org.el 819 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030110311103211033110341103511036110371103811039110401104111042110431104411045110461104711048110491105011051110521105311054110551105611057110581105911060110611106211063110641106511066110671106811069110701107111072110731107411075110761107711078110791108011081110821108311084110851108611087110881108911090110911109211093110941109511096110971109811099111001110111102111031110411105111061110711108111091111011111111121111311114111151111611117111181111911120111211112211123111241112511126111271112811129111301113111132111331113411135111361113711138111391114011141111421114311144111451114611147111481114911150111511115211153111541115511156111571115811159111601116111162111631116411165111661116711168111691117011171111721117311174111751117611177111781117911180111811118211183111841118511186111871118811189111901119111192111931119411195111961119711198111991120011201112021120311204112051120611207112081120911210112111121211213112141121511216112171121811219112201122111222112231122411225112261122711228112291123011231112321123311234112351123611237112381123911240112411124211243112441124511246112471124811249112501125111252112531125411255112561125711258112591126011261112621126311264112651126611267112681126911270112711127211273112741127511276112771127811279112801128111282112831128411285112861128711288112891129011291112921129311294112951129611297112981129911300113011130211303113041130511306113071130811309113101131111312113131131411315113161131711318113191132011321113221132311324113251132611327113281132911330113311133211333113341133511336113371133811339113401134111342113431134411345113461134711348113491135011351113521135311354113551135611357113581135911360113611136211363113641136511366113671136811369113701137111372113731137411375113761137711378113791138011381113821138311384113851138611387113881138911390113911139211393113941139511396113971139811399114001140111402114031140411405114061140711408114091141011411114121141311414114151141611417114181141911420114211142211423114241142511426114271142811429114301143111432114331143411435114361143711438114391144011441114421144311444114451144611447114481144911450114511145211453114541145511456114571145811459114601146111462114631146411465114661146711468114691147011471114721147311474114751147611477114781147911480114811148211483114841148511486114871148811489114901149111492114931149411495114961149711498114991150011501115021150311504115051150611507115081150911510115111151211513115141151511516115171151811519115201152111522115231152411525115261152711528115291153011531115321153311534115351153611537115381153911540115411154211543115441154511546115471154811549115501155111552115531155411555115561155711558115591156011561115621156311564115651156611567115681156911570115711157211573115741157511576115771157811579115801158111582115831158411585115861158711588115891159011591115921159311594115951159611597115981159911600116011160211603116041160511606116071160811609116101161111612116131161411615116161161711618116191162011621116221162311624116251162611627116281162911630116311163211633116341163511636116371163811639116401164111642116431164411645116461164711648116491165011651116521165311654116551165611657116581165911660116611166211663116641166511666116671166811669116701167111672116731167411675116761167711678116791168011681116821168311684116851168611687116881168911690116911169211693116941169511696116971169811699117001170111702117031170411705117061170711708117091171011711117121171311714117151171611717117181171911720117211172211723117241172511726117271172811729117301173111732117331173411735117361173711738117391174011741117421174311744117451174611747117481174911750117511175211753117541175511756117571175811759117601176111762117631176411765117661176711768117691177011771117721177311774117751177611777117781177911780117811178211783117841178511786117871178811789117901179111792117931179411795117961179711798117991180011801118021180311804118051180611807118081180911810118111181211813118141181511816118171181811819118201182111822118231182411825118261182711828118291183011831118321183311834118351183611837118381183911840118411184211843118441184511846118471184811849118501185111852118531185411855118561185711858118591186011861118621186311864118651186611867118681186911870118711187211873118741187511876118771187811879118801188111882118831188411885118861188711888118891189011891118921189311894118951189611897118981189911900119011190211903119041190511906119071190811909119101191111912119131191411915119161191711918119191192011921119221192311924119251192611927119281192911930119311193211933119341193511936119371193811939119401194111942119431194411945119461194711948119491195011951119521195311954119551195611957119581195911960119611196211963119641196511966119671196811969119701197111972119731197411975119761197711978119791198011981119821198311984119851198611987119881198911990119911199211993119941199511996119971199811999120001200112002120031200412005120061200712008120091201012011120121201312014120151201612017120181201912020120211202212023120241202512026120271202812029120301203112032120331203412035120361203712038120391204012041120421204312044120451204612047120481204912050120511205212053120541205512056120571205812059120601206112062120631206412065120661206712068120691207012071120721207312074120751207612077120781207912080120811208212083120841208512086120871208812089120901209112092120931209412095120961209712098120991210012101121021210312104121051210612107121081210912110121111211212113121141211512116121171211812119121201212112122121231212412125121261212712128121291213012131121321213312134121351213612137121381213912140121411214212143121441214512146121471214812149121501215112152121531215412155121561215712158121591216012161121621216312164121651216612167121681216912170121711217212173121741217512176121771217812179121801218112182121831218412185121861218712188121891219012191121921219312194121951219612197121981219912200122011220212203122041220512206122071220812209122101221112212122131221412215122161221712218122191222012221122221222312224122251222612227122281222912230122311223212233122341223512236122371223812239122401224112242122431224412245122461224712248122491225012251122521225312254122551225612257122581225912260122611226212263122641226512266122671226812269122701227112272122731227412275122761227712278122791228012281122821228312284122851228612287122881228912290122911229212293122941229512296122971229812299123001230112302123031230412305123061230712308123091231012311123121231312314123151231612317123181231912320123211232212323123241232512326123271232812329123301233112332123331233412335123361233712338123391234012341123421234312344123451234612347123481234912350123511235212353123541235512356123571235812359123601236112362123631236412365123661236712368123691237012371123721237312374123751237612377123781237912380123811238212383123841238512386123871238812389123901239112392123931239412395123961239712398123991240012401124021240312404124051240612407124081240912410124111241212413124141241512416124171241812419124201242112422124231242412425124261242712428124291243012431124321243312434124351243612437124381243912440124411244212443124441244512446124471244812449124501245112452124531245412455124561245712458124591246012461124621246312464124651246612467124681246912470124711247212473124741247512476124771247812479124801248112482124831248412485124861248712488124891249012491124921249312494124951249612497124981249912500125011250212503125041250512506125071250812509125101251112512125131251412515125161251712518125191252012521125221252312524125251252612527125281252912530125311253212533125341253512536125371253812539125401254112542125431254412545125461254712548125491255012551125521255312554125551255612557125581255912560125611256212563125641256512566125671256812569125701257112572125731257412575125761257712578125791258012581125821258312584125851258612587125881258912590125911259212593125941259512596125971259812599126001260112602126031260412605126061260712608126091261012611126121261312614126151261612617126181261912620126211262212623126241262512626126271262812629126301263112632126331263412635126361263712638126391264012641126421264312644126451264612647126481264912650126511265212653126541265512656126571265812659126601266112662126631266412665126661266712668126691267012671126721267312674126751267612677126781267912680126811268212683126841268512686126871268812689126901269112692126931269412695126961269712698126991270012701127021270312704127051270612707127081270912710127111271212713127141271512716127171271812719127201272112722127231272412725127261272712728127291273012731127321273312734127351273612737127381273912740127411274212743127441274512746127471274812749127501275112752127531275412755127561275712758127591276012761127621276312764127651276612767127681276912770127711277212773127741277512776127771277812779127801278112782127831278412785127861278712788127891279012791127921279312794127951279612797127981279912800128011280212803128041280512806128071280812809128101281112812128131281412815128161281712818128191282012821128221282312824128251282612827128281282912830128311283212833128341283512836128371283812839128401284112842128431284412845128461284712848128491285012851128521285312854128551285612857128581285912860128611286212863128641286512866128671286812869128701287112872128731287412875128761287712878128791288012881128821288312884128851288612887128881288912890128911289212893128941289512896128971289812899129001290112902129031290412905129061290712908129091291012911129121291312914129151291612917129181291912920129211292212923129241292512926129271292812929129301293112932129331293412935129361293712938129391294012941129421294312944129451294612947129481294912950129511295212953129541295512956129571295812959129601296112962129631296412965129661296712968129691297012971129721297312974129751297612977129781297912980129811298212983129841298512986129871298812989129901299112992129931299412995129961299712998129991300013001130021300313004130051300613007130081300913010130111301213013130141301513016130171301813019130201302113022130231302413025130261302713028130291303013031130321303313034130351303613037130381303913040130411304213043130441304513046130471304813049130501305113052130531305413055130561305713058130591306013061130621306313064130651306613067130681306913070130711307213073130741307513076130771307813079130801308113082130831308413085130861308713088130891309013091130921309313094130951309613097130981309913100131011310213103131041310513106131071310813109131101311113112131131311413115131161311713118131191312013121131221312313124131251312613127131281312913130131311313213133131341313513136131371313813139131401314113142131431314413145131461314713148131491315013151131521315313154131551315613157131581315913160131611316213163131641316513166131671316813169131701317113172131731317413175131761317713178131791318013181131821318313184131851318613187131881318913190131911319213193131941319513196131971319813199132001320113202132031320413205132061320713208132091321013211132121321313214132151321613217132181321913220132211322213223132241322513226132271322813229132301323113232132331323413235132361323713238132391324013241132421324313244132451324613247132481324913250132511325213253132541325513256132571325813259132601326113262132631326413265132661326713268132691327013271132721327313274132751327613277132781327913280132811328213283132841328513286132871328813289132901329113292132931329413295132961329713298132991330013301133021330313304133051330613307133081330913310133111331213313133141331513316133171331813319133201332113322133231332413325133261332713328133291333013331133321333313334133351333613337133381333913340133411334213343133441334513346133471334813349133501335113352133531335413355133561335713358133591336013361133621336313364133651336613367133681336913370133711337213373133741337513376133771337813379133801338113382133831338413385133861338713388133891339013391133921339313394133951339613397133981339913400134011340213403134041340513406134071340813409134101341113412134131341413415134161341713418134191342013421134221342313424134251342613427134281342913430134311343213433134341343513436134371343813439134401344113442134431344413445134461344713448134491345013451134521345313454134551345613457134581345913460134611346213463134641346513466134671346813469134701347113472134731347413475134761347713478134791348013481134821348313484134851348613487134881348913490134911349213493134941349513496134971349813499135001350113502135031350413505135061350713508135091351013511135121351313514135151351613517135181351913520135211352213523135241352513526135271352813529135301353113532135331353413535135361353713538135391354013541135421354313544135451354613547135481354913550135511355213553135541355513556135571355813559135601356113562135631356413565135661356713568135691357013571135721357313574135751357613577135781357913580135811358213583135841358513586135871358813589135901359113592135931359413595135961359713598135991360013601136021360313604136051360613607136081360913610136111361213613136141361513616136171361813619136201362113622136231362413625136261362713628136291363013631136321363313634136351363613637136381363913640136411364213643136441364513646136471364813649136501365113652136531365413655136561365713658136591366013661136621366313664136651366613667136681366913670136711367213673136741367513676136771367813679136801368113682136831368413685136861368713688136891369013691136921369313694136951369613697136981369913700137011370213703137041370513706137071370813709137101371113712137131371413715137161371713718137191372013721137221372313724137251372613727137281372913730137311373213733137341373513736137371373813739137401374113742137431374413745137461374713748137491375013751137521375313754137551375613757137581375913760137611376213763137641376513766137671376813769137701377113772137731377413775137761377713778137791378013781137821378313784137851378613787137881378913790137911379213793137941379513796137971379813799138001380113802138031380413805138061380713808138091381013811138121381313814138151381613817138181381913820138211382213823138241382513826138271382813829138301383113832138331383413835138361383713838138391384013841138421384313844138451384613847138481384913850138511385213853138541385513856138571385813859138601386113862138631386413865138661386713868138691387013871138721387313874138751387613877138781387913880138811388213883138841388513886138871388813889138901389113892138931389413895138961389713898138991390013901139021390313904139051390613907139081390913910139111391213913139141391513916139171391813919139201392113922139231392413925139261392713928139291393013931139321393313934139351393613937139381393913940139411394213943139441394513946139471394813949139501395113952139531395413955139561395713958139591396013961139621396313964139651396613967139681396913970139711397213973139741397513976139771397813979139801398113982139831398413985139861398713988139891399013991139921399313994139951399613997139981399914000140011400214003140041400514006140071400814009140101401114012140131401414015140161401714018140191402014021140221402314024140251402614027140281402914030140311403214033140341403514036140371403814039140401404114042140431404414045140461404714048140491405014051140521405314054140551405614057140581405914060140611406214063140641406514066140671406814069140701407114072140731407414075140761407714078140791408014081140821408314084140851408614087140881408914090140911409214093140941409514096140971409814099141001410114102141031410414105141061410714108141091411014111141121411314114141151411614117141181411914120141211412214123141241412514126141271412814129141301413114132141331413414135141361413714138141391414014141141421414314144141451414614147141481414914150141511415214153141541415514156141571415814159141601416114162141631416414165141661416714168141691417014171141721417314174141751417614177141781417914180141811418214183141841418514186141871418814189141901419114192141931419414195141961419714198141991420014201142021420314204142051420614207142081420914210142111421214213142141421514216142171421814219142201422114222142231422414225142261422714228142291423014231142321423314234142351423614237142381423914240142411424214243142441424514246142471424814249142501425114252142531425414255142561425714258142591426014261142621426314264142651426614267142681426914270142711427214273142741427514276142771427814279142801428114282142831428414285142861428714288142891429014291142921429314294142951429614297142981429914300143011430214303143041430514306143071430814309143101431114312143131431414315143161431714318143191432014321143221432314324143251432614327143281432914330143311433214333143341433514336143371433814339143401434114342143431434414345143461434714348143491435014351143521435314354143551435614357143581435914360143611436214363143641436514366143671436814369143701437114372143731437414375143761437714378143791438014381143821438314384143851438614387143881438914390143911439214393143941439514396143971439814399144001440114402144031440414405144061440714408144091441014411144121441314414144151441614417144181441914420144211442214423144241442514426144271442814429144301443114432144331443414435144361443714438144391444014441144421444314444144451444614447144481444914450144511445214453144541445514456144571445814459144601446114462144631446414465144661446714468144691447014471144721447314474144751447614477144781447914480144811448214483144841448514486144871448814489144901449114492144931449414495144961449714498144991450014501145021450314504145051450614507145081450914510145111451214513145141451514516145171451814519145201452114522145231452414525145261452714528145291453014531145321453314534145351453614537145381453914540145411454214543145441454514546145471454814549145501455114552145531455414555145561455714558145591456014561145621456314564145651456614567145681456914570145711457214573145741457514576145771457814579145801458114582145831458414585145861458714588145891459014591145921459314594145951459614597145981459914600146011460214603146041460514606146071460814609146101461114612146131461414615146161461714618146191462014621146221462314624146251462614627146281462914630146311463214633146341463514636146371463814639146401464114642146431464414645146461464714648146491465014651146521465314654146551465614657146581465914660146611466214663146641466514666146671466814669146701467114672146731467414675146761467714678146791468014681146821468314684146851468614687146881468914690146911469214693146941469514696146971469814699147001470114702147031470414705147061470714708147091471014711147121471314714147151471614717147181471914720147211472214723147241472514726147271472814729147301473114732147331473414735147361473714738147391474014741147421474314744147451474614747147481474914750147511475214753147541475514756147571475814759147601476114762147631476414765147661476714768147691477014771147721477314774147751477614777147781477914780147811478214783147841478514786147871478814789147901479114792147931479414795147961479714798147991480014801148021480314804148051480614807148081480914810148111481214813148141481514816148171481814819148201482114822148231482414825148261482714828148291483014831148321483314834148351483614837148381483914840148411484214843148441484514846148471484814849148501485114852148531485414855148561485714858148591486014861148621486314864148651486614867148681486914870148711487214873148741487514876148771487814879148801488114882148831488414885148861488714888148891489014891148921489314894148951489614897148981489914900149011490214903149041490514906149071490814909149101491114912149131491414915149161491714918149191492014921149221492314924149251492614927149281492914930149311493214933149341493514936149371493814939149401494114942149431494414945149461494714948149491495014951149521495314954149551495614957149581495914960149611496214963149641496514966149671496814969149701497114972149731497414975149761497714978149791498014981149821498314984149851498614987149881498914990149911499214993149941499514996149971499814999150001500115002150031500415005150061500715008150091501015011150121501315014150151501615017150181501915020150211502215023150241502515026150271502815029150301503115032150331503415035150361503715038150391504015041150421504315044150451504615047150481504915050150511505215053150541505515056150571505815059150601506115062150631506415065150661506715068150691507015071150721507315074150751507615077150781507915080150811508215083150841508515086150871508815089150901509115092150931509415095150961509715098150991510015101151021510315104151051510615107151081510915110151111511215113151141511515116151171511815119151201512115122151231512415125151261512715128151291513015131151321513315134151351513615137151381513915140151411514215143151441514515146151471514815149151501515115152151531515415155151561515715158151591516015161151621516315164151651516615167151681516915170151711517215173151741517515176151771517815179151801518115182151831518415185151861518715188151891519015191151921519315194151951519615197151981519915200152011520215203152041520515206152071520815209152101521115212152131521415215152161521715218152191522015221152221522315224152251522615227152281522915230152311523215233152341523515236152371523815239152401524115242152431524415245152461524715248152491525015251152521525315254152551525615257152581525915260152611526215263152641526515266152671526815269152701527115272152731527415275152761527715278152791528015281152821528315284152851528615287152881528915290152911529215293152941529515296152971529815299153001530115302153031530415305153061530715308153091531015311153121531315314153151531615317153181531915320153211532215323153241532515326153271532815329153301533115332153331533415335153361533715338153391534015341153421534315344153451534615347153481534915350153511535215353153541535515356153571535815359153601536115362153631536415365153661536715368153691537015371153721537315374153751537615377153781537915380153811538215383153841538515386153871538815389153901539115392153931539415395153961539715398153991540015401154021540315404154051540615407154081540915410154111541215413154141541515416154171541815419154201542115422154231542415425154261542715428154291543015431154321543315434154351543615437154381543915440154411544215443154441544515446154471544815449154501545115452154531545415455154561545715458154591546015461154621546315464154651546615467154681546915470154711547215473154741547515476154771547815479154801548115482154831548415485154861548715488154891549015491154921549315494154951549615497154981549915500155011550215503155041550515506155071550815509155101551115512155131551415515155161551715518155191552015521155221552315524155251552615527155281552915530155311553215533155341553515536155371553815539155401554115542155431554415545155461554715548155491555015551155521555315554155551555615557155581555915560155611556215563155641556515566155671556815569155701557115572155731557415575155761557715578155791558015581155821558315584155851558615587155881558915590155911559215593155941559515596155971559815599156001560115602156031560415605156061560715608156091561015611156121561315614156151561615617156181561915620156211562215623156241562515626156271562815629156301563115632156331563415635156361563715638156391564015641156421564315644156451564615647156481564915650156511565215653156541565515656156571565815659156601566115662156631566415665156661566715668156691567015671156721567315674156751567615677156781567915680156811568215683156841568515686156871568815689156901569115692156931569415695156961569715698156991570015701157021570315704157051570615707157081570915710157111571215713157141571515716157171571815719157201572115722157231572415725157261572715728157291573015731157321573315734157351573615737157381573915740157411574215743157441574515746157471574815749157501575115752157531575415755157561575715758157591576015761157621576315764157651576615767157681576915770157711577215773157741577515776157771577815779157801578115782157831578415785157861578715788157891579015791157921579315794157951579615797157981579915800158011580215803158041580515806158071580815809158101581115812158131581415815158161581715818158191582015821158221582315824158251582615827158281582915830158311583215833158341583515836158371583815839158401584115842158431584415845158461584715848158491585015851158521585315854158551585615857158581585915860158611586215863158641586515866158671586815869158701587115872158731587415875158761587715878158791588015881158821588315884158851588615887158881588915890158911589215893158941589515896158971589815899159001590115902159031590415905159061590715908159091591015911159121591315914159151591615917159181591915920159211592215923159241592515926159271592815929159301593115932159331593415935159361593715938159391594015941159421594315944159451594615947159481594915950159511595215953159541595515956159571595815959159601596115962159631596415965159661596715968159691597015971159721597315974159751597615977159781597915980159811598215983159841598515986159871598815989159901599115992159931599415995159961599715998159991600016001160021600316004160051600616007160081600916010160111601216013160141601516016160171601816019160201602116022160231602416025160261602716028160291603016031160321603316034160351603616037160381603916040160411604216043160441604516046160471604816049160501605116052160531605416055160561605716058160591606016061160621606316064160651606616067160681606916070160711607216073160741607516076160771607816079160801608116082160831608416085160861608716088160891609016091160921609316094160951609616097160981609916100161011610216103161041610516106161071610816109161101611116112161131611416115161161611716118161191612016121161221612316124161251612616127161281612916130161311613216133161341613516136161371613816139161401614116142161431614416145161461614716148161491615016151161521615316154161551615616157161581615916160161611616216163161641616516166161671616816169161701617116172161731617416175161761617716178161791618016181161821618316184161851618616187161881618916190161911619216193161941619516196161971619816199162001620116202162031620416205162061620716208162091621016211162121621316214162151621616217162181621916220162211622216223162241622516226162271622816229162301623116232162331623416235162361623716238162391624016241162421624316244162451624616247162481624916250162511625216253162541625516256162571625816259162601626116262162631626416265162661626716268162691627016271162721627316274162751627616277162781627916280162811628216283162841628516286162871628816289162901629116292162931629416295162961629716298162991630016301163021630316304163051630616307163081630916310163111631216313163141631516316163171631816319163201632116322163231632416325163261632716328163291633016331163321633316334163351633616337163381633916340163411634216343163441634516346163471634816349163501635116352163531635416355163561635716358163591636016361163621636316364163651636616367163681636916370163711637216373163741637516376163771637816379163801638116382163831638416385163861638716388163891639016391163921639316394163951639616397163981639916400164011640216403164041640516406164071640816409164101641116412164131641416415164161641716418164191642016421164221642316424164251642616427164281642916430164311643216433164341643516436164371643816439164401644116442164431644416445164461644716448164491645016451164521645316454164551645616457164581645916460164611646216463164641646516466164671646816469164701647116472164731647416475164761647716478164791648016481164821648316484164851648616487164881648916490164911649216493164941649516496164971649816499165001650116502165031650416505165061650716508165091651016511165121651316514165151651616517165181651916520165211652216523165241652516526165271652816529165301653116532165331653416535165361653716538165391654016541165421654316544165451654616547165481654916550165511655216553165541655516556165571655816559165601656116562165631656416565165661656716568165691657016571165721657316574165751657616577165781657916580165811658216583165841658516586165871658816589165901659116592165931659416595165961659716598165991660016601166021660316604166051660616607166081660916610166111661216613166141661516616166171661816619166201662116622166231662416625166261662716628166291663016631166321663316634166351663616637166381663916640166411664216643166441664516646166471664816649166501665116652166531665416655166561665716658166591666016661166621666316664166651666616667166681666916670166711667216673166741667516676166771667816679166801668116682166831668416685166861668716688166891669016691166921669316694166951669616697166981669916700167011670216703167041670516706167071670816709167101671116712167131671416715167161671716718167191672016721167221672316724167251672616727167281672916730167311673216733167341673516736167371673816739167401674116742167431674416745167461674716748167491675016751167521675316754167551675616757167581675916760167611676216763167641676516766167671676816769167701677116772167731677416775167761677716778167791678016781167821678316784167851678616787167881678916790167911679216793167941679516796167971679816799168001680116802168031680416805168061680716808168091681016811168121681316814168151681616817168181681916820168211682216823168241682516826168271682816829168301683116832168331683416835168361683716838168391684016841168421684316844168451684616847168481684916850168511685216853168541685516856168571685816859168601686116862168631686416865168661686716868168691687016871168721687316874168751687616877168781687916880168811688216883168841688516886168871688816889168901689116892168931689416895168961689716898168991690016901169021690316904169051690616907169081690916910169111691216913169141691516916169171691816919169201692116922169231692416925169261692716928169291693016931169321693316934169351693616937169381693916940169411694216943169441694516946169471694816949169501695116952169531695416955169561695716958169591696016961169621696316964169651696616967169681696916970169711697216973169741697516976169771697816979169801698116982169831698416985169861698716988169891699016991169921699316994169951699616997169981699917000170011700217003170041700517006170071700817009170101701117012170131701417015170161701717018170191702017021170221702317024170251702617027170281702917030170311703217033170341703517036170371703817039170401704117042170431704417045170461704717048170491705017051170521705317054170551705617057170581705917060170611706217063170641706517066170671706817069170701707117072170731707417075170761707717078170791708017081170821708317084170851708617087170881708917090170911709217093170941709517096170971709817099171001710117102171031710417105171061710717108171091711017111171121711317114171151711617117171181711917120171211712217123171241712517126171271712817129171301713117132171331713417135171361713717138171391714017141171421714317144171451714617147171481714917150171511715217153171541715517156171571715817159171601716117162171631716417165171661716717168171691717017171171721717317174171751717617177171781717917180171811718217183171841718517186171871718817189171901719117192171931719417195171961719717198171991720017201172021720317204172051720617207172081720917210172111721217213172141721517216172171721817219172201722117222172231722417225172261722717228172291723017231172321723317234172351723617237172381723917240172411724217243172441724517246172471724817249172501725117252172531725417255172561725717258172591726017261172621726317264172651726617267172681726917270172711727217273172741727517276172771727817279172801728117282172831728417285172861728717288172891729017291172921729317294172951729617297172981729917300173011730217303173041730517306173071730817309173101731117312173131731417315173161731717318173191732017321173221732317324173251732617327173281732917330173311733217333173341733517336173371733817339173401734117342173431734417345173461734717348173491735017351173521735317354173551735617357173581735917360173611736217363173641736517366173671736817369173701737117372173731737417375173761737717378173791738017381173821738317384173851738617387173881738917390173911739217393173941739517396173971739817399174001740117402174031740417405174061740717408174091741017411174121741317414174151741617417174181741917420174211742217423174241742517426174271742817429174301743117432174331743417435174361743717438174391744017441174421744317444174451744617447174481744917450174511745217453174541745517456174571745817459174601746117462174631746417465174661746717468174691747017471174721747317474174751747617477174781747917480174811748217483174841748517486174871748817489174901749117492174931749417495174961749717498174991750017501175021750317504175051750617507175081750917510175111751217513175141751517516175171751817519175201752117522175231752417525175261752717528175291753017531175321753317534175351753617537175381753917540175411754217543175441754517546175471754817549175501755117552175531755417555175561755717558175591756017561175621756317564175651756617567175681756917570175711757217573175741757517576175771757817579175801758117582175831758417585175861758717588175891759017591175921759317594175951759617597175981759917600176011760217603176041760517606176071760817609176101761117612176131761417615176161761717618176191762017621176221762317624176251762617627176281762917630176311763217633176341763517636176371763817639176401764117642176431764417645176461764717648176491765017651176521765317654176551765617657176581765917660176611766217663176641766517666176671766817669176701767117672176731767417675176761767717678176791768017681176821768317684176851768617687176881768917690176911769217693176941769517696176971769817699177001770117702177031770417705177061770717708177091771017711177121771317714177151771617717177181771917720177211772217723177241772517726177271772817729177301773117732177331773417735177361773717738177391774017741177421774317744177451774617747177481774917750177511775217753177541775517756177571775817759177601776117762177631776417765177661776717768177691777017771177721777317774177751777617777177781777917780177811778217783177841778517786177871778817789177901779117792177931779417795177961779717798177991780017801178021780317804178051780617807178081780917810178111781217813178141781517816178171781817819178201782117822178231782417825178261782717828178291783017831178321783317834178351783617837178381783917840178411784217843178441784517846178471784817849178501785117852178531785417855178561785717858178591786017861178621786317864178651786617867178681786917870178711787217873178741787517876178771787817879178801788117882178831788417885178861788717888178891789017891178921789317894178951789617897178981789917900179011790217903179041790517906179071790817909179101791117912179131791417915179161791717918179191792017921179221792317924179251792617927179281792917930179311793217933179341793517936179371793817939179401794117942179431794417945179461794717948179491795017951179521795317954179551795617957179581795917960179611796217963179641796517966179671796817969179701797117972179731797417975179761797717978179791798017981179821798317984179851798617987179881798917990179911799217993179941799517996179971799817999180001800118002180031800418005180061800718008180091801018011180121801318014180151801618017180181801918020180211802218023180241802518026180271802818029180301803118032180331803418035180361803718038180391804018041180421804318044180451804618047180481804918050180511805218053180541805518056180571805818059180601806118062180631806418065180661806718068180691807018071180721807318074180751807618077180781807918080180811808218083180841808518086180871808818089180901809118092180931809418095180961809718098180991810018101181021810318104181051810618107181081810918110181111811218113181141811518116181171811818119181201812118122181231812418125181261812718128181291813018131181321813318134181351813618137181381813918140181411814218143181441814518146181471814818149181501815118152181531815418155181561815718158181591816018161181621816318164181651816618167181681816918170181711817218173181741817518176181771817818179181801818118182181831818418185181861818718188181891819018191181921819318194181951819618197181981819918200182011820218203182041820518206182071820818209182101821118212182131821418215182161821718218182191822018221182221822318224182251822618227182281822918230182311823218233182341823518236182371823818239182401824118242182431824418245182461824718248182491825018251182521825318254182551825618257182581825918260182611826218263182641826518266182671826818269182701827118272182731827418275182761827718278182791828018281182821828318284182851828618287182881828918290182911829218293182941829518296182971829818299183001830118302183031830418305183061830718308183091831018311183121831318314183151831618317183181831918320183211832218323183241832518326183271832818329183301833118332183331833418335183361833718338183391834018341183421834318344183451834618347183481834918350183511835218353183541835518356183571835818359183601836118362183631836418365183661836718368183691837018371183721837318374183751837618377183781837918380183811838218383183841838518386183871838818389183901839118392183931839418395183961839718398183991840018401184021840318404184051840618407184081840918410184111841218413184141841518416184171841818419184201842118422184231842418425184261842718428184291843018431184321843318434184351843618437184381843918440184411844218443184441844518446184471844818449184501845118452184531845418455184561845718458184591846018461184621846318464184651846618467184681846918470184711847218473184741847518476184771847818479184801848118482184831848418485184861848718488184891849018491184921849318494184951849618497184981849918500185011850218503185041850518506185071850818509185101851118512185131851418515185161851718518185191852018521185221852318524185251852618527185281852918530185311853218533185341853518536185371853818539185401854118542185431854418545185461854718548185491855018551185521855318554185551855618557185581855918560185611856218563185641856518566185671856818569185701857118572185731857418575185761857718578185791858018581185821858318584185851858618587185881858918590185911859218593185941859518596185971859818599186001860118602186031860418605186061860718608186091861018611186121861318614186151861618617186181861918620186211862218623186241862518626186271862818629186301863118632186331863418635186361863718638186391864018641186421864318644186451864618647186481864918650186511865218653186541865518656186571865818659186601866118662186631866418665186661866718668186691867018671186721867318674186751867618677186781867918680186811868218683186841868518686186871868818689186901869118692186931869418695186961869718698186991870018701187021870318704187051870618707187081870918710187111871218713187141871518716187171871818719187201872118722187231872418725187261872718728187291873018731187321873318734187351873618737187381873918740187411874218743187441874518746187471874818749187501875118752187531875418755187561875718758187591876018761187621876318764187651876618767187681876918770187711877218773187741877518776187771877818779187801878118782187831878418785187861878718788187891879018791187921879318794187951879618797187981879918800188011880218803188041880518806188071880818809188101881118812188131881418815188161881718818188191882018821188221882318824188251882618827188281882918830188311883218833188341883518836188371883818839188401884118842188431884418845188461884718848188491885018851188521885318854188551885618857188581885918860188611886218863188641886518866188671886818869188701887118872188731887418875188761887718878188791888018881188821888318884188851888618887188881888918890188911889218893188941889518896188971889818899189001890118902189031890418905189061890718908189091891018911189121891318914189151891618917189181891918920189211892218923189241892518926189271892818929189301893118932189331893418935189361893718938189391894018941189421894318944189451894618947189481894918950189511895218953189541895518956189571895818959189601896118962189631896418965189661896718968189691897018971189721897318974189751897618977189781897918980189811898218983189841898518986189871898818989189901899118992189931899418995189961899718998189991900019001190021900319004190051900619007190081900919010190111901219013190141901519016190171901819019190201902119022190231902419025190261902719028190291903019031190321903319034190351903619037190381903919040190411904219043190441904519046190471904819049190501905119052190531905419055190561905719058190591906019061190621906319064190651906619067190681906919070190711907219073190741907519076190771907819079190801908119082190831908419085190861908719088190891909019091190921909319094190951909619097190981909919100191011910219103191041910519106191071910819109191101911119112191131911419115191161911719118191191912019121191221912319124191251912619127191281912919130191311913219133191341913519136191371913819139191401914119142191431914419145191461914719148191491915019151191521915319154191551915619157191581915919160191611916219163191641916519166191671916819169191701917119172191731917419175191761917719178191791918019181191821918319184191851918619187191881918919190191911919219193191941919519196191971919819199192001920119202192031920419205192061920719208192091921019211192121921319214192151921619217192181921919220192211922219223192241922519226192271922819229192301923119232192331923419235192361923719238192391924019241192421924319244192451924619247192481924919250192511925219253192541925519256192571925819259192601926119262192631926419265192661926719268192691927019271192721927319274192751927619277192781927919280192811928219283192841928519286192871928819289192901929119292192931929419295192961929719298192991930019301193021930319304193051930619307193081930919310193111931219313193141931519316193171931819319193201932119322193231932419325193261932719328193291933019331193321933319334193351933619337193381933919340193411934219343193441934519346193471934819349193501935119352193531935419355193561935719358193591936019361193621936319364193651936619367193681936919370193711937219373193741937519376193771937819379193801938119382193831938419385193861938719388193891939019391193921939319394193951939619397193981939919400194011940219403194041940519406194071940819409194101941119412194131941419415194161941719418194191942019421194221942319424194251942619427194281942919430194311943219433194341943519436194371943819439194401944119442194431944419445194461944719448194491945019451194521945319454194551945619457194581945919460194611946219463194641946519466194671946819469194701947119472194731947419475194761947719478194791948019481194821948319484194851948619487194881948919490194911949219493194941949519496194971949819499195001950119502195031950419505195061950719508195091951019511195121951319514195151951619517195181951919520195211952219523195241952519526195271952819529195301953119532195331953419535195361953719538195391954019541195421954319544195451954619547195481954919550195511955219553195541955519556195571955819559195601956119562195631956419565195661956719568195691957019571195721957319574195751957619577195781957919580195811958219583195841958519586195871958819589195901959119592195931959419595195961959719598195991960019601196021960319604196051960619607196081960919610196111961219613196141961519616196171961819619196201962119622196231962419625196261962719628196291963019631196321963319634196351963619637196381963919640196411964219643196441964519646196471964819649196501965119652196531965419655196561965719658196591966019661196621966319664196651966619667196681966919670196711967219673196741967519676196771967819679196801968119682196831968419685196861968719688196891969019691196921969319694196951969619697196981969919700197011970219703197041970519706197071970819709197101971119712197131971419715197161971719718197191972019721197221972319724197251972619727197281972919730197311973219733197341973519736197371973819739197401974119742197431974419745197461974719748197491975019751197521975319754197551975619757197581975919760197611976219763197641976519766197671976819769197701977119772197731977419775197761977719778197791978019781197821978319784197851978619787197881978919790197911979219793197941979519796197971979819799198001980119802198031980419805198061980719808198091981019811198121981319814198151981619817198181981919820198211982219823198241982519826198271982819829198301983119832198331983419835198361983719838198391984019841198421984319844198451984619847198481984919850198511985219853198541985519856198571985819859198601986119862198631986419865198661986719868198691987019871198721987319874198751987619877198781987919880198811988219883198841988519886198871988819889198901989119892198931989419895198961989719898198991990019901199021990319904199051990619907199081990919910199111991219913199141991519916199171991819919199201992119922199231992419925199261992719928199291993019931199321993319934199351993619937199381993919940199411994219943199441994519946199471994819949199501995119952199531995419955199561995719958199591996019961199621996319964199651996619967199681996919970199711997219973199741997519976199771997819979199801998119982199831998419985199861998719988199891999019991199921999319994199951999619997199981999920000200012000220003200042000520006200072000820009200102001120012200132001420015200162001720018200192002020021200222002320024200252002620027200282002920030200312003220033200342003520036200372003820039200402004120042200432004420045200462004720048200492005020051200522005320054200552005620057200582005920060200612006220063200642006520066200672006820069200702007120072200732007420075200762007720078200792008020081200822008320084200852008620087200882008920090200912009220093200942009520096200972009820099201002010120102201032010420105201062010720108201092011020111201122011320114201152011620117201182011920120201212012220123201242012520126201272012820129201302013120132201332013420135201362013720138201392014020141201422014320144201452014620147201482014920150201512015220153201542015520156201572015820159201602016120162201632016420165201662016720168201692017020171201722017320174201752017620177201782017920180201812018220183201842018520186201872018820189201902019120192201932019420195201962019720198201992020020201202022020320204202052020620207202082020920210202112021220213202142021520216202172021820219202202022120222202232022420225202262022720228202292023020231202322023320234202352023620237202382023920240202412024220243202442024520246202472024820249202502025120252202532025420255202562025720258202592026020261202622026320264202652026620267202682026920270202712027220273202742027520276202772027820279202802028120282202832028420285202862028720288202892029020291202922029320294202952029620297202982029920300203012030220303203042030520306203072030820309203102031120312203132031420315203162031720318203192032020321203222032320324203252032620327203282032920330203312033220333203342033520336203372033820339203402034120342203432034420345203462034720348203492035020351203522035320354203552035620357203582035920360203612036220363203642036520366203672036820369203702037120372203732037420375203762037720378203792038020381203822038320384203852038620387203882038920390203912039220393203942039520396203972039820399204002040120402204032040420405204062040720408204092041020411204122041320414204152041620417204182041920420204212042220423204242042520426204272042820429204302043120432204332043420435204362043720438204392044020441204422044320444204452044620447204482044920450204512045220453204542045520456204572045820459204602046120462204632046420465204662046720468204692047020471204722047320474204752047620477204782047920480204812048220483204842048520486204872048820489204902049120492204932049420495204962049720498204992050020501205022050320504205052050620507205082050920510205112051220513205142051520516205172051820519205202052120522205232052420525205262052720528205292053020531205322053320534205352053620537205382053920540205412054220543205442054520546205472054820549205502055120552205532055420555205562055720558205592056020561205622056320564205652056620567205682056920570205712057220573205742057520576205772057820579205802058120582205832058420585205862058720588205892059020591205922059320594205952059620597205982059920600206012060220603206042060520606206072060820609206102061120612206132061420615206162061720618206192062020621206222062320624206252062620627206282062920630206312063220633206342063520636206372063820639206402064120642206432064420645206462064720648206492065020651206522065320654206552065620657206582065920660206612066220663206642066520666206672066820669206702067120672206732067420675206762067720678206792068020681206822068320684206852068620687206882068920690206912069220693206942069520696206972069820699207002070120702207032070420705207062070720708207092071020711207122071320714207152071620717207182071920720207212072220723207242072520726207272072820729207302073120732207332073420735207362073720738207392074020741207422074320744207452074620747207482074920750207512075220753207542075520756207572075820759207602076120762207632076420765207662076720768207692077020771207722077320774207752077620777207782077920780207812078220783207842078520786207872078820789207902079120792207932079420795207962079720798207992080020801208022080320804208052080620807208082080920810208112081220813208142081520816208172081820819208202082120822208232082420825208262082720828208292083020831208322083320834208352083620837208382083920840208412084220843208442084520846208472084820849208502085120852208532085420855208562085720858208592086020861208622086320864208652086620867208682086920870208712087220873208742087520876208772087820879208802088120882208832088420885208862088720888208892089020891208922089320894208952089620897208982089920900209012090220903209042090520906209072090820909209102091120912209132091420915209162091720918209192092020921209222092320924209252092620927209282092920930209312093220933209342093520936209372093820939209402094120942209432094420945209462094720948209492095020951209522095320954209552095620957209582095920960209612096220963209642096520966209672096820969209702097120972209732097420975209762097720978209792098020981209822098320984209852098620987209882098920990209912099220993209942099520996209972099820999210002100121002210032100421005210062100721008210092101021011210122101321014210152101621017210182101921020210212102221023210242102521026210272102821029210302103121032210332103421035210362103721038210392104021041210422104321044210452104621047210482104921050210512105221053210542105521056210572105821059210602106121062210632106421065210662106721068210692107021071210722107321074210752107621077210782107921080210812108221083210842108521086210872108821089210902109121092210932109421095210962109721098210992110021101211022110321104211052110621107211082110921110211112111221113211142111521116211172111821119211202112121122211232112421125211262112721128211292113021131211322113321134211352113621137211382113921140211412114221143211442114521146211472114821149211502115121152211532115421155211562115721158211592116021161211622116321164211652116621167211682116921170211712117221173211742117521176211772117821179211802118121182211832118421185211862118721188211892119021191211922119321194211952119621197211982119921200212012120221203
  1. ;;; org.el --- Outline-based notes management and organizer -*- lexical-binding: t; -*-
  2. ;; Carstens outline-mode for keeping track of everything.
  3. ;; Copyright (C) 2004-2022 Free Software Foundation, Inc.
  4. ;;
  5. ;; Author: Carsten Dominik <carsten.dominik@gmail.com>
  6. ;; Maintainer: Bastien Guerry <bzg@gnu.org>
  7. ;; Keywords: outlines, hypermedia, calendar, wp
  8. ;; URL: https://orgmode.org
  9. ;; Package-Requires: ((emacs "25.1"))
  10. ;; Version: 9.6-pre
  11. ;; This file is part of GNU Emacs.
  12. ;;
  13. ;; GNU Emacs is free software: you can redistribute it and/or modify
  14. ;; it under the terms of the GNU General Public License as published by
  15. ;; the Free Software Foundation, either version 3 of the License, or
  16. ;; (at your option) any later version.
  17. ;; GNU Emacs is distributed in the hope that it will be useful,
  18. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  19. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  20. ;; GNU General Public License for more details.
  21. ;; You should have received a copy of the GNU General Public License
  22. ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
  23. ;;
  24. ;;; Commentary:
  25. ;;
  26. ;; Org is a mode for keeping notes, maintaining ToDo lists, and doing
  27. ;; project planning with a fast and effective plain-text system.
  28. ;;
  29. ;; Org mode develops organizational tasks around NOTES files that
  30. ;; contain information about projects as plain text. Org mode is
  31. ;; implemented on top of outline-mode, which makes it possible to keep
  32. ;; the content of large files well structured. Visibility cycling and
  33. ;; structure editing help to work with the tree. Tables are easily
  34. ;; created with a built-in table editor. Org mode supports ToDo
  35. ;; items, deadlines, time stamps, and scheduling. It dynamically
  36. ;; compiles entries into an agenda that utilizes and smoothly
  37. ;; integrates much of the Emacs calendar and diary. Plain text
  38. ;; URL-like links connect to websites, emails, Usenet messages, BBDB
  39. ;; entries, and any files related to the projects. For printing and
  40. ;; sharing of notes, an Org file can be exported as a structured ASCII
  41. ;; file, as HTML, or (todo and agenda items only) as an iCalendar
  42. ;; file. It can also serve as a publishing tool for a set of linked
  43. ;; webpages.
  44. ;;
  45. ;; Installation and Activation
  46. ;; ---------------------------
  47. ;; See the corresponding sections in the manual at
  48. ;;
  49. ;; https://orgmode.org/org.html#Installation
  50. ;;
  51. ;; Documentation
  52. ;; -------------
  53. ;; The documentation of Org mode can be found in the TeXInfo file. The
  54. ;; distribution also contains a PDF version of it. At the Org mode website,
  55. ;; you can read the same text online as HTML. There is also an excellent
  56. ;; reference card made by Philip Rooke. This card can be found in the
  57. ;; doc/ directory.
  58. ;;
  59. ;; A list of recent changes can be found at
  60. ;; https://orgmode.org/Changes.html
  61. ;;
  62. ;;; Code:
  63. (defvar org-inhibit-highlight-removal nil) ; dynamically scoped param
  64. (defvar org-inlinetask-min-level)
  65. ;;;; Require other packages
  66. (require 'org-compat)
  67. (org-assert-version)
  68. (require 'cl-lib)
  69. (eval-when-compile (require 'gnus-sum))
  70. (require 'calendar)
  71. (require 'find-func)
  72. (require 'format-spec)
  73. (condition-case nil
  74. (load (concat (file-name-directory load-file-name)
  75. "org-loaddefs")
  76. nil t nil t)
  77. (error
  78. (message "WARNING: No org-loaddefs.el file could be found from where org.el is loaded.")
  79. (sit-for 3)
  80. (message "You need to run \"make\" or \"make autoloads\" from Org lisp directory")
  81. (sit-for 3)))
  82. (eval-and-compile (require 'org-macs))
  83. (require 'org-compat)
  84. (require 'org-keys)
  85. (require 'ol)
  86. (require 'oc)
  87. (require 'org-table)
  88. (require 'org-fold)
  89. (require 'org-cycle)
  90. (defvaralias 'org-hide-block-startup 'org-cycle-hide-block-startup)
  91. (defvaralias 'org-pre-cycle-hook 'org-cycle-pre-hook)
  92. (defvaralias 'org-tab-first-hook 'org-cycle-tab-first-hook)
  93. (defalias 'org-global-cycle #'org-cycle-global)
  94. (defalias 'org-overview #'org-cycle-overview)
  95. (defalias 'org-content #'org-cycle-content)
  96. (defalias 'org-reveal #'org-fold-reveal)
  97. (defalias 'org-force-cycle-archived #'org-cycle-force-archived)
  98. ;; `org-outline-regexp' ought to be a defconst but is let-bound in
  99. ;; some places -- e.g. see the macro `org-with-limited-levels'.
  100. (defvar org-outline-regexp "\\*+ "
  101. "Regexp to match Org headlines.")
  102. (defvar org-outline-regexp-bol "^\\*+ "
  103. "Regexp to match Org headlines.
  104. This is similar to `org-outline-regexp' but additionally makes
  105. sure that we are at the beginning of the line.")
  106. (defvar org-heading-regexp "^\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
  107. "Matches a headline, putting stars and text into groups.
  108. Stars are put in group 1 and the trimmed body in group 2.")
  109. (declare-function calendar-check-holidays "holidays" (date))
  110. (declare-function cdlatex-environment "ext:cdlatex" (environment item))
  111. (declare-function cdlatex-math-symbol "ext:cdlatex")
  112. (declare-function Info-goto-node "info" (nodename &optional fork strict-case))
  113. (declare-function isearch-no-upper-case-p "isearch" (string regexp-flag))
  114. (declare-function org-add-archive-files "org-archive" (files))
  115. (declare-function org-agenda-entry-get-agenda-timestamp "org-agenda" (pom))
  116. (declare-function org-agenda-todo-yesterday "org-agenda" (&optional arg))
  117. (declare-function org-agenda-list "org-agenda" (&optional arg start-day span with-hour))
  118. (declare-function org-agenda-redo "org-agenda" (&optional all))
  119. (declare-function org-agenda-remove-restriction-lock "org-agenda" (&optional noupdate))
  120. (declare-function org-archive-subtree "org-archive" (&optional find-done))
  121. (declare-function org-archive-subtree-default "org-archive" ())
  122. (declare-function org-archive-to-archive-sibling "org-archive" ())
  123. (declare-function org-attach "org-attach" ())
  124. (declare-function org-attach-dir "org-attach"
  125. (&optional create-if-not-exists-p no-fs-check))
  126. (declare-function org-babel-do-in-edit-buffer "ob-core" (&rest body) t)
  127. (declare-function org-babel-tangle-file "ob-tangle" (file &optional target-file lang))
  128. (declare-function org-beamer-mode "ox-beamer" (&optional prefix) t)
  129. (declare-function org-clock-auto-clockout "org-clock" ())
  130. (declare-function org-clock-cancel "org-clock" ())
  131. (declare-function org-clock-display "org-clock" (&optional arg))
  132. (declare-function org-clock-get-last-clock-out-time "org-clock" ())
  133. (declare-function org-clock-goto "org-clock" (&optional select))
  134. (declare-function org-clock-in "org-clock" (&optional select start-time))
  135. (declare-function org-clock-in-last "org-clock" (&optional arg))
  136. (declare-function org-clock-out "org-clock" (&optional switch-to-state fail-quietly at-time))
  137. (declare-function org-clock-out-if-current "org-clock" ())
  138. (declare-function org-clock-remove-overlays "org-clock" (&optional beg end noremove))
  139. (declare-function org-clock-report "org-clock" (&optional arg))
  140. (declare-function org-clock-sum "org-clock" (&optional tstart tend headline-filter propname))
  141. (declare-function org-clock-sum-current-item "org-clock" (&optional tstart))
  142. (declare-function org-clock-timestamps-down "org-clock" (&optional n))
  143. (declare-function org-clock-timestamps-up "org-clock" (&optional n))
  144. (declare-function org-clock-update-time-maybe "org-clock" ())
  145. (declare-function org-clocktable-shift "org-clock" (dir n))
  146. (declare-function org-columns-quit "org-colview" ())
  147. (declare-function org-columns-insert-dblock "org-colview" ())
  148. (declare-function org-duration-from-minutes "org-duration" (minutes &optional fmt canonical))
  149. (declare-function org-duration-to-minutes "org-duration" (duration &optional canonical))
  150. (declare-function org-element-at-point "org-element" (&optional pom cached-only))
  151. (declare-function org-element-at-point-no-context "org-element" (&optional pom))
  152. (declare-function org-element-cache-refresh "org-element" (pos))
  153. (declare-function org-element-cache-reset "org-element" (&optional all no-persistence))
  154. (declare-function org-element-cache-map "org-element" (func &rest keys))
  155. (declare-function org-element-contents "org-element" (element))
  156. (declare-function org-element-context "org-element" (&optional element))
  157. (declare-function org-element-copy "org-element" (datum))
  158. (declare-function org-element-create "org-element" (type &optional props &rest children))
  159. (declare-function org-element-extract-element "org-element" (element))
  160. (declare-function org-element-insert-before "org-element" (element location))
  161. (declare-function org-element-interpret-data "org-element" (data))
  162. (declare-function org-element-keyword-parser "org-element" (limit affiliated))
  163. (declare-function org-element-lineage "org-element" (blob &optional types with-self))
  164. (declare-function org-element-link-parser "org-element" ())
  165. (declare-function org-element-map "org-element" (data types fun &optional info first-match no-recursion with-affiliated))
  166. (declare-function org-element-nested-p "org-element" (elem-a elem-b))
  167. (declare-function org-element-parse-buffer "org-element" (&optional granularity visible-only))
  168. (declare-function org-element-parse-secondary-string "org-element" (string restriction &optional parent))
  169. (declare-function org-element-property "org-element" (property element))
  170. (declare-function org-element-put-property "org-element" (element property value))
  171. (declare-function org-element-restriction "org-element" (element))
  172. (declare-function org-element-swap-A-B "org-element" (elem-a elem-b))
  173. (declare-function org-element-timestamp-parser "org-element" ())
  174. (declare-function org-element-type "org-element" (element))
  175. (declare-function org-element--cache-active-p "org-element" ())
  176. (declare-function org-export-dispatch "ox" (&optional arg))
  177. (declare-function org-export-get-backend "ox" (name))
  178. (declare-function org-export-get-environment "ox" (&optional backend subtreep ext-plist))
  179. (declare-function org-feed-goto-inbox "org-feed" (feed))
  180. (declare-function org-feed-update-all "org-feed" ())
  181. (declare-function org-goto "org-goto" (&optional alternative-interface))
  182. (declare-function org-id-find-id-file "org-id" (id))
  183. (declare-function org-id-get-create "org-id" (&optional force))
  184. (declare-function org-inlinetask-at-task-p "org-inlinetask" ())
  185. (declare-function org-inlinetask-outline-regexp "org-inlinetask" ())
  186. (declare-function org-inlinetask-toggle-visibility "org-inlinetask" ())
  187. (declare-function org-latex-make-preamble "ox-latex" (info &optional template snippet?))
  188. (declare-function org-num-mode "org-num" (&optional arg))
  189. (declare-function org-plot/gnuplot "org-plot" (&optional params))
  190. (declare-function org-persist-load "org-persist" (container &optional associated hash-must-match))
  191. (declare-function org-tags-view "org-agenda" (&optional todo-only match))
  192. (declare-function org-timer "org-timer" (&optional restart no-insert))
  193. (declare-function org-timer-item "org-timer" (&optional arg))
  194. (declare-function org-timer-pause-or-continue "org-timer" (&optional stop))
  195. (declare-function org-timer-set-timer "org-timer" (&optional opt))
  196. (declare-function org-timer-start "org-timer" (&optional offset))
  197. (declare-function org-timer-stop "org-timer" ())
  198. (declare-function org-toggle-archive-tag "org-archive" (&optional find-done))
  199. (declare-function org-update-radio-target-regexp "ol" ())
  200. (defvar org-agenda-buffer-name)
  201. (defvar org-element-paragraph-separate)
  202. (defvar org-element-cache-map-continue-from)
  203. (defvar org-element--timestamp-regexp)
  204. (defvar org-indent-indentation-per-level)
  205. (defvar org-radio-target-regexp)
  206. (defvar org-target-link-regexp)
  207. (defvar org-target-regexp)
  208. (defvar org-id-overriding-file-name)
  209. ;; load languages based on value of `org-babel-load-languages'
  210. (defvar org-babel-load-languages)
  211. (defvar crm-separator) ; dynamically scoped param
  212. ;;;###autoload
  213. (defun org-babel-do-load-languages (sym value)
  214. "Load the languages defined in `org-babel-load-languages'."
  215. (set-default-toplevel-value sym value)
  216. (dolist (pair org-babel-load-languages)
  217. (let ((active (cdr pair)) (lang (symbol-name (car pair))))
  218. (if active
  219. (require (intern (concat "ob-" lang)))
  220. (fmakunbound
  221. (intern (concat "org-babel-execute:" lang)))
  222. (fmakunbound
  223. (intern (concat "org-babel-expand-body:" lang)))))))
  224. ;;;###autoload
  225. (defun org-babel-load-file (file &optional compile)
  226. "Load Emacs Lisp source code blocks in the Org FILE.
  227. This function exports the source code using `org-babel-tangle'
  228. and then loads the resulting file using `load-file'. With
  229. optional prefix argument COMPILE, the tangled Emacs Lisp file is
  230. byte-compiled before it is loaded."
  231. (interactive "fFile to load: \nP")
  232. (let ((tangled-file (concat (file-name-sans-extension file) ".el")))
  233. ;; Tangle only if the Org file is newer than the Elisp file.
  234. (unless (org-file-newer-than-p
  235. tangled-file
  236. (file-attribute-modification-time
  237. (file-attributes (file-truename file))))
  238. ;; Make sure that tangled file modification time is
  239. ;; updated even when `org-babel-tangle-file' does not make changes.
  240. ;; This avoids re-tangling changed FILE where the changes did
  241. ;; not affect the tangled code.
  242. (when (file-exists-p tangled-file)
  243. (set-file-times tangled-file))
  244. (org-babel-tangle-file file
  245. tangled-file
  246. (rx string-start
  247. (or "emacs-lisp" "elisp")
  248. string-end)))
  249. (if compile
  250. (progn
  251. (byte-compile-file tangled-file)
  252. (load-file (byte-compile-dest-file tangled-file))
  253. (message "Compiled and loaded %s" tangled-file))
  254. (load-file tangled-file)
  255. (message "Loaded %s" tangled-file))))
  256. (defcustom org-babel-load-languages '((emacs-lisp . t))
  257. "Languages which can be evaluated in Org buffers.
  258. \\<org-mode-map>
  259. This list can be used to load support for any of the available
  260. languages with babel support (see info node `(org) Languages'). Each
  261. language will depend on a different set of system executables and/or
  262. Emacs modes.
  263. When a language is \"loaded\", code blocks in that language can
  264. be evaluated with `org-babel-execute-src-block', which is bound
  265. by default to \\[org-ctrl-c-ctrl-c].
  266. The `org-babel-no-eval-on-ctrl-c-ctrl-c' option can be set to
  267. remove code block evaluation from \\[org-ctrl-c-ctrl-c]. By
  268. default, only Emacs Lisp is loaded, since it has no specific
  269. requirement."
  270. :group 'org-babel
  271. :set 'org-babel-do-load-languages
  272. :version "24.1"
  273. :type '(alist :tag "Babel Languages"
  274. :key-type
  275. (choice
  276. (const :tag "Awk" awk)
  277. (const :tag "C" C)
  278. (const :tag "R" R)
  279. (const :tag "Calc" calc)
  280. (const :tag "Clojure" clojure)
  281. (const :tag "CSS" css)
  282. (const :tag "Ditaa" ditaa)
  283. (const :tag "Dot" dot)
  284. (const :tag "Emacs Lisp" emacs-lisp)
  285. (const :tag "Forth" forth)
  286. (const :tag "Fortran" fortran)
  287. (const :tag "Gnuplot" gnuplot)
  288. (const :tag "Haskell" haskell)
  289. (const :tag "Java" java)
  290. (const :tag "Javascript" js)
  291. (const :tag "LaTeX" latex)
  292. (const :tag "Lilypond" lilypond)
  293. (const :tag "Lisp" lisp)
  294. (const :tag "Makefile" makefile)
  295. (const :tag "Maxima" maxima)
  296. (const :tag "Matlab" matlab)
  297. (const :tag "Ocaml" ocaml)
  298. (const :tag "Octave" octave)
  299. (const :tag "Org" org)
  300. (const :tag "Perl" perl)
  301. (const :tag "Pico Lisp" picolisp)
  302. (const :tag "PlantUML" plantuml)
  303. (const :tag "Python" python)
  304. (const :tag "Ruby" ruby)
  305. (const :tag "Sass" sass)
  306. (const :tag "Scala" scala)
  307. (const :tag "Scheme" scheme)
  308. (const :tag "Screen" screen)
  309. (const :tag "Shell Script" shell)
  310. (const :tag "Sql" sql)
  311. (const :tag "Sqlite" sqlite)
  312. (const :tag "Stan" stan))
  313. :value-type (boolean :tag "Activate" :value t)))
  314. ;;;; Customization variables
  315. (defcustom org-clone-delete-id nil
  316. "Remove ID property of clones of a subtree.
  317. When non-nil, clones of a subtree don't inherit the ID property.
  318. Otherwise they inherit the ID property with a new unique
  319. identifier."
  320. :type 'boolean
  321. :version "24.1"
  322. :group 'org-id)
  323. ;;; Version
  324. (org-check-version)
  325. ;;;###autoload
  326. (defun org-version (&optional here full message)
  327. "Show the Org version.
  328. Interactively, or when MESSAGE is non-nil, show it in echo area.
  329. With prefix argument, or when HERE is non-nil, insert it at point.
  330. In non-interactive uses, a reduced version string is output unless
  331. FULL is given."
  332. (interactive (list current-prefix-arg t (not current-prefix-arg)))
  333. (let ((org-dir (ignore-errors (org-find-library-dir "org")))
  334. (save-load-suffixes load-suffixes)
  335. (load-suffixes (list ".el"))
  336. (org-install-dir
  337. (ignore-errors (org-find-library-dir "org-loaddefs"))))
  338. (unless (and (fboundp 'org-release) (fboundp 'org-git-version))
  339. (org-load-noerror-mustsuffix (concat org-dir "org-version")))
  340. (let* ((load-suffixes save-load-suffixes)
  341. (release (org-release))
  342. (git-version (org-git-version))
  343. (version (format "Org mode version %s (%s @ %s)"
  344. release
  345. git-version
  346. (if org-install-dir
  347. (if (string= org-dir org-install-dir)
  348. org-install-dir
  349. (concat "mixed installation! "
  350. org-install-dir
  351. " and "
  352. org-dir))
  353. "org-loaddefs.el can not be found!")))
  354. (version1 (if full version release)))
  355. (when here (insert version1))
  356. (when message (message "%s" version1))
  357. version1)))
  358. (defconst org-version (org-version))
  359. ;;; Syntax Constants
  360. ;;;; Comments
  361. (defconst org-comment-regexp
  362. (rx (seq bol (zero-or-more (any "\t ")) "#" (or " " eol)))
  363. "Regular expression for comment lines.")
  364. ;;;; Keyword
  365. (defconst org-keyword-regexp "^[ \t]*#\\+\\(\\S-+?\\):[ \t]*\\(.*\\)$"
  366. "Regular expression for keyword-lines.")
  367. ;;;; Block
  368. (defconst org-block-regexp
  369. "^[ \t]*#\\+begin_?\\([^ \n]+\\)\\(\\([^\n]+\\)\\)?\n\\([^\000]+?\\)#\\+end_?\\1[ \t]*$"
  370. "Regular expression for hiding blocks.")
  371. (defconst org-dblock-start-re
  372. "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+\\(\\S-+\\)\\([ \t]+\\(.*\\)\\)?"
  373. "Matches the start line of a dynamic block, with parameters.")
  374. (defconst org-dblock-end-re "^[ \t]*#\\+\\(?:END\\|end\\)\\([: \t\r\n]\\|$\\)"
  375. "Matches the end of a dynamic block.")
  376. ;;;; Timestamp
  377. (defconst org-ts--internal-regexp
  378. (rx (seq
  379. (= 4 digit) "-" (= 2 digit) "-" (= 2 digit)
  380. (optional " " (*? nonl))))
  381. "Regular expression matching the innards of a time stamp.")
  382. (defconst org-ts-regexp (format "<\\(%s\\)>" org-ts--internal-regexp)
  383. "Regular expression for fast time stamp matching.")
  384. (defconst org-ts-regexp-inactive
  385. (format "\\[\\(%s\\)\\]" org-ts--internal-regexp)
  386. "Regular expression for fast inactive time stamp matching.")
  387. (defconst org-ts-regexp-both (format "[[<]\\(%s\\)[]>]" org-ts--internal-regexp)
  388. "Regular expression for fast time stamp matching.")
  389. (defconst org-ts-regexp0
  390. "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\( +[^]+0-9>\r\n -]+\\)?\\( +\\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
  391. "Regular expression matching time strings for analysis.
  392. This one does not require the space after the date, so it can be used
  393. on a string that terminates immediately after the date.")
  394. (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\(?: *\\([^]+0-9>\r\n -]+\\)\\)?\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
  395. "Regular expression matching time strings for analysis.")
  396. (defconst org-ts-regexp2 (concat "<" org-ts-regexp1 "[^>\n]\\{0,16\\}>")
  397. "Regular expression matching time stamps, with groups.")
  398. (defconst org-ts-regexp3 (concat "[[<]" org-ts-regexp1 "[^]>\n]\\{0,16\\}[]>]")
  399. "Regular expression matching time stamps (also [..]), with groups.")
  400. (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
  401. "Regular expression matching a time stamp range.")
  402. (defconst org-tr-regexp-both
  403. (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
  404. "Regular expression matching a time stamp range.")
  405. (defconst org-tsr-regexp (concat org-ts-regexp "\\(--?-?"
  406. org-ts-regexp "\\)?")
  407. "Regular expression matching a time stamp or time stamp range.")
  408. (defconst org-tsr-regexp-both
  409. (concat org-ts-regexp-both "\\(--?-?"
  410. org-ts-regexp-both "\\)?")
  411. "Regular expression matching a time stamp or time stamp range.
  412. The time stamps may be either active or inactive.")
  413. (defconst org-repeat-re
  414. "<[0-9]\\{4\\}-[0-9][0-9]-[0-9][0-9] [^>\n]*?\
  415. \\([.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)"
  416. "Regular expression for specifying repeated events.
  417. After a match, group 1 contains the repeat expression.")
  418. (defconst org-time-stamp-formats '("<%Y-%m-%d %a>" . "<%Y-%m-%d %a %H:%M>")
  419. "Formats for `format-time-string' which are used for time stamps.")
  420. ;;;; Clock and Planning
  421. (defconst org-clock-string "CLOCK:"
  422. "String used as prefix for timestamps clocking work hours on an item.")
  423. (defvar org-closed-string "CLOSED:"
  424. "String used as the prefix for timestamps logging closing a TODO entry.")
  425. (defvar org-deadline-string "DEADLINE:"
  426. "String to mark deadline entries.
  427. \\<org-mode-map>
  428. A deadline is this string, followed by a time stamp. It must be
  429. a word, terminated by a colon. You can insert a schedule keyword
  430. and a timestamp with `\\[org-deadline]'.")
  431. (defvar org-scheduled-string "SCHEDULED:"
  432. "String to mark scheduled TODO entries.
  433. \\<org-mode-map>
  434. A schedule is this string, followed by a time stamp. It must be
  435. a word, terminated by a colon. You can insert a schedule keyword
  436. and a timestamp with `\\[org-schedule]'.")
  437. (defconst org-ds-keyword-length
  438. (+ 2
  439. (apply #'max
  440. (mapcar #'length
  441. (list org-deadline-string org-scheduled-string
  442. org-clock-string org-closed-string))))
  443. "Maximum length of the DEADLINE and SCHEDULED keywords.")
  444. (defconst org-planning-line-re
  445. (concat "^[ \t]*"
  446. (regexp-opt
  447. (list org-closed-string org-deadline-string org-scheduled-string)
  448. t))
  449. "Matches a line with planning info.
  450. Matched keyword is in group 1.")
  451. (defconst org-clock-line-re
  452. (concat "^[ \t]*" org-clock-string)
  453. "Matches a line with clock info.")
  454. (defconst org-deadline-regexp (concat "\\<" org-deadline-string)
  455. "Matches the DEADLINE keyword.")
  456. (defconst org-deadline-time-regexp
  457. (concat "\\<" org-deadline-string " *<\\([^>]+\\)>")
  458. "Matches the DEADLINE keyword together with a time stamp.")
  459. (defconst org-deadline-time-hour-regexp
  460. (concat "\\<" org-deadline-string
  461. " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9+:hdwmy/ \t.-]*\\)>")
  462. "Matches the DEADLINE keyword together with a time-and-hour stamp.")
  463. (defconst org-deadline-line-regexp
  464. (concat "\\<\\(" org-deadline-string "\\).*")
  465. "Matches the DEADLINE keyword and the rest of the line.")
  466. (defconst org-scheduled-regexp (concat "\\<" org-scheduled-string)
  467. "Matches the SCHEDULED keyword.")
  468. (defconst org-scheduled-time-regexp
  469. (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>")
  470. "Matches the SCHEDULED keyword together with a time stamp.")
  471. (defconst org-scheduled-time-hour-regexp
  472. (concat "\\<" org-scheduled-string
  473. " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9+:hdwmy/ \t.-]*\\)>")
  474. "Matches the SCHEDULED keyword together with a time-and-hour stamp.")
  475. (defconst org-closed-time-regexp
  476. (concat "\\<" org-closed-string " *\\[\\([^]]+\\)\\]")
  477. "Matches the CLOSED keyword together with a time stamp.")
  478. (defconst org-keyword-time-regexp
  479. (concat "\\<"
  480. (regexp-opt
  481. (list org-scheduled-string org-deadline-string org-closed-string
  482. org-clock-string)
  483. t)
  484. " *[[<]\\([^]>]+\\)[]>]")
  485. "Matches any of the 4 keywords, together with the time stamp.")
  486. (defconst org-keyword-time-not-clock-regexp
  487. (concat
  488. "\\<"
  489. (regexp-opt
  490. (list org-scheduled-string org-deadline-string org-closed-string) t)
  491. " *[[<]\\([^]>]+\\)[]>]")
  492. "Matches any of the 3 keywords, together with the time stamp.")
  493. (defconst org-all-time-keywords
  494. (mapcar (lambda (w) (substring w 0 -1))
  495. (list org-scheduled-string org-deadline-string
  496. org-clock-string org-closed-string))
  497. "List of time keywords.")
  498. ;;;; Drawer
  499. (defconst org-drawer-regexp "^[ \t]*:\\(\\(?:\\w\\|[-_]\\)+\\):[ \t]*$"
  500. "Matches first or last line of a hidden block.
  501. Group 1 contains drawer's name or \"END\".")
  502. (defconst org-property-start-re "^[ \t]*:PROPERTIES:[ \t]*$"
  503. "Regular expression matching the first line of a property drawer.")
  504. (defconst org-property-end-re "^[ \t]*:END:[ \t]*$"
  505. "Regular expression matching the last line of a property drawer.")
  506. (defconst org-clock-drawer-start-re "^[ \t]*:CLOCK:[ \t]*$"
  507. "Regular expression matching the first line of a clock drawer.")
  508. (defconst org-clock-drawer-end-re "^[ \t]*:END:[ \t]*$"
  509. "Regular expression matching the last line of a clock drawer.")
  510. (defconst org-logbook-drawer-re
  511. (rx (seq bol (0+ (any "\t ")) ":LOGBOOK:" (0+ (any "\t ")) "\n"
  512. (*? (0+ nonl) "\n")
  513. (0+ (any "\t ")) ":END:" (0+ (any "\t ")) eol))
  514. "Matches an entire LOGBOOK drawer.")
  515. (defconst org-property-drawer-re
  516. (concat "^[ \t]*:PROPERTIES:[ \t]*\n"
  517. "\\(?:[ \t]*:\\S-+:\\(?:[ \t].*\\)?[ \t]*\n\\)*?"
  518. "[ \t]*:END:[ \t]*$")
  519. "Matches an entire property drawer.")
  520. (defconst org-clock-drawer-re
  521. (concat "\\(" org-clock-drawer-start-re "\\)[^\000]*?\\("
  522. org-clock-drawer-end-re "\\)\n?")
  523. "Matches an entire clock drawer.")
  524. ;;;; Headline
  525. (defconst org-heading-keyword-regexp-format
  526. "^\\(\\*+\\)\\(?: +%s\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
  527. "Printf format for a regexp matching a headline with some keyword.
  528. This regexp will match the headline of any node which has the
  529. exact keyword that is put into the format. The keyword isn't in
  530. any group by default, but the stars and the body are.")
  531. (defconst org-heading-keyword-maybe-regexp-format
  532. "^\\(\\*+\\)\\(?: +%s\\)?\\(?: +\\(.*?\\)\\)?[ \t]*$"
  533. "Printf format for a regexp matching a headline, possibly with some keyword.
  534. This regexp can match any headline with the specified keyword, or
  535. without a keyword. The keyword isn't in any group by default,
  536. but the stars and the body are.")
  537. (defconst org-archive-tag "ARCHIVE"
  538. "The tag that marks a subtree as archived.
  539. An archived subtree does not open during visibility cycling, and does
  540. not contribute to the agenda listings.")
  541. (defconst org-tag-re "[[:alnum:]_@#%]+"
  542. "Regexp matching a single tag.")
  543. (defconst org-tag-group-re "[ \t]+\\(:\\([[:alnum:]_@#%:]+\\):\\)[ \t]*$"
  544. "Regexp matching the tag group at the end of a line, with leading spaces.
  545. Tags are stored in match group 1. Match group 2 stores the tags
  546. without the enclosing colons.")
  547. (defconst org-tag-line-re
  548. "^\\*+ \\(?:.*[ \t]\\)?\\(:\\([[:alnum:]_@#%:]+\\):\\)[ \t]*$"
  549. "Regexp matching tags in a headline.
  550. Tags are stored in match group 1. Match group 2 stores the tags
  551. without the enclosing colons.")
  552. (eval-and-compile
  553. (defconst org-comment-string "COMMENT"
  554. "Entries starting with this keyword will never be exported.
  555. \\<org-mode-map>
  556. An entry can be toggled between COMMENT and normal with
  557. `\\[org-toggle-comment]'."))
  558. ;;;; LaTeX Environments and Fragments
  559. (defconst org-latex-regexps
  560. '(("begin" "^[ \t]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^\000]+?\\\\end{\\2}\\)" 1 t)
  561. ;; ("$" "\\([ \t(]\\|^\\)\\(\\(\\([$]\\)\\([^ \t\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \t\n,.$]\\)\\4\\)\\)\\([ \t.,?;:'\")]\\|$\\)" 2 nil)
  562. ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
  563. ("$1" "\\([^$]\\|^\\)\\(\\$[^ \t\r\n,;.$]\\$\\)\\(\\s.\\|\\s-\\|\\s(\\|\\s)\\|\\s\"\\|\000\\|'\\|$\\)" 2 nil)
  564. ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \t\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \t\n,.$]\\)\\$\\)\\)\\(\\s.\\|\\s-\\|\\s(\\|\\s)\\|\\s\"\\|\000\\|'\\|$\\)" 2 nil)
  565. ("\\(" "\\\\([^\000]*?\\\\)" 0 nil)
  566. ("\\[" "\\\\\\[[^\000]*?\\\\\\]" 0 nil)
  567. ("$$" "\\$\\$[^\000]*?\\$\\$" 0 nil))
  568. "Regular expressions for matching embedded LaTeX.")
  569. ;;;; Node Property
  570. (defconst org-effort-property "Effort"
  571. "The property that is being used to keep track of effort estimates.
  572. Effort estimates given in this property need to be in the format
  573. defined in org-duration.el.")
  574. ;;; The custom variables
  575. (defgroup org nil
  576. "Outline-based notes management and organizer."
  577. :tag "Org"
  578. :group 'outlines
  579. :group 'calendar)
  580. (defcustom org-mode-hook nil
  581. "Mode hook for Org mode, run after the mode was turned on."
  582. :group 'org
  583. :type 'hook)
  584. (defcustom org-load-hook nil
  585. "Hook that is run after org.el has been loaded."
  586. :group 'org
  587. :type 'hook)
  588. (make-obsolete-variable
  589. 'org-load-hook
  590. "use `with-eval-after-load' instead." "9.5")
  591. (defcustom org-log-buffer-setup-hook nil
  592. "Hook that is run after an Org log buffer is created."
  593. :group 'org
  594. :version "24.1"
  595. :type 'hook)
  596. (defvar org-modules) ; defined below
  597. (defvar org-modules-loaded nil
  598. "Have the modules been loaded already?")
  599. ;;;###autoload
  600. (defun org-load-modules-maybe (&optional force)
  601. "Load all extensions listed in `org-modules'."
  602. (when (or force (not org-modules-loaded))
  603. (dolist (ext org-modules)
  604. (condition-case nil (require ext)
  605. (error (message "Problems while trying to load feature `%s'" ext))))
  606. (setq org-modules-loaded t)))
  607. (defun org-set-modules (var value)
  608. "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
  609. (set-default-toplevel-value var value)
  610. (when (featurep 'org)
  611. (org-load-modules-maybe 'force)
  612. (org-element-cache-reset 'all)))
  613. (defcustom org-modules '(ol-doi ol-w3m ol-bbdb ol-bibtex ol-docview ol-gnus ol-info ol-irc ol-mhe ol-rmail ol-eww)
  614. "Modules that should always be loaded together with org.el.
  615. If a description starts with <C>, the file is not part of Emacs and Org mode,
  616. so loading it will require that you have properly installed org-contrib
  617. package from NonGNU Emacs Lisp Package Archive
  618. https://elpa.nongnu.org/nongnu/org-contrib.html
  619. You can also use this system to load external packages (i.e. neither Org
  620. core modules, nor org-contrib modules). Just add symbols
  621. to the end of the list. If the package is called org-xyz.el, then you need
  622. to add the symbol `xyz', and the package must have a call to:
  623. (provide \\='org-xyz)
  624. For export specific modules, see also `org-export-backends'."
  625. :group 'org
  626. :set 'org-set-modules
  627. :package-version '(Org . "9.5")
  628. :type
  629. '(set :greedy t
  630. (const :tag " bbdb: Links to BBDB entries" ol-bbdb)
  631. (const :tag " bibtex: Links to BibTeX entries" ol-bibtex)
  632. (const :tag " crypt: Encryption of subtrees" org-crypt)
  633. (const :tag " ctags: Access to Emacs tags with links" org-ctags)
  634. (const :tag " docview: Links to Docview buffers" ol-docview)
  635. (const :tag " doi: Links to DOI references" ol-doi)
  636. (const :tag " eww: Store link to URL of Eww" ol-eww)
  637. (const :tag " gnus: Links to GNUS folders/messages" ol-gnus)
  638. (const :tag " habit: Track your consistency with habits" org-habit)
  639. (const :tag " id: Global IDs for identifying entries" org-id)
  640. (const :tag " info: Links to Info nodes" ol-info)
  641. (const :tag " inlinetask: Tasks independent of outline hierarchy" org-inlinetask)
  642. (const :tag " irc: Links to IRC/ERC chat sessions" ol-irc)
  643. (const :tag " mhe: Links to MHE folders/messages" ol-mhe)
  644. (const :tag " mouse: Additional mouse support" org-mouse)
  645. (const :tag " protocol: Intercept calls from emacsclient" org-protocol)
  646. (const :tag " rmail: Links to RMAIL folders/messages" ol-rmail)
  647. (const :tag " tempo: Fast completion for structures" org-tempo)
  648. (const :tag " w3m: Special cut/paste from w3m to Org mode." ol-w3m)
  649. (const :tag " eshell: Links to working directories in Eshell" ol-eshell)
  650. (const :tag "C annotate-file: Annotate a file with Org syntax" org-annotate-file)
  651. (const :tag "C bookmark: Links to bookmarks" ol-bookmark)
  652. (const :tag "C checklist: Extra functions for checklists in repeated tasks" org-checklist)
  653. (const :tag "C choose: Use TODO keywords to mark decisions states" org-choose)
  654. (const :tag "C collector: Collect properties into tables" org-collector)
  655. (const :tag "C depend: TODO dependencies for Org mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
  656. (const :tag "C elisp-symbol: Links to emacs-lisp symbols" ol-elisp-symbol)
  657. (const :tag "C eval-light: Evaluate inbuffer-code on demand" org-eval-light)
  658. (const :tag "C eval: Include command output as text" org-eval)
  659. (const :tag "C expiry: Expiry mechanism for Org entries" org-expiry)
  660. (const :tag "C git-link: Links to specific file version" ol-git-link)
  661. (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
  662. (const :tag "C invoice: Help manage client invoices in Org mode" org-invoice)
  663. (const :tag "C learn: SuperMemo's incremental learning algorithm" org-learn)
  664. (const :tag "C mac-iCal: Imports events from iCal.app to the Emacs diary" org-mac-iCal)
  665. (const :tag "C mac-link: Grab links and url from various mac Applications" org-mac-link)
  666. (const :tag "C mairix: Hook mairix search into Org for different MUAs" org-mairix)
  667. (const :tag "C man: Links to man pages in Org mode" ol-man)
  668. (const :tag "C mew: Links to Mew folders/messages" ol-mew)
  669. (const :tag "C notify: Notifications for Org mode" org-notify)
  670. (const :tag "C notmuch: Provide Org links to notmuch searches or messages" ol-notmuch)
  671. (const :tag "C panel: Simple routines for us with bad memory" org-panel)
  672. (const :tag "C registry: A registry for Org links" org-registry)
  673. (const :tag "C screen: Visit screen sessions through links" org-screen)
  674. (const :tag "C screenshot: Take and manage screenshots in Org files" org-screenshot)
  675. (const :tag "C secretary: Team management with Org" org-secretary)
  676. (const :tag "C sqlinsert: Convert Org tables to SQL insertions" orgtbl-sqlinsert)
  677. (const :tag "C toc: Table of contents for Org buffer" org-toc)
  678. (const :tag "C track: Keep up with Org mode development" org-track)
  679. (const :tag "C velocity Something like Notational Velocity for Org" org-velocity)
  680. (const :tag "C vm: Links to VM folders/messages" ol-vm)
  681. (const :tag "C wikinodes: CamelCase wiki-like links" org-wikinodes)
  682. (const :tag "C wl: Links to Wanderlust folders/messages" ol-wl)
  683. (repeat :tag "External packages" :inline t (symbol :tag "Package"))))
  684. (defvar org-export-registered-backends) ; From ox.el.
  685. (declare-function org-export-derived-backend-p "ox" (backend &rest backends))
  686. (declare-function org-export-backend-name "ox" (backend) t)
  687. (defcustom org-export-backends '(ascii html icalendar latex odt)
  688. "List of export back-ends that should be always available.
  689. If a description starts with <C>, the file is not part of Emacs and Org mode,
  690. so loading it will require that you have properly installed org-contrib
  691. package from NonGNU Emacs Lisp Package Archive
  692. https://elpa.nongnu.org/nongnu/org-contrib.html
  693. Unlike to `org-modules', libraries in this list will not be
  694. loaded along with Org, but only once the export framework is
  695. needed.
  696. This variable needs to be set before org.el is loaded. If you
  697. need to make a change while Emacs is running, use the customize
  698. interface or run the following code, where VAL stands for the new
  699. value of the variable, after updating it:
  700. (progn
  701. (setq org-export-registered-backends
  702. (cl-remove-if-not
  703. (lambda (backend)
  704. (let ((name (org-export-backend-name backend)))
  705. (or (memq name val)
  706. (catch \\='parentp
  707. (dolist (b val)
  708. (and (org-export-derived-backend-p b name)
  709. (throw \\='parentp t)))))))
  710. org-export-registered-backends))
  711. (let ((new-list (mapcar #\\='org-export-backend-name
  712. org-export-registered-backends)))
  713. (dolist (backend val)
  714. (cond
  715. ((not (load (format \"ox-%s\" backend) t t))
  716. (message \"Problems while trying to load export back-end \\=`%s\\='\"
  717. backend))
  718. ((not (memq backend new-list)) (push backend new-list))))
  719. (set-default \\='org-export-backends new-list)))
  720. Adding a back-end to this list will also pull the back-end it
  721. depends on, if any."
  722. :group 'org
  723. :group 'org-export
  724. :version "26.1"
  725. :package-version '(Org . "9.0")
  726. :initialize 'custom-initialize-set
  727. :set (lambda (var val)
  728. (if (not (featurep 'ox)) (set-default-toplevel-value var val)
  729. ;; Any back-end not required anymore (not present in VAL and not
  730. ;; a parent of any back-end in the new value) is removed from the
  731. ;; list of registered back-ends.
  732. (setq org-export-registered-backends
  733. (cl-remove-if-not
  734. (lambda (backend)
  735. (let ((name (org-export-backend-name backend)))
  736. (or (memq name val)
  737. (catch 'parentp
  738. (dolist (b val)
  739. (and (org-export-derived-backend-p b name)
  740. (throw 'parentp t)))))))
  741. org-export-registered-backends))
  742. ;; Now build NEW-LIST of both new back-ends and required
  743. ;; parents.
  744. (let ((new-list (mapcar #'org-export-backend-name
  745. org-export-registered-backends)))
  746. (dolist (backend val)
  747. (cond
  748. ((not (load (format "ox-%s" backend) t t))
  749. (message "Problems while trying to load export back-end `%s'"
  750. backend))
  751. ((not (memq backend new-list)) (push backend new-list))))
  752. ;; Set VAR to that list with fixed dependencies.
  753. (set-default-toplevel-value var new-list))))
  754. :type '(set :greedy t
  755. (const :tag " ascii Export buffer to ASCII format" ascii)
  756. (const :tag " beamer Export buffer to Beamer presentation" beamer)
  757. (const :tag " html Export buffer to HTML format" html)
  758. (const :tag " icalendar Export buffer to iCalendar format" icalendar)
  759. (const :tag " latex Export buffer to LaTeX format" latex)
  760. (const :tag " man Export buffer to MAN format" man)
  761. (const :tag " md Export buffer to Markdown format" md)
  762. (const :tag " odt Export buffer to ODT format" odt)
  763. (const :tag " org Export buffer to Org format" org)
  764. (const :tag " texinfo Export buffer to Texinfo format" texinfo)
  765. (const :tag "C confluence Export buffer to Confluence Wiki format" confluence)
  766. (const :tag "C deck Export buffer to deck.js presentations" deck)
  767. (const :tag "C freemind Export buffer to Freemind mindmap format" freemind)
  768. (const :tag "C groff Export buffer to Groff format" groff)
  769. (const :tag "C koma-letter Export buffer to KOMA Scrlttrl2 format" koma-letter)
  770. (const :tag "C RSS 2.0 Export buffer to RSS 2.0 format" rss)
  771. (const :tag "C s5 Export buffer to s5 presentations" s5)
  772. (const :tag "C taskjuggler Export buffer to TaskJuggler format" taskjuggler)))
  773. (eval-after-load 'ox
  774. '(dolist (backend org-export-backends)
  775. (condition-case nil (require (intern (format "ox-%s" backend)))
  776. (error (message "Problems while trying to load export back-end `%s'"
  777. backend)))))
  778. (defcustom org-support-shift-select nil
  779. "Non-nil means make shift-cursor commands select text when possible.
  780. \\<org-mode-map>
  781. In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
  782. start selecting a region, or enlarge regions started in this way.
  783. In Org mode, in special contexts, these same keys are used for
  784. other purposes, important enough to compete with shift selection.
  785. Org tries to balance these needs by supporting `shift-select-mode'
  786. outside these special contexts, under control of this variable.
  787. The default of this variable is nil, to avoid confusing behavior. Shifted
  788. cursor keys will then execute Org commands in the following contexts:
  789. - on a headline, changing TODO state (left/right) and priority (up/down)
  790. - on a time stamp, changing the time
  791. - in a plain list item, changing the bullet type
  792. - in a property definition line, switching between allowed values
  793. - in the BEGIN line of a clock table (changing the time block).
  794. - in a table, moving the cell in the specified direction.
  795. Outside these contexts, the commands will throw an error.
  796. When this variable is t and the cursor is not in a special
  797. context, Org mode will support shift-selection for making and
  798. enlarging regions. To make this more effective, the bullet
  799. cycling will no longer happen anywhere in an item line, but only
  800. if the cursor is exactly on the bullet.
  801. If you set this variable to the symbol `always', then the keys
  802. will not be special in headlines, property lines, item lines, and
  803. table cells, to make shift selection work there as well. If this is
  804. what you want, you can use the following alternative commands:
  805. `\\[org-todo]' and `\\[org-priority]' \
  806. to change TODO state and priority,
  807. `\\[universal-argument] \\[universal-argument] \\[org-todo]' \
  808. can be used to switch TODO sets,
  809. `\\[org-ctrl-c-minus]' to cycle item bullet types,
  810. and properties can be edited by hand or in column view.
  811. However, when the cursor is on a timestamp, shift-cursor commands
  812. will still edit the time stamp - this is just too good to give up."
  813. :group 'org
  814. :type '(choice
  815. (const :tag "Never" nil)
  816. (const :tag "When outside special context" t)
  817. (const :tag "Everywhere except timestamps" always)))
  818. (defcustom org-loop-over-headlines-in-active-region t
  819. "Shall some commands act upon headlines in the active region?
  820. When set to t, some commands will be performed in all headlines
  821. within the active region.
  822. When set to `start-level', some commands will be performed in all
  823. headlines within the active region, provided that these headlines
  824. are of the same level than the first one.
  825. When set to a string, those commands will be performed on the
  826. matching headlines within the active region. Such string must be
  827. a tags/property/todo match as it is used in the agenda tags view.
  828. The list of commands is: `org-schedule', `org-deadline',
  829. `org-todo', `org-set-tags-command', `org-archive-subtree',
  830. `org-archive-set-tag', `org-toggle-archive-tag' and
  831. `org-archive-to-archive-sibling'. The archiving commands skip
  832. already archived entries.
  833. See `org-agenda-loop-over-headlines-in-active-region' for the
  834. equivalent option for agenda views."
  835. :type '(choice (const :tag "Don't loop" nil)
  836. (const :tag "All headlines in active region" t)
  837. (const :tag "In active region, headlines at the same level than the first one" start-level)
  838. (string :tag "Tags/Property/Todo matcher"))
  839. :package-version '(Org . "9.4")
  840. :group 'org-todo
  841. :group 'org-archive)
  842. (defcustom org-startup-folded 'showeverything
  843. "Non-nil means entering Org mode will switch to OVERVIEW.
  844. This can also be configured on a per-file basis by adding one of
  845. the following lines anywhere in the buffer:
  846. #+STARTUP: fold (or `overview', this is equivalent)
  847. #+STARTUP: nofold (or `showall', this is equivalent)
  848. #+STARTUP: content
  849. #+STARTUP: show<n>levels (<n> = 2..5)
  850. #+STARTUP: showeverything
  851. Set `org-agenda-inhibit-startup' to a non-nil value if you want
  852. to ignore this option when Org opens agenda files for the first
  853. time."
  854. :group 'org-startup
  855. :package-version '(Org . "9.4")
  856. :type '(choice
  857. (const :tag "nofold: show all" nil)
  858. (const :tag "fold: overview" t)
  859. (const :tag "fold: show two levels" show2levels)
  860. (const :tag "fold: show three levels" show3levels)
  861. (const :tag "fold: show four levels" show4evels)
  862. (const :tag "fold: show five levels" show5levels)
  863. (const :tag "content: all headlines" content)
  864. (const :tag "show everything, even drawers" showeverything)))
  865. (defcustom org-startup-truncated t
  866. "Non-nil means entering Org mode will set `truncate-lines'.
  867. This is useful since some lines containing links can be very long and
  868. uninteresting. Also tables look terrible when wrapped.
  869. The variable `org-startup-truncated' allows to configure
  870. truncation for Org mode different to the other modes that use the
  871. variable `truncate-lines' and as a shortcut instead of putting
  872. the variable `truncate-lines' into the `org-mode-hook'. If one
  873. wants to configure truncation for Org mode not statically but
  874. dynamically e.g. in a hook like `ediff-prepare-buffer-hook' then
  875. the variable `truncate-lines' has to be used because in such a
  876. case it is too late to set the variable `org-startup-truncated'."
  877. :group 'org-startup
  878. :type 'boolean)
  879. (defcustom org-startup-indented nil
  880. "Non-nil means turn on `org-indent-mode' on startup.
  881. This can also be configured on a per-file basis by adding one of
  882. the following lines anywhere in the buffer:
  883. #+STARTUP: indent
  884. #+STARTUP: noindent"
  885. :group 'org-structure
  886. :type '(choice
  887. (const :tag "Not" nil)
  888. (const :tag "Globally (slow on startup in large files)" t)))
  889. (defcustom org-startup-numerated nil
  890. "Non-nil means turn on `org-num-mode' on startup.
  891. This can also be configured on a per-file basis by adding one of
  892. the following lines anywhere in the buffer:
  893. #+STARTUP: num
  894. #+STARTUP: nonum"
  895. :group 'org-structure
  896. :package-version '(Org . "9.4")
  897. :type '(choice
  898. (const :tag "Not" nil)
  899. (const :tag "Globally" t)))
  900. (defcustom org-use-sub-superscripts t
  901. "Non-nil means interpret \"_\" and \"^\" for display.
  902. If you want to control how Org exports those characters, see
  903. `org-export-with-sub-superscripts'.
  904. When this option is turned on, you can use TeX-like syntax for
  905. sub- and superscripts within the buffer. Several characters after
  906. \"_\" or \"^\" will be considered as a single item - so grouping
  907. with {} is normally not needed. For example, the following things
  908. will be parsed as single sub- or superscripts:
  909. 10^24 or 10^tau several digits will be considered 1 item.
  910. 10^-12 or 10^-tau a leading sign with digits or a word
  911. x^2-y^3 will be read as x^2 - y^3, because items are
  912. terminated by almost any nonword/nondigit char.
  913. x_{i^2} or x^(2-i) braces or parenthesis do grouping.
  914. Still, ambiguity is possible. So when in doubt, use {} to enclose
  915. the sub/superscript. If you set this variable to the symbol `{}',
  916. the braces are *required* in order to trigger interpretations as
  917. sub/superscript. This can be helpful in documents that need \"_\"
  918. frequently in plain text."
  919. :group 'org-startup
  920. :version "24.4"
  921. :package-version '(Org . "8.0")
  922. :type '(choice
  923. (const :tag "Always interpret" t)
  924. (const :tag "Only with braces" {})
  925. (const :tag "Never interpret" nil)))
  926. (defcustom org-startup-with-beamer-mode nil
  927. "Non-nil means turn on `org-beamer-mode' on startup.
  928. This can also be configured on a per-file basis by adding one of
  929. the following lines anywhere in the buffer:
  930. #+STARTUP: beamer"
  931. :group 'org-startup
  932. :version "24.1"
  933. :type 'boolean)
  934. (defcustom org-startup-align-all-tables nil
  935. "Non-nil means align all tables when visiting a file.
  936. This can also be configured on a per-file basis by adding one of
  937. the following lines anywhere in the buffer:
  938. #+STARTUP: align
  939. #+STARTUP: noalign"
  940. :group 'org-startup
  941. :type 'boolean)
  942. (defcustom org-startup-shrink-all-tables nil
  943. "Non-nil means shrink all table columns with a width cookie.
  944. This can also be configured on a per-file basis by adding one of
  945. the following lines anywhere in the buffer:
  946. #+STARTUP: shrink"
  947. :group 'org-startup
  948. :type 'boolean
  949. :version "27.1"
  950. :package-version '(Org . "9.2")
  951. :safe #'booleanp)
  952. (defcustom org-startup-with-inline-images nil
  953. "Non-nil means show inline images when loading a new Org file.
  954. This can also be configured on a per-file basis by adding one of
  955. the following lines anywhere in the buffer:
  956. #+STARTUP: inlineimages
  957. #+STARTUP: noinlineimages"
  958. :group 'org-startup
  959. :version "24.1"
  960. :type 'boolean)
  961. (defcustom org-startup-with-latex-preview nil
  962. "Non-nil means preview LaTeX fragments when loading a new Org file.
  963. This can also be configured on a per-file basis by adding one of
  964. the following lines anywhere in the buffer:
  965. #+STARTUP: latexpreview
  966. #+STARTUP: nolatexpreview"
  967. :group 'org-startup
  968. :version "24.4"
  969. :package-version '(Org . "8.0")
  970. :type 'boolean)
  971. (defcustom org-insert-mode-line-in-empty-file nil
  972. "Non-nil means insert the first line setting Org mode in empty files.
  973. When the function `org-mode' is called interactively in an empty file, this
  974. normally means that the file name does not automatically trigger Org mode.
  975. To ensure that the file will always be in Org mode in the future, a
  976. line enforcing Org mode will be inserted into the buffer, if this option
  977. has been set."
  978. :group 'org-startup
  979. :type 'boolean)
  980. (defcustom org-ellipsis nil
  981. "The ellipsis to use in the Org mode outline.
  982. When nil, just use the standard three dots. When a non-empty string,
  983. use that string instead.
  984. The change affects only Org mode (which will then use its own display table).
  985. Changing this requires executing `\\[org-mode]' in a buffer to become
  986. effective. It cannot be set as a local variable."
  987. :group 'org-startup
  988. :type '(choice (const :tag "Default" nil)
  989. (string :tag "String" :value "...#")))
  990. (defvar org-display-table nil
  991. "The display table for Org mode, in case `org-ellipsis' is non-nil.")
  992. (defcustom org-directory "~/org"
  993. "Directory with Org files.
  994. This is just a default location to look for Org files. There is no need
  995. at all to put your files into this directory. It is used in the
  996. following situations:
  997. 1. When a capture template specifies a target file that is not an
  998. absolute path. The path will then be interpreted relative to
  999. `org-directory'
  1000. 2. When the value of variable `org-agenda-files' is a single file, any
  1001. relative paths in this file will be taken as relative to
  1002. `org-directory'."
  1003. :group 'org-refile
  1004. :group 'org-capture
  1005. :type 'directory)
  1006. (defcustom org-default-notes-file (convert-standard-filename "~/.notes")
  1007. "Default target for storing notes.
  1008. Used as a fall back file for org-capture.el, for templates that
  1009. do not specify a target file."
  1010. :group 'org-refile
  1011. :group 'org-capture
  1012. :type 'file)
  1013. (defcustom org-reverse-note-order nil
  1014. "Non-nil means store new notes at the beginning of a file or entry.
  1015. When nil, new notes will be filed to the end of a file or entry.
  1016. This can also be a list with cons cells of regular expressions that
  1017. are matched against file names, and values."
  1018. :group 'org-capture
  1019. :group 'org-refile
  1020. :type '(choice
  1021. (const :tag "Reverse always" t)
  1022. (const :tag "Reverse never" nil)
  1023. (repeat :tag "By file name regexp"
  1024. (cons regexp boolean))))
  1025. (defgroup org-keywords nil
  1026. "Keywords in Org mode."
  1027. :tag "Org Keywords"
  1028. :group 'org)
  1029. (defcustom org-closed-keep-when-no-todo nil
  1030. "Remove CLOSED: time-stamp when switching back to a non-todo state?"
  1031. :group 'org-todo
  1032. :group 'org-keywords
  1033. :version "24.4"
  1034. :package-version '(Org . "8.0")
  1035. :type 'boolean)
  1036. (defgroup org-structure nil
  1037. "Options concerning the general structure of Org files."
  1038. :tag "Org Structure"
  1039. :group 'org)
  1040. (defcustom org-indirect-buffer-display 'other-window
  1041. "How should indirect tree buffers be displayed?
  1042. This applies to indirect buffers created with the commands
  1043. `org-tree-to-indirect-buffer' and `org-agenda-tree-to-indirect-buffer'.
  1044. Valid values are:
  1045. current-window Display in the current window
  1046. other-window Just display in another window.
  1047. dedicated-frame Create one new frame, and re-use it each time.
  1048. new-frame Make a new frame each time. Note that in this case
  1049. previously-made indirect buffers are kept, and you need to
  1050. kill these buffers yourself."
  1051. :group 'org-structure
  1052. :group 'org-agenda-windows
  1053. :type '(choice
  1054. (const :tag "In current window" current-window)
  1055. (const :tag "In current frame, other window" other-window)
  1056. (const :tag "Each time a new frame" new-frame)
  1057. (const :tag "One dedicated frame" dedicated-frame)))
  1058. (defconst org-file-apps-gnu
  1059. '((remote . emacs)
  1060. (system . mailcap)
  1061. (t . mailcap))
  1062. "Default file applications on a UNIX or GNU/Linux system.
  1063. See `org-file-apps'.")
  1064. (defconst org-file-apps-macos
  1065. '((remote . emacs)
  1066. (system . "open %s")
  1067. ("ps.gz" . "gv %s")
  1068. ("eps.gz" . "gv %s")
  1069. ("dvi" . "xdvi %s")
  1070. ("fig" . "xfig %s")
  1071. (t . "open %s"))
  1072. "Default file applications on a macOS system.
  1073. The system \"open\" is known as a default, but we use X11 applications
  1074. for some files for which the OS does not have a good default.
  1075. See `org-file-apps'.")
  1076. (defconst org-file-apps-windowsnt
  1077. (list '(remote . emacs)
  1078. (cons 'system (lambda (file _path)
  1079. (with-no-warnings (w32-shell-execute "open" file))))
  1080. (cons t (lambda (file _path)
  1081. (with-no-warnings (w32-shell-execute "open" file)))))
  1082. "Default file applications on a Windows NT system.
  1083. The system \"open\" is used for most files.
  1084. See `org-file-apps'.")
  1085. (defcustom org-file-apps
  1086. '((auto-mode . emacs)
  1087. (directory . emacs)
  1088. ("\\.mm\\'" . default)
  1089. ("\\.x?html?\\'" . default)
  1090. ("\\.pdf\\'" . default))
  1091. "Applications for opening `file:path' items in a document.
  1092. \\<org-mode-map>
  1093. Org mode uses system defaults for different file types, but you
  1094. can use this variable to set the application for a given file
  1095. extension. The entries in this list are cons cells where the car
  1096. identifies files and the cdr the corresponding command.
  1097. Possible values for the file identifier are:
  1098. \"string\" A string as a file identifier can be interpreted in different
  1099. ways, depending on its contents:
  1100. - Alphanumeric characters only:
  1101. Match links with this file extension.
  1102. Example: (\"pdf\" . \"evince %s\")
  1103. to open PDFs with evince.
  1104. - Regular expression: Match links where the
  1105. filename matches the regexp. If you want to
  1106. use groups here, use shy groups.
  1107. Example: (\"\\\\.x?html\\\\\\='\" . \"firefox %s\")
  1108. (\"\\\\(?:xhtml\\\\|html\\\\)\\\\\\='\" . \"firefox %s\")
  1109. to open *.html and *.xhtml with firefox.
  1110. - Regular expression which contains (non-shy) groups:
  1111. Match links where the whole link, including \"::\", and
  1112. anything after that, matches the regexp.
  1113. In a custom command string, %1, %2, etc. are replaced with
  1114. the parts of the link that were matched by the groups.
  1115. For backwards compatibility, if a command string is given
  1116. that does not use any of the group matches, this case is
  1117. handled identically to the second one (i.e. match against
  1118. file name only).
  1119. In a custom function, you can access the group matches with
  1120. (match-string n link).
  1121. Example: (\"\\\\.pdf::\\\\([0-9]+\\\\)\\\\\\='\" . \
  1122. \"evince -p %1 %s\")
  1123. to open [[file:document.pdf::5]] with evince at page 5.
  1124. Likely, you will need more entries: without page
  1125. number; with search pattern; with cross-reference
  1126. anchor; some combination of options. Consider simple
  1127. pattern here and a Lisp function to determine command
  1128. line arguments instead. Passing argument list to
  1129. `call-process' or `make-process' directly allows to
  1130. avoid treating some character in peculiar file names
  1131. as shell specialls causing executing part of file
  1132. name as a subcommand.
  1133. `directory' Matches a directory
  1134. `remote' Matches a remote file, accessible through tramp.
  1135. Remote files most likely should be visited through Emacs
  1136. because external applications cannot handle such paths.
  1137. `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
  1138. so all files Emacs knows how to handle. Using this with
  1139. command `emacs' will open most files in Emacs. Beware that this
  1140. will also open html files inside Emacs, unless you add
  1141. (\"html\" . default) to the list as well.
  1142. `system' The system command to open files, like `open' on Windows
  1143. and macOS, and mailcap under GNU/Linux. This is the command
  1144. that will be selected if you call `org-open-at-point' with a
  1145. double prefix argument (`\\[universal-argument] \
  1146. \\[universal-argument] \\[org-open-at-point]').
  1147. t Default for files not matched by any of the other options.
  1148. Possible values for the command are:
  1149. `emacs' The file will be visited by the current Emacs process.
  1150. `default' Use the default application for this file type, which is the
  1151. association for t in the list, most likely in the system-specific
  1152. part. This can be used to overrule an unwanted setting in the
  1153. system-specific variable.
  1154. `system' Use the system command for opening files, like \"open\".
  1155. This command is specified by the entry whose car is `system'.
  1156. Most likely, the system-specific version of this variable
  1157. does define this command, but you can overrule/replace it
  1158. here.
  1159. `mailcap' Use command specified in the mailcaps.
  1160. string A command to be executed by a shell; %s will be replaced
  1161. by the path to the file.
  1162. function A Lisp function, which will be called with two arguments:
  1163. the file path and the original link string, without the
  1164. \"file:\" prefix.
  1165. For more examples, see the system specific constants
  1166. `org-file-apps-macos'
  1167. `org-file-apps-windowsnt'
  1168. `org-file-apps-gnu'."
  1169. :group 'org
  1170. :package-version '(Org . "9.4")
  1171. :type '(repeat
  1172. (cons (choice :value ""
  1173. (string :tag "Extension")
  1174. (const :tag "System command to open files" system)
  1175. (const :tag "Default for unrecognized files" t)
  1176. (const :tag "Remote file" remote)
  1177. (const :tag "Links to a directory" directory)
  1178. (const :tag "Any files that have Emacs modes"
  1179. auto-mode))
  1180. (choice :value ""
  1181. (const :tag "Visit with Emacs" emacs)
  1182. (const :tag "Use default" default)
  1183. (const :tag "Use the system command" system)
  1184. (string :tag "Command")
  1185. (function :tag "Function")))))
  1186. (defcustom org-resource-download-policy 'prompt
  1187. "The policy applied to requests to obtain remote resources.
  1188. This affects keywords like #+setupfile and #+incude on export,
  1189. `org-persist-write:url',and `org-attach-url' in non-interactive
  1190. Emacs sessions.
  1191. This recognises four possible values:
  1192. - t, remote resources should always be downloaded.
  1193. - prompt, you will be prompted to download resources nt considered safe.
  1194. - safe, only resources considered safe will be downloaded.
  1195. - nil, never download remote resources.
  1196. A resource is considered safe if it matches one of the patterns
  1197. in `org-safe-remote-resources'."
  1198. :group 'org
  1199. :type '(choice (const :tag "Always download remote resources" t)
  1200. (const :tag "Prompt before downloading an unsafe resource" prompt)
  1201. (const :tag "Only download resources considered safe" safe)
  1202. (const :tag "Never download any resources" nil)))
  1203. (defcustom org-safe-remote-resources nil
  1204. "A list of regexp patterns matching safe URIs.
  1205. URI regexps are applied to both URLs and Org files requesting
  1206. remote resources."
  1207. :group 'org
  1208. :type '(list regexp))
  1209. (defcustom org-open-non-existing-files nil
  1210. "Non-nil means `org-open-file' opens non-existing files.
  1211. When nil, an error is thrown.
  1212. This variable applies only to external applications because they
  1213. might choke on non-existing files. If the link is to a file that
  1214. will be opened in Emacs, the variable is ignored."
  1215. :group 'org
  1216. :type 'boolean
  1217. :safe #'booleanp)
  1218. (defcustom org-open-directory-means-index-dot-org nil
  1219. "When non-nil a link to a directory really means to \"index.org\".
  1220. When nil, following a directory link runs Dired or opens
  1221. a finder/explorer window on that directory."
  1222. :group 'org
  1223. :type 'boolean
  1224. :safe #'booleanp)
  1225. (defcustom org-bookmark-names-plist
  1226. '(:last-capture "org-capture-last-stored"
  1227. :last-refile "org-refile-last-stored"
  1228. :last-capture-marker "org-capture-last-stored-marker")
  1229. "Names for bookmarks automatically set by some Org commands.
  1230. This can provide strings as names for a number of bookmarks Org sets
  1231. automatically. The following keys are currently implemented:
  1232. :last-capture
  1233. :last-capture-marker
  1234. :last-refile
  1235. When a key does not show up in the property list, the corresponding bookmark
  1236. is not set."
  1237. :group 'org-structure
  1238. :type 'plist)
  1239. (defgroup org-edit-structure nil
  1240. "Options concerning structure editing in Org mode."
  1241. :tag "Org Edit Structure"
  1242. :group 'org-structure)
  1243. (defcustom org-odd-levels-only nil
  1244. "Non-nil means skip even levels and only use odd levels for the outline.
  1245. This has the effect that two stars are being added/taken away in
  1246. promotion/demotion commands. It also influences how levels are
  1247. handled by the exporters.
  1248. Changing it requires restart of `font-lock-mode' to become effective
  1249. for fontification also in regions already fontified.
  1250. You may also set this on a per-file basis by adding one of the following
  1251. lines to the buffer:
  1252. #+STARTUP: odd
  1253. #+STARTUP: oddeven"
  1254. :group 'org-edit-structure
  1255. :group 'org-appearance
  1256. :type 'boolean)
  1257. (defcustom org-adapt-indentation nil
  1258. "Non-nil means adapt indentation to outline node level.
  1259. When set to t, Org assumes that you write outlines by indenting
  1260. text in each node to align with the headline, after the stars.
  1261. When this variable is set to `headline-data', Org only adapts the
  1262. indentation of the data lines right below the headline, such as
  1263. planning/clock lines and property/logbook drawers.
  1264. The following issues are influenced by this variable:
  1265. - The indentation is increased by one space in a demotion
  1266. command, and decreased by one in a promotion command. However,
  1267. in the latter case, if shifting some line in the entry body
  1268. would alter document structure (e.g., insert a new headline),
  1269. indentation is not changed at all.
  1270. - Property drawers and planning information is inserted indented
  1271. when this variable is set. When nil, they will not be indented.
  1272. - TAB indents a line relative to current level. The lines below
  1273. a headline will be indented when this variable is set to t.
  1274. Note that this is all about true indentation, by adding and
  1275. removing space characters. See also \"org-indent.el\" which does
  1276. level-dependent indentation in a virtual way, i.e. at display
  1277. time in Emacs."
  1278. :group 'org-edit-structure
  1279. :type '(choice
  1280. (const :tag "Adapt indentation for all lines" t)
  1281. (const :tag "Adapt indentation for headline data lines"
  1282. headline-data)
  1283. (const :tag "Do not adapt indentation at all" nil))
  1284. :safe (lambda (x) (memq x '(t nil headline-data))))
  1285. (defvaralias 'org-special-ctrl-a 'org-special-ctrl-a/e)
  1286. (defcustom org-special-ctrl-a/e nil
  1287. "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
  1288. When t, `C-a' will bring back the cursor to the beginning of the
  1289. headline text, i.e. after the stars and after a possible TODO
  1290. keyword. In an item, this will be the position after bullet and
  1291. check-box, if any. When the cursor is already at that position,
  1292. another `C-a' will bring it to the beginning of the line.
  1293. `C-e' will jump to the end of the headline, ignoring the presence
  1294. of tags in the headline. A second `C-e' will then jump to the
  1295. true end of the line, after any tags. This also means that, when
  1296. this variable is non-nil, `C-e' also will never jump beyond the
  1297. end of the heading of a folded section, i.e. not after the
  1298. ellipses.
  1299. When set to the symbol `reversed', the first `C-a' or `C-e' works
  1300. normally, going to the true line boundary first. Only a directly
  1301. following, identical keypress will bring the cursor to the
  1302. special positions.
  1303. This may also be a cons cell where the behavior for `C-a' and
  1304. `C-e' is set separately."
  1305. :group 'org-edit-structure
  1306. :type '(choice
  1307. (const :tag "off" nil)
  1308. (const :tag "on: after stars/bullet and before tags first" t)
  1309. (const :tag "reversed: true line boundary first" reversed)
  1310. (cons :tag "Set C-a and C-e separately"
  1311. (choice :tag "Special C-a"
  1312. (const :tag "off" nil)
  1313. (const :tag "on: after stars/bullet first" t)
  1314. (const :tag "reversed: before stars/bullet first" reversed))
  1315. (choice :tag "Special C-e"
  1316. (const :tag "off" nil)
  1317. (const :tag "on: before tags first" t)
  1318. (const :tag "reversed: after tags first" reversed)))))
  1319. (defcustom org-special-ctrl-k nil
  1320. "Non-nil means that \\<org-mode-map>\\[org-kill-line] \
  1321. will behave specially in headlines.
  1322. When nil, \\[org-kill-line] will call the default `kill-line' command.
  1323. Otherwise, the following will happen when point is in a headline:
  1324. - At the beginning of a headline, kill the entire line.
  1325. - In the middle of the headline text, kill the text up to the tags.
  1326. - After the headline text and before the tags, kill all the tags."
  1327. :group 'org-edit-structure
  1328. :type 'boolean)
  1329. (defcustom org-ctrl-k-protect-subtree nil
  1330. "Non-nil means, do not delete a hidden subtree with `C-k'.
  1331. When set to the symbol `error', simply throw an error when `C-k' is
  1332. used to kill (part-of) a headline that has hidden text behind it.
  1333. Any other non-nil value will result in a query to the user, if it is
  1334. OK to kill that hidden subtree. When nil, kill without remorse."
  1335. :group 'org-edit-structure
  1336. :version "24.1"
  1337. :type '(choice
  1338. (const :tag "Do not protect hidden subtrees" nil)
  1339. (const :tag "Protect hidden subtrees with a security query" t)
  1340. (const :tag "Never kill a hidden subtree with C-k" error)))
  1341. (defcustom org-special-ctrl-o t
  1342. "Non-nil means, make `open-line' (\\[open-line]) insert a row in tables."
  1343. :group 'org-edit-structure
  1344. :type 'boolean)
  1345. (defcustom org-yank-folded-subtrees t
  1346. "Non-nil means when yanking subtrees, fold them.
  1347. If the kill is a single subtree, or a sequence of subtrees, i.e. if
  1348. it starts with a heading and all other headings in it are either children
  1349. or siblings, then fold all the subtrees. However, do this only if no
  1350. text after the yank would be swallowed into a folded tree by this action."
  1351. :group 'org-edit-structure
  1352. :type 'boolean)
  1353. (defcustom org-yank-adjusted-subtrees nil
  1354. "Non-nil means when yanking subtrees, adjust the level.
  1355. With this setting, `org-paste-subtree' is used to insert the subtree, see
  1356. this function for details."
  1357. :group 'org-edit-structure
  1358. :type 'boolean)
  1359. (defcustom org-M-RET-may-split-line '((default . t))
  1360. "Non-nil means M-RET will split the line at the cursor position.
  1361. When nil, it will go to the end of the line before making a
  1362. new line.
  1363. You may also set this option in a different way for different
  1364. contexts. Valid contexts are:
  1365. headline when creating a new headline
  1366. item when creating a new item
  1367. table in a table field
  1368. default the value to be used for all contexts not explicitly
  1369. customized"
  1370. :group 'org-structure
  1371. :group 'org-table
  1372. :type '(choice
  1373. (const :tag "Always" t)
  1374. (const :tag "Never" nil)
  1375. (repeat :greedy t :tag "Individual contexts"
  1376. (cons
  1377. (choice :tag "Context"
  1378. (const headline)
  1379. (const item)
  1380. (const table)
  1381. (const default))
  1382. (boolean)))))
  1383. (defcustom org-insert-heading-respect-content nil
  1384. "Non-nil means insert new headings after the current subtree.
  1385. \\<org-mode-map>
  1386. When nil, the new heading is created directly after the current line.
  1387. The commands `\\[org-insert-heading-respect-content]' and \
  1388. `\\[org-insert-todo-heading-respect-content]' turn this variable on
  1389. for the duration of the command."
  1390. :group 'org-structure
  1391. :type 'boolean)
  1392. (defcustom org-blank-before-new-entry '((heading . auto)
  1393. (plain-list-item . auto))
  1394. "Should `org-insert-heading' leave a blank line before new heading/item?
  1395. The value is an alist, with `heading' and `plain-list-item' as CAR,
  1396. and a boolean flag as CDR. The cdr may also be the symbol `auto', in
  1397. which case Org will look at the surrounding headings/items and try to
  1398. make an intelligent decision whether to insert a blank line or not."
  1399. :group 'org-edit-structure
  1400. :type '(list
  1401. (cons (const heading)
  1402. (choice (const :tag "Never" nil)
  1403. (const :tag "Always" t)
  1404. (const :tag "Auto" auto)))
  1405. (cons (const plain-list-item)
  1406. (choice (const :tag "Never" nil)
  1407. (const :tag "Always" t)
  1408. (const :tag "Auto" auto)))))
  1409. (defcustom org-insert-heading-hook nil
  1410. "Hook being run after inserting a new heading."
  1411. :group 'org-edit-structure
  1412. :type 'hook)
  1413. (defgroup org-sparse-trees nil
  1414. "Options concerning sparse trees in Org mode."
  1415. :tag "Org Sparse Trees"
  1416. :group 'org-structure)
  1417. (defcustom org-highlight-sparse-tree-matches t
  1418. "Non-nil means highlight all matches that define a sparse tree.
  1419. The highlights will automatically disappear the next time the buffer is
  1420. changed by an edit command."
  1421. :group 'org-sparse-trees
  1422. :type 'boolean)
  1423. (defcustom org-remove-highlights-with-change t
  1424. "Non-nil means any change to the buffer will remove temporary highlights.
  1425. \\<org-mode-map>\
  1426. Such highlights are created by `org-occur' and `org-clock-display'.
  1427. When nil, `\\[org-ctrl-c-ctrl-c]' needs to be used \
  1428. to get rid of the highlights.
  1429. The highlights created by `org-latex-preview' always need
  1430. `\\[org-latex-preview]' to be removed."
  1431. :group 'org-sparse-trees
  1432. :group 'org-time
  1433. :type 'boolean)
  1434. (defcustom org-occur-case-fold-search t
  1435. "Non-nil means `org-occur' should be case-insensitive.
  1436. If set to `smart' the search will be case-insensitive only if it
  1437. doesn't specify any upper case character."
  1438. :group 'org-sparse-trees
  1439. :version "26.1"
  1440. :type '(choice
  1441. (const :tag "Case-sensitive" nil)
  1442. (const :tag "Case-insensitive" t)
  1443. (const :tag "Case-insensitive for lower case searches only" smart)))
  1444. (defcustom org-occur-hook '(org-first-headline-recenter)
  1445. "Hook that is run after `org-occur' has constructed a sparse tree.
  1446. This can be used to recenter the window to show as much of the structure
  1447. as possible."
  1448. :group 'org-sparse-trees
  1449. :type 'hook)
  1450. (defcustom org-self-insert-cluster-for-undo nil
  1451. "Non-nil means cluster self-insert commands for undo when possible.
  1452. If this is set, then, like in the Emacs command loop, 20 consecutive
  1453. characters will be undone together.
  1454. This is configurable, because there is some impact on typing performance."
  1455. :group 'org-table
  1456. :type 'boolean)
  1457. (defvaralias 'org-activate-links 'org-highlight-links)
  1458. (defcustom org-highlight-links '(bracket angle plain radio tag date footnote)
  1459. "Types of links that should be highlighted in Org files.
  1460. This is a list of symbols, each one of them leading to the
  1461. highlighting of a certain link type.
  1462. You can still open links that are not highlighted.
  1463. In principle, it does not hurt to turn on highlighting for all
  1464. link types. There may be a small gain when turning off unused
  1465. link types. The types are:
  1466. bracket The recommended [[link][description]] or [[link]] links with hiding.
  1467. angle Links in angular brackets that may contain whitespace like
  1468. <bbdb:Carsten Dominik>.
  1469. plain Plain links in normal text, no whitespace, like https://gnu.org.
  1470. radio Text that is matched by a radio target, see manual for details.
  1471. tag Tag settings in a headline (link to tag search).
  1472. date Time stamps (link to calendar).
  1473. footnote Footnote labels.
  1474. If you set this variable during an Emacs session, use `org-mode-restart'
  1475. in the Org buffer so that the change takes effect."
  1476. :group 'org-appearance
  1477. :type '(set :greedy t
  1478. (const :tag "Double bracket links" bracket)
  1479. (const :tag "Angular bracket links" angle)
  1480. (const :tag "Plain text links" plain)
  1481. (const :tag "Radio target matches" radio)
  1482. (const :tag "Tags" tag)
  1483. (const :tag "Timestamps" date)
  1484. (const :tag "Footnotes" footnote)))
  1485. (defcustom org-mark-ring-length 4
  1486. "Number of different positions to be recorded in the ring.
  1487. Changing this requires a restart of Emacs to work correctly."
  1488. :group 'org-link-follow
  1489. :type 'integer)
  1490. (defgroup org-todo nil
  1491. "Options concerning TODO items in Org mode."
  1492. :tag "Org TODO"
  1493. :group 'org)
  1494. (defgroup org-progress nil
  1495. "Options concerning Progress logging in Org mode."
  1496. :tag "Org Progress"
  1497. :group 'org-time)
  1498. (defvar org-todo-interpretation-widgets
  1499. '((:tag "Sequence (cycling hits every state)" sequence)
  1500. (:tag "Type (cycling directly to DONE)" type))
  1501. "The available interpretation symbols for customizing `org-todo-keywords'.
  1502. Interested libraries should add to this list.")
  1503. (defcustom org-todo-keywords '((sequence "TODO" "DONE"))
  1504. "List of TODO entry keyword sequences and their interpretation.
  1505. \\<org-mode-map>This is a list of sequences.
  1506. Each sequence starts with a symbol, either `sequence' or `type',
  1507. indicating if the keywords should be interpreted as a sequence of
  1508. action steps, or as different types of TODO items. The first
  1509. keywords are states requiring action - these states will select a headline
  1510. for inclusion into the global TODO list Org produces. If one of the
  1511. \"keywords\" is the vertical bar, \"|\", the remaining keywords
  1512. signify that no further action is necessary. If \"|\" is not found,
  1513. the last keyword is treated as the only DONE state of the sequence.
  1514. The command `\\[org-todo]' cycles an entry through these states, and one
  1515. additional state where no keyword is present. For details about this
  1516. cycling, see the manual.
  1517. TODO keywords and interpretation can also be set on a per-file basis with
  1518. the special #+SEQ_TODO and #+TYP_TODO lines.
  1519. Each keyword can optionally specify a character for fast state selection
  1520. \(in combination with the variable `org-use-fast-todo-selection')
  1521. and specifiers for state change logging, using the same syntax that
  1522. is used in the \"#+TODO:\" lines. For example, \"WAIT(w)\" says that
  1523. the WAIT state can be selected with the \"w\" key. \"WAIT(w!)\"
  1524. indicates to record a time stamp each time this state is selected.
  1525. Each keyword may also specify if a timestamp or a note should be
  1526. recorded when entering or leaving the state, by adding additional
  1527. characters in the parenthesis after the keyword. This looks like this:
  1528. \"WAIT(w@/!)\". \"@\" means to add a note (with time), \"!\" means to
  1529. record only the time of the state change. With X and Y being either
  1530. \"@\" or \"!\", \"X/Y\" means use X when entering the state, and use
  1531. Y when leaving the state if and only if the *target* state does not
  1532. define X. You may omit any of the fast-selection key or X or /Y,
  1533. so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
  1534. For backward compatibility, this variable may also be just a list
  1535. of keywords. In this case the interpretation (sequence or type) will be
  1536. taken from the (otherwise obsolete) variable `org-todo-interpretation'."
  1537. :group 'org-todo
  1538. :group 'org-keywords
  1539. :type '(choice
  1540. (repeat :tag "Old syntax, just keywords"
  1541. (string :tag "Keyword"))
  1542. (repeat :tag "New syntax"
  1543. (cons
  1544. (choice
  1545. :tag "Interpretation"
  1546. ;;Quick and dirty way to see
  1547. ;;`org-todo-interpretation'. This takes the
  1548. ;;place of item arguments
  1549. :convert-widget
  1550. (lambda (widget)
  1551. (widget-put widget
  1552. :args (mapcar
  1553. (lambda (x)
  1554. (widget-convert
  1555. (cons 'const x)))
  1556. org-todo-interpretation-widgets))
  1557. widget))
  1558. (repeat
  1559. (string :tag "Keyword"))))))
  1560. (defvar-local org-todo-keywords-1 nil
  1561. "All TODO and DONE keywords active in a buffer.")
  1562. (defvar org-todo-keywords-for-agenda nil)
  1563. (defvar org-done-keywords-for-agenda nil)
  1564. (defvar org-todo-keyword-alist-for-agenda nil)
  1565. (defvar org-tag-alist-for-agenda nil
  1566. "Alist of all tags from all agenda files.")
  1567. (defvar org-tag-groups-alist-for-agenda nil
  1568. "Alist of all groups tags from all current agenda files.")
  1569. (defvar-local org-tag-groups-alist nil)
  1570. (defvar org-agenda-contributing-files nil)
  1571. (defvar-local org-current-tag-alist nil
  1572. "Alist of all tag groups in current buffer.
  1573. This variable takes into consideration `org-tag-alist',
  1574. `org-tag-persistent-alist' and TAGS keywords in the buffer.")
  1575. (defvar-local org-not-done-keywords nil)
  1576. (defvar-local org-done-keywords nil)
  1577. (defvar-local org-todo-heads nil)
  1578. (defvar-local org-todo-sets nil)
  1579. (defvar-local org-todo-log-states nil)
  1580. (defvar-local org-todo-kwd-alist nil)
  1581. (defvar-local org-todo-key-alist nil)
  1582. (defvar-local org-todo-key-trigger nil)
  1583. (defcustom org-todo-interpretation 'sequence
  1584. "Controls how TODO keywords are interpreted.
  1585. This variable is in principle obsolete and is only used for
  1586. backward compatibility, if the interpretation of todo keywords is
  1587. not given already in `org-todo-keywords'. See that variable for
  1588. more information."
  1589. :group 'org-todo
  1590. :group 'org-keywords
  1591. :type '(choice (const sequence)
  1592. (const type)))
  1593. (defcustom org-use-fast-todo-selection 'auto
  1594. "\\<org-mode-map>\
  1595. Non-nil means use the fast todo selection scheme with `\\[org-todo]'.
  1596. This variable describes if and under what circumstances the cycling
  1597. mechanism for TODO keywords will be replaced by a single-key, direct
  1598. selection scheme, where the choices are displayed in a little window.
  1599. When nil, fast selection is never used. This means that the command
  1600. will always switch to the next state.
  1601. When it is the symbol `auto', fast selection is whenever selection
  1602. keys have been defined.
  1603. `expert' is like `auto', but no special window with the keyword
  1604. will be shown, choices will only be listed in the prompt.
  1605. In all cases, the special interface is only used if access keys have
  1606. actually been assigned by the user, i.e. if keywords in the configuration
  1607. are followed by a letter in parenthesis, like TODO(t)."
  1608. :group 'org-todo
  1609. :set (lambda (var val)
  1610. (cond
  1611. ((eq var t) (set-default-toplevel-value var 'auto))
  1612. ((eq var 'prefix) (set-default-toplevel-value var nil))
  1613. (t (set-default-toplevel-value var val))))
  1614. :type '(choice
  1615. (const :tag "Never" nil)
  1616. (const :tag "Automatically, when key letter have been defined" auto)
  1617. (const :tag "Automatically, but don't show the selection window" expert)))
  1618. (defcustom org-provide-todo-statistics t
  1619. "Non-nil means update todo statistics after insert and toggle.
  1620. ALL-HEADLINES means update todo statistics by including headlines
  1621. with no TODO keyword as well, counting them as not done.
  1622. A list of TODO keywords means the same, but skip keywords that are
  1623. not in this list.
  1624. When set to a list of two lists, the first list contains keywords
  1625. to consider as TODO keywords, the second list contains keywords
  1626. to consider as DONE keywords.
  1627. When this is set, todo statistics is updated in the parent of the
  1628. current entry each time a todo state is changed."
  1629. :group 'org-todo
  1630. :type '(choice
  1631. (const :tag "Yes, only for TODO entries" t)
  1632. (const :tag "Yes, including all entries" all-headlines)
  1633. (repeat :tag "Yes, for TODOs in this list"
  1634. (string :tag "TODO keyword"))
  1635. (list :tag "Yes, for TODOs and DONEs in these lists"
  1636. (repeat (string :tag "TODO keyword"))
  1637. (repeat (string :tag "DONE keyword")))
  1638. (other :tag "No TODO statistics" nil)))
  1639. (defcustom org-hierarchical-todo-statistics t
  1640. "Non-nil means TODO statistics covers just direct children.
  1641. When nil, all entries in the subtree are considered.
  1642. This has only an effect if `org-provide-todo-statistics' is set.
  1643. To set this to nil for only a single subtree, use a COOKIE_DATA
  1644. property and include the word \"recursive\" into the value."
  1645. :group 'org-todo
  1646. :type 'boolean)
  1647. (defcustom org-after-todo-state-change-hook nil
  1648. "Hook which is run after the state of a TODO item was changed.
  1649. The new state (a string with a TODO keyword, or nil) is available in the
  1650. Lisp variable `org-state'."
  1651. :group 'org-todo
  1652. :type 'hook)
  1653. (defvar org-blocker-hook nil
  1654. "Hook for functions that are allowed to block a state change.
  1655. Functions in this hook should not modify the buffer.
  1656. Each function gets as its single argument a property list,
  1657. see `org-trigger-hook' for more information about this list.
  1658. If any of the functions in this hook returns nil, the state change
  1659. is blocked.")
  1660. (defvar org-trigger-hook nil
  1661. "Hook for functions that are triggered by a state change.
  1662. Each function gets as its single argument a property list with at
  1663. least the following elements:
  1664. (:type type-of-change :position pos-at-entry-start
  1665. :from old-state :to new-state)
  1666. Depending on the type, more properties may be present.
  1667. This mechanism is currently implemented for:
  1668. TODO state changes
  1669. ------------------
  1670. :type todo-state-change
  1671. :from previous state (keyword as a string), or nil, or a symbol
  1672. `todo' or `done', to indicate the general type of state.
  1673. :to new state, like in :from")
  1674. (defcustom org-enforce-todo-dependencies nil
  1675. "Non-nil means undone TODO entries will block switching the parent to DONE.
  1676. Also, if a parent has an :ORDERED: property, switching an entry to DONE will
  1677. be blocked if any prior sibling is not yet done.
  1678. Finally, if the parent is blocked because of ordered siblings of its own,
  1679. the child will also be blocked."
  1680. :set (lambda (var val)
  1681. (set-default-toplevel-value var val)
  1682. (if val
  1683. (add-hook 'org-blocker-hook
  1684. 'org-block-todo-from-children-or-siblings-or-parent)
  1685. (remove-hook 'org-blocker-hook
  1686. 'org-block-todo-from-children-or-siblings-or-parent)))
  1687. :group 'org-todo
  1688. :type 'boolean)
  1689. (defcustom org-enforce-todo-checkbox-dependencies nil
  1690. "Non-nil means unchecked boxes will block switching the parent to DONE.
  1691. When this is nil, checkboxes have no influence on switching TODO states.
  1692. When non-nil, you first need to check off all check boxes before the TODO
  1693. entry can be switched to DONE.
  1694. This variable needs to be set before org.el is loaded, and you need to
  1695. restart Emacs after a change to make the change effective. The only way
  1696. to change it while Emacs is running is through the customize interface."
  1697. :set (lambda (var val)
  1698. (set-default-toplevel-value var val)
  1699. (if val
  1700. (add-hook 'org-blocker-hook
  1701. 'org-block-todo-from-checkboxes)
  1702. (remove-hook 'org-blocker-hook
  1703. 'org-block-todo-from-checkboxes)))
  1704. :group 'org-todo
  1705. :type 'boolean)
  1706. (defcustom org-treat-insert-todo-heading-as-state-change nil
  1707. "Non-nil means inserting a TODO heading is treated as state change.
  1708. So when the command `\\[org-insert-todo-heading]' is used, state change
  1709. logging will apply if appropriate. When nil, the new TODO item will
  1710. be inserted directly, and no logging will take place."
  1711. :group 'org-todo
  1712. :type 'boolean)
  1713. (defcustom org-treat-S-cursor-todo-selection-as-state-change t
  1714. "Non-nil means switching TODO states with S-cursor counts as state change.
  1715. This is the default behavior. However, setting this to nil allows a
  1716. convenient way to select a TODO state and bypass any logging associated
  1717. with that."
  1718. :group 'org-todo
  1719. :type 'boolean)
  1720. (defcustom org-todo-state-tags-triggers nil
  1721. "Tag changes that should be triggered by TODO state changes.
  1722. This is a list. Each entry is
  1723. (state-change (tag . flag) .......)
  1724. State-change can be a string with a state, and empty string to indicate the
  1725. state that has no TODO keyword, or it can be one of the symbols `todo'
  1726. or `done', meaning any not-done or done state, respectively."
  1727. :group 'org-todo
  1728. :group 'org-tags
  1729. :type '(repeat
  1730. (cons (choice :tag "When changing to"
  1731. (const :tag "Not-done state" todo)
  1732. (const :tag "Done state" done)
  1733. (string :tag "State"))
  1734. (repeat
  1735. (cons :tag "Tag action"
  1736. (string :tag "Tag")
  1737. (choice (const :tag "Add" t) (const :tag "Remove" nil)))))))
  1738. (defcustom org-log-done nil
  1739. "Information to record when a task moves to the DONE state.
  1740. Possible values are:
  1741. nil Don't add anything, just change the keyword
  1742. time Add a time stamp to the task
  1743. note Prompt for a note and add it with template `org-log-note-headings'
  1744. This option can also be set with on a per-file-basis with
  1745. #+STARTUP: nologdone
  1746. #+STARTUP: logdone
  1747. #+STARTUP: lognotedone
  1748. You can have local logging settings for a subtree by setting the LOGGING
  1749. property to one or more of these keywords."
  1750. :group 'org-todo
  1751. :group 'org-progress
  1752. :type '(choice
  1753. (const :tag "No logging" nil)
  1754. (const :tag "Record CLOSED timestamp" time)
  1755. (const :tag "Record CLOSED timestamp with note." note)))
  1756. ;; Normalize old uses of org-log-done.
  1757. (cond
  1758. ((eq org-log-done t) (setq org-log-done 'time))
  1759. ((and (listp org-log-done) (memq 'done org-log-done))
  1760. (setq org-log-done 'note)))
  1761. (defcustom org-log-reschedule nil
  1762. "Information to record when the scheduling date of a task is modified.
  1763. Possible values are:
  1764. nil Don't add anything, just change the date
  1765. time Add a time stamp to the task
  1766. note Prompt for a note and add it with template `org-log-note-headings'
  1767. This option can also be set with on a per-file-basis with
  1768. #+STARTUP: nologreschedule
  1769. #+STARTUP: logreschedule
  1770. #+STARTUP: lognotereschedule
  1771. You can have local logging settings for a subtree by setting the LOGGING
  1772. property to one or more of these keywords.
  1773. This variable has an effect when calling `org-schedule' or
  1774. `org-agenda-schedule' only."
  1775. :group 'org-todo
  1776. :group 'org-progress
  1777. :type '(choice
  1778. (const :tag "No logging" nil)
  1779. (const :tag "Record timestamp" time)
  1780. (const :tag "Record timestamp with note" note)))
  1781. (defcustom org-log-redeadline nil
  1782. "Information to record when the deadline date of a task is modified.
  1783. Possible values are:
  1784. nil Don't add anything, just change the date
  1785. time Add a time stamp to the task
  1786. note Prompt for a note and add it with template `org-log-note-headings'
  1787. This option can also be set with on a per-file-basis with
  1788. #+STARTUP: nologredeadline
  1789. #+STARTUP: logredeadline
  1790. #+STARTUP: lognoteredeadline
  1791. You can have local logging settings for a subtree by setting the LOGGING
  1792. property to one or more of these keywords.
  1793. This variable has an effect when calling `org-deadline' or
  1794. `org-agenda-deadline' only."
  1795. :group 'org-todo
  1796. :group 'org-progress
  1797. :type '(choice
  1798. (const :tag "No logging" nil)
  1799. (const :tag "Record timestamp" time)
  1800. (const :tag "Record timestamp with note." note)))
  1801. (defcustom org-log-note-clock-out nil
  1802. "Non-nil means record a note when clocking out of an item.
  1803. This can also be configured on a per-file basis by adding one of
  1804. the following lines anywhere in the buffer:
  1805. #+STARTUP: lognoteclock-out
  1806. #+STARTUP: nolognoteclock-out"
  1807. :group 'org-todo
  1808. :group 'org-progress
  1809. :type 'boolean)
  1810. (defcustom org-log-done-with-time t
  1811. "Non-nil means the CLOSED time stamp will contain date and time.
  1812. When nil, only the date will be recorded."
  1813. :group 'org-progress
  1814. :type 'boolean)
  1815. (defcustom org-log-note-headings
  1816. '((done . "CLOSING NOTE %t")
  1817. (state . "State %-12s from %-12S %t")
  1818. (note . "Note taken on %t")
  1819. (reschedule . "Rescheduled from %S on %t")
  1820. (delschedule . "Not scheduled, was %S on %t")
  1821. (redeadline . "New deadline from %S on %t")
  1822. (deldeadline . "Removed deadline, was %S on %t")
  1823. (refile . "Refiled on %t")
  1824. (clock-out . ""))
  1825. "Headings for notes added to entries.
  1826. The value is an alist, with the car being a symbol indicating the
  1827. note context, and the cdr is the heading to be used. The heading
  1828. may also be the empty string. The following placeholders can be
  1829. used:
  1830. %t a time stamp.
  1831. %T an active time stamp instead the default inactive one
  1832. %d a short-format time stamp.
  1833. %D an active short-format time stamp.
  1834. %s the new TODO state or time stamp (inactive), in double quotes.
  1835. %S the old TODO state or time stamp (inactive), in double quotes.
  1836. %u the user name.
  1837. %U full user name.
  1838. In fact, it is not a good idea to change the `state' entry,
  1839. because Agenda Log mode depends on the format of these entries."
  1840. :group 'org-todo
  1841. :group 'org-progress
  1842. :type '(list :greedy t
  1843. (cons (const :tag "Heading when closing an item" done) string)
  1844. (cons (const :tag
  1845. "Heading when changing todo state (todo sequence only)"
  1846. state) string)
  1847. (cons (const :tag "Heading when just taking a note" note) string)
  1848. (cons (const :tag "Heading when rescheduling" reschedule) string)
  1849. (cons (const :tag "Heading when an item is no longer scheduled" delschedule) string)
  1850. (cons (const :tag "Heading when changing deadline" redeadline) string)
  1851. (cons (const :tag "Heading when deleting a deadline" deldeadline) string)
  1852. (cons (const :tag "Heading when refiling" refile) string)
  1853. (cons (const :tag "Heading when clocking out" clock-out) string)))
  1854. (unless (assq 'note org-log-note-headings)
  1855. (push '(note . "%t") org-log-note-headings))
  1856. (defvaralias 'org-log-state-notes-into-drawer 'org-log-into-drawer)
  1857. (defcustom org-log-into-drawer nil
  1858. "Non-nil means insert state change notes and time stamps into a drawer.
  1859. When nil, state changes notes will be inserted after the headline and
  1860. any scheduling and clock lines, but not inside a drawer.
  1861. The value of this variable should be the name of the drawer to use.
  1862. LOGBOOK is proposed as the default drawer for this purpose, you can
  1863. also set this to a string to define the drawer of your choice.
  1864. A value of t is also allowed, representing \"LOGBOOK\".
  1865. A value of t or nil can also be set with on a per-file-basis with
  1866. #+STARTUP: logdrawer
  1867. #+STARTUP: nologdrawer
  1868. If this variable is set, `org-log-state-notes-insert-after-drawers'
  1869. will be ignored.
  1870. You can set the property LOG_INTO_DRAWER to overrule this setting for
  1871. a subtree.
  1872. Do not check directly this variable in a Lisp program. Call
  1873. function `org-log-into-drawer' instead."
  1874. :group 'org-todo
  1875. :group 'org-progress
  1876. :type '(choice
  1877. (const :tag "Not into a drawer" nil)
  1878. (const :tag "LOGBOOK" t)
  1879. (string :tag "Other")))
  1880. (defun org-log-into-drawer ()
  1881. "Name of the log drawer, as a string, or nil.
  1882. This is the value of `org-log-into-drawer'. However, if the
  1883. current entry has or inherits a LOG_INTO_DRAWER property, it will
  1884. be used instead of the default value."
  1885. (let ((p (org-entry-get nil "LOG_INTO_DRAWER" 'inherit t)))
  1886. (cond ((equal p "nil") nil)
  1887. ((equal p "t") "LOGBOOK")
  1888. ((stringp p) p)
  1889. (p "LOGBOOK")
  1890. ((stringp org-log-into-drawer) org-log-into-drawer)
  1891. (org-log-into-drawer "LOGBOOK"))))
  1892. (defcustom org-log-state-notes-insert-after-drawers nil
  1893. "Non-nil means insert state change notes after any drawers in entry.
  1894. Only the drawers that *immediately* follow the headline and the
  1895. deadline/scheduled line are skipped.
  1896. When nil, insert notes right after the heading and perhaps the line
  1897. with deadline/scheduling if present.
  1898. This variable will have no effect if `org-log-into-drawer' is
  1899. set."
  1900. :group 'org-todo
  1901. :group 'org-progress
  1902. :type 'boolean)
  1903. (defcustom org-log-states-order-reversed t
  1904. "Non-nil means the latest state note will be directly after heading.
  1905. When nil, the state change notes will be ordered according to time.
  1906. This option can also be set with on a per-file-basis with
  1907. #+STARTUP: logstatesreversed
  1908. #+STARTUP: nologstatesreversed"
  1909. :group 'org-todo
  1910. :group 'org-progress
  1911. :type 'boolean)
  1912. (defcustom org-todo-repeat-to-state nil
  1913. "The TODO state to which a repeater should return the repeating task.
  1914. By default this is the first task of a TODO sequence or the
  1915. previous state of a TYPE_TODO set. But you can specify to use
  1916. the previous state in a TODO sequence or a string.
  1917. Alternatively, you can set the :REPEAT_TO_STATE: property of the
  1918. entry, which has precedence over this option."
  1919. :group 'org-todo
  1920. :version "24.1"
  1921. :type '(choice (const :tag "Use the previous TODO state" t)
  1922. (const :tag "Use the head of the TODO sequence" nil)
  1923. (string :tag "Use a specific TODO state")))
  1924. (defcustom org-log-repeat 'time
  1925. "Non-nil means record moving through the DONE state when triggering repeat.
  1926. An auto-repeating task is immediately switched back to TODO when
  1927. marked DONE. If you are not logging state changes (by adding \"@\"
  1928. or \"!\" to the TODO keyword definition), or set `org-log-done' to
  1929. record a closing note, there will be no record of the task moving
  1930. through DONE. This variable forces taking a note anyway.
  1931. nil Don't force a record
  1932. time Record a time stamp
  1933. note Prompt for a note and add it with template `org-log-note-headings'
  1934. This option can also be set with on a per-file-basis with
  1935. #+STARTUP: nologrepeat
  1936. #+STARTUP: logrepeat
  1937. #+STARTUP: lognoterepeat
  1938. You can have local logging settings for a subtree by setting the LOGGING
  1939. property to one or more of these keywords."
  1940. :group 'org-todo
  1941. :group 'org-progress
  1942. :type '(choice
  1943. (const :tag "Don't force a record" nil)
  1944. (const :tag "Force recording the DONE state" time)
  1945. (const :tag "Force recording a note with the DONE state" note)))
  1946. (defcustom org-todo-repeat-hook nil
  1947. "Hook that is run after a task has been repeated."
  1948. :package-version '(Org . "9.2")
  1949. :group 'org-todo
  1950. :type 'hook)
  1951. (defgroup org-priorities nil
  1952. "Priorities in Org mode."
  1953. :tag "Org Priorities"
  1954. :group 'org-todo)
  1955. (defvaralias 'org-enable-priority-commands 'org-priority-enable-commands)
  1956. (defcustom org-priority-enable-commands t
  1957. "Non-nil means priority commands are active.
  1958. When nil, these commands will be disabled, so that you never accidentally
  1959. set a priority."
  1960. :group 'org-priorities
  1961. :type 'boolean)
  1962. (defvaralias 'org-highest-priority 'org-priority-highest)
  1963. (defcustom org-priority-highest ?A
  1964. "The highest priority of TODO items.
  1965. A character like ?A, ?B, etc., or a numeric value like 1, 2, etc.
  1966. The default is the character ?A, which is 65 as a numeric value.
  1967. If you set `org-priority-highest' to a numeric value inferior to
  1968. 65, Org assumes you want to use digits for the priority cookie.
  1969. If you set it to >=65, Org assumes you want to use alphabetical
  1970. characters.
  1971. In both cases, the value of `org-priority-highest' must be
  1972. smaller than `org-priority-lowest': for example, if \"A\" is the
  1973. highest priority, it is smaller than the lowest \"C\" priority:
  1974. 65 < 67."
  1975. :group 'org-priorities
  1976. :type '(choice
  1977. (character :tag "Character")
  1978. (integer :tag "Integer (< 65)")))
  1979. (defvaralias 'org-lowest-priority 'org-priority-lowest)
  1980. (defcustom org-priority-lowest ?C
  1981. "The lowest priority of TODO items.
  1982. A character like ?C, ?B, etc., or a numeric value like 9, 8, etc.
  1983. The default is the character ?C, which is 67 as a numeric value.
  1984. If you set `org-priority-lowest' to a numeric value inferior to
  1985. 65, Org assumes you want to use digits for the priority cookie.
  1986. If you set it to >=65, Org assumes you want to use alphabetical
  1987. characters.
  1988. In both cases, the value of `org-priority-lowest' must be greater
  1989. than `org-priority-highest': for example, if \"C\" is the lowest
  1990. priority, it is greater than the highest \"A\" priority: 67 >
  1991. 65."
  1992. :group 'org-priorities
  1993. :type '(choice
  1994. (character :tag "Character")
  1995. (integer :tag "Integer (< 65)")))
  1996. (defvaralias 'org-default-priority 'org-priority-default)
  1997. (defcustom org-priority-default ?B
  1998. "The default priority of TODO items.
  1999. This is the priority an item gets if no explicit priority is given.
  2000. When starting to cycle on an empty priority the first step in the cycle
  2001. depends on `org-priority-start-cycle-with-default'. The resulting first
  2002. step priority must not exceed the range from `org-priority-highest' to
  2003. `org-priority-lowest' which means that `org-priority-default' has to be
  2004. in this range exclusive or inclusive to the range boundaries. Else the
  2005. first step refuses to set the default and the second will fall back on
  2006. \(depending on the command used) the highest or lowest priority."
  2007. :group 'org-priorities
  2008. :type '(choice
  2009. (character :tag "Character")
  2010. (integer :tag "Integer (< 65)")))
  2011. (defcustom org-priority-start-cycle-with-default t
  2012. "Non-nil means start with default priority when starting to cycle.
  2013. When this is nil, the first step in the cycle will be (depending on the
  2014. command used) one higher or lower than the default priority.
  2015. See also `org-priority-default'."
  2016. :group 'org-priorities
  2017. :type 'boolean)
  2018. (defvaralias 'org-get-priority-function 'org-priority-get-priority-function)
  2019. (defcustom org-priority-get-priority-function nil
  2020. "Function to extract the priority from a string.
  2021. The string is normally the headline. If this is nil, Org
  2022. computes the priority from the priority cookie like [#A] in the
  2023. headline. It returns an integer, increasing by 1000 for each
  2024. priority level.
  2025. The user can set a different function here, which should take a
  2026. string as an argument and return the numeric priority."
  2027. :group 'org-priorities
  2028. :version "24.1"
  2029. :type '(choice
  2030. (const nil)
  2031. (function)))
  2032. (defgroup org-time nil
  2033. "Options concerning time stamps and deadlines in Org mode."
  2034. :tag "Org Time"
  2035. :group 'org)
  2036. (defcustom org-time-stamp-rounding-minutes '(0 5)
  2037. "Number of minutes to round time stamps to.
  2038. \\<org-mode-map>\
  2039. These are two values, the first applies when first creating a time stamp.
  2040. The second applies when changing it with the commands `S-up' and `S-down'.
  2041. When changing the time stamp, this means that it will change in steps
  2042. of N minutes, as given by the second value.
  2043. When a setting is 0 or 1, insert the time unmodified. Useful rounding
  2044. numbers should be factors of 60, so for example 5, 10, 15.
  2045. When this is larger than 1, you can still force an exact time stamp by using
  2046. a double prefix argument to a time stamp command like \
  2047. `\\[org-time-stamp]' or `\\[org-time-stamp-inactive],
  2048. and by using a prefix arg to `S-up/down' to specify the exact number
  2049. of minutes to shift."
  2050. :group 'org-time
  2051. :get (lambda (var) ; Make sure both elements are there
  2052. (if (integerp (default-value var))
  2053. (list (default-value var) 5)
  2054. (default-value var)))
  2055. :type '(list
  2056. (integer :tag "when inserting times")
  2057. (integer :tag "when modifying times")))
  2058. ;; Normalize old customizations of this variable.
  2059. (when (integerp org-time-stamp-rounding-minutes)
  2060. (setq org-time-stamp-rounding-minutes
  2061. (list org-time-stamp-rounding-minutes
  2062. org-time-stamp-rounding-minutes)))
  2063. (defcustom org-display-custom-times nil
  2064. "Non-nil means overlay custom formats over all time stamps.
  2065. The formats are defined through the variable `org-time-stamp-custom-formats'.
  2066. To turn this on on a per-file basis, insert anywhere in the file:
  2067. #+STARTUP: customtime"
  2068. :group 'org-time
  2069. :type 'sexp)
  2070. (make-variable-buffer-local 'org-display-custom-times)
  2071. (defcustom org-time-stamp-custom-formats
  2072. '("<%m/%d/%y %a>" . "<%m/%d/%y %a %H:%M>") ; american
  2073. "Custom formats for time stamps. See `format-time-string' for the syntax.
  2074. These are overlaid over the default ISO format if the variable
  2075. `org-display-custom-times' is set. Time like %H:%M should be at the
  2076. end of the second format. The custom formats are also honored by export
  2077. commands, if custom time display is turned on at the time of export."
  2078. :group 'org-time
  2079. :type 'sexp)
  2080. (defun org-time-stamp-format (&optional long inactive)
  2081. "Get the right format for a time string."
  2082. (let ((f (if long (cdr org-time-stamp-formats)
  2083. (car org-time-stamp-formats))))
  2084. (if inactive
  2085. (concat "[" (substring f 1 -1) "]")
  2086. f)))
  2087. (defcustom org-deadline-warning-days 14
  2088. "Number of days before expiration during which a deadline becomes active.
  2089. This variable governs the display in sparse trees and in the agenda.
  2090. When 0 or negative, it means use this number (the absolute value of it)
  2091. even if a deadline has a different individual lead time specified.
  2092. Custom commands can set this variable in the options section."
  2093. :group 'org-time
  2094. :group 'org-agenda-daily/weekly
  2095. :type 'integer)
  2096. (defcustom org-scheduled-delay-days 0
  2097. "Number of days before a scheduled item becomes active.
  2098. This variable governs the display in sparse trees and in the agenda.
  2099. The default value (i.e. 0) means: don't delay scheduled item.
  2100. When negative, it means use this number (the absolute value of it)
  2101. even if a scheduled item has a different individual delay time
  2102. specified.
  2103. Custom commands can set this variable in the options section."
  2104. :group 'org-time
  2105. :group 'org-agenda-daily/weekly
  2106. :version "24.4"
  2107. :package-version '(Org . "8.0")
  2108. :type 'integer)
  2109. (defcustom org-read-date-prefer-future t
  2110. "Non-nil means assume future for incomplete date input from user.
  2111. This affects the following situations:
  2112. 1. The user gives a month but not a year.
  2113. For example, if it is April and you enter \"feb 2\", this will be read
  2114. as Feb 2, *next* year. \"May 5\", however, will be this year.
  2115. 2. The user gives a day, but no month.
  2116. For example, if today is the 15th, and you enter \"3\", Org will read
  2117. this as the third of *next* month. However, if you enter \"17\",
  2118. it will be considered as *this* month.
  2119. If you set this variable to the symbol `time', then also the following
  2120. will work:
  2121. 3. If the user gives a time.
  2122. If the time is before now, it will be interpreted as tomorrow.
  2123. Currently none of this works for ISO week specifications.
  2124. When this option is nil, the current day, month and year will always be
  2125. used as defaults.
  2126. See also `org-agenda-jump-prefer-future'."
  2127. :group 'org-time
  2128. :type '(choice
  2129. (const :tag "Never" nil)
  2130. (const :tag "Check month and day" t)
  2131. (const :tag "Check month, day, and time" time)))
  2132. (defcustom org-agenda-jump-prefer-future 'org-read-date-prefer-future
  2133. "Should the agenda jump command prefer the future for incomplete dates?
  2134. The default is to do the same as configured in `org-read-date-prefer-future'.
  2135. But you can also set a deviating value here.
  2136. This may t or nil, or the symbol `org-read-date-prefer-future'."
  2137. :group 'org-agenda
  2138. :group 'org-time
  2139. :version "24.1"
  2140. :type '(choice
  2141. (const :tag "Use org-read-date-prefer-future"
  2142. org-read-date-prefer-future)
  2143. (const :tag "Never" nil)
  2144. (const :tag "Always" t)))
  2145. (defcustom org-read-date-force-compatible-dates t
  2146. "Should date/time prompt force dates that are guaranteed to work in Emacs?
  2147. Depending on the system Emacs is running on, certain dates cannot
  2148. be represented with the type used internally to represent time.
  2149. Dates between 1970-1-1 and 2038-1-1 can always be represented
  2150. correctly. Some systems allow for earlier dates, some for later,
  2151. some for both. One way to find out is to insert any date into an
  2152. Org buffer, putting the cursor on the year and hitting S-up and
  2153. S-down to test the range.
  2154. When this variable is set to t, the date/time prompt will not let
  2155. you specify dates outside the 1970-2037 range, so it is certain that
  2156. these dates will work in whatever version of Emacs you are
  2157. running, and also that you can move a file from one Emacs implementation
  2158. to another. Whenever Org is forcing the year for you, it will display
  2159. a message and beep.
  2160. When this variable is nil, Org will check if the date is
  2161. representable in the specific Emacs implementation you are using.
  2162. If not, it will force a year, usually the current year, and beep
  2163. to remind you. Currently this setting is not recommended because
  2164. the likelihood that you will open your Org files in an Emacs that
  2165. has limited date range is not negligible.
  2166. A workaround for this problem is to use diary sexp dates for time
  2167. stamps outside of this range."
  2168. :group 'org-time
  2169. :version "24.1"
  2170. :type 'boolean)
  2171. (defcustom org-read-date-display-live t
  2172. "Non-nil means display current interpretation of date prompt live.
  2173. This display will be in an overlay, in the minibuffer. Note that
  2174. live display is only active when `org-read-date-popup-calendar'
  2175. is non-nil."
  2176. :group 'org-time
  2177. :type 'boolean)
  2178. (defvaralias 'org-popup-calendar-for-date-prompt
  2179. 'org-read-date-popup-calendar)
  2180. (defcustom org-read-date-popup-calendar t
  2181. "Non-nil means pop up a calendar when prompting for a date.
  2182. In the calendar, the date can be selected with mouse-1. However, the
  2183. minibuffer will also be active, and you can simply enter the date as well.
  2184. When nil, only the minibuffer will be available."
  2185. :group 'org-time
  2186. :type 'boolean)
  2187. (defcustom org-extend-today-until 0
  2188. "The hour when your day really ends. Must be an integer.
  2189. This has influence for the following applications:
  2190. - When switching the agenda to \"today\". If it is still earlier than
  2191. the time given here, the day recognized as TODAY is actually yesterday.
  2192. - When a date is read from the user and it is still before the time given
  2193. here, the current date and time will be assumed to be yesterday, 23:59.
  2194. Also, timestamps inserted in capture templates follow this rule.
  2195. IMPORTANT: This is a feature whose implementation is and likely will
  2196. remain incomplete. Really, it is only here because past midnight seems to
  2197. be the favorite working time of John Wiegley :-)"
  2198. :group 'org-time
  2199. :type 'integer)
  2200. (defcustom org-use-effective-time nil
  2201. "If non-nil, consider `org-extend-today-until' when creating timestamps.
  2202. For example, if `org-extend-today-until' is 8, and it's 4am, then the
  2203. \"effective time\" of any timestamps between midnight and 8am will be
  2204. 23:59 of the previous day."
  2205. :group 'org-time
  2206. :version "24.1"
  2207. :type 'boolean)
  2208. (defcustom org-use-last-clock-out-time-as-effective-time nil
  2209. "When non-nil, use the last clock out time for `org-todo'.
  2210. Note that this option has precedence over the combined use of
  2211. `org-use-effective-time' and `org-extend-today-until'."
  2212. :group 'org-time
  2213. :version "24.4"
  2214. :package-version '(Org . "8.0")
  2215. :type 'boolean)
  2216. (defcustom org-edit-timestamp-down-means-later nil
  2217. "Non-nil means S-down will increase the time in a time stamp.
  2218. When nil, S-up will increase."
  2219. :group 'org-time
  2220. :type 'boolean)
  2221. (defcustom org-calendar-follow-timestamp-change t
  2222. "Non-nil means make the calendar window follow timestamp changes.
  2223. When a timestamp is modified and the calendar window is visible, it will be
  2224. moved to the new date."
  2225. :group 'org-time
  2226. :type 'boolean)
  2227. (defgroup org-tags nil
  2228. "Options concerning tags in Org mode."
  2229. :tag "Org Tags"
  2230. :group 'org)
  2231. (defcustom org-tag-alist nil
  2232. "Default tags available in Org files.
  2233. The value of this variable is an alist. Associations either:
  2234. (TAG)
  2235. (TAG . SELECT)
  2236. (SPECIAL)
  2237. where TAG is a tag as a string, SELECT is character, used to
  2238. select that tag through the fast tag selection interface, and
  2239. SPECIAL is one of the following keywords: `:startgroup',
  2240. `:startgrouptag', `:grouptags', `:endgroup', `:endgrouptag' or
  2241. `:newline'. These keywords are used to define a hierarchy of
  2242. tags. See manual for details.
  2243. When this variable is nil, Org mode bases tag input on what is
  2244. already in the buffer. The value can be overridden locally by
  2245. using a TAGS keyword, e.g.,
  2246. #+TAGS: tag1 tag2
  2247. See also `org-tag-persistent-alist' to sidestep this behavior."
  2248. :group 'org-tags
  2249. :type '(repeat
  2250. (choice
  2251. (cons :tag "Tag with key"
  2252. (string :tag "Tag name")
  2253. (character :tag "Access char"))
  2254. (list :tag "Tag" (string :tag "Tag name"))
  2255. (const :tag "Start radio group" (:startgroup))
  2256. (const :tag "Start tag group, non distinct" (:startgrouptag))
  2257. (const :tag "Group tags delimiter" (:grouptags))
  2258. (const :tag "End radio group" (:endgroup))
  2259. (const :tag "End tag group, non distinct" (:endgrouptag))
  2260. (const :tag "New line" (:newline)))))
  2261. (defcustom org-tag-persistent-alist nil
  2262. "Tags always available in Org files.
  2263. The value of this variable is an alist. Associations either:
  2264. (TAG)
  2265. (TAG . SELECT)
  2266. (SPECIAL)
  2267. where TAG is a tag as a string, SELECT is a character, used to
  2268. select that tag through the fast tag selection interface, and
  2269. SPECIAL is one of the following keywords: `:startgroup',
  2270. `:startgrouptag', `:grouptags', `:endgroup', `:endgrouptag' or
  2271. `:newline'. These keywords are used to define a hierarchy of
  2272. tags. See manual for details.
  2273. Unlike to `org-tag-alist', tags defined in this variable do not
  2274. depend on a local TAGS keyword. Instead, to disable these tags
  2275. on a per-file basis, insert anywhere in the file:
  2276. #+STARTUP: noptag"
  2277. :group 'org-tags
  2278. :type '(repeat
  2279. (choice
  2280. (cons :tag "Tag with key"
  2281. (string :tag "Tag name")
  2282. (character :tag "Access char"))
  2283. (list :tag "Tag" (string :tag "Tag name"))
  2284. (const :tag "Start radio group" (:startgroup))
  2285. (const :tag "Start tag group, non distinct" (:startgrouptag))
  2286. (const :tag "Group tags delimiter" (:grouptags))
  2287. (const :tag "End radio group" (:endgroup))
  2288. (const :tag "End tag group, non distinct" (:endgrouptag))
  2289. (const :tag "New line" (:newline)))))
  2290. (defcustom org-complete-tags-always-offer-all-agenda-tags nil
  2291. "If non-nil, always offer completion for all tags of all agenda files.
  2292. Setting this variable locally allows for dynamic generation of tag
  2293. completions in capture buffers.
  2294. (add-hook \\='org-capture-mode-hook
  2295. (lambda ()
  2296. (setq-local org-complete-tags-always-offer-all-agenda-tags t)))"
  2297. :group 'org-tags
  2298. :version "24.1"
  2299. :type 'boolean)
  2300. (defvar org-file-tags nil
  2301. "List of tags that can be inherited by all entries in the file.
  2302. The tags will be inherited if the variable `org-use-tag-inheritance'
  2303. says they should be.
  2304. This variable is populated from #+FILETAGS lines.")
  2305. (defcustom org-use-fast-tag-selection 'auto
  2306. "Non-nil means use fast tag selection scheme.
  2307. This is a special interface to select and deselect tags with single keys.
  2308. When nil, fast selection is never used.
  2309. When the symbol `auto', fast selection is used if and only if selection
  2310. characters for tags have been configured, either through the variable
  2311. `org-tag-alist' or through a #+TAGS line in the buffer.
  2312. When t, fast selection is always used and selection keys are assigned
  2313. automatically if necessary."
  2314. :group 'org-tags
  2315. :type '(choice
  2316. (const :tag "Always" t)
  2317. (const :tag "Never" nil)
  2318. (const :tag "When selection characters are configured" auto)))
  2319. (defcustom org-fast-tag-selection-single-key nil
  2320. "Non-nil means fast tag selection exits after first change.
  2321. When nil, you have to press RET to exit it.
  2322. During fast tag selection, you can toggle this flag with `C-c'.
  2323. This variable can also have the value `expert'. In this case, the window
  2324. displaying the tags menu is not even shown, until you press `C-c' again."
  2325. :group 'org-tags
  2326. :type '(choice
  2327. (const :tag "No" nil)
  2328. (const :tag "Yes" t)
  2329. (const :tag "Expert" expert)))
  2330. (defvar org-fast-tag-selection-include-todo nil
  2331. "Non-nil means fast tags selection interface will also offer TODO states.
  2332. This is an undocumented feature, you should not rely on it.")
  2333. (defcustom org-tags-column -77
  2334. "The column to which tags should be indented in a headline.
  2335. If this number is positive, it specifies the column. If it is negative,
  2336. it means that the tags should be flushright to that column. For example,
  2337. -80 works well for a normal 80 character screen.
  2338. When 0, place tags directly after headline text, with only one space in
  2339. between."
  2340. :group 'org-tags
  2341. :type 'integer)
  2342. (defcustom org-auto-align-tags t
  2343. "Non-nil keeps tags aligned when modifying headlines.
  2344. Some operations (i.e. demoting) change the length of a headline and
  2345. therefore shift the tags around. With this option turned on, after
  2346. each such operation the tags are again aligned to `org-tags-column'."
  2347. :group 'org-tags
  2348. :type 'boolean)
  2349. (defcustom org-use-tag-inheritance t
  2350. "Non-nil means tags in levels apply also for sublevels.
  2351. When nil, only the tags directly given in a specific line apply there.
  2352. This may also be a list of tags that should be inherited, or a regexp that
  2353. matches tags that should be inherited. Additional control is possible
  2354. with the variable `org-tags-exclude-from-inheritance' which gives an
  2355. explicit list of tags to be excluded from inheritance, even if the value of
  2356. `org-use-tag-inheritance' would select it for inheritance.
  2357. If this option is t, a match early-on in a tree can lead to a large
  2358. number of matches in the subtree when constructing the agenda or creating
  2359. a sparse tree. If you only want to see the first match in a tree during
  2360. a search, check out the variable `org-tags-match-list-sublevels'."
  2361. :group 'org-tags
  2362. :type '(choice
  2363. (const :tag "Not" nil)
  2364. (const :tag "Always" t)
  2365. (repeat :tag "Specific tags" (string :tag "Tag"))
  2366. (regexp :tag "Tags matched by regexp")))
  2367. (defcustom org-tags-exclude-from-inheritance nil
  2368. "List of tags that should never be inherited.
  2369. This is a way to exclude a few tags from inheritance. For way to do
  2370. the opposite, to actively allow inheritance for selected tags,
  2371. see the variable `org-use-tag-inheritance'."
  2372. :group 'org-tags
  2373. :type '(repeat (string :tag "Tag")))
  2374. (defun org-tag-inherit-p (tag)
  2375. "Check if TAG is one that should be inherited."
  2376. (cond
  2377. ((member tag org-tags-exclude-from-inheritance) nil)
  2378. ((eq org-use-tag-inheritance t) t)
  2379. ((not org-use-tag-inheritance) nil)
  2380. ((stringp org-use-tag-inheritance)
  2381. (string-match org-use-tag-inheritance tag))
  2382. ((listp org-use-tag-inheritance)
  2383. (member tag org-use-tag-inheritance))
  2384. (t (error "Invalid setting of `org-use-tag-inheritance'"))))
  2385. (defcustom org-tags-match-list-sublevels t
  2386. "Non-nil means list also sublevels of headlines matching a search.
  2387. This variable applies to tags/property searches, and also to stuck
  2388. projects because this search is based on a tags match as well.
  2389. When set to the symbol `indented', sublevels are indented with
  2390. leading dots.
  2391. Because of tag inheritance (see variable `org-use-tag-inheritance'),
  2392. the sublevels of a headline matching a tag search often also match
  2393. the same search. Listing all of them can create very long lists.
  2394. Setting this variable to nil causes subtrees of a match to be skipped.
  2395. This variable is semi-obsolete and probably should always be true. It
  2396. is better to limit inheritance to certain tags using the variables
  2397. `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
  2398. :group 'org-tags
  2399. :type '(choice
  2400. (const :tag "No, don't list them" nil)
  2401. (const :tag "Yes, do list them" t)
  2402. (const :tag "List them, indented with leading dots" indented)))
  2403. (defcustom org-tags-sort-function nil
  2404. "When set, tags are sorted using this function as a comparator."
  2405. :group 'org-tags
  2406. :type '(choice
  2407. (const :tag "No sorting" nil)
  2408. (const :tag "Alphabetical" string-collate-lessp)
  2409. (const :tag "Reverse alphabetical" org-string-collate-greaterp)
  2410. (function :tag "Custom function" nil)))
  2411. (defvar org-tags-history nil
  2412. "History of minibuffer reads for tags.")
  2413. (defvar org-last-tags-completion-table nil
  2414. "The last used completion table for tags.")
  2415. (defvar org-after-tags-change-hook nil
  2416. "Hook that is run after the tags in a line have changed.")
  2417. (defgroup org-properties nil
  2418. "Options concerning properties in Org mode."
  2419. :tag "Org Properties"
  2420. :group 'org)
  2421. (defcustom org-property-format "%-10s %s"
  2422. "How property key/value pairs should be formatted by `indent-line'.
  2423. When `indent-line' hits a property definition, it will format the line
  2424. according to this format, mainly to make sure that the values are
  2425. lined-up with respect to each other."
  2426. :group 'org-properties
  2427. :type 'string)
  2428. (defcustom org-properties-postprocess-alist nil
  2429. "Alist of properties and functions to adjust inserted values.
  2430. Elements of this alist must be of the form
  2431. ([string] [function])
  2432. where [string] must be a property name and [function] must be a
  2433. lambda expression: this lambda expression must take one argument,
  2434. the value to adjust, and return the new value as a string.
  2435. For example, this element will allow the property \"Remaining\"
  2436. to be updated wrt the relation between the \"Effort\" property
  2437. and the clock summary:
  2438. ((\"Remaining\" (lambda(value)
  2439. (let ((clocksum (org-clock-sum-current-item))
  2440. (effort (org-duration-to-minutes
  2441. (org-entry-get (point) \"Effort\"))))
  2442. (org-minutes-to-clocksum-string (- effort clocksum))))))"
  2443. :group 'org-properties
  2444. :version "24.1"
  2445. :type '(alist :key-type (string :tag "Property")
  2446. :value-type (function :tag "Function")))
  2447. (defcustom org-use-property-inheritance nil
  2448. "Non-nil means properties apply also for sublevels.
  2449. This setting is chiefly used during property searches. Turning it on can
  2450. cause significant overhead when doing a search, which is why it is not
  2451. on by default.
  2452. When nil, only the properties directly given in the current entry count.
  2453. When t, every property is inherited. The value may also be a list of
  2454. properties that should have inheritance, or a regular expression matching
  2455. properties that should be inherited.
  2456. However, note that some special properties use inheritance under special
  2457. circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
  2458. and the properties ending in \"_ALL\" when they are used as descriptor
  2459. for valid values of a property.
  2460. Note for programmers:
  2461. When querying an entry with `org-entry-get', you can control if inheritance
  2462. should be used. By default, `org-entry-get' looks only at the local
  2463. properties. You can request inheritance by setting the inherit argument
  2464. to t (to force inheritance) or to `selective' (to respect the setting
  2465. in this variable)."
  2466. :group 'org-properties
  2467. :type '(choice
  2468. (const :tag "Not" nil)
  2469. (const :tag "Always" t)
  2470. (repeat :tag "Specific properties" (string :tag "Property"))
  2471. (regexp :tag "Properties matched by regexp")))
  2472. (defun org-property-inherit-p (property)
  2473. "Return a non-nil value if PROPERTY should be inherited."
  2474. (cond
  2475. ((eq org-use-property-inheritance t) t)
  2476. ((not org-use-property-inheritance) nil)
  2477. ((stringp org-use-property-inheritance)
  2478. (string-match org-use-property-inheritance property))
  2479. ((listp org-use-property-inheritance)
  2480. (member-ignore-case property org-use-property-inheritance))
  2481. (t (error "Invalid setting of `org-use-property-inheritance'"))))
  2482. (defcustom org-property-separators nil
  2483. "An alist to control how properties are combined.
  2484. The car of each item should be either a list of property names or
  2485. a regular expression, while the cdr should be the separator to
  2486. use when combining that property.
  2487. If an alist item cannot be found that matches a given property, a
  2488. single space will be used as the separator."
  2489. :group 'org-properties
  2490. :type '(alist :key-type (choice (repeat :tag "Properties" string)
  2491. (string :tag "Regular Expression"))
  2492. :value-type (restricted-sexp :tag "Separator"
  2493. :match-alternatives (stringp)
  2494. :value " ")))
  2495. (defun org--property-get-separator (property)
  2496. "Get the separator to use for combining PROPERTY."
  2497. (or
  2498. (catch 'separator
  2499. (dolist (spec org-property-separators)
  2500. (if (listp (car spec))
  2501. (if (member property (car spec))
  2502. (throw 'separator (cdr spec)))
  2503. (if (string-match-p (car spec) property)
  2504. (throw 'separator (cdr spec))))))
  2505. " "))
  2506. (defcustom org-columns-default-format "%25ITEM %TODO %3PRIORITY %TAGS"
  2507. "The default column format, if no other format has been defined.
  2508. This variable can be set on the per-file basis by inserting a line
  2509. #+COLUMNS: %25ITEM ....."
  2510. :group 'org-properties
  2511. :type 'string)
  2512. (defcustom org-columns-default-format-for-agenda nil
  2513. "The default column format in an agenda buffer.
  2514. This will be used for column view in the agenda unless a format has
  2515. been set by adding `org-overriding-columns-format' to the local
  2516. settings list of a custom agenda view. When nil, the columns format
  2517. for the first item in the agenda list will be used, or as a fall-back,
  2518. `org-columns-default-format'."
  2519. :group 'org-properties
  2520. :type '(choice
  2521. (const :tag "No default" nil)
  2522. (string :tag "Format string")))
  2523. (defcustom org-columns-ellipses ".."
  2524. "The ellipses to be used when a field in column view is truncated.
  2525. When this is the empty string, as many characters as possible are shown,
  2526. but then there will be no visual indication that the field has been truncated.
  2527. When this is a string of length N, the last N characters of a truncated
  2528. field are replaced by this string. If the column is narrower than the
  2529. ellipses string, only part of the ellipses string will be shown."
  2530. :group 'org-properties
  2531. :type 'string)
  2532. (defconst org-global-properties-fixed
  2533. '(("VISIBILITY_ALL" . "folded children content all")
  2534. ("CLOCK_MODELINE_TOTAL_ALL" . "current today repeat all auto"))
  2535. "List of property/value pairs that can be inherited by any entry.
  2536. These are fixed values, for the preset properties. The user variable
  2537. that can be used to add to this list is `org-global-properties'.
  2538. The entries in this list are cons cells where the car is a property
  2539. name and cdr is a string with the value. If the value represents
  2540. multiple items like an \"_ALL\" property, separate the items by
  2541. spaces.")
  2542. (defcustom org-global-properties nil
  2543. "List of property/value pairs that can be inherited by any entry.
  2544. This list will be combined with the constant `org-global-properties-fixed'.
  2545. The entries in this list are cons cells where the car is a property
  2546. name and cdr is a string with the value.
  2547. Buffer local properties are added either by a document property drawer
  2548. :PROPERTIES:
  2549. :NAME: VALUE
  2550. :END:
  2551. or by adding lines like
  2552. #+PROPERTY: NAME VALUE"
  2553. :group 'org-properties
  2554. :type '(repeat
  2555. (cons (string :tag "Property")
  2556. (string :tag "Value"))))
  2557. (defvar-local org-keyword-properties nil
  2558. "List of property/value pairs inherited by any entry.
  2559. Valid for the current buffer. This variable is populated from
  2560. PROPERTY keywords.
  2561. Note that properties are defined also in property drawers.
  2562. Properties defined there take precedence over properties defined
  2563. as keywords.")
  2564. (defgroup org-agenda nil
  2565. "Options concerning agenda views in Org mode."
  2566. :tag "Org Agenda"
  2567. :group 'org)
  2568. (defvar-local org-category nil
  2569. "Variable used by Org files to set a category for agenda display.
  2570. There are multiple ways to set the category. One way is to set
  2571. it in the document property drawer. For example:
  2572. :PROPERTIES:
  2573. :CATEGORY: ELisp
  2574. :END:
  2575. Other ways to define it is as an Emacs file variable, for example
  2576. # -*- mode: org; org-category: \"ELisp\"
  2577. or for the file to contain a special line:
  2578. #+CATEGORY: ELisp
  2579. If the file does not specify a category, then file's base name
  2580. is used instead.")
  2581. (put 'org-category 'safe-local-variable (lambda (x) (or (symbolp x) (stringp x))))
  2582. (defcustom org-agenda-files nil
  2583. "The files to be used for agenda display.
  2584. If an entry is a directory, all files in that directory that are matched
  2585. by `org-agenda-file-regexp' will be part of the file list.
  2586. If the value of the variable is not a list but a single file name, then
  2587. the list of agenda files is actually stored and maintained in that file,
  2588. one agenda file per line. In this file paths can be given relative to
  2589. `org-directory'. Tilde expansion and environment variable substitution
  2590. are also made.
  2591. Entries may be added to this list with `\\[org-agenda-file-to-front]'
  2592. and removed with `\\[org-remove-file]'."
  2593. :group 'org-agenda
  2594. :type '(choice
  2595. (repeat :tag "List of files and directories" file)
  2596. (file :tag "Store list in a file\n" :value "~/.agenda_files")))
  2597. (defcustom org-agenda-file-regexp "\\`[^.].*\\.org\\'"
  2598. "Regular expression to match files for `org-agenda-files'.
  2599. If any element in the list in that variable contains a directory instead
  2600. of a normal file, all files in that directory that are matched by this
  2601. regular expression will be included."
  2602. :group 'org-agenda
  2603. :type 'regexp)
  2604. (defvaralias 'org-agenda-multi-occur-extra-files
  2605. 'org-agenda-text-search-extra-files)
  2606. (defcustom org-agenda-text-search-extra-files nil
  2607. "List of extra files to be searched by text search commands.
  2608. These files will be searched in addition to the agenda files by the
  2609. commands `org-search-view' (`\\[org-agenda] s') \
  2610. and `org-occur-in-agenda-files'.
  2611. Note that these files will only be searched for text search commands,
  2612. not for the other agenda views like todo lists, tag searches or the weekly
  2613. agenda. This variable is intended to list notes and possibly archive files
  2614. that should also be searched by these two commands.
  2615. In fact, if the first element in the list is the symbol `agenda-archives',
  2616. then all archive files of all agenda files will be added to the search
  2617. scope."
  2618. :group 'org-agenda
  2619. :type '(set :greedy t
  2620. (const :tag "Agenda Archives" agenda-archives)
  2621. (repeat :inline t (file))))
  2622. (defcustom org-agenda-skip-unavailable-files nil
  2623. "Non-nil means to just skip non-reachable files in `org-agenda-files'.
  2624. A nil value means to remove them, after a query, from the list."
  2625. :group 'org-agenda
  2626. :type 'boolean)
  2627. (defgroup org-latex nil
  2628. "Options for embedding LaTeX code into Org mode."
  2629. :tag "Org LaTeX"
  2630. :group 'org)
  2631. (defcustom org-format-latex-options
  2632. '(:foreground default :background default :scale 1.0
  2633. :html-foreground "Black" :html-background "Transparent"
  2634. :html-scale 1.0 :matchers ("begin" "$1" "$" "$$" "\\(" "\\["))
  2635. "Options for creating images from LaTeX fragments.
  2636. This is a property list with the following properties:
  2637. :foreground the foreground color for images embedded in Emacs, e.g. \"Black\".
  2638. `default' means use the foreground of the default face.
  2639. `auto' means use the foreground from the text face.
  2640. :background the background color, or \"Transparent\".
  2641. `default' means use the background of the default face.
  2642. `auto' means use the background from the text face.
  2643. :scale a scaling factor for the size of the images, to get more pixels
  2644. :html-foreground, :html-background, :html-scale
  2645. the same numbers for HTML export.
  2646. :matchers a list indicating which matchers should be used to
  2647. find LaTeX fragments. Valid members of this list are:
  2648. \"begin\" find environments
  2649. \"$1\" find single characters surrounded by $.$
  2650. \"$\" find math expressions surrounded by $...$
  2651. \"$$\" find math expressions surrounded by $$....$$
  2652. \"\\(\" find math expressions surrounded by \\(...\\)
  2653. \"\\=\\[\" find math expressions surrounded by \\=\\[...\\]"
  2654. :group 'org-latex
  2655. :type 'plist)
  2656. (defcustom org-format-latex-signal-error t
  2657. "Non-nil means signal an error when image creation of LaTeX snippets fails.
  2658. When nil, just push out a message."
  2659. :group 'org-latex
  2660. :version "24.1"
  2661. :type 'boolean)
  2662. (defcustom org-latex-to-mathml-jar-file nil
  2663. "Value of\"%j\" in `org-latex-to-mathml-convert-command'.
  2664. Use this to specify additional executable file say a jar file.
  2665. When using MathToWeb as the converter, specify the full-path to
  2666. your mathtoweb.jar file."
  2667. :group 'org-latex
  2668. :version "24.1"
  2669. :type '(choice
  2670. (const :tag "None" nil)
  2671. (file :tag "JAR file" :must-match t)))
  2672. (defcustom org-latex-to-mathml-convert-command nil
  2673. "Command to convert LaTeX fragments to MathML.
  2674. Replace format-specifiers in the command as noted below and use
  2675. `shell-command' to convert LaTeX to MathML.
  2676. %j: Executable file in fully expanded form as specified by
  2677. `org-latex-to-mathml-jar-file'.
  2678. %I: Input LaTeX file in fully expanded form.
  2679. %i: The latex fragment to be converted.
  2680. %o: Output MathML file.
  2681. This command is used by `org-create-math-formula'.
  2682. When using MathToWeb as the converter, set this option to
  2683. \"java -jar %j -unicode -force -df %o %I\".
  2684. When using LaTeXML set this option to
  2685. \"latexmlmath \"%i\" --presentationmathml=%o\"."
  2686. :group 'org-latex
  2687. :version "24.1"
  2688. :type '(choice
  2689. (const :tag "None" nil)
  2690. (string :tag "\nShell command")))
  2691. (defcustom org-latex-to-html-convert-command nil
  2692. "Command to convert LaTeX fragments to HTML.
  2693. This command is very open-ended: the output of the command will
  2694. directly replace the LaTeX fragment in the resulting HTML.
  2695. Replace format-specifiers in the command as noted below and use
  2696. `shell-command' to convert LaTeX to HTML.
  2697. %i: The LaTeX fragment to be converted.
  2698. For example, this could be used with LaTeXML as
  2699. \"latexmlc \\='literal:%i\\=' --profile=math --preload=siunitx.sty 2>/dev/null\"."
  2700. :group 'org-latex
  2701. :package-version '(Org . "9.4")
  2702. :type '(choice
  2703. (const :tag "None" nil)
  2704. (string :tag "Shell command")))
  2705. (defcustom org-preview-latex-default-process 'dvipng
  2706. "The default process to convert LaTeX fragments to image files.
  2707. All available processes and theirs documents can be found in
  2708. `org-preview-latex-process-alist', which see."
  2709. :group 'org-latex
  2710. :version "26.1"
  2711. :package-version '(Org . "9.0")
  2712. :type 'symbol)
  2713. (defcustom org-preview-latex-process-alist
  2714. '((dvipng
  2715. :programs ("latex" "dvipng")
  2716. :description "dvi > png"
  2717. :message "you need to install the programs: latex and dvipng."
  2718. :image-input-type "dvi"
  2719. :image-output-type "png"
  2720. :image-size-adjust (1.0 . 1.0)
  2721. :latex-compiler ("latex -interaction nonstopmode -output-directory %o %f")
  2722. :image-converter ("dvipng -D %D -T tight -o %O %f")
  2723. :transparent-image-converter
  2724. ("dvipng -D %D -T tight -bg Transparent -o %O %f"))
  2725. (dvisvgm
  2726. :programs ("latex" "dvisvgm")
  2727. :description "dvi > svg"
  2728. :message "you need to install the programs: latex and dvisvgm."
  2729. :image-input-type "dvi"
  2730. :image-output-type "svg"
  2731. :image-size-adjust (1.7 . 1.5)
  2732. :latex-compiler ("latex -interaction nonstopmode -output-directory %o %f")
  2733. :image-converter ("dvisvgm %f -n -b min -c %S -o %O"))
  2734. (imagemagick
  2735. :programs ("latex" "convert")
  2736. :description "pdf > png"
  2737. :message "you need to install the programs: latex and imagemagick."
  2738. :image-input-type "pdf"
  2739. :image-output-type "png"
  2740. :image-size-adjust (1.0 . 1.0)
  2741. :latex-compiler ("pdflatex -interaction nonstopmode -output-directory %o %f")
  2742. :image-converter
  2743. ("convert -density %D -trim -antialias %f -quality 100 %O")))
  2744. "Definitions of external processes for LaTeX previewing.
  2745. Org mode can use some external commands to generate TeX snippet's images for
  2746. previewing or inserting into HTML files, e.g., \"dvipng\". This variable tells
  2747. `org-create-formula-image' how to call them.
  2748. The value is an alist with the pattern (NAME . PROPERTIES). NAME is a symbol.
  2749. PROPERTIES accepts the following attributes:
  2750. :programs list of strings, required programs.
  2751. :description string, describe the process.
  2752. :message string, message it when required programs cannot be found.
  2753. :image-input-type string, input file type of image converter (e.g., \"dvi\").
  2754. :image-output-type string, output file type of image converter (e.g., \"png\").
  2755. :image-size-adjust cons of numbers, the car element is used to adjust LaTeX
  2756. image size showed in buffer and the cdr element is for
  2757. HTML file. This option is only useful for process
  2758. developers, users should use variable
  2759. `org-format-latex-options' instead.
  2760. :post-clean list of strings, files matched are to be cleaned up once
  2761. the image is generated. When nil, the files with \".dvi\",
  2762. \".xdv\", \".pdf\", \".tex\", \".aux\", \".log\", \".svg\",
  2763. \".png\", \".jpg\", \".jpeg\" or \".out\" extension will
  2764. be cleaned up.
  2765. :latex-header list of strings, the LaTeX header of the snippet file.
  2766. When nil, the fallback value is used instead, which is
  2767. controlled by `org-format-latex-header',
  2768. `org-latex-default-packages-alist' and
  2769. `org-latex-packages-alist', which see.
  2770. :latex-compiler list of LaTeX commands, as strings. Each of them is given
  2771. to the shell. Place-holders \"%t\", \"%b\" and \"%o\" are
  2772. replaced with values defined below.
  2773. :image-converter list of image converter commands strings. Each of them is
  2774. given to the shell and supports any of the following
  2775. place-holders defined below.
  2776. If set, :transparent-image-converter is used instead of :image-converter to
  2777. convert an image when the background color is nil or \"Transparent\".
  2778. Place-holders used by `:image-converter' and `:latex-compiler':
  2779. %f input file name
  2780. %b base name of input file
  2781. %o base directory of input file
  2782. %O absolute output file name
  2783. Place-holders only used by `:image-converter':
  2784. %D dpi, which is used to adjust image size by some processing commands.
  2785. %S the image size scale ratio, which is used to adjust image size by some
  2786. processing commands."
  2787. :group 'org-latex
  2788. :version "26.1"
  2789. :package-version '(Org . "9.0")
  2790. :type '(alist :tag "LaTeX to image backends"
  2791. :value-type (plist)))
  2792. (defcustom org-preview-latex-image-directory "ltximg/"
  2793. "Path to store latex preview images.
  2794. A relative path here creates many directories relative to the
  2795. processed Org files paths. An absolute path puts all preview
  2796. images at the same place."
  2797. :group 'org-latex
  2798. :version "26.1"
  2799. :package-version '(Org . "9.0")
  2800. :type 'string)
  2801. (defun org-format-latex-mathml-available-p ()
  2802. "Return t if `org-latex-to-mathml-convert-command' is usable."
  2803. (save-match-data
  2804. (when (and (boundp 'org-latex-to-mathml-convert-command)
  2805. org-latex-to-mathml-convert-command)
  2806. (let ((executable (car (split-string
  2807. org-latex-to-mathml-convert-command))))
  2808. (when (executable-find executable)
  2809. (if (string-match
  2810. "%j" org-latex-to-mathml-convert-command)
  2811. (file-readable-p org-latex-to-mathml-jar-file)
  2812. t))))))
  2813. (defcustom org-format-latex-header "\\documentclass{article}
  2814. \\usepackage[usenames]{color}
  2815. \[DEFAULT-PACKAGES]
  2816. \[PACKAGES]
  2817. \\pagestyle{empty} % do not remove
  2818. % The settings below are copied from fullpage.sty
  2819. \\setlength{\\textwidth}{\\paperwidth}
  2820. \\addtolength{\\textwidth}{-3cm}
  2821. \\setlength{\\oddsidemargin}{1.5cm}
  2822. \\addtolength{\\oddsidemargin}{-2.54cm}
  2823. \\setlength{\\evensidemargin}{\\oddsidemargin}
  2824. \\setlength{\\textheight}{\\paperheight}
  2825. \\addtolength{\\textheight}{-\\headheight}
  2826. \\addtolength{\\textheight}{-\\headsep}
  2827. \\addtolength{\\textheight}{-\\footskip}
  2828. \\addtolength{\\textheight}{-3cm}
  2829. \\setlength{\\topmargin}{1.5cm}
  2830. \\addtolength{\\topmargin}{-2.54cm}"
  2831. "The document header used for processing LaTeX fragments.
  2832. It is imperative that this header make sure that no page number
  2833. appears on the page. The package defined in the variables
  2834. `org-latex-default-packages-alist' and `org-latex-packages-alist'
  2835. will either replace the placeholder \"[PACKAGES]\" in this
  2836. header, or they will be appended."
  2837. :group 'org-latex
  2838. :type 'string)
  2839. (defun org-set-packages-alist (var val)
  2840. "Set the packages alist and make sure it has 3 elements per entry."
  2841. (set-default-toplevel-value var (mapcar (lambda (x)
  2842. (if (and (consp x) (= (length x) 2))
  2843. (list (car x) (nth 1 x) t)
  2844. x))
  2845. val)))
  2846. (defun org-get-packages-alist (var)
  2847. "Get the packages alist and make sure it has 3 elements per entry."
  2848. (mapcar (lambda (x)
  2849. (if (and (consp x) (= (length x) 2))
  2850. (list (car x) (nth 1 x) t)
  2851. x))
  2852. (default-value var)))
  2853. (defcustom org-latex-default-packages-alist
  2854. '(("AUTO" "inputenc" t ("pdflatex"))
  2855. ("T1" "fontenc" t ("pdflatex"))
  2856. ("" "graphicx" t)
  2857. ("" "longtable" nil)
  2858. ("" "wrapfig" nil)
  2859. ("" "rotating" nil)
  2860. ("normalem" "ulem" t)
  2861. ("" "amsmath" t)
  2862. ("" "amssymb" t)
  2863. ("" "capt-of" nil)
  2864. ("" "hyperref" nil))
  2865. "Alist of default packages to be inserted in the header.
  2866. Change this only if one of the packages here causes an
  2867. incompatibility with another package you are using.
  2868. The packages in this list are needed by one part or another of
  2869. Org mode to function properly:
  2870. - inputenc, fontenc: for basic font and character selection
  2871. - graphicx: for including images
  2872. - longtable: For multipage tables
  2873. - wrapfig: for figure placement
  2874. - rotating: for sideways figures and tables
  2875. - ulem: for underline and strike-through
  2876. - amsmath: for subscript and superscript and math environments
  2877. - amssymb: for various symbols used for interpreting the entities
  2878. in `org-entities'. You can skip some of this package if you don't
  2879. use any of the symbols.
  2880. - capt-of: for captions outside of floats
  2881. - hyperref: for cross references
  2882. Therefore you should not modify this variable unless you know
  2883. what you are doing. The one reason to change it anyway is that
  2884. you might be loading some other package that conflicts with one
  2885. of the default packages. Each element is either a cell or
  2886. a string.
  2887. A cell is of the format
  2888. (\"options\" \"package\" SNIPPET-FLAG COMPILERS)
  2889. If SNIPPET-FLAG is non-nil, the package also needs to be included
  2890. when compiling LaTeX snippets into images for inclusion into
  2891. non-LaTeX output.
  2892. COMPILERS is a list of compilers that should include the package,
  2893. see `org-latex-compiler'. If the document compiler is not in the
  2894. list, and the list is non-nil, the package will not be inserted
  2895. in the final document.
  2896. A string will be inserted as-is in the header of the document."
  2897. :group 'org-latex
  2898. :group 'org-export-latex
  2899. :set 'org-set-packages-alist
  2900. :get 'org-get-packages-alist
  2901. :version "26.1"
  2902. :package-version '(Org . "8.3")
  2903. :type '(repeat
  2904. (choice
  2905. (list :tag "options/package pair"
  2906. (string :tag "options")
  2907. (string :tag "package")
  2908. (boolean :tag "Snippet")
  2909. (choice
  2910. (const :tag "For all compilers" nil)
  2911. (repeat :tag "Allowed compiler" string)))
  2912. (string :tag "A line of LaTeX"))))
  2913. (defcustom org-latex-packages-alist nil
  2914. "Alist of packages to be inserted in every LaTeX header.
  2915. These will be inserted after `org-latex-default-packages-alist'.
  2916. Each element is either a cell or a string.
  2917. A cell is of the format:
  2918. (\"options\" \"package\" SNIPPET-FLAG COMPILERS)
  2919. SNIPPET-FLAG, when non-nil, indicates that this package is also
  2920. needed when turning LaTeX snippets into images for inclusion into
  2921. non-LaTeX output.
  2922. COMPILERS is a list of compilers that should include the package,
  2923. see `org-latex-compiler'. If the document compiler is not in the
  2924. list, and the list is non-nil, the package will not be inserted
  2925. in the final document.
  2926. A string will be inserted as-is in the header of the document.
  2927. Make sure that you only list packages here which:
  2928. - you want in every file;
  2929. - do not conflict with the setup in `org-format-latex-header';
  2930. - do not conflict with the default packages in
  2931. `org-latex-default-packages-alist'."
  2932. :group 'org-latex
  2933. :group 'org-export-latex
  2934. :set 'org-set-packages-alist
  2935. :get 'org-get-packages-alist
  2936. :type '(repeat
  2937. (choice
  2938. (list :tag "options/package pair"
  2939. (string :tag "options")
  2940. (string :tag "package")
  2941. (boolean :tag "Snippet"))
  2942. (string :tag "A line of LaTeX"))))
  2943. (defgroup org-appearance nil
  2944. "Settings for Org mode appearance."
  2945. :tag "Org Appearance"
  2946. :group 'org)
  2947. (defcustom org-level-color-stars-only nil
  2948. "Non-nil means fontify only the stars in each headline.
  2949. When nil, the entire headline is fontified.
  2950. Changing it requires restart of `font-lock-mode' to become effective
  2951. also in regions already fontified."
  2952. :group 'org-appearance
  2953. :type 'boolean)
  2954. (defcustom org-hide-leading-stars nil
  2955. "Non-nil means hide the first N-1 stars in a headline.
  2956. This works by using the face `org-hide' for these stars. This
  2957. face is white for a light background, and black for a dark
  2958. background. You may have to customize the face `org-hide' to
  2959. make this work.
  2960. Changing it requires restart of `font-lock-mode' to become effective
  2961. also in regions already fontified.
  2962. You may also set this on a per-file basis by adding one of the following
  2963. lines to the buffer:
  2964. #+STARTUP: hidestars
  2965. #+STARTUP: showstars"
  2966. :group 'org-appearance
  2967. :type 'boolean)
  2968. (defcustom org-hidden-keywords nil
  2969. "List of symbols corresponding to keywords to be hidden in the Org buffer.
  2970. For example, a value (title) for this list makes the document's title
  2971. appear in the buffer without the initial \"#+TITLE:\" part."
  2972. :group 'org-appearance
  2973. :package-version '(Org . "9.5")
  2974. :type '(set (const :tag "#+AUTHOR" author)
  2975. (const :tag "#+DATE" date)
  2976. (const :tag "#+EMAIL" email)
  2977. (const :tag "#+SUBTITLE" subtitle)
  2978. (const :tag "#+TITLE" title)))
  2979. (defcustom org-custom-properties nil
  2980. "List of properties (as strings) with a special meaning.
  2981. The default use of these custom properties is to let the user
  2982. hide them with `org-toggle-custom-properties-visibility'."
  2983. :group 'org-properties
  2984. :group 'org-appearance
  2985. :version "24.3"
  2986. :type '(repeat (string :tag "Property Name")))
  2987. (defcustom org-fontify-todo-headline nil
  2988. "Non-nil means change the face of a headline if it is marked as TODO.
  2989. Normally, only the TODO/DONE keyword indicates the state of a headline.
  2990. When this is non-nil, the headline after the keyword is set to the
  2991. `org-headline-todo' as an additional indication."
  2992. :group 'org-appearance
  2993. :package-version '(Org . "9.4")
  2994. :type 'boolean
  2995. :safe #'booleanp)
  2996. (defcustom org-fontify-done-headline t
  2997. "Non-nil means change the face of a headline if it is marked DONE.
  2998. Normally, only the TODO/DONE keyword indicates the state of a headline.
  2999. When this is non-nil, the headline after the keyword is set to the
  3000. `org-headline-done' as an additional indication."
  3001. :group 'org-appearance
  3002. :package-version '(Org . "9.4")
  3003. :type 'boolean)
  3004. (defcustom org-fontify-emphasized-text t
  3005. "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
  3006. Changing this variable requires a restart of Emacs to take effect."
  3007. :group 'org-appearance
  3008. :type 'boolean)
  3009. (defcustom org-fontify-whole-heading-line nil
  3010. "Non-nil means fontify the whole line for headings.
  3011. This is useful when setting a background color for the
  3012. org-level-* faces."
  3013. :group 'org-appearance
  3014. :type 'boolean)
  3015. (defcustom org-fontify-whole-block-delimiter-line t
  3016. "Non-nil means fontify the whole line for begin/end lines of blocks.
  3017. This is useful when setting a background color for the
  3018. org-block-begin-line and org-block-end-line faces."
  3019. :group 'org-appearance
  3020. :type 'boolean)
  3021. (defcustom org-highlight-latex-and-related nil
  3022. "Non-nil means highlight LaTeX related syntax in the buffer.
  3023. When non-nil, the value should be a list containing any of the
  3024. following symbols:
  3025. `native' Highlight LaTeX snippets and environments natively.
  3026. `latex' Highlight LaTeX snippets and environments.
  3027. `script' Highlight subscript and superscript.
  3028. `entities' Highlight entities."
  3029. :group 'org-appearance
  3030. :version "24.4"
  3031. :package-version '(Org . "8.0")
  3032. :type '(choice
  3033. (const :tag "No highlighting" nil)
  3034. (set :greedy t :tag "Highlight"
  3035. (const :tag "LaTeX snippets and environments (native)" native)
  3036. (const :tag "LaTeX snippets and environments" latex)
  3037. (const :tag "Subscript and superscript" script)
  3038. (const :tag "Entities" entities))))
  3039. (defcustom org-hide-emphasis-markers nil
  3040. "Non-nil mean font-lock should hide the emphasis marker characters."
  3041. :group 'org-appearance
  3042. :type 'boolean
  3043. :safe #'booleanp)
  3044. (defcustom org-hide-macro-markers nil
  3045. "Non-nil mean font-lock should hide the brackets marking macro calls."
  3046. :group 'org-appearance
  3047. :type 'boolean)
  3048. (defcustom org-pretty-entities nil
  3049. "Non-nil means show entities as UTF8 characters.
  3050. When nil, the \\name form remains in the buffer."
  3051. :group 'org-appearance
  3052. :version "24.1"
  3053. :type 'boolean)
  3054. (defcustom org-pretty-entities-include-sub-superscripts t
  3055. "Non-nil means, pretty entity display includes formatting sub/superscripts."
  3056. :group 'org-appearance
  3057. :version "24.1"
  3058. :type 'boolean)
  3059. (defvar org-emph-re nil
  3060. "Regular expression for matching emphasis.
  3061. After a match, the match groups contain these elements:
  3062. 0 The match of the full regular expression, including the characters
  3063. before and after the proper match
  3064. 1 The character before the proper match, or empty at beginning of line
  3065. 2 The proper match, including the leading and trailing markers
  3066. 3 The leading marker like * or /, indicating the type of highlighting
  3067. 4 The text between the emphasis markers, not including the markers
  3068. 5 The character after the match, empty at the end of a line")
  3069. (defvar org-verbatim-re nil
  3070. "Regular expression for matching verbatim text.")
  3071. (defvar org-emphasis-regexp-components) ; defined just below
  3072. (defvar org-emphasis-alist) ; defined just below
  3073. (defun org-set-emph-re (var val)
  3074. "Set variable and compute the emphasis regular expression."
  3075. (set-default-toplevel-value var val)
  3076. (when (and (boundp 'org-emphasis-alist)
  3077. (boundp 'org-emphasis-regexp-components)
  3078. org-emphasis-alist org-emphasis-regexp-components)
  3079. (pcase-let*
  3080. ((`(,pre ,post ,border ,body ,nl) org-emphasis-regexp-components)
  3081. (body (if (<= nl 0) body
  3082. (format "%s*?\\(?:\n%s*?\\)\\{0,%d\\}" body body nl)))
  3083. (template
  3084. (format (concat "\\([%s]\\|^\\)" ;before markers
  3085. "\\(\\([%%s]\\)\\([^%s]\\|[^%s]%s[^%s]\\)\\3\\)"
  3086. "\\([%s]\\|$\\)") ;after markers
  3087. pre border border body border post)))
  3088. (setq org-emph-re (format template "*/_+"))
  3089. (setq org-verbatim-re (format template "=~")))))
  3090. ;; This used to be a defcustom (Org <8.0) but allowing the users to
  3091. ;; set this option proved cumbersome. See this message/thread:
  3092. ;; https://orgmode.org/list/B72CDC2B-72F6-43A8-AC70-E6E6295766EC@gmail.com
  3093. (defvar org-emphasis-regexp-components
  3094. '("-[:space:]('\"{" "-[:space:].,:!?;'\")}\\[" "[:space:]" "." 1)
  3095. "Components used to build the regular expression for emphasis.
  3096. This is a list with five entries. Terminology: In an emphasis string
  3097. like \" *strong word* \", we call the initial space PREMATCH, the final
  3098. space POSTMATCH, the stars MARKERS, \"s\" and \"d\" are BORDER characters
  3099. and \"trong wor\" is the body. The different components in this variable
  3100. specify what is allowed/forbidden in each part:
  3101. pre Chars allowed as prematch. Beginning of line will be allowed too.
  3102. post Chars allowed as postmatch. End of line will be allowed too.
  3103. border The chars *forbidden* as border characters.
  3104. body-regexp A regexp like \".\" to match a body character. Don't use
  3105. non-shy groups here, and don't allow newline here.
  3106. newline The maximum number of newlines allowed in an emphasis exp.
  3107. You need to reload Org or to restart Emacs after setting this.")
  3108. (defcustom org-emphasis-alist
  3109. '(("*" bold)
  3110. ("/" italic)
  3111. ("_" underline)
  3112. ("=" org-verbatim verbatim)
  3113. ("~" org-code verbatim)
  3114. ("+" (:strike-through t)))
  3115. "Alist of characters and faces to emphasize text.
  3116. Text starting and ending with a special character will be emphasized,
  3117. for example *bold*, _underlined_ and /italic/. This variable sets the
  3118. marker characters and the face to be used by font-lock for highlighting
  3119. in Org buffers.
  3120. You need to reload Org or to restart Emacs after customizing this."
  3121. :group 'org-appearance
  3122. :set 'org-set-emph-re
  3123. :version "24.4"
  3124. :package-version '(Org . "8.0")
  3125. :type '(repeat
  3126. (list
  3127. (string :tag "Marker character")
  3128. (choice
  3129. (face :tag "Font-lock-face")
  3130. (plist :tag "Face property list"))
  3131. (option (const verbatim)))))
  3132. (defvar org-protecting-blocks '("src" "example" "export")
  3133. "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
  3134. This is needed for font-lock setup.")
  3135. ;;; Functions and variables from their packages
  3136. ;; Declared here to avoid compiler warnings
  3137. (defvar mark-active)
  3138. ;; Various packages
  3139. (declare-function calc-eval "calc" (str &optional separator &rest args))
  3140. (declare-function calendar-forward-day "cal-move" (arg))
  3141. (declare-function calendar-goto-date "cal-move" (date))
  3142. (declare-function calendar-goto-today "cal-move" ())
  3143. (declare-function calendar-iso-from-absolute "cal-iso" (date))
  3144. (declare-function calendar-iso-to-absolute "cal-iso" (date))
  3145. (declare-function cdlatex-compute-tables "ext:cdlatex" ())
  3146. (declare-function cdlatex-tab "ext:cdlatex" ())
  3147. (declare-function dired-get-filename
  3148. "dired"
  3149. (&optional localp no-error-if-not-filep))
  3150. (declare-function org-agenda-change-all-lines
  3151. "org-agenda"
  3152. (newhead hdmarker &optional fixface just-this))
  3153. (declare-function org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
  3154. "org-agenda"
  3155. (&optional end))
  3156. (declare-function org-agenda-copy-local-variable "org-agenda" (var))
  3157. (declare-function org-agenda-format-item
  3158. "org-agenda"
  3159. (extra txt &optional level category tags dotime
  3160. remove-re habitp))
  3161. (declare-function org-agenda-new-marker "org-agenda" (&optional pos))
  3162. (declare-function org-agenda-save-markers-for-cut-and-paste
  3163. "org-agenda"
  3164. (beg end))
  3165. (declare-function org-agenda-set-restriction-lock "org-agenda" (&optional type))
  3166. (declare-function org-agenda-skip "org-agenda" (&optional element))
  3167. (declare-function org-attach-expand "org-attach" (file))
  3168. (declare-function org-attach-reveal "org-attach" ())
  3169. (declare-function org-attach-reveal-in-emacs "org-attach" ())
  3170. (declare-function org-gnus-follow-link "org-gnus" (&optional group article))
  3171. (declare-function org-indent-mode "org-indent" (&optional arg))
  3172. (declare-function org-inlinetask-goto-beginning "org-inlinetask" ())
  3173. (declare-function org-inlinetask-goto-end "org-inlinetask" ())
  3174. (declare-function org-inlinetask-in-task-p "org-inlinetask" ())
  3175. (declare-function org-inlinetask-remove-END-maybe "org-inlinetask" ())
  3176. (declare-function parse-time-string "parse-time" (string))
  3177. (defvar align-mode-rules-list)
  3178. (defvar calc-embedded-close-formula)
  3179. (defvar calc-embedded-open-formula)
  3180. (defvar calc-embedded-open-mode)
  3181. (defvar font-lock-unfontify-region-function)
  3182. (defvar org-agenda-tags-todo-honor-ignore-options)
  3183. (defvar remember-data-file)
  3184. (defvar texmathp-why)
  3185. (declare-function org-clock-save-markers-for-cut-and-paste "org-clock" (beg end))
  3186. (declare-function org-clock-update-mode-line "org-clock" (&optional refresh))
  3187. (declare-function org-resolve-clocks "org-clock"
  3188. (&optional also-non-dangling-p prompt last-valid))
  3189. (defvar org-clock-start-time)
  3190. (defvar org-clock-marker (make-marker)
  3191. "Marker recording the last clock-in.")
  3192. (defvar org-clock-hd-marker (make-marker)
  3193. "Marker recording the last clock-in, but the headline position.")
  3194. (defvar org-clock-heading ""
  3195. "The heading of the current clock entry.")
  3196. (defun org-clocking-buffer ()
  3197. "Return the buffer where the clock is currently running.
  3198. Return nil if no clock is running."
  3199. (marker-buffer org-clock-marker))
  3200. (defalias 'org-clock-is-active #'org-clocking-buffer)
  3201. (defun org-check-running-clock ()
  3202. "Check if the current buffer contains the running clock.
  3203. If yes, offer to stop it and to save the buffer with the changes."
  3204. (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
  3205. (y-or-n-p (format "Clock-out in buffer %s before killing it? "
  3206. (buffer-name))))
  3207. (org-clock-out)
  3208. (when (y-or-n-p "Save changed buffer?")
  3209. (save-buffer))))
  3210. (defun org-clocktable-try-shift (dir n)
  3211. "Check if this line starts a clock table, if yes, shift the time block."
  3212. (when (org-match-line "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>")
  3213. (org-clocktable-shift dir n)))
  3214. ;;;###autoload
  3215. (defun org-clock-persistence-insinuate ()
  3216. "Set up hooks for clock persistence."
  3217. (require 'org-clock)
  3218. (add-hook 'org-mode-hook 'org-clock-load)
  3219. (add-hook 'kill-emacs-hook 'org-clock-save))
  3220. (defun org-clock-auto-clockout-insinuate ()
  3221. "Set up hook for auto clocking out when Emacs is idle.
  3222. See `org-clock-auto-clockout-timer'.
  3223. This function is meant to be added to the user configuration."
  3224. (require 'org-clock)
  3225. (add-hook 'org-clock-in-hook #'org-clock-auto-clockout t))
  3226. (defgroup org-archive nil
  3227. "Options concerning archiving in Org mode."
  3228. :tag "Org Archive"
  3229. :group 'org-structure)
  3230. (defcustom org-archive-location "%s_archive::"
  3231. "The location where subtrees should be archived.
  3232. The value of this variable is a string, consisting of two parts,
  3233. separated by a double-colon. The first part is a filename and
  3234. the second part is a headline.
  3235. When the filename is omitted, archiving happens in the same file.
  3236. %s in the filename will be replaced by the current file
  3237. name (without the directory part). Archiving to a different file
  3238. is useful to keep archived entries from contributing to the
  3239. Org Agenda.
  3240. The archived entries will be filed as subtrees of the specified
  3241. headline. When the headline is omitted, the subtrees are simply
  3242. filed away at the end of the file, as top-level entries. Also in
  3243. the heading you can use %s to represent the file name, this can be
  3244. useful when using the same archive for a number of different files.
  3245. Here are a few examples:
  3246. \"%s_archive::\"
  3247. If the current file is Projects.org, archive in file
  3248. Projects.org_archive, as top-level trees. This is the default.
  3249. \"::* Archived Tasks\"
  3250. Archive in the current file, under the top-level headline
  3251. \"* Archived Tasks\".
  3252. \"~/org/archive.org::\"
  3253. Archive in file ~/org/archive.org (absolute path), as top-level trees.
  3254. \"~/org/archive.org::* From %s\"
  3255. Archive in file ~/org/archive.org (absolute path), under headlines
  3256. \"From FILENAME\" where file name is the current file name.
  3257. \"~/org/datetree.org::datetree/* Finished Tasks\"
  3258. The \"datetree/\" string is special, signifying to archive
  3259. items to the datetree. Items are placed in either the CLOSED
  3260. date of the item, or the current date if there is no CLOSED date.
  3261. The heading will be a subentry to the current date. There doesn't
  3262. need to be a heading, but there always needs to be a slash after
  3263. datetree. For example, to store archived items directly in the
  3264. datetree, use \"~/org/datetree.org::datetree/\".
  3265. \"basement::** Finished Tasks\"
  3266. Archive in file ./basement (relative path), as level 3 trees
  3267. below the level 2 heading \"** Finished Tasks\".
  3268. You may define it locally by setting an ARCHIVE property. If
  3269. such a property is found in the file or in an entry, and anywhere
  3270. up the hierarchy, it will be used.
  3271. You can also set it for the whole file using the keyword-syntax:
  3272. #+ARCHIVE: basement::** Finished Tasks"
  3273. :group 'org-archive
  3274. :type 'string)
  3275. (defcustom org-agenda-skip-archived-trees t
  3276. "Non-nil means the agenda will skip any items located in archived trees.
  3277. An archived tree is a tree marked with the tag ARCHIVE. The use of this
  3278. variable is no longer recommended, you should leave it at the value t.
  3279. Instead, use the key `v' to cycle the archives-mode in the agenda."
  3280. :group 'org-archive
  3281. :group 'org-agenda-skip
  3282. :type 'boolean)
  3283. (defcustom org-columns-skip-archived-trees t
  3284. "Non-nil means ignore archived trees when creating column view."
  3285. :group 'org-archive
  3286. :group 'org-properties
  3287. :type 'boolean)
  3288. (defcustom org-sparse-tree-open-archived-trees nil
  3289. "Non-nil means sparse tree construction shows matches in archived trees.
  3290. When nil, matches in these trees are highlighted, but the trees are kept in
  3291. collapsed state."
  3292. :group 'org-archive
  3293. :group 'org-sparse-trees
  3294. :type 'boolean)
  3295. (defcustom org-sparse-tree-default-date-type nil
  3296. "The default date type when building a sparse tree.
  3297. When this is nil, a date is a scheduled or a deadline timestamp.
  3298. Otherwise, these types are allowed:
  3299. all: all timestamps
  3300. active: only active timestamps (<...>)
  3301. inactive: only inactive timestamps ([...])
  3302. scheduled: only scheduled timestamps
  3303. deadline: only deadline timestamps"
  3304. :type '(choice (const :tag "Scheduled or deadline" nil)
  3305. (const :tag "All timestamps" all)
  3306. (const :tag "Only active timestamps" active)
  3307. (const :tag "Only inactive timestamps" inactive)
  3308. (const :tag "Only scheduled timestamps" scheduled)
  3309. (const :tag "Only deadline timestamps" deadline)
  3310. (const :tag "Only closed timestamps" closed))
  3311. :version "26.1"
  3312. :package-version '(Org . "8.3")
  3313. :group 'org-sparse-trees)
  3314. (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
  3315. ;; Declare Column View Code
  3316. (declare-function org-columns-get-format-and-top-level "org-colview" ())
  3317. (declare-function org-columns-compute "org-colview" (property))
  3318. ;; Declare ID code
  3319. (declare-function org-id-store-link "org-id")
  3320. (declare-function org-id-locations-load "org-id")
  3321. (declare-function org-id-locations-save "org-id")
  3322. (defvar org-id-track-globally)
  3323. ;;; Variables for pre-computed regular expressions, all buffer local
  3324. (defvar-local org-todo-regexp nil
  3325. "Matches any of the TODO state keywords.
  3326. Since TODO keywords are case-sensitive, `case-fold-search' is
  3327. expected to be bound to nil when matching against this regexp.")
  3328. (defvar-local org-not-done-regexp nil
  3329. "Matches any of the TODO state keywords except the last one.
  3330. Since TODO keywords are case-sensitive, `case-fold-search' is
  3331. expected to be bound to nil when matching against this regexp.")
  3332. (defvar-local org-not-done-heading-regexp nil
  3333. "Matches a TODO headline that is not done.
  3334. Since TODO keywords are case-sensitive, `case-fold-search' is
  3335. expected to be bound to nil when matching against this regexp.")
  3336. (defvar-local org-todo-line-regexp nil
  3337. "Matches a headline and puts TODO state into group 2 if present.
  3338. Since TODO keywords are case-sensitive, `case-fold-search' is
  3339. expected to be bound to nil when matching against this regexp.")
  3340. (defvar-local org-complex-heading-regexp nil
  3341. "Matches a headline and puts everything into groups:
  3342. group 1: Stars
  3343. group 2: The TODO keyword, maybe
  3344. group 3: Priority cookie
  3345. group 4: True headline
  3346. group 5: Tags
  3347. Since TODO keywords are case-sensitive, `case-fold-search' is
  3348. expected to be bound to nil when matching against this regexp.")
  3349. (defvar-local org-complex-heading-regexp-format nil
  3350. "Printf format to make regexp to match an exact headline.
  3351. This regexp will match the headline of any node which has the
  3352. exact headline text that is put into the format, but may have any
  3353. TODO state, priority, tags, statistics cookies (at the beginning
  3354. or end of the headline title), or COMMENT keyword.")
  3355. (defvar-local org-todo-line-tags-regexp nil
  3356. "Matches a headline and puts TODO state into group 2 if present.
  3357. Also put tags into group 4 if tags are present.")
  3358. (defconst org-plain-time-of-day-regexp
  3359. (concat
  3360. "\\(\\<[012]?[0-9]"
  3361. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  3362. "\\(--?"
  3363. "\\(\\<[012]?[0-9]"
  3364. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  3365. "\\)?")
  3366. "Regular expression to match a plain time or time range.
  3367. Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
  3368. groups carry important information:
  3369. 0 the full match
  3370. 1 the first time, range or not
  3371. 8 the second time, if it is a range.")
  3372. (defconst org-plain-time-extension-regexp
  3373. (concat
  3374. "\\(\\<[012]?[0-9]"
  3375. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  3376. "\\+\\([0-9]+\\)\\(:\\([0-5][0-9]\\)\\)?")
  3377. "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
  3378. Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
  3379. groups carry important information:
  3380. 0 the full match
  3381. 7 hours of duration
  3382. 9 minutes of duration")
  3383. (defconst org-stamp-time-of-day-regexp
  3384. (concat
  3385. "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} +\\sw+ +\\)"
  3386. "\\([012][0-9]:[0-5][0-9]\\)\\(-\\([012][0-9]:[0-5][0-9]\\)\\)?[^\n\r>]*?>"
  3387. "\\(--?"
  3388. "<\\1\\([012][0-9]:[0-5][0-9]\\)>\\)?")
  3389. "Regular expression to match a timestamp time or time range.
  3390. After a match, the following groups carry important information:
  3391. 0 the full match
  3392. 1 date plus weekday, for back referencing to make sure
  3393. both times are on the same day
  3394. 2 the first time, range or not
  3395. 4 the second time, if it is a range.")
  3396. (defconst org-startup-options
  3397. '(("fold" org-startup-folded t)
  3398. ("overview" org-startup-folded t)
  3399. ("nofold" org-startup-folded nil)
  3400. ("showall" org-startup-folded nil)
  3401. ("show2levels" org-startup-folded show2levels)
  3402. ("show3levels" org-startup-folded show3levels)
  3403. ("show4levels" org-startup-folded show4levels)
  3404. ("show5levels" org-startup-folded show5levels)
  3405. ("showeverything" org-startup-folded showeverything)
  3406. ("content" org-startup-folded content)
  3407. ("indent" org-startup-indented t)
  3408. ("noindent" org-startup-indented nil)
  3409. ("num" org-startup-numerated t)
  3410. ("nonum" org-startup-numerated nil)
  3411. ("hidestars" org-hide-leading-stars t)
  3412. ("showstars" org-hide-leading-stars nil)
  3413. ("odd" org-odd-levels-only t)
  3414. ("oddeven" org-odd-levels-only nil)
  3415. ("align" org-startup-align-all-tables t)
  3416. ("noalign" org-startup-align-all-tables nil)
  3417. ("shrink" org-startup-shrink-all-tables t)
  3418. ("inlineimages" org-startup-with-inline-images t)
  3419. ("noinlineimages" org-startup-with-inline-images nil)
  3420. ("latexpreview" org-startup-with-latex-preview t)
  3421. ("nolatexpreview" org-startup-with-latex-preview nil)
  3422. ("customtime" org-display-custom-times t)
  3423. ("logdone" org-log-done time)
  3424. ("lognotedone" org-log-done note)
  3425. ("nologdone" org-log-done nil)
  3426. ("lognoteclock-out" org-log-note-clock-out t)
  3427. ("nolognoteclock-out" org-log-note-clock-out nil)
  3428. ("logrepeat" org-log-repeat state)
  3429. ("lognoterepeat" org-log-repeat note)
  3430. ("logdrawer" org-log-into-drawer t)
  3431. ("nologdrawer" org-log-into-drawer nil)
  3432. ("logstatesreversed" org-log-states-order-reversed t)
  3433. ("nologstatesreversed" org-log-states-order-reversed nil)
  3434. ("nologrepeat" org-log-repeat nil)
  3435. ("logreschedule" org-log-reschedule time)
  3436. ("lognotereschedule" org-log-reschedule note)
  3437. ("nologreschedule" org-log-reschedule nil)
  3438. ("logredeadline" org-log-redeadline time)
  3439. ("lognoteredeadline" org-log-redeadline note)
  3440. ("nologredeadline" org-log-redeadline nil)
  3441. ("logrefile" org-log-refile time)
  3442. ("lognoterefile" org-log-refile note)
  3443. ("nologrefile" org-log-refile nil)
  3444. ("fninline" org-footnote-define-inline t)
  3445. ("nofninline" org-footnote-define-inline nil)
  3446. ("fnlocal" org-footnote-section nil)
  3447. ("fnauto" org-footnote-auto-label t)
  3448. ("fnprompt" org-footnote-auto-label nil)
  3449. ("fnconfirm" org-footnote-auto-label confirm)
  3450. ("fnplain" org-footnote-auto-label plain)
  3451. ("fnadjust" org-footnote-auto-adjust t)
  3452. ("nofnadjust" org-footnote-auto-adjust nil)
  3453. ("constcgs" constants-unit-system cgs)
  3454. ("constSI" constants-unit-system SI)
  3455. ("noptag" org-tag-persistent-alist nil)
  3456. ("hideblocks" org-hide-block-startup t)
  3457. ("nohideblocks" org-hide-block-startup nil)
  3458. ("hidedrawers" org-hide-drawer-startup t)
  3459. ("nohidedrawers" org-hide-drawer-startup nil)
  3460. ("beamer" org-startup-with-beamer-mode t)
  3461. ("entitiespretty" org-pretty-entities t)
  3462. ("entitiesplain" org-pretty-entities nil))
  3463. "Variable associated with STARTUP options for Org.
  3464. Each element is a list of three items: the startup options (as written
  3465. in the #+STARTUP line), the corresponding variable, and the value to set
  3466. this variable to if the option is found. An optional fourth element PUSH
  3467. means to push this value onto the list in the variable.")
  3468. (defcustom org-group-tags t
  3469. "When non-nil (the default), use group tags.
  3470. This can be turned on/off through `org-toggle-tags-groups'."
  3471. :group 'org-tags
  3472. :group 'org-startup
  3473. :type 'boolean)
  3474. (defvar org-inhibit-startup nil) ; Dynamically-scoped param.
  3475. (defun org-toggle-tags-groups ()
  3476. "Toggle support for group tags.
  3477. Support for group tags is controlled by the option
  3478. `org-group-tags', which is non-nil by default."
  3479. (interactive)
  3480. (setq org-group-tags (not org-group-tags))
  3481. (cond ((and (derived-mode-p 'org-agenda-mode)
  3482. org-group-tags)
  3483. (org-agenda-redo))
  3484. ((derived-mode-p 'org-mode)
  3485. (let ((org-inhibit-startup t)) (org-mode))))
  3486. (message "Groups tags support has been turned %s"
  3487. (if org-group-tags "on" "off")))
  3488. (defun org--tag-add-to-alist (alist1 alist2)
  3489. "Merge tags from ALIST1 into ALIST2.
  3490. Duplicates tags outside a group are removed. Keywords and order
  3491. are preserved.
  3492. The function assumes ALIST1 and ALIST2 are proper tag alists.
  3493. See `org-tag-alist' for their structure."
  3494. (cond
  3495. ((null alist2) alist1)
  3496. ((null alist1) alist2)
  3497. (t
  3498. (let ((to-add nil)
  3499. (group-flag nil))
  3500. (dolist (tag-pair alist1)
  3501. (pcase tag-pair
  3502. (`(,(or :startgrouptag :startgroup))
  3503. (setq group-flag t)
  3504. (push tag-pair to-add))
  3505. (`(,(or :endgrouptag :endgroup))
  3506. (setq group-flag nil)
  3507. (push tag-pair to-add))
  3508. (`(,(or :grouptags :newline))
  3509. (push tag-pair to-add))
  3510. (`(,tag . ,_)
  3511. ;; Remove duplicates from ALIST1, unless they are in
  3512. ;; a group. Indeed, it makes sense to have a tag appear in
  3513. ;; multiple groups.
  3514. (when (or group-flag (not (assoc tag alist2)))
  3515. (push tag-pair to-add)))
  3516. (_ (error "Invalid association in tag alist: %S" tag-pair))))
  3517. ;; Preserve order of ALIST1.
  3518. (append (nreverse to-add) alist2)))))
  3519. (defun org-priority-to-value (s)
  3520. "Convert priority string S to its numeric value."
  3521. (or (save-match-data
  3522. (and (string-match "\\([0-9]+\\)" s)
  3523. (string-to-number (match-string 1 s))))
  3524. (string-to-char s)))
  3525. (defun org-set-regexps-and-options (&optional tags-only)
  3526. "Precompute regular expressions used in the current buffer.
  3527. When optional argument TAGS-ONLY is non-nil, only compute tags
  3528. related expressions."
  3529. (when (derived-mode-p 'org-mode)
  3530. (let ((alist (org-collect-keywords
  3531. (append '("FILETAGS" "TAGS")
  3532. (and (not tags-only)
  3533. '("ARCHIVE" "CATEGORY" "COLUMNS" "CONSTANTS"
  3534. "LINK" "OPTIONS" "PRIORITIES" "PROPERTY"
  3535. "SEQ_TODO" "STARTUP" "TODO" "TYP_TODO")))
  3536. '("ARCHIVE" "CATEGORY" "COLUMNS" "PRIORITIES"))))
  3537. ;; Startup options. Get this early since it does change
  3538. ;; behavior for other options (e.g., tags).
  3539. (let ((startup (cl-mapcan (lambda (value) (split-string value))
  3540. (cdr (assoc "STARTUP" alist)))))
  3541. (dolist (option startup)
  3542. (pcase (assoc-string option org-startup-options t)
  3543. (`(,_ ,variable ,value t)
  3544. (unless (listp (symbol-value variable))
  3545. (set (make-local-variable variable) nil))
  3546. (add-to-list variable value))
  3547. (`(,_ ,variable ,value . ,_)
  3548. (set (make-local-variable variable) value))
  3549. (_ nil))))
  3550. (setq-local org-file-tags
  3551. (mapcar #'org-add-prop-inherited
  3552. (cl-mapcan (lambda (value)
  3553. (cl-mapcan
  3554. (lambda (k) (org-split-string k ":"))
  3555. (split-string value)))
  3556. (cdr (assoc "FILETAGS" alist)))))
  3557. (setq org-current-tag-alist
  3558. (org--tag-add-to-alist
  3559. org-tag-persistent-alist
  3560. (let ((tags (cdr (assoc "TAGS" alist))))
  3561. (if tags
  3562. (org-tag-string-to-alist
  3563. (mapconcat #'identity tags "\n"))
  3564. org-tag-alist))))
  3565. (setq org-tag-groups-alist
  3566. (org-tag-alist-to-groups org-current-tag-alist))
  3567. (unless tags-only
  3568. ;; Properties.
  3569. (let ((properties nil))
  3570. (dolist (value (cdr (assoc "PROPERTY" alist)))
  3571. (when (string-match "\\(\\S-+\\)[ \t]+\\(.*\\)" value)
  3572. (setq properties (org--update-property-plist
  3573. (match-string-no-properties 1 value)
  3574. (match-string-no-properties 2 value)
  3575. properties))))
  3576. (setq-local org-keyword-properties properties))
  3577. ;; Archive location.
  3578. (let ((archive (cdr (assoc "ARCHIVE" alist))))
  3579. (when archive (setq-local org-archive-location archive)))
  3580. ;; Category.
  3581. (let ((category (cdr (assoc "CATEGORY" alist))))
  3582. (when category
  3583. (setq-local org-category (intern category))
  3584. (setq-local org-keyword-properties
  3585. (org--update-property-plist
  3586. "CATEGORY" category org-keyword-properties))))
  3587. ;; Columns.
  3588. (let ((column (cdr (assoc "COLUMNS" alist))))
  3589. (when column (setq-local org-columns-default-format column)))
  3590. ;; Constants.
  3591. (let ((store nil))
  3592. (dolist (pair (cl-mapcan #'split-string
  3593. (cdr (assoc "CONSTANTS" alist))))
  3594. (when (string-match "^\\([a-zA-Z0][_a-zA-Z0-9]*\\)=\\(.*\\)" pair)
  3595. (let* ((name (match-string 1 pair))
  3596. (value (match-string 2 pair))
  3597. (old (assoc name store)))
  3598. (if old (setcdr old value)
  3599. (push (cons name value) store)))))
  3600. (setq org-table-formula-constants-local store))
  3601. ;; Link abbreviations.
  3602. (let ((links
  3603. (delq nil
  3604. (mapcar
  3605. (lambda (value)
  3606. (and (string-match "\\`\\(\\S-+\\)[ \t]+\\(.+\\)" value)
  3607. (cons (match-string-no-properties 1 value)
  3608. (match-string-no-properties 2 value))))
  3609. (cdr (assoc "LINK" alist))))))
  3610. (when links (setq org-link-abbrev-alist-local (nreverse links))))
  3611. ;; Priorities.
  3612. (let ((value (cdr (assoc "PRIORITIES" alist))))
  3613. (pcase (and value (split-string value))
  3614. (`(,high ,low ,default . ,_)
  3615. (setq-local org-priority-highest (org-priority-to-value high))
  3616. (setq-local org-priority-lowest (org-priority-to-value low))
  3617. (setq-local org-priority-default (org-priority-to-value default)))))
  3618. ;; Scripts.
  3619. (let ((value (cdr (assoc "OPTIONS" alist))))
  3620. (dolist (option value)
  3621. (when (string-match "\\^:\\(t\\|nil\\|{}\\)" option)
  3622. (setq-local org-use-sub-superscripts
  3623. (read (match-string 1 option))))))
  3624. ;; TODO keywords.
  3625. (setq-local org-todo-kwd-alist nil)
  3626. (setq-local org-todo-key-alist nil)
  3627. (setq-local org-todo-key-trigger nil)
  3628. (setq-local org-todo-keywords-1 nil)
  3629. (setq-local org-done-keywords nil)
  3630. (setq-local org-todo-heads nil)
  3631. (setq-local org-todo-sets nil)
  3632. (setq-local org-todo-log-states nil)
  3633. (let ((todo-sequences
  3634. (or (append (mapcar (lambda (value)
  3635. (cons 'type (split-string value)))
  3636. (cdr (assoc "TYP_TODO" alist)))
  3637. (mapcar (lambda (value)
  3638. (cons 'sequence (split-string value)))
  3639. (append (cdr (assoc "TODO" alist))
  3640. (cdr (assoc "SEQ_TODO" alist)))))
  3641. (let ((d (default-value 'org-todo-keywords)))
  3642. (if (not (stringp (car d))) d
  3643. ;; XXX: Backward compatibility code.
  3644. (list (cons org-todo-interpretation d)))))))
  3645. (dolist (sequence todo-sequences)
  3646. (let* ((sequence (or (run-hook-with-args-until-success
  3647. 'org-todo-setup-filter-hook sequence)
  3648. sequence))
  3649. (sequence-type (car sequence))
  3650. (keywords (cdr sequence))
  3651. (sep (member "|" keywords))
  3652. names alist)
  3653. (dolist (k (remove "|" keywords))
  3654. (unless (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?.*?)\\)?$"
  3655. k)
  3656. (error "Invalid TODO keyword %s" k))
  3657. (let ((name (match-string 1 k))
  3658. (key (match-string 2 k))
  3659. (log (org-extract-log-state-settings k)))
  3660. (push name names)
  3661. (push (cons name (and key (string-to-char key))) alist)
  3662. (when log (push log org-todo-log-states))))
  3663. (let* ((names (nreverse names))
  3664. (done (if sep (org-remove-keyword-keys (cdr sep))
  3665. (last names)))
  3666. (head (car names))
  3667. (tail (list sequence-type head (car done) (org-last done))))
  3668. (add-to-list 'org-todo-heads head 'append)
  3669. (push names org-todo-sets)
  3670. (setq org-done-keywords (append org-done-keywords done nil))
  3671. (setq org-todo-keywords-1 (append org-todo-keywords-1 names nil))
  3672. (setq org-todo-key-alist
  3673. (append org-todo-key-alist
  3674. (and alist
  3675. (append '((:startgroup))
  3676. (nreverse alist)
  3677. '((:endgroup))))))
  3678. (dolist (k names) (push (cons k tail) org-todo-kwd-alist))))))
  3679. (setq org-todo-sets (nreverse org-todo-sets)
  3680. org-todo-kwd-alist (nreverse org-todo-kwd-alist)
  3681. org-todo-key-trigger (delq nil (mapcar #'cdr org-todo-key-alist))
  3682. org-todo-key-alist (org-assign-fast-keys org-todo-key-alist))
  3683. ;; Compute the regular expressions and other local variables.
  3684. ;; Using `org-outline-regexp-bol' would complicate them much,
  3685. ;; because of the fixed white space at the end of that string.
  3686. (unless org-done-keywords
  3687. (setq org-done-keywords
  3688. (and org-todo-keywords-1 (last org-todo-keywords-1))))
  3689. (setq org-not-done-keywords
  3690. (org-delete-all org-done-keywords
  3691. (copy-sequence org-todo-keywords-1))
  3692. org-todo-regexp (regexp-opt org-todo-keywords-1 t)
  3693. org-not-done-regexp (regexp-opt org-not-done-keywords t)
  3694. org-not-done-heading-regexp
  3695. (format org-heading-keyword-regexp-format org-not-done-regexp)
  3696. org-todo-line-regexp
  3697. (format org-heading-keyword-maybe-regexp-format org-todo-regexp)
  3698. org-complex-heading-regexp
  3699. (concat "^\\(\\*+\\)"
  3700. "\\(?: +" org-todo-regexp "\\)?"
  3701. "\\(?: +\\(\\[#.\\]\\)\\)?"
  3702. "\\(?: +\\(.*?\\)\\)??"
  3703. "\\(?:[ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)?"
  3704. "[ \t]*$")
  3705. org-complex-heading-regexp-format
  3706. (concat "^\\(\\*+\\)"
  3707. "\\(?: +" org-todo-regexp "\\)?"
  3708. "\\(?: +\\(\\[#.\\]\\)\\)?"
  3709. "\\(?: +"
  3710. ;; Headline might be commented
  3711. "\\(?:" org-comment-string " +\\)?"
  3712. ;; Stats cookies can be stuck to body.
  3713. "\\(?:\\[[0-9%%/]+\\] *\\)*"
  3714. "\\(%s\\)"
  3715. "\\(?: *\\[[0-9%%/]+\\]\\)*"
  3716. "\\)"
  3717. "\\(?:[ \t]+\\(:[[:alnum:]_@#%%:]+:\\)\\)?"
  3718. "[ \t]*$")
  3719. org-todo-line-tags-regexp
  3720. (concat "^\\(\\*+\\)"
  3721. "\\(?: +" org-todo-regexp "\\)?"
  3722. "\\(?: +\\(.*?\\)\\)??"
  3723. "\\(?:[ \t]+\\(:[[:alnum:]:_@#%]+:\\)\\)?"
  3724. "[ \t]*$"))
  3725. (org-compute-latex-and-related-regexp)))))
  3726. (defun org-collect-keywords (keywords &optional unique directory)
  3727. "Return values for KEYWORDS in current buffer, as an alist.
  3728. KEYWORDS is a list of strings. Return value is a list of
  3729. elements with the pattern:
  3730. (NAME . LIST-OF-VALUES)
  3731. where NAME is the upcase name of the keyword, and LIST-OF-VALUES
  3732. is a list of non-empty values, as strings, in order of appearance
  3733. in the buffer.
  3734. When KEYWORD appears in UNIQUE list, LIST-OF-VALUE is its first
  3735. value, empty or not, appearing in the buffer, as a string.
  3736. When KEYWORD appears in DIRECTORIES, each value is a cons cell:
  3737. (VALUE . DIRECTORY)
  3738. where VALUE is the regular value, and DIRECTORY is the variable
  3739. `default-directory' for the buffer containing the keyword. This
  3740. is important for values containing relative file names, since the
  3741. function follows SETUPFILE keywords, and may change its working
  3742. directory."
  3743. (let* ((keywords (cons "SETUPFILE" (mapcar #'upcase keywords)))
  3744. (unique (mapcar #'upcase unique))
  3745. (alist (org--collect-keywords-1
  3746. keywords unique directory
  3747. (and buffer-file-name (list buffer-file-name))
  3748. nil)))
  3749. ;; Re-order results.
  3750. (dolist (entry alist)
  3751. (pcase entry
  3752. (`(,_ . ,(and value (pred consp)))
  3753. (setcdr entry (nreverse value)))))
  3754. (nreverse alist)))
  3755. (defun org--collect-keywords-1 (keywords unique directory files alist)
  3756. (org-with-point-at 1
  3757. (let ((case-fold-search t)
  3758. (regexp (org-make-options-regexp keywords)))
  3759. (while (and keywords (re-search-forward regexp nil t))
  3760. (let ((element (org-element-at-point)))
  3761. (when (eq 'keyword (org-element-type element))
  3762. (let ((value (org-element-property :value element)))
  3763. (pcase (org-element-property :key element)
  3764. ("SETUPFILE"
  3765. (when (and (org-string-nw-p value)
  3766. (not buffer-read-only)) ;FIXME: bug in Gnus?
  3767. (let* ((uri (org-strip-quotes value))
  3768. (uri-is-url (org-url-p uri))
  3769. (uri (if uri-is-url
  3770. uri
  3771. (expand-file-name uri))))
  3772. (unless (member uri files)
  3773. (with-temp-buffer
  3774. (unless uri-is-url
  3775. (setq default-directory (file-name-directory uri)))
  3776. (let ((contents (org-file-contents uri :noerror)))
  3777. (when contents
  3778. (insert contents)
  3779. ;; Fake Org mode: `org-element-at-point'
  3780. ;; doesn't need full set-up.
  3781. (let ((major-mode 'org-mode))
  3782. (setq alist
  3783. (org--collect-keywords-1
  3784. keywords unique directory
  3785. (cons uri files)
  3786. alist))))))))))
  3787. (keyword
  3788. (let ((entry (assoc keyword alist))
  3789. (final
  3790. (cond ((not (member keyword directory)) value)
  3791. (buffer-file-name
  3792. (cons value
  3793. (file-name-directory buffer-file-name)))
  3794. (t (cons value default-directory)))))
  3795. (cond ((member keyword unique)
  3796. (push (cons keyword final) alist)
  3797. (setq keywords (remove keyword keywords))
  3798. (setq regexp (org-make-options-regexp keywords)))
  3799. ((null entry) (push (list keyword final) alist))
  3800. (t (push final (cdr entry)))))))))))
  3801. alist)))
  3802. (defun org-tag-string-to-alist (s)
  3803. "Return tag alist associated to string S.
  3804. S is a value for TAGS keyword or produced with
  3805. `org-tag-alist-to-string'. Return value is an alist suitable for
  3806. `org-tag-alist' or `org-tag-persistent-alist'."
  3807. (let ((lines (mapcar #'split-string (split-string s "\n" t)))
  3808. (tag-re (concat "\\`\\(" org-tag-re "\\|{.+?}\\)" ; regular expression
  3809. "\\(?:(\\(.\\))\\)?\\'"))
  3810. alist group-flag)
  3811. (dolist (tokens lines (cdr (nreverse alist)))
  3812. (push '(:newline) alist)
  3813. (while tokens
  3814. (let ((token (pop tokens)))
  3815. (pcase token
  3816. ("{"
  3817. (push '(:startgroup) alist)
  3818. (when (equal (nth 1 tokens) ":") (setq group-flag t)))
  3819. ("}"
  3820. (push '(:endgroup) alist)
  3821. (setq group-flag nil))
  3822. ("["
  3823. (push '(:startgrouptag) alist)
  3824. (when (equal (nth 1 tokens) ":") (setq group-flag t)))
  3825. ("]"
  3826. (push '(:endgrouptag) alist)
  3827. (setq group-flag nil))
  3828. (":"
  3829. (push '(:grouptags) alist))
  3830. ((guard (string-match tag-re token))
  3831. (let ((tag (match-string 1 token))
  3832. (key (and (match-beginning 2)
  3833. (string-to-char (match-string 2 token)))))
  3834. ;; Push all tags in groups, no matter if they already
  3835. ;; appear somewhere else in the list.
  3836. (when (or group-flag (not (assoc tag alist)))
  3837. (push (cons tag key) alist))))))))))
  3838. (defun org-tag-alist-to-string (alist &optional skip-key)
  3839. "Return tag string associated to ALIST.
  3840. ALIST is an alist, as defined in `org-tag-alist' or
  3841. `org-tag-persistent-alist', or produced with
  3842. `org-tag-string-to-alist'.
  3843. Return value is a string suitable as a value for \"TAGS\"
  3844. keyword.
  3845. When optional argument SKIP-KEY is non-nil, skip selection keys
  3846. next to tags."
  3847. (mapconcat (lambda (token)
  3848. (pcase token
  3849. (`(:startgroup) "{")
  3850. (`(:endgroup) "}")
  3851. (`(:startgrouptag) "[")
  3852. (`(:endgrouptag) "]")
  3853. (`(:grouptags) ":")
  3854. (`(:newline) "\\n")
  3855. ((and
  3856. (guard (not skip-key))
  3857. `(,(and tag (pred stringp)) . ,(and key (pred characterp))))
  3858. (format "%s(%c)" tag key))
  3859. (`(,(and tag (pred stringp)) . ,_) tag)
  3860. (_ (user-error "Invalid tag token: %S" token))))
  3861. alist
  3862. " "))
  3863. (defun org-tag-alist-to-groups (alist)
  3864. "Return group alist from tag ALIST.
  3865. ALIST is an alist, as defined in `org-tag-alist' or
  3866. `org-tag-persistent-alist', or produced with
  3867. `org-tag-string-to-alist'. Return value is an alist following
  3868. the pattern (GROUP-TAG TAGS) where GROUP-TAG is the tag, as
  3869. a string, summarizing TAGS, as a list of strings."
  3870. (let (groups group-status current-group)
  3871. (dolist (token alist (nreverse groups))
  3872. (pcase token
  3873. (`(,(or :startgroup :startgrouptag)) (setq group-status t))
  3874. (`(,(or :endgroup :endgrouptag))
  3875. (when (eq group-status 'append)
  3876. (push (nreverse current-group) groups))
  3877. (setq group-status nil current-group nil))
  3878. (`(:grouptags) (setq group-status 'append))
  3879. ((and `(,tag . ,_) (guard group-status))
  3880. (if (eq group-status 'append) (push tag current-group)
  3881. (setq current-group (list tag))))
  3882. (_ nil)))))
  3883. (defvar org--file-cache (make-hash-table :test #'equal)
  3884. "Hash table to store contents of files referenced via a URL.
  3885. This is the cache of file URLs read using `org-file-contents'.")
  3886. (defun org-reset-file-cache ()
  3887. "Reset the cache of files downloaded by `org-file-contents'."
  3888. (clrhash org--file-cache))
  3889. (defun org-file-contents (file &optional noerror nocache)
  3890. "Return the contents of FILE, as a string.
  3891. FILE can be a file name or URL.
  3892. If FILE is a URL, download the contents. If the URL contents are
  3893. already cached in the `org--file-cache' hash table, the download step
  3894. is skipped.
  3895. If NOERROR is non-nil, ignore the error when unable to read the FILE
  3896. from file or URL, and return nil.
  3897. If NOCACHE is non-nil, do a fresh fetch of FILE even if cached version
  3898. is available. This option applies only if FILE is a URL."
  3899. (let* ((is-url (org-url-p file))
  3900. (cache (and is-url
  3901. (not nocache)
  3902. (gethash file org--file-cache))))
  3903. (cond
  3904. (cache)
  3905. (is-url
  3906. (if (org--should-fetch-remote-resource-p file)
  3907. (with-current-buffer (url-retrieve-synchronously file)
  3908. (goto-char (point-min))
  3909. ;; Move point to after the url-retrieve header.
  3910. (search-forward "\n\n" nil :move)
  3911. ;; Search for the success code only in the url-retrieve header.
  3912. (if (save-excursion
  3913. (re-search-backward "HTTP.*\\s-+200\\s-OK" nil :noerror))
  3914. ;; Update the cache `org--file-cache' and return contents.
  3915. (puthash file
  3916. (buffer-substring-no-properties (point) (point-max))
  3917. org--file-cache)
  3918. (funcall (if noerror #'message #'user-error)
  3919. "Unable to fetch file from %S"
  3920. file)
  3921. nil))
  3922. (funcall (if noerror #'message #'user-error)
  3923. "The remote resource %S is considered unsafe, and will not be downloaded."
  3924. file)))
  3925. (t
  3926. (with-temp-buffer
  3927. (condition-case nil
  3928. (progn
  3929. (insert-file-contents file)
  3930. (buffer-string))
  3931. (file-error
  3932. (funcall (if noerror #'message #'user-error)
  3933. "Unable to read file %S"
  3934. file)
  3935. nil)))))))
  3936. (defun org--should-fetch-remote-resource-p (uri)
  3937. "Return non-nil if the URI should be fetched."
  3938. (or (eq org-resource-download-policy t)
  3939. (org--safe-remote-resource-p uri)
  3940. (and (eq org-resource-download-policy 'prompt)
  3941. (org--confirm-resource-safe uri))))
  3942. (defun org--safe-remote-resource-p (uri)
  3943. "Return non-nil if URI is considered safe.
  3944. This checks every pattern in `org-safe-remote-resources', and
  3945. returns non-nil if any of them match."
  3946. (let ((uri-patterns org-safe-remote-resources)
  3947. (file-uri (and buffer-file-name
  3948. (concat "file://" (file-truename buffer-file-name))))
  3949. match-p)
  3950. (while (and (not match-p) uri-patterns)
  3951. (setq match-p (or (string-match-p (car uri-patterns) uri)
  3952. (and file-uri (string-match-p (car uri-patterns) file-uri)))
  3953. uri-patterns (cdr uri-patterns)))
  3954. match-p))
  3955. (defun org--confirm-resource-safe (uri)
  3956. "Ask the user if URI should be considered safe, returning non-nil if so."
  3957. (unless noninteractive
  3958. (let ((current-file (and buffer-file-name (file-truename buffer-file-name)))
  3959. (domain (and (string-match
  3960. (rx (seq "http" (? "s") "://")
  3961. (optional (+ (not (any "@/\n"))) "@")
  3962. (optional "www.")
  3963. (one-or-more (not (any ":/?\n"))))
  3964. uri)
  3965. (match-string 0 uri)))
  3966. (buf (get-buffer-create "*Org Remote Resource*")))
  3967. ;; Set up the contents of the *Org Remote Resource* buffer.
  3968. (with-current-buffer buf
  3969. (erase-buffer)
  3970. (insert "An org-mode document would like to download "
  3971. (propertize uri 'face '(:inherit org-link :weight normal))
  3972. ", which is not considered safe.\n\n"
  3973. "Do you want to download this? You can type\n "
  3974. (propertize "!" 'face 'success)
  3975. " to download this resource, and permanantly mark it as safe.\n "
  3976. (if domain
  3977. (concat
  3978. (propertize "d" 'face 'success)
  3979. " to download this resource, and mark the domain ("
  3980. (propertize domain 'face '(:inherit org-link :weight normal))
  3981. ") as safe.\n ")
  3982. "")
  3983. (propertize "f" 'face 'success)
  3984. (if current-file
  3985. (concat
  3986. " to download this resource, and permanantly mark all resources in "
  3987. (propertize current-file 'face 'underline)
  3988. " as safe.\n ")
  3989. "")
  3990. (propertize "y" 'face 'warning)
  3991. " to download this resource, just this once.\n "
  3992. (propertize "n" 'face 'error)
  3993. " to skip this resource.\n")
  3994. (setq-local cursor-type nil)
  3995. (set-buffer-modified-p nil)
  3996. (goto-char (point-min)))
  3997. ;; Display the buffer and read a choice.
  3998. (save-window-excursion
  3999. (pop-to-buffer buf)
  4000. (let* ((exit-chars (append '(?y ?n ?! ?d ?\s) (and current-file '(?f))))
  4001. (prompt (format "Please type y, n%s, d, or !%s: "
  4002. (if current-file ", f" "")
  4003. (if (< (line-number-at-pos (point-max))
  4004. (window-body-height))
  4005. ""
  4006. ", or C-v/M-v to scroll")))
  4007. char)
  4008. (setq char (read-char-choice prompt exit-chars))
  4009. (when (memq char '(?! ?f ?d))
  4010. (customize-push-and-save
  4011. 'org-safe-remote-resources
  4012. (list (if (eq char ?d)
  4013. (concat "\\`" (regexp-quote domain) "\\(?:/\\|\\'\\)")
  4014. (concat "\\`"
  4015. (regexp-quote
  4016. (if (and (= char ?f) current-file)
  4017. (concat "file://" current-file) uri))
  4018. "\\'")))))
  4019. (prog1 (memq char '(?y ?n ?! ?d ?\s ?f))
  4020. (quit-window t)))))))
  4021. (defun org-extract-log-state-settings (x)
  4022. "Extract the log state setting from a TODO keyword string.
  4023. This will extract info from a string like \"WAIT(w@/!)\"."
  4024. (when (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?\\([!@]\\)?\\(?:/\\([!@]\\)\\)?)\\)?$" x)
  4025. (let ((kw (match-string 1 x))
  4026. (log1 (and (match-end 3) (match-string 3 x)))
  4027. (log2 (and (match-end 4) (match-string 4 x))))
  4028. (and (or log1 log2)
  4029. (list kw
  4030. (and log1 (if (equal log1 "!") 'time 'note))
  4031. (and log2 (if (equal log2 "!") 'time 'note)))))))
  4032. (defun org-remove-keyword-keys (list)
  4033. "Remove a pair of parenthesis at the end of each string in LIST."
  4034. (mapcar (lambda (x)
  4035. (if (string-match "(.*)$" x)
  4036. (substring x 0 (match-beginning 0))
  4037. x))
  4038. list))
  4039. (defun org-assign-fast-keys (alist)
  4040. "Assign fast keys to a keyword-key alist.
  4041. Respect keys that are already there."
  4042. (let (new e (alt ?0))
  4043. (while (setq e (pop alist))
  4044. (if (or (memq (car e) '(:newline :grouptags :endgroup :startgroup))
  4045. (cdr e)) ;; Key already assigned.
  4046. (push e new)
  4047. (let ((clist (string-to-list (downcase (car e))))
  4048. (used (append new alist)))
  4049. (when (= (car clist) ?@)
  4050. (pop clist))
  4051. (while (and clist (rassoc (car clist) used))
  4052. (pop clist))
  4053. (unless clist
  4054. (while (rassoc alt used)
  4055. (cl-incf alt)))
  4056. (push (cons (car e) (or (car clist) alt)) new))))
  4057. (nreverse new)))
  4058. ;;; Some variables used in various places
  4059. (defvar org-window-configuration nil
  4060. "Used in various places to store a window configuration.")
  4061. (defvar org-selected-window nil
  4062. "Used in various places to store a window configuration.")
  4063. (defvar org-finish-function nil
  4064. "Function to be called when `C-c C-c' is used.
  4065. This is for getting out of special buffers like capture.")
  4066. (defvar org-last-state)
  4067. ;; Defined somewhere in this file, but used before definition.
  4068. (defvar org-entities) ;; defined in org-entities.el
  4069. (defvar org-struct-menu)
  4070. (defvar org-org-menu)
  4071. (defvar org-tbl-menu)
  4072. ;;;; Define the Org mode
  4073. (defun org-before-change-function (_beg _end)
  4074. "Every change indicates that a table might need an update."
  4075. (setq org-table-may-need-update t))
  4076. (defvar org-mode-map)
  4077. (defvar org-inhibit-startup-visibility-stuff nil) ; Dynamically-scoped param.
  4078. (defvar org-agenda-keep-modes nil) ; Dynamically-scoped param.
  4079. (defvar org-inhibit-logging nil) ; Dynamically-scoped param.
  4080. (defvar org-inhibit-blocking nil) ; Dynamically-scoped param.
  4081. (defvar bidi-paragraph-direction)
  4082. (defvar buffer-face-mode-face)
  4083. (require 'outline)
  4084. ;; Other stuff we need.
  4085. (require 'time-date)
  4086. (when (< emacs-major-version 28) ; preloaded in Emacs 28
  4087. (require 'easymenu))
  4088. (require 'org-entities)
  4089. (require 'org-faces)
  4090. (require 'org-list)
  4091. (require 'org-pcomplete)
  4092. (require 'org-src)
  4093. (require 'org-footnote)
  4094. (require 'org-macro)
  4095. ;; babel
  4096. (require 'ob)
  4097. (defvar org-element-cache-persistent); Defined in org-element.el
  4098. (defvar org-element-use-cache); Defined in org-element.el
  4099. (defvar org-mode-loading nil
  4100. "Non-nil during Org mode initialisation.")
  4101. (defvar org-agenda-file-menu-enabled t
  4102. "When non-nil, refresh Agenda files in Org menu when loading Org.")
  4103. ;;;###autoload
  4104. (define-derived-mode org-mode outline-mode "Org"
  4105. "Outline-based notes management and organizer, alias
  4106. \"Carsten's outline-mode for keeping track of everything.\"
  4107. Org mode develops organizational tasks around a NOTES file which
  4108. contains information about projects as plain text. Org mode is
  4109. implemented on top of Outline mode, which is ideal to keep the content
  4110. of large files well structured. It supports ToDo items, deadlines and
  4111. time stamps, which magically appear in the diary listing of the Emacs
  4112. calendar. Tables are easily created with a built-in table editor.
  4113. Plain text URL-like links connect to websites, emails (VM), Usenet
  4114. messages (Gnus), BBDB entries, and any files related to the project.
  4115. For printing and sharing of notes, an Org file (or a part of it)
  4116. can be exported as a structured ASCII or HTML file.
  4117. The following commands are available:
  4118. \\{org-mode-map}"
  4119. (setq-local org-mode-loading t)
  4120. (org-load-modules-maybe)
  4121. (when org-agenda-file-menu-enabled
  4122. (org-install-agenda-files-menu))
  4123. (when (and org-link-descriptive
  4124. (eq org-fold-core-style 'overlays))
  4125. (add-to-invisibility-spec '(org-link)))
  4126. (org-fold-initialize (or (and (stringp org-ellipsis) (not (equal "" org-ellipsis)) org-ellipsis)
  4127. "..."))
  4128. (make-local-variable 'org-link-descriptive)
  4129. (when (eq org-fold-core-style 'overlays) (add-to-invisibility-spec '(org-hide-block . t)))
  4130. (if org-link-descriptive
  4131. (org-fold-core-set-folding-spec-property (car org-link--link-folding-spec) :visible nil)
  4132. (org-fold-core-set-folding-spec-property (car org-link--link-folding-spec) :visible t))
  4133. (setq-local outline-regexp org-outline-regexp)
  4134. (setq-local outline-level 'org-outline-level)
  4135. (when (and (stringp org-ellipsis) (not (equal "" org-ellipsis)))
  4136. (unless org-display-table
  4137. (setq org-display-table (make-display-table)))
  4138. (set-display-table-slot
  4139. org-display-table 4
  4140. (vconcat (mapcar (lambda (c) (make-glyph-code c 'org-ellipsis))
  4141. org-ellipsis)))
  4142. (setq buffer-display-table org-display-table))
  4143. (org-set-regexps-and-options)
  4144. (org-set-font-lock-defaults)
  4145. (when (and org-tag-faces (not org-tags-special-faces-re))
  4146. ;; tag faces set outside customize.... force initialization.
  4147. (org-set-tag-faces 'org-tag-faces org-tag-faces))
  4148. ;; Calc embedded
  4149. (setq-local calc-embedded-open-mode "# ")
  4150. ;; Modify a few syntax entries
  4151. (modify-syntax-entry ?\" "\"")
  4152. (modify-syntax-entry ?\\ "_")
  4153. (modify-syntax-entry ?~ "_")
  4154. (modify-syntax-entry ?< "(>")
  4155. (modify-syntax-entry ?> ")<")
  4156. (setq-local font-lock-unfontify-region-function 'org-unfontify-region)
  4157. ;; Activate before-change-function
  4158. (setq-local org-table-may-need-update t)
  4159. (add-hook 'before-change-functions 'org-before-change-function nil 'local)
  4160. ;; Check for running clock before killing a buffer
  4161. (add-hook 'kill-buffer-hook 'org-check-running-clock nil 'local)
  4162. ;; Initialize cache.
  4163. (org-element-cache-reset)
  4164. (when (and org-element-cache-persistent
  4165. org-element-use-cache)
  4166. (org-persist-load 'org-element--cache (current-buffer) t))
  4167. ;; Initialize macros templates.
  4168. (org-macro-initialize-templates)
  4169. ;; Initialize radio targets.
  4170. (org-update-radio-target-regexp)
  4171. ;; Indentation.
  4172. (setq-local indent-line-function 'org-indent-line)
  4173. (setq-local indent-region-function 'org-indent-region)
  4174. ;; Filling and auto-filling.
  4175. (org-setup-filling)
  4176. ;; Comments.
  4177. (org-setup-comments-handling)
  4178. ;; Beginning/end of defun
  4179. (setq-local beginning-of-defun-function 'org-backward-element)
  4180. (setq-local end-of-defun-function
  4181. (lambda ()
  4182. (if (not (org-at-heading-p))
  4183. (org-forward-element)
  4184. (org-forward-element)
  4185. (forward-char -1))))
  4186. ;; Next error for sparse trees
  4187. (setq-local next-error-function 'org-occur-next-match)
  4188. ;; Make commit log messages from Org documents easier.
  4189. (setq-local add-log-current-defun-function #'org-add-log-current-headline)
  4190. ;; Make sure dependence stuff works reliably, even for users who set it
  4191. ;; too late :-(
  4192. (if org-enforce-todo-dependencies
  4193. (add-hook 'org-blocker-hook
  4194. 'org-block-todo-from-children-or-siblings-or-parent)
  4195. (remove-hook 'org-blocker-hook
  4196. 'org-block-todo-from-children-or-siblings-or-parent))
  4197. (if org-enforce-todo-checkbox-dependencies
  4198. (add-hook 'org-blocker-hook
  4199. 'org-block-todo-from-checkboxes)
  4200. (remove-hook 'org-blocker-hook
  4201. 'org-block-todo-from-checkboxes))
  4202. ;; Align options lines
  4203. (setq-local
  4204. align-mode-rules-list
  4205. '((org-in-buffer-settings
  4206. (regexp . "^[ \t]*#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
  4207. (modes . '(org-mode)))))
  4208. ;; Setup the pcomplete hooks
  4209. (setq-local pcomplete-command-completion-function #'org-pcomplete-initial)
  4210. (setq-local pcomplete-command-name-function #'org-command-at-point)
  4211. (setq-local pcomplete-default-completion-function #'ignore)
  4212. (setq-local pcomplete-parse-arguments-function #'org-parse-arguments)
  4213. (setq-local pcomplete-termination-string "")
  4214. (add-hook 'completion-at-point-functions
  4215. #'pcomplete-completions-at-point nil t)
  4216. (setq-local buffer-face-mode-face 'org-default)
  4217. ;; If empty file that did not turn on Org mode automatically, make
  4218. ;; it to.
  4219. (when (and org-insert-mode-line-in-empty-file
  4220. (called-interactively-p 'any)
  4221. (= (point-min) (point-max)))
  4222. (insert "# -*- mode: org -*-\n\n"))
  4223. (unless org-inhibit-startup
  4224. (org-unmodified
  4225. (when org-startup-with-beamer-mode (org-beamer-mode))
  4226. (when (or org-startup-align-all-tables org-startup-shrink-all-tables)
  4227. (org-table-map-tables
  4228. (cond ((and org-startup-align-all-tables
  4229. org-startup-shrink-all-tables)
  4230. (lambda () (org-table-align) (org-table-shrink)))
  4231. (org-startup-align-all-tables #'org-table-align)
  4232. (t #'org-table-shrink))
  4233. t))
  4234. (when org-startup-with-inline-images (org-display-inline-images))
  4235. (when org-startup-with-latex-preview (org-latex-preview '(16)))
  4236. (unless org-inhibit-startup-visibility-stuff (org-cycle-set-startup-visibility))
  4237. (when org-startup-truncated (setq truncate-lines t))
  4238. (when org-startup-numerated (require 'org-num) (org-num-mode 1))
  4239. (when org-startup-indented (require 'org-indent) (org-indent-mode 1))))
  4240. ;; Add a custom keymap for `visual-line-mode' so that activating
  4241. ;; this minor mode does not override Org's keybindings.
  4242. ;; FIXME: Probably `visual-line-mode' should take care of this.
  4243. (let ((oldmap (cdr (assoc 'visual-line-mode minor-mode-map-alist)))
  4244. (newmap (make-sparse-keymap)))
  4245. (set-keymap-parent newmap oldmap)
  4246. (define-key newmap [remap move-beginning-of-line] nil)
  4247. (define-key newmap [remap move-end-of-line] nil)
  4248. (define-key newmap [remap kill-line] nil)
  4249. (make-local-variable 'minor-mode-overriding-map-alist)
  4250. (push `(visual-line-mode . ,newmap) minor-mode-overriding-map-alist))
  4251. ;; Activate `org-table-header-line-mode'
  4252. (when org-table-header-line-p
  4253. (org-table-header-line-mode 1))
  4254. ;; Try to set `org-hide' face correctly.
  4255. (let ((foreground (org-find-invisible-foreground)))
  4256. (when foreground
  4257. (set-face-foreground 'org-hide foreground)))
  4258. ;; Set face extension as requested.
  4259. (org--set-faces-extend '(org-block-begin-line org-block-end-line)
  4260. org-fontify-whole-block-delimiter-line)
  4261. (org--set-faces-extend org-level-faces org-fontify-whole-heading-line)
  4262. (setq-local org-mode-loading nil))
  4263. ;; Update `customize-package-emacs-version-alist'
  4264. (add-to-list 'customize-package-emacs-version-alist
  4265. '(Org ("8.0" . "24.4")
  4266. ("8.1" . "24.4")
  4267. ("8.2" . "24.4")
  4268. ("8.2.7" . "24.4")
  4269. ("8.3" . "26.1")
  4270. ("9.0" . "26.1")
  4271. ("9.1" . "26.1")
  4272. ("9.2" . "27.1")
  4273. ("9.3" . "27.1")
  4274. ("9.4" . "27.2")
  4275. ("9.5" . "28.1")
  4276. ("9.6" . "29.1")))
  4277. (defvar org-mode-transpose-word-syntax-table
  4278. (let ((st (make-syntax-table text-mode-syntax-table)))
  4279. (dolist (c org-emphasis-alist st)
  4280. (modify-syntax-entry (string-to-char (car c)) "w p" st))))
  4281. (when (fboundp 'abbrev-table-put)
  4282. (abbrev-table-put org-mode-abbrev-table
  4283. :parents (list text-mode-abbrev-table)))
  4284. (defun org-find-invisible-foreground ()
  4285. (let ((candidates (remove
  4286. "unspecified-bg"
  4287. (nconc
  4288. (list (face-background 'default)
  4289. (face-background 'org-default))
  4290. (mapcar
  4291. (lambda (alist)
  4292. (when (boundp alist)
  4293. (cdr (assq 'background-color (symbol-value alist)))))
  4294. '(default-frame-alist initial-frame-alist window-system-default-frame-alist))
  4295. (list (face-foreground 'org-hide))))))
  4296. (car (remove nil candidates))))
  4297. (defun org-current-time (&optional rounding-minutes past)
  4298. "Current time, possibly rounded to ROUNDING-MINUTES.
  4299. When ROUNDING-MINUTES is not an integer, fall back on the car of
  4300. `org-time-stamp-rounding-minutes'. When PAST is non-nil, ensure
  4301. the rounding returns a past time."
  4302. (let ((r (or (and (integerp rounding-minutes) rounding-minutes)
  4303. (car org-time-stamp-rounding-minutes)))
  4304. (now (current-time)))
  4305. (if (< r 1)
  4306. now
  4307. (let* ((time (decode-time now))
  4308. (res (org-encode-time
  4309. (apply #'list
  4310. 0 (* r (round (nth 1 time) r))
  4311. (nthcdr 2 time)))))
  4312. (if (or (not past) (time-less-p res now))
  4313. res
  4314. (time-subtract res (* r 60)))))))
  4315. (defun org-today ()
  4316. "Return today date, considering `org-extend-today-until'."
  4317. (time-to-days
  4318. (time-since (* 3600 org-extend-today-until))))
  4319. ;;;; Font-Lock stuff, including the activators
  4320. (defconst org-match-sexp-depth 3
  4321. "Number of stacked braces for sub/superscript matching.")
  4322. (defun org-create-multibrace-regexp (left right n)
  4323. "Create a regular expression which will match a balanced sexp.
  4324. Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
  4325. as single character strings.
  4326. The regexp returned will match the entire expression including the
  4327. delimiters. It will also define a single group which contains the
  4328. match except for the outermost delimiters. The maximum depth of
  4329. stacked delimiters is N. Escaping delimiters is not possible."
  4330. (let* ((nothing (concat "[^" left right "]*?"))
  4331. (or "\\|")
  4332. (re nothing)
  4333. (next (concat "\\(?:" nothing left nothing right "\\)+" nothing)))
  4334. (while (> n 1)
  4335. (setq n (1- n)
  4336. re (concat re or next)
  4337. next (concat "\\(?:" nothing left next right "\\)+" nothing)))
  4338. (concat left "\\(" re "\\)" right)))
  4339. (defconst org-match-substring-regexp
  4340. (concat
  4341. "\\(\\S-\\)\\([_^]\\)\\("
  4342. "\\(?:" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
  4343. "\\|"
  4344. "\\(?:" (org-create-multibrace-regexp "(" ")" org-match-sexp-depth) "\\)"
  4345. "\\|"
  4346. "\\(?:\\*\\|[+-]?[[:alnum:].,\\]*[[:alnum:]]\\)\\)")
  4347. "The regular expression matching a sub- or superscript.")
  4348. (defconst org-match-substring-with-braces-regexp
  4349. (concat
  4350. "\\(\\S-\\)\\([_^]\\)"
  4351. "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)")
  4352. "The regular expression matching a sub- or superscript, forcing braces.")
  4353. (defvar org-emph-face nil)
  4354. (defun org-do-emphasis-faces (limit)
  4355. "Run through the buffer and emphasize strings."
  4356. (let ((quick-re (format "\\([%s]\\|^\\)\\([~=*/_+]\\)"
  4357. (car org-emphasis-regexp-components))))
  4358. (catch :exit
  4359. (while (re-search-forward quick-re limit t)
  4360. (let* ((marker (match-string 2))
  4361. (verbatim? (member marker '("~" "="))))
  4362. (when (save-excursion
  4363. (goto-char (match-beginning 0))
  4364. (and
  4365. ;; Do not match table hlines.
  4366. (not (and (equal marker "+")
  4367. (org-match-line
  4368. "[ \t]*\\(|[-+]+|?\\|\\+[-+]+\\+\\)[ \t]*$")))
  4369. ;; Do not match headline stars. Do not consider
  4370. ;; stars of a headline as closing marker for bold
  4371. ;; markup either.
  4372. (not (and (equal marker "*")
  4373. (save-excursion
  4374. (forward-char)
  4375. (skip-chars-backward "*")
  4376. (looking-at-p org-outline-regexp-bol))))
  4377. ;; Match full emphasis markup regexp.
  4378. (looking-at (if verbatim? org-verbatim-re org-emph-re))
  4379. ;; Do not span over paragraph boundaries.
  4380. (not (string-match-p org-element-paragraph-separate
  4381. (match-string 2)))
  4382. ;; Do not span over cells in table rows.
  4383. (not (and (save-match-data (org-match-line "[ \t]*|"))
  4384. (string-match-p "|" (match-string 4))))))
  4385. (pcase-let ((`(,_ ,face ,_) (assoc marker org-emphasis-alist))
  4386. (m (if org-hide-emphasis-markers 4 2)))
  4387. (font-lock-prepend-text-property
  4388. (match-beginning m) (match-end m) 'face face)
  4389. (when verbatim?
  4390. (org-remove-flyspell-overlays-in
  4391. (match-beginning 0) (match-end 0))
  4392. (when (and (org-fold-core-folding-spec-p 'org-link)
  4393. (org-fold-core-folding-spec-p 'org-link-description))
  4394. (org-fold-region (match-beginning 0) (match-end 0) nil 'org-link)
  4395. (org-fold-region (match-beginning 0) (match-end 0) nil 'org-link-description))
  4396. (remove-text-properties (match-beginning 2) (match-end 2)
  4397. '(display t invisible t intangible t)))
  4398. (add-text-properties (match-beginning 2) (match-end 2)
  4399. '(font-lock-multiline t org-emphasis t))
  4400. (when (and org-hide-emphasis-markers
  4401. (not (org-at-comment-p)))
  4402. (add-text-properties (match-end 4) (match-beginning 5)
  4403. '(invisible t))
  4404. (add-text-properties (match-beginning 3) (match-end 3)
  4405. '(invisible t)))
  4406. (throw :exit t))))))))
  4407. (defun org-emphasize (&optional char)
  4408. "Insert or change an emphasis, i.e. a font like bold or italic.
  4409. If there is an active region, change that region to a new emphasis.
  4410. If there is no region, just insert the marker characters and position
  4411. the cursor between them.
  4412. CHAR should be the marker character. If it is a space, it means to
  4413. remove the emphasis of the selected region.
  4414. If CHAR is not given (for example in an interactive call) it will be
  4415. prompted for."
  4416. (interactive)
  4417. (let ((erc org-emphasis-regexp-components)
  4418. (string "") beg end move s)
  4419. (if (org-region-active-p)
  4420. (setq beg (region-beginning)
  4421. end (region-end)
  4422. string (buffer-substring beg end))
  4423. (setq move t))
  4424. (unless char
  4425. (message "Emphasis marker or tag: [%s]"
  4426. (mapconcat #'car org-emphasis-alist ""))
  4427. (setq char (read-char-exclusive)))
  4428. (if (equal char ?\s)
  4429. (setq s ""
  4430. move nil)
  4431. (unless (assoc (char-to-string char) org-emphasis-alist)
  4432. (user-error "No such emphasis marker: \"%c\"" char))
  4433. (setq s (char-to-string char)))
  4434. (while (and (> (length string) 1)
  4435. (equal (substring string 0 1) (substring string -1))
  4436. (assoc (substring string 0 1) org-emphasis-alist))
  4437. (setq string (substring string 1 -1)))
  4438. (setq string (concat s string s))
  4439. (when beg (delete-region beg end))
  4440. (unless (or (bolp)
  4441. (string-match (concat "[" (nth 0 erc) "\n]")
  4442. (char-to-string (char-before (point)))))
  4443. (insert " "))
  4444. (unless (or (eobp)
  4445. (string-match (concat "[" (nth 1 erc) "\n]")
  4446. (char-to-string (char-after (point)))))
  4447. (insert " ") (backward-char 1))
  4448. (insert string)
  4449. (and move (backward-char 1))))
  4450. (defconst org-nonsticky-props
  4451. '(mouse-face highlight keymap invisible intangible help-echo org-linked-text htmlize-link))
  4452. (defsubst org-rear-nonsticky-at (pos)
  4453. (add-text-properties (1- pos) pos (list 'rear-nonsticky org-nonsticky-props)))
  4454. (defun org-activate-links--overlays (limit)
  4455. "Add link properties to links.
  4456. This includes angle, plain, and bracket links."
  4457. (catch :exit
  4458. (while (re-search-forward org-link-any-re limit t)
  4459. (let* ((start (match-beginning 0))
  4460. (end (match-end 0))
  4461. (visible-start (or (match-beginning 3) (match-beginning 2)))
  4462. (visible-end (or (match-end 3) (match-end 2)))
  4463. (style (cond ((eq ?< (char-after start)) 'angle)
  4464. ((eq ?\[ (char-after (1+ start))) 'bracket)
  4465. (t 'plain))))
  4466. (when (and (memq style org-highlight-links)
  4467. ;; Do not span over paragraph boundaries.
  4468. (not (string-match-p org-element-paragraph-separate
  4469. (match-string 0)))
  4470. ;; Do not confuse plain links with tags.
  4471. (not (and (eq style 'plain)
  4472. (let ((face (get-text-property
  4473. (max (1- start) (point-min)) 'face)))
  4474. (if (consp face) (memq 'org-tag face)
  4475. (eq 'org-tag face))))))
  4476. (let* ((link-object (save-excursion
  4477. (goto-char start)
  4478. (save-match-data (org-element-link-parser))))
  4479. (link (org-element-property :raw-link link-object))
  4480. (type (org-element-property :type link-object))
  4481. (path (org-element-property :path link-object))
  4482. (face-property (pcase (org-link-get-parameter type :face)
  4483. ((and (pred functionp) face) (funcall face path))
  4484. ((and (pred facep) face) face)
  4485. ((and (pred consp) face) face) ;anonymous
  4486. (_ 'org-link)))
  4487. (properties ;for link's visible part
  4488. (list 'mouse-face (or (org-link-get-parameter type :mouse-face)
  4489. 'highlight)
  4490. 'keymap (or (org-link-get-parameter type :keymap)
  4491. org-mouse-map)
  4492. 'help-echo (pcase (org-link-get-parameter type :help-echo)
  4493. ((and (pred stringp) echo) echo)
  4494. ((and (pred functionp) echo) echo)
  4495. (_ (concat "LINK: " link)))
  4496. 'htmlize-link (pcase (org-link-get-parameter type
  4497. :htmlize-link)
  4498. ((and (pred functionp) f) (funcall f))
  4499. (_ `(:uri ,link)))
  4500. 'font-lock-multiline t)))
  4501. (org-remove-flyspell-overlays-in start end)
  4502. (org-rear-nonsticky-at end)
  4503. (if (not (eq 'bracket style))
  4504. (progn
  4505. (add-face-text-property start end face-property)
  4506. (add-text-properties start end properties))
  4507. ;; Handle invisible parts in bracket links.
  4508. (remove-text-properties start end '(invisible nil))
  4509. (let ((hidden
  4510. (append `(invisible
  4511. ,(or (org-link-get-parameter type :display)
  4512. 'org-link))
  4513. properties)))
  4514. (add-text-properties start visible-start hidden)
  4515. (add-face-text-property start end face-property)
  4516. (add-text-properties visible-start visible-end properties)
  4517. (add-text-properties visible-end end hidden)
  4518. (org-rear-nonsticky-at visible-start)
  4519. (org-rear-nonsticky-at visible-end)))
  4520. (let ((f (org-link-get-parameter type :activate-func)))
  4521. (when (functionp f)
  4522. (funcall f start end path (eq style 'bracket))))
  4523. (throw :exit t))))) ;signal success
  4524. nil))
  4525. (defun org-activate-links--text-properties (limit)
  4526. "Add link properties to links.
  4527. This includes angle, plain, and bracket links."
  4528. (catch :exit
  4529. (while (re-search-forward org-link-any-re limit t)
  4530. (let* ((start (match-beginning 0))
  4531. (end (match-end 0))
  4532. (visible-start (or (match-beginning 3) (match-beginning 2)))
  4533. (visible-end (or (match-end 3) (match-end 2)))
  4534. (style (cond ((eq ?< (char-after start)) 'angle)
  4535. ((eq ?\[ (char-after (1+ start))) 'bracket)
  4536. (t 'plain))))
  4537. (when (and (memq style org-highlight-links)
  4538. ;; Do not span over paragraph boundaries.
  4539. (not (string-match-p org-element-paragraph-separate
  4540. (match-string 0)))
  4541. ;; Do not confuse plain links with tags.
  4542. (not (and (eq style 'plain)
  4543. (let ((face (get-text-property
  4544. (max (1- start) (point-min)) 'face)))
  4545. (if (consp face) (memq 'org-tag face)
  4546. (eq 'org-tag face))))))
  4547. (let* ((link-object (save-excursion
  4548. (goto-char start)
  4549. (save-match-data (org-element-link-parser))))
  4550. (link (org-element-property :raw-link link-object))
  4551. (type (org-element-property :type link-object))
  4552. (path (org-element-property :path link-object))
  4553. (face-property (pcase (org-link-get-parameter type :face)
  4554. ((and (pred functionp) face) (funcall face path))
  4555. ((and (pred facep) face) face)
  4556. ((and (pred consp) face) face) ;anonymous
  4557. (_ 'org-link)))
  4558. (properties ;for link's visible part
  4559. (list 'mouse-face (or (org-link-get-parameter type :mouse-face)
  4560. 'highlight)
  4561. 'keymap (or (org-link-get-parameter type :keymap)
  4562. org-mouse-map)
  4563. 'help-echo (pcase (org-link-get-parameter type :help-echo)
  4564. ((and (pred stringp) echo) echo)
  4565. ((and (pred functionp) echo) echo)
  4566. (_ (concat "LINK: " link)))
  4567. 'htmlize-link (pcase (org-link-get-parameter type
  4568. :htmlize-link)
  4569. ((and (pred functionp) f) (funcall f))
  4570. (_ `(:uri ,link)))
  4571. 'font-lock-multiline t)))
  4572. (org-remove-flyspell-overlays-in start end)
  4573. (org-rear-nonsticky-at end)
  4574. (if (not (eq 'bracket style))
  4575. (progn
  4576. (add-face-text-property start end face-property)
  4577. (add-text-properties start end properties))
  4578. ;; Initialise folding when used outside org-mode.
  4579. (unless (or (derived-mode-p 'org-mode)
  4580. (and (org-fold-folding-spec-p 'org-link-description)
  4581. (org-fold-folding-spec-p 'org-link)))
  4582. (org-fold-initialize (or (and (stringp org-ellipsis) (not (equal "" org-ellipsis)) org-ellipsis)
  4583. "...")))
  4584. ;; Handle invisible parts in bracket links.
  4585. (let ((spec (or (org-link-get-parameter type :display)
  4586. 'org-link)))
  4587. (unless (org-fold-folding-spec-p spec)
  4588. (org-fold-add-folding-spec spec
  4589. (cdr org-link--link-folding-spec)
  4590. nil
  4591. 'append)
  4592. (org-fold-core-set-folding-spec-property spec :visible t))
  4593. (org-fold-region start end nil 'org-link)
  4594. (org-fold-region start end nil 'org-link-description)
  4595. ;; We are folding the whole emphasised text with SPEC
  4596. ;; first. It makes everything invisible (or whatever
  4597. ;; the user wants).
  4598. (org-fold-region start end t spec)
  4599. ;; The visible part of the text is folded using
  4600. ;; 'org-link-description, which is forcing this part of
  4601. ;; the text to be visible.
  4602. (org-fold-region visible-start visible-end t 'org-link-description)
  4603. (add-text-properties start end properties)
  4604. (add-face-text-property start end face-property)
  4605. (org-rear-nonsticky-at visible-start)
  4606. (org-rear-nonsticky-at visible-end)))
  4607. (let ((f (org-link-get-parameter type :activate-func)))
  4608. (when (functionp f)
  4609. (funcall f start end path (eq style 'bracket))))
  4610. (throw :exit t))))) ;signal success
  4611. nil))
  4612. (defsubst org-activate-links (limit)
  4613. "Add link properties to links.
  4614. This includes angle, plain, and bracket links."
  4615. (if (eq org-fold-core-style 'text-properties)
  4616. (org-activate-links--text-properties limit)
  4617. (org-activate-links--overlays limit)))
  4618. (defun org-activate-code (limit)
  4619. (when (re-search-forward "^[ \t]*\\(:\\(?: .*\\|$\\)\n?\\)" limit t)
  4620. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4621. (remove-text-properties (match-beginning 0) (match-end 0)
  4622. '(display t invisible t intangible t))
  4623. t))
  4624. (defcustom org-src-fontify-natively t
  4625. "When non-nil, fontify code in code blocks.
  4626. See also the `org-block' face."
  4627. :type 'boolean
  4628. :version "26.1"
  4629. :package-version '(Org . "8.3")
  4630. :group 'org-appearance
  4631. :group 'org-babel)
  4632. (defcustom org-allow-promoting-top-level-subtree nil
  4633. "When non-nil, allow promoting a top level subtree.
  4634. The leading star of the top level headline will be replaced
  4635. by a #."
  4636. :type 'boolean
  4637. :version "24.1"
  4638. :group 'org-appearance)
  4639. (defun org-fontify-meta-lines-and-blocks (limit)
  4640. (condition-case nil
  4641. (org-fontify-meta-lines-and-blocks-1 limit)
  4642. (error (message "Org mode fontification error in %S at %d"
  4643. (current-buffer)
  4644. (line-number-at-pos)))))
  4645. (defun org-fontify-meta-lines-and-blocks-1 (limit)
  4646. "Fontify #+ lines and blocks."
  4647. (let ((case-fold-search t))
  4648. (when (re-search-forward
  4649. (rx bol (group (zero-or-more (any " \t")) "#"
  4650. (group (group (or (seq "+" (one-or-more (any "a-zA-Z")) (optional ":"))
  4651. (any " \t")
  4652. eol))
  4653. (optional (group "_" (group (one-or-more (any "a-zA-Z"))))))
  4654. (zero-or-more (any " \t"))
  4655. (group (group (zero-or-more (not (any " \t\n"))))
  4656. (zero-or-more (any " \t"))
  4657. (group (zero-or-more any)))))
  4658. limit t)
  4659. (let ((beg (match-beginning 0))
  4660. (end-of-beginline (match-end 0))
  4661. ;; Including \n at end of #+begin line will include \n
  4662. ;; after the end of block content.
  4663. (block-start (match-end 0))
  4664. (block-end nil)
  4665. (lang (match-string 7)) ; The language, if it is a source block.
  4666. (bol-after-beginline (line-beginning-position 2))
  4667. (dc1 (downcase (match-string 2)))
  4668. (dc3 (downcase (match-string 3)))
  4669. (whole-blockline org-fontify-whole-block-delimiter-line)
  4670. beg-of-endline end-of-endline nl-before-endline quoting block-type)
  4671. (cond
  4672. ((and (match-end 4) (equal dc3 "+begin"))
  4673. ;; Truly a block
  4674. (setq block-type (downcase (match-string 5))
  4675. ;; Src, example, export, maybe more.
  4676. quoting (member block-type org-protecting-blocks))
  4677. (when (re-search-forward
  4678. (rx-to-string `(group bol (or (seq (one-or-more "*") space)
  4679. (seq (zero-or-more (any " \t"))
  4680. "#+end"
  4681. ,(match-string 4)
  4682. word-end
  4683. (zero-or-more any)))))
  4684. ;; We look further than LIMIT on purpose.
  4685. nil t)
  4686. ;; We do have a matching #+end line.
  4687. (setq beg-of-endline (match-beginning 0)
  4688. end-of-endline (match-end 0)
  4689. nl-before-endline (1- (match-beginning 0)))
  4690. (setq block-end (match-beginning 0)) ; Include the final newline.
  4691. (when quoting
  4692. (org-remove-flyspell-overlays-in bol-after-beginline nl-before-endline)
  4693. (remove-text-properties beg end-of-endline
  4694. '(display t invisible t intangible t)))
  4695. (add-text-properties
  4696. beg end-of-endline '(font-lock-fontified t font-lock-multiline t))
  4697. (org-remove-flyspell-overlays-in beg bol-after-beginline)
  4698. (org-remove-flyspell-overlays-in nl-before-endline end-of-endline)
  4699. (cond
  4700. ((and lang (not (string= lang "")) org-src-fontify-natively)
  4701. (save-match-data
  4702. (org-src-font-lock-fontify-block lang block-start block-end))
  4703. (add-text-properties bol-after-beginline block-end '(src-block t)))
  4704. (quoting
  4705. (add-text-properties
  4706. bol-after-beginline beg-of-endline
  4707. (list 'face
  4708. (list :inherit
  4709. (let ((face-name
  4710. (intern (format "org-block-%s" lang))))
  4711. (append (and (facep face-name) (list face-name))
  4712. '(org-block)))))))
  4713. ((not org-fontify-quote-and-verse-blocks))
  4714. ((string= block-type "quote")
  4715. (add-face-text-property
  4716. bol-after-beginline beg-of-endline 'org-quote t))
  4717. ((string= block-type "verse")
  4718. (add-face-text-property
  4719. bol-after-beginline beg-of-endline 'org-verse t)))
  4720. ;; Fontify the #+begin and #+end lines of the blocks
  4721. (add-text-properties
  4722. beg (if whole-blockline bol-after-beginline end-of-beginline)
  4723. '(face org-block-begin-line))
  4724. (unless (eq (char-after beg-of-endline) ?*)
  4725. (add-text-properties
  4726. beg-of-endline
  4727. (if whole-blockline
  4728. (let ((beg-of-next-line (1+ end-of-endline)))
  4729. (min (point-max) beg-of-next-line))
  4730. (min (point-max) end-of-endline))
  4731. '(face org-block-end-line)))
  4732. t))
  4733. ((member dc1 '("+title:" "+subtitle:" "+author:" "+email:" "+date:"))
  4734. (org-remove-flyspell-overlays-in
  4735. (match-beginning 0)
  4736. (if (equal "+title:" dc1) (match-end 2) (match-end 0)))
  4737. (add-text-properties
  4738. beg (match-end 3)
  4739. (if (member (intern (substring dc1 1 -1)) org-hidden-keywords)
  4740. '(font-lock-fontified t invisible t)
  4741. '(font-lock-fontified t face org-document-info-keyword)))
  4742. (add-text-properties
  4743. (match-beginning 6) (min (point-max) (1+ (match-end 6)))
  4744. (if (string-equal dc1 "+title:")
  4745. '(font-lock-fontified t face org-document-title)
  4746. '(font-lock-fontified t face org-document-info))))
  4747. ((string-prefix-p "+caption" dc1)
  4748. (org-remove-flyspell-overlays-in (match-end 2) (match-end 0))
  4749. (remove-text-properties (match-beginning 0) (match-end 0)
  4750. '(display t invisible t intangible t))
  4751. ;; Handle short captions
  4752. (save-excursion
  4753. (beginning-of-line)
  4754. (looking-at (rx (group (zero-or-more (any " \t"))
  4755. "#+caption"
  4756. (optional "[" (zero-or-more any) "]")
  4757. ":")
  4758. (zero-or-more (any " \t")))))
  4759. (add-text-properties (line-beginning-position) (match-end 1)
  4760. '(font-lock-fontified t face org-meta-line))
  4761. (add-text-properties (match-end 0) (line-end-position)
  4762. '(font-lock-fontified t face org-block))
  4763. t)
  4764. ((member dc3 '(" " ""))
  4765. ;; Just a comment, the plus was not there
  4766. (org-remove-flyspell-overlays-in beg (match-end 0))
  4767. (add-text-properties
  4768. beg (match-end 0)
  4769. '(font-lock-fontified t face font-lock-comment-face)))
  4770. (t ;; Just any other in-buffer setting, but not indented
  4771. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4772. (remove-text-properties (match-beginning 0) (match-end 0)
  4773. '(display t invisible t intangible t))
  4774. (add-text-properties beg (match-end 0)
  4775. '(font-lock-fontified t face org-meta-line))
  4776. t))))))
  4777. (defun org-fontify-drawers (limit)
  4778. "Fontify drawers."
  4779. (when (re-search-forward org-drawer-regexp limit t)
  4780. (add-text-properties (1- (match-beginning 1)) (1+ (match-end 1))
  4781. '(font-lock-fontified t face org-drawer))
  4782. (org-remove-flyspell-overlays-in
  4783. (line-beginning-position) (line-beginning-position 2))
  4784. t))
  4785. (defun org-fontify-macros (limit)
  4786. "Fontify macros."
  4787. (when (re-search-forward "{{{\\([a-zA-Z][-a-zA-Z0-9_]*\\)" limit t)
  4788. (let ((begin (match-beginning 0))
  4789. (opening-end (match-beginning 1)))
  4790. (when (and (re-search-forward "\n[ \t]*\n\\|\\(}}}\\)" limit t)
  4791. (match-string 1))
  4792. (let ((end (match-end 1))
  4793. (closing-start (match-beginning 1)))
  4794. (add-text-properties
  4795. begin end
  4796. '(font-lock-multiline t font-lock-fontified t face org-macro))
  4797. (org-remove-flyspell-overlays-in begin end)
  4798. (when org-hide-macro-markers
  4799. (add-text-properties begin opening-end '(invisible t))
  4800. (add-text-properties closing-start end '(invisible t)))
  4801. t)))))
  4802. (defun org-fontify-extend-region (beg end _old-len)
  4803. (let ((end (if (progn (goto-char end) (looking-at-p "^[*#]"))
  4804. (1+ end) end))
  4805. (begin-re "\\(\\\\\\[\\|\\(#\\+begin_\\|\\\\begin{\\)\\S-+\\)")
  4806. (end-re "\\(\\\\\\]\\|\\(#\\+end_\\|\\\\end{\\)\\S-+\\)")
  4807. (extend
  4808. (lambda (r1 r2 dir)
  4809. (let ((re (replace-regexp-in-string
  4810. "\\(begin\\|end\\)" r1
  4811. (replace-regexp-in-string
  4812. "[][]" r2
  4813. (match-string-no-properties 0)))))
  4814. (re-search-forward (regexp-quote re) nil t dir)))))
  4815. (goto-char beg)
  4816. (back-to-indentation)
  4817. (save-match-data
  4818. (cond ((looking-at end-re)
  4819. (cons (or (funcall extend "begin" "[" -1) beg) end))
  4820. ((looking-at begin-re)
  4821. (cons beg (or (funcall extend "end" "]" 1) end)))
  4822. (t (cons beg end))))))
  4823. (defun org-activate-footnote-links (limit)
  4824. "Add text properties for footnotes."
  4825. (let ((fn (org-footnote-next-reference-or-definition limit)))
  4826. (when fn
  4827. (let* ((beg (nth 1 fn))
  4828. (end (nth 2 fn))
  4829. (label (car fn))
  4830. (referencep (/= (line-beginning-position) beg)))
  4831. (when (and referencep (nth 3 fn))
  4832. (save-excursion
  4833. (goto-char beg)
  4834. (search-forward (or label "fn:"))
  4835. (org-remove-flyspell-overlays-in beg (match-end 0))))
  4836. (add-text-properties beg end
  4837. (list 'mouse-face 'highlight
  4838. 'keymap org-mouse-map
  4839. 'help-echo
  4840. (if referencep "Footnote reference"
  4841. "Footnote definition")
  4842. 'font-lock-fontified t
  4843. 'font-lock-multiline t
  4844. 'face 'org-footnote))))))
  4845. (defun org-activate-dates (limit)
  4846. "Add text properties for dates."
  4847. (when (and (re-search-forward org-tsr-regexp-both limit t)
  4848. (not (equal (char-before (match-beginning 0)) 91)))
  4849. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4850. (add-text-properties (match-beginning 0) (match-end 0)
  4851. (list 'mouse-face 'highlight
  4852. 'keymap org-mouse-map))
  4853. (org-rear-nonsticky-at (match-end 0))
  4854. (when org-display-custom-times
  4855. ;; If it's a date range, activate custom time for second date.
  4856. (when (match-end 3)
  4857. (org-display-custom-time (match-beginning 3) (match-end 3)))
  4858. (org-display-custom-time (match-beginning 1) (match-end 1)))
  4859. t))
  4860. (defun org-activate-target-links (limit)
  4861. "Add text properties for target matches."
  4862. (when org-target-link-regexp
  4863. (let ((case-fold-search t))
  4864. ;; `org-target-link-regexp' matches one character before the
  4865. ;; actual target.
  4866. (unless (bolp) (forward-char -1))
  4867. (when (re-search-forward org-target-link-regexp limit t)
  4868. (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
  4869. (add-text-properties (match-beginning 1) (match-end 1)
  4870. (list 'mouse-face 'highlight
  4871. 'keymap org-mouse-map
  4872. 'help-echo "Radio target link"
  4873. 'org-linked-text t))
  4874. (org-rear-nonsticky-at (match-end 1))
  4875. t))))
  4876. (defvar org-latex-and-related-regexp nil
  4877. "Regular expression for highlighting LaTeX, entities and sub/superscript.")
  4878. (defun org-compute-latex-and-related-regexp ()
  4879. "Compute regular expression for LaTeX, entities and sub/superscript.
  4880. Result depends on variable `org-highlight-latex-and-related'."
  4881. (let ((re-sub
  4882. (cond ((not (memq 'script org-highlight-latex-and-related)) nil)
  4883. ((eq org-use-sub-superscripts '{})
  4884. (list org-match-substring-with-braces-regexp))
  4885. (org-use-sub-superscripts (list org-match-substring-regexp))))
  4886. (re-latex
  4887. (when (or (memq 'latex org-highlight-latex-and-related)
  4888. (memq 'native org-highlight-latex-and-related))
  4889. (let ((matchers (plist-get org-format-latex-options :matchers)))
  4890. (delq nil
  4891. (mapcar (lambda (x)
  4892. (and (member (car x) matchers) (nth 1 x)))
  4893. org-latex-regexps)))))
  4894. (re-entities
  4895. (when (memq 'entities org-highlight-latex-and-related)
  4896. (list "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\
  4897. \\($\\|{}\\|[^[:alpha:]]\\)"))))
  4898. (setq-local org-latex-and-related-regexp
  4899. (mapconcat #'identity
  4900. (append re-latex re-entities re-sub)
  4901. "\\|"))))
  4902. (defun org-do-latex-and-related (limit)
  4903. "Highlight LaTeX snippets and environments, entities and sub/superscript.
  4904. Stop at first highlighted object, if any. Return t if some
  4905. highlighting was done, nil otherwise."
  4906. (when (org-string-nw-p org-latex-and-related-regexp)
  4907. (let ((latex-prefix-re (rx (or "$" "\\(" "\\[")))
  4908. (blank-line-re (rx (and "\n" (zero-or-more (or " " "\t")) "\n"))))
  4909. (catch 'found
  4910. (while (and (< (point) limit)
  4911. (re-search-forward org-latex-and-related-regexp nil t))
  4912. (cond
  4913. ((>= (match-beginning 0) limit)
  4914. (throw 'found nil))
  4915. ((cl-some (lambda (f)
  4916. (memq f '(org-code org-verbatim underline
  4917. org-special-keyword)))
  4918. (save-excursion
  4919. (goto-char (1+ (match-beginning 0)))
  4920. (face-at-point nil t))))
  4921. ;; Try to limit false positives. In this case, ignore
  4922. ;; $$...$$, \(...\), and \[...\] LaTeX constructs if they
  4923. ;; contain an empty line.
  4924. ((save-excursion
  4925. (goto-char (match-beginning 0))
  4926. (and (looking-at-p latex-prefix-re)
  4927. (save-match-data
  4928. (re-search-forward blank-line-re (1- (match-end 0)) t)))))
  4929. (t
  4930. (let* ((offset (if (memq (char-after (1+ (match-beginning 0)))
  4931. '(?_ ?^))
  4932. 1
  4933. 0))
  4934. (start (+ offset (match-beginning 0)))
  4935. (end (match-end 0)))
  4936. (if (memq 'native org-highlight-latex-and-related)
  4937. (org-src-font-lock-fontify-block "latex" start end)
  4938. (font-lock-prepend-text-property start end
  4939. 'face 'org-latex-and-related))
  4940. (add-text-properties (+ offset (match-beginning 0)) (match-end 0)
  4941. '(font-lock-multiline t))
  4942. (throw 'found t)))))
  4943. nil))))
  4944. (defun org-restart-font-lock ()
  4945. "Restart `font-lock-mode', to force refontification."
  4946. (when font-lock-mode
  4947. (font-lock-mode -1)
  4948. (font-lock-mode 1)))
  4949. (defun org-activate-tags (limit)
  4950. (when (re-search-forward org-tag-line-re limit t)
  4951. (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
  4952. (add-text-properties (match-beginning 1) (match-end 1)
  4953. (list 'mouse-face 'highlight
  4954. 'keymap org-mouse-map))
  4955. (org-rear-nonsticky-at (match-end 1))
  4956. t))
  4957. (defun org-outline-level ()
  4958. "Compute the outline level of the heading at point.
  4959. If this is called at a normal headline, the level is the number
  4960. of stars. Use `org-reduced-level' to remove the effect of
  4961. `org-odd-levels'. Unlike to `org-current-level', this function
  4962. takes into consideration inlinetasks."
  4963. (org-with-wide-buffer
  4964. (end-of-line)
  4965. (if (re-search-backward org-outline-regexp-bol nil t)
  4966. (1- (- (match-end 0) (match-beginning 0)))
  4967. 0)))
  4968. (defvar org-font-lock-keywords nil)
  4969. (defsubst org-re-property (property &optional literal allow-null value)
  4970. "Return a regexp matching a PROPERTY line.
  4971. When optional argument LITERAL is non-nil, do not quote PROPERTY.
  4972. This is useful when PROPERTY is a regexp. When ALLOW-NULL is
  4973. non-nil, match properties even without a value.
  4974. Match group 3 is set to the value when it exists. If there is no
  4975. value and ALLOW-NULL is non-nil, it is set to the empty string.
  4976. With optional argument VALUE, match only property lines with
  4977. that value; in this case, ALLOW-NULL is ignored. VALUE is quoted
  4978. unless LITERAL is non-nil."
  4979. (concat
  4980. "^\\(?4:[ \t]*\\)"
  4981. (format "\\(?1::\\(?2:%s\\):\\)"
  4982. (if literal property (regexp-quote property)))
  4983. (cond (value
  4984. (format "[ \t]+\\(?3:%s\\)\\(?5:[ \t]*\\)$"
  4985. (if literal value (regexp-quote value))))
  4986. (allow-null
  4987. "\\(?:\\(?3:$\\)\\|[ \t]+\\(?3:.*?\\)\\)\\(?5:[ \t]*\\)$")
  4988. (t
  4989. "[ \t]+\\(?3:[^ \r\t\n]+.*?\\)\\(?5:[ \t]*\\)$"))))
  4990. (defconst org-property-re
  4991. (org-re-property "\\S-+" 'literal t)
  4992. "Regular expression matching a property line.
  4993. There are four matching groups:
  4994. 1: :PROPKEY: including the leading and trailing colon,
  4995. 2: PROPKEY without the leading and trailing colon,
  4996. 3: PROPVAL without leading or trailing spaces,
  4997. 4: the indentation of the current line,
  4998. 5: trailing whitespace.")
  4999. (defvar org-font-lock-hook nil
  5000. "Functions to be called for special font lock stuff.")
  5001. (defvar org-font-lock-extra-keywords nil) ;Dynamically scoped.
  5002. (defvar org-font-lock-set-keywords-hook nil
  5003. "Functions that can manipulate `org-font-lock-extra-keywords'.
  5004. This is called after `org-font-lock-extra-keywords' is defined, but before
  5005. it is installed to be used by font lock. This can be useful if something
  5006. needs to be inserted at a specific position in the font-lock sequence.")
  5007. (defun org-font-lock-hook (limit)
  5008. "Run `org-font-lock-hook' within LIMIT."
  5009. (run-hook-with-args 'org-font-lock-hook limit))
  5010. (defun org-set-font-lock-defaults ()
  5011. "Set font lock defaults for the current buffer."
  5012. (let ((org-font-lock-extra-keywords
  5013. (list
  5014. ;; Call the hook
  5015. '(org-font-lock-hook)
  5016. ;; Headlines
  5017. `(,(if org-fontify-whole-heading-line
  5018. "^\\(\\**\\)\\(\\* \\)\\(.*\n?\\)"
  5019. "^\\(\\**\\)\\(\\* \\)\\(.*\\)")
  5020. (1 (org-get-level-face 1))
  5021. (2 (org-get-level-face 2))
  5022. (3 (org-get-level-face 3)))
  5023. ;; Table lines
  5024. '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
  5025. (1 'org-table t))
  5026. ;; Table internals
  5027. '("^[ \t]*|\\(?:.*?|\\)? *\\(:?=[^|\n]*\\)" (1 'org-formula t))
  5028. '("^[ \t]*| *\\([#*]\\) *|" (1 'org-formula t))
  5029. '("^[ \t]*|\\( *\\([$!_^/]\\) *|.*\\)|" (1 'org-formula t))
  5030. '("| *\\(<[lrc]?[0-9]*>\\)" (1 'org-formula t))
  5031. ;; Properties
  5032. (list org-property-re
  5033. '(1 'org-special-keyword t)
  5034. '(3 'org-property-value t))
  5035. ;; Drawers
  5036. '(org-fontify-drawers)
  5037. ;; Link related fontification.
  5038. '(org-activate-links)
  5039. (when (memq 'tag org-highlight-links) '(org-activate-tags (1 'org-tag prepend)))
  5040. (when (memq 'radio org-highlight-links) '(org-activate-target-links (1 'org-link t)))
  5041. (when (memq 'date org-highlight-links) '(org-activate-dates (0 'org-date t)))
  5042. (when (memq 'footnote org-highlight-links) '(org-activate-footnote-links))
  5043. ;; Targets.
  5044. (list org-radio-target-regexp '(0 'org-target t))
  5045. (list org-target-regexp '(0 'org-target t))
  5046. ;; Diary sexps.
  5047. '("^&?%%(.*\\|<%%([^>\n]*?>" (0 'org-sexp-date t))
  5048. ;; Macro
  5049. '(org-fontify-macros)
  5050. ;; TODO keyword
  5051. (list (format org-heading-keyword-regexp-format
  5052. org-todo-regexp)
  5053. '(2 (org-get-todo-face 2) prepend))
  5054. ;; TODO
  5055. (when org-fontify-todo-headline
  5056. (list (format org-heading-keyword-regexp-format
  5057. (concat
  5058. "\\(?:"
  5059. (mapconcat 'regexp-quote org-not-done-keywords "\\|")
  5060. "\\)"))
  5061. '(2 'org-headline-todo prepend)))
  5062. ;; DONE
  5063. (when org-fontify-done-headline
  5064. (list (format org-heading-keyword-regexp-format
  5065. (concat
  5066. "\\(?:"
  5067. (mapconcat 'regexp-quote org-done-keywords "\\|")
  5068. "\\)"))
  5069. '(2 'org-headline-done prepend)))
  5070. ;; Priorities
  5071. '(org-font-lock-add-priority-faces)
  5072. ;; Tags
  5073. '(org-font-lock-add-tag-faces)
  5074. ;; Tags groups
  5075. (when (and org-group-tags org-tag-groups-alist)
  5076. (list (concat org-outline-regexp-bol ".+\\(:"
  5077. (regexp-opt (mapcar 'car org-tag-groups-alist))
  5078. ":\\).*$")
  5079. '(1 'org-tag-group prepend)))
  5080. ;; Special keywords
  5081. (list (concat "\\<" org-deadline-string) '(0 'org-special-keyword t))
  5082. (list (concat "\\<" org-scheduled-string) '(0 'org-special-keyword t))
  5083. (list (concat "\\<" org-closed-string) '(0 'org-special-keyword t))
  5084. (list (concat "\\<" org-clock-string) '(0 'org-special-keyword t))
  5085. ;; Emphasis
  5086. (when org-fontify-emphasized-text '(org-do-emphasis-faces))
  5087. ;; Checkboxes
  5088. '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
  5089. 1 'org-checkbox prepend)
  5090. (when (cdr (assq 'checkbox org-list-automatic-rules))
  5091. '("\\[\\([0-9]*%\\)\\]\\|\\[\\([0-9]*\\)/\\([0-9]*\\)\\]"
  5092. (0 (org-get-checkbox-statistics-face) prepend)))
  5093. ;; Description list items
  5094. '("\\(?:^[ \t]*[-+]\\|^[ \t]+[*]\\)[ \t]+\\(.*?[ \t]+::\\)\\([ \t]+\\|$\\)"
  5095. 1 'org-list-dt prepend)
  5096. ;; Inline export snippets
  5097. '("\\(@@\\)\\([a-z-]+:\\).*?\\(@@\\)"
  5098. (1 'font-lock-comment-face t)
  5099. (2 'org-tag t)
  5100. (3 'font-lock-comment-face t))
  5101. ;; ARCHIVEd headings
  5102. (list (concat
  5103. org-outline-regexp-bol
  5104. "\\(.*:" org-archive-tag ":.*\\)")
  5105. '(1 'org-archived prepend))
  5106. ;; Specials
  5107. '(org-do-latex-and-related)
  5108. '(org-fontify-entities)
  5109. '(org-raise-scripts)
  5110. ;; Code
  5111. '(org-activate-code (1 'org-code t))
  5112. ;; COMMENT
  5113. (list (format
  5114. "^\\*+\\(?: +%s\\)?\\(?: +\\[#[A-Z0-9]\\]\\)? +\\(?9:%s\\)\\(?: \\|$\\)"
  5115. org-todo-regexp
  5116. org-comment-string)
  5117. '(9 'org-special-keyword t))
  5118. ;; Blocks and meta lines
  5119. '(org-fontify-meta-lines-and-blocks)
  5120. '(org-fontify-inline-src-blocks)
  5121. ;; Citations. When an activate processor is specified, if
  5122. ;; specified, try loading it beforehand.
  5123. (progn
  5124. (unless (null org-cite-activate-processor)
  5125. (org-cite-try-load-processor org-cite-activate-processor))
  5126. '(org-cite-activate)))))
  5127. (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
  5128. (run-hooks 'org-font-lock-set-keywords-hook)
  5129. ;; Now set the full font-lock-keywords
  5130. (setq-local org-font-lock-keywords org-font-lock-extra-keywords)
  5131. (setq-local font-lock-defaults
  5132. '(org-font-lock-keywords t nil nil backward-paragraph))
  5133. (setq-local font-lock-extend-after-change-region-function
  5134. #'org-fontify-extend-region)
  5135. (kill-local-variable 'font-lock-keywords)
  5136. nil))
  5137. (defun org-toggle-pretty-entities ()
  5138. "Toggle the composition display of entities as UTF8 characters."
  5139. (interactive)
  5140. (setq-local org-pretty-entities (not org-pretty-entities))
  5141. (org-restart-font-lock)
  5142. (if org-pretty-entities
  5143. (message "Entities are now displayed as UTF8 characters")
  5144. (save-restriction
  5145. (widen)
  5146. (decompose-region (point-min) (point-max))
  5147. (message "Entities are now displayed as plain text"))))
  5148. (defvar-local org-custom-properties-overlays nil
  5149. "List of overlays used for custom properties.")
  5150. (defun org-toggle-custom-properties-visibility ()
  5151. "Display or hide properties in `org-custom-properties'."
  5152. (interactive)
  5153. (if org-custom-properties-overlays
  5154. (progn (mapc #'delete-overlay org-custom-properties-overlays)
  5155. (setq org-custom-properties-overlays nil))
  5156. (when org-custom-properties
  5157. (org-with-wide-buffer
  5158. (goto-char (point-min))
  5159. (let ((regexp (org-re-property (regexp-opt org-custom-properties) t t)))
  5160. (while (re-search-forward regexp nil t)
  5161. (let ((end (cdr (save-match-data (org-get-property-block)))))
  5162. (when (and end (< (point) end))
  5163. ;; Hide first custom property in current drawer.
  5164. (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
  5165. (overlay-put o 'invisible t)
  5166. (overlay-put o 'org-custom-property t)
  5167. (push o org-custom-properties-overlays))
  5168. ;; Hide additional custom properties in the same drawer.
  5169. (while (re-search-forward regexp end t)
  5170. (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
  5171. (overlay-put o 'invisible t)
  5172. (overlay-put o 'org-custom-property t)
  5173. (push o org-custom-properties-overlays)))))
  5174. ;; Each entry is limited to a single property drawer.
  5175. (outline-next-heading)))))))
  5176. (defun org-fontify-entities (limit)
  5177. "Find an entity to fontify."
  5178. (let (ee)
  5179. (when org-pretty-entities
  5180. (catch 'match
  5181. ;; "\_ "-family is left out on purpose. Only the first one,
  5182. ;; i.e., "\_ ", could be fontified anyway, and it would be
  5183. ;; confusing when adding a second white space character.
  5184. (while (re-search-forward
  5185. "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]\n]\\)"
  5186. limit t)
  5187. (when (and (not (org-at-comment-p))
  5188. (setq ee (org-entity-get (match-string 1)))
  5189. (= (length (nth 6 ee)) 1))
  5190. (let* ((end (if (equal (match-string 2) "{}")
  5191. (match-end 2)
  5192. (match-end 1))))
  5193. (add-text-properties
  5194. (match-beginning 0) end
  5195. (list 'font-lock-fontified t))
  5196. (compose-region (match-beginning 0) end
  5197. (nth 6 ee) nil)
  5198. (backward-char 1)
  5199. (throw 'match t))))
  5200. nil))))
  5201. (defun org-fontify-like-in-org-mode (s &optional odd-levels)
  5202. "Fontify string S like in Org mode."
  5203. (with-temp-buffer
  5204. (insert s)
  5205. (let ((org-odd-levels-only odd-levels))
  5206. (org-mode)
  5207. (font-lock-ensure)
  5208. (if org-link-descriptive
  5209. (org-link-display-format
  5210. (buffer-string))
  5211. (buffer-string)))))
  5212. (defun org-get-level-face (n)
  5213. "Get the right face for match N in font-lock matching of headlines."
  5214. (let* ((org-l0 (- (match-end 2) (match-beginning 1) 1))
  5215. (org-l (if org-odd-levels-only (1+ (/ org-l0 2)) org-l0))
  5216. (org-f (if org-cycle-level-faces
  5217. (nth (% (1- org-l) org-n-level-faces) org-level-faces)
  5218. (nth (1- (min org-l org-n-level-faces)) org-level-faces))))
  5219. (cond
  5220. ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
  5221. ((eq n 2) org-f)
  5222. (t (unless org-level-color-stars-only org-f)))))
  5223. (defun org-face-from-face-or-color (context inherit face-or-color)
  5224. "Create a face list that inherits INHERIT, but sets the foreground color.
  5225. When FACE-OR-COLOR is not a string, just return it."
  5226. (if (stringp face-or-color)
  5227. (list :inherit inherit
  5228. (cdr (assoc context org-faces-easy-properties))
  5229. face-or-color)
  5230. face-or-color))
  5231. (defun org-get-todo-face (kwd)
  5232. "Get the right face for a TODO keyword KWD.
  5233. If KWD is a number, get the corresponding match group."
  5234. (when (numberp kwd) (setq kwd (match-string kwd)))
  5235. (or (org-face-from-face-or-color
  5236. 'todo 'org-todo (cdr (assoc kwd org-todo-keyword-faces)))
  5237. (and (member kwd org-done-keywords) 'org-done)
  5238. 'org-todo))
  5239. (defun org-get-priority-face (priority)
  5240. "Get the right face for PRIORITY.
  5241. PRIORITY is a character."
  5242. (or (org-face-from-face-or-color
  5243. 'priority 'org-priority (cdr (assq priority org-priority-faces)))
  5244. 'org-priority))
  5245. (defun org-get-tag-face (tag)
  5246. "Get the right face for TAG.
  5247. If TAG is a number, get the corresponding match group."
  5248. (let ((tag (if (wholenump tag) (match-string tag) tag)))
  5249. (or (org-face-from-face-or-color
  5250. 'tag 'org-tag (cdr (assoc tag org-tag-faces)))
  5251. 'org-tag)))
  5252. (defvar org-priority-regexp) ; defined later in the file
  5253. (defun org-font-lock-add-priority-faces (limit)
  5254. "Add the special priority faces."
  5255. (while (re-search-forward (concat "^\\*+" org-priority-regexp) limit t)
  5256. (let ((beg (match-beginning 1))
  5257. (end (1+ (match-end 2))))
  5258. (add-face-text-property
  5259. beg end
  5260. (org-get-priority-face (string-to-char (match-string 2))))
  5261. (add-text-properties
  5262. beg end
  5263. (list 'font-lock-fontified t)))))
  5264. (defun org-font-lock-add-tag-faces (limit)
  5265. "Add the special tag faces."
  5266. (when (and org-tag-faces org-tags-special-faces-re)
  5267. (while (re-search-forward org-tags-special-faces-re limit t)
  5268. (add-face-text-property
  5269. (match-beginning 1)
  5270. (match-end 1)
  5271. (org-get-tag-face 1))
  5272. (add-text-properties (match-beginning 1) (match-end 1)
  5273. (list 'font-lock-fontified t))
  5274. (backward-char 1))))
  5275. (defun org-unfontify-region (beg end &optional _maybe_loudly)
  5276. "Remove fontification and activation overlays from links."
  5277. (font-lock-default-unfontify-region beg end)
  5278. (with-silent-modifications
  5279. (decompose-region beg end)
  5280. (remove-text-properties beg end
  5281. '(mouse-face t keymap t org-linked-text t
  5282. invisible t intangible t
  5283. org-emphasis t))
  5284. (org-fold-region beg end nil 'org-link)
  5285. (org-fold-region beg end nil 'org-link-description)
  5286. (org-fold-core-update-optimisation beg end)
  5287. (org-remove-font-lock-display-properties beg end)))
  5288. (defconst org-script-display '(((raise -0.3) (height 0.7))
  5289. ((raise 0.3) (height 0.7))
  5290. ((raise -0.5))
  5291. ((raise 0.5)))
  5292. "Display properties for showing superscripts and subscripts.")
  5293. (defun org-remove-font-lock-display-properties (beg end)
  5294. "Remove specific display properties that have been added by font lock.
  5295. The will remove the raise properties that are used to show superscripts
  5296. and subscripts."
  5297. (let (next prop)
  5298. (while (< beg end)
  5299. (setq next (next-single-property-change beg 'display nil end)
  5300. prop (get-text-property beg 'display))
  5301. (when (member prop org-script-display)
  5302. (put-text-property beg next 'display nil))
  5303. (setq beg next))))
  5304. (defun org-raise-scripts (limit)
  5305. "Add raise properties to sub/superscripts."
  5306. (when (and org-pretty-entities org-pretty-entities-include-sub-superscripts
  5307. (re-search-forward
  5308. (if (eq org-use-sub-superscripts t)
  5309. org-match-substring-regexp
  5310. org-match-substring-with-braces-regexp)
  5311. limit t))
  5312. (let* ((pos (point)) table-p comment-p
  5313. (mpos (match-beginning 3))
  5314. (emph-p (get-text-property mpos 'org-emphasis))
  5315. (link-p (get-text-property mpos 'mouse-face))
  5316. (keyw-p (eq 'org-special-keyword (get-text-property mpos 'face))))
  5317. (goto-char (line-beginning-position))
  5318. (setq table-p (looking-at-p org-table-dataline-regexp)
  5319. comment-p (looking-at-p "^[ \t]*#[ +]"))
  5320. (goto-char pos)
  5321. ;; Handle a_b^c
  5322. (when (member (char-after) '(?_ ?^)) (goto-char (1- pos)))
  5323. (unless (or comment-p emph-p link-p keyw-p)
  5324. (put-text-property (match-beginning 3) (match-end 0)
  5325. 'display
  5326. (if (equal (char-after (match-beginning 2)) ?^)
  5327. (nth (if table-p 3 1) org-script-display)
  5328. (nth (if table-p 2 0) org-script-display)))
  5329. (put-text-property (match-beginning 2) (match-end 3)
  5330. 'org-emphasis t)
  5331. (add-text-properties (match-beginning 2) (match-end 2)
  5332. (list 'invisible t))
  5333. (when (and (eq (char-after (match-beginning 3)) ?{)
  5334. (eq (char-before (match-end 3)) ?}))
  5335. (add-text-properties (match-beginning 3) (1+ (match-beginning 3))
  5336. (list 'invisible t))
  5337. (add-text-properties (1- (match-end 3)) (match-end 3)
  5338. (list 'invisible t))))
  5339. t)))
  5340. (defun org-remove-empty-overlays-at (pos)
  5341. "Remove outline overlays that do not contain non-white stuff."
  5342. (dolist (o (overlays-at pos))
  5343. (and (eq 'outline (overlay-get o 'invisible))
  5344. (not (string-match-p
  5345. "\\S-" (buffer-substring (overlay-start o)
  5346. (overlay-end o))))
  5347. (delete-overlay o))))
  5348. ;; FIXME: This function is unused.
  5349. (defun org-show-empty-lines-in-parent ()
  5350. "Move to the parent and re-show empty lines before visible headlines."
  5351. (save-excursion
  5352. (let ((context (if (org-up-heading-safe) 'children 'overview)))
  5353. (org-cycle-show-empty-lines context))))
  5354. (defun org-files-list ()
  5355. "Return `org-agenda-files' list, plus all open Org files.
  5356. This is useful for operations that need to scan all of a user's
  5357. open and agenda-wise Org files."
  5358. (let ((files (mapcar #'expand-file-name (org-agenda-files))))
  5359. (dolist (buf (buffer-list))
  5360. (with-current-buffer buf
  5361. (when (and (derived-mode-p 'org-mode) (buffer-file-name))
  5362. (cl-pushnew (expand-file-name (buffer-file-name)) files
  5363. :test #'equal))))
  5364. files))
  5365. (defsubst org-entry-beginning-position ()
  5366. "Return the beginning position of the current entry."
  5367. (save-excursion (org-back-to-heading t) (point)))
  5368. (defsubst org-entry-end-position ()
  5369. "Return the end position of the current entry."
  5370. (save-excursion (outline-next-heading) (point)))
  5371. (defun org-subtree-end-visible-p ()
  5372. "Is the end of the current subtree visible?"
  5373. (pos-visible-in-window-p
  5374. (save-excursion (org-end-of-subtree t) (point))))
  5375. (defun org-first-headline-recenter ()
  5376. "Move cursor to the first headline and recenter the headline."
  5377. (let ((window (get-buffer-window)))
  5378. (when window
  5379. (goto-char (point-min))
  5380. (when (re-search-forward (concat "^\\(" org-outline-regexp "\\)") nil t)
  5381. (set-window-start window (line-beginning-position))))))
  5382. ;; FIXME: It was in the middle of visibility section. Where should it go to?
  5383. (defvar org-called-with-limited-levels nil
  5384. "Non-nil when `org-with-limited-levels' is currently active.")
  5385. ;;; Indirect buffer display of subtrees
  5386. (defvar org-indirect-dedicated-frame nil
  5387. "This is the frame being used for indirect tree display.")
  5388. (defvar org-last-indirect-buffer nil)
  5389. (defun org-tree-to-indirect-buffer (&optional arg)
  5390. "Create indirect buffer and narrow it to current subtree.
  5391. With a numerical prefix ARG, go up to this level and then take that tree.
  5392. If ARG is negative, go up that many levels.
  5393. If `org-indirect-buffer-display' is not `new-frame', the command removes the
  5394. indirect buffer previously made with this command, to avoid proliferation of
  5395. indirect buffers. However, when you call the command with a \
  5396. `\\[universal-argument]' prefix, or
  5397. when `org-indirect-buffer-display' is `new-frame', the last buffer is kept
  5398. so that you can work with several indirect buffers at the same time. If
  5399. `org-indirect-buffer-display' is `dedicated-frame', the \
  5400. `\\[universal-argument]' prefix also
  5401. requests that a new frame be made for the new buffer, so that the dedicated
  5402. frame is not changed."
  5403. (interactive "P")
  5404. (let ((cbuf (current-buffer))
  5405. (cwin (selected-window))
  5406. (pos (point))
  5407. beg end level heading ibuf)
  5408. (save-excursion
  5409. (org-back-to-heading t)
  5410. (when (numberp arg)
  5411. (setq level (org-outline-level))
  5412. (when (< arg 0) (setq arg (+ level arg)))
  5413. (while (> (setq level (org-outline-level)) arg)
  5414. (org-up-heading-safe)))
  5415. (setq beg (point)
  5416. heading (org-get-heading 'no-tags))
  5417. (org-end-of-subtree t t)
  5418. (when (and (not (eobp)) (org-at-heading-p)) (backward-char 1))
  5419. (setq end (point)))
  5420. (when (and (buffer-live-p org-last-indirect-buffer)
  5421. (not (eq org-indirect-buffer-display 'new-frame))
  5422. (not arg))
  5423. (kill-buffer org-last-indirect-buffer))
  5424. (setq ibuf (org-get-indirect-buffer cbuf heading)
  5425. org-last-indirect-buffer ibuf)
  5426. (cond
  5427. ((or (eq org-indirect-buffer-display 'new-frame)
  5428. (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
  5429. (select-frame (make-frame))
  5430. (delete-other-windows)
  5431. (pop-to-buffer-same-window ibuf)
  5432. (org-set-frame-title heading))
  5433. ((eq org-indirect-buffer-display 'dedicated-frame)
  5434. (raise-frame
  5435. (select-frame (or (and org-indirect-dedicated-frame
  5436. (frame-live-p org-indirect-dedicated-frame)
  5437. org-indirect-dedicated-frame)
  5438. (setq org-indirect-dedicated-frame (make-frame)))))
  5439. (delete-other-windows)
  5440. (pop-to-buffer-same-window ibuf)
  5441. (org-set-frame-title (concat "Indirect: " heading)))
  5442. ((eq org-indirect-buffer-display 'current-window)
  5443. (pop-to-buffer-same-window ibuf))
  5444. ((eq org-indirect-buffer-display 'other-window)
  5445. (pop-to-buffer ibuf))
  5446. (t (error "Invalid value")))
  5447. (narrow-to-region beg end)
  5448. (org-fold-show-all '(headings drawers blocks))
  5449. (goto-char pos)
  5450. (run-hook-with-args 'org-cycle-hook 'all)
  5451. (and (window-live-p cwin) (select-window cwin))))
  5452. (defun org-get-indirect-buffer (&optional buffer heading)
  5453. (setq buffer (or buffer (current-buffer)))
  5454. (let ((n 1) (base (buffer-name buffer)) bname)
  5455. (while (buffer-live-p
  5456. (get-buffer
  5457. (setq bname
  5458. (concat base "-"
  5459. (if heading (concat heading "-" (number-to-string n))
  5460. (number-to-string n))))))
  5461. (setq n (1+ n)))
  5462. (condition-case nil
  5463. (let ((indirect-buffer (make-indirect-buffer buffer bname 'clone)))
  5464. ;; Decouple folding state. We need to do it manually since
  5465. ;; `make-indirect-buffer' does not run
  5466. ;; `clone-indirect-buffer-hook'.
  5467. (org-fold-core-decouple-indirect-buffer-folds)
  5468. ;; Return the buffer.
  5469. indirect-buffer)
  5470. (error (make-indirect-buffer buffer bname)))))
  5471. (defun org-set-frame-title (title)
  5472. "Set the title of the current frame to the string TITLE."
  5473. (modify-frame-parameters (selected-frame) (list (cons 'name title))))
  5474. ;;;; Structure editing
  5475. ;;; Inserting headlines
  5476. (defun org--blank-before-heading-p (&optional parent)
  5477. "Non-nil when an empty line should precede a new heading here.
  5478. When optional argument PARENT is non-nil, consider parent
  5479. headline instead of current one."
  5480. (pcase (assq 'heading org-blank-before-new-entry)
  5481. (`(heading . auto)
  5482. (save-excursion
  5483. (org-with-limited-levels
  5484. (unless (and (org-before-first-heading-p)
  5485. (not (outline-next-heading)))
  5486. (org-back-to-heading t)
  5487. (when parent (org-up-heading-safe))
  5488. (cond ((not (bobp))
  5489. (org-previous-line-empty-p))
  5490. ((outline-next-heading)
  5491. (org-previous-line-empty-p))
  5492. ;; Ignore trailing spaces on last buffer line.
  5493. ((progn (skip-chars-backward " \t") (bolp))
  5494. (org-previous-line-empty-p))
  5495. (t nil))))))
  5496. (`(heading . ,value) value)
  5497. (_ nil)))
  5498. (defun org-insert-heading (&optional arg invisible-ok top)
  5499. "Insert a new heading or an item with the same depth at point.
  5500. If point is at the beginning of a heading, insert a new heading
  5501. or a new headline above the current one. When at the beginning
  5502. of a regular line of text, turn it into a heading.
  5503. If point is in the middle of a line, split it and create a new
  5504. headline with the text in the current line after point (see
  5505. `org-M-RET-may-split-line' on how to modify this behavior). As
  5506. a special case, on a headline, splitting can only happen on the
  5507. title itself. E.g., this excludes breaking stars or tags.
  5508. With a `\\[universal-argument]' prefix, set \
  5509. `org-insert-heading-respect-content' to
  5510. a non-nil value for the duration of the command. This forces the
  5511. insertion of a heading after the current subtree, independently
  5512. on the location of point.
  5513. With a `\\[universal-argument] \\[universal-argument]' prefix, \
  5514. insert the heading at the end of the tree
  5515. above the current heading. For example, if point is within a
  5516. 2nd-level heading, then it will insert a 2nd-level heading at
  5517. the end of the 1st-level parent subtree.
  5518. When INVISIBLE-OK is set, stop at invisible headlines when going
  5519. back. This is important for non-interactive uses of the
  5520. command.
  5521. When optional argument TOP is non-nil, insert a level 1 heading,
  5522. unconditionally."
  5523. (interactive "P")
  5524. (let* ((blank? (org--blank-before-heading-p (equal arg '(16))))
  5525. (level (org-current-level))
  5526. (stars (make-string (if (and level (not top)) level 1) ?*)))
  5527. (cond
  5528. ((or org-insert-heading-respect-content
  5529. (member arg '((4) (16)))
  5530. (and (not invisible-ok)
  5531. (invisible-p (max (1- (point)) (point-min)))))
  5532. ;; Position point at the location of insertion. Make sure we
  5533. ;; end up on a visible headline if INVISIBLE-OK is nil.
  5534. (org-with-limited-levels
  5535. (if (not level) (outline-next-heading) ;before first headline
  5536. (org-back-to-heading invisible-ok)
  5537. (when (equal arg '(16)) (org-up-heading-safe))
  5538. (org-end-of-subtree)))
  5539. (unless (bolp) (insert "\n"))
  5540. (when (and blank? (save-excursion
  5541. (backward-char)
  5542. (org-before-first-heading-p)))
  5543. (insert "\n")
  5544. (backward-char))
  5545. (when (and (not level) (not (eobp)) (not (bobp)))
  5546. (when (org-at-heading-p) (insert "\n"))
  5547. (backward-char))
  5548. (unless (and blank? (org-previous-line-empty-p))
  5549. (org-N-empty-lines-before-current (if blank? 1 0)))
  5550. (insert stars " ")
  5551. ;; When INVISIBLE-OK is non-nil, ensure newly created headline
  5552. ;; is visible.
  5553. (unless invisible-ok
  5554. (if (eq org-fold-core-style 'text-properties)
  5555. (cond
  5556. ((org-fold-folded-p
  5557. (max (point-min)
  5558. (1- (line-beginning-position)))
  5559. 'headline)
  5560. (org-fold-region (line-end-position 0) (line-end-position) nil 'headline))
  5561. (t nil))
  5562. (pcase (get-char-property-and-overlay (point) 'invisible)
  5563. (`(outline . ,o)
  5564. (move-overlay o (overlay-start o) (line-end-position 0)))
  5565. (_ nil)))))
  5566. ;; At a headline...
  5567. ((org-at-heading-p)
  5568. (cond ((bolp)
  5569. (when blank? (save-excursion (insert "\n")))
  5570. (save-excursion (insert stars " \n"))
  5571. (unless (and blank? (org-previous-line-empty-p))
  5572. (org-N-empty-lines-before-current (if blank? 1 0)))
  5573. (end-of-line))
  5574. ((and (org-get-alist-option org-M-RET-may-split-line 'headline)
  5575. (org-match-line org-complex-heading-regexp)
  5576. (org-pos-in-match-range (point) 4))
  5577. ;; Grab the text that should moved to the new headline.
  5578. ;; Preserve tags.
  5579. (let ((split (delete-and-extract-region (point) (match-end 4))))
  5580. (if (looking-at "[ \t]*$") (replace-match "")
  5581. (org-align-tags))
  5582. (end-of-line)
  5583. (when blank? (insert "\n"))
  5584. (insert "\n" stars " ")
  5585. (when (org-string-nw-p split) (insert split))))
  5586. (t
  5587. (end-of-line)
  5588. (when blank? (insert "\n"))
  5589. (insert "\n" stars " "))))
  5590. ;; On regular text, turn line into a headline or split, if
  5591. ;; appropriate.
  5592. ((bolp)
  5593. (insert stars " ")
  5594. (unless (and blank? (org-previous-line-empty-p))
  5595. (org-N-empty-lines-before-current (if blank? 1 0))))
  5596. (t
  5597. (unless (org-get-alist-option org-M-RET-may-split-line 'headline)
  5598. (end-of-line))
  5599. (insert "\n" stars " ")
  5600. (unless (and blank? (org-previous-line-empty-p))
  5601. (org-N-empty-lines-before-current (if blank? 1 0))))))
  5602. (run-hooks 'org-insert-heading-hook))
  5603. (defun org-N-empty-lines-before-current (n)
  5604. "Make the number of empty lines before current exactly N.
  5605. So this will delete or add empty lines."
  5606. (let ((column (current-column)))
  5607. (beginning-of-line)
  5608. (unless (bobp)
  5609. (let ((start (save-excursion
  5610. (skip-chars-backward " \r\t\n")
  5611. (line-end-position))))
  5612. (delete-region start (line-end-position 0))))
  5613. (insert (make-string n ?\n))
  5614. (move-to-column column)))
  5615. (defun org-get-heading (&optional no-tags no-todo no-priority no-comment)
  5616. "Return the heading of the current entry, without the stars.
  5617. When NO-TAGS is non-nil, don't include tags.
  5618. When NO-TODO is non-nil, don't include TODO keywords.
  5619. When NO-PRIORITY is non-nil, don't include priority cookie.
  5620. When NO-COMMENT is non-nil, don't include COMMENT string.
  5621. Return nil before first heading."
  5622. (unless (org-before-first-heading-p)
  5623. (save-excursion
  5624. (org-back-to-heading t)
  5625. (let ((case-fold-search nil))
  5626. (looking-at org-complex-heading-regexp)
  5627. ;; When using `org-fold-core--optimise-for-huge-buffers',
  5628. ;; returned text will be invisible. Clear it up.
  5629. (save-match-data
  5630. (org-fold-core-remove-optimisation (match-beginning 0) (match-end 0)))
  5631. (let ((todo (and (not no-todo) (match-string 2)))
  5632. (priority (and (not no-priority) (match-string 3)))
  5633. (headline (pcase (match-string 4)
  5634. (`nil "")
  5635. ((and (guard no-comment) h)
  5636. (replace-regexp-in-string
  5637. (eval-when-compile
  5638. (format "\\`%s[ \t]+" org-comment-string))
  5639. "" h))
  5640. (h h)))
  5641. (tags (and (not no-tags) (match-string 5))))
  5642. ;; Restore cleared optimisation.
  5643. (org-fold-core-update-optimisation (match-beginning 0) (match-end 0))
  5644. (mapconcat #'identity
  5645. (delq nil (list todo priority headline tags))
  5646. " "))))))
  5647. (defun org-heading-components ()
  5648. "Return the components of the current heading.
  5649. This is a list with the following elements:
  5650. - the level as an integer
  5651. - the reduced level, different if `org-odd-levels-only' is set.
  5652. - the TODO keyword, or nil
  5653. - the priority character, like ?A, or nil if no priority is given
  5654. - the headline text itself, or the tags string if no headline text
  5655. - the tags string, or nil."
  5656. (save-excursion
  5657. (org-back-to-heading t)
  5658. (when (let (case-fold-search) (looking-at org-complex-heading-regexp))
  5659. (org-fold-core-remove-optimisation (match-beginning 0) (match-end 0))
  5660. (prog1
  5661. (list (length (match-string 1))
  5662. (org-reduced-level (length (match-string 1)))
  5663. (match-string-no-properties 2)
  5664. (and (match-end 3) (aref (match-string 3) 2))
  5665. (match-string-no-properties 4)
  5666. (match-string-no-properties 5))
  5667. (org-fold-core-update-optimisation (match-beginning 0) (match-end 0))))))
  5668. (defun org-get-entry ()
  5669. "Get the entry text, after heading, entire subtree."
  5670. (save-excursion
  5671. (org-back-to-heading t)
  5672. (filter-buffer-substring (line-beginning-position 2) (org-end-of-subtree t))))
  5673. (defun org-edit-headline (&optional heading)
  5674. "Edit the current headline.
  5675. Set it to HEADING when provided."
  5676. (interactive)
  5677. (org-with-wide-buffer
  5678. (org-back-to-heading t)
  5679. (let ((case-fold-search nil))
  5680. (when (looking-at org-complex-heading-regexp)
  5681. (let* ((old (match-string-no-properties 4))
  5682. (new (save-match-data
  5683. (org-trim (or heading (read-string "Edit: " old))))))
  5684. (unless (equal old new)
  5685. (if old (replace-match new t t nil 4)
  5686. (goto-char (or (match-end 3) (match-end 2) (match-end 1)))
  5687. (insert " " new))
  5688. (org-align-tags)
  5689. (when (looking-at "[ \t]*$") (replace-match ""))))))))
  5690. (defun org-insert-heading-after-current ()
  5691. "Insert a new heading with same level as current, after current subtree."
  5692. (interactive)
  5693. (org-back-to-heading)
  5694. (org-insert-heading)
  5695. (org-move-subtree-down)
  5696. (end-of-line 1))
  5697. (defun org-insert-heading-respect-content (&optional invisible-ok)
  5698. "Insert heading with `org-insert-heading-respect-content' set to t."
  5699. (interactive)
  5700. (org-insert-heading '(4) invisible-ok))
  5701. (defun org-insert-todo-heading-respect-content (&optional _)
  5702. "Insert TODO heading with `org-insert-heading-respect-content' set to t."
  5703. (interactive)
  5704. (let ((org-insert-heading-respect-content t))
  5705. (org-insert-todo-heading '(4) t)))
  5706. (defun org-insert-todo-heading (arg &optional force-heading)
  5707. "Insert a new heading with the same level and TODO state as current heading.
  5708. If the heading has no TODO state, or if the state is DONE, use
  5709. the first state (TODO by default). Also with one prefix arg,
  5710. force first state. With two prefix args, force inserting at the
  5711. end of the parent subtree.
  5712. When called at a plain list item, insert a new item with an
  5713. unchecked check box."
  5714. (interactive "P")
  5715. (when (or force-heading (not (org-insert-item 'checkbox)))
  5716. (org-insert-heading (or (and (equal arg '(16)) '(16))
  5717. force-heading))
  5718. (save-excursion
  5719. (org-forward-heading-same-level -1)
  5720. (let ((case-fold-search nil)) (looking-at org-todo-line-regexp)))
  5721. (let* ((new-mark-x
  5722. (if (or (equal arg '(4))
  5723. (not (match-beginning 2))
  5724. (member (match-string 2) org-done-keywords))
  5725. (car org-todo-keywords-1)
  5726. (match-string 2)))
  5727. (new-mark
  5728. (or
  5729. (run-hook-with-args-until-success
  5730. 'org-todo-get-default-hook new-mark-x nil)
  5731. new-mark-x)))
  5732. (beginning-of-line 1)
  5733. (and (looking-at org-outline-regexp) (goto-char (match-end 0))
  5734. (if org-treat-insert-todo-heading-as-state-change
  5735. (org-todo new-mark)
  5736. (insert new-mark " "))))
  5737. (when org-provide-todo-statistics
  5738. (org-update-parent-todo-statistics))))
  5739. (defun org-insert-subheading (arg)
  5740. "Insert a new subheading and demote it.
  5741. Works for outline headings and for plain lists alike."
  5742. (interactive "P")
  5743. (org-insert-heading arg)
  5744. (cond
  5745. ((org-at-heading-p) (org-do-demote))
  5746. ((org-at-item-p) (org-indent-item))))
  5747. (defun org-insert-todo-subheading (arg)
  5748. "Insert a new subheading with TODO keyword or checkbox and demote it.
  5749. Works for outline headings and for plain lists alike."
  5750. (interactive "P")
  5751. (org-insert-todo-heading arg)
  5752. (cond
  5753. ((org-at-heading-p) (org-do-demote))
  5754. ((org-at-item-p) (org-indent-item))))
  5755. ;;; Promotion and Demotion
  5756. (defvar org-after-demote-entry-hook nil
  5757. "Hook run after an entry has been demoted.
  5758. The cursor will be at the beginning of the entry.
  5759. When a subtree is being demoted, the hook will be called for each node.")
  5760. (defvar org-after-promote-entry-hook nil
  5761. "Hook run after an entry has been promoted.
  5762. The cursor will be at the beginning of the entry.
  5763. When a subtree is being promoted, the hook will be called for each node.")
  5764. (defun org-promote-subtree ()
  5765. "Promote the entire subtree.
  5766. See also `org-promote'."
  5767. (interactive)
  5768. (save-excursion
  5769. (org-back-to-heading t)
  5770. (combine-change-calls (point) (save-excursion (org-end-of-subtree t))
  5771. (org-with-limited-levels (org-map-tree 'org-promote))))
  5772. (org-fix-position-after-promote))
  5773. (defun org-demote-subtree ()
  5774. "Demote the entire subtree.
  5775. See `org-demote' and `org-promote'."
  5776. (interactive)
  5777. (save-excursion
  5778. (org-back-to-heading t)
  5779. (combine-change-calls (point) (save-excursion (org-end-of-subtree t))
  5780. (org-with-limited-levels (org-map-tree 'org-demote))))
  5781. (org-fix-position-after-promote))
  5782. (defun org-do-promote ()
  5783. "Promote the current heading higher up the tree.
  5784. If the region is active in `transient-mark-mode', promote all
  5785. headings in the region."
  5786. (interactive)
  5787. (save-excursion
  5788. (if (org-region-active-p)
  5789. (org-map-region 'org-promote (region-beginning) (region-end))
  5790. (org-promote)))
  5791. (org-fix-position-after-promote))
  5792. (defun org-do-demote ()
  5793. "Demote the current heading lower down the tree.
  5794. If the region is active in `transient-mark-mode', demote all
  5795. headings in the region."
  5796. (interactive)
  5797. (save-excursion
  5798. (if (org-region-active-p)
  5799. (org-map-region 'org-demote (region-beginning) (region-end))
  5800. (org-demote)))
  5801. (org-fix-position-after-promote))
  5802. (defun org-fix-position-after-promote ()
  5803. "Fix cursor position and indentation after demoting/promoting."
  5804. (let ((pos (point)))
  5805. (when (save-excursion
  5806. (beginning-of-line)
  5807. (let ((case-fold-search nil)) (looking-at org-todo-line-regexp))
  5808. (or (eq pos (match-end 1)) (eq pos (match-end 2))))
  5809. (cond ((eobp) (insert " "))
  5810. ((eolp) (insert " "))
  5811. ((equal (char-after) ?\s) (forward-char 1))))))
  5812. (defun org-current-level ()
  5813. "Return the level of the current entry, or nil if before the first headline.
  5814. The level is the number of stars at the beginning of the
  5815. headline. Use `org-reduced-level' to remove the effect of
  5816. `org-odd-levels'. Unlike to `org-outline-level', this function
  5817. ignores inlinetasks."
  5818. (let ((level (org-with-limited-levels (org-outline-level))))
  5819. (and (> level 0) level)))
  5820. (defun org-get-previous-line-level ()
  5821. "Return the outline depth of the last headline before the current line.
  5822. Returns 0 for the first headline in the buffer, and nil if before the
  5823. first headline."
  5824. (and (org-current-level)
  5825. (or (and (/= (line-beginning-position) (point-min))
  5826. (save-excursion (beginning-of-line 0) (org-current-level)))
  5827. 0)))
  5828. (defun org-reduced-level (l)
  5829. "Compute the effective level of a heading.
  5830. This takes into account the setting of `org-odd-levels-only'."
  5831. (cond
  5832. ((zerop l) 0)
  5833. (org-odd-levels-only (1+ (floor (/ l 2))))
  5834. (t l)))
  5835. (defun org-level-increment ()
  5836. "Return the number of stars that will be added or removed at a
  5837. time to headlines when structure editing, based on the value of
  5838. `org-odd-levels-only'."
  5839. (if org-odd-levels-only 2 1))
  5840. (defun org-get-valid-level (level &optional change)
  5841. "Rectify a level change under the influence of `org-odd-levels-only'.
  5842. LEVEL is a current level, CHANGE is by how much the level should
  5843. be modified. Even if CHANGE is nil, LEVEL may be returned
  5844. modified because even level numbers will become the next higher
  5845. odd number. Returns values greater than 0."
  5846. (if org-odd-levels-only
  5847. (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
  5848. ((> change 0) (1+ (* 2 (/ (+ (1- level) (* 2 change)) 2))))
  5849. ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
  5850. (max 1 (+ level (or change 0)))))
  5851. (defun org-promote ()
  5852. "Promote the current heading higher up the tree."
  5853. (org-with-wide-buffer
  5854. (org-back-to-heading t)
  5855. (let* ((after-change-functions (remq 'flyspell-after-change-function
  5856. after-change-functions))
  5857. (level (save-match-data (funcall outline-level)))
  5858. (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
  5859. (diff (abs (- level (length up-head) -1))))
  5860. (cond
  5861. ((and (= level 1) org-allow-promoting-top-level-subtree)
  5862. (replace-match "# " nil t))
  5863. ((= level 1)
  5864. (user-error "Cannot promote to level 0. UNDO to recover if necessary"))
  5865. (t (replace-match (apply #'propertize up-head (text-properties-at (match-beginning 0))) t)))
  5866. (unless (= level 1)
  5867. (when org-auto-align-tags (org-align-tags))
  5868. (when org-adapt-indentation (org-fixup-indentation (- diff))))
  5869. (run-hooks 'org-after-promote-entry-hook))))
  5870. (defun org-demote ()
  5871. "Demote the current heading lower down the tree."
  5872. (org-with-wide-buffer
  5873. (org-back-to-heading t)
  5874. (let* ((after-change-functions (remq 'flyspell-after-change-function
  5875. after-change-functions))
  5876. (level (save-match-data (funcall outline-level)))
  5877. (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
  5878. (diff (abs (- level (length down-head) -1))))
  5879. (org-fold-core-ignore-fragility-checks
  5880. (replace-match (apply #'propertize down-head (text-properties-at (match-beginning 0))) t)
  5881. (when org-auto-align-tags (org-align-tags))
  5882. (when org-adapt-indentation (org-fixup-indentation diff)))
  5883. (run-hooks 'org-after-demote-entry-hook))))
  5884. (defun org-cycle-level ()
  5885. "Cycle the level of an empty headline through possible states.
  5886. This goes first to child, then to parent, level, then up the hierarchy.
  5887. After top level, it switches back to sibling level."
  5888. (interactive)
  5889. (let ((org-adapt-indentation nil))
  5890. (when (org-point-at-end-of-empty-headline)
  5891. (setq this-command 'org-cycle-level) ; Only needed for caching
  5892. (let ((cur-level (org-current-level))
  5893. (prev-level (org-get-previous-line-level)))
  5894. (cond
  5895. ;; If first headline in file, promote to top-level.
  5896. ((= prev-level 0)
  5897. (cl-loop repeat (/ (- cur-level 1) (org-level-increment))
  5898. do (org-do-promote)))
  5899. ;; If same level as prev, demote one.
  5900. ((= prev-level cur-level)
  5901. (org-do-demote))
  5902. ;; If parent is top-level, promote to top level if not already.
  5903. ((= prev-level 1)
  5904. (cl-loop repeat (/ (- cur-level 1) (org-level-increment))
  5905. do (org-do-promote)))
  5906. ;; If top-level, return to prev-level.
  5907. ((= cur-level 1)
  5908. (cl-loop repeat (/ (- prev-level 1) (org-level-increment))
  5909. do (org-do-demote)))
  5910. ;; If less than prev-level, promote one.
  5911. ((< cur-level prev-level)
  5912. (org-do-promote))
  5913. ;; If deeper than prev-level, promote until higher than
  5914. ;; prev-level.
  5915. ((> cur-level prev-level)
  5916. (cl-loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
  5917. do (org-do-promote))))
  5918. t))))
  5919. (defun org-map-tree (fun)
  5920. "Call FUN for every heading underneath the current one."
  5921. (org-back-to-heading t)
  5922. (let ((level (funcall outline-level)))
  5923. (save-excursion
  5924. (funcall fun)
  5925. (while (and (progn
  5926. (outline-next-heading)
  5927. (> (funcall outline-level) level))
  5928. (not (eobp)))
  5929. (funcall fun)))))
  5930. (defun org-map-region (fun beg end)
  5931. "Call FUN for every heading between BEG and END."
  5932. (let ((org-ignore-region t))
  5933. (save-excursion
  5934. (setq end (copy-marker end))
  5935. (goto-char beg)
  5936. (when (and (re-search-forward org-outline-regexp-bol nil t)
  5937. (< (point) end))
  5938. (funcall fun))
  5939. (while (and (progn
  5940. (outline-next-heading)
  5941. (< (point) end))
  5942. (not (eobp)))
  5943. (funcall fun)))))
  5944. (defun org-fixup-indentation (diff)
  5945. "Change the indentation in the current entry by DIFF.
  5946. DIFF is an integer. Indentation is done according to the
  5947. following rules:
  5948. - Planning information and property drawers are always indented
  5949. according to the new level of the headline;
  5950. - Footnote definitions and their contents are ignored;
  5951. - Inlinetasks' boundaries are not shifted;
  5952. - Empty lines are ignored;
  5953. - Other lines' indentation are shifted by DIFF columns, unless
  5954. it would introduce a structural change in the document, in
  5955. which case no shifting is done at all.
  5956. Assume point is at a heading or an inlinetask beginning."
  5957. (org-with-wide-buffer
  5958. (narrow-to-region (line-beginning-position)
  5959. (save-excursion
  5960. (if (org-with-limited-levels (org-at-heading-p))
  5961. (org-with-limited-levels (outline-next-heading))
  5962. (org-inlinetask-goto-end))
  5963. (point)))
  5964. (forward-line)
  5965. ;; Indent properly planning info and property drawer.
  5966. (when (looking-at-p org-planning-line-re)
  5967. (org-indent-line)
  5968. (forward-line))
  5969. (when (looking-at org-property-drawer-re)
  5970. (goto-char (match-end 0))
  5971. (forward-line)
  5972. (org-indent-region (match-beginning 0) (match-end 0)))
  5973. (when (looking-at org-logbook-drawer-re)
  5974. (let ((end-marker (move-marker (make-marker) (match-end 0)))
  5975. (col (+ (current-indentation) diff)))
  5976. (when (wholenump col)
  5977. (while (< (point) end-marker)
  5978. (if (natnump diff)
  5979. (insert (make-string diff 32))
  5980. (delete-char (abs diff)))
  5981. (forward-line)))))
  5982. (catch 'no-shift
  5983. (when (or (zerop diff) (not (eq org-adapt-indentation t)))
  5984. (throw 'no-shift nil))
  5985. ;; If DIFF is negative, first check if a shift is possible at all
  5986. ;; (e.g., it doesn't break structure). This can only happen if
  5987. ;; some contents are not properly indented.
  5988. (let ((case-fold-search t))
  5989. (when (< diff 0)
  5990. (let ((diff (- diff))
  5991. (forbidden-re (concat org-outline-regexp
  5992. "\\|"
  5993. (substring org-footnote-definition-re 1))))
  5994. (save-excursion
  5995. (while (not (eobp))
  5996. (cond
  5997. ((looking-at-p "[ \t]*$") (forward-line))
  5998. ((and (looking-at-p org-footnote-definition-re)
  5999. (let ((e (org-element-at-point)))
  6000. (and (eq (org-element-type e) 'footnote-definition)
  6001. (goto-char (org-element-property :end e))))))
  6002. ((looking-at-p org-outline-regexp) (forward-line))
  6003. ;; Give up if shifting would move before column 0 or
  6004. ;; if it would introduce a headline or a footnote
  6005. ;; definition.
  6006. (t
  6007. (skip-chars-forward " \t")
  6008. (let ((ind (current-column)))
  6009. (when (or (< ind diff)
  6010. (and (= ind diff) (looking-at-p forbidden-re)))
  6011. (throw 'no-shift nil)))
  6012. ;; Ignore contents of example blocks and source
  6013. ;; blocks if their indentation is meant to be
  6014. ;; preserved. Jump to block's closing line.
  6015. (beginning-of-line)
  6016. (or (and (looking-at-p "[ \t]*#\\+BEGIN_\\(EXAMPLE\\|SRC\\)")
  6017. (let ((e (org-element-at-point)))
  6018. (and (memq (org-element-type e)
  6019. '(example-block src-block))
  6020. (or org-src-preserve-indentation
  6021. (org-element-property :preserve-indent e))
  6022. (goto-char (org-element-property :end e))
  6023. (progn (skip-chars-backward " \r\t\n")
  6024. (beginning-of-line)
  6025. t))))
  6026. (forward-line))))))))
  6027. ;; Shift lines but footnote definitions, inlinetasks boundaries
  6028. ;; by DIFF. Also skip contents of source or example blocks
  6029. ;; when indentation is meant to be preserved.
  6030. (while (not (eobp))
  6031. (cond
  6032. ((and (looking-at-p org-footnote-definition-re)
  6033. (let ((e (org-element-at-point)))
  6034. (and (eq (org-element-type e) 'footnote-definition)
  6035. (goto-char (org-element-property :end e))))))
  6036. ((looking-at-p org-outline-regexp) (forward-line))
  6037. ((looking-at-p "[ \t]*$") (forward-line))
  6038. (t
  6039. (indent-line-to (+ (current-indentation) diff))
  6040. (beginning-of-line)
  6041. (or (and (looking-at-p "[ \t]*#\\+BEGIN_\\(EXAMPLE\\|SRC\\)")
  6042. (let ((e (org-element-at-point)))
  6043. (and (memq (org-element-type e)
  6044. '(example-block src-block))
  6045. (or org-src-preserve-indentation
  6046. (org-element-property :preserve-indent e))
  6047. (goto-char (org-element-property :end e))
  6048. (progn (skip-chars-backward " \r\t\n")
  6049. (beginning-of-line)
  6050. t))))
  6051. (forward-line)))))))))
  6052. (defun org-convert-to-odd-levels ()
  6053. "Convert an Org file with all levels allowed to one with odd levels.
  6054. This will leave level 1 alone, convert level 2 to level 3, level 3 to
  6055. level 5 etc."
  6056. (interactive)
  6057. (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
  6058. (let ((outline-level 'org-outline-level)
  6059. (org-odd-levels-only nil) n)
  6060. (save-excursion
  6061. (goto-char (point-min))
  6062. (while (re-search-forward "^\\*\\*+ " nil t)
  6063. (setq n (- (length (match-string 0)) 2))
  6064. (while (>= (setq n (1- n)) 0)
  6065. (org-demote))
  6066. (end-of-line 1))))))
  6067. (defun org-convert-to-oddeven-levels ()
  6068. "Convert an Org file with only odd levels to one with odd/even levels.
  6069. This promotes level 3 to level 2, level 5 to level 3 etc. If the
  6070. file contains a section with an even level, conversion would
  6071. destroy the structure of the file. An error is signaled in this
  6072. case."
  6073. (interactive)
  6074. (goto-char (point-min))
  6075. ;; First check if there are no even levels
  6076. (when (re-search-forward "^\\(\\*\\*\\)+ " nil t)
  6077. (org-fold-show-set-visibility 'canonical)
  6078. (error "Not all levels are odd in this file. Conversion not possible"))
  6079. (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
  6080. (let ((outline-regexp org-outline-regexp)
  6081. (outline-level 'org-outline-level)
  6082. (org-odd-levels-only nil) n)
  6083. (save-excursion
  6084. (goto-char (point-min))
  6085. (while (re-search-forward "^\\*\\*+ " nil t)
  6086. (setq n (/ (1- (length (match-string 0))) 2))
  6087. (while (>= (setq n (1- n)) 0)
  6088. (org-promote))
  6089. (end-of-line 1))))))
  6090. (defun org-tr-level (n)
  6091. "Make N odd if required."
  6092. (if org-odd-levels-only (1+ (/ n 2)) n))
  6093. ;;; Vertical tree motion, cutting and pasting of subtrees
  6094. (defun org-move-subtree-up (&optional arg)
  6095. "Move the current subtree up past ARG headlines of the same level."
  6096. (interactive "p")
  6097. (org-move-subtree-down (- (prefix-numeric-value arg))))
  6098. (defun org-clean-visibility-after-subtree-move ()
  6099. "Fix visibility issues after moving a subtree."
  6100. ;; First, find a reasonable region to look at:
  6101. ;; Start two siblings above, end three below
  6102. (let* ((beg (save-excursion
  6103. (and (org-get-previous-sibling)
  6104. (org-get-previous-sibling))
  6105. (point)))
  6106. (end (save-excursion
  6107. (and (org-get-next-sibling)
  6108. (org-get-next-sibling)
  6109. (org-get-next-sibling))
  6110. (if (org-at-heading-p)
  6111. (line-end-position)
  6112. (point))))
  6113. (level (looking-at "\\*+"))
  6114. (re (when level (concat "^" (regexp-quote (match-string 0)) " "))))
  6115. (save-excursion
  6116. (save-restriction
  6117. (narrow-to-region beg end)
  6118. (when re
  6119. ;; Properly fold already folded siblings
  6120. (goto-char (point-min))
  6121. (while (re-search-forward re nil t)
  6122. (when (and (not (org-invisible-p))
  6123. (org-invisible-p (line-end-position)))
  6124. (org-fold-heading nil))))
  6125. (org-cycle-hide-drawers 'all)
  6126. (org-cycle-show-empty-lines 'overview)))))
  6127. (defun org-move-subtree-down (&optional arg)
  6128. "Move the current subtree down past ARG headlines of the same level."
  6129. (interactive "p")
  6130. (setq arg (prefix-numeric-value arg))
  6131. (org-preserve-local-variables
  6132. (let ((movfunc (if (> arg 0) 'org-get-next-sibling
  6133. 'org-get-previous-sibling))
  6134. (ins-point (make-marker))
  6135. (cnt (abs arg))
  6136. (col (current-column))
  6137. beg end txt folded)
  6138. ;; Select the tree
  6139. (org-back-to-heading)
  6140. (setq beg (point))
  6141. (save-match-data
  6142. (save-excursion (outline-end-of-heading)
  6143. (setq folded (org-invisible-p)))
  6144. (progn (org-end-of-subtree nil t)
  6145. (unless (eobp) (backward-char))))
  6146. (outline-next-heading)
  6147. (setq end (point))
  6148. (goto-char beg)
  6149. ;; Find insertion point, with error handling
  6150. (while (> cnt 0)
  6151. (unless (and (funcall movfunc) (looking-at org-outline-regexp))
  6152. (goto-char beg)
  6153. (user-error "Cannot move past superior level or buffer limit"))
  6154. (setq cnt (1- cnt)))
  6155. (when (> arg 0)
  6156. ;; Moving forward - still need to move over subtree
  6157. (org-end-of-subtree t t)
  6158. (save-excursion
  6159. (org-back-over-empty-lines)
  6160. (or (bolp) (newline))))
  6161. (move-marker ins-point (point))
  6162. (setq txt (buffer-substring beg end))
  6163. (org-save-markers-in-region beg end)
  6164. (delete-region beg end)
  6165. (when (eq org-fold-core-style 'overlays) (org-remove-empty-overlays-at beg))
  6166. (unless (= beg (point-min)) (org-fold-region (1- beg) beg nil 'outline))
  6167. (unless (bobp) (org-fold-region (1- (point)) (point) nil 'outline))
  6168. (and (not (bolp)) (looking-at "\n") (forward-char 1))
  6169. (let ((bbb (point)))
  6170. (insert-before-markers txt)
  6171. (org-reinstall-markers-in-region bbb)
  6172. (move-marker ins-point bbb))
  6173. (or (bolp) (insert "\n"))
  6174. (goto-char ins-point)
  6175. (org-skip-whitespace)
  6176. (move-marker ins-point nil)
  6177. (if folded
  6178. (org-fold-subtree t)
  6179. (org-fold-show-entry 'hide-drawers)
  6180. (org-fold-show-children))
  6181. (org-clean-visibility-after-subtree-move)
  6182. ;; move back to the initial column we were at
  6183. (move-to-column col))))
  6184. (defvar org-subtree-clip ""
  6185. "Clipboard for cut and paste of subtrees.
  6186. This is actually only a copy of the kill, because we use the normal kill
  6187. ring. We need it to check if the kill was created by `org-copy-subtree'.")
  6188. (defvar org-subtree-clip-folded nil
  6189. "Was the last copied subtree folded?
  6190. This is used to fold the tree back after pasting.")
  6191. (defun org-cut-subtree (&optional n)
  6192. "Cut the current subtree into the clipboard.
  6193. With prefix arg N, cut this many sequential subtrees.
  6194. This is a short-hand for marking the subtree and then cutting it."
  6195. (interactive "p")
  6196. (org-copy-subtree n 'cut))
  6197. (defun org-copy-subtree (&optional n cut force-store-markers nosubtrees)
  6198. "Copy the current subtree into the clipboard.
  6199. With prefix arg N, copy this many sequential subtrees.
  6200. This is a short-hand for marking the subtree and then copying it.
  6201. If CUT is non-nil, actually cut the subtree.
  6202. If FORCE-STORE-MARKERS is non-nil, store the relative locations
  6203. of some markers in the region, even if CUT is non-nil. This is
  6204. useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
  6205. (interactive "p")
  6206. (org-preserve-local-variables
  6207. (let (beg end folded (beg0 (point)))
  6208. (if (called-interactively-p 'any)
  6209. (org-back-to-heading nil) ; take what looks like a subtree
  6210. (org-back-to-heading t)) ; take what is really there
  6211. (setq beg (point))
  6212. (skip-chars-forward " \t\r\n")
  6213. (save-match-data
  6214. (if nosubtrees
  6215. (outline-next-heading)
  6216. (save-excursion (outline-end-of-heading)
  6217. (setq folded (org-invisible-p)))
  6218. (ignore-errors (org-forward-heading-same-level (1- n) t))
  6219. (org-end-of-subtree t t)))
  6220. ;; Include the end of an inlinetask
  6221. (when (and (featurep 'org-inlinetask)
  6222. (looking-at-p (concat (org-inlinetask-outline-regexp)
  6223. "END[ \t]*$")))
  6224. (end-of-line))
  6225. (setq end (point))
  6226. (goto-char beg0)
  6227. (when (> end beg)
  6228. (setq org-subtree-clip-folded folded)
  6229. (when (or cut force-store-markers)
  6230. (org-save-markers-in-region beg end))
  6231. (if cut (kill-region beg end) (copy-region-as-kill beg end))
  6232. (setq org-subtree-clip (current-kill 0))
  6233. (message "%s: Subtree(s) with %d characters"
  6234. (if cut "Cut" "Copied")
  6235. (length org-subtree-clip))))))
  6236. (defun org-paste-subtree (&optional level tree for-yank remove)
  6237. "Paste the clipboard as a subtree, with modification of headline level.
  6238. The entire subtree is promoted or demoted in order to match a new headline
  6239. level.
  6240. If the cursor is at the beginning of a headline, the same level as
  6241. that headline is used to paste the tree.
  6242. If not, the new level is derived from the *visible* headings
  6243. before and after the insertion point, and taken to be the inferior headline
  6244. level of the two. So if the previous visible heading is level 3 and the
  6245. next is level 4 (or vice versa), level 4 will be used for insertion.
  6246. This makes sure that the subtree remains an independent subtree and does
  6247. not swallow low level entries.
  6248. You can also force a different level, either by using a numeric prefix
  6249. argument, or by inserting the heading marker by hand. For example, if the
  6250. cursor is after \"*****\", then the tree will be shifted to level 5.
  6251. If optional TREE is given, use this text instead of the kill ring.
  6252. When FOR-YANK is set, this is called by `org-yank'. In this case, do not
  6253. move back over whitespace before inserting, and move point to the end of
  6254. the inserted text when done.
  6255. When REMOVE is non-nil, remove the subtree from the clipboard."
  6256. (interactive "P")
  6257. (setq tree (or tree (and kill-ring (current-kill 0))))
  6258. (unless (org-kill-is-subtree-p tree)
  6259. (user-error
  6260. (substitute-command-keys
  6261. "The kill is not a (set of) tree(s). Use `\\[yank]' to yank anyway")))
  6262. (org-with-limited-levels
  6263. (org-fold-core-ignore-fragility-checks
  6264. (let* ((visp (not (org-invisible-p)))
  6265. (txt tree)
  6266. (old-level (if (string-match org-outline-regexp-bol txt)
  6267. (- (match-end 0) (match-beginning 0) 1)
  6268. -1))
  6269. (force-level
  6270. (cond
  6271. (level (prefix-numeric-value level))
  6272. ;; When point is after the stars in an otherwise empty
  6273. ;; headline, use the number of stars as the forced level.
  6274. ((and (org-match-line "^\\*+[ \t]*$")
  6275. (not (eq ?* (char-after))))
  6276. (org-outline-level))
  6277. ((looking-at-p org-outline-regexp-bol) (org-outline-level))))
  6278. (previous-level
  6279. (save-excursion
  6280. (org-previous-visible-heading 1)
  6281. (if (org-at-heading-p) (org-outline-level) 1)))
  6282. (next-level
  6283. (save-excursion
  6284. (if (org-at-heading-p) (org-outline-level)
  6285. (org-next-visible-heading 1)
  6286. (if (org-at-heading-p) (org-outline-level) 1))))
  6287. (new-level (or force-level (max previous-level next-level)))
  6288. (shift (if (or (= old-level -1)
  6289. (= new-level -1)
  6290. (= old-level new-level))
  6291. 0
  6292. (- new-level old-level)))
  6293. (delta (if (> shift 0) -1 1))
  6294. (func (if (> shift 0) #'org-demote #'org-promote))
  6295. (org-odd-levels-only nil)
  6296. beg end newend)
  6297. ;; Remove the forced level indicator.
  6298. (when (and force-level (not level))
  6299. (delete-region (line-beginning-position) (point)))
  6300. ;; Paste before the next visible heading or at end of buffer,
  6301. ;; unless point is at the beginning of a headline.
  6302. (unless (and (bolp) (org-at-heading-p))
  6303. (org-next-visible-heading 1)
  6304. (unless (bolp) (insert "\n")))
  6305. (setq beg (point))
  6306. ;; Avoid re-parsing cache elements when i.e. level 1 heading
  6307. ;; is inserted and then promoted.
  6308. (combine-change-calls beg beg
  6309. (when (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
  6310. (insert txt)
  6311. (unless (string-suffix-p "\n" txt) (insert "\n"))
  6312. (setq newend (point))
  6313. (org-reinstall-markers-in-region beg)
  6314. (setq end (point))
  6315. (goto-char beg)
  6316. (skip-chars-forward " \t\n\r")
  6317. (setq beg (point))
  6318. (when (and (org-invisible-p) visp)
  6319. (save-excursion (org-fold-heading nil)))
  6320. ;; Shift if necessary.
  6321. (unless (= shift 0)
  6322. (save-restriction
  6323. (narrow-to-region beg end)
  6324. (while (not (= shift 0))
  6325. (org-map-region func (point-min) (point-max))
  6326. (setq shift (+ delta shift)))
  6327. (goto-char (point-min))
  6328. (setq newend (point-max)))))
  6329. (when (or for-yank (called-interactively-p 'interactive))
  6330. (message "Clipboard pasted as level %d subtree" new-level))
  6331. (when (and (not for-yank) ; in this case, org-yank will decide about folding
  6332. kill-ring
  6333. (equal org-subtree-clip (current-kill 0))
  6334. org-subtree-clip-folded)
  6335. ;; The tree was folded before it was killed/copied
  6336. (org-fold-subtree t))
  6337. (when for-yank (goto-char newend))
  6338. (when remove (pop kill-ring))))))
  6339. (defun org-kill-is-subtree-p (&optional txt)
  6340. "Check if the current kill is an outline subtree, or a set of trees.
  6341. Returns nil if kill does not start with a headline, or if the first
  6342. headline level is not the largest headline level in the tree.
  6343. So this will actually accept several entries of equal levels as well,
  6344. which is OK for `org-paste-subtree'.
  6345. If optional TXT is given, check this string instead of the current kill."
  6346. (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
  6347. (re (org-get-limited-outline-regexp))
  6348. (^re (concat "^" re))
  6349. (start-level (and kill
  6350. (string-match
  6351. (concat "\\`\\([ \t\n\r]*?\n\\)?\\(" re "\\)")
  6352. kill)
  6353. (- (match-end 2) (match-beginning 2) 1)))
  6354. (start (1+ (or (match-beginning 2) -1))))
  6355. (if (not start-level)
  6356. (progn
  6357. nil) ;; does not even start with a heading
  6358. (catch 'exit
  6359. (while (setq start (string-match ^re kill (1+ start)))
  6360. (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
  6361. (throw 'exit nil)))
  6362. t))))
  6363. (defvar org-markers-to-move nil
  6364. "Markers that should be moved with a cut-and-paste operation.
  6365. Those markers are stored together with their positions relative to
  6366. the start of the region.")
  6367. (defun org-save-markers-in-region (beg end)
  6368. "Check markers in region.
  6369. If these markers are between BEG and END, record their position relative
  6370. to BEG, so that after moving the block of text, we can put the markers back
  6371. into place.
  6372. This function gets called just before an entry or tree gets cut from the
  6373. buffer. After re-insertion, `org-reinstall-markers-in-region' must be
  6374. called immediately, to move the markers with the entries."
  6375. (setq org-markers-to-move nil)
  6376. (when (featurep 'org-clock)
  6377. (org-clock-save-markers-for-cut-and-paste beg end))
  6378. (when (featurep 'org-agenda)
  6379. (org-agenda-save-markers-for-cut-and-paste beg end)))
  6380. (defun org-check-and-save-marker (marker beg end)
  6381. "Check if MARKER is between BEG and END.
  6382. If yes, remember the marker and the distance to BEG."
  6383. (when (and (marker-buffer marker)
  6384. (or (equal (marker-buffer marker) (current-buffer))
  6385. (equal (marker-buffer marker) (buffer-base-buffer (current-buffer))))
  6386. (>= marker beg) (< marker end))
  6387. (push (cons marker (- marker beg)) org-markers-to-move)))
  6388. (defun org-reinstall-markers-in-region (beg)
  6389. "Move all remembered markers to their position relative to BEG."
  6390. (dolist (x org-markers-to-move)
  6391. (move-marker (car x) (+ beg (cdr x))))
  6392. (setq org-markers-to-move nil))
  6393. (defun org-narrow-to-subtree (&optional element)
  6394. "Narrow buffer to the current subtree."
  6395. (interactive)
  6396. (if (org-element--cache-active-p)
  6397. (let* ((heading (org-element-lineage
  6398. (or element (org-element-at-point))
  6399. '(headline) t))
  6400. (end (org-element-property :end heading)))
  6401. (if (and heading end)
  6402. (narrow-to-region (org-element-property :begin heading)
  6403. (if (= end (point-max))
  6404. end (1- end)))
  6405. (signal 'outline-before-first-heading nil)))
  6406. (save-excursion
  6407. (save-match-data
  6408. (org-with-limited-levels
  6409. (narrow-to-region
  6410. (progn (org-back-to-heading t) (point))
  6411. (progn (org-end-of-subtree t t)
  6412. (when (and (org-at-heading-p) (not (eobp))) (backward-char 1))
  6413. (point))))))))
  6414. (defun org-toggle-narrow-to-subtree ()
  6415. "Narrow to the subtree at point or widen a narrowed buffer."
  6416. (interactive)
  6417. (if (buffer-narrowed-p)
  6418. (progn (widen) (message "Buffer widen"))
  6419. (org-narrow-to-subtree)
  6420. (message "Buffer narrowed to current subtree")))
  6421. (defun org-narrow-to-block ()
  6422. "Narrow buffer to the current block."
  6423. (interactive)
  6424. (let* ((case-fold-search t)
  6425. (blockp (org-between-regexps-p "^[ \t]*#\\+begin_.*"
  6426. "^[ \t]*#\\+end_.*")))
  6427. (if blockp
  6428. (narrow-to-region (car blockp) (cdr blockp))
  6429. (user-error "Not in a block"))))
  6430. (defun org-clone-subtree-with-time-shift (n &optional shift)
  6431. "Clone the task (subtree) at point N times.
  6432. The clones will be inserted as siblings.
  6433. In interactive use, the user will be prompted for the number of
  6434. clones to be produced. If the entry has a timestamp, the user
  6435. will also be prompted for a time shift, which may be a repeater
  6436. as used in time stamps, for example `+3d'. To disable this,
  6437. you can call the function with a universal prefix argument.
  6438. When a valid repeater is given and the entry contains any time
  6439. stamps, the clones will become a sequence in time, with time
  6440. stamps in the subtree shifted for each clone produced. If SHIFT
  6441. is nil or the empty string, time stamps will be left alone. The
  6442. ID property of the original subtree is removed.
  6443. In each clone, all the CLOCK entries will be removed. This
  6444. prevents Org from considering that the clocked times overlap.
  6445. If the original subtree did contain time stamps with a repeater,
  6446. the following will happen:
  6447. - the repeater will be removed in each clone
  6448. - an additional clone will be produced, with the current, unshifted
  6449. date(s) in the entry.
  6450. - the original entry will be placed *after* all the clones, with
  6451. repeater intact.
  6452. - the start days in the repeater in the original entry will be shifted
  6453. to past the last clone.
  6454. In this way you can spell out a number of instances of a repeating task,
  6455. and still retain the repeater to cover future instances of the task.
  6456. As described above, N+1 clones are produced when the original
  6457. subtree has a repeater. Setting N to 0, then, can be used to
  6458. remove the repeater from a subtree and create a shifted clone
  6459. with the original repeater."
  6460. (interactive "nNumber of clones to produce: ")
  6461. (unless (wholenump n) (user-error "Invalid number of replications %s" n))
  6462. (when (org-before-first-heading-p) (user-error "No subtree to clone"))
  6463. (let* ((beg (save-excursion (org-back-to-heading t) (point)))
  6464. (end-of-tree (save-excursion (org-end-of-subtree t t) (point)))
  6465. (shift
  6466. (or shift
  6467. (if (and (not (equal current-prefix-arg '(4)))
  6468. (save-excursion
  6469. (goto-char beg)
  6470. (re-search-forward org-ts-regexp-both end-of-tree t)))
  6471. (read-from-minibuffer
  6472. "Date shift per clone (e.g. +1w, empty to copy unchanged): ")
  6473. ""))) ;No time shift
  6474. (doshift
  6475. (and (org-string-nw-p shift)
  6476. (or (string-match "\\`[ \t]*\\([+-]?[0-9]+\\)\\([hdwmy]\\)[ \t]*\\'"
  6477. shift)
  6478. (user-error "Invalid shift specification %s" shift)))))
  6479. (goto-char end-of-tree)
  6480. (unless (bolp) (insert "\n"))
  6481. (let* ((end (point))
  6482. (template (buffer-substring beg end))
  6483. (shift-n (and doshift (string-to-number (match-string 1 shift))))
  6484. (shift-what (pcase (and doshift (match-string 2 shift))
  6485. (`nil nil)
  6486. ("h" 'hour)
  6487. ("d" 'day)
  6488. ("w" (setq shift-n (* 7 shift-n)) 'day)
  6489. ("m" 'month)
  6490. ("y" 'year)
  6491. (_ (error "Unsupported time unit"))))
  6492. (nmin 1)
  6493. (nmax n)
  6494. (n-no-remove -1)
  6495. (org-id-overriding-file-name (buffer-file-name (buffer-base-buffer)))
  6496. (idprop (org-entry-get beg "ID")))
  6497. (when (and doshift
  6498. (string-match-p "<[^<>\n]+ [.+]?\\+[0-9]+[hdwmy][^<>\n]*>"
  6499. template))
  6500. (delete-region beg end)
  6501. (setq end beg)
  6502. (setq nmin 0)
  6503. (setq nmax (1+ nmax))
  6504. (setq n-no-remove nmax))
  6505. (goto-char end)
  6506. (cl-loop for n from nmin to nmax do
  6507. (insert
  6508. ;; Prepare clone.
  6509. (with-temp-buffer
  6510. (insert template)
  6511. (org-mode)
  6512. (goto-char (point-min))
  6513. (org-fold-show-subtree)
  6514. (and idprop (if org-clone-delete-id
  6515. (org-entry-delete nil "ID")
  6516. (org-id-get-create t)))
  6517. (unless (= n 0)
  6518. (while (re-search-forward org-clock-line-re nil t)
  6519. (delete-region (line-beginning-position)
  6520. (line-beginning-position 2)))
  6521. (goto-char (point-min))
  6522. (while (re-search-forward org-drawer-regexp nil t)
  6523. (org-remove-empty-drawer-at (point))))
  6524. (goto-char (point-min))
  6525. (when doshift
  6526. (while (re-search-forward org-ts-regexp-both nil t)
  6527. (org-timestamp-change (* n shift-n) shift-what))
  6528. (unless (= n n-no-remove)
  6529. (goto-char (point-min))
  6530. (while (re-search-forward org-ts-regexp nil t)
  6531. (save-excursion
  6532. (goto-char (match-beginning 0))
  6533. (when (looking-at "<[^<>\n]+\\( +[.+]?\\+[0-9]+[hdwmy]\\)")
  6534. (delete-region (match-beginning 1) (match-end 1)))))))
  6535. (buffer-string)))))
  6536. (goto-char beg)))
  6537. ;;; Outline path
  6538. (defvar org-outline-path-cache nil
  6539. "Alist between buffer positions and outline paths.
  6540. It value is an alist (POSITION . PATH) where POSITION is the
  6541. buffer position at the beginning of an entry and PATH is a list
  6542. of strings describing the outline path for that entry, in reverse
  6543. order.")
  6544. (defun org--get-outline-path-1 (&optional use-cache)
  6545. "Return outline path to current headline.
  6546. Outline path is a list of strings, in reverse order. When
  6547. optional argument USE-CACHE is non-nil, make use of a cache. See
  6548. `org-get-outline-path' for details.
  6549. Assume buffer is widened and point is on a headline."
  6550. (or (and use-cache (cdr (assq (point) org-outline-path-cache)))
  6551. (let ((p (point))
  6552. (heading (let ((case-fold-search nil))
  6553. (looking-at org-complex-heading-regexp)
  6554. (if (not (match-end 4)) ""
  6555. ;; Remove statistics cookies.
  6556. (org-trim
  6557. (org-link-display-format
  6558. (replace-regexp-in-string
  6559. "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" ""
  6560. (match-string-no-properties 4))))))))
  6561. (if (org-up-heading-safe)
  6562. (let ((path (cons heading (org--get-outline-path-1 use-cache))))
  6563. (when use-cache
  6564. (push (cons p path) org-outline-path-cache))
  6565. path)
  6566. ;; This is a new root node. Since we assume we are moving
  6567. ;; forward, we can drop previous cache so as to limit number
  6568. ;; of associations there.
  6569. (let ((path (list heading)))
  6570. (when use-cache (setq org-outline-path-cache (list (cons p path))))
  6571. path)))))
  6572. (defun org-get-outline-path (&optional with-self use-cache)
  6573. "Return the outline path to the current entry.
  6574. An outline path is a list of ancestors for current headline, as
  6575. a list of strings. Statistics cookies are removed and links are
  6576. replaced with their description, if any, or their path otherwise.
  6577. When optional argument WITH-SELF is non-nil, the path also
  6578. includes the current headline.
  6579. When optional argument USE-CACHE is non-nil, cache outline paths
  6580. between calls to this function so as to avoid backtracking. This
  6581. argument is useful when planning to find more than one outline
  6582. path in the same document. In that case, there are two
  6583. conditions to satisfy:
  6584. - `org-outline-path-cache' is set to nil before starting the
  6585. process;
  6586. - outline paths are computed by increasing buffer positions."
  6587. (org-with-wide-buffer
  6588. (and (or (and with-self (org-back-to-heading t))
  6589. (org-up-heading-safe))
  6590. (reverse (org--get-outline-path-1 use-cache)))))
  6591. (defun org-format-outline-path (path &optional width prefix separator)
  6592. "Format the outline path PATH for display.
  6593. WIDTH is the maximum number of characters that is available.
  6594. PREFIX is a prefix to be included in the returned string,
  6595. such as the file name.
  6596. SEPARATOR is inserted between the different parts of the path,
  6597. the default is \"/\"."
  6598. (setq width (or width 79))
  6599. (setq path (delq nil path))
  6600. (unless (> width 0)
  6601. (user-error "Argument `width' must be positive"))
  6602. (setq separator (or separator "/"))
  6603. (let* ((org-odd-levels-only nil)
  6604. (fpath (concat
  6605. prefix (and prefix path separator)
  6606. (mapconcat
  6607. (lambda (s) (replace-regexp-in-string "[ \t]+\\'" "" s))
  6608. (cl-loop for head in path
  6609. for n from 0
  6610. collect (org-add-props
  6611. head nil 'face
  6612. (nth (% n org-n-level-faces) org-level-faces)))
  6613. separator))))
  6614. (when (> (length fpath) width)
  6615. (if (< width 7)
  6616. ;; It's unlikely that `width' will be this small, but don't
  6617. ;; waste characters by adding ".." if it is.
  6618. (setq fpath (substring fpath 0 width))
  6619. (setf (substring fpath (- width 2)) "..")))
  6620. fpath))
  6621. (defun org-display-outline-path (&optional file current separator just-return-string)
  6622. "Display the current outline path in the echo area.
  6623. If FILE is non-nil, prepend the output with the file name.
  6624. If CURRENT is non-nil, append the current heading to the output.
  6625. SEPARATOR is passed through to `org-format-outline-path'. It separates
  6626. the different parts of the path and defaults to \"/\".
  6627. If JUST-RETURN-STRING is non-nil, return a string, don't display a message."
  6628. (interactive "P")
  6629. (let* (case-fold-search
  6630. (bfn (buffer-file-name (buffer-base-buffer)))
  6631. (path (and (derived-mode-p 'org-mode) (org-get-outline-path)))
  6632. res)
  6633. (when current (setq path (append path
  6634. (save-excursion
  6635. (org-back-to-heading t)
  6636. (when (looking-at org-complex-heading-regexp)
  6637. (list (match-string 4)))))))
  6638. (setq res
  6639. (org-format-outline-path
  6640. path
  6641. (1- (frame-width))
  6642. (and file bfn (concat (file-name-nondirectory bfn) separator))
  6643. separator))
  6644. (add-face-text-property 0 (length res)
  6645. `(:height ,(face-attribute 'default :height))
  6646. nil res)
  6647. (if just-return-string
  6648. res
  6649. (org-unlogged-message "%s" res))))
  6650. ;;; Outline Sorting
  6651. (defun org-sort (&optional with-case)
  6652. "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
  6653. Optional argument WITH-CASE means sort case-sensitively."
  6654. (interactive "P")
  6655. (org-call-with-arg
  6656. (cond ((org-at-table-p) #'org-table-sort-lines)
  6657. ((org-at-item-p) #'org-sort-list)
  6658. (t #'org-sort-entries))
  6659. with-case))
  6660. (defun org-sort-remove-invisible (s)
  6661. "Remove emphasis markers and any invisible property from string S.
  6662. Assume S may contain only objects."
  6663. ;; org-element-interpret-data clears any text property, including
  6664. ;; invisible part.
  6665. (org-element-interpret-data
  6666. (let ((tree (org-element-parse-secondary-string
  6667. s (org-element-restriction 'paragraph))))
  6668. (org-element-map tree '(bold code italic link strike-through underline verbatim)
  6669. (lambda (o)
  6670. (pcase (org-element-type o)
  6671. ;; Terminal object. Replace it with its value.
  6672. ((or `code `verbatim)
  6673. (let ((new (org-element-property :value o)))
  6674. (org-element-insert-before new o)
  6675. (org-element-put-property
  6676. new :post-blank (org-element-property :post-blank o))))
  6677. ;; Non-terminal objects. Splice contents.
  6678. (type
  6679. (let ((contents
  6680. (or (org-element-contents o)
  6681. (and (eq type 'link)
  6682. (list (org-element-property :raw-link o)))))
  6683. (c nil))
  6684. (while contents
  6685. (setq c (pop contents))
  6686. (org-element-insert-before c o))
  6687. (org-element-put-property
  6688. c :post-blank (org-element-property :post-blank o)))))
  6689. (org-element-extract-element o)))
  6690. ;; Return modified tree.
  6691. tree)))
  6692. (defvar org-after-sorting-entries-or-items-hook nil
  6693. "Hook that is run after a bunch of entries or items have been sorted.
  6694. When children are sorted, the cursor is in the parent line when this
  6695. hook gets called. When a region or a plain list is sorted, the cursor
  6696. will be in the first entry of the sorted region/list.")
  6697. (defun org-sort-entries
  6698. (&optional with-case sorting-type getkey-func compare-func property
  6699. interactive?)
  6700. "Sort entries on a certain level of an outline tree.
  6701. If there is an active region, the entries in the region are sorted.
  6702. Else, if the cursor is before the first entry, sort the top-level items.
  6703. Else, the children of the entry at point are sorted.
  6704. Sorting can be alphabetically, numerically, by date/time as given by
  6705. a time stamp, by a property, by priority order, or by a custom function.
  6706. The command prompts for the sorting type unless it has been given to the
  6707. function through the SORTING-TYPE argument, which needs to be a character,
  6708. \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?o ?O ?r ?R ?f ?F ?k ?K). Here is
  6709. the precise meaning of each character:
  6710. a Alphabetically, ignoring the TODO keyword and the priority, if any.
  6711. c By creation time, which is assumed to be the first inactive time stamp
  6712. at the beginning of a line.
  6713. d By deadline date/time.
  6714. k By clocking time.
  6715. n Numerically, by converting the beginning of the entry/item to a number.
  6716. o By order of TODO keywords.
  6717. p By priority according to the cookie.
  6718. r By the value of a property.
  6719. s By scheduled date/time.
  6720. t By date/time, either the first active time stamp in the entry, or, if
  6721. none exist, by the first inactive one.
  6722. Capital letters will reverse the sort order.
  6723. If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
  6724. called with point at the beginning of the record. It must return a
  6725. value that is compatible with COMPARE-FUNC, the function used to
  6726. compare entries.
  6727. Comparing entries ignores case by default. However, with an optional argument
  6728. WITH-CASE, the sorting considers case as well.
  6729. Sorting is done against the visible part of the headlines, it ignores hidden
  6730. links.
  6731. When sorting is done, call `org-after-sorting-entries-or-items-hook'.
  6732. A non-nil value for INTERACTIVE? is used to signal that this
  6733. function is being called interactively."
  6734. (interactive (list current-prefix-arg nil nil nil nil t))
  6735. (let ((case-func (if with-case 'identity 'downcase))
  6736. start beg end stars re re2
  6737. txt what tmp)
  6738. ;; Find beginning and end of region to sort
  6739. (cond
  6740. ((org-region-active-p)
  6741. ;; we will sort the region
  6742. (setq end (region-end)
  6743. what "region")
  6744. (goto-char (region-beginning))
  6745. (unless (org-at-heading-p) (outline-next-heading))
  6746. (setq start (point)))
  6747. ((or (org-at-heading-p)
  6748. (ignore-errors (progn (org-back-to-heading) t)))
  6749. ;; we will sort the children of the current headline
  6750. (org-back-to-heading)
  6751. (setq start (point)
  6752. end (progn (org-end-of-subtree t t)
  6753. (or (bolp) (insert "\n"))
  6754. (when (>= (org-back-over-empty-lines) 1)
  6755. (forward-line 1))
  6756. (point))
  6757. what "children")
  6758. (goto-char start)
  6759. (org-fold-show-subtree)
  6760. (outline-next-heading))
  6761. (t
  6762. ;; we will sort the top-level entries in this file
  6763. (goto-char (point-min))
  6764. (or (org-at-heading-p) (outline-next-heading))
  6765. (setq start (point))
  6766. (goto-char (point-max))
  6767. (beginning-of-line 1)
  6768. (when (looking-at ".*?\\S-")
  6769. ;; File ends in a non-white line
  6770. (end-of-line 1)
  6771. (insert "\n"))
  6772. (setq end (point-max))
  6773. (setq what "top-level")
  6774. (goto-char start)
  6775. (org-fold-show-all '(headings drawers blocks))))
  6776. (setq beg (point))
  6777. (when (>= beg end) (goto-char start) (user-error "Nothing to sort"))
  6778. (looking-at "\\(\\*+\\)")
  6779. (setq stars (match-string 1)
  6780. re (concat "^" (regexp-quote stars) " +")
  6781. re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[ \t\n]")
  6782. txt (buffer-substring beg end))
  6783. (unless (equal (substring txt -1) "\n") (setq txt (concat txt "\n")))
  6784. (when (and (not (equal stars "*")) (string-match re2 txt))
  6785. (user-error "Region to sort contains a level above the first entry"))
  6786. (unless sorting-type
  6787. (message
  6788. "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
  6789. [t]ime [s]cheduled [d]eadline [c]reated cloc[k]ing
  6790. A/N/P/R/O/F/T/S/D/C/K means reversed:"
  6791. what)
  6792. (setq sorting-type (read-char-exclusive)))
  6793. (unless getkey-func
  6794. (and (= (downcase sorting-type) ?f)
  6795. (setq getkey-func
  6796. (or (and interactive?
  6797. (org-read-function
  6798. "Function for extracting keys: "))
  6799. (error "Missing key extractor")))))
  6800. (and (= (downcase sorting-type) ?r)
  6801. (not property)
  6802. (setq property
  6803. (completing-read "Property: "
  6804. (mapcar #'list (org-buffer-property-keys t))
  6805. nil t)))
  6806. (when (member sorting-type '(?k ?K)) (org-clock-sum))
  6807. (message "Sorting entries...")
  6808. (save-restriction
  6809. (narrow-to-region start end)
  6810. (let ((restore-clock?
  6811. ;; The clock marker is lost when using `sort-subr'; mark
  6812. ;; the clock with temporary `:org-clock-marker-backup'
  6813. ;; text property.
  6814. (when (and (eq (org-clocking-buffer) (current-buffer))
  6815. (<= start (marker-position org-clock-marker))
  6816. (>= end (marker-position org-clock-marker)))
  6817. (with-silent-modifications
  6818. (put-text-property (1- org-clock-marker) org-clock-marker
  6819. :org-clock-marker-backup t))
  6820. t))
  6821. (dcst (downcase sorting-type))
  6822. (case-fold-search nil)
  6823. (now (current-time)))
  6824. (org-preserve-local-variables
  6825. (sort-subr
  6826. (/= dcst sorting-type)
  6827. ;; This function moves to the beginning character of the
  6828. ;; "record" to be sorted.
  6829. (lambda nil
  6830. (if (re-search-forward re nil t)
  6831. (goto-char (match-beginning 0))
  6832. (goto-char (point-max))))
  6833. ;; This function moves to the last character of the "record" being
  6834. ;; sorted.
  6835. (lambda nil
  6836. (save-match-data
  6837. (condition-case nil
  6838. (outline-forward-same-level 1)
  6839. (error
  6840. (goto-char (point-max))))))
  6841. ;; This function returns the value that gets sorted against.
  6842. (lambda ()
  6843. (cond
  6844. ((= dcst ?n)
  6845. (string-to-number
  6846. (org-sort-remove-invisible (org-get-heading t t t t))))
  6847. ((= dcst ?a)
  6848. (funcall case-func
  6849. (org-sort-remove-invisible (org-get-heading t t t t))))
  6850. ((= dcst ?k)
  6851. (or (get-text-property (point) :org-clock-minutes) 0))
  6852. ((= dcst ?t)
  6853. (let ((end (save-excursion (outline-next-heading) (point))))
  6854. (if (or (re-search-forward org-ts-regexp end t)
  6855. (re-search-forward org-ts-regexp-both end t))
  6856. (org-time-string-to-seconds (match-string 0))
  6857. (float-time now))))
  6858. ((= dcst ?c)
  6859. (let ((end (save-excursion (outline-next-heading) (point))))
  6860. (if (re-search-forward
  6861. (concat "^[ \t]*\\[" org-ts-regexp1 "\\]")
  6862. end t)
  6863. (org-time-string-to-seconds (match-string 0))
  6864. (float-time now))))
  6865. ((= dcst ?s)
  6866. (let ((end (save-excursion (outline-next-heading) (point))))
  6867. (if (re-search-forward org-scheduled-time-regexp end t)
  6868. (org-time-string-to-seconds (match-string 1))
  6869. (float-time now))))
  6870. ((= dcst ?d)
  6871. (let ((end (save-excursion (outline-next-heading) (point))))
  6872. (if (re-search-forward org-deadline-time-regexp end t)
  6873. (org-time-string-to-seconds (match-string 1))
  6874. (float-time now))))
  6875. ((= dcst ?p)
  6876. (if (re-search-forward org-priority-regexp (line-end-position) t)
  6877. (string-to-char (match-string 2))
  6878. org-priority-default))
  6879. ((= dcst ?r)
  6880. (or (org-entry-get nil property) ""))
  6881. ((= dcst ?o)
  6882. (when (looking-at org-complex-heading-regexp)
  6883. (let* ((m (match-string 2))
  6884. (s (if (member m org-done-keywords) '- '+)))
  6885. (- 99 (funcall s (length (member m org-todo-keywords-1)))))))
  6886. ((= dcst ?f)
  6887. (if getkey-func
  6888. (progn
  6889. (setq tmp (funcall getkey-func))
  6890. (when (stringp tmp) (setq tmp (funcall case-func tmp)))
  6891. tmp)
  6892. (error "Invalid key function `%s'" getkey-func)))
  6893. (t (error "Invalid sorting type `%c'" sorting-type))))
  6894. nil
  6895. (cond
  6896. ((= dcst ?a) 'string-collate-lessp)
  6897. ((= dcst ?f)
  6898. (or compare-func
  6899. (and interactive?
  6900. (org-read-function
  6901. (concat "Function for comparing keys "
  6902. "(empty for default `sort-subr' predicate): ")
  6903. 'allow-empty))))
  6904. ((member dcst '(?p ?t ?s ?d ?c ?k)) '<))))
  6905. (org-cycle-hide-drawers 'all)
  6906. (when restore-clock?
  6907. (move-marker org-clock-marker
  6908. (1+ (next-single-property-change
  6909. start :org-clock-marker-backup)))
  6910. (remove-text-properties (1- org-clock-marker) org-clock-marker
  6911. '(:org-clock-marker-backup t)))))
  6912. (run-hooks 'org-after-sorting-entries-or-items-hook)
  6913. (message "Sorting entries...done")))
  6914. (defun org-contextualize-keys (alist contexts)
  6915. "Return valid elements in ALIST depending on CONTEXTS.
  6916. `org-agenda-custom-commands' or `org-capture-templates' are the
  6917. values used for ALIST, and `org-agenda-custom-commands-contexts'
  6918. or `org-capture-templates-contexts' are the associated contexts
  6919. definitions."
  6920. (let ((contexts
  6921. ;; normalize contexts
  6922. (mapcar
  6923. (lambda(c) (cond ((listp (cadr c))
  6924. (list (car c) (car c) (nth 1 c)))
  6925. ((string= "" (cadr c))
  6926. (list (car c) (car c) (nth 2 c)))
  6927. (t c)))
  6928. contexts))
  6929. (a alist) r s)
  6930. ;; loop over all commands or templates
  6931. (dolist (c a)
  6932. (let (vrules repl)
  6933. (cond
  6934. ((not (assoc (car c) contexts))
  6935. (push c r))
  6936. ((and (assoc (car c) contexts)
  6937. (setq vrules (org-contextualize-validate-key
  6938. (car c) contexts)))
  6939. (mapc (lambda (vr)
  6940. (unless (equal (car vr) (cadr vr))
  6941. (setq repl vr)))
  6942. vrules)
  6943. (if (not repl) (push c r)
  6944. (push (cadr repl) s)
  6945. (push
  6946. (cons (car c)
  6947. (cdr (or (assoc (cadr repl) alist)
  6948. (error "Undefined key `%s' as contextual replacement for `%s'"
  6949. (cadr repl) (car c)))))
  6950. r))))))
  6951. ;; Return limited ALIST, possibly with keys modified, and deduplicated
  6952. (delq
  6953. nil
  6954. (delete-dups
  6955. (mapcar (lambda (x)
  6956. (let ((tpl (car x)))
  6957. (unless (delq
  6958. nil
  6959. (mapcar (lambda (y)
  6960. (equal y tpl))
  6961. s))
  6962. x)))
  6963. (reverse r))))))
  6964. (defun org-contextualize-validate-key (key contexts)
  6965. "Check CONTEXTS for agenda or capture KEY."
  6966. (let (res)
  6967. (dolist (r contexts)
  6968. (dolist (rr (car (last r)))
  6969. (when
  6970. (and (equal key (car r))
  6971. (if (functionp rr) (funcall rr)
  6972. (or (and (eq (car rr) 'in-file)
  6973. (buffer-file-name)
  6974. (string-match (cdr rr) (buffer-file-name)))
  6975. (and (eq (car rr) 'in-mode)
  6976. (string-match (cdr rr) (symbol-name major-mode)))
  6977. (and (eq (car rr) 'in-buffer)
  6978. (string-match (cdr rr) (buffer-name)))
  6979. (when (and (eq (car rr) 'not-in-file)
  6980. (buffer-file-name))
  6981. (not (string-match (cdr rr) (buffer-file-name))))
  6982. (when (eq (car rr) 'not-in-mode)
  6983. (not (string-match (cdr rr) (symbol-name major-mode))))
  6984. (when (eq (car rr) 'not-in-buffer)
  6985. (not (string-match (cdr rr) (buffer-name)))))))
  6986. (push r res))))
  6987. (delete-dups (delq nil res))))
  6988. ;; Defined to provide a value for defcustom, since there is no
  6989. ;; string-collate-greaterp in Emacs.
  6990. (defun org-string-collate-greaterp (s1 s2)
  6991. "Return non-nil if S1 is greater than S2 in collation order."
  6992. (not (string-collate-lessp s1 s2)))
  6993. ;;;###autoload
  6994. (defun org-run-like-in-org-mode (cmd)
  6995. "Run a command, pretending that the current buffer is in Org mode.
  6996. This will temporarily bind local variables that are typically bound in
  6997. Org mode to the values they have in Org mode, and then interactively
  6998. call CMD."
  6999. (org-load-modules-maybe)
  7000. (let (vars vals)
  7001. (dolist (var (org-get-local-variables))
  7002. (when (or (not (boundp (car var)))
  7003. (eq (symbol-value (car var))
  7004. (default-value (car var))))
  7005. (push (car var) vars)
  7006. (push (cadr var) vals)))
  7007. (cl-progv vars vals
  7008. (call-interactively cmd))))
  7009. (defun org-get-category (&optional pos force-refresh)
  7010. "Get the category applying to position POS."
  7011. (save-match-data
  7012. (when force-refresh (org-refresh-category-properties))
  7013. (let ((pos (or pos (point))))
  7014. (if (org-element--cache-active-p)
  7015. ;; Sync cache.
  7016. (org-with-point-at (org-element-property :begin (org-element-at-point pos))
  7017. (or (org-entry-get-with-inheritance "CATEGORY")
  7018. "???"))
  7019. (or (get-text-property pos 'org-category)
  7020. (progn
  7021. (org-refresh-category-properties)
  7022. (get-text-property pos 'org-category)))))))
  7023. ;;; Refresh properties
  7024. (defun org-refresh-properties (dprop tprop)
  7025. "Refresh buffer text properties.
  7026. DPROP is the drawer property and TPROP is either the
  7027. corresponding text property to set, or an alist with each element
  7028. being a text property (as a symbol) and a function to apply to
  7029. the value of the drawer property."
  7030. (let* ((case-fold-search t)
  7031. (inhibit-read-only t)
  7032. (inherit? (org-property-inherit-p dprop))
  7033. (property-re (org-re-property (concat (regexp-quote dprop) "\\+?") t))
  7034. (global-or-keyword (and inherit?
  7035. (org--property-global-or-keyword-value dprop nil))))
  7036. (with-silent-modifications
  7037. (org-with-point-at 1
  7038. ;; Set global and keyword based values to the whole buffer.
  7039. (when global-or-keyword
  7040. (put-text-property (point-min) (point-max) tprop global-or-keyword))
  7041. ;; Set values based on property-drawers throughout the document.
  7042. (while (re-search-forward property-re nil t)
  7043. (when (org-at-property-p)
  7044. (org-refresh-property tprop (org-entry-get (point) dprop) inherit?))
  7045. (outline-next-heading))))))
  7046. (defun org-refresh-property (tprop p &optional inherit)
  7047. "Refresh the buffer text property TPROP from the drawer property P.
  7048. The refresh happens only for the current entry, or the whole
  7049. sub-tree if optional argument INHERIT is non-nil.
  7050. If point is before first headline, the function applies to the
  7051. part before the first headline. In that particular case, when
  7052. optional argument INHERIT is non-nil, it refreshes properties for
  7053. the whole buffer."
  7054. (save-excursion
  7055. (org-back-to-heading-or-point-min t)
  7056. (let ((start (point))
  7057. (end (save-excursion
  7058. (cond ((and inherit (org-before-first-heading-p))
  7059. (point-max))
  7060. (inherit
  7061. (org-end-of-subtree t t))
  7062. ((outline-next-heading))
  7063. ((point-max))))))
  7064. (with-silent-modifications
  7065. (if (symbolp tprop)
  7066. ;; TPROP is a text property symbol.
  7067. (put-text-property start end tprop p)
  7068. ;; TPROP is an alist with (property . function) elements.
  7069. (pcase-dolist (`(,prop . ,f) tprop)
  7070. (put-text-property start end prop (funcall f p))))))))
  7071. (defun org-refresh-category-properties ()
  7072. "Refresh category text properties in the buffer."
  7073. (unless (org-element--cache-active-p)
  7074. (let ((case-fold-search t)
  7075. (inhibit-read-only t)
  7076. (default-category
  7077. (cond ((null org-category)
  7078. (if buffer-file-name
  7079. (file-name-sans-extension
  7080. (file-name-nondirectory buffer-file-name))
  7081. "???"))
  7082. ((symbolp org-category) (symbol-name org-category))
  7083. (t org-category))))
  7084. (let ((category (catch 'buffer-category
  7085. (org-with-wide-buffer
  7086. (goto-char (point-max))
  7087. (while (re-search-backward "^[ \t]*#\\+CATEGORY:" (point-min) t)
  7088. (let ((element (org-element-at-point-no-context)))
  7089. (when (eq (org-element-type element) 'keyword)
  7090. (throw 'buffer-category
  7091. (org-element-property :value element))))))
  7092. default-category)))
  7093. (with-silent-modifications
  7094. (org-with-wide-buffer
  7095. ;; Set buffer-wide property from keyword. Search last #+CATEGORY
  7096. ;; keyword. If none is found, fall-back to `org-category' or
  7097. ;; buffer file name, or set it by the document property drawer.
  7098. (put-text-property (point-min) (point-max)
  7099. 'org-category category)
  7100. ;; Set categories from the document property drawer or
  7101. ;; property drawers in the outline. If category is found in
  7102. ;; the property drawer for the whole buffer that value
  7103. ;; overrides the keyword-based value set above.
  7104. (goto-char (point-min))
  7105. (let ((regexp (org-re-property "CATEGORY")))
  7106. (while (re-search-forward regexp nil t)
  7107. (let ((value (match-string-no-properties 3)))
  7108. (when (org-at-property-p)
  7109. (put-text-property
  7110. (save-excursion (org-back-to-heading-or-point-min t))
  7111. (save-excursion (if (org-before-first-heading-p)
  7112. (point-max)
  7113. (org-end-of-subtree t t)))
  7114. 'org-category
  7115. value)))))))))))
  7116. (defun org-refresh-stats-properties ()
  7117. "Refresh stats text properties in the buffer."
  7118. (with-silent-modifications
  7119. (org-with-point-at 1
  7120. (let ((regexp (concat org-outline-regexp-bol
  7121. ".*\\[\\([0-9]*\\)\\(?:%\\|/\\([0-9]*\\)\\)\\]")))
  7122. (while (re-search-forward regexp nil t)
  7123. (let* ((numerator (string-to-number (match-string 1)))
  7124. (denominator (and (match-end 2)
  7125. (string-to-number (match-string 2))))
  7126. (stats (cond ((not denominator) numerator) ;percent
  7127. ((= denominator 0) 0)
  7128. (t (/ (* numerator 100) denominator)))))
  7129. (put-text-property (point) (progn (org-end-of-subtree t t) (point))
  7130. 'org-stats stats)))))))
  7131. (defun org-refresh-effort-properties ()
  7132. "Refresh effort properties."
  7133. (org-refresh-properties
  7134. org-effort-property
  7135. '((effort . identity)
  7136. (effort-minutes . org-duration-to-minutes))))
  7137. (defun org-find-file-at-mouse (ev)
  7138. "Open file link or URL at mouse."
  7139. (interactive "e")
  7140. (mouse-set-point ev)
  7141. (org-open-at-point 'in-emacs))
  7142. (defun org-open-at-mouse (ev)
  7143. "Open file link or URL at mouse.
  7144. See the docstring of `org-open-file' for details."
  7145. (interactive "e")
  7146. (mouse-set-point ev)
  7147. (when (eq major-mode 'org-agenda-mode)
  7148. (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
  7149. (org-open-at-point))
  7150. (defvar org-window-config-before-follow-link nil
  7151. "The window configuration before following a link.
  7152. This is saved in case the need arises to restore it.")
  7153. (defun org--file-default-apps ()
  7154. "Return the default applications for this operating system."
  7155. (pcase system-type
  7156. (`darwin org-file-apps-macos)
  7157. (`windows-nt org-file-apps-windowsnt)
  7158. (_ org-file-apps-gnu)))
  7159. (defun org--file-apps-entry-locator-p (entry)
  7160. "Non-nil if ENTRY should be matched against the link by `org-open-file'.
  7161. It assumes that is the case when the entry uses a regular
  7162. expression which has at least one grouping construct and the
  7163. action is either a Lisp form or a command string containing
  7164. \"%1\", i.e., using at least one subexpression match as
  7165. a parameter."
  7166. (pcase entry
  7167. (`(,selector . ,action)
  7168. (and (stringp selector)
  7169. (> (regexp-opt-depth selector) 0)
  7170. (or (and (stringp action)
  7171. (string-match "%[0-9]" action))
  7172. (functionp action))))
  7173. (_ nil)))
  7174. (defun org--file-apps-regexp-alist (list &optional add-auto-mode)
  7175. "Convert extensions to regular expressions in the cars of LIST.
  7176. Also, weed out any non-string entries, because the return value
  7177. is used only for regexp matching.
  7178. When ADD-AUTO-MODE is non-nil, make all matches in `auto-mode-alist'
  7179. point to the symbol `emacs', indicating that the file should be
  7180. opened in Emacs."
  7181. (append
  7182. (delq nil
  7183. (mapcar (lambda (x)
  7184. (unless (not (stringp (car x)))
  7185. (if (string-match "\\W" (car x))
  7186. x
  7187. (cons (concat "\\." (car x) "\\'") (cdr x)))))
  7188. list))
  7189. (when add-auto-mode
  7190. (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
  7191. (defun org--open-file-format-command
  7192. (mailcap-command file link match-data)
  7193. "Format MAILCAP-COMMAND to launch viewer for the FILE.
  7194. MAILCAP-COMMAND may be an entry from the `org-file-apps' list or viewer
  7195. field from mailcap file loaded to `mailcap-mime-data'. See \"RFC
  7196. 1524. A User Agent Configuration Mechanism For Multimedia Mail Format
  7197. Information\" (URL `https://www.rfc-editor.org/rfc/rfc1524.html') for
  7198. details, man page `mailcap(5)' for brief summary, and Info node
  7199. `(emacs-mime) mailcap' for specific related to Emacs. Only a part of
  7200. mailcap specification is supported.
  7201. The following substitutions are interpolated in the MAILCAP-COMMAND
  7202. string:
  7203. - \"%s\" to FILE name passed through
  7204. `convert-standard-filename', so it must be absolute path.
  7205. - \"%1\" to \"%9\" groups from MATCH-DATA found in the LINK string by
  7206. the regular expression in the key part of the `org-file-apps' entry.
  7207. (performed by caller). Not recommended, consider a lisp function
  7208. instead of a shell command. For example, the following link in an
  7209. Org file
  7210. <file:///usr/share/doc/bash/bashref.pdf::#Redirections::allocate a file>
  7211. may be handled by an `org-file-apps' entry like
  7212. (\"\\\\.pdf\\\\(?:\\\\.[gx]z\\\\|\\\\.bz2\\\\)?::\\\\(#[^:]+\\\\)::\\\\(.+\\\\)\\\\\\='\"
  7213. . \"okular --find %2 %s%1\")
  7214. Use backslash \"\\\" to quote percent \"%\" or any other character
  7215. including backslash itself.
  7216. In addition, each argument is passed through `shell-quote-argument',
  7217. so quotes around substitutions should not be used. For compliance
  7218. with mailcap files shipped e.g. in Debian GNU/Linux, single or double
  7219. quotes around substitutions are stripped. It deviates from mailcap
  7220. specification that requires file name to be safe for shell and for the
  7221. application."
  7222. (let ((spec (list (cons ?s (convert-standard-filename file))))
  7223. (ngroups (min 9 (- (/ (length match-data) 2) 1))))
  7224. (when (> ngroups 0)
  7225. (set-match-data match-data)
  7226. (dolist (i (number-sequence 1 ngroups))
  7227. (push (cons (+ ?0 i) (match-string-no-properties i link)) spec)))
  7228. (replace-regexp-in-string
  7229. (rx (or (and "\\" (or (group anything) string-end))
  7230. (and (optional (group (any "'\"")))
  7231. "%"
  7232. (or (group anything) string-end)
  7233. (optional (group (backref 2))))))
  7234. (lambda (fmt)
  7235. (let* ((backslash (match-string-no-properties 1 fmt))
  7236. (key (match-string 3 fmt))
  7237. (value (and key (alist-get (string-to-char key) spec))))
  7238. (cond
  7239. (backslash)
  7240. (value (let ((quot (match-string 2 fmt))
  7241. (subst (shell-quote-argument value)))
  7242. ;; Remove quotes around the file name - we use
  7243. ;; `shell-quote-argument'.
  7244. (if (match-string 4 fmt)
  7245. subst
  7246. (concat quot subst))))
  7247. (t (error "Invalid format `%s'" fmt)))))
  7248. mailcap-command nil 'literal)))
  7249. ;;;###autoload
  7250. (defun org-open-file (path &optional in-emacs line search)
  7251. "Open the file at PATH.
  7252. First, this expands any special file name abbreviations. Then the
  7253. configuration variable `org-file-apps' is checked if it contains an
  7254. entry for this file type, and if yes, the corresponding command is launched.
  7255. If no application is found, Emacs simply visits the file.
  7256. With optional prefix argument IN-EMACS, Emacs will visit the file.
  7257. With a double \\[universal-argument] \\[universal-argument] \
  7258. prefix arg, Org tries to avoid opening in Emacs
  7259. and to use an external application to visit the file.
  7260. Optional LINE specifies a line to go to, optional SEARCH a string
  7261. to search for. If LINE or SEARCH is given, the file will be
  7262. opened in Emacs, unless an entry from `org-file-apps' that makes
  7263. use of groups in a regexp matches.
  7264. If you want to change the way frames are used when following a
  7265. link, please customize `org-link-frame-setup'.
  7266. If the file does not exist, throw an error."
  7267. (let* ((file (if (equal path "") buffer-file-name
  7268. (substitute-in-file-name (expand-file-name path))))
  7269. (file-apps (append org-file-apps (org--file-default-apps)))
  7270. (apps (cl-remove-if #'org--file-apps-entry-locator-p file-apps))
  7271. (apps-locator (cl-remove-if-not #'org--file-apps-entry-locator-p
  7272. file-apps))
  7273. (remp (and (assq 'remote apps) (file-remote-p file)))
  7274. (dirp (unless remp (file-directory-p file)))
  7275. (file (if (and dirp org-open-directory-means-index-dot-org)
  7276. (concat (file-name-as-directory file) "index.org")
  7277. file))
  7278. (a-m-a-p (assq 'auto-mode apps))
  7279. (dfile (downcase file))
  7280. ;; Reconstruct the original link from the PATH, LINE and
  7281. ;; SEARCH args.
  7282. (link (cond (line (concat file "::" (number-to-string line)))
  7283. (search (concat file "::" search))
  7284. (t file)))
  7285. (ext
  7286. (and (string-match "\\`.*?\\.\\([a-zA-Z0-9]+\\(\\.gz\\)?\\)\\'" dfile)
  7287. (match-string 1 dfile)))
  7288. (save-position-maybe
  7289. (let ((old-buffer (current-buffer))
  7290. (old-pos (point))
  7291. (old-mode major-mode))
  7292. (lambda ()
  7293. (and (derived-mode-p 'org-mode)
  7294. (eq old-mode 'org-mode)
  7295. (or (not (eq old-buffer (current-buffer)))
  7296. (not (eq old-pos (point))))
  7297. (org-mark-ring-push old-pos old-buffer)))))
  7298. cmd link-match-data)
  7299. (cond
  7300. ((member in-emacs '((16) system))
  7301. (setq cmd (cdr (assq 'system apps))))
  7302. (in-emacs (setq cmd 'emacs))
  7303. (t
  7304. (setq cmd (or (and remp (cdr (assq 'remote apps)))
  7305. (and dirp (cdr (assq 'directory apps)))
  7306. ;; First, try matching against apps-locator if we
  7307. ;; get a match here, store the match data for
  7308. ;; later.
  7309. (let* ((case-fold-search t)
  7310. (match (assoc-default link apps-locator
  7311. 'string-match)))
  7312. (if match
  7313. (progn (setq link-match-data (match-data))
  7314. match)
  7315. (progn (setq in-emacs (or in-emacs line search))
  7316. nil))) ; if we have no match in apps-locator,
  7317. ; always open the file in emacs if line or search
  7318. ; is given (for backwards compatibility)
  7319. (assoc-default dfile
  7320. (org--file-apps-regexp-alist apps a-m-a-p)
  7321. 'string-match)
  7322. (cdr (assoc ext apps))
  7323. (cdr (assq t apps))))))
  7324. (when (eq cmd 'system)
  7325. (setq cmd (cdr (assq 'system apps))))
  7326. (when (eq cmd 'default)
  7327. (setq cmd (cdr (assoc t apps))))
  7328. (when (eq cmd 'mailcap)
  7329. (require 'mailcap)
  7330. (mailcap-parse-mailcaps)
  7331. (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
  7332. (command (mailcap-mime-info mime-type)))
  7333. (if (stringp command)
  7334. (setq cmd command)
  7335. (setq cmd 'emacs))))
  7336. (when (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
  7337. (not (file-exists-p file))
  7338. (not org-open-non-existing-files))
  7339. (user-error "No such file: %s" file))
  7340. (cond
  7341. ((org-string-nw-p cmd)
  7342. (setq cmd (org--open-file-format-command cmd file link link-match-data))
  7343. (save-window-excursion
  7344. (message "Running %s...done" cmd)
  7345. ;; Handlers such as "gio open" and kde-open5 start viewer in background
  7346. ;; and exit immediately. Use pipe connection type instead of pty to
  7347. ;; avoid killing children processes with SIGHUP when temporary terminal
  7348. ;; session is finished.
  7349. ;;
  7350. ;; TODO: Once minimum Emacs version is 25.1 or above, consider using
  7351. ;; the `make-process' invocation from 5db61eb0f929 to get more helpful
  7352. ;; error messages.
  7353. (let ((process-connection-type nil))
  7354. (start-process-shell-command cmd nil cmd))
  7355. (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))))
  7356. ((or (stringp cmd)
  7357. (eq cmd 'emacs))
  7358. (funcall (cdr (assq 'file org-link-frame-setup)) file)
  7359. (widen)
  7360. (cond (line (org-goto-line line)
  7361. (when (derived-mode-p 'org-mode) (org-fold-reveal)))
  7362. (search (condition-case err
  7363. (org-link-search search)
  7364. ;; Save position before error-ing out so user
  7365. ;; can easily move back to the original buffer.
  7366. (error (funcall save-position-maybe)
  7367. (error (nth 1 err)))))))
  7368. ((functionp cmd)
  7369. (save-match-data
  7370. (set-match-data link-match-data)
  7371. (condition-case nil
  7372. (funcall cmd file link)
  7373. ;; FIXME: Remove this check when most default installations
  7374. ;; of Emacs have at least Org 9.0.
  7375. ((debug wrong-number-of-arguments wrong-type-argument
  7376. invalid-function)
  7377. (user-error "Please see Org News for version 9.0 about \
  7378. `org-file-apps'--Lisp error: %S" cmd)))))
  7379. ((consp cmd)
  7380. ;; FIXME: Remove this check when most default installations of
  7381. ;; Emacs have at least Org 9.0. Heads-up instead of silently
  7382. ;; fall back to `org-link-frame-setup' for an old usage of
  7383. ;; `org-file-apps' with sexp instead of a function for `cmd'.
  7384. (user-error "Please see Org News for version 9.0 about \
  7385. `org-file-apps'--Error: Deprecated usage of %S" cmd))
  7386. (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
  7387. (funcall save-position-maybe)))
  7388. ;;;###autoload
  7389. (defun org-open-at-point-global ()
  7390. "Follow a link or a time-stamp like Org mode does.
  7391. Also follow links and emails as seen by `thing-at-point'.
  7392. This command can be called in any mode to follow an external
  7393. link or a time-stamp that has Org mode syntax. Its behavior
  7394. is undefined when called on internal links like fuzzy links.
  7395. Raise a user error when there is nothing to follow."
  7396. (interactive)
  7397. (let ((tap-url (thing-at-point 'url))
  7398. (tap-email (thing-at-point 'email)))
  7399. (cond ((org-in-regexp org-link-any-re)
  7400. (org-link-open-from-string (match-string-no-properties 0)))
  7401. ((or (org-in-regexp org-ts-regexp-both nil t)
  7402. (org-in-regexp org-tsr-regexp-both nil t))
  7403. (org-follow-timestamp-link))
  7404. (tap-url (org-link-open-from-string tap-url))
  7405. (tap-email (org-link-open-from-string
  7406. (concat "mailto:" tap-email)))
  7407. (t (user-error "No link found")))))
  7408. (defvar org-open-at-point-functions nil
  7409. "Hook that is run when following a link at point.
  7410. Functions in this hook must return t if they identify and follow
  7411. a link at point. If they don't find anything interesting at point,
  7412. they must return nil.")
  7413. (defun org-open-at-point (&optional arg)
  7414. "Open thing at point.
  7415. The thing can be a link, citation, timestamp, footnote, src-block or
  7416. tags.
  7417. When point is on a link, follow it. Normally, files will be
  7418. opened by an appropriate application. If the optional prefix
  7419. argument ARG is non-nil, Emacs will visit the file. With
  7420. a double prefix argument, try to open outside of Emacs, in the
  7421. application the system uses for this file type.
  7422. When point is on a timestamp, open the agenda at the day
  7423. specified.
  7424. When point is a footnote definition, move to the first reference
  7425. found. If it is on a reference, move to the associated
  7426. definition.
  7427. When point is on a src-block of inline src-block, open its result.
  7428. When point is on a citation, follow it.
  7429. When point is on a headline, display a list of every link in the
  7430. entry, so it is possible to pick one, or all, of them. If point
  7431. is on a tag, call `org-tags-view' instead.
  7432. On top of syntactically correct links, this function also tries
  7433. to open links and time-stamps in comments, node properties, and
  7434. keywords if point is on something looking like a timestamp or
  7435. a link."
  7436. (interactive "P")
  7437. (org-load-modules-maybe)
  7438. (setq org-window-config-before-follow-link (current-window-configuration))
  7439. (org-remove-occur-highlights nil nil t)
  7440. (unless (run-hook-with-args-until-success 'org-open-at-point-functions)
  7441. (let* ((context
  7442. ;; Only consider supported types, even if they are not the
  7443. ;; closest one.
  7444. (org-element-lineage
  7445. (org-element-context)
  7446. '(citation citation-reference clock comment comment-block
  7447. footnote-definition footnote-reference headline
  7448. inline-src-block inlinetask keyword link node-property
  7449. planning src-block timestamp)
  7450. t))
  7451. (type (org-element-type context))
  7452. (value (org-element-property :value context)))
  7453. (cond
  7454. ((not type) (user-error "No link found"))
  7455. ;; No valid link at point. For convenience, look if something
  7456. ;; looks like a link under point in some specific places.
  7457. ((memq type '(comment comment-block node-property keyword))
  7458. (call-interactively #'org-open-at-point-global))
  7459. ;; On a headline or an inlinetask, but not on a timestamp,
  7460. ;; a link, a footnote reference or a citation.
  7461. ((memq type '(headline inlinetask))
  7462. (org-match-line org-complex-heading-regexp)
  7463. (let ((tags-beg (match-beginning 5))
  7464. (tags-end (match-end 5)))
  7465. (if (and tags-beg (>= (point) tags-beg) (< (point) tags-end))
  7466. ;; On tags.
  7467. (org-tags-view
  7468. arg
  7469. (save-excursion
  7470. (let* ((beg-tag (or (search-backward ":" tags-beg 'at-limit) (point)))
  7471. (end-tag (search-forward ":" tags-end nil 2)))
  7472. (buffer-substring (1+ beg-tag) (1- end-tag)))))
  7473. ;; Not on tags.
  7474. (pcase (org-offer-links-in-entry (current-buffer) (point) arg)
  7475. (`(nil . ,_)
  7476. (require 'org-attach)
  7477. (when (org-attach-dir)
  7478. (message "Opening attachment")
  7479. (if (equal arg '(4))
  7480. (org-attach-reveal-in-emacs)
  7481. (org-attach-reveal))))
  7482. (`(,links . ,links-end)
  7483. (dolist (link (if (stringp links) (list links) links))
  7484. (search-forward link nil links-end)
  7485. (goto-char (match-beginning 0))
  7486. (org-open-at-point arg)))))))
  7487. ;; On a footnote reference or at definition's label.
  7488. ((or (eq type 'footnote-reference)
  7489. (and (eq type 'footnote-definition)
  7490. (save-excursion
  7491. ;; Do not validate action when point is on the
  7492. ;; spaces right after the footnote label, in order
  7493. ;; to be on par with behavior on links.
  7494. (skip-chars-forward " \t")
  7495. (let ((begin
  7496. (org-element-property :contents-begin context)))
  7497. (if begin (< (point) begin)
  7498. (= (org-element-property :post-affiliated context)
  7499. (line-beginning-position)))))))
  7500. (org-footnote-action))
  7501. ;; On a planning line. Check if we are really on a timestamp.
  7502. ((and (eq type 'planning)
  7503. (org-in-regexp org-ts-regexp-both nil t))
  7504. (org-follow-timestamp-link))
  7505. ;; On a clock line, make sure point is on the timestamp
  7506. ;; before opening it.
  7507. ((and (eq type 'clock)
  7508. value
  7509. (>= (point) (org-element-property :begin value))
  7510. (<= (point) (org-element-property :end value)))
  7511. (org-follow-timestamp-link))
  7512. ((eq type 'src-block) (org-babel-open-src-block-result))
  7513. ;; Do nothing on white spaces after an object.
  7514. ((>= (point)
  7515. (save-excursion
  7516. (goto-char (org-element-property :end context))
  7517. (skip-chars-backward " \t")
  7518. (point)))
  7519. (user-error "No link found"))
  7520. ((eq type 'inline-src-block) (org-babel-open-src-block-result))
  7521. ((eq type 'timestamp) (org-follow-timestamp-link))
  7522. ((eq type 'link) (org-link-open context arg))
  7523. ((memq type '(citation citation-reference)) (org-cite-follow context arg))
  7524. (t (user-error "No link found")))))
  7525. (run-hook-with-args 'org-follow-link-hook))
  7526. ;;;###autoload
  7527. (defun org-offer-links-in-entry (buffer marker &optional nth zero)
  7528. "Offer links in the current entry and return the selected link.
  7529. If there is only one link, return it.
  7530. If NTH is an integer, return the NTH link found.
  7531. If ZERO is a string, check also this string for a link, and if
  7532. there is one, return it."
  7533. (with-current-buffer buffer
  7534. (org-with-wide-buffer
  7535. (goto-char marker)
  7536. (let ((cnt ?0)
  7537. have-zero end links link c)
  7538. (when (and (stringp zero) (string-match org-link-bracket-re zero))
  7539. (push (match-string 0 zero) links)
  7540. (setq cnt (1- cnt) have-zero t))
  7541. (save-excursion
  7542. (org-back-to-heading t)
  7543. (setq end (save-excursion (outline-next-heading) (point)))
  7544. (while (re-search-forward org-link-any-re end t)
  7545. ;; Only consider valid links or links openable via
  7546. ;; `org-open-at-point'.
  7547. (when (memq (org-element-type (org-element-context)) '(link comment comment-block node-property keyword))
  7548. (push (match-string 0) links)))
  7549. (setq links (org-uniquify (reverse links))))
  7550. (cond
  7551. ((null links)
  7552. (message "No links"))
  7553. ((equal (length links) 1)
  7554. (setq link (car links)))
  7555. ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
  7556. (setq link (nth (if have-zero nth (1- nth)) links)))
  7557. (t ; we have to select a link
  7558. (save-excursion
  7559. (save-window-excursion
  7560. (delete-other-windows)
  7561. (with-output-to-temp-buffer "*Select Link*"
  7562. (dolist (l links)
  7563. (cond
  7564. ((not (string-match org-link-bracket-re l))
  7565. (princ (format "[%c] %s\n" (cl-incf cnt)
  7566. (org-unbracket-string "<" ">" l))))
  7567. ((match-end 2)
  7568. (princ (format "[%c] %s (%s)\n" (cl-incf cnt)
  7569. (match-string 2 l) (match-string 1 l))))
  7570. (t (princ (format "[%c] %s\n" (cl-incf cnt)
  7571. (match-string 1 l)))))))
  7572. (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
  7573. (message "Select link to open, RET to open all:")
  7574. (setq c (read-char-exclusive))
  7575. (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
  7576. (when (equal c ?q) (user-error "Abort"))
  7577. (if (equal c ?\C-m)
  7578. (setq link links)
  7579. (setq nth (- c ?0))
  7580. (when have-zero (setq nth (1+ nth)))
  7581. (unless (and (integerp nth) (>= (length links) nth))
  7582. (user-error "Invalid link selection"))
  7583. (setq link (nth (1- nth) links)))))
  7584. (cons link end)))))
  7585. ;;; File search
  7586. (defun org-do-occur (regexp &optional cleanup)
  7587. "Call the Emacs command `occur'.
  7588. If CLEANUP is non-nil, remove the printout of the regular expression
  7589. in the *Occur* buffer. This is useful if the regex is long and not useful
  7590. to read."
  7591. (occur regexp)
  7592. (when cleanup
  7593. (let ((cwin (selected-window)) win beg end)
  7594. (when (setq win (get-buffer-window "*Occur*"))
  7595. (select-window win))
  7596. (goto-char (point-min))
  7597. (when (re-search-forward "match[a-z]+" nil t)
  7598. (setq beg (match-end 0))
  7599. (when (re-search-forward "^[ \t]*[0-9]+" nil t)
  7600. (setq end (1- (match-beginning 0)))))
  7601. (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
  7602. (goto-char (point-min))
  7603. (select-window cwin))))
  7604. ;;; The Mark Ring
  7605. (defvar org-mark-ring nil
  7606. "Mark ring for positions before jumps in Org mode.")
  7607. (defvar org-mark-ring-last-goto nil
  7608. "Last position in the mark ring used to go back.")
  7609. ;; Fill and close the ring
  7610. (setq org-mark-ring nil)
  7611. (setq org-mark-ring-last-goto nil) ;in case file is reloaded
  7612. (dotimes (_ org-mark-ring-length) (push (make-marker) org-mark-ring))
  7613. (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
  7614. org-mark-ring)
  7615. (defun org-mark-ring-push (&optional pos buffer)
  7616. "Put the current position into the mark ring and rotate it.
  7617. Also push position into the Emacs mark ring. If optional
  7618. argument POS and BUFFER are not nil, mark this location instead."
  7619. (interactive)
  7620. (let ((pos (or pos (point)))
  7621. (buffer (or buffer (current-buffer))))
  7622. (with-current-buffer buffer
  7623. (org-with-point-at pos (push-mark nil t)))
  7624. (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
  7625. (move-marker (car org-mark-ring) pos buffer))
  7626. (message
  7627. (substitute-command-keys
  7628. "Position saved to mark ring, go back with `\\[org-mark-ring-goto]'.")))
  7629. (defun org-mark-ring-goto (&optional n)
  7630. "Jump to the previous position in the mark ring.
  7631. With prefix arg N, jump back that many stored positions. When
  7632. called several times in succession, walk through the entire ring.
  7633. Org mode commands jumping to a different position in the current file,
  7634. or to another Org file, automatically push the old position onto the ring."
  7635. (interactive "p")
  7636. (let (p m)
  7637. (if (eq last-command this-command)
  7638. (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
  7639. (setq p org-mark-ring))
  7640. (setq org-mark-ring-last-goto p)
  7641. (setq m (car p))
  7642. (pop-to-buffer-same-window (marker-buffer m))
  7643. (goto-char m)
  7644. (when (or (org-invisible-p) (org-invisible-p2)) (org-fold-show-context 'mark-goto))))
  7645. ;;; Following specific links
  7646. (defvar org-agenda-buffer-tmp-name)
  7647. (defvar org-agenda-start-on-weekday)
  7648. (defvar org-agenda-buffer-name)
  7649. (defun org-follow-timestamp-link ()
  7650. "Open an agenda view for the time-stamp date/range at point."
  7651. ;; Avoid changing the global value.
  7652. (let ((org-agenda-buffer-name org-agenda-buffer-name))
  7653. (cond
  7654. ((org-at-date-range-p t)
  7655. (let ((org-agenda-start-on-weekday)
  7656. (t1 (match-string 1))
  7657. (t2 (match-string 2)) tt1 tt2)
  7658. (setq tt1 (time-to-days (org-time-string-to-time t1))
  7659. tt2 (time-to-days (org-time-string-to-time t2)))
  7660. (let ((org-agenda-buffer-tmp-name
  7661. (format "*Org Agenda(a:%s)"
  7662. (concat (substring t1 0 10) "--" (substring t2 0 10)))))
  7663. (org-agenda-list nil tt1 (1+ (- tt2 tt1))))))
  7664. ((org-at-timestamp-p 'lax)
  7665. (let ((org-agenda-buffer-tmp-name
  7666. (format "*Org Agenda(a:%s)" (substring (match-string 1) 0 10))))
  7667. (org-agenda-list nil (time-to-days (org-time-string-to-time
  7668. (substring (match-string 1) 0 10)))
  7669. 1)))
  7670. (t (error "This should not happen")))))
  7671. ;;; Following file links
  7672. (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
  7673. (declare-function mailcap-extension-to-mime "mailcap" (extn))
  7674. (declare-function mailcap-mime-info
  7675. "mailcap" (string &optional request no-decode))
  7676. (defvar org-wait nil)
  7677. ;;;; Refiling
  7678. (defun org-get-org-file ()
  7679. "Read a filename, with default directory `org-directory'."
  7680. (let ((default (or org-default-notes-file remember-data-file)))
  7681. (read-file-name (format "File name [%s]: " default)
  7682. (file-name-as-directory org-directory)
  7683. default)))
  7684. (defun org-notes-order-reversed-p ()
  7685. "Check if the current file should receive notes in reversed order."
  7686. (cond
  7687. ((not org-reverse-note-order) nil)
  7688. ((eq t org-reverse-note-order) t)
  7689. ((not (listp org-reverse-note-order)) nil)
  7690. (t (catch 'exit
  7691. (dolist (entry org-reverse-note-order)
  7692. (when (string-match (car entry) buffer-file-name)
  7693. (throw 'exit (cdr entry))))))))
  7694. (defvar org-agenda-new-buffers nil
  7695. "Buffers created to visit agenda files.")
  7696. (declare-function org-string-nw-p "org-macs" (s))
  7697. ;;;; Dynamic blocks
  7698. (defun org-find-dblock (name)
  7699. "Find the first dynamic block with name NAME in the buffer.
  7700. If not found, stay at current position and return nil."
  7701. (let ((case-fold-search t) pos)
  7702. (save-excursion
  7703. (goto-char (point-min))
  7704. (setq pos (and (re-search-forward
  7705. (concat "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+" name "\\>") nil t)
  7706. (match-beginning 0))))
  7707. (when pos (goto-char pos))
  7708. pos))
  7709. (defun org-create-dblock (plist)
  7710. "Create a dynamic block section, with parameters taken from PLIST.
  7711. PLIST must contain a :name entry which is used as the name of the block."
  7712. (when (string-match "\\S-" (buffer-substring (line-beginning-position)
  7713. (line-end-position)))
  7714. (end-of-line 1)
  7715. (newline))
  7716. (let ((col (current-column))
  7717. (name (plist-get plist :name)))
  7718. (insert "#+BEGIN: " name)
  7719. (while plist
  7720. (if (eq (car plist) :name)
  7721. (setq plist (cddr plist))
  7722. (insert " " (prin1-to-string (pop plist)))))
  7723. (insert "\n\n" (make-string col ?\ ) "#+END:\n")
  7724. (beginning-of-line -2)))
  7725. (defun org-prepare-dblock ()
  7726. "Prepare dynamic block for refresh.
  7727. This empties the block, puts the cursor at the insert position and returns
  7728. the property list including an extra property :name with the block name."
  7729. (unless (looking-at org-dblock-start-re)
  7730. (user-error "Not at a dynamic block"))
  7731. (let* ((begdel (1+ (match-end 0)))
  7732. (name (org-no-properties (match-string 1)))
  7733. (params (append (list :name name)
  7734. (read (concat "(" (match-string 3) ")")))))
  7735. (save-excursion
  7736. (beginning-of-line 1)
  7737. (skip-chars-forward " \t")
  7738. (setq params (plist-put params :indentation-column (current-column))))
  7739. (unless (re-search-forward org-dblock-end-re nil t)
  7740. (error "Dynamic block not terminated"))
  7741. (setq params
  7742. (append params
  7743. (list :content (buffer-substring
  7744. begdel (match-beginning 0)))))
  7745. (delete-region begdel (match-beginning 0))
  7746. (goto-char begdel)
  7747. (open-line 1)
  7748. params))
  7749. (defun org-map-dblocks (&optional command)
  7750. "Apply COMMAND to all dynamic blocks in the current buffer.
  7751. If COMMAND is not given, use `org-update-dblock'."
  7752. (let ((cmd (or command 'org-update-dblock)))
  7753. (save-excursion
  7754. (goto-char (point-min))
  7755. (while (re-search-forward org-dblock-start-re nil t)
  7756. (goto-char (match-beginning 0))
  7757. (save-excursion
  7758. (condition-case nil
  7759. (funcall cmd)
  7760. (error (message "Error during update of dynamic block"))))
  7761. (unless (re-search-forward org-dblock-end-re nil t)
  7762. (error "Dynamic block not terminated"))))))
  7763. (defvar org-dynamic-block-alist nil
  7764. "Alist defining all the Org dynamic blocks.
  7765. The key is the dynamic block type name, as a string. The value
  7766. is the function used to insert the dynamic block.
  7767. Use `org-dynamic-block-define' to populate it.")
  7768. (defun org-dynamic-block-function (type)
  7769. "Return function associated to a given dynamic block type.
  7770. TYPE is the dynamic block type, as a string."
  7771. (cdr (assoc type org-dynamic-block-alist)))
  7772. (defun org-dynamic-block-types ()
  7773. "List all defined dynamic block types."
  7774. (mapcar #'car org-dynamic-block-alist))
  7775. ;;;###org-autoload
  7776. (defun org-dynamic-block-define (type func)
  7777. "Define dynamic block TYPE with FUNC.
  7778. TYPE is a string. FUNC is the function creating the dynamic
  7779. block of such type."
  7780. (pcase (assoc type org-dynamic-block-alist)
  7781. (`nil (push (cons type func) org-dynamic-block-alist))
  7782. (def (setcdr def func))))
  7783. (defun org-dynamic-block-insert-dblock (type &optional interactive-p)
  7784. "Insert a dynamic block of type TYPE.
  7785. When used interactively, select the dynamic block types among
  7786. defined types, per `org-dynamic-block-define'. If INTERACTIVE-P
  7787. is non-nil, call the dynamic block function interactively."
  7788. (interactive (list (completing-read "Dynamic block: "
  7789. (org-dynamic-block-types))
  7790. t))
  7791. (pcase (org-dynamic-block-function type)
  7792. (`nil (error "No such dynamic block: %S" type))
  7793. ((and f (pred functionp))
  7794. (if interactive-p (call-interactively f) (funcall f)))
  7795. (_ (error "Invalid function for dynamic block %S" type))))
  7796. (defun org-dblock-update (&optional arg)
  7797. "User command for updating dynamic blocks.
  7798. Update the dynamic block at point. With prefix ARG, update all dynamic
  7799. blocks in the buffer."
  7800. (interactive "P")
  7801. (if arg
  7802. (org-update-all-dblocks)
  7803. (or (looking-at org-dblock-start-re)
  7804. (org-beginning-of-dblock))
  7805. (org-update-dblock)))
  7806. (defun org-update-dblock ()
  7807. "Update the dynamic block at point.
  7808. This means to empty the block, parse for parameters and then call
  7809. the correct writing function."
  7810. (interactive)
  7811. (save-excursion
  7812. (let* ((win (selected-window))
  7813. (pos (point))
  7814. (line (org-current-line))
  7815. (params (org-prepare-dblock))
  7816. (name (plist-get params :name))
  7817. (indent (plist-get params :indentation-column))
  7818. (cmd (intern (concat "org-dblock-write:" name))))
  7819. (message "Updating dynamic block `%s' at line %d..." name line)
  7820. (funcall cmd params)
  7821. (message "Updating dynamic block `%s' at line %d...done" name line)
  7822. (goto-char pos)
  7823. (when (and indent (> indent 0))
  7824. (setq indent (make-string indent ?\ ))
  7825. (save-excursion
  7826. (select-window win)
  7827. (org-beginning-of-dblock)
  7828. (forward-line 1)
  7829. (while (not (looking-at org-dblock-end-re))
  7830. (insert indent)
  7831. (beginning-of-line 2))
  7832. (when (looking-at org-dblock-end-re)
  7833. (and (looking-at "[ \t]+")
  7834. (replace-match ""))
  7835. (insert indent)))))))
  7836. (defun org-beginning-of-dblock ()
  7837. "Find the beginning of the dynamic block at point.
  7838. Error if there is no such block at point."
  7839. (let ((pos (point))
  7840. beg)
  7841. (end-of-line 1)
  7842. (if (and (re-search-backward org-dblock-start-re nil t)
  7843. (setq beg (match-beginning 0))
  7844. (re-search-forward org-dblock-end-re nil t)
  7845. (> (match-end 0) pos))
  7846. (goto-char beg)
  7847. (goto-char pos)
  7848. (error "Not in a dynamic block"))))
  7849. (defun org-update-all-dblocks ()
  7850. "Update all dynamic blocks in the buffer.
  7851. This function can be used in a hook."
  7852. (interactive)
  7853. (when (derived-mode-p 'org-mode)
  7854. (org-map-dblocks 'org-update-dblock)))
  7855. ;;;; Completion
  7856. (declare-function org-export-backend-options "ox" (cl-x) t)
  7857. (defun org-get-export-keywords ()
  7858. "Return a list of all currently understood export keywords.
  7859. Export keywords include options, block names, attributes and
  7860. keywords relative to each registered export back-end."
  7861. (let (keywords)
  7862. (dolist (backend
  7863. (bound-and-true-p org-export-registered-backends)
  7864. (delq nil keywords))
  7865. ;; Back-end name (for keywords, like #+LATEX:)
  7866. (push (upcase (symbol-name (org-export-backend-name backend))) keywords)
  7867. (dolist (option-entry (org-export-backend-options backend))
  7868. ;; Back-end options.
  7869. (push (nth 1 option-entry) keywords)))))
  7870. (defconst org-options-keywords
  7871. '("ARCHIVE:" "AUTHOR:" "BIBLIOGRAPHY:" "BIND:" "CATEGORY:" "CITE_EXPORT:"
  7872. "COLUMNS:" "CREATOR:" "DATE:" "DESCRIPTION:" "DRAWERS:" "EMAIL:"
  7873. "EXCLUDE_TAGS:" "FILETAGS:" "INCLUDE:" "INDEX:" "KEYWORDS:" "LANGUAGE:"
  7874. "MACRO:" "OPTIONS:" "PROPERTY:" "PRINT_BIBLIOGRAPHY" "PRIORITIES:"
  7875. "SELECT_TAGS:" "SEQ_TODO:" "SETUPFILE:" "STARTUP:" "TAGS:" "TITLE:" "TODO:"
  7876. "TYP_TODO:" "SELECT_TAGS:" "EXCLUDE_TAGS:"))
  7877. (defcustom org-structure-template-alist
  7878. '(("a" . "export ascii")
  7879. ("c" . "center")
  7880. ("C" . "comment")
  7881. ("e" . "example")
  7882. ("E" . "export")
  7883. ("h" . "export html")
  7884. ("l" . "export latex")
  7885. ("q" . "quote")
  7886. ("s" . "src")
  7887. ("v" . "verse"))
  7888. "An alist of keys and block types.
  7889. `org-insert-structure-template' will display a menu with this list of
  7890. templates to choose from. The block type is inserted, with
  7891. \"#+begin_\" and \"#+end_\" added automatically. If the block type
  7892. consists of just uppercase letters, \"#+BEGIN_\" and \"#+END_\" are
  7893. added instead.
  7894. The menu keys are defined by the car of each entry in this alist.
  7895. If two entries have the keys \"a\" and \"aa\" respectively, the
  7896. former will be inserted by typing \"a TAB/RET/SPC\" and the
  7897. latter will be inserted by typing \"aa\". If an entry with the
  7898. key \"aab\" is later added, it can be inserted by typing \"ab\".
  7899. If loaded, Org Tempo also uses `org-structure-template-alist'. A
  7900. block can be inserted by pressing TAB after the string \"<KEY\"."
  7901. :group 'org-edit-structure
  7902. :type '(repeat
  7903. (cons (string :tag "Key")
  7904. (string :tag "Template")))
  7905. :package-version '(Org . "9.2"))
  7906. (defun org--check-org-structure-template-alist (&optional checklist)
  7907. "Check whether `org-structure-template-alist' is set up correctly.
  7908. In particular, check if the Org 9.2 format is used as opposed to
  7909. previous format."
  7910. (let ((elm (cl-remove-if-not (lambda (x) (listp (cdr x)))
  7911. (or (symbol-value checklist)
  7912. org-structure-template-alist))))
  7913. (when elm
  7914. (org-display-warning
  7915. (format "
  7916. Please update the entries of `%s'.
  7917. In Org 9.2 the format was changed from something like
  7918. (\"s\" \"#+BEGIN_SRC ?\\n#+END_SRC\")
  7919. to something like
  7920. (\"s\" . \"src\")
  7921. Please refer to the documentation of `org-structure-template-alist'.
  7922. The following entries must be updated:
  7923. %s"
  7924. (or checklist 'org-structure-template-alist)
  7925. (pp-to-string elm))))))
  7926. (defun org--insert-structure-template-mks ()
  7927. "Present `org-structure-template-alist' with `org-mks'.
  7928. Menus are added if keys require more than one keystroke. Tabs
  7929. are added to single key entries when more than one stroke is
  7930. needed. Keys longer than two characters are reduced to two
  7931. characters."
  7932. (org--check-org-structure-template-alist)
  7933. (let* (case-fold-search
  7934. (templates (append org-structure-template-alist
  7935. '(("\t" . "Press TAB, RET or SPC to write block name"))))
  7936. (keys (mapcar #'car templates))
  7937. (start-letters
  7938. (delete-dups (mapcar (lambda (key) (substring key 0 1)) keys)))
  7939. ;; Sort each element of `org-structure-template-alist' into
  7940. ;; sublists according to the first letter.
  7941. (superlist
  7942. (mapcar (lambda (letter)
  7943. (list letter
  7944. (cl-remove-if-not
  7945. (apply-partially #'string-match-p (concat "^" letter))
  7946. templates :key #'car)))
  7947. start-letters)))
  7948. (org-mks
  7949. (apply #'append
  7950. ;; Make an `org-mks' table. If only one element is
  7951. ;; present in a sublist, make it part of the top-menu,
  7952. ;; otherwise make a submenu according to the starting
  7953. ;; letter and populate it.
  7954. (mapcar (lambda (sublist)
  7955. (if (eq 1 (length (cadr sublist)))
  7956. (mapcar (lambda (elm)
  7957. (list (substring (car elm) 0 1)
  7958. (cdr elm) ""))
  7959. (cadr sublist))
  7960. ;; Create submenu.
  7961. (let* ((topkey (car sublist))
  7962. (elms (cadr sublist))
  7963. (keys (mapcar #'car elms))
  7964. (long (> (length elms) 3)))
  7965. (append
  7966. (list
  7967. ;; Make a description of the submenu.
  7968. (list topkey
  7969. (concat
  7970. (mapconcat #'cdr
  7971. (cl-subseq elms 0 (if long 3 (length elms)))
  7972. ", ")
  7973. (when long ", ..."))))
  7974. ;; List of entries in submenu.
  7975. (cl-mapcar #'list
  7976. (org--insert-structure-template-unique-keys keys)
  7977. (mapcar #'cdr elms)
  7978. (make-list (length elms) ""))))))
  7979. superlist))
  7980. "Select a key\n============"
  7981. "Key: ")))
  7982. (defun org--insert-structure-template-unique-keys (keys)
  7983. "Make a list of unique, two characters long elements from KEYS.
  7984. Elements of length one have a tab appended. Elements of length
  7985. two are kept as is. Longer elements are truncated to length two.
  7986. If an element cannot be made unique, an error is raised."
  7987. (let ((ordered-keys (cl-sort (copy-sequence keys) #'< :key #'length))
  7988. menu-keys)
  7989. (dolist (key ordered-keys)
  7990. (let ((potential-key
  7991. (cl-case (length key)
  7992. (1 (concat key "\t"))
  7993. (2 key)
  7994. (otherwise
  7995. (cl-find-if-not (lambda (k) (assoc k menu-keys))
  7996. (mapcar (apply-partially #'concat (substring key 0 1))
  7997. (split-string (substring key 1) "" t)))))))
  7998. (if (or (not potential-key) (assoc potential-key menu-keys))
  7999. (user-error "Could not make unique key for `%s'" key)
  8000. (push (cons potential-key key) menu-keys))))
  8001. (mapcar #'car
  8002. (cl-sort menu-keys #'<
  8003. :key (lambda (elm) (cl-position (cdr elm) keys))))))
  8004. (defun org-insert-structure-template (type)
  8005. "Insert a block structure of the type #+begin_foo/#+end_foo.
  8006. Select a block from `org-structure-template-alist' then type
  8007. either RET, TAB or SPC to write the block type. With an active
  8008. region, wrap the region in the block. Otherwise, insert an empty
  8009. block.
  8010. When foo is written as FOO, upcase the #+BEGIN/END as well."
  8011. (interactive
  8012. (list (pcase (org--insert-structure-template-mks)
  8013. (`("\t" . ,_) (read-string "Structure type: "))
  8014. (`(,_ ,choice . ,_) choice))))
  8015. (let* ((case-fold-search t) ; Make sure that matches are case-insensitive.
  8016. (region? (use-region-p))
  8017. (region-start (and region? (region-beginning)))
  8018. (region-end (and region? (copy-marker (region-end))))
  8019. (extended? (string-match-p "\\`\\(src\\|export\\)\\'" type))
  8020. (verbatim? (string-match-p
  8021. (concat "\\`" (regexp-opt '("example" "export"
  8022. "src" "comment")))
  8023. type))
  8024. (upcase? (string= (car (split-string type))
  8025. (upcase (car (split-string type))))))
  8026. (when region? (goto-char region-start))
  8027. (let ((column (current-indentation)))
  8028. (if (save-excursion (skip-chars-backward " \t") (bolp))
  8029. (beginning-of-line)
  8030. (insert "\n"))
  8031. (save-excursion
  8032. (indent-to column)
  8033. (insert (format "#+%s_%s%s\n" (if upcase? "BEGIN" "begin") type (if extended? " " "")))
  8034. (when region?
  8035. (when verbatim? (org-escape-code-in-region (point) region-end))
  8036. (goto-char region-end)
  8037. ;; Ignore empty lines at the end of the region.
  8038. (skip-chars-backward " \r\t\n")
  8039. (end-of-line))
  8040. (unless (bolp) (insert "\n"))
  8041. (indent-to column)
  8042. (insert (format "#+%s_%s" (if upcase? "END" "end") (car (split-string type))))
  8043. (if (looking-at "[ \t]*$") (replace-match "")
  8044. (insert "\n"))
  8045. (when (and (eobp) (not (bolp))) (insert "\n")))
  8046. (if extended? (end-of-line)
  8047. (forward-line)
  8048. (skip-chars-forward " \t")))))
  8049. ;;;; TODO, DEADLINE, Comments
  8050. (defun org-toggle-comment ()
  8051. "Change the COMMENT state of an entry."
  8052. (interactive)
  8053. (save-excursion
  8054. (org-back-to-heading)
  8055. (let ((case-fold-search nil))
  8056. (looking-at org-complex-heading-regexp))
  8057. (goto-char (or (match-end 3) (match-end 2) (match-end 1)))
  8058. (skip-chars-forward " \t")
  8059. (unless (memq (char-before) '(?\s ?\t)) (insert " "))
  8060. (if (org-in-commented-heading-p t)
  8061. (delete-region (point)
  8062. (progn (search-forward " " (line-end-position) 'move)
  8063. (skip-chars-forward " \t")
  8064. (point)))
  8065. (insert org-comment-string)
  8066. (unless (eolp) (insert " ")))))
  8067. (defvar org-last-todo-state-is-todo nil
  8068. "This is non-nil when the last TODO state change led to a TODO state.
  8069. If the last change removed the TODO tag or switched to DONE, then
  8070. this is nil.")
  8071. (defvar org-todo-setup-filter-hook nil
  8072. "Hook for functions that pre-filter todo specs.
  8073. Each function takes a todo spec and returns either nil or the spec
  8074. transformed into canonical form." )
  8075. (defvar org-todo-get-default-hook nil
  8076. "Hook for functions that get a default item for todo.
  8077. Each function takes arguments (NEW-MARK OLD-MARK) and returns either
  8078. nil or a string to be used for the todo mark." )
  8079. (defvar org-agenda-headline-snapshot-before-repeat)
  8080. (defun org-current-effective-time ()
  8081. "Return current time adjusted for `org-extend-today-until' variable."
  8082. (let* ((ct (org-current-time))
  8083. (dct (decode-time ct))
  8084. (ct1
  8085. (cond
  8086. (org-use-last-clock-out-time-as-effective-time
  8087. (or (org-clock-get-last-clock-out-time) ct))
  8088. ((and org-use-effective-time (< (nth 2 dct) org-extend-today-until))
  8089. (org-encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct)))
  8090. (t ct))))
  8091. ct1))
  8092. (defun org-todo-yesterday (&optional arg)
  8093. "Like `org-todo' but the time of change will be 23:59 of yesterday."
  8094. (interactive "P")
  8095. (if (eq major-mode 'org-agenda-mode)
  8096. (org-agenda-todo-yesterday arg)
  8097. (let* ((org-use-effective-time t)
  8098. (hour (nth 2 (decode-time (org-current-time))))
  8099. (org-extend-today-until (1+ hour)))
  8100. (org-todo arg))))
  8101. (defvar org-block-entry-blocking ""
  8102. "First entry preventing the TODO state change.")
  8103. (defun org-cancel-repeater ()
  8104. "Cancel a repeater by setting its numeric value to zero."
  8105. (interactive)
  8106. (save-excursion
  8107. (org-back-to-heading t)
  8108. (let ((bound1 (point))
  8109. (bound0 (save-excursion (outline-next-heading) (point))))
  8110. (when (and (re-search-forward
  8111. (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
  8112. org-deadline-time-regexp "\\)\\|\\("
  8113. org-ts-regexp "\\)")
  8114. bound0 t)
  8115. (re-search-backward "[ \t]+\\(?:[.+]\\)?\\+\\([0-9]+\\)[hdwmy]"
  8116. bound1 t))
  8117. (replace-match "0" t nil nil 1)))))
  8118. (defvar org-state)
  8119. (defvar org-blocked-by-checkboxes)
  8120. (defun org-todo (&optional arg)
  8121. "Change the TODO state of an item.
  8122. The state of an item is given by a keyword at the start of the heading,
  8123. like
  8124. *** TODO Write paper
  8125. *** DONE Call mom
  8126. The different keywords are specified in the variable `org-todo-keywords'.
  8127. By default the available states are \"TODO\" and \"DONE\". So, for this
  8128. example: when the item starts with TODO, it is changed to DONE.
  8129. When it starts with DONE, the DONE is removed. And when neither TODO nor
  8130. DONE are present, add TODO at the beginning of the heading.
  8131. You can set up single-character keys to fast-select the new state. See the
  8132. `org-todo-keywords' and `org-use-fast-todo-selection' for details.
  8133. With `\\[universal-argument]' prefix ARG, force logging the state change \
  8134. and take a
  8135. logging note.
  8136. With a `\\[universal-argument] \\[universal-argument]' prefix, switch to the \
  8137. next set of TODO \
  8138. keywords (nextset).
  8139. Another way to achieve this is `S-C-<right>'.
  8140. With a `\\[universal-argument] \\[universal-argument] \\[universal-argument]' \
  8141. prefix, circumvent any state blocking.
  8142. With numeric prefix arg, switch to the Nth state.
  8143. With a numeric prefix arg of 0, inhibit note taking for the change.
  8144. With a numeric prefix arg of -1, cancel repeater to allow marking as DONE.
  8145. When called through ELisp, arg is also interpreted in the following way:
  8146. `none' -> empty state
  8147. \"\" -> switch to empty state
  8148. `done' -> switch to DONE
  8149. `nextset' -> switch to the next set of keywords
  8150. `previousset' -> switch to the previous set of keywords
  8151. \"WAITING\" -> switch to the specified keyword, but only if it
  8152. really is a member of `org-todo-keywords'."
  8153. (interactive "P")
  8154. (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
  8155. (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
  8156. 'region-start-level 'region))
  8157. org-loop-over-headlines-in-active-region)
  8158. (org-map-entries
  8159. (lambda () (org-todo arg))
  8160. nil cl
  8161. (when (org-invisible-p) (org-end-of-subtree nil t))))
  8162. (when (equal arg '(16)) (setq arg 'nextset))
  8163. (when (equal (prefix-numeric-value arg) -1) (org-cancel-repeater) (setq arg nil))
  8164. (when (< (prefix-numeric-value arg) -1) (user-error "Prefix argument %d not supported" arg))
  8165. (let ((org-blocker-hook org-blocker-hook)
  8166. commentp
  8167. case-fold-search)
  8168. (when (equal arg '(64))
  8169. (setq arg nil org-blocker-hook nil))
  8170. (when (and org-blocker-hook
  8171. (or org-inhibit-blocking
  8172. (org-entry-get nil "NOBLOCKING")))
  8173. (setq org-blocker-hook nil))
  8174. (save-excursion
  8175. (catch 'exit
  8176. (org-back-to-heading t)
  8177. (when (org-in-commented-heading-p t)
  8178. (org-toggle-comment)
  8179. (setq commentp t))
  8180. (when (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
  8181. (or (looking-at (concat " +" org-todo-regexp "\\( +\\|[ \t]*$\\)"))
  8182. (looking-at "\\(?: *\\|[ \t]*$\\)"))
  8183. (let* ((match-data (match-data))
  8184. (startpos (copy-marker (line-beginning-position)))
  8185. (force-log (and (equal arg '(4)) (prog1 t (setq arg nil))))
  8186. (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
  8187. (org-log-done org-log-done)
  8188. (org-log-repeat org-log-repeat)
  8189. (org-todo-log-states org-todo-log-states)
  8190. (org-inhibit-logging
  8191. (if (equal arg 0)
  8192. (progn (setq arg nil) 'note) org-inhibit-logging))
  8193. (this (match-string 1))
  8194. (hl-pos (match-beginning 0))
  8195. (head (org-get-todo-sequence-head this))
  8196. (ass (assoc head org-todo-kwd-alist))
  8197. (interpret (nth 1 ass))
  8198. (done-word (nth 3 ass))
  8199. (final-done-word (nth 4 ass))
  8200. (org-last-state (or this ""))
  8201. (completion-ignore-case t)
  8202. (member (member this org-todo-keywords-1))
  8203. (tail (cdr member))
  8204. (org-state (cond
  8205. ((eq arg 'right)
  8206. ;; Next state
  8207. (if this
  8208. (if tail (car tail) nil)
  8209. (car org-todo-keywords-1)))
  8210. ((eq arg 'left)
  8211. ;; Previous state
  8212. (unless (equal member org-todo-keywords-1)
  8213. (if this
  8214. (nth (- (length org-todo-keywords-1)
  8215. (length tail) 2)
  8216. org-todo-keywords-1)
  8217. (org-last org-todo-keywords-1))))
  8218. (arg
  8219. ;; User or caller requests a specific state.
  8220. (cond
  8221. ((equal arg "") nil)
  8222. ((eq arg 'none) nil)
  8223. ((eq arg 'done) (or done-word (car org-done-keywords)))
  8224. ((eq arg 'nextset)
  8225. (or (car (cdr (member head org-todo-heads)))
  8226. (car org-todo-heads)))
  8227. ((eq arg 'previousset)
  8228. (let ((org-todo-heads (reverse org-todo-heads)))
  8229. (or (car (cdr (member head org-todo-heads)))
  8230. (car org-todo-heads))))
  8231. ((car (member arg org-todo-keywords-1)))
  8232. ((stringp arg)
  8233. (user-error "State `%s' not valid in this file" arg))
  8234. ((nth (1- (prefix-numeric-value arg))
  8235. org-todo-keywords-1))))
  8236. ((and org-todo-key-trigger org-use-fast-todo-selection)
  8237. ;; Use fast selection.
  8238. (org-fast-todo-selection this))
  8239. ((null member) (or head (car org-todo-keywords-1)))
  8240. ((equal this final-done-word) nil) ;-> make empty
  8241. ((null tail) nil) ;-> first entry
  8242. ((memq interpret '(type priority))
  8243. (if (eq this-command last-command)
  8244. (car tail)
  8245. (if (> (length tail) 0)
  8246. (or done-word (car org-done-keywords))
  8247. nil)))
  8248. (t
  8249. (car tail))))
  8250. (org-state (or
  8251. (run-hook-with-args-until-success
  8252. 'org-todo-get-default-hook org-state org-last-state)
  8253. org-state))
  8254. (next (if (org-string-nw-p org-state) (concat " " org-state " ") " "))
  8255. (change-plist (list :type 'todo-state-change :from this :to org-state
  8256. :position startpos))
  8257. dolog now-done-p)
  8258. (when org-blocker-hook
  8259. (let (org-blocked-by-checkboxes block-reason)
  8260. (setq org-last-todo-state-is-todo
  8261. (not (member this org-done-keywords)))
  8262. (unless (save-excursion
  8263. (save-match-data
  8264. (org-with-wide-buffer
  8265. (run-hook-with-args-until-failure
  8266. 'org-blocker-hook change-plist))))
  8267. (setq block-reason (if org-blocked-by-checkboxes
  8268. "contained checkboxes"
  8269. (format "\"%s\"" org-block-entry-blocking)))
  8270. (if (called-interactively-p 'interactive)
  8271. (user-error "TODO state change from %s to %s blocked (by %s)"
  8272. this org-state block-reason)
  8273. ;; Fail silently.
  8274. (message "TODO state change from %s to %s blocked (by %s)"
  8275. this org-state block-reason)
  8276. (throw 'exit nil)))))
  8277. (store-match-data match-data)
  8278. (org-fold-core-ignore-modifications
  8279. (goto-char (match-beginning 0))
  8280. (replace-match "")
  8281. ;; We need to use `insert-before-markers-and-inherit'
  8282. ;; because: (1) We want to preserve the folding state
  8283. ;; text properties; (2) We do not want to make point
  8284. ;; move before new todo state when inserting a new todo
  8285. ;; into an empty heading. In (2), the above
  8286. ;; `save-excursion' is relying on markers saved before.
  8287. (insert-before-markers-and-inherit next)
  8288. (unless (org-invisible-p (line-beginning-position))
  8289. (org-fold-region (line-beginning-position)
  8290. (line-end-position)
  8291. nil)))
  8292. (cond ((and org-state (equal this org-state))
  8293. (message "TODO state was already %s" (org-trim next)))
  8294. ((not (pos-visible-in-window-p hl-pos))
  8295. (message "TODO state changed to %s" (org-trim next))))
  8296. (unless head
  8297. (setq head (org-get-todo-sequence-head org-state)
  8298. ass (assoc head org-todo-kwd-alist)
  8299. interpret (nth 1 ass)
  8300. done-word (nth 3 ass)
  8301. final-done-word (nth 4 ass)))
  8302. (when (memq arg '(nextset previousset))
  8303. (message "Keyword-Set %d/%d: %s"
  8304. (- (length org-todo-sets) -1
  8305. (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
  8306. (length org-todo-sets)
  8307. (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
  8308. (setq org-last-todo-state-is-todo
  8309. (not (member org-state org-done-keywords)))
  8310. (setq now-done-p (and (member org-state org-done-keywords)
  8311. (not (member this org-done-keywords))))
  8312. (and logging (org-local-logging logging))
  8313. (when (or (and (or org-todo-log-states org-log-done)
  8314. (not (eq org-inhibit-logging t))
  8315. (not (memq arg '(nextset previousset))))
  8316. force-log)
  8317. ;; We need to look at recording a time and note.
  8318. (setq dolog (or (if force-log 'note)
  8319. (nth 1 (assoc org-state org-todo-log-states))
  8320. (nth 2 (assoc this org-todo-log-states))))
  8321. (when (and (eq dolog 'note) (eq org-inhibit-logging 'note))
  8322. (setq dolog 'time))
  8323. (when (or (and (not org-state) (not org-closed-keep-when-no-todo))
  8324. (and org-state
  8325. (member org-state org-not-done-keywords)
  8326. (not (member this org-not-done-keywords))))
  8327. ;; This is now a todo state and was not one before
  8328. ;; If there was a CLOSED time stamp, get rid of it.
  8329. (org-add-planning-info nil nil 'closed))
  8330. (when (and now-done-p org-log-done)
  8331. ;; It is now done, and it was not done before.
  8332. (org-add-planning-info 'closed (org-current-effective-time))
  8333. (when (and (not dolog) (eq 'note org-log-done))
  8334. (org-add-log-setup 'done org-state this 'note)))
  8335. (when (and org-state dolog)
  8336. ;; This is a non-nil state, and we need to log it.
  8337. (org-add-log-setup 'state org-state this dolog)))
  8338. ;; Fixup tag positioning.
  8339. (org-todo-trigger-tag-changes org-state)
  8340. (when org-auto-align-tags (org-align-tags))
  8341. (when org-provide-todo-statistics
  8342. (org-update-parent-todo-statistics))
  8343. (when (bound-and-true-p org-clock-out-when-done)
  8344. (org-clock-out-if-current))
  8345. (run-hooks 'org-after-todo-state-change-hook)
  8346. (when (and arg (not (member org-state org-done-keywords)))
  8347. (setq head (org-get-todo-sequence-head org-state)))
  8348. (put-text-property (line-beginning-position)
  8349. (line-end-position) 'org-todo-head head)
  8350. ;; Do we need to trigger a repeat?
  8351. (when now-done-p
  8352. (when (boundp 'org-agenda-headline-snapshot-before-repeat)
  8353. ;; This is for the agenda, take a snapshot of the headline.
  8354. (save-match-data
  8355. (setq org-agenda-headline-snapshot-before-repeat
  8356. (org-get-heading))))
  8357. (org-auto-repeat-maybe org-state))
  8358. ;; Fixup cursor location if close to the keyword.
  8359. (when (and (outline-on-heading-p)
  8360. (not (bolp))
  8361. (save-excursion (beginning-of-line 1)
  8362. (looking-at org-todo-line-regexp))
  8363. (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
  8364. (goto-char (or (match-end 2) (match-end 1)))
  8365. (and (looking-at " ")
  8366. (not (looking-at " *:"))
  8367. (just-one-space)))
  8368. (when org-trigger-hook
  8369. (save-excursion
  8370. (run-hook-with-args 'org-trigger-hook change-plist)))
  8371. (when commentp (org-toggle-comment))))))))
  8372. (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
  8373. "Block turning an entry into a TODO, using the hierarchy.
  8374. This checks whether the current task should be blocked from state
  8375. changes. Such blocking occurs when:
  8376. 1. The task has children which are not all in a completed state.
  8377. 2. A task has a parent with the property :ORDERED:, and there
  8378. are siblings prior to the current task with incomplete
  8379. status.
  8380. 3. The parent of the task is blocked because it has siblings that should
  8381. be done first, or is child of a block grandparent TODO entry."
  8382. (if (not org-enforce-todo-dependencies)
  8383. t ; if locally turned off don't block
  8384. (catch 'dont-block
  8385. ;; If this is not a todo state change, or if this entry is already DONE,
  8386. ;; do not block
  8387. (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
  8388. (member (plist-get change-plist :from)
  8389. (cons 'done org-done-keywords))
  8390. (member (plist-get change-plist :to)
  8391. (cons 'todo org-not-done-keywords))
  8392. (not (plist-get change-plist :to)))
  8393. (throw 'dont-block t))
  8394. ;; If this task has children, and any are undone, it's blocked
  8395. (save-excursion
  8396. (org-back-to-heading t)
  8397. (let ((this-level (funcall outline-level)))
  8398. (outline-next-heading)
  8399. (let ((child-level (funcall outline-level)))
  8400. (while (and (not (eobp))
  8401. (> child-level this-level))
  8402. ;; this todo has children, check whether they are all
  8403. ;; completed
  8404. (when (and (not (org-entry-is-done-p))
  8405. (org-entry-is-todo-p))
  8406. (setq org-block-entry-blocking (org-get-heading))
  8407. (throw 'dont-block nil))
  8408. (outline-next-heading)
  8409. (setq child-level (funcall outline-level))))))
  8410. ;; Otherwise, if the task's parent has the :ORDERED: property, and
  8411. ;; any previous siblings are undone, it's blocked
  8412. (save-excursion
  8413. (org-back-to-heading t)
  8414. (let* ((pos (point))
  8415. (parent-pos (and (org-up-heading-safe) (point)))
  8416. (case-fold-search nil))
  8417. (unless parent-pos (throw 'dont-block t)) ; no parent
  8418. (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
  8419. (forward-line 1)
  8420. (re-search-forward org-not-done-heading-regexp pos t))
  8421. (setq org-block-entry-blocking (match-string 0))
  8422. (throw 'dont-block nil)) ; block, there is an older sibling not done.
  8423. ;; Search further up the hierarchy, to see if an ancestor is blocked
  8424. (while t
  8425. (goto-char parent-pos)
  8426. (unless (looking-at org-not-done-heading-regexp)
  8427. (throw 'dont-block t)) ; do not block, parent is not a TODO
  8428. (setq pos (point))
  8429. (setq parent-pos (and (org-up-heading-safe) (point)))
  8430. (unless parent-pos (throw 'dont-block t)) ; no parent
  8431. (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
  8432. (forward-line 1)
  8433. (re-search-forward org-not-done-heading-regexp pos t)
  8434. (setq org-block-entry-blocking (org-get-heading)))
  8435. (throw 'dont-block nil)))))))) ; block, older sibling not done.
  8436. (defcustom org-track-ordered-property-with-tag nil
  8437. "Should the ORDERED property also be shown as a tag?
  8438. The ORDERED property decides if an entry should require subtasks to be
  8439. completed in sequence. Since a property is not very visible, setting
  8440. this option means that toggling the ORDERED property with the command
  8441. `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
  8442. not relevant for the behavior, but it makes things more visible.
  8443. Note that toggling the tag with tags commands will not change the property
  8444. and therefore not influence behavior!
  8445. This can be t, meaning the tag ORDERED should be used. It can also be a
  8446. string to select a different tag for this task."
  8447. :group 'org-todo
  8448. :type '(choice
  8449. (const :tag "No tracking" nil)
  8450. (const :tag "Track with ORDERED tag" t)
  8451. (string :tag "Use other tag")))
  8452. (defun org-toggle-ordered-property ()
  8453. "Toggle the ORDERED property of the current entry.
  8454. For better visibility, you can track the value of this property with a tag.
  8455. See variable `org-track-ordered-property-with-tag'."
  8456. (interactive)
  8457. (let* ((t1 org-track-ordered-property-with-tag)
  8458. (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
  8459. (save-excursion
  8460. (org-back-to-heading)
  8461. (if (org-entry-get nil "ORDERED")
  8462. (progn
  8463. (org-delete-property "ORDERED")
  8464. (and tag (org-toggle-tag tag 'off))
  8465. (message "Subtasks can be completed in arbitrary order"))
  8466. (org-entry-put nil "ORDERED" "t")
  8467. (and tag (org-toggle-tag tag 'on))
  8468. (message "Subtasks must be completed in sequence")))))
  8469. (defun org-block-todo-from-checkboxes (change-plist)
  8470. "Block turning an entry into a TODO, using checkboxes.
  8471. This checks whether the current task should be blocked from state
  8472. changes because there are unchecked boxes in this entry."
  8473. (if (not org-enforce-todo-checkbox-dependencies)
  8474. t ; if locally turned off don't block
  8475. (catch 'dont-block
  8476. ;; If this is not a todo state change, or if this entry is already DONE,
  8477. ;; do not block
  8478. (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
  8479. (member (plist-get change-plist :from)
  8480. (cons 'done org-done-keywords))
  8481. (member (plist-get change-plist :to)
  8482. (cons 'todo org-not-done-keywords))
  8483. (not (plist-get change-plist :to)))
  8484. (throw 'dont-block t))
  8485. ;; If this task has checkboxes that are not checked, it's blocked
  8486. (save-excursion
  8487. (org-back-to-heading t)
  8488. (let ((beg (point)) end)
  8489. (outline-next-heading)
  8490. (setq end (point))
  8491. (goto-char beg)
  8492. (when (org-list-search-forward
  8493. (concat (org-item-beginning-re)
  8494. "\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?"
  8495. "\\[[- ]\\]")
  8496. end t)
  8497. (when (boundp 'org-blocked-by-checkboxes)
  8498. (setq org-blocked-by-checkboxes t))
  8499. (throw 'dont-block nil))))
  8500. t))) ; do not block
  8501. (defun org-entry-blocked-p ()
  8502. "Non-nil if entry at point is blocked."
  8503. (and (not (org-entry-get nil "NOBLOCKING"))
  8504. (member (org-entry-get nil "TODO") org-not-done-keywords)
  8505. (not (run-hook-with-args-until-failure
  8506. 'org-blocker-hook
  8507. (list :type 'todo-state-change
  8508. :position (point)
  8509. :from 'todo
  8510. :to 'done)))))
  8511. (defun org-update-statistics-cookies (all)
  8512. "Update the statistics cookie, either from TODO or from checkboxes.
  8513. This should be called with the cursor in a line with a statistics
  8514. cookie. When called with a \\[universal-argument] prefix, update
  8515. all statistics cookies in the buffer."
  8516. (interactive "P")
  8517. (if all
  8518. (progn
  8519. (org-update-checkbox-count 'all)
  8520. (org-map-region 'org-update-parent-todo-statistics
  8521. (point-min) (point-max)))
  8522. (if (not (org-at-heading-p))
  8523. (org-update-checkbox-count)
  8524. (let ((pos (point-marker))
  8525. end l1 l2)
  8526. (ignore-errors (org-back-to-heading t))
  8527. (if (not (org-at-heading-p))
  8528. (org-update-checkbox-count)
  8529. (setq l1 (org-outline-level))
  8530. (setq end
  8531. (save-excursion
  8532. (outline-next-heading)
  8533. (when (org-at-heading-p) (setq l2 (org-outline-level)))
  8534. (point)))
  8535. (if (and (save-excursion
  8536. (re-search-forward
  8537. "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) \\[[- X]\\]" end t))
  8538. (not (save-excursion
  8539. (re-search-forward
  8540. ":COOKIE_DATA:.*\\<todo\\>" end t))))
  8541. (org-update-checkbox-count)
  8542. (if (and l2 (> l2 l1))
  8543. (progn
  8544. (goto-char end)
  8545. (org-update-parent-todo-statistics))
  8546. (goto-char pos)
  8547. (beginning-of-line 1)
  8548. (while (re-search-forward
  8549. "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)"
  8550. (line-end-position) t)
  8551. (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
  8552. (goto-char pos)
  8553. (move-marker pos nil)))))
  8554. (defvar org-entry-property-inherited-from) ;; defined below
  8555. (defun org-update-parent-todo-statistics ()
  8556. "Update any statistics cookie in the parent of the current headline.
  8557. When `org-hierarchical-todo-statistics' is nil, statistics will cover
  8558. the entire subtree and this will travel up the hierarchy and update
  8559. statistics everywhere."
  8560. (let* ((prop (save-excursion
  8561. (org-up-heading-safe)
  8562. (org-entry-get nil "COOKIE_DATA" 'inherit)))
  8563. (recursive (or (not org-hierarchical-todo-statistics)
  8564. (and prop (string-match "\\<recursive\\>" prop))))
  8565. (lim (or (and prop (marker-position org-entry-property-inherited-from))
  8566. 0))
  8567. (first t)
  8568. (box-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
  8569. level ltoggle l1 new ndel
  8570. (cnt-all 0) (cnt-done 0) is-percent kwd
  8571. checkbox-beg cookie-present)
  8572. (catch 'exit
  8573. (save-excursion
  8574. (beginning-of-line 1)
  8575. (setq ltoggle (funcall outline-level))
  8576. ;; Three situations are to consider:
  8577. ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
  8578. ;; to the top-level ancestor on the headline;
  8579. ;; 2. If parent has "recursive" property, repeat up to the
  8580. ;; headline setting that property, taking inheritance into
  8581. ;; account;
  8582. ;; 3. Else, move up to direct parent and proceed only once.
  8583. (while (and (setq level (org-up-heading-safe))
  8584. (or recursive first)
  8585. (>= (point) lim))
  8586. (setq first nil cookie-present nil)
  8587. (unless (and level
  8588. (not (string-match
  8589. "\\<checkbox\\>"
  8590. (downcase (or (org-entry-get nil "COOKIE_DATA")
  8591. "")))))
  8592. (throw 'exit nil))
  8593. (while (re-search-forward box-re (line-end-position) t)
  8594. (setq cnt-all 0 cnt-done 0 cookie-present t)
  8595. (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
  8596. (save-match-data
  8597. (unless (outline-next-heading) (throw 'exit nil))
  8598. (while (and (looking-at org-complex-heading-regexp)
  8599. (> (setq l1 (length (match-string 1))) level))
  8600. (setq kwd (and (or recursive (= l1 ltoggle))
  8601. (match-string 2)))
  8602. (if (or (eq org-provide-todo-statistics 'all-headlines)
  8603. (and (eq org-provide-todo-statistics t)
  8604. (or (member kwd org-done-keywords)))
  8605. (and (listp org-provide-todo-statistics)
  8606. (stringp (car org-provide-todo-statistics))
  8607. (or (member kwd org-provide-todo-statistics)
  8608. (member kwd org-done-keywords)))
  8609. (and (listp org-provide-todo-statistics)
  8610. (listp (car org-provide-todo-statistics))
  8611. (or (member kwd (car org-provide-todo-statistics))
  8612. (and (member kwd org-done-keywords)
  8613. (member kwd (cadr org-provide-todo-statistics))))))
  8614. (setq cnt-all (1+ cnt-all))
  8615. (and (eq org-provide-todo-statistics t)
  8616. kwd
  8617. (setq cnt-all (1+ cnt-all))))
  8618. (when (or (and (member org-provide-todo-statistics '(t all-headlines))
  8619. (member kwd org-done-keywords))
  8620. (and (listp org-provide-todo-statistics)
  8621. (listp (car org-provide-todo-statistics))
  8622. (member kwd org-done-keywords)
  8623. (member kwd (cadr org-provide-todo-statistics)))
  8624. (and (listp org-provide-todo-statistics)
  8625. (stringp (car org-provide-todo-statistics))
  8626. (member kwd org-done-keywords)))
  8627. (setq cnt-done (1+ cnt-done)))
  8628. (outline-next-heading)))
  8629. (setq new
  8630. (if is-percent
  8631. (format "[%d%%]" (floor (* 100.0 cnt-done)
  8632. (max 1 cnt-all)))
  8633. (format "[%d/%d]" cnt-done cnt-all))
  8634. ndel (- (match-end 0) checkbox-beg))
  8635. (goto-char checkbox-beg)
  8636. (insert new)
  8637. (delete-region (point) (+ (point) ndel))
  8638. (when org-auto-align-tags (org-fix-tags-on-the-fly)))
  8639. (when cookie-present
  8640. (run-hook-with-args 'org-after-todo-statistics-hook
  8641. cnt-done (- cnt-all cnt-done))))))
  8642. (run-hooks 'org-todo-statistics-hook)))
  8643. (defvar org-after-todo-statistics-hook nil
  8644. "Hook that is called after a TODO statistics cookie has been updated.
  8645. Each function is called with two arguments: the number of not-done entries
  8646. and the number of done entries.
  8647. For example, the following function, when added to this hook, will switch
  8648. an entry to DONE when all children are done, and back to TODO when new
  8649. entries are set to a TODO status. Note that this hook is only called
  8650. when there is a statistics cookie in the headline!
  8651. (defun org-summary-todo (n-done n-not-done)
  8652. \"Switch entry to DONE when all subentries are done, to TODO otherwise.\"
  8653. (let (org-log-done org-log-states) ; turn off logging
  8654. (org-todo (if (= n-not-done 0) \"DONE\" \"TODO\"))))")
  8655. (defvar org-todo-statistics-hook nil
  8656. "Hook that is run whenever Org thinks TODO statistics should be updated.
  8657. This hook runs even if there is no statistics cookie present, in which case
  8658. `org-after-todo-statistics-hook' would not run.")
  8659. (defun org-todo-trigger-tag-changes (state)
  8660. "Apply the changes defined in `org-todo-state-tags-triggers'."
  8661. (let ((l org-todo-state-tags-triggers)
  8662. changes)
  8663. (when (or (not state) (equal state ""))
  8664. (setq changes (append changes (cdr (assoc "" l)))))
  8665. (when (and (stringp state) (> (length state) 0))
  8666. (setq changes (append changes (cdr (assoc state l)))))
  8667. (when (member state org-not-done-keywords)
  8668. (setq changes (append changes (cdr (assq 'todo l)))))
  8669. (when (member state org-done-keywords)
  8670. (setq changes (append changes (cdr (assq 'done l)))))
  8671. (dolist (c changes)
  8672. (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
  8673. (defun org-local-logging (value)
  8674. "Get logging settings from a property VALUE."
  8675. ;; Directly set the variables, they are already local.
  8676. (setq org-log-done nil
  8677. org-log-repeat nil
  8678. org-todo-log-states nil)
  8679. (dolist (w (split-string value))
  8680. (let (a)
  8681. (cond
  8682. ((setq a (assoc w org-startup-options))
  8683. (and (member (nth 1 a) '(org-log-done org-log-repeat))
  8684. (set (nth 1 a) (nth 2 a))))
  8685. ((setq a (org-extract-log-state-settings w))
  8686. (and (member (car a) org-todo-keywords-1)
  8687. (push a org-todo-log-states)))))))
  8688. (defun org-get-todo-sequence-head (kwd)
  8689. "Return the head of the TODO sequence to which KWD belongs.
  8690. If KWD is not set, check if there is a text property remembering the
  8691. right sequence."
  8692. (let (p)
  8693. (cond
  8694. ((not kwd)
  8695. (or (get-text-property (line-beginning-position) 'org-todo-head)
  8696. (progn
  8697. (setq p (next-single-property-change (line-beginning-position)
  8698. 'org-todo-head
  8699. nil (line-end-position)))
  8700. (get-text-property p 'org-todo-head))))
  8701. ((not (member kwd org-todo-keywords-1))
  8702. (car org-todo-keywords-1))
  8703. (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
  8704. (defun org-fast-todo-selection (&optional current-state)
  8705. "Fast TODO keyword selection with single keys.
  8706. Returns the new TODO keyword, or nil if no state change should occur.
  8707. When CURRENT-STATE is given and selection letters are not unique globally,
  8708. prefer a state in the current sequence over on in another sequence."
  8709. (let* ((fulltable org-todo-key-alist)
  8710. (head (org-get-todo-sequence-head current-state))
  8711. (done-keywords org-done-keywords) ;; needed for the faces.
  8712. (maxlen (apply 'max (mapcar
  8713. (lambda (x)
  8714. (if (stringp (car x)) (string-width (car x)) 0))
  8715. fulltable)))
  8716. (expert (equal org-use-fast-todo-selection 'expert))
  8717. (prompt "")
  8718. (fwidth (+ maxlen 3 1 3))
  8719. (ncol (/ (- (window-width) 4) fwidth))
  8720. tg cnt e c tbl subtable
  8721. groups ingroup in-current-sequence)
  8722. (save-excursion
  8723. (save-window-excursion
  8724. (if expert
  8725. (set-buffer (get-buffer-create " *Org todo*"))
  8726. (delete-other-windows)
  8727. (set-window-buffer (split-window-vertically) (get-buffer-create " *Org todo*"))
  8728. (org-switch-to-buffer-other-window " *Org todo*"))
  8729. (erase-buffer)
  8730. (setq-local org-done-keywords done-keywords)
  8731. (setq tbl fulltable cnt 0)
  8732. (while (setq e (pop tbl))
  8733. (cond
  8734. ((equal e '(:startgroup))
  8735. (push '() groups) (setq ingroup t)
  8736. (unless (= cnt 0)
  8737. (setq cnt 0)
  8738. (insert "\n"))
  8739. (setq prompt (concat prompt "{"))
  8740. (insert "{ "))
  8741. ((equal e '(:endgroup))
  8742. (setq ingroup nil cnt 0 in-current-sequence nil)
  8743. (setq prompt (concat prompt "}"))
  8744. (insert "}\n"))
  8745. ((equal e '(:newline))
  8746. (unless (= cnt 0)
  8747. (setq cnt 0)
  8748. (insert "\n")
  8749. (setq e (car tbl))
  8750. (while (equal (car tbl) '(:newline))
  8751. (insert "\n")
  8752. (setq tbl (cdr tbl)))))
  8753. (t
  8754. (setq tg (car e) c (cdr e))
  8755. (if (equal tg head) (setq in-current-sequence t))
  8756. (when ingroup (push tg (car groups)))
  8757. (when in-current-sequence (push e subtable))
  8758. (setq tg (org-add-props tg nil 'face
  8759. (org-get-todo-face tg)))
  8760. (when (and (= cnt 0) (not ingroup)) (insert " "))
  8761. (setq prompt (concat prompt "[" (char-to-string c) "] " tg " "))
  8762. (insert "[" c "] " tg (make-string
  8763. (- fwidth 4 (length tg)) ?\ ))
  8764. (when (and (= (setq cnt (1+ cnt)) ncol)
  8765. ;; Avoid lines with just a closing delimiter.
  8766. (not (equal (car tbl) '(:endgroup))))
  8767. (insert "\n")
  8768. (when ingroup (insert " "))
  8769. (setq cnt 0)))))
  8770. (insert "\n")
  8771. (goto-char (point-min))
  8772. (unless expert (org-fit-window-to-buffer))
  8773. (message (concat "[a-z..]:Set [SPC]:clear"
  8774. (if expert (concat "\n" prompt) "")))
  8775. (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
  8776. (setq subtable (nreverse subtable))
  8777. (cond
  8778. ((or (= c ?\C-g)
  8779. (and (= c ?q) (not (rassoc c fulltable))))
  8780. (setq quit-flag t))
  8781. ((= c ?\ ) nil)
  8782. ((setq e (or (rassoc c subtable) (rassoc c fulltable))
  8783. tg (car e))
  8784. tg)
  8785. (t (setq quit-flag t)))))))
  8786. (defun org-entry-is-todo-p ()
  8787. (member (org-get-todo-state) org-not-done-keywords))
  8788. (defun org-entry-is-done-p ()
  8789. (member (org-get-todo-state) org-done-keywords))
  8790. (defun org-get-todo-state ()
  8791. "Return the TODO keyword of the current subtree."
  8792. (save-excursion
  8793. (org-back-to-heading t)
  8794. (and (let ((case-fold-search nil))
  8795. (looking-at org-todo-line-regexp))
  8796. (match-end 2)
  8797. (match-string 2))))
  8798. (defun org-at-date-range-p (&optional inactive-ok)
  8799. "Non-nil if point is inside a date range.
  8800. When optional argument INACTIVE-OK is non-nil, also consider
  8801. inactive time ranges.
  8802. When this function returns a non-nil value, match data is set
  8803. according to `org-tr-regexp-both' or `org-tr-regexp', depending
  8804. on INACTIVE-OK."
  8805. (interactive)
  8806. (save-excursion
  8807. (catch 'exit
  8808. (let ((pos (point)))
  8809. (skip-chars-backward "^[<\r\n")
  8810. (skip-chars-backward "<[")
  8811. (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
  8812. (>= (match-end 0) pos)
  8813. (throw 'exit t))
  8814. (skip-chars-backward "^<[\r\n")
  8815. (skip-chars-backward "<[")
  8816. (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
  8817. (>= (match-end 0) pos)
  8818. (throw 'exit t)))
  8819. nil)))
  8820. (defun org-get-repeat (&optional timestamp)
  8821. "Check if there is a time-stamp with repeater in this entry.
  8822. Return the repeater, as a string, or nil. Also return nil when
  8823. this function is called before first heading.
  8824. When optional argument TIMESTAMP is a string, extract the
  8825. repeater from there instead."
  8826. (save-match-data
  8827. (cond
  8828. (timestamp
  8829. (and (string-match org-repeat-re timestamp)
  8830. (match-string-no-properties 1 timestamp)))
  8831. ((org-before-first-heading-p) nil)
  8832. (t
  8833. (save-excursion
  8834. (org-back-to-heading t)
  8835. (let ((end (org-entry-end-position)))
  8836. (catch :repeat
  8837. (while (re-search-forward org-repeat-re end t)
  8838. (when (save-match-data (org-at-timestamp-p 'agenda))
  8839. (throw :repeat (match-string-no-properties 1)))))))))))
  8840. (defvar org-last-changed-timestamp)
  8841. (defvar org-last-inserted-timestamp)
  8842. (defvar org-log-post-message)
  8843. (defvar org-log-note-purpose)
  8844. (defvar org-log-note-how nil)
  8845. (defvar org-log-note-extra)
  8846. (defvar org-log-setup nil)
  8847. (defun org-auto-repeat-maybe (done-word)
  8848. "Check if the current headline contains a repeated time-stamp.
  8849. If yes, set TODO state back to what it was and change the base date
  8850. of repeating deadline/scheduled time stamps to new date.
  8851. This function is run automatically after each state change to a DONE state."
  8852. (let* ((repeat (org-get-repeat))
  8853. (aa (assoc org-last-state org-todo-kwd-alist))
  8854. (interpret (nth 1 aa))
  8855. (head (nth 2 aa))
  8856. (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
  8857. (msg "Entry repeats: ")
  8858. (org-log-done nil)
  8859. (org-todo-log-states nil)
  8860. (end (copy-marker (org-entry-end-position))))
  8861. (when (and repeat (not (= 0 (string-to-number (substring repeat 1)))))
  8862. (when (eq org-log-repeat t) (setq org-log-repeat 'state))
  8863. (let ((to-state
  8864. (or (org-entry-get nil "REPEAT_TO_STATE" 'selective)
  8865. (and (stringp org-todo-repeat-to-state)
  8866. org-todo-repeat-to-state)
  8867. (and org-todo-repeat-to-state org-last-state))))
  8868. (org-todo (cond ((and to-state (member to-state org-todo-keywords-1))
  8869. to-state)
  8870. ((eq interpret 'type) org-last-state)
  8871. (head)
  8872. (t 'none))))
  8873. (org-back-to-heading t)
  8874. (org-add-planning-info nil nil 'closed)
  8875. ;; When `org-log-repeat' is non-nil or entry contains
  8876. ;; a clock, set LAST_REPEAT property.
  8877. (when (or org-log-repeat
  8878. (catch :clock
  8879. (save-excursion
  8880. (while (re-search-forward org-clock-line-re end t)
  8881. (when (org-at-clock-log-p) (throw :clock t))))))
  8882. (org-entry-put nil "LAST_REPEAT" (format-time-string
  8883. (org-time-stamp-format t t)
  8884. (org-current-effective-time))))
  8885. (when org-log-repeat
  8886. (if org-log-setup
  8887. ;; We are already setup for some record.
  8888. (when (eq org-log-repeat 'note)
  8889. ;; Make sure we take a note, not only a time stamp.
  8890. (setq org-log-note-how 'note))
  8891. ;; Set up for taking a record.
  8892. (org-add-log-setup 'state
  8893. (or done-word (car org-done-keywords))
  8894. org-last-state
  8895. org-log-repeat)))
  8896. ;; Time-stamps without a repeater are usually skipped. However,
  8897. ;; a SCHEDULED time-stamp without one is removed, as they are no
  8898. ;; longer relevant.
  8899. (save-excursion
  8900. (let ((scheduled (org-entry-get (point) "SCHEDULED")))
  8901. (when (and scheduled (not (string-match-p org-repeat-re scheduled)))
  8902. (org-remove-timestamp-with-keyword org-scheduled-string))))
  8903. ;; Update every time-stamp with a repeater in the entry.
  8904. (let ((planning-re (regexp-opt
  8905. (list org-scheduled-string org-deadline-string))))
  8906. (while (re-search-forward org-repeat-re end t)
  8907. (let* ((ts (match-string 0))
  8908. (type (if (not (org-at-planning-p)) "Plain:"
  8909. (save-excursion
  8910. (re-search-backward
  8911. planning-re (line-beginning-position) t)
  8912. (match-string 0)))))
  8913. (when (and (org-at-timestamp-p 'agenda)
  8914. (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts))
  8915. (let ((n (string-to-number (match-string 2 ts)))
  8916. (what (match-string 3 ts)))
  8917. (when (equal what "w") (setq n (* n 7) what "d"))
  8918. (when (and (equal what "h")
  8919. (not (string-match-p "[0-9]\\{1,2\\}:[0-9]\\{2\\}"
  8920. ts)))
  8921. (user-error
  8922. "Cannot repeat in %d hour(s) because no hour has been set"
  8923. n))
  8924. ;; Preparation, see if we need to modify the start
  8925. ;; date for the change.
  8926. (when (match-end 1)
  8927. (let ((time (save-match-data (org-time-string-to-time ts)))
  8928. (repeater-type (match-string 1 ts)))
  8929. (cond
  8930. ((equal "." repeater-type)
  8931. ;; Shift starting date to today, or now if
  8932. ;; repeater is by hours.
  8933. (if (equal what "h")
  8934. (org-timestamp-change
  8935. (floor (- (org-time-stamp-to-now ts t)) 60) 'minute)
  8936. (org-timestamp-change
  8937. (- (org-today) (time-to-days time)) 'day)))
  8938. ((equal "+" repeater-type)
  8939. (let ((nshiftmax 10)
  8940. (nshift 0))
  8941. (while (or (= nshift 0)
  8942. (not (time-less-p nil time)))
  8943. (when (= nshiftmax (cl-incf nshift))
  8944. (or (y-or-n-p
  8945. (format "%d repeater intervals were not \
  8946. enough to shift date past today. Continue? "
  8947. nshift))
  8948. (user-error "Abort")))
  8949. (org-timestamp-change n (cdr (assoc what whata)))
  8950. (org-in-regexp org-ts-regexp3)
  8951. (setq ts (match-string 1))
  8952. (setq time
  8953. (save-match-data
  8954. (org-time-string-to-time ts)))))
  8955. (org-timestamp-change (- n) (cdr (assoc what whata)))
  8956. ;; Rematch, so that we have everything in place
  8957. ;; for the real shift.
  8958. (org-in-regexp org-ts-regexp3)
  8959. (setq ts (match-string 1))
  8960. (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)"
  8961. ts)))))
  8962. (save-excursion
  8963. (org-timestamp-change n (cdr (assoc what whata)) nil t))
  8964. (setq msg
  8965. (concat msg type " " org-last-changed-timestamp " ")))))))
  8966. (run-hooks 'org-todo-repeat-hook)
  8967. (setq org-log-post-message msg)
  8968. (message msg))))
  8969. (defun org-show-todo-tree (arg)
  8970. "Make a compact tree which shows all headlines marked with TODO.
  8971. The tree will show the lines where the regexp matches, and all higher
  8972. headlines above the match.
  8973. With a `\\[universal-argument]' prefix, prompt for a regexp to match.
  8974. With a numeric prefix N, construct a sparse tree for the Nth element
  8975. of `org-todo-keywords-1'."
  8976. (interactive "P")
  8977. (let ((case-fold-search nil)
  8978. (kwd-re
  8979. (cond ((null arg) (concat org-not-done-regexp "\\s-"))
  8980. ((equal arg '(4))
  8981. (let ((kwd
  8982. (completing-read "Keyword (or KWD1|KWD2|...): "
  8983. (mapcar #'list org-todo-keywords-1))))
  8984. (concat "\\("
  8985. (mapconcat 'identity (org-split-string kwd "|") "\\|")
  8986. "\\)\\>")))
  8987. ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
  8988. (regexp-quote (nth (1- (prefix-numeric-value arg))
  8989. org-todo-keywords-1)))
  8990. (t (user-error "Invalid prefix argument: %s" arg)))))
  8991. (message "%d TODO entries found"
  8992. (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
  8993. (defun org--deadline-or-schedule (arg type time)
  8994. "Insert DEADLINE or SCHEDULE information in current entry.
  8995. TYPE is either `deadline' or `scheduled'. See `org-deadline' or
  8996. `org-schedule' for information about ARG and TIME arguments."
  8997. (org-fold-core-ignore-modifications
  8998. (let* ((deadline? (eq type 'deadline))
  8999. (keyword (if deadline? org-deadline-string org-scheduled-string))
  9000. (log (if deadline? org-log-redeadline org-log-reschedule))
  9001. (old-date (org-entry-get nil (if deadline? "DEADLINE" "SCHEDULED")))
  9002. (old-date-time (and old-date (org-time-string-to-time old-date)))
  9003. ;; Save repeater cookie from either TIME or current scheduled
  9004. ;; time stamp. We are going to insert it back at the end of
  9005. ;; the process.
  9006. (repeater (or (and (org-string-nw-p time)
  9007. ;; We use `org-ts-regexp-both' because we
  9008. ;; need to tell the difference between a
  9009. ;; real repeater and a time delta, e.g.
  9010. ;; "+2d".
  9011. (string-match-p org-ts-regexp-both time)
  9012. (string-match "\\([.+-]+[0-9]+[hdwmy]\
  9013. \\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\)"
  9014. time)
  9015. (match-string 1 time))
  9016. (and (org-string-nw-p old-date)
  9017. (string-match "\\([.+-]+[0-9]+[hdwmy]\
  9018. \\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\)"
  9019. old-date)
  9020. (match-string 1 old-date)))))
  9021. (pcase arg
  9022. (`(4)
  9023. (if (not old-date)
  9024. (message (if deadline? "Entry had no deadline to remove"
  9025. "Entry was not scheduled"))
  9026. (when (and old-date log)
  9027. (org-add-log-setup (if deadline? 'deldeadline 'delschedule)
  9028. nil old-date log))
  9029. (org-remove-timestamp-with-keyword keyword)
  9030. (message (if deadline? "Entry no longer has a deadline."
  9031. "Entry is no longer scheduled."))))
  9032. (`(16)
  9033. (save-excursion
  9034. (org-back-to-heading t)
  9035. (let ((regexp (if deadline? org-deadline-time-regexp
  9036. org-scheduled-time-regexp)))
  9037. (if (not (re-search-forward regexp (line-end-position 2) t))
  9038. (user-error (if deadline? "No deadline information to update"
  9039. "No scheduled information to update"))
  9040. (let* ((rpl0 (match-string 1))
  9041. (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0))
  9042. (msg (if deadline? "Warn starting from" "Delay until")))
  9043. (replace-match
  9044. (concat keyword
  9045. " <" rpl
  9046. (format " -%dd"
  9047. (abs (- (time-to-days
  9048. (save-match-data
  9049. (org-read-date
  9050. nil t nil msg old-date-time)))
  9051. (time-to-days old-date-time))))
  9052. ">") t t))))))
  9053. (_
  9054. (org-add-planning-info type time 'closed)
  9055. (when (and old-date
  9056. log
  9057. (not (equal old-date org-last-inserted-timestamp)))
  9058. (org-add-log-setup (if deadline? 'redeadline 'reschedule)
  9059. org-last-inserted-timestamp
  9060. old-date
  9061. log))
  9062. (when repeater
  9063. (save-excursion
  9064. (org-back-to-heading t)
  9065. (when (re-search-forward
  9066. (concat keyword " " org-last-inserted-timestamp)
  9067. (line-end-position 2)
  9068. t)
  9069. (goto-char (1- (match-end 0)))
  9070. (insert-and-inherit " " repeater)
  9071. (setq org-last-inserted-timestamp
  9072. (concat (substring org-last-inserted-timestamp 0 -1)
  9073. " " repeater
  9074. (substring org-last-inserted-timestamp -1))))))
  9075. (message (if deadline? "Deadline on %s" "Scheduled to %s")
  9076. org-last-inserted-timestamp))))))
  9077. (defun org-deadline (arg &optional time)
  9078. "Insert a \"DEADLINE:\" string with a timestamp to make a deadline.
  9079. When called interactively, this command pops up the Emacs calendar to let
  9080. the user select a date.
  9081. With one universal prefix argument, remove any deadline from the item.
  9082. With two universal prefix arguments, prompt for a warning delay.
  9083. With argument TIME, set the deadline at the corresponding date. TIME
  9084. can either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
  9085. (interactive "P")
  9086. (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
  9087. (org-map-entries
  9088. (lambda () (org--deadline-or-schedule arg 'deadline time))
  9089. nil
  9090. (if (eq org-loop-over-headlines-in-active-region 'start-level)
  9091. 'region-start-level
  9092. 'region)
  9093. (lambda () (when (org-invisible-p) (org-end-of-subtree nil t))))
  9094. (org--deadline-or-schedule arg 'deadline time)))
  9095. (defun org-schedule (arg &optional time)
  9096. "Insert a \"SCHEDULED:\" string with a timestamp to schedule an item.
  9097. When called interactively, this command pops up the Emacs calendar to let
  9098. the user select a date.
  9099. With one universal prefix argument, remove any scheduling date from the item.
  9100. With two universal prefix arguments, prompt for a delay cookie.
  9101. With argument TIME, scheduled at the corresponding date. TIME can
  9102. either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
  9103. (interactive "P")
  9104. (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
  9105. (org-map-entries
  9106. (lambda () (org--deadline-or-schedule arg 'scheduled time))
  9107. nil
  9108. (if (eq org-loop-over-headlines-in-active-region 'start-level)
  9109. 'region-start-level
  9110. 'region)
  9111. (lambda () (when (org-invisible-p) (org-end-of-subtree nil t))))
  9112. (org--deadline-or-schedule arg 'scheduled time)))
  9113. (defun org-get-scheduled-time (pom &optional inherit)
  9114. "Get the scheduled time as a time tuple, of a format suitable
  9115. for calling org-schedule with, or if there is no scheduling,
  9116. returns nil."
  9117. (let ((time (org-entry-get pom "SCHEDULED" inherit)))
  9118. (when time
  9119. (org-time-string-to-time time))))
  9120. (defun org-get-deadline-time (pom &optional inherit)
  9121. "Get the deadline as a time tuple, of a format suitable for
  9122. calling org-deadline with, or if there is no scheduling, returns
  9123. nil."
  9124. (let ((time (org-entry-get pom "DEADLINE" inherit)))
  9125. (when time
  9126. (org-time-string-to-time time))))
  9127. (defun org-remove-timestamp-with-keyword (keyword)
  9128. "Remove all time stamps with KEYWORD in the current entry."
  9129. (let ((re (concat "\\<" (regexp-quote keyword) " +<[^>\n]+>[ \t]*"))
  9130. beg)
  9131. (save-excursion
  9132. (org-back-to-heading t)
  9133. (setq beg (point))
  9134. (outline-next-heading)
  9135. (while (re-search-backward re beg t)
  9136. (replace-match "")
  9137. (if (and (string-match "\\S-" (buffer-substring (line-beginning-position) (point)))
  9138. (equal (char-before) ?\ ))
  9139. (backward-delete-char 1)
  9140. (when (string-match "^[ \t]*$" (buffer-substring
  9141. (line-beginning-position) (line-end-position)))
  9142. (delete-region (line-beginning-position)
  9143. (min (point-max) (1+ (line-end-position))))))))))
  9144. (defvar org-time-was-given) ; dynamically scoped parameter
  9145. (defvar org-end-time-was-given) ; dynamically scoped parameter
  9146. (defun org-at-planning-p ()
  9147. "Non-nil when point is on a planning info line."
  9148. ;; This is as accurate and faster than `org-element-at-point' since
  9149. ;; planning info location is fixed in the section.
  9150. (or (let ((cached (org-element-at-point nil 'cached)))
  9151. (and cached
  9152. (eq 'planning (org-element-type cached))))
  9153. (org-with-wide-buffer
  9154. (beginning-of-line)
  9155. (and (looking-at-p org-planning-line-re)
  9156. (eq (point)
  9157. (ignore-errors
  9158. (if (and (featurep 'org-inlinetask) (org-inlinetask-in-task-p))
  9159. (org-back-to-heading t)
  9160. (org-with-limited-levels (org-back-to-heading t)))
  9161. (line-beginning-position 2)))))))
  9162. (defun org-add-planning-info (what &optional time &rest remove)
  9163. "Insert new timestamp with keyword in the planning line.
  9164. WHAT indicates what kind of time stamp to add. It is a symbol
  9165. among `closed', `deadline', `scheduled' and nil. TIME indicates
  9166. the time to use. If none is given, the user is prompted for
  9167. a date. REMOVE indicates what kind of entries to remove. An old
  9168. WHAT entry will also be removed."
  9169. (org-fold-core-ignore-modifications
  9170. (let (org-time-was-given org-end-time-was-given default-time default-input)
  9171. (when (and (memq what '(scheduled deadline))
  9172. (or (not time)
  9173. (and (stringp time)
  9174. (string-match "^[-+]+[0-9]" time))))
  9175. ;; Try to get a default date/time from existing timestamp
  9176. (save-excursion
  9177. (org-back-to-heading t)
  9178. (let ((end (save-excursion (outline-next-heading) (point))) ts)
  9179. (when (re-search-forward (if (eq what 'scheduled)
  9180. org-scheduled-time-regexp
  9181. org-deadline-time-regexp)
  9182. end t)
  9183. (setq ts (match-string 1)
  9184. default-time (org-time-string-to-time ts)
  9185. default-input (and ts (org-get-compact-tod ts)))))))
  9186. (when what
  9187. (setq time
  9188. (if (stringp time)
  9189. ;; This is a string (relative or absolute), set
  9190. ;; proper date.
  9191. (org-encode-time
  9192. (org-read-date-analyze
  9193. time default-time (decode-time default-time)))
  9194. ;; If necessary, get the time from the user
  9195. (or time (org-read-date nil 'to-time nil
  9196. (cl-case what
  9197. (deadline "DEADLINE")
  9198. (scheduled "SCHEDULED")
  9199. (otherwise nil))
  9200. default-time default-input)))))
  9201. (org-with-wide-buffer
  9202. (org-back-to-heading t)
  9203. (let ((planning? (save-excursion
  9204. (forward-line)
  9205. (looking-at-p org-planning-line-re))))
  9206. (cond
  9207. (planning?
  9208. (forward-line)
  9209. ;; Move to current indentation.
  9210. (skip-chars-forward " \t")
  9211. ;; Check if we have to remove something.
  9212. (dolist (type (if what (cons what remove) remove))
  9213. (save-excursion
  9214. (when (re-search-forward
  9215. (cl-case type
  9216. (closed org-closed-time-regexp)
  9217. (deadline org-deadline-time-regexp)
  9218. (scheduled org-scheduled-time-regexp)
  9219. (otherwise (error "Invalid planning type: %s" type)))
  9220. (line-end-position)
  9221. t)
  9222. ;; Delete until next keyword or end of line.
  9223. (delete-region
  9224. (match-beginning 0)
  9225. (if (re-search-forward org-keyword-time-not-clock-regexp
  9226. (line-end-position)
  9227. t)
  9228. (match-beginning 0)
  9229. (line-end-position))))))
  9230. ;; If there is nothing more to add and no more keyword is
  9231. ;; left, remove the line completely.
  9232. (if (and (looking-at-p "[ \t]*$") (not what))
  9233. (delete-region (line-end-position 0)
  9234. (line-end-position))
  9235. ;; If we removed last keyword, do not leave trailing white
  9236. ;; space at the end of line.
  9237. (let ((p (point)))
  9238. (save-excursion
  9239. (end-of-line)
  9240. (unless (= (skip-chars-backward " \t" p) 0)
  9241. (delete-region (point) (line-end-position)))))))
  9242. (what
  9243. (end-of-line)
  9244. (insert-and-inherit "\n")
  9245. (when org-adapt-indentation
  9246. (indent-to-column (1+ (org-outline-level)))))
  9247. (t nil)))
  9248. (when what
  9249. ;; Insert planning keyword.
  9250. (insert-and-inherit (cl-case what
  9251. (closed org-closed-string)
  9252. (deadline org-deadline-string)
  9253. (scheduled org-scheduled-string)
  9254. (otherwise (error "Invalid planning type: %s" what)))
  9255. " ")
  9256. ;; Insert associated timestamp.
  9257. (let ((ts (org-insert-time-stamp
  9258. time
  9259. (or org-time-was-given
  9260. (and (eq what 'closed) org-log-done-with-time))
  9261. (eq what 'closed)
  9262. nil nil (list org-end-time-was-given))))
  9263. (unless (eolp) (insert " "))
  9264. ts))))))
  9265. (defvar org-log-note-marker (make-marker)
  9266. "Marker pointing at the entry where the note is to be inserted.")
  9267. (defvar org-log-note-purpose nil)
  9268. (defvar org-log-note-state nil)
  9269. (defvar org-log-note-previous-state nil)
  9270. (defvar org-log-note-extra nil)
  9271. (defvar org-log-note-window-configuration nil)
  9272. (defvar org-log-note-return-to (make-marker))
  9273. (defvar org-log-note-effective-time nil
  9274. "Remembered current time.
  9275. So that dynamically scoped `org-extend-today-until' affects
  9276. timestamps in state change log.")
  9277. (defvar org-log-note-this-command
  9278. "`this-command' when `org-add-log-setup' is called.")
  9279. (defvar org-log-note-recursion-depth
  9280. "`recursion-depth' when `org-add-log-setup' is called.")
  9281. (defvar org-log-post-message nil
  9282. "Message to be displayed after a log note has been stored.
  9283. The auto-repeater uses this.")
  9284. (defun org-add-note ()
  9285. "Add a note to the current entry.
  9286. This is done in the same way as adding a state change note."
  9287. (interactive)
  9288. (org-add-log-setup 'note))
  9289. (defun org-log-beginning (&optional create)
  9290. "Return expected start of log notes in current entry.
  9291. When optional argument CREATE is non-nil, the function creates
  9292. a drawer to store notes, if necessary. Returned position ignores
  9293. narrowing."
  9294. (org-with-wide-buffer
  9295. (let ((drawer (org-log-into-drawer)))
  9296. (cond
  9297. (drawer
  9298. (org-end-of-meta-data)
  9299. (let ((regexp (concat "^[ \t]*:" (regexp-quote drawer) ":[ \t]*$"))
  9300. (end (if (org-at-heading-p) (point)
  9301. (save-excursion (outline-next-heading) (point))))
  9302. (case-fold-search t))
  9303. (catch 'exit
  9304. ;; Try to find existing drawer.
  9305. (while (re-search-forward regexp end t)
  9306. (let ((element (org-element-at-point)))
  9307. (when (eq (org-element-type element) 'drawer)
  9308. (let ((cend (org-element-property :contents-end element)))
  9309. (when (and (not org-log-states-order-reversed) cend)
  9310. (goto-char cend)))
  9311. (throw 'exit nil))))
  9312. ;; No drawer found. Create one, if permitted.
  9313. (when create
  9314. ;; Unless current heading is the last heading in buffer
  9315. ;; and does not have a newline, `org-end-of-meta-data'
  9316. ;; should move us somewhere below the heading.
  9317. ;; Avoid situation when we insert drawer right before
  9318. ;; first "*". Otherwise, if the previous heading is
  9319. ;; folded, we are inserting after visible newline at
  9320. ;; the end of the fold, thus breaking the fold
  9321. ;; continuity.
  9322. (unless (eobp)
  9323. (when (org-at-heading-p) (backward-char)))
  9324. (org-fold-core-ignore-modifications
  9325. (unless (bolp) (insert-and-inherit "\n"))
  9326. (let ((beg (point)))
  9327. (insert-and-inherit ":" drawer ":\n:END:\n")
  9328. (org-indent-region beg (point))
  9329. (org-fold-region (line-end-position -1) (1- (point)) t (if (eq org-fold-core-style 'text-properties) 'drawer 'outline)))))
  9330. (end-of-line -1))))
  9331. (t
  9332. (org-end-of-meta-data org-log-state-notes-insert-after-drawers)
  9333. (let ((endpos (point)))
  9334. (skip-chars-forward " \t\n")
  9335. (beginning-of-line)
  9336. (unless org-log-states-order-reversed
  9337. (org-skip-over-state-notes)
  9338. (skip-chars-backward " \t\n")
  9339. (beginning-of-line 2))
  9340. ;; When current headline is at the end of buffer and does not
  9341. ;; end with trailing newline the above can move to the
  9342. ;; beginning of the headline.
  9343. (when (< (point) endpos) (goto-char endpos))))))
  9344. (if (bolp) (point) (line-beginning-position 2))))
  9345. (defun org-add-log-setup (&optional purpose state prev-state how extra)
  9346. "Set up the post command hook to take a note.
  9347. If this is about to TODO state change, the new state is expected in STATE.
  9348. HOW is an indicator what kind of note should be created.
  9349. EXTRA is additional text that will be inserted into the notes buffer."
  9350. (move-marker org-log-note-marker (point))
  9351. (setq org-log-note-purpose purpose
  9352. org-log-note-state state
  9353. org-log-note-previous-state prev-state
  9354. org-log-note-how how
  9355. org-log-note-extra extra
  9356. org-log-note-effective-time (org-current-effective-time)
  9357. org-log-note-this-command this-command
  9358. org-log-note-recursion-depth (recursion-depth)
  9359. org-log-setup t)
  9360. (add-hook 'post-command-hook 'org-add-log-note 'append))
  9361. (defun org-skip-over-state-notes ()
  9362. "Skip past the list of State notes in an entry."
  9363. (when (ignore-errors (goto-char (org-in-item-p)))
  9364. (let* ((struct (org-list-struct))
  9365. (prevs (org-list-prevs-alist struct))
  9366. (regexp
  9367. (concat "[ \t]*- +"
  9368. (replace-regexp-in-string
  9369. " +" " +"
  9370. (org-replace-escapes
  9371. (regexp-quote (cdr (assq 'state org-log-note-headings)))
  9372. `(("%d" . ,org-ts-regexp-inactive)
  9373. ("%D" . ,org-ts-regexp)
  9374. ("%s" . "\\(?:\"\\S-+\"\\)?")
  9375. ("%S" . "\\(?:\"\\S-+\"\\)?")
  9376. ("%t" . ,org-ts-regexp-inactive)
  9377. ("%T" . ,org-ts-regexp)
  9378. ("%u" . ".*?")
  9379. ("%U" . ".*?")))))))
  9380. (while (looking-at-p regexp)
  9381. (goto-char (or (org-list-get-next-item (point) struct prevs)
  9382. (org-list-get-item-end (point) struct)))))))
  9383. (defun org-add-log-note (&optional _purpose)
  9384. "Pop up a window for taking a note, and add this note later."
  9385. (when (and (equal org-log-note-this-command this-command)
  9386. (= org-log-note-recursion-depth (recursion-depth)))
  9387. (remove-hook 'post-command-hook 'org-add-log-note)
  9388. (setq org-log-setup nil)
  9389. (setq org-log-note-window-configuration (current-window-configuration))
  9390. (delete-other-windows)
  9391. (move-marker org-log-note-return-to (point))
  9392. (pop-to-buffer-same-window (marker-buffer org-log-note-marker))
  9393. (goto-char org-log-note-marker)
  9394. (org-switch-to-buffer-other-window "*Org Note*")
  9395. (erase-buffer)
  9396. (if (memq org-log-note-how '(time state))
  9397. (org-store-log-note)
  9398. (let ((org-inhibit-startup t)) (org-mode))
  9399. (insert (format "# Insert note for %s.
  9400. # Finish with C-c C-c, or cancel with C-c C-k.\n\n"
  9401. (cl-case org-log-note-purpose
  9402. (clock-out "stopped clock")
  9403. (done "closed todo item")
  9404. (reschedule "rescheduling")
  9405. (delschedule "no longer scheduled")
  9406. (redeadline "changing deadline")
  9407. (deldeadline "removing deadline")
  9408. (refile "refiling")
  9409. (note "this entry")
  9410. (state
  9411. (format "state change from \"%s\" to \"%s\""
  9412. (or org-log-note-previous-state "")
  9413. (or org-log-note-state "")))
  9414. (t (error "This should not happen")))))
  9415. (when org-log-note-extra (insert org-log-note-extra))
  9416. (setq-local org-finish-function 'org-store-log-note)
  9417. (run-hooks 'org-log-buffer-setup-hook))))
  9418. (defvar org-note-abort nil) ; dynamically scoped
  9419. (defun org-store-log-note ()
  9420. "Finish taking a log note, and insert it to where it belongs."
  9421. (let ((txt (prog1 (buffer-string)
  9422. (kill-buffer)))
  9423. (note (cdr (assq org-log-note-purpose org-log-note-headings)))
  9424. lines)
  9425. (while (string-match "\\`# .*\n[ \t\n]*" txt)
  9426. (setq txt (replace-match "" t t txt)))
  9427. (when (string-match "\\s-+\\'" txt)
  9428. (setq txt (replace-match "" t t txt)))
  9429. (setq lines (and (not (equal "" txt)) (org-split-string txt "\n")))
  9430. (when (org-string-nw-p note)
  9431. (setq note
  9432. (org-replace-escapes
  9433. note
  9434. (list (cons "%u" (user-login-name))
  9435. (cons "%U" user-full-name)
  9436. (cons "%t" (format-time-string
  9437. (org-time-stamp-format 'long 'inactive)
  9438. org-log-note-effective-time))
  9439. (cons "%T" (format-time-string
  9440. (org-time-stamp-format 'long nil)
  9441. org-log-note-effective-time))
  9442. (cons "%d" (format-time-string
  9443. (org-time-stamp-format nil 'inactive)
  9444. org-log-note-effective-time))
  9445. (cons "%D" (format-time-string
  9446. (org-time-stamp-format nil nil)
  9447. org-log-note-effective-time))
  9448. (cons "%s" (cond
  9449. ((not org-log-note-state) "")
  9450. ((string-match-p org-ts-regexp
  9451. org-log-note-state)
  9452. (format "\"[%s]\""
  9453. (substring org-log-note-state 1 -1)))
  9454. (t (format "\"%s\"" org-log-note-state))))
  9455. (cons "%S"
  9456. (cond
  9457. ((not org-log-note-previous-state) "")
  9458. ((string-match-p org-ts-regexp
  9459. org-log-note-previous-state)
  9460. (format "\"[%s]\""
  9461. (substring
  9462. org-log-note-previous-state 1 -1)))
  9463. (t (format "\"%s\""
  9464. org-log-note-previous-state)))))))
  9465. (when lines (setq note (concat note " \\\\")))
  9466. (push note lines))
  9467. (when (and lines (not org-note-abort))
  9468. (with-current-buffer (marker-buffer org-log-note-marker)
  9469. (org-fold-core-ignore-modifications
  9470. (org-with-wide-buffer
  9471. ;; Find location for the new note.
  9472. (goto-char org-log-note-marker)
  9473. (set-marker org-log-note-marker nil)
  9474. ;; Note associated to a clock is to be located right after
  9475. ;; the clock. Do not move point.
  9476. (unless (eq org-log-note-purpose 'clock-out)
  9477. (goto-char (org-log-beginning t)))
  9478. ;; Make sure point is at the beginning of an empty line.
  9479. (cond ((not (bolp)) (let ((inhibit-read-only t)) (insert-and-inherit "\n")))
  9480. ((looking-at "[ \t]*\\S-") (save-excursion (insert-and-inherit "\n"))))
  9481. ;; In an existing list, add a new item at the top level.
  9482. ;; Otherwise, indent line like a regular one.
  9483. (let ((itemp (org-in-item-p)))
  9484. (if itemp
  9485. (indent-line-to
  9486. (let ((struct (save-excursion
  9487. (goto-char itemp) (org-list-struct))))
  9488. (org-list-get-ind (org-list-get-top-point struct) struct)))
  9489. (org-indent-line)))
  9490. (insert-and-inherit (org-list-bullet-string "-") (pop lines))
  9491. (let ((ind (org-list-item-body-column (line-beginning-position))))
  9492. (dolist (line lines)
  9493. (insert-and-inherit "\n")
  9494. (unless (string-empty-p line)
  9495. (indent-line-to ind)
  9496. (insert-and-inherit line))))
  9497. (message "Note stored")
  9498. (org-back-to-heading t))))))
  9499. ;; Don't add undo information when called from `org-agenda-todo'.
  9500. (set-window-configuration org-log-note-window-configuration)
  9501. (with-current-buffer (marker-buffer org-log-note-return-to)
  9502. (goto-char org-log-note-return-to))
  9503. (move-marker org-log-note-return-to nil)
  9504. (when org-log-post-message (message "%s" org-log-post-message)))
  9505. (defun org-remove-empty-drawer-at (pos)
  9506. "Remove an empty drawer at position POS.
  9507. POS may also be a marker."
  9508. (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
  9509. (org-with-wide-buffer
  9510. (goto-char pos)
  9511. (let ((drawer (org-element-at-point)))
  9512. (when (and (memq (org-element-type drawer) '(drawer property-drawer))
  9513. (not (org-element-property :contents-begin drawer)))
  9514. (delete-region (org-element-property :begin drawer)
  9515. (progn (goto-char (org-element-property :end drawer))
  9516. (skip-chars-backward " \r\t\n")
  9517. (forward-line)
  9518. (point))))))))
  9519. (defvar org-ts-type nil)
  9520. (defun org-sparse-tree (&optional arg type)
  9521. "Create a sparse tree, prompt for the details.
  9522. This command can create sparse trees. You first need to select the type
  9523. of match used to create the tree:
  9524. t Show all TODO entries.
  9525. T Show entries with a specific TODO keyword.
  9526. m Show entries selected by a tags/property match.
  9527. p Enter a property name and its value (both with completion on existing
  9528. names/values) and show entries with that property.
  9529. r Show entries matching a regular expression (`/' can be used as well).
  9530. b Show deadlines and scheduled items before a date.
  9531. a Show deadlines and scheduled items after a date.
  9532. d Show deadlines due within `org-deadline-warning-days'.
  9533. D Show deadlines and scheduled items between a date range."
  9534. (interactive "P")
  9535. (setq type (or type org-sparse-tree-default-date-type))
  9536. (setq org-ts-type type)
  9537. (message "Sparse tree: [r]egexp [t]odo [T]odo-kwd [m]atch [p]roperty
  9538. [d]eadlines [b]efore-date [a]fter-date [D]ates range
  9539. [c]ycle through date types: %s"
  9540. (cl-case type
  9541. (all "all timestamps")
  9542. (scheduled "only scheduled")
  9543. (deadline "only deadline")
  9544. (active "only active timestamps")
  9545. (inactive "only inactive timestamps")
  9546. (closed "with a closed time-stamp")
  9547. (otherwise "scheduled/deadline")))
  9548. (let ((answer (read-char-exclusive)))
  9549. (cl-case answer
  9550. (?c
  9551. (org-sparse-tree
  9552. arg
  9553. (cadr
  9554. (memq type '(nil all scheduled deadline active inactive closed)))))
  9555. (?d (call-interactively 'org-check-deadlines))
  9556. (?b (call-interactively 'org-check-before-date))
  9557. (?a (call-interactively 'org-check-after-date))
  9558. (?D (call-interactively 'org-check-dates-range))
  9559. (?t (call-interactively 'org-show-todo-tree))
  9560. (?T (org-show-todo-tree '(4)))
  9561. (?m (call-interactively 'org-match-sparse-tree))
  9562. ((?p ?P)
  9563. (let* ((kwd (completing-read
  9564. "Property: " (mapcar #'list (org-buffer-property-keys))))
  9565. (value (completing-read
  9566. "Value: " (mapcar #'list (org-property-values kwd)))))
  9567. (unless (string-match "\\`{.*}\\'" value)
  9568. (setq value (concat "\"" value "\"")))
  9569. (org-match-sparse-tree arg (concat kwd "=" value))))
  9570. ((?r ?R ?/) (call-interactively 'org-occur))
  9571. (otherwise (user-error "No such sparse tree command \"%c\"" answer)))))
  9572. (defvar-local org-occur-highlights nil
  9573. "List of overlays used for occur matches.")
  9574. (defvar-local org-occur-parameters nil
  9575. "Parameters of the active org-occur calls.
  9576. This is a list, each call to org-occur pushes as cons cell,
  9577. containing the regular expression and the callback, onto the list.
  9578. The list can contain several entries if `org-occur' has been called
  9579. several time with the KEEP-PREVIOUS argument. Otherwise, this list
  9580. will only contain one set of parameters. When the highlights are
  9581. removed (for example with `C-c C-c', or with the next edit (depending
  9582. on `org-remove-highlights-with-change'), this variable is emptied
  9583. as well.")
  9584. (defun org-occur (regexp &optional keep-previous callback)
  9585. "Make a compact tree showing all matches of REGEXP.
  9586. The tree will show the lines where the regexp matches, and any other context
  9587. defined in `org-fold-show-context-detail', which see.
  9588. When optional argument KEEP-PREVIOUS is non-nil, highlighting and exposing
  9589. done by a previous call to `org-occur' will be kept, to allow stacking of
  9590. calls to this command.
  9591. Optional argument CALLBACK can be a function of no argument. In this case,
  9592. it is called with point at the end of the match, match data being set
  9593. accordingly. Current match is shown only if the return value is non-nil.
  9594. The function must neither move point nor alter narrowing."
  9595. (interactive "sRegexp: \nP")
  9596. (when (equal regexp "")
  9597. (user-error "Regexp cannot be empty"))
  9598. (unless keep-previous
  9599. (org-remove-occur-highlights nil nil t))
  9600. (push (cons regexp callback) org-occur-parameters)
  9601. (let ((cnt 0))
  9602. (save-excursion
  9603. (goto-char (point-min))
  9604. (when (or (not keep-previous) ; do not want to keep
  9605. (not org-occur-highlights)) ; no previous matches
  9606. ;; hide everything
  9607. (org-cycle-overview))
  9608. (let ((case-fold-search (if (eq org-occur-case-fold-search 'smart)
  9609. (isearch-no-upper-case-p regexp t)
  9610. org-occur-case-fold-search)))
  9611. (while (re-search-forward regexp nil t)
  9612. (when (or (not callback)
  9613. (save-match-data (funcall callback)))
  9614. (setq cnt (1+ cnt))
  9615. (when org-highlight-sparse-tree-matches
  9616. (org-highlight-new-match (match-beginning 0) (match-end 0)))
  9617. (org-fold-show-context 'occur-tree)))))
  9618. (when org-remove-highlights-with-change
  9619. (add-hook 'before-change-functions 'org-remove-occur-highlights
  9620. nil 'local))
  9621. (unless org-sparse-tree-open-archived-trees
  9622. (org-fold-hide-archived-subtrees (point-min) (point-max)))
  9623. (run-hooks 'org-occur-hook)
  9624. (when (called-interactively-p 'interactive)
  9625. (message "%d match(es) for regexp %s" cnt regexp))
  9626. cnt))
  9627. (defun org-occur-next-match (&optional n _reset)
  9628. "Function for `next-error-function' to find sparse tree matches.
  9629. N is the number of matches to move, when negative move backwards.
  9630. This function always goes back to the starting point when no
  9631. match is found."
  9632. (let* ((limit (if (< n 0) (point-min) (point-max)))
  9633. (search-func (if (< n 0)
  9634. 'previous-single-char-property-change
  9635. 'next-single-char-property-change))
  9636. (n (abs n))
  9637. (pos (point))
  9638. p1)
  9639. (catch 'exit
  9640. (while (setq p1 (funcall search-func (point) 'org-type))
  9641. (when (equal p1 limit)
  9642. (goto-char pos)
  9643. (user-error "No more matches"))
  9644. (when (equal (get-char-property p1 'org-type) 'org-occur)
  9645. (setq n (1- n))
  9646. (when (= n 0)
  9647. (goto-char p1)
  9648. (throw 'exit (point))))
  9649. (goto-char p1))
  9650. (goto-char p1)
  9651. (user-error "No more matches"))))
  9652. (defun org-highlight-new-match (beg end)
  9653. "Highlight from BEG to END and mark the highlight is an occur headline."
  9654. (let ((ov (make-overlay beg end)))
  9655. (overlay-put ov 'face 'secondary-selection)
  9656. (overlay-put ov 'org-type 'org-occur)
  9657. (push ov org-occur-highlights)))
  9658. (defun org-remove-occur-highlights (&optional _beg _end noremove)
  9659. "Remove the occur highlights from the buffer.
  9660. BEG and END are ignored. If NOREMOVE is nil, remove this function
  9661. from the `before-change-functions' in the current buffer."
  9662. (interactive)
  9663. (unless org-inhibit-highlight-removal
  9664. (mapc #'delete-overlay org-occur-highlights)
  9665. (setq org-occur-highlights nil)
  9666. (setq org-occur-parameters nil)
  9667. (unless noremove
  9668. (remove-hook 'before-change-functions
  9669. 'org-remove-occur-highlights 'local))))
  9670. ;;;; Priorities
  9671. (defvar org-priority-regexp ".*?\\(\\[#\\([A-Z0-9]+\\)\\] ?\\)"
  9672. "Regular expression matching the priority indicator.
  9673. A priority indicator can be e.g. [#A] or [#1].
  9674. This regular expression matches these groups:
  9675. 0 : the whole match, e.g. \"TODO [#A] Hack\"
  9676. 1 : the priority cookie, e.g. \"[#A]\"
  9677. 2 : the value of the priority cookie, e.g. \"A\".")
  9678. (defun org-priority-up ()
  9679. "Increase the priority of the current item."
  9680. (interactive)
  9681. (org-priority 'up))
  9682. (defun org-priority-down ()
  9683. "Decrease the priority of the current item."
  9684. (interactive)
  9685. (org-priority 'down))
  9686. (defun org-priority (&optional action show)
  9687. "Change the priority of an item.
  9688. When called interactively with a `\\[universal-argument]' prefix,
  9689. show the priority in the minibuffer instead of changing it.
  9690. When called programmatically, ACTION can be `set', `up', `down',
  9691. or a character."
  9692. (interactive "P")
  9693. (when show
  9694. ;; Deprecation warning inserted for Org 9.2; once enough time has
  9695. ;; passed the SHOW argument should be removed.
  9696. (warn "`org-priority' called with deprecated SHOW argument"))
  9697. (if (equal action '(4))
  9698. (org-priority-show)
  9699. (unless org-priority-enable-commands
  9700. (user-error "Priority commands are disabled"))
  9701. (setq action (or action 'set))
  9702. (let ((nump (< org-priority-lowest 65))
  9703. current new news have remove)
  9704. (save-excursion
  9705. (org-back-to-heading t)
  9706. (when (looking-at org-priority-regexp)
  9707. (let ((ms (match-string 2)))
  9708. (setq current (org-priority-to-value ms)
  9709. have t)))
  9710. (cond
  9711. ((eq action 'remove)
  9712. (setq remove t new ?\ ))
  9713. ((or (eq action 'set)
  9714. (integerp action))
  9715. (if (not (eq action 'set))
  9716. (setq new action)
  9717. (setq
  9718. new
  9719. (if nump
  9720. (let* ((msg (format "Priority %s-%s, SPC to remove: "
  9721. (number-to-string org-priority-highest)
  9722. (number-to-string org-priority-lowest)))
  9723. (s (if (< 9 org-priority-lowest)
  9724. (read-string msg)
  9725. (message msg)
  9726. (char-to-string (read-char-exclusive)))))
  9727. (if (equal s " ") ?\s (string-to-number s)))
  9728. (progn (message "Priority %c-%c, SPC to remove: "
  9729. org-priority-highest org-priority-lowest)
  9730. (save-match-data
  9731. (setq new (read-char-exclusive)))))))
  9732. (when (and (= (upcase org-priority-highest) org-priority-highest)
  9733. (= (upcase org-priority-lowest) org-priority-lowest))
  9734. (setq new (upcase new)))
  9735. (cond ((equal new ?\s) (setq remove t))
  9736. ((or (< (upcase new) org-priority-highest) (> (upcase new) org-priority-lowest))
  9737. (user-error
  9738. (if nump
  9739. "Priority must be between `%s' and `%s'"
  9740. "Priority must be between `%c' and `%c'")
  9741. org-priority-highest org-priority-lowest))))
  9742. ((eq action 'up)
  9743. (setq new (if have
  9744. (1- current) ; normal cycling
  9745. ;; last priority was empty
  9746. (if (eq last-command this-command)
  9747. org-priority-lowest ; wrap around empty to lowest
  9748. ;; default
  9749. (if org-priority-start-cycle-with-default
  9750. org-priority-default
  9751. (1- org-priority-default))))))
  9752. ((eq action 'down)
  9753. (setq new (if have
  9754. (1+ current) ; normal cycling
  9755. ;; last priority was empty
  9756. (if (eq last-command this-command)
  9757. org-priority-highest ; wrap around empty to highest
  9758. ;; default
  9759. (if org-priority-start-cycle-with-default
  9760. org-priority-default
  9761. (1+ org-priority-default))))))
  9762. (t (user-error "Invalid action")))
  9763. (when (or (< (upcase new) org-priority-highest)
  9764. (> (upcase new) org-priority-lowest))
  9765. (if (and (memq action '(up down))
  9766. (not have) (not (eq last-command this-command)))
  9767. ;; `new' is from default priority
  9768. (error
  9769. "The default can not be set, see `org-priority-default' why")
  9770. ;; normal cycling: `new' is beyond highest/lowest priority
  9771. ;; and is wrapped around to the empty priority
  9772. (setq remove t)))
  9773. ;; Numerical priorities are limited to 64, beyond that number,
  9774. ;; assume the priority cookie is a character.
  9775. (setq news (if (> new 64) (format "%c" new) (format "%s" new)))
  9776. (if have
  9777. (if remove
  9778. (replace-match "" t t nil 1)
  9779. (replace-match news t t nil 2))
  9780. (if remove
  9781. (user-error "No priority cookie found in line")
  9782. (let ((case-fold-search nil)) (looking-at org-todo-line-regexp))
  9783. (if (match-end 2)
  9784. (progn
  9785. (goto-char (match-end 2))
  9786. (insert " [#" news "]"))
  9787. (goto-char (match-beginning 3))
  9788. (insert "[#" news "] "))))
  9789. (org-align-tags))
  9790. (if remove
  9791. (message "Priority removed")
  9792. (message "Priority of current item set to %s" news)))))
  9793. (defalias 'org-show-priority 'org-priority-show)
  9794. (defun org-priority-show ()
  9795. "Show the priority of the current item.
  9796. This priority is composed of the main priority given with the [#A] cookies,
  9797. and by additional input from the age of a schedules or deadline entry."
  9798. (interactive)
  9799. (let ((pri (if (eq major-mode 'org-agenda-mode)
  9800. (org-get-at-bol 'priority)
  9801. (save-excursion
  9802. (save-match-data
  9803. (beginning-of-line)
  9804. (and (looking-at org-heading-regexp)
  9805. (org-get-priority (match-string 0))))))))
  9806. (message "Priority is %d" (if pri pri -1000))))
  9807. (defun org-get-priority (s)
  9808. "Find priority cookie and return priority.
  9809. S is a string against which you can match `org-priority-regexp'.
  9810. If `org-priority-get-priority-function' is set to a custom
  9811. function, use it. Otherwise process S and output the priority
  9812. value, an integer."
  9813. (save-match-data
  9814. (if (functionp org-priority-get-priority-function)
  9815. (funcall org-priority-get-priority-function s)
  9816. (if (not (string-match org-priority-regexp s))
  9817. (* 1000 (- org-priority-lowest org-priority-default))
  9818. (* 1000 (- org-priority-lowest
  9819. (org-priority-to-value (match-string 2 s))))))))
  9820. ;;;; Tags
  9821. (defvar org-agenda-archives-mode)
  9822. (defvar org-map-continue-from nil
  9823. "Position from where mapping should continue.
  9824. Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
  9825. (defvar org-scanner-tags nil
  9826. "The current tag list while the tags scanner is running.")
  9827. (defvar org-trust-scanner-tags nil
  9828. "Should `org-get-tags' use the tags for the scanner.
  9829. This is for internal dynamical scoping only.
  9830. When this is non-nil, the function `org-get-tags' will return the value
  9831. of `org-scanner-tags' instead of building the list by itself. This
  9832. can lead to large speed-ups when the tags scanner is used in a file with
  9833. many entries, and when the list of tags is retrieved, for example to
  9834. obtain a list of properties. Building the tags list for each entry in such
  9835. a file becomes an N^2 operation - but with this variable set, it scales
  9836. as N.")
  9837. (defvar org--matcher-tags-todo-only nil)
  9838. (defun org-scan-tags (action matcher todo-only &optional start-level)
  9839. "Scan headline tags with inheritance and produce output ACTION.
  9840. ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
  9841. or `agenda' to produce an entry list for an agenda view. It can also be
  9842. a Lisp form or a function that should be called at each matched headline, in
  9843. this case the return value is a list of all return values from these calls.
  9844. MATCHER is a function accepting three arguments, returning
  9845. a non-nil value whenever a given set of tags qualifies a headline
  9846. for inclusion. See `org-make-tags-matcher' for more information.
  9847. As a special case, it can also be set to t (respectively nil) in
  9848. order to match all (respectively none) headline.
  9849. When TODO-ONLY is non-nil, only lines with a TODO keyword are
  9850. included in the output.
  9851. START-LEVEL can be a string with asterisks, reducing the scope to
  9852. headlines matching this string."
  9853. (require 'org-agenda)
  9854. (let* ((re (concat "^"
  9855. (if start-level
  9856. ;; Get the correct level to match
  9857. (concat "\\*\\{" (number-to-string start-level) "\\} ")
  9858. org-outline-regexp)
  9859. " *\\(?:\\(" (regexp-opt org-todo-keywords-1 t) "\\) \\)?"
  9860. " *\\(.*?\\)\\([ \t]:\\(?:" org-tag-re ":\\)+\\)?[ \t]*$"))
  9861. (props (list 'face 'default
  9862. 'done-face 'org-agenda-done
  9863. 'undone-face 'default
  9864. 'mouse-face 'highlight
  9865. 'org-not-done-regexp org-not-done-regexp
  9866. 'org-todo-regexp org-todo-regexp
  9867. 'org-complex-heading-regexp org-complex-heading-regexp
  9868. 'help-echo
  9869. (format "mouse-2 or RET jump to Org file %S"
  9870. (abbreviate-file-name
  9871. (or (buffer-file-name (buffer-base-buffer))
  9872. (buffer-name (buffer-base-buffer)))))))
  9873. (org-map-continue-from nil)
  9874. lspos tags tags-list
  9875. (tags-alist (list (cons 0 org-file-tags)))
  9876. (llast 0) rtn rtn1 level category i txt
  9877. todo marker entry priority
  9878. ts-date ts-date-type ts-date-pair)
  9879. (unless (or (member action '(agenda sparse-tree)) (functionp action))
  9880. (setq action (list 'lambda nil action)))
  9881. (save-excursion
  9882. (goto-char (point-min))
  9883. (when (eq action 'sparse-tree)
  9884. (org-cycle-overview)
  9885. (org-remove-occur-highlights))
  9886. (if (org-element--cache-active-p)
  9887. (let ((fast-re (concat "^"
  9888. (if start-level
  9889. ;; Get the correct level to match
  9890. (concat "\\*\\{" (number-to-string start-level) "\\} ")
  9891. org-outline-regexp))))
  9892. (org-element-cache-map
  9893. (lambda (el)
  9894. (goto-char (org-element-property :begin el))
  9895. (setq todo (org-element-property :todo-keyword el)
  9896. level (org-element-property :level el)
  9897. category (org-entry-get-with-inheritance "CATEGORY" nil el)
  9898. tags-list (org-get-tags el)
  9899. org-scanner-tags tags-list)
  9900. (when (eq action 'agenda)
  9901. (setq ts-date-pair (org-agenda-entry-get-agenda-timestamp (point))
  9902. ts-date (car ts-date-pair)
  9903. ts-date-type (cdr ts-date-pair)))
  9904. (catch :skip
  9905. (when (and
  9906. ;; eval matcher only when the todo condition is OK
  9907. (and (or (not todo-only) (member todo org-todo-keywords-1))
  9908. (if (functionp matcher)
  9909. (let ((case-fold-search t) (org-trust-scanner-tags t))
  9910. (funcall matcher todo tags-list level))
  9911. matcher))
  9912. ;; Call the skipper, but return t if it does not
  9913. ;; skip, so that the `and' form continues evaluating.
  9914. (progn
  9915. (unless (eq action 'sparse-tree) (org-agenda-skip el))
  9916. t)
  9917. ;; Check if timestamps are deselecting this entry
  9918. (or (not todo-only)
  9919. (and (member todo org-todo-keywords-1)
  9920. (or (not org-agenda-tags-todo-honor-ignore-options)
  9921. (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item))))))
  9922. ;; select this headline
  9923. (cond
  9924. ((eq action 'sparse-tree)
  9925. (and org-highlight-sparse-tree-matches
  9926. (org-get-heading) (match-end 0)
  9927. (org-highlight-new-match
  9928. (match-beginning 1) (match-end 1)))
  9929. (org-fold-show-context 'tags-tree))
  9930. ((eq action 'agenda)
  9931. (let* ((effort (org-entry-get (point) org-effort-property))
  9932. (effort-minutes (when effort (save-match-data (org-duration-to-minutes effort)))))
  9933. (setq txt (org-agenda-format-item
  9934. ""
  9935. ;; Add `effort' and `effort-minutes'
  9936. ;; properties for prefix format.
  9937. (org-add-props
  9938. (concat
  9939. (if (eq org-tags-match-list-sublevels 'indented)
  9940. (make-string (1- level) ?.) "")
  9941. (org-get-heading))
  9942. nil
  9943. 'effort effort
  9944. 'effort-minutes effort-minutes)
  9945. (make-string level ?\s)
  9946. category
  9947. tags-list)
  9948. priority (org-get-priority txt))
  9949. ;; Now add `effort' and `effort-minutes' to
  9950. ;; full agenda line.
  9951. (setq txt (org-add-props txt nil
  9952. 'effort effort
  9953. 'effort-minutes effort-minutes)))
  9954. (goto-char (org-element-property :begin el))
  9955. (setq marker (org-agenda-new-marker))
  9956. (org-add-props txt props
  9957. 'org-marker marker 'org-hd-marker marker 'org-category category
  9958. 'todo-state todo
  9959. 'ts-date ts-date
  9960. 'priority priority
  9961. 'type (concat "tagsmatch" ts-date-type))
  9962. (push txt rtn))
  9963. ((functionp action)
  9964. (setq org-map-continue-from nil)
  9965. (save-excursion
  9966. (setq rtn1 (funcall action))
  9967. (push rtn1 rtn)))
  9968. (t (user-error "Invalid action")))
  9969. ;; if we are to skip sublevels, jump to end of subtree
  9970. (unless org-tags-match-list-sublevels
  9971. (goto-char (1- (org-element-property :end el))))))
  9972. ;; Get the correct position from where to continue
  9973. (when org-map-continue-from
  9974. (setq org-element-cache-map-continue-from org-map-continue-from)
  9975. (goto-char org-map-continue-from))
  9976. ;; Return nil.
  9977. nil)
  9978. :next-re fast-re
  9979. :fail-re fast-re
  9980. :narrow t))
  9981. (while (let (case-fold-search)
  9982. (re-search-forward re nil t))
  9983. (setq org-map-continue-from nil)
  9984. (catch :skip
  9985. ;; Ignore closing parts of inline tasks.
  9986. (when (and (fboundp 'org-inlinetask-end-p) (org-inlinetask-end-p))
  9987. (throw :skip t))
  9988. (setq todo (and (match-end 1) (match-string-no-properties 1)))
  9989. (setq tags (and (match-end 4) (org-trim (match-string-no-properties 4))))
  9990. (goto-char (setq lspos (match-beginning 0)))
  9991. (setq level (org-reduced-level (org-outline-level))
  9992. category (org-get-category))
  9993. (when (eq action 'agenda)
  9994. (setq ts-date-pair (org-agenda-entry-get-agenda-timestamp (point))
  9995. ts-date (car ts-date-pair)
  9996. ts-date-type (cdr ts-date-pair)))
  9997. (setq i llast llast level)
  9998. ;; remove tag lists from same and sublevels
  9999. (while (>= i level)
  10000. (when (setq entry (assoc i tags-alist))
  10001. (setq tags-alist (delete entry tags-alist)))
  10002. (setq i (1- i)))
  10003. ;; add the next tags
  10004. (when tags
  10005. (setq tags (org-split-string tags ":")
  10006. tags-alist
  10007. (cons (cons level tags) tags-alist)))
  10008. ;; compile tags for current headline
  10009. (setq tags-list
  10010. (if org-use-tag-inheritance
  10011. (apply 'append (mapcar 'cdr (reverse tags-alist)))
  10012. tags)
  10013. org-scanner-tags tags-list)
  10014. (when org-use-tag-inheritance
  10015. (setcdr (car tags-alist)
  10016. (mapcar (lambda (x)
  10017. (setq x (copy-sequence x))
  10018. (org-add-prop-inherited x))
  10019. (cdar tags-alist))))
  10020. (when (and tags org-use-tag-inheritance
  10021. (or (not (eq t org-use-tag-inheritance))
  10022. org-tags-exclude-from-inheritance))
  10023. ;; Selective inheritance, remove uninherited ones.
  10024. (setcdr (car tags-alist)
  10025. (org-remove-uninherited-tags (cdar tags-alist))))
  10026. (when (and
  10027. ;; eval matcher only when the todo condition is OK
  10028. (and (or (not todo-only) (member todo org-todo-keywords-1))
  10029. (if (functionp matcher)
  10030. (let ((case-fold-search t) (org-trust-scanner-tags t))
  10031. (funcall matcher todo tags-list level))
  10032. matcher))
  10033. ;; Call the skipper, but return t if it does not
  10034. ;; skip, so that the `and' form continues evaluating.
  10035. (progn
  10036. (unless (eq action 'sparse-tree) (org-agenda-skip))
  10037. t)
  10038. ;; Check if timestamps are deselecting this entry
  10039. (or (not todo-only)
  10040. (and (member todo org-todo-keywords-1)
  10041. (or (not org-agenda-tags-todo-honor-ignore-options)
  10042. (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item))))))
  10043. ;; select this headline
  10044. (cond
  10045. ((eq action 'sparse-tree)
  10046. (and org-highlight-sparse-tree-matches
  10047. (org-get-heading) (match-end 0)
  10048. (org-highlight-new-match
  10049. (match-beginning 1) (match-end 1)))
  10050. (org-fold-show-context 'tags-tree))
  10051. ((eq action 'agenda)
  10052. (setq txt (org-agenda-format-item
  10053. ""
  10054. (concat
  10055. (if (eq org-tags-match-list-sublevels 'indented)
  10056. (make-string (1- level) ?.) "")
  10057. (org-get-heading))
  10058. (make-string level ?\s)
  10059. category
  10060. tags-list)
  10061. priority (org-get-priority txt))
  10062. (goto-char lspos)
  10063. (setq marker (org-agenda-new-marker))
  10064. (org-add-props txt props
  10065. 'org-marker marker 'org-hd-marker marker 'org-category category
  10066. 'todo-state todo
  10067. 'ts-date ts-date
  10068. 'priority priority
  10069. 'type (concat "tagsmatch" ts-date-type))
  10070. (push txt rtn))
  10071. ((functionp action)
  10072. (setq org-map-continue-from nil)
  10073. (save-excursion
  10074. (setq rtn1 (funcall action))
  10075. (push rtn1 rtn)))
  10076. (t (user-error "Invalid action")))
  10077. ;; if we are to skip sublevels, jump to end of subtree
  10078. (unless org-tags-match-list-sublevels
  10079. (org-end-of-subtree t)
  10080. (backward-char 1))))
  10081. ;; Get the correct position from where to continue
  10082. (if org-map-continue-from
  10083. (goto-char org-map-continue-from)
  10084. (and (= (point) lspos) (end-of-line 1))))))
  10085. (when (and (eq action 'sparse-tree)
  10086. (not org-sparse-tree-open-archived-trees))
  10087. (org-fold-hide-archived-subtrees (point-min) (point-max)))
  10088. (nreverse rtn)))
  10089. (defun org-remove-uninherited-tags (tags)
  10090. "Remove all tags that are not inherited from the list TAGS."
  10091. (cond
  10092. ((eq org-use-tag-inheritance t)
  10093. (if org-tags-exclude-from-inheritance
  10094. (org-delete-all org-tags-exclude-from-inheritance tags)
  10095. tags))
  10096. ((not org-use-tag-inheritance) nil)
  10097. ((stringp org-use-tag-inheritance)
  10098. (delq nil (mapcar
  10099. (lambda (x)
  10100. (if (and (string-match org-use-tag-inheritance x)
  10101. (not (member x org-tags-exclude-from-inheritance)))
  10102. x nil))
  10103. tags)))
  10104. ((listp org-use-tag-inheritance)
  10105. (delq nil (mapcar
  10106. (lambda (x)
  10107. (if (member x org-use-tag-inheritance) x nil))
  10108. tags)))))
  10109. (defun org-match-sparse-tree (&optional todo-only match)
  10110. "Create a sparse tree according to tags string MATCH.
  10111. MATCH is a string with match syntax. It can contain a selection
  10112. of tags (\"+work+urgent-boss\"), properties (\"LEVEL>3\"), and
  10113. TODO keywords (\"TODO=\\\"WAITING\\\"\") or a combination of
  10114. those. See the manual for details.
  10115. If optional argument TODO-ONLY is non-nil, only select lines that
  10116. are also TODO tasks."
  10117. (interactive "P")
  10118. (org-agenda-prepare-buffers (list (current-buffer)))
  10119. (let ((org--matcher-tags-todo-only todo-only))
  10120. (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match t))
  10121. org--matcher-tags-todo-only)))
  10122. (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
  10123. (defvar org-cached-props nil)
  10124. (defun org-cached-entry-get (pom property)
  10125. (if (or (eq t org-use-property-inheritance)
  10126. (and (stringp org-use-property-inheritance)
  10127. (let ((case-fold-search t))
  10128. (string-match-p org-use-property-inheritance property)))
  10129. (and (listp org-use-property-inheritance)
  10130. (member-ignore-case property org-use-property-inheritance)))
  10131. ;; Caching is not possible, check it directly.
  10132. (org-entry-get pom property 'inherit)
  10133. ;; Get all properties, so we can do complicated checks easily.
  10134. (cdr (assoc-string property
  10135. (or org-cached-props
  10136. (setq org-cached-props (org-entry-properties pom)))
  10137. t))))
  10138. (defun org-global-tags-completion-table (&optional files)
  10139. "Return the list of all tags in all agenda buffer/files.
  10140. Optional FILES argument is a list of files which can be used
  10141. instead of the agenda files."
  10142. (save-excursion
  10143. (org-uniquify
  10144. (delq nil
  10145. (apply #'append
  10146. (mapcar
  10147. (lambda (file)
  10148. (set-buffer (find-file-noselect file))
  10149. (org--tag-add-to-alist
  10150. (org-get-buffer-tags)
  10151. (mapcar (lambda (x)
  10152. (and (stringp (car-safe x))
  10153. (list (car-safe x))))
  10154. org-current-tag-alist)))
  10155. (if (car-safe files) files
  10156. (org-agenda-files))))))))
  10157. (defun org-make-tags-matcher (match &optional only-local-tags)
  10158. "Create the TAGS/TODO matcher form for the selection string MATCH.
  10159. Returns a cons of the selection string MATCH and a function
  10160. implementing the matcher.
  10161. The matcher is to be called at an Org entry, with point on the
  10162. headline, and returns non-nil if the entry matches the selection
  10163. string MATCH. It must be called with three arguments: the TODO
  10164. keyword at the entry (or nil if none), the list of all tags at
  10165. the entry including inherited ones and the reduced level of the
  10166. headline. Additionally, the category of the entry, if any, must
  10167. be specified as the text property `org-category' on the headline.
  10168. This function sets the variable `org--matcher-tags-todo-only' to
  10169. a non-nil value if the matcher restricts matching to TODO
  10170. entries, otherwise it is not touched.
  10171. When ONLY-LOCAL-TAGS is non-nil, ignore the global tag completion
  10172. table, only get buffer tags.
  10173. See also `org-scan-tags'."
  10174. (unless match
  10175. ;; Get a new match request, with completion against the global
  10176. ;; tags table and the local tags in current buffer.
  10177. (let ((org-last-tags-completion-table
  10178. (org--tag-add-to-alist
  10179. (org-get-buffer-tags)
  10180. (unless only-local-tags
  10181. (org-global-tags-completion-table)))))
  10182. (setq match
  10183. (completing-read
  10184. "Match: "
  10185. 'org-tags-completion-function nil nil nil 'org-tags-history))))
  10186. (let ((match0 match)
  10187. (re (concat
  10188. "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)"
  10189. "\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)"
  10190. "\\([<>=]\\{1,2\\}\\)"
  10191. "\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)"
  10192. "\\|" org-tag-re "\\)"))
  10193. (start 0)
  10194. tagsmatch todomatch tagsmatcher todomatcher)
  10195. ;; Expand group tags.
  10196. (setq match (org-tags-expand match))
  10197. ;; Check if there is a TODO part of this match, which would be the
  10198. ;; part after a "/". To make sure that this slash is not part of
  10199. ;; a property value to be matched against, we also check that
  10200. ;; there is no / after that slash. First, find the last slash.
  10201. (let ((s 0))
  10202. (while (string-match "/+" match s)
  10203. (setq start (match-beginning 0))
  10204. (setq s (match-end 0))))
  10205. (if (and (string-match "/+" match start)
  10206. (not (string-match-p "\"" match start)))
  10207. ;; Match contains also a TODO-matching request.
  10208. (progn
  10209. (setq tagsmatch (substring match 0 (match-beginning 0)))
  10210. (setq todomatch (substring match (match-end 0)))
  10211. (when (string-prefix-p "!" todomatch)
  10212. (setq org--matcher-tags-todo-only t)
  10213. (setq todomatch (substring todomatch 1)))
  10214. (when (string-match "\\`\\s-*\\'" todomatch)
  10215. (setq todomatch nil)))
  10216. ;; Only matching tags.
  10217. (setq tagsmatch match)
  10218. (setq todomatch nil))
  10219. ;; Make the tags matcher.
  10220. (when (org-string-nw-p tagsmatch)
  10221. (let ((orlist nil)
  10222. (orterms (org-split-string tagsmatch "|"))
  10223. term)
  10224. (while (setq term (pop orterms))
  10225. (while (and (equal (substring term -1) "\\") orterms)
  10226. (setq term (concat term "|" (pop orterms)))) ;repair bad split.
  10227. (while (string-match re term)
  10228. (let* ((rest (substring term (match-end 0)))
  10229. (minus (and (match-end 1)
  10230. (equal (match-string 1 term) "-")))
  10231. (tag (save-match-data
  10232. (replace-regexp-in-string
  10233. "\\\\-" "-" (match-string 2 term))))
  10234. (regexp (eq (string-to-char tag) ?{))
  10235. (levelp (match-end 4))
  10236. (propp (match-end 5))
  10237. (mm
  10238. (cond
  10239. (regexp `(org-match-any-p ,(substring tag 1 -1) tags-list))
  10240. (levelp
  10241. `(,(org-op-to-function (match-string 3 term))
  10242. level
  10243. ,(string-to-number (match-string 4 term))))
  10244. (propp
  10245. (let* ((gv (pcase (upcase (match-string 5 term))
  10246. ("CATEGORY"
  10247. '(org-get-category (point)))
  10248. ("TODO" 'todo)
  10249. (p `(org-cached-entry-get nil ,p))))
  10250. (pv (match-string 7 term))
  10251. (regexp (eq (string-to-char pv) ?{))
  10252. (strp (eq (string-to-char pv) ?\"))
  10253. (timep (string-match-p "^\"[[<].*[]>]\"$" pv))
  10254. (po (org-op-to-function (match-string 6 term)
  10255. (if timep 'time strp))))
  10256. (setq pv (if (or regexp strp) (substring pv 1 -1) pv))
  10257. (when timep (setq pv (org-matcher-time pv)))
  10258. (cond ((and regexp (eq po '/=))
  10259. `(not (string-match ,pv (or ,gv ""))))
  10260. (regexp `(string-match ,pv (or ,gv "")))
  10261. (strp `(,po (or ,gv "") ,pv))
  10262. (t
  10263. `(,po
  10264. (string-to-number (or ,gv ""))
  10265. ,(string-to-number pv))))))
  10266. (t `(member ,tag tags-list)))))
  10267. (push (if minus `(not ,mm) mm) tagsmatcher)
  10268. (setq term rest)))
  10269. (push `(and ,@tagsmatcher) orlist)
  10270. (setq tagsmatcher nil))
  10271. (setq tagsmatcher `(progn (setq org-cached-props nil) (or ,@orlist)))))
  10272. ;; Make the TODO matcher.
  10273. (when (org-string-nw-p todomatch)
  10274. (let ((orlist nil))
  10275. (dolist (term (org-split-string todomatch "|"))
  10276. (while (string-match re term)
  10277. (let* ((minus (and (match-end 1)
  10278. (equal (match-string 1 term) "-")))
  10279. (kwd (match-string 2 term))
  10280. (regexp (eq (string-to-char kwd) ?{))
  10281. (mm (if regexp `(string-match ,(substring kwd 1 -1) todo)
  10282. `(equal todo ,kwd))))
  10283. (push (if minus `(not ,mm) mm) todomatcher))
  10284. (setq term (substring term (match-end 0))))
  10285. (push (if (> (length todomatcher) 1)
  10286. (cons 'and todomatcher)
  10287. (car todomatcher))
  10288. orlist)
  10289. (setq todomatcher nil))
  10290. (setq todomatcher (cons 'or orlist))))
  10291. ;; Return the string and function of the matcher. If no
  10292. ;; tags-specific or todo-specific matcher exists, match
  10293. ;; everything.
  10294. (let ((matcher (if (and tagsmatcher todomatcher)
  10295. `(and ,tagsmatcher ,todomatcher)
  10296. (or tagsmatcher todomatcher t))))
  10297. (when org--matcher-tags-todo-only
  10298. (setq matcher `(and (member todo org-not-done-keywords) ,matcher)))
  10299. (cons match0 `(lambda (todo tags-list level) ,matcher)))))
  10300. (defun org--tags-expand-group (group tag-groups expanded)
  10301. "Recursively expand all tags in GROUP, according to TAG-GROUPS.
  10302. TAG-GROUPS is the list of groups used for expansion. EXPANDED is
  10303. an accumulator used in recursive calls."
  10304. (dolist (tag group)
  10305. (unless (member tag expanded)
  10306. (let ((group (assoc tag tag-groups)))
  10307. (push tag expanded)
  10308. (when group
  10309. (setq expanded
  10310. (org--tags-expand-group (cdr group) tag-groups expanded))))))
  10311. expanded)
  10312. (defun org-tags-expand (match &optional single-as-list)
  10313. "Expand group tags in MATCH.
  10314. This replaces every group tag in MATCH with a regexp tag search.
  10315. For example, a group tag \"Work\" defined as { Work : Lab Conf }
  10316. will be replaced like this:
  10317. Work => {\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
  10318. +Work => +{\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
  10319. -Work => -{\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
  10320. Replacing by a regexp preserves the structure of the match.
  10321. E.g., this expansion
  10322. Work|Home => {\\(?:Work\\|Lab\\|Conf\\}|Home
  10323. will match anything tagged with \"Lab\" and \"Home\", or tagged
  10324. with \"Conf\" and \"Home\" or tagged with \"Work\" and \"Home\".
  10325. A group tag in MATCH can contain regular expressions of its own.
  10326. For example, a group tag \"Proj\" defined as { Proj : {P@.+} }
  10327. will be replaced like this:
  10328. Proj => {\\<\\(?:Proj\\)\\>\\|P@.+}
  10329. When the optional argument SINGLE-AS-LIST is non-nil, MATCH is
  10330. assumed to be a single group tag, and the function will return
  10331. the list of tags in this group."
  10332. (unless (org-string-nw-p match) (error "Invalid match tag: %S" match))
  10333. (let ((tag-groups
  10334. (or org-tag-groups-alist-for-agenda org-tag-groups-alist)))
  10335. (cond
  10336. (single-as-list (org--tags-expand-group (list match) tag-groups nil))
  10337. (org-group-tags
  10338. (let* ((case-fold-search t)
  10339. (tag-syntax org-mode-syntax-table)
  10340. (group-keys (mapcar #'car tag-groups))
  10341. (key-regexp (concat "\\([+-]?\\)" (regexp-opt group-keys 'words)))
  10342. (return-match match))
  10343. ;; Mark regexp-expressions in the match-expression so that we
  10344. ;; do not replace them later on.
  10345. (let ((s 0))
  10346. (while (string-match "{.+?}" return-match s)
  10347. (setq s (match-end 0))
  10348. (add-text-properties
  10349. (match-beginning 0) (match-end 0) '(regexp t) return-match)))
  10350. ;; @ and _ are allowed as word-components in tags.
  10351. (modify-syntax-entry ?@ "w" tag-syntax)
  10352. (modify-syntax-entry ?_ "w" tag-syntax)
  10353. ;; For each tag token found in MATCH, compute a regexp and it
  10354. (with-syntax-table tag-syntax
  10355. (replace-regexp-in-string
  10356. key-regexp
  10357. (lambda (m)
  10358. (if (get-text-property (match-beginning 2) 'regexp m)
  10359. m ;regexp tag: ignore
  10360. (let* ((operator (match-string 1 m))
  10361. (tag-token (let ((tag (match-string 2 m)))
  10362. (list tag)))
  10363. regexp-tags regular-tags)
  10364. ;; Partition tags between regexp and regular tags.
  10365. ;; Remove curly bracket syntax from regexp tags.
  10366. (dolist (tag (org--tags-expand-group tag-token tag-groups nil))
  10367. (save-match-data
  10368. (if (string-match "{\\(.+?\\)}" tag)
  10369. (push (match-string 1 tag) regexp-tags)
  10370. (push tag regular-tags))))
  10371. ;; Replace tag token by the appropriate regexp.
  10372. ;; Regular tags need to be regexp-quoted, whereas
  10373. ;; regexp-tags are inserted as-is.
  10374. (let ((regular (regexp-opt regular-tags))
  10375. (regexp (mapconcat #'identity regexp-tags "\\|")))
  10376. (concat operator
  10377. (cond
  10378. ((null regular-tags) (format "{%s}" regexp))
  10379. ((null regexp-tags) (format "{\\<%s\\>}" regular))
  10380. (t (format "{\\<%s\\>\\|%s}" regular regexp))))))))
  10381. return-match
  10382. t t))))
  10383. (t match))))
  10384. (defun org-op-to-function (op &optional stringp)
  10385. "Turn an operator into the appropriate function."
  10386. (setq op
  10387. (cond
  10388. ((equal op "<" ) '(< org-string< org-time<))
  10389. ((equal op ">" ) '(> org-string> org-time>))
  10390. ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
  10391. ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
  10392. ((member op '("=" "==")) '(= string= org-time=))
  10393. ((member op '("<>" "!=")) '(/= org-string<> org-time<>))))
  10394. (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
  10395. (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
  10396. (defvar org-tags-overlay (make-overlay 1 1))
  10397. (delete-overlay org-tags-overlay)
  10398. (defun org-add-prop-inherited (s)
  10399. (add-text-properties 0 (length s) '(inherited t) s)
  10400. s)
  10401. (defun org-toggle-tag (tag &optional onoff)
  10402. "Toggle the tag TAG for the current line.
  10403. If ONOFF is `on' or `off', don't toggle but set to this state."
  10404. (save-excursion
  10405. (org-back-to-heading t)
  10406. (let ((current
  10407. ;; Reverse the tags list so any new tag is appended to the
  10408. ;; current list of tags.
  10409. (nreverse (org-get-tags nil t)))
  10410. res)
  10411. (pcase onoff
  10412. (`off (setq current (delete tag current)))
  10413. ((or `on (guard (not (member tag current))))
  10414. (setq res t)
  10415. (cl-pushnew tag current :test #'equal))
  10416. (_ (setq current (delete tag current))))
  10417. (org-set-tags (nreverse current))
  10418. res)))
  10419. (defun org--align-tags-here (to-col)
  10420. "Align tags on the current headline to TO-COL.
  10421. Assume point is on a headline. Preserve point when aligning
  10422. tags."
  10423. (when (org-match-line org-tag-line-re)
  10424. (let* ((tags-start (match-beginning 1))
  10425. (blank-start (save-excursion
  10426. (goto-char tags-start)
  10427. (skip-chars-backward " \t")
  10428. (point)))
  10429. (new (max (if (>= to-col 0) to-col
  10430. (- (abs to-col) (string-width (match-string 1))))
  10431. ;; Introduce at least one space after the heading
  10432. ;; or the stars.
  10433. (save-excursion
  10434. (goto-char blank-start)
  10435. (1+ (current-column)))))
  10436. (current
  10437. (save-excursion (goto-char tags-start) (current-column)))
  10438. (origin (point-marker))
  10439. (column (current-column))
  10440. (in-blank? (and (> origin blank-start) (<= origin tags-start))))
  10441. (when (/= new current)
  10442. (delete-region blank-start tags-start)
  10443. (goto-char blank-start)
  10444. (let ((indent-tabs-mode nil)) (indent-to new))
  10445. ;; Try to move back to original position. If point was in the
  10446. ;; blanks before the tags, ORIGIN marker is of no use because
  10447. ;; it now points to BLANK-START. Use COLUMN instead.
  10448. (if in-blank? (org-move-to-column column) (goto-char origin))))))
  10449. (defun org-set-tags-command (&optional arg)
  10450. "Set the tags for the current visible entry.
  10451. When called with `\\[universal-argument]' prefix argument ARG, \
  10452. realign all tags
  10453. in the current buffer.
  10454. When called with `\\[universal-argument] \\[universal-argument]' prefix argument, \
  10455. unconditionally do not
  10456. offer the fast tag selection interface.
  10457. If a region is active, set tags in the region according to the
  10458. setting of `org-loop-over-headlines-in-active-region'.
  10459. This function is for interactive use only;
  10460. in Lisp code use `org-set-tags' instead."
  10461. (interactive "P")
  10462. (let ((org-use-fast-tag-selection
  10463. (unless (equal '(16) arg) org-use-fast-tag-selection)))
  10464. (cond
  10465. ((equal '(4) arg) (org-align-tags t))
  10466. ((and (org-region-active-p) org-loop-over-headlines-in-active-region)
  10467. (let (org-loop-over-headlines-in-active-region) ; hint: infinite recursion.
  10468. (org-map-entries
  10469. #'org-set-tags-command
  10470. nil
  10471. (if (eq org-loop-over-headlines-in-active-region 'start-level)
  10472. 'region-start-level
  10473. 'region)
  10474. (lambda () (when (org-invisible-p) (org-end-of-subtree nil t))))))
  10475. (t
  10476. (save-excursion
  10477. (org-back-to-heading)
  10478. (let* ((all-tags (org-get-tags))
  10479. (local-table (or org-current-tag-alist (org-get-buffer-tags)))
  10480. (table (setq org-last-tags-completion-table
  10481. (append
  10482. ;; Put local tags in front.
  10483. local-table
  10484. (cl-set-difference
  10485. (org--tag-add-to-alist
  10486. (and org-complete-tags-always-offer-all-agenda-tags
  10487. (org-global-tags-completion-table
  10488. (org-agenda-files)))
  10489. local-table)
  10490. local-table))))
  10491. (current-tags
  10492. (cl-remove-if (lambda (tag) (get-text-property 0 'inherited tag))
  10493. all-tags))
  10494. (inherited-tags
  10495. (cl-remove-if-not (lambda (tag) (get-text-property 0 'inherited tag))
  10496. all-tags))
  10497. (tags
  10498. (replace-regexp-in-string
  10499. ;; Ignore all forbidden characters in tags.
  10500. "[^[:alnum:]_@#%]+" ":"
  10501. (if (or (eq t org-use-fast-tag-selection)
  10502. (and org-use-fast-tag-selection
  10503. (delq nil (mapcar #'cdr table))))
  10504. (org-fast-tag-selection
  10505. current-tags
  10506. inherited-tags
  10507. table
  10508. (and org-fast-tag-selection-include-todo org-todo-key-alist))
  10509. (let ((org-add-colon-after-tag-completion (< 1 (length table)))
  10510. (crm-separator "[ \t]*:[ \t]*"))
  10511. (mapconcat #'identity
  10512. (completing-read-multiple
  10513. "Tags: "
  10514. org-last-tags-completion-table
  10515. nil nil (org-make-tag-string current-tags)
  10516. 'org-tags-history)
  10517. ":"))))))
  10518. (org-set-tags tags)))))
  10519. ;; `save-excursion' may not replace the point at the right
  10520. ;; position.
  10521. (when (and (save-excursion (skip-chars-backward "*") (bolp))
  10522. (looking-at-p " "))
  10523. (forward-char))))
  10524. (defun org-align-tags (&optional all)
  10525. "Align tags in current entry.
  10526. When optional argument ALL is non-nil, align all tags in the
  10527. visible part of the buffer."
  10528. (let ((get-indent-column
  10529. (lambda ()
  10530. (let ((offset (if (bound-and-true-p org-indent-mode)
  10531. (save-excursion
  10532. (org-back-to-heading-or-point-min)
  10533. (length
  10534. (get-text-property
  10535. (line-end-position)
  10536. 'line-prefix)))
  10537. 0)))
  10538. (+ org-tags-column
  10539. (if (> org-tags-column 0) (- offset) offset))))))
  10540. (if (and (not all) (org-at-heading-p))
  10541. (org--align-tags-here (funcall get-indent-column))
  10542. (save-excursion
  10543. (if all
  10544. (progn
  10545. (goto-char (point-min))
  10546. (while (re-search-forward org-tag-line-re nil t)
  10547. (org--align-tags-here (funcall get-indent-column))))
  10548. (org-back-to-heading t)
  10549. (org--align-tags-here (funcall get-indent-column)))))))
  10550. (defun org-set-tags (tags)
  10551. "Set the tags of the current entry to TAGS, replacing current tags.
  10552. TAGS may be a tags string like \":aa:bb:cc:\", or a list of tags.
  10553. If TAGS is nil or the empty string, all tags are removed.
  10554. This function assumes point is on a headline."
  10555. (org-with-wide-buffer
  10556. (org-fold-core-ignore-modifications
  10557. (let ((tags (pcase tags
  10558. ((pred listp) tags)
  10559. ((pred stringp) (split-string (org-trim tags) ":" t))
  10560. (_ (error "Invalid tag specification: %S" tags))))
  10561. (old-tags (org-get-tags nil t))
  10562. (tags-change? nil))
  10563. (when (functionp org-tags-sort-function)
  10564. (setq tags (sort tags org-tags-sort-function)))
  10565. (setq tags-change? (not (equal tags old-tags)))
  10566. (when tags-change?
  10567. ;; Delete previous tags and any trailing white space.
  10568. (goto-char (if (org-match-line org-tag-line-re) (match-beginning 1)
  10569. (line-end-position)))
  10570. (skip-chars-backward " \t")
  10571. (delete-region (point) (line-end-position))
  10572. ;; Deleting white spaces may break an otherwise empty headline.
  10573. ;; Re-introduce one space in this case.
  10574. (unless (org-at-heading-p) (insert " "))
  10575. (when tags
  10576. (save-excursion (insert-and-inherit " " (org-make-tag-string tags)))
  10577. ;; When text is being inserted on an invisible region
  10578. ;; boundary, it can be inadvertently sucked into
  10579. ;; invisibility.
  10580. (unless (org-invisible-p (line-beginning-position))
  10581. (org-fold-region (point) (line-end-position) nil 'outline))))
  10582. ;; Align tags, if any.
  10583. (when tags (org-align-tags))
  10584. (when tags-change? (run-hooks 'org-after-tags-change-hook))))))
  10585. (defun org-change-tag-in-region (beg end tag off)
  10586. "Add or remove TAG for each entry in the region.
  10587. This works in the agenda, and also in an Org buffer."
  10588. (interactive
  10589. (list (region-beginning) (region-end)
  10590. (let ((org-last-tags-completion-table
  10591. (if (derived-mode-p 'org-mode)
  10592. (org--tag-add-to-alist
  10593. (org-get-buffer-tags)
  10594. (org-global-tags-completion-table))
  10595. (org-global-tags-completion-table))))
  10596. (completing-read
  10597. "Tag: " org-last-tags-completion-table nil nil nil
  10598. 'org-tags-history))
  10599. (progn
  10600. (message "[s]et or [r]emove? ")
  10601. (equal (read-char-exclusive) ?r))))
  10602. (deactivate-mark)
  10603. (let ((agendap (equal major-mode 'org-agenda-mode))
  10604. l1 l2 m buf pos newhead (cnt 0))
  10605. (goto-char end)
  10606. (setq l2 (1- (org-current-line)))
  10607. (goto-char beg)
  10608. (setq l1 (org-current-line))
  10609. (cl-loop for l from l1 to l2 do
  10610. (org-goto-line l)
  10611. (setq m (get-text-property (point) 'org-hd-marker))
  10612. (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
  10613. (and agendap m))
  10614. (setq buf (if agendap (marker-buffer m) (current-buffer))
  10615. pos (if agendap m (point)))
  10616. (with-current-buffer buf
  10617. (save-excursion
  10618. (save-restriction
  10619. (goto-char pos)
  10620. (setq cnt (1+ cnt))
  10621. (org-toggle-tag tag (if off 'off 'on))
  10622. (setq newhead (org-get-heading)))))
  10623. (and agendap (org-agenda-change-all-lines newhead m))))
  10624. (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
  10625. (defun org-tags-completion-function (string _predicate &optional flag)
  10626. "Complete tag STRING.
  10627. FLAG specifies the type of completion operation to perform. This
  10628. function is passed as a collection function to `completing-read',
  10629. which see."
  10630. (let ((completion-ignore-case nil) ;tags are case-sensitive
  10631. (confirm (lambda (x) (stringp (car x))))
  10632. (prefix ""))
  10633. (when (string-match "^\\(.*[-+:&,|]\\)\\([^-+:&,|]*\\)$" string)
  10634. (setq prefix (match-string 1 string))
  10635. (setq string (match-string 2 string)))
  10636. (pcase flag
  10637. (`t (all-completions string org-last-tags-completion-table confirm))
  10638. (`lambda (assoc string org-last-tags-completion-table)) ;exact match?
  10639. (`nil
  10640. (pcase (try-completion string org-last-tags-completion-table confirm)
  10641. ((and completion (pred stringp))
  10642. (concat prefix
  10643. completion
  10644. (if (and org-add-colon-after-tag-completion
  10645. (assoc completion org-last-tags-completion-table))
  10646. ":"
  10647. "")))
  10648. (completion completion)))
  10649. (_ nil))))
  10650. (defun org-fast-tag-insert (kwd tags face &optional end)
  10651. "Insert KWD, and the TAGS, the latter with face FACE.
  10652. Also insert END."
  10653. (insert (format "%-12s" (concat kwd ":"))
  10654. (org-add-props (mapconcat 'identity tags " ") nil 'face face)
  10655. (or end "")))
  10656. (defun org-fast-tag-show-exit (flag)
  10657. (save-excursion
  10658. (org-goto-line 3)
  10659. (when (re-search-forward "[ \t]+Next change exits" (line-end-position) t)
  10660. (replace-match ""))
  10661. (when flag
  10662. (end-of-line 1)
  10663. (org-move-to-column (- (window-width) 19) t)
  10664. (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
  10665. (defun org-set-current-tags-overlay (current prefix)
  10666. "Add an overlay to CURRENT tag with PREFIX."
  10667. (let ((s (org-make-tag-string current)))
  10668. (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
  10669. (org-overlay-display org-tags-overlay (concat prefix s))))
  10670. (defvar org-last-tag-selection-key nil)
  10671. (defun org-fast-tag-selection (current inherited table &optional todo-table)
  10672. "Fast tag selection with single keys.
  10673. CURRENT is the current list of tags in the headline, INHERITED is the
  10674. list of inherited tags, and TABLE is an alist of tags and corresponding keys,
  10675. possibly with grouping information. TODO-TABLE is a similar table with
  10676. TODO keywords, should these have keys assigned to them.
  10677. If the keys are nil, a-z are automatically assigned.
  10678. Returns the new tags string, or nil to not change the current settings."
  10679. (let* ((fulltable (append table todo-table))
  10680. (maxlen (if (null fulltable) 0
  10681. (apply #'max
  10682. (mapcar (lambda (x)
  10683. (if (stringp (car x)) (string-width (car x))
  10684. 0))
  10685. fulltable))))
  10686. (buf (current-buffer))
  10687. (expert (eq org-fast-tag-selection-single-key 'expert))
  10688. (tab-tags nil)
  10689. (fwidth (+ maxlen 3 1 3))
  10690. (ncol (/ (- (window-width) 4) fwidth))
  10691. (i-face 'org-done)
  10692. (c-face 'org-todo)
  10693. tg cnt e c char c1 c2 ntable tbl rtn
  10694. ov-start ov-end ov-prefix
  10695. (exit-after-next org-fast-tag-selection-single-key)
  10696. (done-keywords org-done-keywords)
  10697. groups ingroup intaggroup)
  10698. (save-excursion
  10699. (beginning-of-line)
  10700. (if (looking-at org-tag-line-re)
  10701. (setq ov-start (match-beginning 1)
  10702. ov-end (match-end 1)
  10703. ov-prefix "")
  10704. (setq ov-start (1- (line-end-position))
  10705. ov-end (1+ ov-start))
  10706. (skip-chars-forward "^\n\r")
  10707. (setq ov-prefix
  10708. (concat
  10709. (buffer-substring (1- (point)) (point))
  10710. (if (> (current-column) org-tags-column)
  10711. " "
  10712. (make-string (- org-tags-column (current-column)) ?\ ))))))
  10713. (move-overlay org-tags-overlay ov-start ov-end)
  10714. (save-excursion
  10715. (save-window-excursion
  10716. (if expert
  10717. (set-buffer (get-buffer-create " *Org tags*"))
  10718. (delete-other-windows)
  10719. (set-window-buffer (split-window-vertically) (get-buffer-create " *Org tags*"))
  10720. (org-switch-to-buffer-other-window " *Org tags*"))
  10721. (erase-buffer)
  10722. (setq-local org-done-keywords done-keywords)
  10723. (org-fast-tag-insert "Inherited" inherited i-face "\n")
  10724. (org-fast-tag-insert "Current" current c-face "\n\n")
  10725. (org-fast-tag-show-exit exit-after-next)
  10726. (org-set-current-tags-overlay current ov-prefix)
  10727. (setq tbl fulltable char ?a cnt 0)
  10728. (while (setq e (pop tbl))
  10729. (cond
  10730. ((eq (car e) :startgroup)
  10731. (push '() groups) (setq ingroup t)
  10732. (unless (zerop cnt)
  10733. (setq cnt 0)
  10734. (insert "\n"))
  10735. (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
  10736. ((eq (car e) :endgroup)
  10737. (setq ingroup nil cnt 0)
  10738. (insert "}" (if (cdr e) (format " (%s) " (cdr e)) "") "\n"))
  10739. ((eq (car e) :startgrouptag)
  10740. (setq intaggroup t)
  10741. (unless (zerop cnt)
  10742. (setq cnt 0)
  10743. (insert "\n"))
  10744. (insert "[ "))
  10745. ((eq (car e) :endgrouptag)
  10746. (setq intaggroup nil cnt 0)
  10747. (insert "]\n"))
  10748. ((equal e '(:newline))
  10749. (unless (zerop cnt)
  10750. (setq cnt 0)
  10751. (insert "\n")
  10752. (setq e (car tbl))
  10753. (while (equal (car tbl) '(:newline))
  10754. (insert "\n")
  10755. (setq tbl (cdr tbl)))))
  10756. ((equal e '(:grouptags))
  10757. (delete-char -3)
  10758. (insert " : "))
  10759. (t
  10760. (setq tg (copy-sequence (car e)) c2 nil)
  10761. (if (cdr e)
  10762. (setq c (cdr e))
  10763. ;; automatically assign a character.
  10764. (setq c1 (string-to-char
  10765. (downcase (substring
  10766. tg (if (= (string-to-char tg) ?@) 1 0)))))
  10767. (if (or (rassoc c1 ntable) (rassoc c1 table))
  10768. (while (or (rassoc char ntable) (rassoc char table))
  10769. (setq char (1+ char)))
  10770. (setq c2 c1))
  10771. (setq c (or c2
  10772. (if (> char ?~)
  10773. ?\s
  10774. char)))
  10775. ;; Consider characters A-Z after a-z.
  10776. (if (equal char ?z)
  10777. (setq char ?A)))
  10778. (when ingroup (push tg (car groups)))
  10779. (setq tg (org-add-props tg nil 'face
  10780. (cond
  10781. ((not (assoc tg table))
  10782. (org-get-todo-face tg))
  10783. ((member tg current) c-face)
  10784. ((member tg inherited) i-face))))
  10785. (when (equal (caar tbl) :grouptags)
  10786. (org-add-props tg nil 'face 'org-tag-group))
  10787. (when (and (zerop cnt) (not ingroup) (not intaggroup)) (insert " "))
  10788. (insert "[" c "] " tg (make-string
  10789. (- fwidth 4 (length tg)) ?\ ))
  10790. (push (cons tg c) ntable)
  10791. (when (= (cl-incf cnt) ncol)
  10792. (unless (memq (caar tbl) '(:endgroup :endgrouptag))
  10793. (insert "\n")
  10794. (when (or ingroup intaggroup) (insert " ")))
  10795. (setq cnt 0)))))
  10796. (setq ntable (nreverse ntable))
  10797. (insert "\n")
  10798. (goto-char (point-min))
  10799. (unless expert (org-fit-window-to-buffer))
  10800. (setq rtn
  10801. (catch 'exit
  10802. (while t
  10803. (message "[a-z..]:toggle [SPC]:clear [RET]:accept [TAB]:edit [!] %sgroups%s"
  10804. (if (not groups) "no " "")
  10805. (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
  10806. (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
  10807. (setq org-last-tag-selection-key c)
  10808. (cond
  10809. ((= c ?\r) (throw 'exit t))
  10810. ((= c ?!)
  10811. (setq groups (not groups))
  10812. (goto-char (point-min))
  10813. (while (re-search-forward "[{}]" nil t) (replace-match " ")))
  10814. ((= c ?\C-c)
  10815. (if (not expert)
  10816. (org-fast-tag-show-exit
  10817. (setq exit-after-next (not exit-after-next)))
  10818. (setq expert nil)
  10819. (delete-other-windows)
  10820. (set-window-buffer (split-window-vertically) " *Org tags*")
  10821. (org-switch-to-buffer-other-window " *Org tags*")
  10822. (org-fit-window-to-buffer)))
  10823. ((or (= c ?\C-g)
  10824. (and (= c ?q) (not (rassoc c ntable))))
  10825. (delete-overlay org-tags-overlay)
  10826. (setq quit-flag t))
  10827. ((= c ?\ )
  10828. (setq current nil)
  10829. (when exit-after-next (setq exit-after-next 'now)))
  10830. ((= c ?\t)
  10831. (condition-case nil
  10832. (unless tab-tags
  10833. (setq tab-tags
  10834. (delq nil
  10835. (mapcar (lambda (x)
  10836. (let ((item (car-safe x)))
  10837. (and (stringp item)
  10838. (list item))))
  10839. (org--tag-add-to-alist
  10840. (with-current-buffer buf
  10841. (org-get-buffer-tags))
  10842. table))))))
  10843. (setq tg (completing-read "Tag: " tab-tags))
  10844. (when (string-match "\\S-" tg)
  10845. (cl-pushnew (list tg) tab-tags :test #'equal)
  10846. (if (member tg current)
  10847. (setq current (delete tg current))
  10848. (push tg current)))
  10849. (when exit-after-next (setq exit-after-next 'now)))
  10850. ((setq e (rassoc c todo-table) tg (car e))
  10851. (with-current-buffer buf
  10852. (save-excursion (org-todo tg)))
  10853. (when exit-after-next (setq exit-after-next 'now)))
  10854. ((setq e (rassoc c ntable) tg (car e))
  10855. (if (member tg current)
  10856. (setq current (delete tg current))
  10857. (cl-loop for g in groups do
  10858. (when (member tg g)
  10859. (dolist (x g) (setq current (delete x current)))))
  10860. (push tg current))
  10861. (when exit-after-next (setq exit-after-next 'now))))
  10862. ;; Create a sorted list
  10863. (setq current
  10864. (sort current
  10865. (lambda (a b)
  10866. (assoc b (cdr (memq (assoc a ntable) ntable))))))
  10867. (when (eq exit-after-next 'now) (throw 'exit t))
  10868. (goto-char (point-min))
  10869. (beginning-of-line 2)
  10870. (delete-region (point) (line-end-position))
  10871. (org-fast-tag-insert "Current" current c-face)
  10872. (org-set-current-tags-overlay current ov-prefix)
  10873. (let ((tag-re (concat "\\[.\\] \\(" org-tag-re "\\)")))
  10874. (while (re-search-forward tag-re nil t)
  10875. (let ((tag (match-string 1)))
  10876. (add-text-properties
  10877. (match-beginning 1) (match-end 1)
  10878. (list 'face
  10879. (cond
  10880. ((member tag current) c-face)
  10881. ((member tag inherited) i-face)
  10882. (t 'default)))))))
  10883. (goto-char (point-min)))))
  10884. (delete-overlay org-tags-overlay)
  10885. (if rtn
  10886. (mapconcat 'identity current ":")
  10887. nil)))))
  10888. (defun org-make-tag-string (tags)
  10889. "Return string associated to TAGS.
  10890. TAGS is a list of strings."
  10891. (if (null tags) ""
  10892. (format ":%s:" (mapconcat #'identity tags ":"))))
  10893. (defun org--get-local-tags ()
  10894. "Return list of tags for the current headline.
  10895. Assume point is at the beginning of the headline."
  10896. (let* ((cached (and (org-element--cache-active-p) (org-element-at-point nil 'cached)))
  10897. (cached-tags (org-element-property :tags cached)))
  10898. (if cached
  10899. ;; If we do not explicitly copy the result, reference would
  10900. ;; be returned and cache element might be modified directly.
  10901. (mapcar #'copy-sequence cached-tags)
  10902. ;; Parse tags manually.
  10903. (and (looking-at org-tag-line-re)
  10904. (split-string (match-string-no-properties 2) ":" t)))))
  10905. (defun org-get-tags (&optional pos-or-element local)
  10906. "Get the list of tags specified in the current headline.
  10907. When argument POS-OR-ELEMENT is non-nil, retrieve tags for headline at
  10908. POS.
  10909. According to `org-use-tag-inheritance', tags may be inherited
  10910. from parent headlines, and from the whole document, through
  10911. `org-file-tags'. In this case, the returned list of tags
  10912. contains tags in this order: file tags, tags inherited from
  10913. parent headlines, local tags. If a tag appears multiple times,
  10914. only the most local tag is returned.
  10915. However, when optional argument LOCAL is non-nil, only return
  10916. tags specified at the headline.
  10917. Inherited tags have the `inherited' text property."
  10918. (save-match-data
  10919. (if (and org-trust-scanner-tags
  10920. (or (not pos-or-element) (eq pos-or-element (point)))
  10921. (not local))
  10922. org-scanner-tags
  10923. (org-with-point-at (unless (org-element-type pos-or-element)
  10924. (or pos-or-element (point)))
  10925. (unless (or (org-element-type pos-or-element)
  10926. (org-before-first-heading-p))
  10927. (org-back-to-heading t))
  10928. (let ((ltags (if (org-element-type pos-or-element)
  10929. (org-element-property :tags (org-element-lineage pos-or-element '(headline inlinetask) t))
  10930. (org--get-local-tags)))
  10931. itags)
  10932. (if (or local (not org-use-tag-inheritance)) ltags
  10933. (let ((cached (and (org-element--cache-active-p)
  10934. (if (org-element-type pos-or-element)
  10935. (org-element-lineage pos-or-element '(headline org-data inlinetask) t)
  10936. (org-element-at-point nil 'cached)))))
  10937. (if cached
  10938. (while (setq cached (org-element-property :parent cached))
  10939. (setq itags (nconc (mapcar #'org-add-prop-inherited
  10940. ;; If we do explicitly copy the result, reference would
  10941. ;; be returned and cache element might be modified directly.
  10942. (mapcar #'copy-sequence (org-element-property :tags cached)))
  10943. itags)))
  10944. (while (org-up-heading-safe)
  10945. (setq itags (nconc (mapcar #'org-add-prop-inherited
  10946. (org--get-local-tags))
  10947. itags)))))
  10948. (setq itags (append org-file-tags itags))
  10949. (nreverse
  10950. (delete-dups
  10951. (nreverse (nconc (org-remove-uninherited-tags itags) ltags))))))))))
  10952. (defun org-get-buffer-tags ()
  10953. "Get a table of all tags used in the buffer, for completion."
  10954. (if (org-element--cache-active-p)
  10955. ;; `org-element-cache-map' is about 2x faster compared to regexp
  10956. ;; search.
  10957. (let ((hashed (make-hash-table :test #'equal)))
  10958. (org-element-cache-map
  10959. (lambda (el)
  10960. (dolist (tag (org-element-property :tags el))
  10961. ;; Do not carry over the text properties. They may look
  10962. ;; ugly in the completion.
  10963. (puthash (list (substring-no-properties tag)) t hashed))))
  10964. (dolist (tag org-file-tags) (puthash (list tag) t hashed))
  10965. (hash-table-keys hashed))
  10966. (org-with-point-at 1
  10967. (let (tags)
  10968. (while (re-search-forward org-tag-line-re nil t)
  10969. (setq tags (nconc (split-string (match-string-no-properties 2) ":")
  10970. tags)))
  10971. (mapcar #'list (delete-dups (append org-file-tags tags)))))))
  10972. ;;;; The mapping API
  10973. (defvar org-agenda-skip-comment-trees)
  10974. (defvar org-agenda-skip-function)
  10975. (defun org-map-entries (func &optional match scope &rest skip)
  10976. "Call FUNC at each headline selected by MATCH in SCOPE.
  10977. FUNC is a function or a Lisp form. The function will be called without
  10978. arguments, with the cursor positioned at the beginning of the headline.
  10979. The return values of all calls to the function will be collected and
  10980. returned as a list.
  10981. The call to FUNC will be wrapped into a `save-excursion' form, so FUNC
  10982. does not need to preserve point. After evaluation, the cursor will be
  10983. moved to the end of the line (presumably of the headline of the
  10984. processed entry) and search continues from there. Under some
  10985. circumstances, this may not produce the wanted results. For example,
  10986. if you have removed (e.g. archived) the current (sub)tree it could
  10987. mean that the next entry will be skipped entirely. In such cases, you
  10988. can specify the position from where search should continue by making
  10989. FUNC set the variable `org-map-continue-from' to the desired buffer
  10990. position.
  10991. MATCH is a tags/property/todo match as it is used in the agenda tags view.
  10992. Only headlines that are matched by this query will be considered during
  10993. the iteration. When MATCH is nil or t, all headlines will be
  10994. visited by the iteration.
  10995. SCOPE determines the scope of this command. It can be any of:
  10996. nil The current buffer, respecting the restriction if any
  10997. tree The subtree started with the entry at point
  10998. region The entries within the active region, if any
  10999. region-start-level
  11000. The entries within the active region, but only those at
  11001. the same level than the first one.
  11002. file The current buffer, without restriction
  11003. file-with-archives
  11004. The current buffer, and any archives associated with it
  11005. agenda All agenda files
  11006. agenda-with-archives
  11007. All agenda files with any archive files associated with them
  11008. \(file1 file2 ...)
  11009. If this is a list, all files in the list will be scanned
  11010. The remaining args are treated as settings for the skipping facilities of
  11011. the scanner. The following items can be given here:
  11012. archive skip trees with the archive tag
  11013. comment skip trees with the COMMENT keyword
  11014. function or Emacs Lisp form:
  11015. will be used as value for `org-agenda-skip-function', so
  11016. whenever the function returns a position, FUNC will not be
  11017. called for that entry and search will continue from the
  11018. position returned
  11019. If your function needs to retrieve the tags including inherited tags
  11020. at the *current* entry, you can use the value of the variable
  11021. `org-scanner-tags' which will be much faster than getting the value
  11022. with `org-get-tags'. If your function gets properties with
  11023. `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
  11024. to t around the call to `org-entry-properties' to get the same speedup.
  11025. Note that if your function moves around to retrieve tags and properties at
  11026. a *different* entry, you cannot use these techniques."
  11027. (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
  11028. (not (org-region-active-p)))
  11029. (let* ((org-agenda-archives-mode nil) ; just to make sure
  11030. (org-agenda-skip-archived-trees (memq 'archive skip))
  11031. (org-agenda-skip-comment-trees (memq 'comment skip))
  11032. (org-agenda-skip-function
  11033. (car (org-delete-all '(comment archive) skip)))
  11034. (org-tags-match-list-sublevels t)
  11035. (start-level (eq scope 'region-start-level))
  11036. matcher res
  11037. org-todo-keywords-for-agenda
  11038. org-done-keywords-for-agenda
  11039. org-todo-keyword-alist-for-agenda
  11040. org-tag-alist-for-agenda
  11041. org--matcher-tags-todo-only)
  11042. (cond
  11043. ((eq match t) (setq matcher t))
  11044. ((eq match nil) (setq matcher t))
  11045. (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
  11046. (save-excursion
  11047. (save-restriction
  11048. (cond ((eq scope 'tree)
  11049. (org-back-to-heading t)
  11050. (org-narrow-to-subtree)
  11051. (setq scope nil))
  11052. ((and (or (eq scope 'region) (eq scope 'region-start-level))
  11053. (org-region-active-p))
  11054. ;; If needed, set start-level to a string like "2"
  11055. (when start-level
  11056. (save-excursion
  11057. (goto-char (region-beginning))
  11058. (unless (org-at-heading-p) (outline-next-heading))
  11059. (setq start-level (org-current-level))))
  11060. (narrow-to-region (region-beginning)
  11061. (save-excursion
  11062. (goto-char (region-end))
  11063. (unless (and (bolp) (org-at-heading-p))
  11064. (outline-next-heading))
  11065. (point)))
  11066. (setq scope nil)))
  11067. (if (not scope)
  11068. (progn
  11069. ;; Agenda expects a file buffer. Skip over refreshing
  11070. ;; agenda cache for non-file buffers.
  11071. (when buffer-file-name
  11072. (org-agenda-prepare-buffers
  11073. (and buffer-file-name (list buffer-file-name))))
  11074. (setq res
  11075. (org-scan-tags
  11076. func matcher org--matcher-tags-todo-only start-level)))
  11077. ;; Get the right scope
  11078. (cond
  11079. ((and scope (listp scope) (symbolp (car scope)))
  11080. (setq scope (eval scope t)))
  11081. ((eq scope 'agenda)
  11082. (setq scope (org-agenda-files t)))
  11083. ((eq scope 'agenda-with-archives)
  11084. (setq scope (org-agenda-files t))
  11085. (setq scope (org-add-archive-files scope)))
  11086. ((eq scope 'file)
  11087. (setq scope (and buffer-file-name (list buffer-file-name))))
  11088. ((eq scope 'file-with-archives)
  11089. (setq scope (org-add-archive-files (list (buffer-file-name))))))
  11090. (org-agenda-prepare-buffers scope)
  11091. (dolist (file scope)
  11092. (with-current-buffer (org-find-base-buffer-visiting file)
  11093. (org-with-wide-buffer
  11094. (goto-char (point-min))
  11095. (setq res
  11096. (append
  11097. res
  11098. (org-scan-tags
  11099. func matcher org--matcher-tags-todo-only)))))))))
  11100. res)))
  11101. ;;; Properties API
  11102. (defconst org-special-properties
  11103. '("ALLTAGS" "BLOCKED" "CLOCKSUM" "CLOCKSUM_T" "CLOSED" "DEADLINE" "FILE"
  11104. "ITEM" "PRIORITY" "SCHEDULED" "TAGS" "TIMESTAMP" "TIMESTAMP_IA" "TODO")
  11105. "The special properties valid in Org mode.
  11106. These are properties that are not defined in the property drawer,
  11107. but in some other way.")
  11108. (defconst org-default-properties
  11109. '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
  11110. "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
  11111. "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
  11112. "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
  11113. "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE" "UNNUMBERED"
  11114. "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
  11115. "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS"
  11116. "ORG-IMAGE-ACTUAL-WIDTH")
  11117. "Some properties that are used by Org mode for various purposes.
  11118. Being in this list makes sure that they are offered for completion.")
  11119. (defun org--valid-property-p (property)
  11120. "Non-nil when string PROPERTY is a valid property name."
  11121. (not
  11122. (or (equal property "")
  11123. (string-match-p "\\s-" property))))
  11124. (defun org--update-property-plist (key val props)
  11125. "Associate KEY to VAL in alist PROPS.
  11126. Modifications are made by side-effect. Return new alist."
  11127. (let* ((appending (string= (substring key -1) "+"))
  11128. (key (if appending (substring key 0 -1) key))
  11129. (old (assoc-string key props t)))
  11130. (if (not old) (cons (cons key val) props)
  11131. (setcdr old (if appending (concat (cdr old) " " val) val))
  11132. props)))
  11133. (defun org-get-property-block (&optional beg force)
  11134. "Return the (beg . end) range of the body of the property drawer.
  11135. BEG is the beginning of the current subtree or the beginning of
  11136. the document if before the first headline. If it is not given,
  11137. it will be found. If the drawer does not exist, create it if
  11138. FORCE is non-nil, or return nil."
  11139. (org-with-wide-buffer
  11140. (let ((beg (cond (beg (goto-char beg))
  11141. ((or (not (featurep 'org-inlinetask))
  11142. (org-inlinetask-in-task-p))
  11143. (org-back-to-heading-or-point-min t) (point))
  11144. (t (org-with-limited-levels
  11145. (org-back-to-heading-or-point-min t))
  11146. (point)))))
  11147. ;; Move point to its position according to its positional rules.
  11148. (cond ((org-before-first-heading-p)
  11149. (while (and (org-at-comment-p) (bolp)) (forward-line)))
  11150. (t (forward-line)
  11151. (when (looking-at-p org-planning-line-re) (forward-line))))
  11152. (cond ((looking-at org-property-drawer-re)
  11153. (forward-line)
  11154. (cons (point) (progn (goto-char (match-end 0))
  11155. (line-beginning-position))))
  11156. (force
  11157. (goto-char beg)
  11158. (org-insert-property-drawer)
  11159. (let ((pos (save-excursion (re-search-forward org-property-drawer-re)
  11160. (line-beginning-position))))
  11161. (cons pos pos)))))))
  11162. (defun org-at-property-drawer-p ()
  11163. "Non-nil when point is at the first line of a property drawer."
  11164. (org-with-wide-buffer
  11165. (beginning-of-line)
  11166. (and (looking-at org-property-drawer-re)
  11167. (or (bobp)
  11168. (progn
  11169. (forward-line -1)
  11170. (cond ((org-at-heading-p))
  11171. ((looking-at org-planning-line-re)
  11172. (forward-line -1)
  11173. (org-at-heading-p))
  11174. ((looking-at org-comment-regexp)
  11175. (forward-line -1)
  11176. (while (and (not (bobp)) (looking-at org-comment-regexp))
  11177. (forward-line -1))
  11178. (looking-at org-comment-regexp))
  11179. (t nil)))))))
  11180. (defun org-at-property-p ()
  11181. "Non-nil when point is inside a property drawer.
  11182. See `org-property-re' for match data, if applicable."
  11183. (save-excursion
  11184. (beginning-of-line)
  11185. (and (looking-at org-property-re)
  11186. (let ((property-drawer (save-match-data (org-get-property-block))))
  11187. (and property-drawer
  11188. (>= (point) (car property-drawer))
  11189. (< (point) (cdr property-drawer)))))))
  11190. (defun org-property-action ()
  11191. "Do an action on properties."
  11192. (interactive)
  11193. (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
  11194. (let ((c (read-char-exclusive)))
  11195. (cl-case c
  11196. (?s (call-interactively #'org-set-property))
  11197. (?d (call-interactively #'org-delete-property))
  11198. (?D (call-interactively #'org-delete-property-globally))
  11199. (?c (call-interactively #'org-compute-property-at-point))
  11200. (otherwise (user-error "No such property action %c" c)))))
  11201. (defun org-inc-effort ()
  11202. "Increment the value of the effort property in the current entry."
  11203. (interactive)
  11204. (org-set-effort t))
  11205. (defvar org-clock-effort) ; Defined in org-clock.el.
  11206. (defvar org-clock-current-task) ; Defined in org-clock.el.
  11207. (defun org-set-effort (&optional increment value)
  11208. "Set the effort property of the current entry.
  11209. If INCREMENT is non-nil, set the property to the next allowed
  11210. value. Otherwise, if optional argument VALUE is provided, use
  11211. it. Eventually, prompt for the new value if none of the previous
  11212. variables is set."
  11213. (interactive "P")
  11214. (let* ((allowed (org-property-get-allowed-values nil org-effort-property t))
  11215. (current (org-entry-get nil org-effort-property))
  11216. (value
  11217. (cond
  11218. (increment
  11219. (unless allowed (user-error "Allowed effort values are not set"))
  11220. (or (cl-caadr (member (list current) allowed))
  11221. (user-error "Unknown value %S among allowed values" current)))
  11222. (value
  11223. (if (stringp value) value
  11224. (error "Invalid effort value: %S" value)))
  11225. (t
  11226. (let ((must-match
  11227. (and allowed
  11228. (not (get-text-property 0 'org-unrestricted
  11229. (caar allowed))))))
  11230. (completing-read "Effort: " allowed nil must-match))))))
  11231. ;; Test whether the value can be interpreted as a duration before
  11232. ;; inserting it in the buffer:
  11233. (org-duration-to-minutes value)
  11234. ;; Maybe update the effort value:
  11235. (unless (equal current value)
  11236. (org-entry-put nil org-effort-property value))
  11237. (unless (org-element--cache-active-p)
  11238. (org-refresh-property '((effort . identity)
  11239. (effort-minutes . org-duration-to-minutes))
  11240. value))
  11241. (when (equal (org-get-heading t t t t)
  11242. (bound-and-true-p org-clock-current-task))
  11243. (setq org-clock-effort value)
  11244. (org-clock-update-mode-line))
  11245. (message "%s is now %s" org-effort-property value)))
  11246. (defun org-entry-properties (&optional pom which)
  11247. "Get all properties of the current entry.
  11248. When POM is a buffer position, get all properties from the entry
  11249. there instead.
  11250. This includes the TODO keyword, the tags, time strings for
  11251. deadline, scheduled, and clocking, and any additional properties
  11252. defined in the entry.
  11253. If WHICH is nil or `all', get all properties. If WHICH is
  11254. `special' or `standard', only get that subclass. If WHICH is
  11255. a string, only get that property.
  11256. Return value is an alist. Keys are properties, as upcased
  11257. strings."
  11258. (org-with-point-at pom
  11259. (when (and (derived-mode-p 'org-mode)
  11260. (org-back-to-heading-or-point-min t))
  11261. (catch 'exit
  11262. (let* ((beg (point))
  11263. (specific (and (stringp which) (upcase which)))
  11264. (which (cond ((not specific) which)
  11265. ((member specific org-special-properties) 'special)
  11266. (t 'standard)))
  11267. props)
  11268. ;; Get the special properties, like TODO and TAGS.
  11269. (when (memq which '(nil all special))
  11270. (when (or (not specific) (string= specific "CLOCKSUM"))
  11271. (let ((clocksum (get-text-property (point) :org-clock-minutes)))
  11272. (when clocksum
  11273. (push (cons "CLOCKSUM" (org-duration-from-minutes clocksum))
  11274. props)))
  11275. (when specific (throw 'exit props)))
  11276. (when (or (not specific) (string= specific "CLOCKSUM_T"))
  11277. (let ((clocksumt (get-text-property (point)
  11278. :org-clock-minutes-today)))
  11279. (when clocksumt
  11280. (push (cons "CLOCKSUM_T"
  11281. (org-duration-from-minutes clocksumt))
  11282. props)))
  11283. (when specific (throw 'exit props)))
  11284. (when (or (not specific) (string= specific "ITEM"))
  11285. (let ((case-fold-search nil))
  11286. (when (looking-at org-complex-heading-regexp)
  11287. (push (cons "ITEM"
  11288. (let ((title (match-string-no-properties 4)))
  11289. (if (org-string-nw-p title)
  11290. (org-remove-tabs title)
  11291. "")))
  11292. props)))
  11293. (when specific (throw 'exit props)))
  11294. (when (or (not specific) (string= specific "TODO"))
  11295. (let ((case-fold-search nil))
  11296. (when (and (looking-at org-todo-line-regexp) (match-end 2))
  11297. (push (cons "TODO" (match-string-no-properties 2)) props)))
  11298. (when specific (throw 'exit props)))
  11299. (when (or (not specific) (string= specific "PRIORITY"))
  11300. (push (cons "PRIORITY"
  11301. (if (looking-at org-priority-regexp)
  11302. (match-string-no-properties 2)
  11303. (char-to-string org-priority-default)))
  11304. props)
  11305. (when specific (throw 'exit props)))
  11306. (when (or (not specific) (string= specific "FILE"))
  11307. (push (cons "FILE" (buffer-file-name (buffer-base-buffer)))
  11308. props)
  11309. (when specific (throw 'exit props)))
  11310. (when (or (not specific) (string= specific "TAGS"))
  11311. (let ((tags (org-get-tags nil t)))
  11312. (when tags
  11313. (push (cons "TAGS" (org-make-tag-string tags))
  11314. props)))
  11315. (when specific (throw 'exit props)))
  11316. (when (or (not specific) (string= specific "ALLTAGS"))
  11317. (let ((tags (org-get-tags)))
  11318. (when tags
  11319. (push (cons "ALLTAGS" (org-make-tag-string tags))
  11320. props)))
  11321. (when specific (throw 'exit props)))
  11322. (when (or (not specific) (string= specific "BLOCKED"))
  11323. (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props)
  11324. (when specific (throw 'exit props)))
  11325. (when (or (not specific)
  11326. (member specific '("CLOSED" "DEADLINE" "SCHEDULED")))
  11327. (forward-line)
  11328. (when (looking-at-p org-planning-line-re)
  11329. (end-of-line)
  11330. (let ((bol (line-beginning-position))
  11331. ;; Backward compatibility: time keywords used to
  11332. ;; be configurable (before 8.3). Make sure we
  11333. ;; get the correct keyword.
  11334. (key-assoc `(("CLOSED" . ,org-closed-string)
  11335. ("DEADLINE" . ,org-deadline-string)
  11336. ("SCHEDULED" . ,org-scheduled-string))))
  11337. (dolist (pair (if specific (list (assoc specific key-assoc))
  11338. key-assoc))
  11339. (save-excursion
  11340. (when (search-backward (cdr pair) bol t)
  11341. (goto-char (match-end 0))
  11342. (skip-chars-forward " \t")
  11343. (and (looking-at org-ts-regexp-both)
  11344. (push (cons (car pair)
  11345. (match-string-no-properties 0))
  11346. props)))))))
  11347. (when specific (throw 'exit props)))
  11348. (when (or (not specific)
  11349. (member specific '("TIMESTAMP" "TIMESTAMP_IA")))
  11350. (let ((find-ts
  11351. (lambda (end ts)
  11352. ;; Fix next time-stamp before END. TS is the
  11353. ;; list of time-stamps found so far.
  11354. (let ((ts ts)
  11355. (regexp (cond
  11356. ((string= specific "TIMESTAMP")
  11357. org-ts-regexp)
  11358. ((string= specific "TIMESTAMP_IA")
  11359. org-ts-regexp-inactive)
  11360. ((assoc "TIMESTAMP_IA" ts)
  11361. org-ts-regexp)
  11362. ((assoc "TIMESTAMP" ts)
  11363. org-ts-regexp-inactive)
  11364. (t org-ts-regexp-both))))
  11365. (catch 'next
  11366. (while (re-search-forward regexp end t)
  11367. (backward-char)
  11368. (let ((object (org-element-context)))
  11369. ;; Accept to match timestamps in node
  11370. ;; properties, too.
  11371. (when (memq (org-element-type object)
  11372. '(node-property timestamp))
  11373. (let ((type
  11374. (org-element-property :type object)))
  11375. (cond
  11376. ((and (memq type '(active active-range))
  11377. (not (equal specific "TIMESTAMP_IA")))
  11378. (unless (assoc "TIMESTAMP" ts)
  11379. (push (cons "TIMESTAMP"
  11380. (org-element-property
  11381. :raw-value object))
  11382. ts)
  11383. (when specific (throw 'exit ts))))
  11384. ((and (memq type '(inactive inactive-range))
  11385. (not (string= specific "TIMESTAMP")))
  11386. (unless (assoc "TIMESTAMP_IA" ts)
  11387. (push (cons "TIMESTAMP_IA"
  11388. (org-element-property
  11389. :raw-value object))
  11390. ts)
  11391. (when specific (throw 'exit ts))))))
  11392. ;; Both timestamp types are found,
  11393. ;; move to next part.
  11394. (when (= (length ts) 2) (throw 'next ts)))))
  11395. ts)))))
  11396. (goto-char beg)
  11397. ;; First look for timestamps within headline.
  11398. (let ((ts (funcall find-ts (line-end-position) nil)))
  11399. (if (= (length ts) 2) (setq props (nconc ts props))
  11400. ;; Then find timestamps in the section, skipping
  11401. ;; planning line.
  11402. (let ((end (save-excursion (outline-next-heading))))
  11403. (forward-line)
  11404. (when (looking-at-p org-planning-line-re) (forward-line))
  11405. (setq props (nconc (funcall find-ts end ts) props))))))))
  11406. ;; Get the standard properties, like :PROP:.
  11407. (when (memq which '(nil all standard))
  11408. ;; If we are looking after a specific property, delegate
  11409. ;; to `org-entry-get', which is faster. However, make an
  11410. ;; exception for "CATEGORY", since it can be also set
  11411. ;; through keywords (i.e. #+CATEGORY).
  11412. (if (and specific (not (equal specific "CATEGORY")))
  11413. (let ((value (org-entry-get beg specific nil t)))
  11414. (throw 'exit (and value (list (cons specific value)))))
  11415. (let ((range (org-get-property-block beg)))
  11416. (when range
  11417. (let ((end (cdr range)) seen-base)
  11418. (goto-char (car range))
  11419. ;; Unlike to `org--update-property-plist', we
  11420. ;; handle the case where base values is found
  11421. ;; after its extension. We also forbid standard
  11422. ;; properties to be named as special properties.
  11423. (while (re-search-forward org-property-re end t)
  11424. (let* ((key (upcase (match-string-no-properties 2)))
  11425. (extendp (string-match-p "\\+\\'" key))
  11426. (key-base (if extendp (substring key 0 -1) key))
  11427. (value (match-string-no-properties 3)))
  11428. (cond
  11429. ((member-ignore-case key-base org-special-properties))
  11430. (extendp
  11431. (setq props
  11432. (org--update-property-plist key value props)))
  11433. ((member key seen-base))
  11434. (t (push key seen-base)
  11435. (let ((p (assoc-string key props t)))
  11436. (if p (setcdr p (concat value " " (cdr p)))
  11437. (push (cons key value) props))))))))))))
  11438. (unless (assoc "CATEGORY" props)
  11439. (push (cons "CATEGORY" (org-get-category beg)) props)
  11440. (when (string= specific "CATEGORY") (throw 'exit props)))
  11441. ;; Return value.
  11442. props)))))
  11443. (defun org--property-local-values (property literal-nil &optional element)
  11444. "Return value for PROPERTY in current entry or ELEMENT.
  11445. Value is a list whose car is the base value for PROPERTY and cdr
  11446. a list of accumulated values. Return nil if neither is found in
  11447. the entry. Also return nil when PROPERTY is set to \"nil\",
  11448. unless LITERAL-NIL is non-nil."
  11449. (let ((element (or element
  11450. (and (org-element--cache-active-p)
  11451. (org-element-at-point nil 'cached)))))
  11452. (if element
  11453. (let* ((element (org-element-lineage element '(headline org-data inlinetask) 'with-self))
  11454. (base-value (org-element-property (intern (concat ":" (upcase property))) element))
  11455. (base-value (if literal-nil base-value (org-not-nil base-value)))
  11456. (extra-value (org-element-property (intern (concat ":" (upcase property) "+")) element))
  11457. (extra-value (if (listp extra-value) extra-value (list extra-value)))
  11458. (value (cons base-value extra-value)))
  11459. (and (not (equal value '(nil))) value))
  11460. (let ((range (org-get-property-block)))
  11461. (when range
  11462. (goto-char (car range))
  11463. (let* ((case-fold-search t)
  11464. (end (cdr range))
  11465. (value
  11466. ;; Base value.
  11467. (save-excursion
  11468. (let ((v (and (re-search-forward
  11469. (org-re-property property nil t) end t)
  11470. (match-string-no-properties 3))))
  11471. (list (if literal-nil v (org-not-nil v)))))))
  11472. ;; Find additional values.
  11473. (let* ((property+ (org-re-property (concat property "+") nil t)))
  11474. (while (re-search-forward property+ end t)
  11475. (push (match-string-no-properties 3) value)))
  11476. ;; Return final values.
  11477. (and (not (equal value '(nil))) (nreverse value))))))))
  11478. (defun org--property-global-or-keyword-value (property literal-nil)
  11479. "Return value for PROPERTY as defined by global properties or by keyword.
  11480. Return value is a string. Return nil if property is not set
  11481. globally or by keyword. Also return nil when PROPERTY is set to
  11482. \"nil\", unless LITERAL-NIL is non-nil."
  11483. (let ((global
  11484. (cdr (or (assoc-string property org-keyword-properties t)
  11485. (assoc-string property org-global-properties t)
  11486. (assoc-string property org-global-properties-fixed t)))))
  11487. (if literal-nil global (org-not-nil global))))
  11488. (defun org-entry-get (pom property &optional inherit literal-nil)
  11489. "Get value of PROPERTY for entry or content at point-or-marker POM.
  11490. If INHERIT is non-nil and the entry does not have the property,
  11491. then also check higher levels of the hierarchy. If INHERIT is
  11492. the symbol `selective', use inheritance only if the setting in
  11493. `org-use-property-inheritance' selects PROPERTY for inheritance.
  11494. If the property is present but empty, the return value is the
  11495. empty string. If the property is not present at all, nil is
  11496. returned. In any other case, return the value as a string.
  11497. Search is case-insensitive.
  11498. If LITERAL-NIL is set, return the string value \"nil\" as
  11499. a string, do not interpret it as the list atom nil. This is used
  11500. for inheritance when a \"nil\" value can supersede a non-nil
  11501. value higher up the hierarchy."
  11502. (org-with-point-at pom
  11503. (cond
  11504. ((member-ignore-case property (cons "CATEGORY" org-special-properties))
  11505. ;; We need a special property. Use `org-entry-properties' to
  11506. ;; retrieve it, but specify the wanted property.
  11507. (cdr (assoc-string property (org-entry-properties nil property))))
  11508. ((and inherit
  11509. (or (not (eq inherit 'selective)) (org-property-inherit-p property)))
  11510. (org-entry-get-with-inheritance property literal-nil))
  11511. (t
  11512. (let* ((local (org--property-local-values property literal-nil))
  11513. (value (and local (mapconcat #'identity
  11514. (delq nil local)
  11515. (org--property-get-separator property)))))
  11516. (if literal-nil value (org-not-nil value)))))))
  11517. (defun org-property-or-variable-value (var &optional inherit)
  11518. "Check if there is a property fixing the value of VAR.
  11519. If yes, return this value. If not, return the current value of the variable."
  11520. (let ((prop (org-entry-get nil (symbol-name var) inherit)))
  11521. (if (and prop (stringp prop) (string-match "\\S-" prop))
  11522. (read prop)
  11523. (symbol-value var))))
  11524. (defun org-entry-delete (pom property)
  11525. "Delete PROPERTY from entry at point-or-marker POM.
  11526. Accumulated properties, i.e. PROPERTY+, are also removed. Return
  11527. non-nil when a property was removed."
  11528. (org-with-point-at pom
  11529. (pcase (org-get-property-block)
  11530. (`(,begin . ,origin)
  11531. (let* ((end (copy-marker origin))
  11532. (re (org-re-property
  11533. (concat (regexp-quote property) "\\+?") t t)))
  11534. (goto-char begin)
  11535. (while (re-search-forward re end t)
  11536. (delete-region (match-beginning 0) (line-beginning-position 2)))
  11537. ;; If drawer is empty, remove it altogether.
  11538. (when (= begin end)
  11539. (delete-region (line-beginning-position 0)
  11540. (line-beginning-position 2)))
  11541. ;; Return non-nil if some property was removed.
  11542. (prog1 (/= end origin) (set-marker end nil))))
  11543. (_ nil))))
  11544. ;; Multi-values properties are properties that contain multiple values
  11545. ;; These values are assumed to be single words, separated by whitespace.
  11546. (defun org-entry-add-to-multivalued-property (pom property value)
  11547. "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
  11548. (let* ((old (org-entry-get pom property))
  11549. (values (and old (split-string old))))
  11550. (setq value (org-entry-protect-space value))
  11551. (unless (member value values)
  11552. (setq values (append values (list value)))
  11553. (org-entry-put pom property (mapconcat #'identity values " ")))))
  11554. (defun org-entry-remove-from-multivalued-property (pom property value)
  11555. "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
  11556. (let* ((old (org-entry-get pom property))
  11557. (values (and old (split-string old))))
  11558. (setq value (org-entry-protect-space value))
  11559. (when (member value values)
  11560. (setq values (delete value values))
  11561. (org-entry-put pom property (mapconcat #'identity values " ")))))
  11562. (defun org-entry-member-in-multivalued-property (pom property value)
  11563. "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
  11564. (let* ((old (org-entry-get pom property))
  11565. (values (and old (split-string old))))
  11566. (setq value (org-entry-protect-space value))
  11567. (member value values)))
  11568. (defun org-entry-get-multivalued-property (pom property)
  11569. "Return a list of values in a multivalued property."
  11570. (let* ((value (org-entry-get pom property))
  11571. (values (and value (split-string value))))
  11572. (mapcar #'org-entry-restore-space values)))
  11573. (defun org-entry-put-multivalued-property (pom property &rest values)
  11574. "Set multivalued PROPERTY at point-or-marker POM to VALUES.
  11575. VALUES should be a list of strings. Spaces will be protected."
  11576. (org-entry-put pom property (mapconcat #'org-entry-protect-space values " "))
  11577. (let* ((value (org-entry-get pom property))
  11578. (values (and value (split-string value))))
  11579. (mapcar #'org-entry-restore-space values)))
  11580. (defun org-entry-protect-space (s)
  11581. "Protect spaces and newline in string S."
  11582. (while (string-match " " s)
  11583. (setq s (replace-match "%20" t t s)))
  11584. (while (string-match "\n" s)
  11585. (setq s (replace-match "%0A" t t s)))
  11586. s)
  11587. (defun org-entry-restore-space (s)
  11588. "Restore spaces and newline in string S."
  11589. (while (string-match "%20" s)
  11590. (setq s (replace-match " " t t s)))
  11591. (while (string-match "%0A" s)
  11592. (setq s (replace-match "\n" t t s)))
  11593. s)
  11594. (defvar org-entry-property-inherited-from (make-marker)
  11595. "Marker pointing to the entry from where a property was inherited.
  11596. Each call to `org-entry-get-with-inheritance' will set this marker to the
  11597. location of the entry where the inheritance search matched. If there was
  11598. no match, the marker will point nowhere.
  11599. Note that also `org-entry-get' calls this function, if the INHERIT flag
  11600. is set.")
  11601. (defun org-entry-get-with-inheritance (property &optional literal-nil element)
  11602. "Get PROPERTY of entry or content at point, search higher levels if needed.
  11603. The search will stop at the first ancestor which has the property defined.
  11604. If the value found is \"nil\", return nil to show that the property
  11605. should be considered as undefined (this is the meaning of nil here).
  11606. However, if LITERAL-NIL is set, return the string value \"nil\" instead."
  11607. (move-marker org-entry-property-inherited-from nil)
  11608. (org-with-wide-buffer
  11609. (let (value at-bob-no-heading)
  11610. (catch 'exit
  11611. (let ((element (or element
  11612. (and (org-element--cache-active-p)
  11613. (org-element-at-point nil 'cached))))
  11614. (separator (org--property-get-separator property)))
  11615. (if element
  11616. (let ((element (org-element-lineage element '(headline org-data inlinetask) 'with-self)))
  11617. (while t
  11618. (let* ((v (org--property-local-values property literal-nil element))
  11619. (v (if (listp v) v (list v))))
  11620. (when v
  11621. (setq value
  11622. (concat (mapconcat #'identity (delq nil v) separator)
  11623. (and value separator)
  11624. value)))
  11625. (cond
  11626. ((car v)
  11627. (move-marker org-entry-property-inherited-from (org-element-property :begin element))
  11628. (throw 'exit nil))
  11629. ((org-element-property :parent element)
  11630. (setq element (org-element-property :parent element)))
  11631. (t
  11632. (let ((global (org--property-global-or-keyword-value property literal-nil)))
  11633. (cond ((not global))
  11634. (value (setq value (concat global separator value)))
  11635. (t (setq value global))))
  11636. (throw 'exit nil))))))
  11637. (while t
  11638. (let ((v (org--property-local-values property literal-nil)))
  11639. (when v
  11640. (setq value
  11641. (concat (mapconcat #'identity (delq nil v) separator)
  11642. (and value separator)
  11643. value)))
  11644. (cond
  11645. ((car v)
  11646. (org-back-to-heading-or-point-min t)
  11647. (move-marker org-entry-property-inherited-from (point))
  11648. (throw 'exit nil))
  11649. ((or (org-up-heading-safe)
  11650. (and (not (bobp))
  11651. (goto-char (point-min))
  11652. nil)
  11653. ;; `org-up-heading-safe' returned nil. We are at low
  11654. ;; level heading or bob. If there is headline
  11655. ;; there, do not try to fetch its properties.
  11656. (and (bobp)
  11657. (not at-bob-no-heading)
  11658. (not (org-at-heading-p))
  11659. (setq at-bob-no-heading t))))
  11660. (t
  11661. (let ((global (org--property-global-or-keyword-value property literal-nil)))
  11662. (cond ((not global))
  11663. (value (setq value (concat global separator value)))
  11664. (t (setq value global))))
  11665. (throw 'exit nil))))))))
  11666. (if literal-nil value (org-not-nil value)))))
  11667. (defvar org-property-changed-functions nil
  11668. "Hook called when the value of a property has changed.
  11669. Each hook function should accept two arguments, the name of the property
  11670. and the new value.")
  11671. (defun org-entry-put (pom property value)
  11672. "Set PROPERTY to VALUE for entry at point-or-marker POM.
  11673. If the value is nil, it is converted to the empty string. If it
  11674. is not a string, an error is raised. Also raise an error on
  11675. invalid property names.
  11676. PROPERTY can be any regular property (see
  11677. `org-special-properties'). It can also be \"TODO\",
  11678. \"PRIORITY\", \"SCHEDULED\" and \"DEADLINE\".
  11679. For the last two properties, VALUE may have any of the special
  11680. values \"earlier\" and \"later\". The function then increases or
  11681. decreases scheduled or deadline date by one day."
  11682. (cond ((null value) (setq value ""))
  11683. ((not (stringp value)) (error "Properties values should be strings"))
  11684. ((not (org--valid-property-p property))
  11685. (user-error "Invalid property name: \"%s\"" property)))
  11686. (org-no-read-only
  11687. (org-with-point-at pom
  11688. (if (or (not (featurep 'org-inlinetask)) (org-inlinetask-in-task-p))
  11689. (org-back-to-heading-or-point-min t)
  11690. (org-with-limited-levels (org-back-to-heading-or-point-min t)))
  11691. (let ((beg (point)))
  11692. (cond
  11693. ((equal property "TODO")
  11694. (cond ((not (org-string-nw-p value)) (setq value 'none))
  11695. ((not (member value org-todo-keywords-1))
  11696. (user-error "\"%s\" is not a valid TODO state" value)))
  11697. (org-todo value)
  11698. (org-align-tags))
  11699. ((equal property "PRIORITY")
  11700. (org-priority (if (org-string-nw-p value) (string-to-char value) ?\s))
  11701. (org-align-tags))
  11702. ((equal property "SCHEDULED")
  11703. (forward-line)
  11704. (if (and (looking-at-p org-planning-line-re)
  11705. (re-search-forward
  11706. org-scheduled-time-regexp (line-end-position) t))
  11707. (cond ((string= value "earlier") (org-timestamp-change -1 'day))
  11708. ((string= value "later") (org-timestamp-change 1 'day))
  11709. ((string= value "") (org-schedule '(4)))
  11710. (t (org-schedule nil value)))
  11711. (if (member value '("earlier" "later" ""))
  11712. (call-interactively #'org-schedule)
  11713. (org-schedule nil value))))
  11714. ((equal property "DEADLINE")
  11715. (forward-line)
  11716. (if (and (looking-at-p org-planning-line-re)
  11717. (re-search-forward
  11718. org-deadline-time-regexp (line-end-position) t))
  11719. (cond ((string= value "earlier") (org-timestamp-change -1 'day))
  11720. ((string= value "later") (org-timestamp-change 1 'day))
  11721. ((string= value "") (org-deadline '(4)))
  11722. (t (org-deadline nil value)))
  11723. (if (member value '("earlier" "later" ""))
  11724. (call-interactively #'org-deadline)
  11725. (org-deadline nil value))))
  11726. ((member property org-special-properties)
  11727. (error "The %s property cannot be set with `org-entry-put'" property))
  11728. (t
  11729. (org-fold-core-ignore-modifications
  11730. (let* ((range (org-get-property-block beg 'force))
  11731. (end (cdr range))
  11732. (case-fold-search t))
  11733. (goto-char (car range))
  11734. (if (re-search-forward (org-re-property property nil t) end t)
  11735. (progn (delete-region (match-beginning 0) (match-end 0))
  11736. (goto-char (match-beginning 0)))
  11737. (goto-char end)
  11738. (insert-and-inherit "\n")
  11739. (backward-char))
  11740. (insert-and-inherit ":" property ":")
  11741. (when value (insert-and-inherit " " value))
  11742. (org-indent-line))))))
  11743. (run-hook-with-args 'org-property-changed-functions property value))))
  11744. (defun org-buffer-property-keys (&optional specials defaults columns)
  11745. "Get all property keys in the current buffer.
  11746. When SPECIALS is non-nil, also list the special properties that
  11747. reflect things like tags and TODO state.
  11748. When DEFAULTS is non-nil, also include properties that has
  11749. special meaning internally: ARCHIVE, CATEGORY, SUMMARY,
  11750. DESCRIPTION, LOCATION, and LOGGING and others.
  11751. When COLUMNS in non-nil, also include property names given in
  11752. COLUMN formats in the current buffer."
  11753. (let ((case-fold-search t)
  11754. (props (append
  11755. (and specials org-special-properties)
  11756. (and defaults (cons org-effort-property org-default-properties))
  11757. ;; Get property names from #+PROPERTY keywords as well
  11758. (mapcar (lambda (s)
  11759. (nth 0 (split-string s)))
  11760. (cdar (org-collect-keywords '("PROPERTY")))))))
  11761. (org-with-wide-buffer
  11762. (goto-char (point-min))
  11763. (while (re-search-forward org-property-start-re nil t)
  11764. (catch :skip
  11765. (let ((range (org-get-property-block)))
  11766. (unless range (throw :skip nil))
  11767. (goto-char (car range))
  11768. (let ((begin (car range))
  11769. (end (cdr range)))
  11770. ;; Make sure that found property block is not located
  11771. ;; before current point, as it would generate an infloop.
  11772. ;; It can happen, for example, in the following
  11773. ;; situation:
  11774. ;;
  11775. ;; * Headline
  11776. ;; :PROPERTIES:
  11777. ;; ...
  11778. ;; :END:
  11779. ;; *************** Inlinetask
  11780. ;; #+BEGIN_EXAMPLE
  11781. ;; :PROPERTIES:
  11782. ;; #+END_EXAMPLE
  11783. ;;
  11784. (if (< begin (point)) (throw :skip nil) (goto-char begin))
  11785. (while (< (point) end)
  11786. (let ((p (progn (looking-at org-property-re)
  11787. (match-string-no-properties 2))))
  11788. ;; Only add true property name, not extension symbol.
  11789. (push (if (not (string-match-p "\\+\\'" p)) p
  11790. (substring p 0 -1))
  11791. props))
  11792. (forward-line))))
  11793. (outline-next-heading)))
  11794. (when columns
  11795. (goto-char (point-min))
  11796. (while (re-search-forward "^[ \t]*\\(?:#\\+\\|:\\)COLUMNS:" nil t)
  11797. (let ((element (org-element-at-point)))
  11798. (when (memq (org-element-type element) '(keyword node-property))
  11799. (let ((value (org-element-property :value element))
  11800. (start 0))
  11801. (while (string-match "%[0-9]*\\([[:alnum:]_-]+\\)\\(([^)]+)\\)?\
  11802. \\(?:{[^}]+}\\)?"
  11803. value start)
  11804. (setq start (match-end 0))
  11805. (let ((p (match-string-no-properties 1 value)))
  11806. (unless (member-ignore-case p org-special-properties)
  11807. (push p props))))))))))
  11808. (sort (delete-dups
  11809. (append props
  11810. ;; for each xxx_ALL property, make sure the bare
  11811. ;; xxx property is also included
  11812. (delq nil (mapcar (lambda (p)
  11813. (and (string-match-p "._ALL\\'" p)
  11814. (substring p 0 -4)))
  11815. props))))
  11816. (lambda (a b) (string< (upcase a) (upcase b))))))
  11817. (defun org-property-values (key)
  11818. "List all non-nil values of property KEY in current buffer."
  11819. (org-with-wide-buffer
  11820. (goto-char (point-min))
  11821. (let ((case-fold-search t)
  11822. (re (org-re-property key))
  11823. values)
  11824. (while (re-search-forward re nil t)
  11825. (push (org-entry-get (point) key) values))
  11826. (delete-dups values))))
  11827. (defun org-insert-property-drawer ()
  11828. "Insert a property drawer into the current entry.
  11829. Do nothing if the drawer already exists. The newly created
  11830. drawer is immediately hidden."
  11831. (org-with-wide-buffer
  11832. ;; Set point to the position where the drawer should be inserted.
  11833. (if (or (not (featurep 'org-inlinetask)) (org-inlinetask-in-task-p))
  11834. (org-back-to-heading-or-point-min t)
  11835. (org-with-limited-levels (org-back-to-heading-or-point-min t)))
  11836. (if (org-before-first-heading-p)
  11837. (while (and (org-at-comment-p) (bolp)) (forward-line))
  11838. (forward-line)
  11839. (when (looking-at-p org-planning-line-re) (forward-line)))
  11840. (unless (looking-at-p org-property-drawer-re)
  11841. ;; Make sure we start editing a line from current entry, not from
  11842. ;; next one. It prevents extending text properties or overlays
  11843. ;; belonging to the latter.
  11844. (when (and (bolp) (> (point) (point-min))) (backward-char))
  11845. (let ((begin (if (bobp) (point) (1+ (point))))
  11846. (inhibit-read-only t))
  11847. (unless (bobp) (insert "\n"))
  11848. (insert ":PROPERTIES:\n:END:")
  11849. (org-fold-region (line-end-position 0) (point) t (if (eq org-fold-core-style 'text-properties) 'drawer 'outline))
  11850. (when (or (eobp) (= begin (point-min))) (insert "\n"))
  11851. (org-indent-region begin (point))))))
  11852. (defun org-insert-drawer (&optional arg drawer)
  11853. "Insert a drawer at point.
  11854. When optional argument ARG is non-nil, insert a property drawer.
  11855. Optional argument DRAWER, when non-nil, is a string representing
  11856. drawer's name. Otherwise, the user is prompted for a name.
  11857. If a region is active, insert the drawer around that region
  11858. instead.
  11859. Point is left between drawer's boundaries."
  11860. (interactive "P")
  11861. (let* ((drawer (if arg "PROPERTIES"
  11862. (or drawer (read-from-minibuffer "Drawer: ")))))
  11863. (cond
  11864. ;; With C-u, fall back on `org-insert-property-drawer'
  11865. (arg (org-insert-property-drawer))
  11866. ;; Check validity of suggested drawer's name.
  11867. ((not (string-match-p org-drawer-regexp (format ":%s:" drawer)))
  11868. (user-error "Invalid drawer name"))
  11869. ;; With an active region, insert a drawer at point.
  11870. ((not (org-region-active-p))
  11871. (progn
  11872. (unless (bolp) (insert "\n"))
  11873. (insert (format ":%s:\n\n:END:\n" drawer))
  11874. (forward-line -2)))
  11875. ;; Otherwise, insert the drawer at point
  11876. (t
  11877. (let ((rbeg (region-beginning))
  11878. (rend (copy-marker (region-end))))
  11879. (unwind-protect
  11880. (progn
  11881. (goto-char rbeg)
  11882. (beginning-of-line)
  11883. (when (save-excursion
  11884. (re-search-forward org-outline-regexp-bol rend t))
  11885. (user-error "Drawers cannot contain headlines"))
  11886. ;; Position point at the beginning of the first
  11887. ;; non-blank line in region. Insert drawer's opening
  11888. ;; there, then indent it.
  11889. (org-skip-whitespace)
  11890. (beginning-of-line)
  11891. (insert ":" drawer ":\n")
  11892. (forward-line -1)
  11893. (indent-for-tab-command)
  11894. ;; Move point to the beginning of the first blank line
  11895. ;; after the last non-blank line in region. Insert
  11896. ;; drawer's closing, then indent it.
  11897. (goto-char rend)
  11898. (skip-chars-backward " \r\t\n")
  11899. (insert "\n:END:")
  11900. (deactivate-mark t)
  11901. (indent-for-tab-command)
  11902. (unless (eolp) (insert "\n")))
  11903. ;; Clear marker, whatever the outcome of insertion is.
  11904. (set-marker rend nil)))))))
  11905. (defvar org-property-set-functions-alist nil
  11906. "Property set function alist.
  11907. Each entry should have the following format:
  11908. (PROPERTY . READ-FUNCTION)
  11909. The read function will be called with the same argument as
  11910. `org-completing-read'.")
  11911. (defun org-set-property-function (property)
  11912. "Get the function that should be used to set PROPERTY.
  11913. This is computed according to `org-property-set-functions-alist'."
  11914. (or (cdr (assoc property org-property-set-functions-alist))
  11915. 'org-completing-read))
  11916. (defun org-read-property-value (property &optional pom default)
  11917. "Read value for PROPERTY, as a string.
  11918. When optional argument POM is non-nil, completion uses additional
  11919. information, i.e., allowed or existing values at point or marker
  11920. POM.
  11921. Optional argument DEFAULT provides a default value for PROPERTY."
  11922. (let* ((completion-ignore-case t)
  11923. (allowed
  11924. (or (org-property-get-allowed-values nil property 'table)
  11925. (and pom (org-property-get-allowed-values pom property 'table))))
  11926. (current (org-entry-get nil property))
  11927. (prompt (format "%s value%s: "
  11928. property
  11929. (if (org-string-nw-p current)
  11930. (format " [%s]" current)
  11931. "")))
  11932. (set-function (org-set-property-function property)))
  11933. (org-trim
  11934. (if allowed
  11935. (funcall set-function
  11936. prompt allowed nil
  11937. (not (get-text-property 0 'org-unrestricted (caar allowed)))
  11938. default nil default)
  11939. (let ((all (mapcar #'list
  11940. (append (org-property-values property)
  11941. (and pom
  11942. (org-with-point-at pom
  11943. (org-property-values property)))))))
  11944. (funcall set-function prompt all nil nil "" nil current))))))
  11945. (defvar org-last-set-property nil)
  11946. (defvar org-last-set-property-value nil)
  11947. (defun org-read-property-name ()
  11948. "Read a property name."
  11949. (let ((completion-ignore-case t)
  11950. (default-prop (or (and (org-at-property-p)
  11951. (match-string-no-properties 2))
  11952. org-last-set-property)))
  11953. (org-completing-read
  11954. (concat "Property"
  11955. (if default-prop (concat " [" default-prop "]") "")
  11956. ": ")
  11957. (mapcar #'list (org-buffer-property-keys nil t t))
  11958. nil nil nil nil default-prop)))
  11959. (defun org-set-property-and-value (use-last)
  11960. "Allow to set [PROPERTY]: [value] direction from prompt.
  11961. When use-default, don't even ask, just use the last
  11962. \"[PROPERTY]: [value]\" string from the history."
  11963. (interactive "P")
  11964. (let* ((completion-ignore-case t)
  11965. (pv (or (and use-last org-last-set-property-value)
  11966. (org-completing-read
  11967. "Enter a \"[Property]: [value]\" pair: "
  11968. nil nil nil nil nil
  11969. org-last-set-property-value)))
  11970. prop val)
  11971. (when (string-match "^[ \t]*\\([^:]+\\):[ \t]*\\(.*\\)[ \t]*$" pv)
  11972. (setq prop (match-string 1 pv)
  11973. val (match-string 2 pv))
  11974. (org-set-property prop val))))
  11975. (defun org-set-property (property value)
  11976. "In the current entry, set PROPERTY to VALUE.
  11977. When called interactively, this will prompt for a property name, offering
  11978. completion on existing and default properties. And then it will prompt
  11979. for a value, offering completion either on allowed values (via an inherited
  11980. xxx_ALL property) or on existing values in other instances of this property
  11981. in the current file.
  11982. Throw an error when trying to set a property with an invalid name."
  11983. (interactive (list nil nil))
  11984. (let ((property (or property (org-read-property-name))))
  11985. ;; `org-entry-put' also makes the following check, but this one
  11986. ;; avoids polluting `org-last-set-property' and
  11987. ;; `org-last-set-property-value' needlessly.
  11988. (unless (org--valid-property-p property)
  11989. (user-error "Invalid property name: \"%s\"" property))
  11990. (let ((value (or value (org-read-property-value property)))
  11991. (fn (cdr (assoc-string property org-properties-postprocess-alist t))))
  11992. (setq org-last-set-property property)
  11993. (setq org-last-set-property-value (concat property ": " value))
  11994. ;; Possibly postprocess the inserted value:
  11995. (when fn (setq value (funcall fn value)))
  11996. (unless (equal (org-entry-get nil property) value)
  11997. (org-entry-put nil property value)))))
  11998. (defun org-find-property (property &optional value)
  11999. "Find first entry in buffer that sets PROPERTY.
  12000. When optional argument VALUE is non-nil, only consider an entry
  12001. if it contains PROPERTY set to this value. If PROPERTY should be
  12002. explicitly set to nil, use string \"nil\" for VALUE.
  12003. Return position where the entry begins, or nil if there is no
  12004. such entry. If narrowing is in effect, only search the visible
  12005. part of the buffer."
  12006. (save-excursion
  12007. (goto-char (point-min))
  12008. (let ((case-fold-search t)
  12009. (re (org-re-property property nil (not value) value)))
  12010. (catch 'exit
  12011. (while (re-search-forward re nil t)
  12012. (when (if value (org-at-property-p)
  12013. (org-entry-get (point) property nil t))
  12014. (throw 'exit (progn (org-back-to-heading-or-point-min t)
  12015. (point)))))))))
  12016. (defun org-delete-property (property)
  12017. "In the current entry, delete PROPERTY."
  12018. (interactive
  12019. (let* ((completion-ignore-case t)
  12020. (cat (org-entry-get (point) "CATEGORY"))
  12021. (props0 (org-entry-properties nil 'standard))
  12022. (props (if cat props0
  12023. (delete `("CATEGORY" . ,(org-get-category)) props0)))
  12024. (prop (if (< 1 (length props))
  12025. (completing-read "Property: " props nil t)
  12026. (caar props))))
  12027. (list prop)))
  12028. (if (not property)
  12029. (message "No property to delete in this entry")
  12030. (org-entry-delete nil property)
  12031. (message "Property \"%s\" deleted" property)))
  12032. (defun org-delete-property-globally (property)
  12033. "Remove PROPERTY globally, from all entries.
  12034. This function ignores narrowing, if any."
  12035. (interactive
  12036. (let* ((completion-ignore-case t)
  12037. (prop (completing-read
  12038. "Globally remove property: "
  12039. (mapcar #'list (org-buffer-property-keys)))))
  12040. (list prop)))
  12041. (org-with-wide-buffer
  12042. (goto-char (point-min))
  12043. (let ((count 0)
  12044. (re (org-re-property (concat (regexp-quote property) "\\+?") t t)))
  12045. (while (re-search-forward re nil t)
  12046. (when (org-entry-delete (point) property) (cl-incf count)))
  12047. (message "Property \"%s\" removed from %d entries" property count))))
  12048. (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
  12049. (defun org-compute-property-at-point ()
  12050. "Compute the property at point.
  12051. This looks for an enclosing column format, extracts the operator and
  12052. then applies it to the property in the column format's scope."
  12053. (interactive)
  12054. (unless (org-at-property-p)
  12055. (user-error "Not at a property"))
  12056. (let ((prop (match-string-no-properties 2)))
  12057. (org-columns-get-format-and-top-level)
  12058. (unless (nth 3 (assoc-string prop org-columns-current-fmt-compiled t))
  12059. (user-error "No operator defined for property %s" prop))
  12060. (org-columns-compute prop)))
  12061. (defvar org-property-allowed-value-functions nil
  12062. "Hook for functions supplying allowed values for a specific property.
  12063. The functions must take a single argument, the name of the property, and
  12064. return a flat list of allowed values. If \":ETC\" is one of
  12065. the values, this means that these values are intended as defaults for
  12066. completion, but that other values should be allowed too.
  12067. The functions must return nil if they are not responsible for this
  12068. property.")
  12069. (defun org-property-get-allowed-values (pom property &optional table)
  12070. "Get allowed values for the property PROPERTY.
  12071. When TABLE is non-nil, return an alist that can directly be used for
  12072. completion."
  12073. (let (vals)
  12074. (cond
  12075. ((equal property "TODO")
  12076. (setq vals (org-with-point-at pom
  12077. (append org-todo-keywords-1 '("")))))
  12078. ((equal property "PRIORITY")
  12079. (let ((n org-priority-lowest))
  12080. (while (>= n org-priority-highest)
  12081. (push (char-to-string n) vals)
  12082. (setq n (1- n)))))
  12083. ((equal property "CATEGORY"))
  12084. ((member property org-special-properties))
  12085. ((setq vals (run-hook-with-args-until-success
  12086. 'org-property-allowed-value-functions property)))
  12087. (t
  12088. (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
  12089. (when (and vals (string-match "\\S-" vals))
  12090. (setq vals (car (read-from-string (concat "(" vals ")"))))
  12091. (setq vals (mapcar (lambda (x)
  12092. (cond ((stringp x) x)
  12093. ((numberp x) (number-to-string x))
  12094. ((symbolp x) (symbol-name x))
  12095. (t "???")))
  12096. vals)))))
  12097. (when (member ":ETC" vals)
  12098. (setq vals (remove ":ETC" vals))
  12099. (org-add-props (car vals) '(org-unrestricted t)))
  12100. (if table (mapcar 'list vals) vals)))
  12101. (defun org-property-previous-allowed-value (&optional _previous)
  12102. "Switch to the next allowed value for this property."
  12103. (interactive)
  12104. (org-property-next-allowed-value t))
  12105. (defun org-property-next-allowed-value (&optional previous)
  12106. "Switch to the next allowed value for this property."
  12107. (interactive)
  12108. (unless (org-at-property-p)
  12109. (user-error "Not at a property"))
  12110. (let* ((prop (car (save-match-data (org-split-string (match-string 1) ":"))))
  12111. (key (match-string 2))
  12112. (value (match-string 3))
  12113. (allowed (or (org-property-get-allowed-values (point) key)
  12114. (and (member value '("[ ]" "[-]" "[X]"))
  12115. '("[ ]" "[X]"))))
  12116. (heading (save-match-data (nth 4 (org-heading-components))))
  12117. nval)
  12118. (unless allowed
  12119. (user-error "Allowed values for this property have not been defined"))
  12120. (when previous (setq allowed (reverse allowed)))
  12121. (when (member value allowed)
  12122. (setq nval (car (cdr (member value allowed)))))
  12123. (setq nval (or nval (car allowed)))
  12124. (when (equal nval value)
  12125. (user-error "Only one allowed value for this property"))
  12126. (org-at-property-p)
  12127. (replace-match (concat " :" key ": " nval) t t)
  12128. (org-indent-line)
  12129. (beginning-of-line 1)
  12130. (skip-chars-forward " \t")
  12131. (when (equal prop org-effort-property)
  12132. (unless (org-element--cache-active-p)
  12133. (org-refresh-property
  12134. '((effort . identity)
  12135. (effort-minutes . org-duration-to-minutes))
  12136. nval))
  12137. (when (string= org-clock-current-task heading)
  12138. (setq org-clock-effort nval)
  12139. (org-clock-update-mode-line)))
  12140. (run-hook-with-args 'org-property-changed-functions key nval)))
  12141. (defun org-find-olp (path &optional this-buffer)
  12142. "Return a marker pointing to the entry at outline path OLP.
  12143. If anything goes wrong, throw an error, and if you need to do
  12144. something based on this error, you can catch it with
  12145. `condition-case'.
  12146. If THIS-BUFFER is set, the outline path does not contain a file,
  12147. only headings."
  12148. (let* ((file (if this-buffer buffer-file-name (pop path)))
  12149. (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
  12150. (level 1)
  12151. (lmin 1)
  12152. (lmax 1)
  12153. end found flevel)
  12154. (unless buffer (error "File not found :%s" file))
  12155. (with-current-buffer buffer
  12156. (unless (derived-mode-p 'org-mode)
  12157. (error "Buffer %s needs to be in Org mode" buffer))
  12158. (org-with-wide-buffer
  12159. (goto-char (point-min))
  12160. (dolist (heading path)
  12161. (let ((re (format org-complex-heading-regexp-format
  12162. (regexp-quote heading)))
  12163. (cnt 0))
  12164. (while (re-search-forward re end t)
  12165. (setq level (- (match-end 1) (match-beginning 1)))
  12166. (when (and (>= level lmin) (<= level lmax))
  12167. (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
  12168. (when (= cnt 0)
  12169. (error "Heading not found on level %d: %s" lmax heading))
  12170. (when (> cnt 1)
  12171. (error "Heading not unique on level %d: %s" lmax heading))
  12172. (goto-char found)
  12173. (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
  12174. (setq end (save-excursion (org-end-of-subtree t t)))))
  12175. (when (org-at-heading-p)
  12176. (point-marker))))))
  12177. (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
  12178. "Find node HEADING in BUFFER.
  12179. Return a marker to the heading if it was found, or nil if not.
  12180. If POS-ONLY is set, return just the position instead of a marker.
  12181. The heading text must match exact, but it may have a TODO keyword,
  12182. a priority cookie and tags in the standard locations."
  12183. (with-current-buffer (or buffer (current-buffer))
  12184. (org-with-wide-buffer
  12185. (goto-char (point-min))
  12186. (let (case-fold-search)
  12187. (when (re-search-forward
  12188. (format org-complex-heading-regexp-format
  12189. (regexp-quote heading)) nil t)
  12190. (if pos-only
  12191. (match-beginning 0)
  12192. (move-marker (make-marker) (match-beginning 0))))))))
  12193. (defun org-find-exact-heading-in-directory (heading &optional dir)
  12194. "Find Org node headline HEADING in all \".org\" files in directory DIR.
  12195. When the target headline is found, return a marker to this location."
  12196. (let ((files (directory-files (or dir default-directory)
  12197. t "\\`[^.#].*\\.org\\'"))
  12198. visiting m buffer)
  12199. (catch 'found
  12200. (dolist (file files)
  12201. (message "trying %s" file)
  12202. (setq visiting (org-find-base-buffer-visiting file))
  12203. (setq buffer (or visiting (find-file-noselect file)))
  12204. (setq m (org-find-exact-headline-in-buffer
  12205. heading buffer))
  12206. (when (and (not m) (not visiting)) (kill-buffer buffer))
  12207. (and m (throw 'found m))))))
  12208. (defun org-find-entry-with-id (ident)
  12209. "Locate the entry that contains the ID property with exact value IDENT.
  12210. IDENT can be a string, a symbol or a number, this function will search for
  12211. the string representation of it.
  12212. Return the position where this entry starts, or nil if there is no such entry."
  12213. (interactive "sID: ")
  12214. (let ((id (cond
  12215. ((stringp ident) ident)
  12216. ((symbolp ident) (symbol-name ident))
  12217. ((numberp ident) (number-to-string ident))
  12218. (t (error "IDENT %s must be a string, symbol or number" ident)))))
  12219. (org-with-wide-buffer (org-find-property "ID" id))))
  12220. ;;;; Timestamps
  12221. (defvar org-last-changed-timestamp nil)
  12222. (defvar org-last-inserted-timestamp nil
  12223. "The last time stamp inserted with `org-insert-time-stamp'.")
  12224. (defun org-time-stamp (arg &optional inactive)
  12225. "Prompt for a date/time and insert a time stamp.
  12226. If the user specifies a time like HH:MM or if this command is
  12227. called with at least one prefix argument, the time stamp contains
  12228. the date and the time. Otherwise, only the date is included.
  12229. All parts of a date not specified by the user are filled in from
  12230. the timestamp at point, if any, or the current date/time
  12231. otherwise.
  12232. If there is already a timestamp at the cursor, it is replaced.
  12233. With two universal prefix arguments, insert an active timestamp
  12234. with the current time without prompting the user.
  12235. When called from Lisp, the timestamp is inactive if INACTIVE is
  12236. non-nil."
  12237. (interactive "P")
  12238. (let* ((ts (cond
  12239. ((org-at-date-range-p t)
  12240. (match-string (if (< (point) (- (match-beginning 2) 2)) 1 2)))
  12241. ((org-at-timestamp-p 'lax) (match-string 0))))
  12242. ;; Default time is either the timestamp at point or today.
  12243. ;; When entering a range, only the range start is considered.
  12244. (default-time (and ts (org-time-string-to-time ts)))
  12245. (default-input (and ts (org-get-compact-tod ts)))
  12246. (repeater (and ts
  12247. (string-match "\\([.+-]+[0-9]+[hdwmy] ?\\)+" ts)
  12248. (match-string 0 ts)))
  12249. org-time-was-given
  12250. org-end-time-was-given
  12251. (time
  12252. (if (equal arg '(16)) (current-time)
  12253. ;; Preserve `this-command' and `last-command'.
  12254. (let ((this-command this-command)
  12255. (last-command last-command))
  12256. (org-read-date
  12257. arg 'totime nil nil default-time default-input
  12258. inactive)))))
  12259. (cond
  12260. ((and ts
  12261. (memq last-command '(org-time-stamp org-time-stamp-inactive))
  12262. (memq this-command '(org-time-stamp org-time-stamp-inactive)))
  12263. (insert "--")
  12264. (org-insert-time-stamp time (or org-time-was-given arg) inactive))
  12265. (ts
  12266. ;; Make sure we're on a timestamp. When in the middle of a date
  12267. ;; range, move arbitrarily to range end.
  12268. (unless (org-at-timestamp-p 'lax)
  12269. (skip-chars-forward "-")
  12270. (org-at-timestamp-p 'lax))
  12271. (replace-match "")
  12272. (setq org-last-changed-timestamp
  12273. (org-insert-time-stamp
  12274. time (or org-time-was-given arg)
  12275. inactive nil nil (list org-end-time-was-given)))
  12276. (when repeater
  12277. (backward-char)
  12278. (insert " " repeater)
  12279. (setq org-last-changed-timestamp
  12280. (concat (substring org-last-inserted-timestamp 0 -1)
  12281. " " repeater ">")))
  12282. (message "Timestamp updated"))
  12283. ((equal arg '(16)) (org-insert-time-stamp time t inactive))
  12284. (t (org-insert-time-stamp
  12285. time (or org-time-was-given arg) inactive nil nil
  12286. (list org-end-time-was-given))))))
  12287. ;; FIXME: can we use this for something else, like computing time differences?
  12288. (defun org-get-compact-tod (s)
  12289. (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
  12290. (let* ((t1 (match-string 1 s))
  12291. (h1 (string-to-number (match-string 2 s)))
  12292. (m1 (string-to-number (match-string 3 s)))
  12293. (t2 (and (match-end 4) (match-string 5 s)))
  12294. (h2 (and t2 (string-to-number (match-string 6 s))))
  12295. (m2 (and t2 (string-to-number (match-string 7 s))))
  12296. dh dm)
  12297. (if (not t2)
  12298. t1
  12299. (setq dh (- h2 h1) dm (- m2 m1))
  12300. (when (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
  12301. (concat t1 "+" (number-to-string dh)
  12302. (and (/= 0 dm) (format ":%02d" dm)))))))
  12303. (defun org-time-stamp-inactive (&optional arg)
  12304. "Insert an inactive time stamp.
  12305. An inactive time stamp is enclosed in square brackets instead of
  12306. angle brackets. It is inactive in the sense that it does not
  12307. trigger agenda entries. So these are more for recording a
  12308. certain time/date.
  12309. If the user specifies a time like HH:MM or if this command is called with
  12310. at least one prefix argument, the time stamp contains the date and the time.
  12311. Otherwise, only the date is included.
  12312. When called with two universal prefix arguments, insert an inactive time stamp
  12313. with the current time without prompting the user."
  12314. (interactive "P")
  12315. (org-time-stamp arg 'inactive))
  12316. (defvar org-date-ovl (make-overlay 1 1))
  12317. (overlay-put org-date-ovl 'face 'org-date-selected)
  12318. (delete-overlay org-date-ovl)
  12319. (defvar org-ans1) ; dynamically scoped parameter
  12320. (defvar org-ans2) ; dynamically scoped parameter
  12321. (defvar org-plain-time-of-day-regexp) ; defined below
  12322. (defvar org-overriding-default-time nil) ; dynamically scoped
  12323. (defvar org-read-date-overlay nil)
  12324. (defvar org-read-date-history nil)
  12325. (defvar org-read-date-final-answer nil)
  12326. (defvar org-read-date-analyze-futurep nil)
  12327. (defvar org-read-date-analyze-forced-year nil)
  12328. (defvar org-read-date-inactive)
  12329. (defvar org-def)
  12330. (defvar org-defdecode)
  12331. (defvar org-with-time)
  12332. (defvar calendar-setup) ; Dynamically scoped.
  12333. (defun org-read-date (&optional with-time to-time from-string prompt
  12334. default-time default-input inactive)
  12335. "Read a date, possibly a time, and make things smooth for the user.
  12336. The prompt will suggest to enter an ISO date, but you can also enter anything
  12337. which will at least partially be understood by `parse-time-string'.
  12338. Unrecognized parts of the date will default to the current day, month, year,
  12339. hour and minute. If this command is called to replace a timestamp at point,
  12340. or to enter the second timestamp of a range, the default time is taken
  12341. from the existing stamp. Furthermore, the command prefers the future,
  12342. so if you are giving a date where the year is not given, and the day-month
  12343. combination is already past in the current year, it will assume you
  12344. mean next year. For details, see the manual. A few examples:
  12345. 3-2-5 --> 2003-02-05
  12346. feb 15 --> currentyear-02-15
  12347. 2/15 --> currentyear-02-15
  12348. sep 12 9 --> 2009-09-12
  12349. 12:45 --> today 12:45
  12350. 22 sept 0:34 --> currentyear-09-22 0:34
  12351. 12 --> currentyear-currentmonth-12
  12352. Fri --> nearest Friday after today
  12353. -Tue --> last Tuesday
  12354. etc.
  12355. Furthermore you can specify a relative date by giving, as the *first* thing
  12356. in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
  12357. change in days weeks, months, years.
  12358. With a single plus or minus, the date is relative to today. With a double
  12359. plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
  12360. +4d --> four days from today
  12361. +4 --> same as above
  12362. +2w --> two weeks from today
  12363. ++5 --> five days from default date
  12364. The function understands only English month and weekday abbreviations.
  12365. While prompting, a calendar is popped up - you can also select the
  12366. date with the mouse (button 1). The calendar shows a period of three
  12367. months. To scroll it to other months, use the keys `>' and `<'.
  12368. There are many other calendar navigation commands available, see
  12369. Info node `(org) The date/time prompt' for a full list.
  12370. If you don't like the calendar, turn it off with
  12371. (setq org-read-date-popup-calendar nil)
  12372. With optional argument TO-TIME, the date will immediately be converted
  12373. to an internal time.
  12374. With an optional argument WITH-TIME, the prompt will suggest to
  12375. also insert a time. Note that when WITH-TIME is not set, you can
  12376. still enter a time, and this function will inform the calling routine
  12377. about this change. The calling routine may then choose to change the
  12378. format used to insert the time stamp into the buffer to include the time.
  12379. With optional argument FROM-STRING, read from this string instead from
  12380. the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
  12381. the time/date that is used for everything that is not specified by the
  12382. user."
  12383. (require 'parse-time)
  12384. (let* ((org-with-time with-time)
  12385. (org-time-stamp-rounding-minutes
  12386. (if (equal org-with-time '(16))
  12387. '(0 0)
  12388. org-time-stamp-rounding-minutes))
  12389. (ct (org-current-time))
  12390. (org-def (or org-overriding-default-time default-time ct))
  12391. (org-defdecode (decode-time org-def))
  12392. (cur-frame (selected-frame))
  12393. (mouse-autoselect-window nil) ; Don't let the mouse jump
  12394. (calendar-setup
  12395. (and (eq calendar-setup 'calendar-only) 'calendar-only))
  12396. (calendar-move-hook nil)
  12397. (calendar-view-diary-initially-flag nil)
  12398. (calendar-view-holidays-initially-flag nil)
  12399. ans (org-ans0 "") org-ans1 org-ans2 final cal-frame)
  12400. ;; Rationalize `org-def' and `org-defdecode', if required.
  12401. (when (< (nth 2 org-defdecode) org-extend-today-until)
  12402. (setf (nth 2 org-defdecode) -1)
  12403. (setf (nth 1 org-defdecode) 59)
  12404. (setq org-def (org-encode-time org-defdecode))
  12405. (setq org-defdecode (decode-time org-def)))
  12406. (let* ((timestr (format-time-string
  12407. (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d")
  12408. org-def))
  12409. (prompt (concat (if prompt (concat prompt " ") "")
  12410. (format "Date+time [%s]: " timestr))))
  12411. (cond
  12412. (from-string (setq ans from-string))
  12413. (org-read-date-popup-calendar
  12414. (save-excursion
  12415. (save-window-excursion
  12416. (calendar)
  12417. (when (eq calendar-setup 'calendar-only)
  12418. (setq cal-frame
  12419. (window-frame (get-buffer-window "*Calendar*" 'visible)))
  12420. (select-frame cal-frame))
  12421. (org-eval-in-calendar '(setq cursor-type nil) t)
  12422. (unwind-protect
  12423. (progn
  12424. (calendar-forward-day (- (time-to-days org-def)
  12425. (calendar-absolute-from-gregorian
  12426. (calendar-current-date))))
  12427. (org-eval-in-calendar nil t)
  12428. (let* ((old-map (current-local-map))
  12429. (map (copy-keymap calendar-mode-map))
  12430. (minibuffer-local-map
  12431. (copy-keymap org-read-date-minibuffer-local-map)))
  12432. (org-defkey map (kbd "RET") 'org-calendar-select)
  12433. (org-defkey map [mouse-1] 'org-calendar-select-mouse)
  12434. (org-defkey map [mouse-2] 'org-calendar-select-mouse)
  12435. (unwind-protect
  12436. (progn
  12437. (use-local-map map)
  12438. (setq org-read-date-inactive inactive)
  12439. (add-hook 'post-command-hook 'org-read-date-display)
  12440. (setq org-ans0
  12441. (read-string prompt
  12442. default-input
  12443. 'org-read-date-history
  12444. nil))
  12445. ;; org-ans0: from prompt
  12446. ;; org-ans1: from mouse click
  12447. ;; org-ans2: from calendar motion
  12448. (setq ans
  12449. (concat org-ans0 " " (or org-ans1 org-ans2))))
  12450. (remove-hook 'post-command-hook 'org-read-date-display)
  12451. (use-local-map old-map)
  12452. (when org-read-date-overlay
  12453. (delete-overlay org-read-date-overlay)
  12454. (setq org-read-date-overlay nil)))))
  12455. (bury-buffer "*Calendar*")
  12456. (when cal-frame
  12457. (delete-frame cal-frame)
  12458. (select-frame-set-input-focus cur-frame))))))
  12459. (t ; Naked prompt only
  12460. (unwind-protect
  12461. (setq ans (read-string prompt default-input
  12462. 'org-read-date-history timestr))
  12463. (when org-read-date-overlay
  12464. (delete-overlay org-read-date-overlay)
  12465. (setq org-read-date-overlay nil))))))
  12466. (setq final (org-read-date-analyze ans org-def org-defdecode))
  12467. (when org-read-date-analyze-forced-year
  12468. (message "Year was forced into %s"
  12469. (if org-read-date-force-compatible-dates
  12470. "compatible range (1970-2037)"
  12471. "range representable on this machine"))
  12472. (ding))
  12473. (setq final (org-encode-time final))
  12474. (setq org-read-date-final-answer ans)
  12475. (if to-time
  12476. final
  12477. ;; This round-trip gets rid of 34th of August and stuff like that....
  12478. (setq final (decode-time final))
  12479. (if (and (boundp 'org-time-was-given) org-time-was-given)
  12480. (format "%04d-%02d-%02d %02d:%02d"
  12481. (nth 5 final) (nth 4 final) (nth 3 final)
  12482. (nth 2 final) (nth 1 final))
  12483. (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
  12484. (defun org-read-date-display ()
  12485. "Display the current date prompt interpretation in the minibuffer."
  12486. (when org-read-date-display-live
  12487. (when org-read-date-overlay
  12488. (delete-overlay org-read-date-overlay))
  12489. (when (minibufferp (current-buffer))
  12490. (save-excursion
  12491. (end-of-line 1)
  12492. (while (not (equal (buffer-substring
  12493. (max (point-min) (- (point) 4)) (point))
  12494. " "))
  12495. (insert " ")))
  12496. (let* ((ans (concat (buffer-substring (line-beginning-position)
  12497. (point-max))
  12498. " " (or org-ans1 org-ans2)))
  12499. (org-end-time-was-given nil)
  12500. (f (org-read-date-analyze ans org-def org-defdecode))
  12501. (fmts (if org-display-custom-times
  12502. org-time-stamp-custom-formats
  12503. org-time-stamp-formats))
  12504. (fmt (if (or org-with-time
  12505. (and (boundp 'org-time-was-given) org-time-was-given))
  12506. (cdr fmts)
  12507. (car fmts)))
  12508. (txt (format-time-string fmt (org-encode-time f)))
  12509. (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
  12510. (txt (concat "=> " txt)))
  12511. (when (and org-end-time-was-given
  12512. (string-match org-plain-time-of-day-regexp txt))
  12513. (setq txt (concat (substring txt 0 (match-end 0)) "-"
  12514. org-end-time-was-given
  12515. (substring txt (match-end 0)))))
  12516. (when org-read-date-analyze-futurep
  12517. (setq txt (concat txt " (=>F)")))
  12518. (setq org-read-date-overlay
  12519. (make-overlay (1- (line-end-position)) (line-end-position)))
  12520. (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
  12521. (defun org-read-date-analyze (ans def defdecode)
  12522. "Analyze the combined answer of the date prompt."
  12523. ;; FIXME: cleanup and comment
  12524. (let ((org-def def)
  12525. (org-defdecode defdecode)
  12526. (nowdecode (decode-time))
  12527. delta deltan deltaw deltadef year month day
  12528. hour minute second wday pm h2 m2 tl wday1
  12529. iso-year iso-weekday iso-week iso-date futurep kill-year)
  12530. (setq org-read-date-analyze-futurep nil
  12531. org-read-date-analyze-forced-year nil)
  12532. (when (string-match "\\`[ \t]*\\.[ \t]*\\'" ans)
  12533. (setq ans "+0"))
  12534. (when (setq delta (org-read-date-get-relative ans nil org-def))
  12535. (setq ans (replace-match "" t t ans)
  12536. deltan (car delta)
  12537. deltaw (nth 1 delta)
  12538. deltadef (nth 2 delta)))
  12539. ;; Check if there is an iso week date in there. If yes, store the
  12540. ;; info and postpone interpreting it until the rest of the parsing
  12541. ;; is done.
  12542. (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
  12543. (setq iso-year (when (match-end 1)
  12544. (org-small-year-to-year
  12545. (string-to-number (match-string 1 ans))))
  12546. iso-weekday (when (match-end 3)
  12547. (string-to-number (match-string 3 ans)))
  12548. iso-week (string-to-number (match-string 2 ans)))
  12549. (setq ans (replace-match "" t t ans)))
  12550. ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
  12551. (when (string-match
  12552. "^ *\\(\\([0-9]+\\)-\\)?\\([0-1]?[0-9]\\)-\\([0-3]?[0-9]\\)\\([^-0-9]\\|$\\)" ans)
  12553. (setq year (if (match-end 2)
  12554. (string-to-number (match-string 2 ans))
  12555. (progn (setq kill-year t)
  12556. (string-to-number (format-time-string "%Y"))))
  12557. month (string-to-number (match-string 3 ans))
  12558. day (string-to-number (match-string 4 ans)))
  12559. (setq year (org-small-year-to-year year))
  12560. (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
  12561. t nil ans)))
  12562. ;; Help matching dotted european dates
  12563. (when (string-match
  12564. "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\.\\( ?[1-9][0-9]\\{3\\}\\)?" ans)
  12565. (setq year (if (match-end 3) (string-to-number (match-string 3 ans))
  12566. (setq kill-year t)
  12567. (string-to-number (format-time-string "%Y")))
  12568. day (string-to-number (match-string 1 ans))
  12569. month (string-to-number (match-string 2 ans))
  12570. ans (replace-match (format "%04d-%02d-%02d" year month day)
  12571. t nil ans)))
  12572. ;; Help matching american dates, like 5/30 or 5/30/7
  12573. (when (string-match
  12574. "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
  12575. (setq year (if (match-end 4)
  12576. (string-to-number (match-string 4 ans))
  12577. (progn (setq kill-year t)
  12578. (string-to-number (format-time-string "%Y"))))
  12579. month (string-to-number (match-string 1 ans))
  12580. day (string-to-number (match-string 2 ans)))
  12581. (setq year (org-small-year-to-year year))
  12582. (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
  12583. t nil ans)))
  12584. ;; Help matching am/pm times, because `parse-time-string' does not do that.
  12585. ;; If there is a time with am/pm, and *no* time without it, we convert
  12586. ;; so that matching will be successful.
  12587. (cl-loop for i from 1 to 2 do ; twice, for end time as well
  12588. (when (and (not (string-match "\\(\\`\\|[^+]\\)[012]?[0-9]:[0-9][0-9]\\([ \t\n]\\|$\\)" ans))
  12589. (string-match "\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\(am\\|AM\\|pm\\|PM\\)\\>" ans))
  12590. (setq hour (string-to-number (match-string 1 ans))
  12591. minute (if (match-end 3)
  12592. (string-to-number (match-string 3 ans))
  12593. 0)
  12594. pm (equal ?p
  12595. (string-to-char (downcase (match-string 4 ans)))))
  12596. (if (and (= hour 12) (not pm))
  12597. (setq hour 0)
  12598. (when (and pm (< hour 12)) (setq hour (+ 12 hour))))
  12599. (setq ans (replace-match (format "%02d:%02d" hour minute)
  12600. t t ans))))
  12601. ;; Help matching HHhMM times, similarly as for am/pm times.
  12602. (cl-loop for i from 1 to 2 do ; twice, for end time as well
  12603. (when (and (not (string-match "\\(\\`\\|[^+]\\)[012]?[0-9]:[0-9][0-9]\\([ \t\n]\\|$\\)" ans))
  12604. (string-match "\\(?:\\(?1:[012]?[0-9]\\)?h\\(?2:[0-5][0-9]\\)\\)\\|\\(?:\\(?1:[012]?[0-9]\\)h\\(?2:[0-5][0-9]\\)?\\)\\>" ans))
  12605. (setq hour (if (match-end 1)
  12606. (string-to-number (match-string 1 ans))
  12607. 0)
  12608. minute (if (match-end 2)
  12609. (string-to-number (match-string 2 ans))
  12610. 0))
  12611. (setq ans (replace-match (format "%02d:%02d" hour minute)
  12612. t t ans))))
  12613. ;; Check if a time range is given as a duration
  12614. (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
  12615. (setq hour (string-to-number (match-string 1 ans))
  12616. h2 (+ hour (string-to-number (match-string 3 ans)))
  12617. minute (string-to-number (match-string 2 ans))
  12618. m2 (+ minute (if (match-end 5) (string-to-number
  12619. (match-string 5 ans))0)))
  12620. (when (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
  12621. (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
  12622. t t ans)))
  12623. ;; Check if there is a time range
  12624. (when (boundp 'org-end-time-was-given)
  12625. (setq org-time-was-given nil)
  12626. (when (and (string-match org-plain-time-of-day-regexp ans)
  12627. (match-end 8))
  12628. (setq org-end-time-was-given (match-string 8 ans))
  12629. (setq ans (concat (substring ans 0 (match-beginning 7))
  12630. (substring ans (match-end 7))))))
  12631. (setq tl (parse-time-string ans)
  12632. day (or (nth 3 tl) (nth 3 org-defdecode))
  12633. month
  12634. (cond ((nth 4 tl))
  12635. ((not org-read-date-prefer-future) (nth 4 org-defdecode))
  12636. ;; Day was specified. Make sure DAY+MONTH
  12637. ;; combination happens in the future.
  12638. ((nth 3 tl)
  12639. (setq futurep t)
  12640. (if (< day (nth 3 nowdecode)) (1+ (nth 4 nowdecode))
  12641. (nth 4 nowdecode)))
  12642. (t (nth 4 org-defdecode)))
  12643. year
  12644. (cond ((and (not kill-year) (nth 5 tl)))
  12645. ((not org-read-date-prefer-future) (nth 5 org-defdecode))
  12646. ;; Month was guessed in the future and is at least
  12647. ;; equal to NOWDECODE's. Fix year accordingly.
  12648. (futurep
  12649. (if (or (> month (nth 4 nowdecode))
  12650. (>= day (nth 3 nowdecode)))
  12651. (nth 5 nowdecode)
  12652. (1+ (nth 5 nowdecode))))
  12653. ;; Month was specified. Make sure MONTH+YEAR
  12654. ;; combination happens in the future.
  12655. ((nth 4 tl)
  12656. (setq futurep t)
  12657. (cond ((> month (nth 4 nowdecode)) (nth 5 nowdecode))
  12658. ((< month (nth 4 nowdecode)) (1+ (nth 5 nowdecode)))
  12659. ((< day (nth 3 nowdecode)) (1+ (nth 5 nowdecode)))
  12660. (t (nth 5 nowdecode))))
  12661. (t (nth 5 org-defdecode)))
  12662. hour (or (nth 2 tl) (nth 2 org-defdecode))
  12663. minute (or (nth 1 tl) (nth 1 org-defdecode))
  12664. second (or (nth 0 tl) 0)
  12665. wday (nth 6 tl))
  12666. (when (and (eq org-read-date-prefer-future 'time)
  12667. (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
  12668. (equal day (nth 3 nowdecode))
  12669. (equal month (nth 4 nowdecode))
  12670. (equal year (nth 5 nowdecode))
  12671. (nth 2 tl)
  12672. (or (< (nth 2 tl) (nth 2 nowdecode))
  12673. (and (= (nth 2 tl) (nth 2 nowdecode))
  12674. (nth 1 tl)
  12675. (< (nth 1 tl) (nth 1 nowdecode)))))
  12676. (setq day (1+ day)
  12677. futurep t))
  12678. ;; Special date definitions below
  12679. (cond
  12680. (iso-week
  12681. ;; There was an iso week
  12682. (require 'cal-iso)
  12683. (setq futurep nil)
  12684. (setq year (or iso-year year)
  12685. day (or iso-weekday wday 1)
  12686. wday nil ; to make sure that the trigger below does not match
  12687. iso-date (calendar-gregorian-from-absolute
  12688. (calendar-iso-to-absolute
  12689. (list iso-week day year))))
  12690. ; FIXME: Should we also push ISO weeks into the future?
  12691. ; (when (and org-read-date-prefer-future
  12692. ; (not iso-year)
  12693. ; (< (calendar-absolute-from-gregorian iso-date)
  12694. ; (time-to-days nil)))
  12695. ; (setq year (1+ year)
  12696. ; iso-date (calendar-gregorian-from-absolute
  12697. ; (calendar-iso-to-absolute
  12698. ; (list iso-week day year)))))
  12699. (setq month (car iso-date)
  12700. year (nth 2 iso-date)
  12701. day (nth 1 iso-date)))
  12702. (deltan
  12703. (setq futurep nil)
  12704. (unless deltadef
  12705. (let ((now (decode-time)))
  12706. (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
  12707. (cond ((member deltaw '("h" ""))
  12708. (when (boundp 'org-time-was-given)
  12709. (setq org-time-was-given t))
  12710. (setq hour (+ hour deltan)))
  12711. ((member deltaw '("d" "")) (setq day (+ day deltan)))
  12712. ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
  12713. ((equal deltaw "m") (setq month (+ month deltan)))
  12714. ((equal deltaw "y") (setq year (+ year deltan)))))
  12715. ((and wday (not (nth 3 tl)))
  12716. ;; Weekday was given, but no day, so pick that day in the week
  12717. ;; on or after the derived date.
  12718. (setq wday1 (nth 6 (decode-time (org-encode-time 0 0 0 day month year))))
  12719. (unless (equal wday wday1)
  12720. (setq day (+ day (% (- wday wday1 -7) 7))))))
  12721. (when (and (boundp 'org-time-was-given)
  12722. (nth 2 tl))
  12723. (setq org-time-was-given t))
  12724. (when (< year 100) (setq year (+ 2000 year)))
  12725. ;; Check of the date is representable
  12726. (if org-read-date-force-compatible-dates
  12727. (progn
  12728. (when (< year 1970)
  12729. (setq year 1970 org-read-date-analyze-forced-year t))
  12730. (when (> year 2037)
  12731. (setq year 2037 org-read-date-analyze-forced-year t)))
  12732. (condition-case nil
  12733. (ignore (org-encode-time second minute hour day month year))
  12734. (error
  12735. (setq year (nth 5 org-defdecode))
  12736. (setq org-read-date-analyze-forced-year t))))
  12737. (setq org-read-date-analyze-futurep futurep)
  12738. (list second minute hour day month year nil -1 nil)))
  12739. (defvar parse-time-weekdays)
  12740. (defun org-read-date-get-relative (s today default)
  12741. "Check string S for special relative date string.
  12742. TODAY and DEFAULT are internal times, for today and for a default.
  12743. Return shift list (N what def-flag)
  12744. WHAT is \"d\", \"w\", \"m\", or \"y\" for day, week, month, year.
  12745. N is the number of WHATs to shift.
  12746. DEF-FLAG is t when a double ++ or -- indicates shift relative to
  12747. the DEFAULT date rather than TODAY."
  12748. (require 'parse-time)
  12749. (when (and
  12750. ;; Force case-insensitive.
  12751. (let ((case-fold-search t))
  12752. (string-match
  12753. (concat
  12754. "\\`[ \t]*\\([-+]\\{0,2\\}\\)"
  12755. "\\([0-9]+\\)?"
  12756. "\\([hdwmy]\\|\\(" (mapconcat 'car parse-time-weekdays "\\|") "\\)\\)?"
  12757. "\\([ \t]\\|$\\)") s))
  12758. (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
  12759. (let* ((dir (if (> (match-end 1) (match-beginning 1))
  12760. (string-to-char (substring (match-string 1 s) -1))
  12761. ?+))
  12762. (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
  12763. (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
  12764. (what (if (match-end 3) (match-string 3 s) "d"))
  12765. (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
  12766. (date (if rel default today))
  12767. (wday (nth 6 (decode-time date)))
  12768. delta)
  12769. (if wday1
  12770. (progn
  12771. (setq delta (mod (+ 7 (- wday1 wday)) 7))
  12772. (when (= delta 0) (setq delta 7))
  12773. (when (= dir ?-)
  12774. (setq delta (- delta 7))
  12775. (when (= delta 0) (setq delta -7)))
  12776. (when (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
  12777. (list delta "d" rel))
  12778. (list (* n (if (= dir ?-) -1 1)) what rel)))))
  12779. (defun org-order-calendar-date-args (arg1 arg2 arg3)
  12780. "Turn a user-specified date into the internal representation.
  12781. The internal representation needed by the calendar is (month day year).
  12782. This is a wrapper to handle the brain-dead convention in calendar that
  12783. user function argument order change dependent on argument order."
  12784. (pcase calendar-date-style
  12785. (`american (list arg1 arg2 arg3))
  12786. (`european (list arg2 arg1 arg3))
  12787. (`iso (list arg2 arg3 arg1))))
  12788. (defun org-eval-in-calendar (form &optional keepdate)
  12789. "Eval FORM in the calendar window and return to current window.
  12790. Unless KEEPDATE is non-nil, update `org-ans2' to the cursor date."
  12791. (let ((sf (selected-frame))
  12792. (sw (selected-window)))
  12793. (select-window (get-buffer-window "*Calendar*" t))
  12794. (eval form t)
  12795. (when (and (not keepdate) (calendar-cursor-to-date))
  12796. (let* ((date (calendar-cursor-to-date))
  12797. (time (org-encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  12798. (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
  12799. (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
  12800. (select-window sw)
  12801. (select-frame-set-input-focus sf)))
  12802. (defun org-calendar-select ()
  12803. "Return to `org-read-date' with the date currently selected.
  12804. This is used by `org-read-date' in a temporary keymap for the calendar buffer."
  12805. (interactive)
  12806. (when (calendar-cursor-to-date)
  12807. (let* ((date (calendar-cursor-to-date))
  12808. (time (org-encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  12809. (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
  12810. (when (active-minibuffer-window) (exit-minibuffer))))
  12811. (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
  12812. "Insert a date stamp for the date given by the internal TIME.
  12813. See `format-time-string' for the format of TIME.
  12814. WITH-HM means use the stamp format that includes the time of the day.
  12815. INACTIVE means use square brackets instead of angular ones, so that the
  12816. stamp will not contribute to the agenda.
  12817. PRE and POST are optional strings to be inserted before and after the
  12818. stamp.
  12819. The command returns the inserted time stamp."
  12820. (org-fold-core-ignore-modifications
  12821. (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
  12822. stamp)
  12823. (when inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
  12824. (insert-before-markers-and-inherit (or pre ""))
  12825. (when (listp extra)
  12826. (setq extra (car extra))
  12827. (if (and (stringp extra)
  12828. (string-match "\\([0-9]+\\):\\([0-9]+\\)" extra))
  12829. (setq extra (format "-%02d:%02d"
  12830. (string-to-number (match-string 1 extra))
  12831. (string-to-number (match-string 2 extra))))
  12832. (setq extra nil)))
  12833. (when extra
  12834. (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
  12835. (insert-before-markers-and-inherit (setq stamp (format-time-string fmt time)))
  12836. (insert-before-markers-and-inherit (or post ""))
  12837. (setq org-last-inserted-timestamp stamp))))
  12838. (defun org-toggle-time-stamp-overlays ()
  12839. "Toggle the use of custom time stamp formats."
  12840. (interactive)
  12841. (setq org-display-custom-times (not org-display-custom-times))
  12842. (unless org-display-custom-times
  12843. (let ((p (point-min)) (bmp (buffer-modified-p)))
  12844. (while (setq p (next-single-property-change p 'display))
  12845. (when (and (get-text-property p 'display)
  12846. (eq (get-text-property p 'face) 'org-date))
  12847. (remove-text-properties
  12848. p (setq p (next-single-property-change p 'display))
  12849. '(display t))))
  12850. (set-buffer-modified-p bmp)))
  12851. (org-restart-font-lock)
  12852. (setq org-table-may-need-update t)
  12853. (if org-display-custom-times
  12854. (message "Time stamps are overlaid with custom format")
  12855. (message "Time stamp overlays removed")))
  12856. (defun org-display-custom-time (beg end)
  12857. "Overlay modified time stamp format over timestamp between BEG and END."
  12858. (let* ((ts (buffer-substring beg end))
  12859. t1 with-hm tf time str (off 0))
  12860. (save-match-data
  12861. (setq t1 (org-parse-time-string ts t))
  12862. (when (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
  12863. (setq off (- (match-end 0) (match-beginning 0)))))
  12864. (setq end (- end off))
  12865. (setq with-hm (and (nth 1 t1) (nth 2 t1))
  12866. tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
  12867. time (org-fix-decoded-time t1)
  12868. str (org-add-props
  12869. (format-time-string
  12870. (substring tf 1 -1) (org-encode-time time))
  12871. nil 'mouse-face 'highlight))
  12872. (put-text-property beg end 'display str)))
  12873. (defun org-fix-decoded-time (time)
  12874. "Set 0 instead of nil for the first 6 elements of time.
  12875. Don't touch the rest."
  12876. (let ((n 0))
  12877. (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
  12878. (defun org-time-stamp-to-now (timestamp-string &optional seconds)
  12879. "Difference between TIMESTAMP-STRING and now in days.
  12880. If SECONDS is non-nil, return the difference in seconds."
  12881. (let ((fdiff (if seconds #'float-time #'time-to-days)))
  12882. (- (funcall fdiff (org-time-string-to-time timestamp-string))
  12883. (funcall fdiff nil))))
  12884. (defun org-deadline-close-p (timestamp-string &optional ndays)
  12885. "Is the time in TIMESTAMP-STRING close to the current date?"
  12886. (setq ndays (or ndays (org-get-wdays timestamp-string)))
  12887. (and (<= (org-time-stamp-to-now timestamp-string) ndays)
  12888. (not (org-entry-is-done-p))))
  12889. (defun org-get-wdays (ts &optional delay zero-delay)
  12890. "Get the deadline lead time appropriate for timestring TS.
  12891. When DELAY is non-nil, get the delay time for scheduled items
  12892. instead of the deadline lead time. When ZERO-DELAY is non-nil
  12893. and `org-scheduled-delay-days' is 0, enforce 0 as the delay,
  12894. don't try to find the delay cookie in the scheduled timestamp."
  12895. (let ((tv (if delay org-scheduled-delay-days
  12896. org-deadline-warning-days)))
  12897. (cond
  12898. ((or (and delay (< tv 0))
  12899. (and delay zero-delay (<= tv 0))
  12900. (and (not delay) (<= tv 0)))
  12901. ;; Enforce this value no matter what
  12902. (- tv))
  12903. ((string-match "-\\([0-9]+\\)\\([hdwmy]\\)\\(\\'\\|>\\| \\)" ts)
  12904. ;; lead time is specified.
  12905. (floor (* (string-to-number (match-string 1 ts))
  12906. (cdr (assoc (match-string 2 ts)
  12907. '(("d" . 1) ("w" . 7)
  12908. ("m" . 30.4) ("y" . 365.25)
  12909. ("h" . 0.041667)))))))
  12910. ;; go for the default.
  12911. (t tv))))
  12912. (defun org-calendar-select-mouse (ev)
  12913. "Return to `org-read-date' with the date currently selected.
  12914. This is used by `org-read-date' in a temporary keymap for the calendar buffer."
  12915. (interactive "e")
  12916. (mouse-set-point ev)
  12917. (when (calendar-cursor-to-date)
  12918. (let* ((date (calendar-cursor-to-date))
  12919. (time (org-encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  12920. (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
  12921. (when (active-minibuffer-window) (exit-minibuffer))))
  12922. (defun org-check-deadlines (ndays)
  12923. "Check if there are any deadlines due or past due.
  12924. A deadline is considered due if it happens within `org-deadline-warning-days'
  12925. days from today's date. If the deadline appears in an entry marked DONE,
  12926. it is not shown. A numeric prefix argument NDAYS can be used to test that
  12927. many days. If the prefix is a raw `\\[universal-argument]', all deadlines \
  12928. are shown."
  12929. (interactive "P")
  12930. (let* ((org-warn-days
  12931. (cond
  12932. ((equal ndays '(4)) 100000)
  12933. (ndays (prefix-numeric-value ndays))
  12934. (t (abs org-deadline-warning-days))))
  12935. (case-fold-search nil)
  12936. (regexp (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
  12937. (callback
  12938. (lambda () (org-deadline-close-p (match-string 1) org-warn-days))))
  12939. (message "%d deadlines past-due or due within %d days"
  12940. (org-occur regexp nil callback)
  12941. org-warn-days)))
  12942. (defsubst org-re-timestamp (type)
  12943. "Return a regexp for timestamp TYPE.
  12944. Allowed values for TYPE are:
  12945. all: all timestamps
  12946. active: only active timestamps (<...>)
  12947. inactive: only inactive timestamps ([...])
  12948. scheduled: only scheduled timestamps
  12949. deadline: only deadline timestamps
  12950. closed: only closed time-stamps
  12951. When TYPE is nil, fall back on returning a regexp that matches
  12952. both scheduled and deadline timestamps."
  12953. (cl-case type
  12954. (all org-ts-regexp-both)
  12955. (active org-ts-regexp)
  12956. (inactive org-ts-regexp-inactive)
  12957. (scheduled org-scheduled-time-regexp)
  12958. (deadline org-deadline-time-regexp)
  12959. (closed org-closed-time-regexp)
  12960. (otherwise
  12961. (concat "\\<"
  12962. (regexp-opt (list org-deadline-string org-scheduled-string))
  12963. " *<\\([^>]+\\)>"))))
  12964. (defun org-check-before-date (d)
  12965. "Check if there are deadlines or scheduled entries before date D."
  12966. (interactive (list (org-read-date)))
  12967. (let* ((case-fold-search nil)
  12968. (regexp (org-re-timestamp org-ts-type))
  12969. (ts-type org-ts-type)
  12970. (callback
  12971. (lambda ()
  12972. (let ((match (match-string 1)))
  12973. (and (if (memq ts-type '(active inactive all))
  12974. (eq (org-element-type (save-excursion
  12975. (backward-char)
  12976. (org-element-context)))
  12977. 'timestamp)
  12978. (org-at-planning-p))
  12979. (time-less-p
  12980. (org-time-string-to-time match)
  12981. (org-time-string-to-time d)))))))
  12982. (message "%d entries before %s"
  12983. (org-occur regexp nil callback)
  12984. d)))
  12985. (defun org-check-after-date (d)
  12986. "Check if there are deadlines or scheduled entries after date D."
  12987. (interactive (list (org-read-date)))
  12988. (let* ((case-fold-search nil)
  12989. (regexp (org-re-timestamp org-ts-type))
  12990. (ts-type org-ts-type)
  12991. (callback
  12992. (lambda ()
  12993. (let ((match (match-string 1)))
  12994. (and (if (memq ts-type '(active inactive all))
  12995. (eq (org-element-type (save-excursion
  12996. (backward-char)
  12997. (org-element-context)))
  12998. 'timestamp)
  12999. (org-at-planning-p))
  13000. (not (time-less-p
  13001. (org-time-string-to-time match)
  13002. (org-time-string-to-time d))))))))
  13003. (message "%d entries after %s"
  13004. (org-occur regexp nil callback)
  13005. d)))
  13006. (defun org-check-dates-range (start-date end-date)
  13007. "Check for deadlines/scheduled entries between START-DATE and END-DATE."
  13008. (interactive (list (org-read-date nil nil nil "Range starts")
  13009. (org-read-date nil nil nil "Range end")))
  13010. (let ((case-fold-search nil)
  13011. (regexp (org-re-timestamp org-ts-type))
  13012. (callback
  13013. (let ((type org-ts-type))
  13014. (lambda ()
  13015. (let ((match (match-string 1)))
  13016. (and
  13017. (if (memq type '(active inactive all))
  13018. (eq (org-element-type (save-excursion
  13019. (backward-char)
  13020. (org-element-context)))
  13021. 'timestamp)
  13022. (org-at-planning-p))
  13023. (not (time-less-p
  13024. (org-time-string-to-time match)
  13025. (org-time-string-to-time start-date)))
  13026. (time-less-p
  13027. (org-time-string-to-time match)
  13028. (org-time-string-to-time end-date))))))))
  13029. (message "%d entries between %s and %s"
  13030. (org-occur regexp nil callback) start-date end-date)))
  13031. (defun org-evaluate-time-range (&optional to-buffer)
  13032. "Evaluate a time range by computing the difference between start and end.
  13033. Normally the result is just printed in the echo area, but with prefix arg
  13034. TO-BUFFER, the result is inserted just after the date stamp into the buffer.
  13035. If the time range is actually in a table, the result is inserted into the
  13036. next column.
  13037. For time difference computation, a year is assumed to be exactly 365
  13038. days in order to avoid rounding problems."
  13039. (interactive "P")
  13040. (or
  13041. (org-clock-update-time-maybe)
  13042. (save-excursion
  13043. (unless (org-at-date-range-p t)
  13044. (goto-char (line-beginning-position))
  13045. (re-search-forward org-tr-regexp-both (line-end-position) t))
  13046. (unless (org-at-date-range-p t)
  13047. (user-error "Not at a time-stamp range, and none found in current line")))
  13048. (let* ((ts1 (match-string 1))
  13049. (ts2 (match-string 2))
  13050. (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
  13051. (match-end (match-end 0))
  13052. (time1 (org-time-string-to-time ts1))
  13053. (time2 (org-time-string-to-time ts2))
  13054. (diff (abs (float-time (time-subtract time2 time1))))
  13055. (negative (time-less-p time2 time1))
  13056. ;; (ys (floor (* 365 24 60 60)))
  13057. (ds (* 24 60 60))
  13058. (hs (* 60 60))
  13059. (fy "%dy %dd %02d:%02d")
  13060. (fy1 "%dy %dd")
  13061. (fd "%dd %02d:%02d")
  13062. (fd1 "%dd")
  13063. (fh "%02d:%02d")
  13064. y d h m align)
  13065. (if havetime
  13066. (setq ; y (floor diff ys) diff (mod diff ys)
  13067. y 0
  13068. d (floor diff ds) diff (mod diff ds)
  13069. h (floor diff hs) diff (mod diff hs)
  13070. m (floor diff 60))
  13071. (setq ; y (floor diff ys) diff (mod diff ys)
  13072. y 0
  13073. d (round diff ds)
  13074. h 0 m 0))
  13075. (if (not to-buffer)
  13076. (message "%s" (org-make-tdiff-string y d h m))
  13077. (if (org-at-table-p)
  13078. (progn
  13079. (goto-char match-end)
  13080. (setq align t)
  13081. (and (looking-at " *|") (goto-char (match-end 0))))
  13082. (goto-char match-end))
  13083. (when (looking-at
  13084. "\\( *-? *[0-9]+y\\)?\\( *[0-9]+d\\)? *[0-9][0-9]:[0-9][0-9]")
  13085. (replace-match ""))
  13086. (when negative (insert " -"))
  13087. (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
  13088. (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
  13089. (insert " " (format fh h m))))
  13090. (when align (org-table-align))
  13091. (message "Time difference inserted")))))
  13092. (defun org-make-tdiff-string (y d h m)
  13093. (let ((fmt "")
  13094. (l nil))
  13095. (when (> y 0)
  13096. (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " "))
  13097. (push y l))
  13098. (when (> d 0)
  13099. (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " "))
  13100. (push d l))
  13101. (when (> h 0)
  13102. (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " "))
  13103. (push h l))
  13104. (when (> m 0)
  13105. (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " "))
  13106. (push m l))
  13107. (apply 'format fmt (nreverse l))))
  13108. (defun org-time-string-to-time (s)
  13109. "Convert timestamp string S into internal time."
  13110. (org-encode-time (org-parse-time-string s)))
  13111. (defun org-time-string-to-seconds (s)
  13112. "Convert a timestamp string S into a number of seconds."
  13113. (float-time (org-time-string-to-time s)))
  13114. (define-error 'org-diary-sexp-no-match "Unable to match diary sexp")
  13115. (defun org-time-string-to-absolute (s &optional daynr prefer buffer pos)
  13116. "Convert time stamp S to an absolute day number.
  13117. If DAYNR in non-nil, and there is a specifier for a cyclic time
  13118. stamp, get the closest date to DAYNR. If PREFER is
  13119. `past' (respectively `future') return a date past (respectively
  13120. after) or equal to DAYNR.
  13121. POS is the location of time stamp S, as a buffer position in
  13122. BUFFER.
  13123. Diary sexp timestamps are matched against DAYNR, when non-nil.
  13124. If matching fails or DAYNR is nil, `org-diary-sexp-no-match' is
  13125. signaled."
  13126. (cond
  13127. ((string-match "\\`%%\\((.*)\\)" s)
  13128. ;; Sexp timestamp: try to match DAYNR, if available, since we're
  13129. ;; only able to match individual dates. If it fails, raise an
  13130. ;; error.
  13131. (if (and daynr
  13132. (org-diary-sexp-entry
  13133. (match-string 1 s) "" (calendar-gregorian-from-absolute daynr)))
  13134. daynr
  13135. (signal 'org-diary-sexp-no-match (list s))))
  13136. (daynr (org-closest-date s daynr prefer))
  13137. (t (time-to-days
  13138. (condition-case errdata
  13139. (org-time-string-to-time s)
  13140. (error (error "Bad timestamp `%s'%s\nError was: %s"
  13141. s
  13142. (if (not (and buffer pos)) ""
  13143. (format-message " at %d in buffer `%s'" pos buffer))
  13144. (cdr errdata))))))))
  13145. (defun org-days-to-iso-week (days)
  13146. "Return the ISO week number."
  13147. (require 'cal-iso)
  13148. (car (calendar-iso-from-absolute days)))
  13149. (defun org-small-year-to-year (year)
  13150. "Convert 2-digit years into 4-digit years.
  13151. YEAR is expanded into one of the 30 next years, if possible, or
  13152. into a past one. Any year larger than 99 is returned unchanged."
  13153. (if (>= year 100) year
  13154. (let* ((current (string-to-number (format-time-string "%Y")))
  13155. (century (/ current 100))
  13156. (offset (- year (% current 100))))
  13157. (cond ((> offset 30) (+ (* (1- century) 100) year))
  13158. ((> offset -70) (+ (* century 100) year))
  13159. (t (+ (* (1+ century) 100) year))))))
  13160. (defun org-time-from-absolute (d)
  13161. "Return the time corresponding to date D.
  13162. D may be an absolute day number, or a calendar-type list (month day year)."
  13163. (when (numberp d) (setq d (calendar-gregorian-from-absolute d)))
  13164. (org-encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
  13165. (defvar org-agenda-current-date)
  13166. (defun org-calendar-holiday ()
  13167. "List of holidays, for Diary display in Org mode."
  13168. (require 'holidays)
  13169. (let ((hl (calendar-check-holidays org-agenda-current-date)))
  13170. (and hl (mapconcat #'identity hl "; "))))
  13171. (defvar org--diary-sexp-entry-cache (make-hash-table :test #'equal)
  13172. "Hash table holding return values of `org-diary-sexp-entry'.")
  13173. (defun org-diary-sexp-entry (sexp entry d)
  13174. "Process a SEXP diary ENTRY for date D."
  13175. (require 'diary-lib)
  13176. ;; `org-anniversary' and alike expect ENTRY and DATE to be bound
  13177. ;; dynamically.
  13178. (let ((cached (gethash (list sexp entry d) org--diary-sexp-entry-cache 'none)))
  13179. (if (not (eq 'none cached)) cached
  13180. (puthash (list sexp entry d)
  13181. (let* ((sexp `(let ((entry ,entry)
  13182. (date ',d))
  13183. ,(car (read-from-string sexp))))
  13184. ;; FIXME: Do not use (eval ... t) in the following sexp as
  13185. ;; diary vars are still using dynamic scope.
  13186. (result (if calendar-debug-sexp (eval sexp)
  13187. (condition-case nil
  13188. (eval sexp)
  13189. (error
  13190. (beep)
  13191. (message "Bad sexp at line %d in %s: %s"
  13192. (org-current-line)
  13193. (buffer-file-name) sexp)
  13194. (sleep-for 2))))))
  13195. (cond ((stringp result) (split-string result "; "))
  13196. ((and (consp result)
  13197. (not (consp (cdr result)))
  13198. (stringp (cdr result)))
  13199. (cdr result))
  13200. ((and (consp result)
  13201. (stringp (car result)))
  13202. result)
  13203. (result entry)))
  13204. org--diary-sexp-entry-cache))))
  13205. (defun org-diary-to-ical-string (frombuf)
  13206. "Get iCalendar entries from diary entries in buffer FROMBUF.
  13207. This uses the icalendar.el library."
  13208. (let* ((tmpdir temporary-file-directory)
  13209. (tmpfile (make-temp-name
  13210. (expand-file-name "orgics" tmpdir)))
  13211. buf rtn b e)
  13212. (with-current-buffer frombuf
  13213. (icalendar-export-region (point-min) (point-max) tmpfile)
  13214. (setq buf (find-buffer-visiting tmpfile))
  13215. (set-buffer buf)
  13216. (goto-char (point-min))
  13217. (when (re-search-forward "^BEGIN:VEVENT" nil t)
  13218. (setq b (match-beginning 0)))
  13219. (goto-char (point-max))
  13220. (when (re-search-backward "^END:VEVENT" nil t)
  13221. (setq e (match-end 0)))
  13222. (setq rtn (if (and b e) (concat (buffer-substring b e) "\n") "")))
  13223. (kill-buffer buf)
  13224. (delete-file tmpfile)
  13225. rtn))
  13226. (defun org-closest-date (start current prefer)
  13227. "Return closest date to CURRENT starting from START.
  13228. CURRENT and START are both time stamps.
  13229. When PREFER is `past', return a date that is either CURRENT or
  13230. past. When PREFER is `future', return a date that is either
  13231. CURRENT or future.
  13232. Only time stamps with a repeater are modified. Any other time
  13233. stamp stay unchanged. In any case, return value is an absolute
  13234. day number."
  13235. (if (not (string-match "\\+\\([0-9]+\\)\\([hdwmy]\\)" start))
  13236. ;; No repeater. Do not shift time stamp.
  13237. (time-to-days (org-time-string-to-time start))
  13238. (let ((value (string-to-number (match-string 1 start)))
  13239. (type (match-string 2 start)))
  13240. (if (= 0 value)
  13241. ;; Repeater with a 0-value is considered as void.
  13242. (time-to-days (org-time-string-to-time start))
  13243. (let* ((base (org-date-to-gregorian start))
  13244. (target (org-date-to-gregorian current))
  13245. (sday (calendar-absolute-from-gregorian base))
  13246. (cday (calendar-absolute-from-gregorian target))
  13247. n1 n2)
  13248. ;; If START is already past CURRENT, just return START.
  13249. (if (<= cday sday) sday
  13250. ;; Compute closest date before (N1) and closest date past
  13251. ;; (N2) CURRENT.
  13252. (pcase type
  13253. ("h"
  13254. (let ((missing-hours
  13255. (mod (+ (- (* 24 (- cday sday))
  13256. (nth 2 (org-parse-time-string start)))
  13257. org-extend-today-until)
  13258. value)))
  13259. (setf n1 (if (= missing-hours 0) cday
  13260. (- cday (1+ (/ missing-hours 24)))))
  13261. (setf n2 (+ cday (/ (- value missing-hours) 24)))))
  13262. ((or "d" "w")
  13263. (let ((value (if (equal type "w") (* 7 value) value)))
  13264. (setf n1 (+ sday (* value (/ (- cday sday) value))))
  13265. (setf n2 (+ n1 value))))
  13266. ("m"
  13267. (let* ((add-months
  13268. (lambda (d n)
  13269. ;; Add N months to gregorian date D, i.e.,
  13270. ;; a list (MONTH DAY YEAR). Return a valid
  13271. ;; gregorian date.
  13272. (let ((m (+ (nth 0 d) n)))
  13273. (list (mod m 12)
  13274. (nth 1 d)
  13275. (+ (/ m 12) (nth 2 d))))))
  13276. (months ; Complete months to TARGET.
  13277. (* (/ (+ (* 12 (- (nth 2 target) (nth 2 base)))
  13278. (- (nth 0 target) (nth 0 base))
  13279. ;; If START's day is greater than
  13280. ;; TARGET's, remove incomplete month.
  13281. (if (> (nth 1 target) (nth 1 base)) 0 -1))
  13282. value)
  13283. value))
  13284. (before (funcall add-months base months)))
  13285. (setf n1 (calendar-absolute-from-gregorian before))
  13286. (setf n2
  13287. (calendar-absolute-from-gregorian
  13288. (funcall add-months before value)))))
  13289. (_
  13290. (let* ((d (nth 1 base))
  13291. (m (nth 0 base))
  13292. (y (nth 2 base))
  13293. (years ; Complete years to TARGET.
  13294. (* (/ (- (nth 2 target)
  13295. y
  13296. ;; If START's month and day are
  13297. ;; greater than TARGET's, remove
  13298. ;; incomplete year.
  13299. (if (or (> (nth 0 target) m)
  13300. (and (= (nth 0 target) m)
  13301. (> (nth 1 target) d)))
  13302. 0
  13303. 1))
  13304. value)
  13305. value))
  13306. (before (list m d (+ y years))))
  13307. (setf n1 (calendar-absolute-from-gregorian before))
  13308. (setf n2 (calendar-absolute-from-gregorian
  13309. (list m d (+ (nth 2 before) value)))))))
  13310. ;; Handle PREFER parameter, if any.
  13311. (cond
  13312. ((eq prefer 'past) (if (= cday n2) n2 n1))
  13313. ((eq prefer 'future) (if (= cday n1) n1 n2))
  13314. (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))))))))
  13315. (defun org-date-to-gregorian (d)
  13316. "Turn any specification of date D into a Gregorian date for the calendar."
  13317. (cond ((integerp d) (calendar-gregorian-from-absolute d))
  13318. ((and (listp d) (= (length d) 3)) d)
  13319. ((stringp d)
  13320. (let ((d (org-parse-time-string d)))
  13321. (list (nth 4 d) (nth 3 d) (nth 5 d))))
  13322. ((listp d) (list (nth 4 d) (nth 3 d) (nth 5 d)))))
  13323. (defun org-timestamp-up (&optional arg)
  13324. "Increase the date item at the cursor by one.
  13325. If the cursor is on the year, change the year. If it is on the month,
  13326. the day or the time, change that. If the cursor is on the enclosing
  13327. bracket, change the timestamp type.
  13328. With prefix ARG, change by that many units."
  13329. (interactive "p")
  13330. (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
  13331. (defun org-timestamp-down (&optional arg)
  13332. "Decrease the date item at the cursor by one.
  13333. If the cursor is on the year, change the year. If it is on the month,
  13334. the day or the time, change that. If the cursor is on the enclosing
  13335. bracket, change the timestamp type.
  13336. With prefix ARG, change by that many units."
  13337. (interactive "p")
  13338. (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
  13339. (defun org-timestamp-up-day (&optional arg)
  13340. "Increase the date in the time stamp by one day.
  13341. With prefix ARG, change that many days."
  13342. (interactive "p")
  13343. (if (and (not (org-at-timestamp-p 'lax))
  13344. (org-at-heading-p))
  13345. (org-todo 'up)
  13346. (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
  13347. (defun org-timestamp-down-day (&optional arg)
  13348. "Decrease the date in the time stamp by one day.
  13349. With prefix ARG, change that many days."
  13350. (interactive "p")
  13351. (if (and (not (org-at-timestamp-p 'lax))
  13352. (org-at-heading-p))
  13353. (org-todo 'down)
  13354. (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
  13355. (defun org-at-timestamp-p (&optional extended)
  13356. "Non-nil if point is inside a timestamp.
  13357. By default, the function only consider syntactically valid active
  13358. timestamps. However, the caller may have a broader definition
  13359. for timestamps. As a consequence, optional argument EXTENDED can
  13360. be set to the following values
  13361. `inactive'
  13362. Include also syntactically valid inactive timestamps.
  13363. `agenda'
  13364. Include timestamps allowed in Agenda, i.e., those in
  13365. properties drawers, planning lines and clock lines.
  13366. `lax'
  13367. Ignore context. The function matches any part of the
  13368. document looking like a timestamp. This includes comments,
  13369. example blocks...
  13370. For backward-compatibility with Org 9.0, every other non-nil
  13371. value is equivalent to `inactive'.
  13372. When at a timestamp, return the position of the point as a symbol
  13373. among `bracket', `after', `year', `month', `hour', `minute',
  13374. `day' or a number of character from the last know part of the
  13375. time stamp. If diary sexp timestamps, any point inside the timestamp
  13376. is considered `day' (i.e. only `bracket', `day', and `after' return
  13377. values are possible).
  13378. When matching, the match groups are the following:
  13379. group 1: year, if any
  13380. group 2: month, if any
  13381. group 3: day number, if any
  13382. group 4: day name, if any
  13383. group 5: hours, if any
  13384. group 6: minutes, if any"
  13385. (let* ((regexp
  13386. (if extended
  13387. (if (eq extended 'agenda)
  13388. (rx-to-string
  13389. `(or (regexp ,org-ts-regexp3)
  13390. (regexp ,org-element--timestamp-regexp)))
  13391. org-ts-regexp3)
  13392. org-ts-regexp2))
  13393. (pos (point))
  13394. (match?
  13395. (let ((boundaries (org-in-regexp regexp)))
  13396. (save-match-data
  13397. (cond ((null boundaries) nil)
  13398. ((eq extended 'lax) t)
  13399. (t
  13400. (or (and (eq extended 'agenda)
  13401. (or (org-at-planning-p)
  13402. (org-at-property-p)
  13403. (and (bound-and-true-p
  13404. org-agenda-include-inactive-timestamps)
  13405. (org-at-clock-log-p))))
  13406. (eq 'timestamp
  13407. (save-excursion
  13408. (when (= pos (cdr boundaries)) (forward-char -1))
  13409. (org-element-type (org-element-context)))))))))))
  13410. (cond
  13411. ((not match?) nil)
  13412. ((= pos (match-beginning 0)) 'bracket)
  13413. ;; Distinguish location right before the closing bracket from
  13414. ;; right after it.
  13415. ((= pos (1- (match-end 0))) 'bracket)
  13416. ((= pos (match-end 0)) 'after)
  13417. ((org-pos-in-match-range pos 2) 'year)
  13418. ((org-pos-in-match-range pos 3) 'month)
  13419. ((org-pos-in-match-range pos 7) 'hour)
  13420. ((org-pos-in-match-range pos 8) 'minute)
  13421. ((or (org-pos-in-match-range pos 4)
  13422. (org-pos-in-match-range pos 5)) 'day)
  13423. ((and (or (match-end 8) (match-end 5))
  13424. (> pos (or (match-end 8) (match-end 5)))
  13425. (< pos (match-end 0)))
  13426. (- pos (or (match-end 8) (match-end 5))))
  13427. (t 'day))))
  13428. (defun org-toggle-timestamp-type ()
  13429. "Toggle the type (<active> or [inactive]) of a time stamp."
  13430. (interactive)
  13431. (when (org-at-timestamp-p 'lax)
  13432. (let ((beg (match-beginning 0)) (end (match-end 0))
  13433. (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
  13434. (save-excursion
  13435. (goto-char beg)
  13436. (while (re-search-forward "[][<>]" end t)
  13437. (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
  13438. t t)))
  13439. (message "Timestamp is now %sactive"
  13440. (if (equal (char-after beg) ?<) "" "in")))))
  13441. (defun org-at-clock-log-p ()
  13442. "Non-nil if point is on a clock log line."
  13443. (and (org-match-line org-clock-line-re)
  13444. (eq (org-element-type (save-match-data (org-element-at-point))) 'clock)))
  13445. (defvar org-clock-history) ; defined in org-clock.el
  13446. (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
  13447. (defun org-timestamp-change (n &optional what updown suppress-tmp-delay)
  13448. "Change the date in the time stamp at point.
  13449. The date is changed by N times WHAT. WHAT can be `day', `month',
  13450. `year', `hour', or `minute'. If WHAT is not given, the cursor
  13451. position in the timestamp determines what is changed.
  13452. When optional argument UPDOWN is non-nil, minutes are rounded
  13453. according to `org-time-stamp-rounding-minutes'.
  13454. When SUPPRESS-TMP-DELAY is non-nil, suppress delays like
  13455. \"--2d\"."
  13456. (let ((origin (point))
  13457. (timestamp? (org-at-timestamp-p 'lax))
  13458. origin-cat
  13459. with-hm inactive
  13460. (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
  13461. extra rem
  13462. ts time time0 fixnext clrgx)
  13463. (unless timestamp? (user-error "Not at a timestamp"))
  13464. (if (and (not what) (eq timestamp? 'bracket))
  13465. (org-toggle-timestamp-type)
  13466. ;; Point isn't on brackets. Remember the part of the time-stamp
  13467. ;; the point was in. Indeed, size of time-stamps may change,
  13468. ;; but point must be kept in the same category nonetheless.
  13469. (setq origin-cat timestamp?)
  13470. (when (and (not what) (not (eq timestamp? 'day))
  13471. org-display-custom-times
  13472. (get-text-property (point) 'display)
  13473. (not (get-text-property (1- (point)) 'display)))
  13474. (setq timestamp? 'day))
  13475. (setq timestamp? (or what timestamp?)
  13476. inactive (= (char-after (match-beginning 0)) ?\[)
  13477. ts (match-string 0))
  13478. (replace-match "")
  13479. (when (string-match
  13480. "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?-?[-+][0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)*\\)[]>]"
  13481. ts)
  13482. (setq extra (match-string 1 ts))
  13483. (when suppress-tmp-delay
  13484. (setq extra (replace-regexp-in-string " --[0-9]+[hdwmy]" "" extra))))
  13485. (when (string-match "^.\\{10\\}.*?[0-9]+:[0-9][0-9]" ts)
  13486. (setq with-hm t))
  13487. (setq time0 (org-parse-time-string ts))
  13488. (when (and updown
  13489. (eq timestamp? 'minute)
  13490. (not current-prefix-arg))
  13491. ;; This looks like s-up and s-down. Change by one rounding step.
  13492. (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
  13493. (unless (= 0 (setq rem (% (nth 1 time0) dm)))
  13494. (setcar (cdr time0) (+ (nth 1 time0)
  13495. (if (> n 0) (- rem) (- dm rem))))))
  13496. (setq time
  13497. (org-encode-time
  13498. (apply #'list
  13499. (or (car time0) 0)
  13500. (+ (if (eq timestamp? 'minute) n 0) (nth 1 time0))
  13501. (+ (if (eq timestamp? 'hour) n 0) (nth 2 time0))
  13502. (+ (if (eq timestamp? 'day) n 0) (nth 3 time0))
  13503. (+ (if (eq timestamp? 'month) n 0) (nth 4 time0))
  13504. (+ (if (eq timestamp? 'year) n 0) (nth 5 time0))
  13505. (nthcdr 6 time0))))
  13506. (when (and (memq timestamp? '(hour minute))
  13507. extra
  13508. (string-match "-\\([012][0-9]\\):\\([0-5][0-9]\\)" extra))
  13509. (setq extra (org-modify-ts-extra
  13510. extra
  13511. (if (eq timestamp? 'hour) 2 5)
  13512. n dm)))
  13513. (when (integerp timestamp?)
  13514. (setq extra (org-modify-ts-extra extra timestamp? n dm)))
  13515. (when (eq what 'calendar)
  13516. (let ((cal-date (org-get-date-from-calendar)))
  13517. (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
  13518. (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
  13519. (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
  13520. (setcar time0 (or (car time0) 0))
  13521. (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
  13522. (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
  13523. (setq time (org-encode-time time0))))
  13524. ;; Insert the new time-stamp, and ensure point stays in the same
  13525. ;; category as before (i.e. not after the last position in that
  13526. ;; category).
  13527. (let ((pos (point)))
  13528. ;; Stay before inserted string. `save-excursion' is of no use.
  13529. (setq org-last-changed-timestamp
  13530. (org-insert-time-stamp time with-hm inactive nil nil extra))
  13531. (goto-char pos))
  13532. (save-match-data
  13533. (looking-at org-ts-regexp3)
  13534. (goto-char
  13535. (pcase origin-cat
  13536. ;; `day' category ends before `hour' if any, or at the end
  13537. ;; of the day name.
  13538. (`day (min (or (match-beginning 7) (1- (match-end 5))) origin))
  13539. (`hour (min (match-end 7) origin))
  13540. (`minute (min (1- (match-end 8)) origin))
  13541. ((pred integerp) (min (1- (match-end 0)) origin))
  13542. ;; Point was right after the time-stamp. However, the
  13543. ;; time-stamp length might have changed, so refer to
  13544. ;; (match-end 0) instead.
  13545. (`after (match-end 0))
  13546. ;; `year' and `month' have both fixed size: point couldn't
  13547. ;; have moved into another part.
  13548. (_ origin))))
  13549. ;; Update clock if on a CLOCK line.
  13550. (org-clock-update-time-maybe)
  13551. ;; Maybe adjust the closest clock in `org-clock-history'
  13552. (when org-clock-adjust-closest
  13553. (if (not (and (org-at-clock-log-p)
  13554. (< 1 (length (delq nil (mapcar 'marker-position
  13555. org-clock-history))))))
  13556. (message "No clock to adjust")
  13557. (cond ((save-excursion ; fix previous clock?
  13558. (re-search-backward org-ts-regexp0 nil t)
  13559. (looking-back (concat org-clock-string " \\[")
  13560. (line-beginning-position)))
  13561. (setq fixnext 1 clrgx (concat org-ts-regexp0 "\\] =>.*$")))
  13562. ((save-excursion ; fix next clock?
  13563. (re-search-backward org-ts-regexp0 nil t)
  13564. (looking-at (concat org-ts-regexp0 "\\] =>")))
  13565. (setq fixnext -1 clrgx (concat org-clock-string " \\[" org-ts-regexp0))))
  13566. (save-window-excursion
  13567. ;; Find closest clock to point, adjust the previous/next one in history
  13568. (let* ((p (save-excursion (org-back-to-heading t)))
  13569. (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
  13570. (clfixnth
  13571. (+ fixnext (- (length cl) (or (length (member (apply 'min cl) cl)) 100))))
  13572. (clfixpos (unless (> 0 clfixnth) (nth clfixnth org-clock-history))))
  13573. (if (not clfixpos)
  13574. (message "No clock to adjust")
  13575. (save-excursion
  13576. (org-goto-marker-or-bmk clfixpos)
  13577. (org-fold-show-subtree)
  13578. (when (re-search-forward clrgx nil t)
  13579. (goto-char (match-beginning 1))
  13580. (let (org-clock-adjust-closest)
  13581. (org-timestamp-change n timestamp? updown))
  13582. (message "Clock adjusted in %s for heading: %s"
  13583. (file-name-nondirectory (buffer-file-name))
  13584. (org-get-heading t t)))))))))
  13585. ;; Try to recenter the calendar window, if any.
  13586. (when (and org-calendar-follow-timestamp-change
  13587. (get-buffer-window "*Calendar*" t)
  13588. (memq timestamp? '(day month year)))
  13589. (org-recenter-calendar (time-to-days time))))))
  13590. (defun org-modify-ts-extra (s pos n dm)
  13591. "Change the different parts of the lead-time and repeat fields in timestamp."
  13592. (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
  13593. ng h m new rem)
  13594. (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
  13595. (cond
  13596. ((or (org-pos-in-match-range pos 2)
  13597. (org-pos-in-match-range pos 3))
  13598. (setq m (string-to-number (match-string 3 s))
  13599. h (string-to-number (match-string 2 s)))
  13600. (if (org-pos-in-match-range pos 2)
  13601. (setq h (+ h n))
  13602. (setq n (* dm (with-no-warnings (cl-signum n))))
  13603. (unless (= 0 (setq rem (% m dm)))
  13604. (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
  13605. (setq m (+ m n)))
  13606. (when (< m 0) (setq m (+ m 60) h (1- h)))
  13607. (when (> m 59) (setq m (- m 60) h (1+ h)))
  13608. (setq h (mod h 24))
  13609. (setq ng 1 new (format "-%02d:%02d" h m)))
  13610. ((org-pos-in-match-range pos 6)
  13611. (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
  13612. ((org-pos-in-match-range pos 5)
  13613. (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
  13614. ((org-pos-in-match-range pos 9)
  13615. (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
  13616. ((org-pos-in-match-range pos 8)
  13617. (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
  13618. (when ng
  13619. (setq s (concat
  13620. (substring s 0 (match-beginning ng))
  13621. new
  13622. (substring s (match-end ng))))))
  13623. s))
  13624. (defun org-recenter-calendar (d)
  13625. "If the calendar is visible, recenter it to date D."
  13626. (let ((cwin (get-buffer-window "*Calendar*" t)))
  13627. (when cwin
  13628. (let ((calendar-move-hook nil))
  13629. (with-selected-window cwin
  13630. (calendar-goto-date
  13631. (if (listp d) d (calendar-gregorian-from-absolute d))))))))
  13632. (defun org-goto-calendar (&optional arg)
  13633. "Go to the Emacs calendar at the current date.
  13634. If there is a time stamp in the current line, go to that date.
  13635. A prefix ARG can be used to force the current date."
  13636. (interactive "P")
  13637. (let ((calendar-move-hook nil)
  13638. (calendar-view-holidays-initially-flag nil)
  13639. (calendar-view-diary-initially-flag nil)
  13640. diff)
  13641. (when (or (org-at-timestamp-p 'lax)
  13642. (org-match-line (concat ".*" org-ts-regexp)))
  13643. (let ((d1 (time-to-days nil))
  13644. (d2 (time-to-days (org-time-string-to-time (match-string 1)))))
  13645. (setq diff (- d2 d1))))
  13646. (calendar)
  13647. (calendar-goto-today)
  13648. (when (and diff (not arg)) (calendar-forward-day diff))))
  13649. (defun org-get-date-from-calendar ()
  13650. "Return a list (month day year) of date at point in calendar."
  13651. (with-current-buffer "*Calendar*"
  13652. (save-match-data
  13653. (calendar-cursor-to-date))))
  13654. (defun org-date-from-calendar ()
  13655. "Insert time stamp corresponding to cursor date in *Calendar* buffer.
  13656. If there is already a time stamp at the cursor position, update it."
  13657. (interactive)
  13658. (if (org-at-timestamp-p 'lax)
  13659. (org-timestamp-change 0 'calendar)
  13660. (let ((cal-date (org-get-date-from-calendar)))
  13661. (org-insert-time-stamp
  13662. (org-encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
  13663. (defcustom org-image-actual-width t
  13664. "When non-nil, use the actual width of images when inlining them.
  13665. When set to a number, use imagemagick (when available) to set the
  13666. image's width to this value.
  13667. When set to a number in a list, try to get the width from any
  13668. #+ATTR.* keyword if it matches a width specification like
  13669. #+ATTR_HTML: :width 300px
  13670. and fall back on that number if none is found.
  13671. When set to nil, try to get the width from an #+ATTR.* keyword
  13672. and fall back on the original width if none is found.
  13673. When set to any other non-nil value, always use the image width.
  13674. This requires Emacs >= 24.1, built with imagemagick support."
  13675. :group 'org-appearance
  13676. :version "24.4"
  13677. :package-version '(Org . "8.0")
  13678. :type '(choice
  13679. (const :tag "Use the image width" t)
  13680. (integer :tag "Use a number of pixels")
  13681. (list :tag "Use #+ATTR* or a number of pixels" (integer))
  13682. (const :tag "Use #+ATTR* or don't resize" nil)))
  13683. (defcustom org-agenda-inhibit-startup nil
  13684. "Inhibit startup when preparing agenda buffers.
  13685. When this variable is t, the initialization of the Org agenda
  13686. buffers is inhibited: e.g. the visibility state is not set, the
  13687. tables are not re-aligned, etc."
  13688. :type 'boolean
  13689. :version "24.3"
  13690. :group 'org-agenda)
  13691. (defcustom org-agenda-ignore-properties nil
  13692. "Avoid updating text properties when building the agenda.
  13693. Properties are used to prepare buffers for effort estimates,
  13694. appointments, statistics and subtree-local categories.
  13695. If you don't use these in the agenda, you can add them to this
  13696. list and agenda building will be a bit faster.
  13697. The value is a list, with zero or more of the symbols `effort', `appt',
  13698. `stats' or `category'."
  13699. :type '(set :greedy t
  13700. (const effort)
  13701. (const appt)
  13702. (const stats)
  13703. (const category))
  13704. :version "26.1"
  13705. :package-version '(Org . "8.3")
  13706. :group 'org-agenda)
  13707. ;;;; Files
  13708. (defun org-save-all-org-buffers ()
  13709. "Save all Org buffers without user confirmation."
  13710. (interactive)
  13711. (message "Saving all Org buffers...")
  13712. (save-some-buffers t (lambda () (and (derived-mode-p 'org-mode) t)))
  13713. (when (featurep 'org-id) (org-id-locations-save))
  13714. (message "Saving all Org buffers... done"))
  13715. (defun org-revert-all-org-buffers ()
  13716. "Revert all Org buffers.
  13717. Prompt for confirmation when there are unsaved changes.
  13718. Be sure you know what you are doing before letting this function
  13719. overwrite your changes.
  13720. This function is useful in a setup where one tracks Org files
  13721. with a version control system, to revert on one machine after pulling
  13722. changes from another. I believe the procedure must be like this:
  13723. 1. \\[org-save-all-org-buffers]
  13724. 2. Pull changes from the other machine, resolve conflicts
  13725. 3. \\[org-revert-all-org-buffers]"
  13726. (interactive)
  13727. (unless (yes-or-no-p "Revert all Org buffers from their files? ")
  13728. (user-error "Abort"))
  13729. (save-excursion
  13730. (save-window-excursion
  13731. (dolist (b (buffer-list))
  13732. (when (and (with-current-buffer b (derived-mode-p 'org-mode))
  13733. (with-current-buffer b buffer-file-name))
  13734. (pop-to-buffer-same-window b)
  13735. (revert-buffer t 'no-confirm)))
  13736. (when (and (featurep 'org-id) org-id-track-globally)
  13737. (org-id-locations-load)))))
  13738. ;;;; Agenda files
  13739. ;;;###autoload
  13740. (defun org-switchb (&optional arg)
  13741. "Switch between Org buffers.
  13742. With `\\[universal-argument]' prefix, restrict available buffers to files.
  13743. With `\\[universal-argument] \\[universal-argument]' \
  13744. prefix, restrict available buffers to agenda files."
  13745. (interactive "P")
  13746. (let ((blist (org-buffer-list
  13747. (cond ((equal arg '(4)) 'files)
  13748. ((equal arg '(16)) 'agenda)))))
  13749. (pop-to-buffer-same-window
  13750. (completing-read "Org buffer: "
  13751. (mapcar #'list (mapcar #'buffer-name blist))
  13752. nil t))))
  13753. (defun org-agenda-files (&optional unrestricted archives)
  13754. "Get the list of agenda files.
  13755. Optional UNRESTRICTED means return the full list even if a restriction
  13756. is currently in place.
  13757. When ARCHIVES is t, include all archive files that are really being
  13758. used by the agenda files. If ARCHIVE is `ifmode', do this only if
  13759. `org-agenda-archives-mode' is t."
  13760. (let ((files
  13761. (cond
  13762. ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
  13763. ((stringp org-agenda-files) (org-read-agenda-file-list))
  13764. ((listp org-agenda-files) org-agenda-files)
  13765. (t (error "Invalid value of `org-agenda-files'")))))
  13766. (setq files (apply 'append
  13767. (mapcar (lambda (f)
  13768. (if (file-directory-p f)
  13769. (directory-files
  13770. f t org-agenda-file-regexp)
  13771. (list (expand-file-name f org-directory))))
  13772. files)))
  13773. (when org-agenda-skip-unavailable-files
  13774. (setq files (delq nil
  13775. (mapcar (lambda (file)
  13776. (and (file-readable-p file) file))
  13777. files))))
  13778. (when (or (eq archives t)
  13779. (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
  13780. (setq files (org-add-archive-files files)))
  13781. files))
  13782. (defun org-agenda-file-p (&optional file)
  13783. "Return non-nil, if FILE is an agenda file.
  13784. If FILE is omitted, use the file associated with the current
  13785. buffer."
  13786. (let ((fname (or file (buffer-file-name))))
  13787. (and fname
  13788. (member (file-truename fname)
  13789. (mapcar #'file-truename (org-agenda-files t))))))
  13790. (defun org-edit-agenda-file-list ()
  13791. "Edit the list of agenda files.
  13792. Depending on setup, this either uses customize to edit the variable
  13793. `org-agenda-files', or it visits the file that is holding the list. In the
  13794. latter case, the buffer is set up in a way that saving it automatically kills
  13795. the buffer and restores the previous window configuration."
  13796. (interactive)
  13797. (if (stringp org-agenda-files)
  13798. (let ((cw (current-window-configuration)))
  13799. (find-file org-agenda-files)
  13800. (setq-local org-window-configuration cw)
  13801. (add-hook 'after-save-hook
  13802. (lambda ()
  13803. (set-window-configuration
  13804. (prog1 org-window-configuration
  13805. (kill-buffer (current-buffer))))
  13806. (org-install-agenda-files-menu)
  13807. (message "New agenda file list installed"))
  13808. nil 'local)
  13809. (message "%s" (substitute-command-keys
  13810. "Edit list and finish with \\[save-buffer]")))
  13811. (customize-variable 'org-agenda-files)))
  13812. (defun org-store-new-agenda-file-list (list)
  13813. "Set new value for the agenda file list and save it correctly."
  13814. (if (stringp org-agenda-files)
  13815. (let ((fe (org-read-agenda-file-list t)) b u)
  13816. (while (setq b (find-buffer-visiting org-agenda-files))
  13817. (kill-buffer b))
  13818. (with-temp-file org-agenda-files
  13819. (insert
  13820. (mapconcat
  13821. (lambda (f) ;; Keep un-expanded entries.
  13822. (if (setq u (assoc f fe))
  13823. (cdr u)
  13824. f))
  13825. list "\n")
  13826. "\n")))
  13827. (let ((org-mode-hook nil) (org-inhibit-startup t)
  13828. (org-insert-mode-line-in-empty-file nil))
  13829. (setq org-agenda-files list)
  13830. (customize-save-variable 'org-agenda-files org-agenda-files))))
  13831. (defun org-read-agenda-file-list (&optional pair-with-expansion)
  13832. "Read the list of agenda files from a file.
  13833. If PAIR-WITH-EXPANSION is t return pairs with un-expanded
  13834. filenames, used by `org-store-new-agenda-file-list' to write back
  13835. un-expanded file names."
  13836. (when (file-directory-p org-agenda-files)
  13837. (error "`org-agenda-files' cannot be a single directory"))
  13838. (when (stringp org-agenda-files)
  13839. (with-temp-buffer
  13840. (insert-file-contents org-agenda-files)
  13841. (mapcar
  13842. (lambda (f)
  13843. (let ((e (expand-file-name (substitute-in-file-name f)
  13844. org-directory)))
  13845. (if pair-with-expansion
  13846. (cons e f)
  13847. e)))
  13848. (org-split-string (buffer-string) "[ \t\r\n]*?[\r\n][ \t\r\n]*")))))
  13849. ;;;###autoload
  13850. (defun org-cycle-agenda-files ()
  13851. "Cycle through the files in `org-agenda-files'.
  13852. If the current buffer visits an agenda file, find the next one in the list.
  13853. If the current buffer does not, find the first agenda file."
  13854. (interactive)
  13855. (let* ((fs (or (org-agenda-files t)
  13856. (user-error "No agenda files")))
  13857. (files (copy-sequence fs))
  13858. (tcf (and buffer-file-name (file-truename buffer-file-name)))
  13859. file)
  13860. (when tcf
  13861. (while (and (setq file (pop files))
  13862. (not (equal (file-truename file) tcf)))))
  13863. (find-file (car (or files fs)))
  13864. (when (buffer-base-buffer) (pop-to-buffer-same-window (buffer-base-buffer)))))
  13865. (defun org-agenda-file-to-front (&optional to-end)
  13866. "Move/add the current file to the top of the agenda file list.
  13867. If the file is not present in the list, it is added to the front. If it is
  13868. present, it is moved there. With optional argument TO-END, add/move to the
  13869. end of the list."
  13870. (interactive "P")
  13871. (let ((org-agenda-skip-unavailable-files nil)
  13872. (file-alist (mapcar (lambda (x)
  13873. (cons (file-truename x) x))
  13874. (org-agenda-files t)))
  13875. (ctf (file-truename
  13876. (or buffer-file-name
  13877. (user-error "Please save the current buffer to a file"))))
  13878. x had)
  13879. (setq x (assoc ctf file-alist) had x)
  13880. (unless x (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
  13881. (if to-end
  13882. (setq file-alist (append (delq x file-alist) (list x)))
  13883. (setq file-alist (cons x (delq x file-alist))))
  13884. (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
  13885. (org-install-agenda-files-menu)
  13886. (message "File %s to %s of agenda file list"
  13887. (if had "moved" "added") (if to-end "end" "front"))))
  13888. (defun org-remove-file (&optional file)
  13889. "Remove current file from the list of files in variable `org-agenda-files'.
  13890. These are the files which are being checked for agenda entries.
  13891. Optional argument FILE means use this file instead of the current."
  13892. (interactive)
  13893. (let* ((org-agenda-skip-unavailable-files nil)
  13894. (file (or file buffer-file-name
  13895. (user-error "Current buffer does not visit a file")))
  13896. (true-file (file-truename file))
  13897. (afile (abbreviate-file-name file))
  13898. (files (delq nil (mapcar
  13899. (lambda (x)
  13900. (unless (equal true-file
  13901. (file-truename x))
  13902. x))
  13903. (org-agenda-files t)))))
  13904. (if (not (= (length files) (length (org-agenda-files t))))
  13905. (progn
  13906. (org-store-new-agenda-file-list files)
  13907. (org-install-agenda-files-menu)
  13908. (message "Removed from Org Agenda list: %s" afile))
  13909. (message "File was not in list: %s (not removed)" afile))))
  13910. (defun org-file-menu-entry (file)
  13911. (vector file (list 'find-file file) t))
  13912. (defun org-check-agenda-file (file)
  13913. "Make sure FILE exists. If not, ask user what to do."
  13914. (unless (file-exists-p file)
  13915. (message "Non-existent agenda file %s. [R]emove from list or [A]bort?"
  13916. (abbreviate-file-name file))
  13917. (let ((r (downcase (read-char-exclusive))))
  13918. (cond
  13919. ((equal r ?r)
  13920. (org-remove-file file)
  13921. (throw 'nextfile t))
  13922. (t (user-error "Abort"))))))
  13923. (defun org-get-agenda-file-buffer (file)
  13924. "Get an agenda buffer visiting FILE.
  13925. If the buffer needs to be created, add it to the list of buffers
  13926. which might be released later."
  13927. (let ((buf (org-find-base-buffer-visiting file)))
  13928. (if buf
  13929. buf ; just return it
  13930. ;; Make a new buffer and remember it
  13931. (setq buf (find-file-noselect file))
  13932. (when buf (push buf org-agenda-new-buffers))
  13933. buf)))
  13934. (defun org-release-buffers (blist)
  13935. "Release all buffers in list, asking the user for confirmation when needed.
  13936. When a buffer is unmodified, it is just killed. When modified, it is saved
  13937. \(if the user agrees) and then killed."
  13938. (let (file)
  13939. (dolist (buf blist)
  13940. (setq file (buffer-file-name buf))
  13941. (when (and (buffer-modified-p buf)
  13942. file
  13943. (y-or-n-p (format "Save file %s? " file)))
  13944. (with-current-buffer buf (save-buffer)))
  13945. (kill-buffer buf))))
  13946. (defun org-agenda-prepare-buffers (files)
  13947. "Create buffers for all agenda files, protect archived trees and comments."
  13948. (interactive)
  13949. (let ((inhibit-read-only t)
  13950. (org-inhibit-startup org-agenda-inhibit-startup)
  13951. ;; Do not refresh list of agenda files in the menu when
  13952. ;; opening every new file.
  13953. (org-agenda-file-menu-enabled nil))
  13954. (setq org-tag-alist-for-agenda nil
  13955. org-tag-groups-alist-for-agenda nil)
  13956. (dolist (file files)
  13957. (catch 'nextfile
  13958. (with-current-buffer
  13959. (if (bufferp file)
  13960. file
  13961. (org-check-agenda-file file)
  13962. (org-get-agenda-file-buffer file))
  13963. (org-with-wide-buffer
  13964. (org-set-regexps-and-options 'tags-only)
  13965. (or (memq 'category org-agenda-ignore-properties)
  13966. (org-refresh-category-properties))
  13967. (or (memq 'stats org-agenda-ignore-properties)
  13968. (org-refresh-stats-properties))
  13969. (or (memq 'effort org-agenda-ignore-properties)
  13970. (unless org-element-use-cache
  13971. (org-refresh-effort-properties)))
  13972. (or (memq 'appt org-agenda-ignore-properties)
  13973. (org-refresh-properties "APPT_WARNTIME" 'org-appt-warntime))
  13974. (dolist (el org-todo-keywords-1)
  13975. (unless (member el org-todo-keywords-for-agenda)
  13976. (push el org-todo-keywords-for-agenda)))
  13977. (dolist (el org-done-keywords)
  13978. (unless (member el org-done-keywords-for-agenda)
  13979. (push el org-done-keywords-for-agenda)))
  13980. (setq org-todo-keyword-alist-for-agenda
  13981. (org--tag-add-to-alist
  13982. org-todo-key-alist
  13983. org-todo-keyword-alist-for-agenda))
  13984. (setq org-tag-alist-for-agenda
  13985. (org--tag-add-to-alist
  13986. org-current-tag-alist
  13987. org-tag-alist-for-agenda))
  13988. ;; Merge current file's tag groups into global
  13989. ;; `org-tag-groups-alist-for-agenda'.
  13990. (when org-group-tags
  13991. (dolist (alist org-tag-groups-alist)
  13992. (let ((old (assoc (car alist) org-tag-groups-alist-for-agenda)))
  13993. (if old
  13994. (setcdr old (org-uniquify (append (cdr old) (cdr alist))))
  13995. (push alist org-tag-groups-alist-for-agenda)))))))))
  13996. ;; Refresh the menu once after loading all the agenda buffers.
  13997. (when org-agenda-file-menu-enabled
  13998. (org-install-agenda-files-menu))))
  13999. ;;;; CDLaTeX minor mode
  14000. (defvar org-cdlatex-mode-map (make-sparse-keymap)
  14001. "Keymap for the minor `org-cdlatex-mode'.")
  14002. (org-defkey org-cdlatex-mode-map (kbd "_") #'org-cdlatex-underscore-caret)
  14003. (org-defkey org-cdlatex-mode-map (kbd "^") #'org-cdlatex-underscore-caret)
  14004. (org-defkey org-cdlatex-mode-map (kbd "`") #'cdlatex-math-symbol)
  14005. (org-defkey org-cdlatex-mode-map (kbd "'") #'org-cdlatex-math-modify)
  14006. (org-defkey org-cdlatex-mode-map (kbd "C-c {") #'org-cdlatex-environment-indent)
  14007. (defvar org-cdlatex-texmathp-advice-is-done nil
  14008. "Flag remembering if we have applied the advice to texmathp already.")
  14009. (define-minor-mode org-cdlatex-mode
  14010. "Toggle the minor `org-cdlatex-mode'.
  14011. This mode supports entering LaTeX environment and math in LaTeX fragments
  14012. in Org mode.
  14013. \\{org-cdlatex-mode-map}"
  14014. :lighter " OCDL"
  14015. (when org-cdlatex-mode
  14016. (require 'cdlatex)
  14017. (run-hooks 'cdlatex-mode-hook)
  14018. (cdlatex-compute-tables))
  14019. (unless org-cdlatex-texmathp-advice-is-done
  14020. (setq org-cdlatex-texmathp-advice-is-done t)
  14021. (advice-add 'texmathp :around #'org--math-always-on)))
  14022. (defun org--math-always-on (orig-fun &rest args)
  14023. "Always return t in Org buffers.
  14024. This is because we want to insert math symbols without dollars even outside
  14025. the LaTeX math segments. If Org mode thinks that point is actually inside
  14026. an embedded LaTeX fragment, let `texmathp' do its job.
  14027. `\\[org-cdlatex-mode-map]'"
  14028. (interactive)
  14029. (cond
  14030. ((not (derived-mode-p 'org-mode)) (apply orig-fun args))
  14031. ((eq this-command 'cdlatex-math-symbol)
  14032. (setq texmathp-why '("cdlatex-math-symbol in org-mode" . 0))
  14033. t)
  14034. (t
  14035. (let ((p (org-inside-LaTeX-fragment-p)))
  14036. (when p ;; FIXME: Shouldn't we return t when `p' is nil?
  14037. (if (member (car p)
  14038. (plist-get org-format-latex-options :matchers))
  14039. (progn
  14040. (setq texmathp-why '("Org mode embedded math" . 0))
  14041. t)
  14042. (apply orig-fun args)))))))
  14043. (defun turn-on-org-cdlatex ()
  14044. "Unconditionally turn on `org-cdlatex-mode'."
  14045. (org-cdlatex-mode 1))
  14046. (defun org-try-cdlatex-tab ()
  14047. "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
  14048. It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
  14049. - inside a LaTeX fragment, or
  14050. - after the first word in a line, where an abbreviation expansion could
  14051. insert a LaTeX environment."
  14052. (when org-cdlatex-mode
  14053. (cond
  14054. ;; Before any word on the line: No expansion possible.
  14055. ((save-excursion (skip-chars-backward " \t") (bolp)) nil)
  14056. ;; Just after first word on the line: Expand it. Make sure it
  14057. ;; cannot happen on headlines, though.
  14058. ((save-excursion
  14059. (skip-chars-backward "a-zA-Z0-9*")
  14060. (skip-chars-backward " \t")
  14061. (and (bolp) (not (org-at-heading-p))))
  14062. (cdlatex-tab) t)
  14063. ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
  14064. (defun org-cdlatex-underscore-caret (&optional _arg)
  14065. "Execute `cdlatex-sub-superscript' in LaTeX fragments.
  14066. Revert to the normal definition outside of these fragments."
  14067. (interactive "P")
  14068. (if (org-inside-LaTeX-fragment-p)
  14069. (call-interactively 'cdlatex-sub-superscript)
  14070. (let (org-cdlatex-mode)
  14071. (call-interactively (key-binding (vector last-input-event))))))
  14072. (defun org-cdlatex-math-modify (&optional _arg)
  14073. "Execute `cdlatex-math-modify' in LaTeX fragments.
  14074. Revert to the normal definition outside of these fragments."
  14075. (interactive "P")
  14076. (if (org-inside-LaTeX-fragment-p)
  14077. (call-interactively 'cdlatex-math-modify)
  14078. (let (org-cdlatex-mode)
  14079. (call-interactively (key-binding (vector last-input-event))))))
  14080. (defun org-cdlatex-environment-indent (&optional environment item)
  14081. "Execute `cdlatex-environment' and indent the inserted environment.
  14082. ENVIRONMENT and ITEM are passed to `cdlatex-environment'.
  14083. The inserted environment is indented to current indentation
  14084. unless point is at the beginning of the line, in which the
  14085. environment remains unintended."
  14086. (interactive)
  14087. ;; cdlatex-environment always return nil. Therefore, capture output
  14088. ;; first and determine if an environment was selected.
  14089. (let* ((beg (point-marker))
  14090. (end (copy-marker (point) t))
  14091. (inserted (progn
  14092. (ignore-errors (cdlatex-environment environment item))
  14093. (< beg end)))
  14094. ;; Figure out how many lines to move forward after the
  14095. ;; environment has been inserted.
  14096. (lines (when inserted
  14097. (save-excursion
  14098. (- (cl-loop while (< beg (point))
  14099. with x = 0
  14100. do (forward-line -1)
  14101. (cl-incf x)
  14102. finally return x)
  14103. (if (progn (goto-char beg)
  14104. (and (progn (skip-chars-forward " \t") (eolp))
  14105. (progn (skip-chars-backward " \t") (bolp))))
  14106. 1 0)))))
  14107. (env (org-trim (delete-and-extract-region beg end))))
  14108. (when inserted
  14109. ;; Get indentation of next line unless at column 0.
  14110. (let ((ind (if (bolp) 0
  14111. (save-excursion
  14112. (org-return t)
  14113. (prog1 (current-indentation)
  14114. (when (progn (skip-chars-forward " \t") (eolp))
  14115. (delete-region beg (point)))))))
  14116. (bol (progn (skip-chars-backward " \t") (bolp))))
  14117. ;; Insert a newline before environment unless at column zero
  14118. ;; to "escape" the current line. Insert a newline if
  14119. ;; something is one the same line as \end{ENVIRONMENT}.
  14120. (insert
  14121. (concat (unless bol "\n") env
  14122. (when (and (skip-chars-forward " \t") (not (eolp))) "\n")))
  14123. (unless (zerop ind)
  14124. (save-excursion
  14125. (goto-char beg)
  14126. (while (< (point) end)
  14127. (unless (eolp) (indent-line-to ind))
  14128. (forward-line))))
  14129. (goto-char beg)
  14130. (forward-line lines)
  14131. (indent-line-to ind)))
  14132. (set-marker beg nil)
  14133. (set-marker end nil)))
  14134. ;;;; LaTeX fragments
  14135. (defun org-inside-LaTeX-fragment-p ()
  14136. "Test if point is inside a LaTeX fragment.
  14137. I.e. after a \\begin, \\(, \\[, $, or $$, without the corresponding closing
  14138. sequence appearing also before point.
  14139. Even though the matchers for math are configurable, this function assumes
  14140. that \\begin, \\(, \\[, and $$ are always used. Only the single dollar
  14141. delimiters are skipped when they have been removed by customization.
  14142. The return value is nil, or a cons cell with the delimiter and the
  14143. position of this delimiter.
  14144. This function does a reasonably good job, but can locally be fooled by
  14145. for example currency specifications. For example it will assume being in
  14146. inline math after \"$22.34\". The LaTeX fragment formatter will only format
  14147. fragments that are properly closed, but during editing, we have to live
  14148. with the uncertainty caused by missing closing delimiters. This function
  14149. looks only before point, not after."
  14150. (catch 'exit
  14151. (let ((pos (point))
  14152. (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
  14153. (lim (progn
  14154. (re-search-backward (concat "^\\(" paragraph-start "\\)") nil
  14155. 'move)
  14156. (point)))
  14157. dd-on str (start 0) m re)
  14158. (goto-char pos)
  14159. (when dodollar
  14160. (setq str (concat (buffer-substring lim (point)) "\000 X$.")
  14161. re (nth 1 (assoc "$" org-latex-regexps)))
  14162. (while (string-match re str start)
  14163. (cond
  14164. ((= (match-end 0) (length str))
  14165. (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
  14166. ((= (match-end 0) (- (length str) 5))
  14167. (throw 'exit nil))
  14168. (t (setq start (match-end 0))))))
  14169. (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
  14170. (goto-char pos)
  14171. (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
  14172. (and (match-beginning 2) (throw 'exit nil))
  14173. ;; count $$
  14174. (while (re-search-backward "\\$\\$" lim t)
  14175. (setq dd-on (not dd-on)))
  14176. (goto-char pos)
  14177. (when dd-on (cons "$$" m))))))
  14178. (defun org-inside-latex-macro-p ()
  14179. "Is point inside a LaTeX macro or its arguments?"
  14180. (save-match-data
  14181. (org-in-regexp
  14182. "\\\\[a-zA-Z]+\\*?\\(\\(\\[[^][\n{}]*\\]\\)\\|\\({[^{}\n]*}\\)\\)*")))
  14183. (defun org--make-preview-overlay (beg end image &optional imagetype)
  14184. "Build an overlay between BEG and END using IMAGE file.
  14185. Argument IMAGETYPE is the extension of the displayed image,
  14186. as a string. It defaults to \"png\"."
  14187. (let ((ov (make-overlay beg end))
  14188. (imagetype (or (intern imagetype) 'png)))
  14189. (overlay-put ov 'org-overlay-type 'org-latex-overlay)
  14190. (overlay-put ov 'evaporate t)
  14191. (overlay-put ov
  14192. 'modification-hooks
  14193. (list (lambda (o _flag _beg _end &optional _l)
  14194. (delete-overlay o))))
  14195. (overlay-put ov
  14196. 'display
  14197. (list 'image :type imagetype :file image :ascent 'center))))
  14198. (defun org-clear-latex-preview (&optional beg end)
  14199. "Remove all overlays with LaTeX fragment images in current buffer.
  14200. When optional arguments BEG and END are non-nil, remove all
  14201. overlays between them instead. Return a non-nil value when some
  14202. overlays were removed, nil otherwise."
  14203. (let ((overlays
  14204. (cl-remove-if-not
  14205. (lambda (o) (eq (overlay-get o 'org-overlay-type) 'org-latex-overlay))
  14206. (overlays-in (or beg (point-min)) (or end (point-max))))))
  14207. (mapc #'delete-overlay overlays)
  14208. overlays))
  14209. (defun org--latex-preview-region (beg end)
  14210. "Preview LaTeX fragments between BEG and END.
  14211. BEG and END are buffer positions."
  14212. (let ((file (buffer-file-name (buffer-base-buffer))))
  14213. (save-excursion
  14214. (org-format-latex
  14215. (concat org-preview-latex-image-directory "org-ltximg")
  14216. beg end
  14217. ;; Emacs cannot overlay images from remote hosts. Create it in
  14218. ;; `temporary-file-directory' instead.
  14219. (if (or (not file) (file-remote-p file))
  14220. temporary-file-directory
  14221. default-directory)
  14222. 'overlays nil 'forbuffer org-preview-latex-default-process))))
  14223. (defun org-latex-preview (&optional arg)
  14224. "Toggle preview of the LaTeX fragment at point.
  14225. If the cursor is on a LaTeX fragment, create the image and
  14226. overlay it over the source code, if there is none. Remove it
  14227. otherwise. If there is no fragment at point, display images for
  14228. all fragments in the current section. With an active region,
  14229. display images for all fragments in the region.
  14230. With a `\\[universal-argument]' prefix argument ARG, clear images \
  14231. for all fragments
  14232. in the current section.
  14233. With a `\\[universal-argument] \\[universal-argument]' prefix \
  14234. argument ARG, display image for all
  14235. fragments in the buffer.
  14236. With a `\\[universal-argument] \\[universal-argument] \
  14237. \\[universal-argument]' prefix argument ARG, clear image for all
  14238. fragments in the buffer."
  14239. (interactive "P")
  14240. (cond
  14241. ((not (display-graphic-p)) nil)
  14242. ;; Clear whole buffer.
  14243. ((equal arg '(64))
  14244. (org-clear-latex-preview (point-min) (point-max))
  14245. (message "LaTeX previews removed from buffer"))
  14246. ;; Preview whole buffer.
  14247. ((equal arg '(16))
  14248. (message "Creating LaTeX previews in buffer...")
  14249. (org--latex-preview-region (point-min) (point-max))
  14250. (message "Creating LaTeX previews in buffer... done."))
  14251. ;; Clear current section.
  14252. ((equal arg '(4))
  14253. (org-clear-latex-preview
  14254. (if (use-region-p)
  14255. (region-beginning)
  14256. (if (org-before-first-heading-p) (point-min)
  14257. (save-excursion
  14258. (org-with-limited-levels (org-back-to-heading t) (point)))))
  14259. (if (use-region-p)
  14260. (region-end)
  14261. (org-with-limited-levels (org-entry-end-position)))))
  14262. ((use-region-p)
  14263. (message "Creating LaTeX previews in region...")
  14264. (org--latex-preview-region (region-beginning) (region-end))
  14265. (message "Creating LaTeX previews in region... done."))
  14266. ;; Toggle preview on LaTeX code at point.
  14267. ((let ((datum (org-element-context)))
  14268. (and (memq (org-element-type datum) '(latex-environment latex-fragment))
  14269. (let ((beg (org-element-property :begin datum))
  14270. (end (org-element-property :end datum)))
  14271. (if (org-clear-latex-preview beg end)
  14272. (message "LaTeX preview removed")
  14273. (message "Creating LaTeX preview...")
  14274. (org--latex-preview-region beg end)
  14275. (message "Creating LaTeX preview... done."))
  14276. t))))
  14277. ;; Preview current section.
  14278. (t
  14279. (let ((beg (if (org-before-first-heading-p) (point-min)
  14280. (save-excursion
  14281. (org-with-limited-levels (org-back-to-heading t) (point)))))
  14282. (end (org-with-limited-levels (org-entry-end-position))))
  14283. (message "Creating LaTeX previews in section...")
  14284. (org--latex-preview-region beg end)
  14285. (message "Creating LaTeX previews in section... done.")))))
  14286. (defun org-format-latex
  14287. (prefix &optional beg end dir overlays msg forbuffer processing-type)
  14288. "Replace LaTeX fragments with links to an image.
  14289. The function takes care of creating the replacement image.
  14290. Only consider fragments between BEG and END when those are
  14291. provided.
  14292. When optional argument OVERLAYS is non-nil, display the image on
  14293. top of the fragment instead of replacing it.
  14294. PROCESSING-TYPE is the conversion method to use, as a symbol.
  14295. Some of the options can be changed using the variable
  14296. `org-format-latex-options', which see."
  14297. (when (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
  14298. (unless (eq processing-type 'verbatim)
  14299. (let* ((math-regexp "\\$\\|\\\\[([]\\|^[ \t]*\\\\begin{[A-Za-z0-9*]+}")
  14300. (cnt 0)
  14301. checkdir-flag)
  14302. (goto-char (or beg (point-min)))
  14303. ;; Optimize overlay creation: (info "(elisp) Managing Overlays").
  14304. (when (and overlays (memq processing-type '(dvipng imagemagick)))
  14305. (overlay-recenter (or end (point-max))))
  14306. (while (re-search-forward math-regexp end t)
  14307. (unless (and overlays
  14308. (eq (get-char-property (point) 'org-overlay-type)
  14309. 'org-latex-overlay))
  14310. (let* ((context (org-element-context))
  14311. (type (org-element-type context)))
  14312. (when (memq type '(latex-environment latex-fragment))
  14313. (let ((block-type (eq type 'latex-environment))
  14314. (value (org-element-property :value context))
  14315. (beg (org-element-property :begin context))
  14316. (end (save-excursion
  14317. (goto-char (org-element-property :end context))
  14318. (skip-chars-backward " \r\t\n")
  14319. (point))))
  14320. (cond
  14321. ((eq processing-type 'mathjax)
  14322. ;; Prepare for MathJax processing.
  14323. (if (not (string-match "\\`\\$\\$?" value))
  14324. (goto-char end)
  14325. (delete-region beg end)
  14326. (if (string= (match-string 0 value) "$$")
  14327. (insert "\\[" (substring value 2 -2) "\\]")
  14328. (insert "\\(" (substring value 1 -1) "\\)"))))
  14329. ((eq processing-type 'html)
  14330. (goto-char beg)
  14331. (delete-region beg end)
  14332. (insert (org-format-latex-as-html value)))
  14333. ((assq processing-type org-preview-latex-process-alist)
  14334. ;; Process to an image.
  14335. (cl-incf cnt)
  14336. (goto-char beg)
  14337. (let* ((processing-info
  14338. (cdr (assq processing-type org-preview-latex-process-alist)))
  14339. (face (face-at-point))
  14340. ;; Get the colors from the face at point.
  14341. (fg
  14342. (let ((color (plist-get org-format-latex-options
  14343. :foreground)))
  14344. (if forbuffer
  14345. (cond
  14346. ((eq color 'auto)
  14347. (face-attribute face :foreground nil 'default))
  14348. ((eq color 'default)
  14349. (face-attribute 'default :foreground nil))
  14350. (t color))
  14351. color)))
  14352. (bg
  14353. (let ((color (plist-get org-format-latex-options
  14354. :background)))
  14355. (if forbuffer
  14356. (cond
  14357. ((eq color 'auto)
  14358. (face-attribute face :background nil 'default))
  14359. ((eq color 'default)
  14360. (face-attribute 'default :background nil))
  14361. (t color))
  14362. color)))
  14363. (hash (sha1 (prin1-to-string
  14364. (list org-format-latex-header
  14365. org-latex-default-packages-alist
  14366. org-latex-packages-alist
  14367. org-format-latex-options
  14368. forbuffer value fg bg))))
  14369. (imagetype (or (plist-get processing-info :image-output-type) "png"))
  14370. (absprefix (expand-file-name prefix dir))
  14371. (linkfile (format "%s_%s.%s" prefix hash imagetype))
  14372. (movefile (format "%s_%s.%s" absprefix hash imagetype))
  14373. (sep (and block-type "\n\n"))
  14374. (link (concat sep "[[file:" linkfile "]]" sep))
  14375. (options
  14376. (org-combine-plists
  14377. org-format-latex-options
  14378. `(:foreground ,fg :background ,bg))))
  14379. (when msg (message msg cnt))
  14380. (unless checkdir-flag ; Ensure the directory exists.
  14381. (setq checkdir-flag t)
  14382. (let ((todir (file-name-directory absprefix)))
  14383. (unless (file-directory-p todir)
  14384. (make-directory todir t))))
  14385. (unless (file-exists-p movefile)
  14386. (org-create-formula-image
  14387. value movefile options forbuffer processing-type))
  14388. (if overlays
  14389. (progn
  14390. (dolist (o (overlays-in beg end))
  14391. (when (eq (overlay-get o 'org-overlay-type)
  14392. 'org-latex-overlay)
  14393. (delete-overlay o)))
  14394. (org--make-preview-overlay beg end movefile imagetype)
  14395. (goto-char end))
  14396. (delete-region beg end)
  14397. (insert
  14398. (org-add-props link
  14399. (list 'org-latex-src
  14400. (replace-regexp-in-string "\"" "" value)
  14401. 'org-latex-src-embed-type
  14402. (if block-type 'paragraph 'character)))))))
  14403. ((eq processing-type 'mathml)
  14404. ;; Process to MathML.
  14405. (unless (org-format-latex-mathml-available-p)
  14406. (user-error "LaTeX to MathML converter not configured"))
  14407. (cl-incf cnt)
  14408. (when msg (message msg cnt))
  14409. (goto-char beg)
  14410. (delete-region beg end)
  14411. (insert (org-format-latex-as-mathml
  14412. value block-type prefix dir)))
  14413. (t
  14414. (error "Unknown conversion process %s for LaTeX fragments"
  14415. processing-type)))))))))))
  14416. (defun org-create-math-formula (latex-frag &optional mathml-file)
  14417. "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
  14418. Use `org-latex-to-mathml-convert-command'. If the conversion is
  14419. successful, return the portion between \"<math...> </math>\"
  14420. elements otherwise return nil. When MATHML-FILE is specified,
  14421. write the results in to that file. When invoked as an
  14422. interactive command, prompt for LATEX-FRAG, with initial value
  14423. set to the current active region and echo the results for user
  14424. inspection."
  14425. (interactive (list (let ((frag (when (org-region-active-p)
  14426. (buffer-substring-no-properties
  14427. (region-beginning) (region-end)))))
  14428. (read-string "LaTeX Fragment: " frag nil frag))))
  14429. (unless latex-frag (user-error "Invalid LaTeX fragment"))
  14430. (let* ((tmp-in-file
  14431. (let ((file (file-relative-name
  14432. (make-temp-name (expand-file-name "ltxmathml-in")))))
  14433. (write-region latex-frag nil file)
  14434. file))
  14435. (tmp-out-file (file-relative-name
  14436. (make-temp-name (expand-file-name "ltxmathml-out"))))
  14437. (cmd (format-spec
  14438. org-latex-to-mathml-convert-command
  14439. `((?j . ,(and org-latex-to-mathml-jar-file
  14440. (shell-quote-argument
  14441. (expand-file-name
  14442. org-latex-to-mathml-jar-file))))
  14443. (?I . ,(shell-quote-argument tmp-in-file))
  14444. (?i . ,latex-frag)
  14445. (?o . ,(shell-quote-argument tmp-out-file)))))
  14446. mathml shell-command-output)
  14447. (when (called-interactively-p 'any)
  14448. (unless (org-format-latex-mathml-available-p)
  14449. (user-error "LaTeX to MathML converter not configured")))
  14450. (message "Running %s" cmd)
  14451. (setq shell-command-output (shell-command-to-string cmd))
  14452. (setq mathml
  14453. (when (file-readable-p tmp-out-file)
  14454. (with-current-buffer (find-file-noselect tmp-out-file t)
  14455. (goto-char (point-min))
  14456. (when (re-search-forward
  14457. (format "<math[^>]*?%s[^>]*?>\\(.\\|\n\\)*</math>"
  14458. (regexp-quote
  14459. "xmlns=\"http://www.w3.org/1998/Math/MathML\""))
  14460. nil t)
  14461. (prog1 (match-string 0) (kill-buffer))))))
  14462. (cond
  14463. (mathml
  14464. (setq mathml
  14465. (concat "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" mathml))
  14466. (when mathml-file
  14467. (write-region mathml nil mathml-file))
  14468. (when (called-interactively-p 'any)
  14469. (message mathml)))
  14470. ((warn "LaTeX to MathML conversion failed")
  14471. (message shell-command-output)))
  14472. (delete-file tmp-in-file)
  14473. (when (file-exists-p tmp-out-file)
  14474. (delete-file tmp-out-file))
  14475. mathml))
  14476. (defun org-format-latex-as-mathml (latex-frag latex-frag-type
  14477. prefix &optional dir)
  14478. "Use `org-create-math-formula' but check local cache first."
  14479. (let* ((absprefix (expand-file-name prefix dir))
  14480. (print-length nil) (print-level nil)
  14481. (formula-id (concat
  14482. "formula-"
  14483. (sha1
  14484. (prin1-to-string
  14485. (list latex-frag
  14486. org-latex-to-mathml-convert-command)))))
  14487. (formula-cache (format "%s-%s.mathml" absprefix formula-id))
  14488. (formula-cache-dir (file-name-directory formula-cache)))
  14489. (unless (file-directory-p formula-cache-dir)
  14490. (make-directory formula-cache-dir t))
  14491. (unless (file-exists-p formula-cache)
  14492. (org-create-math-formula latex-frag formula-cache))
  14493. (if (file-exists-p formula-cache)
  14494. ;; Successful conversion. Return the link to MathML file.
  14495. (org-add-props
  14496. (format "[[file:%s]]" (file-relative-name formula-cache dir))
  14497. (list 'org-latex-src (replace-regexp-in-string "\"" "" latex-frag)
  14498. 'org-latex-src-embed-type (if latex-frag-type
  14499. 'paragraph 'character)))
  14500. ;; Failed conversion. Return the LaTeX fragment verbatim
  14501. latex-frag)))
  14502. (defun org-format-latex-as-html (latex-fragment)
  14503. "Convert LATEX-FRAGMENT to HTML.
  14504. This uses `org-latex-to-html-convert-command', which see."
  14505. (let ((cmd (format-spec org-latex-to-html-convert-command
  14506. `((?i . ,latex-fragment)))))
  14507. (message "Running %s" cmd)
  14508. (shell-command-to-string cmd)))
  14509. (defun org--get-display-dpi ()
  14510. "Get the DPI of the display.
  14511. The function assumes that the display has the same pixel width in
  14512. the horizontal and vertical directions."
  14513. (if (display-graphic-p)
  14514. (round (/ (display-pixel-height)
  14515. (/ (display-mm-height) 25.4)))
  14516. (error "Attempt to calculate the dpi of a non-graphic display")))
  14517. (defun org-create-formula-image
  14518. (string tofile options buffer &optional processing-type)
  14519. "Create an image from LaTeX source using external processes.
  14520. The LaTeX STRING is saved to a temporary LaTeX file, then
  14521. converted to an image file by process PROCESSING-TYPE defined in
  14522. `org-preview-latex-process-alist'. A nil value defaults to
  14523. `org-preview-latex-default-process'.
  14524. The generated image file is eventually moved to TOFILE.
  14525. The OPTIONS argument controls the size, foreground color and
  14526. background color of the generated image.
  14527. When BUFFER non-nil, this function is used for LaTeX previewing.
  14528. Otherwise, it is used to deal with LaTeX snippets showed in
  14529. a HTML file."
  14530. (let* ((processing-type (or processing-type
  14531. org-preview-latex-default-process))
  14532. (processing-info
  14533. (cdr (assq processing-type org-preview-latex-process-alist)))
  14534. (programs (plist-get processing-info :programs))
  14535. (error-message (or (plist-get processing-info :message) ""))
  14536. (image-input-type (plist-get processing-info :image-input-type))
  14537. (image-output-type (plist-get processing-info :image-output-type))
  14538. (post-clean (or (plist-get processing-info :post-clean)
  14539. '(".dvi" ".xdv" ".pdf" ".tex" ".aux" ".log"
  14540. ".svg" ".png" ".jpg" ".jpeg" ".out")))
  14541. (latex-header
  14542. (or (plist-get processing-info :latex-header)
  14543. (org-latex-make-preamble
  14544. (org-export-get-environment (org-export-get-backend 'latex))
  14545. org-format-latex-header
  14546. 'snippet)))
  14547. (latex-compiler (plist-get processing-info :latex-compiler))
  14548. (tmpdir temporary-file-directory)
  14549. (texfilebase (make-temp-name
  14550. (expand-file-name "orgtex" tmpdir)))
  14551. (texfile (concat texfilebase ".tex"))
  14552. (image-size-adjust (or (plist-get processing-info :image-size-adjust)
  14553. '(1.0 . 1.0)))
  14554. (scale (* (if buffer (car image-size-adjust) (cdr image-size-adjust))
  14555. (or (plist-get options (if buffer :scale :html-scale)) 1.0)))
  14556. (dpi (* scale (if (and buffer (display-graphic-p)) (org--get-display-dpi) 140.0)))
  14557. (fg (or (plist-get options (if buffer :foreground :html-foreground))
  14558. "Black"))
  14559. (bg (or (plist-get options (if buffer :background :html-background))
  14560. "Transparent"))
  14561. (image-converter
  14562. (or (and (string= bg "Transparent")
  14563. (plist-get processing-info :transparent-image-converter))
  14564. (plist-get processing-info :image-converter)))
  14565. (log-buf (get-buffer-create "*Org Preview LaTeX Output*"))
  14566. (resize-mini-windows nil)) ;Fix Emacs flicker when creating image.
  14567. (dolist (program programs)
  14568. (org-check-external-command program error-message))
  14569. (if (eq fg 'default)
  14570. (setq fg (org-latex-color :foreground))
  14571. (setq fg (org-latex-color-format fg)))
  14572. (setq bg (cond
  14573. ((eq bg 'default) (org-latex-color :background))
  14574. ((string= bg "Transparent") nil)
  14575. (t (org-latex-color-format bg))))
  14576. ;; Remove TeX \par at end of snippet to avoid trailing space.
  14577. (if (string-suffix-p string "\n")
  14578. (aset string (1- (length string)) ?%)
  14579. (setq string (concat string "%")))
  14580. (with-temp-file texfile
  14581. (insert latex-header)
  14582. (insert "\n\\begin{document}\n"
  14583. "\\definecolor{fg}{rgb}{" fg "}%\n"
  14584. (if bg
  14585. (concat "\\definecolor{bg}{rgb}{" bg "}%\n"
  14586. "\n\\pagecolor{bg}%\n")
  14587. "")
  14588. "\n{\\color{fg}\n"
  14589. string
  14590. "\n}\n"
  14591. "\n\\end{document}\n"))
  14592. (let* ((err-msg (format "Please adjust `%s' part of \
  14593. `org-preview-latex-process-alist'."
  14594. processing-type))
  14595. (image-input-file
  14596. (org-compile-file
  14597. texfile latex-compiler image-input-type err-msg log-buf))
  14598. (image-output-file
  14599. (org-compile-file
  14600. image-input-file image-converter image-output-type err-msg log-buf
  14601. `((?D . ,(shell-quote-argument (format "%s" dpi)))
  14602. (?S . ,(shell-quote-argument (format "%s" (/ dpi 140.0))))))))
  14603. (copy-file image-output-file tofile 'replace)
  14604. (dolist (e post-clean)
  14605. (when (file-exists-p (concat texfilebase e))
  14606. (delete-file (concat texfilebase e))))
  14607. image-output-file)))
  14608. (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
  14609. "Fill a LaTeX header template TPL.
  14610. In the template, the following place holders will be recognized:
  14611. [DEFAULT-PACKAGES] \\usepackage statements for DEF-PKG
  14612. [NO-DEFAULT-PACKAGES] do not include DEF-PKG
  14613. [PACKAGES] \\usepackage statements for PKG
  14614. [NO-PACKAGES] do not include PKG
  14615. [EXTRA] the string EXTRA
  14616. [NO-EXTRA] do not include EXTRA
  14617. For backward compatibility, if both the positive and the negative place
  14618. holder is missing, the positive one (without the \"NO-\") will be
  14619. assumed to be present at the end of the template.
  14620. DEF-PKG and PKG are assumed to be alists of options/packagename lists.
  14621. EXTRA is a string.
  14622. SNIPPETS-P indicates if this is run to create snippet images for HTML."
  14623. (let (rpl (end ""))
  14624. (if (string-match "^[ \t]*\\[\\(NO-\\)?DEFAULT-PACKAGES\\][ \t]*\n?" tpl)
  14625. (setq rpl (if (or (match-end 1) (not def-pkg))
  14626. "" (org-latex-packages-to-string def-pkg snippets-p t))
  14627. tpl (replace-match rpl t t tpl))
  14628. (when def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
  14629. (if (string-match "\\[\\(NO-\\)?PACKAGES\\][ \t]*\n?" tpl)
  14630. (setq rpl (if (or (match-end 1) (not pkg))
  14631. "" (org-latex-packages-to-string pkg snippets-p t))
  14632. tpl (replace-match rpl t t tpl))
  14633. (when pkg (setq end
  14634. (concat end "\n"
  14635. (org-latex-packages-to-string pkg snippets-p)))))
  14636. (if (string-match "\\[\\(NO-\\)?EXTRA\\][ \t]*\n?" tpl)
  14637. (setq rpl (if (or (match-end 1) (not extra))
  14638. "" (concat extra "\n"))
  14639. tpl (replace-match rpl t t tpl))
  14640. (when (and extra (string-match "\\S-" extra))
  14641. (setq end (concat end "\n" extra))))
  14642. (if (string-match "\\S-" end)
  14643. (concat tpl "\n" end)
  14644. tpl)))
  14645. (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
  14646. "Turn an alist of packages into a string with the \\usepackage macros."
  14647. (setq pkg (mapconcat (lambda(p)
  14648. (cond
  14649. ((stringp p) p)
  14650. ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
  14651. (format "%% Package %s omitted" (cadr p)))
  14652. ((equal "" (car p))
  14653. (format "\\usepackage{%s}" (cadr p)))
  14654. (t
  14655. (format "\\usepackage[%s]{%s}"
  14656. (car p) (cadr p)))))
  14657. pkg
  14658. "\n"))
  14659. (if newline (concat pkg "\n") pkg))
  14660. (defun org-dvipng-color (attr)
  14661. "Return a RGB color specification for dvipng."
  14662. (org-dvipng-color-format (face-attribute 'default attr nil)))
  14663. (defun org-dvipng-color-format (color-name)
  14664. "Convert COLOR-NAME to a RGB color value for dvipng."
  14665. (apply #'format "rgb %s %s %s"
  14666. (mapcar 'org-normalize-color
  14667. (color-values color-name))))
  14668. (defun org-latex-color (attr)
  14669. "Return a RGB color for the LaTeX color package."
  14670. (org-latex-color-format (face-attribute 'default attr nil)))
  14671. (defun org-latex-color-format (color-name)
  14672. "Convert COLOR-NAME to a RGB color value."
  14673. (apply #'format "%s,%s,%s"
  14674. (mapcar 'org-normalize-color
  14675. (color-values color-name))))
  14676. (defun org-normalize-color (value)
  14677. "Return string to be used as color value for an RGB component."
  14678. (format "%g" (/ value 65535.0)))
  14679. ;; Image display
  14680. (defvar-local org-inline-image-overlays nil)
  14681. (defun org-toggle-inline-images (&optional include-linked)
  14682. "Toggle the display of inline images.
  14683. INCLUDE-LINKED is passed to `org-display-inline-images'."
  14684. (interactive "P")
  14685. (if org-inline-image-overlays
  14686. (progn
  14687. (org-remove-inline-images)
  14688. (when (called-interactively-p 'interactive)
  14689. (message "Inline image display turned off")))
  14690. (org-display-inline-images include-linked)
  14691. (when (called-interactively-p 'interactive)
  14692. (message (if org-inline-image-overlays
  14693. (format "%d images displayed inline"
  14694. (length org-inline-image-overlays))
  14695. "No images to display inline")))))
  14696. (defun org-redisplay-inline-images ()
  14697. "Assure display of inline images and refresh them."
  14698. (interactive)
  14699. (org-toggle-inline-images)
  14700. (unless org-inline-image-overlays
  14701. (org-toggle-inline-images)))
  14702. ;; For without-x builds.
  14703. (declare-function image-flush "image" (spec &optional frame))
  14704. (defcustom org-display-remote-inline-images 'skip
  14705. "How to display remote inline images.
  14706. Possible values of this option are:
  14707. skip Don't display remote images.
  14708. download Always download and display remote images.
  14709. cache Display remote images, and open them in separate buffers
  14710. for caching. Silently update the image buffer when a file
  14711. change is detected."
  14712. :group 'org-appearance
  14713. :package-version '(Org . "9.4")
  14714. :type '(choice
  14715. (const :tag "Ignore remote images" skip)
  14716. (const :tag "Always display remote images" download)
  14717. (const :tag "Display and silently update remote images" cache))
  14718. :safe #'symbolp)
  14719. (defun org--create-inline-image (file width)
  14720. "Create image located at FILE, or return nil.
  14721. WIDTH is the width of the image. The image may not be created
  14722. according to the value of `org-display-remote-inline-images'."
  14723. (let* ((remote? (file-remote-p file))
  14724. (file-or-data
  14725. (pcase org-display-remote-inline-images
  14726. ((guard (not remote?)) file)
  14727. (`download (with-temp-buffer
  14728. (set-buffer-multibyte nil)
  14729. (insert-file-contents-literally file)
  14730. (buffer-string)))
  14731. (`cache (let ((revert-without-query '(".")))
  14732. (with-current-buffer (find-file-noselect file)
  14733. (buffer-string))))
  14734. (`skip nil)
  14735. (other
  14736. (message "Invalid value of `org-display-remote-inline-images': %S"
  14737. other)
  14738. nil))))
  14739. (when file-or-data
  14740. (create-image file-or-data
  14741. (and (image-type-available-p 'imagemagick)
  14742. width
  14743. 'imagemagick)
  14744. remote?
  14745. :width width :scale 1))))
  14746. (defun org-display-inline-images (&optional include-linked refresh beg end)
  14747. "Display inline images.
  14748. An inline image is a link which follows either of these
  14749. conventions:
  14750. 1. Its path is a file with an extension matching return value
  14751. from `image-file-name-regexp' and it has no contents.
  14752. 2. Its description consists in a single link of the previous
  14753. type. In this case, that link must be a well-formed plain
  14754. or angle link, i.e., it must have an explicit \"file\" type.
  14755. Equip each image with the key-map `image-map'.
  14756. When optional argument INCLUDE-LINKED is non-nil, also links with
  14757. a text description part will be inlined. This can be nice for
  14758. a quick look at those images, but it does not reflect what
  14759. exported files will look like.
  14760. When optional argument REFRESH is non-nil, refresh existing
  14761. images between BEG and END. This will create new image displays
  14762. only if necessary.
  14763. BEG and END define the considered part. They default to the
  14764. buffer boundaries with possible narrowing."
  14765. (interactive "P")
  14766. (when (display-graphic-p)
  14767. (unless refresh
  14768. (org-remove-inline-images)
  14769. (when (fboundp 'clear-image-cache) (clear-image-cache)))
  14770. (let ((end (or end (point-max))))
  14771. (org-with-point-at (or beg (point-min))
  14772. (let* ((case-fold-search t)
  14773. (file-extension-re (image-file-name-regexp))
  14774. (link-abbrevs (mapcar #'car
  14775. (append org-link-abbrev-alist-local
  14776. org-link-abbrev-alist)))
  14777. ;; Check absolute, relative file names and explicit
  14778. ;; "file:" links. Also check link abbreviations since
  14779. ;; some might expand to "file" links.
  14780. (file-types-re
  14781. (format "\\[\\[\\(?:file%s:\\|attachment:\\|[./~]\\)\\|\\]\\[\\(<?file:\\)"
  14782. (if (not link-abbrevs) ""
  14783. (concat "\\|" (regexp-opt link-abbrevs))))))
  14784. (while (re-search-forward file-types-re end t)
  14785. (let* ((link (org-element-lineage
  14786. (save-match-data (org-element-context))
  14787. '(link) t))
  14788. (linktype (org-element-property :type link))
  14789. (inner-start (match-beginning 1))
  14790. (path
  14791. (cond
  14792. ;; No link at point; no inline image.
  14793. ((not link) nil)
  14794. ;; File link without a description. Also handle
  14795. ;; INCLUDE-LINKED here since it should have
  14796. ;; precedence over the next case. I.e., if link
  14797. ;; contains filenames in both the path and the
  14798. ;; description, prioritize the path only when
  14799. ;; INCLUDE-LINKED is non-nil.
  14800. ((or (not (org-element-property :contents-begin link))
  14801. include-linked)
  14802. (and (or (equal "file" linktype)
  14803. (equal "attachment" linktype))
  14804. (org-element-property :path link)))
  14805. ;; Link with a description. Check if description
  14806. ;; is a filename. Even if Org doesn't have syntax
  14807. ;; for those -- clickable image -- constructs, fake
  14808. ;; them, as in `org-export-insert-image-links'.
  14809. ((not inner-start) nil)
  14810. (t
  14811. (org-with-point-at inner-start
  14812. (and (looking-at
  14813. (if (char-equal ?< (char-after inner-start))
  14814. org-link-angle-re
  14815. org-link-plain-re))
  14816. ;; File name must fill the whole
  14817. ;; description.
  14818. (= (org-element-property :contents-end link)
  14819. (match-end 0))
  14820. (match-string 2)))))))
  14821. (when (and path (string-match-p file-extension-re path))
  14822. (let ((file (if (equal "attachment" linktype)
  14823. (progn
  14824. (require 'org-attach)
  14825. (ignore-errors (org-attach-expand path)))
  14826. (expand-file-name path))))
  14827. (when (and file (file-exists-p file))
  14828. (let ((width (org-display-inline-image--width link))
  14829. (old (get-char-property-and-overlay
  14830. (org-element-property :begin link)
  14831. 'org-image-overlay)))
  14832. (if (and (car-safe old) refresh)
  14833. (image-flush (overlay-get (cdr old) 'display))
  14834. (let ((image (org--create-inline-image file width)))
  14835. (when image
  14836. (let ((ov (make-overlay
  14837. (org-element-property :begin link)
  14838. (progn
  14839. (goto-char
  14840. (org-element-property :end link))
  14841. (skip-chars-backward " \t")
  14842. (point)))))
  14843. (overlay-put ov 'display image)
  14844. (overlay-put ov 'face 'default)
  14845. (overlay-put ov 'org-image-overlay t)
  14846. (overlay-put
  14847. ov 'modification-hooks
  14848. (list 'org-display-inline-remove-overlay))
  14849. (when (boundp 'image-map)
  14850. (overlay-put ov 'keymap image-map))
  14851. (push ov org-inline-image-overlays))))))))))))))))
  14852. (defvar visual-fill-column-width) ; Silence compiler warning
  14853. (defun org-display-inline-image--width (link)
  14854. "Determine the display width of the image LINK, in pixels.
  14855. - When `org-image-actual-width' is t, the image's pixel width is used.
  14856. - When `org-image-actual-width' is a number, that value will is used.
  14857. - When `org-image-actual-width' is nil or a list, the first :width attribute
  14858. set (if it exists) is used to set the image width. A width of X% is
  14859. divided by 100.
  14860. If no :width attribute is given and `org-image-actual-width' is a list with
  14861. a number as the car, then that number is used as the default value.
  14862. If the value is a float between 0 and 2, it interpreted as that proportion
  14863. of the text width in the buffer."
  14864. ;; Apply `org-image-actual-width' specifications.
  14865. ;; Support subtree-level property "ORG-IMAGE-ACTUAL-WIDTH" specified
  14866. ;; width.
  14867. (let ((org-image-actual-width (org-property-or-variable-value 'org-image-actual-width)))
  14868. (cond
  14869. ((eq org-image-actual-width t) nil)
  14870. ((listp org-image-actual-width)
  14871. (let* ((case-fold-search t)
  14872. (par (org-element-lineage link '(paragraph)))
  14873. (attr-re "^[ \t]*#\\+attr_.*?: +.*?:width +\\(\\S-+\\)")
  14874. (par-end (org-element-property :post-affiliated par))
  14875. ;; Try to find an attribute providing a :width.
  14876. (attr-width
  14877. (when (and par (org-with-point-at
  14878. (org-element-property :begin par)
  14879. (re-search-forward attr-re par-end t)))
  14880. (match-string 1)))
  14881. (width
  14882. (cond
  14883. ;; Treat :width t as if `org-image-actual-width' were t.
  14884. ((string= attr-width "t") nil)
  14885. ;; Fallback to `org-image-actual-width' if no interprable width is given.
  14886. ((or (null attr-width)
  14887. (string-match-p "\\`[^0-9]" attr-width))
  14888. (car org-image-actual-width))
  14889. ;; Convert numeric widths to numbers, converting percentages.
  14890. ((string-match-p "\\`[0-9.]+%" attr-width)
  14891. (/ (string-to-number attr-width) 100.0))
  14892. (t (string-to-number attr-width)))))
  14893. (if (and (floatp width) (<= 0.0 width 2.0))
  14894. ;; A float in [0,2] should be interpereted as this portion of
  14895. ;; the text width in the window. This works well with cases like
  14896. ;; #+attr_latex: :width 0.X\{line,page,column,etc.}width,
  14897. ;; as the "0.X" is pulled out as a float. We use 2 as the upper
  14898. ;; bound as cases such as 1.2\linewidth are feasible.
  14899. (round (* width
  14900. (window-pixel-width)
  14901. (/ (or (and (bound-and-true-p visual-fill-column-mode)
  14902. (or visual-fill-column-width auto-fill-function))
  14903. (when auto-fill-function fill-column)
  14904. (- (window-text-width) (line-number-display-width)))
  14905. (float (window-total-width)))))
  14906. width)))
  14907. ((numberp org-image-actual-width)
  14908. org-image-actual-width)
  14909. (t nil))))
  14910. (defun org-display-inline-remove-overlay (ov after _beg _end &optional _len)
  14911. "Remove inline-display overlay if a corresponding region is modified."
  14912. (when (and ov after)
  14913. (delete ov org-inline-image-overlays)
  14914. (delete-overlay ov)))
  14915. (defun org-remove-inline-images ()
  14916. "Remove inline display of images."
  14917. (interactive)
  14918. (mapc #'delete-overlay org-inline-image-overlays)
  14919. (setq org-inline-image-overlays nil))
  14920. (defvar org-self-insert-command-undo-counter 0)
  14921. (defvar org-speed-command nil)
  14922. (defun org-fix-tags-on-the-fly ()
  14923. "Align tags in headline at point.
  14924. Unlike `org-align-tags', this function does nothing if point is
  14925. either not currently on a tagged headline or on a tag."
  14926. (when (and (org-match-line org-tag-line-re)
  14927. (< (point) (match-beginning 1)))
  14928. (org-align-tags)))
  14929. (defun org-self-insert-command (N)
  14930. "Like `self-insert-command', use overwrite-mode for whitespace in tables.
  14931. If the cursor is in a table looking at whitespace, the whitespace is
  14932. overwritten, and the table is not marked as requiring realignment."
  14933. (interactive "p")
  14934. (org-fold-check-before-invisible-edit 'insert)
  14935. (cond
  14936. ((and org-use-speed-commands
  14937. (let ((kv (this-command-keys-vector)))
  14938. (setq org-speed-command
  14939. (run-hook-with-args-until-success
  14940. 'org-speed-command-hook
  14941. (make-string 1 (aref kv (1- (length kv))))))))
  14942. (cond
  14943. ((commandp org-speed-command)
  14944. (setq this-command org-speed-command)
  14945. (call-interactively org-speed-command))
  14946. ((functionp org-speed-command)
  14947. (funcall org-speed-command))
  14948. ((consp org-speed-command)
  14949. (eval org-speed-command t))
  14950. (t (let (org-use-speed-commands)
  14951. (call-interactively 'org-self-insert-command)))))
  14952. ((and
  14953. (= N 1)
  14954. (not (org-region-active-p))
  14955. (org-at-table-p)
  14956. (progn
  14957. ;; Check if we blank the field, and if that triggers align.
  14958. (and (featurep 'org-table)
  14959. org-table-auto-blank-field
  14960. (memq last-command
  14961. '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c))
  14962. (if (or (eq (char-after) ?\s) (looking-at "[^|\n]* |"))
  14963. ;; Got extra space, this field does not determine
  14964. ;; column width.
  14965. (let (org-table-may-need-update) (org-table-blank-field))
  14966. ;; No extra space, this field may determine column
  14967. ;; width.
  14968. (org-table-blank-field)))
  14969. t)
  14970. (looking-at "[^|\n]* |"))
  14971. ;; There is room for insertion without re-aligning the table.
  14972. (self-insert-command N)
  14973. (org-table-with-shrunk-field
  14974. (save-excursion
  14975. (skip-chars-forward "^|")
  14976. ;; Do not delete last space, which is
  14977. ;; `org-table-separator-space', but the regular space before
  14978. ;; it.
  14979. (delete-region (- (point) 2) (1- (point))))))
  14980. (t
  14981. (setq org-table-may-need-update t)
  14982. (self-insert-command N)
  14983. (org-fix-tags-on-the-fly)
  14984. (when org-self-insert-cluster-for-undo
  14985. (if (not (eq last-command 'org-self-insert-command))
  14986. (setq org-self-insert-command-undo-counter 1)
  14987. (if (>= org-self-insert-command-undo-counter 20)
  14988. (setq org-self-insert-command-undo-counter 1)
  14989. (and (> org-self-insert-command-undo-counter 0)
  14990. buffer-undo-list (listp buffer-undo-list)
  14991. (not (cadr buffer-undo-list)) ; remove nil entry
  14992. (setcdr buffer-undo-list (cddr buffer-undo-list)))
  14993. (setq org-self-insert-command-undo-counter
  14994. (1+ org-self-insert-command-undo-counter))))))))
  14995. (defun org-delete-backward-char (N)
  14996. "Like `delete-backward-char', insert whitespace at field end in tables.
  14997. When deleting backwards, in tables this function will insert whitespace in
  14998. front of the next \"|\" separator, to keep the table aligned. The table will
  14999. still be marked for re-alignment if the field did fill the entire column,
  15000. because, in this case the deletion might narrow the column."
  15001. (interactive "p")
  15002. (save-match-data
  15003. (org-fold-check-before-invisible-edit 'delete-backward)
  15004. (if (and (= N 1)
  15005. (not overwrite-mode)
  15006. (not (org-region-active-p))
  15007. (not (eq (char-before) ?|))
  15008. (save-excursion (skip-chars-backward " \t") (not (bolp)))
  15009. (looking-at-p ".*?|")
  15010. (org-at-table-p))
  15011. (progn (forward-char -1) (org-delete-char 1))
  15012. (backward-delete-char N)
  15013. (org-fix-tags-on-the-fly))))
  15014. (defun org-delete-char (N)
  15015. "Like `delete-char', but insert whitespace at field end in tables.
  15016. When deleting characters, in tables this function will insert whitespace in
  15017. front of the next \"|\" separator, to keep the table aligned. The table will
  15018. still be marked for re-alignment if the field did fill the entire column,
  15019. because, in this case the deletion might narrow the column."
  15020. (interactive "p")
  15021. (save-match-data
  15022. (org-fold-check-before-invisible-edit 'delete)
  15023. (cond
  15024. ((or (/= N 1)
  15025. (eq (char-after) ?|)
  15026. (save-excursion (skip-chars-backward " \t") (bolp))
  15027. (not (org-at-table-p)))
  15028. (delete-char N)
  15029. (org-fix-tags-on-the-fly))
  15030. ((looking-at ".\\(.*?\\)|")
  15031. (let* ((update? org-table-may-need-update)
  15032. (noalign (looking-at-p ".*? |")))
  15033. (delete-char 1)
  15034. (org-table-with-shrunk-field
  15035. (save-excursion
  15036. ;; Last space is `org-table-separator-space', so insert
  15037. ;; a regular one before it instead.
  15038. (goto-char (- (match-end 0) 2))
  15039. (insert " ")))
  15040. ;; If there were two spaces at the end, this field does not
  15041. ;; determine the width of the column.
  15042. (when noalign (setq org-table-may-need-update update?))))
  15043. (t
  15044. (delete-char N)))))
  15045. ;; Make `delete-selection-mode' work with Org mode and Orgtbl mode
  15046. (put 'org-self-insert-command 'delete-selection
  15047. (lambda ()
  15048. (not (run-hook-with-args-until-success
  15049. 'self-insert-uses-region-functions))))
  15050. (put 'orgtbl-self-insert-command 'delete-selection
  15051. (lambda ()
  15052. (not (run-hook-with-args-until-success
  15053. 'self-insert-uses-region-functions))))
  15054. (put 'org-delete-char 'delete-selection 'supersede)
  15055. (put 'org-delete-backward-char 'delete-selection 'supersede)
  15056. (put 'org-yank 'delete-selection 'yank)
  15057. (put 'org-return 'delete-selection t)
  15058. ;; Make `flyspell-mode' delay after some commands
  15059. (put 'org-self-insert-command 'flyspell-delayed t)
  15060. (put 'orgtbl-self-insert-command 'flyspell-delayed t)
  15061. (put 'org-delete-char 'flyspell-delayed t)
  15062. (put 'org-delete-backward-char 'flyspell-delayed t)
  15063. ;; Make pabbrev-mode expand after Org mode commands
  15064. (put 'org-self-insert-command 'pabbrev-expand-after-command t)
  15065. (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
  15066. (defun org-transpose-words ()
  15067. "Transpose words for Org.
  15068. This uses the `org-mode-transpose-word-syntax-table' syntax
  15069. table, which interprets characters in `org-emphasis-alist' as
  15070. word constituents."
  15071. (interactive)
  15072. (with-syntax-table org-mode-transpose-word-syntax-table
  15073. (call-interactively 'transpose-words)))
  15074. (defvar org-ctrl-c-ctrl-c-hook nil
  15075. "Hook for functions attaching themselves to `C-c C-c'.
  15076. This can be used to add additional functionality to the `C-c C-c'
  15077. key which executes context-dependent commands. This hook is run
  15078. before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
  15079. run after the last test.
  15080. Each function will be called with no arguments. The function
  15081. must check if the context is appropriate for it to act. If yes,
  15082. it should do its thing and then return a non-nil value. If the
  15083. context is wrong, just do nothing and return nil.")
  15084. (defvar org-ctrl-c-ctrl-c-final-hook nil
  15085. "Hook for functions attaching themselves to `C-c C-c'.
  15086. This can be used to add additional functionality to the `C-c C-c'
  15087. key which executes context-dependent commands. This hook is run
  15088. after any other test, while `org-ctrl-c-ctrl-c-hook' is run
  15089. before the first test.
  15090. Each function will be called with no arguments. The function
  15091. must check if the context is appropriate for it to act. If yes,
  15092. it should do its thing and then return a non-nil value. If the
  15093. context is wrong, just do nothing and return nil.")
  15094. (defvar org-tab-after-check-for-table-hook nil
  15095. "Hook for functions to attach themselves to TAB.
  15096. See `org-ctrl-c-ctrl-c-hook' for more information.
  15097. This hook runs after it has been established that the cursor is not in a
  15098. table, but before checking if the cursor is in a headline or if global cycling
  15099. should be done.
  15100. If any function in this hook returns t, not other actions like visibility
  15101. cycling will be done.")
  15102. (defvar org-tab-after-check-for-cycling-hook nil
  15103. "Hook for functions to attach themselves to TAB.
  15104. See `org-ctrl-c-ctrl-c-hook' for more information.
  15105. This hook runs after it has been established that not table field motion and
  15106. not visibility should be done because of current context. This is probably
  15107. the place where a package like yasnippets can hook in.")
  15108. (defvar org-tab-before-tab-emulation-hook nil
  15109. "Hook for functions to attach themselves to TAB.
  15110. See `org-ctrl-c-ctrl-c-hook' for more information.
  15111. This hook runs after every other options for TAB have been exhausted, but
  15112. before indentation and \t insertion takes place.")
  15113. (defvar org-metaleft-hook nil
  15114. "Hook for functions attaching themselves to `M-left'.
  15115. See `org-ctrl-c-ctrl-c-hook' for more information.")
  15116. (defvar org-metaright-hook nil
  15117. "Hook for functions attaching themselves to `M-right'.
  15118. See `org-ctrl-c-ctrl-c-hook' for more information.")
  15119. (defvar org-metaup-hook nil
  15120. "Hook for functions attaching themselves to `M-up'.
  15121. See `org-ctrl-c-ctrl-c-hook' for more information.")
  15122. (defvar org-metadown-hook nil
  15123. "Hook for functions attaching themselves to `M-down'.
  15124. See `org-ctrl-c-ctrl-c-hook' for more information.")
  15125. (defvar org-shiftmetaleft-hook nil
  15126. "Hook for functions attaching themselves to `M-S-left'.
  15127. See `org-ctrl-c-ctrl-c-hook' for more information.")
  15128. (defvar org-shiftmetaright-hook nil
  15129. "Hook for functions attaching themselves to `M-S-right'.
  15130. See `org-ctrl-c-ctrl-c-hook' for more information.")
  15131. (defvar org-shiftmetaup-hook nil
  15132. "Hook for functions attaching themselves to `M-S-up'.
  15133. See `org-ctrl-c-ctrl-c-hook' for more information.")
  15134. (defvar org-shiftmetadown-hook nil
  15135. "Hook for functions attaching themselves to `M-S-down'.
  15136. See `org-ctrl-c-ctrl-c-hook' for more information.")
  15137. (defvar org-metareturn-hook nil
  15138. "Hook for functions attaching themselves to `M-RET'.
  15139. See `org-ctrl-c-ctrl-c-hook' for more information.")
  15140. (defvar org-shiftup-hook nil
  15141. "Hook for functions attaching themselves to `S-up'.
  15142. See `org-ctrl-c-ctrl-c-hook' for more information.")
  15143. (defvar org-shiftup-final-hook nil
  15144. "Hook for functions attaching themselves to `S-up'.
  15145. This one runs after all other options except shift-select have been excluded.
  15146. See `org-ctrl-c-ctrl-c-hook' for more information.")
  15147. (defvar org-shiftdown-hook nil
  15148. "Hook for functions attaching themselves to `S-down'.
  15149. See `org-ctrl-c-ctrl-c-hook' for more information.")
  15150. (defvar org-shiftdown-final-hook nil
  15151. "Hook for functions attaching themselves to `S-down'.
  15152. This one runs after all other options except shift-select have been excluded.
  15153. See `org-ctrl-c-ctrl-c-hook' for more information.")
  15154. (defvar org-shiftleft-hook nil
  15155. "Hook for functions attaching themselves to `S-left'.
  15156. See `org-ctrl-c-ctrl-c-hook' for more information.")
  15157. (defvar org-shiftleft-final-hook nil
  15158. "Hook for functions attaching themselves to `S-left'.
  15159. This one runs after all other options except shift-select have been excluded.
  15160. See `org-ctrl-c-ctrl-c-hook' for more information.")
  15161. (defvar org-shiftright-hook nil
  15162. "Hook for functions attaching themselves to `S-right'.
  15163. See `org-ctrl-c-ctrl-c-hook' for more information.")
  15164. (defvar org-shiftright-final-hook nil
  15165. "Hook for functions attaching themselves to `S-right'.
  15166. This one runs after all other options except shift-select have been excluded.
  15167. See `org-ctrl-c-ctrl-c-hook' for more information.")
  15168. (defun org-modifier-cursor-error ()
  15169. "Throw an error, a modified cursor command was applied in wrong context."
  15170. (user-error "This command is active in special context like tables, headlines or items"))
  15171. (defun org-shiftselect-error ()
  15172. "Throw an error because Shift-Cursor command was applied in wrong context."
  15173. (if (and (boundp 'shift-select-mode) shift-select-mode)
  15174. (user-error "To use shift-selection with Org mode, customize `org-support-shift-select'")
  15175. (user-error "This command works only in special context like headlines or timestamps")))
  15176. (defun org-call-for-shift-select (cmd)
  15177. (let ((this-command-keys-shift-translated t))
  15178. (call-interactively cmd)))
  15179. (defun org-shifttab (&optional arg)
  15180. "Global visibility cycling or move to previous table field.
  15181. Call `org-table-previous-field' within a table.
  15182. When ARG is nil, cycle globally through visibility states.
  15183. When ARG is a numeric prefix, show contents of this level."
  15184. (interactive "P")
  15185. (cond
  15186. ((org-at-table-p) (call-interactively 'org-table-previous-field))
  15187. ((integerp arg)
  15188. (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
  15189. (message "Content view to level: %d" arg)
  15190. (org-cycle-content (prefix-numeric-value arg2))
  15191. (org-cycle-show-empty-lines t)
  15192. (setq org-cycle-global-status 'overview)
  15193. (run-hook-with-args 'org-cycle-hook 'overview)))
  15194. (t (call-interactively 'org-cycle-global))))
  15195. (defun org-shiftmetaleft ()
  15196. "Promote subtree or delete table column.
  15197. Calls `org-promote-subtree', `org-outdent-item-tree', or
  15198. `org-table-delete-column', depending on context. See the
  15199. individual commands for more information."
  15200. (interactive)
  15201. (cond
  15202. ((and (eq system-type 'darwin)
  15203. (or (eq org-support-shift-select 'always)
  15204. (and org-support-shift-select (org-region-active-p))))
  15205. (org-call-for-shift-select 'backward-char))
  15206. ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
  15207. ((org-at-table-p) (call-interactively 'org-table-delete-column))
  15208. ((org-at-heading-p) (call-interactively 'org-promote-subtree))
  15209. ((if (not (org-region-active-p)) (org-at-item-p)
  15210. (save-excursion (goto-char (region-beginning))
  15211. (org-at-item-p)))
  15212. (call-interactively 'org-outdent-item-tree))
  15213. (t (org-modifier-cursor-error))))
  15214. (defun org-shiftmetaright ()
  15215. "Demote subtree or insert table column.
  15216. Calls `org-demote-subtree', `org-indent-item-tree', or
  15217. `org-table-insert-column', depending on context. See the
  15218. individual commands for more information."
  15219. (interactive)
  15220. (cond
  15221. ((and (eq system-type 'darwin)
  15222. (or (eq org-support-shift-select 'always)
  15223. (and org-support-shift-select (org-region-active-p))))
  15224. (org-call-for-shift-select 'forward-char))
  15225. ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
  15226. ((org-at-table-p) (call-interactively 'org-table-insert-column))
  15227. ((org-at-heading-p) (call-interactively 'org-demote-subtree))
  15228. ((if (not (org-region-active-p)) (org-at-item-p)
  15229. (save-excursion (goto-char (region-beginning))
  15230. (org-at-item-p)))
  15231. (call-interactively 'org-indent-item-tree))
  15232. (t (org-modifier-cursor-error))))
  15233. (defun org-shiftmetaup (&optional _arg)
  15234. "Drag the line at point up.
  15235. In a table, kill the current row.
  15236. On a clock timestamp, update the value of the timestamp like `S-<up>'
  15237. but also adjust the previous clocked item in the clock history.
  15238. Everywhere else, drag the line at point up."
  15239. (interactive "P")
  15240. (cond
  15241. ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
  15242. ((org-at-table-p) (call-interactively 'org-table-kill-row))
  15243. ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
  15244. (call-interactively 'org-timestamp-up)))
  15245. (t (call-interactively 'org-drag-line-backward))))
  15246. (defun org-shiftmetadown (&optional _arg)
  15247. "Drag the line at point down.
  15248. In a table, insert an empty row at the current line.
  15249. On a clock timestamp, update the value of the timestamp like `S-<down>'
  15250. but also adjust the previous clocked item in the clock history.
  15251. Everywhere else, drag the line at point down."
  15252. (interactive "P")
  15253. (cond
  15254. ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
  15255. ((org-at-table-p) (call-interactively 'org-table-insert-row))
  15256. ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
  15257. (call-interactively 'org-timestamp-down)))
  15258. (t (call-interactively 'org-drag-line-forward))))
  15259. (defsubst org-hidden-tree-error ()
  15260. (user-error
  15261. "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
  15262. (defun org-metaleft (&optional _arg)
  15263. "Promote heading, list item at point or move table column left.
  15264. Calls `org-do-promote', `org-outdent-item' or `org-table-move-column',
  15265. depending on context. With no specific context, calls the Emacs
  15266. default `backward-word'. See the individual commands for more
  15267. information.
  15268. This function runs the hook `org-metaleft-hook' as a first step,
  15269. and returns at first non-nil value."
  15270. (interactive "P")
  15271. (cond
  15272. ((run-hook-with-args-until-success 'org-metaleft-hook))
  15273. ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
  15274. ((org-with-limited-levels
  15275. (or (org-at-heading-p)
  15276. (and (org-region-active-p)
  15277. (save-excursion
  15278. (goto-char (region-beginning))
  15279. (org-at-heading-p)))))
  15280. (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
  15281. (call-interactively 'org-do-promote))
  15282. ;; At an inline task.
  15283. ((org-at-heading-p)
  15284. (call-interactively 'org-inlinetask-promote))
  15285. ((or (org-at-item-p)
  15286. (and (org-region-active-p)
  15287. (save-excursion
  15288. (goto-char (region-beginning))
  15289. (org-at-item-p))))
  15290. (when (org-check-for-hidden 'items) (org-hidden-tree-error))
  15291. (call-interactively 'org-outdent-item))
  15292. (t (call-interactively 'backward-word))))
  15293. (defun org-metaright (&optional _arg)
  15294. "Demote heading, list item at point or move table column right.
  15295. In front of a drawer or a block keyword, indent it correctly.
  15296. Calls `org-do-demote', `org-indent-item', `org-table-move-column',
  15297. `org-indent-drawer' or `org-indent-block' depending on context.
  15298. With no specific context, calls the Emacs default `forward-word'.
  15299. See the individual commands for more information.
  15300. This function runs the hook `org-metaright-hook' as a first step,
  15301. and returns at first non-nil value."
  15302. (interactive "P")
  15303. (cond
  15304. ((run-hook-with-args-until-success 'org-metaright-hook))
  15305. ((org-at-table-p) (call-interactively 'org-table-move-column))
  15306. ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
  15307. ((org-at-block-p) (call-interactively 'org-indent-block))
  15308. ((org-with-limited-levels
  15309. (or (org-at-heading-p)
  15310. (and (org-region-active-p)
  15311. (save-excursion
  15312. (goto-char (region-beginning))
  15313. (org-at-heading-p)))))
  15314. (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
  15315. (call-interactively 'org-do-demote))
  15316. ;; At an inline task.
  15317. ((org-at-heading-p)
  15318. (call-interactively 'org-inlinetask-demote))
  15319. ((or (org-at-item-p)
  15320. (and (org-region-active-p)
  15321. (save-excursion
  15322. (goto-char (region-beginning))
  15323. (org-at-item-p))))
  15324. (when (org-check-for-hidden 'items) (org-hidden-tree-error))
  15325. (call-interactively 'org-indent-item))
  15326. (t (call-interactively 'forward-word))))
  15327. (defun org-check-for-hidden (what)
  15328. "Check if there are hidden headlines/items in the current visual line.
  15329. WHAT can be either `headlines' or `items'. If the current line is
  15330. an outline or item heading and it has a folded subtree below it,
  15331. this function returns t, nil otherwise."
  15332. (let ((re (cond
  15333. ((eq what 'headlines) org-outline-regexp-bol)
  15334. ((eq what 'items) (org-item-beginning-re))
  15335. (t (error "This should not happen"))))
  15336. beg end)
  15337. (save-excursion
  15338. (catch 'exit
  15339. (unless (org-region-active-p)
  15340. (setq beg (line-beginning-position))
  15341. (beginning-of-line 2)
  15342. (while (and (not (eobp)) ;; this is like `next-line'
  15343. (org-invisible-p (1- (point))))
  15344. (beginning-of-line 2))
  15345. (setq end (point))
  15346. (goto-char beg)
  15347. (goto-char (line-end-position))
  15348. (setq end (max end (point)))
  15349. (while (re-search-forward re end t)
  15350. (when (org-invisible-p (match-beginning 0))
  15351. (throw 'exit t))))
  15352. nil))))
  15353. (defun org-metaup (&optional _arg)
  15354. "Move subtree up or move table row up.
  15355. Calls `org-move-subtree-up' or `org-table-move-row' or
  15356. `org-move-item-up', depending on context. See the individual commands
  15357. for more information."
  15358. (interactive "P")
  15359. (cond
  15360. ((run-hook-with-args-until-success 'org-metaup-hook))
  15361. ((org-region-active-p)
  15362. (let* ((a (save-excursion
  15363. (goto-char (region-beginning))
  15364. (line-beginning-position)))
  15365. (b (save-excursion
  15366. (goto-char (region-end))
  15367. (if (bolp) (1- (point)) (line-end-position))))
  15368. (c (save-excursion
  15369. (goto-char a)
  15370. (move-beginning-of-line 0)
  15371. (point)))
  15372. (d (save-excursion
  15373. (goto-char a)
  15374. (move-end-of-line 0)
  15375. (point))))
  15376. (transpose-regions a b c d)
  15377. (goto-char c)))
  15378. ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
  15379. ((and (featurep 'org-inlinetask)
  15380. (org-inlinetask-in-task-p))
  15381. (org-drag-element-backward))
  15382. ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
  15383. ((org-at-item-p) (call-interactively 'org-move-item-up))
  15384. (t (org-drag-element-backward))))
  15385. (defun org-metadown (&optional _arg)
  15386. "Move subtree down or move table row down.
  15387. Calls `org-move-subtree-down' or `org-table-move-row' or
  15388. `org-move-item-down', depending on context. See the individual
  15389. commands for more information."
  15390. (interactive "P")
  15391. (cond
  15392. ((run-hook-with-args-until-success 'org-metadown-hook))
  15393. ((org-region-active-p)
  15394. (let* ((a (save-excursion
  15395. (goto-char (region-beginning))
  15396. (line-beginning-position)))
  15397. (b (save-excursion
  15398. (goto-char (region-end))
  15399. (if (bolp) (1- (point)) (line-end-position))))
  15400. (c (save-excursion
  15401. (goto-char b)
  15402. (move-beginning-of-line (if (bolp) 1 2))
  15403. (point)))
  15404. (d (save-excursion
  15405. (goto-char b)
  15406. (move-end-of-line (if (bolp) 1 2))
  15407. (point))))
  15408. (transpose-regions a b c d)
  15409. (goto-char d)))
  15410. ((org-at-table-p) (call-interactively 'org-table-move-row))
  15411. ((and (featurep 'org-inlinetask)
  15412. (org-inlinetask-in-task-p))
  15413. (org-drag-element-forward))
  15414. ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
  15415. ((org-at-item-p) (call-interactively 'org-move-item-down))
  15416. (t (org-drag-element-forward))))
  15417. (defun org-shiftup (&optional arg)
  15418. "Act on current element according to context.
  15419. Call `org-timestamp-up' or `org-priority-up', or
  15420. `org-previous-item', or `org-table-move-cell-up'. See the
  15421. individual commands for more information."
  15422. (interactive "P")
  15423. (cond
  15424. ((run-hook-with-args-until-success 'org-shiftup-hook))
  15425. ((and org-support-shift-select (org-region-active-p))
  15426. (org-call-for-shift-select 'previous-line))
  15427. ((org-at-timestamp-p 'lax)
  15428. (call-interactively (if org-edit-timestamp-down-means-later
  15429. 'org-timestamp-down 'org-timestamp-up)))
  15430. ((and (not (eq org-support-shift-select 'always))
  15431. org-priority-enable-commands
  15432. (org-at-heading-p))
  15433. (call-interactively 'org-priority-up))
  15434. ((and (not org-support-shift-select) (org-at-item-p))
  15435. (call-interactively 'org-previous-item))
  15436. ((org-clocktable-try-shift 'up arg))
  15437. ((and (not (eq org-support-shift-select 'always))
  15438. (org-at-table-p))
  15439. (org-table-move-cell-up))
  15440. ((run-hook-with-args-until-success 'org-shiftup-final-hook))
  15441. (org-support-shift-select
  15442. (org-call-for-shift-select 'previous-line))
  15443. (t (org-shiftselect-error))))
  15444. (defun org-shiftdown (&optional arg)
  15445. "Act on current element according to context.
  15446. Call `org-timestamp-down' or `org-priority-down', or
  15447. `org-next-item', or `org-table-move-cell-down'. See the
  15448. individual commands for more information."
  15449. (interactive "P")
  15450. (cond
  15451. ((run-hook-with-args-until-success 'org-shiftdown-hook))
  15452. ((and org-support-shift-select (org-region-active-p))
  15453. (org-call-for-shift-select 'next-line))
  15454. ((org-at-timestamp-p 'lax)
  15455. (call-interactively (if org-edit-timestamp-down-means-later
  15456. 'org-timestamp-up 'org-timestamp-down)))
  15457. ((and (not (eq org-support-shift-select 'always))
  15458. org-priority-enable-commands
  15459. (org-at-heading-p))
  15460. (call-interactively 'org-priority-down))
  15461. ((and (not org-support-shift-select) (org-at-item-p))
  15462. (call-interactively 'org-next-item))
  15463. ((org-clocktable-try-shift 'down arg))
  15464. ((and (not (eq org-support-shift-select 'always))
  15465. (org-at-table-p))
  15466. (org-table-move-cell-down))
  15467. ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
  15468. (org-support-shift-select
  15469. (org-call-for-shift-select 'next-line))
  15470. (t (org-shiftselect-error))))
  15471. (defun org-shiftright (&optional arg)
  15472. "Act on the current element according to context.
  15473. This does one of the following:
  15474. - switch a timestamp at point one day into the future
  15475. - on a headline, switch to the next TODO keyword
  15476. - on an item, switch entire list to the next bullet type
  15477. - on a property line, switch to the next allowed value
  15478. - on a clocktable definition line, move time block into the future
  15479. - in a table, move a single cell right"
  15480. (interactive "P")
  15481. (cond
  15482. ((run-hook-with-args-until-success 'org-shiftright-hook))
  15483. ((and org-support-shift-select (org-region-active-p))
  15484. (org-call-for-shift-select 'forward-char))
  15485. ((org-at-timestamp-p 'lax) (call-interactively 'org-timestamp-up-day))
  15486. ((and (not (eq org-support-shift-select 'always))
  15487. (org-at-heading-p))
  15488. (let ((org-inhibit-logging
  15489. (not org-treat-S-cursor-todo-selection-as-state-change))
  15490. (org-inhibit-blocking
  15491. (not org-treat-S-cursor-todo-selection-as-state-change)))
  15492. (org-call-with-arg 'org-todo 'right)))
  15493. ((or (and org-support-shift-select
  15494. (not (eq org-support-shift-select 'always))
  15495. (org-at-item-bullet-p))
  15496. (and (not org-support-shift-select) (org-at-item-p)))
  15497. (org-call-with-arg 'org-cycle-list-bullet nil))
  15498. ((and (not (eq org-support-shift-select 'always))
  15499. (org-at-property-p))
  15500. (call-interactively 'org-property-next-allowed-value))
  15501. ((org-clocktable-try-shift 'right arg))
  15502. ((and (not (eq org-support-shift-select 'always))
  15503. (org-at-table-p))
  15504. (org-table-move-cell-right))
  15505. ((run-hook-with-args-until-success 'org-shiftright-final-hook))
  15506. (org-support-shift-select
  15507. (org-call-for-shift-select 'forward-char))
  15508. (t (org-shiftselect-error))))
  15509. (defun org-shiftleft (&optional arg)
  15510. "Act on current element according to context.
  15511. This does one of the following:
  15512. - switch a timestamp at point one day into the past
  15513. - on a headline, switch to the previous TODO keyword.
  15514. - on an item, switch entire list to the previous bullet type
  15515. - on a property line, switch to the previous allowed value
  15516. - on a clocktable definition line, move time block into the past
  15517. - in a table, move a single cell left"
  15518. (interactive "P")
  15519. (cond
  15520. ((run-hook-with-args-until-success 'org-shiftleft-hook))
  15521. ((and org-support-shift-select (org-region-active-p))
  15522. (org-call-for-shift-select 'backward-char))
  15523. ((org-at-timestamp-p 'lax) (call-interactively 'org-timestamp-down-day))
  15524. ((and (not (eq org-support-shift-select 'always))
  15525. (org-at-heading-p))
  15526. (let ((org-inhibit-logging
  15527. (not org-treat-S-cursor-todo-selection-as-state-change))
  15528. (org-inhibit-blocking
  15529. (not org-treat-S-cursor-todo-selection-as-state-change)))
  15530. (org-call-with-arg 'org-todo 'left)))
  15531. ((or (and org-support-shift-select
  15532. (not (eq org-support-shift-select 'always))
  15533. (org-at-item-bullet-p))
  15534. (and (not org-support-shift-select) (org-at-item-p)))
  15535. (org-call-with-arg 'org-cycle-list-bullet 'previous))
  15536. ((and (not (eq org-support-shift-select 'always))
  15537. (org-at-property-p))
  15538. (call-interactively 'org-property-previous-allowed-value))
  15539. ((org-clocktable-try-shift 'left arg))
  15540. ((and (not (eq org-support-shift-select 'always))
  15541. (org-at-table-p))
  15542. (org-table-move-cell-left))
  15543. ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
  15544. (org-support-shift-select
  15545. (org-call-for-shift-select 'backward-char))
  15546. (t (org-shiftselect-error))))
  15547. (defun org-shiftcontrolright ()
  15548. "Switch to next TODO set."
  15549. (interactive)
  15550. (cond
  15551. ((and org-support-shift-select (org-region-active-p))
  15552. (org-call-for-shift-select 'forward-word))
  15553. ((and (not (eq org-support-shift-select 'always))
  15554. (org-at-heading-p))
  15555. (org-call-with-arg 'org-todo 'nextset))
  15556. (org-support-shift-select
  15557. (org-call-for-shift-select 'forward-word))
  15558. (t (org-shiftselect-error))))
  15559. (defun org-shiftcontrolleft ()
  15560. "Switch to previous TODO set."
  15561. (interactive)
  15562. (cond
  15563. ((and org-support-shift-select (org-region-active-p))
  15564. (org-call-for-shift-select 'backward-word))
  15565. ((and (not (eq org-support-shift-select 'always))
  15566. (org-at-heading-p))
  15567. (org-call-with-arg 'org-todo 'previousset))
  15568. (org-support-shift-select
  15569. (org-call-for-shift-select 'backward-word))
  15570. (t (org-shiftselect-error))))
  15571. (defun org-shiftcontrolup (&optional n)
  15572. "Change timestamps synchronously up in CLOCK log lines.
  15573. Optional argument N tells to change by that many units."
  15574. (interactive "P")
  15575. (if (and (org-at-clock-log-p) (org-at-timestamp-p 'lax))
  15576. (let (org-support-shift-select)
  15577. (org-clock-timestamps-up n))
  15578. (user-error "Not at a clock log")))
  15579. (defun org-shiftcontroldown (&optional n)
  15580. "Change timestamps synchronously down in CLOCK log lines.
  15581. Optional argument N tells to change by that many units."
  15582. (interactive "P")
  15583. (if (and (org-at-clock-log-p) (org-at-timestamp-p 'lax))
  15584. (let (org-support-shift-select)
  15585. (org-clock-timestamps-down n))
  15586. (user-error "Not at a clock log")))
  15587. (defun org-increase-number-at-point (&optional inc)
  15588. "Increment the number at point.
  15589. With an optional prefix numeric argument INC, increment using
  15590. this numeric value."
  15591. (interactive "p")
  15592. (if (not (number-at-point))
  15593. (user-error "Not on a number")
  15594. (unless inc (setq inc 1))
  15595. (let ((pos (point))
  15596. (beg (skip-chars-backward "-+^/*0-9eE."))
  15597. (end (skip-chars-forward "-+^/*0-9eE.")) nap)
  15598. (setq nap (buffer-substring-no-properties
  15599. (+ pos beg) (+ pos beg end)))
  15600. (delete-region (+ pos beg) (+ pos beg end))
  15601. (insert (calc-eval (concat (number-to-string inc) "+" nap))))
  15602. (when (org-at-table-p)
  15603. (org-table-align)
  15604. (org-table-end-of-field 1))))
  15605. (defun org-decrease-number-at-point (&optional inc)
  15606. "Decrement the number at point.
  15607. With an optional prefix numeric argument INC, decrement using
  15608. this numeric value."
  15609. (interactive "p")
  15610. (org-increase-number-at-point (- (or inc 1))))
  15611. (defun org-ctrl-c-ret ()
  15612. "Call `org-table-hline-and-move' or `org-insert-heading'."
  15613. (interactive)
  15614. (cond
  15615. ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
  15616. (t (call-interactively 'org-insert-heading))))
  15617. (defun org-copy-visible (beg end)
  15618. "Copy the visible parts of the region."
  15619. (interactive "r")
  15620. (let ((result ""))
  15621. (while (/= beg end)
  15622. (if (eq org-fold-core-style 'text-properties)
  15623. (progn
  15624. (while (org-invisible-p beg)
  15625. (setq beg (org-fold-next-visibility-change beg end)))
  15626. (let ((next (org-fold-next-visibility-change beg end)))
  15627. (setq result (concat result (buffer-substring beg next)))
  15628. (setq beg next)))
  15629. (when (invisible-p beg)
  15630. (setq beg (next-single-char-property-change beg 'invisible nil end)))
  15631. (let ((next (next-single-char-property-change beg 'invisible nil end)))
  15632. (setq result (concat result (buffer-substring beg next)))
  15633. (setq beg next))))
  15634. ;; Prevent Emacs from adding full selected text to `kill-ring'
  15635. ;; when `select-enable-primary' is non-nil. This special value of
  15636. ;; `deactivate-mark' only works since Emacs 29.
  15637. (setq deactivate-mark 'dont-save)
  15638. (kill-new result)
  15639. (message "Visible strings have been copied to the kill ring.")))
  15640. (defun org-copy-special ()
  15641. "Copy region in table or copy current subtree.
  15642. Calls `org-table-copy-region' or `org-copy-subtree', depending on
  15643. context. See the individual commands for more information."
  15644. (interactive)
  15645. (call-interactively
  15646. (if (org-at-table-p) #'org-table-copy-region #'org-copy-subtree)))
  15647. (defun org-cut-special ()
  15648. "Cut region in table or cut current subtree.
  15649. Calls `org-table-cut-region' or `org-cut-subtree', depending on
  15650. context. See the individual commands for more information."
  15651. (interactive)
  15652. (call-interactively
  15653. (if (org-at-table-p) #'org-table-cut-region #'org-cut-subtree)))
  15654. (defun org-paste-special (arg)
  15655. "Paste rectangular region into table, or past subtree relative to level.
  15656. Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
  15657. See the individual commands for more information."
  15658. (interactive "P")
  15659. (if (org-at-table-p)
  15660. (org-table-paste-rectangle)
  15661. (org-paste-subtree arg)))
  15662. (defun org-edit-special (&optional arg)
  15663. "Call a special editor for the element at point.
  15664. When at a table, call the formula editor with `org-table-edit-formulas'.
  15665. When in a source code block, call `org-edit-src-code'.
  15666. When in a fixed-width region, call `org-edit-fixed-width-region'.
  15667. When in an export block, call `org-edit-export-block'.
  15668. When in a comment block, call `org-edit-comment-block'.
  15669. When in a LaTeX environment, call `org-edit-latex-environment'.
  15670. When at an INCLUDE, SETUPFILE or BIBLIOGRAPHY keyword, visit the included file.
  15671. When at a footnote reference, call `org-edit-footnote-reference'.
  15672. When at a planning line call, `org-deadline' and/or `org-schedule'.
  15673. When at an active timestamp, call `org-time-stamp'.
  15674. When at an inactive timestamp, call `org-time-stamp-inactive'.
  15675. On a link, call `ffap' to visit the link at point.
  15676. Otherwise, return a user error."
  15677. (interactive "P")
  15678. (let ((element (org-element-at-point)))
  15679. (barf-if-buffer-read-only)
  15680. (pcase (org-element-type element)
  15681. (`src-block
  15682. (if (not arg) (org-edit-src-code)
  15683. (let* ((info (org-babel-get-src-block-info))
  15684. (lang (nth 0 info))
  15685. (params (nth 2 info))
  15686. (session (cdr (assq :session params))))
  15687. (if (not session) (org-edit-src-code)
  15688. ;; At a source block with a session and function called
  15689. ;; with an ARG: switch to the buffer related to the
  15690. ;; inferior process.
  15691. (switch-to-buffer
  15692. (funcall (intern (concat "org-babel-prep-session:" lang))
  15693. session params))))))
  15694. (`keyword
  15695. (unless (member (org-element-property :key element)
  15696. '("BIBLIOGRAPHY" "INCLUDE" "SETUPFILE"))
  15697. (user-error "No special environment to edit here"))
  15698. (let ((value (org-element-property :value element)))
  15699. (unless (org-string-nw-p value) (user-error "No file to edit"))
  15700. (let ((file (and (string-match "\\`\"\\(.*?\\)\"\\|\\S-+" value)
  15701. (or (match-string 1 value)
  15702. (match-string 0 value)))))
  15703. (when (org-url-p file)
  15704. (user-error "Files located with a URL cannot be edited"))
  15705. (org-link-open-from-string
  15706. (format "[[%s]]" (expand-file-name file))))))
  15707. (`table
  15708. (if (eq (org-element-property :type element) 'table.el)
  15709. (org-edit-table.el)
  15710. (call-interactively 'org-table-edit-formulas)))
  15711. ;; Only Org tables contain `table-row' type elements.
  15712. (`table-row (call-interactively 'org-table-edit-formulas))
  15713. (`example-block (org-edit-src-code))
  15714. (`export-block (org-edit-export-block))
  15715. (`comment-block (org-edit-comment-block))
  15716. (`fixed-width (org-edit-fixed-width-region))
  15717. (`latex-environment (org-edit-latex-environment))
  15718. (`planning
  15719. (let ((proplist (cadr element)))
  15720. (mapc #'call-interactively
  15721. (remq nil
  15722. (list
  15723. (when (plist-get proplist :deadline) #'org-deadline)
  15724. (when (plist-get proplist :scheduled) #'org-schedule))))))
  15725. (_
  15726. ;; No notable element at point. Though, we may be at a link or
  15727. ;; a footnote reference, which are objects. Thus, scan deeper.
  15728. (let ((context (org-element-context element)))
  15729. (pcase (org-element-type context)
  15730. (`footnote-reference (org-edit-footnote-reference))
  15731. (`inline-src-block (org-edit-inline-src-code))
  15732. (`latex-fragment (org-edit-latex-fragment))
  15733. (`timestamp (if (eq 'inactive (org-element-property :type context))
  15734. (call-interactively #'org-time-stamp-inactive)
  15735. (call-interactively #'org-time-stamp)))
  15736. (`link (call-interactively #'ffap))
  15737. (_ (user-error "No special environment to edit here"))))))))
  15738. (defun org-ctrl-c-ctrl-c (&optional arg)
  15739. "Set tags in headline, or update according to changed information at point.
  15740. This command does many different things, depending on context:
  15741. - If column view is active, in agenda or org buffers, quit it.
  15742. - If there are highlights, remove them.
  15743. - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
  15744. this is what we do.
  15745. - If the cursor is on a statistics cookie, update it.
  15746. - If the cursor is in a headline, in an agenda or an org buffer,
  15747. prompt for tags and insert them into the current line, aligned
  15748. to `org-tags-column'. When called with prefix arg, realign all
  15749. tags in the current buffer.
  15750. - If the cursor is in one of the special #+KEYWORD lines, this
  15751. triggers scanning the buffer for these lines and updating the
  15752. information.
  15753. - If the cursor is inside a table, realign the table. This command
  15754. works even if the automatic table editor has been turned off.
  15755. - If the cursor is on a #+TBLFM line, re-apply the formulas to
  15756. the entire table.
  15757. - If the cursor is at a footnote reference or definition, jump to
  15758. the corresponding definition or references, respectively.
  15759. - If the cursor is a the beginning of a dynamic block, update it.
  15760. - If the current buffer is a capture buffer, close note and file it.
  15761. - If the cursor is on a <<<target>>>, update radio targets and
  15762. corresponding links in this buffer.
  15763. - If the cursor is on a numbered item in a plain list, renumber the
  15764. ordered list.
  15765. - If the cursor is on a checkbox, toggle it.
  15766. - If the cursor is on a code block, evaluate it. The variable
  15767. `org-confirm-babel-evaluate' can be used to control prompting
  15768. before code block evaluation, by default every code block
  15769. evaluation requires confirmation. Code block evaluation can be
  15770. inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
  15771. (interactive "P")
  15772. (cond
  15773. ((bound-and-true-p org-columns-overlays) (org-columns-quit))
  15774. ((or (bound-and-true-p org-clock-overlays) org-occur-highlights)
  15775. (when (boundp 'org-clock-overlays) (org-clock-remove-overlays))
  15776. (org-remove-occur-highlights)
  15777. (message "Temporary highlights/overlays removed from current buffer"))
  15778. ((and (local-variable-p 'org-finish-function)
  15779. (fboundp org-finish-function))
  15780. (funcall org-finish-function))
  15781. ((org-babel-hash-at-point))
  15782. ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
  15783. (t
  15784. (let* ((context
  15785. (org-element-lineage
  15786. (org-element-context)
  15787. ;; Limit to supported contexts.
  15788. '(babel-call clock dynamic-block footnote-definition
  15789. footnote-reference inline-babel-call inline-src-block
  15790. inlinetask item keyword node-property paragraph
  15791. plain-list planning property-drawer radio-target
  15792. src-block statistics-cookie table table-cell table-row
  15793. timestamp)
  15794. t))
  15795. (radio-list-p (org-at-radio-list-p))
  15796. (type (org-element-type context)))
  15797. ;; For convenience: at the first line of a paragraph on the same
  15798. ;; line as an item, apply function on that item instead.
  15799. (when (eq type 'paragraph)
  15800. (let ((parent (org-element-property :parent context)))
  15801. (when (and (eq (org-element-type parent) 'item)
  15802. (= (line-beginning-position)
  15803. (org-element-property :begin parent)))
  15804. (setq context parent)
  15805. (setq type 'item))))
  15806. ;; Act according to type of element or object at point.
  15807. ;;
  15808. ;; Do nothing on a blank line, except if it is contained in
  15809. ;; a source block. Hence, we first check if point is in such
  15810. ;; a block and then if it is at a blank line.
  15811. (pcase type
  15812. ((or `inline-src-block `src-block)
  15813. (unless org-babel-no-eval-on-ctrl-c-ctrl-c
  15814. (org-babel-eval-wipe-error-buffer)
  15815. (org-babel-execute-src-block
  15816. current-prefix-arg (org-babel-get-src-block-info nil context))))
  15817. ((guard (org-match-line "[ \t]*$"))
  15818. (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
  15819. (user-error
  15820. (substitute-command-keys
  15821. "`\\[org-ctrl-c-ctrl-c]' can do nothing useful here"))))
  15822. ((or `babel-call `inline-babel-call)
  15823. (let ((info (org-babel-lob-get-info context)))
  15824. (when info (org-babel-execute-src-block nil info nil type))))
  15825. (`clock
  15826. (if (org-at-timestamp-p 'lax)
  15827. ;; Update the timestamp as well. `org-timestamp-change'
  15828. ;; will call `org-clock-update-time-maybe'.
  15829. (org-timestamp-change 0 'day)
  15830. (org-clock-update-time-maybe)))
  15831. (`dynamic-block
  15832. (save-excursion
  15833. (goto-char (org-element-property :post-affiliated context))
  15834. (org-update-dblock)))
  15835. (`footnote-definition
  15836. (goto-char (org-element-property :post-affiliated context))
  15837. (call-interactively 'org-footnote-action))
  15838. (`footnote-reference (call-interactively #'org-footnote-action))
  15839. ((or `headline `inlinetask)
  15840. (save-excursion (goto-char (org-element-property :begin context))
  15841. (call-interactively #'org-set-tags-command)))
  15842. (`item
  15843. ;; At an item: `C-u C-u' sets checkbox to "[-]"
  15844. ;; unconditionally, whereas `C-u' will toggle its presence.
  15845. ;; Without a universal argument, if the item has a checkbox,
  15846. ;; toggle it. Otherwise repair the list.
  15847. (if (or radio-list-p
  15848. (and (boundp org-list-checkbox-radio-mode)
  15849. org-list-checkbox-radio-mode))
  15850. (org-toggle-radio-button arg)
  15851. (let* ((box (org-element-property :checkbox context))
  15852. (struct (org-element-property :structure context))
  15853. (old-struct (copy-tree struct))
  15854. (parents (org-list-parents-alist struct))
  15855. (prevs (org-list-prevs-alist struct))
  15856. (orderedp (org-not-nil (org-entry-get nil "ORDERED"))))
  15857. (org-list-set-checkbox
  15858. (org-element-property :begin context) struct
  15859. (cond ((equal arg '(16)) "[-]")
  15860. ((and (not box) (equal arg '(4))) "[ ]")
  15861. ((or (not box) (equal arg '(4))) nil)
  15862. ((eq box 'on) "[ ]")
  15863. (t "[X]")))
  15864. ;; Mimic `org-list-write-struct' but with grabbing a return
  15865. ;; value from `org-list-struct-fix-box'.
  15866. (org-list-struct-fix-ind struct parents 2)
  15867. (org-list-struct-fix-item-end struct)
  15868. (org-list-struct-fix-bul struct prevs)
  15869. (org-list-struct-fix-ind struct parents)
  15870. (let ((block-item
  15871. (org-list-struct-fix-box struct parents prevs orderedp)))
  15872. (if (and box (equal struct old-struct))
  15873. (if (equal arg '(16))
  15874. (message "Checkboxes already reset")
  15875. (user-error "Cannot toggle this checkbox: %s"
  15876. (if (eq box 'on)
  15877. "all subitems checked"
  15878. "unchecked subitems")))
  15879. (org-list-struct-apply-struct struct old-struct)
  15880. (org-update-checkbox-count-maybe))
  15881. (when block-item
  15882. (message "Checkboxes were removed due to empty box at line %d"
  15883. (org-current-line block-item)))))))
  15884. (`plain-list
  15885. ;; At a plain list, with a double C-u argument, set
  15886. ;; checkboxes of each item to "[-]", whereas a single one
  15887. ;; will toggle their presence according to the state of the
  15888. ;; first item in the list. Without an argument, repair the
  15889. ;; list.
  15890. (if (or radio-list-p
  15891. (and (boundp org-list-checkbox-radio-mode)
  15892. org-list-checkbox-radio-mode))
  15893. (org-toggle-radio-button arg)
  15894. (let* ((begin (org-element-property :contents-begin context))
  15895. (struct (org-element-property :structure context))
  15896. (old-struct (copy-tree struct))
  15897. (first-box (save-excursion
  15898. (goto-char begin)
  15899. (looking-at org-list-full-item-re)
  15900. (match-string-no-properties 3)))
  15901. (new-box (cond ((equal arg '(16)) "[-]")
  15902. ((equal arg '(4)) (unless first-box "[ ]"))
  15903. ((equal first-box "[X]") "[ ]")
  15904. (t "[X]"))))
  15905. (cond
  15906. (arg
  15907. (dolist (pos
  15908. (org-list-get-all-items
  15909. begin struct (org-list-prevs-alist struct)))
  15910. (org-list-set-checkbox pos struct new-box)))
  15911. ((and first-box (eq (point) begin))
  15912. ;; For convenience, when point is at bol on the first
  15913. ;; item of the list and no argument is provided, simply
  15914. ;; toggle checkbox of that item, if any.
  15915. (org-list-set-checkbox begin struct new-box)))
  15916. (when (equal
  15917. (org-list-write-struct
  15918. struct (org-list-parents-alist struct) old-struct)
  15919. old-struct)
  15920. (message "Cannot update this checkbox"))
  15921. (org-update-checkbox-count-maybe))))
  15922. (`keyword
  15923. (let ((org-inhibit-startup-visibility-stuff t)
  15924. (org-startup-align-all-tables nil))
  15925. (when (boundp 'org-table-coordinate-overlays)
  15926. (mapc #'delete-overlay org-table-coordinate-overlays)
  15927. (setq org-table-coordinate-overlays nil))
  15928. (org-save-outline-visibility 'use-markers (org-mode-restart)))
  15929. (message "Local setup has been refreshed"))
  15930. ((or `property-drawer `node-property)
  15931. (call-interactively #'org-property-action))
  15932. (`radio-target
  15933. (call-interactively #'org-update-radio-target-regexp))
  15934. (`statistics-cookie
  15935. (call-interactively #'org-update-statistics-cookies))
  15936. ((or `table `table-cell `table-row)
  15937. ;; At a table, generate a plot if on the #+plot line,
  15938. ;; recalculate every field and align it otherwise. Also
  15939. ;; send the table if necessary.
  15940. (cond
  15941. ((and (org-match-line "[ \t]*#\\+plot:")
  15942. (< (point) (org-element-property :post-affiliated context)))
  15943. (org-plot/gnuplot))
  15944. ;; If the table has a `table.el' type, just give up.
  15945. ((eq (org-element-property :type context) 'table.el)
  15946. (message "%s" (substitute-command-keys "\\<org-mode-map>\
  15947. Use `\\[org-edit-special]' to edit table.el tables")))
  15948. ;; At a table row or cell, maybe recalculate line but always
  15949. ;; align table.
  15950. ((or (eq type 'table)
  15951. ;; Check if point is at a TBLFM line.
  15952. (and (eq type 'table-row)
  15953. (= (point) (org-element-property :end context))))
  15954. (save-excursion
  15955. (if (org-at-TBLFM-p)
  15956. (progn (require 'org-table)
  15957. (org-table-calc-current-TBLFM))
  15958. (goto-char (org-element-property :contents-begin context))
  15959. (org-call-with-arg 'org-table-recalculate (or arg t))
  15960. (orgtbl-send-table 'maybe))))
  15961. (t
  15962. (org-table-maybe-eval-formula)
  15963. (cond (arg (call-interactively #'org-table-recalculate))
  15964. ((org-table-maybe-recalculate-line))
  15965. (t (org-table-align))))))
  15966. ((or `timestamp (and `planning (guard (org-at-timestamp-p 'lax))))
  15967. (org-timestamp-change 0 'day))
  15968. ((and `nil (guard (org-at-heading-p)))
  15969. ;; When point is on an unsupported object type, we can miss
  15970. ;; the fact that it also is at a heading. Handle it here.
  15971. (call-interactively #'org-set-tags-command))
  15972. ((guard
  15973. (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)))
  15974. (_
  15975. (user-error
  15976. (substitute-command-keys
  15977. "`\\[org-ctrl-c-ctrl-c]' can do nothing useful here"))))))))
  15978. (defun org-mode-restart ()
  15979. "Restart `org-mode'."
  15980. (interactive)
  15981. (let ((indent-status (bound-and-true-p org-indent-mode)))
  15982. (funcall major-mode)
  15983. (hack-local-variables)
  15984. (when (and indent-status (not (bound-and-true-p org-indent-mode)))
  15985. (org-indent-mode -1))
  15986. (org-reset-file-cache))
  15987. (message "%s restarted" major-mode))
  15988. (defun org-kill-note-or-show-branches ()
  15989. "Abort storing current note, or show just branches."
  15990. (interactive)
  15991. (cond (org-finish-function
  15992. (let ((org-note-abort t)) (funcall org-finish-function)))
  15993. ((org-before-first-heading-p)
  15994. (org-fold-show-branches-buffer)
  15995. (org-fold-hide-archived-subtrees (point-min) (point-max)))
  15996. (t
  15997. (let ((beg (progn (org-back-to-heading) (point)))
  15998. (end (save-excursion (org-end-of-subtree t t) (point))))
  15999. (org-fold-hide-subtree)
  16000. (org-fold-show-branches)
  16001. (org-fold-hide-archived-subtrees beg end)))))
  16002. (defun org-delete-indentation (&optional arg)
  16003. "Join current line to previous and fix whitespace at join.
  16004. If previous line is a headline add to headline title. Otherwise
  16005. the function calls `delete-indentation'.
  16006. I.e. with a non-nil optional argument, join the line with the
  16007. following one. If there is a region then join the lines in that
  16008. region."
  16009. (interactive "*P")
  16010. (if (save-excursion
  16011. (beginning-of-line (if arg 1 0))
  16012. (let ((case-fold-search nil))
  16013. (looking-at org-complex-heading-regexp)))
  16014. ;; At headline.
  16015. (let ((tags-column (when (match-beginning 5)
  16016. (save-excursion (goto-char (match-beginning 5))
  16017. (current-column))))
  16018. (string (concat " " (progn (when arg (forward-line 1))
  16019. (org-trim (delete-and-extract-region
  16020. (line-beginning-position)
  16021. (line-end-position)))))))
  16022. (unless (bobp) (delete-region (point) (1- (point))))
  16023. (goto-char (or (match-end 4)
  16024. (match-beginning 5)
  16025. (match-end 0)))
  16026. (skip-chars-backward " \t")
  16027. (save-excursion (insert string))
  16028. ;; Adjust alignment of tags.
  16029. (cond
  16030. ((not tags-column)) ;no tags
  16031. (org-auto-align-tags (org-align-tags))
  16032. (t (org--align-tags-here tags-column)))) ;preserve tags column
  16033. (let ((current-prefix-arg arg))
  16034. (call-interactively #'delete-indentation))))
  16035. (defun org-open-line (n)
  16036. "Insert a new row in tables, call `open-line' elsewhere.
  16037. If `org-special-ctrl-o' is nil, just call `open-line' everywhere.
  16038. As a special case, when a document starts with a table, allow to
  16039. call `open-line' on the very first character."
  16040. (interactive "*p")
  16041. (if (and org-special-ctrl-o (/= (point) 1) (org-at-table-p))
  16042. (org-table-insert-row)
  16043. (open-line n)))
  16044. (defun org--newline (indent arg interactive)
  16045. "Call `newline-and-indent' or just `newline'.
  16046. If INDENT is non-nil, call `newline-and-indent' with ARG to
  16047. indent unconditionally; otherwise, call `newline' with ARG and
  16048. INTERACTIVE, which can trigger indentation if
  16049. `electric-indent-mode' is enabled."
  16050. (if indent
  16051. (org-newline-and-indent arg)
  16052. (newline arg interactive)))
  16053. (defun org-return (&optional indent arg interactive)
  16054. "Goto next table row or insert a newline.
  16055. Calls `org-table-next-row' or `newline', depending on context.
  16056. When optional INDENT argument is non-nil, call
  16057. `newline-and-indent' with ARG, otherwise call `newline' with ARG
  16058. and INTERACTIVE.
  16059. When `org-return-follows-link' is non-nil and point is on
  16060. a timestamp or a link, call `org-open-at-point'. However, it
  16061. will not happen if point is in a table or on a \"dead\"
  16062. object (e.g., within a comment). In these case, you need to use
  16063. `org-open-at-point' directly."
  16064. (interactive "i\nP\np")
  16065. (let* ((context (if org-return-follows-link (org-element-context)
  16066. (org-element-at-point)))
  16067. (element-type (org-element-type context)))
  16068. (cond
  16069. ;; In a table, call `org-table-next-row'. However, before first
  16070. ;; column or after last one, split the table.
  16071. ((or (and (eq 'table element-type)
  16072. (not (eq 'table.el (org-element-property :type context)))
  16073. (>= (point) (org-element-property :contents-begin context))
  16074. (< (point) (org-element-property :contents-end context)))
  16075. (org-element-lineage context '(table-row table-cell) t))
  16076. (if (or (looking-at-p "[ \t]*$")
  16077. (save-excursion (skip-chars-backward " \t") (bolp)))
  16078. (insert "\n")
  16079. (org-table-justify-field-maybe)
  16080. (call-interactively #'org-table-next-row)))
  16081. ;; On a link or a timestamp, call `org-open-at-point' if
  16082. ;; `org-return-follows-link' allows it. Tolerate fuzzy
  16083. ;; locations, e.g., in a comment, as `org-open-at-point'.
  16084. ((and org-return-follows-link
  16085. (or (and (eq 'link element-type)
  16086. ;; Ensure point is not on the white spaces after
  16087. ;; the link.
  16088. (let ((origin (point)))
  16089. (org-with-point-at (org-element-property :end context)
  16090. (skip-chars-backward " \t")
  16091. (> (point) origin))))
  16092. (org-in-regexp org-ts-regexp-both nil t)
  16093. (org-in-regexp org-tsr-regexp-both nil t)
  16094. (org-in-regexp org-link-any-re nil t)))
  16095. (call-interactively #'org-open-at-point))
  16096. ;; Insert newline in heading, but preserve tags.
  16097. ((and (not (bolp))
  16098. (let ((case-fold-search nil))
  16099. (org-match-line org-complex-heading-regexp)))
  16100. ;; At headline. Split line. However, if point is on keyword,
  16101. ;; priority cookie or tags, do not break any of them: add
  16102. ;; a newline after the headline instead.
  16103. (let ((tags-column (and (match-beginning 5)
  16104. (save-excursion (goto-char (match-beginning 5))
  16105. (current-column))))
  16106. (string
  16107. (when (and (match-end 4) (org-point-in-group (point) 4))
  16108. (delete-and-extract-region (point) (match-end 4)))))
  16109. ;; Adjust tag alignment.
  16110. (cond
  16111. ((not (and tags-column string)))
  16112. (org-auto-align-tags (org-align-tags))
  16113. (t (org--align-tags-here tags-column))) ;preserve tags column
  16114. (end-of-line)
  16115. (org-fold-show-entry 'hide-drawers)
  16116. (org--newline indent arg interactive)
  16117. (when string (save-excursion (insert (org-trim string))))))
  16118. ;; In a list, make sure indenting keeps trailing text within.
  16119. ((and (not (eolp))
  16120. (org-element-lineage context '(item)))
  16121. (let ((trailing-data
  16122. (delete-and-extract-region (point) (line-end-position))))
  16123. (org--newline indent arg interactive)
  16124. (save-excursion (insert trailing-data))))
  16125. (t
  16126. ;; Do not auto-fill when point is in an Org property drawer.
  16127. (let ((auto-fill-function (and (not (org-at-property-p))
  16128. auto-fill-function)))
  16129. (org--newline indent arg interactive))))))
  16130. (defun org-return-and-maybe-indent ()
  16131. "Goto next table row, or insert a newline, maybe indented.
  16132. Call `org-table-next-row' or `org-return', depending on context.
  16133. See the individual commands for more information.
  16134. When inserting a newline, if `org-adapt-indentation' is t:
  16135. indent the line if `electric-indent-mode' is disabled, don't
  16136. indent it if it is enabled."
  16137. (interactive)
  16138. (org-return (not electric-indent-mode)))
  16139. (defun org-ctrl-c-tab (&optional arg)
  16140. "Toggle columns width in a table, or show children.
  16141. Call `org-table-toggle-column-width' if point is in a table.
  16142. Otherwise provide a compact view of the children. ARG is the
  16143. level to hide."
  16144. (interactive "p")
  16145. (cond
  16146. ((org-at-table-p)
  16147. (call-interactively #'org-table-toggle-column-width))
  16148. ((org-before-first-heading-p)
  16149. (save-excursion
  16150. (org-fold-flag-above-first-heading)
  16151. (org-fold-hide-sublevels (or arg 1))))
  16152. (t
  16153. (org-fold-hide-subtree)
  16154. (org-fold-show-children arg))))
  16155. (defun org-ctrl-c-star ()
  16156. "Compute table, or change heading status of lines.
  16157. Calls `org-table-recalculate' or `org-toggle-heading',
  16158. depending on context."
  16159. (interactive)
  16160. (cond
  16161. ((org-at-table-p)
  16162. (call-interactively 'org-table-recalculate))
  16163. (t
  16164. ;; Convert all lines in region to list items
  16165. (call-interactively 'org-toggle-heading))))
  16166. (defun org-ctrl-c-minus ()
  16167. "Insert separator line in table or modify bullet status of line.
  16168. Also turns a plain line or a region of lines into list items.
  16169. Calls `org-table-insert-hline', `org-toggle-item', or
  16170. `org-cycle-list-bullet', depending on context."
  16171. (interactive)
  16172. (cond
  16173. ((org-at-table-p)
  16174. (call-interactively 'org-table-insert-hline))
  16175. ((org-region-active-p)
  16176. (call-interactively 'org-toggle-item))
  16177. ((org-in-item-p)
  16178. (call-interactively 'org-cycle-list-bullet))
  16179. (t
  16180. (call-interactively 'org-toggle-item))))
  16181. (defun org-toggle-heading (&optional nstars)
  16182. "Convert headings to normal text, or items or text to headings.
  16183. If there is no active region, only convert the current line.
  16184. With a `\\[universal-argument]' prefix, convert the whole list at
  16185. point into heading.
  16186. In a region:
  16187. - If the first non blank line is a headline, remove the stars
  16188. from all headlines in the region.
  16189. - If it is a normal line, turn each and every normal line (i.e.,
  16190. not an heading or an item) in the region into headings. If you
  16191. want to convert only the first line of this region, use one
  16192. universal prefix argument.
  16193. - If it is a plain list item, turn all plain list items into headings.
  16194. The checkboxes are converted to appropriate TODO or DONE keywords
  16195. (using `car' or `org-done-keywords' and `org-not-done-keywords' when
  16196. available).
  16197. When converting a line into a heading, the number of stars is chosen
  16198. such that the lines become children of the current entry. However,
  16199. when a numeric prefix argument is given, its value determines the
  16200. number of stars to add."
  16201. (interactive "P")
  16202. (let ((skip-blanks
  16203. ;; Return beginning of first non-blank line, starting from
  16204. ;; line at POS.
  16205. (lambda (pos)
  16206. (save-excursion
  16207. (goto-char pos)
  16208. (while (org-at-comment-p) (forward-line))
  16209. (skip-chars-forward " \r\t\n")
  16210. (line-beginning-position))))
  16211. beg end toggled)
  16212. ;; Determine boundaries of changes. If a universal prefix has
  16213. ;; been given, put the list in a region. If region ends at a bol,
  16214. ;; do not consider the last line to be in the region.
  16215. (when (and current-prefix-arg (org-at-item-p))
  16216. (when (listp current-prefix-arg) (setq current-prefix-arg 1))
  16217. (org-mark-element))
  16218. (if (org-region-active-p)
  16219. (setq beg (funcall skip-blanks (region-beginning))
  16220. end (copy-marker (save-excursion
  16221. (goto-char (region-end))
  16222. (if (bolp) (point) (line-end-position)))))
  16223. (setq beg (funcall skip-blanks (line-beginning-position))
  16224. end (copy-marker (line-end-position))))
  16225. ;; Ensure inline tasks don't count as headings.
  16226. (org-with-limited-levels
  16227. (save-excursion
  16228. (goto-char beg)
  16229. (cond
  16230. ;; Case 1. Started at an heading: de-star headings.
  16231. ((org-at-heading-p)
  16232. (while (< (point) end)
  16233. (when (org-at-heading-p)
  16234. (looking-at org-outline-regexp) (replace-match "")
  16235. (setq toggled t))
  16236. (forward-line)))
  16237. ;; Case 2. Started at an item: change items into headlines.
  16238. ;; One star will be added by `org-list-to-subtree'.
  16239. ((org-at-item-p)
  16240. (while (< (point) end)
  16241. (when (org-at-item-p)
  16242. ;; Pay attention to cases when region ends before list.
  16243. (let* ((struct (org-list-struct))
  16244. (list-end
  16245. (min (org-list-get-bottom-point struct) (1+ end))))
  16246. (save-restriction
  16247. (narrow-to-region (point) list-end)
  16248. (insert (org-list-to-subtree
  16249. (org-list-to-lisp t)
  16250. (pcase (org-current-level)
  16251. (`nil 1)
  16252. (l (1+ (org-reduced-level l))))
  16253. ;; Keywords to replace checkboxes.
  16254. (list
  16255. ;; [X]
  16256. :cbon (concat (or (car org-done-keywords) "DONE") " ")
  16257. ;; [ ]
  16258. :cboff (concat (or (car org-not-done-keywords) "TODO") " ")
  16259. ;; [-]
  16260. :cbtrans (concat (or (car org-not-done-keywords) "TODO") " ")))
  16261. "\n")))
  16262. (setq toggled t))
  16263. (forward-line)))
  16264. ;; Case 3. Started at normal text: make every line an heading,
  16265. ;; skipping headlines and items.
  16266. (t (let* ((stars
  16267. (make-string
  16268. (if (numberp nstars) nstars (or (org-current-level) 0)) ?*))
  16269. (add-stars
  16270. (cond (nstars "") ; stars from prefix only
  16271. ((equal stars "") "*") ; before first heading
  16272. (org-odd-levels-only "**") ; inside heading, odd
  16273. (t "*"))) ; inside heading, oddeven
  16274. (rpl (concat stars add-stars " "))
  16275. (lend (when (listp nstars) (save-excursion (end-of-line) (point)))))
  16276. (while (< (point) (if (equal nstars '(4)) lend end))
  16277. (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
  16278. (looking-at "\\([ \t]*\\)\\(\\S-\\)"))
  16279. (replace-match (concat rpl (match-string 2))) (setq toggled t))
  16280. (forward-line)))))))
  16281. (unless toggled (message "Cannot toggle heading from here"))))
  16282. (defun org-meta-return (&optional arg)
  16283. "Insert a new heading or wrap a region in a table.
  16284. Calls `org-insert-heading', `org-insert-item' or
  16285. `org-table-wrap-region', depending on context. When called with
  16286. an argument, unconditionally call `org-insert-heading'."
  16287. (interactive "P")
  16288. (org-fold-check-before-invisible-edit 'insert)
  16289. (or (run-hook-with-args-until-success 'org-metareturn-hook)
  16290. (call-interactively (cond (arg #'org-insert-heading)
  16291. ((org-at-table-p) #'org-table-wrap-region)
  16292. ((org-in-item-p) #'org-insert-item)
  16293. (t #'org-insert-heading)))))
  16294. ;;; Menu entries
  16295. (defsubst org-in-subtree-not-table-p ()
  16296. "Are we in a subtree and not in a table?"
  16297. (and (not (org-before-first-heading-p))
  16298. (not (org-at-table-p))))
  16299. ;; Define the Org mode menus
  16300. (easy-menu-define org-org-menu org-mode-map "Org menu."
  16301. `("Org"
  16302. ("Show/Hide"
  16303. ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
  16304. ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
  16305. ["Sparse Tree..." org-sparse-tree t]
  16306. ["Reveal Context" org-fold-reveal t]
  16307. ["Show All" org-fold-show-all t]
  16308. "--"
  16309. ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
  16310. "--"
  16311. ["New Heading" org-insert-heading t]
  16312. ("Navigate Headings"
  16313. ["Up" outline-up-heading t]
  16314. ["Next" outline-next-visible-heading t]
  16315. ["Previous" outline-previous-visible-heading t]
  16316. ["Next Same Level" outline-forward-same-level t]
  16317. ["Previous Same Level" outline-backward-same-level t]
  16318. "--"
  16319. ["Jump" org-goto t])
  16320. ("Edit Structure"
  16321. ["Move Subtree Up" org-metaup (org-at-heading-p)]
  16322. ["Move Subtree Down" org-metadown (org-at-heading-p)]
  16323. "--"
  16324. ["Copy Subtree" org-copy-special (org-in-subtree-not-table-p)]
  16325. ["Cut Subtree" org-cut-special (org-in-subtree-not-table-p)]
  16326. ["Paste Subtree" org-paste-special (not (org-at-table-p))]
  16327. "--"
  16328. ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
  16329. "--"
  16330. ["Copy visible text" org-copy-visible t]
  16331. "--"
  16332. ["Promote Heading" org-metaleft (org-in-subtree-not-table-p)]
  16333. ["Promote Subtree" org-shiftmetaleft (org-in-subtree-not-table-p)]
  16334. ["Demote Heading" org-metaright (org-in-subtree-not-table-p)]
  16335. ["Demote Subtree" org-shiftmetaright (org-in-subtree-not-table-p)]
  16336. "--"
  16337. ["Sort Region/Children" org-sort t]
  16338. "--"
  16339. ["Convert to odd levels" org-convert-to-odd-levels t]
  16340. ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
  16341. ("Editing"
  16342. ["Emphasis..." org-emphasize t]
  16343. ["Add block structure" org-insert-structure-template t]
  16344. ["Edit Source Example" org-edit-special t]
  16345. "--"
  16346. ["Footnote new/jump" org-footnote-action t]
  16347. ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
  16348. ("Archive"
  16349. ["Archive (default method)" org-archive-subtree-default (org-in-subtree-not-table-p)]
  16350. "--"
  16351. ["Move Subtree to Archive file" org-archive-subtree (org-in-subtree-not-table-p)]
  16352. ["Toggle ARCHIVE tag" org-toggle-archive-tag (org-in-subtree-not-table-p)]
  16353. ["Move subtree to Archive sibling" org-archive-to-archive-sibling (org-in-subtree-not-table-p)])
  16354. "--"
  16355. ("Hyperlinks"
  16356. ["Store Link (Global)" org-store-link t]
  16357. ["Find existing link to here" org-occur-link-in-agenda-files t]
  16358. ["Insert Link" org-insert-link t]
  16359. ["Follow Link" org-open-at-point t]
  16360. "--"
  16361. ["Next link" org-next-link t]
  16362. ["Previous link" org-previous-link t]
  16363. "--"
  16364. ["Descriptive Links"
  16365. org-toggle-link-display
  16366. :style radio
  16367. :selected org-descriptive-links
  16368. ]
  16369. ["Literal Links"
  16370. org-toggle-link-display
  16371. :style radio
  16372. :selected (not org-descriptive-links)])
  16373. "--"
  16374. ("TODO Lists"
  16375. ["TODO/DONE/-" org-todo t]
  16376. ("Select keyword"
  16377. ["Next keyword" org-shiftright (org-at-heading-p)]
  16378. ["Previous keyword" org-shiftleft (org-at-heading-p)]
  16379. ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
  16380. ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
  16381. ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
  16382. ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
  16383. ["Global TODO list" org-todo-list :active t :keys "\\[org-agenda] t"]
  16384. "--"
  16385. ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
  16386. :selected org-enforce-todo-dependencies :style toggle :active t]
  16387. "Settings for tree at point"
  16388. ["Do Children sequentially" org-toggle-ordered-property :style radio
  16389. :selected (org-entry-get nil "ORDERED")
  16390. :active org-enforce-todo-dependencies :keys "C-c C-x o"]
  16391. ["Do Children parallel" org-toggle-ordered-property :style radio
  16392. :selected (not (org-entry-get nil "ORDERED"))
  16393. :active org-enforce-todo-dependencies :keys "C-c C-x o"]
  16394. "--"
  16395. ["Set Priority" org-priority t]
  16396. ["Priority Up" org-shiftup t]
  16397. ["Priority Down" org-shiftdown t]
  16398. "--"
  16399. ["Get news from all feeds" org-feed-update-all t]
  16400. ["Go to the inbox of a feed..." org-feed-goto-inbox t]
  16401. ["Customize feeds" (customize-variable 'org-feed-alist) t])
  16402. ("TAGS and Properties"
  16403. ["Set Tags" org-set-tags-command (not (org-before-first-heading-p))]
  16404. ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
  16405. "--"
  16406. ["Set property" org-set-property (not (org-before-first-heading-p))]
  16407. ["Column view of properties" org-columns t]
  16408. ["Insert Column View DBlock" org-columns-insert-dblock t])
  16409. ("Dates and Scheduling"
  16410. ["Timestamp" org-time-stamp (not (org-before-first-heading-p))]
  16411. ["Timestamp (inactive)" org-time-stamp-inactive (not (org-before-first-heading-p))]
  16412. ("Change Date"
  16413. ["1 Day Later" org-shiftright (org-at-timestamp-p 'lax)]
  16414. ["1 Day Earlier" org-shiftleft (org-at-timestamp-p 'lax)]
  16415. ["1 ... Later" org-shiftup (org-at-timestamp-p 'lax)]
  16416. ["1 ... Earlier" org-shiftdown (org-at-timestamp-p 'lax)])
  16417. ["Compute Time Range" org-evaluate-time-range t]
  16418. ["Schedule Item" org-schedule (not (org-before-first-heading-p))]
  16419. ["Deadline" org-deadline (not (org-before-first-heading-p))]
  16420. "--"
  16421. ["Custom time format" org-toggle-time-stamp-overlays
  16422. :style radio :selected org-display-custom-times]
  16423. "--"
  16424. ["Goto Calendar" org-goto-calendar t]
  16425. ["Date from Calendar" org-date-from-calendar t]
  16426. "--"
  16427. ["Start/Restart Timer" org-timer-start t]
  16428. ["Pause/Continue Timer" org-timer-pause-or-continue t]
  16429. ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
  16430. ["Insert Timer String" org-timer t]
  16431. ["Insert Timer Item" org-timer-item t])
  16432. ("Logging work"
  16433. ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
  16434. ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
  16435. ["Clock out" org-clock-out t]
  16436. ["Clock cancel" org-clock-cancel t]
  16437. "--"
  16438. ["Mark as default task" org-clock-mark-default-task t]
  16439. ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
  16440. ["Goto running clock" org-clock-goto t]
  16441. "--"
  16442. ["Display times" org-clock-display t]
  16443. ["Create clock table" org-clock-report t]
  16444. "--"
  16445. ["Record DONE time"
  16446. (progn (setq org-log-done (not org-log-done))
  16447. (message "Switching to %s will %s record a timestamp"
  16448. (car org-done-keywords)
  16449. (if org-log-done "automatically" "not")))
  16450. :style toggle :selected org-log-done])
  16451. "--"
  16452. ["Agenda Command..." org-agenda t]
  16453. ["Set Restriction Lock" org-agenda-set-restriction-lock t]
  16454. ("File List for Agenda")
  16455. ("Special views current file"
  16456. ["TODO Tree" org-show-todo-tree t]
  16457. ["Check Deadlines" org-check-deadlines t]
  16458. ["Tags/Property tree" org-match-sparse-tree t])
  16459. "--"
  16460. ["Export/Publish..." org-export-dispatch t]
  16461. ("LaTeX"
  16462. ["Org CDLaTeX mode" org-cdlatex-mode :active (require 'cdlatex nil t)
  16463. :style toggle :selected org-cdlatex-mode]
  16464. ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
  16465. ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
  16466. ["Modify math symbol" org-cdlatex-math-modify
  16467. (org-inside-LaTeX-fragment-p)]
  16468. ["Insert citation" org-reftex-citation t])
  16469. "--"
  16470. ("Documentation"
  16471. ["Show Version" org-version t]
  16472. ["Info Documentation" org-info t]
  16473. ["Browse Org News" org-browse-news t])
  16474. ("Customize"
  16475. ["Browse Org Group" org-customize t]
  16476. "--"
  16477. ["Expand This Menu" org-create-customize-menu t])
  16478. ["Send bug report" org-submit-bug-report t]
  16479. "--"
  16480. ("Refresh/Reload"
  16481. ["Refresh setup current buffer" org-mode-restart t]
  16482. ["Reload Org (after update)" org-reload t]
  16483. ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x !"])))
  16484. (easy-menu-define org-tbl-menu org-mode-map "Org Table menu."
  16485. '("Table"
  16486. ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
  16487. ["Next Field" org-cycle (org-at-table-p)]
  16488. ["Previous Field" org-shifttab (org-at-table-p)]
  16489. ["Next Row" org-return (org-at-table-p)]
  16490. "--"
  16491. ["Blank Field" org-table-blank-field (org-at-table-p)]
  16492. ["Edit Field" org-table-edit-field (org-at-table-p)]
  16493. ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
  16494. "--"
  16495. ("Column"
  16496. ["Move Column Left" org-metaleft (org-at-table-p)]
  16497. ["Move Column Right" org-metaright (org-at-table-p)]
  16498. ["Delete Column" org-shiftmetaleft (org-at-table-p)]
  16499. ["Insert Column" org-shiftmetaright (org-at-table-p)]
  16500. ["Shrink Column" org-table-toggle-column-width (org-at-table-p)])
  16501. ("Row"
  16502. ["Move Row Up" org-metaup (org-at-table-p)]
  16503. ["Move Row Down" org-metadown (org-at-table-p)]
  16504. ["Delete Row" org-shiftmetaup (org-at-table-p)]
  16505. ["Insert Row" org-shiftmetadown (org-at-table-p)]
  16506. ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
  16507. "--"
  16508. ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
  16509. ("Rectangle"
  16510. ["Copy Rectangle" org-copy-special (org-at-table-p)]
  16511. ["Cut Rectangle" org-cut-special (org-at-table-p)]
  16512. ["Paste Rectangle" org-paste-special (org-at-table-p)]
  16513. ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
  16514. "--"
  16515. ("Calculate"
  16516. ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
  16517. ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
  16518. ["Edit Formulas" org-edit-special (org-at-table-p)]
  16519. "--"
  16520. ["Recalculate line" org-table-recalculate (org-at-table-p)]
  16521. ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
  16522. ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
  16523. "--"
  16524. ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
  16525. "--"
  16526. ["Sum Column/Rectangle" org-table-sum
  16527. (or (org-at-table-p) (org-region-active-p))]
  16528. ["Which Column?" org-table-current-column (org-at-table-p)])
  16529. ["Debug Formulas"
  16530. org-table-toggle-formula-debugger
  16531. :style toggle :selected (bound-and-true-p org-table-formula-debug)]
  16532. ["Show Col/Row Numbers"
  16533. org-table-toggle-coordinate-overlays
  16534. :style toggle
  16535. :selected (bound-and-true-p org-table-overlay-coordinates)]
  16536. "--"
  16537. ["Create" org-table-create (not (org-at-table-p))]
  16538. ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
  16539. ["Import from File" org-table-import (not (org-at-table-p))]
  16540. ["Export to File" org-table-export (org-at-table-p)]
  16541. "--"
  16542. ["Create/Convert from/to table.el" org-table-create-with-table.el t]
  16543. "--"
  16544. ("Plot"
  16545. ["Ascii plot" orgtbl-ascii-plot :active (org-at-table-p) :keys "C-c \" a"]
  16546. ["Gnuplot" org-plot/gnuplot :active (org-at-table-p) :keys "C-c \" g"])))
  16547. (defun org-info (&optional node)
  16548. "Read documentation for Org in the info system.
  16549. With optional NODE, go directly to that node."
  16550. (interactive)
  16551. (info (format "(org)%s" (or node ""))))
  16552. (defun org-browse-news ()
  16553. "Browse the news for the latest major release."
  16554. (interactive)
  16555. (browse-url "https://orgmode.org/Changes.html"))
  16556. ;;;###autoload
  16557. (defun org-submit-bug-report ()
  16558. "Submit a bug report on Org via mail.
  16559. Don't hesitate to report any problems or inaccurate documentation.
  16560. If you don't have setup sending mail from (X)Emacs, please copy the
  16561. output buffer into your mail program, as it gives us important
  16562. information about your Org version and configuration."
  16563. (interactive)
  16564. (require 'reporter)
  16565. (defvar reporter-prompt-for-summary-p)
  16566. (org-load-modules-maybe)
  16567. (org-require-autoloaded-modules)
  16568. (let ((reporter-prompt-for-summary-p "Bug report subject: "))
  16569. (reporter-submit-bug-report
  16570. "emacs-orgmode@gnu.org"
  16571. (org-version nil 'full)
  16572. (let (list)
  16573. (save-window-excursion
  16574. (pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
  16575. (delete-other-windows)
  16576. (erase-buffer)
  16577. (insert "You are about to submit a bug report to the Org mailing list.
  16578. If your report is about Org installation, please read this section:
  16579. https://orgmode.org/org.html#Installation
  16580. Please read https://orgmode.org/org.html#Feedback on how to make
  16581. a good report, it will help Org contributors fixing your problem.
  16582. Search https://lists.gnu.org/archive/html/emacs-orgmode/ to see
  16583. if the issue you are about to raise has already been dealt with.
  16584. We also would like to add your full Org and Outline configuration
  16585. to the bug report. It will help us debugging the issue.
  16586. *HOWEVER*, some variables you have customized may contain private
  16587. information. The names of customers, colleagues, or friends, might
  16588. appear in the form of file names, tags, todo states or search strings.
  16589. If you answer \"yes\" to the prompt, you might want to check and remove
  16590. such private information before sending the email.")
  16591. (add-text-properties (point-min) (point-max) '(face org-warning))
  16592. (when (yes-or-no-p "Include your Org configuration ")
  16593. (mapatoms
  16594. (lambda (v)
  16595. (and (boundp v)
  16596. (string-match "\\`\\(org-\\|outline-\\)" (symbol-name v))
  16597. (or (and (symbol-value v)
  16598. (string-match "\\(-hook\\|-function\\)\\'" (symbol-name v)))
  16599. (and
  16600. (get v 'custom-type) (get v 'standard-value)
  16601. (not (equal (symbol-value v)
  16602. (eval (car (get v 'standard-value)) t)))))
  16603. (push v list)))))
  16604. (kill-buffer (get-buffer "*Warn about privacy*"))
  16605. list))
  16606. nil nil
  16607. "Remember to cover the basics, that is, what you expected to happen and
  16608. what in fact did happen. You don't know how to make a good report? See
  16609. https://orgmode.org/manual/Feedback.html#Feedback
  16610. Your bug report will be posted to the Org mailing list.
  16611. ------------------------------------------------------------------------")
  16612. (save-excursion
  16613. (when (re-search-backward "^\\(Subject: \\)Org mode version \\(.*?\\);[ \t]*\\(.*\\)" nil t)
  16614. (replace-match "\\1[BUG] \\3 [\\2]")))))
  16615. (defun org-install-agenda-files-menu ()
  16616. "Install agenda file menu."
  16617. (let ((bl (buffer-list)))
  16618. (save-excursion
  16619. (while bl
  16620. (set-buffer (pop bl))
  16621. (when (derived-mode-p 'org-mode) (setq bl nil)))
  16622. (when (derived-mode-p 'org-mode)
  16623. (easy-menu-change
  16624. '("Org") "File List for Agenda"
  16625. (append
  16626. (list
  16627. ["Edit File List" (org-edit-agenda-file-list) t]
  16628. ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
  16629. ["Remove Current File from List" org-remove-file t]
  16630. ["Cycle through agenda files" org-cycle-agenda-files t]
  16631. ["Occur in all agenda files" org-occur-in-agenda-files t]
  16632. "--")
  16633. (mapcar 'org-file-menu-entry
  16634. ;; Prevent initialization from failing.
  16635. (ignore-errors (org-agenda-files t)))))))))
  16636. ;;;; Documentation
  16637. (defun org-require-autoloaded-modules ()
  16638. (interactive)
  16639. (mapc #'require
  16640. '(org-agenda org-archive org-attach org-clock org-colview org-id
  16641. org-table org-timer)))
  16642. ;;;###autoload
  16643. (defun org-reload (&optional uncompiled)
  16644. "Reload all Org Lisp files.
  16645. With prefix arg UNCOMPILED, load the uncompiled versions."
  16646. (interactive "P")
  16647. (require 'loadhist)
  16648. (let* ((org-dir (org-find-library-dir "org"))
  16649. (contrib-dir (or (org-find-library-dir "org-contribdir") org-dir))
  16650. (feature-re "^\\(org\\|ob\\|ox\\|ol\\|oc\\)\\(-.*\\)?")
  16651. (remove-re (format "\\`%s\\'"
  16652. (regexp-opt '("org" "org-loaddefs" "org-version"))))
  16653. (feats (delete-dups
  16654. (mapcar 'file-name-sans-extension
  16655. (mapcar 'file-name-nondirectory
  16656. (delq nil
  16657. (mapcar 'feature-file
  16658. features))))))
  16659. (lfeat (append
  16660. (sort
  16661. (setq feats
  16662. (delq nil (mapcar
  16663. (lambda (f)
  16664. (if (and (string-match feature-re f)
  16665. (not (string-match remove-re f)))
  16666. f nil))
  16667. feats)))
  16668. 'string-lessp)
  16669. (list "org-version" "org")))
  16670. (load-suffixes (if uncompiled (reverse load-suffixes) load-suffixes))
  16671. load-uncore load-misses)
  16672. (setq load-misses
  16673. (delq t
  16674. (mapcar (lambda (f)
  16675. (or (org-load-noerror-mustsuffix (concat org-dir f))
  16676. (and (string= org-dir contrib-dir)
  16677. (org-load-noerror-mustsuffix (concat contrib-dir f)))
  16678. (and (org-load-noerror-mustsuffix (concat (org-find-library-dir f) f))
  16679. (push f load-uncore)
  16680. t)
  16681. f))
  16682. lfeat)))
  16683. (when load-uncore
  16684. (message "The following feature%s found in load-path, please check if that's correct:\n%s"
  16685. (if (> (length load-uncore) 1) "s were" " was")
  16686. (reverse load-uncore)))
  16687. (if load-misses
  16688. (message "Some error occurred while reloading Org feature%s\n%s\nPlease check *Messages*!\n%s"
  16689. (if (> (length load-misses) 1) "s" "") load-misses (org-version nil 'full))
  16690. (message "Successfully reloaded Org\n%s" (org-version nil 'full)))))
  16691. ;;;###autoload
  16692. (defun org-customize ()
  16693. "Call the customize function with org as argument."
  16694. (interactive)
  16695. (org-load-modules-maybe)
  16696. (org-require-autoloaded-modules)
  16697. (customize-browse 'org))
  16698. (defun org-create-customize-menu ()
  16699. "Create a full customization menu for Org mode, insert it into the menu."
  16700. (interactive)
  16701. (org-load-modules-maybe)
  16702. (org-require-autoloaded-modules)
  16703. (easy-menu-change
  16704. '("Org") "Customize"
  16705. `(["Browse Org group" org-customize t]
  16706. "--"
  16707. ,(customize-menu-create 'org)
  16708. ["Set" Custom-set t]
  16709. ["Save" Custom-save t]
  16710. ["Reset to Current" Custom-reset-current t]
  16711. ["Reset to Saved" Custom-reset-saved t]
  16712. ["Reset to Standard Settings" Custom-reset-standard t]))
  16713. (message "\"Org\"-menu now contains full customization menu"))
  16714. ;;;; Miscellaneous stuff
  16715. ;;; Generally useful functions
  16716. (defun org-in-clocktable-p ()
  16717. "Check if the cursor is in a clocktable."
  16718. (let ((pos (point)) start)
  16719. (save-excursion
  16720. (end-of-line 1)
  16721. (and (re-search-backward "^[ \t]*#\\+BEGIN:[ \t]+clocktable" nil t)
  16722. (setq start (match-beginning 0))
  16723. (re-search-forward "^[ \t]*#\\+END:.*" nil t)
  16724. (>= (match-end 0) pos)
  16725. start))))
  16726. (defun org-in-verbatim-emphasis ()
  16727. (save-match-data
  16728. (and (org-in-regexp org-verbatim-re 2)
  16729. (>= (point) (match-beginning 3))
  16730. (<= (point) (match-end 4)))))
  16731. (defun org-goto-marker-or-bmk (marker &optional bookmark)
  16732. "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
  16733. (if (and marker (marker-buffer marker)
  16734. (buffer-live-p (marker-buffer marker)))
  16735. (progn
  16736. (pop-to-buffer-same-window (marker-buffer marker))
  16737. (when (or (> marker (point-max)) (< marker (point-min)))
  16738. (widen))
  16739. (goto-char marker)
  16740. (org-fold-show-context 'org-goto))
  16741. (if bookmark
  16742. (bookmark-jump bookmark)
  16743. (error "Cannot find location"))))
  16744. (defun org-quote-csv-field (s)
  16745. "Quote field for inclusion in CSV material."
  16746. (if (string-match "[\",]" s)
  16747. (concat "\"" (mapconcat 'identity (split-string s "\"") "\"\"") "\"")
  16748. s))
  16749. (defun org-force-self-insert (N)
  16750. "Needed to enforce self-insert under remapping."
  16751. (interactive "p")
  16752. (self-insert-command N))
  16753. (defun org-quote-vert (s)
  16754. "Replace \"|\" with \"\\vert\"."
  16755. (while (string-match "|" s)
  16756. (setq s (replace-match "\\vert" t t s)))
  16757. s)
  16758. (defun org-uuidgen-p (s)
  16759. "Is S an ID created by UUIDGEN?"
  16760. (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
  16761. (defun org-in-src-block-p (&optional inside element)
  16762. "Whether point is in a code source block.
  16763. When INSIDE is non-nil, don't consider we are within a source
  16764. block when point is at #+BEGIN_SRC or #+END_SRC.
  16765. When ELEMENT is provided, it is considered to be element at point."
  16766. (save-match-data (setq element (or element (org-element-at-point))))
  16767. (when (eq 'src-block (org-element-type element))
  16768. (or (not inside)
  16769. (not (or (= (line-beginning-position)
  16770. (org-element-property :post-affiliated element))
  16771. (= (1+ (line-end-position))
  16772. (- (org-element-property :end element)
  16773. (org-element-property :post-blank element))))))))
  16774. (defun org-context ()
  16775. "Return a list of contexts of the current cursor position.
  16776. If several contexts apply, all are returned.
  16777. Each context entry is a list with a symbol naming the context, and
  16778. two positions indicating start and end of the context. Possible
  16779. contexts are:
  16780. :headline anywhere in a headline
  16781. :headline-stars on the leading stars in a headline
  16782. :todo-keyword on a TODO keyword (including DONE) in a headline
  16783. :tags on the TAGS in a headline
  16784. :priority on the priority cookie in a headline
  16785. :item on the first line of a plain list item
  16786. :item-bullet on the bullet/number of a plain list item
  16787. :checkbox on the checkbox in a plain list item
  16788. :table in an Org table
  16789. :table-special on a special filed in a table
  16790. :table-table in a table.el table
  16791. :clocktable in a clocktable
  16792. :src-block in a source block
  16793. :link on a hyperlink
  16794. :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT.
  16795. :latex-fragment on a LaTeX fragment
  16796. :latex-preview on a LaTeX fragment with overlaid preview image
  16797. This function expects the position to be visible because it uses font-lock
  16798. faces as a help to recognize the following contexts: :table-special, :link,
  16799. and :keyword."
  16800. (let* ((f (get-text-property (point) 'face))
  16801. (faces (if (listp f) f (list f)))
  16802. (case-fold-search t)
  16803. (p (point)) clist o)
  16804. ;; First the large context
  16805. (cond
  16806. ((org-at-heading-p)
  16807. (push (list :headline (line-beginning-position)
  16808. (line-end-position))
  16809. clist)
  16810. (when (progn
  16811. (beginning-of-line 1)
  16812. (looking-at org-todo-line-tags-regexp))
  16813. (push (org-point-in-group p 1 :headline-stars) clist)
  16814. (push (org-point-in-group p 2 :todo-keyword) clist)
  16815. (push (org-point-in-group p 4 :tags) clist))
  16816. (goto-char p)
  16817. (skip-chars-backward "^[\n\r \t") (or (bobp) (backward-char 1))
  16818. (when (looking-at "\\[#[A-Z0-9]\\]")
  16819. (push (org-point-in-group p 0 :priority) clist)))
  16820. ((org-at-item-p)
  16821. (push (org-point-in-group p 2 :item-bullet) clist)
  16822. (push (list :item (line-beginning-position)
  16823. (save-excursion (org-end-of-item) (point)))
  16824. clist)
  16825. (and (org-at-item-checkbox-p)
  16826. (push (org-point-in-group p 0 :checkbox) clist)))
  16827. ((org-at-table-p)
  16828. (push (list :table (org-table-begin) (org-table-end)) clist)
  16829. (when (memq 'org-formula faces)
  16830. (push (list :table-special
  16831. (previous-single-property-change p 'face)
  16832. (next-single-property-change p 'face))
  16833. clist)))
  16834. ((org-at-table-p 'any)
  16835. (push (list :table-table) clist)))
  16836. (goto-char p)
  16837. (let ((case-fold-search t))
  16838. ;; New the "medium" contexts: clocktables, source blocks
  16839. (cond ((org-in-clocktable-p)
  16840. (push (list :clocktable
  16841. (and (or (looking-at "[ \t]*\\(#\\+BEGIN: clocktable\\)")
  16842. (re-search-backward "[ \t]*\\(#+BEGIN: clocktable\\)" nil t))
  16843. (match-beginning 1))
  16844. (and (re-search-forward "[ \t]*#\\+END:?" nil t)
  16845. (match-end 0)))
  16846. clist))
  16847. ((org-in-src-block-p)
  16848. (push (list :src-block
  16849. (and (or (looking-at "[ \t]*\\(#\\+BEGIN_SRC\\)")
  16850. (re-search-backward "[ \t]*\\(#+BEGIN_SRC\\)" nil t))
  16851. (match-beginning 1))
  16852. (and (search-forward "#+END_SRC" nil t)
  16853. (match-beginning 0)))
  16854. clist))))
  16855. (goto-char p)
  16856. ;; Now the small context
  16857. (cond
  16858. ((org-at-timestamp-p)
  16859. (push (org-point-in-group p 0 :timestamp) clist))
  16860. ((memq 'org-link faces)
  16861. (push (list :link
  16862. (previous-single-property-change p 'face)
  16863. (next-single-property-change p 'face))
  16864. clist))
  16865. ((memq 'org-special-keyword faces)
  16866. (push (list :keyword
  16867. (previous-single-property-change p 'face)
  16868. (next-single-property-change p 'face))
  16869. clist))
  16870. ((setq o (cl-some
  16871. (lambda (o)
  16872. (and (eq (overlay-get o 'org-overlay-type) 'org-latex-overlay)
  16873. o))
  16874. (overlays-at (point))))
  16875. (push (list :latex-fragment
  16876. (overlay-start o) (overlay-end o))
  16877. clist)
  16878. (push (list :latex-preview
  16879. (overlay-start o) (overlay-end o))
  16880. clist))
  16881. ((org-inside-LaTeX-fragment-p)
  16882. ;; FIXME: positions wrong.
  16883. (push (list :latex-fragment (point) (point)) clist)))
  16884. (setq clist (nreverse (delq nil clist)))
  16885. clist))
  16886. (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
  16887. "Non-nil when point is between matches of START-RE and END-RE.
  16888. Also return a non-nil value when point is on one of the matches.
  16889. Optional arguments LIM-UP and LIM-DOWN bound the search; they are
  16890. buffer positions. Default values are the positions of headlines
  16891. surrounding the point.
  16892. The functions returns a cons cell whose car (resp. cdr) is the
  16893. position before START-RE (resp. after END-RE)."
  16894. (save-match-data
  16895. (let ((pos (point))
  16896. (limit-up (or lim-up (save-excursion (outline-previous-heading))))
  16897. (limit-down (or lim-down (save-excursion (outline-next-heading))))
  16898. beg end)
  16899. (save-excursion
  16900. ;; Point is on a block when on START-RE or if START-RE can be
  16901. ;; found before it...
  16902. (and (or (org-in-regexp start-re)
  16903. (re-search-backward start-re limit-up t))
  16904. (setq beg (match-beginning 0))
  16905. ;; ... and END-RE after it...
  16906. (goto-char (match-end 0))
  16907. (re-search-forward end-re limit-down t)
  16908. (> (setq end (match-end 0)) pos)
  16909. ;; ... without another START-RE in-between.
  16910. (goto-char (match-beginning 0))
  16911. (not (re-search-backward start-re (1+ beg) t))
  16912. ;; Return value.
  16913. (cons beg end))))))
  16914. (defun org-in-block-p (names)
  16915. "Non-nil when point belongs to a block whose name belongs to NAMES.
  16916. NAMES is a list of strings containing names of blocks.
  16917. Return first block name matched, or nil. Beware that in case of
  16918. nested blocks, the returned name may not belong to the closest
  16919. block from point."
  16920. (save-match-data
  16921. (catch 'exit
  16922. (let ((case-fold-search t)
  16923. (lim-up (save-excursion (outline-previous-heading)))
  16924. (lim-down (save-excursion (outline-next-heading))))
  16925. (dolist (name names)
  16926. (let ((n (regexp-quote name)))
  16927. (when (org-between-regexps-p
  16928. (concat "^[ \t]*#\\+begin_" n)
  16929. (concat "^[ \t]*#\\+end_" n)
  16930. lim-up lim-down)
  16931. (throw 'exit n)))))
  16932. nil)))
  16933. (defun org-occur-in-agenda-files (regexp &optional _nlines)
  16934. "Call `multi-occur' with buffers for all agenda files."
  16935. (interactive "sOrg-files matching: ")
  16936. (let* ((files (org-agenda-files))
  16937. (tnames (mapcar #'file-truename files))
  16938. (extra org-agenda-text-search-extra-files))
  16939. (when (eq (car extra) 'agenda-archives)
  16940. (setq extra (cdr extra))
  16941. (setq files (org-add-archive-files files)))
  16942. (dolist (f extra)
  16943. (unless (member (file-truename f) tnames)
  16944. (unless (member f files) (setq files (append files (list f))))
  16945. (setq tnames (append tnames (list (file-truename f))))))
  16946. (multi-occur
  16947. (mapcar (lambda (x)
  16948. (with-current-buffer
  16949. ;; FIXME: Why not just (find-file-noselect x)?
  16950. ;; Is it to avoid the "revert buffer" prompt?
  16951. (or (get-file-buffer x) (find-file-noselect x))
  16952. (widen)
  16953. (current-buffer)))
  16954. files)
  16955. regexp)))
  16956. (add-hook 'occur-mode-find-occurrence-hook
  16957. (lambda () (when (derived-mode-p 'org-mode) (org-fold-reveal))))
  16958. (defun org-occur-link-in-agenda-files ()
  16959. "Create a link and search for it in the agendas.
  16960. The link is not stored in `org-stored-links', it is just created
  16961. for the search purpose."
  16962. (interactive)
  16963. (let ((link (condition-case nil
  16964. (org-store-link nil)
  16965. (error "Unable to create a link to here"))))
  16966. (org-occur-in-agenda-files (regexp-quote link))))
  16967. (defun org-back-over-empty-lines ()
  16968. "Move backwards over whitespace, to the beginning of the first empty line.
  16969. Returns the number of empty lines passed."
  16970. (let ((pos (point)))
  16971. (if (cdr (assq 'heading org-blank-before-new-entry))
  16972. (skip-chars-backward " \t\n\r")
  16973. (unless (eobp)
  16974. (forward-line -1)))
  16975. (beginning-of-line 2)
  16976. (goto-char (min (point) pos))
  16977. (count-lines (point) pos)))
  16978. ;;; TODO: Only called once, from ox-odt which should probably use
  16979. ;;; org-export-inline-image-p or something.
  16980. (defun org-file-image-p (file)
  16981. "Return non-nil if FILE is an image."
  16982. (save-match-data
  16983. (string-match (image-file-name-regexp) file)))
  16984. (defun org-get-cursor-date (&optional with-time)
  16985. "Return the date at cursor in as a time.
  16986. This works in the calendar and in the agenda, anywhere else it just
  16987. returns the current time.
  16988. If WITH-TIME is non-nil, returns the time of the event at point (in
  16989. the agenda) or the current time of the day; otherwise returns the
  16990. earliest time on the cursor date that Org treats as that date
  16991. (bearing in mind `org-extend-today-until')."
  16992. (let (date day defd tp hod mod)
  16993. (when with-time
  16994. (setq tp (get-text-property (point) 'time))
  16995. (when (and tp (string-match "\\([0-2]?[0-9]\\):\\([0-5][0-9]\\)" tp))
  16996. (setq hod (string-to-number (match-string 1 tp))
  16997. mod (string-to-number (match-string 2 tp))))
  16998. (or tp (let ((now (decode-time)))
  16999. (setq hod (nth 2 now)
  17000. mod (nth 1 now)))))
  17001. (cond
  17002. ((eq major-mode 'calendar-mode)
  17003. (setq date (calendar-cursor-to-date)
  17004. defd (org-encode-time 0 (or mod 0) (or hod org-extend-today-until)
  17005. (nth 1 date) (nth 0 date) (nth 2 date))))
  17006. ((eq major-mode 'org-agenda-mode)
  17007. (setq day (get-text-property (point) 'day))
  17008. (when day
  17009. (setq date (calendar-gregorian-from-absolute day)
  17010. defd (org-encode-time 0 (or mod 0) (or hod org-extend-today-until)
  17011. (nth 1 date) (nth 0 date) (nth 2 date))))))
  17012. (or defd (current-time))))
  17013. (defun org-mark-subtree (&optional up)
  17014. "Mark the current subtree.
  17015. This puts point at the start of the current subtree, and mark at
  17016. the end. If a numeric prefix UP is given, move up into the
  17017. hierarchy of headlines by UP levels before marking the subtree."
  17018. (interactive "P")
  17019. (org-with-limited-levels
  17020. (cond ((org-at-heading-p) (beginning-of-line))
  17021. ((org-before-first-heading-p) (user-error "Not in a subtree"))
  17022. (t (outline-previous-visible-heading 1))))
  17023. (when up (while (and (> up 0) (org-up-heading-safe)) (cl-decf up)))
  17024. (if (called-interactively-p 'any)
  17025. (call-interactively 'org-mark-element)
  17026. (org-mark-element)))
  17027. ;;; Indentation
  17028. (defun org--at-headline-data-p (&optional beg element)
  17029. "Return non-nil when `point' or BEG is inside headline metadata.
  17030. Metadata is planning line, properties drawer, logbook drawer right
  17031. after property drawer, or clock log line immediately following
  17032. properties drawer/planning line/ heading.
  17033. Optional argument ELEMENT contains element at BEG."
  17034. (org-with-wide-buffer
  17035. (when beg (goto-char beg))
  17036. (setq element (or element (org-element-at-point)))
  17037. (if (not (org-element-lineage element '(headline inlinetask)))
  17038. nil ; Not inside heading.
  17039. ;; Skip to top-level parent in section.
  17040. (while (not (eq 'section (org-element-type (org-element-property :parent element))))
  17041. (setq element (org-element-property :parent element)))
  17042. (pcase (org-element-type element)
  17043. ((or `planning `property-drawer)
  17044. t)
  17045. (`drawer
  17046. ;; LOGBOOK drawer with appropriate name.
  17047. (equal
  17048. (org-log-into-drawer)
  17049. (org-element-property :drawer-name element)))
  17050. (`clock
  17051. ;; Previous element must be headline metadata or headline.
  17052. (goto-char (1- (org-element-property :begin element)))
  17053. (or (org-at-heading-p)
  17054. (org--at-headline-data-p)))))))
  17055. (defvar org-element-greater-elements)
  17056. (defun org--get-expected-indentation (element contentsp)
  17057. "Expected indentation column for current line, according to ELEMENT.
  17058. ELEMENT is an element containing point. CONTENTSP is non-nil
  17059. when indentation is to be computed according to contents of
  17060. ELEMENT."
  17061. (let ((type (org-element-type element))
  17062. (start (org-element-property :begin element))
  17063. (post-affiliated (org-element-property :post-affiliated element)))
  17064. (org-with-wide-buffer
  17065. (cond
  17066. (contentsp
  17067. (cl-case type
  17068. ((diary-sexp footnote-definition) 0)
  17069. (section
  17070. (org--get-expected-indentation
  17071. (org-element-property :parent element)
  17072. t))
  17073. ((headline inlinetask nil)
  17074. (if (not org-adapt-indentation) 0
  17075. (let ((level (org-current-level)))
  17076. (if level (1+ level) 0))))
  17077. ((item plain-list) (org-list-item-body-column post-affiliated))
  17078. (t
  17079. (goto-char start)
  17080. (current-indentation))))
  17081. ((memq type '(headline inlinetask nil))
  17082. (if (org-match-line "[ \t]*$")
  17083. (org--get-expected-indentation element t)
  17084. 0))
  17085. ((memq type '(diary-sexp footnote-definition)) 0)
  17086. ;; First paragraph of a footnote definition or an item.
  17087. ;; Indent like parent.
  17088. ((< (line-beginning-position) start)
  17089. (org--get-expected-indentation
  17090. (org-element-property :parent element) t))
  17091. ;; At first line: indent according to previous sibling, if any,
  17092. ;; ignoring footnote definitions and inline tasks, or parent's
  17093. ;; contents. If `org-adapt-indentation' is `headline-data', ignore
  17094. ;; previous headline data siblings.
  17095. ((= (line-beginning-position) start)
  17096. (catch 'exit
  17097. (while t
  17098. (if (= (point-min) start) (throw 'exit 0)
  17099. (goto-char (1- start))
  17100. (let* ((previous (org-element-at-point))
  17101. (parent previous))
  17102. (while (and parent (<= (org-element-property :end parent) start))
  17103. (setq previous parent
  17104. parent (org-element-property :parent parent)))
  17105. (cond
  17106. ((not previous) (throw 'exit 0))
  17107. ((> (org-element-property :end previous) start)
  17108. (throw 'exit (org--get-expected-indentation previous t)))
  17109. ((memq (org-element-type previous)
  17110. '(footnote-definition inlinetask))
  17111. (setq start (org-element-property :begin previous)))
  17112. ;; Do not indent like previous when the previous
  17113. ;; element is headline data and `org-adapt-indentation'
  17114. ;; is set to `headline-data'.
  17115. ((and (eq 'headline-data org-adapt-indentation)
  17116. (not (org--at-headline-data-p start element))
  17117. (or (org-at-heading-p)
  17118. (org--at-headline-data-p (1- start) previous)))
  17119. (throw 'exit 0))
  17120. (t (goto-char (org-element-property :begin previous))
  17121. (throw 'exit
  17122. (if (bolp) (current-indentation)
  17123. ;; At first paragraph in an item or
  17124. ;; a footnote definition.
  17125. (org--get-expected-indentation
  17126. (org-element-property :parent previous) t))))))))))
  17127. ;; Otherwise, move to the first non-blank line above.
  17128. (t
  17129. (beginning-of-line)
  17130. (let ((pos (point)))
  17131. (skip-chars-backward " \r\t\n")
  17132. (cond
  17133. ;; Two blank lines end a footnote definition or a plain
  17134. ;; list. When we indent an empty line after them, the
  17135. ;; containing list or footnote definition is over, so it
  17136. ;; qualifies as a previous sibling. Therefore, we indent
  17137. ;; like its first line.
  17138. ((and (memq type '(footnote-definition plain-list))
  17139. (> (count-lines (point) pos) 2))
  17140. (goto-char start)
  17141. (current-indentation))
  17142. ;; Line above is the first one of a paragraph at the
  17143. ;; beginning of an item or a footnote definition. Indent
  17144. ;; like parent.
  17145. ((< (line-beginning-position) start)
  17146. (org--get-expected-indentation
  17147. (org-element-property :parent element) t))
  17148. ;; Line above is the beginning of an element, i.e., point
  17149. ;; was originally on the blank lines between element's start
  17150. ;; and contents.
  17151. ((= (line-beginning-position) post-affiliated)
  17152. (org--get-expected-indentation element t))
  17153. ;; POS is after contents in a greater element. Indent like
  17154. ;; the beginning of the element.
  17155. ((and (memq type org-element-greater-elements)
  17156. (let ((cend (org-element-property :contents-end element)))
  17157. (and cend (<= cend pos))))
  17158. ;; As a special case, if point is at the end of a footnote
  17159. ;; definition or an item, indent like the very last element
  17160. ;; within. If that last element is an item, indent like
  17161. ;; its contents.
  17162. (if (memq type '(footnote-definition item plain-list))
  17163. (let ((last (org-element-at-point)))
  17164. (goto-char pos)
  17165. (org--get-expected-indentation
  17166. last (eq (org-element-type last) 'item)))
  17167. (goto-char start)
  17168. (current-indentation)))
  17169. ;; In any other case, indent like the current line.
  17170. (t (current-indentation)))))
  17171. ;; Finally, no indentation is needed, fall back to 0.
  17172. (t (current-indentation))))))
  17173. (defun org--align-node-property ()
  17174. "Align node property at point.
  17175. Alignment is done according to `org-property-format', which see."
  17176. (when (save-excursion
  17177. (beginning-of-line)
  17178. (looking-at org-property-re))
  17179. (combine-change-calls (match-beginning 0) (match-end 0)
  17180. (let ((newtext (concat (match-string 4)
  17181. (org-trim
  17182. (format org-property-format (match-string 1) (match-string 3))))))
  17183. ;; Do not use `replace-match' here as we want to inherit folding
  17184. ;; properties if inside fold.
  17185. (delete-region (match-beginning 0) (match-end 0))
  17186. (insert-and-inherit newtext)))))
  17187. (defun org-indent-line ()
  17188. "Indent line depending on context.
  17189. Indentation is done according to the following rules:
  17190. - Footnote definitions, diary sexps, headlines and inline tasks
  17191. have to start at column 0.
  17192. - On the very first line of an element, consider, in order, the
  17193. next rules until one matches:
  17194. 1. If there's a sibling element before, ignoring footnote
  17195. definitions and inline tasks, indent like its first line.
  17196. 2. If element has a parent, indent like its contents. More
  17197. precisely, if parent is an item, indent after the bullet.
  17198. Else, indent like parent's first line.
  17199. 3. Otherwise, indent relatively to current level, if
  17200. `org-adapt-indentation' is t, or to left margin.
  17201. - On a blank line at the end of an element, indent according to
  17202. the type of the element. More precisely
  17203. 1. If element is a plain list, an item, or a footnote
  17204. definition, indent like the very last element within.
  17205. 2. If element is a paragraph, indent like its last non blank
  17206. line.
  17207. 3. Otherwise, indent like its very first line.
  17208. - In the code part of a source block, use language major mode
  17209. to indent current line if `org-src-tab-acts-natively' is
  17210. non-nil. If it is nil, do nothing.
  17211. - Otherwise, indent like the first non-blank line above.
  17212. The function doesn't indent an item as it could break the whole
  17213. list structure. Instead, use \\<org-mode-map>`\\[org-shiftmetaleft]' or \
  17214. `\\[org-shiftmetaright]'.
  17215. Also align node properties according to `org-property-format'."
  17216. (interactive)
  17217. (let* ((element (save-excursion (beginning-of-line) (org-element-at-point-no-context)))
  17218. (type (org-element-type element)))
  17219. (unless (or (org-at-heading-p)
  17220. (and (eq org-adapt-indentation 'headline-data)
  17221. (not (org--at-headline-data-p nil element))
  17222. (save-excursion
  17223. (goto-char (1- (org-element-property :begin element)))
  17224. (or (org-at-heading-p)
  17225. (org--at-headline-data-p)))))
  17226. (cond ((and (memq type '(plain-list item))
  17227. (= (line-beginning-position)
  17228. (org-element-property :post-affiliated element)))
  17229. nil)
  17230. ((and (eq type 'latex-environment)
  17231. (>= (point) (org-element-property :post-affiliated element))
  17232. (< (point)
  17233. (org-with-point-at (org-element-property :end element)
  17234. (skip-chars-backward " \t\n")
  17235. (line-beginning-position 2))))
  17236. nil)
  17237. ((and (eq type 'src-block)
  17238. org-src-tab-acts-natively
  17239. (> (line-beginning-position)
  17240. (org-element-property :post-affiliated element))
  17241. (< (line-beginning-position)
  17242. (org-with-point-at (org-element-property :end element)
  17243. (skip-chars-backward " \t\n")
  17244. (line-beginning-position))))
  17245. ;; At the beginning of a blank line, do some preindentation. This
  17246. ;; signals org-src--edit-element to preserve the indentation on exit
  17247. (when (and (looking-at-p "^[[:space:]]*$")
  17248. (not org-src-preserve-indentation))
  17249. (let ((element (org-element-at-point))
  17250. block-content-ind some-ind)
  17251. (org-with-point-at (org-element-property :begin element)
  17252. (setq block-content-ind (+ (org-current-text-indentation)
  17253. org-edit-src-content-indentation))
  17254. (forward-line)
  17255. (save-match-data (re-search-forward "^[ \t]*\\S-" nil t))
  17256. (backward-char)
  17257. (setq some-ind (if (looking-at-p "#\\+end_src")
  17258. block-content-ind (org-current-text-indentation))))
  17259. (indent-line-to (min block-content-ind some-ind))))
  17260. (org-babel-do-key-sequence-in-edit-buffer (kbd "TAB")))
  17261. (t
  17262. (let ((column (org--get-expected-indentation element nil)))
  17263. ;; Preserve current column.
  17264. (if (<= (current-column) (current-indentation))
  17265. (indent-line-to column)
  17266. (save-excursion (indent-line-to column))))
  17267. ;; Align node property. Also preserve current column.
  17268. (when (eq type 'node-property)
  17269. (let ((column (current-column)))
  17270. (org--align-node-property)
  17271. (org-move-to-column column))))))))
  17272. (defun org-indent-region (start end)
  17273. "Indent each non-blank line in the region.
  17274. Called from a program, START and END specify the region to
  17275. indent. The function will not indent contents of example blocks,
  17276. verse blocks and export blocks as leading white spaces are
  17277. assumed to be significant there."
  17278. (interactive "r")
  17279. (save-excursion
  17280. (goto-char start)
  17281. (skip-chars-forward " \r\t\n")
  17282. (unless (eobp) (beginning-of-line))
  17283. (let ((indent-to
  17284. (lambda (ind pos)
  17285. ;; Set IND as indentation for all lines between point and
  17286. ;; POS. Blank lines are ignored. Leave point after POS
  17287. ;; once done.
  17288. (let ((limit (copy-marker pos)))
  17289. (while (< (point) limit)
  17290. (unless (looking-at-p "[ \t]*$") (indent-line-to ind))
  17291. (forward-line))
  17292. (set-marker limit nil))))
  17293. (end (copy-marker end)))
  17294. (while (< (point) end)
  17295. (if (or (looking-at-p " \r\t\n") (org-at-heading-p)) (forward-line)
  17296. (let* ((element (org-element-at-point))
  17297. (type (org-element-type element))
  17298. (element-end (copy-marker (org-element-property :end element)))
  17299. (ind (org--get-expected-indentation element nil)))
  17300. (cond
  17301. ;; Element indented as a single block. Example blocks
  17302. ;; preserving indentation are a special case since the
  17303. ;; "contents" must not be indented whereas the block
  17304. ;; boundaries can.
  17305. ((or (memq type '(export-block latex-environment))
  17306. (and (eq type 'example-block)
  17307. (not
  17308. (or org-src-preserve-indentation
  17309. (org-element-property :preserve-indent element)))))
  17310. (let ((offset (- ind (current-indentation))))
  17311. (unless (zerop offset)
  17312. (indent-rigidly (org-element-property :begin element)
  17313. (org-element-property :end element)
  17314. offset)))
  17315. (goto-char element-end))
  17316. ;; Elements indented line wise. Be sure to exclude
  17317. ;; example blocks (preserving indentation) and source
  17318. ;; blocks from this category as they are treated
  17319. ;; specially later.
  17320. ((or (memq type '(paragraph table table-row))
  17321. (not (or (org-element-property :contents-begin element)
  17322. (memq type '(example-block src-block)))))
  17323. (when (eq type 'node-property)
  17324. (org--align-node-property)
  17325. (beginning-of-line))
  17326. (funcall indent-to ind (min element-end end)))
  17327. ;; Elements consisting of three parts: before the
  17328. ;; contents, the contents, and after the contents. The
  17329. ;; contents are treated specially, according to the
  17330. ;; element type, or not indented at all. Other parts are
  17331. ;; indented as a single block.
  17332. (t
  17333. (let* ((post (copy-marker
  17334. (org-element-property :post-affiliated element)))
  17335. (cbeg
  17336. (copy-marker
  17337. (cond
  17338. ((not (org-element-property :contents-begin element))
  17339. ;; Fake contents for source blocks.
  17340. (org-with-wide-buffer
  17341. (goto-char post)
  17342. (line-beginning-position 2)))
  17343. ((memq type '(footnote-definition item plain-list))
  17344. ;; Contents in these elements could start on
  17345. ;; the same line as the beginning of the
  17346. ;; element. Make sure we start indenting
  17347. ;; from the second line.
  17348. (org-with-wide-buffer
  17349. (goto-char post)
  17350. (end-of-line)
  17351. (skip-chars-forward " \r\t\n")
  17352. (if (eobp) (point) (line-beginning-position))))
  17353. (t (org-element-property :contents-begin element)))))
  17354. (cend (copy-marker
  17355. (or (org-element-property :contents-end element)
  17356. ;; Fake contents for source blocks.
  17357. (org-with-wide-buffer
  17358. (goto-char element-end)
  17359. (skip-chars-backward " \r\t\n")
  17360. (line-beginning-position)))
  17361. t)))
  17362. ;; Do not change items indentation individually as it
  17363. ;; might break the list as a whole. On the other
  17364. ;; hand, when at a plain list, indent it as a whole.
  17365. (cond ((eq type 'plain-list)
  17366. (let ((offset (- ind (org-current-text-indentation))))
  17367. (unless (zerop offset)
  17368. (indent-rigidly (org-element-property :begin element)
  17369. (org-element-property :end element)
  17370. offset))
  17371. (goto-char cbeg)))
  17372. ((eq type 'item) (goto-char cbeg))
  17373. (t (funcall indent-to ind (min cbeg end))))
  17374. (when (< (point) end)
  17375. (cl-case type
  17376. ((example-block verse-block))
  17377. (src-block
  17378. ;; In a source block, indent source code
  17379. ;; according to language major mode, but only if
  17380. ;; `org-src-tab-acts-natively' is non-nil.
  17381. (when (and (< (point) end) org-src-tab-acts-natively)
  17382. (ignore-errors
  17383. (org-babel-do-in-edit-buffer
  17384. (indent-region (point-min) (point-max))))))
  17385. (t (org-indent-region (point) (min cend end))))
  17386. (goto-char (min cend end))
  17387. (when (< (point) end)
  17388. (funcall indent-to ind (min element-end end))))
  17389. (set-marker post nil)
  17390. (set-marker cbeg nil)
  17391. (set-marker cend nil))))
  17392. (set-marker element-end nil))))
  17393. (set-marker end nil))))
  17394. (defun org-indent-drawer ()
  17395. "Indent the drawer at point."
  17396. (interactive)
  17397. (unless (save-excursion
  17398. (beginning-of-line)
  17399. (looking-at-p org-drawer-regexp))
  17400. (user-error "Not at a drawer"))
  17401. (let ((element (org-element-at-point-no-context)))
  17402. (unless (memq (org-element-type element) '(drawer property-drawer))
  17403. (user-error "Not at a drawer"))
  17404. (org-with-wide-buffer
  17405. (org-indent-region (org-element-property :begin element)
  17406. (org-element-property :end element))))
  17407. (message "Drawer at point indented"))
  17408. (defun org-indent-block ()
  17409. "Indent the block at point."
  17410. (interactive)
  17411. (unless (save-excursion
  17412. (beginning-of-line)
  17413. (let ((case-fold-search t))
  17414. (looking-at-p "[ \t]*#\\+\\(begin\\|end\\)_")))
  17415. (user-error "Not at a block"))
  17416. (let ((element (org-element-at-point-no-context)))
  17417. (unless (memq (org-element-type element)
  17418. '(comment-block center-block dynamic-block example-block
  17419. export-block quote-block special-block
  17420. src-block verse-block))
  17421. (user-error "Not at a block"))
  17422. (org-with-wide-buffer
  17423. (org-indent-region (org-element-property :begin element)
  17424. (org-element-property :end element))))
  17425. (message "Block at point indented"))
  17426. ;;; Filling
  17427. ;; We use our own fill-paragraph and auto-fill functions.
  17428. ;; `org-fill-paragraph' relies on adaptive filling and context
  17429. ;; checking. Appropriate `fill-prefix' is computed with
  17430. ;; `org-adaptive-fill-function'.
  17431. ;; `org-auto-fill-function' takes care of auto-filling. It calls
  17432. ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
  17433. ;; `org-adaptive-fill-function' value. Internally,
  17434. ;; `org-comment-line-break-function' breaks the line.
  17435. ;; `org-setup-filling' installs filling and auto-filling related
  17436. ;; variables during `org-mode' initialization.
  17437. (defvar org--single-lines-list-is-paragraph) ; defined later
  17438. (defun org-setup-filling ()
  17439. (require 'org-element)
  17440. ;; Prevent auto-fill from inserting unwanted new items.
  17441. (setq-local fill-nobreak-predicate
  17442. (org-uniquify
  17443. (append fill-nobreak-predicate
  17444. '(org-fill-line-break-nobreak-p
  17445. org-fill-n-macro-as-item-nobreak-p
  17446. org-fill-paragraph-with-timestamp-nobreak-p))))
  17447. (let ((paragraph-ending (substring org-element-paragraph-separate 1)))
  17448. (setq-local paragraph-start paragraph-ending)
  17449. (setq-local paragraph-separate paragraph-ending))
  17450. (setq-local fill-paragraph-function 'org-fill-paragraph)
  17451. (setq-local fill-forward-paragraph-function
  17452. (lambda (&optional arg)
  17453. (let ((org--single-lines-list-is-paragraph nil))
  17454. (org-forward-paragraph arg))))
  17455. (setq-local auto-fill-inhibit-regexp nil)
  17456. (setq-local adaptive-fill-function 'org-adaptive-fill-function)
  17457. (setq-local normal-auto-fill-function 'org-auto-fill-function)
  17458. (setq-local comment-line-break-function 'org-comment-line-break-function))
  17459. (defun org-fill-line-break-nobreak-p ()
  17460. "Non-nil when a new line at point would create an Org line break."
  17461. (save-excursion
  17462. (skip-chars-backward " \t")
  17463. (skip-chars-backward "\\\\")
  17464. (looking-at "\\\\\\\\\\($\\|[^\\]\\)")))
  17465. (defun org-fill-paragraph-with-timestamp-nobreak-p ()
  17466. "Non-nil when a new line at point would split a timestamp."
  17467. (and (org-at-timestamp-p 'lax)
  17468. (not (looking-at org-ts-regexp-both))))
  17469. (defun org-fill-n-macro-as-item-nobreak-p ()
  17470. "Non-nil when a new line at point would create a new list."
  17471. ;; During export, a "n" macro followed by a dot or a closing
  17472. ;; parenthesis can end up being parsed as a new list item.
  17473. (looking-at-p "[ \t]*{{{n\\(?:([^\n)]*)\\)?}}}[.)]\\(?:$\\| \\)"))
  17474. (defun org-adaptive-fill-function ()
  17475. "Compute a fill prefix for the current line.
  17476. Return fill prefix, as a string, or nil if current line isn't
  17477. meant to be filled. For convenience, if `adaptive-fill-regexp'
  17478. matches in paragraphs or comments, use it."
  17479. (org-with-wide-buffer
  17480. (unless (org-at-heading-p)
  17481. (let* ((p (line-beginning-position))
  17482. (element (save-excursion
  17483. (beginning-of-line)
  17484. (org-element-at-point)))
  17485. (type (org-element-type element))
  17486. (post-affiliated (org-element-property :post-affiliated element)))
  17487. (unless (< p post-affiliated)
  17488. (cl-case type
  17489. (comment
  17490. (save-excursion
  17491. (beginning-of-line)
  17492. (looking-at "[ \t]*")
  17493. (concat (match-string 0) "# ")))
  17494. (footnote-definition "")
  17495. ((item plain-list)
  17496. (make-string (org-list-item-body-column post-affiliated) ?\s))
  17497. (paragraph
  17498. ;; Fill prefix is usually the same as the current line,
  17499. ;; unless the paragraph is at the beginning of an item.
  17500. (let ((parent (org-element-property :parent element)))
  17501. (save-excursion
  17502. (beginning-of-line)
  17503. (cond ((eq (org-element-type parent) 'item)
  17504. (make-string (org-list-item-body-column
  17505. (org-element-property :begin parent))
  17506. ?\s))
  17507. ((and adaptive-fill-regexp
  17508. ;; Locally disable
  17509. ;; `adaptive-fill-function' to let
  17510. ;; `fill-context-prefix' handle
  17511. ;; `adaptive-fill-regexp' variable.
  17512. (let (adaptive-fill-function)
  17513. (fill-context-prefix
  17514. post-affiliated
  17515. (org-element-property :end element)))))
  17516. ((looking-at "[ \t]+") (match-string 0))
  17517. (t "")))))
  17518. (comment-block
  17519. ;; Only fill contents if P is within block boundaries.
  17520. (let* ((cbeg (save-excursion (goto-char post-affiliated)
  17521. (forward-line)
  17522. (point)))
  17523. (cend (save-excursion
  17524. (goto-char (org-element-property :end element))
  17525. (skip-chars-backward " \r\t\n")
  17526. (line-beginning-position))))
  17527. (when (and (>= p cbeg) (< p cend))
  17528. (if (save-excursion (beginning-of-line) (looking-at "[ \t]+"))
  17529. (match-string 0)
  17530. ""))))))))))
  17531. (defun org-fill-element (&optional justify)
  17532. "Fill element at point, when applicable.
  17533. This function only applies to comment blocks, comments, example
  17534. blocks and paragraphs. Also, as a special case, re-align table
  17535. when point is at one.
  17536. If JUSTIFY is non-nil (interactively, with prefix argument),
  17537. justify as well. If `sentence-end-double-space' is non-nil, then
  17538. period followed by one space does not end a sentence, so don't
  17539. break a line there. The variable `fill-column' controls the
  17540. width for filling.
  17541. For convenience, when point is at a plain list, an item or
  17542. a footnote definition, try to fill the first paragraph within."
  17543. (with-syntax-table org-mode-transpose-word-syntax-table
  17544. ;; Move to end of line in order to get the first paragraph within
  17545. ;; a plain list or a footnote definition.
  17546. (let ((element (save-excursion (end-of-line) (org-element-at-point))))
  17547. ;; First check if point is in a blank line at the beginning of
  17548. ;; the buffer. In that case, ignore filling.
  17549. (cl-case (org-element-type element)
  17550. ;; Use major mode filling function is source blocks.
  17551. (src-block
  17552. (let ((regionp (region-active-p)))
  17553. (org-babel-do-in-edit-buffer
  17554. ;; `org-babel-do-in-edit-buffer' will preserve region if it
  17555. ;; is within src block contents. Otherwise, the region
  17556. ;; crosses src block boundaries. We re-fill the whole src
  17557. ;; block in such scenario.
  17558. (when (and regionp (not (region-active-p)))
  17559. (push-mark (point-min))
  17560. (goto-char (point-max))
  17561. (setq mark-active t))
  17562. (funcall-interactively #'fill-paragraph justify 'region))))
  17563. ;; Align Org tables, leave table.el tables as-is.
  17564. (table-row (org-table-align) t)
  17565. (table
  17566. (when (eq (org-element-property :type element) 'org)
  17567. (save-excursion
  17568. (goto-char (org-element-property :post-affiliated element))
  17569. (org-table-align)))
  17570. t)
  17571. (paragraph
  17572. ;; Paragraphs may contain `line-break' type objects.
  17573. (let ((beg (max (point-min)
  17574. (org-element-property :contents-begin element)))
  17575. (end (min (point-max)
  17576. (org-element-property :contents-end element))))
  17577. ;; Do nothing if point is at an affiliated keyword.
  17578. (if (< (line-end-position) beg) t
  17579. ;; Fill paragraph, taking line breaks into account.
  17580. (save-excursion
  17581. (goto-char beg)
  17582. (let ((cuts (list beg)))
  17583. (while (re-search-forward "\\\\\\\\[ \t]*\n" end t)
  17584. (when (eq 'line-break
  17585. (org-element-type
  17586. (save-excursion (backward-char)
  17587. (org-element-context))))
  17588. (push (point) cuts)))
  17589. (dolist (c (delq end cuts))
  17590. (fill-region-as-paragraph c end justify)
  17591. (setq end c))))
  17592. t)))
  17593. ;; Contents of `comment-block' type elements should be
  17594. ;; filled as plain text, but only if point is within block
  17595. ;; markers.
  17596. (comment-block
  17597. (let* ((case-fold-search t)
  17598. (beg (save-excursion
  17599. (goto-char (org-element-property :begin element))
  17600. (re-search-forward "^[ \t]*#\\+begin_comment" nil t)
  17601. (forward-line)
  17602. (point)))
  17603. (end (save-excursion
  17604. (goto-char (org-element-property :end element))
  17605. (re-search-backward "^[ \t]*#\\+end_comment" nil t)
  17606. (line-beginning-position))))
  17607. (if (or (< (point) beg) (> (point) end)) t
  17608. (fill-region-as-paragraph
  17609. (save-excursion (end-of-line)
  17610. (re-search-backward "^[ \t]*$" beg 'move)
  17611. (line-beginning-position))
  17612. (save-excursion (beginning-of-line)
  17613. (re-search-forward "^[ \t]*$" end 'move)
  17614. (line-beginning-position))
  17615. justify))))
  17616. ;; Fill comments.
  17617. (comment
  17618. (let ((begin (org-element-property :post-affiliated element))
  17619. (end (org-element-property :end element)))
  17620. (when (and (>= (point) begin) (<= (point) end))
  17621. (let ((begin (save-excursion
  17622. (end-of-line)
  17623. (if (re-search-backward "^[ \t]*#[ \t]*$" begin t)
  17624. (progn (forward-line) (point))
  17625. begin)))
  17626. (end (save-excursion
  17627. (end-of-line)
  17628. (if (re-search-forward "^[ \t]*#[ \t]*$" end 'move)
  17629. (1- (line-beginning-position))
  17630. (skip-chars-backward " \r\t\n")
  17631. (line-end-position)))))
  17632. ;; Do not fill comments when at a blank line.
  17633. (when (> end begin)
  17634. (let ((fill-prefix
  17635. (save-excursion
  17636. (beginning-of-line)
  17637. (looking-at "[ \t]*#")
  17638. (let ((comment-prefix (match-string 0)))
  17639. (goto-char (match-end 0))
  17640. (if (looking-at adaptive-fill-regexp)
  17641. (concat comment-prefix (match-string 0))
  17642. (concat comment-prefix " "))))))
  17643. (save-excursion
  17644. (fill-region-as-paragraph begin end justify))))))
  17645. t))
  17646. ;; Ignore every other element.
  17647. (otherwise t)))))
  17648. (defun org-fill-paragraph (&optional justify region)
  17649. "Fill element at point, when applicable.
  17650. This function only applies to comment blocks, comments, example
  17651. blocks and paragraphs. Also, as a special case, re-align table
  17652. when point is at one.
  17653. For convenience, when point is at a plain list, an item or
  17654. a footnote definition, try to fill the first paragraph within.
  17655. If JUSTIFY is non-nil (interactively, with prefix argument),
  17656. justify as well. If `sentence-end-double-space' is non-nil, then
  17657. period followed by one space does not end a sentence, so don't
  17658. break a line there. The variable `fill-column' controls the
  17659. width for filling.
  17660. The REGION argument is non-nil if called interactively; in that
  17661. case, if Transient Mark mode is enabled and the mark is active,
  17662. fill each of the elements in the active region, instead of just
  17663. filling the current element."
  17664. (interactive (progn
  17665. (barf-if-buffer-read-only)
  17666. (list (when current-prefix-arg 'full) t)))
  17667. (let ((hash (and (not (buffer-modified-p))
  17668. (org-buffer-hash))))
  17669. (cond
  17670. ((and region transient-mark-mode mark-active
  17671. (not (eq (region-beginning) (region-end))))
  17672. (let ((origin (point-marker))
  17673. (start (region-beginning)))
  17674. (unwind-protect
  17675. (progn
  17676. (goto-char (region-end))
  17677. (skip-chars-backward " \t\n")
  17678. (let ((org--single-lines-list-is-paragraph nil))
  17679. (while (> (point) start)
  17680. (org-fill-element justify)
  17681. (org-backward-paragraph)
  17682. (skip-chars-backward " \t\n"))))
  17683. (goto-char origin)
  17684. (set-marker origin nil))))
  17685. (t
  17686. (save-excursion
  17687. (when (org-match-line "[ \t]*$")
  17688. (skip-chars-forward " \t\n"))
  17689. (org-fill-element justify))))
  17690. ;; If we didn't change anything in the buffer (and the buffer was
  17691. ;; previously unmodified), then flip the modification status back
  17692. ;; to "unchanged".
  17693. (when (and hash (equal hash (org-buffer-hash)))
  17694. (set-buffer-modified-p nil))
  17695. ;; Return non-nil.
  17696. t))
  17697. (defun org-auto-fill-function ()
  17698. "Auto-fill function."
  17699. ;; Check if auto-filling is meaningful.
  17700. (let ((fc (current-fill-column)))
  17701. (when (and fc (> (current-column) fc))
  17702. (let* ((fill-prefix (org-adaptive-fill-function))
  17703. ;; Enforce empty fill prefix, if required. Otherwise, it
  17704. ;; will be computed again.
  17705. (adaptive-fill-mode (not (equal fill-prefix ""))))
  17706. (when fill-prefix (do-auto-fill))))))
  17707. (defun org-comment-line-break-function (&optional soft)
  17708. "Break line at point and indent, continuing comment if within one.
  17709. The inserted newline is marked hard if variable
  17710. `use-hard-newlines' is true, unless optional argument SOFT is
  17711. non-nil.
  17712. This function is a simplified version of `comment-indent-new-line'
  17713. that bypasses the complex Emacs machinery dealing with comments.
  17714. We instead rely on Org parser, utilizing `org-adaptive-fill-function'"
  17715. (let ((fill-prefix (org-adaptive-fill-function)))
  17716. (if soft (insert-and-inherit ?\n) (newline 1))
  17717. (save-excursion (forward-char -1) (delete-horizontal-space))
  17718. (delete-horizontal-space)
  17719. (indent-to-left-margin)
  17720. (when fill-prefix
  17721. (insert-before-markers-and-inherit fill-prefix))))
  17722. ;;; Fixed Width Areas
  17723. (defun org-toggle-fixed-width ()
  17724. "Toggle fixed-width markup.
  17725. Add or remove fixed-width markup on current line, whenever it
  17726. makes sense. Return an error otherwise.
  17727. If a region is active and if it contains only fixed-width areas
  17728. or blank lines, remove all fixed-width markup in it. If the
  17729. region contains anything else, convert all non-fixed-width lines
  17730. to fixed-width ones.
  17731. Blank lines at the end of the region are ignored unless the
  17732. region only contains such lines."
  17733. (interactive)
  17734. (if (not (org-region-active-p))
  17735. ;; No region:
  17736. ;;
  17737. ;; Remove fixed width marker only in a fixed-with element.
  17738. ;;
  17739. ;; Add fixed width maker in paragraphs, in blank lines after
  17740. ;; elements or at the beginning of a headline or an inlinetask,
  17741. ;; and before any one-line elements (e.g., a clock).
  17742. (progn
  17743. (beginning-of-line)
  17744. (let* ((element (org-element-at-point))
  17745. (type (org-element-type element)))
  17746. (cond
  17747. ((and (eq type 'fixed-width)
  17748. (looking-at "[ \t]*\\(:\\(?: \\|$\\)\\)"))
  17749. (replace-match
  17750. "" nil nil nil (if (= (line-end-position) (match-end 0)) 0 1)))
  17751. ((and (memq type '(babel-call clock comment diary-sexp headline
  17752. horizontal-rule keyword paragraph
  17753. planning))
  17754. (<= (org-element-property :post-affiliated element) (point)))
  17755. (skip-chars-forward " \t")
  17756. (insert ": "))
  17757. ((and (looking-at-p "[ \t]*$")
  17758. (or (eq type 'inlinetask)
  17759. (save-excursion
  17760. (skip-chars-forward " \r\t\n")
  17761. (<= (org-element-property :end element) (point)))))
  17762. (delete-region (point) (line-end-position))
  17763. (org-indent-line)
  17764. (insert ": "))
  17765. (t (user-error "Cannot insert a fixed-width line here")))))
  17766. ;; Region active.
  17767. (let* ((begin (save-excursion
  17768. (goto-char (region-beginning))
  17769. (line-beginning-position)))
  17770. (end (copy-marker
  17771. (save-excursion
  17772. (goto-char (region-end))
  17773. (unless (eolp) (beginning-of-line))
  17774. (if (save-excursion (re-search-backward "\\S-" begin t))
  17775. (progn (skip-chars-backward " \r\t\n") (point))
  17776. (point)))))
  17777. (all-fixed-width-p
  17778. (catch 'not-all-p
  17779. (save-excursion
  17780. (goto-char begin)
  17781. (skip-chars-forward " \r\t\n")
  17782. (when (eobp) (throw 'not-all-p nil))
  17783. (while (< (point) end)
  17784. (let ((element (org-element-at-point)))
  17785. (if (eq (org-element-type element) 'fixed-width)
  17786. (goto-char (org-element-property :end element))
  17787. (throw 'not-all-p nil))))
  17788. t))))
  17789. (if all-fixed-width-p
  17790. (save-excursion
  17791. (goto-char begin)
  17792. (while (< (point) end)
  17793. (when (looking-at "[ \t]*\\(:\\(?: \\|$\\)\\)")
  17794. (replace-match
  17795. "" nil nil nil
  17796. (if (= (line-end-position) (match-end 0)) 0 1)))
  17797. (forward-line)))
  17798. (let ((min-ind (point-max)))
  17799. ;; Find minimum indentation across all lines.
  17800. (save-excursion
  17801. (goto-char begin)
  17802. (if (not (save-excursion (re-search-forward "\\S-" end t)))
  17803. (setq min-ind 0)
  17804. (catch 'zerop
  17805. (while (< (point) end)
  17806. (unless (looking-at-p "[ \t]*$")
  17807. (let ((ind (org-current-text-indentation)))
  17808. (setq min-ind (min min-ind ind))
  17809. (when (zerop ind) (throw 'zerop t))))
  17810. (forward-line)))))
  17811. ;; Loop over all lines and add fixed-width markup everywhere
  17812. ;; but in fixed-width lines.
  17813. (save-excursion
  17814. (goto-char begin)
  17815. (while (< (point) end)
  17816. (cond
  17817. ((org-at-heading-p)
  17818. (insert ": ")
  17819. (forward-line)
  17820. (while (and (< (point) end) (looking-at-p "[ \t]*$"))
  17821. (insert ":")
  17822. (forward-line)))
  17823. ((looking-at-p "[ \t]*:\\( \\|$\\)")
  17824. (let* ((element (org-element-at-point))
  17825. (element-end (org-element-property :end element)))
  17826. (if (eq (org-element-type element) 'fixed-width)
  17827. (progn (goto-char element-end)
  17828. (skip-chars-backward " \r\t\n")
  17829. (forward-line))
  17830. (let ((limit (min end element-end)))
  17831. (while (< (point) limit)
  17832. (org-move-to-column min-ind t)
  17833. (insert ": ")
  17834. (forward-line))))))
  17835. (t
  17836. (org-move-to-column min-ind t)
  17837. (insert ": ")
  17838. (forward-line)))))))
  17839. (set-marker end nil))))
  17840. ;;; Blocks
  17841. (defun org-block-map (function &optional start end)
  17842. "Call FUNCTION at the head of all source blocks in the current buffer.
  17843. Optional arguments START and END can be used to limit the range."
  17844. (let ((start (or start (point-min)))
  17845. (end (or end (point-max))))
  17846. (save-excursion
  17847. (goto-char start)
  17848. (while (and (< (point) end) (re-search-forward org-block-regexp end t))
  17849. (save-excursion
  17850. (save-match-data
  17851. (goto-char (match-beginning 0))
  17852. (funcall function)))))))
  17853. (defun org-next-block (arg &optional backward block-regexp)
  17854. "Jump to the next block.
  17855. With a prefix argument ARG, jump forward ARG many blocks.
  17856. When BACKWARD is non-nil, jump to the previous block.
  17857. When BLOCK-REGEXP is non-nil, use this regexp to find blocks.
  17858. Match data is set according to this regexp when the function
  17859. returns.
  17860. Return point at beginning of the opening line of found block.
  17861. Throw an error if no block is found."
  17862. (interactive "p")
  17863. (let ((re (or block-regexp "^[ \t]*#\\+BEGIN"))
  17864. (case-fold-search t)
  17865. (search-fn (if backward #'re-search-backward #'re-search-forward))
  17866. (count (or arg 1))
  17867. (origin (point))
  17868. last-element)
  17869. (if backward (beginning-of-line) (end-of-line))
  17870. (while (and (> count 0) (funcall search-fn re nil t))
  17871. (let ((element (save-excursion
  17872. (goto-char (match-beginning 0))
  17873. (save-match-data (org-element-at-point)))))
  17874. (when (and (memq (org-element-type element)
  17875. '(center-block comment-block dynamic-block
  17876. example-block export-block quote-block
  17877. special-block src-block verse-block))
  17878. (<= (match-beginning 0)
  17879. (org-element-property :post-affiliated element)))
  17880. (setq last-element element)
  17881. (cl-decf count))))
  17882. (if (= count 0)
  17883. (prog1 (goto-char (org-element-property :post-affiliated last-element))
  17884. (save-match-data (org-fold-show-context)))
  17885. (goto-char origin)
  17886. (user-error "No %s code blocks" (if backward "previous" "further")))))
  17887. (defun org-previous-block (arg &optional block-regexp)
  17888. "Jump to the previous block.
  17889. With a prefix argument ARG, jump backward ARG many source blocks.
  17890. When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
  17891. (interactive "p")
  17892. (org-next-block arg t block-regexp))
  17893. ;;; Comments
  17894. ;; Org comments syntax is quite complex. It requires the entire line
  17895. ;; to be just a comment. Also, even with the right syntax at the
  17896. ;; beginning of line, some elements (e.g., verse-block or
  17897. ;; example-block) don't accept comments. Usual Emacs comment commands
  17898. ;; cannot cope with those requirements. Therefore, Org replaces them.
  17899. ;; Org still relies on 'comment-dwim', but cannot trust
  17900. ;; 'comment-only-p'. So, 'comment-region-function' and
  17901. ;; 'uncomment-region-function' both point
  17902. ;; to 'org-comment-or-uncomment-region'. Eventually,
  17903. ;; 'org-insert-comment' takes care of insertion of comments at the
  17904. ;; beginning of line.
  17905. ;; 'org-setup-comments-handling' install comments related variables
  17906. ;; during 'org-mode' initialization.
  17907. (defun org-setup-comments-handling ()
  17908. (interactive)
  17909. (setq-local comment-use-syntax nil)
  17910. (setq-local comment-start "# ")
  17911. (setq-local comment-start-skip "^\\s-*#\\(?: \\|$\\)")
  17912. (setq-local comment-insert-comment-function 'org-insert-comment)
  17913. (setq-local comment-region-function 'org-comment-or-uncomment-region)
  17914. (setq-local uncomment-region-function 'org-comment-or-uncomment-region))
  17915. (defun org-insert-comment ()
  17916. "Insert an empty comment above current line.
  17917. If the line is empty, insert comment at its beginning. When
  17918. point is within a source block, comment according to the related
  17919. major mode."
  17920. (if (let ((element (org-element-at-point)))
  17921. (and (eq (org-element-type element) 'src-block)
  17922. (< (save-excursion
  17923. (goto-char (org-element-property :post-affiliated element))
  17924. (line-end-position))
  17925. (point))
  17926. (> (save-excursion
  17927. (goto-char (org-element-property :end element))
  17928. (skip-chars-backward " \r\t\n")
  17929. (line-beginning-position))
  17930. (point))))
  17931. (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
  17932. (beginning-of-line)
  17933. (if (looking-at "\\s-*$") (delete-region (point) (line-end-position))
  17934. (open-line 1))
  17935. (org-indent-line)
  17936. (insert "# ")))
  17937. (defvar comment-empty-lines) ; From newcomment.el.
  17938. (defun org-comment-or-uncomment-region (beg end &rest _)
  17939. "Comment or uncomment each non-blank line in the region.
  17940. Uncomment each non-blank line between BEG and END if it only
  17941. contains commented lines. Otherwise, comment them. If region is
  17942. strictly within a source block, use appropriate comment syntax."
  17943. (if (let ((element (org-element-at-point)))
  17944. (and (eq (org-element-type element) 'src-block)
  17945. (< (save-excursion
  17946. (goto-char (org-element-property :post-affiliated element))
  17947. (line-end-position))
  17948. beg)
  17949. (>= (save-excursion
  17950. (goto-char (org-element-property :end element))
  17951. (skip-chars-backward " \r\t\n")
  17952. (line-beginning-position))
  17953. end)))
  17954. ;; Translate region boundaries for the Org buffer to the source
  17955. ;; buffer.
  17956. (let ((offset (- end beg)))
  17957. (save-excursion
  17958. (goto-char beg)
  17959. (org-babel-do-in-edit-buffer
  17960. (comment-or-uncomment-region (point) (+ offset (point))))))
  17961. (save-restriction
  17962. ;; Restrict region
  17963. (narrow-to-region (save-excursion (goto-char beg)
  17964. (skip-chars-forward " \r\t\n" end)
  17965. (line-beginning-position))
  17966. (save-excursion (goto-char end)
  17967. (skip-chars-backward " \r\t\n" beg)
  17968. (line-end-position)))
  17969. (let ((uncommentp
  17970. ;; UNCOMMENTP is non-nil when every non blank line between
  17971. ;; BEG and END is a comment.
  17972. (save-excursion
  17973. (goto-char (point-min))
  17974. (while (and (not (eobp))
  17975. (let ((element (org-element-at-point)))
  17976. (and (eq (org-element-type element) 'comment)
  17977. (goto-char (min (point-max)
  17978. (org-element-property
  17979. :end element)))))))
  17980. (eobp))))
  17981. (if uncommentp
  17982. ;; Only blank lines and comments in region: uncomment it.
  17983. (save-excursion
  17984. (goto-char (point-min))
  17985. (while (not (eobp))
  17986. (when (looking-at "[ \t]*\\(#\\(?: \\|$\\)\\)")
  17987. (replace-match "" nil nil nil 1))
  17988. (forward-line)))
  17989. ;; Comment each line in region.
  17990. (let ((min-indent (point-max)))
  17991. ;; First find the minimum indentation across all lines.
  17992. (save-excursion
  17993. (goto-char (point-min))
  17994. (while (and (not (eobp)) (not (zerop min-indent)))
  17995. (unless (looking-at "[ \t]*$")
  17996. (setq min-indent (min min-indent (org-current-text-indentation))))
  17997. (forward-line)))
  17998. ;; Then loop over all lines.
  17999. (save-excursion
  18000. (goto-char (point-min))
  18001. (while (not (eobp))
  18002. (unless (and (not comment-empty-lines) (looking-at "[ \t]*$"))
  18003. ;; Don't get fooled by invisible text (e.g. link path)
  18004. ;; when moving to column MIN-INDENT.
  18005. (let ((buffer-invisibility-spec nil))
  18006. (org-move-to-column min-indent t))
  18007. (insert comment-start))
  18008. (forward-line)))))))))
  18009. (defun org-comment-dwim (_arg)
  18010. "Call the comment command you mean.
  18011. Call `org-toggle-comment' if on a heading, otherwise call
  18012. `comment-dwim', within a source edit buffer if needed."
  18013. (interactive "*P")
  18014. (cond ((org-at-heading-p)
  18015. (call-interactively #'org-toggle-comment))
  18016. ((org-in-src-block-p)
  18017. (org-babel-do-in-edit-buffer (call-interactively #'comment-dwim)))
  18018. (t (call-interactively #'comment-dwim))))
  18019. ;;; Timestamps API
  18020. ;; This section contains tools to operate on, or create, timestamp
  18021. ;; objects, as returned by, e.g. `org-element-context'.
  18022. (defun org-timestamp-from-string (s)
  18023. "Convert Org timestamp S, as a string, into a timestamp object.
  18024. Return nil if S is not a valid timestamp string."
  18025. (when (org-string-nw-p s)
  18026. (with-temp-buffer
  18027. (save-excursion (insert s))
  18028. (org-element-timestamp-parser))))
  18029. (defun org-timestamp-from-time (time &optional with-time inactive)
  18030. "Convert a time value into a timestamp object.
  18031. TIME is an Emacs internal time representation, as returned, e.g.,
  18032. by `current-time'.
  18033. When optional argument WITH-TIME is non-nil, return a timestamp
  18034. object with a time part, i.e., with hours and minutes.
  18035. Return an inactive timestamp if INACTIVE is non-nil. Otherwise,
  18036. return an active timestamp."
  18037. (pcase-let ((`(,_ ,minute ,hour ,day ,month ,year . ,_) (decode-time time)))
  18038. (org-element-create 'timestamp
  18039. (list :type (if inactive 'inactive 'active)
  18040. :year-start year
  18041. :month-start month
  18042. :day-start day
  18043. :hour-start (and with-time hour)
  18044. :minute-start (and with-time minute)))))
  18045. (defun org-timestamp-to-time (timestamp &optional end)
  18046. "Convert TIMESTAMP object into an Emacs internal time value.
  18047. Use end of date range or time range when END is non-nil.
  18048. Otherwise, use its start."
  18049. (org-encode-time
  18050. (append '(0)
  18051. (mapcar
  18052. (lambda (prop) (or (org-element-property prop timestamp) 0))
  18053. (if end '(:minute-end :hour-end :day-end :month-end :year-end)
  18054. '(:minute-start :hour-start :day-start :month-start
  18055. :year-start)))
  18056. '(nil -1 nil))))
  18057. (defun org-timestamp-has-time-p (timestamp)
  18058. "Non-nil when TIMESTAMP has a time specified."
  18059. (org-element-property :hour-start timestamp))
  18060. (defun org-timestamp-format (timestamp format &optional end utc)
  18061. "Format a TIMESTAMP object into a string.
  18062. FORMAT is a format specifier to be passed to
  18063. `format-time-string'.
  18064. When optional argument END is non-nil, use end of date-range or
  18065. time-range, if possible.
  18066. When optional argument UTC is non-nil, time is be expressed as
  18067. Universal Time."
  18068. (format-time-string format (org-timestamp-to-time timestamp end)
  18069. (and utc t)))
  18070. (defun org-timestamp-split-range (timestamp &optional end)
  18071. "Extract a TIMESTAMP object from a date or time range.
  18072. END, when non-nil, means extract the end of the range.
  18073. Otherwise, extract its start.
  18074. Return a new timestamp object."
  18075. (let ((type (org-element-property :type timestamp)))
  18076. (if (memq type '(active inactive diary)) timestamp
  18077. (let ((split-ts (org-element-copy timestamp)))
  18078. ;; Set new type.
  18079. (org-element-put-property
  18080. split-ts :type (if (eq type 'active-range) 'active 'inactive))
  18081. ;; Copy start properties over end properties if END is
  18082. ;; non-nil. Otherwise, copy end properties over `start' ones.
  18083. (let ((p-alist '((:minute-start . :minute-end)
  18084. (:hour-start . :hour-end)
  18085. (:day-start . :day-end)
  18086. (:month-start . :month-end)
  18087. (:year-start . :year-end))))
  18088. (dolist (p-cell p-alist)
  18089. (org-element-put-property
  18090. split-ts
  18091. (funcall (if end #'car #'cdr) p-cell)
  18092. (org-element-property
  18093. (funcall (if end #'cdr #'car) p-cell) split-ts)))
  18094. ;; Eventually refresh `:raw-value'.
  18095. (org-element-put-property split-ts :raw-value nil)
  18096. (org-element-put-property
  18097. split-ts :raw-value (org-element-interpret-data split-ts)))))))
  18098. (defun org-timestamp-translate (timestamp &optional boundary)
  18099. "Translate TIMESTAMP object to custom format.
  18100. Format string is defined in `org-time-stamp-custom-formats',
  18101. which see.
  18102. When optional argument BOUNDARY is non-nil, it is either the
  18103. symbol `start' or `end'. In this case, only translate the
  18104. starting or ending part of TIMESTAMP if it is a date or time
  18105. range. Otherwise, translate both parts.
  18106. Return timestamp as-is if `org-display-custom-times' is nil or if
  18107. it has a `diary' type."
  18108. (let ((type (org-element-property :type timestamp)))
  18109. (if (or (not org-display-custom-times) (eq type 'diary))
  18110. (org-element-interpret-data timestamp)
  18111. (let ((fmt (funcall (if (org-timestamp-has-time-p timestamp) #'cdr #'car)
  18112. org-time-stamp-custom-formats)))
  18113. (if (and (not boundary) (memq type '(active-range inactive-range)))
  18114. (concat (org-timestamp-format timestamp fmt)
  18115. "--"
  18116. (org-timestamp-format timestamp fmt t))
  18117. (org-timestamp-format timestamp fmt (eq boundary 'end)))))))
  18118. ;;; Other stuff
  18119. (defvar reftex-docstruct-symbol)
  18120. (defvar org--rds)
  18121. (defun org-reftex-citation ()
  18122. "Use `reftex-citation' to insert a citation into the buffer.
  18123. This looks for a line like
  18124. #+BIBLIOGRAPHY: foo plain option:-d
  18125. and derives from it that foo.bib is the bibliography file relevant
  18126. for this document. It then installs the necessary environment for RefTeX
  18127. to work in this buffer and calls `reftex-citation' to insert a citation
  18128. into the buffer.
  18129. Export of such citations to both LaTeX and HTML is handled by the contributed
  18130. package ox-bibtex by Taru Karttunen."
  18131. (interactive)
  18132. (let ((reftex-docstruct-symbol 'org--rds)
  18133. org--rds bib)
  18134. (org-with-wide-buffer
  18135. (let ((case-fold-search t)
  18136. (re "^[ \t]*#\\+BIBLIOGRAPHY:[ \t]+\\([^ \t\n]+\\)"))
  18137. (if (not (save-excursion
  18138. (or (re-search-forward re nil t)
  18139. (re-search-backward re nil t))))
  18140. (user-error "No bibliography defined in file")
  18141. (setq bib (concat (match-string 1) ".bib")
  18142. org--rds (list (list 'bib bib))))))
  18143. (call-interactively 'reftex-citation)))
  18144. ;;;; Functions extending outline functionality
  18145. (defun org-beginning-of-line (&optional n)
  18146. "Go to the beginning of the current visible line.
  18147. If this is a headline, and `org-special-ctrl-a/e' is not nil or
  18148. symbol `reversed', on the first attempt move to where the
  18149. headline text starts, and only move to beginning of line when the
  18150. cursor is already before the start of the text of the headline.
  18151. If `org-special-ctrl-a/e' is symbol `reversed' then go to the
  18152. start of the text on the second attempt.
  18153. With argument N not nil or 1, move forward N - 1 lines first."
  18154. (interactive "^p")
  18155. (let ((origin (point))
  18156. (special (pcase org-special-ctrl-a/e
  18157. (`(,C-a . ,_) C-a) (_ org-special-ctrl-a/e)))
  18158. deactivate-mark)
  18159. ;; First move to a visible line.
  18160. (if (bound-and-true-p visual-line-mode)
  18161. (beginning-of-visual-line n)
  18162. (move-beginning-of-line n)
  18163. ;; `move-beginning-of-line' may leave point after invisible
  18164. ;; characters if line starts with such of these (e.g., with
  18165. ;; a link at column 0). Really move to the beginning of the
  18166. ;; current visible line.
  18167. (beginning-of-line))
  18168. (cond
  18169. ;; No special behavior. Point is already at the beginning of
  18170. ;; a line, logical or visual.
  18171. ((not special))
  18172. ;; `beginning-of-visual-line' left point before logical beginning
  18173. ;; of line: point is at the beginning of a visual line. Bail
  18174. ;; out.
  18175. ((and (bound-and-true-p visual-line-mode) (not (bolp))))
  18176. ((let ((case-fold-search nil)) (looking-at org-complex-heading-regexp))
  18177. ;; At a headline, special position is before the title, but
  18178. ;; after any TODO keyword or priority cookie.
  18179. (let ((refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
  18180. (line-end-position)))
  18181. (bol (point)))
  18182. (if (eq special 'reversed)
  18183. (when (and (= origin bol) (eq last-command this-command))
  18184. (goto-char refpos))
  18185. (when (or (> origin refpos) (= origin bol))
  18186. (goto-char refpos)))))
  18187. ((and (looking-at org-list-full-item-re)
  18188. (memq (org-element-type (save-match-data (org-element-at-point)))
  18189. '(item plain-list)))
  18190. ;; Set special position at first white space character after
  18191. ;; bullet, and check-box, if any.
  18192. (let ((after-bullet
  18193. (let ((box (match-end 3)))
  18194. (cond ((not box) (match-end 1))
  18195. ((eq (char-after box) ?\s) (1+ box))
  18196. (t box)))))
  18197. (if (eq special 'reversed)
  18198. (when (and (= (point) origin) (eq last-command this-command))
  18199. (goto-char after-bullet))
  18200. (when (or (> origin after-bullet) (= (point) origin))
  18201. (goto-char after-bullet)))))
  18202. ;; No special context. Point is already at beginning of line.
  18203. (t nil))))
  18204. (defun org-end-of-line (&optional n)
  18205. "Go to the end of the line, but before ellipsis, if any.
  18206. If this is a headline, and `org-special-ctrl-a/e' is not nil or
  18207. symbol `reversed', ignore tags on the first attempt, and only
  18208. move to after the tags when the cursor is already beyond the end
  18209. of the headline.
  18210. If `org-special-ctrl-a/e' is symbol `reversed' then ignore tags
  18211. on the second attempt.
  18212. With argument N not nil or 1, move forward N - 1 lines first."
  18213. (interactive "^p")
  18214. (let ((origin (point))
  18215. (special (pcase org-special-ctrl-a/e
  18216. (`(,_ . ,C-e) C-e) (_ org-special-ctrl-a/e)))
  18217. deactivate-mark)
  18218. ;; First move to a visible line.
  18219. (if (bound-and-true-p visual-line-mode)
  18220. (beginning-of-visual-line n)
  18221. (move-beginning-of-line n))
  18222. (cond
  18223. ;; At a headline, with tags.
  18224. ((and special
  18225. (save-excursion
  18226. (beginning-of-line)
  18227. (let ((case-fold-search nil))
  18228. (looking-at org-complex-heading-regexp)))
  18229. (match-end 5))
  18230. (let ((tags (save-excursion
  18231. (goto-char (match-beginning 5))
  18232. (skip-chars-backward " \t")
  18233. (point)))
  18234. (visual-end (and (bound-and-true-p visual-line-mode)
  18235. (save-excursion
  18236. (end-of-visual-line)
  18237. (point)))))
  18238. ;; If `end-of-visual-line' brings us before end of line or
  18239. ;; even tags, i.e., the headline spans over multiple visual
  18240. ;; lines, move there.
  18241. (cond ((and visual-end
  18242. (< visual-end tags)
  18243. (<= origin visual-end))
  18244. (goto-char visual-end))
  18245. ((eq special 'reversed)
  18246. (if (and (= origin (line-end-position))
  18247. (eq this-command last-command))
  18248. (goto-char tags)
  18249. (end-of-line)))
  18250. (t
  18251. (if (or (< origin tags) (= origin (line-end-position)))
  18252. (goto-char tags)
  18253. (end-of-line))))))
  18254. ((bound-and-true-p visual-line-mode)
  18255. (let ((bol (line-beginning-position)))
  18256. (end-of-visual-line)
  18257. ;; If `end-of-visual-line' gets us past the ellipsis at the
  18258. ;; end of a line, backtrack and use `end-of-line' instead.
  18259. (when (/= bol (line-beginning-position))
  18260. (goto-char bol)
  18261. (end-of-line))))
  18262. (t (end-of-line)))))
  18263. (defun org-backward-sentence (&optional _arg)
  18264. "Go to beginning of sentence, or beginning of table field.
  18265. This will call `backward-sentence' or `org-table-beginning-of-field',
  18266. depending on context."
  18267. (interactive)
  18268. (let* ((element (org-element-at-point))
  18269. (contents-begin (org-element-property :contents-begin element))
  18270. (table (org-element-lineage element '(table) t)))
  18271. (if (and table
  18272. (> (point) contents-begin)
  18273. (<= (point) (org-element-property :contents-end table)))
  18274. (call-interactively #'org-table-beginning-of-field)
  18275. (save-restriction
  18276. (when (and contents-begin
  18277. (< (point-min) contents-begin)
  18278. (> (point) contents-begin))
  18279. (narrow-to-region contents-begin
  18280. (org-element-property :contents-end element)))
  18281. (call-interactively #'backward-sentence)))))
  18282. (defun org-forward-sentence (&optional _arg)
  18283. "Go to end of sentence, or end of table field.
  18284. This will call `forward-sentence' or `org-table-end-of-field',
  18285. depending on context."
  18286. (interactive)
  18287. (if (and (org-at-heading-p)
  18288. (save-restriction (skip-chars-forward " \t") (not (eolp))))
  18289. (save-restriction
  18290. (narrow-to-region (line-beginning-position) (line-end-position))
  18291. (call-interactively #'forward-sentence))
  18292. (let* ((element (org-element-at-point))
  18293. (contents-end (org-element-property :contents-end element))
  18294. (table (org-element-lineage element '(table) t)))
  18295. (if (and table
  18296. (>= (point) (org-element-property :contents-begin table))
  18297. (< (point) contents-end))
  18298. (call-interactively #'org-table-end-of-field)
  18299. (save-restriction
  18300. (when (and contents-end
  18301. (> (point-max) contents-end)
  18302. ;; Skip blank lines between elements.
  18303. (< (org-element-property :end element)
  18304. (save-excursion (goto-char contents-end)
  18305. (skip-chars-forward " \r\t\n"))))
  18306. (narrow-to-region (org-element-property :contents-begin element)
  18307. contents-end))
  18308. ;; End of heading is considered as the end of a sentence.
  18309. (let ((sentence-end (concat (sentence-end) "\\|^\\*+ .*$")))
  18310. (call-interactively #'forward-sentence)))))))
  18311. (defun org-kill-line (&optional _arg)
  18312. "Kill line, to tags or end of line.
  18313. The behavior of this command depends on the user options
  18314. `org-special-ctrl-k' and `org-ctrl-k-protect-subtree' (which
  18315. see)."
  18316. (interactive)
  18317. (cond
  18318. ((or (not org-special-ctrl-k)
  18319. (bolp)
  18320. (not (org-at-heading-p)))
  18321. (when (and (org-invisible-p (line-end-position))
  18322. org-ctrl-k-protect-subtree
  18323. (or (eq org-ctrl-k-protect-subtree 'error)
  18324. (not (y-or-n-p "Kill hidden subtree along with headline? "))))
  18325. (user-error
  18326. (substitute-command-keys
  18327. "`\\[org-kill-line]' aborted as it would kill a hidden subtree")))
  18328. (call-interactively
  18329. (if (bound-and-true-p visual-line-mode) 'kill-visual-line 'kill-line)))
  18330. ((org-match-line org-tag-line-re)
  18331. (let ((end (save-excursion
  18332. (goto-char (match-beginning 1))
  18333. (skip-chars-backward " \t")
  18334. (point))))
  18335. (if (<= end (point)) ;on tags part
  18336. (kill-region (point) (line-end-position))
  18337. (kill-region (point) end)))
  18338. ;; Only align tags when we are still on a heading:
  18339. (if (org-at-heading-p) (org-align-tags)))
  18340. (t (kill-region (point) (line-end-position)))))
  18341. (defun org-yank (&optional arg)
  18342. "Yank. If the kill is a subtree, treat it specially.
  18343. This command will look at the current kill and check if is a single
  18344. subtree, or a series of subtrees[1]. If it passes the test, and if the
  18345. cursor is at the beginning of a line or after the stars of a currently
  18346. empty headline, then the yank is handled specially. How exactly depends
  18347. on the value of the following variables.
  18348. `org-yank-folded-subtrees'
  18349. By default, this variable is non-nil, which results in
  18350. subtree(s) being folded after insertion, except if doing so
  18351. would swallow text after the yanked text.
  18352. `org-yank-adjusted-subtrees'
  18353. When non-nil (the default value is nil), the subtree will be
  18354. promoted or demoted in order to fit into the local outline tree
  18355. structure, which means that the level will be adjusted so that it
  18356. becomes the smaller one of the two *visible* surrounding headings.
  18357. Any prefix to this command will cause `yank' to be called directly with
  18358. no special treatment. In particular, a simple `\\[universal-argument]' prefix \
  18359. will just
  18360. plainly yank the text as it is.
  18361. \[1] The test checks if the first non-white line is a heading
  18362. and if there are no other headings with fewer stars."
  18363. (interactive "P")
  18364. (org-yank-generic 'yank arg))
  18365. (defun org-yank-generic (command arg)
  18366. "Perform some yank-like command.
  18367. This function implements the behavior described in the `org-yank'
  18368. documentation. However, it has been generalized to work for any
  18369. interactive command with similar behavior."
  18370. ;; pretend to be command COMMAND
  18371. (setq this-command command)
  18372. (if arg
  18373. (call-interactively command)
  18374. (let ((subtreep ; is kill a subtree, and the yank position appropriate?
  18375. (and (org-kill-is-subtree-p)
  18376. (or (bolp)
  18377. (and (looking-at "[ \t]*$")
  18378. (string-match
  18379. "\\`\\*+\\'"
  18380. (buffer-substring (line-beginning-position) (point)))))))
  18381. swallowp)
  18382. (cond
  18383. ((and subtreep org-yank-folded-subtrees)
  18384. (let ((beg (point))
  18385. end)
  18386. (if (and subtreep org-yank-adjusted-subtrees)
  18387. (org-paste-subtree nil nil 'for-yank)
  18388. (call-interactively command))
  18389. (setq end (point))
  18390. (goto-char beg)
  18391. (when (and (bolp) subtreep
  18392. (not (setq swallowp
  18393. (org-yank-folding-would-swallow-text beg end))))
  18394. (org-with-limited-levels
  18395. (or (looking-at org-outline-regexp)
  18396. (re-search-forward org-outline-regexp-bol end t))
  18397. (while (and (< (point) end) (looking-at org-outline-regexp))
  18398. (org-fold-subtree t)
  18399. (org-cycle-show-empty-lines 'folded)
  18400. (condition-case nil
  18401. (outline-forward-same-level 1)
  18402. (error (goto-char end))))))
  18403. (when swallowp
  18404. (message
  18405. "Inserted text not folded because that would swallow text"))
  18406. (goto-char end)
  18407. (skip-chars-forward " \t\n\r")
  18408. (beginning-of-line 1)
  18409. (push-mark beg 'nomsg)))
  18410. ((and subtreep org-yank-adjusted-subtrees)
  18411. (let ((beg (line-beginning-position)))
  18412. (org-paste-subtree nil nil 'for-yank)
  18413. (push-mark beg 'nomsg)))
  18414. (t
  18415. (call-interactively command))))))
  18416. (defun org-yank-folding-would-swallow-text (beg end)
  18417. "Would `hide-subtree' at BEG swallow any text after END?"
  18418. (let (level)
  18419. (org-with-limited-levels
  18420. (save-excursion
  18421. (goto-char beg)
  18422. (when (or (looking-at org-outline-regexp)
  18423. (re-search-forward org-outline-regexp-bol end t))
  18424. (setq level (org-outline-level)))
  18425. (goto-char end)
  18426. (skip-chars-forward " \t\r\n\v\f")
  18427. (not (or (eobp)
  18428. (and (bolp) (looking-at-p org-outline-regexp)
  18429. (<= (org-outline-level) level))))))))
  18430. (defun org-back-to-heading (&optional invisible-ok)
  18431. "Go back to beginning of heading."
  18432. (beginning-of-line)
  18433. (or (org-at-heading-p (not invisible-ok))
  18434. (if (org-element--cache-active-p)
  18435. (let ((heading (org-element-lineage (org-element-at-point)
  18436. '(headline inlinetask)
  18437. 'include-self)))
  18438. (when heading
  18439. (goto-char (org-element-property :begin heading)))
  18440. (while (and (not invisible-ok)
  18441. heading
  18442. (org-fold-folded-p))
  18443. (goto-char (org-fold-core-previous-visibility-change))
  18444. (setq heading (org-element-lineage (org-element-at-point)
  18445. '(headline inlinetask)
  18446. 'include-self))
  18447. (when heading
  18448. (goto-char (org-element-property :begin heading))))
  18449. (unless heading
  18450. (user-error "Before first headline at position %d in buffer %s"
  18451. (point) (current-buffer)))
  18452. (point))
  18453. (let (found)
  18454. (save-excursion
  18455. ;; At inlinetask end. Move to bol, so that the following
  18456. ;; search goes to the beginning of the inlinetask.
  18457. (when (and (featurep 'org-inlinetask)
  18458. (fboundp 'org-inlinetask-end-p)
  18459. (org-inlinetask-end-p))
  18460. (goto-char (line-beginning-position)))
  18461. (while (not found)
  18462. (or (re-search-backward (concat "^\\(?:" outline-regexp "\\)")
  18463. nil t)
  18464. (user-error "Before first headline at position %d in buffer %s"
  18465. (point) (current-buffer)))
  18466. ;; Skip inlinetask end.
  18467. (if (and (featurep 'org-inlinetask)
  18468. (fboundp 'org-inlinetask-end-p)
  18469. (org-inlinetask-end-p))
  18470. (org-inlinetask-goto-beginning)
  18471. (setq found (and (or invisible-ok (not (org-fold-folded-p)))
  18472. (point))))))
  18473. (goto-char found)
  18474. found))))
  18475. (defun org-back-to-heading-or-point-min (&optional invisible-ok)
  18476. "Go back to heading or first point in buffer.
  18477. If point is before first heading go to first point in buffer
  18478. instead of back to heading."
  18479. (if (org-before-first-heading-p)
  18480. (goto-char (point-min))
  18481. (org-back-to-heading invisible-ok)))
  18482. (defun org-before-first-heading-p ()
  18483. "Before first heading?
  18484. Respect narrowing."
  18485. (let ((cached (org-element-at-point nil 'cached)))
  18486. (if cached
  18487. (let ((cached-headline (org-element-lineage cached '(headline) t)))
  18488. (or (not cached-headline)
  18489. (< (org-element-property :begin cached-headline) (point-min))))
  18490. (org-with-limited-levels
  18491. (save-excursion
  18492. (end-of-line)
  18493. (null (re-search-backward org-outline-regexp-bol nil t)))))))
  18494. (defun org-at-heading-p (&optional invisible-not-ok)
  18495. "Return t if point is on a (possibly invisible) heading line.
  18496. If INVISIBLE-NOT-OK is non-nil, an invisible heading line is not ok."
  18497. (save-excursion
  18498. (beginning-of-line)
  18499. (and (bolp) (or (not invisible-not-ok) (not (org-fold-folded-p)))
  18500. (looking-at outline-regexp))))
  18501. (defun org-in-commented-heading-p (&optional no-inheritance element)
  18502. "Non-nil if point is under a commented heading.
  18503. This function also checks ancestors of the current headline,
  18504. unless optional argument NO-INHERITANCE is non-nil.
  18505. Optional argument ELEMENT contains element at point."
  18506. (save-match-data
  18507. (let ((el (or element
  18508. (org-element-at-point nil 'cached)
  18509. (org-with-wide-buffer
  18510. (org-back-to-heading-or-point-min t)
  18511. (org-element-at-point)))))
  18512. (catch :found
  18513. (setq el (org-element-lineage el '(headline inlinetask) 'include-self))
  18514. (if no-inheritance
  18515. (org-element-property :commentedp el)
  18516. (while el
  18517. (when (org-element-property :commentedp el)
  18518. (throw :found t))
  18519. (setq el (org-element-property :parent el))))))))
  18520. (defun org-in-archived-heading-p (&optional no-inheritance element)
  18521. "Non-nil if point is under an archived heading.
  18522. This function also checks ancestors of the current headline,
  18523. unless optional argument NO-INHERITANCE is non-nil.
  18524. Optional argument ELEMENT contains element at point."
  18525. (cond
  18526. ((and (not element) (org-before-first-heading-p)) nil)
  18527. ((if element
  18528. (org-element-property :archivedp element)
  18529. (let ((tags (org-get-tags element 'local)))
  18530. (and tags
  18531. (cl-some (apply-partially #'string= org-archive-tag) tags)))))
  18532. (no-inheritance nil)
  18533. (t
  18534. (if (or element (org-element--cache-active-p))
  18535. (catch :archived
  18536. (unless element (setq element (org-element-at-point)))
  18537. (while element
  18538. (when (org-element-property :archivedp element)
  18539. (throw :archived t))
  18540. (setq element (org-element-property :parent element))))
  18541. (save-excursion (and (org-up-heading-safe) (org-in-archived-heading-p)))))))
  18542. (defun org-at-comment-p nil
  18543. "Return t if cursor is in a commented line."
  18544. (save-excursion
  18545. (save-match-data
  18546. (beginning-of-line)
  18547. (looking-at org-comment-regexp))))
  18548. (defun org-at-keyword-p nil
  18549. "Return t if cursor is at a keyword-line."
  18550. (save-excursion
  18551. (move-beginning-of-line 1)
  18552. (looking-at org-keyword-regexp)))
  18553. (defun org-at-drawer-p nil
  18554. "Return t if cursor is at a drawer keyword."
  18555. (save-excursion
  18556. (move-beginning-of-line 1)
  18557. (looking-at org-drawer-regexp)))
  18558. (defun org-at-block-p nil
  18559. "Return t if cursor is at a block keyword."
  18560. (save-excursion
  18561. (move-beginning-of-line 1)
  18562. (looking-at org-block-regexp)))
  18563. (defun org-point-at-end-of-empty-headline ()
  18564. "If point is at the end of an empty headline, return t, else nil.
  18565. If the heading only contains a TODO keyword, it is still considered
  18566. empty."
  18567. (let ((case-fold-search nil))
  18568. (and (looking-at "[ \t]*$")
  18569. org-todo-line-regexp
  18570. (save-excursion
  18571. (beginning-of-line)
  18572. (looking-at org-todo-line-regexp)
  18573. (string= (match-string 3) "")))))
  18574. (defun org-at-heading-or-item-p ()
  18575. (or (org-at-heading-p) (org-at-item-p)))
  18576. (defun org-up-heading-all (arg)
  18577. "Move to the heading line of which the present line is a subheading.
  18578. This function considers both visible and invisible heading lines.
  18579. With argument, move up ARG levels."
  18580. (outline-up-heading arg t))
  18581. (defvar-local org--up-heading-cache nil
  18582. "Buffer-local `org-up-heading-safe' cache.")
  18583. (defvar-local org--up-heading-cache-tick nil
  18584. "Buffer `buffer-chars-modified-tick' in `org--up-heading-cache'.")
  18585. (defun org-up-heading-safe ()
  18586. "Move to the heading line of which the present line is a subheading.
  18587. This version will not throw an error. It will return the level of the
  18588. headline found, or nil if no higher level is found.
  18589. Also, this function will be a lot faster than `outline-up-heading',
  18590. because it relies on stars being the outline starters. This can really
  18591. make a significant difference in outlines with very many siblings."
  18592. (let ((element (and (org-element--cache-active-p)
  18593. (org-element-at-point nil t))))
  18594. (if element
  18595. (let* ((current-heading (org-element-lineage element '(headline inlinetask) 'with-self))
  18596. (parent (org-element-lineage current-heading '(headline))))
  18597. (if (and parent
  18598. (<= (point-min) (org-element-property :begin parent)))
  18599. (progn
  18600. (goto-char (org-element-property :begin parent))
  18601. (org-element-property :level parent))
  18602. (when (and current-heading
  18603. (<= (point-min) (org-element-property :begin current-heading)))
  18604. (goto-char (org-element-property :begin current-heading))
  18605. nil)))
  18606. (when (ignore-errors (org-back-to-heading t))
  18607. (let (level-cache)
  18608. (unless org--up-heading-cache
  18609. (setq org--up-heading-cache (make-hash-table)))
  18610. (if (and (eq (buffer-chars-modified-tick) org--up-heading-cache-tick)
  18611. (setq level-cache (gethash (point) org--up-heading-cache)))
  18612. (when (<= (point-min) (car level-cache) (point-max))
  18613. ;; Parent is inside accessible part of the buffer.
  18614. (progn (goto-char (car level-cache))
  18615. (cdr level-cache)))
  18616. ;; Buffer modified. Invalidate cache.
  18617. (unless (eq (buffer-chars-modified-tick) org--up-heading-cache-tick)
  18618. (setq-local org--up-heading-cache-tick
  18619. (buffer-chars-modified-tick))
  18620. (clrhash org--up-heading-cache))
  18621. (let* ((level-up (1- (funcall outline-level)))
  18622. (pos (point))
  18623. (result (and (> level-up 0)
  18624. (re-search-backward
  18625. (format "^\\*\\{1,%d\\} " level-up) nil t)
  18626. (funcall outline-level))))
  18627. (when result (puthash pos (cons (point) result) org--up-heading-cache))
  18628. result)))))))
  18629. (defun org-up-heading-or-point-min ()
  18630. "Move to the heading line of which the present is a subheading, or point-min.
  18631. This version is needed to make point-min behave like a virtual
  18632. heading of level 0 for property-inheritance. It will return the
  18633. level of the headline found (down to 0) or nil if already at a
  18634. point before the first headline or at point-min."
  18635. (when (ignore-errors (org-back-to-heading t))
  18636. (if (< 1 (funcall outline-level))
  18637. (or (org-up-heading-safe)
  18638. ;; The first heading may not be level 1 heading.
  18639. (goto-char (point-min)))
  18640. (unless (= (point) (point-min)) (goto-char (point-min))))))
  18641. (defun org-first-sibling-p ()
  18642. "Is this heading the first child of its parents?"
  18643. (interactive)
  18644. (let ((re org-outline-regexp-bol)
  18645. level l)
  18646. (unless (org-at-heading-p t)
  18647. (user-error "Not at a heading"))
  18648. (setq level (funcall outline-level))
  18649. (save-excursion
  18650. (if (not (re-search-backward re nil t))
  18651. t
  18652. (setq l (funcall outline-level))
  18653. (< l level)))))
  18654. (defun org-goto-sibling (&optional previous)
  18655. "Goto the next sibling, even if it is invisible.
  18656. When PREVIOUS is set, go to the previous sibling instead. Returns t
  18657. when a sibling was found. When none is found, return nil and don't
  18658. move point."
  18659. (let ((fun (if previous 're-search-backward 're-search-forward))
  18660. (pos (point))
  18661. (re org-outline-regexp-bol)
  18662. level l)
  18663. (when (ignore-errors (org-back-to-heading t))
  18664. (setq level (funcall outline-level))
  18665. (catch 'exit
  18666. (or previous (forward-char 1))
  18667. (while (funcall fun re nil t)
  18668. (setq l (funcall outline-level))
  18669. (when (< l level) (goto-char pos) (throw 'exit nil))
  18670. (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
  18671. (goto-char pos)
  18672. nil))))
  18673. (defun org-goto-first-child (&optional element)
  18674. "Goto the first child, even if it is invisible.
  18675. Return t when a child was found. Otherwise don't move point and
  18676. return nil."
  18677. (if (org-element--cache-active-p)
  18678. (let ((heading (org-element-lineage
  18679. (or element (org-element-at-point))
  18680. '(headline inlinetask org-data)
  18681. t)))
  18682. (when heading
  18683. (unless (or (eq 'inlinetask (org-element-type heading))
  18684. (not (org-element-property :contents-begin heading)))
  18685. (let ((pos (point)))
  18686. (goto-char (org-element-property :contents-begin heading))
  18687. (if (re-search-forward
  18688. org-outline-regexp-bol
  18689. (org-element-property :end heading)
  18690. t)
  18691. (progn (goto-char (match-beginning 0)) t)
  18692. (goto-char pos) nil)))))
  18693. (let (level (pos (point)) (re org-outline-regexp-bol))
  18694. (when (org-back-to-heading-or-point-min t)
  18695. (setq level (org-outline-level))
  18696. (forward-char 1)
  18697. (if (and (re-search-forward re nil t) (> (org-outline-level) level))
  18698. (progn (goto-char (match-beginning 0)) t)
  18699. (goto-char pos) nil)))))
  18700. (defun org-get-next-sibling ()
  18701. "Move to next heading of the same level, and return point.
  18702. If there is no such heading, return nil.
  18703. This is like outline-next-sibling, but invisible headings are ok."
  18704. (let ((level (funcall outline-level)))
  18705. (outline-next-heading)
  18706. (while (and (not (eobp)) (> (funcall outline-level) level))
  18707. (outline-next-heading))
  18708. (unless (or (eobp) (< (funcall outline-level) level))
  18709. (point))))
  18710. (defun org-get-previous-sibling ()
  18711. "Move to previous heading of the same level, and return point.
  18712. If there is no such heading, return nil."
  18713. (let ((opoint (point))
  18714. (level (funcall outline-level)))
  18715. (outline-previous-heading)
  18716. (when (and (/= (point) opoint) (outline-on-heading-p t))
  18717. (while (and (> (funcall outline-level) level)
  18718. (not (bobp)))
  18719. (outline-previous-heading))
  18720. (unless (< (funcall outline-level) level)
  18721. (point)))))
  18722. (defun org-end-of-subtree (&optional invisible-ok to-heading element)
  18723. "Goto to the end of a subtree at point or for ELEMENT heading."
  18724. ;; This contains an exact copy of the original function, but it uses
  18725. ;; `org-back-to-heading-or-point-min', to make it work also in invisible
  18726. ;; trees and before first headline. And is uses an invisible-ok argument.
  18727. ;; Under Emacs this is not needed, but the old outline.el needs this fix.
  18728. ;; Furthermore, when used inside Org, finding the end of a large subtree
  18729. ;; with many children and grandchildren etc, this can be much faster
  18730. ;; than the outline version.
  18731. (if element
  18732. (setq element (org-element-lineage element '(headline inlinetask) 'include-self))
  18733. (org-back-to-heading-or-point-min invisible-ok))
  18734. (unless (and (org-element--cache-active-p)
  18735. (let ((cached (or element (org-element-at-point nil t))))
  18736. (and cached
  18737. (eq 'headline (org-element-type cached))
  18738. (goto-char (org-element-property
  18739. :end cached)))))
  18740. (let ((first t)
  18741. (level (funcall outline-level)))
  18742. (cond ((= level 0)
  18743. (goto-char (point-max)))
  18744. ((and (derived-mode-p 'org-mode) (< level 1000))
  18745. ;; A true heading (not a plain list item), in Org
  18746. ;; This means we can easily find the end by looking
  18747. ;; only for the right number of stars. Using a regexp to do
  18748. ;; this is so much faster than using a Lisp loop.
  18749. (let ((re (concat "^\\*\\{1," (number-to-string level) "\\} ")))
  18750. (forward-char 1)
  18751. (and (re-search-forward re nil 'move) (beginning-of-line 1))))
  18752. (t
  18753. ;; something else, do it the slow way
  18754. (while (and (not (eobp))
  18755. (or first (> (funcall outline-level) level)))
  18756. (setq first nil)
  18757. (outline-next-heading))))))
  18758. (unless to-heading
  18759. (when (memq (preceding-char) '(?\n ?\^M))
  18760. ;; Go to end of line before heading
  18761. (forward-char -1)
  18762. (when (memq (preceding-char) '(?\n ?\^M))
  18763. ;; leave blank line before heading
  18764. (forward-char -1))))
  18765. (point))
  18766. (defun org-end-of-meta-data (&optional full)
  18767. "Skip planning line and properties drawer in current entry.
  18768. When optional argument FULL is t, also skip planning information,
  18769. clocking lines and any kind of drawer.
  18770. When FULL is non-nil but not t, skip planning information,
  18771. properties, clocking lines and logbook drawers."
  18772. (org-back-to-heading t)
  18773. (forward-line)
  18774. ;; Skip planning information.
  18775. (when (looking-at-p org-planning-line-re) (forward-line))
  18776. ;; Skip property drawer.
  18777. (when (looking-at org-property-drawer-re)
  18778. (goto-char (match-end 0))
  18779. (forward-line))
  18780. ;; When FULL is not nil, skip more.
  18781. (when (and full (not (org-at-heading-p)))
  18782. (catch 'exit
  18783. (let ((end (save-excursion (outline-next-heading) (point)))
  18784. (re (concat "[ \t]*$" "\\|" org-clock-line-re)))
  18785. (while (not (eobp))
  18786. (cond ;; Skip clock lines.
  18787. ((looking-at-p re) (forward-line))
  18788. ;; Skip logbook drawer.
  18789. ((looking-at-p org-logbook-drawer-re)
  18790. (if (re-search-forward "^[ \t]*:END:[ \t]*$" end t)
  18791. (forward-line)
  18792. (throw 'exit t)))
  18793. ;; When FULL is t, skip regular drawer too.
  18794. ((and (eq full t) (looking-at-p org-drawer-regexp))
  18795. (if (re-search-forward "^[ \t]*:END:[ \t]*$" end t)
  18796. (forward-line)
  18797. (throw 'exit t)))
  18798. (t (throw 'exit t))))))))
  18799. (defun org--line-fully-invisible-p ()
  18800. "Return non-nil if the current line is fully invisible."
  18801. (let ((line-beg (line-beginning-position))
  18802. (line-pos (1- (line-end-position)))
  18803. (is-invisible t))
  18804. (while (and (< line-beg line-pos) is-invisible)
  18805. (setq is-invisible (org-invisible-p line-pos))
  18806. (setq line-pos (1- line-pos)))
  18807. is-invisible))
  18808. (defun org-forward-heading-same-level (arg &optional invisible-ok)
  18809. "Move forward to the ARG'th subheading at same level as this one.
  18810. Stop at the first and last subheadings of a superior heading.
  18811. Normally this only looks at visible headings, but when INVISIBLE-OK is
  18812. non-nil it will also look at invisible ones."
  18813. (interactive "p")
  18814. (let ((backward? (and arg (< arg 0))))
  18815. (if (org-before-first-heading-p)
  18816. (if backward? (goto-char (point-min)) (outline-next-heading))
  18817. (org-back-to-heading invisible-ok)
  18818. (unless backward? (end-of-line)) ;do not match current headline
  18819. (let ((level (- (match-end 0) (match-beginning 0) 1))
  18820. (f (if backward? #'re-search-backward #'re-search-forward))
  18821. (count (if arg (abs arg) 1))
  18822. (result (point)))
  18823. (while (and (> count 0)
  18824. (funcall f org-outline-regexp-bol nil 'move))
  18825. (let ((l (- (match-end 0) (match-beginning 0) 1)))
  18826. (cond ((< l level) (setq count 0))
  18827. ((and (= l level)
  18828. (or invisible-ok
  18829. ;; FIXME: See commit a700fadd72 and the
  18830. ;; related discussion on why using
  18831. ;; `org--line-fully-invisible-p' is needed
  18832. ;; here, which is to serve the needs of an
  18833. ;; external package. If the change is
  18834. ;; wrong regarding Org itself, it should
  18835. ;; be removed.
  18836. (not (org--line-fully-invisible-p))))
  18837. (cl-decf count)
  18838. (when (= l level) (setq result (point)))))))
  18839. (goto-char result))
  18840. (beginning-of-line))))
  18841. (defun org-backward-heading-same-level (arg &optional invisible-ok)
  18842. "Move backward to the ARG'th subheading at same level as this one.
  18843. Stop at the first and last subheadings of a superior heading."
  18844. (interactive "p")
  18845. (org-forward-heading-same-level (if arg (- arg) -1) invisible-ok))
  18846. (defun org-next-visible-heading (arg)
  18847. "Move to the next visible heading line.
  18848. With ARG, repeats or can move backward if negative."
  18849. (interactive "p")
  18850. (let ((regexp (concat "^" (org-get-limited-outline-regexp))))
  18851. (if (< arg 0)
  18852. (beginning-of-line)
  18853. (end-of-line))
  18854. (while (and (< arg 0) (re-search-backward regexp nil :move))
  18855. (unless (bobp)
  18856. (when (org-fold-folded-p)
  18857. (goto-char (org-fold-previous-visibility-change))
  18858. (unless (looking-at-p regexp)
  18859. (re-search-backward regexp nil :mode))))
  18860. (cl-incf arg))
  18861. (while (and (> arg 0) (re-search-forward regexp nil :move))
  18862. (when (org-fold-folded-p)
  18863. (goto-char (org-fold-next-visibility-change))
  18864. (skip-chars-forward " \t\n")
  18865. (end-of-line))
  18866. (cl-decf arg))
  18867. (if (> arg 0) (goto-char (point-max)) (beginning-of-line))))
  18868. (defun org-previous-visible-heading (arg)
  18869. "Move to the previous visible heading.
  18870. With ARG, repeats or can move forward if negative."
  18871. (interactive "p")
  18872. (org-next-visible-heading (- arg)))
  18873. (defun org-forward-paragraph (&optional arg)
  18874. "Move forward by a paragraph, or equivalent, unit.
  18875. With argument ARG, do it ARG times;
  18876. a negative argument ARG = -N means move backward N paragraphs.
  18877. The function moves point between two structural
  18878. elements (paragraphs, tables, lists, etc.).
  18879. It also provides the following special moves for convenience:
  18880. - on a table or a property drawer, move to its beginning;
  18881. - on comment, example, export, source and verse blocks, stop
  18882. at blank lines;
  18883. - skip consecutive clocks, diary S-exps, and keywords."
  18884. (interactive "^p")
  18885. (unless arg (setq arg 1))
  18886. (if (< arg 0) (org-backward-paragraph (- arg))
  18887. (while (and (> arg 0) (not (eobp)))
  18888. (org--forward-paragraph-once)
  18889. (cl-decf arg))
  18890. ;; Return moves left.
  18891. arg))
  18892. (defun org-backward-paragraph (&optional arg)
  18893. "Move backward by a paragraph, or equivalent, unit.
  18894. With argument ARG, do it ARG times;
  18895. a negative argument ARG = -N means move forward N paragraphs.
  18896. The function moves point between two structural
  18897. elements (paragraphs, tables, lists, etc.).
  18898. It also provides the following special moves for convenience:
  18899. - on a table or a property drawer, move to its beginning;
  18900. - on comment, example, export, source and verse blocks, stop
  18901. at blank lines;
  18902. - skip consecutive clocks, diary S-exps, and keywords."
  18903. (interactive "^p")
  18904. (unless arg (setq arg 1))
  18905. (if (< arg 0) (org-forward-paragraph (- arg))
  18906. (while (and (> arg 0) (not (bobp)))
  18907. (org--backward-paragraph-once)
  18908. (cl-decf arg))
  18909. ;; Return moves left.
  18910. arg))
  18911. (defvar org--single-lines-list-is-paragraph t
  18912. "Treat plain lists with single line items as a whole paragraph")
  18913. (defun org--paragraph-at-point ()
  18914. "Return paragraph, or equivalent, element at point.
  18915. Paragraph element at point is the element at point, with the
  18916. following special cases:
  18917. - treat table rows (resp. node properties) as the table
  18918. \(resp. property drawer) containing them.
  18919. - treat plain lists with an item every line as a whole.
  18920. - treat consecutive keywords, clocks, and diary-sexps as a single
  18921. block.
  18922. Function may return a real element, or a pseudo-element with type
  18923. `pseudo-paragraph'."
  18924. (let* ((e (org-element-at-point))
  18925. (type (org-element-type e))
  18926. ;; If we need to fake a new pseudo-element, triplet is
  18927. ;;
  18928. ;; (BEG END PARENT)
  18929. ;;
  18930. ;; where BEG and END are element boundaries, and PARENT the
  18931. ;; element containing it, or nil.
  18932. (triplet
  18933. (cond
  18934. ((memq type '(table property-drawer))
  18935. (list (org-element-property :begin e)
  18936. (org-element-property :end e)
  18937. (org-element-property :parent e)))
  18938. ((memq type '(node-property table-row))
  18939. (let ((e (org-element-property :parent e)))
  18940. (list (org-element-property :begin e)
  18941. (org-element-property :end e)
  18942. (org-element-property :parent e))))
  18943. ((memq type '(clock diary-sexp keyword))
  18944. (let* ((regexp (pcase type
  18945. (`clock org-clock-line-re)
  18946. (`diary-sexp "%%(")
  18947. (_ org-keyword-regexp)))
  18948. (end (if (< 0 (org-element-property :post-blank e))
  18949. (org-element-property :end e)
  18950. (org-with-wide-buffer
  18951. (forward-line)
  18952. (while (looking-at regexp) (forward-line))
  18953. (skip-chars-forward " \t\n")
  18954. (line-beginning-position))))
  18955. (begin (org-with-point-at (org-element-property :begin e)
  18956. (while (and (not (bobp)) (looking-at regexp))
  18957. (forward-line -1))
  18958. ;; We may have gotten one line too far.
  18959. (if (looking-at regexp)
  18960. (point)
  18961. (line-beginning-position 2)))))
  18962. (list begin end (org-element-property :parent e))))
  18963. ;; Find the full plain list containing point, the check it
  18964. ;; contains exactly one line per item.
  18965. ((let ((l (org-element-lineage e '(plain-list) t)))
  18966. (while (memq (org-element-type (org-element-property :parent l))
  18967. '(item plain-list))
  18968. (setq l (org-element-property :parent l)))
  18969. (and l org--single-lines-list-is-paragraph
  18970. (org-with-point-at (org-element-property :post-affiliated l)
  18971. (forward-line (length (org-element-property :structure l)))
  18972. (= (point) (org-element-property :contents-end l)))
  18973. ;; Return value.
  18974. (list (org-element-property :begin l)
  18975. (org-element-property :end l)
  18976. (org-element-property :parent l)))))
  18977. (t nil)))) ;no triplet: return element
  18978. (pcase triplet
  18979. (`(,b ,e ,p)
  18980. (org-element-create
  18981. 'pseudo-paragraph
  18982. (list :begin b :end e :parent p :post-blank 0 :post-affiliated b)))
  18983. (_ e))))
  18984. (defun org--forward-paragraph-once ()
  18985. "Move forward to end of paragraph or equivalent, once.
  18986. See `org-forward-paragraph'."
  18987. (interactive)
  18988. (save-restriction
  18989. (widen)
  18990. (skip-chars-forward " \t\n")
  18991. (cond
  18992. ((eobp) nil)
  18993. ;; When inside a folded part, move out of it.
  18994. ((when (org-invisible-p nil t)
  18995. (goto-char (cdr (org-fold-get-region-at-point)))
  18996. (forward-line)
  18997. t))
  18998. (t
  18999. (let* ((element (org--paragraph-at-point))
  19000. (type (org-element-type element))
  19001. (contents-begin (org-element-property :contents-begin element))
  19002. (end (org-element-property :end element))
  19003. (post-affiliated (org-element-property :post-affiliated element)))
  19004. (cond
  19005. ((eq type 'plain-list)
  19006. (forward-char)
  19007. (org--forward-paragraph-once))
  19008. ;; If the element is folded, skip it altogether.
  19009. ((when (org-with-point-at post-affiliated (org-invisible-p (line-end-position) t))
  19010. (goto-char (cdr (org-fold-get-region-at-point
  19011. nil
  19012. (org-with-point-at post-affiliated
  19013. (line-end-position)))))
  19014. (forward-line)
  19015. t))
  19016. ;; At a greater element, move inside.
  19017. ((and contents-begin
  19018. (> contents-begin (point))
  19019. (not (eq type 'paragraph)))
  19020. (goto-char contents-begin)
  19021. ;; Items and footnote definitions contents may not start at
  19022. ;; the beginning of the line. In this case, skip until the
  19023. ;; next paragraph.
  19024. (cond
  19025. ((not (bolp)) (org--forward-paragraph-once))
  19026. ((org-previous-line-empty-p) (forward-line -1))
  19027. (t nil)))
  19028. ;; Move between empty lines in some blocks.
  19029. ((memq type '(comment-block example-block export-block src-block
  19030. verse-block))
  19031. (let ((contents-start
  19032. (org-with-point-at post-affiliated
  19033. (line-beginning-position 2))))
  19034. (if (< (point) contents-start)
  19035. (goto-char contents-start)
  19036. (let ((contents-end
  19037. (org-with-point-at end
  19038. (skip-chars-backward " \t\n")
  19039. (line-beginning-position))))
  19040. (cond
  19041. ((>= (point) contents-end)
  19042. (goto-char end)
  19043. (skip-chars-backward " \t\n")
  19044. (forward-line))
  19045. ((re-search-forward "^[ \t]*\n" contents-end :move)
  19046. (forward-line -1))
  19047. (t nil))))))
  19048. (t
  19049. ;; Move to element's end.
  19050. (goto-char end)
  19051. (skip-chars-backward " \t\n")
  19052. (forward-line))))))))
  19053. (defun org--backward-paragraph-once ()
  19054. "Move backward to start of paragraph or equivalent, once.
  19055. See `org-backward-paragraph'."
  19056. (interactive)
  19057. (save-restriction
  19058. (widen)
  19059. (cond
  19060. ((bobp) nil)
  19061. ;; Blank lines at the beginning of the buffer.
  19062. ((and (org-match-line "^[ \t]*$")
  19063. (save-excursion (skip-chars-backward " \t\n") (bobp)))
  19064. (goto-char (point-min)))
  19065. ;; When inside a folded part, move out of it.
  19066. ((when (org-invisible-p (1- (point)) t)
  19067. (goto-char (1- (car (org-fold-get-region-at-point nil (1- (point))))))
  19068. (org--backward-paragraph-once)
  19069. t))
  19070. (t
  19071. (let* ((element (org--paragraph-at-point))
  19072. (type (org-element-type element))
  19073. (begin (org-element-property :begin element))
  19074. (post-affiliated (org-element-property :post-affiliated element))
  19075. (contents-end (org-element-property :contents-end element))
  19076. (end (org-element-property :end element))
  19077. (parent (org-element-property :parent element))
  19078. (reach
  19079. ;; Move to the visible empty line above position P, or
  19080. ;; to position P. Return t.
  19081. (lambda (p)
  19082. (goto-char p)
  19083. (when (and (org-previous-line-empty-p)
  19084. (let ((end (line-end-position 0)))
  19085. (or (= end (point-min))
  19086. (not (org-invisible-p (1- end))))))
  19087. (forward-line -1))
  19088. t)))
  19089. (cond
  19090. ;; Already at the beginning of an element.
  19091. ((= begin (point))
  19092. (cond
  19093. ;; There is a blank line above. Move there.
  19094. ((and (org-previous-line-empty-p)
  19095. (not (org-invisible-p (1- (line-end-position 0)))))
  19096. (forward-line -1))
  19097. ;; At the beginning of the first element within a greater
  19098. ;; element. Move to the beginning of the greater element.
  19099. ((and parent
  19100. (not (eq 'section (org-element-type parent)))
  19101. (= begin (org-element-property :contents-begin parent)))
  19102. (funcall reach (org-element-property :begin parent)))
  19103. ;; Since we have to move anyway, find the beginning
  19104. ;; position of the element above.
  19105. (t
  19106. (forward-char -1)
  19107. (org--backward-paragraph-once))))
  19108. ;; Skip paragraphs at the very beginning of footnote
  19109. ;; definitions or items.
  19110. ((and (eq type 'paragraph)
  19111. (org-with-point-at begin (not (bolp))))
  19112. (funcall reach (progn (goto-char begin) (line-beginning-position))))
  19113. ;; If the element is folded, skip it altogether.
  19114. ((org-with-point-at post-affiliated (org-invisible-p (line-end-position) t))
  19115. (funcall reach begin))
  19116. ;; At the end of a greater element, move inside.
  19117. ((and contents-end
  19118. (<= contents-end (point))
  19119. (not (eq type 'paragraph)))
  19120. (cond
  19121. ((memq type '(footnote-definition plain-list))
  19122. (skip-chars-backward " \t\n")
  19123. (org--backward-paragraph-once))
  19124. ((= contents-end (point))
  19125. (forward-char -1)
  19126. (org--backward-paragraph-once))
  19127. (t
  19128. (goto-char contents-end))))
  19129. ;; Move between empty lines in some blocks.
  19130. ((and (memq type '(comment-block example-block export-block src-block
  19131. verse-block))
  19132. (let ((contents-start
  19133. (org-with-point-at post-affiliated
  19134. (line-beginning-position 2))))
  19135. (when (> (point) contents-start)
  19136. (let ((contents-end
  19137. (org-with-point-at end
  19138. (skip-chars-backward " \t\n")
  19139. (line-beginning-position))))
  19140. (if (> (point) contents-end)
  19141. (progn (goto-char contents-end) t)
  19142. (skip-chars-backward " \t\n" begin)
  19143. (re-search-backward "^[ \t]*\n" contents-start :move)
  19144. t))))))
  19145. ;; Move to element's start.
  19146. (t
  19147. (funcall reach begin))))))))
  19148. (defun org-forward-element ()
  19149. "Move forward by one element.
  19150. Move to the next element at the same level, when possible."
  19151. (interactive)
  19152. (cond ((eobp) (user-error "Cannot move further down"))
  19153. ((org-with-limited-levels (org-at-heading-p))
  19154. (let ((origin (point)))
  19155. (goto-char (org-end-of-subtree nil t))
  19156. (unless (org-with-limited-levels (org-at-heading-p))
  19157. (goto-char origin)
  19158. (user-error "Cannot move further down"))))
  19159. (t
  19160. (let* ((elem (org-element-at-point))
  19161. (end (org-element-property :end elem))
  19162. (parent (org-element-property :parent elem)))
  19163. (cond ((and parent (= (org-element-property :contents-end parent) end))
  19164. (goto-char (org-element-property :end parent)))
  19165. ((integer-or-marker-p end) (goto-char end))
  19166. (t (message "No element at point")))))))
  19167. (defun org-backward-element ()
  19168. "Move backward by one element.
  19169. Move to the previous element at the same level, when possible."
  19170. (interactive)
  19171. (cond ((bobp) (user-error "Cannot move further up"))
  19172. ((org-with-limited-levels (org-at-heading-p))
  19173. ;; At a headline, move to the previous one, if any, or stay
  19174. ;; here.
  19175. (let ((origin (point)))
  19176. (org-with-limited-levels (org-backward-heading-same-level 1))
  19177. ;; When current headline has no sibling above, move to its
  19178. ;; parent.
  19179. (when (= (point) origin)
  19180. (or (org-with-limited-levels (org-up-heading-safe))
  19181. (progn (goto-char origin)
  19182. (user-error "Cannot move further up"))))))
  19183. (t
  19184. (let* ((elem (org-element-at-point))
  19185. (beg (org-element-property :begin elem)))
  19186. (cond
  19187. ;; Move to beginning of current element if point isn't
  19188. ;; there already.
  19189. ((null beg) (message "No element at point"))
  19190. ((/= (point) beg) (goto-char beg))
  19191. (t (goto-char beg)
  19192. (skip-chars-backward " \r\t\n")
  19193. (unless (bobp)
  19194. (let ((prev (org-element-at-point)))
  19195. (goto-char (org-element-property :begin prev))
  19196. (while (and (setq prev (org-element-property :parent prev))
  19197. (<= (org-element-property :end prev) beg))
  19198. (goto-char (org-element-property :begin prev)))))))))))
  19199. (defun org-up-element ()
  19200. "Move to upper element."
  19201. (interactive)
  19202. (if (org-with-limited-levels (org-at-heading-p))
  19203. (unless (org-up-heading-safe) (user-error "No surrounding element"))
  19204. (let* ((elem (org-element-at-point))
  19205. (parent (org-element-property :parent elem)))
  19206. ;; Skip sections
  19207. (when (eq 'section (org-element-type parent))
  19208. (setq parent (org-element-property :parent parent)))
  19209. (if (and parent
  19210. (not (eq (org-element-type parent) 'org-data)))
  19211. (goto-char (org-element-property :begin parent))
  19212. (if (org-with-limited-levels (org-before-first-heading-p))
  19213. (user-error "No surrounding element")
  19214. (org-with-limited-levels (org-back-to-heading)))))))
  19215. (defun org-down-element ()
  19216. "Move to inner element."
  19217. (interactive)
  19218. (let ((element (org-element-at-point)))
  19219. (cond
  19220. ((memq (org-element-type element) '(plain-list table))
  19221. (goto-char (org-element-property :contents-begin element))
  19222. (forward-char))
  19223. ((memq (org-element-type element) org-element-greater-elements)
  19224. ;; If contents are hidden, first disclose them.
  19225. (when (org-invisible-p (line-end-position)) (org-cycle))
  19226. (goto-char (or (org-element-property :contents-begin element)
  19227. (user-error "No content for this element"))))
  19228. (t (user-error "No inner element")))))
  19229. (defun org-drag-element-backward ()
  19230. "Move backward element at point."
  19231. (interactive)
  19232. (let ((elem (or (org-element-at-point)
  19233. (user-error "No element at point"))))
  19234. (if (eq (org-element-type elem) 'headline)
  19235. ;; Preserve point when moving a whole tree, even if point was
  19236. ;; on blank lines below the headline.
  19237. (let ((offset (skip-chars-backward " \t\n")))
  19238. (unwind-protect (org-move-subtree-up)
  19239. (forward-char (- offset))))
  19240. (let ((prev-elem
  19241. (save-excursion
  19242. (goto-char (org-element-property :begin elem))
  19243. (skip-chars-backward " \r\t\n")
  19244. (unless (bobp)
  19245. (let* ((beg (org-element-property :begin elem))
  19246. (prev (org-element-at-point))
  19247. (up prev))
  19248. (while (and (setq up (org-element-property :parent up))
  19249. (<= (org-element-property :end up) beg))
  19250. (setq prev up))
  19251. prev)))))
  19252. ;; Error out if no previous element or previous element is
  19253. ;; a parent of the current one.
  19254. (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
  19255. (user-error "Cannot drag element backward")
  19256. (let ((pos (point)))
  19257. (org-element-swap-A-B prev-elem elem)
  19258. (goto-char (+ (org-element-property :begin prev-elem)
  19259. (- pos (org-element-property :begin elem))))))))))
  19260. (defun org-drag-element-forward ()
  19261. "Move forward element at point."
  19262. (interactive)
  19263. (let* ((pos (point))
  19264. (elem (or (org-element-at-point)
  19265. (user-error "No element at point"))))
  19266. (when (= (point-max) (org-element-property :end elem))
  19267. (user-error "Cannot drag element forward"))
  19268. (goto-char (org-element-property :end elem))
  19269. (let ((next-elem (org-element-at-point)))
  19270. (when (or (org-element-nested-p elem next-elem)
  19271. (and (eq (org-element-type next-elem) 'headline)
  19272. (not (eq (org-element-type elem) 'headline))))
  19273. (goto-char pos)
  19274. (user-error "Cannot drag element forward"))
  19275. ;; Compute new position of point: it's shifted by NEXT-ELEM
  19276. ;; body's length (without final blanks) and by the length of
  19277. ;; blanks between ELEM and NEXT-ELEM.
  19278. (let ((size-next (- (save-excursion
  19279. (goto-char (org-element-property :end next-elem))
  19280. (skip-chars-backward " \r\t\n")
  19281. (forward-line)
  19282. ;; Small correction if buffer doesn't end
  19283. ;; with a newline character.
  19284. (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
  19285. (org-element-property :begin next-elem)))
  19286. (size-blank (- (org-element-property :end elem)
  19287. (save-excursion
  19288. (goto-char (org-element-property :end elem))
  19289. (skip-chars-backward " \r\t\n")
  19290. (forward-line)
  19291. (point)))))
  19292. (org-element-swap-A-B elem next-elem)
  19293. (goto-char (+ pos size-next size-blank))))))
  19294. (defun org-drag-line-forward (arg)
  19295. "Drag the line at point ARG lines forward."
  19296. (interactive "p")
  19297. (dotimes (_ (abs arg))
  19298. (let ((c (current-column)))
  19299. (if (< 0 arg)
  19300. (progn
  19301. (beginning-of-line 2)
  19302. (transpose-lines 1)
  19303. (beginning-of-line 0))
  19304. (transpose-lines 1)
  19305. (beginning-of-line -1))
  19306. (org-move-to-column c))))
  19307. (defun org-drag-line-backward (arg)
  19308. "Drag the line at point ARG lines backward."
  19309. (interactive "p")
  19310. (org-drag-line-forward (- arg)))
  19311. (defun org-mark-element ()
  19312. "Put point at beginning of this element, mark at end.
  19313. Interactively, if this command is repeated or (in Transient Mark
  19314. mode) if the mark is active, it marks the next element after the
  19315. ones already marked."
  19316. (interactive)
  19317. (let (deactivate-mark)
  19318. (if (and (called-interactively-p 'any)
  19319. (or (and (eq last-command this-command) (mark t))
  19320. (and transient-mark-mode mark-active)))
  19321. (set-mark
  19322. (save-excursion
  19323. (goto-char (mark))
  19324. (goto-char (org-element-property :end (org-element-at-point)))
  19325. (point)))
  19326. (let ((element (org-element-at-point)))
  19327. (end-of-line)
  19328. (push-mark (min (point-max) (org-element-property :end element)) t t)
  19329. (goto-char (org-element-property :begin element))))))
  19330. (defun org-narrow-to-element ()
  19331. "Narrow buffer to current element."
  19332. (interactive)
  19333. (let ((elem (org-element-at-point)))
  19334. (cond
  19335. ((eq (car elem) 'headline)
  19336. (narrow-to-region
  19337. (org-element-property :begin elem)
  19338. (org-element-property :end elem)))
  19339. ((memq (car elem) org-element-greater-elements)
  19340. (narrow-to-region
  19341. (org-element-property :contents-begin elem)
  19342. (org-element-property :contents-end elem)))
  19343. (t
  19344. (narrow-to-region
  19345. (org-element-property :begin elem)
  19346. (org-element-property :end elem))))))
  19347. (defun org-transpose-element ()
  19348. "Transpose current and previous elements, keeping blank lines between.
  19349. Point is moved after both elements."
  19350. (interactive)
  19351. (org-skip-whitespace)
  19352. (let ((end (org-element-property :end (org-element-at-point))))
  19353. (org-drag-element-backward)
  19354. (goto-char end)))
  19355. (defun org-unindent-buffer ()
  19356. "Un-indent the visible part of the buffer.
  19357. Relative indentation (between items, inside blocks, etc.) isn't
  19358. modified."
  19359. (interactive)
  19360. (unless (eq major-mode 'org-mode)
  19361. (user-error "Cannot un-indent a buffer not in Org mode"))
  19362. (letrec ((parse-tree (org-element-parse-buffer 'greater-element))
  19363. (unindent-tree
  19364. (lambda (contents)
  19365. (dolist (element (reverse contents))
  19366. (if (memq (org-element-type element) '(headline section))
  19367. (funcall unindent-tree (org-element-contents element))
  19368. (save-excursion
  19369. (save-restriction
  19370. (narrow-to-region
  19371. (org-element-property :begin element)
  19372. (org-element-property :end element))
  19373. (org-do-remove-indentation))))))))
  19374. (funcall unindent-tree (org-element-contents parse-tree))))
  19375. (defun org-make-options-regexp (kwds &optional extra)
  19376. "Make a regular expression for keyword lines.
  19377. KWDS is a list of keywords, as strings. Optional argument EXTRA,
  19378. when non-nil, is a regexp matching keywords names."
  19379. (concat "^[ \t]*#\\+\\("
  19380. (regexp-opt kwds)
  19381. (and extra (concat (and kwds "\\|") extra))
  19382. "\\):[ \t]*\\(.*\\)"))
  19383. ;;; Conveniently switch to Info nodes
  19384. (defun org-info-find-node (&optional nodename)
  19385. "Find Info documentation NODENAME or Org documentation according context.
  19386. Started from `gnus-info-find-node'."
  19387. (interactive)
  19388. (Info-goto-node
  19389. (or nodename
  19390. (let ((default-org-info-node "(org) Top"))
  19391. (cond
  19392. ((eq 'org-agenda-mode major-mode) "(org) Agenda Views")
  19393. ((eq 'org-mode major-mode)
  19394. (let* ((context (org-element-at-point))
  19395. (element-info-nodes ; compare to `org-element-all-elements'.
  19396. `((babel-call . "(org) Evaluating Code Blocks")
  19397. (center-block . "(org) Paragraphs")
  19398. (clock . ,default-org-info-node)
  19399. (comment . "(org) Comment Lines")
  19400. (comment-block . "(org) Comment Lines")
  19401. (diary-sexp . ,default-org-info-node)
  19402. (drawer . "(org) Drawers")
  19403. (dynamic-block . "(org) Dynamic Blocks")
  19404. (example-block . "(org) Literal Examples")
  19405. (export-block . "(org) ASCII/Latin-1/UTF-8 export")
  19406. (fixed-width . ,default-org-info-node)
  19407. (footnote-definition . "(org) Creating Footnotes")
  19408. (headline . "(org) Document Structure")
  19409. (horizontal-rule . "(org) Built-in Table Editor")
  19410. (inlinetask . ,default-org-info-node)
  19411. (item . "(org) Plain Lists")
  19412. (keyword . "(org) Per-file keywords")
  19413. (latex-environment . "(org) LaTeX Export")
  19414. (node-property . "(org) Properties and Columns")
  19415. (paragraph . "(org) Paragraphs")
  19416. (plain-list . "(org) Plain Lists")
  19417. (planning . "(org) Deadlines and Scheduling")
  19418. (property-drawer . "(org) Properties and Columns")
  19419. (quote-block . "(org) Paragraphs")
  19420. (section . ,default-org-info-node)
  19421. (special-block . ,default-org-info-node)
  19422. (src-block . "(org) Working with Source Code")
  19423. (table . "(org) Tables")
  19424. (table-row . "(org) Tables")
  19425. (verse-block . "(org) Paragraphs"))))
  19426. (or (cdr (assoc (car context) element-info-nodes))
  19427. default-org-info-node)))
  19428. (t default-org-info-node))))))
  19429. ;;; Finish up
  19430. (add-hook 'org-mode-hook ;remove folds when changing major mode
  19431. (lambda () (add-hook 'change-major-mode-hook
  19432. 'org-fold-show-all 'append 'local)))
  19433. (provide 'org)
  19434. (run-hooks 'org-load-hook)
  19435. ;;; org.el ends here