org.el 952 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589125901259112592125931259412595125961259712598125991260012601126021260312604126051260612607126081260912610126111261212613126141261512616126171261812619126201262112622126231262412625126261262712628126291263012631126321263312634126351263612637126381263912640126411264212643126441264512646126471264812649126501265112652126531265412655126561265712658126591266012661126621266312664126651266612667126681266912670126711267212673126741267512676126771267812679126801268112682126831268412685126861268712688126891269012691126921269312694126951269612697126981269912700127011270212703127041270512706127071270812709127101271112712127131271412715127161271712718127191272012721127221272312724127251272612727127281272912730127311273212733127341273512736127371273812739127401274112742127431274412745127461274712748127491275012751127521275312754127551275612757127581275912760127611276212763127641276512766127671276812769127701277112772127731277412775127761277712778127791278012781127821278312784127851278612787127881278912790127911279212793127941279512796127971279812799128001280112802128031280412805128061280712808128091281012811128121281312814128151281612817128181281912820128211282212823128241282512826128271282812829128301283112832128331283412835128361283712838128391284012841128421284312844128451284612847128481284912850128511285212853128541285512856128571285812859128601286112862128631286412865128661286712868128691287012871128721287312874128751287612877128781287912880128811288212883128841288512886128871288812889128901289112892128931289412895128961289712898128991290012901129021290312904129051290612907129081290912910129111291212913129141291512916129171291812919129201292112922129231292412925129261292712928129291293012931129321293312934129351293612937129381293912940129411294212943129441294512946129471294812949129501295112952129531295412955129561295712958129591296012961129621296312964129651296612967129681296912970129711297212973129741297512976129771297812979129801298112982129831298412985129861298712988129891299012991129921299312994129951299612997129981299913000130011300213003130041300513006130071300813009130101301113012130131301413015130161301713018130191302013021130221302313024130251302613027130281302913030130311303213033130341303513036130371303813039130401304113042130431304413045130461304713048130491305013051130521305313054130551305613057130581305913060130611306213063130641306513066130671306813069130701307113072130731307413075130761307713078130791308013081130821308313084130851308613087130881308913090130911309213093130941309513096130971309813099131001310113102131031310413105131061310713108131091311013111131121311313114131151311613117131181311913120131211312213123131241312513126131271312813129131301313113132131331313413135131361313713138131391314013141131421314313144131451314613147131481314913150131511315213153131541315513156131571315813159131601316113162131631316413165131661316713168131691317013171131721317313174131751317613177131781317913180131811318213183131841318513186131871318813189131901319113192131931319413195131961319713198131991320013201132021320313204132051320613207132081320913210132111321213213132141321513216132171321813219132201322113222132231322413225132261322713228132291323013231132321323313234132351323613237132381323913240132411324213243132441324513246132471324813249132501325113252132531325413255132561325713258132591326013261132621326313264132651326613267132681326913270132711327213273132741327513276132771327813279132801328113282132831328413285132861328713288132891329013291132921329313294132951329613297132981329913300133011330213303133041330513306133071330813309133101331113312133131331413315133161331713318133191332013321133221332313324133251332613327133281332913330133311333213333133341333513336133371333813339133401334113342133431334413345133461334713348133491335013351133521335313354133551335613357133581335913360133611336213363133641336513366133671336813369133701337113372133731337413375133761337713378133791338013381133821338313384133851338613387133881338913390133911339213393133941339513396133971339813399134001340113402134031340413405134061340713408134091341013411134121341313414134151341613417134181341913420134211342213423134241342513426134271342813429134301343113432134331343413435134361343713438134391344013441134421344313444134451344613447134481344913450134511345213453134541345513456134571345813459134601346113462134631346413465134661346713468134691347013471134721347313474134751347613477134781347913480134811348213483134841348513486134871348813489134901349113492134931349413495134961349713498134991350013501135021350313504135051350613507135081350913510135111351213513135141351513516135171351813519135201352113522135231352413525135261352713528135291353013531135321353313534135351353613537135381353913540135411354213543135441354513546135471354813549135501355113552135531355413555135561355713558135591356013561135621356313564135651356613567135681356913570135711357213573135741357513576135771357813579135801358113582135831358413585135861358713588135891359013591135921359313594135951359613597135981359913600136011360213603136041360513606136071360813609136101361113612136131361413615136161361713618136191362013621136221362313624136251362613627136281362913630136311363213633136341363513636136371363813639136401364113642136431364413645136461364713648136491365013651136521365313654136551365613657136581365913660136611366213663136641366513666136671366813669136701367113672136731367413675136761367713678136791368013681136821368313684136851368613687136881368913690136911369213693136941369513696136971369813699137001370113702137031370413705137061370713708137091371013711137121371313714137151371613717137181371913720137211372213723137241372513726137271372813729137301373113732137331373413735137361373713738137391374013741137421374313744137451374613747137481374913750137511375213753137541375513756137571375813759137601376113762137631376413765137661376713768137691377013771137721377313774137751377613777137781377913780137811378213783137841378513786137871378813789137901379113792137931379413795137961379713798137991380013801138021380313804138051380613807138081380913810138111381213813138141381513816138171381813819138201382113822138231382413825138261382713828138291383013831138321383313834138351383613837138381383913840138411384213843138441384513846138471384813849138501385113852138531385413855138561385713858138591386013861138621386313864138651386613867138681386913870138711387213873138741387513876138771387813879138801388113882138831388413885138861388713888138891389013891138921389313894138951389613897138981389913900139011390213903139041390513906139071390813909139101391113912139131391413915139161391713918139191392013921139221392313924139251392613927139281392913930139311393213933139341393513936139371393813939139401394113942139431394413945139461394713948139491395013951139521395313954139551395613957139581395913960139611396213963139641396513966139671396813969139701397113972139731397413975139761397713978139791398013981139821398313984139851398613987139881398913990139911399213993139941399513996139971399813999140001400114002140031400414005140061400714008140091401014011140121401314014140151401614017140181401914020140211402214023140241402514026140271402814029140301403114032140331403414035140361403714038140391404014041140421404314044140451404614047140481404914050140511405214053140541405514056140571405814059140601406114062140631406414065140661406714068140691407014071140721407314074140751407614077140781407914080140811408214083140841408514086140871408814089140901409114092140931409414095140961409714098140991410014101141021410314104141051410614107141081410914110141111411214113141141411514116141171411814119141201412114122141231412414125141261412714128141291413014131141321413314134141351413614137141381413914140141411414214143141441414514146141471414814149141501415114152141531415414155141561415714158141591416014161141621416314164141651416614167141681416914170141711417214173141741417514176141771417814179141801418114182141831418414185141861418714188141891419014191141921419314194141951419614197141981419914200142011420214203142041420514206142071420814209142101421114212142131421414215142161421714218142191422014221142221422314224142251422614227142281422914230142311423214233142341423514236142371423814239142401424114242142431424414245142461424714248142491425014251142521425314254142551425614257142581425914260142611426214263142641426514266142671426814269142701427114272142731427414275142761427714278142791428014281142821428314284142851428614287142881428914290142911429214293142941429514296142971429814299143001430114302143031430414305143061430714308143091431014311143121431314314143151431614317143181431914320143211432214323143241432514326143271432814329143301433114332143331433414335143361433714338143391434014341143421434314344143451434614347143481434914350143511435214353143541435514356143571435814359143601436114362143631436414365143661436714368143691437014371143721437314374143751437614377143781437914380143811438214383143841438514386143871438814389143901439114392143931439414395143961439714398143991440014401144021440314404144051440614407144081440914410144111441214413144141441514416144171441814419144201442114422144231442414425144261442714428144291443014431144321443314434144351443614437144381443914440144411444214443144441444514446144471444814449144501445114452144531445414455144561445714458144591446014461144621446314464144651446614467144681446914470144711447214473144741447514476144771447814479144801448114482144831448414485144861448714488144891449014491144921449314494144951449614497144981449914500145011450214503145041450514506145071450814509145101451114512145131451414515145161451714518145191452014521145221452314524145251452614527145281452914530145311453214533145341453514536145371453814539145401454114542145431454414545145461454714548145491455014551145521455314554145551455614557145581455914560145611456214563145641456514566145671456814569145701457114572145731457414575145761457714578145791458014581145821458314584145851458614587145881458914590145911459214593145941459514596145971459814599146001460114602146031460414605146061460714608146091461014611146121461314614146151461614617146181461914620146211462214623146241462514626146271462814629146301463114632146331463414635146361463714638146391464014641146421464314644146451464614647146481464914650146511465214653146541465514656146571465814659146601466114662146631466414665146661466714668146691467014671146721467314674146751467614677146781467914680146811468214683146841468514686146871468814689146901469114692146931469414695146961469714698146991470014701147021470314704147051470614707147081470914710147111471214713147141471514716147171471814719147201472114722147231472414725147261472714728147291473014731147321473314734147351473614737147381473914740147411474214743147441474514746147471474814749147501475114752147531475414755147561475714758147591476014761147621476314764147651476614767147681476914770147711477214773147741477514776147771477814779147801478114782147831478414785147861478714788147891479014791147921479314794147951479614797147981479914800148011480214803148041480514806148071480814809148101481114812148131481414815148161481714818148191482014821148221482314824148251482614827148281482914830148311483214833148341483514836148371483814839148401484114842148431484414845148461484714848148491485014851148521485314854148551485614857148581485914860148611486214863148641486514866148671486814869148701487114872148731487414875148761487714878148791488014881148821488314884148851488614887148881488914890148911489214893148941489514896148971489814899149001490114902149031490414905149061490714908149091491014911149121491314914149151491614917149181491914920149211492214923149241492514926149271492814929149301493114932149331493414935149361493714938149391494014941149421494314944149451494614947149481494914950149511495214953149541495514956149571495814959149601496114962149631496414965149661496714968149691497014971149721497314974149751497614977149781497914980149811498214983149841498514986149871498814989149901499114992149931499414995149961499714998149991500015001150021500315004150051500615007150081500915010150111501215013150141501515016150171501815019150201502115022150231502415025150261502715028150291503015031150321503315034150351503615037150381503915040150411504215043150441504515046150471504815049150501505115052150531505415055150561505715058150591506015061150621506315064150651506615067150681506915070150711507215073150741507515076150771507815079150801508115082150831508415085150861508715088150891509015091150921509315094150951509615097150981509915100151011510215103151041510515106151071510815109151101511115112151131511415115151161511715118151191512015121151221512315124151251512615127151281512915130151311513215133151341513515136151371513815139151401514115142151431514415145151461514715148151491515015151151521515315154151551515615157151581515915160151611516215163151641516515166151671516815169151701517115172151731517415175151761517715178151791518015181151821518315184151851518615187151881518915190151911519215193151941519515196151971519815199152001520115202152031520415205152061520715208152091521015211152121521315214152151521615217152181521915220152211522215223152241522515226152271522815229152301523115232152331523415235152361523715238152391524015241152421524315244152451524615247152481524915250152511525215253152541525515256152571525815259152601526115262152631526415265152661526715268152691527015271152721527315274152751527615277152781527915280152811528215283152841528515286152871528815289152901529115292152931529415295152961529715298152991530015301153021530315304153051530615307153081530915310153111531215313153141531515316153171531815319153201532115322153231532415325153261532715328153291533015331153321533315334153351533615337153381533915340153411534215343153441534515346153471534815349153501535115352153531535415355153561535715358153591536015361153621536315364153651536615367153681536915370153711537215373153741537515376153771537815379153801538115382153831538415385153861538715388153891539015391153921539315394153951539615397153981539915400154011540215403154041540515406154071540815409154101541115412154131541415415154161541715418154191542015421154221542315424154251542615427154281542915430154311543215433154341543515436154371543815439154401544115442154431544415445154461544715448154491545015451154521545315454154551545615457154581545915460154611546215463154641546515466154671546815469154701547115472154731547415475154761547715478154791548015481154821548315484154851548615487154881548915490154911549215493154941549515496154971549815499155001550115502155031550415505155061550715508155091551015511155121551315514155151551615517155181551915520155211552215523155241552515526155271552815529155301553115532155331553415535155361553715538155391554015541155421554315544155451554615547155481554915550155511555215553155541555515556155571555815559155601556115562155631556415565155661556715568155691557015571155721557315574155751557615577155781557915580155811558215583155841558515586155871558815589155901559115592155931559415595155961559715598155991560015601156021560315604156051560615607156081560915610156111561215613156141561515616156171561815619156201562115622156231562415625156261562715628156291563015631156321563315634156351563615637156381563915640156411564215643156441564515646156471564815649156501565115652156531565415655156561565715658156591566015661156621566315664156651566615667156681566915670156711567215673156741567515676156771567815679156801568115682156831568415685156861568715688156891569015691156921569315694156951569615697156981569915700157011570215703157041570515706157071570815709157101571115712157131571415715157161571715718157191572015721157221572315724157251572615727157281572915730157311573215733157341573515736157371573815739157401574115742157431574415745157461574715748157491575015751157521575315754157551575615757157581575915760157611576215763157641576515766157671576815769157701577115772157731577415775157761577715778157791578015781157821578315784157851578615787157881578915790157911579215793157941579515796157971579815799158001580115802158031580415805158061580715808158091581015811158121581315814158151581615817158181581915820158211582215823158241582515826158271582815829158301583115832158331583415835158361583715838158391584015841158421584315844158451584615847158481584915850158511585215853158541585515856158571585815859158601586115862158631586415865158661586715868158691587015871158721587315874158751587615877158781587915880158811588215883158841588515886158871588815889158901589115892158931589415895158961589715898158991590015901159021590315904159051590615907159081590915910159111591215913159141591515916159171591815919159201592115922159231592415925159261592715928159291593015931159321593315934159351593615937159381593915940159411594215943159441594515946159471594815949159501595115952159531595415955159561595715958159591596015961159621596315964159651596615967159681596915970159711597215973159741597515976159771597815979159801598115982159831598415985159861598715988159891599015991159921599315994159951599615997159981599916000160011600216003160041600516006160071600816009160101601116012160131601416015160161601716018160191602016021160221602316024160251602616027160281602916030160311603216033160341603516036160371603816039160401604116042160431604416045160461604716048160491605016051160521605316054160551605616057160581605916060160611606216063160641606516066160671606816069160701607116072160731607416075160761607716078160791608016081160821608316084160851608616087160881608916090160911609216093160941609516096160971609816099161001610116102161031610416105161061610716108161091611016111161121611316114161151611616117161181611916120161211612216123161241612516126161271612816129161301613116132161331613416135161361613716138161391614016141161421614316144161451614616147161481614916150161511615216153161541615516156161571615816159161601616116162161631616416165161661616716168161691617016171161721617316174161751617616177161781617916180161811618216183161841618516186161871618816189161901619116192161931619416195161961619716198161991620016201162021620316204162051620616207162081620916210162111621216213162141621516216162171621816219162201622116222162231622416225162261622716228162291623016231162321623316234162351623616237162381623916240162411624216243162441624516246162471624816249162501625116252162531625416255162561625716258162591626016261162621626316264162651626616267162681626916270162711627216273162741627516276162771627816279162801628116282162831628416285162861628716288162891629016291162921629316294162951629616297162981629916300163011630216303163041630516306163071630816309163101631116312163131631416315163161631716318163191632016321163221632316324163251632616327163281632916330163311633216333163341633516336163371633816339163401634116342163431634416345163461634716348163491635016351163521635316354163551635616357163581635916360163611636216363163641636516366163671636816369163701637116372163731637416375163761637716378163791638016381163821638316384163851638616387163881638916390163911639216393163941639516396163971639816399164001640116402164031640416405164061640716408164091641016411164121641316414164151641616417164181641916420164211642216423164241642516426164271642816429164301643116432164331643416435164361643716438164391644016441164421644316444164451644616447164481644916450164511645216453164541645516456164571645816459164601646116462164631646416465164661646716468164691647016471164721647316474164751647616477164781647916480164811648216483164841648516486164871648816489164901649116492164931649416495164961649716498164991650016501165021650316504165051650616507165081650916510165111651216513165141651516516165171651816519165201652116522165231652416525165261652716528165291653016531165321653316534165351653616537165381653916540165411654216543165441654516546165471654816549165501655116552165531655416555165561655716558165591656016561165621656316564165651656616567165681656916570165711657216573165741657516576165771657816579165801658116582165831658416585165861658716588165891659016591165921659316594165951659616597165981659916600166011660216603166041660516606166071660816609166101661116612166131661416615166161661716618166191662016621166221662316624166251662616627166281662916630166311663216633166341663516636166371663816639166401664116642166431664416645166461664716648166491665016651166521665316654166551665616657166581665916660166611666216663166641666516666166671666816669166701667116672166731667416675166761667716678166791668016681166821668316684166851668616687166881668916690166911669216693166941669516696166971669816699167001670116702167031670416705167061670716708167091671016711167121671316714167151671616717167181671916720167211672216723167241672516726167271672816729167301673116732167331673416735167361673716738167391674016741167421674316744167451674616747167481674916750167511675216753167541675516756167571675816759167601676116762167631676416765167661676716768167691677016771167721677316774167751677616777167781677916780167811678216783167841678516786167871678816789167901679116792167931679416795167961679716798167991680016801168021680316804168051680616807168081680916810168111681216813168141681516816168171681816819168201682116822168231682416825168261682716828168291683016831168321683316834168351683616837168381683916840168411684216843168441684516846168471684816849168501685116852168531685416855168561685716858168591686016861168621686316864168651686616867168681686916870168711687216873168741687516876168771687816879168801688116882168831688416885168861688716888168891689016891168921689316894168951689616897168981689916900169011690216903169041690516906169071690816909169101691116912169131691416915169161691716918169191692016921169221692316924169251692616927169281692916930169311693216933169341693516936169371693816939169401694116942169431694416945169461694716948169491695016951169521695316954169551695616957169581695916960169611696216963169641696516966169671696816969169701697116972169731697416975169761697716978169791698016981169821698316984169851698616987169881698916990169911699216993169941699516996169971699816999170001700117002170031700417005170061700717008170091701017011170121701317014170151701617017170181701917020170211702217023170241702517026170271702817029170301703117032170331703417035170361703717038170391704017041170421704317044170451704617047170481704917050170511705217053170541705517056170571705817059170601706117062170631706417065170661706717068170691707017071170721707317074170751707617077170781707917080170811708217083170841708517086170871708817089170901709117092170931709417095170961709717098170991710017101171021710317104171051710617107171081710917110171111711217113171141711517116171171711817119171201712117122171231712417125171261712717128171291713017131171321713317134171351713617137171381713917140171411714217143171441714517146171471714817149171501715117152171531715417155171561715717158171591716017161171621716317164171651716617167171681716917170171711717217173171741717517176171771717817179171801718117182171831718417185171861718717188171891719017191171921719317194171951719617197171981719917200172011720217203172041720517206172071720817209172101721117212172131721417215172161721717218172191722017221172221722317224172251722617227172281722917230172311723217233172341723517236172371723817239172401724117242172431724417245172461724717248172491725017251172521725317254172551725617257172581725917260172611726217263172641726517266172671726817269172701727117272172731727417275172761727717278172791728017281172821728317284172851728617287172881728917290172911729217293172941729517296172971729817299173001730117302173031730417305173061730717308173091731017311173121731317314173151731617317173181731917320173211732217323173241732517326173271732817329173301733117332173331733417335173361733717338173391734017341173421734317344173451734617347173481734917350173511735217353173541735517356173571735817359173601736117362173631736417365173661736717368173691737017371173721737317374173751737617377173781737917380173811738217383173841738517386173871738817389173901739117392173931739417395173961739717398173991740017401174021740317404174051740617407174081740917410174111741217413174141741517416174171741817419174201742117422174231742417425174261742717428174291743017431174321743317434174351743617437174381743917440174411744217443174441744517446174471744817449174501745117452174531745417455174561745717458174591746017461174621746317464174651746617467174681746917470174711747217473174741747517476174771747817479174801748117482174831748417485174861748717488174891749017491174921749317494174951749617497174981749917500175011750217503175041750517506175071750817509175101751117512175131751417515175161751717518175191752017521175221752317524175251752617527175281752917530175311753217533175341753517536175371753817539175401754117542175431754417545175461754717548175491755017551175521755317554175551755617557175581755917560175611756217563175641756517566175671756817569175701757117572175731757417575175761757717578175791758017581175821758317584175851758617587175881758917590175911759217593175941759517596175971759817599176001760117602176031760417605176061760717608176091761017611176121761317614176151761617617176181761917620176211762217623176241762517626176271762817629176301763117632176331763417635176361763717638176391764017641176421764317644176451764617647176481764917650176511765217653176541765517656176571765817659176601766117662176631766417665176661766717668176691767017671176721767317674176751767617677176781767917680176811768217683176841768517686176871768817689176901769117692176931769417695176961769717698176991770017701177021770317704177051770617707177081770917710177111771217713177141771517716177171771817719177201772117722177231772417725177261772717728177291773017731177321773317734177351773617737177381773917740177411774217743177441774517746177471774817749177501775117752177531775417755177561775717758177591776017761177621776317764177651776617767177681776917770177711777217773177741777517776177771777817779177801778117782177831778417785177861778717788177891779017791177921779317794177951779617797177981779917800178011780217803178041780517806178071780817809178101781117812178131781417815178161781717818178191782017821178221782317824178251782617827178281782917830178311783217833178341783517836178371783817839178401784117842178431784417845178461784717848178491785017851178521785317854178551785617857178581785917860178611786217863178641786517866178671786817869178701787117872178731787417875178761787717878178791788017881178821788317884178851788617887178881788917890178911789217893178941789517896178971789817899179001790117902179031790417905179061790717908179091791017911179121791317914179151791617917179181791917920179211792217923179241792517926179271792817929179301793117932179331793417935179361793717938179391794017941179421794317944179451794617947179481794917950179511795217953179541795517956179571795817959179601796117962179631796417965179661796717968179691797017971179721797317974179751797617977179781797917980179811798217983179841798517986179871798817989179901799117992179931799417995179961799717998179991800018001180021800318004180051800618007180081800918010180111801218013180141801518016180171801818019180201802118022180231802418025180261802718028180291803018031180321803318034180351803618037180381803918040180411804218043180441804518046180471804818049180501805118052180531805418055180561805718058180591806018061180621806318064180651806618067180681806918070180711807218073180741807518076180771807818079180801808118082180831808418085180861808718088180891809018091180921809318094180951809618097180981809918100181011810218103181041810518106181071810818109181101811118112181131811418115181161811718118181191812018121181221812318124181251812618127181281812918130181311813218133181341813518136181371813818139181401814118142181431814418145181461814718148181491815018151181521815318154181551815618157181581815918160181611816218163181641816518166181671816818169181701817118172181731817418175181761817718178181791818018181181821818318184181851818618187181881818918190181911819218193181941819518196181971819818199182001820118202182031820418205182061820718208182091821018211182121821318214182151821618217182181821918220182211822218223182241822518226182271822818229182301823118232182331823418235182361823718238182391824018241182421824318244182451824618247182481824918250182511825218253182541825518256182571825818259182601826118262182631826418265182661826718268182691827018271182721827318274182751827618277182781827918280182811828218283182841828518286182871828818289182901829118292182931829418295182961829718298182991830018301183021830318304183051830618307183081830918310183111831218313183141831518316183171831818319183201832118322183231832418325183261832718328183291833018331183321833318334183351833618337183381833918340183411834218343183441834518346183471834818349183501835118352183531835418355183561835718358183591836018361183621836318364183651836618367183681836918370183711837218373183741837518376183771837818379183801838118382183831838418385183861838718388183891839018391183921839318394183951839618397183981839918400184011840218403184041840518406184071840818409184101841118412184131841418415184161841718418184191842018421184221842318424184251842618427184281842918430184311843218433184341843518436184371843818439184401844118442184431844418445184461844718448184491845018451184521845318454184551845618457184581845918460184611846218463184641846518466184671846818469184701847118472184731847418475184761847718478184791848018481184821848318484184851848618487184881848918490184911849218493184941849518496184971849818499185001850118502185031850418505185061850718508185091851018511185121851318514185151851618517185181851918520185211852218523185241852518526185271852818529185301853118532185331853418535185361853718538185391854018541185421854318544185451854618547185481854918550185511855218553185541855518556185571855818559185601856118562185631856418565185661856718568185691857018571185721857318574185751857618577185781857918580185811858218583185841858518586185871858818589185901859118592185931859418595185961859718598185991860018601186021860318604186051860618607186081860918610186111861218613186141861518616186171861818619186201862118622186231862418625186261862718628186291863018631186321863318634186351863618637186381863918640186411864218643186441864518646186471864818649186501865118652186531865418655186561865718658186591866018661186621866318664186651866618667186681866918670186711867218673186741867518676186771867818679186801868118682186831868418685186861868718688186891869018691186921869318694186951869618697186981869918700187011870218703187041870518706187071870818709187101871118712187131871418715187161871718718187191872018721187221872318724187251872618727187281872918730187311873218733187341873518736187371873818739187401874118742187431874418745187461874718748187491875018751187521875318754187551875618757187581875918760187611876218763187641876518766187671876818769187701877118772187731877418775187761877718778187791878018781187821878318784187851878618787187881878918790187911879218793187941879518796187971879818799188001880118802188031880418805188061880718808188091881018811188121881318814188151881618817188181881918820188211882218823188241882518826188271882818829188301883118832188331883418835188361883718838188391884018841188421884318844188451884618847188481884918850188511885218853188541885518856188571885818859188601886118862188631886418865188661886718868188691887018871188721887318874188751887618877188781887918880188811888218883188841888518886188871888818889188901889118892188931889418895188961889718898188991890018901189021890318904189051890618907189081890918910189111891218913189141891518916189171891818919189201892118922189231892418925189261892718928189291893018931189321893318934189351893618937189381893918940189411894218943189441894518946189471894818949189501895118952189531895418955189561895718958189591896018961189621896318964189651896618967189681896918970189711897218973189741897518976189771897818979189801898118982189831898418985189861898718988189891899018991189921899318994189951899618997189981899919000190011900219003190041900519006190071900819009190101901119012190131901419015190161901719018190191902019021190221902319024190251902619027190281902919030190311903219033190341903519036190371903819039190401904119042190431904419045190461904719048190491905019051190521905319054190551905619057190581905919060190611906219063190641906519066190671906819069190701907119072190731907419075190761907719078190791908019081190821908319084190851908619087190881908919090190911909219093190941909519096190971909819099191001910119102191031910419105191061910719108191091911019111191121911319114191151911619117191181911919120191211912219123191241912519126191271912819129191301913119132191331913419135191361913719138191391914019141191421914319144191451914619147191481914919150191511915219153191541915519156191571915819159191601916119162191631916419165191661916719168191691917019171191721917319174191751917619177191781917919180191811918219183191841918519186191871918819189191901919119192191931919419195191961919719198191991920019201192021920319204192051920619207192081920919210192111921219213192141921519216192171921819219192201922119222192231922419225192261922719228192291923019231192321923319234192351923619237192381923919240192411924219243192441924519246192471924819249192501925119252192531925419255192561925719258192591926019261192621926319264192651926619267192681926919270192711927219273192741927519276192771927819279192801928119282192831928419285192861928719288192891929019291192921929319294192951929619297192981929919300193011930219303193041930519306193071930819309193101931119312193131931419315193161931719318193191932019321193221932319324193251932619327193281932919330193311933219333193341933519336193371933819339193401934119342193431934419345193461934719348193491935019351193521935319354193551935619357193581935919360193611936219363193641936519366193671936819369193701937119372193731937419375193761937719378193791938019381193821938319384193851938619387193881938919390193911939219393193941939519396193971939819399194001940119402194031940419405194061940719408194091941019411194121941319414194151941619417194181941919420194211942219423194241942519426194271942819429194301943119432194331943419435194361943719438194391944019441194421944319444194451944619447194481944919450194511945219453194541945519456194571945819459194601946119462194631946419465194661946719468194691947019471194721947319474194751947619477194781947919480194811948219483194841948519486194871948819489194901949119492194931949419495194961949719498194991950019501195021950319504195051950619507195081950919510195111951219513195141951519516195171951819519195201952119522195231952419525195261952719528195291953019531195321953319534195351953619537195381953919540195411954219543195441954519546195471954819549195501955119552195531955419555195561955719558195591956019561195621956319564195651956619567195681956919570195711957219573195741957519576195771957819579195801958119582195831958419585195861958719588195891959019591195921959319594195951959619597195981959919600196011960219603196041960519606196071960819609196101961119612196131961419615196161961719618196191962019621196221962319624196251962619627196281962919630196311963219633196341963519636196371963819639196401964119642196431964419645196461964719648196491965019651196521965319654196551965619657196581965919660196611966219663196641966519666196671966819669196701967119672196731967419675196761967719678196791968019681196821968319684196851968619687196881968919690196911969219693196941969519696196971969819699197001970119702197031970419705197061970719708197091971019711197121971319714197151971619717197181971919720197211972219723197241972519726197271972819729197301973119732197331973419735197361973719738197391974019741197421974319744197451974619747197481974919750197511975219753197541975519756197571975819759197601976119762197631976419765197661976719768197691977019771197721977319774197751977619777197781977919780197811978219783197841978519786197871978819789197901979119792197931979419795197961979719798197991980019801198021980319804198051980619807198081980919810198111981219813198141981519816198171981819819198201982119822198231982419825198261982719828198291983019831198321983319834198351983619837198381983919840198411984219843198441984519846198471984819849198501985119852198531985419855198561985719858198591986019861198621986319864198651986619867198681986919870198711987219873198741987519876198771987819879198801988119882198831988419885198861988719888198891989019891198921989319894198951989619897198981989919900199011990219903199041990519906199071990819909199101991119912199131991419915199161991719918199191992019921199221992319924199251992619927199281992919930199311993219933199341993519936199371993819939199401994119942199431994419945199461994719948199491995019951199521995319954199551995619957199581995919960199611996219963199641996519966199671996819969199701997119972199731997419975199761997719978199791998019981199821998319984199851998619987199881998919990199911999219993199941999519996199971999819999200002000120002200032000420005200062000720008200092001020011200122001320014200152001620017200182001920020200212002220023200242002520026200272002820029200302003120032200332003420035200362003720038200392004020041200422004320044200452004620047200482004920050200512005220053200542005520056200572005820059200602006120062200632006420065200662006720068200692007020071200722007320074200752007620077200782007920080200812008220083200842008520086200872008820089200902009120092200932009420095200962009720098200992010020101201022010320104201052010620107201082010920110201112011220113201142011520116201172011820119201202012120122201232012420125201262012720128201292013020131201322013320134201352013620137201382013920140201412014220143201442014520146201472014820149201502015120152201532015420155201562015720158201592016020161201622016320164201652016620167201682016920170201712017220173201742017520176201772017820179201802018120182201832018420185201862018720188201892019020191201922019320194201952019620197201982019920200202012020220203202042020520206202072020820209202102021120212202132021420215202162021720218202192022020221202222022320224202252022620227202282022920230202312023220233202342023520236202372023820239202402024120242202432024420245202462024720248202492025020251202522025320254202552025620257202582025920260202612026220263202642026520266202672026820269202702027120272202732027420275202762027720278202792028020281202822028320284202852028620287202882028920290202912029220293202942029520296202972029820299203002030120302203032030420305203062030720308203092031020311203122031320314203152031620317203182031920320203212032220323203242032520326203272032820329203302033120332203332033420335203362033720338203392034020341203422034320344203452034620347203482034920350203512035220353203542035520356203572035820359203602036120362203632036420365203662036720368203692037020371203722037320374203752037620377203782037920380203812038220383203842038520386203872038820389203902039120392203932039420395203962039720398203992040020401204022040320404204052040620407204082040920410204112041220413204142041520416204172041820419204202042120422204232042420425204262042720428204292043020431204322043320434204352043620437204382043920440204412044220443204442044520446204472044820449204502045120452204532045420455204562045720458204592046020461204622046320464204652046620467204682046920470204712047220473204742047520476204772047820479204802048120482204832048420485204862048720488204892049020491204922049320494204952049620497204982049920500205012050220503205042050520506205072050820509205102051120512205132051420515205162051720518205192052020521205222052320524205252052620527205282052920530205312053220533205342053520536205372053820539205402054120542205432054420545205462054720548205492055020551205522055320554205552055620557205582055920560205612056220563205642056520566205672056820569205702057120572205732057420575205762057720578205792058020581205822058320584205852058620587205882058920590205912059220593205942059520596205972059820599206002060120602206032060420605206062060720608206092061020611206122061320614206152061620617206182061920620206212062220623206242062520626206272062820629206302063120632206332063420635206362063720638206392064020641206422064320644206452064620647206482064920650206512065220653206542065520656206572065820659206602066120662206632066420665206662066720668206692067020671206722067320674206752067620677206782067920680206812068220683206842068520686206872068820689206902069120692206932069420695206962069720698206992070020701207022070320704207052070620707207082070920710207112071220713207142071520716207172071820719207202072120722207232072420725207262072720728207292073020731207322073320734207352073620737207382073920740207412074220743207442074520746207472074820749207502075120752207532075420755207562075720758207592076020761207622076320764207652076620767207682076920770207712077220773207742077520776207772077820779207802078120782207832078420785207862078720788207892079020791207922079320794207952079620797207982079920800208012080220803208042080520806208072080820809208102081120812208132081420815208162081720818208192082020821208222082320824208252082620827208282082920830208312083220833208342083520836208372083820839208402084120842208432084420845208462084720848208492085020851208522085320854208552085620857208582085920860208612086220863208642086520866208672086820869208702087120872208732087420875208762087720878208792088020881208822088320884208852088620887208882088920890208912089220893208942089520896208972089820899209002090120902209032090420905209062090720908209092091020911209122091320914209152091620917209182091920920209212092220923209242092520926209272092820929209302093120932209332093420935209362093720938209392094020941209422094320944209452094620947209482094920950209512095220953209542095520956209572095820959209602096120962209632096420965209662096720968209692097020971209722097320974209752097620977209782097920980209812098220983209842098520986209872098820989209902099120992209932099420995209962099720998209992100021001210022100321004210052100621007210082100921010210112101221013210142101521016210172101821019210202102121022210232102421025210262102721028210292103021031210322103321034210352103621037210382103921040210412104221043210442104521046210472104821049210502105121052210532105421055210562105721058210592106021061210622106321064210652106621067210682106921070210712107221073210742107521076210772107821079210802108121082210832108421085210862108721088210892109021091210922109321094210952109621097210982109921100211012110221103211042110521106211072110821109211102111121112211132111421115211162111721118211192112021121211222112321124211252112621127211282112921130211312113221133211342113521136211372113821139211402114121142211432114421145211462114721148211492115021151211522115321154211552115621157211582115921160211612116221163211642116521166211672116821169211702117121172211732117421175211762117721178211792118021181211822118321184211852118621187211882118921190211912119221193211942119521196211972119821199212002120121202212032120421205212062120721208212092121021211212122121321214212152121621217212182121921220212212122221223212242122521226212272122821229212302123121232212332123421235212362123721238212392124021241212422124321244212452124621247212482124921250212512125221253212542125521256212572125821259212602126121262212632126421265212662126721268212692127021271212722127321274212752127621277212782127921280212812128221283212842128521286212872128821289212902129121292212932129421295212962129721298212992130021301213022130321304213052130621307213082130921310213112131221313213142131521316213172131821319213202132121322213232132421325213262132721328213292133021331213322133321334213352133621337213382133921340213412134221343213442134521346213472134821349213502135121352213532135421355213562135721358213592136021361213622136321364213652136621367213682136921370213712137221373213742137521376213772137821379213802138121382213832138421385213862138721388213892139021391213922139321394213952139621397213982139921400214012140221403214042140521406214072140821409214102141121412214132141421415214162141721418214192142021421214222142321424214252142621427214282142921430214312143221433214342143521436214372143821439214402144121442214432144421445214462144721448214492145021451214522145321454214552145621457214582145921460214612146221463214642146521466214672146821469214702147121472214732147421475214762147721478214792148021481214822148321484214852148621487214882148921490214912149221493214942149521496214972149821499215002150121502215032150421505215062150721508215092151021511215122151321514215152151621517215182151921520215212152221523215242152521526215272152821529215302153121532215332153421535215362153721538215392154021541215422154321544215452154621547215482154921550215512155221553215542155521556215572155821559215602156121562215632156421565215662156721568215692157021571215722157321574215752157621577215782157921580215812158221583215842158521586215872158821589215902159121592215932159421595215962159721598215992160021601216022160321604216052160621607216082160921610216112161221613216142161521616216172161821619216202162121622216232162421625216262162721628216292163021631216322163321634216352163621637216382163921640216412164221643216442164521646216472164821649216502165121652216532165421655216562165721658216592166021661216622166321664216652166621667216682166921670216712167221673216742167521676216772167821679216802168121682216832168421685216862168721688216892169021691216922169321694216952169621697216982169921700217012170221703217042170521706217072170821709217102171121712217132171421715217162171721718217192172021721217222172321724217252172621727217282172921730217312173221733217342173521736217372173821739217402174121742217432174421745217462174721748217492175021751217522175321754217552175621757217582175921760217612176221763217642176521766217672176821769217702177121772217732177421775217762177721778217792178021781217822178321784217852178621787217882178921790217912179221793217942179521796217972179821799218002180121802218032180421805218062180721808218092181021811218122181321814218152181621817218182181921820218212182221823218242182521826218272182821829218302183121832218332183421835218362183721838218392184021841218422184321844218452184621847218482184921850218512185221853218542185521856218572185821859218602186121862218632186421865218662186721868218692187021871218722187321874218752187621877218782187921880218812188221883218842188521886218872188821889218902189121892218932189421895218962189721898218992190021901219022190321904219052190621907219082190921910219112191221913219142191521916219172191821919219202192121922219232192421925219262192721928219292193021931219322193321934219352193621937219382193921940219412194221943219442194521946219472194821949219502195121952219532195421955219562195721958219592196021961219622196321964219652196621967219682196921970219712197221973219742197521976219772197821979219802198121982219832198421985219862198721988219892199021991219922199321994219952199621997219982199922000220012200222003220042200522006220072200822009220102201122012220132201422015220162201722018220192202022021220222202322024220252202622027220282202922030220312203222033220342203522036220372203822039220402204122042220432204422045220462204722048220492205022051220522205322054220552205622057220582205922060220612206222063220642206522066220672206822069220702207122072220732207422075220762207722078220792208022081220822208322084220852208622087220882208922090220912209222093220942209522096220972209822099221002210122102221032210422105221062210722108221092211022111221122211322114221152211622117221182211922120221212212222123221242212522126221272212822129221302213122132221332213422135221362213722138221392214022141221422214322144221452214622147221482214922150221512215222153221542215522156221572215822159221602216122162221632216422165221662216722168221692217022171221722217322174221752217622177221782217922180221812218222183221842218522186221872218822189221902219122192221932219422195221962219722198221992220022201222022220322204222052220622207222082220922210222112221222213222142221522216222172221822219222202222122222222232222422225222262222722228222292223022231222322223322234222352223622237222382223922240222412224222243222442224522246222472224822249222502225122252222532225422255222562225722258222592226022261222622226322264222652226622267222682226922270222712227222273222742227522276222772227822279222802228122282222832228422285222862228722288222892229022291222922229322294222952229622297222982229922300223012230222303223042230522306223072230822309223102231122312223132231422315223162231722318223192232022321223222232322324223252232622327223282232922330223312233222333223342233522336223372233822339223402234122342223432234422345223462234722348223492235022351223522235322354223552235622357223582235922360223612236222363223642236522366223672236822369223702237122372223732237422375223762237722378223792238022381223822238322384223852238622387223882238922390223912239222393223942239522396223972239822399224002240122402224032240422405224062240722408224092241022411224122241322414224152241622417224182241922420224212242222423224242242522426224272242822429224302243122432224332243422435224362243722438224392244022441224422244322444224452244622447224482244922450224512245222453224542245522456224572245822459224602246122462224632246422465224662246722468224692247022471224722247322474224752247622477224782247922480224812248222483224842248522486224872248822489224902249122492224932249422495224962249722498224992250022501225022250322504225052250622507225082250922510225112251222513225142251522516225172251822519225202252122522225232252422525225262252722528225292253022531225322253322534225352253622537225382253922540225412254222543225442254522546225472254822549225502255122552225532255422555225562255722558225592256022561225622256322564225652256622567225682256922570225712257222573225742257522576225772257822579225802258122582225832258422585225862258722588225892259022591225922259322594225952259622597225982259922600226012260222603226042260522606226072260822609226102261122612226132261422615226162261722618226192262022621226222262322624226252262622627226282262922630226312263222633226342263522636226372263822639226402264122642226432264422645226462264722648226492265022651226522265322654226552265622657226582265922660226612266222663226642266522666226672266822669226702267122672226732267422675226762267722678226792268022681226822268322684226852268622687226882268922690226912269222693226942269522696226972269822699227002270122702227032270422705227062270722708227092271022711227122271322714227152271622717227182271922720227212272222723227242272522726227272272822729227302273122732227332273422735227362273722738227392274022741227422274322744227452274622747227482274922750227512275222753227542275522756227572275822759227602276122762227632276422765227662276722768227692277022771227722277322774227752277622777227782277922780227812278222783227842278522786227872278822789227902279122792227932279422795227962279722798227992280022801228022280322804228052280622807228082280922810228112281222813228142281522816228172281822819228202282122822228232282422825228262282722828228292283022831228322283322834228352283622837228382283922840228412284222843228442284522846228472284822849228502285122852228532285422855228562285722858228592286022861228622286322864228652286622867228682286922870228712287222873228742287522876228772287822879228802288122882228832288422885228862288722888228892289022891228922289322894228952289622897228982289922900229012290222903229042290522906229072290822909229102291122912229132291422915229162291722918229192292022921229222292322924229252292622927229282292922930229312293222933229342293522936229372293822939229402294122942229432294422945229462294722948229492295022951229522295322954229552295622957229582295922960229612296222963229642296522966229672296822969229702297122972229732297422975229762297722978229792298022981229822298322984229852298622987229882298922990229912299222993229942299522996229972299822999230002300123002230032300423005230062300723008230092301023011230122301323014230152301623017230182301923020230212302223023230242302523026230272302823029230302303123032230332303423035230362303723038230392304023041230422304323044230452304623047230482304923050230512305223053230542305523056230572305823059230602306123062230632306423065230662306723068230692307023071230722307323074230752307623077230782307923080230812308223083230842308523086230872308823089230902309123092230932309423095230962309723098230992310023101231022310323104231052310623107231082310923110231112311223113231142311523116231172311823119231202312123122231232312423125231262312723128231292313023131231322313323134231352313623137231382313923140231412314223143231442314523146231472314823149231502315123152231532315423155231562315723158231592316023161231622316323164231652316623167231682316923170231712317223173231742317523176231772317823179231802318123182231832318423185231862318723188231892319023191231922319323194231952319623197231982319923200232012320223203232042320523206232072320823209232102321123212232132321423215232162321723218232192322023221232222322323224232252322623227232282322923230232312323223233232342323523236232372323823239232402324123242232432324423245232462324723248232492325023251232522325323254232552325623257232582325923260232612326223263232642326523266232672326823269232702327123272232732327423275232762327723278232792328023281232822328323284232852328623287232882328923290232912329223293232942329523296232972329823299233002330123302233032330423305233062330723308233092331023311233122331323314233152331623317233182331923320233212332223323233242332523326233272332823329233302333123332233332333423335233362333723338233392334023341233422334323344233452334623347233482334923350233512335223353233542335523356233572335823359233602336123362233632336423365233662336723368233692337023371233722337323374233752337623377233782337923380233812338223383233842338523386233872338823389233902339123392233932339423395233962339723398233992340023401234022340323404234052340623407234082340923410234112341223413234142341523416234172341823419234202342123422234232342423425234262342723428234292343023431234322343323434234352343623437234382343923440234412344223443234442344523446234472344823449234502345123452234532345423455234562345723458234592346023461234622346323464234652346623467234682346923470234712347223473234742347523476234772347823479234802348123482234832348423485234862348723488234892349023491234922349323494234952349623497234982349923500235012350223503235042350523506235072350823509235102351123512235132351423515235162351723518235192352023521235222352323524235252352623527235282352923530235312353223533235342353523536235372353823539235402354123542235432354423545235462354723548235492355023551235522355323554235552355623557235582355923560235612356223563235642356523566235672356823569235702357123572235732357423575235762357723578235792358023581235822358323584235852358623587235882358923590235912359223593235942359523596235972359823599236002360123602236032360423605236062360723608236092361023611236122361323614236152361623617236182361923620236212362223623236242362523626236272362823629236302363123632236332363423635236362363723638236392364023641236422364323644236452364623647236482364923650236512365223653236542365523656236572365823659236602366123662236632366423665236662366723668236692367023671236722367323674236752367623677236782367923680236812368223683236842368523686236872368823689236902369123692236932369423695236962369723698236992370023701237022370323704237052370623707237082370923710237112371223713237142371523716237172371823719237202372123722237232372423725237262372723728237292373023731237322373323734237352373623737237382373923740237412374223743237442374523746237472374823749237502375123752237532375423755237562375723758237592376023761237622376323764237652376623767237682376923770237712377223773237742377523776237772377823779237802378123782237832378423785237862378723788237892379023791237922379323794237952379623797237982379923800238012380223803238042380523806238072380823809238102381123812238132381423815238162381723818238192382023821238222382323824238252382623827238282382923830238312383223833238342383523836238372383823839238402384123842238432384423845238462384723848238492385023851238522385323854238552385623857238582385923860238612386223863238642386523866238672386823869238702387123872238732387423875238762387723878238792388023881238822388323884238852388623887238882388923890238912389223893238942389523896238972389823899239002390123902239032390423905239062390723908239092391023911239122391323914239152391623917239182391923920239212392223923239242392523926239272392823929239302393123932239332393423935239362393723938239392394023941239422394323944239452394623947239482394923950239512395223953239542395523956239572395823959239602396123962239632396423965239662396723968239692397023971239722397323974239752397623977239782397923980239812398223983239842398523986239872398823989239902399123992239932399423995239962399723998239992400024001240022400324004240052400624007240082400924010240112401224013240142401524016240172401824019240202402124022240232402424025240262402724028240292403024031240322403324034240352403624037240382403924040240412404224043240442404524046240472404824049240502405124052240532405424055240562405724058240592406024061240622406324064240652406624067240682406924070240712407224073240742407524076240772407824079240802408124082240832408424085240862408724088240892409024091240922409324094240952409624097240982409924100241012410224103241042410524106241072410824109241102411124112241132411424115241162411724118241192412024121241222412324124241252412624127241282412924130241312413224133241342413524136241372413824139241402414124142241432414424145241462414724148241492415024151241522415324154241552415624157241582415924160241612416224163241642416524166241672416824169241702417124172241732417424175241762417724178241792418024181241822418324184241852418624187241882418924190241912419224193241942419524196241972419824199242002420124202242032420424205242062420724208242092421024211242122421324214242152421624217242182421924220242212422224223242242422524226242272422824229242302423124232242332423424235242362423724238242392424024241242422424324244242452424624247242482424924250242512425224253242542425524256242572425824259242602426124262242632426424265242662426724268242692427024271242722427324274242752427624277242782427924280242812428224283242842428524286242872428824289242902429124292242932429424295242962429724298242992430024301243022430324304243052430624307243082430924310243112431224313243142431524316243172431824319243202432124322243232432424325243262432724328243292433024331243322433324334243352433624337243382433924340243412434224343243442434524346243472434824349243502435124352243532435424355243562435724358243592436024361243622436324364243652436624367243682436924370243712437224373243742437524376243772437824379243802438124382243832438424385243862438724388243892439024391243922439324394243952439624397243982439924400244012440224403244042440524406244072440824409244102441124412244132441424415244162441724418244192442024421244222442324424244252442624427244282442924430244312443224433244342443524436244372443824439244402444124442244432444424445244462444724448244492445024451244522445324454244552445624457244582445924460244612446224463244642446524466244672446824469244702447124472244732447424475244762447724478244792448024481244822448324484244852448624487244882448924490244912449224493244942449524496244972449824499245002450124502245032450424505245062450724508245092451024511245122451324514245152451624517245182451924520245212452224523245242452524526245272452824529245302453124532245332453424535245362453724538245392454024541245422454324544245452454624547245482454924550245512455224553245542455524556245572455824559245602456124562245632456424565245662456724568245692457024571245722457324574245752457624577245782457924580245812458224583245842458524586245872458824589245902459124592245932459424595245962459724598245992460024601246022460324604246052460624607246082460924610246112461224613246142461524616246172461824619246202462124622246232462424625246262462724628246292463024631246322463324634246352463624637246382463924640246412464224643246442464524646246472464824649246502465124652246532465424655246562465724658246592466024661246622466324664246652466624667246682466924670246712467224673246742467524676246772467824679246802468124682246832468424685246862468724688246892469024691246922469324694246952469624697246982469924700247012470224703247042470524706247072470824709247102471124712247132471424715247162471724718247192472024721247222472324724247252472624727247282472924730247312473224733247342473524736247372473824739247402474124742247432474424745247462474724748247492475024751247522475324754247552475624757247582475924760247612476224763247642476524766247672476824769247702477124772247732477424775247762477724778247792478024781247822478324784247852478624787247882478924790247912479224793247942479524796247972479824799248002480124802248032480424805248062480724808248092481024811248122481324814248152481624817248182481924820248212482224823248242482524826248272482824829248302483124832248332483424835248362483724838248392484024841248422484324844248452484624847248482484924850248512485224853248542485524856248572485824859248602486124862248632486424865248662486724868248692487024871248722487324874248752487624877248782487924880248812488224883248842488524886248872488824889248902489124892248932489424895248962489724898248992490024901249022490324904249052490624907249082490924910249112491224913249142491524916249172491824919249202492124922249232492424925249262492724928249292493024931249322493324934249352493624937249382493924940249412494224943249442494524946249472494824949249502495124952249532495424955249562495724958249592496024961249622496324964249652496624967249682496924970249712497224973249742497524976249772497824979249802498124982249832498424985249862498724988249892499024991249922499324994249952499624997249982499925000250012500225003250042500525006250072500825009250102501125012250132501425015250162501725018250192502025021250222502325024250252502625027250282502925030250312503225033250342503525036250372503825039250402504125042250432504425045250462504725048250492505025051250522505325054250552505625057250582505925060250612506225063250642506525066250672506825069250702507125072250732507425075250762507725078250792508025081250822508325084250852508625087250882508925090250912509225093250942509525096250972509825099251002510125102251032510425105251062510725108251092511025111251122511325114251152511625117251182511925120251212512225123251242512525126251272512825129251302513125132251332513425135251362513725138251392514025141251422514325144251452514625147251482514925150
  1. ;;; org.el --- Outline-based notes management and organizer
  2. ;; Carstens outline-mode for keeping track of everything.
  3. ;; Copyright (C) 2004-2015 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-mode 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 contain
  29. ;; information about projects as plain text. Org-mode is implemented on
  30. ;; top of outline-mode, which makes it possible to keep the content of
  31. ;; large files well structured. Visibility cycling and structure editing
  32. ;; help to work with the tree. Tables are easily created with a built-in
  33. ;; table editor. Org-mode supports ToDo items, deadlines, time stamps,
  34. ;; and scheduling. It dynamically compiles entries into an agenda that
  35. ;; utilizes and smoothly integrates much of the Emacs calendar and diary.
  36. ;; Plain text URL-like links connect to websites, emails, Usenet
  37. ;; messages, BBDB entries, and any files related to the projects. For
  38. ;; printing and sharing of notes, an Org-mode file can be exported as a
  39. ;; structured ASCII file, as HTML, or (todo and agenda items only) as an
  40. ;; iCalendar file. It can also serve as a publishing tool for a set of
  41. ;; linked webpages.
  42. ;;
  43. ;; Installation and Activation
  44. ;; ---------------------------
  45. ;; See the corresponding sections in the manual at
  46. ;;
  47. ;; http://orgmode.org/org.html#Installation
  48. ;;
  49. ;; Documentation
  50. ;; -------------
  51. ;; The documentation of Org-mode can be found in the TeXInfo file. The
  52. ;; distribution also contains a PDF version of it. At the homepage of
  53. ;; Org-mode, you can read the same text online as HTML. There is also an
  54. ;; excellent reference card made by Philip Rooke. This card can be found
  55. ;; in the etc/ directory of Emacs 22.
  56. ;;
  57. ;; A list of recent changes can be found at
  58. ;; http://orgmode.org/Changes.html
  59. ;;
  60. ;;; Code:
  61. (defvar org-inhibit-highlight-removal nil) ; dynamically scoped param
  62. (defvar org-table-formula-constants-local nil
  63. "Local version of `org-table-formula-constants'.")
  64. (make-variable-buffer-local 'org-table-formula-constants-local)
  65. ;;;; Require other packages
  66. (eval-when-compile
  67. (require 'cl)
  68. (require 'gnus-sum))
  69. (require 'calendar)
  70. (require 'find-func)
  71. (require 'format-spec)
  72. (or (equal this-command 'eval-buffer)
  73. (condition-case nil
  74. (load (concat (file-name-directory load-file-name)
  75. "org-loaddefs.el")
  76. nil t t t)
  77. (error
  78. (message "WARNING: No org-loaddefs.el file could be found from where org.el is loaded.")
  79. (sit-for 3)
  80. (message "You need to run \"make\" or \"make autoloads\" from Org lisp directory")
  81. (sit-for 3))))
  82. (require 'org-macs)
  83. (require 'org-compat)
  84. ;; `org-outline-regexp' ought to be a defconst but is let-bound in
  85. ;; some places -- e.g. see the macro `org-with-limited-levels'.
  86. ;;
  87. ;; In Org buffers, the value of `outline-regexp' is that of
  88. ;; `org-outline-regexp'. The only function still directly relying on
  89. ;; `outline-regexp' is `org-overview' so that `org-cycle' can do its
  90. ;; job when `orgstruct-mode' is active.
  91. (defvar org-outline-regexp "\\*+ "
  92. "Regexp to match Org headlines.")
  93. (defvar org-outline-regexp-bol "^\\*+ "
  94. "Regexp to match Org headlines.
  95. This is similar to `org-outline-regexp' but additionally makes
  96. sure that we are at the beginning of the line.")
  97. (defvar org-heading-regexp "^\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
  98. "Matches a headline, putting stars and text into groups.
  99. Stars are put in group 1 and the trimmed body in group 2.")
  100. ;; Emacs 22 calendar compatibility: Make sure the new variables are available
  101. (unless (boundp 'calendar-view-holidays-initially-flag)
  102. (org-defvaralias 'calendar-view-holidays-initially-flag
  103. 'view-calendar-holidays-initially))
  104. (unless (boundp 'calendar-view-diary-initially-flag)
  105. (org-defvaralias 'calendar-view-diary-initially-flag
  106. 'view-diary-entries-initially))
  107. (unless (boundp 'diary-fancy-buffer)
  108. (org-defvaralias 'diary-fancy-buffer 'fancy-diary-buffer))
  109. (declare-function cdlatex-environment "ext:cdlatex" (environment item))
  110. (declare-function org-add-archive-files "org-archive" (files))
  111. (declare-function org-agenda-entry-get-agenda-timestamp "org-agenda" (pom))
  112. (declare-function org-agenda-list "org-agenda" (&optional arg start-day span))
  113. (declare-function org-agenda-redo "org-agenda" (&optional all))
  114. (declare-function org-babel-do-in-edit-buffer "ob-core" (&rest body))
  115. (declare-function org-babel-tangle-file "ob-tangle" (file &optional target-file lang))
  116. (declare-function org-beamer-mode "ox-beamer" ())
  117. (declare-function org-clock-get-last-clock-out-time "org-clock" ())
  118. (declare-function org-clock-out "org-clock" (&optional switch-to-state fail-quietly at-time))
  119. (declare-function org-clock-remove-overlays "org-clock" (&optional beg end noremove))
  120. (declare-function org-clock-sum "org-clock" (&optional tstart tend headline-filter propname))
  121. (declare-function org-clock-sum-current-item "org-clock" (&optional tstart))
  122. (declare-function org-clock-timestamps-down "org-clock" (&optional n))
  123. (declare-function org-clock-timestamps-up "org-clock" (&optional n))
  124. (declare-function org-clock-update-time-maybe "org-clock" ())
  125. (declare-function org-clocktable-shift "org-clock" (dir n))
  126. (declare-function org-element-at-point "org-element" ())
  127. (declare-function org-element-cache-refresh "org-element" (pos))
  128. (declare-function org-element-cache-reset "org-element" (&optional all))
  129. (declare-function org-element-contents "org-element" (element))
  130. (declare-function org-element-context "org-element" (&optional element))
  131. (declare-function org-element-copy "org-element" (datum))
  132. (declare-function org-element-interpret-data "org-element" (data &optional parent))
  133. (declare-function org-element-lineage "org-element" (blob &optional types with-self))
  134. (declare-function org-element-nested-p "org-element" (elem-a elem-b))
  135. (declare-function org-element-parse-buffer "org-element" (&optional granularity visible-only))
  136. (declare-function org-element-property "org-element" (property element))
  137. (declare-function org-element-put-property "org-element" (element property value))
  138. (declare-function org-element-swap-A-B "org-element" (elem-a elem-b))
  139. (declare-function org-element-type "org-element" (element))
  140. (declare-function org-element-update-syntax "org-element" ())
  141. (declare-function org-id-find-id-file "org-id" (id))
  142. (declare-function org-id-get-create "org-id" (&optional force))
  143. (declare-function org-inlinetask-at-task-p "org-inlinetask" ())
  144. (declare-function org-inlinetask-outline-regexp "org-inlinetask" ())
  145. (declare-function org-inlinetask-toggle-visibility "org-inlinetask" ())
  146. (declare-function org-plot/gnuplot "org-plot" (&optional params))
  147. (declare-function org-pop-to-buffer-same-window "org-compat" (&optional buffer-or-name norecord label))
  148. (declare-function org-table-align "org-table" ())
  149. (declare-function org-table-begin "org-table" (&optional table-type))
  150. (declare-function org-table-beginning-of-field "org-table" (&optional n))
  151. (declare-function org-table-blank-field "org-table" ())
  152. (declare-function org-table-calc-current-TBLFM "org-table" (&optional arg))
  153. (declare-function org-table-edit-field "org-table" (arg))
  154. (declare-function org-table-end "org-table" (&optional table-type))
  155. (declare-function org-table-end-of-field "org-table" (&optional n))
  156. (declare-function org-table-insert-row "org-table" (&optional arg))
  157. (declare-function org-table-justify-field-maybe "org-table" (&optional new))
  158. (declare-function org-table-maybe-eval-formula "org-table" ())
  159. (declare-function org-table-maybe-recalculate-line "org-table" ())
  160. (declare-function org-table-next-row "org-table" ())
  161. (declare-function org-table-paste-rectangle "org-table" ())
  162. (declare-function org-tags-view "org-agenda" (&optional todo-only match))
  163. (declare-function orgtbl-ascii-plot "org-table" (&optional ask))
  164. (declare-function orgtbl-mode "org-table" (&optional arg))
  165. (defsubst org-uniquify (list)
  166. "Non-destructively remove duplicate elements from LIST."
  167. (let ((res (copy-sequence list))) (delete-dups res)))
  168. (defsubst org-get-at-bol (property)
  169. "Get text property PROPERTY at the beginning of line."
  170. (get-text-property (point-at-bol) property))
  171. (defsubst org-trim (s)
  172. "Remove whitespace at the beginning and the end of string S."
  173. (replace-regexp-in-string
  174. "\\`[ \t\n\r]+" ""
  175. (replace-regexp-in-string "[ \t\n\r]+\\'" "" s)))
  176. ;; load languages based on value of `org-babel-load-languages'
  177. (defvar org-babel-load-languages)
  178. ;;;###autoload
  179. (defun org-babel-do-load-languages (sym value)
  180. "Load the languages defined in `org-babel-load-languages'."
  181. (set-default sym value)
  182. (mapc (lambda (pair)
  183. (let ((active (cdr pair)) (lang (symbol-name (car pair))))
  184. (if active
  185. (progn
  186. (require (intern (concat "ob-" lang))))
  187. (progn
  188. (funcall 'fmakunbound
  189. (intern (concat "org-babel-execute:" lang)))
  190. (funcall 'fmakunbound
  191. (intern (concat "org-babel-expand-body:" lang)))))))
  192. org-babel-load-languages))
  193. (declare-function org-babel-tangle-file "ob-tangle" (file &optional target-file lang))
  194. ;;;###autoload
  195. (defun org-babel-load-file (file &optional compile)
  196. "Load Emacs Lisp source code blocks in the Org-mode FILE.
  197. This function exports the source code using `org-babel-tangle'
  198. and then loads the resulting file using `load-file'. With prefix
  199. arg (noninteractively: 2nd arg) COMPILE the tangled Emacs Lisp
  200. file to byte-code before it is loaded."
  201. (interactive "fFile to load: \nP")
  202. (let* ((age (lambda (file)
  203. (float-time
  204. (time-subtract (current-time)
  205. (nth 5 (or (file-attributes (file-truename file))
  206. (file-attributes file)))))))
  207. (base-name (file-name-sans-extension file))
  208. (exported-file (concat base-name ".el")))
  209. ;; tangle if the org-mode file is newer than the elisp file
  210. (unless (and (file-exists-p exported-file)
  211. (> (funcall age file) (funcall age exported-file)))
  212. ;; Tangle-file traversal returns reversed list of tangled files
  213. ;; and we want to evaluate the first target.
  214. (setq exported-file
  215. (car (last (org-babel-tangle-file file exported-file "emacs-lisp")))))
  216. (message "%s %s"
  217. (if compile
  218. (progn (byte-compile-file exported-file 'load)
  219. "Compiled and loaded")
  220. (progn (load-file exported-file) "Loaded"))
  221. exported-file)))
  222. (defcustom org-babel-load-languages '((emacs-lisp . t))
  223. "Languages which can be evaluated in Org-mode buffers.
  224. This list can be used to load support for any of the languages
  225. below, note that each language will depend on a different set of
  226. system executables and/or Emacs modes. When a language is
  227. \"loaded\", then code blocks in that language can be evaluated
  228. with `org-babel-execute-src-block' bound by default to C-c
  229. C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
  230. be set to remove code block evaluation from the C-c C-c
  231. keybinding. By default only Emacs Lisp (which has no
  232. requirements) is loaded."
  233. :group 'org-babel
  234. :set 'org-babel-do-load-languages
  235. :version "24.1"
  236. :type '(alist :tag "Babel Languages"
  237. :key-type
  238. (choice
  239. (const :tag "Awk" awk)
  240. (const :tag "C" C)
  241. (const :tag "R" R)
  242. (const :tag "Asymptote" asymptote)
  243. (const :tag "Calc" calc)
  244. (const :tag "Clojure" clojure)
  245. (const :tag "CSS" css)
  246. (const :tag "Ditaa" ditaa)
  247. (const :tag "Dot" dot)
  248. (const :tag "Emacs Lisp" emacs-lisp)
  249. (const :tag "Forth" forth)
  250. (const :tag "Fortran" fortran)
  251. (const :tag "Gnuplot" gnuplot)
  252. (const :tag "Haskell" haskell)
  253. (const :tag "IO" io)
  254. (const :tag "J" J)
  255. (const :tag "Java" java)
  256. (const :tag "Javascript" js)
  257. (const :tag "LaTeX" latex)
  258. (const :tag "Ledger" ledger)
  259. (const :tag "Lilypond" lilypond)
  260. (const :tag "Lisp" lisp)
  261. (const :tag "Makefile" makefile)
  262. (const :tag "Maxima" maxima)
  263. (const :tag "Matlab" matlab)
  264. (const :tag "Mscgen" mscgen)
  265. (const :tag "Ocaml" ocaml)
  266. (const :tag "Octave" octave)
  267. (const :tag "Org" org)
  268. (const :tag "Perl" perl)
  269. (const :tag "Pico Lisp" picolisp)
  270. (const :tag "PlantUML" plantuml)
  271. (const :tag "Python" python)
  272. (const :tag "Ruby" ruby)
  273. (const :tag "Sass" sass)
  274. (const :tag "Scala" scala)
  275. (const :tag "Scheme" scheme)
  276. (const :tag "Screen" screen)
  277. (const :tag "Shell Script" shell)
  278. (const :tag "Shen" shen)
  279. (const :tag "Sql" sql)
  280. (const :tag "Sqlite" sqlite)
  281. (const :tag "ebnf2ps" ebnf2ps))
  282. :value-type (boolean :tag "Activate" :value t)))
  283. ;;;; Customization variables
  284. (defcustom org-clone-delete-id nil
  285. "Remove ID property of clones of a subtree.
  286. When non-nil, clones of a subtree don't inherit the ID property.
  287. Otherwise they inherit the ID property with a new unique
  288. identifier."
  289. :type 'boolean
  290. :version "24.1"
  291. :group 'org-id)
  292. ;;; Version
  293. (org-check-version)
  294. ;;;###autoload
  295. (defun org-version (&optional here full message)
  296. "Show the org-mode version.
  297. Interactively, or when MESSAGE is non-nil, show it in echo area.
  298. With prefix argument, or when HERE is non-nil, insert it at point.
  299. In non-interactive uses, a reduced version string is output unless
  300. FULL is given."
  301. (interactive (list current-prefix-arg t (not current-prefix-arg)))
  302. (let* ((org-dir (ignore-errors (org-find-library-dir "org")))
  303. (save-load-suffixes (when (boundp 'load-suffixes) load-suffixes))
  304. (load-suffixes (list ".el"))
  305. (org-install-dir (ignore-errors (org-find-library-dir "org-loaddefs")))
  306. (org-trash (or
  307. (and (fboundp 'org-release) (fboundp 'org-git-version))
  308. (org-load-noerror-mustsuffix (concat org-dir "org-version"))))
  309. (load-suffixes save-load-suffixes)
  310. (org-version (org-release))
  311. (git-version (org-git-version))
  312. (version (format "Org-mode version %s (%s @ %s)"
  313. org-version
  314. git-version
  315. (if org-install-dir
  316. (if (string= org-dir org-install-dir)
  317. org-install-dir
  318. (concat "mixed installation! " org-install-dir " and " org-dir))
  319. "org-loaddefs.el can not be found!")))
  320. (version1 (if full version org-version)))
  321. (when here (insert version1))
  322. (when message (message "%s" version1))
  323. version1))
  324. (defconst org-version (org-version))
  325. ;;; Syntax Constants
  326. ;;;; Block
  327. (defconst org-block-regexp
  328. "^[ \t]*#\\+begin_?\\([^ \n]+\\)\\(\\([^\n]+\\)\\)?\n\\([^\000]+?\\)#\\+end_?\\1[ \t]*$"
  329. "Regular expression for hiding blocks.")
  330. (defconst org-dblock-start-re
  331. "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+\\(\\S-+\\)\\([ \t]+\\(.*\\)\\)?"
  332. "Matches the start line of a dynamic block, with parameters.")
  333. (defconst org-dblock-end-re "^[ \t]*#\\+\\(?:END\\|end\\)\\([: \t\r\n]\\|$\\)"
  334. "Matches the end of a dynamic block.")
  335. ;;;; Clock and Planning
  336. (defconst org-clock-string "CLOCK:"
  337. "String used as prefix for timestamps clocking work hours on an item.")
  338. (defvar org-closed-string "CLOSED:"
  339. "String used as the prefix for timestamps logging closing a TODO entry.")
  340. (defvar org-deadline-string "DEADLINE:"
  341. "String to mark deadline entries.
  342. A deadline is this string, followed by a time stamp. Should be a word,
  343. terminated by a colon. You can insert a schedule keyword and
  344. a timestamp with \\[org-deadline].")
  345. (defvar org-scheduled-string "SCHEDULED:"
  346. "String to mark scheduled TODO entries.
  347. A schedule is this string, followed by a time stamp. Should be a word,
  348. terminated by a colon. You can insert a schedule keyword and
  349. a timestamp with \\[org-schedule].")
  350. (defconst org-ds-keyword-length
  351. (+ 2
  352. (apply #'max
  353. (mapcar #'length
  354. (list org-deadline-string org-scheduled-string
  355. org-clock-string org-closed-string))))
  356. "Maximum length of the DEADLINE and SCHEDULED keywords.")
  357. (defconst org-planning-line-re
  358. (concat "^[ \t]*"
  359. (regexp-opt
  360. (list org-closed-string org-deadline-string org-scheduled-string)
  361. t))
  362. "Matches a line with planning info.
  363. Matched keyword is in group 1.")
  364. (defconst org-clock-line-re
  365. (concat "^[ \t]*" org-clock-string)
  366. "Matches a line with clock info.")
  367. (defconst org-deadline-regexp (concat "\\<" org-deadline-string)
  368. "Matches the DEADLINE keyword.")
  369. (defconst org-deadline-time-regexp
  370. (concat "\\<" org-deadline-string " *<\\([^>]+\\)>")
  371. "Matches the DEADLINE keyword together with a time stamp.")
  372. (defconst org-deadline-time-hour-regexp
  373. (concat "\\<" org-deadline-string
  374. " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
  375. "Matches the DEADLINE keyword together with a time-and-hour stamp.")
  376. (defconst org-deadline-line-regexp
  377. (concat "\\<\\(" org-deadline-string "\\).*")
  378. "Matches the DEADLINE keyword and the rest of the line.")
  379. (defconst org-scheduled-regexp (concat "\\<" org-scheduled-string)
  380. "Matches the SCHEDULED keyword.")
  381. (defconst org-scheduled-time-regexp
  382. (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>")
  383. "Matches the SCHEDULED keyword together with a time stamp.")
  384. (defconst org-scheduled-time-hour-regexp
  385. (concat "\\<" org-scheduled-string
  386. " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
  387. "Matches the SCHEDULED keyword together with a time-and-hour stamp.")
  388. (defconst org-closed-time-regexp
  389. (concat "\\<" org-closed-string " *\\[\\([^]]+\\)\\]")
  390. "Matches the CLOSED keyword together with a time stamp.")
  391. (defconst org-keyword-time-regexp
  392. (concat "\\<"
  393. (regexp-opt
  394. (list org-scheduled-string org-deadline-string org-closed-string
  395. org-clock-string)
  396. t)
  397. " *[[<]\\([^]>]+\\)[]>]")
  398. "Matches any of the 4 keywords, together with the time stamp.")
  399. (defconst org-keyword-time-not-clock-regexp
  400. (concat
  401. "\\<"
  402. (regexp-opt
  403. (list org-scheduled-string org-deadline-string org-closed-string) t)
  404. " *[[<]\\([^]>]+\\)[]>]")
  405. "Matches any of the 3 keywords, together with the time stamp.")
  406. (defconst org-maybe-keyword-time-regexp
  407. (concat "\\(\\<"
  408. (regexp-opt
  409. (list org-scheduled-string org-deadline-string org-closed-string
  410. org-clock-string)
  411. t)
  412. "\\)?"
  413. " *\\([[<][0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?[]>]"
  414. "\\|"
  415. "<%%([^\r\n>]*>\\)")
  416. "Matches a timestamp, possibly preceded by a keyword.")
  417. (defconst org-all-time-keywords
  418. (mapcar (lambda (w) (substring w 0 -1))
  419. (list org-scheduled-string org-deadline-string
  420. org-clock-string org-closed-string))
  421. "List of time keywords.")
  422. ;;;; Drawer
  423. (defconst org-drawer-regexp "^[ \t]*:\\(\\(?:\\w\\|[-_]\\)+\\):[ \t]*$"
  424. "Matches first or last line of a hidden block.
  425. Group 1 contains drawer's name or \"END\".")
  426. (defconst org-property-start-re "^[ \t]*:PROPERTIES:[ \t]*$"
  427. "Regular expression matching the first line of a property drawer.")
  428. (defconst org-property-end-re "^[ \t]*:END:[ \t]*$"
  429. "Regular expression matching the last line of a property drawer.")
  430. (defconst org-clock-drawer-start-re "^[ \t]*:CLOCK:[ \t]*$"
  431. "Regular expression matching the first line of a clock drawer.")
  432. (defconst org-clock-drawer-end-re "^[ \t]*:END:[ \t]*$"
  433. "Regular expression matching the last line of a clock drawer.")
  434. (defconst org-property-drawer-re
  435. (concat "^[ \t]*:PROPERTIES:[ \t]*\n"
  436. "\\(?:[ \t]*:\\S-+:\\(?: .*\\)?[ \t]*\n\\)*"
  437. "[ \t]*:END:[ \t]*$")
  438. "Matches an entire property drawer.")
  439. (defconst org-clock-drawer-re
  440. (concat "\\(" org-clock-drawer-start-re "\\)[^\000]*?\\("
  441. org-clock-drawer-end-re "\\)\n?")
  442. "Matches an entire clock drawer.")
  443. ;;;; Headline
  444. (defconst org-heading-keyword-regexp-format
  445. "^\\(\\*+\\)\\(?: +%s\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
  446. "Printf format for a regexp matching a headline with some keyword.
  447. This regexp will match the headline of any node which has the
  448. exact keyword that is put into the format. The keyword isn't in
  449. any group by default, but the stars and the body are.")
  450. (defconst org-heading-keyword-maybe-regexp-format
  451. "^\\(\\*+\\)\\(?: +%s\\)?\\(?: +\\(.*?\\)\\)?[ \t]*$"
  452. "Printf format for a regexp matching a headline, possibly with some keyword.
  453. This regexp can match any headline with the specified keyword, or
  454. without a keyword. The keyword isn't in any group by default,
  455. but the stars and the body are.")
  456. (defconst org-archive-tag "ARCHIVE"
  457. "The tag that marks a subtree as archived.
  458. An archived subtree does not open during visibility cycling, and does
  459. not contribute to the agenda listings.")
  460. (defconst org-comment-string "COMMENT"
  461. "Entries starting with this keyword will never be exported.
  462. An entry can be toggled between COMMENT and normal with
  463. \\[org-toggle-comment].")
  464. ;;;; LaTeX Environments and Fragments
  465. (defconst org-latex-regexps
  466. '(("begin" "^[ \t]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^\000]+?\\\\end{\\2}\\)" 1 t)
  467. ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
  468. ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
  469. ("$1" "\\([^$]\\|^\\)\\(\\$[^ \r\n,;.$]\\$\\)\\(\\s.\\|\\s-\\|\\s(\\|\\s)\\|\\s\"\\|\000\\|$\\)" 2 nil)
  470. ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\(\\s.\\|\\s-\\|\\s(\\|\\s)\\|\\s\"\\|\000\\|$\\)" 2 nil)
  471. ("\\(" "\\\\([^\000]*?\\\\)" 0 nil)
  472. ("\\[" "\\\\\\[[^\000]*?\\\\\\]" 0 nil)
  473. ("$$" "\\$\\$[^\000]*?\\$\\$" 0 nil))
  474. "Regular expressions for matching embedded LaTeX.")
  475. ;;;; Node Property
  476. (defconst org-effort-property "Effort"
  477. "The property that is being used to keep track of effort estimates.
  478. Effort estimates given in this property need to have the format H:MM.")
  479. ;;;; Table
  480. (defconst org-table-any-line-regexp "^[ \t]*\\(|\\|\\+-[-+]\\)"
  481. "Detect an org-type or table-type table.")
  482. (defconst org-table-line-regexp "^[ \t]*|"
  483. "Detect an org-type table line.")
  484. (defconst org-table-dataline-regexp "^[ \t]*|[^-]"
  485. "Detect an org-type table line.")
  486. (defconst org-table-hline-regexp "^[ \t]*|-"
  487. "Detect an org-type table hline.")
  488. (defconst org-table1-hline-regexp "^[ \t]*\\+-[-+]"
  489. "Detect a table-type table hline.")
  490. (defconst org-table-any-border-regexp "^[ \t]*[^|+ \t]"
  491. "Detect the first line outside a table when searching from within it.
  492. This works for both table types.")
  493. (defconst org-TBLFM-regexp "^[ \t]*#\\+TBLFM: "
  494. "Detect a #+TBLFM line.")
  495. ;;;; Timestamp
  496. (defconst org-ts-regexp "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)>"
  497. "Regular expression for fast time stamp matching.")
  498. (defconst org-ts-regexp-inactive
  499. "\\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)\\]"
  500. "Regular expression for fast inactive time stamp matching.")
  501. (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
  502. "Regular expression for fast time stamp matching.")
  503. (defconst org-ts-regexp0
  504. "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\( +[^]+0-9>\r\n -]+\\)?\\( +\\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
  505. "Regular expression matching time strings for analysis.
  506. This one does not require the space after the date, so it can be used
  507. on a string that terminates immediately after the date.")
  508. (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
  509. "Regular expression matching time strings for analysis.")
  510. (defconst org-ts-regexp2 (concat "<" org-ts-regexp1 "[^>\n]\\{0,16\\}>")
  511. "Regular expression matching time stamps, with groups.")
  512. (defconst org-ts-regexp3 (concat "[[<]" org-ts-regexp1 "[^]>\n]\\{0,16\\}[]>]")
  513. "Regular expression matching time stamps (also [..]), with groups.")
  514. (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
  515. "Regular expression matching a time stamp range.")
  516. (defconst org-tr-regexp-both
  517. (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
  518. "Regular expression matching a time stamp range.")
  519. (defconst org-tsr-regexp (concat org-ts-regexp "\\(--?-?"
  520. org-ts-regexp "\\)?")
  521. "Regular expression matching a time stamp or time stamp range.")
  522. (defconst org-tsr-regexp-both
  523. (concat org-ts-regexp-both "\\(--?-?"
  524. org-ts-regexp-both "\\)?")
  525. "Regular expression matching a time stamp or time stamp range.
  526. The time stamps may be either active or inactive.")
  527. (defconst org-repeat-re
  528. "<[0-9]\\{4\\}-[0-9][0-9]-[0-9][0-9] [^>\n]*?\\([.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)"
  529. "Regular expression for specifying repeated events.
  530. After a match, group 1 contains the repeat expression.")
  531. (defconst org-time-stamp-formats '("<%Y-%m-%d %a>" . "<%Y-%m-%d %a %H:%M>")
  532. "Formats for `format-time-string' which are used for time stamps.")
  533. ;;; The custom variables
  534. (defgroup org nil
  535. "Outline-based notes management and organizer."
  536. :tag "Org"
  537. :group 'outlines
  538. :group 'calendar)
  539. (defcustom org-mode-hook nil
  540. "Mode hook for Org-mode, run after the mode was turned on."
  541. :group 'org
  542. :type 'hook)
  543. (defcustom org-load-hook nil
  544. "Hook that is run after org.el has been loaded."
  545. :group 'org
  546. :type 'hook)
  547. (defcustom org-log-buffer-setup-hook nil
  548. "Hook that is run after an Org log buffer is created."
  549. :group 'org
  550. :version "24.1"
  551. :type 'hook)
  552. (defvar org-modules) ; defined below
  553. (defvar org-modules-loaded nil
  554. "Have the modules been loaded already?")
  555. (defun org-load-modules-maybe (&optional force)
  556. "Load all extensions listed in `org-modules'."
  557. (when (or force (not org-modules-loaded))
  558. (mapc (lambda (ext)
  559. (condition-case nil (require ext)
  560. (error (message "Problems while trying to load feature `%s'" ext))))
  561. org-modules)
  562. (setq org-modules-loaded t)))
  563. (defun org-set-modules (var value)
  564. "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
  565. (set var value)
  566. (when (featurep 'org)
  567. (org-load-modules-maybe 'force)
  568. (org-element-cache-reset 'all)))
  569. (defcustom org-modules '(org-w3m org-bbdb org-bibtex org-docview org-gnus org-info org-irc org-mhe org-rmail)
  570. "Modules that should always be loaded together with org.el.
  571. If a description starts with <C>, the file is not part of Emacs
  572. and loading it will require that you have downloaded and properly
  573. installed the Org mode distribution.
  574. You can also use this system to load external packages (i.e. neither Org
  575. core modules, nor modules from the CONTRIB directory). Just add symbols
  576. to the end of the list. If the package is called org-xyz.el, then you need
  577. to add the symbol `xyz', and the package must have a call to:
  578. \(provide 'org-xyz)
  579. For export specific modules, see also `org-export-backends'."
  580. :group 'org
  581. :set 'org-set-modules
  582. :version "24.4"
  583. :package-version '(Org . "8.0")
  584. :type
  585. '(set :greedy t
  586. (const :tag " bbdb: Links to BBDB entries" org-bbdb)
  587. (const :tag " bibtex: Links to BibTeX entries" org-bibtex)
  588. (const :tag " crypt: Encryption of subtrees" org-crypt)
  589. (const :tag " ctags: Access to Emacs tags with links" org-ctags)
  590. (const :tag " docview: Links to doc-view buffers" org-docview)
  591. (const :tag " gnus: Links to GNUS folders/messages" org-gnus)
  592. (const :tag " habit: Track your consistency with habits" org-habit)
  593. (const :tag " id: Global IDs for identifying entries" org-id)
  594. (const :tag " info: Links to Info nodes" org-info)
  595. (const :tag " inlinetask: Tasks independent of outline hierarchy" org-inlinetask)
  596. (const :tag " irc: Links to IRC/ERC chat sessions" org-irc)
  597. (const :tag " mhe: Links to MHE folders/messages" org-mhe)
  598. (const :tag " mouse: Additional mouse support" org-mouse)
  599. (const :tag " protocol: Intercept calls from emacsclient" org-protocol)
  600. (const :tag " rmail: Links to RMAIL folders/messages" org-rmail)
  601. (const :tag " w3m: Special cut/paste from w3m to Org-mode." org-w3m)
  602. (const :tag "C annotate-file: Annotate a file with org syntax" org-annotate-file)
  603. (const :tag "C bookmark: Org-mode links to bookmarks" org-bookmark)
  604. (const :tag "C bullets: Add overlays to headlines stars" org-bullets)
  605. (const :tag "C checklist: Extra functions for checklists in repeated tasks" org-checklist)
  606. (const :tag "C choose: Use TODO keywords to mark decisions states" org-choose)
  607. (const :tag "C collector: Collect properties into tables" org-collector)
  608. (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
  609. (const :tag "C drill: Flashcards and spaced repetition for Org-mode" org-drill)
  610. (const :tag "C elisp-symbol: Org-mode links to emacs-lisp symbols" org-elisp-symbol)
  611. (const :tag "C eshell Support for links to working directories in eshell" org-eshell)
  612. (const :tag "C eval-light: Evaluate inbuffer-code on demand" org-eval-light)
  613. (const :tag "C eval: Include command output as text" org-eval)
  614. (const :tag "C eww: Store link to url of eww" org-eww)
  615. (const :tag "C expiry: Expiry mechanism for Org-mode 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 jira: Add a jira:ticket protocol to Org-mode" org-jira)
  621. (const :tag "C learn: SuperMemo's incremental learning algorithm" org-learn)
  622. (const :tag "C mac-iCal Imports events from iCal.app to the Emacs diary" org-mac-iCal)
  623. (const :tag "C mac-link: Grab links and url from various mac Applications" org-mac-link)
  624. (const :tag "C mairix: Hook mairix search into Org-mode for different MUAs" org-mairix)
  625. (const :tag "C man: Support for links to manpages in Org-mode" org-man)
  626. (const :tag "C mew: Links to Mew folders/messages" org-mew)
  627. (const :tag "C mtags: Support for muse-like tags" org-mtags)
  628. (const :tag "C notmuch: Provide org links to notmuch searches or messages" org-notmuch)
  629. (const :tag "C panel: Simple routines for us with bad memory" org-panel)
  630. (const :tag "C registry: A registry for Org-mode links" org-registry)
  631. (const :tag "C screen: Visit screen sessions through Org-mode links" org-screen)
  632. (const :tag "C secretary: Team management with org-mode" org-secretary)
  633. (const :tag "C sqlinsert: Convert Org-mode tables to SQL insertions" orgtbl-sqlinsert)
  634. (const :tag "C toc: Table of contents for Org-mode buffer" org-toc)
  635. (const :tag "C track: Keep up with Org-mode development" org-track)
  636. (const :tag "C velocity Something like Notational Velocity for Org" org-velocity)
  637. (const :tag "C vm: Links to VM folders/messages" org-vm)
  638. (const :tag "C wikinodes: CamelCase wiki-like links" org-wikinodes)
  639. (const :tag "C wl: Links to Wanderlust folders/messages" org-wl)
  640. (repeat :tag "External packages" :inline t (symbol :tag "Package"))))
  641. (defvar org-export-registered-backends) ; From ox.el.
  642. (declare-function org-export-derived-backend-p "ox" (backend &rest backends))
  643. (declare-function org-export-backend-name "ox" (backend))
  644. (defcustom org-export-backends '(ascii html icalendar latex)
  645. "List of export back-ends that should be always available.
  646. If a description starts with <C>, the file is not part of Emacs
  647. and loading it will require that you have downloaded and properly
  648. installed the Org mode distribution.
  649. Unlike to `org-modules', libraries in this list will not be
  650. loaded along with Org, but only once the export framework is
  651. needed.
  652. This variable needs to be set before org.el is loaded. If you
  653. need to make a change while Emacs is running, use the customize
  654. interface or run the following code, where VAL stands for the new
  655. value of the variable, after updating it:
  656. \(progn
  657. \(setq org-export-registered-backends
  658. \(org-remove-if-not
  659. \(lambda (backend)
  660. \(let ((name (org-export-backend-name backend)))
  661. \(or (memq name val)
  662. \(catch 'parentp
  663. \(dolist (b val)
  664. \(and (org-export-derived-backend-p b name)
  665. \(throw 'parentp t)))))))
  666. org-export-registered-backends))
  667. \(let ((new-list (mapcar #'org-export-backend-name
  668. org-export-registered-backends)))
  669. \(dolist (backend val)
  670. \(cond
  671. \((not (load (format \"ox-%s\" backend) t t))
  672. \(message \"Problems while trying to load export back-end `%s'\"
  673. backend))
  674. \((not (memq backend new-list)) (push backend new-list))))
  675. \(set-default 'org-export-backends new-list)))
  676. Adding a back-end to this list will also pull the back-end it
  677. depends on, if any."
  678. :group 'org
  679. :group 'org-export
  680. :version "24.4"
  681. :package-version '(Org . "8.0")
  682. :initialize 'custom-initialize-set
  683. :set (lambda (var val)
  684. (if (not (featurep 'ox)) (set-default var val)
  685. ;; Any back-end not required anymore (not present in VAL and not
  686. ;; a parent of any back-end in the new value) is removed from the
  687. ;; list of registered back-ends.
  688. (setq org-export-registered-backends
  689. (org-remove-if-not
  690. (lambda (backend)
  691. (let ((name (org-export-backend-name backend)))
  692. (or (memq name val)
  693. (catch 'parentp
  694. (dolist (b val)
  695. (and (org-export-derived-backend-p b name)
  696. (throw 'parentp t)))))))
  697. org-export-registered-backends))
  698. ;; Now build NEW-LIST of both new back-ends and required
  699. ;; parents.
  700. (let ((new-list (mapcar #'org-export-backend-name
  701. org-export-registered-backends)))
  702. (dolist (backend val)
  703. (cond
  704. ((not (load (format "ox-%s" backend) t t))
  705. (message "Problems while trying to load export back-end `%s'"
  706. backend))
  707. ((not (memq backend new-list)) (push backend new-list))))
  708. ;; Set VAR to that list with fixed dependencies.
  709. (set-default var new-list))))
  710. :type '(set :greedy t
  711. (const :tag " ascii Export buffer to ASCII format" ascii)
  712. (const :tag " beamer Export buffer to Beamer presentation" beamer)
  713. (const :tag " html Export buffer to HTML format" html)
  714. (const :tag " icalendar Export buffer to iCalendar format" icalendar)
  715. (const :tag " latex Export buffer to LaTeX format" latex)
  716. (const :tag " man Export buffer to MAN format" man)
  717. (const :tag " md Export buffer to Markdown format" md)
  718. (const :tag " odt Export buffer to ODT format" odt)
  719. (const :tag " org Export buffer to Org format" org)
  720. (const :tag " texinfo Export buffer to Texinfo format" texinfo)
  721. (const :tag "C confluence Export buffer to Confluence Wiki format" confluence)
  722. (const :tag "C deck Export buffer to deck.js presentations" deck)
  723. (const :tag "C freemind Export buffer to Freemind mindmap format" freemind)
  724. (const :tag "C groff Export buffer to Groff format" groff)
  725. (const :tag "C koma-letter Export buffer to KOMA Scrlttrl2 format" koma-letter)
  726. (const :tag "C RSS 2.0 Export buffer to RSS 2.0 format" rss)
  727. (const :tag "C s5 Export buffer to s5 presentations" s5)
  728. (const :tag "C taskjuggler Export buffer to TaskJuggler format" taskjuggler)))
  729. (eval-after-load 'ox
  730. '(mapc
  731. (lambda (backend)
  732. (condition-case nil (require (intern (format "ox-%s" backend)))
  733. (error (message "Problems while trying to load export back-end `%s'"
  734. backend))))
  735. org-export-backends))
  736. (defcustom org-support-shift-select nil
  737. "Non-nil means make shift-cursor commands select text when possible.
  738. In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
  739. start selecting a region, or enlarge regions started in this way.
  740. In Org-mode, in special contexts, these same keys are used for
  741. other purposes, important enough to compete with shift selection.
  742. Org tries to balance these needs by supporting `shift-select-mode'
  743. outside these special contexts, under control of this variable.
  744. The default of this variable is nil, to avoid confusing behavior. Shifted
  745. cursor keys will then execute Org commands in the following contexts:
  746. - on a headline, changing TODO state (left/right) and priority (up/down)
  747. - on a time stamp, changing the time
  748. - in a plain list item, changing the bullet type
  749. - in a property definition line, switching between allowed values
  750. - in the BEGIN line of a clock table (changing the time block).
  751. Outside these contexts, the commands will throw an error.
  752. When this variable is t and the cursor is not in a special
  753. context, Org-mode will support shift-selection for making and
  754. enlarging regions. To make this more effective, the bullet
  755. cycling will no longer happen anywhere in an item line, but only
  756. if the cursor is exactly on the bullet.
  757. If you set this variable to the symbol `always', then the keys
  758. will not be special in headlines, property lines, and item lines,
  759. to make shift selection work there as well. If this is what you
  760. want, you can use the following alternative commands: `C-c C-t'
  761. and `C-c ,' to change TODO state and priority, `C-u C-u C-c C-t'
  762. can be used to switch TODO sets, `C-c -' to cycle item bullet
  763. types, and properties can be edited by hand or in column view.
  764. However, when the cursor is on a timestamp, shift-cursor commands
  765. will still edit the time stamp - this is just too good to give up.
  766. XEmacs user should have this variable set to nil, because
  767. `shift-select-mode' is in Emacs 23 or later only."
  768. :group 'org
  769. :type '(choice
  770. (const :tag "Never" nil)
  771. (const :tag "When outside special context" t)
  772. (const :tag "Everywhere except timestamps" always)))
  773. (defcustom org-loop-over-headlines-in-active-region nil
  774. "Shall some commands act upon headlines in the active region?
  775. When set to `t', some commands will be performed in all headlines
  776. within the active region.
  777. When set to `start-level', some commands will be performed in all
  778. headlines within the active region, provided that these headlines
  779. are of the same level than the first one.
  780. When set to a string, those commands will be performed on the
  781. matching headlines within the active region. Such string must be
  782. a tags/property/todo match as it is used in the agenda tags view.
  783. The list of commands is: `org-schedule', `org-deadline',
  784. `org-todo', `org-archive-subtree', `org-archive-set-tag' and
  785. `org-archive-to-archive-sibling'. The archiving commands skip
  786. already archived entries."
  787. :type '(choice (const :tag "Don't loop" nil)
  788. (const :tag "All headlines in active region" t)
  789. (const :tag "In active region, headlines at the same level than the first one" start-level)
  790. (string :tag "Tags/Property/Todo matcher"))
  791. :version "24.1"
  792. :group 'org-todo
  793. :group 'org-archive)
  794. (defgroup org-startup nil
  795. "Options concerning startup of Org-mode."
  796. :tag "Org Startup"
  797. :group 'org)
  798. (defcustom org-startup-folded t
  799. "Non-nil means entering Org-mode will switch to OVERVIEW.
  800. This can also be configured on a per-file basis by adding one of
  801. the following lines anywhere in the buffer:
  802. #+STARTUP: fold (or `overview', this is equivalent)
  803. #+STARTUP: nofold (or `showall', this is equivalent)
  804. #+STARTUP: content
  805. #+STARTUP: showeverything
  806. By default, this option is ignored when Org opens agenda files
  807. for the first time. If you want the agenda to honor the startup
  808. option, set `org-agenda-inhibit-startup' to nil."
  809. :group 'org-startup
  810. :type '(choice
  811. (const :tag "nofold: show all" nil)
  812. (const :tag "fold: overview" t)
  813. (const :tag "content: all headlines" content)
  814. (const :tag "show everything, even drawers" showeverything)))
  815. (defcustom org-startup-truncated t
  816. "Non-nil means entering Org-mode will set `truncate-lines'.
  817. This is useful since some lines containing links can be very long and
  818. uninteresting. Also tables look terrible when wrapped."
  819. :group 'org-startup
  820. :type 'boolean)
  821. (defcustom org-startup-indented nil
  822. "Non-nil means turn on `org-indent-mode' on startup.
  823. This can also be configured on a per-file basis by adding one of
  824. the following lines anywhere in the buffer:
  825. #+STARTUP: indent
  826. #+STARTUP: noindent"
  827. :group 'org-structure
  828. :type '(choice
  829. (const :tag "Not" nil)
  830. (const :tag "Globally (slow on startup in large files)" t)))
  831. (defcustom org-use-sub-superscripts t
  832. "Non-nil means interpret \"_\" and \"^\" for display.
  833. If you want to control how Org exports those characters, see
  834. `org-export-with-sub-superscripts'. `org-use-sub-superscripts'
  835. used to be an alias for `org-export-with-sub-superscripts' in
  836. Org <8.0, it is not anymore.
  837. When this option is turned on, you can use TeX-like syntax for
  838. sub- and superscripts within the buffer. Several characters after
  839. \"_\" or \"^\" will be considered as a single item - so grouping
  840. with {} is normally not needed. For example, the following things
  841. will be parsed as single sub- or superscripts:
  842. 10^24 or 10^tau several digits will be considered 1 item.
  843. 10^-12 or 10^-tau a leading sign with digits or a word
  844. x^2-y^3 will be read as x^2 - y^3, because items are
  845. terminated by almost any nonword/nondigit char.
  846. x_{i^2} or x^(2-i) braces or parenthesis do grouping.
  847. Still, ambiguity is possible. So when in doubt, use {} to enclose
  848. the sub/superscript. If you set this variable to the symbol `{}',
  849. the braces are *required* in order to trigger interpretations as
  850. sub/superscript. This can be helpful in documents that need \"_\"
  851. frequently in plain text."
  852. :group 'org-startup
  853. :version "24.4"
  854. :package-version '(Org . "8.0")
  855. :type '(choice
  856. (const :tag "Always interpret" t)
  857. (const :tag "Only with braces" {})
  858. (const :tag "Never interpret" nil)))
  859. (defcustom org-startup-with-beamer-mode nil
  860. "Non-nil means turn on `org-beamer-mode' on startup.
  861. This can also be configured on a per-file basis by adding one of
  862. the following lines anywhere in the buffer:
  863. #+STARTUP: beamer"
  864. :group 'org-startup
  865. :version "24.1"
  866. :type 'boolean)
  867. (defcustom org-startup-align-all-tables nil
  868. "Non-nil means align all tables when visiting a file.
  869. This is useful when the column width in tables is forced with <N> cookies
  870. in table fields. Such tables will look correct only after the first re-align.
  871. This can also be configured on a per-file basis by adding one of
  872. the following lines anywhere in the buffer:
  873. #+STARTUP: align
  874. #+STARTUP: noalign"
  875. :group 'org-startup
  876. :type 'boolean)
  877. (defcustom org-startup-with-inline-images nil
  878. "Non-nil means show inline images when loading a new Org file.
  879. This can also be configured on a per-file basis by adding one of
  880. the following lines anywhere in the buffer:
  881. #+STARTUP: inlineimages
  882. #+STARTUP: noinlineimages"
  883. :group 'org-startup
  884. :version "24.1"
  885. :type 'boolean)
  886. (defcustom org-startup-with-latex-preview nil
  887. "Non-nil means preview LaTeX fragments when loading a new Org file.
  888. This can also be configured on a per-file basis by adding one of
  889. the following lines anywhere in the buffer:
  890. #+STARTUP: latexpreview
  891. #+STARTUP: nolatexpreview"
  892. :group 'org-startup
  893. :version "24.4"
  894. :package-version '(Org . "8.0")
  895. :type 'boolean)
  896. (defcustom org-insert-mode-line-in-empty-file nil
  897. "Non-nil means insert the first line setting Org-mode in empty files.
  898. When the function `org-mode' is called interactively in an empty file, this
  899. normally means that the file name does not automatically trigger Org-mode.
  900. To ensure that the file will always be in Org-mode in the future, a
  901. line enforcing Org-mode will be inserted into the buffer, if this option
  902. has been set."
  903. :group 'org-startup
  904. :type 'boolean)
  905. (defcustom org-replace-disputed-keys nil
  906. "Non-nil means use alternative key bindings for some keys.
  907. Org-mode uses S-<cursor> keys for changing timestamps and priorities.
  908. These keys are also used by other packages like shift-selection-mode'
  909. \(built into Emacs 23), `CUA-mode' or `windmove.el'.
  910. If you want to use Org-mode together with one of these other modes,
  911. or more generally if you would like to move some Org-mode commands to
  912. other keys, set this variable and configure the keys with the variable
  913. `org-disputed-keys'.
  914. This option is only relevant at load-time of Org-mode, and must be set
  915. *before* org.el is loaded. Changing it requires a restart of Emacs to
  916. become effective."
  917. :group 'org-startup
  918. :type 'boolean)
  919. (defcustom org-use-extra-keys nil
  920. "Non-nil means use extra key sequence definitions for certain commands.
  921. This happens automatically if you run XEmacs or if `window-system'
  922. is nil. This variable lets you do the same manually. You must
  923. set it before loading org.
  924. Example: on Carbon Emacs 22 running graphically, with an external
  925. keyboard on a Powerbook, the default way of setting M-left might
  926. not work for either Alt or ESC. Setting this variable will make
  927. it work for ESC."
  928. :group 'org-startup
  929. :type 'boolean)
  930. (org-defvaralias 'org-CUA-compatible 'org-replace-disputed-keys)
  931. (defcustom org-disputed-keys
  932. '(([(shift up)] . [(meta p)])
  933. ([(shift down)] . [(meta n)])
  934. ([(shift left)] . [(meta -)])
  935. ([(shift right)] . [(meta +)])
  936. ([(control shift right)] . [(meta shift +)])
  937. ([(control shift left)] . [(meta shift -)]))
  938. "Keys for which Org-mode and other modes compete.
  939. This is an alist, cars are the default keys, second element specifies
  940. the alternative to use when `org-replace-disputed-keys' is t.
  941. Keys can be specified in any syntax supported by `define-key'.
  942. The value of this option takes effect only at Org-mode's startup,
  943. therefore you'll have to restart Emacs to apply it after changing."
  944. :group 'org-startup
  945. :type 'alist)
  946. (defun org-key (key)
  947. "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
  948. Or return the original if not disputed.
  949. Also apply the translations defined in `org-xemacs-key-equivalents'."
  950. (when org-replace-disputed-keys
  951. (let* ((nkey (key-description key))
  952. (x (org-find-if (lambda (x)
  953. (equal (key-description (car x)) nkey))
  954. org-disputed-keys)))
  955. (setq key (if x (cdr x) key))))
  956. (when (featurep 'xemacs)
  957. (setq key (or (cdr (assoc key org-xemacs-key-equivalents)) key)))
  958. key)
  959. (defun org-find-if (predicate seq)
  960. (catch 'exit
  961. (while seq
  962. (if (funcall predicate (car seq))
  963. (throw 'exit (car seq))
  964. (pop seq)))))
  965. (defun org-defkey (keymap key def)
  966. "Define a key, possibly translated, as returned by `org-key'."
  967. (define-key keymap (org-key key) def))
  968. (defcustom org-ellipsis nil
  969. "The ellipsis to use in the Org-mode outline.
  970. When nil, just use the standard three dots.
  971. When a string, use that string instead.
  972. When a face, use the standard 3 dots, but with the specified face.
  973. The change affects only Org-mode (which will then use its own display table).
  974. Changing this requires executing \\[org-mode] in a buffer to become
  975. effective."
  976. :group 'org-startup
  977. :type '(choice (const :tag "Default" nil)
  978. (face :tag "Face" :value org-warning)
  979. (string :tag "String" :value "...#")))
  980. (defvar org-display-table nil
  981. "The display table for org-mode, in case `org-ellipsis' is non-nil.")
  982. (defgroup org-keywords nil
  983. "Keywords in Org-mode."
  984. :tag "Org Keywords"
  985. :group 'org)
  986. (defcustom org-closed-keep-when-no-todo nil
  987. "Remove CLOSED: time-stamp when switching back to a non-todo state?"
  988. :group 'org-todo
  989. :group 'org-keywords
  990. :version "24.4"
  991. :package-version '(Org . "8.0")
  992. :type 'boolean)
  993. (defgroup org-structure nil
  994. "Options concerning the general structure of Org-mode files."
  995. :tag "Org Structure"
  996. :group 'org)
  997. (defgroup org-reveal-location nil
  998. "Options about how to make context of a location visible."
  999. :tag "Org Reveal Location"
  1000. :group 'org-structure)
  1001. (defcustom org-show-context-detail '((isearch . lineage)
  1002. (bookmark-jump . lineage)
  1003. (default . ancestors))
  1004. "Alist between context and visibility span when revealing a location.
  1005. \\<org-mode-map>Some actions may move point into invisible
  1006. locations. As a consequence, Org always expose a neighborhood
  1007. around point. How much is shown depends on the initial action,
  1008. or context. Valid contexts are
  1009. agenda when exposing an entry from the agenda
  1010. org-goto when using the command `org-goto' (\\[org-goto])
  1011. occur-tree when using the command `org-occur' (\\[org-sparse-tree] /)
  1012. tags-tree when constructing a sparse tree based on tags matches
  1013. link-search when exposing search matches associated with a link
  1014. mark-goto when exposing the jump goal of a mark
  1015. bookmark-jump when exposing a bookmark location
  1016. isearch when exiting from an incremental search
  1017. default default for all contexts not set explicitly
  1018. Allowed visibility spans are
  1019. minimal show current headline; if point is not on headline,
  1020. also show entry
  1021. local show current headline, entry and next headline
  1022. ancestors show current headline and its direct ancestors; if
  1023. point is not on headline, also show entry
  1024. lineage show current headline, its direct ancestors and all
  1025. their children; if point is not on headline, also show
  1026. entry and first child
  1027. tree show current headline, its direct ancestors and all
  1028. their children; if point is not on headline, also show
  1029. entry and all children
  1030. canonical show current headline, its direct ancestors along with
  1031. their entries and children; if point is not located on
  1032. the headline, also show current entry and all children
  1033. As special cases, a nil or t value means show all contexts in
  1034. `minimal' or `canonical' view, respectively.
  1035. Some views can make displayed information very compact, but also
  1036. make it harder to edit the location of the match. In such
  1037. a case, use the command `org-reveal' (\\[org-reveal]) to show
  1038. more context."
  1039. :group 'org-reveal-location
  1040. :version "25.1"
  1041. :package-version '(Org . "8.3")
  1042. :type '(choice
  1043. (const :tag "Canonical" t)
  1044. (const :tag "Minimal" nil)
  1045. (repeat :greedy t :tag "Individual contexts"
  1046. (cons
  1047. (choice :tag "Context"
  1048. (const agenda)
  1049. (const org-goto)
  1050. (const occur-tree)
  1051. (const tags-tree)
  1052. (const link-search)
  1053. (const mark-goto)
  1054. (const bookmark-jump)
  1055. (const isearch)
  1056. (const default))
  1057. (choice :tag "Detail level"
  1058. (const minimal)
  1059. (const local)
  1060. (const ancestors)
  1061. (const lineage)
  1062. (const tree)
  1063. (const canonical))))))
  1064. (defcustom org-indirect-buffer-display 'other-window
  1065. "How should indirect tree buffers be displayed?
  1066. This applies to indirect buffers created with the commands
  1067. \\[org-tree-to-indirect-buffer] and \\[org-agenda-tree-to-indirect-buffer].
  1068. Valid values are:
  1069. current-window Display in the current window
  1070. other-window Just display in another window.
  1071. dedicated-frame Create one new frame, and re-use it each time.
  1072. new-frame Make a new frame each time. Note that in this case
  1073. previously-made indirect buffers are kept, and you need to
  1074. kill these buffers yourself."
  1075. :group 'org-structure
  1076. :group 'org-agenda-windows
  1077. :type '(choice
  1078. (const :tag "In current window" current-window)
  1079. (const :tag "In current frame, other window" other-window)
  1080. (const :tag "Each time a new frame" new-frame)
  1081. (const :tag "One dedicated frame" dedicated-frame)))
  1082. (defcustom org-use-speed-commands nil
  1083. "Non-nil means activate single letter commands at beginning of a headline.
  1084. This may also be a function to test for appropriate locations where speed
  1085. commands should be active.
  1086. For example, to activate speed commands when the point is on any
  1087. star at the beginning of the headline, you can do this:
  1088. (setq org-use-speed-commands
  1089. (lambda () (and (looking-at org-outline-regexp) (looking-back \"^\\**\"))))"
  1090. :group 'org-structure
  1091. :type '(choice
  1092. (const :tag "Never" nil)
  1093. (const :tag "At beginning of headline stars" t)
  1094. (function)))
  1095. (defcustom org-speed-commands-user nil
  1096. "Alist of additional speed commands.
  1097. This list will be checked before `org-speed-commands-default'
  1098. when the variable `org-use-speed-commands' is non-nil
  1099. and when the cursor is at the beginning of a headline.
  1100. The car if each entry is a string with a single letter, which must
  1101. be assigned to `self-insert-command' in the global map.
  1102. The cdr is either a command to be called interactively, a function
  1103. to be called, or a form to be evaluated.
  1104. An entry that is just a list with a single string will be interpreted
  1105. as a descriptive headline that will be added when listing the speed
  1106. commands in the Help buffer using the `?' speed command."
  1107. :group 'org-structure
  1108. :type '(repeat :value ("k" . ignore)
  1109. (choice :value ("k" . ignore)
  1110. (list :tag "Descriptive Headline" (string :tag "Headline"))
  1111. (cons :tag "Letter and Command"
  1112. (string :tag "Command letter")
  1113. (choice
  1114. (function)
  1115. (sexp))))))
  1116. (defcustom org-bookmark-names-plist
  1117. '(:last-capture "org-capture-last-stored"
  1118. :last-refile "org-refile-last-stored"
  1119. :last-capture-marker "org-capture-last-stored-marker")
  1120. "Names for bookmarks automatically set by some Org commands.
  1121. This can provide strings as names for a number of bookmarks Org sets
  1122. automatically. The following keys are currently implemented:
  1123. :last-capture
  1124. :last-capture-marker
  1125. :last-refile
  1126. When a key does not show up in the property list, the corresponding bookmark
  1127. is not set."
  1128. :group 'org-structure
  1129. :type 'plist)
  1130. (defgroup org-cycle nil
  1131. "Options concerning visibility cycling in Org-mode."
  1132. :tag "Org Cycle"
  1133. :group 'org-structure)
  1134. (defcustom org-cycle-skip-children-state-if-no-children t
  1135. "Non-nil means skip CHILDREN state in entries that don't have any."
  1136. :group 'org-cycle
  1137. :type 'boolean)
  1138. (defcustom org-cycle-max-level nil
  1139. "Maximum level which should still be subject to visibility cycling.
  1140. Levels higher than this will, for cycling, be treated as text, not a headline.
  1141. When `org-odd-levels-only' is set, a value of N in this variable actually
  1142. means 2N-1 stars as the limiting headline.
  1143. When nil, cycle all levels.
  1144. Note that the limiting level of cycling is also influenced by
  1145. `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
  1146. `org-inlinetask-min-level' is, cycling will be limited to levels one less
  1147. than its value."
  1148. :group 'org-cycle
  1149. :type '(choice
  1150. (const :tag "No limit" nil)
  1151. (integer :tag "Maximum level")))
  1152. (defcustom org-hide-block-startup nil
  1153. "Non-nil means entering Org-mode will fold all blocks.
  1154. This can also be set in on a per-file basis with
  1155. #+STARTUP: hideblocks
  1156. #+STARTUP: showblocks"
  1157. :group 'org-startup
  1158. :group 'org-cycle
  1159. :type 'boolean)
  1160. (defcustom org-cycle-global-at-bob nil
  1161. "Cycle globally if cursor is at beginning of buffer and not at a headline.
  1162. This makes it possible to do global cycling without having to use S-TAB or
  1163. \\[universal-argument] TAB. For this special case to work, the first line
  1164. of the buffer must not be a headline -- it may be empty or some other text.
  1165. When used in this way, `org-cycle-hook' is disabled temporarily to make
  1166. sure the cursor stays at the beginning of the buffer. When this option is
  1167. nil, don't do anything special at the beginning of the buffer."
  1168. :group 'org-cycle
  1169. :type 'boolean)
  1170. (defcustom org-cycle-level-after-item/entry-creation t
  1171. "Non-nil means cycle entry level or item indentation in new empty entries.
  1172. When the cursor is at the end of an empty headline, i.e., with only stars
  1173. and maybe a TODO keyword, TAB will then switch the entry to become a child,
  1174. and then all possible ancestor states, before returning to the original state.
  1175. This makes data entry extremely fast: M-RET to create a new headline,
  1176. on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
  1177. When the cursor is at the end of an empty plain list item, one TAB will
  1178. make it a subitem, two or more tabs will back up to make this an item
  1179. higher up in the item hierarchy."
  1180. :group 'org-cycle
  1181. :type 'boolean)
  1182. (defcustom org-cycle-emulate-tab t
  1183. "Where should `org-cycle' emulate TAB.
  1184. nil Never
  1185. white Only in completely white lines
  1186. whitestart Only at the beginning of lines, before the first non-white char
  1187. t Everywhere except in headlines
  1188. exc-hl-bol Everywhere except at the start of a headline
  1189. If TAB is used in a place where it does not emulate TAB, the current subtree
  1190. visibility is cycled."
  1191. :group 'org-cycle
  1192. :type '(choice (const :tag "Never" nil)
  1193. (const :tag "Only in completely white lines" white)
  1194. (const :tag "Before first char in a line" whitestart)
  1195. (const :tag "Everywhere except in headlines" t)
  1196. (const :tag "Everywhere except at bol in headlines" exc-hl-bol)))
  1197. (defcustom org-cycle-separator-lines 2
  1198. "Number of empty lines needed to keep an empty line between collapsed trees.
  1199. If you leave an empty line between the end of a subtree and the following
  1200. headline, this empty line is hidden when the subtree is folded.
  1201. Org-mode will leave (exactly) one empty line visible if the number of
  1202. empty lines is equal or larger to the number given in this variable.
  1203. So the default 2 means at least 2 empty lines after the end of a subtree
  1204. are needed to produce free space between a collapsed subtree and the
  1205. following headline.
  1206. If the number is negative, and the number of empty lines is at least -N,
  1207. all empty lines are shown.
  1208. Special case: when 0, never leave empty lines in collapsed view."
  1209. :group 'org-cycle
  1210. :type 'integer)
  1211. (put 'org-cycle-separator-lines 'safe-local-variable 'integerp)
  1212. (defcustom org-pre-cycle-hook nil
  1213. "Hook that is run before visibility cycling is happening.
  1214. The function(s) in this hook must accept a single argument which indicates
  1215. the new state that will be set right after running this hook. The
  1216. argument is a symbol. Before a global state change, it can have the values
  1217. `overview', `content', or `all'. Before a local state change, it can have
  1218. the values `folded', `children', or `subtree'."
  1219. :group 'org-cycle
  1220. :type 'hook)
  1221. (defcustom org-cycle-hook '(org-cycle-hide-archived-subtrees
  1222. org-cycle-hide-drawers
  1223. org-cycle-show-empty-lines
  1224. org-optimize-window-after-visibility-change)
  1225. "Hook that is run after `org-cycle' has changed the buffer visibility.
  1226. The function(s) in this hook must accept a single argument which indicates
  1227. the new state that was set by the most recent `org-cycle' command. The
  1228. argument is a symbol. After a global state change, it can have the values
  1229. `overview', `contents', or `all'. After a local state change, it can have
  1230. the values `folded', `children', or `subtree'."
  1231. :group 'org-cycle
  1232. :type 'hook
  1233. :version "25.1"
  1234. :package-version '(Org . "8.3"))
  1235. (defgroup org-edit-structure nil
  1236. "Options concerning structure editing in Org-mode."
  1237. :tag "Org Edit Structure"
  1238. :group 'org-structure)
  1239. (defcustom org-odd-levels-only nil
  1240. "Non-nil means skip even levels and only use odd levels for the outline.
  1241. This has the effect that two stars are being added/taken away in
  1242. promotion/demotion commands. It also influences how levels are
  1243. handled by the exporters.
  1244. Changing it requires restart of `font-lock-mode' to become effective
  1245. for fontification also in regions already fontified.
  1246. You may also set this on a per-file basis by adding one of the following
  1247. lines to the buffer:
  1248. #+STARTUP: odd
  1249. #+STARTUP: oddeven"
  1250. :group 'org-edit-structure
  1251. :group 'org-appearance
  1252. :type 'boolean)
  1253. (defcustom org-adapt-indentation t
  1254. "Non-nil means adapt indentation to outline node level.
  1255. When this variable is set, Org assumes that you write outlines by
  1256. indenting text in each node to align with the headline (after the
  1257. stars). The following issues are influenced by this variable:
  1258. - The indentation is increased by one space in a demotion
  1259. command, and decreased by one in a promotion command. However,
  1260. in the latter case, if shifting some line in the entry body
  1261. would alter document structure (e.g., insert a new headline),
  1262. indentation is not changed at all.
  1263. - Property drawers and planning information is inserted indented
  1264. when this variable is set. When nil, they will not be indented.
  1265. - TAB indents a line relative to current level. The lines below
  1266. a headline will be indented when this variable is set.
  1267. Note that this is all about true indentation, by adding and
  1268. removing space characters. See also `org-indent.el' which does
  1269. level-dependent indentation in a virtual way, i.e. at display
  1270. time in Emacs."
  1271. :group 'org-edit-structure
  1272. :type 'boolean)
  1273. (defcustom org-special-ctrl-a/e nil
  1274. "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
  1275. When t, `C-a' will bring back the cursor to the beginning of the
  1276. headline text, i.e. after the stars and after a possible TODO
  1277. keyword. In an item, this will be the position after bullet and
  1278. check-box, if any. When the cursor is already at that position,
  1279. another `C-a' will bring it to the beginning of the line.
  1280. `C-e' will jump to the end of the headline, ignoring the presence
  1281. of tags in the headline. A second `C-e' will then jump to the
  1282. true end of the line, after any tags. This also means that, when
  1283. this variable is non-nil, `C-e' also will never jump beyond the
  1284. end of the heading of a folded section, i.e. not after the
  1285. ellipses.
  1286. When set to the symbol `reversed', the first `C-a' or `C-e' works
  1287. normally, going to the true line boundary first. Only a directly
  1288. following, identical keypress will bring the cursor to the
  1289. special positions.
  1290. This may also be a cons cell where the behavior for `C-a' and
  1291. `C-e' is set separately."
  1292. :group 'org-edit-structure
  1293. :type '(choice
  1294. (const :tag "off" nil)
  1295. (const :tag "on: after stars/bullet and before tags first" t)
  1296. (const :tag "reversed: true line boundary first" reversed)
  1297. (cons :tag "Set C-a and C-e separately"
  1298. (choice :tag "Special C-a"
  1299. (const :tag "off" nil)
  1300. (const :tag "on: after stars/bullet first" t)
  1301. (const :tag "reversed: before stars/bullet first" reversed))
  1302. (choice :tag "Special C-e"
  1303. (const :tag "off" nil)
  1304. (const :tag "on: before tags first" t)
  1305. (const :tag "reversed: after tags first" reversed)))))
  1306. (org-defvaralias 'org-special-ctrl-a 'org-special-ctrl-a/e)
  1307. (defcustom org-special-ctrl-k nil
  1308. "Non-nil means `C-k' will behave specially in headlines.
  1309. When nil, `C-k' will call the default `kill-line' command.
  1310. When t, the following will happen while the cursor is in the headline:
  1311. - When the cursor is at the beginning of a headline, kill the entire
  1312. line and possible the folded subtree below the line.
  1313. - When in the middle of the headline text, kill the headline up to the tags.
  1314. - When after the headline text, kill the tags."
  1315. :group 'org-edit-structure
  1316. :type 'boolean)
  1317. (defcustom org-ctrl-k-protect-subtree nil
  1318. "Non-nil means, do not delete a hidden subtree with C-k.
  1319. When set to the symbol `error', simply throw an error when C-k is
  1320. used to kill (part-of) a headline that has hidden text behind it.
  1321. Any other non-nil value will result in a query to the user, if it is
  1322. OK to kill that hidden subtree. When nil, kill without remorse."
  1323. :group 'org-edit-structure
  1324. :version "24.1"
  1325. :type '(choice
  1326. (const :tag "Do not protect hidden subtrees" nil)
  1327. (const :tag "Protect hidden subtrees with a security query" t)
  1328. (const :tag "Never kill a hidden subtree with C-k" error)))
  1329. (defcustom org-special-ctrl-o t
  1330. "Non-nil means, make `C-o' insert a row in tables."
  1331. :group 'org-edit-structure
  1332. :type 'boolean)
  1333. (defcustom org-catch-invisible-edits nil
  1334. "Check if in invisible region before inserting or deleting a character.
  1335. Valid values are:
  1336. nil Do not check, so just do invisible edits.
  1337. error Throw an error and do nothing.
  1338. show Make point visible, and do the requested edit.
  1339. show-and-error Make point visible, then throw an error and abort the edit.
  1340. smart Make point visible, and do insertion/deletion if it is
  1341. adjacent to visible text and the change feels predictable.
  1342. Never delete a previously invisible character or add in the
  1343. middle or right after an invisible region. Basically, this
  1344. allows insertion and backward-delete right before ellipses.
  1345. FIXME: maybe in this case we should not even show?"
  1346. :group 'org-edit-structure
  1347. :version "24.1"
  1348. :type '(choice
  1349. (const :tag "Do not check" nil)
  1350. (const :tag "Throw error when trying to edit" error)
  1351. (const :tag "Unhide, but do not do the edit" show-and-error)
  1352. (const :tag "Show invisible part and do the edit" show)
  1353. (const :tag "Be smart and do the right thing" smart)))
  1354. (defcustom org-yank-folded-subtrees t
  1355. "Non-nil means when yanking subtrees, fold them.
  1356. If the kill is a single subtree, or a sequence of subtrees, i.e. if
  1357. it starts with a heading and all other headings in it are either children
  1358. or siblings, then fold all the subtrees. However, do this only if no
  1359. text after the yank would be swallowed into a folded tree by this action."
  1360. :group 'org-edit-structure
  1361. :type 'boolean)
  1362. (defcustom org-yank-adjusted-subtrees nil
  1363. "Non-nil means when yanking subtrees, adjust the level.
  1364. With this setting, `org-paste-subtree' is used to insert the subtree, see
  1365. this function for details."
  1366. :group 'org-edit-structure
  1367. :type 'boolean)
  1368. (defcustom org-M-RET-may-split-line '((default . t))
  1369. "Non-nil means M-RET will split the line at the cursor position.
  1370. When nil, it will go to the end of the line before making a
  1371. new line.
  1372. You may also set this option in a different way for different
  1373. contexts. Valid contexts are:
  1374. headline when creating a new headline
  1375. item when creating a new item
  1376. table in a table field
  1377. default the value to be used for all contexts not explicitly
  1378. customized"
  1379. :group 'org-structure
  1380. :group 'org-table
  1381. :type '(choice
  1382. (const :tag "Always" t)
  1383. (const :tag "Never" nil)
  1384. (repeat :greedy t :tag "Individual contexts"
  1385. (cons
  1386. (choice :tag "Context"
  1387. (const headline)
  1388. (const item)
  1389. (const table)
  1390. (const default))
  1391. (boolean)))))
  1392. (defcustom org-insert-heading-respect-content nil
  1393. "Non-nil means insert new headings after the current subtree.
  1394. When nil, the new heading is created directly after the current line.
  1395. The commands \\[org-insert-heading-respect-content] and \\[org-insert-todo-heading-respect-content] turn
  1396. this variable on for the duration of the command."
  1397. :group 'org-structure
  1398. :type 'boolean)
  1399. (defcustom org-blank-before-new-entry '((heading . auto)
  1400. (plain-list-item . auto))
  1401. "Should `org-insert-heading' leave a blank line before new heading/item?
  1402. The value is an alist, with `heading' and `plain-list-item' as CAR,
  1403. and a boolean flag as CDR. The cdr may also be the symbol `auto', in
  1404. which case Org will look at the surrounding headings/items and try to
  1405. make an intelligent decision whether to insert a blank line or not.
  1406. For plain lists, if `org-list-empty-line-terminates-plain-lists' is set,
  1407. the setting here is ignored and no empty line is inserted to avoid breaking
  1408. the list structure."
  1409. :group 'org-edit-structure
  1410. :type '(list
  1411. (cons (const heading)
  1412. (choice (const :tag "Never" nil)
  1413. (const :tag "Always" t)
  1414. (const :tag "Auto" auto)))
  1415. (cons (const plain-list-item)
  1416. (choice (const :tag "Never" nil)
  1417. (const :tag "Always" t)
  1418. (const :tag "Auto" auto)))))
  1419. (defcustom org-insert-heading-hook nil
  1420. "Hook being run after inserting a new heading."
  1421. :group 'org-edit-structure
  1422. :type 'hook)
  1423. (defcustom org-enable-fixed-width-editor t
  1424. "Non-nil means lines starting with \":\" are treated as fixed-width.
  1425. This currently only means they are never auto-wrapped.
  1426. When nil, such lines will be treated like ordinary lines."
  1427. :group 'org-edit-structure
  1428. :type 'boolean)
  1429. (defcustom org-goto-auto-isearch t
  1430. "Non-nil means typing characters in `org-goto' starts incremental search.
  1431. When nil, you can use these keybindings to navigate the buffer:
  1432. q Quit the org-goto interface
  1433. n Go to the next visible heading
  1434. p Go to the previous visible heading
  1435. f Go one heading forward on same level
  1436. b Go one heading backward on same level
  1437. u Go one heading up"
  1438. :group 'org-edit-structure
  1439. :type 'boolean)
  1440. (defgroup org-sparse-trees nil
  1441. "Options concerning sparse trees in Org-mode."
  1442. :tag "Org Sparse Trees"
  1443. :group 'org-structure)
  1444. (defcustom org-highlight-sparse-tree-matches t
  1445. "Non-nil means highlight all matches that define a sparse tree.
  1446. The highlights will automatically disappear the next time the buffer is
  1447. changed by an edit command."
  1448. :group 'org-sparse-trees
  1449. :type 'boolean)
  1450. (defcustom org-remove-highlights-with-change t
  1451. "Non-nil means any change to the buffer will remove temporary highlights.
  1452. Such highlights are created by `org-occur' and `org-clock-display'.
  1453. When nil, `C-c C-c' needs to be used to get rid of the highlights.
  1454. The highlights created by `org-toggle-latex-fragment' always need
  1455. `C-c C-x C-l' to be removed."
  1456. :group 'org-sparse-trees
  1457. :group 'org-time
  1458. :type 'boolean)
  1459. (defcustom org-occur-hook '(org-first-headline-recenter)
  1460. "Hook that is run after `org-occur' has constructed a sparse tree.
  1461. This can be used to recenter the window to show as much of the structure
  1462. as possible."
  1463. :group 'org-sparse-trees
  1464. :type 'hook)
  1465. (defgroup org-imenu-and-speedbar nil
  1466. "Options concerning imenu and speedbar in Org-mode."
  1467. :tag "Org Imenu and Speedbar"
  1468. :group 'org-structure)
  1469. (defcustom org-imenu-depth 2
  1470. "The maximum level for Imenu access to Org-mode headlines.
  1471. This also applied for speedbar access."
  1472. :group 'org-imenu-and-speedbar
  1473. :type 'integer)
  1474. (defgroup org-table nil
  1475. "Options concerning tables in Org-mode."
  1476. :tag "Org Table"
  1477. :group 'org)
  1478. (defcustom org-enable-table-editor 'optimized
  1479. "Non-nil means lines starting with \"|\" are handled by the table editor.
  1480. When nil, such lines will be treated like ordinary lines.
  1481. When equal to the symbol `optimized', the table editor will be optimized to
  1482. do the following:
  1483. - Automatic overwrite mode in front of whitespace in table fields.
  1484. This makes the structure of the table stay in tact as long as the edited
  1485. field does not exceed the column width.
  1486. - Minimize the number of realigns. Normally, the table is aligned each time
  1487. TAB or RET are pressed to move to another field. With optimization this
  1488. happens only if changes to a field might have changed the column width.
  1489. Optimization requires replacing the functions `self-insert-command',
  1490. `delete-char', and `backward-delete-char' in Org-mode buffers, with a
  1491. slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
  1492. very good at guessing when a re-align will be necessary, but you can always
  1493. force one with \\[org-ctrl-c-ctrl-c].
  1494. If you would like to use the optimized version in Org-mode, but the
  1495. un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
  1496. This variable can be used to turn on and off the table editor during a session,
  1497. but in order to toggle optimization, a restart is required.
  1498. See also the variable `org-table-auto-blank-field'."
  1499. :group 'org-table
  1500. :type '(choice
  1501. (const :tag "off" nil)
  1502. (const :tag "on" t)
  1503. (const :tag "on, optimized" optimized)))
  1504. (defcustom org-self-insert-cluster-for-undo (or (featurep 'xemacs)
  1505. (version<= emacs-version "24.1"))
  1506. "Non-nil means cluster self-insert commands for undo when possible.
  1507. If this is set, then, like in the Emacs command loop, 20 consecutive
  1508. characters will be undone together.
  1509. This is configurable, because there is some impact on typing performance."
  1510. :group 'org-table
  1511. :type 'boolean)
  1512. (defcustom org-table-tab-recognizes-table.el t
  1513. "Non-nil means TAB will automatically notice a table.el table.
  1514. When it sees such a table, it moves point into it and - if necessary -
  1515. calls `table-recognize-table'."
  1516. :group 'org-table-editing
  1517. :type 'boolean)
  1518. (defgroup org-link nil
  1519. "Options concerning links in Org-mode."
  1520. :tag "Org Link"
  1521. :group 'org)
  1522. (defvar org-link-abbrev-alist-local nil
  1523. "Buffer-local version of `org-link-abbrev-alist', which see.
  1524. The value of this is taken from the #+LINK lines.")
  1525. (make-variable-buffer-local 'org-link-abbrev-alist-local)
  1526. (defcustom org-link-abbrev-alist nil
  1527. "Alist of link abbreviations.
  1528. The car of each element is a string, to be replaced at the start of a link.
  1529. The cdrs are replacement values, like (\"linkkey\" . REPLACE). Abbreviated
  1530. links in Org-mode buffers can have an optional tag after a double colon, e.g.
  1531. [[linkkey:tag][description]]
  1532. The 'linkkey' must be a word word, starting with a letter, followed
  1533. by letters, numbers, '-' or '_'.
  1534. If REPLACE is a string, the tag will simply be appended to create the link.
  1535. If the string contains \"%s\", the tag will be inserted there. If the string
  1536. contains \"%h\", it will cause a url-encoded version of the tag to be inserted
  1537. at that point (see the function `url-hexify-string'). If the string contains
  1538. the specifier \"%(my-function)\", then the custom function `my-function' will
  1539. be invoked: this function takes the tag as its only argument and must return
  1540. a string.
  1541. REPLACE may also be a function that will be called with the tag as the
  1542. only argument to create the link, which should be returned as a string.
  1543. See the manual for examples."
  1544. :group 'org-link
  1545. :type '(repeat
  1546. (cons
  1547. (string :tag "Protocol")
  1548. (choice
  1549. (string :tag "Format")
  1550. (function)))))
  1551. (defcustom org-descriptive-links t
  1552. "Non-nil means Org will display descriptive links.
  1553. E.g. [[http://orgmode.org][Org website]] will be displayed as
  1554. \"Org Website\", hiding the link itself and just displaying its
  1555. description. When set to `nil', Org will display the full links
  1556. literally.
  1557. You can interactively set the value of this variable by calling
  1558. `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
  1559. :group 'org-link
  1560. :type 'boolean)
  1561. (defcustom org-link-file-path-type 'adaptive
  1562. "How the path name in file links should be stored.
  1563. Valid values are:
  1564. relative Relative to the current directory, i.e. the directory of the file
  1565. into which the link is being inserted.
  1566. absolute Absolute path, if possible with ~ for home directory.
  1567. noabbrev Absolute path, no abbreviation of home directory.
  1568. adaptive Use relative path for files in the current directory and sub-
  1569. directories of it. For other files, use an absolute path."
  1570. :group 'org-link
  1571. :type '(choice
  1572. (const relative)
  1573. (const absolute)
  1574. (const noabbrev)
  1575. (const adaptive)))
  1576. (defvaralias 'org-activate-links 'org-highlight-links)
  1577. (defcustom org-highlight-links '(bracket angle plain radio tag date footnote)
  1578. "Types of links that should be highlighted in Org-mode files.
  1579. This is a list of symbols, each one of them leading to the
  1580. highlighting of a certain link type.
  1581. You can still open links that are not highlighted.
  1582. In principle, it does not hurt to turn on highlighting for all
  1583. link types. There may be a small gain when turning off unused
  1584. link types. The types are:
  1585. bracket The recommended [[link][description]] or [[link]] links with hiding.
  1586. angle Links in angular brackets that may contain whitespace like
  1587. <bbdb:Carsten Dominik>.
  1588. plain Plain links in normal text, no whitespace, like http://google.com.
  1589. radio Text that is matched by a radio target, see manual for details.
  1590. tag Tag settings in a headline (link to tag search).
  1591. date Time stamps (link to calendar).
  1592. footnote Footnote labels.
  1593. If you set this variable during an Emacs session, use `org-mode-restart'
  1594. in the Org buffer so that the change takes effect."
  1595. :group 'org-link
  1596. :group 'org-appearance
  1597. :type '(set :greedy t
  1598. (const :tag "Double bracket links" bracket)
  1599. (const :tag "Angular bracket links" angle)
  1600. (const :tag "Plain text links" plain)
  1601. (const :tag "Radio target matches" radio)
  1602. (const :tag "Tags" tag)
  1603. (const :tag "Timestamps" date)
  1604. (const :tag "Footnotes" footnote)))
  1605. (defcustom org-make-link-description-function nil
  1606. "Function to use for generating link descriptions from links.
  1607. When nil, the link location will be used. This function must take
  1608. two parameters: the first one is the link, the second one is the
  1609. description generated by `org-insert-link'. The function should
  1610. return the description to use."
  1611. :group 'org-link
  1612. :type '(choice (const nil) (function)))
  1613. (defgroup org-link-store nil
  1614. "Options concerning storing links in Org-mode."
  1615. :tag "Org Store Link"
  1616. :group 'org-link)
  1617. (defcustom org-url-hexify-p t
  1618. "When non-nil, hexify URL when creating a link."
  1619. :type 'boolean
  1620. :version "24.3"
  1621. :group 'org-link-store)
  1622. (defcustom org-email-link-description-format "Email %c: %.30s"
  1623. "Format of the description part of a link to an email or usenet message.
  1624. The following %-escapes will be replaced by corresponding information:
  1625. %F full \"From\" field
  1626. %f name, taken from \"From\" field, address if no name
  1627. %T full \"To\" field
  1628. %t first name in \"To\" field, address if no name
  1629. %c correspondent. Usually \"from NAME\", but if you sent it yourself, it
  1630. will be \"to NAME\". See also the variable `org-from-is-user-regexp'.
  1631. %s subject
  1632. %d date
  1633. %m message-id.
  1634. You may use normal field width specification between the % and the letter.
  1635. This is for example useful to limit the length of the subject.
  1636. Examples: \"%f on: %.30s\", \"Email from %f\", \"Email %c\""
  1637. :group 'org-link-store
  1638. :type 'string)
  1639. (defcustom org-from-is-user-regexp
  1640. (let (r1 r2)
  1641. (when (and user-mail-address (not (string= user-mail-address "")))
  1642. (setq r1 (concat "\\<" (regexp-quote user-mail-address) "\\>")))
  1643. (when (and user-full-name (not (string= user-full-name "")))
  1644. (setq r2 (concat "\\<" (regexp-quote user-full-name) "\\>")))
  1645. (if (and r1 r2) (concat r1 "\\|" r2) (or r1 r2)))
  1646. "Regexp matched against the \"From:\" header of an email or usenet message.
  1647. It should match if the message is from the user him/herself."
  1648. :group 'org-link-store
  1649. :type 'regexp)
  1650. (defcustom org-context-in-file-links t
  1651. "Non-nil means file links from `org-store-link' contain context.
  1652. A search string will be added to the file name with :: as separator and
  1653. used to find the context when the link is activated by the command
  1654. `org-open-at-point'. When this option is t, the entire active region
  1655. will be placed in the search string of the file link. If set to a
  1656. positive integer, only the first n lines of context will be stored.
  1657. Using a prefix arg to the command \\[org-store-link] (`org-store-link')
  1658. negates this setting for the duration of the command."
  1659. :group 'org-link-store
  1660. :type '(choice boolean integer))
  1661. (defcustom org-keep-stored-link-after-insertion nil
  1662. "Non-nil means keep link in list for entire session.
  1663. The command `org-store-link' adds a link pointing to the current
  1664. location to an internal list. These links accumulate during a session.
  1665. The command `org-insert-link' can be used to insert links into any
  1666. Org-mode file (offering completion for all stored links). When this
  1667. option is nil, every link which has been inserted once using \\[org-insert-link]
  1668. will be removed from the list, to make completing the unused links
  1669. more efficient."
  1670. :group 'org-link-store
  1671. :type 'boolean)
  1672. (defgroup org-link-follow nil
  1673. "Options concerning following links in Org-mode."
  1674. :tag "Org Follow Link"
  1675. :group 'org-link)
  1676. (defcustom org-link-translation-function nil
  1677. "Function to translate links with different syntax to Org syntax.
  1678. This can be used to translate links created for example by the Planner
  1679. or emacs-wiki packages to Org syntax.
  1680. The function must accept two parameters, a TYPE containing the link
  1681. protocol name like \"rmail\" or \"gnus\" as a string, and the linked path,
  1682. which is everything after the link protocol. It should return a cons
  1683. with possibly modified values of type and path.
  1684. Org contains a function for this, so if you set this variable to
  1685. `org-translate-link-from-planner', you should be able follow many
  1686. links created by planner."
  1687. :group 'org-link-follow
  1688. :type '(choice (const nil) (function)))
  1689. (defcustom org-follow-link-hook nil
  1690. "Hook that is run after a link has been followed."
  1691. :group 'org-link-follow
  1692. :type 'hook)
  1693. (defcustom org-tab-follows-link nil
  1694. "Non-nil means on links TAB will follow the link.
  1695. Needs to be set before org.el is loaded.
  1696. This really should not be used, it does not make sense, and the
  1697. implementation is bad."
  1698. :group 'org-link-follow
  1699. :type 'boolean)
  1700. (defcustom org-return-follows-link nil
  1701. "Non-nil means on links RET will follow the link.
  1702. In tables, the special behavior of RET has precedence."
  1703. :group 'org-link-follow
  1704. :type 'boolean)
  1705. (defcustom org-mouse-1-follows-link
  1706. (if (boundp 'mouse-1-click-follows-link) mouse-1-click-follows-link t)
  1707. "Non-nil means mouse-1 on a link will follow the link.
  1708. A longer mouse click will still set point. Does not work on XEmacs.
  1709. Needs to be set before org.el is loaded."
  1710. :group 'org-link-follow
  1711. :version "24.4"
  1712. :package-version '(Org . "8.3")
  1713. :type '(choice
  1714. (const :tag "A double click follows the link" double)
  1715. (const :tag "Unconditionally follow the link with mouse-1" t)
  1716. (integer :tag "mouse-1 click does not follow the link if longer than N ms" 450)))
  1717. (defcustom org-mark-ring-length 4
  1718. "Number of different positions to be recorded in the ring.
  1719. Changing this requires a restart of Emacs to work correctly."
  1720. :group 'org-link-follow
  1721. :type 'integer)
  1722. (defcustom org-link-search-must-match-exact-headline 'query-to-create
  1723. "Non-nil means internal links in Org files must exactly match a headline.
  1724. When nil, the link search tries to match a phrase with all words
  1725. in the search text."
  1726. :group 'org-link-follow
  1727. :version "24.1"
  1728. :type '(choice
  1729. (const :tag "Use fuzzy text search" nil)
  1730. (const :tag "Match only exact headline" t)
  1731. (const :tag "Match exact headline or query to create it"
  1732. query-to-create)))
  1733. (defcustom org-link-frame-setup
  1734. '((vm . vm-visit-folder-other-frame)
  1735. (vm-imap . vm-visit-imap-folder-other-frame)
  1736. (gnus . org-gnus-no-new-news)
  1737. (file . find-file-other-window)
  1738. (wl . wl-other-frame))
  1739. "Setup the frame configuration for following links.
  1740. When following a link with Emacs, it may often be useful to display
  1741. this link in another window or frame. This variable can be used to
  1742. set this up for the different types of links.
  1743. For VM, use any of
  1744. `vm-visit-folder'
  1745. `vm-visit-folder-other-window'
  1746. `vm-visit-folder-other-frame'
  1747. For Gnus, use any of
  1748. `gnus'
  1749. `gnus-other-frame'
  1750. `org-gnus-no-new-news'
  1751. For FILE, use any of
  1752. `find-file'
  1753. `find-file-other-window'
  1754. `find-file-other-frame'
  1755. For Wanderlust use any of
  1756. `wl'
  1757. `wl-other-frame'
  1758. For the calendar, use the variable `calendar-setup'.
  1759. For BBDB, it is currently only possible to display the matches in
  1760. another window."
  1761. :group 'org-link-follow
  1762. :type '(list
  1763. (cons (const vm)
  1764. (choice
  1765. (const vm-visit-folder)
  1766. (const vm-visit-folder-other-window)
  1767. (const vm-visit-folder-other-frame)))
  1768. (cons (const vm-imap)
  1769. (choice
  1770. (const vm-visit-imap-folder)
  1771. (const vm-visit-imap-folder-other-window)
  1772. (const vm-visit-imap-folder-other-frame)))
  1773. (cons (const gnus)
  1774. (choice
  1775. (const gnus)
  1776. (const gnus-other-frame)
  1777. (const org-gnus-no-new-news)))
  1778. (cons (const file)
  1779. (choice
  1780. (const find-file)
  1781. (const find-file-other-window)
  1782. (const find-file-other-frame)))
  1783. (cons (const wl)
  1784. (choice
  1785. (const wl)
  1786. (const wl-other-frame)))))
  1787. (defcustom org-display-internal-link-with-indirect-buffer nil
  1788. "Non-nil means use indirect buffer to display infile links.
  1789. Activating internal links (from one location in a file to another location
  1790. in the same file) normally just jumps to the location. When the link is
  1791. activated with a \\[universal-argument] prefix (or with mouse-3), the link \
  1792. is displayed in
  1793. another window. When this option is set, the other window actually displays
  1794. an indirect buffer clone of the current buffer, to avoid any visibility
  1795. changes to the current buffer."
  1796. :group 'org-link-follow
  1797. :type 'boolean)
  1798. (defcustom org-open-non-existing-files nil
  1799. "Non-nil means `org-open-file' will open non-existing files.
  1800. When nil, an error will be generated.
  1801. This variable applies only to external applications because they
  1802. might choke on non-existing files. If the link is to a file that
  1803. will be opened in Emacs, the variable is ignored."
  1804. :group 'org-link-follow
  1805. :type 'boolean)
  1806. (defcustom org-open-directory-means-index-dot-org nil
  1807. "Non-nil means a link to a directory really means to index.org.
  1808. When nil, following a directory link will run dired or open a finder/explorer
  1809. window on that directory."
  1810. :group 'org-link-follow
  1811. :type 'boolean)
  1812. (defcustom org-confirm-shell-link-function 'yes-or-no-p
  1813. "Non-nil means ask for confirmation before executing shell links.
  1814. Shell links can be dangerous: just think about a link
  1815. [[shell:rm -rf ~/*][Google Search]]
  1816. This link would show up in your Org-mode document as \"Google Search\",
  1817. but really it would remove your entire home directory.
  1818. Therefore we advise against setting this variable to nil.
  1819. Just change it to `y-or-n-p' if you want to confirm with a
  1820. single keystroke rather than having to type \"yes\"."
  1821. :group 'org-link-follow
  1822. :type '(choice
  1823. (const :tag "with yes-or-no (safer)" yes-or-no-p)
  1824. (const :tag "with y-or-n (faster)" y-or-n-p)
  1825. (const :tag "no confirmation (dangerous)" nil)))
  1826. (put 'org-confirm-shell-link-function
  1827. 'safe-local-variable
  1828. (lambda (x) (member x '(yes-or-no-p y-or-n-p))))
  1829. (defcustom org-confirm-shell-link-not-regexp ""
  1830. "A regexp to skip confirmation for shell links."
  1831. :group 'org-link-follow
  1832. :version "24.1"
  1833. :type 'regexp)
  1834. (defcustom org-confirm-elisp-link-function 'yes-or-no-p
  1835. "Non-nil means ask for confirmation before executing Emacs Lisp links.
  1836. Elisp links can be dangerous: just think about a link
  1837. [[elisp:(shell-command \"rm -rf ~/*\")][Google Search]]
  1838. This link would show up in your Org-mode document as \"Google Search\",
  1839. but really it would remove your entire home directory.
  1840. Therefore we advise against setting this variable to nil.
  1841. Just change it to `y-or-n-p' if you want to confirm with a
  1842. single keystroke rather than having to type \"yes\"."
  1843. :group 'org-link-follow
  1844. :type '(choice
  1845. (const :tag "with yes-or-no (safer)" yes-or-no-p)
  1846. (const :tag "with y-or-n (faster)" y-or-n-p)
  1847. (const :tag "no confirmation (dangerous)" nil)))
  1848. (put 'org-confirm-shell-link-function
  1849. 'safe-local-variable
  1850. (lambda (x) (member x '(yes-or-no-p y-or-n-p))))
  1851. (defcustom org-confirm-elisp-link-not-regexp ""
  1852. "A regexp to skip confirmation for Elisp links."
  1853. :group 'org-link-follow
  1854. :version "24.1"
  1855. :type 'regexp)
  1856. (defconst org-file-apps-defaults-gnu
  1857. '((remote . emacs)
  1858. (system . mailcap)
  1859. (t . mailcap))
  1860. "Default file applications on a UNIX or GNU/Linux system.
  1861. See `org-file-apps'.")
  1862. (defconst org-file-apps-defaults-macosx
  1863. '((remote . emacs)
  1864. (t . "open %s")
  1865. (system . "open %s")
  1866. ("ps.gz" . "gv %s")
  1867. ("eps.gz" . "gv %s")
  1868. ("dvi" . "xdvi %s")
  1869. ("fig" . "xfig %s"))
  1870. "Default file applications on a MacOS X system.
  1871. The system \"open\" is known as a default, but we use X11 applications
  1872. for some files for which the OS does not have a good default.
  1873. See `org-file-apps'.")
  1874. (defconst org-file-apps-defaults-windowsnt
  1875. (list
  1876. '(remote . emacs)
  1877. (cons t
  1878. (list (if (featurep 'xemacs)
  1879. 'mswindows-shell-execute
  1880. 'w32-shell-execute)
  1881. "open" 'file))
  1882. (cons 'system
  1883. (list (if (featurep 'xemacs)
  1884. 'mswindows-shell-execute
  1885. 'w32-shell-execute)
  1886. "open" 'file)))
  1887. "Default file applications on a Windows NT system.
  1888. The system \"open\" is used for most files.
  1889. See `org-file-apps'.")
  1890. (defcustom org-file-apps
  1891. '((auto-mode . emacs)
  1892. ("\\.mm\\'" . default)
  1893. ("\\.x?html?\\'" . default)
  1894. ("\\.pdf\\'" . default))
  1895. "External applications for opening `file:path' items in a document.
  1896. Org-mode uses system defaults for different file types, but
  1897. you can use this variable to set the application for a given file
  1898. extension. The entries in this list are cons cells where the car identifies
  1899. files and the cdr the corresponding command. Possible values for the
  1900. file identifier are
  1901. \"string\" A string as a file identifier can be interpreted in different
  1902. ways, depending on its contents:
  1903. - Alphanumeric characters only:
  1904. Match links with this file extension.
  1905. Example: (\"pdf\" . \"evince %s\")
  1906. to open PDFs with evince.
  1907. - Regular expression: Match links where the
  1908. filename matches the regexp. If you want to
  1909. use groups here, use shy groups.
  1910. Example: (\"\\.x?html\\'\" . \"firefox %s\")
  1911. (\"\\(?:xhtml\\|html\\)\" . \"firefox %s\")
  1912. to open *.html and *.xhtml with firefox.
  1913. - Regular expression which contains (non-shy) groups:
  1914. Match links where the whole link, including \"::\", and
  1915. anything after that, matches the regexp.
  1916. In a custom command string, %1, %2, etc. are replaced with
  1917. the parts of the link that were matched by the groups.
  1918. For backwards compatibility, if a command string is given
  1919. that does not use any of the group matches, this case is
  1920. handled identically to the second one (i.e. match against
  1921. file name only).
  1922. In a custom lisp form, you can access the group matches with
  1923. (match-string n link).
  1924. Example: (\"\\.pdf::\\(\\d+\\)\\'\" . \"evince -p %1 %s\")
  1925. to open [[file:document.pdf::5]] with evince at page 5.
  1926. `directory' Matches a directory
  1927. `remote' Matches a remote file, accessible through tramp or efs.
  1928. Remote files most likely should be visited through Emacs
  1929. because external applications cannot handle such paths.
  1930. `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
  1931. so all files Emacs knows how to handle. Using this with
  1932. command `emacs' will open most files in Emacs. Beware that this
  1933. will also open html files inside Emacs, unless you add
  1934. (\"html\" . default) to the list as well.
  1935. t Default for files not matched by any of the other options.
  1936. `system' The system command to open files, like `open' on Windows
  1937. and Mac OS X, and mailcap under GNU/Linux. This is the command
  1938. that will be selected if you call `C-c C-o' with a double
  1939. \\[universal-argument] \\[universal-argument] prefix.
  1940. Possible values for the command are:
  1941. `emacs' The file will be visited by the current Emacs process.
  1942. `default' Use the default application for this file type, which is the
  1943. association for t in the list, most likely in the system-specific
  1944. part.
  1945. This can be used to overrule an unwanted setting in the
  1946. system-specific variable.
  1947. `system' Use the system command for opening files, like \"open\".
  1948. This command is specified by the entry whose car is `system'.
  1949. Most likely, the system-specific version of this variable
  1950. does define this command, but you can overrule/replace it
  1951. here.
  1952. string A command to be executed by a shell; %s will be replaced
  1953. by the path to the file.
  1954. sexp A Lisp form which will be evaluated. The file path will
  1955. be available in the Lisp variable `file'.
  1956. For more examples, see the system specific constants
  1957. `org-file-apps-defaults-macosx'
  1958. `org-file-apps-defaults-windowsnt'
  1959. `org-file-apps-defaults-gnu'."
  1960. :group 'org-link-follow
  1961. :type '(repeat
  1962. (cons (choice :value ""
  1963. (string :tag "Extension")
  1964. (const :tag "System command to open files" system)
  1965. (const :tag "Default for unrecognized files" t)
  1966. (const :tag "Remote file" remote)
  1967. (const :tag "Links to a directory" directory)
  1968. (const :tag "Any files that have Emacs modes"
  1969. auto-mode))
  1970. (choice :value ""
  1971. (const :tag "Visit with Emacs" emacs)
  1972. (const :tag "Use default" default)
  1973. (const :tag "Use the system command" system)
  1974. (string :tag "Command")
  1975. (sexp :tag "Lisp form")))))
  1976. (defcustom org-doi-server-url "http://dx.doi.org/"
  1977. "The URL of the DOI server."
  1978. :type 'string
  1979. :version "24.3"
  1980. :group 'org-link-follow)
  1981. (defgroup org-refile nil
  1982. "Options concerning refiling entries in Org-mode."
  1983. :tag "Org Refile"
  1984. :group 'org)
  1985. (defcustom org-directory "~/org"
  1986. "Directory with org files.
  1987. This is just a default location to look for Org files. There is no need
  1988. at all to put your files into this directory. It is only used in the
  1989. following situations:
  1990. 1. When a capture template specifies a target file that is not an
  1991. absolute path. The path will then be interpreted relative to
  1992. `org-directory'
  1993. 2. When a capture note is filed away in an interactive way (when exiting the
  1994. note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
  1995. with `org-directory' as the default path."
  1996. :group 'org-refile
  1997. :group 'org-capture
  1998. :type 'directory)
  1999. (defcustom org-default-notes-file (convert-standard-filename "~/.notes")
  2000. "Default target for storing notes.
  2001. Used as a fall back file for org-capture.el, for templates that
  2002. do not specify a target file."
  2003. :group 'org-refile
  2004. :group 'org-capture
  2005. :type 'file)
  2006. (defcustom org-goto-interface 'outline
  2007. "The default interface to be used for `org-goto'.
  2008. Allowed values are:
  2009. outline The interface shows an outline of the relevant file
  2010. and the correct heading is found by moving through
  2011. the outline or by searching with incremental search.
  2012. outline-path-completion Headlines in the current buffer are offered via
  2013. completion. This is the interface also used by
  2014. the refile command."
  2015. :group 'org-refile
  2016. :type '(choice
  2017. (const :tag "Outline" outline)
  2018. (const :tag "Outline-path-completion" outline-path-completion)))
  2019. (defcustom org-goto-max-level 5
  2020. "Maximum target level when running `org-goto' with refile interface."
  2021. :group 'org-refile
  2022. :type 'integer)
  2023. (defcustom org-reverse-note-order nil
  2024. "Non-nil means store new notes at the beginning of a file or entry.
  2025. When nil, new notes will be filed to the end of a file or entry.
  2026. This can also be a list with cons cells of regular expressions that
  2027. are matched against file names, and values."
  2028. :group 'org-capture
  2029. :group 'org-refile
  2030. :type '(choice
  2031. (const :tag "Reverse always" t)
  2032. (const :tag "Reverse never" nil)
  2033. (repeat :tag "By file name regexp"
  2034. (cons regexp boolean))))
  2035. (defcustom org-log-refile nil
  2036. "Information to record when a task is refiled.
  2037. Possible values are:
  2038. nil Don't add anything
  2039. time Add a time stamp to the task
  2040. note Prompt for a note and add it with template `org-log-note-headings'
  2041. This option can also be set with on a per-file-basis with
  2042. #+STARTUP: nologrefile
  2043. #+STARTUP: logrefile
  2044. #+STARTUP: lognoterefile
  2045. You can have local logging settings for a subtree by setting the LOGGING
  2046. property to one or more of these keywords.
  2047. When bulk-refiling from the agenda, the value `note' is forbidden and
  2048. will temporarily be changed to `time'."
  2049. :group 'org-refile
  2050. :group 'org-progress
  2051. :version "24.1"
  2052. :type '(choice
  2053. (const :tag "No logging" nil)
  2054. (const :tag "Record timestamp" time)
  2055. (const :tag "Record timestamp with note." note)))
  2056. (defcustom org-refile-targets nil
  2057. "Targets for refiling entries with \\[org-refile].
  2058. This is a list of cons cells. Each cell contains:
  2059. - a specification of the files to be considered, either a list of files,
  2060. or a symbol whose function or variable value will be used to retrieve
  2061. a file name or a list of file names. If you use `org-agenda-files' for
  2062. that, all agenda files will be scanned for targets. Nil means consider
  2063. headings in the current buffer.
  2064. - A specification of how to find candidate refile targets. This may be
  2065. any of:
  2066. - a cons cell (:tag . \"TAG\") to identify refile targets by a tag.
  2067. This tag has to be present in all target headlines, inheritance will
  2068. not be considered.
  2069. - a cons cell (:todo . \"KEYWORD\") to identify refile targets by
  2070. todo keyword.
  2071. - a cons cell (:regexp . \"REGEXP\") with a regular expression matching
  2072. headlines that are refiling targets.
  2073. - a cons cell (:level . N). Any headline of level N is considered a target.
  2074. Note that, when `org-odd-levels-only' is set, level corresponds to
  2075. order in hierarchy, not to the number of stars.
  2076. - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
  2077. Note that, when `org-odd-levels-only' is set, level corresponds to
  2078. order in hierarchy, not to the number of stars.
  2079. Each element of this list generates a set of possible targets.
  2080. The union of these sets is presented (with completion) to
  2081. the user by `org-refile'.
  2082. You can set the variable `org-refile-target-verify-function' to a function
  2083. to verify each headline found by the simple criteria above.
  2084. When this variable is nil, all top-level headlines in the current buffer
  2085. are used, equivalent to the value `((nil . (:level . 1))'."
  2086. :group 'org-refile
  2087. :type '(repeat
  2088. (cons
  2089. (choice :value org-agenda-files
  2090. (const :tag "All agenda files" org-agenda-files)
  2091. (const :tag "Current buffer" nil)
  2092. (function) (variable) (file))
  2093. (choice :tag "Identify target headline by"
  2094. (cons :tag "Specific tag" (const :value :tag) (string))
  2095. (cons :tag "TODO keyword" (const :value :todo) (string))
  2096. (cons :tag "Regular expression" (const :value :regexp) (regexp))
  2097. (cons :tag "Level number" (const :value :level) (integer))
  2098. (cons :tag "Max Level number" (const :value :maxlevel) (integer))))))
  2099. (defcustom org-refile-target-verify-function nil
  2100. "Function to verify if the headline at point should be a refile target.
  2101. The function will be called without arguments, with point at the
  2102. beginning of the headline. It should return t and leave point
  2103. where it is if the headline is a valid target for refiling.
  2104. If the target should not be selected, the function must return nil.
  2105. In addition to this, it may move point to a place from where the search
  2106. should be continued. For example, the function may decide that the entire
  2107. subtree of the current entry should be excluded and move point to the end
  2108. of the subtree."
  2109. :group 'org-refile
  2110. :type '(choice
  2111. (const nil)
  2112. (function)))
  2113. (defcustom org-refile-use-cache nil
  2114. "Non-nil means cache refile targets to speed up the process.
  2115. The cache for a particular file will be updated automatically when
  2116. the buffer has been killed, or when any of the marker used for flagging
  2117. refile targets no longer points at a live buffer.
  2118. If you have added new entries to a buffer that might themselves be targets,
  2119. you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
  2120. find that easier, `C-u C-u C-u C-c C-w'."
  2121. :group 'org-refile
  2122. :version "24.1"
  2123. :type 'boolean)
  2124. (defcustom org-refile-use-outline-path nil
  2125. "Non-nil means provide refile targets as paths.
  2126. So a level 3 headline will be available as level1/level2/level3.
  2127. When the value is `file', also include the file name (without directory)
  2128. into the path. In this case, you can also stop the completion after
  2129. the file name, to get entries inserted as top level in the file.
  2130. When `full-file-path', include the full file path."
  2131. :group 'org-refile
  2132. :type '(choice
  2133. (const :tag "Not" nil)
  2134. (const :tag "Yes" t)
  2135. (const :tag "Start with file name" file)
  2136. (const :tag "Start with full file path" full-file-path)))
  2137. (defcustom org-outline-path-complete-in-steps t
  2138. "Non-nil means complete the outline path in hierarchical steps.
  2139. When Org-mode uses the refile interface to select an outline path
  2140. \(see variable `org-refile-use-outline-path'), the completion of
  2141. the path can be done in a single go, or it can be done in steps down
  2142. the headline hierarchy. Going in steps is probably the best if you
  2143. do not use a special completion package like `ido' or `icicles'.
  2144. However, when using these packages, going in one step can be very
  2145. fast, while still showing the whole path to the entry."
  2146. :group 'org-refile
  2147. :type 'boolean)
  2148. (defcustom org-refile-allow-creating-parent-nodes nil
  2149. "Non-nil means allow to create new nodes as refile targets.
  2150. New nodes are then created by adding \"/new node name\" to the completion
  2151. of an existing node. When the value of this variable is `confirm',
  2152. new node creation must be confirmed by the user (recommended).
  2153. When nil, the completion must match an existing entry.
  2154. Note that, if the new heading is not seen by the criteria
  2155. listed in `org-refile-targets', multiple instances of the same
  2156. heading would be created by trying again to file under the new
  2157. heading."
  2158. :group 'org-refile
  2159. :type '(choice
  2160. (const :tag "Never" nil)
  2161. (const :tag "Always" t)
  2162. (const :tag "Prompt for confirmation" confirm)))
  2163. (defcustom org-refile-active-region-within-subtree nil
  2164. "Non-nil means also refile active region within a subtree.
  2165. By default `org-refile' doesn't allow refiling regions if they
  2166. don't contain a set of subtrees, but it might be convenient to
  2167. do so sometimes: in that case, the first line of the region is
  2168. converted to a headline before refiling."
  2169. :group 'org-refile
  2170. :version "24.1"
  2171. :type 'boolean)
  2172. (defgroup org-todo nil
  2173. "Options concerning TODO items in Org-mode."
  2174. :tag "Org TODO"
  2175. :group 'org)
  2176. (defgroup org-progress nil
  2177. "Options concerning Progress logging in Org-mode."
  2178. :tag "Org Progress"
  2179. :group 'org-time)
  2180. (defvar org-todo-interpretation-widgets
  2181. '((:tag "Sequence (cycling hits every state)" sequence)
  2182. (:tag "Type (cycling directly to DONE)" type))
  2183. "The available interpretation symbols for customizing `org-todo-keywords'.
  2184. Interested libraries should add to this list.")
  2185. (defcustom org-todo-keywords '((sequence "TODO" "DONE"))
  2186. "List of TODO entry keyword sequences and their interpretation.
  2187. \\<org-mode-map>This is a list of sequences.
  2188. Each sequence starts with a symbol, either `sequence' or `type',
  2189. indicating if the keywords should be interpreted as a sequence of
  2190. action steps, or as different types of TODO items. The first
  2191. keywords are states requiring action - these states will select a headline
  2192. for inclusion into the global TODO list Org-mode produces. If one of
  2193. the \"keywords\" is the vertical bar, \"|\", the remaining keywords
  2194. signify that no further action is necessary. If \"|\" is not found,
  2195. the last keyword is treated as the only DONE state of the sequence.
  2196. The command \\[org-todo] cycles an entry through these states, and one
  2197. additional state where no keyword is present. For details about this
  2198. cycling, see the manual.
  2199. TODO keywords and interpretation can also be set on a per-file basis with
  2200. the special #+SEQ_TODO and #+TYP_TODO lines.
  2201. Each keyword can optionally specify a character for fast state selection
  2202. \(in combination with the variable `org-use-fast-todo-selection')
  2203. and specifiers for state change logging, using the same syntax that
  2204. is used in the \"#+TODO:\" lines. For example, \"WAIT(w)\" says that
  2205. the WAIT state can be selected with the \"w\" key. \"WAIT(w!)\"
  2206. indicates to record a time stamp each time this state is selected.
  2207. Each keyword may also specify if a timestamp or a note should be
  2208. recorded when entering or leaving the state, by adding additional
  2209. characters in the parenthesis after the keyword. This looks like this:
  2210. \"WAIT(w@/!)\". \"@\" means to add a note (with time), \"!\" means to
  2211. record only the time of the state change. With X and Y being either
  2212. \"@\" or \"!\", \"X/Y\" means use X when entering the state, and use
  2213. Y when leaving the state if and only if the *target* state does not
  2214. define X. You may omit any of the fast-selection key or X or /Y,
  2215. so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
  2216. For backward compatibility, this variable may also be just a list
  2217. of keywords. In this case the interpretation (sequence or type) will be
  2218. taken from the (otherwise obsolete) variable `org-todo-interpretation'."
  2219. :group 'org-todo
  2220. :group 'org-keywords
  2221. :type '(choice
  2222. (repeat :tag "Old syntax, just keywords"
  2223. (string :tag "Keyword"))
  2224. (repeat :tag "New syntax"
  2225. (cons
  2226. (choice
  2227. :tag "Interpretation"
  2228. ;;Quick and dirty way to see
  2229. ;;`org-todo-interpretations'. This takes the
  2230. ;;place of item arguments
  2231. :convert-widget
  2232. (lambda (widget)
  2233. (widget-put widget
  2234. :args (mapcar
  2235. (lambda (x)
  2236. (widget-convert
  2237. (cons 'const x)))
  2238. org-todo-interpretation-widgets))
  2239. widget))
  2240. (repeat
  2241. (string :tag "Keyword"))))))
  2242. (defvar org-todo-keywords-1 nil
  2243. "All TODO and DONE keywords active in a buffer.")
  2244. (make-variable-buffer-local 'org-todo-keywords-1)
  2245. (defvar org-todo-keywords-for-agenda nil)
  2246. (defvar org-done-keywords-for-agenda nil)
  2247. (defvar org-todo-keyword-alist-for-agenda nil)
  2248. (defvar org-tag-alist-for-agenda nil
  2249. "Alist of all tags from all agenda files.")
  2250. (defvar org-tag-groups-alist-for-agenda nil
  2251. "Alist of all groups tags from all current agenda files.")
  2252. (defvar org-tag-groups-alist nil)
  2253. (make-variable-buffer-local 'org-tag-groups-alist)
  2254. (defvar org-agenda-contributing-files nil)
  2255. (defvar org-not-done-keywords nil)
  2256. (make-variable-buffer-local 'org-not-done-keywords)
  2257. (defvar org-done-keywords nil)
  2258. (make-variable-buffer-local 'org-done-keywords)
  2259. (defvar org-todo-heads nil)
  2260. (make-variable-buffer-local 'org-todo-heads)
  2261. (defvar org-todo-sets nil)
  2262. (make-variable-buffer-local 'org-todo-sets)
  2263. (defvar org-todo-log-states nil)
  2264. (make-variable-buffer-local 'org-todo-log-states)
  2265. (defvar org-todo-kwd-alist nil)
  2266. (make-variable-buffer-local 'org-todo-kwd-alist)
  2267. (defvar org-todo-key-alist nil)
  2268. (make-variable-buffer-local 'org-todo-key-alist)
  2269. (defvar org-todo-key-trigger nil)
  2270. (make-variable-buffer-local 'org-todo-key-trigger)
  2271. (defcustom org-todo-interpretation 'sequence
  2272. "Controls how TODO keywords are interpreted.
  2273. This variable is in principle obsolete and is only used for
  2274. backward compatibility, if the interpretation of todo keywords is
  2275. not given already in `org-todo-keywords'. See that variable for
  2276. more information."
  2277. :group 'org-todo
  2278. :group 'org-keywords
  2279. :type '(choice (const sequence)
  2280. (const type)))
  2281. (defcustom org-use-fast-todo-selection t
  2282. "Non-nil means use the fast todo selection scheme with C-c C-t.
  2283. This variable describes if and under what circumstances the cycling
  2284. mechanism for TODO keywords will be replaced by a single-key, direct
  2285. selection scheme.
  2286. When nil, fast selection is never used.
  2287. When the symbol `prefix', it will be used when `org-todo' is called
  2288. with a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and
  2289. `C-u t' in an agenda buffer.
  2290. When t, fast selection is used by default. In this case, the prefix
  2291. argument forces cycling instead.
  2292. In all cases, the special interface is only used if access keys have
  2293. actually been assigned by the user, i.e. if keywords in the configuration
  2294. are followed by a letter in parenthesis, like TODO(t)."
  2295. :group 'org-todo
  2296. :type '(choice
  2297. (const :tag "Never" nil)
  2298. (const :tag "By default" t)
  2299. (const :tag "Only with C-u C-c C-t" prefix)))
  2300. (defcustom org-provide-todo-statistics t
  2301. "Non-nil means update todo statistics after insert and toggle.
  2302. ALL-HEADLINES means update todo statistics by including headlines
  2303. with no TODO keyword as well, counting them as not done.
  2304. A list of TODO keywords means the same, but skip keywords that are
  2305. not in this list.
  2306. When set to a list of two lists, the first list contains keywords
  2307. to consider as TODO keywords, the second list contains keywords
  2308. to consider as DONE keywords.
  2309. When this is set, todo statistics is updated in the parent of the
  2310. current entry each time a todo state is changed."
  2311. :group 'org-todo
  2312. :type '(choice
  2313. (const :tag "Yes, only for TODO entries" t)
  2314. (const :tag "Yes, including all entries" all-headlines)
  2315. (repeat :tag "Yes, for TODOs in this list"
  2316. (string :tag "TODO keyword"))
  2317. (list :tag "Yes, for TODOs and DONEs in these lists"
  2318. (repeat (string :tag "TODO keyword"))
  2319. (repeat (string :tag "DONE keyword")))
  2320. (other :tag "No TODO statistics" nil)))
  2321. (defcustom org-hierarchical-todo-statistics t
  2322. "Non-nil means TODO statistics covers just direct children.
  2323. When nil, all entries in the subtree are considered.
  2324. This has only an effect if `org-provide-todo-statistics' is set.
  2325. To set this to nil for only a single subtree, use a COOKIE_DATA
  2326. property and include the word \"recursive\" into the value."
  2327. :group 'org-todo
  2328. :type 'boolean)
  2329. (defcustom org-after-todo-state-change-hook nil
  2330. "Hook which is run after the state of a TODO item was changed.
  2331. The new state (a string with a TODO keyword, or nil) is available in the
  2332. Lisp variable `org-state'."
  2333. :group 'org-todo
  2334. :type 'hook)
  2335. (defvar org-blocker-hook nil
  2336. "Hook for functions that are allowed to block a state change.
  2337. Functions in this hook should not modify the buffer.
  2338. Each function gets as its single argument a property list,
  2339. see `org-trigger-hook' for more information about this list.
  2340. If any of the functions in this hook returns nil, the state change
  2341. is blocked.")
  2342. (defvar org-trigger-hook nil
  2343. "Hook for functions that are triggered by a state change.
  2344. Each function gets as its single argument a property list with at
  2345. least the following elements:
  2346. (:type type-of-change :position pos-at-entry-start
  2347. :from old-state :to new-state)
  2348. Depending on the type, more properties may be present.
  2349. This mechanism is currently implemented for:
  2350. TODO state changes
  2351. ------------------
  2352. :type todo-state-change
  2353. :from previous state (keyword as a string), or nil, or a symbol
  2354. 'todo' or 'done', to indicate the general type of state.
  2355. :to new state, like in :from")
  2356. (defcustom org-enforce-todo-dependencies nil
  2357. "Non-nil means undone TODO entries will block switching the parent to DONE.
  2358. Also, if a parent has an :ORDERED: property, switching an entry to DONE will
  2359. be blocked if any prior sibling is not yet done.
  2360. Finally, if the parent is blocked because of ordered siblings of its own,
  2361. the child will also be blocked."
  2362. :set (lambda (var val)
  2363. (set var val)
  2364. (if val
  2365. (add-hook 'org-blocker-hook
  2366. 'org-block-todo-from-children-or-siblings-or-parent)
  2367. (remove-hook 'org-blocker-hook
  2368. 'org-block-todo-from-children-or-siblings-or-parent)))
  2369. :group 'org-todo
  2370. :type 'boolean)
  2371. (defcustom org-enforce-todo-checkbox-dependencies nil
  2372. "Non-nil means unchecked boxes will block switching the parent to DONE.
  2373. When this is nil, checkboxes have no influence on switching TODO states.
  2374. When non-nil, you first need to check off all check boxes before the TODO
  2375. entry can be switched to DONE.
  2376. This variable needs to be set before org.el is loaded, and you need to
  2377. restart Emacs after a change to make the change effective. The only way
  2378. to change is while Emacs is running is through the customize interface."
  2379. :set (lambda (var val)
  2380. (set var val)
  2381. (if val
  2382. (add-hook 'org-blocker-hook
  2383. 'org-block-todo-from-checkboxes)
  2384. (remove-hook 'org-blocker-hook
  2385. 'org-block-todo-from-checkboxes)))
  2386. :group 'org-todo
  2387. :type 'boolean)
  2388. (defcustom org-treat-insert-todo-heading-as-state-change nil
  2389. "Non-nil means inserting a TODO heading is treated as state change.
  2390. So when the command \\[org-insert-todo-heading] is used, state change
  2391. logging will apply if appropriate. When nil, the new TODO item will
  2392. be inserted directly, and no logging will take place."
  2393. :group 'org-todo
  2394. :type 'boolean)
  2395. (defcustom org-treat-S-cursor-todo-selection-as-state-change t
  2396. "Non-nil means switching TODO states with S-cursor counts as state change.
  2397. This is the default behavior. However, setting this to nil allows a
  2398. convenient way to select a TODO state and bypass any logging associated
  2399. with that."
  2400. :group 'org-todo
  2401. :type 'boolean)
  2402. (defcustom org-todo-state-tags-triggers nil
  2403. "Tag changes that should be triggered by TODO state changes.
  2404. This is a list. Each entry is
  2405. (state-change (tag . flag) .......)
  2406. State-change can be a string with a state, and empty string to indicate the
  2407. state that has no TODO keyword, or it can be one of the symbols `todo'
  2408. or `done', meaning any not-done or done state, respectively."
  2409. :group 'org-todo
  2410. :group 'org-tags
  2411. :type '(repeat
  2412. (cons (choice :tag "When changing to"
  2413. (const :tag "Not-done state" todo)
  2414. (const :tag "Done state" done)
  2415. (string :tag "State"))
  2416. (repeat
  2417. (cons :tag "Tag action"
  2418. (string :tag "Tag")
  2419. (choice (const :tag "Add" t) (const :tag "Remove" nil)))))))
  2420. (defcustom org-log-done nil
  2421. "Information to record when a task moves to the DONE state.
  2422. Possible values are:
  2423. nil Don't add anything, just change the keyword
  2424. time Add a time stamp to the task
  2425. note Prompt for a note and add it with template `org-log-note-headings'
  2426. This option can also be set with on a per-file-basis with
  2427. #+STARTUP: nologdone
  2428. #+STARTUP: logdone
  2429. #+STARTUP: lognotedone
  2430. You can have local logging settings for a subtree by setting the LOGGING
  2431. property to one or more of these keywords."
  2432. :group 'org-todo
  2433. :group 'org-progress
  2434. :type '(choice
  2435. (const :tag "No logging" nil)
  2436. (const :tag "Record CLOSED timestamp" time)
  2437. (const :tag "Record CLOSED timestamp with note." note)))
  2438. ;; Normalize old uses of org-log-done.
  2439. (cond
  2440. ((eq org-log-done t) (setq org-log-done 'time))
  2441. ((and (listp org-log-done) (memq 'done org-log-done))
  2442. (setq org-log-done 'note)))
  2443. (defcustom org-log-reschedule nil
  2444. "Information to record when the scheduling date of a tasks is modified.
  2445. Possible values are:
  2446. nil Don't add anything, just change the date
  2447. time Add a time stamp to the task
  2448. note Prompt for a note and add it with template `org-log-note-headings'
  2449. This option can also be set with on a per-file-basis with
  2450. #+STARTUP: nologreschedule
  2451. #+STARTUP: logreschedule
  2452. #+STARTUP: lognotereschedule"
  2453. :group 'org-todo
  2454. :group 'org-progress
  2455. :type '(choice
  2456. (const :tag "No logging" nil)
  2457. (const :tag "Record timestamp" time)
  2458. (const :tag "Record timestamp with note." note)))
  2459. (defcustom org-log-redeadline nil
  2460. "Information to record when the deadline date of a tasks is modified.
  2461. Possible values are:
  2462. nil Don't add anything, just change the date
  2463. time Add a time stamp to the task
  2464. note Prompt for a note and add it with template `org-log-note-headings'
  2465. This option can also be set with on a per-file-basis with
  2466. #+STARTUP: nologredeadline
  2467. #+STARTUP: logredeadline
  2468. #+STARTUP: lognoteredeadline
  2469. You can have local logging settings for a subtree by setting the LOGGING
  2470. property to one or more of these keywords."
  2471. :group 'org-todo
  2472. :group 'org-progress
  2473. :type '(choice
  2474. (const :tag "No logging" nil)
  2475. (const :tag "Record timestamp" time)
  2476. (const :tag "Record timestamp with note." note)))
  2477. (defcustom org-log-note-clock-out nil
  2478. "Non-nil means record a note when clocking out of an item.
  2479. This can also be configured on a per-file basis by adding one of
  2480. the following lines anywhere in the buffer:
  2481. #+STARTUP: lognoteclock-out
  2482. #+STARTUP: nolognoteclock-out"
  2483. :group 'org-todo
  2484. :group 'org-progress
  2485. :type 'boolean)
  2486. (defcustom org-log-done-with-time t
  2487. "Non-nil means the CLOSED time stamp will contain date and time.
  2488. When nil, only the date will be recorded."
  2489. :group 'org-progress
  2490. :type 'boolean)
  2491. (defcustom org-log-note-headings
  2492. '((done . "CLOSING NOTE %t")
  2493. (state . "State %-12s from %-12S %t")
  2494. (note . "Note taken on %t")
  2495. (reschedule . "Rescheduled from %S on %t")
  2496. (delschedule . "Not scheduled, was %S on %t")
  2497. (redeadline . "New deadline from %S on %t")
  2498. (deldeadline . "Removed deadline, was %S on %t")
  2499. (refile . "Refiled on %t")
  2500. (clock-out . ""))
  2501. "Headings for notes added to entries.
  2502. The value is an alist, with the car being a symbol indicating the note
  2503. context, and the cdr is the heading to be used. The heading may also be the
  2504. empty string.
  2505. %t in the heading will be replaced by a time stamp.
  2506. %T will be an active time stamp instead the default inactive one
  2507. %d will be replaced by a short-format time stamp.
  2508. %D will be replaced by an active short-format time stamp.
  2509. %s will be replaced by the new TODO state, in double quotes.
  2510. %S will be replaced by the old TODO state, in double quotes.
  2511. %u will be replaced by the user name.
  2512. %U will be replaced by the full user name.
  2513. In fact, it is not a good idea to change the `state' entry, because
  2514. agenda log mode depends on the format of these entries."
  2515. :group 'org-todo
  2516. :group 'org-progress
  2517. :type '(list :greedy t
  2518. (cons (const :tag "Heading when closing an item" done) string)
  2519. (cons (const :tag
  2520. "Heading when changing todo state (todo sequence only)"
  2521. state) string)
  2522. (cons (const :tag "Heading when just taking a note" note) string)
  2523. (cons (const :tag "Heading when rescheduling" reschedule) string)
  2524. (cons (const :tag "Heading when an item is no longer scheduled" delschedule) string)
  2525. (cons (const :tag "Heading when changing deadline" redeadline) string)
  2526. (cons (const :tag "Heading when deleting a deadline" deldeadline) string)
  2527. (cons (const :tag "Heading when refiling" refile) string)
  2528. (cons (const :tag "Heading when clocking out" clock-out) string)))
  2529. (unless (assq 'note org-log-note-headings)
  2530. (push '(note . "%t") org-log-note-headings))
  2531. (defcustom org-log-into-drawer nil
  2532. "Non-nil means insert state change notes and time stamps into a drawer.
  2533. When nil, state changes notes will be inserted after the headline and
  2534. any scheduling and clock lines, but not inside a drawer.
  2535. The value of this variable should be the name of the drawer to use.
  2536. LOGBOOK is proposed as the default drawer for this purpose, you can
  2537. also set this to a string to define the drawer of your choice.
  2538. A value of t is also allowed, representing \"LOGBOOK\".
  2539. A value of t or nil can also be set with on a per-file-basis with
  2540. #+STARTUP: logdrawer
  2541. #+STARTUP: nologdrawer
  2542. If this variable is set, `org-log-state-notes-insert-after-drawers'
  2543. will be ignored.
  2544. You can set the property LOG_INTO_DRAWER to overrule this setting for
  2545. a subtree.
  2546. Do not check directly this variable in a Lisp program. Call
  2547. function `org-log-into-drawer' instead."
  2548. :group 'org-todo
  2549. :group 'org-progress
  2550. :type '(choice
  2551. (const :tag "Not into a drawer" nil)
  2552. (const :tag "LOGBOOK" t)
  2553. (string :tag "Other")))
  2554. (org-defvaralias 'org-log-state-notes-into-drawer 'org-log-into-drawer)
  2555. (defun org-log-into-drawer ()
  2556. "Name of the log drawer, as a string, or nil.
  2557. This is the value of `org-log-into-drawer'. However, if the
  2558. current entry has or inherits a LOG_INTO_DRAWER property, it will
  2559. be used instead of the default value."
  2560. (let ((p (org-entry-get nil "LOG_INTO_DRAWER" 'inherit t)))
  2561. (cond ((equal p "nil") nil)
  2562. ((equal p "t") "LOGBOOK")
  2563. ((stringp p) p)
  2564. (p "LOGBOOK")
  2565. ((stringp org-log-into-drawer) org-log-into-drawer)
  2566. (org-log-into-drawer "LOGBOOK"))))
  2567. (defcustom org-log-state-notes-insert-after-drawers nil
  2568. "Non-nil means insert state change notes after any drawers in entry.
  2569. Only the drawers that *immediately* follow the headline and the
  2570. deadline/scheduled line are skipped.
  2571. When nil, insert notes right after the heading and perhaps the line
  2572. with deadline/scheduling if present.
  2573. This variable will have no effect if `org-log-into-drawer' is
  2574. set."
  2575. :group 'org-todo
  2576. :group 'org-progress
  2577. :type 'boolean)
  2578. (defcustom org-log-states-order-reversed t
  2579. "Non-nil means the latest state note will be directly after heading.
  2580. When nil, the state change notes will be ordered according to time.
  2581. This option can also be set with on a per-file-basis with
  2582. #+STARTUP: logstatesreversed
  2583. #+STARTUP: nologstatesreversed"
  2584. :group 'org-todo
  2585. :group 'org-progress
  2586. :type 'boolean)
  2587. (defcustom org-todo-repeat-to-state nil
  2588. "The TODO state to which a repeater should return the repeating task.
  2589. By default this is the first task in a TODO sequence, or the previous state
  2590. in a TODO_TYP set. But you can specify another task here.
  2591. alternatively, set the :REPEAT_TO_STATE: property of the entry."
  2592. :group 'org-todo
  2593. :version "24.1"
  2594. :type '(choice (const :tag "Head of sequence" nil)
  2595. (string :tag "Specific state")))
  2596. (defcustom org-log-repeat 'time
  2597. "Non-nil means record moving through the DONE state when triggering repeat.
  2598. An auto-repeating task is immediately switched back to TODO when
  2599. marked DONE. If you are not logging state changes (by adding \"@\"
  2600. or \"!\" to the TODO keyword definition), or set `org-log-done' to
  2601. record a closing note, there will be no record of the task moving
  2602. through DONE. This variable forces taking a note anyway.
  2603. nil Don't force a record
  2604. time Record a time stamp
  2605. note Prompt for a note and add it with template `org-log-note-headings'
  2606. This option can also be set with on a per-file-basis with
  2607. #+STARTUP: nologrepeat
  2608. #+STARTUP: logrepeat
  2609. #+STARTUP: lognoterepeat
  2610. You can have local logging settings for a subtree by setting the LOGGING
  2611. property to one or more of these keywords."
  2612. :group 'org-todo
  2613. :group 'org-progress
  2614. :type '(choice
  2615. (const :tag "Don't force a record" nil)
  2616. (const :tag "Force recording the DONE state" time)
  2617. (const :tag "Force recording a note with the DONE state" note)))
  2618. (defgroup org-priorities nil
  2619. "Priorities in Org-mode."
  2620. :tag "Org Priorities"
  2621. :group 'org-todo)
  2622. (defcustom org-enable-priority-commands t
  2623. "Non-nil means priority commands are active.
  2624. When nil, these commands will be disabled, so that you never accidentally
  2625. set a priority."
  2626. :group 'org-priorities
  2627. :type 'boolean)
  2628. (defcustom org-highest-priority ?A
  2629. "The highest priority of TODO items. A character like ?A, ?B etc.
  2630. Must have a smaller ASCII number than `org-lowest-priority'."
  2631. :group 'org-priorities
  2632. :type 'character)
  2633. (defcustom org-lowest-priority ?C
  2634. "The lowest priority of TODO items. A character like ?A, ?B etc.
  2635. Must have a larger ASCII number than `org-highest-priority'."
  2636. :group 'org-priorities
  2637. :type 'character)
  2638. (defcustom org-default-priority ?B
  2639. "The default priority of TODO items.
  2640. This is the priority an item gets if no explicit priority is given.
  2641. When starting to cycle on an empty priority the first step in the cycle
  2642. depends on `org-priority-start-cycle-with-default'. The resulting first
  2643. step priority must not exceed the range from `org-highest-priority' to
  2644. `org-lowest-priority' which means that `org-default-priority' has to be
  2645. in this range exclusive or inclusive the range boundaries. Else the
  2646. first step refuses to set the default and the second will fall back
  2647. to (depending on the command used) the highest or lowest priority."
  2648. :group 'org-priorities
  2649. :type 'character)
  2650. (defcustom org-priority-start-cycle-with-default t
  2651. "Non-nil means start with default priority when starting to cycle.
  2652. When this is nil, the first step in the cycle will be (depending on the
  2653. command used) one higher or lower than the default priority.
  2654. See also `org-default-priority'."
  2655. :group 'org-priorities
  2656. :type 'boolean)
  2657. (defcustom org-get-priority-function nil
  2658. "Function to extract the priority from a string.
  2659. The string is normally the headline. If this is nil Org computes the
  2660. priority from the priority cookie like [#A] in the headline. It returns
  2661. an integer, increasing by 1000 for each priority level.
  2662. The user can set a different function here, which should take a string
  2663. as an argument and return the numeric priority."
  2664. :group 'org-priorities
  2665. :version "24.1"
  2666. :type '(choice
  2667. (const nil)
  2668. (function)))
  2669. (defgroup org-time nil
  2670. "Options concerning time stamps and deadlines in Org-mode."
  2671. :tag "Org Time"
  2672. :group 'org)
  2673. (defcustom org-time-stamp-rounding-minutes '(0 5)
  2674. "Number of minutes to round time stamps to.
  2675. These are two values, the first applies when first creating a time stamp.
  2676. The second applies when changing it with the commands `S-up' and `S-down'.
  2677. When changing the time stamp, this means that it will change in steps
  2678. of N minutes, as given by the second value.
  2679. When a setting is 0 or 1, insert the time unmodified. Useful rounding
  2680. numbers should be factors of 60, so for example 5, 10, 15.
  2681. When this is larger than 1, you can still force an exact time stamp by using
  2682. a double prefix argument to a time stamp command like `C-c .' or `C-c !',
  2683. and by using a prefix arg to `S-up/down' to specify the exact number
  2684. of minutes to shift."
  2685. :group 'org-time
  2686. :get (lambda (var) ; Make sure both elements are there
  2687. (if (integerp (default-value var))
  2688. (list (default-value var) 5)
  2689. (default-value var)))
  2690. :type '(list
  2691. (integer :tag "when inserting times")
  2692. (integer :tag "when modifying times")))
  2693. ;; Normalize old customizations of this variable.
  2694. (when (integerp org-time-stamp-rounding-minutes)
  2695. (setq org-time-stamp-rounding-minutes
  2696. (list org-time-stamp-rounding-minutes
  2697. org-time-stamp-rounding-minutes)))
  2698. (defcustom org-display-custom-times nil
  2699. "Non-nil means overlay custom formats over all time stamps.
  2700. The formats are defined through the variable `org-time-stamp-custom-formats'.
  2701. To turn this on on a per-file basis, insert anywhere in the file:
  2702. #+STARTUP: customtime"
  2703. :group 'org-time
  2704. :set 'set-default
  2705. :type 'sexp)
  2706. (make-variable-buffer-local 'org-display-custom-times)
  2707. (defcustom org-time-stamp-custom-formats
  2708. '("<%m/%d/%y %a>" . "<%m/%d/%y %a %H:%M>") ; american
  2709. "Custom formats for time stamps. See `format-time-string' for the syntax.
  2710. These are overlaid over the default ISO format if the variable
  2711. `org-display-custom-times' is set. Time like %H:%M should be at the
  2712. end of the second format. The custom formats are also honored by export
  2713. commands, if custom time display is turned on at the time of export."
  2714. :group 'org-time
  2715. :type 'sexp)
  2716. (defun org-time-stamp-format (&optional long inactive)
  2717. "Get the right format for a time string."
  2718. (let ((f (if long (cdr org-time-stamp-formats)
  2719. (car org-time-stamp-formats))))
  2720. (if inactive
  2721. (concat "[" (substring f 1 -1) "]")
  2722. f)))
  2723. (defcustom org-time-clocksum-format
  2724. '(:days "%dd " :hours "%d" :require-hours t :minutes ":%02d" :require-minutes t)
  2725. "The format string used when creating CLOCKSUM lines.
  2726. This is also used when Org mode generates a time duration.
  2727. The value can be a single format string containing two
  2728. %-sequences, which will be filled with the number of hours and
  2729. minutes in that order.
  2730. Alternatively, the value can be a plist associating any of the
  2731. keys :years, :months, :weeks, :days, :hours or :minutes with
  2732. format strings. The time duration is formatted using only the
  2733. time components that are needed and concatenating the results.
  2734. If a time unit in absent, it falls back to the next smallest
  2735. unit.
  2736. The keys :require-years, :require-months, :require-days,
  2737. :require-weeks, :require-hours, :require-minutes are also
  2738. meaningful. A non-nil value for these keys indicates that the
  2739. corresponding time component should always be included, even if
  2740. its value is 0.
  2741. For example,
  2742. \(:days \"%dd\" :hours \"%d\" :require-hours t :minutes \":%02d\"
  2743. :require-minutes t)
  2744. means durations longer than a day will be expressed in days,
  2745. hours and minutes, and durations less than a day will always be
  2746. expressed in hours and minutes (even for durations less than an
  2747. hour).
  2748. The value
  2749. \(:days \"%dd\" :minutes \"%dm\")
  2750. means durations longer than a day will be expressed in days and
  2751. minutes, and durations less than a day will be expressed entirely
  2752. in minutes (even for durations longer than an hour)."
  2753. :group 'org-time
  2754. :group 'org-clock
  2755. :version "24.4"
  2756. :package-version '(Org . "8.0")
  2757. :type '(choice (string :tag "Format string")
  2758. (set :tag "Plist"
  2759. (group :inline t (const :tag "Years" :years)
  2760. (string :tag "Format string"))
  2761. (group :inline t
  2762. (const :tag "Always show years" :require-years)
  2763. (const t))
  2764. (group :inline t (const :tag "Months" :months)
  2765. (string :tag "Format string"))
  2766. (group :inline t
  2767. (const :tag "Always show months" :require-months)
  2768. (const t))
  2769. (group :inline t (const :tag "Weeks" :weeks)
  2770. (string :tag "Format string"))
  2771. (group :inline t
  2772. (const :tag "Always show weeks" :require-weeks)
  2773. (const t))
  2774. (group :inline t (const :tag "Days" :days)
  2775. (string :tag "Format string"))
  2776. (group :inline t
  2777. (const :tag "Always show days" :require-days)
  2778. (const t))
  2779. (group :inline t (const :tag "Hours" :hours)
  2780. (string :tag "Format string"))
  2781. (group :inline t
  2782. (const :tag "Always show hours" :require-hours)
  2783. (const t))
  2784. (group :inline t (const :tag "Minutes" :minutes)
  2785. (string :tag "Format string"))
  2786. (group :inline t
  2787. (const :tag "Always show minutes" :require-minutes)
  2788. (const t)))))
  2789. (defcustom org-time-clocksum-use-fractional nil
  2790. "When non-nil, \\[org-clock-display] uses fractional times.
  2791. See `org-time-clocksum-format' for more on time clock formats."
  2792. :group 'org-time
  2793. :group 'org-clock
  2794. :version "24.3"
  2795. :type 'boolean)
  2796. (defcustom org-time-clocksum-use-effort-durations nil
  2797. "When non-nil, \\[org-clock-display] uses effort durations.
  2798. E.g. by default, one day is considered to be a 8 hours effort,
  2799. so a task that has been clocked for 16 hours will be displayed
  2800. as during 2 days in the clock display or in the clocktable.
  2801. See `org-effort-durations' on how to set effort durations
  2802. and `org-time-clocksum-format' for more on time clock formats."
  2803. :group 'org-time
  2804. :group 'org-clock
  2805. :version "24.4"
  2806. :package-version '(Org . "8.0")
  2807. :type 'boolean)
  2808. (defcustom org-time-clocksum-fractional-format "%.2f"
  2809. "The format string used when creating CLOCKSUM lines,
  2810. or when Org mode generates a time duration, if
  2811. `org-time-clocksum-use-fractional' is enabled.
  2812. The value can be a single format string containing one
  2813. %-sequence, which will be filled with the number of hours as
  2814. a float.
  2815. Alternatively, the value can be a plist associating any of the
  2816. keys :years, :months, :weeks, :days, :hours or :minutes with
  2817. a format string. The time duration is formatted using the
  2818. largest time unit which gives a non-zero integer part. If all
  2819. specified formats have zero integer part, the smallest time unit
  2820. is used."
  2821. :group 'org-time
  2822. :type '(choice (string :tag "Format string")
  2823. (set (group :inline t (const :tag "Years" :years)
  2824. (string :tag "Format string"))
  2825. (group :inline t (const :tag "Months" :months)
  2826. (string :tag "Format string"))
  2827. (group :inline t (const :tag "Weeks" :weeks)
  2828. (string :tag "Format string"))
  2829. (group :inline t (const :tag "Days" :days)
  2830. (string :tag "Format string"))
  2831. (group :inline t (const :tag "Hours" :hours)
  2832. (string :tag "Format string"))
  2833. (group :inline t (const :tag "Minutes" :minutes)
  2834. (string :tag "Format string")))))
  2835. (defcustom org-deadline-warning-days 14
  2836. "Number of days before expiration during which a deadline becomes active.
  2837. This variable governs the display in sparse trees and in the agenda.
  2838. When 0 or negative, it means use this number (the absolute value of it)
  2839. even if a deadline has a different individual lead time specified.
  2840. Custom commands can set this variable in the options section."
  2841. :group 'org-time
  2842. :group 'org-agenda-daily/weekly
  2843. :type 'integer)
  2844. (defcustom org-scheduled-delay-days 0
  2845. "Number of days before a scheduled item becomes active.
  2846. This variable governs the display in sparse trees and in the agenda.
  2847. The default value (i.e. 0) means: don't delay scheduled item.
  2848. When negative, it means use this number (the absolute value of it)
  2849. even if a scheduled item has a different individual delay time
  2850. specified.
  2851. Custom commands can set this variable in the options section."
  2852. :group 'org-time
  2853. :group 'org-agenda-daily/weekly
  2854. :version "24.4"
  2855. :package-version '(Org . "8.0")
  2856. :type 'integer)
  2857. (defcustom org-read-date-prefer-future t
  2858. "Non-nil means assume future for incomplete date input from user.
  2859. This affects the following situations:
  2860. 1. The user gives a month but not a year.
  2861. For example, if it is April and you enter \"feb 2\", this will be read
  2862. as Feb 2, *next* year. \"May 5\", however, will be this year.
  2863. 2. The user gives a day, but no month.
  2864. For example, if today is the 15th, and you enter \"3\", Org-mode will
  2865. read this as the third of *next* month. However, if you enter \"17\",
  2866. it will be considered as *this* month.
  2867. If you set this variable to the symbol `time', then also the following
  2868. will work:
  2869. 3. If the user gives a time.
  2870. If the time is before now, it will be interpreted as tomorrow.
  2871. Currently none of this works for ISO week specifications.
  2872. When this option is nil, the current day, month and year will always be
  2873. used as defaults.
  2874. See also `org-agenda-jump-prefer-future'."
  2875. :group 'org-time
  2876. :type '(choice
  2877. (const :tag "Never" nil)
  2878. (const :tag "Check month and day" t)
  2879. (const :tag "Check month, day, and time" time)))
  2880. (defcustom org-agenda-jump-prefer-future 'org-read-date-prefer-future
  2881. "Should the agenda jump command prefer the future for incomplete dates?
  2882. The default is to do the same as configured in `org-read-date-prefer-future'.
  2883. But you can also set a deviating value here.
  2884. This may t or nil, or the symbol `org-read-date-prefer-future'."
  2885. :group 'org-agenda
  2886. :group 'org-time
  2887. :version "24.1"
  2888. :type '(choice
  2889. (const :tag "Use org-read-date-prefer-future"
  2890. org-read-date-prefer-future)
  2891. (const :tag "Never" nil)
  2892. (const :tag "Always" t)))
  2893. (defcustom org-read-date-force-compatible-dates t
  2894. "Should date/time prompt force dates that are guaranteed to work in Emacs?
  2895. Depending on the system Emacs is running on, certain dates cannot
  2896. be represented with the type used internally to represent time.
  2897. Dates between 1970-1-1 and 2038-1-1 can always be represented
  2898. correctly. Some systems allow for earlier dates, some for later,
  2899. some for both. One way to find out it to insert any date into an
  2900. Org buffer, putting the cursor on the year and hitting S-up and
  2901. S-down to test the range.
  2902. When this variable is set to t, the date/time prompt will not let
  2903. you specify dates outside the 1970-2037 range, so it is certain that
  2904. these dates will work in whatever version of Emacs you are
  2905. running, and also that you can move a file from one Emacs implementation
  2906. to another. WHenever Org is forcing the year for you, it will display
  2907. a message and beep.
  2908. When this variable is nil, Org will check if the date is
  2909. representable in the specific Emacs implementation you are using.
  2910. If not, it will force a year, usually the current year, and beep
  2911. to remind you. Currently this setting is not recommended because
  2912. the likelihood that you will open your Org files in an Emacs that
  2913. has limited date range is not negligible.
  2914. A workaround for this problem is to use diary sexp dates for time
  2915. stamps outside of this range."
  2916. :group 'org-time
  2917. :version "24.1"
  2918. :type 'boolean)
  2919. (defcustom org-read-date-display-live t
  2920. "Non-nil means display current interpretation of date prompt live.
  2921. This display will be in an overlay, in the minibuffer."
  2922. :group 'org-time
  2923. :type 'boolean)
  2924. (defcustom org-read-date-popup-calendar t
  2925. "Non-nil means pop up a calendar when prompting for a date.
  2926. In the calendar, the date can be selected with mouse-1. However, the
  2927. minibuffer will also be active, and you can simply enter the date as well.
  2928. When nil, only the minibuffer will be available."
  2929. :group 'org-time
  2930. :type 'boolean)
  2931. (org-defvaralias 'org-popup-calendar-for-date-prompt
  2932. 'org-read-date-popup-calendar)
  2933. (make-obsolete-variable
  2934. 'org-read-date-minibuffer-setup-hook
  2935. "Set `org-read-date-minibuffer-local-map' instead." "24.4")
  2936. (defcustom org-read-date-minibuffer-setup-hook nil
  2937. "Hook to be used to set up keys for the date/time interface.
  2938. Add key definitions to `minibuffer-local-map', which will be a
  2939. temporary copy.
  2940. WARNING: This option is obsolete, you should use
  2941. `org-read-date-minibuffer-local-map' to set up keys."
  2942. :group 'org-time
  2943. :type 'hook)
  2944. (defcustom org-extend-today-until 0
  2945. "The hour when your day really ends. Must be an integer.
  2946. This has influence for the following applications:
  2947. - When switching the agenda to \"today\". It it is still earlier than
  2948. the time given here, the day recognized as TODAY is actually yesterday.
  2949. - When a date is read from the user and it is still before the time given
  2950. here, the current date and time will be assumed to be yesterday, 23:59.
  2951. Also, timestamps inserted in capture templates follow this rule.
  2952. IMPORTANT: This is a feature whose implementation is and likely will
  2953. remain incomplete. Really, it is only here because past midnight seems to
  2954. be the favorite working time of John Wiegley :-)"
  2955. :group 'org-time
  2956. :type 'integer)
  2957. (defcustom org-use-effective-time nil
  2958. "If non-nil, consider `org-extend-today-until' when creating timestamps.
  2959. For example, if `org-extend-today-until' is 8, and it's 4am, then the
  2960. \"effective time\" of any timestamps between midnight and 8am will be
  2961. 23:59 of the previous day."
  2962. :group 'org-time
  2963. :version "24.1"
  2964. :type 'boolean)
  2965. (defcustom org-use-last-clock-out-time-as-effective-time nil
  2966. "When non-nil, use the last clock out time for `org-todo'.
  2967. Note that this option has precedence over the combined use of
  2968. `org-use-effective-time' and `org-extend-today-until'."
  2969. :group 'org-time
  2970. :version "24.4"
  2971. :package-version '(Org . "8.0")
  2972. :type 'boolean)
  2973. (defcustom org-edit-timestamp-down-means-later nil
  2974. "Non-nil means S-down will increase the time in a time stamp.
  2975. When nil, S-up will increase."
  2976. :group 'org-time
  2977. :type 'boolean)
  2978. (defcustom org-calendar-follow-timestamp-change t
  2979. "Non-nil means make the calendar window follow timestamp changes.
  2980. When a timestamp is modified and the calendar window is visible, it will be
  2981. moved to the new date."
  2982. :group 'org-time
  2983. :type 'boolean)
  2984. (defgroup org-tags nil
  2985. "Options concerning tags in Org-mode."
  2986. :tag "Org Tags"
  2987. :group 'org)
  2988. (defcustom org-tag-alist nil
  2989. "List of tags allowed in Org-mode files.
  2990. When this list is nil, Org-mode will base TAG input on what is already in the
  2991. buffer.
  2992. The value of this variable is an alist, the car of each entry must be a
  2993. keyword as a string, the cdr may be a character that is used to select
  2994. that tag through the fast-tag-selection interface.
  2995. See the manual for details."
  2996. :group 'org-tags
  2997. :type '(repeat
  2998. (choice
  2999. (cons (string :tag "Tag name")
  3000. (character :tag "Access char"))
  3001. (list :tag "Start radio group"
  3002. (const :startgroup)
  3003. (option (string :tag "Group description")))
  3004. (list :tag "Start tag group, non distinct"
  3005. (const :startgrouptag)
  3006. (option (string :tag "Group description")))
  3007. (list :tag "Group tags delimiter"
  3008. (const :grouptags))
  3009. (list :tag "End radio group"
  3010. (const :endgroup)
  3011. (option (string :tag "Group description")))
  3012. (list :tag "End tag group, non distinct"
  3013. (const :endgrouptag)
  3014. (option (string :tag "Group description")))
  3015. (const :tag "New line" (:newline)))))
  3016. (defcustom org-tag-persistent-alist nil
  3017. "List of tags that will always appear in all Org-mode files.
  3018. This is in addition to any in buffer settings or customizations
  3019. of `org-tag-alist'.
  3020. When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
  3021. The value of this variable is an alist, the car of each entry must be a
  3022. keyword as a string, the cdr may be a character that is used to select
  3023. that tag through the fast-tag-selection interface.
  3024. See the manual for details.
  3025. To disable these tags on a per-file basis, insert anywhere in the file:
  3026. #+STARTUP: noptag"
  3027. :group 'org-tags
  3028. :type '(repeat
  3029. (choice
  3030. (cons (string :tag "Tag name")
  3031. (character :tag "Access char"))
  3032. (const :tag "Start radio group" (:startgroup))
  3033. (const :tag "Group tags delimiter" (:grouptags))
  3034. (const :tag "End radio group" (:endgroup))
  3035. (const :tag "New line" (:newline)))))
  3036. (defcustom org-complete-tags-always-offer-all-agenda-tags nil
  3037. "If non-nil, always offer completion for all tags of all agenda files.
  3038. Instead of customizing this variable directly, you might want to
  3039. set it locally for capture buffers, because there no list of
  3040. tags in that file can be created dynamically (there are none).
  3041. (add-hook 'org-capture-mode-hook
  3042. (lambda ()
  3043. (set (make-local-variable
  3044. 'org-complete-tags-always-offer-all-agenda-tags)
  3045. t)))"
  3046. :group 'org-tags
  3047. :version "24.1"
  3048. :type 'boolean)
  3049. (defvar org-file-tags nil
  3050. "List of tags that can be inherited by all entries in the file.
  3051. The tags will be inherited if the variable `org-use-tag-inheritance'
  3052. says they should be.
  3053. This variable is populated from #+FILETAGS lines.")
  3054. (defcustom org-use-fast-tag-selection 'auto
  3055. "Non-nil means use fast tag selection scheme.
  3056. This is a special interface to select and deselect tags with single keys.
  3057. When nil, fast selection is never used.
  3058. When the symbol `auto', fast selection is used if and only if selection
  3059. characters for tags have been configured, either through the variable
  3060. `org-tag-alist' or through a #+TAGS line in the buffer.
  3061. When t, fast selection is always used and selection keys are assigned
  3062. automatically if necessary."
  3063. :group 'org-tags
  3064. :type '(choice
  3065. (const :tag "Always" t)
  3066. (const :tag "Never" nil)
  3067. (const :tag "When selection characters are configured" auto)))
  3068. (defcustom org-fast-tag-selection-single-key nil
  3069. "Non-nil means fast tag selection exits after first change.
  3070. When nil, you have to press RET to exit it.
  3071. During fast tag selection, you can toggle this flag with `C-c'.
  3072. This variable can also have the value `expert'. In this case, the window
  3073. displaying the tags menu is not even shown, until you press C-c again."
  3074. :group 'org-tags
  3075. :type '(choice
  3076. (const :tag "No" nil)
  3077. (const :tag "Yes" t)
  3078. (const :tag "Expert" expert)))
  3079. (defvar org-fast-tag-selection-include-todo nil
  3080. "Non-nil means fast tags selection interface will also offer TODO states.
  3081. This is an undocumented feature, you should not rely on it.")
  3082. (defcustom org-tags-column (if (featurep 'xemacs) -76 -77)
  3083. "The column to which tags should be indented in a headline.
  3084. If this number is positive, it specifies the column. If it is negative,
  3085. it means that the tags should be flushright to that column. For example,
  3086. -80 works well for a normal 80 character screen.
  3087. When 0, place tags directly after headline text, with only one space in
  3088. between."
  3089. :group 'org-tags
  3090. :type 'integer)
  3091. (defcustom org-auto-align-tags t
  3092. "Non-nil keeps tags aligned when modifying headlines.
  3093. Some operations (i.e. demoting) change the length of a headline and
  3094. therefore shift the tags around. With this option turned on, after
  3095. each such operation the tags are again aligned to `org-tags-column'."
  3096. :group 'org-tags
  3097. :type 'boolean)
  3098. (defcustom org-use-tag-inheritance t
  3099. "Non-nil means tags in levels apply also for sublevels.
  3100. When nil, only the tags directly given in a specific line apply there.
  3101. This may also be a list of tags that should be inherited, or a regexp that
  3102. matches tags that should be inherited. Additional control is possible
  3103. with the variable `org-tags-exclude-from-inheritance' which gives an
  3104. explicit list of tags to be excluded from inheritance, even if the value of
  3105. `org-use-tag-inheritance' would select it for inheritance.
  3106. If this option is t, a match early-on in a tree can lead to a large
  3107. number of matches in the subtree when constructing the agenda or creating
  3108. a sparse tree. If you only want to see the first match in a tree during
  3109. a search, check out the variable `org-tags-match-list-sublevels'."
  3110. :group 'org-tags
  3111. :type '(choice
  3112. (const :tag "Not" nil)
  3113. (const :tag "Always" t)
  3114. (repeat :tag "Specific tags" (string :tag "Tag"))
  3115. (regexp :tag "Tags matched by regexp")))
  3116. (defcustom org-tags-exclude-from-inheritance nil
  3117. "List of tags that should never be inherited.
  3118. This is a way to exclude a few tags from inheritance. For way to do
  3119. the opposite, to actively allow inheritance for selected tags,
  3120. see the variable `org-use-tag-inheritance'."
  3121. :group 'org-tags
  3122. :type '(repeat (string :tag "Tag")))
  3123. (defun org-tag-inherit-p (tag)
  3124. "Check if TAG is one that should be inherited."
  3125. (cond
  3126. ((member tag org-tags-exclude-from-inheritance) nil)
  3127. ((eq org-use-tag-inheritance t) t)
  3128. ((not org-use-tag-inheritance) nil)
  3129. ((stringp org-use-tag-inheritance)
  3130. (string-match org-use-tag-inheritance tag))
  3131. ((listp org-use-tag-inheritance)
  3132. (member tag org-use-tag-inheritance))
  3133. (t (error "Invalid setting of `org-use-tag-inheritance'"))))
  3134. (defcustom org-tags-match-list-sublevels t
  3135. "Non-nil means list also sublevels of headlines matching a search.
  3136. This variable applies to tags/property searches, and also to stuck
  3137. projects because this search is based on a tags match as well.
  3138. When set to the symbol `indented', sublevels are indented with
  3139. leading dots.
  3140. Because of tag inheritance (see variable `org-use-tag-inheritance'),
  3141. the sublevels of a headline matching a tag search often also match
  3142. the same search. Listing all of them can create very long lists.
  3143. Setting this variable to nil causes subtrees of a match to be skipped.
  3144. This variable is semi-obsolete and probably should always be true. It
  3145. is better to limit inheritance to certain tags using the variables
  3146. `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
  3147. :group 'org-tags
  3148. :type '(choice
  3149. (const :tag "No, don't list them" nil)
  3150. (const :tag "Yes, do list them" t)
  3151. (const :tag "List them, indented with leading dots" indented)))
  3152. (defcustom org-tags-sort-function nil
  3153. "When set, tags are sorted using this function as a comparator."
  3154. :group 'org-tags
  3155. :type '(choice
  3156. (const :tag "No sorting" nil)
  3157. (const :tag "Alphabetical" string<)
  3158. (const :tag "Reverse alphabetical" string>)
  3159. (function :tag "Custom function" nil)))
  3160. (defvar org-tags-history nil
  3161. "History of minibuffer reads for tags.")
  3162. (defvar org-last-tags-completion-table nil
  3163. "The last used completion table for tags.")
  3164. (defvar org-after-tags-change-hook nil
  3165. "Hook that is run after the tags in a line have changed.")
  3166. (defgroup org-properties nil
  3167. "Options concerning properties in Org-mode."
  3168. :tag "Org Properties"
  3169. :group 'org)
  3170. (defcustom org-property-format "%-10s %s"
  3171. "How property key/value pairs should be formatted by `indent-line'.
  3172. When `indent-line' hits a property definition, it will format the line
  3173. according to this format, mainly to make sure that the values are
  3174. lined-up with respect to each other."
  3175. :group 'org-properties
  3176. :type 'string)
  3177. (defcustom org-properties-postprocess-alist nil
  3178. "Alist of properties and functions to adjust inserted values.
  3179. Elements of this alist must be of the form
  3180. ([string] [function])
  3181. where [string] must be a property name and [function] must be a
  3182. lambda expression: this lambda expression must take one argument,
  3183. the value to adjust, and return the new value as a string.
  3184. For example, this element will allow the property \"Remaining\"
  3185. to be updated wrt the relation between the \"Effort\" property
  3186. and the clock summary:
  3187. ((\"Remaining\" (lambda(value)
  3188. (let ((clocksum (org-clock-sum-current-item))
  3189. (effort (org-duration-string-to-minutes
  3190. (org-entry-get (point) \"Effort\"))))
  3191. (org-minutes-to-clocksum-string (- effort clocksum))))))"
  3192. :group 'org-properties
  3193. :version "24.1"
  3194. :type '(alist :key-type (string :tag "Property")
  3195. :value-type (function :tag "Function")))
  3196. (defcustom org-use-property-inheritance nil
  3197. "Non-nil means properties apply also for sublevels.
  3198. This setting is chiefly used during property searches. Turning it on can
  3199. cause significant overhead when doing a search, which is why it is not
  3200. on by default.
  3201. When nil, only the properties directly given in the current entry count.
  3202. When t, every property is inherited. The value may also be a list of
  3203. properties that should have inheritance, or a regular expression matching
  3204. properties that should be inherited.
  3205. However, note that some special properties use inheritance under special
  3206. circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
  3207. and the properties ending in \"_ALL\" when they are used as descriptor
  3208. for valid values of a property.
  3209. Note for programmers:
  3210. When querying an entry with `org-entry-get', you can control if inheritance
  3211. should be used. By default, `org-entry-get' looks only at the local
  3212. properties. You can request inheritance by setting the inherit argument
  3213. to t (to force inheritance) or to `selective' (to respect the setting
  3214. in this variable)."
  3215. :group 'org-properties
  3216. :type '(choice
  3217. (const :tag "Not" nil)
  3218. (const :tag "Always" t)
  3219. (repeat :tag "Specific properties" (string :tag "Property"))
  3220. (regexp :tag "Properties matched by regexp")))
  3221. (defun org-property-inherit-p (property)
  3222. "Check if PROPERTY is one that should be inherited."
  3223. (cond
  3224. ((eq org-use-property-inheritance t) t)
  3225. ((not org-use-property-inheritance) nil)
  3226. ((stringp org-use-property-inheritance)
  3227. (string-match org-use-property-inheritance property))
  3228. ((listp org-use-property-inheritance)
  3229. (member property org-use-property-inheritance))
  3230. (t (error "Invalid setting of `org-use-property-inheritance'"))))
  3231. (defcustom org-columns-default-format "%25ITEM %TODO %3PRIORITY %TAGS"
  3232. "The default column format, if no other format has been defined.
  3233. This variable can be set on the per-file basis by inserting a line
  3234. #+COLUMNS: %25ITEM ....."
  3235. :group 'org-properties
  3236. :type 'string)
  3237. (defcustom org-columns-ellipses ".."
  3238. "The ellipses to be used when a field in column view is truncated.
  3239. When this is the empty string, as many characters as possible are shown,
  3240. but then there will be no visual indication that the field has been truncated.
  3241. When this is a string of length N, the last N characters of a truncated
  3242. field are replaced by this string. If the column is narrower than the
  3243. ellipses string, only part of the ellipses string will be shown."
  3244. :group 'org-properties
  3245. :type 'string)
  3246. (defcustom org-columns-modify-value-for-display-function nil
  3247. "Function that modifies values for display in column view.
  3248. For example, it can be used to cut out a certain part from a time stamp.
  3249. The function must take 2 arguments:
  3250. column-title The title of the column (*not* the property name)
  3251. value The value that should be modified.
  3252. The function should return the value that should be displayed,
  3253. or nil if the normal value should be used."
  3254. :group 'org-properties
  3255. :type '(choice (const nil) (function)))
  3256. (defconst org-global-properties-fixed
  3257. '(("VISIBILITY_ALL" . "folded children content all")
  3258. ("CLOCK_MODELINE_TOTAL_ALL" . "current today repeat all auto"))
  3259. "List of property/value pairs that can be inherited by any entry.
  3260. These are fixed values, for the preset properties. The user variable
  3261. that can be used to add to this list is `org-global-properties'.
  3262. The entries in this list are cons cells where the car is a property
  3263. name and cdr is a string with the value. If the value represents
  3264. multiple items like an \"_ALL\" property, separate the items by
  3265. spaces.")
  3266. (defcustom org-global-properties nil
  3267. "List of property/value pairs that can be inherited by any entry.
  3268. This list will be combined with the constant `org-global-properties-fixed'.
  3269. The entries in this list are cons cells where the car is a property
  3270. name and cdr is a string with the value.
  3271. You can set buffer-local values for the same purpose in the variable
  3272. `org-file-properties' this by adding lines like
  3273. #+PROPERTY: NAME VALUE"
  3274. :group 'org-properties
  3275. :type '(repeat
  3276. (cons (string :tag "Property")
  3277. (string :tag "Value"))))
  3278. (defvar org-file-properties nil
  3279. "List of property/value pairs that can be inherited by any entry.
  3280. Valid for the current buffer.
  3281. This variable is populated from #+PROPERTY lines.")
  3282. (make-variable-buffer-local 'org-file-properties)
  3283. (defgroup org-agenda nil
  3284. "Options concerning agenda views in Org-mode."
  3285. :tag "Org Agenda"
  3286. :group 'org)
  3287. (defvar org-category nil
  3288. "Variable used by org files to set a category for agenda display.
  3289. Such files should use a file variable to set it, for example
  3290. # -*- mode: org; org-category: \"ELisp\"
  3291. or contain a special line
  3292. #+CATEGORY: ELisp
  3293. If the file does not specify a category, then file's base name
  3294. is used instead.")
  3295. (make-variable-buffer-local 'org-category)
  3296. (put 'org-category 'safe-local-variable (lambda (x) (or (symbolp x) (stringp x))))
  3297. (defcustom org-agenda-files nil
  3298. "The files to be used for agenda display.
  3299. Entries may be added to this list with \\[org-agenda-file-to-front] and removed with
  3300. \\[org-remove-file]. You can also use customize to edit the list.
  3301. If an entry is a directory, all files in that directory that are matched by
  3302. `org-agenda-file-regexp' will be part of the file list.
  3303. If the value of the variable is not a list but a single file name, then
  3304. the list of agenda files is actually stored and maintained in that file, one
  3305. agenda file per line. In this file paths can be given relative to
  3306. `org-directory'. Tilde expansion and environment variable substitution
  3307. are also made."
  3308. :group 'org-agenda
  3309. :type '(choice
  3310. (repeat :tag "List of files and directories" file)
  3311. (file :tag "Store list in a file\n" :value "~/.agenda_files")))
  3312. (defcustom org-agenda-file-regexp "\\`[^.].*\\.org\\'"
  3313. "Regular expression to match files for `org-agenda-files'.
  3314. If any element in the list in that variable contains a directory instead
  3315. of a normal file, all files in that directory that are matched by this
  3316. regular expression will be included."
  3317. :group 'org-agenda
  3318. :type 'regexp)
  3319. (defcustom org-agenda-text-search-extra-files nil
  3320. "List of extra files to be searched by text search commands.
  3321. These files will be searched in addition to the agenda files by the
  3322. commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
  3323. Note that these files will only be searched for text search commands,
  3324. not for the other agenda views like todo lists, tag searches or the weekly
  3325. agenda. This variable is intended to list notes and possibly archive files
  3326. that should also be searched by these two commands.
  3327. In fact, if the first element in the list is the symbol `agenda-archives',
  3328. then all archive files of all agenda files will be added to the search
  3329. scope."
  3330. :group 'org-agenda
  3331. :type '(set :greedy t
  3332. (const :tag "Agenda Archives" agenda-archives)
  3333. (repeat :inline t (file))))
  3334. (org-defvaralias 'org-agenda-multi-occur-extra-files
  3335. 'org-agenda-text-search-extra-files)
  3336. (defcustom org-agenda-skip-unavailable-files nil
  3337. "Non-nil means to just skip non-reachable files in `org-agenda-files'.
  3338. A nil value means to remove them, after a query, from the list."
  3339. :group 'org-agenda
  3340. :type 'boolean)
  3341. (defcustom org-calendar-to-agenda-key [?c]
  3342. "The key to be installed in `calendar-mode-map' for switching to the agenda.
  3343. The command `org-calendar-goto-agenda' will be bound to this key. The
  3344. default is the character `c' because then `c' can be used to switch back and
  3345. forth between agenda and calendar."
  3346. :group 'org-agenda
  3347. :type 'sexp)
  3348. (defcustom org-calendar-insert-diary-entry-key [?i]
  3349. "The key to be installed in `calendar-mode-map' for adding diary entries.
  3350. This option is irrelevant until `org-agenda-diary-file' has been configured
  3351. to point to an Org-mode file. When that is the case, the command
  3352. `org-agenda-diary-entry' will be bound to the key given here, by default
  3353. `i'. In the calendar, `i' normally adds entries to `diary-file'. So
  3354. if you want to continue doing this, you need to change this to a different
  3355. key."
  3356. :group 'org-agenda
  3357. :type 'sexp)
  3358. (defcustom org-agenda-diary-file 'diary-file
  3359. "File to which to add new entries with the `i' key in agenda and calendar.
  3360. When this is the symbol `diary-file', the functionality in the Emacs
  3361. calendar will be used to add entries to the `diary-file'. But when this
  3362. points to a file, `org-agenda-diary-entry' will be used instead."
  3363. :group 'org-agenda
  3364. :type '(choice
  3365. (const :tag "The standard Emacs diary file" diary-file)
  3366. (file :tag "Special Org file diary entries")))
  3367. (eval-after-load "calendar"
  3368. '(progn
  3369. (org-defkey calendar-mode-map org-calendar-to-agenda-key
  3370. 'org-calendar-goto-agenda)
  3371. (add-hook 'calendar-mode-hook
  3372. (lambda ()
  3373. (unless (eq org-agenda-diary-file 'diary-file)
  3374. (define-key calendar-mode-map
  3375. org-calendar-insert-diary-entry-key
  3376. 'org-agenda-diary-entry))))))
  3377. (defgroup org-latex nil
  3378. "Options for embedding LaTeX code into Org-mode."
  3379. :tag "Org LaTeX"
  3380. :group 'org)
  3381. (defcustom org-format-latex-options
  3382. '(:foreground default :background default :scale 1.0
  3383. :html-foreground "Black" :html-background "Transparent"
  3384. :html-scale 1.0 :matchers ("begin" "$1" "$" "$$" "\\(" "\\["))
  3385. "Options for creating images from LaTeX fragments.
  3386. This is a property list with the following properties:
  3387. :foreground the foreground color for images embedded in Emacs, e.g. \"Black\".
  3388. `default' means use the foreground of the default face.
  3389. `auto' means use the foreground from the text face.
  3390. :background the background color, or \"Transparent\".
  3391. `default' means use the background of the default face.
  3392. `auto' means use the background from the text face.
  3393. :scale a scaling factor for the size of the images, to get more pixels
  3394. :html-foreground, :html-background, :html-scale
  3395. the same numbers for HTML export.
  3396. :matchers a list indicating which matchers should be used to
  3397. find LaTeX fragments. Valid members of this list are:
  3398. \"begin\" find environments
  3399. \"$1\" find single characters surrounded by $.$
  3400. \"$\" find math expressions surrounded by $...$
  3401. \"$$\" find math expressions surrounded by $$....$$
  3402. \"\\(\" find math expressions surrounded by \\(...\\)
  3403. \"\\=\\[\" find math expressions surrounded by \\=\\[...\\]"
  3404. :group 'org-latex
  3405. :type 'plist)
  3406. (defcustom org-format-latex-signal-error t
  3407. "Non-nil means signal an error when image creation of LaTeX snippets fails.
  3408. When nil, just push out a message."
  3409. :group 'org-latex
  3410. :version "24.1"
  3411. :type 'boolean)
  3412. (defcustom org-latex-to-mathml-jar-file nil
  3413. "Value of\"%j\" in `org-latex-to-mathml-convert-command'.
  3414. Use this to specify additional executable file say a jar file.
  3415. When using MathToWeb as the converter, specify the full-path to
  3416. your mathtoweb.jar file."
  3417. :group 'org-latex
  3418. :version "24.1"
  3419. :type '(choice
  3420. (const :tag "None" nil)
  3421. (file :tag "JAR file" :must-match t)))
  3422. (defcustom org-latex-to-mathml-convert-command nil
  3423. "Command to convert LaTeX fragments to MathML.
  3424. Replace format-specifiers in the command as noted below and use
  3425. `shell-command' to convert LaTeX to MathML.
  3426. %j: Executable file in fully expanded form as specified by
  3427. `org-latex-to-mathml-jar-file'.
  3428. %I: Input LaTeX file in fully expanded form.
  3429. %i: The latex fragment to be converted.
  3430. %o: Output MathML file.
  3431. This command is used by `org-create-math-formula'.
  3432. When using MathToWeb as the converter, set this to
  3433. \"java -jar %j -unicode -force -df %o %I\".
  3434. When using LaTeXML set this to
  3435. \"latexmlmath \"%i\" --presentationmathml=%o\"."
  3436. :group 'org-latex
  3437. :version "24.1"
  3438. :type '(choice
  3439. (const :tag "None" nil)
  3440. (string :tag "\nShell command")))
  3441. (defcustom org-latex-create-formula-image-program 'dvipng
  3442. "Program to convert LaTeX fragments with.
  3443. dvipng Process the LaTeX fragments to dvi file, then convert
  3444. dvi files to png files using dvipng.
  3445. This will also include processing of non-math environments.
  3446. imagemagick Convert the LaTeX fragments to pdf files and use imagemagick
  3447. to convert pdf files to png files"
  3448. :group 'org-latex
  3449. :version "24.1"
  3450. :type '(choice
  3451. (const :tag "dvipng" dvipng)
  3452. (const :tag "imagemagick" imagemagick)))
  3453. (defcustom org-latex-preview-ltxpng-directory "ltxpng/"
  3454. "Path to store latex preview images.
  3455. A relative path here creates many directories relative to the
  3456. processed org files paths. An absolute path puts all preview
  3457. images at the same place."
  3458. :group 'org-latex
  3459. :version "24.3"
  3460. :type 'string)
  3461. (defun org-format-latex-mathml-available-p ()
  3462. "Return t if `org-latex-to-mathml-convert-command' is usable."
  3463. (save-match-data
  3464. (when (and (boundp 'org-latex-to-mathml-convert-command)
  3465. org-latex-to-mathml-convert-command)
  3466. (let ((executable (car (split-string
  3467. org-latex-to-mathml-convert-command))))
  3468. (when (executable-find executable)
  3469. (if (string-match
  3470. "%j" org-latex-to-mathml-convert-command)
  3471. (file-readable-p org-latex-to-mathml-jar-file)
  3472. t))))))
  3473. (defcustom org-format-latex-header "\\documentclass{article}
  3474. \\usepackage[usenames]{color}
  3475. \[PACKAGES]
  3476. \[DEFAULT-PACKAGES]
  3477. \\pagestyle{empty} % do not remove
  3478. % The settings below are copied from fullpage.sty
  3479. \\setlength{\\textwidth}{\\paperwidth}
  3480. \\addtolength{\\textwidth}{-3cm}
  3481. \\setlength{\\oddsidemargin}{1.5cm}
  3482. \\addtolength{\\oddsidemargin}{-2.54cm}
  3483. \\setlength{\\evensidemargin}{\\oddsidemargin}
  3484. \\setlength{\\textheight}{\\paperheight}
  3485. \\addtolength{\\textheight}{-\\headheight}
  3486. \\addtolength{\\textheight}{-\\headsep}
  3487. \\addtolength{\\textheight}{-\\footskip}
  3488. \\addtolength{\\textheight}{-3cm}
  3489. \\setlength{\\topmargin}{1.5cm}
  3490. \\addtolength{\\topmargin}{-2.54cm}"
  3491. "The document header used for processing LaTeX fragments.
  3492. It is imperative that this header make sure that no page number
  3493. appears on the page. The package defined in the variables
  3494. `org-latex-default-packages-alist' and `org-latex-packages-alist'
  3495. will either replace the placeholder \"[PACKAGES]\" in this
  3496. header, or they will be appended."
  3497. :group 'org-latex
  3498. :type 'string)
  3499. (defun org-set-packages-alist (var val)
  3500. "Set the packages alist and make sure it has 3 elements per entry."
  3501. (set var (mapcar (lambda (x)
  3502. (if (and (consp x) (= (length x) 2))
  3503. (list (car x) (nth 1 x) t)
  3504. x))
  3505. val)))
  3506. (defun org-get-packages-alist (var)
  3507. "Get the packages alist and make sure it has 3 elements per entry."
  3508. (mapcar (lambda (x)
  3509. (if (and (consp x) (= (length x) 2))
  3510. (list (car x) (nth 1 x) t)
  3511. x))
  3512. (default-value var)))
  3513. (defcustom org-latex-default-packages-alist
  3514. '(("AUTO" "inputenc" t)
  3515. ("T1" "fontenc" t)
  3516. ("" "fixltx2e" nil)
  3517. ("" "graphicx" t)
  3518. ("" "grffile" t)
  3519. ("" "longtable" nil)
  3520. ("" "float" nil)
  3521. ("" "wrapfig" nil)
  3522. ("" "rotating" nil)
  3523. ("normalem" "ulem" t)
  3524. ("" "amsmath" t)
  3525. ("" "textcomp" t)
  3526. ("" "marvosym" t)
  3527. ("" "wasysym" t)
  3528. ("" "amssymb" t)
  3529. ("" "capt-of" nil)
  3530. ("" "hyperref" nil)
  3531. "\\tolerance=1000")
  3532. "Alist of default packages to be inserted in the header.
  3533. Change this only if one of the packages here causes an
  3534. incompatibility with another package you are using.
  3535. The packages in this list are needed by one part or another of
  3536. Org mode to function properly:
  3537. - inputenc, fontenc: for basic font and character selection
  3538. - fixltx2e: Important patches of LaTeX itself
  3539. - graphicx: for including images
  3540. - grffile: allow periods and spaces in graphics file names
  3541. - longtable: For multipage tables
  3542. - float, wrapfig: for figure placement
  3543. - rotating: for sideways figures and tables
  3544. - ulem: for underline and strike-through
  3545. - amsmath: for subscript and superscript and math environments
  3546. - textcomp, marvosymb, wasysym, amssymb: for various symbols used
  3547. for interpreting the entities in `org-entities'. You can skip
  3548. some of these packages if you don't use any of their symbols.
  3549. - capt-of: for captions outside of floats
  3550. - hyperref: for cross references
  3551. Therefore you should not modify this variable unless you know
  3552. what you are doing. The one reason to change it anyway is that
  3553. you might be loading some other package that conflicts with one
  3554. of the default packages. Each element is either a cell or
  3555. a string.
  3556. A cell is of the format:
  3557. \( \"options\" \"package\" SNIPPET-FLAG).
  3558. If SNIPPET-FLAG is non-nil, the package also needs to be included
  3559. when compiling LaTeX snippets into images for inclusion into
  3560. non-LaTeX output.
  3561. A string will be inserted as-is in the header of the document."
  3562. :group 'org-latex
  3563. :group 'org-export-latex
  3564. :set 'org-set-packages-alist
  3565. :get 'org-get-packages-alist
  3566. :version "24.1"
  3567. :type '(repeat
  3568. (choice
  3569. (list :tag "options/package pair"
  3570. (string :tag "options")
  3571. (string :tag "package")
  3572. (boolean :tag "Snippet"))
  3573. (string :tag "A line of LaTeX"))))
  3574. (defcustom org-latex-packages-alist nil
  3575. "Alist of packages to be inserted in every LaTeX header.
  3576. These will be inserted after `org-latex-default-packages-alist'.
  3577. Each element is either a cell or a string.
  3578. A cell is of the format:
  3579. \(\"options\" \"package\" SNIPPET-FLAG)
  3580. SNIPPET-FLAG, when non-nil, indicates that this package is also
  3581. needed when turning LaTeX snippets into images for inclusion into
  3582. non-LaTeX output.
  3583. A string will be inserted as-is in the header of the document.
  3584. Make sure that you only list packages here which:
  3585. - you want in every file;
  3586. - do not conflict with the setup in `org-format-latex-header';
  3587. - do not conflict with the default packages in
  3588. `org-latex-default-packages-alist'."
  3589. :group 'org-latex
  3590. :group 'org-export-latex
  3591. :set 'org-set-packages-alist
  3592. :get 'org-get-packages-alist
  3593. :type '(repeat
  3594. (choice
  3595. (list :tag "options/package pair"
  3596. (string :tag "options")
  3597. (string :tag "package")
  3598. (boolean :tag "Snippet"))
  3599. (string :tag "A line of LaTeX"))))
  3600. (defgroup org-appearance nil
  3601. "Settings for Org-mode appearance."
  3602. :tag "Org Appearance"
  3603. :group 'org)
  3604. (defcustom org-level-color-stars-only nil
  3605. "Non-nil means fontify only the stars in each headline.
  3606. When nil, the entire headline is fontified.
  3607. Changing it requires restart of `font-lock-mode' to become effective
  3608. also in regions already fontified."
  3609. :group 'org-appearance
  3610. :type 'boolean)
  3611. (defcustom org-hide-leading-stars nil
  3612. "Non-nil means hide the first N-1 stars in a headline.
  3613. This works by using the face `org-hide' for these stars. This
  3614. face is white for a light background, and black for a dark
  3615. background. You may have to customize the face `org-hide' to
  3616. make this work.
  3617. Changing it requires restart of `font-lock-mode' to become effective
  3618. also in regions already fontified.
  3619. You may also set this on a per-file basis by adding one of the following
  3620. lines to the buffer:
  3621. #+STARTUP: hidestars
  3622. #+STARTUP: showstars"
  3623. :group 'org-appearance
  3624. :type 'boolean)
  3625. (defcustom org-hidden-keywords nil
  3626. "List of symbols corresponding to keywords to be hidden the org buffer.
  3627. For example, a value '(title) for this list will make the document's title
  3628. appear in the buffer without the initial #+TITLE: keyword."
  3629. :group 'org-appearance
  3630. :version "24.1"
  3631. :type '(set (const :tag "#+AUTHOR" author)
  3632. (const :tag "#+DATE" date)
  3633. (const :tag "#+EMAIL" email)
  3634. (const :tag "#+TITLE" title)))
  3635. (defcustom org-custom-properties nil
  3636. "List of properties (as strings) with a special meaning.
  3637. The default use of these custom properties is to let the user
  3638. hide them with `org-toggle-custom-properties-visibility'."
  3639. :group 'org-properties
  3640. :group 'org-appearance
  3641. :version "24.3"
  3642. :type '(repeat (string :tag "Property Name")))
  3643. (defcustom org-fontify-done-headline nil
  3644. "Non-nil means change the face of a headline if it is marked DONE.
  3645. Normally, only the TODO/DONE keyword indicates the state of a headline.
  3646. When this is non-nil, the headline after the keyword is set to the
  3647. `org-headline-done' as an additional indication."
  3648. :group 'org-appearance
  3649. :type 'boolean)
  3650. (defcustom org-fontify-emphasized-text t
  3651. "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
  3652. Changing this variable requires a restart of Emacs to take effect."
  3653. :group 'org-appearance
  3654. :type 'boolean)
  3655. (defcustom org-fontify-whole-heading-line nil
  3656. "Non-nil means fontify the whole line for headings.
  3657. This is useful when setting a background color for the
  3658. org-level-* faces."
  3659. :group 'org-appearance
  3660. :type 'boolean)
  3661. (defcustom org-highlight-latex-and-related nil
  3662. "Non-nil means highlight LaTeX related syntax in the buffer.
  3663. When non nil, the value should be a list containing any of the
  3664. following symbols:
  3665. `latex' Highlight LaTeX snippets and environments.
  3666. `script' Highlight subscript and superscript.
  3667. `entities' Highlight entities."
  3668. :group 'org-appearance
  3669. :version "24.4"
  3670. :package-version '(Org . "8.0")
  3671. :type '(choice
  3672. (const :tag "No highlighting" nil)
  3673. (set :greedy t :tag "Highlight"
  3674. (const :tag "LaTeX snippets and environments" latex)
  3675. (const :tag "Subscript and superscript" script)
  3676. (const :tag "Entities" entities))))
  3677. (defcustom org-hide-emphasis-markers nil
  3678. "Non-nil mean font-lock should hide the emphasis marker characters."
  3679. :group 'org-appearance
  3680. :type 'boolean)
  3681. (defcustom org-hide-macro-markers nil
  3682. "Non-nil mean font-lock should hide the brackets marking macro calls."
  3683. :group 'org-appearance
  3684. :type 'boolean)
  3685. (defcustom org-pretty-entities nil
  3686. "Non-nil means show entities as UTF8 characters.
  3687. When nil, the \\name form remains in the buffer."
  3688. :group 'org-appearance
  3689. :version "24.1"
  3690. :type 'boolean)
  3691. (defcustom org-pretty-entities-include-sub-superscripts t
  3692. "Non-nil means, pretty entity display includes formatting sub/superscripts."
  3693. :group 'org-appearance
  3694. :version "24.1"
  3695. :type 'boolean)
  3696. (defvar org-emph-re nil
  3697. "Regular expression for matching emphasis.
  3698. After a match, the match groups contain these elements:
  3699. 0 The match of the full regular expression, including the characters
  3700. before and after the proper match
  3701. 1 The character before the proper match, or empty at beginning of line
  3702. 2 The proper match, including the leading and trailing markers
  3703. 3 The leading marker like * or /, indicating the type of highlighting
  3704. 4 The text between the emphasis markers, not including the markers
  3705. 5 The character after the match, empty at the end of a line")
  3706. (defvar org-verbatim-re nil
  3707. "Regular expression for matching verbatim text.")
  3708. (defvar org-emphasis-regexp-components) ; defined just below
  3709. (defvar org-emphasis-alist) ; defined just below
  3710. (defun org-set-emph-re (var val)
  3711. "Set variable and compute the emphasis regular expression."
  3712. (set var val)
  3713. (when (and (boundp 'org-emphasis-alist)
  3714. (boundp 'org-emphasis-regexp-components)
  3715. org-emphasis-alist org-emphasis-regexp-components)
  3716. (let* ((e org-emphasis-regexp-components)
  3717. (pre (car e))
  3718. (post (nth 1 e))
  3719. (border (nth 2 e))
  3720. (body (nth 3 e))
  3721. (nl (nth 4 e))
  3722. (body1 (concat body "*?"))
  3723. (markers (mapconcat 'car org-emphasis-alist ""))
  3724. (vmarkers (mapconcat
  3725. (lambda (x) (if (eq (nth 2 x) 'verbatim) (car x) ""))
  3726. org-emphasis-alist "")))
  3727. ;; make sure special characters appear at the right position in the class
  3728. (if (string-match "\\^" markers)
  3729. (setq markers (concat (replace-match "" t t markers) "^")))
  3730. (if (string-match "-" markers)
  3731. (setq markers (concat (replace-match "" t t markers) "-")))
  3732. (if (string-match "\\^" vmarkers)
  3733. (setq vmarkers (concat (replace-match "" t t vmarkers) "^")))
  3734. (if (string-match "-" vmarkers)
  3735. (setq vmarkers (concat (replace-match "" t t vmarkers) "-")))
  3736. (if (> nl 0)
  3737. (setq body1 (concat body1 "\\(?:\n" body "*?\\)\\{0,"
  3738. (int-to-string nl) "\\}")))
  3739. ;; Make the regexp
  3740. (setq org-emph-re
  3741. (concat "\\([" pre "]\\|^\\)"
  3742. "\\("
  3743. "\\([" markers "]\\)"
  3744. "\\("
  3745. "[^" border "]\\|"
  3746. "[^" border "]"
  3747. body1
  3748. "[^" border "]"
  3749. "\\)"
  3750. "\\3\\)"
  3751. "\\([" post "]\\|$\\)"))
  3752. (setq org-verbatim-re
  3753. (concat "\\([" pre "]\\|^\\)"
  3754. "\\("
  3755. "\\([" vmarkers "]\\)"
  3756. "\\("
  3757. "[^" border "]\\|"
  3758. "[^" border "]"
  3759. body1
  3760. "[^" border "]"
  3761. "\\)"
  3762. "\\3\\)"
  3763. "\\([" post "]\\|$\\)")))))
  3764. ;; This used to be a defcustom (Org <8.0) but allowing the users to
  3765. ;; set this option proved cumbersome. See this message/thread:
  3766. ;; http://article.gmane.org/gmane.emacs.orgmode/68681
  3767. (defvar org-emphasis-regexp-components
  3768. '(" \t('\"{" "- \t.,:!?;'\")}\\[" " \t\r\n,\"'" "." 1)
  3769. "Components used to build the regular expression for emphasis.
  3770. This is a list with five entries. Terminology: In an emphasis string
  3771. like \" *strong word* \", we call the initial space PREMATCH, the final
  3772. space POSTMATCH, the stars MARKERS, \"s\" and \"d\" are BORDER characters
  3773. and \"trong wor\" is the body. The different components in this variable
  3774. specify what is allowed/forbidden in each part:
  3775. pre Chars allowed as prematch. Beginning of line will be allowed too.
  3776. post Chars allowed as postmatch. End of line will be allowed too.
  3777. border The chars *forbidden* as border characters.
  3778. body-regexp A regexp like \".\" to match a body character. Don't use
  3779. non-shy groups here, and don't allow newline here.
  3780. newline The maximum number of newlines allowed in an emphasis exp.
  3781. You need to reload Org or to restart Emacs after customizing this.")
  3782. (defcustom org-emphasis-alist
  3783. `(("*" bold)
  3784. ("/" italic)
  3785. ("_" underline)
  3786. ("=" org-verbatim verbatim)
  3787. ("~" org-code verbatim)
  3788. ("+" ,(if (featurep 'xemacs) 'org-table '(:strike-through t))))
  3789. "Alist of characters and faces to emphasize text.
  3790. Text starting and ending with a special character will be emphasized,
  3791. for example *bold*, _underlined_ and /italic/. This variable sets the
  3792. marker characters and the face to be used by font-lock for highlighting
  3793. in Org-mode Emacs buffers.
  3794. You need to reload Org or to restart Emacs after customizing this."
  3795. :group 'org-appearance
  3796. :set 'org-set-emph-re
  3797. :version "24.4"
  3798. :package-version '(Org . "8.0")
  3799. :type '(repeat
  3800. (list
  3801. (string :tag "Marker character")
  3802. (choice
  3803. (face :tag "Font-lock-face")
  3804. (plist :tag "Face property list"))
  3805. (option (const verbatim)))))
  3806. (defvar org-protecting-blocks
  3807. '("src" "example" "latex" "ascii" "html" "ditaa" "dot" "r" "R")
  3808. "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
  3809. This is needed for font-lock setup.")
  3810. ;;; Miscellaneous options
  3811. (defgroup org-completion nil
  3812. "Completion in Org-mode."
  3813. :tag "Org Completion"
  3814. :group 'org)
  3815. (defcustom org-completion-use-ido nil
  3816. "Non-nil means use ido completion wherever possible.
  3817. Note that `ido-mode' must be active for this variable to be relevant.
  3818. If you decide to turn this variable on, you might well want to turn off
  3819. `org-outline-path-complete-in-steps'.
  3820. See also `org-completion-use-iswitchb'."
  3821. :group 'org-completion
  3822. :type 'boolean)
  3823. (defcustom org-completion-use-iswitchb nil
  3824. "Non-nil means use iswitchb completion wherever possible.
  3825. Note that `iswitchb-mode' must be active for this variable to be relevant.
  3826. If you decide to turn this variable on, you might well want to turn off
  3827. `org-outline-path-complete-in-steps'.
  3828. Note that this variable has only an effect if `org-completion-use-ido' is nil."
  3829. :group 'org-completion
  3830. :type 'boolean)
  3831. (defcustom org-completion-fallback-command 'hippie-expand
  3832. "The expansion command called by \\[pcomplete] in normal context.
  3833. Normal means, no org-mode-specific context."
  3834. :group 'org-completion
  3835. :type 'function)
  3836. ;;; Functions and variables from their packages
  3837. ;; Declared here to avoid compiler warnings
  3838. ;; XEmacs only
  3839. (defvar outline-mode-menu-heading)
  3840. (defvar outline-mode-menu-show)
  3841. (defvar outline-mode-menu-hide)
  3842. (defvar zmacs-regions) ; XEmacs regions
  3843. ;; Emacs only
  3844. (defvar mark-active)
  3845. ;; Various packages
  3846. (declare-function calendar-iso-to-absolute "cal-iso" (date))
  3847. (declare-function calendar-forward-day "cal-move" (arg))
  3848. (declare-function calendar-goto-date "cal-move" (date))
  3849. (declare-function calendar-goto-today "cal-move" ())
  3850. (declare-function calendar-iso-from-absolute "cal-iso" (date))
  3851. (defvar calc-embedded-close-formula)
  3852. (defvar calc-embedded-open-formula)
  3853. (declare-function cdlatex-tab "ext:cdlatex" ())
  3854. (declare-function cdlatex-compute-tables "ext:cdlatex" ())
  3855. (declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
  3856. (defvar font-lock-unfontify-region-function)
  3857. (declare-function iswitchb-read-buffer "iswitchb"
  3858. (prompt &optional default require-match start matches-set))
  3859. (defvar iswitchb-temp-buflist)
  3860. (declare-function org-gnus-follow-link "org-gnus" (&optional group article))
  3861. (defvar org-agenda-tags-todo-honor-ignore-options)
  3862. (declare-function org-agenda-skip "org-agenda" ())
  3863. (declare-function
  3864. org-agenda-format-item "org-agenda"
  3865. (extra txt &optional level category tags dotime noprefix remove-re habitp))
  3866. (declare-function org-agenda-new-marker "org-agenda" (&optional pos))
  3867. (declare-function org-agenda-change-all-lines "org-agenda"
  3868. (newhead hdmarker &optional fixface just-this))
  3869. (declare-function org-agenda-set-restriction-lock "org-agenda" (&optional type))
  3870. (declare-function org-agenda-maybe-redo "org-agenda" ())
  3871. (declare-function org-agenda-save-markers-for-cut-and-paste "org-agenda"
  3872. (beg end))
  3873. (declare-function org-agenda-copy-local-variable "org-agenda" (var))
  3874. (declare-function org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
  3875. "org-agenda" (&optional end))
  3876. (declare-function org-inlinetask-remove-END-maybe "org-inlinetask" ())
  3877. (declare-function org-inlinetask-in-task-p "org-inlinetask" ())
  3878. (declare-function org-inlinetask-goto-beginning "org-inlinetask" ())
  3879. (declare-function org-inlinetask-goto-end "org-inlinetask" ())
  3880. (declare-function org-indent-mode "org-indent" (&optional arg))
  3881. (declare-function parse-time-string "parse-time" (string))
  3882. (declare-function org-attach-reveal "org-attach" (&optional if-exists))
  3883. (declare-function orgtbl-send-table "org-table" (&optional maybe))
  3884. (defvar remember-data-file)
  3885. (defvar texmathp-why)
  3886. (declare-function speedbar-line-directory "speedbar" (&optional depth))
  3887. (declare-function table--at-cell-p "table" (position &optional object at-column))
  3888. (declare-function calc-eval "calc" (str &optional separator &rest args))
  3889. ;;;###autoload
  3890. (defun turn-on-orgtbl ()
  3891. "Unconditionally turn on `orgtbl-mode'."
  3892. (require 'org-table)
  3893. (orgtbl-mode 1))
  3894. (defun org-at-table-p (&optional table-type)
  3895. "Return t if the cursor is inside an org-type table.
  3896. If TABLE-TYPE is non-nil, also check for table.el-type tables."
  3897. (if org-enable-table-editor
  3898. (save-excursion
  3899. (beginning-of-line 1)
  3900. (looking-at (if table-type org-table-any-line-regexp
  3901. org-table-line-regexp)))
  3902. nil))
  3903. (defsubst org-table-p () (org-at-table-p))
  3904. (defun org-at-table.el-p ()
  3905. "Return t if and only if we are at a table.el table."
  3906. (and (org-at-table-p 'any)
  3907. (save-excursion
  3908. (goto-char (org-table-begin 'any))
  3909. (looking-at org-table1-hline-regexp))))
  3910. (defun org-table-recognize-table.el ()
  3911. "If there is a table.el table nearby, recognize it and move into it."
  3912. (if org-table-tab-recognizes-table.el
  3913. (if (org-at-table.el-p)
  3914. (progn
  3915. (beginning-of-line 1)
  3916. (if (looking-at org-table-dataline-regexp)
  3917. nil
  3918. (if (looking-at org-table1-hline-regexp)
  3919. (progn
  3920. (beginning-of-line 2)
  3921. (if (looking-at org-table-any-border-regexp)
  3922. (beginning-of-line -1)))))
  3923. (if (re-search-forward "|" (org-table-end t) t)
  3924. (progn
  3925. (require 'table)
  3926. (if (table--at-cell-p (point))
  3927. t
  3928. (message "recognizing table.el table...")
  3929. (table-recognize-table)
  3930. (message "recognizing table.el table...done")))
  3931. (error "This should not happen"))
  3932. t)
  3933. nil)
  3934. nil))
  3935. (defun org-at-table-hline-p ()
  3936. "Return t if the cursor is inside a hline in a table."
  3937. (if org-enable-table-editor
  3938. (save-excursion
  3939. (beginning-of-line 1)
  3940. (looking-at org-table-hline-regexp))
  3941. nil))
  3942. (defun org-table-map-tables (function &optional quietly)
  3943. "Apply FUNCTION to the start of all tables in the buffer."
  3944. (save-excursion
  3945. (save-restriction
  3946. (widen)
  3947. (goto-char (point-min))
  3948. (while (re-search-forward org-table-any-line-regexp nil t)
  3949. (unless quietly
  3950. (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size))))
  3951. (beginning-of-line 1)
  3952. (when (and (looking-at org-table-line-regexp)
  3953. ;; Exclude tables in src/example/verbatim/clocktable blocks
  3954. (not (org-in-block-p '("src" "example" "verbatim" "clocktable"))))
  3955. (save-excursion (funcall function))
  3956. (or (looking-at org-table-line-regexp)
  3957. (forward-char 1)))
  3958. (re-search-forward org-table-any-border-regexp nil 1))))
  3959. (unless quietly (message "Mapping tables: done")))
  3960. (declare-function org-clock-save-markers-for-cut-and-paste "org-clock" (beg end))
  3961. (declare-function org-clock-update-mode-line "org-clock" ())
  3962. (declare-function org-resolve-clocks "org-clock"
  3963. (&optional also-non-dangling-p prompt last-valid))
  3964. (defun org-at-TBLFM-p (&optional pos)
  3965. "Non-nil when point (or POS) is in #+TBLFM line."
  3966. (save-excursion
  3967. (goto-char (or pos (point)))
  3968. (beginning-of-line)
  3969. (and (eq (org-element-type (org-element-at-point)) 'table)
  3970. (looking-at org-TBLFM-regexp))))
  3971. (defvar org-clock-start-time)
  3972. (defvar org-clock-marker (make-marker)
  3973. "Marker recording the last clock-in.")
  3974. (defvar org-clock-hd-marker (make-marker)
  3975. "Marker recording the last clock-in, but the headline position.")
  3976. (defvar org-clock-heading ""
  3977. "The heading of the current clock entry.")
  3978. (defun org-clock-is-active ()
  3979. "Return the buffer where the clock is currently running.
  3980. Return nil if no clock is running."
  3981. (marker-buffer org-clock-marker))
  3982. (defun org-check-running-clock ()
  3983. "Check if the current buffer contains the running clock.
  3984. If yes, offer to stop it and to save the buffer with the changes."
  3985. (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
  3986. (y-or-n-p (format "Clock-out in buffer %s before killing it? "
  3987. (buffer-name))))
  3988. (org-clock-out)
  3989. (when (y-or-n-p "Save changed buffer?")
  3990. (save-buffer))))
  3991. (defun org-clocktable-try-shift (dir n)
  3992. "Check if this line starts a clock table, if yes, shift the time block."
  3993. (when (org-match-line "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>")
  3994. (org-clocktable-shift dir n)))
  3995. ;;;###autoload
  3996. (defun org-clock-persistence-insinuate ()
  3997. "Set up hooks for clock persistence."
  3998. (require 'org-clock)
  3999. (add-hook 'org-mode-hook 'org-clock-load)
  4000. (add-hook 'kill-emacs-hook 'org-clock-save))
  4001. (defgroup org-archive nil
  4002. "Options concerning archiving in Org-mode."
  4003. :tag "Org Archive"
  4004. :group 'org-structure)
  4005. (defcustom org-archive-location "%s_archive::"
  4006. "The location where subtrees should be archived.
  4007. The value of this variable is a string, consisting of two parts,
  4008. separated by a double-colon. The first part is a filename and
  4009. the second part is a headline.
  4010. When the filename is omitted, archiving happens in the same file.
  4011. %s in the filename will be replaced by the current file
  4012. name (without the directory part). Archiving to a different file
  4013. is useful to keep archived entries from contributing to the
  4014. Org-mode Agenda.
  4015. The archived entries will be filed as subtrees of the specified
  4016. headline. When the headline is omitted, the subtrees are simply
  4017. filed away at the end of the file, as top-level entries. Also in
  4018. the heading you can use %s to represent the file name, this can be
  4019. useful when using the same archive for a number of different files.
  4020. Here are a few examples:
  4021. \"%s_archive::\"
  4022. If the current file is Projects.org, archive in file
  4023. Projects.org_archive, as top-level trees. This is the default.
  4024. \"::* Archived Tasks\"
  4025. Archive in the current file, under the top-level headline
  4026. \"* Archived Tasks\".
  4027. \"~/org/archive.org::\"
  4028. Archive in file ~/org/archive.org (absolute path), as top-level trees.
  4029. \"~/org/archive.org::* From %s\"
  4030. Archive in file ~/org/archive.org (absolute path), under headlines
  4031. \"From FILENAME\" where file name is the current file name.
  4032. \"~/org/datetree.org::datetree/* Finished Tasks\"
  4033. The \"datetree/\" string is special, signifying to archive
  4034. items to the datetree. Items are placed in either the CLOSED
  4035. date of the item, or the current date if there is no CLOSED date.
  4036. The heading will be a subentry to the current date. There doesn't
  4037. need to be a heading, but there always needs to be a slash after
  4038. datetree. For example, to store archived items directly in the
  4039. datetree, use \"~/org/datetree.org::datetree/\".
  4040. \"basement::** Finished Tasks\"
  4041. Archive in file ./basement (relative path), as level 3 trees
  4042. below the level 2 heading \"** Finished Tasks\".
  4043. You may set this option on a per-file basis by adding to the buffer a
  4044. line like
  4045. #+ARCHIVE: basement::** Finished Tasks
  4046. You may also define it locally for a subtree by setting an ARCHIVE property
  4047. in the entry. If such a property is found in an entry, or anywhere up
  4048. the hierarchy, it will be used."
  4049. :group 'org-archive
  4050. :type 'string)
  4051. (defcustom org-agenda-skip-archived-trees t
  4052. "Non-nil means the agenda will skip any items located in archived trees.
  4053. An archived tree is a tree marked with the tag ARCHIVE. The use of this
  4054. variable is no longer recommended, you should leave it at the value t.
  4055. Instead, use the key `v' to cycle the archives-mode in the agenda."
  4056. :group 'org-archive
  4057. :group 'org-agenda-skip
  4058. :type 'boolean)
  4059. (defcustom org-columns-skip-archived-trees t
  4060. "Non-nil means ignore archived trees when creating column view."
  4061. :group 'org-archive
  4062. :group 'org-properties
  4063. :type 'boolean)
  4064. (defcustom org-cycle-open-archived-trees nil
  4065. "Non-nil means `org-cycle' will open archived trees.
  4066. An archived tree is a tree marked with the tag ARCHIVE.
  4067. When nil, archived trees will stay folded. You can still open them with
  4068. normal outline commands like `show-all', but not with the cycling commands."
  4069. :group 'org-archive
  4070. :group 'org-cycle
  4071. :type 'boolean)
  4072. (defcustom org-sparse-tree-open-archived-trees nil
  4073. "Non-nil means sparse tree construction shows matches in archived trees.
  4074. When nil, matches in these trees are highlighted, but the trees are kept in
  4075. collapsed state."
  4076. :group 'org-archive
  4077. :group 'org-sparse-trees
  4078. :type 'boolean)
  4079. (defcustom org-sparse-tree-default-date-type nil
  4080. "The default date type when building a sparse tree.
  4081. When this is nil, a date is a scheduled or a deadline timestamp.
  4082. Otherwise, these types are allowed:
  4083. all: all timestamps
  4084. active: only active timestamps (<...>)
  4085. inactive: only inactive timestamps ([...])
  4086. scheduled: only scheduled timestamps
  4087. deadline: only deadline timestamps"
  4088. :type '(choice (const :tag "Scheduled or deadline" nil)
  4089. (const :tag "All timestamps" all)
  4090. (const :tag "Only active timestamps" active)
  4091. (const :tag "Only inactive timestamps" inactive)
  4092. (const :tag "Only scheduled timestamps" scheduled)
  4093. (const :tag "Only deadline timestamps" deadline)
  4094. (const :tag "Only closed timestamps" closed))
  4095. :version "25.1"
  4096. :package-version '(Org . "8.3")
  4097. :group 'org-sparse-trees)
  4098. (defun org-cycle-hide-archived-subtrees (state)
  4099. "Re-hide all archived subtrees after a visibility state change."
  4100. (when (and (not org-cycle-open-archived-trees)
  4101. (not (memq state '(overview folded))))
  4102. (save-excursion
  4103. (let* ((globalp (memq state '(contents all)))
  4104. (beg (if globalp (point-min) (point)))
  4105. (end (if globalp (point-max) (org-end-of-subtree t))))
  4106. (org-hide-archived-subtrees beg end)
  4107. (goto-char beg)
  4108. (if (looking-at (concat ".*:" org-archive-tag ":"))
  4109. (message "%s" (substitute-command-keys
  4110. "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
  4111. (defun org-force-cycle-archived ()
  4112. "Cycle subtree even if it is archived."
  4113. (interactive)
  4114. (setq this-command 'org-cycle)
  4115. (let ((org-cycle-open-archived-trees t))
  4116. (call-interactively 'org-cycle)))
  4117. (defun org-hide-archived-subtrees (beg end)
  4118. "Re-hide all archived subtrees after a visibility state change."
  4119. (org-with-wide-buffer
  4120. (let ((case-fold-search nil)
  4121. (re (concat org-outline-regexp-bol ".*:" org-archive-tag ":")))
  4122. (goto-char beg)
  4123. (while (and (< (point) end) (re-search-forward re end t))
  4124. (when (member org-archive-tag (org-get-tags))
  4125. (org-flag-subtree t)
  4126. (org-end-of-subtree t))))))
  4127. (declare-function outline-end-of-heading "outline" ())
  4128. (declare-function outline-flag-region "outline" (from to flag))
  4129. (defun org-flag-subtree (flag)
  4130. (save-excursion
  4131. (org-back-to-heading t)
  4132. (outline-end-of-heading)
  4133. (outline-flag-region (point)
  4134. (progn (org-end-of-subtree t) (point))
  4135. flag)))
  4136. (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
  4137. ;; Declare Column View Code
  4138. (declare-function org-columns-number-to-string "org-colview" (n fmt &optional printf))
  4139. (declare-function org-columns-get-format-and-top-level "org-colview" ())
  4140. (declare-function org-columns-compute "org-colview" (property))
  4141. ;; Declare ID code
  4142. (declare-function org-id-store-link "org-id")
  4143. (declare-function org-id-locations-load "org-id")
  4144. (declare-function org-id-locations-save "org-id")
  4145. (defvar org-id-track-globally)
  4146. ;;; Variables for pre-computed regular expressions, all buffer local
  4147. (defvar org-todo-regexp nil
  4148. "Matches any of the TODO state keywords.")
  4149. (make-variable-buffer-local 'org-todo-regexp)
  4150. (defvar org-not-done-regexp nil
  4151. "Matches any of the TODO state keywords except the last one.")
  4152. (make-variable-buffer-local 'org-not-done-regexp)
  4153. (defvar org-not-done-heading-regexp nil
  4154. "Matches a TODO headline that is not done.")
  4155. (make-variable-buffer-local 'org-not-done-heading-regexp)
  4156. (defvar org-todo-line-regexp nil
  4157. "Matches a headline and puts TODO state into group 2 if present.")
  4158. (make-variable-buffer-local 'org-todo-line-regexp)
  4159. (defvar org-complex-heading-regexp nil
  4160. "Matches a headline and puts everything into groups:
  4161. group 1: the stars
  4162. group 2: The todo keyword, maybe
  4163. group 3: Priority cookie
  4164. group 4: True headline
  4165. group 5: Tags")
  4166. (make-variable-buffer-local 'org-complex-heading-regexp)
  4167. (defvar org-complex-heading-regexp-format nil
  4168. "Printf format to make regexp to match an exact headline.
  4169. This regexp will match the headline of any node which has the
  4170. exact headline text that is put into the format, but may have any
  4171. TODO state, priority and tags.")
  4172. (make-variable-buffer-local 'org-complex-heading-regexp-format)
  4173. (defvar org-todo-line-tags-regexp nil
  4174. "Matches a headline and puts TODO state into group 2 if present.
  4175. Also put tags into group 4 if tags are present.")
  4176. (make-variable-buffer-local 'org-todo-line-tags-regexp)
  4177. (defconst org-plain-time-of-day-regexp
  4178. (concat
  4179. "\\(\\<[012]?[0-9]"
  4180. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  4181. "\\(--?"
  4182. "\\(\\<[012]?[0-9]"
  4183. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  4184. "\\)?")
  4185. "Regular expression to match a plain time or time range.
  4186. Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
  4187. groups carry important information:
  4188. 0 the full match
  4189. 1 the first time, range or not
  4190. 8 the second time, if it is a range.")
  4191. (defconst org-plain-time-extension-regexp
  4192. (concat
  4193. "\\(\\<[012]?[0-9]"
  4194. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  4195. "\\+\\([0-9]+\\)\\(:\\([0-5][0-9]\\)\\)?")
  4196. "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
  4197. Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
  4198. groups carry important information:
  4199. 0 the full match
  4200. 7 hours of duration
  4201. 9 minutes of duration")
  4202. (defconst org-stamp-time-of-day-regexp
  4203. (concat
  4204. "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} +\\sw+ +\\)"
  4205. "\\([012][0-9]:[0-5][0-9]\\(-\\([012][0-9]:[0-5][0-9]\\)\\)?[^\n\r>]*?\\)>"
  4206. "\\(--?"
  4207. "<\\1\\([012][0-9]:[0-5][0-9]\\)>\\)?")
  4208. "Regular expression to match a timestamp time or time range.
  4209. After a match, the following groups carry important information:
  4210. 0 the full match
  4211. 1 date plus weekday, for back referencing to make sure both times are on the same day
  4212. 2 the first time, range or not
  4213. 4 the second time, if it is a range.")
  4214. (defconst org-startup-options
  4215. '(("fold" org-startup-folded t)
  4216. ("overview" org-startup-folded t)
  4217. ("nofold" org-startup-folded nil)
  4218. ("showall" org-startup-folded nil)
  4219. ("showeverything" org-startup-folded showeverything)
  4220. ("content" org-startup-folded content)
  4221. ("indent" org-startup-indented t)
  4222. ("noindent" org-startup-indented nil)
  4223. ("hidestars" org-hide-leading-stars t)
  4224. ("showstars" org-hide-leading-stars nil)
  4225. ("odd" org-odd-levels-only t)
  4226. ("oddeven" org-odd-levels-only nil)
  4227. ("align" org-startup-align-all-tables t)
  4228. ("noalign" org-startup-align-all-tables nil)
  4229. ("inlineimages" org-startup-with-inline-images t)
  4230. ("noinlineimages" org-startup-with-inline-images nil)
  4231. ("latexpreview" org-startup-with-latex-preview t)
  4232. ("nolatexpreview" org-startup-with-latex-preview nil)
  4233. ("customtime" org-display-custom-times t)
  4234. ("logdone" org-log-done time)
  4235. ("lognotedone" org-log-done note)
  4236. ("nologdone" org-log-done nil)
  4237. ("lognoteclock-out" org-log-note-clock-out t)
  4238. ("nolognoteclock-out" org-log-note-clock-out nil)
  4239. ("logrepeat" org-log-repeat state)
  4240. ("lognoterepeat" org-log-repeat note)
  4241. ("logdrawer" org-log-into-drawer t)
  4242. ("nologdrawer" org-log-into-drawer nil)
  4243. ("logstatesreversed" org-log-states-order-reversed t)
  4244. ("nologstatesreversed" org-log-states-order-reversed nil)
  4245. ("nologrepeat" org-log-repeat nil)
  4246. ("logreschedule" org-log-reschedule time)
  4247. ("lognotereschedule" org-log-reschedule note)
  4248. ("nologreschedule" org-log-reschedule nil)
  4249. ("logredeadline" org-log-redeadline time)
  4250. ("lognoteredeadline" org-log-redeadline note)
  4251. ("nologredeadline" org-log-redeadline nil)
  4252. ("logrefile" org-log-refile time)
  4253. ("lognoterefile" org-log-refile note)
  4254. ("nologrefile" org-log-refile nil)
  4255. ("fninline" org-footnote-define-inline t)
  4256. ("nofninline" org-footnote-define-inline nil)
  4257. ("fnlocal" org-footnote-section nil)
  4258. ("fnauto" org-footnote-auto-label t)
  4259. ("fnprompt" org-footnote-auto-label nil)
  4260. ("fnconfirm" org-footnote-auto-label confirm)
  4261. ("fnplain" org-footnote-auto-label plain)
  4262. ("fnadjust" org-footnote-auto-adjust t)
  4263. ("nofnadjust" org-footnote-auto-adjust nil)
  4264. ("constcgs" constants-unit-system cgs)
  4265. ("constSI" constants-unit-system SI)
  4266. ("noptag" org-tag-persistent-alist nil)
  4267. ("hideblocks" org-hide-block-startup t)
  4268. ("nohideblocks" org-hide-block-startup nil)
  4269. ("beamer" org-startup-with-beamer-mode t)
  4270. ("entitiespretty" org-pretty-entities t)
  4271. ("entitiesplain" org-pretty-entities nil))
  4272. "Variable associated with STARTUP options for org-mode.
  4273. Each element is a list of three items: the startup options (as written
  4274. in the #+STARTUP line), the corresponding variable, and the value to set
  4275. this variable to if the option is found. An optional forth element PUSH
  4276. means to push this value onto the list in the variable.")
  4277. (defcustom org-group-tags t
  4278. "When non-nil (the default), use group tags.
  4279. This can be turned on/off through `org-toggle-tags-groups'."
  4280. :group 'org-tags
  4281. :group 'org-startup
  4282. :type 'boolean)
  4283. (defvar org-inhibit-startup nil) ; Dynamically-scoped param.
  4284. (defun org-toggle-tags-groups ()
  4285. "Toggle support for group tags.
  4286. Support for group tags is controlled by the option
  4287. `org-group-tags', which is non-nil by default."
  4288. (interactive)
  4289. (setq org-group-tags (not org-group-tags))
  4290. (cond ((and (derived-mode-p 'org-agenda-mode)
  4291. org-group-tags)
  4292. (org-agenda-redo))
  4293. ((derived-mode-p 'org-mode)
  4294. (let ((org-inhibit-startup t)) (org-mode))))
  4295. (message "Groups tags support has been turned %s"
  4296. (if org-group-tags "on" "off")))
  4297. (defun org-set-regexps-and-options (&optional tags-only)
  4298. "Precompute regular expressions used in the current buffer.
  4299. When optional argument TAGS-ONLY is non-nil, only compute tags
  4300. related expressions."
  4301. (when (derived-mode-p 'org-mode)
  4302. (let ((alist (org--setup-collect-keywords
  4303. (org-make-options-regexp
  4304. (append '("FILETAGS" "TAGS" "SETUPFILE")
  4305. (and (not tags-only)
  4306. '("ARCHIVE" "CATEGORY" "COLUMNS" "CONSTANTS"
  4307. "LINK" "OPTIONS" "PRIORITIES" "PROPERTY"
  4308. "SEQ_TODO" "STARTUP" "TODO" "TYP_TODO")))))))
  4309. (org--setup-process-tags
  4310. (cdr (assq 'tags alist)) (cdr (assq 'filetags alist)))
  4311. (unless tags-only
  4312. ;; File properties.
  4313. (org-set-local 'org-file-properties (cdr (assq 'property alist)))
  4314. ;; Archive location.
  4315. (let ((archive (cdr (assq 'archive alist))))
  4316. (when archive (org-set-local 'org-archive-location archive)))
  4317. ;; Category.
  4318. (let ((cat (org-string-nw-p (cdr (assq 'category alist)))))
  4319. (when cat
  4320. (org-set-local 'org-category (intern cat))
  4321. (org-set-local 'org-file-properties
  4322. (org--update-property-plist
  4323. "CATEGORY" cat org-file-properties))))
  4324. ;; Columns.
  4325. (let ((column (cdr (assq 'columns alist))))
  4326. (when column (org-set-local 'org-columns-default-format column)))
  4327. ;; Constants.
  4328. (setq org-table-formula-constants-local (cdr (assq 'constants alist)))
  4329. ;; Link abbreviations.
  4330. (let ((links (cdr (assq 'link alist))))
  4331. (when links (setq org-link-abbrev-alist-local (nreverse links))))
  4332. ;; Priorities.
  4333. (let ((priorities (cdr (assq 'priorities alist))))
  4334. (when priorities
  4335. (org-set-local 'org-highest-priority (nth 0 priorities))
  4336. (org-set-local 'org-lowest-priority (nth 1 priorities))
  4337. (org-set-local 'org-default-priority (nth 2 priorities))))
  4338. ;; Scripts.
  4339. (let ((scripts (assq 'scripts alist)))
  4340. (when scripts
  4341. (org-set-local 'org-use-sub-superscripts (cdr scripts))))
  4342. ;; Startup options.
  4343. (let ((startup (cdr (assq 'startup alist))))
  4344. (dolist (option startup)
  4345. (let ((entry (assoc-string option org-startup-options t)))
  4346. (when entry
  4347. (let ((var (nth 1 entry))
  4348. (val (nth 2 entry)))
  4349. (if (not (nth 3 entry)) (org-set-local var val)
  4350. (unless (listp (symbol-value var))
  4351. (org-set-local var nil))
  4352. (add-to-list var val)))))))
  4353. ;; TODO keywords.
  4354. (org-set-local 'org-todo-kwd-alist nil)
  4355. (org-set-local 'org-todo-key-alist nil)
  4356. (org-set-local 'org-todo-key-trigger nil)
  4357. (org-set-local 'org-todo-keywords-1 nil)
  4358. (org-set-local 'org-done-keywords nil)
  4359. (org-set-local 'org-todo-heads nil)
  4360. (org-set-local 'org-todo-sets nil)
  4361. (org-set-local 'org-todo-log-states nil)
  4362. (let ((todo-sequences
  4363. (or (nreverse (cdr (assq 'todo alist)))
  4364. (let ((d (default-value 'org-todo-keywords)))
  4365. (if (not (stringp (car d))) d
  4366. ;; XXX: Backward compatibility code.
  4367. (list (cons org-todo-interpretation d)))))))
  4368. (dolist (sequence todo-sequences)
  4369. (let* ((sequence (or (run-hook-with-args-until-success
  4370. 'org-todo-setup-filter-hook sequence)
  4371. sequence))
  4372. (sequence-type (car sequence))
  4373. (keywords (cdr sequence))
  4374. (sep (member "|" keywords))
  4375. names alist)
  4376. (dolist (k (remove "|" keywords))
  4377. (unless (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?.*?)\\)?$"
  4378. k)
  4379. (error "Invalid TODO keyword %s" k))
  4380. (let ((name (match-string 1 k))
  4381. (key (match-string 2 k))
  4382. (log (org-extract-log-state-settings k)))
  4383. (push name names)
  4384. (push (cons name (and key (string-to-char key))) alist)
  4385. (when log (push log org-todo-log-states))))
  4386. (let* ((names (nreverse names))
  4387. (done (if sep (org-remove-keyword-keys (cdr sep))
  4388. (last names)))
  4389. (head (car names))
  4390. (tail (list sequence-type head (car done) (org-last done))))
  4391. (add-to-list 'org-todo-heads head 'append)
  4392. (push names org-todo-sets)
  4393. (setq org-done-keywords (append org-done-keywords done nil))
  4394. (setq org-todo-keywords-1 (append org-todo-keywords-1 names nil))
  4395. (setq org-todo-key-alist
  4396. (append org-todo-key-alist
  4397. (and alist
  4398. (append '((:startgroup))
  4399. (nreverse alist)
  4400. '((:endgroup))))))
  4401. (dolist (k names) (push (cons k tail) org-todo-kwd-alist))))))
  4402. (setq org-todo-sets (nreverse org-todo-sets)
  4403. org-todo-kwd-alist (nreverse org-todo-kwd-alist)
  4404. org-todo-key-trigger (delq nil (mapcar #'cdr org-todo-key-alist))
  4405. org-todo-key-alist (org-assign-fast-keys org-todo-key-alist))
  4406. ;; Compute the regular expressions and other local variables.
  4407. ;; Using `org-outline-regexp-bol' would complicate them much,
  4408. ;; because of the fixed white space at the end of that string.
  4409. (if (not org-done-keywords)
  4410. (setq org-done-keywords
  4411. (and org-todo-keywords-1 (last org-todo-keywords-1))))
  4412. (setq org-not-done-keywords
  4413. (org-delete-all org-done-keywords
  4414. (copy-sequence org-todo-keywords-1))
  4415. org-todo-regexp (regexp-opt org-todo-keywords-1 t)
  4416. org-not-done-regexp (regexp-opt org-not-done-keywords t)
  4417. org-not-done-heading-regexp
  4418. (format org-heading-keyword-regexp-format org-not-done-regexp)
  4419. org-todo-line-regexp
  4420. (format org-heading-keyword-maybe-regexp-format org-todo-regexp)
  4421. org-complex-heading-regexp
  4422. (concat "^\\(\\*+\\)"
  4423. "\\(?: +" org-todo-regexp "\\)?"
  4424. "\\(?: +\\(\\[#.\\]\\)\\)?"
  4425. "\\(?: +\\(.*?\\)\\)??"
  4426. (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)?")
  4427. "[ \t]*$")
  4428. org-complex-heading-regexp-format
  4429. (concat "^\\(\\*+\\)"
  4430. "\\(?: +" org-todo-regexp "\\)?"
  4431. "\\(?: +\\(\\[#.\\]\\)\\)?"
  4432. "\\(?: +"
  4433. ;; Stats cookies can be stuck to body.
  4434. "\\(?:\\[[0-9%%/]+\\] *\\)*"
  4435. "\\(%s\\)"
  4436. "\\(?: *\\[[0-9%%/]+\\]\\)*"
  4437. "\\)"
  4438. (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%%:]+:\\)\\)?")
  4439. "[ \t]*$")
  4440. org-todo-line-tags-regexp
  4441. (concat "^\\(\\*+\\)"
  4442. "\\(?: +" org-todo-regexp "\\)?"
  4443. "\\(?: +\\(.*?\\)\\)??"
  4444. (org-re "\\(?:[ \t]+\\(:[[:alnum:]:_@#%]+:\\)\\)?")
  4445. "[ \t]*$"))
  4446. (org-compute-latex-and-related-regexp)))))
  4447. (defun org--setup-collect-keywords (regexp &optional files alist)
  4448. "Return setup keywords values as an alist.
  4449. REGEXP matches a subset of setup keywords. FILES is a list of
  4450. file names already visited. It is used to avoid circular setup
  4451. files. ALIST, when non-nil, is the alist computed so far.
  4452. Return value contains the following keys: `archive', `category',
  4453. `columns', `constants', `filetags', `link', `priorities',
  4454. `property', `scripts', `startup', `tags' and `todo'."
  4455. (org-with-wide-buffer
  4456. (goto-char (point-min))
  4457. (let ((case-fold-search t))
  4458. (while (re-search-forward regexp nil t)
  4459. (let ((element (org-element-at-point)))
  4460. (when (eq (org-element-type element) 'keyword)
  4461. (let ((key (org-element-property :key element))
  4462. (value (org-element-property :value element)))
  4463. (cond
  4464. ((equal key "ARCHIVE")
  4465. (when (org-string-nw-p value)
  4466. (push (cons 'archive value) alist)))
  4467. ((equal key "CATEGORY") (push (cons 'category value) alist))
  4468. ((equal key "COLUMNS") (push (cons 'columns value) alist))
  4469. ((equal key "CONSTANTS")
  4470. (let* ((constants (assq 'constants alist))
  4471. (store (cdr constants)))
  4472. (dolist (pair (org-split-string value))
  4473. (when (string-match "^\\([a-zA-Z0][_a-zA-Z0-9]*\\)=\\(.*\\)"
  4474. pair)
  4475. (let* ((name (match-string 1 pair))
  4476. (value (match-string 2 pair))
  4477. (old (assoc name store)))
  4478. (if old (setcdr old value)
  4479. (push (cons name value) store)))))
  4480. (if constants (setcdr constants store)
  4481. (push (cons 'constants store) alist))))
  4482. ((equal key "FILETAGS")
  4483. (when (org-string-nw-p value)
  4484. (let ((old (assq 'filetags alist))
  4485. (new (apply #'nconc
  4486. (mapcar (lambda (x) (org-split-string x ":"))
  4487. (org-split-string value)))))
  4488. (if old (setcdr old (append new (cdr old)))
  4489. (push (cons 'filetags new) alist)))))
  4490. ((equal key "LINK")
  4491. (when (string-match "\\`\\(\\S-+\\)[ \t]+\\(.+\\)" value)
  4492. (let ((links (assq 'link alist))
  4493. (pair (cons (org-match-string-no-properties 1 value)
  4494. (org-match-string-no-properties 2 value))))
  4495. (if links (push pair (cdr links))
  4496. (push (list 'link pair) alist)))))
  4497. ((equal key "OPTIONS")
  4498. (when (and (org-string-nw-p value)
  4499. (string-match "\\^:\\(t\\|nil\\|{}\\)" value))
  4500. (push (cons 'scripts (read (match-string 1 value))) alist)))
  4501. ((equal key "PRIORITIES")
  4502. (push (cons 'priorities
  4503. (let ((prio (org-split-string value)))
  4504. (if (< (length prio) 3) '(?A ?C ?B)
  4505. (mapcar #'string-to-char prio))))
  4506. alist))
  4507. ((equal key "PROPERTY")
  4508. (when (string-match "\\(\\S-+\\)[ \t]+\\(.*\\)" value)
  4509. (let* ((property (assq 'property alist))
  4510. (value (org--update-property-plist
  4511. (org-match-string-no-properties 1 value)
  4512. (org-match-string-no-properties 2 value)
  4513. (cdr property))))
  4514. (if property (setcdr property value)
  4515. (push (cons 'property value) alist)))))
  4516. ((equal key "STARTUP")
  4517. (let ((startup (assq 'startup alist)))
  4518. (if startup
  4519. (setcdr startup
  4520. (append (cdr startup) (org-split-string value)))
  4521. (push (cons 'startup (org-split-string value)) alist))))
  4522. ((equal key "TAGS")
  4523. (let ((tag-cell (assq 'tags alist)))
  4524. (if tag-cell
  4525. (setcdr tag-cell
  4526. (append (cdr tag-cell)
  4527. '("\\n")
  4528. (org-split-string value)))
  4529. (push (cons 'tags (org-split-string value)) alist))))
  4530. ((member key '("TODO" "SEQ_TODO" "TYP_TODO"))
  4531. (let ((todo (assq 'todo alist))
  4532. (value (cons (if (equal key "TYP_TODO") 'type 'sequence)
  4533. (org-split-string value))))
  4534. (if todo (push value (cdr todo))
  4535. (push (list 'todo value) alist))))
  4536. ((equal key "SETUPFILE")
  4537. (unless buffer-read-only ; Do not check in Gnus messages.
  4538. (let ((f (and (org-string-nw-p value)
  4539. (expand-file-name
  4540. (org-remove-double-quotes value)))))
  4541. (when (and f (file-readable-p f) (not (member f files)))
  4542. (with-temp-buffer
  4543. (insert-file-contents f)
  4544. (setq alist
  4545. ;; Fake Org mode to benefit from cache
  4546. ;; without recurring needlessly.
  4547. (let ((major-mode 'org-mode))
  4548. (org--setup-collect-keywords
  4549. regexp (cons f files) alist)))))))))))))))
  4550. alist)
  4551. (defun org--setup-process-tags (tags filetags)
  4552. "Precompute variables used for tags.
  4553. TAGS is a list of tags and tag group symbols, as strings.
  4554. FILETAGS is a list of tags, as strings."
  4555. ;; Process the file tags.
  4556. (org-set-local 'org-file-tags
  4557. (mapcar #'org-add-prop-inherited filetags))
  4558. ;; Provide default tags if no local tags are found.
  4559. (when (and (not tags) org-tag-alist)
  4560. (setq tags
  4561. (mapcar (lambda (tag)
  4562. (case (car tag)
  4563. (:startgroup "{")
  4564. (:endgroup "}")
  4565. (:startgrouptag "[")
  4566. (:endgrouptag "]")
  4567. (:grouptags ":")
  4568. (:newline "\\n")
  4569. (otherwise (concat (car tag)
  4570. (and (characterp (cdr tag))
  4571. (format "(%c)" (cdr tag)))))))
  4572. org-tag-alist)))
  4573. ;; Process the tags.
  4574. (org-set-local 'org-tag-groups-alist nil)
  4575. (org-set-local 'org-tag-alist nil)
  4576. (let (group-flag)
  4577. (while tags
  4578. (let ((e (car tags)))
  4579. (setq tags (cdr tags))
  4580. (cond
  4581. ((equal e "{")
  4582. (push '(:startgroup) org-tag-alist)
  4583. (when (equal (nth 1 tags) ":") (setq group-flag t)))
  4584. ((equal e "}")
  4585. (push '(:endgroup) org-tag-alist)
  4586. (setq group-flag nil))
  4587. ((equal e "[")
  4588. (push '(:startgrouptag) org-tag-alist)
  4589. (when (equal (nth 1 tags) ":") (setq group-flag t)))
  4590. ((equal e "]")
  4591. (push '(:endgrouptag) org-tag-alist)
  4592. (setq group-flag nil))
  4593. ((equal e ":")
  4594. (push '(:grouptags) org-tag-alist)
  4595. (setq group-flag 'append))
  4596. ((equal e "\\n") (push '(:newline) org-tag-alist))
  4597. ((string-match
  4598. (org-re (concat "\\`\\([[:alnum:]_@#%]+"
  4599. "\\|{.+?}\\)" ; regular expression
  4600. "\\(?:(\\(.\\))\\)?\\'")) e)
  4601. (let ((tag (match-string 1 e))
  4602. (key (and (match-beginning 2)
  4603. (string-to-char (match-string 2 e)))))
  4604. (cond ((eq group-flag 'append)
  4605. (setcar org-tag-groups-alist
  4606. (append (car org-tag-groups-alist) (list tag))))
  4607. (group-flag (push (list tag) org-tag-groups-alist)))
  4608. ;; Push all tags in groups, no matter if they already exist.
  4609. (unless (and (not group-flag) (assoc tag org-tag-alist))
  4610. (push (cons tag key) org-tag-alist))))))))
  4611. (setq org-tag-alist (nreverse org-tag-alist)))
  4612. (defun org-file-contents (file &optional noerror)
  4613. "Return the contents of FILE, as a string."
  4614. (if (and file (file-readable-p file))
  4615. (with-temp-buffer
  4616. (insert-file-contents file)
  4617. (buffer-string))
  4618. (funcall (if noerror 'message 'error)
  4619. "Cannot read file \"%s\"%s"
  4620. file
  4621. (let ((from (buffer-file-name (buffer-base-buffer))))
  4622. (if from (concat " (referenced in file \"" from "\")") "")))))
  4623. (defun org-extract-log-state-settings (x)
  4624. "Extract the log state setting from a TODO keyword string.
  4625. This will extract info from a string like \"WAIT(w@/!)\"."
  4626. (let (kw key log1 log2)
  4627. (when (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?\\([!@]\\)?\\(?:/\\([!@]\\)\\)?)\\)?$" x)
  4628. (setq kw (match-string 1 x)
  4629. key (and (match-end 2) (match-string 2 x))
  4630. log1 (and (match-end 3) (match-string 3 x))
  4631. log2 (and (match-end 4) (match-string 4 x)))
  4632. (and (or log1 log2)
  4633. (list kw
  4634. (and log1 (if (equal log1 "!") 'time 'note))
  4635. (and log2 (if (equal log2 "!") 'time 'note)))))))
  4636. (defun org-remove-keyword-keys (list)
  4637. "Remove a pair of parenthesis at the end of each string in LIST."
  4638. (mapcar (lambda (x)
  4639. (if (string-match "(.*)$" x)
  4640. (substring x 0 (match-beginning 0))
  4641. x))
  4642. list))
  4643. (defun org-assign-fast-keys (alist)
  4644. "Assign fast keys to a keyword-key alist.
  4645. Respect keys that are already there."
  4646. (let (new e (alt ?0))
  4647. (while (setq e (pop alist))
  4648. (if (or (memq (car e) '(:newline :grouptags :endgroup :startgroup))
  4649. (cdr e)) ;; Key already assigned.
  4650. (push e new)
  4651. (let ((clist (string-to-list (downcase (car e))))
  4652. (used (append new alist)))
  4653. (when (= (car clist) ?@)
  4654. (pop clist))
  4655. (while (and clist (rassoc (car clist) used))
  4656. (pop clist))
  4657. (unless clist
  4658. (while (rassoc alt used)
  4659. (incf alt)))
  4660. (push (cons (car e) (or (car clist) alt)) new))))
  4661. (nreverse new)))
  4662. ;;; Some variables used in various places
  4663. (defvar org-window-configuration nil
  4664. "Used in various places to store a window configuration.")
  4665. (defvar org-selected-window nil
  4666. "Used in various places to store a window configuration.")
  4667. (defvar org-finish-function nil
  4668. "Function to be called when `C-c C-c' is used.
  4669. This is for getting out of special buffers like capture.")
  4670. ;; FIXME: Occasionally check by commenting these, to make sure
  4671. ;; no other functions uses these, forgetting to let-bind them.
  4672. (org-no-warnings (defvar entry)) ;; unprefixed, from calendar.el
  4673. (defvar org-last-state)
  4674. (org-no-warnings (defvar date)) ;; unprefixed, from calendar.el
  4675. ;; Defined somewhere in this file, but used before definition.
  4676. (defvar org-entities) ;; defined in org-entities.el
  4677. (defvar org-struct-menu)
  4678. (defvar org-org-menu)
  4679. (defvar org-tbl-menu)
  4680. ;;;; Define the Org-mode
  4681. ;; We use a before-change function to check if a table might need
  4682. ;; an update.
  4683. (defvar org-table-may-need-update t
  4684. "Indicates that a table might need an update.
  4685. This variable is set by `org-before-change-function'.
  4686. `org-table-align' sets it back to nil.")
  4687. (defun org-before-change-function (beg end)
  4688. "Every change indicates that a table might need an update."
  4689. (setq org-table-may-need-update t))
  4690. (defvar org-mode-map)
  4691. (defvar org-inhibit-startup-visibility-stuff nil) ; Dynamically-scoped param.
  4692. (defvar org-agenda-keep-modes nil) ; Dynamically-scoped param.
  4693. (defvar org-inhibit-logging nil) ; Dynamically-scoped param.
  4694. (defvar org-inhibit-blocking nil) ; Dynamically-scoped param.
  4695. (defvar org-table-buffer-is-an nil)
  4696. (defvar bidi-paragraph-direction)
  4697. (defvar buffer-face-mode-face)
  4698. (require 'outline)
  4699. (if (and (not (keymapp outline-mode-map)) (featurep 'allout))
  4700. (error "Conflict with outdated version of allout.el. Load org.el before allout.el, or upgrade to newer allout, for example by switching to Emacs 22"))
  4701. (require 'noutline "noutline" 'noerror) ;; stock XEmacs does not have it
  4702. ;; Other stuff we need.
  4703. (require 'time-date)
  4704. (unless (fboundp 'time-subtract) (defalias 'time-subtract 'subtract-time))
  4705. (require 'easymenu)
  4706. (autoload 'easy-menu-add "easymenu")
  4707. (require 'overlay)
  4708. ;; (require 'org-macs) moved higher up in the file before it is first used
  4709. (require 'org-entities)
  4710. ;; (require 'org-compat) moved higher up in the file before it is first used
  4711. (require 'org-faces)
  4712. (require 'org-list)
  4713. (require 'org-pcomplete)
  4714. (require 'org-src)
  4715. (require 'org-footnote)
  4716. (require 'org-macro)
  4717. ;; babel
  4718. (require 'ob)
  4719. ;;;###autoload
  4720. (define-derived-mode org-mode outline-mode "Org"
  4721. "Outline-based notes management and organizer, alias
  4722. \"Carsten's outline-mode for keeping track of everything.\"
  4723. Org-mode develops organizational tasks around a NOTES file which
  4724. contains information about projects as plain text. Org-mode is
  4725. implemented on top of outline-mode, which is ideal to keep the content
  4726. of large files well structured. It supports ToDo items, deadlines and
  4727. time stamps, which magically appear in the diary listing of the Emacs
  4728. calendar. Tables are easily created with a built-in table editor.
  4729. Plain text URL-like links connect to websites, emails (VM), Usenet
  4730. messages (Gnus), BBDB entries, and any files related to the project.
  4731. For printing and sharing of notes, an Org-mode file (or a part of it)
  4732. can be exported as a structured ASCII or HTML file.
  4733. The following commands are available:
  4734. \\{org-mode-map}"
  4735. ;; Get rid of Outline menus, they are not needed
  4736. ;; Need to do this here because define-derived-mode sets up
  4737. ;; the keymap so late. Still, it is a waste to call this each time
  4738. ;; we switch another buffer into org-mode.
  4739. (if (featurep 'xemacs)
  4740. (when (boundp 'outline-mode-menu-heading)
  4741. ;; Assume this is Greg's port, it uses easymenu
  4742. (easy-menu-remove outline-mode-menu-heading)
  4743. (easy-menu-remove outline-mode-menu-show)
  4744. (easy-menu-remove outline-mode-menu-hide))
  4745. (define-key org-mode-map [menu-bar headings] 'undefined)
  4746. (define-key org-mode-map [menu-bar hide] 'undefined)
  4747. (define-key org-mode-map [menu-bar show] 'undefined))
  4748. (org-load-modules-maybe)
  4749. (easy-menu-add org-org-menu)
  4750. (easy-menu-add org-tbl-menu)
  4751. (org-install-agenda-files-menu)
  4752. (if org-descriptive-links (add-to-invisibility-spec '(org-link)))
  4753. (add-to-invisibility-spec '(org-cwidth))
  4754. (add-to-invisibility-spec '(org-hide-block . t))
  4755. (when (featurep 'xemacs)
  4756. (org-set-local 'line-move-ignore-invisible t))
  4757. (org-set-local 'outline-regexp org-outline-regexp)
  4758. (org-set-local 'outline-level 'org-outline-level)
  4759. (setq bidi-paragraph-direction 'left-to-right)
  4760. (when (and org-ellipsis
  4761. (fboundp 'set-display-table-slot) (boundp 'buffer-display-table)
  4762. (fboundp 'make-glyph-code))
  4763. (unless org-display-table
  4764. (setq org-display-table (make-display-table)))
  4765. (set-display-table-slot
  4766. org-display-table 4
  4767. (vconcat (mapcar
  4768. (lambda (c) (make-glyph-code c (and (not (stringp org-ellipsis))
  4769. org-ellipsis)))
  4770. (if (stringp org-ellipsis) org-ellipsis "..."))))
  4771. (setq buffer-display-table org-display-table))
  4772. (org-set-regexps-and-options)
  4773. (org-set-font-lock-defaults)
  4774. (when (and org-tag-faces (not org-tags-special-faces-re))
  4775. ;; tag faces set outside customize.... force initialization.
  4776. (org-set-tag-faces 'org-tag-faces org-tag-faces))
  4777. ;; Calc embedded
  4778. (org-set-local 'calc-embedded-open-mode "# ")
  4779. ;; Modify a few syntax entries
  4780. (modify-syntax-entry ?@ "w")
  4781. (modify-syntax-entry ?\" "\"")
  4782. (modify-syntax-entry ?\\ "_")
  4783. (modify-syntax-entry ?~ "_")
  4784. (if org-startup-truncated (setq truncate-lines t))
  4785. (when org-startup-indented (require 'org-indent) (org-indent-mode 1))
  4786. (org-set-local 'font-lock-unfontify-region-function
  4787. 'org-unfontify-region)
  4788. ;; Activate before-change-function
  4789. (org-set-local 'org-table-may-need-update t)
  4790. (org-add-hook 'before-change-functions 'org-before-change-function nil
  4791. 'local)
  4792. ;; Check for running clock before killing a buffer
  4793. (org-add-hook 'kill-buffer-hook 'org-check-running-clock nil 'local)
  4794. ;; Initialize macros templates.
  4795. (org-macro-initialize-templates)
  4796. ;; Initialize radio targets.
  4797. (org-update-radio-target-regexp)
  4798. ;; Indentation.
  4799. (org-set-local 'indent-line-function 'org-indent-line)
  4800. (org-set-local 'indent-region-function 'org-indent-region)
  4801. ;; Filling and auto-filling.
  4802. (org-setup-filling)
  4803. ;; Comments.
  4804. (org-setup-comments-handling)
  4805. ;; Initialize cache.
  4806. (org-element-cache-reset)
  4807. ;; Beginning/end of defun
  4808. (org-set-local 'beginning-of-defun-function 'org-backward-element)
  4809. (org-set-local 'end-of-defun-function
  4810. (lambda ()
  4811. (if (not (org-at-heading-p))
  4812. (org-forward-element)
  4813. (org-forward-element)
  4814. (forward-char -1))))
  4815. ;; Next error for sparse trees
  4816. (org-set-local 'next-error-function 'org-occur-next-match)
  4817. ;; Make sure dependence stuff works reliably, even for users who set it
  4818. ;; too late :-(
  4819. (if org-enforce-todo-dependencies
  4820. (add-hook 'org-blocker-hook
  4821. 'org-block-todo-from-children-or-siblings-or-parent)
  4822. (remove-hook 'org-blocker-hook
  4823. 'org-block-todo-from-children-or-siblings-or-parent))
  4824. (if org-enforce-todo-checkbox-dependencies
  4825. (add-hook 'org-blocker-hook
  4826. 'org-block-todo-from-checkboxes)
  4827. (remove-hook 'org-blocker-hook
  4828. 'org-block-todo-from-checkboxes))
  4829. ;; Align options lines
  4830. (org-set-local
  4831. 'align-mode-rules-list
  4832. '((org-in-buffer-settings
  4833. (regexp . "^[ \t]*#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
  4834. (modes . '(org-mode)))))
  4835. ;; Imenu
  4836. (org-set-local 'imenu-create-index-function
  4837. 'org-imenu-get-tree)
  4838. ;; Make isearch reveal context
  4839. (if (or (featurep 'xemacs)
  4840. (not (boundp 'outline-isearch-open-invisible-function)))
  4841. ;; Emacs 21 and XEmacs make use of the hook
  4842. (org-add-hook 'isearch-mode-end-hook 'org-isearch-end 'append 'local)
  4843. ;; Emacs 22 deals with this through a special variable
  4844. (org-set-local 'outline-isearch-open-invisible-function
  4845. (lambda (&rest ignore) (org-show-context 'isearch))))
  4846. ;; Setup the pcomplete hooks
  4847. (set (make-local-variable 'pcomplete-command-completion-function)
  4848. 'org-pcomplete-initial)
  4849. (set (make-local-variable 'pcomplete-command-name-function)
  4850. 'org-command-at-point)
  4851. (set (make-local-variable 'pcomplete-default-completion-function)
  4852. 'ignore)
  4853. (set (make-local-variable 'pcomplete-parse-arguments-function)
  4854. 'org-parse-arguments)
  4855. (set (make-local-variable 'pcomplete-termination-string) "")
  4856. (when (>= emacs-major-version 23)
  4857. (set (make-local-variable 'buffer-face-mode-face) 'org-default))
  4858. ;; If empty file that did not turn on org-mode automatically, make it to.
  4859. (if (and org-insert-mode-line-in-empty-file
  4860. (org-called-interactively-p 'any)
  4861. (= (point-min) (point-max)))
  4862. (insert "# -*- mode: org -*-\n\n"))
  4863. (unless org-inhibit-startup
  4864. (org-unmodified
  4865. (and org-startup-with-beamer-mode (org-beamer-mode))
  4866. (when org-startup-align-all-tables
  4867. (org-table-map-tables 'org-table-align 'quietly))
  4868. (when org-startup-with-inline-images
  4869. (org-display-inline-images))
  4870. (when org-startup-with-latex-preview
  4871. (org-toggle-latex-fragment))
  4872. (unless org-inhibit-startup-visibility-stuff
  4873. (org-set-startup-visibility))
  4874. (org-refresh-effort-properties)))
  4875. ;; Try to set org-hide correctly
  4876. (let ((foreground (org-find-invisible-foreground)))
  4877. (if foreground
  4878. (set-face-foreground 'org-hide foreground))))
  4879. ;; Update `customize-package-emacs-version-alist'
  4880. (add-to-list 'customize-package-emacs-version-alist
  4881. '(Org ("6.21b" . "23.1") ("6.33x" . "23.2")
  4882. ("7.8.11" . "24.1") ("7.9.4" . "24.3")
  4883. ("8.2.6" . "24.4") ("8.3" . "25.1")))
  4884. (defvar org-mode-transpose-word-syntax-table
  4885. (let ((st (make-syntax-table text-mode-syntax-table)))
  4886. (mapc (lambda(c) (modify-syntax-entry
  4887. (string-to-char (car c)) "w p" st))
  4888. org-emphasis-alist)
  4889. st))
  4890. (when (fboundp 'abbrev-table-put)
  4891. (abbrev-table-put org-mode-abbrev-table
  4892. :parents (list text-mode-abbrev-table)))
  4893. (defun org-find-invisible-foreground ()
  4894. (let ((candidates (remove
  4895. "unspecified-bg"
  4896. (nconc
  4897. (list (face-background 'default)
  4898. (face-background 'org-default))
  4899. (mapcar
  4900. (lambda (alist)
  4901. (when (boundp alist)
  4902. (cdr (assoc 'background-color (symbol-value alist)))))
  4903. '(default-frame-alist initial-frame-alist window-system-default-frame-alist))
  4904. (list (face-foreground 'org-hide))))))
  4905. (car (remove nil candidates))))
  4906. (defun org-current-time (&optional rounding-minutes past)
  4907. "Current time, possibly rounded to ROUNDING-MINUTES.
  4908. When ROUNDING-MINUTES is not an integer, fall back on the car of
  4909. `org-time-stamp-rounding-minutes'. When PAST is non-nil, ensure
  4910. the rounding returns a past time."
  4911. (let ((r (or (and (integerp rounding-minutes) rounding-minutes)
  4912. (car org-time-stamp-rounding-minutes)))
  4913. (time (decode-time)) res)
  4914. (if (< r 1)
  4915. (current-time)
  4916. (setq res
  4917. (apply 'encode-time
  4918. (append (list 0 (* r (floor (+ .5 (/ (float (nth 1 time)) r)))))
  4919. (nthcdr 2 time))))
  4920. (if (and past (< (org-float-time (time-subtract (current-time) res)) 0))
  4921. (seconds-to-time (- (org-float-time res) (* r 60)))
  4922. res))))
  4923. (defun org-today ()
  4924. "Return today date, considering `org-extend-today-until'."
  4925. (time-to-days
  4926. (time-subtract (current-time)
  4927. (list 0 (* 3600 org-extend-today-until) 0))))
  4928. ;;;; Font-Lock stuff, including the activators
  4929. (defvar org-mouse-map (make-sparse-keymap))
  4930. (org-defkey org-mouse-map [mouse-2] 'org-open-at-mouse)
  4931. (org-defkey org-mouse-map [mouse-3] 'org-find-file-at-mouse)
  4932. (when org-mouse-1-follows-link
  4933. (org-defkey org-mouse-map [follow-link] 'mouse-face))
  4934. (when org-tab-follows-link
  4935. (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
  4936. (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
  4937. (require 'font-lock)
  4938. (defconst org-non-link-chars "]\t\n\r<>")
  4939. (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "file+emacs"
  4940. "file+sys" "news" "shell" "elisp" "doi" "message"
  4941. "help"))
  4942. (defvar org-link-types-re nil
  4943. "Matches a link that has a url-like prefix like \"http:\"")
  4944. (defvar org-link-re-with-space nil
  4945. "Matches a link with spaces, optional angular brackets around it.")
  4946. (defvar org-link-re-with-space2 nil
  4947. "Matches a link with spaces, optional angular brackets around it.")
  4948. (defvar org-link-re-with-space3 nil
  4949. "Matches a link with spaces, only for internal part in bracket links.")
  4950. (defvar org-angle-link-re nil
  4951. "Matches link with angular brackets, spaces are allowed.")
  4952. (defvar org-plain-link-re nil
  4953. "Matches plain link, without spaces.")
  4954. (defvar org-bracket-link-regexp nil
  4955. "Matches a link in double brackets.")
  4956. (defvar org-bracket-link-analytic-regexp nil
  4957. "Regular expression used to analyze links.
  4958. Here is what the match groups contain after a match:
  4959. 1: http:
  4960. 2: http
  4961. 3: path
  4962. 4: [desc]
  4963. 5: desc")
  4964. (defvar org-bracket-link-analytic-regexp++ nil
  4965. "Like `org-bracket-link-analytic-regexp', but include coderef internal type.")
  4966. (defvar org-any-link-re nil
  4967. "Regular expression matching any link.")
  4968. (defconst org-match-sexp-depth 3
  4969. "Number of stacked braces for sub/superscript matching.")
  4970. (defun org-create-multibrace-regexp (left right n)
  4971. "Create a regular expression which will match a balanced sexp.
  4972. Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
  4973. as single character strings.
  4974. The regexp returned will match the entire expression including the
  4975. delimiters. It will also define a single group which contains the
  4976. match except for the outermost delimiters. The maximum depth of
  4977. stacked delimiters is N. Escaping delimiters is not possible."
  4978. (let* ((nothing (concat "[^" left right "]*?"))
  4979. (or "\\|")
  4980. (re nothing)
  4981. (next (concat "\\(?:" nothing left nothing right "\\)+" nothing)))
  4982. (while (> n 1)
  4983. (setq n (1- n)
  4984. re (concat re or next)
  4985. next (concat "\\(?:" nothing left next right "\\)+" nothing)))
  4986. (concat left "\\(" re "\\)" right)))
  4987. (defconst org-match-substring-regexp
  4988. (concat
  4989. "\\(\\S-\\)\\([_^]\\)\\("
  4990. "\\(?:" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
  4991. "\\|"
  4992. "\\(?:" (org-create-multibrace-regexp "(" ")" org-match-sexp-depth) "\\)"
  4993. "\\|"
  4994. "\\(?:\\*\\|[+-]?[[:alnum:].,\\]*[[:alnum:]]\\)\\)")
  4995. "The regular expression matching a sub- or superscript.")
  4996. (defconst org-match-substring-with-braces-regexp
  4997. (concat
  4998. "\\(\\S-\\)\\([_^]\\)"
  4999. "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)")
  5000. "The regular expression matching a sub- or superscript, forcing braces.")
  5001. (defun org-make-link-regexps ()
  5002. "Update the link regular expressions.
  5003. This should be called after the variable `org-link-types' has changed."
  5004. (let ((types-re (regexp-opt org-link-types t)))
  5005. (setq org-link-types-re
  5006. (concat "\\`" types-re ":")
  5007. org-link-re-with-space
  5008. (concat "<?" types-re ":"
  5009. "\\([^" org-non-link-chars " ]"
  5010. "[^" org-non-link-chars "]*"
  5011. "[^" org-non-link-chars " ]\\)>?")
  5012. org-link-re-with-space2
  5013. (concat "<?" types-re ":"
  5014. "\\([^" org-non-link-chars " ]"
  5015. "[^\t\n\r]*"
  5016. "[^" org-non-link-chars " ]\\)>?")
  5017. org-link-re-with-space3
  5018. (concat "<?" types-re ":"
  5019. "\\([^" org-non-link-chars " ]"
  5020. "[^\t\n\r]*\\)")
  5021. org-angle-link-re
  5022. (concat "<" types-re ":"
  5023. "\\([^" org-non-link-chars " ]"
  5024. "[^" org-non-link-chars "]*"
  5025. "\\)>")
  5026. org-plain-link-re
  5027. (concat
  5028. "\\<" types-re ":"
  5029. (org-re "\\([^ \t\n()<>]+\\(?:([[:word:]0-9_]+)\\|\\([^[:punct:] \t\n]\\|/\\)\\)\\)"))
  5030. ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
  5031. org-bracket-link-regexp
  5032. "\\[\\[\\([^][]+\\)\\]\\(\\[\\([^][]+\\)\\]\\)?\\]"
  5033. org-bracket-link-analytic-regexp
  5034. (concat
  5035. "\\[\\["
  5036. "\\(" types-re ":\\)?"
  5037. "\\([^]]+\\)"
  5038. "\\]"
  5039. "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
  5040. "\\]")
  5041. org-bracket-link-analytic-regexp++
  5042. (concat
  5043. "\\[\\["
  5044. "\\(" (regexp-opt (cons "coderef" org-link-types) t) ":\\)?"
  5045. "\\([^]]+\\)"
  5046. "\\]"
  5047. "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
  5048. "\\]")
  5049. org-any-link-re
  5050. (concat "\\(" org-bracket-link-regexp "\\)\\|\\("
  5051. org-angle-link-re "\\)\\|\\("
  5052. org-plain-link-re "\\)"))))
  5053. (org-make-link-regexps)
  5054. (defvar org-emph-face nil)
  5055. (defun org-do-emphasis-faces (limit)
  5056. "Run through the buffer and emphasize strings."
  5057. (let (rtn a)
  5058. (while (and (not rtn) (re-search-forward org-emph-re limit t))
  5059. (let* ((border (char-after (match-beginning 3)))
  5060. (bre (regexp-quote (char-to-string border))))
  5061. (if (and (not (= border (char-after (match-beginning 4))))
  5062. (not (save-match-data
  5063. (string-match (concat bre ".*" bre)
  5064. (replace-regexp-in-string
  5065. "\n" " "
  5066. (substring (match-string 2) 1 -1))))))
  5067. (progn
  5068. (setq rtn t)
  5069. (setq a (assoc (match-string 3) org-emphasis-alist))
  5070. (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
  5071. 'face
  5072. (nth 1 a))
  5073. (and (nth 2 a)
  5074. (org-remove-flyspell-overlays-in
  5075. (match-beginning 0) (match-end 0)))
  5076. (add-text-properties (match-beginning 2) (match-end 2)
  5077. '(font-lock-multiline t org-emphasis t))
  5078. (when org-hide-emphasis-markers
  5079. (add-text-properties (match-end 4) (match-beginning 5)
  5080. '(invisible org-link))
  5081. (add-text-properties (match-beginning 3) (match-end 3)
  5082. '(invisible org-link))))))
  5083. (goto-char (1+ (match-beginning 0))))
  5084. rtn))
  5085. (defun org-emphasize (&optional char)
  5086. "Insert or change an emphasis, i.e. a font like bold or italic.
  5087. If there is an active region, change that region to a new emphasis.
  5088. If there is no region, just insert the marker characters and position
  5089. the cursor between them.
  5090. CHAR should be the marker character. If it is a space, it means to
  5091. remove the emphasis of the selected region.
  5092. If CHAR is not given (for example in an interactive call) it will be
  5093. prompted for."
  5094. (interactive)
  5095. (let ((erc org-emphasis-regexp-components)
  5096. (prompt "")
  5097. (string "") beg end move c s)
  5098. (if (org-region-active-p)
  5099. (setq beg (region-beginning) end (region-end)
  5100. string (buffer-substring beg end))
  5101. (setq move t))
  5102. (unless char
  5103. (message "Emphasis marker or tag: [%s]"
  5104. (mapconcat (lambda(e) (car e)) org-emphasis-alist ""))
  5105. (setq char (read-char-exclusive)))
  5106. (if (equal char ?\ )
  5107. (setq s "" move nil)
  5108. (unless (assoc (char-to-string char) org-emphasis-alist)
  5109. (user-error "No such emphasis marker: \"%c\"" char))
  5110. (setq s (char-to-string char)))
  5111. (while (and (> (length string) 1)
  5112. (equal (substring string 0 1) (substring string -1))
  5113. (assoc (substring string 0 1) org-emphasis-alist))
  5114. (setq string (substring string 1 -1)))
  5115. (setq string (concat s string s))
  5116. (if beg (delete-region beg end))
  5117. (unless (or (bolp)
  5118. (string-match (concat "[" (nth 0 erc) "\n]")
  5119. (char-to-string (char-before (point)))))
  5120. (insert " "))
  5121. (unless (or (eobp)
  5122. (string-match (concat "[" (nth 1 erc) "\n]")
  5123. (char-to-string (char-after (point)))))
  5124. (insert " ") (backward-char 1))
  5125. (insert string)
  5126. (and move (backward-char 1))))
  5127. (defconst org-nonsticky-props
  5128. '(mouse-face highlight keymap invisible intangible help-echo org-linked-text htmlize-link))
  5129. (defsubst org-rear-nonsticky-at (pos)
  5130. (add-text-properties (1- pos) pos (list 'rear-nonsticky org-nonsticky-props)))
  5131. (defun org-activate-plain-links (limit)
  5132. "Add link properties for plain links."
  5133. (let (f hl)
  5134. (when (and (re-search-forward (concat org-plain-link-re) limit t)
  5135. (not (member 'org-tag
  5136. (get-text-property (1- (match-beginning 0)) 'face)))
  5137. (not (org-in-src-block-p)))
  5138. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  5139. (setq f (get-text-property (match-beginning 0) 'face))
  5140. (setq hl (org-match-string-no-properties 0))
  5141. (if (or (eq f 'org-tag)
  5142. (and (listp f) (memq 'org-tag f)))
  5143. nil
  5144. (add-text-properties (match-beginning 0) (match-end 0)
  5145. (list 'mouse-face 'highlight
  5146. 'face 'org-link
  5147. 'htmlize-link `(:uri ,hl)
  5148. 'keymap org-mouse-map))
  5149. (org-rear-nonsticky-at (match-end 0)))
  5150. t)))
  5151. (defun org-activate-code (limit)
  5152. (if (re-search-forward "^[ \t]*\\(:\\(?: .*\\|$\\)\n?\\)" limit t)
  5153. (progn
  5154. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  5155. (remove-text-properties (match-beginning 0) (match-end 0)
  5156. '(display t invisible t intangible t))
  5157. t)))
  5158. (defcustom org-src-fontify-natively t
  5159. "When non-nil, fontify code in code blocks."
  5160. :type 'boolean
  5161. :version "24.4"
  5162. :package-version '(Org . "8.3")
  5163. :group 'org-appearance
  5164. :group 'org-babel)
  5165. (defcustom org-allow-promoting-top-level-subtree nil
  5166. "When non-nil, allow promoting a top level subtree.
  5167. The leading star of the top level headline will be replaced
  5168. by a #."
  5169. :type 'boolean
  5170. :version "24.1"
  5171. :group 'org-appearance)
  5172. (defun org-fontify-meta-lines-and-blocks (limit)
  5173. (condition-case nil
  5174. (org-fontify-meta-lines-and-blocks-1 limit)
  5175. (error (message "org-mode fontification error"))))
  5176. (defun org-fontify-meta-lines-and-blocks-1 (limit)
  5177. "Fontify #+ lines and blocks."
  5178. (let ((case-fold-search t))
  5179. (if (re-search-forward
  5180. "^\\([ \t]*#\\(\\(\\+[a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
  5181. limit t)
  5182. (let ((beg (match-beginning 0))
  5183. (block-start (match-end 0))
  5184. (block-end nil)
  5185. (lang (match-string 7))
  5186. (beg1 (line-beginning-position 2))
  5187. (dc1 (downcase (match-string 2)))
  5188. (dc3 (downcase (match-string 3)))
  5189. end end1 quoting block-type ovl)
  5190. (cond
  5191. ((and (match-end 4) (equal dc3 "+begin"))
  5192. ;; Truly a block
  5193. (setq block-type (downcase (match-string 5))
  5194. quoting (member block-type org-protecting-blocks))
  5195. (when (re-search-forward
  5196. (concat "^[ \t]*#\\+end" (match-string 4) "\\>.*")
  5197. nil t) ;; on purpose, we look further than LIMIT
  5198. (setq end (min (point-max) (match-end 0))
  5199. end1 (min (point-max) (1- (match-beginning 0))))
  5200. (setq block-end (match-beginning 0))
  5201. (when quoting
  5202. (org-remove-flyspell-overlays-in beg1 end1)
  5203. (remove-text-properties beg end
  5204. '(display t invisible t intangible t)))
  5205. (add-text-properties
  5206. beg end '(font-lock-fontified t font-lock-multiline t))
  5207. (add-text-properties beg beg1 '(face org-meta-line))
  5208. (org-remove-flyspell-overlays-in beg beg1)
  5209. (add-text-properties ; For end_src
  5210. end1 (min (point-max) (1+ end)) '(face org-meta-line))
  5211. (org-remove-flyspell-overlays-in end1 end)
  5212. (cond
  5213. ((and lang (not (string= lang "")) org-src-fontify-natively)
  5214. (org-src-font-lock-fontify-block lang block-start block-end)
  5215. (add-text-properties beg1 block-end '(src-block t)))
  5216. (quoting
  5217. (add-text-properties beg1 (min (point-max) (1+ end1))
  5218. '(face org-block))) ; end of source block
  5219. ((not org-fontify-quote-and-verse-blocks))
  5220. ((string= block-type "quote")
  5221. (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-quote)))
  5222. ((string= block-type "verse")
  5223. (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-verse))))
  5224. (add-text-properties beg beg1 '(face org-block-begin-line))
  5225. (add-text-properties (min (point-max) (1+ end)) (min (point-max) (1+ end1))
  5226. '(face org-block-end-line))
  5227. t))
  5228. ((member dc1 '("+title:" "+author:" "+email:" "+date:"))
  5229. (org-remove-flyspell-overlays-in
  5230. (match-beginning 0)
  5231. (if (equal "+title:" dc1) (match-end 2) (match-end 0)))
  5232. (add-text-properties
  5233. beg (match-end 3)
  5234. (if (member (intern (substring dc1 1 -1)) org-hidden-keywords)
  5235. '(font-lock-fontified t invisible t)
  5236. '(font-lock-fontified t face org-document-info-keyword)))
  5237. (add-text-properties
  5238. (match-beginning 6) (min (point-max) (1+ (match-end 6)))
  5239. (if (string-equal dc1 "+title:")
  5240. '(font-lock-fontified t face org-document-title)
  5241. '(font-lock-fontified t face org-document-info))))
  5242. ((equal dc1 "+caption:")
  5243. (org-remove-flyspell-overlays-in (match-end 2) (match-end 0))
  5244. (remove-text-properties (match-beginning 0) (match-end 0)
  5245. '(display t invisible t intangible t))
  5246. (add-text-properties (match-beginning 1) (match-end 3)
  5247. '(font-lock-fontified t face org-meta-line))
  5248. (add-text-properties (match-beginning 6) (+ (match-end 6) 1)
  5249. '(font-lock-fontified t face org-block))
  5250. t)
  5251. ((member dc3 '(" " ""))
  5252. (org-remove-flyspell-overlays-in beg (match-end 0))
  5253. (add-text-properties
  5254. beg (match-end 0)
  5255. '(font-lock-fontified t face font-lock-comment-face)))
  5256. (t ;; just any other in-buffer setting, but not indented
  5257. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  5258. (remove-text-properties (match-beginning 0) (match-end 0)
  5259. '(display t invisible t intangible t))
  5260. (add-text-properties beg (match-end 0)
  5261. '(font-lock-fontified t face org-meta-line))
  5262. t))))))
  5263. (defun org-fontify-drawers (limit)
  5264. "Fontify drawers."
  5265. (when (re-search-forward org-drawer-regexp limit t)
  5266. (add-text-properties
  5267. (match-beginning 0) (match-end 0)
  5268. '(font-lock-fontified t face org-special-keyword))
  5269. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  5270. t))
  5271. (defun org-fontify-macros (limit)
  5272. "Fontify macros."
  5273. (when (re-search-forward "\\({{{\\).+?\\(}}}\\)" limit t)
  5274. (add-text-properties
  5275. (match-beginning 0) (match-end 0)
  5276. '(font-lock-fontified t face org-macro))
  5277. (when org-hide-macro-markers
  5278. (add-text-properties (match-end 2) (match-beginning 2)
  5279. '(invisible t))
  5280. (add-text-properties (match-beginning 1) (match-end 1)
  5281. '(invisible t)))
  5282. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  5283. t))
  5284. (defun org-activate-angle-links (limit)
  5285. "Add text properties for angle links."
  5286. (if (and (re-search-forward org-angle-link-re limit t)
  5287. (not (org-in-src-block-p)))
  5288. (progn
  5289. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  5290. (add-text-properties (match-beginning 0) (match-end 0)
  5291. (list 'mouse-face 'highlight
  5292. 'keymap org-mouse-map))
  5293. (org-rear-nonsticky-at (match-end 0))
  5294. t)))
  5295. (defun org-activate-footnote-links (limit)
  5296. "Add text properties for footnotes."
  5297. (let ((fn (org-footnote-next-reference-or-definition limit)))
  5298. (when fn
  5299. (let* ((beg (nth 1 fn))
  5300. (end (nth 2 fn))
  5301. (label (car fn))
  5302. (referencep (/= (line-beginning-position) beg)))
  5303. (when (and referencep (nth 3 fn))
  5304. (save-excursion
  5305. (goto-char beg)
  5306. (search-forward (or label "fn:"))
  5307. (org-remove-flyspell-overlays-in beg (match-end 0))))
  5308. (add-text-properties beg end
  5309. (list 'mouse-face 'highlight
  5310. 'keymap org-mouse-map
  5311. 'help-echo
  5312. (if referencep "Footnote reference"
  5313. "Footnote definition")
  5314. 'font-lock-fontified t
  5315. 'font-lock-multiline t
  5316. 'face 'org-footnote))))))
  5317. (defun org-activate-bracket-links (limit)
  5318. "Add text properties for bracketed links."
  5319. (if (and (re-search-forward org-bracket-link-regexp limit t)
  5320. (not (org-in-src-block-p)))
  5321. (let* ((hl (org-match-string-no-properties 1))
  5322. (help (concat "LINK: " (save-match-data (org-link-unescape hl))))
  5323. (ip (org-maybe-intangible
  5324. (list 'invisible 'org-link
  5325. 'keymap org-mouse-map 'mouse-face 'highlight
  5326. 'font-lock-multiline t 'help-echo help
  5327. 'htmlize-link `(:uri ,hl))))
  5328. (vp (list 'keymap org-mouse-map 'mouse-face 'highlight
  5329. 'font-lock-multiline t 'help-echo help
  5330. 'htmlize-link `(:uri ,hl))))
  5331. ;; We need to remove the invisible property here. Table narrowing
  5332. ;; may have made some of this invisible.
  5333. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  5334. (remove-text-properties (match-beginning 0) (match-end 0)
  5335. '(invisible nil))
  5336. (if (match-end 3)
  5337. (progn
  5338. (add-text-properties (match-beginning 0) (match-beginning 3) ip)
  5339. (org-rear-nonsticky-at (match-beginning 3))
  5340. (add-text-properties (match-beginning 3) (match-end 3) vp)
  5341. (org-rear-nonsticky-at (match-end 3))
  5342. (add-text-properties (match-end 3) (match-end 0) ip)
  5343. (org-rear-nonsticky-at (match-end 0)))
  5344. (add-text-properties (match-beginning 0) (match-beginning 1) ip)
  5345. (org-rear-nonsticky-at (match-beginning 1))
  5346. (add-text-properties (match-beginning 1) (match-end 1) vp)
  5347. (org-rear-nonsticky-at (match-end 1))
  5348. (add-text-properties (match-end 1) (match-end 0) ip)
  5349. (org-rear-nonsticky-at (match-end 0)))
  5350. t)))
  5351. (defun org-activate-dates (limit)
  5352. "Add text properties for dates."
  5353. (if (and (re-search-forward org-tsr-regexp-both limit t)
  5354. (not (equal (char-before (match-beginning 0)) 91)))
  5355. (progn
  5356. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  5357. (add-text-properties (match-beginning 0) (match-end 0)
  5358. (list 'mouse-face 'highlight
  5359. 'keymap org-mouse-map))
  5360. (org-rear-nonsticky-at (match-end 0))
  5361. (when org-display-custom-times
  5362. (if (match-end 3)
  5363. (org-display-custom-time (match-beginning 3) (match-end 3)))
  5364. (org-display-custom-time (match-beginning 1) (match-end 1)))
  5365. t)))
  5366. (defvar org-target-link-regexp nil
  5367. "Regular expression matching radio targets in plain text.")
  5368. (make-variable-buffer-local 'org-target-link-regexp)
  5369. (defconst org-target-regexp (let ((border "[^<>\n\r \t]"))
  5370. (format "<<\\(%s\\|%s[^<>\n\r]*%s\\)>>"
  5371. border border border))
  5372. "Regular expression matching a link target.")
  5373. (defconst org-radio-target-regexp (format "<%s>" org-target-regexp)
  5374. "Regular expression matching a radio target.")
  5375. (defconst org-any-target-regexp
  5376. (format "%s\\|%s" org-radio-target-regexp org-target-regexp)
  5377. "Regular expression matching any target.")
  5378. (defun org-activate-target-links (limit)
  5379. "Add text properties for target matches."
  5380. (when org-target-link-regexp
  5381. (let ((case-fold-search t))
  5382. (if (re-search-forward org-target-link-regexp limit t)
  5383. (progn
  5384. (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
  5385. (add-text-properties (match-beginning 1) (match-end 1)
  5386. (list 'mouse-face 'highlight
  5387. 'keymap org-mouse-map
  5388. 'help-echo "Radio target link"
  5389. 'org-linked-text t))
  5390. (org-rear-nonsticky-at (match-end 1))
  5391. t)))))
  5392. (defun org-update-radio-target-regexp ()
  5393. "Find all radio targets in this file and update the regular expression.
  5394. Also refresh fontification if needed."
  5395. (interactive)
  5396. (let ((old-regexp org-target-link-regexp)
  5397. (before-re "\\(?:^\\|[^[:alnum:]]\\)\\(")
  5398. (after-re "\\)\\(?:$\\|[^[:alnum:]]\\)")
  5399. (targets
  5400. (org-with-wide-buffer
  5401. (goto-char (point-min))
  5402. (let (rtn)
  5403. (while (re-search-forward org-radio-target-regexp nil t)
  5404. ;; Make sure point is really within the object.
  5405. (backward-char)
  5406. (let ((obj (org-element-context)))
  5407. (when (eq (org-element-type obj) 'radio-target)
  5408. (add-to-list 'rtn (org-element-property :value obj)))))
  5409. rtn))))
  5410. (setq org-target-link-regexp
  5411. (and targets
  5412. (concat before-re
  5413. (mapconcat
  5414. (lambda (x)
  5415. (replace-regexp-in-string
  5416. " +" "\\s-+" (regexp-quote x) t t))
  5417. targets
  5418. "\\|")
  5419. after-re)))
  5420. (unless (equal old-regexp org-target-link-regexp)
  5421. ;; Clean-up cache.
  5422. (let ((regexp (cond ((not old-regexp) org-target-link-regexp)
  5423. ((not org-target-link-regexp) old-regexp)
  5424. (t
  5425. (concat before-re
  5426. (mapconcat
  5427. (lambda (re)
  5428. (substring re (length before-re)
  5429. (- (length after-re))))
  5430. (list old-regexp org-target-link-regexp)
  5431. "\\|")
  5432. after-re)))))
  5433. (org-with-wide-buffer
  5434. (goto-char (point-min))
  5435. (while (re-search-forward regexp nil t)
  5436. (org-element-cache-refresh (match-beginning 1)))))
  5437. ;; Re fontify buffer.
  5438. (when (memq 'radio org-highlight-links)
  5439. (org-restart-font-lock)))))
  5440. (defun org-hide-wide-columns (limit)
  5441. (let (s e)
  5442. (setq s (text-property-any (point) (or limit (point-max))
  5443. 'org-cwidth t))
  5444. (when s
  5445. (setq e (next-single-property-change s 'org-cwidth))
  5446. (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
  5447. (goto-char e)
  5448. t)))
  5449. (defvar org-latex-and-related-regexp nil
  5450. "Regular expression for highlighting LaTeX, entities and sub/superscript.")
  5451. (defun org-compute-latex-and-related-regexp ()
  5452. "Compute regular expression for LaTeX, entities and sub/superscript.
  5453. Result depends on variable `org-highlight-latex-and-related'."
  5454. (org-set-local
  5455. 'org-latex-and-related-regexp
  5456. (let* ((re-sub
  5457. (cond ((not (memq 'script org-highlight-latex-and-related)) nil)
  5458. ((eq org-use-sub-superscripts '{})
  5459. (list org-match-substring-with-braces-regexp))
  5460. (org-use-sub-superscripts (list org-match-substring-regexp))))
  5461. (re-latex
  5462. (when (memq 'latex org-highlight-latex-and-related)
  5463. (let ((matchers (plist-get org-format-latex-options :matchers)))
  5464. (delq nil
  5465. (mapcar (lambda (x)
  5466. (and (member (car x) matchers) (nth 1 x)))
  5467. org-latex-regexps)))))
  5468. (re-entities
  5469. (when (memq 'entities org-highlight-latex-and-related)
  5470. (list "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)"))))
  5471. (mapconcat 'identity (append re-latex re-entities re-sub) "\\|"))))
  5472. (defun org-do-latex-and-related (limit)
  5473. "Highlight LaTeX snippets and environments, entities and sub/superscript.
  5474. LIMIT bounds the search for syntax to highlight. Stop at first
  5475. highlighted object, if any. Return t if some highlighting was
  5476. done, nil otherwise."
  5477. (when (org-string-nw-p org-latex-and-related-regexp)
  5478. (catch 'found
  5479. (while (re-search-forward org-latex-and-related-regexp limit t)
  5480. (unless (memq (car-safe (get-text-property (1+ (match-beginning 0))
  5481. 'face))
  5482. '(org-code org-verbatim underline))
  5483. (let ((offset (if (memq (char-after (1+ (match-beginning 0)))
  5484. '(?_ ?^))
  5485. 1
  5486. 0)))
  5487. (font-lock-prepend-text-property
  5488. (+ offset (match-beginning 0)) (match-end 0)
  5489. 'face 'org-latex-and-related)
  5490. (add-text-properties (+ offset (match-beginning 0)) (match-end 0)
  5491. '(font-lock-multiline t)))
  5492. (throw 'found t)))
  5493. nil)))
  5494. (defun org-restart-font-lock ()
  5495. "Restart `font-lock-mode', to force refontification."
  5496. (when (and (boundp 'font-lock-mode) font-lock-mode)
  5497. (font-lock-mode -1)
  5498. (font-lock-mode 1)))
  5499. (defun org-activate-tags (limit)
  5500. (if (re-search-forward (org-re "^\\*+.*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \r\n]") limit t)
  5501. (progn
  5502. (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
  5503. (add-text-properties (match-beginning 1) (match-end 1)
  5504. (list 'mouse-face 'highlight
  5505. 'keymap org-mouse-map))
  5506. (org-rear-nonsticky-at (match-end 1))
  5507. t)))
  5508. (defun org-outline-level ()
  5509. "Compute the outline level of the heading at point.
  5510. If this is called at a normal headline, the level is the number
  5511. of stars. Use `org-reduced-level' to remove the effect of
  5512. `org-odd-levels'. Unlike to `org-current-level', this function
  5513. takes into consideration inlinetasks."
  5514. (org-with-wide-buffer
  5515. (end-of-line)
  5516. (if (re-search-backward org-outline-regexp-bol nil t)
  5517. (1- (- (match-end 0) (match-beginning 0)))
  5518. 0)))
  5519. (defvar org-font-lock-keywords nil)
  5520. (defsubst org-re-property (property &optional literal allow-null value)
  5521. "Return a regexp matching a PROPERTY line.
  5522. When optional argument LITERAL is non-nil, do not quote PROPERTY.
  5523. This is useful when PROPERTY is a regexp. When ALLOW-NULL is
  5524. non-nil, match properties even without a value.
  5525. Match group 3 is set to the value when it exists. If there is no
  5526. value and ALLOW-NULL is non-nil, it is set to the empty string.
  5527. With optional argument VALUE, match only property lines with
  5528. that value; in this case, ALLOW-NULL is ignored. VALUE is quoted
  5529. unless LITERAL is non-nil."
  5530. (concat
  5531. "^\\(?4:[ \t]*\\)"
  5532. (format "\\(?1::\\(?2:%s\\):\\)"
  5533. (if literal property (regexp-quote property)))
  5534. (cond (value
  5535. (format "[ \t]+\\(?3:%s\\)\\(?5:[ \t]*\\)$"
  5536. (if literal value (regexp-quote value))))
  5537. (allow-null
  5538. "\\(?:\\(?3:$\\)\\|[ \t]+\\(?3:.*?\\)\\)\\(?5:[ \t]*\\)$")
  5539. (t
  5540. "[ \t]+\\(?3:[^ \r\t\n]+.*?\\)\\(?5:[ \t]*\\)$"))))
  5541. (defconst org-property-re
  5542. (org-re-property "\\S-+" 'literal t)
  5543. "Regular expression matching a property line.
  5544. There are four matching groups:
  5545. 1: :PROPKEY: including the leading and trailing colon,
  5546. 2: PROPKEY without the leading and trailing colon,
  5547. 3: PROPVAL without leading or trailing spaces,
  5548. 4: the indentation of the current line,
  5549. 5: trailing whitespace.")
  5550. (defvar org-font-lock-hook nil
  5551. "Functions to be called for special font lock stuff.")
  5552. (defvar org-font-lock-set-keywords-hook nil
  5553. "Functions that can manipulate `org-font-lock-extra-keywords'.
  5554. This is called after `org-font-lock-extra-keywords' is defined, but before
  5555. it is installed to be used by font lock. This can be useful if something
  5556. needs to be inserted at a specific position in the font-lock sequence.")
  5557. (defun org-font-lock-hook (limit)
  5558. "Run `org-font-lock-hook' within LIMIT."
  5559. (run-hook-with-args 'org-font-lock-hook limit))
  5560. (defun org-set-font-lock-defaults ()
  5561. "Set font lock defaults for the current buffer."
  5562. (let* ((em org-fontify-emphasized-text)
  5563. (lk org-highlight-links)
  5564. (org-font-lock-extra-keywords
  5565. (list
  5566. ;; Call the hook
  5567. '(org-font-lock-hook)
  5568. ;; Headlines
  5569. `(,(if org-fontify-whole-heading-line
  5570. "^\\(\\**\\)\\(\\* \\)\\(.*\n?\\)"
  5571. "^\\(\\**\\)\\(\\* \\)\\(.*\\)")
  5572. (1 (org-get-level-face 1))
  5573. (2 (org-get-level-face 2))
  5574. (3 (org-get-level-face 3)))
  5575. ;; Table lines
  5576. '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
  5577. (1 'org-table t))
  5578. ;; Table internals
  5579. '("^[ \t]*|\\(?:.*?|\\)? *\\(:?=[^|\n]*\\)" (1 'org-formula t))
  5580. '("^[ \t]*| *\\([#*]\\) *|" (1 'org-formula t))
  5581. '("^[ \t]*|\\( *\\([$!_^/]\\) *|.*\\)|" (1 'org-formula t))
  5582. '("| *\\(<[lrc]?[0-9]*>\\)" (1 'org-formula t))
  5583. ;; Drawers
  5584. '(org-fontify-drawers)
  5585. ;; Properties
  5586. (list org-property-re
  5587. '(1 'org-special-keyword t)
  5588. '(3 'org-property-value t))
  5589. ;; Links
  5590. (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
  5591. (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
  5592. (if (memq 'plain lk) '(org-activate-plain-links (0 'org-link t)))
  5593. (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
  5594. (if (memq 'radio lk) '(org-activate-target-links (1 'org-link t)))
  5595. (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
  5596. (if (memq 'footnote lk) '(org-activate-footnote-links))
  5597. ;; Targets.
  5598. (list org-any-target-regexp '(0 'org-target t))
  5599. ;; Diary sexps.
  5600. '("^&?%%(.*\\|<%%([^>\n]*?>" (0 'org-sexp-date t))
  5601. ;; Macro
  5602. '(org-fontify-macros)
  5603. '(org-hide-wide-columns (0 nil append))
  5604. ;; TODO keyword
  5605. (list (format org-heading-keyword-regexp-format
  5606. org-todo-regexp)
  5607. '(2 (org-get-todo-face 2) t))
  5608. ;; DONE
  5609. (if org-fontify-done-headline
  5610. (list (format org-heading-keyword-regexp-format
  5611. (concat
  5612. "\\(?:"
  5613. (mapconcat 'regexp-quote org-done-keywords "\\|")
  5614. "\\)"))
  5615. '(2 'org-headline-done t))
  5616. nil)
  5617. ;; Priorities
  5618. '(org-font-lock-add-priority-faces)
  5619. ;; Tags
  5620. '(org-font-lock-add-tag-faces)
  5621. ;; Tags groups
  5622. (if (and org-group-tags org-tag-groups-alist)
  5623. (list (concat org-outline-regexp-bol ".+\\(:"
  5624. (regexp-opt (mapcar 'car org-tag-groups-alist))
  5625. ":\\).*$")
  5626. '(1 'org-tag-group prepend)))
  5627. ;; Special keywords
  5628. (list (concat "\\<" org-comment-string) '(0 'org-special-keyword t))
  5629. (list (concat "\\<" org-deadline-string) '(0 'org-special-keyword t))
  5630. (list (concat "\\<" org-scheduled-string) '(0 'org-special-keyword t))
  5631. (list (concat "\\<" org-closed-string) '(0 'org-special-keyword t))
  5632. (list (concat "\\<" org-clock-string) '(0 'org-special-keyword t))
  5633. ;; Emphasis
  5634. (if em
  5635. (if (featurep 'xemacs)
  5636. '(org-do-emphasis-faces (0 nil append))
  5637. '(org-do-emphasis-faces)))
  5638. ;; Checkboxes
  5639. '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
  5640. 1 'org-checkbox prepend)
  5641. (if (cdr (assq 'checkbox org-list-automatic-rules))
  5642. '("\\[\\([0-9]*%\\)\\]\\|\\[\\([0-9]*\\)/\\([0-9]*\\)\\]"
  5643. (0 (org-get-checkbox-statistics-face) t)))
  5644. ;; Description list items
  5645. '("^[ \t]*[-+*][ \t]+\\(.*?[ \t]+::\\)\\([ \t]+\\|$\\)"
  5646. 1 'org-list-dt prepend)
  5647. ;; ARCHIVEd headings
  5648. (list (concat
  5649. org-outline-regexp-bol
  5650. "\\(.*:" org-archive-tag ":.*\\)")
  5651. '(1 'org-archived prepend))
  5652. ;; Specials
  5653. '(org-do-latex-and-related)
  5654. '(org-fontify-entities)
  5655. '(org-raise-scripts)
  5656. ;; Code
  5657. '(org-activate-code (1 'org-code t))
  5658. ;; COMMENT
  5659. (list (format
  5660. "^\\*\\(?: +%s\\)?\\(?: +\\[#[A-Z0-9]\\]\\)? +\\(?9:%s\\)\\(?: \\|$\\)"
  5661. org-todo-regexp
  5662. org-comment-string)
  5663. '(9 'org-special-keyword t))
  5664. ;; Blocks and meta lines
  5665. '(org-fontify-meta-lines-and-blocks))))
  5666. (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
  5667. (run-hooks 'org-font-lock-set-keywords-hook)
  5668. ;; Now set the full font-lock-keywords
  5669. (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
  5670. (org-set-local 'font-lock-defaults
  5671. '(org-font-lock-keywords t nil nil backward-paragraph))
  5672. (kill-local-variable 'font-lock-keywords) nil))
  5673. (defun org-toggle-pretty-entities ()
  5674. "Toggle the composition display of entities as UTF8 characters."
  5675. (interactive)
  5676. (org-set-local 'org-pretty-entities (not org-pretty-entities))
  5677. (org-restart-font-lock)
  5678. (if org-pretty-entities
  5679. (message "Entities are now displayed as UTF8 characters")
  5680. (save-restriction
  5681. (widen)
  5682. (org-decompose-region (point-min) (point-max))
  5683. (message "Entities are now displayed as plain text"))))
  5684. (defvar org-custom-properties-overlays nil
  5685. "List of overlays used for custom properties.")
  5686. (make-variable-buffer-local 'org-custom-properties-overlays)
  5687. (defun org-toggle-custom-properties-visibility ()
  5688. "Display or hide properties in `org-custom-properties'."
  5689. (interactive)
  5690. (if org-custom-properties-overlays
  5691. (progn (mapc #'delete-overlay org-custom-properties-overlays)
  5692. (setq org-custom-properties-overlays nil))
  5693. (when org-custom-properties
  5694. (org-with-wide-buffer
  5695. (goto-char (point-min))
  5696. (let ((regexp (org-re-property (regexp-opt org-custom-properties) t t)))
  5697. (while (re-search-forward regexp nil t)
  5698. (let ((end (cdr (save-match-data (org-get-property-block)))))
  5699. (when (and end (< (point) end))
  5700. ;; Hide first custom property in current drawer.
  5701. (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
  5702. (overlay-put o 'invisible t)
  5703. (overlay-put o 'org-custom-property t)
  5704. (push o org-custom-properties-overlays))
  5705. ;; Hide additional custom properties in the same drawer.
  5706. (while (re-search-forward regexp end t)
  5707. (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
  5708. (overlay-put o 'invisible t)
  5709. (overlay-put o 'org-custom-property t)
  5710. (push o org-custom-properties-overlays)))))
  5711. ;; Each entry is limited to a single property drawer.
  5712. (outline-next-heading)))))))
  5713. (defun org-fontify-entities (limit)
  5714. "Find an entity to fontify."
  5715. (let (ee)
  5716. (when org-pretty-entities
  5717. (catch 'match
  5718. ;; "\_ "-family is left out on purpose. Only the first one,
  5719. ;; i.e., "\_ ", could be fontified anyway, and it would be
  5720. ;; confusing when adding a second white space character.
  5721. (while (re-search-forward
  5722. "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]\n]\\)"
  5723. limit t)
  5724. (if (and (not (org-at-comment-p))
  5725. (setq ee (org-entity-get (match-string 1)))
  5726. (= (length (nth 6 ee)) 1))
  5727. (let*
  5728. ((end (if (equal (match-string 2) "{}")
  5729. (match-end 2)
  5730. (match-end 1))))
  5731. (add-text-properties
  5732. (match-beginning 0) end
  5733. (list 'font-lock-fontified t))
  5734. (compose-region (match-beginning 0) end
  5735. (nth 6 ee) nil)
  5736. (backward-char 1)
  5737. (throw 'match t))))
  5738. nil))))
  5739. (defun org-fontify-like-in-org-mode (s &optional odd-levels)
  5740. "Fontify string S like in Org-mode."
  5741. (with-temp-buffer
  5742. (insert s)
  5743. (let ((org-odd-levels-only odd-levels))
  5744. (org-mode)
  5745. (font-lock-ensure)
  5746. (buffer-string))))
  5747. (defvar org-m nil)
  5748. (defvar org-l nil)
  5749. (defvar org-f nil)
  5750. (defun org-get-level-face (n)
  5751. "Get the right face for match N in font-lock matching of headlines."
  5752. (setq org-l (- (match-end 2) (match-beginning 1) 1))
  5753. (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
  5754. (if org-cycle-level-faces
  5755. (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
  5756. (setq org-f (nth (1- (min org-l org-n-level-faces)) org-level-faces)))
  5757. (cond
  5758. ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
  5759. ((eq n 2) org-f)
  5760. (t (if org-level-color-stars-only nil org-f))))
  5761. (defun org-get-todo-face (kwd)
  5762. "Get the right face for a TODO keyword KWD.
  5763. If KWD is a number, get the corresponding match group."
  5764. (if (numberp kwd) (setq kwd (match-string kwd)))
  5765. (or (org-face-from-face-or-color
  5766. 'todo 'org-todo (cdr (assoc kwd org-todo-keyword-faces)))
  5767. (and (member kwd org-done-keywords) 'org-done)
  5768. 'org-todo))
  5769. (defun org-face-from-face-or-color (context inherit face-or-color)
  5770. "Create a face list that inherits INHERIT, but sets the foreground color.
  5771. When FACE-OR-COLOR is not a string, just return it."
  5772. (if (stringp face-or-color)
  5773. (list :inherit inherit
  5774. (cdr (assoc context org-faces-easy-properties))
  5775. face-or-color)
  5776. face-or-color))
  5777. (defun org-font-lock-add-tag-faces (limit)
  5778. "Add the special tag faces."
  5779. (when (and org-tag-faces org-tags-special-faces-re)
  5780. (while (re-search-forward org-tags-special-faces-re limit t)
  5781. (add-text-properties (match-beginning 1) (match-end 1)
  5782. (list 'face (org-get-tag-face 1)
  5783. 'font-lock-fontified t))
  5784. (backward-char 1))))
  5785. (defun org-font-lock-add-priority-faces (limit)
  5786. "Add the special priority faces."
  5787. (while (re-search-forward "\\[#\\([A-Z0-9]\\)\\]" limit t)
  5788. (when (save-match-data (org-at-heading-p))
  5789. (add-text-properties
  5790. (match-beginning 0) (match-end 0)
  5791. (list 'face (or (org-face-from-face-or-color
  5792. 'priority 'org-priority
  5793. (cdr (assoc (char-after (match-beginning 1))
  5794. org-priority-faces)))
  5795. 'org-priority)
  5796. 'font-lock-fontified t)))))
  5797. (defun org-get-tag-face (kwd)
  5798. "Get the right face for a TODO keyword KWD.
  5799. If KWD is a number, get the corresponding match group."
  5800. (if (numberp kwd) (setq kwd (match-string kwd)))
  5801. (or (org-face-from-face-or-color
  5802. 'tag 'org-tag (cdr (assoc kwd org-tag-faces)))
  5803. 'org-tag))
  5804. (defun org-unfontify-region (beg end &optional maybe_loudly)
  5805. "Remove fontification and activation overlays from links."
  5806. (font-lock-default-unfontify-region beg end)
  5807. (let* ((buffer-undo-list t)
  5808. (inhibit-read-only t) (inhibit-point-motion-hooks t)
  5809. (inhibit-modification-hooks t)
  5810. deactivate-mark buffer-file-name buffer-file-truename)
  5811. (org-decompose-region beg end)
  5812. (remove-text-properties beg end
  5813. '(mouse-face t keymap t org-linked-text t
  5814. invisible t intangible t
  5815. org-emphasis t))
  5816. (org-remove-font-lock-display-properties beg end)))
  5817. (defconst org-script-display '(((raise -0.3) (height 0.7))
  5818. ((raise 0.3) (height 0.7))
  5819. ((raise -0.5))
  5820. ((raise 0.5)))
  5821. "Display properties for showing superscripts and subscripts.")
  5822. (defun org-remove-font-lock-display-properties (beg end)
  5823. "Remove specific display properties that have been added by font lock.
  5824. The will remove the raise properties that are used to show superscripts
  5825. and subscripts."
  5826. (let (next prop)
  5827. (while (< beg end)
  5828. (setq next (next-single-property-change beg 'display nil end)
  5829. prop (get-text-property beg 'display))
  5830. (if (member prop org-script-display)
  5831. (put-text-property beg next 'display nil))
  5832. (setq beg next))))
  5833. (defun org-raise-scripts (limit)
  5834. "Add raise properties to sub/superscripts."
  5835. (when (and org-pretty-entities org-pretty-entities-include-sub-superscripts)
  5836. (if (re-search-forward
  5837. (if (eq org-use-sub-superscripts t)
  5838. org-match-substring-regexp
  5839. org-match-substring-with-braces-regexp)
  5840. limit t)
  5841. (let* ((pos (point)) table-p comment-p
  5842. (mpos (match-beginning 3))
  5843. (emph-p (get-text-property mpos 'org-emphasis))
  5844. (link-p (get-text-property mpos 'mouse-face))
  5845. (keyw-p (eq 'org-special-keyword (get-text-property mpos 'face))))
  5846. (goto-char (point-at-bol))
  5847. (setq table-p (org-looking-at-p org-table-dataline-regexp)
  5848. comment-p (org-looking-at-p "^[ \t]*#[ +]"))
  5849. (goto-char pos)
  5850. ;; Handle a_b^c
  5851. (if (member (char-after) '(?_ ?^)) (goto-char (1- pos)))
  5852. (if (or comment-p emph-p link-p keyw-p)
  5853. t
  5854. (put-text-property (match-beginning 3) (match-end 0)
  5855. 'display
  5856. (if (equal (char-after (match-beginning 2)) ?^)
  5857. (nth (if table-p 3 1) org-script-display)
  5858. (nth (if table-p 2 0) org-script-display)))
  5859. (add-text-properties (match-beginning 2) (match-end 2)
  5860. (list 'invisible t
  5861. 'org-dwidth t 'org-dwidth-n 1))
  5862. (if (and (eq (char-after (match-beginning 3)) ?{)
  5863. (eq (char-before (match-end 3)) ?}))
  5864. (progn
  5865. (add-text-properties
  5866. (match-beginning 3) (1+ (match-beginning 3))
  5867. (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))
  5868. (add-text-properties
  5869. (1- (match-end 3)) (match-end 3)
  5870. (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))))
  5871. t)))))
  5872. ;;;; Visibility cycling, including org-goto and indirect buffer
  5873. ;;; Cycling
  5874. (defvar org-cycle-global-status nil)
  5875. (make-variable-buffer-local 'org-cycle-global-status)
  5876. (put 'org-cycle-global-status 'org-state t)
  5877. (defvar org-cycle-subtree-status nil)
  5878. (make-variable-buffer-local 'org-cycle-subtree-status)
  5879. (put 'org-cycle-subtree-status 'org-state t)
  5880. (defvar org-inlinetask-min-level)
  5881. (defun org-unlogged-message (&rest args)
  5882. "Display a message, but avoid logging it in the *Messages* buffer."
  5883. (let ((message-log-max nil))
  5884. (apply 'message args)))
  5885. ;;;###autoload
  5886. (defun org-cycle (&optional arg)
  5887. "TAB-action and visibility cycling for Org-mode.
  5888. This is the command invoked in Org-mode by the TAB key. Its main purpose
  5889. is outline visibility cycling, but it also invokes other actions
  5890. in special contexts.
  5891. - When this function is called with a prefix argument, rotate the entire
  5892. buffer through 3 states (global cycling)
  5893. 1. OVERVIEW: Show only top-level headlines.
  5894. 2. CONTENTS: Show all headlines of all levels, but no body text.
  5895. 3. SHOW ALL: Show everything.
  5896. When called with two `C-u C-u' prefixes, switch to the startup visibility,
  5897. determined by the variable `org-startup-folded', and by any VISIBILITY
  5898. properties in the buffer.
  5899. When called with three `C-u C-u C-u' prefixed, show the entire buffer,
  5900. including any drawers.
  5901. - When inside a table, re-align the table and move to the next field.
  5902. - When point is at the beginning of a headline, rotate the subtree started
  5903. by this line through 3 different states (local cycling)
  5904. 1. FOLDED: Only the main headline is shown.
  5905. 2. CHILDREN: The main headline and the direct children are shown.
  5906. From this state, you can move to one of the children
  5907. and zoom in further.
  5908. 3. SUBTREE: Show the entire subtree, including body text.
  5909. If there is no subtree, switch directly from CHILDREN to FOLDED.
  5910. - When point is at the beginning of an empty headline and the variable
  5911. `org-cycle-level-after-item/entry-creation' is set, cycle the level
  5912. of the headline by demoting and promoting it to likely levels. This
  5913. speeds up creation document structure by pressing TAB once or several
  5914. times right after creating a new headline.
  5915. - When there is a numeric prefix, go up to a heading with level ARG, do
  5916. a `show-subtree' and return to the previous cursor position. If ARG
  5917. is negative, go up that many levels.
  5918. - When point is not at the beginning of a headline, execute the global
  5919. binding for TAB, which is re-indenting the line. See the option
  5920. `org-cycle-emulate-tab' for details.
  5921. - Special case: if point is at the beginning of the buffer and there is
  5922. no headline in line 1, this function will act as if called with prefix arg
  5923. (C-u TAB, same as S-TAB) also when called without prefix arg.
  5924. But only if also the variable `org-cycle-global-at-bob' is t."
  5925. (interactive "P")
  5926. (org-load-modules-maybe)
  5927. (unless (or (run-hook-with-args-until-success 'org-tab-first-hook)
  5928. (and org-cycle-level-after-item/entry-creation
  5929. (or (org-cycle-level)
  5930. (org-cycle-item-indentation))))
  5931. (let* ((limit-level
  5932. (or org-cycle-max-level
  5933. (and (boundp 'org-inlinetask-min-level)
  5934. org-inlinetask-min-level
  5935. (1- org-inlinetask-min-level))))
  5936. (nstars (and limit-level
  5937. (if org-odd-levels-only
  5938. (and limit-level (1- (* limit-level 2)))
  5939. limit-level)))
  5940. (org-outline-regexp
  5941. (if (not (derived-mode-p 'org-mode))
  5942. outline-regexp
  5943. (concat "\\*" (if nstars (format "\\{1,%d\\} " nstars) "+ "))))
  5944. (bob-special (and org-cycle-global-at-bob (not arg) (bobp)
  5945. (not (looking-at org-outline-regexp))))
  5946. (org-cycle-hook
  5947. (if bob-special
  5948. (delq 'org-optimize-window-after-visibility-change
  5949. (copy-sequence org-cycle-hook))
  5950. org-cycle-hook))
  5951. (pos (point)))
  5952. (if (or bob-special (equal arg '(4)))
  5953. ;; special case: use global cycling
  5954. (setq arg t))
  5955. (cond
  5956. ((equal arg '(16))
  5957. (setq last-command 'dummy)
  5958. (org-set-startup-visibility)
  5959. (org-unlogged-message "Startup visibility, plus VISIBILITY properties"))
  5960. ((equal arg '(64))
  5961. (show-all)
  5962. (org-unlogged-message "Entire buffer visible, including drawers"))
  5963. ;; Try cdlatex TAB completion
  5964. ((org-try-cdlatex-tab))
  5965. ;; Table: enter it or move to the next field.
  5966. ((org-at-table-p 'any)
  5967. (if (org-at-table.el-p)
  5968. (message "Use C-c ' to edit table.el tables")
  5969. (if arg (org-table-edit-field t)
  5970. (org-table-justify-field-maybe)
  5971. (call-interactively 'org-table-next-field))))
  5972. ((run-hook-with-args-until-success
  5973. 'org-tab-after-check-for-table-hook))
  5974. ;; Global cycling: delegate to `org-cycle-internal-global'.
  5975. ((eq arg t) (org-cycle-internal-global))
  5976. ;; Drawers: delegate to `org-flag-drawer'.
  5977. ((save-excursion
  5978. (beginning-of-line 1)
  5979. (looking-at org-drawer-regexp))
  5980. (org-flag-drawer ; toggle block visibility
  5981. (not (get-char-property (match-end 0) 'invisible))))
  5982. ;; Show-subtree, ARG levels up from here.
  5983. ((integerp arg)
  5984. (save-excursion
  5985. (org-back-to-heading)
  5986. (outline-up-heading (if (< arg 0) (- arg)
  5987. (- (funcall outline-level) arg)))
  5988. (org-show-subtree)))
  5989. ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
  5990. ((and (featurep 'org-inlinetask)
  5991. (org-inlinetask-at-task-p)
  5992. (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
  5993. (org-inlinetask-toggle-visibility))
  5994. ;; At an item/headline: delegate to `org-cycle-internal-local'.
  5995. ((and (or (and org-cycle-include-plain-lists (org-at-item-p))
  5996. (save-excursion (move-beginning-of-line 1)
  5997. (looking-at org-outline-regexp)))
  5998. (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
  5999. (org-cycle-internal-local))
  6000. ;; From there: TAB emulation and template completion.
  6001. (buffer-read-only (org-back-to-heading))
  6002. ((run-hook-with-args-until-success
  6003. 'org-tab-after-check-for-cycling-hook))
  6004. ((org-try-structure-completion))
  6005. ((run-hook-with-args-until-success
  6006. 'org-tab-before-tab-emulation-hook))
  6007. ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
  6008. (or (not (bolp))
  6009. (not (looking-at org-outline-regexp))))
  6010. (call-interactively (global-key-binding "\t")))
  6011. ((if (and (memq org-cycle-emulate-tab '(white whitestart))
  6012. (save-excursion (beginning-of-line 1) (looking-at "[ \t]*"))
  6013. (or (and (eq org-cycle-emulate-tab 'white)
  6014. (= (match-end 0) (point-at-eol)))
  6015. (and (eq org-cycle-emulate-tab 'whitestart)
  6016. (>= (match-end 0) pos))))
  6017. t
  6018. (eq org-cycle-emulate-tab t))
  6019. (call-interactively (global-key-binding "\t")))
  6020. (t (save-excursion
  6021. (org-back-to-heading)
  6022. (org-cycle)))))))
  6023. (defun org-cycle-internal-global ()
  6024. "Do the global cycling action."
  6025. ;; Hack to avoid display of messages for .org attachments in Gnus
  6026. (let ((ga (string-match "\\*fontification" (buffer-name))))
  6027. (cond
  6028. ((and (eq last-command this-command)
  6029. (eq org-cycle-global-status 'overview))
  6030. ;; We just created the overview - now do table of contents
  6031. ;; This can be slow in very large buffers, so indicate action
  6032. (run-hook-with-args 'org-pre-cycle-hook 'contents)
  6033. (unless ga (org-unlogged-message "CONTENTS..."))
  6034. (org-content)
  6035. (unless ga (org-unlogged-message "CONTENTS...done"))
  6036. (setq org-cycle-global-status 'contents)
  6037. (run-hook-with-args 'org-cycle-hook 'contents))
  6038. ((and (eq last-command this-command)
  6039. (eq org-cycle-global-status 'contents))
  6040. ;; We just showed the table of contents - now show everything
  6041. (run-hook-with-args 'org-pre-cycle-hook 'all)
  6042. (show-all)
  6043. (unless ga (org-unlogged-message "SHOW ALL"))
  6044. (setq org-cycle-global-status 'all)
  6045. (run-hook-with-args 'org-cycle-hook 'all))
  6046. (t
  6047. ;; Default action: go to overview
  6048. (run-hook-with-args 'org-pre-cycle-hook 'overview)
  6049. (org-overview)
  6050. (unless ga (org-unlogged-message "OVERVIEW"))
  6051. (setq org-cycle-global-status 'overview)
  6052. (run-hook-with-args 'org-cycle-hook 'overview)))))
  6053. (defvar org-called-with-limited-levels nil
  6054. "Non-nil when `org-with-limited-levels' is currently active.")
  6055. (defun org-cycle-internal-local ()
  6056. "Do the local cycling action."
  6057. (let ((goal-column 0) eoh eol eos has-children children-skipped struct)
  6058. ;; First, determine end of headline (EOH), end of subtree or item
  6059. ;; (EOS), and if item or heading has children (HAS-CHILDREN).
  6060. (save-excursion
  6061. (if (org-at-item-p)
  6062. (progn
  6063. (beginning-of-line)
  6064. (setq struct (org-list-struct))
  6065. (setq eoh (point-at-eol))
  6066. (setq eos (org-list-get-item-end-before-blank (point) struct))
  6067. (setq has-children (org-list-has-child-p (point) struct)))
  6068. (org-back-to-heading)
  6069. (setq eoh (save-excursion (outline-end-of-heading) (point)))
  6070. (setq eos (save-excursion (org-end-of-subtree t t)
  6071. (when (bolp) (backward-char)) (point)))
  6072. (setq has-children
  6073. (or (save-excursion
  6074. (let ((level (funcall outline-level)))
  6075. (outline-next-heading)
  6076. (and (org-at-heading-p t)
  6077. (> (funcall outline-level) level))))
  6078. (save-excursion
  6079. (org-list-search-forward (org-item-beginning-re) eos t)))))
  6080. ;; Determine end invisible part of buffer (EOL)
  6081. (beginning-of-line 2)
  6082. ;; XEmacs doesn't have `next-single-char-property-change'
  6083. (if (featurep 'xemacs)
  6084. (while (and (not (eobp)) ;; this is like `next-line'
  6085. (get-char-property (1- (point)) 'invisible))
  6086. (beginning-of-line 2))
  6087. (while (and (not (eobp)) ;; this is like `next-line'
  6088. (get-char-property (1- (point)) 'invisible))
  6089. (goto-char (next-single-char-property-change (point) 'invisible))
  6090. (and (eolp) (beginning-of-line 2))))
  6091. (setq eol (point)))
  6092. ;; Find out what to do next and set `this-command'
  6093. (cond
  6094. ((= eos eoh)
  6095. ;; Nothing is hidden behind this heading
  6096. (unless (org-before-first-heading-p)
  6097. (run-hook-with-args 'org-pre-cycle-hook 'empty))
  6098. (org-unlogged-message "EMPTY ENTRY")
  6099. (setq org-cycle-subtree-status nil)
  6100. (save-excursion
  6101. (goto-char eos)
  6102. (outline-next-heading)
  6103. (if (outline-invisible-p) (org-flag-heading nil))))
  6104. ((and (or (>= eol eos)
  6105. (not (string-match "\\S-" (buffer-substring eol eos))))
  6106. (or has-children
  6107. (not (setq children-skipped
  6108. org-cycle-skip-children-state-if-no-children))))
  6109. ;; Entire subtree is hidden in one line: children view
  6110. (unless (org-before-first-heading-p)
  6111. (run-hook-with-args 'org-pre-cycle-hook 'children))
  6112. (if (org-at-item-p)
  6113. (org-list-set-item-visibility (point-at-bol) struct 'children)
  6114. (org-show-entry)
  6115. (org-with-limited-levels (show-children))
  6116. ;; FIXME: This slows down the func way too much.
  6117. ;; How keep drawers hidden in subtree anyway?
  6118. ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
  6119. ;; (org-cycle-hide-drawers 'subtree))
  6120. ;; Fold every list in subtree to top-level items.
  6121. (when (eq org-cycle-include-plain-lists 'integrate)
  6122. (save-excursion
  6123. (org-back-to-heading)
  6124. (while (org-list-search-forward (org-item-beginning-re) eos t)
  6125. (beginning-of-line 1)
  6126. (let* ((struct (org-list-struct))
  6127. (prevs (org-list-prevs-alist struct))
  6128. (end (org-list-get-bottom-point struct)))
  6129. (mapc (lambda (e) (org-list-set-item-visibility e struct 'folded))
  6130. (org-list-get-all-items (point) struct prevs))
  6131. (goto-char (if (< end eos) end eos)))))))
  6132. (org-unlogged-message "CHILDREN")
  6133. (save-excursion
  6134. (goto-char eos)
  6135. (outline-next-heading)
  6136. (if (outline-invisible-p) (org-flag-heading nil)))
  6137. (setq org-cycle-subtree-status 'children)
  6138. (unless (org-before-first-heading-p)
  6139. (run-hook-with-args 'org-cycle-hook 'children)))
  6140. ((or children-skipped
  6141. (and (eq last-command this-command)
  6142. (eq org-cycle-subtree-status 'children)))
  6143. ;; We just showed the children, or no children are there,
  6144. ;; now show everything.
  6145. (unless (org-before-first-heading-p)
  6146. (run-hook-with-args 'org-pre-cycle-hook 'subtree))
  6147. (outline-flag-region eoh eos nil)
  6148. (org-unlogged-message
  6149. (if children-skipped "SUBTREE (NO CHILDREN)" "SUBTREE"))
  6150. (setq org-cycle-subtree-status 'subtree)
  6151. (unless (org-before-first-heading-p)
  6152. (run-hook-with-args 'org-cycle-hook 'subtree)))
  6153. (t
  6154. ;; Default action: hide the subtree.
  6155. (run-hook-with-args 'org-pre-cycle-hook 'folded)
  6156. (outline-flag-region eoh eos t)
  6157. (org-unlogged-message "FOLDED")
  6158. (setq org-cycle-subtree-status 'folded)
  6159. (unless (org-before-first-heading-p)
  6160. (run-hook-with-args 'org-cycle-hook 'folded))))))
  6161. ;;;###autoload
  6162. (defun org-global-cycle (&optional arg)
  6163. "Cycle the global visibility. For details see `org-cycle'.
  6164. With \\[universal-argument] prefix arg, switch to startup visibility.
  6165. With a numeric prefix, show all headlines up to that level."
  6166. (interactive "P")
  6167. (let ((org-cycle-include-plain-lists
  6168. (if (derived-mode-p 'org-mode) org-cycle-include-plain-lists nil)))
  6169. (cond
  6170. ((integerp arg)
  6171. (show-all)
  6172. (hide-sublevels arg)
  6173. (setq org-cycle-global-status 'contents))
  6174. ((equal arg '(4))
  6175. (org-set-startup-visibility)
  6176. (org-unlogged-message "Startup visibility, plus VISIBILITY properties."))
  6177. (t
  6178. (org-cycle '(4))))))
  6179. (defun org-set-startup-visibility ()
  6180. "Set the visibility required by startup options and properties."
  6181. (cond
  6182. ((eq org-startup-folded t)
  6183. (org-overview))
  6184. ((eq org-startup-folded 'content)
  6185. (org-content))
  6186. ((or (eq org-startup-folded 'showeverything)
  6187. (eq org-startup-folded nil))
  6188. (show-all)))
  6189. (unless (eq org-startup-folded 'showeverything)
  6190. (if org-hide-block-startup (org-hide-block-all))
  6191. (org-set-visibility-according-to-property 'no-cleanup)
  6192. (org-cycle-hide-archived-subtrees 'all)
  6193. (org-cycle-hide-drawers 'all)
  6194. (org-cycle-show-empty-lines t)))
  6195. (defun org-set-visibility-according-to-property (&optional no-cleanup)
  6196. "Switch subtree visibilities according to :VISIBILITY: property."
  6197. (interactive)
  6198. (let (org-show-entry-below)
  6199. (org-with-wide-buffer
  6200. (goto-char (point-min))
  6201. (while (re-search-forward "^[ \t]*:VISIBILITY:" nil t)
  6202. (if (not (org-at-property-p)) (outline-next-heading)
  6203. (let ((state (match-string 3)))
  6204. (save-excursion
  6205. (org-back-to-heading t)
  6206. (hide-subtree)
  6207. (org-reveal)
  6208. (cond
  6209. ((equal state "folded")
  6210. (hide-subtree))
  6211. ((equal state "children")
  6212. (org-show-hidden-entry)
  6213. (show-children))
  6214. ((equal state "content")
  6215. (save-excursion
  6216. (save-restriction
  6217. (org-narrow-to-subtree)
  6218. (org-content))))
  6219. ((member state '("all" "showall"))
  6220. (show-subtree)))))))
  6221. (unless no-cleanup
  6222. (org-cycle-hide-archived-subtrees 'all)
  6223. (org-cycle-hide-drawers 'all)
  6224. (org-cycle-show-empty-lines 'all)))))
  6225. ;; This function uses outline-regexp instead of the more fundamental
  6226. ;; org-outline-regexp so that org-cycle-global works outside of Org
  6227. ;; buffers, where outline-regexp is needed.
  6228. (defun org-overview ()
  6229. "Switch to overview mode, showing only top-level headlines.
  6230. This shows all headlines with a level equal or greater than the level
  6231. of the first headline in the buffer. This is important, because if the
  6232. first headline is not level one, then (hide-sublevels 1) gives confusing
  6233. results."
  6234. (interactive)
  6235. (save-excursion
  6236. (let ((level
  6237. (save-excursion
  6238. (goto-char (point-min))
  6239. (if (re-search-forward (concat "^" outline-regexp) nil t)
  6240. (progn
  6241. (goto-char (match-beginning 0))
  6242. (funcall outline-level))))))
  6243. (and level (hide-sublevels level)))))
  6244. (defun org-content (&optional arg)
  6245. "Show all headlines in the buffer, like a table of contents.
  6246. With numerical argument N, show content up to level N."
  6247. (interactive "P")
  6248. (org-overview)
  6249. (save-excursion
  6250. ;; Visit all headings and show their offspring
  6251. (and (integerp arg) (org-overview))
  6252. (goto-char (point-max))
  6253. (catch 'exit
  6254. (while (and (progn (condition-case nil
  6255. (outline-previous-visible-heading 1)
  6256. (error (goto-char (point-min))))
  6257. t)
  6258. (looking-at org-outline-regexp))
  6259. (if (integerp arg)
  6260. (show-children (1- arg))
  6261. (show-branches))
  6262. (if (bobp) (throw 'exit nil))))))
  6263. (defun org-optimize-window-after-visibility-change (state)
  6264. "Adjust the window after a change in outline visibility.
  6265. This function is the default value of the hook `org-cycle-hook'."
  6266. (when (get-buffer-window (current-buffer))
  6267. (cond
  6268. ((eq state 'content) nil)
  6269. ((eq state 'all) nil)
  6270. ((eq state 'folded) nil)
  6271. ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
  6272. ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
  6273. (defun org-remove-empty-overlays-at (pos)
  6274. "Remove outline overlays that do not contain non-white stuff."
  6275. (mapc
  6276. (lambda (o)
  6277. (and (eq 'outline (overlay-get o 'invisible))
  6278. (not (string-match "\\S-" (buffer-substring (overlay-start o)
  6279. (overlay-end o))))
  6280. (delete-overlay o)))
  6281. (overlays-at pos)))
  6282. (defun org-clean-visibility-after-subtree-move ()
  6283. "Fix visibility issues after moving a subtree."
  6284. ;; First, find a reasonable region to look at:
  6285. ;; Start two siblings above, end three below
  6286. (let* ((beg (save-excursion
  6287. (and (org-get-last-sibling)
  6288. (org-get-last-sibling))
  6289. (point)))
  6290. (end (save-excursion
  6291. (and (org-get-next-sibling)
  6292. (org-get-next-sibling)
  6293. (org-get-next-sibling))
  6294. (if (org-at-heading-p)
  6295. (point-at-eol)
  6296. (point))))
  6297. (level (looking-at "\\*+"))
  6298. (re (if level (concat "^" (regexp-quote (match-string 0)) " "))))
  6299. (save-excursion
  6300. (save-restriction
  6301. (narrow-to-region beg end)
  6302. (when re
  6303. ;; Properly fold already folded siblings
  6304. (goto-char (point-min))
  6305. (while (re-search-forward re nil t)
  6306. (if (and (not (outline-invisible-p))
  6307. (save-excursion
  6308. (goto-char (point-at-eol)) (outline-invisible-p)))
  6309. (hide-entry))))
  6310. (org-cycle-show-empty-lines 'overview)
  6311. (org-cycle-hide-drawers 'overview)))))
  6312. (defun org-cycle-show-empty-lines (state)
  6313. "Show empty lines above all visible headlines.
  6314. The region to be covered depends on STATE when called through
  6315. `org-cycle-hook'. Lisp program can use t for STATE to get the
  6316. entire buffer covered. Note that an empty line is only shown if there
  6317. are at least `org-cycle-separator-lines' empty lines before the headline."
  6318. (when (/= org-cycle-separator-lines 0)
  6319. (save-excursion
  6320. (let* ((n (abs org-cycle-separator-lines))
  6321. (re (cond
  6322. ((= n 1) "\\(\n[ \t]*\n\\*+\\) ")
  6323. ((= n 2) "^[ \t]*\\(\n[ \t]*\n\\*+\\) ")
  6324. (t (let ((ns (number-to-string (- n 2))))
  6325. (concat "^\\(?:[ \t]*\n\\)\\{" ns "," ns "\\}"
  6326. "[ \t]*\\(\n[ \t]*\n\\*+\\) ")))))
  6327. beg end)
  6328. (cond
  6329. ((memq state '(overview contents t))
  6330. (setq beg (point-min) end (point-max)))
  6331. ((memq state '(children folded))
  6332. (setq beg (point)
  6333. end (progn (org-end-of-subtree t t)
  6334. (line-beginning-position 2)))))
  6335. (when beg
  6336. (goto-char beg)
  6337. (while (re-search-forward re end t)
  6338. (unless (get-char-property (match-end 1) 'invisible)
  6339. (let ((e (match-end 1))
  6340. (b (if (>= org-cycle-separator-lines 0)
  6341. (match-beginning 1)
  6342. (save-excursion
  6343. (goto-char (match-beginning 0))
  6344. (skip-chars-backward " \t\n")
  6345. (line-end-position)))))
  6346. (outline-flag-region b e nil))))))))
  6347. ;; Never hide empty lines at the end of the file.
  6348. (save-excursion
  6349. (goto-char (point-max))
  6350. (outline-previous-heading)
  6351. (outline-end-of-heading)
  6352. (if (and (looking-at "[ \t\n]+")
  6353. (= (match-end 0) (point-max)))
  6354. (outline-flag-region (point) (match-end 0) nil))))
  6355. (defun org-show-empty-lines-in-parent ()
  6356. "Move to the parent and re-show empty lines before visible headlines."
  6357. (save-excursion
  6358. (let ((context (if (org-up-heading-safe) 'children 'overview)))
  6359. (org-cycle-show-empty-lines context))))
  6360. (defun org-files-list ()
  6361. "Return `org-agenda-files' list, plus all open org-mode files.
  6362. This is useful for operations that need to scan all of a user's
  6363. open and agenda-wise Org files."
  6364. (let ((files (mapcar 'expand-file-name (org-agenda-files))))
  6365. (dolist (buf (buffer-list))
  6366. (with-current-buffer buf
  6367. (if (and (derived-mode-p 'org-mode) (buffer-file-name))
  6368. (let ((file (expand-file-name (buffer-file-name))))
  6369. (unless (member file files)
  6370. (push file files))))))
  6371. files))
  6372. (defsubst org-entry-beginning-position ()
  6373. "Return the beginning position of the current entry."
  6374. (save-excursion (outline-back-to-heading t) (point)))
  6375. (defsubst org-entry-end-position ()
  6376. "Return the end position of the current entry."
  6377. (save-excursion (outline-next-heading) (point)))
  6378. (defun org-cycle-hide-drawers (state &optional exceptions)
  6379. "Re-hide all drawers after a visibility state change.
  6380. When non-nil, optional argument EXCEPTIONS is a list of strings
  6381. specifying which drawers should not be hidden."
  6382. (when (and (derived-mode-p 'org-mode)
  6383. (not (memq state '(overview folded contents))))
  6384. (save-excursion
  6385. (let* ((globalp (memq state '(contents all)))
  6386. (beg (if globalp (point-min) (point)))
  6387. (end (if globalp (point-max)
  6388. (if (eq state 'children)
  6389. (save-excursion (outline-next-heading) (point))
  6390. (org-end-of-subtree t)))))
  6391. (goto-char beg)
  6392. (while (re-search-forward org-drawer-regexp (max end (point)) t)
  6393. (unless (member-ignore-case (match-string 1) exceptions)
  6394. (let ((drawer (org-element-at-point)))
  6395. (when (memq (org-element-type drawer) '(drawer property-drawer))
  6396. (org-flag-drawer t drawer)
  6397. ;; Make sure to skip drawer entirely or we might flag
  6398. ;; it another time when matching its ending line with
  6399. ;; `org-drawer-regexp'.
  6400. (goto-char (org-element-property :end drawer))))))))))
  6401. (defun org-flag-drawer (flag &optional element)
  6402. "When FLAG is non-nil, hide the drawer we are at.
  6403. Otherwise make it visible. When optional argument ELEMENT is
  6404. a parsed drawer, as returned by `org-element-at-point', hide or
  6405. show that drawer instead."
  6406. (when (save-excursion
  6407. (beginning-of-line)
  6408. (org-looking-at-p org-drawer-regexp))
  6409. (let ((drawer (or element (org-element-at-point))))
  6410. (when (memq (org-element-type drawer) '(drawer property-drawer))
  6411. (let ((post (org-element-property :post-affiliated drawer)))
  6412. (save-excursion
  6413. (outline-flag-region
  6414. (progn (goto-char post) (line-end-position))
  6415. (progn (goto-char (org-element-property :end drawer))
  6416. (skip-chars-backward " \r\t\n")
  6417. (line-end-position))
  6418. flag))
  6419. ;; When the drawer is hidden away, make sure point lies in
  6420. ;; a visible part of the buffer.
  6421. (when (and flag (> (line-beginning-position) post))
  6422. (goto-char post)))))))
  6423. (defun org-subtree-end-visible-p ()
  6424. "Is the end of the current subtree visible?"
  6425. (pos-visible-in-window-p
  6426. (save-excursion (org-end-of-subtree t) (point))))
  6427. (defun org-first-headline-recenter ()
  6428. "Move cursor to the first headline and recenter the headline."
  6429. (goto-char (point-min))
  6430. (when (re-search-forward (concat "^\\(" org-outline-regexp "\\)") nil t)
  6431. (set-window-start (selected-window) (point-at-bol))))
  6432. ;;; Saving and restoring visibility
  6433. (defun org-outline-overlay-data (&optional use-markers)
  6434. "Return a list of the locations of all outline overlays.
  6435. These are overlays with the `invisible' property value `outline'.
  6436. The return value is a list of cons cells, with start and stop
  6437. positions for each overlay.
  6438. If USE-MARKERS is set, return the positions as markers."
  6439. (let (beg end)
  6440. (save-excursion
  6441. (save-restriction
  6442. (widen)
  6443. (delq nil
  6444. (mapcar (lambda (o)
  6445. (when (eq (overlay-get o 'invisible) 'outline)
  6446. (setq beg (overlay-start o)
  6447. end (overlay-end o))
  6448. (and beg end (> end beg)
  6449. (if use-markers
  6450. (cons (copy-marker beg)
  6451. (copy-marker end t))
  6452. (cons beg end)))))
  6453. (overlays-in (point-min) (point-max))))))))
  6454. (defun org-set-outline-overlay-data (data)
  6455. "Create visibility overlays for all positions in DATA.
  6456. DATA should have been made by `org-outline-overlay-data'."
  6457. (let (o)
  6458. (save-excursion
  6459. (save-restriction
  6460. (widen)
  6461. (show-all)
  6462. (mapc (lambda (c)
  6463. (outline-flag-region (car c) (cdr c) t))
  6464. data)))))
  6465. ;;; Folding of blocks
  6466. (defvar org-hide-block-overlays nil
  6467. "Overlays hiding blocks.")
  6468. (make-variable-buffer-local 'org-hide-block-overlays)
  6469. (defun org-block-map (function &optional start end)
  6470. "Call FUNCTION at the head of all source blocks in the current buffer.
  6471. Optional arguments START and END can be used to limit the range."
  6472. (let ((start (or start (point-min)))
  6473. (end (or end (point-max))))
  6474. (save-excursion
  6475. (goto-char start)
  6476. (while (and (< (point) end) (re-search-forward org-block-regexp end t))
  6477. (save-excursion
  6478. (save-match-data
  6479. (goto-char (match-beginning 0))
  6480. (funcall function)))))))
  6481. (defun org-hide-block-toggle-all ()
  6482. "Toggle the visibility of all blocks in the current buffer."
  6483. (org-block-map 'org-hide-block-toggle))
  6484. (defun org-hide-block-all ()
  6485. "Fold all blocks in the current buffer."
  6486. (interactive)
  6487. (org-show-block-all)
  6488. (org-block-map 'org-hide-block-toggle-maybe))
  6489. (defun org-show-block-all ()
  6490. "Unfold all blocks in the current buffer."
  6491. (interactive)
  6492. (mapc 'delete-overlay org-hide-block-overlays)
  6493. (setq org-hide-block-overlays nil))
  6494. (defun org-hide-block-toggle-maybe ()
  6495. "Toggle visibility of block at point.
  6496. Unlike to `org-hide-block-toggle', this function does not throw
  6497. an error. Return a non-nil value when toggling is successful."
  6498. (interactive)
  6499. (ignore-errors (org-hide-block-toggle)))
  6500. (defun org-hide-block-toggle (&optional force)
  6501. "Toggle the visibility of the current block.
  6502. When optional argument FORCE is `off', make block visible. If it
  6503. is non-nil, hide it unconditionally. Throw an error when not at
  6504. a block. Return a non-nil value when toggling is successful."
  6505. (interactive)
  6506. (let ((element (org-element-at-point)))
  6507. (unless (memq (org-element-type element)
  6508. '(center-block comment-block dynamic-block example-block
  6509. export-block quote-block special-block
  6510. src-block verse-block))
  6511. (user-error "Not at a block"))
  6512. (let* ((start (save-excursion
  6513. (goto-char (org-element-property :post-affiliated element))
  6514. (line-end-position)))
  6515. (end (save-excursion
  6516. (goto-char (org-element-property :end element))
  6517. (skip-chars-backward " \r\t\n")
  6518. (line-end-position)))
  6519. (overlays (overlays-at start)))
  6520. (cond
  6521. ;; Do nothing when not before or at the block opening line or
  6522. ;; at the block closing line.
  6523. ((let ((eol (line-end-position))) (and (> eol start) (/= eol end))) nil)
  6524. ((and (not (eq force 'off))
  6525. (not (memq t (mapcar
  6526. (lambda (o)
  6527. (eq (overlay-get o 'invisible) 'org-hide-block))
  6528. overlays))))
  6529. (let ((ov (make-overlay start end)))
  6530. (overlay-put ov 'invisible 'org-hide-block)
  6531. ;; Make the block accessible to `isearch'.
  6532. (overlay-put
  6533. ov 'isearch-open-invisible
  6534. (lambda (ov)
  6535. (when (memq ov org-hide-block-overlays)
  6536. (setq org-hide-block-overlays (delq ov org-hide-block-overlays)))
  6537. (when (eq (overlay-get ov 'invisible) 'org-hide-block)
  6538. (delete-overlay ov))))
  6539. (push ov org-hide-block-overlays)
  6540. ;; When the block is hidden away, make sure point is left in
  6541. ;; a visible part of the buffer.
  6542. (when (> (line-beginning-position) start)
  6543. (goto-char start)
  6544. (beginning-of-line))
  6545. ;; Signal successful toggling.
  6546. t))
  6547. ((or (not force) (eq force 'off))
  6548. (dolist (ov overlays t)
  6549. (when (memq ov org-hide-block-overlays)
  6550. (setq org-hide-block-overlays (delq ov org-hide-block-overlays)))
  6551. (when (eq (overlay-get ov 'invisible) 'org-hide-block)
  6552. (delete-overlay ov))))))))
  6553. ;; org-tab-after-check-for-cycling-hook
  6554. (add-hook 'org-tab-first-hook 'org-hide-block-toggle-maybe)
  6555. ;; Remove overlays when changing major mode
  6556. (add-hook 'org-mode-hook
  6557. (lambda () (org-add-hook 'change-major-mode-hook
  6558. 'org-show-block-all 'append 'local)))
  6559. ;;; Org-goto
  6560. (defvar org-goto-window-configuration nil)
  6561. (defvar org-goto-marker nil)
  6562. (defvar org-goto-map)
  6563. (defun org-goto-map ()
  6564. "Set the keymap `org-goto'."
  6565. (setq org-goto-map
  6566. (let ((map (make-sparse-keymap)))
  6567. (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command
  6568. mouse-drag-region universal-argument org-occur))
  6569. cmd)
  6570. (while (setq cmd (pop cmds))
  6571. (substitute-key-definition cmd cmd map global-map)))
  6572. (suppress-keymap map)
  6573. (org-defkey map "\C-m" 'org-goto-ret)
  6574. (org-defkey map [(return)] 'org-goto-ret)
  6575. (org-defkey map [(left)] 'org-goto-left)
  6576. (org-defkey map [(right)] 'org-goto-right)
  6577. (org-defkey map [(control ?g)] 'org-goto-quit)
  6578. (org-defkey map "\C-i" 'org-cycle)
  6579. (org-defkey map [(tab)] 'org-cycle)
  6580. (org-defkey map [(down)] 'outline-next-visible-heading)
  6581. (org-defkey map [(up)] 'outline-previous-visible-heading)
  6582. (if org-goto-auto-isearch
  6583. (if (fboundp 'define-key-after)
  6584. (define-key-after map [t] 'org-goto-local-auto-isearch)
  6585. nil)
  6586. (org-defkey map "q" 'org-goto-quit)
  6587. (org-defkey map "n" 'outline-next-visible-heading)
  6588. (org-defkey map "p" 'outline-previous-visible-heading)
  6589. (org-defkey map "f" 'outline-forward-same-level)
  6590. (org-defkey map "b" 'outline-backward-same-level)
  6591. (org-defkey map "u" 'outline-up-heading))
  6592. (org-defkey map "/" 'org-occur)
  6593. (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
  6594. (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
  6595. (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
  6596. (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
  6597. (org-defkey map "\C-c\C-u" 'outline-up-heading)
  6598. map)))
  6599. (defconst org-goto-help
  6600. "Browse buffer copy, to find location or copy text.%s
  6601. RET=jump to location C-g=quit and return to previous location
  6602. \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
  6603. (defvar org-goto-start-pos) ; dynamically scoped parameter
  6604. (defun org-goto (&optional alternative-interface)
  6605. "Look up a different location in the current file, keeping current visibility.
  6606. When you want look-up or go to a different location in a
  6607. document, the fastest way is often to fold the entire buffer and
  6608. then dive into the tree. This method has the disadvantage, that
  6609. the previous location will be folded, which may not be what you
  6610. want.
  6611. This command works around this by showing a copy of the current
  6612. buffer in an indirect buffer, in overview mode. You can dive
  6613. into the tree in that copy, use org-occur and incremental search
  6614. to find a location. When pressing RET or `Q', the command
  6615. returns to the original buffer in which the visibility is still
  6616. unchanged. After RET it will also jump to the location selected
  6617. in the indirect buffer and expose the headline hierarchy above.
  6618. With a prefix argument, use the alternative interface: e.g. if
  6619. `org-goto-interface' is 'outline use 'outline-path-completion."
  6620. (interactive "P")
  6621. (org-goto-map)
  6622. (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
  6623. (org-refile-use-outline-path t)
  6624. (org-refile-target-verify-function nil)
  6625. (interface
  6626. (if (not alternative-interface)
  6627. org-goto-interface
  6628. (if (eq org-goto-interface 'outline)
  6629. 'outline-path-completion
  6630. 'outline)))
  6631. (org-goto-start-pos (point))
  6632. (selected-point
  6633. (if (eq interface 'outline)
  6634. (car (org-get-location (current-buffer) org-goto-help))
  6635. (let ((pa (org-refile-get-location "Goto" nil nil t)))
  6636. (org-refile-check-position pa)
  6637. (nth 3 pa)))))
  6638. (if selected-point
  6639. (progn
  6640. (org-mark-ring-push org-goto-start-pos)
  6641. (goto-char selected-point)
  6642. (if (or (outline-invisible-p) (org-invisible-p2))
  6643. (org-show-context 'org-goto)))
  6644. (message "Quit"))))
  6645. (defvar org-goto-selected-point nil) ; dynamically scoped parameter
  6646. (defvar org-goto-exit-command nil) ; dynamically scoped parameter
  6647. (defvar org-goto-local-auto-isearch-map) ; defined below
  6648. (defun org-get-location (buf help)
  6649. "Let the user select a location in the Org-mode buffer BUF.
  6650. This function uses a recursive edit. It returns the selected position
  6651. or nil."
  6652. (org-no-popups
  6653. (let ((isearch-mode-map org-goto-local-auto-isearch-map)
  6654. (isearch-hide-immediately nil)
  6655. (isearch-search-fun-function
  6656. (lambda () 'org-goto-local-search-headings))
  6657. (org-goto-selected-point org-goto-exit-command))
  6658. (save-excursion
  6659. (save-window-excursion
  6660. (delete-other-windows)
  6661. (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
  6662. (org-pop-to-buffer-same-window
  6663. (condition-case nil
  6664. (make-indirect-buffer (current-buffer) "*org-goto*")
  6665. (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
  6666. (with-output-to-temp-buffer "*Org Help*"
  6667. (princ (format help (if org-goto-auto-isearch
  6668. " Just type for auto-isearch."
  6669. " n/p/f/b/u to navigate, q to quit."))))
  6670. (org-fit-window-to-buffer (get-buffer-window "*Org Help*"))
  6671. (setq buffer-read-only nil)
  6672. (let ((org-startup-truncated t)
  6673. (org-startup-folded nil)
  6674. (org-startup-align-all-tables nil))
  6675. (org-mode)
  6676. (org-overview))
  6677. (setq buffer-read-only t)
  6678. (if (and (boundp 'org-goto-start-pos)
  6679. (integer-or-marker-p org-goto-start-pos))
  6680. (progn (goto-char org-goto-start-pos)
  6681. (when (outline-invisible-p)
  6682. (org-show-set-visibility 'lineage)))
  6683. (goto-char (point-min)))
  6684. (let (org-special-ctrl-a/e) (org-beginning-of-line))
  6685. (message "Select location and press RET")
  6686. (use-local-map org-goto-map)
  6687. (recursive-edit)))
  6688. (kill-buffer "*org-goto*")
  6689. (cons org-goto-selected-point org-goto-exit-command))))
  6690. (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
  6691. (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
  6692. ;; `isearch-other-control-char' was removed in Emacs 24.4.
  6693. (if (fboundp 'isearch-other-control-char)
  6694. (progn
  6695. (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
  6696. (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char))
  6697. (define-key org-goto-local-auto-isearch-map "\C-i" nil)
  6698. (define-key org-goto-local-auto-isearch-map "\C-m" nil)
  6699. (define-key org-goto-local-auto-isearch-map [return] nil))
  6700. (defun org-goto-local-search-headings (string bound noerror)
  6701. "Search and make sure that any matches are in headlines."
  6702. (catch 'return
  6703. (while (if isearch-forward
  6704. (search-forward string bound noerror)
  6705. (search-backward string bound noerror))
  6706. (when (let ((context (mapcar 'car (save-match-data (org-context)))))
  6707. (and (member :headline context)
  6708. (not (member :tags context))))
  6709. (throw 'return (point))))))
  6710. (defun org-goto-local-auto-isearch ()
  6711. "Start isearch."
  6712. (interactive)
  6713. (goto-char (point-min))
  6714. (let ((keys (this-command-keys)))
  6715. (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
  6716. (isearch-mode t)
  6717. (isearch-process-search-char (string-to-char keys)))))
  6718. (defun org-goto-ret (&optional arg)
  6719. "Finish `org-goto' by going to the new location."
  6720. (interactive "P")
  6721. (setq org-goto-selected-point (point)
  6722. org-goto-exit-command 'return)
  6723. (throw 'exit nil))
  6724. (defun org-goto-left ()
  6725. "Finish `org-goto' by going to the new location."
  6726. (interactive)
  6727. (if (org-at-heading-p)
  6728. (progn
  6729. (beginning-of-line 1)
  6730. (setq org-goto-selected-point (point)
  6731. org-goto-exit-command 'left)
  6732. (throw 'exit nil))
  6733. (user-error "Not on a heading")))
  6734. (defun org-goto-right ()
  6735. "Finish `org-goto' by going to the new location."
  6736. (interactive)
  6737. (if (org-at-heading-p)
  6738. (progn
  6739. (setq org-goto-selected-point (point)
  6740. org-goto-exit-command 'right)
  6741. (throw 'exit nil))
  6742. (user-error "Not on a heading")))
  6743. (defun org-goto-quit ()
  6744. "Finish `org-goto' without cursor motion."
  6745. (interactive)
  6746. (setq org-goto-selected-point nil)
  6747. (setq org-goto-exit-command 'quit)
  6748. (throw 'exit nil))
  6749. ;;; Indirect buffer display of subtrees
  6750. (defvar org-indirect-dedicated-frame nil
  6751. "This is the frame being used for indirect tree display.")
  6752. (defvar org-last-indirect-buffer nil)
  6753. (defun org-tree-to-indirect-buffer (&optional arg)
  6754. "Create indirect buffer and narrow it to current subtree.
  6755. With a numerical prefix ARG, go up to this level and then take that tree.
  6756. If ARG is negative, go up that many levels.
  6757. If `org-indirect-buffer-display' is not `new-frame', the command removes the
  6758. indirect buffer previously made with this command, to avoid proliferation of
  6759. indirect buffers. However, when you call the command with a \
  6760. \\[universal-argument] prefix, or
  6761. when `org-indirect-buffer-display' is `new-frame', the last buffer
  6762. is kept so that you can work with several indirect buffers at the same time.
  6763. If `org-indirect-buffer-display' is `dedicated-frame', the \
  6764. \\[universal-argument] prefix also
  6765. requests that a new frame be made for the new buffer, so that the dedicated
  6766. frame is not changed."
  6767. (interactive "P")
  6768. (let ((cbuf (current-buffer))
  6769. (cwin (selected-window))
  6770. (pos (point))
  6771. beg end level heading ibuf)
  6772. (save-excursion
  6773. (org-back-to-heading t)
  6774. (when (numberp arg)
  6775. (setq level (org-outline-level))
  6776. (if (< arg 0) (setq arg (+ level arg)))
  6777. (while (> (setq level (org-outline-level)) arg)
  6778. (org-up-heading-safe)))
  6779. (setq beg (point)
  6780. heading (org-get-heading))
  6781. (org-end-of-subtree t t)
  6782. (if (org-at-heading-p) (backward-char 1))
  6783. (setq end (point)))
  6784. (if (and (buffer-live-p org-last-indirect-buffer)
  6785. (not (eq org-indirect-buffer-display 'new-frame))
  6786. (not arg))
  6787. (kill-buffer org-last-indirect-buffer))
  6788. (setq ibuf (org-get-indirect-buffer cbuf heading)
  6789. org-last-indirect-buffer ibuf)
  6790. (cond
  6791. ((or (eq org-indirect-buffer-display 'new-frame)
  6792. (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
  6793. (select-frame (make-frame))
  6794. (delete-other-windows)
  6795. (org-pop-to-buffer-same-window ibuf)
  6796. (org-set-frame-title heading))
  6797. ((eq org-indirect-buffer-display 'dedicated-frame)
  6798. (raise-frame
  6799. (select-frame (or (and org-indirect-dedicated-frame
  6800. (frame-live-p org-indirect-dedicated-frame)
  6801. org-indirect-dedicated-frame)
  6802. (setq org-indirect-dedicated-frame (make-frame)))))
  6803. (delete-other-windows)
  6804. (org-pop-to-buffer-same-window ibuf)
  6805. (org-set-frame-title (concat "Indirect: " heading)))
  6806. ((eq org-indirect-buffer-display 'current-window)
  6807. (org-pop-to-buffer-same-window ibuf))
  6808. ((eq org-indirect-buffer-display 'other-window)
  6809. (pop-to-buffer ibuf))
  6810. (t (error "Invalid value")))
  6811. (if (featurep 'xemacs)
  6812. (save-excursion (org-mode) (turn-on-font-lock)))
  6813. (narrow-to-region beg end)
  6814. (show-all)
  6815. (goto-char pos)
  6816. (run-hook-with-args 'org-cycle-hook 'all)
  6817. (and (window-live-p cwin) (select-window cwin))))
  6818. (defun org-get-indirect-buffer (&optional buffer heading)
  6819. (setq buffer (or buffer (current-buffer)))
  6820. (let ((n 1) (base (buffer-name buffer)) bname)
  6821. (while (buffer-live-p
  6822. (get-buffer
  6823. (setq bname
  6824. (concat base "-"
  6825. (if heading (concat heading "-" (number-to-string n))
  6826. (number-to-string n))))))
  6827. (setq n (1+ n)))
  6828. (condition-case nil
  6829. (make-indirect-buffer buffer bname 'clone)
  6830. (error (make-indirect-buffer buffer bname)))))
  6831. (defun org-set-frame-title (title)
  6832. "Set the title of the current frame to the string TITLE."
  6833. ;; FIXME: how to name a single frame in XEmacs???
  6834. (unless (featurep 'xemacs)
  6835. (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
  6836. ;;;; Structure editing
  6837. ;;; Inserting headlines
  6838. (defun org-previous-line-empty-p (&optional next)
  6839. "Is the previous line a blank line?
  6840. When NEXT is non-nil, check the next line instead."
  6841. (save-excursion
  6842. (and (not (bobp))
  6843. (or (beginning-of-line (if next 2 0)) t)
  6844. (save-match-data
  6845. (looking-at "[ \t]*$")))))
  6846. (defun org-insert-heading (&optional arg invisible-ok top-level)
  6847. "Insert a new heading or an item with the same depth at point.
  6848. If point is at the beginning of a heading or a list item, insert
  6849. a new heading or a new item above the current one. If point is
  6850. at the beginning of a normal line, turn the line into a heading.
  6851. If point is in the middle of a headline or a list item, split the
  6852. headline or the item and create a new headline/item with the text
  6853. in the current line after point \(see `org-M-RET-may-split-line'
  6854. on how to modify this behavior).
  6855. With one universal prefix argument, set the user option
  6856. `org-insert-heading-respect-content' to t for the duration of
  6857. the command. This modifies the behavior described above in this
  6858. ways: on list items and at the beginning of normal lines, force
  6859. the insertion of a heading after the current subtree.
  6860. With two universal prefix arguments, insert the heading at the
  6861. end of the grandparent subtree. For example, if point is within
  6862. a 2nd-level heading, then it will insert a 2nd-level heading at
  6863. the end of the 1st-level parent heading.
  6864. If point is at the beginning of a headline, insert a sibling
  6865. before the current headline. If point is not at the beginning,
  6866. split the line and create a new headline with the text in the
  6867. current line after point \(see `org-M-RET-may-split-line' on how
  6868. to modify this behavior).
  6869. If point is at the beginning of a normal line, turn this line
  6870. into a heading.
  6871. When INVISIBLE-OK is set, stop at invisible headlines when going
  6872. back. This is important for non-interactive uses of the
  6873. command.
  6874. When optional argument TOP-LEVEL is non-nil, insert a level 1
  6875. heading, unconditionally."
  6876. (interactive "P")
  6877. (if (org-called-interactively-p 'any) (org-reveal))
  6878. (let ((itemp (and (not top-level) (org-in-item-p)))
  6879. (may-split (org-get-alist-option org-M-RET-may-split-line 'headline))
  6880. (respect-content (or org-insert-heading-respect-content
  6881. (equal arg '(4))))
  6882. (initial-content ""))
  6883. (cond
  6884. ((or (= (buffer-size) 0)
  6885. (and (not (save-excursion
  6886. (and (ignore-errors (org-back-to-heading invisible-ok))
  6887. (org-at-heading-p))))
  6888. (or arg (not itemp))))
  6889. ;; At beginning of buffer or so high up that only a heading
  6890. ;; makes sense.
  6891. (cond ((and (bolp) (not respect-content)) (insert "* "))
  6892. ((not respect-content)
  6893. (unless may-split (end-of-line))
  6894. (insert "\n* "))
  6895. ((re-search-forward org-outline-regexp-bol nil t)
  6896. (beginning-of-line)
  6897. (insert "* \n")
  6898. (backward-char))
  6899. (t (goto-char (point-max))
  6900. (insert "\n* ")))
  6901. (run-hooks 'org-insert-heading-hook))
  6902. ((and itemp (not (member arg '((4) (16)))) (org-insert-item)))
  6903. (t
  6904. ;; Maybe move at the end of the subtree
  6905. (when (equal arg '(16))
  6906. (org-up-heading-safe)
  6907. (org-end-of-subtree t))
  6908. ;; Insert a heading
  6909. (save-restriction
  6910. (widen)
  6911. (let* ((level nil)
  6912. (on-heading (org-at-heading-p))
  6913. (empty-line-p (if on-heading
  6914. (org-previous-line-empty-p)
  6915. ;; We will decide later
  6916. nil))
  6917. ;; Get a level string to fall back on.
  6918. (fix-level
  6919. (if (org-before-first-heading-p) "*"
  6920. (save-excursion
  6921. (org-back-to-heading t)
  6922. (if (org-previous-line-empty-p) (setq empty-line-p t))
  6923. (looking-at org-outline-regexp)
  6924. (make-string (1- (length (match-string 0))) ?*))))
  6925. (stars
  6926. (save-excursion
  6927. (condition-case nil
  6928. (if top-level "* "
  6929. (org-back-to-heading invisible-ok)
  6930. (when (and (not on-heading)
  6931. (featurep 'org-inlinetask)
  6932. (integerp org-inlinetask-min-level)
  6933. (>= (length (match-string 0))
  6934. org-inlinetask-min-level))
  6935. ;; Find a heading level before the inline
  6936. ;; task.
  6937. (while (and (setq level (org-up-heading-safe))
  6938. (>= level org-inlinetask-min-level)))
  6939. (if (org-at-heading-p)
  6940. (org-back-to-heading invisible-ok)
  6941. (error "This should not happen")))
  6942. (unless (and (save-excursion
  6943. (save-match-data
  6944. (org-backward-heading-same-level
  6945. 1 invisible-ok))
  6946. (= (point) (match-beginning 0)))
  6947. (not (org-previous-line-empty-p t)))
  6948. (setq empty-line-p (or empty-line-p
  6949. (org-previous-line-empty-p))))
  6950. (match-string 0))
  6951. (error (or fix-level "* ")))))
  6952. (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
  6953. (blank (if (eq blank-a 'auto) empty-line-p blank-a))
  6954. pos hide-previous previous-pos)
  6955. ;; If we insert after content, move there and clean up
  6956. ;; whitespace.
  6957. (when (and respect-content
  6958. (not (org-looking-at-p org-outline-regexp-bol)))
  6959. (if (not (org-before-first-heading-p))
  6960. (org-end-of-subtree nil t)
  6961. (re-search-forward org-outline-regexp-bol)
  6962. (beginning-of-line 0))
  6963. (skip-chars-backward " \r\t\n")
  6964. (and (not (looking-back "^\\*+"))
  6965. (looking-at "[ \t]+") (replace-match ""))
  6966. (unless (eobp) (forward-char 1))
  6967. (when (looking-at "^\\*")
  6968. (unless (bobp) (backward-char 1))
  6969. (insert "\n")))
  6970. ;; If we are splitting, grab the text that should be moved
  6971. ;; to the new headline.
  6972. (when may-split
  6973. (if (org-on-heading-p)
  6974. ;; This is a heading: split intelligently (keeping
  6975. ;; tags).
  6976. (let ((pos (point)))
  6977. (beginning-of-line)
  6978. (unless (looking-at org-complex-heading-regexp)
  6979. (error "This should not happen"))
  6980. (when (and (match-beginning 4)
  6981. (> pos (match-beginning 4))
  6982. (< pos (match-end 4)))
  6983. (setq initial-content (buffer-substring pos (match-end 4)))
  6984. (goto-char pos)
  6985. (delete-region (point) (match-end 4))
  6986. (if (looking-at "[ \t]*$")
  6987. (replace-match "")
  6988. (insert (make-string (length initial-content) ?\s)))
  6989. (setq initial-content (org-trim initial-content)))
  6990. (goto-char pos))
  6991. ;; A normal line.
  6992. (setq initial-content
  6993. (org-trim
  6994. (delete-and-extract-region (point) (line-end-position))))))
  6995. ;; If we are at the beginning of the line, insert before it.
  6996. ;; Otherwise, after it.
  6997. (cond
  6998. ((and (bolp) (looking-at "[ \t]*$")))
  6999. ((bolp) (save-excursion (insert "\n")))
  7000. (t (end-of-line)
  7001. (insert "\n")))
  7002. ;; Insert the new heading
  7003. (insert stars)
  7004. (just-one-space)
  7005. (insert initial-content)
  7006. (unless (and blank (org-previous-line-empty-p))
  7007. (org-N-empty-lines-before-current (if blank 1 0)))
  7008. ;; Adjust visibility, which may be messed up if we removed
  7009. ;; blank lines while previous entry was hidden.
  7010. (let ((bol (line-beginning-position)))
  7011. (dolist (o (overlays-at (1- bol)))
  7012. (when (and (eq (overlay-get o 'invisible) 'outline)
  7013. (eq (overlay-end o) bol))
  7014. (move-overlay o (overlay-start o) (1- bol)))))
  7015. (run-hooks 'org-insert-heading-hook)))))))
  7016. (defun org-N-empty-lines-before-current (N)
  7017. "Make the number of empty lines before current exactly N.
  7018. So this will delete or add empty lines."
  7019. (save-excursion
  7020. (beginning-of-line)
  7021. (let ((p (point)))
  7022. (skip-chars-backward " \r\t\n")
  7023. (unless (bolp) (forward-line))
  7024. (delete-region (point) p))
  7025. (when (> N 0) (insert (make-string N ?\n)))))
  7026. (defun org-get-heading (&optional no-tags no-todo)
  7027. "Return the heading of the current entry, without the stars.
  7028. When NO-TAGS is non-nil, don't include tags.
  7029. When NO-TODO is non-nil, don't include TODO keywords."
  7030. (save-excursion
  7031. (org-back-to-heading t)
  7032. (cond
  7033. ((and no-tags no-todo)
  7034. (looking-at org-complex-heading-regexp)
  7035. (match-string 4))
  7036. (no-tags
  7037. (looking-at (concat org-outline-regexp
  7038. "\\(.*?\\)"
  7039. "\\(?:[ \t]+:[[:alnum:]:_@#%]+:\\)?[ \t]*$"))
  7040. (match-string 1))
  7041. (no-todo
  7042. (looking-at org-todo-line-regexp)
  7043. (match-string 3))
  7044. (t (looking-at org-heading-regexp)
  7045. (match-string 2)))))
  7046. (defvar orgstruct-mode) ; defined below
  7047. (defun org-heading-components ()
  7048. "Return the components of the current heading.
  7049. This is a list with the following elements:
  7050. - the level as an integer
  7051. - the reduced level, different if `org-odd-levels-only' is set.
  7052. - the TODO keyword, or nil
  7053. - the priority character, like ?A, or nil if no priority is given
  7054. - the headline text itself, or the tags string if no headline text
  7055. - the tags string, or nil."
  7056. (save-excursion
  7057. (org-back-to-heading t)
  7058. (if (let (case-fold-search)
  7059. (looking-at
  7060. (if orgstruct-mode
  7061. org-heading-regexp
  7062. org-complex-heading-regexp)))
  7063. (if orgstruct-mode
  7064. (list (length (match-string 1))
  7065. (org-reduced-level (length (match-string 1)))
  7066. nil
  7067. nil
  7068. (match-string 2)
  7069. nil)
  7070. (list (length (match-string 1))
  7071. (org-reduced-level (length (match-string 1)))
  7072. (org-match-string-no-properties 2)
  7073. (and (match-end 3) (aref (match-string 3) 2))
  7074. (org-match-string-no-properties 4)
  7075. (org-match-string-no-properties 5))))))
  7076. (defun org-get-entry ()
  7077. "Get the entry text, after heading, entire subtree."
  7078. (save-excursion
  7079. (org-back-to-heading t)
  7080. (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
  7081. (defun org-insert-heading-after-current ()
  7082. "Insert a new heading with same level as current, after current subtree."
  7083. (interactive)
  7084. (org-back-to-heading)
  7085. (org-insert-heading)
  7086. (org-move-subtree-down)
  7087. (end-of-line 1))
  7088. (defun org-insert-heading-respect-content (&optional invisible-ok)
  7089. "Insert heading with `org-insert-heading-respect-content' set to t."
  7090. (interactive)
  7091. (org-insert-heading '(4) invisible-ok))
  7092. (defun org-insert-todo-heading-respect-content (&optional force-state)
  7093. "Insert TODO heading with `org-insert-heading-respect-content' set to t."
  7094. (interactive)
  7095. (org-insert-todo-heading force-state '(4)))
  7096. (defun org-insert-todo-heading (arg &optional force-heading)
  7097. "Insert a new heading with the same level and TODO state as current heading.
  7098. If the heading has no TODO state, or if the state is DONE, use the first
  7099. state (TODO by default). Also with one prefix arg, force first state. With
  7100. two prefix args, force inserting at the end of the parent subtree."
  7101. (interactive "P")
  7102. (when (or force-heading (not (org-insert-item 'checkbox)))
  7103. (org-insert-heading (or (and (equal arg '(16)) '(16))
  7104. force-heading))
  7105. (save-excursion
  7106. (org-back-to-heading)
  7107. (outline-previous-heading)
  7108. (looking-at org-todo-line-regexp))
  7109. (let*
  7110. ((new-mark-x
  7111. (if (or (equal arg '(4))
  7112. (not (match-beginning 2))
  7113. (member (match-string 2) org-done-keywords))
  7114. (car org-todo-keywords-1)
  7115. (match-string 2)))
  7116. (new-mark
  7117. (or
  7118. (run-hook-with-args-until-success
  7119. 'org-todo-get-default-hook new-mark-x nil)
  7120. new-mark-x)))
  7121. (beginning-of-line 1)
  7122. (and (looking-at org-outline-regexp) (goto-char (match-end 0))
  7123. (if org-treat-insert-todo-heading-as-state-change
  7124. (org-todo new-mark)
  7125. (insert new-mark " "))))
  7126. (when org-provide-todo-statistics
  7127. (org-update-parent-todo-statistics))))
  7128. (defun org-insert-subheading (arg)
  7129. "Insert a new subheading and demote it.
  7130. Works for outline headings and for plain lists alike."
  7131. (interactive "P")
  7132. (org-insert-heading arg)
  7133. (cond
  7134. ((org-at-heading-p) (org-do-demote))
  7135. ((org-at-item-p) (org-indent-item))))
  7136. (defun org-insert-todo-subheading (arg)
  7137. "Insert a new subheading with TODO keyword or checkbox and demote it.
  7138. Works for outline headings and for plain lists alike."
  7139. (interactive "P")
  7140. (org-insert-todo-heading arg)
  7141. (cond
  7142. ((org-at-heading-p) (org-do-demote))
  7143. ((org-at-item-p) (org-indent-item))))
  7144. ;;; Promotion and Demotion
  7145. (defvar org-after-demote-entry-hook nil
  7146. "Hook run after an entry has been demoted.
  7147. The cursor will be at the beginning of the entry.
  7148. When a subtree is being demoted, the hook will be called for each node.")
  7149. (defvar org-after-promote-entry-hook nil
  7150. "Hook run after an entry has been promoted.
  7151. The cursor will be at the beginning of the entry.
  7152. When a subtree is being promoted, the hook will be called for each node.")
  7153. (defun org-promote-subtree ()
  7154. "Promote the entire subtree.
  7155. See also `org-promote'."
  7156. (interactive)
  7157. (save-excursion
  7158. (org-with-limited-levels (org-map-tree 'org-promote)))
  7159. (org-fix-position-after-promote))
  7160. (defun org-demote-subtree ()
  7161. "Demote the entire subtree. See `org-demote'.
  7162. See also `org-promote'."
  7163. (interactive)
  7164. (save-excursion
  7165. (org-with-limited-levels (org-map-tree 'org-demote)))
  7166. (org-fix-position-after-promote))
  7167. (defun org-do-promote ()
  7168. "Promote the current heading higher up the tree.
  7169. If the region is active in `transient-mark-mode', promote all headings
  7170. in the region."
  7171. (interactive)
  7172. (save-excursion
  7173. (if (org-region-active-p)
  7174. (org-map-region 'org-promote (region-beginning) (region-end))
  7175. (org-promote)))
  7176. (org-fix-position-after-promote))
  7177. (defun org-do-demote ()
  7178. "Demote the current heading lower down the tree.
  7179. If the region is active in `transient-mark-mode', demote all headings
  7180. in the region."
  7181. (interactive)
  7182. (save-excursion
  7183. (if (org-region-active-p)
  7184. (org-map-region 'org-demote (region-beginning) (region-end))
  7185. (org-demote)))
  7186. (org-fix-position-after-promote))
  7187. (defun org-fix-position-after-promote ()
  7188. "Make sure that after pro/demotion cursor position is right."
  7189. (let ((pos (point)))
  7190. (when (save-excursion
  7191. (beginning-of-line 1)
  7192. (looking-at org-todo-line-regexp)
  7193. (or (equal pos (match-end 1)) (equal pos (match-end 2))))
  7194. (cond ((eobp) (insert " "))
  7195. ((eolp) (insert " "))
  7196. ((equal (char-after) ?\ ) (forward-char 1))))))
  7197. (defun org-current-level ()
  7198. "Return the level of the current entry, or nil if before the first headline.
  7199. The level is the number of stars at the beginning of the
  7200. headline. Use `org-reduced-level' to remove the effect of
  7201. `org-odd-levels'. Unlike to `org-outline-level', this function
  7202. ignores inlinetasks."
  7203. (let ((level (org-with-limited-levels (org-outline-level))))
  7204. (and (> level 0) level)))
  7205. (defun org-get-previous-line-level ()
  7206. "Return the outline depth of the last headline before the current line.
  7207. Returns 0 for the first headline in the buffer, and nil if before the
  7208. first headline."
  7209. (and (org-current-level)
  7210. (or (and (/= (line-beginning-position) (point-min))
  7211. (save-excursion (beginning-of-line 0) (org-current-level)))
  7212. 0)))
  7213. (defun org-reduced-level (l)
  7214. "Compute the effective level of a heading.
  7215. This takes into account the setting of `org-odd-levels-only'."
  7216. (cond
  7217. ((zerop l) 0)
  7218. (org-odd-levels-only (1+ (floor (/ l 2))))
  7219. (t l)))
  7220. (defun org-level-increment ()
  7221. "Return the number of stars that will be added or removed at a
  7222. time to headlines when structure editing, based on the value of
  7223. `org-odd-levels-only'."
  7224. (if org-odd-levels-only 2 1))
  7225. (defun org-get-valid-level (level &optional change)
  7226. "Rectify a level change under the influence of `org-odd-levels-only'
  7227. LEVEL is a current level, CHANGE is by how much the level should be
  7228. modified. Even if CHANGE is nil, LEVEL may be returned modified because
  7229. even level numbers will become the next higher odd number."
  7230. (if org-odd-levels-only
  7231. (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
  7232. ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
  7233. ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
  7234. (max 1 (+ level (or change 0)))))
  7235. (if (boundp 'define-obsolete-function-alias)
  7236. (if (or (featurep 'xemacs) (< emacs-major-version 23))
  7237. (define-obsolete-function-alias 'org-get-legal-level
  7238. 'org-get-valid-level)
  7239. (define-obsolete-function-alias 'org-get-legal-level
  7240. 'org-get-valid-level "23.1")))
  7241. (defun org-promote ()
  7242. "Promote the current heading higher up the tree."
  7243. (org-with-wide-buffer
  7244. (org-back-to-heading t)
  7245. (let* ((after-change-functions (remq 'flyspell-after-change-function
  7246. after-change-functions))
  7247. (level (save-match-data (funcall outline-level)))
  7248. (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
  7249. (diff (abs (- level (length up-head) -1))))
  7250. (cond
  7251. ((and (= level 1) org-allow-promoting-top-level-subtree)
  7252. (replace-match "# " nil t))
  7253. ((= level 1)
  7254. (user-error "Cannot promote to level 0. UNDO to recover if necessary"))
  7255. (t (replace-match up-head nil t)))
  7256. (unless (= level 1)
  7257. (when org-auto-align-tags (org-set-tags nil 'ignore-column))
  7258. (when org-adapt-indentation (org-fixup-indentation (- diff))))
  7259. (run-hooks 'org-after-promote-entry-hook))))
  7260. (defun org-demote ()
  7261. "Demote the current heading lower down the tree."
  7262. (org-with-wide-buffer
  7263. (org-back-to-heading t)
  7264. (let* ((after-change-functions (remq 'flyspell-after-change-function
  7265. after-change-functions))
  7266. (level (save-match-data (funcall outline-level)))
  7267. (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
  7268. (diff (abs (- level (length down-head) -1))))
  7269. (replace-match down-head nil t)
  7270. (when org-auto-align-tags (org-set-tags nil 'ignore-column))
  7271. (when org-adapt-indentation (org-fixup-indentation diff))
  7272. (run-hooks 'org-after-demote-entry-hook))))
  7273. (defun org-cycle-level ()
  7274. "Cycle the level of an empty headline through possible states.
  7275. This goes first to child, then to parent, level, then up the hierarchy.
  7276. After top level, it switches back to sibling level."
  7277. (interactive)
  7278. (let ((org-adapt-indentation nil))
  7279. (when (org-point-at-end-of-empty-headline)
  7280. (setq this-command 'org-cycle-level) ; Only needed for caching
  7281. (let ((cur-level (org-current-level))
  7282. (prev-level (org-get-previous-line-level)))
  7283. (cond
  7284. ;; If first headline in file, promote to top-level.
  7285. ((= prev-level 0)
  7286. (loop repeat (/ (- cur-level 1) (org-level-increment))
  7287. do (org-do-promote)))
  7288. ;; If same level as prev, demote one.
  7289. ((= prev-level cur-level)
  7290. (org-do-demote))
  7291. ;; If parent is top-level, promote to top level if not already.
  7292. ((= prev-level 1)
  7293. (loop repeat (/ (- cur-level 1) (org-level-increment))
  7294. do (org-do-promote)))
  7295. ;; If top-level, return to prev-level.
  7296. ((= cur-level 1)
  7297. (loop repeat (/ (- prev-level 1) (org-level-increment))
  7298. do (org-do-demote)))
  7299. ;; If less than prev-level, promote one.
  7300. ((< cur-level prev-level)
  7301. (org-do-promote))
  7302. ;; If deeper than prev-level, promote until higher than
  7303. ;; prev-level.
  7304. ((> cur-level prev-level)
  7305. (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
  7306. do (org-do-promote))))
  7307. t))))
  7308. (defun org-map-tree (fun)
  7309. "Call FUN for every heading underneath the current one."
  7310. (org-back-to-heading)
  7311. (let ((level (funcall outline-level)))
  7312. (save-excursion
  7313. (funcall fun)
  7314. (while (and (progn
  7315. (outline-next-heading)
  7316. (> (funcall outline-level) level))
  7317. (not (eobp)))
  7318. (funcall fun)))))
  7319. (defun org-map-region (fun beg end)
  7320. "Call FUN for every heading between BEG and END."
  7321. (let ((org-ignore-region t))
  7322. (save-excursion
  7323. (setq end (copy-marker end))
  7324. (goto-char beg)
  7325. (if (and (re-search-forward org-outline-regexp-bol nil t)
  7326. (< (point) end))
  7327. (funcall fun))
  7328. (while (and (progn
  7329. (outline-next-heading)
  7330. (< (point) end))
  7331. (not (eobp)))
  7332. (funcall fun)))))
  7333. (defun org-fixup-indentation (diff)
  7334. "Change the indentation in the current entry by DIFF.
  7335. DIFF is an integer. Indentation is done according to the
  7336. following rules:
  7337. - Planning information and property drawers are always indented
  7338. according to the new level of the headline;
  7339. - Footnote definitions and their contents are ignored;
  7340. - Inlinetasks' boundaries are not shifted;
  7341. - Empty lines are ignored;
  7342. - Other lines' indentation are shifted by DIFF columns, unless
  7343. it would introduce a structural change in the document, in
  7344. which case no shifting is done at all.
  7345. Assume point is at a heading or an inlinetask beginning."
  7346. (org-with-wide-buffer
  7347. (narrow-to-region (line-beginning-position)
  7348. (save-excursion
  7349. (if (org-with-limited-levels (org-at-heading-p))
  7350. (org-with-limited-levels (outline-next-heading))
  7351. (org-inlinetask-goto-end))
  7352. (point)))
  7353. (forward-line)
  7354. ;; Indent properly planning info and property drawer.
  7355. (when (org-looking-at-p org-planning-line-re)
  7356. (org-indent-line)
  7357. (forward-line))
  7358. (when (looking-at org-property-drawer-re)
  7359. (goto-char (match-end 0))
  7360. (forward-line)
  7361. (save-excursion (org-indent-region (match-beginning 0) (match-end 0))))
  7362. (catch 'no-shift
  7363. (when (zerop diff) (throw 'no-shift nil))
  7364. ;; If DIFF is negative, first check if a shift is possible at all
  7365. ;; (e.g., it doesn't break structure). This can only happen if
  7366. ;; some contents are not properly indented.
  7367. (let ((case-fold-search t))
  7368. (when (< diff 0)
  7369. (let ((diff (- diff))
  7370. (forbidden-re (concat org-outline-regexp
  7371. "\\|"
  7372. (substring org-footnote-definition-re 1))))
  7373. (save-excursion
  7374. (while (not (eobp))
  7375. (cond
  7376. ((org-looking-at-p "[ \t]*$") (forward-line))
  7377. ((and (org-looking-at-p org-footnote-definition-re)
  7378. (let ((e (org-element-at-point)))
  7379. (and (eq (org-element-type e) 'footnote-definition)
  7380. (goto-char (org-element-property :end e))))))
  7381. ((org-looking-at-p org-outline-regexp) (forward-line))
  7382. ;; Give up if shifting would move before column 0 or
  7383. ;; if it would introduce a headline or a footnote
  7384. ;; definition.
  7385. (t
  7386. (skip-chars-forward " \t")
  7387. (let ((ind (current-column)))
  7388. (when (or (< ind diff)
  7389. (and (= ind diff) (org-looking-at-p forbidden-re)))
  7390. (throw 'no-shift nil)))
  7391. ;; Ignore contents of example blocks and source
  7392. ;; blocks if their indentation is meant to be
  7393. ;; preserved. Jump to block's closing line.
  7394. (beginning-of-line)
  7395. (or (and (org-looking-at-p "[ \t]*#\\+BEGIN_\\(EXAMPLE\\|SRC\\)")
  7396. (let ((e (org-element-at-point)))
  7397. (and (memq (org-element-type e)
  7398. '(example-block src-block))
  7399. (or org-src-preserve-indentation
  7400. (org-element-property :preserve-indent e))
  7401. (goto-char (org-element-property :end e))
  7402. (progn (skip-chars-backward " \r\t\n")
  7403. (beginning-of-line)
  7404. t))))
  7405. (forward-line))))))))
  7406. ;; Shift lines but footnote definitions, inlinetasks boundaries
  7407. ;; by DIFF. Also skip contents of source or example blocks
  7408. ;; when indentation is meant to be preserved.
  7409. (while (not (eobp))
  7410. (cond
  7411. ((and (org-looking-at-p org-footnote-definition-re)
  7412. (let ((e (org-element-at-point)))
  7413. (and (eq (org-element-type e) 'footnote-definition)
  7414. (goto-char (org-element-property :end e))))))
  7415. ((org-looking-at-p org-outline-regexp) (forward-line))
  7416. ((org-looking-at-p "[ \t]*$") (forward-line))
  7417. (t
  7418. (org-indent-line-to (+ (org-get-indentation) diff))
  7419. (beginning-of-line)
  7420. (or (and (org-looking-at-p "[ \t]*#\\+BEGIN_\\(EXAMPLE\\|SRC\\)")
  7421. (let ((e (org-element-at-point)))
  7422. (and (memq (org-element-type e)
  7423. '(example-block src-block))
  7424. (or org-src-preserve-indentation
  7425. (org-element-property :preserve-indent e))
  7426. (goto-char (org-element-property :end e))
  7427. (progn (skip-chars-backward " \r\t\n")
  7428. (beginning-of-line)
  7429. t))))
  7430. (forward-line)))))))))
  7431. (defun org-convert-to-odd-levels ()
  7432. "Convert an org-mode file with all levels allowed to one with odd levels.
  7433. This will leave level 1 alone, convert level 2 to level 3, level 3 to
  7434. level 5 etc."
  7435. (interactive)
  7436. (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
  7437. (let ((outline-level 'org-outline-level)
  7438. (org-odd-levels-only nil) n)
  7439. (save-excursion
  7440. (goto-char (point-min))
  7441. (while (re-search-forward "^\\*\\*+ " nil t)
  7442. (setq n (- (length (match-string 0)) 2))
  7443. (while (>= (setq n (1- n)) 0)
  7444. (org-demote))
  7445. (end-of-line 1))))))
  7446. (defun org-convert-to-oddeven-levels ()
  7447. "Convert an org-mode file with only odd levels to one with odd/even levels.
  7448. This promotes level 3 to level 2, level 5 to level 3 etc. If the
  7449. file contains a section with an even level, conversion would
  7450. destroy the structure of the file. An error is signaled in this
  7451. case."
  7452. (interactive)
  7453. (goto-char (point-min))
  7454. ;; First check if there are no even levels
  7455. (when (re-search-forward "^\\(\\*\\*\\)+ " nil t)
  7456. (org-show-set-visibility 'canonical)
  7457. (error "Not all levels are odd in this file. Conversion not possible"))
  7458. (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
  7459. (let ((outline-regexp org-outline-regexp)
  7460. (outline-level 'org-outline-level)
  7461. (org-odd-levels-only nil) n)
  7462. (save-excursion
  7463. (goto-char (point-min))
  7464. (while (re-search-forward "^\\*\\*+ " nil t)
  7465. (setq n (/ (1- (length (match-string 0))) 2))
  7466. (while (>= (setq n (1- n)) 0)
  7467. (org-promote))
  7468. (end-of-line 1))))))
  7469. (defun org-tr-level (n)
  7470. "Make N odd if required."
  7471. (if org-odd-levels-only (1+ (/ n 2)) n))
  7472. ;;; Vertical tree motion, cutting and pasting of subtrees
  7473. (defun org-move-subtree-up (&optional arg)
  7474. "Move the current subtree up past ARG headlines of the same level."
  7475. (interactive "p")
  7476. (org-move-subtree-down (- (prefix-numeric-value arg))))
  7477. (defun org-move-subtree-down (&optional arg)
  7478. "Move the current subtree down past ARG headlines of the same level."
  7479. (interactive "p")
  7480. (setq arg (prefix-numeric-value arg))
  7481. (let ((movfunc (if (> arg 0) 'org-get-next-sibling
  7482. 'org-get-last-sibling))
  7483. (ins-point (make-marker))
  7484. (cnt (abs arg))
  7485. (col (current-column))
  7486. beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
  7487. ;; Select the tree
  7488. (org-back-to-heading)
  7489. (setq beg0 (point))
  7490. (save-excursion
  7491. (setq ne-beg (org-back-over-empty-lines))
  7492. (setq beg (point)))
  7493. (save-match-data
  7494. (save-excursion (outline-end-of-heading)
  7495. (setq folded (outline-invisible-p)))
  7496. (progn (org-end-of-subtree nil t)
  7497. (unless (eobp) (backward-char))))
  7498. (outline-next-heading)
  7499. (setq ne-end (org-back-over-empty-lines))
  7500. (setq end (point))
  7501. (goto-char beg0)
  7502. (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
  7503. ;; include less whitespace
  7504. (save-excursion
  7505. (goto-char beg)
  7506. (forward-line (- ne-beg ne-end))
  7507. (setq beg (point))))
  7508. ;; Find insertion point, with error handling
  7509. (while (> cnt 0)
  7510. (or (and (funcall movfunc) (looking-at org-outline-regexp))
  7511. (progn (goto-char beg0)
  7512. (user-error "Cannot move past superior level or buffer limit")))
  7513. (setq cnt (1- cnt)))
  7514. (if (> arg 0)
  7515. ;; Moving forward - still need to move over subtree
  7516. (progn (org-end-of-subtree t t)
  7517. (save-excursion
  7518. (org-back-over-empty-lines)
  7519. (or (bolp) (newline)))))
  7520. (setq ne-ins (org-back-over-empty-lines))
  7521. (move-marker ins-point (point))
  7522. (setq txt (buffer-substring beg end))
  7523. (org-save-markers-in-region beg end)
  7524. (delete-region beg end)
  7525. (org-remove-empty-overlays-at beg)
  7526. (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
  7527. (or (bobp) (outline-flag-region (1- (point)) (point) nil))
  7528. (and (not (bolp)) (looking-at "\n") (forward-char 1))
  7529. (let ((bbb (point)))
  7530. (insert-before-markers txt)
  7531. (org-reinstall-markers-in-region bbb)
  7532. (move-marker ins-point bbb))
  7533. (or (bolp) (insert "\n"))
  7534. (setq ins-end (point))
  7535. (goto-char ins-point)
  7536. (org-skip-whitespace)
  7537. (when (and (< arg 0)
  7538. (org-first-sibling-p)
  7539. (> ne-ins ne-beg))
  7540. ;; Move whitespace back to beginning
  7541. (save-excursion
  7542. (goto-char ins-end)
  7543. (let ((kill-whole-line t))
  7544. (kill-line (- ne-ins ne-beg)) (point)))
  7545. (insert (make-string (- ne-ins ne-beg) ?\n)))
  7546. (move-marker ins-point nil)
  7547. (if folded
  7548. (hide-subtree)
  7549. (org-show-entry)
  7550. (show-children)
  7551. (org-cycle-hide-drawers 'children))
  7552. (org-clean-visibility-after-subtree-move)
  7553. ;; move back to the initial column we were at
  7554. (move-to-column col)))
  7555. (defvar org-subtree-clip ""
  7556. "Clipboard for cut and paste of subtrees.
  7557. This is actually only a copy of the kill, because we use the normal kill
  7558. ring. We need it to check if the kill was created by `org-copy-subtree'.")
  7559. (defvar org-subtree-clip-folded nil
  7560. "Was the last copied subtree folded?
  7561. This is used to fold the tree back after pasting.")
  7562. (defun org-cut-subtree (&optional n)
  7563. "Cut the current subtree into the clipboard.
  7564. With prefix arg N, cut this many sequential subtrees.
  7565. This is a short-hand for marking the subtree and then cutting it."
  7566. (interactive "p")
  7567. (org-copy-subtree n 'cut))
  7568. (defun org-copy-subtree (&optional n cut force-store-markers nosubtrees)
  7569. "Copy the current subtree it in the clipboard.
  7570. With prefix arg N, copy this many sequential subtrees.
  7571. This is a short-hand for marking the subtree and then copying it.
  7572. If CUT is non-nil, actually cut the subtree.
  7573. If FORCE-STORE-MARKERS is non-nil, store the relative locations
  7574. of some markers in the region, even if CUT is non-nil. This is
  7575. useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
  7576. (interactive "p")
  7577. (let (beg end folded (beg0 (point)))
  7578. (if (org-called-interactively-p 'any)
  7579. (org-back-to-heading nil) ; take what looks like a subtree
  7580. (org-back-to-heading t)) ; take what is really there
  7581. (setq beg (point))
  7582. (skip-chars-forward " \t\r\n")
  7583. (save-match-data
  7584. (if nosubtrees
  7585. (outline-next-heading)
  7586. (save-excursion (outline-end-of-heading)
  7587. (setq folded (outline-invisible-p)))
  7588. (ignore-errors (org-forward-heading-same-level (1- n) t))
  7589. (org-end-of-subtree t t)))
  7590. ;; Include the end of an inlinetask
  7591. (when (and (featurep 'org-inlinetask)
  7592. (looking-at-p (concat (org-inlinetask-outline-regexp)
  7593. "END[ \t]*$")))
  7594. (end-of-line))
  7595. (setq end (point))
  7596. (goto-char beg0)
  7597. (when (> end beg)
  7598. (setq org-subtree-clip-folded folded)
  7599. (when (or cut force-store-markers)
  7600. (org-save-markers-in-region beg end))
  7601. (if cut (kill-region beg end) (copy-region-as-kill beg end))
  7602. (setq org-subtree-clip (current-kill 0))
  7603. (message "%s: Subtree(s) with %d characters"
  7604. (if cut "Cut" "Copied")
  7605. (length org-subtree-clip)))))
  7606. (defun org-paste-subtree (&optional level tree for-yank remove)
  7607. "Paste the clipboard as a subtree, with modification of headline level.
  7608. The entire subtree is promoted or demoted in order to match a new headline
  7609. level.
  7610. If the cursor is at the beginning of a headline, the same level as
  7611. that headline is used to paste the tree.
  7612. If not, the new level is derived from the *visible* headings
  7613. before and after the insertion point, and taken to be the inferior headline
  7614. level of the two. So if the previous visible heading is level 3 and the
  7615. next is level 4 (or vice versa), level 4 will be used for insertion.
  7616. This makes sure that the subtree remains an independent subtree and does
  7617. not swallow low level entries.
  7618. You can also force a different level, either by using a numeric prefix
  7619. argument, or by inserting the heading marker by hand. For example, if the
  7620. cursor is after \"*****\", then the tree will be shifted to level 5.
  7621. If optional TREE is given, use this text instead of the kill ring.
  7622. When FOR-YANK is set, this is called by `org-yank'. In this case, do not
  7623. move back over whitespace before inserting, and move point to the end of
  7624. the inserted text when done.
  7625. When REMOVE is non-nil, remove the subtree from the clipboard."
  7626. (interactive "P")
  7627. (setq tree (or tree (and kill-ring (current-kill 0))))
  7628. (unless (org-kill-is-subtree-p tree)
  7629. (user-error "%s"
  7630. (substitute-command-keys
  7631. "The kill is not a (set of) tree(s) - please use \\[yank] to yank anyway")))
  7632. (org-with-limited-levels
  7633. (let* ((visp (not (outline-invisible-p)))
  7634. (txt tree)
  7635. (^re_ "\\(\\*+\\)[ \t]*")
  7636. (old-level (if (string-match org-outline-regexp-bol txt)
  7637. (- (match-end 0) (match-beginning 0) 1)
  7638. -1))
  7639. (force-level (cond (level (prefix-numeric-value level))
  7640. ((and (looking-at "[ \t]*$")
  7641. (string-match
  7642. "^\\*+$" (buffer-substring
  7643. (point-at-bol) (point))))
  7644. (- (match-end 0) (match-beginning 0)))
  7645. ((and (bolp)
  7646. (looking-at org-outline-regexp))
  7647. (- (match-end 0) (point) 1))))
  7648. (previous-level (save-excursion
  7649. (condition-case nil
  7650. (progn
  7651. (outline-previous-visible-heading 1)
  7652. (if (looking-at ^re_)
  7653. (- (match-end 0) (match-beginning 0) 1)
  7654. 1))
  7655. (error 1))))
  7656. (next-level (save-excursion
  7657. (condition-case nil
  7658. (progn
  7659. (or (looking-at org-outline-regexp)
  7660. (outline-next-visible-heading 1))
  7661. (if (looking-at ^re_)
  7662. (- (match-end 0) (match-beginning 0) 1)
  7663. 1))
  7664. (error 1))))
  7665. (new-level (or force-level (max previous-level next-level)))
  7666. (shift (if (or (= old-level -1)
  7667. (= new-level -1)
  7668. (= old-level new-level))
  7669. 0
  7670. (- new-level old-level)))
  7671. (delta (if (> shift 0) -1 1))
  7672. (func (if (> shift 0) 'org-demote 'org-promote))
  7673. (org-odd-levels-only nil)
  7674. beg end newend)
  7675. ;; Remove the forced level indicator
  7676. (if force-level
  7677. (delete-region (point-at-bol) (point)))
  7678. ;; Paste
  7679. (beginning-of-line (if (bolp) 1 2))
  7680. (setq beg (point))
  7681. (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
  7682. (insert-before-markers txt)
  7683. (unless (string-match "\n\\'" txt) (insert "\n"))
  7684. (setq newend (point))
  7685. (org-reinstall-markers-in-region beg)
  7686. (setq end (point))
  7687. (goto-char beg)
  7688. (skip-chars-forward " \t\n\r")
  7689. (setq beg (point))
  7690. (if (and (outline-invisible-p) visp)
  7691. (save-excursion (outline-show-heading)))
  7692. ;; Shift if necessary
  7693. (unless (= shift 0)
  7694. (save-restriction
  7695. (narrow-to-region beg end)
  7696. (while (not (= shift 0))
  7697. (org-map-region func (point-min) (point-max))
  7698. (setq shift (+ delta shift)))
  7699. (goto-char (point-min))
  7700. (setq newend (point-max))))
  7701. (when (or (org-called-interactively-p 'interactive) for-yank)
  7702. (message "Clipboard pasted as level %d subtree" new-level))
  7703. (if (and (not for-yank) ; in this case, org-yank will decide about folding
  7704. kill-ring
  7705. (eq org-subtree-clip (current-kill 0))
  7706. org-subtree-clip-folded)
  7707. ;; The tree was folded before it was killed/copied
  7708. (hide-subtree))
  7709. (and for-yank (goto-char newend))
  7710. (and remove (setq kill-ring (cdr kill-ring))))))
  7711. (defun org-kill-is-subtree-p (&optional txt)
  7712. "Check if the current kill is an outline subtree, or a set of trees.
  7713. Returns nil if kill does not start with a headline, or if the first
  7714. headline level is not the largest headline level in the tree.
  7715. So this will actually accept several entries of equal levels as well,
  7716. which is OK for `org-paste-subtree'.
  7717. If optional TXT is given, check this string instead of the current kill."
  7718. (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
  7719. (re (org-get-limited-outline-regexp))
  7720. (^re (concat "^" re))
  7721. (start-level (and kill
  7722. (string-match
  7723. (concat "\\`\\([ \t\n\r]*?\n\\)?\\(" re "\\)")
  7724. kill)
  7725. (- (match-end 2) (match-beginning 2) 1)))
  7726. (start (1+ (or (match-beginning 2) -1))))
  7727. (if (not start-level)
  7728. (progn
  7729. nil) ;; does not even start with a heading
  7730. (catch 'exit
  7731. (while (setq start (string-match ^re kill (1+ start)))
  7732. (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
  7733. (throw 'exit nil)))
  7734. t))))
  7735. (defvar org-markers-to-move nil
  7736. "Markers that should be moved with a cut-and-paste operation.
  7737. Those markers are stored together with their positions relative to
  7738. the start of the region.")
  7739. (defun org-save-markers-in-region (beg end)
  7740. "Check markers in region.
  7741. If these markers are between BEG and END, record their position relative
  7742. to BEG, so that after moving the block of text, we can put the markers back
  7743. into place.
  7744. This function gets called just before an entry or tree gets cut from the
  7745. buffer. After re-insertion, `org-reinstall-markers-in-region' must be
  7746. called immediately, to move the markers with the entries."
  7747. (setq org-markers-to-move nil)
  7748. (when (featurep 'org-clock)
  7749. (org-clock-save-markers-for-cut-and-paste beg end))
  7750. (when (featurep 'org-agenda)
  7751. (org-agenda-save-markers-for-cut-and-paste beg end)))
  7752. (defun org-check-and-save-marker (marker beg end)
  7753. "Check if MARKER is between BEG and END.
  7754. If yes, remember the marker and the distance to BEG."
  7755. (when (and (marker-buffer marker)
  7756. (equal (marker-buffer marker) (current-buffer)))
  7757. (if (and (>= marker beg) (< marker end))
  7758. (push (cons marker (- marker beg)) org-markers-to-move))))
  7759. (defun org-reinstall-markers-in-region (beg)
  7760. "Move all remembered markers to their position relative to BEG."
  7761. (mapc (lambda (x)
  7762. (move-marker (car x) (+ beg (cdr x))))
  7763. org-markers-to-move)
  7764. (setq org-markers-to-move nil))
  7765. (defun org-narrow-to-subtree ()
  7766. "Narrow buffer to the current subtree."
  7767. (interactive)
  7768. (save-excursion
  7769. (save-match-data
  7770. (org-with-limited-levels
  7771. (narrow-to-region
  7772. (progn (org-back-to-heading t) (point))
  7773. (progn (org-end-of-subtree t t)
  7774. (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
  7775. (point)))))))
  7776. (defun org-narrow-to-block ()
  7777. "Narrow buffer to the current block."
  7778. (interactive)
  7779. (let* ((case-fold-search t)
  7780. (blockp (org-between-regexps-p "^[ \t]*#\\+begin_.*"
  7781. "^[ \t]*#\\+end_.*")))
  7782. (if blockp
  7783. (narrow-to-region (car blockp) (cdr blockp))
  7784. (user-error "Not in a block"))))
  7785. (defun org-clone-subtree-with-time-shift (n &optional shift)
  7786. "Clone the task (subtree) at point N times.
  7787. The clones will be inserted as siblings.
  7788. In interactive use, the user will be prompted for the number of
  7789. clones to be produced. If the entry has a timestamp, the user
  7790. will also be prompted for a time shift, which may be a repeater
  7791. as used in time stamps, for example `+3d'. To disable this,
  7792. you can call the function with a universal prefix argument.
  7793. When a valid repeater is given and the entry contains any time
  7794. stamps, the clones will become a sequence in time, with time
  7795. stamps in the subtree shifted for each clone produced. If SHIFT
  7796. is nil or the empty string, time stamps will be left alone. The
  7797. ID property of the original subtree is removed.
  7798. If the original subtree did contain time stamps with a repeater,
  7799. the following will happen:
  7800. - the repeater will be removed in each clone
  7801. - an additional clone will be produced, with the current, unshifted
  7802. date(s) in the entry.
  7803. - the original entry will be placed *after* all the clones, with
  7804. repeater intact.
  7805. - the start days in the repeater in the original entry will be shifted
  7806. to past the last clone.
  7807. In this way you can spell out a number of instances of a repeating task,
  7808. and still retain the repeater to cover future instances of the task."
  7809. (interactive "nNumber of clones to produce: ")
  7810. (let ((shift
  7811. (or shift
  7812. (if (and (not (equal current-prefix-arg '(4)))
  7813. (save-excursion
  7814. (re-search-forward org-ts-regexp-both
  7815. (save-excursion
  7816. (org-end-of-subtree t)
  7817. (point)) t)))
  7818. (read-from-minibuffer
  7819. "Date shift per clone (e.g. +1w, empty to copy unchanged): ")
  7820. ""))) ;; No time shift
  7821. (n-no-remove -1)
  7822. (drawer-re org-drawer-regexp)
  7823. (org-clock-re (format "^[ \t]*%s.*$" org-clock-string))
  7824. beg end template task idprop
  7825. shift-n shift-what doshift nmin nmax)
  7826. (if (not (and (integerp n) (> n 0)))
  7827. (user-error "Invalid number of replications %s" n))
  7828. (if (and (setq doshift (and (stringp shift) (string-match "\\S-" shift)))
  7829. (not (string-match "\\`[ \t]*\\+?\\([0-9]+\\)\\([hdwmy]\\)[ \t]*\\'"
  7830. shift)))
  7831. (user-error "Invalid shift specification %s" shift))
  7832. (when doshift
  7833. (setq shift-n (string-to-number (match-string 1 shift))
  7834. shift-what (cdr (assoc (match-string 2 shift)
  7835. '(("d" . day) ("w" . week)
  7836. ("m" . month) ("y" . year))))))
  7837. (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
  7838. (setq nmin 1 nmax n)
  7839. (org-back-to-heading t)
  7840. (setq beg (point))
  7841. (setq idprop (org-entry-get nil "ID"))
  7842. (org-end-of-subtree t t)
  7843. (or (bolp) (insert "\n"))
  7844. (setq end (point))
  7845. (setq template (buffer-substring beg end))
  7846. (when (and doshift
  7847. (string-match "<[^<>\n]+ [.+]?\\+[0-9]+[hdwmy][^<>\n]*>" template))
  7848. (delete-region beg end)
  7849. (setq end beg)
  7850. (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
  7851. (goto-char end)
  7852. (loop for n from nmin to nmax do
  7853. ;; prepare clone
  7854. (with-temp-buffer
  7855. (insert template)
  7856. (org-mode)
  7857. (goto-char (point-min))
  7858. (org-show-subtree)
  7859. (and idprop (if org-clone-delete-id
  7860. (org-entry-delete nil "ID")
  7861. (org-id-get-create t)))
  7862. (unless (= n 0)
  7863. (while (re-search-forward org-clock-re nil t)
  7864. (kill-whole-line))
  7865. (goto-char (point-min))
  7866. (while (re-search-forward drawer-re nil t)
  7867. (org-remove-empty-drawer-at (point))))
  7868. (goto-char (point-min))
  7869. (when doshift
  7870. (while (re-search-forward org-ts-regexp-both nil t)
  7871. (org-timestamp-change (* n shift-n) shift-what))
  7872. (unless (= n n-no-remove)
  7873. (goto-char (point-min))
  7874. (while (re-search-forward org-ts-regexp nil t)
  7875. (save-excursion
  7876. (goto-char (match-beginning 0))
  7877. (if (looking-at "<[^<>\n]+\\( +[.+]?\\+[0-9]+[hdwmy]\\)")
  7878. (delete-region (match-beginning 1) (match-end 1)))))))
  7879. (setq task (buffer-string)))
  7880. (insert task))
  7881. (goto-char beg)))
  7882. ;;; Outline Sorting
  7883. (defun org-sort (with-case)
  7884. "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
  7885. Optional argument WITH-CASE means sort case-sensitively."
  7886. (interactive "P")
  7887. (cond
  7888. ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
  7889. ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
  7890. (t
  7891. (org-call-with-arg 'org-sort-entries with-case))))
  7892. (defun org-sort-remove-invisible (s)
  7893. "Remove invisible links from string S."
  7894. (remove-text-properties 0 (length s) org-rm-props s)
  7895. (while (string-match org-bracket-link-regexp s)
  7896. (setq s (replace-match (if (match-end 2)
  7897. (match-string 3 s)
  7898. (match-string 1 s)) t t s)))
  7899. (let ((st (format " %s " s)))
  7900. (while (string-match org-emph-re st)
  7901. (setq st (replace-match (format " %s " (match-string 4 st)) t t st)))
  7902. (setq s (substring st 1 -1)))
  7903. s)
  7904. (defvar org-priority-regexp) ; defined later in the file
  7905. (defvar org-after-sorting-entries-or-items-hook nil
  7906. "Hook that is run after a bunch of entries or items have been sorted.
  7907. When children are sorted, the cursor is in the parent line when this
  7908. hook gets called. When a region or a plain list is sorted, the cursor
  7909. will be in the first entry of the sorted region/list.")
  7910. (defun org-sort-entries
  7911. (&optional with-case sorting-type getkey-func compare-func property)
  7912. "Sort entries on a certain level of an outline tree.
  7913. If there is an active region, the entries in the region are sorted.
  7914. Else, if the cursor is before the first entry, sort the top-level items.
  7915. Else, the children of the entry at point are sorted.
  7916. Sorting can be alphabetically, numerically, by date/time as given by
  7917. a time stamp, by a property, by priority order, or by a custom function.
  7918. The command prompts for the sorting type unless it has been given to the
  7919. function through the SORTING-TYPE argument, which needs to be a character,
  7920. \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?o ?O ?r ?R ?f ?F ?k ?K). Here is
  7921. the precise meaning of each character:
  7922. a Alphabetically, ignoring the TODO keyword and the priority, if any.
  7923. c By creation time, which is assumed to be the first inactive time stamp
  7924. at the beginning of a line.
  7925. d By deadline date/time.
  7926. k By clocking time.
  7927. n Numerically, by converting the beginning of the entry/item to a number.
  7928. o By order of TODO keywords.
  7929. p By priority according to the cookie.
  7930. r By the value of a property.
  7931. s By scheduled date/time.
  7932. t By date/time, either the first active time stamp in the entry, or, if
  7933. none exist, by the first inactive one.
  7934. Capital letters will reverse the sort order.
  7935. If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
  7936. called with point at the beginning of the record. It must return either
  7937. a string or a number that should serve as the sorting key for that record.
  7938. Comparing entries ignores case by default. However, with an optional argument
  7939. WITH-CASE, the sorting considers case as well.
  7940. Sorting is done against the visible part of the headlines, it ignores hidden
  7941. links.
  7942. When sorting is done, call `org-after-sorting-entries-or-items-hook'."
  7943. (interactive "P")
  7944. (let ((case-func (if with-case 'identity 'downcase))
  7945. (cmstr
  7946. ;; The clock marker is lost when using `sort-subr', let's
  7947. ;; store the clocking string.
  7948. (when (equal (marker-buffer org-clock-marker) (current-buffer))
  7949. (save-excursion
  7950. (goto-char org-clock-marker)
  7951. (looking-back "^.*") (match-string-no-properties 0))))
  7952. start beg end stars re re2
  7953. txt what tmp)
  7954. ;; Find beginning and end of region to sort
  7955. (cond
  7956. ((org-region-active-p)
  7957. ;; we will sort the region
  7958. (setq end (region-end)
  7959. what "region")
  7960. (goto-char (region-beginning))
  7961. (if (not (org-at-heading-p)) (outline-next-heading))
  7962. (setq start (point)))
  7963. ((or (org-at-heading-p)
  7964. (ignore-errors (progn (org-back-to-heading) t)))
  7965. ;; we will sort the children of the current headline
  7966. (org-back-to-heading)
  7967. (setq start (point)
  7968. end (progn (org-end-of-subtree t t)
  7969. (or (bolp) (insert "\n"))
  7970. (when (>= (org-back-over-empty-lines) 1)
  7971. (forward-line 1))
  7972. (point))
  7973. what "children")
  7974. (goto-char start)
  7975. (show-subtree)
  7976. (outline-next-heading))
  7977. (t
  7978. ;; we will sort the top-level entries in this file
  7979. (goto-char (point-min))
  7980. (or (org-at-heading-p) (outline-next-heading))
  7981. (setq start (point))
  7982. (goto-char (point-max))
  7983. (beginning-of-line 1)
  7984. (when (looking-at ".*?\\S-")
  7985. ;; File ends in a non-white line
  7986. (end-of-line 1)
  7987. (insert "\n"))
  7988. (setq end (point-max))
  7989. (setq what "top-level")
  7990. (goto-char start)
  7991. (show-all)))
  7992. (setq beg (point))
  7993. (when (>= beg end) (goto-char start) (user-error "Nothing to sort"))
  7994. (looking-at "\\(\\*+\\)")
  7995. (setq stars (match-string 1)
  7996. re (concat "^" (regexp-quote stars) " +")
  7997. re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[ \t\n]")
  7998. txt (buffer-substring beg end))
  7999. (if (not (equal (substring txt -1) "\n")) (setq txt (concat txt "\n")))
  8000. (if (and (not (equal stars "*")) (string-match re2 txt))
  8001. (user-error "Region to sort contains a level above the first entry"))
  8002. (unless sorting-type
  8003. (message
  8004. "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
  8005. [t]ime [s]cheduled [d]eadline [c]reated cloc[k]ing
  8006. A/N/P/R/O/F/T/S/D/C/K means reversed:"
  8007. what)
  8008. (setq sorting-type (read-char-exclusive))
  8009. (unless getkey-func
  8010. (and (= (downcase sorting-type) ?f)
  8011. (setq getkey-func
  8012. (org-icompleting-read "Sort using function: "
  8013. obarray 'fboundp t nil nil))
  8014. (setq getkey-func (intern getkey-func))))
  8015. (and (= (downcase sorting-type) ?r)
  8016. (not property)
  8017. (setq property
  8018. (org-icompleting-read "Property: "
  8019. (mapcar 'list (org-buffer-property-keys t))
  8020. nil t))))
  8021. (when (member sorting-type '(?k ?K)) (org-clock-sum))
  8022. (message "Sorting entries...")
  8023. (save-restriction
  8024. (narrow-to-region start end)
  8025. (let ((dcst (downcase sorting-type))
  8026. (case-fold-search nil)
  8027. (now (current-time)))
  8028. (sort-subr
  8029. (/= dcst sorting-type)
  8030. ;; This function moves to the beginning character of the "record" to
  8031. ;; be sorted.
  8032. (lambda nil
  8033. (if (re-search-forward re nil t)
  8034. (goto-char (match-beginning 0))
  8035. (goto-char (point-max))))
  8036. ;; This function moves to the last character of the "record" being
  8037. ;; sorted.
  8038. (lambda nil
  8039. (save-match-data
  8040. (condition-case nil
  8041. (outline-forward-same-level 1)
  8042. (error
  8043. (goto-char (point-max))))))
  8044. ;; This function returns the value that gets sorted against.
  8045. (lambda nil
  8046. (cond
  8047. ((= dcst ?n)
  8048. (if (looking-at org-complex-heading-regexp)
  8049. (string-to-number (org-sort-remove-invisible (match-string 4)))
  8050. nil))
  8051. ((= dcst ?a)
  8052. (if (looking-at org-complex-heading-regexp)
  8053. (funcall case-func (org-sort-remove-invisible (match-string 4)))
  8054. nil))
  8055. ((= dcst ?k)
  8056. (or (get-text-property (point) :org-clock-minutes) 0))
  8057. ((= dcst ?t)
  8058. (let ((end (save-excursion (outline-next-heading) (point))))
  8059. (if (or (re-search-forward org-ts-regexp end t)
  8060. (re-search-forward org-ts-regexp-both end t))
  8061. (org-time-string-to-seconds (match-string 0))
  8062. (org-float-time now))))
  8063. ((= dcst ?c)
  8064. (let ((end (save-excursion (outline-next-heading) (point))))
  8065. (if (re-search-forward
  8066. (concat "^[ \t]*\\[" org-ts-regexp1 "\\]")
  8067. end t)
  8068. (org-time-string-to-seconds (match-string 0))
  8069. (org-float-time now))))
  8070. ((= dcst ?s)
  8071. (let ((end (save-excursion (outline-next-heading) (point))))
  8072. (if (re-search-forward org-scheduled-time-regexp end t)
  8073. (org-time-string-to-seconds (match-string 1))
  8074. (org-float-time now))))
  8075. ((= dcst ?d)
  8076. (let ((end (save-excursion (outline-next-heading) (point))))
  8077. (if (re-search-forward org-deadline-time-regexp end t)
  8078. (org-time-string-to-seconds (match-string 1))
  8079. (org-float-time now))))
  8080. ((= dcst ?p)
  8081. (if (re-search-forward org-priority-regexp (point-at-eol) t)
  8082. (string-to-char (match-string 2))
  8083. org-default-priority))
  8084. ((= dcst ?r)
  8085. (or (org-entry-get nil property) ""))
  8086. ((= dcst ?o)
  8087. (if (looking-at org-complex-heading-regexp)
  8088. (let* ((m (match-string 2))
  8089. (s (if (member m org-done-keywords) '- '+)))
  8090. (- 99 (funcall s (length (member m org-todo-keywords-1)))))))
  8091. ((= dcst ?f)
  8092. (if getkey-func
  8093. (progn
  8094. (setq tmp (funcall getkey-func))
  8095. (if (stringp tmp) (setq tmp (funcall case-func tmp)))
  8096. tmp)
  8097. (error "Invalid key function `%s'" getkey-func)))
  8098. (t (error "Invalid sorting type `%c'" sorting-type))))
  8099. nil
  8100. (cond
  8101. ((= dcst ?a) 'string<)
  8102. ((= dcst ?f) compare-func)
  8103. ((member dcst '(?p ?t ?s ?d ?c ?k)) '<)))))
  8104. (run-hooks 'org-after-sorting-entries-or-items-hook)
  8105. ;; Reset the clock marker if needed
  8106. (when cmstr
  8107. (save-excursion
  8108. (goto-char start)
  8109. (search-forward cmstr nil t)
  8110. (move-marker org-clock-marker (point))))
  8111. (message "Sorting entries...done")))
  8112. ;;; The orgstruct minor mode
  8113. ;; Define a minor mode which can be used in other modes in order to
  8114. ;; integrate the org-mode structure editing commands.
  8115. ;; This is really a hack, because the org-mode structure commands use
  8116. ;; keys which normally belong to the major mode. Here is how it
  8117. ;; works: The minor mode defines all the keys necessary to operate the
  8118. ;; structure commands, but wraps the commands into a function which
  8119. ;; tests if the cursor is currently at a headline or a plain list
  8120. ;; item. If that is the case, the structure command is used,
  8121. ;; temporarily setting many Org-mode variables like regular
  8122. ;; expressions for filling etc. However, when any of those keys is
  8123. ;; used at a different location, function uses `key-binding' to look
  8124. ;; up if the key has an associated command in another currently active
  8125. ;; keymap (minor modes, major mode, global), and executes that
  8126. ;; command. There might be problems if any of the keys is otherwise
  8127. ;; used as a prefix key.
  8128. (defcustom orgstruct-heading-prefix-regexp ""
  8129. "Regexp that matches the custom prefix of Org headlines in
  8130. orgstruct(++)-mode."
  8131. :group 'org
  8132. :version "24.4"
  8133. :package-version '(Org . "8.3")
  8134. :type 'regexp)
  8135. ;;;###autoload(put 'orgstruct-heading-prefix-regexp 'safe-local-variable 'stringp)
  8136. (defcustom orgstruct-setup-hook nil
  8137. "Hook run after orgstruct-mode-map is filled."
  8138. :group 'org
  8139. :version "24.4"
  8140. :package-version '(Org . "8.0")
  8141. :type 'hook)
  8142. (defvar orgstruct-initialized nil)
  8143. (defvar org-local-vars nil
  8144. "List of local variables, for use by `orgstruct-mode'.")
  8145. ;;;###autoload
  8146. (define-minor-mode orgstruct-mode
  8147. "Toggle the minor mode `orgstruct-mode'.
  8148. This mode is for using Org-mode structure commands in other
  8149. modes. The following keys behave as if Org-mode were active, if
  8150. the cursor is on a headline, or on a plain list item (both as
  8151. defined by Org-mode)."
  8152. nil " OrgStruct" (make-sparse-keymap)
  8153. (funcall (if orgstruct-mode
  8154. 'add-to-invisibility-spec
  8155. 'remove-from-invisibility-spec)
  8156. '(outline . t))
  8157. (when orgstruct-mode
  8158. (org-load-modules-maybe)
  8159. (unless orgstruct-initialized
  8160. (orgstruct-setup)
  8161. (setq orgstruct-initialized t))))
  8162. ;;;###autoload
  8163. (defun turn-on-orgstruct ()
  8164. "Unconditionally turn on `orgstruct-mode'."
  8165. (orgstruct-mode 1))
  8166. (defvar org-fb-vars nil)
  8167. (make-variable-buffer-local 'org-fb-vars)
  8168. (defun orgstruct++-mode (&optional arg)
  8169. "Toggle `orgstruct-mode', the enhanced version of it.
  8170. In addition to setting orgstruct-mode, this also exports all
  8171. indentation and autofilling variables from org-mode into the
  8172. buffer. It will also recognize item context in multiline items."
  8173. (interactive "P")
  8174. (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
  8175. (if (< arg 1)
  8176. (progn (orgstruct-mode -1)
  8177. (mapc (lambda(v)
  8178. (org-set-local (car v)
  8179. (if (eq (car-safe (cadr v)) 'quote) (cadadr v) (cadr v))))
  8180. org-fb-vars))
  8181. (orgstruct-mode 1)
  8182. (setq org-fb-vars nil)
  8183. (unless org-local-vars
  8184. (setq org-local-vars (org-get-local-variables)))
  8185. (let (var val)
  8186. (mapc
  8187. (lambda (x)
  8188. (when (string-match
  8189. "^\\(paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|fill-prefix\\|indent-\\)"
  8190. (symbol-name (car x)))
  8191. (setq var (car x) val (nth 1 x))
  8192. (push (list var `(quote ,(eval var))) org-fb-vars)
  8193. (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
  8194. org-local-vars)
  8195. (org-set-local 'orgstruct-is-++ t))))
  8196. (defvar orgstruct-is-++ nil
  8197. "Is `orgstruct-mode' in ++ version in the current-buffer?")
  8198. (make-variable-buffer-local 'orgstruct-is-++)
  8199. ;;;###autoload
  8200. (defun turn-on-orgstruct++ ()
  8201. "Unconditionally turn on `orgstruct++-mode'."
  8202. (orgstruct++-mode 1))
  8203. (defun orgstruct-error ()
  8204. "Error when there is no default binding for a structure key."
  8205. (interactive)
  8206. (funcall (if (fboundp 'user-error)
  8207. 'user-error
  8208. 'error)
  8209. "This key has no function outside structure elements"))
  8210. (defun orgstruct-setup ()
  8211. "Setup orgstruct keymap."
  8212. (dolist (cell '((org-demote . t)
  8213. (org-metaleft . t)
  8214. (org-metaright . t)
  8215. (org-promote . t)
  8216. (org-shiftmetaleft . t)
  8217. (org-shiftmetaright . t)
  8218. org-backward-element
  8219. org-backward-heading-same-level
  8220. org-ctrl-c-ret
  8221. org-ctrl-c-minus
  8222. org-ctrl-c-star
  8223. org-cycle
  8224. org-forward-heading-same-level
  8225. org-insert-heading
  8226. org-insert-heading-respect-content
  8227. org-kill-note-or-show-branches
  8228. org-mark-subtree
  8229. org-meta-return
  8230. org-metadown
  8231. org-metaup
  8232. org-narrow-to-subtree
  8233. org-promote-subtree
  8234. org-reveal
  8235. org-shiftdown
  8236. org-shiftleft
  8237. org-shiftmetadown
  8238. org-shiftmetaup
  8239. org-shiftright
  8240. org-shifttab
  8241. org-shifttab
  8242. org-shiftup
  8243. org-show-subtree
  8244. org-sort
  8245. org-up-element
  8246. outline-demote
  8247. outline-next-visible-heading
  8248. outline-previous-visible-heading
  8249. outline-promote
  8250. outline-up-heading
  8251. show-children))
  8252. (let ((f (or (car-safe cell) cell))
  8253. (disable-when-heading-prefix (cdr-safe cell)))
  8254. (when (fboundp f)
  8255. (let ((new-bindings))
  8256. (dolist (binding (nconc (where-is-internal f org-mode-map)
  8257. (where-is-internal f outline-mode-map)))
  8258. (push binding new-bindings)
  8259. ;; TODO use local-function-key-map
  8260. (dolist (rep '(("<tab>" . "TAB")
  8261. ("<return>" . "RET")
  8262. ("<escape>" . "ESC")
  8263. ("<delete>" . "DEL")))
  8264. (setq binding (read-kbd-macro
  8265. (let ((case-fold-search))
  8266. (replace-regexp-in-string
  8267. (regexp-quote (cdr rep))
  8268. (car rep)
  8269. (key-description binding)))))
  8270. (pushnew binding new-bindings :test 'equal)))
  8271. (dolist (binding new-bindings)
  8272. (let ((key (lookup-key orgstruct-mode-map binding)))
  8273. (when (or (not key) (numberp key))
  8274. (ignore-errors
  8275. (org-defkey orgstruct-mode-map
  8276. binding
  8277. (orgstruct-make-binding
  8278. f binding disable-when-heading-prefix))))))))))
  8279. (run-hooks 'orgstruct-setup-hook))
  8280. (defun orgstruct-make-binding (fun key disable-when-heading-prefix)
  8281. "Create a function for binding in the structure minor mode.
  8282. FUN is the command to call inside a table. KEY is the key that
  8283. should be checked in for a command to execute outside of tables.
  8284. Non-nil `disable-when-heading-prefix' means to disable the command
  8285. if `orgstruct-heading-prefix-regexp' is not empty."
  8286. (let ((name (concat "orgstruct-hijacker-" (symbol-name fun))))
  8287. (let ((nname name)
  8288. (i 0))
  8289. (while (fboundp (intern nname))
  8290. (setq nname (format "%s-%d" name (setq i (1+ i)))))
  8291. (setq name (intern nname)))
  8292. (eval
  8293. (let ((bindings '((org-heading-regexp
  8294. (concat "^"
  8295. orgstruct-heading-prefix-regexp
  8296. "\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ ]*$"))
  8297. (org-outline-regexp
  8298. (concat orgstruct-heading-prefix-regexp "\\*+ "))
  8299. (org-outline-regexp-bol
  8300. (concat "^" org-outline-regexp))
  8301. (outline-regexp org-outline-regexp)
  8302. (outline-heading-end-regexp "\n")
  8303. (outline-level 'org-outline-level)
  8304. (outline-heading-alist))))
  8305. `(defun ,name (arg)
  8306. ,(concat "In Structure, run `" (symbol-name fun) "'.\n"
  8307. "Outside of structure, run the binding of `"
  8308. (key-description key) "'."
  8309. (when disable-when-heading-prefix
  8310. (concat
  8311. "\nIf `orgstruct-heading-prefix-regexp' is not empty, this command will always fall\n"
  8312. "back to the default binding due to limitations of Org's implementation of\n"
  8313. "`" (symbol-name fun) "'.")))
  8314. (interactive "p")
  8315. (let* ((disable
  8316. ,(and disable-when-heading-prefix
  8317. '(not (string= orgstruct-heading-prefix-regexp ""))))
  8318. (fallback
  8319. (or disable
  8320. (not
  8321. (let* ,bindings
  8322. (org-context-p 'headline 'item
  8323. ,(when (memq fun
  8324. '(org-insert-heading
  8325. org-insert-heading-respect-content
  8326. org-meta-return))
  8327. '(when orgstruct-is-++
  8328. 'item-body))))))))
  8329. (if fallback
  8330. (let* ((orgstruct-mode)
  8331. (binding
  8332. (let ((key ,key))
  8333. (catch 'exit
  8334. (dolist
  8335. (rep
  8336. '(nil
  8337. ("<\\([^>]*\\)tab>" . "\\1TAB")
  8338. ("<\\([^>]*\\)return>" . "\\1RET")
  8339. ("<\\([^>]*\\)escape>" . "\\1ESC")
  8340. ("<\\([^>]*\\)delete>" . "\\1DEL"))
  8341. nil)
  8342. (when rep
  8343. (setq key (read-kbd-macro
  8344. (let ((case-fold-search))
  8345. (replace-regexp-in-string
  8346. (car rep)
  8347. (cdr rep)
  8348. (key-description key))))))
  8349. (when (key-binding key)
  8350. (throw 'exit (key-binding key))))))))
  8351. (if (keymapp binding)
  8352. (org-set-transient-map binding)
  8353. (let ((func (or binding
  8354. (unless disable
  8355. 'orgstruct-error))))
  8356. (when func
  8357. (call-interactively func)))))
  8358. (org-run-like-in-org-mode
  8359. (lambda ()
  8360. (interactive)
  8361. (let* ,bindings
  8362. (call-interactively ',fun)))))))))
  8363. name))
  8364. (defun org-contextualize-keys (alist contexts)
  8365. "Return valid elements in ALIST depending on CONTEXTS.
  8366. `org-agenda-custom-commands' or `org-capture-templates' are the
  8367. values used for ALIST, and `org-agenda-custom-commands-contexts'
  8368. or `org-capture-templates-contexts' are the associated contexts
  8369. definitions."
  8370. (let ((contexts
  8371. ;; normalize contexts
  8372. (mapcar
  8373. (lambda(c) (cond ((listp (cadr c))
  8374. (list (car c) (car c) (cadr c)))
  8375. ((string= "" (cadr c))
  8376. (list (car c) (car c) (caddr c)))
  8377. (t c))) contexts))
  8378. (a alist) c r s)
  8379. ;; loop over all commands or templates
  8380. (while (setq c (pop a))
  8381. (let (vrules repl)
  8382. (cond
  8383. ((not (assoc (car c) contexts))
  8384. (push c r))
  8385. ((and (assoc (car c) contexts)
  8386. (setq vrules (org-contextualize-validate-key
  8387. (car c) contexts)))
  8388. (mapc (lambda (vr)
  8389. (when (not (equal (car vr) (cadr vr)))
  8390. (setq repl vr))) vrules)
  8391. (if (not repl) (push c r)
  8392. (push (cadr repl) s)
  8393. (push
  8394. (cons (car c)
  8395. (cdr (or (assoc (cadr repl) alist)
  8396. (error "Undefined key `%s' as contextual replacement for `%s'"
  8397. (cadr repl) (car c)))))
  8398. r))))))
  8399. ;; Return limited ALIST, possibly with keys modified, and deduplicated
  8400. (delq
  8401. nil
  8402. (delete-dups
  8403. (mapcar (lambda (x)
  8404. (let ((tpl (car x)))
  8405. (when (not (delq
  8406. nil
  8407. (mapcar (lambda(y)
  8408. (equal y tpl)) s))) x)))
  8409. (reverse r))))))
  8410. (defun org-contextualize-validate-key (key contexts)
  8411. "Check CONTEXTS for agenda or capture KEY."
  8412. (let (r rr res)
  8413. (while (setq r (pop contexts))
  8414. (mapc
  8415. (lambda (rr)
  8416. (when
  8417. (and (equal key (car r))
  8418. (if (functionp rr) (funcall rr)
  8419. (or (and (eq (car rr) 'in-file)
  8420. (buffer-file-name)
  8421. (string-match (cdr rr) (buffer-file-name)))
  8422. (and (eq (car rr) 'in-mode)
  8423. (string-match (cdr rr) (symbol-name major-mode)))
  8424. (and (eq (car rr) 'in-buffer)
  8425. (string-match (cdr rr) (buffer-name)))
  8426. (when (and (eq (car rr) 'not-in-file)
  8427. (buffer-file-name))
  8428. (not (string-match (cdr rr) (buffer-file-name))))
  8429. (when (eq (car rr) 'not-in-mode)
  8430. (not (string-match (cdr rr) (symbol-name major-mode))))
  8431. (when (eq (car rr) 'not-in-buffer)
  8432. (not (string-match (cdr rr) (buffer-name)))))))
  8433. (push r res)))
  8434. (car (last r))))
  8435. (delete-dups (delq nil res))))
  8436. (defun org-context-p (&rest contexts)
  8437. "Check if local context is any of CONTEXTS.
  8438. Possible values in the list of contexts are `table', `headline', and `item'."
  8439. (let ((pos (point)))
  8440. (goto-char (point-at-bol))
  8441. (prog1 (or (and (memq 'table contexts)
  8442. (looking-at "[ \t]*|"))
  8443. (and (memq 'headline contexts)
  8444. (looking-at org-outline-regexp))
  8445. (and (memq 'item contexts)
  8446. (looking-at "[ \t]*\\([-+*] \\|[0-9]+[.)] \\)"))
  8447. (and (memq 'item-body contexts)
  8448. (org-in-item-p)))
  8449. (goto-char pos))))
  8450. (defun org-get-local-variables ()
  8451. "Return a list of all local variables in an Org mode buffer."
  8452. (let (varlist)
  8453. (with-current-buffer (get-buffer-create "*Org tmp*")
  8454. (erase-buffer)
  8455. (org-mode)
  8456. (setq varlist (buffer-local-variables)))
  8457. (kill-buffer "*Org tmp*")
  8458. (delq nil
  8459. (mapcar
  8460. (lambda (x)
  8461. (setq x
  8462. (if (symbolp x)
  8463. (list x)
  8464. (list (car x) (cdr x))))
  8465. (if (and (not (get (car x) 'org-state))
  8466. (string-match
  8467. "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|indent-\\)"
  8468. (symbol-name (car x))))
  8469. x nil))
  8470. varlist))))
  8471. (defun org-clone-local-variables (from-buffer &optional regexp)
  8472. "Clone local variables from FROM-BUFFER.
  8473. Optional argument REGEXP selects variables to clone."
  8474. (mapc
  8475. (lambda (pair)
  8476. (and (symbolp (car pair))
  8477. (or (null regexp)
  8478. (string-match regexp (symbol-name (car pair))))
  8479. (set (make-local-variable (car pair))
  8480. (cdr pair))))
  8481. (buffer-local-variables from-buffer)))
  8482. ;;;###autoload
  8483. (defun org-run-like-in-org-mode (cmd)
  8484. "Run a command, pretending that the current buffer is in Org-mode.
  8485. This will temporarily bind local variables that are typically bound in
  8486. Org-mode to the values they have in Org-mode, and then interactively
  8487. call CMD."
  8488. (org-load-modules-maybe)
  8489. (unless org-local-vars
  8490. (setq org-local-vars (org-get-local-variables)))
  8491. (let (binds)
  8492. (dolist (var org-local-vars)
  8493. (when (or (not (boundp (car var)))
  8494. (eq (symbol-value (car var))
  8495. (default-value (car var))))
  8496. (push (list (car var) `(quote ,(cadr var))) binds)))
  8497. (eval `(let ,binds
  8498. (call-interactively (quote ,cmd))))))
  8499. (defun org-get-category (&optional pos force-refresh)
  8500. "Get the category applying to position POS."
  8501. (save-match-data
  8502. (if force-refresh (org-refresh-category-properties))
  8503. (let ((pos (or pos (point))))
  8504. (or (get-text-property pos 'org-category)
  8505. (progn (org-refresh-category-properties)
  8506. (get-text-property pos 'org-category))))))
  8507. ;;; Refresh properties
  8508. (defun org-refresh-properties (dprop tprop)
  8509. "Refresh buffer text properties.
  8510. DPROP is the drawer property and TPROP is either the
  8511. corresponding text property to set, or an alist with each element
  8512. being a text property (as a symbol) and a function to apply to
  8513. the value of the drawer property."
  8514. (let ((case-fold-search t)
  8515. (inhibit-read-only t))
  8516. (org-with-silent-modifications
  8517. (save-excursion
  8518. (save-restriction
  8519. (widen)
  8520. (goto-char (point-min))
  8521. (while (re-search-forward (concat "^[ \t]*:" dprop ": +\\(.*\\)[ \t]*$") nil t)
  8522. (org-refresh-property tprop (org-match-string-no-properties 1))))))))
  8523. (defun org-refresh-property (tprop p)
  8524. "Refresh the buffer text property TPROP from the drawer property P.
  8525. The refresh happens only for the current tree (not subtree)."
  8526. (unless (org-before-first-heading-p)
  8527. (save-excursion
  8528. (org-back-to-heading t)
  8529. (if (symbolp tprop)
  8530. ;; TPROP is a text property symbol
  8531. (put-text-property
  8532. (point) (or (outline-next-heading) (point-max)) tprop p)
  8533. ;; TPROP is an alist with (properties . function) elements
  8534. (dolist (al tprop)
  8535. (save-excursion
  8536. (put-text-property
  8537. (line-beginning-position) (or (outline-next-heading) (point-max))
  8538. (car al)
  8539. (funcall (cdr al) p))))))))
  8540. (defun org-refresh-category-properties ()
  8541. "Refresh category text properties in the buffer."
  8542. (let ((case-fold-search t)
  8543. (inhibit-read-only t)
  8544. (default-category
  8545. (cond ((null org-category)
  8546. (if buffer-file-name
  8547. (file-name-sans-extension
  8548. (file-name-nondirectory buffer-file-name))
  8549. "???"))
  8550. ((symbolp org-category) (symbol-name org-category))
  8551. (t org-category))))
  8552. (org-with-silent-modifications
  8553. (org-with-wide-buffer
  8554. ;; Set buffer-wide category. Search last #+CATEGORY keyword.
  8555. ;; This is the default category for the buffer. If none is
  8556. ;; found, fall-back to `org-category' or buffer file name.
  8557. (put-text-property
  8558. (point-min) (point-max)
  8559. 'org-category
  8560. (catch 'buffer-category
  8561. (goto-char (point-max))
  8562. (while (re-search-backward "^[ \t]*#\\+CATEGORY:" (point-min) t)
  8563. (let ((element (org-element-at-point)))
  8564. (when (eq (org-element-type element) 'keyword)
  8565. (throw 'buffer-category
  8566. (org-element-property :value element)))))
  8567. default-category))
  8568. ;; Set sub-tree specific categories.
  8569. (goto-char (point-min))
  8570. (let ((regexp (org-re-property "CATEGORY")))
  8571. (while (re-search-forward regexp nil t)
  8572. (let ((value (org-match-string-no-properties 3)))
  8573. (when (org-at-property-p)
  8574. (put-text-property
  8575. (save-excursion (org-back-to-heading t) (point))
  8576. (save-excursion (org-end-of-subtree t t) (point))
  8577. 'org-category
  8578. value)))))))))
  8579. (defun org-refresh-stats-properties ()
  8580. "Refresh stats text properties in the buffer."
  8581. (let (stats)
  8582. (org-with-silent-modifications
  8583. (save-excursion
  8584. (save-restriction
  8585. (widen)
  8586. (goto-char (point-min))
  8587. (while (re-search-forward
  8588. (concat org-outline-regexp-bol ".*"
  8589. "\\(?:\\[\\([0-9]+\\)%\\|\\([0-9]+\\)/\\([0-9]+\\)\\]\\)")
  8590. nil t)
  8591. (setq stats (cond ((equal (match-string 3) "0") 0)
  8592. ((match-string 2)
  8593. (/ (* (string-to-number (match-string 2)) 100)
  8594. (string-to-number (match-string 3))))
  8595. (t (string-to-number (match-string 1)))))
  8596. (org-back-to-heading t)
  8597. (put-text-property (point) (progn (org-end-of-subtree t t) (point))
  8598. 'org-stats stats)))))))
  8599. (defun org-refresh-effort-properties ()
  8600. "Refresh effort properties"
  8601. (org-refresh-properties
  8602. org-effort-property
  8603. '((effort . identity)
  8604. (effort-minutes . org-duration-string-to-minutes))))
  8605. ;;;; Link Stuff
  8606. ;;; Link abbreviations
  8607. (defun org-link-expand-abbrev (link)
  8608. "Apply replacements as defined in `org-link-abbrev-alist'."
  8609. (if (string-match "^\\([^:]*\\)\\(::?\\(.*\\)\\)?$" link)
  8610. (let* ((key (match-string 1 link))
  8611. (as (or (assoc key org-link-abbrev-alist-local)
  8612. (assoc key org-link-abbrev-alist)))
  8613. (tag (and (match-end 2) (match-string 3 link)))
  8614. rpl)
  8615. (if (not as)
  8616. link
  8617. (setq rpl (cdr as))
  8618. (cond
  8619. ((symbolp rpl) (funcall rpl tag))
  8620. ((string-match "%(\\([^)]+\\))" rpl)
  8621. (replace-match
  8622. (save-match-data
  8623. (funcall (intern-soft (match-string 1 rpl)) tag)) t t rpl))
  8624. ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
  8625. ((string-match "%h" rpl)
  8626. (replace-match (url-hexify-string (or tag "")) t t rpl))
  8627. (t (concat rpl tag)))))
  8628. link))
  8629. ;;; Storing and inserting links
  8630. (defvar org-insert-link-history nil
  8631. "Minibuffer history for links inserted with `org-insert-link'.")
  8632. (defvar org-stored-links nil
  8633. "Contains the links stored with `org-store-link'.")
  8634. (defvar org-store-link-plist nil
  8635. "Plist with info about the most recently link created with `org-store-link'.")
  8636. (defvar org-link-protocols nil
  8637. "Link protocols added to Org-mode using `org-add-link-type'.")
  8638. (defvar org-store-link-functions nil
  8639. "List of functions that are called to create and store a link.
  8640. Each function will be called in turn until one returns a non-nil
  8641. value. Each function should check if it is responsible for creating
  8642. this link (for example by looking at the major mode).
  8643. If not, it must exit and return nil.
  8644. If yes, it should return a non-nil value after a calling
  8645. `org-store-link-props' with a list of properties and values.
  8646. Special properties are:
  8647. :type The link prefix, like \"http\". This must be given.
  8648. :link The link, like \"http://www.astro.uva.nl/~dominik\".
  8649. This is obligatory as well.
  8650. :description Optional default description for the second pair
  8651. of brackets in an Org-mode link. The user can still change
  8652. this when inserting this link into an Org-mode buffer.
  8653. In addition to these, any additional properties can be specified
  8654. and then used in capture templates.")
  8655. (defun org-add-link-type (type &optional follow export)
  8656. "Add TYPE to the list of `org-link-types'.
  8657. Re-compute all regular expressions depending on `org-link-types'
  8658. FOLLOW and EXPORT are two functions.
  8659. FOLLOW should take the link path as the single argument and do whatever
  8660. is necessary to follow the link, for example find a file or display
  8661. a mail message.
  8662. EXPORT should format the link path for export to one of the export formats.
  8663. It should be a function accepting three arguments:
  8664. path the path of the link, the text after the prefix (like \"http:\")
  8665. desc the description of the link, if any
  8666. format the export format, a symbol like `html' or `latex' or `ascii'.
  8667. The function may use the FORMAT information to return different values
  8668. depending on the format. The return value will be put literally into
  8669. the exported file. If the return value is nil, this means Org should
  8670. do what it normally does with links which do not have EXPORT defined.
  8671. Org mode has a built-in default for exporting links. If you are happy with
  8672. this default, there is no need to define an export function for the link
  8673. type. For a simple example of an export function, see `org-bbdb.el'."
  8674. (add-to-list 'org-link-types type t)
  8675. (org-make-link-regexps)
  8676. (org-element-update-syntax)
  8677. (if (assoc type org-link-protocols)
  8678. (setcdr (assoc type org-link-protocols) (list follow export))
  8679. (push (list type follow export) org-link-protocols)))
  8680. (defvar org-agenda-buffer-name) ; Defined in org-agenda.el
  8681. (defvar org-id-link-to-org-use-id) ; Defined in org-id.el
  8682. ;;;###autoload
  8683. (defun org-store-link (arg)
  8684. "\\<org-mode-map>Store an org-link to the current location.
  8685. This link is added to `org-stored-links' and can later be inserted
  8686. into an Org buffer with \\[org-insert-link].
  8687. For some link types, a prefix ARG is interpreted.
  8688. For links to Usenet articles, ARG negates `org-gnus-prefer-web-links'.
  8689. For file links, ARG negates `org-context-in-file-links'.
  8690. A double prefix ARG force skipping storing functions that are not
  8691. part of Org's core.
  8692. A triple prefix ARG force storing a link for each line in the
  8693. active region."
  8694. (interactive "P")
  8695. (org-load-modules-maybe)
  8696. (if (and (equal arg '(64)) (org-region-active-p))
  8697. (save-excursion
  8698. (let ((end (region-end)))
  8699. (goto-char (region-beginning))
  8700. (set-mark (point))
  8701. (while (< (point-at-eol) end)
  8702. (move-end-of-line 1) (activate-mark)
  8703. (let (current-prefix-arg)
  8704. (call-interactively 'org-store-link))
  8705. (move-beginning-of-line 2)
  8706. (set-mark (point)))))
  8707. (org-with-limited-levels
  8708. (setq org-store-link-plist nil)
  8709. (let (link cpltxt desc description search
  8710. txt custom-id agenda-link sfuns sfunsn)
  8711. (cond
  8712. ;; Store a link using an external link type
  8713. ((and (not (equal arg '(16)))
  8714. (setq sfuns
  8715. (delq
  8716. nil (mapcar (lambda (f)
  8717. (let (fs) (if (funcall f) (push f fs))))
  8718. org-store-link-functions))
  8719. sfunsn (mapcar (lambda (fu) (symbol-name (car fu))) sfuns))
  8720. (or (and (cdr sfuns)
  8721. (funcall (intern
  8722. (completing-read
  8723. "Which function for creating the link? "
  8724. sfunsn nil t (car sfunsn)))))
  8725. (funcall (caar sfuns)))
  8726. (setq link (plist-get org-store-link-plist :link)
  8727. desc (or (plist-get org-store-link-plist
  8728. :description) link))))
  8729. ;; Store a link from a source code buffer.
  8730. ((org-src-edit-buffer-p)
  8731. (cond
  8732. ((save-excursion
  8733. (beginning-of-line)
  8734. (looking-at (concat (format org-coderef-label-format "\\(.*?\\)")
  8735. "[ \t]*$")))
  8736. (setq link (format "(%s)" (org-match-string-no-properties 1))))
  8737. ((org-called-interactively-p 'any)
  8738. (let (label)
  8739. (while (or (not label)
  8740. (org-with-wide-buffer
  8741. (goto-char (point-min))
  8742. (re-search-forward
  8743. (regexp-quote (format org-coderef-label-format label))
  8744. nil t)))
  8745. (when label (message "Label exists already") (sit-for 2))
  8746. (setq label (read-string "Code line label: " label)))
  8747. (end-of-line)
  8748. (setq link (format org-coderef-label-format label))
  8749. (let ((gc (- 79 (length link))))
  8750. (if (< (current-column) gc) (org-move-to-column gc t)
  8751. (insert " ")))
  8752. (insert link)
  8753. (setq link (concat "(" label ")") desc nil)))
  8754. (t (setq link nil))))
  8755. ;; We are in the agenda, link to referenced location
  8756. ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
  8757. (let ((m (or (get-text-property (point) 'org-hd-marker)
  8758. (get-text-property (point) 'org-marker))))
  8759. (when m
  8760. (org-with-point-at m
  8761. (setq agenda-link
  8762. (if (org-called-interactively-p 'any)
  8763. (call-interactively 'org-store-link)
  8764. (org-store-link nil)))))))
  8765. ((eq major-mode 'calendar-mode)
  8766. (let ((cd (calendar-cursor-to-date)))
  8767. (setq link
  8768. (format-time-string
  8769. (car org-time-stamp-formats)
  8770. (apply 'encode-time
  8771. (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
  8772. nil nil nil))))
  8773. (org-store-link-props :type "calendar" :date cd)))
  8774. ((eq major-mode 'help-mode)
  8775. (setq link (concat "help:" (save-excursion
  8776. (goto-char (point-min))
  8777. (looking-at "^[^ ]+")
  8778. (match-string 0))))
  8779. (org-store-link-props :type "help"))
  8780. ((eq major-mode 'w3-mode)
  8781. (setq cpltxt (if (and (buffer-name)
  8782. (not (string-match "Untitled" (buffer-name))))
  8783. (buffer-name)
  8784. (url-view-url t))
  8785. link (url-view-url t))
  8786. (org-store-link-props :type "w3" :url (url-view-url t)))
  8787. ((eq major-mode 'image-mode)
  8788. (setq cpltxt (concat "file:"
  8789. (abbreviate-file-name buffer-file-name))
  8790. link cpltxt)
  8791. (org-store-link-props :type "image" :file buffer-file-name))
  8792. ;; In dired, store a link to the file of the current line
  8793. ((derived-mode-p 'dired-mode)
  8794. (let ((file (dired-get-filename nil t)))
  8795. (setq file (if file
  8796. (abbreviate-file-name
  8797. (expand-file-name (dired-get-filename nil t)))
  8798. ;; otherwise, no file so use current directory.
  8799. default-directory))
  8800. (setq cpltxt (concat "file:" file)
  8801. link cpltxt)))
  8802. ((setq search (run-hook-with-args-until-success
  8803. 'org-create-file-search-functions))
  8804. (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
  8805. "::" search))
  8806. (setq cpltxt (or description link)))
  8807. ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
  8808. (setq custom-id (org-entry-get nil "CUSTOM_ID"))
  8809. (cond
  8810. ;; Store a link using the target at point
  8811. ((org-in-regexp "[^<]<<\\([^<>]+\\)>>[^>]" 1)
  8812. (setq cpltxt
  8813. (concat "file:"
  8814. (abbreviate-file-name
  8815. (buffer-file-name (buffer-base-buffer)))
  8816. "::" (match-string 1))
  8817. link cpltxt))
  8818. ((and (featurep 'org-id)
  8819. (or (eq org-id-link-to-org-use-id t)
  8820. (and (org-called-interactively-p 'any)
  8821. (or (eq org-id-link-to-org-use-id 'create-if-interactive)
  8822. (and (eq org-id-link-to-org-use-id
  8823. 'create-if-interactive-and-no-custom-id)
  8824. (not custom-id))))
  8825. (and org-id-link-to-org-use-id (org-entry-get nil "ID"))))
  8826. ;; Store a link using the ID at point
  8827. (setq link (condition-case nil
  8828. (prog1 (org-id-store-link)
  8829. (setq desc (or (plist-get org-store-link-plist
  8830. :description)
  8831. "")))
  8832. (error
  8833. ;; Probably before first headline, link only to file
  8834. (concat "file:"
  8835. (abbreviate-file-name
  8836. (buffer-file-name (buffer-base-buffer))))))))
  8837. (t
  8838. ;; Just link to current headline
  8839. (setq cpltxt (concat "file:"
  8840. (abbreviate-file-name
  8841. (buffer-file-name (buffer-base-buffer)))))
  8842. ;; Add a context search string
  8843. (when (org-xor org-context-in-file-links arg)
  8844. (let* ((ee (org-element-at-point))
  8845. (et (org-element-type ee))
  8846. (ev (plist-get (cadr ee) :value))
  8847. (ek (plist-get (cadr ee) :key))
  8848. (eok (and (stringp ek) (string-match "name" ek))))
  8849. (setq txt (cond
  8850. ((org-at-heading-p) nil)
  8851. ((and (eq et 'keyword) eok) ev)
  8852. ((org-region-active-p)
  8853. (buffer-substring (region-beginning) (region-end)))))
  8854. (when (or (null txt) (string-match "\\S-" txt))
  8855. (setq cpltxt
  8856. (concat cpltxt "::"
  8857. (condition-case nil
  8858. (org-make-org-heading-search-string txt)
  8859. (error "")))
  8860. desc (or (and (eq et 'keyword) eok ev)
  8861. (nth 4 (ignore-errors (org-heading-components)))
  8862. "NONE")))))
  8863. (if (string-match "::\\'" cpltxt)
  8864. (setq cpltxt (substring cpltxt 0 -2)))
  8865. (setq link cpltxt))))
  8866. ((buffer-file-name (buffer-base-buffer))
  8867. ;; Just link to this file here.
  8868. (setq cpltxt (concat "file:"
  8869. (abbreviate-file-name
  8870. (buffer-file-name (buffer-base-buffer)))))
  8871. ;; Add a context string.
  8872. (when (org-xor org-context-in-file-links arg)
  8873. (setq txt (if (org-region-active-p)
  8874. (buffer-substring (region-beginning) (region-end))
  8875. (buffer-substring (point-at-bol) (point-at-eol))))
  8876. ;; Only use search option if there is some text.
  8877. (when (string-match "\\S-" txt)
  8878. (setq cpltxt
  8879. (concat cpltxt "::" (org-make-org-heading-search-string txt))
  8880. desc "NONE")))
  8881. (setq link cpltxt))
  8882. ((org-called-interactively-p 'interactive)
  8883. (user-error "No method for storing a link from this buffer"))
  8884. (t (setq link nil)))
  8885. ;; We're done setting link and desc, clean up
  8886. (if (consp link) (setq cpltxt (car link) link (cdr link)))
  8887. (setq link (or link cpltxt)
  8888. desc (or desc cpltxt))
  8889. (cond ((equal desc "NONE") (setq desc nil))
  8890. ((and desc (string-match org-bracket-link-analytic-regexp desc))
  8891. (let ((d0 (match-string 3 desc))
  8892. (p0 (match-string 5 desc)))
  8893. (setq desc
  8894. (replace-regexp-in-string
  8895. org-bracket-link-regexp
  8896. (concat (or p0 d0)
  8897. (if (equal (length (match-string 0 desc))
  8898. (length desc)) "*" "")) desc)))))
  8899. ;; Return the link
  8900. (if (not (and (or (org-called-interactively-p 'any)
  8901. executing-kbd-macro) link))
  8902. (or agenda-link (and link (org-make-link-string link desc)))
  8903. (push (list link desc) org-stored-links)
  8904. (message "Stored: %s" (or desc link))
  8905. (when custom-id
  8906. (setq link (concat "file:" (abbreviate-file-name
  8907. (buffer-file-name)) "::#" custom-id))
  8908. (push (list link desc) org-stored-links))
  8909. (car org-stored-links))))))
  8910. (defun org-store-link-props (&rest plist)
  8911. "Store link properties, extract names and addresses."
  8912. (let (x adr)
  8913. (when (setq x (plist-get plist :from))
  8914. (setq adr (mail-extract-address-components x))
  8915. (setq plist (plist-put plist :fromname (car adr)))
  8916. (setq plist (plist-put plist :fromaddress (nth 1 adr))))
  8917. (when (setq x (plist-get plist :to))
  8918. (setq adr (mail-extract-address-components x))
  8919. (setq plist (plist-put plist :toname (car adr)))
  8920. (setq plist (plist-put plist :toaddress (nth 1 adr)))))
  8921. (let ((from (plist-get plist :from))
  8922. (to (plist-get plist :to)))
  8923. (when (and from to org-from-is-user-regexp)
  8924. (setq plist
  8925. (plist-put plist :fromto
  8926. (if (string-match org-from-is-user-regexp from)
  8927. (concat "to %t")
  8928. (concat "from %f"))))))
  8929. (setq org-store-link-plist plist))
  8930. (defun org-add-link-props (&rest plist)
  8931. "Add these properties to the link property list."
  8932. (let (key value)
  8933. (while plist
  8934. (setq key (pop plist) value (pop plist))
  8935. (setq org-store-link-plist
  8936. (plist-put org-store-link-plist key value)))))
  8937. (defun org-email-link-description (&optional fmt)
  8938. "Return the description part of an email link.
  8939. This takes information from `org-store-link-plist' and formats it
  8940. according to FMT (default from `org-email-link-description-format')."
  8941. (setq fmt (or fmt org-email-link-description-format))
  8942. (let* ((p org-store-link-plist)
  8943. (to (plist-get p :toaddress))
  8944. (from (plist-get p :fromaddress))
  8945. (table
  8946. (list
  8947. (cons "%c" (plist-get p :fromto))
  8948. (cons "%F" (plist-get p :from))
  8949. (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
  8950. (cons "%T" (plist-get p :to))
  8951. (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
  8952. (cons "%s" (plist-get p :subject))
  8953. (cons "%d" (plist-get p :date))
  8954. (cons "%m" (plist-get p :message-id)))))
  8955. (when (string-match "%c" fmt)
  8956. ;; Check if the user wrote this message
  8957. (if (and org-from-is-user-regexp from to
  8958. (save-match-data (string-match org-from-is-user-regexp from)))
  8959. (setq fmt (replace-match "to %t" t t fmt))
  8960. (setq fmt (replace-match "from %f" t t fmt))))
  8961. (org-replace-escapes fmt table)))
  8962. (defun org-make-org-heading-search-string (&optional string)
  8963. "Make search string for the current headline or STRING."
  8964. (let ((s (or string
  8965. (and (derived-mode-p 'org-mode)
  8966. (save-excursion
  8967. (org-back-to-heading t)
  8968. (org-element-property :raw-value (org-element-at-point))))))
  8969. (lines org-context-in-file-links))
  8970. (or string (setq s (concat "*" s))) ; Add * for headlines
  8971. (setq s (replace-regexp-in-string "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" "" s))
  8972. (when (and string (integerp lines) (> lines 0))
  8973. (let ((slines (org-split-string s "\n")))
  8974. (when (< lines (length slines))
  8975. (setq s (mapconcat
  8976. 'identity
  8977. (reverse (nthcdr (- (length slines) lines)
  8978. (reverse slines))) "\n")))))
  8979. (mapconcat 'identity (org-split-string s "[ \t]+") " ")))
  8980. (defun org-make-link-string (link &optional description)
  8981. "Make a link with brackets, consisting of LINK and DESCRIPTION."
  8982. (unless (org-string-nw-p link) (error "Empty link"))
  8983. (let ((uri (cond ((string-match org-link-types-re link)
  8984. (concat (match-string 1 link)
  8985. (org-link-escape (substring link (match-end 1)))))
  8986. ;; For readability, url-encode internal links only
  8987. ;; when absolutely needed (i.e, when they contain
  8988. ;; square brackets). File links however, are
  8989. ;; encoded since, e.g., spaces are significant.
  8990. ((or (file-name-absolute-p link)
  8991. (org-string-match-p "\\`\\.\\.?/\\|[][]" link))
  8992. (org-link-escape link))
  8993. (t link)))
  8994. (description
  8995. (and (org-string-nw-p description)
  8996. ;; Remove brackets from description, as they are fatal.
  8997. (replace-regexp-in-string
  8998. "[][]" (lambda (m) (if (equal "[" m) "{" "}"))
  8999. (org-trim description)))))
  9000. (format "[[%s]%s]"
  9001. uri
  9002. (if description (format "[%s]" description) ""))))
  9003. (defconst org-link-escape-chars
  9004. ;;%20 %5B %5D %25
  9005. '(?\s ?\[ ?\] ?%)
  9006. "List of characters that should be escaped in a link when stored to Org.
  9007. This is the list that is used for internal purposes.")
  9008. (defconst org-link-escape-chars-browser
  9009. ;;%20 %22
  9010. '(?\s ?\")
  9011. "List of characters to be escaped before handing over to the browser.
  9012. If you consider using this constant then you probably want to use
  9013. the function `org-link-escape-browser' instead. See there why
  9014. this constant is a candidate to be removed once Org drops support
  9015. for Emacs 24.1 and 24.2.")
  9016. (defun org-link-escape (text &optional table merge)
  9017. "Return percent escaped representation of TEXT.
  9018. TEXT is a string with the text to escape.
  9019. Optional argument TABLE is a list with characters that should be
  9020. escaped. When nil, `org-link-escape-chars' is used.
  9021. If optional argument MERGE is set, merge TABLE into
  9022. `org-link-escape-chars'."
  9023. (let ((characters-to-encode
  9024. (cond ((null table) org-link-escape-chars)
  9025. (merge (append org-link-escape-chars table))
  9026. (t table))))
  9027. (mapconcat
  9028. (lambda (c)
  9029. (if (or (memq c characters-to-encode)
  9030. (and org-url-hexify-p (or (< c 32) (> c 126))))
  9031. (mapconcat (lambda (e) (format "%%%.2X" e))
  9032. (or (encode-coding-char c 'utf-8)
  9033. (error "Unable to percent escape character: %c" c))
  9034. "")
  9035. (char-to-string c)))
  9036. text "")))
  9037. (defun org-link-escape-browser (text)
  9038. "Escape some characters before handing over to the browser.
  9039. This function is a candidate to be removed together with the
  9040. constant `org-link-escape-chars-browser' once Org drops support
  9041. for Emacs 24.1 and 24.2. All calls to this function will have to
  9042. be replaced with `url-encode-url' which is available since Emacs
  9043. 24.3.1."
  9044. ;; Example with the Org link
  9045. ;; [[http://lists.gnu.org/archive/cgi-bin/namazu.cgi?idxname=emacs-orgmode&query=%252Bsubject:"Release+8.2"]]
  9046. ;; to open the browser with +subject:"Release 8.2" filled into the
  9047. ;; query field: In this case the variable TEXT contains the
  9048. ;; unescaped [...]=%2Bsubject:"Release+8.2". Then `url-encode-url'
  9049. ;; converts correctly to [...]=%2Bsubject:%22Release+8.2%22 or
  9050. ;; `org-link-escape' with `org-link-escape-chars-browser' converts
  9051. ;; wrongly to [...]=%252Bsubject:%22Release+8.2%22.
  9052. (if (fboundp 'url-encode-url)
  9053. (url-encode-url text)
  9054. (if (org-string-match-p
  9055. (concat "[[:nonascii:]" org-link-escape-chars-browser "]")
  9056. text)
  9057. (org-link-escape text org-link-escape-chars-browser)
  9058. text)))
  9059. (defun org-link-unescape (str)
  9060. "Unhex hexified Unicode parts in string STR.
  9061. E.g. `%C3%B6' becomes the german o-Umlaut. This is the
  9062. reciprocal of `org-link-escape', which see."
  9063. (if (org-string-nw-p str)
  9064. (replace-regexp-in-string
  9065. "\\(%[0-9A-Za-z]\\{2\\}\\)+" #'org-link-unescape-compound str t t)
  9066. str))
  9067. (defun org-link-unescape-compound (hex)
  9068. "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German o-Umlaut.
  9069. Note: this function also decodes single byte encodings like
  9070. `%E1' (a-acute) if not followed by another `%[A-F0-9]{2}' group."
  9071. (save-match-data
  9072. (let* ((bytes (cdr (split-string hex "%")))
  9073. (ret "")
  9074. (eat 0)
  9075. (sum 0))
  9076. (while bytes
  9077. (let* ((val (string-to-number (pop bytes) 16))
  9078. (shift-xor
  9079. (if (= 0 eat)
  9080. (cond
  9081. ((>= val 252) (cons 6 252))
  9082. ((>= val 248) (cons 5 248))
  9083. ((>= val 240) (cons 4 240))
  9084. ((>= val 224) (cons 3 224))
  9085. ((>= val 192) (cons 2 192))
  9086. (t (cons 0 0)))
  9087. (cons 6 128))))
  9088. (if (>= val 192) (setq eat (car shift-xor)))
  9089. (setq val (logxor val (cdr shift-xor)))
  9090. (setq sum (+ (lsh sum (car shift-xor)) val))
  9091. (if (> eat 0) (setq eat (- eat 1)))
  9092. (cond
  9093. ((= 0 eat) ;multi byte
  9094. (setq ret (concat ret (org-char-to-string sum)))
  9095. (setq sum 0))
  9096. ((not bytes) ; single byte(s)
  9097. (setq ret (org-link-unescape-single-byte-sequence hex))))))
  9098. ret)))
  9099. (defun org-link-unescape-single-byte-sequence (hex)
  9100. "Unhexify hex-encoded single byte character sequences."
  9101. (mapconcat (lambda (byte)
  9102. (char-to-string (string-to-number byte 16)))
  9103. (cdr (split-string hex "%")) ""))
  9104. (defun org-xor (a b)
  9105. "Exclusive or."
  9106. (if a (not b) b))
  9107. (defun org-fixup-message-id-for-http (s)
  9108. "Replace special characters in a message id, so it can be used in an http query."
  9109. (when (string-match "%" s)
  9110. (setq s (mapconcat (lambda (c)
  9111. (if (eq c ?%)
  9112. "%25"
  9113. (char-to-string c)))
  9114. s "")))
  9115. (while (string-match "<" s)
  9116. (setq s (replace-match "%3C" t t s)))
  9117. (while (string-match ">" s)
  9118. (setq s (replace-match "%3E" t t s)))
  9119. (while (string-match "@" s)
  9120. (setq s (replace-match "%40" t t s)))
  9121. s)
  9122. (defun org-link-prettify (link)
  9123. "Return a human-readable representation of LINK.
  9124. The car of LINK must be a raw link.
  9125. The cdr of LINK must be either a link description or nil."
  9126. (let ((desc (or (cadr link) "<no description>")))
  9127. (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
  9128. "<" (car link) ">")))
  9129. ;;;###autoload
  9130. (defun org-insert-link-global ()
  9131. "Insert a link like Org-mode does.
  9132. This command can be called in any mode to insert a link in Org-mode syntax."
  9133. (interactive)
  9134. (org-load-modules-maybe)
  9135. (org-run-like-in-org-mode 'org-insert-link))
  9136. (defun org-insert-all-links (arg &optional pre post)
  9137. "Insert all links in `org-stored-links'.
  9138. When a universal prefix, do not delete the links from `org-stored-links'.
  9139. When `ARG' is a number, insert the last N link(s).
  9140. `PRE' and `POST' are optional arguments to define a string to
  9141. prepend or to append."
  9142. (interactive "P")
  9143. (let ((org-keep-stored-link-after-insertion (equal arg '(4)))
  9144. (links (copy-seq org-stored-links))
  9145. (pr (or pre "- "))
  9146. (po (or post "\n"))
  9147. (cnt 1) l)
  9148. (if (null org-stored-links)
  9149. (message "No link to insert")
  9150. (while (and (or (listp arg) (>= arg cnt))
  9151. (setq l (if (listp arg)
  9152. (pop links)
  9153. (pop org-stored-links))))
  9154. (setq cnt (1+ cnt))
  9155. (insert pr)
  9156. (org-insert-link nil (car l) (or (cadr l) "<no description>"))
  9157. (insert po)))))
  9158. (defun org-insert-last-stored-link (arg)
  9159. "Insert the last link stored in `org-stored-links'."
  9160. (interactive "p")
  9161. (org-insert-all-links arg "" "\n"))
  9162. (defun org-link-fontify-links-to-this-file ()
  9163. "Fontify links to the current file in `org-stored-links'."
  9164. (let ((f (buffer-file-name)) a b)
  9165. (setq a (mapcar (lambda(l)
  9166. (let ((ll (car l)))
  9167. (when (and (string-match "^file:\\(.+\\)::" ll)
  9168. (equal f (expand-file-name (match-string 1 ll))))
  9169. ll)))
  9170. org-stored-links))
  9171. (when (featurep 'org-id)
  9172. (setq b (mapcar (lambda(l)
  9173. (let ((ll (car l)))
  9174. (when (and (string-match "^id:\\(.+\\)$" ll)
  9175. (equal f (expand-file-name
  9176. (or (org-id-find-id-file
  9177. (match-string 1 ll)) ""))))
  9178. ll)))
  9179. org-stored-links)))
  9180. (mapcar (lambda(l)
  9181. (put-text-property 0 (length l) 'face 'font-lock-comment-face l))
  9182. (delq nil (append a b)))))
  9183. (defvar org-link-links-in-this-file nil)
  9184. (defun org-insert-link (&optional complete-file link-location default-description)
  9185. "Insert a link. At the prompt, enter the link.
  9186. Completion can be used to insert any of the link protocol prefixes like
  9187. http or ftp in use.
  9188. The history can be used to select a link previously stored with
  9189. `org-store-link'. When the empty string is entered (i.e. if you just
  9190. press RET at the prompt), the link defaults to the most recently
  9191. stored link. As SPC triggers completion in the minibuffer, you need to
  9192. use M-SPC or C-q SPC to force the insertion of a space character.
  9193. You will also be prompted for a description, and if one is given, it will
  9194. be displayed in the buffer instead of the link.
  9195. If there is already a link at point, this command will allow you to edit link
  9196. and description parts.
  9197. With a \\[universal-argument] prefix, prompts for a file to link to. The file name can
  9198. be selected using completion. The path to the file will be relative to the
  9199. current directory if the file is in the current directory or a subdirectory.
  9200. Otherwise, the link will be the absolute path as completed in the minibuffer
  9201. \(i.e. normally ~/path/to/file). You can configure this behavior using the
  9202. option `org-link-file-path-type'.
  9203. With two \\[universal-argument] prefixes, enforce an absolute path even if the file is in
  9204. the current directory or below.
  9205. With three \\[universal-argument] prefixes, negate the meaning of
  9206. `org-keep-stored-link-after-insertion'.
  9207. If `org-make-link-description-function' is non-nil, this function will be
  9208. called with the link target, and the result will be the default
  9209. link description.
  9210. If the LINK-LOCATION parameter is non-nil, this value will be
  9211. used as the link location instead of reading one interactively.
  9212. If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
  9213. be used as the default description."
  9214. (interactive "P")
  9215. (let* ((wcf (current-window-configuration))
  9216. (origbuf (current-buffer))
  9217. (region (if (org-region-active-p)
  9218. (buffer-substring (region-beginning) (region-end))))
  9219. (remove (and region (list (region-beginning) (region-end))))
  9220. (desc region)
  9221. tmphist ; byte-compile incorrectly complains about this
  9222. (link link-location)
  9223. (abbrevs org-link-abbrev-alist-local)
  9224. entry file all-prefixes auto-desc)
  9225. (cond
  9226. (link-location) ; specified by arg, just use it.
  9227. ((org-in-regexp org-bracket-link-regexp 1)
  9228. ;; We do have a link at point, and we are going to edit it.
  9229. (setq remove (list (match-beginning 0) (match-end 0)))
  9230. (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
  9231. (setq link (read-string "Link: "
  9232. (org-link-unescape
  9233. (org-match-string-no-properties 1)))))
  9234. ((or (org-in-regexp org-angle-link-re)
  9235. (org-in-regexp org-plain-link-re))
  9236. ;; Convert to bracket link
  9237. (setq remove (list (match-beginning 0) (match-end 0))
  9238. link (read-string "Link: "
  9239. (org-remove-angle-brackets (match-string 0)))))
  9240. ((member complete-file '((4) (16)))
  9241. ;; Completing read for file names.
  9242. (setq link (org-file-complete-link complete-file)))
  9243. (t
  9244. ;; Read link, with completion for stored links.
  9245. (org-link-fontify-links-to-this-file)
  9246. (org-switch-to-buffer-other-window "*Org Links*")
  9247. (with-current-buffer "*Org Links*"
  9248. (erase-buffer)
  9249. (insert "Insert a link.
  9250. Use TAB to complete link prefixes, then RET for type-specific completion support\n")
  9251. (when org-stored-links
  9252. (insert "\nStored links are available with <up>/<down> or M-p/n (most recent with RET):\n\n")
  9253. (insert (mapconcat 'org-link-prettify
  9254. (reverse org-stored-links) "\n")))
  9255. (goto-char (point-min)))
  9256. (let ((cw (selected-window)))
  9257. (select-window (get-buffer-window "*Org Links*" 'visible))
  9258. (with-current-buffer "*Org Links*" (setq truncate-lines t))
  9259. (unless (pos-visible-in-window-p (point-max))
  9260. (org-fit-window-to-buffer))
  9261. (and (window-live-p cw) (select-window cw)))
  9262. ;; Fake a link history, containing the stored links.
  9263. (setq tmphist (append (mapcar 'car org-stored-links)
  9264. org-insert-link-history))
  9265. (setq all-prefixes (append (mapcar 'car abbrevs)
  9266. (mapcar 'car org-link-abbrev-alist)
  9267. org-link-types))
  9268. (unwind-protect
  9269. (progn
  9270. (setq link
  9271. (org-completing-read
  9272. "Link: "
  9273. (append
  9274. (mapcar (lambda (x) (concat x ":"))
  9275. all-prefixes)
  9276. (mapcar 'car org-stored-links))
  9277. nil nil nil
  9278. 'tmphist
  9279. (caar org-stored-links)))
  9280. (if (not (string-match "\\S-" link))
  9281. (user-error "No link selected"))
  9282. (mapc (lambda(l)
  9283. (when (equal link (cadr l)) (setq link (car l) auto-desc t)))
  9284. org-stored-links)
  9285. (if (or (member link all-prefixes)
  9286. (and (equal ":" (substring link -1))
  9287. (member (substring link 0 -1) all-prefixes)
  9288. (setq link (substring link 0 -1))))
  9289. (setq link (with-current-buffer origbuf
  9290. (org-link-try-special-completion link)))))
  9291. (set-window-configuration wcf)
  9292. (kill-buffer "*Org Links*"))
  9293. (setq entry (assoc link org-stored-links))
  9294. (or entry (push link org-insert-link-history))
  9295. (setq desc (or desc (nth 1 entry)))))
  9296. (if (funcall (if (equal complete-file '(64)) 'not 'identity)
  9297. (not org-keep-stored-link-after-insertion))
  9298. (setq org-stored-links (delq (assoc link org-stored-links)
  9299. org-stored-links)))
  9300. (if (and (string-match org-plain-link-re link)
  9301. (not (string-match org-ts-regexp link)))
  9302. ;; URL-like link, normalize the use of angular brackets.
  9303. (setq link (org-remove-angle-brackets link)))
  9304. ;; Check if we are linking to the current file with a search
  9305. ;; option If yes, simplify the link by using only the search
  9306. ;; option.
  9307. (when (and buffer-file-name
  9308. (string-match "^file:\\(.+?\\)::\\(.+\\)" link))
  9309. (let* ((path (match-string 1 link))
  9310. (case-fold-search nil)
  9311. (search (match-string 2 link)))
  9312. (save-match-data
  9313. (if (equal (file-truename buffer-file-name) (file-truename path))
  9314. ;; We are linking to this same file, with a search option
  9315. (setq link search)))))
  9316. ;; Check if we can/should use a relative path. If yes, simplify the link
  9317. (when (string-match "^\\(file:\\|docview:\\)\\(.*\\)" link)
  9318. (let* ((type (match-string 1 link))
  9319. (path (match-string 2 link))
  9320. (origpath path)
  9321. (case-fold-search nil))
  9322. (cond
  9323. ((or (eq org-link-file-path-type 'absolute)
  9324. (equal complete-file '(16)))
  9325. (setq path (abbreviate-file-name (expand-file-name path))))
  9326. ((eq org-link-file-path-type 'noabbrev)
  9327. (setq path (expand-file-name path)))
  9328. ((eq org-link-file-path-type 'relative)
  9329. (setq path (file-relative-name path)))
  9330. (t
  9331. (save-match-data
  9332. (if (string-match (concat "^" (regexp-quote
  9333. (expand-file-name
  9334. (file-name-as-directory
  9335. default-directory))))
  9336. (expand-file-name path))
  9337. ;; We are linking a file with relative path name.
  9338. (setq path (substring (expand-file-name path)
  9339. (match-end 0)))
  9340. (setq path (abbreviate-file-name (expand-file-name path)))))))
  9341. (setq link (concat type path))
  9342. (if (equal desc origpath)
  9343. (setq desc path))))
  9344. (if org-make-link-description-function
  9345. (setq desc
  9346. (or (condition-case nil
  9347. (funcall org-make-link-description-function link desc)
  9348. (error (progn (message "Can't get link description from `%s'"
  9349. (symbol-name org-make-link-description-function))
  9350. (sit-for 2) nil)))
  9351. (read-string "Description: " default-description)))
  9352. (if default-description (setq desc default-description)
  9353. (setq desc (or (and auto-desc desc)
  9354. (read-string "Description: " desc)))))
  9355. (unless (string-match "\\S-" desc) (setq desc nil))
  9356. (if remove (apply 'delete-region remove))
  9357. (insert (org-make-link-string link desc))))
  9358. (defun org-link-try-special-completion (type)
  9359. "If there is completion support for link type TYPE, offer it."
  9360. (let ((fun (intern (concat "org-" type "-complete-link"))))
  9361. (if (functionp fun)
  9362. (funcall fun)
  9363. (read-string "Link (no completion support): " (concat type ":")))))
  9364. (defun org-file-complete-link (&optional arg)
  9365. "Create a file link using completion."
  9366. (let ((file (org-iread-file-name "File: "))
  9367. (pwd (file-name-as-directory (expand-file-name ".")))
  9368. (pwd1 (file-name-as-directory (abbreviate-file-name
  9369. (expand-file-name ".")))))
  9370. (cond ((equal arg '(16))
  9371. (concat "file:"
  9372. (abbreviate-file-name (expand-file-name file))))
  9373. ((string-match
  9374. (concat "^" (regexp-quote pwd1) "\\(.+\\)") file)
  9375. (concat "file:" (match-string 1 file)))
  9376. ((string-match
  9377. (concat "^" (regexp-quote pwd) "\\(.+\\)")
  9378. (expand-file-name file))
  9379. (concat "file:"
  9380. (match-string 1 (expand-file-name file))))
  9381. (t (concat "file:" file)))))
  9382. (defun org-iread-file-name (&rest args)
  9383. "Read-file-name using `ido-mode' speedup if available.
  9384. ARGS are arguments that may be passed to `ido-read-file-name' or `read-file-name'.
  9385. See `read-file-name' for a description of parameters."
  9386. (org-without-partial-completion
  9387. (if (and org-completion-use-ido
  9388. (fboundp 'ido-read-file-name)
  9389. (org-bound-and-true-p ido-mode)
  9390. (listp (nth 1 args)))
  9391. (let ((ido-enter-matching-directory nil))
  9392. (apply #'ido-read-file-name args))
  9393. (apply #'read-file-name args))))
  9394. (defun org-completing-read (&rest args)
  9395. "Completing-read with SPACE being a normal character."
  9396. (let ((enable-recursive-minibuffers t)
  9397. (minibuffer-local-completion-map
  9398. (copy-keymap minibuffer-local-completion-map)))
  9399. (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
  9400. (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
  9401. (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
  9402. (apply 'org-icompleting-read args)))
  9403. (defun org-completing-read-no-i (&rest args)
  9404. (let (org-completion-use-ido org-completion-use-iswitchb)
  9405. (apply 'org-completing-read args)))
  9406. (defun org-iswitchb-completing-read (prompt choices &rest args)
  9407. "Use iswitch as a completing-read replacement to choose from choices.
  9408. PROMPT is a string to prompt with. CHOICES is a list of strings to choose
  9409. from."
  9410. (let* ((iswitchb-use-virtual-buffers nil)
  9411. (iswitchb-make-buflist-hook
  9412. (lambda ()
  9413. (setq iswitchb-temp-buflist choices))))
  9414. (iswitchb-read-buffer prompt)))
  9415. (defun org-icompleting-read (&rest args)
  9416. "Completing-read using `ido-mode' or `iswitchb' speedups if available.
  9417. Should be called like `completing-read'."
  9418. (org-without-partial-completion
  9419. (if (not (listp (nth 1 args)))
  9420. ;; Ido only supports lists as the COLLECTION argument. Use
  9421. ;; default completion function when second argument is not
  9422. ;; a list.
  9423. (apply #'completing-read args)
  9424. (let ((ido-enter-matching-directory nil))
  9425. (apply (cond ((and org-completion-use-ido
  9426. (fboundp 'ido-completing-read)
  9427. (org-bound-and-true-p ido-mode))
  9428. #'ido-completing-read)
  9429. ((and org-completion-use-iswitchb
  9430. (org-bound-and-true-p iswitchb-mode))
  9431. #'org-iswitchb-completing-read)
  9432. (t #'completing-read))
  9433. args)))))
  9434. ;;; Opening/following a link
  9435. (defvar org-link-search-failed nil)
  9436. (defvar org-open-link-functions nil
  9437. "Hook for functions finding a plain text link.
  9438. These functions must take a single argument, the link content.
  9439. They will be called for links that look like [[link text][description]]
  9440. when LINK TEXT does not have a protocol like \"http:\" and does not look
  9441. like a filename (e.g. \"./blue.png\").
  9442. These functions will be called *before* Org attempts to resolve the
  9443. link by doing text searches in the current buffer - so if you want a
  9444. link \"[[target]]\" to still find \"<<target>>\", your function should
  9445. handle this as a special case.
  9446. When the function does handle the link, it must return a non-nil value.
  9447. If it decides that it is not responsible for this link, it must return
  9448. nil to indicate that that Org-mode can continue with other options
  9449. like exact and fuzzy text search.")
  9450. (defun org-next-link (&optional search-backward)
  9451. "Move forward to the next link.
  9452. If the link is in hidden text, expose it."
  9453. (interactive "P")
  9454. (when (and org-link-search-failed (eq this-command last-command))
  9455. (goto-char (point-min))
  9456. (message "Link search wrapped back to beginning of buffer"))
  9457. (setq org-link-search-failed nil)
  9458. (let* ((pos (point))
  9459. (ct (org-context))
  9460. (a (assoc :link ct))
  9461. (srch-fun (if search-backward 're-search-backward 're-search-forward)))
  9462. (cond (a (goto-char (nth (if search-backward 1 2) a)))
  9463. ((looking-at org-any-link-re)
  9464. ;; Don't stay stuck at link without an org-link face
  9465. (forward-char (if search-backward -1 1))))
  9466. (if (funcall srch-fun org-any-link-re nil t)
  9467. (progn
  9468. (goto-char (match-beginning 0))
  9469. (if (outline-invisible-p) (org-show-context)))
  9470. (goto-char pos)
  9471. (setq org-link-search-failed t)
  9472. (message "No further link found"))))
  9473. (defun org-previous-link ()
  9474. "Move backward to the previous link.
  9475. If the link is in hidden text, expose it."
  9476. (interactive)
  9477. (funcall 'org-next-link t))
  9478. (defun org-translate-link (s)
  9479. "Translate a link string if a translation function has been defined."
  9480. (if (and org-link-translation-function
  9481. (fboundp org-link-translation-function)
  9482. (string-match "\\([a-zA-Z0-9]+\\):\\(.*\\)" s))
  9483. (progn
  9484. (setq s (funcall org-link-translation-function
  9485. (match-string 1 s) (match-string 2 s)))
  9486. (concat (car s) ":" (cdr s)))
  9487. s))
  9488. (defun org-translate-link-from-planner (type path)
  9489. "Translate a link from Emacs Planner syntax so that Org can follow it.
  9490. This is still an experimental function, your mileage may vary."
  9491. (cond
  9492. ((member type '("http" "https" "news" "ftp"))
  9493. ;; standard Internet links are the same.
  9494. nil)
  9495. ((and (equal type "irc") (string-match "^//" path))
  9496. ;; Planner has two / at the beginning of an irc link, we have 1.
  9497. ;; We should have zero, actually....
  9498. (setq path (substring path 1)))
  9499. ((and (equal type "lisp") (string-match "^/" path))
  9500. ;; Planner has a slash, we do not.
  9501. (setq type "elisp" path (substring path 1)))
  9502. ((string-match "^//\\(.?*\\)/\\(<.*>\\)$" path)
  9503. ;; A typical message link. Planner has the id after the final slash,
  9504. ;; we separate it with a hash mark
  9505. (setq path (concat (match-string 1 path) "#"
  9506. (org-remove-angle-brackets (match-string 2 path))))))
  9507. (cons type path))
  9508. (defun org-find-file-at-mouse (ev)
  9509. "Open file link or URL at mouse."
  9510. (interactive "e")
  9511. (mouse-set-point ev)
  9512. (org-open-at-point 'in-emacs))
  9513. (defun org-open-at-mouse (ev)
  9514. "Open file link or URL at mouse.
  9515. See the docstring of `org-open-file' for details."
  9516. (interactive "e")
  9517. (mouse-set-point ev)
  9518. (if (eq major-mode 'org-agenda-mode)
  9519. (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
  9520. (org-open-at-point))
  9521. (defvar org-window-config-before-follow-link nil
  9522. "The window configuration before following a link.
  9523. This is saved in case the need arises to restore it.")
  9524. (defvar org-open-link-marker (make-marker)
  9525. "Marker pointing to the location where `org-open-at-point' was called.")
  9526. ;;;###autoload
  9527. (defun org-open-at-point-global ()
  9528. "Follow a link like Org-mode does.
  9529. This command can be called in any mode to follow a link that has
  9530. Org-mode syntax."
  9531. (interactive)
  9532. (org-run-like-in-org-mode 'org-open-at-point))
  9533. ;;;###autoload
  9534. (defun org-open-link-from-string (s &optional arg reference-buffer)
  9535. "Open a link in the string S, as if it was in Org-mode."
  9536. (interactive "sLink: \nP")
  9537. (let ((reference-buffer (or reference-buffer (current-buffer))))
  9538. (with-temp-buffer
  9539. (let ((org-inhibit-startup (not reference-buffer)))
  9540. (org-mode)
  9541. (insert s)
  9542. (goto-char (point-min))
  9543. (when reference-buffer
  9544. (setq org-link-abbrev-alist-local
  9545. (with-current-buffer reference-buffer
  9546. org-link-abbrev-alist-local)))
  9547. (org-open-at-point arg reference-buffer)))))
  9548. (defvar org-open-at-point-functions nil
  9549. "Hook that is run when following a link at point.
  9550. Functions in this hook must return t if they identify and follow
  9551. a link at point. If they don't find anything interesting at point,
  9552. they must return nil.")
  9553. (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
  9554. (defvar clean-buffer-list-kill-buffer-names) ; Defined in midnight.el
  9555. (defun org-open-at-point (&optional arg reference-buffer)
  9556. "Open link, timestamp, footnote or tags at point.
  9557. When point is on a link, follow it. Normally, files will be
  9558. opened by an appropriate application. If the optional prefix
  9559. argument ARG is non-nil, Emacs will visit the file. With
  9560. a double prefix argument, try to open outside of Emacs, in the
  9561. application the system uses for this file type.
  9562. When point is on a timestamp, open the agenda at the day
  9563. specified.
  9564. When point is a footnote definition, move to the first reference
  9565. found. If it is on a reference, move to the associated
  9566. definition.
  9567. When point is on a headline, display a list of every link in the
  9568. entry, so it is possible to pick one, or all, of them. If point
  9569. is on a tag, call `org-tags-view' instead.
  9570. When optional argument REFERENCE-BUFFER is non-nil, it should
  9571. specify a buffer from where the link search should happen. This
  9572. is used internally by `org-open-link-from-string'.
  9573. On top of syntactically correct links, this function will open
  9574. the link at point in comments or comment blocks and the first
  9575. link in a property drawer line."
  9576. (interactive "P")
  9577. ;; On a code block, open block's results.
  9578. (unless (call-interactively 'org-babel-open-src-block-result)
  9579. (org-load-modules-maybe)
  9580. (move-marker org-open-link-marker (point))
  9581. (setq org-window-config-before-follow-link (current-window-configuration))
  9582. (org-remove-occur-highlights nil nil t)
  9583. (unless (run-hook-with-args-until-success 'org-open-at-point-functions)
  9584. (let* ((context
  9585. ;; Only consider supported types, even if they are not
  9586. ;; the closest one.
  9587. (org-element-lineage
  9588. (org-element-context)
  9589. '(comment comment-block footnote-definition footnote-reference
  9590. headline inlinetask keyword link node-property
  9591. timestamp)
  9592. t))
  9593. (type (org-element-type context))
  9594. (value (org-element-property :value context)))
  9595. (cond
  9596. ((not context) (user-error "No link found"))
  9597. ;; Exception: open timestamps and links in properties
  9598. ;; drawers, keywords and comments.
  9599. ((memq type '(comment comment-block keyword node-property))
  9600. (cond ((org-in-regexp org-any-link-re)
  9601. (org-open-link-from-string (match-string-no-properties 0)))
  9602. ((or (org-at-timestamp-p t) (org-at-date-range-p t))
  9603. (org-follow-timestamp-link))
  9604. (t (user-error "No link found"))))
  9605. ;; On a headline or an inlinetask, but not on a timestamp,
  9606. ;; a link, a footnote reference or on tags.
  9607. ((and (memq type '(headline inlinetask))
  9608. ;; Not on tags.
  9609. (progn (save-excursion (beginning-of-line)
  9610. (looking-at org-complex-heading-regexp))
  9611. (or (not (match-beginning 5))
  9612. (< (point) (match-beginning 5)))))
  9613. (let* ((data (org-offer-links-in-entry (current-buffer) (point) arg))
  9614. (links (car data))
  9615. (links-end (cdr data)))
  9616. (if links
  9617. (dolist (link (if (stringp links) (list links) links))
  9618. (search-forward link nil links-end)
  9619. (goto-char (match-beginning 0))
  9620. (org-open-at-point))
  9621. (require 'org-attach)
  9622. (org-attach-reveal 'if-exists))))
  9623. ;; Do nothing on white spaces after an object, unless point
  9624. ;; is right after it.
  9625. ((> (point)
  9626. (save-excursion
  9627. (goto-char (org-element-property :end context))
  9628. (skip-chars-backward " \t")
  9629. (point)))
  9630. (user-error "No link found"))
  9631. ((eq type 'timestamp) (org-follow-timestamp-link))
  9632. ;; On tags within a headline or an inlinetask.
  9633. ((and (memq type '(headline inlinetask))
  9634. (progn (save-excursion (beginning-of-line)
  9635. (looking-at org-complex-heading-regexp))
  9636. (and (match-beginning 5)
  9637. (>= (point) (match-beginning 5)))))
  9638. (org-tags-view arg (substring (match-string 5) 0 -1)))
  9639. ((eq type 'link)
  9640. ;; When link is located within the description of another
  9641. ;; link (e.g., an inline image), always open the parent
  9642. ;; link.
  9643. (let*((link (let ((up (org-element-property :parent context)))
  9644. (if (eq (org-element-type up) 'link) up context)))
  9645. (type (org-element-property :type link))
  9646. (path (org-link-unescape (org-element-property :path link))))
  9647. ;; Switch back to REFERENCE-BUFFER needed when called in
  9648. ;; a temporary buffer through `org-open-link-from-string'.
  9649. (with-current-buffer (or reference-buffer (current-buffer))
  9650. (cond
  9651. ((equal type "file")
  9652. (if (string-match "[*?{]" (file-name-nondirectory path))
  9653. (dired path)
  9654. ;; Look into `org-link-protocols' in order to find
  9655. ;; a DEDICATED-FUNCTION to open file. The function
  9656. ;; will be applied on raw link instead of parsed
  9657. ;; link due to the limitation in `org-add-link-type'
  9658. ;; ("open" function called with a single argument).
  9659. ;; If no such function is found, fallback to
  9660. ;; `org-open-file'.
  9661. ;;
  9662. ;; Note : "file+emacs" and "file+sys" types are
  9663. ;; hard-coded in order to escape the previous
  9664. ;; limitation.
  9665. (let* ((option (org-element-property :search-option link))
  9666. (app (org-element-property :application link))
  9667. (dedicated-function
  9668. (nth 1 (assoc app org-link-protocols))))
  9669. (if dedicated-function
  9670. (funcall dedicated-function
  9671. (concat path
  9672. (and option (concat "::" option))))
  9673. (apply 'org-open-file
  9674. path
  9675. (cond (arg)
  9676. ((equal app "emacs") 'emacs)
  9677. ((equal app "sys") 'system))
  9678. (cond ((not option) nil)
  9679. ((org-string-match-p "\\`[0-9]+\\'" option)
  9680. (list (string-to-number option)))
  9681. (t (list nil
  9682. (org-link-unescape option)))))))))
  9683. ((assoc type org-link-protocols)
  9684. (funcall (nth 1 (assoc type org-link-protocols)) path))
  9685. ((equal type "help")
  9686. (let ((f-or-v (intern path)))
  9687. (cond ((fboundp f-or-v) (describe-function f-or-v))
  9688. ((boundp f-or-v) (describe-variable f-or-v))
  9689. (t (error "Not a known function or variable")))))
  9690. ((member type '("http" "https" "ftp" "mailto" "news"))
  9691. (browse-url (org-link-escape-browser (concat type ":" path))))
  9692. ((equal type "doi")
  9693. (browse-url
  9694. (org-link-escape-browser (concat org-doi-server-url path))))
  9695. ((equal type "message") (browse-url (concat type ":" path)))
  9696. ((equal type "shell")
  9697. (let ((buf (generate-new-buffer "*Org Shell Output*"))
  9698. (cmd path))
  9699. (if (or (and (org-string-nw-p
  9700. org-confirm-shell-link-not-regexp)
  9701. (string-match
  9702. org-confirm-shell-link-not-regexp cmd))
  9703. (not org-confirm-shell-link-function)
  9704. (funcall org-confirm-shell-link-function
  9705. (format "Execute \"%s\" in shell? "
  9706. (org-add-props cmd nil
  9707. 'face 'org-warning))))
  9708. (progn
  9709. (message "Executing %s" cmd)
  9710. (shell-command cmd buf)
  9711. (when (featurep 'midnight)
  9712. (setq clean-buffer-list-kill-buffer-names
  9713. (cons (buffer-name buf)
  9714. clean-buffer-list-kill-buffer-names))))
  9715. (user-error "Abort"))))
  9716. ((equal type "elisp")
  9717. (let ((cmd path))
  9718. (if (or (and (org-string-nw-p
  9719. org-confirm-elisp-link-not-regexp)
  9720. (org-string-match-p
  9721. org-confirm-elisp-link-not-regexp cmd))
  9722. (not org-confirm-elisp-link-function)
  9723. (funcall org-confirm-elisp-link-function
  9724. (format "Execute \"%s\" as elisp? "
  9725. (org-add-props cmd nil
  9726. 'face 'org-warning))))
  9727. (message "%s => %s" cmd
  9728. (if (eq (string-to-char cmd) ?\()
  9729. (eval (read cmd))
  9730. (call-interactively (read cmd))))
  9731. (user-error "Abort"))))
  9732. ((equal type "id")
  9733. (require 'ord-id)
  9734. (funcall (nth 1 (assoc "id" org-link-protocols)) 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 ((cmd `(org-link-search
  9742. ,(if (member type '("custom-id" "coderef"))
  9743. (org-element-property :raw-link link)
  9744. path)
  9745. ,(cond ((equal arg '(4)) 'occur)
  9746. ((equal arg '(16)) 'org-occur))
  9747. ,(org-element-property :begin link))))
  9748. (condition-case nil
  9749. (let ((org-link-search-inhibit-query t))
  9750. (eval cmd))
  9751. (error (progn (widen) (eval cmd)))))))
  9752. (t (browse-url-at-point))))))
  9753. ;; On a footnote reference or at a footnote definition's label.
  9754. ((or (eq type 'footnote-reference)
  9755. (and (eq type 'footnote-definition)
  9756. (save-excursion
  9757. ;; Do not validate action when point is on the
  9758. ;; spaces right after the footnote label, in
  9759. ;; order to be on par with behaviour on links.
  9760. (skip-chars-forward " \t")
  9761. (let ((begin
  9762. (org-element-property :contents-begin context)))
  9763. (if begin (< (point) begin)
  9764. (= (org-element-property :post-affiliated context)
  9765. (line-beginning-position)))))))
  9766. (org-footnote-action))
  9767. (t (user-error "No link found")))))
  9768. (move-marker org-open-link-marker nil)
  9769. (run-hook-with-args 'org-follow-link-hook)))
  9770. (defun org-offer-links-in-entry (buffer marker &optional nth zero)
  9771. "Offer links in the current entry and return the selected link.
  9772. If there is only one link, return it.
  9773. If NTH is an integer, return the NTH link found.
  9774. If ZERO is a string, check also this string for a link, and if
  9775. there is one, return it."
  9776. (with-current-buffer buffer
  9777. (save-excursion
  9778. (save-restriction
  9779. (widen)
  9780. (goto-char marker)
  9781. (let ((cnt ?0)
  9782. (in-emacs (if (integerp nth) nil nth))
  9783. have-zero end links link c)
  9784. (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
  9785. (push (match-string 0 zero) links)
  9786. (setq cnt (1- cnt) have-zero t))
  9787. (save-excursion
  9788. (org-back-to-heading t)
  9789. (setq end (save-excursion (outline-next-heading) (point)))
  9790. (while (re-search-forward org-any-link-re end t)
  9791. (push (match-string 0) links))
  9792. (setq links (org-uniquify (reverse links))))
  9793. (cond
  9794. ((null links)
  9795. (message "No links"))
  9796. ((equal (length links) 1)
  9797. (setq link (car links)))
  9798. ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
  9799. (setq link (nth (if have-zero nth (1- nth)) links)))
  9800. (t ; we have to select a link
  9801. (save-excursion
  9802. (save-window-excursion
  9803. (delete-other-windows)
  9804. (with-output-to-temp-buffer "*Select Link*"
  9805. (mapc (lambda (l)
  9806. (if (not (string-match org-bracket-link-regexp l))
  9807. (princ (format "[%c] %s\n" (incf cnt)
  9808. (org-remove-angle-brackets l)))
  9809. (if (match-end 3)
  9810. (princ (format "[%c] %s (%s)\n" (incf cnt)
  9811. (match-string 3 l) (match-string 1 l)))
  9812. (princ (format "[%c] %s\n" (incf cnt)
  9813. (match-string 1 l))))))
  9814. links))
  9815. (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
  9816. (message "Select link to open, RET to open all:")
  9817. (setq c (read-char-exclusive))
  9818. (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
  9819. (when (equal c ?q) (user-error "Abort"))
  9820. (if (equal c ?\C-m)
  9821. (setq link links)
  9822. (setq nth (- c ?0))
  9823. (if have-zero (setq nth (1+ nth)))
  9824. (unless (and (integerp nth) (>= (length links) nth))
  9825. (user-error "Invalid link selection"))
  9826. (setq link (nth (1- nth) links)))))
  9827. (cons link end))))))
  9828. ;; TODO: These functions are deprecated since `org-open-at-point'
  9829. ;; hard-codes behaviour for "file+emacs" and "file+sys" types.
  9830. (defun org-open-file-with-system (path)
  9831. "Open file at PATH using the system way of opening it."
  9832. (org-open-file path 'system))
  9833. (defun org-open-file-with-emacs (path)
  9834. "Open file at PATH in Emacs."
  9835. (org-open-file path 'emacs))
  9836. ;;; File search
  9837. (defvar org-create-file-search-functions nil
  9838. "List of functions to construct the right search string for a file link.
  9839. These functions are called in turn with point at the location to
  9840. which the link should point.
  9841. A function in the hook should first test if it would like to
  9842. handle this file type, for example by checking the `major-mode'
  9843. or the file extension. If it decides not to handle this file, it
  9844. should just return nil to give other functions a chance. If it
  9845. does handle the file, it must return the search string to be used
  9846. when following the link. The search string will be part of the
  9847. file link, given after a double colon, and `org-open-at-point'
  9848. will automatically search for it. If special measures must be
  9849. taken to make the search successful, another function should be
  9850. added to the companion hook `org-execute-file-search-functions',
  9851. which see.
  9852. A function in this hook may also use `setq' to set the variable
  9853. `description' to provide a suggestion for the descriptive text to
  9854. be used for this link when it gets inserted into an Org-mode
  9855. buffer with \\[org-insert-link].")
  9856. (defvar org-execute-file-search-functions nil
  9857. "List of functions to execute a file search triggered by a link.
  9858. Functions added to this hook must accept a single argument, the
  9859. search string that was part of the file link, the part after the
  9860. double colon. The function must first check if it would like to
  9861. handle this search, for example by checking the `major-mode' or
  9862. the file extension. If it decides not to handle this search, it
  9863. should just return nil to give other functions a chance. If it
  9864. does handle the search, it must return a non-nil value to keep
  9865. other functions from trying.
  9866. Each function can access the current prefix argument through the
  9867. variable `current-prefix-arg'. Note that a single prefix is used
  9868. to force opening a link in Emacs, so it may be good to only use a
  9869. numeric or double prefix to guide the search function.
  9870. In case this is needed, a function in this hook can also restore
  9871. the window configuration before `org-open-at-point' was called using:
  9872. (set-window-configuration org-window-config-before-follow-link)")
  9873. (defun org-link-search (s &optional type avoid-pos stealth)
  9874. "Search for a link search option.
  9875. If S is surrounded by forward slashes, it is interpreted as a
  9876. regular expression. In org-mode files, this will create an `org-occur'
  9877. sparse tree. In ordinary files, `occur' will be used to list matches.
  9878. If the current buffer is in `dired-mode', grep will be used to search
  9879. in all files. If AVOID-POS is given, ignore matches near that position.
  9880. When optional argument STEALTH is non-nil, do not modify
  9881. visibility around point, thus ignoring `org-show-context-detail'
  9882. variable."
  9883. (let ((case-fold-search t)
  9884. (s0 (mapconcat 'identity (org-split-string s "[ \t\r\n]+") " "))
  9885. (markers (concat "\\(?:" (mapconcat (lambda (x) (regexp-quote (car x)))
  9886. (append '(("") (" ") ("\t") ("\n"))
  9887. org-emphasis-alist)
  9888. "\\|") "\\)"))
  9889. (pos (point))
  9890. words re0 re2 re4_ re4 re5 re2a re2a_ reall)
  9891. (cond
  9892. ;; First check if there are any special search functions
  9893. ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
  9894. ;; Now try the builtin stuff
  9895. ((and (eq (aref s0 0) ?#)
  9896. (> (length s0) 1)
  9897. (let ((match (org-find-property "CUSTOM_ID" (substring s0 1))))
  9898. (and match (goto-char match) (setf type 'dedicated)))))
  9899. ((save-excursion
  9900. (goto-char (point-min))
  9901. (and
  9902. (re-search-forward
  9903. (concat "<<" (regexp-quote s0) ">>") nil t)
  9904. (setq type 'dedicated
  9905. pos (match-beginning 0))))
  9906. ;; There is an exact target for this
  9907. (goto-char pos))
  9908. ((save-excursion
  9909. (goto-char (point-min))
  9910. (and
  9911. (re-search-forward
  9912. (format "^[ \t]*#\\+NAME: %s" (regexp-quote s0)) nil t)
  9913. (setq type 'dedicated pos (match-beginning 0))))
  9914. ;; Found an element with a matching #+name affiliated keyword.
  9915. (goto-char pos))
  9916. ((and (string-match "^(\\(.*\\))$" s0)
  9917. (save-excursion
  9918. (goto-char (point-min))
  9919. (and
  9920. (re-search-forward
  9921. (concat "[^[]" (regexp-quote
  9922. (format org-coderef-label-format
  9923. (match-string 1 s0))))
  9924. nil t)
  9925. (setq type 'dedicated
  9926. pos (1+ (match-beginning 0))))))
  9927. ;; There is a coderef target for this
  9928. (goto-char pos))
  9929. ((string-match "^/\\(.*\\)/$" s)
  9930. ;; A regular expression
  9931. (cond
  9932. ((derived-mode-p 'org-mode)
  9933. (org-occur (match-string 1 s)))
  9934. (t (org-do-occur (match-string 1 s)))))
  9935. ((and (derived-mode-p 'org-mode)
  9936. (or (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
  9937. org-link-search-must-match-exact-headline))
  9938. ;; Headline search.
  9939. (goto-char (point-min))
  9940. (cond
  9941. ((let (case-fold-search)
  9942. (re-search-forward
  9943. (let* ((wspace "[ \t]")
  9944. (wspaceopt (concat wspace "*"))
  9945. (cookie (concat "\\(?:"
  9946. wspaceopt
  9947. "\\[[0-9]*\\(?:%\\|/[0-9]*\\)\\]"
  9948. wspaceopt
  9949. "\\)"))
  9950. (sep (concat "\\(?:" wspace "+\\|" cookie "+\\)")))
  9951. (concat
  9952. org-outline-regexp-bol
  9953. "\\(?:" org-todo-regexp "[ \t]+\\)?"
  9954. "\\(?:\\[#.\\][ \t]+\\)?"
  9955. "\\(?:" org-comment-string "[ \t]+\\)?"
  9956. sep "*"
  9957. (mapconcat #'identity
  9958. (org-split-string (regexp-quote s))
  9959. (concat sep "+"))
  9960. sep "*"
  9961. (org-re "\\(?:[ \t]+:[[:alnum:]_@#%%:]+:\\)?")
  9962. "[ \t]*$"))
  9963. nil t))
  9964. ;; OK, found a match
  9965. (setq type 'dedicated)
  9966. (goto-char (match-beginning 0)))
  9967. ((and (not org-link-search-inhibit-query)
  9968. (eq org-link-search-must-match-exact-headline 'query-to-create)
  9969. (y-or-n-p "No match - create this as a new heading? "))
  9970. (goto-char (point-max))
  9971. (unless (bolp) (newline))
  9972. (org-insert-heading nil t t)
  9973. (insert s "\n")
  9974. (beginning-of-line 0))
  9975. (t
  9976. (goto-char pos)
  9977. (error "No match"))))
  9978. (t
  9979. ;; A normal search string
  9980. (remove-text-properties
  9981. 0 (length s)
  9982. '(face nil mouse-face nil keymap nil fontified nil) s)
  9983. ;; Make a series of regular expressions to find a match
  9984. (setq words (org-split-string s "[ \n\r\t]+")
  9985. re0 (concat "\\(<<" (regexp-quote s0) ">>\\)")
  9986. re2 (concat markers "\\(" (mapconcat 'downcase words "[ \t]+")
  9987. "\\)" markers)
  9988. re2a_ (concat "\\(" (mapconcat 'downcase words
  9989. "[ \t\r\n]+") "\\)[ \t\r\n]")
  9990. re2a (concat "[ \t\r\n]" re2a_)
  9991. re4_ (concat "\\(" (mapconcat 'downcase words
  9992. "[^a-zA-Z_\r\n]+") "\\)[^a-zA-Z_]")
  9993. re4 (concat "[^a-zA-Z_]" re4_)
  9994. re5 (concat ".*" re4)
  9995. reall (concat "\\(" re0 "\\)\\|\\(" re2 "\\)\\|\\(" re4
  9996. "\\)\\|\\(" re5 "\\)"))
  9997. (cond
  9998. ((eq type 'org-occur) (org-occur reall))
  9999. ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
  10000. (t (goto-char (point-min))
  10001. (setq type 'fuzzy)
  10002. (if (or (and (org-search-not-self 1 re0 nil t)
  10003. (setq type 'dedicated))
  10004. (org-search-not-self 1 re2 nil t)
  10005. (org-search-not-self 1 re2a nil t)
  10006. (org-search-not-self 1 re4 nil t)
  10007. (org-search-not-self 1 re5 nil t))
  10008. (goto-char (match-beginning 1))
  10009. (goto-char pos)
  10010. (error "No match"))))))
  10011. (and (derived-mode-p 'org-mode)
  10012. (not stealth)
  10013. (org-show-context 'link-search))
  10014. type))
  10015. (defun org-search-not-self (group &rest args)
  10016. "Execute `re-search-forward', but only accept matches that do not
  10017. enclose the position of `org-open-link-marker'."
  10018. (let ((m org-open-link-marker))
  10019. (catch 'exit
  10020. (while (apply 're-search-forward args)
  10021. (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
  10022. (goto-char (match-end group))
  10023. (if (and (or (not (eq (marker-buffer m) (current-buffer)))
  10024. (> (match-beginning 0) (marker-position m))
  10025. (< (match-end 0) (marker-position m)))
  10026. (save-match-data
  10027. (or (not (org-in-regexp
  10028. org-bracket-link-analytic-regexp 1))
  10029. (not (match-end 4)) ; no description
  10030. (and (<= (match-beginning 4) (point))
  10031. (>= (match-end 4) (point))))))
  10032. (throw 'exit (point))))))))
  10033. (defun org-get-buffer-for-internal-link (buffer)
  10034. "Return a buffer to be used for displaying the link target of internal links."
  10035. (cond
  10036. ((not org-display-internal-link-with-indirect-buffer)
  10037. buffer)
  10038. ((string-match "(Clone)$" (buffer-name buffer))
  10039. (message "Buffer is already a clone, not making another one")
  10040. ;; we also do not modify visibility in this case
  10041. buffer)
  10042. (t ; make a new indirect buffer for displaying the link
  10043. (let* ((bn (buffer-name buffer))
  10044. (ibn (concat bn "(Clone)"))
  10045. (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
  10046. (with-current-buffer ib (org-overview))
  10047. ib))))
  10048. (defun org-do-occur (regexp &optional cleanup)
  10049. "Call the Emacs command `occur'.
  10050. If CLEANUP is non-nil, remove the printout of the regular expression
  10051. in the *Occur* buffer. This is useful if the regex is long and not useful
  10052. to read."
  10053. (occur regexp)
  10054. (when cleanup
  10055. (let ((cwin (selected-window)) win beg end)
  10056. (when (setq win (get-buffer-window "*Occur*"))
  10057. (select-window win))
  10058. (goto-char (point-min))
  10059. (when (re-search-forward "match[a-z]+" nil t)
  10060. (setq beg (match-end 0))
  10061. (if (re-search-forward "^[ \t]*[0-9]+" nil t)
  10062. (setq end (1- (match-beginning 0)))))
  10063. (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
  10064. (goto-char (point-min))
  10065. (select-window cwin))))
  10066. ;;; The mark ring for links jumps
  10067. (defvar org-mark-ring nil
  10068. "Mark ring for positions before jumps in Org-mode.")
  10069. (defvar org-mark-ring-last-goto nil
  10070. "Last position in the mark ring used to go back.")
  10071. ;; Fill and close the ring
  10072. (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
  10073. (loop for i from 1 to org-mark-ring-length do
  10074. (push (make-marker) org-mark-ring))
  10075. (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
  10076. org-mark-ring)
  10077. (defun org-mark-ring-push (&optional pos buffer)
  10078. "Put the current position or POS into the mark ring and rotate it."
  10079. (interactive)
  10080. (setq pos (or pos (point)))
  10081. (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
  10082. (move-marker (car org-mark-ring)
  10083. (or pos (point))
  10084. (or buffer (current-buffer)))
  10085. (message "%s"
  10086. (substitute-command-keys
  10087. "Position saved to mark ring, go back with \\[org-mark-ring-goto].")))
  10088. (defun org-mark-ring-goto (&optional n)
  10089. "Jump to the previous position in the mark ring.
  10090. With prefix arg N, jump back that many stored positions. When
  10091. called several times in succession, walk through the entire ring.
  10092. Org-mode commands jumping to a different position in the current file,
  10093. or to another Org-mode file, automatically push the old position
  10094. onto the ring."
  10095. (interactive "p")
  10096. (let (p m)
  10097. (if (eq last-command this-command)
  10098. (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
  10099. (setq p org-mark-ring))
  10100. (setq org-mark-ring-last-goto p)
  10101. (setq m (car p))
  10102. (org-pop-to-buffer-same-window (marker-buffer m))
  10103. (goto-char m)
  10104. (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
  10105. (defun org-remove-angle-brackets (s)
  10106. (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
  10107. (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
  10108. s)
  10109. (defun org-add-angle-brackets (s)
  10110. (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
  10111. (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
  10112. s)
  10113. (defun org-remove-double-quotes (s)
  10114. (if (equal (substring s 0 1) "\"") (setq s (substring s 1)))
  10115. (if (equal (substring s -1) "\"") (setq s (substring s 0 -1)))
  10116. s)
  10117. ;;; Following specific links
  10118. (defun org-follow-timestamp-link ()
  10119. "Open an agenda view for the time-stamp date/range at point."
  10120. (cond
  10121. ((org-at-date-range-p t)
  10122. (let ((org-agenda-start-on-weekday)
  10123. (t1 (match-string 1))
  10124. (t2 (match-string 2)) tt1 tt2)
  10125. (setq tt1 (time-to-days (org-time-string-to-time t1))
  10126. tt2 (time-to-days (org-time-string-to-time t2)))
  10127. (let ((org-agenda-buffer-tmp-name
  10128. (format "*Org Agenda(a:%s)"
  10129. (concat (substring t1 0 10) "--" (substring t2 0 10)))))
  10130. (org-agenda-list nil tt1 (1+ (- tt2 tt1))))))
  10131. ((org-at-timestamp-p t)
  10132. (let ((org-agenda-buffer-tmp-name
  10133. (format "*Org Agenda(a:%s)" (substring (match-string 1) 0 10))))
  10134. (org-agenda-list nil (time-to-days (org-time-string-to-time
  10135. (substring (match-string 1) 0 10)))
  10136. 1)))
  10137. (t (error "This should not happen"))))
  10138. ;;; Following file links
  10139. (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
  10140. (declare-function mailcap-extension-to-mime "mailcap" (extn))
  10141. (declare-function mailcap-mime-info
  10142. "mailcap" (string &optional request no-decode))
  10143. (defvar org-wait nil)
  10144. (defun org-open-file (path &optional in-emacs line search)
  10145. "Open the file at PATH.
  10146. First, this expands any special file name abbreviations. Then the
  10147. configuration variable `org-file-apps' is checked if it contains an
  10148. entry for this file type, and if yes, the corresponding command is launched.
  10149. If no application is found, Emacs simply visits the file.
  10150. With optional prefix argument IN-EMACS, Emacs will visit the file.
  10151. With a double \\[universal-argument] \\[universal-argument] \
  10152. prefix arg, Org tries to avoid opening in Emacs
  10153. and to use an external application to visit the file.
  10154. Optional LINE specifies a line to go to, optional SEARCH a string
  10155. to search for. If LINE or SEARCH is given, the file will be
  10156. opened in Emacs, unless an entry from org-file-apps that makes
  10157. use of groups in a regexp matches.
  10158. If you want to change the way frames are used when following a
  10159. link, please customize `org-link-frame-setup'.
  10160. If the file does not exist, an error is thrown."
  10161. (let* ((file (if (equal path "")
  10162. buffer-file-name
  10163. (substitute-in-file-name (expand-file-name path))))
  10164. (file-apps (append org-file-apps (org-default-apps)))
  10165. (apps (org-remove-if
  10166. 'org-file-apps-entry-match-against-dlink-p file-apps))
  10167. (apps-dlink (org-remove-if-not
  10168. 'org-file-apps-entry-match-against-dlink-p file-apps))
  10169. (remp (and (assq 'remote apps) (org-file-remote-p file)))
  10170. (dirp (if remp nil (file-directory-p file)))
  10171. (file (if (and dirp org-open-directory-means-index-dot-org)
  10172. (concat (file-name-as-directory file) "index.org")
  10173. file))
  10174. (a-m-a-p (assq 'auto-mode apps))
  10175. (dfile (downcase file))
  10176. ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
  10177. (link (cond ((and (eq line nil)
  10178. (eq search nil))
  10179. file)
  10180. (line
  10181. (concat file "::" (number-to-string line)))
  10182. (search
  10183. (concat file "::" search))))
  10184. (dlink (downcase link))
  10185. (old-buffer (current-buffer))
  10186. (old-pos (point))
  10187. (old-mode major-mode)
  10188. ext cmd link-match-data)
  10189. (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\.gz\\)$" dfile)
  10190. (setq ext (match-string 1 dfile))
  10191. (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\)$" dfile)
  10192. (setq ext (match-string 1 dfile))))
  10193. (cond
  10194. ((member in-emacs '((16) system))
  10195. (setq cmd (cdr (assoc 'system apps))))
  10196. (in-emacs (setq cmd 'emacs))
  10197. (t
  10198. (setq cmd (or (and remp (cdr (assoc 'remote apps)))
  10199. (and dirp (cdr (assoc 'directory apps)))
  10200. ; first, try matching against apps-dlink
  10201. ; if we get a match here, store the match data for later
  10202. (let ((match (assoc-default dlink apps-dlink
  10203. 'string-match)))
  10204. (if match
  10205. (progn (setq link-match-data (match-data))
  10206. match)
  10207. (progn (setq in-emacs (or in-emacs line search))
  10208. nil))) ; if we have no match in apps-dlink,
  10209. ; always open the file in emacs if line or search
  10210. ; is given (for backwards compatibility)
  10211. (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
  10212. 'string-match)
  10213. (cdr (assoc ext apps))
  10214. (cdr (assoc t apps))))))
  10215. (when (eq cmd 'system)
  10216. (setq cmd (cdr (assoc 'system apps))))
  10217. (when (eq cmd 'default)
  10218. (setq cmd (cdr (assoc t apps))))
  10219. (when (eq cmd 'mailcap)
  10220. (require 'mailcap)
  10221. (mailcap-parse-mailcaps)
  10222. (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
  10223. (command (mailcap-mime-info mime-type)))
  10224. (if (stringp command)
  10225. (setq cmd command)
  10226. (setq cmd 'emacs))))
  10227. (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
  10228. (not (file-exists-p file))
  10229. (not org-open-non-existing-files))
  10230. (user-error "No such file: %s" file))
  10231. (cond
  10232. ((and (stringp cmd) (not (string-match "^\\s-*$" cmd)))
  10233. ;; Remove quotes around the file name - we'll use shell-quote-argument.
  10234. (while (string-match "['\"]%s['\"]" cmd)
  10235. (setq cmd (replace-match "%s" t t cmd)))
  10236. (while (string-match "%s" cmd)
  10237. (setq cmd (replace-match
  10238. (save-match-data
  10239. (shell-quote-argument
  10240. (convert-standard-filename file)))
  10241. t t cmd)))
  10242. ;; Replace "%1", "%2" etc. in command with group matches from regex
  10243. (save-match-data
  10244. (let ((match-index 1)
  10245. (number-of-groups (- (/ (length link-match-data) 2) 1)))
  10246. (set-match-data link-match-data)
  10247. (while (<= match-index number-of-groups)
  10248. (let ((regex (concat "%" (number-to-string match-index)))
  10249. (replace-with (match-string match-index dlink)))
  10250. (while (string-match regex cmd)
  10251. (setq cmd (replace-match replace-with t t cmd))))
  10252. (setq match-index (+ match-index 1)))))
  10253. (save-window-excursion
  10254. (message "Running %s...done" cmd)
  10255. (start-process-shell-command cmd nil cmd)
  10256. (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))))
  10257. ((or (stringp cmd)
  10258. (eq cmd 'emacs))
  10259. (funcall (cdr (assq 'file org-link-frame-setup)) file)
  10260. (widen)
  10261. (if line (progn (org-goto-line line)
  10262. (if (derived-mode-p 'org-mode)
  10263. (org-reveal)))
  10264. (if search (org-link-search search))))
  10265. ((consp cmd)
  10266. (let ((file (convert-standard-filename file)))
  10267. (save-match-data
  10268. (set-match-data link-match-data)
  10269. (eval cmd))))
  10270. (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
  10271. (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
  10272. (or (not (equal old-buffer (current-buffer)))
  10273. (not (equal old-pos (point))))
  10274. (org-mark-ring-push old-pos old-buffer))))
  10275. (defun org-file-apps-entry-match-against-dlink-p (entry)
  10276. "This function returns non-nil if `entry' uses a regular
  10277. expression which should be matched against the whole link by
  10278. org-open-file.
  10279. It assumes that is the case when the entry uses a regular
  10280. expression which has at least one grouping construct and the
  10281. action is either a lisp form or a command string containing
  10282. '%1', i.e. using at least one subexpression match as a
  10283. parameter."
  10284. (let ((selector (car entry))
  10285. (action (cdr entry)))
  10286. (if (stringp selector)
  10287. (and (> (regexp-opt-depth selector) 0)
  10288. (or (and (stringp action)
  10289. (string-match "%[0-9]" action))
  10290. (consp action)))
  10291. nil)))
  10292. (defun org-default-apps ()
  10293. "Return the default applications for this operating system."
  10294. (cond
  10295. ((eq system-type 'darwin)
  10296. org-file-apps-defaults-macosx)
  10297. ((eq system-type 'windows-nt)
  10298. org-file-apps-defaults-windowsnt)
  10299. (t org-file-apps-defaults-gnu)))
  10300. (defun org-apps-regexp-alist (list &optional add-auto-mode)
  10301. "Convert extensions to regular expressions in the cars of LIST.
  10302. Also, weed out any non-string entries, because the return value is used
  10303. only for regexp matching.
  10304. When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
  10305. point to the symbol `emacs', indicating that the file should
  10306. be opened in Emacs."
  10307. (append
  10308. (delq nil
  10309. (mapcar (lambda (x)
  10310. (if (not (stringp (car x)))
  10311. nil
  10312. (if (string-match "\\W" (car x))
  10313. x
  10314. (cons (concat "\\." (car x) "\\'") (cdr x)))))
  10315. list))
  10316. (if add-auto-mode
  10317. (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
  10318. (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
  10319. (defun org-file-remote-p (file)
  10320. "Test whether FILE specifies a location on a remote system.
  10321. Return non-nil if the location is indeed remote.
  10322. For example, the filename \"/user@host:/foo\" specifies a location
  10323. on the system \"/user@host:\"."
  10324. (cond ((fboundp 'file-remote-p)
  10325. (file-remote-p file))
  10326. ((fboundp 'tramp-handle-file-remote-p)
  10327. (tramp-handle-file-remote-p file))
  10328. ((and (boundp 'ange-ftp-name-format)
  10329. (string-match (car ange-ftp-name-format) file))
  10330. t)))
  10331. ;;;; Refiling
  10332. (defun org-get-org-file ()
  10333. "Read a filename, with default directory `org-directory'."
  10334. (let ((default (or org-default-notes-file remember-data-file)))
  10335. (read-file-name (format "File name [%s]: " default)
  10336. (file-name-as-directory org-directory)
  10337. default)))
  10338. (defun org-notes-order-reversed-p ()
  10339. "Check if the current file should receive notes in reversed order."
  10340. (cond
  10341. ((not org-reverse-note-order) nil)
  10342. ((eq t org-reverse-note-order) t)
  10343. ((not (listp org-reverse-note-order)) nil)
  10344. (t (catch 'exit
  10345. (let ((all org-reverse-note-order)
  10346. entry)
  10347. (while (setq entry (pop all))
  10348. (if (string-match (car entry) buffer-file-name)
  10349. (throw 'exit (cdr entry))))
  10350. nil)))))
  10351. (defvar org-refile-target-table nil
  10352. "The list of refile targets, created by `org-refile'.")
  10353. (defvar org-agenda-new-buffers nil
  10354. "Buffers created to visit agenda files.")
  10355. (defvar org-refile-cache nil
  10356. "Cache for refile targets.")
  10357. (defvar org-refile-markers nil
  10358. "All the markers used for caching refile locations.")
  10359. (defun org-refile-marker (pos)
  10360. "Get a new refile marker, but only if caching is in use."
  10361. (if (not org-refile-use-cache)
  10362. pos
  10363. (let ((m (make-marker)))
  10364. (move-marker m pos)
  10365. (push m org-refile-markers)
  10366. m)))
  10367. (defun org-refile-cache-clear ()
  10368. "Clear the refile cache and disable all the markers."
  10369. (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
  10370. (setq org-refile-markers nil)
  10371. (setq org-refile-cache nil)
  10372. (message "Refile cache has been cleared"))
  10373. (defun org-refile-cache-check-set (set)
  10374. "Check if all the markers in the cache still have live buffers."
  10375. (let (marker)
  10376. (catch 'exit
  10377. (while (and set (setq marker (nth 3 (pop set))))
  10378. ;; If `org-refile-use-outline-path' is 'file, marker may be nil
  10379. (when (and marker (null (marker-buffer marker)))
  10380. (message "Please regenerate the refile cache with `C-0 C-c C-w'")
  10381. (sit-for 3)
  10382. (throw 'exit nil)))
  10383. t)))
  10384. (defun org-refile-cache-put (set &rest identifiers)
  10385. "Push the refile targets SET into the cache, under IDENTIFIERS."
  10386. (let* ((key (sha1 (prin1-to-string identifiers)))
  10387. (entry (assoc key org-refile-cache)))
  10388. (if entry
  10389. (setcdr entry set)
  10390. (push (cons key set) org-refile-cache))))
  10391. (defun org-refile-cache-get (&rest identifiers)
  10392. "Retrieve the cached value for refile targets given by IDENTIFIERS."
  10393. (cond
  10394. ((not org-refile-cache) nil)
  10395. ((not org-refile-use-cache) (org-refile-cache-clear) nil)
  10396. (t
  10397. (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
  10398. org-refile-cache))))
  10399. (and set (org-refile-cache-check-set set) set)))))
  10400. (defun org-refile-get-targets (&optional default-buffer excluded-entries)
  10401. "Produce a table with refile targets."
  10402. (let ((case-fold-search nil)
  10403. ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
  10404. (entries (or org-refile-targets '((nil . (:level . 1)))))
  10405. targets tgs txt re files f desc descre fast-path-p level pos0)
  10406. (message "Getting targets...")
  10407. (with-current-buffer (or default-buffer (current-buffer))
  10408. (while (setq entry (pop entries))
  10409. (setq files (car entry) desc (cdr entry))
  10410. (setq fast-path-p nil)
  10411. (cond
  10412. ((null files) (setq files (list (current-buffer))))
  10413. ((eq files 'org-agenda-files)
  10414. (setq files (org-agenda-files 'unrestricted)))
  10415. ((and (symbolp files) (fboundp files))
  10416. (setq files (funcall files)))
  10417. ((and (symbolp files) (boundp files))
  10418. (setq files (symbol-value files))))
  10419. (if (stringp files) (setq files (list files)))
  10420. (cond
  10421. ((eq (car desc) :tag)
  10422. (setq descre (concat "^\\*+[ \t]+.*?:" (regexp-quote (cdr desc)) ":")))
  10423. ((eq (car desc) :todo)
  10424. (setq descre (concat "^\\*+[ \t]+" (regexp-quote (cdr desc)) "[ \t]")))
  10425. ((eq (car desc) :regexp)
  10426. (setq descre (cdr desc)))
  10427. ((eq (car desc) :level)
  10428. (setq descre (concat "^\\*\\{" (number-to-string
  10429. (if org-odd-levels-only
  10430. (1- (* 2 (cdr desc)))
  10431. (cdr desc)))
  10432. "\\}[ \t]")))
  10433. ((eq (car desc) :maxlevel)
  10434. (setq fast-path-p t)
  10435. (setq descre (concat "^\\*\\{1," (number-to-string
  10436. (if org-odd-levels-only
  10437. (1- (* 2 (cdr desc)))
  10438. (cdr desc)))
  10439. "\\}[ \t]")))
  10440. (t (error "Bad refiling target description %s" desc)))
  10441. (while (setq f (pop files))
  10442. (with-current-buffer
  10443. (if (bufferp f) f (org-get-agenda-file-buffer f))
  10444. (or
  10445. (setq tgs (org-refile-cache-get (buffer-file-name) descre))
  10446. (progn
  10447. (if (bufferp f) (setq f (buffer-file-name
  10448. (buffer-base-buffer f))))
  10449. (setq f (and f (expand-file-name f)))
  10450. (if (eq org-refile-use-outline-path 'file)
  10451. (push (list (file-name-nondirectory f) f nil nil) tgs))
  10452. (save-excursion
  10453. (save-restriction
  10454. (widen)
  10455. (goto-char (point-min))
  10456. (while (re-search-forward descre nil t)
  10457. (goto-char (setq pos0 (point-at-bol)))
  10458. (catch 'next
  10459. (when org-refile-target-verify-function
  10460. (save-match-data
  10461. (or (funcall org-refile-target-verify-function)
  10462. (throw 'next t))))
  10463. (when (and (looking-at org-complex-heading-regexp)
  10464. (not (member (match-string 4) excluded-entries))
  10465. (match-string 4))
  10466. (setq level (org-reduced-level
  10467. (- (match-end 1) (match-beginning 1)))
  10468. txt (org-link-display-format (match-string 4))
  10469. txt (replace-regexp-in-string "\\( *\[[0-9]+/?[0-9]*%?\]\\)+$" "" txt)
  10470. re (format org-complex-heading-regexp-format
  10471. (regexp-quote (match-string 4))))
  10472. (when org-refile-use-outline-path
  10473. (setq txt (mapconcat
  10474. 'org-protect-slash
  10475. (append
  10476. (if (eq org-refile-use-outline-path
  10477. 'file)
  10478. (list (file-name-nondirectory
  10479. (buffer-file-name
  10480. (buffer-base-buffer))))
  10481. (if (eq org-refile-use-outline-path
  10482. 'full-file-path)
  10483. (list (buffer-file-name
  10484. (buffer-base-buffer)))))
  10485. (org-get-outline-path fast-path-p
  10486. level txt)
  10487. (list txt))
  10488. "/")))
  10489. (push (list txt f re (org-refile-marker (point)))
  10490. tgs)))
  10491. (when (= (point) pos0)
  10492. ;; verification function has not moved point
  10493. (goto-char (point-at-eol))))))))
  10494. (when org-refile-use-cache
  10495. (org-refile-cache-put tgs (buffer-file-name) descre))
  10496. (setq targets (append tgs targets))))))
  10497. (message "Getting targets...done")
  10498. (nreverse targets)))
  10499. (defun org-protect-slash (s)
  10500. (while (string-match "/" s)
  10501. (setq s (replace-match "\\" t t s)))
  10502. s)
  10503. (defvar org-olpa (make-vector 20 nil))
  10504. (defun org-get-outline-path (&optional fastp level heading)
  10505. "Return the outline path to the current entry, as a list.
  10506. The parameters FASTP, LEVEL, and HEADING are for use by a scanner
  10507. routine which makes outline path derivations for an entire file,
  10508. avoiding backtracing. Refile target collection makes use of that."
  10509. (if fastp
  10510. (progn
  10511. (if (> level 19)
  10512. (error "Outline path failure, more than 19 levels"))
  10513. (loop for i from level upto 19 do
  10514. (aset org-olpa i nil))
  10515. (prog1
  10516. (delq nil (append org-olpa nil))
  10517. (aset org-olpa level heading)))
  10518. (let (rtn case-fold-search)
  10519. (save-excursion
  10520. (save-restriction
  10521. (widen)
  10522. (while (org-up-heading-safe)
  10523. (when (looking-at org-complex-heading-regexp)
  10524. (push (org-trim
  10525. (replace-regexp-in-string
  10526. ;; Remove statistical/checkboxes cookies
  10527. "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" ""
  10528. (org-match-string-no-properties 4)))
  10529. rtn)))
  10530. rtn)))))
  10531. (defun org-format-outline-path (path &optional width prefix separator)
  10532. "Format the outline path PATH for display.
  10533. WIDTH is the maximum number of characters that is available.
  10534. PREFIX is a prefix to be included in the returned string,
  10535. such as the file name.
  10536. SEPARATOR is inserted between the different parts of the path,
  10537. the default is \"/\"."
  10538. (setq width (or width 79))
  10539. (if prefix (setq width (- width (length prefix))))
  10540. (if (not path)
  10541. (or prefix "")
  10542. (let* ((nsteps (length path))
  10543. (total-width (+ nsteps (apply '+ (mapcar 'length path))))
  10544. (maxwidth (if (<= total-width width)
  10545. 10000 ;; everything fits
  10546. ;; we need to shorten the level headings
  10547. (/ (- width nsteps) nsteps)))
  10548. (org-odd-levels-only nil)
  10549. (n 0)
  10550. (total (1+ (length prefix))))
  10551. (setq maxwidth (max maxwidth 10))
  10552. (concat prefix
  10553. (if prefix (or separator "/"))
  10554. (mapconcat
  10555. (lambda (h)
  10556. (setq n (1+ n))
  10557. (if (and (= n nsteps) (< maxwidth 10000))
  10558. (setq maxwidth (- total-width total)))
  10559. (if (< (length h) maxwidth)
  10560. (progn (setq total (+ total (length h) 1)) h)
  10561. (setq h (substring h 0 (- maxwidth 2))
  10562. total (+ total maxwidth 1))
  10563. (if (string-match "[ \t]+\\'" h)
  10564. (setq h (substring h 0 (match-beginning 0))))
  10565. (setq h (concat h "..")))
  10566. (org-add-props h nil 'face
  10567. (nth (% (1- n) org-n-level-faces)
  10568. org-level-faces))
  10569. h)
  10570. path (or separator "/"))))))
  10571. (defun org-display-outline-path (&optional file current separator just-return-string)
  10572. "Display the current outline path in the echo area.
  10573. If FILE is non-nil, prepend the output with the file name.
  10574. If CURRENT is non-nil, append the current heading to the output.
  10575. SEPARATOR is passed through to `org-format-outline-path'. It separates
  10576. the different parts of the path and defaults to \"/\".
  10577. If JUST-RETURN-STRING is non-nil, return a string, don't display a message."
  10578. (interactive "P")
  10579. (let* (case-fold-search
  10580. (bfn (buffer-file-name (buffer-base-buffer)))
  10581. (path (and (derived-mode-p 'org-mode) (org-get-outline-path)))
  10582. res)
  10583. (if current (setq path (append path
  10584. (save-excursion
  10585. (org-back-to-heading t)
  10586. (if (looking-at org-complex-heading-regexp)
  10587. (list (match-string 4)))))))
  10588. (setq res
  10589. (org-format-outline-path
  10590. path
  10591. (1- (frame-width))
  10592. (and file bfn (concat (file-name-nondirectory bfn) separator))
  10593. separator))
  10594. (if just-return-string
  10595. (org-no-properties res)
  10596. (org-unlogged-message "%s" res))))
  10597. (defvar org-refile-history nil
  10598. "History for refiling operations.")
  10599. (defvar org-after-refile-insert-hook nil
  10600. "Hook run after `org-refile' has inserted its stuff at the new location.
  10601. Note that this is still *before* the stuff will be removed from
  10602. the *old* location.")
  10603. (defvar org-capture-last-stored-marker)
  10604. (defvar org-refile-keep nil
  10605. "Non-nil means `org-refile' will copy instead of refile.")
  10606. (defun org-copy ()
  10607. "Like `org-refile', but copy."
  10608. (interactive)
  10609. (let ((org-refile-keep t))
  10610. (funcall 'org-refile nil nil nil "Copy")))
  10611. (defun org-refile (&optional arg default-buffer rfloc msg)
  10612. "Move the entry or entries at point to another heading.
  10613. The list of target headings is compiled using the information in
  10614. `org-refile-targets', which see.
  10615. At the target location, the entry is filed as a subitem of the
  10616. target heading. Depending on `org-reverse-note-order', the new
  10617. subitem will either be the first or the last subitem.
  10618. If there is an active region, all entries in that region will be
  10619. refiled. However, the region must fulfill the requirement that
  10620. the first heading sets the top-level of the moved text.
  10621. With prefix arg ARG, the command will only visit the target
  10622. location and not actually move anything.
  10623. With a double prefix arg \\[universal-argument] \\[universal-argument], go to the location where the last
  10624. refiling operation has put the subtree.
  10625. With a numeric prefix argument of `2', refile to the running clock.
  10626. With a numeric prefix argument of `3', emulate `org-refile-keep'
  10627. being set to `t' and copy to the target location, don't move it.
  10628. Beware that keeping refiled entries may result in duplicated ID
  10629. properties.
  10630. RFLOC can be a refile location obtained in a different way.
  10631. MSG is a string to replace \"Refile\" in the default prompt with
  10632. another verb. E.g. `org-copy' sets this parameter to \"Copy\".
  10633. See also `org-refile-use-outline-path' and `org-completion-use-ido'.
  10634. If you are using target caching (see `org-refile-use-cache'), you
  10635. have to clear the target cache in order to find new targets.
  10636. This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
  10637. prefix argument (`C-u C-u C-u C-c C-w')."
  10638. (interactive "P")
  10639. (if (member arg '(0 (64)))
  10640. (org-refile-cache-clear)
  10641. (let* ((actionmsg (cond (msg msg)
  10642. ((equal arg 3) "Refile (and keep)")
  10643. (t "Refile")))
  10644. (cbuf (current-buffer))
  10645. (regionp (org-region-active-p))
  10646. (region-start (and regionp (region-beginning)))
  10647. (region-end (and regionp (region-end)))
  10648. (filename (buffer-file-name (buffer-base-buffer cbuf)))
  10649. (org-refile-keep (if (equal arg 3) t org-refile-keep))
  10650. pos it nbuf file re level reversed)
  10651. (setq last-command nil)
  10652. (when regionp
  10653. (goto-char region-start)
  10654. (or (bolp) (goto-char (point-at-bol)))
  10655. (setq region-start (point))
  10656. (unless (or (org-kill-is-subtree-p
  10657. (buffer-substring region-start region-end))
  10658. (prog1 org-refile-active-region-within-subtree
  10659. (let ((s (point-at-eol)))
  10660. (org-toggle-heading)
  10661. (setq region-end (+ (- (point-at-eol) s) region-end)))))
  10662. (user-error "The region is not a (sequence of) subtree(s)")))
  10663. (if (equal arg '(16))
  10664. (org-refile-goto-last-stored)
  10665. (when (or
  10666. (and (equal arg 2)
  10667. org-clock-hd-marker (marker-buffer org-clock-hd-marker)
  10668. (prog1
  10669. (setq it (list (or org-clock-heading "running clock")
  10670. (buffer-file-name
  10671. (marker-buffer org-clock-hd-marker))
  10672. ""
  10673. (marker-position org-clock-hd-marker)))
  10674. (setq arg nil)))
  10675. (setq it (or rfloc
  10676. (let (heading-text)
  10677. (save-excursion
  10678. (unless (and arg (listp arg))
  10679. (org-back-to-heading t)
  10680. (setq heading-text
  10681. (replace-regexp-in-string
  10682. org-bracket-link-regexp
  10683. "\\3"
  10684. (nth 4 (org-heading-components)))))
  10685. (org-refile-get-location
  10686. (cond ((and arg (listp arg)) "Goto")
  10687. (regionp (concat actionmsg " region to"))
  10688. (t (concat actionmsg " subtree \""
  10689. heading-text "\" to")))
  10690. default-buffer
  10691. (and (not (equal '(4) arg))
  10692. org-refile-allow-creating-parent-nodes)
  10693. arg))))))
  10694. (setq file (nth 1 it)
  10695. re (nth 2 it)
  10696. pos (nth 3 it))
  10697. (if (and (not arg)
  10698. pos
  10699. (equal (buffer-file-name) file)
  10700. (if regionp
  10701. (and (>= pos region-start)
  10702. (<= pos region-end))
  10703. (and (>= pos (point))
  10704. (< pos (save-excursion
  10705. (org-end-of-subtree t t))))))
  10706. (error "Cannot refile to position inside the tree or region"))
  10707. (setq nbuf (or (find-buffer-visiting file)
  10708. (find-file-noselect file)))
  10709. (if (and arg (not (equal arg 3)))
  10710. (progn
  10711. (org-pop-to-buffer-same-window nbuf)
  10712. (goto-char pos)
  10713. (org-show-context 'org-goto))
  10714. (if regionp
  10715. (progn
  10716. (org-kill-new (buffer-substring region-start region-end))
  10717. (org-save-markers-in-region region-start region-end))
  10718. (org-copy-subtree 1 nil t))
  10719. (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
  10720. (find-file-noselect file)))
  10721. (setq reversed (org-notes-order-reversed-p))
  10722. (save-excursion
  10723. (save-restriction
  10724. (widen)
  10725. (if pos
  10726. (progn
  10727. (goto-char pos)
  10728. (looking-at org-outline-regexp)
  10729. (setq level (org-get-valid-level (funcall outline-level) 1))
  10730. (goto-char
  10731. (if reversed
  10732. (or (outline-next-heading) (point-max))
  10733. (or (save-excursion (org-get-next-sibling))
  10734. (org-end-of-subtree t t)
  10735. (point-max)))))
  10736. (setq level 1)
  10737. (if (not reversed)
  10738. (goto-char (point-max))
  10739. (goto-char (point-min))
  10740. (or (outline-next-heading) (goto-char (point-max)))))
  10741. (if (not (bolp)) (newline))
  10742. (org-paste-subtree level nil nil t)
  10743. (when org-log-refile
  10744. (org-add-log-setup 'refile nil nil 'findpos org-log-refile)
  10745. (unless (eq org-log-refile 'note)
  10746. (save-excursion (org-add-log-note))))
  10747. (and org-auto-align-tags
  10748. (let ((org-loop-over-headlines-in-active-region nil))
  10749. (org-set-tags nil t)))
  10750. (let ((bookmark-name (plist-get org-bookmark-names-plist
  10751. :last-refile)))
  10752. (when bookmark-name
  10753. (with-demoted-errors
  10754. (bookmark-set bookmark-name))))
  10755. ;; If we are refiling for capture, make sure that the
  10756. ;; last-capture pointers point here
  10757. (when (org-bound-and-true-p org-refile-for-capture)
  10758. (let ((bookmark-name (plist-get org-bookmark-names-plist
  10759. :last-capture-marker)))
  10760. (when bookmark-name
  10761. (with-demoted-errors
  10762. (bookmark-set bookmark-name))))
  10763. (move-marker org-capture-last-stored-marker (point)))
  10764. (if (fboundp 'deactivate-mark) (deactivate-mark))
  10765. (run-hooks 'org-after-refile-insert-hook))))
  10766. (unless org-refile-keep
  10767. (if regionp
  10768. (delete-region (point) (+ (point) (- region-end region-start)))
  10769. (delete-region
  10770. (and (org-back-to-heading t) (point))
  10771. (min (1+ (buffer-size)) (org-end-of-subtree t t) (point)))))
  10772. (when (featurep 'org-inlinetask)
  10773. (org-inlinetask-remove-END-maybe))
  10774. (setq org-markers-to-move nil)
  10775. (message (concat actionmsg " to \"%s\" in file %s: done") (car it) file)))))))
  10776. (defun org-refile-goto-last-stored ()
  10777. "Go to the location where the last refile was stored."
  10778. (interactive)
  10779. (bookmark-jump (plist-get org-bookmark-names-plist :last-refile))
  10780. (message "This is the location of the last refile"))
  10781. (defun org-refile--get-location (refloc tbl)
  10782. "When user refile to REFLOC, find the associated target in TBL.
  10783. Also check `org-refile-target-table'."
  10784. (car (delq
  10785. nil
  10786. (mapcar
  10787. (lambda (r) (or (assoc r tbl)
  10788. (assoc r org-refile-target-table)))
  10789. (list (replace-regexp-in-string "/$" "" refloc)
  10790. (replace-regexp-in-string "\\([^/]\\)$" "\\1/" refloc))))))
  10791. (defun org-refile-get-location (&optional prompt default-buffer new-nodes
  10792. no-exclude)
  10793. "Prompt the user for a refile location, using PROMPT.
  10794. PROMPT should not be suffixed with a colon and a space, because
  10795. this function appends the default value from
  10796. `org-refile-history' automatically, if that is not empty.
  10797. When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
  10798. this is used for the GOTO interface."
  10799. (let ((org-refile-targets org-refile-targets)
  10800. (org-refile-use-outline-path org-refile-use-outline-path)
  10801. excluded-entries)
  10802. (when (and (derived-mode-p 'org-mode)
  10803. (not org-refile-use-cache)
  10804. (not no-exclude))
  10805. (org-map-tree
  10806. (lambda()
  10807. (setq excluded-entries
  10808. (append excluded-entries (list (org-get-heading t t)))))))
  10809. (setq org-refile-target-table
  10810. (org-refile-get-targets default-buffer excluded-entries)))
  10811. (unless org-refile-target-table
  10812. (user-error "No refile targets"))
  10813. (let* ((cbuf (current-buffer))
  10814. (partial-completion-mode nil)
  10815. (cfn (buffer-file-name (buffer-base-buffer cbuf)))
  10816. (cfunc (if (and org-refile-use-outline-path
  10817. org-outline-path-complete-in-steps)
  10818. 'org-olpath-completing-read
  10819. 'org-icompleting-read))
  10820. (extra (if org-refile-use-outline-path "/" ""))
  10821. (cbnex (concat (buffer-name) extra))
  10822. (filename (and cfn (expand-file-name cfn)))
  10823. (tbl (mapcar
  10824. (lambda (x)
  10825. (if (and (not (member org-refile-use-outline-path
  10826. '(file full-file-path)))
  10827. (not (equal filename (nth 1 x))))
  10828. (cons (concat (car x) extra " ("
  10829. (file-name-nondirectory (nth 1 x)) ")")
  10830. (cdr x))
  10831. (cons (concat (car x) extra) (cdr x))))
  10832. org-refile-target-table))
  10833. (completion-ignore-case t)
  10834. cdef
  10835. (prompt (concat prompt
  10836. (or (and (car org-refile-history)
  10837. (concat " (default " (car org-refile-history) ")"))
  10838. (and (assoc cbnex tbl) (setq cdef cbnex)
  10839. (concat " (default " cbnex ")"))) ": "))
  10840. pa answ parent-target child parent old-hist)
  10841. (setq old-hist org-refile-history)
  10842. (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
  10843. nil 'org-refile-history (or cdef (car org-refile-history))))
  10844. (if (setq pa (org-refile--get-location answ tbl))
  10845. (progn
  10846. (org-refile-check-position pa)
  10847. (when (or (not org-refile-history)
  10848. (not (eq old-hist org-refile-history))
  10849. (not (equal (car pa) (car org-refile-history))))
  10850. (setq org-refile-history
  10851. (cons (car pa) (if (assoc (car org-refile-history) tbl)
  10852. org-refile-history
  10853. (cdr org-refile-history))))
  10854. (if (equal (car org-refile-history) (nth 1 org-refile-history))
  10855. (pop org-refile-history)))
  10856. pa)
  10857. (if (string-match "\\`\\(.*\\)/\\([^/]+\\)\\'" answ)
  10858. (progn
  10859. (setq parent (match-string 1 answ)
  10860. child (match-string 2 answ))
  10861. (setq parent-target (org-refile--get-location parent tbl))
  10862. (when (and parent-target
  10863. (or (eq new-nodes t)
  10864. (and (eq new-nodes 'confirm)
  10865. (y-or-n-p (format "Create new node \"%s\"? "
  10866. child)))))
  10867. (org-refile-new-child parent-target child)))
  10868. (user-error "Invalid target location")))))
  10869. (declare-function org-string-nw-p "org-macs" (s))
  10870. (defun org-refile-check-position (refile-pointer)
  10871. "Check if the refile pointer matches the headline to which it points."
  10872. (let* ((file (nth 1 refile-pointer))
  10873. (re (nth 2 refile-pointer))
  10874. (pos (nth 3 refile-pointer))
  10875. buffer)
  10876. (if (and (not (markerp pos)) (not file))
  10877. (user-error "Please indicate a target file in the refile path")
  10878. (when (org-string-nw-p re)
  10879. (setq buffer (if (markerp pos)
  10880. (marker-buffer pos)
  10881. (or (find-buffer-visiting file)
  10882. (find-file-noselect file))))
  10883. (with-current-buffer buffer
  10884. (save-excursion
  10885. (save-restriction
  10886. (widen)
  10887. (goto-char pos)
  10888. (beginning-of-line 1)
  10889. (unless (org-looking-at-p re)
  10890. (user-error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling")))))))))
  10891. (defun org-refile-new-child (parent-target child)
  10892. "Use refile target PARENT-TARGET to add new CHILD below it."
  10893. (unless parent-target
  10894. (error "Cannot find parent for new node"))
  10895. (let ((file (nth 1 parent-target))
  10896. (pos (nth 3 parent-target))
  10897. level)
  10898. (with-current-buffer (or (find-buffer-visiting file)
  10899. (find-file-noselect file))
  10900. (save-excursion
  10901. (save-restriction
  10902. (widen)
  10903. (if pos
  10904. (goto-char pos)
  10905. (goto-char (point-max))
  10906. (if (not (bolp)) (newline)))
  10907. (when (looking-at org-outline-regexp)
  10908. (setq level (funcall outline-level))
  10909. (org-end-of-subtree t t))
  10910. (org-back-over-empty-lines)
  10911. (insert "\n" (make-string
  10912. (if pos (org-get-valid-level level 1) 1) ?*)
  10913. " " child "\n")
  10914. (beginning-of-line 0)
  10915. (list (concat (car parent-target) "/" child) file "" (point)))))))
  10916. (defun org-olpath-completing-read (prompt collection &rest args)
  10917. "Read an outline path like a file name."
  10918. (let ((thetable collection)
  10919. (org-completion-use-ido nil) ; does not work with ido.
  10920. (org-completion-use-iswitchb nil)) ; or iswitchb
  10921. (apply #'org-icompleting-read
  10922. prompt
  10923. (lambda (string predicate &optional flag)
  10924. (cond
  10925. ((eq flag nil) (try-completion string thetable))
  10926. ((eq flag t)
  10927. (let ((l (length string)))
  10928. (mapcar (lambda (x)
  10929. (let ((r (substring x l))
  10930. (f (if (string-match " ([^)]*)$" x)
  10931. (match-string 0 x)
  10932. "")))
  10933. (if (string-match "/" r)
  10934. (concat string (substring r 0 (match-end 0)) f)
  10935. x)))
  10936. (all-completions string thetable predicate))))
  10937. ;; Exact match?
  10938. ((eq flag 'lambda) (assoc string thetable))))
  10939. args)))
  10940. ;;;; Dynamic blocks
  10941. (defun org-find-dblock (name)
  10942. "Find the first dynamic block with name NAME in the buffer.
  10943. If not found, stay at current position and return nil."
  10944. (let ((case-fold-search t) pos)
  10945. (save-excursion
  10946. (goto-char (point-min))
  10947. (setq pos (and (re-search-forward
  10948. (concat "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+" name "\\>") nil t)
  10949. (match-beginning 0))))
  10950. (if pos (goto-char pos))
  10951. pos))
  10952. (defun org-create-dblock (plist)
  10953. "Create a dynamic block section, with parameters taken from PLIST.
  10954. PLIST must contain a :name entry which is used as the name of the block."
  10955. (when (string-match "\\S-" (buffer-substring (point-at-bol) (point-at-eol)))
  10956. (end-of-line 1)
  10957. (newline))
  10958. (let ((col (current-column))
  10959. (name (plist-get plist :name)))
  10960. (insert "#+BEGIN: " name)
  10961. (while plist
  10962. (if (eq (car plist) :name)
  10963. (setq plist (cddr plist))
  10964. (insert " " (prin1-to-string (pop plist)))))
  10965. (insert "\n\n" (make-string col ?\ ) "#+END:\n")
  10966. (beginning-of-line -2)))
  10967. (defun org-prepare-dblock ()
  10968. "Prepare dynamic block for refresh.
  10969. This empties the block, puts the cursor at the insert position and returns
  10970. the property list including an extra property :name with the block name."
  10971. (unless (looking-at org-dblock-start-re)
  10972. (user-error "Not at a dynamic block"))
  10973. (let* ((begdel (1+ (match-end 0)))
  10974. (name (org-no-properties (match-string 1)))
  10975. (params (append (list :name name)
  10976. (read (concat "(" (match-string 3) ")")))))
  10977. (save-excursion
  10978. (beginning-of-line 1)
  10979. (skip-chars-forward " \t")
  10980. (setq params (plist-put params :indentation-column (current-column))))
  10981. (unless (re-search-forward org-dblock-end-re nil t)
  10982. (error "Dynamic block not terminated"))
  10983. (setq params
  10984. (append params
  10985. (list :content (buffer-substring
  10986. begdel (match-beginning 0)))))
  10987. (delete-region begdel (match-beginning 0))
  10988. (goto-char begdel)
  10989. (open-line 1)
  10990. params))
  10991. (defun org-map-dblocks (&optional command)
  10992. "Apply COMMAND to all dynamic blocks in the current buffer.
  10993. If COMMAND is not given, use `org-update-dblock'."
  10994. (let ((cmd (or command 'org-update-dblock)))
  10995. (save-excursion
  10996. (goto-char (point-min))
  10997. (while (re-search-forward org-dblock-start-re nil t)
  10998. (goto-char (match-beginning 0))
  10999. (save-excursion
  11000. (condition-case nil
  11001. (funcall cmd)
  11002. (error (message "Error during update of dynamic block"))))
  11003. (unless (re-search-forward org-dblock-end-re nil t)
  11004. (error "Dynamic block not terminated"))))))
  11005. (defun org-dblock-update (&optional arg)
  11006. "User command for updating dynamic blocks.
  11007. Update the dynamic block at point. With prefix ARG, update all dynamic
  11008. blocks in the buffer."
  11009. (interactive "P")
  11010. (if arg
  11011. (org-update-all-dblocks)
  11012. (or (looking-at org-dblock-start-re)
  11013. (org-beginning-of-dblock))
  11014. (org-update-dblock)))
  11015. (defun org-update-dblock ()
  11016. "Update the dynamic block at point.
  11017. This means to empty the block, parse for parameters and then call
  11018. the correct writing function."
  11019. (interactive)
  11020. (save-excursion
  11021. (let* ((win (selected-window))
  11022. (pos (point))
  11023. (line (org-current-line))
  11024. (params (org-prepare-dblock))
  11025. (name (plist-get params :name))
  11026. (indent (plist-get params :indentation-column))
  11027. (cmd (intern (concat "org-dblock-write:" name))))
  11028. (message "Updating dynamic block `%s' at line %d..." name line)
  11029. (funcall cmd params)
  11030. (message "Updating dynamic block `%s' at line %d...done" name line)
  11031. (goto-char pos)
  11032. (when (and indent (> indent 0))
  11033. (setq indent (make-string indent ?\ ))
  11034. (save-excursion
  11035. (select-window win)
  11036. (org-beginning-of-dblock)
  11037. (forward-line 1)
  11038. (while (not (looking-at org-dblock-end-re))
  11039. (insert indent)
  11040. (beginning-of-line 2))
  11041. (when (looking-at org-dblock-end-re)
  11042. (and (looking-at "[ \t]+")
  11043. (replace-match ""))
  11044. (insert indent)))))))
  11045. (defun org-beginning-of-dblock ()
  11046. "Find the beginning of the dynamic block at point.
  11047. Error if there is no such block at point."
  11048. (let ((pos (point))
  11049. beg)
  11050. (end-of-line 1)
  11051. (if (and (re-search-backward org-dblock-start-re nil t)
  11052. (setq beg (match-beginning 0))
  11053. (re-search-forward org-dblock-end-re nil t)
  11054. (> (match-end 0) pos))
  11055. (goto-char beg)
  11056. (goto-char pos)
  11057. (error "Not in a dynamic block"))))
  11058. (defun org-update-all-dblocks ()
  11059. "Update all dynamic blocks in the buffer.
  11060. This function can be used in a hook."
  11061. (interactive)
  11062. (when (derived-mode-p 'org-mode)
  11063. (org-map-dblocks 'org-update-dblock)))
  11064. ;;;; Completion
  11065. (declare-function org-export-backend-name "org-export" (cl-x))
  11066. (declare-function org-export-backend-options "org-export" (cl-x))
  11067. (defun org-get-export-keywords ()
  11068. "Return a list of all currently understood export keywords.
  11069. Export keywords include options, block names, attributes and
  11070. keywords relative to each registered export back-end."
  11071. (let (keywords)
  11072. (dolist (backend
  11073. (org-bound-and-true-p org-export-registered-backends)
  11074. (delq nil keywords))
  11075. ;; Back-end name (for keywords, like #+LATEX:)
  11076. (push (upcase (symbol-name (org-export-backend-name backend))) keywords)
  11077. (dolist (option-entry (org-export-backend-options backend))
  11078. ;; Back-end options.
  11079. (push (nth 1 option-entry) keywords)))))
  11080. (defconst org-options-keywords
  11081. '("ARCHIVE:" "AUTHOR:" "BIND:" "CATEGORY:" "COLUMNS:" "CREATOR:" "DATE:"
  11082. "DESCRIPTION:" "DRAWERS:" "EMAIL:" "EXCLUDE_TAGS:" "FILETAGS:" "INCLUDE:"
  11083. "INDEX:" "KEYWORDS:" "LANGUAGE:" "MACRO:" "OPTIONS:" "PROPERTY:"
  11084. "PRIORITIES:" "SELECT_TAGS:" "SEQ_TODO:" "SETUPFILE:" "STARTUP:" "TAGS:"
  11085. "TITLE:" "TODO:" "TYP_TODO:" "SELECT_TAGS:" "EXCLUDE_TAGS:"))
  11086. (defcustom org-structure-template-alist
  11087. '(("s" "#+BEGIN_SRC ?\n\n#+END_SRC")
  11088. ("e" "#+BEGIN_EXAMPLE\n?\n#+END_EXAMPLE")
  11089. ("q" "#+BEGIN_QUOTE\n?\n#+END_QUOTE")
  11090. ("v" "#+BEGIN_VERSE\n?\n#+END_VERSE")
  11091. ("V" "#+BEGIN_VERBATIM\n?\n#+END_VERBATIM")
  11092. ("c" "#+BEGIN_CENTER\n?\n#+END_CENTER")
  11093. ("l" "#+BEGIN_LaTeX\n?\n#+END_LaTeX")
  11094. ("L" "#+LaTeX: ")
  11095. ("h" "#+BEGIN_HTML\n?\n#+END_HTML")
  11096. ("H" "#+HTML: ")
  11097. ("a" "#+BEGIN_ASCII\n?\n#+END_ASCII")
  11098. ("A" "#+ASCII: ")
  11099. ("i" "#+INDEX: ?")
  11100. ("I" "#+INCLUDE: %file ?"))
  11101. "Structure completion elements.
  11102. This is a list of abbreviation keys and values. The value gets inserted
  11103. if you type `<' followed by the key and then press the completion key,
  11104. usually `TAB'. %file will be replaced by a file name after prompting
  11105. for the file using completion. The cursor will be placed at the position
  11106. of the `?` in the template.
  11107. There are two templates for each key, the first uses the original Org syntax,
  11108. the second uses Emacs Muse-like syntax tags. These Muse-like tags become
  11109. the default when the /org-mtags.el/ module has been loaded. See also the
  11110. variable `org-mtags-prefer-muse-templates'."
  11111. :group 'org-completion
  11112. :type '(repeat
  11113. (list
  11114. (string :tag "Key")
  11115. (string :tag "Template")))
  11116. :version "25.1"
  11117. :package-version '(Org . "8.3"))
  11118. (defun org-try-structure-completion ()
  11119. "Try to complete a structure template before point.
  11120. This looks for strings like \"<e\" on an otherwise empty line and
  11121. expands them."
  11122. (let ((l (buffer-substring (point-at-bol) (point)))
  11123. a)
  11124. (when (and (looking-at "[ \t]*$")
  11125. (string-match "^[ \t]*<\\([a-zA-Z]+\\)$" l)
  11126. (setq a (assoc (match-string 1 l) org-structure-template-alist)))
  11127. (org-complete-expand-structure-template (+ -1 (point-at-bol)
  11128. (match-beginning 1)) a)
  11129. t)))
  11130. (defun org-complete-expand-structure-template (start cell)
  11131. "Expand a structure template."
  11132. (let ((rpl (nth 1 cell))
  11133. (ind ""))
  11134. (delete-region start (point))
  11135. (when (string-match "\\`[ \t]*#\\+" rpl)
  11136. (cond
  11137. ((bolp))
  11138. ((not (string-match "\\S-" (buffer-substring (point-at-bol) (point))))
  11139. (setq ind (buffer-substring (point-at-bol) (point))))
  11140. (t (newline))))
  11141. (setq start (point))
  11142. (if (string-match "%file" rpl)
  11143. (setq rpl (replace-match
  11144. (concat
  11145. "\""
  11146. (save-match-data
  11147. (abbreviate-file-name (read-file-name "Include file: ")))
  11148. "\"")
  11149. t t rpl)))
  11150. (setq rpl (mapconcat 'identity (split-string rpl "\n")
  11151. (concat "\n" ind)))
  11152. (insert rpl)
  11153. (if (re-search-backward "\\?" start t) (delete-char 1))))
  11154. ;;;; TODO, DEADLINE, Comments
  11155. (defun org-toggle-comment ()
  11156. "Change the COMMENT state of an entry."
  11157. (interactive)
  11158. (save-excursion
  11159. (org-back-to-heading)
  11160. (looking-at org-complex-heading-regexp)
  11161. (goto-char (or (match-end 3) (match-end 2) (match-end 1)))
  11162. (skip-chars-forward " \t")
  11163. (unless (memq (char-before) '(?\s ?\t)) (insert " "))
  11164. (if (org-in-commented-heading-p t)
  11165. (delete-region (point)
  11166. (progn (search-forward " " (line-end-position) 'move)
  11167. (skip-chars-forward " \t")
  11168. (point)))
  11169. (insert org-comment-string)
  11170. (unless (eolp) (insert " ")))))
  11171. (defvar org-last-todo-state-is-todo nil
  11172. "This is non-nil when the last TODO state change led to a TODO state.
  11173. If the last change removed the TODO tag or switched to DONE, then
  11174. this is nil.")
  11175. (defvar org-setting-tags nil) ; dynamically skipped
  11176. (defvar org-todo-setup-filter-hook nil
  11177. "Hook for functions that pre-filter todo specs.
  11178. Each function takes a todo spec and returns either nil or the spec
  11179. transformed into canonical form." )
  11180. (defvar org-todo-get-default-hook nil
  11181. "Hook for functions that get a default item for todo.
  11182. Each function takes arguments (NEW-MARK OLD-MARK) and returns either
  11183. nil or a string to be used for the todo mark." )
  11184. (defvar org-agenda-headline-snapshot-before-repeat)
  11185. (defun org-current-effective-time ()
  11186. "Return current time adjusted for `org-extend-today-until' variable."
  11187. (let* ((ct (org-current-time))
  11188. (dct (decode-time ct))
  11189. (ct1
  11190. (cond
  11191. (org-use-last-clock-out-time-as-effective-time
  11192. (or (org-clock-get-last-clock-out-time) ct))
  11193. ((and org-use-effective-time (< (nth 2 dct) org-extend-today-until))
  11194. (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct)))
  11195. (t ct))))
  11196. ct1))
  11197. (defun org-todo-yesterday (&optional arg)
  11198. "Like `org-todo' but the time of change will be 23:59 of yesterday."
  11199. (interactive "P")
  11200. (if (eq major-mode 'org-agenda-mode)
  11201. (apply 'org-agenda-todo-yesterday arg)
  11202. (let* ((org-use-effective-time t)
  11203. (hour (third (decode-time
  11204. (org-current-time))))
  11205. (org-extend-today-until (1+ hour)))
  11206. (org-todo arg))))
  11207. (defvar org-block-entry-blocking ""
  11208. "First entry preventing the TODO state change.")
  11209. (defun org-cancel-repeater ()
  11210. "Cancel a repeater by setting its numeric value to zero."
  11211. (interactive)
  11212. (save-excursion
  11213. (org-back-to-heading t)
  11214. (let ((bound1 (point))
  11215. (bound0 (save-excursion (outline-next-heading) (point))))
  11216. (when (re-search-forward
  11217. (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
  11218. org-deadline-time-regexp "\\)\\|\\("
  11219. org-ts-regexp "\\)")
  11220. bound0 t)
  11221. (if (re-search-backward "[ \t]+\\(?:[.+]\\)?\\+\\([0-9]+\\)[hdwmy]" bound1 t)
  11222. (replace-match "0" t nil nil 1))))))
  11223. (defun org-todo (&optional arg)
  11224. "Change the TODO state of an item.
  11225. The state of an item is given by a keyword at the start of the heading,
  11226. like
  11227. *** TODO Write paper
  11228. *** DONE Call mom
  11229. The different keywords are specified in the variable `org-todo-keywords'.
  11230. By default the available states are \"TODO\" and \"DONE\".
  11231. So for this example: when the item starts with TODO, it is changed to DONE.
  11232. When it starts with DONE, the DONE is removed. And when neither TODO nor
  11233. DONE are present, add TODO at the beginning of the heading.
  11234. With \\[universal-argument] prefix arg, use completion to determine the new \
  11235. state.
  11236. With numeric prefix arg, switch to that state.
  11237. With a double \\[universal-argument] prefix, switch to the next set of TODO \
  11238. keywords (nextset).
  11239. With a triple \\[universal-argument] prefix, circumvent any state blocking.
  11240. With a numeric prefix arg of 0, inhibit note taking for the change.
  11241. With a numeric prefix arg of -1, cancel repeater to allow marking as DONE.
  11242. When called through ELisp, arg is also interpreted in the following way:
  11243. 'none -> empty state
  11244. \"\"(empty string) -> switch to empty state
  11245. 'done -> switch to DONE
  11246. 'nextset -> switch to the next set of keywords
  11247. 'previousset -> switch to the previous set of keywords
  11248. \"WAITING\" -> switch to the specified keyword, but only if it
  11249. really is a member of `org-todo-keywords'."
  11250. (interactive "P")
  11251. (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
  11252. (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
  11253. 'region-start-level 'region))
  11254. org-loop-over-headlines-in-active-region)
  11255. (org-map-entries
  11256. `(org-todo ,arg)
  11257. org-loop-over-headlines-in-active-region
  11258. cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
  11259. (if (equal arg '(16)) (setq arg 'nextset))
  11260. (when (equal arg -1) (org-cancel-repeater) (setq arg nil))
  11261. (let ((org-blocker-hook org-blocker-hook)
  11262. commentp
  11263. case-fold-search)
  11264. (when (equal arg '(64))
  11265. (setq arg nil org-blocker-hook nil))
  11266. (when (and org-blocker-hook
  11267. (or org-inhibit-blocking
  11268. (org-entry-get nil "NOBLOCKING")))
  11269. (setq org-blocker-hook nil))
  11270. (save-excursion
  11271. (catch 'exit
  11272. (org-back-to-heading t)
  11273. (when (org-in-commented-heading-p t)
  11274. (org-toggle-comment)
  11275. (setq commentp t))
  11276. (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
  11277. (or (looking-at (concat " +" org-todo-regexp "\\( +\\|[ \t]*$\\)"))
  11278. (looking-at "\\(?: *\\|[ \t]*$\\)"))
  11279. (let* ((match-data (match-data))
  11280. (startpos (point-at-bol))
  11281. (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
  11282. (org-log-done org-log-done)
  11283. (org-log-repeat org-log-repeat)
  11284. (org-todo-log-states org-todo-log-states)
  11285. (org-inhibit-logging
  11286. (if (equal arg 0)
  11287. (progn (setq arg nil) 'note) org-inhibit-logging))
  11288. (this (match-string 1))
  11289. (hl-pos (match-beginning 0))
  11290. (head (org-get-todo-sequence-head this))
  11291. (ass (assoc head org-todo-kwd-alist))
  11292. (interpret (nth 1 ass))
  11293. (done-word (nth 3 ass))
  11294. (final-done-word (nth 4 ass))
  11295. (org-last-state (or this ""))
  11296. (completion-ignore-case t)
  11297. (member (member this org-todo-keywords-1))
  11298. (tail (cdr member))
  11299. (org-state (cond
  11300. ((and org-todo-key-trigger
  11301. (or (and (equal arg '(4))
  11302. (eq org-use-fast-todo-selection 'prefix))
  11303. (and (not arg) org-use-fast-todo-selection
  11304. (not (eq org-use-fast-todo-selection
  11305. 'prefix)))))
  11306. ;; Use fast selection
  11307. (org-fast-todo-selection))
  11308. ((and (equal arg '(4))
  11309. (or (not org-use-fast-todo-selection)
  11310. (not org-todo-key-trigger)))
  11311. ;; Read a state with completion
  11312. (org-icompleting-read
  11313. "State: " (mapcar 'list org-todo-keywords-1)
  11314. nil t))
  11315. ((eq arg 'right)
  11316. (if this
  11317. (if tail (car tail) nil)
  11318. (car org-todo-keywords-1)))
  11319. ((eq arg 'left)
  11320. (if (equal member org-todo-keywords-1)
  11321. nil
  11322. (if this
  11323. (nth (- (length org-todo-keywords-1)
  11324. (length tail) 2)
  11325. org-todo-keywords-1)
  11326. (org-last org-todo-keywords-1))))
  11327. ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
  11328. (setq arg nil))) ; hack to fall back to cycling
  11329. (arg
  11330. ;; user or caller requests a specific state
  11331. (cond
  11332. ((equal arg "") nil)
  11333. ((eq arg 'none) nil)
  11334. ((eq arg 'done) (or done-word (car org-done-keywords)))
  11335. ((eq arg 'nextset)
  11336. (or (car (cdr (member head org-todo-heads)))
  11337. (car org-todo-heads)))
  11338. ((eq arg 'previousset)
  11339. (let ((org-todo-heads (reverse org-todo-heads)))
  11340. (or (car (cdr (member head org-todo-heads)))
  11341. (car org-todo-heads))))
  11342. ((car (member arg org-todo-keywords-1)))
  11343. ((stringp arg)
  11344. (user-error "State `%s' not valid in this file" arg))
  11345. ((nth (1- (prefix-numeric-value arg))
  11346. org-todo-keywords-1))))
  11347. ((null member) (or head (car org-todo-keywords-1)))
  11348. ((equal this final-done-word) nil) ;; -> make empty
  11349. ((null tail) nil) ;; -> first entry
  11350. ((memq interpret '(type priority))
  11351. (if (eq this-command last-command)
  11352. (car tail)
  11353. (if (> (length tail) 0)
  11354. (or done-word (car org-done-keywords))
  11355. nil)))
  11356. (t
  11357. (car tail))))
  11358. (org-state (or
  11359. (run-hook-with-args-until-success
  11360. 'org-todo-get-default-hook org-state org-last-state)
  11361. org-state))
  11362. (next (if org-state (concat " " org-state " ") " "))
  11363. (change-plist (list :type 'todo-state-change :from this :to org-state
  11364. :position startpos))
  11365. dolog now-done-p)
  11366. (when org-blocker-hook
  11367. (setq org-last-todo-state-is-todo
  11368. (not (member this org-done-keywords)))
  11369. (unless (save-excursion
  11370. (save-match-data
  11371. (org-with-wide-buffer
  11372. (run-hook-with-args-until-failure
  11373. 'org-blocker-hook change-plist))))
  11374. (if (org-called-interactively-p 'interactive)
  11375. (user-error "TODO state change from %s to %s blocked (by \"%s\")"
  11376. this org-state org-block-entry-blocking)
  11377. ;; fail silently
  11378. (message "TODO state change from %s to %s blocked (by \"%s\")"
  11379. this org-state org-block-entry-blocking)
  11380. (throw 'exit nil))))
  11381. (store-match-data match-data)
  11382. (replace-match next t t)
  11383. (cond ((equal this org-state)
  11384. (message "TODO state was already %s" (org-trim next)))
  11385. ((pos-visible-in-window-p hl-pos)
  11386. (message "TODO state changed to %s" (org-trim next))))
  11387. (unless head
  11388. (setq head (org-get-todo-sequence-head org-state)
  11389. ass (assoc head org-todo-kwd-alist)
  11390. interpret (nth 1 ass)
  11391. done-word (nth 3 ass)
  11392. final-done-word (nth 4 ass)))
  11393. (when (memq arg '(nextset previousset))
  11394. (message "Keyword-Set %d/%d: %s"
  11395. (- (length org-todo-sets) -1
  11396. (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
  11397. (length org-todo-sets)
  11398. (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
  11399. (setq org-last-todo-state-is-todo
  11400. (not (member org-state org-done-keywords)))
  11401. (setq now-done-p (and (member org-state org-done-keywords)
  11402. (not (member this org-done-keywords))))
  11403. (and logging (org-local-logging logging))
  11404. (when (and (or org-todo-log-states org-log-done)
  11405. (not (eq org-inhibit-logging t))
  11406. (not (memq arg '(nextset previousset))))
  11407. ;; we need to look at recording a time and note
  11408. (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
  11409. (nth 2 (assoc this org-todo-log-states))))
  11410. (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
  11411. (setq dolog 'time))
  11412. (when (or (and (not org-state) (not org-closed-keep-when-no-todo))
  11413. (and org-state
  11414. (member org-state org-not-done-keywords)
  11415. (not (member this org-not-done-keywords))))
  11416. ;; This is now a todo state and was not one before
  11417. ;; If there was a CLOSED time stamp, get rid of it.
  11418. (org-add-planning-info nil nil 'closed))
  11419. (when (and now-done-p org-log-done)
  11420. ;; It is now done, and it was not done before
  11421. (org-add-planning-info 'closed (org-current-effective-time))
  11422. (if (and (not dolog) (eq 'note org-log-done))
  11423. (org-add-log-setup 'done org-state this 'findpos 'note)))
  11424. (when (and org-state dolog)
  11425. ;; This is a non-nil state, and we need to log it
  11426. (org-add-log-setup 'state org-state this 'findpos dolog)))
  11427. ;; Fixup tag positioning
  11428. (org-todo-trigger-tag-changes org-state)
  11429. (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
  11430. (when org-provide-todo-statistics
  11431. (org-update-parent-todo-statistics))
  11432. (run-hooks 'org-after-todo-state-change-hook)
  11433. (if (and arg (not (member org-state org-done-keywords)))
  11434. (setq head (org-get-todo-sequence-head org-state)))
  11435. (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
  11436. ;; Do we need to trigger a repeat?
  11437. (when now-done-p
  11438. (when (boundp 'org-agenda-headline-snapshot-before-repeat)
  11439. ;; This is for the agenda, take a snapshot of the headline.
  11440. (save-match-data
  11441. (setq org-agenda-headline-snapshot-before-repeat
  11442. (org-get-heading))))
  11443. (org-auto-repeat-maybe org-state))
  11444. ;; Fixup cursor location if close to the keyword
  11445. (if (and (outline-on-heading-p)
  11446. (not (bolp))
  11447. (save-excursion (beginning-of-line 1)
  11448. (looking-at org-todo-line-regexp))
  11449. (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
  11450. (progn
  11451. (goto-char (or (match-end 2) (match-end 1)))
  11452. (and (looking-at " ") (just-one-space))))
  11453. (when org-trigger-hook
  11454. (save-excursion
  11455. (run-hook-with-args 'org-trigger-hook change-plist)))
  11456. (when commentp (org-toggle-comment))))))))
  11457. (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
  11458. "Block turning an entry into a TODO, using the hierarchy.
  11459. This checks whether the current task should be blocked from state
  11460. changes. Such blocking occurs when:
  11461. 1. The task has children which are not all in a completed state.
  11462. 2. A task has a parent with the property :ORDERED:, and there
  11463. are siblings prior to the current task with incomplete
  11464. status.
  11465. 3. The parent of the task is blocked because it has siblings that should
  11466. be done first, or is child of a block grandparent TODO entry."
  11467. (if (not org-enforce-todo-dependencies)
  11468. t ; if locally turned off don't block
  11469. (catch 'dont-block
  11470. ;; If this is not a todo state change, or if this entry is already DONE,
  11471. ;; do not block
  11472. (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
  11473. (member (plist-get change-plist :from)
  11474. (cons 'done org-done-keywords))
  11475. (member (plist-get change-plist :to)
  11476. (cons 'todo org-not-done-keywords))
  11477. (not (plist-get change-plist :to)))
  11478. (throw 'dont-block t))
  11479. ;; If this task has children, and any are undone, it's blocked
  11480. (save-excursion
  11481. (org-back-to-heading t)
  11482. (let ((this-level (funcall outline-level)))
  11483. (outline-next-heading)
  11484. (let ((child-level (funcall outline-level)))
  11485. (while (and (not (eobp))
  11486. (> child-level this-level))
  11487. ;; this todo has children, check whether they are all
  11488. ;; completed
  11489. (if (and (not (org-entry-is-done-p))
  11490. (org-entry-is-todo-p))
  11491. (progn (setq org-block-entry-blocking (org-get-heading))
  11492. (throw 'dont-block nil)))
  11493. (outline-next-heading)
  11494. (setq child-level (funcall outline-level))))))
  11495. ;; Otherwise, if the task's parent has the :ORDERED: property, and
  11496. ;; any previous siblings are undone, it's blocked
  11497. (save-excursion
  11498. (org-back-to-heading t)
  11499. (let* ((pos (point))
  11500. (parent-pos (and (org-up-heading-safe) (point))))
  11501. (if (not parent-pos) (throw 'dont-block t)) ; no parent
  11502. (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
  11503. (forward-line 1)
  11504. (re-search-forward org-not-done-heading-regexp pos t))
  11505. (setq org-block-entry-blocking (match-string 0))
  11506. (throw 'dont-block nil)) ; block, there is an older sibling not done.
  11507. ;; Search further up the hierarchy, to see if an ancestor is blocked
  11508. (while t
  11509. (goto-char parent-pos)
  11510. (if (not (looking-at org-not-done-heading-regexp))
  11511. (throw 'dont-block t)) ; do not block, parent is not a TODO
  11512. (setq pos (point))
  11513. (setq parent-pos (and (org-up-heading-safe) (point)))
  11514. (if (not parent-pos) (throw 'dont-block t)) ; no parent
  11515. (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
  11516. (forward-line 1)
  11517. (re-search-forward org-not-done-heading-regexp pos t)
  11518. (setq org-block-entry-blocking (org-get-heading)))
  11519. (throw 'dont-block nil)))))))) ; block, older sibling not done.
  11520. (defcustom org-track-ordered-property-with-tag nil
  11521. "Should the ORDERED property also be shown as a tag?
  11522. The ORDERED property decides if an entry should require subtasks to be
  11523. completed in sequence. Since a property is not very visible, setting
  11524. this option means that toggling the ORDERED property with the command
  11525. `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
  11526. not relevant for the behavior, but it makes things more visible.
  11527. Note that toggling the tag with tags commands will not change the property
  11528. and therefore not influence behavior!
  11529. This can be t, meaning the tag ORDERED should be used, It can also be a
  11530. string to select a different tag for this task."
  11531. :group 'org-todo
  11532. :type '(choice
  11533. (const :tag "No tracking" nil)
  11534. (const :tag "Track with ORDERED tag" t)
  11535. (string :tag "Use other tag")))
  11536. (defun org-toggle-ordered-property ()
  11537. "Toggle the ORDERED property of the current entry.
  11538. For better visibility, you can track the value of this property with a tag.
  11539. See variable `org-track-ordered-property-with-tag'."
  11540. (interactive)
  11541. (let* ((t1 org-track-ordered-property-with-tag)
  11542. (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
  11543. (save-excursion
  11544. (org-back-to-heading)
  11545. (if (org-entry-get nil "ORDERED")
  11546. (progn
  11547. (org-delete-property "ORDERED")
  11548. (and tag (org-toggle-tag tag 'off))
  11549. (message "Subtasks can be completed in arbitrary order"))
  11550. (org-entry-put nil "ORDERED" "t")
  11551. (and tag (org-toggle-tag tag 'on))
  11552. (message "Subtasks must be completed in sequence")))))
  11553. (defvar org-blocked-by-checkboxes) ; dynamically scoped
  11554. (defun org-block-todo-from-checkboxes (change-plist)
  11555. "Block turning an entry into a TODO, using checkboxes.
  11556. This checks whether the current task should be blocked from state
  11557. changes because there are unchecked boxes in this entry."
  11558. (if (not org-enforce-todo-checkbox-dependencies)
  11559. t ; if locally turned off don't block
  11560. (catch 'dont-block
  11561. ;; If this is not a todo state change, or if this entry is already DONE,
  11562. ;; do not block
  11563. (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
  11564. (member (plist-get change-plist :from)
  11565. (cons 'done org-done-keywords))
  11566. (member (plist-get change-plist :to)
  11567. (cons 'todo org-not-done-keywords))
  11568. (not (plist-get change-plist :to)))
  11569. (throw 'dont-block t))
  11570. ;; If this task has checkboxes that are not checked, it's blocked
  11571. (save-excursion
  11572. (org-back-to-heading t)
  11573. (let ((beg (point)) end)
  11574. (outline-next-heading)
  11575. (setq end (point))
  11576. (goto-char beg)
  11577. (if (org-list-search-forward
  11578. (concat (org-item-beginning-re)
  11579. "\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?"
  11580. "\\[[- ]\\]")
  11581. end t)
  11582. (progn
  11583. (if (boundp 'org-blocked-by-checkboxes)
  11584. (setq org-blocked-by-checkboxes t))
  11585. (throw 'dont-block nil)))))
  11586. t))) ; do not block
  11587. (defun org-entry-blocked-p ()
  11588. "Is the current entry blocked?"
  11589. (org-with-silent-modifications
  11590. (if (org-entry-get nil "NOBLOCKING")
  11591. nil ;; Never block this entry
  11592. (not (run-hook-with-args-until-failure
  11593. 'org-blocker-hook
  11594. (list :type 'todo-state-change
  11595. :position (point)
  11596. :from 'todo
  11597. :to 'done))))))
  11598. (defun org-update-statistics-cookies (all)
  11599. "Update the statistics cookie, either from TODO or from checkboxes.
  11600. This should be called with the cursor in a line with a statistics cookie."
  11601. (interactive "P")
  11602. (if all
  11603. (progn
  11604. (org-update-checkbox-count 'all)
  11605. (org-map-entries 'org-update-parent-todo-statistics))
  11606. (if (not (org-at-heading-p))
  11607. (org-update-checkbox-count)
  11608. (let ((pos (point-marker))
  11609. end l1 l2)
  11610. (ignore-errors (org-back-to-heading t))
  11611. (if (not (org-at-heading-p))
  11612. (org-update-checkbox-count)
  11613. (setq l1 (org-outline-level))
  11614. (setq end (save-excursion
  11615. (outline-next-heading)
  11616. (if (org-at-heading-p) (setq l2 (org-outline-level)))
  11617. (point)))
  11618. (if (and (save-excursion
  11619. (re-search-forward
  11620. "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) \\[[- X]\\]" end t))
  11621. (not (save-excursion (re-search-forward
  11622. ":COOKIE_DATA:.*\\<todo\\>" end t))))
  11623. (org-update-checkbox-count)
  11624. (if (and l2 (> l2 l1))
  11625. (progn
  11626. (goto-char end)
  11627. (org-update-parent-todo-statistics))
  11628. (goto-char pos)
  11629. (beginning-of-line 1)
  11630. (while (re-search-forward
  11631. "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)"
  11632. (point-at-eol) t)
  11633. (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
  11634. (goto-char pos)
  11635. (move-marker pos nil)))))
  11636. (defvar org-entry-property-inherited-from) ;; defined below
  11637. (defun org-update-parent-todo-statistics ()
  11638. "Update any statistics cookie in the parent of the current headline.
  11639. When `org-hierarchical-todo-statistics' is nil, statistics will cover
  11640. the entire subtree and this will travel up the hierarchy and update
  11641. statistics everywhere."
  11642. (let* ((prop (save-excursion (org-up-heading-safe)
  11643. (org-entry-get nil "COOKIE_DATA" 'inherit)))
  11644. (recursive (or (not org-hierarchical-todo-statistics)
  11645. (and prop (string-match "\\<recursive\\>" prop))))
  11646. (lim (or (and prop (marker-position org-entry-property-inherited-from))
  11647. 0))
  11648. (first t)
  11649. (box-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
  11650. level ltoggle l1 new ndel
  11651. (cnt-all 0) (cnt-done 0) is-percent kwd
  11652. checkbox-beg ov ovs ove cookie-present)
  11653. (catch 'exit
  11654. (save-excursion
  11655. (beginning-of-line 1)
  11656. (setq ltoggle (funcall outline-level))
  11657. ;; Three situations are to consider:
  11658. ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
  11659. ;; to the top-level ancestor on the headline;
  11660. ;; 2. If parent has "recursive" property, repeat up to the
  11661. ;; headline setting that property, taking inheritance into
  11662. ;; account;
  11663. ;; 3. Else, move up to direct parent and proceed only once.
  11664. (while (and (setq level (org-up-heading-safe))
  11665. (or recursive first)
  11666. (>= (point) lim))
  11667. (setq first nil cookie-present nil)
  11668. (unless (and level
  11669. (not (string-match
  11670. "\\<checkbox\\>"
  11671. (downcase (or (org-entry-get nil "COOKIE_DATA")
  11672. "")))))
  11673. (throw 'exit nil))
  11674. (while (re-search-forward box-re (point-at-eol) t)
  11675. (setq cnt-all 0 cnt-done 0 cookie-present t)
  11676. (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
  11677. (save-match-data
  11678. (unless (outline-next-heading) (throw 'exit nil))
  11679. (while (and (looking-at org-complex-heading-regexp)
  11680. (> (setq l1 (length (match-string 1))) level))
  11681. (setq kwd (and (or recursive (= l1 ltoggle))
  11682. (match-string 2)))
  11683. (if (or (eq org-provide-todo-statistics 'all-headlines)
  11684. (and (eq org-provide-todo-statistics t)
  11685. (or (member kwd org-done-keywords)))
  11686. (and (listp org-provide-todo-statistics)
  11687. (stringp (car org-provide-todo-statistics))
  11688. (or (member kwd org-provide-todo-statistics)
  11689. (member kwd org-done-keywords)))
  11690. (and (listp org-provide-todo-statistics)
  11691. (listp (car org-provide-todo-statistics))
  11692. (or (member kwd (car org-provide-todo-statistics))
  11693. (and (member kwd org-done-keywords)
  11694. (member kwd (cadr org-provide-todo-statistics))))))
  11695. (setq cnt-all (1+ cnt-all))
  11696. (if (eq org-provide-todo-statistics t)
  11697. (and kwd (setq cnt-all (1+ cnt-all)))))
  11698. (when (or (and (member org-provide-todo-statistics '(t all-headlines))
  11699. (member kwd org-done-keywords))
  11700. (and (listp org-provide-todo-statistics)
  11701. (listp (car org-provide-todo-statistics))
  11702. (member kwd org-done-keywords)
  11703. (member kwd (cadr org-provide-todo-statistics)))
  11704. (and (listp org-provide-todo-statistics)
  11705. (stringp (car org-provide-todo-statistics))
  11706. (member kwd org-done-keywords)))
  11707. (setq cnt-done (1+ cnt-done)))
  11708. (outline-next-heading)))
  11709. (setq new
  11710. (if is-percent
  11711. (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
  11712. (format "[%d/%d]" cnt-done cnt-all))
  11713. ndel (- (match-end 0) checkbox-beg))
  11714. ;; handle overlays when updating cookie from column view
  11715. (when (setq ov (car (overlays-at checkbox-beg)))
  11716. (setq ovs (overlay-start ov) ove (overlay-end ov))
  11717. (delete-overlay ov))
  11718. (goto-char checkbox-beg)
  11719. (insert new)
  11720. (delete-region (point) (+ (point) ndel))
  11721. (when org-auto-align-tags (org-fix-tags-on-the-fly))
  11722. (when ov (move-overlay ov ovs ove)))
  11723. (when cookie-present
  11724. (run-hook-with-args 'org-after-todo-statistics-hook
  11725. cnt-done (- cnt-all cnt-done))))))
  11726. (run-hooks 'org-todo-statistics-hook)))
  11727. (defvar org-after-todo-statistics-hook nil
  11728. "Hook that is called after a TODO statistics cookie has been updated.
  11729. Each function is called with two arguments: the number of not-done entries
  11730. and the number of done entries.
  11731. For example, the following function, when added to this hook, will switch
  11732. an entry to DONE when all children are done, and back to TODO when new
  11733. entries are set to a TODO status. Note that this hook is only called
  11734. when there is a statistics cookie in the headline!
  11735. (defun org-summary-todo (n-done n-not-done)
  11736. \"Switch entry to DONE when all subentries are done, to TODO otherwise.\"
  11737. (let (org-log-done org-log-states) ; turn off logging
  11738. (org-todo (if (= n-not-done 0) \"DONE\" \"TODO\"))))
  11739. ")
  11740. (defvar org-todo-statistics-hook nil
  11741. "Hook that is run whenever Org thinks TODO statistics should be updated.
  11742. This hook runs even if there is no statistics cookie present, in which case
  11743. `org-after-todo-statistics-hook' would not run.")
  11744. (defun org-todo-trigger-tag-changes (state)
  11745. "Apply the changes defined in `org-todo-state-tags-triggers'."
  11746. (let ((l org-todo-state-tags-triggers)
  11747. changes)
  11748. (when (or (not state) (equal state ""))
  11749. (setq changes (append changes (cdr (assoc "" l)))))
  11750. (when (and (stringp state) (> (length state) 0))
  11751. (setq changes (append changes (cdr (assoc state l)))))
  11752. (when (member state org-not-done-keywords)
  11753. (setq changes (append changes (cdr (assoc 'todo l)))))
  11754. (when (member state org-done-keywords)
  11755. (setq changes (append changes (cdr (assoc 'done l)))))
  11756. (dolist (c changes)
  11757. (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
  11758. (defun org-local-logging (value)
  11759. "Get logging settings from a property VALUE."
  11760. (let* (words w a)
  11761. ;; directly set the variables, they are already local.
  11762. (setq org-log-done nil
  11763. org-log-repeat nil
  11764. org-todo-log-states nil)
  11765. (setq words (org-split-string value))
  11766. (while (setq w (pop words))
  11767. (cond
  11768. ((setq a (assoc w org-startup-options))
  11769. (and (member (nth 1 a) '(org-log-done org-log-repeat))
  11770. (set (nth 1 a) (nth 2 a))))
  11771. ((setq a (org-extract-log-state-settings w))
  11772. (and (member (car a) org-todo-keywords-1)
  11773. (push a org-todo-log-states)))))))
  11774. (defun org-get-todo-sequence-head (kwd)
  11775. "Return the head of the TODO sequence to which KWD belongs.
  11776. If KWD is not set, check if there is a text property remembering the
  11777. right sequence."
  11778. (let (p)
  11779. (cond
  11780. ((not kwd)
  11781. (or (get-text-property (point-at-bol) 'org-todo-head)
  11782. (progn
  11783. (setq p (next-single-property-change (point-at-bol) 'org-todo-head
  11784. nil (point-at-eol)))
  11785. (get-text-property p 'org-todo-head))))
  11786. ((not (member kwd org-todo-keywords-1))
  11787. (car org-todo-keywords-1))
  11788. (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
  11789. (defun org-fast-todo-selection ()
  11790. "Fast TODO keyword selection with single keys.
  11791. Returns the new TODO keyword, or nil if no state change should occur."
  11792. (let* ((fulltable org-todo-key-alist)
  11793. (done-keywords org-done-keywords) ;; needed for the faces.
  11794. (maxlen (apply 'max (mapcar
  11795. (lambda (x)
  11796. (if (stringp (car x)) (string-width (car x)) 0))
  11797. fulltable)))
  11798. (expert nil)
  11799. (fwidth (+ maxlen 3 1 3))
  11800. (ncol (/ (- (window-width) 4) fwidth))
  11801. tg cnt e c tbl
  11802. groups ingroup)
  11803. (save-excursion
  11804. (save-window-excursion
  11805. (if expert
  11806. (set-buffer (get-buffer-create " *Org todo*"))
  11807. (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
  11808. (erase-buffer)
  11809. (org-set-local 'org-done-keywords done-keywords)
  11810. (setq tbl fulltable cnt 0)
  11811. (while (setq e (pop tbl))
  11812. (cond
  11813. ((equal e '(:startgroup))
  11814. (push '() groups) (setq ingroup t)
  11815. (when (not (= cnt 0))
  11816. (setq cnt 0)
  11817. (insert "\n"))
  11818. (insert "{ "))
  11819. ((equal e '(:endgroup))
  11820. (setq ingroup nil cnt 0)
  11821. (insert "}\n"))
  11822. ((equal e '(:newline))
  11823. (when (not (= cnt 0))
  11824. (setq cnt 0)
  11825. (insert "\n")
  11826. (setq e (car tbl))
  11827. (while (equal (car tbl) '(:newline))
  11828. (insert "\n")
  11829. (setq tbl (cdr tbl)))))
  11830. (t
  11831. (setq tg (car e) c (cdr e))
  11832. (if ingroup (push tg (car groups)))
  11833. (setq tg (org-add-props tg nil 'face
  11834. (org-get-todo-face tg)))
  11835. (if (and (= cnt 0) (not ingroup)) (insert " "))
  11836. (insert "[" c "] " tg (make-string
  11837. (- fwidth 4 (length tg)) ?\ ))
  11838. (when (= (setq cnt (1+ cnt)) ncol)
  11839. (insert "\n")
  11840. (if ingroup (insert " "))
  11841. (setq cnt 0)))))
  11842. (insert "\n")
  11843. (goto-char (point-min))
  11844. (if (not expert) (org-fit-window-to-buffer))
  11845. (message "[a-z..]:Set [SPC]:clear")
  11846. (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
  11847. (cond
  11848. ((or (= c ?\C-g)
  11849. (and (= c ?q) (not (rassoc c fulltable))))
  11850. (setq quit-flag t))
  11851. ((= c ?\ ) nil)
  11852. ((setq e (rassoc c fulltable) tg (car e))
  11853. tg)
  11854. (t (setq quit-flag t)))))))
  11855. (defun org-entry-is-todo-p ()
  11856. (member (org-get-todo-state) org-not-done-keywords))
  11857. (defun org-entry-is-done-p ()
  11858. (member (org-get-todo-state) org-done-keywords))
  11859. (defun org-get-todo-state ()
  11860. "Return the TODO keyword of the current subtree."
  11861. (save-excursion
  11862. (org-back-to-heading t)
  11863. (and (looking-at org-todo-line-regexp)
  11864. (match-end 2)
  11865. (match-string 2))))
  11866. (defun org-at-date-range-p (&optional inactive-ok)
  11867. "Is the cursor inside a date range?"
  11868. (interactive)
  11869. (save-excursion
  11870. (catch 'exit
  11871. (let ((pos (point)))
  11872. (skip-chars-backward "^[<\r\n")
  11873. (skip-chars-backward "<[")
  11874. (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
  11875. (>= (match-end 0) pos)
  11876. (throw 'exit t))
  11877. (skip-chars-backward "^<[\r\n")
  11878. (skip-chars-backward "<[")
  11879. (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
  11880. (>= (match-end 0) pos)
  11881. (throw 'exit t)))
  11882. nil)))
  11883. (defun org-get-repeat (&optional tagline)
  11884. "Check if there is a deadline/schedule with repeater in this entry."
  11885. (save-match-data
  11886. (save-excursion
  11887. (org-back-to-heading t)
  11888. (and (re-search-forward (if tagline
  11889. (concat tagline "\\s-*" org-repeat-re)
  11890. org-repeat-re)
  11891. (org-entry-end-position) t)
  11892. (match-string-no-properties 1)))))
  11893. (defvar org-last-changed-timestamp)
  11894. (defvar org-last-inserted-timestamp)
  11895. (defvar org-log-post-message)
  11896. (defvar org-log-note-purpose)
  11897. (defvar org-log-note-how nil)
  11898. (defvar org-log-note-extra)
  11899. (defun org-auto-repeat-maybe (done-word)
  11900. "Check if the current headline contains a repeated deadline/schedule.
  11901. If yes, set TODO state back to what it was and change the base date
  11902. of repeating deadline/scheduled time stamps to new date.
  11903. This function is run automatically after each state change to a DONE state."
  11904. ;; last-state is dynamically scoped into this function
  11905. (let* ((repeat (org-get-repeat))
  11906. (aa (assoc org-last-state org-todo-kwd-alist))
  11907. (interpret (nth 1 aa))
  11908. (head (nth 2 aa))
  11909. (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
  11910. (msg "Entry repeats: ")
  11911. (org-log-done nil)
  11912. (org-todo-log-states nil)
  11913. re type n what ts time to-state)
  11914. (when (and repeat (not (zerop (string-to-number (substring repeat 1)))))
  11915. (if (eq org-log-repeat t) (setq org-log-repeat 'state))
  11916. (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
  11917. org-todo-repeat-to-state))
  11918. (unless (and to-state (member to-state org-todo-keywords-1))
  11919. (setq to-state (if (eq interpret 'type) org-last-state head)))
  11920. (org-todo to-state)
  11921. (when (or org-log-repeat (org-entry-get nil "CLOCK"))
  11922. (org-entry-put nil "LAST_REPEAT" (format-time-string
  11923. (org-time-stamp-format t t))))
  11924. (when org-log-repeat
  11925. (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
  11926. (memq 'org-add-log-note post-command-hook))
  11927. ;; OK, we are already setup for some record
  11928. (if (eq org-log-repeat 'note)
  11929. ;; make sure we take a note, not only a time stamp
  11930. (setq org-log-note-how 'note))
  11931. ;; Set up for taking a record
  11932. (org-add-log-setup 'state (or done-word (car org-done-keywords))
  11933. org-last-state
  11934. 'findpos org-log-repeat)))
  11935. (org-back-to-heading t)
  11936. (org-add-planning-info nil nil 'closed)
  11937. (setq re (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
  11938. org-deadline-time-regexp "\\)\\|\\("
  11939. org-ts-regexp "\\)"))
  11940. (while (re-search-forward
  11941. re (save-excursion (outline-next-heading) (point)) t)
  11942. (setq type (if (match-end 1) org-scheduled-string
  11943. (if (match-end 3) org-deadline-string "Plain:"))
  11944. ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
  11945. (when (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts)
  11946. (setq n (string-to-number (match-string 2 ts))
  11947. what (match-string 3 ts))
  11948. (if (equal what "w") (setq n (* n 7) what "d"))
  11949. (if (and (equal what "h") (not (string-match "[0-9]\\{1,2\\}:[0-9]\\{2\\}" ts)))
  11950. (user-error "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
  11951. ;; Preparation, see if we need to modify the start date for the change
  11952. (when (match-end 1)
  11953. (setq time (save-match-data (org-time-string-to-time ts)))
  11954. (cond
  11955. ((equal (match-string 1 ts) ".")
  11956. ;; Shift starting date to today
  11957. (org-timestamp-change
  11958. (- (org-today) (time-to-days time))
  11959. 'day))
  11960. ((equal (match-string 1 ts) "+")
  11961. (let ((nshiftmax 10) (nshift 0))
  11962. (while (or (= nshift 0)
  11963. (<= (time-to-days time)
  11964. (time-to-days (current-time))))
  11965. (when (= (incf nshift) nshiftmax)
  11966. (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
  11967. (user-error "Abort")))
  11968. (org-timestamp-change n (cdr (assoc what whata)))
  11969. (org-at-timestamp-p t)
  11970. (setq ts (match-string 1))
  11971. (setq time (save-match-data (org-time-string-to-time ts)))))
  11972. (org-timestamp-change (- n) (cdr (assoc what whata)))
  11973. ;; rematch, so that we have everything in place for the real shift
  11974. (org-at-timestamp-p t)
  11975. (setq ts (match-string 1))
  11976. (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts))))
  11977. (save-excursion (org-timestamp-change n (cdr (assoc what whata)) nil t))
  11978. (setq msg (concat msg type " " org-last-changed-timestamp " "))))
  11979. (setq org-log-post-message msg)
  11980. (message "%s" msg))))
  11981. (defun org-show-todo-tree (arg)
  11982. "Make a compact tree which shows all headlines marked with TODO.
  11983. The tree will show the lines where the regexp matches, and all higher
  11984. headlines above the match.
  11985. With a \\[universal-argument] prefix, prompt for a regexp to match.
  11986. With a numeric prefix N, construct a sparse tree for the Nth element
  11987. of `org-todo-keywords-1'."
  11988. (interactive "P")
  11989. (let ((case-fold-search nil)
  11990. (kwd-re
  11991. (cond ((null arg) org-not-done-regexp)
  11992. ((equal arg '(4))
  11993. (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
  11994. (mapcar 'list org-todo-keywords-1))))
  11995. (concat "\\("
  11996. (mapconcat 'identity (org-split-string kwd "|") "\\|")
  11997. "\\)\\>")))
  11998. ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
  11999. (regexp-quote (nth (1- (prefix-numeric-value arg))
  12000. org-todo-keywords-1)))
  12001. (t (user-error "Invalid prefix argument: %s" arg)))))
  12002. (message "%d TODO entries found"
  12003. (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
  12004. (defun org-deadline (arg &optional time)
  12005. "Insert the \"DEADLINE:\" string with a timestamp to make a deadline.
  12006. With one universal prefix argument, remove any deadline from the item.
  12007. With two universal prefix arguments, prompt for a warning delay.
  12008. With argument TIME, set the deadline at the corresponding date. TIME
  12009. can either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
  12010. (interactive "P")
  12011. (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
  12012. (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
  12013. 'region-start-level 'region))
  12014. org-loop-over-headlines-in-active-region)
  12015. (org-map-entries
  12016. `(org-deadline ',arg ,time)
  12017. org-loop-over-headlines-in-active-region
  12018. cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
  12019. (let* ((old-date (org-entry-get nil "DEADLINE"))
  12020. (old-date-time (if old-date (org-time-string-to-time old-date)))
  12021. (repeater (and old-date
  12022. (string-match
  12023. "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
  12024. old-date)
  12025. (match-string 1 old-date))))
  12026. (cond
  12027. ((equal arg '(4))
  12028. (when (and old-date org-log-redeadline)
  12029. (org-add-log-setup 'deldeadline nil old-date 'findpos
  12030. org-log-redeadline))
  12031. (org-remove-timestamp-with-keyword org-deadline-string)
  12032. (message "Item no longer has a deadline."))
  12033. ((equal arg '(16))
  12034. (save-excursion
  12035. (org-back-to-heading t)
  12036. (if (re-search-forward
  12037. org-deadline-time-regexp
  12038. (save-excursion (outline-next-heading) (point)) t)
  12039. (let* ((rpl0 (match-string 1))
  12040. (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
  12041. (replace-match
  12042. (concat org-deadline-string
  12043. " <" rpl
  12044. (format " -%dd"
  12045. (abs
  12046. (- (time-to-days
  12047. (save-match-data
  12048. (org-read-date nil t nil "Warn starting from" old-date-time)))
  12049. (time-to-days old-date-time))))
  12050. ">") t t))
  12051. (user-error "No deadline information to update"))))
  12052. (t
  12053. (org-add-planning-info 'deadline time 'closed)
  12054. (when (and old-date org-log-redeadline
  12055. (not (equal old-date
  12056. (substring org-last-inserted-timestamp 1 -1))))
  12057. (org-add-log-setup 'redeadline nil old-date 'findpos
  12058. org-log-redeadline))
  12059. (when repeater
  12060. (save-excursion
  12061. (org-back-to-heading t)
  12062. (when (re-search-forward (concat org-deadline-string " "
  12063. org-last-inserted-timestamp)
  12064. (save-excursion
  12065. (outline-next-heading) (point)) t)
  12066. (goto-char (1- (match-end 0)))
  12067. (insert " " repeater)
  12068. (setq org-last-inserted-timestamp
  12069. (concat (substring org-last-inserted-timestamp 0 -1)
  12070. " " repeater
  12071. (substring org-last-inserted-timestamp -1))))))
  12072. (message "Deadline on %s" org-last-inserted-timestamp))))))
  12073. (defun org-schedule (arg &optional time)
  12074. "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
  12075. With one universal prefix argument, remove any scheduling date from the item.
  12076. With two universal prefix arguments, prompt for a delay cookie.
  12077. With argument TIME, scheduled at the corresponding date. TIME can
  12078. either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
  12079. (interactive "P")
  12080. (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
  12081. (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
  12082. 'region-start-level 'region))
  12083. org-loop-over-headlines-in-active-region)
  12084. (org-map-entries
  12085. `(org-schedule ',arg ,time)
  12086. org-loop-over-headlines-in-active-region
  12087. cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
  12088. (let* ((old-date (org-entry-get nil "SCHEDULED"))
  12089. (old-date-time (if old-date (org-time-string-to-time old-date)))
  12090. (repeater (and old-date
  12091. (string-match
  12092. "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
  12093. old-date)
  12094. (match-string 1 old-date))))
  12095. (cond
  12096. ((equal arg '(4))
  12097. (progn
  12098. (when (and old-date org-log-reschedule)
  12099. (org-add-log-setup 'delschedule nil old-date 'findpos
  12100. org-log-reschedule))
  12101. (org-remove-timestamp-with-keyword org-scheduled-string)
  12102. (message "Item is no longer scheduled.")))
  12103. ((equal arg '(16))
  12104. (save-excursion
  12105. (org-back-to-heading t)
  12106. (if (re-search-forward
  12107. org-scheduled-time-regexp
  12108. (save-excursion (outline-next-heading) (point)) t)
  12109. (let* ((rpl0 (match-string 1))
  12110. (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
  12111. (replace-match
  12112. (concat org-scheduled-string
  12113. " <" rpl
  12114. (format " -%dd"
  12115. (abs
  12116. (- (time-to-days
  12117. (save-match-data
  12118. (org-read-date nil t nil "Delay until" old-date-time)))
  12119. (time-to-days old-date-time))))
  12120. ">") t t))
  12121. (user-error "No scheduled information to update"))))
  12122. (t
  12123. (org-add-planning-info 'scheduled time 'closed)
  12124. (when (and old-date org-log-reschedule
  12125. (not (equal old-date
  12126. (substring org-last-inserted-timestamp 1 -1))))
  12127. (org-add-log-setup 'reschedule nil old-date 'findpos
  12128. org-log-reschedule))
  12129. (when repeater
  12130. (save-excursion
  12131. (org-back-to-heading t)
  12132. (when (re-search-forward (concat org-scheduled-string " "
  12133. org-last-inserted-timestamp)
  12134. (save-excursion
  12135. (outline-next-heading) (point)) t)
  12136. (goto-char (1- (match-end 0)))
  12137. (insert " " repeater)
  12138. (setq org-last-inserted-timestamp
  12139. (concat (substring org-last-inserted-timestamp 0 -1)
  12140. " " repeater
  12141. (substring org-last-inserted-timestamp -1))))))
  12142. (message "Scheduled to %s" org-last-inserted-timestamp))))))
  12143. (defun org-get-scheduled-time (pom &optional inherit)
  12144. "Get the scheduled time as a time tuple, of a format suitable
  12145. for calling org-schedule with, or if there is no scheduling,
  12146. returns nil."
  12147. (let ((time (org-entry-get pom "SCHEDULED" inherit)))
  12148. (when time
  12149. (apply 'encode-time (org-parse-time-string time)))))
  12150. (defun org-get-deadline-time (pom &optional inherit)
  12151. "Get the deadline as a time tuple, of a format suitable for
  12152. calling org-deadline with, or if there is no scheduling, returns
  12153. nil."
  12154. (let ((time (org-entry-get pom "DEADLINE" inherit)))
  12155. (when time
  12156. (apply 'encode-time (org-parse-time-string time)))))
  12157. (defun org-remove-timestamp-with-keyword (keyword)
  12158. "Remove all time stamps with KEYWORD in the current entry."
  12159. (let ((re (concat "\\<" (regexp-quote keyword) " +<[^>\n]+>[ \t]*"))
  12160. beg)
  12161. (save-excursion
  12162. (org-back-to-heading t)
  12163. (setq beg (point))
  12164. (outline-next-heading)
  12165. (while (re-search-backward re beg t)
  12166. (replace-match "")
  12167. (if (and (string-match "\\S-" (buffer-substring (point-at-bol) (point)))
  12168. (equal (char-before) ?\ ))
  12169. (backward-delete-char 1)
  12170. (if (string-match "^[ \t]*$" (buffer-substring
  12171. (point-at-bol) (point-at-eol)))
  12172. (delete-region (point-at-bol)
  12173. (min (point-max) (1+ (point-at-eol))))))))))
  12174. (defvar org-time-was-given) ; dynamically scoped parameter
  12175. (defvar org-end-time-was-given) ; dynamically scoped parameter
  12176. (defun org-at-planning-p ()
  12177. "Non-nil when point is on a planning info line."
  12178. ;; This is as accurate and faster than `org-element-at-point' since
  12179. ;; planning info location is fixed in the section.
  12180. (org-with-wide-buffer
  12181. (beginning-of-line)
  12182. (and (org-looking-at-p org-planning-line-re)
  12183. (eq (point)
  12184. (ignore-errors
  12185. (if (and (featurep 'org-inlinetask) (org-inlinetask-in-task-p))
  12186. (org-back-to-heading t)
  12187. (org-with-limited-levels (org-back-to-heading t)))
  12188. (line-beginning-position 2))))))
  12189. (defun org-add-planning-info (what &optional time &rest remove)
  12190. "Insert new timestamp with keyword in the planning line.
  12191. WHAT indicates what kind of time stamp to add. It is a symbol
  12192. among `closed', `deadline', `scheduled' and nil. TIME indicates
  12193. the time to use. If none is given, the user is prompted for
  12194. a date. REMOVE indicates what kind of entries to remove. An old
  12195. WHAT entry will also be removed."
  12196. (let (org-time-was-given org-end-time-was-given default-time default-input)
  12197. (catch 'exit
  12198. (when (and (memq what '(scheduled deadline))
  12199. (or (not time)
  12200. (and (stringp time)
  12201. (string-match "^[-+]+[0-9]" time))))
  12202. ;; Try to get a default date/time from existing timestamp
  12203. (save-excursion
  12204. (org-back-to-heading t)
  12205. (let ((end (save-excursion (outline-next-heading) (point))) ts)
  12206. (when (re-search-forward (if (eq what 'scheduled)
  12207. org-scheduled-time-regexp
  12208. org-deadline-time-regexp)
  12209. end t)
  12210. (setq ts (match-string 1)
  12211. default-time (apply 'encode-time (org-parse-time-string ts))
  12212. default-input (and ts (org-get-compact-tod ts)))))))
  12213. (when what
  12214. (setq time
  12215. (if (stringp time)
  12216. ;; This is a string (relative or absolute), set
  12217. ;; proper date.
  12218. (apply #'encode-time
  12219. (org-read-date-analyze
  12220. time default-time (decode-time default-time)))
  12221. ;; If necessary, get the time from the user
  12222. (or time (org-read-date nil 'to-time nil nil
  12223. default-time default-input)))))
  12224. (org-with-wide-buffer
  12225. (org-back-to-heading t)
  12226. (forward-line)
  12227. (unless (bolp) (insert "\n"))
  12228. (cond ((org-looking-at-p org-planning-line-re)
  12229. ;; Move to current indentation.
  12230. (skip-chars-forward " \t")
  12231. ;; Check if we have to remove something.
  12232. (dolist (type (if what (cons what remove) remove))
  12233. (when (save-excursion
  12234. (re-search-forward
  12235. (case type
  12236. (closed org-closed-time-regexp)
  12237. (deadline org-deadline-time-regexp)
  12238. (scheduled org-scheduled-time-regexp)
  12239. (otherwise (error "Invalid planning type: %s" type)))
  12240. (line-end-position) t))
  12241. (replace-match "")
  12242. (when (looking-at "--+<[^>]+>") (replace-match ""))
  12243. (when (and (not what) (eq type 'closed))
  12244. (save-excursion
  12245. (beginning-of-line)
  12246. (if (looking-at "[ \t]*$")
  12247. (delete-region (point) (1+ (point-at-eol)))))))
  12248. ;; Remove leading white spaces.
  12249. (when (and (not (bolp)) (looking-at "[ \t]+")) (replace-match ""))))
  12250. ((not what) (throw 'exit nil)) ; Nothing to do.
  12251. (t (insert-before-markers "\n")
  12252. (backward-char 1)
  12253. (when org-adapt-indentation
  12254. (org-indent-to-column (1+ (org-outline-level))))))
  12255. (when what
  12256. ;; Insert planning keyword.
  12257. (insert (case what
  12258. (closed org-closed-string)
  12259. (deadline org-deadline-string)
  12260. (scheduled org-scheduled-string)
  12261. (otherwise (error "Invalid planning type: %s" what)))
  12262. " ")
  12263. ;; Insert associated timestamp.
  12264. (let ((ts (org-insert-time-stamp
  12265. time
  12266. (or org-time-was-given
  12267. (and (eq what 'closed) org-log-done-with-time))
  12268. (eq what 'closed)
  12269. nil nil (list org-end-time-was-given))))
  12270. (unless (eolp) (insert " "))
  12271. ts))))))
  12272. (defvar org-log-note-marker (make-marker))
  12273. (defvar org-log-note-purpose nil)
  12274. (defvar org-log-note-state nil)
  12275. (defvar org-log-note-previous-state nil)
  12276. (defvar org-log-note-extra nil)
  12277. (defvar org-log-note-window-configuration nil)
  12278. (defvar org-log-note-return-to (make-marker))
  12279. (defvar org-log-note-effective-time nil
  12280. "Remembered current time so that dynamically scoped
  12281. `org-extend-today-until' affects tha timestamps in state change
  12282. log")
  12283. (defvar org-log-post-message nil
  12284. "Message to be displayed after a log note has been stored.
  12285. The auto-repeater uses this.")
  12286. (defun org-add-note ()
  12287. "Add a note to the current entry.
  12288. This is done in the same way as adding a state change note."
  12289. (interactive)
  12290. (org-add-log-setup 'note nil nil 'findpos nil))
  12291. (defun org-log-beginning (&optional create)
  12292. "Return expected start of log notes in current entry.
  12293. When optional argument CREATE is non-nil, the function creates
  12294. a drawer to store notes, if necessary. Returned position ignores
  12295. narrowing."
  12296. (org-with-wide-buffer
  12297. (org-end-of-meta-data)
  12298. (let ((end (if (org-at-heading-p) (point)
  12299. (save-excursion (outline-next-heading) (point))))
  12300. (drawer (org-log-into-drawer)))
  12301. (cond
  12302. (drawer
  12303. (let ((regexp (concat "^[ \t]*:" (regexp-quote drawer) ":[ \t]*$"))
  12304. (case-fold-search t))
  12305. (catch 'exit
  12306. ;; Try to find existing drawer.
  12307. (while (re-search-forward regexp end t)
  12308. (let ((element (org-element-at-point)))
  12309. (when (eq (org-element-type element) 'drawer)
  12310. (let ((cend (org-element-property :contents-end element)))
  12311. (when (and (not org-log-states-order-reversed) cend)
  12312. (goto-char cend)))
  12313. (throw 'exit nil))))
  12314. ;; No drawer found. Create one, if permitted.
  12315. (when create
  12316. (unless (bolp) (insert "\n"))
  12317. (let ((beg (point)))
  12318. (insert ":" drawer ":\n:END:\n")
  12319. (org-indent-region beg (point)))
  12320. (end-of-line -1)))))
  12321. (org-log-state-notes-insert-after-drawers
  12322. (while (and (looking-at org-drawer-regexp)
  12323. (progn (goto-char (match-end 0))
  12324. (re-search-forward org-property-end-re end t)))
  12325. (forward-line)))))
  12326. (if (bolp) (point) (line-beginning-position 2))))
  12327. (defun org-add-log-setup (&optional purpose state prev-state findpos how extra)
  12328. "Set up the post command hook to take a note.
  12329. If this is about to TODO state change, the new state is expected in STATE.
  12330. When FINDPOS is non-nil, find the correct position for the note in
  12331. the current entry. If not, assume that it can be inserted at point.
  12332. HOW is an indicator what kind of note should be created.
  12333. EXTRA is additional text that will be inserted into the notes buffer."
  12334. (org-with-wide-buffer
  12335. (when findpos
  12336. (goto-char (org-log-beginning t))
  12337. (unless org-log-states-order-reversed
  12338. (org-skip-over-state-notes)
  12339. (skip-chars-backward " \t\n\r")
  12340. (forward-line)))
  12341. (move-marker org-log-note-marker (point))
  12342. ;; Preserve position even if a property drawer is inserted in the
  12343. ;; process.
  12344. (set-marker-insertion-type org-log-note-marker t)
  12345. (setq org-log-note-purpose purpose
  12346. org-log-note-state state
  12347. org-log-note-previous-state prev-state
  12348. org-log-note-how how
  12349. org-log-note-extra extra
  12350. org-log-note-effective-time (org-current-effective-time))
  12351. (add-hook 'post-command-hook 'org-add-log-note 'append)))
  12352. (defun org-skip-over-state-notes ()
  12353. "Skip past the list of State notes in an entry."
  12354. (when (ignore-errors (goto-char (org-in-item-p)))
  12355. (let* ((struct (org-list-struct))
  12356. (prevs (org-list-prevs-alist struct))
  12357. (regexp
  12358. (concat "[ \t]*- +"
  12359. (replace-regexp-in-string
  12360. " +" " +"
  12361. (org-replace-escapes
  12362. (regexp-quote (cdr (assq 'state org-log-note-headings)))
  12363. `(("%d" . ,org-ts-regexp-inactive)
  12364. ("%D" . ,org-ts-regexp)
  12365. ("%s" . "\"\\S-+\"")
  12366. ("%S" . "\"\\S-+\"")
  12367. ("%t" . ,org-ts-regexp-inactive)
  12368. ("%T" . ,org-ts-regexp)
  12369. ("%u" . ".*?")
  12370. ("%U" . ".*?")))))))
  12371. (while (org-looking-at-p regexp)
  12372. (goto-char (or (org-list-get-next-item (point) struct prevs)
  12373. (org-list-get-item-end (point) struct)))))))
  12374. (defun org-add-log-note (&optional purpose)
  12375. "Pop up a window for taking a note, and add this note later at point."
  12376. (remove-hook 'post-command-hook 'org-add-log-note)
  12377. (setq org-log-note-window-configuration (current-window-configuration))
  12378. (delete-other-windows)
  12379. (move-marker org-log-note-return-to (point))
  12380. (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
  12381. (goto-char org-log-note-marker)
  12382. (org-switch-to-buffer-other-window "*Org Note*")
  12383. (erase-buffer)
  12384. (if (memq org-log-note-how '(time state))
  12385. (let (current-prefix-arg) (org-store-log-note))
  12386. (let ((org-inhibit-startup t)) (org-mode))
  12387. (insert (format "# Insert note for %s.
  12388. # Finish with C-c C-c, or cancel with C-c C-k.\n\n"
  12389. (cond
  12390. ((eq org-log-note-purpose 'clock-out) "stopped clock")
  12391. ((eq org-log-note-purpose 'done) "closed todo item")
  12392. ((eq org-log-note-purpose 'state)
  12393. (format "state change from \"%s\" to \"%s\""
  12394. (or org-log-note-previous-state "")
  12395. (or org-log-note-state "")))
  12396. ((eq org-log-note-purpose 'reschedule)
  12397. "rescheduling")
  12398. ((eq org-log-note-purpose 'delschedule)
  12399. "no longer scheduled")
  12400. ((eq org-log-note-purpose 'redeadline)
  12401. "changing deadline")
  12402. ((eq org-log-note-purpose 'deldeadline)
  12403. "removing deadline")
  12404. ((eq org-log-note-purpose 'refile)
  12405. "refiling")
  12406. ((eq org-log-note-purpose 'note)
  12407. "this entry")
  12408. (t (error "This should not happen")))))
  12409. (if org-log-note-extra (insert org-log-note-extra))
  12410. (org-set-local 'org-finish-function 'org-store-log-note)
  12411. (run-hooks 'org-log-buffer-setup-hook)))
  12412. (defvar org-note-abort nil) ; dynamically scoped
  12413. (defun org-store-log-note ()
  12414. "Finish taking a log note, and insert it to where it belongs."
  12415. (let ((txt (buffer-string)))
  12416. (kill-buffer (current-buffer))
  12417. (let ((note (cdr (assq org-log-note-purpose org-log-note-headings))) lines)
  12418. (while (string-match "\\`# .*\n[ \t\n]*" txt)
  12419. (setq txt (replace-match "" t t txt)))
  12420. (if (string-match "\\s-+\\'" txt)
  12421. (setq txt (replace-match "" t t txt)))
  12422. (setq lines (org-split-string txt "\n"))
  12423. (when (and note (string-match "\\S-" note))
  12424. (setq note
  12425. (org-replace-escapes
  12426. note
  12427. (list (cons "%u" (user-login-name))
  12428. (cons "%U" user-full-name)
  12429. (cons "%t" (format-time-string
  12430. (org-time-stamp-format 'long 'inactive)
  12431. org-log-note-effective-time))
  12432. (cons "%T" (format-time-string
  12433. (org-time-stamp-format 'long nil)
  12434. org-log-note-effective-time))
  12435. (cons "%d" (format-time-string
  12436. (org-time-stamp-format nil 'inactive)
  12437. org-log-note-effective-time))
  12438. (cons "%D" (format-time-string
  12439. (org-time-stamp-format nil nil)
  12440. org-log-note-effective-time))
  12441. (cons "%s" (if org-log-note-state
  12442. (concat "\"" org-log-note-state "\"")
  12443. ""))
  12444. (cons "%S" (if org-log-note-previous-state
  12445. (concat "\"" org-log-note-previous-state "\"")
  12446. "\"\"")))))
  12447. (when lines (setq note (concat note " \\\\")))
  12448. (push note lines))
  12449. (when (or current-prefix-arg org-note-abort)
  12450. (when (org-log-into-drawer)
  12451. (org-remove-empty-drawer-at org-log-note-marker))
  12452. (setq lines nil))
  12453. (when lines
  12454. (with-current-buffer (marker-buffer org-log-note-marker)
  12455. (org-with-wide-buffer
  12456. (goto-char org-log-note-marker)
  12457. (move-marker org-log-note-marker nil)
  12458. ;; Make sure point is at the beginning of an empty line.
  12459. (cond ((not (bolp)) (let ((inhibit-read-only t)) (insert "\n")))
  12460. ((looking-at "[ \t]*\\S-") (save-excursion (insert "\n"))))
  12461. ;; In an existing list, add a new item at the top level.
  12462. ;; Otherwise, indent line like a regular one.
  12463. (let ((itemp (org-in-item-p)))
  12464. (if itemp
  12465. (org-indent-line-to
  12466. (let ((struct (save-excursion
  12467. (goto-char itemp) (org-list-struct))))
  12468. (org-list-get-ind (org-list-get-top-point struct) struct)))
  12469. (org-indent-line)))
  12470. (insert (org-list-bullet-string "-") (pop lines))
  12471. (let ((ind (org-list-item-body-column (line-beginning-position))))
  12472. (dolist (line lines)
  12473. (insert "\n")
  12474. (org-indent-line-to ind)
  12475. (insert line)))
  12476. (message "Note stored")
  12477. (org-back-to-heading t)
  12478. (org-cycle-hide-drawers 'children))
  12479. ;; Fix `buffer-undo-list' when `org-store-log-note' is called
  12480. ;; from within `org-add-log-note' because `buffer-undo-list'
  12481. ;; is then modified outside of `org-with-remote-undo'.
  12482. (when (eq this-command 'org-agenda-todo)
  12483. (setcdr buffer-undo-list (cddr buffer-undo-list)))))))
  12484. ;; Don't add undo information when called from `org-agenda-todo'
  12485. (let ((buffer-undo-list (eq this-command 'org-agenda-todo)))
  12486. (set-window-configuration org-log-note-window-configuration)
  12487. (with-current-buffer (marker-buffer org-log-note-return-to)
  12488. (goto-char org-log-note-return-to))
  12489. (move-marker org-log-note-return-to nil)
  12490. (and org-log-post-message (message "%s" org-log-post-message))))
  12491. (defun org-remove-empty-drawer-at (pos)
  12492. "Remove an empty drawer at position POS.
  12493. POS may also be a marker."
  12494. (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
  12495. (org-with-wide-buffer
  12496. (goto-char pos)
  12497. (let ((drawer (org-element-at-point)))
  12498. (when (and (memq (org-element-type drawer) '(drawer property-drawer))
  12499. (not (org-element-property :contents-begin drawer)))
  12500. (delete-region (org-element-property :begin drawer)
  12501. (progn (goto-char (org-element-property :end drawer))
  12502. (skip-chars-backward " \r\t\n")
  12503. (forward-line)
  12504. (point))))))))
  12505. (defvar org-ts-type nil)
  12506. (defun org-sparse-tree (&optional arg type)
  12507. "Create a sparse tree, prompt for the details.
  12508. This command can create sparse trees. You first need to select the type
  12509. of match used to create the tree:
  12510. t Show all TODO entries.
  12511. T Show entries with a specific TODO keyword.
  12512. m Show entries selected by a tags/property match.
  12513. p Enter a property name and its value (both with completion on existing
  12514. names/values) and show entries with that property.
  12515. r Show entries matching a regular expression (`/' can be used as well).
  12516. b Show deadlines and scheduled items before a date.
  12517. a Show deadlines and scheduled items after a date.
  12518. d Show deadlines due within `org-deadline-warning-days'.
  12519. D Show deadlines and scheduled items between a date range."
  12520. (interactive "P")
  12521. (setq type (or type org-sparse-tree-default-date-type))
  12522. (setq org-ts-type type)
  12523. (message "Sparse tree: [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty
  12524. [d]eadlines [b]efore-date [a]fter-date [D]ates range
  12525. [c]ycle through date types: %s"
  12526. (case type
  12527. (all "all timestamps")
  12528. (scheduled "only scheduled")
  12529. (deadline "only deadline")
  12530. (active "only active timestamps")
  12531. (inactive "only inactive timestamps")
  12532. (closed "with a closed time-stamp")
  12533. (otherwise "scheduled/deadline")))
  12534. (let ((answer (read-char-exclusive)))
  12535. (case answer
  12536. (?c
  12537. (org-sparse-tree
  12538. arg
  12539. (cadr
  12540. (memq type '(nil all scheduled deadline active inactive closed)))))
  12541. (?d (call-interactively 'org-check-deadlines))
  12542. (?b (call-interactively 'org-check-before-date))
  12543. (?a (call-interactively 'org-check-after-date))
  12544. (?D (call-interactively 'org-check-dates-range))
  12545. (?t (call-interactively 'org-show-todo-tree))
  12546. (?T (org-show-todo-tree '(4)))
  12547. (?m (call-interactively 'org-match-sparse-tree))
  12548. ((?p ?P)
  12549. (let* ((kwd (org-icompleting-read
  12550. "Property: " (mapcar 'list (org-buffer-property-keys))))
  12551. (value (org-icompleting-read
  12552. "Value: " (mapcar 'list (org-property-values kwd)))))
  12553. (unless (string-match "\\`{.*}\\'" value)
  12554. (setq value (concat "\"" value "\"")))
  12555. (org-match-sparse-tree arg (concat kwd "=" value))))
  12556. ((?r ?R ?/) (call-interactively 'org-occur))
  12557. (otherwise (user-error "No such sparse tree command \"%c\"" answer)))))
  12558. (defvar org-occur-highlights nil
  12559. "List of overlays used for occur matches.")
  12560. (make-variable-buffer-local 'org-occur-highlights)
  12561. (defvar org-occur-parameters nil
  12562. "Parameters of the active org-occur calls.
  12563. This is a list, each call to org-occur pushes as cons cell,
  12564. containing the regular expression and the callback, onto the list.
  12565. The list can contain several entries if `org-occur' has been called
  12566. several time with the KEEP-PREVIOUS argument. Otherwise, this list
  12567. will only contain one set of parameters. When the highlights are
  12568. removed (for example with `C-c C-c', or with the next edit (depending
  12569. on `org-remove-highlights-with-change'), this variable is emptied
  12570. as well.")
  12571. (make-variable-buffer-local 'org-occur-parameters)
  12572. (defun org-occur (regexp &optional keep-previous callback)
  12573. "Make a compact tree which shows all matches of REGEXP.
  12574. The tree will show the lines where the regexp matches, and all higher
  12575. headlines above the match. It will also show the heading after the match,
  12576. to make sure editing the matching entry is easy.
  12577. If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
  12578. call to `org-occur' will be kept, to allow stacking of calls to this
  12579. command.
  12580. If CALLBACK is non-nil, it is a function which is called to confirm
  12581. that the match should indeed be shown."
  12582. (interactive "sRegexp: \nP")
  12583. (when (equal regexp "")
  12584. (user-error "Regexp cannot be empty"))
  12585. (unless keep-previous
  12586. (org-remove-occur-highlights nil nil t))
  12587. (push (cons regexp callback) org-occur-parameters)
  12588. (let ((cnt 0))
  12589. (save-excursion
  12590. (goto-char (point-min))
  12591. (if (or (not keep-previous) ; do not want to keep
  12592. (not org-occur-highlights)) ; no previous matches
  12593. ;; hide everything
  12594. (org-overview))
  12595. (while (re-search-forward regexp nil t)
  12596. (when (or (not callback)
  12597. (save-match-data (funcall callback)))
  12598. (setq cnt (1+ cnt))
  12599. (when org-highlight-sparse-tree-matches
  12600. (org-highlight-new-match (match-beginning 0) (match-end 0)))
  12601. (org-show-context 'occur-tree))))
  12602. (when org-remove-highlights-with-change
  12603. (org-add-hook 'before-change-functions 'org-remove-occur-highlights
  12604. nil 'local))
  12605. (unless org-sparse-tree-open-archived-trees
  12606. (org-hide-archived-subtrees (point-min) (point-max)))
  12607. (run-hooks 'org-occur-hook)
  12608. (if (org-called-interactively-p 'interactive)
  12609. (message "%d match(es) for regexp %s" cnt regexp))
  12610. cnt))
  12611. (defun org-occur-next-match (&optional n reset)
  12612. "Function for `next-error-function' to find sparse tree matches.
  12613. N is the number of matches to move, when negative move backwards.
  12614. RESET is entirely ignored - this function always goes back to the
  12615. starting point when no match is found."
  12616. (let* ((limit (if (< n 0) (point-min) (point-max)))
  12617. (search-func (if (< n 0)
  12618. 'previous-single-char-property-change
  12619. 'next-single-char-property-change))
  12620. (n (abs n))
  12621. (pos (point))
  12622. p1)
  12623. (catch 'exit
  12624. (while (setq p1 (funcall search-func (point) 'org-type))
  12625. (when (equal p1 limit)
  12626. (goto-char pos)
  12627. (user-error "No more matches"))
  12628. (when (equal (get-char-property p1 'org-type) 'org-occur)
  12629. (setq n (1- n))
  12630. (when (= n 0)
  12631. (goto-char p1)
  12632. (throw 'exit (point))))
  12633. (goto-char p1))
  12634. (goto-char p1)
  12635. (user-error "No more matches"))))
  12636. (defun org-show-context (&optional key)
  12637. "Make sure point and context are visible.
  12638. Optional argument KEY, when non-nil, is a symbol. See
  12639. `org-show-context-detail' for allowed values and how much is to
  12640. be shown."
  12641. (org-show-set-visibility
  12642. (cond ((symbolp org-show-context-detail) org-show-context-detail)
  12643. ((cdr (assq key org-show-context-detail)))
  12644. (t (cdr (assq 'default org-show-context-detail))))))
  12645. (defun org-show-set-visibility (detail)
  12646. "Set visibility around point according to DETAIL.
  12647. DETAIL is either nil, `minimal', `local', `ancestors', `lineage',
  12648. `tree', `canonical' or t. See `org-show-context-detail' for more
  12649. information."
  12650. (unless (org-before-first-heading-p)
  12651. ;; Show current heading and possibly its entry, following headline
  12652. ;; or all children.
  12653. (if (and (org-at-heading-p) (not (eq detail 'local)))
  12654. (org-flag-heading nil)
  12655. (org-show-entry)
  12656. (org-with-limited-levels
  12657. (case detail
  12658. ((tree canonical t) (show-children))
  12659. ((nil minimal ancestors))
  12660. (t (save-excursion
  12661. (outline-next-heading)
  12662. (org-flag-heading nil))))))
  12663. ;; Show all siblings.
  12664. (when (eq detail 'lineage) (org-show-siblings))
  12665. ;; Show ancestors, possibly with their children.
  12666. (when (memq detail '(ancestors lineage tree canonical t))
  12667. (save-excursion
  12668. (while (org-up-heading-safe)
  12669. (org-flag-heading nil)
  12670. (when (memq detail '(canonical t)) (org-show-entry))
  12671. (when (memq detail '(tree canonical t)) (show-children)))))))
  12672. (defvar org-reveal-start-hook nil
  12673. "Hook run before revealing a location.")
  12674. (defun org-reveal (&optional siblings)
  12675. "Show current entry, hierarchy above it, and the following headline.
  12676. This can be used to show a consistent set of context around
  12677. locations exposed with `org-show-context'.
  12678. With optional argument SIBLINGS, on each level of the hierarchy all
  12679. siblings are shown. This repairs the tree structure to what it would
  12680. look like when opened with hierarchical calls to `org-cycle'.
  12681. With double optional argument \\[universal-argument] \\[universal-argument], \
  12682. go to the parent and show the
  12683. entire tree."
  12684. (interactive "P")
  12685. (run-hooks 'org-reveal-start-hook)
  12686. (cond ((equal siblings '(4)) (org-show-set-visibility 'canonical))
  12687. ((equal siblings '(16))
  12688. (save-excursion
  12689. (when (org-up-heading-safe)
  12690. (org-show-subtree)
  12691. (run-hook-with-args 'org-cycle-hook 'subtree))))
  12692. (t (org-show-set-visibility 'lineage))))
  12693. (defun org-highlight-new-match (beg end)
  12694. "Highlight from BEG to END and mark the highlight is an occur headline."
  12695. (let ((ov (make-overlay beg end)))
  12696. (overlay-put ov 'face 'secondary-selection)
  12697. (overlay-put ov 'org-type 'org-occur)
  12698. (push ov org-occur-highlights)))
  12699. (defun org-remove-occur-highlights (&optional beg end noremove)
  12700. "Remove the occur highlights from the buffer.
  12701. BEG and END are ignored. If NOREMOVE is nil, remove this function
  12702. from the `before-change-functions' in the current buffer."
  12703. (interactive)
  12704. (unless org-inhibit-highlight-removal
  12705. (mapc 'delete-overlay org-occur-highlights)
  12706. (setq org-occur-highlights nil)
  12707. (setq org-occur-parameters nil)
  12708. (unless noremove
  12709. (remove-hook 'before-change-functions
  12710. 'org-remove-occur-highlights 'local))))
  12711. ;;;; Priorities
  12712. (defvar org-priority-regexp ".*?\\(\\[#\\([A-Z0-9]\\)\\] ?\\)"
  12713. "Regular expression matching the priority indicator.")
  12714. (defvar org-remove-priority-next-time nil)
  12715. (defun org-priority-up ()
  12716. "Increase the priority of the current item."
  12717. (interactive)
  12718. (org-priority 'up))
  12719. (defun org-priority-down ()
  12720. "Decrease the priority of the current item."
  12721. (interactive)
  12722. (org-priority 'down))
  12723. (defun org-priority (&optional action show)
  12724. "Change the priority of an item.
  12725. ACTION can be `set', `up', `down', or a character."
  12726. (interactive "P")
  12727. (if (equal action '(4))
  12728. (org-show-priority)
  12729. (unless org-enable-priority-commands
  12730. (user-error "Priority commands are disabled"))
  12731. (setq action (or action 'set))
  12732. (let (current new news have remove)
  12733. (save-excursion
  12734. (org-back-to-heading t)
  12735. (if (looking-at org-priority-regexp)
  12736. (setq current (string-to-char (match-string 2))
  12737. have t))
  12738. (cond
  12739. ((eq action 'remove)
  12740. (setq remove t new ?\ ))
  12741. ((or (eq action 'set)
  12742. (if (featurep 'xemacs) (characterp action) (integerp action)))
  12743. (if (not (eq action 'set))
  12744. (setq new action)
  12745. (message "Priority %c-%c, SPC to remove: "
  12746. org-highest-priority org-lowest-priority)
  12747. (save-match-data
  12748. (setq new (read-char-exclusive))))
  12749. (if (and (= (upcase org-highest-priority) org-highest-priority)
  12750. (= (upcase org-lowest-priority) org-lowest-priority))
  12751. (setq new (upcase new)))
  12752. (cond ((equal new ?\ ) (setq remove t))
  12753. ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
  12754. (user-error "Priority must be between `%c' and `%c'"
  12755. org-highest-priority org-lowest-priority))))
  12756. ((eq action 'up)
  12757. (setq new (if have
  12758. (1- current) ; normal cycling
  12759. ;; last priority was empty
  12760. (if (eq last-command this-command)
  12761. org-lowest-priority ; wrap around empty to lowest
  12762. ;; default
  12763. (if org-priority-start-cycle-with-default
  12764. org-default-priority
  12765. (1- org-default-priority))))))
  12766. ((eq action 'down)
  12767. (setq new (if have
  12768. (1+ current) ; normal cycling
  12769. ;; last priority was empty
  12770. (if (eq last-command this-command)
  12771. org-highest-priority ; wrap around empty to highest
  12772. ;; default
  12773. (if org-priority-start-cycle-with-default
  12774. org-default-priority
  12775. (1+ org-default-priority))))))
  12776. (t (user-error "Invalid action")))
  12777. (if (or (< (upcase new) org-highest-priority)
  12778. (> (upcase new) org-lowest-priority))
  12779. (if (and (memq action '(up down))
  12780. (not have) (not (eq last-command this-command)))
  12781. ;; `new' is from default priority
  12782. (error
  12783. "The default can not be set, see `org-default-priority' why")
  12784. ;; normal cycling: `new' is beyond highest/lowest priority
  12785. ;; and is wrapped around to the empty priority
  12786. (setq remove t)))
  12787. (setq news (format "%c" new))
  12788. (if have
  12789. (if remove
  12790. (replace-match "" t t nil 1)
  12791. (replace-match news t t nil 2))
  12792. (if remove
  12793. (user-error "No priority cookie found in line")
  12794. (let ((case-fold-search nil))
  12795. (looking-at org-todo-line-regexp))
  12796. (if (match-end 2)
  12797. (progn
  12798. (goto-char (match-end 2))
  12799. (insert " [#" news "]"))
  12800. (goto-char (match-beginning 3))
  12801. (insert "[#" news "] "))))
  12802. (org-set-tags nil 'align))
  12803. (if remove
  12804. (message "Priority removed")
  12805. (message "Priority of current item set to %s" news)))))
  12806. (defun org-show-priority ()
  12807. "Show the priority of the current item.
  12808. This priority is composed of the main priority given with the [#A] cookies,
  12809. and by additional input from the age of a schedules or deadline entry."
  12810. (interactive)
  12811. (let ((pri (if (eq major-mode 'org-agenda-mode)
  12812. (org-get-at-bol 'priority)
  12813. (save-excursion
  12814. (save-match-data
  12815. (beginning-of-line)
  12816. (and (looking-at org-heading-regexp)
  12817. (org-get-priority (match-string 0))))))))
  12818. (message "Priority is %d" (if pri pri -1000))))
  12819. (defun org-get-priority (s)
  12820. "Find priority cookie and return priority."
  12821. (save-match-data
  12822. (if (functionp org-get-priority-function)
  12823. (funcall org-get-priority-function)
  12824. (if (not (string-match org-priority-regexp s))
  12825. (* 1000 (- org-lowest-priority org-default-priority))
  12826. (* 1000 (- org-lowest-priority
  12827. (string-to-char (match-string 2 s))))))))
  12828. ;;;; Tags
  12829. (defvar org-agenda-archives-mode)
  12830. (defvar org-map-continue-from nil
  12831. "Position from where mapping should continue.
  12832. Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
  12833. (defvar org-scanner-tags nil
  12834. "The current tag list while the tags scanner is running.")
  12835. (defvar org-trust-scanner-tags nil
  12836. "Should `org-get-tags-at' use the tags for the scanner.
  12837. This is for internal dynamical scoping only.
  12838. When this is non-nil, the function `org-get-tags-at' will return the value
  12839. of `org-scanner-tags' instead of building the list by itself. This
  12840. can lead to large speed-ups when the tags scanner is used in a file with
  12841. many entries, and when the list of tags is retrieved, for example to
  12842. obtain a list of properties. Building the tags list for each entry in such
  12843. a file becomes an N^2 operation - but with this variable set, it scales
  12844. as N.")
  12845. (defun org-scan-tags (action matcher todo-only &optional start-level)
  12846. "Scan headline tags with inheritance and produce output ACTION.
  12847. ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
  12848. or `agenda' to produce an entry list for an agenda view. It can also be
  12849. a Lisp form or a function that should be called at each matched headline, in
  12850. this case the return value is a list of all return values from these calls.
  12851. MATCHER is a Lisp form to be evaluated, testing if a given set of tags
  12852. qualifies a headline for inclusion. When TODO-ONLY is non-nil,
  12853. only lines with a not-done TODO keyword are included in the output.
  12854. This should be the same variable that was scoped into
  12855. and set by `org-make-tags-matcher' when it constructed MATCHER.
  12856. START-LEVEL can be a string with asterisks, reducing the scope to
  12857. headlines matching this string."
  12858. (require 'org-agenda)
  12859. (let* ((re (concat "^"
  12860. (if start-level
  12861. ;; Get the correct level to match
  12862. (concat "\\*\\{" (number-to-string start-level) "\\} ")
  12863. org-outline-regexp)
  12864. " *\\(\\<\\("
  12865. (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
  12866. (org-re "\\)\\>\\)? *\\(.*?\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*$")))
  12867. (props (list 'face 'default
  12868. 'done-face 'org-agenda-done
  12869. 'undone-face 'default
  12870. 'mouse-face 'highlight
  12871. 'org-not-done-regexp org-not-done-regexp
  12872. 'org-todo-regexp org-todo-regexp
  12873. 'org-complex-heading-regexp org-complex-heading-regexp
  12874. 'help-echo
  12875. (format "mouse-2 or RET jump to org file %s"
  12876. (abbreviate-file-name
  12877. (or (buffer-file-name (buffer-base-buffer))
  12878. (buffer-name (buffer-base-buffer)))))))
  12879. (org-map-continue-from nil)
  12880. lspos tags tags-list
  12881. (tags-alist (list (cons 0 org-file-tags)))
  12882. (llast 0) rtn rtn1 level category i txt
  12883. todo marker entry priority
  12884. ts-date ts-date-type ts-date-pair)
  12885. (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
  12886. (setq action (list 'lambda nil action)))
  12887. (save-excursion
  12888. (goto-char (point-min))
  12889. (when (eq action 'sparse-tree)
  12890. (org-overview)
  12891. (org-remove-occur-highlights))
  12892. (while (let (case-fold-search)
  12893. (re-search-forward re nil t))
  12894. (setq org-map-continue-from nil)
  12895. (catch :skip
  12896. (setq todo (if (match-end 1) (org-match-string-no-properties 2))
  12897. tags (if (match-end 4) (org-match-string-no-properties 4)))
  12898. (goto-char (setq lspos (match-beginning 0)))
  12899. (setq level (org-reduced-level (org-outline-level))
  12900. category (org-get-category))
  12901. (when (eq action 'agenda)
  12902. (setq ts-date-pair (org-agenda-entry-get-agenda-timestamp (point))
  12903. ts-date (car ts-date-pair)
  12904. ts-date-type (cdr ts-date-pair)))
  12905. (setq i llast llast level)
  12906. ;; remove tag lists from same and sublevels
  12907. (while (>= i level)
  12908. (when (setq entry (assoc i tags-alist))
  12909. (setq tags-alist (delete entry tags-alist)))
  12910. (setq i (1- i)))
  12911. ;; add the next tags
  12912. (when tags
  12913. (setq tags (org-split-string tags ":")
  12914. tags-alist
  12915. (cons (cons level tags) tags-alist)))
  12916. ;; compile tags for current headline
  12917. (setq tags-list
  12918. (if org-use-tag-inheritance
  12919. (apply 'append (mapcar 'cdr (reverse tags-alist)))
  12920. tags)
  12921. org-scanner-tags tags-list)
  12922. (when org-use-tag-inheritance
  12923. (setcdr (car tags-alist)
  12924. (mapcar (lambda (x)
  12925. (setq x (copy-sequence x))
  12926. (org-add-prop-inherited x))
  12927. (cdar tags-alist))))
  12928. (when (and tags org-use-tag-inheritance
  12929. (or (not (eq t org-use-tag-inheritance))
  12930. org-tags-exclude-from-inheritance))
  12931. ;; selective inheritance, remove uninherited ones
  12932. (setcdr (car tags-alist)
  12933. (org-remove-uninherited-tags (cdar tags-alist))))
  12934. (when (and
  12935. ;; eval matcher only when the todo condition is OK
  12936. (and (or (not todo-only) (member todo org-not-done-keywords))
  12937. (let ((case-fold-search t) (org-trust-scanner-tags t))
  12938. (eval matcher)))
  12939. ;; Call the skipper, but return t if it does not skip,
  12940. ;; so that the `and' form continues evaluating
  12941. (progn
  12942. (unless (eq action 'sparse-tree) (org-agenda-skip))
  12943. t)
  12944. ;; Check if timestamps are deselecting this entry
  12945. (or (not todo-only)
  12946. (and (member todo org-not-done-keywords)
  12947. (or (not org-agenda-tags-todo-honor-ignore-options)
  12948. (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item))))))
  12949. ;; select this headline
  12950. (cond
  12951. ((eq action 'sparse-tree)
  12952. (and org-highlight-sparse-tree-matches
  12953. (org-get-heading) (match-end 0)
  12954. (org-highlight-new-match
  12955. (match-beginning 1) (match-end 1)))
  12956. (org-show-context 'tags-tree))
  12957. ((eq action 'agenda)
  12958. (setq txt (org-agenda-format-item
  12959. ""
  12960. (concat
  12961. (if (eq org-tags-match-list-sublevels 'indented)
  12962. (make-string (1- level) ?.) "")
  12963. (org-get-heading))
  12964. (make-string level ?\s)
  12965. category
  12966. tags-list)
  12967. priority (org-get-priority txt))
  12968. (goto-char lspos)
  12969. (setq marker (org-agenda-new-marker))
  12970. (org-add-props txt props
  12971. 'org-marker marker 'org-hd-marker marker 'org-category category
  12972. 'todo-state todo
  12973. 'ts-date ts-date
  12974. 'priority priority
  12975. 'type (concat "tagsmatch" ts-date-type))
  12976. (push txt rtn))
  12977. ((functionp action)
  12978. (setq org-map-continue-from nil)
  12979. (save-excursion
  12980. (setq rtn1 (funcall action))
  12981. (push rtn1 rtn)))
  12982. (t (user-error "Invalid action")))
  12983. ;; if we are to skip sublevels, jump to end of subtree
  12984. (unless org-tags-match-list-sublevels
  12985. (org-end-of-subtree t)
  12986. (backward-char 1))))
  12987. ;; Get the correct position from where to continue
  12988. (if org-map-continue-from
  12989. (goto-char org-map-continue-from)
  12990. (and (= (point) lspos) (end-of-line 1)))))
  12991. (when (and (eq action 'sparse-tree)
  12992. (not org-sparse-tree-open-archived-trees))
  12993. (org-hide-archived-subtrees (point-min) (point-max)))
  12994. (nreverse rtn)))
  12995. (defun org-remove-uninherited-tags (tags)
  12996. "Remove all tags that are not inherited from the list TAGS."
  12997. (cond
  12998. ((eq org-use-tag-inheritance t)
  12999. (if org-tags-exclude-from-inheritance
  13000. (org-delete-all org-tags-exclude-from-inheritance tags)
  13001. tags))
  13002. ((not org-use-tag-inheritance) nil)
  13003. ((stringp org-use-tag-inheritance)
  13004. (delq nil (mapcar
  13005. (lambda (x)
  13006. (if (and (string-match org-use-tag-inheritance x)
  13007. (not (member x org-tags-exclude-from-inheritance)))
  13008. x nil))
  13009. tags)))
  13010. ((listp org-use-tag-inheritance)
  13011. (delq nil (mapcar
  13012. (lambda (x)
  13013. (if (member x org-use-tag-inheritance) x nil))
  13014. tags)))))
  13015. (defun org-match-sparse-tree (&optional todo-only match)
  13016. "Create a sparse tree according to tags string MATCH.
  13017. MATCH can contain positive and negative selection of tags, like
  13018. \"+WORK+URGENT-WITHBOSS\".
  13019. If optional argument TODO-ONLY is non-nil, only select lines that are
  13020. also TODO lines."
  13021. (interactive "P")
  13022. (org-agenda-prepare-buffers (list (current-buffer)))
  13023. (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
  13024. (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
  13025. (defvar org-cached-props nil)
  13026. (defun org-cached-entry-get (pom property)
  13027. (if (or (eq t org-use-property-inheritance)
  13028. (and (stringp org-use-property-inheritance)
  13029. (let ((case-fold-search t))
  13030. (org-string-match-p org-use-property-inheritance property)))
  13031. (and (listp org-use-property-inheritance)
  13032. (member-ignore-case property org-use-property-inheritance)))
  13033. ;; Caching is not possible, check it directly.
  13034. (org-entry-get pom property 'inherit)
  13035. ;; Get all properties, so we can do complicated checks easily.
  13036. (cdr (assoc-string property
  13037. (or org-cached-props
  13038. (setq org-cached-props (org-entry-properties pom)))
  13039. t))))
  13040. (defun org-global-tags-completion-table (&optional files)
  13041. "Return the list of all tags in all agenda buffer/files.
  13042. Optional FILES argument is a list of files which can be used
  13043. instead of the agenda files."
  13044. (save-excursion
  13045. (org-uniquify
  13046. (delq nil
  13047. (apply 'append
  13048. (mapcar
  13049. (lambda (file)
  13050. (set-buffer (find-file-noselect file))
  13051. (append (org-get-buffer-tags)
  13052. (mapcar (lambda (x) (if (stringp (car-safe x))
  13053. (list (car-safe x)) nil))
  13054. org-tag-alist)))
  13055. (if (and files (car files))
  13056. files
  13057. (org-agenda-files))))))))
  13058. (defun org-make-tags-matcher (match)
  13059. "Create the TAGS/TODO matcher form for the selection string MATCH.
  13060. The variable `todo-only' is scoped dynamically into this function.
  13061. It will be set to t if the matcher restricts matching to TODO entries,
  13062. otherwise will not be touched.
  13063. Returns a cons of the selection string MATCH and the constructed
  13064. lisp form implementing the matcher. The matcher is to be evaluated
  13065. at an Org entry, with point on the headline, and returns t if the
  13066. entry matches the selection string MATCH. The returned lisp form
  13067. references two variables with information about the entry, which
  13068. must be bound around the form's evaluation: todo, the TODO keyword
  13069. at the entry (or nil of none); and tags-list, the list of all tags
  13070. at the entry including inherited ones. Additionally, the category
  13071. of the entry (if any) must be specified as the text property
  13072. 'org-category on the headline.
  13073. See also `org-scan-tags'.
  13074. "
  13075. (declare (special todo-only))
  13076. (unless (boundp 'todo-only)
  13077. (error "`org-make-tags-matcher' expects todo-only to be scoped in"))
  13078. (unless match
  13079. ;; Get a new match request, with completion against the global
  13080. ;; tags table and the local tags in current buffer
  13081. (let ((org-last-tags-completion-table
  13082. (org-uniquify
  13083. (delq nil (append (org-get-buffer-tags)
  13084. (org-global-tags-completion-table))))))
  13085. (setq match (org-completing-read-no-i
  13086. "Match: " 'org-tags-completion-function nil nil nil
  13087. 'org-tags-history))))
  13088. ;; Parse the string and create a lisp form
  13089. (let ((match0 match)
  13090. (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
  13091. minus tag mm
  13092. tagsmatch todomatch tagsmatcher todomatcher kwd matcher
  13093. orterms term orlist re-p str-p level-p level-op time-p
  13094. prop-p pn pv po gv rest (start 0) (ss 0))
  13095. ;; Expand group tags
  13096. (setq match (org-tags-expand match))
  13097. ;; Check if there is a TODO part of this match, which would be the
  13098. ;; part after a "/". TO make sure that this slash is not part of
  13099. ;; a property value to be matched against, we also check that there
  13100. ;; is no " after that slash.
  13101. ;; First, find the last slash
  13102. (while (string-match "/+" match ss)
  13103. (setq start (match-beginning 0) ss (match-end 0)))
  13104. (if (and (string-match "/+" match start)
  13105. (not (save-match-data (string-match "\"" match start))))
  13106. ;; match contains also a todo-matching request
  13107. (progn
  13108. (setq tagsmatch (substring match 0 (match-beginning 0))
  13109. todomatch (substring match (match-end 0)))
  13110. (if (string-match "^!" todomatch)
  13111. (setq todo-only t todomatch (substring todomatch 1)))
  13112. (if (string-match "^\\s-*$" todomatch)
  13113. (setq todomatch nil)))
  13114. ;; only matching tags
  13115. (setq tagsmatch match todomatch nil))
  13116. ;; Make the tags matcher
  13117. (if (or (not tagsmatch) (not (string-match "\\S-" tagsmatch)))
  13118. (setq tagsmatcher t)
  13119. (setq orterms (org-split-string tagsmatch "|") orlist nil)
  13120. (while (setq term (pop orterms))
  13121. (while (and (equal (substring term -1) "\\") orterms)
  13122. (setq term (concat term "|" (pop orterms)))) ; repair bad split
  13123. (while (string-match re term)
  13124. (setq rest (substring term (match-end 0))
  13125. minus (and (match-end 1)
  13126. (equal (match-string 1 term) "-"))
  13127. tag (save-match-data (replace-regexp-in-string
  13128. "\\\\-" "-"
  13129. (match-string 2 term)))
  13130. re-p (equal (string-to-char tag) ?{)
  13131. level-p (match-end 4)
  13132. prop-p (match-end 5)
  13133. mm (cond
  13134. (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
  13135. (level-p
  13136. (setq level-op (org-op-to-function (match-string 3 term)))
  13137. `(,level-op level ,(string-to-number
  13138. (match-string 4 term))))
  13139. (prop-p
  13140. (setq pn (match-string 5 term)
  13141. po (match-string 6 term)
  13142. pv (match-string 7 term)
  13143. re-p (equal (string-to-char pv) ?{)
  13144. str-p (equal (string-to-char pv) ?\")
  13145. time-p (save-match-data
  13146. (string-match "^\"[[<].*[]>]\"$" pv))
  13147. pv (if (or re-p str-p) (substring pv 1 -1) pv))
  13148. (if time-p (setq pv (org-matcher-time pv)))
  13149. (setq po (org-op-to-function po (if time-p 'time str-p)))
  13150. (cond
  13151. ((equal pn "CATEGORY")
  13152. (setq gv '(get-text-property (point) 'org-category)))
  13153. ((equal pn "TODO")
  13154. (setq gv 'todo))
  13155. (t
  13156. (setq gv `(org-cached-entry-get nil ,pn))))
  13157. (if re-p
  13158. (if (eq po 'org<>)
  13159. `(not (string-match ,pv (or ,gv "")))
  13160. `(string-match ,pv (or ,gv "")))
  13161. (if str-p
  13162. `(,po (or ,gv "") ,pv)
  13163. `(,po (string-to-number (or ,gv ""))
  13164. ,(string-to-number pv) ))))
  13165. (t `(member ,tag tags-list)))
  13166. mm (if minus (list 'not mm) mm)
  13167. term rest)
  13168. (push mm tagsmatcher))
  13169. (push (if (> (length tagsmatcher) 1)
  13170. (cons 'and tagsmatcher)
  13171. (car tagsmatcher))
  13172. orlist)
  13173. (setq tagsmatcher nil))
  13174. (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
  13175. (setq tagsmatcher
  13176. (list 'progn '(setq org-cached-props nil) tagsmatcher)))
  13177. ;; Make the todo matcher
  13178. (if (or (not todomatch) (not (string-match "\\S-" todomatch)))
  13179. (setq todomatcher t)
  13180. (setq orterms (org-split-string todomatch "|") orlist nil)
  13181. (while (setq term (pop orterms))
  13182. (while (string-match re term)
  13183. (setq minus (and (match-end 1)
  13184. (equal (match-string 1 term) "-"))
  13185. kwd (match-string 2 term)
  13186. re-p (equal (string-to-char kwd) ?{)
  13187. term (substring term (match-end 0))
  13188. mm (if re-p
  13189. `(string-match ,(substring kwd 1 -1) todo)
  13190. (list 'equal 'todo kwd))
  13191. mm (if minus (list 'not mm) mm))
  13192. (push mm todomatcher))
  13193. (push (if (> (length todomatcher) 1)
  13194. (cons 'and todomatcher)
  13195. (car todomatcher))
  13196. orlist)
  13197. (setq todomatcher nil))
  13198. (setq todomatcher (if (> (length orlist) 1)
  13199. (cons 'or orlist) (car orlist))))
  13200. ;; Return the string and lisp forms of the matcher
  13201. (setq matcher (if todomatcher
  13202. (list 'and tagsmatcher todomatcher)
  13203. tagsmatcher))
  13204. (when todo-only
  13205. (setq matcher (list 'and '(member todo org-not-done-keywords)
  13206. matcher)))
  13207. (cons match0 matcher)))
  13208. (defun org-tags-expand (match &optional single-as-list downcased tags-already-expanded)
  13209. "Expand group tags in MATCH.
  13210. This replaces every group tag in MATCH with a regexp tag search.
  13211. For example, a group tag \"Work\" defined as { Work : Lab Conf }
  13212. will be replaced like this:
  13213. Work => {\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
  13214. +Work => +{\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
  13215. -Work => -{\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
  13216. Replacing by a regexp preserves the structure of the match.
  13217. E.g., this expansion
  13218. Work|Home => {\\(?:Work\\|Lab\\|Conf\\}|Home
  13219. will match anything tagged with \"Lab\" and \"Home\", or tagged
  13220. with \"Conf\" and \"Home\" or tagged with \"Work\" and \"home\".
  13221. A group tag in MATCH can contain regular expressions of its own.
  13222. For example, a group tag \"Proj\" defined as { Proj : {P@.+} }
  13223. will be replaced like this:
  13224. Proj => {\\<\\(?:Proj\\)\\>\\|P@.+}
  13225. When the optional argument SINGLE-AS-LIST is non-nil, MATCH is
  13226. assumed to be a single group tag, and the function will return
  13227. the list of tags in this group.
  13228. When DOWNCASE is non-nil, expand downcased TAGS."
  13229. (if org-group-tags
  13230. (let* ((case-fold-search t)
  13231. (stable org-mode-syntax-table)
  13232. (taggroups (or org-tag-groups-alist-for-agenda org-tag-groups-alist))
  13233. (taggroups (if downcased
  13234. (mapcar (lambda (tg) (mapcar #'downcase tg))
  13235. taggroups)
  13236. taggroups))
  13237. (taggroups-keys (mapcar #'car taggroups))
  13238. (return-match (if downcased (downcase match) match))
  13239. (count 0)
  13240. (work-already-expanded tags-already-expanded)
  13241. regexps-in-match tags-in-group regexp-in-group regexp-in-group-escaped)
  13242. ;; @ and _ are allowed as word-components in tags.
  13243. (modify-syntax-entry ?@ "w" stable)
  13244. (modify-syntax-entry ?_ "w" stable)
  13245. ;; Temporarily replace regexp-expressions in the match-expression.
  13246. (while (string-match "{.+?}" return-match)
  13247. (incf count)
  13248. (push (match-string 0 return-match) regexps-in-match)
  13249. (setq return-match (replace-match (format "<%d>" count) t nil return-match)))
  13250. (while (and taggroups-keys
  13251. (with-syntax-table stable
  13252. (string-match
  13253. (concat "\\(?1:[+-]?\\)\\(?2:\\<"
  13254. (regexp-opt taggroups-keys) "\\>\\)") return-match)))
  13255. (let* ((dir (match-string 1 return-match))
  13256. (tag (match-string 2 return-match))
  13257. (tag (if downcased (downcase tag) tag)))
  13258. (unless (or (get-text-property 0 'grouptag (match-string 2 return-match))
  13259. (member tag work-already-expanded))
  13260. (setq tags-in-group (assoc tag taggroups))
  13261. (push tag work-already-expanded)
  13262. ;; Recursively expand each tag in the group, if the tag hasn't
  13263. ;; already been expanded. Restore the match-data after all recursive calls.
  13264. (save-match-data
  13265. (let (tags-expanded)
  13266. (dolist (x (cdr tags-in-group))
  13267. (if (and (member x taggroups-keys)
  13268. (not (member x work-already-expanded)))
  13269. (setq tags-expanded
  13270. (delete-dups
  13271. (append
  13272. (org-tags-expand x t downcased
  13273. work-already-expanded)
  13274. tags-expanded)))
  13275. (setq tags-expanded
  13276. (append (list x) tags-expanded)))
  13277. (setq work-already-expanded
  13278. (delete-dups
  13279. (append tags-expanded
  13280. work-already-expanded))))
  13281. (setq tags-in-group
  13282. (delete-dups (cons (car tags-in-group)
  13283. tags-expanded)))))
  13284. ;; Filter tag-regexps from tags.
  13285. (setq regexp-in-group-escaped
  13286. (delq nil (mapcar (lambda (x)
  13287. (if (stringp x)
  13288. (and (equal "{" (substring x 0 1))
  13289. (equal "}" (substring x -1))
  13290. x)
  13291. x))
  13292. tags-in-group))
  13293. regexp-in-group
  13294. (mapcar (lambda (x)
  13295. (substring x 1 -1))
  13296. regexp-in-group-escaped)
  13297. tags-in-group
  13298. (delq nil (mapcar (lambda (x)
  13299. (if (stringp x)
  13300. (and (not (equal "{" (substring x 0 1)))
  13301. (not (equal "}" (substring x -1)))
  13302. x)
  13303. x))
  13304. tags-in-group)))
  13305. ;; If single-as-list, do no more in the while-loop.
  13306. (if (not single-as-list)
  13307. (progn
  13308. (when regexp-in-group
  13309. (setq regexp-in-group
  13310. (concat "\\|"
  13311. (mapconcat 'identity regexp-in-group
  13312. "\\|"))))
  13313. (setq tags-in-group
  13314. (concat dir
  13315. "{\\<"
  13316. (regexp-opt tags-in-group)
  13317. "\\>"
  13318. regexp-in-group
  13319. "}"))
  13320. (when (stringp tags-in-group)
  13321. (org-add-props tags-in-group '(grouptag t)))
  13322. (setq return-match
  13323. (replace-match tags-in-group t t return-match)))
  13324. (setq tags-in-group
  13325. (append regexp-in-group-escaped tags-in-group))))
  13326. (setq taggroups-keys (delete tag taggroups-keys))))
  13327. ;; Add the regular expressions back into the match-expression again.
  13328. (while regexps-in-match
  13329. (setq return-match (replace-regexp-in-string (format "<%d>" count)
  13330. (pop regexps-in-match)
  13331. return-match t t))
  13332. (decf count))
  13333. (if single-as-list
  13334. (if tags-in-group tags-in-group (list return-match))
  13335. return-match))
  13336. (if single-as-list
  13337. (list (if downcased (downcase match) match))
  13338. match)))
  13339. (defun org-op-to-function (op &optional stringp)
  13340. "Turn an operator into the appropriate function."
  13341. (setq op
  13342. (cond
  13343. ((equal op "<" ) '(< string< org-time<))
  13344. ((equal op ">" ) '(> org-string> org-time>))
  13345. ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
  13346. ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
  13347. ((member op '("=" "==")) '(= string= org-time=))
  13348. ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
  13349. (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
  13350. (defun org<> (a b) (not (= a b)))
  13351. (defun org-string<= (a b) (or (string= a b) (string< a b)))
  13352. (defun org-string>= (a b) (not (string< a b)))
  13353. (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
  13354. (defun org-string<> (a b) (not (string= a b)))
  13355. (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
  13356. (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
  13357. (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
  13358. (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
  13359. (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
  13360. (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
  13361. (defun org-2ft (s)
  13362. "Convert S to a floating point time.
  13363. If S is already a number, just return it. If it is a string, parse
  13364. it as a time string and apply `float-time' to it. If S is nil, just return 0."
  13365. (cond
  13366. ((numberp s) s)
  13367. ((stringp s)
  13368. (condition-case nil
  13369. (float-time (apply 'encode-time (org-parse-time-string s)))
  13370. (error 0.)))
  13371. (t 0.)))
  13372. (defun org-time-today ()
  13373. "Time in seconds today at 0:00.
  13374. Returns the float number of seconds since the beginning of the
  13375. epoch to the beginning of today (00:00)."
  13376. (float-time (apply 'encode-time
  13377. (append '(0 0 0) (nthcdr 3 (decode-time))))))
  13378. (defun org-matcher-time (s)
  13379. "Interpret a time comparison value."
  13380. (save-match-data
  13381. (cond
  13382. ((string= s "<now>") (float-time))
  13383. ((string= s "<today>") (org-time-today))
  13384. ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
  13385. ((string= s "<yesterday>") (- (org-time-today) 86400.0))
  13386. ((string-match "^<\\([-+][0-9]+\\)\\([hdwmy]\\)>$" s)
  13387. (+ (org-time-today)
  13388. (* (string-to-number (match-string 1 s))
  13389. (cdr (assoc (match-string 2 s)
  13390. '(("d" . 86400.0) ("w" . 604800.0)
  13391. ("m" . 2678400.0) ("y" . 31557600.0)))))))
  13392. (t (org-2ft s)))))
  13393. (defun org-match-any-p (re list)
  13394. "Does re match any element of list?"
  13395. (setq list (mapcar (lambda (x) (string-match re x)) list))
  13396. (delq nil list))
  13397. (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
  13398. (defvar org-tags-overlay (make-overlay 1 1))
  13399. (org-detach-overlay org-tags-overlay)
  13400. (defun org-get-local-tags-at (&optional pos)
  13401. "Get a list of tags defined in the current headline."
  13402. (org-get-tags-at pos 'local))
  13403. (defun org-get-local-tags ()
  13404. "Get a list of tags defined in the current headline."
  13405. (org-get-tags-at nil 'local))
  13406. (defun org-get-tags-at (&optional pos local)
  13407. "Get a list of all headline tags applicable at POS.
  13408. POS defaults to point. If tags are inherited, the list contains
  13409. the targets in the same sequence as the headlines appear, i.e.
  13410. the tags of the current headline come last.
  13411. When LOCAL is non-nil, only return tags from the current headline,
  13412. ignore inherited ones."
  13413. (interactive)
  13414. (if (and org-trust-scanner-tags
  13415. (or (not pos) (equal pos (point)))
  13416. (not local))
  13417. org-scanner-tags
  13418. (let (tags ltags lastpos parent)
  13419. (save-excursion
  13420. (save-restriction
  13421. (widen)
  13422. (goto-char (or pos (point)))
  13423. (save-match-data
  13424. (catch 'done
  13425. (condition-case nil
  13426. (progn
  13427. (org-back-to-heading t)
  13428. (while (not (equal lastpos (point)))
  13429. (setq lastpos (point))
  13430. (when (looking-at
  13431. (org-re "[^\r\n]+?:\\([[:alnum:]_@#%:]+\\):[ \t]*$"))
  13432. (setq ltags (org-split-string
  13433. (org-match-string-no-properties 1) ":"))
  13434. (when parent
  13435. (setq ltags (mapcar 'org-add-prop-inherited ltags)))
  13436. (setq tags (append
  13437. (if parent
  13438. (org-remove-uninherited-tags ltags)
  13439. ltags)
  13440. tags)))
  13441. (or org-use-tag-inheritance (throw 'done t))
  13442. (if local (throw 'done t))
  13443. (or (org-up-heading-safe) (error nil))
  13444. (setq parent t)))
  13445. (error nil)))))
  13446. (if local
  13447. tags
  13448. (reverse (delete-dups
  13449. (reverse (append
  13450. (org-remove-uninherited-tags
  13451. org-file-tags) tags)))))))))
  13452. (defun org-add-prop-inherited (s)
  13453. (add-text-properties 0 (length s) '(inherited t) s)
  13454. s)
  13455. (defun org-toggle-tag (tag &optional onoff)
  13456. "Toggle the tag TAG for the current line.
  13457. If ONOFF is `on' or `off', don't toggle but set to this state."
  13458. (let (res current)
  13459. (save-excursion
  13460. (org-back-to-heading t)
  13461. (if (re-search-forward (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t]*$")
  13462. (point-at-eol) t)
  13463. (progn
  13464. (setq current (match-string 1))
  13465. (replace-match ""))
  13466. (setq current ""))
  13467. (setq current (nreverse (org-split-string current ":")))
  13468. (cond
  13469. ((eq onoff 'on)
  13470. (setq res t)
  13471. (or (member tag current) (push tag current)))
  13472. ((eq onoff 'off)
  13473. (or (not (member tag current)) (setq current (delete tag current))))
  13474. (t (if (member tag current)
  13475. (setq current (delete tag current))
  13476. (setq res t)
  13477. (push tag current))))
  13478. (end-of-line 1)
  13479. (if current
  13480. (progn
  13481. (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
  13482. (org-set-tags nil t))
  13483. (delete-horizontal-space))
  13484. (run-hooks 'org-after-tags-change-hook))
  13485. res))
  13486. (defun org-align-tags-here (to-col)
  13487. ;; Assumes that this is a headline
  13488. "Align tags on the current headline to TO-COL."
  13489. (let ((pos (point)) (col (current-column)) ncol tags-l p)
  13490. (beginning-of-line 1)
  13491. (if (and (looking-at (org-re ".*?\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
  13492. (< pos (match-beginning 2)))
  13493. (progn
  13494. (setq tags-l (- (match-end 2) (match-beginning 2)))
  13495. (goto-char (match-beginning 1))
  13496. (insert " ")
  13497. (delete-region (point) (1+ (match-beginning 2)))
  13498. (setq ncol (max (current-column)
  13499. (1+ col)
  13500. (if (> to-col 0)
  13501. to-col
  13502. (- (abs to-col) tags-l))))
  13503. (setq p (point))
  13504. (insert (make-string (- ncol (current-column)) ?\ ))
  13505. (setq ncol (current-column))
  13506. (when indent-tabs-mode (tabify p (point-at-eol)))
  13507. (org-move-to-column (min ncol col)))
  13508. (goto-char pos))))
  13509. (defun org-set-tags-command (&optional arg just-align)
  13510. "Call the set-tags command for the current entry."
  13511. (interactive "P")
  13512. (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
  13513. (org-set-tags arg just-align)
  13514. (save-excursion
  13515. (unless (and (org-region-active-p)
  13516. org-loop-over-headlines-in-active-region)
  13517. (org-back-to-heading t))
  13518. (org-set-tags arg just-align))))
  13519. (defun org-set-tags-to (data)
  13520. "Set the tags of the current entry to DATA, replacing the current tags.
  13521. DATA may be a tags string like :aa:bb:cc:, or a list of tags.
  13522. If DATA is nil or the empty string, any tags will be removed."
  13523. (interactive "sTags: ")
  13524. (setq data
  13525. (cond
  13526. ((eq data nil) "")
  13527. ((equal data "") "")
  13528. ((stringp data)
  13529. (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
  13530. ":"))
  13531. ((listp data)
  13532. (concat ":" (mapconcat 'identity data ":") ":"))))
  13533. (when data
  13534. (save-excursion
  13535. (org-back-to-heading t)
  13536. (when (looking-at org-complex-heading-regexp)
  13537. (if (match-end 5)
  13538. (progn
  13539. (goto-char (match-beginning 5))
  13540. (insert data)
  13541. (delete-region (point) (point-at-eol))
  13542. (org-set-tags nil 'align))
  13543. (goto-char (point-at-eol))
  13544. (insert " " data)
  13545. (org-set-tags nil 'align)))
  13546. (beginning-of-line 1)
  13547. (if (looking-at ".*?\\([ \t]+\\)$")
  13548. (delete-region (match-beginning 1) (match-end 1))))))
  13549. (defun org-align-all-tags ()
  13550. "Align the tags i all headings."
  13551. (interactive)
  13552. (save-excursion
  13553. (or (ignore-errors (org-back-to-heading t))
  13554. (outline-next-heading))
  13555. (if (org-at-heading-p)
  13556. (org-set-tags t)
  13557. (message "No headings"))))
  13558. (defvar org-indent-indentation-per-level)
  13559. (defun org-set-tags (&optional arg just-align)
  13560. "Set the tags for the current headline.
  13561. With prefix ARG, realign all tags in headings in the current buffer.
  13562. When JUST-ALIGN is non-nil, only align tags."
  13563. (interactive "P")
  13564. (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
  13565. (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
  13566. 'region-start-level 'region))
  13567. org-loop-over-headlines-in-active-region)
  13568. (org-map-entries
  13569. ;; We don't use ARG and JUST-ALIGN here because these args
  13570. ;; are not useful when looping over headlines.
  13571. `(org-set-tags)
  13572. org-loop-over-headlines-in-active-region
  13573. cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
  13574. (let* ((re org-outline-regexp-bol)
  13575. (current (unless arg (org-get-tags-string)))
  13576. (col (current-column))
  13577. (org-setting-tags t)
  13578. table current-tags inherited-tags ; computed below when needed
  13579. tags p0 c0 c1 rpl di tc level)
  13580. (if arg
  13581. (save-excursion
  13582. (goto-char (point-min))
  13583. (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
  13584. (while (re-search-forward re nil t)
  13585. (org-set-tags nil t)
  13586. (end-of-line 1)))
  13587. (message "All tags realigned to column %d" org-tags-column))
  13588. (if just-align
  13589. (setq tags current)
  13590. ;; Get a new set of tags from the user
  13591. (save-excursion
  13592. (setq table (append org-tag-persistent-alist
  13593. (or org-tag-alist (org-get-buffer-tags))
  13594. (and
  13595. org-complete-tags-always-offer-all-agenda-tags
  13596. (org-global-tags-completion-table
  13597. (org-agenda-files))))
  13598. org-last-tags-completion-table table
  13599. current-tags (org-split-string current ":")
  13600. inherited-tags (nreverse
  13601. (nthcdr (length current-tags)
  13602. (nreverse (org-get-tags-at))))
  13603. tags
  13604. (if (or (eq t org-use-fast-tag-selection)
  13605. (and org-use-fast-tag-selection
  13606. (delq nil (mapcar 'cdr table))))
  13607. (org-fast-tag-selection
  13608. current-tags inherited-tags table
  13609. (if org-fast-tag-selection-include-todo
  13610. org-todo-key-alist))
  13611. (let ((org-add-colon-after-tag-completion (< 1 (length table))))
  13612. (org-trim
  13613. (org-icompleting-read "Tags: "
  13614. 'org-tags-completion-function
  13615. nil nil current 'org-tags-history))))))
  13616. (while (string-match "[-+&]+" tags)
  13617. ;; No boolean logic, just a list
  13618. (setq tags (replace-match ":" t t tags))))
  13619. (setq tags (replace-regexp-in-string "[,]" ":" tags))
  13620. (if org-tags-sort-function
  13621. (setq tags (mapconcat 'identity
  13622. (sort (org-split-string
  13623. tags (org-re "[^[:alnum:]_@#%]+"))
  13624. org-tags-sort-function) ":")))
  13625. (if (string-match "\\`[\t ]*\\'" tags)
  13626. (setq tags "")
  13627. (unless (string-match ":$" tags) (setq tags (concat tags ":")))
  13628. (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
  13629. ;; Insert new tags at the correct column
  13630. (beginning-of-line 1)
  13631. (setq level (or (and (looking-at org-outline-regexp)
  13632. (- (match-end 0) (point) 1))
  13633. 1))
  13634. (cond
  13635. ((and (equal current "") (equal tags "")))
  13636. ((re-search-forward
  13637. (concat "\\([ \t]*" (regexp-quote current) "\\)[ \t]*$")
  13638. (point-at-eol) t)
  13639. (if (equal tags "")
  13640. (setq rpl "")
  13641. (goto-char (match-beginning 0))
  13642. (setq c0 (current-column)
  13643. ;; compute offset for the case of org-indent-mode active
  13644. di (if (org-bound-and-true-p org-indent-mode)
  13645. (* (1- org-indent-indentation-per-level) (1- level))
  13646. 0)
  13647. p0 (if (equal (char-before) ?*) (1+ (point)) (point))
  13648. tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
  13649. c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (string-width tags))))
  13650. rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
  13651. (replace-match rpl t t)
  13652. (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
  13653. tags)
  13654. (t (error "Tags alignment failed")))
  13655. (org-move-to-column col)
  13656. (unless just-align
  13657. (run-hooks 'org-after-tags-change-hook))))))
  13658. (defun org-change-tag-in-region (beg end tag off)
  13659. "Add or remove TAG for each entry in the region.
  13660. This works in the agenda, and also in an org-mode buffer."
  13661. (interactive
  13662. (list (region-beginning) (region-end)
  13663. (let ((org-last-tags-completion-table
  13664. (if (derived-mode-p 'org-mode)
  13665. (org-uniquify
  13666. (delq nil (append (org-get-buffer-tags)
  13667. (org-global-tags-completion-table))))
  13668. (org-global-tags-completion-table))))
  13669. (org-icompleting-read
  13670. "Tag: " 'org-tags-completion-function nil nil nil
  13671. 'org-tags-history))
  13672. (progn
  13673. (message "[s]et or [r]emove? ")
  13674. (equal (read-char-exclusive) ?r))))
  13675. (if (fboundp 'deactivate-mark) (deactivate-mark))
  13676. (let ((agendap (equal major-mode 'org-agenda-mode))
  13677. l1 l2 m buf pos newhead (cnt 0))
  13678. (goto-char end)
  13679. (setq l2 (1- (org-current-line)))
  13680. (goto-char beg)
  13681. (setq l1 (org-current-line))
  13682. (loop for l from l1 to l2 do
  13683. (org-goto-line l)
  13684. (setq m (get-text-property (point) 'org-hd-marker))
  13685. (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
  13686. (and agendap m))
  13687. (setq buf (if agendap (marker-buffer m) (current-buffer))
  13688. pos (if agendap m (point)))
  13689. (with-current-buffer buf
  13690. (save-excursion
  13691. (save-restriction
  13692. (goto-char pos)
  13693. (setq cnt (1+ cnt))
  13694. (org-toggle-tag tag (if off 'off 'on))
  13695. (setq newhead (org-get-heading)))))
  13696. (and agendap (org-agenda-change-all-lines newhead m))))
  13697. (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
  13698. (defun org-tags-completion-function (string predicate &optional flag)
  13699. (let (s1 s2 rtn (ctable org-last-tags-completion-table)
  13700. (confirm (lambda (x) (stringp (car x)))))
  13701. (if (string-match "^\\(.*[-+:&,|]\\)\\([^-+:&,|]*\\)$" string)
  13702. (setq s1 (match-string 1 string)
  13703. s2 (match-string 2 string))
  13704. (setq s1 "" s2 string))
  13705. (cond
  13706. ((eq flag nil)
  13707. ;; try completion
  13708. (setq rtn (try-completion s2 ctable confirm))
  13709. (if (stringp rtn)
  13710. (setq rtn
  13711. (concat s1 s2 (substring rtn (length s2))
  13712. (if (and org-add-colon-after-tag-completion
  13713. (assoc rtn ctable))
  13714. ":" ""))))
  13715. rtn)
  13716. ((eq flag t)
  13717. ;; all-completions
  13718. (all-completions s2 ctable confirm))
  13719. ((eq flag 'lambda)
  13720. ;; exact match?
  13721. (assoc s2 ctable)))))
  13722. (defun org-fast-tag-insert (kwd tags face &optional end)
  13723. "Insert KDW, and the TAGS, the latter with face FACE.
  13724. Also insert END."
  13725. (insert (format "%-12s" (concat kwd ":"))
  13726. (org-add-props (mapconcat 'identity tags " ") nil 'face face)
  13727. (or end "")))
  13728. (defun org-fast-tag-show-exit (flag)
  13729. (save-excursion
  13730. (org-goto-line 3)
  13731. (if (re-search-forward "[ \t]+Next change exits" (point-at-eol) t)
  13732. (replace-match ""))
  13733. (when flag
  13734. (end-of-line 1)
  13735. (org-move-to-column (- (window-width) 19) t)
  13736. (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
  13737. (defun org-set-current-tags-overlay (current prefix)
  13738. "Add an overlay to CURRENT tag with PREFIX."
  13739. (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
  13740. (if (featurep 'xemacs)
  13741. (org-overlay-display org-tags-overlay (concat prefix s)
  13742. 'secondary-selection)
  13743. (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
  13744. (org-overlay-display org-tags-overlay (concat prefix s)))))
  13745. (defvar org-last-tag-selection-key nil)
  13746. (defun org-fast-tag-selection (current inherited table &optional todo-table)
  13747. "Fast tag selection with single keys.
  13748. CURRENT is the current list of tags in the headline, INHERITED is the
  13749. list of inherited tags, and TABLE is an alist of tags and corresponding keys,
  13750. possibly with grouping information. TODO-TABLE is a similar table with
  13751. TODO keywords, should these have keys assigned to them.
  13752. If the keys are nil, a-z are automatically assigned.
  13753. Returns the new tags string, or nil to not change the current settings."
  13754. (let* ((fulltable (append table todo-table))
  13755. (maxlen (apply 'max (mapcar
  13756. (lambda (x)
  13757. (if (stringp (car x)) (string-width (car x)) 0))
  13758. fulltable)))
  13759. (buf (current-buffer))
  13760. (expert (eq org-fast-tag-selection-single-key 'expert))
  13761. (buffer-tags nil)
  13762. (fwidth (+ maxlen 3 1 3))
  13763. (ncol (/ (- (window-width) 4) fwidth))
  13764. (i-face 'org-done)
  13765. (c-face 'org-todo)
  13766. tg cnt e c char c1 c2 ntable tbl rtn
  13767. ov-start ov-end ov-prefix
  13768. (exit-after-next org-fast-tag-selection-single-key)
  13769. (done-keywords org-done-keywords)
  13770. groups ingroup intaggroup)
  13771. (save-excursion
  13772. (beginning-of-line 1)
  13773. (if (looking-at
  13774. (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
  13775. (setq ov-start (match-beginning 1)
  13776. ov-end (match-end 1)
  13777. ov-prefix "")
  13778. (setq ov-start (1- (point-at-eol))
  13779. ov-end (1+ ov-start))
  13780. (skip-chars-forward "^\n\r")
  13781. (setq ov-prefix
  13782. (concat
  13783. (buffer-substring (1- (point)) (point))
  13784. (if (> (current-column) org-tags-column)
  13785. " "
  13786. (make-string (- org-tags-column (current-column)) ?\ ))))))
  13787. (move-overlay org-tags-overlay ov-start ov-end)
  13788. (save-window-excursion
  13789. (if expert
  13790. (set-buffer (get-buffer-create " *Org tags*"))
  13791. (delete-other-windows)
  13792. (set-window-buffer (split-window-vertically) (get-buffer-create " *Org tags*"))
  13793. (org-switch-to-buffer-other-window " *Org tags*"))
  13794. (erase-buffer)
  13795. (org-set-local 'org-done-keywords done-keywords)
  13796. (org-fast-tag-insert "Inherited" inherited i-face "\n")
  13797. (org-fast-tag-insert "Current" current c-face "\n\n")
  13798. (org-fast-tag-show-exit exit-after-next)
  13799. (org-set-current-tags-overlay current ov-prefix)
  13800. (setq tbl fulltable char ?a cnt 0)
  13801. (while (setq e (pop tbl))
  13802. (cond
  13803. ((eq (car e) :startgroup)
  13804. (push '() groups) (setq ingroup t)
  13805. (unless (zerop cnt)
  13806. (setq cnt 0)
  13807. (insert "\n"))
  13808. (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
  13809. ((eq (car e) :endgroup)
  13810. (setq ingroup nil cnt 0)
  13811. (insert "}" (if (cdr e) (format " (%s) " (cdr e)) "") "\n"))
  13812. ((eq (car e) :startgrouptag)
  13813. (setq intaggroup t)
  13814. (unless (zerop cnt)
  13815. (setq cnt 0)
  13816. (insert "\n"))
  13817. (insert "[ "))
  13818. ((eq (car e) :endgrouptag)
  13819. (setq intaggroup nil cnt 0)
  13820. (insert "]\n"))
  13821. ((equal e '(:newline))
  13822. (unless (zerop cnt)
  13823. (setq cnt 0)
  13824. (insert "\n")
  13825. (setq e (car tbl))
  13826. (while (equal (car tbl) '(:newline))
  13827. (insert "\n")
  13828. (setq tbl (cdr tbl)))))
  13829. ((equal e '(:grouptags)) (insert " : "))
  13830. (t
  13831. (setq tg (copy-sequence (car e)) c2 nil)
  13832. (if (cdr e)
  13833. (setq c (cdr e))
  13834. ;; automatically assign a character.
  13835. (setq c1 (string-to-char
  13836. (downcase (substring
  13837. tg (if (= (string-to-char tg) ?@) 1 0)))))
  13838. (if (or (rassoc c1 ntable) (rassoc c1 table))
  13839. (while (or (rassoc char ntable) (rassoc char table))
  13840. (setq char (1+ char)))
  13841. (setq c2 c1))
  13842. (setq c (or c2 char)))
  13843. (when ingroup (push tg (car groups)))
  13844. (setq tg (org-add-props tg nil 'face
  13845. (cond
  13846. ((not (assoc tg table))
  13847. (org-get-todo-face tg))
  13848. ((member tg current) c-face)
  13849. ((member tg inherited) i-face))))
  13850. (when (equal (caar tbl) :grouptags)
  13851. (org-add-props tg nil 'face 'org-tag-group))
  13852. (when (and (zerop cnt) (not ingroup) (not intaggroup)) (insert " "))
  13853. (insert "[" c "] " tg (make-string
  13854. (- fwidth 4 (length tg)) ?\ ))
  13855. (push (cons tg c) ntable)
  13856. (when (= (incf cnt) ncol)
  13857. (insert "\n")
  13858. (when (or ingroup intaggroup) (insert " "))
  13859. (setq cnt 0)))))
  13860. (setq ntable (nreverse ntable))
  13861. (insert "\n")
  13862. (goto-char (point-min))
  13863. (unless expert (org-fit-window-to-buffer))
  13864. (setq rtn
  13865. (catch 'exit
  13866. (while t
  13867. (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
  13868. (if (not groups) "no " "")
  13869. (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
  13870. (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
  13871. (setq org-last-tag-selection-key c)
  13872. (cond
  13873. ((= c ?\r) (throw 'exit t))
  13874. ((= c ?!)
  13875. (setq groups (not groups))
  13876. (goto-char (point-min))
  13877. (while (re-search-forward "[{}]" nil t) (replace-match " ")))
  13878. ((= c ?\C-c)
  13879. (if (not expert)
  13880. (org-fast-tag-show-exit
  13881. (setq exit-after-next (not exit-after-next)))
  13882. (setq expert nil)
  13883. (delete-other-windows)
  13884. (set-window-buffer (split-window-vertically) " *Org tags*")
  13885. (org-switch-to-buffer-other-window " *Org tags*")
  13886. (org-fit-window-to-buffer)))
  13887. ((or (= c ?\C-g)
  13888. (and (= c ?q) (not (rassoc c ntable))))
  13889. (org-detach-overlay org-tags-overlay)
  13890. (setq quit-flag t))
  13891. ((= c ?\ )
  13892. (setq current nil)
  13893. (when exit-after-next (setq exit-after-next 'now)))
  13894. ((= c ?\t)
  13895. (condition-case nil
  13896. (setq tg (org-icompleting-read
  13897. "Tag: "
  13898. (or buffer-tags
  13899. (with-current-buffer buf
  13900. (org-get-buffer-tags)))))
  13901. (quit (setq tg "")))
  13902. (when (string-match "\\S-" tg)
  13903. (add-to-list 'buffer-tags (list tg))
  13904. (if (member tg current)
  13905. (setq current (delete tg current))
  13906. (push tg current)))
  13907. (when exit-after-next (setq exit-after-next 'now)))
  13908. ((setq e (rassoc c todo-table) tg (car e))
  13909. (with-current-buffer buf
  13910. (save-excursion (org-todo tg)))
  13911. (when exit-after-next (setq exit-after-next 'now)))
  13912. ((setq e (rassoc c ntable) tg (car e))
  13913. (if (member tg current)
  13914. (setq current (delete tg current))
  13915. (loop for g in groups do
  13916. (when (member tg g)
  13917. (dolist (x g) (setq current (delete x current)))))
  13918. (push tg current))
  13919. (when exit-after-next (setq exit-after-next 'now))))
  13920. ;; Create a sorted list
  13921. (setq current
  13922. (sort current
  13923. (lambda (a b)
  13924. (assoc b (cdr (memq (assoc a ntable) ntable))))))
  13925. (when (eq exit-after-next 'now) (throw 'exit t))
  13926. (goto-char (point-min))
  13927. (beginning-of-line 2)
  13928. (delete-region (point) (point-at-eol))
  13929. (org-fast-tag-insert "Current" current c-face)
  13930. (org-set-current-tags-overlay current ov-prefix)
  13931. (while (re-search-forward
  13932. (org-re "\\[.\\] \\([[:alnum:]_@#%]+\\)") nil t)
  13933. (setq tg (match-string 1))
  13934. (add-text-properties
  13935. (match-beginning 1) (match-end 1)
  13936. (list 'face
  13937. (cond
  13938. ((member tg current) c-face)
  13939. ((member tg inherited) i-face)
  13940. (t (get-text-property (match-beginning 1) 'face))))))
  13941. (goto-char (point-min)))))
  13942. (org-detach-overlay org-tags-overlay)
  13943. (if rtn
  13944. (mapconcat 'identity current ":")
  13945. nil))))
  13946. (defun org-get-tags-string ()
  13947. "Get the TAGS string in the current headline."
  13948. (unless (org-at-heading-p t)
  13949. (user-error "Not on a heading"))
  13950. (save-excursion
  13951. (beginning-of-line 1)
  13952. (if (looking-at (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
  13953. (org-match-string-no-properties 1)
  13954. "")))
  13955. (defun org-get-tags ()
  13956. "Get the list of tags specified in the current headline."
  13957. (org-split-string (org-get-tags-string) ":"))
  13958. (defun org-get-buffer-tags ()
  13959. "Get a table of all tags used in the buffer, for completion."
  13960. (org-with-wide-buffer
  13961. (goto-char (point-min))
  13962. (let ((tag-re (concat org-outline-regexp-bol
  13963. "\\(?:.*?[ \t]\\)?"
  13964. (org-re ":\\([[:alnum:]_@#%:]+\\):[ \t]*$")))
  13965. tags)
  13966. (while (re-search-forward tag-re nil t)
  13967. (dolist (tag (org-split-string (org-match-string-no-properties 1) ":"))
  13968. (push tag tags)))
  13969. (mapcar #'list (append org-file-tags (org-uniquify tags))))))
  13970. ;;;; The mapping API
  13971. (defun org-map-entries (func &optional match scope &rest skip)
  13972. "Call FUNC at each headline selected by MATCH in SCOPE.
  13973. FUNC is a function or a lisp form. The function will be called without
  13974. arguments, with the cursor positioned at the beginning of the headline.
  13975. The return values of all calls to the function will be collected and
  13976. returned as a list.
  13977. The call to FUNC will be wrapped into a save-excursion form, so FUNC
  13978. does not need to preserve point. After evaluation, the cursor will be
  13979. moved to the end of the line (presumably of the headline of the
  13980. processed entry) and search continues from there. Under some
  13981. circumstances, this may not produce the wanted results. For example,
  13982. if you have removed (e.g. archived) the current (sub)tree it could
  13983. mean that the next entry will be skipped entirely. In such cases, you
  13984. can specify the position from where search should continue by making
  13985. FUNC set the variable `org-map-continue-from' to the desired buffer
  13986. position.
  13987. MATCH is a tags/property/todo match as it is used in the agenda tags view.
  13988. Only headlines that are matched by this query will be considered during
  13989. the iteration. When MATCH is nil or t, all headlines will be
  13990. visited by the iteration.
  13991. SCOPE determines the scope of this command. It can be any of:
  13992. nil The current buffer, respecting the restriction if any
  13993. tree The subtree started with the entry at point
  13994. region The entries within the active region, if any
  13995. region-start-level
  13996. The entries within the active region, but only those at
  13997. the same level than the first one.
  13998. file The current buffer, without restriction
  13999. file-with-archives
  14000. The current buffer, and any archives associated with it
  14001. agenda All agenda files
  14002. agenda-with-archives
  14003. All agenda files with any archive files associated with them
  14004. \(file1 file2 ...)
  14005. If this is a list, all files in the list will be scanned
  14006. The remaining args are treated as settings for the skipping facilities of
  14007. the scanner. The following items can be given here:
  14008. archive skip trees with the archive tag
  14009. comment skip trees with the COMMENT keyword
  14010. function or Emacs Lisp form:
  14011. will be used as value for `org-agenda-skip-function', so
  14012. whenever the function returns a position, FUNC will not be
  14013. called for that entry and search will continue from the
  14014. position returned
  14015. If your function needs to retrieve the tags including inherited tags
  14016. at the *current* entry, you can use the value of the variable
  14017. `org-scanner-tags' which will be much faster than getting the value
  14018. with `org-get-tags-at'. If your function gets properties with
  14019. `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
  14020. to t around the call to `org-entry-properties' to get the same speedup.
  14021. Note that if your function moves around to retrieve tags and properties at
  14022. a *different* entry, you cannot use these techniques."
  14023. (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
  14024. (not (org-region-active-p)))
  14025. (let* ((org-agenda-archives-mode nil) ; just to make sure
  14026. (org-agenda-skip-archived-trees (memq 'archive skip))
  14027. (org-agenda-skip-comment-trees (memq 'comment skip))
  14028. (org-agenda-skip-function
  14029. (car (org-delete-all '(comment archive) skip)))
  14030. (org-tags-match-list-sublevels t)
  14031. (start-level (eq scope 'region-start-level))
  14032. matcher file res
  14033. org-todo-keywords-for-agenda
  14034. org-done-keywords-for-agenda
  14035. org-todo-keyword-alist-for-agenda
  14036. org-tag-alist-for-agenda
  14037. todo-only)
  14038. (cond
  14039. ((eq match t) (setq matcher t))
  14040. ((eq match nil) (setq matcher t))
  14041. (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
  14042. (save-excursion
  14043. (save-restriction
  14044. (cond ((eq scope 'tree)
  14045. (org-back-to-heading t)
  14046. (org-narrow-to-subtree)
  14047. (setq scope nil))
  14048. ((and (or (eq scope 'region) (eq scope 'region-start-level))
  14049. (org-region-active-p))
  14050. ;; If needed, set start-level to a string like "2"
  14051. (when start-level
  14052. (save-excursion
  14053. (goto-char (region-beginning))
  14054. (unless (org-at-heading-p) (outline-next-heading))
  14055. (setq start-level (org-current-level))))
  14056. (narrow-to-region (region-beginning)
  14057. (save-excursion
  14058. (goto-char (region-end))
  14059. (unless (and (bolp) (org-at-heading-p))
  14060. (outline-next-heading))
  14061. (point)))
  14062. (setq scope nil)))
  14063. (if (not scope)
  14064. (progn
  14065. (org-agenda-prepare-buffers
  14066. (list (buffer-file-name (current-buffer))))
  14067. (setq res (org-scan-tags func matcher todo-only start-level)))
  14068. ;; Get the right scope
  14069. (cond
  14070. ((and scope (listp scope) (symbolp (car scope)))
  14071. (setq scope (eval scope)))
  14072. ((eq scope 'agenda)
  14073. (setq scope (org-agenda-files t)))
  14074. ((eq scope 'agenda-with-archives)
  14075. (setq scope (org-agenda-files t))
  14076. (setq scope (org-add-archive-files scope)))
  14077. ((eq scope 'file)
  14078. (setq scope (list (buffer-file-name))))
  14079. ((eq scope 'file-with-archives)
  14080. (setq scope (org-add-archive-files (list (buffer-file-name))))))
  14081. (org-agenda-prepare-buffers scope)
  14082. (while (setq file (pop scope))
  14083. (with-current-buffer (org-find-base-buffer-visiting file)
  14084. (save-excursion
  14085. (save-restriction
  14086. (widen)
  14087. (goto-char (point-min))
  14088. (setq res (append res (org-scan-tags func matcher todo-only))))))))))
  14089. res)))
  14090. ;;; Properties API
  14091. (defconst org-special-properties
  14092. '("ALLTAGS" "BLOCKED" "CLOCKSUM" "CLOCKSUM_T" "CLOSED" "DEADLINE" "FILE"
  14093. "ITEM" "PRIORITY" "SCHEDULED" "TAGS" "TIMESTAMP" "TIMESTAMP_IA" "TODO")
  14094. "The special properties valid in Org mode.
  14095. These are properties that are not defined in the property drawer,
  14096. but in some other way.")
  14097. (defconst org-default-properties
  14098. '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
  14099. "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
  14100. "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
  14101. "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
  14102. "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE" "UNNUMBERED"
  14103. "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
  14104. "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
  14105. "Some properties that are used by Org mode for various purposes.
  14106. Being in this list makes sure that they are offered for completion.")
  14107. (defun org--update-property-plist (key val props)
  14108. "Associate KEY to VAL in alist PROPS.
  14109. Modifications are made by side-effect. Return new alist."
  14110. (let* ((appending (string= (substring key -1) "+"))
  14111. (key (if appending (substring key 0 -1) key))
  14112. (old (assoc-string key props t)))
  14113. (if (not old) (cons (cons key val) props)
  14114. (setcdr old (if appending (concat (cdr old) " " val) val))
  14115. props)))
  14116. (defun org-get-property-block (&optional beg force)
  14117. "Return the (beg . end) range of the body of the property drawer.
  14118. BEG is the beginning of the current subtree, or of the part
  14119. before the first headline. If it is not given, it will be found.
  14120. If the drawer does not exist, create it if FORCE is non-nil, or
  14121. return nil."
  14122. (org-with-wide-buffer
  14123. (when beg (goto-char beg))
  14124. (unless (org-before-first-heading-p)
  14125. (let ((beg (cond (beg)
  14126. ((or (not (featurep 'org-inlinetask))
  14127. (org-inlinetask-in-task-p))
  14128. (org-back-to-heading t))
  14129. (t (org-with-limited-levels (org-back-to-heading t))))))
  14130. (forward-line)
  14131. (when (org-looking-at-p org-planning-line-re) (forward-line))
  14132. (cond ((looking-at org-property-drawer-re)
  14133. (forward-line)
  14134. (cons (point) (progn (goto-char (match-end 0))
  14135. (line-beginning-position))))
  14136. (force
  14137. (goto-char beg)
  14138. (org-insert-property-drawer)
  14139. (let ((pos (save-excursion (search-forward ":END:")
  14140. (line-beginning-position))))
  14141. (cons pos pos))))))))
  14142. (defun org-at-property-p ()
  14143. "Non-nil when point is inside a property drawer.
  14144. See `org-property-re' for match data, if applicable."
  14145. (save-excursion
  14146. (beginning-of-line)
  14147. (and (looking-at org-property-re)
  14148. (let ((property-drawer (save-match-data (org-get-property-block))))
  14149. (and property-drawer
  14150. (>= (point) (car property-drawer))
  14151. (< (point) (cdr property-drawer)))))))
  14152. (defun org-property-action ()
  14153. "Do an action on properties."
  14154. (interactive)
  14155. (unless (org-at-property-p) (user-error "Not at a property"))
  14156. (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
  14157. (let ((c (read-char-exclusive)))
  14158. (case c
  14159. (?s (call-interactively #'org-set-property))
  14160. (?d (call-interactively #'org-delete-property))
  14161. (?D (call-interactively #'org-delete-property-globally))
  14162. (?c (call-interactively #'org-compute-property-at-point))
  14163. (otherwise (user-error "No such property action %c" c)))))
  14164. (defun org-inc-effort ()
  14165. "Increment the value of the effort property in the current entry."
  14166. (interactive)
  14167. (org-set-effort nil t))
  14168. (defvar org-clock-effort) ; Defined in org-clock.el.
  14169. (defvar org-clock-current-task) ; Defined in org-clock.el.
  14170. (defun org-set-effort (&optional value increment)
  14171. "Set the effort property of the current entry.
  14172. With numerical prefix arg, use the nth allowed value, 0 stands for the
  14173. 10th allowed value.
  14174. When INCREMENT is non-nil, set the property to the next allowed value."
  14175. (interactive "P")
  14176. (if (equal value 0) (setq value 10))
  14177. (let* ((completion-ignore-case t)
  14178. (prop org-effort-property)
  14179. (cur (org-entry-get nil prop))
  14180. (allowed (org-property-get-allowed-values nil prop 'table))
  14181. (existing (mapcar 'list (org-property-values prop)))
  14182. (heading (nth 4 (org-heading-components)))
  14183. rpl
  14184. (val (cond
  14185. ((stringp value) value)
  14186. ((and allowed (integerp value))
  14187. (or (car (nth (1- value) allowed))
  14188. (car (org-last allowed))))
  14189. ((and allowed increment)
  14190. (or (caadr (member (list cur) allowed))
  14191. (user-error "Allowed effort values are not set")))
  14192. (allowed
  14193. (message "Select 1-9,0, [RET%s]: %s"
  14194. (if cur (concat "=" cur) "")
  14195. (mapconcat 'car allowed " "))
  14196. (setq rpl (read-char-exclusive))
  14197. (if (equal rpl ?\r)
  14198. cur
  14199. (setq rpl (- rpl ?0))
  14200. (if (equal rpl 0) (setq rpl 10))
  14201. (if (and (> rpl 0) (<= rpl (length allowed)))
  14202. (car (nth (1- rpl) allowed))
  14203. (org-completing-read "Effort: " allowed nil))))
  14204. (t
  14205. (let (org-completion-use-ido org-completion-use-iswitchb)
  14206. (org-completing-read
  14207. (concat "Effort " (if (and cur (string-match "\\S-" cur))
  14208. (concat "[" cur "]") "")
  14209. ": ")
  14210. existing nil nil "" nil cur))))))
  14211. (unless (equal (org-entry-get nil prop) val)
  14212. (org-entry-put nil prop val))
  14213. (org-refresh-property
  14214. '((effort . identity)
  14215. (effort-minutes . org-duration-string-to-minutes))
  14216. val)
  14217. (when (string= heading org-clock-current-task)
  14218. (setq org-clock-effort (get-text-property (point-at-bol) 'effort))
  14219. (org-clock-update-mode-line))
  14220. (message "%s is now %s" prop val)))
  14221. (defun org-entry-properties (&optional pom which)
  14222. "Get all properties of the current entry.
  14223. When POM is a buffer position, get all properties from the entry
  14224. there instead.
  14225. This includes the TODO keyword, the tags, time strings for
  14226. deadline, scheduled, and clocking, and any additional properties
  14227. defined in the entry.
  14228. If WHICH is nil or `all', get all properties. If WHICH is
  14229. `special' or `standard', only get that subclass. If WHICH is
  14230. a string, only get that property.
  14231. Return value is an alist. Keys are properties, as upcased
  14232. strings."
  14233. (org-with-point-at pom
  14234. (when (and (derived-mode-p 'org-mode)
  14235. (ignore-errors (org-back-to-heading t)))
  14236. (catch 'exit
  14237. (let* ((beg (point))
  14238. (specific (and (stringp which) (upcase which)))
  14239. (which (cond ((not specific) which)
  14240. ((member specific org-special-properties) 'special)
  14241. (t 'standard)))
  14242. props)
  14243. ;; Get the special properties, like TODO and TAGS.
  14244. (when (memq which '(nil all special))
  14245. (when (or (not specific) (string= specific "CLOCKSUM"))
  14246. (let ((clocksum (get-text-property (point) :org-clock-minutes)))
  14247. (when clocksum
  14248. (push (cons "CLOCKSUM"
  14249. (org-columns-number-to-string
  14250. (/ (float clocksum) 60.) 'add_times))
  14251. props)))
  14252. (when specific (throw 'exit props)))
  14253. (when (or (not specific) (string= specific "CLOCKSUM_T"))
  14254. (let ((clocksumt (get-text-property (point)
  14255. :org-clock-minutes-today)))
  14256. (when clocksumt
  14257. (push (cons "CLOCKSUM_T"
  14258. (org-columns-number-to-string
  14259. (/ (float clocksumt) 60.) 'add_times))
  14260. props)))
  14261. (when specific (throw 'exit props)))
  14262. (when (or (not specific) (string= specific "ITEM"))
  14263. (when (looking-at org-complex-heading-regexp)
  14264. (push (cons "ITEM"
  14265. (concat
  14266. (org-match-string-no-properties 1)
  14267. (let ((title (org-match-string-no-properties 4)))
  14268. (when (org-string-nw-p title)
  14269. (concat " " (org-remove-tabs title))))))
  14270. props))
  14271. (when specific (throw 'exit props)))
  14272. (when (or (not specific) (string= specific "TODO"))
  14273. (when (and (looking-at org-todo-line-regexp) (match-end 2))
  14274. (push (cons "TODO" (org-match-string-no-properties 2)) props))
  14275. (when specific (throw 'exit props)))
  14276. (when (or (not specific) (string= specific "PRIORITY"))
  14277. (when (looking-at org-priority-regexp)
  14278. (push (cons "PRIORITY" (org-match-string-no-properties 2))
  14279. props))
  14280. (when specific (throw 'exit props)))
  14281. (when (or (not specific) (string= specific "FILE"))
  14282. (push (cons "FILE" (buffer-file-name (buffer-base-buffer)))
  14283. props)
  14284. (when specific (throw 'exit props)))
  14285. (when (or (not specific) (string= specific "TAGS"))
  14286. (let ((value (org-string-nw-p (org-get-tags-string))))
  14287. (when value (push (cons "TAGS" value) props)))
  14288. (when specific (throw 'exit props)))
  14289. (when (or (not specific) (string= specific "ALLTAGS"))
  14290. (let ((value (org-get-tags-at)))
  14291. (when value
  14292. (push (cons "ALLTAGS"
  14293. (format ":%s:" (mapconcat #'identity value ":")))
  14294. props)))
  14295. (when specific (throw 'exit props)))
  14296. (when (or (not specific) (string= specific "BLOCKED"))
  14297. (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props)
  14298. (when specific (throw 'exit props)))
  14299. (when (or (not specific)
  14300. (member specific '("CLOSED" "DEADLINE" "SCHEDULED")))
  14301. (forward-line)
  14302. (when (org-looking-at-p org-planning-line-re)
  14303. (end-of-line)
  14304. (let ((bol (line-beginning-position))
  14305. ;; Backward compatibility: time keywords used to
  14306. ;; be configurable (before 8.3). Make sure we
  14307. ;; get the correct keyword.
  14308. (key-assoc `(("CLOSED" . ,org-closed-string)
  14309. ("DEADLINE" . ,org-deadline-string)
  14310. ("SCHEDULED" . ,org-scheduled-string))))
  14311. (dolist (pair (if specific (list (assoc specific key-assoc))
  14312. key-assoc))
  14313. (save-excursion
  14314. (when (search-backward (cdr pair) bol t)
  14315. (goto-char (match-end 0))
  14316. (skip-chars-forward " \t")
  14317. (and (looking-at org-ts-regexp-both)
  14318. (push (cons (car pair)
  14319. (org-match-string-no-properties 0))
  14320. props)))))))
  14321. (when specific (throw 'exit props)))
  14322. (when (or (not specific)
  14323. (member specific '("TIMESTAMP" "TIMESTAMP_IA")))
  14324. (let ((find-ts
  14325. (lambda (end ts)
  14326. (let ((regexp (cond
  14327. ((string= specific "TIMESTAMP")
  14328. org-ts-regexp)
  14329. ((string= specific "TIMESTAMP_IA")
  14330. org-ts-regexp-inactive)
  14331. ((assoc "TIMESTAMP_IA" ts)
  14332. org-ts-regexp)
  14333. ((assoc "TIMESTAMP" ts)
  14334. org-ts-regexp-inactive)
  14335. (t org-ts-regexp-both))))
  14336. (catch 'next
  14337. (while (re-search-forward regexp end t)
  14338. (backward-char)
  14339. (let ((object (org-element-context)))
  14340. ;; Accept to match timestamps in node
  14341. ;; properties, too.
  14342. (when (memq (org-element-type object)
  14343. '(node-property timestamp))
  14344. (let ((type
  14345. (org-element-property :type object)))
  14346. (cond
  14347. ((and (memq type '(active active-range))
  14348. (not (equal specific "TIMESTAMP_IA")))
  14349. (unless (assoc "TIMESTAMP" ts)
  14350. (push (cons "TIMESTAMP"
  14351. (org-element-property
  14352. :raw-value object))
  14353. ts)
  14354. (when specific (throw 'exit ts))))
  14355. ((and (memq type '(inactive inactive-range))
  14356. (not (string= specific "TIMESTAMP")))
  14357. (unless (assoc "TIMESTAMP_IA" ts)
  14358. (push (cons "TIMESTAMP_IA"
  14359. (org-element-property
  14360. :raw-value object))
  14361. ts)
  14362. (when specific (throw 'exit ts))))))
  14363. ;; Both timestamp types are found,
  14364. ;; move to next part.
  14365. (when (= (length ts) 2) (throw 'next ts)))))
  14366. ts)))))
  14367. (goto-char beg)
  14368. ;; First look for timestamps within headline.
  14369. (let ((ts (funcall find-ts (line-end-position) nil)))
  14370. (if (= (length ts) 2) (setq props (nconc ts props))
  14371. (forward-line)
  14372. ;; Then find timestamps in the section, skipping
  14373. ;; planning line.
  14374. (when (org-looking-at-p org-planning-line-re)
  14375. (forward-line))
  14376. (let ((end (save-excursion (outline-next-heading))))
  14377. (setq props (nconc (funcall find-ts end ts) props))))))))
  14378. ;; Get the standard properties, like :PROP:.
  14379. (when (memq which '(nil all standard))
  14380. ;; If we are looking after a specific property, delegate
  14381. ;; to `org-entry-get', which is faster. However, make an
  14382. ;; exception for "CATEGORY", since it can be also set
  14383. ;; through keywords (i.e. #+CATEGORY).
  14384. (if (and specific (not (equal specific "CATEGORY")))
  14385. (let ((value (org-entry-get beg specific nil t)))
  14386. (throw 'exit (and value (list (cons specific value)))))
  14387. (let ((range (org-get-property-block beg)))
  14388. (when range
  14389. (let ((end (cdr range)) seen-base)
  14390. (goto-char (car range))
  14391. ;; Unlike to `org--update-property-plist', we
  14392. ;; handle the case where base values is found
  14393. ;; after its extension. We also forbid standard
  14394. ;; properties to be named as special properties.
  14395. (while (re-search-forward org-property-re end t)
  14396. (let* ((key (upcase (org-match-string-no-properties 2)))
  14397. (extendp (org-string-match-p "\\+\\'" key))
  14398. (key-base (if extendp (substring key 0 -1) key))
  14399. (value (org-match-string-no-properties 3)))
  14400. (cond
  14401. ((member-ignore-case key-base org-special-properties))
  14402. (extendp
  14403. (setq props
  14404. (org--update-property-plist key value props)))
  14405. ((member key seen-base))
  14406. (t (push key seen-base)
  14407. (let ((p (assoc-string key props t)))
  14408. (if p (setcdr p (concat value " " (cdr p)))
  14409. (push (cons key value) props))))))))))))
  14410. (unless (assoc "CATEGORY" props)
  14411. (push (cons "CATEGORY" (org-get-category beg)) props)
  14412. (when (string= specific "CATEGORY") (throw 'exit props)))
  14413. ;; Return value.
  14414. (append (get-text-property beg 'org-summaries) props))))))
  14415. (defun org-entry-get (pom property &optional inherit literal-nil)
  14416. "Get value of PROPERTY for entry or content at point-or-marker POM.
  14417. If INHERIT is non-nil and the entry does not have the property,
  14418. then also check higher levels of the hierarchy. If INHERIT is
  14419. the symbol `selective', use inheritance only if the setting in
  14420. `org-use-property-inheritance' selects PROPERTY for inheritance.
  14421. If the property is present but empty, the return value is the
  14422. empty string. If the property is not present at all, nil is
  14423. returned. In any other case, return the value as a string.
  14424. Search is case-insensitive.
  14425. If LITERAL-NIL is set, return the string value \"nil\" as
  14426. a string, do not interpret it as the list atom nil. This is used
  14427. for inheritance when a \"nil\" value can supersede a non-nil
  14428. value higher up the hierarchy."
  14429. (org-with-point-at pom
  14430. (cond
  14431. ((member-ignore-case property (cons "CATEGORY" org-special-properties))
  14432. ;; We need a special property. Use `org-entry-properties' to
  14433. ;; retrieve it, but specify the wanted property.
  14434. (cdr (assoc-string property (org-entry-properties nil property))))
  14435. ((and inherit
  14436. (or (not (eq inherit 'selective)) (org-property-inherit-p property)))
  14437. (org-entry-get-with-inheritance property literal-nil))
  14438. (t
  14439. (let ((range (org-get-property-block)))
  14440. (when range
  14441. (let* ((case-fold-search t)
  14442. (end (cdr range))
  14443. (props
  14444. (let ((global
  14445. (or (assoc-string property org-file-properties t)
  14446. (assoc-string property org-global-properties t)
  14447. (assoc-string
  14448. property org-global-properties-fixed t))))
  14449. ;; Make sure to not re-use GLOBAL as
  14450. ;; `org--update-property-plist' would alter it by
  14451. ;; side-effect.
  14452. (and global (list (cons property (cdr global))))))
  14453. (find-value
  14454. (lambda (key)
  14455. (when (re-search-forward (org-re-property key nil t) end t)
  14456. (setq props
  14457. (org--update-property-plist
  14458. key (org-match-string-no-properties 3) props))))))
  14459. (goto-char (car range))
  14460. ;; Find base value.
  14461. (save-excursion (funcall find-value property))
  14462. ;; Find additional values.
  14463. (let ((property+ (concat property "+")))
  14464. (while (funcall find-value property+)))
  14465. ;; Return final value.
  14466. (let ((val (cdr (assoc-string property props t))))
  14467. (if literal-nil val (org-not-nil val))))))))))
  14468. (defun org-property-or-variable-value (var &optional inherit)
  14469. "Check if there is a property fixing the value of VAR.
  14470. If yes, return this value. If not, return the current value of the variable."
  14471. (let ((prop (org-entry-get nil (symbol-name var) inherit)))
  14472. (if (and prop (stringp prop) (string-match "\\S-" prop))
  14473. (read prop)
  14474. (symbol-value var))))
  14475. (defun org-entry-delete (pom property)
  14476. "Delete PROPERTY from entry at point-or-marker POM.
  14477. Accumulated properties, i.e. PROPERTY+, are also removed. Return
  14478. non-nil when a property was removed."
  14479. (unless (member property org-special-properties)
  14480. (org-with-point-at pom
  14481. (let ((range (org-get-property-block)))
  14482. (when range
  14483. (let* ((begin (car range))
  14484. (origin (cdr range))
  14485. (end (copy-marker origin))
  14486. (re (org-re-property
  14487. (concat (regexp-quote property) "\\+?") t t)))
  14488. (goto-char begin)
  14489. (while (re-search-forward re end t)
  14490. (delete-region (match-beginning 0) (line-beginning-position 2)))
  14491. ;; If drawer is empty, remove it altogether.
  14492. (when (= begin end)
  14493. (delete-region (line-beginning-position 0)
  14494. (line-beginning-position 2)))
  14495. ;; Return non-nil if some property was removed.
  14496. (prog1 (/= end origin) (set-marker end nil))))))))
  14497. ;; Multi-values properties are properties that contain multiple values
  14498. ;; These values are assumed to be single words, separated by whitespace.
  14499. (defun org-entry-add-to-multivalued-property (pom property value)
  14500. "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
  14501. (let* ((old (org-entry-get pom property))
  14502. (values (and old (org-split-string old "[ \t]"))))
  14503. (setq value (org-entry-protect-space value))
  14504. (unless (member value values)
  14505. (setq values (append values (list value)))
  14506. (org-entry-put pom property
  14507. (mapconcat 'identity values " ")))))
  14508. (defun org-entry-remove-from-multivalued-property (pom property value)
  14509. "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
  14510. (let* ((old (org-entry-get pom property))
  14511. (values (and old (org-split-string old "[ \t]"))))
  14512. (setq value (org-entry-protect-space value))
  14513. (when (member value values)
  14514. (setq values (delete value values))
  14515. (org-entry-put pom property
  14516. (mapconcat 'identity values " ")))))
  14517. (defun org-entry-member-in-multivalued-property (pom property value)
  14518. "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
  14519. (let* ((old (org-entry-get pom property))
  14520. (values (and old (org-split-string old "[ \t]"))))
  14521. (setq value (org-entry-protect-space value))
  14522. (member value values)))
  14523. (defun org-entry-get-multivalued-property (pom property)
  14524. "Return a list of values in a multivalued property."
  14525. (let* ((value (org-entry-get pom property))
  14526. (values (and value (org-split-string value "[ \t]"))))
  14527. (mapcar 'org-entry-restore-space values)))
  14528. (defun org-entry-put-multivalued-property (pom property &rest values)
  14529. "Set multivalued PROPERTY at point-or-marker POM to VALUES.
  14530. VALUES should be a list of strings. Spaces will be protected."
  14531. (org-entry-put pom property
  14532. (mapconcat 'org-entry-protect-space values " "))
  14533. (let* ((value (org-entry-get pom property))
  14534. (values (and value (org-split-string value "[ \t]"))))
  14535. (mapcar 'org-entry-restore-space values)))
  14536. (defun org-entry-protect-space (s)
  14537. "Protect spaces and newline in string S."
  14538. (while (string-match " " s)
  14539. (setq s (replace-match "%20" t t s)))
  14540. (while (string-match "\n" s)
  14541. (setq s (replace-match "%0A" t t s)))
  14542. s)
  14543. (defun org-entry-restore-space (s)
  14544. "Restore spaces and newline in string S."
  14545. (while (string-match "%20" s)
  14546. (setq s (replace-match " " t t s)))
  14547. (while (string-match "%0A" s)
  14548. (setq s (replace-match "\n" t t s)))
  14549. s)
  14550. (defvar org-entry-property-inherited-from (make-marker)
  14551. "Marker pointing to the entry from where a property was inherited.
  14552. Each call to `org-entry-get-with-inheritance' will set this marker to the
  14553. location of the entry where the inheritance search matched. If there was
  14554. no match, the marker will point nowhere.
  14555. Note that also `org-entry-get' calls this function, if the INHERIT flag
  14556. is set.")
  14557. (defun org-entry-get-with-inheritance (property &optional literal-nil)
  14558. "Get PROPERTY of entry or content at point, search higher levels if needed.
  14559. The search will stop at the first ancestor which has the property defined.
  14560. If the value found is \"nil\", return nil to show that the property
  14561. should be considered as undefined (this is the meaning of nil here).
  14562. However, if LITERAL-NIL is set, return the string value \"nil\" instead."
  14563. (move-marker org-entry-property-inherited-from nil)
  14564. (let (value)
  14565. (org-with-wide-buffer
  14566. (catch 'exit
  14567. (while t
  14568. (when (setq value (org-entry-get nil property nil literal-nil))
  14569. (org-back-to-heading t)
  14570. (move-marker org-entry-property-inherited-from (point))
  14571. (throw 'exit nil))
  14572. (or (org-up-heading-safe) (throw 'exit nil)))))
  14573. (unless value
  14574. (setq value
  14575. (cdr (or (assoc-string property org-file-properties t)
  14576. (assoc-string property org-global-properties t)
  14577. (assoc-string property org-global-properties-fixed t)))))
  14578. (if literal-nil value (org-not-nil value))))
  14579. (defvar org-property-changed-functions nil
  14580. "Hook called when the value of a property has changed.
  14581. Each hook function should accept two arguments, the name of the property
  14582. and the new value.")
  14583. (defun org-entry-put (pom property value)
  14584. "Set PROPERTY to VALUE for entry at point-or-marker POM.
  14585. If the value is `nil', it is converted to the empty string. If
  14586. it is not a string, an error is raised.
  14587. PROPERTY can be any regular property (see
  14588. `org-special-properties'). It can also be \"TODO\",
  14589. \"PRIORITY\", \"SCHEDULED\" and \"DEADLINE\".
  14590. For the last two properties, VALUE may have any of the special
  14591. values \"earlier\" and \"later\". The function then increases or
  14592. decreases scheduled or deadline date by one day."
  14593. (cond ((null value) (setq value ""))
  14594. ((not (stringp value)) (error "Properties values should be strings")))
  14595. (org-with-point-at pom
  14596. (if (or (not (featurep 'org-inlinetask)) (org-inlinetask-in-task-p))
  14597. (org-back-to-heading t)
  14598. (org-with-limited-levels (org-back-to-heading t)))
  14599. (let ((beg (point)))
  14600. (cond
  14601. ((equal property "TODO")
  14602. (cond ((not (org-string-nw-p value)) (setq value 'none))
  14603. ((not (member value org-todo-keywords-1))
  14604. (user-error "\"%s\" is not a valid TODO state" value)))
  14605. (org-todo value)
  14606. (org-set-tags nil 'align))
  14607. ((equal property "PRIORITY")
  14608. (org-priority (if (org-string-nw-p value) (string-to-char value) ?\s))
  14609. (org-set-tags nil 'align))
  14610. ((equal property "SCHEDULED")
  14611. (forward-line)
  14612. (if (and (org-looking-at-p org-planning-line-re)
  14613. (re-search-forward
  14614. org-scheduled-time-regexp (line-end-position) t))
  14615. (cond ((string= value "earlier") (org-timestamp-change -1 'day))
  14616. ((string= value "later") (org-timestamp-change 1 'day))
  14617. ((string= value "") (org-schedule '(4)))
  14618. (t (org-schedule nil value)))
  14619. (if (member value '("earlier" "later" ""))
  14620. (call-interactively #'org-schedule)
  14621. (org-schedule nil value))))
  14622. ((equal property "DEADLINE")
  14623. (forward-line)
  14624. (if (and (org-looking-at-p org-planning-line-re)
  14625. (re-search-forward
  14626. org-deadline-time-regexp (line-end-position) t))
  14627. (cond ((string= value "earlier") (org-timestamp-change -1 'day))
  14628. ((string= value "later") (org-timestamp-change 1 'day))
  14629. ((string= value "") (org-deadline '(4)))
  14630. (t (org-deadline nil value)))
  14631. (if (member value '("earlier" "later" ""))
  14632. (call-interactively #'org-deadline)
  14633. (org-deadline nil value))))
  14634. ((member property org-special-properties)
  14635. (error "The %s property cannot be set with `org-entry-put'" property))
  14636. (t
  14637. (let* ((range (org-get-property-block beg 'force))
  14638. (end (cdr range))
  14639. (case-fold-search t))
  14640. (goto-char (car range))
  14641. (if (re-search-forward (org-re-property property nil t) end t)
  14642. (progn (delete-region (match-beginning 0) (match-end 0))
  14643. (goto-char (match-beginning 0)))
  14644. (goto-char end)
  14645. (insert "\n")
  14646. (backward-char))
  14647. (insert ":" property ":")
  14648. (when value (insert " " value))
  14649. (org-indent-line)))))
  14650. (run-hook-with-args 'org-property-changed-functions property value)))
  14651. (defun org-buffer-property-keys (&optional specials defaults columns)
  14652. "Get all property keys in the current buffer.
  14653. When SPECIALS is non-nil, also list the special properties that
  14654. reflect things like tags and TODO state.
  14655. When DEFAULTS is non-nil, also include properties that has
  14656. special meaning internally: ARCHIVE, CATEGORY, SUMMARY,
  14657. DESCRIPTION, LOCATION, and LOGGING and others.
  14658. When COLUMNS in non-nil, also include property names given in
  14659. COLUMN formats in the current buffer."
  14660. (let ((case-fold-search t)
  14661. (props (append
  14662. (and specials org-special-properties)
  14663. (and defaults (cons org-effort-property org-default-properties))
  14664. nil)))
  14665. (org-with-wide-buffer
  14666. (goto-char (point-min))
  14667. (while (re-search-forward org-property-start-re nil t)
  14668. (let ((range (org-get-property-block)))
  14669. (catch 'skip
  14670. (unless range
  14671. (when (and (not (org-before-first-heading-p))
  14672. (y-or-n-p (format "Malformed drawer at %d, repair?"
  14673. (line-beginning-position))))
  14674. (org-get-property-block nil t))
  14675. (throw 'skip nil))
  14676. (goto-char (car range))
  14677. (let ((begin (car range))
  14678. (end (cdr range)))
  14679. ;; Make sure that found property block is not located
  14680. ;; before current point, as it would generate an infloop.
  14681. ;; It can happen, for example, in the following
  14682. ;; situation:
  14683. ;;
  14684. ;; * Headline
  14685. ;; :PROPERTIES:
  14686. ;; ...
  14687. ;; :END:
  14688. ;; *************** Inlinetask
  14689. ;; #+BEGIN_EXAMPLE
  14690. ;; :PROPERTIES:
  14691. ;; #+END_EXAMPLE
  14692. ;;
  14693. (if (< begin (point)) (throw 'skip nil) (goto-char begin))
  14694. (while (< (point) end)
  14695. (let ((p (progn (looking-at org-property-re)
  14696. (org-match-string-no-properties 2))))
  14697. ;; Only add true property name, not extension symbol.
  14698. (add-to-list 'props
  14699. (if (not (org-string-match-p "\\+\\'" p)) p
  14700. (substring p 0 -1))))
  14701. (forward-line))))
  14702. (outline-next-heading)))
  14703. (when columns
  14704. (goto-char (point-min))
  14705. (while (re-search-forward "^[ \t]*\\(?:#\\+\\|:\\)COLUMNS:" nil t)
  14706. (let ((element (org-element-at-point)))
  14707. (when (memq (org-element-type element) '(keyword node-property))
  14708. (let ((value (org-element-property :value element))
  14709. (start 0))
  14710. (while (string-match "%[0-9]*\\(\\S-+\\)" value start)
  14711. (setq start (match-end 0))
  14712. (let ((p (org-match-string-no-properties 1 value)))
  14713. (unless (member-ignore-case p org-special-properties)
  14714. (add-to-list 'props p))))))))))
  14715. (sort props (lambda (a b) (string< (upcase a) (upcase b))))))
  14716. (defun org-property-values (key)
  14717. "List all non-nil values of property KEY in current buffer."
  14718. (org-with-wide-buffer
  14719. (goto-char (point-min))
  14720. (let ((case-fold-search t)
  14721. (re (org-re-property key))
  14722. values)
  14723. (while (re-search-forward re nil t)
  14724. (add-to-list 'values (org-entry-get (point) key)))
  14725. values)))
  14726. (defun org-insert-property-drawer ()
  14727. "Insert a property drawer into the current entry."
  14728. (org-with-wide-buffer
  14729. (if (or (not (featurep 'org-inlinetask)) (org-inlinetask-in-task-p))
  14730. (org-back-to-heading t)
  14731. (org-with-limited-levels (org-back-to-heading t)))
  14732. (forward-line)
  14733. (when (org-looking-at-p org-planning-line-re) (forward-line))
  14734. (unless (org-looking-at-p org-property-drawer-re)
  14735. (let ((inhibit-read-only t))
  14736. (unless (bolp) (insert "\n"))
  14737. (let ((begin (point)))
  14738. (insert ":PROPERTIES:\n:END:\n")
  14739. (org-indent-region begin (point)))))))
  14740. (defun org-insert-drawer (&optional arg drawer)
  14741. "Insert a drawer at point.
  14742. When optional argument ARG is non-nil, insert a property drawer.
  14743. Optional argument DRAWER, when non-nil, is a string representing
  14744. drawer's name. Otherwise, the user is prompted for a name.
  14745. If a region is active, insert the drawer around that region
  14746. instead.
  14747. Point is left between drawer's boundaries."
  14748. (interactive "P")
  14749. (let* ((drawer (if arg "PROPERTIES"
  14750. (or drawer (read-from-minibuffer "Drawer: ")))))
  14751. (cond
  14752. ;; With C-u, fall back on `org-insert-property-drawer'
  14753. (arg (org-insert-property-drawer))
  14754. ;; Check validity of suggested drawer's name.
  14755. ((not (org-string-match-p org-drawer-regexp (format ":%s:" drawer)))
  14756. (user-error "Invalid drawer name"))
  14757. ;; With an active region, insert a drawer at point.
  14758. ((not (org-region-active-p))
  14759. (progn
  14760. (unless (bolp) (insert "\n"))
  14761. (insert (format ":%s:\n\n:END:\n" drawer))
  14762. (forward-line -2)))
  14763. ;; Otherwise, insert the drawer at point
  14764. (t
  14765. (let ((rbeg (region-beginning))
  14766. (rend (copy-marker (region-end))))
  14767. (unwind-protect
  14768. (progn
  14769. (goto-char rbeg)
  14770. (beginning-of-line)
  14771. (when (save-excursion
  14772. (re-search-forward org-outline-regexp-bol rend t))
  14773. (user-error "Drawers cannot contain headlines"))
  14774. ;; Position point at the beginning of the first
  14775. ;; non-blank line in region. Insert drawer's opening
  14776. ;; there, then indent it.
  14777. (org-skip-whitespace)
  14778. (beginning-of-line)
  14779. (insert ":" drawer ":\n")
  14780. (forward-line -1)
  14781. (indent-for-tab-command)
  14782. ;; Move point to the beginning of the first blank line
  14783. ;; after the last non-blank line in region. Insert
  14784. ;; drawer's closing, then indent it.
  14785. (goto-char rend)
  14786. (skip-chars-backward " \r\t\n")
  14787. (insert "\n:END:")
  14788. (deactivate-mark t)
  14789. (indent-for-tab-command)
  14790. (unless (eolp) (insert "\n")))
  14791. ;; Clear marker, whatever the outcome of insertion is.
  14792. (set-marker rend nil)))))))
  14793. (defvar org-property-set-functions-alist nil
  14794. "Property set function alist.
  14795. Each entry should have the following format:
  14796. (PROPERTY . READ-FUNCTION)
  14797. The read function will be called with the same argument as
  14798. `org-completing-read'.")
  14799. (defun org-set-property-function (property)
  14800. "Get the function that should be used to set PROPERTY.
  14801. This is computed according to `org-property-set-functions-alist'."
  14802. (or (cdr (assoc property org-property-set-functions-alist))
  14803. 'org-completing-read))
  14804. (defun org-read-property-value (property)
  14805. "Read PROPERTY value from user."
  14806. (let* ((completion-ignore-case t)
  14807. (allowed (org-property-get-allowed-values nil property 'table))
  14808. (cur (org-entry-get nil property))
  14809. (prompt (concat property " value"
  14810. (if (and cur (string-match "\\S-" cur))
  14811. (concat " [" cur "]") "") ": "))
  14812. (set-function (org-set-property-function property))
  14813. (val (if allowed
  14814. (funcall set-function prompt allowed nil
  14815. (not (get-text-property 0 'org-unrestricted
  14816. (caar allowed))))
  14817. (let (org-completion-use-ido org-completion-use-iswitchb)
  14818. (funcall set-function prompt
  14819. (mapcar 'list (org-property-values property))
  14820. nil nil "" nil cur)))))
  14821. (org-trim val)))
  14822. (defvar org-last-set-property nil)
  14823. (defvar org-last-set-property-value nil)
  14824. (defun org-read-property-name ()
  14825. "Read a property name."
  14826. (let ((completion-ignore-case t)
  14827. (default-prop (or (and (org-at-property-p)
  14828. (org-match-string-no-properties 2))
  14829. org-last-set-property)))
  14830. (org-completing-read
  14831. (concat "Property"
  14832. (if default-prop (concat " [" default-prop "]") "")
  14833. ": ")
  14834. (mapcar #'list (org-buffer-property-keys nil t t))
  14835. nil nil nil nil default-prop)))
  14836. (defun org-set-property-and-value (use-last)
  14837. "Allow to set [PROPERTY]: [value] direction from prompt.
  14838. When use-default, don't even ask, just use the last
  14839. \"[PROPERTY]: [value]\" string from the history."
  14840. (interactive "P")
  14841. (let* ((completion-ignore-case t)
  14842. (pv (or (and use-last org-last-set-property-value)
  14843. (org-completing-read
  14844. "Enter a \"[Property]: [value]\" pair: "
  14845. nil nil nil nil nil
  14846. org-last-set-property-value)))
  14847. prop val)
  14848. (when (string-match "^[ \t]*\\([^:]+\\):[ \t]*\\(.*\\)[ \t]*$" pv)
  14849. (setq prop (match-string 1 pv)
  14850. val (match-string 2 pv))
  14851. (org-set-property prop val))))
  14852. (defun org-set-property (property value)
  14853. "In the current entry, set PROPERTY to VALUE.
  14854. When called interactively, this will prompt for a property name, offering
  14855. completion on existing and default properties. And then it will prompt
  14856. for a value, offering completion either on allowed values (via an inherited
  14857. xxx_ALL property) or on existing values in other instances of this property
  14858. in the current file."
  14859. (interactive (list nil nil))
  14860. (let* ((property (or property (org-read-property-name)))
  14861. (value (or value (org-read-property-value property)))
  14862. (fn (cdr (assoc property org-properties-postprocess-alist))))
  14863. (setq org-last-set-property property)
  14864. (setq org-last-set-property-value (concat property ": " value))
  14865. ;; Possibly postprocess the inserted value:
  14866. (when fn (setq value (funcall fn value)))
  14867. (unless (equal (org-entry-get nil property) value)
  14868. (org-entry-put nil property value))))
  14869. (defun org-find-property (property &optional value)
  14870. "Find first entry in buffer that sets PROPERTY.
  14871. When optional argument VALUE is non-nil, only consider an entry
  14872. if it contains PROPERTY set to this value. If PROPERTY should be
  14873. explicitly set to nil, use string \"nil\" for VALUE.
  14874. Return position where the entry begins, or nil if there is no
  14875. such entry. If narrowing is in effect, only search the visible
  14876. part of the buffer."
  14877. (save-excursion
  14878. (goto-char (point-min))
  14879. (let ((case-fold-search t)
  14880. (re (org-re-property property nil (not value) value)))
  14881. (catch 'exit
  14882. (while (re-search-forward re nil t)
  14883. (when (if value (org-at-property-p)
  14884. (org-entry-get (point) property nil t))
  14885. (throw 'exit (progn (org-back-to-heading t) (point)))))))))
  14886. (defun org-delete-property (property)
  14887. "In the current entry, delete PROPERTY."
  14888. (interactive
  14889. (let* ((completion-ignore-case t)
  14890. (cat (org-entry-get (point) "CATEGORY"))
  14891. (props0 (org-entry-properties nil 'standard))
  14892. (props (if cat props0
  14893. (delete `("CATEGORY" . ,(org-get-category)) props0)))
  14894. (prop (if (< 1 (length props))
  14895. (org-icompleting-read "Property: " props nil t)
  14896. (caar props))))
  14897. (list prop)))
  14898. (if (not property)
  14899. (message "No property to delete in this entry")
  14900. (org-entry-delete nil property)
  14901. (message "Property \"%s\" deleted" property)))
  14902. (defun org-delete-property-globally (property)
  14903. "Remove PROPERTY globally, from all entries.
  14904. This function ignores narrowing, if any."
  14905. (interactive
  14906. (let* ((completion-ignore-case t)
  14907. (prop (org-icompleting-read
  14908. "Globally remove property: "
  14909. (mapcar #'list (org-buffer-property-keys)))))
  14910. (list prop)))
  14911. (org-with-wide-buffer
  14912. (goto-char (point-min))
  14913. (let ((count 0)
  14914. (re (org-re-property (concat (regexp-quote property) "\\+?") t t)))
  14915. (while (re-search-forward re nil t)
  14916. (when (org-entry-delete (point) property) (incf count)))
  14917. (message "Property \"%s\" removed from %d entries" property count))))
  14918. (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
  14919. (defun org-compute-property-at-point ()
  14920. "Compute the property at point.
  14921. This looks for an enclosing column format, extracts the operator and
  14922. then applies it to the property in the column format's scope."
  14923. (interactive)
  14924. (unless (org-at-property-p)
  14925. (user-error "Not at a property"))
  14926. (let ((prop (org-match-string-no-properties 2)))
  14927. (org-columns-get-format-and-top-level)
  14928. (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
  14929. (user-error "No operator defined for property %s" prop))
  14930. (org-columns-compute prop)))
  14931. (defvar org-property-allowed-value-functions nil
  14932. "Hook for functions supplying allowed values for a specific property.
  14933. The functions must take a single argument, the name of the property, and
  14934. return a flat list of allowed values. If \":ETC\" is one of
  14935. the values, this means that these values are intended as defaults for
  14936. completion, but that other values should be allowed too.
  14937. The functions must return nil if they are not responsible for this
  14938. property.")
  14939. (defun org-property-get-allowed-values (pom property &optional table)
  14940. "Get allowed values for the property PROPERTY.
  14941. When TABLE is non-nil, return an alist that can directly be used for
  14942. completion."
  14943. (let (vals)
  14944. (cond
  14945. ((equal property "TODO")
  14946. (setq vals (org-with-point-at pom
  14947. (append org-todo-keywords-1 '("")))))
  14948. ((equal property "PRIORITY")
  14949. (let ((n org-lowest-priority))
  14950. (while (>= n org-highest-priority)
  14951. (push (char-to-string n) vals)
  14952. (setq n (1- n)))))
  14953. ((equal property "CATEGORY"))
  14954. ((member property org-special-properties))
  14955. ((setq vals (run-hook-with-args-until-success
  14956. 'org-property-allowed-value-functions property)))
  14957. (t
  14958. (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
  14959. (when (and vals (string-match "\\S-" vals))
  14960. (setq vals (car (read-from-string (concat "(" vals ")"))))
  14961. (setq vals (mapcar (lambda (x)
  14962. (cond ((stringp x) x)
  14963. ((numberp x) (number-to-string x))
  14964. ((symbolp x) (symbol-name x))
  14965. (t "???")))
  14966. vals)))))
  14967. (when (member ":ETC" vals)
  14968. (setq vals (remove ":ETC" vals))
  14969. (org-add-props (car vals) '(org-unrestricted t)))
  14970. (if table (mapcar 'list vals) vals)))
  14971. (defun org-property-previous-allowed-value (&optional previous)
  14972. "Switch to the next allowed value for this property."
  14973. (interactive)
  14974. (org-property-next-allowed-value t))
  14975. (defun org-property-next-allowed-value (&optional previous)
  14976. "Switch to the next allowed value for this property."
  14977. (interactive)
  14978. (unless (org-at-property-p)
  14979. (user-error "Not at a property"))
  14980. (let* ((prop (car (save-match-data (org-split-string (match-string 1) ":"))))
  14981. (key (match-string 2))
  14982. (value (match-string 3))
  14983. (allowed (or (org-property-get-allowed-values (point) key)
  14984. (and (member value '("[ ]" "[-]" "[X]"))
  14985. '("[ ]" "[X]"))))
  14986. (heading (save-match-data (nth 4 (org-heading-components))))
  14987. nval)
  14988. (unless allowed
  14989. (user-error "Allowed values for this property have not been defined"))
  14990. (if previous (setq allowed (reverse allowed)))
  14991. (if (member value allowed)
  14992. (setq nval (car (cdr (member value allowed)))))
  14993. (setq nval (or nval (car allowed)))
  14994. (if (equal nval value)
  14995. (user-error "Only one allowed value for this property"))
  14996. (org-at-property-p)
  14997. (replace-match (concat " :" key ": " nval) t t)
  14998. (org-indent-line)
  14999. (beginning-of-line 1)
  15000. (skip-chars-forward " \t")
  15001. (when (equal prop org-effort-property)
  15002. (org-refresh-property
  15003. '((effort . identity)
  15004. (effort-minutes . org-duration-string-to-minutes))
  15005. nval)
  15006. (when (string= org-clock-current-task heading)
  15007. (setq org-clock-effort nval)
  15008. (org-clock-update-mode-line)))
  15009. (run-hook-with-args 'org-property-changed-functions key nval)))
  15010. (defun org-find-olp (path &optional this-buffer)
  15011. "Return a marker pointing to the entry at outline path OLP.
  15012. If anything goes wrong, throw an error.
  15013. You can wrap this call to catch the error like this:
  15014. (condition-case msg
  15015. (org-mobile-locate-entry (match-string 4))
  15016. (error (nth 1 msg)))
  15017. The return value will then be either a string with the error message,
  15018. or a marker if everything is OK.
  15019. If THIS-BUFFER is set, the outline path does not contain a file,
  15020. only headings."
  15021. (let* ((file (if this-buffer buffer-file-name (pop path)))
  15022. (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
  15023. (level 1)
  15024. (lmin 1)
  15025. (lmax 1)
  15026. limit re end found pos heading cnt flevel)
  15027. (unless buffer (error "File not found :%s" file))
  15028. (with-current-buffer buffer
  15029. (save-excursion
  15030. (save-restriction
  15031. (widen)
  15032. (setq limit (point-max))
  15033. (goto-char (point-min))
  15034. (while (setq heading (pop path))
  15035. (setq re (format org-complex-heading-regexp-format
  15036. (regexp-quote heading)))
  15037. (setq cnt 0 pos (point))
  15038. (while (re-search-forward re end t)
  15039. (setq level (- (match-end 1) (match-beginning 1)))
  15040. (if (and (>= level lmin) (<= level lmax))
  15041. (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
  15042. (when (= cnt 0) (error "Heading not found on level %d: %s"
  15043. lmax heading))
  15044. (when (> cnt 1) (error "Heading not unique on level %d: %s"
  15045. lmax heading))
  15046. (goto-char found)
  15047. (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
  15048. (setq end (save-excursion (org-end-of-subtree t t))))
  15049. (when (org-at-heading-p)
  15050. (point-marker)))))))
  15051. (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
  15052. "Find node HEADING in BUFFER.
  15053. Return a marker to the heading if it was found, or nil if not.
  15054. If POS-ONLY is set, return just the position instead of a marker.
  15055. The heading text must match exact, but it may have a TODO keyword,
  15056. a priority cookie and tags in the standard locations."
  15057. (with-current-buffer (or buffer (current-buffer))
  15058. (save-excursion
  15059. (save-restriction
  15060. (widen)
  15061. (goto-char (point-min))
  15062. (let (case-fold-search)
  15063. (if (re-search-forward
  15064. (format org-complex-heading-regexp-format
  15065. (regexp-quote heading)) nil t)
  15066. (if pos-only
  15067. (match-beginning 0)
  15068. (move-marker (make-marker) (match-beginning 0)))))))))
  15069. (defun org-find-exact-heading-in-directory (heading &optional dir)
  15070. "Find Org node headline HEADING in all .org files in directory DIR.
  15071. When the target headline is found, return a marker to this location."
  15072. (let ((files (directory-files (or dir default-directory)
  15073. t "\\`[^.#].*\\.org\\'"))
  15074. file visiting m buffer)
  15075. (catch 'found
  15076. (while (setq file (pop files))
  15077. (message "trying %s" file)
  15078. (setq visiting (org-find-base-buffer-visiting file))
  15079. (setq buffer (or visiting (find-file-noselect file)))
  15080. (setq m (org-find-exact-headline-in-buffer
  15081. heading buffer))
  15082. (when (and (not m) (not visiting)) (kill-buffer buffer))
  15083. (and m (throw 'found m))))))
  15084. (defun org-find-entry-with-id (ident)
  15085. "Locate the entry that contains the ID property with exact value IDENT.
  15086. IDENT can be a string, a symbol or a number, this function will search for
  15087. the string representation of it.
  15088. Return the position where this entry starts, or nil if there is no such entry."
  15089. (interactive "sID: ")
  15090. (let ((id (cond
  15091. ((stringp ident) ident)
  15092. ((symbolp ident) (symbol-name ident))
  15093. ((numberp ident) (number-to-string ident))
  15094. (t (error "IDENT %s must be a string, symbol or number" ident)))))
  15095. (org-with-wide-buffer (org-find-property "ID" id))))
  15096. ;;;; Timestamps
  15097. (defvar org-last-changed-timestamp nil)
  15098. (defvar org-last-inserted-timestamp nil
  15099. "The last time stamp inserted with `org-insert-time-stamp'.")
  15100. (defvar org-ts-what) ; dynamically scoped parameter
  15101. (defun org-time-stamp (arg &optional inactive)
  15102. "Prompt for a date/time and insert a time stamp.
  15103. If the user specifies a time like HH:MM or if this command is
  15104. called with at least one prefix argument, the time stamp contains
  15105. the date and the time. Otherwise, only the date is included.
  15106. All parts of a date not specified by the user are filled in from
  15107. the timestamp at point, if any, or the current date/time
  15108. otherwise.
  15109. If there is already a timestamp at the cursor, it is replaced.
  15110. With two universal prefix arguments, insert an active timestamp
  15111. with the current time without prompting the user.
  15112. When called from lisp, the timestamp is inactive if INACTIVE is
  15113. non-nil."
  15114. (interactive "P")
  15115. (let* ((ts
  15116. (cond ((org-at-date-range-p t)
  15117. (save-excursion
  15118. (goto-char (match-beginning 0))
  15119. (looking-at (if inactive org-ts-regexp-both org-ts-regexp)))
  15120. (match-string 0))
  15121. ((org-at-timestamp-p t) (match-string 0))))
  15122. ;; Default time is either the timestamp at point or today.
  15123. ;; When entering a range, only the range start is considered.
  15124. (default-time (if (not ts) (current-time)
  15125. (apply #'encode-time (org-parse-time-string ts))))
  15126. (default-input (and ts (org-get-compact-tod ts)))
  15127. (repeater (and ts
  15128. (string-match "\\([.+-]+[0-9]+[hdwmy] ?\\)+" ts)
  15129. (match-string 0 ts)))
  15130. org-time-was-given
  15131. org-end-time-was-given
  15132. (time
  15133. (and (if (equal arg '(16)) (current-time)
  15134. ;; Preserve `this-command' and `last-command'.
  15135. (let ((this-command this-command)
  15136. (last-command last-command))
  15137. (org-read-date
  15138. arg 'totime nil nil default-time default-input
  15139. inactive))))))
  15140. (cond
  15141. ((and ts
  15142. (memq last-command '(org-time-stamp org-time-stamp-inactive))
  15143. (memq this-command '(org-time-stamp org-time-stamp-inactive)))
  15144. (insert "--")
  15145. (org-insert-time-stamp time (or org-time-was-given arg) inactive))
  15146. (ts
  15147. ;; Make sure we're on a timestamp. When in the middle of a date
  15148. ;; range, move arbitrarily to range end.
  15149. (unless (org-at-timestamp-p t)
  15150. (skip-chars-forward "-")
  15151. (org-at-timestamp-p t))
  15152. (replace-match "")
  15153. (setq org-last-changed-timestamp
  15154. (org-insert-time-stamp
  15155. time (or org-time-was-given arg)
  15156. inactive nil nil (list org-end-time-was-given)))
  15157. (when repeater
  15158. (backward-char)
  15159. (insert " " repeater)
  15160. (setq org-last-changed-timestamp
  15161. (concat (substring org-last-inserted-timestamp 0 -1)
  15162. " " repeater ">")))
  15163. (message "Timestamp updated"))
  15164. ((equal arg '(16)) (org-insert-time-stamp time t inactive))
  15165. (t (org-insert-time-stamp
  15166. time (or org-time-was-given arg) inactive nil nil
  15167. (list org-end-time-was-given))))))
  15168. ;; FIXME: can we use this for something else, like computing time differences?
  15169. (defun org-get-compact-tod (s)
  15170. (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
  15171. (let* ((t1 (match-string 1 s))
  15172. (h1 (string-to-number (match-string 2 s)))
  15173. (m1 (string-to-number (match-string 3 s)))
  15174. (t2 (and (match-end 4) (match-string 5 s)))
  15175. (h2 (and t2 (string-to-number (match-string 6 s))))
  15176. (m2 (and t2 (string-to-number (match-string 7 s))))
  15177. dh dm)
  15178. (if (not t2)
  15179. t1
  15180. (setq dh (- h2 h1) dm (- m2 m1))
  15181. (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
  15182. (concat t1 "+" (number-to-string dh)
  15183. (and (/= 0 dm) (format ":%02d" dm)))))))
  15184. (defun org-time-stamp-inactive (&optional arg)
  15185. "Insert an inactive time stamp.
  15186. An inactive time stamp is enclosed in square brackets instead of angle
  15187. brackets. It is inactive in the sense that it does not trigger agenda entries,
  15188. does not link to the calendar and cannot be changed with the S-cursor keys.
  15189. So these are more for recording a certain time/date."
  15190. (interactive "P")
  15191. (org-time-stamp arg 'inactive))
  15192. (defvar org-date-ovl (make-overlay 1 1))
  15193. (overlay-put org-date-ovl 'face 'org-date-selected)
  15194. (org-detach-overlay org-date-ovl)
  15195. (defvar org-ans1) ; dynamically scoped parameter
  15196. (defvar org-ans2) ; dynamically scoped parameter
  15197. (defvar org-plain-time-of-day-regexp) ; defined below
  15198. (defvar org-overriding-default-time nil) ; dynamically scoped
  15199. (defvar org-read-date-overlay nil)
  15200. (defvar org-dcst nil) ; dynamically scoped
  15201. (defvar org-read-date-history nil)
  15202. (defvar org-read-date-final-answer nil)
  15203. (defvar org-read-date-analyze-futurep nil)
  15204. (defvar org-read-date-analyze-forced-year nil)
  15205. (defvar org-read-date-inactive)
  15206. (defvar org-read-date-minibuffer-local-map
  15207. (let* ((map (make-sparse-keymap)))
  15208. (set-keymap-parent map minibuffer-local-map)
  15209. (org-defkey map (kbd ".")
  15210. (lambda () (interactive)
  15211. ;; Are we at the beginning of the prompt?
  15212. (if (looking-back "^[^:]+: ")
  15213. (org-eval-in-calendar '(calendar-goto-today))
  15214. (insert "."))))
  15215. (org-defkey map (kbd "C-.")
  15216. (lambda () (interactive)
  15217. (org-eval-in-calendar '(calendar-goto-today))))
  15218. (org-defkey map [(meta shift left)]
  15219. (lambda () (interactive)
  15220. (org-eval-in-calendar '(calendar-backward-month 1))))
  15221. (org-defkey map [(meta shift right)]
  15222. (lambda () (interactive)
  15223. (org-eval-in-calendar '(calendar-forward-month 1))))
  15224. (org-defkey map [(meta shift up)]
  15225. (lambda () (interactive)
  15226. (org-eval-in-calendar '(calendar-backward-year 1))))
  15227. (org-defkey map [(meta shift down)]
  15228. (lambda () (interactive)
  15229. (org-eval-in-calendar '(calendar-forward-year 1))))
  15230. (org-defkey map [?\e (shift left)]
  15231. (lambda () (interactive)
  15232. (org-eval-in-calendar '(calendar-backward-month 1))))
  15233. (org-defkey map [?\e (shift right)]
  15234. (lambda () (interactive)
  15235. (org-eval-in-calendar '(calendar-forward-month 1))))
  15236. (org-defkey map [?\e (shift up)]
  15237. (lambda () (interactive)
  15238. (org-eval-in-calendar '(calendar-backward-year 1))))
  15239. (org-defkey map [?\e (shift down)]
  15240. (lambda () (interactive)
  15241. (org-eval-in-calendar '(calendar-forward-year 1))))
  15242. (org-defkey map [(shift up)]
  15243. (lambda () (interactive)
  15244. (org-eval-in-calendar '(calendar-backward-week 1))))
  15245. (org-defkey map [(shift down)]
  15246. (lambda () (interactive)
  15247. (org-eval-in-calendar '(calendar-forward-week 1))))
  15248. (org-defkey map [(shift left)]
  15249. (lambda () (interactive)
  15250. (org-eval-in-calendar '(calendar-backward-day 1))))
  15251. (org-defkey map [(shift right)]
  15252. (lambda () (interactive)
  15253. (org-eval-in-calendar '(calendar-forward-day 1))))
  15254. (org-defkey map "!"
  15255. (lambda () (interactive)
  15256. (org-eval-in-calendar '(diary-view-entries))
  15257. (message "")))
  15258. (org-defkey map ">"
  15259. (lambda () (interactive)
  15260. (org-eval-in-calendar '(calendar-scroll-left 1))))
  15261. (org-defkey map "<"
  15262. (lambda () (interactive)
  15263. (org-eval-in-calendar '(calendar-scroll-right 1))))
  15264. (org-defkey map "\C-v"
  15265. (lambda () (interactive)
  15266. (org-eval-in-calendar
  15267. '(calendar-scroll-left-three-months 1))))
  15268. (org-defkey map "\M-v"
  15269. (lambda () (interactive)
  15270. (org-eval-in-calendar
  15271. '(calendar-scroll-right-three-months 1))))
  15272. map)
  15273. "Keymap for minibuffer commands when using `org-read-date'.")
  15274. (defvar org-def)
  15275. (defvar org-defdecode)
  15276. (defvar org-with-time)
  15277. (defun org-read-date (&optional org-with-time to-time from-string prompt
  15278. default-time default-input inactive)
  15279. "Read a date, possibly a time, and make things smooth for the user.
  15280. The prompt will suggest to enter an ISO date, but you can also enter anything
  15281. which will at least partially be understood by `parse-time-string'.
  15282. Unrecognized parts of the date will default to the current day, month, year,
  15283. hour and minute. If this command is called to replace a timestamp at point,
  15284. or to enter the second timestamp of a range, the default time is taken
  15285. from the existing stamp. Furthermore, the command prefers the future,
  15286. so if you are giving a date where the year is not given, and the day-month
  15287. combination is already past in the current year, it will assume you
  15288. mean next year. For details, see the manual. A few examples:
  15289. 3-2-5 --> 2003-02-05
  15290. feb 15 --> currentyear-02-15
  15291. 2/15 --> currentyear-02-15
  15292. sep 12 9 --> 2009-09-12
  15293. 12:45 --> today 12:45
  15294. 22 sept 0:34 --> currentyear-09-22 0:34
  15295. 12 --> currentyear-currentmonth-12
  15296. Fri --> nearest Friday after today
  15297. -Tue --> last Tuesday
  15298. etc.
  15299. Furthermore you can specify a relative date by giving, as the *first* thing
  15300. in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
  15301. change in days weeks, months, years.
  15302. With a single plus or minus, the date is relative to today. With a double
  15303. plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
  15304. +4d --> four days from today
  15305. +4 --> same as above
  15306. +2w --> two weeks from today
  15307. ++5 --> five days from default date
  15308. The function understands only English month and weekday abbreviations.
  15309. While prompting, a calendar is popped up - you can also select the
  15310. date with the mouse (button 1). The calendar shows a period of three
  15311. months. To scroll it to other months, use the keys `>' and `<'.
  15312. If you don't like the calendar, turn it off with
  15313. \(setq org-read-date-popup-calendar nil)
  15314. With optional argument TO-TIME, the date will immediately be converted
  15315. to an internal time.
  15316. With an optional argument ORG-WITH-TIME, the prompt will suggest to
  15317. also insert a time. Note that when ORG-WITH-TIME is not set, you can
  15318. still enter a time, and this function will inform the calling routine
  15319. about this change. The calling routine may then choose to change the
  15320. format used to insert the time stamp into the buffer to include the time.
  15321. With optional argument FROM-STRING, read from this string instead from
  15322. the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
  15323. the time/date that is used for everything that is not specified by the
  15324. user."
  15325. (require 'parse-time)
  15326. (let* ((org-time-stamp-rounding-minutes
  15327. (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
  15328. (org-dcst org-display-custom-times)
  15329. (ct (org-current-time))
  15330. (org-def (or org-overriding-default-time default-time ct))
  15331. (org-defdecode (decode-time org-def))
  15332. (dummy (progn
  15333. (when (< (nth 2 org-defdecode) org-extend-today-until)
  15334. (setcar (nthcdr 2 org-defdecode) -1)
  15335. (setcar (nthcdr 1 org-defdecode) 59)
  15336. (setq org-def (apply 'encode-time org-defdecode)
  15337. org-defdecode (decode-time org-def)))))
  15338. (cur-frame (selected-frame))
  15339. (mouse-autoselect-window nil) ; Don't let the mouse jump
  15340. (calendar-frame-setup nil)
  15341. (calendar-setup (when (eq calendar-setup 'calendar-only) 'calendar-only))
  15342. (calendar-move-hook nil)
  15343. (calendar-view-diary-initially-flag nil)
  15344. (calendar-view-holidays-initially-flag nil)
  15345. (timestr (format-time-string
  15346. (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
  15347. (prompt (concat (if prompt (concat prompt " ") "")
  15348. (format "Date+time [%s]: " timestr)))
  15349. ans (org-ans0 "") org-ans1 org-ans2 final cal-frame)
  15350. (cond
  15351. (from-string (setq ans from-string))
  15352. (org-read-date-popup-calendar
  15353. (save-excursion
  15354. (save-window-excursion
  15355. (calendar)
  15356. (when (eq calendar-setup 'calendar-only)
  15357. (setq cal-frame
  15358. (window-frame (get-buffer-window "*Calendar*" 'visible)))
  15359. (select-frame cal-frame))
  15360. (org-eval-in-calendar '(setq cursor-type nil) t)
  15361. (unwind-protect
  15362. (progn
  15363. (calendar-forward-day (- (time-to-days org-def)
  15364. (calendar-absolute-from-gregorian
  15365. (calendar-current-date))))
  15366. (org-eval-in-calendar nil t)
  15367. (let* ((old-map (current-local-map))
  15368. (map (copy-keymap calendar-mode-map))
  15369. (minibuffer-local-map
  15370. (copy-keymap org-read-date-minibuffer-local-map)))
  15371. (org-defkey map (kbd "RET") 'org-calendar-select)
  15372. (org-defkey map [mouse-1] 'org-calendar-select-mouse)
  15373. (org-defkey map [mouse-2] 'org-calendar-select-mouse)
  15374. (unwind-protect
  15375. (progn
  15376. (use-local-map map)
  15377. (setq org-read-date-inactive inactive)
  15378. (add-hook 'post-command-hook 'org-read-date-display)
  15379. (setq org-ans0 (read-string prompt default-input
  15380. 'org-read-date-history nil))
  15381. ;; org-ans0: from prompt
  15382. ;; org-ans1: from mouse click
  15383. ;; org-ans2: from calendar motion
  15384. (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
  15385. (remove-hook 'post-command-hook 'org-read-date-display)
  15386. (use-local-map old-map)
  15387. (when org-read-date-overlay
  15388. (delete-overlay org-read-date-overlay)
  15389. (setq org-read-date-overlay nil)))))
  15390. (bury-buffer "*Calendar*")
  15391. (when cal-frame
  15392. (delete-frame cal-frame)
  15393. (select-frame-set-input-focus cur-frame))))))
  15394. (t ; Naked prompt only
  15395. (unwind-protect
  15396. (setq ans (read-string prompt default-input
  15397. 'org-read-date-history timestr))
  15398. (when org-read-date-overlay
  15399. (delete-overlay org-read-date-overlay)
  15400. (setq org-read-date-overlay nil)))))
  15401. (setq final (org-read-date-analyze ans org-def org-defdecode))
  15402. (when org-read-date-analyze-forced-year
  15403. (message "Year was forced into %s"
  15404. (if org-read-date-force-compatible-dates
  15405. "compatible range (1970-2037)"
  15406. "range representable on this machine"))
  15407. (ding))
  15408. ;; One round trip to get rid of 34th of August and stuff like that....
  15409. (setq final (decode-time (apply 'encode-time final)))
  15410. (setq org-read-date-final-answer ans)
  15411. (if to-time
  15412. (apply 'encode-time final)
  15413. (if (and (boundp 'org-time-was-given) org-time-was-given)
  15414. (format "%04d-%02d-%02d %02d:%02d"
  15415. (nth 5 final) (nth 4 final) (nth 3 final)
  15416. (nth 2 final) (nth 1 final))
  15417. (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
  15418. (defun org-read-date-display ()
  15419. "Display the current date prompt interpretation in the minibuffer."
  15420. (when org-read-date-display-live
  15421. (when org-read-date-overlay
  15422. (delete-overlay org-read-date-overlay))
  15423. (when (minibufferp (current-buffer))
  15424. (save-excursion
  15425. (end-of-line 1)
  15426. (while (not (equal (buffer-substring
  15427. (max (point-min) (- (point) 4)) (point))
  15428. " "))
  15429. (insert " ")))
  15430. (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
  15431. " " (or org-ans1 org-ans2)))
  15432. (org-end-time-was-given nil)
  15433. (f (org-read-date-analyze ans org-def org-defdecode))
  15434. (fmts (if org-dcst
  15435. org-time-stamp-custom-formats
  15436. org-time-stamp-formats))
  15437. (fmt (if (or org-with-time
  15438. (and (boundp 'org-time-was-given) org-time-was-given))
  15439. (cdr fmts)
  15440. (car fmts)))
  15441. (txt (format-time-string fmt (apply 'encode-time f)))
  15442. (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
  15443. (txt (concat "=> " txt)))
  15444. (when (and org-end-time-was-given
  15445. (string-match org-plain-time-of-day-regexp txt))
  15446. (setq txt (concat (substring txt 0 (match-end 0)) "-"
  15447. org-end-time-was-given
  15448. (substring txt (match-end 0)))))
  15449. (when org-read-date-analyze-futurep
  15450. (setq txt (concat txt " (=>F)")))
  15451. (setq org-read-date-overlay
  15452. (make-overlay (1- (point-at-eol)) (point-at-eol)))
  15453. (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
  15454. (defun org-read-date-analyze (ans org-def org-defdecode)
  15455. "Analyze the combined answer of the date prompt."
  15456. ;; FIXME: cleanup and comment
  15457. (let ((nowdecode (decode-time (current-time)))
  15458. delta deltan deltaw deltadef year month day
  15459. hour minute second wday pm h2 m2 tl wday1
  15460. iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
  15461. (setq org-read-date-analyze-futurep nil
  15462. org-read-date-analyze-forced-year nil)
  15463. (when (string-match "\\`[ \t]*\\.[ \t]*\\'" ans)
  15464. (setq ans "+0"))
  15465. (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
  15466. (setq ans (replace-match "" t t ans)
  15467. deltan (car delta)
  15468. deltaw (nth 1 delta)
  15469. deltadef (nth 2 delta)))
  15470. ;; Check if there is an iso week date in there. If yes, store the
  15471. ;; info and postpone interpreting it until the rest of the parsing
  15472. ;; is done.
  15473. (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
  15474. (setq iso-year (if (match-end 1)
  15475. (org-small-year-to-year
  15476. (string-to-number (match-string 1 ans))))
  15477. iso-weekday (if (match-end 3)
  15478. (string-to-number (match-string 3 ans)))
  15479. iso-week (string-to-number (match-string 2 ans)))
  15480. (setq ans (replace-match "" t t ans)))
  15481. ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
  15482. (when (string-match
  15483. "^ *\\(\\([0-9]+\\)-\\)?\\([0-1]?[0-9]\\)-\\([0-3]?[0-9]\\)\\([^-0-9]\\|$\\)" ans)
  15484. (setq year (if (match-end 2)
  15485. (string-to-number (match-string 2 ans))
  15486. (progn (setq kill-year t)
  15487. (string-to-number (format-time-string "%Y"))))
  15488. month (string-to-number (match-string 3 ans))
  15489. day (string-to-number (match-string 4 ans)))
  15490. (if (< year 100) (setq year (+ 2000 year)))
  15491. (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
  15492. t nil ans)))
  15493. ;; Help matching dotted european dates
  15494. (when (string-match
  15495. "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\.\\( ?[1-9][0-9]\\{3\\}\\)?" ans)
  15496. (setq year (if (match-end 3) (string-to-number (match-string 3 ans))
  15497. (setq kill-year t)
  15498. (string-to-number (format-time-string "%Y")))
  15499. day (string-to-number (match-string 1 ans))
  15500. month (string-to-number (match-string 2 ans))
  15501. ans (replace-match (format "%04d-%02d-%02d" year month day)
  15502. t nil ans)))
  15503. ;; Help matching american dates, like 5/30 or 5/30/7
  15504. (when (string-match
  15505. "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
  15506. (setq year (if (match-end 4)
  15507. (string-to-number (match-string 4 ans))
  15508. (progn (setq kill-year t)
  15509. (string-to-number (format-time-string "%Y"))))
  15510. month (string-to-number (match-string 1 ans))
  15511. day (string-to-number (match-string 2 ans)))
  15512. (if (< year 100) (setq year (+ 2000 year)))
  15513. (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
  15514. t nil ans)))
  15515. ;; Help matching am/pm times, because `parse-time-string' does not do that.
  15516. ;; If there is a time with am/pm, and *no* time without it, we convert
  15517. ;; so that matching will be successful.
  15518. (loop for i from 1 to 2 do ; twice, for end time as well
  15519. (when (and (not (string-match "\\(\\`\\|[^+]\\)[012]?[0-9]:[0-9][0-9]\\([ \t\n]\\|$\\)" ans))
  15520. (string-match "\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\(am\\|AM\\|pm\\|PM\\)\\>" ans))
  15521. (setq hour (string-to-number (match-string 1 ans))
  15522. minute (if (match-end 3)
  15523. (string-to-number (match-string 3 ans))
  15524. 0)
  15525. pm (equal ?p
  15526. (string-to-char (downcase (match-string 4 ans)))))
  15527. (if (and (= hour 12) (not pm))
  15528. (setq hour 0)
  15529. (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
  15530. (setq ans (replace-match (format "%02d:%02d" hour minute)
  15531. t t ans))))
  15532. ;; Check if a time range is given as a duration
  15533. (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
  15534. (setq hour (string-to-number (match-string 1 ans))
  15535. h2 (+ hour (string-to-number (match-string 3 ans)))
  15536. minute (string-to-number (match-string 2 ans))
  15537. m2 (+ minute (if (match-end 5) (string-to-number
  15538. (match-string 5 ans))0)))
  15539. (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
  15540. (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
  15541. t t ans)))
  15542. ;; Check if there is a time range
  15543. (when (boundp 'org-end-time-was-given)
  15544. (setq org-time-was-given nil)
  15545. (when (and (string-match org-plain-time-of-day-regexp ans)
  15546. (match-end 8))
  15547. (setq org-end-time-was-given (match-string 8 ans))
  15548. (setq ans (concat (substring ans 0 (match-beginning 7))
  15549. (substring ans (match-end 7))))))
  15550. (setq tl (parse-time-string ans)
  15551. day (or (nth 3 tl) (nth 3 org-defdecode))
  15552. month
  15553. (cond ((nth 4 tl))
  15554. ((not org-read-date-prefer-future) (nth 4 org-defdecode))
  15555. ;; Day was specified. Make sure DAY+MONTH
  15556. ;; combination happens in the future.
  15557. ((nth 3 tl)
  15558. (setq futurep t)
  15559. (if (< day (nth 3 nowdecode)) (1+ (nth 4 nowdecode))
  15560. (nth 4 nowdecode)))
  15561. (t (nth 4 org-defdecode)))
  15562. year
  15563. (cond ((and (not kill-year) (nth 5 tl)))
  15564. ((not org-read-date-prefer-future) (nth 5 org-defdecode))
  15565. ;; Month was guessed in the future and is at least
  15566. ;; equal to NOWDECODE's. Fix year accordingly.
  15567. (futurep
  15568. (if (or (> month (nth 4 nowdecode))
  15569. (>= day (nth 3 nowdecode)))
  15570. (nth 5 nowdecode)
  15571. (1+ (nth 5 nowdecode))))
  15572. ;; Month was specified. Make sure MONTH+YEAR
  15573. ;; combination happens in the future.
  15574. ((nth 4 tl)
  15575. (setq futurep t)
  15576. (cond ((> month (nth 4 nowdecode)) (nth 5 nowdecode))
  15577. ((< month (nth 4 nowdecode)) (1+ (nth 5 nowdecode)))
  15578. ((< day (nth 3 nowdecode)) (1+ (nth 5 nowdecode)))
  15579. (t (nth 5 nowdecode))))
  15580. (t (nth 5 org-defdecode)))
  15581. hour (or (nth 2 tl) (nth 2 org-defdecode))
  15582. minute (or (nth 1 tl) (nth 1 org-defdecode))
  15583. second (or (nth 0 tl) 0)
  15584. wday (nth 6 tl))
  15585. (when (and (eq org-read-date-prefer-future 'time)
  15586. (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
  15587. (equal day (nth 3 nowdecode))
  15588. (equal month (nth 4 nowdecode))
  15589. (equal year (nth 5 nowdecode))
  15590. (nth 2 tl)
  15591. (or (< (nth 2 tl) (nth 2 nowdecode))
  15592. (and (= (nth 2 tl) (nth 2 nowdecode))
  15593. (nth 1 tl)
  15594. (< (nth 1 tl) (nth 1 nowdecode)))))
  15595. (setq day (1+ day)
  15596. futurep t))
  15597. ;; Special date definitions below
  15598. (cond
  15599. (iso-week
  15600. ;; There was an iso week
  15601. (require 'cal-iso)
  15602. (setq futurep nil)
  15603. (setq year (or iso-year year)
  15604. day (or iso-weekday wday 1)
  15605. wday nil ; to make sure that the trigger below does not match
  15606. iso-date (calendar-gregorian-from-absolute
  15607. (calendar-iso-to-absolute
  15608. (list iso-week day year))))
  15609. ; FIXME: Should we also push ISO weeks into the future?
  15610. ; (when (and org-read-date-prefer-future
  15611. ; (not iso-year)
  15612. ; (< (calendar-absolute-from-gregorian iso-date)
  15613. ; (time-to-days (current-time))))
  15614. ; (setq year (1+ year)
  15615. ; iso-date (calendar-gregorian-from-absolute
  15616. ; (calendar-iso-to-absolute
  15617. ; (list iso-week day year)))))
  15618. (setq month (car iso-date)
  15619. year (nth 2 iso-date)
  15620. day (nth 1 iso-date)))
  15621. (deltan
  15622. (setq futurep nil)
  15623. (unless deltadef
  15624. (let ((now (decode-time (current-time))))
  15625. (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
  15626. (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
  15627. ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
  15628. ((equal deltaw "m") (setq month (+ month deltan)))
  15629. ((equal deltaw "y") (setq year (+ year deltan)))))
  15630. ((and wday (not (nth 3 tl)))
  15631. ;; Weekday was given, but no day, so pick that day in the week
  15632. ;; on or after the derived date.
  15633. (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
  15634. (unless (equal wday wday1)
  15635. (setq day (+ day (% (- wday wday1 -7) 7))))))
  15636. (if (and (boundp 'org-time-was-given)
  15637. (nth 2 tl))
  15638. (setq org-time-was-given t))
  15639. (if (< year 100) (setq year (+ 2000 year)))
  15640. ;; Check of the date is representable
  15641. (if org-read-date-force-compatible-dates
  15642. (progn
  15643. (if (< year 1970)
  15644. (setq year 1970 org-read-date-analyze-forced-year t))
  15645. (if (> year 2037)
  15646. (setq year 2037 org-read-date-analyze-forced-year t)))
  15647. (condition-case nil
  15648. (ignore (encode-time second minute hour day month year))
  15649. (error
  15650. (setq year (nth 5 org-defdecode))
  15651. (setq org-read-date-analyze-forced-year t))))
  15652. (setq org-read-date-analyze-futurep futurep)
  15653. (list second minute hour day month year)))
  15654. (defvar parse-time-weekdays)
  15655. (defun org-read-date-get-relative (s today default)
  15656. "Check string S for special relative date string.
  15657. TODAY and DEFAULT are internal times, for today and for a default.
  15658. Return shift list (N what def-flag)
  15659. WHAT is \"d\", \"w\", \"m\", or \"y\" for day, week, month, year.
  15660. N is the number of WHATs to shift.
  15661. DEF-FLAG is t when a double ++ or -- indicates shift relative to
  15662. the DEFAULT date rather than TODAY."
  15663. (require 'parse-time)
  15664. (when (and
  15665. (string-match
  15666. (concat
  15667. "\\`[ \t]*\\([-+]\\{0,2\\}\\)"
  15668. "\\([0-9]+\\)?"
  15669. "\\([hdwmy]\\|\\(" (mapconcat 'car parse-time-weekdays "\\|") "\\)\\)?"
  15670. "\\([ \t]\\|$\\)") s)
  15671. (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
  15672. (let* ((dir (if (> (match-end 1) (match-beginning 1))
  15673. (string-to-char (substring (match-string 1 s) -1))
  15674. ?+))
  15675. (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
  15676. (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
  15677. (what (if (match-end 3) (match-string 3 s) "d"))
  15678. (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
  15679. (date (if rel default today))
  15680. (wday (nth 6 (decode-time date)))
  15681. delta)
  15682. (if wday1
  15683. (progn
  15684. (setq delta (mod (+ 7 (- wday1 wday)) 7))
  15685. (if (= delta 0) (setq delta 7))
  15686. (if (= dir ?-)
  15687. (progn
  15688. (setq delta (- delta 7))
  15689. (if (= delta 0) (setq delta -7))))
  15690. (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
  15691. (list delta "d" rel))
  15692. (list (* n (if (= dir ?-) -1 1)) what rel)))))
  15693. (defun org-order-calendar-date-args (arg1 arg2 arg3)
  15694. "Turn a user-specified date into the internal representation.
  15695. The internal representation needed by the calendar is (month day year).
  15696. This is a wrapper to handle the brain-dead convention in calendar that
  15697. user function argument order change dependent on argument order."
  15698. (if (boundp 'calendar-date-style)
  15699. (cond
  15700. ((eq calendar-date-style 'american)
  15701. (list arg1 arg2 arg3))
  15702. ((eq calendar-date-style 'european)
  15703. (list arg2 arg1 arg3))
  15704. ((eq calendar-date-style 'iso)
  15705. (list arg2 arg3 arg1)))
  15706. (org-no-warnings ;; european-calendar-style is obsolete as of version 23.1
  15707. (if (org-bound-and-true-p european-calendar-style)
  15708. (list arg2 arg1 arg3)
  15709. (list arg1 arg2 arg3)))))
  15710. (defun org-eval-in-calendar (form &optional keepdate)
  15711. "Eval FORM in the calendar window and return to current window.
  15712. When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
  15713. otherwise stick to the current value of `org-ans2'."
  15714. (let ((sf (selected-frame))
  15715. (sw (selected-window)))
  15716. (select-window (get-buffer-window "*Calendar*" t))
  15717. (eval form)
  15718. (when (and (not keepdate) (calendar-cursor-to-date))
  15719. (let* ((date (calendar-cursor-to-date))
  15720. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  15721. (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
  15722. (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
  15723. (select-window sw)
  15724. (org-select-frame-set-input-focus sf)))
  15725. (defun org-calendar-select ()
  15726. "Return to `org-read-date' with the date currently selected.
  15727. This is used by `org-read-date' in a temporary keymap for the calendar buffer."
  15728. (interactive)
  15729. (when (calendar-cursor-to-date)
  15730. (let* ((date (calendar-cursor-to-date))
  15731. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  15732. (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
  15733. (if (active-minibuffer-window) (exit-minibuffer))))
  15734. (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
  15735. "Insert a date stamp for the date given by the internal TIME.
  15736. See `format-time-string' for the format of TIME.
  15737. WITH-HM means use the stamp format that includes the time of the day.
  15738. INACTIVE means use square brackets instead of angular ones, so that the
  15739. stamp will not contribute to the agenda.
  15740. PRE and POST are optional strings to be inserted before and after the
  15741. stamp.
  15742. The command returns the inserted time stamp."
  15743. (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
  15744. stamp)
  15745. (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
  15746. (insert-before-markers (or pre ""))
  15747. (when (listp extra)
  15748. (setq extra (car extra))
  15749. (if (and (stringp extra)
  15750. (string-match "\\([0-9]+\\):\\([0-9]+\\)" extra))
  15751. (setq extra (format "-%02d:%02d"
  15752. (string-to-number (match-string 1 extra))
  15753. (string-to-number (match-string 2 extra))))
  15754. (setq extra nil)))
  15755. (when extra
  15756. (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
  15757. (insert-before-markers (setq stamp (format-time-string fmt time)))
  15758. (insert-before-markers (or post ""))
  15759. (setq org-last-inserted-timestamp stamp)))
  15760. (defun org-toggle-time-stamp-overlays ()
  15761. "Toggle the use of custom time stamp formats."
  15762. (interactive)
  15763. (setq org-display-custom-times (not org-display-custom-times))
  15764. (unless org-display-custom-times
  15765. (let ((p (point-min)) (bmp (buffer-modified-p)))
  15766. (while (setq p (next-single-property-change p 'display))
  15767. (if (and (get-text-property p 'display)
  15768. (eq (get-text-property p 'face) 'org-date))
  15769. (remove-text-properties
  15770. p (setq p (next-single-property-change p 'display))
  15771. '(display t))))
  15772. (set-buffer-modified-p bmp)))
  15773. (if (featurep 'xemacs)
  15774. (remove-text-properties (point-min) (point-max) '(end-glyph t)))
  15775. (org-restart-font-lock)
  15776. (setq org-table-may-need-update t)
  15777. (if org-display-custom-times
  15778. (message "Time stamps are overlaid with custom format")
  15779. (message "Time stamp overlays removed")))
  15780. (defun org-display-custom-time (beg end)
  15781. "Overlay modified time stamp format over timestamp between BEG and END."
  15782. (let* ((ts (buffer-substring beg end))
  15783. t1 w1 with-hm tf time str w2 (off 0))
  15784. (save-match-data
  15785. (setq t1 (org-parse-time-string ts t))
  15786. (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
  15787. (setq off (- (match-end 0) (match-beginning 0)))))
  15788. (setq end (- end off))
  15789. (setq w1 (- end beg)
  15790. with-hm (and (nth 1 t1) (nth 2 t1))
  15791. tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
  15792. time (org-fix-decoded-time t1)
  15793. str (org-add-props
  15794. (format-time-string
  15795. (substring tf 1 -1) (apply 'encode-time time))
  15796. nil 'mouse-face 'highlight)
  15797. w2 (length str))
  15798. (if (not (= w2 w1))
  15799. (add-text-properties (1+ beg) (+ 2 beg)
  15800. (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
  15801. (if (featurep 'xemacs)
  15802. (progn
  15803. (put-text-property beg end 'invisible t)
  15804. (put-text-property beg end 'end-glyph (make-glyph str)))
  15805. (put-text-property beg end 'display str))))
  15806. (defun org-fix-decoded-time (time)
  15807. "Set 0 instead of nil for the first 6 elements of time.
  15808. Don't touch the rest."
  15809. (let ((n 0))
  15810. (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
  15811. (define-obsolete-function-alias 'org-days-to-time 'org-time-stamp-to-now "24.4")
  15812. (defun org-time-stamp-to-now (timestamp-string &optional seconds)
  15813. "Difference between TIMESTAMP-STRING and now in days.
  15814. If SECONDS is non-nil, return the difference in seconds."
  15815. (let ((fdiff (if seconds 'org-float-time 'time-to-days)))
  15816. (- (funcall fdiff (org-time-string-to-time timestamp-string))
  15817. (funcall fdiff (current-time)))))
  15818. (defun org-deadline-close (timestamp-string &optional ndays)
  15819. "Is the time in TIMESTAMP-STRING close to the current date?"
  15820. (setq ndays (or ndays (org-get-wdays timestamp-string)))
  15821. (and (< (org-time-stamp-to-now timestamp-string) ndays)
  15822. (not (org-entry-is-done-p))))
  15823. (defun org-get-wdays (ts &optional delay zero-delay)
  15824. "Get the deadline lead time appropriate for timestring TS.
  15825. When DELAY is non-nil, get the delay time for scheduled items
  15826. instead of the deadline lead time. When ZERO-DELAY is non-nil
  15827. and `org-scheduled-delay-days' is 0, enforce 0 as the delay,
  15828. don't try to find the delay cookie in the scheduled timestamp."
  15829. (let ((tv (if delay org-scheduled-delay-days
  15830. org-deadline-warning-days)))
  15831. (cond
  15832. ((or (and delay (< tv 0))
  15833. (and delay zero-delay (<= tv 0))
  15834. (and (not delay) (<= tv 0)))
  15835. ;; Enforce this value no matter what
  15836. (- tv))
  15837. ((string-match "-\\([0-9]+\\)\\([hdwmy]\\)\\(\\'\\|>\\| \\)" ts)
  15838. ;; lead time is specified.
  15839. (floor (* (string-to-number (match-string 1 ts))
  15840. (cdr (assoc (match-string 2 ts)
  15841. '(("d" . 1) ("w" . 7)
  15842. ("m" . 30.4) ("y" . 365.25)
  15843. ("h" . 0.041667)))))))
  15844. ;; go for the default.
  15845. (t tv))))
  15846. (defun org-calendar-select-mouse (ev)
  15847. "Return to `org-read-date' with the date currently selected.
  15848. This is used by `org-read-date' in a temporary keymap for the calendar buffer."
  15849. (interactive "e")
  15850. (mouse-set-point ev)
  15851. (when (calendar-cursor-to-date)
  15852. (let* ((date (calendar-cursor-to-date))
  15853. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  15854. (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
  15855. (if (active-minibuffer-window) (exit-minibuffer))))
  15856. (defun org-check-deadlines (ndays)
  15857. "Check if there are any deadlines due or past due.
  15858. A deadline is considered due if it happens within `org-deadline-warning-days'
  15859. days from today's date. If the deadline appears in an entry marked DONE,
  15860. it is not shown. The prefix arg NDAYS can be used to test that many
  15861. days. If the prefix is a raw \\[universal-argument] prefix, all deadlines are shown."
  15862. (interactive "P")
  15863. (let* ((org-warn-days
  15864. (cond
  15865. ((equal ndays '(4)) 100000)
  15866. (ndays (prefix-numeric-value ndays))
  15867. (t (abs org-deadline-warning-days))))
  15868. (case-fold-search nil)
  15869. (regexp (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
  15870. (callback
  15871. (lambda () (org-deadline-close (match-string 1) org-warn-days))))
  15872. (message "%d deadlines past-due or due within %d days"
  15873. (org-occur regexp nil callback)
  15874. org-warn-days)))
  15875. (defsubst org-re-timestamp (type)
  15876. "Return a regexp for timestamp TYPE.
  15877. Allowed values for TYPE are:
  15878. all: all timestamps
  15879. active: only active timestamps (<...>)
  15880. inactive: only inactive timestamps ([...])
  15881. scheduled: only scheduled timestamps
  15882. deadline: only deadline timestamps
  15883. closed: only closed time-stamps
  15884. When TYPE is nil, fall back on returning a regexp that matches
  15885. both scheduled and deadline timestamps."
  15886. (case type
  15887. (all org-ts-regexp-both)
  15888. (active org-ts-regexp)
  15889. (inactive org-ts-regexp-inactive)
  15890. (scheduled org-scheduled-time-regexp)
  15891. (deadline org-deadline-time-regexp)
  15892. (closed org-closed-time-regexp)
  15893. (otherwise
  15894. (concat "\\<"
  15895. (regexp-opt (list org-deadline-string org-scheduled-string))
  15896. " *<\\([^>]+\\)>"))))
  15897. (defun org-check-before-date (date)
  15898. "Check if there are deadlines or scheduled entries before DATE."
  15899. (interactive (list (org-read-date)))
  15900. (let ((case-fold-search nil)
  15901. (regexp (org-re-timestamp org-ts-type))
  15902. (callback
  15903. `(lambda ()
  15904. (and ,(if (memq org-ts-type '(active inactive all))
  15905. '(eq (org-element-type (org-element-context)) 'timestamp)
  15906. '(org-at-planning-p))
  15907. (time-less-p
  15908. (org-time-string-to-time (match-string 1))
  15909. (org-time-string-to-time date))))))
  15910. (message "%d entries before %s"
  15911. (org-occur regexp nil callback) date)))
  15912. (defun org-check-after-date (date)
  15913. "Check if there are deadlines or scheduled entries after DATE."
  15914. (interactive (list (org-read-date)))
  15915. (let ((case-fold-search nil)
  15916. (regexp (org-re-timestamp org-ts-type))
  15917. (callback
  15918. `(lambda ()
  15919. (and ,(if (memq org-ts-type '(active inactive all))
  15920. '(eq (org-element-type (org-element-context)) 'timestamp)
  15921. '(org-at-planning-p))
  15922. (not (time-less-p
  15923. (org-time-string-to-time (match-string 1))
  15924. (org-time-string-to-time date)))))))
  15925. (message "%d entries after %s"
  15926. (org-occur regexp nil callback) date)))
  15927. (defun org-check-dates-range (start-date end-date)
  15928. "Check for deadlines/scheduled entries between START-DATE and END-DATE."
  15929. (interactive (list (org-read-date nil nil nil "Range starts")
  15930. (org-read-date nil nil nil "Range end")))
  15931. (let ((case-fold-search nil)
  15932. (regexp (org-re-timestamp org-ts-type))
  15933. (callback
  15934. `(lambda ()
  15935. (let ((match (match-string 1)))
  15936. (and
  15937. ,(if (memq org-ts-type '(active inactive all))
  15938. '(eq (org-element-type (org-element-context)) 'timestamp)
  15939. '(org-at-planning-p))
  15940. (not (time-less-p
  15941. (org-time-string-to-time match)
  15942. (org-time-string-to-time start-date)))
  15943. (time-less-p
  15944. (org-time-string-to-time match)
  15945. (org-time-string-to-time end-date)))))))
  15946. (message "%d entries between %s and %s"
  15947. (org-occur regexp nil callback) start-date end-date)))
  15948. (defun org-evaluate-time-range (&optional to-buffer)
  15949. "Evaluate a time range by computing the difference between start and end.
  15950. Normally the result is just printed in the echo area, but with prefix arg
  15951. TO-BUFFER, the result is inserted just after the date stamp into the buffer.
  15952. If the time range is actually in a table, the result is inserted into the
  15953. next column.
  15954. For time difference computation, a year is assumed to be exactly 365
  15955. days in order to avoid rounding problems."
  15956. (interactive "P")
  15957. (or
  15958. (org-clock-update-time-maybe)
  15959. (save-excursion
  15960. (unless (org-at-date-range-p t)
  15961. (goto-char (point-at-bol))
  15962. (re-search-forward org-tr-regexp-both (point-at-eol) t))
  15963. (if (not (org-at-date-range-p t))
  15964. (user-error "Not at a time-stamp range, and none found in current line")))
  15965. (let* ((ts1 (match-string 1))
  15966. (ts2 (match-string 2))
  15967. (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
  15968. (match-end (match-end 0))
  15969. (time1 (org-time-string-to-time ts1))
  15970. (time2 (org-time-string-to-time ts2))
  15971. (t1 (org-float-time time1))
  15972. (t2 (org-float-time time2))
  15973. (diff (abs (- t2 t1)))
  15974. (negative (< (- t2 t1) 0))
  15975. ;; (ys (floor (* 365 24 60 60)))
  15976. (ds (* 24 60 60))
  15977. (hs (* 60 60))
  15978. (fy "%dy %dd %02d:%02d")
  15979. (fy1 "%dy %dd")
  15980. (fd "%dd %02d:%02d")
  15981. (fd1 "%dd")
  15982. (fh "%02d:%02d")
  15983. y d h m align)
  15984. (if havetime
  15985. (setq ; y (floor (/ diff ys)) diff (mod diff ys)
  15986. y 0
  15987. d (floor (/ diff ds)) diff (mod diff ds)
  15988. h (floor (/ diff hs)) diff (mod diff hs)
  15989. m (floor (/ diff 60)))
  15990. (setq ; y (floor (/ diff ys)) diff (mod diff ys)
  15991. y 0
  15992. d (floor (+ (/ diff ds) 0.5))
  15993. h 0 m 0))
  15994. (if (not to-buffer)
  15995. (message "%s" (org-make-tdiff-string y d h m))
  15996. (if (org-at-table-p)
  15997. (progn
  15998. (goto-char match-end)
  15999. (setq align t)
  16000. (and (looking-at " *|") (goto-char (match-end 0))))
  16001. (goto-char match-end))
  16002. (if (looking-at
  16003. "\\( *-? *[0-9]+y\\)?\\( *[0-9]+d\\)? *[0-9][0-9]:[0-9][0-9]")
  16004. (replace-match ""))
  16005. (if negative (insert " -"))
  16006. (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
  16007. (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
  16008. (insert " " (format fh h m))))
  16009. (if align (org-table-align))
  16010. (message "Time difference inserted")))))
  16011. (defun org-make-tdiff-string (y d h m)
  16012. (let ((fmt "")
  16013. (l nil))
  16014. (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
  16015. l (push y l)))
  16016. (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
  16017. l (push d l)))
  16018. (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
  16019. l (push h l)))
  16020. (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
  16021. l (push m l)))
  16022. (apply 'format fmt (nreverse l))))
  16023. (defun org-time-string-to-time (s &optional buffer pos)
  16024. "Convert a timestamp string into internal time."
  16025. (condition-case errdata
  16026. (apply 'encode-time (org-parse-time-string s))
  16027. (error (error "Bad timestamp `%s'%s\nError was: %s"
  16028. s (if (not (and buffer pos))
  16029. ""
  16030. (format " at %d in buffer `%s'" pos buffer))
  16031. (cdr errdata)))))
  16032. (defun org-time-string-to-seconds (s)
  16033. "Convert a timestamp string to a number of seconds."
  16034. (org-float-time (org-time-string-to-time s)))
  16035. (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
  16036. "Convert a time stamp to an absolute day number.
  16037. If there is a specifier for a cyclic time stamp, get the closest
  16038. date to DAYNR.
  16039. PREFER and SHOW-ALL are passed through to `org-closest-date'.
  16040. The variable `date' is bound by the calendar when this is called."
  16041. (cond
  16042. ((and daynr (string-match "\\`%%\\((.*)\\)" s))
  16043. (if (org-diary-sexp-entry (match-string 1 s) "" date)
  16044. daynr
  16045. (+ daynr 1000)))
  16046. ((and daynr (string-match "\\+[0-9]+[hdwmy]" s))
  16047. (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
  16048. (time-to-days (current-time))) (match-string 0 s)
  16049. prefer show-all))
  16050. (t (time-to-days
  16051. (condition-case errdata
  16052. (apply 'encode-time (org-parse-time-string s))
  16053. (error (error "Bad timestamp `%s'%s\nError was: %s"
  16054. s (if (not (and buffer pos))
  16055. ""
  16056. (format " at %d in buffer `%s'" pos buffer))
  16057. (cdr errdata))))))))
  16058. (defun org-days-to-iso-week (days)
  16059. "Return the iso week number."
  16060. (require 'cal-iso)
  16061. (car (calendar-iso-from-absolute days)))
  16062. (defun org-small-year-to-year (year)
  16063. "Convert 2-digit years into 4-digit years.
  16064. YEAR is expanded into one of the 30 next years, if possible, or
  16065. into a past one. Any year larger than 99 is returned unchanged."
  16066. (if (>= year 100) year
  16067. (let* ((current (string-to-number (format-time-string "%Y" (current-time))))
  16068. (century (/ current 100))
  16069. (offset (- year (% current 100))))
  16070. (cond ((> offset 30) (+ (* (1- century) 100) year))
  16071. ((> offset -70) (+ (* century 100) year))
  16072. (t (+ (* (1+ century) 100) year))))))
  16073. (defun org-time-from-absolute (d)
  16074. "Return the time corresponding to date D.
  16075. D may be an absolute day number, or a calendar-type list (month day year)."
  16076. (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
  16077. (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
  16078. (defun org-calendar-holiday ()
  16079. "List of holidays, for Diary display in Org-mode."
  16080. (require 'holidays)
  16081. (let ((hl (funcall
  16082. (if (fboundp 'calendar-check-holidays)
  16083. 'calendar-check-holidays 'check-calendar-holidays) date)))
  16084. (if hl (mapconcat 'identity hl "; "))))
  16085. (defun org-diary-sexp-entry (sexp entry date)
  16086. "Process a SEXP diary ENTRY for DATE."
  16087. (require 'diary-lib)
  16088. (let ((result (if calendar-debug-sexp
  16089. (let ((stack-trace-on-error t))
  16090. (eval (car (read-from-string sexp))))
  16091. (condition-case nil
  16092. (eval (car (read-from-string sexp)))
  16093. (error
  16094. (beep)
  16095. (message "Bad sexp at line %d in %s: %s"
  16096. (org-current-line)
  16097. (buffer-file-name) sexp)
  16098. (sleep-for 2))))))
  16099. (cond ((stringp result) (split-string result "; "))
  16100. ((and (consp result)
  16101. (not (consp (cdr result)))
  16102. (stringp (cdr result))) (cdr result))
  16103. ((and (consp result)
  16104. (stringp (car result))) result)
  16105. (result entry))))
  16106. (defun org-diary-to-ical-string (frombuf)
  16107. "Get iCalendar entries from diary entries in buffer FROMBUF.
  16108. This uses the icalendar.el library."
  16109. (let* ((tmpdir (if (featurep 'xemacs)
  16110. (temp-directory)
  16111. temporary-file-directory))
  16112. (tmpfile (make-temp-name
  16113. (expand-file-name "orgics" tmpdir)))
  16114. buf rtn b e)
  16115. (with-current-buffer frombuf
  16116. (icalendar-export-region (point-min) (point-max) tmpfile)
  16117. (setq buf (find-buffer-visiting tmpfile))
  16118. (set-buffer buf)
  16119. (goto-char (point-min))
  16120. (if (re-search-forward "^BEGIN:VEVENT" nil t)
  16121. (setq b (match-beginning 0)))
  16122. (goto-char (point-max))
  16123. (if (re-search-backward "^END:VEVENT" nil t)
  16124. (setq e (match-end 0)))
  16125. (setq rtn (if (and b e) (concat (buffer-substring b e) "\n") "")))
  16126. (kill-buffer buf)
  16127. (delete-file tmpfile)
  16128. rtn))
  16129. (defun org-closest-date (start current change prefer show-all)
  16130. "Find the date closest to CURRENT that is consistent with START and CHANGE.
  16131. When PREFER is `past', return a date that is either CURRENT or past.
  16132. When PREFER is `future', return a date that is either CURRENT or future.
  16133. When SHOW-ALL is nil, only return the current occurrence of a time stamp."
  16134. ;; Make the proper lists from the dates
  16135. (catch 'exit
  16136. (let ((a1 '(("h" . hour)
  16137. ("d" . day)
  16138. ("w" . week)
  16139. ("m" . month)
  16140. ("y" . year)))
  16141. (shour (nth 2 (org-parse-time-string start)))
  16142. dn dw sday cday n1 n2 n0
  16143. d m y y1 y2 date1 date2 nmonths nm ny m2)
  16144. (setq start (org-date-to-gregorian start)
  16145. current (org-date-to-gregorian
  16146. (if show-all
  16147. current
  16148. (time-to-days (current-time))))
  16149. sday (calendar-absolute-from-gregorian start)
  16150. cday (calendar-absolute-from-gregorian current))
  16151. (if (<= cday sday) (throw 'exit sday))
  16152. (if (string-match "\\(\\+[0-9]+\\)\\([hdwmy]\\)" change)
  16153. (setq dn (string-to-number (match-string 1 change))
  16154. dw (cdr (assoc (match-string 2 change) a1)))
  16155. (user-error "Invalid change specifier: %s" change))
  16156. (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
  16157. (cond
  16158. ((eq dw 'hour)
  16159. (let ((missing-hours
  16160. (mod (+ (- (* 24 (- cday sday)) shour) org-extend-today-until)
  16161. dn)))
  16162. (setq n1 (if (zerop missing-hours) cday
  16163. (- cday (1+ (floor (/ missing-hours 24)))))
  16164. n2 (+ cday (floor (/ (- dn missing-hours) 24))))))
  16165. ((eq dw 'day)
  16166. (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
  16167. n2 (+ n1 dn)))
  16168. ((eq dw 'year)
  16169. (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
  16170. (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
  16171. (setq date1 (list m d y1)
  16172. n1 (calendar-absolute-from-gregorian date1)
  16173. date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
  16174. n2 (calendar-absolute-from-gregorian date2)))
  16175. ((eq dw 'month)
  16176. ;; approx number of month between the two dates
  16177. (setq nmonths (floor (/ (- cday sday) 30.436875)))
  16178. ;; How often does dn fit in there?
  16179. (setq d (nth 1 start) m (car start) y (nth 2 start)
  16180. nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
  16181. m (+ m nm)
  16182. ny (floor (/ m 12))
  16183. y (+ y ny)
  16184. m (- m (* ny 12)))
  16185. (while (> m 12) (setq m (- m 12) y (1+ y)))
  16186. (setq n1 (calendar-absolute-from-gregorian (list m d y)))
  16187. (setq m2 (+ m dn) y2 y)
  16188. (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
  16189. (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
  16190. (while (<= n2 cday)
  16191. (setq n1 n2 m m2 y y2)
  16192. (setq m2 (+ m dn) y2 y)
  16193. (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
  16194. (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
  16195. ;; Make sure n1 is the earlier date
  16196. (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
  16197. (if show-all
  16198. (cond
  16199. ((eq prefer 'past) (if (= cday n2) n2 n1))
  16200. ((eq prefer 'future) (if (= cday n1) n1 n2))
  16201. (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
  16202. (cond
  16203. ((eq prefer 'past) (if (= cday n2) n2 n1))
  16204. ((eq prefer 'future) (if (= cday n1) n1 n2))
  16205. (t (if (= cday n1) n1 n2)))))))
  16206. (defun org-date-to-gregorian (date)
  16207. "Turn any specification of DATE into a Gregorian date for the calendar."
  16208. (cond ((integerp date) (calendar-gregorian-from-absolute date))
  16209. ((and (listp date) (= (length date) 3)) date)
  16210. ((stringp date)
  16211. (setq date (org-parse-time-string date))
  16212. (list (nth 4 date) (nth 3 date) (nth 5 date)))
  16213. ((listp date)
  16214. (list (nth 4 date) (nth 3 date) (nth 5 date)))))
  16215. (defun org-parse-time-string (s &optional nodefault)
  16216. "Parse the standard Org-mode time string.
  16217. This should be a lot faster than the normal `parse-time-string'.
  16218. If time is not given, defaults to 0:00. However, with optional NODEFAULT,
  16219. hour and minute fields will be nil if not given."
  16220. (cond ((string-match org-ts-regexp0 s)
  16221. (list 0
  16222. (if (or (match-beginning 8) (not nodefault))
  16223. (string-to-number (or (match-string 8 s) "0")))
  16224. (if (or (match-beginning 7) (not nodefault))
  16225. (string-to-number (or (match-string 7 s) "0")))
  16226. (string-to-number (match-string 4 s))
  16227. (string-to-number (match-string 3 s))
  16228. (string-to-number (match-string 2 s))
  16229. nil nil nil))
  16230. ((string-match "^<[^>]+>$" s)
  16231. (decode-time (seconds-to-time (org-matcher-time s))))
  16232. (t (error "Not a standard Org-mode time string: %s" s))))
  16233. (defun org-timestamp-up (&optional arg)
  16234. "Increase the date item at the cursor by one.
  16235. If the cursor is on the year, change the year. If it is on the month,
  16236. the day or the time, change that.
  16237. With prefix ARG, change by that many units."
  16238. (interactive "p")
  16239. (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
  16240. (defun org-timestamp-down (&optional arg)
  16241. "Decrease the date item at the cursor by one.
  16242. If the cursor is on the year, change the year. If it is on the month,
  16243. the day or the time, change that.
  16244. With prefix ARG, change by that many units."
  16245. (interactive "p")
  16246. (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
  16247. (defun org-timestamp-up-day (&optional arg)
  16248. "Increase the date in the time stamp by one day.
  16249. With prefix ARG, change that many days."
  16250. (interactive "p")
  16251. (if (and (not (org-at-timestamp-p t))
  16252. (org-at-heading-p))
  16253. (org-todo 'up)
  16254. (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
  16255. (defun org-timestamp-down-day (&optional arg)
  16256. "Decrease the date in the time stamp by one day.
  16257. With prefix ARG, change that many days."
  16258. (interactive "p")
  16259. (if (and (not (org-at-timestamp-p t))
  16260. (org-at-heading-p))
  16261. (org-todo 'down)
  16262. (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
  16263. (defun org-at-timestamp-p (&optional inactive-ok)
  16264. "Determine if the cursor is in or at a timestamp."
  16265. (interactive)
  16266. (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
  16267. (pos (point))
  16268. (ans (or (looking-at tsr)
  16269. (save-excursion
  16270. (skip-chars-backward "^[<\n\r\t")
  16271. (if (> (point) (point-min)) (backward-char 1))
  16272. (and (looking-at tsr)
  16273. (> (- (match-end 0) pos) -1))))))
  16274. (and ans
  16275. (boundp 'org-ts-what)
  16276. (setq org-ts-what
  16277. (cond
  16278. ((= pos (match-beginning 0)) 'bracket)
  16279. ;; Point is considered to be "on the bracket" whether
  16280. ;; it's really on it or right after it.
  16281. ((= pos (1- (match-end 0))) 'bracket)
  16282. ((= pos (match-end 0)) 'after)
  16283. ((org-pos-in-match-range pos 2) 'year)
  16284. ((org-pos-in-match-range pos 3) 'month)
  16285. ((org-pos-in-match-range pos 7) 'hour)
  16286. ((org-pos-in-match-range pos 8) 'minute)
  16287. ((or (org-pos-in-match-range pos 4)
  16288. (org-pos-in-match-range pos 5)) 'day)
  16289. ((and (> pos (or (match-end 8) (match-end 5)))
  16290. (< pos (match-end 0)))
  16291. (- pos (or (match-end 8) (match-end 5))))
  16292. (t 'day))))
  16293. ans))
  16294. (defun org-toggle-timestamp-type ()
  16295. "Toggle the type (<active> or [inactive]) of a time stamp."
  16296. (interactive)
  16297. (when (org-at-timestamp-p t)
  16298. (let ((beg (match-beginning 0)) (end (match-end 0))
  16299. (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
  16300. (save-excursion
  16301. (goto-char beg)
  16302. (while (re-search-forward "[][<>]" end t)
  16303. (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
  16304. t t)))
  16305. (message "Timestamp is now %sactive"
  16306. (if (equal (char-after beg) ?<) "" "in")))))
  16307. (defun org-at-clock-log-p nil
  16308. "Is the cursor on the clock log line?"
  16309. (save-excursion
  16310. (move-beginning-of-line 1)
  16311. (looking-at org-clock-line-re)))
  16312. (defvar org-clock-history) ; defined in org-clock.el
  16313. (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
  16314. (defun org-timestamp-change (n &optional what updown suppress-tmp-delay)
  16315. "Change the date in the time stamp at point.
  16316. The date will be changed by N times WHAT. WHAT can be `day', `month',
  16317. `year', `minute', `second'. If WHAT is not given, the cursor position
  16318. in the timestamp determines what will be changed.
  16319. When SUPPRESS-TMP-DELAY is non-nil, suppress delays like \"--2d\"."
  16320. (let ((origin (point)) origin-cat
  16321. with-hm inactive
  16322. (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
  16323. org-ts-what
  16324. extra rem
  16325. ts time time0 fixnext clrgx)
  16326. (if (not (org-at-timestamp-p t))
  16327. (user-error "Not at a timestamp"))
  16328. (if (and (not what) (eq org-ts-what 'bracket))
  16329. (org-toggle-timestamp-type)
  16330. ;; Point isn't on brackets. Remember the part of the time-stamp
  16331. ;; the point was in. Indeed, size of time-stamps may change,
  16332. ;; but point must be kept in the same category nonetheless.
  16333. (setq origin-cat org-ts-what)
  16334. (if (and (not what) (not (eq org-ts-what 'day))
  16335. org-display-custom-times
  16336. (get-text-property (point) 'display)
  16337. (not (get-text-property (1- (point)) 'display)))
  16338. (setq org-ts-what 'day))
  16339. (setq org-ts-what (or what org-ts-what)
  16340. inactive (= (char-after (match-beginning 0)) ?\[)
  16341. ts (match-string 0))
  16342. (replace-match "")
  16343. (when (string-match
  16344. "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?-?[-+][0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)*\\)[]>]"
  16345. ts)
  16346. (setq extra (match-string 1 ts))
  16347. (if suppress-tmp-delay
  16348. (setq extra (replace-regexp-in-string " --[0-9]+[hdwmy]" "" extra))))
  16349. (if (string-match "^.\\{10\\}.*?[0-9]+:[0-9][0-9]" ts)
  16350. (setq with-hm t))
  16351. (setq time0 (org-parse-time-string ts))
  16352. (when (and updown
  16353. (eq org-ts-what 'minute)
  16354. (not current-prefix-arg))
  16355. ;; This looks like s-up and s-down. Change by one rounding step.
  16356. (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
  16357. (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
  16358. (setcar (cdr time0) (+ (nth 1 time0)
  16359. (if (> n 0) (- rem) (- dm rem))))))
  16360. (setq time
  16361. (encode-time (or (car time0) 0)
  16362. (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
  16363. (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
  16364. (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
  16365. (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
  16366. (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
  16367. (nthcdr 6 time0)))
  16368. (when (and (member org-ts-what '(hour minute))
  16369. extra
  16370. (string-match "-\\([012][0-9]\\):\\([0-5][0-9]\\)" extra))
  16371. (setq extra (org-modify-ts-extra
  16372. extra
  16373. (if (eq org-ts-what 'hour) 2 5)
  16374. n dm)))
  16375. (when (integerp org-ts-what)
  16376. (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
  16377. (if (eq what 'calendar)
  16378. (let ((cal-date (org-get-date-from-calendar)))
  16379. (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
  16380. (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
  16381. (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
  16382. (setcar time0 (or (car time0) 0))
  16383. (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
  16384. (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
  16385. (setq time (apply 'encode-time time0))))
  16386. ;; Insert the new time-stamp, and ensure point stays in the same
  16387. ;; category as before (i.e. not after the last position in that
  16388. ;; category).
  16389. (let ((pos (point)))
  16390. ;; Stay before inserted string. `save-excursion' is of no use.
  16391. (setq org-last-changed-timestamp
  16392. (org-insert-time-stamp time with-hm inactive nil nil extra))
  16393. (goto-char pos))
  16394. (save-match-data
  16395. (looking-at org-ts-regexp3)
  16396. (goto-char (cond
  16397. ;; `day' category ends before `hour' if any, or at
  16398. ;; the end of the day name.
  16399. ((eq origin-cat 'day)
  16400. (min (or (match-beginning 7) (1- (match-end 5))) origin))
  16401. ((eq origin-cat 'hour) (min (match-end 7) origin))
  16402. ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
  16403. ((integerp origin-cat) (min (1- (match-end 0)) origin))
  16404. ;; `year' and `month' have both fixed size: point
  16405. ;; couldn't have moved into another part.
  16406. (t origin))))
  16407. ;; Update clock if on a CLOCK line.
  16408. (org-clock-update-time-maybe)
  16409. ;; Maybe adjust the closest clock in `org-clock-history'
  16410. (when org-clock-adjust-closest
  16411. (if (not (and (org-at-clock-log-p)
  16412. (< 1 (length (delq nil (mapcar 'marker-position
  16413. org-clock-history))))))
  16414. (message "No clock to adjust")
  16415. (cond ((save-excursion ; fix previous clock?
  16416. (re-search-backward org-ts-regexp0 nil t)
  16417. (org-looking-back (concat org-clock-string " \\[")))
  16418. (setq fixnext 1 clrgx (concat org-ts-regexp0 "\\] =>.*$")))
  16419. ((save-excursion ; fix next clock?
  16420. (re-search-backward org-ts-regexp0 nil t)
  16421. (looking-at (concat org-ts-regexp0 "\\] =>")))
  16422. (setq fixnext -1 clrgx (concat org-clock-string " \\[" org-ts-regexp0))))
  16423. (save-window-excursion
  16424. ;; Find closest clock to point, adjust the previous/next one in history
  16425. (let* ((p (save-excursion (org-back-to-heading t)))
  16426. (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
  16427. (clfixnth
  16428. (+ fixnext (- (length cl) (or (length (member (apply 'min cl) cl)) 100))))
  16429. (clfixpos (if (> 0 clfixnth) nil (nth clfixnth org-clock-history))))
  16430. (if (not clfixpos)
  16431. (message "No clock to adjust")
  16432. (save-excursion
  16433. (org-goto-marker-or-bmk clfixpos)
  16434. (org-show-subtree)
  16435. (when (re-search-forward clrgx nil t)
  16436. (goto-char (match-beginning 1))
  16437. (let (org-clock-adjust-closest)
  16438. (org-timestamp-change n org-ts-what updown))
  16439. (message "Clock adjusted in %s for heading: %s"
  16440. (file-name-nondirectory (buffer-file-name))
  16441. (org-get-heading t t)))))))))
  16442. ;; Try to recenter the calendar window, if any.
  16443. (if (and org-calendar-follow-timestamp-change
  16444. (get-buffer-window "*Calendar*" t)
  16445. (memq org-ts-what '(day month year)))
  16446. (org-recenter-calendar (time-to-days time))))))
  16447. (defun org-modify-ts-extra (s pos n dm)
  16448. "Change the different parts of the lead-time and repeat fields in timestamp."
  16449. (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
  16450. ng h m new rem)
  16451. (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
  16452. (cond
  16453. ((or (org-pos-in-match-range pos 2)
  16454. (org-pos-in-match-range pos 3))
  16455. (setq m (string-to-number (match-string 3 s))
  16456. h (string-to-number (match-string 2 s)))
  16457. (if (org-pos-in-match-range pos 2)
  16458. (setq h (+ h n))
  16459. (setq n (* dm (org-no-warnings (signum n))))
  16460. (when (not (= 0 (setq rem (% m dm))))
  16461. (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
  16462. (setq m (+ m n)))
  16463. (if (< m 0) (setq m (+ m 60) h (1- h)))
  16464. (if (> m 59) (setq m (- m 60) h (1+ h)))
  16465. (setq h (min 24 (max 0 h)))
  16466. (setq ng 1 new (format "-%02d:%02d" h m)))
  16467. ((org-pos-in-match-range pos 6)
  16468. (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
  16469. ((org-pos-in-match-range pos 5)
  16470. (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
  16471. ((org-pos-in-match-range pos 9)
  16472. (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
  16473. ((org-pos-in-match-range pos 8)
  16474. (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
  16475. (when ng
  16476. (setq s (concat
  16477. (substring s 0 (match-beginning ng))
  16478. new
  16479. (substring s (match-end ng))))))
  16480. s))
  16481. (defun org-recenter-calendar (date)
  16482. "If the calendar is visible, recenter it to DATE."
  16483. (let ((cwin (get-buffer-window "*Calendar*" t)))
  16484. (when cwin
  16485. (let ((calendar-move-hook nil))
  16486. (with-selected-window cwin
  16487. (calendar-goto-date (if (listp date) date
  16488. (calendar-gregorian-from-absolute date))))))))
  16489. (defun org-goto-calendar (&optional arg)
  16490. "Go to the Emacs calendar at the current date.
  16491. If there is a time stamp in the current line, go to that date.
  16492. A prefix ARG can be used to force the current date."
  16493. (interactive "P")
  16494. (let ((tsr org-ts-regexp) diff
  16495. (calendar-move-hook nil)
  16496. (calendar-view-holidays-initially-flag nil)
  16497. (calendar-view-diary-initially-flag nil))
  16498. (if (or (org-at-timestamp-p)
  16499. (save-excursion
  16500. (beginning-of-line 1)
  16501. (looking-at (concat ".*" tsr))))
  16502. (let ((d1 (time-to-days (current-time)))
  16503. (d2 (time-to-days
  16504. (org-time-string-to-time (match-string 1)))))
  16505. (setq diff (- d2 d1))))
  16506. (calendar)
  16507. (calendar-goto-today)
  16508. (if (and diff (not arg)) (calendar-forward-day diff))))
  16509. (defun org-get-date-from-calendar ()
  16510. "Return a list (month day year) of date at point in calendar."
  16511. (with-current-buffer "*Calendar*"
  16512. (save-match-data
  16513. (calendar-cursor-to-date))))
  16514. (defun org-date-from-calendar ()
  16515. "Insert time stamp corresponding to cursor date in *Calendar* buffer.
  16516. If there is already a time stamp at the cursor position, update it."
  16517. (interactive)
  16518. (if (org-at-timestamp-p t)
  16519. (org-timestamp-change 0 'calendar)
  16520. (let ((cal-date (org-get-date-from-calendar)))
  16521. (org-insert-time-stamp
  16522. (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
  16523. (defcustom org-effort-durations
  16524. `(("min" . 1)
  16525. ("h" . 60)
  16526. ("d" . ,(* 60 8))
  16527. ("w" . ,(* 60 8 5))
  16528. ("m" . ,(* 60 8 5 4))
  16529. ("y" . ,(* 60 8 5 40)))
  16530. "Conversion factor to minutes for an effort modifier.
  16531. Each entry has the form (MODIFIER . MINUTES).
  16532. In an effort string, a number followed by MODIFIER is multiplied
  16533. by the specified number of MINUTES to obtain an effort in
  16534. minutes.
  16535. For example, if the value of this variable is ((\"hours\" . 60)), then an
  16536. effort string \"2hours\" is equivalent to 120 minutes."
  16537. :group 'org-agenda
  16538. :version "25.1"
  16539. :package-version '(Org . "8.3")
  16540. :type '(alist :key-type (string :tag "Modifier")
  16541. :value-type (number :tag "Minutes")))
  16542. (defun org-minutes-to-clocksum-string (m)
  16543. "Format number of minutes as a clocksum string.
  16544. The format is determined by `org-time-clocksum-format',
  16545. `org-time-clocksum-use-fractional' and
  16546. `org-time-clocksum-fractional-format' and
  16547. `org-time-clocksum-use-effort-durations'."
  16548. (let ((clocksum "")
  16549. (m (round m)) ; Don't allow fractions of minutes
  16550. h d w mo y fmt n)
  16551. (setq h (if org-time-clocksum-use-effort-durations
  16552. (cdr (assoc "h" org-effort-durations)) 60)
  16553. d (if org-time-clocksum-use-effort-durations
  16554. (/ (cdr (assoc "d" org-effort-durations)) h) 24)
  16555. w (if org-time-clocksum-use-effort-durations
  16556. (/ (cdr (assoc "w" org-effort-durations)) (* d h)) 7)
  16557. mo (if org-time-clocksum-use-effort-durations
  16558. (/ (cdr (assoc "m" org-effort-durations)) (* d h)) 30)
  16559. y (if org-time-clocksum-use-effort-durations
  16560. (/ (cdr (assoc "y" org-effort-durations)) (* d h)) 365))
  16561. ;; fractional format
  16562. (if org-time-clocksum-use-fractional
  16563. (cond
  16564. ;; single format string
  16565. ((stringp org-time-clocksum-fractional-format)
  16566. (format org-time-clocksum-fractional-format (/ m (float h))))
  16567. ;; choice of fractional formats for different time units
  16568. ((and (setq fmt (plist-get org-time-clocksum-fractional-format :years))
  16569. (> (/ (truncate m) (* y d h)) 0))
  16570. (format fmt (/ m (* y d (float h)))))
  16571. ((and (setq fmt (plist-get org-time-clocksum-fractional-format :months))
  16572. (> (/ (truncate m) (* mo d h)) 0))
  16573. (format fmt (/ m (* mo d (float h)))))
  16574. ((and (setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
  16575. (> (/ (truncate m) (* w d h)) 0))
  16576. (format fmt (/ m (* w d (float h)))))
  16577. ((and (setq fmt (plist-get org-time-clocksum-fractional-format :days))
  16578. (> (/ (truncate m) (* d h)) 0))
  16579. (format fmt (/ m (* d (float h)))))
  16580. ((and (setq fmt (plist-get org-time-clocksum-fractional-format :hours))
  16581. (> (/ (truncate m) h) 0))
  16582. (format fmt (/ m (float h))))
  16583. ((setq fmt (plist-get org-time-clocksum-fractional-format :minutes))
  16584. (format fmt m))
  16585. ;; fall back to smallest time unit with a format
  16586. ((setq fmt (plist-get org-time-clocksum-fractional-format :hours))
  16587. (format fmt (/ m (float h))))
  16588. ((setq fmt (plist-get org-time-clocksum-fractional-format :days))
  16589. (format fmt (/ m (* d (float h)))))
  16590. ((setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
  16591. (format fmt (/ m (* w d (float h)))))
  16592. ((setq fmt (plist-get org-time-clocksum-fractional-format :months))
  16593. (format fmt (/ m (* mo d (float h)))))
  16594. ((setq fmt (plist-get org-time-clocksum-fractional-format :years))
  16595. (format fmt (/ m (* y d (float h))))))
  16596. ;; standard (non-fractional) format, with single format string
  16597. (if (stringp org-time-clocksum-format)
  16598. (format org-time-clocksum-format (setq n (/ m h)) (- m (* h n)))
  16599. ;; separate formats components
  16600. (and (setq fmt (plist-get org-time-clocksum-format :years))
  16601. (or (> (setq n (/ (truncate m) (* y d h))) 0)
  16602. (plist-get org-time-clocksum-format :require-years))
  16603. (setq clocksum (concat clocksum (format fmt n))
  16604. m (- m (* n y d h))))
  16605. (and (setq fmt (plist-get org-time-clocksum-format :months))
  16606. (or (> (setq n (/ (truncate m) (* mo d h))) 0)
  16607. (plist-get org-time-clocksum-format :require-months))
  16608. (setq clocksum (concat clocksum (format fmt n))
  16609. m (- m (* n mo d h))))
  16610. (and (setq fmt (plist-get org-time-clocksum-format :weeks))
  16611. (or (> (setq n (/ (truncate m) (* w d h))) 0)
  16612. (plist-get org-time-clocksum-format :require-weeks))
  16613. (setq clocksum (concat clocksum (format fmt n))
  16614. m (- m (* n w d h))))
  16615. (and (setq fmt (plist-get org-time-clocksum-format :days))
  16616. (or (> (setq n (/ (truncate m) (* d h))) 0)
  16617. (plist-get org-time-clocksum-format :require-days))
  16618. (setq clocksum (concat clocksum (format fmt n))
  16619. m (- m (* n d h))))
  16620. (and (setq fmt (plist-get org-time-clocksum-format :hours))
  16621. (or (> (setq n (/ (truncate m) h)) 0)
  16622. (plist-get org-time-clocksum-format :require-hours))
  16623. (setq clocksum (concat clocksum (format fmt n))
  16624. m (- m (* n h))))
  16625. (and (setq fmt (plist-get org-time-clocksum-format :minutes))
  16626. (or (> m 0) (plist-get org-time-clocksum-format :require-minutes))
  16627. (setq clocksum (concat clocksum (format fmt m))))
  16628. ;; return formatted time duration
  16629. clocksum))))
  16630. (defalias 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string)
  16631. (make-obsolete 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string
  16632. "Org mode version 8.0")
  16633. (defun org-hours-to-clocksum-string (n)
  16634. (org-minutes-to-clocksum-string (* n 60)))
  16635. (defun org-hh:mm-string-to-minutes (s)
  16636. "Convert a string H:MM to a number of minutes.
  16637. If the string is just a number, interpret it as minutes.
  16638. In fact, the first hh:mm or number in the string will be taken,
  16639. there can be extra stuff in the string.
  16640. If no number is found, the return value is 0."
  16641. (cond
  16642. ((integerp s) s)
  16643. ((string-match "\\([0-9]+\\):\\([0-9]+\\)" s)
  16644. (+ (* (string-to-number (match-string 1 s)) 60)
  16645. (string-to-number (match-string 2 s))))
  16646. ((string-match "\\([0-9]+\\)" s)
  16647. (string-to-number (match-string 1 s)))
  16648. (t 0)))
  16649. (defcustom org-image-actual-width t
  16650. "Should we use the actual width of images when inlining them?
  16651. When set to `t', always use the image width.
  16652. When set to a number, use imagemagick (when available) to set
  16653. the image's width to this value.
  16654. When set to a number in a list, try to get the width from any
  16655. #+ATTR.* keyword if it matches a width specification like
  16656. #+ATTR_HTML: :width 300px
  16657. and fall back on that number if none is found.
  16658. When set to nil, try to get the width from an #+ATTR.* keyword
  16659. and fall back on the original width if none is found.
  16660. This requires Emacs >= 24.1, build with imagemagick support."
  16661. :group 'org-appearance
  16662. :version "24.4"
  16663. :package-version '(Org . "8.0")
  16664. :type '(choice
  16665. (const :tag "Use the image width" t)
  16666. (integer :tag "Use a number of pixels")
  16667. (list :tag "Use #+ATTR* or a number of pixels" (integer))
  16668. (const :tag "Use #+ATTR* or don't resize" nil)))
  16669. (defcustom org-agenda-inhibit-startup nil
  16670. "Inhibit startup when preparing agenda buffers.
  16671. When this variable is `t', the initialization of the Org agenda
  16672. buffers is inhibited: e.g. the visibility state is not set, the
  16673. tables are not re-aligned, etc."
  16674. :type 'boolean
  16675. :version "24.3"
  16676. :group 'org-agenda)
  16677. (define-obsolete-variable-alias
  16678. 'org-agenda-ignore-drawer-properties
  16679. 'org-agenda-ignore-properties "25.1")
  16680. (defcustom org-agenda-ignore-properties nil
  16681. "Avoid updating text properties when building the agenda.
  16682. Properties are used to prepare buffers for effort estimates,
  16683. appointments, statistics and subtree-local categories.
  16684. If you don't use these in the agenda, you can add them to this
  16685. list and agenda building will be a bit faster.
  16686. The value is a list, with zero or more of the symbols `effort', `appt',
  16687. `stats' or `category'."
  16688. :type '(set :greedy t
  16689. (const effort)
  16690. (const appt)
  16691. (const stats)
  16692. (const category))
  16693. :version "25.1"
  16694. :package-version '(Org . "8.3")
  16695. :group 'org-agenda)
  16696. (defun org-duration-string-to-minutes (s &optional output-to-string)
  16697. "Convert a duration string S to minutes.
  16698. A bare number is interpreted as minutes, modifiers can be set by
  16699. customizing `org-effort-durations' (which see).
  16700. Entries containing a colon are interpreted as H:MM by
  16701. `org-hh:mm-string-to-minutes'."
  16702. (let ((result 0)
  16703. (re (concat "\\([0-9.]+\\) *\\("
  16704. (regexp-opt (mapcar 'car org-effort-durations))
  16705. "\\)")))
  16706. (while (string-match re s)
  16707. (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
  16708. (string-to-number (match-string 1 s))))
  16709. (setq s (replace-match "" nil t s)))
  16710. (setq result (floor result))
  16711. (incf result (org-hh:mm-string-to-minutes s))
  16712. (if output-to-string (number-to-string result) result)))
  16713. ;;;; Files
  16714. (defun org-save-all-org-buffers ()
  16715. "Save all Org-mode buffers without user confirmation."
  16716. (interactive)
  16717. (message "Saving all Org-mode buffers...")
  16718. (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
  16719. (when (featurep 'org-id) (org-id-locations-save))
  16720. (message "Saving all Org-mode buffers... done"))
  16721. (defun org-revert-all-org-buffers ()
  16722. "Revert all Org-mode buffers.
  16723. Prompt for confirmation when there are unsaved changes.
  16724. Be sure you know what you are doing before letting this function
  16725. overwrite your changes.
  16726. This function is useful in a setup where one tracks org files
  16727. with a version control system, to revert on one machine after pulling
  16728. changes from another. I believe the procedure must be like this:
  16729. 1. M-x org-save-all-org-buffers
  16730. 2. Pull changes from the other machine, resolve conflicts
  16731. 3. M-x org-revert-all-org-buffers"
  16732. (interactive)
  16733. (unless (yes-or-no-p "Revert all Org buffers from their files? ")
  16734. (user-error "Abort"))
  16735. (save-excursion
  16736. (save-window-excursion
  16737. (mapc
  16738. (lambda (b)
  16739. (when (and (with-current-buffer b (derived-mode-p 'org-mode))
  16740. (with-current-buffer b buffer-file-name))
  16741. (org-pop-to-buffer-same-window b)
  16742. (revert-buffer t 'no-confirm)))
  16743. (buffer-list))
  16744. (when (and (featurep 'org-id) org-id-track-globally)
  16745. (org-id-locations-load)))))
  16746. ;;;; Agenda files
  16747. ;;;###autoload
  16748. (defun org-switchb (&optional arg)
  16749. "Switch between Org buffers.
  16750. With one prefix argument, restrict available buffers to files.
  16751. With two prefix arguments, restrict available buffers to agenda files.
  16752. Defaults to `iswitchb' for buffer name completion.
  16753. Set `org-completion-use-ido' to make it use ido instead."
  16754. (interactive "P")
  16755. (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
  16756. ((equal arg '(16)) (org-buffer-list 'agenda))
  16757. (t (org-buffer-list))))
  16758. (org-completion-use-iswitchb org-completion-use-iswitchb)
  16759. (org-completion-use-ido org-completion-use-ido))
  16760. (unless (or org-completion-use-ido org-completion-use-iswitchb)
  16761. (setq org-completion-use-iswitchb t))
  16762. (org-pop-to-buffer-same-window
  16763. (org-icompleting-read "Org buffer: "
  16764. (mapcar 'list (mapcar 'buffer-name blist))
  16765. nil t))))
  16766. ;;; Define some older names previously used for this functionality
  16767. ;;;###autoload
  16768. (defalias 'org-ido-switchb 'org-switchb)
  16769. ;;;###autoload
  16770. (defalias 'org-iswitchb 'org-switchb)
  16771. (defun org-buffer-list (&optional predicate exclude-tmp)
  16772. "Return a list of Org buffers.
  16773. PREDICATE can be `export', `files' or `agenda'.
  16774. export restrict the list to Export buffers.
  16775. files restrict the list to buffers visiting Org files.
  16776. agenda restrict the list to buffers visiting agenda files.
  16777. If EXCLUDE-TMP is non-nil, ignore temporary buffers."
  16778. (let* ((bfn nil)
  16779. (agenda-files (and (eq predicate 'agenda)
  16780. (mapcar 'file-truename (org-agenda-files t))))
  16781. (filter
  16782. (cond
  16783. ((eq predicate 'files)
  16784. (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
  16785. ((eq predicate 'export)
  16786. (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
  16787. ((eq predicate 'agenda)
  16788. (lambda (b)
  16789. (with-current-buffer b
  16790. (and (derived-mode-p 'org-mode)
  16791. (setq bfn (buffer-file-name b))
  16792. (member (file-truename bfn) agenda-files)))))
  16793. (t (lambda (b) (with-current-buffer b
  16794. (or (derived-mode-p 'org-mode)
  16795. (string-match "\*Org .*Export"
  16796. (buffer-name b)))))))))
  16797. (delq nil
  16798. (mapcar
  16799. (lambda(b)
  16800. (if (and (funcall filter b)
  16801. (or (not exclude-tmp)
  16802. (not (string-match "tmp" (buffer-name b)))))
  16803. b
  16804. nil))
  16805. (buffer-list)))))
  16806. (defun org-agenda-files (&optional unrestricted archives)
  16807. "Get the list of agenda files.
  16808. Optional UNRESTRICTED means return the full list even if a restriction
  16809. is currently in place.
  16810. When ARCHIVES is t, include all archive files that are really being
  16811. used by the agenda files. If ARCHIVE is `ifmode', do this only if
  16812. `org-agenda-archives-mode' is t."
  16813. (let ((files
  16814. (cond
  16815. ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
  16816. ((stringp org-agenda-files) (org-read-agenda-file-list))
  16817. ((listp org-agenda-files) org-agenda-files)
  16818. (t (error "Invalid value of `org-agenda-files'")))))
  16819. (setq files (apply 'append
  16820. (mapcar (lambda (f)
  16821. (if (file-directory-p f)
  16822. (directory-files
  16823. f t org-agenda-file-regexp)
  16824. (list f)))
  16825. files)))
  16826. (when org-agenda-skip-unavailable-files
  16827. (setq files (delq nil
  16828. (mapcar (function
  16829. (lambda (file)
  16830. (and (file-readable-p file) file)))
  16831. files))))
  16832. (when (or (eq archives t)
  16833. (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
  16834. (setq files (org-add-archive-files files)))
  16835. files))
  16836. (defun org-agenda-file-p (&optional file)
  16837. "Return non-nil, if FILE is an agenda file.
  16838. If FILE is omitted, use the file associated with the current
  16839. buffer."
  16840. (let ((fname (or file (buffer-file-name))))
  16841. (and fname
  16842. (member (file-truename fname)
  16843. (mapcar #'file-truename (org-agenda-files t))))))
  16844. (defun org-edit-agenda-file-list ()
  16845. "Edit the list of agenda files.
  16846. Depending on setup, this either uses customize to edit the variable
  16847. `org-agenda-files', or it visits the file that is holding the list. In the
  16848. latter case, the buffer is set up in a way that saving it automatically kills
  16849. the buffer and restores the previous window configuration."
  16850. (interactive)
  16851. (if (stringp org-agenda-files)
  16852. (let ((cw (current-window-configuration)))
  16853. (find-file org-agenda-files)
  16854. (org-set-local 'org-window-configuration cw)
  16855. (org-add-hook 'after-save-hook
  16856. (lambda ()
  16857. (set-window-configuration
  16858. (prog1 org-window-configuration
  16859. (kill-buffer (current-buffer))))
  16860. (org-install-agenda-files-menu)
  16861. (message "New agenda file list installed"))
  16862. nil 'local)
  16863. (message "%s" (substitute-command-keys
  16864. "Edit list and finish with \\[save-buffer]")))
  16865. (customize-variable 'org-agenda-files)))
  16866. (defun org-store-new-agenda-file-list (list)
  16867. "Set new value for the agenda file list and save it correctly."
  16868. (if (stringp org-agenda-files)
  16869. (let ((fe (org-read-agenda-file-list t)) b u)
  16870. (while (setq b (find-buffer-visiting org-agenda-files))
  16871. (kill-buffer b))
  16872. (with-temp-file org-agenda-files
  16873. (insert
  16874. (mapconcat
  16875. (lambda (f) ;; Keep un-expanded entries.
  16876. (if (setq u (assoc f fe))
  16877. (cdr u)
  16878. f))
  16879. list "\n")
  16880. "\n")))
  16881. (let ((org-mode-hook nil) (org-inhibit-startup t)
  16882. (org-insert-mode-line-in-empty-file nil))
  16883. (setq org-agenda-files list)
  16884. (customize-save-variable 'org-agenda-files org-agenda-files))))
  16885. (defun org-read-agenda-file-list (&optional pair-with-expansion)
  16886. "Read the list of agenda files from a file.
  16887. If PAIR-WITH-EXPANSION is t return pairs with un-expanded
  16888. filenames, used by `org-store-new-agenda-file-list' to write back
  16889. un-expanded file names."
  16890. (when (file-directory-p org-agenda-files)
  16891. (error "`org-agenda-files' cannot be a single directory"))
  16892. (when (stringp org-agenda-files)
  16893. (with-temp-buffer
  16894. (insert-file-contents org-agenda-files)
  16895. (mapcar
  16896. (lambda (f)
  16897. (let ((e (expand-file-name (substitute-in-file-name f)
  16898. org-directory)))
  16899. (if pair-with-expansion
  16900. (cons e f)
  16901. e)))
  16902. (org-split-string (buffer-string) "[ \t\r\n]*?[\r\n][ \t\r\n]*")))))
  16903. ;;;###autoload
  16904. (defun org-cycle-agenda-files ()
  16905. "Cycle through the files in `org-agenda-files'.
  16906. If the current buffer visits an agenda file, find the next one in the list.
  16907. If the current buffer does not, find the first agenda file."
  16908. (interactive)
  16909. (let* ((fs (org-agenda-files t))
  16910. (files (append fs (list (car fs))))
  16911. (tcf (if buffer-file-name (file-truename buffer-file-name)))
  16912. file)
  16913. (unless files (user-error "No agenda files"))
  16914. (catch 'exit
  16915. (while (setq file (pop files))
  16916. (if (equal (file-truename file) tcf)
  16917. (when (car files)
  16918. (find-file (car files))
  16919. (throw 'exit t))))
  16920. (find-file (car fs)))
  16921. (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
  16922. (defun org-agenda-file-to-front (&optional to-end)
  16923. "Move/add the current file to the top of the agenda file list.
  16924. If the file is not present in the list, it is added to the front. If it is
  16925. present, it is moved there. With optional argument TO-END, add/move to the
  16926. end of the list."
  16927. (interactive "P")
  16928. (let ((org-agenda-skip-unavailable-files nil)
  16929. (file-alist (mapcar (lambda (x)
  16930. (cons (file-truename x) x))
  16931. (org-agenda-files t)))
  16932. (ctf (file-truename
  16933. (or buffer-file-name
  16934. (user-error "Please save the current buffer to a file"))))
  16935. x had)
  16936. (setq x (assoc ctf file-alist) had x)
  16937. (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
  16938. (if to-end
  16939. (setq file-alist (append (delq x file-alist) (list x)))
  16940. (setq file-alist (cons x (delq x file-alist))))
  16941. (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
  16942. (org-install-agenda-files-menu)
  16943. (message "File %s to %s of agenda file list"
  16944. (if had "moved" "added") (if to-end "end" "front"))))
  16945. (defun org-remove-file (&optional file)
  16946. "Remove current file from the list of files in variable `org-agenda-files'.
  16947. These are the files which are being checked for agenda entries.
  16948. Optional argument FILE means use this file instead of the current."
  16949. (interactive)
  16950. (let* ((org-agenda-skip-unavailable-files nil)
  16951. (file (or file buffer-file-name
  16952. (user-error "Current buffer does not visit a file")))
  16953. (true-file (file-truename file))
  16954. (afile (abbreviate-file-name file))
  16955. (files (delq nil (mapcar
  16956. (lambda (x)
  16957. (if (equal true-file
  16958. (file-truename x))
  16959. nil x))
  16960. (org-agenda-files t)))))
  16961. (if (not (= (length files) (length (org-agenda-files t))))
  16962. (progn
  16963. (org-store-new-agenda-file-list files)
  16964. (org-install-agenda-files-menu)
  16965. (message "Removed from Org Agenda list: %s" afile))
  16966. (message "File was not in list: %s (not removed)" afile))))
  16967. (defun org-file-menu-entry (file)
  16968. (vector file (list 'find-file file) t))
  16969. (defun org-check-agenda-file (file)
  16970. "Make sure FILE exists. If not, ask user what to do."
  16971. (when (not (file-exists-p file))
  16972. (message "Non-existent agenda file %s. [R]emove from list or [A]bort?"
  16973. (abbreviate-file-name file))
  16974. (let ((r (downcase (read-char-exclusive))))
  16975. (cond
  16976. ((equal r ?r)
  16977. (org-remove-file file)
  16978. (throw 'nextfile t))
  16979. (t (user-error "Abort"))))))
  16980. (defun org-get-agenda-file-buffer (file)
  16981. "Get an agenda buffer visiting FILE.
  16982. If the buffer needs to be created, add it to the list of buffers
  16983. which might be released later."
  16984. (let ((buf (org-find-base-buffer-visiting file)))
  16985. (if buf
  16986. buf ; just return it
  16987. ;; Make a new buffer and remember it
  16988. (setq buf (find-file-noselect file))
  16989. (if buf (push buf org-agenda-new-buffers))
  16990. buf)))
  16991. (defun org-release-buffers (blist)
  16992. "Release all buffers in list, asking the user for confirmation when needed.
  16993. When a buffer is unmodified, it is just killed. When modified, it is saved
  16994. \(if the user agrees) and then killed."
  16995. (let (buf file)
  16996. (while (setq buf (pop blist))
  16997. (setq file (buffer-file-name buf))
  16998. (when (and (buffer-modified-p buf)
  16999. file
  17000. (y-or-n-p (format "Save file %s? " file)))
  17001. (with-current-buffer buf (save-buffer)))
  17002. (kill-buffer buf))))
  17003. (defun org-agenda-prepare-buffers (files)
  17004. "Create buffers for all agenda files, protect archived trees and comments."
  17005. (interactive)
  17006. (let ((pa '(:org-archived t))
  17007. (pc '(:org-comment t))
  17008. (pall '(:org-archived t :org-comment t))
  17009. (inhibit-read-only t)
  17010. (org-inhibit-startup org-agenda-inhibit-startup)
  17011. (rea (concat ":" org-archive-tag ":"))
  17012. file re pos)
  17013. (setq org-tag-alist-for-agenda nil
  17014. org-tag-groups-alist-for-agenda nil)
  17015. (save-excursion
  17016. (save-restriction
  17017. (while (setq file (pop files))
  17018. (catch 'nextfile
  17019. (if (bufferp file)
  17020. (set-buffer file)
  17021. (org-check-agenda-file file)
  17022. (set-buffer (org-get-agenda-file-buffer file)))
  17023. (widen)
  17024. (org-set-regexps-and-options 'tags-only)
  17025. (setq pos (point))
  17026. (or (memq 'category org-agenda-ignore-properties)
  17027. (org-refresh-category-properties))
  17028. (or (memq 'stats org-agenda-ignore-properties)
  17029. (org-refresh-stats-properties))
  17030. (or (memq 'effort org-agenda-ignore-properties)
  17031. (org-refresh-effort-properties))
  17032. (or (memq 'appt org-agenda-ignore-properties)
  17033. (org-refresh-properties "APPT_WARNTIME" 'org-appt-warntime))
  17034. (setq org-todo-keywords-for-agenda
  17035. (append org-todo-keywords-for-agenda org-todo-keywords-1))
  17036. (setq org-done-keywords-for-agenda
  17037. (append org-done-keywords-for-agenda org-done-keywords))
  17038. (setq org-todo-keyword-alist-for-agenda
  17039. (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
  17040. (setq org-tag-alist-for-agenda
  17041. (org-uniquify
  17042. (append org-tag-alist-for-agenda
  17043. org-tag-alist
  17044. org-tag-persistent-alist)))
  17045. (if org-group-tags
  17046. (setq org-tag-groups-alist-for-agenda
  17047. (org-uniquify-alist
  17048. (append org-tag-groups-alist-for-agenda org-tag-groups-alist))))
  17049. (org-with-silent-modifications
  17050. (save-excursion
  17051. (remove-text-properties (point-min) (point-max) pall)
  17052. (when org-agenda-skip-archived-trees
  17053. (goto-char (point-min))
  17054. (while (re-search-forward rea nil t)
  17055. (if (org-at-heading-p t)
  17056. (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
  17057. (goto-char (point-min))
  17058. (setq re (format "^\\* .*\\<%s\\>" org-comment-string))
  17059. (while (re-search-forward re nil t)
  17060. (when (save-match-data (org-in-commented-heading-p t))
  17061. (add-text-properties
  17062. (match-beginning 0) (org-end-of-subtree t) pc)))))
  17063. (goto-char pos)))))
  17064. (setq org-todo-keywords-for-agenda
  17065. (org-uniquify org-todo-keywords-for-agenda))
  17066. (setq org-todo-keyword-alist-for-agenda
  17067. (org-uniquify org-todo-keyword-alist-for-agenda))))
  17068. ;;;; CDLaTeX minor mode
  17069. (defvar org-cdlatex-mode-map (make-sparse-keymap)
  17070. "Keymap for the minor `org-cdlatex-mode'.")
  17071. (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
  17072. (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
  17073. (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
  17074. (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
  17075. (org-defkey org-cdlatex-mode-map "\C-c{" 'org-cdlatex-environment-indent)
  17076. (defvar org-cdlatex-texmathp-advice-is-done nil
  17077. "Flag remembering if we have applied the advice to texmathp already.")
  17078. (define-minor-mode org-cdlatex-mode
  17079. "Toggle the minor `org-cdlatex-mode'.
  17080. This mode supports entering LaTeX environment and math in LaTeX fragments
  17081. in Org-mode.
  17082. \\{org-cdlatex-mode-map}"
  17083. nil " OCDL" nil
  17084. (when org-cdlatex-mode
  17085. (require 'cdlatex)
  17086. (run-hooks 'cdlatex-mode-hook)
  17087. (cdlatex-compute-tables))
  17088. (unless org-cdlatex-texmathp-advice-is-done
  17089. (setq org-cdlatex-texmathp-advice-is-done t)
  17090. (defadvice texmathp (around org-math-always-on activate)
  17091. "Always return t in org-mode buffers.
  17092. This is because we want to insert math symbols without dollars even outside
  17093. the LaTeX math segments. If Orgmode thinks that point is actually inside
  17094. an embedded LaTeX fragment, let texmathp do its job.
  17095. \\[org-cdlatex-mode-map]"
  17096. (interactive)
  17097. (let (p)
  17098. (cond
  17099. ((not (derived-mode-p 'org-mode)) ad-do-it)
  17100. ((eq this-command 'cdlatex-math-symbol)
  17101. (setq ad-return-value t
  17102. texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
  17103. (t
  17104. (let ((p (org-inside-LaTeX-fragment-p)))
  17105. (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
  17106. (setq ad-return-value t
  17107. texmathp-why '("Org-mode embedded math" . 0))
  17108. (if p ad-do-it)))))))))
  17109. (defun turn-on-org-cdlatex ()
  17110. "Unconditionally turn on `org-cdlatex-mode'."
  17111. (org-cdlatex-mode 1))
  17112. (defun org-try-cdlatex-tab ()
  17113. "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
  17114. It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
  17115. - inside a LaTeX fragment, or
  17116. - after the first word in a line, where an abbreviation expansion could
  17117. insert a LaTeX environment."
  17118. (when org-cdlatex-mode
  17119. (cond
  17120. ;; Before any word on the line: No expansion possible.
  17121. ((save-excursion (skip-chars-backward " \t") (bolp)) nil)
  17122. ;; Just after first word on the line: Expand it. Make sure it
  17123. ;; cannot happen on headlines, though.
  17124. ((save-excursion
  17125. (skip-chars-backward "a-zA-Z0-9*")
  17126. (skip-chars-backward " \t")
  17127. (and (bolp) (not (org-at-heading-p))))
  17128. (cdlatex-tab) t)
  17129. ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
  17130. (defun org-cdlatex-underscore-caret (&optional arg)
  17131. "Execute `cdlatex-sub-superscript' in LaTeX fragments.
  17132. Revert to the normal definition outside of these fragments."
  17133. (interactive "P")
  17134. (if (org-inside-LaTeX-fragment-p)
  17135. (call-interactively 'cdlatex-sub-superscript)
  17136. (let (org-cdlatex-mode)
  17137. (call-interactively (key-binding (vector last-input-event))))))
  17138. (defun org-cdlatex-math-modify (&optional arg)
  17139. "Execute `cdlatex-math-modify' in LaTeX fragments.
  17140. Revert to the normal definition outside of these fragments."
  17141. (interactive "P")
  17142. (if (org-inside-LaTeX-fragment-p)
  17143. (call-interactively 'cdlatex-math-modify)
  17144. (let (org-cdlatex-mode)
  17145. (call-interactively (key-binding (vector last-input-event))))))
  17146. (defun org-cdlatex-environment-indent (&optional environment item)
  17147. "Execute `cdlatex-environment' and indent the inserted environment.
  17148. ENVIRONMENT and ITEM are passed to `cdlatex-environment'.
  17149. The inserted environment is indented to current indentation
  17150. unless point is at the beginning of the line, in which the
  17151. environment remains unintended."
  17152. (interactive)
  17153. ;; cdlatex-environment always return nil. Therefore, capture output
  17154. ;; first and determine if an environment was selected.
  17155. (let* ((beg (point-marker))
  17156. (end (copy-marker (point) t))
  17157. (inserted (progn
  17158. (ignore-errors (cdlatex-environment environment item))
  17159. (< beg end)))
  17160. ;; Figure out how many lines to move forward after the
  17161. ;; environment has been inserted.
  17162. (lines (when inserted
  17163. (save-excursion
  17164. (- (loop while (< beg (point))
  17165. with x = 0
  17166. do (forward-line -1)
  17167. (incf x)
  17168. finally return x)
  17169. (if (progn (goto-char beg)
  17170. (and (progn (skip-chars-forward " \t") (eolp))
  17171. (progn (skip-chars-backward " \t") (bolp))))
  17172. 1 0)))))
  17173. (env (org-trim (delete-and-extract-region beg end))))
  17174. (when inserted
  17175. ;; Get indentation of next line unless at column 0.
  17176. (let ((ind (if (bolp) 0
  17177. (save-excursion
  17178. (org-return-indent)
  17179. (prog1 (org-get-indentation)
  17180. (when (progn (skip-chars-forward " \t") (eolp))
  17181. (delete-region beg (point)))))))
  17182. (bol (progn (skip-chars-backward " \t") (bolp))))
  17183. ;; Insert a newline before environment unless at column zero
  17184. ;; to "escape" the current line. Insert a newline if
  17185. ;; something is one the same line as \end{ENVIRONMENT}.
  17186. (insert
  17187. (concat (unless bol "\n") env
  17188. (when (and (skip-chars-forward " \t") (not (eolp))) "\n")))
  17189. (unless (zerop ind)
  17190. (save-excursion
  17191. (goto-char beg)
  17192. (while (< (point) end)
  17193. (unless (eolp) (org-indent-line-to ind))
  17194. (forward-line))))
  17195. (goto-char beg)
  17196. (forward-line lines)
  17197. (org-indent-line-to ind)))
  17198. (set-marker beg nil)
  17199. (set-marker end nil)))
  17200. ;;;; LaTeX fragments
  17201. (defun org-inside-LaTeX-fragment-p ()
  17202. "Test if point is inside a LaTeX fragment.
  17203. I.e. after a \\begin, \\(, \\[, $, or $$, without the corresponding closing
  17204. sequence appearing also before point.
  17205. Even though the matchers for math are configurable, this function assumes
  17206. that \\begin, \\(, \\[, and $$ are always used. Only the single dollar
  17207. delimiters are skipped when they have been removed by customization.
  17208. The return value is nil, or a cons cell with the delimiter and the
  17209. position of this delimiter.
  17210. This function does a reasonably good job, but can locally be fooled by
  17211. for example currency specifications. For example it will assume being in
  17212. inline math after \"$22.34\". The LaTeX fragment formatter will only format
  17213. fragments that are properly closed, but during editing, we have to live
  17214. with the uncertainty caused by missing closing delimiters. This function
  17215. looks only before point, not after."
  17216. (catch 'exit
  17217. (let ((pos (point))
  17218. (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
  17219. (lim (progn
  17220. (re-search-backward (concat "^\\(" paragraph-start "\\)") nil t)
  17221. (point)))
  17222. dd-on str (start 0) m re)
  17223. (goto-char pos)
  17224. (when dodollar
  17225. (setq str (concat (buffer-substring lim (point)) "\000 X$.")
  17226. re (nth 1 (assoc "$" org-latex-regexps)))
  17227. (while (string-match re str start)
  17228. (cond
  17229. ((= (match-end 0) (length str))
  17230. (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
  17231. ((= (match-end 0) (- (length str) 5))
  17232. (throw 'exit nil))
  17233. (t (setq start (match-end 0))))))
  17234. (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
  17235. (goto-char pos)
  17236. (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
  17237. (and (match-beginning 2) (throw 'exit nil))
  17238. ;; count $$
  17239. (while (re-search-backward "\\$\\$" lim t)
  17240. (setq dd-on (not dd-on)))
  17241. (goto-char pos)
  17242. (if dd-on (cons "$$" m))))))
  17243. (defun org-inside-latex-macro-p ()
  17244. "Is point inside a LaTeX macro or its arguments?"
  17245. (save-match-data
  17246. (org-in-regexp
  17247. "\\\\[a-zA-Z]+\\*?\\(\\(\\[[^][\n{}]*\\]\\)\\|\\({[^{}\n]*}\\)\\)*")))
  17248. (defvar org-latex-fragment-image-overlays nil
  17249. "List of overlays carrying the images of latex fragments.")
  17250. (make-variable-buffer-local 'org-latex-fragment-image-overlays)
  17251. (defun org-remove-latex-fragment-image-overlays (&optional beg end)
  17252. "Remove all overlays with LaTeX fragment images in current buffer.
  17253. When optional arguments BEG and END are non-nil, remove all
  17254. overlays between them instead. Return t when some overlays were
  17255. removed, nil otherwise."
  17256. (let (removedp)
  17257. (setq org-latex-fragment-image-overlays
  17258. (let ((beg (or beg (point-min)))
  17259. (end (or end (point-max))))
  17260. (org-remove-if
  17261. (lambda (o)
  17262. (and (>= (overlay-start o) beg)
  17263. (<= (overlay-end o) end)
  17264. (progn (delete-overlay o)
  17265. (or removedp (setq removedp t)))))
  17266. org-latex-fragment-image-overlays)))
  17267. removedp))
  17268. (define-obsolete-function-alias
  17269. 'org-preview-latex-fragment 'org-toggle-latex-fragment "24.4")
  17270. (defun org-toggle-latex-fragment (&optional arg)
  17271. "Preview the LaTeX fragment at point, or all locally or globally.
  17272. If the cursor is on a LaTeX fragment, create the image and overlay
  17273. it over the source code, if there is none. Remove it otherwise.
  17274. If there is no fragment at point, display all fragments in the
  17275. current section.
  17276. With prefix ARG, preview or clear image for all fragments in the
  17277. current subtree or in the whole buffer when used before the first
  17278. headline. With a double prefix ARG \\[universal-argument] \
  17279. \\[universal-argument] preview or clear images
  17280. for all fragments in the buffer."
  17281. (interactive "P")
  17282. (unless (buffer-file-name (buffer-base-buffer))
  17283. (user-error "Can't preview LaTeX fragment in a non-file buffer"))
  17284. (when (display-graphic-p)
  17285. (catch 'exit
  17286. (save-excursion
  17287. (let ((window-start (window-start)) msg)
  17288. (save-restriction
  17289. (cond
  17290. ((or (equal arg '(16))
  17291. (and (equal arg '(4))
  17292. (org-with-limited-levels (org-before-first-heading-p))))
  17293. (if (org-remove-latex-fragment-image-overlays)
  17294. (progn (message "LaTeX fragments images removed from buffer")
  17295. (throw 'exit nil))
  17296. (setq msg "Creating images for buffer...")))
  17297. ((equal arg '(4))
  17298. (org-with-limited-levels (org-back-to-heading t))
  17299. (let ((beg (point))
  17300. (end (progn (org-end-of-subtree t) (point))))
  17301. (if (org-remove-latex-fragment-image-overlays beg end)
  17302. (progn
  17303. (message "LaTeX fragment images removed from subtree")
  17304. (throw 'exit nil))
  17305. (setq msg "Creating images for subtree...")
  17306. (narrow-to-region beg end))))
  17307. ((let ((datum (org-element-context)))
  17308. (when (memq (org-element-type datum)
  17309. '(latex-environment latex-fragment))
  17310. (let* ((beg (org-element-property :begin datum))
  17311. (end (org-element-property :end datum)))
  17312. (if (org-remove-latex-fragment-image-overlays beg end)
  17313. (progn (message "LaTeX fragment image removed")
  17314. (throw 'exit nil))
  17315. (narrow-to-region beg end)
  17316. (setq msg "Creating image..."))))))
  17317. (t
  17318. (org-with-limited-levels
  17319. (let ((beg (if (org-at-heading-p) (line-beginning-position)
  17320. (outline-previous-heading)
  17321. (point)))
  17322. (end (progn (outline-next-heading) (point))))
  17323. (if (org-remove-latex-fragment-image-overlays beg end)
  17324. (progn
  17325. (message "LaTeX fragment images removed from section")
  17326. (throw 'exit nil))
  17327. (setq msg "Creating images for section...")
  17328. (narrow-to-region beg end))))))
  17329. (let ((file (buffer-file-name (buffer-base-buffer))))
  17330. (org-format-latex
  17331. (concat org-latex-preview-ltxpng-directory
  17332. (file-name-sans-extension (file-name-nondirectory file)))
  17333. ;; Emacs cannot overlay images from remote hosts.
  17334. ;; Create it in `temporary-file-directory' instead.
  17335. (if (file-remote-p file) temporary-file-directory
  17336. default-directory)
  17337. 'overlays msg 'forbuffer
  17338. org-latex-create-formula-image-program)))
  17339. ;; Work around a bug that doesn't restore window's start
  17340. ;; when widening back the buffer.
  17341. (set-window-start nil window-start)
  17342. (message (concat msg "done")))))))
  17343. (defun org-format-latex
  17344. (prefix &optional dir overlays msg forbuffer processing-type)
  17345. "Replace LaTeX fragments with links to an image, and produce images.
  17346. When optional argument OVERLAYS is non-nil, display the image on
  17347. top of the fragment instead of replacing it.
  17348. PROCESSING-TYPE is the conversion method to use, as a symbol.
  17349. Some of the options can be changed using the variable
  17350. `org-format-latex-options', which see."
  17351. (when (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
  17352. (unless (eq processing-type 'verbatim)
  17353. (let* ((math-regexp "\\$\\|\\\\[([]\\|^[ \t]*\\\\begin{[A-Za-z0-9*]+}")
  17354. (cnt 0)
  17355. checkdir-flag)
  17356. (goto-char (point-min))
  17357. ;; Optimize overlay creation: (info "(elisp) Managing Overlays").
  17358. (when (and overlays (memq processing-type '(dvipng imagemagick)))
  17359. (overlay-recenter (point-max)))
  17360. (while (re-search-forward math-regexp nil t)
  17361. (unless (and overlays
  17362. (eq (get-char-property (point) 'org-overlay-type)
  17363. 'org-latex-overlay))
  17364. (let* ((context (org-element-context))
  17365. (type (org-element-type context)))
  17366. (when (memq type '(latex-environment latex-fragment))
  17367. (let ((block-type (eq type 'latex-environment))
  17368. (value (org-element-property :value context))
  17369. (beg (org-element-property :begin context))
  17370. (end (save-excursion
  17371. (goto-char (org-element-property :end context))
  17372. (skip-chars-backward " \r\t\n")
  17373. (point))))
  17374. (case processing-type
  17375. (mathjax
  17376. ;; Prepare for MathJax processing.
  17377. (if (eq (char-after beg) ?$)
  17378. (save-excursion
  17379. (delete-region beg end)
  17380. (insert "\\(" (substring value 1 -1) "\\)"))
  17381. (goto-char end)))
  17382. ((dvipng imagemagick)
  17383. ;; Process to an image.
  17384. (incf cnt)
  17385. (goto-char beg)
  17386. (let* ((face (face-at-point))
  17387. ;; Get the colors from the face at point.
  17388. (fg
  17389. (let ((color (plist-get org-format-latex-options
  17390. :foreground)))
  17391. (if (and forbuffer (eq color 'auto))
  17392. (face-attribute face :foreground nil 'default)
  17393. color)))
  17394. (bg
  17395. (let ((color (plist-get org-format-latex-options
  17396. :background)))
  17397. (if (and forbuffer (eq color 'auto))
  17398. (face-attribute face :background nil 'default)
  17399. color)))
  17400. (hash (sha1 (prin1-to-string
  17401. (list org-format-latex-header
  17402. org-latex-default-packages-alist
  17403. org-latex-packages-alist
  17404. org-format-latex-options
  17405. forbuffer value fg bg))))
  17406. (absprefix (expand-file-name prefix dir))
  17407. (linkfile (format "%s_%s.png" prefix hash))
  17408. (movefile (format "%s_%s.png" absprefix hash))
  17409. (sep (and block-type "\n\n"))
  17410. (link (concat sep "[[file:" linkfile "]]" sep))
  17411. (options
  17412. (org-combine-plists
  17413. org-format-latex-options
  17414. `(:foreground ,fg :background ,bg))))
  17415. (when msg (message msg cnt))
  17416. (unless checkdir-flag ; Ensure the directory exists.
  17417. (setq checkdir-flag t)
  17418. (let ((todir (file-name-directory absprefix)))
  17419. (unless (file-directory-p todir)
  17420. (make-directory todir t))))
  17421. (unless (file-exists-p movefile)
  17422. (org-create-formula-image
  17423. value movefile options forbuffer processing-type))
  17424. (if overlays
  17425. (progn
  17426. (dolist (o (overlays-in beg end))
  17427. (when (eq (overlay-get o 'org-overlay-type)
  17428. 'org-latex-overlay)
  17429. (delete-overlay o)))
  17430. (let ((ov (make-overlay beg end)))
  17431. (overlay-put ov
  17432. 'org-overlay-type
  17433. 'org-latex-overlay)
  17434. (overlay-put ov 'evaporate t)
  17435. (if (featurep 'xemacs)
  17436. (progn
  17437. (overlay-put ov 'invisible t)
  17438. (overlay-put
  17439. ov 'end-glyph
  17440. (make-glyph
  17441. (vector 'png :file movefile))))
  17442. (overlay-put
  17443. ov 'display
  17444. (list 'image
  17445. :type 'png
  17446. :file movefile
  17447. :ascent 'center)))
  17448. (push ov org-latex-fragment-image-overlays))
  17449. (goto-char end))
  17450. (delete-region beg end)
  17451. (insert
  17452. (org-add-props link
  17453. (list 'org-latex-src
  17454. (replace-regexp-in-string "\"" "" value)
  17455. 'org-latex-src-embed-type
  17456. (if block-type 'paragraph 'character)))))))
  17457. (mathml
  17458. ;; Process to MathML.
  17459. (unless (org-format-latex-mathml-available-p)
  17460. (user-error "LaTeX to MathML converter not configured"))
  17461. (incf cnt)
  17462. (when msg (message msg cnt))
  17463. (goto-char beg)
  17464. (delete-region beg end)
  17465. (insert (org-format-latex-as-mathml
  17466. value block-type prefix dir)))
  17467. (otherwise
  17468. (error "Unknown conversion type %s for LaTeX fragments"
  17469. processing-type)))))))))))
  17470. (defun org-create-math-formula (latex-frag &optional mathml-file)
  17471. "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
  17472. Use `org-latex-to-mathml-convert-command'. If the conversion is
  17473. sucessful, return the portion between \"<math...> </math>\"
  17474. elements otherwise return nil. When MATHML-FILE is specified,
  17475. write the results in to that file. When invoked as an
  17476. interactive command, prompt for LATEX-FRAG, with initial value
  17477. set to the current active region and echo the results for user
  17478. inspection."
  17479. (interactive (list (let ((frag (when (org-region-active-p)
  17480. (buffer-substring-no-properties
  17481. (region-beginning) (region-end)))))
  17482. (read-string "LaTeX Fragment: " frag nil frag))))
  17483. (unless latex-frag (user-error "Invalid LaTeX fragment"))
  17484. (let* ((tmp-in-file (file-relative-name
  17485. (make-temp-name (expand-file-name "ltxmathml-in"))))
  17486. (ignore (write-region latex-frag nil tmp-in-file))
  17487. (tmp-out-file (file-relative-name
  17488. (make-temp-name (expand-file-name "ltxmathml-out"))))
  17489. (cmd (format-spec
  17490. org-latex-to-mathml-convert-command
  17491. `((?j . ,(and org-latex-to-mathml-jar-file
  17492. (shell-quote-argument
  17493. (expand-file-name
  17494. org-latex-to-mathml-jar-file))))
  17495. (?I . ,(shell-quote-argument tmp-in-file))
  17496. (?i . ,latex-frag)
  17497. (?o . ,(shell-quote-argument tmp-out-file)))))
  17498. mathml shell-command-output)
  17499. (when (org-called-interactively-p 'any)
  17500. (unless (org-format-latex-mathml-available-p)
  17501. (user-error "LaTeX to MathML converter not configured")))
  17502. (message "Running %s" cmd)
  17503. (setq shell-command-output (shell-command-to-string cmd))
  17504. (setq mathml
  17505. (when (file-readable-p tmp-out-file)
  17506. (with-current-buffer (find-file-noselect tmp-out-file t)
  17507. (goto-char (point-min))
  17508. (when (re-search-forward
  17509. (concat
  17510. (regexp-quote
  17511. "<math xmlns=\"http://www.w3.org/1998/Math/MathML\"")
  17512. "[^>]*?>"
  17513. "\\(.\\|\n\\)*"
  17514. "</math>")
  17515. nil t)
  17516. (prog1 (match-string 0) (kill-buffer))))))
  17517. (cond
  17518. (mathml
  17519. (setq mathml
  17520. (concat "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" mathml))
  17521. (when mathml-file
  17522. (write-region mathml nil mathml-file))
  17523. (when (org-called-interactively-p 'any)
  17524. (message mathml)))
  17525. ((message "LaTeX to MathML conversion failed")
  17526. (message shell-command-output)))
  17527. (delete-file tmp-in-file)
  17528. (when (file-exists-p tmp-out-file)
  17529. (delete-file tmp-out-file))
  17530. mathml))
  17531. (defun org-format-latex-as-mathml (latex-frag latex-frag-type
  17532. prefix &optional dir)
  17533. "Use `org-create-math-formula' but check local cache first."
  17534. (let* ((absprefix (expand-file-name prefix dir))
  17535. (print-length nil) (print-level nil)
  17536. (formula-id (concat
  17537. "formula-"
  17538. (sha1
  17539. (prin1-to-string
  17540. (list latex-frag
  17541. org-latex-to-mathml-convert-command)))))
  17542. (formula-cache (format "%s-%s.mathml" absprefix formula-id))
  17543. (formula-cache-dir (file-name-directory formula-cache)))
  17544. (unless (file-directory-p formula-cache-dir)
  17545. (make-directory formula-cache-dir t))
  17546. (unless (file-exists-p formula-cache)
  17547. (org-create-math-formula latex-frag formula-cache))
  17548. (if (file-exists-p formula-cache)
  17549. ;; Successful conversion. Return the link to MathML file.
  17550. (org-add-props
  17551. (format "[[file:%s]]" (file-relative-name formula-cache dir))
  17552. (list 'org-latex-src (replace-regexp-in-string "\"" "" latex-frag)
  17553. 'org-latex-src-embed-type (if latex-frag-type
  17554. 'paragraph 'character)))
  17555. ;; Failed conversion. Return the LaTeX fragment verbatim
  17556. latex-frag)))
  17557. (defun org-create-formula-image (string tofile options buffer &optional type)
  17558. "Create an image from LaTeX source using dvipng or convert.
  17559. This function calls either `org-create-formula-image-with-dvipng'
  17560. or `org-create-formula-image-with-imagemagick' depending on the
  17561. value of `org-latex-create-formula-image-program' or on the value
  17562. of the optional TYPE variable.
  17563. Note: ultimately these two function should be combined as they
  17564. share a good deal of logic."
  17565. (org-check-external-command
  17566. "latex" "needed to convert LaTeX fragments to images")
  17567. (funcall
  17568. (case (or type org-latex-create-formula-image-program)
  17569. (dvipng
  17570. (org-check-external-command
  17571. "dvipng" "needed to convert LaTeX fragments to images")
  17572. #'org-create-formula-image-with-dvipng)
  17573. (imagemagick
  17574. (org-check-external-command
  17575. "convert" "you need to install imagemagick")
  17576. #'org-create-formula-image-with-imagemagick)
  17577. (t (error
  17578. "Invalid value of `org-latex-create-formula-image-program'")))
  17579. string tofile options buffer))
  17580. (declare-function org-export-get-backend "ox" (name))
  17581. (declare-function org-export--get-global-options "ox" (&optional backend))
  17582. (declare-function org-export--get-inbuffer-options "ox" (&optional backend))
  17583. (declare-function org-latex-guess-inputenc "ox-latex" (header))
  17584. (declare-function org-latex-guess-babel-language "ox-latex" (header info))
  17585. (defun org-create-formula--latex-header ()
  17586. "Return LaTeX header appropriate for previewing a LaTeX snippet."
  17587. (let ((info (org-combine-plists (org-export--get-global-options
  17588. (org-export-get-backend 'latex))
  17589. (org-export--get-inbuffer-options
  17590. (org-export-get-backend 'latex)))))
  17591. (org-latex-guess-babel-language
  17592. (org-latex-guess-inputenc
  17593. (org-splice-latex-header
  17594. org-format-latex-header
  17595. org-latex-default-packages-alist
  17596. org-latex-packages-alist t
  17597. (plist-get info :latex-header)))
  17598. info)))
  17599. (defun org--get-display-dpi ()
  17600. "Get the DPI of the display.
  17601. Assumes that the display has the same pixel width in the
  17602. horizontal and vertical directions."
  17603. (if (display-graphic-p)
  17604. (round (/ (display-pixel-height)
  17605. (/ (display-mm-height) 25.4)))
  17606. (error "Attempt to calculate the dpi of a non-graphic display")))
  17607. ;; This function borrows from Ganesh Swami's latex2png.el
  17608. (defun org-create-formula-image-with-dvipng (string tofile options buffer)
  17609. "This calls dvipng."
  17610. (require 'ox-latex)
  17611. (let* ((tmpdir (if (featurep 'xemacs)
  17612. (temp-directory)
  17613. temporary-file-directory))
  17614. (texfilebase (make-temp-name
  17615. (expand-file-name "orgtex" tmpdir)))
  17616. (texfile (concat texfilebase ".tex"))
  17617. (dvifile (concat texfilebase ".dvi"))
  17618. (pngfile (concat texfilebase ".png"))
  17619. (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
  17620. ;; This assumes that the display has the same pixel width in
  17621. ;; the horizontal and vertical directions
  17622. (dpi (number-to-string (* scale (if buffer (org--get-display-dpi) 120))))
  17623. (fg (or (plist-get options (if buffer :foreground :html-foreground))
  17624. "Black"))
  17625. (bg (or (plist-get options (if buffer :background :html-background))
  17626. "Transparent")))
  17627. (if (eq fg 'default) (setq fg (org-dvipng-color :foreground))
  17628. (unless (string= fg "Transparent") (setq fg (org-dvipng-color-format fg))))
  17629. (if (eq bg 'default) (setq bg (org-dvipng-color :background))
  17630. (unless (string= bg "Transparent") (setq bg (org-dvipng-color-format bg))))
  17631. (let ((latex-header (org-create-formula--latex-header)))
  17632. (with-temp-file texfile
  17633. (insert latex-header)
  17634. (insert "\n\\begin{document}\n" string "\n\\end{document}\n")))
  17635. (let ((dir default-directory))
  17636. (ignore-errors
  17637. (cd tmpdir)
  17638. (call-process "latex" nil nil nil texfile))
  17639. (cd dir))
  17640. (if (not (file-exists-p dvifile))
  17641. (progn (message "Failed to create dvi file from %s" texfile) nil)
  17642. (ignore-errors
  17643. (if (featurep 'xemacs)
  17644. (call-process "dvipng" nil nil nil
  17645. "-fg" fg "-bg" bg
  17646. "-T" "tight"
  17647. "-o" pngfile
  17648. dvifile)
  17649. (call-process "dvipng" nil nil nil
  17650. "-fg" fg "-bg" bg
  17651. "-D" dpi
  17652. ;;"-x" scale "-y" scale
  17653. "-T" "tight"
  17654. "-o" pngfile
  17655. dvifile)))
  17656. (if (not (file-exists-p pngfile))
  17657. (if org-format-latex-signal-error
  17658. (error "Failed to create png file from %s" texfile)
  17659. (message "Failed to create png file from %s" texfile)
  17660. nil)
  17661. ;; Use the requested file name and clean up
  17662. (copy-file pngfile tofile 'replace)
  17663. (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
  17664. (if (file-exists-p (concat texfilebase e))
  17665. (delete-file (concat texfilebase e))))
  17666. pngfile))))
  17667. (declare-function org-latex-compile "ox-latex" (texfile &optional snippet))
  17668. (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
  17669. "This calls convert, which is included into imagemagick."
  17670. (require 'ox-latex)
  17671. (let* ((tmpdir (if (featurep 'xemacs)
  17672. (temp-directory)
  17673. temporary-file-directory))
  17674. (texfilebase (make-temp-name
  17675. (expand-file-name "orgtex" tmpdir)))
  17676. (texfile (concat texfilebase ".tex"))
  17677. (pdffile (concat texfilebase ".pdf"))
  17678. (pngfile (concat texfilebase ".png"))
  17679. (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
  17680. (dpi (number-to-string (* scale (if buffer (org--get-display-dpi) 120))))
  17681. (fg (or (plist-get options (if buffer :foreground :html-foreground))
  17682. "black"))
  17683. (bg (or (plist-get options (if buffer :background :html-background))
  17684. "white")))
  17685. (if (eq fg 'default) (setq fg (org-latex-color :foreground))
  17686. (setq fg (org-latex-color-format fg)))
  17687. (if (eq bg 'default) (setq bg (org-latex-color :background))
  17688. (setq bg (org-latex-color-format
  17689. (if (string= bg "Transparent") "white" bg))))
  17690. (let ((latex-header (org-create-formula--latex-header)))
  17691. (with-temp-file texfile
  17692. (insert latex-header)
  17693. (insert "\n\\begin{document}\n"
  17694. "\\definecolor{fg}{rgb}{" fg "}\n"
  17695. "\\definecolor{bg}{rgb}{" bg "}\n"
  17696. "\n\\pagecolor{bg}\n"
  17697. "\n{\\color{fg}\n"
  17698. string
  17699. "\n}\n"
  17700. "\n\\end{document}\n")))
  17701. (org-latex-compile texfile t)
  17702. (if (not (file-exists-p pdffile))
  17703. (progn (message "Failed to create pdf file from %s" texfile) nil)
  17704. (ignore-errors
  17705. (if (featurep 'xemacs)
  17706. (call-process "convert" nil nil nil
  17707. "-density" "96"
  17708. "-trim"
  17709. "-antialias"
  17710. pdffile
  17711. "-quality" "100"
  17712. ;; "-sharpen" "0x1.0"
  17713. pngfile)
  17714. (call-process "convert" nil nil nil
  17715. "-density" dpi
  17716. "-trim"
  17717. "-antialias"
  17718. pdffile
  17719. "-quality" "100"
  17720. ;; "-sharpen" "0x1.0"
  17721. pngfile)))
  17722. (if (not (file-exists-p pngfile))
  17723. (if org-format-latex-signal-error
  17724. (error "Failed to create png file from %s" texfile)
  17725. (message "Failed to create png file from %s" texfile)
  17726. nil)
  17727. ;; Use the requested file name and clean up
  17728. (copy-file pngfile tofile 'replace)
  17729. (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
  17730. (if (file-exists-p (concat texfilebase e))
  17731. (delete-file (concat texfilebase e))))
  17732. pngfile))))
  17733. (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
  17734. "Fill a LaTeX header template TPL.
  17735. In the template, the following place holders will be recognized:
  17736. [DEFAULT-PACKAGES] \\usepackage statements for DEF-PKG
  17737. [NO-DEFAULT-PACKAGES] do not include DEF-PKG
  17738. [PACKAGES] \\usepackage statements for PKG
  17739. [NO-PACKAGES] do not include PKG
  17740. [EXTRA] the string EXTRA
  17741. [NO-EXTRA] do not include EXTRA
  17742. For backward compatibility, if both the positive and the negative place
  17743. holder is missing, the positive one (without the \"NO-\") will be
  17744. assumed to be present at the end of the template.
  17745. DEF-PKG and PKG are assumed to be alists of options/packagename lists.
  17746. EXTRA is a string.
  17747. SNIPPETS-P indicates if this is run to create snippet images for HTML."
  17748. (let (rpl (end ""))
  17749. (if (string-match "^[ \t]*\\[\\(NO-\\)?DEFAULT-PACKAGES\\][ \t]*\n?" tpl)
  17750. (setq rpl (if (or (match-end 1) (not def-pkg))
  17751. "" (org-latex-packages-to-string def-pkg snippets-p t))
  17752. tpl (replace-match rpl t t tpl))
  17753. (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
  17754. (if (string-match "\\[\\(NO-\\)?PACKAGES\\][ \t]*\n?" tpl)
  17755. (setq rpl (if (or (match-end 1) (not pkg))
  17756. "" (org-latex-packages-to-string pkg snippets-p t))
  17757. tpl (replace-match rpl t t tpl))
  17758. (if pkg (setq end
  17759. (concat end "\n"
  17760. (org-latex-packages-to-string pkg snippets-p)))))
  17761. (if (string-match "\\[\\(NO-\\)?EXTRA\\][ \t]*\n?" tpl)
  17762. (setq rpl (if (or (match-end 1) (not extra))
  17763. "" (concat extra "\n"))
  17764. tpl (replace-match rpl t t tpl))
  17765. (if (and extra (string-match "\\S-" extra))
  17766. (setq end (concat end "\n" extra))))
  17767. (if (string-match "\\S-" end)
  17768. (concat tpl "\n" end)
  17769. tpl)))
  17770. (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
  17771. "Turn an alist of packages into a string with the \\usepackage macros."
  17772. (setq pkg (mapconcat (lambda(p)
  17773. (cond
  17774. ((stringp p) p)
  17775. ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
  17776. (format "%% Package %s omitted" (cadr p)))
  17777. ((equal "" (car p))
  17778. (format "\\usepackage{%s}" (cadr p)))
  17779. (t
  17780. (format "\\usepackage[%s]{%s}"
  17781. (car p) (cadr p)))))
  17782. pkg
  17783. "\n"))
  17784. (if newline (concat pkg "\n") pkg))
  17785. (defun org-dvipng-color (attr)
  17786. "Return a RGB color specification for dvipng."
  17787. (apply 'format "rgb %s %s %s"
  17788. (mapcar 'org-normalize-color
  17789. (if (featurep 'xemacs)
  17790. (color-rgb-components
  17791. (face-property 'default
  17792. (cond ((eq attr :foreground) 'foreground)
  17793. ((eq attr :background) 'background))))
  17794. (color-values (face-attribute 'default attr nil))))))
  17795. (defun org-dvipng-color-format (color-name)
  17796. "Convert COLOR-NAME to a RGB color value for dvipng."
  17797. (apply 'format "rgb %s %s %s"
  17798. (mapcar 'org-normalize-color
  17799. (color-values color-name))))
  17800. (defun org-latex-color (attr)
  17801. "Return a RGB color for the LaTeX color package."
  17802. (apply 'format "%s,%s,%s"
  17803. (mapcar 'org-normalize-color
  17804. (if (featurep 'xemacs)
  17805. (color-rgb-components
  17806. (face-property 'default
  17807. (cond ((eq attr :foreground) 'foreground)
  17808. ((eq attr :background) 'background))))
  17809. (color-values (face-attribute 'default attr nil))))))
  17810. (defun org-latex-color-format (color-name)
  17811. "Convert COLOR-NAME to a RGB color value."
  17812. (apply 'format "%s,%s,%s"
  17813. (mapcar 'org-normalize-color
  17814. (color-values color-name))))
  17815. (defun org-normalize-color (value)
  17816. "Return string to be used as color value for an RGB component."
  17817. (format "%g" (/ value 65535.0)))
  17818. ;; Image display
  17819. (defvar org-inline-image-overlays nil)
  17820. (make-variable-buffer-local 'org-inline-image-overlays)
  17821. (defun org-toggle-inline-images (&optional include-linked)
  17822. "Toggle the display of inline images.
  17823. INCLUDE-LINKED is passed to `org-display-inline-images'."
  17824. (interactive "P")
  17825. (if org-inline-image-overlays
  17826. (progn
  17827. (org-remove-inline-images)
  17828. (when (org-called-interactively-p 'interactive)
  17829. (message "Inline image display turned off")))
  17830. (org-display-inline-images include-linked)
  17831. (when (org-called-interactively-p 'interactive)
  17832. (message (if org-inline-image-overlays
  17833. (format "%d images displayed inline"
  17834. (length org-inline-image-overlays))
  17835. "No images to display inline")))))
  17836. (defun org-redisplay-inline-images ()
  17837. "Refresh the display of inline images."
  17838. (interactive)
  17839. (if (not org-inline-image-overlays)
  17840. (org-toggle-inline-images)
  17841. (org-toggle-inline-images)
  17842. (org-toggle-inline-images)))
  17843. (defun org-display-inline-images (&optional include-linked refresh beg end)
  17844. "Display inline images.
  17845. An inline image is a link which follows either of these
  17846. conventions:
  17847. 1. Its path is a file with an extension matching return value
  17848. from `image-file-name-regexp' and it has no contents.
  17849. 2. Its description consists in a single link of the previous
  17850. type.
  17851. When optional argument INCLUDE-LINKED is non-nil, also links with
  17852. a text description part will be inlined. This can be nice for
  17853. a quick look at those images, but it does not reflect what
  17854. exported files will look like.
  17855. When optional argument REFRESH is non-nil, refresh existing
  17856. images between BEG and END. This will create new image displays
  17857. only if necessary. BEG and END default to the buffer
  17858. boundaries."
  17859. (interactive "P")
  17860. (when (display-graphic-p)
  17861. (unless refresh
  17862. (org-remove-inline-images)
  17863. (when (fboundp 'clear-image-cache) (clear-image-cache)))
  17864. (org-with-wide-buffer
  17865. (goto-char (or beg (point-min)))
  17866. (let ((case-fold-search t)
  17867. (file-extension-re (org-image-file-name-regexp)))
  17868. (while (re-search-forward "[][]\\[\\(?:file\\|[./~]\\)" end t)
  17869. (let ((link (save-match-data (org-element-context))))
  17870. ;; Check if we're at an inline image.
  17871. (when (and (equal (org-element-property :type link) "file")
  17872. (or include-linked
  17873. (not (org-element-property :contents-begin link)))
  17874. (let ((parent (org-element-property :parent link)))
  17875. (or (not (eq (org-element-type parent) 'link))
  17876. (not (cdr (org-element-contents parent)))))
  17877. (org-string-match-p file-extension-re
  17878. (org-element-property :path link)))
  17879. (let ((file (expand-file-name
  17880. (org-link-unescape
  17881. (org-element-property :path link)))))
  17882. (when (file-exists-p file)
  17883. (let ((width
  17884. ;; Apply `org-image-actual-width' specifications.
  17885. (cond
  17886. ((not (image-type-available-p 'imagemagick)) nil)
  17887. ((eq org-image-actual-width t) nil)
  17888. ((listp org-image-actual-width)
  17889. (or
  17890. ;; First try to find a width among
  17891. ;; attributes associated to the paragraph
  17892. ;; containing link.
  17893. (let ((paragraph
  17894. (let ((e link))
  17895. (while (and (setq e (org-element-property
  17896. :parent e))
  17897. (not (eq (org-element-type e)
  17898. 'paragraph))))
  17899. e)))
  17900. (when paragraph
  17901. (save-excursion
  17902. (goto-char (org-element-property :begin paragraph))
  17903. (when
  17904. (re-search-forward
  17905. "^[ \t]*#\\+attr_.*?: +.*?:width +\\(\\S-+\\)"
  17906. (org-element-property
  17907. :post-affiliated paragraph)
  17908. t)
  17909. (string-to-number (match-string 1))))))
  17910. ;; Otherwise, fall-back to provided number.
  17911. (car org-image-actual-width)))
  17912. ((numberp org-image-actual-width)
  17913. org-image-actual-width)))
  17914. (old (get-char-property-and-overlay
  17915. (org-element-property :begin link)
  17916. 'org-image-overlay)))
  17917. (if (and (car-safe old) refresh)
  17918. (image-refresh (overlay-get (cdr old) 'display))
  17919. (let ((image (create-image file
  17920. (and width 'imagemagick)
  17921. nil
  17922. :width width)))
  17923. (when image
  17924. (let* ((link
  17925. ;; If inline image is the description
  17926. ;; of another link, be sure to
  17927. ;; consider the latter as the one to
  17928. ;; apply the overlay on.
  17929. (let ((parent
  17930. (org-element-property :parent link)))
  17931. (if (eq (org-element-type parent) 'link)
  17932. parent
  17933. link)))
  17934. (ov (make-overlay
  17935. (org-element-property :begin link)
  17936. (progn
  17937. (goto-char
  17938. (org-element-property :end link))
  17939. (skip-chars-backward " \t")
  17940. (point)))))
  17941. (overlay-put ov 'display image)
  17942. (overlay-put ov 'face 'default)
  17943. (overlay-put ov 'org-image-overlay t)
  17944. (overlay-put
  17945. ov 'modification-hooks
  17946. (list 'org-display-inline-remove-overlay))
  17947. (push ov org-inline-image-overlays)))))))))))))))
  17948. (define-obsolete-function-alias
  17949. 'org-display-inline-modification-hook 'org-display-inline-remove-overlay "24.3")
  17950. (defun org-display-inline-remove-overlay (ov after beg end &optional len)
  17951. "Remove inline-display overlay if a corresponding region is modified."
  17952. (let ((inhibit-modification-hooks t))
  17953. (when (and ov after)
  17954. (delete ov org-inline-image-overlays)
  17955. (delete-overlay ov))))
  17956. (defun org-remove-inline-images ()
  17957. "Remove inline display of images."
  17958. (interactive)
  17959. (mapc 'delete-overlay org-inline-image-overlays)
  17960. (setq org-inline-image-overlays nil))
  17961. ;;;; Key bindings
  17962. ;; Outline functions from `outline-mode-prefix-map'
  17963. ;; that can be remapped in Org:
  17964. (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
  17965. (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
  17966. (define-key org-mode-map [remap outline-forward-same-level]
  17967. 'org-forward-heading-same-level)
  17968. (define-key org-mode-map [remap outline-backward-same-level]
  17969. 'org-backward-heading-same-level)
  17970. (define-key org-mode-map [remap show-branches]
  17971. 'org-kill-note-or-show-branches)
  17972. (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
  17973. (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
  17974. (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
  17975. (define-key org-mode-map [remap outline-next-visible-heading]
  17976. 'org-next-visible-heading)
  17977. (define-key org-mode-map [remap outline-previous-visible-heading]
  17978. 'org-previous-visible-heading)
  17979. ;; Outline functions from `outline-mode-prefix-map' that can not
  17980. ;; be remapped in Org:
  17981. ;; - the column "key binding" shows whether the Outline function is still
  17982. ;; available in Org mode on the same key that it has been bound to in
  17983. ;; Outline mode:
  17984. ;; - "overridden": key used for a different functionality in Org mode
  17985. ;; - else: key still bound to the same Outline function in Org mode
  17986. ;; | Outline function | key binding | Org replacement |
  17987. ;; |------------------------------------+-------------+--------------------------|
  17988. ;; | `outline-next-visible-heading' | `C-c C-n' | better: skip inlinetasks |
  17989. ;; | `outline-previous-visible-heading' | `C-c C-p' | better: skip inlinetasks |
  17990. ;; | `outline-up-heading' | `C-c C-u' | still same function |
  17991. ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
  17992. ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
  17993. ;; | `show-entry' | overridden | no replacement |
  17994. ;; | `show-children' | `C-c C-i' | visibility cycling |
  17995. ;; | `show-branches' | `C-c C-k' | still same function |
  17996. ;; | `show-subtree' | overridden | visibility cycling |
  17997. ;; | `show-all' | overridden | no replacement |
  17998. ;; | `hide-subtree' | overridden | visibility cycling |
  17999. ;; | `hide-body' | overridden | no replacement |
  18000. ;; | `hide-entry' | overridden | visibility cycling |
  18001. ;; | `hide-leaves' | overridden | no replacement |
  18002. ;; | `hide-sublevels' | overridden | no replacement |
  18003. ;; | `hide-other' | overridden | no replacement |
  18004. ;; Make `C-c C-x' a prefix key
  18005. (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
  18006. ;; TAB key with modifiers
  18007. (org-defkey org-mode-map "\C-i" 'org-cycle)
  18008. (org-defkey org-mode-map [(tab)] 'org-cycle)
  18009. (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
  18010. (org-defkey org-mode-map "\M-\t" 'pcomplete)
  18011. ;; The following line is necessary under Suse GNU/Linux
  18012. (unless (featurep 'xemacs)
  18013. (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
  18014. (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
  18015. (define-key org-mode-map [backtab] 'org-shifttab)
  18016. (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
  18017. (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
  18018. (org-defkey org-mode-map [(meta return)] 'org-meta-return)
  18019. ;; Cursor keys with modifiers
  18020. (org-defkey org-mode-map [(meta left)] 'org-metaleft)
  18021. (org-defkey org-mode-map [(meta right)] 'org-metaright)
  18022. (org-defkey org-mode-map [(meta up)] 'org-metaup)
  18023. (org-defkey org-mode-map [(meta down)] 'org-metadown)
  18024. (org-defkey org-mode-map [(control meta shift right)] 'org-increase-number-at-point)
  18025. (org-defkey org-mode-map [(control meta shift left)] 'org-decrease-number-at-point)
  18026. (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
  18027. (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
  18028. (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
  18029. (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
  18030. (org-defkey org-mode-map [(shift up)] 'org-shiftup)
  18031. (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
  18032. (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
  18033. (org-defkey org-mode-map [(shift right)] 'org-shiftright)
  18034. (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
  18035. (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
  18036. (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
  18037. (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
  18038. ;; Babel keys
  18039. (define-key org-mode-map org-babel-key-prefix org-babel-map)
  18040. (mapc (lambda (pair)
  18041. (define-key org-babel-map (car pair) (cdr pair)))
  18042. org-babel-key-bindings)
  18043. ;;; Extra keys for tty access.
  18044. ;; We only set them when really needed because otherwise the
  18045. ;; menus don't show the simple keys
  18046. (when (or org-use-extra-keys
  18047. (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
  18048. (not window-system))
  18049. (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
  18050. (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
  18051. (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
  18052. (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
  18053. (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
  18054. (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
  18055. (org-defkey org-mode-map [?\e (right)] 'org-metaright)
  18056. (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
  18057. (org-defkey org-mode-map [?\e (up)] 'org-metaup)
  18058. (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
  18059. (org-defkey org-mode-map [?\e (down)] 'org-metadown)
  18060. (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
  18061. (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
  18062. (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
  18063. (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
  18064. (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
  18065. (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
  18066. (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
  18067. (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
  18068. (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
  18069. (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
  18070. (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
  18071. (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
  18072. (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
  18073. (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
  18074. (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
  18075. (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
  18076. (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
  18077. ;; All the other keys
  18078. (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
  18079. (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
  18080. (if (boundp 'narrow-map)
  18081. (org-defkey narrow-map "s" 'org-narrow-to-subtree)
  18082. (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
  18083. (if (boundp 'narrow-map)
  18084. (org-defkey narrow-map "b" 'org-narrow-to-block)
  18085. (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
  18086. (if (boundp 'narrow-map)
  18087. (org-defkey narrow-map "e" 'org-narrow-to-element)
  18088. (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
  18089. (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
  18090. (org-defkey org-mode-map "\M-}" 'org-forward-element)
  18091. (org-defkey org-mode-map "\M-{" 'org-backward-element)
  18092. (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
  18093. (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
  18094. (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
  18095. (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
  18096. (org-defkey org-mode-map "\C-c\M-f" 'org-next-block)
  18097. (org-defkey org-mode-map "\C-c\M-b" 'org-previous-block)
  18098. (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
  18099. (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
  18100. (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
  18101. (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
  18102. (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
  18103. (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
  18104. (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
  18105. (org-defkey org-mode-map "\C-c\C-xq" 'org-toggle-tags-groups)
  18106. (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
  18107. (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
  18108. (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
  18109. (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
  18110. (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
  18111. (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
  18112. (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
  18113. (org-defkey org-mode-map "\C-c\M-w" 'org-copy)
  18114. (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
  18115. (org-defkey org-mode-map "\C-c\\" 'org-match-sparse-tree) ; Minor-mode res.
  18116. (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
  18117. (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
  18118. (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
  18119. (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
  18120. (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
  18121. (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
  18122. (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
  18123. (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
  18124. (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
  18125. (org-defkey org-mode-map "\C-c\M-l" 'org-insert-last-stored-link)
  18126. (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
  18127. (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
  18128. (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
  18129. (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
  18130. (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
  18131. (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
  18132. (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
  18133. (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
  18134. (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
  18135. (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
  18136. (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
  18137. (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
  18138. (org-defkey org-mode-map [(control ?\')] 'org-cycle-agenda-files)
  18139. (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
  18140. (org-defkey org-mode-map "\C-c]" 'org-remove-file)
  18141. (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
  18142. (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
  18143. (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
  18144. (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
  18145. (org-defkey org-mode-map "\C-c^" 'org-sort)
  18146. (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
  18147. (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
  18148. (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
  18149. (org-defkey org-mode-map [remap open-line] 'org-open-line)
  18150. (org-defkey org-mode-map [remap comment-dwim] 'org-comment-dwim)
  18151. (org-defkey org-mode-map [remap forward-paragraph] 'org-forward-paragraph)
  18152. (org-defkey org-mode-map [remap backward-paragraph] 'org-backward-paragraph)
  18153. (org-defkey org-mode-map "\M-^" 'org-delete-indentation)
  18154. (org-defkey org-mode-map "\C-m" 'org-return)
  18155. (org-defkey org-mode-map "\C-j" 'org-return-indent)
  18156. (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
  18157. (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
  18158. (org-defkey org-mode-map "\C-c+" 'org-table-sum)
  18159. (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
  18160. (org-defkey org-mode-map "\C-c'" 'org-edit-special)
  18161. (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
  18162. (org-defkey org-mode-map "\C-c\"a" 'orgtbl-ascii-plot)
  18163. (org-defkey org-mode-map "\C-c\"g" 'org-plot/gnuplot)
  18164. (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
  18165. (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
  18166. (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
  18167. (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
  18168. (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
  18169. (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
  18170. (org-defkey org-mode-map "\C-c\C-e" 'org-export-dispatch)
  18171. (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width)
  18172. (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
  18173. (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
  18174. (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
  18175. (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
  18176. (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
  18177. (org-defkey org-mode-map "\M-h" 'org-mark-element)
  18178. (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
  18179. ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
  18180. (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
  18181. (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
  18182. (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
  18183. (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
  18184. (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
  18185. (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
  18186. (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
  18187. (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
  18188. (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
  18189. (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
  18190. (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
  18191. (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
  18192. (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
  18193. (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-toggle-latex-fragment)
  18194. (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
  18195. (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
  18196. (org-defkey org-mode-map "\C-c\C-x\\" 'org-toggle-pretty-entities)
  18197. (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
  18198. (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
  18199. (org-defkey org-mode-map "\C-c\C-xP" 'org-set-property-and-value)
  18200. (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
  18201. (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
  18202. (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
  18203. (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
  18204. (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
  18205. (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
  18206. (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
  18207. (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
  18208. (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
  18209. (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
  18210. (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
  18211. (define-key org-mode-map "\C-c\C-x!" 'org-reload)
  18212. (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
  18213. (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
  18214. (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
  18215. (when (featurep 'xemacs)
  18216. (org-defkey org-mode-map 'button3 'popup-mode-menu))
  18217. (defconst org-speed-commands-default
  18218. '(
  18219. ("Outline Navigation")
  18220. ("n" . (org-speed-move-safe 'org-next-visible-heading))
  18221. ("p" . (org-speed-move-safe 'org-previous-visible-heading))
  18222. ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
  18223. ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
  18224. ("F" . org-next-block)
  18225. ("B" . org-previous-block)
  18226. ("u" . (org-speed-move-safe 'outline-up-heading))
  18227. ("j" . org-goto)
  18228. ("g" . (org-refile t))
  18229. ("Outline Visibility")
  18230. ("c" . org-cycle)
  18231. ("C" . org-shifttab)
  18232. (" " . org-display-outline-path)
  18233. ("s" . org-narrow-to-subtree)
  18234. ("=" . org-columns)
  18235. ("Outline Structure Editing")
  18236. ("U" . org-metaup)
  18237. ("D" . org-metadown)
  18238. ("r" . org-metaright)
  18239. ("l" . org-metaleft)
  18240. ("R" . org-shiftmetaright)
  18241. ("L" . org-shiftmetaleft)
  18242. ("i" . (progn (forward-char 1) (call-interactively
  18243. 'org-insert-heading-respect-content)))
  18244. ("^" . org-sort)
  18245. ("w" . org-refile)
  18246. ("a" . org-archive-subtree-default-with-confirmation)
  18247. ("@" . org-mark-subtree)
  18248. ("#" . org-toggle-comment)
  18249. ("Clock Commands")
  18250. ("I" . org-clock-in)
  18251. ("O" . org-clock-out)
  18252. ("Meta Data Editing")
  18253. ("t" . org-todo)
  18254. ("," . (org-priority))
  18255. ("0" . (org-priority ?\ ))
  18256. ("1" . (org-priority ?A))
  18257. ("2" . (org-priority ?B))
  18258. ("3" . (org-priority ?C))
  18259. (":" . org-set-tags-command)
  18260. ("e" . org-set-effort)
  18261. ("E" . org-inc-effort)
  18262. ("W" . (lambda(m) (interactive "sMinutes before warning: ")
  18263. (org-entry-put (point) "APPT_WARNTIME" m)))
  18264. ("Agenda Views etc")
  18265. ("v" . org-agenda)
  18266. ("/" . org-sparse-tree)
  18267. ("Misc")
  18268. ("o" . org-open-at-point)
  18269. ("?" . org-speed-command-help)
  18270. ("<" . (org-agenda-set-restriction-lock 'subtree))
  18271. (">" . (org-agenda-remove-restriction-lock))
  18272. )
  18273. "The default speed commands.")
  18274. (defun org-print-speed-command (e)
  18275. (if (> (length (car e)) 1)
  18276. (progn
  18277. (princ "\n")
  18278. (princ (car e))
  18279. (princ "\n")
  18280. (princ (make-string (length (car e)) ?-))
  18281. (princ "\n"))
  18282. (princ (car e))
  18283. (princ " ")
  18284. (if (symbolp (cdr e))
  18285. (princ (symbol-name (cdr e)))
  18286. (prin1 (cdr e)))
  18287. (princ "\n")))
  18288. (defun org-speed-command-help ()
  18289. "Show the available speed commands."
  18290. (interactive)
  18291. (if (not org-use-speed-commands)
  18292. (user-error "Speed commands are not activated, customize `org-use-speed-commands'")
  18293. (with-output-to-temp-buffer "*Help*"
  18294. (princ "User-defined Speed commands\n===========================\n")
  18295. (mapc 'org-print-speed-command org-speed-commands-user)
  18296. (princ "\n")
  18297. (princ "Built-in Speed commands\n=======================\n")
  18298. (mapc 'org-print-speed-command org-speed-commands-default))
  18299. (with-current-buffer "*Help*"
  18300. (setq truncate-lines t))))
  18301. (defun org-speed-move-safe (cmd)
  18302. "Execute CMD, but make sure that the cursor always ends up in a headline.
  18303. If not, return to the original position and throw an error."
  18304. (interactive)
  18305. (let ((pos (point)))
  18306. (call-interactively cmd)
  18307. (unless (and (bolp) (org-at-heading-p))
  18308. (goto-char pos)
  18309. (error "Boundary reached while executing %s" cmd))))
  18310. (defvar org-self-insert-command-undo-counter 0)
  18311. (defvar org-table-auto-blank-field) ; defined in org-table.el
  18312. (defvar org-speed-command nil)
  18313. (define-obsolete-function-alias
  18314. 'org-speed-command-default-hook 'org-speed-command-activate "24.3")
  18315. (defun org-speed-command-activate (keys)
  18316. "Hook for activating single-letter speed commands.
  18317. `org-speed-commands-default' specifies a minimal command set.
  18318. Use `org-speed-commands-user' for further customization."
  18319. (when (or (and (bolp) (looking-at org-outline-regexp))
  18320. (and (functionp org-use-speed-commands)
  18321. (funcall org-use-speed-commands)))
  18322. (cdr (assoc keys (append org-speed-commands-user
  18323. org-speed-commands-default)))))
  18324. (define-obsolete-function-alias
  18325. 'org-babel-speed-command-hook 'org-babel-speed-command-activate "24.3")
  18326. (defun org-babel-speed-command-activate (keys)
  18327. "Hook for activating single-letter code block commands."
  18328. (when (and (bolp) (looking-at org-babel-src-block-regexp))
  18329. (cdr (assoc keys org-babel-key-bindings))))
  18330. (defcustom org-speed-command-hook
  18331. '(org-speed-command-default-hook org-babel-speed-command-hook)
  18332. "Hook for activating speed commands at strategic locations.
  18333. Hook functions are called in sequence until a valid handler is
  18334. found.
  18335. Each hook takes a single argument, a user-pressed command key
  18336. which is also a `self-insert-command' from the global map.
  18337. Within the hook, examine the cursor position and the command key
  18338. and return nil or a valid handler as appropriate. Handler could
  18339. be one of an interactive command, a function, or a form.
  18340. Set `org-use-speed-commands' to non-nil value to enable this
  18341. hook. The default setting is `org-speed-command-activate'."
  18342. :group 'org-structure
  18343. :version "24.1"
  18344. :type 'hook)
  18345. (defun org-self-insert-command (N)
  18346. "Like `self-insert-command', use overwrite-mode for whitespace in tables.
  18347. If the cursor is in a table looking at whitespace, the whitespace is
  18348. overwritten, and the table is not marked as requiring realignment."
  18349. (interactive "p")
  18350. (org-check-before-invisible-edit 'insert)
  18351. (cond
  18352. ((and org-use-speed-commands
  18353. (let ((kv (this-command-keys-vector)))
  18354. (setq org-speed-command
  18355. (run-hook-with-args-until-success
  18356. 'org-speed-command-hook
  18357. (make-string 1 (aref kv (1- (length kv))))))))
  18358. (cond
  18359. ((commandp org-speed-command)
  18360. (setq this-command org-speed-command)
  18361. (call-interactively org-speed-command))
  18362. ((functionp org-speed-command)
  18363. (funcall org-speed-command))
  18364. ((and org-speed-command (listp org-speed-command))
  18365. (eval org-speed-command))
  18366. (t (let (org-use-speed-commands)
  18367. (call-interactively 'org-self-insert-command)))))
  18368. ((and
  18369. (org-table-p)
  18370. (progn
  18371. ;; check if we blank the field, and if that triggers align
  18372. (and (featurep 'org-table) org-table-auto-blank-field
  18373. (memq last-command
  18374. '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c))
  18375. (if (or (equal (char-after) ?\ ) (looking-at "[^|\n]* |"))
  18376. ;; got extra space, this field does not determine column width
  18377. (let (org-table-may-need-update) (org-table-blank-field))
  18378. ;; no extra space, this field may determine column width
  18379. (org-table-blank-field)))
  18380. t)
  18381. (eq N 1)
  18382. (looking-at "[^|\n]* |"))
  18383. (let (org-table-may-need-update)
  18384. (goto-char (1- (match-end 0)))
  18385. (backward-delete-char 1)
  18386. (goto-char (match-beginning 0))
  18387. (self-insert-command N)))
  18388. (t
  18389. (setq org-table-may-need-update t)
  18390. (self-insert-command N)
  18391. (org-fix-tags-on-the-fly)
  18392. (if org-self-insert-cluster-for-undo
  18393. (if (not (eq last-command 'org-self-insert-command))
  18394. (setq org-self-insert-command-undo-counter 1)
  18395. (if (>= org-self-insert-command-undo-counter 20)
  18396. (setq org-self-insert-command-undo-counter 1)
  18397. (and (> org-self-insert-command-undo-counter 0)
  18398. buffer-undo-list (listp buffer-undo-list)
  18399. (not (cadr buffer-undo-list)) ; remove nil entry
  18400. (setcdr buffer-undo-list (cddr buffer-undo-list)))
  18401. (setq org-self-insert-command-undo-counter
  18402. (1+ org-self-insert-command-undo-counter))))))))
  18403. (defun org-check-before-invisible-edit (kind)
  18404. "Check is editing if kind KIND would be dangerous with invisible text around.
  18405. The detailed reaction depends on the user option `org-catch-invisible-edits'."
  18406. ;; First, try to get out of here as quickly as possible, to reduce overhead
  18407. (if (and org-catch-invisible-edits
  18408. (or (not (boundp 'visible-mode)) (not visible-mode))
  18409. (or (get-char-property (point) 'invisible)
  18410. (get-char-property (max (point-min) (1- (point))) 'invisible)))
  18411. ;; OK, we need to take a closer look
  18412. (let* ((invisible-at-point (get-char-property (point) 'invisible))
  18413. (invisible-before-point (if (bobp) nil (get-char-property
  18414. (1- (point)) 'invisible)))
  18415. (border-and-ok-direction
  18416. (or
  18417. ;; Check if we are acting predictably before invisible text
  18418. (and invisible-at-point (not invisible-before-point)
  18419. (memq kind '(insert delete-backward)))
  18420. ;; Check if we are acting predictably after invisible text
  18421. ;; This works not well, and I have turned it off. It seems
  18422. ;; better to always show and stop after invisible text.
  18423. ;; (and (not invisible-at-point) invisible-before-point
  18424. ;; (memq kind '(insert delete)))
  18425. )))
  18426. (when (or (memq invisible-at-point '(outline org-hide-block t))
  18427. (memq invisible-before-point '(outline org-hide-block t)))
  18428. (if (eq org-catch-invisible-edits 'error)
  18429. (user-error "Editing in invisible areas is prohibited, make them visible first"))
  18430. (if (and org-custom-properties-overlays
  18431. (y-or-n-p "Display invisible properties in this buffer? "))
  18432. (org-toggle-custom-properties-visibility)
  18433. ;; Make the area visible
  18434. (save-excursion
  18435. (if invisible-before-point
  18436. (goto-char (previous-single-char-property-change
  18437. (point) 'invisible)))
  18438. (show-subtree))
  18439. (cond
  18440. ((eq org-catch-invisible-edits 'show)
  18441. ;; That's it, we do the edit after showing
  18442. (message
  18443. "Unfolding invisible region around point before editing")
  18444. (sit-for 1))
  18445. ((and (eq org-catch-invisible-edits 'smart)
  18446. border-and-ok-direction)
  18447. (message "Unfolding invisible region around point before editing"))
  18448. (t
  18449. ;; Don't do the edit, make the user repeat it in full visibility
  18450. (user-error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
  18451. (defun org-fix-tags-on-the-fly ()
  18452. (when (and (equal (char-after (point-at-bol)) ?*)
  18453. (org-at-heading-p))
  18454. (org-align-tags-here org-tags-column)))
  18455. (defun org-delete-backward-char (N)
  18456. "Like `delete-backward-char', insert whitespace at field end in tables.
  18457. When deleting backwards, in tables this function will insert whitespace in
  18458. front of the next \"|\" separator, to keep the table aligned. The table will
  18459. still be marked for re-alignment if the field did fill the entire column,
  18460. because, in this case the deletion might narrow the column."
  18461. (interactive "p")
  18462. (save-match-data
  18463. (org-check-before-invisible-edit 'delete-backward)
  18464. (if (and (org-table-p)
  18465. (eq N 1)
  18466. (string-match "|" (buffer-substring (point-at-bol) (point)))
  18467. (looking-at ".*?|"))
  18468. (let ((pos (point))
  18469. (noalign (looking-at "[^|\n\r]* |"))
  18470. (c org-table-may-need-update))
  18471. (backward-delete-char N)
  18472. (if (not overwrite-mode)
  18473. (progn
  18474. (skip-chars-forward "^|")
  18475. (insert " ")
  18476. (goto-char (1- pos))))
  18477. ;; noalign: if there were two spaces at the end, this field
  18478. ;; does not determine the width of the column.
  18479. (if noalign (setq org-table-may-need-update c)))
  18480. (backward-delete-char N)
  18481. (org-fix-tags-on-the-fly))))
  18482. (defun org-delete-char (N)
  18483. "Like `delete-char', but insert whitespace at field end in tables.
  18484. When deleting characters, in tables this function will insert whitespace in
  18485. front of the next \"|\" separator, to keep the table aligned. The table will
  18486. still be marked for re-alignment if the field did fill the entire column,
  18487. because, in this case the deletion might narrow the column."
  18488. (interactive "p")
  18489. (save-match-data
  18490. (org-check-before-invisible-edit 'delete)
  18491. (if (and (org-table-p)
  18492. (not (bolp))
  18493. (not (= (char-after) ?|))
  18494. (eq N 1))
  18495. (if (looking-at ".*?|")
  18496. (let ((pos (point))
  18497. (noalign (looking-at "[^|\n\r]* |"))
  18498. (c org-table-may-need-update))
  18499. (replace-match
  18500. (concat (substring (match-string 0) 1 -1) " |") nil t)
  18501. (goto-char pos)
  18502. ;; noalign: if there were two spaces at the end, this field
  18503. ;; does not determine the width of the column.
  18504. (if noalign (setq org-table-may-need-update c)))
  18505. (delete-char N))
  18506. (delete-char N)
  18507. (org-fix-tags-on-the-fly))))
  18508. ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
  18509. (put 'org-self-insert-command 'delete-selection
  18510. (lambda ()
  18511. (not (run-hook-with-args-until-success
  18512. 'self-insert-uses-region-functions))))
  18513. (put 'orgtbl-self-insert-command 'delete-selection
  18514. (lambda ()
  18515. (not (run-hook-with-args-until-success
  18516. 'self-insert-uses-region-functions))))
  18517. (put 'org-delete-char 'delete-selection 'supersede)
  18518. (put 'org-delete-backward-char 'delete-selection 'supersede)
  18519. (put 'org-yank 'delete-selection 'yank)
  18520. ;; Make `flyspell-mode' delay after some commands
  18521. (put 'org-self-insert-command 'flyspell-delayed t)
  18522. (put 'orgtbl-self-insert-command 'flyspell-delayed t)
  18523. (put 'org-delete-char 'flyspell-delayed t)
  18524. (put 'org-delete-backward-char 'flyspell-delayed t)
  18525. ;; Make pabbrev-mode expand after org-mode commands
  18526. (put 'org-self-insert-command 'pabbrev-expand-after-command t)
  18527. (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
  18528. (defun org-remap (map &rest commands)
  18529. "In MAP, remap the functions given in COMMANDS.
  18530. COMMANDS is a list of alternating OLDDEF NEWDEF command names."
  18531. (let (new old)
  18532. (while commands
  18533. (setq old (pop commands) new (pop commands))
  18534. (if (fboundp 'command-remapping)
  18535. (org-defkey map (vector 'remap old) new)
  18536. (substitute-key-definition old new map global-map)))))
  18537. (defun org-transpose-words ()
  18538. "Transpose words for Org.
  18539. This uses the `org-mode-transpose-word-syntax-table' syntax
  18540. table, which interprets characters in `org-emphasis-alist' as
  18541. word constituents."
  18542. (interactive)
  18543. (with-syntax-table org-mode-transpose-word-syntax-table
  18544. (call-interactively 'transpose-words)))
  18545. (org-remap org-mode-map 'transpose-words 'org-transpose-words)
  18546. (when (eq org-enable-table-editor 'optimized)
  18547. ;; If the user wants maximum table support, we need to hijack
  18548. ;; some standard editing functions
  18549. (org-remap org-mode-map
  18550. 'self-insert-command 'org-self-insert-command
  18551. 'delete-char 'org-delete-char
  18552. 'delete-backward-char 'org-delete-backward-char)
  18553. (org-defkey org-mode-map "|" 'org-force-self-insert))
  18554. (defvar org-ctrl-c-ctrl-c-hook nil
  18555. "Hook for functions attaching themselves to `C-c C-c'.
  18556. This can be used to add additional functionality to the C-c C-c
  18557. key which executes context-dependent commands. This hook is run
  18558. before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
  18559. run after the last test.
  18560. Each function will be called with no arguments. The function
  18561. must check if the context is appropriate for it to act. If yes,
  18562. it should do its thing and then return a non-nil value. If the
  18563. context is wrong, just do nothing and return nil.")
  18564. (defvar org-ctrl-c-ctrl-c-final-hook nil
  18565. "Hook for functions attaching themselves to `C-c C-c'.
  18566. This can be used to add additional functionality to the C-c C-c
  18567. key which executes context-dependent commands. This hook is run
  18568. after any other test, while `org-ctrl-c-ctrl-c-hook' is run
  18569. before the first test.
  18570. Each function will be called with no arguments. The function
  18571. must check if the context is appropriate for it to act. If yes,
  18572. it should do its thing and then return a non-nil value. If the
  18573. context is wrong, just do nothing and return nil.")
  18574. (defvar org-tab-first-hook nil
  18575. "Hook for functions to attach themselves to TAB.
  18576. See `org-ctrl-c-ctrl-c-hook' for more information.
  18577. This hook runs as the first action when TAB is pressed, even before
  18578. `org-cycle' messes around with the `outline-regexp' to cater for
  18579. inline tasks and plain list item folding.
  18580. If any function in this hook returns t, any other actions that
  18581. would have been caused by TAB (such as table field motion or visibility
  18582. cycling) will not occur.")
  18583. (defvar org-tab-after-check-for-table-hook nil
  18584. "Hook for functions to attach themselves to TAB.
  18585. See `org-ctrl-c-ctrl-c-hook' for more information.
  18586. This hook runs after it has been established that the cursor is not in a
  18587. table, but before checking if the cursor is in a headline or if global cycling
  18588. should be done.
  18589. If any function in this hook returns t, not other actions like visibility
  18590. cycling will be done.")
  18591. (defvar org-tab-after-check-for-cycling-hook nil
  18592. "Hook for functions to attach themselves to TAB.
  18593. See `org-ctrl-c-ctrl-c-hook' for more information.
  18594. This hook runs after it has been established that not table field motion and
  18595. not visibility should be done because of current context. This is probably
  18596. the place where a package like yasnippets can hook in.")
  18597. (defvar org-tab-before-tab-emulation-hook nil
  18598. "Hook for functions to attach themselves to TAB.
  18599. See `org-ctrl-c-ctrl-c-hook' for more information.
  18600. This hook runs after every other options for TAB have been exhausted, but
  18601. before indentation and \t insertion takes place.")
  18602. (defvar org-metaleft-hook nil
  18603. "Hook for functions attaching themselves to `M-left'.
  18604. See `org-ctrl-c-ctrl-c-hook' for more information.")
  18605. (defvar org-metaright-hook nil
  18606. "Hook for functions attaching themselves to `M-right'.
  18607. See `org-ctrl-c-ctrl-c-hook' for more information.")
  18608. (defvar org-metaup-hook nil
  18609. "Hook for functions attaching themselves to `M-up'.
  18610. See `org-ctrl-c-ctrl-c-hook' for more information.")
  18611. (defvar org-metadown-hook nil
  18612. "Hook for functions attaching themselves to `M-down'.
  18613. See `org-ctrl-c-ctrl-c-hook' for more information.")
  18614. (defvar org-shiftmetaleft-hook nil
  18615. "Hook for functions attaching themselves to `M-S-left'.
  18616. See `org-ctrl-c-ctrl-c-hook' for more information.")
  18617. (defvar org-shiftmetaright-hook nil
  18618. "Hook for functions attaching themselves to `M-S-right'.
  18619. See `org-ctrl-c-ctrl-c-hook' for more information.")
  18620. (defvar org-shiftmetaup-hook nil
  18621. "Hook for functions attaching themselves to `M-S-up'.
  18622. See `org-ctrl-c-ctrl-c-hook' for more information.")
  18623. (defvar org-shiftmetadown-hook nil
  18624. "Hook for functions attaching themselves to `M-S-down'.
  18625. See `org-ctrl-c-ctrl-c-hook' for more information.")
  18626. (defvar org-metareturn-hook nil
  18627. "Hook for functions attaching themselves to `M-RET'.
  18628. See `org-ctrl-c-ctrl-c-hook' for more information.")
  18629. (defvar org-shiftup-hook nil
  18630. "Hook for functions attaching themselves to `S-up'.
  18631. See `org-ctrl-c-ctrl-c-hook' for more information.")
  18632. (defvar org-shiftup-final-hook nil
  18633. "Hook for functions attaching themselves to `S-up'.
  18634. This one runs after all other options except shift-select have been excluded.
  18635. See `org-ctrl-c-ctrl-c-hook' for more information.")
  18636. (defvar org-shiftdown-hook nil
  18637. "Hook for functions attaching themselves to `S-down'.
  18638. See `org-ctrl-c-ctrl-c-hook' for more information.")
  18639. (defvar org-shiftdown-final-hook nil
  18640. "Hook for functions attaching themselves to `S-down'.
  18641. This one runs after all other options except shift-select have been excluded.
  18642. See `org-ctrl-c-ctrl-c-hook' for more information.")
  18643. (defvar org-shiftleft-hook nil
  18644. "Hook for functions attaching themselves to `S-left'.
  18645. See `org-ctrl-c-ctrl-c-hook' for more information.")
  18646. (defvar org-shiftleft-final-hook nil
  18647. "Hook for functions attaching themselves to `S-left'.
  18648. This one runs after all other options except shift-select have been excluded.
  18649. See `org-ctrl-c-ctrl-c-hook' for more information.")
  18650. (defvar org-shiftright-hook nil
  18651. "Hook for functions attaching themselves to `S-right'.
  18652. See `org-ctrl-c-ctrl-c-hook' for more information.")
  18653. (defvar org-shiftright-final-hook nil
  18654. "Hook for functions attaching themselves to `S-right'.
  18655. This one runs after all other options except shift-select have been excluded.
  18656. See `org-ctrl-c-ctrl-c-hook' for more information.")
  18657. (defun org-modifier-cursor-error ()
  18658. "Throw an error, a modified cursor command was applied in wrong context."
  18659. (user-error "This command is active in special context like tables, headlines or items"))
  18660. (defun org-shiftselect-error ()
  18661. "Throw an error because Shift-Cursor command was applied in wrong context."
  18662. (if (and (boundp 'shift-select-mode) shift-select-mode)
  18663. (user-error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
  18664. (user-error "This command works only in special context like headlines or timestamps")))
  18665. (defun org-call-for-shift-select (cmd)
  18666. (let ((this-command-keys-shift-translated t))
  18667. (call-interactively cmd)))
  18668. (defun org-shifttab (&optional arg)
  18669. "Global visibility cycling or move to previous table field.
  18670. Call `org-table-previous-field' within a table.
  18671. When ARG is nil, cycle globally through visibility states.
  18672. When ARG is a numeric prefix, show contents of this level."
  18673. (interactive "P")
  18674. (cond
  18675. ((org-at-table-p) (call-interactively 'org-table-previous-field))
  18676. ((integerp arg)
  18677. (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
  18678. (message "Content view to level: %d" arg)
  18679. (org-content (prefix-numeric-value arg2))
  18680. (org-cycle-show-empty-lines t)
  18681. (setq org-cycle-global-status 'overview)))
  18682. (t (call-interactively 'org-global-cycle))))
  18683. (defun org-shiftmetaleft ()
  18684. "Promote subtree or delete table column.
  18685. Calls `org-promote-subtree', `org-outdent-item-tree', or
  18686. `org-table-delete-column', depending on context. See the
  18687. individual commands for more information."
  18688. (interactive)
  18689. (cond
  18690. ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
  18691. ((org-at-table-p) (call-interactively 'org-table-delete-column))
  18692. ((org-at-heading-p) (call-interactively 'org-promote-subtree))
  18693. ((if (not (org-region-active-p)) (org-at-item-p)
  18694. (save-excursion (goto-char (region-beginning))
  18695. (org-at-item-p)))
  18696. (call-interactively 'org-outdent-item-tree))
  18697. (t (org-modifier-cursor-error))))
  18698. (defun org-shiftmetaright ()
  18699. "Demote subtree or insert table column.
  18700. Calls `org-demote-subtree', `org-indent-item-tree', or
  18701. `org-table-insert-column', depending on context. See the
  18702. individual commands for more information."
  18703. (interactive)
  18704. (cond
  18705. ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
  18706. ((org-at-table-p) (call-interactively 'org-table-insert-column))
  18707. ((org-at-heading-p) (call-interactively 'org-demote-subtree))
  18708. ((if (not (org-region-active-p)) (org-at-item-p)
  18709. (save-excursion (goto-char (region-beginning))
  18710. (org-at-item-p)))
  18711. (call-interactively 'org-indent-item-tree))
  18712. (t (org-modifier-cursor-error))))
  18713. (defun org-shiftmetaup (&optional arg)
  18714. "Drag the line at point up.
  18715. In a table, kill the current row.
  18716. On a clock timestamp, update the value of the timestamp like `S-<up>'
  18717. but also adjust the previous clocked item in the clock history.
  18718. Everywhere else, drag the line at point up."
  18719. (interactive "P")
  18720. (cond
  18721. ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
  18722. ((org-at-table-p) (call-interactively 'org-table-kill-row))
  18723. ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
  18724. (call-interactively 'org-timestamp-up)))
  18725. (t (call-interactively 'org-drag-line-backward))))
  18726. (defun org-shiftmetadown (&optional arg)
  18727. "Drag the line at point down.
  18728. In a table, insert an empty row at the current line.
  18729. On a clock timestamp, update the value of the timestamp like `S-<down>'
  18730. but also adjust the previous clocked item in the clock history.
  18731. Everywhere else, drag the line at point down."
  18732. (interactive "P")
  18733. (cond
  18734. ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
  18735. ((org-at-table-p) (call-interactively 'org-table-insert-row))
  18736. ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
  18737. (call-interactively 'org-timestamp-down)))
  18738. (t (call-interactively 'org-drag-line-forward))))
  18739. (defsubst org-hidden-tree-error ()
  18740. (user-error
  18741. "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
  18742. (defun org-metaleft (&optional arg)
  18743. "Promote heading, list item at point or move table column left.
  18744. Calls `org-do-promote', `org-outdent-item' or `org-table-move-column',
  18745. depending on context. With no specific context, calls the Emacs
  18746. default `backward-word'. See the individual commands for more
  18747. information.
  18748. This function runs the hook `org-metaleft-hook' as a first step,
  18749. and returns at first non-nil value."
  18750. (interactive "P")
  18751. (cond
  18752. ((run-hook-with-args-until-success 'org-metaleft-hook))
  18753. ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
  18754. ((org-with-limited-levels
  18755. (or (org-at-heading-p)
  18756. (and (org-region-active-p)
  18757. (save-excursion
  18758. (goto-char (region-beginning))
  18759. (org-at-heading-p)))))
  18760. (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
  18761. (call-interactively 'org-do-promote))
  18762. ;; At an inline task.
  18763. ((org-at-heading-p)
  18764. (call-interactively 'org-inlinetask-promote))
  18765. ((or (org-at-item-p)
  18766. (and (org-region-active-p)
  18767. (save-excursion
  18768. (goto-char (region-beginning))
  18769. (org-at-item-p))))
  18770. (when (org-check-for-hidden 'items) (org-hidden-tree-error))
  18771. (call-interactively 'org-outdent-item))
  18772. (t (call-interactively 'backward-word))))
  18773. (defun org-metaright (&optional arg)
  18774. "Demote heading, list item at point or move table column right.
  18775. In front of a drawer or a block keyword, indent it correctly.
  18776. Calls `org-do-demote', `org-indent-item', `org-table-move-column',
  18777. `org-indnet-drawer' or `org-indent-block' depending on context.
  18778. With no specific context, calls the Emacs default `forward-word'.
  18779. See the individual commands for more information.
  18780. This function runs the hook `org-metaright-hook' as a first step,
  18781. and returns at first non-nil value."
  18782. (interactive "P")
  18783. (cond
  18784. ((run-hook-with-args-until-success 'org-metaright-hook))
  18785. ((org-at-table-p) (call-interactively 'org-table-move-column))
  18786. ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
  18787. ((org-at-block-p) (call-interactively 'org-indent-block))
  18788. ((org-with-limited-levels
  18789. (or (org-at-heading-p)
  18790. (and (org-region-active-p)
  18791. (save-excursion
  18792. (goto-char (region-beginning))
  18793. (org-at-heading-p)))))
  18794. (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
  18795. (call-interactively 'org-do-demote))
  18796. ;; At an inline task.
  18797. ((org-at-heading-p)
  18798. (call-interactively 'org-inlinetask-demote))
  18799. ((or (org-at-item-p)
  18800. (and (org-region-active-p)
  18801. (save-excursion
  18802. (goto-char (region-beginning))
  18803. (org-at-item-p))))
  18804. (when (org-check-for-hidden 'items) (org-hidden-tree-error))
  18805. (call-interactively 'org-indent-item))
  18806. (t (call-interactively 'forward-word))))
  18807. (defun org-check-for-hidden (what)
  18808. "Check if there are hidden headlines/items in the current visual line.
  18809. WHAT can be either `headlines' or `items'. If the current line is
  18810. an outline or item heading and it has a folded subtree below it,
  18811. this function returns t, nil otherwise."
  18812. (let ((re (cond
  18813. ((eq what 'headlines) org-outline-regexp-bol)
  18814. ((eq what 'items) (org-item-beginning-re))
  18815. (t (error "This should not happen"))))
  18816. beg end)
  18817. (save-excursion
  18818. (catch 'exit
  18819. (unless (org-region-active-p)
  18820. (setq beg (point-at-bol))
  18821. (beginning-of-line 2)
  18822. (while (and (not (eobp)) ;; this is like `next-line'
  18823. (get-char-property (1- (point)) 'invisible))
  18824. (beginning-of-line 2))
  18825. (setq end (point))
  18826. (goto-char beg)
  18827. (goto-char (point-at-eol))
  18828. (setq end (max end (point)))
  18829. (while (re-search-forward re end t)
  18830. (if (get-char-property (match-beginning 0) 'invisible)
  18831. (throw 'exit t))))
  18832. nil))))
  18833. (defun org-metaup (&optional arg)
  18834. "Move subtree up or move table row up.
  18835. Calls `org-move-subtree-up' or `org-table-move-row' or
  18836. `org-move-item-up', depending on context. See the individual commands
  18837. for more information."
  18838. (interactive "P")
  18839. (cond
  18840. ((run-hook-with-args-until-success 'org-metaup-hook))
  18841. ((org-region-active-p)
  18842. (let* ((a (min (region-beginning) (region-end)))
  18843. (b (1- (max (region-beginning) (region-end))))
  18844. (c (save-excursion (goto-char a)
  18845. (move-beginning-of-line 0)))
  18846. (d (save-excursion (goto-char a)
  18847. (move-end-of-line 0) (point))))
  18848. (transpose-regions a b c d)
  18849. (goto-char c)))
  18850. ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
  18851. ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
  18852. ((org-at-item-p) (call-interactively 'org-move-item-up))
  18853. (t (org-drag-element-backward))))
  18854. (defun org-metadown (&optional arg)
  18855. "Move subtree down or move table row down.
  18856. Calls `org-move-subtree-down' or `org-table-move-row' or
  18857. `org-move-item-down', depending on context. See the individual
  18858. commands for more information."
  18859. (interactive "P")
  18860. (cond
  18861. ((run-hook-with-args-until-success 'org-metadown-hook))
  18862. ((org-region-active-p)
  18863. (let* ((a (min (region-beginning) (region-end)))
  18864. (b (max (region-beginning) (region-end)))
  18865. (c (save-excursion (goto-char b)
  18866. (move-beginning-of-line 1)))
  18867. (d (save-excursion (goto-char b)
  18868. (move-end-of-line 1) (1+ (point)))))
  18869. (transpose-regions a b c d)
  18870. (goto-char d)))
  18871. ((org-at-table-p) (call-interactively 'org-table-move-row))
  18872. ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
  18873. ((org-at-item-p) (call-interactively 'org-move-item-down))
  18874. (t (org-drag-element-forward))))
  18875. (defun org-shiftup (&optional arg)
  18876. "Increase item in timestamp or increase priority of current headline.
  18877. Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
  18878. depending on context. See the individual commands for more information."
  18879. (interactive "P")
  18880. (cond
  18881. ((run-hook-with-args-until-success 'org-shiftup-hook))
  18882. ((and org-support-shift-select (org-region-active-p))
  18883. (org-call-for-shift-select 'previous-line))
  18884. ((org-at-timestamp-p t)
  18885. (call-interactively (if org-edit-timestamp-down-means-later
  18886. 'org-timestamp-down 'org-timestamp-up)))
  18887. ((and (not (eq org-support-shift-select 'always))
  18888. org-enable-priority-commands
  18889. (org-at-heading-p))
  18890. (call-interactively 'org-priority-up))
  18891. ((and (not org-support-shift-select) (org-at-item-p))
  18892. (call-interactively 'org-previous-item))
  18893. ((org-clocktable-try-shift 'up arg))
  18894. ((run-hook-with-args-until-success 'org-shiftup-final-hook))
  18895. (org-support-shift-select
  18896. (org-call-for-shift-select 'previous-line))
  18897. (t (org-shiftselect-error))))
  18898. (defun org-shiftdown (&optional arg)
  18899. "Decrease item in timestamp or decrease priority of current headline.
  18900. Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
  18901. depending on context. See the individual commands for more information."
  18902. (interactive "P")
  18903. (cond
  18904. ((run-hook-with-args-until-success 'org-shiftdown-hook))
  18905. ((and org-support-shift-select (org-region-active-p))
  18906. (org-call-for-shift-select 'next-line))
  18907. ((org-at-timestamp-p t)
  18908. (call-interactively (if org-edit-timestamp-down-means-later
  18909. 'org-timestamp-up 'org-timestamp-down)))
  18910. ((and (not (eq org-support-shift-select 'always))
  18911. org-enable-priority-commands
  18912. (org-at-heading-p))
  18913. (call-interactively 'org-priority-down))
  18914. ((and (not org-support-shift-select) (org-at-item-p))
  18915. (call-interactively 'org-next-item))
  18916. ((org-clocktable-try-shift 'down arg))
  18917. ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
  18918. (org-support-shift-select
  18919. (org-call-for-shift-select 'next-line))
  18920. (t (org-shiftselect-error))))
  18921. (defun org-shiftright (&optional arg)
  18922. "Cycle the thing at point or in the current line, depending on context.
  18923. Depending on context, this does one of the following:
  18924. - switch a timestamp at point one day into the future
  18925. - on a headline, switch to the next TODO keyword.
  18926. - on an item, switch entire list to the next bullet type
  18927. - on a property line, switch to the next allowed value
  18928. - on a clocktable definition line, move time block into the future"
  18929. (interactive "P")
  18930. (cond
  18931. ((run-hook-with-args-until-success 'org-shiftright-hook))
  18932. ((and org-support-shift-select (org-region-active-p))
  18933. (org-call-for-shift-select 'forward-char))
  18934. ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
  18935. ((and (not (eq org-support-shift-select 'always))
  18936. (org-at-heading-p))
  18937. (let ((org-inhibit-logging
  18938. (not org-treat-S-cursor-todo-selection-as-state-change))
  18939. (org-inhibit-blocking
  18940. (not org-treat-S-cursor-todo-selection-as-state-change)))
  18941. (org-call-with-arg 'org-todo 'right)))
  18942. ((or (and org-support-shift-select
  18943. (not (eq org-support-shift-select 'always))
  18944. (org-at-item-bullet-p))
  18945. (and (not org-support-shift-select) (org-at-item-p)))
  18946. (org-call-with-arg 'org-cycle-list-bullet nil))
  18947. ((and (not (eq org-support-shift-select 'always))
  18948. (org-at-property-p))
  18949. (call-interactively 'org-property-next-allowed-value))
  18950. ((org-clocktable-try-shift 'right arg))
  18951. ((run-hook-with-args-until-success 'org-shiftright-final-hook))
  18952. (org-support-shift-select
  18953. (org-call-for-shift-select 'forward-char))
  18954. (t (org-shiftselect-error))))
  18955. (defun org-shiftleft (&optional arg)
  18956. "Cycle the thing at point or in the current line, depending on context.
  18957. Depending on context, this does one of the following:
  18958. - switch a timestamp at point one day into the past
  18959. - on a headline, switch to the previous TODO keyword.
  18960. - on an item, switch entire list to the previous bullet type
  18961. - on a property line, switch to the previous allowed value
  18962. - on a clocktable definition line, move time block into the past"
  18963. (interactive "P")
  18964. (cond
  18965. ((run-hook-with-args-until-success 'org-shiftleft-hook))
  18966. ((and org-support-shift-select (org-region-active-p))
  18967. (org-call-for-shift-select 'backward-char))
  18968. ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
  18969. ((and (not (eq org-support-shift-select 'always))
  18970. (org-at-heading-p))
  18971. (let ((org-inhibit-logging
  18972. (not org-treat-S-cursor-todo-selection-as-state-change))
  18973. (org-inhibit-blocking
  18974. (not org-treat-S-cursor-todo-selection-as-state-change)))
  18975. (org-call-with-arg 'org-todo 'left)))
  18976. ((or (and org-support-shift-select
  18977. (not (eq org-support-shift-select 'always))
  18978. (org-at-item-bullet-p))
  18979. (and (not org-support-shift-select) (org-at-item-p)))
  18980. (org-call-with-arg 'org-cycle-list-bullet 'previous))
  18981. ((and (not (eq org-support-shift-select 'always))
  18982. (org-at-property-p))
  18983. (call-interactively 'org-property-previous-allowed-value))
  18984. ((org-clocktable-try-shift 'left arg))
  18985. ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
  18986. (org-support-shift-select
  18987. (org-call-for-shift-select 'backward-char))
  18988. (t (org-shiftselect-error))))
  18989. (defun org-shiftcontrolright ()
  18990. "Switch to next TODO set."
  18991. (interactive)
  18992. (cond
  18993. ((and org-support-shift-select (org-region-active-p))
  18994. (org-call-for-shift-select 'forward-word))
  18995. ((and (not (eq org-support-shift-select 'always))
  18996. (org-at-heading-p))
  18997. (org-call-with-arg 'org-todo 'nextset))
  18998. (org-support-shift-select
  18999. (org-call-for-shift-select 'forward-word))
  19000. (t (org-shiftselect-error))))
  19001. (defun org-shiftcontrolleft ()
  19002. "Switch to previous TODO set."
  19003. (interactive)
  19004. (cond
  19005. ((and org-support-shift-select (org-region-active-p))
  19006. (org-call-for-shift-select 'backward-word))
  19007. ((and (not (eq org-support-shift-select 'always))
  19008. (org-at-heading-p))
  19009. (org-call-with-arg 'org-todo 'previousset))
  19010. (org-support-shift-select
  19011. (org-call-for-shift-select 'backward-word))
  19012. (t (org-shiftselect-error))))
  19013. (defun org-shiftcontrolup (&optional n)
  19014. "Change timestamps synchronously up in CLOCK log lines.
  19015. Optional argument N tells to change by that many units."
  19016. (interactive "P")
  19017. (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
  19018. (let (org-support-shift-select)
  19019. (org-clock-timestamps-up n))
  19020. (user-error "Not at a clock log")))
  19021. (defun org-shiftcontroldown (&optional n)
  19022. "Change timestamps synchronously down in CLOCK log lines.
  19023. Optional argument N tells to change by that many units."
  19024. (interactive "P")
  19025. (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
  19026. (let (org-support-shift-select)
  19027. (org-clock-timestamps-down n))
  19028. (user-error "Not at a clock log")))
  19029. (defun org-increase-number-at-point (&optional inc)
  19030. "Increment the number at point.
  19031. With an optional prefix numeric argument INC, increment using
  19032. this numeric value."
  19033. (interactive "p")
  19034. (if (not (number-at-point))
  19035. (user-error "Not on a number")
  19036. (unless inc (setq inc 1))
  19037. (let ((pos (point))
  19038. (beg (skip-chars-backward "-+^/*0-9eE."))
  19039. (end (skip-chars-forward "-+^/*0-9eE^.")) nap)
  19040. (setq nap (buffer-substring-no-properties
  19041. (+ pos beg) (+ pos beg end)))
  19042. (delete-region (+ pos beg) (+ pos beg end))
  19043. (insert (calc-eval (concat (number-to-string inc) "+" nap))))
  19044. (when (org-at-table-p)
  19045. (org-table-align)
  19046. (org-table-end-of-field 1))))
  19047. (defun org-decrease-number-at-point (&optional inc)
  19048. "Decrement the number at point.
  19049. With an optional prefix numeric argument INC, decrement using
  19050. this numeric value."
  19051. (interactive "p")
  19052. (org-increase-number-at-point (- inc)))
  19053. (defun org-ctrl-c-ret ()
  19054. "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
  19055. (interactive)
  19056. (cond
  19057. ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
  19058. (t (call-interactively 'org-insert-heading))))
  19059. (defun org-find-visible ()
  19060. (let ((s (point)))
  19061. (while (and (not (= (point-max) (setq s (next-overlay-change s))))
  19062. (get-char-property s 'invisible)))
  19063. s))
  19064. (defun org-find-invisible ()
  19065. (let ((s (point)))
  19066. (while (and (not (= (point-max) (setq s (next-overlay-change s))))
  19067. (not (get-char-property s 'invisible))))
  19068. s))
  19069. (defun org-copy-visible (beg end)
  19070. "Copy the visible parts of the region."
  19071. (interactive "r")
  19072. (let (snippets s)
  19073. (save-excursion
  19074. (save-restriction
  19075. (narrow-to-region beg end)
  19076. (setq s (goto-char (point-min)))
  19077. (while (not (= (point) (point-max)))
  19078. (goto-char (org-find-invisible))
  19079. (push (buffer-substring s (point)) snippets)
  19080. (setq s (goto-char (org-find-visible))))))
  19081. (kill-new (apply 'concat (nreverse snippets)))))
  19082. (defun org-copy-special ()
  19083. "Copy region in table or copy current subtree.
  19084. Calls `org-table-copy' or `org-copy-subtree', depending on context.
  19085. See the individual commands for more information."
  19086. (interactive)
  19087. (call-interactively
  19088. (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
  19089. (defun org-cut-special ()
  19090. "Cut region in table or cut current subtree.
  19091. Calls `org-table-copy' or `org-cut-subtree', depending on context.
  19092. See the individual commands for more information."
  19093. (interactive)
  19094. (call-interactively
  19095. (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
  19096. (defun org-paste-special (arg)
  19097. "Paste rectangular region into table, or past subtree relative to level.
  19098. Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
  19099. See the individual commands for more information."
  19100. (interactive "P")
  19101. (if (org-at-table-p)
  19102. (org-table-paste-rectangle)
  19103. (org-paste-subtree arg)))
  19104. (defsubst org-in-fixed-width-region-p ()
  19105. "Is point in a fixed-width region?"
  19106. (save-match-data
  19107. (eq 'fixed-width (org-element-type (org-element-at-point)))))
  19108. (defun org-edit-special (&optional arg)
  19109. "Call a special editor for the element at point.
  19110. When at a table, call the formula editor with `org-table-edit-formulas'.
  19111. When in a source code block, call `org-edit-src-code'.
  19112. When in a fixed-width region, call `org-edit-fixed-width-region'.
  19113. When in an export block, call `org-edit-export-block'.
  19114. When at an #+INCLUDE keyword, visit the included file.
  19115. When at a footnote reference, call `org-edit-footnote-reference'
  19116. On a link, call `ffap' to visit the link at point.
  19117. Otherwise, return a user error."
  19118. (interactive "P")
  19119. (let ((element (org-element-at-point)))
  19120. (assert (not buffer-read-only) nil
  19121. "Buffer is read-only: %s" (buffer-name))
  19122. (case (org-element-type element)
  19123. (src-block
  19124. (if (not arg) (org-edit-src-code)
  19125. (let* ((info (org-babel-get-src-block-info))
  19126. (lang (nth 0 info))
  19127. (params (nth 2 info))
  19128. (session (cdr (assq :session params))))
  19129. (if (not session) (org-edit-src-code)
  19130. ;; At a src-block with a session and function called with
  19131. ;; an ARG: switch to the buffer related to the inferior
  19132. ;; process.
  19133. (switch-to-buffer
  19134. (funcall (intern (concat "org-babel-prep-session:" lang))
  19135. session params))))))
  19136. (keyword
  19137. (if (member (org-element-property :key element) '("INCLUDE" "SETUPFILE"))
  19138. (org-open-link-from-string
  19139. (format "[[%s]]"
  19140. (expand-file-name
  19141. (let ((value (org-element-property :value element)))
  19142. (cond ((not (org-string-nw-p value))
  19143. (user-error "No file to edit"))
  19144. ((string-match "\\`\"\\(.*?\\)\"" value)
  19145. (match-string 1 value))
  19146. ((string-match "\\`[^ \t\"]\\S-*" value)
  19147. (match-string 0 value))
  19148. (t (user-error "No valid file specified")))))))
  19149. (user-error "No special environment to edit here")))
  19150. (table
  19151. (if (eq (org-element-property :type element) 'table.el)
  19152. (org-edit-table.el)
  19153. (call-interactively 'org-table-edit-formulas)))
  19154. ;; Only Org tables contain `table-row' type elements.
  19155. (table-row (call-interactively 'org-table-edit-formulas))
  19156. (example-block (org-edit-src-code))
  19157. (export-block (org-edit-export-block))
  19158. (fixed-width (org-edit-fixed-width-region))
  19159. (otherwise
  19160. ;; No notable element at point. Though, we may be at a link or
  19161. ;; a footnote reference, which are objects. Thus, scan deeper.
  19162. (let ((context (org-element-context element)))
  19163. (case (org-element-type context)
  19164. (link (call-interactively #'ffap))
  19165. (footnote-reference (org-edit-footnote-reference))
  19166. (t (user-error "No special environment to edit here"))))))))
  19167. (defvar org-table-coordinate-overlays) ; defined in org-table.el
  19168. (defun org-ctrl-c-ctrl-c (&optional arg)
  19169. "Set tags in headline, or update according to changed information at point.
  19170. This command does many different things, depending on context:
  19171. - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
  19172. this is what we do.
  19173. - If the cursor is on a statistics cookie, update it.
  19174. - If the cursor is in a headline, prompt for tags and insert them
  19175. into the current line, aligned to `org-tags-column'. When called
  19176. with prefix arg, realign all tags in the current buffer.
  19177. - If the cursor is in one of the special #+KEYWORD lines, this
  19178. triggers scanning the buffer for these lines and updating the
  19179. information.
  19180. - If the cursor is inside a table, realign the table. This command
  19181. works even if the automatic table editor has been turned off.
  19182. - If the cursor is on a #+TBLFM line, re-apply the formulas to
  19183. the entire table.
  19184. - If the cursor is at a footnote reference or definition, jump to
  19185. the corresponding definition or references, respectively.
  19186. - If the cursor is a the beginning of a dynamic block, update it.
  19187. - If the current buffer is a capture buffer, close note and file it.
  19188. - If the cursor is on a <<<target>>>, update radio targets and
  19189. corresponding links in this buffer.
  19190. - If the cursor is on a numbered item in a plain list, renumber the
  19191. ordered list.
  19192. - If the cursor is on a checkbox, toggle it.
  19193. - If the cursor is on a code block, evaluate it. The variable
  19194. `org-confirm-babel-evaluate' can be used to control prompting
  19195. before code block evaluation, by default every code block
  19196. evaluation requires confirmation. Code block evaluation can be
  19197. inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
  19198. (interactive "P")
  19199. (cond
  19200. ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
  19201. org-occur-highlights)
  19202. (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
  19203. (org-remove-occur-highlights)
  19204. (message "Temporary highlights/overlays removed from current buffer"))
  19205. ((and (local-variable-p 'org-finish-function (current-buffer))
  19206. (fboundp org-finish-function))
  19207. (funcall org-finish-function))
  19208. ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
  19209. (t
  19210. (if (save-excursion (beginning-of-line) (looking-at "[ \t]*$"))
  19211. (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
  19212. (user-error "C-c C-c can do nothing useful at this location"))
  19213. (let* ((context (org-element-context))
  19214. (type (org-element-type context)))
  19215. (case type
  19216. ;; When at a link, act according to the parent instead.
  19217. (link (setq context (org-element-property :parent context))
  19218. (setq type (org-element-type context)))
  19219. ;; Unsupported object types: refer to the first supported
  19220. ;; element or object containing it.
  19221. ((bold code entity export-snippet inline-babel-call inline-src-block
  19222. italic latex-fragment line-break macro strike-through subscript
  19223. superscript underline verbatim)
  19224. (setq context
  19225. (org-element-lineage
  19226. context '(radio-target paragraph verse-block table-cell)))))
  19227. ;; For convenience: at the first line of a paragraph on the
  19228. ;; same line as an item, apply function on that item instead.
  19229. (when (eq type 'paragraph)
  19230. (let ((parent (org-element-property :parent context)))
  19231. (when (and (eq (org-element-type parent) 'item)
  19232. (= (line-beginning-position)
  19233. (org-element-property :begin parent)))
  19234. (setq context parent type 'item))))
  19235. ;; Act according to type of element or object at point.
  19236. (case type
  19237. (clock (org-clock-update-time-maybe))
  19238. (dynamic-block
  19239. (save-excursion
  19240. (goto-char (org-element-property :post-affiliated context))
  19241. (org-update-dblock)))
  19242. (footnote-definition
  19243. (goto-char (org-element-property :post-affiliated context))
  19244. (call-interactively 'org-footnote-action))
  19245. (footnote-reference (call-interactively 'org-footnote-action))
  19246. ((headline inlinetask)
  19247. (save-excursion (goto-char (org-element-property :begin context))
  19248. (call-interactively 'org-set-tags)))
  19249. (item
  19250. ;; At an item: a double C-u set checkbox to "[-]"
  19251. ;; unconditionally, whereas a single one will toggle its
  19252. ;; presence. Without an universal argument, if the item
  19253. ;; has a checkbox, toggle it. Otherwise repair the list.
  19254. (let* ((box (org-element-property :checkbox context))
  19255. (struct (org-element-property :structure context))
  19256. (old-struct (copy-tree struct))
  19257. (parents (org-list-parents-alist struct))
  19258. (prevs (org-list-prevs-alist struct))
  19259. (orderedp (org-not-nil (org-entry-get nil "ORDERED"))))
  19260. (org-list-set-checkbox
  19261. (org-element-property :begin context) struct
  19262. (cond ((equal arg '(16)) "[-]")
  19263. ((and (not box) (equal arg '(4))) "[ ]")
  19264. ((or (not box) (equal arg '(4))) nil)
  19265. ((eq box 'on) "[ ]")
  19266. (t "[X]")))
  19267. ;; Mimic `org-list-write-struct' but with grabbing
  19268. ;; a return value from `org-list-struct-fix-box'.
  19269. (org-list-struct-fix-ind struct parents 2)
  19270. (org-list-struct-fix-item-end struct)
  19271. (org-list-struct-fix-bul struct prevs)
  19272. (org-list-struct-fix-ind struct parents)
  19273. (let ((block-item
  19274. (org-list-struct-fix-box struct parents prevs orderedp)))
  19275. (if (and box (equal struct old-struct))
  19276. (if (equal arg '(16))
  19277. (message "Checkboxes already reset")
  19278. (user-error "Cannot toggle this checkbox: %s"
  19279. (if (eq box 'on)
  19280. "all subitems checked"
  19281. "unchecked subitems")))
  19282. (org-list-struct-apply-struct struct old-struct)
  19283. (org-update-checkbox-count-maybe))
  19284. (when block-item
  19285. (message "Checkboxes were removed due to empty box at line %d"
  19286. (org-current-line block-item))))))
  19287. (keyword
  19288. (let ((org-inhibit-startup-visibility-stuff t)
  19289. (org-startup-align-all-tables nil))
  19290. (when (boundp 'org-table-coordinate-overlays)
  19291. (mapc 'delete-overlay org-table-coordinate-overlays)
  19292. (setq org-table-coordinate-overlays nil))
  19293. (org-save-outline-visibility 'use-markers (org-mode-restart)))
  19294. (message "Local setup has been refreshed"))
  19295. (plain-list
  19296. ;; At a plain list, with a double C-u argument, set
  19297. ;; checkboxes of each item to "[-]", whereas a single one
  19298. ;; will toggle their presence according to the state of the
  19299. ;; first item in the list. Without an argument, repair the
  19300. ;; list.
  19301. (let* ((begin (org-element-property :contents-begin context))
  19302. (beginm (move-marker (make-marker) begin))
  19303. (struct (org-element-property :structure context))
  19304. (old-struct (copy-tree struct))
  19305. (first-box (save-excursion
  19306. (goto-char begin)
  19307. (looking-at org-list-full-item-re)
  19308. (match-string-no-properties 3)))
  19309. (new-box (cond ((equal arg '(16)) "[-]")
  19310. ((equal arg '(4)) (unless first-box "[ ]"))
  19311. ((equal first-box "[X]") "[ ]")
  19312. (t "[X]"))))
  19313. (cond
  19314. (arg
  19315. (mapc (lambda (pos) (org-list-set-checkbox pos struct new-box))
  19316. (org-list-get-all-items
  19317. begin struct (org-list-prevs-alist struct))))
  19318. ((and first-box (eq (point) begin))
  19319. ;; For convenience, when point is at bol on the first
  19320. ;; item of the list and no argument is provided, simply
  19321. ;; toggle checkbox of that item, if any.
  19322. (org-list-set-checkbox begin struct new-box)))
  19323. (org-list-write-struct
  19324. struct (org-list-parents-alist struct) old-struct)
  19325. (org-update-checkbox-count-maybe)
  19326. (save-excursion (goto-char beginm) (org-list-send-list 'maybe))))
  19327. ((property-drawer node-property)
  19328. (call-interactively 'org-property-action))
  19329. ((radio-target target)
  19330. (call-interactively 'org-update-radio-target-regexp))
  19331. (statistics-cookie
  19332. (call-interactively 'org-update-statistics-cookies))
  19333. ((table table-cell table-row)
  19334. ;; At a table, recalculate every field and align it. Also
  19335. ;; send the table if necessary. If the table has
  19336. ;; a `table.el' type, just give up. At a table row or
  19337. ;; cell, maybe recalculate line but always align table.
  19338. (if (eq (org-element-property :type context) 'table.el)
  19339. (message "Use C-c ' to edit table.el tables")
  19340. (let ((org-enable-table-editor t))
  19341. (if (or (eq type 'table)
  19342. ;; Check if point is at a TBLFM line.
  19343. (and (eq type 'table-row)
  19344. (= (point) (org-element-property :end context))))
  19345. (save-excursion
  19346. (if (org-at-TBLFM-p)
  19347. (progn (require 'org-table)
  19348. (org-table-calc-current-TBLFM))
  19349. (goto-char (org-element-property :contents-begin context))
  19350. (org-call-with-arg 'org-table-recalculate (or arg t))
  19351. (orgtbl-send-table 'maybe)))
  19352. (org-table-maybe-eval-formula)
  19353. (cond (arg (call-interactively 'org-table-recalculate))
  19354. ((org-table-maybe-recalculate-line))
  19355. (t (org-table-align)))))))
  19356. (timestamp (org-timestamp-change 0 'day))
  19357. (otherwise
  19358. (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
  19359. (user-error
  19360. "C-c C-c can do nothing useful at this location")))))))))
  19361. (defun org-mode-restart ()
  19362. (interactive)
  19363. (let ((indent-status (org-bound-and-true-p org-indent-mode)))
  19364. (funcall major-mode)
  19365. (hack-local-variables)
  19366. (when (and indent-status (not (org-bound-and-true-p org-indent-mode)))
  19367. (org-indent-mode -1)))
  19368. (message "%s restarted" major-mode))
  19369. (defun org-kill-note-or-show-branches ()
  19370. "If this is a Note buffer, abort storing the note. Else call `show-branches'."
  19371. (interactive)
  19372. (if (not org-finish-function)
  19373. (progn
  19374. (hide-subtree)
  19375. (call-interactively 'show-branches))
  19376. (let ((org-note-abort t))
  19377. (funcall org-finish-function))))
  19378. (defun org-delete-indentation (&optional ARG)
  19379. "Join current line to previous and fix whitespace at join.
  19380. If previous line is a headline add to headline title. Otherwise
  19381. the function calls `delete-indentation'.
  19382. With argument, join this line to following line."
  19383. (interactive "*P")
  19384. (if (save-excursion
  19385. (if ARG (beginning-of-line)
  19386. (forward-line -1))
  19387. (looking-at org-complex-heading-regexp))
  19388. ;; At headline.
  19389. (let ((tags-column (when (match-beginning 5)
  19390. (save-excursion (goto-char (match-beginning 5))
  19391. (current-column))))
  19392. (string (concat " " (progn (when ARG (forward-line 1))
  19393. (org-trim (delete-and-extract-region
  19394. (line-beginning-position)
  19395. (line-end-position)))))))
  19396. (unless (bobp) (delete-region (point) (1- (point))))
  19397. (goto-char (or (match-end 4)
  19398. (match-beginning 5)
  19399. (match-end 0)))
  19400. (skip-chars-backward " \t")
  19401. (save-excursion (insert string))
  19402. ;; Adjust alignment of tags.
  19403. (when tags-column
  19404. (org-align-tags-here (if org-auto-align-tags
  19405. org-tags-column
  19406. tags-column))))
  19407. (delete-indentation ARG)))
  19408. (defun org-open-line (n)
  19409. "Insert a new row in tables, call `open-line' elsewhere.
  19410. If `org-special-ctrl-o' is nil, just call `open-line' everywhere."
  19411. (interactive "*p")
  19412. (cond
  19413. ((not org-special-ctrl-o)
  19414. (open-line n))
  19415. ((org-at-table-p)
  19416. (org-table-insert-row))
  19417. (t
  19418. (open-line n))))
  19419. (defun org-return (&optional indent)
  19420. "Goto next table row or insert a newline.
  19421. Calls `org-table-next-row' or `newline', depending on context.
  19422. When optional INDENT argument is non-nil, call
  19423. `newline-and-indent' instead of `newline'.
  19424. When `org-return-follows-link' is non-nil and point is on
  19425. a timestamp or a link, call `org-open-at-point'. However, it
  19426. will not happen if point is in a table or on a \"dead\"
  19427. object (e.g., within a comment). In these case, you need to use
  19428. `org-open-at-point' directly."
  19429. (interactive)
  19430. (if (and (not (bolp))
  19431. (save-excursion (beginning-of-line)
  19432. (looking-at org-complex-heading-regexp)))
  19433. ;; At headline.
  19434. (let ((tags-column (when (match-beginning 5)
  19435. (save-excursion (goto-char (match-beginning 5))
  19436. (current-column))))
  19437. ;; Test if before or after headline title.
  19438. (string (when (and (match-end 4)
  19439. (not (or (< (point)
  19440. (or (match-end 3)
  19441. (match-end 2)
  19442. (save-excursion
  19443. (goto-char (match-beginning 4))
  19444. (skip-chars-backward " \t")
  19445. (point))))
  19446. (and (match-beginning 5)
  19447. (>= (point) (match-beginning 5))))))
  19448. ;; Point is on headline keywords, tags or cookies. Do not break
  19449. ;; them: add a newline after the headline instead.
  19450. (org-string-nw-p
  19451. (delete-and-extract-region (point) (match-end 4))))))
  19452. ;; Adjust alignment of tags.
  19453. (when (and tags-column string)
  19454. (org-align-tags-here (if org-auto-align-tags
  19455. org-tags-column
  19456. tags-column)))
  19457. (end-of-line)
  19458. (org-show-entry)
  19459. (if indent (newline-and-indent) (newline))
  19460. (and string (save-excursion (insert (org-trim string)))))
  19461. (let* ((context (if org-return-follows-link (org-element-context)
  19462. (org-element-at-point)))
  19463. (type (org-element-type context)))
  19464. (cond
  19465. ;; In a table, call `org-table-next-row'.
  19466. ((or (and (eq type 'table)
  19467. (>= (point) (org-element-property :contents-begin context))
  19468. (< (point) (org-element-property :contents-end context)))
  19469. (org-element-lineage context '(table-row table-cell) t))
  19470. (org-table-justify-field-maybe)
  19471. (call-interactively #'org-table-next-row))
  19472. ;; On a link or a timestamp but not on white spaces after it,
  19473. ;; call `org-open-line' if `org-return-follows-link' allows it.
  19474. ((and org-return-follows-link
  19475. (memq type '(link timestamp))
  19476. (< (point)
  19477. (save-excursion (goto-char (org-element-property :end context))
  19478. (skip-chars-backward " \t")
  19479. (point))))
  19480. (call-interactively #'org-open-at-point))
  19481. ;; In a list, make sure indenting keeps trailing text within.
  19482. ((and indent
  19483. (not (eolp))
  19484. (org-element-lineage context '(item)))
  19485. (let ((trailing-data
  19486. (delete-and-extract-region (point) (line-end-position))))
  19487. (newline-and-indent)
  19488. (save-excursion (insert trailing-data))))
  19489. (t (if indent (newline-and-indent) (newline)))))))
  19490. (defun org-return-indent ()
  19491. "Goto next table row or insert a newline and indent.
  19492. Calls `org-table-next-row' or `newline-and-indent', depending on
  19493. context. See the individual commands for more information."
  19494. (interactive)
  19495. (org-return t))
  19496. (defun org-ctrl-c-star ()
  19497. "Compute table, or change heading status of lines.
  19498. Calls `org-table-recalculate' or `org-toggle-heading',
  19499. depending on context."
  19500. (interactive)
  19501. (cond
  19502. ((org-at-table-p)
  19503. (call-interactively 'org-table-recalculate))
  19504. (t
  19505. ;; Convert all lines in region to list items
  19506. (call-interactively 'org-toggle-heading))))
  19507. (defun org-ctrl-c-minus ()
  19508. "Insert separator line in table or modify bullet status of line.
  19509. Also turns a plain line or a region of lines into list items.
  19510. Calls `org-table-insert-hline', `org-toggle-item', or
  19511. `org-cycle-list-bullet', depending on context."
  19512. (interactive)
  19513. (cond
  19514. ((org-at-table-p)
  19515. (call-interactively 'org-table-insert-hline))
  19516. ((org-region-active-p)
  19517. (call-interactively 'org-toggle-item))
  19518. ((org-in-item-p)
  19519. (call-interactively 'org-cycle-list-bullet))
  19520. (t
  19521. (call-interactively 'org-toggle-item))))
  19522. (defun org-toggle-item (arg)
  19523. "Convert headings or normal lines to items, items to normal lines.
  19524. If there is no active region, only the current line is considered.
  19525. If the first non blank line in the region is a headline, convert
  19526. all headlines to items, shifting text accordingly.
  19527. If it is an item, convert all items to normal lines.
  19528. If it is normal text, change region into a list of items.
  19529. With a prefix argument ARG, change the region in a single item."
  19530. (interactive "P")
  19531. (let ((shift-text
  19532. (function
  19533. ;; Shift text in current section to IND, from point to END.
  19534. ;; The function leaves point to END line.
  19535. (lambda (ind end)
  19536. (let ((min-i 1000) (end (copy-marker end)))
  19537. ;; First determine the minimum indentation (MIN-I) of
  19538. ;; the text.
  19539. (save-excursion
  19540. (catch 'exit
  19541. (while (< (point) end)
  19542. (let ((i (org-get-indentation)))
  19543. (cond
  19544. ;; Skip blank lines and inline tasks.
  19545. ((looking-at "^[ \t]*$"))
  19546. ((looking-at org-outline-regexp-bol))
  19547. ;; We can't find less than 0 indentation.
  19548. ((zerop i) (throw 'exit (setq min-i 0)))
  19549. ((< i min-i) (setq min-i i))))
  19550. (forward-line))))
  19551. ;; Then indent each line so that a line indented to
  19552. ;; MIN-I becomes indented to IND. Ignore blank lines
  19553. ;; and inline tasks in the process.
  19554. (let ((delta (- ind min-i)))
  19555. (while (< (point) end)
  19556. (unless (or (looking-at "^[ \t]*$")
  19557. (looking-at org-outline-regexp-bol))
  19558. (org-indent-line-to (+ (org-get-indentation) delta)))
  19559. (forward-line)))))))
  19560. (skip-blanks
  19561. (function
  19562. ;; Return beginning of first non-blank line, starting from
  19563. ;; line at POS.
  19564. (lambda (pos)
  19565. (save-excursion
  19566. (goto-char pos)
  19567. (skip-chars-forward " \r\t\n")
  19568. (point-at-bol)))))
  19569. beg end)
  19570. ;; Determine boundaries of changes.
  19571. (if (org-region-active-p)
  19572. (setq beg (funcall skip-blanks (region-beginning))
  19573. end (copy-marker (region-end)))
  19574. (setq beg (funcall skip-blanks (point-at-bol))
  19575. end (copy-marker (point-at-eol))))
  19576. ;; Depending on the starting line, choose an action on the text
  19577. ;; between BEG and END.
  19578. (org-with-limited-levels
  19579. (save-excursion
  19580. (goto-char beg)
  19581. (cond
  19582. ;; Case 1. Start at an item: de-itemize. Note that it only
  19583. ;; happens when a region is active: `org-ctrl-c-minus'
  19584. ;; would call `org-cycle-list-bullet' otherwise.
  19585. ((org-at-item-p)
  19586. (while (< (point) end)
  19587. (when (org-at-item-p)
  19588. (skip-chars-forward " \t")
  19589. (delete-region (point) (match-end 0)))
  19590. (forward-line)))
  19591. ;; Case 2. Start at an heading: convert to items.
  19592. ((org-at-heading-p)
  19593. (let* ((bul (org-list-bullet-string "-"))
  19594. (bul-len (length bul))
  19595. (done (org-entry-is-done-p))
  19596. (todo (org-entry-is-todo-p))
  19597. ;; Indentation of the first heading. It should be
  19598. ;; relative to the indentation of its parent, if any.
  19599. (start-ind (save-excursion
  19600. (cond
  19601. ((not org-adapt-indentation) 0)
  19602. ((not (outline-previous-heading)) 0)
  19603. (t (length (match-string 0))))))
  19604. ;; Level of first heading. Further headings will be
  19605. ;; compared to it to determine hierarchy in the list.
  19606. (ref-level (org-reduced-level (org-outline-level))))
  19607. (when (or done todo) (org-todo ""))
  19608. (while (< (point) end)
  19609. (let* ((level (org-reduced-level (org-outline-level)))
  19610. (delta (max 0 (- level ref-level))))
  19611. ;; If current headline is less indented than the first
  19612. ;; one, set it as reference, in order to preserve
  19613. ;; subtrees.
  19614. (when (< level ref-level) (setq ref-level level))
  19615. (replace-match bul t t)
  19616. (org-indent-line-to (+ start-ind (* delta bul-len)))
  19617. (when (or done todo)
  19618. (let* ((struct (org-list-struct))
  19619. (old (copy-tree struct)))
  19620. (org-list-set-checkbox (line-beginning-position)
  19621. struct
  19622. (if done "[X]" "[ ]"))
  19623. (org-list-write-struct struct
  19624. (org-list-parents-alist struct)
  19625. old)))
  19626. ;; Ensure all text down to END (or SECTION-END) belongs
  19627. ;; to the newly created item.
  19628. (let ((section-end (save-excursion
  19629. (or (outline-next-heading) (point)))))
  19630. (forward-line)
  19631. (funcall shift-text
  19632. (+ start-ind (* (1+ delta) bul-len))
  19633. (min end section-end)))))))
  19634. ;; Case 3. Normal line with ARG: make the first line of region
  19635. ;; an item, and shift indentation of others lines to
  19636. ;; set them as item's body.
  19637. (arg (let* ((bul (org-list-bullet-string "-"))
  19638. (bul-len (length bul))
  19639. (ref-ind (org-get-indentation)))
  19640. (skip-chars-forward " \t")
  19641. (insert bul)
  19642. (forward-line)
  19643. (while (< (point) end)
  19644. ;; Ensure that lines less indented than first one
  19645. ;; still get included in item body.
  19646. (funcall shift-text
  19647. (+ ref-ind bul-len)
  19648. (min end (save-excursion (or (outline-next-heading)
  19649. (point)))))
  19650. (forward-line))))
  19651. ;; Case 4. Normal line without ARG: turn each non-item line
  19652. ;; into an item.
  19653. (t
  19654. (while (< (point) end)
  19655. (unless (or (org-at-heading-p) (org-at-item-p))
  19656. (if (looking-at "\\([ \t]*\\)\\(\\S-\\)")
  19657. (replace-match
  19658. (concat "\\1" (org-list-bullet-string "-") "\\2"))))
  19659. (forward-line))))))))
  19660. (defun org-toggle-heading (&optional nstars)
  19661. "Convert headings to normal text, or items or text to headings.
  19662. If there is no active region, only convert the current line.
  19663. With a \\[universal-argument] prefix, convert the whole list at
  19664. point into heading.
  19665. In a region:
  19666. - If the first non blank line is a headline, remove the stars
  19667. from all headlines in the region.
  19668. - If it is a normal line, turn each and every normal line (i.e.,
  19669. not an heading or an item) in the region into headings. If you
  19670. want to convert only the first line of this region, use one
  19671. universal prefix argument.
  19672. - If it is a plain list item, turn all plain list items into headings.
  19673. When converting a line into a heading, the number of stars is chosen
  19674. such that the lines become children of the current entry. However,
  19675. when a numeric prefix argument is given, its value determines the
  19676. number of stars to add."
  19677. (interactive "P")
  19678. (let ((skip-blanks
  19679. (function
  19680. ;; Return beginning of first non-blank line, starting from
  19681. ;; line at POS.
  19682. (lambda (pos)
  19683. (save-excursion
  19684. (goto-char pos)
  19685. (while (org-at-comment-p) (forward-line))
  19686. (skip-chars-forward " \r\t\n")
  19687. (point-at-bol)))))
  19688. beg end toggled)
  19689. ;; Determine boundaries of changes. If a universal prefix has
  19690. ;; been given, put the list in a region. If region ends at a bol,
  19691. ;; do not consider the last line to be in the region.
  19692. (when (and current-prefix-arg (org-at-item-p))
  19693. (if (listp current-prefix-arg) (setq current-prefix-arg 1))
  19694. (org-mark-element))
  19695. (if (org-region-active-p)
  19696. (setq beg (funcall skip-blanks (region-beginning))
  19697. end (copy-marker (save-excursion
  19698. (goto-char (region-end))
  19699. (if (bolp) (point) (point-at-eol)))))
  19700. (setq beg (funcall skip-blanks (point-at-bol))
  19701. end (copy-marker (point-at-eol))))
  19702. ;; Ensure inline tasks don't count as headings.
  19703. (org-with-limited-levels
  19704. (save-excursion
  19705. (goto-char beg)
  19706. (cond
  19707. ;; Case 1. Started at an heading: de-star headings.
  19708. ((org-at-heading-p)
  19709. (while (< (point) end)
  19710. (when (org-at-heading-p t)
  19711. (looking-at org-outline-regexp) (replace-match "")
  19712. (setq toggled t))
  19713. (forward-line)))
  19714. ;; Case 2. Started at an item: change items into headlines.
  19715. ;; One star will be added by `org-list-to-subtree'.
  19716. ((org-at-item-p)
  19717. (while (< (point) end)
  19718. (when (org-at-item-p)
  19719. ;; Pay attention to cases when region ends before list.
  19720. (let* ((struct (org-list-struct))
  19721. (list-end (min (org-list-get-bottom-point struct) (1+ end))))
  19722. (save-restriction
  19723. (narrow-to-region (point) list-end)
  19724. (insert (org-list-to-subtree (org-list-parse-list t)))))
  19725. (setq toggled t))
  19726. (forward-line)))
  19727. ;; Case 3. Started at normal text: make every line an heading,
  19728. ;; skipping headlines and items.
  19729. (t (let* ((stars
  19730. (make-string
  19731. (if (numberp nstars) nstars (or (org-current-level) 0)) ?*))
  19732. (add-stars
  19733. (cond (nstars "") ; stars from prefix only
  19734. ((equal stars "") "*") ; before first heading
  19735. (org-odd-levels-only "**") ; inside heading, odd
  19736. (t "*"))) ; inside heading, oddeven
  19737. (rpl (concat stars add-stars " "))
  19738. (lend (if (listp nstars) (save-excursion (end-of-line) (point)))))
  19739. (while (< (point) (if (equal nstars '(4)) lend end))
  19740. (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
  19741. (looking-at "\\([ \t]*\\)\\(\\S-\\)"))
  19742. (replace-match (concat rpl (match-string 2))) (setq toggled t))
  19743. (forward-line)))))))
  19744. (unless toggled (message "Cannot toggle heading from here"))))
  19745. (defun org-meta-return (&optional arg)
  19746. "Insert a new heading or wrap a region in a table.
  19747. Calls `org-insert-heading' or `org-table-wrap-region', depending
  19748. on context. See the individual commands for more information."
  19749. (interactive "P")
  19750. (org-check-before-invisible-edit 'insert)
  19751. (or (run-hook-with-args-until-success 'org-metareturn-hook)
  19752. (let* ((element (org-element-at-point))
  19753. (type (org-element-type element)))
  19754. (when (eq type 'table-row)
  19755. (setq element (org-element-property :parent element))
  19756. (setq type 'table))
  19757. (if (and (eq type 'table)
  19758. (eq (org-element-property :type element) 'org)
  19759. (>= (point) (org-element-property :contents-begin element))
  19760. (< (point) (org-element-property :contents-end element)))
  19761. (call-interactively 'org-table-wrap-region)
  19762. (call-interactively 'org-insert-heading)))))
  19763. ;;; Menu entries
  19764. (defsubst org-in-subtree-not-table-p ()
  19765. "Are we in a subtree and not in a table?"
  19766. (and (not (org-before-first-heading-p))
  19767. (not (org-at-table-p))))
  19768. ;; Define the Org-mode menus
  19769. (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
  19770. '("Tbl"
  19771. ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
  19772. ["Next Field" org-cycle (org-at-table-p)]
  19773. ["Previous Field" org-shifttab (org-at-table-p)]
  19774. ["Next Row" org-return (org-at-table-p)]
  19775. "--"
  19776. ["Blank Field" org-table-blank-field (org-at-table-p)]
  19777. ["Edit Field" org-table-edit-field (org-at-table-p)]
  19778. ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
  19779. "--"
  19780. ("Column"
  19781. ["Move Column Left" org-metaleft (org-at-table-p)]
  19782. ["Move Column Right" org-metaright (org-at-table-p)]
  19783. ["Delete Column" org-shiftmetaleft (org-at-table-p)]
  19784. ["Insert Column" org-shiftmetaright (org-at-table-p)])
  19785. ("Row"
  19786. ["Move Row Up" org-metaup (org-at-table-p)]
  19787. ["Move Row Down" org-metadown (org-at-table-p)]
  19788. ["Delete Row" org-shiftmetaup (org-at-table-p)]
  19789. ["Insert Row" org-shiftmetadown (org-at-table-p)]
  19790. ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
  19791. "--"
  19792. ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
  19793. ("Rectangle"
  19794. ["Copy Rectangle" org-copy-special (org-at-table-p)]
  19795. ["Cut Rectangle" org-cut-special (org-at-table-p)]
  19796. ["Paste Rectangle" org-paste-special (org-at-table-p)]
  19797. ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
  19798. "--"
  19799. ("Calculate"
  19800. ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
  19801. ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
  19802. ["Edit Formulas" org-edit-special (org-at-table-p)]
  19803. "--"
  19804. ["Recalculate line" org-table-recalculate (org-at-table-p)]
  19805. ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
  19806. ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
  19807. "--"
  19808. ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
  19809. "--"
  19810. ["Sum Column/Rectangle" org-table-sum
  19811. (or (org-at-table-p) (org-region-active-p))]
  19812. ["Which Column?" org-table-current-column (org-at-table-p)])
  19813. ["Debug Formulas"
  19814. org-table-toggle-formula-debugger
  19815. :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
  19816. ["Show Col/Row Numbers"
  19817. org-table-toggle-coordinate-overlays
  19818. :style toggle
  19819. :selected (org-bound-and-true-p org-table-overlay-coordinates)]
  19820. "--"
  19821. ["Create" org-table-create (and (not (org-at-table-p))
  19822. org-enable-table-editor)]
  19823. ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
  19824. ["Import from File" org-table-import (not (org-at-table-p))]
  19825. ["Export to File" org-table-export (org-at-table-p)]
  19826. "--"
  19827. ["Create/Convert from/to table.el" org-table-create-with-table.el t]
  19828. "--"
  19829. ("Plot"
  19830. ["Ascii plot" orgtbl-ascii-plot :active (org-at-table-p) :keys "C-c \" a"]
  19831. ["Gnuplot" org-plot/gnuplot :active (org-at-table-p) :keys "C-c \" g"])))
  19832. (easy-menu-define org-org-menu org-mode-map "Org menu"
  19833. '("Org"
  19834. ("Show/Hide"
  19835. ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
  19836. ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
  19837. ["Sparse Tree..." org-sparse-tree t]
  19838. ["Reveal Context" org-reveal t]
  19839. ["Show All" show-all t]
  19840. "--"
  19841. ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
  19842. "--"
  19843. ["New Heading" org-insert-heading t]
  19844. ("Navigate Headings"
  19845. ["Up" outline-up-heading t]
  19846. ["Next" outline-next-visible-heading t]
  19847. ["Previous" outline-previous-visible-heading t]
  19848. ["Next Same Level" outline-forward-same-level t]
  19849. ["Previous Same Level" outline-backward-same-level t]
  19850. "--"
  19851. ["Jump" org-goto t])
  19852. ("Edit Structure"
  19853. ["Refile Subtree" org-refile (org-in-subtree-not-table-p)]
  19854. "--"
  19855. ["Move Subtree Up" org-metaup (org-at-heading-p)]
  19856. ["Move Subtree Down" org-metadown (org-at-heading-p)]
  19857. "--"
  19858. ["Copy Subtree" org-copy-special (org-in-subtree-not-table-p)]
  19859. ["Cut Subtree" org-cut-special (org-in-subtree-not-table-p)]
  19860. ["Paste Subtree" org-paste-special (not (org-at-table-p))]
  19861. "--"
  19862. ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
  19863. "--"
  19864. ["Copy visible text" org-copy-visible t]
  19865. "--"
  19866. ["Promote Heading" org-metaleft (org-in-subtree-not-table-p)]
  19867. ["Promote Subtree" org-shiftmetaleft (org-in-subtree-not-table-p)]
  19868. ["Demote Heading" org-metaright (org-in-subtree-not-table-p)]
  19869. ["Demote Subtree" org-shiftmetaright (org-in-subtree-not-table-p)]
  19870. "--"
  19871. ["Sort Region/Children" org-sort t]
  19872. "--"
  19873. ["Convert to odd levels" org-convert-to-odd-levels t]
  19874. ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
  19875. ("Editing"
  19876. ["Emphasis..." org-emphasize t]
  19877. ["Edit Source Example" org-edit-special t]
  19878. "--"
  19879. ["Footnote new/jump" org-footnote-action t]
  19880. ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
  19881. ("Archive"
  19882. ["Archive (default method)" org-archive-subtree-default (org-in-subtree-not-table-p)]
  19883. "--"
  19884. ["Move Subtree to Archive file" org-advertized-archive-subtree (org-in-subtree-not-table-p)]
  19885. ["Toggle ARCHIVE tag" org-toggle-archive-tag (org-in-subtree-not-table-p)]
  19886. ["Move subtree to Archive sibling" org-archive-to-archive-sibling (org-in-subtree-not-table-p)]
  19887. )
  19888. "--"
  19889. ("Hyperlinks"
  19890. ["Store Link (Global)" org-store-link t]
  19891. ["Find existing link to here" org-occur-link-in-agenda-files t]
  19892. ["Insert Link" org-insert-link t]
  19893. ["Follow Link" org-open-at-point t]
  19894. "--"
  19895. ["Next link" org-next-link t]
  19896. ["Previous link" org-previous-link t]
  19897. "--"
  19898. ["Descriptive Links"
  19899. org-toggle-link-display
  19900. :style radio
  19901. :selected org-descriptive-links
  19902. ]
  19903. ["Literal Links"
  19904. org-toggle-link-display
  19905. :style radio
  19906. :selected (not org-descriptive-links)])
  19907. "--"
  19908. ("TODO Lists"
  19909. ["TODO/DONE/-" org-todo t]
  19910. ("Select keyword"
  19911. ["Next keyword" org-shiftright (org-at-heading-p)]
  19912. ["Previous keyword" org-shiftleft (org-at-heading-p)]
  19913. ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
  19914. ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
  19915. ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
  19916. ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
  19917. ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
  19918. "--"
  19919. ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
  19920. :selected org-enforce-todo-dependencies :style toggle :active t]
  19921. "Settings for tree at point"
  19922. ["Do Children sequentially" org-toggle-ordered-property :style radio
  19923. :selected (org-entry-get nil "ORDERED")
  19924. :active org-enforce-todo-dependencies :keys "C-c C-x o"]
  19925. ["Do Children parallel" org-toggle-ordered-property :style radio
  19926. :selected (not (org-entry-get nil "ORDERED"))
  19927. :active org-enforce-todo-dependencies :keys "C-c C-x o"]
  19928. "--"
  19929. ["Set Priority" org-priority t]
  19930. ["Priority Up" org-shiftup t]
  19931. ["Priority Down" org-shiftdown t]
  19932. "--"
  19933. ["Get news from all feeds" org-feed-update-all t]
  19934. ["Go to the inbox of a feed..." org-feed-goto-inbox t]
  19935. ["Customize feeds" (customize-variable 'org-feed-alist) t])
  19936. ("TAGS and Properties"
  19937. ["Set Tags" org-set-tags-command (not (org-before-first-heading-p))]
  19938. ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
  19939. "--"
  19940. ["Set property" org-set-property (not (org-before-first-heading-p))]
  19941. ["Column view of properties" org-columns t]
  19942. ["Insert Column View DBlock" org-insert-columns-dblock t])
  19943. ("Dates and Scheduling"
  19944. ["Timestamp" org-time-stamp (not (org-before-first-heading-p))]
  19945. ["Timestamp (inactive)" org-time-stamp-inactive (not (org-before-first-heading-p))]
  19946. ("Change Date"
  19947. ["1 Day Later" org-shiftright (org-at-timestamp-p)]
  19948. ["1 Day Earlier" org-shiftleft (org-at-timestamp-p)]
  19949. ["1 ... Later" org-shiftup (org-at-timestamp-p)]
  19950. ["1 ... Earlier" org-shiftdown (org-at-timestamp-p)])
  19951. ["Compute Time Range" org-evaluate-time-range t]
  19952. ["Schedule Item" org-schedule (not (org-before-first-heading-p))]
  19953. ["Deadline" org-deadline (not (org-before-first-heading-p))]
  19954. "--"
  19955. ["Custom time format" org-toggle-time-stamp-overlays
  19956. :style radio :selected org-display-custom-times]
  19957. "--"
  19958. ["Goto Calendar" org-goto-calendar t]
  19959. ["Date from Calendar" org-date-from-calendar t]
  19960. "--"
  19961. ["Start/Restart Timer" org-timer-start t]
  19962. ["Pause/Continue Timer" org-timer-pause-or-continue t]
  19963. ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
  19964. ["Insert Timer String" org-timer t]
  19965. ["Insert Timer Item" org-timer-item t])
  19966. ("Logging work"
  19967. ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
  19968. ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
  19969. ["Clock out" org-clock-out t]
  19970. ["Clock cancel" org-clock-cancel t]
  19971. "--"
  19972. ["Mark as default task" org-clock-mark-default-task t]
  19973. ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
  19974. ["Goto running clock" org-clock-goto t]
  19975. "--"
  19976. ["Display times" org-clock-display t]
  19977. ["Create clock table" org-clock-report t]
  19978. "--"
  19979. ["Record DONE time"
  19980. (progn (setq org-log-done (not org-log-done))
  19981. (message "Switching to %s will %s record a timestamp"
  19982. (car org-done-keywords)
  19983. (if org-log-done "automatically" "not")))
  19984. :style toggle :selected org-log-done])
  19985. "--"
  19986. ["Agenda Command..." org-agenda t]
  19987. ["Set Restriction Lock" org-agenda-set-restriction-lock t]
  19988. ("File List for Agenda")
  19989. ("Special views current file"
  19990. ["TODO Tree" org-show-todo-tree t]
  19991. ["Check Deadlines" org-check-deadlines t]
  19992. ["Timeline" org-timeline t]
  19993. ["Tags/Property tree" org-match-sparse-tree t])
  19994. "--"
  19995. ["Export/Publish..." org-export-dispatch t]
  19996. ("LaTeX"
  19997. ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
  19998. :selected org-cdlatex-mode]
  19999. ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
  20000. ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
  20001. ["Modify math symbol" org-cdlatex-math-modify
  20002. (org-inside-LaTeX-fragment-p)]
  20003. ["Insert citation" org-reftex-citation t]
  20004. "--"
  20005. ["Template for BEAMER" (org-beamer-insert-options-template) t])
  20006. "--"
  20007. ("MobileOrg"
  20008. ["Push Files and Views" org-mobile-push t]
  20009. ["Get Captured and Flagged" org-mobile-pull t]
  20010. ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
  20011. "--"
  20012. ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
  20013. "--"
  20014. ("Documentation"
  20015. ["Show Version" org-version t]
  20016. ["Info Documentation" org-info t])
  20017. ("Customize"
  20018. ["Browse Org Group" org-customize t]
  20019. "--"
  20020. ["Expand This Menu" org-create-customize-menu
  20021. (fboundp 'customize-menu-create)])
  20022. ["Send bug report" org-submit-bug-report t]
  20023. "--"
  20024. ("Refresh/Reload"
  20025. ["Refresh setup current buffer" org-mode-restart t]
  20026. ["Reload Org (after update)" org-reload t]
  20027. ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x !"])
  20028. ))
  20029. (defun org-info (&optional node)
  20030. "Read documentation for Org-mode in the info system.
  20031. With optional NODE, go directly to that node."
  20032. (interactive)
  20033. (info (format "(org)%s" (or node ""))))
  20034. ;;;###autoload
  20035. (defun org-submit-bug-report ()
  20036. "Submit a bug report on Org-mode via mail.
  20037. Don't hesitate to report any problems or inaccurate documentation.
  20038. If you don't have setup sending mail from (X)Emacs, please copy the
  20039. output buffer into your mail program, as it gives us important
  20040. information about your Org-mode version and configuration."
  20041. (interactive)
  20042. (require 'reporter)
  20043. (org-load-modules-maybe)
  20044. (org-require-autoloaded-modules)
  20045. (let ((reporter-prompt-for-summary-p "Bug report subject: "))
  20046. (reporter-submit-bug-report
  20047. "emacs-orgmode@gnu.org"
  20048. (org-version nil 'full)
  20049. (let (list)
  20050. (save-window-excursion
  20051. (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
  20052. (delete-other-windows)
  20053. (erase-buffer)
  20054. (insert "You are about to submit a bug report to the Org-mode mailing list.
  20055. We would like to add your full Org-mode and Outline configuration to the
  20056. bug report. This greatly simplifies the work of the maintainer and
  20057. other experts on the mailing list.
  20058. HOWEVER, some variables you have customized may contain private
  20059. information. The names of customers, colleagues, or friends, might
  20060. appear in the form of file names, tags, todo states, or search strings.
  20061. If you answer yes to the prompt, you might want to check and remove
  20062. such private information before sending the email.")
  20063. (add-text-properties (point-min) (point-max) '(face org-warning))
  20064. (when (yes-or-no-p "Include your Org-mode configuration ")
  20065. (mapatoms
  20066. (lambda (v)
  20067. (and (boundp v)
  20068. (string-match "\\`\\(org-\\|outline-\\)" (symbol-name v))
  20069. (or (and (symbol-value v)
  20070. (string-match "\\(-hook\\|-function\\)\\'" (symbol-name v)))
  20071. (and
  20072. (get v 'custom-type) (get v 'standard-value)
  20073. (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
  20074. (push v list)))))
  20075. (kill-buffer (get-buffer "*Warn about privacy*"))
  20076. list))
  20077. nil nil
  20078. "Remember to cover the basics, that is, what you expected to happen and
  20079. what in fact did happen. You don't know how to make a good report? See
  20080. http://orgmode.org/manual/Feedback.html#Feedback
  20081. Your bug report will be posted to the Org-mode mailing list.
  20082. ------------------------------------------------------------------------")
  20083. (save-excursion
  20084. (if (re-search-backward "^\\(Subject: \\)Org-mode version \\(.*?\\);[ \t]*\\(.*\\)" nil t)
  20085. (replace-match "\\1Bug: \\3 [\\2]")))))
  20086. (defun org-install-agenda-files-menu ()
  20087. (let ((bl (buffer-list)))
  20088. (save-excursion
  20089. (while bl
  20090. (set-buffer (pop bl))
  20091. (if (derived-mode-p 'org-mode) (setq bl nil)))
  20092. (when (derived-mode-p 'org-mode)
  20093. (easy-menu-change
  20094. '("Org") "File List for Agenda"
  20095. (append
  20096. (list
  20097. ["Edit File List" (org-edit-agenda-file-list) t]
  20098. ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
  20099. ["Remove Current File from List" org-remove-file t]
  20100. ["Cycle through agenda files" org-cycle-agenda-files t]
  20101. ["Occur in all agenda files" org-occur-in-agenda-files t]
  20102. "--")
  20103. (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
  20104. ;;;; Documentation
  20105. (defun org-require-autoloaded-modules ()
  20106. (interactive)
  20107. (mapc 'require
  20108. '(org-agenda org-archive org-attach org-clock org-colview org-id
  20109. org-table org-timer)))
  20110. ;;;###autoload
  20111. (defun org-reload (&optional uncompiled)
  20112. "Reload all org lisp files.
  20113. With prefix arg UNCOMPILED, load the uncompiled versions."
  20114. (interactive "P")
  20115. (require 'loadhist)
  20116. (let* ((org-dir (org-find-library-dir "org"))
  20117. (contrib-dir (or (org-find-library-dir "org-contribdir") org-dir))
  20118. (feature-re "^\\(org\\|ob\\|ox\\)\\(-.*\\)?")
  20119. (remove-re (mapconcat 'identity
  20120. (mapcar (lambda (f) (concat "^" f "$"))
  20121. (list (if (featurep 'xemacs)
  20122. "org-colview"
  20123. "org-colview-xemacs")
  20124. "org" "org-loaddefs" "org-version"))
  20125. "\\|"))
  20126. (feats (delete-dups
  20127. (mapcar 'file-name-sans-extension
  20128. (mapcar 'file-name-nondirectory
  20129. (delq nil
  20130. (mapcar 'feature-file
  20131. features))))))
  20132. (lfeat (append
  20133. (sort
  20134. (setq feats
  20135. (delq nil (mapcar
  20136. (lambda (f)
  20137. (if (and (string-match feature-re f)
  20138. (not (string-match remove-re f)))
  20139. f nil))
  20140. feats)))
  20141. 'string-lessp)
  20142. (list "org-version" "org")))
  20143. (load-suffixes (when (boundp 'load-suffixes) load-suffixes))
  20144. (load-suffixes (if uncompiled (reverse load-suffixes) load-suffixes))
  20145. load-uncore load-misses)
  20146. (setq load-misses
  20147. (delq 't
  20148. (mapcar (lambda (f)
  20149. (or (org-load-noerror-mustsuffix (concat org-dir f))
  20150. (and (string= org-dir contrib-dir)
  20151. (org-load-noerror-mustsuffix (concat contrib-dir f)))
  20152. (and (org-load-noerror-mustsuffix (concat (org-find-library-dir f) f))
  20153. (add-to-list 'load-uncore f 'append)
  20154. 't)
  20155. f))
  20156. lfeat)))
  20157. (if load-uncore
  20158. (message "The following feature%s found in load-path, please check if that's correct:\n%s"
  20159. (if (> (length load-uncore) 1) "s were" " was") load-uncore))
  20160. (if load-misses
  20161. (message "Some error occurred while reloading Org feature%s\n%s\nPlease check *Messages*!\n%s"
  20162. (if (> (length load-misses) 1) "s" "") load-misses (org-version nil 'full))
  20163. (message "Successfully reloaded Org\n%s" (org-version nil 'full)))))
  20164. ;;;###autoload
  20165. (defun org-customize ()
  20166. "Call the customize function with org as argument."
  20167. (interactive)
  20168. (org-load-modules-maybe)
  20169. (org-require-autoloaded-modules)
  20170. (customize-browse 'org))
  20171. (defun org-create-customize-menu ()
  20172. "Create a full customization menu for Org-mode, insert it into the menu."
  20173. (interactive)
  20174. (org-load-modules-maybe)
  20175. (org-require-autoloaded-modules)
  20176. (if (fboundp 'customize-menu-create)
  20177. (progn
  20178. (easy-menu-change
  20179. '("Org") "Customize"
  20180. `(["Browse Org group" org-customize t]
  20181. "--"
  20182. ,(customize-menu-create 'org)
  20183. ["Set" Custom-set t]
  20184. ["Save" Custom-save t]
  20185. ["Reset to Current" Custom-reset-current t]
  20186. ["Reset to Saved" Custom-reset-saved t]
  20187. ["Reset to Standard Settings" Custom-reset-standard t]))
  20188. (message "\"Org\"-menu now contains full customization menu"))
  20189. (error "Cannot expand menu (outdated version of cus-edit.el)")))
  20190. ;;;; Miscellaneous stuff
  20191. ;;; Generally useful functions
  20192. (defsubst org-get-at-eol (property n)
  20193. "Get text property PROPERTY at the end of line less N characters."
  20194. (get-text-property (- (point-at-eol) n) property))
  20195. (defun org-find-text-property-in-string (prop s)
  20196. "Return the first non-nil value of property PROP in string S."
  20197. (or (get-text-property 0 prop s)
  20198. (get-text-property (or (next-single-property-change 0 prop s) 0)
  20199. prop s)))
  20200. (defun org-display-warning (message) ;; Copied from Emacs-Muse
  20201. "Display the given MESSAGE as a warning."
  20202. (if (fboundp 'display-warning)
  20203. (display-warning 'org message
  20204. (if (featurep 'xemacs) 'warning :warning))
  20205. (let ((buf (get-buffer-create "*Org warnings*")))
  20206. (with-current-buffer buf
  20207. (goto-char (point-max))
  20208. (insert "Warning (Org): " message)
  20209. (unless (bolp)
  20210. (newline)))
  20211. (display-buffer buf)
  20212. (sit-for 0))))
  20213. (defun org-eval (form)
  20214. "Eval FORM and return result."
  20215. (condition-case error
  20216. (eval form)
  20217. (error (format "%%![Error: %s]" error))))
  20218. (defun org-in-clocktable-p ()
  20219. "Check if the cursor is in a clocktable."
  20220. (let ((pos (point)) start)
  20221. (save-excursion
  20222. (end-of-line 1)
  20223. (and (re-search-backward "^[ \t]*#\\+BEGIN:[ \t]+clocktable" nil t)
  20224. (setq start (match-beginning 0))
  20225. (re-search-forward "^[ \t]*#\\+END:.*" nil t)
  20226. (>= (match-end 0) pos)
  20227. start))))
  20228. (defun org-in-verbatim-emphasis ()
  20229. (save-match-data
  20230. (and (org-in-regexp org-emph-re 2)
  20231. (>= (point) (match-beginning 3))
  20232. (<= (point) (match-end 4))
  20233. (member (match-string 3) '("=" "~")))))
  20234. (defun org-goto-marker-or-bmk (marker &optional bookmark)
  20235. "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
  20236. (if (and marker (marker-buffer marker)
  20237. (buffer-live-p (marker-buffer marker)))
  20238. (progn
  20239. (org-pop-to-buffer-same-window (marker-buffer marker))
  20240. (if (or (> marker (point-max)) (< marker (point-min)))
  20241. (widen))
  20242. (goto-char marker)
  20243. (org-show-context 'org-goto))
  20244. (if bookmark
  20245. (bookmark-jump bookmark)
  20246. (error "Cannot find location"))))
  20247. (defun org-quote-csv-field (s)
  20248. "Quote field for inclusion in CSV material."
  20249. (if (string-match "[\",]" s)
  20250. (concat "\"" (mapconcat 'identity (split-string s "\"") "\"\"") "\"")
  20251. s))
  20252. (defun org-force-self-insert (N)
  20253. "Needed to enforce self-insert under remapping."
  20254. (interactive "p")
  20255. (self-insert-command N))
  20256. (defun org-string-width (s)
  20257. "Compute width of string, ignoring invisible characters.
  20258. This ignores character with invisibility property `org-link', and also
  20259. characters with property `org-cwidth', because these will become invisible
  20260. upon the next fontification round."
  20261. (let (b l)
  20262. (when (or (eq t buffer-invisibility-spec)
  20263. (assq 'org-link buffer-invisibility-spec))
  20264. (while (setq b (text-property-any 0 (length s)
  20265. 'invisible 'org-link s))
  20266. (setq s (concat (substring s 0 b)
  20267. (substring s (or (next-single-property-change
  20268. b 'invisible s) (length s)))))))
  20269. (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
  20270. (setq s (concat (substring s 0 b)
  20271. (substring s (or (next-single-property-change
  20272. b 'org-cwidth s) (length s))))))
  20273. (setq l (string-width s) b -1)
  20274. (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
  20275. (setq l (- l (get-text-property b 'org-dwidth-n s))))
  20276. l))
  20277. (defun org-shorten-string (s maxlength)
  20278. "Shorten string S so tht it is no longer than MAXLENGTH characters.
  20279. If the string is shorter or has length MAXLENGTH, just return the
  20280. original string. If it is longer, the functions finds a space in the
  20281. string, breaks this string off at that locations and adds three dots
  20282. as ellipsis. Including the ellipsis, the string will not be longer
  20283. than MAXLENGTH. If finding a good breaking point in the string does
  20284. not work, the string is just chopped off in the middle of a word
  20285. if necessary."
  20286. (if (<= (length s) maxlength)
  20287. s
  20288. (let* ((n (max (- maxlength 4) 1))
  20289. (re (concat "\\`\\(.\\{1," (int-to-string n) "\\}[^ ]\\)\\([ ]\\|\\'\\)")))
  20290. (if (string-match re s)
  20291. (concat (match-string 1 s) "...")
  20292. (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
  20293. (defun org-get-indentation (&optional line)
  20294. "Get the indentation of the current line, interpreting tabs.
  20295. When LINE is given, assume it represents a line and compute its indentation."
  20296. (if line
  20297. (if (string-match "^ *" (org-remove-tabs line))
  20298. (match-end 0))
  20299. (save-excursion
  20300. (beginning-of-line 1)
  20301. (skip-chars-forward " \t")
  20302. (current-column))))
  20303. (defun org-get-string-indentation (s)
  20304. "What indentation has S due to SPACE and TAB at the beginning of the string?"
  20305. (let ((n -1) (i 0) (w tab-width) c)
  20306. (catch 'exit
  20307. (while (< (setq n (1+ n)) (length s))
  20308. (setq c (aref s n))
  20309. (cond ((= c ?\ ) (setq i (1+ i)))
  20310. ((= c ?\t) (setq i (* (/ (+ w i) w) w)))
  20311. (t (throw 'exit t)))))
  20312. i))
  20313. (defun org-remove-tabs (s &optional width)
  20314. "Replace tabulators in S with spaces.
  20315. Assumes that s is a single line, starting in column 0."
  20316. (setq width (or width tab-width))
  20317. (while (string-match "\t" s)
  20318. (setq s (replace-match
  20319. (make-string
  20320. (- (* width (/ (+ (match-beginning 0) width) width))
  20321. (match-beginning 0)) ?\ )
  20322. t t s)))
  20323. s)
  20324. (defun org-fix-indentation (line ind)
  20325. "Fix indentation in LINE.
  20326. IND is a cons cell with target and minimum indentation.
  20327. If the current indentation in LINE is smaller than the minimum,
  20328. leave it alone. If it is larger than ind, set it to the target."
  20329. (let* ((l (org-remove-tabs line))
  20330. (i (org-get-indentation l))
  20331. (i1 (car ind)) (i2 (cdr ind)))
  20332. (if (>= i i2) (setq l (substring line i2)))
  20333. (if (> i1 0)
  20334. (concat (make-string i1 ?\ ) l)
  20335. l)))
  20336. (defun org-remove-indentation (code &optional n)
  20337. "Remove the maximum common indentation from the lines in CODE.
  20338. N may optionally be the number of spaces to remove."
  20339. (with-temp-buffer
  20340. (insert code)
  20341. (org-do-remove-indentation n)
  20342. (buffer-string)))
  20343. (defun org-do-remove-indentation (&optional n)
  20344. "Remove the maximum common indentation from the buffer."
  20345. (untabify (point-min) (point-max))
  20346. (let ((min 10000) re)
  20347. (if n
  20348. (setq min n)
  20349. (goto-char (point-min))
  20350. (while (re-search-forward "^ *[^ \n]" nil t)
  20351. (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
  20352. (unless (or (= min 0) (= min 10000))
  20353. (setq re (format "^ \\{%d\\}" min))
  20354. (goto-char (point-min))
  20355. (while (re-search-forward re nil t)
  20356. (replace-match "")
  20357. (end-of-line 1))
  20358. min)))
  20359. (defun org-fill-template (template alist)
  20360. "Find each %key of ALIST in TEMPLATE and replace it."
  20361. (let ((case-fold-search nil)
  20362. entry key value)
  20363. (setq alist (sort (copy-sequence alist)
  20364. (lambda (a b) (< (length (car a)) (length (car b))))))
  20365. (while (setq entry (pop alist))
  20366. (setq template
  20367. (replace-regexp-in-string
  20368. (concat "%" (regexp-quote (car entry)))
  20369. (or (cdr entry) "") template t t)))
  20370. template))
  20371. (defun org-base-buffer (buffer)
  20372. "Return the base buffer of BUFFER, if it has one. Else return the buffer."
  20373. (if (not buffer)
  20374. buffer
  20375. (or (buffer-base-buffer buffer)
  20376. buffer)))
  20377. (defun org-wrap (string &optional width lines)
  20378. "Wrap string to either a number of lines, or a width in characters.
  20379. If WIDTH is non-nil, the string is wrapped to that width, however many lines
  20380. that costs. If there is a word longer than WIDTH, the text is actually
  20381. wrapped to the length of that word.
  20382. IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
  20383. many lines, whatever width that takes.
  20384. The return value is a list of lines, without newlines at the end."
  20385. (let* ((words (org-split-string string "[ \t\n]+"))
  20386. (maxword (apply 'max (mapcar 'org-string-width words)))
  20387. w ll)
  20388. (cond (width
  20389. (org-do-wrap words (max maxword width)))
  20390. (lines
  20391. (setq w maxword)
  20392. (setq ll (org-do-wrap words maxword))
  20393. (if (<= (length ll) lines)
  20394. ll
  20395. (setq ll words)
  20396. (while (> (length ll) lines)
  20397. (setq w (1+ w))
  20398. (setq ll (org-do-wrap words w)))
  20399. ll))
  20400. (t (error "Cannot wrap this")))))
  20401. (defun org-do-wrap (words width)
  20402. "Create lines of maximum width WIDTH (in characters) from word list WORDS."
  20403. (let (lines line)
  20404. (while words
  20405. (setq line (pop words))
  20406. (while (and words (< (+ (length line) (length (car words))) width))
  20407. (setq line (concat line " " (pop words))))
  20408. (setq lines (push line lines)))
  20409. (nreverse lines)))
  20410. (defun org-split-string (string &optional separators)
  20411. "Splits STRING into substrings at SEPARATORS.
  20412. No empty strings are returned if there are matches at the beginning
  20413. and end of string."
  20414. (let ((rexp (or separators "[ \f\t\n\r\v]+"))
  20415. (start 0)
  20416. notfirst
  20417. (list nil))
  20418. (while (and (string-match rexp string
  20419. (if (and notfirst
  20420. (= start (match-beginning 0))
  20421. (< start (length string)))
  20422. (1+ start) start))
  20423. (< (match-beginning 0) (length string)))
  20424. (setq notfirst t)
  20425. (or (eq (match-beginning 0) 0)
  20426. (and (eq (match-beginning 0) (match-end 0))
  20427. (eq (match-beginning 0) start))
  20428. (setq list
  20429. (cons (substring string start (match-beginning 0))
  20430. list)))
  20431. (setq start (match-end 0)))
  20432. (or (eq start (length string))
  20433. (setq list
  20434. (cons (substring string start)
  20435. list)))
  20436. (nreverse list)))
  20437. (defun org-quote-vert (s)
  20438. "Replace \"|\" with \"\\vert\"."
  20439. (while (string-match "|" s)
  20440. (setq s (replace-match "\\vert" t t s)))
  20441. s)
  20442. (defun org-uuidgen-p (s)
  20443. "Is S an ID created by UUIDGEN?"
  20444. (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
  20445. (defun org-in-src-block-p (&optional inside)
  20446. "Whether point is in a code source block.
  20447. When INSIDE is non-nil, don't consider we are within a src block
  20448. when point is at #+BEGIN_SRC or #+END_SRC."
  20449. (let ((case-fold-search t) ov)
  20450. (or (and (eq (get-char-property (point) 'src-block) t))
  20451. (and (not inside)
  20452. (save-match-data
  20453. (save-excursion
  20454. (beginning-of-line)
  20455. (looking-at ".*#\\+\\(begin\\|end\\)_src")))))))
  20456. (defun org-context ()
  20457. "Return a list of contexts of the current cursor position.
  20458. If several contexts apply, all are returned.
  20459. Each context entry is a list with a symbol naming the context, and
  20460. two positions indicating start and end of the context. Possible
  20461. contexts are:
  20462. :headline anywhere in a headline
  20463. :headline-stars on the leading stars in a headline
  20464. :todo-keyword on a TODO keyword (including DONE) in a headline
  20465. :tags on the TAGS in a headline
  20466. :priority on the priority cookie in a headline
  20467. :item on the first line of a plain list item
  20468. :item-bullet on the bullet/number of a plain list item
  20469. :checkbox on the checkbox in a plain list item
  20470. :table in an org-mode table
  20471. :table-special on a special filed in a table
  20472. :table-table in a table.el table
  20473. :clocktable in a clocktable
  20474. :src-block in a source block
  20475. :link on a hyperlink
  20476. :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT.
  20477. :target on a <<target>>
  20478. :radio-target on a <<<radio-target>>>
  20479. :latex-fragment on a LaTeX fragment
  20480. :latex-preview on a LaTeX fragment with overlaid preview image
  20481. This function expects the position to be visible because it uses font-lock
  20482. faces as a help to recognize the following contexts: :table-special, :link,
  20483. and :keyword."
  20484. (let* ((f (get-text-property (point) 'face))
  20485. (faces (if (listp f) f (list f)))
  20486. (case-fold-search t)
  20487. (p (point)) clist o)
  20488. ;; First the large context
  20489. (cond
  20490. ((org-at-heading-p t)
  20491. (push (list :headline (point-at-bol) (point-at-eol)) clist)
  20492. (when (progn
  20493. (beginning-of-line 1)
  20494. (looking-at org-todo-line-tags-regexp))
  20495. (push (org-point-in-group p 1 :headline-stars) clist)
  20496. (push (org-point-in-group p 2 :todo-keyword) clist)
  20497. (push (org-point-in-group p 4 :tags) clist))
  20498. (goto-char p)
  20499. (skip-chars-backward "^[\n\r \t") (or (bobp) (backward-char 1))
  20500. (if (looking-at "\\[#[A-Z0-9]\\]")
  20501. (push (org-point-in-group p 0 :priority) clist)))
  20502. ((org-at-item-p)
  20503. (push (org-point-in-group p 2 :item-bullet) clist)
  20504. (push (list :item (point-at-bol)
  20505. (save-excursion (org-end-of-item) (point)))
  20506. clist)
  20507. (and (org-at-item-checkbox-p)
  20508. (push (org-point-in-group p 0 :checkbox) clist)))
  20509. ((org-at-table-p)
  20510. (push (list :table (org-table-begin) (org-table-end)) clist)
  20511. (if (memq 'org-formula faces)
  20512. (push (list :table-special
  20513. (previous-single-property-change p 'face)
  20514. (next-single-property-change p 'face)) clist)))
  20515. ((org-at-table-p 'any)
  20516. (push (list :table-table) clist)))
  20517. (goto-char p)
  20518. (let ((case-fold-search t))
  20519. ;; New the "medium" contexts: clocktables, source blocks
  20520. (cond ((org-in-clocktable-p)
  20521. (push (list :clocktable
  20522. (and (or (looking-at "[ \t]*\\(#\\+BEGIN: clocktable\\)")
  20523. (re-search-backward "[ \t]*\\(#+BEGIN: clocktable\\)" nil t))
  20524. (match-beginning 1))
  20525. (and (re-search-forward "[ \t]*#\\+END:?" nil t)
  20526. (match-end 0))) clist))
  20527. ((org-in-src-block-p)
  20528. (push (list :src-block
  20529. (and (or (looking-at "[ \t]*\\(#\\+BEGIN_SRC\\)")
  20530. (re-search-backward "[ \t]*\\(#+BEGIN_SRC\\)" nil t))
  20531. (match-beginning 1))
  20532. (and (search-forward "#+END_SRC" nil t)
  20533. (match-beginning 0))) clist))))
  20534. (goto-char p)
  20535. ;; Now the small context
  20536. (cond
  20537. ((org-at-timestamp-p)
  20538. (push (org-point-in-group p 0 :timestamp) clist))
  20539. ((memq 'org-link faces)
  20540. (push (list :link
  20541. (previous-single-property-change p 'face)
  20542. (next-single-property-change p 'face)) clist))
  20543. ((memq 'org-special-keyword faces)
  20544. (push (list :keyword
  20545. (previous-single-property-change p 'face)
  20546. (next-single-property-change p 'face)) clist))
  20547. ((org-at-target-p)
  20548. (push (org-point-in-group p 0 :target) clist)
  20549. (goto-char (1- (match-beginning 0)))
  20550. (if (looking-at org-radio-target-regexp)
  20551. (push (org-point-in-group p 0 :radio-target) clist))
  20552. (goto-char p))
  20553. ((setq o (car (delq nil
  20554. (mapcar
  20555. (lambda (x)
  20556. (if (memq x org-latex-fragment-image-overlays) x))
  20557. (overlays-at (point))))))
  20558. (push (list :latex-fragment
  20559. (overlay-start o) (overlay-end o)) clist)
  20560. (push (list :latex-preview
  20561. (overlay-start o) (overlay-end o)) clist))
  20562. ((org-inside-LaTeX-fragment-p)
  20563. ;; FIXME: positions wrong.
  20564. (push (list :latex-fragment (point) (point)) clist)))
  20565. (setq clist (nreverse (delq nil clist)))
  20566. clist))
  20567. (defun org-in-regexp (re &optional nlines visually)
  20568. "Check if point is inside a match of RE.
  20569. Normally only the current line is checked, but you can include
  20570. NLINES extra lines after point into the search. If VISUALLY is
  20571. set, require that the cursor is not after the match but really
  20572. on, so that the block visually is on the match."
  20573. (catch 'exit
  20574. (let ((pos (point))
  20575. (eol (point-at-eol (+ 1 (or nlines 0))))
  20576. (inc (if visually 1 0)))
  20577. (save-excursion
  20578. (beginning-of-line (- 1 (or nlines 0)))
  20579. (while (re-search-forward re eol t)
  20580. (if (and (<= (match-beginning 0) pos)
  20581. (>= (+ inc (match-end 0)) pos))
  20582. (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
  20583. (define-obsolete-function-alias 'org-at-regexp-p 'org-in-regexp
  20584. "Org mode 8.3")
  20585. (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
  20586. "Non-nil when point is between matches of START-RE and END-RE.
  20587. Also return a non-nil value when point is on one of the matches.
  20588. Optional arguments LIM-UP and LIM-DOWN bound the search; they are
  20589. buffer positions. Default values are the positions of headlines
  20590. surrounding the point.
  20591. The functions returns a cons cell whose car (resp. cdr) is the
  20592. position before START-RE (resp. after END-RE)."
  20593. (save-match-data
  20594. (let ((pos (point))
  20595. (limit-up (or lim-up (save-excursion (outline-previous-heading))))
  20596. (limit-down (or lim-down (save-excursion (outline-next-heading))))
  20597. beg end)
  20598. (save-excursion
  20599. ;; Point is on a block when on START-RE or if START-RE can be
  20600. ;; found before it...
  20601. (and (or (org-in-regexp start-re)
  20602. (re-search-backward start-re limit-up t))
  20603. (setq beg (match-beginning 0))
  20604. ;; ... and END-RE after it...
  20605. (goto-char (match-end 0))
  20606. (re-search-forward end-re limit-down t)
  20607. (> (setq end (match-end 0)) pos)
  20608. ;; ... without another START-RE in-between.
  20609. (goto-char (match-beginning 0))
  20610. (not (re-search-backward start-re (1+ beg) t))
  20611. ;; Return value.
  20612. (cons beg end))))))
  20613. (defun org-in-block-p (names)
  20614. "Non-nil when point belongs to a block whose name belongs to NAMES.
  20615. NAMES is a list of strings containing names of blocks.
  20616. Return first block name matched, or nil. Beware that in case of
  20617. nested blocks, the returned name may not belong to the closest
  20618. block from point."
  20619. (save-match-data
  20620. (catch 'exit
  20621. (let ((case-fold-search t)
  20622. (lim-up (save-excursion (outline-previous-heading)))
  20623. (lim-down (save-excursion (outline-next-heading))))
  20624. (mapc (lambda (name)
  20625. (let ((n (regexp-quote name)))
  20626. (when (org-between-regexps-p
  20627. (concat "^[ \t]*#\\+begin_" n)
  20628. (concat "^[ \t]*#\\+end_" n)
  20629. lim-up lim-down)
  20630. (throw 'exit n))))
  20631. names))
  20632. nil)))
  20633. (defun org-occur-in-agenda-files (regexp &optional nlines)
  20634. "Call `multi-occur' with buffers for all agenda files."
  20635. (interactive "sOrg-files matching: \np")
  20636. (let* ((files (org-agenda-files))
  20637. (tnames (mapcar 'file-truename files))
  20638. (extra org-agenda-text-search-extra-files)
  20639. f)
  20640. (when (eq (car extra) 'agenda-archives)
  20641. (setq extra (cdr extra))
  20642. (setq files (org-add-archive-files files)))
  20643. (while (setq f (pop extra))
  20644. (unless (member (file-truename f) tnames)
  20645. (add-to-list 'files f 'append)
  20646. (add-to-list 'tnames (file-truename f) 'append)))
  20647. (multi-occur
  20648. (mapcar (lambda (x)
  20649. (with-current-buffer
  20650. (or (get-file-buffer x) (find-file-noselect x))
  20651. (widen)
  20652. (current-buffer)))
  20653. files)
  20654. regexp)))
  20655. (if (boundp 'occur-mode-find-occurrence-hook)
  20656. ;; Emacs 23
  20657. (add-hook 'occur-mode-find-occurrence-hook
  20658. (lambda ()
  20659. (when (derived-mode-p 'org-mode)
  20660. (org-reveal))))
  20661. ;; Emacs 22
  20662. (defadvice occur-mode-goto-occurrence
  20663. (after org-occur-reveal activate)
  20664. (and (derived-mode-p 'org-mode) (org-reveal)))
  20665. (defadvice occur-mode-goto-occurrence-other-window
  20666. (after org-occur-reveal activate)
  20667. (and (derived-mode-p 'org-mode) (org-reveal)))
  20668. (defadvice occur-mode-display-occurrence
  20669. (after org-occur-reveal activate)
  20670. (when (derived-mode-p 'org-mode)
  20671. (let ((pos (occur-mode-find-occurrence)))
  20672. (with-current-buffer (marker-buffer pos)
  20673. (save-excursion
  20674. (goto-char pos)
  20675. (org-reveal)))))))
  20676. (defun org-occur-link-in-agenda-files ()
  20677. "Create a link and search for it in the agendas.
  20678. The link is not stored in `org-stored-links', it is just created
  20679. for the search purpose."
  20680. (interactive)
  20681. (let ((link (condition-case nil
  20682. (org-store-link nil)
  20683. (error "Unable to create a link to here"))))
  20684. (org-occur-in-agenda-files (regexp-quote link))))
  20685. (defun org-reverse-string (string)
  20686. "Return the reverse of STRING."
  20687. (apply 'string (reverse (string-to-list string))))
  20688. ;; defsubst org-uniquify must be defined before first use
  20689. (defun org-uniquify-alist (alist)
  20690. "Merge elements of ALIST with the same key.
  20691. For example, in this alist:
  20692. \(org-uniquify-alist '((a 1) (b 2) (a 3)))
  20693. => '((a 1 3) (b 2))
  20694. merge (a 1) and (a 3) into (a 1 3).
  20695. The function returns the new ALIST."
  20696. (let (rtn)
  20697. (mapc
  20698. (lambda (e)
  20699. (let (n)
  20700. (if (not (assoc (car e) rtn))
  20701. (push e rtn)
  20702. (setq n (cons (car e) (append (cdr (assoc (car e) rtn)) (cdr e))))
  20703. (setq rtn (assq-delete-all (car e) rtn))
  20704. (push n rtn))))
  20705. alist)
  20706. rtn))
  20707. (defun org-delete-all (elts list)
  20708. "Remove all elements in ELTS from LIST."
  20709. (while elts
  20710. (setq list (delete (pop elts) list)))
  20711. list)
  20712. (defun org-count (cl-item cl-seq)
  20713. "Count the number of occurrences of ITEM in SEQ.
  20714. Taken from `count' in cl-seq.el with all keyword arguments removed."
  20715. (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
  20716. (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
  20717. (while (< cl-start cl-end)
  20718. (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
  20719. (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
  20720. (setq cl-start (1+ cl-start)))
  20721. cl-count))
  20722. (defun org-remove-if (predicate seq)
  20723. "Remove everything from SEQ that fulfills PREDICATE."
  20724. (let (res e)
  20725. (while seq
  20726. (setq e (pop seq))
  20727. (if (not (funcall predicate e)) (push e res)))
  20728. (nreverse res)))
  20729. (defun org-remove-if-not (predicate seq)
  20730. "Remove everything from SEQ that does not fulfill PREDICATE."
  20731. (let (res e)
  20732. (while seq
  20733. (setq e (pop seq))
  20734. (if (funcall predicate e) (push e res)))
  20735. (nreverse res)))
  20736. (defun org-reduce (cl-func cl-seq &rest cl-keys)
  20737. "Reduce two-argument FUNCTION across SEQ.
  20738. Taken from `reduce' in cl-seq.el with all keyword arguments but
  20739. \":initial-value\" removed."
  20740. (let ((cl-accum (cond ((memq :initial-value cl-keys)
  20741. (cadr (memq :initial-value cl-keys)))
  20742. (cl-seq (pop cl-seq))
  20743. (t (funcall cl-func)))))
  20744. (while cl-seq
  20745. (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
  20746. cl-accum))
  20747. (defun org-every (pred seq)
  20748. "Return true if PREDICATE is true of every element of SEQ.
  20749. Adapted from `every' in cl.el."
  20750. (catch 'org-every
  20751. (mapc (lambda (e) (unless (funcall pred e) (throw 'org-every nil))) seq)
  20752. t))
  20753. (defun org-some (pred seq)
  20754. "Return true if PREDICATE is true of any element of SEQ.
  20755. Adapted from `some' in cl.el."
  20756. (catch 'org-some
  20757. (mapc (lambda (e) (when (funcall pred e) (throw 'org-some t))) seq)
  20758. nil))
  20759. (defun org-back-over-empty-lines ()
  20760. "Move backwards over whitespace, to the beginning of the first empty line.
  20761. Returns the number of empty lines passed."
  20762. (let ((pos (point)))
  20763. (if (cdr (assoc 'heading org-blank-before-new-entry))
  20764. (skip-chars-backward " \t\n\r")
  20765. (unless (eobp)
  20766. (forward-line -1)))
  20767. (beginning-of-line 2)
  20768. (goto-char (min (point) pos))
  20769. (count-lines (point) pos)))
  20770. (defun org-skip-whitespace ()
  20771. (skip-chars-forward " \t\n\r"))
  20772. (defun org-point-in-group (point group &optional context)
  20773. "Check if POINT is in match-group GROUP.
  20774. If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
  20775. match. If the match group does not exist or point is not inside it,
  20776. return nil."
  20777. (and (match-beginning group)
  20778. (>= point (match-beginning group))
  20779. (<= point (match-end group))
  20780. (if context
  20781. (list context (match-beginning group) (match-end group))
  20782. t)))
  20783. (defun org-switch-to-buffer-other-window (&rest args)
  20784. "Switch to buffer in a second window on the current frame.
  20785. In particular, do not allow pop-up frames.
  20786. Returns the newly created buffer."
  20787. (org-no-popups
  20788. (apply 'switch-to-buffer-other-window args)))
  20789. (defun org-combine-plists (&rest plists)
  20790. "Create a single property list from all plists in PLISTS.
  20791. The process starts by copying the first list, and then setting properties
  20792. from the other lists. Settings in the last list are the most significant
  20793. ones and overrule settings in the other lists."
  20794. (let ((rtn (copy-sequence (pop plists)))
  20795. p v ls)
  20796. (while plists
  20797. (setq ls (pop plists))
  20798. (while ls
  20799. (setq p (pop ls) v (pop ls))
  20800. (setq rtn (plist-put rtn p v))))
  20801. rtn))
  20802. (defun org-replace-escapes (string table)
  20803. "Replace %-escapes in STRING with values in TABLE.
  20804. TABLE is an association list with keys like \"%a\" and string values.
  20805. The sequences in STRING may contain normal field width and padding information,
  20806. for example \"%-5s\". Replacements happen in the sequence given by TABLE,
  20807. so values can contain further %-escapes if they are define later in TABLE."
  20808. (let ((tbl (copy-alist table))
  20809. (case-fold-search nil)
  20810. (pchg 0)
  20811. e re rpl)
  20812. (while (setq e (pop tbl))
  20813. (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
  20814. (when (and (cdr e) (string-match re (cdr e)))
  20815. (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
  20816. (safe "SREF"))
  20817. (add-text-properties 0 3 (list 'sref sref) safe)
  20818. (setcdr e (replace-match safe t t (cdr e)))))
  20819. (while (string-match re string)
  20820. (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
  20821. (cdr e)))
  20822. (setq string (replace-match rpl t t string))))
  20823. (while (setq pchg (next-property-change pchg string))
  20824. (let ((sref (get-text-property pchg 'sref string)))
  20825. (when (and sref (string-match "SREF" string pchg))
  20826. (setq string (replace-match sref t t string)))))
  20827. string))
  20828. (defun org-sublist (list start end)
  20829. "Return a section of LIST, from START to END.
  20830. Counting starts at 1."
  20831. (let (rtn (c start))
  20832. (setq list (nthcdr (1- start) list))
  20833. (while (and list (<= c end))
  20834. (push (pop list) rtn)
  20835. (setq c (1+ c)))
  20836. (nreverse rtn)))
  20837. (defun org-find-base-buffer-visiting (file)
  20838. "Like `find-buffer-visiting' but always return the base buffer and
  20839. not an indirect buffer."
  20840. (let ((buf (or (get-file-buffer file)
  20841. (find-buffer-visiting file))))
  20842. (if buf
  20843. (or (buffer-base-buffer buf) buf)
  20844. nil)))
  20845. (defun org-image-file-name-regexp (&optional extensions)
  20846. "Return regexp matching the file names of images.
  20847. If EXTENSIONS is given, only match these."
  20848. (if (and (not extensions) (fboundp 'image-file-name-regexp))
  20849. (image-file-name-regexp)
  20850. (let ((image-file-name-extensions
  20851. (or extensions
  20852. '("png" "jpeg" "jpg" "gif" "tiff" "tif"
  20853. "xbm" "xpm" "pbm" "pgm" "ppm"))))
  20854. (concat "\\."
  20855. (regexp-opt (nconc (mapcar 'upcase
  20856. image-file-name-extensions)
  20857. image-file-name-extensions)
  20858. t)
  20859. "\\'"))))
  20860. (defun org-file-image-p (file &optional extensions)
  20861. "Return non-nil if FILE is an image."
  20862. (save-match-data
  20863. (string-match (org-image-file-name-regexp extensions) file)))
  20864. (defun org-get-cursor-date (&optional with-time)
  20865. "Return the date at cursor in as a time.
  20866. This works in the calendar and in the agenda, anywhere else it just
  20867. returns the current time.
  20868. If WITH-TIME is non-nil, returns the time of the event at point (in
  20869. the agenda) or the current time of the day."
  20870. (let (date day defd tp tm hod mod)
  20871. (when with-time
  20872. (setq tp (get-text-property (point) 'time))
  20873. (when (and tp (string-match "\\([0-9][0-9]\\):\\([0-9][0-9]\\)" tp))
  20874. (setq hod (string-to-number (match-string 1 tp))
  20875. mod (string-to-number (match-string 2 tp))))
  20876. (or tp (setq hod (nth 2 (decode-time (current-time)))
  20877. mod (nth 1 (decode-time (current-time))))))
  20878. (cond
  20879. ((eq major-mode 'calendar-mode)
  20880. (setq date (calendar-cursor-to-date)
  20881. defd (encode-time 0 (or mod 0) (or hod 0)
  20882. (nth 1 date) (nth 0 date) (nth 2 date))))
  20883. ((eq major-mode 'org-agenda-mode)
  20884. (setq day (get-text-property (point) 'day))
  20885. (if day
  20886. (setq date (calendar-gregorian-from-absolute day)
  20887. defd (encode-time 0 (or mod 0) (or hod 0)
  20888. (nth 1 date) (nth 0 date) (nth 2 date))))))
  20889. (or defd (current-time))))
  20890. (defun org-mark-subtree (&optional up)
  20891. "Mark the current subtree.
  20892. This puts point at the start of the current subtree, and mark at
  20893. the end. If a numeric prefix UP is given, move up into the
  20894. hierarchy of headlines by UP levels before marking the subtree."
  20895. (interactive "P")
  20896. (org-with-limited-levels
  20897. (cond ((org-at-heading-p) (beginning-of-line))
  20898. ((org-before-first-heading-p) (user-error "Not in a subtree"))
  20899. (t (outline-previous-visible-heading 1))))
  20900. (when up (while (and (> up 0) (org-up-heading-safe)) (decf up)))
  20901. (if (org-called-interactively-p 'any)
  20902. (call-interactively 'org-mark-element)
  20903. (org-mark-element)))
  20904. ;;; Indentation
  20905. (defun org--get-expected-indentation (element contentsp)
  20906. "Expected indentation column for current line, according to ELEMENT.
  20907. ELEMENT is an element containing point. CONTENTSP is non-nil
  20908. when indentation is to be computed according to contents of
  20909. ELEMENT."
  20910. (let ((type (org-element-type element))
  20911. (start (org-element-property :begin element))
  20912. (post-affiliated (org-element-property :post-affiliated element)))
  20913. (org-with-wide-buffer
  20914. (cond
  20915. (contentsp
  20916. (case type
  20917. ((diary-sexp footnote-definition) 0)
  20918. ((headline inlinetask nil)
  20919. (if (not org-adapt-indentation) 0
  20920. (let ((level (org-current-level)))
  20921. (if level (1+ level) 0))))
  20922. ((item plain-list) (org-list-item-body-column post-affiliated))
  20923. (t
  20924. (goto-char start)
  20925. (org-get-indentation))))
  20926. ((memq type '(headline inlinetask nil))
  20927. (if (save-excursion (beginning-of-line) (looking-at "[ \t]*$"))
  20928. (org--get-expected-indentation element t)
  20929. 0))
  20930. ((memq type '(diary-sexp footnote-definition)) 0)
  20931. ;; First paragraph of a footnote definition or an item.
  20932. ;; Indent like parent.
  20933. ((< (line-beginning-position) start)
  20934. (org--get-expected-indentation
  20935. (org-element-property :parent element) t))
  20936. ;; At first line: indent according to previous sibling, if any,
  20937. ;; ignoring footnote definitions and inline tasks, or parent's
  20938. ;; contents.
  20939. ((= (line-beginning-position) start)
  20940. (catch 'exit
  20941. (while t
  20942. (if (= (point-min) start) (throw 'exit 0)
  20943. (goto-char (1- start))
  20944. (let* ((previous (org-element-at-point))
  20945. (parent previous))
  20946. (while (and parent (<= (org-element-property :end parent) start))
  20947. (setq previous parent
  20948. parent (org-element-property :parent parent)))
  20949. (cond
  20950. ((not previous) (throw 'exit 0))
  20951. ((> (org-element-property :end previous) start)
  20952. (throw 'exit (org--get-expected-indentation previous t)))
  20953. ((memq (org-element-type previous)
  20954. '(footnote-definition inlinetask))
  20955. (setq start (org-element-property :begin previous)))
  20956. (t (goto-char (org-element-property :begin previous))
  20957. (throw 'exit
  20958. (if (bolp) (org-get-indentation)
  20959. ;; At first paragraph in an item or
  20960. ;; a footnote definition.
  20961. (org--get-expected-indentation
  20962. (org-element-property :parent previous) t))))))))))
  20963. ;; Otherwise, move to the first non-blank line above.
  20964. (t
  20965. (beginning-of-line)
  20966. (let ((pos (point)))
  20967. (skip-chars-backward " \r\t\n")
  20968. (cond
  20969. ;; Two blank lines end a footnote definition or a plain
  20970. ;; list. When we indent an empty line after them, the
  20971. ;; containing list or footnote definition is over, so it
  20972. ;; qualifies as a previous sibling. Therefore, we indent
  20973. ;; like its first line.
  20974. ((and (memq type '(footnote-definition plain-list))
  20975. (> (count-lines (point) pos) 2))
  20976. (goto-char start)
  20977. (org-get-indentation))
  20978. ;; Line above is the first one of a paragraph at the
  20979. ;; beginning of an item or a footnote definition. Indent
  20980. ;; like parent.
  20981. ((< (line-beginning-position) start)
  20982. (org--get-expected-indentation
  20983. (org-element-property :parent element) t))
  20984. ;; Line above is the beginning of an element, i.e., point
  20985. ;; was originally on the blank lines between element's start
  20986. ;; and contents.
  20987. ((= (line-beginning-position) post-affiliated)
  20988. (org--get-expected-indentation element t))
  20989. ;; POS is after contents in a greater element. Indent like
  20990. ;; the beginning of the element.
  20991. ;;
  20992. ;; As a special case, if point is at the end of a footnote
  20993. ;; definition or an item, indent like the very last element
  20994. ;; within.
  20995. ((and (not (eq type 'paragraph))
  20996. (let ((cend (org-element-property :contents-end element)))
  20997. (and cend (<= cend pos))))
  20998. (if (memq type '(footnote-definition item plain-list))
  20999. (let ((last (org-element-at-point)))
  21000. (org--get-expected-indentation
  21001. last
  21002. (memq (org-element-type last)
  21003. '(footnote-definition item plain-list))))
  21004. (goto-char start)
  21005. (org-get-indentation)))
  21006. ;; In any other case, indent like the current line.
  21007. (t (org-get-indentation)))))))))
  21008. (defun org--align-node-property ()
  21009. "Align node property at point.
  21010. Alignment is done according to `org-property-format', which see."
  21011. (when (save-excursion
  21012. (beginning-of-line)
  21013. (looking-at org-property-re))
  21014. (replace-match
  21015. (concat (match-string 4)
  21016. (org-trim
  21017. (format org-property-format (match-string 1) (match-string 3))))
  21018. t t)))
  21019. (defun org-indent-line ()
  21020. "Indent line depending on context.
  21021. Indentation is done according to the following rules:
  21022. - Footnote definitions, diary sexps, headlines and inline tasks
  21023. have to start at column 0.
  21024. - On the very first line of an element, consider, in order, the
  21025. next rules until one matches:
  21026. 1. If there's a sibling element before, ignoring footnote
  21027. definitions and inline tasks, indent like its first line.
  21028. 2. If element has a parent, indent like its contents. More
  21029. precisely, if parent is an item, indent after the
  21030. description part, if any, or the bullet (see
  21031. `org-list-description-max-indent'). Else, indent like
  21032. parent's first line.
  21033. 3. Otherwise, indent relatively to current level, if
  21034. `org-adapt-indentation' is non-nil, or to left margin.
  21035. - On a blank line at the end of an element, indent according to
  21036. the type of the element. More precisely
  21037. 1. If element is a plain list, an item, or a footnote
  21038. definition, indent like the very last element within.
  21039. 2. If element is a paragraph, indent like its last non blank
  21040. line.
  21041. 3. Otherwise, indent like its very first line.
  21042. - In the code part of a source block, use language major mode
  21043. to indent current line if `org-src-tab-acts-natively' is
  21044. non-nil. If it is nil, do nothing.
  21045. - Otherwise, indent like the first non-blank line above.
  21046. The function doesn't indent an item as it could break the whole
  21047. list structure. Instead, use \\<org-mode-map>\\[org-shiftmetaleft] or \
  21048. \\[org-shiftmetaright].
  21049. Also align node properties according to `org-property-format'."
  21050. (interactive)
  21051. (cond
  21052. (orgstruct-is-++
  21053. (let ((indent-line-function
  21054. (cadadr (assq 'indent-line-function org-fb-vars))))
  21055. (indent-according-to-mode)))
  21056. ((org-at-heading-p) 'noindent)
  21057. (t
  21058. (let* ((element (save-excursion (beginning-of-line) (org-element-at-point)))
  21059. (type (org-element-type element)))
  21060. (cond ((and (memq type '(plain-list item))
  21061. (= (line-beginning-position)
  21062. (org-element-property :post-affiliated element)))
  21063. 'noindent)
  21064. ((and (eq type 'src-block)
  21065. org-src-tab-acts-natively
  21066. (> (line-beginning-position)
  21067. (org-element-property :post-affiliated element))
  21068. (< (line-beginning-position)
  21069. (org-with-wide-buffer
  21070. (goto-char (org-element-property :end element))
  21071. (skip-chars-backward " \r\t\n")
  21072. (line-beginning-position))))
  21073. (org-babel-do-key-sequence-in-edit-buffer (kbd "TAB")))
  21074. (t
  21075. (let ((column (org--get-expected-indentation element nil)))
  21076. ;; Preserve current column.
  21077. (if (<= (current-column) (current-indentation))
  21078. (org-indent-line-to column)
  21079. (save-excursion (org-indent-line-to column))))
  21080. ;; Align node property. Also preserve current column.
  21081. (when (eq type 'node-property)
  21082. (let ((column (current-column)))
  21083. (org--align-node-property)
  21084. (org-move-to-column column)))))))))
  21085. (defun org-indent-region (start end)
  21086. "Indent each non-blank line in the region.
  21087. Called from a program, START and END specify the region to
  21088. indent. The function will not indent contents of example blocks,
  21089. verse blocks and export blocks as leading white spaces are
  21090. assumed to be significant there."
  21091. (interactive "r")
  21092. (save-excursion
  21093. (goto-char start)
  21094. (skip-chars-forward " \r\t\n")
  21095. (unless (eobp) (beginning-of-line))
  21096. (let ((indent-to
  21097. (lambda (ind pos)
  21098. ;; Set IND as indentation for all lines between point and
  21099. ;; POS or END, whichever comes first. Blank lines are
  21100. ;; ignored. Leave point after POS once done.
  21101. (let ((limit (copy-marker (min end pos))))
  21102. (while (< (point) limit)
  21103. (unless (org-looking-at-p "[ \t]*$") (org-indent-line-to ind))
  21104. (forward-line))
  21105. (set-marker limit nil))))
  21106. (end (copy-marker end)))
  21107. (while (< (point) end)
  21108. (if (or (org-looking-at-p " \r\t\n") (org-at-heading-p)) (forward-line)
  21109. (let* ((element (org-element-at-point))
  21110. (type (org-element-type element))
  21111. (element-end (copy-marker (org-element-property :end element)))
  21112. (ind (org--get-expected-indentation element nil)))
  21113. (cond
  21114. ((or (memq type '(paragraph table table-row))
  21115. (not (or (org-element-property :contents-begin element)
  21116. (memq type
  21117. '(example-block export-block src-block)))))
  21118. ;; Elements here are indented as a single block. Also
  21119. ;; align node properties.
  21120. (when (eq type 'node-property)
  21121. (org--align-node-property)
  21122. (beginning-of-line))
  21123. (funcall indent-to ind element-end))
  21124. (t
  21125. ;; Elements in this category consist of three parts:
  21126. ;; before the contents, the contents, and after the
  21127. ;; contents. The contents are treated specially,
  21128. ;; according to the element type, or not indented at
  21129. ;; all. Other parts are indented as a single block.
  21130. (let* ((post (copy-marker
  21131. (org-element-property :post-affiliated element)))
  21132. (cbeg
  21133. (copy-marker
  21134. (cond
  21135. ((not (org-element-property :contents-begin element))
  21136. ;; Fake contents for source blocks.
  21137. (org-with-wide-buffer
  21138. (goto-char post)
  21139. (forward-line)
  21140. (point)))
  21141. ((memq type '(footnote-definition item plain-list))
  21142. ;; Contents in these elements could start on
  21143. ;; the same line as the beginning of the
  21144. ;; element. Make sure we start indenting
  21145. ;; from the second line.
  21146. (org-with-wide-buffer
  21147. (goto-char post)
  21148. (end-of-line)
  21149. (skip-chars-forward " \r\t\n")
  21150. (if (eobp) (point) (line-beginning-position))))
  21151. (t (org-element-property :contents-begin element)))))
  21152. (cend (copy-marker
  21153. (or (org-element-property :contents-end element)
  21154. ;; Fake contents for source blocks.
  21155. (org-with-wide-buffer
  21156. (goto-char element-end)
  21157. (skip-chars-backward " \r\t\n")
  21158. (line-beginning-position)))
  21159. t)))
  21160. ;; Do not change items indentation individually as it
  21161. ;; might break the list as a whole. On the other
  21162. ;; hand, when at a plain list, indent it as a whole.
  21163. (cond ((eq type 'plain-list)
  21164. (let ((offset (- ind (org-get-indentation))))
  21165. (unless (zerop offset)
  21166. (indent-rigidly (org-element-property :begin element)
  21167. (org-element-property :end element)
  21168. offset))
  21169. (goto-char cbeg)))
  21170. ((eq type 'item) (goto-char cbeg))
  21171. (t (funcall indent-to ind cbeg)))
  21172. (when (< (point) end)
  21173. (case type
  21174. ((example-block export-block verse-block))
  21175. (src-block
  21176. ;; In a source block, indent source code
  21177. ;; according to language major mode, but only if
  21178. ;; `org-src-tab-acts-natively' is non-nil.
  21179. (when (and (< (point) end) org-src-tab-acts-natively)
  21180. (ignore-errors
  21181. (org-babel-do-in-edit-buffer
  21182. (indent-region (point-min) (point-max))))))
  21183. (t (org-indent-region (point) (min cend end))))
  21184. (goto-char (min cend end))
  21185. (when (< (point) end) (funcall indent-to ind element-end)))
  21186. (set-marker post nil)
  21187. (set-marker cbeg nil)
  21188. (set-marker cend nil))))
  21189. (set-marker element-end nil))))
  21190. (set-marker end nil))))
  21191. (defun org-indent-drawer ()
  21192. "Indent the drawer at point."
  21193. (interactive)
  21194. (unless (save-excursion
  21195. (beginning-of-line)
  21196. (org-looking-at-p org-drawer-regexp))
  21197. (user-error "Not at a drawer"))
  21198. (let ((element (org-element-at-point)))
  21199. (unless (memq (org-element-type element) '(drawer property-drawer))
  21200. (user-error "Not at a drawer"))
  21201. (org-with-wide-buffer
  21202. (org-indent-region (org-element-property :begin element)
  21203. (org-element-property :end element))))
  21204. (message "Drawer at point indented"))
  21205. (defun org-indent-block ()
  21206. "Indent the block at point."
  21207. (interactive)
  21208. (unless (save-excursion
  21209. (beginning-of-line)
  21210. (let ((case-fold-search t))
  21211. (org-looking-at-p "[ \t]*#\\+\\(begin\\|end\\)_")))
  21212. (user-error "Not at a block"))
  21213. (let ((element (org-element-at-point)))
  21214. (unless (memq (org-element-type element)
  21215. '(comment-block center-block dynamic-block example-block
  21216. export-block quote-block special-block
  21217. src-block verse-block))
  21218. (user-error "Not at a block"))
  21219. (org-with-wide-buffer
  21220. (org-indent-region (org-element-property :begin element)
  21221. (org-element-property :end element))))
  21222. (message "Block at point indented"))
  21223. ;;; Filling
  21224. ;; We use our own fill-paragraph and auto-fill functions.
  21225. ;; `org-fill-paragraph' relies on adaptive filling and context
  21226. ;; checking. Appropriate `fill-prefix' is computed with
  21227. ;; `org-adaptive-fill-function'.
  21228. ;; `org-auto-fill-function' takes care of auto-filling. It calls
  21229. ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
  21230. ;; `org-adaptive-fill-function' value. Internally,
  21231. ;; `org-comment-line-break-function' breaks the line.
  21232. ;; `org-setup-filling' installs filling and auto-filling related
  21233. ;; variables during `org-mode' initialization.
  21234. (defvar org-element-paragraph-separate) ; org-element.el
  21235. (defun org-setup-filling ()
  21236. (require 'org-element)
  21237. ;; Prevent auto-fill from inserting unwanted new items.
  21238. (when (boundp 'fill-nobreak-predicate)
  21239. (org-set-local
  21240. 'fill-nobreak-predicate
  21241. (org-uniquify
  21242. (append fill-nobreak-predicate
  21243. '(org-fill-line-break-nobreak-p
  21244. org-fill-paragraph-with-timestamp-nobreak-p)))))
  21245. (let ((paragraph-ending (substring org-element-paragraph-separate 1)))
  21246. (org-set-local 'paragraph-start paragraph-ending)
  21247. (org-set-local 'paragraph-separate paragraph-ending))
  21248. (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
  21249. (org-set-local 'auto-fill-inhibit-regexp nil)
  21250. (org-set-local 'adaptive-fill-function 'org-adaptive-fill-function)
  21251. (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
  21252. (org-set-local 'comment-line-break-function 'org-comment-line-break-function))
  21253. (defun org-fill-line-break-nobreak-p ()
  21254. "Non-nil when a new line at point would create an Org line break."
  21255. (save-excursion
  21256. (skip-chars-backward "[ \t]")
  21257. (skip-chars-backward "\\\\")
  21258. (looking-at "\\\\\\\\\\($\\|[^\\\\]\\)")))
  21259. (defun org-fill-paragraph-with-timestamp-nobreak-p ()
  21260. "Non-nil when a new line at point would split a timestamp."
  21261. (and (org-at-timestamp-p t)
  21262. (not (looking-at org-ts-regexp-both))))
  21263. (declare-function message-in-body-p "message" ())
  21264. (defvar orgtbl-line-start-regexp) ; From org-table.el
  21265. (defun org-adaptive-fill-function ()
  21266. "Compute a fill prefix for the current line.
  21267. Return fill prefix, as a string, or nil if current line isn't
  21268. meant to be filled. For convenience, if `adaptive-fill-regexp'
  21269. matches in paragraphs or comments, use it."
  21270. (catch 'exit
  21271. (when (derived-mode-p 'message-mode)
  21272. (save-excursion
  21273. (beginning-of-line)
  21274. (cond ((not (message-in-body-p)) (throw 'exit nil))
  21275. ((org-looking-at-p org-table-line-regexp) (throw 'exit nil))
  21276. ((looking-at message-cite-prefix-regexp)
  21277. (throw 'exit (match-string-no-properties 0)))
  21278. ((looking-at org-outline-regexp)
  21279. (throw 'exit (make-string (length (match-string 0)) ?\s))))))
  21280. (org-with-wide-buffer
  21281. (unless (org-at-heading-p)
  21282. (let* ((p (line-beginning-position))
  21283. (element (save-excursion
  21284. (beginning-of-line)
  21285. (org-element-at-point)))
  21286. (type (org-element-type element))
  21287. (post-affiliated (org-element-property :post-affiliated element)))
  21288. (unless (< p post-affiliated)
  21289. (case type
  21290. (comment
  21291. (save-excursion
  21292. (beginning-of-line)
  21293. (looking-at "[ \t]*")
  21294. (concat (match-string 0) "# ")))
  21295. (footnote-definition "")
  21296. ((item plain-list)
  21297. (make-string (org-list-item-body-column post-affiliated) ?\s))
  21298. (paragraph
  21299. ;; Fill prefix is usually the same as the current line,
  21300. ;; unless the paragraph is at the beginning of an item.
  21301. (let ((parent (org-element-property :parent element)))
  21302. (save-excursion
  21303. (beginning-of-line)
  21304. (cond ((eq (org-element-type parent) 'item)
  21305. (make-string (org-list-item-body-column
  21306. (org-element-property :begin parent))
  21307. ?\s))
  21308. ((and adaptive-fill-regexp
  21309. ;; Locally disable
  21310. ;; `adaptive-fill-function' to let
  21311. ;; `fill-context-prefix' handle
  21312. ;; `adaptive-fill-regexp' variable.
  21313. (let (adaptive-fill-function)
  21314. (fill-context-prefix
  21315. post-affiliated
  21316. (org-element-property :end element)))))
  21317. ((looking-at "[ \t]+") (match-string 0))
  21318. (t "")))))
  21319. (comment-block
  21320. ;; Only fill contents if P is within block boundaries.
  21321. (let* ((cbeg (save-excursion (goto-char post-affiliated)
  21322. (forward-line)
  21323. (point)))
  21324. (cend (save-excursion
  21325. (goto-char (org-element-property :end element))
  21326. (skip-chars-backward " \r\t\n")
  21327. (line-beginning-position))))
  21328. (when (and (>= p cbeg) (< p cend))
  21329. (if (save-excursion (beginning-of-line) (looking-at "[ \t]+"))
  21330. (match-string 0)
  21331. "")))))))))))
  21332. (declare-function message-goto-body "message" ())
  21333. (defvar message-cite-prefix-regexp) ; From message.el
  21334. (defun org-fill-paragraph (&optional justify)
  21335. "Fill element at point, when applicable.
  21336. This function only applies to comment blocks, comments, example
  21337. blocks and paragraphs. Also, as a special case, re-align table
  21338. when point is at one.
  21339. If JUSTIFY is non-nil (interactively, with prefix argument),
  21340. justify as well. If `sentence-end-double-space' is non-nil, then
  21341. period followed by one space does not end a sentence, so don't
  21342. break a line there. The variable `fill-column' controls the
  21343. width for filling.
  21344. For convenience, when point is at a plain list, an item or
  21345. a footnote definition, try to fill the first paragraph within."
  21346. (interactive)
  21347. (if (and (derived-mode-p 'message-mode)
  21348. (or (not (message-in-body-p))
  21349. (save-excursion (move-beginning-of-line 1)
  21350. (looking-at message-cite-prefix-regexp))))
  21351. ;; First ensure filling is correct in message-mode.
  21352. (let ((fill-paragraph-function
  21353. (cadadr (assoc 'fill-paragraph-function org-fb-vars)))
  21354. (fill-prefix (cadadr (assoc 'fill-prefix org-fb-vars)))
  21355. (paragraph-start (cadadr (assoc 'paragraph-start org-fb-vars)))
  21356. (paragraph-separate
  21357. (cadadr (assoc 'paragraph-separate org-fb-vars))))
  21358. (fill-paragraph nil))
  21359. (with-syntax-table org-mode-transpose-word-syntax-table
  21360. ;; Move to end of line in order to get the first paragraph
  21361. ;; within a plain list or a footnote definition.
  21362. (let ((element (save-excursion
  21363. (end-of-line)
  21364. (or (ignore-errors (org-element-at-point))
  21365. (user-error "An element cannot be parsed line %d"
  21366. (line-number-at-pos (point)))))))
  21367. ;; First check if point is in a blank line at the beginning of
  21368. ;; the buffer. In that case, ignore filling.
  21369. (case (org-element-type element)
  21370. ;; Use major mode filling function is src blocks.
  21371. (src-block (org-babel-do-key-sequence-in-edit-buffer (kbd "M-q")))
  21372. ;; Align Org tables, leave table.el tables as-is.
  21373. (table-row (org-table-align) t)
  21374. (table
  21375. (when (eq (org-element-property :type element) 'org)
  21376. (save-excursion
  21377. (goto-char (org-element-property :post-affiliated element))
  21378. (org-table-align)))
  21379. t)
  21380. (paragraph
  21381. ;; Paragraphs may contain `line-break' type objects.
  21382. (let ((beg (max (point-min)
  21383. (org-element-property :contents-begin element)))
  21384. (end (min (point-max)
  21385. (org-element-property :contents-end element))))
  21386. ;; Do nothing if point is at an affiliated keyword.
  21387. (if (< (line-end-position) beg) t
  21388. (when (derived-mode-p 'message-mode)
  21389. ;; In `message-mode', do not fill following citation
  21390. ;; in current paragraph nor text before message body.
  21391. (let ((body-start (save-excursion (message-goto-body))))
  21392. (when body-start (setq beg (max body-start beg))))
  21393. (when (save-excursion
  21394. (re-search-forward
  21395. (concat "^" message-cite-prefix-regexp) end t))
  21396. (setq end (match-beginning 0))))
  21397. ;; Fill paragraph, taking line breaks into account.
  21398. (save-excursion
  21399. (goto-char beg)
  21400. (let ((cuts (list beg)))
  21401. (while (re-search-forward "\\\\\\\\[ \t]*\n" end t)
  21402. (when (eq 'line-break
  21403. (org-element-type
  21404. (save-excursion (backward-char)
  21405. (org-element-context))))
  21406. (push (point) cuts)))
  21407. (dolist (c (delq end cuts))
  21408. (fill-region-as-paragraph c end justify)
  21409. (setq end c))))
  21410. t)))
  21411. ;; Contents of `comment-block' type elements should be
  21412. ;; filled as plain text, but only if point is within block
  21413. ;; markers.
  21414. (comment-block
  21415. (let* ((case-fold-search t)
  21416. (beg (save-excursion
  21417. (goto-char (org-element-property :begin element))
  21418. (re-search-forward "^[ \t]*#\\+begin_comment" nil t)
  21419. (forward-line)
  21420. (point)))
  21421. (end (save-excursion
  21422. (goto-char (org-element-property :end element))
  21423. (re-search-backward "^[ \t]*#\\+end_comment" nil t)
  21424. (line-beginning-position))))
  21425. (if (or (< (point) beg) (> (point) end)) t
  21426. (fill-region-as-paragraph
  21427. (save-excursion (end-of-line)
  21428. (re-search-backward "^[ \t]*$" beg 'move)
  21429. (line-beginning-position))
  21430. (save-excursion (beginning-of-line)
  21431. (re-search-forward "^[ \t]*$" end 'move)
  21432. (line-beginning-position))
  21433. justify))))
  21434. ;; Fill comments.
  21435. (comment
  21436. (let ((begin (org-element-property :post-affiliated element))
  21437. (end (org-element-property :end element)))
  21438. (when (and (>= (point) begin) (<= (point) end))
  21439. (let ((begin (save-excursion
  21440. (end-of-line)
  21441. (if (re-search-backward "^[ \t]*#[ \t]*$" begin t)
  21442. (progn (forward-line) (point))
  21443. begin)))
  21444. (end (save-excursion
  21445. (end-of-line)
  21446. (if (re-search-forward "^[ \t]*#[ \t]*$" end 'move)
  21447. (1- (line-beginning-position))
  21448. (skip-chars-backward " \r\t\n")
  21449. (line-end-position)))))
  21450. ;; Do not fill comments when at a blank line.
  21451. (when (> end begin)
  21452. (let ((fill-prefix
  21453. (save-excursion
  21454. (beginning-of-line)
  21455. (looking-at "[ \t]*#")
  21456. (let ((comment-prefix (match-string 0)))
  21457. (goto-char (match-end 0))
  21458. (if (looking-at adaptive-fill-regexp)
  21459. (concat comment-prefix (match-string 0))
  21460. (concat comment-prefix " "))))))
  21461. (save-excursion
  21462. (fill-region-as-paragraph begin end justify))))))
  21463. t))
  21464. ;; Ignore every other element.
  21465. (otherwise t))))))
  21466. (defun org-auto-fill-function ()
  21467. "Auto-fill function."
  21468. ;; Check if auto-filling is meaningful.
  21469. (let ((fc (current-fill-column)))
  21470. (when (and fc (> (current-column) fc))
  21471. (let* ((fill-prefix (org-adaptive-fill-function))
  21472. ;; Enforce empty fill prefix, if required. Otherwise, it
  21473. ;; will be computed again.
  21474. (adaptive-fill-mode (not (equal fill-prefix ""))))
  21475. (when fill-prefix (do-auto-fill))))))
  21476. (defun org-comment-line-break-function (&optional soft)
  21477. "Break line at point and indent, continuing comment if within one.
  21478. The inserted newline is marked hard if variable
  21479. `use-hard-newlines' is true, unless optional argument SOFT is
  21480. non-nil."
  21481. (if soft (insert-and-inherit ?\n) (newline 1))
  21482. (save-excursion (forward-char -1) (delete-horizontal-space))
  21483. (delete-horizontal-space)
  21484. (indent-to-left-margin)
  21485. (insert-before-markers-and-inherit fill-prefix))
  21486. ;;; Fixed Width Areas
  21487. (defun org-toggle-fixed-width ()
  21488. "Toggle fixed-width markup.
  21489. Add or remove fixed-width markup on current line, whenever it
  21490. makes sense. Return an error otherwise.
  21491. If a region is active and if it contains only fixed-width areas
  21492. or blank lines, remove all fixed-width markup in it. If the
  21493. region contains anything else, convert all non-fixed-width lines
  21494. to fixed-width ones.
  21495. Blank lines at the end of the region are ignored unless the
  21496. region only contains such lines."
  21497. (interactive)
  21498. (if (not (org-region-active-p))
  21499. ;; No region:
  21500. ;;
  21501. ;; Remove fixed width marker only in a fixed-with element.
  21502. ;;
  21503. ;; Add fixed width maker in paragraphs, in blank lines after
  21504. ;; elements or at the beginning of a headline or an inlinetask,
  21505. ;; and before any one-line elements (e.g., a clock).
  21506. (progn
  21507. (beginning-of-line)
  21508. (let* ((element (org-element-at-point))
  21509. (type (org-element-type element)))
  21510. (cond
  21511. ((and (eq type 'fixed-width)
  21512. (looking-at "[ \t]*\\(:\\(?: \\|$\\)\\)"))
  21513. (replace-match
  21514. "" nil nil nil (if (= (line-end-position) (match-end 0)) 0 1)))
  21515. ((and (memq type '(babel-call clock comment diary-sexp headline
  21516. horizontal-rule keyword paragraph
  21517. planning))
  21518. (<= (org-element-property :post-affiliated element) (point)))
  21519. (skip-chars-forward " \t")
  21520. (insert ": "))
  21521. ((and (org-looking-at-p "[ \t]*$")
  21522. (or (eq type 'inlinetask)
  21523. (save-excursion
  21524. (skip-chars-forward " \r\t\n")
  21525. (<= (org-element-property :end element) (point)))))
  21526. (delete-region (point) (line-end-position))
  21527. (org-indent-line)
  21528. (insert ": "))
  21529. (t (user-error "Cannot insert a fixed-width line here")))))
  21530. ;; Region active.
  21531. (let* ((begin (save-excursion
  21532. (goto-char (region-beginning))
  21533. (line-beginning-position)))
  21534. (end (copy-marker
  21535. (save-excursion
  21536. (goto-char (region-end))
  21537. (unless (eolp) (beginning-of-line))
  21538. (if (save-excursion (re-search-backward "\\S-" begin t))
  21539. (progn (skip-chars-backward " \r\t\n") (point))
  21540. (point)))))
  21541. (all-fixed-width-p
  21542. (catch 'not-all-p
  21543. (save-excursion
  21544. (goto-char begin)
  21545. (skip-chars-forward " \r\t\n")
  21546. (when (eobp) (throw 'not-all-p nil))
  21547. (while (< (point) end)
  21548. (let ((element (org-element-at-point)))
  21549. (if (eq (org-element-type element) 'fixed-width)
  21550. (goto-char (org-element-property :end element))
  21551. (throw 'not-all-p nil))))
  21552. t))))
  21553. (if all-fixed-width-p
  21554. (save-excursion
  21555. (goto-char begin)
  21556. (while (< (point) end)
  21557. (when (looking-at "[ \t]*\\(:\\(?: \\|$\\)\\)")
  21558. (replace-match
  21559. "" nil nil nil
  21560. (if (= (line-end-position) (match-end 0)) 0 1)))
  21561. (forward-line)))
  21562. (let ((min-ind (point-max)))
  21563. ;; Find minimum indentation across all lines.
  21564. (save-excursion
  21565. (goto-char begin)
  21566. (if (not (save-excursion (re-search-forward "\\S-" end t)))
  21567. (setq min-ind 0)
  21568. (catch 'zerop
  21569. (while (< (point) end)
  21570. (unless (org-looking-at-p "[ \t]*$")
  21571. (let ((ind (org-get-indentation)))
  21572. (setq min-ind (min min-ind ind))
  21573. (when (zerop ind) (throw 'zerop t))))
  21574. (forward-line)))))
  21575. ;; Loop over all lines and add fixed-width markup everywhere
  21576. ;; but in fixed-width lines.
  21577. (save-excursion
  21578. (goto-char begin)
  21579. (while (< (point) end)
  21580. (cond
  21581. ((org-at-heading-p)
  21582. (insert ": ")
  21583. (forward-line)
  21584. (while (and (< (point) end) (org-looking-at-p "[ \t]*$"))
  21585. (insert ":")
  21586. (forward-line)))
  21587. ((org-looking-at-p "[ \t]*:\\( \\|$\\)")
  21588. (let* ((element (org-element-at-point))
  21589. (element-end (org-element-property :end element)))
  21590. (if (eq (org-element-type element) 'fixed-width)
  21591. (progn (goto-char element-end)
  21592. (skip-chars-backward " \r\t\n")
  21593. (forward-line))
  21594. (let ((limit (min end element-end)))
  21595. (while (< (point) limit)
  21596. (org-move-to-column min-ind t)
  21597. (insert ": ")
  21598. (forward-line))))))
  21599. (t
  21600. (org-move-to-column min-ind t)
  21601. (insert ": ")
  21602. (forward-line)))))))
  21603. (set-marker end nil))))
  21604. ;;; Comments
  21605. ;; Org comments syntax is quite complex. It requires the entire line
  21606. ;; to be just a comment. Also, even with the right syntax at the
  21607. ;; beginning of line, some some elements (i.e. verse-block or
  21608. ;; example-block) don't accept comments. Usual Emacs comment commands
  21609. ;; cannot cope with those requirements. Therefore, Org replaces them.
  21610. ;; Org still relies on `comment-dwim', but cannot trust
  21611. ;; `comment-only-p'. So, `comment-region-function' and
  21612. ;; `uncomment-region-function' both point
  21613. ;; to`org-comment-or-uncomment-region'. Eventually,
  21614. ;; `org-insert-comment' takes care of insertion of comments at the
  21615. ;; beginning of line.
  21616. ;; `org-setup-comments-handling' install comments related variables
  21617. ;; during `org-mode' initialization.
  21618. (defun org-setup-comments-handling ()
  21619. (interactive)
  21620. (org-set-local 'comment-use-syntax nil)
  21621. (org-set-local 'comment-start "# ")
  21622. (org-set-local 'comment-start-skip "^\\s-*#\\(?: \\|$\\)")
  21623. (org-set-local 'comment-insert-comment-function 'org-insert-comment)
  21624. (org-set-local 'comment-region-function 'org-comment-or-uncomment-region)
  21625. (org-set-local 'uncomment-region-function 'org-comment-or-uncomment-region))
  21626. (defun org-insert-comment ()
  21627. "Insert an empty comment above current line.
  21628. If the line is empty, insert comment at its beginning. When
  21629. point is within a source block, comment according to the related
  21630. major mode."
  21631. (if (let ((element (org-element-at-point)))
  21632. (and (eq (org-element-type element) 'src-block)
  21633. (< (save-excursion
  21634. (goto-char (org-element-property :post-affiliated element))
  21635. (line-end-position))
  21636. (point))
  21637. (> (save-excursion
  21638. (goto-char (org-element-property :end element))
  21639. (skip-chars-backward " \r\t\n")
  21640. (line-beginning-position))
  21641. (point))))
  21642. (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
  21643. (beginning-of-line)
  21644. (if (looking-at "\\s-*$") (delete-region (point) (point-at-eol))
  21645. (open-line 1))
  21646. (org-indent-line)
  21647. (insert "# ")))
  21648. (defvar comment-empty-lines) ; From newcomment.el.
  21649. (defun org-comment-or-uncomment-region (beg end &rest ignore)
  21650. "Comment or uncomment each non-blank line in the region.
  21651. Uncomment each non-blank line between BEG and END if it only
  21652. contains commented lines. Otherwise, comment them. If region is
  21653. strictly within a source block, use appropriate comment syntax."
  21654. (if (let ((element (org-element-at-point)))
  21655. (and (eq (org-element-type element) 'src-block)
  21656. (< (save-excursion
  21657. (goto-char (org-element-property :post-affiliated element))
  21658. (line-end-position))
  21659. beg)
  21660. (>= (save-excursion
  21661. (goto-char (org-element-property :end element))
  21662. (skip-chars-backward " \r\t\n")
  21663. (line-beginning-position))
  21664. end)))
  21665. (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
  21666. (save-restriction
  21667. ;; Restrict region
  21668. (narrow-to-region (save-excursion (goto-char beg)
  21669. (skip-chars-forward " \r\t\n" end)
  21670. (line-beginning-position))
  21671. (save-excursion (goto-char end)
  21672. (skip-chars-backward " \r\t\n" beg)
  21673. (line-end-position)))
  21674. (let ((uncommentp
  21675. ;; UNCOMMENTP is non-nil when every non blank line between
  21676. ;; BEG and END is a comment.
  21677. (save-excursion
  21678. (goto-char (point-min))
  21679. (while (and (not (eobp))
  21680. (let ((element (org-element-at-point)))
  21681. (and (eq (org-element-type element) 'comment)
  21682. (goto-char (min (point-max)
  21683. (org-element-property
  21684. :end element)))))))
  21685. (eobp))))
  21686. (if uncommentp
  21687. ;; Only blank lines and comments in region: uncomment it.
  21688. (save-excursion
  21689. (goto-char (point-min))
  21690. (while (not (eobp))
  21691. (when (looking-at "[ \t]*\\(#\\(?: \\|$\\)\\)")
  21692. (replace-match "" nil nil nil 1))
  21693. (forward-line)))
  21694. ;; Comment each line in region.
  21695. (let ((min-indent (point-max)))
  21696. ;; First find the minimum indentation across all lines.
  21697. (save-excursion
  21698. (goto-char (point-min))
  21699. (while (and (not (eobp)) (not (zerop min-indent)))
  21700. (unless (looking-at "[ \t]*$")
  21701. (setq min-indent (min min-indent (current-indentation))))
  21702. (forward-line)))
  21703. ;; Then loop over all lines.
  21704. (save-excursion
  21705. (goto-char (point-min))
  21706. (while (not (eobp))
  21707. (unless (and (not comment-empty-lines) (looking-at "[ \t]*$"))
  21708. ;; Don't get fooled by invisible text (e.g. link path)
  21709. ;; when moving to column MIN-INDENT.
  21710. (let ((buffer-invisibility-spec nil))
  21711. (org-move-to-column min-indent t))
  21712. (insert comment-start))
  21713. (forward-line)))))))))
  21714. (defun org-comment-dwim (arg)
  21715. "Call `comment-dwim' within a source edit buffer if needed."
  21716. (interactive "*P")
  21717. (if (org-in-src-block-p)
  21718. (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
  21719. (call-interactively 'comment-dwim)))
  21720. ;;; Timestamps API
  21721. ;; This section contains tools to operate on timestamp objects, as
  21722. ;; returned by, e.g. `org-element-context'.
  21723. (defun org-timestamp--to-internal-time (timestamp &optional end)
  21724. "Encode TIMESTAMP object into Emacs internal time.
  21725. Use end of date range or time range when END is non-nil."
  21726. (apply #'encode-time
  21727. (cons 0
  21728. (mapcar
  21729. (lambda (prop) (or (org-element-property prop timestamp) 0))
  21730. (if end '(:minute-end :hour-end :day-end :month-end :year-end)
  21731. '(:minute-start :hour-start :day-start :month-start
  21732. :year-start))))))
  21733. (defun org-timestamp-has-time-p (timestamp)
  21734. "Non-nil when TIMESTAMP has a time specified."
  21735. (org-element-property :hour-start timestamp))
  21736. (defun org-timestamp-format (timestamp format &optional end utc)
  21737. "Format a TIMESTAMP object into a string.
  21738. FORMAT is a format specifier to be passed to
  21739. `format-time-string'.
  21740. When optional argument END is non-nil, use end of date-range or
  21741. time-range, if possible.
  21742. When optional argument UTC is non-nil, time will be expressed as
  21743. Universal Time."
  21744. (format-time-string
  21745. format (org-timestamp--to-internal-time timestamp end) utc))
  21746. (defun org-timestamp-split-range (timestamp &optional end)
  21747. "Extract a TIMESTAMP object from a date or time range.
  21748. END, when non-nil, means extract the end of the range.
  21749. Otherwise, extract its start.
  21750. Return a new timestamp object."
  21751. (let ((type (org-element-property :type timestamp)))
  21752. (if (memq type '(active inactive diary)) timestamp
  21753. (let ((split-ts (org-element-copy timestamp)))
  21754. ;; Set new type.
  21755. (org-element-put-property
  21756. split-ts :type (if (eq type 'active-range) 'active 'inactive))
  21757. ;; Copy start properties over end properties if END is
  21758. ;; non-nil. Otherwise, copy end properties over `start' ones.
  21759. (let ((p-alist '((:minute-start . :minute-end)
  21760. (:hour-start . :hour-end)
  21761. (:day-start . :day-end)
  21762. (:month-start . :month-end)
  21763. (:year-start . :year-end))))
  21764. (dolist (p-cell p-alist)
  21765. (org-element-put-property
  21766. split-ts
  21767. (funcall (if end #'car #'cdr) p-cell)
  21768. (org-element-property
  21769. (funcall (if end #'cdr #'car) p-cell) split-ts)))
  21770. ;; Eventually refresh `:raw-value'.
  21771. (org-element-put-property split-ts :raw-value nil)
  21772. (org-element-put-property
  21773. split-ts :raw-value (org-element-interpret-data split-ts)))))))
  21774. (defun org-timestamp-translate (timestamp &optional boundary)
  21775. "Translate TIMESTAMP object to custom format.
  21776. Format string is defined in `org-time-stamp-custom-formats',
  21777. which see.
  21778. When optional argument BOUNDARY is non-nil, it is either the
  21779. symbol `start' or `end'. In this case, only translate the
  21780. starting or ending part of TIMESTAMP if it is a date or time
  21781. range. Otherwise, translate both parts.
  21782. Return timestamp as-is if `org-display-custom-times' is nil or if
  21783. it has a `diary' type."
  21784. (let ((type (org-element-property :type timestamp)))
  21785. (if (or (not org-display-custom-times) (eq type 'diary))
  21786. (org-element-interpret-data timestamp)
  21787. (let ((fmt (funcall (if (org-timestamp-has-time-p timestamp) #'cdr #'car)
  21788. org-time-stamp-custom-formats)))
  21789. (if (and (not boundary) (memq type '(active-range inactive-range)))
  21790. (concat (org-timestamp-format timestamp fmt)
  21791. "--"
  21792. (org-timestamp-format timestamp fmt t))
  21793. (org-timestamp-format timestamp fmt (eq boundary 'end)))))))
  21794. ;;; Other stuff.
  21795. (defun org-reftex-citation ()
  21796. "Use reftex-citation to insert a citation into the buffer.
  21797. This looks for a line like
  21798. #+BIBLIOGRAPHY: foo plain option:-d
  21799. and derives from it that foo.bib is the bibliography file relevant
  21800. for this document. It then installs the necessary environment for RefTeX
  21801. to work in this buffer and calls `reftex-citation' to insert a citation
  21802. into the buffer.
  21803. Export of such citations to both LaTeX and HTML is handled by the contributed
  21804. package ox-bibtex by Taru Karttunen."
  21805. (interactive)
  21806. (let ((reftex-docstruct-symbol 'rds)
  21807. (reftex-cite-format "\\cite{%l}")
  21808. rds bib)
  21809. (save-excursion
  21810. (save-restriction
  21811. (widen)
  21812. (let ((case-fold-search t)
  21813. (re "^[ \t]*#\\+BIBLIOGRAPHY:[ \t]+\\([^ \t\n]+\\)"))
  21814. (if (not (save-excursion
  21815. (or (re-search-forward re nil t)
  21816. (re-search-backward re nil t))))
  21817. (user-error "No bibliography defined in file")
  21818. (setq bib (concat (match-string 1) ".bib")
  21819. rds (list (list 'bib bib)))))))
  21820. (call-interactively 'reftex-citation)))
  21821. ;;;; Functions extending outline functionality
  21822. (defun org-beginning-of-line (&optional arg)
  21823. "Go to the beginning of the current line. If that is invisible, continue
  21824. to a visible line beginning. This makes the function of C-a more intuitive.
  21825. If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
  21826. first attempt, and only move to after the tags when the cursor is already
  21827. beyond the end of the headline."
  21828. (interactive "P")
  21829. (let ((pos (point))
  21830. (special (if (consp org-special-ctrl-a/e)
  21831. (car org-special-ctrl-a/e)
  21832. org-special-ctrl-a/e))
  21833. deactivate-mark refpos)
  21834. (if (org-bound-and-true-p visual-line-mode)
  21835. (beginning-of-visual-line 1)
  21836. (beginning-of-line 1))
  21837. (if (and arg (fboundp 'move-beginning-of-line))
  21838. (call-interactively 'move-beginning-of-line)
  21839. (if (bobp)
  21840. nil
  21841. (backward-char 1)
  21842. (if (org-truely-invisible-p)
  21843. (while (and (not (bobp)) (org-truely-invisible-p))
  21844. (backward-char 1)
  21845. (beginning-of-line 1))
  21846. (forward-char 1))))
  21847. (when special
  21848. (cond
  21849. ((and (looking-at org-complex-heading-regexp)
  21850. (= (char-after (match-end 1)) ?\ ))
  21851. (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
  21852. (point-at-eol)))
  21853. (goto-char
  21854. (if (eq special t)
  21855. (cond ((> pos refpos) refpos)
  21856. ((= pos (point)) refpos)
  21857. (t (point)))
  21858. (cond ((> pos (point)) (point))
  21859. ((not (eq last-command this-command)) (point))
  21860. (t refpos)))))
  21861. ((org-at-item-p)
  21862. ;; Being at an item and not looking at an the item means point
  21863. ;; was previously moved to beginning of a visual line, which
  21864. ;; doesn't contain the item. Therefore, do nothing special,
  21865. ;; just stay here.
  21866. (when (looking-at org-list-full-item-re)
  21867. ;; Set special position at first white space character after
  21868. ;; bullet, and check-box, if any.
  21869. (let ((after-bullet
  21870. (let ((box (match-end 3)))
  21871. (if (not box) (match-end 1)
  21872. (let ((after (char-after box)))
  21873. (if (and after (= after ? )) (1+ box) box))))))
  21874. ;; Special case: Move point to special position when
  21875. ;; currently after it or at beginning of line.
  21876. (if (eq special t)
  21877. (when (or (> pos after-bullet) (= (point) pos))
  21878. (goto-char after-bullet))
  21879. ;; Reversed case: Move point to special position when
  21880. ;; point was already at beginning of line and command is
  21881. ;; repeated.
  21882. (when (and (= (point) pos) (eq last-command this-command))
  21883. (goto-char after-bullet))))))))
  21884. (org-no-warnings
  21885. (and (featurep 'xemacs) (setq zmacs-region-stays t))))
  21886. (setq disable-point-adjustment
  21887. (or (not (invisible-p (point)))
  21888. (not (invisible-p (max (point-min) (1- (point))))))))
  21889. (defun org-end-of-line (&optional arg)
  21890. "Go to the end of the line.
  21891. If this is a headline, and `org-special-ctrl-a/e' is set, ignore
  21892. tags on the first attempt, and only move to after the tags when
  21893. the cursor is already beyond the end of the headline."
  21894. (interactive "P")
  21895. (let ((special (if (consp org-special-ctrl-a/e) (cdr org-special-ctrl-a/e)
  21896. org-special-ctrl-a/e))
  21897. (move-fun (cond ((org-bound-and-true-p visual-line-mode)
  21898. 'end-of-visual-line)
  21899. ((fboundp 'move-end-of-line) 'move-end-of-line)
  21900. (t 'end-of-line)))
  21901. deactivate-mark)
  21902. (if (or (not special) arg) (call-interactively move-fun)
  21903. (let* ((element (save-excursion (beginning-of-line)
  21904. (org-element-at-point)))
  21905. (type (org-element-type element)))
  21906. (cond
  21907. ((memq type '(headline inlinetask))
  21908. (let ((pos (point)))
  21909. (beginning-of-line 1)
  21910. (if (looking-at (org-re ".*?\\(?:\\([ \t]*\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*\\)?$"))
  21911. (if (eq special t)
  21912. (if (or (< pos (match-beginning 1)) (= pos (match-end 0)))
  21913. (goto-char (match-beginning 1))
  21914. (goto-char (match-end 0)))
  21915. (if (or (< pos (match-end 0))
  21916. (not (eq this-command last-command)))
  21917. (goto-char (match-end 0))
  21918. (goto-char (match-beginning 1))))
  21919. (call-interactively move-fun))))
  21920. ((outline-invisible-p (line-end-position))
  21921. ;; If element is hidden, `move-end-of-line' would put point
  21922. ;; after it. Use `end-of-line' to stay on current line.
  21923. (call-interactively 'end-of-line))
  21924. (t (call-interactively move-fun)))))
  21925. (org-no-warnings (and (featurep 'xemacs) (setq zmacs-region-stays t))))
  21926. (setq disable-point-adjustment
  21927. (or (not (invisible-p (point)))
  21928. (not (invisible-p (max (point-min) (1- (point))))))))
  21929. (define-key org-mode-map "\C-a" 'org-beginning-of-line)
  21930. (define-key org-mode-map "\C-e" 'org-end-of-line)
  21931. (defun org-backward-sentence (&optional arg)
  21932. "Go to beginning of sentence, or beginning of table field.
  21933. This will call `backward-sentence' or `org-table-beginning-of-field',
  21934. depending on context."
  21935. (interactive "P")
  21936. (let* ((element (org-element-at-point))
  21937. (contents-begin (org-element-property :contents-begin element))
  21938. (table (org-element-lineage element '(table) t)))
  21939. (if (and table
  21940. (> (point) contents-begin)
  21941. (<= (point) (org-element-property :contents-end table)))
  21942. (call-interactively #'org-table-beginning-of-field)
  21943. (save-restriction
  21944. (when (and contents-begin
  21945. (< (point-min) contents-begin)
  21946. (> (point) contents-begin))
  21947. (narrow-to-region contents-begin
  21948. (org-element-property :contents-end element)))
  21949. (call-interactively #'backward-sentence)))))
  21950. (defun org-forward-sentence (&optional arg)
  21951. "Go to end of sentence, or end of table field.
  21952. This will call `forward-sentence' or `org-table-end-of-field',
  21953. depending on context."
  21954. (interactive "P")
  21955. (let* ((element (org-element-at-point))
  21956. (contents-end (org-element-property :contents-end element))
  21957. (table (org-element-lineage element '(table) t)))
  21958. (if (and table
  21959. (>= (point) (org-element-property :contents-begin table))
  21960. (< (point) contents-end))
  21961. (call-interactively #'org-table-end-of-field)
  21962. (save-restriction
  21963. (when (and contents-end
  21964. (> (point-max) contents-end)
  21965. ;; Skip blank lines between elements.
  21966. (< (org-element-property :end element)
  21967. (save-excursion (goto-char contents-end)
  21968. (skip-chars-forward " \r\t\n"))))
  21969. (narrow-to-region (org-element-property :contents-begin element)
  21970. contents-end))
  21971. (call-interactively #'forward-sentence)))))
  21972. (define-key org-mode-map "\M-a" 'org-backward-sentence)
  21973. (define-key org-mode-map "\M-e" 'org-forward-sentence)
  21974. (defun org-kill-line (&optional arg)
  21975. "Kill line, to tags or end of line."
  21976. (interactive "P")
  21977. (cond
  21978. ((or (not org-special-ctrl-k)
  21979. (bolp)
  21980. (not (org-at-heading-p)))
  21981. (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
  21982. org-ctrl-k-protect-subtree)
  21983. (if (or (eq org-ctrl-k-protect-subtree 'error)
  21984. (not (y-or-n-p "Kill hidden subtree along with headline? ")))
  21985. (user-error "C-k aborted as it would kill a hidden subtree")))
  21986. (call-interactively
  21987. (if (org-bound-and-true-p visual-line-mode) 'kill-visual-line 'kill-line)))
  21988. ((looking-at (org-re ".*?\\S-\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$"))
  21989. (kill-region (point) (match-beginning 1))
  21990. (org-set-tags nil t))
  21991. (t (kill-region (point) (point-at-eol)))))
  21992. (define-key org-mode-map "\C-k" 'org-kill-line)
  21993. (defun org-yank (&optional arg)
  21994. "Yank. If the kill is a subtree, treat it specially.
  21995. This command will look at the current kill and check if is a single
  21996. subtree, or a series of subtrees[1]. If it passes the test, and if the
  21997. cursor is at the beginning of a line or after the stars of a currently
  21998. empty headline, then the yank is handled specially. How exactly depends
  21999. on the value of the following variables, both set by default.
  22000. `org-yank-folded-subtrees'
  22001. When set, the subtree(s) will be folded after insertion, but only
  22002. if doing so would now swallow text after the yanked text.
  22003. `org-yank-adjusted-subtrees'
  22004. When set, the subtree will be promoted or demoted in order to
  22005. fit into the local outline tree structure, which means that the
  22006. level will be adjusted so that it becomes the smaller one of the
  22007. two *visible* surrounding headings.
  22008. Any prefix to this command will cause `yank' to be called directly with
  22009. no special treatment. In particular, a simple \\[universal-argument] prefix \
  22010. will just
  22011. plainly yank the text as it is.
  22012. \[1] The test checks if the first non-white line is a heading
  22013. and if there are no other headings with fewer stars."
  22014. (interactive "P")
  22015. (org-yank-generic 'yank arg))
  22016. (defun org-yank-generic (command arg)
  22017. "Perform some yank-like command.
  22018. This function implements the behavior described in the `org-yank'
  22019. documentation. However, it has been generalized to work for any
  22020. interactive command with similar behavior."
  22021. ;; pretend to be command COMMAND
  22022. (setq this-command command)
  22023. (if arg
  22024. (call-interactively command)
  22025. (let ((subtreep ; is kill a subtree, and the yank position appropriate?
  22026. (and (org-kill-is-subtree-p)
  22027. (or (bolp)
  22028. (and (looking-at "[ \t]*$")
  22029. (string-match
  22030. "\\`\\*+\\'"
  22031. (buffer-substring (point-at-bol) (point)))))))
  22032. swallowp)
  22033. (cond
  22034. ((and subtreep org-yank-folded-subtrees)
  22035. (let ((beg (point))
  22036. end)
  22037. (if (and subtreep org-yank-adjusted-subtrees)
  22038. (org-paste-subtree nil nil 'for-yank)
  22039. (call-interactively command))
  22040. (setq end (point))
  22041. (goto-char beg)
  22042. (when (and (bolp) subtreep
  22043. (not (setq swallowp
  22044. (org-yank-folding-would-swallow-text beg end))))
  22045. (org-with-limited-levels
  22046. (or (looking-at org-outline-regexp)
  22047. (re-search-forward org-outline-regexp-bol end t))
  22048. (while (and (< (point) end) (looking-at org-outline-regexp))
  22049. (hide-subtree)
  22050. (org-cycle-show-empty-lines 'folded)
  22051. (condition-case nil
  22052. (outline-forward-same-level 1)
  22053. (error (goto-char end))))))
  22054. (when swallowp
  22055. (message
  22056. "Inserted text not folded because that would swallow text"))
  22057. (goto-char end)
  22058. (skip-chars-forward " \t\n\r")
  22059. (beginning-of-line 1)
  22060. (push-mark beg 'nomsg)))
  22061. ((and subtreep org-yank-adjusted-subtrees)
  22062. (let ((beg (point-at-bol)))
  22063. (org-paste-subtree nil nil 'for-yank)
  22064. (push-mark beg 'nomsg)))
  22065. (t
  22066. (call-interactively command))))))
  22067. (defun org-yank-folding-would-swallow-text (beg end)
  22068. "Would hide-subtree at BEG swallow any text after END?"
  22069. (let (level)
  22070. (org-with-limited-levels
  22071. (save-excursion
  22072. (goto-char beg)
  22073. (when (or (looking-at org-outline-regexp)
  22074. (re-search-forward org-outline-regexp-bol end t))
  22075. (setq level (org-outline-level)))
  22076. (goto-char end)
  22077. (skip-chars-forward " \t\r\n\v\f")
  22078. (if (or (eobp)
  22079. (and (bolp) (looking-at org-outline-regexp)
  22080. (<= (org-outline-level) level)))
  22081. nil ; Nothing would be swallowed
  22082. t))))) ; something would swallow
  22083. (define-key org-mode-map "\C-y" 'org-yank)
  22084. (defun org-truely-invisible-p ()
  22085. "Check if point is at a character currently not visible.
  22086. This version does not only check the character property, but also
  22087. `visible-mode'."
  22088. ;; Early versions of noutline don't have `outline-invisible-p'.
  22089. (if (org-bound-and-true-p visible-mode)
  22090. nil
  22091. (outline-invisible-p)))
  22092. (defun org-invisible-p2 ()
  22093. "Check if point is at a character currently not visible."
  22094. (save-excursion
  22095. (if (and (eolp) (not (bobp))) (backward-char 1))
  22096. ;; Early versions of noutline don't have `outline-invisible-p'.
  22097. (outline-invisible-p)))
  22098. (defun org-back-to-heading (&optional invisible-ok)
  22099. "Call `outline-back-to-heading', but provide a better error message."
  22100. (condition-case nil
  22101. (outline-back-to-heading invisible-ok)
  22102. (error (error "Before first headline at position %d in buffer %s"
  22103. (point) (current-buffer)))))
  22104. (defun org-before-first-heading-p ()
  22105. "Before first heading?"
  22106. (save-excursion
  22107. (end-of-line)
  22108. (null (re-search-backward org-outline-regexp-bol nil t))))
  22109. (defun org-at-heading-p (&optional ignored)
  22110. (outline-on-heading-p t))
  22111. ;; Compatibility alias with Org versions < 7.8.03
  22112. (defalias 'org-on-heading-p 'org-at-heading-p)
  22113. (defun org-in-commented-heading-p (&optional no-inheritance)
  22114. "Non-nil if point is under a commented heading.
  22115. This function also checks ancestors of the current headline,
  22116. unless optional argument NO-INHERITANCE is non-nil."
  22117. (cond
  22118. ((org-before-first-heading-p) nil)
  22119. ((let ((headline (nth 4 (org-heading-components))))
  22120. (and headline
  22121. (let ((case-fold-search nil))
  22122. (org-string-match-p (concat "^" org-comment-string "\\(?: \\|$\\)")
  22123. headline)))))
  22124. (no-inheritance nil)
  22125. (t
  22126. (save-excursion (and (org-up-heading-safe) (org-in-commented-heading-p))))))
  22127. (defun org-at-comment-p nil
  22128. "Is cursor in a commented line?"
  22129. (save-excursion
  22130. (save-match-data
  22131. (beginning-of-line)
  22132. (looking-at "^[ \t]*# "))))
  22133. (defun org-at-drawer-p nil
  22134. "Is cursor at a drawer keyword?"
  22135. (save-excursion
  22136. (move-beginning-of-line 1)
  22137. (looking-at org-drawer-regexp)))
  22138. (defun org-at-block-p nil
  22139. "Is cursor at a block keyword?"
  22140. (save-excursion
  22141. (move-beginning-of-line 1)
  22142. (looking-at org-block-regexp)))
  22143. (defun org-point-at-end-of-empty-headline ()
  22144. "If point is at the end of an empty headline, return t, else nil.
  22145. If the heading only contains a TODO keyword, it is still still considered
  22146. empty."
  22147. (and (looking-at "[ \t]*$")
  22148. (when org-todo-line-regexp
  22149. (save-excursion
  22150. (beginning-of-line 1)
  22151. (let ((case-fold-search nil))
  22152. (looking-at org-todo-line-regexp)
  22153. (string= (match-string 3) ""))))))
  22154. (defun org-at-heading-or-item-p ()
  22155. (or (org-at-heading-p) (org-at-item-p)))
  22156. (defun org-at-target-p ()
  22157. (or (org-in-regexp org-radio-target-regexp)
  22158. (org-in-regexp org-target-regexp)))
  22159. ;; Compatibility alias with Org versions < 7.8.03
  22160. (defalias 'org-on-target-p 'org-at-target-p)
  22161. (defun org-up-heading-all (arg)
  22162. "Move to the heading line of which the present line is a subheading.
  22163. This function considers both visible and invisible heading lines.
  22164. With argument, move up ARG levels."
  22165. (if (fboundp 'outline-up-heading-all)
  22166. (outline-up-heading-all arg) ; emacs 21 version of outline.el
  22167. (outline-up-heading arg t))) ; emacs 22 version of outline.el
  22168. (defun org-up-heading-safe ()
  22169. "Move to the heading line of which the present line is a subheading.
  22170. This version will not throw an error. It will return the level of the
  22171. headline found, or nil if no higher level is found.
  22172. Also, this function will be a lot faster than `outline-up-heading',
  22173. because it relies on stars being the outline starters. This can really
  22174. make a significant difference in outlines with very many siblings."
  22175. (when (ignore-errors (org-back-to-heading t))
  22176. (let ((level-up (1- (funcall outline-level))))
  22177. (and (> level-up 0)
  22178. (re-search-backward (format "^\\*\\{1,%d\\} " level-up) nil t)
  22179. (funcall outline-level)))))
  22180. (defun org-first-sibling-p ()
  22181. "Is this heading the first child of its parents?"
  22182. (interactive)
  22183. (let ((re org-outline-regexp-bol)
  22184. level l)
  22185. (unless (org-at-heading-p t)
  22186. (user-error "Not at a heading"))
  22187. (setq level (funcall outline-level))
  22188. (save-excursion
  22189. (if (not (re-search-backward re nil t))
  22190. t
  22191. (setq l (funcall outline-level))
  22192. (< l level)))))
  22193. (defun org-goto-sibling (&optional previous)
  22194. "Goto the next sibling, even if it is invisible.
  22195. When PREVIOUS is set, go to the previous sibling instead. Returns t
  22196. when a sibling was found. When none is found, return nil and don't
  22197. move point."
  22198. (let ((fun (if previous 're-search-backward 're-search-forward))
  22199. (pos (point))
  22200. (re org-outline-regexp-bol)
  22201. level l)
  22202. (when (ignore-errors (org-back-to-heading t))
  22203. (setq level (funcall outline-level))
  22204. (catch 'exit
  22205. (or previous (forward-char 1))
  22206. (while (funcall fun re nil t)
  22207. (setq l (funcall outline-level))
  22208. (when (< l level) (goto-char pos) (throw 'exit nil))
  22209. (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
  22210. (goto-char pos)
  22211. nil))))
  22212. (defun org-show-siblings ()
  22213. "Show all siblings of the current headline."
  22214. (save-excursion
  22215. (while (org-goto-sibling) (org-flag-heading nil)))
  22216. (save-excursion
  22217. (while (org-goto-sibling 'previous)
  22218. (org-flag-heading nil))))
  22219. (defun org-goto-first-child ()
  22220. "Goto the first child, even if it is invisible.
  22221. Return t when a child was found. Otherwise don't move point and
  22222. return nil."
  22223. (let (level (pos (point)) (re org-outline-regexp-bol))
  22224. (when (ignore-errors (org-back-to-heading t))
  22225. (setq level (outline-level))
  22226. (forward-char 1)
  22227. (if (and (re-search-forward re nil t) (> (outline-level) level))
  22228. (progn (goto-char (match-beginning 0)) t)
  22229. (goto-char pos) nil))))
  22230. (defun org-show-hidden-entry ()
  22231. "Show an entry where even the heading is hidden."
  22232. (save-excursion
  22233. (org-show-entry)))
  22234. (defun org-flag-heading (flag &optional entry)
  22235. "Flag the current heading. FLAG non-nil means make invisible.
  22236. When ENTRY is non-nil, show the entire entry."
  22237. (save-excursion
  22238. (org-back-to-heading t)
  22239. ;; Check if we should show the entire entry
  22240. (if entry
  22241. (progn
  22242. (org-show-entry)
  22243. (save-excursion
  22244. (and (outline-next-heading)
  22245. (org-flag-heading nil))))
  22246. (outline-flag-region (max (point-min) (1- (point)))
  22247. (save-excursion (outline-end-of-heading) (point))
  22248. flag))))
  22249. (defun org-get-next-sibling ()
  22250. "Move to next heading of the same level, and return point.
  22251. If there is no such heading, return nil.
  22252. This is like outline-next-sibling, but invisible headings are ok."
  22253. (let ((level (funcall outline-level)))
  22254. (outline-next-heading)
  22255. (while (and (not (eobp)) (> (funcall outline-level) level))
  22256. (outline-next-heading))
  22257. (if (or (eobp) (< (funcall outline-level) level))
  22258. nil
  22259. (point))))
  22260. (defun org-get-last-sibling ()
  22261. "Move to previous heading of the same level, and return point.
  22262. If there is no such heading, return nil."
  22263. (let ((opoint (point))
  22264. (level (funcall outline-level)))
  22265. (outline-previous-heading)
  22266. (when (and (/= (point) opoint) (outline-on-heading-p t))
  22267. (while (and (> (funcall outline-level) level)
  22268. (not (bobp)))
  22269. (outline-previous-heading))
  22270. (if (< (funcall outline-level) level)
  22271. nil
  22272. (point)))))
  22273. (defun org-end-of-subtree (&optional invisible-ok to-heading)
  22274. "Goto to the end of a subtree."
  22275. ;; This contains an exact copy of the original function, but it uses
  22276. ;; `org-back-to-heading', to make it work also in invisible
  22277. ;; trees. And is uses an invisible-ok argument.
  22278. ;; Under Emacs this is not needed, but the old outline.el needs this fix.
  22279. ;; Furthermore, when used inside Org, finding the end of a large subtree
  22280. ;; with many children and grandchildren etc, this can be much faster
  22281. ;; than the outline version.
  22282. (org-back-to-heading invisible-ok)
  22283. (let ((first t)
  22284. (level (funcall outline-level)))
  22285. (if (and (derived-mode-p 'org-mode) (< level 1000))
  22286. ;; A true heading (not a plain list item), in Org-mode
  22287. ;; This means we can easily find the end by looking
  22288. ;; only for the right number of stars. Using a regexp to do
  22289. ;; this is so much faster than using a Lisp loop.
  22290. (let ((re (concat "^\\*\\{1," (int-to-string level) "\\} ")))
  22291. (forward-char 1)
  22292. (and (re-search-forward re nil 'move) (beginning-of-line 1)))
  22293. ;; something else, do it the slow way
  22294. (while (and (not (eobp))
  22295. (or first (> (funcall outline-level) level)))
  22296. (setq first nil)
  22297. (outline-next-heading)))
  22298. (unless to-heading
  22299. (if (memq (preceding-char) '(?\n ?\^M))
  22300. (progn
  22301. ;; Go to end of line before heading
  22302. (forward-char -1)
  22303. (if (memq (preceding-char) '(?\n ?\^M))
  22304. ;; leave blank line before heading
  22305. (forward-char -1))))))
  22306. (point))
  22307. (defun org-end-of-meta-data (&optional full)
  22308. "Skip planning line and properties drawer in current entry.
  22309. When optional argument FULL is non-nil, also skip empty lines,
  22310. clocking lines and regular drawers at the beginning of the
  22311. entry."
  22312. (org-back-to-heading t)
  22313. (forward-line)
  22314. (when (org-looking-at-p org-planning-line-re) (forward-line))
  22315. (when (looking-at org-property-drawer-re)
  22316. (goto-char (match-end 0))
  22317. (forward-line))
  22318. (when (and full (not (org-at-heading-p)))
  22319. (catch 'exit
  22320. (let ((end (save-excursion (outline-next-heading) (point)))
  22321. (re (concat "[ \t]*$" "\\|" org-clock-line-re)))
  22322. (while (not (eobp))
  22323. (cond ((org-looking-at-p org-drawer-regexp)
  22324. (if (re-search-forward "^[ \t]*:END:[ \t]*$" end t)
  22325. (forward-line)
  22326. (throw 'exit t)))
  22327. ((org-looking-at-p re) (forward-line))
  22328. (t (throw 'exit t))))))))
  22329. (defun org-forward-heading-same-level (arg &optional invisible-ok)
  22330. "Move forward to the ARG'th subheading at same level as this one.
  22331. Stop at the first and last subheadings of a superior heading.
  22332. Normally this only looks at visible headings, but when INVISIBLE-OK is
  22333. non-nil it will also look at invisible ones."
  22334. (interactive "p")
  22335. (if (not (ignore-errors (org-back-to-heading invisible-ok)))
  22336. (if (and arg (< arg 0))
  22337. (goto-char (point-min))
  22338. (outline-next-heading))
  22339. (org-at-heading-p)
  22340. (let ((level (- (match-end 0) (match-beginning 0) 1))
  22341. (f (if (and arg (< arg 0))
  22342. 're-search-backward
  22343. 're-search-forward))
  22344. (count (if arg (abs arg) 1))
  22345. (result (point)))
  22346. (while (and (prog1 (> count 0)
  22347. (forward-char (if (and arg (< arg 0)) -1 1)))
  22348. (funcall f org-outline-regexp-bol nil 'move))
  22349. (let ((l (- (match-end 0) (match-beginning 0) 1)))
  22350. (cond ((< l level) (setq count 0))
  22351. ((and (= l level)
  22352. (or invisible-ok
  22353. (progn
  22354. (goto-char (line-beginning-position))
  22355. (not (outline-invisible-p)))))
  22356. (setq count (1- count))
  22357. (when (eq l level)
  22358. (setq result (point)))))))
  22359. (goto-char result))
  22360. (beginning-of-line 1)))
  22361. (defun org-backward-heading-same-level (arg &optional invisible-ok)
  22362. "Move backward to the ARG'th subheading at same level as this one.
  22363. Stop at the first and last subheadings of a superior heading."
  22364. (interactive "p")
  22365. (org-forward-heading-same-level (if arg (- arg) -1) invisible-ok))
  22366. (defun org-next-visible-heading (arg)
  22367. "Move to the next visible heading.
  22368. This function wraps `outline-next-visible-heading' with
  22369. `org-with-limited-levels' in order to skip over inline tasks and
  22370. respect customization of `org-odd-levels-only'."
  22371. (interactive "p")
  22372. (org-with-limited-levels
  22373. (outline-next-visible-heading arg)))
  22374. (defun org-previous-visible-heading (arg)
  22375. "Move to the next visible heading.
  22376. This function wraps `outline-previous-visible-heading' with
  22377. `org-with-limited-levels' in order to skip over inline tasks and
  22378. respect customization of `org-odd-levels-only'."
  22379. (interactive "p")
  22380. (org-with-limited-levels
  22381. (outline-previous-visible-heading arg)))
  22382. (defun org-next-block (arg &optional backward block-regexp)
  22383. "Jump to the next block.
  22384. With a prefix argument ARG, jump forward ARG many blocks.
  22385. When BACKWARD is non-nil, jump to the previous block.
  22386. When BLOCK-REGEXP is non-nil, use this regexp to find blocks.
  22387. Match data is set according to this regexp when the function
  22388. returns.
  22389. Return point at beginning of the opening line of found block.
  22390. Throw an error if no block is found."
  22391. (interactive "p")
  22392. (let ((re (or block-regexp "^[ \t]*#\\+BEGIN"))
  22393. (case-fold-search t)
  22394. (search-fn (if backward #'re-search-backward #'re-search-forward))
  22395. (count (or arg 1))
  22396. (origin (point))
  22397. last-element)
  22398. (if backward (beginning-of-line) (end-of-line))
  22399. (while (and (> count 0) (funcall search-fn re nil t))
  22400. (let ((element (save-excursion
  22401. (goto-char (match-beginning 0))
  22402. (save-match-data (org-element-at-point)))))
  22403. (when (and (memq (org-element-type element)
  22404. '(center-block comment-block dynamic-block
  22405. example-block export-block quote-block
  22406. special-block src-block verse-block))
  22407. (<= (match-beginning 0)
  22408. (org-element-property :post-affiliated element)))
  22409. (setq last-element element)
  22410. (decf count))))
  22411. (if (= count 0)
  22412. (prog1 (goto-char (org-element-property :post-affiliated last-element))
  22413. (save-match-data (org-show-context)))
  22414. (goto-char origin)
  22415. (user-error "No %s code blocks" (if backward "previous" "further")))))
  22416. (defun org-previous-block (arg &optional block-regexp)
  22417. "Jump to the previous block.
  22418. With a prefix argument ARG, jump backward ARG many source blocks.
  22419. When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
  22420. (interactive "p")
  22421. (org-next-block arg t block-regexp))
  22422. (defun org-forward-paragraph ()
  22423. "Move forward to beginning of next paragraph or equivalent.
  22424. The function moves point to the beginning of the next visible
  22425. structural element, which can be a paragraph, a table, a list
  22426. item, etc. It also provides some special moves for convenience:
  22427. - On an affiliated keyword, jump to the beginning of the
  22428. relative element.
  22429. - On an item or a footnote definition, move to the second
  22430. element inside, if any.
  22431. - On a table or a property drawer, jump after it.
  22432. - On a verse or source block, stop after blank lines."
  22433. (interactive)
  22434. (when (eobp) (user-error "Cannot move further down"))
  22435. (let* ((deactivate-mark nil)
  22436. (element (org-element-at-point))
  22437. (type (org-element-type element))
  22438. (post-affiliated (org-element-property :post-affiliated element))
  22439. (contents-begin (org-element-property :contents-begin element))
  22440. (contents-end (org-element-property :contents-end element))
  22441. (end (let ((end (org-element-property :end element)) (parent element))
  22442. (while (and (setq parent (org-element-property :parent parent))
  22443. (= (org-element-property :contents-end parent) end))
  22444. (setq end (org-element-property :end parent)))
  22445. end)))
  22446. (cond ((not element)
  22447. (skip-chars-forward " \r\t\n")
  22448. (or (eobp) (beginning-of-line)))
  22449. ;; On affiliated keywords, move to element's beginning.
  22450. ((< (point) post-affiliated)
  22451. (goto-char post-affiliated))
  22452. ;; At a table row, move to the end of the table. Similarly,
  22453. ;; at a node property, move to the end of the property
  22454. ;; drawer.
  22455. ((memq type '(node-property table-row))
  22456. (goto-char (org-element-property
  22457. :end (org-element-property :parent element))))
  22458. ((memq type '(property-drawer table)) (goto-char end))
  22459. ;; Consider blank lines as separators in verse and source
  22460. ;; blocks to ease editing.
  22461. ((memq type '(src-block verse-block))
  22462. (when (eq type 'src-block)
  22463. (setq contents-end
  22464. (save-excursion (goto-char end)
  22465. (skip-chars-backward " \r\t\n")
  22466. (line-beginning-position))))
  22467. (beginning-of-line)
  22468. (when (looking-at "[ \t]*$") (skip-chars-forward " \r\t\n"))
  22469. (if (not (re-search-forward "^[ \t]*$" contents-end t))
  22470. (goto-char end)
  22471. (skip-chars-forward " \r\t\n")
  22472. (if (= (point) contents-end) (goto-char end)
  22473. (beginning-of-line))))
  22474. ;; With no contents, just skip element.
  22475. ((not contents-begin) (goto-char end))
  22476. ;; If contents are invisible, skip the element altogether.
  22477. ((outline-invisible-p (line-end-position))
  22478. (case type
  22479. (headline
  22480. (org-with-limited-levels (outline-next-visible-heading 1)))
  22481. ;; At a plain list, make sure we move to the next item
  22482. ;; instead of skipping the whole list.
  22483. (plain-list (forward-char)
  22484. (org-forward-paragraph))
  22485. (otherwise (goto-char end))))
  22486. ((>= (point) contents-end) (goto-char end))
  22487. ((>= (point) contents-begin)
  22488. ;; This can only happen on paragraphs and plain lists.
  22489. (case type
  22490. (paragraph (goto-char end))
  22491. ;; At a plain list, try to move to second element in
  22492. ;; first item, if possible.
  22493. (plain-list (end-of-line)
  22494. (org-forward-paragraph))))
  22495. ;; When contents start on the middle of a line (e.g. in
  22496. ;; items and footnote definitions), try to reach first
  22497. ;; element starting after current line.
  22498. ((> (line-end-position) contents-begin)
  22499. (end-of-line)
  22500. (org-forward-paragraph))
  22501. (t (goto-char contents-begin)))))
  22502. (defun org-backward-paragraph ()
  22503. "Move backward to start of previous paragraph or equivalent.
  22504. The function moves point to the beginning of the current
  22505. structural element, which can be a paragraph, a table, a list
  22506. item, etc., or to the beginning of the previous visible one if
  22507. point is already there. It also provides some special moves for
  22508. convenience:
  22509. - On an affiliated keyword, jump to the first one.
  22510. - On a table or a property drawer, move to its beginning.
  22511. - On a verse or source block, stop before blank lines."
  22512. (interactive)
  22513. (when (bobp) (user-error "Cannot move further up"))
  22514. (let* ((deactivate-mark nil)
  22515. (element (org-element-at-point))
  22516. (type (org-element-type element))
  22517. (contents-begin (org-element-property :contents-begin element))
  22518. (contents-end (org-element-property :contents-end element))
  22519. (post-affiliated (org-element-property :post-affiliated element))
  22520. (begin (org-element-property :begin element)))
  22521. (cond
  22522. ((not element) (goto-char (point-min)))
  22523. ((= (point) begin)
  22524. (backward-char)
  22525. (org-backward-paragraph))
  22526. ((<= (point) post-affiliated) (goto-char begin))
  22527. ((memq type '(node-property table-row))
  22528. (goto-char (org-element-property
  22529. :post-affiliated (org-element-property :parent element))))
  22530. ((memq type '(property-drawer table)) (goto-char begin))
  22531. ((memq type '(src-block verse-block))
  22532. (when (eq type 'src-block)
  22533. (setq contents-begin
  22534. (save-excursion (goto-char begin) (forward-line) (point))))
  22535. (if (= (point) contents-begin) (goto-char post-affiliated)
  22536. ;; Inside a verse block, see blank lines as paragraph
  22537. ;; separators.
  22538. (let ((origin (point)))
  22539. (skip-chars-backward " \r\t\n" contents-begin)
  22540. (when (re-search-backward "^[ \t]*$" contents-begin 'move)
  22541. (skip-chars-forward " \r\t\n" origin)
  22542. (if (= (point) origin) (goto-char contents-begin)
  22543. (beginning-of-line))))))
  22544. ((not contents-begin) (goto-char (or post-affiliated begin)))
  22545. ((eq type 'paragraph)
  22546. (goto-char contents-begin)
  22547. ;; When at first paragraph in an item or a footnote definition,
  22548. ;; move directly to beginning of line.
  22549. (let ((parent-contents
  22550. (org-element-property
  22551. :contents-begin (org-element-property :parent element))))
  22552. (when (and parent-contents (= parent-contents contents-begin))
  22553. (beginning-of-line))))
  22554. ;; At the end of a greater element, move to the beginning of the
  22555. ;; last element within.
  22556. ((>= (point) contents-end)
  22557. (goto-char (1- contents-end))
  22558. (org-backward-paragraph))
  22559. (t (goto-char (or post-affiliated begin))))
  22560. ;; Ensure we never leave point invisible.
  22561. (when (outline-invisible-p (point)) (beginning-of-visual-line))))
  22562. (defun org-forward-element ()
  22563. "Move forward by one element.
  22564. Move to the next element at the same level, when possible."
  22565. (interactive)
  22566. (cond ((eobp) (user-error "Cannot move further down"))
  22567. ((org-with-limited-levels (org-at-heading-p))
  22568. (let ((origin (point)))
  22569. (goto-char (org-end-of-subtree nil t))
  22570. (unless (org-with-limited-levels (org-at-heading-p))
  22571. (goto-char origin)
  22572. (user-error "Cannot move further down"))))
  22573. (t
  22574. (let* ((elem (org-element-at-point))
  22575. (end (org-element-property :end elem))
  22576. (parent (org-element-property :parent elem)))
  22577. (cond ((and parent (= (org-element-property :contents-end parent) end))
  22578. (goto-char (org-element-property :end parent)))
  22579. ((integer-or-marker-p end) (goto-char end))
  22580. (t (message "No element at point")))))))
  22581. (defun org-backward-element ()
  22582. "Move backward by one element.
  22583. Move to the previous element at the same level, when possible."
  22584. (interactive)
  22585. (cond ((bobp) (user-error "Cannot move further up"))
  22586. ((org-with-limited-levels (org-at-heading-p))
  22587. ;; At a headline, move to the previous one, if any, or stay
  22588. ;; here.
  22589. (let ((origin (point)))
  22590. (org-with-limited-levels (org-backward-heading-same-level 1))
  22591. ;; When current headline has no sibling above, move to its
  22592. ;; parent.
  22593. (when (= (point) origin)
  22594. (or (org-with-limited-levels (org-up-heading-safe))
  22595. (progn (goto-char origin)
  22596. (user-error "Cannot move further up"))))))
  22597. (t
  22598. (let* ((elem (org-element-at-point))
  22599. (beg (org-element-property :begin elem)))
  22600. (cond
  22601. ;; Move to beginning of current element if point isn't
  22602. ;; there already.
  22603. ((null beg) (message "No element at point"))
  22604. ((/= (point) beg) (goto-char beg))
  22605. (t (goto-char beg)
  22606. (skip-chars-backward " \r\t\n")
  22607. (unless (bobp)
  22608. (let ((prev (org-element-at-point)))
  22609. (goto-char (org-element-property :begin prev))
  22610. (while (and (setq prev (org-element-property :parent prev))
  22611. (<= (org-element-property :end prev) beg))
  22612. (goto-char (org-element-property :begin prev)))))))))))
  22613. (defun org-up-element ()
  22614. "Move to upper element."
  22615. (interactive)
  22616. (if (org-with-limited-levels (org-at-heading-p))
  22617. (unless (org-up-heading-safe) (user-error "No surrounding element"))
  22618. (let* ((elem (org-element-at-point))
  22619. (parent (org-element-property :parent elem)))
  22620. (if parent (goto-char (org-element-property :begin parent))
  22621. (if (org-with-limited-levels (org-before-first-heading-p))
  22622. (user-error "No surrounding element")
  22623. (org-with-limited-levels (org-back-to-heading)))))))
  22624. (defvar org-element-greater-elements)
  22625. (defun org-down-element ()
  22626. "Move to inner element."
  22627. (interactive)
  22628. (let ((element (org-element-at-point)))
  22629. (cond
  22630. ((memq (org-element-type element) '(plain-list table))
  22631. (goto-char (org-element-property :contents-begin element))
  22632. (forward-char))
  22633. ((memq (org-element-type element) org-element-greater-elements)
  22634. ;; If contents are hidden, first disclose them.
  22635. (when (outline-invisible-p (line-end-position)) (org-cycle))
  22636. (goto-char (or (org-element-property :contents-begin element)
  22637. (user-error "No content for this element"))))
  22638. (t (user-error "No inner element")))))
  22639. (defun org-drag-element-backward ()
  22640. "Move backward element at point."
  22641. (interactive)
  22642. (if (org-with-limited-levels (org-at-heading-p)) (org-move-subtree-up)
  22643. (let* ((elem (org-element-at-point))
  22644. (prev-elem
  22645. (save-excursion
  22646. (goto-char (org-element-property :begin elem))
  22647. (skip-chars-backward " \r\t\n")
  22648. (unless (bobp)
  22649. (let* ((beg (org-element-property :begin elem))
  22650. (prev (org-element-at-point))
  22651. (up prev))
  22652. (while (and (setq up (org-element-property :parent up))
  22653. (<= (org-element-property :end up) beg))
  22654. (setq prev up))
  22655. prev)))))
  22656. ;; Error out if no previous element or previous element is
  22657. ;; a parent of the current one.
  22658. (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
  22659. (user-error "Cannot drag element backward")
  22660. (let ((pos (point)))
  22661. (org-element-swap-A-B prev-elem elem)
  22662. (goto-char (+ (org-element-property :begin prev-elem)
  22663. (- pos (org-element-property :begin elem)))))))))
  22664. (defun org-drag-element-forward ()
  22665. "Move forward element at point."
  22666. (interactive)
  22667. (let* ((pos (point))
  22668. (elem (org-element-at-point)))
  22669. (when (= (point-max) (org-element-property :end elem))
  22670. (user-error "Cannot drag element forward"))
  22671. (goto-char (org-element-property :end elem))
  22672. (let ((next-elem (org-element-at-point)))
  22673. (when (or (org-element-nested-p elem next-elem)
  22674. (and (eq (org-element-type next-elem) 'headline)
  22675. (not (eq (org-element-type elem) 'headline))))
  22676. (goto-char pos)
  22677. (user-error "Cannot drag element forward"))
  22678. ;; Compute new position of point: it's shifted by NEXT-ELEM
  22679. ;; body's length (without final blanks) and by the length of
  22680. ;; blanks between ELEM and NEXT-ELEM.
  22681. (let ((size-next (- (save-excursion
  22682. (goto-char (org-element-property :end next-elem))
  22683. (skip-chars-backward " \r\t\n")
  22684. (forward-line)
  22685. ;; Small correction if buffer doesn't end
  22686. ;; with a newline character.
  22687. (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
  22688. (org-element-property :begin next-elem)))
  22689. (size-blank (- (org-element-property :end elem)
  22690. (save-excursion
  22691. (goto-char (org-element-property :end elem))
  22692. (skip-chars-backward " \r\t\n")
  22693. (forward-line)
  22694. (point)))))
  22695. (org-element-swap-A-B elem next-elem)
  22696. (goto-char (+ pos size-next size-blank))))))
  22697. (defun org-drag-line-forward (arg)
  22698. "Drag the line at point ARG lines forward."
  22699. (interactive "p")
  22700. (dotimes (n (abs arg))
  22701. (let ((c (current-column)))
  22702. (if (< 0 arg)
  22703. (progn
  22704. (beginning-of-line 2)
  22705. (transpose-lines 1)
  22706. (beginning-of-line 0))
  22707. (transpose-lines 1)
  22708. (beginning-of-line -1))
  22709. (org-move-to-column c))))
  22710. (defun org-drag-line-backward (arg)
  22711. "Drag the line at point ARG lines backward."
  22712. (interactive "p")
  22713. (org-drag-line-forward (- arg)))
  22714. (defun org-mark-element ()
  22715. "Put point at beginning of this element, mark at end.
  22716. Interactively, if this command is repeated or (in Transient Mark
  22717. mode) if the mark is active, it marks the next element after the
  22718. ones already marked."
  22719. (interactive)
  22720. (let (deactivate-mark)
  22721. (if (and (org-called-interactively-p 'any)
  22722. (or (and (eq last-command this-command) (mark t))
  22723. (and transient-mark-mode mark-active)))
  22724. (set-mark
  22725. (save-excursion
  22726. (goto-char (mark))
  22727. (goto-char (org-element-property :end (org-element-at-point)))))
  22728. (let ((element (org-element-at-point)))
  22729. (end-of-line)
  22730. (push-mark (org-element-property :end element) t t)
  22731. (goto-char (org-element-property :begin element))))))
  22732. (defun org-narrow-to-element ()
  22733. "Narrow buffer to current element."
  22734. (interactive)
  22735. (let ((elem (org-element-at-point)))
  22736. (cond
  22737. ((eq (car elem) 'headline)
  22738. (narrow-to-region
  22739. (org-element-property :begin elem)
  22740. (org-element-property :end elem)))
  22741. ((memq (car elem) org-element-greater-elements)
  22742. (narrow-to-region
  22743. (org-element-property :contents-begin elem)
  22744. (org-element-property :contents-end elem)))
  22745. (t
  22746. (narrow-to-region
  22747. (org-element-property :begin elem)
  22748. (org-element-property :end elem))))))
  22749. (defun org-transpose-element ()
  22750. "Transpose current and previous elements, keeping blank lines between.
  22751. Point is moved after both elements."
  22752. (interactive)
  22753. (org-skip-whitespace)
  22754. (let ((end (org-element-property :end (org-element-at-point))))
  22755. (org-drag-element-backward)
  22756. (goto-char end)))
  22757. (defun org-unindent-buffer ()
  22758. "Un-indent the visible part of the buffer.
  22759. Relative indentation (between items, inside blocks, etc.) isn't
  22760. modified."
  22761. (interactive)
  22762. (unless (eq major-mode 'org-mode)
  22763. (user-error "Cannot un-indent a buffer not in Org mode"))
  22764. (let* ((parse-tree (org-element-parse-buffer 'greater-element))
  22765. unindent-tree ; For byte-compiler.
  22766. (unindent-tree
  22767. (function
  22768. (lambda (contents)
  22769. (mapc
  22770. (lambda (element)
  22771. (if (memq (org-element-type element) '(headline section))
  22772. (funcall unindent-tree (org-element-contents element))
  22773. (save-excursion
  22774. (save-restriction
  22775. (narrow-to-region
  22776. (org-element-property :begin element)
  22777. (org-element-property :end element))
  22778. (org-do-remove-indentation)))))
  22779. (reverse contents))))))
  22780. (funcall unindent-tree (org-element-contents parse-tree))))
  22781. (defun org-show-subtree ()
  22782. "Show everything after this heading at deeper levels."
  22783. (interactive)
  22784. (outline-flag-region
  22785. (point)
  22786. (save-excursion
  22787. (org-end-of-subtree t t))
  22788. nil))
  22789. (defun org-show-entry ()
  22790. "Show the body directly following this heading.
  22791. Show the heading too, if it is currently invisible."
  22792. (interactive)
  22793. (save-excursion
  22794. (ignore-errors
  22795. (org-back-to-heading t)
  22796. (outline-flag-region
  22797. (max (point-min) (1- (point)))
  22798. (save-excursion
  22799. (if (re-search-forward
  22800. (concat "[\r\n]\\(" org-outline-regexp "\\)") nil t)
  22801. (match-beginning 1)
  22802. (point-max)))
  22803. nil)
  22804. (org-cycle-hide-drawers 'children))))
  22805. (defun org-make-options-regexp (kwds &optional extra)
  22806. "Make a regular expression for keyword lines.
  22807. KWDS is a list of keywords, as strings. Optional argument EXTRA,
  22808. when non-nil, is a regexp matching keywords names."
  22809. (concat "^[ \t]*#\\+\\("
  22810. (regexp-opt kwds)
  22811. (and extra (concat (and kwds "\\|") extra))
  22812. "\\):[ \t]*\\(.*\\)"))
  22813. ;; Make isearch reveal the necessary context
  22814. (defun org-isearch-end ()
  22815. "Reveal context after isearch exits."
  22816. (when isearch-success ; only if search was successful
  22817. (if (featurep 'xemacs)
  22818. ;; Under XEmacs, the hook is run in the correct place,
  22819. ;; we directly show the context.
  22820. (org-show-context 'isearch)
  22821. ;; In Emacs the hook runs *before* restoring the overlays.
  22822. ;; So we have to use a one-time post-command-hook to do this.
  22823. ;; (Emacs 22 has a special variable, see function `org-mode')
  22824. (unless (and (boundp 'isearch-mode-end-hook-quit)
  22825. isearch-mode-end-hook-quit)
  22826. ;; Only when the isearch was not quitted.
  22827. (org-add-hook 'post-command-hook 'org-isearch-post-command
  22828. 'append 'local)))))
  22829. (defun org-isearch-post-command ()
  22830. "Remove self from hook, and show context."
  22831. (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
  22832. (org-show-context 'isearch))
  22833. ;;;; Integration with and fixes for other packages
  22834. ;;; Imenu support
  22835. (defvar org-imenu-markers nil
  22836. "All markers currently used by Imenu.")
  22837. (make-variable-buffer-local 'org-imenu-markers)
  22838. (defun org-imenu-new-marker (&optional pos)
  22839. "Return a new marker for use by Imenu, and remember the marker."
  22840. (let ((m (make-marker)))
  22841. (move-marker m (or pos (point)))
  22842. (push m org-imenu-markers)
  22843. m))
  22844. (defun org-imenu-get-tree ()
  22845. "Produce the index for Imenu."
  22846. (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
  22847. (setq org-imenu-markers nil)
  22848. (let* ((n org-imenu-depth)
  22849. (re (concat "^" (org-get-limited-outline-regexp)))
  22850. (subs (make-vector (1+ n) nil))
  22851. (last-level 0)
  22852. m level head0 head)
  22853. (save-excursion
  22854. (save-restriction
  22855. (widen)
  22856. (goto-char (point-max))
  22857. (while (re-search-backward re nil t)
  22858. (setq level (org-reduced-level (funcall outline-level)))
  22859. (when (and (<= level n)
  22860. (looking-at org-complex-heading-regexp)
  22861. (setq head0 (org-match-string-no-properties 4)))
  22862. (setq head (org-link-display-format head0)
  22863. m (org-imenu-new-marker))
  22864. (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
  22865. (if (>= level last-level)
  22866. (push (cons head m) (aref subs level))
  22867. (push (cons head (aref subs (1+ level))) (aref subs level))
  22868. (loop for i from (1+ level) to n do (aset subs i nil)))
  22869. (setq last-level level)))))
  22870. (aref subs 1)))
  22871. (eval-after-load "imenu"
  22872. '(progn
  22873. (add-hook 'imenu-after-jump-hook
  22874. (lambda ()
  22875. (if (derived-mode-p 'org-mode)
  22876. (org-show-context 'org-goto))))))
  22877. (defun org-link-display-format (link)
  22878. "Replace a link with its the description.
  22879. If there is no description, use the link target."
  22880. (save-match-data
  22881. (if (string-match org-bracket-link-analytic-regexp link)
  22882. (replace-match (if (match-end 5)
  22883. (match-string 5 link)
  22884. (concat (match-string 1 link)
  22885. (match-string 3 link)))
  22886. nil t link)
  22887. link)))
  22888. (defun org-toggle-link-display ()
  22889. "Toggle the literal or descriptive display of links."
  22890. (interactive)
  22891. (if org-descriptive-links
  22892. (progn (org-remove-from-invisibility-spec '(org-link))
  22893. (org-restart-font-lock)
  22894. (setq org-descriptive-links nil))
  22895. (progn (add-to-invisibility-spec '(org-link))
  22896. (org-restart-font-lock)
  22897. (setq org-descriptive-links t))))
  22898. ;; Speedbar support
  22899. (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
  22900. "Overlay marking the agenda restriction line in speedbar.")
  22901. (overlay-put org-speedbar-restriction-lock-overlay
  22902. 'face 'org-agenda-restriction-lock)
  22903. (overlay-put org-speedbar-restriction-lock-overlay
  22904. 'help-echo "Agendas are currently limited to this item.")
  22905. (org-detach-overlay org-speedbar-restriction-lock-overlay)
  22906. (defun org-speedbar-set-agenda-restriction ()
  22907. "Restrict future agenda commands to the location at point in speedbar.
  22908. To get rid of the restriction, use \\[org-agenda-remove-restriction-lock]."
  22909. (interactive)
  22910. (require 'org-agenda)
  22911. (let (p m tp np dir txt)
  22912. (cond
  22913. ((setq p (text-property-any (point-at-bol) (point-at-eol)
  22914. 'org-imenu t))
  22915. (setq m (get-text-property p 'org-imenu-marker))
  22916. (with-current-buffer (marker-buffer m)
  22917. (goto-char m)
  22918. (org-agenda-set-restriction-lock 'subtree)))
  22919. ((setq p (text-property-any (point-at-bol) (point-at-eol)
  22920. 'speedbar-function 'speedbar-find-file))
  22921. (setq tp (previous-single-property-change
  22922. (1+ p) 'speedbar-function)
  22923. np (next-single-property-change
  22924. tp 'speedbar-function)
  22925. dir (speedbar-line-directory)
  22926. txt (buffer-substring-no-properties (or tp (point-min))
  22927. (or np (point-max))))
  22928. (with-current-buffer (find-file-noselect
  22929. (let ((default-directory dir))
  22930. (expand-file-name txt)))
  22931. (unless (derived-mode-p 'org-mode)
  22932. (user-error "Cannot restrict to non-Org-mode file"))
  22933. (org-agenda-set-restriction-lock 'file)))
  22934. (t (user-error "Don't know how to restrict Org-mode's agenda")))
  22935. (move-overlay org-speedbar-restriction-lock-overlay
  22936. (point-at-bol) (point-at-eol))
  22937. (setq current-prefix-arg nil)
  22938. (org-agenda-maybe-redo)))
  22939. (defvar speedbar-file-key-map)
  22940. (declare-function speedbar-add-supported-extension "speedbar" (extension))
  22941. (eval-after-load "speedbar"
  22942. '(progn
  22943. (speedbar-add-supported-extension ".org")
  22944. (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
  22945. (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
  22946. (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
  22947. (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
  22948. (add-hook 'speedbar-visiting-tag-hook
  22949. (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
  22950. ;;; Fixes and Hacks for problems with other packages
  22951. (defun org--flyspell-object-check-p (element)
  22952. "Non-nil when Flyspell can check object at point.
  22953. ELEMENT is the element at point."
  22954. (let ((object (save-excursion
  22955. (when (org-looking-at-p "\\>") (backward-char))
  22956. (org-element-context element))))
  22957. (case (org-element-type object)
  22958. ;; Prevent checks in links due to keybinding conflict with
  22959. ;; Flyspell.
  22960. ((code entity export-snippet inline-babel-call
  22961. inline-src-block line-break latex-fragment link macro
  22962. statistics-cookie target timestamp verbatim)
  22963. nil)
  22964. (footnote-reference
  22965. ;; Only in inline footnotes, within the definition.
  22966. (and (eq (org-element-property :type object) 'inline)
  22967. (< (save-excursion
  22968. (goto-char (org-element-property :begin object))
  22969. (search-forward ":" nil t 2))
  22970. (point))))
  22971. (otherwise t))))
  22972. (defun org-mode-flyspell-verify ()
  22973. "Function used for `flyspell-generic-check-word-predicate'."
  22974. (if (org-at-heading-p)
  22975. ;; At a headline or an inlinetask, check title only. This is
  22976. ;; faster than relying on `org-element-at-point'.
  22977. (and (save-excursion (beginning-of-line)
  22978. (and (let ((case-fold-search t))
  22979. (not (looking-at "\\*+ END[ \t]*$")))
  22980. (looking-at org-complex-heading-regexp)))
  22981. (match-beginning 4)
  22982. (>= (point) (match-beginning 4))
  22983. (or (not (match-beginning 5))
  22984. (< (point) (match-beginning 5))))
  22985. (let* ((element (org-element-at-point))
  22986. (post-affiliated (org-element-property :post-affiliated element)))
  22987. (cond
  22988. ;; Ignore checks in all affiliated keywords but captions.
  22989. ((< (point) post-affiliated)
  22990. (and (save-excursion
  22991. (beginning-of-line)
  22992. (let ((case-fold-search t)) (looking-at "[ \t]*#\\+CAPTION:")))
  22993. (> (point) (match-end 0))
  22994. (org--flyspell-object-check-p element)))
  22995. ;; Ignore checks in LOGBOOK (or equivalent) drawer.
  22996. ((let ((log (org-log-into-drawer)))
  22997. (and log
  22998. (let ((drawer (org-element-lineage element '(drawer))))
  22999. (and drawer
  23000. (eq (compare-strings
  23001. log nil nil
  23002. (org-element-property :drawer-name drawer) nil nil t)
  23003. t)))))
  23004. nil)
  23005. (t
  23006. (case (org-element-type element)
  23007. ((comment quote-section) t)
  23008. (comment-block
  23009. ;; Allow checks between block markers, not on them.
  23010. (and (> (line-beginning-position) post-affiliated)
  23011. (save-excursion
  23012. (end-of-line)
  23013. (skip-chars-forward " \r\t\n")
  23014. (< (point) (org-element-property :end element)))))
  23015. ;; Arbitrary list of keywords where checks are meaningful.
  23016. ;; Make sure point is on the value part of the element.
  23017. (keyword
  23018. (and (member (org-element-property :key element)
  23019. '("DESCRIPTION" "TITLE"))
  23020. (save-excursion
  23021. (search-backward ":" (line-beginning-position) t))))
  23022. ;; Check is globally allowed in paragraphs verse blocks and
  23023. ;; table rows (after affiliated keywords) but some objects
  23024. ;; must not be affected.
  23025. ((paragraph table-row verse-block)
  23026. (let ((cbeg (org-element-property :contents-begin element))
  23027. (cend (org-element-property :contents-end element)))
  23028. (and cbeg (>= (point) cbeg) (< (point) cend)
  23029. (org--flyspell-object-check-p element))))))))))
  23030. (put 'org-mode 'flyspell-mode-predicate 'org-mode-flyspell-verify)
  23031. (defun org-remove-flyspell-overlays-in (beg end)
  23032. "Remove flyspell overlays in region."
  23033. (and (org-bound-and-true-p flyspell-mode)
  23034. (fboundp 'flyspell-delete-region-overlays)
  23035. (flyspell-delete-region-overlays beg end)))
  23036. (defvar flyspell-delayed-commands)
  23037. (eval-after-load "flyspell"
  23038. '(add-to-list 'flyspell-delayed-commands 'org-self-insert-command))
  23039. ;; Make `bookmark-jump' shows the jump location if it was hidden.
  23040. (eval-after-load "bookmark"
  23041. '(if (boundp 'bookmark-after-jump-hook)
  23042. ;; We can use the hook
  23043. (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
  23044. ;; Hook not available, use advice
  23045. (defadvice bookmark-jump (after org-make-visible activate)
  23046. "Make the position visible."
  23047. (org-bookmark-jump-unhide))))
  23048. ;; Make sure saveplace shows the location if it was hidden
  23049. (eval-after-load "saveplace"
  23050. '(defadvice save-place-find-file-hook (after org-make-visible activate)
  23051. "Make the position visible."
  23052. (org-bookmark-jump-unhide)))
  23053. ;; Make sure ecb shows the location if it was hidden
  23054. (eval-after-load "ecb"
  23055. '(defadvice ecb-method-clicked (after esf/org-show-context activate)
  23056. "Make hierarchy visible when jumping into location from ECB tree buffer."
  23057. (if (derived-mode-p 'org-mode)
  23058. (org-show-context))))
  23059. (defun org-bookmark-jump-unhide ()
  23060. "Unhide the current position, to show the bookmark location."
  23061. (and (derived-mode-p 'org-mode)
  23062. (or (outline-invisible-p)
  23063. (save-excursion (goto-char (max (point-min) (1- (point))))
  23064. (outline-invisible-p)))
  23065. (org-show-context 'bookmark-jump)))
  23066. (defun org-mark-jump-unhide ()
  23067. "Make the point visible with `org-show-context' after jumping to the mark."
  23068. (when (and (derived-mode-p 'org-mode)
  23069. (outline-invisible-p))
  23070. (org-show-context 'mark-goto)))
  23071. (eval-after-load "simple"
  23072. '(defadvice pop-to-mark-command (after org-make-visible activate)
  23073. "Make the point visible with `org-show-context'."
  23074. (org-mark-jump-unhide)))
  23075. (eval-after-load "simple"
  23076. '(defadvice exchange-point-and-mark (after org-make-visible activate)
  23077. "Make the point visible with `org-show-context'."
  23078. (org-mark-jump-unhide)))
  23079. (eval-after-load "simple"
  23080. '(defadvice pop-global-mark (after org-make-visible activate)
  23081. "Make the point visible with `org-show-context'."
  23082. (org-mark-jump-unhide)))
  23083. ;; Make session.el ignore our circular variable
  23084. (defvar session-globals-exclude)
  23085. (eval-after-load "session"
  23086. '(add-to-list 'session-globals-exclude 'org-mark-ring))
  23087. ;;;; Finish up
  23088. (provide 'org)
  23089. (run-hooks 'org-load-hook)
  23090. ;;; org.el ends here