org.el 949 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030110311103211033110341103511036110371103811039110401104111042110431104411045110461104711048110491105011051110521105311054110551105611057110581105911060110611106211063110641106511066110671106811069110701107111072110731107411075110761107711078110791108011081110821108311084110851108611087110881108911090110911109211093110941109511096110971109811099111001110111102111031110411105111061110711108111091111011111111121111311114111151111611117111181111911120111211112211123111241112511126111271112811129111301113111132111331113411135111361113711138111391114011141111421114311144111451114611147111481114911150111511115211153111541115511156111571115811159111601116111162111631116411165111661116711168111691117011171111721117311174111751117611177111781117911180111811118211183111841118511186111871118811189111901119111192111931119411195111961119711198111991120011201112021120311204112051120611207112081120911210112111121211213112141121511216112171121811219112201122111222112231122411225112261122711228112291123011231112321123311234112351123611237112381123911240112411124211243112441124511246112471124811249112501125111252112531125411255112561125711258112591126011261112621126311264112651126611267112681126911270112711127211273112741127511276112771127811279112801128111282112831128411285112861128711288112891129011291112921129311294112951129611297112981129911300113011130211303113041130511306113071130811309113101131111312113131131411315113161131711318113191132011321113221132311324113251132611327113281132911330113311133211333113341133511336113371133811339113401134111342113431134411345113461134711348113491135011351113521135311354113551135611357113581135911360113611136211363113641136511366113671136811369113701137111372113731137411375113761137711378113791138011381113821138311384113851138611387113881138911390113911139211393113941139511396113971139811399114001140111402114031140411405114061140711408114091141011411114121141311414114151141611417114181141911420114211142211423114241142511426114271142811429114301143111432114331143411435114361143711438114391144011441114421144311444114451144611447114481144911450114511145211453114541145511456114571145811459114601146111462114631146411465114661146711468114691147011471114721147311474114751147611477114781147911480114811148211483114841148511486114871148811489114901149111492114931149411495114961149711498114991150011501115021150311504115051150611507115081150911510115111151211513115141151511516115171151811519115201152111522115231152411525115261152711528115291153011531115321153311534115351153611537115381153911540115411154211543115441154511546115471154811549115501155111552115531155411555115561155711558115591156011561115621156311564115651156611567115681156911570115711157211573115741157511576115771157811579115801158111582115831158411585115861158711588115891159011591115921159311594115951159611597115981159911600116011160211603116041160511606116071160811609116101161111612116131161411615116161161711618116191162011621116221162311624116251162611627116281162911630116311163211633116341163511636116371163811639116401164111642116431164411645116461164711648116491165011651116521165311654116551165611657116581165911660116611166211663116641166511666116671166811669116701167111672116731167411675116761167711678116791168011681116821168311684116851168611687116881168911690116911169211693116941169511696116971169811699117001170111702117031170411705117061170711708117091171011711117121171311714117151171611717117181171911720117211172211723117241172511726117271172811729117301173111732117331173411735117361173711738117391174011741117421174311744117451174611747117481174911750117511175211753117541175511756117571175811759117601176111762117631176411765117661176711768117691177011771117721177311774117751177611777117781177911780117811178211783117841178511786117871178811789117901179111792117931179411795117961179711798117991180011801118021180311804118051180611807118081180911810118111181211813118141181511816118171181811819118201182111822118231182411825118261182711828118291183011831118321183311834118351183611837118381183911840118411184211843118441184511846118471184811849118501185111852118531185411855118561185711858118591186011861118621186311864118651186611867118681186911870118711187211873118741187511876118771187811879118801188111882118831188411885118861188711888118891189011891118921189311894118951189611897118981189911900119011190211903119041190511906119071190811909119101191111912119131191411915119161191711918119191192011921119221192311924119251192611927119281192911930119311193211933119341193511936119371193811939119401194111942119431194411945119461194711948119491195011951119521195311954119551195611957119581195911960119611196211963119641196511966119671196811969119701197111972119731197411975119761197711978119791198011981119821198311984119851198611987119881198911990119911199211993119941199511996119971199811999120001200112002120031200412005120061200712008120091201012011120121201312014120151201612017120181201912020120211202212023120241202512026120271202812029120301203112032120331203412035120361203712038120391204012041120421204312044120451204612047120481204912050120511205212053120541205512056120571205812059120601206112062120631206412065120661206712068120691207012071120721207312074120751207612077120781207912080120811208212083120841208512086120871208812089120901209112092120931209412095120961209712098120991210012101121021210312104121051210612107121081210912110121111211212113121141211512116121171211812119121201212112122121231212412125121261212712128121291213012131121321213312134121351213612137121381213912140121411214212143121441214512146121471214812149121501215112152121531215412155121561215712158121591216012161121621216312164121651216612167121681216912170121711217212173121741217512176121771217812179121801218112182121831218412185121861218712188121891219012191121921219312194121951219612197121981219912200122011220212203122041220512206122071220812209122101221112212122131221412215122161221712218122191222012221122221222312224122251222612227122281222912230122311223212233122341223512236122371223812239122401224112242122431224412245122461224712248122491225012251122521225312254122551225612257122581225912260122611226212263122641226512266122671226812269122701227112272122731227412275122761227712278122791228012281122821228312284122851228612287122881228912290122911229212293122941229512296122971229812299123001230112302123031230412305123061230712308123091231012311123121231312314123151231612317123181231912320123211232212323123241232512326123271232812329123301233112332123331233412335123361233712338123391234012341123421234312344123451234612347123481234912350123511235212353123541235512356123571235812359123601236112362123631236412365123661236712368123691237012371123721237312374123751237612377123781237912380123811238212383123841238512386123871238812389123901239112392123931239412395123961239712398123991240012401124021240312404124051240612407124081240912410124111241212413124141241512416124171241812419124201242112422124231242412425124261242712428124291243012431124321243312434124351243612437124381243912440124411244212443124441244512446124471244812449124501245112452124531245412455124561245712458124591246012461124621246312464124651246612467124681246912470124711247212473124741247512476124771247812479124801248112482124831248412485124861248712488124891249012491124921249312494124951249612497124981249912500125011250212503125041250512506125071250812509125101251112512125131251412515125161251712518125191252012521125221252312524125251252612527125281252912530125311253212533125341253512536125371253812539125401254112542125431254412545125461254712548125491255012551125521255312554125551255612557125581255912560125611256212563125641256512566125671256812569125701257112572125731257412575125761257712578125791258012581125821258312584125851258612587125881258912590125911259212593125941259512596125971259812599126001260112602126031260412605126061260712608126091261012611126121261312614126151261612617126181261912620126211262212623126241262512626126271262812629126301263112632126331263412635126361263712638126391264012641126421264312644126451264612647126481264912650126511265212653126541265512656126571265812659126601266112662126631266412665126661266712668126691267012671126721267312674126751267612677126781267912680126811268212683126841268512686126871268812689126901269112692126931269412695126961269712698126991270012701127021270312704127051270612707127081270912710127111271212713127141271512716127171271812719127201272112722127231272412725127261272712728127291273012731127321273312734127351273612737127381273912740127411274212743127441274512746127471274812749127501275112752127531275412755127561275712758127591276012761127621276312764127651276612767127681276912770127711277212773127741277512776127771277812779127801278112782127831278412785127861278712788127891279012791127921279312794127951279612797127981279912800128011280212803128041280512806128071280812809128101281112812128131281412815128161281712818128191282012821128221282312824128251282612827128281282912830128311283212833128341283512836128371283812839128401284112842128431284412845128461284712848128491285012851128521285312854128551285612857128581285912860128611286212863128641286512866128671286812869128701287112872128731287412875128761287712878128791288012881128821288312884128851288612887128881288912890128911289212893128941289512896128971289812899129001290112902129031290412905129061290712908129091291012911129121291312914129151291612917129181291912920129211292212923129241292512926129271292812929129301293112932129331293412935129361293712938129391294012941129421294312944129451294612947129481294912950129511295212953129541295512956129571295812959129601296112962129631296412965129661296712968129691297012971129721297312974129751297612977129781297912980129811298212983129841298512986129871298812989129901299112992129931299412995129961299712998129991300013001130021300313004130051300613007130081300913010130111301213013130141301513016130171301813019130201302113022130231302413025130261302713028130291303013031130321303313034130351303613037130381303913040130411304213043130441304513046130471304813049130501305113052130531305413055130561305713058130591306013061130621306313064130651306613067130681306913070130711307213073130741307513076130771307813079130801308113082130831308413085130861308713088130891309013091130921309313094130951309613097130981309913100131011310213103131041310513106131071310813109131101311113112131131311413115131161311713118131191312013121131221312313124131251312613127131281312913130131311313213133131341313513136131371313813139131401314113142131431314413145131461314713148131491315013151131521315313154131551315613157131581315913160131611316213163131641316513166131671316813169131701317113172131731317413175131761317713178131791318013181131821318313184131851318613187131881318913190131911319213193131941319513196131971319813199132001320113202132031320413205132061320713208132091321013211132121321313214132151321613217132181321913220132211322213223132241322513226132271322813229132301323113232132331323413235132361323713238132391324013241132421324313244132451324613247132481324913250132511325213253132541325513256132571325813259132601326113262132631326413265132661326713268132691327013271132721327313274132751327613277132781327913280132811328213283132841328513286132871328813289132901329113292132931329413295132961329713298132991330013301133021330313304133051330613307133081330913310133111331213313133141331513316133171331813319133201332113322133231332413325133261332713328133291333013331133321333313334133351333613337133381333913340133411334213343133441334513346133471334813349133501335113352133531335413355133561335713358133591336013361133621336313364133651336613367133681336913370133711337213373133741337513376133771337813379133801338113382133831338413385133861338713388133891339013391133921339313394133951339613397133981339913400134011340213403134041340513406134071340813409134101341113412134131341413415134161341713418134191342013421134221342313424134251342613427134281342913430134311343213433134341343513436134371343813439134401344113442134431344413445134461344713448134491345013451134521345313454134551345613457134581345913460134611346213463134641346513466134671346813469134701347113472134731347413475134761347713478134791348013481134821348313484134851348613487134881348913490134911349213493134941349513496134971349813499135001350113502135031350413505135061350713508135091351013511135121351313514135151351613517135181351913520135211352213523135241352513526135271352813529135301353113532135331353413535135361353713538135391354013541135421354313544135451354613547135481354913550135511355213553135541355513556135571355813559135601356113562135631356413565135661356713568135691357013571135721357313574135751357613577135781357913580135811358213583135841358513586135871358813589135901359113592135931359413595135961359713598135991360013601136021360313604136051360613607136081360913610136111361213613136141361513616136171361813619136201362113622136231362413625136261362713628136291363013631136321363313634136351363613637136381363913640136411364213643136441364513646136471364813649136501365113652136531365413655136561365713658136591366013661136621366313664136651366613667136681366913670136711367213673136741367513676136771367813679136801368113682136831368413685136861368713688136891369013691136921369313694136951369613697136981369913700137011370213703137041370513706137071370813709137101371113712137131371413715137161371713718137191372013721137221372313724137251372613727137281372913730137311373213733137341373513736137371373813739137401374113742137431374413745137461374713748137491375013751137521375313754137551375613757137581375913760137611376213763137641376513766137671376813769137701377113772137731377413775137761377713778137791378013781137821378313784137851378613787137881378913790137911379213793137941379513796137971379813799138001380113802138031380413805138061380713808138091381013811138121381313814138151381613817138181381913820138211382213823138241382513826138271382813829138301383113832138331383413835138361383713838138391384013841138421384313844138451384613847138481384913850138511385213853138541385513856138571385813859138601386113862138631386413865138661386713868138691387013871138721387313874138751387613877138781387913880138811388213883138841388513886138871388813889138901389113892138931389413895138961389713898138991390013901139021390313904139051390613907139081390913910139111391213913139141391513916139171391813919139201392113922139231392413925139261392713928139291393013931139321393313934139351393613937139381393913940139411394213943139441394513946139471394813949139501395113952139531395413955139561395713958139591396013961139621396313964139651396613967139681396913970139711397213973139741397513976139771397813979139801398113982139831398413985139861398713988139891399013991139921399313994139951399613997139981399914000140011400214003140041400514006140071400814009140101401114012140131401414015140161401714018140191402014021140221402314024140251402614027140281402914030140311403214033140341403514036140371403814039140401404114042140431404414045140461404714048140491405014051140521405314054140551405614057140581405914060140611406214063140641406514066140671406814069140701407114072140731407414075140761407714078140791408014081140821408314084140851408614087140881408914090140911409214093140941409514096140971409814099141001410114102141031410414105141061410714108141091411014111141121411314114141151411614117141181411914120141211412214123141241412514126141271412814129141301413114132141331413414135141361413714138141391414014141141421414314144141451414614147141481414914150141511415214153141541415514156141571415814159141601416114162141631416414165141661416714168141691417014171141721417314174141751417614177141781417914180141811418214183141841418514186141871418814189141901419114192141931419414195141961419714198141991420014201142021420314204142051420614207142081420914210142111421214213142141421514216142171421814219142201422114222142231422414225142261422714228142291423014231142321423314234142351423614237142381423914240142411424214243142441424514246142471424814249142501425114252142531425414255142561425714258142591426014261142621426314264142651426614267142681426914270142711427214273142741427514276142771427814279142801428114282142831428414285142861428714288142891429014291142921429314294142951429614297142981429914300143011430214303143041430514306143071430814309143101431114312143131431414315143161431714318143191432014321143221432314324143251432614327143281432914330143311433214333143341433514336143371433814339143401434114342143431434414345143461434714348143491435014351143521435314354143551435614357143581435914360143611436214363143641436514366143671436814369143701437114372143731437414375143761437714378143791438014381143821438314384143851438614387143881438914390143911439214393143941439514396143971439814399144001440114402144031440414405144061440714408144091441014411144121441314414144151441614417144181441914420144211442214423144241442514426144271442814429144301443114432144331443414435144361443714438144391444014441144421444314444144451444614447144481444914450144511445214453144541445514456144571445814459144601446114462144631446414465144661446714468144691447014471144721447314474144751447614477144781447914480144811448214483144841448514486144871448814489144901449114492144931449414495144961449714498144991450014501145021450314504145051450614507145081450914510145111451214513145141451514516145171451814519145201452114522145231452414525145261452714528145291453014531145321453314534145351453614537145381453914540145411454214543145441454514546145471454814549145501455114552145531455414555145561455714558145591456014561145621456314564145651456614567145681456914570145711457214573145741457514576145771457814579145801458114582145831458414585145861458714588145891459014591145921459314594145951459614597145981459914600146011460214603146041460514606146071460814609146101461114612146131461414615146161461714618146191462014621146221462314624146251462614627146281462914630146311463214633146341463514636146371463814639146401464114642146431464414645146461464714648146491465014651146521465314654146551465614657146581465914660146611466214663146641466514666146671466814669146701467114672146731467414675146761467714678146791468014681146821468314684146851468614687146881468914690146911469214693146941469514696146971469814699147001470114702147031470414705147061470714708147091471014711147121471314714147151471614717147181471914720147211472214723147241472514726147271472814729147301473114732147331473414735147361473714738147391474014741147421474314744147451474614747147481474914750147511475214753147541475514756147571475814759147601476114762147631476414765147661476714768147691477014771147721477314774147751477614777147781477914780147811478214783147841478514786147871478814789147901479114792147931479414795147961479714798147991480014801148021480314804148051480614807148081480914810148111481214813148141481514816148171481814819148201482114822148231482414825148261482714828148291483014831148321483314834148351483614837148381483914840148411484214843148441484514846148471484814849148501485114852148531485414855148561485714858148591486014861148621486314864148651486614867148681486914870148711487214873148741487514876148771487814879148801488114882148831488414885148861488714888148891489014891148921489314894148951489614897148981489914900149011490214903149041490514906149071490814909149101491114912149131491414915149161491714918149191492014921149221492314924149251492614927149281492914930149311493214933149341493514936149371493814939149401494114942149431494414945149461494714948149491495014951149521495314954149551495614957149581495914960149611496214963149641496514966149671496814969149701497114972149731497414975149761497714978149791498014981149821498314984149851498614987149881498914990149911499214993149941499514996149971499814999150001500115002150031500415005150061500715008150091501015011150121501315014150151501615017150181501915020150211502215023150241502515026150271502815029150301503115032150331503415035150361503715038150391504015041150421504315044150451504615047150481504915050150511505215053150541505515056150571505815059150601506115062150631506415065150661506715068150691507015071150721507315074150751507615077150781507915080150811508215083150841508515086150871508815089150901509115092150931509415095150961509715098150991510015101151021510315104151051510615107151081510915110151111511215113151141511515116151171511815119151201512115122151231512415125151261512715128151291513015131151321513315134151351513615137151381513915140151411514215143151441514515146151471514815149151501515115152151531515415155151561515715158151591516015161151621516315164151651516615167151681516915170151711517215173151741517515176151771517815179151801518115182151831518415185151861518715188151891519015191151921519315194151951519615197151981519915200152011520215203152041520515206152071520815209152101521115212152131521415215152161521715218152191522015221152221522315224152251522615227152281522915230152311523215233152341523515236152371523815239152401524115242152431524415245152461524715248152491525015251152521525315254152551525615257152581525915260152611526215263152641526515266152671526815269152701527115272152731527415275152761527715278152791528015281152821528315284152851528615287152881528915290152911529215293152941529515296152971529815299153001530115302153031530415305153061530715308153091531015311153121531315314153151531615317153181531915320153211532215323153241532515326153271532815329153301533115332153331533415335153361533715338153391534015341153421534315344153451534615347153481534915350153511535215353153541535515356153571535815359153601536115362153631536415365153661536715368153691537015371153721537315374153751537615377153781537915380153811538215383153841538515386153871538815389153901539115392153931539415395153961539715398153991540015401154021540315404154051540615407154081540915410154111541215413154141541515416154171541815419154201542115422154231542415425154261542715428154291543015431154321543315434154351543615437154381543915440154411544215443154441544515446154471544815449154501545115452154531545415455154561545715458154591546015461154621546315464154651546615467154681546915470154711547215473154741547515476154771547815479154801548115482154831548415485154861548715488154891549015491154921549315494154951549615497154981549915500155011550215503155041550515506155071550815509155101551115512155131551415515155161551715518155191552015521155221552315524155251552615527155281552915530155311553215533155341553515536155371553815539155401554115542155431554415545155461554715548155491555015551155521555315554155551555615557155581555915560155611556215563155641556515566155671556815569155701557115572155731557415575155761557715578155791558015581155821558315584155851558615587155881558915590155911559215593155941559515596155971559815599156001560115602156031560415605156061560715608156091561015611156121561315614156151561615617156181561915620156211562215623156241562515626156271562815629156301563115632156331563415635156361563715638156391564015641156421564315644156451564615647156481564915650156511565215653156541565515656156571565815659156601566115662156631566415665156661566715668156691567015671156721567315674156751567615677156781567915680156811568215683156841568515686156871568815689156901569115692156931569415695156961569715698156991570015701157021570315704157051570615707157081570915710157111571215713157141571515716157171571815719157201572115722157231572415725157261572715728157291573015731157321573315734157351573615737157381573915740157411574215743157441574515746157471574815749157501575115752157531575415755157561575715758157591576015761157621576315764157651576615767157681576915770157711577215773157741577515776157771577815779157801578115782157831578415785157861578715788157891579015791157921579315794157951579615797157981579915800158011580215803158041580515806158071580815809158101581115812158131581415815158161581715818158191582015821158221582315824158251582615827158281582915830158311583215833158341583515836158371583815839158401584115842158431584415845158461584715848158491585015851158521585315854158551585615857158581585915860158611586215863158641586515866158671586815869158701587115872158731587415875158761587715878158791588015881158821588315884158851588615887158881588915890158911589215893158941589515896158971589815899159001590115902159031590415905159061590715908159091591015911159121591315914159151591615917159181591915920159211592215923159241592515926159271592815929159301593115932159331593415935159361593715938159391594015941159421594315944159451594615947159481594915950159511595215953159541595515956159571595815959159601596115962159631596415965159661596715968159691597015971159721597315974159751597615977159781597915980159811598215983159841598515986159871598815989159901599115992159931599415995159961599715998159991600016001160021600316004160051600616007160081600916010160111601216013160141601516016160171601816019160201602116022160231602416025160261602716028160291603016031160321603316034160351603616037160381603916040160411604216043160441604516046160471604816049160501605116052160531605416055160561605716058160591606016061160621606316064160651606616067160681606916070160711607216073160741607516076160771607816079160801608116082160831608416085160861608716088160891609016091160921609316094160951609616097160981609916100161011610216103161041610516106161071610816109161101611116112161131611416115161161611716118161191612016121161221612316124161251612616127161281612916130161311613216133161341613516136161371613816139161401614116142161431614416145161461614716148161491615016151161521615316154161551615616157161581615916160161611616216163161641616516166161671616816169161701617116172161731617416175161761617716178161791618016181161821618316184161851618616187161881618916190161911619216193161941619516196161971619816199162001620116202162031620416205162061620716208162091621016211162121621316214162151621616217162181621916220162211622216223162241622516226162271622816229162301623116232162331623416235162361623716238162391624016241162421624316244162451624616247162481624916250162511625216253162541625516256162571625816259162601626116262162631626416265162661626716268162691627016271162721627316274162751627616277162781627916280162811628216283162841628516286162871628816289162901629116292162931629416295162961629716298162991630016301163021630316304163051630616307163081630916310163111631216313163141631516316163171631816319163201632116322163231632416325163261632716328163291633016331163321633316334163351633616337163381633916340163411634216343163441634516346163471634816349163501635116352163531635416355163561635716358163591636016361163621636316364163651636616367163681636916370163711637216373163741637516376163771637816379163801638116382163831638416385163861638716388163891639016391163921639316394163951639616397163981639916400164011640216403164041640516406164071640816409164101641116412164131641416415164161641716418164191642016421164221642316424164251642616427164281642916430164311643216433164341643516436164371643816439164401644116442164431644416445164461644716448164491645016451164521645316454164551645616457164581645916460164611646216463164641646516466164671646816469164701647116472164731647416475164761647716478164791648016481164821648316484164851648616487164881648916490164911649216493164941649516496164971649816499165001650116502165031650416505165061650716508165091651016511165121651316514165151651616517165181651916520165211652216523165241652516526165271652816529165301653116532165331653416535165361653716538165391654016541165421654316544165451654616547165481654916550165511655216553165541655516556165571655816559165601656116562165631656416565165661656716568165691657016571165721657316574165751657616577165781657916580165811658216583165841658516586165871658816589165901659116592165931659416595165961659716598165991660016601166021660316604166051660616607166081660916610166111661216613166141661516616166171661816619166201662116622166231662416625166261662716628166291663016631166321663316634166351663616637166381663916640166411664216643166441664516646166471664816649166501665116652166531665416655166561665716658166591666016661166621666316664166651666616667166681666916670166711667216673166741667516676166771667816679166801668116682166831668416685166861668716688166891669016691166921669316694166951669616697166981669916700167011670216703167041670516706167071670816709167101671116712167131671416715167161671716718167191672016721167221672316724167251672616727167281672916730167311673216733167341673516736167371673816739167401674116742167431674416745167461674716748167491675016751167521675316754167551675616757167581675916760167611676216763167641676516766167671676816769167701677116772167731677416775167761677716778167791678016781167821678316784167851678616787167881678916790167911679216793167941679516796167971679816799168001680116802168031680416805168061680716808168091681016811168121681316814168151681616817168181681916820168211682216823168241682516826168271682816829168301683116832168331683416835168361683716838168391684016841168421684316844168451684616847168481684916850168511685216853168541685516856168571685816859168601686116862168631686416865168661686716868168691687016871168721687316874168751687616877168781687916880168811688216883168841688516886168871688816889168901689116892168931689416895168961689716898168991690016901169021690316904169051690616907169081690916910169111691216913169141691516916169171691816919169201692116922169231692416925169261692716928169291693016931169321693316934169351693616937169381693916940169411694216943169441694516946169471694816949169501695116952169531695416955169561695716958169591696016961169621696316964169651696616967169681696916970169711697216973169741697516976169771697816979169801698116982169831698416985169861698716988169891699016991169921699316994169951699616997169981699917000170011700217003170041700517006170071700817009170101701117012170131701417015170161701717018170191702017021170221702317024170251702617027170281702917030170311703217033170341703517036170371703817039170401704117042170431704417045170461704717048170491705017051170521705317054170551705617057170581705917060170611706217063170641706517066170671706817069170701707117072170731707417075170761707717078170791708017081170821708317084170851708617087170881708917090170911709217093170941709517096170971709817099171001710117102171031710417105171061710717108171091711017111171121711317114171151711617117171181711917120171211712217123171241712517126171271712817129171301713117132171331713417135171361713717138171391714017141171421714317144171451714617147171481714917150171511715217153171541715517156171571715817159171601716117162171631716417165171661716717168171691717017171171721717317174171751717617177171781717917180171811718217183171841718517186171871718817189171901719117192171931719417195171961719717198171991720017201172021720317204172051720617207172081720917210172111721217213172141721517216172171721817219172201722117222172231722417225172261722717228172291723017231172321723317234172351723617237172381723917240172411724217243172441724517246172471724817249172501725117252172531725417255172561725717258172591726017261172621726317264172651726617267172681726917270172711727217273172741727517276172771727817279172801728117282172831728417285172861728717288172891729017291172921729317294172951729617297172981729917300173011730217303173041730517306173071730817309173101731117312173131731417315173161731717318173191732017321173221732317324173251732617327173281732917330173311733217333173341733517336173371733817339173401734117342173431734417345173461734717348173491735017351173521735317354173551735617357173581735917360173611736217363173641736517366173671736817369173701737117372173731737417375173761737717378173791738017381173821738317384173851738617387173881738917390173911739217393173941739517396173971739817399174001740117402174031740417405174061740717408174091741017411174121741317414174151741617417174181741917420174211742217423174241742517426174271742817429174301743117432174331743417435174361743717438174391744017441174421744317444174451744617447174481744917450174511745217453174541745517456174571745817459174601746117462174631746417465174661746717468174691747017471174721747317474174751747617477174781747917480174811748217483174841748517486174871748817489174901749117492174931749417495174961749717498174991750017501175021750317504175051750617507175081750917510175111751217513175141751517516175171751817519175201752117522175231752417525175261752717528175291753017531175321753317534175351753617537175381753917540175411754217543175441754517546175471754817549175501755117552175531755417555175561755717558175591756017561175621756317564175651756617567175681756917570175711757217573175741757517576175771757817579175801758117582175831758417585175861758717588175891759017591175921759317594175951759617597175981759917600176011760217603176041760517606176071760817609176101761117612176131761417615176161761717618176191762017621176221762317624176251762617627176281762917630176311763217633176341763517636176371763817639176401764117642176431764417645176461764717648176491765017651176521765317654176551765617657176581765917660176611766217663176641766517666176671766817669176701767117672176731767417675176761767717678176791768017681176821768317684176851768617687176881768917690176911769217693176941769517696176971769817699177001770117702177031770417705177061770717708177091771017711177121771317714177151771617717177181771917720177211772217723177241772517726177271772817729177301773117732177331773417735177361773717738177391774017741177421774317744177451774617747177481774917750177511775217753177541775517756177571775817759177601776117762177631776417765177661776717768177691777017771177721777317774177751777617777177781777917780177811778217783177841778517786177871778817789177901779117792177931779417795177961779717798177991780017801178021780317804178051780617807178081780917810178111781217813178141781517816178171781817819178201782117822178231782417825178261782717828178291783017831178321783317834178351783617837178381783917840178411784217843178441784517846178471784817849178501785117852178531785417855178561785717858178591786017861178621786317864178651786617867178681786917870178711787217873178741787517876178771787817879178801788117882178831788417885178861788717888178891789017891178921789317894178951789617897178981789917900179011790217903179041790517906179071790817909179101791117912179131791417915179161791717918179191792017921179221792317924179251792617927179281792917930179311793217933179341793517936179371793817939179401794117942179431794417945179461794717948179491795017951179521795317954179551795617957179581795917960179611796217963179641796517966179671796817969179701797117972179731797417975179761797717978179791798017981179821798317984179851798617987179881798917990179911799217993179941799517996179971799817999180001800118002180031800418005180061800718008180091801018011180121801318014180151801618017180181801918020180211802218023180241802518026180271802818029180301803118032180331803418035180361803718038180391804018041180421804318044180451804618047180481804918050180511805218053180541805518056180571805818059180601806118062180631806418065180661806718068180691807018071180721807318074180751807618077180781807918080180811808218083180841808518086180871808818089180901809118092180931809418095180961809718098180991810018101181021810318104181051810618107181081810918110181111811218113181141811518116181171811818119181201812118122181231812418125181261812718128181291813018131181321813318134181351813618137181381813918140181411814218143181441814518146181471814818149181501815118152181531815418155181561815718158181591816018161181621816318164181651816618167181681816918170181711817218173181741817518176181771817818179181801818118182181831818418185181861818718188181891819018191181921819318194181951819618197181981819918200182011820218203182041820518206182071820818209182101821118212182131821418215182161821718218182191822018221182221822318224182251822618227182281822918230182311823218233182341823518236182371823818239182401824118242182431824418245182461824718248182491825018251182521825318254182551825618257182581825918260182611826218263182641826518266182671826818269182701827118272182731827418275182761827718278182791828018281182821828318284182851828618287182881828918290182911829218293182941829518296182971829818299183001830118302183031830418305183061830718308183091831018311183121831318314183151831618317183181831918320183211832218323183241832518326183271832818329183301833118332183331833418335183361833718338183391834018341183421834318344183451834618347183481834918350183511835218353183541835518356183571835818359183601836118362183631836418365183661836718368183691837018371183721837318374183751837618377183781837918380183811838218383183841838518386183871838818389183901839118392183931839418395183961839718398183991840018401184021840318404184051840618407184081840918410184111841218413184141841518416184171841818419184201842118422184231842418425184261842718428184291843018431184321843318434184351843618437184381843918440184411844218443184441844518446184471844818449184501845118452184531845418455184561845718458184591846018461184621846318464184651846618467184681846918470184711847218473184741847518476184771847818479184801848118482184831848418485184861848718488184891849018491184921849318494184951849618497184981849918500185011850218503185041850518506185071850818509185101851118512185131851418515185161851718518185191852018521185221852318524185251852618527185281852918530185311853218533185341853518536185371853818539185401854118542185431854418545185461854718548185491855018551185521855318554185551855618557185581855918560185611856218563185641856518566185671856818569185701857118572185731857418575185761857718578185791858018581185821858318584185851858618587185881858918590185911859218593185941859518596185971859818599186001860118602186031860418605186061860718608186091861018611186121861318614186151861618617186181861918620186211862218623186241862518626186271862818629186301863118632186331863418635186361863718638186391864018641186421864318644186451864618647186481864918650186511865218653186541865518656186571865818659186601866118662186631866418665186661866718668186691867018671186721867318674186751867618677186781867918680186811868218683186841868518686186871868818689186901869118692186931869418695186961869718698186991870018701187021870318704187051870618707187081870918710187111871218713187141871518716187171871818719187201872118722187231872418725187261872718728187291873018731187321873318734187351873618737187381873918740187411874218743187441874518746187471874818749187501875118752187531875418755187561875718758187591876018761187621876318764187651876618767187681876918770187711877218773187741877518776187771877818779187801878118782187831878418785187861878718788187891879018791187921879318794187951879618797187981879918800188011880218803188041880518806188071880818809188101881118812188131881418815188161881718818188191882018821188221882318824188251882618827188281882918830188311883218833188341883518836188371883818839188401884118842188431884418845188461884718848188491885018851188521885318854188551885618857188581885918860188611886218863188641886518866188671886818869188701887118872188731887418875188761887718878188791888018881188821888318884188851888618887188881888918890188911889218893188941889518896188971889818899189001890118902189031890418905189061890718908189091891018911189121891318914189151891618917189181891918920189211892218923189241892518926189271892818929189301893118932189331893418935189361893718938189391894018941189421894318944189451894618947189481894918950189511895218953189541895518956189571895818959189601896118962189631896418965189661896718968189691897018971189721897318974189751897618977189781897918980189811898218983189841898518986189871898818989189901899118992189931899418995189961899718998189991900019001190021900319004190051900619007190081900919010190111901219013190141901519016190171901819019190201902119022190231902419025190261902719028190291903019031190321903319034190351903619037190381903919040190411904219043190441904519046190471904819049190501905119052190531905419055190561905719058190591906019061190621906319064190651906619067190681906919070190711907219073190741907519076190771907819079190801908119082190831908419085190861908719088190891909019091190921909319094190951909619097190981909919100191011910219103191041910519106191071910819109191101911119112191131911419115191161911719118191191912019121191221912319124191251912619127191281912919130191311913219133191341913519136191371913819139191401914119142191431914419145191461914719148191491915019151191521915319154191551915619157191581915919160191611916219163191641916519166191671916819169191701917119172191731917419175191761917719178191791918019181191821918319184191851918619187191881918919190191911919219193191941919519196191971919819199192001920119202192031920419205192061920719208192091921019211192121921319214192151921619217192181921919220192211922219223192241922519226192271922819229192301923119232192331923419235192361923719238192391924019241192421924319244192451924619247192481924919250192511925219253192541925519256192571925819259192601926119262192631926419265192661926719268192691927019271192721927319274192751927619277192781927919280192811928219283192841928519286192871928819289192901929119292192931929419295192961929719298192991930019301193021930319304193051930619307193081930919310193111931219313193141931519316193171931819319193201932119322193231932419325193261932719328193291933019331193321933319334193351933619337193381933919340193411934219343193441934519346193471934819349193501935119352193531935419355193561935719358193591936019361193621936319364193651936619367193681936919370193711937219373193741937519376193771937819379193801938119382193831938419385193861938719388193891939019391193921939319394193951939619397193981939919400194011940219403194041940519406194071940819409194101941119412194131941419415194161941719418194191942019421194221942319424194251942619427194281942919430194311943219433194341943519436194371943819439194401944119442194431944419445194461944719448194491945019451194521945319454194551945619457194581945919460194611946219463194641946519466194671946819469194701947119472194731947419475194761947719478194791948019481194821948319484194851948619487194881948919490194911949219493194941949519496194971949819499195001950119502195031950419505195061950719508195091951019511195121951319514195151951619517195181951919520195211952219523195241952519526195271952819529195301953119532195331953419535195361953719538195391954019541195421954319544195451954619547195481954919550195511955219553195541955519556195571955819559195601956119562195631956419565195661956719568195691957019571195721957319574195751957619577195781957919580195811958219583195841958519586195871958819589195901959119592195931959419595195961959719598195991960019601196021960319604196051960619607196081960919610196111961219613196141961519616196171961819619196201962119622196231962419625196261962719628196291963019631196321963319634196351963619637196381963919640196411964219643196441964519646196471964819649196501965119652196531965419655196561965719658196591966019661196621966319664196651966619667196681966919670196711967219673196741967519676196771967819679196801968119682196831968419685196861968719688196891969019691196921969319694196951969619697196981969919700197011970219703197041970519706197071970819709197101971119712197131971419715197161971719718197191972019721197221972319724197251972619727197281972919730197311973219733197341973519736197371973819739197401974119742197431974419745197461974719748197491975019751197521975319754197551975619757197581975919760197611976219763197641976519766197671976819769197701977119772197731977419775197761977719778197791978019781197821978319784197851978619787197881978919790197911979219793197941979519796197971979819799198001980119802198031980419805198061980719808198091981019811198121981319814198151981619817198181981919820198211982219823198241982519826198271982819829198301983119832198331983419835198361983719838198391984019841198421984319844198451984619847198481984919850198511985219853198541985519856198571985819859198601986119862198631986419865198661986719868198691987019871198721987319874198751987619877198781987919880198811988219883198841988519886198871988819889198901989119892198931989419895198961989719898198991990019901199021990319904199051990619907199081990919910199111991219913199141991519916199171991819919199201992119922199231992419925199261992719928199291993019931199321993319934199351993619937199381993919940199411994219943199441994519946199471994819949199501995119952199531995419955199561995719958199591996019961199621996319964199651996619967199681996919970199711997219973199741997519976199771997819979199801998119982199831998419985199861998719988199891999019991199921999319994199951999619997199981999920000200012000220003200042000520006200072000820009200102001120012200132001420015200162001720018200192002020021200222002320024200252002620027200282002920030200312003220033200342003520036200372003820039200402004120042200432004420045200462004720048200492005020051200522005320054200552005620057200582005920060200612006220063200642006520066200672006820069200702007120072200732007420075200762007720078200792008020081200822008320084200852008620087200882008920090200912009220093200942009520096200972009820099201002010120102201032010420105201062010720108201092011020111201122011320114201152011620117201182011920120201212012220123201242012520126201272012820129201302013120132201332013420135201362013720138201392014020141201422014320144201452014620147201482014920150201512015220153201542015520156201572015820159201602016120162201632016420165201662016720168201692017020171201722017320174201752017620177201782017920180201812018220183201842018520186201872018820189201902019120192201932019420195201962019720198201992020020201202022020320204202052020620207202082020920210202112021220213202142021520216202172021820219202202022120222202232022420225202262022720228202292023020231202322023320234202352023620237202382023920240202412024220243202442024520246202472024820249202502025120252202532025420255202562025720258202592026020261202622026320264202652026620267202682026920270202712027220273202742027520276202772027820279202802028120282202832028420285202862028720288202892029020291202922029320294202952029620297202982029920300203012030220303203042030520306203072030820309203102031120312203132031420315203162031720318203192032020321203222032320324203252032620327203282032920330203312033220333203342033520336203372033820339203402034120342203432034420345203462034720348203492035020351203522035320354203552035620357203582035920360203612036220363203642036520366203672036820369203702037120372203732037420375203762037720378203792038020381203822038320384203852038620387203882038920390203912039220393203942039520396203972039820399204002040120402204032040420405204062040720408204092041020411204122041320414204152041620417204182041920420204212042220423204242042520426204272042820429204302043120432204332043420435204362043720438204392044020441204422044320444204452044620447204482044920450204512045220453204542045520456204572045820459204602046120462204632046420465204662046720468204692047020471204722047320474204752047620477204782047920480204812048220483204842048520486204872048820489204902049120492204932049420495204962049720498204992050020501205022050320504205052050620507205082050920510205112051220513205142051520516205172051820519205202052120522205232052420525205262052720528205292053020531205322053320534205352053620537205382053920540205412054220543205442054520546205472054820549205502055120552205532055420555205562055720558205592056020561205622056320564205652056620567205682056920570205712057220573205742057520576205772057820579205802058120582205832058420585205862058720588205892059020591205922059320594205952059620597205982059920600206012060220603206042060520606206072060820609206102061120612206132061420615206162061720618206192062020621206222062320624206252062620627206282062920630206312063220633206342063520636206372063820639206402064120642206432064420645206462064720648206492065020651206522065320654206552065620657206582065920660206612066220663206642066520666206672066820669206702067120672206732067420675206762067720678206792068020681206822068320684206852068620687206882068920690206912069220693206942069520696206972069820699207002070120702207032070420705207062070720708207092071020711207122071320714207152071620717207182071920720207212072220723207242072520726207272072820729207302073120732207332073420735207362073720738207392074020741207422074320744207452074620747207482074920750207512075220753207542075520756207572075820759207602076120762207632076420765207662076720768207692077020771207722077320774207752077620777207782077920780207812078220783207842078520786207872078820789207902079120792207932079420795207962079720798207992080020801208022080320804208052080620807208082080920810208112081220813208142081520816208172081820819208202082120822208232082420825208262082720828208292083020831208322083320834208352083620837208382083920840208412084220843208442084520846208472084820849208502085120852208532085420855208562085720858208592086020861208622086320864208652086620867208682086920870208712087220873208742087520876208772087820879208802088120882208832088420885208862088720888208892089020891208922089320894208952089620897208982089920900209012090220903209042090520906209072090820909209102091120912209132091420915209162091720918209192092020921209222092320924209252092620927209282092920930209312093220933209342093520936209372093820939209402094120942209432094420945209462094720948209492095020951209522095320954209552095620957209582095920960209612096220963209642096520966209672096820969209702097120972209732097420975209762097720978209792098020981209822098320984209852098620987209882098920990209912099220993209942099520996209972099820999210002100121002210032100421005210062100721008210092101021011210122101321014210152101621017210182101921020210212102221023210242102521026210272102821029210302103121032210332103421035210362103721038210392104021041210422104321044210452104621047210482104921050210512105221053210542105521056210572105821059210602106121062210632106421065210662106721068210692107021071210722107321074210752107621077210782107921080210812108221083210842108521086210872108821089210902109121092210932109421095210962109721098210992110021101211022110321104211052110621107211082110921110211112111221113211142111521116211172111821119211202112121122211232112421125211262112721128211292113021131211322113321134211352113621137211382113921140211412114221143211442114521146211472114821149211502115121152211532115421155211562115721158211592116021161211622116321164211652116621167211682116921170211712117221173211742117521176211772117821179211802118121182211832118421185211862118721188211892119021191211922119321194211952119621197211982119921200212012120221203212042120521206212072120821209212102121121212212132121421215212162121721218212192122021221212222122321224212252122621227212282122921230212312123221233212342123521236212372123821239212402124121242212432124421245212462124721248212492125021251212522125321254212552125621257212582125921260212612126221263212642126521266212672126821269212702127121272212732127421275212762127721278212792128021281212822128321284212852128621287212882128921290212912129221293212942129521296212972129821299213002130121302213032130421305213062130721308213092131021311213122131321314213152131621317213182131921320213212132221323213242132521326213272132821329213302133121332213332133421335213362133721338213392134021341213422134321344213452134621347213482134921350213512135221353213542135521356213572135821359213602136121362213632136421365213662136721368213692137021371213722137321374213752137621377213782137921380213812138221383213842138521386213872138821389213902139121392213932139421395213962139721398213992140021401214022140321404214052140621407214082140921410214112141221413214142141521416214172141821419214202142121422214232142421425214262142721428214292143021431214322143321434214352143621437214382143921440214412144221443214442144521446214472144821449214502145121452214532145421455214562145721458214592146021461214622146321464214652146621467214682146921470214712147221473214742147521476214772147821479214802148121482214832148421485214862148721488214892149021491214922149321494214952149621497214982149921500215012150221503215042150521506215072150821509215102151121512215132151421515215162151721518215192152021521215222152321524215252152621527215282152921530215312153221533215342153521536215372153821539215402154121542215432154421545215462154721548215492155021551215522155321554215552155621557215582155921560215612156221563215642156521566215672156821569215702157121572215732157421575215762157721578215792158021581215822158321584215852158621587215882158921590215912159221593215942159521596215972159821599216002160121602216032160421605216062160721608216092161021611216122161321614216152161621617216182161921620216212162221623216242162521626216272162821629216302163121632216332163421635216362163721638216392164021641216422164321644216452164621647216482164921650216512165221653216542165521656216572165821659216602166121662216632166421665216662166721668216692167021671216722167321674216752167621677216782167921680216812168221683216842168521686216872168821689216902169121692216932169421695216962169721698216992170021701217022170321704217052170621707217082170921710217112171221713217142171521716217172171821719217202172121722217232172421725217262172721728217292173021731217322173321734217352173621737217382173921740217412174221743217442174521746217472174821749217502175121752217532175421755217562175721758217592176021761217622176321764217652176621767217682176921770217712177221773217742177521776217772177821779217802178121782217832178421785217862178721788217892179021791217922179321794217952179621797217982179921800218012180221803218042180521806218072180821809218102181121812218132181421815218162181721818218192182021821218222182321824218252182621827218282182921830218312183221833218342183521836218372183821839218402184121842218432184421845218462184721848218492185021851218522185321854218552185621857218582185921860218612186221863218642186521866218672186821869218702187121872218732187421875218762187721878218792188021881218822188321884218852188621887218882188921890218912189221893218942189521896218972189821899219002190121902219032190421905219062190721908219092191021911219122191321914219152191621917219182191921920219212192221923219242192521926219272192821929219302193121932219332193421935219362193721938219392194021941219422194321944219452194621947219482194921950219512195221953219542195521956219572195821959219602196121962219632196421965219662196721968219692197021971219722197321974219752197621977219782197921980219812198221983219842198521986219872198821989219902199121992219932199421995219962199721998219992200022001220022200322004220052200622007220082200922010220112201222013220142201522016220172201822019220202202122022220232202422025220262202722028220292203022031220322203322034220352203622037220382203922040220412204222043220442204522046220472204822049220502205122052220532205422055220562205722058220592206022061220622206322064220652206622067220682206922070220712207222073220742207522076220772207822079220802208122082220832208422085220862208722088220892209022091220922209322094220952209622097220982209922100221012210222103221042210522106221072210822109221102211122112221132211422115221162211722118221192212022121221222212322124221252212622127221282212922130221312213222133221342213522136221372213822139221402214122142221432214422145221462214722148221492215022151221522215322154221552215622157221582215922160221612216222163221642216522166221672216822169221702217122172221732217422175221762217722178221792218022181221822218322184221852218622187221882218922190221912219222193221942219522196221972219822199222002220122202222032220422205222062220722208222092221022211222122221322214222152221622217222182221922220222212222222223222242222522226222272222822229222302223122232222332223422235222362223722238222392224022241222422224322244222452224622247222482224922250222512225222253222542225522256222572225822259222602226122262222632226422265222662226722268222692227022271222722227322274222752227622277222782227922280222812228222283222842228522286222872228822289222902229122292222932229422295222962229722298222992230022301223022230322304223052230622307223082230922310223112231222313223142231522316223172231822319223202232122322223232232422325223262232722328223292233022331223322233322334223352233622337223382233922340223412234222343223442234522346223472234822349223502235122352223532235422355223562235722358223592236022361223622236322364223652236622367223682236922370223712237222373223742237522376223772237822379223802238122382223832238422385223862238722388223892239022391223922239322394223952239622397223982239922400224012240222403224042240522406224072240822409224102241122412224132241422415224162241722418224192242022421224222242322424224252242622427224282242922430224312243222433224342243522436224372243822439224402244122442224432244422445224462244722448224492245022451224522245322454224552245622457224582245922460224612246222463224642246522466224672246822469224702247122472224732247422475224762247722478224792248022481224822248322484224852248622487224882248922490224912249222493224942249522496224972249822499225002250122502225032250422505225062250722508225092251022511225122251322514225152251622517225182251922520225212252222523225242252522526225272252822529225302253122532225332253422535225362253722538225392254022541225422254322544225452254622547225482254922550225512255222553225542255522556225572255822559225602256122562225632256422565225662256722568225692257022571225722257322574225752257622577225782257922580225812258222583225842258522586225872258822589225902259122592225932259422595225962259722598225992260022601226022260322604226052260622607226082260922610226112261222613226142261522616226172261822619226202262122622226232262422625226262262722628226292263022631226322263322634226352263622637226382263922640226412264222643226442264522646226472264822649226502265122652226532265422655226562265722658226592266022661226622266322664226652266622667226682266922670226712267222673226742267522676226772267822679226802268122682226832268422685226862268722688226892269022691226922269322694226952269622697226982269922700227012270222703227042270522706227072270822709227102271122712227132271422715227162271722718227192272022721227222272322724227252272622727227282272922730227312273222733227342273522736227372273822739227402274122742227432274422745227462274722748227492275022751227522275322754227552275622757227582275922760227612276222763227642276522766227672276822769227702277122772227732277422775227762277722778227792278022781227822278322784227852278622787227882278922790227912279222793227942279522796227972279822799228002280122802228032280422805228062280722808228092281022811228122281322814228152281622817228182281922820228212282222823228242282522826228272282822829228302283122832228332283422835228362283722838228392284022841228422284322844228452284622847228482284922850228512285222853228542285522856228572285822859228602286122862228632286422865228662286722868228692287022871228722287322874228752287622877228782287922880228812288222883228842288522886228872288822889228902289122892228932289422895228962289722898228992290022901229022290322904229052290622907229082290922910229112291222913229142291522916229172291822919229202292122922229232292422925229262292722928229292293022931229322293322934229352293622937229382293922940229412294222943229442294522946229472294822949229502295122952229532295422955229562295722958229592296022961229622296322964229652296622967229682296922970229712297222973229742297522976229772297822979229802298122982229832298422985229862298722988229892299022991229922299322994229952299622997229982299923000230012300223003230042300523006230072300823009230102301123012230132301423015230162301723018230192302023021230222302323024230252302623027230282302923030230312303223033230342303523036230372303823039230402304123042230432304423045230462304723048230492305023051230522305323054230552305623057230582305923060230612306223063230642306523066230672306823069230702307123072230732307423075230762307723078230792308023081230822308323084230852308623087230882308923090230912309223093230942309523096230972309823099231002310123102231032310423105231062310723108231092311023111231122311323114231152311623117231182311923120231212312223123231242312523126231272312823129231302313123132231332313423135231362313723138231392314023141231422314323144231452314623147231482314923150231512315223153231542315523156231572315823159231602316123162231632316423165231662316723168231692317023171231722317323174231752317623177231782317923180231812318223183231842318523186231872318823189231902319123192231932319423195231962319723198231992320023201232022320323204232052320623207232082320923210232112321223213232142321523216232172321823219232202322123222232232322423225232262322723228232292323023231232322323323234232352323623237232382323923240232412324223243232442324523246232472324823249232502325123252232532325423255232562325723258232592326023261232622326323264232652326623267232682326923270232712327223273232742327523276232772327823279232802328123282232832328423285232862328723288232892329023291232922329323294232952329623297232982329923300233012330223303233042330523306233072330823309233102331123312233132331423315233162331723318233192332023321233222332323324233252332623327233282332923330233312333223333233342333523336233372333823339233402334123342233432334423345233462334723348233492335023351233522335323354233552335623357233582335923360233612336223363233642336523366233672336823369233702337123372233732337423375233762337723378233792338023381233822338323384233852338623387233882338923390233912339223393233942339523396233972339823399234002340123402234032340423405234062340723408234092341023411234122341323414234152341623417234182341923420234212342223423234242342523426234272342823429234302343123432234332343423435234362343723438234392344023441234422344323444234452344623447234482344923450234512345223453234542345523456234572345823459234602346123462234632346423465234662346723468234692347023471234722347323474234752347623477234782347923480234812348223483234842348523486234872348823489234902349123492234932349423495234962349723498234992350023501235022350323504235052350623507235082350923510235112351223513235142351523516235172351823519235202352123522235232352423525235262352723528235292353023531235322353323534235352353623537235382353923540235412354223543235442354523546235472354823549235502355123552235532355423555235562355723558235592356023561235622356323564235652356623567235682356923570235712357223573235742357523576235772357823579235802358123582235832358423585235862358723588235892359023591235922359323594235952359623597235982359923600236012360223603236042360523606236072360823609236102361123612236132361423615236162361723618236192362023621236222362323624236252362623627236282362923630236312363223633236342363523636236372363823639236402364123642236432364423645236462364723648236492365023651236522365323654236552365623657236582365923660236612366223663236642366523666236672366823669236702367123672236732367423675236762367723678236792368023681236822368323684236852368623687236882368923690236912369223693236942369523696236972369823699237002370123702237032370423705237062370723708237092371023711237122371323714237152371623717237182371923720237212372223723237242372523726237272372823729237302373123732237332373423735237362373723738237392374023741237422374323744237452374623747237482374923750237512375223753237542375523756237572375823759237602376123762237632376423765237662376723768237692377023771237722377323774237752377623777237782377923780237812378223783237842378523786237872378823789237902379123792237932379423795237962379723798237992380023801238022380323804238052380623807238082380923810238112381223813238142381523816238172381823819238202382123822238232382423825238262382723828238292383023831238322383323834238352383623837238382383923840238412384223843238442384523846238472384823849238502385123852238532385423855238562385723858238592386023861238622386323864238652386623867238682386923870238712387223873238742387523876238772387823879238802388123882238832388423885238862388723888238892389023891238922389323894238952389623897238982389923900239012390223903239042390523906239072390823909239102391123912239132391423915239162391723918239192392023921239222392323924239252392623927239282392923930239312393223933239342393523936239372393823939239402394123942239432394423945239462394723948239492395023951239522395323954239552395623957239582395923960239612396223963239642396523966239672396823969239702397123972239732397423975239762397723978239792398023981239822398323984239852398623987239882398923990239912399223993239942399523996239972399823999240002400124002240032400424005240062400724008240092401024011240122401324014240152401624017240182401924020240212402224023240242402524026240272402824029240302403124032240332403424035240362403724038240392404024041240422404324044240452404624047240482404924050240512405224053240542405524056240572405824059240602406124062240632406424065240662406724068240692407024071240722407324074240752407624077240782407924080240812408224083240842408524086240872408824089240902409124092240932409424095240962409724098240992410024101241022410324104241052410624107241082410924110241112411224113241142411524116241172411824119241202412124122241232412424125241262412724128241292413024131241322413324134241352413624137241382413924140241412414224143241442414524146241472414824149241502415124152241532415424155241562415724158241592416024161241622416324164241652416624167241682416924170241712417224173241742417524176241772417824179241802418124182241832418424185241862418724188241892419024191241922419324194241952419624197241982419924200242012420224203242042420524206242072420824209242102421124212242132421424215242162421724218242192422024221242222422324224242252422624227242282422924230242312423224233242342423524236242372423824239242402424124242242432424424245242462424724248242492425024251242522425324254242552425624257242582425924260242612426224263242642426524266242672426824269242702427124272242732427424275242762427724278242792428024281242822428324284242852428624287242882428924290242912429224293242942429524296242972429824299243002430124302243032430424305243062430724308243092431024311243122431324314243152431624317243182431924320243212432224323243242432524326243272432824329243302433124332243332433424335243362433724338243392434024341243422434324344243452434624347243482434924350243512435224353243542435524356243572435824359243602436124362243632436424365243662436724368243692437024371243722437324374243752437624377243782437924380243812438224383243842438524386243872438824389243902439124392243932439424395243962439724398243992440024401244022440324404244052440624407244082440924410244112441224413244142441524416244172441824419244202442124422244232442424425244262442724428244292443024431244322443324434244352443624437244382443924440244412444224443244442444524446244472444824449244502445124452244532445424455244562445724458244592446024461244622446324464244652446624467244682446924470244712447224473244742447524476244772447824479244802448124482244832448424485244862448724488244892449024491244922449324494244952449624497244982449924500245012450224503245042450524506245072450824509245102451124512245132451424515245162451724518245192452024521245222452324524245252452624527245282452924530245312453224533245342453524536245372453824539245402454124542245432454424545245462454724548245492455024551245522455324554245552455624557245582455924560245612456224563245642456524566245672456824569245702457124572245732457424575245762457724578245792458024581245822458324584245852458624587245882458924590245912459224593245942459524596245972459824599246002460124602246032460424605246062460724608246092461024611246122461324614246152461624617246182461924620246212462224623246242462524626246272462824629246302463124632246332463424635246362463724638246392464024641246422464324644246452464624647246482464924650246512465224653246542465524656246572465824659246602466124662246632466424665246662466724668246692467024671246722467324674246752467624677246782467924680246812468224683246842468524686246872468824689246902469124692246932469424695246962469724698246992470024701247022470324704247052470624707247082470924710247112471224713247142471524716247172471824719247202472124722247232472424725247262472724728247292473024731247322473324734247352473624737247382473924740247412474224743247442474524746247472474824749247502475124752247532475424755247562475724758247592476024761247622476324764247652476624767247682476924770247712477224773247742477524776247772477824779247802478124782247832478424785247862478724788247892479024791247922479324794247952479624797247982479924800248012480224803248042480524806248072480824809248102481124812248132481424815248162481724818248192482024821248222482324824248252482624827248282482924830248312483224833248342483524836248372483824839248402484124842248432484424845248462484724848248492485024851248522485324854248552485624857248582485924860248612486224863248642486524866248672486824869248702487124872248732487424875248762487724878248792488024881248822488324884248852488624887248882488924890248912489224893248942489524896248972489824899249002490124902249032490424905249062490724908249092491024911249122491324914249152491624917249182491924920249212492224923249242492524926249272492824929249302493124932249332493424935249362493724938249392494024941249422494324944249452494624947249482494924950249512495224953249542495524956249572495824959249602496124962249632496424965249662496724968249692497024971249722497324974249752497624977249782497924980249812498224983249842498524986249872498824989249902499124992249932499424995249962499724998249992500025001250022500325004250052500625007250082500925010250112501225013250142501525016250172501825019250202502125022250232502425025250262502725028250292503025031250322503325034250352503625037250382503925040250412504225043250442504525046250472504825049250502505125052250532505425055250562505725058250592506025061250622506325064250652506625067250682506925070250712507225073250742507525076250772507825079250802508125082250832508425085250862508725088250892509025091250922509325094250952509625097250982509925100251012510225103251042510525106251072510825109251102511125112
  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-2017 Free Software Foundation, Inc.
  4. ;;
  5. ;; Author: Carsten Dominik <carsten at orgmode dot org>
  6. ;; Maintainer: Carsten Dominik <carsten at orgmode dot org>
  7. ;; Keywords: outlines, hypermedia, calendar, wp
  8. ;; Homepage: http://orgmode.org
  9. ;;
  10. ;; This file is part of GNU Emacs.
  11. ;;
  12. ;; GNU Emacs is free software: you can redistribute it and/or modify
  13. ;; it under the terms of the GNU General Public License as published by
  14. ;; the Free Software Foundation, either version 3 of the License, or
  15. ;; (at your option) any later version.
  16. ;; GNU Emacs is distributed in the hope that it will be useful,
  17. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  18. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  19. ;; GNU General Public License for more details.
  20. ;; You should have received a copy of the GNU General Public License
  21. ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
  22. ;;
  23. ;;; Commentary:
  24. ;;
  25. ;; Org is a mode for keeping notes, maintaining ToDo lists, and doing
  26. ;; project planning with a fast and effective plain-text system.
  27. ;;
  28. ;; Org mode develops organizational tasks around NOTES files that
  29. ;; contain information about projects as plain text. Org mode is
  30. ;; implemented on top of outline-mode, which makes it possible to keep
  31. ;; the content of large files well structured. Visibility cycling and
  32. ;; structure editing help to work with the tree. Tables are easily
  33. ;; created with a built-in table editor. Org mode supports ToDo
  34. ;; items, deadlines, time stamps, and scheduling. It dynamically
  35. ;; compiles entries into an agenda that utilizes and smoothly
  36. ;; integrates much of the Emacs calendar and diary. Plain text
  37. ;; URL-like links connect to websites, emails, Usenet messages, BBDB
  38. ;; entries, and any files related to the projects. For printing and
  39. ;; sharing of notes, an Org file can be exported as a structured ASCII
  40. ;; file, as HTML, or (todo and agenda items only) as an iCalendar
  41. ;; file. It can also serve as a publishing tool for a set of linked
  42. ;; webpages.
  43. ;;
  44. ;; Installation and Activation
  45. ;; ---------------------------
  46. ;; See the corresponding sections in the manual at
  47. ;;
  48. ;; http://orgmode.org/org.html#Installation
  49. ;;
  50. ;; Documentation
  51. ;; -------------
  52. ;; The documentation of Org mode can be found in the TeXInfo file. The
  53. ;; distribution also contains a PDF version of it. At the homepage of
  54. ;; Org mode, you can read the same text online as HTML. There is also an
  55. ;; excellent reference card made by Philip Rooke. This card can be found
  56. ;; in the doc/ directory.
  57. ;;
  58. ;; A list of recent changes can be found at
  59. ;; http://orgmode.org/Changes.html
  60. ;;
  61. ;;; Code:
  62. (defvar org-inhibit-highlight-removal nil) ; dynamically scoped param
  63. (defvar-local org-table-formula-constants-local nil
  64. "Local version of `org-table-formula-constants'.")
  65. ;;;; Require other packages
  66. (require 'cl-lib)
  67. (eval-when-compile (require 'gnus-sum))
  68. (require 'calendar)
  69. (require 'find-func)
  70. (require 'format-spec)
  71. (or (eq this-command 'eval-buffer)
  72. (condition-case nil
  73. (load (concat (file-name-directory load-file-name)
  74. "org-loaddefs.el")
  75. nil t t t)
  76. (error
  77. (message "WARNING: No org-loaddefs.el file could be found from where org.el is loaded.")
  78. (sit-for 3)
  79. (message "You need to run \"make\" or \"make autoloads\" from Org lisp directory")
  80. (sit-for 3))))
  81. (require 'org-macs)
  82. (require 'org-compat)
  83. ;; `org-outline-regexp' ought to be a defconst but is let-bound in
  84. ;; some places -- e.g. see the macro `org-with-limited-levels'.
  85. ;;
  86. ;; In Org buffers, the value of `outline-regexp' is that of
  87. ;; `org-outline-regexp'. The only function still directly relying on
  88. ;; `outline-regexp' is `org-overview' so that `org-cycle' can do its
  89. ;; job when `orgstruct-mode' is active.
  90. (defvar org-outline-regexp "\\*+ "
  91. "Regexp to match Org headlines.")
  92. (defvar org-outline-regexp-bol "^\\*+ "
  93. "Regexp to match Org headlines.
  94. This is similar to `org-outline-regexp' but additionally makes
  95. sure that we are at the beginning of the line.")
  96. (defvar org-heading-regexp "^\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
  97. "Matches a headline, putting stars and text into groups.
  98. Stars are put in group 1 and the trimmed body in group 2.")
  99. (declare-function calendar-check-holidays "holidays" (date))
  100. (declare-function cdlatex-environment "ext:cdlatex" (environment item))
  101. (declare-function isearch-no-upper-case-p "isearch" (string regexp-flag))
  102. (declare-function org-add-archive-files "org-archive" (files))
  103. (declare-function org-agenda-entry-get-agenda-timestamp "org-agenda" (pom))
  104. (declare-function org-agenda-list "org-agenda"
  105. (&optional arg start-day span with-hour))
  106. (declare-function org-agenda-redo "org-agenda" (&optional all))
  107. (declare-function org-babel-do-in-edit-buffer "ob-core" (&rest body) t)
  108. (declare-function org-babel-tangle-file "ob-tangle" (file &optional target-file lang))
  109. (declare-function org-beamer-mode "ox-beamer" (&optional prefix) t)
  110. (declare-function org-clock-get-last-clock-out-time "org-clock" ())
  111. (declare-function org-clock-out "org-clock" (&optional switch-to-state fail-quietly at-time))
  112. (declare-function org-clock-remove-overlays "org-clock" (&optional beg end noremove))
  113. (declare-function org-clock-sum "org-clock" (&optional tstart tend headline-filter propname))
  114. (declare-function org-clock-sum-current-item "org-clock" (&optional tstart))
  115. (declare-function org-clock-timestamps-down "org-clock" (&optional n))
  116. (declare-function org-clock-timestamps-up "org-clock" (&optional n))
  117. (declare-function org-clock-update-time-maybe "org-clock" ())
  118. (declare-function org-clocktable-shift "org-clock" (dir n))
  119. (declare-function org-element-at-point "org-element" ())
  120. (declare-function org-element-cache-refresh "org-element" (pos))
  121. (declare-function org-element-cache-reset "org-element" (&optional all))
  122. (declare-function org-element-contents "org-element" (element))
  123. (declare-function org-element-context "org-element" (&optional element))
  124. (declare-function org-element-copy "org-element" (datum))
  125. (declare-function org-element-interpret-data "org-element" (data))
  126. (declare-function org-element-lineage "org-element" (blob &optional types with-self))
  127. (declare-function org-element-nested-p "org-element" (elem-a elem-b))
  128. (declare-function org-element-parse-buffer "org-element" (&optional granularity visible-only))
  129. (declare-function org-element-property "org-element" (property element))
  130. (declare-function org-element-put-property "org-element" (element property value))
  131. (declare-function org-element-swap-A-B "org-element" (elem-a elem-b))
  132. (declare-function org-element-type "org-element" (element))
  133. (declare-function org-element-update-syntax "org-element" ())
  134. (declare-function org-id-find-id-file "org-id" (id))
  135. (declare-function org-id-get-create "org-id" (&optional force))
  136. (declare-function org-inlinetask-at-task-p "org-inlinetask" ())
  137. (declare-function org-inlinetask-outline-regexp "org-inlinetask" ())
  138. (declare-function org-inlinetask-toggle-visibility "org-inlinetask" ())
  139. (declare-function org-plot/gnuplot "org-plot" (&optional params))
  140. (declare-function org-table-align "org-table" ())
  141. (declare-function org-table-begin "org-table" (&optional table-type))
  142. (declare-function org-table-beginning-of-field "org-table" (&optional n))
  143. (declare-function org-table-blank-field "org-table" ())
  144. (declare-function org-table-calc-current-TBLFM "org-table" (&optional arg))
  145. (declare-function org-table-copy-region "org-table" (beg end &optional cut))
  146. (declare-function org-table-cut-region "org-table" (beg end))
  147. (declare-function org-table-edit-field "org-table" (arg))
  148. (declare-function org-table-end "org-table" (&optional table-type))
  149. (declare-function org-table-end-of-field "org-table" (&optional n))
  150. (declare-function org-table-insert-row "org-table" (&optional arg))
  151. (declare-function org-table-justify-field-maybe "org-table" (&optional new))
  152. (declare-function org-table-maybe-eval-formula "org-table" ())
  153. (declare-function org-table-maybe-recalculate-line "org-table" ())
  154. (declare-function org-table-next-row "org-table" ())
  155. (declare-function org-table-paste-rectangle "org-table" ())
  156. (declare-function org-table-recalculate "org-table" (&optional all noalign))
  157. (declare-function org-table-wrap-region "org-table" (arg))
  158. (declare-function org-tags-view "org-agenda" (&optional todo-only match))
  159. (declare-function orgtbl-ascii-plot "org-table" (&optional ask))
  160. (declare-function orgtbl-mode "org-table" (&optional arg))
  161. (defsubst org-uniquify (list)
  162. "Non-destructively remove duplicate elements from LIST."
  163. (let ((res (copy-sequence list))) (delete-dups res)))
  164. (defsubst org-get-at-bol (property)
  165. "Get text property PROPERTY at the beginning of line."
  166. (get-text-property (point-at-bol) property))
  167. (defsubst org-trim (s &optional keep-lead)
  168. "Remove whitespace at the beginning and the end of string S.
  169. When optional argument KEEP-LEAD is non-nil, removing blank lines
  170. at the beginning of the string does not affect leading indentation."
  171. (replace-regexp-in-string
  172. (if keep-lead "\\`\\([ \t]*\n\\)+" "\\`[ \t\n\r]+") ""
  173. (replace-regexp-in-string "[ \t\n\r]+\\'" "" s)))
  174. ;; load languages based on value of `org-babel-load-languages'
  175. (defvar org-babel-load-languages)
  176. ;;;###autoload
  177. (defun org-babel-do-load-languages (sym value)
  178. "Load the languages defined in `org-babel-load-languages'."
  179. (set-default sym value)
  180. (dolist (pair org-babel-load-languages)
  181. (let ((active (cdr pair)) (lang (symbol-name (car pair))))
  182. (if active
  183. (require (intern (concat "ob-" lang)))
  184. (funcall 'fmakunbound
  185. (intern (concat "org-babel-execute:" lang)))
  186. (funcall 'fmakunbound
  187. (intern (concat "org-babel-expand-body:" lang)))))))
  188. (declare-function org-babel-tangle-file "ob-tangle" (file &optional target-file lang))
  189. ;;;###autoload
  190. (defun org-babel-load-file (file &optional compile)
  191. "Load Emacs Lisp source code blocks in the Org FILE.
  192. This function exports the source code using `org-babel-tangle'
  193. and then loads the resulting file using `load-file'. With prefix
  194. arg (noninteractively: 2nd arg) COMPILE the tangled Emacs Lisp
  195. file to byte-code before it is loaded."
  196. (interactive "fFile to load: \nP")
  197. (let* ((age (lambda (file)
  198. (float-time
  199. (time-subtract (current-time)
  200. (nth 5 (or (file-attributes (file-truename file))
  201. (file-attributes file)))))))
  202. (base-name (file-name-sans-extension file))
  203. (exported-file (concat base-name ".el")))
  204. ;; tangle if the Org file is newer than the elisp file
  205. (unless (and (file-exists-p exported-file)
  206. (> (funcall age file) (funcall age exported-file)))
  207. ;; Tangle-file traversal returns reversed list of tangled files
  208. ;; and we want to evaluate the first target.
  209. (setq exported-file
  210. (car (last (org-babel-tangle-file file exported-file "emacs-lisp")))))
  211. (message "%s %s"
  212. (if compile
  213. (progn (byte-compile-file exported-file 'load)
  214. "Compiled and loaded")
  215. (progn (load-file exported-file) "Loaded"))
  216. exported-file)))
  217. (defcustom org-babel-load-languages '((emacs-lisp . t))
  218. "Languages which can be evaluated in Org buffers.
  219. This list can be used to load support for any of the languages
  220. below, note that each language will depend on a different set of
  221. system executables and/or Emacs modes. When a language is
  222. \"loaded\", then code blocks in that language can be evaluated
  223. with `org-babel-execute-src-block' bound by default to C-c
  224. C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
  225. be set to remove code block evaluation from the C-c C-c
  226. keybinding. By default only Emacs Lisp (which has no
  227. requirements) is loaded."
  228. :group 'org-babel
  229. :set 'org-babel-do-load-languages
  230. :version "24.1"
  231. :type '(alist :tag "Babel Languages"
  232. :key-type
  233. (choice
  234. (const :tag "Awk" awk)
  235. (const :tag "C" C)
  236. (const :tag "R" R)
  237. (const :tag "Asymptote" asymptote)
  238. (const :tag "Calc" calc)
  239. (const :tag "Clojure" clojure)
  240. (const :tag "CSS" css)
  241. (const :tag "Ditaa" ditaa)
  242. (const :tag "Dot" dot)
  243. (const :tag "Emacs Lisp" emacs-lisp)
  244. (const :tag "Forth" forth)
  245. (const :tag "Fortran" fortran)
  246. (const :tag "Gnuplot" gnuplot)
  247. (const :tag "Haskell" haskell)
  248. (const :tag "IO" io)
  249. (const :tag "J" J)
  250. (const :tag "Java" java)
  251. (const :tag "Javascript" js)
  252. (const :tag "LaTeX" latex)
  253. (const :tag "Ledger" ledger)
  254. (const :tag "Lilypond" lilypond)
  255. (const :tag "Lisp" lisp)
  256. (const :tag "Makefile" makefile)
  257. (const :tag "Maxima" maxima)
  258. (const :tag "Matlab" matlab)
  259. (const :tag "Mscgen" mscgen)
  260. (const :tag "Ocaml" ocaml)
  261. (const :tag "Octave" octave)
  262. (const :tag "Org" org)
  263. (const :tag "Perl" perl)
  264. (const :tag "Pico Lisp" picolisp)
  265. (const :tag "PlantUML" plantuml)
  266. (const :tag "Python" python)
  267. (const :tag "Ruby" ruby)
  268. (const :tag "Sass" sass)
  269. (const :tag "Scala" scala)
  270. (const :tag "Scheme" scheme)
  271. (const :tag "Screen" screen)
  272. (const :tag "Shell Script" shell)
  273. (const :tag "Shen" shen)
  274. (const :tag "Sql" sql)
  275. (const :tag "Sqlite" sqlite)
  276. (const :tag "Stan" stan)
  277. (const :tag "ebnf2ps" ebnf2ps))
  278. :value-type (boolean :tag "Activate" :value t)))
  279. ;;;; Customization variables
  280. (defcustom org-clone-delete-id nil
  281. "Remove ID property of clones of a subtree.
  282. When non-nil, clones of a subtree don't inherit the ID property.
  283. Otherwise they inherit the ID property with a new unique
  284. identifier."
  285. :type 'boolean
  286. :version "24.1"
  287. :group 'org-id)
  288. ;;; Version
  289. (org-check-version)
  290. ;;;###autoload
  291. (defun org-version (&optional here full message)
  292. "Show the Org version.
  293. Interactively, or when MESSAGE is non-nil, show it in echo area.
  294. With prefix argument, or when HERE is non-nil, insert it at point.
  295. In non-interactive uses, a reduced version string is output unless
  296. FULL is given."
  297. (interactive (list current-prefix-arg t (not current-prefix-arg)))
  298. (let ((org-dir (ignore-errors (org-find-library-dir "org")))
  299. (save-load-suffixes (when (boundp 'load-suffixes) load-suffixes))
  300. (load-suffixes (list ".el"))
  301. (org-install-dir
  302. (ignore-errors (org-find-library-dir "org-loaddefs"))))
  303. (unless (and (fboundp 'org-release) (fboundp 'org-git-version))
  304. (org-load-noerror-mustsuffix (concat org-dir "org-version")))
  305. (let* ((load-suffixes save-load-suffixes)
  306. (release (org-release))
  307. (git-version (org-git-version))
  308. (version (format "Org mode version %s (%s @ %s)"
  309. release
  310. git-version
  311. (if org-install-dir
  312. (if (string= org-dir org-install-dir)
  313. org-install-dir
  314. (concat "mixed installation! "
  315. org-install-dir
  316. " and "
  317. org-dir))
  318. "org-loaddefs.el can not be found!")))
  319. (version1 (if full version release)))
  320. (when here (insert version1))
  321. (when message (message "%s" version1))
  322. version1)))
  323. (defconst org-version (org-version))
  324. ;;; Syntax Constants
  325. ;;;; Block
  326. (defconst org-block-regexp
  327. "^[ \t]*#\\+begin_?\\([^ \n]+\\)\\(\\([^\n]+\\)\\)?\n\\([^\000]+?\\)#\\+end_?\\1[ \t]*$"
  328. "Regular expression for hiding blocks.")
  329. (defconst org-dblock-start-re
  330. "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+\\(\\S-+\\)\\([ \t]+\\(.*\\)\\)?"
  331. "Matches the start line of a dynamic block, with parameters.")
  332. (defconst org-dblock-end-re "^[ \t]*#\\+\\(?:END\\|end\\)\\([: \t\r\n]\\|$\\)"
  333. "Matches the end of a dynamic block.")
  334. ;;;; Clock and Planning
  335. (defconst org-clock-string "CLOCK:"
  336. "String used as prefix for timestamps clocking work hours on an item.")
  337. (defvar org-closed-string "CLOSED:"
  338. "String used as the prefix for timestamps logging closing a TODO entry.")
  339. (defvar org-deadline-string "DEADLINE:"
  340. "String to mark deadline entries.
  341. \\<org-mode-map>
  342. A deadline is this string, followed by a time stamp. It must be
  343. a word, terminated by a colon. You can insert a schedule keyword
  344. and a timestamp with `\\[org-deadline]'.")
  345. (defvar org-scheduled-string "SCHEDULED:"
  346. "String to mark scheduled TODO entries.
  347. \\<org-mode-map>
  348. A schedule is this string, followed by a time stamp. It must be
  349. a word, terminated by a colon. You can insert a schedule keyword
  350. and a timestamp with `\\[org-schedule]'.")
  351. (defconst org-ds-keyword-length
  352. (+ 2
  353. (apply #'max
  354. (mapcar #'length
  355. (list org-deadline-string org-scheduled-string
  356. org-clock-string org-closed-string))))
  357. "Maximum length of the DEADLINE and SCHEDULED keywords.")
  358. (defconst org-planning-line-re
  359. (concat "^[ \t]*"
  360. (regexp-opt
  361. (list org-closed-string org-deadline-string org-scheduled-string)
  362. t))
  363. "Matches a line with planning info.
  364. Matched keyword is in group 1.")
  365. (defconst org-clock-line-re
  366. (concat "^[ \t]*" org-clock-string)
  367. "Matches a line with clock info.")
  368. (defconst org-deadline-regexp (concat "\\<" org-deadline-string)
  369. "Matches the DEADLINE keyword.")
  370. (defconst org-deadline-time-regexp
  371. (concat "\\<" org-deadline-string " *<\\([^>]+\\)>")
  372. "Matches the DEADLINE keyword together with a time stamp.")
  373. (defconst org-deadline-time-hour-regexp
  374. (concat "\\<" org-deadline-string
  375. " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
  376. "Matches the DEADLINE keyword together with a time-and-hour stamp.")
  377. (defconst org-deadline-line-regexp
  378. (concat "\\<\\(" org-deadline-string "\\).*")
  379. "Matches the DEADLINE keyword and the rest of the line.")
  380. (defconst org-scheduled-regexp (concat "\\<" org-scheduled-string)
  381. "Matches the SCHEDULED keyword.")
  382. (defconst org-scheduled-time-regexp
  383. (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>")
  384. "Matches the SCHEDULED keyword together with a time stamp.")
  385. (defconst org-scheduled-time-hour-regexp
  386. (concat "\\<" org-scheduled-string
  387. " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
  388. "Matches the SCHEDULED keyword together with a time-and-hour stamp.")
  389. (defconst org-closed-time-regexp
  390. (concat "\\<" org-closed-string " *\\[\\([^]]+\\)\\]")
  391. "Matches the CLOSED keyword together with a time stamp.")
  392. (defconst org-keyword-time-regexp
  393. (concat "\\<"
  394. (regexp-opt
  395. (list org-scheduled-string org-deadline-string org-closed-string
  396. org-clock-string)
  397. t)
  398. " *[[<]\\([^]>]+\\)[]>]")
  399. "Matches any of the 4 keywords, together with the time stamp.")
  400. (defconst org-keyword-time-not-clock-regexp
  401. (concat
  402. "\\<"
  403. (regexp-opt
  404. (list org-scheduled-string org-deadline-string org-closed-string) t)
  405. " *[[<]\\([^]>]+\\)[]>]")
  406. "Matches any of the 3 keywords, together with the time stamp.")
  407. (defconst org-maybe-keyword-time-regexp
  408. (concat "\\(\\<"
  409. (regexp-opt
  410. (list org-scheduled-string org-deadline-string org-closed-string
  411. org-clock-string)
  412. t)
  413. "\\)?"
  414. " *\\([[<][0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?[]>]"
  415. "\\|"
  416. "<%%([^\r\n>]*>\\)")
  417. "Matches a timestamp, possibly preceded by a keyword.")
  418. (defconst org-all-time-keywords
  419. (mapcar (lambda (w) (substring w 0 -1))
  420. (list org-scheduled-string org-deadline-string
  421. org-clock-string org-closed-string))
  422. "List of time keywords.")
  423. ;;;; Drawer
  424. (defconst org-drawer-regexp "^[ \t]*:\\(\\(?:\\w\\|[-_]\\)+\\):[ \t]*$"
  425. "Matches first or last line of a hidden block.
  426. Group 1 contains drawer's name or \"END\".")
  427. (defconst org-property-start-re "^[ \t]*:PROPERTIES:[ \t]*$"
  428. "Regular expression matching the first line of a property drawer.")
  429. (defconst org-property-end-re "^[ \t]*:END:[ \t]*$"
  430. "Regular expression matching the last line of a property drawer.")
  431. (defconst org-clock-drawer-start-re "^[ \t]*:CLOCK:[ \t]*$"
  432. "Regular expression matching the first line of a clock drawer.")
  433. (defconst org-clock-drawer-end-re "^[ \t]*:END:[ \t]*$"
  434. "Regular expression matching the last line of a clock drawer.")
  435. (defconst org-property-drawer-re
  436. (concat "^[ \t]*:PROPERTIES:[ \t]*\n"
  437. "\\(?:[ \t]*:\\S-+:\\(?: .*\\)?[ \t]*\n\\)*?"
  438. "[ \t]*:END:[ \t]*$")
  439. "Matches an entire property drawer.")
  440. (defconst org-clock-drawer-re
  441. (concat "\\(" org-clock-drawer-start-re "\\)[^\000]*?\\("
  442. org-clock-drawer-end-re "\\)\n?")
  443. "Matches an entire clock drawer.")
  444. ;;;; Headline
  445. (defconst org-heading-keyword-regexp-format
  446. "^\\(\\*+\\)\\(?: +%s\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
  447. "Printf format for a regexp matching a headline with some keyword.
  448. This regexp will match the headline of any node which has the
  449. exact keyword that is put into the format. The keyword isn't in
  450. any group by default, but the stars and the body are.")
  451. (defconst org-heading-keyword-maybe-regexp-format
  452. "^\\(\\*+\\)\\(?: +%s\\)?\\(?: +\\(.*?\\)\\)?[ \t]*$"
  453. "Printf format for a regexp matching a headline, possibly with some keyword.
  454. This regexp can match any headline with the specified keyword, or
  455. without a keyword. The keyword isn't in any group by default,
  456. but the stars and the body are.")
  457. (defconst org-archive-tag "ARCHIVE"
  458. "The tag that marks a subtree as archived.
  459. An archived subtree does not open during visibility cycling, and does
  460. not contribute to the agenda listings.")
  461. (defconst org-comment-string "COMMENT"
  462. "Entries starting with this keyword will never be exported.
  463. \\<org-mode-map>
  464. An entry can be toggled between COMMENT and normal with
  465. `\\[org-toggle-comment]'.")
  466. ;;;; LaTeX Environments and Fragments
  467. (defconst org-latex-regexps
  468. '(("begin" "^[ \t]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^\000]+?\\\\end{\\2}\\)" 1 t)
  469. ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
  470. ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
  471. ("$1" "\\([^$]\\|^\\)\\(\\$[^ \r\n,;.$]\\$\\)\\(\\s.\\|\\s-\\|\\s(\\|\\s)\\|\\s\"\\|\000\\|$\\)" 2 nil)
  472. ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\(\\s.\\|\\s-\\|\\s(\\|\\s)\\|\\s\"\\|\000\\|$\\)" 2 nil)
  473. ("\\(" "\\\\([^\000]*?\\\\)" 0 nil)
  474. ("\\[" "\\\\\\[[^\000]*?\\\\\\]" 0 nil)
  475. ("$$" "\\$\\$[^\000]*?\\$\\$" 0 nil))
  476. "Regular expressions for matching embedded LaTeX.")
  477. ;;;; Node Property
  478. (defconst org-effort-property "Effort"
  479. "The property that is being used to keep track of effort estimates.
  480. Effort estimates given in this property need to have the format H:MM.")
  481. ;;;; Table
  482. (defconst org-table-any-line-regexp "^[ \t]*\\(|\\|\\+-[-+]\\)"
  483. "Detect an org-type or table-type table.")
  484. (defconst org-table-line-regexp "^[ \t]*|"
  485. "Detect an org-type table line.")
  486. (defconst org-table-dataline-regexp "^[ \t]*|[^-]"
  487. "Detect an org-type table line.")
  488. (defconst org-table-hline-regexp "^[ \t]*|-"
  489. "Detect an org-type table hline.")
  490. (defconst org-table1-hline-regexp "^[ \t]*\\+-[-+]"
  491. "Detect a table-type table hline.")
  492. (defconst org-table-any-border-regexp "^[ \t]*[^|+ \t]"
  493. "Detect the first line outside a table when searching from within it.
  494. This works for both table types.")
  495. (defconst org-TBLFM-regexp "^[ \t]*#\\+TBLFM: "
  496. "Detect a #+TBLFM line.")
  497. ;;;; Timestamp
  498. (defconst org-ts-regexp "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)>"
  499. "Regular expression for fast time stamp matching.")
  500. (defconst org-ts-regexp-inactive
  501. "\\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)\\]"
  502. "Regular expression for fast inactive time stamp matching.")
  503. (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
  504. "Regular expression for fast time stamp matching.")
  505. (defconst org-ts-regexp0
  506. "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\( +[^]+0-9>\r\n -]+\\)?\\( +\\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
  507. "Regular expression matching time strings for analysis.
  508. This one does not require the space after the date, so it can be used
  509. on a string that terminates immediately after the date.")
  510. (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
  511. "Regular expression matching time strings for analysis.")
  512. (defconst org-ts-regexp2 (concat "<" org-ts-regexp1 "[^>\n]\\{0,16\\}>")
  513. "Regular expression matching time stamps, with groups.")
  514. (defconst org-ts-regexp3 (concat "[[<]" org-ts-regexp1 "[^]>\n]\\{0,16\\}[]>]")
  515. "Regular expression matching time stamps (also [..]), with groups.")
  516. (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
  517. "Regular expression matching a time stamp range.")
  518. (defconst org-tr-regexp-both
  519. (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
  520. "Regular expression matching a time stamp range.")
  521. (defconst org-tsr-regexp (concat org-ts-regexp "\\(--?-?"
  522. org-ts-regexp "\\)?")
  523. "Regular expression matching a time stamp or time stamp range.")
  524. (defconst org-tsr-regexp-both
  525. (concat org-ts-regexp-both "\\(--?-?"
  526. org-ts-regexp-both "\\)?")
  527. "Regular expression matching a time stamp or time stamp range.
  528. The time stamps may be either active or inactive.")
  529. (defconst org-repeat-re
  530. "<[0-9]\\{4\\}-[0-9][0-9]-[0-9][0-9] [^>\n]*?\\([.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)"
  531. "Regular expression for specifying repeated events.
  532. After a match, group 1 contains the repeat expression.")
  533. (defconst org-time-stamp-formats '("<%Y-%m-%d %a>" . "<%Y-%m-%d %a %H:%M>")
  534. "Formats for `format-time-string' which are used for time stamps.")
  535. ;;; The custom variables
  536. (defgroup org nil
  537. "Outline-based notes management and organizer."
  538. :tag "Org"
  539. :group 'outlines
  540. :group 'calendar)
  541. (defcustom org-mode-hook nil
  542. "Mode hook for Org mode, run after the mode was turned on."
  543. :group 'org
  544. :type 'hook)
  545. (defcustom org-load-hook nil
  546. "Hook that is run after org.el has been loaded."
  547. :group 'org
  548. :type 'hook)
  549. (defcustom org-log-buffer-setup-hook nil
  550. "Hook that is run after an Org log buffer is created."
  551. :group 'org
  552. :version "24.1"
  553. :type 'hook)
  554. (defvar org-modules) ; defined below
  555. (defvar org-modules-loaded nil
  556. "Have the modules been loaded already?")
  557. (defun org-load-modules-maybe (&optional force)
  558. "Load all extensions listed in `org-modules'."
  559. (when (or force (not org-modules-loaded))
  560. (dolist (ext org-modules)
  561. (condition-case nil (require ext)
  562. (error (message "Problems while trying to load feature `%s'" ext))))
  563. (setq org-modules-loaded t)))
  564. (defun org-set-modules (var value)
  565. "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
  566. (set var value)
  567. (when (featurep 'org)
  568. (org-load-modules-maybe 'force)
  569. (org-element-cache-reset 'all)))
  570. (defcustom org-modules '(org-w3m org-bbdb org-bibtex org-docview org-gnus org-info org-irc org-mhe org-rmail)
  571. "Modules that should always be loaded together with org.el.
  572. If a description starts with <C>, the file is not part of Emacs
  573. and loading it will require that you have downloaded and properly
  574. installed the Org mode distribution.
  575. You can also use this system to load external packages (i.e. neither Org
  576. core modules, nor modules from the CONTRIB directory). Just add symbols
  577. to the end of the list. If the package is called org-xyz.el, then you need
  578. to add the symbol `xyz', and the package must have a call to:
  579. (provide \\='org-xyz)
  580. For export specific modules, see also `org-export-backends'."
  581. :group 'org
  582. :set 'org-set-modules
  583. :version "24.4"
  584. :package-version '(Org . "8.0")
  585. :type
  586. '(set :greedy t
  587. (const :tag " bbdb: Links to BBDB entries" org-bbdb)
  588. (const :tag " bibtex: Links to BibTeX entries" org-bibtex)
  589. (const :tag " crypt: Encryption of subtrees" org-crypt)
  590. (const :tag " ctags: Access to Emacs tags with links" org-ctags)
  591. (const :tag " docview: Links to doc-view buffers" org-docview)
  592. (const :tag " eww: Store link to url of eww" org-eww)
  593. (const :tag " gnus: Links to GNUS folders/messages" org-gnus)
  594. (const :tag " habit: Track your consistency with habits" org-habit)
  595. (const :tag " id: Global IDs for identifying entries" org-id)
  596. (const :tag " info: Links to Info nodes" org-info)
  597. (const :tag " inlinetask: Tasks independent of outline hierarchy" org-inlinetask)
  598. (const :tag " irc: Links to IRC/ERC chat sessions" org-irc)
  599. (const :tag " mhe: Links to MHE folders/messages" org-mhe)
  600. (const :tag " mouse: Additional mouse support" org-mouse)
  601. (const :tag " protocol: Intercept calls from emacsclient" org-protocol)
  602. (const :tag " rmail: Links to RMAIL folders/messages" org-rmail)
  603. (const :tag " w3m: Special cut/paste from w3m to Org mode." org-w3m)
  604. (const :tag "C annotate-file: Annotate a file with org syntax" org-annotate-file)
  605. (const :tag "C bookmark: Org links to bookmarks" org-bookmark)
  606. (const :tag "C checklist: Extra functions for checklists in repeated tasks" org-checklist)
  607. (const :tag "C choose: Use TODO keywords to mark decisions states" org-choose)
  608. (const :tag "C collector: Collect properties into tables" org-collector)
  609. (const :tag "C depend: TODO dependencies for Org mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
  610. (const :tag "C drill: Flashcards and spaced repetition for Org mode" org-drill)
  611. (const :tag "C elisp-symbol: Org links to emacs-lisp symbols" org-elisp-symbol)
  612. (const :tag "C eshell Support for links to working directories in eshell" org-eshell)
  613. (const :tag "C eval-light: Evaluate inbuffer-code on demand" org-eval-light)
  614. (const :tag "C eval: Include command output as text" org-eval)
  615. (const :tag "C expiry: Expiry mechanism for Org entries" org-expiry)
  616. (const :tag "C favtable: Lookup table of favorite references and links" org-favtable)
  617. (const :tag "C git-link: Provide org links to specific file version" org-git-link)
  618. (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
  619. (const :tag "C invoice: Help manage client invoices in Org mode" org-invoice)
  620. (const :tag "C learn: SuperMemo's incremental learning algorithm" org-learn)
  621. (const :tag "C mac-iCal Imports events from iCal.app to the Emacs diary" org-mac-iCal)
  622. (const :tag "C mac-link: Grab links and url from various mac Applications" org-mac-link)
  623. (const :tag "C mairix: Hook mairix search into Org for different MUAs" org-mairix)
  624. (const :tag "C man: Support for links to manpages in Org mode" org-man)
  625. (const :tag "C mew: Links to Mew folders/messages" org-mew)
  626. (const :tag "C mtags: Support for muse-like tags" org-mtags)
  627. (const :tag "C notmuch: Provide org links to notmuch searches or messages" org-notmuch)
  628. (const :tag "C panel: Simple routines for us with bad memory" org-panel)
  629. (const :tag "C registry: A registry for Org links" org-registry)
  630. (const :tag "C screen: Visit screen sessions through Org links" org-screen)
  631. (const :tag "C secretary: Team management with org-mode" org-secretary)
  632. (const :tag "C sqlinsert: Convert Org tables to SQL insertions" orgtbl-sqlinsert)
  633. (const :tag "C toc: Table of contents for Org buffer" org-toc)
  634. (const :tag "C track: Keep up with Org mode development" org-track)
  635. (const :tag "C velocity Something like Notational Velocity for Org" org-velocity)
  636. (const :tag "C vm: Links to VM folders/messages" org-vm)
  637. (const :tag "C wikinodes: CamelCase wiki-like links" org-wikinodes)
  638. (const :tag "C wl: Links to Wanderlust folders/messages" org-wl)
  639. (repeat :tag "External packages" :inline t (symbol :tag "Package"))))
  640. (defvar org-export-registered-backends) ; From ox.el.
  641. (declare-function org-export-derived-backend-p "ox" (backend &rest backends))
  642. (declare-function org-export-backend-name "ox" (backend) t)
  643. (defcustom org-export-backends '(ascii html icalendar latex odt)
  644. "List of export back-ends that should be always available.
  645. If a description starts with <C>, the file is not part of Emacs
  646. and loading it will require that you have downloaded and properly
  647. installed the Org mode distribution.
  648. Unlike to `org-modules', libraries in this list will not be
  649. loaded along with Org, but only once the export framework is
  650. needed.
  651. This variable needs to be set before org.el is loaded. If you
  652. need to make a change while Emacs is running, use the customize
  653. interface or run the following code, where VAL stands for the new
  654. value of the variable, after updating it:
  655. (progn
  656. (setq org-export-registered-backends
  657. (cl-remove-if-not
  658. (lambda (backend)
  659. (let ((name (org-export-backend-name backend)))
  660. (or (memq name val)
  661. (catch \\='parentp
  662. (dolist (b val)
  663. (and (org-export-derived-backend-p b name)
  664. (throw \\='parentp t)))))))
  665. org-export-registered-backends))
  666. (let ((new-list (mapcar #\\='org-export-backend-name
  667. org-export-registered-backends)))
  668. (dolist (backend val)
  669. (cond
  670. ((not (load (format \"ox-%s\" backend) t t))
  671. (message \"Problems while trying to load export back-end \\=`%s\\='\"
  672. backend))
  673. ((not (memq backend new-list)) (push backend new-list))))
  674. (set-default \\='org-export-backends new-list)))
  675. Adding a back-end to this list will also pull the back-end it
  676. depends on, if any."
  677. :group 'org
  678. :group 'org-export
  679. :version "25.2"
  680. :package-version '(Org . "9.0")
  681. :initialize 'custom-initialize-set
  682. :set (lambda (var val)
  683. (if (not (featurep 'ox)) (set-default var val)
  684. ;; Any back-end not required anymore (not present in VAL and not
  685. ;; a parent of any back-end in the new value) is removed from the
  686. ;; list of registered back-ends.
  687. (setq org-export-registered-backends
  688. (cl-remove-if-not
  689. (lambda (backend)
  690. (let ((name (org-export-backend-name backend)))
  691. (or (memq name val)
  692. (catch 'parentp
  693. (dolist (b val)
  694. (and (org-export-derived-backend-p b name)
  695. (throw 'parentp t)))))))
  696. org-export-registered-backends))
  697. ;; Now build NEW-LIST of both new back-ends and required
  698. ;; parents.
  699. (let ((new-list (mapcar #'org-export-backend-name
  700. org-export-registered-backends)))
  701. (dolist (backend val)
  702. (cond
  703. ((not (load (format "ox-%s" backend) t t))
  704. (message "Problems while trying to load export back-end `%s'"
  705. backend))
  706. ((not (memq backend new-list)) (push backend new-list))))
  707. ;; Set VAR to that list with fixed dependencies.
  708. (set-default var new-list))))
  709. :type '(set :greedy t
  710. (const :tag " ascii Export buffer to ASCII format" ascii)
  711. (const :tag " beamer Export buffer to Beamer presentation" beamer)
  712. (const :tag " html Export buffer to HTML format" html)
  713. (const :tag " icalendar Export buffer to iCalendar format" icalendar)
  714. (const :tag " latex Export buffer to LaTeX format" latex)
  715. (const :tag " man Export buffer to MAN format" man)
  716. (const :tag " md Export buffer to Markdown format" md)
  717. (const :tag " odt Export buffer to ODT format" odt)
  718. (const :tag " org Export buffer to Org format" org)
  719. (const :tag " texinfo Export buffer to Texinfo format" texinfo)
  720. (const :tag "C confluence Export buffer to Confluence Wiki format" confluence)
  721. (const :tag "C deck Export buffer to deck.js presentations" deck)
  722. (const :tag "C freemind Export buffer to Freemind mindmap format" freemind)
  723. (const :tag "C groff Export buffer to Groff format" groff)
  724. (const :tag "C koma-letter Export buffer to KOMA Scrlttrl2 format" koma-letter)
  725. (const :tag "C RSS 2.0 Export buffer to RSS 2.0 format" rss)
  726. (const :tag "C s5 Export buffer to s5 presentations" s5)
  727. (const :tag "C taskjuggler Export buffer to TaskJuggler format" taskjuggler)))
  728. (eval-after-load 'ox
  729. '(dolist (backend org-export-backends)
  730. (condition-case nil (require (intern (format "ox-%s" backend)))
  731. (error (message "Problems while trying to load export back-end `%s'"
  732. backend)))))
  733. (defcustom org-support-shift-select nil
  734. "Non-nil means make shift-cursor commands select text when possible.
  735. \\<org-mode-map>\
  736. In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
  737. start selecting a region, or enlarge regions started in this way.
  738. In Org mode, in special contexts, these same keys are used for
  739. other purposes, important enough to compete with shift selection.
  740. Org tries to balance these needs by supporting `shift-select-mode'
  741. outside these special contexts, under control of this variable.
  742. The default of this variable is nil, to avoid confusing behavior. Shifted
  743. cursor keys will then execute Org commands in the following contexts:
  744. - on a headline, changing TODO state (left/right) and priority (up/down)
  745. - on a time stamp, changing the time
  746. - in a plain list item, changing the bullet type
  747. - in a property definition line, switching between allowed values
  748. - in the BEGIN line of a clock table (changing the time block).
  749. Outside these contexts, the commands will throw an error.
  750. When this variable is t and the cursor is not in a special
  751. context, Org mode will support shift-selection for making and
  752. enlarging regions. To make this more effective, the bullet
  753. cycling will no longer happen anywhere in an item line, but only
  754. if the cursor is exactly on the bullet.
  755. If you set this variable to the symbol `always', then the keys
  756. will not be special in headlines, property lines, and item lines,
  757. to make shift selection work there as well. If this is what you
  758. want, you can use the following alternative commands:
  759. `\\[org-todo]' and `\\[org-priority]' \
  760. to change TODO state and priority,
  761. `\\[universal-argument] \\[universal-argument] \\[org-todo]' \
  762. can be used to switch TODO sets,
  763. `\\[org-ctrl-c-minus]' to cycle item bullet types,
  764. and properties can be edited by hand or in column view.
  765. However, when the cursor is on a timestamp, shift-cursor commands
  766. will still edit the time stamp - this is just too good to give up."
  767. :group 'org
  768. :type '(choice
  769. (const :tag "Never" nil)
  770. (const :tag "When outside special context" t)
  771. (const :tag "Everywhere except timestamps" always)))
  772. (defcustom org-loop-over-headlines-in-active-region nil
  773. "Shall some commands act upon headlines in the active region?
  774. When set to t, some commands will be performed in all headlines
  775. within the active region.
  776. When set to `start-level', some commands will be performed in all
  777. headlines within the active region, provided that these headlines
  778. are of the same level than the first one.
  779. When set to a string, those commands will be performed on the
  780. matching headlines within the active region. Such string must be
  781. a tags/property/todo match as it is used in the agenda tags view.
  782. The list of commands is: `org-schedule', `org-deadline',
  783. `org-todo', `org-archive-subtree', `org-archive-set-tag' and
  784. `org-archive-to-archive-sibling'. The archiving commands skip
  785. already archived entries."
  786. :type '(choice (const :tag "Don't loop" nil)
  787. (const :tag "All headlines in active region" t)
  788. (const :tag "In active region, headlines at the same level than the first one" start-level)
  789. (string :tag "Tags/Property/Todo matcher"))
  790. :version "24.1"
  791. :group 'org-todo
  792. :group 'org-archive)
  793. (defgroup org-startup nil
  794. "Options concerning startup of Org mode."
  795. :tag "Org Startup"
  796. :group 'org)
  797. (defcustom org-startup-folded t
  798. "Non-nil means entering Org mode will switch to OVERVIEW.
  799. This can also be configured on a per-file basis by adding one of
  800. the following lines anywhere in the buffer:
  801. #+STARTUP: fold (or `overview', this is equivalent)
  802. #+STARTUP: nofold (or `showall', this is equivalent)
  803. #+STARTUP: content
  804. #+STARTUP: showeverything
  805. Set `org-agenda-inhibit-startup' to a non-nil value if you want
  806. to ignore this option when Org opens agenda files for the first
  807. time."
  808. :group 'org-startup
  809. :type '(choice
  810. (const :tag "nofold: show all" nil)
  811. (const :tag "fold: overview" t)
  812. (const :tag "content: all headlines" content)
  813. (const :tag "show everything, even drawers" showeverything)))
  814. (defcustom org-startup-truncated t
  815. "Non-nil means entering Org mode will set `truncate-lines'.
  816. This is useful since some lines containing links can be very long and
  817. uninteresting. Also tables look terrible when wrapped.
  818. The variable `org-startup-truncated' allows to configure
  819. truncation for Org mode different to the other modes that use the
  820. variable `truncate-lines' and as a shortcut instead of putting
  821. the variable `truncate-lines' into the `org-mode-hook'. If one
  822. wants to configure truncation for Org mode not statically but
  823. dynamically e. g. in a hook like `ediff-prepare-buffer-hook' then
  824. the variable `truncate-lines' has to be used because in such a
  825. case it is too late to set the variable `org-startup-truncated'."
  826. :group 'org-startup
  827. :type 'boolean)
  828. (defcustom org-startup-indented nil
  829. "Non-nil means turn on `org-indent-mode' on startup.
  830. This can also be configured on a per-file basis by adding one of
  831. the following lines anywhere in the buffer:
  832. #+STARTUP: indent
  833. #+STARTUP: noindent"
  834. :group 'org-structure
  835. :type '(choice
  836. (const :tag "Not" nil)
  837. (const :tag "Globally (slow on startup in large files)" t)))
  838. (defcustom org-use-sub-superscripts t
  839. "Non-nil means interpret \"_\" and \"^\" for display.
  840. If you want to control how Org exports those characters, see
  841. `org-export-with-sub-superscripts'. `org-use-sub-superscripts'
  842. used to be an alias for `org-export-with-sub-superscripts' in
  843. Org <8.0, it is not anymore.
  844. When this option is turned on, you can use TeX-like syntax for
  845. sub- and superscripts within the buffer. Several characters after
  846. \"_\" or \"^\" will be considered as a single item - so grouping
  847. with {} is normally not needed. For example, the following things
  848. will be parsed as single sub- or superscripts:
  849. 10^24 or 10^tau several digits will be considered 1 item.
  850. 10^-12 or 10^-tau a leading sign with digits or a word
  851. x^2-y^3 will be read as x^2 - y^3, because items are
  852. terminated by almost any nonword/nondigit char.
  853. x_{i^2} or x^(2-i) braces or parenthesis do grouping.
  854. Still, ambiguity is possible. So when in doubt, use {} to enclose
  855. the sub/superscript. If you set this variable to the symbol `{}',
  856. the braces are *required* in order to trigger interpretations as
  857. sub/superscript. This can be helpful in documents that need \"_\"
  858. frequently in plain text."
  859. :group 'org-startup
  860. :version "24.4"
  861. :package-version '(Org . "8.0")
  862. :type '(choice
  863. (const :tag "Always interpret" t)
  864. (const :tag "Only with braces" {})
  865. (const :tag "Never interpret" nil)))
  866. (defcustom org-startup-with-beamer-mode nil
  867. "Non-nil means turn on `org-beamer-mode' on startup.
  868. This can also be configured on a per-file basis by adding one of
  869. the following lines anywhere in the buffer:
  870. #+STARTUP: beamer"
  871. :group 'org-startup
  872. :version "24.1"
  873. :type 'boolean)
  874. (defcustom org-startup-align-all-tables nil
  875. "Non-nil means align all tables when visiting a file.
  876. This is useful when the column width in tables is forced with <N> cookies
  877. in table fields. Such tables will look correct only after the first re-align.
  878. This can also be configured on a per-file basis by adding one of
  879. the following lines anywhere in the buffer:
  880. #+STARTUP: align
  881. #+STARTUP: noalign"
  882. :group 'org-startup
  883. :type 'boolean)
  884. (defcustom org-startup-with-inline-images nil
  885. "Non-nil means show inline images when loading a new Org file.
  886. This can also be configured on a per-file basis by adding one of
  887. the following lines anywhere in the buffer:
  888. #+STARTUP: inlineimages
  889. #+STARTUP: noinlineimages"
  890. :group 'org-startup
  891. :version "24.1"
  892. :type 'boolean)
  893. (defcustom org-startup-with-latex-preview nil
  894. "Non-nil means preview LaTeX fragments when loading a new Org file.
  895. This can also be configured on a per-file basis by adding one of
  896. the following lines anywhere in the buffer:
  897. #+STARTUP: latexpreview
  898. #+STARTUP: nolatexpreview"
  899. :group 'org-startup
  900. :version "24.4"
  901. :package-version '(Org . "8.0")
  902. :type 'boolean)
  903. (defcustom org-insert-mode-line-in-empty-file nil
  904. "Non-nil means insert the first line setting Org mode in empty files.
  905. When the function `org-mode' is called interactively in an empty file, this
  906. normally means that the file name does not automatically trigger Org mode.
  907. To ensure that the file will always be in Org mode in the future, a
  908. line enforcing Org mode will be inserted into the buffer, if this option
  909. has been set."
  910. :group 'org-startup
  911. :type 'boolean)
  912. (defcustom org-replace-disputed-keys nil
  913. "Non-nil means use alternative key bindings for some keys.
  914. Org mode uses S-<cursor> keys for changing timestamps and priorities.
  915. These keys are also used by other packages like shift-selection-mode'
  916. \(built into Emacs 23), `CUA-mode' or `windmove.el'.
  917. If you want to use Org mode together with one of these other modes,
  918. or more generally if you would like to move some Org mode commands to
  919. other keys, set this variable and configure the keys with the variable
  920. `org-disputed-keys'.
  921. This option is only relevant at load-time of Org mode, and must be set
  922. *before* org.el is loaded. Changing it requires a restart of Emacs to
  923. become effective."
  924. :group 'org-startup
  925. :type 'boolean)
  926. (defcustom org-use-extra-keys nil
  927. "Non-nil means use extra key sequence definitions for certain commands.
  928. This happens automatically if `window-system' is nil. This
  929. variable lets you do the same manually. You must set it before
  930. loading Org."
  931. :group 'org-startup
  932. :type 'boolean)
  933. (defvaralias 'org-CUA-compatible 'org-replace-disputed-keys)
  934. (defcustom org-disputed-keys
  935. '(([(shift up)] . [(meta p)])
  936. ([(shift down)] . [(meta n)])
  937. ([(shift left)] . [(meta -)])
  938. ([(shift right)] . [(meta +)])
  939. ([(control shift right)] . [(meta shift +)])
  940. ([(control shift left)] . [(meta shift -)]))
  941. "Keys for which Org mode and other modes compete.
  942. This is an alist, cars are the default keys, second element specifies
  943. the alternative to use when `org-replace-disputed-keys' is t.
  944. Keys can be specified in any syntax supported by `define-key'.
  945. The value of this option takes effect only at Org mode startup,
  946. therefore you'll have to restart Emacs to apply it after changing."
  947. :group 'org-startup
  948. :type 'alist)
  949. (defun org-key (key)
  950. "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
  951. Or return the original if not disputed."
  952. (when org-replace-disputed-keys
  953. (let* ((nkey (key-description key))
  954. (x (cl-find-if (lambda (x) (equal (key-description (car x)) nkey))
  955. org-disputed-keys)))
  956. (setq key (if x (cdr x) key))))
  957. key)
  958. (defun org-defkey (keymap key def)
  959. "Define a key, possibly translated, as returned by `org-key'."
  960. (define-key keymap (org-key key) def))
  961. (defcustom org-ellipsis nil
  962. "The ellipsis to use in the Org mode outline.
  963. When nil, just use the standard three dots.
  964. When a string, use that string instead.
  965. The change affects only Org mode (which will then use its own display table).
  966. Changing this requires executing `\\[org-mode]' in a buffer to become
  967. effective."
  968. :group 'org-startup
  969. :type '(choice (const :tag "Default" nil)
  970. (string :tag "String" :value "...#"))
  971. :safe #'string-or-null-p)
  972. (defvar org-display-table nil
  973. "The display table for org-mode, in case `org-ellipsis' is non-nil.")
  974. (defgroup org-keywords nil
  975. "Keywords in Org mode."
  976. :tag "Org Keywords"
  977. :group 'org)
  978. (defcustom org-closed-keep-when-no-todo nil
  979. "Remove CLOSED: time-stamp when switching back to a non-todo state?"
  980. :group 'org-todo
  981. :group 'org-keywords
  982. :version "24.4"
  983. :package-version '(Org . "8.0")
  984. :type 'boolean)
  985. (defgroup org-structure nil
  986. "Options concerning the general structure of Org files."
  987. :tag "Org Structure"
  988. :group 'org)
  989. (defgroup org-reveal-location nil
  990. "Options about how to make context of a location visible."
  991. :tag "Org Reveal Location"
  992. :group 'org-structure)
  993. (defcustom org-show-context-detail '((agenda . local)
  994. (bookmark-jump . lineage)
  995. (isearch . lineage)
  996. (default . ancestors))
  997. "Alist between context and visibility span when revealing a location.
  998. \\<org-mode-map>Some actions may move point into invisible
  999. locations. As a consequence, Org always expose a neighborhood
  1000. around point. How much is shown depends on the initial action,
  1001. or context. Valid contexts are
  1002. agenda when exposing an entry from the agenda
  1003. org-goto when using the command `org-goto' (`\\[org-goto]')
  1004. occur-tree when using the command `org-occur' (`\\[org-sparse-tree] /')
  1005. tags-tree when constructing a sparse tree based on tags matches
  1006. link-search when exposing search matches associated with a link
  1007. mark-goto when exposing the jump goal of a mark
  1008. bookmark-jump when exposing a bookmark location
  1009. isearch when exiting from an incremental search
  1010. default default for all contexts not set explicitly
  1011. Allowed visibility spans are
  1012. minimal show current headline; if point is not on headline,
  1013. also show entry
  1014. local show current headline, entry and next headline
  1015. ancestors show current headline and its direct ancestors; if
  1016. point is not on headline, also show entry
  1017. lineage show current headline, its direct ancestors and all
  1018. their children; if point is not on headline, also show
  1019. entry and first child
  1020. tree show current headline, its direct ancestors and all
  1021. their children; if point is not on headline, also show
  1022. entry and all children
  1023. canonical show current headline, its direct ancestors along with
  1024. their entries and children; if point is not located on
  1025. the headline, also show current entry and all children
  1026. As special cases, a nil or t value means show all contexts in
  1027. `minimal' or `canonical' view, respectively.
  1028. Some views can make displayed information very compact, but also
  1029. make it harder to edit the location of the match. In such
  1030. a case, use the command `org-reveal' (`\\[org-reveal]') to show
  1031. more context."
  1032. :group 'org-reveal-location
  1033. :version "25.2"
  1034. :package-version '(Org . "9.0")
  1035. :type '(choice
  1036. (const :tag "Canonical" t)
  1037. (const :tag "Minimal" nil)
  1038. (repeat :greedy t :tag "Individual contexts"
  1039. (cons
  1040. (choice :tag "Context"
  1041. (const agenda)
  1042. (const org-goto)
  1043. (const occur-tree)
  1044. (const tags-tree)
  1045. (const link-search)
  1046. (const mark-goto)
  1047. (const bookmark-jump)
  1048. (const isearch)
  1049. (const default))
  1050. (choice :tag "Detail level"
  1051. (const minimal)
  1052. (const local)
  1053. (const ancestors)
  1054. (const lineage)
  1055. (const tree)
  1056. (const canonical))))))
  1057. (defcustom org-indirect-buffer-display 'other-window
  1058. "How should indirect tree buffers be displayed?
  1059. This applies to indirect buffers created with the commands
  1060. `org-tree-to-indirect-buffer' and `org-agenda-tree-to-indirect-buffer'.
  1061. Valid values are:
  1062. current-window Display in the current window
  1063. other-window Just display in another window.
  1064. dedicated-frame Create one new frame, and re-use it each time.
  1065. new-frame Make a new frame each time. Note that in this case
  1066. previously-made indirect buffers are kept, and you need to
  1067. kill these buffers yourself."
  1068. :group 'org-structure
  1069. :group 'org-agenda-windows
  1070. :type '(choice
  1071. (const :tag "In current window" current-window)
  1072. (const :tag "In current frame, other window" other-window)
  1073. (const :tag "Each time a new frame" new-frame)
  1074. (const :tag "One dedicated frame" dedicated-frame)))
  1075. (defcustom org-use-speed-commands nil
  1076. "Non-nil means activate single letter commands at beginning of a headline.
  1077. This may also be a function to test for appropriate locations where speed
  1078. commands should be active.
  1079. For example, to activate speed commands when the point is on any
  1080. star at the beginning of the headline, you can do this:
  1081. (setq org-use-speed-commands
  1082. (lambda () (and (looking-at org-outline-regexp) (looking-back \"^\\**\"))))"
  1083. :group 'org-structure
  1084. :type '(choice
  1085. (const :tag "Never" nil)
  1086. (const :tag "At beginning of headline stars" t)
  1087. (function)))
  1088. (defcustom org-speed-commands-user nil
  1089. "Alist of additional speed commands.
  1090. This list will be checked before `org-speed-commands-default'
  1091. when the variable `org-use-speed-commands' is non-nil
  1092. and when the cursor is at the beginning of a headline.
  1093. The car if each entry is a string with a single letter, which must
  1094. be assigned to `self-insert-command' in the global map.
  1095. The cdr is either a command to be called interactively, a function
  1096. to be called, or a form to be evaluated.
  1097. An entry that is just a list with a single string will be interpreted
  1098. as a descriptive headline that will be added when listing the speed
  1099. commands in the Help buffer using the `?' speed command."
  1100. :group 'org-structure
  1101. :type '(repeat :value ("k" . ignore)
  1102. (choice :value ("k" . ignore)
  1103. (list :tag "Descriptive Headline" (string :tag "Headline"))
  1104. (cons :tag "Letter and Command"
  1105. (string :tag "Command letter")
  1106. (choice
  1107. (function)
  1108. (sexp))))))
  1109. (defcustom org-bookmark-names-plist
  1110. '(:last-capture "org-capture-last-stored"
  1111. :last-refile "org-refile-last-stored"
  1112. :last-capture-marker "org-capture-last-stored-marker")
  1113. "Names for bookmarks automatically set by some Org commands.
  1114. This can provide strings as names for a number of bookmarks Org sets
  1115. automatically. The following keys are currently implemented:
  1116. :last-capture
  1117. :last-capture-marker
  1118. :last-refile
  1119. When a key does not show up in the property list, the corresponding bookmark
  1120. is not set."
  1121. :group 'org-structure
  1122. :type 'plist)
  1123. (defgroup org-cycle nil
  1124. "Options concerning visibility cycling in Org mode."
  1125. :tag "Org Cycle"
  1126. :group 'org-structure)
  1127. (defcustom org-cycle-skip-children-state-if-no-children t
  1128. "Non-nil means skip CHILDREN state in entries that don't have any."
  1129. :group 'org-cycle
  1130. :type 'boolean)
  1131. (defcustom org-cycle-max-level nil
  1132. "Maximum level which should still be subject to visibility cycling.
  1133. Levels higher than this will, for cycling, be treated as text, not a headline.
  1134. When `org-odd-levels-only' is set, a value of N in this variable actually
  1135. means 2N-1 stars as the limiting headline.
  1136. When nil, cycle all levels.
  1137. Note that the limiting level of cycling is also influenced by
  1138. `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
  1139. `org-inlinetask-min-level' is, cycling will be limited to levels one less
  1140. than its value."
  1141. :group 'org-cycle
  1142. :type '(choice
  1143. (const :tag "No limit" nil)
  1144. (integer :tag "Maximum level")))
  1145. (defcustom org-hide-block-startup nil
  1146. "Non-nil means entering Org mode will fold all blocks.
  1147. This can also be set in on a per-file basis with
  1148. #+STARTUP: hideblocks
  1149. #+STARTUP: showblocks"
  1150. :group 'org-startup
  1151. :group 'org-cycle
  1152. :type 'boolean)
  1153. (defcustom org-cycle-global-at-bob nil
  1154. "Cycle globally if cursor is at beginning of buffer and not at a headline.
  1155. This makes it possible to do global cycling without having to use `S-TAB'
  1156. or `\\[universal-argument] TAB'. For this special case to work, the first \
  1157. line of the buffer
  1158. must not be a headline -- it may be empty or some other text.
  1159. When used in this way, `org-cycle-hook' is disabled temporarily to make
  1160. sure the cursor stays at the beginning of the buffer.
  1161. When this option is nil, don't do anything special at the beginning of
  1162. the buffer."
  1163. :group 'org-cycle
  1164. :type 'boolean)
  1165. (defcustom org-cycle-level-after-item/entry-creation t
  1166. "Non-nil means cycle entry level or item indentation in new empty entries.
  1167. When the cursor is at the end of an empty headline, i.e., with only stars
  1168. and maybe a TODO keyword, TAB will then switch the entry to become a child,
  1169. and then all possible ancestor states, before returning to the original state.
  1170. This makes data entry extremely fast: M-RET to create a new headline,
  1171. on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
  1172. When the cursor is at the end of an empty plain list item, one TAB will
  1173. make it a subitem, two or more tabs will back up to make this an item
  1174. higher up in the item hierarchy."
  1175. :group 'org-cycle
  1176. :type 'boolean)
  1177. (defcustom org-cycle-emulate-tab t
  1178. "Where should `org-cycle' emulate TAB.
  1179. nil Never
  1180. white Only in completely white lines
  1181. whitestart Only at the beginning of lines, before the first non-white char
  1182. t Everywhere except in headlines
  1183. exc-hl-bol Everywhere except at the start of a headline
  1184. If TAB is used in a place where it does not emulate TAB, the current subtree
  1185. visibility is cycled."
  1186. :group 'org-cycle
  1187. :type '(choice (const :tag "Never" nil)
  1188. (const :tag "Only in completely white lines" white)
  1189. (const :tag "Before first char in a line" whitestart)
  1190. (const :tag "Everywhere except in headlines" t)
  1191. (const :tag "Everywhere except at bol in headlines" exc-hl-bol)))
  1192. (defcustom org-cycle-separator-lines 2
  1193. "Number of empty lines needed to keep an empty line between collapsed trees.
  1194. If you leave an empty line between the end of a subtree and the following
  1195. headline, this empty line is hidden when the subtree is folded.
  1196. Org mode will leave (exactly) one empty line visible if the number of
  1197. empty lines is equal or larger to the number given in this variable.
  1198. So the default 2 means at least 2 empty lines after the end of a subtree
  1199. are needed to produce free space between a collapsed subtree and the
  1200. following headline.
  1201. If the number is negative, and the number of empty lines is at least -N,
  1202. all empty lines are shown.
  1203. Special case: when 0, never leave empty lines in collapsed view."
  1204. :group 'org-cycle
  1205. :type 'integer)
  1206. (put 'org-cycle-separator-lines 'safe-local-variable 'integerp)
  1207. (defcustom org-pre-cycle-hook nil
  1208. "Hook that is run before visibility cycling is happening.
  1209. The function(s) in this hook must accept a single argument which indicates
  1210. the new state that will be set right after running this hook. The
  1211. argument is a symbol. Before a global state change, it can have the values
  1212. `overview', `content', or `all'. Before a local state change, it can have
  1213. the values `folded', `children', or `subtree'."
  1214. :group 'org-cycle
  1215. :type 'hook)
  1216. (defcustom org-cycle-hook '(org-cycle-hide-archived-subtrees
  1217. org-cycle-hide-drawers
  1218. org-cycle-show-empty-lines
  1219. org-optimize-window-after-visibility-change)
  1220. "Hook that is run after `org-cycle' has changed the buffer visibility.
  1221. The function(s) in this hook must accept a single argument which indicates
  1222. the new state that was set by the most recent `org-cycle' command. The
  1223. argument is a symbol. After a global state change, it can have the values
  1224. `overview', `contents', or `all'. After a local state change, it can have
  1225. the values `folded', `children', or `subtree'."
  1226. :group 'org-cycle
  1227. :type 'hook
  1228. :version "25.2"
  1229. :package-version '(Org . "8.3"))
  1230. (defgroup org-edit-structure nil
  1231. "Options concerning structure editing in Org mode."
  1232. :tag "Org Edit Structure"
  1233. :group 'org-structure)
  1234. (defcustom org-odd-levels-only nil
  1235. "Non-nil means skip even levels and only use odd levels for the outline.
  1236. This has the effect that two stars are being added/taken away in
  1237. promotion/demotion commands. It also influences how levels are
  1238. handled by the exporters.
  1239. Changing it requires restart of `font-lock-mode' to become effective
  1240. for fontification also in regions already fontified.
  1241. You may also set this on a per-file basis by adding one of the following
  1242. lines to the buffer:
  1243. #+STARTUP: odd
  1244. #+STARTUP: oddeven"
  1245. :group 'org-edit-structure
  1246. :group 'org-appearance
  1247. :type 'boolean)
  1248. (defcustom org-adapt-indentation t
  1249. "Non-nil means adapt indentation to outline node level.
  1250. When this variable is set, Org assumes that you write outlines by
  1251. indenting text in each node to align with the headline (after the
  1252. stars). The following issues are influenced by this variable:
  1253. - The indentation is increased by one space in a demotion
  1254. command, and decreased by one in a promotion command. However,
  1255. in the latter case, if shifting some line in the entry body
  1256. would alter document structure (e.g., insert a new headline),
  1257. indentation is not changed at all.
  1258. - Property drawers and planning information is inserted indented
  1259. when this variable is set. When nil, they will not be indented.
  1260. - TAB indents a line relative to current level. The lines below
  1261. a headline will be indented when this variable is set.
  1262. Note that this is all about true indentation, by adding and
  1263. removing space characters. See also `org-indent.el' which does
  1264. level-dependent indentation in a virtual way, i.e. at display
  1265. time in Emacs."
  1266. :group 'org-edit-structure
  1267. :type 'boolean)
  1268. (defcustom org-special-ctrl-a/e nil
  1269. "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
  1270. When t, `C-a' will bring back the cursor to the beginning of the
  1271. headline text, i.e. after the stars and after a possible TODO
  1272. keyword. In an item, this will be the position after bullet and
  1273. check-box, if any. When the cursor is already at that position,
  1274. another `C-a' will bring it to the beginning of the line.
  1275. `C-e' will jump to the end of the headline, ignoring the presence
  1276. of tags in the headline. A second `C-e' will then jump to the
  1277. true end of the line, after any tags. This also means that, when
  1278. this variable is non-nil, `C-e' also will never jump beyond the
  1279. end of the heading of a folded section, i.e. not after the
  1280. ellipses.
  1281. When set to the symbol `reversed', the first `C-a' or `C-e' works
  1282. normally, going to the true line boundary first. Only a directly
  1283. following, identical keypress will bring the cursor to the
  1284. special positions.
  1285. This may also be a cons cell where the behavior for `C-a' and
  1286. `C-e' is set separately."
  1287. :group 'org-edit-structure
  1288. :type '(choice
  1289. (const :tag "off" nil)
  1290. (const :tag "on: after stars/bullet and before tags first" t)
  1291. (const :tag "reversed: true line boundary first" reversed)
  1292. (cons :tag "Set C-a and C-e separately"
  1293. (choice :tag "Special C-a"
  1294. (const :tag "off" nil)
  1295. (const :tag "on: after stars/bullet first" t)
  1296. (const :tag "reversed: before stars/bullet first" reversed))
  1297. (choice :tag "Special C-e"
  1298. (const :tag "off" nil)
  1299. (const :tag "on: before tags first" t)
  1300. (const :tag "reversed: after tags first" reversed)))))
  1301. (defvaralias 'org-special-ctrl-a 'org-special-ctrl-a/e)
  1302. (defcustom org-special-ctrl-k nil
  1303. "Non-nil means `C-k' will behave specially in headlines.
  1304. When nil, `C-k' will call the default `kill-line' command.
  1305. When t, the following will happen while the cursor is in the headline:
  1306. - When the cursor is at the beginning of a headline, kill the entire
  1307. line and possible the folded subtree below the line.
  1308. - When in the middle of the headline text, kill the headline up to the tags.
  1309. - When after the headline text, kill the tags."
  1310. :group 'org-edit-structure
  1311. :type 'boolean)
  1312. (defcustom org-ctrl-k-protect-subtree nil
  1313. "Non-nil means, do not delete a hidden subtree with C-k.
  1314. When set to the symbol `error', simply throw an error when C-k is
  1315. used to kill (part-of) a headline that has hidden text behind it.
  1316. Any other non-nil value will result in a query to the user, if it is
  1317. OK to kill that hidden subtree. When nil, kill without remorse."
  1318. :group 'org-edit-structure
  1319. :version "24.1"
  1320. :type '(choice
  1321. (const :tag "Do not protect hidden subtrees" nil)
  1322. (const :tag "Protect hidden subtrees with a security query" t)
  1323. (const :tag "Never kill a hidden subtree with C-k" error)))
  1324. (defcustom org-special-ctrl-o t
  1325. "Non-nil means, make `C-o' insert a row in tables."
  1326. :group 'org-edit-structure
  1327. :type 'boolean)
  1328. (defcustom org-catch-invisible-edits nil
  1329. "Check if in invisible region before inserting or deleting a character.
  1330. Valid values are:
  1331. nil Do not check, so just do invisible edits.
  1332. error Throw an error and do nothing.
  1333. show Make point visible, and do the requested edit.
  1334. show-and-error Make point visible, then throw an error and abort the edit.
  1335. smart Make point visible, and do insertion/deletion if it is
  1336. adjacent to visible text and the change feels predictable.
  1337. Never delete a previously invisible character or add in the
  1338. middle or right after an invisible region. Basically, this
  1339. allows insertion and backward-delete right before ellipses.
  1340. FIXME: maybe in this case we should not even show?"
  1341. :group 'org-edit-structure
  1342. :version "24.1"
  1343. :type '(choice
  1344. (const :tag "Do not check" nil)
  1345. (const :tag "Throw error when trying to edit" error)
  1346. (const :tag "Unhide, but do not do the edit" show-and-error)
  1347. (const :tag "Show invisible part and do the edit" show)
  1348. (const :tag "Be smart and do the right thing" smart)))
  1349. (defcustom org-yank-folded-subtrees t
  1350. "Non-nil means when yanking subtrees, fold them.
  1351. If the kill is a single subtree, or a sequence of subtrees, i.e. if
  1352. it starts with a heading and all other headings in it are either children
  1353. or siblings, then fold all the subtrees. However, do this only if no
  1354. text after the yank would be swallowed into a folded tree by this action."
  1355. :group 'org-edit-structure
  1356. :type 'boolean)
  1357. (defcustom org-yank-adjusted-subtrees nil
  1358. "Non-nil means when yanking subtrees, adjust the level.
  1359. With this setting, `org-paste-subtree' is used to insert the subtree, see
  1360. this function for details."
  1361. :group 'org-edit-structure
  1362. :type 'boolean)
  1363. (defcustom org-M-RET-may-split-line '((default . t))
  1364. "Non-nil means M-RET will split the line at the cursor position.
  1365. When nil, it will go to the end of the line before making a
  1366. new line.
  1367. You may also set this option in a different way for different
  1368. contexts. Valid contexts are:
  1369. headline when creating a new headline
  1370. item when creating a new item
  1371. table in a table field
  1372. default the value to be used for all contexts not explicitly
  1373. customized"
  1374. :group 'org-structure
  1375. :group 'org-table
  1376. :type '(choice
  1377. (const :tag "Always" t)
  1378. (const :tag "Never" nil)
  1379. (repeat :greedy t :tag "Individual contexts"
  1380. (cons
  1381. (choice :tag "Context"
  1382. (const headline)
  1383. (const item)
  1384. (const table)
  1385. (const default))
  1386. (boolean)))))
  1387. (defcustom org-insert-heading-respect-content nil
  1388. "Non-nil means insert new headings after the current subtree.
  1389. \\<org-mode-map>
  1390. When nil, the new heading is created directly after the current line.
  1391. The commands `\\[org-insert-heading-respect-content]' and \
  1392. `\\[org-insert-todo-heading-respect-content]' turn this variable on
  1393. for the duration of the command."
  1394. :group 'org-structure
  1395. :type 'boolean)
  1396. (defcustom org-blank-before-new-entry '((heading . auto)
  1397. (plain-list-item . auto))
  1398. "Should `org-insert-heading' leave a blank line before new heading/item?
  1399. The value is an alist, with `heading' and `plain-list-item' as CAR,
  1400. and a boolean flag as CDR. The cdr may also be the symbol `auto', in
  1401. which case Org will look at the surrounding headings/items and try to
  1402. make an intelligent decision whether to insert a blank line or not."
  1403. :group 'org-edit-structure
  1404. :type '(list
  1405. (cons (const heading)
  1406. (choice (const :tag "Never" nil)
  1407. (const :tag "Always" t)
  1408. (const :tag "Auto" auto)))
  1409. (cons (const plain-list-item)
  1410. (choice (const :tag "Never" nil)
  1411. (const :tag "Always" t)
  1412. (const :tag "Auto" auto)))))
  1413. (defcustom org-insert-heading-hook nil
  1414. "Hook being run after inserting a new heading."
  1415. :group 'org-edit-structure
  1416. :type 'hook)
  1417. (defcustom org-enable-fixed-width-editor t
  1418. "Non-nil means lines starting with \":\" are treated as fixed-width.
  1419. This currently only means they are never auto-wrapped.
  1420. When nil, such lines will be treated like ordinary lines."
  1421. :group 'org-edit-structure
  1422. :type 'boolean)
  1423. (defcustom org-goto-auto-isearch t
  1424. "Non-nil means typing characters in `org-goto' starts incremental search.
  1425. When nil, you can use these keybindings to navigate the buffer:
  1426. q Quit the org-goto interface
  1427. n Go to the next visible heading
  1428. p Go to the previous visible heading
  1429. f Go one heading forward on same level
  1430. b Go one heading backward on same level
  1431. u Go one heading up"
  1432. :group 'org-edit-structure
  1433. :type 'boolean)
  1434. (defgroup org-sparse-trees nil
  1435. "Options concerning sparse trees in Org mode."
  1436. :tag "Org Sparse Trees"
  1437. :group 'org-structure)
  1438. (defcustom org-highlight-sparse-tree-matches t
  1439. "Non-nil means highlight all matches that define a sparse tree.
  1440. The highlights will automatically disappear the next time the buffer is
  1441. changed by an edit command."
  1442. :group 'org-sparse-trees
  1443. :type 'boolean)
  1444. (defcustom org-remove-highlights-with-change t
  1445. "Non-nil means any change to the buffer will remove temporary highlights.
  1446. \\<org-mode-map>\
  1447. Such highlights are created by `org-occur' and `org-clock-display'.
  1448. When nil, `\\[org-ctrl-c-ctrl-c]' needs to be used \
  1449. to get rid of the highlights.
  1450. The highlights created by `org-toggle-latex-fragment' always need
  1451. `\\[org-toggle-latex-fragment]' to be removed."
  1452. :group 'org-sparse-trees
  1453. :group 'org-time
  1454. :type 'boolean)
  1455. (defcustom org-occur-case-fold-search t
  1456. "Non-nil means `org-occur' should be case-insensitive.
  1457. If set to `smart' the search will be case-insensitive only if it
  1458. doesn't specify any upper case character."
  1459. :group 'org-sparse-trees
  1460. :version "25.2"
  1461. :type '(choice
  1462. (const :tag "Case-sensitive" nil)
  1463. (const :tag "Case-insensitive" t)
  1464. (const :tag "Case-insensitive for lower case searches only" 'smart)))
  1465. (defcustom org-occur-hook '(org-first-headline-recenter)
  1466. "Hook that is run after `org-occur' has constructed a sparse tree.
  1467. This can be used to recenter the window to show as much of the structure
  1468. as possible."
  1469. :group 'org-sparse-trees
  1470. :type 'hook)
  1471. (defgroup org-imenu-and-speedbar nil
  1472. "Options concerning imenu and speedbar in Org mode."
  1473. :tag "Org Imenu and Speedbar"
  1474. :group 'org-structure)
  1475. (defcustom org-imenu-depth 2
  1476. "The maximum level for Imenu access to Org headlines.
  1477. This also applied for speedbar access."
  1478. :group 'org-imenu-and-speedbar
  1479. :type 'integer)
  1480. (defgroup org-table nil
  1481. "Options concerning tables in Org mode."
  1482. :tag "Org Table"
  1483. :group 'org)
  1484. (defcustom org-enable-table-editor 'optimized
  1485. "Non-nil means lines starting with \"|\" are handled by the table editor.
  1486. When nil, such lines will be treated like ordinary lines.
  1487. When equal to the symbol `optimized', the table editor will be optimized to
  1488. do the following:
  1489. - Automatic overwrite mode in front of whitespace in table fields.
  1490. This makes the structure of the table stay in tact as long as the edited
  1491. field does not exceed the column width.
  1492. - Minimize the number of realigns. Normally, the table is aligned each time
  1493. TAB or RET are pressed to move to another field. With optimization this
  1494. happens only if changes to a field might have changed the column width.
  1495. Optimization requires replacing the functions `self-insert-command',
  1496. `delete-char', and `backward-delete-char' in Org buffers, with a
  1497. slight (in fact: unnoticeable) speed impact for normal typing. Org is very
  1498. good at guessing when a re-align will be necessary, but you can always
  1499. force one with `\\[org-ctrl-c-ctrl-c]'.
  1500. If you would like to use the optimized version in Org mode, but the
  1501. un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
  1502. This variable can be used to turn on and off the table editor during a session,
  1503. but in order to toggle optimization, a restart is required.
  1504. See also the variable `org-table-auto-blank-field'."
  1505. :group 'org-table
  1506. :type '(choice
  1507. (const :tag "off" nil)
  1508. (const :tag "on" t)
  1509. (const :tag "on, optimized" optimized)))
  1510. (defcustom org-self-insert-cluster-for-undo nil
  1511. "Non-nil means cluster self-insert commands for undo when possible.
  1512. If this is set, then, like in the Emacs command loop, 20 consecutive
  1513. characters will be undone together.
  1514. This is configurable, because there is some impact on typing performance."
  1515. :group 'org-table
  1516. :type 'boolean)
  1517. (defcustom org-table-tab-recognizes-table.el t
  1518. "Non-nil means TAB will automatically notice a table.el table.
  1519. When it sees such a table, it moves point into it and - if necessary -
  1520. calls `table-recognize-table'."
  1521. :group 'org-table-editing
  1522. :type 'boolean)
  1523. (defgroup org-link nil
  1524. "Options concerning links in Org mode."
  1525. :tag "Org Link"
  1526. :group 'org)
  1527. (defvar-local org-link-abbrev-alist-local nil
  1528. "Buffer-local version of `org-link-abbrev-alist', which see.
  1529. The value of this is taken from the #+LINK lines.")
  1530. (defcustom org-link-parameters
  1531. '(("doi" :follow org--open-doi-link)
  1532. ("elisp" :follow org--open-elisp-link)
  1533. ("file" :complete org-file-complete-link)
  1534. ("ftp" :follow (lambda (path) (browse-url (concat "ftp:" path))))
  1535. ("help" :follow org--open-help-link)
  1536. ("http" :follow (lambda (path) (browse-url (concat "http:" path))))
  1537. ("https" :follow (lambda (path) (browse-url (concat "https:" path))))
  1538. ("mailto" :follow (lambda (path) (browse-url (concat "mailto:" path))))
  1539. ("message" :follow (lambda (path) (browse-url (concat "message:" path))))
  1540. ("news" :follow (lambda (path) (browse-url (concat "news:" path))))
  1541. ("shell" :follow org--open-shell-link))
  1542. "An alist of properties that defines all the links in Org mode.
  1543. The key in each association is a string of the link type.
  1544. Subsequent optional elements make up a p-list of link properties.
  1545. :follow - A function that takes the link path as an argument.
  1546. :export - A function that takes the link path, description and
  1547. export-backend as arguments.
  1548. :store - A function responsible for storing the link. See the
  1549. function `org-store-link-functions'.
  1550. :complete - A function that inserts a link with completion. The
  1551. function takes one optional prefix arg.
  1552. :face - A face for the link, or a function that returns a face.
  1553. The function takes one argument which is the link path. The
  1554. default face is `org-link'.
  1555. :mouse-face - The mouse-face. The default is `highlight'.
  1556. :display - `full' will not fold the link in descriptive
  1557. display. Default is `org-link'.
  1558. :help-echo - A string or function that takes (window object position)
  1559. as arguments and returns a string.
  1560. :keymap - A keymap that is active on the link. The default is
  1561. `org-mouse-map'.
  1562. :htmlize-link - A function for the htmlize-link. Defaults
  1563. to (list :uri \"type:path\")
  1564. :activate-func - A function to run at the end of font-lock
  1565. activation. The function must accept (link-start link-end path bracketp)
  1566. as arguments."
  1567. :group 'org-link
  1568. :type '(alist :tag "Link display parameters"
  1569. :value-type plist))
  1570. (defun org-link-get-parameter (type key)
  1571. "Get TYPE link property for KEY.
  1572. TYPE is a string and KEY is a plist keyword."
  1573. (plist-get
  1574. (cdr (assoc type org-link-parameters))
  1575. key))
  1576. (defun org-link-set-parameters (type &rest parameters)
  1577. "Set link TYPE properties to PARAMETERS.
  1578. PARAMETERS should be :key val pairs."
  1579. (let ((data (assoc type org-link-parameters)))
  1580. (if data (setcdr data (org-combine-plists (cdr data) parameters))
  1581. (push (cons type parameters) org-link-parameters)
  1582. (org-make-link-regexps)
  1583. (org-element-update-syntax))))
  1584. (defun org-link-types ()
  1585. "Return a list of known link types."
  1586. (mapcar #'car org-link-parameters))
  1587. (defcustom org-link-abbrev-alist nil
  1588. "Alist of link abbreviations.
  1589. The car of each element is a string, to be replaced at the start of a link.
  1590. The cdrs are replacement values, like (\"linkkey\" . REPLACE). Abbreviated
  1591. links in Org buffers can have an optional tag after a double colon, e.g.,
  1592. [[linkkey:tag][description]]
  1593. The `linkkey' must be a single word, starting with a letter, followed
  1594. by letters, numbers, `-' or `_'.
  1595. If REPLACE is a string, the tag will simply be appended to create the link.
  1596. If the string contains \"%s\", the tag will be inserted there. If the string
  1597. contains \"%h\", it will cause a url-encoded version of the tag to be inserted
  1598. at that point (see the function `url-hexify-string'). If the string contains
  1599. the specifier \"%(my-function)\", then the custom function `my-function' will
  1600. be invoked: this function takes the tag as its only argument and must return
  1601. a string.
  1602. REPLACE may also be a function that will be called with the tag as the
  1603. only argument to create the link, which should be returned as a string.
  1604. See the manual for examples."
  1605. :group 'org-link
  1606. :type '(repeat
  1607. (cons
  1608. (string :tag "Protocol")
  1609. (choice
  1610. (string :tag "Format")
  1611. (function)))))
  1612. (defcustom org-descriptive-links t
  1613. "Non-nil means Org will display descriptive links.
  1614. E.g. [[http://orgmode.org][Org website]] will be displayed as
  1615. \"Org Website\", hiding the link itself and just displaying its
  1616. description. When set to nil, Org will display the full links
  1617. literally.
  1618. You can interactively set the value of this variable by calling
  1619. `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
  1620. :group 'org-link
  1621. :type 'boolean)
  1622. (defcustom org-link-file-path-type 'adaptive
  1623. "How the path name in file links should be stored.
  1624. Valid values are:
  1625. relative Relative to the current directory, i.e. the directory of the file
  1626. into which the link is being inserted.
  1627. absolute Absolute path, if possible with ~ for home directory.
  1628. noabbrev Absolute path, no abbreviation of home directory.
  1629. adaptive Use relative path for files in the current directory and sub-
  1630. directories of it. For other files, use an absolute path."
  1631. :group 'org-link
  1632. :type '(choice
  1633. (const relative)
  1634. (const absolute)
  1635. (const noabbrev)
  1636. (const adaptive)))
  1637. (defvaralias 'org-activate-links 'org-highlight-links)
  1638. (defcustom org-highlight-links '(bracket angle plain radio tag date footnote)
  1639. "Types of links that should be highlighted in Org files.
  1640. This is a list of symbols, each one of them leading to the
  1641. highlighting of a certain link type.
  1642. You can still open links that are not highlighted.
  1643. In principle, it does not hurt to turn on highlighting for all
  1644. link types. There may be a small gain when turning off unused
  1645. link types. The types are:
  1646. bracket The recommended [[link][description]] or [[link]] links with hiding.
  1647. angle Links in angular brackets that may contain whitespace like
  1648. <bbdb:Carsten Dominik>.
  1649. plain Plain links in normal text, no whitespace, like http://google.com.
  1650. radio Text that is matched by a radio target, see manual for details.
  1651. tag Tag settings in a headline (link to tag search).
  1652. date Time stamps (link to calendar).
  1653. footnote Footnote labels.
  1654. If you set this variable during an Emacs session, use `org-mode-restart'
  1655. in the Org buffer so that the change takes effect."
  1656. :group 'org-link
  1657. :group 'org-appearance
  1658. :type '(set :greedy t
  1659. (const :tag "Double bracket links" bracket)
  1660. (const :tag "Angular bracket links" angle)
  1661. (const :tag "Plain text links" plain)
  1662. (const :tag "Radio target matches" radio)
  1663. (const :tag "Tags" tag)
  1664. (const :tag "Timestamps" date)
  1665. (const :tag "Footnotes" footnote)))
  1666. (defcustom org-make-link-description-function nil
  1667. "Function to use for generating link descriptions from links.
  1668. When nil, the link location will be used. This function must take
  1669. two parameters: the first one is the link, the second one is the
  1670. description generated by `org-insert-link'. The function should
  1671. return the description to use."
  1672. :group 'org-link
  1673. :type '(choice (const nil) (function)))
  1674. (defgroup org-link-store nil
  1675. "Options concerning storing links in Org mode."
  1676. :tag "Org Store Link"
  1677. :group 'org-link)
  1678. (defcustom org-url-hexify-p t
  1679. "When non-nil, hexify URL when creating a link."
  1680. :type 'boolean
  1681. :version "24.3"
  1682. :group 'org-link-store)
  1683. (defcustom org-email-link-description-format "Email %c: %.30s"
  1684. "Format of the description part of a link to an email or usenet message.
  1685. The following %-escapes will be replaced by corresponding information:
  1686. %F full \"From\" field
  1687. %f name, taken from \"From\" field, address if no name
  1688. %T full \"To\" field
  1689. %t first name in \"To\" field, address if no name
  1690. %c correspondent. Usually \"from NAME\", but if you sent it yourself, it
  1691. will be \"to NAME\". See also the variable `org-from-is-user-regexp'.
  1692. %s subject
  1693. %d date
  1694. %m message-id.
  1695. You may use normal field width specification between the % and the letter.
  1696. This is for example useful to limit the length of the subject.
  1697. Examples: \"%f on: %.30s\", \"Email from %f\", \"Email %c\""
  1698. :group 'org-link-store
  1699. :type 'string)
  1700. (defcustom org-from-is-user-regexp
  1701. (let (r1 r2)
  1702. (when (and user-mail-address (not (string= user-mail-address "")))
  1703. (setq r1 (concat "\\<" (regexp-quote user-mail-address) "\\>")))
  1704. (when (and user-full-name (not (string= user-full-name "")))
  1705. (setq r2 (concat "\\<" (regexp-quote user-full-name) "\\>")))
  1706. (if (and r1 r2) (concat r1 "\\|" r2) (or r1 r2)))
  1707. "Regexp matched against the \"From:\" header of an email or usenet message.
  1708. It should match if the message is from the user him/herself."
  1709. :group 'org-link-store
  1710. :type 'regexp)
  1711. (defcustom org-context-in-file-links t
  1712. "Non-nil means file links from `org-store-link' contain context.
  1713. \\<org-mode-map>
  1714. A search string will be added to the file name with :: as separator
  1715. and used to find the context when the link is activated by the command
  1716. `org-open-at-point'. When this option is t, the entire active region
  1717. will be placed in the search string of the file link. If set to a
  1718. positive integer, only the first n lines of context will be stored.
  1719. Using a prefix arg to the command `org-store-link' (`\\[universal-argument] \
  1720. \\[org-store-link]')
  1721. negates this setting for the duration of the command."
  1722. :group 'org-link-store
  1723. :type '(choice boolean integer))
  1724. (defcustom org-keep-stored-link-after-insertion nil
  1725. "Non-nil means keep link in list for entire session.
  1726. \\<org-mode-map>
  1727. The command `org-store-link' adds a link pointing to the current
  1728. location to an internal list. These links accumulate during a session.
  1729. The command `org-insert-link' can be used to insert links into any
  1730. Org file (offering completion for all stored links).
  1731. When this option is nil, every link which has been inserted once using
  1732. `\\[org-insert-link]' will be removed from the list, to make completing the \
  1733. unused
  1734. links more efficient."
  1735. :group 'org-link-store
  1736. :type 'boolean)
  1737. (defgroup org-link-follow nil
  1738. "Options concerning following links in Org mode."
  1739. :tag "Org Follow Link"
  1740. :group 'org-link)
  1741. (defcustom org-link-translation-function nil
  1742. "Function to translate links with different syntax to Org syntax.
  1743. This can be used to translate links created for example by the Planner
  1744. or emacs-wiki packages to Org syntax.
  1745. The function must accept two parameters, a TYPE containing the link
  1746. protocol name like \"rmail\" or \"gnus\" as a string, and the linked path,
  1747. which is everything after the link protocol. It should return a cons
  1748. with possibly modified values of type and path.
  1749. Org contains a function for this, so if you set this variable to
  1750. `org-translate-link-from-planner', you should be able follow many
  1751. links created by planner."
  1752. :group 'org-link-follow
  1753. :type '(choice (const nil) (function)))
  1754. (defcustom org-follow-link-hook nil
  1755. "Hook that is run after a link has been followed."
  1756. :group 'org-link-follow
  1757. :type 'hook)
  1758. (defcustom org-tab-follows-link nil
  1759. "Non-nil means on links TAB will follow the link.
  1760. Needs to be set before org.el is loaded.
  1761. This really should not be used, it does not make sense, and the
  1762. implementation is bad."
  1763. :group 'org-link-follow
  1764. :type 'boolean)
  1765. (defcustom org-return-follows-link nil
  1766. "Non-nil means on links RET will follow the link.
  1767. In tables, the special behavior of RET has precedence."
  1768. :group 'org-link-follow
  1769. :type 'boolean)
  1770. (defcustom org-mouse-1-follows-link
  1771. (if (boundp 'mouse-1-click-follows-link) mouse-1-click-follows-link t)
  1772. "Non-nil means mouse-1 on a link will follow the link.
  1773. A longer mouse click will still set point. Needs to be set
  1774. before org.el is loaded."
  1775. :group 'org-link-follow
  1776. :version "24.4"
  1777. :package-version '(Org . "8.3")
  1778. :type '(choice
  1779. (const :tag "A double click follows the link" double)
  1780. (const :tag "Unconditionally follow the link with mouse-1" t)
  1781. (integer :tag "mouse-1 click does not follow the link if longer than N ms" 450)))
  1782. (defcustom org-mark-ring-length 4
  1783. "Number of different positions to be recorded in the ring.
  1784. Changing this requires a restart of Emacs to work correctly."
  1785. :group 'org-link-follow
  1786. :type 'integer)
  1787. (defcustom org-link-search-must-match-exact-headline 'query-to-create
  1788. "Non-nil means internal fuzzy links can only match headlines.
  1789. When nil, the a fuzzy link may point to a target or a named
  1790. construct in the document. When set to the special value
  1791. `query-to-create', offer to create a new headline when none
  1792. matched.
  1793. Spaces and statistics cookies are ignored during heading searches."
  1794. :group 'org-link-follow
  1795. :version "24.1"
  1796. :type '(choice
  1797. (const :tag "Use fuzzy text search" nil)
  1798. (const :tag "Match only exact headline" t)
  1799. (const :tag "Match exact headline or query to create it"
  1800. query-to-create))
  1801. :safe #'symbolp)
  1802. (defcustom org-link-frame-setup
  1803. '((vm . vm-visit-folder-other-frame)
  1804. (vm-imap . vm-visit-imap-folder-other-frame)
  1805. (gnus . org-gnus-no-new-news)
  1806. (file . find-file-other-window)
  1807. (wl . wl-other-frame))
  1808. "Setup the frame configuration for following links.
  1809. When following a link with Emacs, it may often be useful to display
  1810. this link in another window or frame. This variable can be used to
  1811. set this up for the different types of links.
  1812. For VM, use any of
  1813. `vm-visit-folder'
  1814. `vm-visit-folder-other-window'
  1815. `vm-visit-folder-other-frame'
  1816. For Gnus, use any of
  1817. `gnus'
  1818. `gnus-other-frame'
  1819. `org-gnus-no-new-news'
  1820. For FILE, use any of
  1821. `find-file'
  1822. `find-file-other-window'
  1823. `find-file-other-frame'
  1824. For Wanderlust use any of
  1825. `wl'
  1826. `wl-other-frame'
  1827. For the calendar, use the variable `calendar-setup'.
  1828. For BBDB, it is currently only possible to display the matches in
  1829. another window."
  1830. :group 'org-link-follow
  1831. :type '(list
  1832. (cons (const vm)
  1833. (choice
  1834. (const vm-visit-folder)
  1835. (const vm-visit-folder-other-window)
  1836. (const vm-visit-folder-other-frame)))
  1837. (cons (const vm-imap)
  1838. (choice
  1839. (const vm-visit-imap-folder)
  1840. (const vm-visit-imap-folder-other-window)
  1841. (const vm-visit-imap-folder-other-frame)))
  1842. (cons (const gnus)
  1843. (choice
  1844. (const gnus)
  1845. (const gnus-other-frame)
  1846. (const org-gnus-no-new-news)))
  1847. (cons (const file)
  1848. (choice
  1849. (const find-file)
  1850. (const find-file-other-window)
  1851. (const find-file-other-frame)))
  1852. (cons (const wl)
  1853. (choice
  1854. (const wl)
  1855. (const wl-other-frame)))))
  1856. (defcustom org-display-internal-link-with-indirect-buffer nil
  1857. "Non-nil means use indirect buffer to display infile links.
  1858. Activating internal links (from one location in a file to another location
  1859. in the same file) normally just jumps to the location. When the link is
  1860. activated with a `\\[universal-argument]' prefix (or with mouse-3), the link \
  1861. is displayed in
  1862. another window. When this option is set, the other window actually displays
  1863. an indirect buffer clone of the current buffer, to avoid any visibility
  1864. changes to the current buffer."
  1865. :group 'org-link-follow
  1866. :type 'boolean)
  1867. (defcustom org-open-non-existing-files nil
  1868. "Non-nil means `org-open-file' will open non-existing files.
  1869. When nil, an error will be generated.
  1870. This variable applies only to external applications because they
  1871. might choke on non-existing files. If the link is to a file that
  1872. will be opened in Emacs, the variable is ignored."
  1873. :group 'org-link-follow
  1874. :type 'boolean)
  1875. (defcustom org-open-directory-means-index-dot-org nil
  1876. "Non-nil means a link to a directory really means to index.org.
  1877. When nil, following a directory link will run dired or open a finder/explorer
  1878. window on that directory."
  1879. :group 'org-link-follow
  1880. :type 'boolean)
  1881. (defcustom org-confirm-shell-link-function 'yes-or-no-p
  1882. "Non-nil means ask for confirmation before executing shell links.
  1883. Shell links can be dangerous: just think about a link
  1884. [[shell:rm -rf ~/*][Google Search]]
  1885. This link would show up in your Org document as \"Google Search\",
  1886. but really it would remove your entire home directory.
  1887. Therefore we advise against setting this variable to nil.
  1888. Just change it to `y-or-n-p' if you want to confirm with a
  1889. single keystroke rather than having to type \"yes\"."
  1890. :group 'org-link-follow
  1891. :type '(choice
  1892. (const :tag "with yes-or-no (safer)" yes-or-no-p)
  1893. (const :tag "with y-or-n (faster)" y-or-n-p)
  1894. (const :tag "no confirmation (dangerous)" nil)))
  1895. (put 'org-confirm-shell-link-function
  1896. 'safe-local-variable
  1897. (lambda (x) (member x '(yes-or-no-p y-or-n-p))))
  1898. (defcustom org-confirm-shell-link-not-regexp ""
  1899. "A regexp to skip confirmation for shell links."
  1900. :group 'org-link-follow
  1901. :version "24.1"
  1902. :type 'regexp)
  1903. (defcustom org-confirm-elisp-link-function 'yes-or-no-p
  1904. "Non-nil means ask for confirmation before executing Emacs Lisp links.
  1905. Elisp links can be dangerous: just think about a link
  1906. [[elisp:(shell-command \"rm -rf ~/*\")][Google Search]]
  1907. This link would show up in your Org document as \"Google Search\",
  1908. but really it would remove your entire home directory.
  1909. Therefore we advise against setting this variable to nil.
  1910. Just change it to `y-or-n-p' if you want to confirm with a
  1911. single keystroke rather than having to type \"yes\"."
  1912. :group 'org-link-follow
  1913. :type '(choice
  1914. (const :tag "with yes-or-no (safer)" yes-or-no-p)
  1915. (const :tag "with y-or-n (faster)" y-or-n-p)
  1916. (const :tag "no confirmation (dangerous)" nil)))
  1917. (put 'org-confirm-shell-link-function
  1918. 'safe-local-variable
  1919. (lambda (x) (member x '(yes-or-no-p y-or-n-p))))
  1920. (defcustom org-confirm-elisp-link-not-regexp ""
  1921. "A regexp to skip confirmation for Elisp links."
  1922. :group 'org-link-follow
  1923. :version "24.1"
  1924. :type 'regexp)
  1925. (defconst org-file-apps-defaults-gnu
  1926. '((remote . emacs)
  1927. (system . mailcap)
  1928. (t . mailcap))
  1929. "Default file applications on a UNIX or GNU/Linux system.
  1930. See `org-file-apps'.")
  1931. (defconst org-file-apps-defaults-macosx
  1932. '((remote . emacs)
  1933. (system . "open %s")
  1934. ("ps.gz" . "gv %s")
  1935. ("eps.gz" . "gv %s")
  1936. ("dvi" . "xdvi %s")
  1937. ("fig" . "xfig %s")
  1938. (t . "open %s"))
  1939. "Default file applications on a macOS system.
  1940. The system \"open\" is known as a default, but we use X11 applications
  1941. for some files for which the OS does not have a good default.
  1942. See `org-file-apps'.")
  1943. (defconst org-file-apps-defaults-windowsnt
  1944. (list '(remote . emacs)
  1945. (cons 'system (lambda (file _path)
  1946. (with-no-warnings (w32-shell-execute "open" file))))
  1947. (cons t (lambda (file _path)
  1948. (with-no-warnings (w32-shell-execute "open" file)))))
  1949. "Default file applications on a Windows NT system.
  1950. The system \"open\" is used for most files.
  1951. See `org-file-apps'.")
  1952. (defcustom org-file-apps
  1953. '((auto-mode . emacs)
  1954. ("\\.mm\\'" . default)
  1955. ("\\.x?html?\\'" . default)
  1956. ("\\.pdf\\'" . default))
  1957. "External applications for opening `file:path' items in a document.
  1958. \\<org-mode-map>\
  1959. Org mode uses system defaults for different file types, but
  1960. you can use this variable to set the application for a given file
  1961. extension. The entries in this list are cons cells where the car identifies
  1962. files and the cdr the corresponding command.
  1963. Possible values for the file identifier are:
  1964. \"string\" A string as a file identifier can be interpreted in different
  1965. ways, depending on its contents:
  1966. - Alphanumeric characters only:
  1967. Match links with this file extension.
  1968. Example: (\"pdf\" . \"evince %s\")
  1969. to open PDFs with evince.
  1970. - Regular expression: Match links where the
  1971. filename matches the regexp. If you want to
  1972. use groups here, use shy groups.
  1973. Example: (\"\\\\.x?html\\\\\\='\" . \"firefox %s\")
  1974. (\"\\\\(?:xhtml\\\\|html\\\\)\\\\\\='\" . \"firefox %s\")
  1975. to open *.html and *.xhtml with firefox.
  1976. - Regular expression which contains (non-shy) groups:
  1977. Match links where the whole link, including \"::\", and
  1978. anything after that, matches the regexp.
  1979. In a custom command string, %1, %2, etc. are replaced with
  1980. the parts of the link that were matched by the groups.
  1981. For backwards compatibility, if a command string is given
  1982. that does not use any of the group matches, this case is
  1983. handled identically to the second one (i.e. match against
  1984. file name only).
  1985. In a custom function, you can access the group matches with
  1986. (match-string n link).
  1987. Example: (\"\\\\.pdf::\\\\(\\\\d+\\\\)\\\\\\='\" . \
  1988. \"evince -p %1 %s\")
  1989. to open [[file:document.pdf::5]] with evince at page 5.
  1990. `directory' Matches a directory
  1991. `remote' Matches a remote file, accessible through tramp or efs.
  1992. Remote files most likely should be visited through Emacs
  1993. because external applications cannot handle such paths.
  1994. `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
  1995. so all files Emacs knows how to handle. Using this with
  1996. command `emacs' will open most files in Emacs. Beware that this
  1997. will also open html files inside Emacs, unless you add
  1998. (\"html\" . default) to the list as well.
  1999. `system' The system command to open files, like `open' on Windows
  2000. and macOS, and mailcap under GNU/Linux. This is the command
  2001. that will be selected if you call `org-open-at-point' with a
  2002. double prefix argument (`\\[universal-argument] \
  2003. \\[universal-argument] \\[org-open-at-point]').
  2004. t Default for files not matched by any of the other options.
  2005. Possible values for the command are:
  2006. `emacs' The file will be visited by the current Emacs process.
  2007. `default' Use the default application for this file type, which is the
  2008. association for t in the list, most likely in the system-specific
  2009. part. This can be used to overrule an unwanted setting in the
  2010. system-specific variable.
  2011. `system' Use the system command for opening files, like \"open\".
  2012. This command is specified by the entry whose car is `system'.
  2013. Most likely, the system-specific version of this variable
  2014. does define this command, but you can overrule/replace it
  2015. here.
  2016. `mailcap' Use command specified in the mailcaps.
  2017. string A command to be executed by a shell; %s will be replaced
  2018. by the path to the file.
  2019. function A Lisp function, which will be called with two arguments:
  2020. the file path and the original link string, without the
  2021. \"file:\" prefix.
  2022. For more examples, see the system specific constants
  2023. `org-file-apps-defaults-macosx'
  2024. `org-file-apps-defaults-windowsnt'
  2025. `org-file-apps-defaults-gnu'."
  2026. :group 'org-link-follow
  2027. :type '(repeat
  2028. (cons (choice :value ""
  2029. (string :tag "Extension")
  2030. (const :tag "System command to open files" system)
  2031. (const :tag "Default for unrecognized files" t)
  2032. (const :tag "Remote file" remote)
  2033. (const :tag "Links to a directory" directory)
  2034. (const :tag "Any files that have Emacs modes"
  2035. auto-mode))
  2036. (choice :value ""
  2037. (const :tag "Visit with Emacs" emacs)
  2038. (const :tag "Use default" default)
  2039. (const :tag "Use the system command" system)
  2040. (string :tag "Command")
  2041. (function :tag "Function")))))
  2042. (defcustom org-doi-server-url "http://dx.doi.org/"
  2043. "The URL of the DOI server."
  2044. :type 'string
  2045. :version "24.3"
  2046. :group 'org-link-follow)
  2047. (defgroup org-refile nil
  2048. "Options concerning refiling entries in Org mode."
  2049. :tag "Org Refile"
  2050. :group 'org)
  2051. (defcustom org-directory "~/org"
  2052. "Directory with Org files.
  2053. This is just a default location to look for Org files. There is no need
  2054. at all to put your files into this directory. It is used in the
  2055. following situations:
  2056. 1. When a capture template specifies a target file that is not an
  2057. absolute path. The path will then be interpreted relative to
  2058. `org-directory'
  2059. 2. When the value of variable `org-agenda-files' is a single file, any
  2060. relative paths in this file will be taken as relative to
  2061. `org-directory'."
  2062. :group 'org-refile
  2063. :group 'org-capture
  2064. :type 'directory)
  2065. (defcustom org-default-notes-file (convert-standard-filename "~/.notes")
  2066. "Default target for storing notes.
  2067. Used as a fall back file for org-capture.el, for templates that
  2068. do not specify a target file."
  2069. :group 'org-refile
  2070. :group 'org-capture
  2071. :type 'file)
  2072. (defcustom org-goto-interface 'outline
  2073. "The default interface to be used for `org-goto'.
  2074. Allowed values are:
  2075. outline The interface shows an outline of the relevant file
  2076. and the correct heading is found by moving through
  2077. the outline or by searching with incremental search.
  2078. outline-path-completion Headlines in the current buffer are offered via
  2079. completion. This is the interface also used by
  2080. the refile command."
  2081. :group 'org-refile
  2082. :type '(choice
  2083. (const :tag "Outline" outline)
  2084. (const :tag "Outline-path-completion" outline-path-completion)))
  2085. (defcustom org-goto-max-level 5
  2086. "Maximum target level when running `org-goto' with refile interface."
  2087. :group 'org-refile
  2088. :type 'integer)
  2089. (defcustom org-reverse-note-order nil
  2090. "Non-nil means store new notes at the beginning of a file or entry.
  2091. When nil, new notes will be filed to the end of a file or entry.
  2092. This can also be a list with cons cells of regular expressions that
  2093. are matched against file names, and values."
  2094. :group 'org-capture
  2095. :group 'org-refile
  2096. :type '(choice
  2097. (const :tag "Reverse always" t)
  2098. (const :tag "Reverse never" nil)
  2099. (repeat :tag "By file name regexp"
  2100. (cons regexp boolean))))
  2101. (defcustom org-log-refile nil
  2102. "Information to record when a task is refiled.
  2103. Possible values are:
  2104. nil Don't add anything
  2105. time Add a time stamp to the task
  2106. note Prompt for a note and add it with template `org-log-note-headings'
  2107. This option can also be set with on a per-file-basis with
  2108. #+STARTUP: nologrefile
  2109. #+STARTUP: logrefile
  2110. #+STARTUP: lognoterefile
  2111. You can have local logging settings for a subtree by setting the LOGGING
  2112. property to one or more of these keywords.
  2113. When bulk-refiling from the agenda, the value `note' is forbidden and
  2114. will temporarily be changed to `time'."
  2115. :group 'org-refile
  2116. :group 'org-progress
  2117. :version "24.1"
  2118. :type '(choice
  2119. (const :tag "No logging" nil)
  2120. (const :tag "Record timestamp" time)
  2121. (const :tag "Record timestamp with note." note)))
  2122. (defcustom org-refile-targets nil
  2123. "Targets for refiling entries with `\\[org-refile]'.
  2124. This is a list of cons cells. Each cell contains:
  2125. - a specification of the files to be considered, either a list of files,
  2126. or a symbol whose function or variable value will be used to retrieve
  2127. a file name or a list of file names. If you use `org-agenda-files' for
  2128. that, all agenda files will be scanned for targets. Nil means consider
  2129. headings in the current buffer.
  2130. - A specification of how to find candidate refile targets. This may be
  2131. any of:
  2132. - a cons cell (:tag . \"TAG\") to identify refile targets by a tag.
  2133. This tag has to be present in all target headlines, inheritance will
  2134. not be considered.
  2135. - a cons cell (:todo . \"KEYWORD\") to identify refile targets by
  2136. todo keyword.
  2137. - a cons cell (:regexp . \"REGEXP\") with a regular expression matching
  2138. headlines that are refiling targets.
  2139. - a cons cell (:level . N). Any headline of level N is considered a target.
  2140. Note that, when `org-odd-levels-only' is set, level corresponds to
  2141. order in hierarchy, not to the number of stars.
  2142. - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
  2143. Note that, when `org-odd-levels-only' is set, level corresponds to
  2144. order in hierarchy, not to the number of stars.
  2145. Each element of this list generates a set of possible targets.
  2146. The union of these sets is presented (with completion) to
  2147. the user by `org-refile'.
  2148. You can set the variable `org-refile-target-verify-function' to a function
  2149. to verify each headline found by the simple criteria above.
  2150. When this variable is nil, all top-level headlines in the current buffer
  2151. are used, equivalent to the value `((nil . (:level . 1))'."
  2152. :group 'org-refile
  2153. :type '(repeat
  2154. (cons
  2155. (choice :value org-agenda-files
  2156. (const :tag "All agenda files" org-agenda-files)
  2157. (const :tag "Current buffer" nil)
  2158. (function) (variable) (file))
  2159. (choice :tag "Identify target headline by"
  2160. (cons :tag "Specific tag" (const :value :tag) (string))
  2161. (cons :tag "TODO keyword" (const :value :todo) (string))
  2162. (cons :tag "Regular expression" (const :value :regexp) (regexp))
  2163. (cons :tag "Level number" (const :value :level) (integer))
  2164. (cons :tag "Max Level number" (const :value :maxlevel) (integer))))))
  2165. (defcustom org-refile-target-verify-function nil
  2166. "Function to verify if the headline at point should be a refile target.
  2167. The function will be called without arguments, with point at the
  2168. beginning of the headline. It should return t and leave point
  2169. where it is if the headline is a valid target for refiling.
  2170. If the target should not be selected, the function must return nil.
  2171. In addition to this, it may move point to a place from where the search
  2172. should be continued. For example, the function may decide that the entire
  2173. subtree of the current entry should be excluded and move point to the end
  2174. of the subtree."
  2175. :group 'org-refile
  2176. :type '(choice
  2177. (const nil)
  2178. (function)))
  2179. (defcustom org-refile-use-cache nil
  2180. "Non-nil means cache refile targets to speed up the process.
  2181. \\<org-mode-map>\
  2182. The cache for a particular file will be updated automatically when
  2183. the buffer has been killed, or when any of the marker used for flagging
  2184. refile targets no longer points at a live buffer.
  2185. If you have added new entries to a buffer that might themselves be targets,
  2186. you need to clear the cache manually by pressing `C-0 \\[org-refile]' or,
  2187. if you find that easier, \
  2188. `\\[universal-argument] \\[universal-argument] \\[universal-argument] \
  2189. \\[org-refile]'."
  2190. :group 'org-refile
  2191. :version "24.1"
  2192. :type 'boolean)
  2193. (defcustom org-refile-use-outline-path nil
  2194. "Non-nil means provide refile targets as paths.
  2195. So a level 3 headline will be available as level1/level2/level3.
  2196. When the value is `file', also include the file name (without directory)
  2197. into the path. In this case, you can also stop the completion after
  2198. the file name, to get entries inserted as top level in the file.
  2199. When `full-file-path', include the full file path."
  2200. :group 'org-refile
  2201. :type '(choice
  2202. (const :tag "Not" nil)
  2203. (const :tag "Yes" t)
  2204. (const :tag "Start with file name" file)
  2205. (const :tag "Start with full file path" full-file-path)))
  2206. (defcustom org-outline-path-complete-in-steps t
  2207. "Non-nil means complete the outline path in hierarchical steps.
  2208. When Org uses the refile interface to select an outline path (see
  2209. `org-refile-use-outline-path'), the completion of the path can be
  2210. done in a single go, or it can be done in steps down the headline
  2211. hierarchy. Going in steps is probably the best if you do not use
  2212. a special completion package like `ido' or `icicles'. However,
  2213. when using these packages, going in one step can be very fast,
  2214. while still showing the whole path to the entry."
  2215. :group 'org-refile
  2216. :type 'boolean)
  2217. (defcustom org-refile-allow-creating-parent-nodes nil
  2218. "Non-nil means allow the creation of new nodes as refile targets.
  2219. New nodes are then created by adding \"/new node name\" to the completion
  2220. of an existing node. When the value of this variable is `confirm',
  2221. new node creation must be confirmed by the user (recommended).
  2222. When nil, the completion must match an existing entry.
  2223. Note that, if the new heading is not seen by the criteria
  2224. listed in `org-refile-targets', multiple instances of the same
  2225. heading would be created by trying again to file under the new
  2226. heading."
  2227. :group 'org-refile
  2228. :type '(choice
  2229. (const :tag "Never" nil)
  2230. (const :tag "Always" t)
  2231. (const :tag "Prompt for confirmation" confirm)))
  2232. (defcustom org-refile-active-region-within-subtree nil
  2233. "Non-nil means also refile active region within a subtree.
  2234. By default `org-refile' doesn't allow refiling regions if they
  2235. don't contain a set of subtrees, but it might be convenient to
  2236. do so sometimes: in that case, the first line of the region is
  2237. converted to a headline before refiling."
  2238. :group 'org-refile
  2239. :version "24.1"
  2240. :type 'boolean)
  2241. (defgroup org-todo nil
  2242. "Options concerning TODO items in Org mode."
  2243. :tag "Org TODO"
  2244. :group 'org)
  2245. (defgroup org-progress nil
  2246. "Options concerning Progress logging in Org mode."
  2247. :tag "Org Progress"
  2248. :group 'org-time)
  2249. (defvar org-todo-interpretation-widgets
  2250. '((:tag "Sequence (cycling hits every state)" sequence)
  2251. (:tag "Type (cycling directly to DONE)" type))
  2252. "The available interpretation symbols for customizing `org-todo-keywords'.
  2253. Interested libraries should add to this list.")
  2254. (defcustom org-todo-keywords '((sequence "TODO" "DONE"))
  2255. "List of TODO entry keyword sequences and their interpretation.
  2256. \\<org-mode-map>This is a list of sequences.
  2257. Each sequence starts with a symbol, either `sequence' or `type',
  2258. indicating if the keywords should be interpreted as a sequence of
  2259. action steps, or as different types of TODO items. The first
  2260. keywords are states requiring action - these states will select a headline
  2261. for inclusion into the global TODO list Org produces. If one of the
  2262. \"keywords\" is the vertical bar, \"|\", the remaining keywords
  2263. signify that no further action is necessary. If \"|\" is not found,
  2264. the last keyword is treated as the only DONE state of the sequence.
  2265. The command `\\[org-todo]' cycles an entry through these states, and one
  2266. additional state where no keyword is present. For details about this
  2267. cycling, see the manual.
  2268. TODO keywords and interpretation can also be set on a per-file basis with
  2269. the special #+SEQ_TODO and #+TYP_TODO lines.
  2270. Each keyword can optionally specify a character for fast state selection
  2271. \(in combination with the variable `org-use-fast-todo-selection')
  2272. and specifiers for state change logging, using the same syntax that
  2273. is used in the \"#+TODO:\" lines. For example, \"WAIT(w)\" says that
  2274. the WAIT state can be selected with the \"w\" key. \"WAIT(w!)\"
  2275. indicates to record a time stamp each time this state is selected.
  2276. Each keyword may also specify if a timestamp or a note should be
  2277. recorded when entering or leaving the state, by adding additional
  2278. characters in the parenthesis after the keyword. This looks like this:
  2279. \"WAIT(w@/!)\". \"@\" means to add a note (with time), \"!\" means to
  2280. record only the time of the state change. With X and Y being either
  2281. \"@\" or \"!\", \"X/Y\" means use X when entering the state, and use
  2282. Y when leaving the state if and only if the *target* state does not
  2283. define X. You may omit any of the fast-selection key or X or /Y,
  2284. so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
  2285. For backward compatibility, this variable may also be just a list
  2286. of keywords. In this case the interpretation (sequence or type) will be
  2287. taken from the (otherwise obsolete) variable `org-todo-interpretation'."
  2288. :group 'org-todo
  2289. :group 'org-keywords
  2290. :type '(choice
  2291. (repeat :tag "Old syntax, just keywords"
  2292. (string :tag "Keyword"))
  2293. (repeat :tag "New syntax"
  2294. (cons
  2295. (choice
  2296. :tag "Interpretation"
  2297. ;;Quick and dirty way to see
  2298. ;;`org-todo-interpretations'. This takes the
  2299. ;;place of item arguments
  2300. :convert-widget
  2301. (lambda (widget)
  2302. (widget-put widget
  2303. :args (mapcar
  2304. (lambda (x)
  2305. (widget-convert
  2306. (cons 'const x)))
  2307. org-todo-interpretation-widgets))
  2308. widget))
  2309. (repeat
  2310. (string :tag "Keyword"))))))
  2311. (defvar-local org-todo-keywords-1 nil
  2312. "All TODO and DONE keywords active in a buffer.")
  2313. (defvar org-todo-keywords-for-agenda nil)
  2314. (defvar org-done-keywords-for-agenda nil)
  2315. (defvar org-todo-keyword-alist-for-agenda nil)
  2316. (defvar org-tag-alist-for-agenda nil
  2317. "Alist of all tags from all agenda files.")
  2318. (defvar org-tag-groups-alist-for-agenda nil
  2319. "Alist of all groups tags from all current agenda files.")
  2320. (defvar-local org-tag-groups-alist nil)
  2321. (defvar org-agenda-contributing-files nil)
  2322. (defvar-local org-current-tag-alist nil
  2323. "Alist of all tag groups in current buffer.
  2324. This variable takes into consideration `org-tag-alist',
  2325. `org-tag-persistent-alist' and TAGS keywords in the buffer.")
  2326. (defvar-local org-not-done-keywords nil)
  2327. (defvar-local org-done-keywords nil)
  2328. (defvar-local org-todo-heads nil)
  2329. (defvar-local org-todo-sets nil)
  2330. (defvar-local org-todo-log-states nil)
  2331. (defvar-local org-todo-kwd-alist nil)
  2332. (defvar-local org-todo-key-alist nil)
  2333. (defvar-local org-todo-key-trigger nil)
  2334. (defcustom org-todo-interpretation 'sequence
  2335. "Controls how TODO keywords are interpreted.
  2336. This variable is in principle obsolete and is only used for
  2337. backward compatibility, if the interpretation of todo keywords is
  2338. not given already in `org-todo-keywords'. See that variable for
  2339. more information."
  2340. :group 'org-todo
  2341. :group 'org-keywords
  2342. :type '(choice (const sequence)
  2343. (const type)))
  2344. (defcustom org-use-fast-todo-selection t
  2345. "\\<org-mode-map>\
  2346. Non-nil means use the fast todo selection scheme with `\\[org-todo]'.
  2347. This variable describes if and under what circumstances the cycling
  2348. mechanism for TODO keywords will be replaced by a single-key, direct
  2349. selection scheme.
  2350. When nil, fast selection is never used.
  2351. When the symbol `prefix', it will be used when `org-todo' is called
  2352. with a prefix argument, i.e. `\\[universal-argument] \\[org-todo]' \
  2353. in an Org buffer, and
  2354. `\\[universal-argument] t' in an agenda buffer.
  2355. When t, fast selection is used by default. In this case, the prefix
  2356. argument forces cycling instead.
  2357. In all cases, the special interface is only used if access keys have
  2358. actually been assigned by the user, i.e. if keywords in the configuration
  2359. are followed by a letter in parenthesis, like TODO(t)."
  2360. :group 'org-todo
  2361. :type '(choice
  2362. (const :tag "Never" nil)
  2363. (const :tag "By default" t)
  2364. (const :tag "Only with C-u C-c C-t" prefix)))
  2365. (defcustom org-provide-todo-statistics t
  2366. "Non-nil means update todo statistics after insert and toggle.
  2367. ALL-HEADLINES means update todo statistics by including headlines
  2368. with no TODO keyword as well, counting them as not done.
  2369. A list of TODO keywords means the same, but skip keywords that are
  2370. not in this list.
  2371. When set to a list of two lists, the first list contains keywords
  2372. to consider as TODO keywords, the second list contains keywords
  2373. to consider as DONE keywords.
  2374. When this is set, todo statistics is updated in the parent of the
  2375. current entry each time a todo state is changed."
  2376. :group 'org-todo
  2377. :type '(choice
  2378. (const :tag "Yes, only for TODO entries" t)
  2379. (const :tag "Yes, including all entries" all-headlines)
  2380. (repeat :tag "Yes, for TODOs in this list"
  2381. (string :tag "TODO keyword"))
  2382. (list :tag "Yes, for TODOs and DONEs in these lists"
  2383. (repeat (string :tag "TODO keyword"))
  2384. (repeat (string :tag "DONE keyword")))
  2385. (other :tag "No TODO statistics" nil)))
  2386. (defcustom org-hierarchical-todo-statistics t
  2387. "Non-nil means TODO statistics covers just direct children.
  2388. When nil, all entries in the subtree are considered.
  2389. This has only an effect if `org-provide-todo-statistics' is set.
  2390. To set this to nil for only a single subtree, use a COOKIE_DATA
  2391. property and include the word \"recursive\" into the value."
  2392. :group 'org-todo
  2393. :type 'boolean)
  2394. (defcustom org-after-todo-state-change-hook nil
  2395. "Hook which is run after the state of a TODO item was changed.
  2396. The new state (a string with a TODO keyword, or nil) is available in the
  2397. Lisp variable `org-state'."
  2398. :group 'org-todo
  2399. :type 'hook)
  2400. (defvar org-blocker-hook nil
  2401. "Hook for functions that are allowed to block a state change.
  2402. Functions in this hook should not modify the buffer.
  2403. Each function gets as its single argument a property list,
  2404. see `org-trigger-hook' for more information about this list.
  2405. If any of the functions in this hook returns nil, the state change
  2406. is blocked.")
  2407. (defvar org-trigger-hook nil
  2408. "Hook for functions that are triggered by a state change.
  2409. Each function gets as its single argument a property list with at
  2410. least the following elements:
  2411. (:type type-of-change :position pos-at-entry-start
  2412. :from old-state :to new-state)
  2413. Depending on the type, more properties may be present.
  2414. This mechanism is currently implemented for:
  2415. TODO state changes
  2416. ------------------
  2417. :type todo-state-change
  2418. :from previous state (keyword as a string), or nil, or a symbol
  2419. `todo' or `done', to indicate the general type of state.
  2420. :to new state, like in :from")
  2421. (defcustom org-enforce-todo-dependencies nil
  2422. "Non-nil means undone TODO entries will block switching the parent to DONE.
  2423. Also, if a parent has an :ORDERED: property, switching an entry to DONE will
  2424. be blocked if any prior sibling is not yet done.
  2425. Finally, if the parent is blocked because of ordered siblings of its own,
  2426. the child will also be blocked."
  2427. :set (lambda (var val)
  2428. (set var val)
  2429. (if val
  2430. (add-hook 'org-blocker-hook
  2431. 'org-block-todo-from-children-or-siblings-or-parent)
  2432. (remove-hook 'org-blocker-hook
  2433. 'org-block-todo-from-children-or-siblings-or-parent)))
  2434. :group 'org-todo
  2435. :type 'boolean)
  2436. (defcustom org-enforce-todo-checkbox-dependencies nil
  2437. "Non-nil means unchecked boxes will block switching the parent to DONE.
  2438. When this is nil, checkboxes have no influence on switching TODO states.
  2439. When non-nil, you first need to check off all check boxes before the TODO
  2440. entry can be switched to DONE.
  2441. This variable needs to be set before org.el is loaded, and you need to
  2442. restart Emacs after a change to make the change effective. The only way
  2443. to change is while Emacs is running is through the customize interface."
  2444. :set (lambda (var val)
  2445. (set var val)
  2446. (if val
  2447. (add-hook 'org-blocker-hook
  2448. 'org-block-todo-from-checkboxes)
  2449. (remove-hook 'org-blocker-hook
  2450. 'org-block-todo-from-checkboxes)))
  2451. :group 'org-todo
  2452. :type 'boolean)
  2453. (defcustom org-treat-insert-todo-heading-as-state-change nil
  2454. "Non-nil means inserting a TODO heading is treated as state change.
  2455. So when the command `\\[org-insert-todo-heading]' is used, state change
  2456. logging will apply if appropriate. When nil, the new TODO item will
  2457. be inserted directly, and no logging will take place."
  2458. :group 'org-todo
  2459. :type 'boolean)
  2460. (defcustom org-treat-S-cursor-todo-selection-as-state-change t
  2461. "Non-nil means switching TODO states with S-cursor counts as state change.
  2462. This is the default behavior. However, setting this to nil allows a
  2463. convenient way to select a TODO state and bypass any logging associated
  2464. with that."
  2465. :group 'org-todo
  2466. :type 'boolean)
  2467. (defcustom org-todo-state-tags-triggers nil
  2468. "Tag changes that should be triggered by TODO state changes.
  2469. This is a list. Each entry is
  2470. (state-change (tag . flag) .......)
  2471. State-change can be a string with a state, and empty string to indicate the
  2472. state that has no TODO keyword, or it can be one of the symbols `todo'
  2473. or `done', meaning any not-done or done state, respectively."
  2474. :group 'org-todo
  2475. :group 'org-tags
  2476. :type '(repeat
  2477. (cons (choice :tag "When changing to"
  2478. (const :tag "Not-done state" todo)
  2479. (const :tag "Done state" done)
  2480. (string :tag "State"))
  2481. (repeat
  2482. (cons :tag "Tag action"
  2483. (string :tag "Tag")
  2484. (choice (const :tag "Add" t) (const :tag "Remove" nil)))))))
  2485. (defcustom org-log-done nil
  2486. "Information to record when a task moves to the DONE state.
  2487. Possible values are:
  2488. nil Don't add anything, just change the keyword
  2489. time Add a time stamp to the task
  2490. note Prompt for a note and add it with template `org-log-note-headings'
  2491. This option can also be set with on a per-file-basis with
  2492. #+STARTUP: nologdone
  2493. #+STARTUP: logdone
  2494. #+STARTUP: lognotedone
  2495. You can have local logging settings for a subtree by setting the LOGGING
  2496. property to one or more of these keywords."
  2497. :group 'org-todo
  2498. :group 'org-progress
  2499. :type '(choice
  2500. (const :tag "No logging" nil)
  2501. (const :tag "Record CLOSED timestamp" time)
  2502. (const :tag "Record CLOSED timestamp with note." note)))
  2503. ;; Normalize old uses of org-log-done.
  2504. (cond
  2505. ((eq org-log-done t) (setq org-log-done 'time))
  2506. ((and (listp org-log-done) (memq 'done org-log-done))
  2507. (setq org-log-done 'note)))
  2508. (defcustom org-log-reschedule nil
  2509. "Information to record when the scheduling date of a tasks is modified.
  2510. Possible values are:
  2511. nil Don't add anything, just change the date
  2512. time Add a time stamp to the task
  2513. note Prompt for a note and add it with template `org-log-note-headings'
  2514. This option can also be set with on a per-file-basis with
  2515. #+STARTUP: nologreschedule
  2516. #+STARTUP: logreschedule
  2517. #+STARTUP: lognotereschedule"
  2518. :group 'org-todo
  2519. :group 'org-progress
  2520. :type '(choice
  2521. (const :tag "No logging" nil)
  2522. (const :tag "Record timestamp" time)
  2523. (const :tag "Record timestamp with note." note)))
  2524. (defcustom org-log-redeadline nil
  2525. "Information to record when the deadline date of a tasks is modified.
  2526. Possible values are:
  2527. nil Don't add anything, just change the date
  2528. time Add a time stamp to the task
  2529. note Prompt for a note and add it with template `org-log-note-headings'
  2530. This option can also be set with on a per-file-basis with
  2531. #+STARTUP: nologredeadline
  2532. #+STARTUP: logredeadline
  2533. #+STARTUP: lognoteredeadline
  2534. You can have local logging settings for a subtree by setting the LOGGING
  2535. property to one or more of these keywords."
  2536. :group 'org-todo
  2537. :group 'org-progress
  2538. :type '(choice
  2539. (const :tag "No logging" nil)
  2540. (const :tag "Record timestamp" time)
  2541. (const :tag "Record timestamp with note." note)))
  2542. (defcustom org-log-note-clock-out nil
  2543. "Non-nil means record a note when clocking out of an item.
  2544. This can also be configured on a per-file basis by adding one of
  2545. the following lines anywhere in the buffer:
  2546. #+STARTUP: lognoteclock-out
  2547. #+STARTUP: nolognoteclock-out"
  2548. :group 'org-todo
  2549. :group 'org-progress
  2550. :type 'boolean)
  2551. (defcustom org-log-done-with-time t
  2552. "Non-nil means the CLOSED time stamp will contain date and time.
  2553. When nil, only the date will be recorded."
  2554. :group 'org-progress
  2555. :type 'boolean)
  2556. (defcustom org-log-note-headings
  2557. '((done . "CLOSING NOTE %t")
  2558. (state . "State %-12s from %-12S %t")
  2559. (note . "Note taken on %t")
  2560. (reschedule . "Rescheduled from %S on %t")
  2561. (delschedule . "Not scheduled, was %S on %t")
  2562. (redeadline . "New deadline from %S on %t")
  2563. (deldeadline . "Removed deadline, was %S on %t")
  2564. (refile . "Refiled on %t")
  2565. (clock-out . ""))
  2566. "Headings for notes added to entries.
  2567. The value is an alist, with the car being a symbol indicating the
  2568. note context, and the cdr is the heading to be used. The heading
  2569. may also be the empty string. The following placeholders can be
  2570. used:
  2571. %t a time stamp.
  2572. %T an active time stamp instead the default inactive one
  2573. %d a short-format time stamp.
  2574. %D an active short-format time stamp.
  2575. %s the new TODO state or time stamp (inactive), in double quotes.
  2576. %S the old TODO state or time stamp (inactive), in double quotes.
  2577. %u the user name.
  2578. %U full user name.
  2579. In fact, it is not a good idea to change the `state' entry,
  2580. because Agenda Log mode depends on the format of these entries."
  2581. :group 'org-todo
  2582. :group 'org-progress
  2583. :type '(list :greedy t
  2584. (cons (const :tag "Heading when closing an item" done) string)
  2585. (cons (const :tag
  2586. "Heading when changing todo state (todo sequence only)"
  2587. state) string)
  2588. (cons (const :tag "Heading when just taking a note" note) string)
  2589. (cons (const :tag "Heading when rescheduling" reschedule) string)
  2590. (cons (const :tag "Heading when an item is no longer scheduled" delschedule) string)
  2591. (cons (const :tag "Heading when changing deadline" redeadline) string)
  2592. (cons (const :tag "Heading when deleting a deadline" deldeadline) string)
  2593. (cons (const :tag "Heading when refiling" refile) string)
  2594. (cons (const :tag "Heading when clocking out" clock-out) string)))
  2595. (unless (assq 'note org-log-note-headings)
  2596. (push '(note . "%t") org-log-note-headings))
  2597. (defcustom org-log-into-drawer nil
  2598. "Non-nil means insert state change notes and time stamps into a drawer.
  2599. When nil, state changes notes will be inserted after the headline and
  2600. any scheduling and clock lines, but not inside a drawer.
  2601. The value of this variable should be the name of the drawer to use.
  2602. LOGBOOK is proposed as the default drawer for this purpose, you can
  2603. also set this to a string to define the drawer of your choice.
  2604. A value of t is also allowed, representing \"LOGBOOK\".
  2605. A value of t or nil can also be set with on a per-file-basis with
  2606. #+STARTUP: logdrawer
  2607. #+STARTUP: nologdrawer
  2608. If this variable is set, `org-log-state-notes-insert-after-drawers'
  2609. will be ignored.
  2610. You can set the property LOG_INTO_DRAWER to overrule this setting for
  2611. a subtree.
  2612. Do not check directly this variable in a Lisp program. Call
  2613. function `org-log-into-drawer' instead."
  2614. :group 'org-todo
  2615. :group 'org-progress
  2616. :type '(choice
  2617. (const :tag "Not into a drawer" nil)
  2618. (const :tag "LOGBOOK" t)
  2619. (string :tag "Other")))
  2620. (defvaralias 'org-log-state-notes-into-drawer 'org-log-into-drawer)
  2621. (defun org-log-into-drawer ()
  2622. "Name of the log drawer, as a string, or nil.
  2623. This is the value of `org-log-into-drawer'. However, if the
  2624. current entry has or inherits a LOG_INTO_DRAWER property, it will
  2625. be used instead of the default value."
  2626. (let ((p (org-entry-get nil "LOG_INTO_DRAWER" 'inherit t)))
  2627. (cond ((equal p "nil") nil)
  2628. ((equal p "t") "LOGBOOK")
  2629. ((stringp p) p)
  2630. (p "LOGBOOK")
  2631. ((stringp org-log-into-drawer) org-log-into-drawer)
  2632. (org-log-into-drawer "LOGBOOK"))))
  2633. (defcustom org-log-state-notes-insert-after-drawers nil
  2634. "Non-nil means insert state change notes after any drawers in entry.
  2635. Only the drawers that *immediately* follow the headline and the
  2636. deadline/scheduled line are skipped.
  2637. When nil, insert notes right after the heading and perhaps the line
  2638. with deadline/scheduling if present.
  2639. This variable will have no effect if `org-log-into-drawer' is
  2640. set."
  2641. :group 'org-todo
  2642. :group 'org-progress
  2643. :type 'boolean)
  2644. (defcustom org-log-states-order-reversed t
  2645. "Non-nil means the latest state note will be directly after heading.
  2646. When nil, the state change notes will be ordered according to time.
  2647. This option can also be set with on a per-file-basis with
  2648. #+STARTUP: logstatesreversed
  2649. #+STARTUP: nologstatesreversed"
  2650. :group 'org-todo
  2651. :group 'org-progress
  2652. :type 'boolean)
  2653. (defcustom org-todo-repeat-to-state nil
  2654. "The TODO state to which a repeater should return the repeating task.
  2655. By default this is the first task in a TODO sequence, or the previous state
  2656. in a TODO_TYP set. But you can specify another task here.
  2657. alternatively, set the :REPEAT_TO_STATE: property of the entry."
  2658. :group 'org-todo
  2659. :version "24.1"
  2660. :type '(choice (const :tag "Head of sequence" nil)
  2661. (string :tag "Specific state")))
  2662. (defcustom org-log-repeat 'time
  2663. "Non-nil means record moving through the DONE state when triggering repeat.
  2664. An auto-repeating task is immediately switched back to TODO when
  2665. marked DONE. If you are not logging state changes (by adding \"@\"
  2666. or \"!\" to the TODO keyword definition), or set `org-log-done' to
  2667. record a closing note, there will be no record of the task moving
  2668. through DONE. This variable forces taking a note anyway.
  2669. nil Don't force a record
  2670. time Record a time stamp
  2671. note Prompt for a note and add it with template `org-log-note-headings'
  2672. This option can also be set with on a per-file-basis with
  2673. #+STARTUP: nologrepeat
  2674. #+STARTUP: logrepeat
  2675. #+STARTUP: lognoterepeat
  2676. You can have local logging settings for a subtree by setting the LOGGING
  2677. property to one or more of these keywords."
  2678. :group 'org-todo
  2679. :group 'org-progress
  2680. :type '(choice
  2681. (const :tag "Don't force a record" nil)
  2682. (const :tag "Force recording the DONE state" time)
  2683. (const :tag "Force recording a note with the DONE state" note)))
  2684. (defgroup org-priorities nil
  2685. "Priorities in Org mode."
  2686. :tag "Org Priorities"
  2687. :group 'org-todo)
  2688. (defcustom org-enable-priority-commands t
  2689. "Non-nil means priority commands are active.
  2690. When nil, these commands will be disabled, so that you never accidentally
  2691. set a priority."
  2692. :group 'org-priorities
  2693. :type 'boolean)
  2694. (defcustom org-highest-priority ?A
  2695. "The highest priority of TODO items. A character like ?A, ?B etc.
  2696. Must have a smaller ASCII number than `org-lowest-priority'."
  2697. :group 'org-priorities
  2698. :type 'character)
  2699. (defcustom org-lowest-priority ?C
  2700. "The lowest priority of TODO items. A character like ?A, ?B etc.
  2701. Must have a larger ASCII number than `org-highest-priority'."
  2702. :group 'org-priorities
  2703. :type 'character)
  2704. (defcustom org-default-priority ?B
  2705. "The default priority of TODO items.
  2706. This is the priority an item gets if no explicit priority is given.
  2707. When starting to cycle on an empty priority the first step in the cycle
  2708. depends on `org-priority-start-cycle-with-default'. The resulting first
  2709. step priority must not exceed the range from `org-highest-priority' to
  2710. `org-lowest-priority' which means that `org-default-priority' has to be
  2711. in this range exclusive or inclusive the range boundaries. Else the
  2712. first step refuses to set the default and the second will fall back
  2713. to (depending on the command used) the highest or lowest priority."
  2714. :group 'org-priorities
  2715. :type 'character)
  2716. (defcustom org-priority-start-cycle-with-default t
  2717. "Non-nil means start with default priority when starting to cycle.
  2718. When this is nil, the first step in the cycle will be (depending on the
  2719. command used) one higher or lower than the default priority.
  2720. See also `org-default-priority'."
  2721. :group 'org-priorities
  2722. :type 'boolean)
  2723. (defcustom org-get-priority-function nil
  2724. "Function to extract the priority from a string.
  2725. The string is normally the headline. If this is nil Org computes the
  2726. priority from the priority cookie like [#A] in the headline. It returns
  2727. an integer, increasing by 1000 for each priority level.
  2728. The user can set a different function here, which should take a string
  2729. as an argument and return the numeric priority."
  2730. :group 'org-priorities
  2731. :version "24.1"
  2732. :type '(choice
  2733. (const nil)
  2734. (function)))
  2735. (defgroup org-time nil
  2736. "Options concerning time stamps and deadlines in Org mode."
  2737. :tag "Org Time"
  2738. :group 'org)
  2739. (defcustom org-time-stamp-rounding-minutes '(0 5)
  2740. "Number of minutes to round time stamps to.
  2741. \\<org-mode-map>\
  2742. These are two values, the first applies when first creating a time stamp.
  2743. The second applies when changing it with the commands `S-up' and `S-down'.
  2744. When changing the time stamp, this means that it will change in steps
  2745. of N minutes, as given by the second value.
  2746. When a setting is 0 or 1, insert the time unmodified. Useful rounding
  2747. numbers should be factors of 60, so for example 5, 10, 15.
  2748. When this is larger than 1, you can still force an exact time stamp by using
  2749. a double prefix argument to a time stamp command like \
  2750. `\\[org-time-stamp]' or `\\[org-time-stamp-inactive],
  2751. and by using a prefix arg to `S-up/down' to specify the exact number
  2752. of minutes to shift."
  2753. :group 'org-time
  2754. :get (lambda (var) ; Make sure both elements are there
  2755. (if (integerp (default-value var))
  2756. (list (default-value var) 5)
  2757. (default-value var)))
  2758. :type '(list
  2759. (integer :tag "when inserting times")
  2760. (integer :tag "when modifying times")))
  2761. ;; Normalize old customizations of this variable.
  2762. (when (integerp org-time-stamp-rounding-minutes)
  2763. (setq org-time-stamp-rounding-minutes
  2764. (list org-time-stamp-rounding-minutes
  2765. org-time-stamp-rounding-minutes)))
  2766. (defcustom org-display-custom-times nil
  2767. "Non-nil means overlay custom formats over all time stamps.
  2768. The formats are defined through the variable `org-time-stamp-custom-formats'.
  2769. To turn this on on a per-file basis, insert anywhere in the file:
  2770. #+STARTUP: customtime"
  2771. :group 'org-time
  2772. :set 'set-default
  2773. :type 'sexp)
  2774. (make-variable-buffer-local 'org-display-custom-times)
  2775. (defcustom org-time-stamp-custom-formats
  2776. '("<%m/%d/%y %a>" . "<%m/%d/%y %a %H:%M>") ; american
  2777. "Custom formats for time stamps. See `format-time-string' for the syntax.
  2778. These are overlaid over the default ISO format if the variable
  2779. `org-display-custom-times' is set. Time like %H:%M should be at the
  2780. end of the second format. The custom formats are also honored by export
  2781. commands, if custom time display is turned on at the time of export."
  2782. :group 'org-time
  2783. :type 'sexp)
  2784. (defun org-time-stamp-format (&optional long inactive)
  2785. "Get the right format for a time string."
  2786. (let ((f (if long (cdr org-time-stamp-formats)
  2787. (car org-time-stamp-formats))))
  2788. (if inactive
  2789. (concat "[" (substring f 1 -1) "]")
  2790. f)))
  2791. (defcustom org-time-clocksum-format
  2792. '(:days "%dd " :hours "%d" :require-hours t :minutes ":%02d" :require-minutes t)
  2793. "The format string used when creating CLOCKSUM lines.
  2794. This is also used when Org mode generates a time duration.
  2795. The value can be a single format string containing two
  2796. %-sequences, which will be filled with the number of hours and
  2797. minutes in that order.
  2798. Alternatively, the value can be a plist associating any of the
  2799. keys :years, :months, :weeks, :days, :hours or :minutes with
  2800. format strings. The time duration is formatted using only the
  2801. time components that are needed and concatenating the results.
  2802. If a time unit in absent, it falls back to the next smallest
  2803. unit.
  2804. The keys :require-years, :require-months, :require-days,
  2805. :require-weeks, :require-hours, :require-minutes are also
  2806. meaningful. A non-nil value for these keys indicates that the
  2807. corresponding time component should always be included, even if
  2808. its value is 0.
  2809. For example,
  2810. (:days \"%dd\" :hours \"%d\" :require-hours t :minutes \":%02d\"
  2811. :require-minutes t)
  2812. means durations longer than a day will be expressed in days,
  2813. hours and minutes, and durations less than a day will always be
  2814. expressed in hours and minutes (even for durations less than an
  2815. hour).
  2816. The value
  2817. (:days \"%dd\" :minutes \"%dm\")
  2818. means durations longer than a day will be expressed in days and
  2819. minutes, and durations less than a day will be expressed entirely
  2820. in minutes (even for durations longer than an hour)."
  2821. :group 'org-time
  2822. :group 'org-clock
  2823. :version "24.4"
  2824. :package-version '(Org . "8.0")
  2825. :type '(choice (string :tag "Format string")
  2826. (set :tag "Plist"
  2827. (group :inline t (const :tag "Years" :years)
  2828. (string :tag "Format string"))
  2829. (group :inline t
  2830. (const :tag "Always show years" :require-years)
  2831. (const t))
  2832. (group :inline t (const :tag "Months" :months)
  2833. (string :tag "Format string"))
  2834. (group :inline t
  2835. (const :tag "Always show months" :require-months)
  2836. (const t))
  2837. (group :inline t (const :tag "Weeks" :weeks)
  2838. (string :tag "Format string"))
  2839. (group :inline t
  2840. (const :tag "Always show weeks" :require-weeks)
  2841. (const t))
  2842. (group :inline t (const :tag "Days" :days)
  2843. (string :tag "Format string"))
  2844. (group :inline t
  2845. (const :tag "Always show days" :require-days)
  2846. (const t))
  2847. (group :inline t (const :tag "Hours" :hours)
  2848. (string :tag "Format string"))
  2849. (group :inline t
  2850. (const :tag "Always show hours" :require-hours)
  2851. (const t))
  2852. (group :inline t (const :tag "Minutes" :minutes)
  2853. (string :tag "Format string"))
  2854. (group :inline t
  2855. (const :tag "Always show minutes" :require-minutes)
  2856. (const t)))))
  2857. (defcustom org-time-clocksum-use-fractional nil
  2858. "When non-nil, `\\[org-clock-display]' uses fractional times.
  2859. See `org-time-clocksum-format' for more on time clock formats."
  2860. :group 'org-time
  2861. :group 'org-clock
  2862. :version "24.3"
  2863. :type 'boolean)
  2864. (defcustom org-time-clocksum-use-effort-durations nil
  2865. "When non-nil, `\\[org-clock-display]' uses effort durations.
  2866. E.g. by default, one day is considered to be a 8 hours effort,
  2867. so a task that has been clocked for 16 hours will be displayed
  2868. as during 2 days in the clock display or in the clocktable.
  2869. See `org-effort-durations' on how to set effort durations
  2870. and `org-time-clocksum-format' for more on time clock formats."
  2871. :group 'org-time
  2872. :group 'org-clock
  2873. :version "24.4"
  2874. :package-version '(Org . "8.0")
  2875. :type 'boolean)
  2876. (defcustom org-time-clocksum-fractional-format "%.2f"
  2877. "The format string used when creating CLOCKSUM lines,
  2878. or when Org mode generates a time duration, if
  2879. `org-time-clocksum-use-fractional' is enabled.
  2880. The value can be a single format string containing one
  2881. %-sequence, which will be filled with the number of hours as
  2882. a float.
  2883. Alternatively, the value can be a plist associating any of the
  2884. keys :years, :months, :weeks, :days, :hours or :minutes with
  2885. a format string. The time duration is formatted using the
  2886. largest time unit which gives a non-zero integer part. If all
  2887. specified formats have zero integer part, the smallest time unit
  2888. is used."
  2889. :group 'org-time
  2890. :type '(choice (string :tag "Format string")
  2891. (set (group :inline t (const :tag "Years" :years)
  2892. (string :tag "Format string"))
  2893. (group :inline t (const :tag "Months" :months)
  2894. (string :tag "Format string"))
  2895. (group :inline t (const :tag "Weeks" :weeks)
  2896. (string :tag "Format string"))
  2897. (group :inline t (const :tag "Days" :days)
  2898. (string :tag "Format string"))
  2899. (group :inline t (const :tag "Hours" :hours)
  2900. (string :tag "Format string"))
  2901. (group :inline t (const :tag "Minutes" :minutes)
  2902. (string :tag "Format string")))))
  2903. (defcustom org-deadline-warning-days 14
  2904. "Number of days before expiration during which a deadline becomes active.
  2905. This variable governs the display in sparse trees and in the agenda.
  2906. When 0 or negative, it means use this number (the absolute value of it)
  2907. even if a deadline has a different individual lead time specified.
  2908. Custom commands can set this variable in the options section."
  2909. :group 'org-time
  2910. :group 'org-agenda-daily/weekly
  2911. :type 'integer)
  2912. (defcustom org-scheduled-delay-days 0
  2913. "Number of days before a scheduled item becomes active.
  2914. This variable governs the display in sparse trees and in the agenda.
  2915. The default value (i.e. 0) means: don't delay scheduled item.
  2916. When negative, it means use this number (the absolute value of it)
  2917. even if a scheduled item has a different individual delay time
  2918. specified.
  2919. Custom commands can set this variable in the options section."
  2920. :group 'org-time
  2921. :group 'org-agenda-daily/weekly
  2922. :version "24.4"
  2923. :package-version '(Org . "8.0")
  2924. :type 'integer)
  2925. (defcustom org-read-date-prefer-future t
  2926. "Non-nil means assume future for incomplete date input from user.
  2927. This affects the following situations:
  2928. 1. The user gives a month but not a year.
  2929. For example, if it is April and you enter \"feb 2\", this will be read
  2930. as Feb 2, *next* year. \"May 5\", however, will be this year.
  2931. 2. The user gives a day, but no month.
  2932. For example, if today is the 15th, and you enter \"3\", Org will read
  2933. this as the third of *next* month. However, if you enter \"17\",
  2934. it will be considered as *this* month.
  2935. If you set this variable to the symbol `time', then also the following
  2936. will work:
  2937. 3. If the user gives a time.
  2938. If the time is before now, it will be interpreted as tomorrow.
  2939. Currently none of this works for ISO week specifications.
  2940. When this option is nil, the current day, month and year will always be
  2941. used as defaults.
  2942. See also `org-agenda-jump-prefer-future'."
  2943. :group 'org-time
  2944. :type '(choice
  2945. (const :tag "Never" nil)
  2946. (const :tag "Check month and day" t)
  2947. (const :tag "Check month, day, and time" time)))
  2948. (defcustom org-agenda-jump-prefer-future 'org-read-date-prefer-future
  2949. "Should the agenda jump command prefer the future for incomplete dates?
  2950. The default is to do the same as configured in `org-read-date-prefer-future'.
  2951. But you can also set a deviating value here.
  2952. This may t or nil, or the symbol `org-read-date-prefer-future'."
  2953. :group 'org-agenda
  2954. :group 'org-time
  2955. :version "24.1"
  2956. :type '(choice
  2957. (const :tag "Use org-read-date-prefer-future"
  2958. org-read-date-prefer-future)
  2959. (const :tag "Never" nil)
  2960. (const :tag "Always" t)))
  2961. (defcustom org-read-date-force-compatible-dates t
  2962. "Should date/time prompt force dates that are guaranteed to work in Emacs?
  2963. Depending on the system Emacs is running on, certain dates cannot
  2964. be represented with the type used internally to represent time.
  2965. Dates between 1970-1-1 and 2038-1-1 can always be represented
  2966. correctly. Some systems allow for earlier dates, some for later,
  2967. some for both. One way to find out it to insert any date into an
  2968. Org buffer, putting the cursor on the year and hitting S-up and
  2969. S-down to test the range.
  2970. When this variable is set to t, the date/time prompt will not let
  2971. you specify dates outside the 1970-2037 range, so it is certain that
  2972. these dates will work in whatever version of Emacs you are
  2973. running, and also that you can move a file from one Emacs implementation
  2974. to another. WHenever Org is forcing the year for you, it will display
  2975. a message and beep.
  2976. When this variable is nil, Org will check if the date is
  2977. representable in the specific Emacs implementation you are using.
  2978. If not, it will force a year, usually the current year, and beep
  2979. to remind you. Currently this setting is not recommended because
  2980. the likelihood that you will open your Org files in an Emacs that
  2981. has limited date range is not negligible.
  2982. A workaround for this problem is to use diary sexp dates for time
  2983. stamps outside of this range."
  2984. :group 'org-time
  2985. :version "24.1"
  2986. :type 'boolean)
  2987. (defcustom org-read-date-display-live t
  2988. "Non-nil means display current interpretation of date prompt live.
  2989. This display will be in an overlay, in the minibuffer."
  2990. :group 'org-time
  2991. :type 'boolean)
  2992. (defcustom org-read-date-popup-calendar t
  2993. "Non-nil means pop up a calendar when prompting for a date.
  2994. In the calendar, the date can be selected with mouse-1. However, the
  2995. minibuffer will also be active, and you can simply enter the date as well.
  2996. When nil, only the minibuffer will be available."
  2997. :group 'org-time
  2998. :type 'boolean)
  2999. (defvaralias 'org-popup-calendar-for-date-prompt
  3000. 'org-read-date-popup-calendar)
  3001. (defcustom org-extend-today-until 0
  3002. "The hour when your day really ends. Must be an integer.
  3003. This has influence for the following applications:
  3004. - When switching the agenda to \"today\". It it is still earlier than
  3005. the time given here, the day recognized as TODAY is actually yesterday.
  3006. - When a date is read from the user and it is still before the time given
  3007. here, the current date and time will be assumed to be yesterday, 23:59.
  3008. Also, timestamps inserted in capture templates follow this rule.
  3009. IMPORTANT: This is a feature whose implementation is and likely will
  3010. remain incomplete. Really, it is only here because past midnight seems to
  3011. be the favorite working time of John Wiegley :-)"
  3012. :group 'org-time
  3013. :type 'integer)
  3014. (defcustom org-use-effective-time nil
  3015. "If non-nil, consider `org-extend-today-until' when creating timestamps.
  3016. For example, if `org-extend-today-until' is 8, and it's 4am, then the
  3017. \"effective time\" of any timestamps between midnight and 8am will be
  3018. 23:59 of the previous day."
  3019. :group 'org-time
  3020. :version "24.1"
  3021. :type 'boolean)
  3022. (defcustom org-use-last-clock-out-time-as-effective-time nil
  3023. "When non-nil, use the last clock out time for `org-todo'.
  3024. Note that this option has precedence over the combined use of
  3025. `org-use-effective-time' and `org-extend-today-until'."
  3026. :group 'org-time
  3027. :version "24.4"
  3028. :package-version '(Org . "8.0")
  3029. :type 'boolean)
  3030. (defcustom org-edit-timestamp-down-means-later nil
  3031. "Non-nil means S-down will increase the time in a time stamp.
  3032. When nil, S-up will increase."
  3033. :group 'org-time
  3034. :type 'boolean)
  3035. (defcustom org-calendar-follow-timestamp-change t
  3036. "Non-nil means make the calendar window follow timestamp changes.
  3037. When a timestamp is modified and the calendar window is visible, it will be
  3038. moved to the new date."
  3039. :group 'org-time
  3040. :type 'boolean)
  3041. (defgroup org-tags nil
  3042. "Options concerning tags in Org mode."
  3043. :tag "Org Tags"
  3044. :group 'org)
  3045. (defcustom org-tag-alist nil
  3046. "Default tags available in Org files.
  3047. The value of this variable is an alist. Associations either:
  3048. (TAG)
  3049. (TAG . SELECT)
  3050. (SPECIAL)
  3051. where TAG is a tag as a string, SELECT is character, used to
  3052. select that tag through the fast tag selection interface, and
  3053. SPECIAL is one of the following keywords: `:startgroup',
  3054. `:startgrouptag', `:grouptags', `:engroup', `:endgrouptag' or
  3055. `:newline'. These keywords are used to define a hierarchy of
  3056. tags. See manual for details.
  3057. When this variable is nil, Org mode bases tag input on what is
  3058. already in the buffer. The value can be overridden locally by
  3059. using a TAGS keyword, e.g.,
  3060. #+TAGS: tag1 tag2
  3061. See also `org-tag-persistent-alist' to sidestep this behavior."
  3062. :group 'org-tags
  3063. :type '(repeat
  3064. (choice
  3065. (cons (string :tag "Tag name")
  3066. (character :tag "Access char"))
  3067. (const :tag "Start radio group" (:startgroup))
  3068. (const :tag "Start tag group, non distinct" (:startgrouptag))
  3069. (const :tag "Group tags delimiter" (:grouptags))
  3070. (const :tag "End radio group" (:endgroup))
  3071. (const :tag "End tag group, non distinct" (:endgrouptag))
  3072. (const :tag "New line" (:newline)))))
  3073. (defcustom org-tag-persistent-alist nil
  3074. "Tags always available in Org files.
  3075. The value of this variable is an alist. Associations either:
  3076. (TAG)
  3077. (TAG . SELECT)
  3078. (SPECIAL)
  3079. where TAG is a tag as a string, SELECT is a character, used to
  3080. select that tag through the fast tag selection interface, and
  3081. SPECIAL is one of the following keywords: `:startgroup',
  3082. `:startgrouptag', `:grouptags', `:engroup', `:endgrouptag' or
  3083. `:newline'. These keywords are used to define a hierarchy of
  3084. tags. See manual for details.
  3085. Unlike to `org-tag-alist', tags defined in this variable do not
  3086. depend on a local TAGS keyword. Instead, to disable these tags
  3087. on a per-file basis, insert anywhere in the file:
  3088. #+STARTUP: noptag"
  3089. :group 'org-tags
  3090. :type '(repeat
  3091. (choice
  3092. (cons (string :tag "Tag name")
  3093. (character :tag "Access char"))
  3094. (const :tag "Start radio group" (:startgroup))
  3095. (const :tag "Start tag group, non distinct" (:startgrouptag))
  3096. (const :tag "Group tags delimiter" (:grouptags))
  3097. (const :tag "End radio group" (:endgroup))
  3098. (const :tag "End tag group, non distinct" (:endgrouptag))
  3099. (const :tag "New line" (:newline)))))
  3100. (defcustom org-complete-tags-always-offer-all-agenda-tags nil
  3101. "If non-nil, always offer completion for all tags of all agenda files.
  3102. Instead of customizing this variable directly, you might want to
  3103. set it locally for capture buffers, because there no list of
  3104. tags in that file can be created dynamically (there are none).
  3105. (add-hook \\='org-capture-mode-hook
  3106. (lambda ()
  3107. (setq-local org-complete-tags-always-offer-all-agenda-tags t)))"
  3108. :group 'org-tags
  3109. :version "24.1"
  3110. :type 'boolean)
  3111. (defvar org-file-tags nil
  3112. "List of tags that can be inherited by all entries in the file.
  3113. The tags will be inherited if the variable `org-use-tag-inheritance'
  3114. says they should be.
  3115. This variable is populated from #+FILETAGS lines.")
  3116. (defcustom org-use-fast-tag-selection 'auto
  3117. "Non-nil means use fast tag selection scheme.
  3118. This is a special interface to select and deselect tags with single keys.
  3119. When nil, fast selection is never used.
  3120. When the symbol `auto', fast selection is used if and only if selection
  3121. characters for tags have been configured, either through the variable
  3122. `org-tag-alist' or through a #+TAGS line in the buffer.
  3123. When t, fast selection is always used and selection keys are assigned
  3124. automatically if necessary."
  3125. :group 'org-tags
  3126. :type '(choice
  3127. (const :tag "Always" t)
  3128. (const :tag "Never" nil)
  3129. (const :tag "When selection characters are configured" auto)))
  3130. (defcustom org-fast-tag-selection-single-key nil
  3131. "Non-nil means fast tag selection exits after first change.
  3132. When nil, you have to press RET to exit it.
  3133. During fast tag selection, you can toggle this flag with `C-c'.
  3134. This variable can also have the value `expert'. In this case, the window
  3135. displaying the tags menu is not even shown, until you press C-c again."
  3136. :group 'org-tags
  3137. :type '(choice
  3138. (const :tag "No" nil)
  3139. (const :tag "Yes" t)
  3140. (const :tag "Expert" expert)))
  3141. (defvar org-fast-tag-selection-include-todo nil
  3142. "Non-nil means fast tags selection interface will also offer TODO states.
  3143. This is an undocumented feature, you should not rely on it.")
  3144. (defcustom org-tags-column -77
  3145. "The column to which tags should be indented in a headline.
  3146. If this number is positive, it specifies the column. If it is negative,
  3147. it means that the tags should be flushright to that column. For example,
  3148. -80 works well for a normal 80 character screen.
  3149. When 0, place tags directly after headline text, with only one space in
  3150. between."
  3151. :group 'org-tags
  3152. :type 'integer)
  3153. (defcustom org-auto-align-tags t
  3154. "Non-nil keeps tags aligned when modifying headlines.
  3155. Some operations (i.e. demoting) change the length of a headline and
  3156. therefore shift the tags around. With this option turned on, after
  3157. each such operation the tags are again aligned to `org-tags-column'."
  3158. :group 'org-tags
  3159. :type 'boolean)
  3160. (defcustom org-use-tag-inheritance t
  3161. "Non-nil means tags in levels apply also for sublevels.
  3162. When nil, only the tags directly given in a specific line apply there.
  3163. This may also be a list of tags that should be inherited, or a regexp that
  3164. matches tags that should be inherited. Additional control is possible
  3165. with the variable `org-tags-exclude-from-inheritance' which gives an
  3166. explicit list of tags to be excluded from inheritance, even if the value of
  3167. `org-use-tag-inheritance' would select it for inheritance.
  3168. If this option is t, a match early-on in a tree can lead to a large
  3169. number of matches in the subtree when constructing the agenda or creating
  3170. a sparse tree. If you only want to see the first match in a tree during
  3171. a search, check out the variable `org-tags-match-list-sublevels'."
  3172. :group 'org-tags
  3173. :type '(choice
  3174. (const :tag "Not" nil)
  3175. (const :tag "Always" t)
  3176. (repeat :tag "Specific tags" (string :tag "Tag"))
  3177. (regexp :tag "Tags matched by regexp")))
  3178. (defcustom org-tags-exclude-from-inheritance nil
  3179. "List of tags that should never be inherited.
  3180. This is a way to exclude a few tags from inheritance. For way to do
  3181. the opposite, to actively allow inheritance for selected tags,
  3182. see the variable `org-use-tag-inheritance'."
  3183. :group 'org-tags
  3184. :type '(repeat (string :tag "Tag")))
  3185. (defun org-tag-inherit-p (tag)
  3186. "Check if TAG is one that should be inherited."
  3187. (cond
  3188. ((member tag org-tags-exclude-from-inheritance) nil)
  3189. ((eq org-use-tag-inheritance t) t)
  3190. ((not org-use-tag-inheritance) nil)
  3191. ((stringp org-use-tag-inheritance)
  3192. (string-match org-use-tag-inheritance tag))
  3193. ((listp org-use-tag-inheritance)
  3194. (member tag org-use-tag-inheritance))
  3195. (t (error "Invalid setting of `org-use-tag-inheritance'"))))
  3196. (defcustom org-tags-match-list-sublevels t
  3197. "Non-nil means list also sublevels of headlines matching a search.
  3198. This variable applies to tags/property searches, and also to stuck
  3199. projects because this search is based on a tags match as well.
  3200. When set to the symbol `indented', sublevels are indented with
  3201. leading dots.
  3202. Because of tag inheritance (see variable `org-use-tag-inheritance'),
  3203. the sublevels of a headline matching a tag search often also match
  3204. the same search. Listing all of them can create very long lists.
  3205. Setting this variable to nil causes subtrees of a match to be skipped.
  3206. This variable is semi-obsolete and probably should always be true. It
  3207. is better to limit inheritance to certain tags using the variables
  3208. `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
  3209. :group 'org-tags
  3210. :type '(choice
  3211. (const :tag "No, don't list them" nil)
  3212. (const :tag "Yes, do list them" t)
  3213. (const :tag "List them, indented with leading dots" indented)))
  3214. (defcustom org-tags-sort-function nil
  3215. "When set, tags are sorted using this function as a comparator."
  3216. :group 'org-tags
  3217. :type '(choice
  3218. (const :tag "No sorting" nil)
  3219. (const :tag "Alphabetical" string<)
  3220. (const :tag "Reverse alphabetical" string>)
  3221. (function :tag "Custom function" nil)))
  3222. (defvar org-tags-history nil
  3223. "History of minibuffer reads for tags.")
  3224. (defvar org-last-tags-completion-table nil
  3225. "The last used completion table for tags.")
  3226. (defvar org-after-tags-change-hook nil
  3227. "Hook that is run after the tags in a line have changed.")
  3228. (defgroup org-properties nil
  3229. "Options concerning properties in Org mode."
  3230. :tag "Org Properties"
  3231. :group 'org)
  3232. (defcustom org-property-format "%-10s %s"
  3233. "How property key/value pairs should be formatted by `indent-line'.
  3234. When `indent-line' hits a property definition, it will format the line
  3235. according to this format, mainly to make sure that the values are
  3236. lined-up with respect to each other."
  3237. :group 'org-properties
  3238. :type 'string)
  3239. (defcustom org-properties-postprocess-alist nil
  3240. "Alist of properties and functions to adjust inserted values.
  3241. Elements of this alist must be of the form
  3242. ([string] [function])
  3243. where [string] must be a property name and [function] must be a
  3244. lambda expression: this lambda expression must take one argument,
  3245. the value to adjust, and return the new value as a string.
  3246. For example, this element will allow the property \"Remaining\"
  3247. to be updated wrt the relation between the \"Effort\" property
  3248. and the clock summary:
  3249. ((\"Remaining\" (lambda(value)
  3250. (let ((clocksum (org-clock-sum-current-item))
  3251. (effort (org-duration-string-to-minutes
  3252. (org-entry-get (point) \"Effort\"))))
  3253. (org-minutes-to-clocksum-string (- effort clocksum))))))"
  3254. :group 'org-properties
  3255. :version "24.1"
  3256. :type '(alist :key-type (string :tag "Property")
  3257. :value-type (function :tag "Function")))
  3258. (defcustom org-use-property-inheritance nil
  3259. "Non-nil means properties apply also for sublevels.
  3260. This setting is chiefly used during property searches. Turning it on can
  3261. cause significant overhead when doing a search, which is why it is not
  3262. on by default.
  3263. When nil, only the properties directly given in the current entry count.
  3264. When t, every property is inherited. The value may also be a list of
  3265. properties that should have inheritance, or a regular expression matching
  3266. properties that should be inherited.
  3267. However, note that some special properties use inheritance under special
  3268. circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
  3269. and the properties ending in \"_ALL\" when they are used as descriptor
  3270. for valid values of a property.
  3271. Note for programmers:
  3272. When querying an entry with `org-entry-get', you can control if inheritance
  3273. should be used. By default, `org-entry-get' looks only at the local
  3274. properties. You can request inheritance by setting the inherit argument
  3275. to t (to force inheritance) or to `selective' (to respect the setting
  3276. in this variable)."
  3277. :group 'org-properties
  3278. :type '(choice
  3279. (const :tag "Not" nil)
  3280. (const :tag "Always" t)
  3281. (repeat :tag "Specific properties" (string :tag "Property"))
  3282. (regexp :tag "Properties matched by regexp")))
  3283. (defun org-property-inherit-p (property)
  3284. "Check if PROPERTY is one that should be inherited."
  3285. (cond
  3286. ((eq org-use-property-inheritance t) t)
  3287. ((not org-use-property-inheritance) nil)
  3288. ((stringp org-use-property-inheritance)
  3289. (string-match org-use-property-inheritance property))
  3290. ((listp org-use-property-inheritance)
  3291. (member property org-use-property-inheritance))
  3292. (t (error "Invalid setting of `org-use-property-inheritance'"))))
  3293. (defcustom org-columns-default-format "%25ITEM %TODO %3PRIORITY %TAGS"
  3294. "The default column format, if no other format has been defined.
  3295. This variable can be set on the per-file basis by inserting a line
  3296. #+COLUMNS: %25ITEM ....."
  3297. :group 'org-properties
  3298. :type 'string)
  3299. (defcustom org-columns-ellipses ".."
  3300. "The ellipses to be used when a field in column view is truncated.
  3301. When this is the empty string, as many characters as possible are shown,
  3302. but then there will be no visual indication that the field has been truncated.
  3303. When this is a string of length N, the last N characters of a truncated
  3304. field are replaced by this string. If the column is narrower than the
  3305. ellipses string, only part of the ellipses string will be shown."
  3306. :group 'org-properties
  3307. :type 'string)
  3308. (defconst org-global-properties-fixed
  3309. '(("VISIBILITY_ALL" . "folded children content all")
  3310. ("CLOCK_MODELINE_TOTAL_ALL" . "current today repeat all auto"))
  3311. "List of property/value pairs that can be inherited by any entry.
  3312. These are fixed values, for the preset properties. The user variable
  3313. that can be used to add to this list is `org-global-properties'.
  3314. The entries in this list are cons cells where the car is a property
  3315. name and cdr is a string with the value. If the value represents
  3316. multiple items like an \"_ALL\" property, separate the items by
  3317. spaces.")
  3318. (defcustom org-global-properties nil
  3319. "List of property/value pairs that can be inherited by any entry.
  3320. This list will be combined with the constant `org-global-properties-fixed'.
  3321. The entries in this list are cons cells where the car is a property
  3322. name and cdr is a string with the value.
  3323. You can set buffer-local values for the same purpose in the variable
  3324. `org-file-properties' this by adding lines like
  3325. #+PROPERTY: NAME VALUE"
  3326. :group 'org-properties
  3327. :type '(repeat
  3328. (cons (string :tag "Property")
  3329. (string :tag "Value"))))
  3330. (defvar-local org-file-properties nil
  3331. "List of property/value pairs that can be inherited by any entry.
  3332. Valid for the current buffer.
  3333. This variable is populated from #+PROPERTY lines.")
  3334. (defgroup org-agenda nil
  3335. "Options concerning agenda views in Org mode."
  3336. :tag "Org Agenda"
  3337. :group 'org)
  3338. (defvar-local org-category nil
  3339. "Variable used by org files to set a category for agenda display.
  3340. Such files should use a file variable to set it, for example
  3341. # -*- mode: org; org-category: \"ELisp\"
  3342. or contain a special line
  3343. #+CATEGORY: ELisp
  3344. If the file does not specify a category, then file's base name
  3345. is used instead.")
  3346. (put 'org-category 'safe-local-variable (lambda (x) (or (symbolp x) (stringp x))))
  3347. (defcustom org-agenda-files nil
  3348. "The files to be used for agenda display.
  3349. If an entry is a directory, all files in that directory that are matched
  3350. by `org-agenda-file-regexp' will be part of the file list.
  3351. If the value of the variable is not a list but a single file name, then
  3352. the list of agenda files is actually stored and maintained in that file,
  3353. one agenda file per line. In this file paths can be given relative to
  3354. `org-directory'. Tilde expansion and environment variable substitution
  3355. are also made.
  3356. Entries may be added to this list with `\\[org-agenda-file-to-front]'
  3357. and removed with `\\[org-remove-file]'."
  3358. :group 'org-agenda
  3359. :type '(choice
  3360. (repeat :tag "List of files and directories" file)
  3361. (file :tag "Store list in a file\n" :value "~/.agenda_files")))
  3362. (defcustom org-agenda-file-regexp "\\`[^.].*\\.org\\'"
  3363. "Regular expression to match files for `org-agenda-files'.
  3364. If any element in the list in that variable contains a directory instead
  3365. of a normal file, all files in that directory that are matched by this
  3366. regular expression will be included."
  3367. :group 'org-agenda
  3368. :type 'regexp)
  3369. (defcustom org-agenda-text-search-extra-files nil
  3370. "List of extra files to be searched by text search commands.
  3371. These files will be searched in addition to the agenda files by the
  3372. commands `org-search-view' (`\\[org-agenda] s') \
  3373. and `org-occur-in-agenda-files'.
  3374. Note that these files will only be searched for text search commands,
  3375. not for the other agenda views like todo lists, tag searches or the weekly
  3376. agenda. This variable is intended to list notes and possibly archive files
  3377. that should also be searched by these two commands.
  3378. In fact, if the first element in the list is the symbol `agenda-archives',
  3379. then all archive files of all agenda files will be added to the search
  3380. scope."
  3381. :group 'org-agenda
  3382. :type '(set :greedy t
  3383. (const :tag "Agenda Archives" agenda-archives)
  3384. (repeat :inline t (file))))
  3385. (defvaralias 'org-agenda-multi-occur-extra-files
  3386. 'org-agenda-text-search-extra-files)
  3387. (defcustom org-agenda-skip-unavailable-files nil
  3388. "Non-nil means to just skip non-reachable files in `org-agenda-files'.
  3389. A nil value means to remove them, after a query, from the list."
  3390. :group 'org-agenda
  3391. :type 'boolean)
  3392. (defcustom org-calendar-to-agenda-key [?c]
  3393. "The key to be installed in `calendar-mode-map' for switching to the agenda.
  3394. The command `org-calendar-goto-agenda' will be bound to this key. The
  3395. default is the character `c' because then `c' can be used to switch back and
  3396. forth between agenda and calendar."
  3397. :group 'org-agenda
  3398. :type 'sexp)
  3399. (defcustom org-calendar-insert-diary-entry-key [?i]
  3400. "The key to be installed in `calendar-mode-map' for adding diary entries.
  3401. This option is irrelevant until `org-agenda-diary-file' has been configured
  3402. to point to an Org file. When that is the case, the command
  3403. `org-agenda-diary-entry' will be bound to the key given here, by default
  3404. `i'. In the calendar, `i' normally adds entries to `diary-file'. So
  3405. if you want to continue doing this, you need to change this to a different
  3406. key."
  3407. :group 'org-agenda
  3408. :type 'sexp)
  3409. (defcustom org-agenda-diary-file 'diary-file
  3410. "File to which to add new entries with the `i' key in agenda and calendar.
  3411. When this is the symbol `diary-file', the functionality in the Emacs
  3412. calendar will be used to add entries to the `diary-file'. But when this
  3413. points to a file, `org-agenda-diary-entry' will be used instead."
  3414. :group 'org-agenda
  3415. :type '(choice
  3416. (const :tag "The standard Emacs diary file" diary-file)
  3417. (file :tag "Special Org file diary entries")))
  3418. (eval-after-load "calendar"
  3419. '(progn
  3420. (org-defkey calendar-mode-map org-calendar-to-agenda-key
  3421. 'org-calendar-goto-agenda)
  3422. (add-hook 'calendar-mode-hook
  3423. (lambda ()
  3424. (unless (eq org-agenda-diary-file 'diary-file)
  3425. (define-key calendar-mode-map
  3426. org-calendar-insert-diary-entry-key
  3427. 'org-agenda-diary-entry))))))
  3428. (defgroup org-latex nil
  3429. "Options for embedding LaTeX code into Org mode."
  3430. :tag "Org LaTeX"
  3431. :group 'org)
  3432. (defcustom org-format-latex-options
  3433. '(:foreground default :background default :scale 1.0
  3434. :html-foreground "Black" :html-background "Transparent"
  3435. :html-scale 1.0 :matchers ("begin" "$1" "$" "$$" "\\(" "\\["))
  3436. "Options for creating images from LaTeX fragments.
  3437. This is a property list with the following properties:
  3438. :foreground the foreground color for images embedded in Emacs, e.g. \"Black\".
  3439. `default' means use the foreground of the default face.
  3440. `auto' means use the foreground from the text face.
  3441. :background the background color, or \"Transparent\".
  3442. `default' means use the background of the default face.
  3443. `auto' means use the background from the text face.
  3444. :scale a scaling factor for the size of the images, to get more pixels
  3445. :html-foreground, :html-background, :html-scale
  3446. the same numbers for HTML export.
  3447. :matchers a list indicating which matchers should be used to
  3448. find LaTeX fragments. Valid members of this list are:
  3449. \"begin\" find environments
  3450. \"$1\" find single characters surrounded by $.$
  3451. \"$\" find math expressions surrounded by $...$
  3452. \"$$\" find math expressions surrounded by $$....$$
  3453. \"\\(\" find math expressions surrounded by \\(...\\)
  3454. \"\\=\\[\" find math expressions surrounded by \\=\\[...\\]"
  3455. :group 'org-latex
  3456. :type 'plist)
  3457. (defcustom org-format-latex-signal-error t
  3458. "Non-nil means signal an error when image creation of LaTeX snippets fails.
  3459. When nil, just push out a message."
  3460. :group 'org-latex
  3461. :version "24.1"
  3462. :type 'boolean)
  3463. (defcustom org-latex-to-mathml-jar-file nil
  3464. "Value of\"%j\" in `org-latex-to-mathml-convert-command'.
  3465. Use this to specify additional executable file say a jar file.
  3466. When using MathToWeb as the converter, specify the full-path to
  3467. your mathtoweb.jar file."
  3468. :group 'org-latex
  3469. :version "24.1"
  3470. :type '(choice
  3471. (const :tag "None" nil)
  3472. (file :tag "JAR file" :must-match t)))
  3473. (defcustom org-latex-to-mathml-convert-command nil
  3474. "Command to convert LaTeX fragments to MathML.
  3475. Replace format-specifiers in the command as noted below and use
  3476. `shell-command' to convert LaTeX to MathML.
  3477. %j: Executable file in fully expanded form as specified by
  3478. `org-latex-to-mathml-jar-file'.
  3479. %I: Input LaTeX file in fully expanded form.
  3480. %i: The latex fragment to be converted.
  3481. %o: Output MathML file.
  3482. This command is used by `org-create-math-formula'.
  3483. When using MathToWeb as the converter, set this option to
  3484. \"java -jar %j -unicode -force -df %o %I\".
  3485. When using LaTeXML set this option to
  3486. \"latexmlmath \"%i\" --presentationmathml=%o\"."
  3487. :group 'org-latex
  3488. :version "24.1"
  3489. :type '(choice
  3490. (const :tag "None" nil)
  3491. (string :tag "\nShell command")))
  3492. (defcustom org-preview-latex-default-process 'dvipng
  3493. "The default process to convert LaTeX fragments to image files.
  3494. All available processes and theirs documents can be found in
  3495. `org-preview-latex-process-alist', which see."
  3496. :group 'org-latex
  3497. :version "25.2"
  3498. :package-version '(Org . "9.0")
  3499. :type 'symbol)
  3500. (defcustom org-preview-latex-process-alist
  3501. '((dvipng
  3502. :programs ("latex" "dvipng")
  3503. :description "dvi > png"
  3504. :message "you need to install the programs: latex and dvipng."
  3505. :image-input-type "dvi"
  3506. :image-output-type "png"
  3507. :image-size-adjust (1.0 . 1.0)
  3508. :latex-compiler ("latex -interaction nonstopmode -output-directory %o %f")
  3509. :image-converter ("dvipng -fg %F -bg %B -D %D -T tight -o %O %f"))
  3510. (dvisvgm
  3511. :programs ("latex" "dvisvgm")
  3512. :description "dvi > svg"
  3513. :message "you need to install the programs: latex and dvisvgm."
  3514. :use-xcolor t
  3515. :image-input-type "dvi"
  3516. :image-output-type "svg"
  3517. :image-size-adjust (1.7 . 1.5)
  3518. :latex-compiler ("latex -interaction nonstopmode -output-directory %o %f")
  3519. :image-converter ("dvisvgm %f -n -b min -c %S -o %O"))
  3520. (imagemagick
  3521. :programs ("latex" "convert")
  3522. :description "pdf > png"
  3523. :message "you need to install the programs: latex and imagemagick."
  3524. :use-xcolor t
  3525. :image-input-type "pdf"
  3526. :image-output-type "png"
  3527. :image-size-adjust (1.0 . 1.0)
  3528. :latex-compiler ("pdflatex -interaction nonstopmode -output-directory %o %f")
  3529. :image-converter
  3530. ("convert -density %D -trim -antialias %f -quality 100 %O")))
  3531. "Definitions of external processes for LaTeX previewing.
  3532. Org mode can use some external commands to generate TeX snippet's images for
  3533. previewing or inserting into HTML files, e.g., \"dvipng\". This variable tells
  3534. `org-create-formula-image' how to call them.
  3535. The value is an alist with the pattern (NAME . PROPERTIES). NAME is a symbol.
  3536. PROPERTIES accepts the following attributes:
  3537. :programs list of strings, required programs.
  3538. :description string, describe the process.
  3539. :message string, message it when required programs cannot be found.
  3540. :image-input-type string, input file type of image converter (e.g., \"dvi\").
  3541. :image-output-type string, output file type of image converter (e.g., \"png\").
  3542. :use-xcolor boolean, when non-nil, LaTeX \"xcolor\" macro is used to
  3543. deal with background and foreground color of image.
  3544. Otherwise, dvipng style background and foregroud color
  3545. format are generated. You may then refer to them in
  3546. command options with \"%F\" and \"%B\".
  3547. :image-size-adjust cons of numbers, the car element is used to adjust LaTeX
  3548. image size showed in buffer and the cdr element is for
  3549. HTML file. This option is only useful for process
  3550. developers, users should use variable
  3551. `org-format-latex-options' instead.
  3552. :post-clean list of strings, files matched are to be cleaned up once
  3553. the image is generated. When nil, the files with \".dvi\",
  3554. \".xdv\", \".pdf\", \".tex\", \".aux\", \".log\", \".svg\",
  3555. \".png\", \".jpg\", \".jpeg\" or \".out\" extension will
  3556. be cleaned up.
  3557. :latex-header list of strings, the LaTeX header of the snippet file.
  3558. When nil, the fallback value is used instead, which is
  3559. controlled by `org-format-latex-header',
  3560. `org-latex-default-packages-alist' and
  3561. `org-latex-packages-alist', which see.
  3562. :latex-compiler list of LaTeX commands, as strings. Each of them is given
  3563. to the shell. Place-holders \"%t\", \"%b\" and \"%o\" are
  3564. replaced with values defined below.
  3565. :image-converter list of image converter commands strings. Each of them is
  3566. given to the shell and supports any of the following
  3567. place-holders defined below.
  3568. Place-holders used by `:image-converter' and `:latex-compiler':
  3569. %f input file name
  3570. %b base name of input file
  3571. %o base directory of input file
  3572. %O absolute output file name
  3573. Place-holders only used by `:image-converter':
  3574. %F foreground of image
  3575. %B background of image
  3576. %D dpi, which is used to adjust image size by some processing commands.
  3577. %S the image size scale ratio, which is used to adjust image size by some
  3578. processing commands."
  3579. :group 'org-latex
  3580. :version "25.2"
  3581. :package-version '(Org . "9.0")
  3582. :type '(alist :tag "LaTeX to image backends"
  3583. :value-type (plist)))
  3584. (defcustom org-preview-latex-image-directory "ltximg/"
  3585. "Path to store latex preview images.
  3586. A relative path here creates many directories relative to the
  3587. processed org files paths. An absolute path puts all preview
  3588. images at the same place."
  3589. :group 'org-latex
  3590. :version "25.2"
  3591. :package-version '(Org . "9.0")
  3592. :type 'string)
  3593. (defun org-format-latex-mathml-available-p ()
  3594. "Return t if `org-latex-to-mathml-convert-command' is usable."
  3595. (save-match-data
  3596. (when (and (boundp 'org-latex-to-mathml-convert-command)
  3597. org-latex-to-mathml-convert-command)
  3598. (let ((executable (car (split-string
  3599. org-latex-to-mathml-convert-command))))
  3600. (when (executable-find executable)
  3601. (if (string-match
  3602. "%j" org-latex-to-mathml-convert-command)
  3603. (file-readable-p org-latex-to-mathml-jar-file)
  3604. t))))))
  3605. (defcustom org-format-latex-header "\\documentclass{article}
  3606. \\usepackage[usenames]{color}
  3607. \[PACKAGES]
  3608. \[DEFAULT-PACKAGES]
  3609. \\pagestyle{empty} % do not remove
  3610. % The settings below are copied from fullpage.sty
  3611. \\setlength{\\textwidth}{\\paperwidth}
  3612. \\addtolength{\\textwidth}{-3cm}
  3613. \\setlength{\\oddsidemargin}{1.5cm}
  3614. \\addtolength{\\oddsidemargin}{-2.54cm}
  3615. \\setlength{\\evensidemargin}{\\oddsidemargin}
  3616. \\setlength{\\textheight}{\\paperheight}
  3617. \\addtolength{\\textheight}{-\\headheight}
  3618. \\addtolength{\\textheight}{-\\headsep}
  3619. \\addtolength{\\textheight}{-\\footskip}
  3620. \\addtolength{\\textheight}{-3cm}
  3621. \\setlength{\\topmargin}{1.5cm}
  3622. \\addtolength{\\topmargin}{-2.54cm}"
  3623. "The document header used for processing LaTeX fragments.
  3624. It is imperative that this header make sure that no page number
  3625. appears on the page. The package defined in the variables
  3626. `org-latex-default-packages-alist' and `org-latex-packages-alist'
  3627. will either replace the placeholder \"[PACKAGES]\" in this
  3628. header, or they will be appended."
  3629. :group 'org-latex
  3630. :type 'string)
  3631. (defun org-set-packages-alist (var val)
  3632. "Set the packages alist and make sure it has 3 elements per entry."
  3633. (set var (mapcar (lambda (x)
  3634. (if (and (consp x) (= (length x) 2))
  3635. (list (car x) (nth 1 x) t)
  3636. x))
  3637. val)))
  3638. (defun org-get-packages-alist (var)
  3639. "Get the packages alist and make sure it has 3 elements per entry."
  3640. (mapcar (lambda (x)
  3641. (if (and (consp x) (= (length x) 2))
  3642. (list (car x) (nth 1 x) t)
  3643. x))
  3644. (default-value var)))
  3645. (defcustom org-latex-default-packages-alist
  3646. '(("AUTO" "inputenc" t ("pdflatex"))
  3647. ("T1" "fontenc" t ("pdflatex"))
  3648. ("" "graphicx" t)
  3649. ("" "grffile" t)
  3650. ("" "longtable" nil)
  3651. ("" "wrapfig" nil)
  3652. ("" "rotating" nil)
  3653. ("normalem" "ulem" t)
  3654. ("" "amsmath" t)
  3655. ("" "textcomp" t)
  3656. ("" "amssymb" t)
  3657. ("" "capt-of" nil)
  3658. ("" "hyperref" nil))
  3659. "Alist of default packages to be inserted in the header.
  3660. Change this only if one of the packages here causes an
  3661. incompatibility with another package you are using.
  3662. The packages in this list are needed by one part or another of
  3663. Org mode to function properly:
  3664. - inputenc, fontenc: for basic font and character selection
  3665. - graphicx: for including images
  3666. - grffile: allow periods and spaces in graphics file names
  3667. - longtable: For multipage tables
  3668. - wrapfig: for figure placement
  3669. - rotating: for sideways figures and tables
  3670. - ulem: for underline and strike-through
  3671. - amsmath: for subscript and superscript and math environments
  3672. - textcomp, amssymb: for various symbols used
  3673. for interpreting the entities in `org-entities'. You can skip
  3674. some of these packages if you don't use any of their symbols.
  3675. - capt-of: for captions outside of floats
  3676. - hyperref: for cross references
  3677. Therefore you should not modify this variable unless you know
  3678. what you are doing. The one reason to change it anyway is that
  3679. you might be loading some other package that conflicts with one
  3680. of the default packages. Each element is either a cell or
  3681. a string.
  3682. A cell is of the format
  3683. (\"options\" \"package\" SNIPPET-FLAG COMPILERS)
  3684. If SNIPPET-FLAG is non-nil, the package also needs to be included
  3685. when compiling LaTeX snippets into images for inclusion into
  3686. non-LaTeX output. COMPILERS is a list of compilers that should
  3687. include the package, see `org-latex-compiler'. If the document
  3688. compiler is not in the list, and the list is non-nil, the package
  3689. will not be inserted in the final document.
  3690. A string will be inserted as-is in the header of the document."
  3691. :group 'org-latex
  3692. :group 'org-export-latex
  3693. :set 'org-set-packages-alist
  3694. :get 'org-get-packages-alist
  3695. :version "25.2"
  3696. :package-version '(Org . "8.3")
  3697. :type '(repeat
  3698. (choice
  3699. (list :tag "options/package pair"
  3700. (string :tag "options")
  3701. (string :tag "package")
  3702. (boolean :tag "Snippet"))
  3703. (string :tag "A line of LaTeX"))))
  3704. (defcustom org-latex-packages-alist nil
  3705. "Alist of packages to be inserted in every LaTeX header.
  3706. These will be inserted after `org-latex-default-packages-alist'.
  3707. Each element is either a cell or a string.
  3708. A cell is of the format:
  3709. (\"options\" \"package\" SNIPPET-FLAG)
  3710. SNIPPET-FLAG, when non-nil, indicates that this package is also
  3711. needed when turning LaTeX snippets into images for inclusion into
  3712. non-LaTeX output.
  3713. A string will be inserted as-is in the header of the document.
  3714. Make sure that you only list packages here which:
  3715. - you want in every file;
  3716. - do not conflict with the setup in `org-format-latex-header';
  3717. - do not conflict with the default packages in
  3718. `org-latex-default-packages-alist'."
  3719. :group 'org-latex
  3720. :group 'org-export-latex
  3721. :set 'org-set-packages-alist
  3722. :get 'org-get-packages-alist
  3723. :type '(repeat
  3724. (choice
  3725. (list :tag "options/package pair"
  3726. (string :tag "options")
  3727. (string :tag "package")
  3728. (boolean :tag "Snippet"))
  3729. (string :tag "A line of LaTeX"))))
  3730. (defgroup org-appearance nil
  3731. "Settings for Org mode appearance."
  3732. :tag "Org Appearance"
  3733. :group 'org)
  3734. (defcustom org-level-color-stars-only nil
  3735. "Non-nil means fontify only the stars in each headline.
  3736. When nil, the entire headline is fontified.
  3737. Changing it requires restart of `font-lock-mode' to become effective
  3738. also in regions already fontified."
  3739. :group 'org-appearance
  3740. :type 'boolean)
  3741. (defcustom org-hide-leading-stars nil
  3742. "Non-nil means hide the first N-1 stars in a headline.
  3743. This works by using the face `org-hide' for these stars. This
  3744. face is white for a light background, and black for a dark
  3745. background. You may have to customize the face `org-hide' to
  3746. make this work.
  3747. Changing it requires restart of `font-lock-mode' to become effective
  3748. also in regions already fontified.
  3749. You may also set this on a per-file basis by adding one of the following
  3750. lines to the buffer:
  3751. #+STARTUP: hidestars
  3752. #+STARTUP: showstars"
  3753. :group 'org-appearance
  3754. :type 'boolean)
  3755. (defcustom org-hidden-keywords nil
  3756. "List of symbols corresponding to keywords to be hidden the org buffer.
  3757. For example, a value \\='(title) for this list will make the document's title
  3758. appear in the buffer without the initial #+TITLE: keyword."
  3759. :group 'org-appearance
  3760. :version "24.1"
  3761. :type '(set (const :tag "#+AUTHOR" author)
  3762. (const :tag "#+DATE" date)
  3763. (const :tag "#+EMAIL" email)
  3764. (const :tag "#+TITLE" title)))
  3765. (defcustom org-custom-properties nil
  3766. "List of properties (as strings) with a special meaning.
  3767. The default use of these custom properties is to let the user
  3768. hide them with `org-toggle-custom-properties-visibility'."
  3769. :group 'org-properties
  3770. :group 'org-appearance
  3771. :version "24.3"
  3772. :type '(repeat (string :tag "Property Name")))
  3773. (defcustom org-fontify-done-headline nil
  3774. "Non-nil means change the face of a headline if it is marked DONE.
  3775. Normally, only the TODO/DONE keyword indicates the state of a headline.
  3776. When this is non-nil, the headline after the keyword is set to the
  3777. `org-headline-done' as an additional indication."
  3778. :group 'org-appearance
  3779. :type 'boolean)
  3780. (defcustom org-fontify-emphasized-text t
  3781. "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
  3782. Changing this variable requires a restart of Emacs to take effect."
  3783. :group 'org-appearance
  3784. :type 'boolean)
  3785. (defcustom org-fontify-whole-heading-line nil
  3786. "Non-nil means fontify the whole line for headings.
  3787. This is useful when setting a background color for the
  3788. org-level-* faces."
  3789. :group 'org-appearance
  3790. :type 'boolean)
  3791. (defcustom org-highlight-latex-and-related nil
  3792. "Non-nil means highlight LaTeX related syntax in the buffer.
  3793. When non nil, the value should be a list containing any of the
  3794. following symbols:
  3795. `latex' Highlight LaTeX snippets and environments.
  3796. `script' Highlight subscript and superscript.
  3797. `entities' Highlight entities."
  3798. :group 'org-appearance
  3799. :version "24.4"
  3800. :package-version '(Org . "8.0")
  3801. :type '(choice
  3802. (const :tag "No highlighting" nil)
  3803. (set :greedy t :tag "Highlight"
  3804. (const :tag "LaTeX snippets and environments" latex)
  3805. (const :tag "Subscript and superscript" script)
  3806. (const :tag "Entities" entities))))
  3807. (defcustom org-hide-emphasis-markers nil
  3808. "Non-nil mean font-lock should hide the emphasis marker characters."
  3809. :group 'org-appearance
  3810. :type 'boolean)
  3811. (defcustom org-hide-macro-markers nil
  3812. "Non-nil mean font-lock should hide the brackets marking macro calls."
  3813. :group 'org-appearance
  3814. :type 'boolean)
  3815. (defcustom org-pretty-entities nil
  3816. "Non-nil means show entities as UTF8 characters.
  3817. When nil, the \\name form remains in the buffer."
  3818. :group 'org-appearance
  3819. :version "24.1"
  3820. :type 'boolean)
  3821. (defcustom org-pretty-entities-include-sub-superscripts t
  3822. "Non-nil means, pretty entity display includes formatting sub/superscripts."
  3823. :group 'org-appearance
  3824. :version "24.1"
  3825. :type 'boolean)
  3826. (defvar org-emph-re nil
  3827. "Regular expression for matching emphasis.
  3828. After a match, the match groups contain these elements:
  3829. 0 The match of the full regular expression, including the characters
  3830. before and after the proper match
  3831. 1 The character before the proper match, or empty at beginning of line
  3832. 2 The proper match, including the leading and trailing markers
  3833. 3 The leading marker like * or /, indicating the type of highlighting
  3834. 4 The text between the emphasis markers, not including the markers
  3835. 5 The character after the match, empty at the end of a line")
  3836. (defvar org-verbatim-re nil
  3837. "Regular expression for matching verbatim text.")
  3838. (defvar org-emphasis-regexp-components) ; defined just below
  3839. (defvar org-emphasis-alist) ; defined just below
  3840. (defun org-set-emph-re (var val)
  3841. "Set variable and compute the emphasis regular expression."
  3842. (set var val)
  3843. (when (and (boundp 'org-emphasis-alist)
  3844. (boundp 'org-emphasis-regexp-components)
  3845. org-emphasis-alist org-emphasis-regexp-components)
  3846. (pcase-let*
  3847. ((`(,pre ,post ,border ,body ,nl) org-emphasis-regexp-components)
  3848. (body (if (<= nl 0) body
  3849. (format "%s*?\\(?:\n%s*?\\)\\{0,%d\\}" body body nl)))
  3850. (template
  3851. (format (concat "\\([%s]\\|^\\)" ;before markers
  3852. "\\(\\([%%s]\\)\\([^%s]\\|[^%s]%s[^%s]\\)\\3\\)"
  3853. "\\([%s]\\|$\\)") ;after markers
  3854. pre border border body border post)))
  3855. (setq org-emph-re (format template "*/_+"))
  3856. (setq org-verbatim-re (format template "=~")))))
  3857. ;; This used to be a defcustom (Org <8.0) but allowing the users to
  3858. ;; set this option proved cumbersome. See this message/thread:
  3859. ;; http://article.gmane.org/gmane.emacs.orgmode/68681
  3860. (defvar org-emphasis-regexp-components
  3861. '(" \t('\"{" "- \t.,:!?;'\")}\\[" " \t\r\n" "." 1)
  3862. "Components used to build the regular expression for emphasis.
  3863. This is a list with five entries. Terminology: In an emphasis string
  3864. like \" *strong word* \", we call the initial space PREMATCH, the final
  3865. space POSTMATCH, the stars MARKERS, \"s\" and \"d\" are BORDER characters
  3866. and \"trong wor\" is the body. The different components in this variable
  3867. specify what is allowed/forbidden in each part:
  3868. pre Chars allowed as prematch. Beginning of line will be allowed too.
  3869. post Chars allowed as postmatch. End of line will be allowed too.
  3870. border The chars *forbidden* as border characters.
  3871. body-regexp A regexp like \".\" to match a body character. Don't use
  3872. non-shy groups here, and don't allow newline here.
  3873. newline The maximum number of newlines allowed in an emphasis exp.
  3874. You need to reload Org or to restart Emacs after customizing this.")
  3875. (defcustom org-emphasis-alist
  3876. '(("*" bold)
  3877. ("/" italic)
  3878. ("_" underline)
  3879. ("=" org-verbatim verbatim)
  3880. ("~" org-code verbatim)
  3881. ("+" (:strike-through t)))
  3882. "Alist of characters and faces to emphasize text.
  3883. Text starting and ending with a special character will be emphasized,
  3884. for example *bold*, _underlined_ and /italic/. This variable sets the
  3885. marker characters and the face to be used by font-lock for highlighting
  3886. in Org buffers.
  3887. You need to reload Org or to restart Emacs after customizing this."
  3888. :group 'org-appearance
  3889. :set 'org-set-emph-re
  3890. :version "24.4"
  3891. :package-version '(Org . "8.0")
  3892. :type '(repeat
  3893. (list
  3894. (string :tag "Marker character")
  3895. (choice
  3896. (face :tag "Font-lock-face")
  3897. (plist :tag "Face property list"))
  3898. (option (const verbatim)))))
  3899. (defvar org-protecting-blocks '("src" "example" "export")
  3900. "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
  3901. This is needed for font-lock setup.")
  3902. ;;; Functions and variables from their packages
  3903. ;; Declared here to avoid compiler warnings
  3904. (defvar mark-active)
  3905. ;; Various packages
  3906. (declare-function calc-eval "calc" (str &optional separator &rest args))
  3907. (declare-function calendar-forward-day "cal-move" (arg))
  3908. (declare-function calendar-goto-date "cal-move" (date))
  3909. (declare-function calendar-goto-today "cal-move" ())
  3910. (declare-function calendar-iso-from-absolute "cal-iso" (date))
  3911. (declare-function calendar-iso-to-absolute "cal-iso" (date))
  3912. (declare-function cdlatex-compute-tables "ext:cdlatex" ())
  3913. (declare-function cdlatex-tab "ext:cdlatex" ())
  3914. (declare-function dired-get-filename
  3915. "dired"
  3916. (&optional localp no-error-if-not-filep))
  3917. (declare-function iswitchb-read-buffer
  3918. "iswitchb"
  3919. (prompt &optional
  3920. default require-match _predicate start matches-set))
  3921. (declare-function org-agenda-change-all-lines
  3922. "org-agenda"
  3923. (newhead hdmarker &optional fixface just-this))
  3924. (declare-function org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
  3925. "org-agenda"
  3926. (&optional end))
  3927. (declare-function org-agenda-copy-local-variable "org-agenda" (var))
  3928. (declare-function org-agenda-format-item
  3929. "org-agenda"
  3930. (extra txt &optional level category tags dotime
  3931. remove-re habitp))
  3932. (declare-function org-agenda-maybe-redo "org-agenda" ())
  3933. (declare-function org-agenda-new-marker "org-agenda" (&optional pos))
  3934. (declare-function org-agenda-save-markers-for-cut-and-paste
  3935. "org-agenda"
  3936. (beg end))
  3937. (declare-function org-agenda-set-restriction-lock "org-agenda" (&optional type))
  3938. (declare-function org-agenda-skip "org-agenda" ())
  3939. (declare-function org-attach-reveal "org-attach" (&optional if-exists))
  3940. (declare-function org-gnus-follow-link "org-gnus" (&optional group article))
  3941. (declare-function org-indent-mode "org-indent" (&optional arg))
  3942. (declare-function org-inlinetask-goto-beginning "org-inlinetask" ())
  3943. (declare-function org-inlinetask-goto-end "org-inlinetask" ())
  3944. (declare-function org-inlinetask-in-task-p "org-inlinetask" ())
  3945. (declare-function org-inlinetask-remove-END-maybe "org-inlinetask" ())
  3946. (declare-function orgtbl-send-table "org-table" (&optional maybe))
  3947. (declare-function parse-time-string "parse-time" (string))
  3948. (declare-function speedbar-line-directory "speedbar" (&optional depth))
  3949. (defvar align-mode-rules-list)
  3950. (defvar calc-embedded-close-formula)
  3951. (defvar calc-embedded-open-formula)
  3952. (defvar calc-embedded-open-mode)
  3953. (defvar font-lock-unfontify-region-function)
  3954. (defvar iswitchb-temp-buflist)
  3955. (defvar org-agenda-tags-todo-honor-ignore-options)
  3956. (defvar remember-data-file)
  3957. (defvar texmathp-why)
  3958. ;;;###autoload
  3959. (defun turn-on-orgtbl ()
  3960. "Unconditionally turn on `orgtbl-mode'."
  3961. (require 'org-table)
  3962. (orgtbl-mode 1))
  3963. (defun org-at-table-p (&optional table-type)
  3964. "Non-nil if the cursor is inside an Org table.
  3965. If TABLE-TYPE is non-nil, also check for table.el-type tables.
  3966. If `org-enable-table-editor' is nil, return nil unconditionally."
  3967. (and
  3968. org-enable-table-editor
  3969. (save-excursion
  3970. (beginning-of-line)
  3971. (looking-at-p (if table-type "[ \t]*[|+]" "[ \t]*|")))
  3972. (or (not (derived-mode-p 'org-mode))
  3973. (let ((e (org-element-lineage (org-element-at-point) '(table) t)))
  3974. (and e (or table-type (eq (org-element-property :type e) 'org)))))))
  3975. (defun org-at-table.el-p ()
  3976. "Non-nil when point is at a table.el table."
  3977. (and (save-excursion (beginning-of-line) (looking-at "[ \t]*[|+]"))
  3978. (let ((element (org-element-at-point)))
  3979. (and (eq (org-element-type element) 'table)
  3980. (eq (org-element-property :type element) 'table.el)))))
  3981. (defun org-at-table-hline-p ()
  3982. "Non-nil when point is inside a hline in a table.
  3983. Assume point is already in a table. If `org-enable-table-editor'
  3984. is nil, return nil unconditionally."
  3985. (and org-enable-table-editor
  3986. (save-excursion
  3987. (beginning-of-line)
  3988. (looking-at org-table-hline-regexp))))
  3989. (defun org-table-map-tables (function &optional quietly)
  3990. "Apply FUNCTION to the start of all tables in the buffer."
  3991. (org-with-wide-buffer
  3992. (goto-char (point-min))
  3993. (while (re-search-forward org-table-any-line-regexp nil t)
  3994. (unless quietly
  3995. (message "Mapping tables: %d%%"
  3996. (floor (* 100.0 (point)) (buffer-size))))
  3997. (beginning-of-line 1)
  3998. (when (and (looking-at org-table-line-regexp)
  3999. ;; Exclude tables in src/example/verbatim/clocktable blocks
  4000. (not (org-in-block-p '("src" "example" "verbatim" "clocktable"))))
  4001. (save-excursion (funcall function))
  4002. (or (looking-at org-table-line-regexp)
  4003. (forward-char 1)))
  4004. (re-search-forward org-table-any-border-regexp nil 1)))
  4005. (unless quietly (message "Mapping tables: done")))
  4006. (declare-function org-clock-save-markers-for-cut-and-paste "org-clock" (beg end))
  4007. (declare-function org-clock-update-mode-line "org-clock" ())
  4008. (declare-function org-resolve-clocks "org-clock"
  4009. (&optional also-non-dangling-p prompt last-valid))
  4010. (defun org-at-TBLFM-p (&optional pos)
  4011. "Non-nil when point (or POS) is in #+TBLFM line."
  4012. (save-excursion
  4013. (goto-char (or pos (point)))
  4014. (beginning-of-line)
  4015. (and (let ((case-fold-search t)) (looking-at org-TBLFM-regexp))
  4016. (eq (org-element-type (org-element-at-point)) 'table))))
  4017. (defvar org-clock-start-time)
  4018. (defvar org-clock-marker (make-marker)
  4019. "Marker recording the last clock-in.")
  4020. (defvar org-clock-hd-marker (make-marker)
  4021. "Marker recording the last clock-in, but the headline position.")
  4022. (defvar org-clock-heading ""
  4023. "The heading of the current clock entry.")
  4024. (defun org-clock-is-active ()
  4025. "Return the buffer where the clock is currently running.
  4026. Return nil if no clock is running."
  4027. (marker-buffer org-clock-marker))
  4028. (defun org-check-running-clock ()
  4029. "Check if the current buffer contains the running clock.
  4030. If yes, offer to stop it and to save the buffer with the changes."
  4031. (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
  4032. (y-or-n-p (format "Clock-out in buffer %s before killing it? "
  4033. (buffer-name))))
  4034. (org-clock-out)
  4035. (when (y-or-n-p "Save changed buffer?")
  4036. (save-buffer))))
  4037. (defun org-clocktable-try-shift (dir n)
  4038. "Check if this line starts a clock table, if yes, shift the time block."
  4039. (when (org-match-line "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>")
  4040. (org-clocktable-shift dir n)))
  4041. ;;;###autoload
  4042. (defun org-clock-persistence-insinuate ()
  4043. "Set up hooks for clock persistence."
  4044. (require 'org-clock)
  4045. (add-hook 'org-mode-hook 'org-clock-load)
  4046. (add-hook 'kill-emacs-hook 'org-clock-save))
  4047. (defgroup org-archive nil
  4048. "Options concerning archiving in Org mode."
  4049. :tag "Org Archive"
  4050. :group 'org-structure)
  4051. (defcustom org-archive-location "%s_archive::"
  4052. "The location where subtrees should be archived.
  4053. The value of this variable is a string, consisting of two parts,
  4054. separated by a double-colon. The first part is a filename and
  4055. the second part is a headline.
  4056. When the filename is omitted, archiving happens in the same file.
  4057. %s in the filename will be replaced by the current file
  4058. name (without the directory part). Archiving to a different file
  4059. is useful to keep archived entries from contributing to the
  4060. Org Agenda.
  4061. The archived entries will be filed as subtrees of the specified
  4062. headline. When the headline is omitted, the subtrees are simply
  4063. filed away at the end of the file, as top-level entries. Also in
  4064. the heading you can use %s to represent the file name, this can be
  4065. useful when using the same archive for a number of different files.
  4066. Here are a few examples:
  4067. \"%s_archive::\"
  4068. If the current file is Projects.org, archive in file
  4069. Projects.org_archive, as top-level trees. This is the default.
  4070. \"::* Archived Tasks\"
  4071. Archive in the current file, under the top-level headline
  4072. \"* Archived Tasks\".
  4073. \"~/org/archive.org::\"
  4074. Archive in file ~/org/archive.org (absolute path), as top-level trees.
  4075. \"~/org/archive.org::* From %s\"
  4076. Archive in file ~/org/archive.org (absolute path), under headlines
  4077. \"From FILENAME\" where file name is the current file name.
  4078. \"~/org/datetree.org::datetree/* Finished Tasks\"
  4079. The \"datetree/\" string is special, signifying to archive
  4080. items to the datetree. Items are placed in either the CLOSED
  4081. date of the item, or the current date if there is no CLOSED date.
  4082. The heading will be a subentry to the current date. There doesn't
  4083. need to be a heading, but there always needs to be a slash after
  4084. datetree. For example, to store archived items directly in the
  4085. datetree, use \"~/org/datetree.org::datetree/\".
  4086. \"basement::** Finished Tasks\"
  4087. Archive in file ./basement (relative path), as level 3 trees
  4088. below the level 2 heading \"** Finished Tasks\".
  4089. You may set this option on a per-file basis by adding to the buffer a
  4090. line like
  4091. #+ARCHIVE: basement::** Finished Tasks
  4092. You may also define it locally for a subtree by setting an ARCHIVE property
  4093. in the entry. If such a property is found in an entry, or anywhere up
  4094. the hierarchy, it will be used."
  4095. :group 'org-archive
  4096. :type 'string)
  4097. (defcustom org-agenda-skip-archived-trees t
  4098. "Non-nil means the agenda will skip any items located in archived trees.
  4099. An archived tree is a tree marked with the tag ARCHIVE. The use of this
  4100. variable is no longer recommended, you should leave it at the value t.
  4101. Instead, use the key `v' to cycle the archives-mode in the agenda."
  4102. :group 'org-archive
  4103. :group 'org-agenda-skip
  4104. :type 'boolean)
  4105. (defcustom org-columns-skip-archived-trees t
  4106. "Non-nil means ignore archived trees when creating column view."
  4107. :group 'org-archive
  4108. :group 'org-properties
  4109. :type 'boolean)
  4110. (defcustom org-cycle-open-archived-trees nil
  4111. "Non-nil means `org-cycle' will open archived trees.
  4112. An archived tree is a tree marked with the tag ARCHIVE.
  4113. When nil, archived trees will stay folded. You can still open them with
  4114. normal outline commands like `show-all', but not with the cycling commands."
  4115. :group 'org-archive
  4116. :group 'org-cycle
  4117. :type 'boolean)
  4118. (defcustom org-sparse-tree-open-archived-trees nil
  4119. "Non-nil means sparse tree construction shows matches in archived trees.
  4120. When nil, matches in these trees are highlighted, but the trees are kept in
  4121. collapsed state."
  4122. :group 'org-archive
  4123. :group 'org-sparse-trees
  4124. :type 'boolean)
  4125. (defcustom org-sparse-tree-default-date-type nil
  4126. "The default date type when building a sparse tree.
  4127. When this is nil, a date is a scheduled or a deadline timestamp.
  4128. Otherwise, these types are allowed:
  4129. all: all timestamps
  4130. active: only active timestamps (<...>)
  4131. inactive: only inactive timestamps ([...])
  4132. scheduled: only scheduled timestamps
  4133. deadline: only deadline timestamps"
  4134. :type '(choice (const :tag "Scheduled or deadline" nil)
  4135. (const :tag "All timestamps" all)
  4136. (const :tag "Only active timestamps" active)
  4137. (const :tag "Only inactive timestamps" inactive)
  4138. (const :tag "Only scheduled timestamps" scheduled)
  4139. (const :tag "Only deadline timestamps" deadline)
  4140. (const :tag "Only closed timestamps" closed))
  4141. :version "25.2"
  4142. :package-version '(Org . "8.3")
  4143. :group 'org-sparse-trees)
  4144. (defun org-cycle-hide-archived-subtrees (state)
  4145. "Re-hide all archived subtrees after a visibility state change."
  4146. (when (and (not org-cycle-open-archived-trees)
  4147. (not (memq state '(overview folded))))
  4148. (save-excursion
  4149. (let* ((globalp (memq state '(contents all)))
  4150. (beg (if globalp (point-min) (point)))
  4151. (end (if globalp (point-max) (org-end-of-subtree t))))
  4152. (org-hide-archived-subtrees beg end)
  4153. (goto-char beg)
  4154. (when (looking-at-p (concat ".*:" org-archive-tag ":"))
  4155. (message "%s" (substitute-command-keys
  4156. "Subtree is archived and stays closed. Use \
  4157. `\\[org-force-cycle-archived]' to cycle it anyway.")))))))
  4158. (defun org-force-cycle-archived ()
  4159. "Cycle subtree even if it is archived."
  4160. (interactive)
  4161. (setq this-command 'org-cycle)
  4162. (let ((org-cycle-open-archived-trees t))
  4163. (call-interactively 'org-cycle)))
  4164. (defun org-hide-archived-subtrees (beg end)
  4165. "Re-hide all archived subtrees after a visibility state change."
  4166. (org-with-wide-buffer
  4167. (let ((case-fold-search nil)
  4168. (re (concat org-outline-regexp-bol ".*:" org-archive-tag ":")))
  4169. (goto-char beg)
  4170. ;; Include headline point is currently on.
  4171. (beginning-of-line)
  4172. (while (and (< (point) end) (re-search-forward re end t))
  4173. (when (member org-archive-tag (org-get-tags))
  4174. (org-flag-subtree t)
  4175. (org-end-of-subtree t))))))
  4176. (declare-function outline-end-of-heading "outline" ())
  4177. (declare-function outline-flag-region "outline" (from to flag))
  4178. (defun org-flag-subtree (flag)
  4179. (save-excursion
  4180. (org-back-to-heading t)
  4181. (outline-end-of-heading)
  4182. (outline-flag-region (point)
  4183. (progn (org-end-of-subtree t) (point))
  4184. flag)))
  4185. (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
  4186. ;; Declare Column View Code
  4187. (declare-function org-columns-get-format-and-top-level "org-colview" ())
  4188. (declare-function org-columns-compute "org-colview" (property))
  4189. ;; Declare ID code
  4190. (declare-function org-id-store-link "org-id")
  4191. (declare-function org-id-locations-load "org-id")
  4192. (declare-function org-id-locations-save "org-id")
  4193. (defvar org-id-track-globally)
  4194. ;;; Variables for pre-computed regular expressions, all buffer local
  4195. (defvar-local org-todo-regexp nil
  4196. "Matches any of the TODO state keywords.
  4197. Since TODO keywords are case-sensitive, `case-fold-search' is
  4198. expected to be bound to nil when matching against this regexp.")
  4199. (defvar-local org-not-done-regexp nil
  4200. "Matches any of the TODO state keywords except the last one.
  4201. Since TODO keywords are case-sensitive, `case-fold-search' is
  4202. expected to be bound to nil when matching against this regexp.")
  4203. (defvar-local org-not-done-heading-regexp nil
  4204. "Matches a TODO headline that is not done.
  4205. Since TODO keywords are case-sensitive, `case-fold-search' is
  4206. expected to be bound to nil when matching against this regexp.")
  4207. (defvar-local org-todo-line-regexp nil
  4208. "Matches a headline and puts TODO state into group 2 if present.
  4209. Since TODO keywords are case-sensitive, `case-fold-search' is
  4210. expected to be bound to nil when matching against this regexp.")
  4211. (defvar-local org-complex-heading-regexp nil
  4212. "Matches a headline and puts everything into groups:
  4213. group 1: Stars
  4214. group 2: The TODO keyword, maybe
  4215. group 3: Priority cookie
  4216. group 4: True headline
  4217. group 5: Tags
  4218. Since TODO keywords are case-sensitive, `case-fold-search' is
  4219. expected to be bound to nil when matching against this regexp.")
  4220. (defvar-local org-complex-heading-regexp-format nil
  4221. "Printf format to make regexp to match an exact headline.
  4222. This regexp will match the headline of any node which has the
  4223. exact headline text that is put into the format, but may have any
  4224. TODO state, priority and tags.")
  4225. (defvar-local org-todo-line-tags-regexp nil
  4226. "Matches a headline and puts TODO state into group 2 if present.
  4227. Also put tags into group 4 if tags are present.")
  4228. (defconst org-plain-time-of-day-regexp
  4229. (concat
  4230. "\\(\\<[012]?[0-9]"
  4231. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  4232. "\\(--?"
  4233. "\\(\\<[012]?[0-9]"
  4234. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  4235. "\\)?")
  4236. "Regular expression to match a plain time or time range.
  4237. Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
  4238. groups carry important information:
  4239. 0 the full match
  4240. 1 the first time, range or not
  4241. 8 the second time, if it is a range.")
  4242. (defconst org-plain-time-extension-regexp
  4243. (concat
  4244. "\\(\\<[012]?[0-9]"
  4245. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  4246. "\\+\\([0-9]+\\)\\(:\\([0-5][0-9]\\)\\)?")
  4247. "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
  4248. Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
  4249. groups carry important information:
  4250. 0 the full match
  4251. 7 hours of duration
  4252. 9 minutes of duration")
  4253. (defconst org-stamp-time-of-day-regexp
  4254. (concat
  4255. "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} +\\sw+ +\\)"
  4256. "\\([012][0-9]:[0-5][0-9]\\(-\\([012][0-9]:[0-5][0-9]\\)\\)?[^\n\r>]*?\\)>"
  4257. "\\(--?"
  4258. "<\\1\\([012][0-9]:[0-5][0-9]\\)>\\)?")
  4259. "Regular expression to match a timestamp time or time range.
  4260. After a match, the following groups carry important information:
  4261. 0 the full match
  4262. 1 date plus weekday, for back referencing to make sure both times are on the same day
  4263. 2 the first time, range or not
  4264. 4 the second time, if it is a range.")
  4265. (defconst org-startup-options
  4266. '(("fold" org-startup-folded t)
  4267. ("overview" org-startup-folded t)
  4268. ("nofold" org-startup-folded nil)
  4269. ("showall" org-startup-folded nil)
  4270. ("showeverything" org-startup-folded showeverything)
  4271. ("content" org-startup-folded content)
  4272. ("indent" org-startup-indented t)
  4273. ("noindent" org-startup-indented nil)
  4274. ("hidestars" org-hide-leading-stars t)
  4275. ("showstars" org-hide-leading-stars nil)
  4276. ("odd" org-odd-levels-only t)
  4277. ("oddeven" org-odd-levels-only nil)
  4278. ("align" org-startup-align-all-tables t)
  4279. ("noalign" org-startup-align-all-tables nil)
  4280. ("inlineimages" org-startup-with-inline-images t)
  4281. ("noinlineimages" org-startup-with-inline-images nil)
  4282. ("latexpreview" org-startup-with-latex-preview t)
  4283. ("nolatexpreview" org-startup-with-latex-preview nil)
  4284. ("customtime" org-display-custom-times t)
  4285. ("logdone" org-log-done time)
  4286. ("lognotedone" org-log-done note)
  4287. ("nologdone" org-log-done nil)
  4288. ("lognoteclock-out" org-log-note-clock-out t)
  4289. ("nolognoteclock-out" org-log-note-clock-out nil)
  4290. ("logrepeat" org-log-repeat state)
  4291. ("lognoterepeat" org-log-repeat note)
  4292. ("logdrawer" org-log-into-drawer t)
  4293. ("nologdrawer" org-log-into-drawer nil)
  4294. ("logstatesreversed" org-log-states-order-reversed t)
  4295. ("nologstatesreversed" org-log-states-order-reversed nil)
  4296. ("nologrepeat" org-log-repeat nil)
  4297. ("logreschedule" org-log-reschedule time)
  4298. ("lognotereschedule" org-log-reschedule note)
  4299. ("nologreschedule" org-log-reschedule nil)
  4300. ("logredeadline" org-log-redeadline time)
  4301. ("lognoteredeadline" org-log-redeadline note)
  4302. ("nologredeadline" org-log-redeadline nil)
  4303. ("logrefile" org-log-refile time)
  4304. ("lognoterefile" org-log-refile note)
  4305. ("nologrefile" org-log-refile nil)
  4306. ("fninline" org-footnote-define-inline t)
  4307. ("nofninline" org-footnote-define-inline nil)
  4308. ("fnlocal" org-footnote-section nil)
  4309. ("fnauto" org-footnote-auto-label t)
  4310. ("fnprompt" org-footnote-auto-label nil)
  4311. ("fnconfirm" org-footnote-auto-label confirm)
  4312. ("fnplain" org-footnote-auto-label plain)
  4313. ("fnadjust" org-footnote-auto-adjust t)
  4314. ("nofnadjust" org-footnote-auto-adjust nil)
  4315. ("constcgs" constants-unit-system cgs)
  4316. ("constSI" constants-unit-system SI)
  4317. ("noptag" org-tag-persistent-alist nil)
  4318. ("hideblocks" org-hide-block-startup t)
  4319. ("nohideblocks" org-hide-block-startup nil)
  4320. ("beamer" org-startup-with-beamer-mode t)
  4321. ("entitiespretty" org-pretty-entities t)
  4322. ("entitiesplain" org-pretty-entities nil))
  4323. "Variable associated with STARTUP options for org-mode.
  4324. Each element is a list of three items: the startup options (as written
  4325. in the #+STARTUP line), the corresponding variable, and the value to set
  4326. this variable to if the option is found. An optional forth element PUSH
  4327. means to push this value onto the list in the variable.")
  4328. (defcustom org-group-tags t
  4329. "When non-nil (the default), use group tags.
  4330. This can be turned on/off through `org-toggle-tags-groups'."
  4331. :group 'org-tags
  4332. :group 'org-startup
  4333. :type 'boolean)
  4334. (defvar org-inhibit-startup nil) ; Dynamically-scoped param.
  4335. (defun org-toggle-tags-groups ()
  4336. "Toggle support for group tags.
  4337. Support for group tags is controlled by the option
  4338. `org-group-tags', which is non-nil by default."
  4339. (interactive)
  4340. (setq org-group-tags (not org-group-tags))
  4341. (cond ((and (derived-mode-p 'org-agenda-mode)
  4342. org-group-tags)
  4343. (org-agenda-redo))
  4344. ((derived-mode-p 'org-mode)
  4345. (let ((org-inhibit-startup t)) (org-mode))))
  4346. (message "Groups tags support has been turned %s"
  4347. (if org-group-tags "on" "off")))
  4348. (defun org-set-regexps-and-options (&optional tags-only)
  4349. "Precompute regular expressions used in the current buffer.
  4350. When optional argument TAGS-ONLY is non-nil, only compute tags
  4351. related expressions."
  4352. (when (derived-mode-p 'org-mode)
  4353. (let ((alist (org--setup-collect-keywords
  4354. (org-make-options-regexp
  4355. (append '("FILETAGS" "TAGS" "SETUPFILE")
  4356. (and (not tags-only)
  4357. '("ARCHIVE" "CATEGORY" "COLUMNS" "CONSTANTS"
  4358. "LINK" "OPTIONS" "PRIORITIES" "PROPERTY"
  4359. "SEQ_TODO" "STARTUP" "TODO" "TYP_TODO")))))))
  4360. ;; Startup options. Get this early since it does change
  4361. ;; behavior for other options (e.g., tags).
  4362. (let ((startup (cdr (assq 'startup alist))))
  4363. (dolist (option startup)
  4364. (let ((entry (assoc-string option org-startup-options t)))
  4365. (when entry
  4366. (let ((var (nth 1 entry))
  4367. (val (nth 2 entry)))
  4368. (if (not (nth 3 entry)) (set (make-local-variable var) val)
  4369. (unless (listp (symbol-value var))
  4370. (set (make-local-variable var) nil))
  4371. (add-to-list var val)))))))
  4372. (setq-local org-file-tags
  4373. (mapcar #'org-add-prop-inherited
  4374. (cdr (assq 'filetags alist))))
  4375. (setq org-current-tag-alist
  4376. (append org-tag-persistent-alist
  4377. (let ((tags (cdr (assq 'tags alist))))
  4378. (if tags (org-tag-string-to-alist tags)
  4379. org-tag-alist))))
  4380. (setq org-tag-groups-alist
  4381. (org-tag-alist-to-groups org-current-tag-alist))
  4382. (unless tags-only
  4383. ;; File properties.
  4384. (setq-local org-file-properties (cdr (assq 'property alist)))
  4385. ;; Archive location.
  4386. (let ((archive (cdr (assq 'archive alist))))
  4387. (when archive (setq-local org-archive-location archive)))
  4388. ;; Category.
  4389. (let ((cat (org-string-nw-p (cdr (assq 'category alist)))))
  4390. (when cat
  4391. (setq-local org-category (intern cat))
  4392. (setq-local org-file-properties
  4393. (org--update-property-plist
  4394. "CATEGORY" cat org-file-properties))))
  4395. ;; Columns.
  4396. (let ((column (cdr (assq 'columns alist))))
  4397. (when column (setq-local org-columns-default-format column)))
  4398. ;; Constants.
  4399. (setq org-table-formula-constants-local (cdr (assq 'constants alist)))
  4400. ;; Link abbreviations.
  4401. (let ((links (cdr (assq 'link alist))))
  4402. (when links (setq org-link-abbrev-alist-local (nreverse links))))
  4403. ;; Priorities.
  4404. (let ((priorities (cdr (assq 'priorities alist))))
  4405. (when priorities
  4406. (setq-local org-highest-priority (nth 0 priorities))
  4407. (setq-local org-lowest-priority (nth 1 priorities))
  4408. (setq-local org-default-priority (nth 2 priorities))))
  4409. ;; Scripts.
  4410. (let ((scripts (assq 'scripts alist)))
  4411. (when scripts
  4412. (setq-local org-use-sub-superscripts (cdr scripts))))
  4413. ;; TODO keywords.
  4414. (setq-local org-todo-kwd-alist nil)
  4415. (setq-local org-todo-key-alist nil)
  4416. (setq-local org-todo-key-trigger nil)
  4417. (setq-local org-todo-keywords-1 nil)
  4418. (setq-local org-done-keywords nil)
  4419. (setq-local org-todo-heads nil)
  4420. (setq-local org-todo-sets nil)
  4421. (setq-local org-todo-log-states nil)
  4422. (let ((todo-sequences
  4423. (or (nreverse (cdr (assq 'todo alist)))
  4424. (let ((d (default-value 'org-todo-keywords)))
  4425. (if (not (stringp (car d))) d
  4426. ;; XXX: Backward compatibility code.
  4427. (list (cons org-todo-interpretation d)))))))
  4428. (dolist (sequence todo-sequences)
  4429. (let* ((sequence (or (run-hook-with-args-until-success
  4430. 'org-todo-setup-filter-hook sequence)
  4431. sequence))
  4432. (sequence-type (car sequence))
  4433. (keywords (cdr sequence))
  4434. (sep (member "|" keywords))
  4435. names alist)
  4436. (dolist (k (remove "|" keywords))
  4437. (unless (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?.*?)\\)?$"
  4438. k)
  4439. (error "Invalid TODO keyword %s" k))
  4440. (let ((name (match-string 1 k))
  4441. (key (match-string 2 k))
  4442. (log (org-extract-log-state-settings k)))
  4443. (push name names)
  4444. (push (cons name (and key (string-to-char key))) alist)
  4445. (when log (push log org-todo-log-states))))
  4446. (let* ((names (nreverse names))
  4447. (done (if sep (org-remove-keyword-keys (cdr sep))
  4448. (last names)))
  4449. (head (car names))
  4450. (tail (list sequence-type head (car done) (org-last done))))
  4451. (add-to-list 'org-todo-heads head 'append)
  4452. (push names org-todo-sets)
  4453. (setq org-done-keywords (append org-done-keywords done nil))
  4454. (setq org-todo-keywords-1 (append org-todo-keywords-1 names nil))
  4455. (setq org-todo-key-alist
  4456. (append org-todo-key-alist
  4457. (and alist
  4458. (append '((:startgroup))
  4459. (nreverse alist)
  4460. '((:endgroup))))))
  4461. (dolist (k names) (push (cons k tail) org-todo-kwd-alist))))))
  4462. (setq org-todo-sets (nreverse org-todo-sets)
  4463. org-todo-kwd-alist (nreverse org-todo-kwd-alist)
  4464. org-todo-key-trigger (delq nil (mapcar #'cdr org-todo-key-alist))
  4465. org-todo-key-alist (org-assign-fast-keys org-todo-key-alist))
  4466. ;; Compute the regular expressions and other local variables.
  4467. ;; Using `org-outline-regexp-bol' would complicate them much,
  4468. ;; because of the fixed white space at the end of that string.
  4469. (unless org-done-keywords
  4470. (setq org-done-keywords
  4471. (and org-todo-keywords-1 (last org-todo-keywords-1))))
  4472. (setq org-not-done-keywords
  4473. (org-delete-all org-done-keywords
  4474. (copy-sequence org-todo-keywords-1))
  4475. org-todo-regexp (regexp-opt org-todo-keywords-1 t)
  4476. org-not-done-regexp (regexp-opt org-not-done-keywords t)
  4477. org-not-done-heading-regexp
  4478. (format org-heading-keyword-regexp-format org-not-done-regexp)
  4479. org-todo-line-regexp
  4480. (format org-heading-keyword-maybe-regexp-format org-todo-regexp)
  4481. org-complex-heading-regexp
  4482. (concat "^\\(\\*+\\)"
  4483. "\\(?: +" org-todo-regexp "\\)?"
  4484. "\\(?: +\\(\\[#.\\]\\)\\)?"
  4485. "\\(?: +\\(.*?\\)\\)??"
  4486. "\\(?:[ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)?"
  4487. "[ \t]*$")
  4488. org-complex-heading-regexp-format
  4489. (concat "^\\(\\*+\\)"
  4490. "\\(?: +" org-todo-regexp "\\)?"
  4491. "\\(?: +\\(\\[#.\\]\\)\\)?"
  4492. "\\(?: +"
  4493. ;; Stats cookies can be stuck to body.
  4494. "\\(?:\\[[0-9%%/]+\\] *\\)*"
  4495. "\\(%s\\)"
  4496. "\\(?: *\\[[0-9%%/]+\\]\\)*"
  4497. "\\)"
  4498. "\\(?:[ \t]+\\(:[[:alnum:]_@#%%:]+:\\)\\)?"
  4499. "[ \t]*$")
  4500. org-todo-line-tags-regexp
  4501. (concat "^\\(\\*+\\)"
  4502. "\\(?: +" org-todo-regexp "\\)?"
  4503. "\\(?: +\\(.*?\\)\\)??"
  4504. "\\(?:[ \t]+\\(:[[:alnum:]:_@#%]+:\\)\\)?"
  4505. "[ \t]*$"))
  4506. (org-compute-latex-and-related-regexp)))))
  4507. (defun org--setup-collect-keywords (regexp &optional files alist)
  4508. "Return setup keywords values as an alist.
  4509. REGEXP matches a subset of setup keywords. FILES is a list of
  4510. file names already visited. It is used to avoid circular setup
  4511. files. ALIST, when non-nil, is the alist computed so far.
  4512. Return value contains the following keys: `archive', `category',
  4513. `columns', `constants', `filetags', `link', `priorities',
  4514. `property', `scripts', `startup', `tags' and `todo'."
  4515. (org-with-wide-buffer
  4516. (goto-char (point-min))
  4517. (let ((case-fold-search t))
  4518. (while (re-search-forward regexp nil t)
  4519. (let ((element (org-element-at-point)))
  4520. (when (eq (org-element-type element) 'keyword)
  4521. (let ((key (org-element-property :key element))
  4522. (value (org-element-property :value element)))
  4523. (cond
  4524. ((equal key "ARCHIVE")
  4525. (when (org-string-nw-p value)
  4526. (push (cons 'archive value) alist)))
  4527. ((equal key "CATEGORY") (push (cons 'category value) alist))
  4528. ((equal key "COLUMNS") (push (cons 'columns value) alist))
  4529. ((equal key "CONSTANTS")
  4530. (let* ((constants (assq 'constants alist))
  4531. (store (cdr constants)))
  4532. (dolist (pair (org-split-string value))
  4533. (when (string-match "^\\([a-zA-Z0][_a-zA-Z0-9]*\\)=\\(.*\\)"
  4534. pair)
  4535. (let* ((name (match-string 1 pair))
  4536. (value (match-string 2 pair))
  4537. (old (assoc name store)))
  4538. (if old (setcdr old value)
  4539. (push (cons name value) store)))))
  4540. (if constants (setcdr constants store)
  4541. (push (cons 'constants store) alist))))
  4542. ((equal key "FILETAGS")
  4543. (when (org-string-nw-p value)
  4544. (let ((old (assq 'filetags alist))
  4545. (new (apply #'nconc
  4546. (mapcar (lambda (x) (org-split-string x ":"))
  4547. (org-split-string value)))))
  4548. (if old (setcdr old (append new (cdr old)))
  4549. (push (cons 'filetags new) alist)))))
  4550. ((equal key "LINK")
  4551. (when (string-match "\\`\\(\\S-+\\)[ \t]+\\(.+\\)" value)
  4552. (let ((links (assq 'link alist))
  4553. (pair (cons (match-string-no-properties 1 value)
  4554. (match-string-no-properties 2 value))))
  4555. (if links (push pair (cdr links))
  4556. (push (list 'link pair) alist)))))
  4557. ((equal key "OPTIONS")
  4558. (when (and (org-string-nw-p value)
  4559. (string-match "\\^:\\(t\\|nil\\|{}\\)" value))
  4560. (push (cons 'scripts (read (match-string 1 value))) alist)))
  4561. ((equal key "PRIORITIES")
  4562. (push (cons 'priorities
  4563. (let ((prio (org-split-string value)))
  4564. (if (< (length prio) 3) '(?A ?C ?B)
  4565. (mapcar #'string-to-char prio))))
  4566. alist))
  4567. ((equal key "PROPERTY")
  4568. (when (string-match "\\(\\S-+\\)[ \t]+\\(.*\\)" value)
  4569. (let* ((property (assq 'property alist))
  4570. (value (org--update-property-plist
  4571. (match-string-no-properties 1 value)
  4572. (match-string-no-properties 2 value)
  4573. (cdr property))))
  4574. (if property (setcdr property value)
  4575. (push (cons 'property value) alist)))))
  4576. ((equal key "STARTUP")
  4577. (let ((startup (assq 'startup alist)))
  4578. (if startup
  4579. (setcdr startup
  4580. (append (cdr startup) (org-split-string value)))
  4581. (push (cons 'startup (org-split-string value)) alist))))
  4582. ((equal key "TAGS")
  4583. (let ((tag-cell (assq 'tags alist)))
  4584. (if tag-cell
  4585. (setcdr tag-cell (concat (cdr tag-cell) "\n" value))
  4586. (push (cons 'tags value) alist))))
  4587. ((member key '("TODO" "SEQ_TODO" "TYP_TODO"))
  4588. (let ((todo (assq 'todo alist))
  4589. (value (cons (if (equal key "TYP_TODO") 'type 'sequence)
  4590. (org-split-string value))))
  4591. (if todo (push value (cdr todo))
  4592. (push (list 'todo value) alist))))
  4593. ((equal key "SETUPFILE")
  4594. (unless buffer-read-only ; Do not check in Gnus messages.
  4595. (let ((f (and (org-string-nw-p value)
  4596. (expand-file-name
  4597. (org-unbracket-string "\"" "\"" value)))))
  4598. (when (and f (file-readable-p f) (not (member f files)))
  4599. (with-temp-buffer
  4600. (setq default-directory (file-name-directory f))
  4601. (insert-file-contents f)
  4602. (setq alist
  4603. ;; Fake Org mode to benefit from cache
  4604. ;; without recurring needlessly.
  4605. (let ((major-mode 'org-mode))
  4606. (org--setup-collect-keywords
  4607. regexp (cons f files) alist)))))))))))))))
  4608. alist)
  4609. (defun org-tag-string-to-alist (s)
  4610. "Return tag alist associated to string S.
  4611. S is a value for TAGS keyword or produced with
  4612. `org-tag-alist-to-string'. Return value is an alist suitable for
  4613. `org-tag-alist' or `org-tag-persistent-alist'."
  4614. (let ((lines (mapcar #'split-string (split-string s "\n" t)))
  4615. (tag-re (concat "\\`\\([[:alnum:]_@#%]+"
  4616. "\\|{.+?}\\)" ; regular expression
  4617. "\\(?:(\\(.\\))\\)?\\'"))
  4618. alist group-flag)
  4619. (dolist (tokens lines (cdr (nreverse alist)))
  4620. (push '(:newline) alist)
  4621. (while tokens
  4622. (let ((token (pop tokens)))
  4623. (pcase token
  4624. ("{"
  4625. (push '(:startgroup) alist)
  4626. (when (equal (nth 1 tokens) ":") (setq group-flag t)))
  4627. ("}"
  4628. (push '(:endgroup) alist)
  4629. (setq group-flag nil))
  4630. ("["
  4631. (push '(:startgrouptag) alist)
  4632. (when (equal (nth 1 tokens) ":") (setq group-flag t)))
  4633. ("]"
  4634. (push '(:endgrouptag) alist)
  4635. (setq group-flag nil))
  4636. (":"
  4637. (push '(:grouptags) alist))
  4638. ((guard (string-match tag-re token))
  4639. (let ((tag (match-string 1 token))
  4640. (key (and (match-beginning 2)
  4641. (string-to-char (match-string 2 token)))))
  4642. ;; Push all tags in groups, no matter if they already
  4643. ;; appear somewhere else in the list.
  4644. (when (or group-flag (not (assoc tag alist)))
  4645. (push (cons tag key) alist))))))))))
  4646. (defun org-tag-alist-to-string (alist &optional skip-key)
  4647. "Return tag string associated to ALIST.
  4648. ALIST is an alist, as defined in `org-tag-alist' or
  4649. `org-tag-persistent-alist', or produced with
  4650. `org-tag-string-to-alist'.
  4651. Return value is a string suitable as a value for \"TAGS\"
  4652. keyword.
  4653. When optional argument SKIP-KEY is non-nil, skip selection keys
  4654. next to tags."
  4655. (mapconcat (lambda (token)
  4656. (pcase token
  4657. (`(:startgroup) "{")
  4658. (`(:endgroup) "}")
  4659. (`(:startgrouptag) "[")
  4660. (`(:endgrouptag) "]")
  4661. (`(:grouptags) ":")
  4662. (`(:newline) "\\n")
  4663. ((and
  4664. (guard (not skip-key))
  4665. `(,(and tag (pred stringp)) . ,(and key (pred characterp))))
  4666. (format "%s(%c)" tag key))
  4667. (`(,(and tag (pred stringp)) . ,_) tag)
  4668. (_ (user-error "Invalid tag token: %S" token))))
  4669. alist
  4670. " "))
  4671. (defun org-tag-alist-to-groups (alist)
  4672. "Return group alist from tag ALIST.
  4673. ALIST is an alist, as defined in `org-tag-alist' or
  4674. `org-tag-persistent-alist', or produced with
  4675. `org-tag-string-to-alist'. Return value is an alist following
  4676. the pattern (GROUP-TAG TAGS) where GROUP-TAG is the tag, as
  4677. a string, summarizing TAGS, as a list of strings."
  4678. (let (groups group-status current-group)
  4679. (dolist (token alist (nreverse groups))
  4680. (pcase token
  4681. (`(,(or :startgroup :startgrouptag)) (setq group-status t))
  4682. (`(,(or :endgroup :endgrouptag))
  4683. (when (eq group-status 'append)
  4684. (push (nreverse current-group) groups))
  4685. (setq group-status nil))
  4686. (`(:grouptags) (setq group-status 'append))
  4687. ((and `(,tag . ,_) (guard group-status))
  4688. (if (eq group-status 'append) (push tag current-group)
  4689. (setq current-group (list tag))))
  4690. (_ nil)))))
  4691. (defun org-file-contents (file &optional noerror)
  4692. "Return the contents of FILE, as a string."
  4693. (if (and file (file-readable-p file))
  4694. (with-temp-buffer
  4695. (insert-file-contents file)
  4696. (buffer-string))
  4697. (funcall (if noerror 'message 'error)
  4698. "Cannot read file \"%s\"%s"
  4699. file
  4700. (let ((from (buffer-file-name (buffer-base-buffer))))
  4701. (if from (concat " (referenced in file \"" from "\")") "")))))
  4702. (defun org-extract-log-state-settings (x)
  4703. "Extract the log state setting from a TODO keyword string.
  4704. This will extract info from a string like \"WAIT(w@/!)\"."
  4705. (when (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?\\([!@]\\)?\\(?:/\\([!@]\\)\\)?)\\)?$" x)
  4706. (let ((kw (match-string 1 x))
  4707. (log1 (and (match-end 3) (match-string 3 x)))
  4708. (log2 (and (match-end 4) (match-string 4 x))))
  4709. (and (or log1 log2)
  4710. (list kw
  4711. (and log1 (if (equal log1 "!") 'time 'note))
  4712. (and log2 (if (equal log2 "!") 'time 'note)))))))
  4713. (defun org-remove-keyword-keys (list)
  4714. "Remove a pair of parenthesis at the end of each string in LIST."
  4715. (mapcar (lambda (x)
  4716. (if (string-match "(.*)$" x)
  4717. (substring x 0 (match-beginning 0))
  4718. x))
  4719. list))
  4720. (defun org-assign-fast-keys (alist)
  4721. "Assign fast keys to a keyword-key alist.
  4722. Respect keys that are already there."
  4723. (let (new e (alt ?0))
  4724. (while (setq e (pop alist))
  4725. (if (or (memq (car e) '(:newline :grouptags :endgroup :startgroup))
  4726. (cdr e)) ;; Key already assigned.
  4727. (push e new)
  4728. (let ((clist (string-to-list (downcase (car e))))
  4729. (used (append new alist)))
  4730. (when (= (car clist) ?@)
  4731. (pop clist))
  4732. (while (and clist (rassoc (car clist) used))
  4733. (pop clist))
  4734. (unless clist
  4735. (while (rassoc alt used)
  4736. (cl-incf alt)))
  4737. (push (cons (car e) (or (car clist) alt)) new))))
  4738. (nreverse new)))
  4739. ;;; Some variables used in various places
  4740. (defvar org-window-configuration nil
  4741. "Used in various places to store a window configuration.")
  4742. (defvar org-selected-window nil
  4743. "Used in various places to store a window configuration.")
  4744. (defvar org-finish-function nil
  4745. "Function to be called when `C-c C-c' is used.
  4746. This is for getting out of special buffers like capture.")
  4747. (defvar org-last-state)
  4748. ;; Defined somewhere in this file, but used before definition.
  4749. (defvar org-entities) ;; defined in org-entities.el
  4750. (defvar org-struct-menu)
  4751. (defvar org-org-menu)
  4752. (defvar org-tbl-menu)
  4753. ;;;; Define the Org mode
  4754. ;; We use a before-change function to check if a table might need
  4755. ;; an update.
  4756. (defvar org-table-may-need-update t
  4757. "Indicates that a table might need an update.
  4758. This variable is set by `org-before-change-function'.
  4759. `org-table-align' sets it back to nil.")
  4760. (defun org-before-change-function (_beg _end)
  4761. "Every change indicates that a table might need an update."
  4762. (setq org-table-may-need-update t))
  4763. (defvar org-mode-map)
  4764. (defvar org-inhibit-startup-visibility-stuff nil) ; Dynamically-scoped param.
  4765. (defvar org-agenda-keep-modes nil) ; Dynamically-scoped param.
  4766. (defvar org-inhibit-logging nil) ; Dynamically-scoped param.
  4767. (defvar org-inhibit-blocking nil) ; Dynamically-scoped param.
  4768. (defvar org-table-buffer-is-an nil)
  4769. (defvar bidi-paragraph-direction)
  4770. (defvar buffer-face-mode-face)
  4771. (require 'outline)
  4772. ;; Other stuff we need.
  4773. (require 'time-date)
  4774. (unless (fboundp 'time-subtract) (defalias 'time-subtract 'subtract-time))
  4775. (require 'easymenu)
  4776. (autoload 'easy-menu-add "easymenu")
  4777. (require 'overlay)
  4778. ;; (require 'org-macs) moved higher up in the file before it is first used
  4779. (require 'org-entities)
  4780. ;; (require 'org-compat) moved higher up in the file before it is first used
  4781. (require 'org-faces)
  4782. (require 'org-list)
  4783. (require 'org-pcomplete)
  4784. (require 'org-src)
  4785. (require 'org-footnote)
  4786. (require 'org-macro)
  4787. ;; babel
  4788. (require 'ob)
  4789. ;;;###autoload
  4790. (define-derived-mode org-mode outline-mode "Org"
  4791. "Outline-based notes management and organizer, alias
  4792. \"Carsten's outline-mode for keeping track of everything.\"
  4793. Org mode develops organizational tasks around a NOTES file which
  4794. contains information about projects as plain text. Org mode is
  4795. implemented on top of Outline mode, which is ideal to keep the content
  4796. of large files well structured. It supports ToDo items, deadlines and
  4797. time stamps, which magically appear in the diary listing of the Emacs
  4798. calendar. Tables are easily created with a built-in table editor.
  4799. Plain text URL-like links connect to websites, emails (VM), Usenet
  4800. messages (Gnus), BBDB entries, and any files related to the project.
  4801. For printing and sharing of notes, an Org file (or a part of it)
  4802. can be exported as a structured ASCII or HTML file.
  4803. The following commands are available:
  4804. \\{org-mode-map}"
  4805. ;; Get rid of Outline menus, they are not needed
  4806. ;; Need to do this here because define-derived-mode sets up
  4807. ;; the keymap so late. Still, it is a waste to call this each time
  4808. ;; we switch another buffer into Org mode.
  4809. (define-key org-mode-map [menu-bar headings] 'undefined)
  4810. (define-key org-mode-map [menu-bar hide] 'undefined)
  4811. (define-key org-mode-map [menu-bar show] 'undefined)
  4812. (org-load-modules-maybe)
  4813. (org-install-agenda-files-menu)
  4814. (when org-descriptive-links (add-to-invisibility-spec '(org-link)))
  4815. (add-to-invisibility-spec '(org-cwidth))
  4816. (add-to-invisibility-spec '(org-hide-block . t))
  4817. (setq-local outline-regexp org-outline-regexp)
  4818. (setq-local outline-level 'org-outline-level)
  4819. (setq bidi-paragraph-direction 'left-to-right)
  4820. (when (and org-ellipsis
  4821. (fboundp 'set-display-table-slot) (boundp 'buffer-display-table)
  4822. (fboundp 'make-glyph-code))
  4823. (unless org-display-table
  4824. (setq org-display-table (make-display-table)))
  4825. (set-display-table-slot
  4826. org-display-table 4
  4827. (vconcat (mapcar (lambda (c) (make-glyph-code c 'org-ellipsis))
  4828. (if (stringp org-ellipsis) org-ellipsis "..."))))
  4829. (setq buffer-display-table org-display-table))
  4830. (org-set-regexps-and-options)
  4831. (org-set-font-lock-defaults)
  4832. (when (and org-tag-faces (not org-tags-special-faces-re))
  4833. ;; tag faces set outside customize.... force initialization.
  4834. (org-set-tag-faces 'org-tag-faces org-tag-faces))
  4835. ;; Calc embedded
  4836. (setq-local calc-embedded-open-mode "# ")
  4837. ;; Modify a few syntax entries
  4838. (modify-syntax-entry ?@ "w")
  4839. (modify-syntax-entry ?\" "\"")
  4840. (modify-syntax-entry ?\\ "_")
  4841. (modify-syntax-entry ?~ "_")
  4842. (setq-local font-lock-unfontify-region-function 'org-unfontify-region)
  4843. ;; Activate before-change-function
  4844. (setq-local org-table-may-need-update t)
  4845. (add-hook 'before-change-functions 'org-before-change-function nil 'local)
  4846. ;; Check for running clock before killing a buffer
  4847. (add-hook 'kill-buffer-hook 'org-check-running-clock nil 'local)
  4848. ;; Initialize macros templates.
  4849. (org-macro-initialize-templates)
  4850. ;; Initialize radio targets.
  4851. (org-update-radio-target-regexp)
  4852. ;; Indentation.
  4853. (setq-local indent-line-function 'org-indent-line)
  4854. (setq-local indent-region-function 'org-indent-region)
  4855. ;; Filling and auto-filling.
  4856. (org-setup-filling)
  4857. ;; Comments.
  4858. (org-setup-comments-handling)
  4859. ;; Initialize cache.
  4860. (org-element-cache-reset)
  4861. ;; Beginning/end of defun
  4862. (setq-local beginning-of-defun-function 'org-backward-element)
  4863. (setq-local end-of-defun-function
  4864. (lambda ()
  4865. (if (not (org-at-heading-p))
  4866. (org-forward-element)
  4867. (org-forward-element)
  4868. (forward-char -1))))
  4869. ;; Next error for sparse trees
  4870. (setq-local next-error-function 'org-occur-next-match)
  4871. ;; Make sure dependence stuff works reliably, even for users who set it
  4872. ;; too late :-(
  4873. (if org-enforce-todo-dependencies
  4874. (add-hook 'org-blocker-hook
  4875. 'org-block-todo-from-children-or-siblings-or-parent)
  4876. (remove-hook 'org-blocker-hook
  4877. 'org-block-todo-from-children-or-siblings-or-parent))
  4878. (if org-enforce-todo-checkbox-dependencies
  4879. (add-hook 'org-blocker-hook
  4880. 'org-block-todo-from-checkboxes)
  4881. (remove-hook 'org-blocker-hook
  4882. 'org-block-todo-from-checkboxes))
  4883. ;; Align options lines
  4884. (setq-local
  4885. align-mode-rules-list
  4886. '((org-in-buffer-settings
  4887. (regexp . "^[ \t]*#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
  4888. (modes . '(org-mode)))))
  4889. ;; Imenu
  4890. (setq-local imenu-create-index-function 'org-imenu-get-tree)
  4891. ;; Make isearch reveal context
  4892. (setq-local outline-isearch-open-invisible-function
  4893. (lambda (&rest _) (org-show-context 'isearch)))
  4894. ;; Setup the pcomplete hooks
  4895. (setq-local pcomplete-command-completion-function 'org-pcomplete-initial)
  4896. (setq-local pcomplete-command-name-function 'org-command-at-point)
  4897. (setq-local pcomplete-default-completion-function 'ignore)
  4898. (setq-local pcomplete-parse-arguments-function 'org-parse-arguments)
  4899. (setq-local pcomplete-termination-string "")
  4900. (setq-local buffer-face-mode-face 'org-default)
  4901. ;; If empty file that did not turn on Org mode automatically, make
  4902. ;; it to.
  4903. (when (and org-insert-mode-line-in-empty-file
  4904. (called-interactively-p 'any)
  4905. (= (point-min) (point-max)))
  4906. (insert "# -*- mode: org -*-\n\n"))
  4907. (unless org-inhibit-startup
  4908. (org-unmodified
  4909. (when org-startup-with-beamer-mode (org-beamer-mode))
  4910. (when org-startup-align-all-tables
  4911. (org-table-map-tables #'org-table-align t))
  4912. (when org-startup-with-inline-images (org-display-inline-images))
  4913. (when org-startup-with-latex-preview (org-toggle-latex-fragment))
  4914. (unless org-inhibit-startup-visibility-stuff (org-set-startup-visibility))
  4915. (when org-startup-truncated (setq truncate-lines t))
  4916. (when org-startup-indented (require 'org-indent) (org-indent-mode 1))
  4917. (org-refresh-effort-properties)))
  4918. ;; Try to set `org-hide' face correctly.
  4919. (let ((foreground (org-find-invisible-foreground)))
  4920. (when foreground
  4921. (set-face-foreground 'org-hide foreground))))
  4922. ;; Update `customize-package-emacs-version-alist'
  4923. (add-to-list 'customize-package-emacs-version-alist
  4924. '(Org ("6.21b" . "23.1") ("6.33x" . "23.2")
  4925. ("7.8.11" . "24.1") ("7.9.4" . "24.3")
  4926. ("8.2.6" . "24.4") ("8.2.10" . "24.5")
  4927. ("9.0" . "25.2")))
  4928. (defvar org-mode-transpose-word-syntax-table
  4929. (let ((st (make-syntax-table text-mode-syntax-table)))
  4930. (dolist (c org-emphasis-alist st)
  4931. (modify-syntax-entry (string-to-char (car c)) "w p" st))))
  4932. (when (fboundp 'abbrev-table-put)
  4933. (abbrev-table-put org-mode-abbrev-table
  4934. :parents (list text-mode-abbrev-table)))
  4935. (defun org-find-invisible-foreground ()
  4936. (let ((candidates (remove
  4937. "unspecified-bg"
  4938. (nconc
  4939. (list (face-background 'default)
  4940. (face-background 'org-default))
  4941. (mapcar
  4942. (lambda (alist)
  4943. (when (boundp alist)
  4944. (cdr (assq 'background-color (symbol-value alist)))))
  4945. '(default-frame-alist initial-frame-alist window-system-default-frame-alist))
  4946. (list (face-foreground 'org-hide))))))
  4947. (car (remove nil candidates))))
  4948. (defun org-current-time (&optional rounding-minutes past)
  4949. "Current time, possibly rounded to ROUNDING-MINUTES.
  4950. When ROUNDING-MINUTES is not an integer, fall back on the car of
  4951. `org-time-stamp-rounding-minutes'. When PAST is non-nil, ensure
  4952. the rounding returns a past time."
  4953. (let ((r (or (and (integerp rounding-minutes) rounding-minutes)
  4954. (car org-time-stamp-rounding-minutes)))
  4955. (time (decode-time)) res)
  4956. (if (< r 1)
  4957. (current-time)
  4958. (setq res
  4959. (apply 'encode-time
  4960. (append (list 0 (* r (floor (+ .5 (/ (float (nth 1 time)) r)))))
  4961. (nthcdr 2 time))))
  4962. (if (and past (< (float-time (time-subtract (current-time) res)) 0))
  4963. (seconds-to-time (- (float-time res) (* r 60)))
  4964. res))))
  4965. (defun org-today ()
  4966. "Return today date, considering `org-extend-today-until'."
  4967. (time-to-days
  4968. (time-subtract (current-time)
  4969. (list 0 (* 3600 org-extend-today-until) 0))))
  4970. ;;;; Font-Lock stuff, including the activators
  4971. (defvar org-mouse-map (make-sparse-keymap))
  4972. (org-defkey org-mouse-map [mouse-2] 'org-open-at-mouse)
  4973. (org-defkey org-mouse-map [mouse-3] 'org-find-file-at-mouse)
  4974. (when org-mouse-1-follows-link
  4975. (org-defkey org-mouse-map [follow-link] 'mouse-face))
  4976. (when org-tab-follows-link
  4977. (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
  4978. (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
  4979. (require 'font-lock)
  4980. (defconst org-non-link-chars "]\t\n\r<>")
  4981. (defvar org-link-types-re nil
  4982. "Matches a link that has a url-like prefix like \"http:\"")
  4983. (defvar org-link-re-with-space nil
  4984. "Matches a link with spaces, optional angular brackets around it.")
  4985. (defvar org-link-re-with-space2 nil
  4986. "Matches a link with spaces, optional angular brackets around it.")
  4987. (defvar org-link-re-with-space3 nil
  4988. "Matches a link with spaces, only for internal part in bracket links.")
  4989. (defvar org-angle-link-re nil
  4990. "Matches link with angular brackets, spaces are allowed.")
  4991. (defvar org-plain-link-re nil
  4992. "Matches plain link, without spaces.")
  4993. (defvar org-bracket-link-regexp nil
  4994. "Matches a link in double brackets.")
  4995. (defvar org-bracket-link-analytic-regexp nil
  4996. "Regular expression used to analyze links.
  4997. Here is what the match groups contain after a match:
  4998. 1: http:
  4999. 2: http
  5000. 3: path
  5001. 4: [desc]
  5002. 5: desc")
  5003. (defvar org-bracket-link-analytic-regexp++ nil
  5004. "Like `org-bracket-link-analytic-regexp', but include coderef internal type.")
  5005. (defvar org-any-link-re nil
  5006. "Regular expression matching any link.")
  5007. (defconst org-match-sexp-depth 3
  5008. "Number of stacked braces for sub/superscript matching.")
  5009. (defun org-create-multibrace-regexp (left right n)
  5010. "Create a regular expression which will match a balanced sexp.
  5011. Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
  5012. as single character strings.
  5013. The regexp returned will match the entire expression including the
  5014. delimiters. It will also define a single group which contains the
  5015. match except for the outermost delimiters. The maximum depth of
  5016. stacked delimiters is N. Escaping delimiters is not possible."
  5017. (let* ((nothing (concat "[^" left right "]*?"))
  5018. (or "\\|")
  5019. (re nothing)
  5020. (next (concat "\\(?:" nothing left nothing right "\\)+" nothing)))
  5021. (while (> n 1)
  5022. (setq n (1- n)
  5023. re (concat re or next)
  5024. next (concat "\\(?:" nothing left next right "\\)+" nothing)))
  5025. (concat left "\\(" re "\\)" right)))
  5026. (defconst org-match-substring-regexp
  5027. (concat
  5028. "\\(\\S-\\)\\([_^]\\)\\("
  5029. "\\(?:" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
  5030. "\\|"
  5031. "\\(?:" (org-create-multibrace-regexp "(" ")" org-match-sexp-depth) "\\)"
  5032. "\\|"
  5033. "\\(?:\\*\\|[+-]?[[:alnum:].,\\]*[[:alnum:]]\\)\\)")
  5034. "The regular expression matching a sub- or superscript.")
  5035. (defconst org-match-substring-with-braces-regexp
  5036. (concat
  5037. "\\(\\S-\\)\\([_^]\\)"
  5038. "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)")
  5039. "The regular expression matching a sub- or superscript, forcing braces.")
  5040. (defun org-make-link-regexps ()
  5041. "Update the link regular expressions.
  5042. This should be called after the variable `org-link-parameters' has changed."
  5043. (let ((types-re (regexp-opt (org-link-types) t)))
  5044. (setq org-link-types-re
  5045. (concat "\\`" types-re ":")
  5046. org-link-re-with-space
  5047. (concat "<?" types-re ":"
  5048. "\\([^" org-non-link-chars " ]"
  5049. "[^" org-non-link-chars "]*"
  5050. "[^" org-non-link-chars " ]\\)>?")
  5051. org-link-re-with-space2
  5052. (concat "<?" types-re ":"
  5053. "\\([^" org-non-link-chars " ]"
  5054. "[^\t\n\r]*"
  5055. "[^" org-non-link-chars " ]\\)>?")
  5056. org-link-re-with-space3
  5057. (concat "<?" types-re ":"
  5058. "\\([^" org-non-link-chars " ]"
  5059. "[^\t\n\r]*\\)")
  5060. org-angle-link-re
  5061. (format "<%s:\\([^>\n]*\\(?:\n[ \t]*[^> \t\n][^>\n]*\\)*\\)>"
  5062. types-re)
  5063. org-plain-link-re
  5064. (concat
  5065. "\\<" types-re ":"
  5066. "\\([^ \t\n()<>]+\\(?:([[:word:]0-9_]+)\\|\\([^[:punct:] \t\n]\\|/\\)\\)\\)")
  5067. ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
  5068. org-bracket-link-regexp
  5069. "\\[\\[\\([^][]+\\)\\]\\(\\[\\([^][]+\\)\\]\\)?\\]"
  5070. org-bracket-link-analytic-regexp
  5071. (concat
  5072. "\\[\\["
  5073. "\\(" types-re ":\\)?"
  5074. "\\([^]]+\\)"
  5075. "\\]"
  5076. "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
  5077. "\\]")
  5078. org-bracket-link-analytic-regexp++
  5079. (concat
  5080. "\\[\\["
  5081. "\\(" (regexp-opt (cons "coderef" (org-link-types)) t) ":\\)?"
  5082. "\\([^]]+\\)"
  5083. "\\]"
  5084. "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
  5085. "\\]")
  5086. org-any-link-re
  5087. (concat "\\(" org-bracket-link-regexp "\\)\\|\\("
  5088. org-angle-link-re "\\)\\|\\("
  5089. org-plain-link-re "\\)"))))
  5090. (org-make-link-regexps)
  5091. (defvar org-emph-face nil)
  5092. (defun org-do-emphasis-faces (limit)
  5093. "Run through the buffer and emphasize strings."
  5094. (let ((quick-re (format "\\([%s]\\|^\\)\\([~=*/_+]\\)"
  5095. (car org-emphasis-regexp-components))))
  5096. (catch :exit
  5097. (while (re-search-forward quick-re limit t)
  5098. (let* ((marker (match-string 2))
  5099. (verbatim? (member marker '("~" "="))))
  5100. (when (save-excursion
  5101. (goto-char (match-beginning 0))
  5102. ;; Do not match headline stars. Do not consider
  5103. ;; stars of a headline as closing marker for bold
  5104. ;; markup either.
  5105. (and (not (looking-at-p org-outline-regexp-bol))
  5106. (looking-at (if verbatim? org-verbatim-re org-emph-re))
  5107. (not (string-match-p
  5108. (concat org-outline-regexp-bol "\\'")
  5109. (match-string 0)))))
  5110. (pcase-let ((`(,_ ,face ,_) (assoc marker org-emphasis-alist)))
  5111. (font-lock-prepend-text-property
  5112. (match-beginning 2) (match-end 2) 'face face)
  5113. (when verbatim?
  5114. (org-remove-flyspell-overlays-in
  5115. (match-beginning 0) (match-end 0)))
  5116. (add-text-properties (match-beginning 2) (match-end 2)
  5117. '(font-lock-multiline t org-emphasis t))
  5118. (when org-hide-emphasis-markers
  5119. (add-text-properties (match-end 4) (match-beginning 5)
  5120. '(invisible org-link))
  5121. (add-text-properties (match-beginning 3) (match-end 3)
  5122. '(invisible org-link)))
  5123. (throw :exit t))))))))
  5124. (defun org-emphasize (&optional char)
  5125. "Insert or change an emphasis, i.e. a font like bold or italic.
  5126. If there is an active region, change that region to a new emphasis.
  5127. If there is no region, just insert the marker characters and position
  5128. the cursor between them.
  5129. CHAR should be the marker character. If it is a space, it means to
  5130. remove the emphasis of the selected region.
  5131. If CHAR is not given (for example in an interactive call) it will be
  5132. prompted for."
  5133. (interactive)
  5134. (let ((erc org-emphasis-regexp-components)
  5135. (string "") beg end move s)
  5136. (if (org-region-active-p)
  5137. (setq beg (region-beginning)
  5138. end (region-end)
  5139. string (buffer-substring beg end))
  5140. (setq move t))
  5141. (unless char
  5142. (message "Emphasis marker or tag: [%s]"
  5143. (mapconcat #'car org-emphasis-alist ""))
  5144. (setq char (read-char-exclusive)))
  5145. (if (equal char ?\s)
  5146. (setq s ""
  5147. move nil)
  5148. (unless (assoc (char-to-string char) org-emphasis-alist)
  5149. (user-error "No such emphasis marker: \"%c\"" char))
  5150. (setq s (char-to-string char)))
  5151. (while (and (> (length string) 1)
  5152. (equal (substring string 0 1) (substring string -1))
  5153. (assoc (substring string 0 1) org-emphasis-alist))
  5154. (setq string (substring string 1 -1)))
  5155. (setq string (concat s string s))
  5156. (when beg (delete-region beg end))
  5157. (unless (or (bolp)
  5158. (string-match (concat "[" (nth 0 erc) "\n]")
  5159. (char-to-string (char-before (point)))))
  5160. (insert " "))
  5161. (unless (or (eobp)
  5162. (string-match (concat "[" (nth 1 erc) "\n]")
  5163. (char-to-string (char-after (point)))))
  5164. (insert " ") (backward-char 1))
  5165. (insert string)
  5166. (and move (backward-char 1))))
  5167. (defconst org-nonsticky-props
  5168. '(mouse-face highlight keymap invisible intangible help-echo org-linked-text htmlize-link))
  5169. (defsubst org-rear-nonsticky-at (pos)
  5170. (add-text-properties (1- pos) pos (list 'rear-nonsticky org-nonsticky-props)))
  5171. (defun org-activate-plain-links (limit)
  5172. "Add link properties for plain links."
  5173. (when (and (re-search-forward org-plain-link-re limit t)
  5174. (not (org-in-src-block-p)))
  5175. (let* ((face (get-text-property (max (1- (match-beginning 0)) (point-min))
  5176. 'face))
  5177. (link (match-string-no-properties 0))
  5178. (type (match-string-no-properties 1))
  5179. (path (match-string-no-properties 2))
  5180. (link-start (match-beginning 0))
  5181. (link-end (match-end 0))
  5182. (link-face (org-link-get-parameter type :face))
  5183. (help-echo (org-link-get-parameter type :help-echo))
  5184. (htmlize-link (org-link-get-parameter type :htmlize-link))
  5185. (activate-func (org-link-get-parameter type :activate-func)))
  5186. (unless (if (consp face) (memq 'org-tag face) (eq 'org-tag face))
  5187. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  5188. (add-text-properties (match-beginning 0) (match-end 0)
  5189. (list
  5190. 'mouse-face (or (org-link-get-parameter type :mouse-face)
  5191. 'highlight)
  5192. 'face (cond
  5193. ;; A function that returns a face
  5194. ((functionp link-face)
  5195. (funcall link-face path))
  5196. ;; a face
  5197. ((facep link-face)
  5198. link-face)
  5199. ;; An anonymous face
  5200. ((consp link-face)
  5201. link-face)
  5202. ;; default
  5203. (t
  5204. 'org-link))
  5205. 'help-echo (cond
  5206. ((stringp help-echo)
  5207. help-echo)
  5208. ((functionp help-echo)
  5209. help-echo)
  5210. (t
  5211. (concat "LINK: "
  5212. (save-match-data
  5213. (org-link-unescape link)))))
  5214. 'htmlize-link (cond
  5215. ((functionp htmlize-link)
  5216. (funcall htmlize-link path))
  5217. (t
  5218. `(:uri ,link)))
  5219. 'keymap (or (org-link-get-parameter type :keymap)
  5220. org-mouse-map)
  5221. 'org-link-start (match-beginning 0)))
  5222. (org-rear-nonsticky-at (match-end 0))
  5223. (when activate-func
  5224. (funcall activate-func link-start link-end path nil))
  5225. t))))
  5226. (defun org-activate-code (limit)
  5227. (when (re-search-forward "^[ \t]*\\(:\\(?: .*\\|$\\)\n?\\)" limit t)
  5228. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  5229. (remove-text-properties (match-beginning 0) (match-end 0)
  5230. '(display t invisible t intangible t))
  5231. t))
  5232. (defcustom org-src-fontify-natively t
  5233. "When non-nil, fontify code in code blocks.
  5234. See also the `org-block' face."
  5235. :type 'boolean
  5236. :version "24.4"
  5237. :package-version '(Org . "8.3")
  5238. :group 'org-appearance
  5239. :group 'org-babel)
  5240. (defcustom org-allow-promoting-top-level-subtree nil
  5241. "When non-nil, allow promoting a top level subtree.
  5242. The leading star of the top level headline will be replaced
  5243. by a #."
  5244. :type 'boolean
  5245. :version "24.1"
  5246. :group 'org-appearance)
  5247. (defun org-fontify-meta-lines-and-blocks (limit)
  5248. (condition-case nil
  5249. (org-fontify-meta-lines-and-blocks-1 limit)
  5250. (error (message "org-mode fontification error in %S at %d"
  5251. (current-buffer)
  5252. (line-number-at-pos)))))
  5253. (defun org-fontify-meta-lines-and-blocks-1 (limit)
  5254. "Fontify #+ lines and blocks."
  5255. (let ((case-fold-search t))
  5256. (when (re-search-forward
  5257. "^\\([ \t]*#\\(\\(\\+[a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
  5258. limit t)
  5259. (let ((beg (match-beginning 0))
  5260. (block-start (match-end 0))
  5261. (block-end nil)
  5262. (lang (match-string 7))
  5263. (beg1 (line-beginning-position 2))
  5264. (dc1 (downcase (match-string 2)))
  5265. (dc3 (downcase (match-string 3)))
  5266. end end1 quoting block-type)
  5267. (cond
  5268. ((and (match-end 4) (equal dc3 "+begin"))
  5269. ;; Truly a block
  5270. (setq block-type (downcase (match-string 5))
  5271. quoting (member block-type org-protecting-blocks))
  5272. (when (re-search-forward
  5273. (concat "^[ \t]*#\\+end" (match-string 4) "\\>.*")
  5274. nil t) ;; on purpose, we look further than LIMIT
  5275. (setq end (min (point-max) (match-end 0))
  5276. end1 (min (point-max) (1- (match-beginning 0))))
  5277. (setq block-end (match-beginning 0))
  5278. (when quoting
  5279. (org-remove-flyspell-overlays-in beg1 end1)
  5280. (remove-text-properties beg end
  5281. '(display t invisible t intangible t)))
  5282. (add-text-properties
  5283. beg end '(font-lock-fontified t font-lock-multiline t))
  5284. (add-text-properties beg beg1 '(face org-meta-line))
  5285. (org-remove-flyspell-overlays-in beg beg1)
  5286. (add-text-properties ; For end_src
  5287. end1 (min (point-max) (1+ end)) '(face org-meta-line))
  5288. (org-remove-flyspell-overlays-in end1 end)
  5289. (cond
  5290. ((and lang (not (string= lang "")) org-src-fontify-natively)
  5291. (org-src-font-lock-fontify-block lang block-start block-end)
  5292. (add-text-properties beg1 block-end '(src-block t)))
  5293. (quoting
  5294. (add-text-properties beg1 (min (point-max) (1+ end1))
  5295. (list 'face
  5296. (list :inherit
  5297. (let ((face-name
  5298. (intern (format "org-block-%s" lang))))
  5299. (append (and (facep face-name) (list face-name))
  5300. '(org-block))))))) ; end of source block
  5301. ((not org-fontify-quote-and-verse-blocks))
  5302. ((string= block-type "quote")
  5303. (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-quote)))
  5304. ((string= block-type "verse")
  5305. (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-verse))))
  5306. (add-text-properties beg beg1 '(face org-block-begin-line))
  5307. (add-text-properties (min (point-max) (1+ end)) (min (point-max) (1+ end1))
  5308. '(face org-block-end-line))
  5309. t))
  5310. ((member dc1 '("+title:" "+author:" "+email:" "+date:"))
  5311. (org-remove-flyspell-overlays-in
  5312. (match-beginning 0)
  5313. (if (equal "+title:" dc1) (match-end 2) (match-end 0)))
  5314. (add-text-properties
  5315. beg (match-end 3)
  5316. (if (member (intern (substring dc1 1 -1)) org-hidden-keywords)
  5317. '(font-lock-fontified t invisible t)
  5318. '(font-lock-fontified t face org-document-info-keyword)))
  5319. (add-text-properties
  5320. (match-beginning 6) (min (point-max) (1+ (match-end 6)))
  5321. (if (string-equal dc1 "+title:")
  5322. '(font-lock-fontified t face org-document-title)
  5323. '(font-lock-fontified t face org-document-info))))
  5324. ((string-prefix-p "+caption" dc1)
  5325. (org-remove-flyspell-overlays-in (match-end 2) (match-end 0))
  5326. (remove-text-properties (match-beginning 0) (match-end 0)
  5327. '(display t invisible t intangible t))
  5328. ;; Handle short captions.
  5329. (save-excursion
  5330. (beginning-of-line)
  5331. (looking-at "\\([ \t]*#\\+caption\\(?:\\[.*\\]\\)?:\\)[ \t]*"))
  5332. (add-text-properties (line-beginning-position) (match-end 1)
  5333. '(font-lock-fontified t face org-meta-line))
  5334. (add-text-properties (match-end 0) (line-end-position)
  5335. '(font-lock-fontified t face org-block))
  5336. t)
  5337. ((member dc3 '(" " ""))
  5338. (org-remove-flyspell-overlays-in beg (match-end 0))
  5339. (add-text-properties
  5340. beg (match-end 0)
  5341. '(font-lock-fontified t face font-lock-comment-face)))
  5342. (t ;; just any other in-buffer setting, but not indented
  5343. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  5344. (remove-text-properties (match-beginning 0) (match-end 0)
  5345. '(display t invisible t intangible t))
  5346. (add-text-properties beg (match-end 0)
  5347. '(font-lock-fontified t face org-meta-line))
  5348. t))))))
  5349. (defun org-fontify-drawers (limit)
  5350. "Fontify drawers."
  5351. (when (re-search-forward org-drawer-regexp limit t)
  5352. (add-text-properties
  5353. (match-beginning 0) (match-end 0)
  5354. '(font-lock-fontified t face org-special-keyword))
  5355. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  5356. t))
  5357. (defun org-fontify-macros (limit)
  5358. "Fontify macros."
  5359. (when (re-search-forward "\\({{{\\).+?\\(}}}\\)" limit t)
  5360. (add-text-properties
  5361. (match-beginning 0) (match-end 0)
  5362. '(font-lock-fontified t face org-macro))
  5363. (when org-hide-macro-markers
  5364. (add-text-properties (match-end 2) (match-beginning 2)
  5365. '(invisible t))
  5366. (add-text-properties (match-beginning 1) (match-end 1)
  5367. '(invisible t)))
  5368. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  5369. t))
  5370. (defun org-activate-angle-links (limit)
  5371. "Add text properties for angle links."
  5372. (when (and (re-search-forward org-angle-link-re limit t)
  5373. (not (org-in-src-block-p)))
  5374. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  5375. (add-text-properties (match-beginning 0) (match-end 0)
  5376. (list 'mouse-face 'highlight
  5377. 'keymap org-mouse-map
  5378. 'font-lock-multiline t))
  5379. (org-rear-nonsticky-at (match-end 0))
  5380. t))
  5381. (defun org-activate-footnote-links (limit)
  5382. "Add text properties for footnotes."
  5383. (let ((fn (org-footnote-next-reference-or-definition limit)))
  5384. (when fn
  5385. (let* ((beg (nth 1 fn))
  5386. (end (nth 2 fn))
  5387. (label (car fn))
  5388. (referencep (/= (line-beginning-position) beg)))
  5389. (when (and referencep (nth 3 fn))
  5390. (save-excursion
  5391. (goto-char beg)
  5392. (search-forward (or label "fn:"))
  5393. (org-remove-flyspell-overlays-in beg (match-end 0))))
  5394. (add-text-properties beg end
  5395. (list 'mouse-face 'highlight
  5396. 'keymap org-mouse-map
  5397. 'help-echo
  5398. (if referencep "Footnote reference"
  5399. "Footnote definition")
  5400. 'font-lock-fontified t
  5401. 'font-lock-multiline t
  5402. 'face 'org-footnote))))))
  5403. (defun org-activate-bracket-links (limit)
  5404. "Add text properties for bracketed links."
  5405. (when (and (re-search-forward org-bracket-link-regexp limit t)
  5406. (not (org-in-src-block-p)))
  5407. (let* ((hl (save-match-data
  5408. (org-link-expand-abbrev (match-string-no-properties 1))))
  5409. (type (save-match-data
  5410. (and (string-match org-plain-link-re hl)
  5411. (match-string-no-properties 1 hl))))
  5412. (path (save-match-data
  5413. (and (string-match org-plain-link-re hl)
  5414. (match-string-no-properties 2 hl))))
  5415. (link-start (match-beginning 0))
  5416. (link-end (match-end 0))
  5417. (bracketp t)
  5418. (help-echo (org-link-get-parameter type :help-echo))
  5419. (help (cond
  5420. ((stringp help-echo)
  5421. help-echo)
  5422. ((functionp help-echo)
  5423. help-echo)
  5424. (t
  5425. (concat "LINK: "
  5426. (save-match-data
  5427. (org-link-unescape hl))))))
  5428. (link-face (org-link-get-parameter type :face))
  5429. (face (cond
  5430. ;; A function that returns a face
  5431. ((functionp link-face)
  5432. (funcall link-face path))
  5433. ;; a face
  5434. ((facep link-face)
  5435. link-face)
  5436. ;; An anonymous face
  5437. ((consp link-face)
  5438. link-face)
  5439. ;; default
  5440. (t
  5441. 'org-link)))
  5442. (keymap (or (org-link-get-parameter type :keymap)
  5443. org-mouse-map))
  5444. (mouse-face (or (org-link-get-parameter type :mouse-face)
  5445. 'highlight))
  5446. (htmlize (org-link-get-parameter type :htmlize-link))
  5447. (htmlize-link (cond
  5448. ((functionp htmlize)
  5449. (funcall htmlize))
  5450. (t
  5451. `(:uri ,(format "%s:%s" type path)))))
  5452. (activate-func (org-link-get-parameter type :activate-func))
  5453. ;; invisible part
  5454. (ip (list 'invisible (or
  5455. (org-link-get-parameter type :display)
  5456. 'org-link)
  5457. 'face face
  5458. 'keymap keymap
  5459. 'mouse-face mouse-face
  5460. 'font-lock-multiline t
  5461. 'help-echo help
  5462. 'htmlize-link htmlize-link))
  5463. ;; visible part
  5464. (vp (list 'keymap keymap
  5465. 'face face
  5466. 'mouse-face mouse-face
  5467. 'font-lock-multiline t
  5468. 'help-echo help
  5469. 'htmlize-link htmlize-link)))
  5470. ;; We need to remove the invisible property here. Table narrowing
  5471. ;; may have made some of this invisible.
  5472. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  5473. (remove-text-properties (match-beginning 0) (match-end 0)
  5474. '(invisible nil))
  5475. (if (match-end 3)
  5476. (progn
  5477. (add-text-properties (match-beginning 0) (match-beginning 3) ip)
  5478. (org-rear-nonsticky-at (match-beginning 3))
  5479. (add-text-properties (match-beginning 3) (match-end 3) vp)
  5480. (org-rear-nonsticky-at (match-end 3))
  5481. (add-text-properties (match-end 3) (match-end 0) ip)
  5482. (org-rear-nonsticky-at (match-end 0)))
  5483. (add-text-properties (match-beginning 0) (match-beginning 1) ip)
  5484. (org-rear-nonsticky-at (match-beginning 1))
  5485. (add-text-properties (match-beginning 1) (match-end 1) vp)
  5486. (org-rear-nonsticky-at (match-end 1))
  5487. (add-text-properties (match-end 1) (match-end 0) ip)
  5488. (org-rear-nonsticky-at (match-end 0)))
  5489. (when activate-func
  5490. (funcall activate-func link-start link-end path bracketp))
  5491. t)))
  5492. (defun org-activate-dates (limit)
  5493. "Add text properties for dates."
  5494. (when (and (re-search-forward org-tsr-regexp-both limit t)
  5495. (not (equal (char-before (match-beginning 0)) 91)))
  5496. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  5497. (add-text-properties (match-beginning 0) (match-end 0)
  5498. (list 'mouse-face 'highlight
  5499. 'keymap org-mouse-map))
  5500. (org-rear-nonsticky-at (match-end 0))
  5501. (when org-display-custom-times
  5502. (if (match-end 3)
  5503. (org-display-custom-time (match-beginning 3) (match-end 3))
  5504. (org-display-custom-time (match-beginning 1) (match-end 1))))
  5505. t))
  5506. (defvar-local org-target-link-regexp nil
  5507. "Regular expression matching radio targets in plain text.")
  5508. (defconst org-target-regexp (let ((border "[^<>\n\r \t]"))
  5509. (format "<<\\(%s\\|%s[^<>\n\r]*%s\\)>>"
  5510. border border border))
  5511. "Regular expression matching a link target.")
  5512. (defconst org-radio-target-regexp (format "<%s>" org-target-regexp)
  5513. "Regular expression matching a radio target.")
  5514. (defconst org-any-target-regexp
  5515. (format "%s\\|%s" org-radio-target-regexp org-target-regexp)
  5516. "Regular expression matching any target.")
  5517. (defun org-activate-target-links (limit)
  5518. "Add text properties for target matches."
  5519. (when org-target-link-regexp
  5520. (let ((case-fold-search t))
  5521. (when (re-search-forward org-target-link-regexp limit t)
  5522. (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
  5523. (add-text-properties (match-beginning 1) (match-end 1)
  5524. (list 'mouse-face 'highlight
  5525. 'keymap org-mouse-map
  5526. 'help-echo "Radio target link"
  5527. 'org-linked-text t))
  5528. (org-rear-nonsticky-at (match-end 1))
  5529. t))))
  5530. (defun org-update-radio-target-regexp ()
  5531. "Find all radio targets in this file and update the regular expression.
  5532. Also refresh fontification if needed."
  5533. (interactive)
  5534. (let ((old-regexp org-target-link-regexp)
  5535. (before-re "\\(?:^\\|[^[:alnum:]]\\)\\(")
  5536. (after-re "\\)\\(?:$\\|[^[:alnum:]]\\)")
  5537. (targets
  5538. (org-with-wide-buffer
  5539. (goto-char (point-min))
  5540. (let (rtn)
  5541. (while (re-search-forward org-radio-target-regexp nil t)
  5542. ;; Make sure point is really within the object.
  5543. (backward-char)
  5544. (let ((obj (org-element-context)))
  5545. (when (eq (org-element-type obj) 'radio-target)
  5546. (cl-pushnew (org-element-property :value obj) rtn
  5547. :test #'equal))))
  5548. rtn))))
  5549. (setq org-target-link-regexp
  5550. (and targets
  5551. (concat before-re
  5552. (mapconcat
  5553. (lambda (x)
  5554. (replace-regexp-in-string
  5555. " +" "\\s-+" (regexp-quote x) t t))
  5556. targets
  5557. "\\|")
  5558. after-re)))
  5559. (unless (equal old-regexp org-target-link-regexp)
  5560. ;; Clean-up cache.
  5561. (let ((regexp (cond ((not old-regexp) org-target-link-regexp)
  5562. ((not org-target-link-regexp) old-regexp)
  5563. (t
  5564. (concat before-re
  5565. (mapconcat
  5566. (lambda (re)
  5567. (substring re (length before-re)
  5568. (- (length after-re))))
  5569. (list old-regexp org-target-link-regexp)
  5570. "\\|")
  5571. after-re)))))
  5572. (org-with-wide-buffer
  5573. (goto-char (point-min))
  5574. (while (re-search-forward regexp nil t)
  5575. (org-element-cache-refresh (match-beginning 1)))))
  5576. ;; Re fontify buffer.
  5577. (when (memq 'radio org-highlight-links)
  5578. (org-restart-font-lock)))))
  5579. (defun org-hide-wide-columns (limit)
  5580. (let (s e)
  5581. (setq s (text-property-any (point) (or limit (point-max))
  5582. 'org-cwidth t))
  5583. (when s
  5584. (setq e (next-single-property-change s 'org-cwidth))
  5585. (add-text-properties s e '(invisible org-cwidth))
  5586. (goto-char e)
  5587. t)))
  5588. (defvar org-latex-and-related-regexp nil
  5589. "Regular expression for highlighting LaTeX, entities and sub/superscript.")
  5590. (defun org-compute-latex-and-related-regexp ()
  5591. "Compute regular expression for LaTeX, entities and sub/superscript.
  5592. Result depends on variable `org-highlight-latex-and-related'."
  5593. (setq-local
  5594. org-latex-and-related-regexp
  5595. (let* ((re-sub
  5596. (cond ((not (memq 'script org-highlight-latex-and-related)) nil)
  5597. ((eq org-use-sub-superscripts '{})
  5598. (list org-match-substring-with-braces-regexp))
  5599. (org-use-sub-superscripts (list org-match-substring-regexp))))
  5600. (re-latex
  5601. (when (memq 'latex org-highlight-latex-and-related)
  5602. (let ((matchers (plist-get org-format-latex-options :matchers)))
  5603. (delq nil
  5604. (mapcar (lambda (x)
  5605. (and (member (car x) matchers) (nth 1 x)))
  5606. org-latex-regexps)))))
  5607. (re-entities
  5608. (when (memq 'entities org-highlight-latex-and-related)
  5609. (list "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)"))))
  5610. (mapconcat 'identity (append re-latex re-entities re-sub) "\\|"))))
  5611. (defun org-do-latex-and-related (limit)
  5612. "Highlight LaTeX snippets and environments, entities and sub/superscript.
  5613. LIMIT bounds the search for syntax to highlight. Stop at first
  5614. highlighted object, if any. Return t if some highlighting was
  5615. done, nil otherwise."
  5616. (when (org-string-nw-p org-latex-and-related-regexp)
  5617. (catch 'found
  5618. (while (re-search-forward org-latex-and-related-regexp limit t)
  5619. (unless
  5620. (cl-some
  5621. (lambda (f)
  5622. (memq f '(org-code org-verbatim underline org-special-keyword)))
  5623. (save-excursion
  5624. (goto-char (1+ (match-beginning 0)))
  5625. (face-at-point nil t)))
  5626. (let ((offset (if (memq (char-after (1+ (match-beginning 0)))
  5627. '(?_ ?^))
  5628. 1
  5629. 0)))
  5630. (font-lock-prepend-text-property
  5631. (+ offset (match-beginning 0)) (match-end 0)
  5632. 'face 'org-latex-and-related)
  5633. (add-text-properties (+ offset (match-beginning 0)) (match-end 0)
  5634. '(font-lock-multiline t)))
  5635. (throw 'found t)))
  5636. nil)))
  5637. (defun org-restart-font-lock ()
  5638. "Restart `font-lock-mode', to force refontification."
  5639. (when (and (boundp 'font-lock-mode) font-lock-mode)
  5640. (font-lock-mode -1)
  5641. (font-lock-mode 1)))
  5642. (defun org-activate-tags (limit)
  5643. (when (re-search-forward
  5644. "^\\*+.*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$" limit t)
  5645. (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
  5646. (add-text-properties (match-beginning 1) (match-end 1)
  5647. (list 'mouse-face 'highlight
  5648. 'keymap org-mouse-map))
  5649. (org-rear-nonsticky-at (match-end 1))
  5650. t))
  5651. (defun org-outline-level ()
  5652. "Compute the outline level of the heading at point.
  5653. If this is called at a normal headline, the level is the number
  5654. of stars. Use `org-reduced-level' to remove the effect of
  5655. `org-odd-levels'. Unlike to `org-current-level', this function
  5656. takes into consideration inlinetasks."
  5657. (org-with-wide-buffer
  5658. (end-of-line)
  5659. (if (re-search-backward org-outline-regexp-bol nil t)
  5660. (1- (- (match-end 0) (match-beginning 0)))
  5661. 0)))
  5662. (defvar org-font-lock-keywords nil)
  5663. (defsubst org-re-property (property &optional literal allow-null value)
  5664. "Return a regexp matching a PROPERTY line.
  5665. When optional argument LITERAL is non-nil, do not quote PROPERTY.
  5666. This is useful when PROPERTY is a regexp. When ALLOW-NULL is
  5667. non-nil, match properties even without a value.
  5668. Match group 3 is set to the value when it exists. If there is no
  5669. value and ALLOW-NULL is non-nil, it is set to the empty string.
  5670. With optional argument VALUE, match only property lines with
  5671. that value; in this case, ALLOW-NULL is ignored. VALUE is quoted
  5672. unless LITERAL is non-nil."
  5673. (concat
  5674. "^\\(?4:[ \t]*\\)"
  5675. (format "\\(?1::\\(?2:%s\\):\\)"
  5676. (if literal property (regexp-quote property)))
  5677. (cond (value
  5678. (format "[ \t]+\\(?3:%s\\)\\(?5:[ \t]*\\)$"
  5679. (if literal value (regexp-quote value))))
  5680. (allow-null
  5681. "\\(?:\\(?3:$\\)\\|[ \t]+\\(?3:.*?\\)\\)\\(?5:[ \t]*\\)$")
  5682. (t
  5683. "[ \t]+\\(?3:[^ \r\t\n]+.*?\\)\\(?5:[ \t]*\\)$"))))
  5684. (defconst org-property-re
  5685. (org-re-property "\\S-+" 'literal t)
  5686. "Regular expression matching a property line.
  5687. There are four matching groups:
  5688. 1: :PROPKEY: including the leading and trailing colon,
  5689. 2: PROPKEY without the leading and trailing colon,
  5690. 3: PROPVAL without leading or trailing spaces,
  5691. 4: the indentation of the current line,
  5692. 5: trailing whitespace.")
  5693. (defvar org-font-lock-hook nil
  5694. "Functions to be called for special font lock stuff.")
  5695. (defvar org-font-lock-extra-keywords nil) ;Dynamically scoped.
  5696. (defvar org-font-lock-set-keywords-hook nil
  5697. "Functions that can manipulate `org-font-lock-extra-keywords'.
  5698. This is called after `org-font-lock-extra-keywords' is defined, but before
  5699. it is installed to be used by font lock. This can be useful if something
  5700. needs to be inserted at a specific position in the font-lock sequence.")
  5701. (defun org-font-lock-hook (limit)
  5702. "Run `org-font-lock-hook' within LIMIT."
  5703. (run-hook-with-args 'org-font-lock-hook limit))
  5704. (defun org-set-font-lock-defaults ()
  5705. "Set font lock defaults for the current buffer."
  5706. (let* ((em org-fontify-emphasized-text)
  5707. (lk org-highlight-links)
  5708. (org-font-lock-extra-keywords
  5709. (list
  5710. ;; Call the hook
  5711. '(org-font-lock-hook)
  5712. ;; Headlines
  5713. `(,(if org-fontify-whole-heading-line
  5714. "^\\(\\**\\)\\(\\* \\)\\(.*\n?\\)"
  5715. "^\\(\\**\\)\\(\\* \\)\\(.*\\)")
  5716. (1 (org-get-level-face 1))
  5717. (2 (org-get-level-face 2))
  5718. (3 (org-get-level-face 3)))
  5719. ;; Table lines
  5720. '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
  5721. (1 'org-table t))
  5722. ;; Table internals
  5723. '("^[ \t]*|\\(?:.*?|\\)? *\\(:?=[^|\n]*\\)" (1 'org-formula t))
  5724. '("^[ \t]*| *\\([#*]\\) *|" (1 'org-formula t))
  5725. '("^[ \t]*|\\( *\\([$!_^/]\\) *|.*\\)|" (1 'org-formula t))
  5726. '("| *\\(<[lrc]?[0-9]*>\\)" (1 'org-formula t))
  5727. ;; Drawers
  5728. '(org-fontify-drawers)
  5729. ;; Properties
  5730. (list org-property-re
  5731. '(1 'org-special-keyword t)
  5732. '(3 'org-property-value t))
  5733. ;; Links
  5734. (when (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
  5735. (when (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
  5736. (when (memq 'plain lk) '(org-activate-plain-links (0 'org-link)))
  5737. (when (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link)))
  5738. (when (memq 'radio lk) '(org-activate-target-links (1 'org-link t)))
  5739. (when (memq 'date lk) '(org-activate-dates (0 'org-date t)))
  5740. (when (memq 'footnote lk) '(org-activate-footnote-links))
  5741. ;; Targets.
  5742. (list org-any-target-regexp '(0 'org-target t))
  5743. ;; Diary sexps.
  5744. '("^&?%%(.*\\|<%%([^>\n]*?>" (0 'org-sexp-date t))
  5745. ;; Macro
  5746. '(org-fontify-macros)
  5747. '(org-hide-wide-columns (0 nil append))
  5748. ;; TODO keyword
  5749. (list (format org-heading-keyword-regexp-format
  5750. org-todo-regexp)
  5751. '(2 (org-get-todo-face 2) t))
  5752. ;; DONE
  5753. (if org-fontify-done-headline
  5754. (list (format org-heading-keyword-regexp-format
  5755. (concat
  5756. "\\(?:"
  5757. (mapconcat 'regexp-quote org-done-keywords "\\|")
  5758. "\\)"))
  5759. '(2 'org-headline-done t))
  5760. nil)
  5761. ;; Priorities
  5762. '(org-font-lock-add-priority-faces)
  5763. ;; Tags
  5764. '(org-font-lock-add-tag-faces)
  5765. ;; Tags groups
  5766. (when (and org-group-tags org-tag-groups-alist)
  5767. (list (concat org-outline-regexp-bol ".+\\(:"
  5768. (regexp-opt (mapcar 'car org-tag-groups-alist))
  5769. ":\\).*$")
  5770. '(1 'org-tag-group prepend)))
  5771. ;; Special keywords
  5772. (list (concat "\\<" org-deadline-string) '(0 'org-special-keyword t))
  5773. (list (concat "\\<" org-scheduled-string) '(0 'org-special-keyword t))
  5774. (list (concat "\\<" org-closed-string) '(0 'org-special-keyword t))
  5775. (list (concat "\\<" org-clock-string) '(0 'org-special-keyword t))
  5776. ;; Emphasis
  5777. (when em '(org-do-emphasis-faces))
  5778. ;; Checkboxes
  5779. '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
  5780. 1 'org-checkbox prepend)
  5781. (when (cdr (assq 'checkbox org-list-automatic-rules))
  5782. '("\\[\\([0-9]*%\\)\\]\\|\\[\\([0-9]*\\)/\\([0-9]*\\)\\]"
  5783. (0 (org-get-checkbox-statistics-face) t)))
  5784. ;; Description list items
  5785. '("^[ \t]*[-+*][ \t]+\\(.*?[ \t]+::\\)\\([ \t]+\\|$\\)"
  5786. 1 'org-list-dt prepend)
  5787. ;; ARCHIVEd headings
  5788. (list (concat
  5789. org-outline-regexp-bol
  5790. "\\(.*:" org-archive-tag ":.*\\)")
  5791. '(1 'org-archived prepend))
  5792. ;; Specials
  5793. '(org-do-latex-and-related)
  5794. '(org-fontify-entities)
  5795. '(org-raise-scripts)
  5796. ;; Code
  5797. '(org-activate-code (1 'org-code t))
  5798. ;; COMMENT
  5799. (list (format
  5800. "^\\*+\\(?: +%s\\)?\\(?: +\\[#[A-Z0-9]\\]\\)? +\\(?9:%s\\)\\(?: \\|$\\)"
  5801. org-todo-regexp
  5802. org-comment-string)
  5803. '(9 'org-special-keyword t))
  5804. ;; Blocks and meta lines
  5805. '(org-fontify-meta-lines-and-blocks))))
  5806. (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
  5807. (run-hooks 'org-font-lock-set-keywords-hook)
  5808. ;; Now set the full font-lock-keywords
  5809. (setq-local org-font-lock-keywords org-font-lock-extra-keywords)
  5810. (setq-local font-lock-defaults
  5811. '(org-font-lock-keywords t nil nil backward-paragraph))
  5812. (kill-local-variable 'font-lock-keywords)
  5813. nil))
  5814. (defun org-toggle-pretty-entities ()
  5815. "Toggle the composition display of entities as UTF8 characters."
  5816. (interactive)
  5817. (setq-local org-pretty-entities (not org-pretty-entities))
  5818. (org-restart-font-lock)
  5819. (if org-pretty-entities
  5820. (message "Entities are now displayed as UTF8 characters")
  5821. (save-restriction
  5822. (widen)
  5823. (decompose-region (point-min) (point-max))
  5824. (message "Entities are now displayed as plain text"))))
  5825. (defvar-local org-custom-properties-overlays nil
  5826. "List of overlays used for custom properties.")
  5827. (defun org-toggle-custom-properties-visibility ()
  5828. "Display or hide properties in `org-custom-properties'."
  5829. (interactive)
  5830. (if org-custom-properties-overlays
  5831. (progn (mapc #'delete-overlay org-custom-properties-overlays)
  5832. (setq org-custom-properties-overlays nil))
  5833. (when org-custom-properties
  5834. (org-with-wide-buffer
  5835. (goto-char (point-min))
  5836. (let ((regexp (org-re-property (regexp-opt org-custom-properties) t t)))
  5837. (while (re-search-forward regexp nil t)
  5838. (let ((end (cdr (save-match-data (org-get-property-block)))))
  5839. (when (and end (< (point) end))
  5840. ;; Hide first custom property in current drawer.
  5841. (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
  5842. (overlay-put o 'invisible t)
  5843. (overlay-put o 'org-custom-property t)
  5844. (push o org-custom-properties-overlays))
  5845. ;; Hide additional custom properties in the same drawer.
  5846. (while (re-search-forward regexp end t)
  5847. (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
  5848. (overlay-put o 'invisible t)
  5849. (overlay-put o 'org-custom-property t)
  5850. (push o org-custom-properties-overlays)))))
  5851. ;; Each entry is limited to a single property drawer.
  5852. (outline-next-heading)))))))
  5853. (defun org-fontify-entities (limit)
  5854. "Find an entity to fontify."
  5855. (let (ee)
  5856. (when org-pretty-entities
  5857. (catch 'match
  5858. ;; "\_ "-family is left out on purpose. Only the first one,
  5859. ;; i.e., "\_ ", could be fontified anyway, and it would be
  5860. ;; confusing when adding a second white space character.
  5861. (while (re-search-forward
  5862. "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]\n]\\)"
  5863. limit t)
  5864. (when (and (not (org-at-comment-p))
  5865. (setq ee (org-entity-get (match-string 1)))
  5866. (= (length (nth 6 ee)) 1))
  5867. (let* ((end (if (equal (match-string 2) "{}")
  5868. (match-end 2)
  5869. (match-end 1))))
  5870. (add-text-properties
  5871. (match-beginning 0) end
  5872. (list 'font-lock-fontified t))
  5873. (compose-region (match-beginning 0) end
  5874. (nth 6 ee) nil)
  5875. (backward-char 1)
  5876. (throw 'match t))))
  5877. nil))))
  5878. (defun org-fontify-like-in-org-mode (s &optional odd-levels)
  5879. "Fontify string S like in Org mode."
  5880. (with-temp-buffer
  5881. (insert s)
  5882. (let ((org-odd-levels-only odd-levels))
  5883. (org-mode)
  5884. (org-font-lock-ensure)
  5885. (buffer-string))))
  5886. (defvar org-m nil)
  5887. (defvar org-l nil)
  5888. (defvar org-f nil)
  5889. (defun org-get-level-face (n)
  5890. "Get the right face for match N in font-lock matching of headlines."
  5891. (setq org-l (- (match-end 2) (match-beginning 1) 1))
  5892. (when org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
  5893. (if org-cycle-level-faces
  5894. (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
  5895. (setq org-f (nth (1- (min org-l org-n-level-faces)) org-level-faces)))
  5896. (cond
  5897. ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
  5898. ((eq n 2) org-f)
  5899. (t (unless org-level-color-stars-only org-f))))
  5900. (defun org-face-from-face-or-color (context inherit face-or-color)
  5901. "Create a face list that inherits INHERIT, but sets the foreground color.
  5902. When FACE-OR-COLOR is not a string, just return it."
  5903. (if (stringp face-or-color)
  5904. (list :inherit inherit
  5905. (cdr (assoc context org-faces-easy-properties))
  5906. face-or-color)
  5907. face-or-color))
  5908. (defun org-get-todo-face (kwd)
  5909. "Get the right face for a TODO keyword KWD.
  5910. If KWD is a number, get the corresponding match group."
  5911. (when (numberp kwd) (setq kwd (match-string kwd)))
  5912. (or (org-face-from-face-or-color
  5913. 'todo 'org-todo (cdr (assoc kwd org-todo-keyword-faces)))
  5914. (and (member kwd org-done-keywords) 'org-done)
  5915. 'org-todo))
  5916. (defun org-get-priority-face (priority)
  5917. "Get the right face for PRIORITY.
  5918. PRIORITY is a character."
  5919. (or (org-face-from-face-or-color
  5920. 'priority 'org-priority (cdr (assq priority org-priority-faces)))
  5921. 'org-priority))
  5922. (defun org-get-tag-face (tag)
  5923. "Get the right face for TAG.
  5924. If TAG is a number, get the corresponding match group."
  5925. (let ((tag (if (wholenump tag) (match-string tag) tag)))
  5926. (or (org-face-from-face-or-color
  5927. 'tag 'org-tag (cdr (assoc tag org-tag-faces)))
  5928. 'org-tag)))
  5929. (defun org-font-lock-add-priority-faces (limit)
  5930. "Add the special priority faces."
  5931. (while (re-search-forward "^\\*+ .*?\\(\\[#\\(.\\)\\]\\)" limit t)
  5932. (add-text-properties
  5933. (match-beginning 1) (match-end 1)
  5934. (list 'face (org-get-priority-face (string-to-char (match-string 2)))
  5935. 'font-lock-fontified t))))
  5936. (defun org-font-lock-add-tag-faces (limit)
  5937. "Add the special tag faces."
  5938. (when (and org-tag-faces org-tags-special-faces-re)
  5939. (while (re-search-forward org-tags-special-faces-re limit t)
  5940. (add-text-properties (match-beginning 1) (match-end 1)
  5941. (list 'face (org-get-tag-face 1)
  5942. 'font-lock-fontified t))
  5943. (backward-char 1))))
  5944. (defun org-unfontify-region (beg end &optional _maybe_loudly)
  5945. "Remove fontification and activation overlays from links."
  5946. (font-lock-default-unfontify-region beg end)
  5947. (let* ((buffer-undo-list t)
  5948. (inhibit-read-only t) (inhibit-point-motion-hooks t)
  5949. (inhibit-modification-hooks t)
  5950. deactivate-mark buffer-file-name buffer-file-truename)
  5951. (decompose-region beg end)
  5952. (remove-text-properties beg end
  5953. '(mouse-face t keymap t org-linked-text t
  5954. invisible t intangible t
  5955. org-emphasis t))
  5956. (org-remove-font-lock-display-properties beg end)))
  5957. (defconst org-script-display '(((raise -0.3) (height 0.7))
  5958. ((raise 0.3) (height 0.7))
  5959. ((raise -0.5))
  5960. ((raise 0.5)))
  5961. "Display properties for showing superscripts and subscripts.")
  5962. (defun org-remove-font-lock-display-properties (beg end)
  5963. "Remove specific display properties that have been added by font lock.
  5964. The will remove the raise properties that are used to show superscripts
  5965. and subscripts."
  5966. (let (next prop)
  5967. (while (< beg end)
  5968. (setq next (next-single-property-change beg 'display nil end)
  5969. prop (get-text-property beg 'display))
  5970. (when (member prop org-script-display)
  5971. (put-text-property beg next 'display nil))
  5972. (setq beg next))))
  5973. (defun org-raise-scripts (limit)
  5974. "Add raise properties to sub/superscripts."
  5975. (when (and org-pretty-entities org-pretty-entities-include-sub-superscripts
  5976. (re-search-forward
  5977. (if (eq org-use-sub-superscripts t)
  5978. org-match-substring-regexp
  5979. org-match-substring-with-braces-regexp)
  5980. limit t))
  5981. (let* ((pos (point)) table-p comment-p
  5982. (mpos (match-beginning 3))
  5983. (emph-p (get-text-property mpos 'org-emphasis))
  5984. (link-p (get-text-property mpos 'mouse-face))
  5985. (keyw-p (eq 'org-special-keyword (get-text-property mpos 'face))))
  5986. (goto-char (point-at-bol))
  5987. (setq table-p (looking-at-p org-table-dataline-regexp)
  5988. comment-p (looking-at-p "^[ \t]*#[ +]"))
  5989. (goto-char pos)
  5990. ;; Handle a_b^c
  5991. (when (member (char-after) '(?_ ?^)) (goto-char (1- pos)))
  5992. (unless (or comment-p emph-p link-p keyw-p)
  5993. (put-text-property (match-beginning 3) (match-end 0)
  5994. 'display
  5995. (if (equal (char-after (match-beginning 2)) ?^)
  5996. (nth (if table-p 3 1) org-script-display)
  5997. (nth (if table-p 2 0) org-script-display)))
  5998. (add-text-properties (match-beginning 2) (match-end 2)
  5999. (list 'invisible t
  6000. 'org-dwidth t 'org-dwidth-n 1))
  6001. (if (and (eq (char-after (match-beginning 3)) ?{)
  6002. (eq (char-before (match-end 3)) ?}))
  6003. (progn
  6004. (add-text-properties
  6005. (match-beginning 3) (1+ (match-beginning 3))
  6006. (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))
  6007. (add-text-properties
  6008. (1- (match-end 3)) (match-end 3)
  6009. (list 'invisible t 'org-dwidth t 'org-dwidth-n 1)))))
  6010. t)))
  6011. ;;;; Visibility cycling, including org-goto and indirect buffer
  6012. ;;; Cycling
  6013. (defvar-local org-cycle-global-status nil)
  6014. (put 'org-cycle-global-status 'org-state t)
  6015. (defvar-local org-cycle-subtree-status nil)
  6016. (put 'org-cycle-subtree-status 'org-state t)
  6017. (defvar org-inlinetask-min-level)
  6018. (defun org-unlogged-message (&rest args)
  6019. "Display a message, but avoid logging it in the *Messages* buffer."
  6020. (let ((message-log-max nil))
  6021. (apply 'message args)))
  6022. ;;;###autoload
  6023. (defun org-cycle (&optional arg)
  6024. "TAB-action and visibility cycling for Org mode.
  6025. This is the command invoked in Org mode by the `TAB' key. Its main
  6026. purpose is outline visibility cycling, but it also invokes other actions
  6027. in special contexts.
  6028. When this function is called with a `\\[universal-argument]' prefix, rotate \
  6029. the entire
  6030. buffer through 3 states (global cycling)
  6031. 1. OVERVIEW: Show only top-level headlines.
  6032. 2. CONTENTS: Show all headlines of all levels, but no body text.
  6033. 3. SHOW ALL: Show everything.
  6034. With a `\\[universal-argument] \\[universal-argument]' prefix argument, \
  6035. switch to the startup visibility,
  6036. determined by the variable `org-startup-folded', and by any VISIBILITY
  6037. properties in the buffer.
  6038. With a `\\[universal-argument] \\[universal-argument] \
  6039. \\[universal-argument]' prefix argument, show the entire buffer, including
  6040. any drawers.
  6041. When inside a table, re-align the table and move to the next field.
  6042. When point is at the beginning of a headline, rotate the subtree started
  6043. by this line through 3 different states (local cycling)
  6044. 1. FOLDED: Only the main headline is shown.
  6045. 2. CHILDREN: The main headline and the direct children are shown.
  6046. From this state, you can move to one of the children
  6047. and zoom in further.
  6048. 3. SUBTREE: Show the entire subtree, including body text.
  6049. If there is no subtree, switch directly from CHILDREN to FOLDED.
  6050. When point is at the beginning of an empty headline and the variable
  6051. `org-cycle-level-after-item/entry-creation' is set, cycle the level
  6052. of the headline by demoting and promoting it to likely levels. This
  6053. speeds up creation document structure by pressing `TAB' once or several
  6054. times right after creating a new headline.
  6055. When there is a numeric prefix, go up to a heading with level ARG, do
  6056. a `show-subtree' and return to the previous cursor position. If ARG
  6057. is negative, go up that many levels.
  6058. When point is not at the beginning of a headline, execute the global
  6059. binding for `TAB', which is re-indenting the line. See the option
  6060. `org-cycle-emulate-tab' for details.
  6061. As a special case, if point is at the beginning of the buffer and there is
  6062. no headline in line 1, this function will act as if called with prefix arg
  6063. \(`\\[universal-argument] TAB', same as `S-TAB') also when called without \
  6064. prefix arg, but only
  6065. if the variable `org-cycle-global-at-bob' is t."
  6066. (interactive "P")
  6067. (org-load-modules-maybe)
  6068. (unless (or (run-hook-with-args-until-success 'org-tab-first-hook)
  6069. (and org-cycle-level-after-item/entry-creation
  6070. (or (org-cycle-level)
  6071. (org-cycle-item-indentation))))
  6072. (let* ((limit-level
  6073. (or org-cycle-max-level
  6074. (and (boundp 'org-inlinetask-min-level)
  6075. org-inlinetask-min-level
  6076. (1- org-inlinetask-min-level))))
  6077. (nstars (and limit-level
  6078. (if org-odd-levels-only
  6079. (and limit-level (1- (* limit-level 2)))
  6080. limit-level)))
  6081. (org-outline-regexp
  6082. (if (not (derived-mode-p 'org-mode))
  6083. outline-regexp
  6084. (concat "\\*" (if nstars (format "\\{1,%d\\} " nstars) "+ "))))
  6085. (bob-special (and org-cycle-global-at-bob (not arg) (bobp)
  6086. (not (looking-at org-outline-regexp))))
  6087. (org-cycle-hook
  6088. (if bob-special
  6089. (delq 'org-optimize-window-after-visibility-change
  6090. (copy-sequence org-cycle-hook))
  6091. org-cycle-hook))
  6092. (pos (point)))
  6093. (cond
  6094. ((equal arg '(16))
  6095. (setq last-command 'dummy)
  6096. (org-set-startup-visibility)
  6097. (org-unlogged-message "Startup visibility, plus VISIBILITY properties"))
  6098. ((equal arg '(64))
  6099. (outline-show-all)
  6100. (org-unlogged-message "Entire buffer visible, including drawers"))
  6101. ((equal arg '(4)) (org-cycle-internal-global))
  6102. ;; Try hiding block at point.
  6103. ((org-hide-block-toggle-maybe))
  6104. ;; Try cdlatex TAB completion
  6105. ((org-try-cdlatex-tab))
  6106. ;; Table: enter it or move to the next field.
  6107. ((org-at-table-p 'any)
  6108. (if (org-at-table.el-p)
  6109. (message "%s" (substitute-command-keys "\\<org-mode-map>\
  6110. Use `\\[org-edit-special]' to edit table.el tables"))
  6111. (if arg (org-table-edit-field t)
  6112. (org-table-justify-field-maybe)
  6113. (call-interactively 'org-table-next-field))))
  6114. ((run-hook-with-args-until-success 'org-tab-after-check-for-table-hook))
  6115. ;; Global cycling: delegate to `org-cycle-internal-global'.
  6116. (bob-special (org-cycle-internal-global))
  6117. ;; Drawers: delegate to `org-flag-drawer'.
  6118. ((save-excursion
  6119. (beginning-of-line 1)
  6120. (looking-at org-drawer-regexp))
  6121. (org-flag-drawer ; toggle block visibility
  6122. (not (get-char-property (match-end 0) 'invisible))))
  6123. ;; Show-subtree, ARG levels up from here.
  6124. ((integerp arg)
  6125. (save-excursion
  6126. (org-back-to-heading)
  6127. (outline-up-heading (if (< arg 0) (- arg)
  6128. (- (funcall outline-level) arg)))
  6129. (org-show-subtree)))
  6130. ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
  6131. ((and (featurep 'org-inlinetask)
  6132. (org-inlinetask-at-task-p)
  6133. (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
  6134. (org-inlinetask-toggle-visibility))
  6135. ;; At an item/headline: delegate to `org-cycle-internal-local'.
  6136. ((and (or (and org-cycle-include-plain-lists (org-at-item-p))
  6137. (save-excursion (move-beginning-of-line 1)
  6138. (looking-at org-outline-regexp)))
  6139. (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
  6140. (org-cycle-internal-local))
  6141. ;; From there: TAB emulation and template completion.
  6142. (buffer-read-only (org-back-to-heading))
  6143. ((run-hook-with-args-until-success
  6144. 'org-tab-after-check-for-cycling-hook))
  6145. ((org-try-structure-completion))
  6146. ((run-hook-with-args-until-success
  6147. 'org-tab-before-tab-emulation-hook))
  6148. ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
  6149. (or (not (bolp))
  6150. (not (looking-at org-outline-regexp))))
  6151. (call-interactively (global-key-binding "\t")))
  6152. ((if (and (memq org-cycle-emulate-tab '(white whitestart))
  6153. (save-excursion (beginning-of-line 1) (looking-at "[ \t]*"))
  6154. (or (and (eq org-cycle-emulate-tab 'white)
  6155. (= (match-end 0) (point-at-eol)))
  6156. (and (eq org-cycle-emulate-tab 'whitestart)
  6157. (>= (match-end 0) pos))))
  6158. t
  6159. (eq org-cycle-emulate-tab t))
  6160. (call-interactively (global-key-binding "\t")))
  6161. (t (save-excursion
  6162. (org-back-to-heading)
  6163. (org-cycle)))))))
  6164. (defun org-cycle-internal-global ()
  6165. "Do the global cycling action."
  6166. ;; Hack to avoid display of messages for .org attachments in Gnus
  6167. (let ((ga (string-match "\\*fontification" (buffer-name))))
  6168. (cond
  6169. ((and (eq last-command this-command)
  6170. (eq org-cycle-global-status 'overview))
  6171. ;; We just created the overview - now do table of contents
  6172. ;; This can be slow in very large buffers, so indicate action
  6173. (run-hook-with-args 'org-pre-cycle-hook 'contents)
  6174. (unless ga (org-unlogged-message "CONTENTS..."))
  6175. (org-content)
  6176. (unless ga (org-unlogged-message "CONTENTS...done"))
  6177. (setq org-cycle-global-status 'contents)
  6178. (run-hook-with-args 'org-cycle-hook 'contents))
  6179. ((and (eq last-command this-command)
  6180. (eq org-cycle-global-status 'contents))
  6181. ;; We just showed the table of contents - now show everything
  6182. (run-hook-with-args 'org-pre-cycle-hook 'all)
  6183. (outline-show-all)
  6184. (unless ga (org-unlogged-message "SHOW ALL"))
  6185. (setq org-cycle-global-status 'all)
  6186. (run-hook-with-args 'org-cycle-hook 'all))
  6187. (t
  6188. ;; Default action: go to overview
  6189. (run-hook-with-args 'org-pre-cycle-hook 'overview)
  6190. (org-overview)
  6191. (unless ga (org-unlogged-message "OVERVIEW"))
  6192. (setq org-cycle-global-status 'overview)
  6193. (run-hook-with-args 'org-cycle-hook 'overview)))))
  6194. (defvar org-called-with-limited-levels nil
  6195. "Non-nil when `org-with-limited-levels' is currently active.")
  6196. (defun org-cycle-internal-local ()
  6197. "Do the local cycling action."
  6198. (let ((goal-column 0) eoh eol eos has-children children-skipped struct)
  6199. ;; First, determine end of headline (EOH), end of subtree or item
  6200. ;; (EOS), and if item or heading has children (HAS-CHILDREN).
  6201. (save-excursion
  6202. (if (org-at-item-p)
  6203. (progn
  6204. (beginning-of-line)
  6205. (setq struct (org-list-struct))
  6206. (setq eoh (point-at-eol))
  6207. (setq eos (org-list-get-item-end-before-blank (point) struct))
  6208. (setq has-children (org-list-has-child-p (point) struct)))
  6209. (org-back-to-heading)
  6210. (setq eoh (save-excursion (outline-end-of-heading) (point)))
  6211. (setq eos (save-excursion (org-end-of-subtree t t)
  6212. (when (bolp) (backward-char)) (point)))
  6213. (setq has-children
  6214. (or (save-excursion
  6215. (let ((level (funcall outline-level)))
  6216. (outline-next-heading)
  6217. (and (org-at-heading-p t)
  6218. (> (funcall outline-level) level))))
  6219. (save-excursion
  6220. (org-list-search-forward (org-item-beginning-re) eos t)))))
  6221. ;; Determine end invisible part of buffer (EOL)
  6222. (beginning-of-line 2)
  6223. (while (and (not (eobp)) ;This is like `next-line'.
  6224. (get-char-property (1- (point)) 'invisible))
  6225. (goto-char (next-single-char-property-change (point) 'invisible))
  6226. (and (eolp) (beginning-of-line 2)))
  6227. (setq eol (point)))
  6228. ;; Find out what to do next and set `this-command'
  6229. (cond
  6230. ((= eos eoh)
  6231. ;; Nothing is hidden behind this heading
  6232. (unless (org-before-first-heading-p)
  6233. (run-hook-with-args 'org-pre-cycle-hook 'empty))
  6234. (org-unlogged-message "EMPTY ENTRY")
  6235. (setq org-cycle-subtree-status nil)
  6236. (save-excursion
  6237. (goto-char eos)
  6238. (outline-next-heading)
  6239. (when (outline-invisible-p) (org-flag-heading nil))))
  6240. ((and (or (>= eol eos)
  6241. (not (string-match "\\S-" (buffer-substring eol eos))))
  6242. (or has-children
  6243. (not (setq children-skipped
  6244. org-cycle-skip-children-state-if-no-children))))
  6245. ;; Entire subtree is hidden in one line: children view
  6246. (unless (org-before-first-heading-p)
  6247. (run-hook-with-args 'org-pre-cycle-hook 'children))
  6248. (if (org-at-item-p)
  6249. (org-list-set-item-visibility (point-at-bol) struct 'children)
  6250. (org-show-entry)
  6251. (org-with-limited-levels (org-show-children))
  6252. ;; FIXME: This slows down the func way too much.
  6253. ;; How keep drawers hidden in subtree anyway?
  6254. ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
  6255. ;; (org-cycle-hide-drawers 'subtree))
  6256. ;; Fold every list in subtree to top-level items.
  6257. (when (eq org-cycle-include-plain-lists 'integrate)
  6258. (save-excursion
  6259. (org-back-to-heading)
  6260. (while (org-list-search-forward (org-item-beginning-re) eos t)
  6261. (beginning-of-line 1)
  6262. (let* ((struct (org-list-struct))
  6263. (prevs (org-list-prevs-alist struct))
  6264. (end (org-list-get-bottom-point struct)))
  6265. (dolist (e (org-list-get-all-items (point) struct prevs))
  6266. (org-list-set-item-visibility e struct 'folded))
  6267. (goto-char (if (< end eos) end eos)))))))
  6268. (org-unlogged-message "CHILDREN")
  6269. (save-excursion
  6270. (goto-char eos)
  6271. (outline-next-heading)
  6272. (when (outline-invisible-p) (org-flag-heading nil)))
  6273. (setq org-cycle-subtree-status 'children)
  6274. (unless (org-before-first-heading-p)
  6275. (run-hook-with-args 'org-cycle-hook 'children)))
  6276. ((or children-skipped
  6277. (and (eq last-command this-command)
  6278. (eq org-cycle-subtree-status 'children)))
  6279. ;; We just showed the children, or no children are there,
  6280. ;; now show everything.
  6281. (unless (org-before-first-heading-p)
  6282. (run-hook-with-args 'org-pre-cycle-hook 'subtree))
  6283. (outline-flag-region eoh eos nil)
  6284. (org-unlogged-message
  6285. (if children-skipped "SUBTREE (NO CHILDREN)" "SUBTREE"))
  6286. (setq org-cycle-subtree-status 'subtree)
  6287. (unless (org-before-first-heading-p)
  6288. (run-hook-with-args 'org-cycle-hook 'subtree)))
  6289. (t
  6290. ;; Default action: hide the subtree.
  6291. (run-hook-with-args 'org-pre-cycle-hook 'folded)
  6292. (outline-flag-region eoh eos t)
  6293. (org-unlogged-message "FOLDED")
  6294. (setq org-cycle-subtree-status 'folded)
  6295. (unless (org-before-first-heading-p)
  6296. (run-hook-with-args 'org-cycle-hook 'folded))))))
  6297. ;;;###autoload
  6298. (defun org-global-cycle (&optional arg)
  6299. "Cycle the global visibility. For details see `org-cycle'.
  6300. With `\\[universal-argument]' prefix ARG, switch to startup visibility.
  6301. With a numeric prefix, show all headlines up to that level."
  6302. (interactive "P")
  6303. (let ((org-cycle-include-plain-lists
  6304. (if (derived-mode-p 'org-mode) org-cycle-include-plain-lists nil)))
  6305. (cond
  6306. ((integerp arg)
  6307. (outline-show-all)
  6308. (outline-hide-sublevels arg)
  6309. (setq org-cycle-global-status 'contents))
  6310. ((equal arg '(4))
  6311. (org-set-startup-visibility)
  6312. (org-unlogged-message "Startup visibility, plus VISIBILITY properties."))
  6313. (t
  6314. (org-cycle '(4))))))
  6315. (defun org-set-startup-visibility ()
  6316. "Set the visibility required by startup options and properties."
  6317. (cond
  6318. ((eq org-startup-folded t)
  6319. (org-overview))
  6320. ((eq org-startup-folded 'content)
  6321. (org-content))
  6322. ((or (eq org-startup-folded 'showeverything)
  6323. (eq org-startup-folded nil))
  6324. (outline-show-all)))
  6325. (unless (eq org-startup-folded 'showeverything)
  6326. (when org-hide-block-startup (org-hide-block-all))
  6327. (org-set-visibility-according-to-property 'no-cleanup)
  6328. (org-cycle-hide-archived-subtrees 'all)
  6329. (org-cycle-hide-drawers 'all)
  6330. (org-cycle-show-empty-lines t)))
  6331. (defun org-set-visibility-according-to-property (&optional no-cleanup)
  6332. "Switch subtree visibilities according to :VISIBILITY: property."
  6333. (interactive)
  6334. (org-with-wide-buffer
  6335. (goto-char (point-min))
  6336. (while (re-search-forward "^[ \t]*:VISIBILITY:" nil t)
  6337. (if (not (org-at-property-p)) (outline-next-heading)
  6338. (let ((state (match-string 3)))
  6339. (save-excursion
  6340. (org-back-to-heading t)
  6341. (outline-hide-subtree)
  6342. (org-reveal)
  6343. (cond
  6344. ((equal state "folded")
  6345. (outline-hide-subtree))
  6346. ((equal state "children")
  6347. (org-show-hidden-entry)
  6348. (org-show-children))
  6349. ((equal state "content")
  6350. (save-excursion
  6351. (save-restriction
  6352. (org-narrow-to-subtree)
  6353. (org-content))))
  6354. ((member state '("all" "showall"))
  6355. (outline-show-subtree)))))))
  6356. (unless no-cleanup
  6357. (org-cycle-hide-archived-subtrees 'all)
  6358. (org-cycle-hide-drawers 'all)
  6359. (org-cycle-show-empty-lines 'all))))
  6360. ;; This function uses outline-regexp instead of the more fundamental
  6361. ;; org-outline-regexp so that org-cycle-global works outside of Org
  6362. ;; buffers, where outline-regexp is needed.
  6363. (defun org-overview ()
  6364. "Switch to overview mode, showing only top-level headlines.
  6365. This shows all headlines with a level equal or greater than the level
  6366. of the first headline in the buffer. This is important, because if the
  6367. first headline is not level one, then (hide-sublevels 1) gives confusing
  6368. results."
  6369. (interactive)
  6370. (save-excursion
  6371. (let ((level
  6372. (save-excursion
  6373. (goto-char (point-min))
  6374. (when (re-search-forward (concat "^" outline-regexp) nil t)
  6375. (goto-char (match-beginning 0))
  6376. (funcall outline-level)))))
  6377. (and level (outline-hide-sublevels level)))))
  6378. (defun org-content (&optional arg)
  6379. "Show all headlines in the buffer, like a table of contents.
  6380. With numerical argument N, show content up to level N."
  6381. (interactive "P")
  6382. (org-overview)
  6383. (save-excursion
  6384. ;; Visit all headings and show their offspring
  6385. (and (integerp arg) (org-overview))
  6386. (goto-char (point-max))
  6387. (catch 'exit
  6388. (while (and (progn (condition-case nil
  6389. (outline-previous-visible-heading 1)
  6390. (error (goto-char (point-min))))
  6391. t)
  6392. (looking-at org-outline-regexp))
  6393. (if (integerp arg)
  6394. (org-show-children (1- arg))
  6395. (outline-show-branches))
  6396. (when (bobp) (throw 'exit nil))))))
  6397. (defun org-optimize-window-after-visibility-change (state)
  6398. "Adjust the window after a change in outline visibility.
  6399. This function is the default value of the hook `org-cycle-hook'."
  6400. (when (get-buffer-window (current-buffer))
  6401. (cond
  6402. ((eq state 'content) nil)
  6403. ((eq state 'all) nil)
  6404. ((eq state 'folded) nil)
  6405. ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
  6406. ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
  6407. (defun org-remove-empty-overlays-at (pos)
  6408. "Remove outline overlays that do not contain non-white stuff."
  6409. (dolist (o (overlays-at pos))
  6410. (and (eq 'outline (overlay-get o 'invisible))
  6411. (not (string-match "\\S-" (buffer-substring (overlay-start o)
  6412. (overlay-end o))))
  6413. (delete-overlay o))))
  6414. (defun org-clean-visibility-after-subtree-move ()
  6415. "Fix visibility issues after moving a subtree."
  6416. ;; First, find a reasonable region to look at:
  6417. ;; Start two siblings above, end three below
  6418. (let* ((beg (save-excursion
  6419. (and (org-get-last-sibling)
  6420. (org-get-last-sibling))
  6421. (point)))
  6422. (end (save-excursion
  6423. (and (org-get-next-sibling)
  6424. (org-get-next-sibling)
  6425. (org-get-next-sibling))
  6426. (if (org-at-heading-p)
  6427. (point-at-eol)
  6428. (point))))
  6429. (level (looking-at "\\*+"))
  6430. (re (when level (concat "^" (regexp-quote (match-string 0)) " "))))
  6431. (save-excursion
  6432. (save-restriction
  6433. (narrow-to-region beg end)
  6434. (when re
  6435. ;; Properly fold already folded siblings
  6436. (goto-char (point-min))
  6437. (while (re-search-forward re nil t)
  6438. (when (and (not (outline-invisible-p))
  6439. (save-excursion
  6440. (goto-char (point-at-eol)) (outline-invisible-p)))
  6441. (outline-hide-entry))))
  6442. (org-cycle-show-empty-lines 'overview)
  6443. (org-cycle-hide-drawers 'overview)))))
  6444. (defun org-cycle-show-empty-lines (state)
  6445. "Show empty lines above all visible headlines.
  6446. The region to be covered depends on STATE when called through
  6447. `org-cycle-hook'. Lisp program can use t for STATE to get the
  6448. entire buffer covered. Note that an empty line is only shown if there
  6449. are at least `org-cycle-separator-lines' empty lines before the headline."
  6450. (when (/= org-cycle-separator-lines 0)
  6451. (save-excursion
  6452. (let* ((n (abs org-cycle-separator-lines))
  6453. (re (cond
  6454. ((= n 1) "\\(\n[ \t]*\n\\*+\\) ")
  6455. ((= n 2) "^[ \t]*\\(\n[ \t]*\n\\*+\\) ")
  6456. (t (let ((ns (number-to-string (- n 2))))
  6457. (concat "^\\(?:[ \t]*\n\\)\\{" ns "," ns "\\}"
  6458. "[ \t]*\\(\n[ \t]*\n\\*+\\) ")))))
  6459. beg end)
  6460. (cond
  6461. ((memq state '(overview contents t))
  6462. (setq beg (point-min) end (point-max)))
  6463. ((memq state '(children folded))
  6464. (setq beg (point)
  6465. end (progn (org-end-of-subtree t t)
  6466. (line-beginning-position 2)))))
  6467. (when beg
  6468. (goto-char beg)
  6469. (while (re-search-forward re end t)
  6470. (unless (get-char-property (match-end 1) 'invisible)
  6471. (let ((e (match-end 1))
  6472. (b (if (>= org-cycle-separator-lines 0)
  6473. (match-beginning 1)
  6474. (save-excursion
  6475. (goto-char (match-beginning 0))
  6476. (skip-chars-backward " \t\n")
  6477. (line-end-position)))))
  6478. (outline-flag-region b e nil))))))))
  6479. ;; Never hide empty lines at the end of the file.
  6480. (save-excursion
  6481. (goto-char (point-max))
  6482. (outline-previous-heading)
  6483. (outline-end-of-heading)
  6484. (when (and (looking-at "[ \t\n]+")
  6485. (= (match-end 0) (point-max)))
  6486. (outline-flag-region (point) (match-end 0) nil))))
  6487. (defun org-show-empty-lines-in-parent ()
  6488. "Move to the parent and re-show empty lines before visible headlines."
  6489. (save-excursion
  6490. (let ((context (if (org-up-heading-safe) 'children 'overview)))
  6491. (org-cycle-show-empty-lines context))))
  6492. (defun org-files-list ()
  6493. "Return `org-agenda-files' list, plus all open Org files.
  6494. This is useful for operations that need to scan all of a user's
  6495. open and agenda-wise Org files."
  6496. (let ((files (mapcar 'expand-file-name (org-agenda-files))))
  6497. (dolist (buf (buffer-list))
  6498. (with-current-buffer buf
  6499. (when (and (derived-mode-p 'org-mode) (buffer-file-name))
  6500. (cl-pushnew (expand-file-name (buffer-file-name)) files))))
  6501. files))
  6502. (defsubst org-entry-beginning-position ()
  6503. "Return the beginning position of the current entry."
  6504. (save-excursion (org-back-to-heading t) (point)))
  6505. (defsubst org-entry-end-position ()
  6506. "Return the end position of the current entry."
  6507. (save-excursion (outline-next-heading) (point)))
  6508. (defun org-cycle-hide-drawers (state &optional exceptions)
  6509. "Re-hide all drawers after a visibility state change.
  6510. When non-nil, optional argument EXCEPTIONS is a list of strings
  6511. specifying which drawers should not be hidden."
  6512. (when (and (derived-mode-p 'org-mode)
  6513. (not (memq state '(overview folded contents))))
  6514. (save-excursion
  6515. (let* ((globalp (memq state '(contents all)))
  6516. (beg (if globalp (point-min) (point)))
  6517. (end (if globalp (point-max)
  6518. (if (eq state 'children)
  6519. (save-excursion (outline-next-heading) (point))
  6520. (org-end-of-subtree t)))))
  6521. (goto-char beg)
  6522. (while (re-search-forward org-drawer-regexp (max end (point)) t)
  6523. (unless (member-ignore-case (match-string 1) exceptions)
  6524. (let ((drawer (org-element-at-point)))
  6525. (when (memq (org-element-type drawer) '(drawer property-drawer))
  6526. (org-flag-drawer t drawer)
  6527. ;; Make sure to skip drawer entirely or we might flag
  6528. ;; it another time when matching its ending line with
  6529. ;; `org-drawer-regexp'.
  6530. (goto-char (org-element-property :end drawer))))))))))
  6531. (defun org-flag-drawer (flag &optional element)
  6532. "When FLAG is non-nil, hide the drawer we are at.
  6533. Otherwise make it visible. When optional argument ELEMENT is
  6534. a parsed drawer, as returned by `org-element-at-point', hide or
  6535. show that drawer instead."
  6536. (let ((drawer (or element
  6537. (and (save-excursion
  6538. (beginning-of-line)
  6539. (looking-at-p org-drawer-regexp))
  6540. (org-element-at-point)))))
  6541. (when (memq (org-element-type drawer) '(drawer property-drawer))
  6542. (let ((post (org-element-property :post-affiliated drawer)))
  6543. (save-excursion
  6544. (outline-flag-region
  6545. (progn (goto-char post) (line-end-position))
  6546. (progn (goto-char (org-element-property :end drawer))
  6547. (skip-chars-backward " \r\t\n")
  6548. (line-end-position))
  6549. flag))
  6550. ;; When the drawer is hidden away, make sure point lies in
  6551. ;; a visible part of the buffer.
  6552. (when (and flag (> (line-beginning-position) post))
  6553. (goto-char post))))))
  6554. (defun org-subtree-end-visible-p ()
  6555. "Is the end of the current subtree visible?"
  6556. (pos-visible-in-window-p
  6557. (save-excursion (org-end-of-subtree t) (point))))
  6558. (defun org-first-headline-recenter ()
  6559. "Move cursor to the first headline and recenter the headline."
  6560. (let ((window (get-buffer-window)))
  6561. (when window
  6562. (goto-char (point-min))
  6563. (when (re-search-forward (concat "^\\(" org-outline-regexp "\\)") nil t)
  6564. (set-window-start window (line-beginning-position))))))
  6565. ;;; Saving and restoring visibility
  6566. (defun org-outline-overlay-data (&optional use-markers)
  6567. "Return a list of the locations of all outline overlays.
  6568. These are overlays with the `invisible' property value `outline'.
  6569. The return value is a list of cons cells, with start and stop
  6570. positions for each overlay.
  6571. If USE-MARKERS is set, return the positions as markers."
  6572. (let (beg end)
  6573. (org-with-wide-buffer
  6574. (delq nil
  6575. (mapcar (lambda (o)
  6576. (when (eq (overlay-get o 'invisible) 'outline)
  6577. (setq beg (overlay-start o)
  6578. end (overlay-end o))
  6579. (and beg end (> end beg)
  6580. (if use-markers
  6581. (cons (copy-marker beg)
  6582. (copy-marker end t))
  6583. (cons beg end)))))
  6584. (overlays-in (point-min) (point-max)))))))
  6585. (defun org-set-outline-overlay-data (data)
  6586. "Create visibility overlays for all positions in DATA.
  6587. DATA should have been made by `org-outline-overlay-data'."
  6588. (org-with-wide-buffer
  6589. (outline-show-all)
  6590. (dolist (c data) (outline-flag-region (car c) (cdr c) t))))
  6591. ;;; Folding of blocks
  6592. (defvar-local org-hide-block-overlays nil
  6593. "Overlays hiding blocks.")
  6594. (defun org-block-map (function &optional start end)
  6595. "Call FUNCTION at the head of all source blocks in the current buffer.
  6596. Optional arguments START and END can be used to limit the range."
  6597. (let ((start (or start (point-min)))
  6598. (end (or end (point-max))))
  6599. (save-excursion
  6600. (goto-char start)
  6601. (while (and (< (point) end) (re-search-forward org-block-regexp end t))
  6602. (save-excursion
  6603. (save-match-data
  6604. (goto-char (match-beginning 0))
  6605. (funcall function)))))))
  6606. (defun org-hide-block-toggle-all ()
  6607. "Toggle the visibility of all blocks in the current buffer."
  6608. (org-block-map 'org-hide-block-toggle))
  6609. (defun org-hide-block-all ()
  6610. "Fold all blocks in the current buffer."
  6611. (interactive)
  6612. (org-show-block-all)
  6613. (org-block-map 'org-hide-block-toggle-maybe))
  6614. (defun org-show-block-all ()
  6615. "Unfold all blocks in the current buffer."
  6616. (interactive)
  6617. (mapc #'delete-overlay org-hide-block-overlays)
  6618. (setq org-hide-block-overlays nil))
  6619. (defun org-hide-block-toggle-maybe ()
  6620. "Toggle visibility of block at point.
  6621. Unlike to `org-hide-block-toggle', this function does not throw
  6622. an error. Return a non-nil value when toggling is successful."
  6623. (interactive)
  6624. (ignore-errors (org-hide-block-toggle)))
  6625. (defun org-hide-block-toggle (&optional force)
  6626. "Toggle the visibility of the current block.
  6627. When optional argument FORCE is `off', make block visible. If it
  6628. is non-nil, hide it unconditionally. Throw an error when not at
  6629. a block. Return a non-nil value when toggling is successful."
  6630. (interactive)
  6631. (let ((element (org-element-at-point)))
  6632. (unless (memq (org-element-type element)
  6633. '(center-block comment-block dynamic-block example-block
  6634. export-block quote-block special-block
  6635. src-block verse-block))
  6636. (user-error "Not at a block"))
  6637. (let* ((start (save-excursion
  6638. (goto-char (org-element-property :post-affiliated element))
  6639. (line-end-position)))
  6640. (end (save-excursion
  6641. (goto-char (org-element-property :end element))
  6642. (skip-chars-backward " \r\t\n")
  6643. (line-end-position)))
  6644. (overlays (overlays-at start)))
  6645. (cond
  6646. ;; Do nothing when not before or at the block opening line or
  6647. ;; at the block closing line.
  6648. ((let ((eol (line-end-position))) (and (> eol start) (/= eol end))) nil)
  6649. ((and (not (eq force 'off))
  6650. (not (memq t (mapcar
  6651. (lambda (o)
  6652. (eq (overlay-get o 'invisible) 'org-hide-block))
  6653. overlays))))
  6654. (let ((ov (make-overlay start end)))
  6655. (overlay-put ov 'invisible 'org-hide-block)
  6656. ;; Make the block accessible to `isearch'.
  6657. (overlay-put
  6658. ov 'isearch-open-invisible
  6659. (lambda (ov)
  6660. (when (memq ov org-hide-block-overlays)
  6661. (setq org-hide-block-overlays (delq ov org-hide-block-overlays)))
  6662. (when (eq (overlay-get ov 'invisible) 'org-hide-block)
  6663. (delete-overlay ov))))
  6664. (push ov org-hide-block-overlays)
  6665. ;; When the block is hidden away, make sure point is left in
  6666. ;; a visible part of the buffer.
  6667. (when (> (line-beginning-position) start)
  6668. (goto-char start)
  6669. (beginning-of-line))
  6670. ;; Signal successful toggling.
  6671. t))
  6672. ((or (not force) (eq force 'off))
  6673. (dolist (ov overlays t)
  6674. (when (memq ov org-hide-block-overlays)
  6675. (setq org-hide-block-overlays (delq ov org-hide-block-overlays)))
  6676. (when (eq (overlay-get ov 'invisible) 'org-hide-block)
  6677. (delete-overlay ov))))))))
  6678. ;; Remove overlays when changing major mode
  6679. (add-hook 'org-mode-hook
  6680. (lambda () (add-hook 'change-major-mode-hook
  6681. 'org-show-block-all 'append 'local)))
  6682. ;;; Org-goto
  6683. (defvar org-goto-window-configuration nil)
  6684. (defvar org-goto-marker nil)
  6685. (defvar org-goto-map)
  6686. (defun org-goto-map ()
  6687. "Set the keymap `org-goto'."
  6688. (setq org-goto-map
  6689. (let ((map (make-sparse-keymap)))
  6690. (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command
  6691. mouse-drag-region universal-argument org-occur)))
  6692. (dolist (cmd cmds)
  6693. (substitute-key-definition cmd cmd map global-map)))
  6694. (suppress-keymap map)
  6695. (org-defkey map "\C-m" 'org-goto-ret)
  6696. (org-defkey map [(return)] 'org-goto-ret)
  6697. (org-defkey map [(left)] 'org-goto-left)
  6698. (org-defkey map [(right)] 'org-goto-right)
  6699. (org-defkey map [(control ?g)] 'org-goto-quit)
  6700. (org-defkey map "\C-i" 'org-cycle)
  6701. (org-defkey map [(tab)] 'org-cycle)
  6702. (org-defkey map [(down)] 'outline-next-visible-heading)
  6703. (org-defkey map [(up)] 'outline-previous-visible-heading)
  6704. (if org-goto-auto-isearch
  6705. (if (fboundp 'define-key-after)
  6706. (define-key-after map [t] 'org-goto-local-auto-isearch)
  6707. nil)
  6708. (org-defkey map "q" 'org-goto-quit)
  6709. (org-defkey map "n" 'outline-next-visible-heading)
  6710. (org-defkey map "p" 'outline-previous-visible-heading)
  6711. (org-defkey map "f" 'outline-forward-same-level)
  6712. (org-defkey map "b" 'outline-backward-same-level)
  6713. (org-defkey map "u" 'outline-up-heading))
  6714. (org-defkey map "/" 'org-occur)
  6715. (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
  6716. (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
  6717. (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
  6718. (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
  6719. (org-defkey map "\C-c\C-u" 'outline-up-heading)
  6720. map)))
  6721. (defconst org-goto-help
  6722. "Browse buffer copy, to find location or copy text.%s
  6723. RET=jump to location C-g=quit and return to previous location
  6724. \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
  6725. (defvar org-goto-start-pos) ; dynamically scoped parameter
  6726. (defun org-goto (&optional alternative-interface)
  6727. "Look up a different location in the current file, keeping current visibility.
  6728. When you want look-up or go to a different location in a
  6729. document, the fastest way is often to fold the entire buffer and
  6730. then dive into the tree. This method has the disadvantage, that
  6731. the previous location will be folded, which may not be what you
  6732. want.
  6733. This command works around this by showing a copy of the current
  6734. buffer in an indirect buffer, in overview mode. You can dive
  6735. into the tree in that copy, use org-occur and incremental search
  6736. to find a location. When pressing RET or `Q', the command
  6737. returns to the original buffer in which the visibility is still
  6738. unchanged. After RET it will also jump to the location selected
  6739. in the indirect buffer and expose the headline hierarchy above.
  6740. With a prefix argument, use the alternative interface: e.g., if
  6741. `org-goto-interface' is `outline' use `outline-path-completion'."
  6742. (interactive "P")
  6743. (org-goto-map)
  6744. (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
  6745. (org-refile-use-outline-path t)
  6746. (org-refile-target-verify-function nil)
  6747. (interface
  6748. (if (not alternative-interface)
  6749. org-goto-interface
  6750. (if (eq org-goto-interface 'outline)
  6751. 'outline-path-completion
  6752. 'outline)))
  6753. (org-goto-start-pos (point))
  6754. (selected-point
  6755. (if (eq interface 'outline)
  6756. (car (org-get-location (current-buffer) org-goto-help))
  6757. (let ((pa (org-refile-get-location "Goto")))
  6758. (org-refile-check-position pa)
  6759. (nth 3 pa)))))
  6760. (if selected-point
  6761. (progn
  6762. (org-mark-ring-push org-goto-start-pos)
  6763. (goto-char selected-point)
  6764. (when (or (outline-invisible-p) (org-invisible-p2))
  6765. (org-show-context 'org-goto)))
  6766. (message "Quit"))))
  6767. (defvar org-goto-selected-point nil) ; dynamically scoped parameter
  6768. (defvar org-goto-exit-command nil) ; dynamically scoped parameter
  6769. (defvar org-goto-local-auto-isearch-map) ; defined below
  6770. (defun org-get-location (_buf help)
  6771. "Let the user select a location in current buffer.
  6772. This function uses a recursive edit. It returns the selected position
  6773. or nil."
  6774. (org-no-popups
  6775. (let ((isearch-mode-map org-goto-local-auto-isearch-map)
  6776. (isearch-hide-immediately nil)
  6777. (isearch-search-fun-function
  6778. (lambda () 'org-goto-local-search-headings))
  6779. (org-goto-selected-point org-goto-exit-command))
  6780. (save-excursion
  6781. (save-window-excursion
  6782. (delete-other-windows)
  6783. (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
  6784. (pop-to-buffer-same-window
  6785. (condition-case nil
  6786. (make-indirect-buffer (current-buffer) "*org-goto*")
  6787. (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
  6788. (with-output-to-temp-buffer "*Org Help*"
  6789. (princ (format help (if org-goto-auto-isearch
  6790. " Just type for auto-isearch."
  6791. " n/p/f/b/u to navigate, q to quit."))))
  6792. (org-fit-window-to-buffer (get-buffer-window "*Org Help*"))
  6793. (setq buffer-read-only nil)
  6794. (let ((org-startup-truncated t)
  6795. (org-startup-folded nil)
  6796. (org-startup-align-all-tables nil))
  6797. (org-mode)
  6798. (org-overview))
  6799. (setq buffer-read-only t)
  6800. (if (and (boundp 'org-goto-start-pos)
  6801. (integer-or-marker-p org-goto-start-pos))
  6802. (progn (goto-char org-goto-start-pos)
  6803. (when (outline-invisible-p)
  6804. (org-show-set-visibility 'lineage)))
  6805. (goto-char (point-min)))
  6806. (let (org-special-ctrl-a/e) (org-beginning-of-line))
  6807. (message "Select location and press RET")
  6808. (use-local-map org-goto-map)
  6809. (recursive-edit)))
  6810. (kill-buffer "*org-goto*")
  6811. (cons org-goto-selected-point org-goto-exit-command))))
  6812. (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
  6813. (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
  6814. ;; `isearch-other-control-char' was removed in Emacs 24.4.
  6815. (if (fboundp 'isearch-other-control-char)
  6816. (progn
  6817. (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
  6818. (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char))
  6819. (define-key org-goto-local-auto-isearch-map "\C-i" nil)
  6820. (define-key org-goto-local-auto-isearch-map "\C-m" nil)
  6821. (define-key org-goto-local-auto-isearch-map [return] nil))
  6822. (defun org-goto-local-search-headings (string bound noerror)
  6823. "Search and make sure that any matches are in headlines."
  6824. (catch 'return
  6825. (while (if isearch-forward
  6826. (search-forward string bound noerror)
  6827. (search-backward string bound noerror))
  6828. (when (save-match-data
  6829. (and (save-excursion
  6830. (beginning-of-line)
  6831. (looking-at org-complex-heading-regexp))
  6832. (or (not (match-beginning 5))
  6833. (< (point) (match-beginning 5)))))
  6834. (throw 'return (point))))))
  6835. (defun org-goto-local-auto-isearch ()
  6836. "Start isearch."
  6837. (interactive)
  6838. (goto-char (point-min))
  6839. (let ((keys (this-command-keys)))
  6840. (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
  6841. (isearch-mode t)
  6842. (isearch-process-search-char (string-to-char keys)))))
  6843. (defun org-goto-ret (&optional _arg)
  6844. "Finish `org-goto' by going to the new location."
  6845. (interactive "P")
  6846. (setq org-goto-selected-point (point))
  6847. (setq org-goto-exit-command 'return)
  6848. (throw 'exit nil))
  6849. (defun org-goto-left ()
  6850. "Finish `org-goto' by going to the new location."
  6851. (interactive)
  6852. (if (org-at-heading-p)
  6853. (progn
  6854. (beginning-of-line 1)
  6855. (setq org-goto-selected-point (point)
  6856. org-goto-exit-command 'left)
  6857. (throw 'exit nil))
  6858. (user-error "Not on a heading")))
  6859. (defun org-goto-right ()
  6860. "Finish `org-goto' by going to the new location."
  6861. (interactive)
  6862. (if (org-at-heading-p)
  6863. (progn
  6864. (setq org-goto-selected-point (point)
  6865. org-goto-exit-command 'right)
  6866. (throw 'exit nil))
  6867. (user-error "Not on a heading")))
  6868. (defun org-goto-quit ()
  6869. "Finish `org-goto' without cursor motion."
  6870. (interactive)
  6871. (setq org-goto-selected-point nil)
  6872. (setq org-goto-exit-command 'quit)
  6873. (throw 'exit nil))
  6874. ;;; Indirect buffer display of subtrees
  6875. (defvar org-indirect-dedicated-frame nil
  6876. "This is the frame being used for indirect tree display.")
  6877. (defvar org-last-indirect-buffer nil)
  6878. (defun org-tree-to-indirect-buffer (&optional arg)
  6879. "Create indirect buffer and narrow it to current subtree.
  6880. With a numerical prefix ARG, go up to this level and then take that tree.
  6881. If ARG is negative, go up that many levels.
  6882. If `org-indirect-buffer-display' is not `new-frame', the command removes the
  6883. indirect buffer previously made with this command, to avoid proliferation of
  6884. indirect buffers. However, when you call the command with a \
  6885. `\\[universal-argument]' prefix, or
  6886. when `org-indirect-buffer-display' is `new-frame', the last buffer is kept
  6887. so that you can work with several indirect buffers at the same time. If
  6888. `org-indirect-buffer-display' is `dedicated-frame', the \
  6889. `\\[universal-argument]' prefix also
  6890. requests that a new frame be made for the new buffer, so that the dedicated
  6891. frame is not changed."
  6892. (interactive "P")
  6893. (let ((cbuf (current-buffer))
  6894. (cwin (selected-window))
  6895. (pos (point))
  6896. beg end level heading ibuf)
  6897. (save-excursion
  6898. (org-back-to-heading t)
  6899. (when (numberp arg)
  6900. (setq level (org-outline-level))
  6901. (when (< arg 0) (setq arg (+ level arg)))
  6902. (while (> (setq level (org-outline-level)) arg)
  6903. (org-up-heading-safe)))
  6904. (setq beg (point)
  6905. heading (org-get-heading 'no-tags))
  6906. (org-end-of-subtree t t)
  6907. (when (org-at-heading-p) (backward-char 1))
  6908. (setq end (point)))
  6909. (when (and (buffer-live-p org-last-indirect-buffer)
  6910. (not (eq org-indirect-buffer-display 'new-frame))
  6911. (not arg))
  6912. (kill-buffer org-last-indirect-buffer))
  6913. (setq ibuf (org-get-indirect-buffer cbuf heading)
  6914. org-last-indirect-buffer ibuf)
  6915. (cond
  6916. ((or (eq org-indirect-buffer-display 'new-frame)
  6917. (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
  6918. (select-frame (make-frame))
  6919. (delete-other-windows)
  6920. (pop-to-buffer-same-window ibuf)
  6921. (org-set-frame-title heading))
  6922. ((eq org-indirect-buffer-display 'dedicated-frame)
  6923. (raise-frame
  6924. (select-frame (or (and org-indirect-dedicated-frame
  6925. (frame-live-p org-indirect-dedicated-frame)
  6926. org-indirect-dedicated-frame)
  6927. (setq org-indirect-dedicated-frame (make-frame)))))
  6928. (delete-other-windows)
  6929. (pop-to-buffer-same-window ibuf)
  6930. (org-set-frame-title (concat "Indirect: " heading)))
  6931. ((eq org-indirect-buffer-display 'current-window)
  6932. (pop-to-buffer-same-window ibuf))
  6933. ((eq org-indirect-buffer-display 'other-window)
  6934. (pop-to-buffer ibuf))
  6935. (t (error "Invalid value")))
  6936. (narrow-to-region beg end)
  6937. (outline-show-all)
  6938. (goto-char pos)
  6939. (run-hook-with-args 'org-cycle-hook 'all)
  6940. (and (window-live-p cwin) (select-window cwin))))
  6941. (defun org-get-indirect-buffer (&optional buffer heading)
  6942. (setq buffer (or buffer (current-buffer)))
  6943. (let ((n 1) (base (buffer-name buffer)) bname)
  6944. (while (buffer-live-p
  6945. (get-buffer
  6946. (setq bname
  6947. (concat base "-"
  6948. (if heading (concat heading "-" (number-to-string n))
  6949. (number-to-string n))))))
  6950. (setq n (1+ n)))
  6951. (condition-case nil
  6952. (make-indirect-buffer buffer bname 'clone)
  6953. (error (make-indirect-buffer buffer bname)))))
  6954. (defun org-set-frame-title (title)
  6955. "Set the title of the current frame to the string TITLE."
  6956. (modify-frame-parameters (selected-frame) (list (cons 'name title))))
  6957. ;;;; Structure editing
  6958. ;;; Inserting headlines
  6959. (defun org--line-empty-p (n)
  6960. "Is the Nth next line empty?
  6961. Counts the current line as N = 1 and the previous line as N = 0;
  6962. see `beginning-of-line'."
  6963. (save-excursion
  6964. (and (not (bobp))
  6965. (or (beginning-of-line n) t)
  6966. (save-match-data
  6967. (looking-at "[ \t]*$")))))
  6968. (defun org-previous-line-empty-p ()
  6969. "Is the previous line a blank line?
  6970. When NEXT is non-nil, check the next line instead."
  6971. (org--line-empty-p 0))
  6972. (defun org-next-line-empty-p ()
  6973. "Is the previous line a blank line?
  6974. When NEXT is non-nil, check the next line instead."
  6975. (org--line-empty-p 2))
  6976. (defun org--blank-before-heading-p (&optional parent)
  6977. "Non-nil when an empty line should precede a new heading here.
  6978. When optional argument PARENT is non-nil, consider parent
  6979. headline instead of current one."
  6980. (pcase (assq 'heading org-blank-before-new-entry)
  6981. (`(heading . auto)
  6982. (save-excursion
  6983. (org-with-limited-levels
  6984. (unless (and (org-before-first-heading-p)
  6985. (not (outline-next-heading)))
  6986. (org-back-to-heading t)
  6987. (when parent (org-up-heading-safe))
  6988. (cond ((not (bobp))
  6989. (org-previous-line-empty-p))
  6990. ((outline-next-heading)
  6991. (org-previous-line-empty-p))
  6992. ;; Ignore trailing spaces on last buffer line.
  6993. ((progn (skip-chars-backward " \t") (bolp))
  6994. (org-previous-line-empty-p))
  6995. (t nil))))))
  6996. (`(heading . ,value) value)
  6997. (_ nil)))
  6998. (defun org-insert-heading (&optional arg invisible-ok top)
  6999. "Insert a new heading or an item with the same depth at point.
  7000. If point is at the beginning of a heading, insert a new heading
  7001. or a new headline above the current one. When at the beginning
  7002. of a regular line of text, turn it into a heading.
  7003. If point is in the middle of a line, split it and create a new
  7004. headline with the text in the current line after point (see
  7005. `org-M-RET-may-split-line' on how to modify this behavior). As
  7006. a special case, on a headline, splitting can only happen on the
  7007. title itself. E.g., this excludes breaking stars or tags.
  7008. With a `\\[universal-argument]' prefix, set \
  7009. `org-insert-heading-respect-content' to
  7010. a non-nil value for the duration of the command. This forces the
  7011. insertion of a heading after the current subtree, independently
  7012. on the location of point.
  7013. With a `\\[universal-argument] \\[universal-argument]' prefix, \
  7014. insert the heading at the end of the tree
  7015. above the current heading. For example, if point is within a
  7016. 2nd-level heading, then it will insert a 2nd-level heading at
  7017. the end of the 1st-level parent subtree.
  7018. When INVISIBLE-OK is set, stop at invisible headlines when going
  7019. back. This is important for non-interactive uses of the
  7020. command.
  7021. When optional argument TOP is non-nil, insert a level 1 heading,
  7022. unconditionally."
  7023. (interactive "P")
  7024. (let* ((blank? (org--blank-before-heading-p (equal arg '(16))))
  7025. (level (org-current-level))
  7026. (stars (make-string (if (and level (not top)) level 1) ?*)))
  7027. (cond
  7028. ((or org-insert-heading-respect-content
  7029. (member arg '((4) (16)))
  7030. (and (not invisible-ok)
  7031. (invisible-p (max (1- (point)) (point-min)))))
  7032. ;; Position point at the location of insertion.
  7033. (if (not level) ;before first headline
  7034. (org-with-limited-levels (outline-next-heading))
  7035. ;; Make sure we end up on a visible headline if INVISIBLE-OK
  7036. ;; is nil.
  7037. (org-with-limited-levels (org-back-to-heading invisible-ok))
  7038. (cond ((equal arg '(16))
  7039. (org-up-heading-safe)
  7040. (org-end-of-subtree t t))
  7041. (t
  7042. (org-end-of-subtree t t))))
  7043. (unless (bolp) (insert "\n")) ;ensure final newline
  7044. (unless (and blank? (org-previous-line-empty-p))
  7045. (org-N-empty-lines-before-current (if blank? 1 0)))
  7046. (insert stars " \n")
  7047. (forward-char -1))
  7048. ;; At a headline...
  7049. ((org-at-heading-p)
  7050. (cond ((bolp)
  7051. (when blank? (save-excursion (insert "\n")))
  7052. (save-excursion (insert stars " \n"))
  7053. (unless (and blank? (org-previous-line-empty-p))
  7054. (org-N-empty-lines-before-current (if blank? 1 0)))
  7055. (end-of-line))
  7056. ((and (org-get-alist-option org-M-RET-may-split-line 'headline)
  7057. (org-match-line org-complex-heading-regexp)
  7058. (org-pos-in-match-range (point) 4))
  7059. ;; Grab the text that should moved to the new headline.
  7060. ;; Preserve tags.
  7061. (let ((split (delete-and-extract-region (point) (match-end 4))))
  7062. (if (looking-at "[ \t]*$") (replace-match "")
  7063. (org-set-tags nil t))
  7064. (end-of-line)
  7065. (when blank? (insert "\n"))
  7066. (insert "\n" stars " ")
  7067. (when (org-string-nw-p split) (insert split))
  7068. (insert "\n")
  7069. (forward-char -1)))
  7070. (t
  7071. (end-of-line)
  7072. (when blank? (insert "\n"))
  7073. (insert "\n" stars " \n")
  7074. (forward-char -1))))
  7075. ;; On regular text, turn line into a headline or split, if
  7076. ;; appropriate.
  7077. ((bolp)
  7078. (insert stars " ")
  7079. (unless (and blank? (org-previous-line-empty-p))
  7080. (org-N-empty-lines-before-current (if blank? 1 0))))
  7081. (t
  7082. (unless (org-get-alist-option org-M-RET-may-split-line 'headline)
  7083. (end-of-line))
  7084. (insert "\n" stars " ")
  7085. (unless (and blank? (org-previous-line-empty-p))
  7086. (org-N-empty-lines-before-current (if blank? 1 0))))))
  7087. (run-hooks 'org-insert-heading-hook))
  7088. (defun org-N-empty-lines-before-current (n)
  7089. "Make the number of empty lines before current exactly N.
  7090. So this will delete or add empty lines."
  7091. (let ((column (current-column))
  7092. (empty-lines (make-string n ?\n)))
  7093. (beginning-of-line)
  7094. (let ((p (point)))
  7095. (skip-chars-backward " \r\t\n")
  7096. (unless (bolp) (forward-line))
  7097. (delete-region (point) p))
  7098. (insert empty-lines)
  7099. (move-to-column column)))
  7100. (defun org-get-heading (&optional no-tags no-todo)
  7101. "Return the heading of the current entry, without the stars.
  7102. When NO-TAGS is non-nil, don't include tags.
  7103. When NO-TODO is non-nil, don't include TODO keywords."
  7104. (save-excursion
  7105. (org-back-to-heading t)
  7106. (let ((case-fold-search nil))
  7107. (cond
  7108. ((and no-tags no-todo)
  7109. (looking-at org-complex-heading-regexp)
  7110. ;; Return value has to be a string, but match group 4 is
  7111. ;; optional.
  7112. (or (match-string 4) ""))
  7113. (no-tags
  7114. (looking-at (concat org-outline-regexp
  7115. "\\(.*?\\)"
  7116. "\\(?:[ \t]+:[[:alnum:]:_@#%]+:\\)?[ \t]*$"))
  7117. (match-string 1))
  7118. (no-todo
  7119. (looking-at org-todo-line-regexp)
  7120. (match-string 3))
  7121. (t (looking-at org-heading-regexp)
  7122. (match-string 2))))))
  7123. (defvar orgstruct-mode) ; defined below
  7124. (defun org-heading-components ()
  7125. "Return the components of the current heading.
  7126. This is a list with the following elements:
  7127. - the level as an integer
  7128. - the reduced level, different if `org-odd-levels-only' is set.
  7129. - the TODO keyword, or nil
  7130. - the priority character, like ?A, or nil if no priority is given
  7131. - the headline text itself, or the tags string if no headline text
  7132. - the tags string, or nil."
  7133. (save-excursion
  7134. (org-back-to-heading t)
  7135. (when (let (case-fold-search)
  7136. (looking-at
  7137. (if orgstruct-mode
  7138. org-heading-regexp
  7139. org-complex-heading-regexp)))
  7140. (if orgstruct-mode
  7141. (list (length (match-string 1))
  7142. (org-reduced-level (length (match-string 1)))
  7143. nil
  7144. nil
  7145. (match-string 2)
  7146. nil)
  7147. (list (length (match-string 1))
  7148. (org-reduced-level (length (match-string 1)))
  7149. (match-string-no-properties 2)
  7150. (and (match-end 3) (aref (match-string 3) 2))
  7151. (match-string-no-properties 4)
  7152. (match-string-no-properties 5))))))
  7153. (defun org-get-entry ()
  7154. "Get the entry text, after heading, entire subtree."
  7155. (save-excursion
  7156. (org-back-to-heading t)
  7157. (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
  7158. (defun org-edit-headline (&optional heading)
  7159. "Edit the current headline.
  7160. Set it to HEADING when provided."
  7161. (interactive)
  7162. (org-with-wide-buffer
  7163. (org-back-to-heading t)
  7164. (let ((case-fold-search nil))
  7165. (when (looking-at org-complex-heading-regexp)
  7166. (let* ((old (match-string-no-properties 4))
  7167. (new (save-match-data
  7168. (org-trim (or heading (read-string "Edit: " old))))))
  7169. (unless (equal old new)
  7170. (if old (replace-match new t t nil 4)
  7171. (goto-char (or (match-end 3) (match-end 2) (match-end 1)))
  7172. (insert " " new))
  7173. (org-set-tags nil t)
  7174. (when (looking-at "[ \t]*$") (replace-match ""))))))))
  7175. (defun org-insert-heading-after-current ()
  7176. "Insert a new heading with same level as current, after current subtree."
  7177. (interactive)
  7178. (org-back-to-heading)
  7179. (org-insert-heading)
  7180. (org-move-subtree-down)
  7181. (end-of-line 1))
  7182. (defun org-insert-heading-respect-content (&optional invisible-ok)
  7183. "Insert heading with `org-insert-heading-respect-content' set to t."
  7184. (interactive)
  7185. (org-insert-heading '(4) invisible-ok))
  7186. (defun org-insert-todo-heading-respect-content (&optional force-state)
  7187. "Insert TODO heading with `org-insert-heading-respect-content' set to t."
  7188. (interactive)
  7189. (org-insert-todo-heading force-state '(4)))
  7190. (defun org-insert-todo-heading (arg &optional force-heading)
  7191. "Insert a new heading with the same level and TODO state as current heading.
  7192. If the heading has no TODO state, or if the state is DONE, use
  7193. the first state (TODO by default). Also with one prefix arg,
  7194. force first state. With two prefix args, force inserting at the
  7195. end of the parent subtree.
  7196. When called at a plain list item, insert a new item with an
  7197. unchecked check box."
  7198. (interactive "P")
  7199. (when (or force-heading (not (org-insert-item 'checkbox)))
  7200. (org-insert-heading (or (and (equal arg '(16)) '(16))
  7201. force-heading))
  7202. (save-excursion
  7203. (org-back-to-heading)
  7204. (outline-previous-heading)
  7205. (let ((case-fold-search nil)) (looking-at org-todo-line-regexp)))
  7206. (let* ((new-mark-x
  7207. (if (or (equal arg '(4))
  7208. (not (match-beginning 2))
  7209. (member (match-string 2) org-done-keywords))
  7210. (car org-todo-keywords-1)
  7211. (match-string 2)))
  7212. (new-mark
  7213. (or
  7214. (run-hook-with-args-until-success
  7215. 'org-todo-get-default-hook new-mark-x nil)
  7216. new-mark-x)))
  7217. (beginning-of-line 1)
  7218. (and (looking-at org-outline-regexp) (goto-char (match-end 0))
  7219. (if org-treat-insert-todo-heading-as-state-change
  7220. (org-todo new-mark)
  7221. (insert new-mark " "))))
  7222. (when org-provide-todo-statistics
  7223. (org-update-parent-todo-statistics))))
  7224. (defun org-insert-subheading (arg)
  7225. "Insert a new subheading and demote it.
  7226. Works for outline headings and for plain lists alike."
  7227. (interactive "P")
  7228. (org-insert-heading arg)
  7229. (cond
  7230. ((org-at-heading-p) (org-do-demote))
  7231. ((org-at-item-p) (org-indent-item))))
  7232. (defun org-insert-todo-subheading (arg)
  7233. "Insert a new subheading with TODO keyword or checkbox and demote it.
  7234. Works for outline headings and for plain lists alike."
  7235. (interactive "P")
  7236. (org-insert-todo-heading arg)
  7237. (cond
  7238. ((org-at-heading-p) (org-do-demote))
  7239. ((org-at-item-p) (org-indent-item))))
  7240. ;;; Promotion and Demotion
  7241. (defvar org-after-demote-entry-hook nil
  7242. "Hook run after an entry has been demoted.
  7243. The cursor will be at the beginning of the entry.
  7244. When a subtree is being demoted, the hook will be called for each node.")
  7245. (defvar org-after-promote-entry-hook nil
  7246. "Hook run after an entry has been promoted.
  7247. The cursor will be at the beginning of the entry.
  7248. When a subtree is being promoted, the hook will be called for each node.")
  7249. (defun org-promote-subtree ()
  7250. "Promote the entire subtree.
  7251. See also `org-promote'."
  7252. (interactive)
  7253. (save-excursion
  7254. (org-with-limited-levels (org-map-tree 'org-promote)))
  7255. (org-fix-position-after-promote))
  7256. (defun org-demote-subtree ()
  7257. "Demote the entire subtree.
  7258. See `org-demote' and `org-promote'."
  7259. (interactive)
  7260. (save-excursion
  7261. (org-with-limited-levels (org-map-tree 'org-demote)))
  7262. (org-fix-position-after-promote))
  7263. (defun org-do-promote ()
  7264. "Promote the current heading higher up the tree.
  7265. If the region is active in `transient-mark-mode', promote all
  7266. headings in the region."
  7267. (interactive)
  7268. (save-excursion
  7269. (if (org-region-active-p)
  7270. (org-map-region 'org-promote (region-beginning) (region-end))
  7271. (org-promote)))
  7272. (org-fix-position-after-promote))
  7273. (defun org-do-demote ()
  7274. "Demote the current heading lower down the tree.
  7275. If the region is active in `transient-mark-mode', demote all
  7276. headings in the region."
  7277. (interactive)
  7278. (save-excursion
  7279. (if (org-region-active-p)
  7280. (org-map-region 'org-demote (region-beginning) (region-end))
  7281. (org-demote)))
  7282. (org-fix-position-after-promote))
  7283. (defun org-fix-position-after-promote ()
  7284. "Fix cursor position and indentation after demoting/promoting."
  7285. (let ((pos (point)))
  7286. (when (save-excursion
  7287. (beginning-of-line)
  7288. (let ((case-fold-search nil)) (looking-at org-todo-line-regexp))
  7289. (or (eq pos (match-end 1)) (eq pos (match-end 2))))
  7290. (cond ((eobp) (insert " "))
  7291. ((eolp) (insert " "))
  7292. ((equal (char-after) ?\s) (forward-char 1))))))
  7293. (defun org-current-level ()
  7294. "Return the level of the current entry, or nil if before the first headline.
  7295. The level is the number of stars at the beginning of the
  7296. headline. Use `org-reduced-level' to remove the effect of
  7297. `org-odd-levels'. Unlike to `org-outline-level', this function
  7298. ignores inlinetasks."
  7299. (let ((level (org-with-limited-levels (org-outline-level))))
  7300. (and (> level 0) level)))
  7301. (defun org-get-previous-line-level ()
  7302. "Return the outline depth of the last headline before the current line.
  7303. Returns 0 for the first headline in the buffer, and nil if before the
  7304. first headline."
  7305. (and (org-current-level)
  7306. (or (and (/= (line-beginning-position) (point-min))
  7307. (save-excursion (beginning-of-line 0) (org-current-level)))
  7308. 0)))
  7309. (defun org-reduced-level (l)
  7310. "Compute the effective level of a heading.
  7311. This takes into account the setting of `org-odd-levels-only'."
  7312. (cond
  7313. ((zerop l) 0)
  7314. (org-odd-levels-only (1+ (floor (/ l 2))))
  7315. (t l)))
  7316. (defun org-level-increment ()
  7317. "Return the number of stars that will be added or removed at a
  7318. time to headlines when structure editing, based on the value of
  7319. `org-odd-levels-only'."
  7320. (if org-odd-levels-only 2 1))
  7321. (defun org-get-valid-level (level &optional change)
  7322. "Rectify a level change under the influence of `org-odd-levels-only'.
  7323. LEVEL is a current level, CHANGE is by how much the level should
  7324. be modified. Even if CHANGE is nil, LEVEL may be returned
  7325. modified because even level numbers will become the next higher
  7326. odd number. Returns values greater than 0."
  7327. (if org-odd-levels-only
  7328. (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
  7329. ((> change 0) (1+ (* 2 (/ (+ (1- level) (* 2 change)) 2))))
  7330. ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
  7331. (max 1 (+ level (or change 0)))))
  7332. (defun org-promote ()
  7333. "Promote the current heading higher up the tree."
  7334. (org-with-wide-buffer
  7335. (org-back-to-heading t)
  7336. (let* ((after-change-functions (remq 'flyspell-after-change-function
  7337. after-change-functions))
  7338. (level (save-match-data (funcall outline-level)))
  7339. (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
  7340. (diff (abs (- level (length up-head) -1))))
  7341. (cond
  7342. ((and (= level 1) org-allow-promoting-top-level-subtree)
  7343. (replace-match "# " nil t))
  7344. ((= level 1)
  7345. (user-error "Cannot promote to level 0. UNDO to recover if necessary"))
  7346. (t (replace-match up-head nil t)))
  7347. (unless (= level 1)
  7348. (when org-auto-align-tags (org-set-tags nil 'ignore-column))
  7349. (when org-adapt-indentation (org-fixup-indentation (- diff))))
  7350. (run-hooks 'org-after-promote-entry-hook))))
  7351. (defun org-demote ()
  7352. "Demote the current heading lower down the tree."
  7353. (org-with-wide-buffer
  7354. (org-back-to-heading t)
  7355. (let* ((after-change-functions (remq 'flyspell-after-change-function
  7356. after-change-functions))
  7357. (level (save-match-data (funcall outline-level)))
  7358. (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
  7359. (diff (abs (- level (length down-head) -1))))
  7360. (replace-match down-head nil t)
  7361. (when org-auto-align-tags (org-set-tags nil 'ignore-column))
  7362. (when org-adapt-indentation (org-fixup-indentation diff))
  7363. (run-hooks 'org-after-demote-entry-hook))))
  7364. (defun org-cycle-level ()
  7365. "Cycle the level of an empty headline through possible states.
  7366. This goes first to child, then to parent, level, then up the hierarchy.
  7367. After top level, it switches back to sibling level."
  7368. (interactive)
  7369. (let ((org-adapt-indentation nil))
  7370. (when (org-point-at-end-of-empty-headline)
  7371. (setq this-command 'org-cycle-level) ; Only needed for caching
  7372. (let ((cur-level (org-current-level))
  7373. (prev-level (org-get-previous-line-level)))
  7374. (cond
  7375. ;; If first headline in file, promote to top-level.
  7376. ((= prev-level 0)
  7377. (cl-loop repeat (/ (- cur-level 1) (org-level-increment))
  7378. do (org-do-promote)))
  7379. ;; If same level as prev, demote one.
  7380. ((= prev-level cur-level)
  7381. (org-do-demote))
  7382. ;; If parent is top-level, promote to top level if not already.
  7383. ((= prev-level 1)
  7384. (cl-loop repeat (/ (- cur-level 1) (org-level-increment))
  7385. do (org-do-promote)))
  7386. ;; If top-level, return to prev-level.
  7387. ((= cur-level 1)
  7388. (cl-loop repeat (/ (- prev-level 1) (org-level-increment))
  7389. do (org-do-demote)))
  7390. ;; If less than prev-level, promote one.
  7391. ((< cur-level prev-level)
  7392. (org-do-promote))
  7393. ;; If deeper than prev-level, promote until higher than
  7394. ;; prev-level.
  7395. ((> cur-level prev-level)
  7396. (cl-loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
  7397. do (org-do-promote))))
  7398. t))))
  7399. (defun org-map-tree (fun)
  7400. "Call FUN for every heading underneath the current one."
  7401. (org-back-to-heading t)
  7402. (let ((level (funcall outline-level)))
  7403. (save-excursion
  7404. (funcall fun)
  7405. (while (and (progn
  7406. (outline-next-heading)
  7407. (> (funcall outline-level) level))
  7408. (not (eobp)))
  7409. (funcall fun)))))
  7410. (defun org-map-region (fun beg end)
  7411. "Call FUN for every heading between BEG and END."
  7412. (let ((org-ignore-region t))
  7413. (save-excursion
  7414. (setq end (copy-marker end))
  7415. (goto-char beg)
  7416. (when (and (re-search-forward org-outline-regexp-bol nil t)
  7417. (< (point) end))
  7418. (funcall fun))
  7419. (while (and (progn
  7420. (outline-next-heading)
  7421. (< (point) end))
  7422. (not (eobp)))
  7423. (funcall fun)))))
  7424. (defun org-fixup-indentation (diff)
  7425. "Change the indentation in the current entry by DIFF.
  7426. DIFF is an integer. Indentation is done according to the
  7427. following rules:
  7428. - Planning information and property drawers are always indented
  7429. according to the new level of the headline;
  7430. - Footnote definitions and their contents are ignored;
  7431. - Inlinetasks' boundaries are not shifted;
  7432. - Empty lines are ignored;
  7433. - Other lines' indentation are shifted by DIFF columns, unless
  7434. it would introduce a structural change in the document, in
  7435. which case no shifting is done at all.
  7436. Assume point is at a heading or an inlinetask beginning."
  7437. (org-with-wide-buffer
  7438. (narrow-to-region (line-beginning-position)
  7439. (save-excursion
  7440. (if (org-with-limited-levels (org-at-heading-p))
  7441. (org-with-limited-levels (outline-next-heading))
  7442. (org-inlinetask-goto-end))
  7443. (point)))
  7444. (forward-line)
  7445. ;; Indent properly planning info and property drawer.
  7446. (when (looking-at-p org-planning-line-re)
  7447. (org-indent-line)
  7448. (forward-line))
  7449. (when (looking-at org-property-drawer-re)
  7450. (goto-char (match-end 0))
  7451. (forward-line)
  7452. (save-excursion (org-indent-region (match-beginning 0) (match-end 0))))
  7453. (catch 'no-shift
  7454. (when (zerop diff) (throw 'no-shift nil))
  7455. ;; If DIFF is negative, first check if a shift is possible at all
  7456. ;; (e.g., it doesn't break structure). This can only happen if
  7457. ;; some contents are not properly indented.
  7458. (let ((case-fold-search t))
  7459. (when (< diff 0)
  7460. (let ((diff (- diff))
  7461. (forbidden-re (concat org-outline-regexp
  7462. "\\|"
  7463. (substring org-footnote-definition-re 1))))
  7464. (save-excursion
  7465. (while (not (eobp))
  7466. (cond
  7467. ((looking-at-p "[ \t]*$") (forward-line))
  7468. ((and (looking-at-p org-footnote-definition-re)
  7469. (let ((e (org-element-at-point)))
  7470. (and (eq (org-element-type e) 'footnote-definition)
  7471. (goto-char (org-element-property :end e))))))
  7472. ((looking-at-p org-outline-regexp) (forward-line))
  7473. ;; Give up if shifting would move before column 0 or
  7474. ;; if it would introduce a headline or a footnote
  7475. ;; definition.
  7476. (t
  7477. (skip-chars-forward " \t")
  7478. (let ((ind (current-column)))
  7479. (when (or (< ind diff)
  7480. (and (= ind diff) (looking-at-p forbidden-re)))
  7481. (throw 'no-shift nil)))
  7482. ;; Ignore contents of example blocks and source
  7483. ;; blocks if their indentation is meant to be
  7484. ;; preserved. Jump to block's closing line.
  7485. (beginning-of-line)
  7486. (or (and (looking-at-p "[ \t]*#\\+BEGIN_\\(EXAMPLE\\|SRC\\)")
  7487. (let ((e (org-element-at-point)))
  7488. (and (memq (org-element-type e)
  7489. '(example-block src-block))
  7490. (or org-src-preserve-indentation
  7491. (org-element-property :preserve-indent e))
  7492. (goto-char (org-element-property :end e))
  7493. (progn (skip-chars-backward " \r\t\n")
  7494. (beginning-of-line)
  7495. t))))
  7496. (forward-line))))))))
  7497. ;; Shift lines but footnote definitions, inlinetasks boundaries
  7498. ;; by DIFF. Also skip contents of source or example blocks
  7499. ;; when indentation is meant to be preserved.
  7500. (while (not (eobp))
  7501. (cond
  7502. ((and (looking-at-p org-footnote-definition-re)
  7503. (let ((e (org-element-at-point)))
  7504. (and (eq (org-element-type e) 'footnote-definition)
  7505. (goto-char (org-element-property :end e))))))
  7506. ((looking-at-p org-outline-regexp) (forward-line))
  7507. ((looking-at-p "[ \t]*$") (forward-line))
  7508. (t
  7509. (indent-line-to (+ (org-get-indentation) diff))
  7510. (beginning-of-line)
  7511. (or (and (looking-at-p "[ \t]*#\\+BEGIN_\\(EXAMPLE\\|SRC\\)")
  7512. (let ((e (org-element-at-point)))
  7513. (and (memq (org-element-type e)
  7514. '(example-block src-block))
  7515. (or org-src-preserve-indentation
  7516. (org-element-property :preserve-indent e))
  7517. (goto-char (org-element-property :end e))
  7518. (progn (skip-chars-backward " \r\t\n")
  7519. (beginning-of-line)
  7520. t))))
  7521. (forward-line)))))))))
  7522. (defun org-convert-to-odd-levels ()
  7523. "Convert an Org file with all levels allowed to one with odd levels.
  7524. This will leave level 1 alone, convert level 2 to level 3, level 3 to
  7525. level 5 etc."
  7526. (interactive)
  7527. (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
  7528. (let ((outline-level 'org-outline-level)
  7529. (org-odd-levels-only nil) n)
  7530. (save-excursion
  7531. (goto-char (point-min))
  7532. (while (re-search-forward "^\\*\\*+ " nil t)
  7533. (setq n (- (length (match-string 0)) 2))
  7534. (while (>= (setq n (1- n)) 0)
  7535. (org-demote))
  7536. (end-of-line 1))))))
  7537. (defun org-convert-to-oddeven-levels ()
  7538. "Convert an Org file with only odd levels to one with odd/even levels.
  7539. This promotes level 3 to level 2, level 5 to level 3 etc. If the
  7540. file contains a section with an even level, conversion would
  7541. destroy the structure of the file. An error is signaled in this
  7542. case."
  7543. (interactive)
  7544. (goto-char (point-min))
  7545. ;; First check if there are no even levels
  7546. (when (re-search-forward "^\\(\\*\\*\\)+ " nil t)
  7547. (org-show-set-visibility 'canonical)
  7548. (error "Not all levels are odd in this file. Conversion not possible"))
  7549. (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
  7550. (let ((outline-regexp org-outline-regexp)
  7551. (outline-level 'org-outline-level)
  7552. (org-odd-levels-only nil) n)
  7553. (save-excursion
  7554. (goto-char (point-min))
  7555. (while (re-search-forward "^\\*\\*+ " nil t)
  7556. (setq n (/ (1- (length (match-string 0))) 2))
  7557. (while (>= (setq n (1- n)) 0)
  7558. (org-promote))
  7559. (end-of-line 1))))))
  7560. (defun org-tr-level (n)
  7561. "Make N odd if required."
  7562. (if org-odd-levels-only (1+ (/ n 2)) n))
  7563. ;;; Vertical tree motion, cutting and pasting of subtrees
  7564. (defun org-move-subtree-up (&optional arg)
  7565. "Move the current subtree up past ARG headlines of the same level."
  7566. (interactive "p")
  7567. (org-move-subtree-down (- (prefix-numeric-value arg))))
  7568. (defun org-move-subtree-down (&optional arg)
  7569. "Move the current subtree down past ARG headlines of the same level."
  7570. (interactive "p")
  7571. (setq arg (prefix-numeric-value arg))
  7572. (let ((movfunc (if (> arg 0) 'org-get-next-sibling
  7573. 'org-get-last-sibling))
  7574. (ins-point (make-marker))
  7575. (cnt (abs arg))
  7576. (col (current-column))
  7577. beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
  7578. ;; Select the tree
  7579. (org-back-to-heading)
  7580. (setq beg0 (point))
  7581. (save-excursion
  7582. (setq ne-beg (org-back-over-empty-lines))
  7583. (setq beg (point)))
  7584. (save-match-data
  7585. (save-excursion (outline-end-of-heading)
  7586. (setq folded (outline-invisible-p)))
  7587. (progn (org-end-of-subtree nil t)
  7588. (unless (eobp) (backward-char))))
  7589. (outline-next-heading)
  7590. (setq ne-end (org-back-over-empty-lines))
  7591. (setq end (point))
  7592. (goto-char beg0)
  7593. (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
  7594. ;; include less whitespace
  7595. (save-excursion
  7596. (goto-char beg)
  7597. (forward-line (- ne-beg ne-end))
  7598. (setq beg (point))))
  7599. ;; Find insertion point, with error handling
  7600. (while (> cnt 0)
  7601. (or (and (funcall movfunc) (looking-at org-outline-regexp))
  7602. (progn (goto-char beg0)
  7603. (user-error "Cannot move past superior level or buffer limit")))
  7604. (setq cnt (1- cnt)))
  7605. (when (> arg 0)
  7606. ;; Moving forward - still need to move over subtree
  7607. (org-end-of-subtree t t)
  7608. (save-excursion
  7609. (org-back-over-empty-lines)
  7610. (or (bolp) (newline))))
  7611. (setq ne-ins (org-back-over-empty-lines))
  7612. (move-marker ins-point (point))
  7613. (setq txt (buffer-substring beg end))
  7614. (org-save-markers-in-region beg end)
  7615. (delete-region beg end)
  7616. (org-remove-empty-overlays-at beg)
  7617. (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
  7618. (or (bobp) (outline-flag-region (1- (point)) (point) nil))
  7619. (and (not (bolp)) (looking-at "\n") (forward-char 1))
  7620. (let ((bbb (point)))
  7621. (insert-before-markers txt)
  7622. (org-reinstall-markers-in-region bbb)
  7623. (move-marker ins-point bbb))
  7624. (or (bolp) (insert "\n"))
  7625. (setq ins-end (point))
  7626. (goto-char ins-point)
  7627. (org-skip-whitespace)
  7628. (when (and (< arg 0)
  7629. (org-first-sibling-p)
  7630. (> ne-ins ne-beg))
  7631. ;; Move whitespace back to beginning
  7632. (save-excursion
  7633. (goto-char ins-end)
  7634. (let ((kill-whole-line t))
  7635. (kill-line (- ne-ins ne-beg)) (point)))
  7636. (insert (make-string (- ne-ins ne-beg) ?\n)))
  7637. (move-marker ins-point nil)
  7638. (if folded
  7639. (outline-hide-subtree)
  7640. (org-show-entry)
  7641. (org-show-children)
  7642. (org-cycle-hide-drawers 'children))
  7643. (org-clean-visibility-after-subtree-move)
  7644. ;; move back to the initial column we were at
  7645. (move-to-column col)))
  7646. (defvar org-subtree-clip ""
  7647. "Clipboard for cut and paste of subtrees.
  7648. This is actually only a copy of the kill, because we use the normal kill
  7649. ring. We need it to check if the kill was created by `org-copy-subtree'.")
  7650. (defvar org-subtree-clip-folded nil
  7651. "Was the last copied subtree folded?
  7652. This is used to fold the tree back after pasting.")
  7653. (defun org-cut-subtree (&optional n)
  7654. "Cut the current subtree into the clipboard.
  7655. With prefix arg N, cut this many sequential subtrees.
  7656. This is a short-hand for marking the subtree and then cutting it."
  7657. (interactive "p")
  7658. (org-copy-subtree n 'cut))
  7659. (defun org-copy-subtree (&optional n cut force-store-markers nosubtrees)
  7660. "Copy the current subtree it in the clipboard.
  7661. With prefix arg N, copy this many sequential subtrees.
  7662. This is a short-hand for marking the subtree and then copying it.
  7663. If CUT is non-nil, actually cut the subtree.
  7664. If FORCE-STORE-MARKERS is non-nil, store the relative locations
  7665. of some markers in the region, even if CUT is non-nil. This is
  7666. useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
  7667. (interactive "p")
  7668. (let (beg end folded (beg0 (point)))
  7669. (if (called-interactively-p 'any)
  7670. (org-back-to-heading nil) ; take what looks like a subtree
  7671. (org-back-to-heading t)) ; take what is really there
  7672. (setq beg (point))
  7673. (skip-chars-forward " \t\r\n")
  7674. (save-match-data
  7675. (if nosubtrees
  7676. (outline-next-heading)
  7677. (save-excursion (outline-end-of-heading)
  7678. (setq folded (outline-invisible-p)))
  7679. (ignore-errors (org-forward-heading-same-level (1- n) t))
  7680. (org-end-of-subtree t t)))
  7681. ;; Include the end of an inlinetask
  7682. (when (and (featurep 'org-inlinetask)
  7683. (looking-at-p (concat (org-inlinetask-outline-regexp)
  7684. "END[ \t]*$")))
  7685. (end-of-line))
  7686. (setq end (point))
  7687. (goto-char beg0)
  7688. (when (> end beg)
  7689. (setq org-subtree-clip-folded folded)
  7690. (when (or cut force-store-markers)
  7691. (org-save-markers-in-region beg end))
  7692. (if cut (kill-region beg end) (copy-region-as-kill beg end))
  7693. (setq org-subtree-clip (current-kill 0))
  7694. (message "%s: Subtree(s) with %d characters"
  7695. (if cut "Cut" "Copied")
  7696. (length org-subtree-clip)))))
  7697. (defun org-paste-subtree (&optional level tree for-yank remove)
  7698. "Paste the clipboard as a subtree, with modification of headline level.
  7699. The entire subtree is promoted or demoted in order to match a new headline
  7700. level.
  7701. If the cursor is at the beginning of a headline, the same level as
  7702. that headline is used to paste the tree.
  7703. If not, the new level is derived from the *visible* headings
  7704. before and after the insertion point, and taken to be the inferior headline
  7705. level of the two. So if the previous visible heading is level 3 and the
  7706. next is level 4 (or vice versa), level 4 will be used for insertion.
  7707. This makes sure that the subtree remains an independent subtree and does
  7708. not swallow low level entries.
  7709. You can also force a different level, either by using a numeric prefix
  7710. argument, or by inserting the heading marker by hand. For example, if the
  7711. cursor is after \"*****\", then the tree will be shifted to level 5.
  7712. If optional TREE is given, use this text instead of the kill ring.
  7713. When FOR-YANK is set, this is called by `org-yank'. In this case, do not
  7714. move back over whitespace before inserting, and move point to the end of
  7715. the inserted text when done.
  7716. When REMOVE is non-nil, remove the subtree from the clipboard."
  7717. (interactive "P")
  7718. (setq tree (or tree (and kill-ring (current-kill 0))))
  7719. (unless (org-kill-is-subtree-p tree)
  7720. (user-error "%s"
  7721. (substitute-command-keys
  7722. "The kill is not a (set of) tree(s) - please use \\[yank] to yank anyway")))
  7723. (org-with-limited-levels
  7724. (let* ((visp (not (outline-invisible-p)))
  7725. (txt tree)
  7726. (^re_ "\\(\\*+\\)[ \t]*")
  7727. (old-level (if (string-match org-outline-regexp-bol txt)
  7728. (- (match-end 0) (match-beginning 0) 1)
  7729. -1))
  7730. (force-level (cond (level (prefix-numeric-value level))
  7731. ((and (looking-at "[ \t]*$")
  7732. (string-match
  7733. "^\\*+$" (buffer-substring
  7734. (point-at-bol) (point))))
  7735. (- (match-end 0) (match-beginning 0)))
  7736. ((and (bolp)
  7737. (looking-at org-outline-regexp))
  7738. (- (match-end 0) (point) 1))))
  7739. (previous-level (save-excursion
  7740. (condition-case nil
  7741. (progn
  7742. (outline-previous-visible-heading 1)
  7743. (if (looking-at ^re_)
  7744. (- (match-end 0) (match-beginning 0) 1)
  7745. 1))
  7746. (error 1))))
  7747. (next-level (save-excursion
  7748. (condition-case nil
  7749. (progn
  7750. (or (looking-at org-outline-regexp)
  7751. (outline-next-visible-heading 1))
  7752. (if (looking-at ^re_)
  7753. (- (match-end 0) (match-beginning 0) 1)
  7754. 1))
  7755. (error 1))))
  7756. (new-level (or force-level (max previous-level next-level)))
  7757. (shift (if (or (= old-level -1)
  7758. (= new-level -1)
  7759. (= old-level new-level))
  7760. 0
  7761. (- new-level old-level)))
  7762. (delta (if (> shift 0) -1 1))
  7763. (func (if (> shift 0) 'org-demote 'org-promote))
  7764. (org-odd-levels-only nil)
  7765. beg end newend)
  7766. ;; Remove the forced level indicator
  7767. (when force-level
  7768. (delete-region (point-at-bol) (point)))
  7769. ;; Paste
  7770. (beginning-of-line (if (bolp) 1 2))
  7771. (setq beg (point))
  7772. (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
  7773. (insert-before-markers txt)
  7774. (unless (string-suffix-p "\n" txt) (insert "\n"))
  7775. (setq newend (point))
  7776. (org-reinstall-markers-in-region beg)
  7777. (setq end (point))
  7778. (goto-char beg)
  7779. (skip-chars-forward " \t\n\r")
  7780. (setq beg (point))
  7781. (when (and (outline-invisible-p) visp)
  7782. (save-excursion (outline-show-heading)))
  7783. ;; Shift if necessary
  7784. (unless (= shift 0)
  7785. (save-restriction
  7786. (narrow-to-region beg end)
  7787. (while (not (= shift 0))
  7788. (org-map-region func (point-min) (point-max))
  7789. (setq shift (+ delta shift)))
  7790. (goto-char (point-min))
  7791. (setq newend (point-max))))
  7792. (when (or (called-interactively-p 'interactive) for-yank)
  7793. (message "Clipboard pasted as level %d subtree" new-level))
  7794. (when (and (not for-yank) ; in this case, org-yank will decide about folding
  7795. kill-ring
  7796. (eq org-subtree-clip (current-kill 0))
  7797. org-subtree-clip-folded)
  7798. ;; The tree was folded before it was killed/copied
  7799. (outline-hide-subtree))
  7800. (and for-yank (goto-char newend))
  7801. (and remove (setq kill-ring (cdr kill-ring))))))
  7802. (defun org-kill-is-subtree-p (&optional txt)
  7803. "Check if the current kill is an outline subtree, or a set of trees.
  7804. Returns nil if kill does not start with a headline, or if the first
  7805. headline level is not the largest headline level in the tree.
  7806. So this will actually accept several entries of equal levels as well,
  7807. which is OK for `org-paste-subtree'.
  7808. If optional TXT is given, check this string instead of the current kill."
  7809. (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
  7810. (re (org-get-limited-outline-regexp))
  7811. (^re (concat "^" re))
  7812. (start-level (and kill
  7813. (string-match
  7814. (concat "\\`\\([ \t\n\r]*?\n\\)?\\(" re "\\)")
  7815. kill)
  7816. (- (match-end 2) (match-beginning 2) 1)))
  7817. (start (1+ (or (match-beginning 2) -1))))
  7818. (if (not start-level)
  7819. (progn
  7820. nil) ;; does not even start with a heading
  7821. (catch 'exit
  7822. (while (setq start (string-match ^re kill (1+ start)))
  7823. (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
  7824. (throw 'exit nil)))
  7825. t))))
  7826. (defvar org-markers-to-move nil
  7827. "Markers that should be moved with a cut-and-paste operation.
  7828. Those markers are stored together with their positions relative to
  7829. the start of the region.")
  7830. (defun org-save-markers-in-region (beg end)
  7831. "Check markers in region.
  7832. If these markers are between BEG and END, record their position relative
  7833. to BEG, so that after moving the block of text, we can put the markers back
  7834. into place.
  7835. This function gets called just before an entry or tree gets cut from the
  7836. buffer. After re-insertion, `org-reinstall-markers-in-region' must be
  7837. called immediately, to move the markers with the entries."
  7838. (setq org-markers-to-move nil)
  7839. (when (featurep 'org-clock)
  7840. (org-clock-save-markers-for-cut-and-paste beg end))
  7841. (when (featurep 'org-agenda)
  7842. (org-agenda-save-markers-for-cut-and-paste beg end)))
  7843. (defun org-check-and-save-marker (marker beg end)
  7844. "Check if MARKER is between BEG and END.
  7845. If yes, remember the marker and the distance to BEG."
  7846. (when (and (marker-buffer marker)
  7847. (equal (marker-buffer marker) (current-buffer))
  7848. (>= marker beg) (< marker end))
  7849. (push (cons marker (- marker beg)) org-markers-to-move)))
  7850. (defun org-reinstall-markers-in-region (beg)
  7851. "Move all remembered markers to their position relative to BEG."
  7852. (dolist (x org-markers-to-move)
  7853. (move-marker (car x) (+ beg (cdr x))))
  7854. (setq org-markers-to-move nil))
  7855. (defun org-narrow-to-subtree ()
  7856. "Narrow buffer to the current subtree."
  7857. (interactive)
  7858. (save-excursion
  7859. (save-match-data
  7860. (org-with-limited-levels
  7861. (narrow-to-region
  7862. (progn (org-back-to-heading t) (point))
  7863. (progn (org-end-of-subtree t t)
  7864. (when (and (org-at-heading-p) (not (eobp))) (backward-char 1))
  7865. (point)))))))
  7866. (defun org-narrow-to-block ()
  7867. "Narrow buffer to the current block."
  7868. (interactive)
  7869. (let* ((case-fold-search t)
  7870. (blockp (org-between-regexps-p "^[ \t]*#\\+begin_.*"
  7871. "^[ \t]*#\\+end_.*")))
  7872. (if blockp
  7873. (narrow-to-region (car blockp) (cdr blockp))
  7874. (user-error "Not in a block"))))
  7875. (defun org-clone-subtree-with-time-shift (n &optional shift)
  7876. "Clone the task (subtree) at point N times.
  7877. The clones will be inserted as siblings.
  7878. In interactive use, the user will be prompted for the number of
  7879. clones to be produced. If the entry has a timestamp, the user
  7880. will also be prompted for a time shift, which may be a repeater
  7881. as used in time stamps, for example `+3d'. To disable this,
  7882. you can call the function with a universal prefix argument.
  7883. When a valid repeater is given and the entry contains any time
  7884. stamps, the clones will become a sequence in time, with time
  7885. stamps in the subtree shifted for each clone produced. If SHIFT
  7886. is nil or the empty string, time stamps will be left alone. The
  7887. ID property of the original subtree is removed.
  7888. In each clone, all the CLOCK entries will be removed. This
  7889. prevents Org from considering that the clocked times overlap.
  7890. If the original subtree did contain time stamps with a repeater,
  7891. the following will happen:
  7892. - the repeater will be removed in each clone
  7893. - an additional clone will be produced, with the current, unshifted
  7894. date(s) in the entry.
  7895. - the original entry will be placed *after* all the clones, with
  7896. repeater intact.
  7897. - the start days in the repeater in the original entry will be shifted
  7898. to past the last clone.
  7899. In this way you can spell out a number of instances of a repeating task,
  7900. and still retain the repeater to cover future instances of the task.
  7901. As described above, N+1 clones are produced when the original
  7902. subtree has a repeater. Setting N to 0, then, can be used to
  7903. remove the repeater from a subtree and create a shifted clone
  7904. with the original repeater."
  7905. (interactive "nNumber of clones to produce: ")
  7906. (unless (wholenump n) (user-error "Invalid number of replications %s" n))
  7907. (when (org-before-first-heading-p) (user-error "No subtree to clone"))
  7908. (let* ((beg (save-excursion (org-back-to-heading t) (point)))
  7909. (end-of-tree (save-excursion (org-end-of-subtree t t) (point)))
  7910. (shift
  7911. (or shift
  7912. (if (and (not (equal current-prefix-arg '(4)))
  7913. (save-excursion
  7914. (goto-char beg)
  7915. (re-search-forward org-ts-regexp-both end-of-tree t)))
  7916. (read-from-minibuffer
  7917. "Date shift per clone (e.g. +1w, empty to copy unchanged): ")
  7918. ""))) ;No time shift
  7919. (doshift
  7920. (and (org-string-nw-p shift)
  7921. (or (string-match "\\`[ \t]*\\+?\\([0-9]+\\)\\([dwmy]\\)[ \t]*\\'"
  7922. shift)
  7923. (user-error "Invalid shift specification %s" shift)))))
  7924. (goto-char end-of-tree)
  7925. (unless (bolp) (insert "\n"))
  7926. (let* ((end (point))
  7927. (template (buffer-substring beg end))
  7928. (shift-n (and doshift (string-to-number (match-string 1 shift))))
  7929. (shift-what (pcase (and doshift (match-string 2 shift))
  7930. (`nil nil)
  7931. ("d" 'day)
  7932. ("w" (setq shift-n (* 7 shift-n)) 'day)
  7933. ("m" 'month)
  7934. ("y" 'year)
  7935. (_ (error "Unsupported time unit"))))
  7936. (nmin 1)
  7937. (nmax n)
  7938. (n-no-remove -1)
  7939. (idprop (org-entry-get nil "ID")))
  7940. (when (and doshift
  7941. (string-match-p "<[^<>\n]+ [.+]?\\+[0-9]+[hdwmy][^<>\n]*>"
  7942. template))
  7943. (delete-region beg end)
  7944. (setq end beg)
  7945. (setq nmin 0)
  7946. (setq nmax (1+ nmax))
  7947. (setq n-no-remove nmax))
  7948. (goto-char end)
  7949. (cl-loop for n from nmin to nmax do
  7950. (insert
  7951. ;; Prepare clone.
  7952. (with-temp-buffer
  7953. (insert template)
  7954. (org-mode)
  7955. (goto-char (point-min))
  7956. (org-show-subtree)
  7957. (and idprop (if org-clone-delete-id
  7958. (org-entry-delete nil "ID")
  7959. (org-id-get-create t)))
  7960. (unless (= n 0)
  7961. (while (re-search-forward org-clock-line-re nil t)
  7962. (delete-region (line-beginning-position)
  7963. (line-beginning-position 2)))
  7964. (goto-char (point-min))
  7965. (while (re-search-forward org-drawer-regexp nil t)
  7966. (org-remove-empty-drawer-at (point))))
  7967. (goto-char (point-min))
  7968. (when doshift
  7969. (while (re-search-forward org-ts-regexp-both nil t)
  7970. (org-timestamp-change (* n shift-n) shift-what))
  7971. (unless (= n n-no-remove)
  7972. (goto-char (point-min))
  7973. (while (re-search-forward org-ts-regexp nil t)
  7974. (save-excursion
  7975. (goto-char (match-beginning 0))
  7976. (when (looking-at "<[^<>\n]+\\( +[.+]?\\+[0-9]+[hdwmy]\\)")
  7977. (delete-region (match-beginning 1) (match-end 1)))))))
  7978. (buffer-string)))))
  7979. (goto-char beg)))
  7980. ;;; Outline Sorting
  7981. (defun org-sort (with-case)
  7982. "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
  7983. Optional argument WITH-CASE means sort case-sensitively."
  7984. (interactive "P")
  7985. (cond
  7986. ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
  7987. ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
  7988. (t
  7989. (org-call-with-arg 'org-sort-entries with-case))))
  7990. (defun org-sort-remove-invisible (s)
  7991. "Remove invisible part of links and emphasis markers from string S."
  7992. (remove-text-properties 0 (length s) org-rm-props s)
  7993. (replace-regexp-in-string
  7994. org-verbatim-re (lambda (m) (format "%s " (match-string 4 m)))
  7995. (replace-regexp-in-string
  7996. org-emph-re (lambda (m) (format " %s " (match-string 4 m)))
  7997. (org-link-display-format s)
  7998. t t) t t))
  7999. (defvar org-priority-regexp) ; defined later in the file
  8000. (defvar org-after-sorting-entries-or-items-hook nil
  8001. "Hook that is run after a bunch of entries or items have been sorted.
  8002. When children are sorted, the cursor is in the parent line when this
  8003. hook gets called. When a region or a plain list is sorted, the cursor
  8004. will be in the first entry of the sorted region/list.")
  8005. (defun org-sort-entries
  8006. (&optional with-case sorting-type getkey-func compare-func property)
  8007. "Sort entries on a certain level of an outline tree.
  8008. If there is an active region, the entries in the region are sorted.
  8009. Else, if the cursor is before the first entry, sort the top-level items.
  8010. Else, the children of the entry at point are sorted.
  8011. Sorting can be alphabetically, numerically, by date/time as given by
  8012. a time stamp, by a property, by priority order, or by a custom function.
  8013. The command prompts for the sorting type unless it has been given to the
  8014. function through the SORTING-TYPE argument, which needs to be a character,
  8015. \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?o ?O ?r ?R ?f ?F ?k ?K). Here is
  8016. the precise meaning of each character:
  8017. a Alphabetically, ignoring the TODO keyword and the priority, if any.
  8018. c By creation time, which is assumed to be the first inactive time stamp
  8019. at the beginning of a line.
  8020. d By deadline date/time.
  8021. k By clocking time.
  8022. n Numerically, by converting the beginning of the entry/item to a number.
  8023. o By order of TODO keywords.
  8024. p By priority according to the cookie.
  8025. r By the value of a property.
  8026. s By scheduled date/time.
  8027. t By date/time, either the first active time stamp in the entry, or, if
  8028. none exist, by the first inactive one.
  8029. Capital letters will reverse the sort order.
  8030. If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
  8031. called with point at the beginning of the record. It must return either
  8032. a string or a number that should serve as the sorting key for that record.
  8033. Comparing entries ignores case by default. However, with an optional argument
  8034. WITH-CASE, the sorting considers case as well.
  8035. Sorting is done against the visible part of the headlines, it ignores hidden
  8036. links.
  8037. When sorting is done, call `org-after-sorting-entries-or-items-hook'."
  8038. (interactive "P")
  8039. (let ((case-func (if with-case 'identity 'downcase))
  8040. (cmstr
  8041. ;; The clock marker is lost when using `sort-subr', let's
  8042. ;; store the clocking string.
  8043. (when (equal (marker-buffer org-clock-marker) (current-buffer))
  8044. (save-excursion
  8045. (goto-char org-clock-marker)
  8046. (buffer-substring-no-properties (line-beginning-position)
  8047. (point)))))
  8048. start beg end stars re re2
  8049. txt what tmp)
  8050. ;; Find beginning and end of region to sort
  8051. (cond
  8052. ((org-region-active-p)
  8053. ;; we will sort the region
  8054. (setq end (region-end)
  8055. what "region")
  8056. (goto-char (region-beginning))
  8057. (unless (org-at-heading-p) (outline-next-heading))
  8058. (setq start (point)))
  8059. ((or (org-at-heading-p)
  8060. (ignore-errors (progn (org-back-to-heading) t)))
  8061. ;; we will sort the children of the current headline
  8062. (org-back-to-heading)
  8063. (setq start (point)
  8064. end (progn (org-end-of-subtree t t)
  8065. (or (bolp) (insert "\n"))
  8066. (when (>= (org-back-over-empty-lines) 1)
  8067. (forward-line 1))
  8068. (point))
  8069. what "children")
  8070. (goto-char start)
  8071. (outline-show-subtree)
  8072. (outline-next-heading))
  8073. (t
  8074. ;; we will sort the top-level entries in this file
  8075. (goto-char (point-min))
  8076. (or (org-at-heading-p) (outline-next-heading))
  8077. (setq start (point))
  8078. (goto-char (point-max))
  8079. (beginning-of-line 1)
  8080. (when (looking-at ".*?\\S-")
  8081. ;; File ends in a non-white line
  8082. (end-of-line 1)
  8083. (insert "\n"))
  8084. (setq end (point-max))
  8085. (setq what "top-level")
  8086. (goto-char start)
  8087. (outline-show-all)))
  8088. (setq beg (point))
  8089. (when (>= beg end) (goto-char start) (user-error "Nothing to sort"))
  8090. (looking-at "\\(\\*+\\)")
  8091. (setq stars (match-string 1)
  8092. re (concat "^" (regexp-quote stars) " +")
  8093. re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[ \t\n]")
  8094. txt (buffer-substring beg end))
  8095. (unless (equal (substring txt -1) "\n") (setq txt (concat txt "\n")))
  8096. (when (and (not (equal stars "*")) (string-match re2 txt))
  8097. (user-error "Region to sort contains a level above the first entry"))
  8098. (unless sorting-type
  8099. (message
  8100. "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
  8101. [t]ime [s]cheduled [d]eadline [c]reated cloc[k]ing
  8102. A/N/P/R/O/F/T/S/D/C/K means reversed:"
  8103. what)
  8104. (setq sorting-type (read-char-exclusive))
  8105. (unless getkey-func
  8106. (and (= (downcase sorting-type) ?f)
  8107. (setq getkey-func
  8108. (completing-read "Sort using function: "
  8109. obarray 'fboundp t nil nil))
  8110. (setq getkey-func (intern getkey-func))))
  8111. (and (= (downcase sorting-type) ?r)
  8112. (not property)
  8113. (setq property
  8114. (completing-read "Property: "
  8115. (mapcar #'list (org-buffer-property-keys t))
  8116. nil t))))
  8117. (when (member sorting-type '(?k ?K)) (org-clock-sum))
  8118. (message "Sorting entries...")
  8119. (save-restriction
  8120. (narrow-to-region start end)
  8121. (let ((dcst (downcase sorting-type))
  8122. (case-fold-search nil)
  8123. (now (current-time)))
  8124. (sort-subr
  8125. (/= dcst sorting-type)
  8126. ;; This function moves to the beginning character of the "record" to
  8127. ;; be sorted.
  8128. (lambda nil
  8129. (if (re-search-forward re nil t)
  8130. (goto-char (match-beginning 0))
  8131. (goto-char (point-max))))
  8132. ;; This function moves to the last character of the "record" being
  8133. ;; sorted.
  8134. (lambda nil
  8135. (save-match-data
  8136. (condition-case nil
  8137. (outline-forward-same-level 1)
  8138. (error
  8139. (goto-char (point-max))))))
  8140. ;; This function returns the value that gets sorted against.
  8141. (lambda nil
  8142. (cond
  8143. ((= dcst ?n)
  8144. (if (looking-at org-complex-heading-regexp)
  8145. (string-to-number (org-sort-remove-invisible (match-string 4)))
  8146. nil))
  8147. ((= dcst ?a)
  8148. (if (looking-at org-complex-heading-regexp)
  8149. (funcall case-func (org-sort-remove-invisible (match-string 4)))
  8150. nil))
  8151. ((= dcst ?k)
  8152. (or (get-text-property (point) :org-clock-minutes) 0))
  8153. ((= dcst ?t)
  8154. (let ((end (save-excursion (outline-next-heading) (point))))
  8155. (if (or (re-search-forward org-ts-regexp end t)
  8156. (re-search-forward org-ts-regexp-both end t))
  8157. (org-time-string-to-seconds (match-string 0))
  8158. (float-time now))))
  8159. ((= dcst ?c)
  8160. (let ((end (save-excursion (outline-next-heading) (point))))
  8161. (if (re-search-forward
  8162. (concat "^[ \t]*\\[" org-ts-regexp1 "\\]")
  8163. end t)
  8164. (org-time-string-to-seconds (match-string 0))
  8165. (float-time now))))
  8166. ((= dcst ?s)
  8167. (let ((end (save-excursion (outline-next-heading) (point))))
  8168. (if (re-search-forward org-scheduled-time-regexp end t)
  8169. (org-time-string-to-seconds (match-string 1))
  8170. (float-time now))))
  8171. ((= dcst ?d)
  8172. (let ((end (save-excursion (outline-next-heading) (point))))
  8173. (if (re-search-forward org-deadline-time-regexp end t)
  8174. (org-time-string-to-seconds (match-string 1))
  8175. (float-time now))))
  8176. ((= dcst ?p)
  8177. (if (re-search-forward org-priority-regexp (point-at-eol) t)
  8178. (string-to-char (match-string 2))
  8179. org-default-priority))
  8180. ((= dcst ?r)
  8181. (or (org-entry-get nil property) ""))
  8182. ((= dcst ?o)
  8183. (when (looking-at org-complex-heading-regexp)
  8184. (let* ((m (match-string 2))
  8185. (s (if (member m org-done-keywords) '- '+)))
  8186. (- 99 (funcall s (length (member m org-todo-keywords-1)))))))
  8187. ((= dcst ?f)
  8188. (if getkey-func
  8189. (progn
  8190. (setq tmp (funcall getkey-func))
  8191. (when (stringp tmp) (setq tmp (funcall case-func tmp)))
  8192. tmp)
  8193. (error "Invalid key function `%s'" getkey-func)))
  8194. (t (error "Invalid sorting type `%c'" sorting-type))))
  8195. nil
  8196. (cond
  8197. ((= dcst ?a) 'string<)
  8198. ((= dcst ?f) compare-func)
  8199. ((member dcst '(?p ?t ?s ?d ?c ?k)) '<)))))
  8200. (run-hooks 'org-after-sorting-entries-or-items-hook)
  8201. ;; Reset the clock marker if needed
  8202. (when cmstr
  8203. (save-excursion
  8204. (goto-char start)
  8205. (search-forward cmstr nil t)
  8206. (move-marker org-clock-marker (point))))
  8207. (message "Sorting entries...done")))
  8208. ;;; The orgstruct minor mode
  8209. ;; Define a minor mode which can be used in other modes in order to
  8210. ;; integrate the Org mode structure editing commands.
  8211. ;; This is really a hack, because the Org mode structure commands use
  8212. ;; keys which normally belong to the major mode. Here is how it
  8213. ;; works: The minor mode defines all the keys necessary to operate the
  8214. ;; structure commands, but wraps the commands into a function which
  8215. ;; tests if the cursor is currently at a headline or a plain list
  8216. ;; item. If that is the case, the structure command is used,
  8217. ;; temporarily setting many Org mode variables like regular
  8218. ;; expressions for filling etc. However, when any of those keys is
  8219. ;; used at a different location, function uses `key-binding' to look
  8220. ;; up if the key has an associated command in another currently active
  8221. ;; keymap (minor modes, major mode, global), and executes that
  8222. ;; command. There might be problems if any of the keys is otherwise
  8223. ;; used as a prefix key.
  8224. (defcustom orgstruct-heading-prefix-regexp ""
  8225. "Regexp that matches the custom prefix of Org headlines in
  8226. orgstruct(++)-mode."
  8227. :group 'org
  8228. :version "24.4"
  8229. :package-version '(Org . "8.3")
  8230. :type 'regexp)
  8231. ;;;###autoload(put 'orgstruct-heading-prefix-regexp 'safe-local-variable 'stringp)
  8232. (defcustom orgstruct-setup-hook nil
  8233. "Hook run after orgstruct-mode-map is filled."
  8234. :group 'org
  8235. :version "24.4"
  8236. :package-version '(Org . "8.0")
  8237. :type 'hook)
  8238. (defvar orgstruct-initialized nil)
  8239. (defvar org-local-vars nil
  8240. "List of local variables, for use by `orgstruct-mode'.")
  8241. ;;;###autoload
  8242. (define-minor-mode orgstruct-mode
  8243. "Toggle the minor mode `orgstruct-mode'.
  8244. This mode is for using Org mode structure commands in other
  8245. modes. The following keys behave as if Org mode were active, if
  8246. the cursor is on a headline, or on a plain list item (both as
  8247. defined by Org mode)."
  8248. nil " OrgStruct" (make-sparse-keymap)
  8249. (funcall (if orgstruct-mode
  8250. 'add-to-invisibility-spec
  8251. 'remove-from-invisibility-spec)
  8252. '(outline . t))
  8253. (when orgstruct-mode
  8254. (org-load-modules-maybe)
  8255. (unless orgstruct-initialized
  8256. (orgstruct-setup)
  8257. (setq orgstruct-initialized t))))
  8258. ;;;###autoload
  8259. (defun turn-on-orgstruct ()
  8260. "Unconditionally turn on `orgstruct-mode'."
  8261. (orgstruct-mode 1))
  8262. (defvar-local orgstruct-is-++ nil
  8263. "Is `orgstruct-mode' in ++ version in the current-buffer?")
  8264. (defvar-local org-fb-vars nil)
  8265. (defun orgstruct++-mode (&optional arg)
  8266. "Toggle `orgstruct-mode', the enhanced version of it.
  8267. In addition to setting orgstruct-mode, this also exports all
  8268. indentation and autofilling variables from Org mode into the
  8269. buffer. It will also recognize item context in multiline items."
  8270. (interactive "P")
  8271. (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
  8272. (if (< arg 1)
  8273. (progn (orgstruct-mode -1)
  8274. (dolist (v org-fb-vars)
  8275. (set (make-local-variable (car v))
  8276. (if (eq (car-safe (cadr v)) 'quote)
  8277. (cl-cadadr v)
  8278. (nth 1 v)))))
  8279. (orgstruct-mode 1)
  8280. (setq org-fb-vars nil)
  8281. (unless org-local-vars
  8282. (setq org-local-vars (org-get-local-variables)))
  8283. (let (var val)
  8284. (dolist (x org-local-vars)
  8285. (when (string-match
  8286. "^\\(paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\
  8287. \\|fill-prefix\\|indent-\\)"
  8288. (symbol-name (car x)))
  8289. (setq var (car x) val (nth 1 x))
  8290. (push (list var `(quote ,(eval var))) org-fb-vars)
  8291. (set (make-local-variable var)
  8292. (if (eq (car-safe val) 'quote) (nth 1 val) val))))
  8293. (setq-local orgstruct-is-++ t))))
  8294. ;;;###autoload
  8295. (defun turn-on-orgstruct++ ()
  8296. "Unconditionally turn on `orgstruct++-mode'."
  8297. (orgstruct++-mode 1))
  8298. (defun orgstruct-error ()
  8299. "Error when there is no default binding for a structure key."
  8300. (interactive)
  8301. (funcall (if (fboundp 'user-error)
  8302. 'user-error
  8303. 'error)
  8304. "This key has no function outside structure elements"))
  8305. (defun orgstruct-setup ()
  8306. "Setup orgstruct keymap."
  8307. (dolist (cell '((org-demote . t)
  8308. (org-metaleft . t)
  8309. (org-metaright . t)
  8310. (org-promote . t)
  8311. (org-shiftmetaleft . t)
  8312. (org-shiftmetaright . t)
  8313. org-backward-element
  8314. org-backward-heading-same-level
  8315. org-ctrl-c-ret
  8316. org-ctrl-c-minus
  8317. org-ctrl-c-star
  8318. org-cycle
  8319. org-force-cycle-archived
  8320. org-forward-heading-same-level
  8321. org-insert-heading
  8322. org-insert-heading-respect-content
  8323. org-kill-note-or-show-branches
  8324. org-mark-subtree
  8325. org-meta-return
  8326. org-metadown
  8327. org-metaup
  8328. org-narrow-to-subtree
  8329. org-promote-subtree
  8330. org-reveal
  8331. org-shiftdown
  8332. org-shiftleft
  8333. org-shiftmetadown
  8334. org-shiftmetaup
  8335. org-shiftright
  8336. org-shifttab
  8337. org-shifttab
  8338. org-shiftup
  8339. org-show-children
  8340. org-show-subtree
  8341. org-sort
  8342. org-up-element
  8343. outline-demote
  8344. outline-next-visible-heading
  8345. outline-previous-visible-heading
  8346. outline-promote
  8347. outline-up-heading))
  8348. (let ((f (or (car-safe cell) cell))
  8349. (disable-when-heading-prefix (cdr-safe cell)))
  8350. (when (fboundp f)
  8351. (let ((new-bindings))
  8352. (dolist (binding (nconc (where-is-internal f org-mode-map)
  8353. (where-is-internal f outline-mode-map)))
  8354. (push binding new-bindings)
  8355. ;; TODO use local-function-key-map
  8356. (dolist (rep '(("<tab>" . "TAB")
  8357. ("<return>" . "RET")
  8358. ("<escape>" . "ESC")
  8359. ("<delete>" . "DEL")))
  8360. (setq binding (read-kbd-macro
  8361. (let ((case-fold-search))
  8362. (replace-regexp-in-string
  8363. (regexp-quote (cdr rep))
  8364. (car rep)
  8365. (key-description binding)))))
  8366. (cl-pushnew binding new-bindings :test 'equal)))
  8367. (dolist (binding new-bindings)
  8368. (let ((key (lookup-key orgstruct-mode-map binding)))
  8369. (when (or (not key) (numberp key))
  8370. (ignore-errors
  8371. (org-defkey orgstruct-mode-map
  8372. binding
  8373. (orgstruct-make-binding
  8374. f binding disable-when-heading-prefix))))))))))
  8375. (run-hooks 'orgstruct-setup-hook))
  8376. (defun orgstruct-make-binding (fun key disable-when-heading-prefix)
  8377. "Create a function for binding in the structure minor mode.
  8378. FUN is the command to call inside a table. KEY is the key that
  8379. should be checked in for a command to execute outside of tables.
  8380. Non-nil `disable-when-heading-prefix' means to disable the command
  8381. if `orgstruct-heading-prefix-regexp' is not empty."
  8382. (let ((name (concat "orgstruct-hijacker-" (symbol-name fun))))
  8383. (let ((nname name)
  8384. (i 0))
  8385. (while (fboundp (intern nname))
  8386. (setq nname (format "%s-%d" name (setq i (1+ i)))))
  8387. (setq name (intern nname)))
  8388. (eval
  8389. (let ((bindings '((org-heading-regexp
  8390. (concat "^"
  8391. orgstruct-heading-prefix-regexp
  8392. "\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ ]*$"))
  8393. (org-outline-regexp
  8394. (concat orgstruct-heading-prefix-regexp "\\*+ "))
  8395. (org-outline-regexp-bol
  8396. (concat "^" org-outline-regexp))
  8397. (outline-regexp org-outline-regexp)
  8398. (outline-heading-end-regexp "\n")
  8399. (outline-level 'org-outline-level)
  8400. (outline-heading-alist))))
  8401. `(defun ,name (arg)
  8402. ,(concat "In Structure, run `" (symbol-name fun) "'.\n"
  8403. "Outside of structure, run the binding of `"
  8404. (key-description key) "'."
  8405. (when disable-when-heading-prefix
  8406. (concat
  8407. "\nIf `orgstruct-heading-prefix-regexp' is not empty, this command will always fall\n"
  8408. "back to the default binding due to limitations of Org's implementation of\n"
  8409. "`" (symbol-name fun) "'.")))
  8410. (interactive "p")
  8411. (let* ((disable
  8412. ,(and disable-when-heading-prefix
  8413. '(not (string= orgstruct-heading-prefix-regexp ""))))
  8414. (fallback
  8415. (or disable
  8416. (not
  8417. (let* ,bindings
  8418. (org-context-p 'headline 'item
  8419. ,(when (memq fun
  8420. '(org-insert-heading
  8421. org-insert-heading-respect-content
  8422. org-meta-return))
  8423. '(when orgstruct-is-++
  8424. 'item-body))))))))
  8425. (if fallback
  8426. (let* ((orgstruct-mode)
  8427. (binding
  8428. (let ((key ,key))
  8429. (catch 'exit
  8430. (dolist
  8431. (rep
  8432. '(nil
  8433. ("<\\([^>]*\\)tab>" . "\\1TAB")
  8434. ("<\\([^>]*\\)return>" . "\\1RET")
  8435. ("<\\([^>]*\\)escape>" . "\\1ESC")
  8436. ("<\\([^>]*\\)delete>" . "\\1DEL"))
  8437. nil)
  8438. (when rep
  8439. (setq key (read-kbd-macro
  8440. (let ((case-fold-search))
  8441. (replace-regexp-in-string
  8442. (car rep)
  8443. (cdr rep)
  8444. (key-description key))))))
  8445. (when (key-binding key)
  8446. (throw 'exit (key-binding key))))))))
  8447. (if (keymapp binding)
  8448. (org-set-transient-map binding)
  8449. (let ((func (or binding
  8450. (unless disable
  8451. 'orgstruct-error))))
  8452. (when func
  8453. (call-interactively func)))))
  8454. (org-run-like-in-org-mode
  8455. (lambda ()
  8456. (interactive)
  8457. (let* ,bindings
  8458. (call-interactively ',fun)))))))))
  8459. name))
  8460. (defun org-contextualize-keys (alist contexts)
  8461. "Return valid elements in ALIST depending on CONTEXTS.
  8462. `org-agenda-custom-commands' or `org-capture-templates' are the
  8463. values used for ALIST, and `org-agenda-custom-commands-contexts'
  8464. or `org-capture-templates-contexts' are the associated contexts
  8465. definitions."
  8466. (let ((contexts
  8467. ;; normalize contexts
  8468. (mapcar
  8469. (lambda(c) (cond ((listp (cadr c))
  8470. (list (car c) (car c) (nth 1 c)))
  8471. ((string= "" (cadr c))
  8472. (list (car c) (car c) (nth 2 c)))
  8473. (t c)))
  8474. contexts))
  8475. (a alist) r s)
  8476. ;; loop over all commands or templates
  8477. (dolist (c a)
  8478. (let (vrules repl)
  8479. (cond
  8480. ((not (assoc (car c) contexts))
  8481. (push c r))
  8482. ((and (assoc (car c) contexts)
  8483. (setq vrules (org-contextualize-validate-key
  8484. (car c) contexts)))
  8485. (mapc (lambda (vr)
  8486. (unless (equal (car vr) (cadr vr))
  8487. (setq repl vr)))
  8488. vrules)
  8489. (if (not repl) (push c r)
  8490. (push (cadr repl) s)
  8491. (push
  8492. (cons (car c)
  8493. (cdr (or (assoc (cadr repl) alist)
  8494. (error "Undefined key `%s' as contextual replacement for `%s'"
  8495. (cadr repl) (car c)))))
  8496. r))))))
  8497. ;; Return limited ALIST, possibly with keys modified, and deduplicated
  8498. (delq
  8499. nil
  8500. (delete-dups
  8501. (mapcar (lambda (x)
  8502. (let ((tpl (car x)))
  8503. (unless (delq
  8504. nil
  8505. (mapcar (lambda (y)
  8506. (equal y tpl))
  8507. s))
  8508. x)))
  8509. (reverse r))))))
  8510. (defun org-contextualize-validate-key (key contexts)
  8511. "Check CONTEXTS for agenda or capture KEY."
  8512. (let (res)
  8513. (dolist (r contexts)
  8514. (dolist (rr (car (last r)))
  8515. (when
  8516. (and (equal key (car r))
  8517. (if (functionp rr) (funcall rr)
  8518. (or (and (eq (car rr) 'in-file)
  8519. (buffer-file-name)
  8520. (string-match (cdr rr) (buffer-file-name)))
  8521. (and (eq (car rr) 'in-mode)
  8522. (string-match (cdr rr) (symbol-name major-mode)))
  8523. (and (eq (car rr) 'in-buffer)
  8524. (string-match (cdr rr) (buffer-name)))
  8525. (when (and (eq (car rr) 'not-in-file)
  8526. (buffer-file-name))
  8527. (not (string-match (cdr rr) (buffer-file-name))))
  8528. (when (eq (car rr) 'not-in-mode)
  8529. (not (string-match (cdr rr) (symbol-name major-mode))))
  8530. (when (eq (car rr) 'not-in-buffer)
  8531. (not (string-match (cdr rr) (buffer-name)))))))
  8532. (push r res))))
  8533. (delete-dups (delq nil res))))
  8534. (defun org-context-p (&rest contexts)
  8535. "Check if local context is any of CONTEXTS.
  8536. Possible values in the list of contexts are `table', `headline', and `item'."
  8537. (let ((pos (point)))
  8538. (goto-char (point-at-bol))
  8539. (prog1 (or (and (memq 'table contexts)
  8540. (looking-at "[ \t]*|"))
  8541. (and (memq 'headline contexts)
  8542. (looking-at org-outline-regexp))
  8543. (and (memq 'item contexts)
  8544. (looking-at "[ \t]*\\([-+*] \\|[0-9]+[.)] \\)"))
  8545. (and (memq 'item-body contexts)
  8546. (org-in-item-p)))
  8547. (goto-char pos))))
  8548. (defconst org-unique-local-variables
  8549. '(org-element--cache
  8550. org-element--cache-objects
  8551. org-element--cache-sync-keys
  8552. org-element--cache-sync-requests
  8553. org-element--cache-sync-timer)
  8554. "List of local variables that cannot be transferred to another buffer.")
  8555. (defun org-get-local-variables ()
  8556. "Return a list of all local variables in an Org mode buffer."
  8557. (delq nil
  8558. (mapcar
  8559. (lambda (x)
  8560. (let* ((binding (if (symbolp x) (list x) (list (car x) (cdr x))))
  8561. (name (car binding)))
  8562. (and (not (get name 'org-state))
  8563. (not (memq name org-unique-local-variables))
  8564. (string-match-p
  8565. "\\`\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|\
  8566. auto-fill\\|normal-auto-fill\\|fill-paragraph\\|indent-\\)"
  8567. (symbol-name name))
  8568. binding)))
  8569. (with-temp-buffer
  8570. (org-mode)
  8571. (buffer-local-variables)))))
  8572. (defun org-clone-local-variables (from-buffer &optional regexp)
  8573. "Clone local variables from FROM-BUFFER.
  8574. Optional argument REGEXP selects variables to clone."
  8575. (dolist (pair (buffer-local-variables from-buffer))
  8576. (let ((name (car pair)))
  8577. (when (and (symbolp name)
  8578. (not (memq name org-unique-local-variables))
  8579. (or (null regexp) (string-match regexp (symbol-name name))))
  8580. (set (make-local-variable name) (cdr pair))))))
  8581. ;;;###autoload
  8582. (defun org-run-like-in-org-mode (cmd)
  8583. "Run a command, pretending that the current buffer is in Org mode.
  8584. This will temporarily bind local variables that are typically bound in
  8585. Org mode to the values they have in Org mode, and then interactively
  8586. call CMD."
  8587. (org-load-modules-maybe)
  8588. (unless org-local-vars
  8589. (setq org-local-vars (org-get-local-variables)))
  8590. (let (binds)
  8591. (dolist (var org-local-vars)
  8592. (when (or (not (boundp (car var)))
  8593. (eq (symbol-value (car var))
  8594. (default-value (car var))))
  8595. (push (list (car var) `(quote ,(cadr var))) binds)))
  8596. (eval `(let ,binds
  8597. (call-interactively (quote ,cmd))))))
  8598. (defun org-get-category (&optional pos force-refresh)
  8599. "Get the category applying to position POS."
  8600. (save-match-data
  8601. (when force-refresh (org-refresh-category-properties))
  8602. (let ((pos (or pos (point))))
  8603. (or (get-text-property pos 'org-category)
  8604. (progn (org-refresh-category-properties)
  8605. (get-text-property pos 'org-category))))))
  8606. ;;; Refresh properties
  8607. (defun org-refresh-properties (dprop tprop)
  8608. "Refresh buffer text properties.
  8609. DPROP is the drawer property and TPROP is either the
  8610. corresponding text property to set, or an alist with each element
  8611. being a text property (as a symbol) and a function to apply to
  8612. the value of the drawer property."
  8613. (let ((case-fold-search t)
  8614. (inhibit-read-only t))
  8615. (org-with-silent-modifications
  8616. (org-with-wide-buffer
  8617. (goto-char (point-min))
  8618. (while (re-search-forward (concat "^[ \t]*:" dprop ": +\\(.*\\)[ \t]*$") nil t)
  8619. (org-refresh-property tprop (match-string-no-properties 1)))))))
  8620. (defun org-refresh-property (tprop p)
  8621. "Refresh the buffer text property TPROP from the drawer property P.
  8622. The refresh happens only for the current tree (not subtree)."
  8623. (unless (org-before-first-heading-p)
  8624. (save-excursion
  8625. (org-back-to-heading t)
  8626. (if (symbolp tprop)
  8627. ;; TPROP is a text property symbol
  8628. (put-text-property
  8629. (point) (or (outline-next-heading) (point-max)) tprop p)
  8630. ;; TPROP is an alist with (properties . function) elements
  8631. (dolist (al tprop)
  8632. (save-excursion
  8633. (put-text-property
  8634. (line-beginning-position) (or (outline-next-heading) (point-max))
  8635. (car al)
  8636. (funcall (cdr al) p))))))))
  8637. (defun org-refresh-category-properties ()
  8638. "Refresh category text properties in the buffer."
  8639. (let ((case-fold-search t)
  8640. (inhibit-read-only t)
  8641. (default-category
  8642. (cond ((null org-category)
  8643. (if buffer-file-name
  8644. (file-name-sans-extension
  8645. (file-name-nondirectory buffer-file-name))
  8646. "???"))
  8647. ((symbolp org-category) (symbol-name org-category))
  8648. (t org-category))))
  8649. (org-with-silent-modifications
  8650. (org-with-wide-buffer
  8651. ;; Set buffer-wide category. Search last #+CATEGORY keyword.
  8652. ;; This is the default category for the buffer. If none is
  8653. ;; found, fall-back to `org-category' or buffer file name.
  8654. (put-text-property
  8655. (point-min) (point-max)
  8656. 'org-category
  8657. (catch 'buffer-category
  8658. (goto-char (point-max))
  8659. (while (re-search-backward "^[ \t]*#\\+CATEGORY:" (point-min) t)
  8660. (let ((element (org-element-at-point)))
  8661. (when (eq (org-element-type element) 'keyword)
  8662. (throw 'buffer-category
  8663. (org-element-property :value element)))))
  8664. default-category))
  8665. ;; Set sub-tree specific categories.
  8666. (goto-char (point-min))
  8667. (let ((regexp (org-re-property "CATEGORY")))
  8668. (while (re-search-forward regexp nil t)
  8669. (let ((value (match-string-no-properties 3)))
  8670. (when (org-at-property-p)
  8671. (put-text-property
  8672. (save-excursion (org-back-to-heading t) (point))
  8673. (save-excursion (org-end-of-subtree t t) (point))
  8674. 'org-category
  8675. value)))))))))
  8676. (defun org-refresh-stats-properties ()
  8677. "Refresh stats text properties in the buffer."
  8678. (let (stats)
  8679. (org-with-silent-modifications
  8680. (org-with-wide-buffer
  8681. (goto-char (point-min))
  8682. (while (re-search-forward
  8683. (concat org-outline-regexp-bol ".*"
  8684. "\\(?:\\[\\([0-9]+\\)%\\|\\([0-9]+\\)/\\([0-9]+\\)\\]\\)")
  8685. nil t)
  8686. (setq stats (cond ((equal (match-string 3) "0") 0)
  8687. ((match-string 2)
  8688. (/ (* (string-to-number (match-string 2)) 100)
  8689. (string-to-number (match-string 3))))
  8690. (t (string-to-number (match-string 1)))))
  8691. (org-back-to-heading t)
  8692. (put-text-property (point) (progn (org-end-of-subtree t t) (point))
  8693. 'org-stats stats))))))
  8694. (defun org-refresh-effort-properties ()
  8695. "Refresh effort properties"
  8696. (org-refresh-properties
  8697. org-effort-property
  8698. '((effort . identity)
  8699. (effort-minutes . org-duration-string-to-minutes))))
  8700. ;;;; Link Stuff
  8701. ;;; Link abbreviations
  8702. (defun org-link-expand-abbrev (link)
  8703. "Apply replacements as defined in `org-link-abbrev-alist'."
  8704. (if (string-match "^\\([^:]*\\)\\(::?\\(.*\\)\\)?$" link)
  8705. (let* ((key (match-string 1 link))
  8706. (as (or (assoc key org-link-abbrev-alist-local)
  8707. (assoc key org-link-abbrev-alist)))
  8708. (tag (and (match-end 2) (match-string 3 link)))
  8709. rpl)
  8710. (if (not as)
  8711. link
  8712. (setq rpl (cdr as))
  8713. (cond
  8714. ((symbolp rpl) (funcall rpl tag))
  8715. ((string-match "%(\\([^)]+\\))" rpl)
  8716. (replace-match
  8717. (save-match-data
  8718. (funcall (intern-soft (match-string 1 rpl)) tag)) t t rpl))
  8719. ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
  8720. ((string-match "%h" rpl)
  8721. (replace-match (url-hexify-string (or tag "")) t t rpl))
  8722. (t (concat rpl tag)))))
  8723. link))
  8724. ;;; Storing and inserting links
  8725. (defvar org-insert-link-history nil
  8726. "Minibuffer history for links inserted with `org-insert-link'.")
  8727. (defvar org-stored-links nil
  8728. "Contains the links stored with `org-store-link'.")
  8729. (defvar org-store-link-plist nil
  8730. "Plist with info about the most recently link created with `org-store-link'.")
  8731. (defun org-store-link-functions ()
  8732. "Return a list of functions that are called to create and store a link.
  8733. The functions defined in the :store property of
  8734. `org-link-parameters'.
  8735. Each function will be called in turn until one returns a non-nil
  8736. value. Each function should check if it is responsible for
  8737. creating this link (for example by looking at the major mode).
  8738. If not, it must exit and return nil. If yes, it should return
  8739. a non-nil value after calling `org-store-link-props' with a list
  8740. of properties and values. Special properties are:
  8741. :type The link prefix, like \"http\". This must be given.
  8742. :link The link, like \"http://www.astro.uva.nl/~dominik\".
  8743. This is obligatory as well.
  8744. :description Optional default description for the second pair
  8745. of brackets in an Org mode link. The user can still change
  8746. this when inserting this link into an Org mode buffer.
  8747. In addition to these, any additional properties can be specified
  8748. and then used in capture templates."
  8749. (cl-loop for link in org-link-parameters
  8750. with store-func
  8751. do (setq store-func (org-link-get-parameter (car link) :store))
  8752. if store-func
  8753. collect store-func))
  8754. (defvar org-agenda-buffer-name) ; Defined in org-agenda.el
  8755. (defvar org-id-link-to-org-use-id) ; Defined in org-id.el
  8756. ;;;###autoload
  8757. (defun org-store-link (arg)
  8758. "Store an org-link to the current location.
  8759. \\<org-mode-map>
  8760. This link is added to `org-stored-links' and can later be inserted
  8761. into an Org buffer with `org-insert-link' (`\\[org-insert-link]').
  8762. For some link types, a `\\[universal-argument]' prefix ARG is interpreted.
  8763. For links to Usenet articles, ARG negates `org-gnus-prefer-web-links'.
  8764. For file links, ARG negates `org-context-in-file-links'.
  8765. A `\\[universal-argument] \\[universal-argument]' prefix ARG forces \
  8766. skipping storing functions that are not
  8767. part of Org core.
  8768. A `\\[universal-argument] \\[universal-argument] \\[universal-argument]' \
  8769. prefix ARG forces storing a link for each line in the
  8770. active region."
  8771. (interactive "P")
  8772. (org-load-modules-maybe)
  8773. (if (and (equal arg '(64)) (org-region-active-p))
  8774. (save-excursion
  8775. (let ((end (region-end)))
  8776. (goto-char (region-beginning))
  8777. (set-mark (point))
  8778. (while (< (point-at-eol) end)
  8779. (move-end-of-line 1) (activate-mark)
  8780. (let (current-prefix-arg)
  8781. (call-interactively 'org-store-link))
  8782. (move-beginning-of-line 2)
  8783. (set-mark (point)))))
  8784. (setq org-store-link-plist nil)
  8785. (let (link cpltxt desc description search
  8786. txt custom-id agenda-link sfuns sfunsn)
  8787. (cond
  8788. ;; Store a link using an external link type
  8789. ((and (not (equal arg '(16)))
  8790. (setq sfuns
  8791. (delq
  8792. nil (mapcar (lambda (f)
  8793. (let (fs) (if (funcall f) (push f fs))))
  8794. (org-store-link-functions)))
  8795. sfunsn (mapcar (lambda (fu) (symbol-name (car fu))) sfuns))
  8796. (or (and (cdr sfuns)
  8797. (funcall (intern
  8798. (completing-read
  8799. "Which function for creating the link? "
  8800. sfunsn nil t (car sfunsn)))))
  8801. (funcall (caar sfuns)))
  8802. (setq link (plist-get org-store-link-plist :link)
  8803. desc (or (plist-get org-store-link-plist
  8804. :description)
  8805. link))))
  8806. ;; Store a link from a source code buffer.
  8807. ((org-src-edit-buffer-p)
  8808. (let ((coderef-format (org-src-coderef-format)))
  8809. (cond ((save-excursion
  8810. (beginning-of-line)
  8811. (looking-at (org-src-coderef-regexp coderef-format)))
  8812. (setq link (format "(%s)" (match-string-no-properties 3))))
  8813. ((called-interactively-p 'any)
  8814. (let ((label (read-string "Code line label: ")))
  8815. (end-of-line)
  8816. (setq link (format coderef-format label))
  8817. (let ((gc (- 79 (length link))))
  8818. (if (< (current-column) gc)
  8819. (org-move-to-column gc t)
  8820. (insert " ")))
  8821. (insert link)
  8822. (setq link (concat "(" label ")"))
  8823. (setq desc nil)))
  8824. (t (setq link nil)))))
  8825. ;; We are in the agenda, link to referenced location
  8826. ((equal (bound-and-true-p org-agenda-buffer-name) (buffer-name))
  8827. (let ((m (or (get-text-property (point) 'org-hd-marker)
  8828. (get-text-property (point) 'org-marker))))
  8829. (when m
  8830. (org-with-point-at m
  8831. (setq agenda-link
  8832. (if (called-interactively-p 'any)
  8833. (call-interactively 'org-store-link)
  8834. (org-store-link nil)))))))
  8835. ((eq major-mode 'calendar-mode)
  8836. (let ((cd (calendar-cursor-to-date)))
  8837. (setq link
  8838. (format-time-string
  8839. (car org-time-stamp-formats)
  8840. (apply 'encode-time
  8841. (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
  8842. nil nil nil))))
  8843. (org-store-link-props :type "calendar" :date cd)))
  8844. ((eq major-mode 'help-mode)
  8845. (setq link (concat "help:" (save-excursion
  8846. (goto-char (point-min))
  8847. (looking-at "^[^ ]+")
  8848. (match-string 0))))
  8849. (org-store-link-props :type "help"))
  8850. ((eq major-mode 'w3-mode)
  8851. (setq cpltxt (if (and (buffer-name)
  8852. (not (string-match "Untitled" (buffer-name))))
  8853. (buffer-name)
  8854. (url-view-url t))
  8855. link (url-view-url t))
  8856. (org-store-link-props :type "w3" :url (url-view-url t)))
  8857. ((eq major-mode 'image-mode)
  8858. (setq cpltxt (concat "file:"
  8859. (abbreviate-file-name buffer-file-name))
  8860. link cpltxt)
  8861. (org-store-link-props :type "image" :file buffer-file-name))
  8862. ;; In dired, store a link to the file of the current line
  8863. ((derived-mode-p 'dired-mode)
  8864. (let ((file (dired-get-filename nil t)))
  8865. (setq file (if file
  8866. (abbreviate-file-name
  8867. (expand-file-name (dired-get-filename nil t)))
  8868. ;; otherwise, no file so use current directory.
  8869. default-directory))
  8870. (setq cpltxt (concat "file:" file)
  8871. link cpltxt)))
  8872. ((setq search (run-hook-with-args-until-success
  8873. 'org-create-file-search-functions))
  8874. (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
  8875. "::" search))
  8876. (setq cpltxt (or description link)))
  8877. ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
  8878. (org-with-limited-levels
  8879. (setq custom-id (org-entry-get nil "CUSTOM_ID"))
  8880. (cond
  8881. ;; Store a link using the target at point
  8882. ((org-in-regexp "[^<]<<\\([^<>]+\\)>>[^>]" 1)
  8883. (setq cpltxt
  8884. (concat "file:"
  8885. (abbreviate-file-name
  8886. (buffer-file-name (buffer-base-buffer)))
  8887. "::" (match-string 1))
  8888. link cpltxt))
  8889. ((and (featurep 'org-id)
  8890. (or (eq org-id-link-to-org-use-id t)
  8891. (and (called-interactively-p 'any)
  8892. (or (eq org-id-link-to-org-use-id 'create-if-interactive)
  8893. (and (eq org-id-link-to-org-use-id
  8894. 'create-if-interactive-and-no-custom-id)
  8895. (not custom-id))))
  8896. (and org-id-link-to-org-use-id (org-entry-get nil "ID"))))
  8897. ;; Store a link using the ID at point
  8898. (setq link (condition-case nil
  8899. (prog1 (org-id-store-link)
  8900. (setq desc (or (plist-get org-store-link-plist
  8901. :description)
  8902. "")))
  8903. (error
  8904. ;; Probably before first headline, link only to file
  8905. (concat "file:"
  8906. (abbreviate-file-name
  8907. (buffer-file-name (buffer-base-buffer))))))))
  8908. (t
  8909. ;; Just link to current headline
  8910. (setq cpltxt (concat "file:"
  8911. (abbreviate-file-name
  8912. (buffer-file-name (buffer-base-buffer)))))
  8913. ;; Add a context search string
  8914. (when (org-xor org-context-in-file-links arg)
  8915. (let* ((element (org-element-at-point))
  8916. (name (org-element-property :name element)))
  8917. (setq txt (cond
  8918. ((org-at-heading-p) nil)
  8919. (name)
  8920. ((org-region-active-p)
  8921. (buffer-substring (region-beginning) (region-end)))))
  8922. (when (or (null txt) (string-match "\\S-" txt))
  8923. (setq cpltxt
  8924. (concat cpltxt "::"
  8925. (condition-case nil
  8926. (org-make-org-heading-search-string txt)
  8927. (error "")))
  8928. desc (or name
  8929. (nth 4 (ignore-errors (org-heading-components)))
  8930. "NONE")))))
  8931. (when (string-match "::\\'" cpltxt)
  8932. (setq cpltxt (substring cpltxt 0 -2)))
  8933. (setq link cpltxt)))))
  8934. ((buffer-file-name (buffer-base-buffer))
  8935. ;; Just link to this file here.
  8936. (setq cpltxt (concat "file:"
  8937. (abbreviate-file-name
  8938. (buffer-file-name (buffer-base-buffer)))))
  8939. ;; Add a context string.
  8940. (when (org-xor org-context-in-file-links arg)
  8941. (setq txt (if (org-region-active-p)
  8942. (buffer-substring (region-beginning) (region-end))
  8943. (buffer-substring (point-at-bol) (point-at-eol))))
  8944. ;; Only use search option if there is some text.
  8945. (when (string-match "\\S-" txt)
  8946. (setq cpltxt
  8947. (concat cpltxt "::" (org-make-org-heading-search-string txt))
  8948. desc "NONE")))
  8949. (setq link cpltxt))
  8950. ((called-interactively-p 'interactive)
  8951. (user-error "No method for storing a link from this buffer"))
  8952. (t (setq link nil)))
  8953. ;; We're done setting link and desc, clean up
  8954. (when (consp link) (setq cpltxt (car link) link (cdr link)))
  8955. (setq link (or link cpltxt)
  8956. desc (or desc cpltxt))
  8957. (cond ((not desc))
  8958. ((equal desc "NONE") (setq desc nil))
  8959. (t (setq desc
  8960. (replace-regexp-in-string
  8961. org-bracket-link-analytic-regexp
  8962. (lambda (m) (or (match-string 5 m) (match-string 3 m)))
  8963. desc))))
  8964. ;; Return the link
  8965. (if (not (and (or (called-interactively-p 'any)
  8966. executing-kbd-macro)
  8967. link))
  8968. (or agenda-link (and link (org-make-link-string link desc)))
  8969. (push (list link desc) org-stored-links)
  8970. (message "Stored: %s" (or desc link))
  8971. (when custom-id
  8972. (setq link (concat "file:" (abbreviate-file-name
  8973. (buffer-file-name)) "::#" custom-id))
  8974. (push (list link desc) org-stored-links))
  8975. (car org-stored-links)))))
  8976. (defun org-store-link-props (&rest plist)
  8977. "Store link properties, extract names, addresses and dates."
  8978. (let ((x (plist-get plist :from)))
  8979. (when x
  8980. (let ((adr (mail-extract-address-components x)))
  8981. (setq plist (plist-put plist :fromname (car adr)))
  8982. (setq plist (plist-put plist :fromaddress (nth 1 adr))))))
  8983. (let ((x (plist-get plist :to)))
  8984. (when x
  8985. (let ((adr (mail-extract-address-components x)))
  8986. (setq plist (plist-put plist :toname (car adr)))
  8987. (setq plist (plist-put plist :toaddress (nth 1 adr))))))
  8988. (let ((x (ignore-errors (date-to-time (plist-get plist :date)))))
  8989. (when x
  8990. (setq plist (plist-put plist :date-timestamp
  8991. (format-time-string
  8992. (org-time-stamp-format t) x)))
  8993. (setq plist (plist-put plist :date-timestamp-inactive
  8994. (format-time-string
  8995. (org-time-stamp-format t t) x)))))
  8996. (let ((from (plist-get plist :from))
  8997. (to (plist-get plist :to)))
  8998. (when (and from to org-from-is-user-regexp)
  8999. (setq plist
  9000. (plist-put plist :fromto
  9001. (if (string-match org-from-is-user-regexp from)
  9002. (concat "to %t")
  9003. (concat "from %f"))))))
  9004. (setq org-store-link-plist plist))
  9005. (defun org-add-link-props (&rest plist)
  9006. "Add these properties to the link property list."
  9007. (let (key value)
  9008. (while plist
  9009. (setq key (pop plist) value (pop plist))
  9010. (setq org-store-link-plist
  9011. (plist-put org-store-link-plist key value)))))
  9012. (defun org-email-link-description (&optional fmt)
  9013. "Return the description part of an email link.
  9014. This takes information from `org-store-link-plist' and formats it
  9015. according to FMT (default from `org-email-link-description-format')."
  9016. (setq fmt (or fmt org-email-link-description-format))
  9017. (let* ((p org-store-link-plist)
  9018. (to (plist-get p :toaddress))
  9019. (from (plist-get p :fromaddress))
  9020. (table
  9021. (list
  9022. (cons "%c" (plist-get p :fromto))
  9023. (cons "%F" (plist-get p :from))
  9024. (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
  9025. (cons "%T" (plist-get p :to))
  9026. (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
  9027. (cons "%s" (plist-get p :subject))
  9028. (cons "%d" (plist-get p :date))
  9029. (cons "%m" (plist-get p :message-id)))))
  9030. (when (string-match "%c" fmt)
  9031. ;; Check if the user wrote this message
  9032. (if (and org-from-is-user-regexp from to
  9033. (save-match-data (string-match org-from-is-user-regexp from)))
  9034. (setq fmt (replace-match "to %t" t t fmt))
  9035. (setq fmt (replace-match "from %f" t t fmt))))
  9036. (org-replace-escapes fmt table)))
  9037. (defun org-make-org-heading-search-string (&optional string)
  9038. "Make search string for the current headline or STRING."
  9039. (let ((s (or string
  9040. (and (derived-mode-p 'org-mode)
  9041. (save-excursion
  9042. (org-back-to-heading t)
  9043. (org-element-property :raw-value (org-element-at-point))))))
  9044. (lines org-context-in-file-links))
  9045. (or string (setq s (concat "*" s))) ; Add * for headlines
  9046. (setq s (replace-regexp-in-string "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" "" s))
  9047. (when (and string (integerp lines) (> lines 0))
  9048. (let ((slines (org-split-string s "\n")))
  9049. (when (< lines (length slines))
  9050. (setq s (mapconcat
  9051. 'identity
  9052. (reverse (nthcdr (- (length slines) lines)
  9053. (reverse slines))) "\n")))))
  9054. (mapconcat 'identity (org-split-string s "[ \t]+") " ")))
  9055. (defun org-make-link-string (link &optional description)
  9056. "Make a link with brackets, consisting of LINK and DESCRIPTION."
  9057. (unless (org-string-nw-p link) (error "Empty link"))
  9058. (let ((uri (cond ((string-match org-link-types-re link)
  9059. (concat (match-string 1 link)
  9060. (org-link-escape (substring link (match-end 1)))))
  9061. ;; For readability, url-encode internal links only
  9062. ;; when absolutely needed (i.e, when they contain
  9063. ;; square brackets). File links however, are
  9064. ;; encoded since, e.g., spaces are significant.
  9065. ((or (file-name-absolute-p link)
  9066. (string-match-p "\\`\\.\\.?/\\|[][]" link))
  9067. (org-link-escape link))
  9068. (t link)))
  9069. (description
  9070. (and (org-string-nw-p description)
  9071. ;; Remove brackets from description, as they are fatal.
  9072. (replace-regexp-in-string
  9073. "[][]" (lambda (m) (if (equal "[" m) "{" "}"))
  9074. (org-trim description)))))
  9075. (format "[[%s]%s]"
  9076. uri
  9077. (if description (format "[%s]" description) ""))))
  9078. (defconst org-link-escape-chars
  9079. ;;%20 %5B %5D %25
  9080. '(?\s ?\[ ?\] ?%)
  9081. "List of characters that should be escaped in a link when stored to Org.
  9082. This is the list that is used for internal purposes.")
  9083. (defun org-link-escape (text &optional table merge)
  9084. "Return percent escaped representation of TEXT.
  9085. TEXT is a string with the text to escape.
  9086. Optional argument TABLE is a list with characters that should be
  9087. escaped. When nil, `org-link-escape-chars' is used.
  9088. If optional argument MERGE is set, merge TABLE into
  9089. `org-link-escape-chars'."
  9090. (let ((characters-to-encode
  9091. (cond ((null table) org-link-escape-chars)
  9092. (merge (append org-link-escape-chars table))
  9093. (t table))))
  9094. (mapconcat
  9095. (lambda (c)
  9096. (if (or (memq c characters-to-encode)
  9097. (and org-url-hexify-p (or (< c 32) (> c 126))))
  9098. (mapconcat (lambda (e) (format "%%%.2X" e))
  9099. (or (encode-coding-char c 'utf-8)
  9100. (error "Unable to percent escape character: %c" c))
  9101. "")
  9102. (char-to-string c)))
  9103. text "")))
  9104. (defun org-link-unescape (str)
  9105. "Unhex hexified Unicode parts in string STR.
  9106. E.g. `%C3%B6' becomes the german o-Umlaut. This is the
  9107. reciprocal of `org-link-escape', which see."
  9108. (if (org-string-nw-p str)
  9109. (replace-regexp-in-string
  9110. "\\(%[0-9A-Za-z]\\{2\\}\\)+" #'org-link-unescape-compound str t t)
  9111. str))
  9112. (defun org-link-unescape-compound (hex)
  9113. "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German o-Umlaut.
  9114. Note: this function also decodes single byte encodings like
  9115. `%E1' (a-acute) if not followed by another `%[A-F0-9]{2}' group."
  9116. (save-match-data
  9117. (let* ((bytes (cdr (split-string hex "%")))
  9118. (ret "")
  9119. (eat 0)
  9120. (sum 0))
  9121. (while bytes
  9122. (let* ((val (string-to-number (pop bytes) 16))
  9123. (shift-xor
  9124. (if (= 0 eat)
  9125. (cond
  9126. ((>= val 252) (cons 6 252))
  9127. ((>= val 248) (cons 5 248))
  9128. ((>= val 240) (cons 4 240))
  9129. ((>= val 224) (cons 3 224))
  9130. ((>= val 192) (cons 2 192))
  9131. (t (cons 0 0)))
  9132. (cons 6 128))))
  9133. (when (>= val 192) (setq eat (car shift-xor)))
  9134. (setq val (logxor val (cdr shift-xor)))
  9135. (setq sum (+ (lsh sum (car shift-xor)) val))
  9136. (when (> eat 0) (setq eat (- eat 1)))
  9137. (cond
  9138. ((= 0 eat) ;multi byte
  9139. (setq ret (concat ret (char-to-string sum)))
  9140. (setq sum 0))
  9141. ((not bytes) ; single byte(s)
  9142. (setq ret (org-link-unescape-single-byte-sequence hex))))))
  9143. ret)))
  9144. (defun org-link-unescape-single-byte-sequence (hex)
  9145. "Unhexify hex-encoded single byte character sequences."
  9146. (mapconcat (lambda (byte)
  9147. (char-to-string (string-to-number byte 16)))
  9148. (cdr (split-string hex "%")) ""))
  9149. (defun org-xor (a b)
  9150. "Exclusive or."
  9151. (if a (not b) b))
  9152. (defun org-fixup-message-id-for-http (s)
  9153. "Replace special characters in a message id, so it can be used in an http query."
  9154. (when (string-match "%" s)
  9155. (setq s (mapconcat (lambda (c)
  9156. (if (eq c ?%)
  9157. "%25"
  9158. (char-to-string c)))
  9159. s "")))
  9160. (while (string-match "<" s)
  9161. (setq s (replace-match "%3C" t t s)))
  9162. (while (string-match ">" s)
  9163. (setq s (replace-match "%3E" t t s)))
  9164. (while (string-match "@" s)
  9165. (setq s (replace-match "%40" t t s)))
  9166. s)
  9167. (defun org-link-prettify (link)
  9168. "Return a human-readable representation of LINK.
  9169. The car of LINK must be a raw link.
  9170. The cdr of LINK must be either a link description or nil."
  9171. (let ((desc (or (cadr link) "<no description>")))
  9172. (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
  9173. "<" (car link) ">")))
  9174. ;;;###autoload
  9175. (defun org-insert-link-global ()
  9176. "Insert a link like Org mode does.
  9177. This command can be called in any mode to insert a link in Org syntax."
  9178. (interactive)
  9179. (org-load-modules-maybe)
  9180. (org-run-like-in-org-mode 'org-insert-link))
  9181. (defun org-insert-all-links (arg &optional pre post)
  9182. "Insert all links in `org-stored-links'.
  9183. When a universal prefix, do not delete the links from `org-stored-links'.
  9184. When `ARG' is a number, insert the last N link(s).
  9185. `PRE' and `POST' are optional arguments to define a string to
  9186. prepend or to append."
  9187. (interactive "P")
  9188. (let ((org-keep-stored-link-after-insertion (equal arg '(4)))
  9189. (links (copy-sequence org-stored-links))
  9190. (pr (or pre "- "))
  9191. (po (or post "\n"))
  9192. (cnt 1) l)
  9193. (if (null org-stored-links)
  9194. (message "No link to insert")
  9195. (while (and (or (listp arg) (>= arg cnt))
  9196. (setq l (if (listp arg)
  9197. (pop links)
  9198. (pop org-stored-links))))
  9199. (setq cnt (1+ cnt))
  9200. (insert pr)
  9201. (org-insert-link nil (car l) (or (cadr l) "<no description>"))
  9202. (insert po)))))
  9203. (defun org-insert-last-stored-link (arg)
  9204. "Insert the last link stored in `org-stored-links'."
  9205. (interactive "p")
  9206. (org-insert-all-links arg "" "\n"))
  9207. (defun org-link-fontify-links-to-this-file ()
  9208. "Fontify links to the current file in `org-stored-links'."
  9209. (let ((f (buffer-file-name)) a b)
  9210. (setq a (mapcar (lambda(l)
  9211. (let ((ll (car l)))
  9212. (when (and (string-match "^file:\\(.+\\)::" ll)
  9213. (equal f (expand-file-name (match-string 1 ll))))
  9214. ll)))
  9215. org-stored-links))
  9216. (when (featurep 'org-id)
  9217. (setq b (mapcar (lambda(l)
  9218. (let ((ll (car l)))
  9219. (when (and (string-match "^id:\\(.+\\)$" ll)
  9220. (equal f (expand-file-name
  9221. (or (org-id-find-id-file
  9222. (match-string 1 ll)) ""))))
  9223. ll)))
  9224. org-stored-links)))
  9225. (mapcar (lambda(l)
  9226. (put-text-property 0 (length l) 'face 'font-lock-comment-face l))
  9227. (delq nil (append a b)))))
  9228. (defvar org--links-history nil)
  9229. (defun org-insert-link (&optional complete-file link-location default-description)
  9230. "Insert a link. At the prompt, enter the link.
  9231. Completion can be used to insert any of the link protocol prefixes in use.
  9232. The history can be used to select a link previously stored with
  9233. `org-store-link'. When the empty string is entered (i.e. if you just
  9234. press `RET' at the prompt), the link defaults to the most recently
  9235. stored link. As `SPC' triggers completion in the minibuffer, you need to
  9236. use `M-SPC' or `C-q SPC' to force the insertion of a space character.
  9237. You will also be prompted for a description, and if one is given, it will
  9238. be displayed in the buffer instead of the link.
  9239. If there is already a link at point, this command will allow you to edit
  9240. link and description parts.
  9241. With a `\\[universal-argument]' prefix, prompts for a file to link to. The \
  9242. file name can be
  9243. selected using completion. The path to the file will be relative to the
  9244. current directory if the file is in the current directory or a subdirectory.
  9245. Otherwise, the link will be the absolute path as completed in the minibuffer
  9246. \(i.e. normally ~/path/to/file). You can configure this behavior using the
  9247. option `org-link-file-path-type'.
  9248. With a `\\[universal-argument] \\[universal-argument]' prefix, enforce an \
  9249. absolute path even if the file is in
  9250. the current directory or below.
  9251. A `\\[universal-argument] \\[universal-argument] \\[universal-argument]' \
  9252. prefix negates `org-keep-stored-link-after-insertion'.
  9253. If `org-make-link-description-function' is non-nil, this function will be
  9254. called with the link target, and the result will be the default
  9255. link description.
  9256. If the LINK-LOCATION parameter is non-nil, this value will be used as
  9257. the link location instead of reading one interactively.
  9258. If the DEFAULT-DESCRIPTION parameter is non-nil, this value will be used
  9259. as the default description."
  9260. (interactive "P")
  9261. (let* ((wcf (current-window-configuration))
  9262. (origbuf (current-buffer))
  9263. (region (when (org-region-active-p)
  9264. (buffer-substring (region-beginning) (region-end))))
  9265. (remove (and region (list (region-beginning) (region-end))))
  9266. (desc region)
  9267. (link link-location)
  9268. (abbrevs org-link-abbrev-alist-local)
  9269. entry all-prefixes auto-desc)
  9270. (cond
  9271. (link-location) ; specified by arg, just use it.
  9272. ((org-in-regexp org-bracket-link-regexp 1)
  9273. ;; We do have a link at point, and we are going to edit it.
  9274. (setq remove (list (match-beginning 0) (match-end 0)))
  9275. (setq desc (when (match-end 3) (match-string-no-properties 3)))
  9276. (setq link (read-string "Link: "
  9277. (org-link-unescape
  9278. (match-string-no-properties 1)))))
  9279. ((or (org-in-regexp org-angle-link-re)
  9280. (org-in-regexp org-plain-link-re))
  9281. ;; Convert to bracket link
  9282. (setq remove (list (match-beginning 0) (match-end 0))
  9283. link (read-string "Link: "
  9284. (org-unbracket-string "<" ">" (match-string 0)))))
  9285. ((member complete-file '((4) (16)))
  9286. ;; Completing read for file names.
  9287. (setq link (org-file-complete-link complete-file)))
  9288. (t
  9289. ;; Read link, with completion for stored links.
  9290. (org-link-fontify-links-to-this-file)
  9291. (org-switch-to-buffer-other-window "*Org Links*")
  9292. (with-current-buffer "*Org Links*"
  9293. (erase-buffer)
  9294. (insert "Insert a link.
  9295. Use TAB to complete link prefixes, then RET for type-specific completion support\n")
  9296. (when org-stored-links
  9297. (insert "\nStored links are available with <up>/<down> or M-p/n (most recent with RET):\n\n")
  9298. (insert (mapconcat 'org-link-prettify
  9299. (reverse org-stored-links) "\n")))
  9300. (goto-char (point-min)))
  9301. (let ((cw (selected-window)))
  9302. (select-window (get-buffer-window "*Org Links*" 'visible))
  9303. (with-current-buffer "*Org Links*" (setq truncate-lines t))
  9304. (unless (pos-visible-in-window-p (point-max))
  9305. (org-fit-window-to-buffer))
  9306. (and (window-live-p cw) (select-window cw)))
  9307. (setq all-prefixes (append (mapcar 'car abbrevs)
  9308. (mapcar 'car org-link-abbrev-alist)
  9309. (org-link-types)))
  9310. (unwind-protect
  9311. ;; Fake a link history, containing the stored links.
  9312. (let ((org--links-history
  9313. (append (mapcar #'car org-stored-links)
  9314. org-insert-link-history)))
  9315. (setq link
  9316. (org-completing-read
  9317. "Link: "
  9318. (append
  9319. (mapcar (lambda (x) (concat x ":")) all-prefixes)
  9320. (mapcar #'car org-stored-links))
  9321. nil nil nil
  9322. 'org--links-history
  9323. (caar org-stored-links)))
  9324. (unless (org-string-nw-p link) (user-error "No link selected"))
  9325. (dolist (l org-stored-links)
  9326. (when (equal link (cadr l))
  9327. (setq link (car l))
  9328. (setq auto-desc t)))
  9329. (when (or (member link all-prefixes)
  9330. (and (equal ":" (substring link -1))
  9331. (member (substring link 0 -1) all-prefixes)
  9332. (setq link (substring link 0 -1))))
  9333. (setq link (with-current-buffer origbuf
  9334. (org-link-try-special-completion link)))))
  9335. (set-window-configuration wcf)
  9336. (kill-buffer "*Org Links*"))
  9337. (setq entry (assoc link org-stored-links))
  9338. (or entry (push link org-insert-link-history))
  9339. (setq desc (or desc (nth 1 entry)))))
  9340. (when (funcall (if (equal complete-file '(64)) 'not 'identity)
  9341. (not org-keep-stored-link-after-insertion))
  9342. (setq org-stored-links (delq (assoc link org-stored-links)
  9343. org-stored-links)))
  9344. (when (and (string-match org-plain-link-re link)
  9345. (not (string-match org-ts-regexp link)))
  9346. ;; URL-like link, normalize the use of angular brackets.
  9347. (setq link (org-unbracket-string "<" ">" link)))
  9348. ;; Check if we are linking to the current file with a search
  9349. ;; option If yes, simplify the link by using only the search
  9350. ;; option.
  9351. (when (and buffer-file-name
  9352. (string-match "^file:\\(.+?\\)::\\(.+\\)" link))
  9353. (let* ((path (match-string 1 link))
  9354. (case-fold-search nil)
  9355. (search (match-string 2 link)))
  9356. (save-match-data
  9357. (when (equal (file-truename buffer-file-name) (file-truename path))
  9358. ;; We are linking to this same file, with a search option
  9359. (setq link search)))))
  9360. ;; Check if we can/should use a relative path. If yes, simplify the link
  9361. (when (string-match "^\\(file:\\|docview:\\)\\(.*\\)" link)
  9362. (let* ((type (match-string 1 link))
  9363. (path (match-string 2 link))
  9364. (origpath path)
  9365. (case-fold-search nil))
  9366. (cond
  9367. ((or (eq org-link-file-path-type 'absolute)
  9368. (equal complete-file '(16)))
  9369. (setq path (abbreviate-file-name (expand-file-name path))))
  9370. ((eq org-link-file-path-type 'noabbrev)
  9371. (setq path (expand-file-name path)))
  9372. ((eq org-link-file-path-type 'relative)
  9373. (setq path (file-relative-name path)))
  9374. (t
  9375. (save-match-data
  9376. (if (string-match (concat "^" (regexp-quote
  9377. (expand-file-name
  9378. (file-name-as-directory
  9379. default-directory))))
  9380. (expand-file-name path))
  9381. ;; We are linking a file with relative path name.
  9382. (setq path (substring (expand-file-name path)
  9383. (match-end 0)))
  9384. (setq path (abbreviate-file-name (expand-file-name path)))))))
  9385. (setq link (concat type path))
  9386. (when (equal desc origpath)
  9387. (setq desc path))))
  9388. (if org-make-link-description-function
  9389. (setq desc
  9390. (or (condition-case nil
  9391. (funcall org-make-link-description-function link desc)
  9392. (error (progn (message "Can't get link description from `%s'"
  9393. (symbol-name org-make-link-description-function))
  9394. (sit-for 2) nil)))
  9395. (read-string "Description: " default-description)))
  9396. (if default-description (setq desc default-description)
  9397. (setq desc (or (and auto-desc desc)
  9398. (read-string "Description: " desc)))))
  9399. (unless (string-match "\\S-" desc) (setq desc nil))
  9400. (when remove (apply 'delete-region remove))
  9401. (insert (org-make-link-string link desc))
  9402. ;; Redisplay so as the new link has proper invisible characters.
  9403. (sit-for 0)))
  9404. (defun org-link-try-special-completion (type)
  9405. "If there is completion support for link type TYPE, offer it."
  9406. (let ((fun (org-link-get-parameter type :complete)))
  9407. (if (functionp fun)
  9408. (funcall fun)
  9409. (read-string "Link (no completion support): " (concat type ":")))))
  9410. (defun org-file-complete-link (&optional arg)
  9411. "Create a file link using completion."
  9412. (let ((file (read-file-name "File: "))
  9413. (pwd (file-name-as-directory (expand-file-name ".")))
  9414. (pwd1 (file-name-as-directory (abbreviate-file-name
  9415. (expand-file-name ".")))))
  9416. (cond ((equal arg '(16))
  9417. (concat "file:"
  9418. (abbreviate-file-name (expand-file-name file))))
  9419. ((string-match
  9420. (concat "^" (regexp-quote pwd1) "\\(.+\\)") file)
  9421. (concat "file:" (match-string 1 file)))
  9422. ((string-match
  9423. (concat "^" (regexp-quote pwd) "\\(.+\\)")
  9424. (expand-file-name file))
  9425. (concat "file:"
  9426. (match-string 1 (expand-file-name file))))
  9427. (t (concat "file:" file)))))
  9428. (defun org-completing-read (&rest args)
  9429. "Completing-read with SPACE being a normal character."
  9430. (let ((enable-recursive-minibuffers t)
  9431. (minibuffer-local-completion-map
  9432. (copy-keymap minibuffer-local-completion-map)))
  9433. (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
  9434. (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
  9435. (org-defkey minibuffer-local-completion-map (kbd "C-c !")
  9436. 'org-time-stamp-inactive)
  9437. (apply #'completing-read args)))
  9438. ;;; Opening/following a link
  9439. (defvar org-link-search-failed nil)
  9440. (defvar org-open-link-functions nil
  9441. "Hook for functions finding a plain text link.
  9442. These functions must take a single argument, the link content.
  9443. They will be called for links that look like [[link text][description]]
  9444. when LINK TEXT does not have a protocol like \"http:\" and does not look
  9445. like a filename (e.g. \"./blue.png\").
  9446. These functions will be called *before* Org attempts to resolve the
  9447. link by doing text searches in the current buffer - so if you want a
  9448. link \"[[target]]\" to still find \"<<target>>\", your function should
  9449. handle this as a special case.
  9450. When the function does handle the link, it must return a non-nil value.
  9451. If it decides that it is not responsible for this link, it must return
  9452. nil to indicate that that Org can continue with other options like
  9453. exact and fuzzy text search.")
  9454. (defun org-next-link (&optional search-backward)
  9455. "Move forward to the next link.
  9456. If the link is in hidden text, expose it."
  9457. (interactive "P")
  9458. (when (and org-link-search-failed (eq this-command last-command))
  9459. (goto-char (point-min))
  9460. (message "Link search wrapped back to beginning of buffer"))
  9461. (setq org-link-search-failed nil)
  9462. (let* ((pos (point))
  9463. (ct (org-context))
  9464. (a (assq :link ct))
  9465. (srch-fun (if search-backward 're-search-backward 're-search-forward)))
  9466. (cond (a (goto-char (nth (if search-backward 1 2) a)))
  9467. ((looking-at org-any-link-re)
  9468. ;; Don't stay stuck at link without an org-link face
  9469. (forward-char (if search-backward -1 1))))
  9470. (if (funcall srch-fun org-any-link-re nil t)
  9471. (progn
  9472. (goto-char (match-beginning 0))
  9473. (when (outline-invisible-p) (org-show-context)))
  9474. (goto-char pos)
  9475. (setq org-link-search-failed t)
  9476. (message "No further link found"))))
  9477. (defun org-previous-link ()
  9478. "Move backward to the previous link.
  9479. If the link is in hidden text, expose it."
  9480. (interactive)
  9481. (funcall 'org-next-link t))
  9482. (defun org-translate-link (s)
  9483. "Translate a link string if a translation function has been defined."
  9484. (with-temp-buffer
  9485. (insert (org-trim s))
  9486. (org-trim (org-element-interpret-data (org-element-context)))))
  9487. (defun org-translate-link-from-planner (type path)
  9488. "Translate a link from Emacs Planner syntax so that Org can follow it.
  9489. This is still an experimental function, your mileage may vary."
  9490. (cond
  9491. ((member type '("http" "https" "news" "ftp"))
  9492. ;; standard Internet links are the same.
  9493. nil)
  9494. ((and (equal type "irc") (string-match "^//" path))
  9495. ;; Planner has two / at the beginning of an irc link, we have 1.
  9496. ;; We should have zero, actually....
  9497. (setq path (substring path 1)))
  9498. ((and (equal type "lisp") (string-match "^/" path))
  9499. ;; Planner has a slash, we do not.
  9500. (setq type "elisp" path (substring path 1)))
  9501. ((string-match "^//\\(.?*\\)/\\(<.*>\\)$" path)
  9502. ;; A typical message link. Planner has the id after the final slash,
  9503. ;; we separate it with a hash mark
  9504. (setq path (concat (match-string 1 path) "#"
  9505. (org-unbracket-string "<" ">" (match-string 2 path))))))
  9506. (cons type path))
  9507. (defun org-find-file-at-mouse (ev)
  9508. "Open file link or URL at mouse."
  9509. (interactive "e")
  9510. (mouse-set-point ev)
  9511. (org-open-at-point 'in-emacs))
  9512. (defun org-open-at-mouse (ev)
  9513. "Open file link or URL at mouse.
  9514. See the docstring of `org-open-file' for details."
  9515. (interactive "e")
  9516. (mouse-set-point ev)
  9517. (when (eq major-mode 'org-agenda-mode)
  9518. (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
  9519. (org-open-at-point))
  9520. (defvar org-window-config-before-follow-link nil
  9521. "The window configuration before following a link.
  9522. This is saved in case the need arises to restore it.")
  9523. ;;;###autoload
  9524. (defun org-open-at-point-global ()
  9525. "Follow a link or time-stamp like Org mode does.
  9526. This command can be called in any mode to follow an external link
  9527. or a time-stamp that has Org mode syntax. Its behavior is
  9528. undefined when called on internal links (e.g., fuzzy links).
  9529. Raise an error when there is nothing to follow. "
  9530. (interactive)
  9531. (cond ((org-in-regexp org-any-link-re)
  9532. (org-open-link-from-string (match-string-no-properties 0)))
  9533. ((or (org-in-regexp org-ts-regexp-both nil t)
  9534. (org-in-regexp org-tsr-regexp-both nil t))
  9535. (org-follow-timestamp-link))
  9536. (t (user-error "No link found"))))
  9537. ;;;###autoload
  9538. (defun org-open-link-from-string (s &optional arg reference-buffer)
  9539. "Open a link in the string S, as if it was in Org mode."
  9540. (interactive "sLink: \nP")
  9541. (let ((reference-buffer (or reference-buffer (current-buffer))))
  9542. (with-temp-buffer
  9543. (let ((org-inhibit-startup (not reference-buffer)))
  9544. (org-mode)
  9545. (insert s)
  9546. (goto-char (point-min))
  9547. (when reference-buffer
  9548. (setq org-link-abbrev-alist-local
  9549. (with-current-buffer reference-buffer
  9550. org-link-abbrev-alist-local)))
  9551. (org-open-at-point arg reference-buffer)))))
  9552. (defvar org-open-at-point-functions nil
  9553. "Hook that is run when following a link at point.
  9554. Functions in this hook must return t if they identify and follow
  9555. a link at point. If they don't find anything interesting at point,
  9556. they must return nil.")
  9557. (defvar org-link-search-inhibit-query nil)
  9558. (defvar clean-buffer-list-kill-buffer-names) ;Defined in midnight.el
  9559. (defun org--open-doi-link (path)
  9560. "Open a \"doi\" type link.
  9561. PATH is a the path to search for, as a string."
  9562. (browse-url (url-encode-url (concat org-doi-server-url path))))
  9563. (defun org--open-elisp-link (path)
  9564. "Open a \"elisp\" type link.
  9565. PATH is the sexp to evaluate, as a string."
  9566. (let ((cmd path))
  9567. (if (or (and (org-string-nw-p
  9568. org-confirm-elisp-link-not-regexp)
  9569. (string-match-p org-confirm-elisp-link-not-regexp cmd))
  9570. (not org-confirm-elisp-link-function)
  9571. (funcall org-confirm-elisp-link-function
  9572. (format "Execute \"%s\" as elisp? "
  9573. (org-add-props cmd nil 'face 'org-warning))))
  9574. (message "%s => %s" cmd
  9575. (if (eq (string-to-char cmd) ?\()
  9576. (eval (read cmd))
  9577. (call-interactively (read cmd))))
  9578. (user-error "Abort"))))
  9579. (defun org--open-help-link (path)
  9580. "Open a \"help\" type link.
  9581. PATH is a symbol name, as a string."
  9582. (pcase (intern path)
  9583. ((and (pred fboundp) variable) (describe-function variable))
  9584. ((and (pred boundp) function) (describe-variable function))
  9585. (name (user-error "Unknown function or variable: %s" name))))
  9586. (defun org--open-shell-link (path)
  9587. "Open a \"shell\" type link.
  9588. PATH is the command to execute, as a string."
  9589. (let ((buf (generate-new-buffer "*Org Shell Output*"))
  9590. (cmd path))
  9591. (if (or (and (org-string-nw-p
  9592. org-confirm-shell-link-not-regexp)
  9593. (string-match
  9594. org-confirm-shell-link-not-regexp cmd))
  9595. (not org-confirm-shell-link-function)
  9596. (funcall org-confirm-shell-link-function
  9597. (format "Execute \"%s\" in shell? "
  9598. (org-add-props cmd nil
  9599. 'face 'org-warning))))
  9600. (progn
  9601. (message "Executing %s" cmd)
  9602. (shell-command cmd buf)
  9603. (when (featurep 'midnight)
  9604. (setq clean-buffer-list-kill-buffer-names
  9605. (cons (buffer-name buf)
  9606. clean-buffer-list-kill-buffer-names))))
  9607. (user-error "Abort"))))
  9608. (defun org-open-at-point (&optional arg reference-buffer)
  9609. "Open link, timestamp, footnote or tags at point.
  9610. When point is on a link, follow it. Normally, files will be
  9611. opened by an appropriate application. If the optional prefix
  9612. argument ARG is non-nil, Emacs will visit the file. With
  9613. a double prefix argument, try to open outside of Emacs, in the
  9614. application the system uses for this file type.
  9615. When point is on a timestamp, open the agenda at the day
  9616. specified.
  9617. When point is a footnote definition, move to the first reference
  9618. found. If it is on a reference, move to the associated
  9619. definition.
  9620. When point is on a headline, display a list of every link in the
  9621. entry, so it is possible to pick one, or all, of them. If point
  9622. is on a tag, call `org-tags-view' instead.
  9623. When optional argument REFERENCE-BUFFER is non-nil, it should
  9624. specify a buffer from where the link search should happen. This
  9625. is used internally by `org-open-link-from-string'.
  9626. On top of syntactically correct links, this function will open
  9627. the link at point in comments or comment blocks and the first
  9628. link in a property drawer line."
  9629. (interactive "P")
  9630. ;; On a code block, open block's results.
  9631. (unless (call-interactively 'org-babel-open-src-block-result)
  9632. (org-load-modules-maybe)
  9633. (setq org-window-config-before-follow-link (current-window-configuration))
  9634. (org-remove-occur-highlights nil nil t)
  9635. (unless (run-hook-with-args-until-success 'org-open-at-point-functions)
  9636. (let* ((context
  9637. ;; Only consider supported types, even if they are not
  9638. ;; the closest one.
  9639. (org-element-lineage
  9640. (org-element-context)
  9641. '(clock comment comment-block footnote-definition
  9642. footnote-reference headline inlinetask keyword link
  9643. node-property timestamp)
  9644. t))
  9645. (type (org-element-type context))
  9646. (value (org-element-property :value context)))
  9647. (cond
  9648. ((not context) (user-error "No link found"))
  9649. ;; Exception: open timestamps and links in properties
  9650. ;; drawers, keywords and comments.
  9651. ((memq type '(comment comment-block keyword node-property))
  9652. (call-interactively #'org-open-at-point-global))
  9653. ;; On a headline or an inlinetask, but not on a timestamp,
  9654. ;; a link, a footnote reference or on tags.
  9655. ((and (memq type '(headline inlinetask))
  9656. ;; Not on tags.
  9657. (let ((case-fold-search nil))
  9658. (save-excursion
  9659. (beginning-of-line)
  9660. (looking-at org-complex-heading-regexp))
  9661. (or (not (match-beginning 5))
  9662. (< (point) (match-beginning 5)))))
  9663. (let* ((data (org-offer-links-in-entry (current-buffer) (point) arg))
  9664. (links (car data))
  9665. (links-end (cdr data)))
  9666. (if links
  9667. (dolist (link (if (stringp links) (list links) links))
  9668. (search-forward link nil links-end)
  9669. (goto-char (match-beginning 0))
  9670. (org-open-at-point))
  9671. (require 'org-attach)
  9672. (org-attach-reveal 'if-exists))))
  9673. ;; On a clock line, make sure point is on the timestamp
  9674. ;; before opening it.
  9675. ((and (eq type 'clock)
  9676. value
  9677. (>= (point) (org-element-property :begin value))
  9678. (<= (point) (org-element-property :end value)))
  9679. (org-follow-timestamp-link))
  9680. ;; Do nothing on white spaces after an object.
  9681. ((>= (point)
  9682. (save-excursion
  9683. (goto-char (org-element-property :end context))
  9684. (skip-chars-backward " \t")
  9685. (point)))
  9686. (user-error "No link found"))
  9687. ((eq type 'timestamp) (org-follow-timestamp-link))
  9688. ;; On tags within a headline or an inlinetask.
  9689. ((and (memq type '(headline inlinetask))
  9690. (let ((case-fold-search nil))
  9691. (save-excursion (beginning-of-line)
  9692. (looking-at org-complex-heading-regexp))
  9693. (and (match-beginning 5)
  9694. (>= (point) (match-beginning 5)))))
  9695. (org-tags-view arg (substring (match-string 5) 0 -1)))
  9696. ((eq type 'link)
  9697. (let ((type (org-element-property :type context))
  9698. (path (org-link-unescape (org-element-property :path context))))
  9699. ;; Switch back to REFERENCE-BUFFER needed when called in
  9700. ;; a temporary buffer through `org-open-link-from-string'.
  9701. (with-current-buffer (or reference-buffer (current-buffer))
  9702. (cond
  9703. ((equal type "file")
  9704. (if (string-match "[*?{]" (file-name-nondirectory path))
  9705. (dired path)
  9706. ;; Look into `org-link-parameters' in order to find
  9707. ;; a DEDICATED-FUNCTION to open file. The function
  9708. ;; will be applied on raw link instead of parsed
  9709. ;; link due to the limitation in `org-add-link-type'
  9710. ;; ("open" function called with a single argument).
  9711. ;; If no such function is found, fallback to
  9712. ;; `org-open-file'.
  9713. (let* ((option (org-element-property :search-option context))
  9714. (app (org-element-property :application context))
  9715. (dedicated-function
  9716. (org-link-get-parameter
  9717. (if app (concat type "+" app) type)
  9718. :follow)))
  9719. (if dedicated-function
  9720. (funcall dedicated-function
  9721. (concat path
  9722. (and option (concat "::" option))))
  9723. (apply #'org-open-file
  9724. path
  9725. (cond (arg)
  9726. ((equal app "emacs") 'emacs)
  9727. ((equal app "sys") 'system))
  9728. (cond ((not option) nil)
  9729. ((string-match-p "\\`[0-9]+\\'" option)
  9730. (list (string-to-number option)))
  9731. (t (list nil
  9732. (org-link-unescape option)))))))))
  9733. ((functionp (org-link-get-parameter type :follow))
  9734. (funcall (org-link-get-parameter type :follow) path))
  9735. ((member type '("coderef" "custom-id" "fuzzy" "radio"))
  9736. (unless (run-hook-with-args-until-success
  9737. 'org-open-link-functions path)
  9738. (if (not arg) (org-mark-ring-push)
  9739. (switch-to-buffer-other-window
  9740. (org-get-buffer-for-internal-link (current-buffer))))
  9741. (let ((destination
  9742. (org-with-wide-buffer
  9743. (if (equal type "radio")
  9744. (org-search-radio-target
  9745. (org-element-property :path context))
  9746. (org-link-search
  9747. (if (member type '("custom-id" "coderef"))
  9748. (org-element-property :raw-link context)
  9749. path)
  9750. ;; Prevent fuzzy links from matching
  9751. ;; themselves.
  9752. (and (equal type "fuzzy")
  9753. (+ 2 (org-element-property :begin context)))))
  9754. (point))))
  9755. (unless (and (<= (point-min) destination)
  9756. (>= (point-max) destination))
  9757. (widen))
  9758. (goto-char destination))))
  9759. (t (browse-url-at-point))))))
  9760. ;; On a footnote reference or at a footnote definition's label.
  9761. ((or (eq type 'footnote-reference)
  9762. (and (eq type 'footnote-definition)
  9763. (save-excursion
  9764. ;; Do not validate action when point is on the
  9765. ;; spaces right after the footnote label, in
  9766. ;; order to be on par with behaviour on links.
  9767. (skip-chars-forward " \t")
  9768. (let ((begin
  9769. (org-element-property :contents-begin context)))
  9770. (if begin (< (point) begin)
  9771. (= (org-element-property :post-affiliated context)
  9772. (line-beginning-position)))))))
  9773. (org-footnote-action))
  9774. (t (user-error "No link found")))))
  9775. (run-hook-with-args 'org-follow-link-hook)))
  9776. (defun org-offer-links-in-entry (buffer marker &optional nth zero)
  9777. "Offer links in the current entry and return the selected link.
  9778. If there is only one link, return it.
  9779. If NTH is an integer, return the NTH link found.
  9780. If ZERO is a string, check also this string for a link, and if
  9781. there is one, return it."
  9782. (with-current-buffer buffer
  9783. (org-with-wide-buffer
  9784. (goto-char marker)
  9785. (let ((cnt ?0)
  9786. have-zero end links link c)
  9787. (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
  9788. (push (match-string 0 zero) links)
  9789. (setq cnt (1- cnt) have-zero t))
  9790. (save-excursion
  9791. (org-back-to-heading t)
  9792. (setq end (save-excursion (outline-next-heading) (point)))
  9793. (while (re-search-forward org-any-link-re end t)
  9794. (push (match-string 0) links))
  9795. (setq links (org-uniquify (reverse links))))
  9796. (cond
  9797. ((null links)
  9798. (message "No links"))
  9799. ((equal (length links) 1)
  9800. (setq link (car links)))
  9801. ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
  9802. (setq link (nth (if have-zero nth (1- nth)) links)))
  9803. (t ; we have to select a link
  9804. (save-excursion
  9805. (save-window-excursion
  9806. (delete-other-windows)
  9807. (with-output-to-temp-buffer "*Select Link*"
  9808. (dolist (l links)
  9809. (cond
  9810. ((not (string-match org-bracket-link-regexp l))
  9811. (princ (format "[%c] %s\n" (cl-incf cnt)
  9812. (org-unbracket-string "<" ">" l))))
  9813. ((match-end 3)
  9814. (princ (format "[%c] %s (%s)\n" (cl-incf cnt)
  9815. (match-string 3 l) (match-string 1 l))))
  9816. (t (princ (format "[%c] %s\n" (cl-incf cnt)
  9817. (match-string 1 l)))))))
  9818. (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
  9819. (message "Select link to open, RET to open all:")
  9820. (setq c (read-char-exclusive))
  9821. (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
  9822. (when (equal c ?q) (user-error "Abort"))
  9823. (if (equal c ?\C-m)
  9824. (setq link links)
  9825. (setq nth (- c ?0))
  9826. (when have-zero (setq nth (1+ nth)))
  9827. (unless (and (integerp nth) (>= (length links) nth))
  9828. (user-error "Invalid link selection"))
  9829. (setq link (nth (1- nth) links)))))
  9830. (cons link end)))))
  9831. ;; TODO: These functions are deprecated since `org-open-at-point'
  9832. ;; hard-codes behaviour for "file+emacs" and "file+sys" types.
  9833. (defun org-open-file-with-system (path)
  9834. "Open file at PATH using the system way of opening it."
  9835. (org-open-file path 'system))
  9836. (defun org-open-file-with-emacs (path)
  9837. "Open file at PATH in Emacs."
  9838. (org-open-file path 'emacs))
  9839. ;;; File search
  9840. (defvar org-create-file-search-functions nil
  9841. "List of functions to construct the right search string for a file link.
  9842. These functions are called in turn with point at the location to
  9843. which the link should point.
  9844. A function in the hook should first test if it would like to
  9845. handle this file type, for example by checking the `major-mode'
  9846. or the file extension. If it decides not to handle this file, it
  9847. should just return nil to give other functions a chance. If it
  9848. does handle the file, it must return the search string to be used
  9849. when following the link. The search string will be part of the
  9850. file link, given after a double colon, and `org-open-at-point'
  9851. will automatically search for it. If special measures must be
  9852. taken to make the search successful, another function should be
  9853. added to the companion hook `org-execute-file-search-functions',
  9854. which see.
  9855. A function in this hook may also use `setq' to set the variable
  9856. `description' to provide a suggestion for the descriptive text to
  9857. be used for this link when it gets inserted into an Org buffer
  9858. with \\[org-insert-link].")
  9859. (defvar org-execute-file-search-functions nil
  9860. "List of functions to execute a file search triggered by a link.
  9861. Functions added to this hook must accept a single argument, the
  9862. search string that was part of the file link, the part after the
  9863. double colon. The function must first check if it would like to
  9864. handle this search, for example by checking the `major-mode' or
  9865. the file extension. If it decides not to handle this search, it
  9866. should just return nil to give other functions a chance. If it
  9867. does handle the search, it must return a non-nil value to keep
  9868. other functions from trying.
  9869. Each function can access the current prefix argument through the
  9870. variable `current-prefix-arg'. Note that a single prefix is used
  9871. to force opening a link in Emacs, so it may be good to only use a
  9872. numeric or double prefix to guide the search function.
  9873. In case this is needed, a function in this hook can also restore
  9874. the window configuration before `org-open-at-point' was called using:
  9875. (set-window-configuration org-window-config-before-follow-link)")
  9876. (defun org-search-radio-target (target)
  9877. "Search a radio target matching TARGET in current buffer.
  9878. White spaces are not significant."
  9879. (let ((re (format "<<<%s>>>"
  9880. (mapconcat #'regexp-quote
  9881. (org-split-string target "[ \t\n]+")
  9882. "[ \t]+\\(?:\n[ \t]*\\)?")))
  9883. (origin (point)))
  9884. (goto-char (point-min))
  9885. (catch :radio-match
  9886. (while (re-search-forward re nil t)
  9887. (backward-char)
  9888. (let ((object (org-element-context)))
  9889. (when (eq (org-element-type object) 'radio-target)
  9890. (goto-char (org-element-property :begin object))
  9891. (org-show-context 'link-search)
  9892. (throw :radio-match nil))))
  9893. (goto-char origin)
  9894. (user-error "No match for radio target: %s" target))))
  9895. (defun org-link-search (s &optional avoid-pos stealth)
  9896. "Search for a search string S.
  9897. If S starts with \"#\", it triggers a custom ID search.
  9898. If S is enclosed within parenthesis, it initiates a coderef
  9899. search.
  9900. If S is surrounded by forward slashes, it is interpreted as
  9901. a regular expression. In Org mode files, this will create an
  9902. `org-occur' sparse tree. In ordinary files, `occur' will be used
  9903. to list matches. If the current buffer is in `dired-mode', grep
  9904. will be used to search in all files.
  9905. When AVOID-POS is given, ignore matches near that position.
  9906. When optional argument STEALTH is non-nil, do not modify
  9907. visibility around point, thus ignoring `org-show-context-detail'
  9908. variable.
  9909. Search is case-insensitive and ignores white spaces. Return type
  9910. of matched result, which is either `dedicated' or `fuzzy'."
  9911. (unless (org-string-nw-p s) (error "Invalid search string \"%s\"" s))
  9912. (let* ((case-fold-search t)
  9913. (origin (point))
  9914. (normalized (replace-regexp-in-string "\n[ \t]*" " " s))
  9915. (starred (eq (string-to-char normalized) ?*))
  9916. (words (split-string (if starred (substring s 1) s)))
  9917. (s-multi-re (mapconcat #'regexp-quote words "[ \t]+\\(?:\n[ \t]*\\)?"))
  9918. (s-single-re (mapconcat #'regexp-quote words "[ \t]+"))
  9919. type)
  9920. (cond
  9921. ;; Check if there are any special search functions.
  9922. ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
  9923. ((eq (string-to-char s) ?#)
  9924. ;; Look for a custom ID S if S starts with "#".
  9925. (let* ((id (substring normalized 1))
  9926. (match (org-find-property "CUSTOM_ID" id)))
  9927. (if match (progn (goto-char match) (setf type 'dedicated))
  9928. (error "No match for custom ID: %s" id))))
  9929. ((string-match "\\`(\\(.*\\))\\'" normalized)
  9930. ;; Look for coderef targets if S is enclosed within parenthesis.
  9931. (let ((coderef (match-string-no-properties 1 normalized))
  9932. (re (substring s-single-re 1 -1)))
  9933. (goto-char (point-min))
  9934. (catch :coderef-match
  9935. (while (re-search-forward re nil t)
  9936. (let ((element (org-element-at-point)))
  9937. (when (and (memq (org-element-type element)
  9938. '(example-block src-block))
  9939. ;; Build proper regexp according to current
  9940. ;; block's label format.
  9941. (let ((label-fmt
  9942. (regexp-quote
  9943. (or (org-element-property :label-fmt element)
  9944. org-coderef-label-format))))
  9945. (save-excursion
  9946. (beginning-of-line)
  9947. (looking-at (format ".*?\\(%s\\)[ \t]*$"
  9948. (format label-fmt coderef))))))
  9949. (setq type 'dedicated)
  9950. (goto-char (match-beginning 1))
  9951. (throw :coderef-match nil))))
  9952. (goto-char origin)
  9953. (error "No match for coderef: %s" coderef))))
  9954. ((string-match "\\`/\\(.*\\)/\\'" normalized)
  9955. ;; Look for a regular expression.
  9956. (funcall (if (derived-mode-p 'org-mode) #'org-occur #'org-do-occur)
  9957. (match-string 1 s)))
  9958. ;; From here, we handle fuzzy links.
  9959. ;;
  9960. ;; Look for targets, only if not in a headline search.
  9961. ((and (not starred)
  9962. (let ((target (format "<<%s>>" s-multi-re)))
  9963. (catch :target-match
  9964. (goto-char (point-min))
  9965. (while (re-search-forward target nil t)
  9966. (backward-char)
  9967. (let ((context (org-element-context)))
  9968. (when (eq (org-element-type context) 'target)
  9969. (setq type 'dedicated)
  9970. (goto-char (org-element-property :begin context))
  9971. (throw :target-match t))))
  9972. nil))))
  9973. ;; Look for elements named after S, only if not in a headline
  9974. ;; search.
  9975. ((and (not starred)
  9976. (let ((name (format "^[ \t]*#\\+NAME: +%s[ \t]*$" s-single-re)))
  9977. (catch :name-match
  9978. (goto-char (point-min))
  9979. (while (re-search-forward name nil t)
  9980. (let ((element (org-element-at-point)))
  9981. (when (equal words
  9982. (split-string
  9983. (org-element-property :name element)))
  9984. (setq type 'dedicated)
  9985. (beginning-of-line)
  9986. (throw :name-match t))))
  9987. nil))))
  9988. ;; Regular text search. Prefer headlines in Org mode buffers.
  9989. ;; Ignore COMMENT keyword, TODO keywords, priority cookies,
  9990. ;; statistics cookies and tags.
  9991. ((and (derived-mode-p 'org-mode)
  9992. (let ((title-re
  9993. (format "%s.*\\(?:%s[ \t]\\)?.*%s"
  9994. org-outline-regexp-bol
  9995. org-comment-string
  9996. (mapconcat #'regexp-quote words ".+")))
  9997. (cookie-re "\\[[0-9]*\\(?:%\\|/[0-9]*\\)\\]")
  9998. (comment-re (format "\\`%s[ \t]+" org-comment-string)))
  9999. (goto-char (point-min))
  10000. (catch :found
  10001. (while (re-search-forward title-re nil t)
  10002. (when (equal words
  10003. (split-string
  10004. (replace-regexp-in-string
  10005. cookie-re ""
  10006. (replace-regexp-in-string
  10007. comment-re "" (org-get-heading t t)))))
  10008. (throw :found t)))
  10009. nil)))
  10010. (beginning-of-line)
  10011. (setq type 'dedicated))
  10012. ;; Offer to create non-existent headline depending on
  10013. ;; `org-link-search-must-match-exact-headline'.
  10014. ((and (derived-mode-p 'org-mode)
  10015. (not org-link-search-inhibit-query)
  10016. (eq org-link-search-must-match-exact-headline 'query-to-create)
  10017. (yes-or-no-p "No match - create this as a new heading? "))
  10018. (goto-char (point-max))
  10019. (unless (bolp) (newline))
  10020. (org-insert-heading nil t t)
  10021. (insert s "\n")
  10022. (beginning-of-line 0))
  10023. ;; Only headlines are looked after. No need to process
  10024. ;; further: throw an error.
  10025. ((and (derived-mode-p 'org-mode)
  10026. (or starred org-link-search-must-match-exact-headline))
  10027. (goto-char origin)
  10028. (error "No match for fuzzy expression: %s" normalized))
  10029. ;; Regular text search.
  10030. ((catch :fuzzy-match
  10031. (goto-char (point-min))
  10032. (while (re-search-forward s-multi-re nil t)
  10033. ;; Skip match if it contains AVOID-POS or it is included in
  10034. ;; a link with a description but outside the description.
  10035. (unless (or (and avoid-pos
  10036. (<= (match-beginning 0) avoid-pos)
  10037. (> (match-end 0) avoid-pos))
  10038. (and (save-match-data
  10039. (org-in-regexp org-bracket-link-regexp))
  10040. (match-beginning 3)
  10041. (or (> (match-beginning 3) (point))
  10042. (<= (match-end 3) (point)))
  10043. (org-element-lineage
  10044. (save-match-data (org-element-context))
  10045. '(link) t)))
  10046. (goto-char (match-beginning 0))
  10047. (setq type 'fuzzy)
  10048. (throw :fuzzy-match t)))
  10049. nil))
  10050. ;; All failed. Throw an error.
  10051. (t (goto-char origin)
  10052. (error "No match for fuzzy expression: %s" normalized)))
  10053. ;; Disclose surroundings of match, if appropriate.
  10054. (when (and (derived-mode-p 'org-mode) (not stealth))
  10055. (org-show-context 'link-search))
  10056. type))
  10057. (defun org-get-buffer-for-internal-link (buffer)
  10058. "Return a buffer to be used for displaying the link target of internal links."
  10059. (cond
  10060. ((not org-display-internal-link-with-indirect-buffer)
  10061. buffer)
  10062. ((string-suffix-p "(Clone)" (buffer-name buffer))
  10063. (message "Buffer is already a clone, not making another one")
  10064. ;; we also do not modify visibility in this case
  10065. buffer)
  10066. (t ; make a new indirect buffer for displaying the link
  10067. (let* ((bn (buffer-name buffer))
  10068. (ibn (concat bn "(Clone)"))
  10069. (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
  10070. (with-current-buffer ib (org-overview))
  10071. ib))))
  10072. (defun org-do-occur (regexp &optional cleanup)
  10073. "Call the Emacs command `occur'.
  10074. If CLEANUP is non-nil, remove the printout of the regular expression
  10075. in the *Occur* buffer. This is useful if the regex is long and not useful
  10076. to read."
  10077. (occur regexp)
  10078. (when cleanup
  10079. (let ((cwin (selected-window)) win beg end)
  10080. (when (setq win (get-buffer-window "*Occur*"))
  10081. (select-window win))
  10082. (goto-char (point-min))
  10083. (when (re-search-forward "match[a-z]+" nil t)
  10084. (setq beg (match-end 0))
  10085. (when (re-search-forward "^[ \t]*[0-9]+" nil t)
  10086. (setq end (1- (match-beginning 0)))))
  10087. (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
  10088. (goto-char (point-min))
  10089. (select-window cwin))))
  10090. ;;; The mark ring for links jumps
  10091. (defvar org-mark-ring nil
  10092. "Mark ring for positions before jumps in Org mode.")
  10093. (defvar org-mark-ring-last-goto nil
  10094. "Last position in the mark ring used to go back.")
  10095. ;; Fill and close the ring
  10096. (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
  10097. (dotimes (_ org-mark-ring-length)
  10098. (push (make-marker) org-mark-ring))
  10099. (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
  10100. org-mark-ring)
  10101. (defun org-mark-ring-push (&optional pos buffer)
  10102. "Put the current position or POS into the mark ring and rotate it."
  10103. (interactive)
  10104. (setq pos (or pos (point)))
  10105. (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
  10106. (move-marker (car org-mark-ring)
  10107. (or pos (point))
  10108. (or buffer (current-buffer)))
  10109. (message "%s"
  10110. (substitute-command-keys
  10111. "Position saved to mark ring, go back with \
  10112. `\\[org-mark-ring-goto]'.")))
  10113. (defun org-mark-ring-goto (&optional n)
  10114. "Jump to the previous position in the mark ring.
  10115. With prefix arg N, jump back that many stored positions. When
  10116. called several times in succession, walk through the entire ring.
  10117. Org mode commands jumping to a different position in the current file,
  10118. or to another Org file, automatically push the old position onto the ring."
  10119. (interactive "p")
  10120. (let (p m)
  10121. (if (eq last-command this-command)
  10122. (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
  10123. (setq p org-mark-ring))
  10124. (setq org-mark-ring-last-goto p)
  10125. (setq m (car p))
  10126. (pop-to-buffer-same-window (marker-buffer m))
  10127. (goto-char m)
  10128. (when (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
  10129. (defun org-add-angle-brackets (s)
  10130. (unless (equal (substring s 0 1) "<") (setq s (concat "<" s)))
  10131. (unless (equal (substring s -1) ">") (setq s (concat s ">")))
  10132. s)
  10133. ;;; Following specific links
  10134. (defvar org-agenda-buffer-tmp-name)
  10135. (defvar org-agenda-start-on-weekday)
  10136. (defun org-follow-timestamp-link ()
  10137. "Open an agenda view for the time-stamp date/range at point."
  10138. (cond
  10139. ((org-at-date-range-p t)
  10140. (let ((org-agenda-start-on-weekday)
  10141. (t1 (match-string 1))
  10142. (t2 (match-string 2)) tt1 tt2)
  10143. (setq tt1 (time-to-days (org-time-string-to-time t1))
  10144. tt2 (time-to-days (org-time-string-to-time t2)))
  10145. (let ((org-agenda-buffer-tmp-name
  10146. (format "*Org Agenda(a:%s)"
  10147. (concat (substring t1 0 10) "--" (substring t2 0 10)))))
  10148. (org-agenda-list nil tt1 (1+ (- tt2 tt1))))))
  10149. ((org-at-timestamp-p t)
  10150. (let ((org-agenda-buffer-tmp-name
  10151. (format "*Org Agenda(a:%s)" (substring (match-string 1) 0 10))))
  10152. (org-agenda-list nil (time-to-days (org-time-string-to-time
  10153. (substring (match-string 1) 0 10)))
  10154. 1)))
  10155. (t (error "This should not happen"))))
  10156. ;;; Following file links
  10157. (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
  10158. (declare-function mailcap-extension-to-mime "mailcap" (extn))
  10159. (declare-function mailcap-mime-info
  10160. "mailcap" (string &optional request no-decode))
  10161. (defvar org-wait nil)
  10162. (defun org-open-file (path &optional in-emacs line search)
  10163. "Open the file at PATH.
  10164. First, this expands any special file name abbreviations. Then the
  10165. configuration variable `org-file-apps' is checked if it contains an
  10166. entry for this file type, and if yes, the corresponding command is launched.
  10167. If no application is found, Emacs simply visits the file.
  10168. With optional prefix argument IN-EMACS, Emacs will visit the file.
  10169. With a double \\[universal-argument] \\[universal-argument] \
  10170. prefix arg, Org tries to avoid opening in Emacs
  10171. and to use an external application to visit the file.
  10172. Optional LINE specifies a line to go to, optional SEARCH a string
  10173. to search for. If LINE or SEARCH is given, the file will be
  10174. opened in Emacs, unless an entry from org-file-apps that makes
  10175. use of groups in a regexp matches.
  10176. If you want to change the way frames are used when following a
  10177. link, please customize `org-link-frame-setup'.
  10178. If the file does not exist, an error is thrown."
  10179. (let* ((file (if (equal path "")
  10180. buffer-file-name
  10181. (substitute-in-file-name (expand-file-name path))))
  10182. (file-apps (append org-file-apps (org-default-apps)))
  10183. (apps (cl-remove-if
  10184. 'org-file-apps-entry-match-against-dlink-p file-apps))
  10185. (apps-dlink (cl-remove-if-not
  10186. 'org-file-apps-entry-match-against-dlink-p file-apps))
  10187. (remp (and (assq 'remote apps) (org-file-remote-p file)))
  10188. (dirp (unless remp (file-directory-p file)))
  10189. (file (if (and dirp org-open-directory-means-index-dot-org)
  10190. (concat (file-name-as-directory file) "index.org")
  10191. file))
  10192. (a-m-a-p (assq 'auto-mode apps))
  10193. (dfile (downcase file))
  10194. ;; Reconstruct the original link from the PATH, LINE and
  10195. ;; SEARCH args.
  10196. (link (cond (line (concat file "::" (number-to-string line)))
  10197. (search (concat file "::" search))
  10198. (t file)))
  10199. (dlink (downcase link))
  10200. (ext
  10201. (and (string-match "\\`.*?\\.\\([a-zA-Z0-9]+\\(\\.gz\\)?\\)\\'" dfile)
  10202. (match-string 1 dfile)))
  10203. (save-position-maybe
  10204. (let ((old-buffer (current-buffer))
  10205. (old-pos (point))
  10206. (old-mode major-mode))
  10207. (lambda ()
  10208. (and (derived-mode-p 'org-mode)
  10209. (eq old-mode 'org-mode)
  10210. (or (not (eq old-buffer (current-buffer)))
  10211. (not (eq old-pos (point))))
  10212. (org-mark-ring-push old-pos old-buffer)))))
  10213. cmd link-match-data)
  10214. (cond
  10215. ((member in-emacs '((16) system))
  10216. (setq cmd (cdr (assq 'system apps))))
  10217. (in-emacs (setq cmd 'emacs))
  10218. (t
  10219. (setq cmd (or (and remp (cdr (assq 'remote apps)))
  10220. (and dirp (cdr (assq 'directory apps)))
  10221. ;; First, try matching against apps-dlink if we
  10222. ;; get a match here, store the match data for
  10223. ;; later.
  10224. (let ((match (assoc-default dlink apps-dlink
  10225. 'string-match)))
  10226. (if match
  10227. (progn (setq link-match-data (match-data))
  10228. match)
  10229. (progn (setq in-emacs (or in-emacs line search))
  10230. nil))) ; if we have no match in apps-dlink,
  10231. ; always open the file in emacs if line or search
  10232. ; is given (for backwards compatibility)
  10233. (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
  10234. 'string-match)
  10235. (cdr (assoc ext apps))
  10236. (cdr (assq t apps))))))
  10237. (when (eq cmd 'system)
  10238. (setq cmd (cdr (assq 'system apps))))
  10239. (when (eq cmd 'default)
  10240. (setq cmd (cdr (assoc t apps))))
  10241. (when (eq cmd 'mailcap)
  10242. (require 'mailcap)
  10243. (mailcap-parse-mailcaps)
  10244. (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
  10245. (command (mailcap-mime-info mime-type)))
  10246. (if (stringp command)
  10247. (setq cmd command)
  10248. (setq cmd 'emacs))))
  10249. (when (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
  10250. (not (file-exists-p file))
  10251. (not org-open-non-existing-files))
  10252. (user-error "No such file: %s" file))
  10253. (cond
  10254. ((and (stringp cmd) (not (string-match "^\\s-*$" cmd)))
  10255. ;; Remove quotes around the file name - we'll use shell-quote-argument.
  10256. (while (string-match "['\"]%s['\"]" cmd)
  10257. (setq cmd (replace-match "%s" t t cmd)))
  10258. (setq cmd (replace-regexp-in-string
  10259. "%s"
  10260. (shell-quote-argument (convert-standard-filename file))
  10261. cmd
  10262. nil t))
  10263. ;; Replace "%1", "%2" etc. in command with group matches from regex
  10264. (save-match-data
  10265. (let ((match-index 1)
  10266. (number-of-groups (- (/ (length link-match-data) 2) 1)))
  10267. (set-match-data link-match-data)
  10268. (while (<= match-index number-of-groups)
  10269. (let ((regex (concat "%" (number-to-string match-index)))
  10270. (replace-with (match-string match-index dlink)))
  10271. (while (string-match regex cmd)
  10272. (setq cmd (replace-match replace-with t t cmd))))
  10273. (setq match-index (+ match-index 1)))))
  10274. (save-window-excursion
  10275. (message "Running %s...done" cmd)
  10276. (start-process-shell-command cmd nil cmd)
  10277. (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))))
  10278. ((or (stringp cmd)
  10279. (eq cmd 'emacs))
  10280. (funcall (cdr (assq 'file org-link-frame-setup)) file)
  10281. (widen)
  10282. (cond (line (org-goto-line line)
  10283. (when (derived-mode-p 'org-mode) (org-reveal)))
  10284. (search (condition-case err
  10285. (org-link-search search)
  10286. ;; Save position before error-ing out so user
  10287. ;; can easily move back to the original buffer.
  10288. (error (funcall save-position-maybe)
  10289. (error (nth 1 err)))))))
  10290. ((functionp cmd)
  10291. (save-match-data
  10292. (set-match-data link-match-data)
  10293. (condition-case nil
  10294. (funcall cmd file link)
  10295. ;; FIXME: Remove this check when most default installations
  10296. ;; of Emacs have at least Org 9.0.
  10297. ((debug wrong-number-of-arguments wrong-type-argument
  10298. invalid-function)
  10299. (user-error "Please see Org News for version 9.0 about \
  10300. `org-file-apps'--Lisp error: %S" cmd)))))
  10301. ((consp cmd)
  10302. ;; FIXME: Remove this check when most default installations of
  10303. ;; Emacs have at least Org 9.0. Heads-up instead of silently
  10304. ;; fall back to `org-link-frame-setup' for an old usage of
  10305. ;; `org-file-apps' with sexp instead of a function for `cmd'.
  10306. (user-error "Please see Org News for version 9.0 about \
  10307. `org-file-apps'--Error: Deprecated usage of %S" cmd))
  10308. (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
  10309. (funcall save-position-maybe)))
  10310. (defun org-file-apps-entry-match-against-dlink-p (entry)
  10311. "This function returns non-nil if `entry' uses a regular
  10312. expression which should be matched against the whole link by
  10313. org-open-file.
  10314. It assumes that is the case when the entry uses a regular
  10315. expression which has at least one grouping construct and the
  10316. action is either a lisp form or a command string containing
  10317. `%1', i.e. using at least one subexpression match as a
  10318. parameter."
  10319. (let ((selector (car entry))
  10320. (action (cdr entry)))
  10321. (if (stringp selector)
  10322. (and (> (regexp-opt-depth selector) 0)
  10323. (or (and (stringp action)
  10324. (string-match "%[0-9]" action))
  10325. (consp action)))
  10326. nil)))
  10327. (defun org-default-apps ()
  10328. "Return the default applications for this operating system."
  10329. (cond
  10330. ((eq system-type 'darwin)
  10331. org-file-apps-defaults-macosx)
  10332. ((eq system-type 'windows-nt)
  10333. org-file-apps-defaults-windowsnt)
  10334. (t org-file-apps-defaults-gnu)))
  10335. (defun org-apps-regexp-alist (list &optional add-auto-mode)
  10336. "Convert extensions to regular expressions in the cars of LIST.
  10337. Also, weed out any non-string entries, because the return value is used
  10338. only for regexp matching.
  10339. When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
  10340. point to the symbol `emacs', indicating that the file should
  10341. be opened in Emacs."
  10342. (append
  10343. (delq nil
  10344. (mapcar (lambda (x)
  10345. (unless (not (stringp (car x)))
  10346. (if (string-match "\\W" (car x))
  10347. x
  10348. (cons (concat "\\." (car x) "\\'") (cdr x)))))
  10349. list))
  10350. (when add-auto-mode
  10351. (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
  10352. (defvar ange-ftp-name-format)
  10353. (defun org-file-remote-p (file)
  10354. "Test whether FILE specifies a location on a remote system.
  10355. Return non-nil if the location is indeed remote.
  10356. For example, the filename \"/user@host:/foo\" specifies a location
  10357. on the system \"/user@host:\"."
  10358. (cond ((fboundp 'file-remote-p)
  10359. (file-remote-p file))
  10360. ((fboundp 'tramp-handle-file-remote-p)
  10361. (tramp-handle-file-remote-p file))
  10362. ((and (boundp 'ange-ftp-name-format)
  10363. (string-match (car ange-ftp-name-format) file))
  10364. t)))
  10365. ;;;; Refiling
  10366. (defun org-get-org-file ()
  10367. "Read a filename, with default directory `org-directory'."
  10368. (let ((default (or org-default-notes-file remember-data-file)))
  10369. (read-file-name (format "File name [%s]: " default)
  10370. (file-name-as-directory org-directory)
  10371. default)))
  10372. (defun org-notes-order-reversed-p ()
  10373. "Check if the current file should receive notes in reversed order."
  10374. (cond
  10375. ((not org-reverse-note-order) nil)
  10376. ((eq t org-reverse-note-order) t)
  10377. ((not (listp org-reverse-note-order)) nil)
  10378. (t (catch 'exit
  10379. (dolist (entry org-reverse-note-order)
  10380. (when (string-match (car entry) buffer-file-name)
  10381. (throw 'exit (cdr entry))))))))
  10382. (defvar org-refile-target-table nil
  10383. "The list of refile targets, created by `org-refile'.")
  10384. (defvar org-agenda-new-buffers nil
  10385. "Buffers created to visit agenda files.")
  10386. (defvar org-refile-cache nil
  10387. "Cache for refile targets.")
  10388. (defvar org-refile-markers nil
  10389. "All the markers used for caching refile locations.")
  10390. (defun org-refile-marker (pos)
  10391. "Get a new refile marker, but only if caching is in use."
  10392. (if (not org-refile-use-cache)
  10393. pos
  10394. (let ((m (make-marker)))
  10395. (move-marker m pos)
  10396. (push m org-refile-markers)
  10397. m)))
  10398. (defun org-refile-cache-clear ()
  10399. "Clear the refile cache and disable all the markers."
  10400. (dolist (m org-refile-markers) (move-marker m nil))
  10401. (setq org-refile-markers nil)
  10402. (setq org-refile-cache nil)
  10403. (message "Refile cache has been cleared"))
  10404. (defun org-refile-cache-check-set (set)
  10405. "Check if all the markers in the cache still have live buffers."
  10406. (let (marker)
  10407. (catch 'exit
  10408. (while (and set (setq marker (nth 3 (pop set))))
  10409. ;; If `org-refile-use-outline-path' is 'file, marker may be nil
  10410. (when (and marker (null (marker-buffer marker)))
  10411. (message "Please regenerate the refile cache with `C-0 C-c C-w'")
  10412. (sit-for 3)
  10413. (throw 'exit nil)))
  10414. t)))
  10415. (defun org-refile-cache-put (set &rest identifiers)
  10416. "Push the refile targets SET into the cache, under IDENTIFIERS."
  10417. (let* ((key (sha1 (prin1-to-string identifiers)))
  10418. (entry (assoc key org-refile-cache)))
  10419. (if entry
  10420. (setcdr entry set)
  10421. (push (cons key set) org-refile-cache))))
  10422. (defun org-refile-cache-get (&rest identifiers)
  10423. "Retrieve the cached value for refile targets given by IDENTIFIERS."
  10424. (cond
  10425. ((not org-refile-cache) nil)
  10426. ((not org-refile-use-cache) (org-refile-cache-clear) nil)
  10427. (t
  10428. (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
  10429. org-refile-cache))))
  10430. (and set (org-refile-cache-check-set set) set)))))
  10431. (defvar org-outline-path-cache nil
  10432. "Alist between buffer positions and outline paths.
  10433. It value is an alist (POSITION . PATH) where POSITION is the
  10434. buffer position at the beginning of an entry and PATH is a list
  10435. of strings describing the outline path for that entry, in reverse
  10436. order.")
  10437. (defun org-refile-get-targets (&optional default-buffer)
  10438. "Produce a table with refile targets."
  10439. (let ((case-fold-search nil)
  10440. ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
  10441. (entries (or org-refile-targets '((nil . (:level . 1)))))
  10442. targets tgs files desc descre)
  10443. (message "Getting targets...")
  10444. (with-current-buffer (or default-buffer (current-buffer))
  10445. (dolist (entry entries)
  10446. (setq files (car entry) desc (cdr entry))
  10447. (cond
  10448. ((null files) (setq files (list (current-buffer))))
  10449. ((eq files 'org-agenda-files)
  10450. (setq files (org-agenda-files 'unrestricted)))
  10451. ((and (symbolp files) (fboundp files))
  10452. (setq files (funcall files)))
  10453. ((and (symbolp files) (boundp files))
  10454. (setq files (symbol-value files))))
  10455. (when (stringp files) (setq files (list files)))
  10456. (cond
  10457. ((eq (car desc) :tag)
  10458. (setq descre (concat "^\\*+[ \t]+.*?:" (regexp-quote (cdr desc)) ":")))
  10459. ((eq (car desc) :todo)
  10460. (setq descre (concat "^\\*+[ \t]+" (regexp-quote (cdr desc)) "[ \t]")))
  10461. ((eq (car desc) :regexp)
  10462. (setq descre (cdr desc)))
  10463. ((eq (car desc) :level)
  10464. (setq descre (concat "^\\*\\{" (number-to-string
  10465. (if org-odd-levels-only
  10466. (1- (* 2 (cdr desc)))
  10467. (cdr desc)))
  10468. "\\}[ \t]")))
  10469. ((eq (car desc) :maxlevel)
  10470. (setq descre (concat "^\\*\\{1," (number-to-string
  10471. (if org-odd-levels-only
  10472. (1- (* 2 (cdr desc)))
  10473. (cdr desc)))
  10474. "\\}[ \t]")))
  10475. (t (error "Bad refiling target description %s" desc)))
  10476. (dolist (f files)
  10477. (with-current-buffer (if (bufferp f) f (org-get-agenda-file-buffer f))
  10478. (or
  10479. (setq tgs (org-refile-cache-get (buffer-file-name) descre))
  10480. (progn
  10481. (when (bufferp f)
  10482. (setq f (buffer-file-name (buffer-base-buffer f))))
  10483. (setq f (and f (expand-file-name f)))
  10484. (when (eq org-refile-use-outline-path 'file)
  10485. (push (list (file-name-nondirectory f) f nil nil) tgs))
  10486. (org-with-wide-buffer
  10487. (goto-char (point-min))
  10488. (setq org-outline-path-cache nil)
  10489. (while (re-search-forward descre nil t)
  10490. (beginning-of-line)
  10491. (let ((case-fold-search nil))
  10492. (looking-at org-complex-heading-regexp))
  10493. (let ((begin (point))
  10494. (heading (match-string-no-properties 4)))
  10495. (unless (or (and
  10496. org-refile-target-verify-function
  10497. (not
  10498. (funcall org-refile-target-verify-function)))
  10499. (not heading))
  10500. (let ((re (format org-complex-heading-regexp-format
  10501. (regexp-quote heading)))
  10502. (target
  10503. (if (not org-refile-use-outline-path) heading
  10504. (mapconcat
  10505. #'org-protect-slash
  10506. (append
  10507. (pcase org-refile-use-outline-path
  10508. (`file (list (file-name-nondirectory
  10509. (buffer-file-name
  10510. (buffer-base-buffer)))))
  10511. (`full-file-path
  10512. (list (buffer-file-name
  10513. (buffer-base-buffer))))
  10514. (_ nil))
  10515. (org-get-outline-path t t))
  10516. "/"))))
  10517. (push (list target f re (org-refile-marker (point)))
  10518. tgs)))
  10519. (when (= (point) begin)
  10520. ;; Verification function has not moved point.
  10521. (end-of-line)))))))
  10522. (when org-refile-use-cache
  10523. (org-refile-cache-put tgs (buffer-file-name) descre))
  10524. (setq targets (append tgs targets))))))
  10525. (message "Getting targets...done")
  10526. (nreverse targets)))
  10527. (defun org-protect-slash (s)
  10528. (replace-regexp-in-string "/" "\\/" s nil t))
  10529. (defun org--get-outline-path-1 (&optional use-cache)
  10530. "Return outline path to current headline.
  10531. Outline path is a list of strings, in reverse order. When
  10532. optional argument USE-CACHE is non-nil, make use of a cache. See
  10533. `org-get-outline-path' for details.
  10534. Assume buffer is widened and point is on a headline."
  10535. (or (and use-cache (cdr (assq (point) org-outline-path-cache)))
  10536. (let ((p (point))
  10537. (heading (let ((case-fold-search nil))
  10538. (looking-at org-complex-heading-regexp)
  10539. (if (not (match-end 4)) ""
  10540. ;; Remove statistics cookies.
  10541. (org-trim
  10542. (org-link-display-format
  10543. (replace-regexp-in-string
  10544. "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" ""
  10545. (match-string-no-properties 4))))))))
  10546. (if (org-up-heading-safe)
  10547. (let ((path (cons heading (org--get-outline-path-1 use-cache))))
  10548. (when use-cache
  10549. (push (cons p path) org-outline-path-cache))
  10550. path)
  10551. ;; This is a new root node. Since we assume we are moving
  10552. ;; forward, we can drop previous cache so as to limit number
  10553. ;; of associations there.
  10554. (let ((path (list heading)))
  10555. (when use-cache (setq org-outline-path-cache (list (cons p path))))
  10556. path)))))
  10557. (defun org-get-outline-path (&optional with-self use-cache)
  10558. "Return the outline path to the current entry.
  10559. An outline path is a list of ancestors for current headline, as
  10560. a list of strings. Statistics cookies are removed and links are
  10561. replaced with their description, if any, or their path otherwise.
  10562. When optional argument WITH-SELF is non-nil, the path also
  10563. includes the current headline.
  10564. When optional argument USE-CACHE is non-nil, cache outline paths
  10565. between calls to this function so as to avoid backtracking. This
  10566. argument is useful when planning to find more than one outline
  10567. path in the same document. In that case, there are two
  10568. conditions to satisfy:
  10569. - `org-outline-path-cache' is set to nil before starting the
  10570. process;
  10571. - outline paths are computed by increasing buffer positions."
  10572. (org-with-wide-buffer
  10573. (and (or (and with-self (org-back-to-heading t))
  10574. (org-up-heading-safe))
  10575. (reverse (org--get-outline-path-1 use-cache)))))
  10576. (defun org-format-outline-path (path &optional width prefix separator)
  10577. "Format the outline path PATH for display.
  10578. WIDTH is the maximum number of characters that is available.
  10579. PREFIX is a prefix to be included in the returned string,
  10580. such as the file name.
  10581. SEPARATOR is inserted between the different parts of the path,
  10582. the default is \"/\"."
  10583. (setq width (or width 79))
  10584. (setq path (delq nil path))
  10585. (unless (> width 0)
  10586. (user-error "Argument `width' must be positive"))
  10587. (setq separator (or separator "/"))
  10588. (let* ((org-odd-levels-only nil)
  10589. (fpath (concat
  10590. prefix (and prefix path separator)
  10591. (mapconcat
  10592. (lambda (s) (replace-regexp-in-string "[ \t]+\\'" "" s))
  10593. (cl-loop for head in path
  10594. for n from 0
  10595. collect (org-add-props
  10596. head nil 'face
  10597. (nth (% n org-n-level-faces) org-level-faces)))
  10598. separator))))
  10599. (when (> (length fpath) width)
  10600. (if (< width 7)
  10601. ;; It's unlikely that `width' will be this small, but don't
  10602. ;; waste characters by adding ".." if it is.
  10603. (setq fpath (substring fpath 0 width))
  10604. (setf (substring fpath (- width 2)) "..")))
  10605. fpath))
  10606. (defun org-display-outline-path (&optional file current separator just-return-string)
  10607. "Display the current outline path in the echo area.
  10608. If FILE is non-nil, prepend the output with the file name.
  10609. If CURRENT is non-nil, append the current heading to the output.
  10610. SEPARATOR is passed through to `org-format-outline-path'. It separates
  10611. the different parts of the path and defaults to \"/\".
  10612. If JUST-RETURN-STRING is non-nil, return a string, don't display a message."
  10613. (interactive "P")
  10614. (let* (case-fold-search
  10615. (bfn (buffer-file-name (buffer-base-buffer)))
  10616. (path (and (derived-mode-p 'org-mode) (org-get-outline-path)))
  10617. res)
  10618. (when current (setq path (append path
  10619. (save-excursion
  10620. (org-back-to-heading t)
  10621. (when (looking-at org-complex-heading-regexp)
  10622. (list (match-string 4)))))))
  10623. (setq res
  10624. (org-format-outline-path
  10625. path
  10626. (1- (frame-width))
  10627. (and file bfn (concat (file-name-nondirectory bfn) separator))
  10628. separator))
  10629. (if just-return-string
  10630. (org-no-properties res)
  10631. (org-unlogged-message "%s" res))))
  10632. (defvar org-refile-history nil
  10633. "History for refiling operations.")
  10634. (defvar org-after-refile-insert-hook nil
  10635. "Hook run after `org-refile' has inserted its stuff at the new location.
  10636. Note that this is still *before* the stuff will be removed from
  10637. the *old* location.")
  10638. (defvar org-capture-last-stored-marker)
  10639. (defvar org-refile-keep nil
  10640. "Non-nil means `org-refile' will copy instead of refile.")
  10641. (defun org-copy ()
  10642. "Like `org-refile', but copy."
  10643. (interactive)
  10644. (let ((org-refile-keep t))
  10645. (funcall 'org-refile nil nil nil "Copy")))
  10646. (defun org-refile (&optional arg default-buffer rfloc msg)
  10647. "Move the entry or entries at point to another heading.
  10648. The list of target headings is compiled using the information in
  10649. `org-refile-targets', which see.
  10650. At the target location, the entry is filed as a subitem of the
  10651. target heading. Depending on `org-reverse-note-order', the new
  10652. subitem will either be the first or the last subitem.
  10653. If there is an active region, all entries in that region will be
  10654. refiled. However, the region must fulfill the requirement that
  10655. the first heading sets the top-level of the moved text.
  10656. With a `\\[universal-argument]' ARG, the command will only visit the target \
  10657. location
  10658. and not actually move anything.
  10659. With a prefix `\\[universal-argument] \\[universal-argument]', go to the \
  10660. location where the last
  10661. refiling operation has put the subtree.
  10662. With a numeric prefix argument of `2', refile to the running clock.
  10663. With a numeric prefix argument of `3', emulate `org-refile-keep'
  10664. being set to t and copy to the target location, don't move it.
  10665. Beware that keeping refiled entries may result in duplicated ID
  10666. properties.
  10667. RFLOC can be a refile location obtained in a different way.
  10668. MSG is a string to replace \"Refile\" in the default prompt with
  10669. another verb. E.g. `org-copy' sets this parameter to \"Copy\".
  10670. See also `org-refile-use-outline-path'.
  10671. If you are using target caching (see `org-refile-use-cache'), you
  10672. have to clear the target cache in order to find new targets.
  10673. This can be done with a `0' prefix (`C-0 C-c C-w') or a triple
  10674. prefix argument (`C-u C-u C-u C-c C-w')."
  10675. (interactive "P")
  10676. (if (member arg '(0 (64)))
  10677. (org-refile-cache-clear)
  10678. (let* ((actionmsg (cond (msg msg)
  10679. ((equal arg 3) "Refile (and keep)")
  10680. (t "Refile")))
  10681. (regionp (org-region-active-p))
  10682. (region-start (and regionp (region-beginning)))
  10683. (region-end (and regionp (region-end)))
  10684. (org-refile-keep (if (equal arg 3) t org-refile-keep))
  10685. pos it nbuf file level reversed)
  10686. (setq last-command nil)
  10687. (when regionp
  10688. (goto-char region-start)
  10689. (or (bolp) (goto-char (point-at-bol)))
  10690. (setq region-start (point))
  10691. (unless (or (org-kill-is-subtree-p
  10692. (buffer-substring region-start region-end))
  10693. (prog1 org-refile-active-region-within-subtree
  10694. (let ((s (point-at-eol)))
  10695. (org-toggle-heading)
  10696. (setq region-end (+ (- (point-at-eol) s) region-end)))))
  10697. (user-error "The region is not a (sequence of) subtree(s)")))
  10698. (if (equal arg '(16))
  10699. (org-refile-goto-last-stored)
  10700. (when (or
  10701. (and (equal arg 2)
  10702. org-clock-hd-marker (marker-buffer org-clock-hd-marker)
  10703. (prog1
  10704. (setq it (list (or org-clock-heading "running clock")
  10705. (buffer-file-name
  10706. (marker-buffer org-clock-hd-marker))
  10707. ""
  10708. (marker-position org-clock-hd-marker)))
  10709. (setq arg nil)))
  10710. (setq it
  10711. (or rfloc
  10712. (let (heading-text)
  10713. (save-excursion
  10714. (unless (and arg (listp arg))
  10715. (org-back-to-heading t)
  10716. (setq heading-text
  10717. (replace-regexp-in-string
  10718. org-bracket-link-regexp
  10719. "\\3"
  10720. (or (nth 4 (org-heading-components))
  10721. ""))))
  10722. (org-refile-get-location
  10723. (cond ((and arg (listp arg)) "Goto")
  10724. (regionp (concat actionmsg " region to"))
  10725. (t (concat actionmsg " subtree \""
  10726. heading-text "\" to")))
  10727. default-buffer
  10728. (and (not (equal '(4) arg))
  10729. org-refile-allow-creating-parent-nodes)))))))
  10730. (setq file (nth 1 it)
  10731. pos (nth 3 it))
  10732. (when (and (not arg)
  10733. pos
  10734. (equal (buffer-file-name) file)
  10735. (if regionp
  10736. (and (>= pos region-start)
  10737. (<= pos region-end))
  10738. (and (>= pos (point))
  10739. (< pos (save-excursion
  10740. (org-end-of-subtree t t))))))
  10741. (error "Cannot refile to position inside the tree or region"))
  10742. (setq nbuf (or (find-buffer-visiting file)
  10743. (find-file-noselect file)))
  10744. (if (and arg (not (equal arg 3)))
  10745. (progn
  10746. (pop-to-buffer-same-window nbuf)
  10747. (goto-char pos)
  10748. (org-show-context 'org-goto))
  10749. (if regionp
  10750. (progn
  10751. (org-kill-new (buffer-substring region-start region-end))
  10752. (org-save-markers-in-region region-start region-end))
  10753. (org-copy-subtree 1 nil t))
  10754. (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
  10755. (find-file-noselect file)))
  10756. (setq reversed (org-notes-order-reversed-p))
  10757. (org-with-wide-buffer
  10758. (if pos
  10759. (progn
  10760. (goto-char pos)
  10761. (setq level (org-get-valid-level (funcall outline-level) 1))
  10762. (goto-char
  10763. (if reversed
  10764. (or (outline-next-heading) (point-max))
  10765. (or (save-excursion (org-get-next-sibling))
  10766. (org-end-of-subtree t t)
  10767. (point-max)))))
  10768. (setq level 1)
  10769. (if (not reversed)
  10770. (goto-char (point-max))
  10771. (goto-char (point-min))
  10772. (or (outline-next-heading) (goto-char (point-max)))))
  10773. (unless (bolp) (newline))
  10774. (org-paste-subtree level nil nil t)
  10775. (when org-log-refile
  10776. (org-add-log-setup 'refile nil nil org-log-refile)
  10777. (unless (eq org-log-refile 'note)
  10778. (save-excursion (org-add-log-note))))
  10779. (and org-auto-align-tags
  10780. (let ((org-loop-over-headlines-in-active-region nil))
  10781. (org-set-tags nil t)))
  10782. (let ((bookmark-name (plist-get org-bookmark-names-plist
  10783. :last-refile)))
  10784. (when bookmark-name
  10785. (with-demoted-errors
  10786. (bookmark-set bookmark-name))))
  10787. ;; If we are refiling for capture, make sure that the
  10788. ;; last-capture pointers point here
  10789. (when (bound-and-true-p org-capture-is-refiling)
  10790. (let ((bookmark-name (plist-get org-bookmark-names-plist
  10791. :last-capture-marker)))
  10792. (when bookmark-name
  10793. (with-demoted-errors
  10794. (bookmark-set bookmark-name))))
  10795. (move-marker org-capture-last-stored-marker (point)))
  10796. (when (fboundp 'deactivate-mark) (deactivate-mark))
  10797. (run-hooks 'org-after-refile-insert-hook)))
  10798. (unless org-refile-keep
  10799. (if regionp
  10800. (delete-region (point) (+ (point) (- region-end region-start)))
  10801. (delete-region
  10802. (and (org-back-to-heading t) (point))
  10803. (min (1+ (buffer-size)) (org-end-of-subtree t t) (point)))))
  10804. (when (featurep 'org-inlinetask)
  10805. (org-inlinetask-remove-END-maybe))
  10806. (setq org-markers-to-move nil)
  10807. (message (concat actionmsg " to \"%s\" in file %s: done") (car it) file)))))))
  10808. (defun org-refile-goto-last-stored ()
  10809. "Go to the location where the last refile was stored."
  10810. (interactive)
  10811. (bookmark-jump (plist-get org-bookmark-names-plist :last-refile))
  10812. (message "This is the location of the last refile"))
  10813. (defun org-refile--get-location (refloc tbl)
  10814. "When user refile to REFLOC, find the associated target in TBL.
  10815. Also check `org-refile-target-table'."
  10816. (car (delq
  10817. nil
  10818. (mapcar
  10819. (lambda (r) (or (assoc r tbl)
  10820. (assoc r org-refile-target-table)))
  10821. (list (replace-regexp-in-string "/$" "" refloc)
  10822. (replace-regexp-in-string "\\([^/]\\)$" "\\1/" refloc))))))
  10823. (defun org-refile-get-location (&optional prompt default-buffer new-nodes)
  10824. "Prompt the user for a refile location, using PROMPT.
  10825. PROMPT should not be suffixed with a colon and a space, because
  10826. this function appends the default value from
  10827. `org-refile-history' automatically, if that is not empty."
  10828. (let ((org-refile-targets org-refile-targets)
  10829. (org-refile-use-outline-path org-refile-use-outline-path))
  10830. (setq org-refile-target-table (org-refile-get-targets default-buffer)))
  10831. (unless org-refile-target-table
  10832. (user-error "No refile targets"))
  10833. (let* ((cbuf (current-buffer))
  10834. (cfn (buffer-file-name (buffer-base-buffer cbuf)))
  10835. (cfunc (if (and org-refile-use-outline-path
  10836. org-outline-path-complete-in-steps)
  10837. #'org-olpath-completing-read
  10838. #'completing-read))
  10839. (extra (if org-refile-use-outline-path "/" ""))
  10840. (cbnex (concat (buffer-name) extra))
  10841. (filename (and cfn (expand-file-name cfn)))
  10842. (tbl (mapcar
  10843. (lambda (x)
  10844. (if (and (not (member org-refile-use-outline-path
  10845. '(file full-file-path)))
  10846. (not (equal filename (nth 1 x))))
  10847. (cons (concat (car x) extra " ("
  10848. (file-name-nondirectory (nth 1 x)) ")")
  10849. (cdr x))
  10850. (cons (concat (car x) extra) (cdr x))))
  10851. org-refile-target-table))
  10852. (completion-ignore-case t)
  10853. cdef
  10854. (prompt (concat prompt
  10855. (or (and (car org-refile-history)
  10856. (concat " (default " (car org-refile-history) ")"))
  10857. (and (assoc cbnex tbl) (setq cdef cbnex)
  10858. (concat " (default " cbnex ")"))) ": "))
  10859. pa answ parent-target child parent old-hist)
  10860. (setq old-hist org-refile-history)
  10861. (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
  10862. nil 'org-refile-history (or cdef (car org-refile-history))))
  10863. (if (setq pa (org-refile--get-location answ tbl))
  10864. (progn
  10865. (org-refile-check-position pa)
  10866. (when (or (not org-refile-history)
  10867. (not (eq old-hist org-refile-history))
  10868. (not (equal (car pa) (car org-refile-history))))
  10869. (setq org-refile-history
  10870. (cons (car pa) (if (assoc (car org-refile-history) tbl)
  10871. org-refile-history
  10872. (cdr org-refile-history))))
  10873. (when (equal (car org-refile-history) (nth 1 org-refile-history))
  10874. (pop org-refile-history)))
  10875. pa)
  10876. (if (string-match "\\`\\(.*\\)/\\([^/]+\\)\\'" answ)
  10877. (progn
  10878. (setq parent (match-string 1 answ)
  10879. child (match-string 2 answ))
  10880. (setq parent-target (org-refile--get-location parent tbl))
  10881. (when (and parent-target
  10882. (or (eq new-nodes t)
  10883. (and (eq new-nodes 'confirm)
  10884. (y-or-n-p (format "Create new node \"%s\"? "
  10885. child)))))
  10886. (org-refile-new-child parent-target child)))
  10887. (user-error "Invalid target location")))))
  10888. (declare-function org-string-nw-p "org-macs" (s))
  10889. (defun org-refile-check-position (refile-pointer)
  10890. "Check if the refile pointer matches the headline to which it points."
  10891. (let* ((file (nth 1 refile-pointer))
  10892. (re (nth 2 refile-pointer))
  10893. (pos (nth 3 refile-pointer))
  10894. buffer)
  10895. (if (and (not (markerp pos)) (not file))
  10896. (user-error "Please indicate a target file in the refile path")
  10897. (when (org-string-nw-p re)
  10898. (setq buffer (if (markerp pos)
  10899. (marker-buffer pos)
  10900. (or (find-buffer-visiting file)
  10901. (find-file-noselect file))))
  10902. (with-current-buffer buffer
  10903. (org-with-wide-buffer
  10904. (goto-char pos)
  10905. (beginning-of-line 1)
  10906. (unless (looking-at-p re)
  10907. (user-error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling"))))))))
  10908. (defun org-refile-new-child (parent-target child)
  10909. "Use refile target PARENT-TARGET to add new CHILD below it."
  10910. (unless parent-target
  10911. (error "Cannot find parent for new node"))
  10912. (let ((file (nth 1 parent-target))
  10913. (pos (nth 3 parent-target))
  10914. level)
  10915. (with-current-buffer (or (find-buffer-visiting file)
  10916. (find-file-noselect file))
  10917. (org-with-wide-buffer
  10918. (if pos
  10919. (goto-char pos)
  10920. (goto-char (point-max))
  10921. (unless (bolp) (newline)))
  10922. (when (looking-at org-outline-regexp)
  10923. (setq level (funcall outline-level))
  10924. (org-end-of-subtree t t))
  10925. (org-back-over-empty-lines)
  10926. (insert "\n" (make-string
  10927. (if pos (org-get-valid-level level 1) 1) ?*)
  10928. " " child "\n")
  10929. (beginning-of-line 0)
  10930. (list (concat (car parent-target) "/" child) file "" (point))))))
  10931. (defun org-olpath-completing-read (prompt collection &rest args)
  10932. "Read an outline path like a file name."
  10933. (let ((thetable collection))
  10934. (apply #'completing-read
  10935. prompt
  10936. (lambda (string predicate &optional flag)
  10937. (cond
  10938. ((eq flag nil) (try-completion string thetable))
  10939. ((eq flag t)
  10940. (let ((l (length string)))
  10941. (mapcar (lambda (x)
  10942. (let ((r (substring x l))
  10943. (f (if (string-match " ([^)]*)$" x)
  10944. (match-string 0 x)
  10945. "")))
  10946. (if (string-match "/" r)
  10947. (concat string (substring r 0 (match-end 0)) f)
  10948. x)))
  10949. (all-completions string thetable predicate))))
  10950. ;; Exact match?
  10951. ((eq flag 'lambda) (assoc string thetable))))
  10952. args)))
  10953. ;;;; Dynamic blocks
  10954. (defun org-find-dblock (name)
  10955. "Find the first dynamic block with name NAME in the buffer.
  10956. If not found, stay at current position and return nil."
  10957. (let ((case-fold-search t) pos)
  10958. (save-excursion
  10959. (goto-char (point-min))
  10960. (setq pos (and (re-search-forward
  10961. (concat "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+" name "\\>") nil t)
  10962. (match-beginning 0))))
  10963. (when pos (goto-char pos))
  10964. pos))
  10965. (defun org-create-dblock (plist)
  10966. "Create a dynamic block section, with parameters taken from PLIST.
  10967. PLIST must contain a :name entry which is used as the name of the block."
  10968. (when (string-match "\\S-" (buffer-substring (point-at-bol) (point-at-eol)))
  10969. (end-of-line 1)
  10970. (newline))
  10971. (let ((col (current-column))
  10972. (name (plist-get plist :name)))
  10973. (insert "#+BEGIN: " name)
  10974. (while plist
  10975. (if (eq (car plist) :name)
  10976. (setq plist (cddr plist))
  10977. (insert " " (prin1-to-string (pop plist)))))
  10978. (insert "\n\n" (make-string col ?\ ) "#+END:\n")
  10979. (beginning-of-line -2)))
  10980. (defun org-prepare-dblock ()
  10981. "Prepare dynamic block for refresh.
  10982. This empties the block, puts the cursor at the insert position and returns
  10983. the property list including an extra property :name with the block name."
  10984. (unless (looking-at org-dblock-start-re)
  10985. (user-error "Not at a dynamic block"))
  10986. (let* ((begdel (1+ (match-end 0)))
  10987. (name (org-no-properties (match-string 1)))
  10988. (params (append (list :name name)
  10989. (read (concat "(" (match-string 3) ")")))))
  10990. (save-excursion
  10991. (beginning-of-line 1)
  10992. (skip-chars-forward " \t")
  10993. (setq params (plist-put params :indentation-column (current-column))))
  10994. (unless (re-search-forward org-dblock-end-re nil t)
  10995. (error "Dynamic block not terminated"))
  10996. (setq params
  10997. (append params
  10998. (list :content (buffer-substring
  10999. begdel (match-beginning 0)))))
  11000. (delete-region begdel (match-beginning 0))
  11001. (goto-char begdel)
  11002. (open-line 1)
  11003. params))
  11004. (defun org-map-dblocks (&optional command)
  11005. "Apply COMMAND to all dynamic blocks in the current buffer.
  11006. If COMMAND is not given, use `org-update-dblock'."
  11007. (let ((cmd (or command 'org-update-dblock)))
  11008. (save-excursion
  11009. (goto-char (point-min))
  11010. (while (re-search-forward org-dblock-start-re nil t)
  11011. (goto-char (match-beginning 0))
  11012. (save-excursion
  11013. (condition-case nil
  11014. (funcall cmd)
  11015. (error (message "Error during update of dynamic block"))))
  11016. (unless (re-search-forward org-dblock-end-re nil t)
  11017. (error "Dynamic block not terminated"))))))
  11018. (defun org-dblock-update (&optional arg)
  11019. "User command for updating dynamic blocks.
  11020. Update the dynamic block at point. With prefix ARG, update all dynamic
  11021. blocks in the buffer."
  11022. (interactive "P")
  11023. (if arg
  11024. (org-update-all-dblocks)
  11025. (or (looking-at org-dblock-start-re)
  11026. (org-beginning-of-dblock))
  11027. (org-update-dblock)))
  11028. (defun org-update-dblock ()
  11029. "Update the dynamic block at point.
  11030. This means to empty the block, parse for parameters and then call
  11031. the correct writing function."
  11032. (interactive)
  11033. (save-excursion
  11034. (let* ((win (selected-window))
  11035. (pos (point))
  11036. (line (org-current-line))
  11037. (params (org-prepare-dblock))
  11038. (name (plist-get params :name))
  11039. (indent (plist-get params :indentation-column))
  11040. (cmd (intern (concat "org-dblock-write:" name))))
  11041. (message "Updating dynamic block `%s' at line %d..." name line)
  11042. (funcall cmd params)
  11043. (message "Updating dynamic block `%s' at line %d...done" name line)
  11044. (goto-char pos)
  11045. (when (and indent (> indent 0))
  11046. (setq indent (make-string indent ?\ ))
  11047. (save-excursion
  11048. (select-window win)
  11049. (org-beginning-of-dblock)
  11050. (forward-line 1)
  11051. (while (not (looking-at org-dblock-end-re))
  11052. (insert indent)
  11053. (beginning-of-line 2))
  11054. (when (looking-at org-dblock-end-re)
  11055. (and (looking-at "[ \t]+")
  11056. (replace-match ""))
  11057. (insert indent)))))))
  11058. (defun org-beginning-of-dblock ()
  11059. "Find the beginning of the dynamic block at point.
  11060. Error if there is no such block at point."
  11061. (let ((pos (point))
  11062. beg)
  11063. (end-of-line 1)
  11064. (if (and (re-search-backward org-dblock-start-re nil t)
  11065. (setq beg (match-beginning 0))
  11066. (re-search-forward org-dblock-end-re nil t)
  11067. (> (match-end 0) pos))
  11068. (goto-char beg)
  11069. (goto-char pos)
  11070. (error "Not in a dynamic block"))))
  11071. (defun org-update-all-dblocks ()
  11072. "Update all dynamic blocks in the buffer.
  11073. This function can be used in a hook."
  11074. (interactive)
  11075. (when (derived-mode-p 'org-mode)
  11076. (org-map-dblocks 'org-update-dblock)))
  11077. ;;;; Completion
  11078. (declare-function org-export-backend-options "ox" (cl-x) t)
  11079. (defun org-get-export-keywords ()
  11080. "Return a list of all currently understood export keywords.
  11081. Export keywords include options, block names, attributes and
  11082. keywords relative to each registered export back-end."
  11083. (let (keywords)
  11084. (dolist (backend
  11085. (bound-and-true-p org-export-registered-backends)
  11086. (delq nil keywords))
  11087. ;; Back-end name (for keywords, like #+LATEX:)
  11088. (push (upcase (symbol-name (org-export-backend-name backend))) keywords)
  11089. (dolist (option-entry (org-export-backend-options backend))
  11090. ;; Back-end options.
  11091. (push (nth 1 option-entry) keywords)))))
  11092. (defconst org-options-keywords
  11093. '("ARCHIVE:" "AUTHOR:" "BIND:" "CATEGORY:" "COLUMNS:" "CREATOR:" "DATE:"
  11094. "DESCRIPTION:" "DRAWERS:" "EMAIL:" "EXCLUDE_TAGS:" "FILETAGS:" "INCLUDE:"
  11095. "INDEX:" "KEYWORDS:" "LANGUAGE:" "MACRO:" "OPTIONS:" "PROPERTY:"
  11096. "PRIORITIES:" "SELECT_TAGS:" "SEQ_TODO:" "SETUPFILE:" "STARTUP:" "TAGS:"
  11097. "TITLE:" "TODO:" "TYP_TODO:" "SELECT_TAGS:" "EXCLUDE_TAGS:"))
  11098. (defcustom org-structure-template-alist
  11099. '(("s" "#+BEGIN_SRC ?\n\n#+END_SRC")
  11100. ("e" "#+BEGIN_EXAMPLE\n?\n#+END_EXAMPLE")
  11101. ("q" "#+BEGIN_QUOTE\n?\n#+END_QUOTE")
  11102. ("v" "#+BEGIN_VERSE\n?\n#+END_VERSE")
  11103. ("V" "#+BEGIN_VERBATIM\n?\n#+END_VERBATIM")
  11104. ("c" "#+BEGIN_CENTER\n?\n#+END_CENTER")
  11105. ("l" "#+BEGIN_EXPORT latex\n?\n#+END_EXPORT")
  11106. ("L" "#+LaTeX: ")
  11107. ("h" "#+BEGIN_EXPORT html\n?\n#+END_EXPORT")
  11108. ("H" "#+HTML: ")
  11109. ("a" "#+BEGIN_EXPORT ascii\n?\n#+END_EXPORT")
  11110. ("A" "#+ASCII: ")
  11111. ("i" "#+INDEX: ?")
  11112. ("I" "#+INCLUDE: %file ?"))
  11113. "Structure completion elements.
  11114. This is a list of abbreviation keys and values. The value gets inserted
  11115. if you type `<' followed by the key and then press the completion key,
  11116. usually `TAB'. %file will be replaced by a file name after prompting
  11117. for the file using completion. The cursor will be placed at the position
  11118. of the `?' in the template.
  11119. There are two templates for each key, the first uses the original Org syntax,
  11120. the second uses Emacs Muse-like syntax tags. These Muse-like tags become
  11121. the default when the /org-mtags.el/ module has been loaded. See also the
  11122. variable `org-mtags-prefer-muse-templates'."
  11123. :group 'org-completion
  11124. :type '(repeat
  11125. (list
  11126. (string :tag "Key")
  11127. (string :tag "Template")))
  11128. :version "25.2"
  11129. :package-version '(Org . "8.3"))
  11130. (defun org-try-structure-completion ()
  11131. "Try to complete a structure template before point.
  11132. This looks for strings like \"<e\" on an otherwise empty line and
  11133. expands them."
  11134. (let ((l (buffer-substring (point-at-bol) (point)))
  11135. a)
  11136. (when (and (looking-at "[ \t]*$")
  11137. (string-match "^[ \t]*<\\([a-zA-Z]+\\)$" l)
  11138. (setq a (assoc (match-string 1 l) org-structure-template-alist)))
  11139. (org-complete-expand-structure-template (+ -1 (point-at-bol)
  11140. (match-beginning 1)) a)
  11141. t)))
  11142. (defun org-complete-expand-structure-template (start cell)
  11143. "Expand a structure template."
  11144. (let ((rpl (nth 1 cell))
  11145. (ind ""))
  11146. (delete-region start (point))
  11147. (when (string-match "\\`[ \t]*#\\+" rpl)
  11148. (cond
  11149. ((bolp))
  11150. ((not (string-match "\\S-" (buffer-substring (point-at-bol) (point))))
  11151. (setq ind (buffer-substring (point-at-bol) (point))))
  11152. (t (newline))))
  11153. (setq start (point))
  11154. (when (string-match "%file" rpl)
  11155. (setq rpl (replace-match
  11156. (concat
  11157. "\""
  11158. (save-match-data
  11159. (abbreviate-file-name (read-file-name "Include file: ")))
  11160. "\"")
  11161. t t rpl)))
  11162. (setq rpl (mapconcat 'identity (split-string rpl "\n")
  11163. (concat "\n" ind)))
  11164. (insert rpl)
  11165. (when (re-search-backward "\\?" start t) (delete-char 1))))
  11166. ;;;; TODO, DEADLINE, Comments
  11167. (defun org-toggle-comment ()
  11168. "Change the COMMENT state of an entry."
  11169. (interactive)
  11170. (save-excursion
  11171. (org-back-to-heading)
  11172. (let ((case-fold-search nil))
  11173. (looking-at org-complex-heading-regexp))
  11174. (goto-char (or (match-end 3) (match-end 2) (match-end 1)))
  11175. (skip-chars-forward " \t")
  11176. (unless (memq (char-before) '(?\s ?\t)) (insert " "))
  11177. (if (org-in-commented-heading-p t)
  11178. (delete-region (point)
  11179. (progn (search-forward " " (line-end-position) 'move)
  11180. (skip-chars-forward " \t")
  11181. (point)))
  11182. (insert org-comment-string)
  11183. (unless (eolp) (insert " ")))))
  11184. (defvar org-last-todo-state-is-todo nil
  11185. "This is non-nil when the last TODO state change led to a TODO state.
  11186. If the last change removed the TODO tag or switched to DONE, then
  11187. this is nil.")
  11188. (defvar org-setting-tags nil) ; dynamically skipped
  11189. (defvar org-todo-setup-filter-hook nil
  11190. "Hook for functions that pre-filter todo specs.
  11191. Each function takes a todo spec and returns either nil or the spec
  11192. transformed into canonical form." )
  11193. (defvar org-todo-get-default-hook nil
  11194. "Hook for functions that get a default item for todo.
  11195. Each function takes arguments (NEW-MARK OLD-MARK) and returns either
  11196. nil or a string to be used for the todo mark." )
  11197. (defvar org-agenda-headline-snapshot-before-repeat)
  11198. (defun org-current-effective-time ()
  11199. "Return current time adjusted for `org-extend-today-until' variable."
  11200. (let* ((ct (org-current-time))
  11201. (dct (decode-time ct))
  11202. (ct1
  11203. (cond
  11204. (org-use-last-clock-out-time-as-effective-time
  11205. (or (org-clock-get-last-clock-out-time) ct))
  11206. ((and org-use-effective-time (< (nth 2 dct) org-extend-today-until))
  11207. (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct)))
  11208. (t ct))))
  11209. ct1))
  11210. (defun org-todo-yesterday (&optional arg)
  11211. "Like `org-todo' but the time of change will be 23:59 of yesterday."
  11212. (interactive "P")
  11213. (if (eq major-mode 'org-agenda-mode)
  11214. (apply 'org-agenda-todo-yesterday arg)
  11215. (let* ((org-use-effective-time t)
  11216. (hour (nth 2 (decode-time (org-current-time))))
  11217. (org-extend-today-until (1+ hour)))
  11218. (org-todo arg))))
  11219. (defvar org-block-entry-blocking ""
  11220. "First entry preventing the TODO state change.")
  11221. (defun org-cancel-repeater ()
  11222. "Cancel a repeater by setting its numeric value to zero."
  11223. (interactive)
  11224. (save-excursion
  11225. (org-back-to-heading t)
  11226. (let ((bound1 (point))
  11227. (bound0 (save-excursion (outline-next-heading) (point))))
  11228. (when (and (re-search-forward
  11229. (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
  11230. org-deadline-time-regexp "\\)\\|\\("
  11231. org-ts-regexp "\\)")
  11232. bound0 t)
  11233. (re-search-backward "[ \t]+\\(?:[.+]\\)?\\+\\([0-9]+\\)[hdwmy]"
  11234. bound1 t))
  11235. (replace-match "0" t nil nil 1)))))
  11236. (defvar org-state) ;; dynamically scoped into this function
  11237. (defun org-todo (&optional arg)
  11238. "Change the TODO state of an item.
  11239. The state of an item is given by a keyword at the start of the heading,
  11240. like
  11241. *** TODO Write paper
  11242. *** DONE Call mom
  11243. The different keywords are specified in the variable `org-todo-keywords'.
  11244. By default the available states are \"TODO\" and \"DONE\". So, for this
  11245. example: when the item starts with TODO, it is changed to DONE.
  11246. When it starts with DONE, the DONE is removed. And when neither TODO nor
  11247. DONE are present, add TODO at the beginning of the heading.
  11248. With `\\[universal-argument]' prefix ARG, use completion to determine the new \
  11249. state.
  11250. With numeric prefix ARG, switch to that state.
  11251. With a `\\[universal-argument] \\[universal-argument]' prefix, switch to the \
  11252. next set of TODO \
  11253. keywords (nextset).
  11254. With a `\\[universal-argument] \\[universal-argument] \\[universal-argument]' \
  11255. prefix, circumvent any state blocking.
  11256. With a numeric prefix arg of 0, inhibit note taking for the change.
  11257. With a numeric prefix arg of -1, cancel repeater to allow marking as DONE.
  11258. When called through ELisp, arg is also interpreted in the following way:
  11259. `none' -> empty state
  11260. \"\" -> switch to empty state
  11261. `done' -> switch to DONE
  11262. `nextset' -> switch to the next set of keywords
  11263. `previousset' -> switch to the previous set of keywords
  11264. \"WAITING\" -> switch to the specified keyword, but only if it
  11265. really is a member of `org-todo-keywords'."
  11266. (interactive "P")
  11267. (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
  11268. (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
  11269. 'region-start-level 'region))
  11270. org-loop-over-headlines-in-active-region)
  11271. (org-map-entries
  11272. `(org-todo ,arg)
  11273. org-loop-over-headlines-in-active-region
  11274. cl (when (outline-invisible-p) (org-end-of-subtree nil t))))
  11275. (when (equal arg '(16)) (setq arg 'nextset))
  11276. (when (equal arg -1) (org-cancel-repeater) (setq arg nil))
  11277. (let ((org-blocker-hook org-blocker-hook)
  11278. commentp
  11279. case-fold-search)
  11280. (when (equal arg '(64))
  11281. (setq arg nil org-blocker-hook nil))
  11282. (when (and org-blocker-hook
  11283. (or org-inhibit-blocking
  11284. (org-entry-get nil "NOBLOCKING")))
  11285. (setq org-blocker-hook nil))
  11286. (save-excursion
  11287. (catch 'exit
  11288. (org-back-to-heading t)
  11289. (when (org-in-commented-heading-p t)
  11290. (org-toggle-comment)
  11291. (setq commentp t))
  11292. (when (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
  11293. (or (looking-at (concat " +" org-todo-regexp "\\( +\\|[ \t]*$\\)"))
  11294. (looking-at "\\(?: *\\|[ \t]*$\\)"))
  11295. (let* ((match-data (match-data))
  11296. (startpos (point-at-bol))
  11297. (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
  11298. (org-log-done org-log-done)
  11299. (org-log-repeat org-log-repeat)
  11300. (org-todo-log-states org-todo-log-states)
  11301. (org-inhibit-logging
  11302. (if (equal arg 0)
  11303. (progn (setq arg nil) 'note) org-inhibit-logging))
  11304. (this (match-string 1))
  11305. (hl-pos (match-beginning 0))
  11306. (head (org-get-todo-sequence-head this))
  11307. (ass (assoc head org-todo-kwd-alist))
  11308. (interpret (nth 1 ass))
  11309. (done-word (nth 3 ass))
  11310. (final-done-word (nth 4 ass))
  11311. (org-last-state (or this ""))
  11312. (completion-ignore-case t)
  11313. (member (member this org-todo-keywords-1))
  11314. (tail (cdr member))
  11315. (org-state (cond
  11316. ((and org-todo-key-trigger
  11317. (or (and (equal arg '(4))
  11318. (eq org-use-fast-todo-selection 'prefix))
  11319. (and (not arg) org-use-fast-todo-selection
  11320. (not (eq org-use-fast-todo-selection
  11321. 'prefix)))))
  11322. ;; Use fast selection
  11323. (org-fast-todo-selection))
  11324. ((and (equal arg '(4))
  11325. (or (not org-use-fast-todo-selection)
  11326. (not org-todo-key-trigger)))
  11327. ;; Read a state with completion
  11328. (completing-read
  11329. "State: " (mapcar #'list org-todo-keywords-1)
  11330. nil t))
  11331. ((eq arg 'right)
  11332. (if this
  11333. (if tail (car tail) nil)
  11334. (car org-todo-keywords-1)))
  11335. ((eq arg 'left)
  11336. (unless (equal member org-todo-keywords-1)
  11337. (if this
  11338. (nth (- (length org-todo-keywords-1)
  11339. (length tail) 2)
  11340. org-todo-keywords-1)
  11341. (org-last org-todo-keywords-1))))
  11342. ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
  11343. (setq arg nil))) ; hack to fall back to cycling
  11344. (arg
  11345. ;; user or caller requests a specific state
  11346. (cond
  11347. ((equal arg "") nil)
  11348. ((eq arg 'none) nil)
  11349. ((eq arg 'done) (or done-word (car org-done-keywords)))
  11350. ((eq arg 'nextset)
  11351. (or (car (cdr (member head org-todo-heads)))
  11352. (car org-todo-heads)))
  11353. ((eq arg 'previousset)
  11354. (let ((org-todo-heads (reverse org-todo-heads)))
  11355. (or (car (cdr (member head org-todo-heads)))
  11356. (car org-todo-heads))))
  11357. ((car (member arg org-todo-keywords-1)))
  11358. ((stringp arg)
  11359. (user-error "State `%s' not valid in this file" arg))
  11360. ((nth (1- (prefix-numeric-value arg))
  11361. org-todo-keywords-1))))
  11362. ((null member) (or head (car org-todo-keywords-1)))
  11363. ((equal this final-done-word) nil) ;; -> make empty
  11364. ((null tail) nil) ;; -> first entry
  11365. ((memq interpret '(type priority))
  11366. (if (eq this-command last-command)
  11367. (car tail)
  11368. (if (> (length tail) 0)
  11369. (or done-word (car org-done-keywords))
  11370. nil)))
  11371. (t
  11372. (car tail))))
  11373. (org-state (or
  11374. (run-hook-with-args-until-success
  11375. 'org-todo-get-default-hook org-state org-last-state)
  11376. org-state))
  11377. (next (if org-state (concat " " org-state " ") " "))
  11378. (change-plist (list :type 'todo-state-change :from this :to org-state
  11379. :position startpos))
  11380. dolog now-done-p)
  11381. (when org-blocker-hook
  11382. (setq org-last-todo-state-is-todo
  11383. (not (member this org-done-keywords)))
  11384. (unless (save-excursion
  11385. (save-match-data
  11386. (org-with-wide-buffer
  11387. (run-hook-with-args-until-failure
  11388. 'org-blocker-hook change-plist))))
  11389. (if (called-interactively-p 'interactive)
  11390. (user-error "TODO state change from %s to %s blocked (by \"%s\")"
  11391. this org-state org-block-entry-blocking)
  11392. ;; fail silently
  11393. (message "TODO state change from %s to %s blocked (by \"%s\")"
  11394. this org-state org-block-entry-blocking)
  11395. (throw 'exit nil))))
  11396. (store-match-data match-data)
  11397. (replace-match next t t)
  11398. (cond ((equal this org-state)
  11399. (message "TODO state was already %s" (org-trim next)))
  11400. ((pos-visible-in-window-p hl-pos)
  11401. (message "TODO state changed to %s" (org-trim next))))
  11402. (unless head
  11403. (setq head (org-get-todo-sequence-head org-state)
  11404. ass (assoc head org-todo-kwd-alist)
  11405. interpret (nth 1 ass)
  11406. done-word (nth 3 ass)
  11407. final-done-word (nth 4 ass)))
  11408. (when (memq arg '(nextset previousset))
  11409. (message "Keyword-Set %d/%d: %s"
  11410. (- (length org-todo-sets) -1
  11411. (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
  11412. (length org-todo-sets)
  11413. (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
  11414. (setq org-last-todo-state-is-todo
  11415. (not (member org-state org-done-keywords)))
  11416. (setq now-done-p (and (member org-state org-done-keywords)
  11417. (not (member this org-done-keywords))))
  11418. (and logging (org-local-logging logging))
  11419. (when (and (or org-todo-log-states org-log-done)
  11420. (not (eq org-inhibit-logging t))
  11421. (not (memq arg '(nextset previousset))))
  11422. ;; we need to look at recording a time and note
  11423. (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
  11424. (nth 2 (assoc this org-todo-log-states))))
  11425. (when (and (eq dolog 'note) (eq org-inhibit-logging 'note))
  11426. (setq dolog 'time))
  11427. (when (or (and (not org-state) (not org-closed-keep-when-no-todo))
  11428. (and org-state
  11429. (member org-state org-not-done-keywords)
  11430. (not (member this org-not-done-keywords))))
  11431. ;; This is now a todo state and was not one before
  11432. ;; If there was a CLOSED time stamp, get rid of it.
  11433. (org-add-planning-info nil nil 'closed))
  11434. (when (and now-done-p org-log-done)
  11435. ;; It is now done, and it was not done before
  11436. (org-add-planning-info 'closed (org-current-effective-time))
  11437. (when (and (not dolog) (eq 'note org-log-done))
  11438. (org-add-log-setup 'done org-state this 'note)))
  11439. (when (and org-state dolog)
  11440. ;; This is a non-nil state, and we need to log it
  11441. (org-add-log-setup 'state org-state this dolog)))
  11442. ;; Fixup tag positioning
  11443. (org-todo-trigger-tag-changes org-state)
  11444. (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
  11445. (when org-provide-todo-statistics
  11446. (org-update-parent-todo-statistics))
  11447. (run-hooks 'org-after-todo-state-change-hook)
  11448. (when (and arg (not (member org-state org-done-keywords)))
  11449. (setq head (org-get-todo-sequence-head org-state)))
  11450. (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
  11451. ;; Do we need to trigger a repeat?
  11452. (when now-done-p
  11453. (when (boundp 'org-agenda-headline-snapshot-before-repeat)
  11454. ;; This is for the agenda, take a snapshot of the headline.
  11455. (save-match-data
  11456. (setq org-agenda-headline-snapshot-before-repeat
  11457. (org-get-heading))))
  11458. (org-auto-repeat-maybe org-state))
  11459. ;; Fixup cursor location if close to the keyword
  11460. (when (and (outline-on-heading-p)
  11461. (not (bolp))
  11462. (save-excursion (beginning-of-line 1)
  11463. (looking-at org-todo-line-regexp))
  11464. (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
  11465. (goto-char (or (match-end 2) (match-end 1)))
  11466. (and (looking-at " ") (just-one-space)))
  11467. (when org-trigger-hook
  11468. (save-excursion
  11469. (run-hook-with-args 'org-trigger-hook change-plist)))
  11470. (when commentp (org-toggle-comment))))))))
  11471. (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
  11472. "Block turning an entry into a TODO, using the hierarchy.
  11473. This checks whether the current task should be blocked from state
  11474. changes. Such blocking occurs when:
  11475. 1. The task has children which are not all in a completed state.
  11476. 2. A task has a parent with the property :ORDERED:, and there
  11477. are siblings prior to the current task with incomplete
  11478. status.
  11479. 3. The parent of the task is blocked because it has siblings that should
  11480. be done first, or is child of a block grandparent TODO entry."
  11481. (if (not org-enforce-todo-dependencies)
  11482. t ; if locally turned off don't block
  11483. (catch 'dont-block
  11484. ;; If this is not a todo state change, or if this entry is already DONE,
  11485. ;; do not block
  11486. (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
  11487. (member (plist-get change-plist :from)
  11488. (cons 'done org-done-keywords))
  11489. (member (plist-get change-plist :to)
  11490. (cons 'todo org-not-done-keywords))
  11491. (not (plist-get change-plist :to)))
  11492. (throw 'dont-block t))
  11493. ;; If this task has children, and any are undone, it's blocked
  11494. (save-excursion
  11495. (org-back-to-heading t)
  11496. (let ((this-level (funcall outline-level)))
  11497. (outline-next-heading)
  11498. (let ((child-level (funcall outline-level)))
  11499. (while (and (not (eobp))
  11500. (> child-level this-level))
  11501. ;; this todo has children, check whether they are all
  11502. ;; completed
  11503. (when (and (not (org-entry-is-done-p))
  11504. (org-entry-is-todo-p))
  11505. (setq org-block-entry-blocking (org-get-heading))
  11506. (throw 'dont-block nil))
  11507. (outline-next-heading)
  11508. (setq child-level (funcall outline-level))))))
  11509. ;; Otherwise, if the task's parent has the :ORDERED: property, and
  11510. ;; any previous siblings are undone, it's blocked
  11511. (save-excursion
  11512. (org-back-to-heading t)
  11513. (let* ((pos (point))
  11514. (parent-pos (and (org-up-heading-safe) (point)))
  11515. (case-fold-search nil))
  11516. (unless parent-pos (throw 'dont-block t)) ; no parent
  11517. (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
  11518. (forward-line 1)
  11519. (re-search-forward org-not-done-heading-regexp pos t))
  11520. (setq org-block-entry-blocking (match-string 0))
  11521. (throw 'dont-block nil)) ; block, there is an older sibling not done.
  11522. ;; Search further up the hierarchy, to see if an ancestor is blocked
  11523. (while t
  11524. (goto-char parent-pos)
  11525. (unless (looking-at org-not-done-heading-regexp)
  11526. (throw 'dont-block t)) ; do not block, parent is not a TODO
  11527. (setq pos (point))
  11528. (setq parent-pos (and (org-up-heading-safe) (point)))
  11529. (unless parent-pos (throw 'dont-block t)) ; no parent
  11530. (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
  11531. (forward-line 1)
  11532. (re-search-forward org-not-done-heading-regexp pos t)
  11533. (setq org-block-entry-blocking (org-get-heading)))
  11534. (throw 'dont-block nil)))))))) ; block, older sibling not done.
  11535. (defcustom org-track-ordered-property-with-tag nil
  11536. "Should the ORDERED property also be shown as a tag?
  11537. The ORDERED property decides if an entry should require subtasks to be
  11538. completed in sequence. Since a property is not very visible, setting
  11539. this option means that toggling the ORDERED property with the command
  11540. `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
  11541. not relevant for the behavior, but it makes things more visible.
  11542. Note that toggling the tag with tags commands will not change the property
  11543. and therefore not influence behavior!
  11544. This can be t, meaning the tag ORDERED should be used, It can also be a
  11545. string to select a different tag for this task."
  11546. :group 'org-todo
  11547. :type '(choice
  11548. (const :tag "No tracking" nil)
  11549. (const :tag "Track with ORDERED tag" t)
  11550. (string :tag "Use other tag")))
  11551. (defun org-toggle-ordered-property ()
  11552. "Toggle the ORDERED property of the current entry.
  11553. For better visibility, you can track the value of this property with a tag.
  11554. See variable `org-track-ordered-property-with-tag'."
  11555. (interactive)
  11556. (let* ((t1 org-track-ordered-property-with-tag)
  11557. (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
  11558. (save-excursion
  11559. (org-back-to-heading)
  11560. (if (org-entry-get nil "ORDERED")
  11561. (progn
  11562. (org-delete-property "ORDERED")
  11563. (and tag (org-toggle-tag tag 'off))
  11564. (message "Subtasks can be completed in arbitrary order"))
  11565. (org-entry-put nil "ORDERED" "t")
  11566. (and tag (org-toggle-tag tag 'on))
  11567. (message "Subtasks must be completed in sequence")))))
  11568. (defvar org-blocked-by-checkboxes) ; dynamically scoped
  11569. (defun org-block-todo-from-checkboxes (change-plist)
  11570. "Block turning an entry into a TODO, using checkboxes.
  11571. This checks whether the current task should be blocked from state
  11572. changes because there are unchecked boxes in this entry."
  11573. (if (not org-enforce-todo-checkbox-dependencies)
  11574. t ; if locally turned off don't block
  11575. (catch 'dont-block
  11576. ;; If this is not a todo state change, or if this entry is already DONE,
  11577. ;; do not block
  11578. (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
  11579. (member (plist-get change-plist :from)
  11580. (cons 'done org-done-keywords))
  11581. (member (plist-get change-plist :to)
  11582. (cons 'todo org-not-done-keywords))
  11583. (not (plist-get change-plist :to)))
  11584. (throw 'dont-block t))
  11585. ;; If this task has checkboxes that are not checked, it's blocked
  11586. (save-excursion
  11587. (org-back-to-heading t)
  11588. (let ((beg (point)) end)
  11589. (outline-next-heading)
  11590. (setq end (point))
  11591. (goto-char beg)
  11592. (when (org-list-search-forward
  11593. (concat (org-item-beginning-re)
  11594. "\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?"
  11595. "\\[[- ]\\]")
  11596. end t)
  11597. (when (boundp 'org-blocked-by-checkboxes)
  11598. (setq org-blocked-by-checkboxes t))
  11599. (throw 'dont-block nil))))
  11600. t))) ; do not block
  11601. (defun org-entry-blocked-p ()
  11602. "Non-nil if entry at point is blocked."
  11603. (and (not (org-entry-get nil "NOBLOCKING"))
  11604. (member (org-entry-get nil "TODO") org-not-done-keywords)
  11605. (not (run-hook-with-args-until-failure
  11606. 'org-blocker-hook
  11607. (list :type 'todo-state-change
  11608. :position (point)
  11609. :from 'todo
  11610. :to 'done)))))
  11611. (defun org-update-statistics-cookies (all)
  11612. "Update the statistics cookie, either from TODO or from checkboxes.
  11613. This should be called with the cursor in a line with a statistics
  11614. cookie. When called with a \\[universal-argument] prefix, update
  11615. all statistics cookies in the buffer."
  11616. (interactive "P")
  11617. (if all
  11618. (progn
  11619. (org-update-checkbox-count 'all)
  11620. (org-map-entries 'org-update-parent-todo-statistics))
  11621. (if (not (org-at-heading-p))
  11622. (org-update-checkbox-count)
  11623. (let ((pos (point-marker))
  11624. end l1 l2)
  11625. (ignore-errors (org-back-to-heading t))
  11626. (if (not (org-at-heading-p))
  11627. (org-update-checkbox-count)
  11628. (setq l1 (org-outline-level))
  11629. (setq end (save-excursion
  11630. (outline-next-heading)
  11631. (when (org-at-heading-p) (setq l2 (org-outline-level)))
  11632. (point)))
  11633. (if (and (save-excursion
  11634. (re-search-forward
  11635. "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) \\[[- X]\\]" end t))
  11636. (not (save-excursion (re-search-forward
  11637. ":COOKIE_DATA:.*\\<todo\\>" end t))))
  11638. (org-update-checkbox-count)
  11639. (if (and l2 (> l2 l1))
  11640. (progn
  11641. (goto-char end)
  11642. (org-update-parent-todo-statistics))
  11643. (goto-char pos)
  11644. (beginning-of-line 1)
  11645. (while (re-search-forward
  11646. "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)"
  11647. (point-at-eol) t)
  11648. (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
  11649. (goto-char pos)
  11650. (move-marker pos nil)))))
  11651. (defvar org-entry-property-inherited-from) ;; defined below
  11652. (defun org-update-parent-todo-statistics ()
  11653. "Update any statistics cookie in the parent of the current headline.
  11654. When `org-hierarchical-todo-statistics' is nil, statistics will cover
  11655. the entire subtree and this will travel up the hierarchy and update
  11656. statistics everywhere."
  11657. (let* ((prop (save-excursion (org-up-heading-safe)
  11658. (org-entry-get nil "COOKIE_DATA" 'inherit)))
  11659. (recursive (or (not org-hierarchical-todo-statistics)
  11660. (and prop (string-match "\\<recursive\\>" prop))))
  11661. (lim (or (and prop (marker-position org-entry-property-inherited-from))
  11662. 0))
  11663. (first t)
  11664. (box-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
  11665. level ltoggle l1 new ndel
  11666. (cnt-all 0) (cnt-done 0) is-percent kwd
  11667. checkbox-beg cookie-present)
  11668. (catch 'exit
  11669. (save-excursion
  11670. (beginning-of-line 1)
  11671. (setq ltoggle (funcall outline-level))
  11672. ;; Three situations are to consider:
  11673. ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
  11674. ;; to the top-level ancestor on the headline;
  11675. ;; 2. If parent has "recursive" property, repeat up to the
  11676. ;; headline setting that property, taking inheritance into
  11677. ;; account;
  11678. ;; 3. Else, move up to direct parent and proceed only once.
  11679. (while (and (setq level (org-up-heading-safe))
  11680. (or recursive first)
  11681. (>= (point) lim))
  11682. (setq first nil cookie-present nil)
  11683. (unless (and level
  11684. (not (string-match
  11685. "\\<checkbox\\>"
  11686. (downcase (or (org-entry-get nil "COOKIE_DATA")
  11687. "")))))
  11688. (throw 'exit nil))
  11689. (while (re-search-forward box-re (point-at-eol) t)
  11690. (setq cnt-all 0 cnt-done 0 cookie-present t)
  11691. (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
  11692. (save-match-data
  11693. (unless (outline-next-heading) (throw 'exit nil))
  11694. (while (and (looking-at org-complex-heading-regexp)
  11695. (> (setq l1 (length (match-string 1))) level))
  11696. (setq kwd (and (or recursive (= l1 ltoggle))
  11697. (match-string 2)))
  11698. (if (or (eq org-provide-todo-statistics 'all-headlines)
  11699. (and (eq org-provide-todo-statistics t)
  11700. (or (member kwd org-done-keywords)))
  11701. (and (listp org-provide-todo-statistics)
  11702. (stringp (car org-provide-todo-statistics))
  11703. (or (member kwd org-provide-todo-statistics)
  11704. (member kwd org-done-keywords)))
  11705. (and (listp org-provide-todo-statistics)
  11706. (listp (car org-provide-todo-statistics))
  11707. (or (member kwd (car org-provide-todo-statistics))
  11708. (and (member kwd org-done-keywords)
  11709. (member kwd (cadr org-provide-todo-statistics))))))
  11710. (setq cnt-all (1+ cnt-all))
  11711. (and (eq org-provide-todo-statistics t)
  11712. kwd
  11713. (setq cnt-all (1+ cnt-all))))
  11714. (when (or (and (member org-provide-todo-statistics '(t all-headlines))
  11715. (member kwd org-done-keywords))
  11716. (and (listp org-provide-todo-statistics)
  11717. (listp (car org-provide-todo-statistics))
  11718. (member kwd org-done-keywords)
  11719. (member kwd (cadr org-provide-todo-statistics)))
  11720. (and (listp org-provide-todo-statistics)
  11721. (stringp (car org-provide-todo-statistics))
  11722. (member kwd org-done-keywords)))
  11723. (setq cnt-done (1+ cnt-done)))
  11724. (outline-next-heading)))
  11725. (setq new
  11726. (if is-percent
  11727. (format "[%d%%]" (floor (* 100.0 cnt-done)
  11728. (max 1 cnt-all)))
  11729. (format "[%d/%d]" cnt-done cnt-all))
  11730. ndel (- (match-end 0) checkbox-beg))
  11731. (goto-char checkbox-beg)
  11732. (insert new)
  11733. (delete-region (point) (+ (point) ndel))
  11734. (when org-auto-align-tags (org-fix-tags-on-the-fly)))
  11735. (when cookie-present
  11736. (run-hook-with-args 'org-after-todo-statistics-hook
  11737. cnt-done (- cnt-all cnt-done))))))
  11738. (run-hooks 'org-todo-statistics-hook)))
  11739. (defvar org-after-todo-statistics-hook nil
  11740. "Hook that is called after a TODO statistics cookie has been updated.
  11741. Each function is called with two arguments: the number of not-done entries
  11742. and the number of done entries.
  11743. For example, the following function, when added to this hook, will switch
  11744. an entry to DONE when all children are done, and back to TODO when new
  11745. entries are set to a TODO status. Note that this hook is only called
  11746. when there is a statistics cookie in the headline!
  11747. (defun org-summary-todo (n-done n-not-done)
  11748. \"Switch entry to DONE when all subentries are done, to TODO otherwise.\"
  11749. (let (org-log-done org-log-states) ; turn off logging
  11750. (org-todo (if (= n-not-done 0) \"DONE\" \"TODO\"))))
  11751. ")
  11752. (defvar org-todo-statistics-hook nil
  11753. "Hook that is run whenever Org thinks TODO statistics should be updated.
  11754. This hook runs even if there is no statistics cookie present, in which case
  11755. `org-after-todo-statistics-hook' would not run.")
  11756. (defun org-todo-trigger-tag-changes (state)
  11757. "Apply the changes defined in `org-todo-state-tags-triggers'."
  11758. (let ((l org-todo-state-tags-triggers)
  11759. changes)
  11760. (when (or (not state) (equal state ""))
  11761. (setq changes (append changes (cdr (assoc "" l)))))
  11762. (when (and (stringp state) (> (length state) 0))
  11763. (setq changes (append changes (cdr (assoc state l)))))
  11764. (when (member state org-not-done-keywords)
  11765. (setq changes (append changes (cdr (assq 'todo l)))))
  11766. (when (member state org-done-keywords)
  11767. (setq changes (append changes (cdr (assq 'done l)))))
  11768. (dolist (c changes)
  11769. (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
  11770. (defun org-local-logging (value)
  11771. "Get logging settings from a property VALUE."
  11772. ;; Directly set the variables, they are already local.
  11773. (setq org-log-done nil
  11774. org-log-repeat nil
  11775. org-todo-log-states nil)
  11776. (dolist (w (org-split-string value))
  11777. (let (a)
  11778. (cond
  11779. ((setq a (assoc w org-startup-options))
  11780. (and (member (nth 1 a) '(org-log-done org-log-repeat))
  11781. (set (nth 1 a) (nth 2 a))))
  11782. ((setq a (org-extract-log-state-settings w))
  11783. (and (member (car a) org-todo-keywords-1)
  11784. (push a org-todo-log-states)))))))
  11785. (defun org-get-todo-sequence-head (kwd)
  11786. "Return the head of the TODO sequence to which KWD belongs.
  11787. If KWD is not set, check if there is a text property remembering the
  11788. right sequence."
  11789. (let (p)
  11790. (cond
  11791. ((not kwd)
  11792. (or (get-text-property (point-at-bol) 'org-todo-head)
  11793. (progn
  11794. (setq p (next-single-property-change (point-at-bol) 'org-todo-head
  11795. nil (point-at-eol)))
  11796. (get-text-property p 'org-todo-head))))
  11797. ((not (member kwd org-todo-keywords-1))
  11798. (car org-todo-keywords-1))
  11799. (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
  11800. (defun org-fast-todo-selection ()
  11801. "Fast TODO keyword selection with single keys.
  11802. Returns the new TODO keyword, or nil if no state change should occur."
  11803. (let* ((fulltable org-todo-key-alist)
  11804. (done-keywords org-done-keywords) ;; needed for the faces.
  11805. (maxlen (apply 'max (mapcar
  11806. (lambda (x)
  11807. (if (stringp (car x)) (string-width (car x)) 0))
  11808. fulltable)))
  11809. (expert nil)
  11810. (fwidth (+ maxlen 3 1 3))
  11811. (ncol (/ (- (window-width) 4) fwidth))
  11812. tg cnt e c tbl
  11813. groups ingroup)
  11814. (save-excursion
  11815. (save-window-excursion
  11816. (if expert
  11817. (set-buffer (get-buffer-create " *Org todo*"))
  11818. (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
  11819. (erase-buffer)
  11820. (setq-local org-done-keywords done-keywords)
  11821. (setq tbl fulltable cnt 0)
  11822. (while (setq e (pop tbl))
  11823. (cond
  11824. ((equal e '(:startgroup))
  11825. (push '() groups) (setq ingroup t)
  11826. (unless (= cnt 0)
  11827. (setq cnt 0)
  11828. (insert "\n"))
  11829. (insert "{ "))
  11830. ((equal e '(:endgroup))
  11831. (setq ingroup nil cnt 0)
  11832. (insert "}\n"))
  11833. ((equal e '(:newline))
  11834. (unless (= cnt 0)
  11835. (setq cnt 0)
  11836. (insert "\n")
  11837. (setq e (car tbl))
  11838. (while (equal (car tbl) '(:newline))
  11839. (insert "\n")
  11840. (setq tbl (cdr tbl)))))
  11841. (t
  11842. (setq tg (car e) c (cdr e))
  11843. (when ingroup (push tg (car groups)))
  11844. (setq tg (org-add-props tg nil 'face
  11845. (org-get-todo-face tg)))
  11846. (when (and (= cnt 0) (not ingroup)) (insert " "))
  11847. (insert "[" c "] " tg (make-string
  11848. (- fwidth 4 (length tg)) ?\ ))
  11849. (when (= (setq cnt (1+ cnt)) ncol)
  11850. (insert "\n")
  11851. (when ingroup (insert " "))
  11852. (setq cnt 0)))))
  11853. (insert "\n")
  11854. (goto-char (point-min))
  11855. (unless expert (org-fit-window-to-buffer))
  11856. (message "[a-z..]:Set [SPC]:clear")
  11857. (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
  11858. (cond
  11859. ((or (= c ?\C-g)
  11860. (and (= c ?q) (not (rassoc c fulltable))))
  11861. (setq quit-flag t))
  11862. ((= c ?\ ) nil)
  11863. ((setq e (rassoc c fulltable) tg (car e))
  11864. tg)
  11865. (t (setq quit-flag t)))))))
  11866. (defun org-entry-is-todo-p ()
  11867. (member (org-get-todo-state) org-not-done-keywords))
  11868. (defun org-entry-is-done-p ()
  11869. (member (org-get-todo-state) org-done-keywords))
  11870. (defun org-get-todo-state ()
  11871. "Return the TODO keyword of the current subtree."
  11872. (save-excursion
  11873. (org-back-to-heading t)
  11874. (and (let ((case-fold-search nil)) (looking-at org-todo-line-regexp))
  11875. (match-end 2)
  11876. (match-string 2))))
  11877. (defun org-at-date-range-p (&optional inactive-ok)
  11878. "Non-nil if point is inside a date range.
  11879. When optional argument INACTIVE-OK is non-nil, also consider
  11880. inactive time ranges.
  11881. When this function returns a non-nil value, match data is set
  11882. according to `org-tr-regexp-both' or `org-tr-regexp', depending
  11883. on INACTIVE-OK."
  11884. (interactive)
  11885. (save-excursion
  11886. (catch 'exit
  11887. (let ((pos (point)))
  11888. (skip-chars-backward "^[<\r\n")
  11889. (skip-chars-backward "<[")
  11890. (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
  11891. (>= (match-end 0) pos)
  11892. (throw 'exit t))
  11893. (skip-chars-backward "^<[\r\n")
  11894. (skip-chars-backward "<[")
  11895. (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
  11896. (>= (match-end 0) pos)
  11897. (throw 'exit t)))
  11898. nil)))
  11899. (defun org-get-repeat (&optional tagline)
  11900. "Check if there is a deadline/schedule with repeater in this entry."
  11901. (save-match-data
  11902. (save-excursion
  11903. (org-back-to-heading t)
  11904. (and (re-search-forward (if tagline
  11905. (concat tagline "\\s-*" org-repeat-re)
  11906. org-repeat-re)
  11907. (org-entry-end-position) t)
  11908. (match-string-no-properties 1)))))
  11909. (defvar org-last-changed-timestamp)
  11910. (defvar org-last-inserted-timestamp)
  11911. (defvar org-log-post-message)
  11912. (defvar org-log-note-purpose)
  11913. (defvar org-log-note-how nil)
  11914. (defvar org-log-note-extra)
  11915. (defun org-auto-repeat-maybe (done-word)
  11916. "Check if the current headline contains a repeated time-stamp.
  11917. If yes, set TODO state back to what it was and change the base date
  11918. of repeating deadline/scheduled time stamps to new date.
  11919. This function is run automatically after each state change to a DONE state."
  11920. (let* ((repeat (org-get-repeat))
  11921. (aa (assoc org-last-state org-todo-kwd-alist))
  11922. (interpret (nth 1 aa))
  11923. (head (nth 2 aa))
  11924. (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
  11925. (msg "Entry repeats: ")
  11926. (org-log-done nil)
  11927. (org-todo-log-states nil))
  11928. (when (and repeat (not (zerop (string-to-number (substring repeat 1)))))
  11929. (when (eq org-log-repeat t) (setq org-log-repeat 'state))
  11930. (let ((to-state (or (org-entry-get nil "REPEAT_TO_STATE" 'selective)
  11931. org-todo-repeat-to-state)))
  11932. (unless (and to-state (member to-state org-todo-keywords-1))
  11933. (setq to-state (if (eq interpret 'type) org-last-state head)))
  11934. (org-todo to-state))
  11935. (when (or org-log-repeat (org-entry-get nil "CLOCK"))
  11936. (org-entry-put nil "LAST_REPEAT" (format-time-string
  11937. (org-time-stamp-format t t))))
  11938. (when org-log-repeat
  11939. (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
  11940. (memq 'org-add-log-note post-command-hook))
  11941. ;; We are already setup for some record.
  11942. (when (eq org-log-repeat 'note)
  11943. ;; Make sure we take a note, not only a time stamp.
  11944. (setq org-log-note-how 'note))
  11945. ;; Set up for taking a record.
  11946. (org-add-log-setup 'state
  11947. (or done-word (car org-done-keywords))
  11948. org-last-state
  11949. org-log-repeat)))
  11950. (org-back-to-heading t)
  11951. (org-add-planning-info nil nil 'closed)
  11952. (let ((end (save-excursion (outline-next-heading) (point)))
  11953. (planning-re (regexp-opt
  11954. (list org-scheduled-string org-deadline-string))))
  11955. (while (re-search-forward org-ts-regexp end t)
  11956. (let* ((ts (match-string 0))
  11957. (planning? (org-at-planning-p))
  11958. (type (if (not planning?) "Plain:"
  11959. (save-excursion
  11960. (re-search-backward
  11961. planning-re (line-beginning-position) t)
  11962. (match-string 0)))))
  11963. (cond
  11964. ;; Ignore fake time-stamps (e.g., within comments).
  11965. ((and (not planning?)
  11966. (not (org-at-property-p))
  11967. (not (eq 'timestamp
  11968. (org-element-type (save-excursion
  11969. (backward-char)
  11970. (org-element-context)))))))
  11971. ;; Time-stamps without a repeater are usually skipped.
  11972. ;; However, a SCHEDULED time-stamp without one is
  11973. ;; removed, as it is considered as no longer relevant.
  11974. ((not (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts))
  11975. (when (equal type org-scheduled-string)
  11976. (org-remove-timestamp-with-keyword type)))
  11977. (t
  11978. (let ((n (string-to-number (match-string 2 ts)))
  11979. (what (match-string 3 ts)))
  11980. (when (equal what "w") (setq n (* n 7) what "d"))
  11981. (when (and (equal what "h")
  11982. (not (string-match-p "[0-9]\\{1,2\\}:[0-9]\\{2\\}"
  11983. ts)))
  11984. (user-error
  11985. "Cannot repeat in Repeat in %d hour(s) because no hour \
  11986. has been set"
  11987. n))
  11988. ;; Preparation, see if we need to modify the start
  11989. ;; date for the change.
  11990. (when (match-end 1)
  11991. (let ((time (save-match-data (org-time-string-to-time ts))))
  11992. (cond
  11993. ((equal (match-string 1 ts) ".")
  11994. ;; Shift starting date to today
  11995. (org-timestamp-change
  11996. (- (org-today) (time-to-days time))
  11997. 'day))
  11998. ((equal (match-string 1 ts) "+")
  11999. (let ((nshiftmax 10)
  12000. (nshift 0))
  12001. (while (or (= nshift 0)
  12002. (not (time-less-p (current-time) time)))
  12003. (when (= (cl-incf nshift) nshiftmax)
  12004. (or (y-or-n-p
  12005. (format "%d repeater intervals were not \
  12006. enough to shift date past today. Continue? "
  12007. nshift))
  12008. (user-error "Abort")))
  12009. (org-timestamp-change n (cdr (assoc what whata)))
  12010. (org-at-timestamp-p t)
  12011. (setq ts (match-string 1))
  12012. (setq time
  12013. (save-match-data
  12014. (org-time-string-to-time ts)))))
  12015. (org-timestamp-change (- n) (cdr (assoc what whata)))
  12016. ;; Rematch, so that we have everything in place
  12017. ;; for the real shift.
  12018. (org-at-timestamp-p t)
  12019. (setq ts (match-string 1))
  12020. (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)"
  12021. ts)))))
  12022. (save-excursion
  12023. (org-timestamp-change n (cdr (assoc what whata)) nil t))
  12024. (setq msg
  12025. (concat
  12026. msg type " " org-last-changed-timestamp " "))))))))
  12027. (setq org-log-post-message msg)
  12028. (message "%s" msg))))
  12029. (defun org-show-todo-tree (arg)
  12030. "Make a compact tree which shows all headlines marked with TODO.
  12031. The tree will show the lines where the regexp matches, and all higher
  12032. headlines above the match.
  12033. With a `\\[universal-argument]' prefix, prompt for a regexp to match.
  12034. With a numeric prefix N, construct a sparse tree for the Nth element
  12035. of `org-todo-keywords-1'."
  12036. (interactive "P")
  12037. (let ((case-fold-search nil)
  12038. (kwd-re
  12039. (cond ((null arg) org-not-done-regexp)
  12040. ((equal arg '(4))
  12041. (let ((kwd
  12042. (completing-read "Keyword (or KWD1|KWD2|...): "
  12043. (mapcar #'list org-todo-keywords-1))))
  12044. (concat "\\("
  12045. (mapconcat 'identity (org-split-string kwd "|") "\\|")
  12046. "\\)\\>")))
  12047. ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
  12048. (regexp-quote (nth (1- (prefix-numeric-value arg))
  12049. org-todo-keywords-1)))
  12050. (t (user-error "Invalid prefix argument: %s" arg)))))
  12051. (message "%d TODO entries found"
  12052. (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
  12053. (defun org-deadline (arg &optional time)
  12054. "Insert the \"DEADLINE:\" string with a timestamp to make a deadline.
  12055. With one universal prefix argument, remove any deadline from the item.
  12056. With two universal prefix arguments, prompt for a warning delay.
  12057. With argument TIME, set the deadline at the corresponding date. TIME
  12058. can either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
  12059. (interactive "P")
  12060. (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
  12061. (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
  12062. 'region-start-level 'region))
  12063. org-loop-over-headlines-in-active-region)
  12064. (org-map-entries
  12065. `(org-deadline ',arg ,time)
  12066. org-loop-over-headlines-in-active-region
  12067. cl (when (outline-invisible-p) (org-end-of-subtree nil t))))
  12068. (let* ((old-date (org-entry-get nil "DEADLINE"))
  12069. (old-date-time (when old-date (org-time-string-to-time old-date)))
  12070. (repeater (and old-date
  12071. (string-match
  12072. "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
  12073. old-date)
  12074. (match-string 1 old-date))))
  12075. (cond
  12076. ((equal arg '(4))
  12077. (when (and old-date org-log-redeadline)
  12078. (org-add-log-setup 'deldeadline nil old-date org-log-redeadline))
  12079. (org-remove-timestamp-with-keyword org-deadline-string)
  12080. (message "Item no longer has a deadline."))
  12081. ((equal arg '(16))
  12082. (save-excursion
  12083. (org-back-to-heading t)
  12084. (if (re-search-forward
  12085. org-deadline-time-regexp
  12086. (save-excursion (outline-next-heading) (point)) t)
  12087. (let* ((rpl0 (match-string 1))
  12088. (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
  12089. (replace-match
  12090. (concat org-deadline-string
  12091. " <" rpl
  12092. (format " -%dd"
  12093. (abs
  12094. (- (time-to-days
  12095. (save-match-data
  12096. (org-read-date nil t nil "Warn starting from" old-date-time)))
  12097. (time-to-days old-date-time))))
  12098. ">") t t))
  12099. (user-error "No deadline information to update"))))
  12100. (t
  12101. (org-add-planning-info 'deadline time 'closed)
  12102. (when (and old-date
  12103. org-log-redeadline
  12104. (not (equal old-date org-last-inserted-timestamp)))
  12105. (org-add-log-setup
  12106. 'redeadline org-last-inserted-timestamp old-date org-log-redeadline))
  12107. (when repeater
  12108. (save-excursion
  12109. (org-back-to-heading t)
  12110. (when (re-search-forward (concat org-deadline-string " "
  12111. org-last-inserted-timestamp)
  12112. (save-excursion
  12113. (outline-next-heading) (point)) t)
  12114. (goto-char (1- (match-end 0)))
  12115. (insert " " repeater)
  12116. (setq org-last-inserted-timestamp
  12117. (concat (substring org-last-inserted-timestamp 0 -1)
  12118. " " repeater
  12119. (substring org-last-inserted-timestamp -1))))))
  12120. (message "Deadline on %s" org-last-inserted-timestamp))))))
  12121. (defun org-schedule (arg &optional time)
  12122. "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
  12123. With one universal prefix argument, remove any scheduling date from the item.
  12124. With two universal prefix arguments, prompt for a delay cookie.
  12125. With argument TIME, scheduled at the corresponding date. TIME can
  12126. either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
  12127. (interactive "P")
  12128. (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
  12129. (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
  12130. 'region-start-level 'region))
  12131. org-loop-over-headlines-in-active-region)
  12132. (org-map-entries
  12133. `(org-schedule ',arg ,time)
  12134. org-loop-over-headlines-in-active-region
  12135. cl (when (outline-invisible-p) (org-end-of-subtree nil t))))
  12136. (let* ((old-date (org-entry-get nil "SCHEDULED"))
  12137. (old-date-time (when old-date (org-time-string-to-time old-date)))
  12138. (repeater (and old-date
  12139. (string-match
  12140. "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
  12141. old-date)
  12142. (match-string 1 old-date))))
  12143. (cond
  12144. ((equal arg '(4))
  12145. (progn
  12146. (when (and old-date org-log-reschedule)
  12147. (org-add-log-setup 'delschedule nil old-date org-log-reschedule))
  12148. (org-remove-timestamp-with-keyword org-scheduled-string)
  12149. (message "Item is no longer scheduled.")))
  12150. ((equal arg '(16))
  12151. (save-excursion
  12152. (org-back-to-heading t)
  12153. (if (re-search-forward
  12154. org-scheduled-time-regexp
  12155. (save-excursion (outline-next-heading) (point)) t)
  12156. (let* ((rpl0 (match-string 1))
  12157. (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
  12158. (replace-match
  12159. (concat org-scheduled-string
  12160. " <" rpl
  12161. (format " -%dd"
  12162. (abs
  12163. (- (time-to-days
  12164. (save-match-data
  12165. (org-read-date nil t nil "Delay until" old-date-time)))
  12166. (time-to-days old-date-time))))
  12167. ">") t t))
  12168. (user-error "No scheduled information to update"))))
  12169. (t
  12170. (org-add-planning-info 'scheduled time 'closed)
  12171. (when (and old-date
  12172. org-log-reschedule
  12173. (not (equal old-date org-last-inserted-timestamp)))
  12174. (org-add-log-setup
  12175. 'reschedule org-last-inserted-timestamp old-date org-log-reschedule))
  12176. (when repeater
  12177. (save-excursion
  12178. (org-back-to-heading t)
  12179. (when (re-search-forward (concat org-scheduled-string " "
  12180. org-last-inserted-timestamp)
  12181. (save-excursion
  12182. (outline-next-heading) (point)) t)
  12183. (goto-char (1- (match-end 0)))
  12184. (insert " " repeater)
  12185. (setq org-last-inserted-timestamp
  12186. (concat (substring org-last-inserted-timestamp 0 -1)
  12187. " " repeater
  12188. (substring org-last-inserted-timestamp -1))))))
  12189. (message "Scheduled to %s" org-last-inserted-timestamp))))))
  12190. (defun org-get-scheduled-time (pom &optional inherit)
  12191. "Get the scheduled time as a time tuple, of a format suitable
  12192. for calling org-schedule with, or if there is no scheduling,
  12193. returns nil."
  12194. (let ((time (org-entry-get pom "SCHEDULED" inherit)))
  12195. (when time
  12196. (apply 'encode-time (org-parse-time-string time)))))
  12197. (defun org-get-deadline-time (pom &optional inherit)
  12198. "Get the deadline as a time tuple, of a format suitable for
  12199. calling org-deadline with, or if there is no scheduling, returns
  12200. nil."
  12201. (let ((time (org-entry-get pom "DEADLINE" inherit)))
  12202. (when time
  12203. (apply 'encode-time (org-parse-time-string time)))))
  12204. (defun org-remove-timestamp-with-keyword (keyword)
  12205. "Remove all time stamps with KEYWORD in the current entry."
  12206. (let ((re (concat "\\<" (regexp-quote keyword) " +<[^>\n]+>[ \t]*"))
  12207. beg)
  12208. (save-excursion
  12209. (org-back-to-heading t)
  12210. (setq beg (point))
  12211. (outline-next-heading)
  12212. (while (re-search-backward re beg t)
  12213. (replace-match "")
  12214. (if (and (string-match "\\S-" (buffer-substring (point-at-bol) (point)))
  12215. (equal (char-before) ?\ ))
  12216. (backward-delete-char 1)
  12217. (when (string-match "^[ \t]*$" (buffer-substring
  12218. (point-at-bol) (point-at-eol)))
  12219. (delete-region (point-at-bol)
  12220. (min (point-max) (1+ (point-at-eol))))))))))
  12221. (defvar org-time-was-given) ; dynamically scoped parameter
  12222. (defvar org-end-time-was-given) ; dynamically scoped parameter
  12223. (defun org-at-planning-p ()
  12224. "Non-nil when point is on a planning info line."
  12225. ;; This is as accurate and faster than `org-element-at-point' since
  12226. ;; planning info location is fixed in the section.
  12227. (org-with-wide-buffer
  12228. (beginning-of-line)
  12229. (and (looking-at-p org-planning-line-re)
  12230. (eq (point)
  12231. (ignore-errors
  12232. (if (and (featurep 'org-inlinetask) (org-inlinetask-in-task-p))
  12233. (org-back-to-heading t)
  12234. (org-with-limited-levels (org-back-to-heading t)))
  12235. (line-beginning-position 2))))))
  12236. (defun org-add-planning-info (what &optional time &rest remove)
  12237. "Insert new timestamp with keyword in the planning line.
  12238. WHAT indicates what kind of time stamp to add. It is a symbol
  12239. among `closed', `deadline', `scheduled' and nil. TIME indicates
  12240. the time to use. If none is given, the user is prompted for
  12241. a date. REMOVE indicates what kind of entries to remove. An old
  12242. WHAT entry will also be removed."
  12243. (let (org-time-was-given org-end-time-was-given default-time default-input)
  12244. (catch 'exit
  12245. (when (and (memq what '(scheduled deadline))
  12246. (or (not time)
  12247. (and (stringp time)
  12248. (string-match "^[-+]+[0-9]" time))))
  12249. ;; Try to get a default date/time from existing timestamp
  12250. (save-excursion
  12251. (org-back-to-heading t)
  12252. (let ((end (save-excursion (outline-next-heading) (point))) ts)
  12253. (when (re-search-forward (if (eq what 'scheduled)
  12254. org-scheduled-time-regexp
  12255. org-deadline-time-regexp)
  12256. end t)
  12257. (setq ts (match-string 1)
  12258. default-time (apply 'encode-time (org-parse-time-string ts))
  12259. default-input (and ts (org-get-compact-tod ts)))))))
  12260. (when what
  12261. (setq time
  12262. (if (stringp time)
  12263. ;; This is a string (relative or absolute), set
  12264. ;; proper date.
  12265. (apply #'encode-time
  12266. (org-read-date-analyze
  12267. time default-time (decode-time default-time)))
  12268. ;; If necessary, get the time from the user
  12269. (or time (org-read-date nil 'to-time nil nil
  12270. default-time default-input)))))
  12271. (org-with-wide-buffer
  12272. (org-back-to-heading t)
  12273. (forward-line)
  12274. (unless (bolp) (insert "\n"))
  12275. (cond ((looking-at-p org-planning-line-re)
  12276. ;; Move to current indentation.
  12277. (skip-chars-forward " \t")
  12278. ;; Check if we have to remove something.
  12279. (dolist (type (if what (cons what remove) remove))
  12280. (save-excursion
  12281. (when (re-search-forward
  12282. (cl-case type
  12283. (closed org-closed-time-regexp)
  12284. (deadline org-deadline-time-regexp)
  12285. (scheduled org-scheduled-time-regexp)
  12286. (otherwise
  12287. (error "Invalid planning type: %s" type)))
  12288. (line-end-position) t)
  12289. ;; Delete until next keyword or end of line.
  12290. (delete-region
  12291. (match-beginning 0)
  12292. (if (re-search-forward org-keyword-time-not-clock-regexp
  12293. (line-end-position)
  12294. t)
  12295. (match-beginning 0)
  12296. (line-end-position))))))
  12297. ;; If there is nothing more to add and no more keyword
  12298. ;; is left, remove the line completely.
  12299. (if (and (looking-at-p "[ \t]*$") (not what))
  12300. (delete-region (line-beginning-position)
  12301. (line-beginning-position 2))
  12302. ;; If we removed last keyword, do not leave trailing
  12303. ;; white space at the end of line.
  12304. (let ((p (point)))
  12305. (save-excursion
  12306. (end-of-line)
  12307. (unless (= (skip-chars-backward " \t" p) 0)
  12308. (delete-region (point) (line-end-position)))))))
  12309. ((not what) (throw 'exit nil)) ; Nothing to do.
  12310. (t (insert-before-markers "\n")
  12311. (backward-char 1)
  12312. (when org-adapt-indentation
  12313. (indent-to-column (1+ (org-outline-level))))))
  12314. (when what
  12315. ;; Insert planning keyword.
  12316. (insert (cl-case what
  12317. (closed org-closed-string)
  12318. (deadline org-deadline-string)
  12319. (scheduled org-scheduled-string)
  12320. (otherwise (error "Invalid planning type: %s" what)))
  12321. " ")
  12322. ;; Insert associated timestamp.
  12323. (let ((ts (org-insert-time-stamp
  12324. time
  12325. (or org-time-was-given
  12326. (and (eq what 'closed) org-log-done-with-time))
  12327. (eq what 'closed)
  12328. nil nil (list org-end-time-was-given))))
  12329. (unless (eolp) (insert " "))
  12330. ts))))))
  12331. (defvar org-log-note-marker (make-marker)
  12332. "Marker pointing at the entry where the note is to be inserted.")
  12333. (defvar org-log-note-purpose nil)
  12334. (defvar org-log-note-state nil)
  12335. (defvar org-log-note-previous-state nil)
  12336. (defvar org-log-note-extra nil)
  12337. (defvar org-log-note-window-configuration nil)
  12338. (defvar org-log-note-return-to (make-marker))
  12339. (defvar org-log-note-effective-time nil
  12340. "Remembered current time so that dynamically scoped
  12341. `org-extend-today-until' affects timestamps in state change log")
  12342. (defvar org-log-post-message nil
  12343. "Message to be displayed after a log note has been stored.
  12344. The auto-repeater uses this.")
  12345. (defun org-add-note ()
  12346. "Add a note to the current entry.
  12347. This is done in the same way as adding a state change note."
  12348. (interactive)
  12349. (org-add-log-setup 'note))
  12350. (defun org-log-beginning (&optional create)
  12351. "Return expected start of log notes in current entry.
  12352. When optional argument CREATE is non-nil, the function creates
  12353. a drawer to store notes, if necessary. Returned position ignores
  12354. narrowing."
  12355. (org-with-wide-buffer
  12356. (let ((drawer (org-log-into-drawer)))
  12357. (cond
  12358. (drawer
  12359. (org-end-of-meta-data)
  12360. (let ((regexp (concat "^[ \t]*:" (regexp-quote drawer) ":[ \t]*$"))
  12361. (end (if (org-at-heading-p) (point)
  12362. (save-excursion (outline-next-heading) (point))))
  12363. (case-fold-search t))
  12364. (catch 'exit
  12365. ;; Try to find existing drawer.
  12366. (while (re-search-forward regexp end t)
  12367. (let ((element (org-element-at-point)))
  12368. (when (eq (org-element-type element) 'drawer)
  12369. (let ((cend (org-element-property :contents-end element)))
  12370. (when (and (not org-log-states-order-reversed) cend)
  12371. (goto-char cend)))
  12372. (throw 'exit nil))))
  12373. ;; No drawer found. Create one, if permitted.
  12374. (when create
  12375. (unless (bolp) (insert "\n"))
  12376. (let ((beg (point)))
  12377. (insert ":" drawer ":\n:END:\n")
  12378. (org-indent-region beg (point)))
  12379. (end-of-line -1)))))
  12380. (t
  12381. (org-end-of-meta-data org-log-state-notes-insert-after-drawers)
  12382. (skip-chars-forward " \t\n")
  12383. (beginning-of-line)
  12384. (unless org-log-states-order-reversed
  12385. (org-skip-over-state-notes)
  12386. (skip-chars-backward " \t\n")
  12387. (forward-line)))))
  12388. (if (bolp) (point) (line-beginning-position 2))))
  12389. (defun org-add-log-setup (&optional purpose state prev-state how extra)
  12390. "Set up the post command hook to take a note.
  12391. If this is about to TODO state change, the new state is expected in STATE.
  12392. HOW is an indicator what kind of note should be created.
  12393. EXTRA is additional text that will be inserted into the notes buffer."
  12394. (move-marker org-log-note-marker (point))
  12395. (setq org-log-note-purpose purpose
  12396. org-log-note-state state
  12397. org-log-note-previous-state prev-state
  12398. org-log-note-how how
  12399. org-log-note-extra extra
  12400. org-log-note-effective-time (org-current-effective-time))
  12401. (add-hook 'post-command-hook 'org-add-log-note 'append))
  12402. (defun org-skip-over-state-notes ()
  12403. "Skip past the list of State notes in an entry."
  12404. (when (ignore-errors (goto-char (org-in-item-p)))
  12405. (let* ((struct (org-list-struct))
  12406. (prevs (org-list-prevs-alist struct))
  12407. (regexp
  12408. (concat "[ \t]*- +"
  12409. (replace-regexp-in-string
  12410. " +" " +"
  12411. (org-replace-escapes
  12412. (regexp-quote (cdr (assq 'state org-log-note-headings)))
  12413. `(("%d" . ,org-ts-regexp-inactive)
  12414. ("%D" . ,org-ts-regexp)
  12415. ("%s" . "\"\\S-+\"")
  12416. ("%S" . "\"\\S-+\"")
  12417. ("%t" . ,org-ts-regexp-inactive)
  12418. ("%T" . ,org-ts-regexp)
  12419. ("%u" . ".*?")
  12420. ("%U" . ".*?")))))))
  12421. (while (looking-at-p regexp)
  12422. (goto-char (or (org-list-get-next-item (point) struct prevs)
  12423. (org-list-get-item-end (point) struct)))))))
  12424. (defun org-add-log-note (&optional _purpose)
  12425. "Pop up a window for taking a note, and add this note later."
  12426. (remove-hook 'post-command-hook 'org-add-log-note)
  12427. (setq org-log-note-window-configuration (current-window-configuration))
  12428. (delete-other-windows)
  12429. (move-marker org-log-note-return-to (point))
  12430. (pop-to-buffer-same-window (marker-buffer org-log-note-marker))
  12431. (goto-char org-log-note-marker)
  12432. (org-switch-to-buffer-other-window "*Org Note*")
  12433. (erase-buffer)
  12434. (if (memq org-log-note-how '(time state))
  12435. (let (current-prefix-arg) (org-store-log-note))
  12436. (let ((org-inhibit-startup t)) (org-mode))
  12437. (insert (format "# Insert note for %s.
  12438. # Finish with C-c C-c, or cancel with C-c C-k.\n\n"
  12439. (cond
  12440. ((eq org-log-note-purpose 'clock-out) "stopped clock")
  12441. ((eq org-log-note-purpose 'done) "closed todo item")
  12442. ((eq org-log-note-purpose 'state)
  12443. (format "state change from \"%s\" to \"%s\""
  12444. (or org-log-note-previous-state "")
  12445. (or org-log-note-state "")))
  12446. ((eq org-log-note-purpose 'reschedule)
  12447. "rescheduling")
  12448. ((eq org-log-note-purpose 'delschedule)
  12449. "no longer scheduled")
  12450. ((eq org-log-note-purpose 'redeadline)
  12451. "changing deadline")
  12452. ((eq org-log-note-purpose 'deldeadline)
  12453. "removing deadline")
  12454. ((eq org-log-note-purpose 'refile)
  12455. "refiling")
  12456. ((eq org-log-note-purpose 'note)
  12457. "this entry")
  12458. (t (error "This should not happen")))))
  12459. (when org-log-note-extra (insert org-log-note-extra))
  12460. (setq-local org-finish-function 'org-store-log-note)
  12461. (run-hooks 'org-log-buffer-setup-hook)))
  12462. (defvar org-note-abort nil) ; dynamically scoped
  12463. (defun org-store-log-note ()
  12464. "Finish taking a log note, and insert it to where it belongs."
  12465. (let ((txt (prog1 (buffer-string)
  12466. (kill-buffer)))
  12467. (note (cdr (assq org-log-note-purpose org-log-note-headings)))
  12468. lines)
  12469. (while (string-match "\\`# .*\n[ \t\n]*" txt)
  12470. (setq txt (replace-match "" t t txt)))
  12471. (when (string-match "\\s-+\\'" txt)
  12472. (setq txt (replace-match "" t t txt)))
  12473. (setq lines (org-split-string txt "\n"))
  12474. (when (org-string-nw-p note)
  12475. (setq note
  12476. (org-replace-escapes
  12477. note
  12478. (list (cons "%u" (user-login-name))
  12479. (cons "%U" user-full-name)
  12480. (cons "%t" (format-time-string
  12481. (org-time-stamp-format 'long 'inactive)
  12482. org-log-note-effective-time))
  12483. (cons "%T" (format-time-string
  12484. (org-time-stamp-format 'long nil)
  12485. org-log-note-effective-time))
  12486. (cons "%d" (format-time-string
  12487. (org-time-stamp-format nil 'inactive)
  12488. org-log-note-effective-time))
  12489. (cons "%D" (format-time-string
  12490. (org-time-stamp-format nil nil)
  12491. org-log-note-effective-time))
  12492. (cons "%s" (cond
  12493. ((not org-log-note-state) "")
  12494. ((string-match-p org-ts-regexp
  12495. org-log-note-state)
  12496. (format "\"[%s]\""
  12497. (substring org-log-note-state 1 -1)))
  12498. (t (format "\"%s\"" org-log-note-state))))
  12499. (cons "%S"
  12500. (cond
  12501. ((not org-log-note-previous-state) "")
  12502. ((string-match-p org-ts-regexp
  12503. org-log-note-previous-state)
  12504. (format "\"[%s]\""
  12505. (substring
  12506. org-log-note-previous-state 1 -1)))
  12507. (t (format "\"%s\""
  12508. org-log-note-previous-state)))))))
  12509. (when lines (setq note (concat note " \\\\")))
  12510. (push note lines))
  12511. (when (and lines (not (or current-prefix-arg org-note-abort)))
  12512. (with-current-buffer (marker-buffer org-log-note-marker)
  12513. (org-with-wide-buffer
  12514. ;; Find location for the new note.
  12515. (goto-char org-log-note-marker)
  12516. (set-marker org-log-note-marker nil)
  12517. (goto-char (org-log-beginning t))
  12518. ;; Make sure point is at the beginning of an empty line.
  12519. (cond ((not (bolp)) (let ((inhibit-read-only t)) (insert "\n")))
  12520. ((looking-at "[ \t]*\\S-") (save-excursion (insert "\n"))))
  12521. ;; In an existing list, add a new item at the top level.
  12522. ;; Otherwise, indent line like a regular one.
  12523. (let ((itemp (org-in-item-p)))
  12524. (if itemp
  12525. (indent-line-to
  12526. (let ((struct (save-excursion
  12527. (goto-char itemp) (org-list-struct))))
  12528. (org-list-get-ind (org-list-get-top-point struct) struct)))
  12529. (org-indent-line)))
  12530. (insert (org-list-bullet-string "-") (pop lines))
  12531. (let ((ind (org-list-item-body-column (line-beginning-position))))
  12532. (dolist (line lines)
  12533. (insert "\n")
  12534. (indent-line-to ind)
  12535. (insert line)))
  12536. (message "Note stored")
  12537. (org-back-to-heading t)
  12538. (org-cycle-hide-drawers 'children))
  12539. ;; Fix `buffer-undo-list' when `org-store-log-note' is called
  12540. ;; from within `org-add-log-note' because `buffer-undo-list'
  12541. ;; is then modified outside of `org-with-remote-undo'.
  12542. (when (eq this-command 'org-agenda-todo)
  12543. (setcdr buffer-undo-list (cddr buffer-undo-list))))))
  12544. ;; Don't add undo information when called from `org-agenda-todo'.
  12545. (let ((buffer-undo-list (eq this-command 'org-agenda-todo)))
  12546. (set-window-configuration org-log-note-window-configuration)
  12547. (with-current-buffer (marker-buffer org-log-note-return-to)
  12548. (goto-char org-log-note-return-to))
  12549. (move-marker org-log-note-return-to nil)
  12550. (when org-log-post-message (message "%s" org-log-post-message))))
  12551. (defun org-remove-empty-drawer-at (pos)
  12552. "Remove an empty drawer at position POS.
  12553. POS may also be a marker."
  12554. (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
  12555. (org-with-wide-buffer
  12556. (goto-char pos)
  12557. (let ((drawer (org-element-at-point)))
  12558. (when (and (memq (org-element-type drawer) '(drawer property-drawer))
  12559. (not (org-element-property :contents-begin drawer)))
  12560. (delete-region (org-element-property :begin drawer)
  12561. (progn (goto-char (org-element-property :end drawer))
  12562. (skip-chars-backward " \r\t\n")
  12563. (forward-line)
  12564. (point))))))))
  12565. (defvar org-ts-type nil)
  12566. (defun org-sparse-tree (&optional arg type)
  12567. "Create a sparse tree, prompt for the details.
  12568. This command can create sparse trees. You first need to select the type
  12569. of match used to create the tree:
  12570. t Show all TODO entries.
  12571. T Show entries with a specific TODO keyword.
  12572. m Show entries selected by a tags/property match.
  12573. p Enter a property name and its value (both with completion on existing
  12574. names/values) and show entries with that property.
  12575. r Show entries matching a regular expression (`/' can be used as well).
  12576. b Show deadlines and scheduled items before a date.
  12577. a Show deadlines and scheduled items after a date.
  12578. d Show deadlines due within `org-deadline-warning-days'.
  12579. D Show deadlines and scheduled items between a date range."
  12580. (interactive "P")
  12581. (setq type (or type org-sparse-tree-default-date-type))
  12582. (setq org-ts-type type)
  12583. (message "Sparse tree: [r]egexp [t]odo [T]odo-kwd [m]atch [p]roperty
  12584. \[d]eadlines [b]efore-date [a]fter-date [D]ates range
  12585. \[c]ycle through date types: %s"
  12586. (cl-case type
  12587. (all "all timestamps")
  12588. (scheduled "only scheduled")
  12589. (deadline "only deadline")
  12590. (active "only active timestamps")
  12591. (inactive "only inactive timestamps")
  12592. (closed "with a closed time-stamp")
  12593. (otherwise "scheduled/deadline")))
  12594. (let ((answer (read-char-exclusive)))
  12595. (cl-case answer
  12596. (?c
  12597. (org-sparse-tree
  12598. arg
  12599. (cadr
  12600. (memq type '(nil all scheduled deadline active inactive closed)))))
  12601. (?d (call-interactively 'org-check-deadlines))
  12602. (?b (call-interactively 'org-check-before-date))
  12603. (?a (call-interactively 'org-check-after-date))
  12604. (?D (call-interactively 'org-check-dates-range))
  12605. (?t (call-interactively 'org-show-todo-tree))
  12606. (?T (org-show-todo-tree '(4)))
  12607. (?m (call-interactively 'org-match-sparse-tree))
  12608. ((?p ?P)
  12609. (let* ((kwd (completing-read
  12610. "Property: " (mapcar #'list (org-buffer-property-keys))))
  12611. (value (completing-read
  12612. "Value: " (mapcar #'list (org-property-values kwd)))))
  12613. (unless (string-match "\\`{.*}\\'" value)
  12614. (setq value (concat "\"" value "\"")))
  12615. (org-match-sparse-tree arg (concat kwd "=" value))))
  12616. ((?r ?R ?/) (call-interactively 'org-occur))
  12617. (otherwise (user-error "No such sparse tree command \"%c\"" answer)))))
  12618. (defvar-local org-occur-highlights nil
  12619. "List of overlays used for occur matches.")
  12620. (defvar-local org-occur-parameters nil
  12621. "Parameters of the active org-occur calls.
  12622. This is a list, each call to org-occur pushes as cons cell,
  12623. containing the regular expression and the callback, onto the list.
  12624. The list can contain several entries if `org-occur' has been called
  12625. several time with the KEEP-PREVIOUS argument. Otherwise, this list
  12626. will only contain one set of parameters. When the highlights are
  12627. removed (for example with `C-c C-c', or with the next edit (depending
  12628. on `org-remove-highlights-with-change'), this variable is emptied
  12629. as well.")
  12630. (defun org-occur (regexp &optional keep-previous callback)
  12631. "Make a compact tree which shows all matches of REGEXP.
  12632. The tree will show the lines where the regexp matches, and any other context
  12633. defined in `org-show-context-detail', which see.
  12634. When optional argument KEEP-PREVIOUS is non-nil, highlighting and exposing
  12635. done by a previous call to `org-occur' will be kept, to allow stacking of
  12636. calls to this command.
  12637. Optional argument CALLBACK can be a function of no argument. In this case,
  12638. it is called with point at the end of the match, match data being set
  12639. accordingly. Current match is shown only if the return value is non-nil.
  12640. The function must neither move point nor alter narrowing."
  12641. (interactive "sRegexp: \nP")
  12642. (when (equal regexp "")
  12643. (user-error "Regexp cannot be empty"))
  12644. (unless keep-previous
  12645. (org-remove-occur-highlights nil nil t))
  12646. (push (cons regexp callback) org-occur-parameters)
  12647. (let ((cnt 0))
  12648. (save-excursion
  12649. (goto-char (point-min))
  12650. (when (or (not keep-previous) ; do not want to keep
  12651. (not org-occur-highlights)) ; no previous matches
  12652. ;; hide everything
  12653. (org-overview))
  12654. (let ((case-fold-search (if (eq org-occur-case-fold-search 'smart)
  12655. (isearch-no-upper-case-p regexp t)
  12656. org-occur-case-fold-search)))
  12657. (while (re-search-forward regexp nil t)
  12658. (when (or (not callback)
  12659. (save-match-data (funcall callback)))
  12660. (setq cnt (1+ cnt))
  12661. (when org-highlight-sparse-tree-matches
  12662. (org-highlight-new-match (match-beginning 0) (match-end 0)))
  12663. (org-show-context 'occur-tree)))))
  12664. (when org-remove-highlights-with-change
  12665. (add-hook 'before-change-functions 'org-remove-occur-highlights
  12666. nil 'local))
  12667. (unless org-sparse-tree-open-archived-trees
  12668. (org-hide-archived-subtrees (point-min) (point-max)))
  12669. (run-hooks 'org-occur-hook)
  12670. (when (called-interactively-p 'interactive)
  12671. (message "%d match(es) for regexp %s" cnt regexp))
  12672. cnt))
  12673. (defun org-occur-next-match (&optional n _reset)
  12674. "Function for `next-error-function' to find sparse tree matches.
  12675. N is the number of matches to move, when negative move backwards.
  12676. This function always goes back to the starting point when no
  12677. match is found."
  12678. (let* ((limit (if (< n 0) (point-min) (point-max)))
  12679. (search-func (if (< n 0)
  12680. 'previous-single-char-property-change
  12681. 'next-single-char-property-change))
  12682. (n (abs n))
  12683. (pos (point))
  12684. p1)
  12685. (catch 'exit
  12686. (while (setq p1 (funcall search-func (point) 'org-type))
  12687. (when (equal p1 limit)
  12688. (goto-char pos)
  12689. (user-error "No more matches"))
  12690. (when (equal (get-char-property p1 'org-type) 'org-occur)
  12691. (setq n (1- n))
  12692. (when (= n 0)
  12693. (goto-char p1)
  12694. (throw 'exit (point))))
  12695. (goto-char p1))
  12696. (goto-char p1)
  12697. (user-error "No more matches"))))
  12698. (defun org-show-context (&optional key)
  12699. "Make sure point and context are visible.
  12700. Optional argument KEY, when non-nil, is a symbol. See
  12701. `org-show-context-detail' for allowed values and how much is to
  12702. be shown."
  12703. (org-show-set-visibility
  12704. (cond ((symbolp org-show-context-detail) org-show-context-detail)
  12705. ((cdr (assq key org-show-context-detail)))
  12706. (t (cdr (assq 'default org-show-context-detail))))))
  12707. (defun org-show-set-visibility (detail)
  12708. "Set visibility around point according to DETAIL.
  12709. DETAIL is either nil, `minimal', `local', `ancestors', `lineage',
  12710. `tree', `canonical' or t. See `org-show-context-detail' for more
  12711. information."
  12712. ;; Show current heading and possibly its entry, following headline
  12713. ;; or all children.
  12714. (if (and (org-at-heading-p) (not (eq detail 'local)))
  12715. (org-flag-heading nil)
  12716. (org-show-entry)
  12717. ;; If point is hidden within a drawer or a block, make sure to
  12718. ;; expose it.
  12719. (dolist (o (overlays-at (point)))
  12720. (when (memq (overlay-get o 'invisible) '(org-hide-block outline))
  12721. (delete-overlay o)))
  12722. (unless (org-before-first-heading-p)
  12723. (org-with-limited-levels
  12724. (cl-case detail
  12725. ((tree canonical t) (org-show-children))
  12726. ((nil minimal ancestors))
  12727. (t (save-excursion
  12728. (outline-next-heading)
  12729. (org-flag-heading nil)))))))
  12730. ;; Show all siblings.
  12731. (when (eq detail 'lineage) (org-show-siblings))
  12732. ;; Show ancestors, possibly with their children.
  12733. (when (memq detail '(ancestors lineage tree canonical t))
  12734. (save-excursion
  12735. (while (org-up-heading-safe)
  12736. (org-flag-heading nil)
  12737. (when (memq detail '(canonical t)) (org-show-entry))
  12738. (when (memq detail '(tree canonical t)) (org-show-children))))))
  12739. (defvar org-reveal-start-hook nil
  12740. "Hook run before revealing a location.")
  12741. (defun org-reveal (&optional siblings)
  12742. "Show current entry, hierarchy above it, and the following headline.
  12743. This can be used to show a consistent set of context around
  12744. locations exposed with `org-show-context'.
  12745. With optional argument SIBLINGS, on each level of the hierarchy all
  12746. siblings are shown. This repairs the tree structure to what it would
  12747. look like when opened with hierarchical calls to `org-cycle'.
  12748. With a \\[universal-argument] \\[universal-argument] prefix, \
  12749. go to the parent and show the entire tree."
  12750. (interactive "P")
  12751. (run-hooks 'org-reveal-start-hook)
  12752. (cond ((equal siblings '(4)) (org-show-set-visibility 'canonical))
  12753. ((equal siblings '(16))
  12754. (save-excursion
  12755. (when (org-up-heading-safe)
  12756. (org-show-subtree)
  12757. (run-hook-with-args 'org-cycle-hook 'subtree))))
  12758. (t (org-show-set-visibility 'lineage))))
  12759. (defun org-highlight-new-match (beg end)
  12760. "Highlight from BEG to END and mark the highlight is an occur headline."
  12761. (let ((ov (make-overlay beg end)))
  12762. (overlay-put ov 'face 'secondary-selection)
  12763. (overlay-put ov 'org-type 'org-occur)
  12764. (push ov org-occur-highlights)))
  12765. (defun org-remove-occur-highlights (&optional _beg _end noremove)
  12766. "Remove the occur highlights from the buffer.
  12767. BEG and END are ignored. If NOREMOVE is nil, remove this function
  12768. from the `before-change-functions' in the current buffer."
  12769. (interactive)
  12770. (unless org-inhibit-highlight-removal
  12771. (mapc #'delete-overlay org-occur-highlights)
  12772. (setq org-occur-highlights nil)
  12773. (setq org-occur-parameters nil)
  12774. (unless noremove
  12775. (remove-hook 'before-change-functions
  12776. 'org-remove-occur-highlights 'local))))
  12777. ;;;; Priorities
  12778. (defvar org-priority-regexp ".*?\\(\\[#\\([A-Z0-9]\\)\\] ?\\)"
  12779. "Regular expression matching the priority indicator.")
  12780. (defvar org-remove-priority-next-time nil)
  12781. (defun org-priority-up ()
  12782. "Increase the priority of the current item."
  12783. (interactive)
  12784. (org-priority 'up))
  12785. (defun org-priority-down ()
  12786. "Decrease the priority of the current item."
  12787. (interactive)
  12788. (org-priority 'down))
  12789. (defun org-priority (&optional action _show)
  12790. "Change the priority of an item.
  12791. ACTION can be `set', `up', `down', or a character."
  12792. (interactive "P")
  12793. (if (equal action '(4))
  12794. (org-show-priority)
  12795. (unless org-enable-priority-commands
  12796. (user-error "Priority commands are disabled"))
  12797. (setq action (or action 'set))
  12798. (let (current new news have remove)
  12799. (save-excursion
  12800. (org-back-to-heading t)
  12801. (when (looking-at org-priority-regexp)
  12802. (setq current (string-to-char (match-string 2))
  12803. have t))
  12804. (cond
  12805. ((eq action 'remove)
  12806. (setq remove t new ?\ ))
  12807. ((or (eq action 'set)
  12808. (integerp action))
  12809. (if (not (eq action 'set))
  12810. (setq new action)
  12811. (message "Priority %c-%c, SPC to remove: "
  12812. org-highest-priority org-lowest-priority)
  12813. (save-match-data
  12814. (setq new (read-char-exclusive))))
  12815. (when (and (= (upcase org-highest-priority) org-highest-priority)
  12816. (= (upcase org-lowest-priority) org-lowest-priority))
  12817. (setq new (upcase new)))
  12818. (cond ((equal new ?\ ) (setq remove t))
  12819. ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
  12820. (user-error "Priority must be between `%c' and `%c'"
  12821. org-highest-priority org-lowest-priority))))
  12822. ((eq action 'up)
  12823. (setq new (if have
  12824. (1- current) ; normal cycling
  12825. ;; last priority was empty
  12826. (if (eq last-command this-command)
  12827. org-lowest-priority ; wrap around empty to lowest
  12828. ;; default
  12829. (if org-priority-start-cycle-with-default
  12830. org-default-priority
  12831. (1- org-default-priority))))))
  12832. ((eq action 'down)
  12833. (setq new (if have
  12834. (1+ current) ; normal cycling
  12835. ;; last priority was empty
  12836. (if (eq last-command this-command)
  12837. org-highest-priority ; wrap around empty to highest
  12838. ;; default
  12839. (if org-priority-start-cycle-with-default
  12840. org-default-priority
  12841. (1+ org-default-priority))))))
  12842. (t (user-error "Invalid action")))
  12843. (when (or (< (upcase new) org-highest-priority)
  12844. (> (upcase new) org-lowest-priority))
  12845. (if (and (memq action '(up down))
  12846. (not have) (not (eq last-command this-command)))
  12847. ;; `new' is from default priority
  12848. (error
  12849. "The default can not be set, see `org-default-priority' why")
  12850. ;; normal cycling: `new' is beyond highest/lowest priority
  12851. ;; and is wrapped around to the empty priority
  12852. (setq remove t)))
  12853. (setq news (format "%c" new))
  12854. (if have
  12855. (if remove
  12856. (replace-match "" t t nil 1)
  12857. (replace-match news t t nil 2))
  12858. (if remove
  12859. (user-error "No priority cookie found in line")
  12860. (let ((case-fold-search nil)) (looking-at org-todo-line-regexp))
  12861. (if (match-end 2)
  12862. (progn
  12863. (goto-char (match-end 2))
  12864. (insert " [#" news "]"))
  12865. (goto-char (match-beginning 3))
  12866. (insert "[#" news "] "))))
  12867. (org-set-tags nil 'align))
  12868. (if remove
  12869. (message "Priority removed")
  12870. (message "Priority of current item set to %s" news)))))
  12871. (defun org-show-priority ()
  12872. "Show the priority of the current item.
  12873. This priority is composed of the main priority given with the [#A] cookies,
  12874. and by additional input from the age of a schedules or deadline entry."
  12875. (interactive)
  12876. (let ((pri (if (eq major-mode 'org-agenda-mode)
  12877. (org-get-at-bol 'priority)
  12878. (save-excursion
  12879. (save-match-data
  12880. (beginning-of-line)
  12881. (and (looking-at org-heading-regexp)
  12882. (org-get-priority (match-string 0))))))))
  12883. (message "Priority is %d" (if pri pri -1000))))
  12884. (defun org-get-priority (s)
  12885. "Find priority cookie and return priority."
  12886. (save-match-data
  12887. (if (functionp org-get-priority-function)
  12888. (funcall org-get-priority-function)
  12889. (if (not (string-match org-priority-regexp s))
  12890. (* 1000 (- org-lowest-priority org-default-priority))
  12891. (* 1000 (- org-lowest-priority
  12892. (string-to-char (match-string 2 s))))))))
  12893. ;;;; Tags
  12894. (defvar org-agenda-archives-mode)
  12895. (defvar org-map-continue-from nil
  12896. "Position from where mapping should continue.
  12897. Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
  12898. (defvar org-scanner-tags nil
  12899. "The current tag list while the tags scanner is running.")
  12900. (defvar org-trust-scanner-tags nil
  12901. "Should `org-get-tags-at' use the tags for the scanner.
  12902. This is for internal dynamical scoping only.
  12903. When this is non-nil, the function `org-get-tags-at' will return the value
  12904. of `org-scanner-tags' instead of building the list by itself. This
  12905. can lead to large speed-ups when the tags scanner is used in a file with
  12906. many entries, and when the list of tags is retrieved, for example to
  12907. obtain a list of properties. Building the tags list for each entry in such
  12908. a file becomes an N^2 operation - but with this variable set, it scales
  12909. as N.")
  12910. (defvar org--matcher-tags-todo-only nil)
  12911. (defun org-scan-tags (action matcher todo-only &optional start-level)
  12912. "Scan headline tags with inheritance and produce output ACTION.
  12913. ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
  12914. or `agenda' to produce an entry list for an agenda view. It can also be
  12915. a Lisp form or a function that should be called at each matched headline, in
  12916. this case the return value is a list of all return values from these calls.
  12917. MATCHER is a function accepting three arguments, returning
  12918. a non-nil value whenever a given set of tags qualifies a headline
  12919. for inclusion. See `org-make-tags-matcher' for more information.
  12920. As a special case, it can also be set to t (respectively nil) in
  12921. order to match all (respectively none) headline.
  12922. When TODO-ONLY is non-nil, only lines with a not-done TODO
  12923. keyword are included in the output.
  12924. START-LEVEL can be a string with asterisks, reducing the scope to
  12925. headlines matching this string."
  12926. (require 'org-agenda)
  12927. (let* ((re (concat "^"
  12928. (if start-level
  12929. ;; Get the correct level to match
  12930. (concat "\\*\\{" (number-to-string start-level) "\\} ")
  12931. org-outline-regexp)
  12932. " *\\(\\<\\("
  12933. (mapconcat #'regexp-quote org-todo-keywords-1 "\\|")
  12934. "\\)\\>\\)? *\\(.*?\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*$"))
  12935. (props (list 'face 'default
  12936. 'done-face 'org-agenda-done
  12937. 'undone-face 'default
  12938. 'mouse-face 'highlight
  12939. 'org-not-done-regexp org-not-done-regexp
  12940. 'org-todo-regexp org-todo-regexp
  12941. 'org-complex-heading-regexp org-complex-heading-regexp
  12942. 'help-echo
  12943. (format "mouse-2 or RET jump to org file %s"
  12944. (abbreviate-file-name
  12945. (or (buffer-file-name (buffer-base-buffer))
  12946. (buffer-name (buffer-base-buffer)))))))
  12947. (org-map-continue-from nil)
  12948. lspos tags tags-list
  12949. (tags-alist (list (cons 0 org-file-tags)))
  12950. (llast 0) rtn rtn1 level category i txt
  12951. todo marker entry priority
  12952. ts-date ts-date-type ts-date-pair)
  12953. (unless (or (member action '(agenda sparse-tree)) (functionp action))
  12954. (setq action (list 'lambda nil action)))
  12955. (save-excursion
  12956. (goto-char (point-min))
  12957. (when (eq action 'sparse-tree)
  12958. (org-overview)
  12959. (org-remove-occur-highlights))
  12960. (while (let (case-fold-search)
  12961. (re-search-forward re nil t))
  12962. (setq org-map-continue-from nil)
  12963. (catch :skip
  12964. (setq todo
  12965. ;; TODO: is the 1-2 difference a bug?
  12966. (when (match-end 1) (match-string-no-properties 2))
  12967. tags (when (match-end 4) (match-string-no-properties 4)))
  12968. (goto-char (setq lspos (match-beginning 0)))
  12969. (setq level (org-reduced-level (org-outline-level))
  12970. category (org-get-category))
  12971. (when (eq action 'agenda)
  12972. (setq ts-date-pair (org-agenda-entry-get-agenda-timestamp (point))
  12973. ts-date (car ts-date-pair)
  12974. ts-date-type (cdr ts-date-pair)))
  12975. (setq i llast llast level)
  12976. ;; remove tag lists from same and sublevels
  12977. (while (>= i level)
  12978. (when (setq entry (assoc i tags-alist))
  12979. (setq tags-alist (delete entry tags-alist)))
  12980. (setq i (1- i)))
  12981. ;; add the next tags
  12982. (when tags
  12983. (setq tags (org-split-string tags ":")
  12984. tags-alist
  12985. (cons (cons level tags) tags-alist)))
  12986. ;; compile tags for current headline
  12987. (setq tags-list
  12988. (if org-use-tag-inheritance
  12989. (apply 'append (mapcar 'cdr (reverse tags-alist)))
  12990. tags)
  12991. org-scanner-tags tags-list)
  12992. (when org-use-tag-inheritance
  12993. (setcdr (car tags-alist)
  12994. (mapcar (lambda (x)
  12995. (setq x (copy-sequence x))
  12996. (org-add-prop-inherited x))
  12997. (cdar tags-alist))))
  12998. (when (and tags org-use-tag-inheritance
  12999. (or (not (eq t org-use-tag-inheritance))
  13000. org-tags-exclude-from-inheritance))
  13001. ;; Selective inheritance, remove uninherited ones.
  13002. (setcdr (car tags-alist)
  13003. (org-remove-uninherited-tags (cdar tags-alist))))
  13004. (when (and
  13005. ;; eval matcher only when the todo condition is OK
  13006. (and (or (not todo-only) (member todo org-not-done-keywords))
  13007. (if (functionp matcher)
  13008. (let ((case-fold-search t) (org-trust-scanner-tags t))
  13009. (funcall matcher todo tags-list level))
  13010. matcher))
  13011. ;; Call the skipper, but return t if it does not
  13012. ;; skip, so that the `and' form continues evaluating.
  13013. (progn
  13014. (unless (eq action 'sparse-tree) (org-agenda-skip))
  13015. t)
  13016. ;; Check if timestamps are deselecting this entry
  13017. (or (not todo-only)
  13018. (and (member todo org-not-done-keywords)
  13019. (or (not org-agenda-tags-todo-honor-ignore-options)
  13020. (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item))))))
  13021. ;; select this headline
  13022. (cond
  13023. ((eq action 'sparse-tree)
  13024. (and org-highlight-sparse-tree-matches
  13025. (org-get-heading) (match-end 0)
  13026. (org-highlight-new-match
  13027. (match-beginning 1) (match-end 1)))
  13028. (org-show-context 'tags-tree))
  13029. ((eq action 'agenda)
  13030. (setq txt (org-agenda-format-item
  13031. ""
  13032. (concat
  13033. (if (eq org-tags-match-list-sublevels 'indented)
  13034. (make-string (1- level) ?.) "")
  13035. (org-get-heading))
  13036. (make-string level ?\s)
  13037. category
  13038. tags-list)
  13039. priority (org-get-priority txt))
  13040. (goto-char lspos)
  13041. (setq marker (org-agenda-new-marker))
  13042. (org-add-props txt props
  13043. 'org-marker marker 'org-hd-marker marker 'org-category category
  13044. 'todo-state todo
  13045. 'ts-date ts-date
  13046. 'priority priority
  13047. 'type (concat "tagsmatch" ts-date-type))
  13048. (push txt rtn))
  13049. ((functionp action)
  13050. (setq org-map-continue-from nil)
  13051. (save-excursion
  13052. (setq rtn1 (funcall action))
  13053. (push rtn1 rtn)))
  13054. (t (user-error "Invalid action")))
  13055. ;; if we are to skip sublevels, jump to end of subtree
  13056. (unless org-tags-match-list-sublevels
  13057. (org-end-of-subtree t)
  13058. (backward-char 1))))
  13059. ;; Get the correct position from where to continue
  13060. (if org-map-continue-from
  13061. (goto-char org-map-continue-from)
  13062. (and (= (point) lspos) (end-of-line 1)))))
  13063. (when (and (eq action 'sparse-tree)
  13064. (not org-sparse-tree-open-archived-trees))
  13065. (org-hide-archived-subtrees (point-min) (point-max)))
  13066. (nreverse rtn)))
  13067. (defun org-remove-uninherited-tags (tags)
  13068. "Remove all tags that are not inherited from the list TAGS."
  13069. (cond
  13070. ((eq org-use-tag-inheritance t)
  13071. (if org-tags-exclude-from-inheritance
  13072. (org-delete-all org-tags-exclude-from-inheritance tags)
  13073. tags))
  13074. ((not org-use-tag-inheritance) nil)
  13075. ((stringp org-use-tag-inheritance)
  13076. (delq nil (mapcar
  13077. (lambda (x)
  13078. (if (and (string-match org-use-tag-inheritance x)
  13079. (not (member x org-tags-exclude-from-inheritance)))
  13080. x nil))
  13081. tags)))
  13082. ((listp org-use-tag-inheritance)
  13083. (delq nil (mapcar
  13084. (lambda (x)
  13085. (if (member x org-use-tag-inheritance) x nil))
  13086. tags)))))
  13087. (defun org-match-sparse-tree (&optional todo-only match)
  13088. "Create a sparse tree according to tags string MATCH.
  13089. MATCH is a string with match syntax. It can contain a selection
  13090. of tags (\"+work+urgent-boss\"), properties (\"LEVEL>3\"), and
  13091. TODO keywords (\"TODO=\\\"WAITING\\\"\") or a combination of
  13092. those. See the manual for details.
  13093. If optional argument TODO-ONLY is non-nil, only select lines that
  13094. are also TODO tasks."
  13095. (interactive "P")
  13096. (org-agenda-prepare-buffers (list (current-buffer)))
  13097. (let ((org--matcher-tags-todo-only todo-only))
  13098. (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match))
  13099. org--matcher-tags-todo-only)))
  13100. (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
  13101. (defvar org-cached-props nil)
  13102. (defun org-cached-entry-get (pom property)
  13103. (if (or (eq t org-use-property-inheritance)
  13104. (and (stringp org-use-property-inheritance)
  13105. (let ((case-fold-search t))
  13106. (string-match-p org-use-property-inheritance property)))
  13107. (and (listp org-use-property-inheritance)
  13108. (member-ignore-case property org-use-property-inheritance)))
  13109. ;; Caching is not possible, check it directly.
  13110. (org-entry-get pom property 'inherit)
  13111. ;; Get all properties, so we can do complicated checks easily.
  13112. (cdr (assoc-string property
  13113. (or org-cached-props
  13114. (setq org-cached-props (org-entry-properties pom)))
  13115. t))))
  13116. (defun org-global-tags-completion-table (&optional files)
  13117. "Return the list of all tags in all agenda buffer/files.
  13118. Optional FILES argument is a list of files which can be used
  13119. instead of the agenda files."
  13120. (save-excursion
  13121. (org-uniquify
  13122. (delq nil
  13123. (apply #'append
  13124. (mapcar
  13125. (lambda (file)
  13126. (set-buffer (find-file-noselect file))
  13127. (mapcar (lambda (x)
  13128. (and (stringp (car-safe x))
  13129. (list (car-safe x))))
  13130. (or org-current-tag-alist (org-get-buffer-tags))))
  13131. (if (car-safe files) files
  13132. (org-agenda-files))))))))
  13133. (defun org-make-tags-matcher (match)
  13134. "Create the TAGS/TODO matcher form for the selection string MATCH.
  13135. Returns a cons of the selection string MATCH and a function
  13136. implementing the matcher.
  13137. The matcher is to be called at an Org entry, with point on the
  13138. headline, and returns non-nil if the entry matches the selection
  13139. string MATCH. It must be called with three arguments: the TODO
  13140. keyword at the entry (or nil if none), the list of all tags at
  13141. the entry including inherited ones and the reduced level of the
  13142. headline. Additionally, the category of the entry, if any, must
  13143. be specified as the text property `org-category' on the headline.
  13144. This function sets the variable `org--matcher-tags-todo-only' to
  13145. a non-nil value if the matcher restricts matching to TODO
  13146. entries, otherwise it is not touched.
  13147. See also `org-scan-tags'."
  13148. (unless match
  13149. ;; Get a new match request, with completion against the global
  13150. ;; tags table and the local tags in current buffer.
  13151. (let ((org-last-tags-completion-table
  13152. (org-uniquify
  13153. (delq nil (append (org-get-buffer-tags)
  13154. (org-global-tags-completion-table))))))
  13155. (setq match
  13156. (completing-read
  13157. "Match: "
  13158. 'org-tags-completion-function nil nil nil 'org-tags-history))))
  13159. (let ((match0 match)
  13160. (re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)")
  13161. (start 0)
  13162. tagsmatch todomatch tagsmatcher todomatcher)
  13163. ;; Expand group tags.
  13164. (setq match (org-tags-expand match))
  13165. ;; Check if there is a TODO part of this match, which would be the
  13166. ;; part after a "/". To make sure that this slash is not part of
  13167. ;; a property value to be matched against, we also check that
  13168. ;; there is no / after that slash. First, find the last slash.
  13169. (let ((s 0))
  13170. (while (string-match "/+" match s)
  13171. (setq start (match-beginning 0))
  13172. (setq s (match-end 0))))
  13173. (if (and (string-match "/+" match start)
  13174. (not (string-match-p "\"" match start)))
  13175. ;; Match contains also a TODO-matching request.
  13176. (progn
  13177. (setq tagsmatch (substring match 0 (match-beginning 0)))
  13178. (setq todomatch (substring match (match-end 0)))
  13179. (when (string-prefix-p "!" todomatch)
  13180. (setq org--matcher-tags-todo-only t)
  13181. (setq todomatch (substring todomatch 1)))
  13182. (when (string-match "\\`\\s-*\\'" todomatch)
  13183. (setq todomatch nil)))
  13184. ;; Only matching tags.
  13185. (setq tagsmatch match)
  13186. (setq todomatch nil))
  13187. ;; Make the tags matcher.
  13188. (when (org-string-nw-p tagsmatch)
  13189. (let ((orlist nil)
  13190. (orterms (org-split-string tagsmatch "|"))
  13191. term)
  13192. (while (setq term (pop orterms))
  13193. (while (and (equal (substring term -1) "\\") orterms)
  13194. (setq term (concat term "|" (pop orterms)))) ;repair bad split.
  13195. (while (string-match re term)
  13196. (let* ((rest (substring term (match-end 0)))
  13197. (minus (and (match-end 1)
  13198. (equal (match-string 1 term) "-")))
  13199. (tag (save-match-data
  13200. (replace-regexp-in-string
  13201. "\\\\-" "-" (match-string 2 term))))
  13202. (regexp (eq (string-to-char tag) ?{))
  13203. (levelp (match-end 4))
  13204. (propp (match-end 5))
  13205. (mm
  13206. (cond
  13207. (regexp `(org-match-any-p ,(substring tag 1 -1) tags-list))
  13208. (levelp
  13209. `(,(org-op-to-function (match-string 3 term))
  13210. level
  13211. ,(string-to-number (match-string 4 term))))
  13212. (propp
  13213. (let* ((gv (pcase (upcase (match-string 5 term))
  13214. ("CATEGORY"
  13215. '(get-text-property (point) 'org-category))
  13216. ("TODO" 'todo)
  13217. (p `(org-cached-entry-get nil ,p))))
  13218. (pv (match-string 7 term))
  13219. (regexp (eq (string-to-char pv) ?{))
  13220. (strp (eq (string-to-char pv) ?\"))
  13221. (timep (string-match-p "^\"[[<].*[]>]\"$" pv))
  13222. (po (org-op-to-function (match-string 6 term)
  13223. (if timep 'time strp))))
  13224. (setq pv (if (or regexp strp) (substring pv 1 -1) pv))
  13225. (when timep (setq pv (org-matcher-time pv)))
  13226. (cond ((and regexp (eq po 'org<>))
  13227. `(not (string-match ,pv (or ,gv ""))))
  13228. (regexp `(string-match ,pv (or ,gv "")))
  13229. (strp `(,po (or ,gv "") ,pv))
  13230. (t
  13231. `(,po
  13232. (string-to-number (or ,gv ""))
  13233. ,(string-to-number pv))))))
  13234. (t `(member ,tag tags-list)))))
  13235. (push (if minus `(not ,mm) mm) tagsmatcher)
  13236. (setq term rest)))
  13237. (push `(and ,@tagsmatcher) orlist)
  13238. (setq tagsmatcher nil))
  13239. (setq tagsmatcher `(progn (setq org-cached-props nil) (or ,@orlist)))))
  13240. ;; Make the TODO matcher.
  13241. (when (org-string-nw-p todomatch)
  13242. (let ((orlist nil))
  13243. (dolist (term (org-split-string todomatch "|"))
  13244. (while (string-match re term)
  13245. (let* ((minus (and (match-end 1)
  13246. (equal (match-string 1 term) "-")))
  13247. (kwd (match-string 2 term))
  13248. (regexp (eq (string-to-char kwd) ?{))
  13249. (mm (if regexp `(string-match ,(substring kwd 1 -1) todo)
  13250. `(equal todo ,kwd))))
  13251. (push (if minus `(not ,mm) mm) todomatcher))
  13252. (setq term (substring term (match-end 0))))
  13253. (push (if (> (length todomatcher) 1)
  13254. (cons 'and todomatcher)
  13255. (car todomatcher))
  13256. orlist)
  13257. (setq todomatcher nil))
  13258. (setq todomatcher (cons 'or orlist))))
  13259. ;; Return the string and function of the matcher. If no
  13260. ;; tags-specific or todo-specific matcher exists, match
  13261. ;; everything.
  13262. (let ((matcher (if (and tagsmatcher todomatcher)
  13263. `(and ,tagsmatcher ,todomatcher)
  13264. (or tagsmatcher todomatcher t))))
  13265. (when org--matcher-tags-todo-only
  13266. (setq matcher `(and (member todo org-not-done-keywords) ,matcher)))
  13267. (cons match0 `(lambda (todo tags-list level) ,matcher)))))
  13268. (defun org-tags-expand (match &optional single-as-list downcased tags-already-expanded)
  13269. "Expand group tags in MATCH.
  13270. This replaces every group tag in MATCH with a regexp tag search.
  13271. For example, a group tag \"Work\" defined as { Work : Lab Conf }
  13272. will be replaced like this:
  13273. Work => {\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
  13274. +Work => +{\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
  13275. -Work => -{\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
  13276. Replacing by a regexp preserves the structure of the match.
  13277. E.g., this expansion
  13278. Work|Home => {\\(?:Work\\|Lab\\|Conf\\}|Home
  13279. will match anything tagged with \"Lab\" and \"Home\", or tagged
  13280. with \"Conf\" and \"Home\" or tagged with \"Work\" and \"home\".
  13281. A group tag in MATCH can contain regular expressions of its own.
  13282. For example, a group tag \"Proj\" defined as { Proj : {P@.+} }
  13283. will be replaced like this:
  13284. Proj => {\\<\\(?:Proj\\)\\>\\|P@.+}
  13285. When the optional argument SINGLE-AS-LIST is non-nil, MATCH is
  13286. assumed to be a single group tag, and the function will return
  13287. the list of tags in this group.
  13288. When DOWNCASE is non-nil, expand downcased TAGS."
  13289. (if org-group-tags
  13290. (let* ((case-fold-search t)
  13291. (stable org-mode-syntax-table)
  13292. (taggroups (or org-tag-groups-alist-for-agenda org-tag-groups-alist))
  13293. (taggroups (if downcased
  13294. (mapcar (lambda (tg) (mapcar #'downcase tg))
  13295. taggroups)
  13296. taggroups))
  13297. (taggroups-keys (mapcar #'car taggroups))
  13298. (return-match (if downcased (downcase match) match))
  13299. (count 0)
  13300. (work-already-expanded tags-already-expanded)
  13301. regexps-in-match tags-in-group regexp-in-group regexp-in-group-escaped)
  13302. ;; @ and _ are allowed as word-components in tags.
  13303. (modify-syntax-entry ?@ "w" stable)
  13304. (modify-syntax-entry ?_ "w" stable)
  13305. ;; Temporarily replace regexp-expressions in the match-expression.
  13306. (while (string-match "{.+?}" return-match)
  13307. (cl-incf count)
  13308. (push (match-string 0 return-match) regexps-in-match)
  13309. (setq return-match (replace-match (format "<%d>" count) t nil return-match)))
  13310. (while (and taggroups-keys
  13311. (with-syntax-table stable
  13312. (string-match
  13313. (concat "\\(?1:[+-]?\\)\\(?2:\\<"
  13314. (regexp-opt taggroups-keys) "\\>\\)")
  13315. return-match)))
  13316. (let* ((dir (match-string 1 return-match))
  13317. (tag (match-string 2 return-match))
  13318. (tag (if downcased (downcase tag) tag)))
  13319. (unless (or (get-text-property 0 'grouptag (match-string 2 return-match))
  13320. (member tag work-already-expanded))
  13321. (setq tags-in-group (assoc tag taggroups))
  13322. (push tag work-already-expanded)
  13323. ;; Recursively expand each tag in the group, if the tag hasn't
  13324. ;; already been expanded. Restore the match-data after all recursive calls.
  13325. (save-match-data
  13326. (let (tags-expanded)
  13327. (dolist (x (cdr tags-in-group))
  13328. (if (and (member x taggroups-keys)
  13329. (not (member x work-already-expanded)))
  13330. (setq tags-expanded
  13331. (delete-dups
  13332. (append
  13333. (org-tags-expand x t downcased
  13334. work-already-expanded)
  13335. tags-expanded)))
  13336. (setq tags-expanded
  13337. (append (list x) tags-expanded)))
  13338. (setq work-already-expanded
  13339. (delete-dups
  13340. (append tags-expanded
  13341. work-already-expanded))))
  13342. (setq tags-in-group
  13343. (delete-dups (cons (car tags-in-group)
  13344. tags-expanded)))))
  13345. ;; Filter tag-regexps from tags.
  13346. (setq regexp-in-group-escaped
  13347. (delq nil (mapcar (lambda (x)
  13348. (if (stringp x)
  13349. (and (equal "{" (substring x 0 1))
  13350. (equal "}" (substring x -1))
  13351. x)
  13352. x))
  13353. tags-in-group))
  13354. regexp-in-group
  13355. (mapcar (lambda (x)
  13356. (substring x 1 -1))
  13357. regexp-in-group-escaped)
  13358. tags-in-group
  13359. (delq nil (mapcar (lambda (x)
  13360. (if (stringp x)
  13361. (and (not (equal "{" (substring x 0 1)))
  13362. (not (equal "}" (substring x -1)))
  13363. x)
  13364. x))
  13365. tags-in-group)))
  13366. ;; If single-as-list, do no more in the while-loop.
  13367. (if (not single-as-list)
  13368. (progn
  13369. (when regexp-in-group
  13370. (setq regexp-in-group
  13371. (concat "\\|"
  13372. (mapconcat 'identity regexp-in-group
  13373. "\\|"))))
  13374. (setq tags-in-group
  13375. (concat dir
  13376. "{\\<"
  13377. (regexp-opt tags-in-group)
  13378. "\\>"
  13379. regexp-in-group
  13380. "}"))
  13381. (when (stringp tags-in-group)
  13382. (org-add-props tags-in-group '(grouptag t)))
  13383. (setq return-match
  13384. (replace-match tags-in-group t t return-match)))
  13385. (setq tags-in-group
  13386. (append regexp-in-group-escaped tags-in-group))))
  13387. (setq taggroups-keys (delete tag taggroups-keys))))
  13388. ;; Add the regular expressions back into the match-expression again.
  13389. (while regexps-in-match
  13390. (setq return-match (replace-regexp-in-string (format "<%d>" count)
  13391. (pop regexps-in-match)
  13392. return-match t t))
  13393. (cl-decf count))
  13394. (if single-as-list
  13395. (if tags-in-group tags-in-group (list return-match))
  13396. return-match))
  13397. (if single-as-list
  13398. (list (if downcased (downcase match) match))
  13399. match)))
  13400. (defun org-op-to-function (op &optional stringp)
  13401. "Turn an operator into the appropriate function."
  13402. (setq op
  13403. (cond
  13404. ((equal op "<" ) '(< string< org-time<))
  13405. ((equal op ">" ) '(> org-string> org-time>))
  13406. ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
  13407. ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
  13408. ((member op '("=" "==")) '(= string= org-time=))
  13409. ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
  13410. (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
  13411. (defun org<> (a b) (not (= a b)))
  13412. (defun org-string<= (a b) (or (string= a b) (string< a b)))
  13413. (defun org-string>= (a b) (not (string< a b)))
  13414. (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
  13415. (defun org-string<> (a b) (not (string= a b)))
  13416. (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
  13417. (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
  13418. (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
  13419. (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
  13420. (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
  13421. (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
  13422. (defun org-2ft (s)
  13423. "Convert S to a floating point time.
  13424. If S is already a number, just return it. If it is a string, parse
  13425. it as a time string and apply `float-time' to it. If S is nil, just return 0."
  13426. (cond
  13427. ((numberp s) s)
  13428. ((stringp s)
  13429. (condition-case nil
  13430. (float-time (apply 'encode-time (org-parse-time-string s)))
  13431. (error 0.)))
  13432. (t 0.)))
  13433. (defun org-time-today ()
  13434. "Time in seconds today at 0:00.
  13435. Returns the float number of seconds since the beginning of the
  13436. epoch to the beginning of today (00:00)."
  13437. (float-time (apply 'encode-time
  13438. (append '(0 0 0) (nthcdr 3 (decode-time))))))
  13439. (defun org-matcher-time (s)
  13440. "Interpret a time comparison value."
  13441. (save-match-data
  13442. (cond
  13443. ((string= s "<now>") (float-time))
  13444. ((string= s "<today>") (org-time-today))
  13445. ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
  13446. ((string= s "<yesterday>") (- (org-time-today) 86400.0))
  13447. ((string-match "^<\\([-+][0-9]+\\)\\([hdwmy]\\)>$" s)
  13448. (+ (org-time-today)
  13449. (* (string-to-number (match-string 1 s))
  13450. (cdr (assoc (match-string 2 s)
  13451. '(("d" . 86400.0) ("w" . 604800.0)
  13452. ("m" . 2678400.0) ("y" . 31557600.0)))))))
  13453. (t (org-2ft s)))))
  13454. (defun org-match-any-p (re list)
  13455. "Does re match any element of list?"
  13456. (setq list (mapcar (lambda (x) (string-match re x)) list))
  13457. (delq nil list))
  13458. (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
  13459. (defvar org-tags-overlay (make-overlay 1 1))
  13460. (delete-overlay org-tags-overlay)
  13461. (defun org-get-local-tags-at (&optional pos)
  13462. "Get a list of tags defined in the current headline."
  13463. (org-get-tags-at pos 'local))
  13464. (defun org-get-local-tags ()
  13465. "Get a list of tags defined in the current headline."
  13466. (org-get-tags-at nil 'local))
  13467. (defun org-get-tags-at (&optional pos local)
  13468. "Get a list of all headline tags applicable at POS.
  13469. POS defaults to point. If tags are inherited, the list contains
  13470. the targets in the same sequence as the headlines appear, i.e.
  13471. the tags of the current headline come last.
  13472. When LOCAL is non-nil, only return tags from the current headline,
  13473. ignore inherited ones."
  13474. (interactive)
  13475. (if (and org-trust-scanner-tags
  13476. (or (not pos) (equal pos (point)))
  13477. (not local))
  13478. org-scanner-tags
  13479. (let (tags ltags lastpos parent)
  13480. (save-excursion
  13481. (save-restriction
  13482. (widen)
  13483. (goto-char (or pos (point)))
  13484. (save-match-data
  13485. (catch 'done
  13486. (condition-case nil
  13487. (progn
  13488. (org-back-to-heading t)
  13489. (while (not (equal lastpos (point)))
  13490. (setq lastpos (point))
  13491. (when (looking-at ".+?:\\([[:alnum:]_@#%:]+\\):[ \t]*$")
  13492. (setq ltags (org-split-string
  13493. (match-string-no-properties 1) ":"))
  13494. (when parent
  13495. (setq ltags (mapcar 'org-add-prop-inherited ltags)))
  13496. (setq tags (append
  13497. (if parent
  13498. (org-remove-uninherited-tags ltags)
  13499. ltags)
  13500. tags)))
  13501. (or org-use-tag-inheritance (throw 'done t))
  13502. (when local (throw 'done t))
  13503. (or (org-up-heading-safe) (error nil))
  13504. (setq parent t)))
  13505. (error nil)))))
  13506. (if local
  13507. tags
  13508. (reverse (delete-dups
  13509. (reverse (append
  13510. (org-remove-uninherited-tags
  13511. org-file-tags)
  13512. tags)))))))))
  13513. (defun org-add-prop-inherited (s)
  13514. (add-text-properties 0 (length s) '(inherited t) s)
  13515. s)
  13516. (defun org-toggle-tag (tag &optional onoff)
  13517. "Toggle the tag TAG for the current line.
  13518. If ONOFF is `on' or `off', don't toggle but set to this state."
  13519. (let (res current)
  13520. (save-excursion
  13521. (org-back-to-heading t)
  13522. (if (re-search-forward "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t]*$"
  13523. (point-at-eol) t)
  13524. (progn
  13525. (setq current (match-string 1))
  13526. (replace-match ""))
  13527. (setq current ""))
  13528. (setq current (nreverse (org-split-string current ":")))
  13529. (cond
  13530. ((eq onoff 'on)
  13531. (setq res t)
  13532. (or (member tag current) (push tag current)))
  13533. ((eq onoff 'off)
  13534. (or (not (member tag current)) (setq current (delete tag current))))
  13535. (t (if (member tag current)
  13536. (setq current (delete tag current))
  13537. (setq res t)
  13538. (push tag current))))
  13539. (end-of-line 1)
  13540. (if current
  13541. (progn
  13542. (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
  13543. (org-set-tags nil t))
  13544. (delete-horizontal-space))
  13545. (run-hooks 'org-after-tags-change-hook))
  13546. res))
  13547. (defun org--align-tags-here (to-col)
  13548. "Align tags on the current headline to TO-COL.
  13549. Assume point is on a headline."
  13550. (let ((pos (point)))
  13551. (beginning-of-line)
  13552. (if (or (not (looking-at ".*?\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
  13553. (>= pos (match-beginning 2)))
  13554. ;; No tags or point within tags: do not align.
  13555. (goto-char pos)
  13556. (goto-char (match-beginning 1))
  13557. (let ((shift (max (- (if (>= to-col 0) to-col
  13558. (- (abs to-col) (string-width (match-string 2))))
  13559. (current-column))
  13560. 1)))
  13561. (replace-match (make-string shift ?\s) nil nil nil 1)
  13562. ;; Preserve initial position, if possible. In any case, stop
  13563. ;; before tags.
  13564. (when (< pos (point)) (goto-char pos))))))
  13565. (defun org-set-tags-command (&optional arg just-align)
  13566. "Call the set-tags command for the current entry."
  13567. (interactive "P")
  13568. (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
  13569. (org-set-tags arg just-align)
  13570. (save-excursion
  13571. (unless (and (org-region-active-p)
  13572. org-loop-over-headlines-in-active-region)
  13573. (org-back-to-heading t))
  13574. (org-set-tags arg just-align))))
  13575. (defun org-set-tags-to (data)
  13576. "Set the tags of the current entry to DATA, replacing the current tags.
  13577. DATA may be a tags string like :aa:bb:cc:, or a list of tags.
  13578. If DATA is nil or the empty string, any tags will be removed."
  13579. (interactive "sTags: ")
  13580. (setq data
  13581. (cond
  13582. ((eq data nil) "")
  13583. ((equal data "") "")
  13584. ((stringp data)
  13585. (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
  13586. ":"))
  13587. ((listp data)
  13588. (concat ":" (mapconcat 'identity data ":") ":"))))
  13589. (when data
  13590. (save-excursion
  13591. (org-back-to-heading t)
  13592. (when (let ((case-fold-search nil))
  13593. (looking-at org-complex-heading-regexp))
  13594. (if (match-end 5)
  13595. (progn
  13596. (goto-char (match-beginning 5))
  13597. (insert data)
  13598. (delete-region (point) (point-at-eol))
  13599. (org-set-tags nil 'align))
  13600. (goto-char (point-at-eol))
  13601. (insert " " data)
  13602. (org-set-tags nil 'align)))
  13603. (beginning-of-line 1)
  13604. (when (looking-at ".*?\\([ \t]+\\)$")
  13605. (delete-region (match-beginning 1) (match-end 1))))))
  13606. (defun org-align-all-tags ()
  13607. "Align the tags in all headings."
  13608. (interactive)
  13609. (save-excursion
  13610. (or (ignore-errors (org-back-to-heading t))
  13611. (outline-next-heading))
  13612. (if (org-at-heading-p)
  13613. (org-set-tags t)
  13614. (message "No headings"))))
  13615. (defvar org-indent-indentation-per-level)
  13616. (defun org-set-tags (&optional arg just-align)
  13617. "Set the tags for the current headline.
  13618. With prefix ARG, realign all tags in headings in the current buffer.
  13619. When JUST-ALIGN is non-nil, only align tags."
  13620. (interactive "P")
  13621. (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
  13622. (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
  13623. 'region-start-level
  13624. 'region))
  13625. org-loop-over-headlines-in-active-region)
  13626. (org-map-entries
  13627. ;; We don't use ARG and JUST-ALIGN here because these args
  13628. ;; are not useful when looping over headlines.
  13629. #'org-set-tags
  13630. org-loop-over-headlines-in-active-region
  13631. cl
  13632. '(when (outline-invisible-p) (org-end-of-subtree nil t))))
  13633. (let ((org-setting-tags t))
  13634. (if arg
  13635. (save-excursion
  13636. (goto-char (point-min))
  13637. (while (re-search-forward org-outline-regexp-bol nil t)
  13638. (org-set-tags nil t)
  13639. (end-of-line))
  13640. (message "All tags realigned to column %d" org-tags-column))
  13641. (let* ((current (org-get-tags-string))
  13642. (tags
  13643. (if just-align current
  13644. ;; Get a new set of tags from the user.
  13645. (save-excursion
  13646. (let* ((seen)
  13647. (table
  13648. (setq
  13649. org-last-tags-completion-table
  13650. ;; Uniquify tags in alists, yet preserve
  13651. ;; structure (i.e., keywords).
  13652. (delq nil
  13653. (mapcar
  13654. (lambda (pair)
  13655. (let ((head (car pair)))
  13656. (cond ((symbolp head) pair)
  13657. ((member head seen) nil)
  13658. (t (push head seen)
  13659. pair))))
  13660. (append
  13661. (or org-current-tag-alist
  13662. (org-get-buffer-tags))
  13663. (and
  13664. org-complete-tags-always-offer-all-agenda-tags
  13665. (org-global-tags-completion-table
  13666. (org-agenda-files))))))))
  13667. (current-tags (org-split-string current ":"))
  13668. (inherited-tags
  13669. (nreverse (nthcdr (length current-tags)
  13670. (nreverse (org-get-tags-at))))))
  13671. (replace-regexp-in-string
  13672. "\\([-+&]+\\|,\\)"
  13673. ":"
  13674. (if (or (eq t org-use-fast-tag-selection)
  13675. (and org-use-fast-tag-selection
  13676. (delq nil (mapcar #'cdr table))))
  13677. (org-fast-tag-selection
  13678. current-tags inherited-tags table
  13679. (and org-fast-tag-selection-include-todo
  13680. org-todo-key-alist))
  13681. (let ((org-add-colon-after-tag-completion
  13682. (< 1 (length table))))
  13683. (org-trim
  13684. (completing-read
  13685. "Tags: "
  13686. #'org-tags-completion-function
  13687. nil nil current 'org-tags-history))))))))))
  13688. (when org-tags-sort-function
  13689. (setq tags
  13690. (mapconcat
  13691. #'identity
  13692. (sort (org-split-string tags "[^[:alnum:]_@#%]+")
  13693. org-tags-sort-function)
  13694. ":")))
  13695. (if (not (org-string-nw-p tags)) (setq tags "")
  13696. (unless (string-suffix-p ":" tags) (setq tags (concat tags ":")))
  13697. (unless (string-prefix-p ":" tags) (setq tags (concat ":" tags))))
  13698. ;; Insert new tags at the correct column.
  13699. (unless (equal current tags)
  13700. (save-excursion
  13701. (beginning-of-line)
  13702. (let ((case-fold-search nil))
  13703. (looking-at org-complex-heading-regexp))
  13704. ;; Remove current tags, if any.
  13705. (when (match-end 5) (replace-match "" nil nil nil 5))
  13706. ;; Insert new tags, if any. Otherwise, remove trailing
  13707. ;; white spaces.
  13708. (end-of-line)
  13709. (if (not (equal tags ""))
  13710. ;; When text is being inserted on an invisible
  13711. ;; region boundary, it can be inadvertently sucked
  13712. ;; into invisibility.
  13713. (outline-flag-region (point) (progn (insert " " tags) (point)) nil)
  13714. (skip-chars-backward " \t")
  13715. (delete-region (point) (line-end-position)))))
  13716. ;; Align tags, if any. Fix tags column if `org-indent-mode'
  13717. ;; is on.
  13718. (unless (equal tags "")
  13719. (let* ((level (save-excursion
  13720. (beginning-of-line)
  13721. (skip-chars-forward "\\*")))
  13722. (offset (if (bound-and-true-p org-indent-mode)
  13723. (* (1- org-indent-indentation-per-level)
  13724. (1- level))
  13725. 0))
  13726. (tags-column
  13727. (+ org-tags-column
  13728. (if (> org-tags-column 0) (- offset) offset))))
  13729. (org--align-tags-here tags-column))))
  13730. (unless just-align (run-hooks 'org-after-tags-change-hook))))))
  13731. (defun org-change-tag-in-region (beg end tag off)
  13732. "Add or remove TAG for each entry in the region.
  13733. This works in the agenda, and also in an Org buffer."
  13734. (interactive
  13735. (list (region-beginning) (region-end)
  13736. (let ((org-last-tags-completion-table
  13737. (if (derived-mode-p 'org-mode)
  13738. (org-uniquify
  13739. (delq nil (append (org-get-buffer-tags)
  13740. (org-global-tags-completion-table))))
  13741. (org-global-tags-completion-table))))
  13742. (completing-read
  13743. "Tag: " 'org-tags-completion-function nil nil nil
  13744. 'org-tags-history))
  13745. (progn
  13746. (message "[s]et or [r]emove? ")
  13747. (equal (read-char-exclusive) ?r))))
  13748. (when (fboundp 'deactivate-mark) (deactivate-mark))
  13749. (let ((agendap (equal major-mode 'org-agenda-mode))
  13750. l1 l2 m buf pos newhead (cnt 0))
  13751. (goto-char end)
  13752. (setq l2 (1- (org-current-line)))
  13753. (goto-char beg)
  13754. (setq l1 (org-current-line))
  13755. (cl-loop for l from l1 to l2 do
  13756. (org-goto-line l)
  13757. (setq m (get-text-property (point) 'org-hd-marker))
  13758. (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
  13759. (and agendap m))
  13760. (setq buf (if agendap (marker-buffer m) (current-buffer))
  13761. pos (if agendap m (point)))
  13762. (with-current-buffer buf
  13763. (save-excursion
  13764. (save-restriction
  13765. (goto-char pos)
  13766. (setq cnt (1+ cnt))
  13767. (org-toggle-tag tag (if off 'off 'on))
  13768. (setq newhead (org-get-heading)))))
  13769. (and agendap (org-agenda-change-all-lines newhead m))))
  13770. (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
  13771. (defun org-tags-completion-function (string _predicate &optional flag)
  13772. (let (s1 s2 rtn (ctable org-last-tags-completion-table)
  13773. (confirm (lambda (x) (stringp (car x)))))
  13774. (if (string-match "^\\(.*[-+:&,|]\\)\\([^-+:&,|]*\\)$" string)
  13775. (setq s1 (match-string 1 string)
  13776. s2 (match-string 2 string))
  13777. (setq s1 "" s2 string))
  13778. (cond
  13779. ((eq flag nil)
  13780. ;; try completion
  13781. (setq rtn (try-completion s2 ctable confirm))
  13782. (when (stringp rtn)
  13783. (setq rtn
  13784. (concat s1 s2 (substring rtn (length s2))
  13785. (if (and org-add-colon-after-tag-completion
  13786. (assoc rtn ctable))
  13787. ":" ""))))
  13788. rtn)
  13789. ((eq flag t)
  13790. ;; all-completions
  13791. (all-completions s2 ctable confirm))
  13792. ((eq flag 'lambda)
  13793. ;; exact match?
  13794. (assoc s2 ctable)))))
  13795. (defun org-fast-tag-insert (kwd tags face &optional end)
  13796. "Insert KDW, and the TAGS, the latter with face FACE.
  13797. Also insert END."
  13798. (insert (format "%-12s" (concat kwd ":"))
  13799. (org-add-props (mapconcat 'identity tags " ") nil 'face face)
  13800. (or end "")))
  13801. (defun org-fast-tag-show-exit (flag)
  13802. (save-excursion
  13803. (org-goto-line 3)
  13804. (when (re-search-forward "[ \t]+Next change exits" (point-at-eol) t)
  13805. (replace-match ""))
  13806. (when flag
  13807. (end-of-line 1)
  13808. (org-move-to-column (- (window-width) 19) t)
  13809. (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
  13810. (defun org-set-current-tags-overlay (current prefix)
  13811. "Add an overlay to CURRENT tag with PREFIX."
  13812. (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
  13813. (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
  13814. (org-overlay-display org-tags-overlay (concat prefix s))))
  13815. (defvar org-last-tag-selection-key nil)
  13816. (defun org-fast-tag-selection (current inherited table &optional todo-table)
  13817. "Fast tag selection with single keys.
  13818. CURRENT is the current list of tags in the headline, INHERITED is the
  13819. list of inherited tags, and TABLE is an alist of tags and corresponding keys,
  13820. possibly with grouping information. TODO-TABLE is a similar table with
  13821. TODO keywords, should these have keys assigned to them.
  13822. If the keys are nil, a-z are automatically assigned.
  13823. Returns the new tags string, or nil to not change the current settings."
  13824. (let* ((fulltable (append table todo-table))
  13825. (maxlen (apply 'max (mapcar
  13826. (lambda (x)
  13827. (if (stringp (car x)) (string-width (car x)) 0))
  13828. fulltable)))
  13829. (buf (current-buffer))
  13830. (expert (eq org-fast-tag-selection-single-key 'expert))
  13831. (buffer-tags nil)
  13832. (fwidth (+ maxlen 3 1 3))
  13833. (ncol (/ (- (window-width) 4) fwidth))
  13834. (i-face 'org-done)
  13835. (c-face 'org-todo)
  13836. tg cnt e c char c1 c2 ntable tbl rtn
  13837. ov-start ov-end ov-prefix
  13838. (exit-after-next org-fast-tag-selection-single-key)
  13839. (done-keywords org-done-keywords)
  13840. groups ingroup intaggroup)
  13841. (save-excursion
  13842. (beginning-of-line 1)
  13843. (if (looking-at ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")
  13844. (setq ov-start (match-beginning 1)
  13845. ov-end (match-end 1)
  13846. ov-prefix "")
  13847. (setq ov-start (1- (point-at-eol))
  13848. ov-end (1+ ov-start))
  13849. (skip-chars-forward "^\n\r")
  13850. (setq ov-prefix
  13851. (concat
  13852. (buffer-substring (1- (point)) (point))
  13853. (if (> (current-column) org-tags-column)
  13854. " "
  13855. (make-string (- org-tags-column (current-column)) ?\ ))))))
  13856. (move-overlay org-tags-overlay ov-start ov-end)
  13857. (save-window-excursion
  13858. (if expert
  13859. (set-buffer (get-buffer-create " *Org tags*"))
  13860. (delete-other-windows)
  13861. (set-window-buffer (split-window-vertically) (get-buffer-create " *Org tags*"))
  13862. (org-switch-to-buffer-other-window " *Org tags*"))
  13863. (erase-buffer)
  13864. (setq-local org-done-keywords done-keywords)
  13865. (org-fast-tag-insert "Inherited" inherited i-face "\n")
  13866. (org-fast-tag-insert "Current" current c-face "\n\n")
  13867. (org-fast-tag-show-exit exit-after-next)
  13868. (org-set-current-tags-overlay current ov-prefix)
  13869. (setq tbl fulltable char ?a cnt 0)
  13870. (while (setq e (pop tbl))
  13871. (cond
  13872. ((eq (car e) :startgroup)
  13873. (push '() groups) (setq ingroup t)
  13874. (unless (zerop cnt)
  13875. (setq cnt 0)
  13876. (insert "\n"))
  13877. (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
  13878. ((eq (car e) :endgroup)
  13879. (setq ingroup nil cnt 0)
  13880. (insert "}" (if (cdr e) (format " (%s) " (cdr e)) "") "\n"))
  13881. ((eq (car e) :startgrouptag)
  13882. (setq intaggroup t)
  13883. (unless (zerop cnt)
  13884. (setq cnt 0)
  13885. (insert "\n"))
  13886. (insert "[ "))
  13887. ((eq (car e) :endgrouptag)
  13888. (setq intaggroup nil cnt 0)
  13889. (insert "]\n"))
  13890. ((equal e '(:newline))
  13891. (unless (zerop cnt)
  13892. (setq cnt 0)
  13893. (insert "\n")
  13894. (setq e (car tbl))
  13895. (while (equal (car tbl) '(:newline))
  13896. (insert "\n")
  13897. (setq tbl (cdr tbl)))))
  13898. ((equal e '(:grouptags)) (insert " : "))
  13899. (t
  13900. (setq tg (copy-sequence (car e)) c2 nil)
  13901. (if (cdr e)
  13902. (setq c (cdr e))
  13903. ;; automatically assign a character.
  13904. (setq c1 (string-to-char
  13905. (downcase (substring
  13906. tg (if (= (string-to-char tg) ?@) 1 0)))))
  13907. (if (or (rassoc c1 ntable) (rassoc c1 table))
  13908. (while (or (rassoc char ntable) (rassoc char table))
  13909. (setq char (1+ char)))
  13910. (setq c2 c1))
  13911. (setq c (or c2 char)))
  13912. (when ingroup (push tg (car groups)))
  13913. (setq tg (org-add-props tg nil 'face
  13914. (cond
  13915. ((not (assoc tg table))
  13916. (org-get-todo-face tg))
  13917. ((member tg current) c-face)
  13918. ((member tg inherited) i-face))))
  13919. (when (equal (caar tbl) :grouptags)
  13920. (org-add-props tg nil 'face 'org-tag-group))
  13921. (when (and (zerop cnt) (not ingroup) (not intaggroup)) (insert " "))
  13922. (insert "[" c "] " tg (make-string
  13923. (- fwidth 4 (length tg)) ?\ ))
  13924. (push (cons tg c) ntable)
  13925. (when (= (cl-incf cnt) ncol)
  13926. (insert "\n")
  13927. (when (or ingroup intaggroup) (insert " "))
  13928. (setq cnt 0)))))
  13929. (setq ntable (nreverse ntable))
  13930. (insert "\n")
  13931. (goto-char (point-min))
  13932. (unless expert (org-fit-window-to-buffer))
  13933. (setq rtn
  13934. (catch 'exit
  13935. (while t
  13936. (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
  13937. (if (not groups) "no " "")
  13938. (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
  13939. (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
  13940. (setq org-last-tag-selection-key c)
  13941. (cond
  13942. ((= c ?\r) (throw 'exit t))
  13943. ((= c ?!)
  13944. (setq groups (not groups))
  13945. (goto-char (point-min))
  13946. (while (re-search-forward "[{}]" nil t) (replace-match " ")))
  13947. ((= c ?\C-c)
  13948. (if (not expert)
  13949. (org-fast-tag-show-exit
  13950. (setq exit-after-next (not exit-after-next)))
  13951. (setq expert nil)
  13952. (delete-other-windows)
  13953. (set-window-buffer (split-window-vertically) " *Org tags*")
  13954. (org-switch-to-buffer-other-window " *Org tags*")
  13955. (org-fit-window-to-buffer)))
  13956. ((or (= c ?\C-g)
  13957. (and (= c ?q) (not (rassoc c ntable))))
  13958. (delete-overlay org-tags-overlay)
  13959. (setq quit-flag t))
  13960. ((= c ?\ )
  13961. (setq current nil)
  13962. (when exit-after-next (setq exit-after-next 'now)))
  13963. ((= c ?\t)
  13964. (condition-case nil
  13965. (setq tg (completing-read
  13966. "Tag: "
  13967. (or buffer-tags
  13968. (with-current-buffer buf
  13969. (setq buffer-tags
  13970. (org-get-buffer-tags))))))
  13971. (quit (setq tg "")))
  13972. (when (string-match "\\S-" tg)
  13973. (cl-pushnew (list tg) buffer-tags :test #'equal)
  13974. (if (member tg current)
  13975. (setq current (delete tg current))
  13976. (push tg current)))
  13977. (when exit-after-next (setq exit-after-next 'now)))
  13978. ((setq e (rassoc c todo-table) tg (car e))
  13979. (with-current-buffer buf
  13980. (save-excursion (org-todo tg)))
  13981. (when exit-after-next (setq exit-after-next 'now)))
  13982. ((setq e (rassoc c ntable) tg (car e))
  13983. (if (member tg current)
  13984. (setq current (delete tg current))
  13985. (cl-loop for g in groups do
  13986. (when (member tg g)
  13987. (dolist (x g) (setq current (delete x current)))))
  13988. (push tg current))
  13989. (when exit-after-next (setq exit-after-next 'now))))
  13990. ;; Create a sorted list
  13991. (setq current
  13992. (sort current
  13993. (lambda (a b)
  13994. (assoc b (cdr (memq (assoc a ntable) ntable))))))
  13995. (when (eq exit-after-next 'now) (throw 'exit t))
  13996. (goto-char (point-min))
  13997. (beginning-of-line 2)
  13998. (delete-region (point) (point-at-eol))
  13999. (org-fast-tag-insert "Current" current c-face)
  14000. (org-set-current-tags-overlay current ov-prefix)
  14001. (while (re-search-forward "\\[.\\] \\([[:alnum:]_@#%]+\\)" nil t)
  14002. (setq tg (match-string 1))
  14003. (add-text-properties
  14004. (match-beginning 1) (match-end 1)
  14005. (list 'face
  14006. (cond
  14007. ((member tg current) c-face)
  14008. ((member tg inherited) i-face)
  14009. (t (get-text-property (match-beginning 1) 'face))))))
  14010. (goto-char (point-min)))))
  14011. (delete-overlay org-tags-overlay)
  14012. (if rtn
  14013. (mapconcat 'identity current ":")
  14014. nil))))
  14015. (defun org-get-tags-string ()
  14016. "Get the TAGS string in the current headline."
  14017. (unless (org-at-heading-p t)
  14018. (user-error "Not on a heading"))
  14019. (save-excursion
  14020. (beginning-of-line 1)
  14021. (if (looking-at ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")
  14022. (match-string-no-properties 1)
  14023. "")))
  14024. (defun org-get-tags ()
  14025. "Get the list of tags specified in the current headline."
  14026. (org-split-string (org-get-tags-string) ":"))
  14027. (defun org-get-buffer-tags ()
  14028. "Get a table of all tags used in the buffer, for completion."
  14029. (org-with-wide-buffer
  14030. (goto-char (point-min))
  14031. (let ((tag-re (concat org-outline-regexp-bol
  14032. "\\(?:.*?[ \t]\\)?:\\([[:alnum:]_@#%:]+\\):[ \t]*$"))
  14033. tags)
  14034. (while (re-search-forward tag-re nil t)
  14035. (dolist (tag (org-split-string (match-string-no-properties 1) ":"))
  14036. (push tag tags)))
  14037. (mapcar #'list (append org-file-tags (org-uniquify tags))))))
  14038. ;;;; The mapping API
  14039. (defvar org-agenda-skip-comment-trees)
  14040. (defvar org-agenda-skip-function)
  14041. (defun org-map-entries (func &optional match scope &rest skip)
  14042. "Call FUNC at each headline selected by MATCH in SCOPE.
  14043. FUNC is a function or a lisp form. The function will be called without
  14044. arguments, with the cursor positioned at the beginning of the headline.
  14045. The return values of all calls to the function will be collected and
  14046. returned as a list.
  14047. The call to FUNC will be wrapped into a save-excursion form, so FUNC
  14048. does not need to preserve point. After evaluation, the cursor will be
  14049. moved to the end of the line (presumably of the headline of the
  14050. processed entry) and search continues from there. Under some
  14051. circumstances, this may not produce the wanted results. For example,
  14052. if you have removed (e.g. archived) the current (sub)tree it could
  14053. mean that the next entry will be skipped entirely. In such cases, you
  14054. can specify the position from where search should continue by making
  14055. FUNC set the variable `org-map-continue-from' to the desired buffer
  14056. position.
  14057. MATCH is a tags/property/todo match as it is used in the agenda tags view.
  14058. Only headlines that are matched by this query will be considered during
  14059. the iteration. When MATCH is nil or t, all headlines will be
  14060. visited by the iteration.
  14061. SCOPE determines the scope of this command. It can be any of:
  14062. nil The current buffer, respecting the restriction if any
  14063. tree The subtree started with the entry at point
  14064. region The entries within the active region, if any
  14065. region-start-level
  14066. The entries within the active region, but only those at
  14067. the same level than the first one.
  14068. file The current buffer, without restriction
  14069. file-with-archives
  14070. The current buffer, and any archives associated with it
  14071. agenda All agenda files
  14072. agenda-with-archives
  14073. All agenda files with any archive files associated with them
  14074. \(file1 file2 ...)
  14075. If this is a list, all files in the list will be scanned
  14076. The remaining args are treated as settings for the skipping facilities of
  14077. the scanner. The following items can be given here:
  14078. archive skip trees with the archive tag
  14079. comment skip trees with the COMMENT keyword
  14080. function or Emacs Lisp form:
  14081. will be used as value for `org-agenda-skip-function', so
  14082. whenever the function returns a position, FUNC will not be
  14083. called for that entry and search will continue from the
  14084. position returned
  14085. If your function needs to retrieve the tags including inherited tags
  14086. at the *current* entry, you can use the value of the variable
  14087. `org-scanner-tags' which will be much faster than getting the value
  14088. with `org-get-tags-at'. If your function gets properties with
  14089. `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
  14090. to t around the call to `org-entry-properties' to get the same speedup.
  14091. Note that if your function moves around to retrieve tags and properties at
  14092. a *different* entry, you cannot use these techniques."
  14093. (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
  14094. (not (org-region-active-p)))
  14095. (let* ((org-agenda-archives-mode nil) ; just to make sure
  14096. (org-agenda-skip-archived-trees (memq 'archive skip))
  14097. (org-agenda-skip-comment-trees (memq 'comment skip))
  14098. (org-agenda-skip-function
  14099. (car (org-delete-all '(comment archive) skip)))
  14100. (org-tags-match-list-sublevels t)
  14101. (start-level (eq scope 'region-start-level))
  14102. matcher res
  14103. org-todo-keywords-for-agenda
  14104. org-done-keywords-for-agenda
  14105. org-todo-keyword-alist-for-agenda
  14106. org-tag-alist-for-agenda
  14107. org--matcher-tags-todo-only)
  14108. (cond
  14109. ((eq match t) (setq matcher t))
  14110. ((eq match nil) (setq matcher t))
  14111. (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
  14112. (save-excursion
  14113. (save-restriction
  14114. (cond ((eq scope 'tree)
  14115. (org-back-to-heading t)
  14116. (org-narrow-to-subtree)
  14117. (setq scope nil))
  14118. ((and (or (eq scope 'region) (eq scope 'region-start-level))
  14119. (org-region-active-p))
  14120. ;; If needed, set start-level to a string like "2"
  14121. (when start-level
  14122. (save-excursion
  14123. (goto-char (region-beginning))
  14124. (unless (org-at-heading-p) (outline-next-heading))
  14125. (setq start-level (org-current-level))))
  14126. (narrow-to-region (region-beginning)
  14127. (save-excursion
  14128. (goto-char (region-end))
  14129. (unless (and (bolp) (org-at-heading-p))
  14130. (outline-next-heading))
  14131. (point)))
  14132. (setq scope nil)))
  14133. (if (not scope)
  14134. (progn
  14135. (org-agenda-prepare-buffers
  14136. (and buffer-file-name (list buffer-file-name)))
  14137. (setq res
  14138. (org-scan-tags
  14139. func matcher org--matcher-tags-todo-only start-level)))
  14140. ;; Get the right scope
  14141. (cond
  14142. ((and scope (listp scope) (symbolp (car scope)))
  14143. (setq scope (eval scope)))
  14144. ((eq scope 'agenda)
  14145. (setq scope (org-agenda-files t)))
  14146. ((eq scope 'agenda-with-archives)
  14147. (setq scope (org-agenda-files t))
  14148. (setq scope (org-add-archive-files scope)))
  14149. ((eq scope 'file)
  14150. (setq scope (and buffer-file-name (list buffer-file-name))))
  14151. ((eq scope 'file-with-archives)
  14152. (setq scope (org-add-archive-files (list (buffer-file-name))))))
  14153. (org-agenda-prepare-buffers scope)
  14154. (dolist (file scope)
  14155. (with-current-buffer (org-find-base-buffer-visiting file)
  14156. (org-with-wide-buffer
  14157. (goto-char (point-min))
  14158. (setq res
  14159. (append
  14160. res
  14161. (org-scan-tags
  14162. func matcher org--matcher-tags-todo-only)))))))))
  14163. res)))
  14164. ;;; Properties API
  14165. (defconst org-special-properties
  14166. '("ALLTAGS" "BLOCKED" "CLOCKSUM" "CLOCKSUM_T" "CLOSED" "DEADLINE" "FILE"
  14167. "ITEM" "PRIORITY" "SCHEDULED" "TAGS" "TIMESTAMP" "TIMESTAMP_IA" "TODO")
  14168. "The special properties valid in Org mode.
  14169. These are properties that are not defined in the property drawer,
  14170. but in some other way.")
  14171. (defconst org-default-properties
  14172. '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
  14173. "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
  14174. "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
  14175. "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
  14176. "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE" "UNNUMBERED"
  14177. "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
  14178. "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
  14179. "Some properties that are used by Org mode for various purposes.
  14180. Being in this list makes sure that they are offered for completion.")
  14181. (defun org--valid-property-p (property)
  14182. "Non nil when string PROPERTY is a valid property name."
  14183. (not
  14184. (or (equal property "")
  14185. (string-match-p "\\s-" property))))
  14186. (defun org--update-property-plist (key val props)
  14187. "Associate KEY to VAL in alist PROPS.
  14188. Modifications are made by side-effect. Return new alist."
  14189. (let* ((appending (string= (substring key -1) "+"))
  14190. (key (if appending (substring key 0 -1) key))
  14191. (old (assoc-string key props t)))
  14192. (if (not old) (cons (cons key val) props)
  14193. (setcdr old (if appending (concat (cdr old) " " val) val))
  14194. props)))
  14195. (defun org-get-property-block (&optional beg force)
  14196. "Return the (beg . end) range of the body of the property drawer.
  14197. BEG is the beginning of the current subtree, or of the part
  14198. before the first headline. If it is not given, it will be found.
  14199. If the drawer does not exist, create it if FORCE is non-nil, or
  14200. return nil."
  14201. (org-with-wide-buffer
  14202. (when beg (goto-char beg))
  14203. (unless (org-before-first-heading-p)
  14204. (let ((beg (cond (beg)
  14205. ((or (not (featurep 'org-inlinetask))
  14206. (org-inlinetask-in-task-p))
  14207. (org-back-to-heading t))
  14208. (t (org-with-limited-levels (org-back-to-heading t))))))
  14209. (forward-line)
  14210. (when (looking-at-p org-planning-line-re) (forward-line))
  14211. (cond ((looking-at org-property-drawer-re)
  14212. (forward-line)
  14213. (cons (point) (progn (goto-char (match-end 0))
  14214. (line-beginning-position))))
  14215. (force
  14216. (goto-char beg)
  14217. (org-insert-property-drawer)
  14218. (let ((pos (save-excursion (search-forward ":END:")
  14219. (line-beginning-position))))
  14220. (cons pos pos))))))))
  14221. (defun org-at-property-p ()
  14222. "Non-nil when point is inside a property drawer.
  14223. See `org-property-re' for match data, if applicable."
  14224. (save-excursion
  14225. (beginning-of-line)
  14226. (and (looking-at org-property-re)
  14227. (let ((property-drawer (save-match-data (org-get-property-block))))
  14228. (and property-drawer
  14229. (>= (point) (car property-drawer))
  14230. (< (point) (cdr property-drawer)))))))
  14231. (defun org-property-action ()
  14232. "Do an action on properties."
  14233. (interactive)
  14234. (unless (org-at-property-p) (user-error "Not at a property"))
  14235. (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
  14236. (let ((c (read-char-exclusive)))
  14237. (cl-case c
  14238. (?s (call-interactively #'org-set-property))
  14239. (?d (call-interactively #'org-delete-property))
  14240. (?D (call-interactively #'org-delete-property-globally))
  14241. (?c (call-interactively #'org-compute-property-at-point))
  14242. (otherwise (user-error "No such property action %c" c)))))
  14243. (defun org-inc-effort ()
  14244. "Increment the value of the effort property in the current entry."
  14245. (interactive)
  14246. (org-set-effort nil t))
  14247. (defvar org-clock-effort) ; Defined in org-clock.el.
  14248. (defvar org-clock-current-task) ; Defined in org-clock.el.
  14249. (defun org-set-effort (&optional value increment)
  14250. "Set the effort property of the current entry.
  14251. With numerical prefix arg, use the nth allowed value, 0 stands for the
  14252. 10th allowed value.
  14253. When INCREMENT is non-nil, set the property to the next allowed value."
  14254. (interactive "P")
  14255. (when (equal value 0) (setq value 10))
  14256. (let* ((completion-ignore-case t)
  14257. (prop org-effort-property)
  14258. (cur (org-entry-get nil prop))
  14259. (allowed (org-property-get-allowed-values nil prop 'table))
  14260. (existing (mapcar 'list (org-property-values prop)))
  14261. (heading (nth 4 (org-heading-components)))
  14262. rpl
  14263. (val (cond
  14264. ((stringp value) value)
  14265. ((and allowed (integerp value))
  14266. (or (car (nth (1- value) allowed))
  14267. (car (org-last allowed))))
  14268. ((and allowed increment)
  14269. (or (cl-caadr (member (list cur) allowed))
  14270. (user-error "Allowed effort values are not set")))
  14271. (allowed
  14272. (message "Select 1-9,0, [RET%s]: %s"
  14273. (if cur (concat "=" cur) "")
  14274. (mapconcat 'car allowed " "))
  14275. (setq rpl (read-char-exclusive))
  14276. (if (equal rpl ?\r)
  14277. cur
  14278. (setq rpl (- rpl ?0))
  14279. (when (equal rpl 0) (setq rpl 10))
  14280. (if (and (> rpl 0) (<= rpl (length allowed)))
  14281. (car (nth (1- rpl) allowed))
  14282. (org-completing-read "Effort: " allowed nil))))
  14283. (t
  14284. (org-completing-read
  14285. (concat "Effort" (and cur (string-match "\\S-" cur)
  14286. (concat " [" cur "]"))
  14287. ": ")
  14288. existing nil nil "" nil cur)))))
  14289. (unless (equal (org-entry-get nil prop) val)
  14290. (org-entry-put nil prop val))
  14291. (org-refresh-property
  14292. '((effort . identity)
  14293. (effort-minutes . org-duration-string-to-minutes))
  14294. val)
  14295. (when (equal heading (bound-and-true-p org-clock-current-task))
  14296. (setq org-clock-effort (get-text-property (point-at-bol) 'effort))
  14297. (org-clock-update-mode-line))
  14298. (message "%s is now %s" prop val)))
  14299. (defun org-entry-properties (&optional pom which)
  14300. "Get all properties of the current entry.
  14301. When POM is a buffer position, get all properties from the entry
  14302. there instead.
  14303. This includes the TODO keyword, the tags, time strings for
  14304. deadline, scheduled, and clocking, and any additional properties
  14305. defined in the entry.
  14306. If WHICH is nil or `all', get all properties. If WHICH is
  14307. `special' or `standard', only get that subclass. If WHICH is
  14308. a string, only get that property.
  14309. Return value is an alist. Keys are properties, as upcased
  14310. strings."
  14311. (org-with-point-at pom
  14312. (when (and (derived-mode-p 'org-mode)
  14313. (ignore-errors (org-back-to-heading t)))
  14314. (catch 'exit
  14315. (let* ((beg (point))
  14316. (specific (and (stringp which) (upcase which)))
  14317. (which (cond ((not specific) which)
  14318. ((member specific org-special-properties) 'special)
  14319. (t 'standard)))
  14320. props)
  14321. ;; Get the special properties, like TODO and TAGS.
  14322. (when (memq which '(nil all special))
  14323. (when (or (not specific) (string= specific "CLOCKSUM"))
  14324. (let ((clocksum (get-text-property (point) :org-clock-minutes)))
  14325. (when clocksum
  14326. (push (cons "CLOCKSUM"
  14327. (org-minutes-to-clocksum-string clocksum))
  14328. props)))
  14329. (when specific (throw 'exit props)))
  14330. (when (or (not specific) (string= specific "CLOCKSUM_T"))
  14331. (let ((clocksumt (get-text-property (point)
  14332. :org-clock-minutes-today)))
  14333. (when clocksumt
  14334. (push (cons "CLOCKSUM_T"
  14335. (org-minutes-to-clocksum-string clocksumt))
  14336. props)))
  14337. (when specific (throw 'exit props)))
  14338. (when (or (not specific) (string= specific "ITEM"))
  14339. (let ((case-fold-search nil))
  14340. (when (looking-at org-complex-heading-regexp)
  14341. (push (cons "ITEM"
  14342. (let ((title (match-string-no-properties 4)))
  14343. (if (org-string-nw-p title)
  14344. (org-remove-tabs title)
  14345. "")))
  14346. props)))
  14347. (when specific (throw 'exit props)))
  14348. (when (or (not specific) (string= specific "TODO"))
  14349. (let ((case-fold-search nil))
  14350. (when (and (looking-at org-todo-line-regexp) (match-end 2))
  14351. (push (cons "TODO" (match-string-no-properties 2)) props)))
  14352. (when specific (throw 'exit props)))
  14353. (when (or (not specific) (string= specific "PRIORITY"))
  14354. (push (cons "PRIORITY"
  14355. (if (looking-at org-priority-regexp)
  14356. (match-string-no-properties 2)
  14357. (char-to-string org-default-priority)))
  14358. props)
  14359. (when specific (throw 'exit props)))
  14360. (when (or (not specific) (string= specific "FILE"))
  14361. (push (cons "FILE" (buffer-file-name (buffer-base-buffer)))
  14362. props)
  14363. (when specific (throw 'exit props)))
  14364. (when (or (not specific) (string= specific "TAGS"))
  14365. (let ((value (org-string-nw-p (org-get-tags-string))))
  14366. (when value (push (cons "TAGS" value) props)))
  14367. (when specific (throw 'exit props)))
  14368. (when (or (not specific) (string= specific "ALLTAGS"))
  14369. (let ((value (org-get-tags-at)))
  14370. (when value
  14371. (push (cons "ALLTAGS"
  14372. (format ":%s:" (mapconcat #'identity value ":")))
  14373. props)))
  14374. (when specific (throw 'exit props)))
  14375. (when (or (not specific) (string= specific "BLOCKED"))
  14376. (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props)
  14377. (when specific (throw 'exit props)))
  14378. (when (or (not specific)
  14379. (member specific '("CLOSED" "DEADLINE" "SCHEDULED")))
  14380. (forward-line)
  14381. (when (looking-at-p org-planning-line-re)
  14382. (end-of-line)
  14383. (let ((bol (line-beginning-position))
  14384. ;; Backward compatibility: time keywords used to
  14385. ;; be configurable (before 8.3). Make sure we
  14386. ;; get the correct keyword.
  14387. (key-assoc `(("CLOSED" . ,org-closed-string)
  14388. ("DEADLINE" . ,org-deadline-string)
  14389. ("SCHEDULED" . ,org-scheduled-string))))
  14390. (dolist (pair (if specific (list (assoc specific key-assoc))
  14391. key-assoc))
  14392. (save-excursion
  14393. (when (search-backward (cdr pair) bol t)
  14394. (goto-char (match-end 0))
  14395. (skip-chars-forward " \t")
  14396. (and (looking-at org-ts-regexp-both)
  14397. (push (cons (car pair)
  14398. (match-string-no-properties 0))
  14399. props)))))))
  14400. (when specific (throw 'exit props)))
  14401. (when (or (not specific)
  14402. (member specific '("TIMESTAMP" "TIMESTAMP_IA")))
  14403. (let ((find-ts
  14404. (lambda (end ts)
  14405. ;; Fix next time-stamp before END. TS is the
  14406. ;; list of time-stamps found so far.
  14407. (let ((ts ts)
  14408. (regexp (cond
  14409. ((string= specific "TIMESTAMP")
  14410. org-ts-regexp)
  14411. ((string= specific "TIMESTAMP_IA")
  14412. org-ts-regexp-inactive)
  14413. ((assoc "TIMESTAMP_IA" ts)
  14414. org-ts-regexp)
  14415. ((assoc "TIMESTAMP" ts)
  14416. org-ts-regexp-inactive)
  14417. (t org-ts-regexp-both))))
  14418. (catch 'next
  14419. (while (re-search-forward regexp end t)
  14420. (backward-char)
  14421. (let ((object (org-element-context)))
  14422. ;; Accept to match timestamps in node
  14423. ;; properties, too.
  14424. (when (memq (org-element-type object)
  14425. '(node-property timestamp))
  14426. (let ((type
  14427. (org-element-property :type object)))
  14428. (cond
  14429. ((and (memq type '(active active-range))
  14430. (not (equal specific "TIMESTAMP_IA")))
  14431. (unless (assoc "TIMESTAMP" ts)
  14432. (push (cons "TIMESTAMP"
  14433. (org-element-property
  14434. :raw-value object))
  14435. ts)
  14436. (when specific (throw 'exit ts))))
  14437. ((and (memq type '(inactive inactive-range))
  14438. (not (string= specific "TIMESTAMP")))
  14439. (unless (assoc "TIMESTAMP_IA" ts)
  14440. (push (cons "TIMESTAMP_IA"
  14441. (org-element-property
  14442. :raw-value object))
  14443. ts)
  14444. (when specific (throw 'exit ts))))))
  14445. ;; Both timestamp types are found,
  14446. ;; move to next part.
  14447. (when (= (length ts) 2) (throw 'next ts)))))
  14448. ts)))))
  14449. (goto-char beg)
  14450. ;; First look for timestamps within headline.
  14451. (let ((ts (funcall find-ts (line-end-position) nil)))
  14452. (if (= (length ts) 2) (setq props (nconc ts props))
  14453. (forward-line)
  14454. ;; Then find timestamps in the section, skipping
  14455. ;; planning line.
  14456. (when (looking-at-p org-planning-line-re)
  14457. (forward-line))
  14458. (let ((end (save-excursion (outline-next-heading))))
  14459. (setq props (nconc (funcall find-ts end ts) props))))))))
  14460. ;; Get the standard properties, like :PROP:.
  14461. (when (memq which '(nil all standard))
  14462. ;; If we are looking after a specific property, delegate
  14463. ;; to `org-entry-get', which is faster. However, make an
  14464. ;; exception for "CATEGORY", since it can be also set
  14465. ;; through keywords (i.e. #+CATEGORY).
  14466. (if (and specific (not (equal specific "CATEGORY")))
  14467. (let ((value (org-entry-get beg specific nil t)))
  14468. (throw 'exit (and value (list (cons specific value)))))
  14469. (let ((range (org-get-property-block beg)))
  14470. (when range
  14471. (let ((end (cdr range)) seen-base)
  14472. (goto-char (car range))
  14473. ;; Unlike to `org--update-property-plist', we
  14474. ;; handle the case where base values is found
  14475. ;; after its extension. We also forbid standard
  14476. ;; properties to be named as special properties.
  14477. (while (re-search-forward org-property-re end t)
  14478. (let* ((key (upcase (match-string-no-properties 2)))
  14479. (extendp (string-match-p "\\+\\'" key))
  14480. (key-base (if extendp (substring key 0 -1) key))
  14481. (value (match-string-no-properties 3)))
  14482. (cond
  14483. ((member-ignore-case key-base org-special-properties))
  14484. (extendp
  14485. (setq props
  14486. (org--update-property-plist key value props)))
  14487. ((member key seen-base))
  14488. (t (push key seen-base)
  14489. (let ((p (assoc-string key props t)))
  14490. (if p (setcdr p (concat value " " (cdr p)))
  14491. (push (cons key value) props))))))))))))
  14492. (unless (assoc "CATEGORY" props)
  14493. (push (cons "CATEGORY" (org-get-category beg)) props)
  14494. (when (string= specific "CATEGORY") (throw 'exit props)))
  14495. ;; Return value.
  14496. props)))))
  14497. (defun org-property--local-values (property literal-nil)
  14498. "Return value for PROPERTY in current entry.
  14499. Value is a list whose car is the base value for PROPERTY and cdr
  14500. a list of accumulated values. Return nil if neither is found in
  14501. the entry. Also return nil when PROPERTY is set to \"nil\",
  14502. unless LITERAL-NIL is non-nil."
  14503. (let ((range (org-get-property-block)))
  14504. (when range
  14505. (goto-char (car range))
  14506. (let* ((case-fold-search t)
  14507. (end (cdr range))
  14508. (value
  14509. ;; Base value.
  14510. (save-excursion
  14511. (let ((v (and (re-search-forward
  14512. (org-re-property property nil t) end t)
  14513. (match-string-no-properties 3))))
  14514. (list (if literal-nil v (org-not-nil v)))))))
  14515. ;; Find additional values.
  14516. (let* ((property+ (org-re-property (concat property "+") nil t)))
  14517. (while (re-search-forward property+ end t)
  14518. (push (match-string-no-properties 3) value)))
  14519. ;; Return final values.
  14520. (and (not (equal value '(nil))) (nreverse value))))))
  14521. (defun org-entry-get (pom property &optional inherit literal-nil)
  14522. "Get value of PROPERTY for entry or content at point-or-marker POM.
  14523. If INHERIT is non-nil and the entry does not have the property,
  14524. then also check higher levels of the hierarchy. If INHERIT is
  14525. the symbol `selective', use inheritance only if the setting in
  14526. `org-use-property-inheritance' selects PROPERTY for inheritance.
  14527. If the property is present but empty, the return value is the
  14528. empty string. If the property is not present at all, nil is
  14529. returned. In any other case, return the value as a string.
  14530. Search is case-insensitive.
  14531. If LITERAL-NIL is set, return the string value \"nil\" as
  14532. a string, do not interpret it as the list atom nil. This is used
  14533. for inheritance when a \"nil\" value can supersede a non-nil
  14534. value higher up the hierarchy."
  14535. (org-with-point-at pom
  14536. (cond
  14537. ((member-ignore-case property (cons "CATEGORY" org-special-properties))
  14538. ;; We need a special property. Use `org-entry-properties' to
  14539. ;; retrieve it, but specify the wanted property.
  14540. (cdr (assoc-string property (org-entry-properties nil property))))
  14541. ((and inherit
  14542. (or (not (eq inherit 'selective)) (org-property-inherit-p property)))
  14543. (org-entry-get-with-inheritance property literal-nil))
  14544. (t
  14545. (let* ((local (org-property--local-values property literal-nil))
  14546. (value (and local (mapconcat #'identity (delq nil local) " "))))
  14547. (if literal-nil value (org-not-nil value)))))))
  14548. (defun org-property-or-variable-value (var &optional inherit)
  14549. "Check if there is a property fixing the value of VAR.
  14550. If yes, return this value. If not, return the current value of the variable."
  14551. (let ((prop (org-entry-get nil (symbol-name var) inherit)))
  14552. (if (and prop (stringp prop) (string-match "\\S-" prop))
  14553. (read prop)
  14554. (symbol-value var))))
  14555. (defun org-entry-delete (pom property)
  14556. "Delete PROPERTY from entry at point-or-marker POM.
  14557. Accumulated properties, i.e. PROPERTY+, are also removed. Return
  14558. non-nil when a property was removed."
  14559. (unless (member property org-special-properties)
  14560. (org-with-point-at pom
  14561. (let ((range (org-get-property-block)))
  14562. (when range
  14563. (let* ((begin (car range))
  14564. (origin (cdr range))
  14565. (end (copy-marker origin))
  14566. (re (org-re-property
  14567. (concat (regexp-quote property) "\\+?") t t)))
  14568. (goto-char begin)
  14569. (while (re-search-forward re end t)
  14570. (delete-region (match-beginning 0) (line-beginning-position 2)))
  14571. ;; If drawer is empty, remove it altogether.
  14572. (when (= begin end)
  14573. (delete-region (line-beginning-position 0)
  14574. (line-beginning-position 2)))
  14575. ;; Return non-nil if some property was removed.
  14576. (prog1 (/= end origin) (set-marker end nil))))))))
  14577. ;; Multi-values properties are properties that contain multiple values
  14578. ;; These values are assumed to be single words, separated by whitespace.
  14579. (defun org-entry-add-to-multivalued-property (pom property value)
  14580. "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
  14581. (let* ((old (org-entry-get pom property))
  14582. (values (and old (org-split-string old "[ \t]"))))
  14583. (setq value (org-entry-protect-space value))
  14584. (unless (member value values)
  14585. (setq values (append values (list value)))
  14586. (org-entry-put pom property
  14587. (mapconcat 'identity values " ")))))
  14588. (defun org-entry-remove-from-multivalued-property (pom property value)
  14589. "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
  14590. (let* ((old (org-entry-get pom property))
  14591. (values (and old (org-split-string old "[ \t]"))))
  14592. (setq value (org-entry-protect-space value))
  14593. (when (member value values)
  14594. (setq values (delete value values))
  14595. (org-entry-put pom property
  14596. (mapconcat 'identity values " ")))))
  14597. (defun org-entry-member-in-multivalued-property (pom property value)
  14598. "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
  14599. (let* ((old (org-entry-get pom property))
  14600. (values (and old (org-split-string old "[ \t]"))))
  14601. (setq value (org-entry-protect-space value))
  14602. (member value values)))
  14603. (defun org-entry-get-multivalued-property (pom property)
  14604. "Return a list of values in a multivalued property."
  14605. (let* ((value (org-entry-get pom property))
  14606. (values (and value (org-split-string value "[ \t]"))))
  14607. (mapcar 'org-entry-restore-space values)))
  14608. (defun org-entry-put-multivalued-property (pom property &rest values)
  14609. "Set multivalued PROPERTY at point-or-marker POM to VALUES.
  14610. VALUES should be a list of strings. Spaces will be protected."
  14611. (org-entry-put pom property
  14612. (mapconcat 'org-entry-protect-space values " "))
  14613. (let* ((value (org-entry-get pom property))
  14614. (values (and value (org-split-string value "[ \t]"))))
  14615. (mapcar 'org-entry-restore-space values)))
  14616. (defun org-entry-protect-space (s)
  14617. "Protect spaces and newline in string S."
  14618. (while (string-match " " s)
  14619. (setq s (replace-match "%20" t t s)))
  14620. (while (string-match "\n" s)
  14621. (setq s (replace-match "%0A" t t s)))
  14622. s)
  14623. (defun org-entry-restore-space (s)
  14624. "Restore spaces and newline in string S."
  14625. (while (string-match "%20" s)
  14626. (setq s (replace-match " " t t s)))
  14627. (while (string-match "%0A" s)
  14628. (setq s (replace-match "\n" t t s)))
  14629. s)
  14630. (defvar org-entry-property-inherited-from (make-marker)
  14631. "Marker pointing to the entry from where a property was inherited.
  14632. Each call to `org-entry-get-with-inheritance' will set this marker to the
  14633. location of the entry where the inheritance search matched. If there was
  14634. no match, the marker will point nowhere.
  14635. Note that also `org-entry-get' calls this function, if the INHERIT flag
  14636. is set.")
  14637. (defun org-entry-get-with-inheritance (property &optional literal-nil)
  14638. "Get PROPERTY of entry or content at point, search higher levels if needed.
  14639. The search will stop at the first ancestor which has the property defined.
  14640. If the value found is \"nil\", return nil to show that the property
  14641. should be considered as undefined (this is the meaning of nil here).
  14642. However, if LITERAL-NIL is set, return the string value \"nil\" instead."
  14643. (move-marker org-entry-property-inherited-from nil)
  14644. (org-with-wide-buffer
  14645. (let (value)
  14646. (catch 'exit
  14647. (while t
  14648. (let ((v (org-property--local-values property literal-nil)))
  14649. (when v
  14650. (setq value
  14651. (concat (mapconcat #'identity (delq nil v) " ")
  14652. (and value " ")
  14653. value)))
  14654. (cond
  14655. ((car v)
  14656. (org-back-to-heading t)
  14657. (move-marker org-entry-property-inherited-from (point))
  14658. (throw 'exit nil))
  14659. ((org-up-heading-safe))
  14660. (t
  14661. (let ((global
  14662. (cdr (or (assoc-string property org-file-properties t)
  14663. (assoc-string property org-global-properties t)
  14664. (assoc-string property org-global-properties-fixed t)))))
  14665. (cond ((not global))
  14666. (value (setq value (concat global " " value)))
  14667. (t (setq value global))))
  14668. (throw 'exit nil))))))
  14669. (if literal-nil value (org-not-nil value)))))
  14670. (defvar org-property-changed-functions nil
  14671. "Hook called when the value of a property has changed.
  14672. Each hook function should accept two arguments, the name of the property
  14673. and the new value.")
  14674. (defun org-entry-put (pom property value)
  14675. "Set PROPERTY to VALUE for entry at point-or-marker POM.
  14676. If the value is nil, it is converted to the empty string. If it
  14677. is not a string, an error is raised. Also raise an error on
  14678. invalid property names.
  14679. PROPERTY can be any regular property (see
  14680. `org-special-properties'). It can also be \"TODO\",
  14681. \"PRIORITY\", \"SCHEDULED\" and \"DEADLINE\".
  14682. For the last two properties, VALUE may have any of the special
  14683. values \"earlier\" and \"later\". The function then increases or
  14684. decreases scheduled or deadline date by one day."
  14685. (cond ((null value) (setq value ""))
  14686. ((not (stringp value)) (error "Properties values should be strings"))
  14687. ((not (org--valid-property-p property))
  14688. (user-error "Invalid property name: \"%s\"" property)))
  14689. (org-with-point-at pom
  14690. (if (or (not (featurep 'org-inlinetask)) (org-inlinetask-in-task-p))
  14691. (org-back-to-heading t)
  14692. (org-with-limited-levels (org-back-to-heading t)))
  14693. (let ((beg (point)))
  14694. (cond
  14695. ((equal property "TODO")
  14696. (cond ((not (org-string-nw-p value)) (setq value 'none))
  14697. ((not (member value org-todo-keywords-1))
  14698. (user-error "\"%s\" is not a valid TODO state" value)))
  14699. (org-todo value)
  14700. (org-set-tags nil 'align))
  14701. ((equal property "PRIORITY")
  14702. (org-priority (if (org-string-nw-p value) (string-to-char value) ?\s))
  14703. (org-set-tags nil 'align))
  14704. ((equal property "SCHEDULED")
  14705. (forward-line)
  14706. (if (and (looking-at-p org-planning-line-re)
  14707. (re-search-forward
  14708. org-scheduled-time-regexp (line-end-position) t))
  14709. (cond ((string= value "earlier") (org-timestamp-change -1 'day))
  14710. ((string= value "later") (org-timestamp-change 1 'day))
  14711. ((string= value "") (org-schedule '(4)))
  14712. (t (org-schedule nil value)))
  14713. (if (member value '("earlier" "later" ""))
  14714. (call-interactively #'org-schedule)
  14715. (org-schedule nil value))))
  14716. ((equal property "DEADLINE")
  14717. (forward-line)
  14718. (if (and (looking-at-p org-planning-line-re)
  14719. (re-search-forward
  14720. org-deadline-time-regexp (line-end-position) t))
  14721. (cond ((string= value "earlier") (org-timestamp-change -1 'day))
  14722. ((string= value "later") (org-timestamp-change 1 'day))
  14723. ((string= value "") (org-deadline '(4)))
  14724. (t (org-deadline nil value)))
  14725. (if (member value '("earlier" "later" ""))
  14726. (call-interactively #'org-deadline)
  14727. (org-deadline nil value))))
  14728. ((member property org-special-properties)
  14729. (error "The %s property cannot be set with `org-entry-put'" property))
  14730. (t
  14731. (let* ((range (org-get-property-block beg 'force))
  14732. (end (cdr range))
  14733. (case-fold-search t))
  14734. (goto-char (car range))
  14735. (if (re-search-forward (org-re-property property nil t) end t)
  14736. (progn (delete-region (match-beginning 0) (match-end 0))
  14737. (goto-char (match-beginning 0)))
  14738. (goto-char end)
  14739. (insert "\n")
  14740. (backward-char))
  14741. (insert ":" property ":")
  14742. (when value (insert " " value))
  14743. (org-indent-line)))))
  14744. (run-hook-with-args 'org-property-changed-functions property value)))
  14745. (defun org-buffer-property-keys
  14746. (&optional specials defaults columns ignore-malformed)
  14747. "Get all property keys in the current buffer.
  14748. When SPECIALS is non-nil, also list the special properties that
  14749. reflect things like tags and TODO state.
  14750. When DEFAULTS is non-nil, also include properties that has
  14751. special meaning internally: ARCHIVE, CATEGORY, SUMMARY,
  14752. DESCRIPTION, LOCATION, and LOGGING and others.
  14753. When COLUMNS in non-nil, also include property names given in
  14754. COLUMN formats in the current buffer.
  14755. When IGNORE-MALFORMED is non-nil, malformed drawer repair will not be
  14756. automatically performed, such drawers will be silently ignored."
  14757. (let ((case-fold-search t)
  14758. (props (append
  14759. (and specials org-special-properties)
  14760. (and defaults (cons org-effort-property org-default-properties))
  14761. nil)))
  14762. (org-with-wide-buffer
  14763. (goto-char (point-min))
  14764. (while (re-search-forward org-property-start-re nil t)
  14765. (let ((range (org-get-property-block)))
  14766. (catch 'skip
  14767. (unless range
  14768. (when (and (not ignore-malformed)
  14769. (not (org-before-first-heading-p))
  14770. (y-or-n-p (format "Malformed drawer at %d, repair?"
  14771. (line-beginning-position))))
  14772. (org-get-property-block nil t))
  14773. (throw 'skip nil))
  14774. (goto-char (car range))
  14775. (let ((begin (car range))
  14776. (end (cdr range)))
  14777. ;; Make sure that found property block is not located
  14778. ;; before current point, as it would generate an infloop.
  14779. ;; It can happen, for example, in the following
  14780. ;; situation:
  14781. ;;
  14782. ;; * Headline
  14783. ;; :PROPERTIES:
  14784. ;; ...
  14785. ;; :END:
  14786. ;; *************** Inlinetask
  14787. ;; #+BEGIN_EXAMPLE
  14788. ;; :PROPERTIES:
  14789. ;; #+END_EXAMPLE
  14790. ;;
  14791. (if (< begin (point)) (throw 'skip nil) (goto-char begin))
  14792. (while (< (point) end)
  14793. (let ((p (progn (looking-at org-property-re)
  14794. (match-string-no-properties 2))))
  14795. ;; Only add true property name, not extension symbol.
  14796. (push (if (not (string-match-p "\\+\\'" p)) p
  14797. (substring p 0 -1))
  14798. props))
  14799. (forward-line))))
  14800. (outline-next-heading)))
  14801. (when columns
  14802. (goto-char (point-min))
  14803. (while (re-search-forward "^[ \t]*\\(?:#\\+\\|:\\)COLUMNS:" nil t)
  14804. (let ((element (org-element-at-point)))
  14805. (when (memq (org-element-type element) '(keyword node-property))
  14806. (let ((value (org-element-property :value element))
  14807. (start 0))
  14808. (while (string-match "%[0-9]*\\(\\S-+\\)" value start)
  14809. (setq start (match-end 0))
  14810. (let ((p (match-string-no-properties 1 value)))
  14811. (unless (member-ignore-case p org-special-properties)
  14812. (push p props))))))))))
  14813. (sort (delete-dups props) (lambda (a b) (string< (upcase a) (upcase b))))))
  14814. (defun org-property-values (key)
  14815. "List all non-nil values of property KEY in current buffer."
  14816. (org-with-wide-buffer
  14817. (goto-char (point-min))
  14818. (let ((case-fold-search t)
  14819. (re (org-re-property key))
  14820. values)
  14821. (while (re-search-forward re nil t)
  14822. (push (org-entry-get (point) key) values))
  14823. (delete-dups values))))
  14824. (defun org-insert-property-drawer ()
  14825. "Insert a property drawer into the current entry."
  14826. (org-with-wide-buffer
  14827. (if (or (not (featurep 'org-inlinetask)) (org-inlinetask-in-task-p))
  14828. (org-back-to-heading t)
  14829. (org-with-limited-levels (org-back-to-heading t)))
  14830. (forward-line)
  14831. (when (looking-at-p org-planning-line-re) (forward-line))
  14832. (unless (looking-at-p org-property-drawer-re)
  14833. ;; Make sure we start editing a line from current entry, not from
  14834. ;; next one. It prevents extending text properties or overlays
  14835. ;; belonging to the latter.
  14836. (when (bolp) (backward-char))
  14837. (let ((begin (1+ (point)))
  14838. (inhibit-read-only t))
  14839. (insert "\n:PROPERTIES:\n:END:")
  14840. (when (eobp) (insert "\n"))
  14841. (org-indent-region begin (point))))))
  14842. (defun org-insert-drawer (&optional arg drawer)
  14843. "Insert a drawer at point.
  14844. When optional argument ARG is non-nil, insert a property drawer.
  14845. Optional argument DRAWER, when non-nil, is a string representing
  14846. drawer's name. Otherwise, the user is prompted for a name.
  14847. If a region is active, insert the drawer around that region
  14848. instead.
  14849. Point is left between drawer's boundaries."
  14850. (interactive "P")
  14851. (let* ((drawer (if arg "PROPERTIES"
  14852. (or drawer (read-from-minibuffer "Drawer: ")))))
  14853. (cond
  14854. ;; With C-u, fall back on `org-insert-property-drawer'
  14855. (arg (org-insert-property-drawer))
  14856. ;; Check validity of suggested drawer's name.
  14857. ((not (string-match-p org-drawer-regexp (format ":%s:" drawer)))
  14858. (user-error "Invalid drawer name"))
  14859. ;; With an active region, insert a drawer at point.
  14860. ((not (org-region-active-p))
  14861. (progn
  14862. (unless (bolp) (insert "\n"))
  14863. (insert (format ":%s:\n\n:END:\n" drawer))
  14864. (forward-line -2)))
  14865. ;; Otherwise, insert the drawer at point
  14866. (t
  14867. (let ((rbeg (region-beginning))
  14868. (rend (copy-marker (region-end))))
  14869. (unwind-protect
  14870. (progn
  14871. (goto-char rbeg)
  14872. (beginning-of-line)
  14873. (when (save-excursion
  14874. (re-search-forward org-outline-regexp-bol rend t))
  14875. (user-error "Drawers cannot contain headlines"))
  14876. ;; Position point at the beginning of the first
  14877. ;; non-blank line in region. Insert drawer's opening
  14878. ;; there, then indent it.
  14879. (org-skip-whitespace)
  14880. (beginning-of-line)
  14881. (insert ":" drawer ":\n")
  14882. (forward-line -1)
  14883. (indent-for-tab-command)
  14884. ;; Move point to the beginning of the first blank line
  14885. ;; after the last non-blank line in region. Insert
  14886. ;; drawer's closing, then indent it.
  14887. (goto-char rend)
  14888. (skip-chars-backward " \r\t\n")
  14889. (insert "\n:END:")
  14890. (deactivate-mark t)
  14891. (indent-for-tab-command)
  14892. (unless (eolp) (insert "\n")))
  14893. ;; Clear marker, whatever the outcome of insertion is.
  14894. (set-marker rend nil)))))))
  14895. (defvar org-property-set-functions-alist nil
  14896. "Property set function alist.
  14897. Each entry should have the following format:
  14898. (PROPERTY . READ-FUNCTION)
  14899. The read function will be called with the same argument as
  14900. `org-completing-read'.")
  14901. (defun org-set-property-function (property)
  14902. "Get the function that should be used to set PROPERTY.
  14903. This is computed according to `org-property-set-functions-alist'."
  14904. (or (cdr (assoc property org-property-set-functions-alist))
  14905. 'org-completing-read))
  14906. (defun org-read-property-value (property)
  14907. "Read PROPERTY value from user."
  14908. (let* ((completion-ignore-case t)
  14909. (allowed (org-property-get-allowed-values nil property 'table))
  14910. (cur (org-entry-get nil property))
  14911. (prompt (concat property " value"
  14912. (if (and cur (string-match "\\S-" cur))
  14913. (concat " [" cur "]") "") ": "))
  14914. (set-function (org-set-property-function property))
  14915. (val (if allowed
  14916. (funcall set-function prompt allowed nil
  14917. (not (get-text-property 0 'org-unrestricted
  14918. (caar allowed))))
  14919. (funcall set-function prompt
  14920. (mapcar 'list (org-property-values property))
  14921. nil nil "" nil cur))))
  14922. (org-trim val)))
  14923. (defvar org-last-set-property nil)
  14924. (defvar org-last-set-property-value nil)
  14925. (defun org-read-property-name ()
  14926. "Read a property name."
  14927. (let ((completion-ignore-case t)
  14928. (default-prop (or (and (org-at-property-p)
  14929. (match-string-no-properties 2))
  14930. org-last-set-property)))
  14931. (org-completing-read
  14932. (concat "Property"
  14933. (if default-prop (concat " [" default-prop "]") "")
  14934. ": ")
  14935. (mapcar #'list (org-buffer-property-keys nil t t))
  14936. nil nil nil nil default-prop)))
  14937. (defun org-set-property-and-value (use-last)
  14938. "Allow to set [PROPERTY]: [value] direction from prompt.
  14939. When use-default, don't even ask, just use the last
  14940. \"[PROPERTY]: [value]\" string from the history."
  14941. (interactive "P")
  14942. (let* ((completion-ignore-case t)
  14943. (pv (or (and use-last org-last-set-property-value)
  14944. (org-completing-read
  14945. "Enter a \"[Property]: [value]\" pair: "
  14946. nil nil nil nil nil
  14947. org-last-set-property-value)))
  14948. prop val)
  14949. (when (string-match "^[ \t]*\\([^:]+\\):[ \t]*\\(.*\\)[ \t]*$" pv)
  14950. (setq prop (match-string 1 pv)
  14951. val (match-string 2 pv))
  14952. (org-set-property prop val))))
  14953. (defun org-set-property (property value)
  14954. "In the current entry, set PROPERTY to VALUE.
  14955. When called interactively, this will prompt for a property name, offering
  14956. completion on existing and default properties. And then it will prompt
  14957. for a value, offering completion either on allowed values (via an inherited
  14958. xxx_ALL property) or on existing values in other instances of this property
  14959. in the current file.
  14960. Throw an error when trying to set a property with an invalid name."
  14961. (interactive (list nil nil))
  14962. (let ((property (or property (org-read-property-name))))
  14963. ;; `org-entry-put' also makes the following check, but this one
  14964. ;; avoids polluting `org-last-set-property' and
  14965. ;; `org-last-set-property-value' needlessly.
  14966. (unless (org--valid-property-p property)
  14967. (user-error "Invalid property name: \"%s\"" property))
  14968. (let ((value (or value (org-read-property-value property)))
  14969. (fn (cdr (assoc-string property org-properties-postprocess-alist t))))
  14970. (setq org-last-set-property property)
  14971. (setq org-last-set-property-value (concat property ": " value))
  14972. ;; Possibly postprocess the inserted value:
  14973. (when fn (setq value (funcall fn value)))
  14974. (unless (equal (org-entry-get nil property) value)
  14975. (org-entry-put nil property value)))))
  14976. (defun org-find-property (property &optional value)
  14977. "Find first entry in buffer that sets PROPERTY.
  14978. When optional argument VALUE is non-nil, only consider an entry
  14979. if it contains PROPERTY set to this value. If PROPERTY should be
  14980. explicitly set to nil, use string \"nil\" for VALUE.
  14981. Return position where the entry begins, or nil if there is no
  14982. such entry. If narrowing is in effect, only search the visible
  14983. part of the buffer."
  14984. (save-excursion
  14985. (goto-char (point-min))
  14986. (let ((case-fold-search t)
  14987. (re (org-re-property property nil (not value) value)))
  14988. (catch 'exit
  14989. (while (re-search-forward re nil t)
  14990. (when (if value (org-at-property-p)
  14991. (org-entry-get (point) property nil t))
  14992. (throw 'exit (progn (org-back-to-heading t) (point)))))))))
  14993. (defun org-delete-property (property)
  14994. "In the current entry, delete PROPERTY."
  14995. (interactive
  14996. (let* ((completion-ignore-case t)
  14997. (cat (org-entry-get (point) "CATEGORY"))
  14998. (props0 (org-entry-properties nil 'standard))
  14999. (props (if cat props0
  15000. (delete `("CATEGORY" . ,(org-get-category)) props0)))
  15001. (prop (if (< 1 (length props))
  15002. (completing-read "Property: " props nil t)
  15003. (caar props))))
  15004. (list prop)))
  15005. (if (not property)
  15006. (message "No property to delete in this entry")
  15007. (org-entry-delete nil property)
  15008. (message "Property \"%s\" deleted" property)))
  15009. (defun org-delete-property-globally (property)
  15010. "Remove PROPERTY globally, from all entries.
  15011. This function ignores narrowing, if any."
  15012. (interactive
  15013. (let* ((completion-ignore-case t)
  15014. (prop (completing-read
  15015. "Globally remove property: "
  15016. (mapcar #'list (org-buffer-property-keys)))))
  15017. (list prop)))
  15018. (org-with-wide-buffer
  15019. (goto-char (point-min))
  15020. (let ((count 0)
  15021. (re (org-re-property (concat (regexp-quote property) "\\+?") t t)))
  15022. (while (re-search-forward re nil t)
  15023. (when (org-entry-delete (point) property) (cl-incf count)))
  15024. (message "Property \"%s\" removed from %d entries" property count))))
  15025. (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
  15026. (defun org-compute-property-at-point ()
  15027. "Compute the property at point.
  15028. This looks for an enclosing column format, extracts the operator and
  15029. then applies it to the property in the column format's scope."
  15030. (interactive)
  15031. (unless (org-at-property-p)
  15032. (user-error "Not at a property"))
  15033. (let ((prop (match-string-no-properties 2)))
  15034. (org-columns-get-format-and-top-level)
  15035. (unless (nth 3 (assoc-string prop org-columns-current-fmt-compiled t))
  15036. (user-error "No operator defined for property %s" prop))
  15037. (org-columns-compute prop)))
  15038. (defvar org-property-allowed-value-functions nil
  15039. "Hook for functions supplying allowed values for a specific property.
  15040. The functions must take a single argument, the name of the property, and
  15041. return a flat list of allowed values. If \":ETC\" is one of
  15042. the values, this means that these values are intended as defaults for
  15043. completion, but that other values should be allowed too.
  15044. The functions must return nil if they are not responsible for this
  15045. property.")
  15046. (defun org-property-get-allowed-values (pom property &optional table)
  15047. "Get allowed values for the property PROPERTY.
  15048. When TABLE is non-nil, return an alist that can directly be used for
  15049. completion."
  15050. (let (vals)
  15051. (cond
  15052. ((equal property "TODO")
  15053. (setq vals (org-with-point-at pom
  15054. (append org-todo-keywords-1 '("")))))
  15055. ((equal property "PRIORITY")
  15056. (let ((n org-lowest-priority))
  15057. (while (>= n org-highest-priority)
  15058. (push (char-to-string n) vals)
  15059. (setq n (1- n)))))
  15060. ((equal property "CATEGORY"))
  15061. ((member property org-special-properties))
  15062. ((setq vals (run-hook-with-args-until-success
  15063. 'org-property-allowed-value-functions property)))
  15064. (t
  15065. (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
  15066. (when (and vals (string-match "\\S-" vals))
  15067. (setq vals (car (read-from-string (concat "(" vals ")"))))
  15068. (setq vals (mapcar (lambda (x)
  15069. (cond ((stringp x) x)
  15070. ((numberp x) (number-to-string x))
  15071. ((symbolp x) (symbol-name x))
  15072. (t "???")))
  15073. vals)))))
  15074. (when (member ":ETC" vals)
  15075. (setq vals (remove ":ETC" vals))
  15076. (org-add-props (car vals) '(org-unrestricted t)))
  15077. (if table (mapcar 'list vals) vals)))
  15078. (defun org-property-previous-allowed-value (&optional _previous)
  15079. "Switch to the next allowed value for this property."
  15080. (interactive)
  15081. (org-property-next-allowed-value t))
  15082. (defun org-property-next-allowed-value (&optional previous)
  15083. "Switch to the next allowed value for this property."
  15084. (interactive)
  15085. (unless (org-at-property-p)
  15086. (user-error "Not at a property"))
  15087. (let* ((prop (car (save-match-data (org-split-string (match-string 1) ":"))))
  15088. (key (match-string 2))
  15089. (value (match-string 3))
  15090. (allowed (or (org-property-get-allowed-values (point) key)
  15091. (and (member value '("[ ]" "[-]" "[X]"))
  15092. '("[ ]" "[X]"))))
  15093. (heading (save-match-data (nth 4 (org-heading-components))))
  15094. nval)
  15095. (unless allowed
  15096. (user-error "Allowed values for this property have not been defined"))
  15097. (when previous (setq allowed (reverse allowed)))
  15098. (when (member value allowed)
  15099. (setq nval (car (cdr (member value allowed)))))
  15100. (setq nval (or nval (car allowed)))
  15101. (when (equal nval value)
  15102. (user-error "Only one allowed value for this property"))
  15103. (org-at-property-p)
  15104. (replace-match (concat " :" key ": " nval) t t)
  15105. (org-indent-line)
  15106. (beginning-of-line 1)
  15107. (skip-chars-forward " \t")
  15108. (when (equal prop org-effort-property)
  15109. (org-refresh-property
  15110. '((effort . identity)
  15111. (effort-minutes . org-duration-string-to-minutes))
  15112. nval)
  15113. (when (string= org-clock-current-task heading)
  15114. (setq org-clock-effort nval)
  15115. (org-clock-update-mode-line)))
  15116. (run-hook-with-args 'org-property-changed-functions key nval)))
  15117. (defun org-find-olp (path &optional this-buffer)
  15118. "Return a marker pointing to the entry at outline path OLP.
  15119. If anything goes wrong, throw an error.
  15120. You can wrap this call to catch the error like this:
  15121. (condition-case msg
  15122. (org-mobile-locate-entry (match-string 4))
  15123. (error (nth 1 msg)))
  15124. The return value will then be either a string with the error message,
  15125. or a marker if everything is OK.
  15126. If THIS-BUFFER is set, the outline path does not contain a file,
  15127. only headings."
  15128. (let* ((file (if this-buffer buffer-file-name (pop path)))
  15129. (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
  15130. (level 1)
  15131. (lmin 1)
  15132. (lmax 1)
  15133. end found flevel)
  15134. (unless buffer (error "File not found :%s" file))
  15135. (with-current-buffer buffer
  15136. (org-with-wide-buffer
  15137. (goto-char (point-min))
  15138. (dolist (heading path)
  15139. (let ((re (format org-complex-heading-regexp-format
  15140. (regexp-quote heading)))
  15141. (cnt 0))
  15142. (while (re-search-forward re end t)
  15143. (setq level (- (match-end 1) (match-beginning 1)))
  15144. (when (and (>= level lmin) (<= level lmax))
  15145. (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
  15146. (when (= cnt 0)
  15147. (error "Heading not found on level %d: %s" lmax heading))
  15148. (when (> cnt 1)
  15149. (error "Heading not unique on level %d: %s" lmax heading))
  15150. (goto-char found)
  15151. (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
  15152. (setq end (save-excursion (org-end-of-subtree t t)))))
  15153. (when (org-at-heading-p)
  15154. (point-marker))))))
  15155. (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
  15156. "Find node HEADING in BUFFER.
  15157. Return a marker to the heading if it was found, or nil if not.
  15158. If POS-ONLY is set, return just the position instead of a marker.
  15159. The heading text must match exact, but it may have a TODO keyword,
  15160. a priority cookie and tags in the standard locations."
  15161. (with-current-buffer (or buffer (current-buffer))
  15162. (org-with-wide-buffer
  15163. (goto-char (point-min))
  15164. (let (case-fold-search)
  15165. (when (re-search-forward
  15166. (format org-complex-heading-regexp-format
  15167. (regexp-quote heading)) nil t)
  15168. (if pos-only
  15169. (match-beginning 0)
  15170. (move-marker (make-marker) (match-beginning 0))))))))
  15171. (defun org-find-exact-heading-in-directory (heading &optional dir)
  15172. "Find Org node headline HEADING in all .org files in directory DIR.
  15173. When the target headline is found, return a marker to this location."
  15174. (let ((files (directory-files (or dir default-directory)
  15175. t "\\`[^.#].*\\.org\\'"))
  15176. visiting m buffer)
  15177. (catch 'found
  15178. (dolist (file files)
  15179. (message "trying %s" file)
  15180. (setq visiting (org-find-base-buffer-visiting file))
  15181. (setq buffer (or visiting (find-file-noselect file)))
  15182. (setq m (org-find-exact-headline-in-buffer
  15183. heading buffer))
  15184. (when (and (not m) (not visiting)) (kill-buffer buffer))
  15185. (and m (throw 'found m))))))
  15186. (defun org-find-entry-with-id (ident)
  15187. "Locate the entry that contains the ID property with exact value IDENT.
  15188. IDENT can be a string, a symbol or a number, this function will search for
  15189. the string representation of it.
  15190. Return the position where this entry starts, or nil if there is no such entry."
  15191. (interactive "sID: ")
  15192. (let ((id (cond
  15193. ((stringp ident) ident)
  15194. ((symbolp ident) (symbol-name ident))
  15195. ((numberp ident) (number-to-string ident))
  15196. (t (error "IDENT %s must be a string, symbol or number" ident)))))
  15197. (org-with-wide-buffer (org-find-property "ID" id))))
  15198. ;;;; Timestamps
  15199. (defvar org-last-changed-timestamp nil)
  15200. (defvar org-last-inserted-timestamp nil
  15201. "The last time stamp inserted with `org-insert-time-stamp'.")
  15202. (defvar org-ts-what) ; dynamically scoped parameter
  15203. (defun org-time-stamp (arg &optional inactive)
  15204. "Prompt for a date/time and insert a time stamp.
  15205. If the user specifies a time like HH:MM or if this command is
  15206. called with at least one prefix argument, the time stamp contains
  15207. the date and the time. Otherwise, only the date is included.
  15208. All parts of a date not specified by the user are filled in from
  15209. the timestamp at point, if any, or the current date/time
  15210. otherwise.
  15211. If there is already a timestamp at the cursor, it is replaced.
  15212. With two universal prefix arguments, insert an active timestamp
  15213. with the current time without prompting the user.
  15214. When called from lisp, the timestamp is inactive if INACTIVE is
  15215. non-nil."
  15216. (interactive "P")
  15217. (let* ((ts (cond
  15218. ((org-at-date-range-p t)
  15219. (match-string (if (< (point) (- (match-beginning 2) 2)) 1 2)))
  15220. ((org-at-timestamp-p t) (match-string 0))))
  15221. ;; Default time is either the timestamp at point or today.
  15222. ;; When entering a range, only the range start is considered.
  15223. (default-time (if (not ts) (current-time)
  15224. (apply #'encode-time (org-parse-time-string ts))))
  15225. (default-input (and ts (org-get-compact-tod ts)))
  15226. (repeater (and ts
  15227. (string-match "\\([.+-]+[0-9]+[hdwmy] ?\\)+" ts)
  15228. (match-string 0 ts)))
  15229. org-time-was-given
  15230. org-end-time-was-given
  15231. (time
  15232. (and (if (equal arg '(16)) (current-time)
  15233. ;; Preserve `this-command' and `last-command'.
  15234. (let ((this-command this-command)
  15235. (last-command last-command))
  15236. (org-read-date
  15237. arg 'totime nil nil default-time default-input
  15238. inactive))))))
  15239. (cond
  15240. ((and ts
  15241. (memq last-command '(org-time-stamp org-time-stamp-inactive))
  15242. (memq this-command '(org-time-stamp org-time-stamp-inactive)))
  15243. (insert "--")
  15244. (org-insert-time-stamp time (or org-time-was-given arg) inactive))
  15245. (ts
  15246. ;; Make sure we're on a timestamp. When in the middle of a date
  15247. ;; range, move arbitrarily to range end.
  15248. (unless (org-at-timestamp-p t)
  15249. (skip-chars-forward "-")
  15250. (org-at-timestamp-p t))
  15251. (replace-match "")
  15252. (setq org-last-changed-timestamp
  15253. (org-insert-time-stamp
  15254. time (or org-time-was-given arg)
  15255. inactive nil nil (list org-end-time-was-given)))
  15256. (when repeater
  15257. (backward-char)
  15258. (insert " " repeater)
  15259. (setq org-last-changed-timestamp
  15260. (concat (substring org-last-inserted-timestamp 0 -1)
  15261. " " repeater ">")))
  15262. (message "Timestamp updated"))
  15263. ((equal arg '(16)) (org-insert-time-stamp time t inactive))
  15264. (t (org-insert-time-stamp
  15265. time (or org-time-was-given arg) inactive nil nil
  15266. (list org-end-time-was-given))))))
  15267. ;; FIXME: can we use this for something else, like computing time differences?
  15268. (defun org-get-compact-tod (s)
  15269. (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
  15270. (let* ((t1 (match-string 1 s))
  15271. (h1 (string-to-number (match-string 2 s)))
  15272. (m1 (string-to-number (match-string 3 s)))
  15273. (t2 (and (match-end 4) (match-string 5 s)))
  15274. (h2 (and t2 (string-to-number (match-string 6 s))))
  15275. (m2 (and t2 (string-to-number (match-string 7 s))))
  15276. dh dm)
  15277. (if (not t2)
  15278. t1
  15279. (setq dh (- h2 h1) dm (- m2 m1))
  15280. (when (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
  15281. (concat t1 "+" (number-to-string dh)
  15282. (and (/= 0 dm) (format ":%02d" dm)))))))
  15283. (defun org-time-stamp-inactive (&optional arg)
  15284. "Insert an inactive time stamp.
  15285. An inactive time stamp is enclosed in square brackets instead of angle
  15286. brackets. It is inactive in the sense that it does not trigger agenda entries,
  15287. does not link to the calendar and cannot be changed with the S-cursor keys.
  15288. So these are more for recording a certain time/date."
  15289. (interactive "P")
  15290. (org-time-stamp arg 'inactive))
  15291. (defvar org-date-ovl (make-overlay 1 1))
  15292. (overlay-put org-date-ovl 'face 'org-date-selected)
  15293. (delete-overlay org-date-ovl)
  15294. (defvar org-ans1) ; dynamically scoped parameter
  15295. (defvar org-ans2) ; dynamically scoped parameter
  15296. (defvar org-plain-time-of-day-regexp) ; defined below
  15297. (defvar org-overriding-default-time nil) ; dynamically scoped
  15298. (defvar org-read-date-overlay nil)
  15299. (defvar org-dcst nil) ; dynamically scoped
  15300. (defvar org-read-date-history nil)
  15301. (defvar org-read-date-final-answer nil)
  15302. (defvar org-read-date-analyze-futurep nil)
  15303. (defvar org-read-date-analyze-forced-year nil)
  15304. (defvar org-read-date-inactive)
  15305. (defvar org-read-date-minibuffer-local-map
  15306. (let* ((map (make-sparse-keymap)))
  15307. (set-keymap-parent map minibuffer-local-map)
  15308. (org-defkey map (kbd ".")
  15309. (lambda () (interactive)
  15310. ;; Are we at the beginning of the prompt?
  15311. (if (looking-back "^[^:]+: "
  15312. (let ((inhibit-field-text-motion t))
  15313. (line-beginning-position)))
  15314. (org-eval-in-calendar '(calendar-goto-today))
  15315. (insert "."))))
  15316. (org-defkey map (kbd "C-.")
  15317. (lambda () (interactive)
  15318. (org-eval-in-calendar '(calendar-goto-today))))
  15319. (org-defkey map [(meta shift left)]
  15320. (lambda () (interactive)
  15321. (org-eval-in-calendar '(calendar-backward-month 1))))
  15322. (org-defkey map [(meta shift right)]
  15323. (lambda () (interactive)
  15324. (org-eval-in-calendar '(calendar-forward-month 1))))
  15325. (org-defkey map [(meta shift up)]
  15326. (lambda () (interactive)
  15327. (org-eval-in-calendar '(calendar-backward-year 1))))
  15328. (org-defkey map [(meta shift down)]
  15329. (lambda () (interactive)
  15330. (org-eval-in-calendar '(calendar-forward-year 1))))
  15331. (org-defkey map [?\e (shift left)]
  15332. (lambda () (interactive)
  15333. (org-eval-in-calendar '(calendar-backward-month 1))))
  15334. (org-defkey map [?\e (shift right)]
  15335. (lambda () (interactive)
  15336. (org-eval-in-calendar '(calendar-forward-month 1))))
  15337. (org-defkey map [?\e (shift up)]
  15338. (lambda () (interactive)
  15339. (org-eval-in-calendar '(calendar-backward-year 1))))
  15340. (org-defkey map [?\e (shift down)]
  15341. (lambda () (interactive)
  15342. (org-eval-in-calendar '(calendar-forward-year 1))))
  15343. (org-defkey map [(shift up)]
  15344. (lambda () (interactive)
  15345. (org-eval-in-calendar '(calendar-backward-week 1))))
  15346. (org-defkey map [(shift down)]
  15347. (lambda () (interactive)
  15348. (org-eval-in-calendar '(calendar-forward-week 1))))
  15349. (org-defkey map [(shift left)]
  15350. (lambda () (interactive)
  15351. (org-eval-in-calendar '(calendar-backward-day 1))))
  15352. (org-defkey map [(shift right)]
  15353. (lambda () (interactive)
  15354. (org-eval-in-calendar '(calendar-forward-day 1))))
  15355. (org-defkey map "!"
  15356. (lambda () (interactive)
  15357. (org-eval-in-calendar '(diary-view-entries))
  15358. (message "")))
  15359. (org-defkey map ">"
  15360. (lambda () (interactive)
  15361. (org-eval-in-calendar '(calendar-scroll-left 1))))
  15362. (org-defkey map "<"
  15363. (lambda () (interactive)
  15364. (org-eval-in-calendar '(calendar-scroll-right 1))))
  15365. (org-defkey map "\C-v"
  15366. (lambda () (interactive)
  15367. (org-eval-in-calendar
  15368. '(calendar-scroll-left-three-months 1))))
  15369. (org-defkey map "\M-v"
  15370. (lambda () (interactive)
  15371. (org-eval-in-calendar
  15372. '(calendar-scroll-right-three-months 1))))
  15373. map)
  15374. "Keymap for minibuffer commands when using `org-read-date'.")
  15375. (defvar org-def)
  15376. (defvar org-defdecode)
  15377. (defvar org-with-time)
  15378. (defvar calendar-setup) ; Dynamically scoped.
  15379. (defun org-read-date (&optional with-time to-time from-string prompt
  15380. default-time default-input inactive)
  15381. "Read a date, possibly a time, and make things smooth for the user.
  15382. The prompt will suggest to enter an ISO date, but you can also enter anything
  15383. which will at least partially be understood by `parse-time-string'.
  15384. Unrecognized parts of the date will default to the current day, month, year,
  15385. hour and minute. If this command is called to replace a timestamp at point,
  15386. or to enter the second timestamp of a range, the default time is taken
  15387. from the existing stamp. Furthermore, the command prefers the future,
  15388. so if you are giving a date where the year is not given, and the day-month
  15389. combination is already past in the current year, it will assume you
  15390. mean next year. For details, see the manual. A few examples:
  15391. 3-2-5 --> 2003-02-05
  15392. feb 15 --> currentyear-02-15
  15393. 2/15 --> currentyear-02-15
  15394. sep 12 9 --> 2009-09-12
  15395. 12:45 --> today 12:45
  15396. 22 sept 0:34 --> currentyear-09-22 0:34
  15397. 12 --> currentyear-currentmonth-12
  15398. Fri --> nearest Friday after today
  15399. -Tue --> last Tuesday
  15400. etc.
  15401. Furthermore you can specify a relative date by giving, as the *first* thing
  15402. in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
  15403. change in days weeks, months, years.
  15404. With a single plus or minus, the date is relative to today. With a double
  15405. plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
  15406. +4d --> four days from today
  15407. +4 --> same as above
  15408. +2w --> two weeks from today
  15409. ++5 --> five days from default date
  15410. The function understands only English month and weekday abbreviations.
  15411. While prompting, a calendar is popped up - you can also select the
  15412. date with the mouse (button 1). The calendar shows a period of three
  15413. months. To scroll it to other months, use the keys `>' and `<'.
  15414. If you don't like the calendar, turn it off with
  15415. (setq org-read-date-popup-calendar nil)
  15416. With optional argument TO-TIME, the date will immediately be converted
  15417. to an internal time.
  15418. With an optional argument WITH-TIME, the prompt will suggest to
  15419. also insert a time. Note that when WITH-TIME is not set, you can
  15420. still enter a time, and this function will inform the calling routine
  15421. about this change. The calling routine may then choose to change the
  15422. format used to insert the time stamp into the buffer to include the time.
  15423. With optional argument FROM-STRING, read from this string instead from
  15424. the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
  15425. the time/date that is used for everything that is not specified by the
  15426. user."
  15427. (require 'parse-time)
  15428. (let* ((org-with-time with-time)
  15429. (org-time-stamp-rounding-minutes
  15430. (if (equal org-with-time '(16))
  15431. '(0 0)
  15432. org-time-stamp-rounding-minutes))
  15433. (org-dcst org-display-custom-times)
  15434. (ct (org-current-time))
  15435. (org-def (or org-overriding-default-time default-time ct))
  15436. (org-defdecode (decode-time org-def))
  15437. (cur-frame (selected-frame))
  15438. (mouse-autoselect-window nil) ; Don't let the mouse jump
  15439. (calendar-setup
  15440. (and (eq calendar-setup 'calendar-only) 'calendar-only))
  15441. (calendar-move-hook nil)
  15442. (calendar-view-diary-initially-flag nil)
  15443. (calendar-view-holidays-initially-flag nil)
  15444. ans (org-ans0 "") org-ans1 org-ans2 final cal-frame)
  15445. ;; Rationalize `org-def' and `org-defdecode', if required.
  15446. (when (< (nth 2 org-defdecode) org-extend-today-until)
  15447. (setf (nth 2 org-defdecode) -1)
  15448. (setf (nth 1 org-defdecode) 59)
  15449. (setq org-def (apply #'encode-time org-defdecode))
  15450. (setq org-defdecode (decode-time org-def)))
  15451. (let* ((timestr (format-time-string
  15452. (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d")
  15453. org-def))
  15454. (prompt (concat (if prompt (concat prompt " ") "")
  15455. (format "Date+time [%s]: " timestr))))
  15456. (cond
  15457. (from-string (setq ans from-string))
  15458. (org-read-date-popup-calendar
  15459. (save-excursion
  15460. (save-window-excursion
  15461. (calendar)
  15462. (when (eq calendar-setup 'calendar-only)
  15463. (setq cal-frame
  15464. (window-frame (get-buffer-window "*Calendar*" 'visible)))
  15465. (select-frame cal-frame))
  15466. (org-eval-in-calendar '(setq cursor-type nil) t)
  15467. (unwind-protect
  15468. (progn
  15469. (calendar-forward-day (- (time-to-days org-def)
  15470. (calendar-absolute-from-gregorian
  15471. (calendar-current-date))))
  15472. (org-eval-in-calendar nil t)
  15473. (let* ((old-map (current-local-map))
  15474. (map (copy-keymap calendar-mode-map))
  15475. (minibuffer-local-map
  15476. (copy-keymap org-read-date-minibuffer-local-map)))
  15477. (org-defkey map (kbd "RET") 'org-calendar-select)
  15478. (org-defkey map [mouse-1] 'org-calendar-select-mouse)
  15479. (org-defkey map [mouse-2] 'org-calendar-select-mouse)
  15480. (unwind-protect
  15481. (progn
  15482. (use-local-map map)
  15483. (setq org-read-date-inactive inactive)
  15484. (add-hook 'post-command-hook 'org-read-date-display)
  15485. (setq org-ans0
  15486. (read-string prompt
  15487. default-input
  15488. 'org-read-date-history
  15489. nil))
  15490. ;; org-ans0: from prompt
  15491. ;; org-ans1: from mouse click
  15492. ;; org-ans2: from calendar motion
  15493. (setq ans
  15494. (concat org-ans0 " " (or org-ans1 org-ans2))))
  15495. (remove-hook 'post-command-hook 'org-read-date-display)
  15496. (use-local-map old-map)
  15497. (when org-read-date-overlay
  15498. (delete-overlay org-read-date-overlay)
  15499. (setq org-read-date-overlay nil)))))
  15500. (bury-buffer "*Calendar*")
  15501. (when cal-frame
  15502. (delete-frame cal-frame)
  15503. (select-frame-set-input-focus cur-frame))))))
  15504. (t ; Naked prompt only
  15505. (unwind-protect
  15506. (setq ans (read-string prompt default-input
  15507. 'org-read-date-history timestr))
  15508. (when org-read-date-overlay
  15509. (delete-overlay org-read-date-overlay)
  15510. (setq org-read-date-overlay nil))))))
  15511. (setq final (org-read-date-analyze ans org-def org-defdecode))
  15512. (when org-read-date-analyze-forced-year
  15513. (message "Year was forced into %s"
  15514. (if org-read-date-force-compatible-dates
  15515. "compatible range (1970-2037)"
  15516. "range representable on this machine"))
  15517. (ding))
  15518. ;; One round trip to get rid of 34th of August and stuff like that....
  15519. (setq final (decode-time (apply 'encode-time final)))
  15520. (setq org-read-date-final-answer ans)
  15521. (if to-time
  15522. (apply 'encode-time final)
  15523. (if (and (boundp 'org-time-was-given) org-time-was-given)
  15524. (format "%04d-%02d-%02d %02d:%02d"
  15525. (nth 5 final) (nth 4 final) (nth 3 final)
  15526. (nth 2 final) (nth 1 final))
  15527. (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
  15528. (defun org-read-date-display ()
  15529. "Display the current date prompt interpretation in the minibuffer."
  15530. (when org-read-date-display-live
  15531. (when org-read-date-overlay
  15532. (delete-overlay org-read-date-overlay))
  15533. (when (minibufferp (current-buffer))
  15534. (save-excursion
  15535. (end-of-line 1)
  15536. (while (not (equal (buffer-substring
  15537. (max (point-min) (- (point) 4)) (point))
  15538. " "))
  15539. (insert " ")))
  15540. (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
  15541. " " (or org-ans1 org-ans2)))
  15542. (org-end-time-was-given nil)
  15543. (f (org-read-date-analyze ans org-def org-defdecode))
  15544. (fmts (if org-dcst
  15545. org-time-stamp-custom-formats
  15546. org-time-stamp-formats))
  15547. (fmt (if (or org-with-time
  15548. (and (boundp 'org-time-was-given) org-time-was-given))
  15549. (cdr fmts)
  15550. (car fmts)))
  15551. (txt (format-time-string fmt (apply 'encode-time f)))
  15552. (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
  15553. (txt (concat "=> " txt)))
  15554. (when (and org-end-time-was-given
  15555. (string-match org-plain-time-of-day-regexp txt))
  15556. (setq txt (concat (substring txt 0 (match-end 0)) "-"
  15557. org-end-time-was-given
  15558. (substring txt (match-end 0)))))
  15559. (when org-read-date-analyze-futurep
  15560. (setq txt (concat txt " (=>F)")))
  15561. (setq org-read-date-overlay
  15562. (make-overlay (1- (point-at-eol)) (point-at-eol)))
  15563. (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
  15564. (defun org-read-date-analyze (ans def defdecode)
  15565. "Analyze the combined answer of the date prompt."
  15566. ;; FIXME: cleanup and comment
  15567. ;; Pass `current-time' result to `decode-time' (instead of calling
  15568. ;; without arguments) so that only `current-time' has to be
  15569. ;; overriden in tests.
  15570. (let ((org-def def)
  15571. (org-defdecode defdecode)
  15572. (nowdecode (decode-time (current-time)))
  15573. delta deltan deltaw deltadef year month day
  15574. hour minute second wday pm h2 m2 tl wday1
  15575. iso-year iso-weekday iso-week iso-date futurep kill-year)
  15576. (setq org-read-date-analyze-futurep nil
  15577. org-read-date-analyze-forced-year nil)
  15578. (when (string-match "\\`[ \t]*\\.[ \t]*\\'" ans)
  15579. (setq ans "+0"))
  15580. (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
  15581. (setq ans (replace-match "" t t ans)
  15582. deltan (car delta)
  15583. deltaw (nth 1 delta)
  15584. deltadef (nth 2 delta)))
  15585. ;; Check if there is an iso week date in there. If yes, store the
  15586. ;; info and postpone interpreting it until the rest of the parsing
  15587. ;; is done.
  15588. (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
  15589. (setq iso-year (when (match-end 1)
  15590. (org-small-year-to-year
  15591. (string-to-number (match-string 1 ans))))
  15592. iso-weekday (when (match-end 3)
  15593. (string-to-number (match-string 3 ans)))
  15594. iso-week (string-to-number (match-string 2 ans)))
  15595. (setq ans (replace-match "" t t ans)))
  15596. ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
  15597. (when (string-match
  15598. "^ *\\(\\([0-9]+\\)-\\)?\\([0-1]?[0-9]\\)-\\([0-3]?[0-9]\\)\\([^-0-9]\\|$\\)" ans)
  15599. (setq year (if (match-end 2)
  15600. (string-to-number (match-string 2 ans))
  15601. (progn (setq kill-year t)
  15602. (string-to-number (format-time-string "%Y"))))
  15603. month (string-to-number (match-string 3 ans))
  15604. day (string-to-number (match-string 4 ans)))
  15605. (setq year (org-small-year-to-year year))
  15606. (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
  15607. t nil ans)))
  15608. ;; Help matching dotted european dates
  15609. (when (string-match
  15610. "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\.\\( ?[1-9][0-9]\\{3\\}\\)?" ans)
  15611. (setq year (if (match-end 3) (string-to-number (match-string 3 ans))
  15612. (setq kill-year t)
  15613. (string-to-number (format-time-string "%Y")))
  15614. day (string-to-number (match-string 1 ans))
  15615. month (string-to-number (match-string 2 ans))
  15616. ans (replace-match (format "%04d-%02d-%02d" year month day)
  15617. t nil ans)))
  15618. ;; Help matching american dates, like 5/30 or 5/30/7
  15619. (when (string-match
  15620. "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
  15621. (setq year (if (match-end 4)
  15622. (string-to-number (match-string 4 ans))
  15623. (progn (setq kill-year t)
  15624. (string-to-number (format-time-string "%Y"))))
  15625. month (string-to-number (match-string 1 ans))
  15626. day (string-to-number (match-string 2 ans)))
  15627. (setq year (org-small-year-to-year year))
  15628. (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
  15629. t nil ans)))
  15630. ;; Help matching am/pm times, because `parse-time-string' does not do that.
  15631. ;; If there is a time with am/pm, and *no* time without it, we convert
  15632. ;; so that matching will be successful.
  15633. (cl-loop for i from 1 to 2 do ; twice, for end time as well
  15634. (when (and (not (string-match "\\(\\`\\|[^+]\\)[012]?[0-9]:[0-9][0-9]\\([ \t\n]\\|$\\)" ans))
  15635. (string-match "\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\(am\\|AM\\|pm\\|PM\\)\\>" ans))
  15636. (setq hour (string-to-number (match-string 1 ans))
  15637. minute (if (match-end 3)
  15638. (string-to-number (match-string 3 ans))
  15639. 0)
  15640. pm (equal ?p
  15641. (string-to-char (downcase (match-string 4 ans)))))
  15642. (if (and (= hour 12) (not pm))
  15643. (setq hour 0)
  15644. (when (and pm (< hour 12)) (setq hour (+ 12 hour))))
  15645. (setq ans (replace-match (format "%02d:%02d" hour minute)
  15646. t t ans))))
  15647. ;; Check if a time range is given as a duration
  15648. (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
  15649. (setq hour (string-to-number (match-string 1 ans))
  15650. h2 (+ hour (string-to-number (match-string 3 ans)))
  15651. minute (string-to-number (match-string 2 ans))
  15652. m2 (+ minute (if (match-end 5) (string-to-number
  15653. (match-string 5 ans))0)))
  15654. (when (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
  15655. (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
  15656. t t ans)))
  15657. ;; Check if there is a time range
  15658. (when (boundp 'org-end-time-was-given)
  15659. (setq org-time-was-given nil)
  15660. (when (and (string-match org-plain-time-of-day-regexp ans)
  15661. (match-end 8))
  15662. (setq org-end-time-was-given (match-string 8 ans))
  15663. (setq ans (concat (substring ans 0 (match-beginning 7))
  15664. (substring ans (match-end 7))))))
  15665. (setq tl (parse-time-string ans)
  15666. day (or (nth 3 tl) (nth 3 org-defdecode))
  15667. month
  15668. (cond ((nth 4 tl))
  15669. ((not org-read-date-prefer-future) (nth 4 org-defdecode))
  15670. ;; Day was specified. Make sure DAY+MONTH
  15671. ;; combination happens in the future.
  15672. ((nth 3 tl)
  15673. (setq futurep t)
  15674. (if (< day (nth 3 nowdecode)) (1+ (nth 4 nowdecode))
  15675. (nth 4 nowdecode)))
  15676. (t (nth 4 org-defdecode)))
  15677. year
  15678. (cond ((and (not kill-year) (nth 5 tl)))
  15679. ((not org-read-date-prefer-future) (nth 5 org-defdecode))
  15680. ;; Month was guessed in the future and is at least
  15681. ;; equal to NOWDECODE's. Fix year accordingly.
  15682. (futurep
  15683. (if (or (> month (nth 4 nowdecode))
  15684. (>= day (nth 3 nowdecode)))
  15685. (nth 5 nowdecode)
  15686. (1+ (nth 5 nowdecode))))
  15687. ;; Month was specified. Make sure MONTH+YEAR
  15688. ;; combination happens in the future.
  15689. ((nth 4 tl)
  15690. (setq futurep t)
  15691. (cond ((> month (nth 4 nowdecode)) (nth 5 nowdecode))
  15692. ((< month (nth 4 nowdecode)) (1+ (nth 5 nowdecode)))
  15693. ((< day (nth 3 nowdecode)) (1+ (nth 5 nowdecode)))
  15694. (t (nth 5 nowdecode))))
  15695. (t (nth 5 org-defdecode)))
  15696. hour (or (nth 2 tl) (nth 2 org-defdecode))
  15697. minute (or (nth 1 tl) (nth 1 org-defdecode))
  15698. second (or (nth 0 tl) 0)
  15699. wday (nth 6 tl))
  15700. (when (and (eq org-read-date-prefer-future 'time)
  15701. (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
  15702. (equal day (nth 3 nowdecode))
  15703. (equal month (nth 4 nowdecode))
  15704. (equal year (nth 5 nowdecode))
  15705. (nth 2 tl)
  15706. (or (< (nth 2 tl) (nth 2 nowdecode))
  15707. (and (= (nth 2 tl) (nth 2 nowdecode))
  15708. (nth 1 tl)
  15709. (< (nth 1 tl) (nth 1 nowdecode)))))
  15710. (setq day (1+ day)
  15711. futurep t))
  15712. ;; Special date definitions below
  15713. (cond
  15714. (iso-week
  15715. ;; There was an iso week
  15716. (require 'cal-iso)
  15717. (setq futurep nil)
  15718. (setq year (or iso-year year)
  15719. day (or iso-weekday wday 1)
  15720. wday nil ; to make sure that the trigger below does not match
  15721. iso-date (calendar-gregorian-from-absolute
  15722. (calendar-iso-to-absolute
  15723. (list iso-week day year))))
  15724. ; FIXME: Should we also push ISO weeks into the future?
  15725. ; (when (and org-read-date-prefer-future
  15726. ; (not iso-year)
  15727. ; (< (calendar-absolute-from-gregorian iso-date)
  15728. ; (time-to-days (current-time))))
  15729. ; (setq year (1+ year)
  15730. ; iso-date (calendar-gregorian-from-absolute
  15731. ; (calendar-iso-to-absolute
  15732. ; (list iso-week day year)))))
  15733. (setq month (car iso-date)
  15734. year (nth 2 iso-date)
  15735. day (nth 1 iso-date)))
  15736. (deltan
  15737. (setq futurep nil)
  15738. (unless deltadef
  15739. ;; Pass `current-time' result to `decode-time' (instead of
  15740. ;; calling without arguments) so that only `current-time' has
  15741. ;; to be overriden in tests.
  15742. (let ((now (decode-time (current-time))))
  15743. (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
  15744. (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
  15745. ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
  15746. ((equal deltaw "m") (setq month (+ month deltan)))
  15747. ((equal deltaw "y") (setq year (+ year deltan)))))
  15748. ((and wday (not (nth 3 tl)))
  15749. ;; Weekday was given, but no day, so pick that day in the week
  15750. ;; on or after the derived date.
  15751. (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
  15752. (unless (equal wday wday1)
  15753. (setq day (+ day (% (- wday wday1 -7) 7))))))
  15754. (when (and (boundp 'org-time-was-given)
  15755. (nth 2 tl))
  15756. (setq org-time-was-given t))
  15757. (when (< year 100) (setq year (+ 2000 year)))
  15758. ;; Check of the date is representable
  15759. (if org-read-date-force-compatible-dates
  15760. (progn
  15761. (when (< year 1970)
  15762. (setq year 1970 org-read-date-analyze-forced-year t))
  15763. (when (> year 2037)
  15764. (setq year 2037 org-read-date-analyze-forced-year t)))
  15765. (condition-case nil
  15766. (ignore (encode-time second minute hour day month year))
  15767. (error
  15768. (setq year (nth 5 org-defdecode))
  15769. (setq org-read-date-analyze-forced-year t))))
  15770. (setq org-read-date-analyze-futurep futurep)
  15771. (list second minute hour day month year)))
  15772. (defvar parse-time-weekdays)
  15773. (defun org-read-date-get-relative (s today default)
  15774. "Check string S for special relative date string.
  15775. TODAY and DEFAULT are internal times, for today and for a default.
  15776. Return shift list (N what def-flag)
  15777. WHAT is \"d\", \"w\", \"m\", or \"y\" for day, week, month, year.
  15778. N is the number of WHATs to shift.
  15779. DEF-FLAG is t when a double ++ or -- indicates shift relative to
  15780. the DEFAULT date rather than TODAY."
  15781. (require 'parse-time)
  15782. (when (and
  15783. (string-match
  15784. (concat
  15785. "\\`[ \t]*\\([-+]\\{0,2\\}\\)"
  15786. "\\([0-9]+\\)?"
  15787. "\\([hdwmy]\\|\\(" (mapconcat 'car parse-time-weekdays "\\|") "\\)\\)?"
  15788. "\\([ \t]\\|$\\)") s)
  15789. (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
  15790. (let* ((dir (if (> (match-end 1) (match-beginning 1))
  15791. (string-to-char (substring (match-string 1 s) -1))
  15792. ?+))
  15793. (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
  15794. (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
  15795. (what (if (match-end 3) (match-string 3 s) "d"))
  15796. (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
  15797. (date (if rel default today))
  15798. (wday (nth 6 (decode-time date)))
  15799. delta)
  15800. (if wday1
  15801. (progn
  15802. (setq delta (mod (+ 7 (- wday1 wday)) 7))
  15803. (when (= delta 0) (setq delta 7))
  15804. (when (= dir ?-)
  15805. (setq delta (- delta 7))
  15806. (when (= delta 0) (setq delta -7)))
  15807. (when (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
  15808. (list delta "d" rel))
  15809. (list (* n (if (= dir ?-) -1 1)) what rel)))))
  15810. (defun org-order-calendar-date-args (arg1 arg2 arg3)
  15811. "Turn a user-specified date into the internal representation.
  15812. The internal representation needed by the calendar is (month day year).
  15813. This is a wrapper to handle the brain-dead convention in calendar that
  15814. user function argument order change dependent on argument order."
  15815. (pcase calendar-date-style
  15816. (`american (list arg1 arg2 arg3))
  15817. (`european (list arg2 arg1 arg3))
  15818. (`iso (list arg2 arg3 arg1))))
  15819. (defun org-eval-in-calendar (form &optional keepdate)
  15820. "Eval FORM in the calendar window and return to current window.
  15821. Unless KEEPDATE is non-nil, update `org-ans2' to the cursor date."
  15822. (let ((sf (selected-frame))
  15823. (sw (selected-window)))
  15824. (select-window (get-buffer-window "*Calendar*" t))
  15825. (eval form)
  15826. (when (and (not keepdate) (calendar-cursor-to-date))
  15827. (let* ((date (calendar-cursor-to-date))
  15828. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  15829. (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
  15830. (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
  15831. (select-window sw)
  15832. (select-frame-set-input-focus sf)))
  15833. (defun org-calendar-select ()
  15834. "Return to `org-read-date' with the date currently selected.
  15835. This is used by `org-read-date' in a temporary keymap for the calendar buffer."
  15836. (interactive)
  15837. (when (calendar-cursor-to-date)
  15838. (let* ((date (calendar-cursor-to-date))
  15839. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  15840. (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
  15841. (when (active-minibuffer-window) (exit-minibuffer))))
  15842. (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
  15843. "Insert a date stamp for the date given by the internal TIME.
  15844. See `format-time-string' for the format of TIME.
  15845. WITH-HM means use the stamp format that includes the time of the day.
  15846. INACTIVE means use square brackets instead of angular ones, so that the
  15847. stamp will not contribute to the agenda.
  15848. PRE and POST are optional strings to be inserted before and after the
  15849. stamp.
  15850. The command returns the inserted time stamp."
  15851. (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
  15852. stamp)
  15853. (when inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
  15854. (insert-before-markers (or pre ""))
  15855. (when (listp extra)
  15856. (setq extra (car extra))
  15857. (if (and (stringp extra)
  15858. (string-match "\\([0-9]+\\):\\([0-9]+\\)" extra))
  15859. (setq extra (format "-%02d:%02d"
  15860. (string-to-number (match-string 1 extra))
  15861. (string-to-number (match-string 2 extra))))
  15862. (setq extra nil)))
  15863. (when extra
  15864. (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
  15865. (insert-before-markers (setq stamp (format-time-string fmt time)))
  15866. (insert-before-markers (or post ""))
  15867. (setq org-last-inserted-timestamp stamp)))
  15868. (defun org-toggle-time-stamp-overlays ()
  15869. "Toggle the use of custom time stamp formats."
  15870. (interactive)
  15871. (setq org-display-custom-times (not org-display-custom-times))
  15872. (unless org-display-custom-times
  15873. (let ((p (point-min)) (bmp (buffer-modified-p)))
  15874. (while (setq p (next-single-property-change p 'display))
  15875. (when (and (get-text-property p 'display)
  15876. (eq (get-text-property p 'face) 'org-date))
  15877. (remove-text-properties
  15878. p (setq p (next-single-property-change p 'display))
  15879. '(display t))))
  15880. (set-buffer-modified-p bmp)))
  15881. (org-restart-font-lock)
  15882. (setq org-table-may-need-update t)
  15883. (if org-display-custom-times
  15884. (message "Time stamps are overlaid with custom format")
  15885. (message "Time stamp overlays removed")))
  15886. (defun org-display-custom-time (beg end)
  15887. "Overlay modified time stamp format over timestamp between BEG and END."
  15888. (let* ((ts (buffer-substring beg end))
  15889. t1 w1 with-hm tf time str w2 (off 0))
  15890. (save-match-data
  15891. (setq t1 (org-parse-time-string ts t))
  15892. (when (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
  15893. (setq off (- (match-end 0) (match-beginning 0)))))
  15894. (setq end (- end off))
  15895. (setq w1 (- end beg)
  15896. with-hm (and (nth 1 t1) (nth 2 t1))
  15897. tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
  15898. time (org-fix-decoded-time t1)
  15899. str (org-add-props
  15900. (format-time-string
  15901. (substring tf 1 -1) (apply 'encode-time time))
  15902. nil 'mouse-face 'highlight)
  15903. w2 (length str))
  15904. (unless (= w2 w1)
  15905. (add-text-properties (1+ beg) (+ 2 beg)
  15906. (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
  15907. (put-text-property beg end 'display str)))
  15908. (defun org-fix-decoded-time (time)
  15909. "Set 0 instead of nil for the first 6 elements of time.
  15910. Don't touch the rest."
  15911. (let ((n 0))
  15912. (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
  15913. (defun org-time-stamp-to-now (timestamp-string &optional seconds)
  15914. "Difference between TIMESTAMP-STRING and now in days.
  15915. If SECONDS is non-nil, return the difference in seconds."
  15916. (let ((fdiff (if seconds #'float-time #'time-to-days)))
  15917. (- (funcall fdiff (org-time-string-to-time timestamp-string))
  15918. (funcall fdiff (current-time)))))
  15919. (defun org-deadline-close-p (timestamp-string &optional ndays)
  15920. "Is the time in TIMESTAMP-STRING close to the current date?"
  15921. (setq ndays (or ndays (org-get-wdays timestamp-string)))
  15922. (and (<= (org-time-stamp-to-now timestamp-string) ndays)
  15923. (not (org-entry-is-done-p))))
  15924. (defun org-get-wdays (ts &optional delay zero-delay)
  15925. "Get the deadline lead time appropriate for timestring TS.
  15926. When DELAY is non-nil, get the delay time for scheduled items
  15927. instead of the deadline lead time. When ZERO-DELAY is non-nil
  15928. and `org-scheduled-delay-days' is 0, enforce 0 as the delay,
  15929. don't try to find the delay cookie in the scheduled timestamp."
  15930. (let ((tv (if delay org-scheduled-delay-days
  15931. org-deadline-warning-days)))
  15932. (cond
  15933. ((or (and delay (< tv 0))
  15934. (and delay zero-delay (<= tv 0))
  15935. (and (not delay) (<= tv 0)))
  15936. ;; Enforce this value no matter what
  15937. (- tv))
  15938. ((string-match "-\\([0-9]+\\)\\([hdwmy]\\)\\(\\'\\|>\\| \\)" ts)
  15939. ;; lead time is specified.
  15940. (floor (* (string-to-number (match-string 1 ts))
  15941. (cdr (assoc (match-string 2 ts)
  15942. '(("d" . 1) ("w" . 7)
  15943. ("m" . 30.4) ("y" . 365.25)
  15944. ("h" . 0.041667)))))))
  15945. ;; go for the default.
  15946. (t tv))))
  15947. (defun org-calendar-select-mouse (ev)
  15948. "Return to `org-read-date' with the date currently selected.
  15949. This is used by `org-read-date' in a temporary keymap for the calendar buffer."
  15950. (interactive "e")
  15951. (mouse-set-point ev)
  15952. (when (calendar-cursor-to-date)
  15953. (let* ((date (calendar-cursor-to-date))
  15954. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  15955. (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
  15956. (when (active-minibuffer-window) (exit-minibuffer))))
  15957. (defun org-check-deadlines (ndays)
  15958. "Check if there are any deadlines due or past due.
  15959. A deadline is considered due if it happens within `org-deadline-warning-days'
  15960. days from today's date. If the deadline appears in an entry marked DONE,
  15961. it is not shown. A numeric prefix argument NDAYS can be used to test that
  15962. many days. If the prefix is a raw `\\[universal-argument]', all deadlines \
  15963. are shown."
  15964. (interactive "P")
  15965. (let* ((org-warn-days
  15966. (cond
  15967. ((equal ndays '(4)) 100000)
  15968. (ndays (prefix-numeric-value ndays))
  15969. (t (abs org-deadline-warning-days))))
  15970. (case-fold-search nil)
  15971. (regexp (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
  15972. (callback
  15973. (lambda () (org-deadline-close-p (match-string 1) org-warn-days))))
  15974. (message "%d deadlines past-due or due within %d days"
  15975. (org-occur regexp nil callback)
  15976. org-warn-days)))
  15977. (defsubst org-re-timestamp (type)
  15978. "Return a regexp for timestamp TYPE.
  15979. Allowed values for TYPE are:
  15980. all: all timestamps
  15981. active: only active timestamps (<...>)
  15982. inactive: only inactive timestamps ([...])
  15983. scheduled: only scheduled timestamps
  15984. deadline: only deadline timestamps
  15985. closed: only closed time-stamps
  15986. When TYPE is nil, fall back on returning a regexp that matches
  15987. both scheduled and deadline timestamps."
  15988. (cl-case type
  15989. (all org-ts-regexp-both)
  15990. (active org-ts-regexp)
  15991. (inactive org-ts-regexp-inactive)
  15992. (scheduled org-scheduled-time-regexp)
  15993. (deadline org-deadline-time-regexp)
  15994. (closed org-closed-time-regexp)
  15995. (otherwise
  15996. (concat "\\<"
  15997. (regexp-opt (list org-deadline-string org-scheduled-string))
  15998. " *<\\([^>]+\\)>"))))
  15999. (defun org-check-before-date (d)
  16000. "Check if there are deadlines or scheduled entries before date D."
  16001. (interactive (list (org-read-date)))
  16002. (let* ((case-fold-search nil)
  16003. (regexp (org-re-timestamp org-ts-type))
  16004. (ts-type org-ts-type)
  16005. (callback
  16006. (lambda ()
  16007. (let ((match (match-string 1)))
  16008. (and (if (memq ts-type '(active inactive all))
  16009. (eq (org-element-type (save-excursion
  16010. (backward-char)
  16011. (org-element-context)))
  16012. 'timestamp)
  16013. (org-at-planning-p))
  16014. (time-less-p
  16015. (org-time-string-to-time match)
  16016. (org-time-string-to-time d)))))))
  16017. (message "%d entries before %s"
  16018. (org-occur regexp nil callback)
  16019. d)))
  16020. (defun org-check-after-date (d)
  16021. "Check if there are deadlines or scheduled entries after date D."
  16022. (interactive (list (org-read-date)))
  16023. (let* ((case-fold-search nil)
  16024. (regexp (org-re-timestamp org-ts-type))
  16025. (ts-type org-ts-type)
  16026. (callback
  16027. (lambda ()
  16028. (let ((match (match-string 1)))
  16029. (and (if (memq ts-type '(active inactive all))
  16030. (eq (org-element-type (save-excursion
  16031. (backward-char)
  16032. (org-element-context)))
  16033. 'timestamp)
  16034. (org-at-planning-p))
  16035. (not (time-less-p
  16036. (org-time-string-to-time match)
  16037. (org-time-string-to-time d))))))))
  16038. (message "%d entries after %s"
  16039. (org-occur regexp nil callback)
  16040. d)))
  16041. (defun org-check-dates-range (start-date end-date)
  16042. "Check for deadlines/scheduled entries between START-DATE and END-DATE."
  16043. (interactive (list (org-read-date nil nil nil "Range starts")
  16044. (org-read-date nil nil nil "Range end")))
  16045. (let ((case-fold-search nil)
  16046. (regexp (org-re-timestamp org-ts-type))
  16047. (callback
  16048. (let ((type org-ts-type))
  16049. (lambda ()
  16050. (let ((match (match-string 1)))
  16051. (and
  16052. (if (memq type '(active inactive all))
  16053. (eq (org-element-type (save-excursion
  16054. (backward-char)
  16055. (org-element-context)))
  16056. 'timestamp)
  16057. (org-at-planning-p))
  16058. (not (time-less-p
  16059. (org-time-string-to-time match)
  16060. (org-time-string-to-time start-date)))
  16061. (time-less-p
  16062. (org-time-string-to-time match)
  16063. (org-time-string-to-time end-date))))))))
  16064. (message "%d entries between %s and %s"
  16065. (org-occur regexp nil callback) start-date end-date)))
  16066. (defun org-evaluate-time-range (&optional to-buffer)
  16067. "Evaluate a time range by computing the difference between start and end.
  16068. Normally the result is just printed in the echo area, but with prefix arg
  16069. TO-BUFFER, the result is inserted just after the date stamp into the buffer.
  16070. If the time range is actually in a table, the result is inserted into the
  16071. next column.
  16072. For time difference computation, a year is assumed to be exactly 365
  16073. days in order to avoid rounding problems."
  16074. (interactive "P")
  16075. (or
  16076. (org-clock-update-time-maybe)
  16077. (save-excursion
  16078. (unless (org-at-date-range-p t)
  16079. (goto-char (point-at-bol))
  16080. (re-search-forward org-tr-regexp-both (point-at-eol) t))
  16081. (unless (org-at-date-range-p t)
  16082. (user-error "Not at a time-stamp range, and none found in current line")))
  16083. (let* ((ts1 (match-string 1))
  16084. (ts2 (match-string 2))
  16085. (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
  16086. (match-end (match-end 0))
  16087. (time1 (org-time-string-to-time ts1))
  16088. (time2 (org-time-string-to-time ts2))
  16089. (t1 (float-time time1))
  16090. (t2 (float-time time2))
  16091. (diff (abs (- t2 t1)))
  16092. (negative (< (- t2 t1) 0))
  16093. ;; (ys (floor (* 365 24 60 60)))
  16094. (ds (* 24 60 60))
  16095. (hs (* 60 60))
  16096. (fy "%dy %dd %02d:%02d")
  16097. (fy1 "%dy %dd")
  16098. (fd "%dd %02d:%02d")
  16099. (fd1 "%dd")
  16100. (fh "%02d:%02d")
  16101. y d h m align)
  16102. (if havetime
  16103. (setq ; y (floor (/ diff ys)) diff (mod diff ys)
  16104. y 0
  16105. d (floor (/ diff ds)) diff (mod diff ds)
  16106. h (floor (/ diff hs)) diff (mod diff hs)
  16107. m (floor (/ diff 60)))
  16108. (setq ; y (floor (/ diff ys)) diff (mod diff ys)
  16109. y 0
  16110. d (floor (+ (/ diff ds) 0.5))
  16111. h 0 m 0))
  16112. (if (not to-buffer)
  16113. (message "%s" (org-make-tdiff-string y d h m))
  16114. (if (org-at-table-p)
  16115. (progn
  16116. (goto-char match-end)
  16117. (setq align t)
  16118. (and (looking-at " *|") (goto-char (match-end 0))))
  16119. (goto-char match-end))
  16120. (when (looking-at
  16121. "\\( *-? *[0-9]+y\\)?\\( *[0-9]+d\\)? *[0-9][0-9]:[0-9][0-9]")
  16122. (replace-match ""))
  16123. (when negative (insert " -"))
  16124. (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
  16125. (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
  16126. (insert " " (format fh h m))))
  16127. (when align (org-table-align))
  16128. (message "Time difference inserted")))))
  16129. (defun org-make-tdiff-string (y d h m)
  16130. (let ((fmt "")
  16131. (l nil))
  16132. (when (> y 0)
  16133. (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " "))
  16134. (push y l))
  16135. (when (> d 0)
  16136. (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " "))
  16137. (push d l))
  16138. (when (> h 0)
  16139. (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " "))
  16140. (push h l))
  16141. (when (> m 0)
  16142. (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " "))
  16143. (push m l))
  16144. (apply 'format fmt (nreverse l))))
  16145. (defun org-time-string-to-time (s &optional buffer pos)
  16146. "Convert a timestamp string into internal time."
  16147. (condition-case errdata
  16148. (apply 'encode-time (org-parse-time-string s))
  16149. (error (error "Bad timestamp `%s'%s\nError was: %s"
  16150. s (if (not (and buffer pos))
  16151. ""
  16152. (format-message " at %d in buffer `%s'" pos buffer))
  16153. (cdr errdata)))))
  16154. (defun org-time-string-to-seconds (s)
  16155. "Convert a timestamp string to a number of seconds."
  16156. (float-time (org-time-string-to-time s)))
  16157. (org-define-error 'org-diary-sexp-no-match "Unable to match diary sexp")
  16158. (defun org-time-string-to-absolute (s &optional daynr prefer buffer pos)
  16159. "Convert time stamp S to an absolute day number.
  16160. If DAYNR in non-nil, and there is a specifier for a cyclic time
  16161. stamp, get the closest date to DAYNR. If PREFER is
  16162. `past' (respectively `future') return a date past (respectively
  16163. after) or equal to DAYNR.
  16164. POS is the location of time stamp S, as a buffer position in
  16165. BUFFER.
  16166. Diary sexp timestamps are matched against DAYNR, when non-nil.
  16167. If matching fails or DAYNR is nil, `org-diary-sexp-no-match' is
  16168. signalled."
  16169. (cond
  16170. ((string-match "\\`%%\\((.*)\\)" s)
  16171. ;; Sexp timestamp: try to match DAYNR, if available, since we're
  16172. ;; only able to match individual dates. If it fails, raise an
  16173. ;; error.
  16174. (if (and daynr
  16175. (org-diary-sexp-entry
  16176. (match-string 1 s) "" (calendar-gregorian-from-absolute daynr)))
  16177. daynr
  16178. (signal 'org-diary-sexp-no-match (list s))))
  16179. (daynr (org-closest-date s daynr prefer))
  16180. (t (time-to-days
  16181. (condition-case errdata
  16182. (apply #'encode-time (org-parse-time-string s))
  16183. (error (error "Bad timestamp `%s'%s\nError was: %s"
  16184. s
  16185. (if (not (and buffer pos)) ""
  16186. (format-message " at %d in buffer `%s'" pos buffer))
  16187. (cdr errdata))))))))
  16188. (defun org-days-to-iso-week (days)
  16189. "Return the iso week number."
  16190. (require 'cal-iso)
  16191. (car (calendar-iso-from-absolute days)))
  16192. (defun org-small-year-to-year (year)
  16193. "Convert 2-digit years into 4-digit years.
  16194. YEAR is expanded into one of the 30 next years, if possible, or
  16195. into a past one. Any year larger than 99 is returned unchanged."
  16196. (if (>= year 100) year
  16197. (let* ((current (string-to-number (format-time-string "%Y" (current-time))))
  16198. (century (/ current 100))
  16199. (offset (- year (% current 100))))
  16200. (cond ((> offset 30) (+ (* (1- century) 100) year))
  16201. ((> offset -70) (+ (* century 100) year))
  16202. (t (+ (* (1+ century) 100) year))))))
  16203. (defun org-time-from-absolute (d)
  16204. "Return the time corresponding to date D.
  16205. D may be an absolute day number, or a calendar-type list (month day year)."
  16206. (when (numberp d) (setq d (calendar-gregorian-from-absolute d)))
  16207. (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
  16208. (defvar org-agenda-current-date)
  16209. (defun org-calendar-holiday ()
  16210. "List of holidays, for Diary display in Org mode."
  16211. (require 'holidays)
  16212. (let ((hl (calendar-check-holidays org-agenda-current-date)))
  16213. (and hl (mapconcat #'identity hl "; "))))
  16214. (defun org-diary-sexp-entry (sexp entry d)
  16215. "Process a SEXP diary ENTRY for date D."
  16216. (require 'diary-lib)
  16217. ;; `org-anniversary' and alike expect ENTRY and DATE to be bound
  16218. ;; dynamically.
  16219. (let* ((sexp `(let ((entry ,entry)
  16220. (date ',d))
  16221. ,(car (read-from-string sexp))))
  16222. (result (if calendar-debug-sexp (eval sexp)
  16223. (condition-case nil
  16224. (eval sexp)
  16225. (error
  16226. (beep)
  16227. (message "Bad sexp at line %d in %s: %s"
  16228. (org-current-line)
  16229. (buffer-file-name) sexp)
  16230. (sleep-for 2))))))
  16231. (cond ((stringp result) (split-string result "; "))
  16232. ((and (consp result)
  16233. (not (consp (cdr result)))
  16234. (stringp (cdr result))) (cdr result))
  16235. ((and (consp result)
  16236. (stringp (car result))) result)
  16237. (result entry))))
  16238. (defun org-diary-to-ical-string (frombuf)
  16239. "Get iCalendar entries from diary entries in buffer FROMBUF.
  16240. This uses the icalendar.el library."
  16241. (let* ((tmpdir temporary-file-directory)
  16242. (tmpfile (make-temp-name
  16243. (expand-file-name "orgics" tmpdir)))
  16244. buf rtn b e)
  16245. (with-current-buffer frombuf
  16246. (icalendar-export-region (point-min) (point-max) tmpfile)
  16247. (setq buf (find-buffer-visiting tmpfile))
  16248. (set-buffer buf)
  16249. (goto-char (point-min))
  16250. (when (re-search-forward "^BEGIN:VEVENT" nil t)
  16251. (setq b (match-beginning 0)))
  16252. (goto-char (point-max))
  16253. (when (re-search-backward "^END:VEVENT" nil t)
  16254. (setq e (match-end 0)))
  16255. (setq rtn (if (and b e) (concat (buffer-substring b e) "\n") "")))
  16256. (kill-buffer buf)
  16257. (delete-file tmpfile)
  16258. rtn))
  16259. (defun org-closest-date (start current prefer)
  16260. "Return closest date to CURRENT starting from START.
  16261. CURRENT and START are both time stamps.
  16262. When PREFER is `past', return a date that is either CURRENT or
  16263. past. When PREFER is `future', return a date that is either
  16264. CURRENT or future.
  16265. Only time stamps with a repeater are modified. Any other time
  16266. stamp stay unchanged. In any case, return value is an absolute
  16267. day number."
  16268. (if (not (string-match "\\+\\([0-9]+\\)\\([hdwmy]\\)" start))
  16269. ;; No repeater. Do not shift time stamp.
  16270. (time-to-days (apply #'encode-time (org-parse-time-string start)))
  16271. (let ((value (string-to-number (match-string 1 start)))
  16272. (type (match-string 2 start)))
  16273. (if (= 0 value)
  16274. ;; Repeater with a 0-value is considered as void.
  16275. (time-to-days (apply #'encode-time (org-parse-time-string start)))
  16276. (let* ((base (org-date-to-gregorian start))
  16277. (target (org-date-to-gregorian current))
  16278. (sday (calendar-absolute-from-gregorian base))
  16279. (cday (calendar-absolute-from-gregorian target))
  16280. n1 n2)
  16281. ;; If START is already past CURRENT, just return START.
  16282. (if (<= cday sday) sday
  16283. ;; Compute closest date before (N1) and closest date past
  16284. ;; (N2) CURRENT.
  16285. (pcase type
  16286. ("h"
  16287. (let ((missing-hours
  16288. (mod (+ (- (* 24 (- cday sday))
  16289. (nth 2 (org-parse-time-string start)))
  16290. org-extend-today-until)
  16291. value)))
  16292. (setf n1 (if (= missing-hours 0) cday
  16293. (- cday (1+ (/ missing-hours 24)))))
  16294. (setf n2 (+ cday (/ (- value missing-hours) 24)))))
  16295. ((or "d" "w")
  16296. (let ((value (if (equal type "w") (* 7 value) value)))
  16297. (setf n1 (+ sday (* value (/ (- cday sday) value))))
  16298. (setf n2 (+ n1 value))))
  16299. ("m"
  16300. (let* ((add-months
  16301. (lambda (d n)
  16302. ;; Add N months to gregorian date D, i.e.,
  16303. ;; a list (MONTH DAY YEAR). Return a valid
  16304. ;; gregorian date.
  16305. (let ((m (+ (nth 0 d) n)))
  16306. (list (mod m 12)
  16307. (nth 1 d)
  16308. (+ (/ m 12) (nth 2 d))))))
  16309. (months ; Complete months to TARGET.
  16310. (* (/ (+ (* 12 (- (nth 2 target) (nth 2 base)))
  16311. (- (nth 0 target) (nth 0 base))
  16312. ;; If START's day is greater than
  16313. ;; TARGET's, remove incomplete month.
  16314. (if (> (nth 1 target) (nth 1 base)) 0 -1))
  16315. value)
  16316. value))
  16317. (before (funcall add-months base months)))
  16318. (setf n1 (calendar-absolute-from-gregorian before))
  16319. (setf n2
  16320. (calendar-absolute-from-gregorian
  16321. (funcall add-months before value)))))
  16322. (_
  16323. (let* ((d (nth 1 base))
  16324. (m (nth 0 base))
  16325. (y (nth 2 base))
  16326. (years ; Complete years to TARGET.
  16327. (* (/ (- (nth 2 target)
  16328. y
  16329. ;; If START's month and day are
  16330. ;; greater than TARGET's, remove
  16331. ;; incomplete year.
  16332. (if (or (> (nth 0 target) m)
  16333. (and (= (nth 0 target) m)
  16334. (> (nth 1 target) d)))
  16335. 0
  16336. 1))
  16337. value)
  16338. value))
  16339. (before (list m d (+ y years))))
  16340. (setf n1 (calendar-absolute-from-gregorian before))
  16341. (setf n2 (calendar-absolute-from-gregorian
  16342. (list m d (+ (nth 2 before) value)))))))
  16343. ;; Handle PREFER parameter, if any.
  16344. (cond
  16345. ((eq prefer 'past) (if (= cday n2) n2 n1))
  16346. ((eq prefer 'future) (if (= cday n1) n1 n2))
  16347. (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))))))))
  16348. (defun org-date-to-gregorian (d)
  16349. "Turn any specification of date D into a Gregorian date for the calendar."
  16350. (cond ((integerp d) (calendar-gregorian-from-absolute d))
  16351. ((and (listp d) (= (length d) 3)) d)
  16352. ((stringp d)
  16353. (let ((d (org-parse-time-string d)))
  16354. (list (nth 4 d) (nth 3 d) (nth 5 d))))
  16355. ((listp d) (list (nth 4 d) (nth 3 d) (nth 5 d)))))
  16356. (defun org-parse-time-string (s &optional nodefault)
  16357. "Parse the standard Org time string.
  16358. This should be a lot faster than the normal `parse-time-string'.
  16359. If time is not given, defaults to 0:00. However, with optional NODEFAULT,
  16360. hour and minute fields will be nil if not given."
  16361. (cond ((string-match org-ts-regexp0 s)
  16362. (list 0
  16363. (when (or (match-beginning 8) (not nodefault))
  16364. (string-to-number (or (match-string 8 s) "0")))
  16365. (when (or (match-beginning 7) (not nodefault))
  16366. (string-to-number (or (match-string 7 s) "0")))
  16367. (string-to-number (match-string 4 s))
  16368. (string-to-number (match-string 3 s))
  16369. (string-to-number (match-string 2 s))
  16370. nil nil nil))
  16371. ((string-match "^<[^>]+>$" s)
  16372. (decode-time (seconds-to-time (org-matcher-time s))))
  16373. (t (error "Not a standard Org time string: %s" s))))
  16374. (defun org-timestamp-up (&optional arg)
  16375. "Increase the date item at the cursor by one.
  16376. If the cursor is on the year, change the year. If it is on the month,
  16377. the day or the time, change that.
  16378. With prefix ARG, change by that many units."
  16379. (interactive "p")
  16380. (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
  16381. (defun org-timestamp-down (&optional arg)
  16382. "Decrease the date item at the cursor by one.
  16383. If the cursor is on the year, change the year. If it is on the month,
  16384. the day or the time, change that.
  16385. With prefix ARG, change by that many units."
  16386. (interactive "p")
  16387. (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
  16388. (defun org-timestamp-up-day (&optional arg)
  16389. "Increase the date in the time stamp by one day.
  16390. With prefix ARG, change that many days."
  16391. (interactive "p")
  16392. (if (and (not (org-at-timestamp-p t))
  16393. (org-at-heading-p))
  16394. (org-todo 'up)
  16395. (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
  16396. (defun org-timestamp-down-day (&optional arg)
  16397. "Decrease the date in the time stamp by one day.
  16398. With prefix ARG, change that many days."
  16399. (interactive "p")
  16400. (if (and (not (org-at-timestamp-p t))
  16401. (org-at-heading-p))
  16402. (org-todo 'down)
  16403. (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
  16404. (defun org-at-timestamp-p (&optional inactive-ok)
  16405. "Non-nil if point is inside a timestamp.
  16406. When optional argument INACTIVE-OK is non-nil, also consider
  16407. inactive timestamps.
  16408. When this function returns a non-nil value, match data is set
  16409. according to `org-ts-regexp3' or `org-ts-regexp2', depending on
  16410. INACTIVE-OK."
  16411. (interactive)
  16412. (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
  16413. (pos (point))
  16414. (ans (or (looking-at tsr)
  16415. (save-excursion
  16416. (skip-chars-backward "^[<\n\r\t")
  16417. (when (> (point) (point-min)) (backward-char 1))
  16418. (and (looking-at tsr)
  16419. (> (- (match-end 0) pos) -1))))))
  16420. (and ans
  16421. (boundp 'org-ts-what)
  16422. (setq org-ts-what
  16423. (cond
  16424. ((= pos (match-beginning 0)) 'bracket)
  16425. ;; Point is considered to be "on the bracket" whether
  16426. ;; it's really on it or right after it.
  16427. ((= pos (1- (match-end 0))) 'bracket)
  16428. ((= pos (match-end 0)) 'after)
  16429. ((org-pos-in-match-range pos 2) 'year)
  16430. ((org-pos-in-match-range pos 3) 'month)
  16431. ((org-pos-in-match-range pos 7) 'hour)
  16432. ((org-pos-in-match-range pos 8) 'minute)
  16433. ((or (org-pos-in-match-range pos 4)
  16434. (org-pos-in-match-range pos 5)) 'day)
  16435. ((and (> pos (or (match-end 8) (match-end 5)))
  16436. (< pos (match-end 0)))
  16437. (- pos (or (match-end 8) (match-end 5))))
  16438. (t 'day))))
  16439. ans))
  16440. (defun org-toggle-timestamp-type ()
  16441. "Toggle the type (<active> or [inactive]) of a time stamp."
  16442. (interactive)
  16443. (when (org-at-timestamp-p t)
  16444. (let ((beg (match-beginning 0)) (end (match-end 0))
  16445. (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
  16446. (save-excursion
  16447. (goto-char beg)
  16448. (while (re-search-forward "[][<>]" end t)
  16449. (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
  16450. t t)))
  16451. (message "Timestamp is now %sactive"
  16452. (if (equal (char-after beg) ?<) "" "in")))))
  16453. (defun org-at-clock-log-p nil
  16454. "Is the cursor on the clock log line?"
  16455. (save-excursion
  16456. (beginning-of-line)
  16457. (looking-at org-clock-line-re)))
  16458. (defvar org-clock-history) ; defined in org-clock.el
  16459. (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
  16460. (defun org-timestamp-change (n &optional what updown suppress-tmp-delay)
  16461. "Change the date in the time stamp at point.
  16462. The date will be changed by N times WHAT. WHAT can be `day', `month',
  16463. `year', `minute', `second'. If WHAT is not given, the cursor position
  16464. in the timestamp determines what will be changed.
  16465. When SUPPRESS-TMP-DELAY is non-nil, suppress delays like \"--2d\"."
  16466. (let ((origin (point)) origin-cat
  16467. with-hm inactive
  16468. (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
  16469. org-ts-what
  16470. extra rem
  16471. ts time time0 fixnext clrgx)
  16472. (unless (org-at-timestamp-p t)
  16473. (user-error "Not at a timestamp"))
  16474. (if (and (not what) (eq org-ts-what 'bracket))
  16475. (org-toggle-timestamp-type)
  16476. ;; Point isn't on brackets. Remember the part of the time-stamp
  16477. ;; the point was in. Indeed, size of time-stamps may change,
  16478. ;; but point must be kept in the same category nonetheless.
  16479. (setq origin-cat org-ts-what)
  16480. (when (and (not what) (not (eq org-ts-what 'day))
  16481. org-display-custom-times
  16482. (get-text-property (point) 'display)
  16483. (not (get-text-property (1- (point)) 'display)))
  16484. (setq org-ts-what 'day))
  16485. (setq org-ts-what (or what org-ts-what)
  16486. inactive (= (char-after (match-beginning 0)) ?\[)
  16487. ts (match-string 0))
  16488. (replace-match "")
  16489. (when (string-match
  16490. "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?-?[-+][0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)*\\)[]>]"
  16491. ts)
  16492. (setq extra (match-string 1 ts))
  16493. (when suppress-tmp-delay
  16494. (setq extra (replace-regexp-in-string " --[0-9]+[hdwmy]" "" extra))))
  16495. (when (string-match "^.\\{10\\}.*?[0-9]+:[0-9][0-9]" ts)
  16496. (setq with-hm t))
  16497. (setq time0 (org-parse-time-string ts))
  16498. (when (and updown
  16499. (eq org-ts-what 'minute)
  16500. (not current-prefix-arg))
  16501. ;; This looks like s-up and s-down. Change by one rounding step.
  16502. (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
  16503. (unless (= 0 (setq rem (% (nth 1 time0) dm)))
  16504. (setcar (cdr time0) (+ (nth 1 time0)
  16505. (if (> n 0) (- rem) (- dm rem))))))
  16506. (setq time
  16507. (apply #'encode-time
  16508. (or (car time0) 0)
  16509. (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
  16510. (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
  16511. (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
  16512. (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
  16513. (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
  16514. (nthcdr 6 time0)))
  16515. (when (and (member org-ts-what '(hour minute))
  16516. extra
  16517. (string-match "-\\([012][0-9]\\):\\([0-5][0-9]\\)" extra))
  16518. (setq extra (org-modify-ts-extra
  16519. extra
  16520. (if (eq org-ts-what 'hour) 2 5)
  16521. n dm)))
  16522. (when (integerp org-ts-what)
  16523. (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
  16524. (when (eq what 'calendar)
  16525. (let ((cal-date (org-get-date-from-calendar)))
  16526. (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
  16527. (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
  16528. (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
  16529. (setcar time0 (or (car time0) 0))
  16530. (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
  16531. (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
  16532. (setq time (apply 'encode-time time0))))
  16533. ;; Insert the new time-stamp, and ensure point stays in the same
  16534. ;; category as before (i.e. not after the last position in that
  16535. ;; category).
  16536. (let ((pos (point)))
  16537. ;; Stay before inserted string. `save-excursion' is of no use.
  16538. (setq org-last-changed-timestamp
  16539. (org-insert-time-stamp time with-hm inactive nil nil extra))
  16540. (goto-char pos))
  16541. (save-match-data
  16542. (looking-at org-ts-regexp3)
  16543. (goto-char
  16544. (pcase origin-cat
  16545. ;; `day' category ends before `hour' if any, or at the end
  16546. ;; of the day name.
  16547. (`day (min (or (match-beginning 7) (1- (match-end 5))) origin))
  16548. (`hour (min (match-end 7) origin))
  16549. (`minute (min (1- (match-end 8)) origin))
  16550. ((pred integerp) (min (1- (match-end 0)) origin))
  16551. ;; Point was right after the time-stamp. However, the
  16552. ;; time-stamp length might have changed, so refer to
  16553. ;; (match-end 0) instead.
  16554. (`after (match-end 0))
  16555. ;; `year' and `month' have both fixed size: point couldn't
  16556. ;; have moved into another part.
  16557. (_ origin))))
  16558. ;; Update clock if on a CLOCK line.
  16559. (org-clock-update-time-maybe)
  16560. ;; Maybe adjust the closest clock in `org-clock-history'
  16561. (when org-clock-adjust-closest
  16562. (if (not (and (org-at-clock-log-p)
  16563. (< 1 (length (delq nil (mapcar 'marker-position
  16564. org-clock-history))))))
  16565. (message "No clock to adjust")
  16566. (cond ((save-excursion ; fix previous clock?
  16567. (re-search-backward org-ts-regexp0 nil t)
  16568. (looking-back (concat org-clock-string " \\[")
  16569. (line-beginning-position)))
  16570. (setq fixnext 1 clrgx (concat org-ts-regexp0 "\\] =>.*$")))
  16571. ((save-excursion ; fix next clock?
  16572. (re-search-backward org-ts-regexp0 nil t)
  16573. (looking-at (concat org-ts-regexp0 "\\] =>")))
  16574. (setq fixnext -1 clrgx (concat org-clock-string " \\[" org-ts-regexp0))))
  16575. (save-window-excursion
  16576. ;; Find closest clock to point, adjust the previous/next one in history
  16577. (let* ((p (save-excursion (org-back-to-heading t)))
  16578. (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
  16579. (clfixnth
  16580. (+ fixnext (- (length cl) (or (length (member (apply 'min cl) cl)) 100))))
  16581. (clfixpos (unless (> 0 clfixnth) (nth clfixnth org-clock-history))))
  16582. (if (not clfixpos)
  16583. (message "No clock to adjust")
  16584. (save-excursion
  16585. (org-goto-marker-or-bmk clfixpos)
  16586. (org-show-subtree)
  16587. (when (re-search-forward clrgx nil t)
  16588. (goto-char (match-beginning 1))
  16589. (let (org-clock-adjust-closest)
  16590. (org-timestamp-change n org-ts-what updown))
  16591. (message "Clock adjusted in %s for heading: %s"
  16592. (file-name-nondirectory (buffer-file-name))
  16593. (org-get-heading t t)))))))))
  16594. ;; Try to recenter the calendar window, if any.
  16595. (when (and org-calendar-follow-timestamp-change
  16596. (get-buffer-window "*Calendar*" t)
  16597. (memq org-ts-what '(day month year)))
  16598. (org-recenter-calendar (time-to-days time))))))
  16599. (defun org-modify-ts-extra (s pos n dm)
  16600. "Change the different parts of the lead-time and repeat fields in timestamp."
  16601. (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
  16602. ng h m new rem)
  16603. (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
  16604. (cond
  16605. ((or (org-pos-in-match-range pos 2)
  16606. (org-pos-in-match-range pos 3))
  16607. (setq m (string-to-number (match-string 3 s))
  16608. h (string-to-number (match-string 2 s)))
  16609. (if (org-pos-in-match-range pos 2)
  16610. (setq h (+ h n))
  16611. (setq n (* dm (with-no-warnings (signum n))))
  16612. (unless (= 0 (setq rem (% m dm)))
  16613. (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
  16614. (setq m (+ m n)))
  16615. (when (< m 0) (setq m (+ m 60) h (1- h)))
  16616. (when (> m 59) (setq m (- m 60) h (1+ h)))
  16617. (setq h (mod h 24))
  16618. (setq ng 1 new (format "-%02d:%02d" h m)))
  16619. ((org-pos-in-match-range pos 6)
  16620. (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
  16621. ((org-pos-in-match-range pos 5)
  16622. (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
  16623. ((org-pos-in-match-range pos 9)
  16624. (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
  16625. ((org-pos-in-match-range pos 8)
  16626. (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
  16627. (when ng
  16628. (setq s (concat
  16629. (substring s 0 (match-beginning ng))
  16630. new
  16631. (substring s (match-end ng))))))
  16632. s))
  16633. (defun org-recenter-calendar (d)
  16634. "If the calendar is visible, recenter it to date D."
  16635. (let ((cwin (get-buffer-window "*Calendar*" t)))
  16636. (when cwin
  16637. (let ((calendar-move-hook nil))
  16638. (with-selected-window cwin
  16639. (calendar-goto-date
  16640. (if (listp d) d (calendar-gregorian-from-absolute d))))))))
  16641. (defun org-goto-calendar (&optional arg)
  16642. "Go to the Emacs calendar at the current date.
  16643. If there is a time stamp in the current line, go to that date.
  16644. A prefix ARG can be used to force the current date."
  16645. (interactive "P")
  16646. (let ((tsr org-ts-regexp) diff
  16647. (calendar-move-hook nil)
  16648. (calendar-view-holidays-initially-flag nil)
  16649. (calendar-view-diary-initially-flag nil))
  16650. (when (or (org-at-timestamp-p)
  16651. (save-excursion
  16652. (beginning-of-line 1)
  16653. (looking-at (concat ".*" tsr))))
  16654. (let ((d1 (time-to-days (current-time)))
  16655. (d2 (time-to-days
  16656. (org-time-string-to-time (match-string 1)))))
  16657. (setq diff (- d2 d1))))
  16658. (calendar)
  16659. (calendar-goto-today)
  16660. (when (and diff (not arg)) (calendar-forward-day diff))))
  16661. (defun org-get-date-from-calendar ()
  16662. "Return a list (month day year) of date at point in calendar."
  16663. (with-current-buffer "*Calendar*"
  16664. (save-match-data
  16665. (calendar-cursor-to-date))))
  16666. (defun org-date-from-calendar ()
  16667. "Insert time stamp corresponding to cursor date in *Calendar* buffer.
  16668. If there is already a time stamp at the cursor position, update it."
  16669. (interactive)
  16670. (if (org-at-timestamp-p t)
  16671. (org-timestamp-change 0 'calendar)
  16672. (let ((cal-date (org-get-date-from-calendar)))
  16673. (org-insert-time-stamp
  16674. (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
  16675. (defcustom org-effort-durations
  16676. `(("min" . 1)
  16677. ("h" . 60)
  16678. ("d" . ,(* 60 8))
  16679. ("w" . ,(* 60 8 5))
  16680. ("m" . ,(* 60 8 5 4))
  16681. ("y" . ,(* 60 8 5 40)))
  16682. "Conversion factor to minutes for an effort modifier.
  16683. Each entry has the form (MODIFIER . MINUTES).
  16684. In an effort string, a number followed by MODIFIER is multiplied
  16685. by the specified number of MINUTES to obtain an effort in
  16686. minutes.
  16687. For example, if the value of this variable is ((\"hours\" . 60)), then an
  16688. effort string \"2hours\" is equivalent to 120 minutes."
  16689. :group 'org-agenda
  16690. :version "25.2"
  16691. :package-version '(Org . "8.3")
  16692. :type '(alist :key-type (string :tag "Modifier")
  16693. :value-type (number :tag "Minutes")))
  16694. (defun org-minutes-to-clocksum-string (m)
  16695. "Format number of minutes as a clocksum string.
  16696. The format is determined by `org-time-clocksum-format',
  16697. `org-time-clocksum-use-fractional' and
  16698. `org-time-clocksum-fractional-format' and
  16699. `org-time-clocksum-use-effort-durations'."
  16700. (let ((clocksum "")
  16701. (m (round m)) ; Don't allow fractions of minutes
  16702. h d w mo y fmt n)
  16703. (setq h (if org-time-clocksum-use-effort-durations
  16704. (cdr (assoc "h" org-effort-durations)) 60)
  16705. d (if org-time-clocksum-use-effort-durations
  16706. (/ (cdr (assoc "d" org-effort-durations)) h) 24)
  16707. w (if org-time-clocksum-use-effort-durations
  16708. (/ (cdr (assoc "w" org-effort-durations)) (* d h)) 7)
  16709. mo (if org-time-clocksum-use-effort-durations
  16710. (/ (cdr (assoc "m" org-effort-durations)) (* d h)) 30)
  16711. y (if org-time-clocksum-use-effort-durations
  16712. (/ (cdr (assoc "y" org-effort-durations)) (* d h)) 365))
  16713. ;; fractional format
  16714. (if org-time-clocksum-use-fractional
  16715. (cond
  16716. ;; single format string
  16717. ((stringp org-time-clocksum-fractional-format)
  16718. (format org-time-clocksum-fractional-format (/ m (float h))))
  16719. ;; choice of fractional formats for different time units
  16720. ((and (setq fmt (plist-get org-time-clocksum-fractional-format :years))
  16721. (> (/ (truncate m) (* y d h)) 0))
  16722. (format fmt (/ m (* y d (float h)))))
  16723. ((and (setq fmt (plist-get org-time-clocksum-fractional-format :months))
  16724. (> (/ (truncate m) (* mo d h)) 0))
  16725. (format fmt (/ m (* mo d (float h)))))
  16726. ((and (setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
  16727. (> (/ (truncate m) (* w d h)) 0))
  16728. (format fmt (/ m (* w d (float h)))))
  16729. ((and (setq fmt (plist-get org-time-clocksum-fractional-format :days))
  16730. (> (/ (truncate m) (* d h)) 0))
  16731. (format fmt (/ m (* d (float h)))))
  16732. ((and (setq fmt (plist-get org-time-clocksum-fractional-format :hours))
  16733. (> (/ (truncate m) h) 0))
  16734. (format fmt (/ m (float h))))
  16735. ((setq fmt (plist-get org-time-clocksum-fractional-format :minutes))
  16736. (format fmt m))
  16737. ;; fall back to smallest time unit with a format
  16738. ((setq fmt (plist-get org-time-clocksum-fractional-format :hours))
  16739. (format fmt (/ m (float h))))
  16740. ((setq fmt (plist-get org-time-clocksum-fractional-format :days))
  16741. (format fmt (/ m (* d (float h)))))
  16742. ((setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
  16743. (format fmt (/ m (* w d (float h)))))
  16744. ((setq fmt (plist-get org-time-clocksum-fractional-format :months))
  16745. (format fmt (/ m (* mo d (float h)))))
  16746. ((setq fmt (plist-get org-time-clocksum-fractional-format :years))
  16747. (format fmt (/ m (* y d (float h))))))
  16748. ;; standard (non-fractional) format, with single format string
  16749. (if (stringp org-time-clocksum-format)
  16750. (format org-time-clocksum-format (setq n (/ m h)) (- m (* h n)))
  16751. ;; separate formats components
  16752. (and (setq fmt (plist-get org-time-clocksum-format :years))
  16753. (or (> (setq n (/ (truncate m) (* y d h))) 0)
  16754. (plist-get org-time-clocksum-format :require-years))
  16755. (setq clocksum (concat clocksum (format fmt n))
  16756. m (- m (* n y d h))))
  16757. (and (setq fmt (plist-get org-time-clocksum-format :months))
  16758. (or (> (setq n (/ (truncate m) (* mo d h))) 0)
  16759. (plist-get org-time-clocksum-format :require-months))
  16760. (setq clocksum (concat clocksum (format fmt n))
  16761. m (- m (* n mo d h))))
  16762. (and (setq fmt (plist-get org-time-clocksum-format :weeks))
  16763. (or (> (setq n (/ (truncate m) (* w d h))) 0)
  16764. (plist-get org-time-clocksum-format :require-weeks))
  16765. (setq clocksum (concat clocksum (format fmt n))
  16766. m (- m (* n w d h))))
  16767. (and (setq fmt (plist-get org-time-clocksum-format :days))
  16768. (or (> (setq n (/ (truncate m) (* d h))) 0)
  16769. (plist-get org-time-clocksum-format :require-days))
  16770. (setq clocksum (concat clocksum (format fmt n))
  16771. m (- m (* n d h))))
  16772. (and (setq fmt (plist-get org-time-clocksum-format :hours))
  16773. (or (> (setq n (/ (truncate m) h)) 0)
  16774. (plist-get org-time-clocksum-format :require-hours))
  16775. (setq clocksum (concat clocksum (format fmt n))
  16776. m (- m (* n h))))
  16777. (and (setq fmt (plist-get org-time-clocksum-format :minutes))
  16778. (or (> m 0) (plist-get org-time-clocksum-format :require-minutes))
  16779. (setq clocksum (concat clocksum (format fmt m))))
  16780. ;; return formatted time duration
  16781. clocksum))))
  16782. (defun org-hours-to-clocksum-string (n)
  16783. (org-minutes-to-clocksum-string (* n 60)))
  16784. (defun org-hh:mm-string-to-minutes (s)
  16785. "Convert a string H:MM to a number of minutes.
  16786. If the string is just a number, interpret it as minutes.
  16787. In fact, the first hh:mm or number in the string will be taken,
  16788. there can be extra stuff in the string.
  16789. If no number is found, the return value is 0."
  16790. (cond
  16791. ((integerp s) s)
  16792. ((string-match "\\([0-9]+\\):\\([0-9]+\\)" s)
  16793. (+ (* (string-to-number (match-string 1 s)) 60)
  16794. (string-to-number (match-string 2 s))))
  16795. ((string-match "\\([0-9]+\\)" s)
  16796. (string-to-number (match-string 1 s)))
  16797. (t 0)))
  16798. (defcustom org-image-actual-width t
  16799. "Should we use the actual width of images when inlining them?
  16800. When set to t, always use the image width.
  16801. When set to a number, use imagemagick (when available) to set
  16802. the image's width to this value.
  16803. When set to a number in a list, try to get the width from any
  16804. #+ATTR.* keyword if it matches a width specification like
  16805. #+ATTR_HTML: :width 300px
  16806. and fall back on that number if none is found.
  16807. When set to nil, try to get the width from an #+ATTR.* keyword
  16808. and fall back on the original width if none is found.
  16809. This requires Emacs >= 24.1, build with imagemagick support."
  16810. :group 'org-appearance
  16811. :version "24.4"
  16812. :package-version '(Org . "8.0")
  16813. :type '(choice
  16814. (const :tag "Use the image width" t)
  16815. (integer :tag "Use a number of pixels")
  16816. (list :tag "Use #+ATTR* or a number of pixels" (integer))
  16817. (const :tag "Use #+ATTR* or don't resize" nil)))
  16818. (defcustom org-agenda-inhibit-startup nil
  16819. "Inhibit startup when preparing agenda buffers.
  16820. When this variable is t, the initialization of the Org agenda
  16821. buffers is inhibited: e.g. the visibility state is not set, the
  16822. tables are not re-aligned, etc."
  16823. :type 'boolean
  16824. :version "24.3"
  16825. :group 'org-agenda)
  16826. (defcustom org-agenda-ignore-properties nil
  16827. "Avoid updating text properties when building the agenda.
  16828. Properties are used to prepare buffers for effort estimates,
  16829. appointments, statistics and subtree-local categories.
  16830. If you don't use these in the agenda, you can add them to this
  16831. list and agenda building will be a bit faster.
  16832. The value is a list, with zero or more of the symbols `effort', `appt',
  16833. `stats' or `category'."
  16834. :type '(set :greedy t
  16835. (const effort)
  16836. (const appt)
  16837. (const stats)
  16838. (const category))
  16839. :version "25.2"
  16840. :package-version '(Org . "8.3")
  16841. :group 'org-agenda)
  16842. (defun org-duration-string-to-minutes (s &optional output-to-string)
  16843. "Convert a duration string S to minutes.
  16844. A bare number is interpreted as minutes, modifiers can be set by
  16845. customizing `org-effort-durations' (which see).
  16846. Entries containing a colon are interpreted as H:MM by
  16847. `org-hh:mm-string-to-minutes'."
  16848. (let ((result 0)
  16849. (re (concat "\\([0-9.]+\\) *\\("
  16850. (regexp-opt (mapcar 'car org-effort-durations))
  16851. "\\)")))
  16852. (while (string-match re s)
  16853. (cl-incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
  16854. (string-to-number (match-string 1 s))))
  16855. (setq s (replace-match "" nil t s)))
  16856. (setq result (floor result))
  16857. (cl-incf result (org-hh:mm-string-to-minutes s))
  16858. (if output-to-string (number-to-string result) result)))
  16859. ;;;; Files
  16860. (defun org-save-all-org-buffers ()
  16861. "Save all Org buffers without user confirmation."
  16862. (interactive)
  16863. (message "Saving all Org buffers...")
  16864. (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
  16865. (when (featurep 'org-id) (org-id-locations-save))
  16866. (message "Saving all Org buffers... done"))
  16867. (defun org-revert-all-org-buffers ()
  16868. "Revert all Org buffers.
  16869. Prompt for confirmation when there are unsaved changes.
  16870. Be sure you know what you are doing before letting this function
  16871. overwrite your changes.
  16872. This function is useful in a setup where one tracks org files
  16873. with a version control system, to revert on one machine after pulling
  16874. changes from another. I believe the procedure must be like this:
  16875. 1. M-x org-save-all-org-buffers
  16876. 2. Pull changes from the other machine, resolve conflicts
  16877. 3. M-x org-revert-all-org-buffers"
  16878. (interactive)
  16879. (unless (yes-or-no-p "Revert all Org buffers from their files? ")
  16880. (user-error "Abort"))
  16881. (save-excursion
  16882. (save-window-excursion
  16883. (dolist (b (buffer-list))
  16884. (when (and (with-current-buffer b (derived-mode-p 'org-mode))
  16885. (with-current-buffer b buffer-file-name))
  16886. (pop-to-buffer-same-window b)
  16887. (revert-buffer t 'no-confirm)))
  16888. (when (and (featurep 'org-id) org-id-track-globally)
  16889. (org-id-locations-load)))))
  16890. ;;;; Agenda files
  16891. ;;;###autoload
  16892. (defun org-switchb (&optional arg)
  16893. "Switch between Org buffers.
  16894. With `\\[universal-argument]' prefix, restrict available buffers to files.
  16895. With `\\[universal-argument] \\[universal-argument]' \
  16896. prefix, restrict available buffers to agenda files."
  16897. (interactive "P")
  16898. (let ((blist (org-buffer-list
  16899. (cond ((equal arg '(4)) 'files)
  16900. ((equal arg '(16)) 'agenda)))))
  16901. (pop-to-buffer-same-window
  16902. (completing-read "Org buffer: "
  16903. (mapcar #'list (mapcar #'buffer-name blist))
  16904. nil t))))
  16905. (defun org-buffer-list (&optional predicate exclude-tmp)
  16906. "Return a list of Org buffers.
  16907. PREDICATE can be `export', `files' or `agenda'.
  16908. export restrict the list to Export buffers.
  16909. files restrict the list to buffers visiting Org files.
  16910. agenda restrict the list to buffers visiting agenda files.
  16911. If EXCLUDE-TMP is non-nil, ignore temporary buffers."
  16912. (let* ((bfn nil)
  16913. (agenda-files (and (eq predicate 'agenda)
  16914. (mapcar 'file-truename (org-agenda-files t))))
  16915. (filter
  16916. (cond
  16917. ((eq predicate 'files)
  16918. (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
  16919. ((eq predicate 'export)
  16920. (lambda (b) (string-match "\\*Org .*Export" (buffer-name b))))
  16921. ((eq predicate 'agenda)
  16922. (lambda (b)
  16923. (with-current-buffer b
  16924. (and (derived-mode-p 'org-mode)
  16925. (setq bfn (buffer-file-name b))
  16926. (member (file-truename bfn) agenda-files)))))
  16927. (t (lambda (b) (with-current-buffer b
  16928. (or (derived-mode-p 'org-mode)
  16929. (string-match "\\*Org .*Export"
  16930. (buffer-name b)))))))))
  16931. (delq nil
  16932. (mapcar
  16933. (lambda(b)
  16934. (if (and (funcall filter b)
  16935. (or (not exclude-tmp)
  16936. (not (string-match "tmp" (buffer-name b)))))
  16937. b
  16938. nil))
  16939. (buffer-list)))))
  16940. (defun org-agenda-files (&optional unrestricted archives)
  16941. "Get the list of agenda files.
  16942. Optional UNRESTRICTED means return the full list even if a restriction
  16943. is currently in place.
  16944. When ARCHIVES is t, include all archive files that are really being
  16945. used by the agenda files. If ARCHIVE is `ifmode', do this only if
  16946. `org-agenda-archives-mode' is t."
  16947. (let ((files
  16948. (cond
  16949. ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
  16950. ((stringp org-agenda-files) (org-read-agenda-file-list))
  16951. ((listp org-agenda-files) org-agenda-files)
  16952. (t (error "Invalid value of `org-agenda-files'")))))
  16953. (setq files (apply 'append
  16954. (mapcar (lambda (f)
  16955. (if (file-directory-p f)
  16956. (directory-files
  16957. f t org-agenda-file-regexp)
  16958. (list f)))
  16959. files)))
  16960. (when org-agenda-skip-unavailable-files
  16961. (setq files (delq nil
  16962. (mapcar (function
  16963. (lambda (file)
  16964. (and (file-readable-p file) file)))
  16965. files))))
  16966. (when (or (eq archives t)
  16967. (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
  16968. (setq files (org-add-archive-files files)))
  16969. files))
  16970. (defun org-agenda-file-p (&optional file)
  16971. "Return non-nil, if FILE is an agenda file.
  16972. If FILE is omitted, use the file associated with the current
  16973. buffer."
  16974. (let ((fname (or file (buffer-file-name))))
  16975. (and fname
  16976. (member (file-truename fname)
  16977. (mapcar #'file-truename (org-agenda-files t))))))
  16978. (defun org-edit-agenda-file-list ()
  16979. "Edit the list of agenda files.
  16980. Depending on setup, this either uses customize to edit the variable
  16981. `org-agenda-files', or it visits the file that is holding the list. In the
  16982. latter case, the buffer is set up in a way that saving it automatically kills
  16983. the buffer and restores the previous window configuration."
  16984. (interactive)
  16985. (if (stringp org-agenda-files)
  16986. (let ((cw (current-window-configuration)))
  16987. (find-file org-agenda-files)
  16988. (setq-local org-window-configuration cw)
  16989. (add-hook 'after-save-hook
  16990. (lambda ()
  16991. (set-window-configuration
  16992. (prog1 org-window-configuration
  16993. (kill-buffer (current-buffer))))
  16994. (org-install-agenda-files-menu)
  16995. (message "New agenda file list installed"))
  16996. nil 'local)
  16997. (message "%s" (substitute-command-keys
  16998. "Edit list and finish with \\[save-buffer]")))
  16999. (customize-variable 'org-agenda-files)))
  17000. (defun org-store-new-agenda-file-list (list)
  17001. "Set new value for the agenda file list and save it correctly."
  17002. (if (stringp org-agenda-files)
  17003. (let ((fe (org-read-agenda-file-list t)) b u)
  17004. (while (setq b (find-buffer-visiting org-agenda-files))
  17005. (kill-buffer b))
  17006. (with-temp-file org-agenda-files
  17007. (insert
  17008. (mapconcat
  17009. (lambda (f) ;; Keep un-expanded entries.
  17010. (if (setq u (assoc f fe))
  17011. (cdr u)
  17012. f))
  17013. list "\n")
  17014. "\n")))
  17015. (let ((org-mode-hook nil) (org-inhibit-startup t)
  17016. (org-insert-mode-line-in-empty-file nil))
  17017. (setq org-agenda-files list)
  17018. (customize-save-variable 'org-agenda-files org-agenda-files))))
  17019. (defun org-read-agenda-file-list (&optional pair-with-expansion)
  17020. "Read the list of agenda files from a file.
  17021. If PAIR-WITH-EXPANSION is t return pairs with un-expanded
  17022. filenames, used by `org-store-new-agenda-file-list' to write back
  17023. un-expanded file names."
  17024. (when (file-directory-p org-agenda-files)
  17025. (error "`org-agenda-files' cannot be a single directory"))
  17026. (when (stringp org-agenda-files)
  17027. (with-temp-buffer
  17028. (insert-file-contents org-agenda-files)
  17029. (mapcar
  17030. (lambda (f)
  17031. (let ((e (expand-file-name (substitute-in-file-name f)
  17032. org-directory)))
  17033. (if pair-with-expansion
  17034. (cons e f)
  17035. e)))
  17036. (org-split-string (buffer-string) "[ \t\r\n]*?[\r\n][ \t\r\n]*")))))
  17037. ;;;###autoload
  17038. (defun org-cycle-agenda-files ()
  17039. "Cycle through the files in `org-agenda-files'.
  17040. If the current buffer visits an agenda file, find the next one in the list.
  17041. If the current buffer does not, find the first agenda file."
  17042. (interactive)
  17043. (let* ((fs (or (org-agenda-files t)
  17044. (user-error "No agenda files")))
  17045. (files (copy-sequence fs))
  17046. (tcf (and buffer-file-name (file-truename buffer-file-name)))
  17047. file)
  17048. (when tcf
  17049. (while (and (setq file (pop files))
  17050. (not (equal (file-truename file) tcf)))))
  17051. (find-file (car (or files fs)))
  17052. (when (buffer-base-buffer) (pop-to-buffer-same-window (buffer-base-buffer)))))
  17053. (defun org-agenda-file-to-front (&optional to-end)
  17054. "Move/add the current file to the top of the agenda file list.
  17055. If the file is not present in the list, it is added to the front. If it is
  17056. present, it is moved there. With optional argument TO-END, add/move to the
  17057. end of the list."
  17058. (interactive "P")
  17059. (let ((org-agenda-skip-unavailable-files nil)
  17060. (file-alist (mapcar (lambda (x)
  17061. (cons (file-truename x) x))
  17062. (org-agenda-files t)))
  17063. (ctf (file-truename
  17064. (or buffer-file-name
  17065. (user-error "Please save the current buffer to a file"))))
  17066. x had)
  17067. (setq x (assoc ctf file-alist) had x)
  17068. (unless x (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
  17069. (if to-end
  17070. (setq file-alist (append (delq x file-alist) (list x)))
  17071. (setq file-alist (cons x (delq x file-alist))))
  17072. (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
  17073. (org-install-agenda-files-menu)
  17074. (message "File %s to %s of agenda file list"
  17075. (if had "moved" "added") (if to-end "end" "front"))))
  17076. (defun org-remove-file (&optional file)
  17077. "Remove current file from the list of files in variable `org-agenda-files'.
  17078. These are the files which are being checked for agenda entries.
  17079. Optional argument FILE means use this file instead of the current."
  17080. (interactive)
  17081. (let* ((org-agenda-skip-unavailable-files nil)
  17082. (file (or file buffer-file-name
  17083. (user-error "Current buffer does not visit a file")))
  17084. (true-file (file-truename file))
  17085. (afile (abbreviate-file-name file))
  17086. (files (delq nil (mapcar
  17087. (lambda (x)
  17088. (unless (equal true-file
  17089. (file-truename x))
  17090. x))
  17091. (org-agenda-files t)))))
  17092. (if (not (= (length files) (length (org-agenda-files t))))
  17093. (progn
  17094. (org-store-new-agenda-file-list files)
  17095. (org-install-agenda-files-menu)
  17096. (message "Removed from Org Agenda list: %s" afile))
  17097. (message "File was not in list: %s (not removed)" afile))))
  17098. (defun org-file-menu-entry (file)
  17099. (vector file (list 'find-file file) t))
  17100. (defun org-check-agenda-file (file)
  17101. "Make sure FILE exists. If not, ask user what to do."
  17102. (unless (file-exists-p file)
  17103. (message "Non-existent agenda file %s. [R]emove from list or [A]bort?"
  17104. (abbreviate-file-name file))
  17105. (let ((r (downcase (read-char-exclusive))))
  17106. (cond
  17107. ((equal r ?r)
  17108. (org-remove-file file)
  17109. (throw 'nextfile t))
  17110. (t (user-error "Abort"))))))
  17111. (defun org-get-agenda-file-buffer (file)
  17112. "Get an agenda buffer visiting FILE.
  17113. If the buffer needs to be created, add it to the list of buffers
  17114. which might be released later."
  17115. (let ((buf (org-find-base-buffer-visiting file)))
  17116. (if buf
  17117. buf ; just return it
  17118. ;; Make a new buffer and remember it
  17119. (setq buf (find-file-noselect file))
  17120. (when buf (push buf org-agenda-new-buffers))
  17121. buf)))
  17122. (defun org-release-buffers (blist)
  17123. "Release all buffers in list, asking the user for confirmation when needed.
  17124. When a buffer is unmodified, it is just killed. When modified, it is saved
  17125. \(if the user agrees) and then killed."
  17126. (let (file)
  17127. (dolist (buf blist)
  17128. (setq file (buffer-file-name buf))
  17129. (when (and (buffer-modified-p buf)
  17130. file
  17131. (y-or-n-p (format "Save file %s? " file)))
  17132. (with-current-buffer buf (save-buffer)))
  17133. (kill-buffer buf))))
  17134. (defun org-agenda-prepare-buffers (files)
  17135. "Create buffers for all agenda files, protect archived trees and comments."
  17136. (interactive)
  17137. (let ((pa '(:org-archived t))
  17138. (pc '(:org-comment t))
  17139. (pall '(:org-archived t :org-comment t))
  17140. (inhibit-read-only t)
  17141. (org-inhibit-startup org-agenda-inhibit-startup)
  17142. (rea (concat ":" org-archive-tag ":"))
  17143. re pos)
  17144. (setq org-tag-alist-for-agenda nil
  17145. org-tag-groups-alist-for-agenda nil)
  17146. (save-excursion
  17147. (save-restriction
  17148. (dolist (file files)
  17149. (catch 'nextfile
  17150. (if (bufferp file)
  17151. (set-buffer file)
  17152. (org-check-agenda-file file)
  17153. (set-buffer (org-get-agenda-file-buffer file)))
  17154. (widen)
  17155. (org-set-regexps-and-options 'tags-only)
  17156. (setq pos (point))
  17157. (or (memq 'category org-agenda-ignore-properties)
  17158. (org-refresh-category-properties))
  17159. (or (memq 'stats org-agenda-ignore-properties)
  17160. (org-refresh-stats-properties))
  17161. (or (memq 'effort org-agenda-ignore-properties)
  17162. (org-refresh-effort-properties))
  17163. (or (memq 'appt org-agenda-ignore-properties)
  17164. (org-refresh-properties "APPT_WARNTIME" 'org-appt-warntime))
  17165. (setq org-todo-keywords-for-agenda
  17166. (append org-todo-keywords-for-agenda org-todo-keywords-1))
  17167. (setq org-done-keywords-for-agenda
  17168. (append org-done-keywords-for-agenda org-done-keywords))
  17169. (setq org-todo-keyword-alist-for-agenda
  17170. (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
  17171. (setq org-tag-alist-for-agenda
  17172. (org-uniquify
  17173. (append org-tag-alist-for-agenda
  17174. org-current-tag-alist)))
  17175. ;; Merge current file's tag groups into global
  17176. ;; `org-tag-groups-alist-for-agenda'.
  17177. (when org-group-tags
  17178. (dolist (alist org-tag-groups-alist)
  17179. (let ((old (assoc (car alist) org-tag-groups-alist-for-agenda)))
  17180. (if old
  17181. (setcdr old (org-uniquify (append (cdr old) (cdr alist))))
  17182. (push alist org-tag-groups-alist-for-agenda)))))
  17183. (org-with-silent-modifications
  17184. (save-excursion
  17185. (remove-text-properties (point-min) (point-max) pall)
  17186. (when org-agenda-skip-archived-trees
  17187. (goto-char (point-min))
  17188. (while (re-search-forward rea nil t)
  17189. (when (org-at-heading-p t)
  17190. (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
  17191. (goto-char (point-min))
  17192. (setq re (format "^\\*+ .*\\<%s\\>" org-comment-string))
  17193. (while (re-search-forward re nil t)
  17194. (when (save-match-data (org-in-commented-heading-p t))
  17195. (add-text-properties
  17196. (match-beginning 0) (org-end-of-subtree t) pc)))))
  17197. (goto-char pos)))))
  17198. (setq org-todo-keywords-for-agenda
  17199. (org-uniquify org-todo-keywords-for-agenda))
  17200. (setq org-todo-keyword-alist-for-agenda
  17201. (org-uniquify org-todo-keyword-alist-for-agenda))))
  17202. ;;;; CDLaTeX minor mode
  17203. (defvar org-cdlatex-mode-map (make-sparse-keymap)
  17204. "Keymap for the minor `org-cdlatex-mode'.")
  17205. (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
  17206. (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
  17207. (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
  17208. (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
  17209. (org-defkey org-cdlatex-mode-map "\C-c{" 'org-cdlatex-environment-indent)
  17210. (defvar org-cdlatex-texmathp-advice-is-done nil
  17211. "Flag remembering if we have applied the advice to texmathp already.")
  17212. (define-minor-mode org-cdlatex-mode
  17213. "Toggle the minor `org-cdlatex-mode'.
  17214. This mode supports entering LaTeX environment and math in LaTeX fragments
  17215. in Org mode.
  17216. \\{org-cdlatex-mode-map}"
  17217. nil " OCDL" nil
  17218. (when org-cdlatex-mode
  17219. (require 'cdlatex)
  17220. (run-hooks 'cdlatex-mode-hook)
  17221. (cdlatex-compute-tables))
  17222. (unless org-cdlatex-texmathp-advice-is-done
  17223. (setq org-cdlatex-texmathp-advice-is-done t)
  17224. (defadvice texmathp (around org-math-always-on activate)
  17225. "Always return t in Org buffers.
  17226. This is because we want to insert math symbols without dollars even outside
  17227. the LaTeX math segments. If Org mode thinks that point is actually inside
  17228. an embedded LaTeX fragment, let `texmathp' do its job.
  17229. `\\[org-cdlatex-mode-map]'"
  17230. (interactive)
  17231. (let (p)
  17232. (cond
  17233. ((not (derived-mode-p 'org-mode)) ad-do-it)
  17234. ((eq this-command 'cdlatex-math-symbol)
  17235. (setq ad-return-value t
  17236. texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
  17237. (t
  17238. (let ((p (org-inside-LaTeX-fragment-p)))
  17239. (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
  17240. (setq ad-return-value t
  17241. texmathp-why '("Org mode embedded math" . 0))
  17242. (when p ad-do-it)))))))))
  17243. (defun turn-on-org-cdlatex ()
  17244. "Unconditionally turn on `org-cdlatex-mode'."
  17245. (org-cdlatex-mode 1))
  17246. (defun org-try-cdlatex-tab ()
  17247. "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
  17248. It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
  17249. - inside a LaTeX fragment, or
  17250. - after the first word in a line, where an abbreviation expansion could
  17251. insert a LaTeX environment."
  17252. (when org-cdlatex-mode
  17253. (cond
  17254. ;; Before any word on the line: No expansion possible.
  17255. ((save-excursion (skip-chars-backward " \t") (bolp)) nil)
  17256. ;; Just after first word on the line: Expand it. Make sure it
  17257. ;; cannot happen on headlines, though.
  17258. ((save-excursion
  17259. (skip-chars-backward "a-zA-Z0-9*")
  17260. (skip-chars-backward " \t")
  17261. (and (bolp) (not (org-at-heading-p))))
  17262. (cdlatex-tab) t)
  17263. ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
  17264. (defun org-cdlatex-underscore-caret (&optional _arg)
  17265. "Execute `cdlatex-sub-superscript' in LaTeX fragments.
  17266. Revert to the normal definition outside of these fragments."
  17267. (interactive "P")
  17268. (if (org-inside-LaTeX-fragment-p)
  17269. (call-interactively 'cdlatex-sub-superscript)
  17270. (let (org-cdlatex-mode)
  17271. (call-interactively (key-binding (vector last-input-event))))))
  17272. (defun org-cdlatex-math-modify (&optional _arg)
  17273. "Execute `cdlatex-math-modify' in LaTeX fragments.
  17274. Revert to the normal definition outside of these fragments."
  17275. (interactive "P")
  17276. (if (org-inside-LaTeX-fragment-p)
  17277. (call-interactively 'cdlatex-math-modify)
  17278. (let (org-cdlatex-mode)
  17279. (call-interactively (key-binding (vector last-input-event))))))
  17280. (defun org-cdlatex-environment-indent (&optional environment item)
  17281. "Execute `cdlatex-environment' and indent the inserted environment.
  17282. ENVIRONMENT and ITEM are passed to `cdlatex-environment'.
  17283. The inserted environment is indented to current indentation
  17284. unless point is at the beginning of the line, in which the
  17285. environment remains unintended."
  17286. (interactive)
  17287. ;; cdlatex-environment always return nil. Therefore, capture output
  17288. ;; first and determine if an environment was selected.
  17289. (let* ((beg (point-marker))
  17290. (end (copy-marker (point) t))
  17291. (inserted (progn
  17292. (ignore-errors (cdlatex-environment environment item))
  17293. (< beg end)))
  17294. ;; Figure out how many lines to move forward after the
  17295. ;; environment has been inserted.
  17296. (lines (when inserted
  17297. (save-excursion
  17298. (- (cl-loop while (< beg (point))
  17299. with x = 0
  17300. do (forward-line -1)
  17301. (cl-incf x)
  17302. finally return x)
  17303. (if (progn (goto-char beg)
  17304. (and (progn (skip-chars-forward " \t") (eolp))
  17305. (progn (skip-chars-backward " \t") (bolp))))
  17306. 1 0)))))
  17307. (env (org-trim (delete-and-extract-region beg end))))
  17308. (when inserted
  17309. ;; Get indentation of next line unless at column 0.
  17310. (let ((ind (if (bolp) 0
  17311. (save-excursion
  17312. (org-return-indent)
  17313. (prog1 (org-get-indentation)
  17314. (when (progn (skip-chars-forward " \t") (eolp))
  17315. (delete-region beg (point)))))))
  17316. (bol (progn (skip-chars-backward " \t") (bolp))))
  17317. ;; Insert a newline before environment unless at column zero
  17318. ;; to "escape" the current line. Insert a newline if
  17319. ;; something is one the same line as \end{ENVIRONMENT}.
  17320. (insert
  17321. (concat (unless bol "\n") env
  17322. (when (and (skip-chars-forward " \t") (not (eolp))) "\n")))
  17323. (unless (zerop ind)
  17324. (save-excursion
  17325. (goto-char beg)
  17326. (while (< (point) end)
  17327. (unless (eolp) (indent-line-to ind))
  17328. (forward-line))))
  17329. (goto-char beg)
  17330. (forward-line lines)
  17331. (indent-line-to ind)))
  17332. (set-marker beg nil)
  17333. (set-marker end nil)))
  17334. ;;;; LaTeX fragments
  17335. (defun org-inside-LaTeX-fragment-p ()
  17336. "Test if point is inside a LaTeX fragment.
  17337. I.e. after a \\begin, \\(, \\[, $, or $$, without the corresponding closing
  17338. sequence appearing also before point.
  17339. Even though the matchers for math are configurable, this function assumes
  17340. that \\begin, \\(, \\[, and $$ are always used. Only the single dollar
  17341. delimiters are skipped when they have been removed by customization.
  17342. The return value is nil, or a cons cell with the delimiter and the
  17343. position of this delimiter.
  17344. This function does a reasonably good job, but can locally be fooled by
  17345. for example currency specifications. For example it will assume being in
  17346. inline math after \"$22.34\". The LaTeX fragment formatter will only format
  17347. fragments that are properly closed, but during editing, we have to live
  17348. with the uncertainty caused by missing closing delimiters. This function
  17349. looks only before point, not after."
  17350. (catch 'exit
  17351. (let ((pos (point))
  17352. (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
  17353. (lim (progn
  17354. (re-search-backward (concat "^\\(" paragraph-start "\\)") nil t)
  17355. (point)))
  17356. dd-on str (start 0) m re)
  17357. (goto-char pos)
  17358. (when dodollar
  17359. (setq str (concat (buffer-substring lim (point)) "\000 X$.")
  17360. re (nth 1 (assoc "$" org-latex-regexps)))
  17361. (while (string-match re str start)
  17362. (cond
  17363. ((= (match-end 0) (length str))
  17364. (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
  17365. ((= (match-end 0) (- (length str) 5))
  17366. (throw 'exit nil))
  17367. (t (setq start (match-end 0))))))
  17368. (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
  17369. (goto-char pos)
  17370. (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
  17371. (and (match-beginning 2) (throw 'exit nil))
  17372. ;; count $$
  17373. (while (re-search-backward "\\$\\$" lim t)
  17374. (setq dd-on (not dd-on)))
  17375. (goto-char pos)
  17376. (when dd-on (cons "$$" m))))))
  17377. (defun org-inside-latex-macro-p ()
  17378. "Is point inside a LaTeX macro or its arguments?"
  17379. (save-match-data
  17380. (org-in-regexp
  17381. "\\\\[a-zA-Z]+\\*?\\(\\(\\[[^][\n{}]*\\]\\)\\|\\({[^{}\n]*}\\)\\)*")))
  17382. (defun org--format-latex-make-overlay (beg end image &optional imagetype)
  17383. "Build an overlay between BEG and END using IMAGE file.
  17384. Argument IMAGETYPE is the extension of the displayed image,
  17385. as a string. It defaults to \"png\"."
  17386. (let ((ov (make-overlay beg end))
  17387. (imagetype (or (intern imagetype) 'png)))
  17388. (overlay-put ov 'org-overlay-type 'org-latex-overlay)
  17389. (overlay-put ov 'evaporate t)
  17390. (overlay-put ov
  17391. 'modification-hooks
  17392. (list (lambda (o _flag _beg _end &optional _l)
  17393. (delete-overlay o))))
  17394. (overlay-put ov
  17395. 'display
  17396. (list 'image :type imagetype :file image :ascent 'center))))
  17397. (defun org--list-latex-overlays (&optional beg end)
  17398. "List all Org LaTeX overlays in current buffer.
  17399. Limit to overlays between BEG and END when those are provided."
  17400. (cl-remove-if-not
  17401. (lambda (o) (eq (overlay-get o 'org-overlay-type) 'org-latex-overlay))
  17402. (overlays-in (or beg (point-min)) (or end (point-max)))))
  17403. (defun org-remove-latex-fragment-image-overlays (&optional beg end)
  17404. "Remove all overlays with LaTeX fragment images in current buffer.
  17405. When optional arguments BEG and END are non-nil, remove all
  17406. overlays between them instead. Return a non-nil value when some
  17407. overlays were removed, nil otherwise."
  17408. (let ((overlays (org--list-latex-overlays beg end)))
  17409. (mapc #'delete-overlay overlays)
  17410. overlays))
  17411. (defun org-toggle-latex-fragment (&optional arg)
  17412. "Preview the LaTeX fragment at point, or all locally or globally.
  17413. If the cursor is on a LaTeX fragment, create the image and overlay
  17414. it over the source code, if there is none. Remove it otherwise.
  17415. If there is no fragment at point, display all fragments in the
  17416. current section.
  17417. With prefix ARG, preview or clear image for all fragments in the
  17418. current subtree or in the whole buffer when used before the first
  17419. headline. With a prefix ARG `\\[universal-argument] \
  17420. \\[universal-argument]' preview or clear images
  17421. for all fragments in the buffer."
  17422. (interactive "P")
  17423. (when (display-graphic-p)
  17424. (catch 'exit
  17425. (save-excursion
  17426. (let (beg end msg)
  17427. (cond
  17428. ((or (equal arg '(16))
  17429. (and (equal arg '(4))
  17430. (org-with-limited-levels (org-before-first-heading-p))))
  17431. (if (org-remove-latex-fragment-image-overlays)
  17432. (progn (message "LaTeX fragments images removed from buffer")
  17433. (throw 'exit nil))
  17434. (setq msg "Creating images for buffer...")))
  17435. ((equal arg '(4))
  17436. (org-with-limited-levels (org-back-to-heading t))
  17437. (setq beg (point))
  17438. (setq end (progn (org-end-of-subtree t) (point)))
  17439. (if (org-remove-latex-fragment-image-overlays beg end)
  17440. (progn
  17441. (message "LaTeX fragment images removed from subtree")
  17442. (throw 'exit nil))
  17443. (setq msg "Creating images for subtree...")))
  17444. ((let ((datum (org-element-context)))
  17445. (when (memq (org-element-type datum)
  17446. '(latex-environment latex-fragment))
  17447. (setq beg (org-element-property :begin datum))
  17448. (setq end (org-element-property :end datum))
  17449. (if (org-remove-latex-fragment-image-overlays beg end)
  17450. (progn (message "LaTeX fragment image removed")
  17451. (throw 'exit nil))
  17452. (setq msg "Creating image...")))))
  17453. (t
  17454. (org-with-limited-levels
  17455. (setq beg (if (org-at-heading-p) (line-beginning-position)
  17456. (outline-previous-heading)
  17457. (point)))
  17458. (setq end (progn (outline-next-heading) (point)))
  17459. (if (org-remove-latex-fragment-image-overlays beg end)
  17460. (progn
  17461. (message "LaTeX fragment images removed from section")
  17462. (throw 'exit nil))
  17463. (setq msg "Creating images for section...")))))
  17464. (let ((file (buffer-file-name (buffer-base-buffer))))
  17465. (org-format-latex
  17466. (concat org-preview-latex-image-directory "org-ltximg")
  17467. beg end
  17468. ;; Emacs cannot overlay images from remote hosts. Create
  17469. ;; it in `temporary-file-directory' instead.
  17470. (if (or (not file) (file-remote-p file))
  17471. temporary-file-directory
  17472. default-directory)
  17473. 'overlays msg 'forbuffer org-preview-latex-default-process))
  17474. (message (concat msg "done")))))))
  17475. (defun org-format-latex
  17476. (prefix &optional beg end dir overlays msg forbuffer processing-type)
  17477. "Replace LaTeX fragments with links to an image.
  17478. The function takes care of creating the replacement image.
  17479. Only consider fragments between BEG and END when those are
  17480. provided.
  17481. When optional argument OVERLAYS is non-nil, display the image on
  17482. top of the fragment instead of replacing it.
  17483. PROCESSING-TYPE is the conversion method to use, as a symbol.
  17484. Some of the options can be changed using the variable
  17485. `org-format-latex-options', which see."
  17486. (when (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
  17487. (unless (eq processing-type 'verbatim)
  17488. (let* ((math-regexp "\\$\\|\\\\[([]\\|^[ \t]*\\\\begin{[A-Za-z0-9*]+}")
  17489. (cnt 0)
  17490. checkdir-flag)
  17491. (goto-char (or beg (point-min)))
  17492. ;; Optimize overlay creation: (info "(elisp) Managing Overlays").
  17493. (when (and overlays (memq processing-type '(dvipng imagemagick)))
  17494. (overlay-recenter (or end (point-max))))
  17495. (while (re-search-forward math-regexp end t)
  17496. (unless (and overlays
  17497. (eq (get-char-property (point) 'org-overlay-type)
  17498. 'org-latex-overlay))
  17499. (let* ((context (org-element-context))
  17500. (type (org-element-type context)))
  17501. (when (memq type '(latex-environment latex-fragment))
  17502. (let ((block-type (eq type 'latex-environment))
  17503. (value (org-element-property :value context))
  17504. (beg (org-element-property :begin context))
  17505. (end (save-excursion
  17506. (goto-char (org-element-property :end context))
  17507. (skip-chars-backward " \r\t\n")
  17508. (point))))
  17509. (cond
  17510. ((eq processing-type 'mathjax)
  17511. ;; Prepare for MathJax processing.
  17512. (if (not (string-match "\\`\\$\\$?" value))
  17513. (goto-char end)
  17514. (delete-region beg end)
  17515. (if (string= (match-string 0 value) "$$")
  17516. (insert "\\[" (substring value 2 -2) "\\]")
  17517. (insert "\\(" (substring value 1 -1) "\\)"))))
  17518. ((assq processing-type org-preview-latex-process-alist)
  17519. ;; Process to an image.
  17520. (cl-incf cnt)
  17521. (goto-char beg)
  17522. (let* ((processing-info
  17523. (cdr (assq processing-type org-preview-latex-process-alist)))
  17524. (face (face-at-point))
  17525. ;; Get the colors from the face at point.
  17526. (fg
  17527. (let ((color (plist-get org-format-latex-options
  17528. :foreground)))
  17529. (if (and forbuffer (eq color 'auto))
  17530. (face-attribute face :foreground nil 'default)
  17531. color)))
  17532. (bg
  17533. (let ((color (plist-get org-format-latex-options
  17534. :background)))
  17535. (if (and forbuffer (eq color 'auto))
  17536. (face-attribute face :background nil 'default)
  17537. color)))
  17538. (hash (sha1 (prin1-to-string
  17539. (list org-format-latex-header
  17540. org-latex-default-packages-alist
  17541. org-latex-packages-alist
  17542. org-format-latex-options
  17543. forbuffer value fg bg))))
  17544. (imagetype (or (plist-get processing-info :image-output-type) "png"))
  17545. (absprefix (expand-file-name prefix dir))
  17546. (linkfile (format "%s_%s.%s" prefix hash imagetype))
  17547. (movefile (format "%s_%s.%s" absprefix hash imagetype))
  17548. (sep (and block-type "\n\n"))
  17549. (link (concat sep "[[file:" linkfile "]]" sep))
  17550. (options
  17551. (org-combine-plists
  17552. org-format-latex-options
  17553. `(:foreground ,fg :background ,bg))))
  17554. (when msg (message msg cnt))
  17555. (unless checkdir-flag ; Ensure the directory exists.
  17556. (setq checkdir-flag t)
  17557. (let ((todir (file-name-directory absprefix)))
  17558. (unless (file-directory-p todir)
  17559. (make-directory todir t))))
  17560. (unless (file-exists-p movefile)
  17561. (org-create-formula-image
  17562. value movefile options forbuffer processing-type))
  17563. (if overlays
  17564. (progn
  17565. (dolist (o (overlays-in beg end))
  17566. (when (eq (overlay-get o 'org-overlay-type)
  17567. 'org-latex-overlay)
  17568. (delete-overlay o)))
  17569. (org--format-latex-make-overlay beg end movefile imagetype)
  17570. (goto-char end))
  17571. (delete-region beg end)
  17572. (insert
  17573. (org-add-props link
  17574. (list 'org-latex-src
  17575. (replace-regexp-in-string "\"" "" value)
  17576. 'org-latex-src-embed-type
  17577. (if block-type 'paragraph 'character)))))))
  17578. ((eq processing-type 'mathml)
  17579. ;; Process to MathML.
  17580. (unless (org-format-latex-mathml-available-p)
  17581. (user-error "LaTeX to MathML converter not configured"))
  17582. (cl-incf cnt)
  17583. (when msg (message msg cnt))
  17584. (goto-char beg)
  17585. (delete-region beg end)
  17586. (insert (org-format-latex-as-mathml
  17587. value block-type prefix dir)))
  17588. (t
  17589. (error "Unknown conversion process %s for LaTeX fragments"
  17590. processing-type)))))))))))
  17591. (defun org-create-math-formula (latex-frag &optional mathml-file)
  17592. "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
  17593. Use `org-latex-to-mathml-convert-command'. If the conversion is
  17594. sucessful, return the portion between \"<math...> </math>\"
  17595. elements otherwise return nil. When MATHML-FILE is specified,
  17596. write the results in to that file. When invoked as an
  17597. interactive command, prompt for LATEX-FRAG, with initial value
  17598. set to the current active region and echo the results for user
  17599. inspection."
  17600. (interactive (list (let ((frag (when (org-region-active-p)
  17601. (buffer-substring-no-properties
  17602. (region-beginning) (region-end)))))
  17603. (read-string "LaTeX Fragment: " frag nil frag))))
  17604. (unless latex-frag (user-error "Invalid LaTeX fragment"))
  17605. (let* ((tmp-in-file
  17606. (let ((file (file-relative-name
  17607. (make-temp-name (expand-file-name "ltxmathml-in")))))
  17608. (write-region latex-frag nil file)
  17609. file))
  17610. (tmp-out-file (file-relative-name
  17611. (make-temp-name (expand-file-name "ltxmathml-out"))))
  17612. (cmd (format-spec
  17613. org-latex-to-mathml-convert-command
  17614. `((?j . ,(and org-latex-to-mathml-jar-file
  17615. (shell-quote-argument
  17616. (expand-file-name
  17617. org-latex-to-mathml-jar-file))))
  17618. (?I . ,(shell-quote-argument tmp-in-file))
  17619. (?i . ,latex-frag)
  17620. (?o . ,(shell-quote-argument tmp-out-file)))))
  17621. mathml shell-command-output)
  17622. (when (called-interactively-p 'any)
  17623. (unless (org-format-latex-mathml-available-p)
  17624. (user-error "LaTeX to MathML converter not configured")))
  17625. (message "Running %s" cmd)
  17626. (setq shell-command-output (shell-command-to-string cmd))
  17627. (setq mathml
  17628. (when (file-readable-p tmp-out-file)
  17629. (with-current-buffer (find-file-noselect tmp-out-file t)
  17630. (goto-char (point-min))
  17631. (when (re-search-forward
  17632. (format "<math[^>]*?%s[^>]*?>\\(.\\|\n\\)*</math>"
  17633. (regexp-quote
  17634. "xmlns=\"http://www.w3.org/1998/Math/MathML\""))
  17635. nil t)
  17636. (prog1 (match-string 0) (kill-buffer))))))
  17637. (cond
  17638. (mathml
  17639. (setq mathml
  17640. (concat "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" mathml))
  17641. (when mathml-file
  17642. (write-region mathml nil mathml-file))
  17643. (when (called-interactively-p 'any)
  17644. (message mathml)))
  17645. ((message "LaTeX to MathML conversion failed")
  17646. (message shell-command-output)))
  17647. (delete-file tmp-in-file)
  17648. (when (file-exists-p tmp-out-file)
  17649. (delete-file tmp-out-file))
  17650. mathml))
  17651. (defun org-format-latex-as-mathml (latex-frag latex-frag-type
  17652. prefix &optional dir)
  17653. "Use `org-create-math-formula' but check local cache first."
  17654. (let* ((absprefix (expand-file-name prefix dir))
  17655. (print-length nil) (print-level nil)
  17656. (formula-id (concat
  17657. "formula-"
  17658. (sha1
  17659. (prin1-to-string
  17660. (list latex-frag
  17661. org-latex-to-mathml-convert-command)))))
  17662. (formula-cache (format "%s-%s.mathml" absprefix formula-id))
  17663. (formula-cache-dir (file-name-directory formula-cache)))
  17664. (unless (file-directory-p formula-cache-dir)
  17665. (make-directory formula-cache-dir t))
  17666. (unless (file-exists-p formula-cache)
  17667. (org-create-math-formula latex-frag formula-cache))
  17668. (if (file-exists-p formula-cache)
  17669. ;; Successful conversion. Return the link to MathML file.
  17670. (org-add-props
  17671. (format "[[file:%s]]" (file-relative-name formula-cache dir))
  17672. (list 'org-latex-src (replace-regexp-in-string "\"" "" latex-frag)
  17673. 'org-latex-src-embed-type (if latex-frag-type
  17674. 'paragraph 'character)))
  17675. ;; Failed conversion. Return the LaTeX fragment verbatim
  17676. latex-frag)))
  17677. (declare-function org-export-get-backend "ox" (name))
  17678. (declare-function org-export--get-global-options "ox" (&optional backend))
  17679. (declare-function org-export--get-inbuffer-options "ox" (&optional backend))
  17680. (declare-function org-latex-guess-inputenc "ox-latex" (header))
  17681. (declare-function org-latex-guess-babel-language "ox-latex" (header info))
  17682. (defun org-create-formula--latex-header ()
  17683. "Return LaTeX header appropriate for previewing a LaTeX snippet."
  17684. (let ((info (org-combine-plists (org-export--get-global-options
  17685. (org-export-get-backend 'latex))
  17686. (org-export--get-inbuffer-options
  17687. (org-export-get-backend 'latex)))))
  17688. (org-latex-guess-babel-language
  17689. (org-latex-guess-inputenc
  17690. (org-splice-latex-header
  17691. org-format-latex-header
  17692. org-latex-default-packages-alist
  17693. org-latex-packages-alist t
  17694. (plist-get info :latex-header)))
  17695. info)))
  17696. (defun org--get-display-dpi ()
  17697. "Get the DPI of the display.
  17698. The function assumes that the display has the same pixel width in
  17699. the horizontal and vertical directions."
  17700. (if (display-graphic-p)
  17701. (round (/ (display-pixel-height)
  17702. (/ (display-mm-height) 25.4)))
  17703. (error "Attempt to calculate the dpi of a non-graphic display")))
  17704. (defun org-create-formula-image
  17705. (string tofile options buffer &optional processing-type)
  17706. "Create an image from LaTeX source using external processes.
  17707. The LaTeX STRING is saved to a temporary LaTeX file, then
  17708. converted to an image file by process PROCESSING-TYPE defined in
  17709. `org-preview-latex-process-alist'. A nil value defaults to
  17710. `org-preview-latex-default-process'.
  17711. The generated image file is eventually moved to TOFILE.
  17712. The OPTIONS argument controls the size, foreground color and
  17713. background color of the generated image.
  17714. When BUFFER non-nil, this function is used for LaTeX previewing.
  17715. Otherwise, it is used to deal with LaTeX snippets showed in
  17716. a HTML file."
  17717. (let* ((processing-type (or processing-type
  17718. org-preview-latex-default-process))
  17719. (processing-info
  17720. (cdr (assq processing-type org-preview-latex-process-alist)))
  17721. (programs (plist-get processing-info :programs))
  17722. (error-message (or (plist-get processing-info :message) ""))
  17723. (use-xcolor (plist-get processing-info :use-xcolor))
  17724. (image-input-type (plist-get processing-info :image-input-type))
  17725. (image-output-type (plist-get processing-info :image-output-type))
  17726. (post-clean (or (plist-get processing-info :post-clean)
  17727. '(".dvi" ".xdv" ".pdf" ".tex" ".aux" ".log"
  17728. ".svg" ".png" ".jpg" ".jpeg" ".out")))
  17729. (latex-header (or (plist-get processing-info :latex-header)
  17730. (org-create-formula--latex-header)))
  17731. (latex-compiler (plist-get processing-info :latex-compiler))
  17732. (image-converter (plist-get processing-info :image-converter))
  17733. (tmpdir temporary-file-directory)
  17734. (texfilebase (make-temp-name
  17735. (expand-file-name "orgtex" tmpdir)))
  17736. (texfile (concat texfilebase ".tex"))
  17737. (image-size-adjust (or (plist-get processing-info :image-size-adjust)
  17738. '(1.0 . 1.0)))
  17739. (scale (* (if buffer (car image-size-adjust) (cdr image-size-adjust))
  17740. (or (plist-get options (if buffer :scale :html-scale)) 1.0)))
  17741. (dpi (* scale (if buffer (org--get-display-dpi) 140.0)))
  17742. (fg (or (plist-get options (if buffer :foreground :html-foreground))
  17743. "Black"))
  17744. (bg (or (plist-get options (if buffer :background :html-background))
  17745. "Transparent"))
  17746. (log-buf (get-buffer-create "*Org Preview LaTeX Output*"))
  17747. (resize-mini-windows nil)) ;Fix Emacs flicker when creating image.
  17748. (dolist (program programs)
  17749. (org-check-external-command program error-message))
  17750. (if use-xcolor
  17751. (progn (if (eq fg 'default)
  17752. (setq fg (org-latex-color :foreground))
  17753. (setq fg (org-latex-color-format fg)))
  17754. (if (eq bg 'default)
  17755. (setq bg (org-latex-color :background))
  17756. (setq bg (org-latex-color-format
  17757. (if (string= bg "Transparent") "white" bg))))
  17758. (with-temp-file texfile
  17759. (insert latex-header)
  17760. (insert "\n\\begin{document}\n"
  17761. "\\definecolor{fg}{rgb}{" fg "}\n"
  17762. "\\definecolor{bg}{rgb}{" bg "}\n"
  17763. "\n\\pagecolor{bg}\n"
  17764. "\n{\\color{fg}\n"
  17765. string
  17766. "\n}\n"
  17767. "\n\\end{document}\n")))
  17768. (if (eq fg 'default)
  17769. (setq fg (org-dvipng-color :foreground))
  17770. (unless (string= fg "Transparent")
  17771. (setq fg (org-dvipng-color-format fg))))
  17772. (if (eq bg 'default)
  17773. (setq bg (org-dvipng-color :background))
  17774. (unless (string= bg "Transparent")
  17775. (setq bg (org-dvipng-color-format bg))))
  17776. (with-temp-file texfile
  17777. (insert latex-header)
  17778. (insert "\n\\begin{document}\n" string "\n\\end{document}\n")))
  17779. (let* ((err-msg (format "Please adjust '%s' part of \
  17780. `org-preview-latex-process-alist'."
  17781. processing-type))
  17782. (image-input-file
  17783. (org-compile-file
  17784. texfile latex-compiler image-input-type err-msg log-buf))
  17785. (image-output-file
  17786. (org-compile-file
  17787. image-input-file image-converter image-output-type err-msg log-buf
  17788. `((?F . ,(shell-quote-argument fg))
  17789. (?B . ,(shell-quote-argument bg))
  17790. (?D . ,(shell-quote-argument (format "%s" dpi)))
  17791. (?S . ,(shell-quote-argument (format "%s" (/ dpi 140.0))))))))
  17792. (copy-file image-output-file tofile 'replace)
  17793. (dolist (e post-clean)
  17794. (when (file-exists-p (concat texfilebase e))
  17795. (delete-file (concat texfilebase e))))
  17796. image-output-file)))
  17797. (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
  17798. "Fill a LaTeX header template TPL.
  17799. In the template, the following place holders will be recognized:
  17800. [DEFAULT-PACKAGES] \\usepackage statements for DEF-PKG
  17801. [NO-DEFAULT-PACKAGES] do not include DEF-PKG
  17802. [PACKAGES] \\usepackage statements for PKG
  17803. [NO-PACKAGES] do not include PKG
  17804. [EXTRA] the string EXTRA
  17805. [NO-EXTRA] do not include EXTRA
  17806. For backward compatibility, if both the positive and the negative place
  17807. holder is missing, the positive one (without the \"NO-\") will be
  17808. assumed to be present at the end of the template.
  17809. DEF-PKG and PKG are assumed to be alists of options/packagename lists.
  17810. EXTRA is a string.
  17811. SNIPPETS-P indicates if this is run to create snippet images for HTML."
  17812. (let (rpl (end ""))
  17813. (if (string-match "^[ \t]*\\[\\(NO-\\)?DEFAULT-PACKAGES\\][ \t]*\n?" tpl)
  17814. (setq rpl (if (or (match-end 1) (not def-pkg))
  17815. "" (org-latex-packages-to-string def-pkg snippets-p t))
  17816. tpl (replace-match rpl t t tpl))
  17817. (when def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
  17818. (if (string-match "\\[\\(NO-\\)?PACKAGES\\][ \t]*\n?" tpl)
  17819. (setq rpl (if (or (match-end 1) (not pkg))
  17820. "" (org-latex-packages-to-string pkg snippets-p t))
  17821. tpl (replace-match rpl t t tpl))
  17822. (when pkg (setq end
  17823. (concat end "\n"
  17824. (org-latex-packages-to-string pkg snippets-p)))))
  17825. (if (string-match "\\[\\(NO-\\)?EXTRA\\][ \t]*\n?" tpl)
  17826. (setq rpl (if (or (match-end 1) (not extra))
  17827. "" (concat extra "\n"))
  17828. tpl (replace-match rpl t t tpl))
  17829. (when (and extra (string-match "\\S-" extra))
  17830. (setq end (concat end "\n" extra))))
  17831. (if (string-match "\\S-" end)
  17832. (concat tpl "\n" end)
  17833. tpl)))
  17834. (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
  17835. "Turn an alist of packages into a string with the \\usepackage macros."
  17836. (setq pkg (mapconcat (lambda(p)
  17837. (cond
  17838. ((stringp p) p)
  17839. ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
  17840. (format "%% Package %s omitted" (cadr p)))
  17841. ((equal "" (car p))
  17842. (format "\\usepackage{%s}" (cadr p)))
  17843. (t
  17844. (format "\\usepackage[%s]{%s}"
  17845. (car p) (cadr p)))))
  17846. pkg
  17847. "\n"))
  17848. (if newline (concat pkg "\n") pkg))
  17849. (defun org-dvipng-color (attr)
  17850. "Return a RGB color specification for dvipng."
  17851. (org-dvipng-color-format (face-attribute 'default attr nil)))
  17852. (defun org-dvipng-color-format (color-name)
  17853. "Convert COLOR-NAME to a RGB color value for dvipng."
  17854. (apply #'format "rgb %s %s %s"
  17855. (mapcar 'org-normalize-color
  17856. (color-values color-name))))
  17857. (defun org-latex-color (attr)
  17858. "Return a RGB color for the LaTeX color package."
  17859. (org-latex-color-format (face-attribute 'default attr nil)))
  17860. (defun org-latex-color-format (color-name)
  17861. "Convert COLOR-NAME to a RGB color value."
  17862. (apply #'format "%s,%s,%s"
  17863. (mapcar 'org-normalize-color
  17864. (color-values color-name))))
  17865. (defun org-normalize-color (value)
  17866. "Return string to be used as color value for an RGB component."
  17867. (format "%g" (/ value 65535.0)))
  17868. ;; Image display
  17869. (defvar-local org-inline-image-overlays nil)
  17870. (defun org-toggle-inline-images (&optional include-linked)
  17871. "Toggle the display of inline images.
  17872. INCLUDE-LINKED is passed to `org-display-inline-images'."
  17873. (interactive "P")
  17874. (if org-inline-image-overlays
  17875. (progn
  17876. (org-remove-inline-images)
  17877. (when (called-interactively-p 'interactive)
  17878. (message "Inline image display turned off")))
  17879. (org-display-inline-images include-linked)
  17880. (when (called-interactively-p 'interactive)
  17881. (message (if org-inline-image-overlays
  17882. (format "%d images displayed inline"
  17883. (length org-inline-image-overlays))
  17884. "No images to display inline")))))
  17885. (defun org-redisplay-inline-images ()
  17886. "Refresh the display of inline images."
  17887. (interactive)
  17888. (if (not org-inline-image-overlays)
  17889. (org-toggle-inline-images)
  17890. (org-toggle-inline-images)
  17891. (org-toggle-inline-images)))
  17892. (defun org-display-inline-images (&optional include-linked refresh beg end)
  17893. "Display inline images.
  17894. An inline image is a link which follows either of these
  17895. conventions:
  17896. 1. Its path is a file with an extension matching return value
  17897. from `image-file-name-regexp' and it has no contents.
  17898. 2. Its description consists in a single link of the previous
  17899. type.
  17900. When optional argument INCLUDE-LINKED is non-nil, also links with
  17901. a text description part will be inlined. This can be nice for
  17902. a quick look at those images, but it does not reflect what
  17903. exported files will look like.
  17904. When optional argument REFRESH is non-nil, refresh existing
  17905. images between BEG and END. This will create new image displays
  17906. only if necessary. BEG and END default to the buffer
  17907. boundaries."
  17908. (interactive "P")
  17909. (when (display-graphic-p)
  17910. (unless refresh
  17911. (org-remove-inline-images)
  17912. (when (fboundp 'clear-image-cache) (clear-image-cache)))
  17913. (org-with-wide-buffer
  17914. (goto-char (or beg (point-min)))
  17915. (let ((case-fold-search t)
  17916. (file-extension-re (image-file-name-regexp)))
  17917. (while (re-search-forward "[][]\\[\\(?:file\\|[./~]\\)" end t)
  17918. (let ((link (save-match-data (org-element-context))))
  17919. ;; Check if we're at an inline image.
  17920. (when (and (equal (org-element-property :type link) "file")
  17921. (or include-linked
  17922. (not (org-element-property :contents-begin link)))
  17923. (let ((parent (org-element-property :parent link)))
  17924. (or (not (eq (org-element-type parent) 'link))
  17925. (not (cdr (org-element-contents parent)))))
  17926. (string-match-p file-extension-re
  17927. (org-element-property :path link)))
  17928. (let ((file (expand-file-name
  17929. (org-link-unescape
  17930. (org-element-property :path link)))))
  17931. (when (file-exists-p file)
  17932. (let ((width
  17933. ;; Apply `org-image-actual-width' specifications.
  17934. (cond
  17935. ((not (image-type-available-p 'imagemagick)) nil)
  17936. ((eq org-image-actual-width t) nil)
  17937. ((listp org-image-actual-width)
  17938. (or
  17939. ;; First try to find a width among
  17940. ;; attributes associated to the paragraph
  17941. ;; containing link.
  17942. (let ((paragraph
  17943. (let ((e link))
  17944. (while (and (setq e (org-element-property
  17945. :parent e))
  17946. (not (eq (org-element-type e)
  17947. 'paragraph))))
  17948. e)))
  17949. (when paragraph
  17950. (save-excursion
  17951. (goto-char (org-element-property :begin paragraph))
  17952. (when
  17953. (re-search-forward
  17954. "^[ \t]*#\\+attr_.*?: +.*?:width +\\(\\S-+\\)"
  17955. (org-element-property
  17956. :post-affiliated paragraph)
  17957. t)
  17958. (string-to-number (match-string 1))))))
  17959. ;; Otherwise, fall-back to provided number.
  17960. (car org-image-actual-width)))
  17961. ((numberp org-image-actual-width)
  17962. org-image-actual-width)))
  17963. (old (get-char-property-and-overlay
  17964. (org-element-property :begin link)
  17965. 'org-image-overlay)))
  17966. (if (and (car-safe old) refresh)
  17967. (image-refresh (overlay-get (cdr old) 'display))
  17968. (let ((image (create-image file
  17969. (and width 'imagemagick)
  17970. nil
  17971. :width width)))
  17972. (when image
  17973. (let* ((link
  17974. ;; If inline image is the description
  17975. ;; of another link, be sure to
  17976. ;; consider the latter as the one to
  17977. ;; apply the overlay on.
  17978. (let ((parent
  17979. (org-element-property :parent link)))
  17980. (if (eq (org-element-type parent) 'link)
  17981. parent
  17982. link)))
  17983. (ov (make-overlay
  17984. (org-element-property :begin link)
  17985. (progn
  17986. (goto-char
  17987. (org-element-property :end link))
  17988. (skip-chars-backward " \t")
  17989. (point)))))
  17990. (overlay-put ov 'display image)
  17991. (overlay-put ov 'face 'default)
  17992. (overlay-put ov 'org-image-overlay t)
  17993. (overlay-put
  17994. ov 'modification-hooks
  17995. (list 'org-display-inline-remove-overlay))
  17996. (push ov org-inline-image-overlays)))))))))))))))
  17997. (defun org-display-inline-remove-overlay (ov after _beg _end &optional _len)
  17998. "Remove inline-display overlay if a corresponding region is modified."
  17999. (let ((inhibit-modification-hooks t))
  18000. (when (and ov after)
  18001. (delete ov org-inline-image-overlays)
  18002. (delete-overlay ov))))
  18003. (defun org-remove-inline-images ()
  18004. "Remove inline display of images."
  18005. (interactive)
  18006. (mapc #'delete-overlay org-inline-image-overlays)
  18007. (setq org-inline-image-overlays nil))
  18008. ;;;; Key bindings
  18009. ;; Outline functions from `outline-mode-prefix-map'
  18010. ;; that can be remapped in Org:
  18011. (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
  18012. (define-key org-mode-map [remap outline-show-subtree] 'org-show-subtree)
  18013. (define-key org-mode-map [remap outline-forward-same-level]
  18014. 'org-forward-heading-same-level)
  18015. (define-key org-mode-map [remap outline-backward-same-level]
  18016. 'org-backward-heading-same-level)
  18017. (define-key org-mode-map [remap outline-show-branches]
  18018. 'org-kill-note-or-show-branches)
  18019. (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
  18020. (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
  18021. (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
  18022. (define-key org-mode-map [remap outline-next-visible-heading]
  18023. 'org-next-visible-heading)
  18024. (define-key org-mode-map [remap outline-previous-visible-heading]
  18025. 'org-previous-visible-heading)
  18026. (define-key org-mode-map [remap show-children] 'org-show-children)
  18027. ;; Outline functions from `outline-mode-prefix-map' that can not
  18028. ;; be remapped in Org:
  18029. ;; - the column "key binding" shows whether the Outline function is still
  18030. ;; available in Org mode on the same key that it has been bound to in
  18031. ;; Outline mode:
  18032. ;; - "overridden": key used for a different functionality in Org mode
  18033. ;; - else: key still bound to the same Outline function in Org mode
  18034. ;; | Outline function | key binding | Org replacement |
  18035. ;; |------------------------------------+-------------+--------------------------|
  18036. ;; | `outline-up-heading' | `C-c C-u' | still same function |
  18037. ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
  18038. ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
  18039. ;; | `show-entry' | overridden | no replacement |
  18040. ;; | `show-branches' | `C-c C-k' | still same function |
  18041. ;; | `show-subtree' | overridden | visibility cycling |
  18042. ;; | `show-all' | overridden | no replacement |
  18043. ;; | `hide-subtree' | overridden | visibility cycling |
  18044. ;; | `hide-body' | overridden | no replacement |
  18045. ;; | `hide-entry' | overridden | visibility cycling |
  18046. ;; | `hide-leaves' | overridden | no replacement |
  18047. ;; | `hide-sublevels' | overridden | no replacement |
  18048. ;; | `hide-other' | overridden | no replacement |
  18049. ;; Make `C-c C-x' a prefix key
  18050. (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
  18051. ;; TAB key with modifiers
  18052. (org-defkey org-mode-map "\C-i" 'org-cycle)
  18053. (org-defkey org-mode-map [(tab)] 'org-cycle)
  18054. (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
  18055. (org-defkey org-mode-map "\M-\t" #'pcomplete)
  18056. ;; The following line is necessary under Suse GNU/Linux
  18057. (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab)
  18058. (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
  18059. (define-key org-mode-map [backtab] 'org-shifttab)
  18060. (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
  18061. (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
  18062. (org-defkey org-mode-map [(meta return)] 'org-meta-return)
  18063. ;; Cursor keys with modifiers
  18064. (org-defkey org-mode-map [(meta left)] 'org-metaleft)
  18065. (org-defkey org-mode-map [(meta right)] 'org-metaright)
  18066. (org-defkey org-mode-map [(meta up)] 'org-metaup)
  18067. (org-defkey org-mode-map [(meta down)] 'org-metadown)
  18068. (org-defkey org-mode-map [(control meta shift right)] 'org-increase-number-at-point)
  18069. (org-defkey org-mode-map [(control meta shift left)] 'org-decrease-number-at-point)
  18070. (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
  18071. (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
  18072. (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
  18073. (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
  18074. (org-defkey org-mode-map [(shift up)] 'org-shiftup)
  18075. (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
  18076. (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
  18077. (org-defkey org-mode-map [(shift right)] 'org-shiftright)
  18078. (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
  18079. (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
  18080. (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
  18081. (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
  18082. ;; Babel keys
  18083. (define-key org-mode-map org-babel-key-prefix org-babel-map)
  18084. (dolist (pair org-babel-key-bindings)
  18085. (define-key org-babel-map (car pair) (cdr pair)))
  18086. ;;; Extra keys for tty access.
  18087. ;; We only set them when really needed because otherwise the
  18088. ;; menus don't show the simple keys
  18089. (when (or org-use-extra-keys (not window-system))
  18090. (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
  18091. (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
  18092. (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
  18093. (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
  18094. (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
  18095. (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
  18096. (org-defkey org-mode-map [?\e (right)] 'org-metaright)
  18097. (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
  18098. (org-defkey org-mode-map [?\e (up)] 'org-metaup)
  18099. (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
  18100. (org-defkey org-mode-map [?\e (down)] 'org-metadown)
  18101. (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
  18102. (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
  18103. (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
  18104. (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
  18105. (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
  18106. (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
  18107. (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
  18108. (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
  18109. (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
  18110. (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
  18111. (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
  18112. (org-defkey org-mode-map [?\e (tab)] #'pcomplete)
  18113. (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
  18114. (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
  18115. (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
  18116. (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
  18117. (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
  18118. ;; All the other keys
  18119. (org-defkey org-mode-map "\C-c\C-a" 'outline-show-all) ; in case allout messed up.
  18120. (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
  18121. (if (boundp 'narrow-map)
  18122. (org-defkey narrow-map "s" 'org-narrow-to-subtree)
  18123. (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
  18124. (if (boundp 'narrow-map)
  18125. (org-defkey narrow-map "b" 'org-narrow-to-block)
  18126. (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
  18127. (if (boundp 'narrow-map)
  18128. (org-defkey narrow-map "e" 'org-narrow-to-element)
  18129. (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
  18130. (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
  18131. (org-defkey org-mode-map "\M-}" 'org-forward-element)
  18132. (org-defkey org-mode-map "\M-{" 'org-backward-element)
  18133. (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
  18134. (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
  18135. (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
  18136. (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
  18137. (org-defkey org-mode-map "\C-c\M-f" 'org-next-block)
  18138. (org-defkey org-mode-map "\C-c\M-b" 'org-previous-block)
  18139. (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
  18140. (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-archive-subtree)
  18141. (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
  18142. (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
  18143. (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
  18144. (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
  18145. (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
  18146. (org-defkey org-mode-map "\C-c\C-xq" 'org-toggle-tags-groups)
  18147. (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
  18148. (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
  18149. (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
  18150. (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
  18151. (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
  18152. (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
  18153. (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
  18154. (org-defkey org-mode-map "\C-c\M-w" 'org-copy)
  18155. (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
  18156. (org-defkey org-mode-map "\C-c\\" 'org-match-sparse-tree) ; Minor-mode res.
  18157. (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
  18158. (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
  18159. (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
  18160. (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
  18161. (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
  18162. (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
  18163. (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
  18164. (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
  18165. (org-defkey org-mode-map "\C-c\M-l" 'org-insert-last-stored-link)
  18166. (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
  18167. (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
  18168. (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
  18169. (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
  18170. (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
  18171. (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
  18172. (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
  18173. (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
  18174. (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
  18175. (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
  18176. (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
  18177. (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
  18178. (org-defkey org-mode-map [(control ?\')] 'org-cycle-agenda-files)
  18179. (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
  18180. (org-defkey org-mode-map "\C-c]" 'org-remove-file)
  18181. (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
  18182. (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
  18183. (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
  18184. (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
  18185. (org-defkey org-mode-map "\C-c^" 'org-sort)
  18186. (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
  18187. (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
  18188. (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
  18189. (org-defkey org-mode-map [remap open-line] 'org-open-line)
  18190. (org-defkey org-mode-map [remap comment-dwim] 'org-comment-dwim)
  18191. (org-defkey org-mode-map [remap forward-paragraph] 'org-forward-paragraph)
  18192. (org-defkey org-mode-map [remap backward-paragraph] 'org-backward-paragraph)
  18193. (org-defkey org-mode-map "\M-^" 'org-delete-indentation)
  18194. (org-defkey org-mode-map "\C-m" 'org-return)
  18195. (org-defkey org-mode-map "\C-j" 'org-return-indent)
  18196. (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
  18197. (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
  18198. (org-defkey org-mode-map "\C-c+" 'org-table-sum)
  18199. (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
  18200. (org-defkey org-mode-map "\C-c'" 'org-edit-special)
  18201. (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
  18202. (org-defkey org-mode-map "\C-c\"a" 'orgtbl-ascii-plot)
  18203. (org-defkey org-mode-map "\C-c\"g" 'org-plot/gnuplot)
  18204. (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
  18205. (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
  18206. (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
  18207. (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
  18208. (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
  18209. (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
  18210. (org-defkey org-mode-map "\C-c\C-e" 'org-export-dispatch)
  18211. (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width)
  18212. (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
  18213. (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
  18214. (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
  18215. (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
  18216. (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
  18217. (org-defkey org-mode-map "\M-h" 'org-mark-element)
  18218. (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
  18219. ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
  18220. (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
  18221. (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
  18222. (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
  18223. (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
  18224. (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
  18225. (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
  18226. (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
  18227. (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
  18228. (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
  18229. (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
  18230. (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
  18231. (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
  18232. (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
  18233. (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-toggle-latex-fragment)
  18234. (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
  18235. (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
  18236. (org-defkey org-mode-map "\C-c\C-x\\" 'org-toggle-pretty-entities)
  18237. (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
  18238. (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
  18239. (org-defkey org-mode-map "\C-c\C-xP" 'org-set-property-and-value)
  18240. (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
  18241. (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
  18242. (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
  18243. (org-defkey org-mode-map "\C-c\C-xi" 'org-columns-insert-dblock)
  18244. (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
  18245. (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
  18246. (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
  18247. (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
  18248. (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
  18249. (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
  18250. (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
  18251. (define-key org-mode-map "\C-c\C-x!" 'org-reload)
  18252. (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
  18253. (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
  18254. (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
  18255. (defconst org-speed-commands-default
  18256. '(
  18257. ("Outline Navigation")
  18258. ("n" . (org-speed-move-safe 'org-next-visible-heading))
  18259. ("p" . (org-speed-move-safe 'org-previous-visible-heading))
  18260. ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
  18261. ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
  18262. ("F" . org-next-block)
  18263. ("B" . org-previous-block)
  18264. ("u" . (org-speed-move-safe 'outline-up-heading))
  18265. ("j" . org-goto)
  18266. ("g" . (org-refile t))
  18267. ("Outline Visibility")
  18268. ("c" . org-cycle)
  18269. ("C" . org-shifttab)
  18270. (" " . org-display-outline-path)
  18271. ("s" . org-narrow-to-subtree)
  18272. ("=" . org-columns)
  18273. ("Outline Structure Editing")
  18274. ("U" . org-metaup)
  18275. ("D" . org-metadown)
  18276. ("r" . org-metaright)
  18277. ("l" . org-metaleft)
  18278. ("R" . org-shiftmetaright)
  18279. ("L" . org-shiftmetaleft)
  18280. ("i" . (progn (forward-char 1) (call-interactively
  18281. 'org-insert-heading-respect-content)))
  18282. ("^" . org-sort)
  18283. ("w" . org-refile)
  18284. ("a" . org-archive-subtree-default-with-confirmation)
  18285. ("@" . org-mark-subtree)
  18286. ("#" . org-toggle-comment)
  18287. ("Clock Commands")
  18288. ("I" . org-clock-in)
  18289. ("O" . org-clock-out)
  18290. ("Meta Data Editing")
  18291. ("t" . org-todo)
  18292. ("," . (org-priority))
  18293. ("0" . (org-priority ?\ ))
  18294. ("1" . (org-priority ?A))
  18295. ("2" . (org-priority ?B))
  18296. ("3" . (org-priority ?C))
  18297. (":" . org-set-tags-command)
  18298. ("e" . org-set-effort)
  18299. ("E" . org-inc-effort)
  18300. ("W" . (lambda(m) (interactive "sMinutes before warning: ")
  18301. (org-entry-put (point) "APPT_WARNTIME" m)))
  18302. ("Agenda Views etc")
  18303. ("v" . org-agenda)
  18304. ("/" . org-sparse-tree)
  18305. ("Misc")
  18306. ("o" . org-open-at-point)
  18307. ("?" . org-speed-command-help)
  18308. ("<" . (org-agenda-set-restriction-lock 'subtree))
  18309. (">" . (org-agenda-remove-restriction-lock))
  18310. )
  18311. "The default speed commands.")
  18312. (defun org-print-speed-command (e)
  18313. (if (> (length (car e)) 1)
  18314. (progn
  18315. (princ "\n")
  18316. (princ (car e))
  18317. (princ "\n")
  18318. (princ (make-string (length (car e)) ?-))
  18319. (princ "\n"))
  18320. (princ (car e))
  18321. (princ " ")
  18322. (if (symbolp (cdr e))
  18323. (princ (symbol-name (cdr e)))
  18324. (prin1 (cdr e)))
  18325. (princ "\n")))
  18326. (defun org-speed-command-help ()
  18327. "Show the available speed commands."
  18328. (interactive)
  18329. (if (not org-use-speed-commands)
  18330. (user-error "Speed commands are not activated, customize `org-use-speed-commands'")
  18331. (with-output-to-temp-buffer "*Help*"
  18332. (princ "User-defined Speed commands\n===========================\n")
  18333. (mapc #'org-print-speed-command org-speed-commands-user)
  18334. (princ "\n")
  18335. (princ "Built-in Speed commands\n=======================\n")
  18336. (mapc #'org-print-speed-command org-speed-commands-default))
  18337. (with-current-buffer "*Help*"
  18338. (setq truncate-lines t))))
  18339. (defun org-speed-move-safe (cmd)
  18340. "Execute CMD, but make sure that the cursor always ends up in a headline.
  18341. If not, return to the original position and throw an error."
  18342. (interactive)
  18343. (let ((pos (point)))
  18344. (call-interactively cmd)
  18345. (unless (and (bolp) (org-at-heading-p))
  18346. (goto-char pos)
  18347. (error "Boundary reached while executing %s" cmd))))
  18348. (defvar org-self-insert-command-undo-counter 0)
  18349. (defvar org-table-auto-blank-field) ; defined in org-table.el
  18350. (defvar org-speed-command nil)
  18351. (defun org-speed-command-activate (keys)
  18352. "Hook for activating single-letter speed commands.
  18353. `org-speed-commands-default' specifies a minimal command set.
  18354. Use `org-speed-commands-user' for further customization."
  18355. (when (or (and (bolp) (looking-at org-outline-regexp))
  18356. (and (functionp org-use-speed-commands)
  18357. (funcall org-use-speed-commands)))
  18358. (cdr (assoc keys (append org-speed-commands-user
  18359. org-speed-commands-default)))))
  18360. (defun org-babel-speed-command-activate (keys)
  18361. "Hook for activating single-letter code block commands."
  18362. (when (and (bolp) (looking-at org-babel-src-block-regexp))
  18363. (cdr (assoc keys org-babel-key-bindings))))
  18364. (defcustom org-speed-command-hook
  18365. '(org-speed-command-activate org-babel-speed-command-activate)
  18366. "Hook for activating speed commands at strategic locations.
  18367. Hook functions are called in sequence until a valid handler is
  18368. found.
  18369. Each hook takes a single argument, a user-pressed command key
  18370. which is also a `self-insert-command' from the global map.
  18371. Within the hook, examine the cursor position and the command key
  18372. and return nil or a valid handler as appropriate. Handler could
  18373. be one of an interactive command, a function, or a form.
  18374. Set `org-use-speed-commands' to non-nil value to enable this
  18375. hook. The default setting is `org-speed-command-activate'."
  18376. :group 'org-structure
  18377. :version "24.1"
  18378. :type 'hook)
  18379. (defun org-self-insert-command (N)
  18380. "Like `self-insert-command', use overwrite-mode for whitespace in tables.
  18381. If the cursor is in a table looking at whitespace, the whitespace is
  18382. overwritten, and the table is not marked as requiring realignment."
  18383. (interactive "p")
  18384. (org-check-before-invisible-edit 'insert)
  18385. (cond
  18386. ((and org-use-speed-commands
  18387. (let ((kv (this-command-keys-vector)))
  18388. (setq org-speed-command
  18389. (run-hook-with-args-until-success
  18390. 'org-speed-command-hook
  18391. (make-string 1 (aref kv (1- (length kv))))))))
  18392. (cond
  18393. ((commandp org-speed-command)
  18394. (setq this-command org-speed-command)
  18395. (call-interactively org-speed-command))
  18396. ((functionp org-speed-command)
  18397. (funcall org-speed-command))
  18398. ((and org-speed-command (listp org-speed-command))
  18399. (eval org-speed-command))
  18400. (t (let (org-use-speed-commands)
  18401. (call-interactively 'org-self-insert-command)))))
  18402. ((and
  18403. (org-at-table-p)
  18404. (progn
  18405. ;; Check if we blank the field, and if that triggers align.
  18406. (and (featurep 'org-table) org-table-auto-blank-field
  18407. (memq last-command
  18408. '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c))
  18409. (if (or (eq (char-after) ?\s) (looking-at "[^|\n]* |"))
  18410. ;; Got extra space, this field does not determine
  18411. ;; column width.
  18412. (let (org-table-may-need-update) (org-table-blank-field))
  18413. ;; No extra space, this field may determine column
  18414. ;; width.
  18415. (org-table-blank-field)))
  18416. t)
  18417. (eq N 1)
  18418. (looking-at "[^|\n]* \\( \\)|"))
  18419. ;; There is room for insertion without re-aligning the table.
  18420. (delete-region (match-beginning 1) (match-end 1))
  18421. (self-insert-command N))
  18422. (t
  18423. (setq org-table-may-need-update t)
  18424. (self-insert-command N)
  18425. (org-fix-tags-on-the-fly)
  18426. (when org-self-insert-cluster-for-undo
  18427. (if (not (eq last-command 'org-self-insert-command))
  18428. (setq org-self-insert-command-undo-counter 1)
  18429. (if (>= org-self-insert-command-undo-counter 20)
  18430. (setq org-self-insert-command-undo-counter 1)
  18431. (and (> org-self-insert-command-undo-counter 0)
  18432. buffer-undo-list (listp buffer-undo-list)
  18433. (not (cadr buffer-undo-list)) ; remove nil entry
  18434. (setcdr buffer-undo-list (cddr buffer-undo-list)))
  18435. (setq org-self-insert-command-undo-counter
  18436. (1+ org-self-insert-command-undo-counter))))))))
  18437. (defun org-check-before-invisible-edit (kind)
  18438. "Check is editing if kind KIND would be dangerous with invisible text around.
  18439. The detailed reaction depends on the user option `org-catch-invisible-edits'."
  18440. ;; First, try to get out of here as quickly as possible, to reduce overhead
  18441. (when (and org-catch-invisible-edits
  18442. (or (not (boundp 'visible-mode)) (not visible-mode))
  18443. (or (get-char-property (point) 'invisible)
  18444. (get-char-property (max (point-min) (1- (point))) 'invisible)))
  18445. ;; OK, we need to take a closer look
  18446. (let* ((invisible-at-point (get-char-property (point) 'invisible))
  18447. (invisible-before-point (unless (bobp) (get-char-property
  18448. (1- (point)) 'invisible)))
  18449. (border-and-ok-direction
  18450. (or
  18451. ;; Check if we are acting predictably before invisible text
  18452. (and invisible-at-point (not invisible-before-point)
  18453. (memq kind '(insert delete-backward)))
  18454. ;; Check if we are acting predictably after invisible text
  18455. ;; This works not well, and I have turned it off. It seems
  18456. ;; better to always show and stop after invisible text.
  18457. ;; (and (not invisible-at-point) invisible-before-point
  18458. ;; (memq kind '(insert delete)))
  18459. )))
  18460. (when (or (memq invisible-at-point '(outline org-hide-block t))
  18461. (memq invisible-before-point '(outline org-hide-block t)))
  18462. (when (eq org-catch-invisible-edits 'error)
  18463. (user-error "Editing in invisible areas is prohibited, make them visible first"))
  18464. (if (and org-custom-properties-overlays
  18465. (y-or-n-p "Display invisible properties in this buffer? "))
  18466. (org-toggle-custom-properties-visibility)
  18467. ;; Make the area visible
  18468. (save-excursion
  18469. (when invisible-before-point
  18470. (goto-char (previous-single-char-property-change
  18471. (point) 'invisible)))
  18472. (outline-show-subtree))
  18473. (cond
  18474. ((eq org-catch-invisible-edits 'show)
  18475. ;; That's it, we do the edit after showing
  18476. (message
  18477. "Unfolding invisible region around point before editing")
  18478. (sit-for 1))
  18479. ((and (eq org-catch-invisible-edits 'smart)
  18480. border-and-ok-direction)
  18481. (message "Unfolding invisible region around point before editing"))
  18482. (t
  18483. ;; Don't do the edit, make the user repeat it in full visibility
  18484. (user-error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
  18485. (defun org-fix-tags-on-the-fly ()
  18486. "Align tags in headline at point.
  18487. Unlike to `org-set-tags', it ignores region and sorting."
  18488. (when (and (eq (char-after (line-beginning-position)) ?*) ;short-circuit
  18489. (org-at-heading-p))
  18490. (let ((org-ignore-region t)
  18491. (org-tags-sort-function nil))
  18492. (org-set-tags nil t))))
  18493. (defun org-delete-backward-char (N)
  18494. "Like `delete-backward-char', insert whitespace at field end in tables.
  18495. When deleting backwards, in tables this function will insert whitespace in
  18496. front of the next \"|\" separator, to keep the table aligned. The table will
  18497. still be marked for re-alignment if the field did fill the entire column,
  18498. because, in this case the deletion might narrow the column."
  18499. (interactive "p")
  18500. (save-match-data
  18501. (org-check-before-invisible-edit 'delete-backward)
  18502. (if (and (org-at-table-p)
  18503. (eq N 1)
  18504. (string-match "|" (buffer-substring (point-at-bol) (point)))
  18505. (looking-at ".*?|"))
  18506. (let ((pos (point))
  18507. (noalign (looking-at "[^|\n\r]* |"))
  18508. (c org-table-may-need-update))
  18509. (backward-delete-char N)
  18510. (unless overwrite-mode
  18511. (skip-chars-forward "^|")
  18512. (insert " ")
  18513. (goto-char (1- pos)))
  18514. ;; noalign: if there were two spaces at the end, this field
  18515. ;; does not determine the width of the column.
  18516. (when noalign (setq org-table-may-need-update c)))
  18517. (backward-delete-char N)
  18518. (org-fix-tags-on-the-fly))))
  18519. (defun org-delete-char (N)
  18520. "Like `delete-char', but insert whitespace at field end in tables.
  18521. When deleting characters, in tables this function will insert whitespace in
  18522. front of the next \"|\" separator, to keep the table aligned. The table will
  18523. still be marked for re-alignment if the field did fill the entire column,
  18524. because, in this case the deletion might narrow the column."
  18525. (interactive "p")
  18526. (save-match-data
  18527. (org-check-before-invisible-edit 'delete)
  18528. (if (and (org-at-table-p)
  18529. (not (bolp))
  18530. (not (= (char-after) ?|))
  18531. (eq N 1))
  18532. (if (looking-at ".*?|")
  18533. (let ((pos (point))
  18534. (noalign (looking-at "[^|\n\r]* |"))
  18535. (c org-table-may-need-update))
  18536. (replace-match
  18537. (concat (substring (match-string 0) 1 -1) " |") nil t)
  18538. (goto-char pos)
  18539. ;; noalign: if there were two spaces at the end, this field
  18540. ;; does not determine the width of the column.
  18541. (when noalign (setq org-table-may-need-update c)))
  18542. (delete-char N))
  18543. (delete-char N)
  18544. (org-fix-tags-on-the-fly))))
  18545. ;; Make `delete-selection-mode' work with Org mode and Orgtbl mode
  18546. (put 'org-self-insert-command 'delete-selection
  18547. (lambda ()
  18548. (not (run-hook-with-args-until-success
  18549. 'self-insert-uses-region-functions))))
  18550. (put 'orgtbl-self-insert-command 'delete-selection
  18551. (lambda ()
  18552. (not (run-hook-with-args-until-success
  18553. 'self-insert-uses-region-functions))))
  18554. (put 'org-delete-char 'delete-selection 'supersede)
  18555. (put 'org-delete-backward-char 'delete-selection 'supersede)
  18556. (put 'org-yank 'delete-selection 'yank)
  18557. ;; Make `flyspell-mode' delay after some commands
  18558. (put 'org-self-insert-command 'flyspell-delayed t)
  18559. (put 'orgtbl-self-insert-command 'flyspell-delayed t)
  18560. (put 'org-delete-char 'flyspell-delayed t)
  18561. (put 'org-delete-backward-char 'flyspell-delayed t)
  18562. ;; Make pabbrev-mode expand after Org mode commands
  18563. (put 'org-self-insert-command 'pabbrev-expand-after-command t)
  18564. (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
  18565. (defun org-remap (map &rest commands)
  18566. "In MAP, remap the functions given in COMMANDS.
  18567. COMMANDS is a list of alternating OLDDEF NEWDEF command names."
  18568. (let (new old)
  18569. (while commands
  18570. (setq old (pop commands) new (pop commands))
  18571. (org-defkey map (vector 'remap old) new))))
  18572. (defun org-transpose-words ()
  18573. "Transpose words for Org.
  18574. This uses the `org-mode-transpose-word-syntax-table' syntax
  18575. table, which interprets characters in `org-emphasis-alist' as
  18576. word constituents."
  18577. (interactive)
  18578. (with-syntax-table org-mode-transpose-word-syntax-table
  18579. (call-interactively 'transpose-words)))
  18580. (org-remap org-mode-map 'transpose-words 'org-transpose-words)
  18581. (when (eq org-enable-table-editor 'optimized)
  18582. ;; If the user wants maximum table support, we need to hijack
  18583. ;; some standard editing functions
  18584. (org-remap org-mode-map
  18585. 'self-insert-command 'org-self-insert-command
  18586. 'delete-char 'org-delete-char
  18587. 'delete-backward-char 'org-delete-backward-char)
  18588. (org-defkey org-mode-map "|" 'org-force-self-insert))
  18589. (defvar org-ctrl-c-ctrl-c-hook nil
  18590. "Hook for functions attaching themselves to `C-c C-c'.
  18591. This can be used to add additional functionality to the C-c C-c
  18592. key which executes context-dependent commands. This hook is run
  18593. before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
  18594. run after the last test.
  18595. Each function will be called with no arguments. The function
  18596. must check if the context is appropriate for it to act. If yes,
  18597. it should do its thing and then return a non-nil value. If the
  18598. context is wrong, just do nothing and return nil.")
  18599. (defvar org-ctrl-c-ctrl-c-final-hook nil
  18600. "Hook for functions attaching themselves to `C-c C-c'.
  18601. This can be used to add additional functionality to the C-c C-c
  18602. key which executes context-dependent commands. This hook is run
  18603. after any other test, while `org-ctrl-c-ctrl-c-hook' is run
  18604. before the first test.
  18605. Each function will be called with no arguments. The function
  18606. must check if the context is appropriate for it to act. If yes,
  18607. it should do its thing and then return a non-nil value. If the
  18608. context is wrong, just do nothing and return nil.")
  18609. (defvar org-tab-first-hook nil
  18610. "Hook for functions to attach themselves to TAB.
  18611. See `org-ctrl-c-ctrl-c-hook' for more information.
  18612. This hook runs as the first action when TAB is pressed, even before
  18613. `org-cycle' messes around with the `outline-regexp' to cater for
  18614. inline tasks and plain list item folding.
  18615. If any function in this hook returns t, any other actions that
  18616. would have been caused by TAB (such as table field motion or visibility
  18617. cycling) will not occur.")
  18618. (defvar org-tab-after-check-for-table-hook nil
  18619. "Hook for functions to attach themselves to TAB.
  18620. See `org-ctrl-c-ctrl-c-hook' for more information.
  18621. This hook runs after it has been established that the cursor is not in a
  18622. table, but before checking if the cursor is in a headline or if global cycling
  18623. should be done.
  18624. If any function in this hook returns t, not other actions like visibility
  18625. cycling will be done.")
  18626. (defvar org-tab-after-check-for-cycling-hook nil
  18627. "Hook for functions to attach themselves to TAB.
  18628. See `org-ctrl-c-ctrl-c-hook' for more information.
  18629. This hook runs after it has been established that not table field motion and
  18630. not visibility should be done because of current context. This is probably
  18631. the place where a package like yasnippets can hook in.")
  18632. (defvar org-tab-before-tab-emulation-hook nil
  18633. "Hook for functions to attach themselves to TAB.
  18634. See `org-ctrl-c-ctrl-c-hook' for more information.
  18635. This hook runs after every other options for TAB have been exhausted, but
  18636. before indentation and \t insertion takes place.")
  18637. (defvar org-metaleft-hook nil
  18638. "Hook for functions attaching themselves to `M-left'.
  18639. See `org-ctrl-c-ctrl-c-hook' for more information.")
  18640. (defvar org-metaright-hook nil
  18641. "Hook for functions attaching themselves to `M-right'.
  18642. See `org-ctrl-c-ctrl-c-hook' for more information.")
  18643. (defvar org-metaup-hook nil
  18644. "Hook for functions attaching themselves to `M-up'.
  18645. See `org-ctrl-c-ctrl-c-hook' for more information.")
  18646. (defvar org-metadown-hook nil
  18647. "Hook for functions attaching themselves to `M-down'.
  18648. See `org-ctrl-c-ctrl-c-hook' for more information.")
  18649. (defvar org-shiftmetaleft-hook nil
  18650. "Hook for functions attaching themselves to `M-S-left'.
  18651. See `org-ctrl-c-ctrl-c-hook' for more information.")
  18652. (defvar org-shiftmetaright-hook nil
  18653. "Hook for functions attaching themselves to `M-S-right'.
  18654. See `org-ctrl-c-ctrl-c-hook' for more information.")
  18655. (defvar org-shiftmetaup-hook nil
  18656. "Hook for functions attaching themselves to `M-S-up'.
  18657. See `org-ctrl-c-ctrl-c-hook' for more information.")
  18658. (defvar org-shiftmetadown-hook nil
  18659. "Hook for functions attaching themselves to `M-S-down'.
  18660. See `org-ctrl-c-ctrl-c-hook' for more information.")
  18661. (defvar org-metareturn-hook nil
  18662. "Hook for functions attaching themselves to `M-RET'.
  18663. See `org-ctrl-c-ctrl-c-hook' for more information.")
  18664. (defvar org-shiftup-hook nil
  18665. "Hook for functions attaching themselves to `S-up'.
  18666. See `org-ctrl-c-ctrl-c-hook' for more information.")
  18667. (defvar org-shiftup-final-hook nil
  18668. "Hook for functions attaching themselves to `S-up'.
  18669. This one runs after all other options except shift-select have been excluded.
  18670. See `org-ctrl-c-ctrl-c-hook' for more information.")
  18671. (defvar org-shiftdown-hook nil
  18672. "Hook for functions attaching themselves to `S-down'.
  18673. See `org-ctrl-c-ctrl-c-hook' for more information.")
  18674. (defvar org-shiftdown-final-hook nil
  18675. "Hook for functions attaching themselves to `S-down'.
  18676. This one runs after all other options except shift-select have been excluded.
  18677. See `org-ctrl-c-ctrl-c-hook' for more information.")
  18678. (defvar org-shiftleft-hook nil
  18679. "Hook for functions attaching themselves to `S-left'.
  18680. See `org-ctrl-c-ctrl-c-hook' for more information.")
  18681. (defvar org-shiftleft-final-hook nil
  18682. "Hook for functions attaching themselves to `S-left'.
  18683. This one runs after all other options except shift-select have been excluded.
  18684. See `org-ctrl-c-ctrl-c-hook' for more information.")
  18685. (defvar org-shiftright-hook nil
  18686. "Hook for functions attaching themselves to `S-right'.
  18687. See `org-ctrl-c-ctrl-c-hook' for more information.")
  18688. (defvar org-shiftright-final-hook nil
  18689. "Hook for functions attaching themselves to `S-right'.
  18690. This one runs after all other options except shift-select have been excluded.
  18691. See `org-ctrl-c-ctrl-c-hook' for more information.")
  18692. (defun org-modifier-cursor-error ()
  18693. "Throw an error, a modified cursor command was applied in wrong context."
  18694. (user-error "This command is active in special context like tables, headlines or items"))
  18695. (defun org-shiftselect-error ()
  18696. "Throw an error because Shift-Cursor command was applied in wrong context."
  18697. (if (and (boundp 'shift-select-mode) shift-select-mode)
  18698. (user-error "To use shift-selection with Org mode, customize `org-support-shift-select'")
  18699. (user-error "This command works only in special context like headlines or timestamps")))
  18700. (defun org-call-for-shift-select (cmd)
  18701. (let ((this-command-keys-shift-translated t))
  18702. (call-interactively cmd)))
  18703. (defun org-shifttab (&optional arg)
  18704. "Global visibility cycling or move to previous table field.
  18705. Call `org-table-previous-field' within a table.
  18706. When ARG is nil, cycle globally through visibility states.
  18707. When ARG is a numeric prefix, show contents of this level."
  18708. (interactive "P")
  18709. (cond
  18710. ((org-at-table-p) (call-interactively 'org-table-previous-field))
  18711. ((integerp arg)
  18712. (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
  18713. (message "Content view to level: %d" arg)
  18714. (org-content (prefix-numeric-value arg2))
  18715. (org-cycle-show-empty-lines t)
  18716. (setq org-cycle-global-status 'overview)))
  18717. (t (call-interactively 'org-global-cycle))))
  18718. (defun org-shiftmetaleft ()
  18719. "Promote subtree or delete table column.
  18720. Calls `org-promote-subtree', `org-outdent-item-tree', or
  18721. `org-table-delete-column', depending on context. See the
  18722. individual commands for more information."
  18723. (interactive)
  18724. (cond
  18725. ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
  18726. ((org-at-table-p) (call-interactively 'org-table-delete-column))
  18727. ((org-at-heading-p) (call-interactively 'org-promote-subtree))
  18728. ((if (not (org-region-active-p)) (org-at-item-p)
  18729. (save-excursion (goto-char (region-beginning))
  18730. (org-at-item-p)))
  18731. (call-interactively 'org-outdent-item-tree))
  18732. (t (org-modifier-cursor-error))))
  18733. (defun org-shiftmetaright ()
  18734. "Demote subtree or insert table column.
  18735. Calls `org-demote-subtree', `org-indent-item-tree', or
  18736. `org-table-insert-column', depending on context. See the
  18737. individual commands for more information."
  18738. (interactive)
  18739. (cond
  18740. ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
  18741. ((org-at-table-p) (call-interactively 'org-table-insert-column))
  18742. ((org-at-heading-p) (call-interactively 'org-demote-subtree))
  18743. ((if (not (org-region-active-p)) (org-at-item-p)
  18744. (save-excursion (goto-char (region-beginning))
  18745. (org-at-item-p)))
  18746. (call-interactively 'org-indent-item-tree))
  18747. (t (org-modifier-cursor-error))))
  18748. (defun org-shiftmetaup (&optional _arg)
  18749. "Drag the line at point up.
  18750. In a table, kill the current row.
  18751. On a clock timestamp, update the value of the timestamp like `S-<up>'
  18752. but also adjust the previous clocked item in the clock history.
  18753. Everywhere else, drag the line at point up."
  18754. (interactive "P")
  18755. (cond
  18756. ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
  18757. ((org-at-table-p) (call-interactively 'org-table-kill-row))
  18758. ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
  18759. (call-interactively 'org-timestamp-up)))
  18760. (t (call-interactively 'org-drag-line-backward))))
  18761. (defun org-shiftmetadown (&optional _arg)
  18762. "Drag the line at point down.
  18763. In a table, insert an empty row at the current line.
  18764. On a clock timestamp, update the value of the timestamp like `S-<down>'
  18765. but also adjust the previous clocked item in the clock history.
  18766. Everywhere else, drag the line at point down."
  18767. (interactive "P")
  18768. (cond
  18769. ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
  18770. ((org-at-table-p) (call-interactively 'org-table-insert-row))
  18771. ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
  18772. (call-interactively 'org-timestamp-down)))
  18773. (t (call-interactively 'org-drag-line-forward))))
  18774. (defsubst org-hidden-tree-error ()
  18775. (user-error
  18776. "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
  18777. (defun org-metaleft (&optional _arg)
  18778. "Promote heading, list item at point or move table column left.
  18779. Calls `org-do-promote', `org-outdent-item' or `org-table-move-column',
  18780. depending on context. With no specific context, calls the Emacs
  18781. default `backward-word'. See the individual commands for more
  18782. information.
  18783. This function runs the hook `org-metaleft-hook' as a first step,
  18784. and returns at first non-nil value."
  18785. (interactive "P")
  18786. (cond
  18787. ((run-hook-with-args-until-success 'org-metaleft-hook))
  18788. ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
  18789. ((org-with-limited-levels
  18790. (or (org-at-heading-p)
  18791. (and (org-region-active-p)
  18792. (save-excursion
  18793. (goto-char (region-beginning))
  18794. (org-at-heading-p)))))
  18795. (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
  18796. (call-interactively 'org-do-promote))
  18797. ;; At an inline task.
  18798. ((org-at-heading-p)
  18799. (call-interactively 'org-inlinetask-promote))
  18800. ((or (org-at-item-p)
  18801. (and (org-region-active-p)
  18802. (save-excursion
  18803. (goto-char (region-beginning))
  18804. (org-at-item-p))))
  18805. (when (org-check-for-hidden 'items) (org-hidden-tree-error))
  18806. (call-interactively 'org-outdent-item))
  18807. (t (call-interactively 'backward-word))))
  18808. (defun org-metaright (&optional _arg)
  18809. "Demote heading, list item at point or move table column right.
  18810. In front of a drawer or a block keyword, indent it correctly.
  18811. Calls `org-do-demote', `org-indent-item', `org-table-move-column',
  18812. `org-indent-drawer' or `org-indent-block' depending on context.
  18813. With no specific context, calls the Emacs default `forward-word'.
  18814. See the individual commands for more information.
  18815. This function runs the hook `org-metaright-hook' as a first step,
  18816. and returns at first non-nil value."
  18817. (interactive "P")
  18818. (cond
  18819. ((run-hook-with-args-until-success 'org-metaright-hook))
  18820. ((org-at-table-p) (call-interactively 'org-table-move-column))
  18821. ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
  18822. ((org-at-block-p) (call-interactively 'org-indent-block))
  18823. ((org-with-limited-levels
  18824. (or (org-at-heading-p)
  18825. (and (org-region-active-p)
  18826. (save-excursion
  18827. (goto-char (region-beginning))
  18828. (org-at-heading-p)))))
  18829. (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
  18830. (call-interactively 'org-do-demote))
  18831. ;; At an inline task.
  18832. ((org-at-heading-p)
  18833. (call-interactively 'org-inlinetask-demote))
  18834. ((or (org-at-item-p)
  18835. (and (org-region-active-p)
  18836. (save-excursion
  18837. (goto-char (region-beginning))
  18838. (org-at-item-p))))
  18839. (when (org-check-for-hidden 'items) (org-hidden-tree-error))
  18840. (call-interactively 'org-indent-item))
  18841. (t (call-interactively 'forward-word))))
  18842. (defun org-check-for-hidden (what)
  18843. "Check if there are hidden headlines/items in the current visual line.
  18844. WHAT can be either `headlines' or `items'. If the current line is
  18845. an outline or item heading and it has a folded subtree below it,
  18846. this function returns t, nil otherwise."
  18847. (let ((re (cond
  18848. ((eq what 'headlines) org-outline-regexp-bol)
  18849. ((eq what 'items) (org-item-beginning-re))
  18850. (t (error "This should not happen"))))
  18851. beg end)
  18852. (save-excursion
  18853. (catch 'exit
  18854. (unless (org-region-active-p)
  18855. (setq beg (point-at-bol))
  18856. (beginning-of-line 2)
  18857. (while (and (not (eobp)) ;; this is like `next-line'
  18858. (get-char-property (1- (point)) 'invisible))
  18859. (beginning-of-line 2))
  18860. (setq end (point))
  18861. (goto-char beg)
  18862. (goto-char (point-at-eol))
  18863. (setq end (max end (point)))
  18864. (while (re-search-forward re end t)
  18865. (when (get-char-property (match-beginning 0) 'invisible)
  18866. (throw 'exit t))))
  18867. nil))))
  18868. (defun org-metaup (&optional _arg)
  18869. "Move subtree up or move table row up.
  18870. Calls `org-move-subtree-up' or `org-table-move-row' or
  18871. `org-move-item-up', depending on context. See the individual commands
  18872. for more information."
  18873. (interactive "P")
  18874. (cond
  18875. ((run-hook-with-args-until-success 'org-metaup-hook))
  18876. ((org-region-active-p)
  18877. (let* ((a (min (region-beginning) (region-end)))
  18878. (b (1- (max (region-beginning) (region-end))))
  18879. (c (save-excursion (goto-char a)
  18880. (move-beginning-of-line 0)))
  18881. (d (save-excursion (goto-char a)
  18882. (move-end-of-line 0) (point))))
  18883. (transpose-regions a b c d)
  18884. (goto-char c)))
  18885. ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
  18886. ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
  18887. ((org-at-item-p) (call-interactively 'org-move-item-up))
  18888. (t (org-drag-element-backward))))
  18889. (defun org-metadown (&optional _arg)
  18890. "Move subtree down or move table row down.
  18891. Calls `org-move-subtree-down' or `org-table-move-row' or
  18892. `org-move-item-down', depending on context. See the individual
  18893. commands for more information."
  18894. (interactive "P")
  18895. (cond
  18896. ((run-hook-with-args-until-success 'org-metadown-hook))
  18897. ((org-region-active-p)
  18898. (let* ((a (min (region-beginning) (region-end)))
  18899. (b (max (region-beginning) (region-end)))
  18900. (c (save-excursion (goto-char b)
  18901. (move-beginning-of-line 1)))
  18902. (d (save-excursion (goto-char b)
  18903. (move-end-of-line 1) (1+ (point)))))
  18904. (transpose-regions a b c d)
  18905. (goto-char d)))
  18906. ((org-at-table-p) (call-interactively 'org-table-move-row))
  18907. ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
  18908. ((org-at-item-p) (call-interactively 'org-move-item-down))
  18909. (t (org-drag-element-forward))))
  18910. (defun org-shiftup (&optional arg)
  18911. "Increase item in timestamp or increase priority of current headline.
  18912. Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
  18913. depending on context. See the individual commands for more information."
  18914. (interactive "P")
  18915. (cond
  18916. ((run-hook-with-args-until-success 'org-shiftup-hook))
  18917. ((and org-support-shift-select (org-region-active-p))
  18918. (org-call-for-shift-select 'previous-line))
  18919. ((org-at-timestamp-p t)
  18920. (call-interactively (if org-edit-timestamp-down-means-later
  18921. 'org-timestamp-down 'org-timestamp-up)))
  18922. ((and (not (eq org-support-shift-select 'always))
  18923. org-enable-priority-commands
  18924. (org-at-heading-p))
  18925. (call-interactively 'org-priority-up))
  18926. ((and (not org-support-shift-select) (org-at-item-p))
  18927. (call-interactively 'org-previous-item))
  18928. ((org-clocktable-try-shift 'up arg))
  18929. ((run-hook-with-args-until-success 'org-shiftup-final-hook))
  18930. (org-support-shift-select
  18931. (org-call-for-shift-select 'previous-line))
  18932. (t (org-shiftselect-error))))
  18933. (defun org-shiftdown (&optional arg)
  18934. "Decrease item in timestamp or decrease priority of current headline.
  18935. Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
  18936. depending on context. See the individual commands for more information."
  18937. (interactive "P")
  18938. (cond
  18939. ((run-hook-with-args-until-success 'org-shiftdown-hook))
  18940. ((and org-support-shift-select (org-region-active-p))
  18941. (org-call-for-shift-select 'next-line))
  18942. ((org-at-timestamp-p t)
  18943. (call-interactively (if org-edit-timestamp-down-means-later
  18944. 'org-timestamp-up 'org-timestamp-down)))
  18945. ((and (not (eq org-support-shift-select 'always))
  18946. org-enable-priority-commands
  18947. (org-at-heading-p))
  18948. (call-interactively 'org-priority-down))
  18949. ((and (not org-support-shift-select) (org-at-item-p))
  18950. (call-interactively 'org-next-item))
  18951. ((org-clocktable-try-shift 'down arg))
  18952. ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
  18953. (org-support-shift-select
  18954. (org-call-for-shift-select 'next-line))
  18955. (t (org-shiftselect-error))))
  18956. (defun org-shiftright (&optional arg)
  18957. "Cycle the thing at point or in the current line, depending on context.
  18958. Depending on context, this does one of the following:
  18959. - switch a timestamp at point one day into the future
  18960. - on a headline, switch to the next TODO keyword.
  18961. - on an item, switch entire list to the next bullet type
  18962. - on a property line, switch to the next allowed value
  18963. - on a clocktable definition line, move time block into the future"
  18964. (interactive "P")
  18965. (cond
  18966. ((run-hook-with-args-until-success 'org-shiftright-hook))
  18967. ((and org-support-shift-select (org-region-active-p))
  18968. (org-call-for-shift-select 'forward-char))
  18969. ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
  18970. ((and (not (eq org-support-shift-select 'always))
  18971. (org-at-heading-p))
  18972. (let ((org-inhibit-logging
  18973. (not org-treat-S-cursor-todo-selection-as-state-change))
  18974. (org-inhibit-blocking
  18975. (not org-treat-S-cursor-todo-selection-as-state-change)))
  18976. (org-call-with-arg 'org-todo 'right)))
  18977. ((or (and org-support-shift-select
  18978. (not (eq org-support-shift-select 'always))
  18979. (org-at-item-bullet-p))
  18980. (and (not org-support-shift-select) (org-at-item-p)))
  18981. (org-call-with-arg 'org-cycle-list-bullet nil))
  18982. ((and (not (eq org-support-shift-select 'always))
  18983. (org-at-property-p))
  18984. (call-interactively 'org-property-next-allowed-value))
  18985. ((org-clocktable-try-shift 'right arg))
  18986. ((run-hook-with-args-until-success 'org-shiftright-final-hook))
  18987. (org-support-shift-select
  18988. (org-call-for-shift-select 'forward-char))
  18989. (t (org-shiftselect-error))))
  18990. (defun org-shiftleft (&optional arg)
  18991. "Cycle the thing at point or in the current line, depending on context.
  18992. Depending on context, this does one of the following:
  18993. - switch a timestamp at point one day into the past
  18994. - on a headline, switch to the previous TODO keyword.
  18995. - on an item, switch entire list to the previous bullet type
  18996. - on a property line, switch to the previous allowed value
  18997. - on a clocktable definition line, move time block into the past"
  18998. (interactive "P")
  18999. (cond
  19000. ((run-hook-with-args-until-success 'org-shiftleft-hook))
  19001. ((and org-support-shift-select (org-region-active-p))
  19002. (org-call-for-shift-select 'backward-char))
  19003. ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
  19004. ((and (not (eq org-support-shift-select 'always))
  19005. (org-at-heading-p))
  19006. (let ((org-inhibit-logging
  19007. (not org-treat-S-cursor-todo-selection-as-state-change))
  19008. (org-inhibit-blocking
  19009. (not org-treat-S-cursor-todo-selection-as-state-change)))
  19010. (org-call-with-arg 'org-todo 'left)))
  19011. ((or (and org-support-shift-select
  19012. (not (eq org-support-shift-select 'always))
  19013. (org-at-item-bullet-p))
  19014. (and (not org-support-shift-select) (org-at-item-p)))
  19015. (org-call-with-arg 'org-cycle-list-bullet 'previous))
  19016. ((and (not (eq org-support-shift-select 'always))
  19017. (org-at-property-p))
  19018. (call-interactively 'org-property-previous-allowed-value))
  19019. ((org-clocktable-try-shift 'left arg))
  19020. ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
  19021. (org-support-shift-select
  19022. (org-call-for-shift-select 'backward-char))
  19023. (t (org-shiftselect-error))))
  19024. (defun org-shiftcontrolright ()
  19025. "Switch to next TODO set."
  19026. (interactive)
  19027. (cond
  19028. ((and org-support-shift-select (org-region-active-p))
  19029. (org-call-for-shift-select 'forward-word))
  19030. ((and (not (eq org-support-shift-select 'always))
  19031. (org-at-heading-p))
  19032. (org-call-with-arg 'org-todo 'nextset))
  19033. (org-support-shift-select
  19034. (org-call-for-shift-select 'forward-word))
  19035. (t (org-shiftselect-error))))
  19036. (defun org-shiftcontrolleft ()
  19037. "Switch to previous TODO set."
  19038. (interactive)
  19039. (cond
  19040. ((and org-support-shift-select (org-region-active-p))
  19041. (org-call-for-shift-select 'backward-word))
  19042. ((and (not (eq org-support-shift-select 'always))
  19043. (org-at-heading-p))
  19044. (org-call-with-arg 'org-todo 'previousset))
  19045. (org-support-shift-select
  19046. (org-call-for-shift-select 'backward-word))
  19047. (t (org-shiftselect-error))))
  19048. (defun org-shiftcontrolup (&optional n)
  19049. "Change timestamps synchronously up in CLOCK log lines.
  19050. Optional argument N tells to change by that many units."
  19051. (interactive "P")
  19052. (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
  19053. (let (org-support-shift-select)
  19054. (org-clock-timestamps-up n))
  19055. (user-error "Not at a clock log")))
  19056. (defun org-shiftcontroldown (&optional n)
  19057. "Change timestamps synchronously down in CLOCK log lines.
  19058. Optional argument N tells to change by that many units."
  19059. (interactive "P")
  19060. (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
  19061. (let (org-support-shift-select)
  19062. (org-clock-timestamps-down n))
  19063. (user-error "Not at a clock log")))
  19064. (defun org-increase-number-at-point (&optional inc)
  19065. "Increment the number at point.
  19066. With an optional prefix numeric argument INC, increment using
  19067. this numeric value."
  19068. (interactive "p")
  19069. (if (not (number-at-point))
  19070. (user-error "Not on a number")
  19071. (unless inc (setq inc 1))
  19072. (let ((pos (point))
  19073. (beg (skip-chars-backward "-+^/*0-9eE."))
  19074. (end (skip-chars-forward "-+^/*0-9eE^.")) nap)
  19075. (setq nap (buffer-substring-no-properties
  19076. (+ pos beg) (+ pos beg end)))
  19077. (delete-region (+ pos beg) (+ pos beg end))
  19078. (insert (calc-eval (concat (number-to-string inc) "+" nap))))
  19079. (when (org-at-table-p)
  19080. (org-table-align)
  19081. (org-table-end-of-field 1))))
  19082. (defun org-decrease-number-at-point (&optional inc)
  19083. "Decrement the number at point.
  19084. With an optional prefix numeric argument INC, decrement using
  19085. this numeric value."
  19086. (interactive "p")
  19087. (org-increase-number-at-point (- (or inc 1))))
  19088. (defun org-ctrl-c-ret ()
  19089. "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
  19090. (interactive)
  19091. (cond
  19092. ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
  19093. (t (call-interactively 'org-insert-heading))))
  19094. (defun org-find-visible ()
  19095. (let ((s (point)))
  19096. (while (and (not (= (point-max) (setq s (next-overlay-change s))))
  19097. (get-char-property s 'invisible)))
  19098. s))
  19099. (defun org-find-invisible ()
  19100. (let ((s (point)))
  19101. (while (and (not (= (point-max) (setq s (next-overlay-change s))))
  19102. (not (get-char-property s 'invisible))))
  19103. s))
  19104. (defun org-copy-visible (beg end)
  19105. "Copy the visible parts of the region."
  19106. (interactive "r")
  19107. (let (snippets s)
  19108. (save-excursion
  19109. (save-restriction
  19110. (narrow-to-region beg end)
  19111. (setq s (goto-char (point-min)))
  19112. (while (not (= (point) (point-max)))
  19113. (goto-char (org-find-invisible))
  19114. (push (buffer-substring s (point)) snippets)
  19115. (setq s (goto-char (org-find-visible))))))
  19116. (kill-new (apply 'concat (nreverse snippets)))))
  19117. (defun org-copy-special ()
  19118. "Copy region in table or copy current subtree.
  19119. Calls `org-table-copy-region' or `org-copy-subtree', depending on
  19120. context. See the individual commands for more information."
  19121. (interactive)
  19122. (call-interactively
  19123. (if (org-at-table-p) #'org-table-copy-region #'org-copy-subtree)))
  19124. (defun org-cut-special ()
  19125. "Cut region in table or cut current subtree.
  19126. Calls `org-table-cut-region' or `org-cut-subtree', depending on
  19127. context. See the individual commands for more information."
  19128. (interactive)
  19129. (call-interactively
  19130. (if (org-at-table-p) #'org-table-cut-region #'org-cut-subtree)))
  19131. (defun org-paste-special (arg)
  19132. "Paste rectangular region into table, or past subtree relative to level.
  19133. Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
  19134. See the individual commands for more information."
  19135. (interactive "P")
  19136. (if (org-at-table-p)
  19137. (org-table-paste-rectangle)
  19138. (org-paste-subtree arg)))
  19139. (defun org-edit-special (&optional arg)
  19140. "Call a special editor for the element at point.
  19141. When at a table, call the formula editor with `org-table-edit-formulas'.
  19142. When in a source code block, call `org-edit-src-code'.
  19143. When in a fixed-width region, call `org-edit-fixed-width-region'.
  19144. When in an export block, call `org-edit-export-block'.
  19145. When at an #+INCLUDE keyword, visit the included file.
  19146. When at a footnote reference, call `org-edit-footnote-reference'
  19147. On a link, call `ffap' to visit the link at point.
  19148. Otherwise, return a user error."
  19149. (interactive "P")
  19150. (let ((element (org-element-at-point)))
  19151. (barf-if-buffer-read-only)
  19152. (pcase (org-element-type element)
  19153. (`src-block
  19154. (if (not arg) (org-edit-src-code)
  19155. (let* ((info (org-babel-get-src-block-info))
  19156. (lang (nth 0 info))
  19157. (params (nth 2 info))
  19158. (session (cdr (assq :session params))))
  19159. (if (not session) (org-edit-src-code)
  19160. ;; At a src-block with a session and function called with
  19161. ;; an ARG: switch to the buffer related to the inferior
  19162. ;; process.
  19163. (switch-to-buffer
  19164. (funcall (intern (concat "org-babel-prep-session:" lang))
  19165. session params))))))
  19166. (`keyword
  19167. (if (member (org-element-property :key element) '("INCLUDE" "SETUPFILE"))
  19168. (org-open-link-from-string
  19169. (format "[[%s]]"
  19170. (expand-file-name
  19171. (let ((value (org-element-property :value element)))
  19172. (cond ((not (org-string-nw-p value))
  19173. (user-error "No file to edit"))
  19174. ((string-match "\\`\"\\(.*?\\)\"" value)
  19175. (match-string 1 value))
  19176. ((string-match "\\`[^ \t\"]\\S-*" value)
  19177. (match-string 0 value))
  19178. (t (user-error "No valid file specified")))))))
  19179. (user-error "No special environment to edit here")))
  19180. (`table
  19181. (if (eq (org-element-property :type element) 'table.el)
  19182. (org-edit-table.el)
  19183. (call-interactively 'org-table-edit-formulas)))
  19184. ;; Only Org tables contain `table-row' type elements.
  19185. (`table-row (call-interactively 'org-table-edit-formulas))
  19186. (`example-block (org-edit-src-code))
  19187. (`export-block (org-edit-export-block))
  19188. (`fixed-width (org-edit-fixed-width-region))
  19189. (_
  19190. ;; No notable element at point. Though, we may be at a link or
  19191. ;; a footnote reference, which are objects. Thus, scan deeper.
  19192. (let ((context (org-element-context element)))
  19193. (pcase (org-element-type context)
  19194. (`footnote-reference (org-edit-footnote-reference))
  19195. (`inline-src-block (org-edit-inline-src-code))
  19196. (`link (call-interactively #'ffap))
  19197. (_ (user-error "No special environment to edit here"))))))))
  19198. (defvar org-table-coordinate-overlays) ; defined in org-table.el
  19199. (defun org-ctrl-c-ctrl-c (&optional arg)
  19200. "Set tags in headline, or update according to changed information at point.
  19201. This command does many different things, depending on context:
  19202. - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
  19203. this is what we do.
  19204. - If the cursor is on a statistics cookie, update it.
  19205. - If the cursor is in a headline, prompt for tags and insert them
  19206. into the current line, aligned to `org-tags-column'. When called
  19207. with prefix arg, realign all tags in the current buffer.
  19208. - If the cursor is in one of the special #+KEYWORD lines, this
  19209. triggers scanning the buffer for these lines and updating the
  19210. information.
  19211. - If the cursor is inside a table, realign the table. This command
  19212. works even if the automatic table editor has been turned off.
  19213. - If the cursor is on a #+TBLFM line, re-apply the formulas to
  19214. the entire table.
  19215. - If the cursor is at a footnote reference or definition, jump to
  19216. the corresponding definition or references, respectively.
  19217. - If the cursor is a the beginning of a dynamic block, update it.
  19218. - If the current buffer is a capture buffer, close note and file it.
  19219. - If the cursor is on a <<<target>>>, update radio targets and
  19220. corresponding links in this buffer.
  19221. - If the cursor is on a numbered item in a plain list, renumber the
  19222. ordered list.
  19223. - If the cursor is on a checkbox, toggle it.
  19224. - If the cursor is on a code block, evaluate it. The variable
  19225. `org-confirm-babel-evaluate' can be used to control prompting
  19226. before code block evaluation, by default every code block
  19227. evaluation requires confirmation. Code block evaluation can be
  19228. inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
  19229. (interactive "P")
  19230. (cond
  19231. ((or (bound-and-true-p org-clock-overlays) org-occur-highlights)
  19232. (when (boundp 'org-clock-overlays) (org-clock-remove-overlays))
  19233. (org-remove-occur-highlights)
  19234. (message "Temporary highlights/overlays removed from current buffer"))
  19235. ((and (local-variable-p 'org-finish-function)
  19236. (fboundp org-finish-function))
  19237. (funcall org-finish-function))
  19238. ((org-babel-hash-at-point))
  19239. ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
  19240. ((save-excursion (beginning-of-line) (looking-at-p "[ \t]*$"))
  19241. (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
  19242. (user-error
  19243. (substitute-command-keys
  19244. "`\\[org-ctrl-c-ctrl-c]' can do nothing useful here"))))
  19245. (t
  19246. (let* ((context
  19247. (org-element-lineage
  19248. (org-element-context)
  19249. ;; Limit to supported contexts.
  19250. '(babel-call clock dynamic-block footnote-definition
  19251. footnote-reference inline-babel-call inline-src-block
  19252. inlinetask item keyword node-property paragraph
  19253. plain-list property-drawer radio-target src-block
  19254. statistics-cookie table table-cell table-row
  19255. timestamp)
  19256. t))
  19257. (type (org-element-type context)))
  19258. ;; For convenience: at the first line of a paragraph on the same
  19259. ;; line as an item, apply function on that item instead.
  19260. (when (eq type 'paragraph)
  19261. (let ((parent (org-element-property :parent context)))
  19262. (when (and (eq (org-element-type parent) 'item)
  19263. (= (line-beginning-position)
  19264. (org-element-property :begin parent)))
  19265. (setq context parent)
  19266. (setq type 'item))))
  19267. ;; Act according to type of element or object at point.
  19268. (pcase type
  19269. ((or `babel-call `inline-babel-call)
  19270. (let ((info (org-babel-lob-get-info context)))
  19271. (when info (org-babel-execute-src-block nil info))))
  19272. (`clock (org-clock-update-time-maybe))
  19273. (`dynamic-block
  19274. (save-excursion
  19275. (goto-char (org-element-property :post-affiliated context))
  19276. (org-update-dblock)))
  19277. (`footnote-definition
  19278. (goto-char (org-element-property :post-affiliated context))
  19279. (call-interactively 'org-footnote-action))
  19280. (`footnote-reference (call-interactively #'org-footnote-action))
  19281. ((or `headline `inlinetask)
  19282. (save-excursion (goto-char (org-element-property :begin context))
  19283. (call-interactively #'org-set-tags)))
  19284. ((or `inline-src-block `src-block)
  19285. (unless org-babel-no-eval-on-ctrl-c-ctrl-c
  19286. (org-babel-eval-wipe-error-buffer)
  19287. (org-babel-execute-src-block
  19288. current-prefix-arg (org-babel-get-src-block-info nil context))))
  19289. (`item
  19290. ;; At an item: `C-u C-u' sets checkbox to "[-]"
  19291. ;; unconditionally, whereas `C-u' will toggle its presence.
  19292. ;; Without a universal argument, if the item has a checkbox,
  19293. ;; toggle it. Otherwise repair the list.
  19294. (let* ((box (org-element-property :checkbox context))
  19295. (struct (org-element-property :structure context))
  19296. (old-struct (copy-tree struct))
  19297. (parents (org-list-parents-alist struct))
  19298. (prevs (org-list-prevs-alist struct))
  19299. (orderedp (org-not-nil (org-entry-get nil "ORDERED"))))
  19300. (org-list-set-checkbox
  19301. (org-element-property :begin context) struct
  19302. (cond ((equal arg '(16)) "[-]")
  19303. ((and (not box) (equal arg '(4))) "[ ]")
  19304. ((or (not box) (equal arg '(4))) nil)
  19305. ((eq box 'on) "[ ]")
  19306. (t "[X]")))
  19307. ;; Mimic `org-list-write-struct' but with grabbing a return
  19308. ;; value from `org-list-struct-fix-box'.
  19309. (org-list-struct-fix-ind struct parents 2)
  19310. (org-list-struct-fix-item-end struct)
  19311. (org-list-struct-fix-bul struct prevs)
  19312. (org-list-struct-fix-ind struct parents)
  19313. (let ((block-item
  19314. (org-list-struct-fix-box struct parents prevs orderedp)))
  19315. (if (and box (equal struct old-struct))
  19316. (if (equal arg '(16))
  19317. (message "Checkboxes already reset")
  19318. (user-error "Cannot toggle this checkbox: %s"
  19319. (if (eq box 'on)
  19320. "all subitems checked"
  19321. "unchecked subitems")))
  19322. (org-list-struct-apply-struct struct old-struct)
  19323. (org-update-checkbox-count-maybe))
  19324. (when block-item
  19325. (message "Checkboxes were removed due to empty box at line %d"
  19326. (org-current-line block-item))))))
  19327. (`keyword
  19328. (let ((org-inhibit-startup-visibility-stuff t)
  19329. (org-startup-align-all-tables nil))
  19330. (when (boundp 'org-table-coordinate-overlays)
  19331. (mapc #'delete-overlay org-table-coordinate-overlays)
  19332. (setq org-table-coordinate-overlays nil))
  19333. (org-save-outline-visibility 'use-markers (org-mode-restart)))
  19334. (message "Local setup has been refreshed"))
  19335. (`plain-list
  19336. ;; At a plain list, with a double C-u argument, set
  19337. ;; checkboxes of each item to "[-]", whereas a single one
  19338. ;; will toggle their presence according to the state of the
  19339. ;; first item in the list. Without an argument, repair the
  19340. ;; list.
  19341. (let* ((begin (org-element-property :contents-begin context))
  19342. (beginm (move-marker (make-marker) begin))
  19343. (struct (org-element-property :structure context))
  19344. (old-struct (copy-tree struct))
  19345. (first-box (save-excursion
  19346. (goto-char begin)
  19347. (looking-at org-list-full-item-re)
  19348. (match-string-no-properties 3)))
  19349. (new-box (cond ((equal arg '(16)) "[-]")
  19350. ((equal arg '(4)) (unless first-box "[ ]"))
  19351. ((equal first-box "[X]") "[ ]")
  19352. (t "[X]"))))
  19353. (cond
  19354. (arg
  19355. (dolist (pos
  19356. (org-list-get-all-items
  19357. begin struct (org-list-prevs-alist struct)))
  19358. (org-list-set-checkbox pos struct new-box)))
  19359. ((and first-box (eq (point) begin))
  19360. ;; For convenience, when point is at bol on the first
  19361. ;; item of the list and no argument is provided, simply
  19362. ;; toggle checkbox of that item, if any.
  19363. (org-list-set-checkbox begin struct new-box)))
  19364. (org-list-write-struct
  19365. struct (org-list-parents-alist struct) old-struct)
  19366. (org-update-checkbox-count-maybe)
  19367. (save-excursion (goto-char beginm) (org-list-send-list 'maybe))))
  19368. ((or `property-drawer `node-property)
  19369. (call-interactively #'org-property-action))
  19370. (`radio-target
  19371. (call-interactively #'org-update-radio-target-regexp))
  19372. (`statistics-cookie
  19373. (call-interactively #'org-update-statistics-cookies))
  19374. ((or `table `table-cell `table-row)
  19375. ;; At a table, recalculate every field and align it. Also
  19376. ;; send the table if necessary. If the table has
  19377. ;; a `table.el' type, just give up. At a table row or cell,
  19378. ;; maybe recalculate line but always align table.
  19379. (if (eq (org-element-property :type context) 'table.el)
  19380. (message "%s" (substitute-command-keys "\\<org-mode-map>\
  19381. Use `\\[org-edit-special]' to edit table.el tables"))
  19382. (let ((org-enable-table-editor t))
  19383. (if (or (eq type 'table)
  19384. ;; Check if point is at a TBLFM line.
  19385. (and (eq type 'table-row)
  19386. (= (point) (org-element-property :end context))))
  19387. (save-excursion
  19388. (if (org-at-TBLFM-p)
  19389. (progn (require 'org-table)
  19390. (org-table-calc-current-TBLFM))
  19391. (goto-char (org-element-property :contents-begin context))
  19392. (org-call-with-arg 'org-table-recalculate (or arg t))
  19393. (orgtbl-send-table 'maybe)))
  19394. (org-table-maybe-eval-formula)
  19395. (cond (arg (call-interactively #'org-table-recalculate))
  19396. ((org-table-maybe-recalculate-line))
  19397. (t (org-table-align)))))))
  19398. (`timestamp (org-timestamp-change 0 'day))
  19399. ((and `nil (guard (org-at-heading-p)))
  19400. ;; When point is on an unsupported object type, we can miss
  19401. ;; the fact that it also is at a heading. Handle it here.
  19402. (call-interactively #'org-set-tags))
  19403. ((guard
  19404. (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)))
  19405. (_
  19406. (user-error
  19407. (substitute-command-keys
  19408. "`\\[org-ctrl-c-ctrl-c]' can do nothing useful here"))))))))
  19409. (defun org-mode-restart ()
  19410. (interactive)
  19411. (let ((indent-status (bound-and-true-p org-indent-mode)))
  19412. (funcall major-mode)
  19413. (hack-local-variables)
  19414. (when (and indent-status (not (bound-and-true-p org-indent-mode)))
  19415. (org-indent-mode -1)))
  19416. (message "%s restarted" major-mode))
  19417. (defun org-kill-note-or-show-branches ()
  19418. "Abort storing current note, or call `outline-show-branches'."
  19419. (interactive)
  19420. (if (not org-finish-function)
  19421. (progn
  19422. (outline-hide-subtree)
  19423. (call-interactively 'outline-show-branches))
  19424. (let ((org-note-abort t))
  19425. (funcall org-finish-function))))
  19426. (defun org-delete-indentation (&optional arg)
  19427. "Join current line to previous and fix whitespace at join.
  19428. If previous line is a headline add to headline title. Otherwise
  19429. the function calls `delete-indentation'.
  19430. With a non-nil optional argument, join it to the following one."
  19431. (interactive "*P")
  19432. (if (save-excursion
  19433. (beginning-of-line (if arg 1 0))
  19434. (let ((case-fold-search nil))
  19435. (looking-at org-complex-heading-regexp)))
  19436. ;; At headline.
  19437. (let ((tags-column (when (match-beginning 5)
  19438. (save-excursion (goto-char (match-beginning 5))
  19439. (current-column))))
  19440. (string (concat " " (progn (when arg (forward-line 1))
  19441. (org-trim (delete-and-extract-region
  19442. (line-beginning-position)
  19443. (line-end-position)))))))
  19444. (unless (bobp) (delete-region (point) (1- (point))))
  19445. (goto-char (or (match-end 4)
  19446. (match-beginning 5)
  19447. (match-end 0)))
  19448. (skip-chars-backward " \t")
  19449. (save-excursion (insert string))
  19450. ;; Adjust alignment of tags.
  19451. (cond
  19452. ((not tags-column)) ;no tags
  19453. (org-auto-align-tags (org-set-tags nil t))
  19454. (t (org--align-tags-here tags-column)))) ;preserve tags column
  19455. (delete-indentation arg)))
  19456. (defun org-open-line (n)
  19457. "Insert a new row in tables, call `open-line' elsewhere.
  19458. If `org-special-ctrl-o' is nil, just call `open-line' everywhere.
  19459. As a special case, when a document starts with a table, allow to
  19460. call `open-line' on the very first character."
  19461. (interactive "*p")
  19462. (if (and org-special-ctrl-o (/= (point) 1) (org-at-table-p))
  19463. (org-table-insert-row)
  19464. (open-line n)))
  19465. (defun org-return (&optional indent)
  19466. "Goto next table row or insert a newline.
  19467. Calls `org-table-next-row' or `newline', depending on context.
  19468. When optional INDENT argument is non-nil, call
  19469. `newline-and-indent' instead of `newline'.
  19470. When `org-return-follows-link' is non-nil and point is on
  19471. a timestamp or a link, call `org-open-at-point'. However, it
  19472. will not happen if point is in a table or on a \"dead\"
  19473. object (e.g., within a comment). In these case, you need to use
  19474. `org-open-at-point' directly."
  19475. (interactive)
  19476. (let ((context (if org-return-follows-link (org-element-context)
  19477. (org-element-at-point))))
  19478. (cond
  19479. ;; In a table, call `org-table-next-row'.
  19480. ((or (and (eq (org-element-type context) 'table)
  19481. (>= (point) (org-element-property :contents-begin context))
  19482. (< (point) (org-element-property :contents-end context)))
  19483. (org-element-lineage context '(table-row table-cell) t))
  19484. (org-table-justify-field-maybe)
  19485. (call-interactively #'org-table-next-row))
  19486. ;; On a link or a timestamp, call `org-open-at-point' if
  19487. ;; `org-return-follows-link' allows it. Tolerate fuzzy
  19488. ;; locations, e.g., in a comment, as `org-open-at-point'.
  19489. ((and org-return-follows-link
  19490. (or (org-in-regexp org-ts-regexp-both nil t)
  19491. (org-in-regexp org-tsr-regexp-both nil t)
  19492. (org-in-regexp org-any-link-re nil t)))
  19493. (call-interactively #'org-open-at-point))
  19494. ;; Insert newline in heading, but preserve tags.
  19495. ((and (not (bolp))
  19496. (save-excursion (beginning-of-line)
  19497. (let ((case-fold-search nil))
  19498. (looking-at org-complex-heading-regexp))))
  19499. ;; At headline. Split line. However, if point is on keyword,
  19500. ;; priority cookie or tags, do not break any of them: add
  19501. ;; a newline after the headline instead.
  19502. (let ((tags-column (and (match-beginning 5)
  19503. (save-excursion (goto-char (match-beginning 5))
  19504. (current-column))))
  19505. (string
  19506. (when (and (match-end 4) (org-point-in-group (point) 4))
  19507. (delete-and-extract-region (point) (match-end 4)))))
  19508. ;; Adjust tag alignment.
  19509. (cond
  19510. ((not (and tags-column string)))
  19511. (org-auto-align-tags (org-set-tags nil t))
  19512. (t (org--align-tags-here tags-column))) ;preserve tags column
  19513. (end-of-line)
  19514. (org-show-entry)
  19515. (if indent (newline-and-indent) (newline))
  19516. (when string (save-excursion (insert (org-trim string))))))
  19517. ;; In a list, make sure indenting keeps trailing text within.
  19518. ((and indent
  19519. (not (eolp))
  19520. (org-element-lineage context '(item)))
  19521. (let ((trailing-data
  19522. (delete-and-extract-region (point) (line-end-position))))
  19523. (newline-and-indent)
  19524. (save-excursion (insert trailing-data))))
  19525. (t (if indent (newline-and-indent) (newline))))))
  19526. (defun org-return-indent ()
  19527. "Goto next table row or insert a newline and indent.
  19528. Calls `org-table-next-row' or `newline-and-indent', depending on
  19529. context. See the individual commands for more information."
  19530. (interactive)
  19531. (org-return t))
  19532. (defun org-ctrl-c-star ()
  19533. "Compute table, or change heading status of lines.
  19534. Calls `org-table-recalculate' or `org-toggle-heading',
  19535. depending on context."
  19536. (interactive)
  19537. (cond
  19538. ((org-at-table-p)
  19539. (call-interactively 'org-table-recalculate))
  19540. (t
  19541. ;; Convert all lines in region to list items
  19542. (call-interactively 'org-toggle-heading))))
  19543. (defun org-ctrl-c-minus ()
  19544. "Insert separator line in table or modify bullet status of line.
  19545. Also turns a plain line or a region of lines into list items.
  19546. Calls `org-table-insert-hline', `org-toggle-item', or
  19547. `org-cycle-list-bullet', depending on context."
  19548. (interactive)
  19549. (cond
  19550. ((org-at-table-p)
  19551. (call-interactively 'org-table-insert-hline))
  19552. ((org-region-active-p)
  19553. (call-interactively 'org-toggle-item))
  19554. ((org-in-item-p)
  19555. (call-interactively 'org-cycle-list-bullet))
  19556. (t
  19557. (call-interactively 'org-toggle-item))))
  19558. (defun org-toggle-heading (&optional nstars)
  19559. "Convert headings to normal text, or items or text to headings.
  19560. If there is no active region, only convert the current line.
  19561. With a `\\[universal-argument]' prefix, convert the whole list at
  19562. point into heading.
  19563. In a region:
  19564. - If the first non blank line is a headline, remove the stars
  19565. from all headlines in the region.
  19566. - If it is a normal line, turn each and every normal line (i.e.,
  19567. not an heading or an item) in the region into headings. If you
  19568. want to convert only the first line of this region, use one
  19569. universal prefix argument.
  19570. - If it is a plain list item, turn all plain list items into headings.
  19571. When converting a line into a heading, the number of stars is chosen
  19572. such that the lines become children of the current entry. However,
  19573. when a numeric prefix argument is given, its value determines the
  19574. number of stars to add."
  19575. (interactive "P")
  19576. (let ((skip-blanks
  19577. (function
  19578. ;; Return beginning of first non-blank line, starting from
  19579. ;; line at POS.
  19580. (lambda (pos)
  19581. (save-excursion
  19582. (goto-char pos)
  19583. (while (org-at-comment-p) (forward-line))
  19584. (skip-chars-forward " \r\t\n")
  19585. (point-at-bol)))))
  19586. beg end toggled)
  19587. ;; Determine boundaries of changes. If a universal prefix has
  19588. ;; been given, put the list in a region. If region ends at a bol,
  19589. ;; do not consider the last line to be in the region.
  19590. (when (and current-prefix-arg (org-at-item-p))
  19591. (when (listp current-prefix-arg) (setq current-prefix-arg 1))
  19592. (org-mark-element))
  19593. (if (org-region-active-p)
  19594. (setq beg (funcall skip-blanks (region-beginning))
  19595. end (copy-marker (save-excursion
  19596. (goto-char (region-end))
  19597. (if (bolp) (point) (point-at-eol)))))
  19598. (setq beg (funcall skip-blanks (point-at-bol))
  19599. end (copy-marker (point-at-eol))))
  19600. ;; Ensure inline tasks don't count as headings.
  19601. (org-with-limited-levels
  19602. (save-excursion
  19603. (goto-char beg)
  19604. (cond
  19605. ;; Case 1. Started at an heading: de-star headings.
  19606. ((org-at-heading-p)
  19607. (while (< (point) end)
  19608. (when (org-at-heading-p t)
  19609. (looking-at org-outline-regexp) (replace-match "")
  19610. (setq toggled t))
  19611. (forward-line)))
  19612. ;; Case 2. Started at an item: change items into headlines.
  19613. ;; One star will be added by `org-list-to-subtree'.
  19614. ((org-at-item-p)
  19615. (while (< (point) end)
  19616. (when (org-at-item-p)
  19617. ;; Pay attention to cases when region ends before list.
  19618. (let* ((struct (org-list-struct))
  19619. (list-end
  19620. (min (org-list-get-bottom-point struct) (1+ end))))
  19621. (save-restriction
  19622. (narrow-to-region (point) list-end)
  19623. (insert (org-list-to-subtree (org-list-to-lisp t)) "\n")))
  19624. (setq toggled t))
  19625. (forward-line)))
  19626. ;; Case 3. Started at normal text: make every line an heading,
  19627. ;; skipping headlines and items.
  19628. (t (let* ((stars
  19629. (make-string
  19630. (if (numberp nstars) nstars (or (org-current-level) 0)) ?*))
  19631. (add-stars
  19632. (cond (nstars "") ; stars from prefix only
  19633. ((equal stars "") "*") ; before first heading
  19634. (org-odd-levels-only "**") ; inside heading, odd
  19635. (t "*"))) ; inside heading, oddeven
  19636. (rpl (concat stars add-stars " "))
  19637. (lend (when (listp nstars) (save-excursion (end-of-line) (point)))))
  19638. (while (< (point) (if (equal nstars '(4)) lend end))
  19639. (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
  19640. (looking-at "\\([ \t]*\\)\\(\\S-\\)"))
  19641. (replace-match (concat rpl (match-string 2))) (setq toggled t))
  19642. (forward-line)))))))
  19643. (unless toggled (message "Cannot toggle heading from here"))))
  19644. (defun org-meta-return (&optional arg)
  19645. "Insert a new heading or wrap a region in a table.
  19646. Calls `org-insert-heading', `org-insert-item' or
  19647. `org-table-wrap-region', depending on context. When called with
  19648. an argument, unconditionally call `org-insert-heading'."
  19649. (interactive "P")
  19650. (org-check-before-invisible-edit 'insert)
  19651. (or (run-hook-with-args-until-success 'org-metareturn-hook)
  19652. (call-interactively (cond (arg #'org-insert-heading)
  19653. ((org-at-table-p) #'org-table-wrap-region)
  19654. ((org-in-item-p) #'org-insert-item)
  19655. (t #'org-insert-heading)))))
  19656. ;;; Menu entries
  19657. (defsubst org-in-subtree-not-table-p ()
  19658. "Are we in a subtree and not in a table?"
  19659. (and (not (org-before-first-heading-p))
  19660. (not (org-at-table-p))))
  19661. ;; Define the Org mode menus
  19662. (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
  19663. '("Tbl"
  19664. ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
  19665. ["Next Field" org-cycle (org-at-table-p)]
  19666. ["Previous Field" org-shifttab (org-at-table-p)]
  19667. ["Next Row" org-return (org-at-table-p)]
  19668. "--"
  19669. ["Blank Field" org-table-blank-field (org-at-table-p)]
  19670. ["Edit Field" org-table-edit-field (org-at-table-p)]
  19671. ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
  19672. "--"
  19673. ("Column"
  19674. ["Move Column Left" org-metaleft (org-at-table-p)]
  19675. ["Move Column Right" org-metaright (org-at-table-p)]
  19676. ["Delete Column" org-shiftmetaleft (org-at-table-p)]
  19677. ["Insert Column" org-shiftmetaright (org-at-table-p)])
  19678. ("Row"
  19679. ["Move Row Up" org-metaup (org-at-table-p)]
  19680. ["Move Row Down" org-metadown (org-at-table-p)]
  19681. ["Delete Row" org-shiftmetaup (org-at-table-p)]
  19682. ["Insert Row" org-shiftmetadown (org-at-table-p)]
  19683. ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
  19684. "--"
  19685. ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
  19686. ("Rectangle"
  19687. ["Copy Rectangle" org-copy-special (org-at-table-p)]
  19688. ["Cut Rectangle" org-cut-special (org-at-table-p)]
  19689. ["Paste Rectangle" org-paste-special (org-at-table-p)]
  19690. ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
  19691. "--"
  19692. ("Calculate"
  19693. ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
  19694. ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
  19695. ["Edit Formulas" org-edit-special (org-at-table-p)]
  19696. "--"
  19697. ["Recalculate line" org-table-recalculate (org-at-table-p)]
  19698. ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
  19699. ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
  19700. "--"
  19701. ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
  19702. "--"
  19703. ["Sum Column/Rectangle" org-table-sum
  19704. (or (org-at-table-p) (org-region-active-p))]
  19705. ["Which Column?" org-table-current-column (org-at-table-p)])
  19706. ["Debug Formulas"
  19707. org-table-toggle-formula-debugger
  19708. :style toggle :selected (bound-and-true-p org-table-formula-debug)]
  19709. ["Show Col/Row Numbers"
  19710. org-table-toggle-coordinate-overlays
  19711. :style toggle
  19712. :selected (bound-and-true-p org-table-overlay-coordinates)]
  19713. "--"
  19714. ["Create" org-table-create (and (not (org-at-table-p))
  19715. org-enable-table-editor)]
  19716. ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
  19717. ["Import from File" org-table-import (not (org-at-table-p))]
  19718. ["Export to File" org-table-export (org-at-table-p)]
  19719. "--"
  19720. ["Create/Convert from/to table.el" org-table-create-with-table.el t]
  19721. "--"
  19722. ("Plot"
  19723. ["Ascii plot" orgtbl-ascii-plot :active (org-at-table-p) :keys "C-c \" a"]
  19724. ["Gnuplot" org-plot/gnuplot :active (org-at-table-p) :keys "C-c \" g"])))
  19725. (easy-menu-define org-org-menu org-mode-map "Org menu"
  19726. '("Org"
  19727. ("Show/Hide"
  19728. ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
  19729. ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
  19730. ["Sparse Tree..." org-sparse-tree t]
  19731. ["Reveal Context" org-reveal t]
  19732. ["Show All" outline-show-all t]
  19733. "--"
  19734. ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
  19735. "--"
  19736. ["New Heading" org-insert-heading t]
  19737. ("Navigate Headings"
  19738. ["Up" outline-up-heading t]
  19739. ["Next" outline-next-visible-heading t]
  19740. ["Previous" outline-previous-visible-heading t]
  19741. ["Next Same Level" outline-forward-same-level t]
  19742. ["Previous Same Level" outline-backward-same-level t]
  19743. "--"
  19744. ["Jump" org-goto t])
  19745. ("Edit Structure"
  19746. ["Refile Subtree" org-refile (org-in-subtree-not-table-p)]
  19747. "--"
  19748. ["Move Subtree Up" org-metaup (org-at-heading-p)]
  19749. ["Move Subtree Down" org-metadown (org-at-heading-p)]
  19750. "--"
  19751. ["Copy Subtree" org-copy-special (org-in-subtree-not-table-p)]
  19752. ["Cut Subtree" org-cut-special (org-in-subtree-not-table-p)]
  19753. ["Paste Subtree" org-paste-special (not (org-at-table-p))]
  19754. "--"
  19755. ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
  19756. "--"
  19757. ["Copy visible text" org-copy-visible t]
  19758. "--"
  19759. ["Promote Heading" org-metaleft (org-in-subtree-not-table-p)]
  19760. ["Promote Subtree" org-shiftmetaleft (org-in-subtree-not-table-p)]
  19761. ["Demote Heading" org-metaright (org-in-subtree-not-table-p)]
  19762. ["Demote Subtree" org-shiftmetaright (org-in-subtree-not-table-p)]
  19763. "--"
  19764. ["Sort Region/Children" org-sort t]
  19765. "--"
  19766. ["Convert to odd levels" org-convert-to-odd-levels t]
  19767. ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
  19768. ("Editing"
  19769. ["Emphasis..." org-emphasize t]
  19770. ["Edit Source Example" org-edit-special t]
  19771. "--"
  19772. ["Footnote new/jump" org-footnote-action t]
  19773. ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
  19774. ("Archive"
  19775. ["Archive (default method)" org-archive-subtree-default (org-in-subtree-not-table-p)]
  19776. "--"
  19777. ["Move Subtree to Archive file" org-archive-subtree (org-in-subtree-not-table-p)]
  19778. ["Toggle ARCHIVE tag" org-toggle-archive-tag (org-in-subtree-not-table-p)]
  19779. ["Move subtree to Archive sibling" org-archive-to-archive-sibling (org-in-subtree-not-table-p)]
  19780. )
  19781. "--"
  19782. ("Hyperlinks"
  19783. ["Store Link (Global)" org-store-link t]
  19784. ["Find existing link to here" org-occur-link-in-agenda-files t]
  19785. ["Insert Link" org-insert-link t]
  19786. ["Follow Link" org-open-at-point t]
  19787. "--"
  19788. ["Next link" org-next-link t]
  19789. ["Previous link" org-previous-link t]
  19790. "--"
  19791. ["Descriptive Links"
  19792. org-toggle-link-display
  19793. :style radio
  19794. :selected org-descriptive-links
  19795. ]
  19796. ["Literal Links"
  19797. org-toggle-link-display
  19798. :style radio
  19799. :selected (not org-descriptive-links)])
  19800. "--"
  19801. ("TODO Lists"
  19802. ["TODO/DONE/-" org-todo t]
  19803. ("Select keyword"
  19804. ["Next keyword" org-shiftright (org-at-heading-p)]
  19805. ["Previous keyword" org-shiftleft (org-at-heading-p)]
  19806. ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
  19807. ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
  19808. ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
  19809. ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
  19810. ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
  19811. "--"
  19812. ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
  19813. :selected org-enforce-todo-dependencies :style toggle :active t]
  19814. "Settings for tree at point"
  19815. ["Do Children sequentially" org-toggle-ordered-property :style radio
  19816. :selected (org-entry-get nil "ORDERED")
  19817. :active org-enforce-todo-dependencies :keys "C-c C-x o"]
  19818. ["Do Children parallel" org-toggle-ordered-property :style radio
  19819. :selected (not (org-entry-get nil "ORDERED"))
  19820. :active org-enforce-todo-dependencies :keys "C-c C-x o"]
  19821. "--"
  19822. ["Set Priority" org-priority t]
  19823. ["Priority Up" org-shiftup t]
  19824. ["Priority Down" org-shiftdown t]
  19825. "--"
  19826. ["Get news from all feeds" org-feed-update-all t]
  19827. ["Go to the inbox of a feed..." org-feed-goto-inbox t]
  19828. ["Customize feeds" (customize-variable 'org-feed-alist) t])
  19829. ("TAGS and Properties"
  19830. ["Set Tags" org-set-tags-command (not (org-before-first-heading-p))]
  19831. ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
  19832. "--"
  19833. ["Set property" org-set-property (not (org-before-first-heading-p))]
  19834. ["Column view of properties" org-columns t]
  19835. ["Insert Column View DBlock" org-columns-insert-dblock t])
  19836. ("Dates and Scheduling"
  19837. ["Timestamp" org-time-stamp (not (org-before-first-heading-p))]
  19838. ["Timestamp (inactive)" org-time-stamp-inactive (not (org-before-first-heading-p))]
  19839. ("Change Date"
  19840. ["1 Day Later" org-shiftright (org-at-timestamp-p)]
  19841. ["1 Day Earlier" org-shiftleft (org-at-timestamp-p)]
  19842. ["1 ... Later" org-shiftup (org-at-timestamp-p)]
  19843. ["1 ... Earlier" org-shiftdown (org-at-timestamp-p)])
  19844. ["Compute Time Range" org-evaluate-time-range t]
  19845. ["Schedule Item" org-schedule (not (org-before-first-heading-p))]
  19846. ["Deadline" org-deadline (not (org-before-first-heading-p))]
  19847. "--"
  19848. ["Custom time format" org-toggle-time-stamp-overlays
  19849. :style radio :selected org-display-custom-times]
  19850. "--"
  19851. ["Goto Calendar" org-goto-calendar t]
  19852. ["Date from Calendar" org-date-from-calendar t]
  19853. "--"
  19854. ["Start/Restart Timer" org-timer-start t]
  19855. ["Pause/Continue Timer" org-timer-pause-or-continue t]
  19856. ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
  19857. ["Insert Timer String" org-timer t]
  19858. ["Insert Timer Item" org-timer-item t])
  19859. ("Logging work"
  19860. ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
  19861. ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
  19862. ["Clock out" org-clock-out t]
  19863. ["Clock cancel" org-clock-cancel t]
  19864. "--"
  19865. ["Mark as default task" org-clock-mark-default-task t]
  19866. ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
  19867. ["Goto running clock" org-clock-goto t]
  19868. "--"
  19869. ["Display times" org-clock-display t]
  19870. ["Create clock table" org-clock-report t]
  19871. "--"
  19872. ["Record DONE time"
  19873. (progn (setq org-log-done (not org-log-done))
  19874. (message "Switching to %s will %s record a timestamp"
  19875. (car org-done-keywords)
  19876. (if org-log-done "automatically" "not")))
  19877. :style toggle :selected org-log-done])
  19878. "--"
  19879. ["Agenda Command..." org-agenda t]
  19880. ["Set Restriction Lock" org-agenda-set-restriction-lock t]
  19881. ("File List for Agenda")
  19882. ("Special views current file"
  19883. ["TODO Tree" org-show-todo-tree t]
  19884. ["Check Deadlines" org-check-deadlines t]
  19885. ["Tags/Property tree" org-match-sparse-tree t])
  19886. "--"
  19887. ["Export/Publish..." org-export-dispatch t]
  19888. ("LaTeX"
  19889. ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
  19890. :selected org-cdlatex-mode]
  19891. ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
  19892. ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
  19893. ["Modify math symbol" org-cdlatex-math-modify
  19894. (org-inside-LaTeX-fragment-p)]
  19895. ["Insert citation" org-reftex-citation t])
  19896. "--"
  19897. ("MobileOrg"
  19898. ["Push Files and Views" org-mobile-push t]
  19899. ["Get Captured and Flagged" org-mobile-pull t]
  19900. ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
  19901. "--"
  19902. ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
  19903. "--"
  19904. ("Documentation"
  19905. ["Show Version" org-version t]
  19906. ["Info Documentation" org-info t])
  19907. ("Customize"
  19908. ["Browse Org Group" org-customize t]
  19909. "--"
  19910. ["Expand This Menu" org-create-customize-menu
  19911. (fboundp 'customize-menu-create)])
  19912. ["Send bug report" org-submit-bug-report t]
  19913. "--"
  19914. ("Refresh/Reload"
  19915. ["Refresh setup current buffer" org-mode-restart t]
  19916. ["Reload Org (after update)" org-reload t]
  19917. ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x !"])
  19918. ))
  19919. (defun org-info (&optional node)
  19920. "Read documentation for Org in the info system.
  19921. With optional NODE, go directly to that node."
  19922. (interactive)
  19923. (info (format "(org)%s" (or node ""))))
  19924. ;;;###autoload
  19925. (defun org-submit-bug-report ()
  19926. "Submit a bug report on Org via mail.
  19927. Don't hesitate to report any problems or inaccurate documentation.
  19928. If you don't have setup sending mail from (X)Emacs, please copy the
  19929. output buffer into your mail program, as it gives us important
  19930. information about your Org version and configuration."
  19931. (interactive)
  19932. (require 'reporter)
  19933. (defvar reporter-prompt-for-summary-p)
  19934. (org-load-modules-maybe)
  19935. (org-require-autoloaded-modules)
  19936. (let ((reporter-prompt-for-summary-p "Bug report subject: "))
  19937. (reporter-submit-bug-report
  19938. "emacs-orgmode@gnu.org"
  19939. (org-version nil 'full)
  19940. (let (list)
  19941. (save-window-excursion
  19942. (pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
  19943. (delete-other-windows)
  19944. (erase-buffer)
  19945. (insert "You are about to submit a bug report to the Org mailing list.
  19946. We would like to add your full Org and Outline configuration to the
  19947. bug report. This greatly simplifies the work of the maintainer and
  19948. other experts on the mailing list.
  19949. HOWEVER, some variables you have customized may contain private
  19950. information. The names of customers, colleagues, or friends, might
  19951. appear in the form of file names, tags, todo states, or search strings.
  19952. If you answer yes to the prompt, you might want to check and remove
  19953. such private information before sending the email.")
  19954. (add-text-properties (point-min) (point-max) '(face org-warning))
  19955. (when (yes-or-no-p "Include your Org configuration ")
  19956. (mapatoms
  19957. (lambda (v)
  19958. (and (boundp v)
  19959. (string-match "\\`\\(org-\\|outline-\\)" (symbol-name v))
  19960. (or (and (symbol-value v)
  19961. (string-match "\\(-hook\\|-function\\)\\'" (symbol-name v)))
  19962. (and
  19963. (get v 'custom-type) (get v 'standard-value)
  19964. (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
  19965. (push v list)))))
  19966. (kill-buffer (get-buffer "*Warn about privacy*"))
  19967. list))
  19968. nil nil
  19969. "Remember to cover the basics, that is, what you expected to happen and
  19970. what in fact did happen. You don't know how to make a good report? See
  19971. http://orgmode.org/manual/Feedback.html#Feedback
  19972. Your bug report will be posted to the Org mailing list.
  19973. ------------------------------------------------------------------------")
  19974. (save-excursion
  19975. (when (re-search-backward "^\\(Subject: \\)Org mode version \\(.*?\\);[ \t]*\\(.*\\)" nil t)
  19976. (replace-match "\\1Bug: \\3 [\\2]")))))
  19977. (defun org-install-agenda-files-menu ()
  19978. (let ((bl (buffer-list)))
  19979. (save-excursion
  19980. (while bl
  19981. (set-buffer (pop bl))
  19982. (when (derived-mode-p 'org-mode) (setq bl nil)))
  19983. (when (derived-mode-p 'org-mode)
  19984. (easy-menu-change
  19985. '("Org") "File List for Agenda"
  19986. (append
  19987. (list
  19988. ["Edit File List" (org-edit-agenda-file-list) t]
  19989. ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
  19990. ["Remove Current File from List" org-remove-file t]
  19991. ["Cycle through agenda files" org-cycle-agenda-files t]
  19992. ["Occur in all agenda files" org-occur-in-agenda-files t]
  19993. "--")
  19994. (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
  19995. ;;;; Documentation
  19996. (defun org-require-autoloaded-modules ()
  19997. (interactive)
  19998. (mapc #'require
  19999. '(org-agenda org-archive org-attach org-clock org-colview org-id
  20000. org-table org-timer)))
  20001. ;;;###autoload
  20002. (defun org-reload (&optional uncompiled)
  20003. "Reload all org lisp files.
  20004. With prefix arg UNCOMPILED, load the uncompiled versions."
  20005. (interactive "P")
  20006. (require 'loadhist)
  20007. (let* ((org-dir (org-find-library-dir "org"))
  20008. (contrib-dir (or (org-find-library-dir "org-contribdir") org-dir))
  20009. (feature-re "^\\(org\\|ob\\|ox\\)\\(-.*\\)?")
  20010. (remove-re (format "\\`%s\\'"
  20011. (regexp-opt '("org" "org-loaddefs" "org-version"))))
  20012. (feats (delete-dups
  20013. (mapcar 'file-name-sans-extension
  20014. (mapcar 'file-name-nondirectory
  20015. (delq nil
  20016. (mapcar 'feature-file
  20017. features))))))
  20018. (lfeat (append
  20019. (sort
  20020. (setq feats
  20021. (delq nil (mapcar
  20022. (lambda (f)
  20023. (if (and (string-match feature-re f)
  20024. (not (string-match remove-re f)))
  20025. f nil))
  20026. feats)))
  20027. 'string-lessp)
  20028. (list "org-version" "org")))
  20029. (load-suffixes (when (boundp 'load-suffixes) load-suffixes))
  20030. (load-suffixes (if uncompiled (reverse load-suffixes) load-suffixes))
  20031. load-uncore load-misses)
  20032. (setq load-misses
  20033. (delq 't
  20034. (mapcar (lambda (f)
  20035. (or (org-load-noerror-mustsuffix (concat org-dir f))
  20036. (and (string= org-dir contrib-dir)
  20037. (org-load-noerror-mustsuffix (concat contrib-dir f)))
  20038. (and (org-load-noerror-mustsuffix (concat (org-find-library-dir f) f))
  20039. (add-to-list 'load-uncore f 'append)
  20040. 't)
  20041. f))
  20042. lfeat)))
  20043. (when load-uncore
  20044. (message "The following feature%s found in load-path, please check if that's correct:\n%s"
  20045. (if (> (length load-uncore) 1) "s were" " was") load-uncore))
  20046. (if load-misses
  20047. (message "Some error occurred while reloading Org feature%s\n%s\nPlease check *Messages*!\n%s"
  20048. (if (> (length load-misses) 1) "s" "") load-misses (org-version nil 'full))
  20049. (message "Successfully reloaded Org\n%s" (org-version nil 'full)))))
  20050. ;;;###autoload
  20051. (defun org-customize ()
  20052. "Call the customize function with org as argument."
  20053. (interactive)
  20054. (org-load-modules-maybe)
  20055. (org-require-autoloaded-modules)
  20056. (customize-browse 'org))
  20057. (defun org-create-customize-menu ()
  20058. "Create a full customization menu for Org mode, insert it into the menu."
  20059. (interactive)
  20060. (org-load-modules-maybe)
  20061. (org-require-autoloaded-modules)
  20062. (if (fboundp 'customize-menu-create)
  20063. (progn
  20064. (easy-menu-change
  20065. '("Org") "Customize"
  20066. `(["Browse Org group" org-customize t]
  20067. "--"
  20068. ,(customize-menu-create 'org)
  20069. ["Set" Custom-set t]
  20070. ["Save" Custom-save t]
  20071. ["Reset to Current" Custom-reset-current t]
  20072. ["Reset to Saved" Custom-reset-saved t]
  20073. ["Reset to Standard Settings" Custom-reset-standard t]))
  20074. (message "\"Org\"-menu now contains full customization menu"))
  20075. (error "Cannot expand menu (outdated version of cus-edit.el)")))
  20076. ;;;; Miscellaneous stuff
  20077. ;;; Generally useful functions
  20078. (defun org-get-at-eol (property n)
  20079. "Get text property PROPERTY at the end of line less N characters."
  20080. (get-text-property (- (point-at-eol) n) property))
  20081. (defun org-find-text-property-in-string (prop s)
  20082. "Return the first non-nil value of property PROP in string S."
  20083. (or (get-text-property 0 prop s)
  20084. (get-text-property (or (next-single-property-change 0 prop s) 0)
  20085. prop s)))
  20086. (defun org-display-warning (message)
  20087. "Display the given MESSAGE as a warning."
  20088. (display-warning 'org message :warning))
  20089. (defun org-eval (form)
  20090. "Eval FORM and return result."
  20091. (condition-case error
  20092. (eval form)
  20093. (error (format "%%![Error: %s]" error))))
  20094. (defun org-in-clocktable-p ()
  20095. "Check if the cursor is in a clocktable."
  20096. (let ((pos (point)) start)
  20097. (save-excursion
  20098. (end-of-line 1)
  20099. (and (re-search-backward "^[ \t]*#\\+BEGIN:[ \t]+clocktable" nil t)
  20100. (setq start (match-beginning 0))
  20101. (re-search-forward "^[ \t]*#\\+END:.*" nil t)
  20102. (>= (match-end 0) pos)
  20103. start))))
  20104. (defun org-in-verbatim-emphasis ()
  20105. (save-match-data
  20106. (and (org-in-regexp org-verbatim-re 2)
  20107. (>= (point) (match-beginning 3))
  20108. (<= (point) (match-end 4)))))
  20109. (defun org-overlay-display (ovl text &optional face evap)
  20110. "Make overlay OVL display TEXT with face FACE."
  20111. (overlay-put ovl 'display text)
  20112. (if face (overlay-put ovl 'face face))
  20113. (if evap (overlay-put ovl 'evaporate t)))
  20114. (defun org-overlay-before-string (ovl text &optional face evap)
  20115. "Make overlay OVL display TEXT with face FACE."
  20116. (if face (org-add-props text nil 'face face))
  20117. (overlay-put ovl 'before-string text)
  20118. (if evap (overlay-put ovl 'evaporate t)))
  20119. (defun org-find-overlays (prop &optional pos delete)
  20120. "Find all overlays specifying PROP at POS or point.
  20121. If DELETE is non-nil, delete all those overlays."
  20122. (let (found)
  20123. (dolist (ov (overlays-at (or pos (point))) found)
  20124. (cond ((not (overlay-get ov prop)))
  20125. (delete (delete-overlay ov))
  20126. (t (push ov found))))))
  20127. (defun org-goto-marker-or-bmk (marker &optional bookmark)
  20128. "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
  20129. (if (and marker (marker-buffer marker)
  20130. (buffer-live-p (marker-buffer marker)))
  20131. (progn
  20132. (pop-to-buffer-same-window (marker-buffer marker))
  20133. (when (or (> marker (point-max)) (< marker (point-min)))
  20134. (widen))
  20135. (goto-char marker)
  20136. (org-show-context 'org-goto))
  20137. (if bookmark
  20138. (bookmark-jump bookmark)
  20139. (error "Cannot find location"))))
  20140. (defun org-quote-csv-field (s)
  20141. "Quote field for inclusion in CSV material."
  20142. (if (string-match "[\",]" s)
  20143. (concat "\"" (mapconcat 'identity (split-string s "\"") "\"\"") "\"")
  20144. s))
  20145. (defun org-force-self-insert (N)
  20146. "Needed to enforce self-insert under remapping."
  20147. (interactive "p")
  20148. (self-insert-command N))
  20149. (defun org-string-width (s)
  20150. "Compute width of string, ignoring invisible characters.
  20151. This ignores character with invisibility property `org-link', and also
  20152. characters with property `org-cwidth', because these will become invisible
  20153. upon the next fontification round."
  20154. (let (b l)
  20155. (when (or (eq t buffer-invisibility-spec)
  20156. (assq 'org-link buffer-invisibility-spec))
  20157. (while (setq b (text-property-any 0 (length s)
  20158. 'invisible 'org-link s))
  20159. (setq s (concat (substring s 0 b)
  20160. (substring s (or (next-single-property-change
  20161. b 'invisible s)
  20162. (length s)))))))
  20163. (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
  20164. (setq s (concat (substring s 0 b)
  20165. (substring s (or (next-single-property-change
  20166. b 'org-cwidth s)
  20167. (length s))))))
  20168. (setq l (string-width s) b -1)
  20169. (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
  20170. (setq l (- l (get-text-property b 'org-dwidth-n s))))
  20171. l))
  20172. (defun org-shorten-string (s maxlength)
  20173. "Shorten string S so that it is no longer than MAXLENGTH characters.
  20174. If the string is shorter or has length MAXLENGTH, just return the
  20175. original string. If it is longer, the functions finds a space in the
  20176. string, breaks this string off at that locations and adds three dots
  20177. as ellipsis. Including the ellipsis, the string will not be longer
  20178. than MAXLENGTH. If finding a good breaking point in the string does
  20179. not work, the string is just chopped off in the middle of a word
  20180. if necessary."
  20181. (if (<= (length s) maxlength)
  20182. s
  20183. (let* ((n (max (- maxlength 4) 1))
  20184. (re (concat "\\`\\(.\\{1," (int-to-string n) "\\}[^ ]\\)\\([ ]\\|\\'\\)")))
  20185. (if (string-match re s)
  20186. (concat (match-string 1 s) "...")
  20187. (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
  20188. (defun org-get-indentation (&optional line)
  20189. "Get the indentation of the current line, interpreting tabs.
  20190. When LINE is given, assume it represents a line and compute its indentation."
  20191. (if line
  20192. (when (string-match "^ *" (org-remove-tabs line))
  20193. (match-end 0))
  20194. (save-excursion
  20195. (beginning-of-line 1)
  20196. (skip-chars-forward " \t")
  20197. (current-column))))
  20198. (defun org-get-string-indentation (s)
  20199. "What indentation has S due to SPACE and TAB at the beginning of the string?"
  20200. (let ((n -1) (i 0) (w tab-width) c)
  20201. (catch 'exit
  20202. (while (< (setq n (1+ n)) (length s))
  20203. (setq c (aref s n))
  20204. (cond ((= c ?\ ) (setq i (1+ i)))
  20205. ((= c ?\t) (setq i (* (/ (+ w i) w) w)))
  20206. (t (throw 'exit t)))))
  20207. i))
  20208. (defun org-remove-tabs (s &optional width)
  20209. "Replace tabulators in S with spaces.
  20210. Assumes that s is a single line, starting in column 0."
  20211. (setq width (or width tab-width))
  20212. (while (string-match "\t" s)
  20213. (setq s (replace-match
  20214. (make-string
  20215. (- (* width (/ (+ (match-beginning 0) width) width))
  20216. (match-beginning 0)) ?\ )
  20217. t t s)))
  20218. s)
  20219. (defun org-fix-indentation (line ind)
  20220. "Fix indentation in LINE.
  20221. IND is a cons cell with target and minimum indentation.
  20222. If the current indentation in LINE is smaller than the minimum,
  20223. leave it alone. If it is larger than ind, set it to the target."
  20224. (let* ((l (org-remove-tabs line))
  20225. (i (org-get-indentation l))
  20226. (i1 (car ind)) (i2 (cdr ind)))
  20227. (when (>= i i2) (setq l (substring line i2)))
  20228. (if (> i1 0)
  20229. (concat (make-string i1 ?\ ) l)
  20230. l)))
  20231. (defun org-remove-indentation (code &optional n)
  20232. "Remove maximum common indentation in string CODE and return it.
  20233. N may optionally be the number of columns to remove. Return CODE
  20234. as-is if removal failed."
  20235. (with-temp-buffer
  20236. (insert code)
  20237. (if (org-do-remove-indentation n) (buffer-string) code)))
  20238. (defun org-do-remove-indentation (&optional n)
  20239. "Remove the maximum common indentation from the buffer.
  20240. When optional argument N is a positive integer, remove exactly
  20241. that much characters from indentation, if possible. Return nil
  20242. if it fails."
  20243. (catch :exit
  20244. (goto-char (point-min))
  20245. ;; Find maximum common indentation, if not specified.
  20246. (let ((n (or n
  20247. (let ((min-ind (point-max)))
  20248. (save-excursion
  20249. (while (re-search-forward "^[ \t]*\\S-" nil t)
  20250. (let ((ind (1- (current-column))))
  20251. (if (zerop ind) (throw :exit nil)
  20252. (setq min-ind (min min-ind ind))))))
  20253. min-ind))))
  20254. (if (zerop n) (throw :exit nil)
  20255. ;; Remove exactly N indentation, but give up if not possible.
  20256. (while (not (eobp))
  20257. (let ((ind (progn (skip-chars-forward " \t") (current-column))))
  20258. (cond ((eolp) (delete-region (line-beginning-position) (point)))
  20259. ((< ind n) (throw :exit nil))
  20260. (t (indent-line-to (- ind n))))
  20261. (forward-line)))
  20262. ;; Signal success.
  20263. t))))
  20264. (defun org-fill-template (template alist)
  20265. "Find each %key of ALIST in TEMPLATE and replace it."
  20266. (let ((case-fold-search nil))
  20267. (dolist (entry (sort (copy-sequence alist)
  20268. (lambda (a b) (< (length (car a)) (length (car b))))))
  20269. (setq template
  20270. (replace-regexp-in-string
  20271. (concat "%" (regexp-quote (car entry)))
  20272. (or (cdr entry) "") template t t)))
  20273. template))
  20274. (defun org-base-buffer (buffer)
  20275. "Return the base buffer of BUFFER, if it has one. Else return the buffer."
  20276. (if (not buffer)
  20277. buffer
  20278. (or (buffer-base-buffer buffer)
  20279. buffer)))
  20280. (defun org-wrap (string &optional width lines)
  20281. "Wrap string to either a number of lines, or a width in characters.
  20282. If WIDTH is non-nil, the string is wrapped to that width, however many lines
  20283. that costs. If there is a word longer than WIDTH, the text is actually
  20284. wrapped to the length of that word.
  20285. IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
  20286. many lines, whatever width that takes.
  20287. The return value is a list of lines, without newlines at the end."
  20288. (let* ((words (org-split-string string "[ \t\n]+"))
  20289. (maxword (apply 'max (mapcar 'org-string-width words)))
  20290. w ll)
  20291. (cond (width
  20292. (org-do-wrap words (max maxword width)))
  20293. (lines
  20294. (setq w maxword)
  20295. (setq ll (org-do-wrap words maxword))
  20296. (if (<= (length ll) lines)
  20297. ll
  20298. (setq ll words)
  20299. (while (> (length ll) lines)
  20300. (setq w (1+ w))
  20301. (setq ll (org-do-wrap words w)))
  20302. ll))
  20303. (t (error "Cannot wrap this")))))
  20304. (defun org-do-wrap (words width)
  20305. "Create lines of maximum width WIDTH (in characters) from word list WORDS."
  20306. (let (lines line)
  20307. (while words
  20308. (setq line (pop words))
  20309. (while (and words (< (+ (length line) (length (car words))) width))
  20310. (setq line (concat line " " (pop words))))
  20311. (setq lines (push line lines)))
  20312. (nreverse lines)))
  20313. (defun org-split-string (string &optional separators)
  20314. "Splits STRING into substrings at SEPARATORS.
  20315. SEPARATORS is a regular expression.
  20316. No empty strings are returned if there are matches at the beginning
  20317. and end of string."
  20318. ;; FIXME: why not use (split-string STRING SEPARATORS t)?
  20319. (let ((start 0) notfirst list)
  20320. (while (and (string-match (or separators "[ \f\t\n\r\v]+") string
  20321. (if (and notfirst
  20322. (= start (match-beginning 0))
  20323. (< start (length string)))
  20324. (1+ start) start))
  20325. (< (match-beginning 0) (length string)))
  20326. (setq notfirst t)
  20327. (or (eq (match-beginning 0) 0)
  20328. (and (eq (match-beginning 0) (match-end 0))
  20329. (eq (match-beginning 0) start))
  20330. (push (substring string start (match-beginning 0)) list))
  20331. (setq start (match-end 0)))
  20332. (or (eq start (length string))
  20333. (push (substring string start) list))
  20334. (nreverse list)))
  20335. (defun org-quote-vert (s)
  20336. "Replace \"|\" with \"\\vert\"."
  20337. (while (string-match "|" s)
  20338. (setq s (replace-match "\\vert" t t s)))
  20339. s)
  20340. (defun org-uuidgen-p (s)
  20341. "Is S an ID created by UUIDGEN?"
  20342. (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
  20343. (defun org-in-src-block-p (&optional inside)
  20344. "Whether point is in a code source block.
  20345. When INSIDE is non-nil, don't consider we are within a src block
  20346. when point is at #+BEGIN_SRC or #+END_SRC."
  20347. (let ((case-fold-search t))
  20348. (or (and (eq (get-char-property (point) 'src-block) t))
  20349. (and (not inside)
  20350. (save-match-data
  20351. (save-excursion
  20352. (beginning-of-line)
  20353. (looking-at ".*#\\+\\(begin\\|end\\)_src")))))))
  20354. (defun org-context ()
  20355. "Return a list of contexts of the current cursor position.
  20356. If several contexts apply, all are returned.
  20357. Each context entry is a list with a symbol naming the context, and
  20358. two positions indicating start and end of the context. Possible
  20359. contexts are:
  20360. :headline anywhere in a headline
  20361. :headline-stars on the leading stars in a headline
  20362. :todo-keyword on a TODO keyword (including DONE) in a headline
  20363. :tags on the TAGS in a headline
  20364. :priority on the priority cookie in a headline
  20365. :item on the first line of a plain list item
  20366. :item-bullet on the bullet/number of a plain list item
  20367. :checkbox on the checkbox in a plain list item
  20368. :table in an Org table
  20369. :table-special on a special filed in a table
  20370. :table-table in a table.el table
  20371. :clocktable in a clocktable
  20372. :src-block in a source block
  20373. :link on a hyperlink
  20374. :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT.
  20375. :target on a <<target>>
  20376. :radio-target on a <<<radio-target>>>
  20377. :latex-fragment on a LaTeX fragment
  20378. :latex-preview on a LaTeX fragment with overlaid preview image
  20379. This function expects the position to be visible because it uses font-lock
  20380. faces as a help to recognize the following contexts: :table-special, :link,
  20381. and :keyword."
  20382. (let* ((f (get-text-property (point) 'face))
  20383. (faces (if (listp f) f (list f)))
  20384. (case-fold-search t)
  20385. (p (point)) clist o)
  20386. ;; First the large context
  20387. (cond
  20388. ((org-at-heading-p t)
  20389. (push (list :headline (point-at-bol) (point-at-eol)) clist)
  20390. (when (progn
  20391. (beginning-of-line 1)
  20392. (looking-at org-todo-line-tags-regexp))
  20393. (push (org-point-in-group p 1 :headline-stars) clist)
  20394. (push (org-point-in-group p 2 :todo-keyword) clist)
  20395. (push (org-point-in-group p 4 :tags) clist))
  20396. (goto-char p)
  20397. (skip-chars-backward "^[\n\r \t") (or (bobp) (backward-char 1))
  20398. (when (looking-at "\\[#[A-Z0-9]\\]")
  20399. (push (org-point-in-group p 0 :priority) clist)))
  20400. ((org-at-item-p)
  20401. (push (org-point-in-group p 2 :item-bullet) clist)
  20402. (push (list :item (point-at-bol)
  20403. (save-excursion (org-end-of-item) (point)))
  20404. clist)
  20405. (and (org-at-item-checkbox-p)
  20406. (push (org-point-in-group p 0 :checkbox) clist)))
  20407. ((org-at-table-p)
  20408. (push (list :table (org-table-begin) (org-table-end)) clist)
  20409. (when (memq 'org-formula faces)
  20410. (push (list :table-special
  20411. (previous-single-property-change p 'face)
  20412. (next-single-property-change p 'face)) clist)))
  20413. ((org-at-table-p 'any)
  20414. (push (list :table-table) clist)))
  20415. (goto-char p)
  20416. (let ((case-fold-search t))
  20417. ;; New the "medium" contexts: clocktables, source blocks
  20418. (cond ((org-in-clocktable-p)
  20419. (push (list :clocktable
  20420. (and (or (looking-at "[ \t]*\\(#\\+BEGIN: clocktable\\)")
  20421. (re-search-backward "[ \t]*\\(#+BEGIN: clocktable\\)" nil t))
  20422. (match-beginning 1))
  20423. (and (re-search-forward "[ \t]*#\\+END:?" nil t)
  20424. (match-end 0))) clist))
  20425. ((org-in-src-block-p)
  20426. (push (list :src-block
  20427. (and (or (looking-at "[ \t]*\\(#\\+BEGIN_SRC\\)")
  20428. (re-search-backward "[ \t]*\\(#+BEGIN_SRC\\)" nil t))
  20429. (match-beginning 1))
  20430. (and (search-forward "#+END_SRC" nil t)
  20431. (match-beginning 0))) clist))))
  20432. (goto-char p)
  20433. ;; Now the small context
  20434. (cond
  20435. ((org-at-timestamp-p)
  20436. (push (org-point-in-group p 0 :timestamp) clist))
  20437. ((memq 'org-link faces)
  20438. (push (list :link
  20439. (previous-single-property-change p 'face)
  20440. (next-single-property-change p 'face)) clist))
  20441. ((memq 'org-special-keyword faces)
  20442. (push (list :keyword
  20443. (previous-single-property-change p 'face)
  20444. (next-single-property-change p 'face)) clist))
  20445. ((org-at-target-p)
  20446. (push (org-point-in-group p 0 :target) clist)
  20447. (goto-char (1- (match-beginning 0)))
  20448. (when (looking-at org-radio-target-regexp)
  20449. (push (org-point-in-group p 0 :radio-target) clist))
  20450. (goto-char p))
  20451. ((setq o (cl-some
  20452. (lambda (o)
  20453. (and (eq (overlay-get o 'org-overlay-type) 'org-latex-overlay)
  20454. o))
  20455. (overlays-at (point))))
  20456. (push (list :latex-fragment
  20457. (overlay-start o) (overlay-end o)) clist)
  20458. (push (list :latex-preview
  20459. (overlay-start o) (overlay-end o)) clist))
  20460. ((org-inside-LaTeX-fragment-p)
  20461. ;; FIXME: positions wrong.
  20462. (push (list :latex-fragment (point) (point)) clist)))
  20463. (setq clist (nreverse (delq nil clist)))
  20464. clist))
  20465. (defun org-in-regexp (regexp &optional nlines visually)
  20466. "Check if point is inside a match of REGEXP.
  20467. Normally only the current line is checked, but you can include
  20468. NLINES extra lines around point into the search. If VISUALLY is
  20469. set, require that the cursor is not after the match but really
  20470. on, so that the block visually is on the match.
  20471. Return nil or a cons cell (BEG . END) where BEG and END are,
  20472. respectively, the positions at the beginning and the end of the
  20473. match."
  20474. (catch :exit
  20475. (let ((pos (point))
  20476. (eol (line-end-position (if nlines (1+ nlines) 1))))
  20477. (save-excursion
  20478. (beginning-of-line (- 1 (or nlines 0)))
  20479. (while (and (re-search-forward regexp eol t)
  20480. (<= (match-beginning 0) pos))
  20481. (let ((end (match-end 0)))
  20482. (when (or (> end pos) (and (= end pos) (not visually)))
  20483. (throw :exit (cons (match-beginning 0) (match-end 0))))))))))
  20484. (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
  20485. "Non-nil when point is between matches of START-RE and END-RE.
  20486. Also return a non-nil value when point is on one of the matches.
  20487. Optional arguments LIM-UP and LIM-DOWN bound the search; they are
  20488. buffer positions. Default values are the positions of headlines
  20489. surrounding the point.
  20490. The functions returns a cons cell whose car (resp. cdr) is the
  20491. position before START-RE (resp. after END-RE)."
  20492. (save-match-data
  20493. (let ((pos (point))
  20494. (limit-up (or lim-up (save-excursion (outline-previous-heading))))
  20495. (limit-down (or lim-down (save-excursion (outline-next-heading))))
  20496. beg end)
  20497. (save-excursion
  20498. ;; Point is on a block when on START-RE or if START-RE can be
  20499. ;; found before it...
  20500. (and (or (org-in-regexp start-re)
  20501. (re-search-backward start-re limit-up t))
  20502. (setq beg (match-beginning 0))
  20503. ;; ... and END-RE after it...
  20504. (goto-char (match-end 0))
  20505. (re-search-forward end-re limit-down t)
  20506. (> (setq end (match-end 0)) pos)
  20507. ;; ... without another START-RE in-between.
  20508. (goto-char (match-beginning 0))
  20509. (not (re-search-backward start-re (1+ beg) t))
  20510. ;; Return value.
  20511. (cons beg end))))))
  20512. (defun org-in-block-p (names)
  20513. "Non-nil when point belongs to a block whose name belongs to NAMES.
  20514. NAMES is a list of strings containing names of blocks.
  20515. Return first block name matched, or nil. Beware that in case of
  20516. nested blocks, the returned name may not belong to the closest
  20517. block from point."
  20518. (save-match-data
  20519. (catch 'exit
  20520. (let ((case-fold-search t)
  20521. (lim-up (save-excursion (outline-previous-heading)))
  20522. (lim-down (save-excursion (outline-next-heading))))
  20523. (dolist (name names)
  20524. (let ((n (regexp-quote name)))
  20525. (when (org-between-regexps-p
  20526. (concat "^[ \t]*#\\+begin_" n)
  20527. (concat "^[ \t]*#\\+end_" n)
  20528. lim-up lim-down)
  20529. (throw 'exit n)))))
  20530. nil)))
  20531. (defun org-occur-in-agenda-files (regexp &optional _nlines)
  20532. "Call `multi-occur' with buffers for all agenda files."
  20533. (interactive "sOrg-files matching: ")
  20534. (let* ((files (org-agenda-files))
  20535. (tnames (mapcar #'file-truename files))
  20536. (extra org-agenda-text-search-extra-files))
  20537. (when (eq (car extra) 'agenda-archives)
  20538. (setq extra (cdr extra))
  20539. (setq files (org-add-archive-files files)))
  20540. (dolist (f extra)
  20541. (unless (member (file-truename f) tnames)
  20542. (unless (member f files) (setq files (append files (list f))))
  20543. (setq tnames (append tnames (list (file-truename f))))))
  20544. (multi-occur
  20545. (mapcar (lambda (x)
  20546. (with-current-buffer
  20547. ;; FIXME: Why not just (find-file-noselect x)?
  20548. ;; Is it to avoid the "revert buffer" prompt?
  20549. (or (get-file-buffer x) (find-file-noselect x))
  20550. (widen)
  20551. (current-buffer)))
  20552. files)
  20553. regexp)))
  20554. (add-hook 'occur-mode-find-occurrence-hook
  20555. (lambda () (when (derived-mode-p 'org-mode) (org-reveal))))
  20556. (defun org-occur-link-in-agenda-files ()
  20557. "Create a link and search for it in the agendas.
  20558. The link is not stored in `org-stored-links', it is just created
  20559. for the search purpose."
  20560. (interactive)
  20561. (let ((link (condition-case nil
  20562. (org-store-link nil)
  20563. (error "Unable to create a link to here"))))
  20564. (org-occur-in-agenda-files (regexp-quote link))))
  20565. (defun org-reverse-string (string)
  20566. "Return the reverse of STRING."
  20567. (apply 'string (reverse (string-to-list string))))
  20568. ;; defsubst org-uniquify must be defined before first use
  20569. (defun org-uniquify-alist (alist)
  20570. "Merge elements of ALIST with the same key.
  20571. For example, in this alist:
  20572. \(org-uniquify-alist \\='((a 1) (b 2) (a 3)))
  20573. => \\='((a 1 3) (b 2))
  20574. merge (a 1) and (a 3) into (a 1 3).
  20575. The function returns the new ALIST."
  20576. (let (rtn)
  20577. (dolist (e alist rtn)
  20578. (let (n)
  20579. (if (not (assoc (car e) rtn))
  20580. (push e rtn)
  20581. (setq n (cons (car e) (append (cdr (assoc (car e) rtn)) (cdr e))))
  20582. (setq rtn (assq-delete-all (car e) rtn))
  20583. (push n rtn))))))
  20584. (defun org-delete-all (elts list)
  20585. "Remove all elements in ELTS from LIST.
  20586. Comparison is done with `equal'. It is a destructive operation
  20587. that may remove elements by altering the list structure."
  20588. (while elts
  20589. (setq list (delete (pop elts) list)))
  20590. list)
  20591. (defun org-back-over-empty-lines ()
  20592. "Move backwards over whitespace, to the beginning of the first empty line.
  20593. Returns the number of empty lines passed."
  20594. (let ((pos (point)))
  20595. (if (cdr (assq 'heading org-blank-before-new-entry))
  20596. (skip-chars-backward " \t\n\r")
  20597. (unless (eobp)
  20598. (forward-line -1)))
  20599. (beginning-of-line 2)
  20600. (goto-char (min (point) pos))
  20601. (count-lines (point) pos)))
  20602. (defun org-skip-whitespace ()
  20603. (skip-chars-forward " \t\n\r"))
  20604. (defun org-point-in-group (point group &optional context)
  20605. "Check if POINT is in match-group GROUP.
  20606. If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
  20607. match. If the match group does not exist or point is not inside it,
  20608. return nil."
  20609. (and (match-beginning group)
  20610. (>= point (match-beginning group))
  20611. (<= point (match-end group))
  20612. (if context
  20613. (list context (match-beginning group) (match-end group))
  20614. t)))
  20615. (defun org-switch-to-buffer-other-window (&rest args)
  20616. "Switch to buffer in a second window on the current frame.
  20617. In particular, do not allow pop-up frames.
  20618. Returns the newly created buffer."
  20619. (org-no-popups
  20620. (apply 'switch-to-buffer-other-window args)))
  20621. (defun org-combine-plists (&rest plists)
  20622. "Create a single property list from all plists in PLISTS.
  20623. The process starts by copying the first list, and then setting properties
  20624. from the other lists. Settings in the last list are the most significant
  20625. ones and overrule settings in the other lists."
  20626. (let ((rtn (copy-sequence (pop plists)))
  20627. p v ls)
  20628. (while plists
  20629. (setq ls (pop plists))
  20630. (while ls
  20631. (setq p (pop ls) v (pop ls))
  20632. (setq rtn (plist-put rtn p v))))
  20633. rtn))
  20634. (defun org-replace-escapes (string table)
  20635. "Replace %-escapes in STRING with values in TABLE.
  20636. TABLE is an association list with keys like \"%a\" and string values.
  20637. The sequences in STRING may contain normal field width and padding information,
  20638. for example \"%-5s\". Replacements happen in the sequence given by TABLE,
  20639. so values can contain further %-escapes if they are define later in TABLE."
  20640. (let ((tbl (copy-alist table))
  20641. (case-fold-search nil)
  20642. (pchg 0)
  20643. re rpl)
  20644. (dolist (e tbl)
  20645. (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
  20646. (when (and (cdr e) (string-match re (cdr e)))
  20647. (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
  20648. (safe "SREF"))
  20649. (add-text-properties 0 3 (list 'sref sref) safe)
  20650. (setcdr e (replace-match safe t t (cdr e)))))
  20651. (while (string-match re string)
  20652. (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
  20653. (cdr e)))
  20654. (setq string (replace-match rpl t t string))))
  20655. (while (setq pchg (next-property-change pchg string))
  20656. (let ((sref (get-text-property pchg 'sref string)))
  20657. (when (and sref (string-match "SREF" string pchg))
  20658. (setq string (replace-match sref t t string)))))
  20659. string))
  20660. (defun org-find-base-buffer-visiting (file)
  20661. "Like `find-buffer-visiting' but always return the base buffer and
  20662. not an indirect buffer."
  20663. (let ((buf (or (get-file-buffer file)
  20664. (find-buffer-visiting file))))
  20665. (if buf
  20666. (or (buffer-base-buffer buf) buf)
  20667. nil)))
  20668. ;;; TODO: Only called once, from ox-odt which should probably use
  20669. ;;; org-export-inline-image-p or something.
  20670. (defun org-file-image-p (file)
  20671. "Return non-nil if FILE is an image."
  20672. (save-match-data
  20673. (string-match (image-file-name-regexp) file)))
  20674. (defun org-get-cursor-date (&optional with-time)
  20675. "Return the date at cursor in as a time.
  20676. This works in the calendar and in the agenda, anywhere else it just
  20677. returns the current time.
  20678. If WITH-TIME is non-nil, returns the time of the event at point (in
  20679. the agenda) or the current time of the day."
  20680. (let (date day defd tp hod mod)
  20681. (when with-time
  20682. (setq tp (get-text-property (point) 'time))
  20683. (when (and tp (string-match "\\([0-9][0-9]\\):\\([0-9][0-9]\\)" tp))
  20684. (setq hod (string-to-number (match-string 1 tp))
  20685. mod (string-to-number (match-string 2 tp))))
  20686. (or tp (let ((now (decode-time)))
  20687. (setq hod (nth 2 now)
  20688. mod (nth 1 now)))))
  20689. (cond
  20690. ((eq major-mode 'calendar-mode)
  20691. (setq date (calendar-cursor-to-date)
  20692. defd (encode-time 0 (or mod 0) (or hod 0)
  20693. (nth 1 date) (nth 0 date) (nth 2 date))))
  20694. ((eq major-mode 'org-agenda-mode)
  20695. (setq day (get-text-property (point) 'day))
  20696. (when day
  20697. (setq date (calendar-gregorian-from-absolute day)
  20698. defd (encode-time 0 (or mod 0) (or hod 0)
  20699. (nth 1 date) (nth 0 date) (nth 2 date))))))
  20700. (or defd (current-time))))
  20701. (defun org-mark-subtree (&optional up)
  20702. "Mark the current subtree.
  20703. This puts point at the start of the current subtree, and mark at
  20704. the end. If a numeric prefix UP is given, move up into the
  20705. hierarchy of headlines by UP levels before marking the subtree."
  20706. (interactive "P")
  20707. (org-with-limited-levels
  20708. (cond ((org-at-heading-p) (beginning-of-line))
  20709. ((org-before-first-heading-p) (user-error "Not in a subtree"))
  20710. (t (outline-previous-visible-heading 1))))
  20711. (when up (while (and (> up 0) (org-up-heading-safe)) (cl-decf up)))
  20712. (if (called-interactively-p 'any)
  20713. (call-interactively 'org-mark-element)
  20714. (org-mark-element)))
  20715. (defun org-file-newer-than-p (file time)
  20716. "Non-nil if FILE is newer than TIME.
  20717. FILE is a filename, as a string, TIME is a list of integers, as
  20718. returned by, e.g., `current-time'."
  20719. (and (file-exists-p file)
  20720. ;; Only compare times up to whole seconds as some file-systems
  20721. ;; (e.g. HFS+) do not retain any finer granularity. As
  20722. ;; a consequence, make sure we return non-nil when the two
  20723. ;; times are equal.
  20724. (not (time-less-p (cl-subseq (nth 5 (file-attributes file)) 0 2)
  20725. (cl-subseq time 0 2)))))
  20726. (defun org-compile-file (source process ext &optional err-msg log-buf spec)
  20727. "Compile a SOURCE file using PROCESS.
  20728. PROCESS is either a function or a list of shell commands, as
  20729. strings. EXT is a file extension, without the leading dot, as
  20730. a string. It is used to check if the process actually succeeded.
  20731. PROCESS must create a file with the same base name and directory
  20732. as SOURCE, but ending with EXT. The function then returns its
  20733. filename. Otherwise, it raises an error. The error message can
  20734. then be refined by providing string ERR-MSG, which is appended to
  20735. the standard message.
  20736. If PROCESS is a function, it is called with a single argument:
  20737. the SOURCE file.
  20738. If it is a list of commands, each of them is called using
  20739. `shell-command'. By default, in each command, %b, %f, %F, %o and
  20740. %O are replaced with, respectively, SOURCE base name, name, full
  20741. name, directory and absolute output file name. It is possible,
  20742. however, to use more place-holders by specifying them in optional
  20743. argument SPEC, as an alist following the pattern
  20744. (CHARACTER . REPLACEMENT-STRING).
  20745. When PROCESS is a list of commands, optional argument LOG-BUF can
  20746. be set to a buffer or a buffer name. `shell-command' then uses
  20747. it for output."
  20748. (let* ((base-name (file-name-base source))
  20749. (full-name (file-truename source))
  20750. (out-dir (or (file-name-directory source) "./"))
  20751. (output (expand-file-name (concat base-name "." ext) out-dir))
  20752. (time (current-time))
  20753. (err-msg (if (stringp err-msg) (concat ". " err-msg) "")))
  20754. (save-window-excursion
  20755. (pcase process
  20756. ((pred functionp) (funcall process (shell-quote-argument source)))
  20757. ((pred consp)
  20758. (let ((log-buf (and log-buf (get-buffer-create log-buf)))
  20759. (spec (append spec
  20760. `((?b . ,(shell-quote-argument base-name))
  20761. (?f . ,(shell-quote-argument source))
  20762. (?F . ,(shell-quote-argument full-name))
  20763. (?o . ,(shell-quote-argument out-dir))
  20764. (?O . ,(shell-quote-argument output))))))
  20765. (dolist (command process)
  20766. (shell-command (format-spec command spec) log-buf))))
  20767. (_ (error "No valid command to process %S%s" source err-msg))))
  20768. ;; Check for process failure. Output file is expected to be
  20769. ;; located in the same directory as SOURCE.
  20770. (unless (org-file-newer-than-p output time)
  20771. (error (format "File %S wasn't produced%s" output err-msg)))
  20772. output))
  20773. ;;; Indentation
  20774. (defun org--get-expected-indentation (element contentsp)
  20775. "Expected indentation column for current line, according to ELEMENT.
  20776. ELEMENT is an element containing point. CONTENTSP is non-nil
  20777. when indentation is to be computed according to contents of
  20778. ELEMENT."
  20779. (let ((type (org-element-type element))
  20780. (start (org-element-property :begin element))
  20781. (post-affiliated (org-element-property :post-affiliated element)))
  20782. (org-with-wide-buffer
  20783. (cond
  20784. (contentsp
  20785. (cl-case type
  20786. ((diary-sexp footnote-definition) 0)
  20787. ((headline inlinetask nil)
  20788. (if (not org-adapt-indentation) 0
  20789. (let ((level (org-current-level)))
  20790. (if level (1+ level) 0))))
  20791. ((item plain-list) (org-list-item-body-column post-affiliated))
  20792. (t
  20793. (goto-char start)
  20794. (org-get-indentation))))
  20795. ((memq type '(headline inlinetask nil))
  20796. (if (save-excursion (beginning-of-line) (looking-at "[ \t]*$"))
  20797. (org--get-expected-indentation element t)
  20798. 0))
  20799. ((memq type '(diary-sexp footnote-definition)) 0)
  20800. ;; First paragraph of a footnote definition or an item.
  20801. ;; Indent like parent.
  20802. ((< (line-beginning-position) start)
  20803. (org--get-expected-indentation
  20804. (org-element-property :parent element) t))
  20805. ;; At first line: indent according to previous sibling, if any,
  20806. ;; ignoring footnote definitions and inline tasks, or parent's
  20807. ;; contents.
  20808. ((= (line-beginning-position) start)
  20809. (catch 'exit
  20810. (while t
  20811. (if (= (point-min) start) (throw 'exit 0)
  20812. (goto-char (1- start))
  20813. (let* ((previous (org-element-at-point))
  20814. (parent previous))
  20815. (while (and parent (<= (org-element-property :end parent) start))
  20816. (setq previous parent
  20817. parent (org-element-property :parent parent)))
  20818. (cond
  20819. ((not previous) (throw 'exit 0))
  20820. ((> (org-element-property :end previous) start)
  20821. (throw 'exit (org--get-expected-indentation previous t)))
  20822. ((memq (org-element-type previous)
  20823. '(footnote-definition inlinetask))
  20824. (setq start (org-element-property :begin previous)))
  20825. (t (goto-char (org-element-property :begin previous))
  20826. (throw 'exit
  20827. (if (bolp) (org-get-indentation)
  20828. ;; At first paragraph in an item or
  20829. ;; a footnote definition.
  20830. (org--get-expected-indentation
  20831. (org-element-property :parent previous) t))))))))))
  20832. ;; Otherwise, move to the first non-blank line above.
  20833. (t
  20834. (beginning-of-line)
  20835. (let ((pos (point)))
  20836. (skip-chars-backward " \r\t\n")
  20837. (cond
  20838. ;; Two blank lines end a footnote definition or a plain
  20839. ;; list. When we indent an empty line after them, the
  20840. ;; containing list or footnote definition is over, so it
  20841. ;; qualifies as a previous sibling. Therefore, we indent
  20842. ;; like its first line.
  20843. ((and (memq type '(footnote-definition plain-list))
  20844. (> (count-lines (point) pos) 2))
  20845. (goto-char start)
  20846. (org-get-indentation))
  20847. ;; Line above is the first one of a paragraph at the
  20848. ;; beginning of an item or a footnote definition. Indent
  20849. ;; like parent.
  20850. ((< (line-beginning-position) start)
  20851. (org--get-expected-indentation
  20852. (org-element-property :parent element) t))
  20853. ;; Line above is the beginning of an element, i.e., point
  20854. ;; was originally on the blank lines between element's start
  20855. ;; and contents.
  20856. ((= (line-beginning-position) post-affiliated)
  20857. (org--get-expected-indentation element t))
  20858. ;; POS is after contents in a greater element. Indent like
  20859. ;; the beginning of the element.
  20860. ;;
  20861. ;; As a special case, if point is at the end of a footnote
  20862. ;; definition or an item, indent like the very last element
  20863. ;; within. If that last element is an item, indent like its
  20864. ;; contents.
  20865. ((and (not (eq type 'paragraph))
  20866. (let ((cend (org-element-property :contents-end element)))
  20867. (and cend (<= cend pos))))
  20868. (if (memq type '(footnote-definition item plain-list))
  20869. (let ((last (org-element-at-point)))
  20870. (org--get-expected-indentation
  20871. last (eq (org-element-type last) 'item)))
  20872. (goto-char start)
  20873. (org-get-indentation)))
  20874. ;; In any other case, indent like the current line.
  20875. (t (org-get-indentation)))))))))
  20876. (defun org--align-node-property ()
  20877. "Align node property at point.
  20878. Alignment is done according to `org-property-format', which see."
  20879. (when (save-excursion
  20880. (beginning-of-line)
  20881. (looking-at org-property-re))
  20882. (replace-match
  20883. (concat (match-string 4)
  20884. (org-trim
  20885. (format org-property-format (match-string 1) (match-string 3))))
  20886. t t)))
  20887. (defun org-indent-line ()
  20888. "Indent line depending on context.
  20889. Indentation is done according to the following rules:
  20890. - Footnote definitions, diary sexps, headlines and inline tasks
  20891. have to start at column 0.
  20892. - On the very first line of an element, consider, in order, the
  20893. next rules until one matches:
  20894. 1. If there's a sibling element before, ignoring footnote
  20895. definitions and inline tasks, indent like its first line.
  20896. 2. If element has a parent, indent like its contents. More
  20897. precisely, if parent is an item, indent after the
  20898. description part, if any, or the bullet (see
  20899. `org-list-description-max-indent'). Else, indent like
  20900. parent's first line.
  20901. 3. Otherwise, indent relatively to current level, if
  20902. `org-adapt-indentation' is non-nil, or to left margin.
  20903. - On a blank line at the end of an element, indent according to
  20904. the type of the element. More precisely
  20905. 1. If element is a plain list, an item, or a footnote
  20906. definition, indent like the very last element within.
  20907. 2. If element is a paragraph, indent like its last non blank
  20908. line.
  20909. 3. Otherwise, indent like its very first line.
  20910. - In the code part of a source block, use language major mode
  20911. to indent current line if `org-src-tab-acts-natively' is
  20912. non-nil. If it is nil, do nothing.
  20913. - Otherwise, indent like the first non-blank line above.
  20914. The function doesn't indent an item as it could break the whole
  20915. list structure. Instead, use \\<org-mode-map>`\\[org-shiftmetaleft]' or \
  20916. `\\[org-shiftmetaright]'.
  20917. Also align node properties according to `org-property-format'."
  20918. (interactive)
  20919. (cond
  20920. (orgstruct-is-++
  20921. (let ((indent-line-function
  20922. (cl-cadadr (assq 'indent-line-function org-fb-vars))))
  20923. (indent-according-to-mode)))
  20924. ((org-at-heading-p) 'noindent)
  20925. (t
  20926. (let* ((element (save-excursion (beginning-of-line) (org-element-at-point)))
  20927. (type (org-element-type element)))
  20928. (cond ((and (memq type '(plain-list item))
  20929. (= (line-beginning-position)
  20930. (org-element-property :post-affiliated element)))
  20931. 'noindent)
  20932. ((and (eq type 'src-block)
  20933. org-src-tab-acts-natively
  20934. (> (line-beginning-position)
  20935. (org-element-property :post-affiliated element))
  20936. (< (line-beginning-position)
  20937. (org-with-wide-buffer
  20938. (goto-char (org-element-property :end element))
  20939. (skip-chars-backward " \r\t\n")
  20940. (line-beginning-position))))
  20941. (org-babel-do-key-sequence-in-edit-buffer (kbd "TAB")))
  20942. (t
  20943. (let ((column (org--get-expected-indentation element nil)))
  20944. ;; Preserve current column.
  20945. (if (<= (current-column) (current-indentation))
  20946. (indent-line-to column)
  20947. (save-excursion (indent-line-to column))))
  20948. ;; Align node property. Also preserve current column.
  20949. (when (eq type 'node-property)
  20950. (let ((column (current-column)))
  20951. (org--align-node-property)
  20952. (org-move-to-column column)))))))))
  20953. (defun org-indent-region (start end)
  20954. "Indent each non-blank line in the region.
  20955. Called from a program, START and END specify the region to
  20956. indent. The function will not indent contents of example blocks,
  20957. verse blocks and export blocks as leading white spaces are
  20958. assumed to be significant there."
  20959. (interactive "r")
  20960. (save-excursion
  20961. (goto-char start)
  20962. (skip-chars-forward " \r\t\n")
  20963. (unless (eobp) (beginning-of-line))
  20964. (let ((indent-to
  20965. (lambda (ind pos)
  20966. ;; Set IND as indentation for all lines between point and
  20967. ;; POS. Blank lines are ignored. Leave point after POS
  20968. ;; once done.
  20969. (let ((limit (copy-marker pos)))
  20970. (while (< (point) limit)
  20971. (unless (looking-at-p "[ \t]*$") (indent-line-to ind))
  20972. (forward-line))
  20973. (set-marker limit nil))))
  20974. (end (copy-marker end)))
  20975. (while (< (point) end)
  20976. (if (or (looking-at-p " \r\t\n") (org-at-heading-p)) (forward-line)
  20977. (let* ((element (org-element-at-point))
  20978. (type (org-element-type element))
  20979. (element-end (copy-marker (org-element-property :end element)))
  20980. (ind (org--get-expected-indentation element nil)))
  20981. (cond
  20982. ((or (memq type '(paragraph table table-row))
  20983. (not (or (org-element-property :contents-begin element)
  20984. (memq type
  20985. '(example-block export-block src-block)))))
  20986. ;; Elements here are indented as a single block. Also
  20987. ;; align node properties.
  20988. (when (eq type 'node-property)
  20989. (org--align-node-property)
  20990. (beginning-of-line))
  20991. (funcall indent-to ind (min element-end end)))
  20992. (t
  20993. ;; Elements in this category consist of three parts:
  20994. ;; before the contents, the contents, and after the
  20995. ;; contents. The contents are treated specially,
  20996. ;; according to the element type, or not indented at
  20997. ;; all. Other parts are indented as a single block.
  20998. (let* ((post (copy-marker
  20999. (org-element-property :post-affiliated element)))
  21000. (cbeg
  21001. (copy-marker
  21002. (cond
  21003. ((not (org-element-property :contents-begin element))
  21004. ;; Fake contents for source blocks.
  21005. (org-with-wide-buffer
  21006. (goto-char post)
  21007. (forward-line)
  21008. (point)))
  21009. ((memq type '(footnote-definition item plain-list))
  21010. ;; Contents in these elements could start on
  21011. ;; the same line as the beginning of the
  21012. ;; element. Make sure we start indenting
  21013. ;; from the second line.
  21014. (org-with-wide-buffer
  21015. (goto-char post)
  21016. (end-of-line)
  21017. (skip-chars-forward " \r\t\n")
  21018. (if (eobp) (point) (line-beginning-position))))
  21019. (t (org-element-property :contents-begin element)))))
  21020. (cend (copy-marker
  21021. (or (org-element-property :contents-end element)
  21022. ;; Fake contents for source blocks.
  21023. (org-with-wide-buffer
  21024. (goto-char element-end)
  21025. (skip-chars-backward " \r\t\n")
  21026. (line-beginning-position)))
  21027. t)))
  21028. ;; Do not change items indentation individually as it
  21029. ;; might break the list as a whole. On the other
  21030. ;; hand, when at a plain list, indent it as a whole.
  21031. (cond ((eq type 'plain-list)
  21032. (let ((offset (- ind (org-get-indentation))))
  21033. (unless (zerop offset)
  21034. (indent-rigidly (org-element-property :begin element)
  21035. (org-element-property :end element)
  21036. offset))
  21037. (goto-char cbeg)))
  21038. ((eq type 'item) (goto-char cbeg))
  21039. (t (funcall indent-to ind (min cbeg end))))
  21040. (when (< (point) end)
  21041. (cl-case type
  21042. ((example-block export-block verse-block))
  21043. (src-block
  21044. ;; In a source block, indent source code
  21045. ;; according to language major mode, but only if
  21046. ;; `org-src-tab-acts-natively' is non-nil.
  21047. (when (and (< (point) end) org-src-tab-acts-natively)
  21048. (ignore-errors
  21049. (org-babel-do-in-edit-buffer
  21050. (indent-region (point-min) (point-max))))))
  21051. (t (org-indent-region (point) (min cend end))))
  21052. (goto-char (min cend end))
  21053. (when (< (point) end)
  21054. (funcall indent-to ind (min element-end end))))
  21055. (set-marker post nil)
  21056. (set-marker cbeg nil)
  21057. (set-marker cend nil))))
  21058. (set-marker element-end nil))))
  21059. (set-marker end nil))))
  21060. (defun org-indent-drawer ()
  21061. "Indent the drawer at point."
  21062. (interactive)
  21063. (unless (save-excursion
  21064. (beginning-of-line)
  21065. (looking-at-p org-drawer-regexp))
  21066. (user-error "Not at a drawer"))
  21067. (let ((element (org-element-at-point)))
  21068. (unless (memq (org-element-type element) '(drawer property-drawer))
  21069. (user-error "Not at a drawer"))
  21070. (org-with-wide-buffer
  21071. (org-indent-region (org-element-property :begin element)
  21072. (org-element-property :end element))))
  21073. (message "Drawer at point indented"))
  21074. (defun org-indent-block ()
  21075. "Indent the block at point."
  21076. (interactive)
  21077. (unless (save-excursion
  21078. (beginning-of-line)
  21079. (let ((case-fold-search t))
  21080. (looking-at-p "[ \t]*#\\+\\(begin\\|end\\)_")))
  21081. (user-error "Not at a block"))
  21082. (let ((element (org-element-at-point)))
  21083. (unless (memq (org-element-type element)
  21084. '(comment-block center-block dynamic-block example-block
  21085. export-block quote-block special-block
  21086. src-block verse-block))
  21087. (user-error "Not at a block"))
  21088. (org-with-wide-buffer
  21089. (org-indent-region (org-element-property :begin element)
  21090. (org-element-property :end element))))
  21091. (message "Block at point indented"))
  21092. ;;; Filling
  21093. ;; We use our own fill-paragraph and auto-fill functions.
  21094. ;; `org-fill-paragraph' relies on adaptive filling and context
  21095. ;; checking. Appropriate `fill-prefix' is computed with
  21096. ;; `org-adaptive-fill-function'.
  21097. ;; `org-auto-fill-function' takes care of auto-filling. It calls
  21098. ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
  21099. ;; `org-adaptive-fill-function' value. Internally,
  21100. ;; `org-comment-line-break-function' breaks the line.
  21101. ;; `org-setup-filling' installs filling and auto-filling related
  21102. ;; variables during `org-mode' initialization.
  21103. (defvar org-element-paragraph-separate) ; org-element.el
  21104. (defun org-setup-filling ()
  21105. (require 'org-element)
  21106. ;; Prevent auto-fill from inserting unwanted new items.
  21107. (when (boundp 'fill-nobreak-predicate)
  21108. (setq-local
  21109. fill-nobreak-predicate
  21110. (org-uniquify
  21111. (append fill-nobreak-predicate
  21112. '(org-fill-line-break-nobreak-p
  21113. org-fill-paragraph-with-timestamp-nobreak-p)))))
  21114. (let ((paragraph-ending (substring org-element-paragraph-separate 1)))
  21115. (setq-local paragraph-start paragraph-ending)
  21116. (setq-local paragraph-separate paragraph-ending))
  21117. (setq-local fill-paragraph-function 'org-fill-paragraph)
  21118. (setq-local auto-fill-inhibit-regexp nil)
  21119. (setq-local adaptive-fill-function 'org-adaptive-fill-function)
  21120. (setq-local normal-auto-fill-function 'org-auto-fill-function)
  21121. (setq-local comment-line-break-function 'org-comment-line-break-function))
  21122. (defun org-fill-line-break-nobreak-p ()
  21123. "Non-nil when a new line at point would create an Org line break."
  21124. (save-excursion
  21125. (skip-chars-backward "[ \t]")
  21126. (skip-chars-backward "\\\\")
  21127. (looking-at "\\\\\\\\\\($\\|[^\\\\]\\)")))
  21128. (defun org-fill-paragraph-with-timestamp-nobreak-p ()
  21129. "Non-nil when a new line at point would split a timestamp."
  21130. (and (org-at-timestamp-p t)
  21131. (not (looking-at org-ts-regexp-both))))
  21132. (declare-function message-in-body-p "message" ())
  21133. (defvar orgtbl-line-start-regexp) ; From org-table.el
  21134. (defun org-adaptive-fill-function ()
  21135. "Compute a fill prefix for the current line.
  21136. Return fill prefix, as a string, or nil if current line isn't
  21137. meant to be filled. For convenience, if `adaptive-fill-regexp'
  21138. matches in paragraphs or comments, use it."
  21139. (catch 'exit
  21140. (when (derived-mode-p 'message-mode)
  21141. (save-excursion
  21142. (beginning-of-line)
  21143. (cond ((not (message-in-body-p)) (throw 'exit nil))
  21144. ((looking-at-p org-table-line-regexp) (throw 'exit nil))
  21145. ((looking-at message-cite-prefix-regexp)
  21146. (throw 'exit (match-string-no-properties 0)))
  21147. ((looking-at org-outline-regexp)
  21148. (throw 'exit (make-string (length (match-string 0)) ?\s))))))
  21149. (org-with-wide-buffer
  21150. (unless (org-at-heading-p)
  21151. (let* ((p (line-beginning-position))
  21152. (element (save-excursion
  21153. (beginning-of-line)
  21154. (org-element-at-point)))
  21155. (type (org-element-type element))
  21156. (post-affiliated (org-element-property :post-affiliated element)))
  21157. (unless (< p post-affiliated)
  21158. (cl-case type
  21159. (comment
  21160. (save-excursion
  21161. (beginning-of-line)
  21162. (looking-at "[ \t]*")
  21163. (concat (match-string 0) "# ")))
  21164. (footnote-definition "")
  21165. ((item plain-list)
  21166. (make-string (org-list-item-body-column post-affiliated) ?\s))
  21167. (paragraph
  21168. ;; Fill prefix is usually the same as the current line,
  21169. ;; unless the paragraph is at the beginning of an item.
  21170. (let ((parent (org-element-property :parent element)))
  21171. (save-excursion
  21172. (beginning-of-line)
  21173. (cond ((eq (org-element-type parent) 'item)
  21174. (make-string (org-list-item-body-column
  21175. (org-element-property :begin parent))
  21176. ?\s))
  21177. ((and adaptive-fill-regexp
  21178. ;; Locally disable
  21179. ;; `adaptive-fill-function' to let
  21180. ;; `fill-context-prefix' handle
  21181. ;; `adaptive-fill-regexp' variable.
  21182. (let (adaptive-fill-function)
  21183. (fill-context-prefix
  21184. post-affiliated
  21185. (org-element-property :end element)))))
  21186. ((looking-at "[ \t]+") (match-string 0))
  21187. (t "")))))
  21188. (comment-block
  21189. ;; Only fill contents if P is within block boundaries.
  21190. (let* ((cbeg (save-excursion (goto-char post-affiliated)
  21191. (forward-line)
  21192. (point)))
  21193. (cend (save-excursion
  21194. (goto-char (org-element-property :end element))
  21195. (skip-chars-backward " \r\t\n")
  21196. (line-beginning-position))))
  21197. (when (and (>= p cbeg) (< p cend))
  21198. (if (save-excursion (beginning-of-line) (looking-at "[ \t]+"))
  21199. (match-string 0)
  21200. "")))))))))))
  21201. (declare-function message-goto-body "message" ())
  21202. (defvar message-cite-prefix-regexp) ; From message.el
  21203. (defun org-fill-paragraph (&optional justify)
  21204. "Fill element at point, when applicable.
  21205. This function only applies to comment blocks, comments, example
  21206. blocks and paragraphs. Also, as a special case, re-align table
  21207. when point is at one.
  21208. If JUSTIFY is non-nil (interactively, with prefix argument),
  21209. justify as well. If `sentence-end-double-space' is non-nil, then
  21210. period followed by one space does not end a sentence, so don't
  21211. break a line there. The variable `fill-column' controls the
  21212. width for filling.
  21213. For convenience, when point is at a plain list, an item or
  21214. a footnote definition, try to fill the first paragraph within."
  21215. (interactive)
  21216. (if (and (derived-mode-p 'message-mode)
  21217. (or (not (message-in-body-p))
  21218. (save-excursion (move-beginning-of-line 1)
  21219. (looking-at message-cite-prefix-regexp))))
  21220. ;; First ensure filling is correct in message-mode.
  21221. (let ((fill-paragraph-function
  21222. (cl-cadadr (assq 'fill-paragraph-function org-fb-vars)))
  21223. (fill-prefix (cl-cadadr (assq 'fill-prefix org-fb-vars)))
  21224. (paragraph-start (cl-cadadr (assq 'paragraph-start org-fb-vars)))
  21225. (paragraph-separate
  21226. (cl-cadadr (assq 'paragraph-separate org-fb-vars))))
  21227. (fill-paragraph nil))
  21228. (with-syntax-table org-mode-transpose-word-syntax-table
  21229. ;; Move to end of line in order to get the first paragraph
  21230. ;; within a plain list or a footnote definition.
  21231. (let ((element (save-excursion
  21232. (end-of-line)
  21233. (or (ignore-errors (org-element-at-point))
  21234. (user-error "An element cannot be parsed line %d"
  21235. (line-number-at-pos (point)))))))
  21236. ;; First check if point is in a blank line at the beginning of
  21237. ;; the buffer. In that case, ignore filling.
  21238. (cl-case (org-element-type element)
  21239. ;; Use major mode filling function is src blocks.
  21240. (src-block (org-babel-do-key-sequence-in-edit-buffer (kbd "M-q")))
  21241. ;; Align Org tables, leave table.el tables as-is.
  21242. (table-row (org-table-align) t)
  21243. (table
  21244. (when (eq (org-element-property :type element) 'org)
  21245. (save-excursion
  21246. (goto-char (org-element-property :post-affiliated element))
  21247. (org-table-align)))
  21248. t)
  21249. (paragraph
  21250. ;; Paragraphs may contain `line-break' type objects.
  21251. (let ((beg (max (point-min)
  21252. (org-element-property :contents-begin element)))
  21253. (end (min (point-max)
  21254. (org-element-property :contents-end element))))
  21255. ;; Do nothing if point is at an affiliated keyword.
  21256. (if (< (line-end-position) beg) t
  21257. (when (derived-mode-p 'message-mode)
  21258. ;; In `message-mode', do not fill following citation
  21259. ;; in current paragraph nor text before message body.
  21260. (let ((body-start (save-excursion (message-goto-body))))
  21261. (when body-start (setq beg (max body-start beg))))
  21262. (when (save-excursion
  21263. (re-search-forward
  21264. (concat "^" message-cite-prefix-regexp) end t))
  21265. (setq end (match-beginning 0))))
  21266. ;; Fill paragraph, taking line breaks into account.
  21267. (save-excursion
  21268. (goto-char beg)
  21269. (let ((cuts (list beg)))
  21270. (while (re-search-forward "\\\\\\\\[ \t]*\n" end t)
  21271. (when (eq 'line-break
  21272. (org-element-type
  21273. (save-excursion (backward-char)
  21274. (org-element-context))))
  21275. (push (point) cuts)))
  21276. (dolist (c (delq end cuts))
  21277. (fill-region-as-paragraph c end justify)
  21278. (setq end c))))
  21279. t)))
  21280. ;; Contents of `comment-block' type elements should be
  21281. ;; filled as plain text, but only if point is within block
  21282. ;; markers.
  21283. (comment-block
  21284. (let* ((case-fold-search t)
  21285. (beg (save-excursion
  21286. (goto-char (org-element-property :begin element))
  21287. (re-search-forward "^[ \t]*#\\+begin_comment" nil t)
  21288. (forward-line)
  21289. (point)))
  21290. (end (save-excursion
  21291. (goto-char (org-element-property :end element))
  21292. (re-search-backward "^[ \t]*#\\+end_comment" nil t)
  21293. (line-beginning-position))))
  21294. (if (or (< (point) beg) (> (point) end)) t
  21295. (fill-region-as-paragraph
  21296. (save-excursion (end-of-line)
  21297. (re-search-backward "^[ \t]*$" beg 'move)
  21298. (line-beginning-position))
  21299. (save-excursion (beginning-of-line)
  21300. (re-search-forward "^[ \t]*$" end 'move)
  21301. (line-beginning-position))
  21302. justify))))
  21303. ;; Fill comments.
  21304. (comment
  21305. (let ((begin (org-element-property :post-affiliated element))
  21306. (end (org-element-property :end element)))
  21307. (when (and (>= (point) begin) (<= (point) end))
  21308. (let ((begin (save-excursion
  21309. (end-of-line)
  21310. (if (re-search-backward "^[ \t]*#[ \t]*$" begin t)
  21311. (progn (forward-line) (point))
  21312. begin)))
  21313. (end (save-excursion
  21314. (end-of-line)
  21315. (if (re-search-forward "^[ \t]*#[ \t]*$" end 'move)
  21316. (1- (line-beginning-position))
  21317. (skip-chars-backward " \r\t\n")
  21318. (line-end-position)))))
  21319. ;; Do not fill comments when at a blank line.
  21320. (when (> end begin)
  21321. (let ((fill-prefix
  21322. (save-excursion
  21323. (beginning-of-line)
  21324. (looking-at "[ \t]*#")
  21325. (let ((comment-prefix (match-string 0)))
  21326. (goto-char (match-end 0))
  21327. (if (looking-at adaptive-fill-regexp)
  21328. (concat comment-prefix (match-string 0))
  21329. (concat comment-prefix " "))))))
  21330. (save-excursion
  21331. (fill-region-as-paragraph begin end justify))))))
  21332. t))
  21333. ;; Ignore every other element.
  21334. (otherwise t))))))
  21335. (defun org-auto-fill-function ()
  21336. "Auto-fill function."
  21337. ;; Check if auto-filling is meaningful.
  21338. (let ((fc (current-fill-column)))
  21339. (when (and fc (> (current-column) fc))
  21340. (let* ((fill-prefix (org-adaptive-fill-function))
  21341. ;; Enforce empty fill prefix, if required. Otherwise, it
  21342. ;; will be computed again.
  21343. (adaptive-fill-mode (not (equal fill-prefix ""))))
  21344. (when fill-prefix (do-auto-fill))))))
  21345. (defun org-comment-line-break-function (&optional soft)
  21346. "Break line at point and indent, continuing comment if within one.
  21347. The inserted newline is marked hard if variable
  21348. `use-hard-newlines' is true, unless optional argument SOFT is
  21349. non-nil."
  21350. (if soft (insert-and-inherit ?\n) (newline 1))
  21351. (save-excursion (forward-char -1) (delete-horizontal-space))
  21352. (delete-horizontal-space)
  21353. (indent-to-left-margin)
  21354. (insert-before-markers-and-inherit fill-prefix))
  21355. ;;; Fixed Width Areas
  21356. (defun org-toggle-fixed-width ()
  21357. "Toggle fixed-width markup.
  21358. Add or remove fixed-width markup on current line, whenever it
  21359. makes sense. Return an error otherwise.
  21360. If a region is active and if it contains only fixed-width areas
  21361. or blank lines, remove all fixed-width markup in it. If the
  21362. region contains anything else, convert all non-fixed-width lines
  21363. to fixed-width ones.
  21364. Blank lines at the end of the region are ignored unless the
  21365. region only contains such lines."
  21366. (interactive)
  21367. (if (not (org-region-active-p))
  21368. ;; No region:
  21369. ;;
  21370. ;; Remove fixed width marker only in a fixed-with element.
  21371. ;;
  21372. ;; Add fixed width maker in paragraphs, in blank lines after
  21373. ;; elements or at the beginning of a headline or an inlinetask,
  21374. ;; and before any one-line elements (e.g., a clock).
  21375. (progn
  21376. (beginning-of-line)
  21377. (let* ((element (org-element-at-point))
  21378. (type (org-element-type element)))
  21379. (cond
  21380. ((and (eq type 'fixed-width)
  21381. (looking-at "[ \t]*\\(:\\(?: \\|$\\)\\)"))
  21382. (replace-match
  21383. "" nil nil nil (if (= (line-end-position) (match-end 0)) 0 1)))
  21384. ((and (memq type '(babel-call clock comment diary-sexp headline
  21385. horizontal-rule keyword paragraph
  21386. planning))
  21387. (<= (org-element-property :post-affiliated element) (point)))
  21388. (skip-chars-forward " \t")
  21389. (insert ": "))
  21390. ((and (looking-at-p "[ \t]*$")
  21391. (or (eq type 'inlinetask)
  21392. (save-excursion
  21393. (skip-chars-forward " \r\t\n")
  21394. (<= (org-element-property :end element) (point)))))
  21395. (delete-region (point) (line-end-position))
  21396. (org-indent-line)
  21397. (insert ": "))
  21398. (t (user-error "Cannot insert a fixed-width line here")))))
  21399. ;; Region active.
  21400. (let* ((begin (save-excursion
  21401. (goto-char (region-beginning))
  21402. (line-beginning-position)))
  21403. (end (copy-marker
  21404. (save-excursion
  21405. (goto-char (region-end))
  21406. (unless (eolp) (beginning-of-line))
  21407. (if (save-excursion (re-search-backward "\\S-" begin t))
  21408. (progn (skip-chars-backward " \r\t\n") (point))
  21409. (point)))))
  21410. (all-fixed-width-p
  21411. (catch 'not-all-p
  21412. (save-excursion
  21413. (goto-char begin)
  21414. (skip-chars-forward " \r\t\n")
  21415. (when (eobp) (throw 'not-all-p nil))
  21416. (while (< (point) end)
  21417. (let ((element (org-element-at-point)))
  21418. (if (eq (org-element-type element) 'fixed-width)
  21419. (goto-char (org-element-property :end element))
  21420. (throw 'not-all-p nil))))
  21421. t))))
  21422. (if all-fixed-width-p
  21423. (save-excursion
  21424. (goto-char begin)
  21425. (while (< (point) end)
  21426. (when (looking-at "[ \t]*\\(:\\(?: \\|$\\)\\)")
  21427. (replace-match
  21428. "" nil nil nil
  21429. (if (= (line-end-position) (match-end 0)) 0 1)))
  21430. (forward-line)))
  21431. (let ((min-ind (point-max)))
  21432. ;; Find minimum indentation across all lines.
  21433. (save-excursion
  21434. (goto-char begin)
  21435. (if (not (save-excursion (re-search-forward "\\S-" end t)))
  21436. (setq min-ind 0)
  21437. (catch 'zerop
  21438. (while (< (point) end)
  21439. (unless (looking-at-p "[ \t]*$")
  21440. (let ((ind (org-get-indentation)))
  21441. (setq min-ind (min min-ind ind))
  21442. (when (zerop ind) (throw 'zerop t))))
  21443. (forward-line)))))
  21444. ;; Loop over all lines and add fixed-width markup everywhere
  21445. ;; but in fixed-width lines.
  21446. (save-excursion
  21447. (goto-char begin)
  21448. (while (< (point) end)
  21449. (cond
  21450. ((org-at-heading-p)
  21451. (insert ": ")
  21452. (forward-line)
  21453. (while (and (< (point) end) (looking-at-p "[ \t]*$"))
  21454. (insert ":")
  21455. (forward-line)))
  21456. ((looking-at-p "[ \t]*:\\( \\|$\\)")
  21457. (let* ((element (org-element-at-point))
  21458. (element-end (org-element-property :end element)))
  21459. (if (eq (org-element-type element) 'fixed-width)
  21460. (progn (goto-char element-end)
  21461. (skip-chars-backward " \r\t\n")
  21462. (forward-line))
  21463. (let ((limit (min end element-end)))
  21464. (while (< (point) limit)
  21465. (org-move-to-column min-ind t)
  21466. (insert ": ")
  21467. (forward-line))))))
  21468. (t
  21469. (org-move-to-column min-ind t)
  21470. (insert ": ")
  21471. (forward-line)))))))
  21472. (set-marker end nil))))
  21473. ;;; Comments
  21474. ;; Org comments syntax is quite complex. It requires the entire line
  21475. ;; to be just a comment. Also, even with the right syntax at the
  21476. ;; beginning of line, some some elements (i.e. verse-block or
  21477. ;; example-block) don't accept comments. Usual Emacs comment commands
  21478. ;; cannot cope with those requirements. Therefore, Org replaces them.
  21479. ;; Org still relies on `comment-dwim', but cannot trust
  21480. ;; `comment-only-p'. So, `comment-region-function' and
  21481. ;; `uncomment-region-function' both point
  21482. ;; to`org-comment-or-uncomment-region'. Eventually,
  21483. ;; `org-insert-comment' takes care of insertion of comments at the
  21484. ;; beginning of line.
  21485. ;; `org-setup-comments-handling' install comments related variables
  21486. ;; during `org-mode' initialization.
  21487. (defun org-setup-comments-handling ()
  21488. (interactive)
  21489. (setq-local comment-use-syntax nil)
  21490. (setq-local comment-start "# ")
  21491. (setq-local comment-start-skip "^\\s-*#\\(?: \\|$\\)")
  21492. (setq-local comment-insert-comment-function 'org-insert-comment)
  21493. (setq-local comment-region-function 'org-comment-or-uncomment-region)
  21494. (setq-local uncomment-region-function 'org-comment-or-uncomment-region))
  21495. (defun org-insert-comment ()
  21496. "Insert an empty comment above current line.
  21497. If the line is empty, insert comment at its beginning. When
  21498. point is within a source block, comment according to the related
  21499. major mode."
  21500. (if (let ((element (org-element-at-point)))
  21501. (and (eq (org-element-type element) 'src-block)
  21502. (< (save-excursion
  21503. (goto-char (org-element-property :post-affiliated element))
  21504. (line-end-position))
  21505. (point))
  21506. (> (save-excursion
  21507. (goto-char (org-element-property :end element))
  21508. (skip-chars-backward " \r\t\n")
  21509. (line-beginning-position))
  21510. (point))))
  21511. (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
  21512. (beginning-of-line)
  21513. (if (looking-at "\\s-*$") (delete-region (point) (point-at-eol))
  21514. (open-line 1))
  21515. (org-indent-line)
  21516. (insert "# ")))
  21517. (defvar comment-empty-lines) ; From newcomment.el.
  21518. (defun org-comment-or-uncomment-region (beg end &rest _)
  21519. "Comment or uncomment each non-blank line in the region.
  21520. Uncomment each non-blank line between BEG and END if it only
  21521. contains commented lines. Otherwise, comment them. If region is
  21522. strictly within a source block, use appropriate comment syntax."
  21523. (if (let ((element (org-element-at-point)))
  21524. (and (eq (org-element-type element) 'src-block)
  21525. (< (save-excursion
  21526. (goto-char (org-element-property :post-affiliated element))
  21527. (line-end-position))
  21528. beg)
  21529. (>= (save-excursion
  21530. (goto-char (org-element-property :end element))
  21531. (skip-chars-backward " \r\t\n")
  21532. (line-beginning-position))
  21533. end)))
  21534. ;; Translate region boundaries for the Org buffer to the source
  21535. ;; buffer.
  21536. (let ((offset (- end beg)))
  21537. (save-excursion
  21538. (goto-char beg)
  21539. (org-babel-do-in-edit-buffer
  21540. (comment-or-uncomment-region (point) (+ offset (point))))))
  21541. (save-restriction
  21542. ;; Restrict region
  21543. (narrow-to-region (save-excursion (goto-char beg)
  21544. (skip-chars-forward " \r\t\n" end)
  21545. (line-beginning-position))
  21546. (save-excursion (goto-char end)
  21547. (skip-chars-backward " \r\t\n" beg)
  21548. (line-end-position)))
  21549. (let ((uncommentp
  21550. ;; UNCOMMENTP is non-nil when every non blank line between
  21551. ;; BEG and END is a comment.
  21552. (save-excursion
  21553. (goto-char (point-min))
  21554. (while (and (not (eobp))
  21555. (let ((element (org-element-at-point)))
  21556. (and (eq (org-element-type element) 'comment)
  21557. (goto-char (min (point-max)
  21558. (org-element-property
  21559. :end element)))))))
  21560. (eobp))))
  21561. (if uncommentp
  21562. ;; Only blank lines and comments in region: uncomment it.
  21563. (save-excursion
  21564. (goto-char (point-min))
  21565. (while (not (eobp))
  21566. (when (looking-at "[ \t]*\\(#\\(?: \\|$\\)\\)")
  21567. (replace-match "" nil nil nil 1))
  21568. (forward-line)))
  21569. ;; Comment each line in region.
  21570. (let ((min-indent (point-max)))
  21571. ;; First find the minimum indentation across all lines.
  21572. (save-excursion
  21573. (goto-char (point-min))
  21574. (while (and (not (eobp)) (not (zerop min-indent)))
  21575. (unless (looking-at "[ \t]*$")
  21576. (setq min-indent (min min-indent (current-indentation))))
  21577. (forward-line)))
  21578. ;; Then loop over all lines.
  21579. (save-excursion
  21580. (goto-char (point-min))
  21581. (while (not (eobp))
  21582. (unless (and (not comment-empty-lines) (looking-at "[ \t]*$"))
  21583. ;; Don't get fooled by invisible text (e.g. link path)
  21584. ;; when moving to column MIN-INDENT.
  21585. (let ((buffer-invisibility-spec nil))
  21586. (org-move-to-column min-indent t))
  21587. (insert comment-start))
  21588. (forward-line)))))))))
  21589. (defun org-comment-dwim (_arg)
  21590. "Call `comment-dwim' within a source edit buffer if needed."
  21591. (interactive "*P")
  21592. (if (org-in-src-block-p)
  21593. (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
  21594. (call-interactively 'comment-dwim)))
  21595. ;;; Timestamps API
  21596. ;; This section contains tools to operate on timestamp objects, as
  21597. ;; returned by, e.g. `org-element-context'.
  21598. (defun org-timestamp--to-internal-time (timestamp &optional end)
  21599. "Encode TIMESTAMP object into Emacs internal time.
  21600. Use end of date range or time range when END is non-nil."
  21601. (apply #'encode-time
  21602. (cons 0
  21603. (mapcar
  21604. (lambda (prop) (or (org-element-property prop timestamp) 0))
  21605. (if end '(:minute-end :hour-end :day-end :month-end :year-end)
  21606. '(:minute-start :hour-start :day-start :month-start
  21607. :year-start))))))
  21608. (defun org-timestamp-has-time-p (timestamp)
  21609. "Non-nil when TIMESTAMP has a time specified."
  21610. (org-element-property :hour-start timestamp))
  21611. (defun org-timestamp-format (timestamp format &optional end utc)
  21612. "Format a TIMESTAMP object into a string.
  21613. FORMAT is a format specifier to be passed to
  21614. `format-time-string'.
  21615. When optional argument END is non-nil, use end of date-range or
  21616. time-range, if possible.
  21617. When optional argument UTC is non-nil, time will be expressed as
  21618. Universal Time."
  21619. (format-time-string
  21620. format (org-timestamp--to-internal-time timestamp end)
  21621. (and utc t)))
  21622. (defun org-timestamp-split-range (timestamp &optional end)
  21623. "Extract a TIMESTAMP object from a date or time range.
  21624. END, when non-nil, means extract the end of the range.
  21625. Otherwise, extract its start.
  21626. Return a new timestamp object."
  21627. (let ((type (org-element-property :type timestamp)))
  21628. (if (memq type '(active inactive diary)) timestamp
  21629. (let ((split-ts (org-element-copy timestamp)))
  21630. ;; Set new type.
  21631. (org-element-put-property
  21632. split-ts :type (if (eq type 'active-range) 'active 'inactive))
  21633. ;; Copy start properties over end properties if END is
  21634. ;; non-nil. Otherwise, copy end properties over `start' ones.
  21635. (let ((p-alist '((:minute-start . :minute-end)
  21636. (:hour-start . :hour-end)
  21637. (:day-start . :day-end)
  21638. (:month-start . :month-end)
  21639. (:year-start . :year-end))))
  21640. (dolist (p-cell p-alist)
  21641. (org-element-put-property
  21642. split-ts
  21643. (funcall (if end #'car #'cdr) p-cell)
  21644. (org-element-property
  21645. (funcall (if end #'cdr #'car) p-cell) split-ts)))
  21646. ;; Eventually refresh `:raw-value'.
  21647. (org-element-put-property split-ts :raw-value nil)
  21648. (org-element-put-property
  21649. split-ts :raw-value (org-element-interpret-data split-ts)))))))
  21650. (defun org-timestamp-translate (timestamp &optional boundary)
  21651. "Translate TIMESTAMP object to custom format.
  21652. Format string is defined in `org-time-stamp-custom-formats',
  21653. which see.
  21654. When optional argument BOUNDARY is non-nil, it is either the
  21655. symbol `start' or `end'. In this case, only translate the
  21656. starting or ending part of TIMESTAMP if it is a date or time
  21657. range. Otherwise, translate both parts.
  21658. Return timestamp as-is if `org-display-custom-times' is nil or if
  21659. it has a `diary' type."
  21660. (let ((type (org-element-property :type timestamp)))
  21661. (if (or (not org-display-custom-times) (eq type 'diary))
  21662. (org-element-interpret-data timestamp)
  21663. (let ((fmt (funcall (if (org-timestamp-has-time-p timestamp) #'cdr #'car)
  21664. org-time-stamp-custom-formats)))
  21665. (if (and (not boundary) (memq type '(active-range inactive-range)))
  21666. (concat (org-timestamp-format timestamp fmt)
  21667. "--"
  21668. (org-timestamp-format timestamp fmt t))
  21669. (org-timestamp-format timestamp fmt (eq boundary 'end)))))))
  21670. ;;; Other stuff.
  21671. (defvar reftex-docstruct-symbol)
  21672. (defvar org--rds)
  21673. (defun org-reftex-citation ()
  21674. "Use reftex-citation to insert a citation into the buffer.
  21675. This looks for a line like
  21676. #+BIBLIOGRAPHY: foo plain option:-d
  21677. and derives from it that foo.bib is the bibliography file relevant
  21678. for this document. It then installs the necessary environment for RefTeX
  21679. to work in this buffer and calls `reftex-citation' to insert a citation
  21680. into the buffer.
  21681. Export of such citations to both LaTeX and HTML is handled by the contributed
  21682. package ox-bibtex by Taru Karttunen."
  21683. (interactive)
  21684. (let ((reftex-docstruct-symbol 'org--rds)
  21685. org--rds bib)
  21686. (org-with-wide-buffer
  21687. (let ((case-fold-search t)
  21688. (re "^[ \t]*#\\+BIBLIOGRAPHY:[ \t]+\\([^ \t\n]+\\)"))
  21689. (if (not (save-excursion
  21690. (or (re-search-forward re nil t)
  21691. (re-search-backward re nil t))))
  21692. (user-error "No bibliography defined in file")
  21693. (setq bib (concat (match-string 1) ".bib")
  21694. org--rds (list (list 'bib bib))))))
  21695. (call-interactively 'reftex-citation)))
  21696. ;;;; Functions extending outline functionality
  21697. (defun org-beginning-of-line (&optional n)
  21698. "Go to the beginning of the current visible line.
  21699. If this is a headline, and `org-special-ctrl-a/e' is set, ignore
  21700. tags on the first attempt, and only move to after the tags when
  21701. the cursor is already beyond the end of the headline.
  21702. With argument N not nil or 1, move forward N - 1 lines first."
  21703. (interactive "^p")
  21704. (let ((origin (point))
  21705. (special (pcase org-special-ctrl-a/e
  21706. (`(,C-a . ,_) C-a) (_ org-special-ctrl-a/e)))
  21707. deactivate-mark)
  21708. ;; First move to a visible line.
  21709. (if (bound-and-true-p visual-line-mode)
  21710. (beginning-of-visual-line n)
  21711. (move-beginning-of-line n)
  21712. ;; `move-beginning-of-line' may leave point after invisible
  21713. ;; characters if line starts with such of these (e.g., with
  21714. ;; a link at column 0). Really move to the beginning of the
  21715. ;; current visible line.
  21716. (beginning-of-line))
  21717. (cond
  21718. ;; No special behavior. Point is already at the beginning of
  21719. ;; a line, logical or visual.
  21720. ((not special))
  21721. ;; `beginning-of-visual-line' left point before logical beginning
  21722. ;; of line: point is at the beginning of a visual line. Bail
  21723. ;; out.
  21724. ((and (bound-and-true-p visual-line-mode) (not (bolp))))
  21725. ((let ((case-fold-search nil)) (looking-at org-complex-heading-regexp))
  21726. ;; At a headline, special position is before the title, but
  21727. ;; after any TODO keyword or priority cookie.
  21728. (let ((refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
  21729. (line-end-position)))
  21730. (bol (point)))
  21731. (if (eq special 'reversed)
  21732. (when (and (= origin bol) (eq last-command this-command))
  21733. (goto-char refpos))
  21734. (when (or (> origin refpos) (= origin bol))
  21735. (goto-char refpos)))))
  21736. ((and (looking-at org-list-full-item-re)
  21737. (memq (org-element-type (save-match-data (org-element-at-point)))
  21738. '(item plain-list)))
  21739. ;; Set special position at first white space character after
  21740. ;; bullet, and check-box, if any.
  21741. (let ((after-bullet
  21742. (let ((box (match-end 3)))
  21743. (cond ((not box) (match-end 1))
  21744. ((eq (char-after box) ?\s) (1+ box))
  21745. (t box)))))
  21746. (if (eq special 'reversed)
  21747. (when (and (= (point) origin) (eq last-command this-command))
  21748. (goto-char after-bullet))
  21749. (when (or (> origin after-bullet) (= (point) origin))
  21750. (goto-char after-bullet)))))
  21751. ;; No special context. Point is already at beginning of line.
  21752. (t nil))))
  21753. (defun org-end-of-line (&optional n)
  21754. "Go to the end of the line, but before ellipsis, if any.
  21755. If this is a headline, and `org-special-ctrl-a/e' is set, ignore
  21756. tags on the first attempt, and only move to after the tags when
  21757. the cursor is already beyond the end of the headline.
  21758. With argument N not nil or 1, move forward N - 1 lines first."
  21759. (interactive "^p")
  21760. (let ((origin (point))
  21761. (special (pcase org-special-ctrl-a/e
  21762. (`(,_ . ,C-e) C-e) (_ org-special-ctrl-a/e)))
  21763. deactivate-mark)
  21764. ;; First move to a visible line.
  21765. (if (bound-and-true-p visual-line-mode)
  21766. (beginning-of-visual-line n)
  21767. (move-beginning-of-line n))
  21768. (cond
  21769. ;; At a headline, with tags.
  21770. ((and special
  21771. (save-excursion
  21772. (beginning-of-line)
  21773. (let ((case-fold-search nil))
  21774. (looking-at org-complex-heading-regexp)))
  21775. (match-end 5))
  21776. (let ((tags (save-excursion
  21777. (goto-char (match-beginning 5))
  21778. (skip-chars-backward " \t")
  21779. (point)))
  21780. (visual-end (and (bound-and-true-p visual-line-mode)
  21781. (save-excursion
  21782. (end-of-visual-line)
  21783. (point)))))
  21784. ;; If `end-of-visual-line' brings us before end of line or
  21785. ;; even tags, i.e., the headline spans over multiple visual
  21786. ;; lines, move there.
  21787. (cond ((and visual-end
  21788. (< visual-end tags)
  21789. (<= origin visual-end))
  21790. (goto-char visual-end))
  21791. ((eq special 'reversed)
  21792. (if (and (= origin (line-end-position))
  21793. (eq this-command last-command))
  21794. (goto-char tags)
  21795. (end-of-line)))
  21796. (t
  21797. (if (or (< origin tags) (= origin (line-end-position)))
  21798. (goto-char tags)
  21799. (end-of-line))))))
  21800. ((bound-and-true-p visual-line-mode)
  21801. (let ((bol (line-beginning-position)))
  21802. (end-of-visual-line)
  21803. ;; If `end-of-visual-line' gets us past the ellipsis at the
  21804. ;; end of a line, backtrack and use `end-of-line' instead.
  21805. (when (/= bol (line-beginning-position))
  21806. (goto-char bol)
  21807. (end-of-line))))
  21808. (t (end-of-line)))))
  21809. (define-key org-mode-map "\C-a" 'org-beginning-of-line)
  21810. (define-key org-mode-map "\C-e" 'org-end-of-line)
  21811. (defun org-backward-sentence (&optional _arg)
  21812. "Go to beginning of sentence, or beginning of table field.
  21813. This will call `backward-sentence' or `org-table-beginning-of-field',
  21814. depending on context."
  21815. (interactive)
  21816. (let* ((element (org-element-at-point))
  21817. (contents-begin (org-element-property :contents-begin element))
  21818. (table (org-element-lineage element '(table) t)))
  21819. (if (and table
  21820. (> (point) contents-begin)
  21821. (<= (point) (org-element-property :contents-end table)))
  21822. (call-interactively #'org-table-beginning-of-field)
  21823. (save-restriction
  21824. (when (and contents-begin
  21825. (< (point-min) contents-begin)
  21826. (> (point) contents-begin))
  21827. (narrow-to-region contents-begin
  21828. (org-element-property :contents-end element)))
  21829. (call-interactively #'backward-sentence)))))
  21830. (defun org-forward-sentence (&optional _arg)
  21831. "Go to end of sentence, or end of table field.
  21832. This will call `forward-sentence' or `org-table-end-of-field',
  21833. depending on context."
  21834. (interactive)
  21835. (let* ((element (org-element-at-point))
  21836. (contents-end (org-element-property :contents-end element))
  21837. (table (org-element-lineage element '(table) t)))
  21838. (if (and table
  21839. (>= (point) (org-element-property :contents-begin table))
  21840. (< (point) contents-end))
  21841. (call-interactively #'org-table-end-of-field)
  21842. (save-restriction
  21843. (when (and contents-end
  21844. (> (point-max) contents-end)
  21845. ;; Skip blank lines between elements.
  21846. (< (org-element-property :end element)
  21847. (save-excursion (goto-char contents-end)
  21848. (skip-chars-forward " \r\t\n"))))
  21849. (narrow-to-region (org-element-property :contents-begin element)
  21850. contents-end))
  21851. (call-interactively #'forward-sentence)))))
  21852. (define-key org-mode-map "\M-a" 'org-backward-sentence)
  21853. (define-key org-mode-map "\M-e" 'org-forward-sentence)
  21854. (defun org-kill-line (&optional _arg)
  21855. "Kill line, to tags or end of line."
  21856. (interactive)
  21857. (cond
  21858. ((or (not org-special-ctrl-k)
  21859. (bolp)
  21860. (not (org-at-heading-p)))
  21861. (when (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
  21862. org-ctrl-k-protect-subtree
  21863. (or (eq org-ctrl-k-protect-subtree 'error)
  21864. (not (y-or-n-p "Kill hidden subtree along with headline? "))))
  21865. (user-error "C-k aborted as it would kill a hidden subtree"))
  21866. (call-interactively
  21867. (if (bound-and-true-p visual-line-mode) 'kill-visual-line 'kill-line)))
  21868. ((looking-at ".*?\\S-\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$")
  21869. (kill-region (point) (match-beginning 1))
  21870. (org-set-tags nil t))
  21871. (t (kill-region (point) (point-at-eol)))))
  21872. (define-key org-mode-map "\C-k" 'org-kill-line)
  21873. (defun org-yank (&optional arg)
  21874. "Yank. If the kill is a subtree, treat it specially.
  21875. This command will look at the current kill and check if is a single
  21876. subtree, or a series of subtrees[1]. If it passes the test, and if the
  21877. cursor is at the beginning of a line or after the stars of a currently
  21878. empty headline, then the yank is handled specially. How exactly depends
  21879. on the value of the following variables.
  21880. `org-yank-folded-subtrees'
  21881. By default, this variable is non-nil, which results in
  21882. subtree(s) being folded after insertion, except if doing so
  21883. would swallow text after the yanked text.
  21884. `org-yank-adjusted-subtrees'
  21885. When non-nil (the default value is nil), the subtree will be
  21886. promoted or demoted in order to fit into the local outline tree
  21887. structure, which means that the level will be adjusted so that it
  21888. becomes the smaller one of the two *visible* surrounding headings.
  21889. Any prefix to this command will cause `yank' to be called directly with
  21890. no special treatment. In particular, a simple `\\[universal-argument]' prefix \
  21891. will just
  21892. plainly yank the text as it is.
  21893. \[1] The test checks if the first non-white line is a heading
  21894. and if there are no other headings with fewer stars."
  21895. (interactive "P")
  21896. (org-yank-generic 'yank arg))
  21897. (defun org-yank-generic (command arg)
  21898. "Perform some yank-like command.
  21899. This function implements the behavior described in the `org-yank'
  21900. documentation. However, it has been generalized to work for any
  21901. interactive command with similar behavior."
  21902. ;; pretend to be command COMMAND
  21903. (setq this-command command)
  21904. (if arg
  21905. (call-interactively command)
  21906. (let ((subtreep ; is kill a subtree, and the yank position appropriate?
  21907. (and (org-kill-is-subtree-p)
  21908. (or (bolp)
  21909. (and (looking-at "[ \t]*$")
  21910. (string-match
  21911. "\\`\\*+\\'"
  21912. (buffer-substring (point-at-bol) (point)))))))
  21913. swallowp)
  21914. (cond
  21915. ((and subtreep org-yank-folded-subtrees)
  21916. (let ((beg (point))
  21917. end)
  21918. (if (and subtreep org-yank-adjusted-subtrees)
  21919. (org-paste-subtree nil nil 'for-yank)
  21920. (call-interactively command))
  21921. (setq end (point))
  21922. (goto-char beg)
  21923. (when (and (bolp) subtreep
  21924. (not (setq swallowp
  21925. (org-yank-folding-would-swallow-text beg end))))
  21926. (org-with-limited-levels
  21927. (or (looking-at org-outline-regexp)
  21928. (re-search-forward org-outline-regexp-bol end t))
  21929. (while (and (< (point) end) (looking-at org-outline-regexp))
  21930. (outline-hide-subtree)
  21931. (org-cycle-show-empty-lines 'folded)
  21932. (condition-case nil
  21933. (outline-forward-same-level 1)
  21934. (error (goto-char end))))))
  21935. (when swallowp
  21936. (message
  21937. "Inserted text not folded because that would swallow text"))
  21938. (goto-char end)
  21939. (skip-chars-forward " \t\n\r")
  21940. (beginning-of-line 1)
  21941. (push-mark beg 'nomsg)))
  21942. ((and subtreep org-yank-adjusted-subtrees)
  21943. (let ((beg (point-at-bol)))
  21944. (org-paste-subtree nil nil 'for-yank)
  21945. (push-mark beg 'nomsg)))
  21946. (t
  21947. (call-interactively command))))))
  21948. (defun org-yank-folding-would-swallow-text (beg end)
  21949. "Would hide-subtree at BEG swallow any text after END?"
  21950. (let (level)
  21951. (org-with-limited-levels
  21952. (save-excursion
  21953. (goto-char beg)
  21954. (when (or (looking-at org-outline-regexp)
  21955. (re-search-forward org-outline-regexp-bol end t))
  21956. (setq level (org-outline-level)))
  21957. (goto-char end)
  21958. (skip-chars-forward " \t\r\n\v\f")
  21959. (not (or (eobp)
  21960. (and (bolp) (looking-at-p org-outline-regexp)
  21961. (<= (org-outline-level) level))))))))
  21962. (define-key org-mode-map "\C-y" 'org-yank)
  21963. (defun org-truely-invisible-p ()
  21964. "Check if point is at a character currently not visible.
  21965. This version does not only check the character property, but also
  21966. `visible-mode'."
  21967. ;; Early versions of noutline don't have `outline-invisible-p'.
  21968. (unless (bound-and-true-p visible-mode)
  21969. (outline-invisible-p)))
  21970. (defun org-invisible-p2 ()
  21971. "Check if point is at a character currently not visible."
  21972. (save-excursion
  21973. (when (and (eolp) (not (bobp))) (backward-char 1))
  21974. ;; Early versions of noutline don't have `outline-invisible-p'.
  21975. (outline-invisible-p)))
  21976. (defun org-back-to-heading (&optional invisible-ok)
  21977. "Call `outline-back-to-heading', but provide a better error message."
  21978. (condition-case nil
  21979. (outline-back-to-heading invisible-ok)
  21980. (error (error "Before first headline at position %d in buffer %s"
  21981. (point) (current-buffer)))))
  21982. (defun org-before-first-heading-p ()
  21983. "Before first heading?"
  21984. (save-excursion
  21985. (end-of-line)
  21986. (null (re-search-backward org-outline-regexp-bol nil t))))
  21987. (defun org-at-heading-p (&optional ignored)
  21988. (outline-on-heading-p t))
  21989. (defun org-in-commented-heading-p (&optional no-inheritance)
  21990. "Non-nil if point is under a commented heading.
  21991. This function also checks ancestors of the current headline,
  21992. unless optional argument NO-INHERITANCE is non-nil."
  21993. (cond
  21994. ((org-before-first-heading-p) nil)
  21995. ((let ((headline (nth 4 (org-heading-components))))
  21996. (and headline
  21997. (let ((case-fold-search nil))
  21998. (string-match-p (concat "^" org-comment-string "\\(?: \\|$\\)")
  21999. headline)))))
  22000. (no-inheritance nil)
  22001. (t
  22002. (save-excursion (and (org-up-heading-safe) (org-in-commented-heading-p))))))
  22003. (defun org-at-comment-p nil
  22004. "Is cursor in a commented line?"
  22005. (save-excursion
  22006. (save-match-data
  22007. (beginning-of-line)
  22008. (looking-at "^[ \t]*# "))))
  22009. (defun org-at-drawer-p nil
  22010. "Is cursor at a drawer keyword?"
  22011. (save-excursion
  22012. (move-beginning-of-line 1)
  22013. (looking-at org-drawer-regexp)))
  22014. (defun org-at-block-p nil
  22015. "Is cursor at a block keyword?"
  22016. (save-excursion
  22017. (move-beginning-of-line 1)
  22018. (looking-at org-block-regexp)))
  22019. (defun org-point-at-end-of-empty-headline ()
  22020. "If point is at the end of an empty headline, return t, else nil.
  22021. If the heading only contains a TODO keyword, it is still still considered
  22022. empty."
  22023. (let ((case-fold-search nil))
  22024. (and (looking-at "[ \t]*$")
  22025. org-todo-line-regexp
  22026. (save-excursion
  22027. (beginning-of-line)
  22028. (looking-at org-todo-line-regexp)
  22029. (string= (match-string 3) "")))))
  22030. (defun org-at-heading-or-item-p ()
  22031. (or (org-at-heading-p) (org-at-item-p)))
  22032. (defun org-at-target-p ()
  22033. (or (org-in-regexp org-radio-target-regexp)
  22034. (org-in-regexp org-target-regexp)))
  22035. ;; Compatibility alias with Org versions < 7.8.03
  22036. (defalias 'org-on-target-p 'org-at-target-p)
  22037. (defun org-up-heading-all (arg)
  22038. "Move to the heading line of which the present line is a subheading.
  22039. This function considers both visible and invisible heading lines.
  22040. With argument, move up ARG levels."
  22041. (outline-up-heading arg t))
  22042. (defun org-up-heading-safe ()
  22043. "Move to the heading line of which the present line is a subheading.
  22044. This version will not throw an error. It will return the level of the
  22045. headline found, or nil if no higher level is found.
  22046. Also, this function will be a lot faster than `outline-up-heading',
  22047. because it relies on stars being the outline starters. This can really
  22048. make a significant difference in outlines with very many siblings."
  22049. (when (ignore-errors (org-back-to-heading t))
  22050. (let ((level-up (1- (funcall outline-level))))
  22051. (and (> level-up 0)
  22052. (re-search-backward (format "^\\*\\{1,%d\\} " level-up) nil t)
  22053. (funcall outline-level)))))
  22054. (defun org-first-sibling-p ()
  22055. "Is this heading the first child of its parents?"
  22056. (interactive)
  22057. (let ((re org-outline-regexp-bol)
  22058. level l)
  22059. (unless (org-at-heading-p t)
  22060. (user-error "Not at a heading"))
  22061. (setq level (funcall outline-level))
  22062. (save-excursion
  22063. (if (not (re-search-backward re nil t))
  22064. t
  22065. (setq l (funcall outline-level))
  22066. (< l level)))))
  22067. (defun org-goto-sibling (&optional previous)
  22068. "Goto the next sibling, even if it is invisible.
  22069. When PREVIOUS is set, go to the previous sibling instead. Returns t
  22070. when a sibling was found. When none is found, return nil and don't
  22071. move point."
  22072. (let ((fun (if previous 're-search-backward 're-search-forward))
  22073. (pos (point))
  22074. (re org-outline-regexp-bol)
  22075. level l)
  22076. (when (ignore-errors (org-back-to-heading t))
  22077. (setq level (funcall outline-level))
  22078. (catch 'exit
  22079. (or previous (forward-char 1))
  22080. (while (funcall fun re nil t)
  22081. (setq l (funcall outline-level))
  22082. (when (< l level) (goto-char pos) (throw 'exit nil))
  22083. (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
  22084. (goto-char pos)
  22085. nil))))
  22086. (defun org-show-siblings ()
  22087. "Show all siblings of the current headline."
  22088. (save-excursion
  22089. (while (org-goto-sibling) (org-flag-heading nil)))
  22090. (save-excursion
  22091. (while (org-goto-sibling 'previous)
  22092. (org-flag-heading nil))))
  22093. (defun org-goto-first-child ()
  22094. "Goto the first child, even if it is invisible.
  22095. Return t when a child was found. Otherwise don't move point and
  22096. return nil."
  22097. (let (level (pos (point)) (re org-outline-regexp-bol))
  22098. (when (ignore-errors (org-back-to-heading t))
  22099. (setq level (outline-level))
  22100. (forward-char 1)
  22101. (if (and (re-search-forward re nil t) (> (outline-level) level))
  22102. (progn (goto-char (match-beginning 0)) t)
  22103. (goto-char pos) nil))))
  22104. (defun org-show-hidden-entry ()
  22105. "Show an entry where even the heading is hidden."
  22106. (save-excursion
  22107. (org-show-entry)))
  22108. (defun org-flag-heading (flag &optional entry)
  22109. "Flag the current heading. FLAG non-nil means make invisible.
  22110. When ENTRY is non-nil, show the entire entry."
  22111. (save-excursion
  22112. (org-back-to-heading t)
  22113. ;; Check if we should show the entire entry
  22114. (if entry
  22115. (progn
  22116. (org-show-entry)
  22117. (save-excursion
  22118. (and (outline-next-heading)
  22119. (org-flag-heading nil))))
  22120. (outline-flag-region (max (point-min) (1- (point)))
  22121. (save-excursion (outline-end-of-heading) (point))
  22122. flag))))
  22123. (defun org-get-next-sibling ()
  22124. "Move to next heading of the same level, and return point.
  22125. If there is no such heading, return nil.
  22126. This is like outline-next-sibling, but invisible headings are ok."
  22127. (let ((level (funcall outline-level)))
  22128. (outline-next-heading)
  22129. (while (and (not (eobp)) (> (funcall outline-level) level))
  22130. (outline-next-heading))
  22131. (unless (or (eobp) (< (funcall outline-level) level))
  22132. (point))))
  22133. (defun org-get-last-sibling ()
  22134. "Move to previous heading of the same level, and return point.
  22135. If there is no such heading, return nil."
  22136. (let ((opoint (point))
  22137. (level (funcall outline-level)))
  22138. (outline-previous-heading)
  22139. (when (and (/= (point) opoint) (outline-on-heading-p t))
  22140. (while (and (> (funcall outline-level) level)
  22141. (not (bobp)))
  22142. (outline-previous-heading))
  22143. (unless (< (funcall outline-level) level)
  22144. (point)))))
  22145. (defun org-end-of-subtree (&optional invisible-ok to-heading)
  22146. "Goto to the end of a subtree."
  22147. ;; This contains an exact copy of the original function, but it uses
  22148. ;; `org-back-to-heading', to make it work also in invisible
  22149. ;; trees. And is uses an invisible-ok argument.
  22150. ;; Under Emacs this is not needed, but the old outline.el needs this fix.
  22151. ;; Furthermore, when used inside Org, finding the end of a large subtree
  22152. ;; with many children and grandchildren etc, this can be much faster
  22153. ;; than the outline version.
  22154. (org-back-to-heading invisible-ok)
  22155. (let ((first t)
  22156. (level (funcall outline-level)))
  22157. (if (and (derived-mode-p 'org-mode) (< level 1000))
  22158. ;; A true heading (not a plain list item), in Org
  22159. ;; This means we can easily find the end by looking
  22160. ;; only for the right number of stars. Using a regexp to do
  22161. ;; this is so much faster than using a Lisp loop.
  22162. (let ((re (concat "^\\*\\{1," (int-to-string level) "\\} ")))
  22163. (forward-char 1)
  22164. (and (re-search-forward re nil 'move) (beginning-of-line 1)))
  22165. ;; something else, do it the slow way
  22166. (while (and (not (eobp))
  22167. (or first (> (funcall outline-level) level)))
  22168. (setq first nil)
  22169. (outline-next-heading)))
  22170. (unless to-heading
  22171. (when (memq (preceding-char) '(?\n ?\^M))
  22172. ;; Go to end of line before heading
  22173. (forward-char -1)
  22174. (when (memq (preceding-char) '(?\n ?\^M))
  22175. ;; leave blank line before heading
  22176. (forward-char -1)))))
  22177. (point))
  22178. (defun org-end-of-meta-data (&optional full)
  22179. "Skip planning line and properties drawer in current entry.
  22180. When optional argument FULL is non-nil, also skip empty lines,
  22181. clocking lines and regular drawers at the beginning of the
  22182. entry."
  22183. (org-back-to-heading t)
  22184. (forward-line)
  22185. (when (looking-at-p org-planning-line-re) (forward-line))
  22186. (when (looking-at org-property-drawer-re)
  22187. (goto-char (match-end 0))
  22188. (forward-line))
  22189. (when (and full (not (org-at-heading-p)))
  22190. (catch 'exit
  22191. (let ((end (save-excursion (outline-next-heading) (point)))
  22192. (re (concat "[ \t]*$" "\\|" org-clock-line-re)))
  22193. (while (not (eobp))
  22194. (cond ((looking-at-p org-drawer-regexp)
  22195. (if (re-search-forward "^[ \t]*:END:[ \t]*$" end t)
  22196. (forward-line)
  22197. (throw 'exit t)))
  22198. ((looking-at-p re) (forward-line))
  22199. (t (throw 'exit t))))))))
  22200. (defun org-forward-heading-same-level (arg &optional invisible-ok)
  22201. "Move forward to the ARG'th subheading at same level as this one.
  22202. Stop at the first and last subheadings of a superior heading.
  22203. Normally this only looks at visible headings, but when INVISIBLE-OK is
  22204. non-nil it will also look at invisible ones."
  22205. (interactive "p")
  22206. (if (not (ignore-errors (org-back-to-heading invisible-ok)))
  22207. (if (and arg (< arg 0))
  22208. (goto-char (point-min))
  22209. (outline-next-heading))
  22210. (org-at-heading-p)
  22211. (let ((level (- (match-end 0) (match-beginning 0) 1))
  22212. (f (if (and arg (< arg 0))
  22213. 're-search-backward
  22214. 're-search-forward))
  22215. (count (if arg (abs arg) 1))
  22216. (result (point)))
  22217. (while (and (prog1 (> count 0)
  22218. (forward-char (if (and arg (< arg 0)) -1 1)))
  22219. (funcall f org-outline-regexp-bol nil 'move))
  22220. (let ((l (- (match-end 0) (match-beginning 0) 1)))
  22221. (cond ((< l level) (setq count 0))
  22222. ((and (= l level)
  22223. (or invisible-ok
  22224. (progn
  22225. (goto-char (line-beginning-position))
  22226. (not (outline-invisible-p)))))
  22227. (setq count (1- count))
  22228. (when (eq l level)
  22229. (setq result (point)))))))
  22230. (goto-char result))
  22231. (beginning-of-line 1)))
  22232. (defun org-backward-heading-same-level (arg &optional invisible-ok)
  22233. "Move backward to the ARG'th subheading at same level as this one.
  22234. Stop at the first and last subheadings of a superior heading."
  22235. (interactive "p")
  22236. (org-forward-heading-same-level (if arg (- arg) -1) invisible-ok))
  22237. (defun org-next-visible-heading (arg)
  22238. "Move to the next visible heading.
  22239. This function wraps `outline-next-visible-heading' with
  22240. `org-with-limited-levels' in order to skip over inline tasks and
  22241. respect customization of `org-odd-levels-only'."
  22242. (interactive "p")
  22243. (org-with-limited-levels
  22244. (outline-next-visible-heading arg)))
  22245. (defun org-previous-visible-heading (arg)
  22246. "Move to the previous visible heading.
  22247. This function wraps `outline-previous-visible-heading' with
  22248. `org-with-limited-levels' in order to skip over inline tasks and
  22249. respect customization of `org-odd-levels-only'."
  22250. (interactive "p")
  22251. (org-with-limited-levels
  22252. (outline-previous-visible-heading arg)))
  22253. (defun org-next-block (arg &optional backward block-regexp)
  22254. "Jump to the next block.
  22255. With a prefix argument ARG, jump forward ARG many blocks.
  22256. When BACKWARD is non-nil, jump to the previous block.
  22257. When BLOCK-REGEXP is non-nil, use this regexp to find blocks.
  22258. Match data is set according to this regexp when the function
  22259. returns.
  22260. Return point at beginning of the opening line of found block.
  22261. Throw an error if no block is found."
  22262. (interactive "p")
  22263. (let ((re (or block-regexp "^[ \t]*#\\+BEGIN"))
  22264. (case-fold-search t)
  22265. (search-fn (if backward #'re-search-backward #'re-search-forward))
  22266. (count (or arg 1))
  22267. (origin (point))
  22268. last-element)
  22269. (if backward (beginning-of-line) (end-of-line))
  22270. (while (and (> count 0) (funcall search-fn re nil t))
  22271. (let ((element (save-excursion
  22272. (goto-char (match-beginning 0))
  22273. (save-match-data (org-element-at-point)))))
  22274. (when (and (memq (org-element-type element)
  22275. '(center-block comment-block dynamic-block
  22276. example-block export-block quote-block
  22277. special-block src-block verse-block))
  22278. (<= (match-beginning 0)
  22279. (org-element-property :post-affiliated element)))
  22280. (setq last-element element)
  22281. (cl-decf count))))
  22282. (if (= count 0)
  22283. (prog1 (goto-char (org-element-property :post-affiliated last-element))
  22284. (save-match-data (org-show-context)))
  22285. (goto-char origin)
  22286. (user-error "No %s code blocks" (if backward "previous" "further")))))
  22287. (defun org-previous-block (arg &optional block-regexp)
  22288. "Jump to the previous block.
  22289. With a prefix argument ARG, jump backward ARG many source blocks.
  22290. When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
  22291. (interactive "p")
  22292. (org-next-block arg t block-regexp))
  22293. (defun org-forward-paragraph ()
  22294. "Move forward to beginning of next paragraph or equivalent.
  22295. The function moves point to the beginning of the next visible
  22296. structural element, which can be a paragraph, a table, a list
  22297. item, etc. It also provides some special moves for convenience:
  22298. - On an affiliated keyword, jump to the beginning of the
  22299. relative element.
  22300. - On an item or a footnote definition, move to the second
  22301. element inside, if any.
  22302. - On a table or a property drawer, jump after it.
  22303. - On a verse or source block, stop after blank lines."
  22304. (interactive)
  22305. (when (eobp) (user-error "Cannot move further down"))
  22306. (let* ((deactivate-mark nil)
  22307. (element (org-element-at-point))
  22308. (type (org-element-type element))
  22309. (post-affiliated (org-element-property :post-affiliated element))
  22310. (contents-begin (org-element-property :contents-begin element))
  22311. (contents-end (org-element-property :contents-end element))
  22312. (end (let ((end (org-element-property :end element)) (parent element))
  22313. (while (and (setq parent (org-element-property :parent parent))
  22314. (= (org-element-property :contents-end parent) end))
  22315. (setq end (org-element-property :end parent)))
  22316. end)))
  22317. (cond ((not element)
  22318. (skip-chars-forward " \r\t\n")
  22319. (or (eobp) (beginning-of-line)))
  22320. ;; On affiliated keywords, move to element's beginning.
  22321. ((< (point) post-affiliated)
  22322. (goto-char post-affiliated))
  22323. ;; At a table row, move to the end of the table. Similarly,
  22324. ;; at a node property, move to the end of the property
  22325. ;; drawer.
  22326. ((memq type '(node-property table-row))
  22327. (goto-char (org-element-property
  22328. :end (org-element-property :parent element))))
  22329. ((memq type '(property-drawer table)) (goto-char end))
  22330. ;; Consider blank lines as separators in verse and source
  22331. ;; blocks to ease editing.
  22332. ((memq type '(src-block verse-block))
  22333. (when (eq type 'src-block)
  22334. (setq contents-end
  22335. (save-excursion (goto-char end)
  22336. (skip-chars-backward " \r\t\n")
  22337. (line-beginning-position))))
  22338. (beginning-of-line)
  22339. (when (looking-at "[ \t]*$") (skip-chars-forward " \r\t\n"))
  22340. (if (not (re-search-forward "^[ \t]*$" contents-end t))
  22341. (goto-char end)
  22342. (skip-chars-forward " \r\t\n")
  22343. (if (= (point) contents-end) (goto-char end)
  22344. (beginning-of-line))))
  22345. ;; With no contents, just skip element.
  22346. ((not contents-begin) (goto-char end))
  22347. ;; If contents are invisible, skip the element altogether.
  22348. ((outline-invisible-p (line-end-position))
  22349. (cl-case type
  22350. (headline
  22351. (org-with-limited-levels (outline-next-visible-heading 1)))
  22352. ;; At a plain list, make sure we move to the next item
  22353. ;; instead of skipping the whole list.
  22354. (plain-list (forward-char)
  22355. (org-forward-paragraph))
  22356. (otherwise (goto-char end))))
  22357. ((>= (point) contents-end) (goto-char end))
  22358. ((>= (point) contents-begin)
  22359. ;; This can only happen on paragraphs and plain lists.
  22360. (cl-case type
  22361. (paragraph (goto-char end))
  22362. ;; At a plain list, try to move to second element in
  22363. ;; first item, if possible.
  22364. (plain-list (end-of-line)
  22365. (org-forward-paragraph))))
  22366. ;; When contents start on the middle of a line (e.g. in
  22367. ;; items and footnote definitions), try to reach first
  22368. ;; element starting after current line.
  22369. ((> (line-end-position) contents-begin)
  22370. (end-of-line)
  22371. (org-forward-paragraph))
  22372. (t (goto-char contents-begin)))))
  22373. (defun org-backward-paragraph ()
  22374. "Move backward to start of previous paragraph or equivalent.
  22375. The function moves point to the beginning of the current
  22376. structural element, which can be a paragraph, a table, a list
  22377. item, etc., or to the beginning of the previous visible one if
  22378. point is already there. It also provides some special moves for
  22379. convenience:
  22380. - On an affiliated keyword, jump to the first one.
  22381. - On a table or a property drawer, move to its beginning.
  22382. - On a verse or source block, stop before blank lines."
  22383. (interactive)
  22384. (when (bobp) (user-error "Cannot move further up"))
  22385. (let* ((deactivate-mark nil)
  22386. (element (org-element-at-point))
  22387. (type (org-element-type element))
  22388. (contents-begin (org-element-property :contents-begin element))
  22389. (contents-end (org-element-property :contents-end element))
  22390. (post-affiliated (org-element-property :post-affiliated element))
  22391. (begin (org-element-property :begin element)))
  22392. (cond
  22393. ((not element) (goto-char (point-min)))
  22394. ((= (point) begin)
  22395. (backward-char)
  22396. (org-backward-paragraph))
  22397. ((<= (point) post-affiliated) (goto-char begin))
  22398. ((memq type '(node-property table-row))
  22399. (goto-char (org-element-property
  22400. :post-affiliated (org-element-property :parent element))))
  22401. ((memq type '(property-drawer table)) (goto-char begin))
  22402. ((memq type '(src-block verse-block))
  22403. (when (eq type 'src-block)
  22404. (setq contents-begin
  22405. (save-excursion (goto-char begin) (forward-line) (point))))
  22406. (if (= (point) contents-begin) (goto-char post-affiliated)
  22407. ;; Inside a verse block, see blank lines as paragraph
  22408. ;; separators.
  22409. (let ((origin (point)))
  22410. (skip-chars-backward " \r\t\n" contents-begin)
  22411. (when (re-search-backward "^[ \t]*$" contents-begin 'move)
  22412. (skip-chars-forward " \r\t\n" origin)
  22413. (if (= (point) origin) (goto-char contents-begin)
  22414. (beginning-of-line))))))
  22415. ((not contents-begin) (goto-char (or post-affiliated begin)))
  22416. ((eq type 'paragraph)
  22417. (goto-char contents-begin)
  22418. ;; When at first paragraph in an item or a footnote definition,
  22419. ;; move directly to beginning of line.
  22420. (let ((parent-contents
  22421. (org-element-property
  22422. :contents-begin (org-element-property :parent element))))
  22423. (when (and parent-contents (= parent-contents contents-begin))
  22424. (beginning-of-line))))
  22425. ;; At the end of a greater element, move to the beginning of the
  22426. ;; last element within.
  22427. ((>= (point) contents-end)
  22428. (goto-char (1- contents-end))
  22429. (org-backward-paragraph))
  22430. (t (goto-char (or post-affiliated begin))))
  22431. ;; Ensure we never leave point invisible.
  22432. (when (outline-invisible-p (point)) (beginning-of-visual-line))))
  22433. (defun org-forward-element ()
  22434. "Move forward by one element.
  22435. Move to the next element at the same level, when possible."
  22436. (interactive)
  22437. (cond ((eobp) (user-error "Cannot move further down"))
  22438. ((org-with-limited-levels (org-at-heading-p))
  22439. (let ((origin (point)))
  22440. (goto-char (org-end-of-subtree nil t))
  22441. (unless (org-with-limited-levels (org-at-heading-p))
  22442. (goto-char origin)
  22443. (user-error "Cannot move further down"))))
  22444. (t
  22445. (let* ((elem (org-element-at-point))
  22446. (end (org-element-property :end elem))
  22447. (parent (org-element-property :parent elem)))
  22448. (cond ((and parent (= (org-element-property :contents-end parent) end))
  22449. (goto-char (org-element-property :end parent)))
  22450. ((integer-or-marker-p end) (goto-char end))
  22451. (t (message "No element at point")))))))
  22452. (defun org-backward-element ()
  22453. "Move backward by one element.
  22454. Move to the previous element at the same level, when possible."
  22455. (interactive)
  22456. (cond ((bobp) (user-error "Cannot move further up"))
  22457. ((org-with-limited-levels (org-at-heading-p))
  22458. ;; At a headline, move to the previous one, if any, or stay
  22459. ;; here.
  22460. (let ((origin (point)))
  22461. (org-with-limited-levels (org-backward-heading-same-level 1))
  22462. ;; When current headline has no sibling above, move to its
  22463. ;; parent.
  22464. (when (= (point) origin)
  22465. (or (org-with-limited-levels (org-up-heading-safe))
  22466. (progn (goto-char origin)
  22467. (user-error "Cannot move further up"))))))
  22468. (t
  22469. (let* ((elem (org-element-at-point))
  22470. (beg (org-element-property :begin elem)))
  22471. (cond
  22472. ;; Move to beginning of current element if point isn't
  22473. ;; there already.
  22474. ((null beg) (message "No element at point"))
  22475. ((/= (point) beg) (goto-char beg))
  22476. (t (goto-char beg)
  22477. (skip-chars-backward " \r\t\n")
  22478. (unless (bobp)
  22479. (let ((prev (org-element-at-point)))
  22480. (goto-char (org-element-property :begin prev))
  22481. (while (and (setq prev (org-element-property :parent prev))
  22482. (<= (org-element-property :end prev) beg))
  22483. (goto-char (org-element-property :begin prev)))))))))))
  22484. (defun org-up-element ()
  22485. "Move to upper element."
  22486. (interactive)
  22487. (if (org-with-limited-levels (org-at-heading-p))
  22488. (unless (org-up-heading-safe) (user-error "No surrounding element"))
  22489. (let* ((elem (org-element-at-point))
  22490. (parent (org-element-property :parent elem)))
  22491. (if parent (goto-char (org-element-property :begin parent))
  22492. (if (org-with-limited-levels (org-before-first-heading-p))
  22493. (user-error "No surrounding element")
  22494. (org-with-limited-levels (org-back-to-heading)))))))
  22495. (defvar org-element-greater-elements)
  22496. (defun org-down-element ()
  22497. "Move to inner element."
  22498. (interactive)
  22499. (let ((element (org-element-at-point)))
  22500. (cond
  22501. ((memq (org-element-type element) '(plain-list table))
  22502. (goto-char (org-element-property :contents-begin element))
  22503. (forward-char))
  22504. ((memq (org-element-type element) org-element-greater-elements)
  22505. ;; If contents are hidden, first disclose them.
  22506. (when (outline-invisible-p (line-end-position)) (org-cycle))
  22507. (goto-char (or (org-element-property :contents-begin element)
  22508. (user-error "No content for this element"))))
  22509. (t (user-error "No inner element")))))
  22510. (defun org-drag-element-backward ()
  22511. "Move backward element at point."
  22512. (interactive)
  22513. (let ((elem (or (org-element-at-point)
  22514. (user-error "No element at point"))))
  22515. (if (eq (org-element-type elem) 'headline)
  22516. ;; Preserve point when moving a whole tree, even if point was
  22517. ;; on blank lines below the headline.
  22518. (let ((offset (skip-chars-backward " \t\n")))
  22519. (unwind-protect (org-move-subtree-up)
  22520. (forward-char (- offset))))
  22521. (let ((prev-elem
  22522. (save-excursion
  22523. (goto-char (org-element-property :begin elem))
  22524. (skip-chars-backward " \r\t\n")
  22525. (unless (bobp)
  22526. (let* ((beg (org-element-property :begin elem))
  22527. (prev (org-element-at-point))
  22528. (up prev))
  22529. (while (and (setq up (org-element-property :parent up))
  22530. (<= (org-element-property :end up) beg))
  22531. (setq prev up))
  22532. prev)))))
  22533. ;; Error out if no previous element or previous element is
  22534. ;; a parent of the current one.
  22535. (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
  22536. (user-error "Cannot drag element backward")
  22537. (let ((pos (point)))
  22538. (org-element-swap-A-B prev-elem elem)
  22539. (goto-char (+ (org-element-property :begin prev-elem)
  22540. (- pos (org-element-property :begin elem))))))))))
  22541. (defun org-drag-element-forward ()
  22542. "Move forward element at point."
  22543. (interactive)
  22544. (let* ((pos (point))
  22545. (elem (or (org-element-at-point)
  22546. (user-error "No element at point"))))
  22547. (when (= (point-max) (org-element-property :end elem))
  22548. (user-error "Cannot drag element forward"))
  22549. (goto-char (org-element-property :end elem))
  22550. (let ((next-elem (org-element-at-point)))
  22551. (when (or (org-element-nested-p elem next-elem)
  22552. (and (eq (org-element-type next-elem) 'headline)
  22553. (not (eq (org-element-type elem) 'headline))))
  22554. (goto-char pos)
  22555. (user-error "Cannot drag element forward"))
  22556. ;; Compute new position of point: it's shifted by NEXT-ELEM
  22557. ;; body's length (without final blanks) and by the length of
  22558. ;; blanks between ELEM and NEXT-ELEM.
  22559. (let ((size-next (- (save-excursion
  22560. (goto-char (org-element-property :end next-elem))
  22561. (skip-chars-backward " \r\t\n")
  22562. (forward-line)
  22563. ;; Small correction if buffer doesn't end
  22564. ;; with a newline character.
  22565. (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
  22566. (org-element-property :begin next-elem)))
  22567. (size-blank (- (org-element-property :end elem)
  22568. (save-excursion
  22569. (goto-char (org-element-property :end elem))
  22570. (skip-chars-backward " \r\t\n")
  22571. (forward-line)
  22572. (point)))))
  22573. (org-element-swap-A-B elem next-elem)
  22574. (goto-char (+ pos size-next size-blank))))))
  22575. (defun org-drag-line-forward (arg)
  22576. "Drag the line at point ARG lines forward."
  22577. (interactive "p")
  22578. (dotimes (_ (abs arg))
  22579. (let ((c (current-column)))
  22580. (if (< 0 arg)
  22581. (progn
  22582. (beginning-of-line 2)
  22583. (transpose-lines 1)
  22584. (beginning-of-line 0))
  22585. (transpose-lines 1)
  22586. (beginning-of-line -1))
  22587. (org-move-to-column c))))
  22588. (defun org-drag-line-backward (arg)
  22589. "Drag the line at point ARG lines backward."
  22590. (interactive "p")
  22591. (org-drag-line-forward (- arg)))
  22592. (defun org-mark-element ()
  22593. "Put point at beginning of this element, mark at end.
  22594. Interactively, if this command is repeated or (in Transient Mark
  22595. mode) if the mark is active, it marks the next element after the
  22596. ones already marked."
  22597. (interactive)
  22598. (let (deactivate-mark)
  22599. (if (and (called-interactively-p 'any)
  22600. (or (and (eq last-command this-command) (mark t))
  22601. (and transient-mark-mode mark-active)))
  22602. (set-mark
  22603. (save-excursion
  22604. (goto-char (mark))
  22605. (goto-char (org-element-property :end (org-element-at-point)))))
  22606. (let ((element (org-element-at-point)))
  22607. (end-of-line)
  22608. (push-mark (org-element-property :end element) t t)
  22609. (goto-char (org-element-property :begin element))))))
  22610. (defun org-narrow-to-element ()
  22611. "Narrow buffer to current element."
  22612. (interactive)
  22613. (let ((elem (org-element-at-point)))
  22614. (cond
  22615. ((eq (car elem) 'headline)
  22616. (narrow-to-region
  22617. (org-element-property :begin elem)
  22618. (org-element-property :end elem)))
  22619. ((memq (car elem) org-element-greater-elements)
  22620. (narrow-to-region
  22621. (org-element-property :contents-begin elem)
  22622. (org-element-property :contents-end elem)))
  22623. (t
  22624. (narrow-to-region
  22625. (org-element-property :begin elem)
  22626. (org-element-property :end elem))))))
  22627. (defun org-transpose-element ()
  22628. "Transpose current and previous elements, keeping blank lines between.
  22629. Point is moved after both elements."
  22630. (interactive)
  22631. (org-skip-whitespace)
  22632. (let ((end (org-element-property :end (org-element-at-point))))
  22633. (org-drag-element-backward)
  22634. (goto-char end)))
  22635. (defun org-unindent-buffer ()
  22636. "Un-indent the visible part of the buffer.
  22637. Relative indentation (between items, inside blocks, etc.) isn't
  22638. modified."
  22639. (interactive)
  22640. (unless (eq major-mode 'org-mode)
  22641. (user-error "Cannot un-indent a buffer not in Org mode"))
  22642. (letrec ((parse-tree (org-element-parse-buffer 'greater-element))
  22643. (unindent-tree
  22644. (lambda (contents)
  22645. (dolist (element (reverse contents))
  22646. (if (memq (org-element-type element) '(headline section))
  22647. (funcall unindent-tree (org-element-contents element))
  22648. (save-excursion
  22649. (save-restriction
  22650. (narrow-to-region
  22651. (org-element-property :begin element)
  22652. (org-element-property :end element))
  22653. (org-do-remove-indentation))))))))
  22654. (funcall unindent-tree (org-element-contents parse-tree))))
  22655. (defun org-show-children (&optional level)
  22656. "Show all direct subheadings of this heading.
  22657. Prefix arg LEVEL is how many levels below the current level
  22658. should be shown. Default is enough to cause the following
  22659. heading to appear."
  22660. (interactive "p")
  22661. ;; If `orgstruct-mode' is active, use the slower version.
  22662. (if orgstruct-mode (call-interactively #'outline-show-children)
  22663. (save-excursion
  22664. (org-back-to-heading t)
  22665. (let* ((current-level (funcall outline-level))
  22666. (max-level (org-get-valid-level
  22667. current-level
  22668. (if level (prefix-numeric-value level) 1)))
  22669. (end (save-excursion (org-end-of-subtree t t)))
  22670. (regexp-fmt "^\\*\\{%d,%s\\}\\(?: \\|$\\)")
  22671. (past-first-child nil)
  22672. ;; Make sure to skip inlinetasks.
  22673. (re (format regexp-fmt
  22674. current-level
  22675. (cond
  22676. ((not (featurep 'org-inlinetask)) "")
  22677. (org-odd-levels-only (- (* 2 org-inlinetask-min-level)
  22678. 3))
  22679. (t (1- org-inlinetask-min-level))))))
  22680. ;; Display parent heading.
  22681. (outline-flag-region (line-end-position 0) (line-end-position) nil)
  22682. (forward-line)
  22683. ;; Display children. First child may be deeper than expected
  22684. ;; MAX-LEVEL. Since we want to display it anyway, adjust
  22685. ;; MAX-LEVEL accordingly.
  22686. (while (re-search-forward re end t)
  22687. (unless past-first-child
  22688. (setq re (format regexp-fmt
  22689. current-level
  22690. (max (funcall outline-level) max-level)))
  22691. (setq past-first-child t))
  22692. (outline-flag-region
  22693. (line-end-position 0) (line-end-position) nil))))))
  22694. (defun org-show-subtree ()
  22695. "Show everything after this heading at deeper levels."
  22696. (interactive)
  22697. (outline-flag-region
  22698. (point)
  22699. (save-excursion
  22700. (org-end-of-subtree t t))
  22701. nil))
  22702. (defun org-show-entry ()
  22703. "Show the body directly following this heading.
  22704. Show the heading too, if it is currently invisible."
  22705. (interactive)
  22706. (save-excursion
  22707. (ignore-errors
  22708. (org-back-to-heading t)
  22709. (outline-flag-region
  22710. (max (point-min) (1- (point)))
  22711. (save-excursion
  22712. (if (re-search-forward
  22713. (concat "[\r\n]\\(" org-outline-regexp "\\)") nil t)
  22714. (match-beginning 1)
  22715. (point-max)))
  22716. nil)
  22717. (org-cycle-hide-drawers 'children))))
  22718. (defun org-make-options-regexp (kwds &optional extra)
  22719. "Make a regular expression for keyword lines.
  22720. KWDS is a list of keywords, as strings. Optional argument EXTRA,
  22721. when non-nil, is a regexp matching keywords names."
  22722. (concat "^[ \t]*#\\+\\("
  22723. (regexp-opt kwds)
  22724. (and extra (concat (and kwds "\\|") extra))
  22725. "\\):[ \t]*\\(.*\\)"))
  22726. ;;;; Integration with and fixes for other packages
  22727. ;;; Imenu support
  22728. (defvar-local org-imenu-markers nil
  22729. "All markers currently used by Imenu.")
  22730. (defun org-imenu-new-marker (&optional pos)
  22731. "Return a new marker for use by Imenu, and remember the marker."
  22732. (let ((m (make-marker)))
  22733. (move-marker m (or pos (point)))
  22734. (push m org-imenu-markers)
  22735. m))
  22736. (defun org-imenu-get-tree ()
  22737. "Produce the index for Imenu."
  22738. (dolist (x org-imenu-markers) (move-marker x nil))
  22739. (setq org-imenu-markers nil)
  22740. (let* ((case-fold-search nil)
  22741. (n org-imenu-depth)
  22742. (re (concat "^" (org-get-limited-outline-regexp)))
  22743. (subs (make-vector (1+ n) nil))
  22744. (last-level 0)
  22745. m level head0 head)
  22746. (org-with-wide-buffer
  22747. (goto-char (point-max))
  22748. (while (re-search-backward re nil t)
  22749. (setq level (org-reduced-level (funcall outline-level)))
  22750. (when (and (<= level n)
  22751. (looking-at org-complex-heading-regexp)
  22752. (setq head0 (match-string-no-properties 4)))
  22753. (setq head (org-link-display-format head0)
  22754. m (org-imenu-new-marker))
  22755. (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
  22756. (if (>= level last-level)
  22757. (push (cons head m) (aref subs level))
  22758. (push (cons head (aref subs (1+ level))) (aref subs level))
  22759. (cl-loop for i from (1+ level) to n do (aset subs i nil)))
  22760. (setq last-level level))))
  22761. (aref subs 1)))
  22762. (eval-after-load "imenu"
  22763. '(progn
  22764. (add-hook 'imenu-after-jump-hook
  22765. (lambda ()
  22766. (when (derived-mode-p 'org-mode)
  22767. (org-show-context 'org-goto))))))
  22768. (defun org-link-display-format (s)
  22769. "Replace links in string S with their description.
  22770. If there is no description, use the link target."
  22771. (save-match-data
  22772. (replace-regexp-in-string
  22773. org-bracket-link-analytic-regexp
  22774. (lambda (m)
  22775. (if (match-end 5) (match-string 5 m)
  22776. (concat (match-string 1 m) (match-string 3 m))))
  22777. s nil t)))
  22778. (defun org-toggle-link-display ()
  22779. "Toggle the literal or descriptive display of links."
  22780. (interactive)
  22781. (if org-descriptive-links
  22782. (progn (org-remove-from-invisibility-spec '(org-link))
  22783. (org-restart-font-lock)
  22784. (setq org-descriptive-links nil))
  22785. (progn (add-to-invisibility-spec '(org-link))
  22786. (org-restart-font-lock)
  22787. (setq org-descriptive-links t))))
  22788. ;; Speedbar support
  22789. (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
  22790. "Overlay marking the agenda restriction line in speedbar.")
  22791. (overlay-put org-speedbar-restriction-lock-overlay
  22792. 'face 'org-agenda-restriction-lock)
  22793. (overlay-put org-speedbar-restriction-lock-overlay
  22794. 'help-echo "Agendas are currently limited to this item.")
  22795. (delete-overlay org-speedbar-restriction-lock-overlay)
  22796. (defun org-speedbar-set-agenda-restriction ()
  22797. "Restrict future agenda commands to the location at point in speedbar.
  22798. To get rid of the restriction, use `\\[org-agenda-remove-restriction-lock]'."
  22799. (interactive)
  22800. (require 'org-agenda)
  22801. (let (p m tp np dir txt)
  22802. (cond
  22803. ((setq p (text-property-any (point-at-bol) (point-at-eol)
  22804. 'org-imenu t))
  22805. (setq m (get-text-property p 'org-imenu-marker))
  22806. (with-current-buffer (marker-buffer m)
  22807. (goto-char m)
  22808. (org-agenda-set-restriction-lock 'subtree)))
  22809. ((setq p (text-property-any (point-at-bol) (point-at-eol)
  22810. 'speedbar-function 'speedbar-find-file))
  22811. (setq tp (previous-single-property-change
  22812. (1+ p) 'speedbar-function)
  22813. np (next-single-property-change
  22814. tp 'speedbar-function)
  22815. dir (speedbar-line-directory)
  22816. txt (buffer-substring-no-properties (or tp (point-min))
  22817. (or np (point-max))))
  22818. (with-current-buffer (find-file-noselect
  22819. (let ((default-directory dir))
  22820. (expand-file-name txt)))
  22821. (unless (derived-mode-p 'org-mode)
  22822. (user-error "Cannot restrict to non-Org mode file"))
  22823. (org-agenda-set-restriction-lock 'file)))
  22824. (t (user-error "Don't know how to restrict Org mode agenda")))
  22825. (move-overlay org-speedbar-restriction-lock-overlay
  22826. (point-at-bol) (point-at-eol))
  22827. (setq current-prefix-arg nil)
  22828. (org-agenda-maybe-redo)))
  22829. (defvar speedbar-file-key-map)
  22830. (declare-function speedbar-add-supported-extension "speedbar" (extension))
  22831. (eval-after-load "speedbar"
  22832. '(progn
  22833. (speedbar-add-supported-extension ".org")
  22834. (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
  22835. (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
  22836. (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
  22837. (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
  22838. (add-hook 'speedbar-visiting-tag-hook
  22839. (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
  22840. ;;; Fixes and Hacks for problems with other packages
  22841. (defun org--flyspell-object-check-p (element)
  22842. "Non-nil when Flyspell can check object at point.
  22843. ELEMENT is the element at point."
  22844. (let ((object (save-excursion
  22845. (when (looking-at-p "\\>") (backward-char))
  22846. (org-element-context element))))
  22847. (cl-case (org-element-type object)
  22848. ;; Prevent checks in links due to keybinding conflict with
  22849. ;; Flyspell.
  22850. ((code entity export-snippet inline-babel-call
  22851. inline-src-block line-break latex-fragment link macro
  22852. statistics-cookie target timestamp verbatim)
  22853. nil)
  22854. (footnote-reference
  22855. ;; Only in inline footnotes, within the definition.
  22856. (and (eq (org-element-property :type object) 'inline)
  22857. (< (save-excursion
  22858. (goto-char (org-element-property :begin object))
  22859. (search-forward ":" nil t 2))
  22860. (point))))
  22861. (otherwise t))))
  22862. (defun org-mode-flyspell-verify ()
  22863. "Function used for `flyspell-generic-check-word-predicate'."
  22864. (if (org-at-heading-p)
  22865. ;; At a headline or an inlinetask, check title only. This is
  22866. ;; faster than relying on `org-element-at-point'.
  22867. (and (save-excursion (beginning-of-line)
  22868. (and (let ((case-fold-search t))
  22869. (not (looking-at-p "\\*+ END[ \t]*$")))
  22870. (let ((case-fold-search nil))
  22871. (looking-at org-complex-heading-regexp))))
  22872. (match-beginning 4)
  22873. (>= (point) (match-beginning 4))
  22874. (or (not (match-beginning 5))
  22875. (< (point) (match-beginning 5))))
  22876. (let* ((element (org-element-at-point))
  22877. (post-affiliated (org-element-property :post-affiliated element)))
  22878. (cond
  22879. ;; Ignore checks in all affiliated keywords but captions.
  22880. ((< (point) post-affiliated)
  22881. (and (save-excursion
  22882. (beginning-of-line)
  22883. (let ((case-fold-search t)) (looking-at "[ \t]*#\\+CAPTION:")))
  22884. (> (point) (match-end 0))
  22885. (org--flyspell-object-check-p element)))
  22886. ;; Ignore checks in LOGBOOK (or equivalent) drawer.
  22887. ((let ((log (org-log-into-drawer)))
  22888. (and log
  22889. (let ((drawer (org-element-lineage element '(drawer))))
  22890. (and drawer
  22891. (eq (compare-strings
  22892. log nil nil
  22893. (org-element-property :drawer-name drawer) nil nil t)
  22894. t)))))
  22895. nil)
  22896. (t
  22897. (cl-case (org-element-type element)
  22898. ((comment quote-section) t)
  22899. (comment-block
  22900. ;; Allow checks between block markers, not on them.
  22901. (and (> (line-beginning-position) post-affiliated)
  22902. (save-excursion
  22903. (end-of-line)
  22904. (skip-chars-forward " \r\t\n")
  22905. (< (point) (org-element-property :end element)))))
  22906. ;; Arbitrary list of keywords where checks are meaningful.
  22907. ;; Make sure point is on the value part of the element.
  22908. (keyword
  22909. (and (member (org-element-property :key element)
  22910. '("DESCRIPTION" "TITLE"))
  22911. (save-excursion
  22912. (search-backward ":" (line-beginning-position) t))))
  22913. ;; Check is globally allowed in paragraphs verse blocks and
  22914. ;; table rows (after affiliated keywords) but some objects
  22915. ;; must not be affected.
  22916. ((paragraph table-row verse-block)
  22917. (let ((cbeg (org-element-property :contents-begin element))
  22918. (cend (org-element-property :contents-end element)))
  22919. (and cbeg (>= (point) cbeg) (< (point) cend)
  22920. (org--flyspell-object-check-p element))))))))))
  22921. (put 'org-mode 'flyspell-mode-predicate 'org-mode-flyspell-verify)
  22922. (defun org-remove-flyspell-overlays-in (beg end)
  22923. "Remove flyspell overlays in region."
  22924. (and (bound-and-true-p flyspell-mode)
  22925. (fboundp 'flyspell-delete-region-overlays)
  22926. (flyspell-delete-region-overlays beg end)))
  22927. (defvar flyspell-delayed-commands)
  22928. (eval-after-load "flyspell"
  22929. '(add-to-list 'flyspell-delayed-commands 'org-self-insert-command))
  22930. ;; Make `bookmark-jump' shows the jump location if it was hidden.
  22931. (eval-after-load "bookmark"
  22932. '(if (boundp 'bookmark-after-jump-hook)
  22933. ;; We can use the hook
  22934. (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
  22935. ;; Hook not available, use advice
  22936. (defadvice bookmark-jump (after org-make-visible activate)
  22937. "Make the position visible."
  22938. (org-bookmark-jump-unhide))))
  22939. ;; Make sure saveplace shows the location if it was hidden
  22940. (eval-after-load "saveplace"
  22941. '(defadvice save-place-find-file-hook (after org-make-visible activate)
  22942. "Make the position visible."
  22943. (org-bookmark-jump-unhide)))
  22944. ;; Make sure ecb shows the location if it was hidden
  22945. (eval-after-load "ecb"
  22946. '(defadvice ecb-method-clicked (after esf/org-show-context activate)
  22947. "Make hierarchy visible when jumping into location from ECB tree buffer."
  22948. (when (derived-mode-p 'org-mode)
  22949. (org-show-context))))
  22950. (defun org-bookmark-jump-unhide ()
  22951. "Unhide the current position, to show the bookmark location."
  22952. (and (derived-mode-p 'org-mode)
  22953. (or (outline-invisible-p)
  22954. (save-excursion (goto-char (max (point-min) (1- (point))))
  22955. (outline-invisible-p)))
  22956. (org-show-context 'bookmark-jump)))
  22957. (defun org-mark-jump-unhide ()
  22958. "Make the point visible with `org-show-context' after jumping to the mark."
  22959. (when (and (derived-mode-p 'org-mode)
  22960. (outline-invisible-p))
  22961. (org-show-context 'mark-goto)))
  22962. (eval-after-load "simple"
  22963. '(defadvice pop-to-mark-command (after org-make-visible activate)
  22964. "Make the point visible with `org-show-context'."
  22965. (org-mark-jump-unhide)))
  22966. (eval-after-load "simple"
  22967. '(defadvice exchange-point-and-mark (after org-make-visible activate)
  22968. "Make the point visible with `org-show-context'."
  22969. (org-mark-jump-unhide)))
  22970. (eval-after-load "simple"
  22971. '(defadvice pop-global-mark (after org-make-visible activate)
  22972. "Make the point visible with `org-show-context'."
  22973. (org-mark-jump-unhide)))
  22974. ;; Make session.el ignore our circular variable
  22975. (defvar session-globals-exclude)
  22976. (eval-after-load "session"
  22977. '(add-to-list 'session-globals-exclude 'org-mark-ring))
  22978. ;;;; Finish up
  22979. (provide 'org)
  22980. (run-hooks 'org-load-hook)
  22981. ;;; org.el ends here