org.el 897 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589125901259112592125931259412595125961259712598125991260012601126021260312604126051260612607126081260912610126111261212613126141261512616126171261812619126201262112622126231262412625126261262712628126291263012631126321263312634126351263612637126381263912640126411264212643126441264512646126471264812649126501265112652126531265412655126561265712658126591266012661126621266312664126651266612667126681266912670126711267212673126741267512676126771267812679126801268112682126831268412685126861268712688126891269012691126921269312694126951269612697126981269912700127011270212703127041270512706127071270812709127101271112712127131271412715127161271712718127191272012721127221272312724127251272612727127281272912730127311273212733127341273512736127371273812739127401274112742127431274412745127461274712748127491275012751127521275312754127551275612757127581275912760127611276212763127641276512766127671276812769127701277112772127731277412775127761277712778127791278012781127821278312784127851278612787127881278912790127911279212793127941279512796127971279812799128001280112802128031280412805128061280712808128091281012811128121281312814128151281612817128181281912820128211282212823128241282512826128271282812829128301283112832128331283412835128361283712838128391284012841128421284312844128451284612847128481284912850128511285212853128541285512856128571285812859128601286112862128631286412865128661286712868128691287012871128721287312874128751287612877128781287912880128811288212883128841288512886128871288812889128901289112892128931289412895128961289712898128991290012901129021290312904129051290612907129081290912910129111291212913129141291512916129171291812919129201292112922129231292412925129261292712928129291293012931129321293312934129351293612937129381293912940129411294212943129441294512946129471294812949129501295112952129531295412955129561295712958129591296012961129621296312964129651296612967129681296912970129711297212973129741297512976129771297812979129801298112982129831298412985129861298712988129891299012991129921299312994129951299612997129981299913000130011300213003130041300513006130071300813009130101301113012130131301413015130161301713018130191302013021130221302313024130251302613027130281302913030130311303213033130341303513036130371303813039130401304113042130431304413045130461304713048130491305013051130521305313054130551305613057130581305913060130611306213063130641306513066130671306813069130701307113072130731307413075130761307713078130791308013081130821308313084130851308613087130881308913090130911309213093130941309513096130971309813099131001310113102131031310413105131061310713108131091311013111131121311313114131151311613117131181311913120131211312213123131241312513126131271312813129131301313113132131331313413135131361313713138131391314013141131421314313144131451314613147131481314913150131511315213153131541315513156131571315813159131601316113162131631316413165131661316713168131691317013171131721317313174131751317613177131781317913180131811318213183131841318513186131871318813189131901319113192131931319413195131961319713198131991320013201132021320313204132051320613207132081320913210132111321213213132141321513216132171321813219132201322113222132231322413225132261322713228132291323013231132321323313234132351323613237132381323913240132411324213243132441324513246132471324813249132501325113252132531325413255132561325713258132591326013261132621326313264132651326613267132681326913270132711327213273132741327513276132771327813279132801328113282132831328413285132861328713288132891329013291132921329313294132951329613297132981329913300133011330213303133041330513306133071330813309133101331113312133131331413315133161331713318133191332013321133221332313324133251332613327133281332913330133311333213333133341333513336133371333813339133401334113342133431334413345133461334713348133491335013351133521335313354133551335613357133581335913360133611336213363133641336513366133671336813369133701337113372133731337413375133761337713378133791338013381133821338313384133851338613387133881338913390133911339213393133941339513396133971339813399134001340113402134031340413405134061340713408134091341013411134121341313414134151341613417134181341913420134211342213423134241342513426134271342813429134301343113432134331343413435134361343713438134391344013441134421344313444134451344613447134481344913450134511345213453134541345513456134571345813459134601346113462134631346413465134661346713468134691347013471134721347313474134751347613477134781347913480134811348213483134841348513486134871348813489134901349113492134931349413495134961349713498134991350013501135021350313504135051350613507135081350913510135111351213513135141351513516135171351813519135201352113522135231352413525135261352713528135291353013531135321353313534135351353613537135381353913540135411354213543135441354513546135471354813549135501355113552135531355413555135561355713558135591356013561135621356313564135651356613567135681356913570135711357213573135741357513576135771357813579135801358113582135831358413585135861358713588135891359013591135921359313594135951359613597135981359913600136011360213603136041360513606136071360813609136101361113612136131361413615136161361713618136191362013621136221362313624136251362613627136281362913630136311363213633136341363513636136371363813639136401364113642136431364413645136461364713648136491365013651136521365313654136551365613657136581365913660136611366213663136641366513666136671366813669136701367113672136731367413675136761367713678136791368013681136821368313684136851368613687136881368913690136911369213693136941369513696136971369813699137001370113702137031370413705137061370713708137091371013711137121371313714137151371613717137181371913720137211372213723137241372513726137271372813729137301373113732137331373413735137361373713738137391374013741137421374313744137451374613747137481374913750137511375213753137541375513756137571375813759137601376113762137631376413765137661376713768137691377013771137721377313774137751377613777137781377913780137811378213783137841378513786137871378813789137901379113792137931379413795137961379713798137991380013801138021380313804138051380613807138081380913810138111381213813138141381513816138171381813819138201382113822138231382413825138261382713828138291383013831138321383313834138351383613837138381383913840138411384213843138441384513846138471384813849138501385113852138531385413855138561385713858138591386013861138621386313864138651386613867138681386913870138711387213873138741387513876138771387813879138801388113882138831388413885138861388713888138891389013891138921389313894138951389613897138981389913900139011390213903139041390513906139071390813909139101391113912139131391413915139161391713918139191392013921139221392313924139251392613927139281392913930139311393213933139341393513936139371393813939139401394113942139431394413945139461394713948139491395013951139521395313954139551395613957139581395913960139611396213963139641396513966139671396813969139701397113972139731397413975139761397713978139791398013981139821398313984139851398613987139881398913990139911399213993139941399513996139971399813999140001400114002140031400414005140061400714008140091401014011140121401314014140151401614017140181401914020140211402214023140241402514026140271402814029140301403114032140331403414035140361403714038140391404014041140421404314044140451404614047140481404914050140511405214053140541405514056140571405814059140601406114062140631406414065140661406714068140691407014071140721407314074140751407614077140781407914080140811408214083140841408514086140871408814089140901409114092140931409414095140961409714098140991410014101141021410314104141051410614107141081410914110141111411214113141141411514116141171411814119141201412114122141231412414125141261412714128141291413014131141321413314134141351413614137141381413914140141411414214143141441414514146141471414814149141501415114152141531415414155141561415714158141591416014161141621416314164141651416614167141681416914170141711417214173141741417514176141771417814179141801418114182141831418414185141861418714188141891419014191141921419314194141951419614197141981419914200142011420214203142041420514206142071420814209142101421114212142131421414215142161421714218142191422014221142221422314224142251422614227142281422914230142311423214233142341423514236142371423814239142401424114242142431424414245142461424714248142491425014251142521425314254142551425614257142581425914260142611426214263142641426514266142671426814269142701427114272142731427414275142761427714278142791428014281142821428314284142851428614287142881428914290142911429214293142941429514296142971429814299143001430114302143031430414305143061430714308143091431014311143121431314314143151431614317143181431914320143211432214323143241432514326143271432814329143301433114332143331433414335143361433714338143391434014341143421434314344143451434614347143481434914350143511435214353143541435514356143571435814359143601436114362143631436414365143661436714368143691437014371143721437314374143751437614377143781437914380143811438214383143841438514386143871438814389143901439114392143931439414395143961439714398143991440014401144021440314404144051440614407144081440914410144111441214413144141441514416144171441814419144201442114422144231442414425144261442714428144291443014431144321443314434144351443614437144381443914440144411444214443144441444514446144471444814449144501445114452144531445414455144561445714458144591446014461144621446314464144651446614467144681446914470144711447214473144741447514476144771447814479144801448114482144831448414485144861448714488144891449014491144921449314494144951449614497144981449914500145011450214503145041450514506145071450814509145101451114512145131451414515145161451714518145191452014521145221452314524145251452614527145281452914530145311453214533145341453514536145371453814539145401454114542145431454414545145461454714548145491455014551145521455314554145551455614557145581455914560145611456214563145641456514566145671456814569145701457114572145731457414575145761457714578145791458014581145821458314584145851458614587145881458914590145911459214593145941459514596145971459814599146001460114602146031460414605146061460714608146091461014611146121461314614146151461614617146181461914620146211462214623146241462514626146271462814629146301463114632146331463414635146361463714638146391464014641146421464314644146451464614647146481464914650146511465214653146541465514656146571465814659146601466114662146631466414665146661466714668146691467014671146721467314674146751467614677146781467914680146811468214683146841468514686146871468814689146901469114692146931469414695146961469714698146991470014701147021470314704147051470614707147081470914710147111471214713147141471514716147171471814719147201472114722147231472414725147261472714728147291473014731147321473314734147351473614737147381473914740147411474214743147441474514746147471474814749147501475114752147531475414755147561475714758147591476014761147621476314764147651476614767147681476914770147711477214773147741477514776147771477814779147801478114782147831478414785147861478714788147891479014791147921479314794147951479614797147981479914800148011480214803148041480514806148071480814809148101481114812148131481414815148161481714818148191482014821148221482314824148251482614827148281482914830148311483214833148341483514836148371483814839148401484114842148431484414845148461484714848148491485014851148521485314854148551485614857148581485914860148611486214863148641486514866148671486814869148701487114872148731487414875148761487714878148791488014881148821488314884148851488614887148881488914890148911489214893148941489514896148971489814899149001490114902149031490414905149061490714908149091491014911149121491314914149151491614917149181491914920149211492214923149241492514926149271492814929149301493114932149331493414935149361493714938149391494014941149421494314944149451494614947149481494914950149511495214953149541495514956149571495814959149601496114962149631496414965149661496714968149691497014971149721497314974149751497614977149781497914980149811498214983149841498514986149871498814989149901499114992149931499414995149961499714998149991500015001150021500315004150051500615007150081500915010150111501215013150141501515016150171501815019150201502115022150231502415025150261502715028150291503015031150321503315034150351503615037150381503915040150411504215043150441504515046150471504815049150501505115052150531505415055150561505715058150591506015061150621506315064150651506615067150681506915070150711507215073150741507515076150771507815079150801508115082150831508415085150861508715088150891509015091150921509315094150951509615097150981509915100151011510215103151041510515106151071510815109151101511115112151131511415115151161511715118151191512015121151221512315124151251512615127151281512915130151311513215133151341513515136151371513815139151401514115142151431514415145151461514715148151491515015151151521515315154151551515615157151581515915160151611516215163151641516515166151671516815169151701517115172151731517415175151761517715178151791518015181151821518315184151851518615187151881518915190151911519215193151941519515196151971519815199152001520115202152031520415205152061520715208152091521015211152121521315214152151521615217152181521915220152211522215223152241522515226152271522815229152301523115232152331523415235152361523715238152391524015241152421524315244152451524615247152481524915250152511525215253152541525515256152571525815259152601526115262152631526415265152661526715268152691527015271152721527315274152751527615277152781527915280152811528215283152841528515286152871528815289152901529115292152931529415295152961529715298152991530015301153021530315304153051530615307153081530915310153111531215313153141531515316153171531815319153201532115322153231532415325153261532715328153291533015331153321533315334153351533615337153381533915340153411534215343153441534515346153471534815349153501535115352153531535415355153561535715358153591536015361153621536315364153651536615367153681536915370153711537215373153741537515376153771537815379153801538115382153831538415385153861538715388153891539015391153921539315394153951539615397153981539915400154011540215403154041540515406154071540815409154101541115412154131541415415154161541715418154191542015421154221542315424154251542615427154281542915430154311543215433154341543515436154371543815439154401544115442154431544415445154461544715448154491545015451154521545315454154551545615457154581545915460154611546215463154641546515466154671546815469154701547115472154731547415475154761547715478154791548015481154821548315484154851548615487154881548915490154911549215493154941549515496154971549815499155001550115502155031550415505155061550715508155091551015511155121551315514155151551615517155181551915520155211552215523155241552515526155271552815529155301553115532155331553415535155361553715538155391554015541155421554315544155451554615547155481554915550155511555215553155541555515556155571555815559155601556115562155631556415565155661556715568155691557015571155721557315574155751557615577155781557915580155811558215583155841558515586155871558815589155901559115592155931559415595155961559715598155991560015601156021560315604156051560615607156081560915610156111561215613156141561515616156171561815619156201562115622156231562415625156261562715628156291563015631156321563315634156351563615637156381563915640156411564215643156441564515646156471564815649156501565115652156531565415655156561565715658156591566015661156621566315664156651566615667156681566915670156711567215673156741567515676156771567815679156801568115682156831568415685156861568715688156891569015691156921569315694156951569615697156981569915700157011570215703157041570515706157071570815709157101571115712157131571415715157161571715718157191572015721157221572315724157251572615727157281572915730157311573215733157341573515736157371573815739157401574115742157431574415745157461574715748157491575015751157521575315754157551575615757157581575915760157611576215763157641576515766157671576815769157701577115772157731577415775157761577715778157791578015781157821578315784157851578615787157881578915790157911579215793157941579515796157971579815799158001580115802158031580415805158061580715808158091581015811158121581315814158151581615817158181581915820158211582215823158241582515826158271582815829158301583115832158331583415835158361583715838158391584015841158421584315844158451584615847158481584915850158511585215853158541585515856158571585815859158601586115862158631586415865158661586715868158691587015871158721587315874158751587615877158781587915880158811588215883158841588515886158871588815889158901589115892158931589415895158961589715898158991590015901159021590315904159051590615907159081590915910159111591215913159141591515916159171591815919159201592115922159231592415925159261592715928159291593015931159321593315934159351593615937159381593915940159411594215943159441594515946159471594815949159501595115952159531595415955159561595715958159591596015961159621596315964159651596615967159681596915970159711597215973159741597515976159771597815979159801598115982159831598415985159861598715988159891599015991159921599315994159951599615997159981599916000160011600216003160041600516006160071600816009160101601116012160131601416015160161601716018160191602016021160221602316024160251602616027160281602916030160311603216033160341603516036160371603816039160401604116042160431604416045160461604716048160491605016051160521605316054160551605616057160581605916060160611606216063160641606516066160671606816069160701607116072160731607416075160761607716078160791608016081160821608316084160851608616087160881608916090160911609216093160941609516096160971609816099161001610116102161031610416105161061610716108161091611016111161121611316114161151611616117161181611916120161211612216123161241612516126161271612816129161301613116132161331613416135161361613716138161391614016141161421614316144161451614616147161481614916150161511615216153161541615516156161571615816159161601616116162161631616416165161661616716168161691617016171161721617316174161751617616177161781617916180161811618216183161841618516186161871618816189161901619116192161931619416195161961619716198161991620016201162021620316204162051620616207162081620916210162111621216213162141621516216162171621816219162201622116222162231622416225162261622716228162291623016231162321623316234162351623616237162381623916240162411624216243162441624516246162471624816249162501625116252162531625416255162561625716258162591626016261162621626316264162651626616267162681626916270162711627216273162741627516276162771627816279162801628116282162831628416285162861628716288162891629016291162921629316294162951629616297162981629916300163011630216303163041630516306163071630816309163101631116312163131631416315163161631716318163191632016321163221632316324163251632616327163281632916330163311633216333163341633516336163371633816339163401634116342163431634416345163461634716348163491635016351163521635316354163551635616357163581635916360163611636216363163641636516366163671636816369163701637116372163731637416375163761637716378163791638016381163821638316384163851638616387163881638916390163911639216393163941639516396163971639816399164001640116402164031640416405164061640716408164091641016411164121641316414164151641616417164181641916420164211642216423164241642516426164271642816429164301643116432164331643416435164361643716438164391644016441164421644316444164451644616447164481644916450164511645216453164541645516456164571645816459164601646116462164631646416465164661646716468164691647016471164721647316474164751647616477164781647916480164811648216483164841648516486164871648816489164901649116492164931649416495164961649716498164991650016501165021650316504165051650616507165081650916510165111651216513165141651516516165171651816519165201652116522165231652416525165261652716528165291653016531165321653316534165351653616537165381653916540165411654216543165441654516546165471654816549165501655116552165531655416555165561655716558165591656016561165621656316564165651656616567165681656916570165711657216573165741657516576165771657816579165801658116582165831658416585165861658716588165891659016591165921659316594165951659616597165981659916600166011660216603166041660516606166071660816609166101661116612166131661416615166161661716618166191662016621166221662316624166251662616627166281662916630166311663216633166341663516636166371663816639166401664116642166431664416645166461664716648166491665016651166521665316654166551665616657166581665916660166611666216663166641666516666166671666816669166701667116672166731667416675166761667716678166791668016681166821668316684166851668616687166881668916690166911669216693166941669516696166971669816699167001670116702167031670416705167061670716708167091671016711167121671316714167151671616717167181671916720167211672216723167241672516726167271672816729167301673116732167331673416735167361673716738167391674016741167421674316744167451674616747167481674916750167511675216753167541675516756167571675816759167601676116762167631676416765167661676716768167691677016771167721677316774167751677616777167781677916780167811678216783167841678516786167871678816789167901679116792167931679416795167961679716798167991680016801168021680316804168051680616807168081680916810168111681216813168141681516816168171681816819168201682116822168231682416825168261682716828168291683016831168321683316834168351683616837168381683916840168411684216843168441684516846168471684816849168501685116852168531685416855168561685716858168591686016861168621686316864168651686616867168681686916870168711687216873168741687516876168771687816879168801688116882168831688416885168861688716888168891689016891168921689316894168951689616897168981689916900169011690216903169041690516906169071690816909169101691116912169131691416915169161691716918169191692016921169221692316924169251692616927169281692916930169311693216933169341693516936169371693816939169401694116942169431694416945169461694716948169491695016951169521695316954169551695616957169581695916960169611696216963169641696516966169671696816969169701697116972169731697416975169761697716978169791698016981169821698316984169851698616987169881698916990169911699216993169941699516996169971699816999170001700117002170031700417005170061700717008170091701017011170121701317014170151701617017170181701917020170211702217023170241702517026170271702817029170301703117032170331703417035170361703717038170391704017041170421704317044170451704617047170481704917050170511705217053170541705517056170571705817059170601706117062170631706417065170661706717068170691707017071170721707317074170751707617077170781707917080170811708217083170841708517086170871708817089170901709117092170931709417095170961709717098170991710017101171021710317104171051710617107171081710917110171111711217113171141711517116171171711817119171201712117122171231712417125171261712717128171291713017131171321713317134171351713617137171381713917140171411714217143171441714517146171471714817149171501715117152171531715417155171561715717158171591716017161171621716317164171651716617167171681716917170171711717217173171741717517176171771717817179171801718117182171831718417185171861718717188171891719017191171921719317194171951719617197171981719917200172011720217203172041720517206172071720817209172101721117212172131721417215172161721717218172191722017221172221722317224172251722617227172281722917230172311723217233172341723517236172371723817239172401724117242172431724417245172461724717248172491725017251172521725317254172551725617257172581725917260172611726217263172641726517266172671726817269172701727117272172731727417275172761727717278172791728017281172821728317284172851728617287172881728917290172911729217293172941729517296172971729817299173001730117302173031730417305173061730717308173091731017311173121731317314173151731617317173181731917320173211732217323173241732517326173271732817329173301733117332173331733417335173361733717338173391734017341173421734317344173451734617347173481734917350173511735217353173541735517356173571735817359173601736117362173631736417365173661736717368173691737017371173721737317374173751737617377173781737917380173811738217383173841738517386173871738817389173901739117392173931739417395173961739717398173991740017401174021740317404174051740617407174081740917410174111741217413174141741517416174171741817419174201742117422174231742417425174261742717428174291743017431174321743317434174351743617437174381743917440174411744217443174441744517446174471744817449174501745117452174531745417455174561745717458174591746017461174621746317464174651746617467174681746917470174711747217473174741747517476174771747817479174801748117482174831748417485174861748717488174891749017491174921749317494174951749617497174981749917500175011750217503175041750517506175071750817509175101751117512175131751417515175161751717518175191752017521175221752317524175251752617527175281752917530175311753217533175341753517536175371753817539175401754117542175431754417545175461754717548175491755017551175521755317554175551755617557175581755917560175611756217563175641756517566175671756817569175701757117572175731757417575175761757717578175791758017581175821758317584175851758617587175881758917590175911759217593175941759517596175971759817599176001760117602176031760417605176061760717608176091761017611176121761317614176151761617617176181761917620176211762217623176241762517626176271762817629176301763117632176331763417635176361763717638176391764017641176421764317644176451764617647176481764917650176511765217653176541765517656176571765817659176601766117662176631766417665176661766717668176691767017671176721767317674176751767617677176781767917680176811768217683176841768517686176871768817689176901769117692176931769417695176961769717698176991770017701177021770317704177051770617707177081770917710177111771217713177141771517716177171771817719177201772117722177231772417725177261772717728177291773017731177321773317734177351773617737177381773917740177411774217743177441774517746177471774817749177501775117752177531775417755177561775717758177591776017761177621776317764177651776617767177681776917770177711777217773177741777517776177771777817779177801778117782177831778417785177861778717788177891779017791177921779317794177951779617797177981779917800178011780217803178041780517806178071780817809178101781117812178131781417815178161781717818178191782017821178221782317824178251782617827178281782917830178311783217833178341783517836178371783817839178401784117842178431784417845178461784717848178491785017851178521785317854178551785617857178581785917860178611786217863178641786517866178671786817869178701787117872178731787417875178761787717878178791788017881178821788317884178851788617887178881788917890178911789217893178941789517896178971789817899179001790117902179031790417905179061790717908179091791017911179121791317914179151791617917179181791917920179211792217923179241792517926179271792817929179301793117932179331793417935179361793717938179391794017941179421794317944179451794617947179481794917950179511795217953179541795517956179571795817959179601796117962179631796417965179661796717968179691797017971179721797317974179751797617977179781797917980179811798217983179841798517986179871798817989179901799117992179931799417995179961799717998179991800018001180021800318004180051800618007180081800918010180111801218013180141801518016180171801818019180201802118022180231802418025180261802718028180291803018031180321803318034180351803618037180381803918040180411804218043180441804518046180471804818049180501805118052180531805418055180561805718058180591806018061180621806318064180651806618067180681806918070180711807218073180741807518076180771807818079180801808118082180831808418085180861808718088180891809018091180921809318094180951809618097180981809918100181011810218103181041810518106181071810818109181101811118112181131811418115181161811718118181191812018121181221812318124181251812618127181281812918130181311813218133181341813518136181371813818139181401814118142181431814418145181461814718148181491815018151181521815318154181551815618157181581815918160181611816218163181641816518166181671816818169181701817118172181731817418175181761817718178181791818018181181821818318184181851818618187181881818918190181911819218193181941819518196181971819818199182001820118202182031820418205182061820718208182091821018211182121821318214182151821618217182181821918220182211822218223182241822518226182271822818229182301823118232182331823418235182361823718238182391824018241182421824318244182451824618247182481824918250182511825218253182541825518256182571825818259182601826118262182631826418265182661826718268182691827018271182721827318274182751827618277182781827918280182811828218283182841828518286182871828818289182901829118292182931829418295182961829718298182991830018301183021830318304183051830618307183081830918310183111831218313183141831518316183171831818319183201832118322183231832418325183261832718328183291833018331183321833318334183351833618337183381833918340183411834218343183441834518346183471834818349183501835118352183531835418355183561835718358183591836018361183621836318364183651836618367183681836918370183711837218373183741837518376183771837818379183801838118382183831838418385183861838718388183891839018391183921839318394183951839618397183981839918400184011840218403184041840518406184071840818409184101841118412184131841418415184161841718418184191842018421184221842318424184251842618427184281842918430184311843218433184341843518436184371843818439184401844118442184431844418445184461844718448184491845018451184521845318454184551845618457184581845918460184611846218463184641846518466184671846818469184701847118472184731847418475184761847718478184791848018481184821848318484184851848618487184881848918490184911849218493184941849518496184971849818499185001850118502185031850418505185061850718508185091851018511185121851318514185151851618517185181851918520185211852218523185241852518526185271852818529185301853118532185331853418535185361853718538185391854018541185421854318544185451854618547185481854918550185511855218553185541855518556185571855818559185601856118562185631856418565185661856718568185691857018571185721857318574185751857618577185781857918580185811858218583185841858518586185871858818589185901859118592185931859418595185961859718598185991860018601186021860318604186051860618607186081860918610186111861218613186141861518616186171861818619186201862118622186231862418625186261862718628186291863018631186321863318634186351863618637186381863918640186411864218643186441864518646186471864818649186501865118652186531865418655186561865718658186591866018661186621866318664186651866618667186681866918670186711867218673186741867518676186771867818679186801868118682186831868418685186861868718688186891869018691186921869318694186951869618697186981869918700187011870218703187041870518706187071870818709187101871118712187131871418715187161871718718187191872018721187221872318724187251872618727187281872918730187311873218733187341873518736187371873818739187401874118742187431874418745187461874718748187491875018751187521875318754187551875618757187581875918760187611876218763187641876518766187671876818769187701877118772187731877418775187761877718778187791878018781187821878318784187851878618787187881878918790187911879218793187941879518796187971879818799188001880118802188031880418805188061880718808188091881018811188121881318814188151881618817188181881918820188211882218823188241882518826188271882818829188301883118832188331883418835188361883718838188391884018841188421884318844188451884618847188481884918850188511885218853188541885518856188571885818859188601886118862188631886418865188661886718868188691887018871188721887318874188751887618877188781887918880188811888218883188841888518886188871888818889188901889118892188931889418895188961889718898188991890018901189021890318904189051890618907189081890918910189111891218913189141891518916189171891818919189201892118922189231892418925189261892718928189291893018931189321893318934189351893618937189381893918940189411894218943189441894518946189471894818949189501895118952189531895418955189561895718958189591896018961189621896318964189651896618967189681896918970189711897218973189741897518976189771897818979189801898118982189831898418985189861898718988189891899018991189921899318994189951899618997189981899919000190011900219003190041900519006190071900819009190101901119012190131901419015190161901719018190191902019021190221902319024190251902619027190281902919030190311903219033190341903519036190371903819039190401904119042190431904419045190461904719048190491905019051190521905319054190551905619057190581905919060190611906219063190641906519066190671906819069190701907119072190731907419075190761907719078190791908019081190821908319084190851908619087190881908919090190911909219093190941909519096190971909819099191001910119102191031910419105191061910719108191091911019111191121911319114191151911619117191181911919120191211912219123191241912519126191271912819129191301913119132191331913419135191361913719138191391914019141191421914319144191451914619147191481914919150191511915219153191541915519156191571915819159191601916119162191631916419165191661916719168191691917019171191721917319174191751917619177191781917919180191811918219183191841918519186191871918819189191901919119192191931919419195191961919719198191991920019201192021920319204192051920619207192081920919210192111921219213192141921519216192171921819219192201922119222192231922419225192261922719228192291923019231192321923319234192351923619237192381923919240192411924219243192441924519246192471924819249192501925119252192531925419255192561925719258192591926019261192621926319264192651926619267192681926919270192711927219273192741927519276192771927819279192801928119282192831928419285192861928719288192891929019291192921929319294192951929619297192981929919300193011930219303193041930519306193071930819309193101931119312193131931419315193161931719318193191932019321193221932319324193251932619327193281932919330193311933219333193341933519336193371933819339193401934119342193431934419345193461934719348193491935019351193521935319354193551935619357193581935919360193611936219363193641936519366193671936819369193701937119372193731937419375193761937719378193791938019381193821938319384193851938619387193881938919390193911939219393193941939519396193971939819399194001940119402194031940419405194061940719408194091941019411194121941319414194151941619417194181941919420194211942219423194241942519426194271942819429194301943119432194331943419435194361943719438194391944019441194421944319444194451944619447194481944919450194511945219453194541945519456194571945819459194601946119462194631946419465194661946719468194691947019471194721947319474194751947619477194781947919480194811948219483194841948519486194871948819489194901949119492194931949419495194961949719498194991950019501195021950319504195051950619507195081950919510195111951219513195141951519516195171951819519195201952119522195231952419525195261952719528195291953019531195321953319534195351953619537195381953919540195411954219543195441954519546195471954819549195501955119552195531955419555195561955719558195591956019561195621956319564195651956619567195681956919570195711957219573195741957519576195771957819579195801958119582195831958419585195861958719588195891959019591195921959319594195951959619597195981959919600196011960219603196041960519606196071960819609196101961119612196131961419615196161961719618196191962019621196221962319624196251962619627196281962919630196311963219633196341963519636196371963819639196401964119642196431964419645196461964719648196491965019651196521965319654196551965619657196581965919660196611966219663196641966519666196671966819669196701967119672196731967419675196761967719678196791968019681196821968319684196851968619687196881968919690196911969219693196941969519696196971969819699197001970119702197031970419705197061970719708197091971019711197121971319714197151971619717197181971919720197211972219723197241972519726197271972819729197301973119732197331973419735197361973719738197391974019741197421974319744197451974619747197481974919750197511975219753197541975519756197571975819759197601976119762197631976419765197661976719768197691977019771197721977319774197751977619777197781977919780197811978219783197841978519786197871978819789197901979119792197931979419795197961979719798197991980019801198021980319804198051980619807198081980919810198111981219813198141981519816198171981819819198201982119822198231982419825198261982719828198291983019831198321983319834198351983619837198381983919840198411984219843198441984519846198471984819849198501985119852198531985419855198561985719858198591986019861198621986319864198651986619867198681986919870198711987219873198741987519876198771987819879198801988119882198831988419885198861988719888198891989019891198921989319894198951989619897198981989919900199011990219903199041990519906199071990819909199101991119912199131991419915199161991719918199191992019921199221992319924199251992619927199281992919930199311993219933199341993519936199371993819939199401994119942199431994419945199461994719948199491995019951199521995319954199551995619957199581995919960199611996219963199641996519966199671996819969199701997119972199731997419975199761997719978199791998019981199821998319984199851998619987199881998919990199911999219993199941999519996199971999819999200002000120002200032000420005200062000720008200092001020011200122001320014200152001620017200182001920020200212002220023200242002520026200272002820029200302003120032200332003420035200362003720038200392004020041200422004320044200452004620047200482004920050200512005220053200542005520056200572005820059200602006120062200632006420065200662006720068200692007020071200722007320074200752007620077200782007920080200812008220083200842008520086200872008820089200902009120092200932009420095200962009720098200992010020101201022010320104201052010620107201082010920110201112011220113201142011520116201172011820119201202012120122201232012420125201262012720128201292013020131201322013320134201352013620137201382013920140201412014220143201442014520146201472014820149201502015120152201532015420155201562015720158201592016020161201622016320164201652016620167201682016920170201712017220173201742017520176201772017820179201802018120182201832018420185201862018720188201892019020191201922019320194201952019620197201982019920200202012020220203202042020520206202072020820209202102021120212202132021420215202162021720218202192022020221202222022320224202252022620227202282022920230202312023220233202342023520236202372023820239202402024120242202432024420245202462024720248202492025020251202522025320254202552025620257202582025920260202612026220263202642026520266202672026820269202702027120272202732027420275202762027720278202792028020281202822028320284202852028620287202882028920290202912029220293202942029520296202972029820299203002030120302203032030420305203062030720308203092031020311203122031320314203152031620317203182031920320203212032220323203242032520326203272032820329203302033120332203332033420335203362033720338203392034020341203422034320344203452034620347203482034920350203512035220353203542035520356203572035820359203602036120362203632036420365203662036720368203692037020371203722037320374203752037620377203782037920380203812038220383203842038520386203872038820389203902039120392203932039420395203962039720398203992040020401204022040320404204052040620407204082040920410204112041220413204142041520416204172041820419204202042120422204232042420425204262042720428204292043020431204322043320434204352043620437204382043920440204412044220443204442044520446204472044820449204502045120452204532045420455204562045720458204592046020461204622046320464204652046620467204682046920470204712047220473204742047520476204772047820479204802048120482204832048420485204862048720488204892049020491204922049320494204952049620497204982049920500205012050220503205042050520506205072050820509205102051120512205132051420515205162051720518205192052020521205222052320524205252052620527205282052920530205312053220533205342053520536205372053820539205402054120542205432054420545205462054720548205492055020551205522055320554205552055620557205582055920560205612056220563205642056520566205672056820569205702057120572205732057420575205762057720578205792058020581205822058320584205852058620587205882058920590205912059220593205942059520596205972059820599206002060120602206032060420605206062060720608206092061020611206122061320614206152061620617206182061920620206212062220623206242062520626206272062820629206302063120632206332063420635206362063720638206392064020641206422064320644206452064620647206482064920650206512065220653206542065520656206572065820659206602066120662206632066420665206662066720668206692067020671206722067320674206752067620677206782067920680206812068220683206842068520686206872068820689206902069120692206932069420695206962069720698206992070020701207022070320704207052070620707207082070920710207112071220713207142071520716207172071820719207202072120722207232072420725207262072720728207292073020731207322073320734207352073620737207382073920740207412074220743207442074520746207472074820749207502075120752207532075420755207562075720758207592076020761207622076320764207652076620767207682076920770207712077220773207742077520776207772077820779207802078120782207832078420785207862078720788207892079020791207922079320794207952079620797207982079920800208012080220803208042080520806208072080820809208102081120812208132081420815208162081720818208192082020821208222082320824208252082620827208282082920830208312083220833208342083520836208372083820839208402084120842208432084420845208462084720848208492085020851208522085320854208552085620857208582085920860208612086220863208642086520866208672086820869208702087120872208732087420875208762087720878208792088020881208822088320884208852088620887208882088920890208912089220893208942089520896208972089820899209002090120902209032090420905209062090720908209092091020911209122091320914209152091620917209182091920920209212092220923209242092520926209272092820929209302093120932209332093420935209362093720938209392094020941209422094320944209452094620947209482094920950209512095220953209542095520956209572095820959209602096120962209632096420965209662096720968209692097020971209722097320974209752097620977209782097920980209812098220983209842098520986209872098820989209902099120992209932099420995209962099720998209992100021001210022100321004210052100621007210082100921010210112101221013210142101521016210172101821019210202102121022210232102421025210262102721028210292103021031210322103321034210352103621037210382103921040210412104221043210442104521046210472104821049210502105121052210532105421055210562105721058210592106021061210622106321064210652106621067210682106921070210712107221073210742107521076210772107821079210802108121082210832108421085210862108721088210892109021091210922109321094210952109621097210982109921100211012110221103211042110521106211072110821109211102111121112211132111421115211162111721118211192112021121211222112321124211252112621127211282112921130211312113221133211342113521136211372113821139211402114121142211432114421145211462114721148211492115021151211522115321154211552115621157211582115921160211612116221163211642116521166211672116821169211702117121172211732117421175211762117721178211792118021181211822118321184211852118621187211882118921190211912119221193211942119521196211972119821199212002120121202212032120421205212062120721208212092121021211212122121321214212152121621217212182121921220212212122221223212242122521226212272122821229212302123121232212332123421235212362123721238212392124021241212422124321244212452124621247212482124921250212512125221253212542125521256212572125821259212602126121262212632126421265212662126721268212692127021271212722127321274212752127621277212782127921280212812128221283212842128521286212872128821289212902129121292212932129421295212962129721298212992130021301213022130321304213052130621307213082130921310213112131221313213142131521316213172131821319213202132121322213232132421325213262132721328213292133021331213322133321334213352133621337213382133921340213412134221343213442134521346213472134821349213502135121352213532135421355213562135721358213592136021361213622136321364213652136621367213682136921370213712137221373213742137521376213772137821379213802138121382213832138421385213862138721388213892139021391213922139321394213952139621397213982139921400214012140221403214042140521406214072140821409214102141121412214132141421415214162141721418214192142021421214222142321424214252142621427214282142921430214312143221433214342143521436214372143821439214402144121442214432144421445214462144721448214492145021451214522145321454214552145621457214582145921460214612146221463214642146521466214672146821469214702147121472214732147421475214762147721478214792148021481214822148321484214852148621487214882148921490214912149221493214942149521496214972149821499215002150121502215032150421505215062150721508215092151021511215122151321514215152151621517215182151921520215212152221523215242152521526215272152821529215302153121532215332153421535215362153721538215392154021541215422154321544215452154621547215482154921550215512155221553215542155521556215572155821559215602156121562215632156421565215662156721568215692157021571215722157321574215752157621577215782157921580215812158221583215842158521586215872158821589215902159121592215932159421595215962159721598215992160021601216022160321604216052160621607216082160921610216112161221613216142161521616216172161821619216202162121622216232162421625216262162721628216292163021631216322163321634216352163621637216382163921640216412164221643216442164521646216472164821649216502165121652216532165421655216562165721658216592166021661216622166321664216652166621667216682166921670216712167221673216742167521676216772167821679216802168121682216832168421685216862168721688216892169021691216922169321694216952169621697216982169921700217012170221703217042170521706217072170821709217102171121712217132171421715217162171721718217192172021721217222172321724217252172621727217282172921730217312173221733217342173521736217372173821739217402174121742217432174421745217462174721748217492175021751217522175321754217552175621757217582175921760217612176221763217642176521766217672176821769217702177121772217732177421775217762177721778217792178021781217822178321784217852178621787217882178921790217912179221793217942179521796217972179821799218002180121802218032180421805218062180721808218092181021811218122181321814218152181621817218182181921820218212182221823218242182521826218272182821829218302183121832218332183421835218362183721838218392184021841218422184321844218452184621847218482184921850218512185221853218542185521856218572185821859218602186121862218632186421865218662186721868218692187021871218722187321874218752187621877218782187921880218812188221883218842188521886218872188821889218902189121892218932189421895218962189721898218992190021901219022190321904219052190621907219082190921910219112191221913219142191521916219172191821919219202192121922219232192421925219262192721928219292193021931219322193321934219352193621937219382193921940219412194221943219442194521946219472194821949219502195121952219532195421955219562195721958219592196021961219622196321964219652196621967219682196921970219712197221973219742197521976219772197821979219802198121982219832198421985219862198721988219892199021991219922199321994219952199621997219982199922000220012200222003220042200522006220072200822009220102201122012220132201422015220162201722018220192202022021220222202322024220252202622027220282202922030220312203222033220342203522036220372203822039220402204122042220432204422045220462204722048220492205022051220522205322054220552205622057220582205922060220612206222063220642206522066220672206822069220702207122072220732207422075220762207722078220792208022081220822208322084220852208622087220882208922090220912209222093220942209522096220972209822099221002210122102221032210422105221062210722108221092211022111221122211322114221152211622117221182211922120221212212222123221242212522126221272212822129221302213122132221332213422135221362213722138221392214022141221422214322144221452214622147221482214922150221512215222153221542215522156221572215822159221602216122162221632216422165221662216722168221692217022171221722217322174221752217622177221782217922180221812218222183221842218522186221872218822189221902219122192221932219422195221962219722198221992220022201222022220322204222052220622207222082220922210222112221222213222142221522216222172221822219222202222122222222232222422225222262222722228222292223022231222322223322234222352223622237222382223922240222412224222243222442224522246222472224822249222502225122252222532225422255222562225722258222592226022261222622226322264222652226622267222682226922270222712227222273222742227522276222772227822279222802228122282222832228422285222862228722288222892229022291222922229322294222952229622297222982229922300223012230222303223042230522306223072230822309223102231122312223132231422315223162231722318223192232022321223222232322324223252232622327223282232922330223312233222333223342233522336223372233822339223402234122342223432234422345223462234722348223492235022351223522235322354223552235622357223582235922360223612236222363223642236522366223672236822369223702237122372223732237422375223762237722378223792238022381223822238322384223852238622387223882238922390223912239222393223942239522396223972239822399224002240122402224032240422405224062240722408224092241022411224122241322414224152241622417224182241922420224212242222423224242242522426224272242822429224302243122432224332243422435224362243722438224392244022441224422244322444224452244622447224482244922450224512245222453224542245522456224572245822459224602246122462224632246422465224662246722468224692247022471224722247322474224752247622477224782247922480224812248222483224842248522486224872248822489224902249122492224932249422495224962249722498224992250022501225022250322504225052250622507225082250922510225112251222513225142251522516225172251822519225202252122522225232252422525225262252722528225292253022531225322253322534225352253622537225382253922540225412254222543225442254522546225472254822549225502255122552225532255422555225562255722558225592256022561225622256322564225652256622567225682256922570225712257222573225742257522576225772257822579225802258122582225832258422585225862258722588225892259022591225922259322594225952259622597225982259922600226012260222603226042260522606226072260822609226102261122612226132261422615226162261722618226192262022621226222262322624226252262622627226282262922630226312263222633226342263522636226372263822639226402264122642226432264422645226462264722648226492265022651226522265322654226552265622657226582265922660226612266222663226642266522666226672266822669226702267122672226732267422675226762267722678226792268022681226822268322684226852268622687226882268922690226912269222693226942269522696226972269822699227002270122702227032270422705227062270722708227092271022711227122271322714227152271622717227182271922720227212272222723227242272522726227272272822729227302273122732227332273422735227362273722738227392274022741227422274322744227452274622747227482274922750227512275222753227542275522756227572275822759227602276122762227632276422765227662276722768227692277022771227722277322774227752277622777227782277922780227812278222783227842278522786227872278822789227902279122792227932279422795227962279722798227992280022801228022280322804228052280622807228082280922810228112281222813228142281522816228172281822819228202282122822228232282422825228262282722828228292283022831228322283322834228352283622837228382283922840228412284222843228442284522846228472284822849228502285122852228532285422855228562285722858228592286022861228622286322864228652286622867228682286922870228712287222873228742287522876228772287822879228802288122882228832288422885228862288722888228892289022891228922289322894228952289622897228982289922900229012290222903229042290522906229072290822909229102291122912229132291422915229162291722918229192292022921229222292322924229252292622927229282292922930229312293222933229342293522936229372293822939229402294122942229432294422945229462294722948229492295022951229522295322954229552295622957229582295922960229612296222963229642296522966229672296822969229702297122972229732297422975229762297722978229792298022981229822298322984229852298622987229882298922990229912299222993229942299522996229972299822999230002300123002230032300423005230062300723008230092301023011230122301323014230152301623017230182301923020230212302223023230242302523026230272302823029230302303123032230332303423035230362303723038230392304023041230422304323044230452304623047230482304923050230512305223053230542305523056230572305823059230602306123062230632306423065230662306723068230692307023071230722307323074230752307623077230782307923080230812308223083230842308523086230872308823089230902309123092230932309423095230962309723098230992310023101231022310323104231052310623107231082310923110231112311223113231142311523116231172311823119231202312123122231232312423125231262312723128231292313023131231322313323134231352313623137231382313923140231412314223143231442314523146231472314823149231502315123152231532315423155231562315723158231592316023161231622316323164231652316623167231682316923170231712317223173231742317523176231772317823179231802318123182231832318423185231862318723188231892319023191231922319323194231952319623197231982319923200232012320223203232042320523206232072320823209232102321123212232132321423215232162321723218232192322023221232222322323224232252322623227232282322923230232312323223233232342323523236232372323823239232402324123242232432324423245232462324723248232492325023251232522325323254232552325623257232582325923260232612326223263232642326523266232672326823269232702327123272232732327423275232762327723278232792328023281232822328323284232852328623287232882328923290232912329223293232942329523296232972329823299233002330123302233032330423305233062330723308233092331023311233122331323314233152331623317233182331923320233212332223323233242332523326233272332823329233302333123332233332333423335233362333723338233392334023341233422334323344233452334623347233482334923350233512335223353233542335523356233572335823359233602336123362233632336423365233662336723368233692337023371233722337323374233752337623377233782337923380233812338223383233842338523386233872338823389233902339123392233932339423395233962339723398233992340023401234022340323404234052340623407234082340923410234112341223413234142341523416234172341823419234202342123422234232342423425234262342723428234292343023431234322343323434234352343623437234382343923440234412344223443234442344523446234472344823449234502345123452234532345423455234562345723458234592346023461234622346323464234652346623467234682346923470234712347223473234742347523476234772347823479234802348123482234832348423485234862348723488234892349023491234922349323494234952349623497234982349923500235012350223503235042350523506235072350823509235102351123512235132351423515235162351723518235192352023521235222352323524235252352623527235282352923530235312353223533235342353523536235372353823539235402354123542235432354423545235462354723548235492355023551235522355323554235552355623557235582355923560235612356223563235642356523566235672356823569235702357123572235732357423575235762357723578235792358023581235822358323584235852358623587235882358923590235912359223593235942359523596235972359823599236002360123602236032360423605236062360723608236092361023611236122361323614236152361623617236182361923620236212362223623236242362523626236272362823629236302363123632236332363423635236362363723638236392364023641236422364323644236452364623647236482364923650236512365223653236542365523656236572365823659236602366123662236632366423665236662366723668236692367023671236722367323674236752367623677236782367923680236812368223683236842368523686236872368823689236902369123692236932369423695236962369723698236992370023701237022370323704237052370623707237082370923710237112371223713237142371523716237172371823719237202372123722237232372423725237262372723728237292373023731237322373323734237352373623737237382373923740
  1. ;;; org.el --- Outline-based notes management and organizer
  2. ;; Carstens outline-mode for keeping track of everything.
  3. ;; Copyright (C) 2004-2013 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. (load "org-loaddefs.el" t t t)
  73. (require 'org-macs)
  74. (require 'org-compat)
  75. ;; `org-outline-regexp' ought to be a defconst but is let-binding in
  76. ;; some places -- e.g. see the macro `org-with-limited-levels'.
  77. ;;
  78. ;; In Org buffers, the value of `outline-regexp' is that of
  79. ;; `org-outline-regexp'. The only function still directly relying on
  80. ;; `outline-regexp' is `org-overview' so that `org-cycle' can do its
  81. ;; job when `orgstruct-mode' is active.
  82. (defvar org-outline-regexp "\\*+ "
  83. "Regexp to match Org headlines.")
  84. (defvar org-outline-regexp-bol "^\\*+ "
  85. "Regexp to match Org headlines.
  86. This is similar to `org-outline-regexp' but additionally makes
  87. sure that we are at the beginning of the line.")
  88. (defvar org-heading-regexp "^\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
  89. "Matches a headline, putting stars and text into groups.
  90. Stars are put in group 1 and the trimmed body in group 2.")
  91. ;; Emacs 22 calendar compatibility: Make sure the new variables are available
  92. (unless (boundp 'calendar-view-holidays-initially-flag)
  93. (org-defvaralias 'calendar-view-holidays-initially-flag
  94. 'view-calendar-holidays-initially))
  95. (unless (boundp 'calendar-view-diary-initially-flag)
  96. (org-defvaralias 'calendar-view-diary-initially-flag
  97. 'view-diary-entries-initially))
  98. (unless (boundp 'diary-fancy-buffer)
  99. (org-defvaralias 'diary-fancy-buffer 'fancy-diary-buffer))
  100. (declare-function org-inlinetask-at-task-p "org-inlinetask" ())
  101. (declare-function org-inlinetask-outline-regexp "org-inlinetask" ())
  102. (declare-function org-inlinetask-toggle-visibility "org-inlinetask" ())
  103. (declare-function org-pop-to-buffer-same-window "org-compat" (&optional buffer-or-name norecord label))
  104. (declare-function org-clock-get-last-clock-out-time "org-clock" ())
  105. (declare-function org-clock-timestamps-up "org-clock" (&optional n))
  106. (declare-function org-clock-timestamps-down "org-clock" (&optional n))
  107. (declare-function org-clock-sum-current-item "org-clock" (&optional tstart))
  108. (declare-function orgtbl-mode "org-table" (&optional arg))
  109. (declare-function org-clock-out "org-clock" (&optional switch-to-state fail-quietly at-time))
  110. (declare-function org-beamer-mode "ox-beamer" ())
  111. (declare-function org-table-edit-field "org-table" (arg))
  112. (declare-function org-table-justify-field-maybe "org-table" (&optional new))
  113. (declare-function org-table-set-constants "org-table" ())
  114. (declare-function org-table-calc-current-TBLFM "org-table" (&optional arg))
  115. (declare-function org-id-get-create "org-id" (&optional force))
  116. (declare-function org-id-find-id-file "org-id" (id))
  117. (declare-function org-tags-view "org-agenda" (&optional todo-only match))
  118. (declare-function org-agenda-list "org-agenda" (&optional arg start-day span))
  119. (declare-function org-agenda-redo "org-agenda" (&optional all))
  120. (declare-function org-table-align "org-table" ())
  121. (declare-function org-table-paste-rectangle "org-table" ())
  122. (declare-function org-table-maybe-eval-formula "org-table" ())
  123. (declare-function org-table-maybe-recalculate-line "org-table" ())
  124. (declare-function org-element--parse-objects "org-element"
  125. (beg end acc restriction))
  126. (declare-function org-element-at-point "org-element" (&optional keep-trail))
  127. (declare-function org-element-contents "org-element" (element))
  128. (declare-function org-element-context "org-element" (&optional element))
  129. (declare-function org-element-interpret-data "org-element"
  130. (data &optional parent))
  131. (declare-function org-element-map "org-element"
  132. (data types fun &optional info first-match no-recursion))
  133. (declare-function org-element-nested-p "org-element" (elem-a elem-b))
  134. (declare-function org-element-parse-buffer "org-element"
  135. (&optional granularity visible-only))
  136. (declare-function org-element-property "org-element" (property element))
  137. (declare-function org-element-put-property "org-element"
  138. (element property value))
  139. (declare-function org-element-swap-A-B "org-element" (elem-a elem-b))
  140. (declare-function org-element--parse-objects "org-element"
  141. (beg end acc restriction))
  142. (declare-function org-element-parse-buffer "org-element"
  143. (&optional granularity visible-only))
  144. (declare-function org-element-restriction "org-element" (element))
  145. (declare-function org-element-type "org-element" (element))
  146. ;; load languages based on value of `org-babel-load-languages'
  147. (defvar org-babel-load-languages)
  148. ;;;###autoload
  149. (defun org-babel-do-load-languages (sym value)
  150. "Load the languages defined in `org-babel-load-languages'."
  151. (set-default sym value)
  152. (mapc (lambda (pair)
  153. (let ((active (cdr pair)) (lang (symbol-name (car pair))))
  154. (if active
  155. (progn
  156. (require (intern (concat "ob-" lang))))
  157. (progn
  158. (funcall 'fmakunbound
  159. (intern (concat "org-babel-execute:" lang)))
  160. (funcall 'fmakunbound
  161. (intern (concat "org-babel-expand-body:" lang)))))))
  162. org-babel-load-languages))
  163. ;;;###autoload
  164. (defun org-babel-load-file (file &optional compile)
  165. "Load Emacs Lisp source code blocks in the Org-mode FILE.
  166. This function exports the source code using `org-babel-tangle'
  167. and then loads the resulting file using `load-file'. With prefix
  168. arg (noninteractively: 2nd arg) COMPILE the tangled Emacs Lisp
  169. file to byte-code before it is loaded."
  170. (interactive "fFile to load: \nP")
  171. (require 'ob-core)
  172. (let* ((age (lambda (file)
  173. (float-time
  174. (time-subtract (current-time)
  175. (nth 5 (or (file-attributes (file-truename file))
  176. (file-attributes file)))))))
  177. (base-name (file-name-sans-extension file))
  178. (exported-file (concat base-name ".el")))
  179. ;; tangle if the org-mode file is newer than the elisp file
  180. (unless (and (file-exists-p exported-file)
  181. (> (funcall age file) (funcall age exported-file)))
  182. (org-babel-tangle-file file exported-file "emacs-lisp"))
  183. (message "%s %s"
  184. (if compile
  185. (progn (byte-compile-file exported-file 'load)
  186. "Compiled and loaded")
  187. (progn (load-file exported-file) "Loaded"))
  188. exported-file)))
  189. (defcustom org-babel-load-languages '((emacs-lisp . t))
  190. "Languages which can be evaluated in Org-mode buffers.
  191. This list can be used to load support for any of the languages
  192. below, note that each language will depend on a different set of
  193. system executables and/or Emacs modes. When a language is
  194. \"loaded\", then code blocks in that language can be evaluated
  195. with `org-babel-execute-src-block' bound by default to C-c
  196. C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
  197. be set to remove code block evaluation from the C-c C-c
  198. keybinding. By default only Emacs Lisp (which has no
  199. requirements) is loaded."
  200. :group 'org-babel
  201. :set 'org-babel-do-load-languages
  202. :version "24.1"
  203. :type '(alist :tag "Babel Languages"
  204. :key-type
  205. (choice
  206. (const :tag "Awk" awk)
  207. (const :tag "C" C)
  208. (const :tag "R" R)
  209. (const :tag "Asymptote" asymptote)
  210. (const :tag "Calc" calc)
  211. (const :tag "Clojure" clojure)
  212. (const :tag "CSS" css)
  213. (const :tag "Ditaa" ditaa)
  214. (const :tag "Dot" dot)
  215. (const :tag "Emacs Lisp" emacs-lisp)
  216. (const :tag "Fortran" fortran)
  217. (const :tag "Gnuplot" gnuplot)
  218. (const :tag "Haskell" haskell)
  219. (const :tag "IO" io)
  220. (const :tag "Java" java)
  221. (const :tag "Javascript" js)
  222. (const :tag "LaTeX" latex)
  223. (const :tag "Ledger" ledger)
  224. (const :tag "Lilypond" lilypond)
  225. (const :tag "Lisp" lisp)
  226. (const :tag "Makefile" makefile)
  227. (const :tag "Maxima" maxima)
  228. (const :tag "Matlab" matlab)
  229. (const :tag "Mscgen" mscgen)
  230. (const :tag "Ocaml" ocaml)
  231. (const :tag "Octave" octave)
  232. (const :tag "Org" org)
  233. (const :tag "Perl" perl)
  234. (const :tag "Pico Lisp" picolisp)
  235. (const :tag "PlantUML" plantuml)
  236. (const :tag "Python" python)
  237. (const :tag "Ruby" ruby)
  238. (const :tag "Sass" sass)
  239. (const :tag "Scala" scala)
  240. (const :tag "Scheme" scheme)
  241. (const :tag "Screen" screen)
  242. (const :tag "Shell Script" sh)
  243. (const :tag "Shen" shen)
  244. (const :tag "Sql" sql)
  245. (const :tag "Sqlite" sqlite))
  246. :value-type (boolean :tag "Activate" :value t)))
  247. ;;;; Customization variables
  248. (defcustom org-clone-delete-id nil
  249. "Remove ID property of clones of a subtree.
  250. When non-nil, clones of a subtree don't inherit the ID property.
  251. Otherwise they inherit the ID property with a new unique
  252. identifier."
  253. :type 'boolean
  254. :version "24.1"
  255. :group 'org-id)
  256. ;;; Version
  257. (org-check-version)
  258. ;;;###autoload
  259. (defun org-version (&optional here full message)
  260. "Show the org-mode version in the echo area.
  261. With prefix argument HERE, insert it at point.
  262. When FULL is non-nil, use a verbose version string.
  263. When MESSAGE is non-nil, display a message with the version."
  264. (interactive "P")
  265. (let* ((org-dir (ignore-errors (org-find-library-dir "org")))
  266. (save-load-suffixes (when (boundp 'load-suffixes) load-suffixes))
  267. (load-suffixes (list ".el"))
  268. (org-install-dir (ignore-errors (org-find-library-dir "org-loaddefs")))
  269. (org-trash (or
  270. (and (fboundp 'org-release) (fboundp 'org-git-version))
  271. (org-load-noerror-mustsuffix (concat org-dir "org-version"))))
  272. (load-suffixes save-load-suffixes)
  273. (org-version (org-release))
  274. (git-version (org-git-version))
  275. (version (format "Org-mode version %s (%s @ %s)"
  276. org-version
  277. git-version
  278. (if org-install-dir
  279. (if (string= org-dir org-install-dir)
  280. org-install-dir
  281. (concat "mixed installation! " org-install-dir " and " org-dir))
  282. "org-loaddefs.el can not be found!")))
  283. (_version (if full version org-version)))
  284. (if (org-called-interactively-p 'interactive)
  285. (if here
  286. (insert version)
  287. (message version))
  288. (if message (message _version))
  289. _version)))
  290. (defconst org-version (org-version))
  291. ;;; Compatibility constants
  292. ;;; The custom variables
  293. (defgroup org nil
  294. "Outline-based notes management and organizer."
  295. :tag "Org"
  296. :group 'outlines
  297. :group 'calendar)
  298. (defcustom org-mode-hook nil
  299. "Mode hook for Org-mode, run after the mode was turned on."
  300. :group 'org
  301. :type 'hook)
  302. (defcustom org-load-hook nil
  303. "Hook that is run after org.el has been loaded."
  304. :group 'org
  305. :type 'hook)
  306. (defcustom org-log-buffer-setup-hook nil
  307. "Hook that is run after an Org log buffer is created."
  308. :group 'org
  309. :version "24.1"
  310. :type 'hook)
  311. (defvar org-modules) ; defined below
  312. (defvar org-modules-loaded nil
  313. "Have the modules been loaded already?")
  314. (defun org-load-modules-maybe (&optional force)
  315. "Load all extensions listed in `org-modules'."
  316. (when (or force (not org-modules-loaded))
  317. (mapc (lambda (ext)
  318. (condition-case nil (require ext)
  319. (error (message "Problems while trying to load feature `%s'" ext))))
  320. org-modules)
  321. (setq org-modules-loaded t)))
  322. (defun org-set-modules (var value)
  323. "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
  324. (set var value)
  325. (when (featurep 'org)
  326. (org-load-modules-maybe 'force)))
  327. (defcustom org-modules '(org-w3m org-bbdb org-bibtex org-docview org-gnus org-info org-irc org-mhe org-rmail)
  328. "Modules that should always be loaded together with org.el.
  329. If a description starts with <C>, the file is not part of Emacs
  330. and loading it will require that you have downloaded and properly
  331. installed the Org mode distribution.
  332. You can also use this system to load external packages (i.e. neither Org
  333. core modules, nor modules from the CONTRIB directory). Just add symbols
  334. to the end of the list. If the package is called org-xyz.el, then you need
  335. to add the symbol `xyz', and the package must have a call to:
  336. \(provide 'org-xyz)
  337. For export specific modules, see also `org-export-backends'."
  338. :group 'org
  339. :set 'org-set-modules
  340. :version "24.4"
  341. :package-version '(Org . "8.0")
  342. :type
  343. '(set :greedy t
  344. (const :tag " bbdb: Links to BBDB entries" org-bbdb)
  345. (const :tag " bibtex: Links to BibTeX entries" org-bibtex)
  346. (const :tag " crypt: Encryption of subtrees" org-crypt)
  347. (const :tag " ctags: Access to Emacs tags with links" org-ctags)
  348. (const :tag " docview: Links to doc-view buffers" org-docview)
  349. (const :tag " gnus: Links to GNUS folders/messages" org-gnus)
  350. (const :tag " habit: Track your consistency with habits" org-habit)
  351. (const :tag " id: Global IDs for identifying entries" org-id)
  352. (const :tag " info: Links to Info nodes" org-info)
  353. (const :tag " inlinetask: Tasks independent of outline hierarchy" org-inlinetask)
  354. (const :tag " irc: Links to IRC/ERC chat sessions" org-irc)
  355. (const :tag " mhe: Links to MHE folders/messages" org-mhe)
  356. (const :tag " mouse: Additional mouse support" org-mouse)
  357. (const :tag " protocol: Intercept calls from emacsclient" org-protocol)
  358. (const :tag " rmail: Links to RMAIL folders/messages" org-rmail)
  359. (const :tag " w3m: Special cut/paste from w3m to Org-mode." org-w3m)
  360. (const :tag "C annotate-file: Annotate a file with org syntax" org-annotate-file)
  361. (const :tag "C bookmark: Org-mode links to bookmarks" org-bookmark)
  362. (const :tag "C bullets: Add overlays to headlines stars" org-bullets)
  363. (const :tag "C checklist: Extra functions for checklists in repeated tasks" org-checklist)
  364. (const :tag "C choose: Use TODO keywords to mark decisions states" org-choose)
  365. (const :tag "C collector: Collect properties into tables" org-collector)
  366. (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
  367. (const :tag "C drill: Flashcards and spaced repetition for Org-mode" org-drill)
  368. (const :tag "C elisp-symbol: Org-mode links to emacs-lisp symbols" org-elisp-symbol)
  369. (const :tag "C eshell Support for links to working directories in eshell" org-eshell)
  370. (const :tag "C eval-light: Evaluate inbuffer-code on demand" org-eval-light)
  371. (const :tag "C eval: Include command output as text" org-eval)
  372. (const :tag "C expiry: Expiry mechanism for Org-mode entries" org-expiry)
  373. (const :tag "C favtable: Lookup table of favorite references and links" org-favtable)
  374. (const :tag "C git-link: Provide org links to specific file version" org-git-link)
  375. (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
  376. (const :tag "C invoice: Help manage client invoices in Org-mode" org-invoice)
  377. (const :tag "C jira: Add a jira:ticket protocol to Org-mode" org-jira)
  378. (const :tag "C learn: SuperMemo's incremental learning algorithm" org-learn)
  379. (const :tag "C mac-iCal Imports events from iCal.app to the Emacs diary" org-mac-iCal)
  380. (const :tag "C mac-link: Grab links and url from various mac Applications" org-mac-link)
  381. (const :tag "C mairix: Hook mairix search into Org-mode for different MUAs" org-mairix)
  382. (const :tag "C man: Support for links to manpages in Org-mode" org-man)
  383. (const :tag "C mew: Links to Mew folders/messages" org-mew)
  384. (const :tag "C mtags: Support for muse-like tags" org-mtags)
  385. (const :tag "C notmuch: Provide org links to notmuch searches or messages" org-notmuch)
  386. (const :tag "C panel: Simple routines for us with bad memory" org-panel)
  387. (const :tag "C registry: A registry for Org-mode links" org-registry)
  388. (const :tag "C screen: Visit screen sessions through Org-mode links" org-screen)
  389. (const :tag "C secretary: Team management with org-mode" org-secretary)
  390. (const :tag "C sqlinsert: Convert Org-mode tables to SQL insertions" orgtbl-sqlinsert)
  391. (const :tag "C toc: Table of contents for Org-mode buffer" org-toc)
  392. (const :tag "C track: Keep up with Org-mode development" org-track)
  393. (const :tag "C velocity Something like Notational Velocity for Org" org-velocity)
  394. (const :tag "C vm: Links to VM folders/messages" org-vm)
  395. (const :tag "C wikinodes: CamelCase wiki-like links" org-wikinodes)
  396. (const :tag "C wl: Links to Wanderlust folders/messages" org-wl)
  397. (repeat :tag "External packages" :inline t (symbol :tag "Package"))))
  398. (defvar org-export--registered-backends) ; From ox.el.
  399. (declare-function org-export-derived-backend-p "ox" (backend &rest backends))
  400. (declare-function org-export-backend-name "ox" (backend))
  401. (defcustom org-export-backends '(ascii html icalendar latex)
  402. "List of export back-ends that should be always available.
  403. If a description starts with <C>, the file is not part of Emacs
  404. and loading it will require that you have downloaded and properly
  405. installed the Org mode distribution.
  406. Unlike to `org-modules', libraries in this list will not be
  407. loaded along with Org, but only once the export framework is
  408. needed.
  409. This variable needs to be set before org.el is loaded. If you
  410. need to make a change while Emacs is running, use the customize
  411. interface or run the following code, where VAL stands for the new
  412. value of the variable, after updating it:
  413. \(progn
  414. \(setq org-export--registered-backends
  415. \(org-remove-if-not
  416. \(lambda (backend)
  417. \(let ((name (org-export-backend-name backend)))
  418. \(or (memq name val)
  419. \(catch 'parentp
  420. \(dolist (b val)
  421. \(and (org-export-derived-backend-p b name)
  422. \(throw 'parentp t)))))))
  423. org-export--registered-backends))
  424. \(let ((new-list (mapcar 'org-export-backend-name
  425. org-export--registered-backends)))
  426. \(dolist (backend val)
  427. \(cond
  428. \((not (load (format \"ox-%s\" backend) t t))
  429. \(message \"Problems while trying to load export back-end `%s'\"
  430. backend))
  431. \((not (memq backend new-list)) (push backend new-list))))
  432. \(set-default 'org-export-backends new-list)))
  433. Adding a back-end to this list will also pull the back-end it
  434. depends on, if any."
  435. :group 'org
  436. :group 'org-export
  437. :version "24.4"
  438. :package-version '(Org . "8.0")
  439. :initialize 'custom-initialize-set
  440. :set (lambda (var val)
  441. (if (not (featurep 'ox)) (set-default var val)
  442. ;; Any back-end not required anymore (not present in VAL and not
  443. ;; a parent of any back-end in the new value) is removed from the
  444. ;; list of registered back-ends.
  445. (setq org-export--registered-backends
  446. (org-remove-if-not
  447. (lambda (backend)
  448. (let ((name (org-export-backend-name backend)))
  449. (or (memq name val)
  450. (catch 'parentp
  451. (dolist (b val)
  452. (and (org-export-derived-backend-p b name)
  453. (throw 'parentp t)))))))
  454. org-export--registered-backends))
  455. ;; Now build NEW-LIST of both new back-ends and required
  456. ;; parents.
  457. (let ((new-list (mapcar 'org-export-backend-name
  458. org-export--registered-backends)))
  459. (dolist (backend val)
  460. (cond
  461. ((not (load (format "ox-%s" backend) t t))
  462. (message "Problems while trying to load export back-end `%s'"
  463. backend))
  464. ((not (memq backend new-list)) (push backend new-list))))
  465. ;; Set VAR to that list with fixed dependencies.
  466. (set-default var new-list))))
  467. :type '(set :greedy t
  468. (const :tag " ascii Export buffer to ASCII format" ascii)
  469. (const :tag " beamer Export buffer to Beamer presentation" beamer)
  470. (const :tag " html Export buffer to HTML format" html)
  471. (const :tag " icalendar Export buffer to iCalendar format" icalendar)
  472. (const :tag " latex Export buffer to LaTeX format" latex)
  473. (const :tag " man Export buffer to MAN format" man)
  474. (const :tag " md Export buffer to Markdown format" md)
  475. (const :tag " odt Export buffer to ODT format" odt)
  476. (const :tag " org Export buffer to Org format" org)
  477. (const :tag " texinfo Export buffer to Texinfo format" texinfo)
  478. (const :tag "C confluence Export buffer to Confluence Wiki format" confluence)
  479. (const :tag "C deck Export buffer to deck.js presentations" deck)
  480. (const :tag "C freemind Export buffer to Freemind mindmap format" freemind)
  481. (const :tag "C groff Export buffer to Groff format" groff)
  482. (const :tag "C koma-letter Export buffer to KOMA Scrlttrl2 format" koma-letter)
  483. (const :tag "C RSS 2.0 Export buffer to RSS 2.0 format" rss)
  484. (const :tag "C s5 Export buffer to s5 presentations" s5)
  485. (const :tag "C taskjuggler Export buffer to TaskJuggler format" taskjuggler)))
  486. (eval-after-load 'ox
  487. '(mapc
  488. (lambda (backend)
  489. (condition-case nil (require (intern (format "ox-%s" backend)))
  490. (error (message "Problems while trying to load export back-end `%s'"
  491. backend))))
  492. org-export-backends))
  493. (defcustom org-support-shift-select nil
  494. "Non-nil means make shift-cursor commands select text when possible.
  495. In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
  496. start selecting a region, or enlarge regions started in this way.
  497. In Org-mode, in special contexts, these same keys are used for
  498. other purposes, important enough to compete with shift selection.
  499. Org tries to balance these needs by supporting `shift-select-mode'
  500. outside these special contexts, under control of this variable.
  501. The default of this variable is nil, to avoid confusing behavior. Shifted
  502. cursor keys will then execute Org commands in the following contexts:
  503. - on a headline, changing TODO state (left/right) and priority (up/down)
  504. - on a time stamp, changing the time
  505. - in a plain list item, changing the bullet type
  506. - in a property definition line, switching between allowed values
  507. - in the BEGIN line of a clock table (changing the time block).
  508. Outside these contexts, the commands will throw an error.
  509. When this variable is t and the cursor is not in a special
  510. context, Org-mode will support shift-selection for making and
  511. enlarging regions. To make this more effective, the bullet
  512. cycling will no longer happen anywhere in an item line, but only
  513. if the cursor is exactly on the bullet.
  514. If you set this variable to the symbol `always', then the keys
  515. will not be special in headlines, property lines, and item lines,
  516. to make shift selection work there as well. If this is what you
  517. want, you can use the following alternative commands: `C-c C-t'
  518. and `C-c ,' to change TODO state and priority, `C-u C-u C-c C-t'
  519. can be used to switch TODO sets, `C-c -' to cycle item bullet
  520. types, and properties can be edited by hand or in column view.
  521. However, when the cursor is on a timestamp, shift-cursor commands
  522. will still edit the time stamp - this is just too good to give up.
  523. XEmacs user should have this variable set to nil, because
  524. `shift-select-mode' is in Emacs 23 or later only."
  525. :group 'org
  526. :type '(choice
  527. (const :tag "Never" nil)
  528. (const :tag "When outside special context" t)
  529. (const :tag "Everywhere except timestamps" always)))
  530. (defcustom org-loop-over-headlines-in-active-region nil
  531. "Shall some commands act upon headlines in the active region?
  532. When set to `t', some commands will be performed in all headlines
  533. within the active region.
  534. When set to `start-level', some commands will be performed in all
  535. headlines within the active region, provided that these headlines
  536. are of the same level than the first one.
  537. When set to a string, those commands will be performed on the
  538. matching headlines within the active region. Such string must be
  539. a tags/property/todo match as it is used in the agenda tags view.
  540. The list of commands is: `org-schedule', `org-deadline',
  541. `org-todo', `org-archive-subtree', `org-archive-set-tag' and
  542. `org-archive-to-archive-sibling'. The archiving commands skip
  543. already archived entries."
  544. :type '(choice (const :tag "Don't loop" nil)
  545. (const :tag "All headlines in active region" t)
  546. (const :tag "In active region, headlines at the same level than the first one" 'start-level)
  547. (string :tag "Tags/Property/Todo matcher"))
  548. :version "24.1"
  549. :group 'org-todo
  550. :group 'org-archive)
  551. (defgroup org-startup nil
  552. "Options concerning startup of Org-mode."
  553. :tag "Org Startup"
  554. :group 'org)
  555. (defcustom org-startup-folded t
  556. "Non-nil means entering Org-mode will switch to OVERVIEW.
  557. This can also be configured on a per-file basis by adding one of
  558. the following lines anywhere in the buffer:
  559. #+STARTUP: fold (or `overview', this is equivalent)
  560. #+STARTUP: nofold (or `showall', this is equivalent)
  561. #+STARTUP: content
  562. #+STARTUP: showeverything
  563. By default, this option is ignored when Org opens agenda files
  564. for the first time. If you want the agenda to honor the startup
  565. option, set `org-agenda-inhibit-startup' to nil."
  566. :group 'org-startup
  567. :type '(choice
  568. (const :tag "nofold: show all" nil)
  569. (const :tag "fold: overview" t)
  570. (const :tag "content: all headlines" content)
  571. (const :tag "show everything, even drawers" showeverything)))
  572. (defcustom org-startup-truncated t
  573. "Non-nil means entering Org-mode will set `truncate-lines'.
  574. This is useful since some lines containing links can be very long and
  575. uninteresting. Also tables look terrible when wrapped."
  576. :group 'org-startup
  577. :type 'boolean)
  578. (defcustom org-startup-indented nil
  579. "Non-nil means turn on `org-indent-mode' on startup.
  580. This can also be configured on a per-file basis by adding one of
  581. the following lines anywhere in the buffer:
  582. #+STARTUP: indent
  583. #+STARTUP: noindent"
  584. :group 'org-structure
  585. :type '(choice
  586. (const :tag "Not" nil)
  587. (const :tag "Globally (slow on startup in large files)" t)))
  588. (defcustom org-use-sub-superscripts t
  589. "Non-nil means interpret \"_\" and \"^\" for display.
  590. When this option is turned on, you can use TeX-like syntax for sub- and
  591. superscripts. Several characters after \"_\" or \"^\" will be
  592. considered as a single item - so grouping with {} is normally not
  593. needed. For example, the following things will be parsed as single
  594. sub- or superscripts.
  595. 10^24 or 10^tau several digits will be considered 1 item.
  596. 10^-12 or 10^-tau a leading sign with digits or a word
  597. x^2-y^3 will be read as x^2 - y^3, because items are
  598. terminated by almost any nonword/nondigit char.
  599. x_{i^2} or x^(2-i) braces or parenthesis do grouping.
  600. Still, ambiguity is possible - so when in doubt use {} to enclose
  601. the sub/superscript. If you set this variable to the symbol
  602. `{}', the braces are *required* in order to trigger
  603. interpretations as sub/superscript. This can be helpful in
  604. documents that need \"_\" frequently in plain text."
  605. :group 'org-startup
  606. :version "24.1"
  607. :type '(choice
  608. (const :tag "Always interpret" t)
  609. (const :tag "Only with braces" {})
  610. (const :tag "Never interpret" nil)))
  611. (defcustom org-startup-with-beamer-mode nil
  612. "Non-nil means turn on `org-beamer-mode' on startup.
  613. This can also be configured on a per-file basis by adding one of
  614. the following lines anywhere in the buffer:
  615. #+STARTUP: beamer"
  616. :group 'org-startup
  617. :version "24.1"
  618. :type 'boolean)
  619. (defcustom org-startup-align-all-tables nil
  620. "Non-nil means align all tables when visiting a file.
  621. This is useful when the column width in tables is forced with <N> cookies
  622. in table fields. Such tables will look correct only after the first re-align.
  623. This can also be configured on a per-file basis by adding one of
  624. the following lines anywhere in the buffer:
  625. #+STARTUP: align
  626. #+STARTUP: noalign"
  627. :group 'org-startup
  628. :type 'boolean)
  629. (defcustom org-startup-with-inline-images nil
  630. "Non-nil means show inline images when loading a new Org file.
  631. This can also be configured on a per-file basis by adding one of
  632. the following lines anywhere in the buffer:
  633. #+STARTUP: inlineimages
  634. #+STARTUP: noinlineimages"
  635. :group 'org-startup
  636. :version "24.1"
  637. :type 'boolean)
  638. (defcustom org-startup-with-latex-preview nil
  639. "Non-nil means preview LaTeX fragments when loading a new Org file.
  640. This can also be configured on a per-file basis by adding one of
  641. the followinglines anywhere in the buffer:
  642. #+STARTUP: latexpreview
  643. #+STARTUP: nolatexpreview"
  644. :group 'org-startup
  645. :version "24.4"
  646. :package-version '(Org . "8.0")
  647. :type 'boolean)
  648. (defcustom org-insert-mode-line-in-empty-file nil
  649. "Non-nil means insert the first line setting Org-mode in empty files.
  650. When the function `org-mode' is called interactively in an empty file, this
  651. normally means that the file name does not automatically trigger Org-mode.
  652. To ensure that the file will always be in Org-mode in the future, a
  653. line enforcing Org-mode will be inserted into the buffer, if this option
  654. has been set."
  655. :group 'org-startup
  656. :type 'boolean)
  657. (defcustom org-replace-disputed-keys nil
  658. "Non-nil means use alternative key bindings for some keys.
  659. Org-mode uses S-<cursor> keys for changing timestamps and priorities.
  660. These keys are also used by other packages like shift-selection-mode'
  661. \(built into Emacs 23), `CUA-mode' or `windmove.el'.
  662. If you want to use Org-mode together with one of these other modes,
  663. or more generally if you would like to move some Org-mode commands to
  664. other keys, set this variable and configure the keys with the variable
  665. `org-disputed-keys'.
  666. This option is only relevant at load-time of Org-mode, and must be set
  667. *before* org.el is loaded. Changing it requires a restart of Emacs to
  668. become effective."
  669. :group 'org-startup
  670. :type 'boolean)
  671. (defcustom org-use-extra-keys nil
  672. "Non-nil means use extra key sequence definitions for certain commands.
  673. This happens automatically if you run XEmacs or if `window-system'
  674. is nil. This variable lets you do the same manually. You must
  675. set it before loading org.
  676. Example: on Carbon Emacs 22 running graphically, with an external
  677. keyboard on a Powerbook, the default way of setting M-left might
  678. not work for either Alt or ESC. Setting this variable will make
  679. it work for ESC."
  680. :group 'org-startup
  681. :type 'boolean)
  682. (org-defvaralias 'org-CUA-compatible 'org-replace-disputed-keys)
  683. (defcustom org-disputed-keys
  684. '(([(shift up)] . [(meta p)])
  685. ([(shift down)] . [(meta n)])
  686. ([(shift left)] . [(meta -)])
  687. ([(shift right)] . [(meta +)])
  688. ([(control shift right)] . [(meta shift +)])
  689. ([(control shift left)] . [(meta shift -)]))
  690. "Keys for which Org-mode and other modes compete.
  691. This is an alist, cars are the default keys, second element specifies
  692. the alternative to use when `org-replace-disputed-keys' is t.
  693. Keys can be specified in any syntax supported by `define-key'.
  694. The value of this option takes effect only at Org-mode's startup,
  695. therefore you'll have to restart Emacs to apply it after changing."
  696. :group 'org-startup
  697. :type 'alist)
  698. (defun org-key (key)
  699. "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
  700. Or return the original if not disputed.
  701. Also apply the translations defined in `org-xemacs-key-equivalents'."
  702. (when org-replace-disputed-keys
  703. (let* ((nkey (key-description key))
  704. (x (org-find-if (lambda (x)
  705. (equal (key-description (car x)) nkey))
  706. org-disputed-keys)))
  707. (setq key (if x (cdr x) key))))
  708. (when (featurep 'xemacs)
  709. (setq key (or (cdr (assoc key org-xemacs-key-equivalents)) key)))
  710. key)
  711. (defun org-find-if (predicate seq)
  712. (catch 'exit
  713. (while seq
  714. (if (funcall predicate (car seq))
  715. (throw 'exit (car seq))
  716. (pop seq)))))
  717. (defun org-defkey (keymap key def)
  718. "Define a key, possibly translated, as returned by `org-key'."
  719. (define-key keymap (org-key key) def))
  720. (defcustom org-ellipsis nil
  721. "The ellipsis to use in the Org-mode outline.
  722. When nil, just use the standard three dots. When a string, use that instead,
  723. When a face, use the standard 3 dots, but with the specified face.
  724. The change affects only Org-mode (which will then use its own display table).
  725. Changing this requires executing `M-x org-mode' in a buffer to become
  726. effective."
  727. :group 'org-startup
  728. :type '(choice (const :tag "Default" nil)
  729. (face :tag "Face" :value org-warning)
  730. (string :tag "String" :value "...#")))
  731. (defvar org-display-table nil
  732. "The display table for org-mode, in case `org-ellipsis' is non-nil.")
  733. (defgroup org-keywords nil
  734. "Keywords in Org-mode."
  735. :tag "Org Keywords"
  736. :group 'org)
  737. (defcustom org-deadline-string "DEADLINE:"
  738. "String to mark deadline entries.
  739. A deadline is this string, followed by a time stamp. Should be a word,
  740. terminated by a colon. You can insert a schedule keyword and
  741. a timestamp with \\[org-deadline].
  742. Changes become only effective after restarting Emacs."
  743. :group 'org-keywords
  744. :type 'string)
  745. (defcustom org-scheduled-string "SCHEDULED:"
  746. "String to mark scheduled TODO entries.
  747. A schedule is this string, followed by a time stamp. Should be a word,
  748. terminated by a colon. You can insert a schedule keyword and
  749. a timestamp with \\[org-schedule].
  750. Changes become only effective after restarting Emacs."
  751. :group 'org-keywords
  752. :type 'string)
  753. (defcustom org-closed-string "CLOSED:"
  754. "String used as the prefix for timestamps logging closing a TODO entry."
  755. :group 'org-keywords
  756. :type 'string)
  757. (defcustom org-clock-string "CLOCK:"
  758. "String used as prefix for timestamps clocking work hours on an item."
  759. :group 'org-keywords
  760. :type 'string)
  761. (defcustom org-closed-keep-when-no-todo nil
  762. "Remove CLOSED: time-stamp when switching back to a non-todo state?"
  763. :group 'org-todo
  764. :group 'org-keywords
  765. :version "24.4"
  766. :package-version '(Org . "8.0")
  767. :type 'boolean)
  768. (defconst org-planning-or-clock-line-re (concat "^[ \t]*\\("
  769. org-scheduled-string "\\|"
  770. org-deadline-string "\\|"
  771. org-closed-string "\\|"
  772. org-clock-string "\\)")
  773. "Matches a line with planning or clock info.")
  774. (defcustom org-comment-string "COMMENT"
  775. "Entries starting with this keyword will never be exported.
  776. An entry can be toggled between COMMENT and normal with
  777. \\[org-toggle-comment].
  778. Changes become only effective after restarting Emacs."
  779. :group 'org-keywords
  780. :type 'string)
  781. (defcustom org-quote-string "QUOTE"
  782. "Entries starting with this keyword will be exported in fixed-width font.
  783. Quoting applies only to the text in the entry following the headline, and does
  784. not extend beyond the next headline, even if that is lower level.
  785. An entry can be toggled between QUOTE and normal with
  786. \\[org-toggle-fixed-width-section]."
  787. :group 'org-keywords
  788. :type 'string)
  789. (defconst org-repeat-re
  790. "<[0-9]\\{4\\}-[0-9][0-9]-[0-9][0-9] [^>\n]*?\\([.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)"
  791. "Regular expression for specifying repeated events.
  792. After a match, group 1 contains the repeat expression.")
  793. (defgroup org-structure nil
  794. "Options concerning the general structure of Org-mode files."
  795. :tag "Org Structure"
  796. :group 'org)
  797. (defgroup org-reveal-location nil
  798. "Options about how to make context of a location visible."
  799. :tag "Org Reveal Location"
  800. :group 'org-structure)
  801. (defconst org-context-choice
  802. '(choice
  803. (const :tag "Always" t)
  804. (const :tag "Never" nil)
  805. (repeat :greedy t :tag "Individual contexts"
  806. (cons
  807. (choice :tag "Context"
  808. (const agenda)
  809. (const org-goto)
  810. (const occur-tree)
  811. (const tags-tree)
  812. (const link-search)
  813. (const mark-goto)
  814. (const bookmark-jump)
  815. (const isearch)
  816. (const default))
  817. (boolean))))
  818. "Contexts for the reveal options.")
  819. (defcustom org-show-hierarchy-above '((default . t))
  820. "Non-nil means show full hierarchy when revealing a location.
  821. Org-mode often shows locations in an org-mode file which might have
  822. been invisible before. When this is set, the hierarchy of headings
  823. above the exposed location is shown.
  824. Turning this off for example for sparse trees makes them very compact.
  825. Instead of t, this can also be an alist specifying this option for different
  826. contexts. Valid contexts are
  827. agenda when exposing an entry from the agenda
  828. org-goto when using the command `org-goto' on key C-c C-j
  829. occur-tree when using the command `org-occur' on key C-c /
  830. tags-tree when constructing a sparse tree based on tags matches
  831. link-search when exposing search matches associated with a link
  832. mark-goto when exposing the jump goal of a mark
  833. bookmark-jump when exposing a bookmark location
  834. isearch when exiting from an incremental search
  835. default default for all contexts not set explicitly"
  836. :group 'org-reveal-location
  837. :type org-context-choice)
  838. (defcustom org-show-following-heading '((default . nil))
  839. "Non-nil means show following heading when revealing a location.
  840. Org-mode often shows locations in an org-mode file which might have
  841. been invisible before. When this is set, the heading following the
  842. match is shown.
  843. Turning this off for example for sparse trees makes them very compact,
  844. but makes it harder to edit the location of the match. In such a case,
  845. use the command \\[org-reveal] to show more context.
  846. Instead of t, this can also be an alist specifying this option for different
  847. contexts. See `org-show-hierarchy-above' for valid contexts."
  848. :group 'org-reveal-location
  849. :type org-context-choice)
  850. (defcustom org-show-siblings '((default . nil) (isearch t) (bookmark-jump t))
  851. "Non-nil means show all sibling heading when revealing a location.
  852. Org-mode often shows locations in an org-mode file which might have
  853. been invisible before. When this is set, the sibling of the current entry
  854. heading are all made visible. If `org-show-hierarchy-above' is t,
  855. the same happens on each level of the hierarchy above the current entry.
  856. By default this is on for the isearch context, off for all other contexts.
  857. Turning this off for example for sparse trees makes them very compact,
  858. but makes it harder to edit the location of the match. In such a case,
  859. use the command \\[org-reveal] to show more context.
  860. Instead of t, this can also be an alist specifying this option for different
  861. contexts. See `org-show-hierarchy-above' for valid contexts."
  862. :group 'org-reveal-location
  863. :type org-context-choice
  864. :version "24.4"
  865. :package-version '(Org . "8.0"))
  866. (defcustom org-show-entry-below '((default . nil))
  867. "Non-nil means show the entry below a headline when revealing a location.
  868. Org-mode often shows locations in an org-mode file which might have
  869. been invisible before. When this is set, the text below the headline that is
  870. exposed is also shown.
  871. By default this is off for all contexts.
  872. Instead of t, this can also be an alist specifying this option for different
  873. contexts. See `org-show-hierarchy-above' for valid contexts."
  874. :group 'org-reveal-location
  875. :type org-context-choice)
  876. (defcustom org-indirect-buffer-display 'other-window
  877. "How should indirect tree buffers be displayed?
  878. This applies to indirect buffers created with the commands
  879. \\[org-tree-to-indirect-buffer] and \\[org-agenda-tree-to-indirect-buffer].
  880. Valid values are:
  881. current-window Display in the current window
  882. other-window Just display in another window.
  883. dedicated-frame Create one new frame, and re-use it each time.
  884. new-frame Make a new frame each time. Note that in this case
  885. previously-made indirect buffers are kept, and you need to
  886. kill these buffers yourself."
  887. :group 'org-structure
  888. :group 'org-agenda-windows
  889. :type '(choice
  890. (const :tag "In current window" current-window)
  891. (const :tag "In current frame, other window" other-window)
  892. (const :tag "Each time a new frame" new-frame)
  893. (const :tag "One dedicated frame" dedicated-frame)))
  894. (defcustom org-use-speed-commands nil
  895. "Non-nil means activate single letter commands at beginning of a headline.
  896. This may also be a function to test for appropriate locations where speed
  897. commands should be active."
  898. :group 'org-structure
  899. :type '(choice
  900. (const :tag "Never" nil)
  901. (const :tag "At beginning of headline stars" t)
  902. (function)))
  903. (defcustom org-speed-commands-user nil
  904. "Alist of additional speed commands.
  905. This list will be checked before `org-speed-commands-default'
  906. when the variable `org-use-speed-commands' is non-nil
  907. and when the cursor is at the beginning of a headline.
  908. The car if each entry is a string with a single letter, which must
  909. be assigned to `self-insert-command' in the global map.
  910. The cdr is either a command to be called interactively, a function
  911. to be called, or a form to be evaluated.
  912. An entry that is just a list with a single string will be interpreted
  913. as a descriptive headline that will be added when listing the speed
  914. commands in the Help buffer using the `?' speed command."
  915. :group 'org-structure
  916. :type '(repeat :value ("k" . ignore)
  917. (choice :value ("k" . ignore)
  918. (list :tag "Descriptive Headline" (string :tag "Headline"))
  919. (cons :tag "Letter and Command"
  920. (string :tag "Command letter")
  921. (choice
  922. (function)
  923. (sexp))))))
  924. (defcustom org-bookmark-names-plist
  925. '(:last-capture "org-capture-last-stored"
  926. :last-refile "org-refile-last-stored"
  927. :last-capture-marker "org-capture-last-stored-marker")
  928. "Names for bookmarks automatically set by some Org commands.
  929. This can provide strings as names for a number of bookmakrs Org sets
  930. automatically. The following keys are currently implemented:
  931. :last-capture
  932. :last-capture-marker
  933. :last-refile
  934. When a key does not show up in the property list, the corresponding bookmark
  935. is not set."
  936. :group 'org-structure
  937. :type 'plist)
  938. (defgroup org-cycle nil
  939. "Options concerning visibility cycling in Org-mode."
  940. :tag "Org Cycle"
  941. :group 'org-structure)
  942. (defcustom org-cycle-skip-children-state-if-no-children t
  943. "Non-nil means skip CHILDREN state in entries that don't have any."
  944. :group 'org-cycle
  945. :type 'boolean)
  946. (defcustom org-cycle-max-level nil
  947. "Maximum level which should still be subject to visibility cycling.
  948. Levels higher than this will, for cycling, be treated as text, not a headline.
  949. When `org-odd-levels-only' is set, a value of N in this variable actually
  950. means 2N-1 stars as the limiting headline.
  951. When nil, cycle all levels.
  952. Note that the limiting level of cycling is also influenced by
  953. `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
  954. `org-inlinetask-min-level' is, cycling will be limited to levels one less
  955. than its value."
  956. :group 'org-cycle
  957. :type '(choice
  958. (const :tag "No limit" nil)
  959. (integer :tag "Maximum level")))
  960. (defcustom org-drawers '("PROPERTIES" "CLOCK" "LOGBOOK" "RESULTS")
  961. "Names of drawers. Drawers are not opened by cycling on the headline above.
  962. Drawers only open with a TAB on the drawer line itself. A drawer looks like
  963. this:
  964. :DRAWERNAME:
  965. .....
  966. :END:
  967. The drawer \"PROPERTIES\" is special for capturing properties through
  968. the property API.
  969. Drawers can be defined on the per-file basis with a line like:
  970. #+DRAWERS: HIDDEN STATE PROPERTIES"
  971. :group 'org-structure
  972. :group 'org-cycle
  973. :type '(repeat (string :tag "Drawer Name")))
  974. (defcustom org-hide-block-startup nil
  975. "Non-nil means entering Org-mode will fold all blocks.
  976. This can also be set in on a per-file basis with
  977. #+STARTUP: hideblocks
  978. #+STARTUP: showblocks"
  979. :group 'org-startup
  980. :group 'org-cycle
  981. :type 'boolean)
  982. (defcustom org-cycle-global-at-bob nil
  983. "Cycle globally if cursor is at beginning of buffer and not at a headline.
  984. This makes it possible to do global cycling without having to use S-TAB or
  985. \\[universal-argument] TAB. For this special case to work, the first line
  986. of the buffer must not be a headline -- it may be empty or some other text.
  987. When used in this way, `org-cycle-hook' is disabled temporarily to make
  988. sure the cursor stays at the beginning of the buffer. When this option is
  989. nil, don't do anything special at the beginning of the buffer."
  990. :group 'org-cycle
  991. :type 'boolean)
  992. (defcustom org-cycle-level-after-item/entry-creation t
  993. "Non-nil means cycle entry level or item indentation in new empty entries.
  994. When the cursor is at the end of an empty headline, i.e., with only stars
  995. and maybe a TODO keyword, TAB will then switch the entry to become a child,
  996. and then all possible ancestor states, before returning to the original state.
  997. This makes data entry extremely fast: M-RET to create a new headline,
  998. on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
  999. When the cursor is at the end of an empty plain list item, one TAB will
  1000. make it a subitem, two or more tabs will back up to make this an item
  1001. higher up in the item hierarchy."
  1002. :group 'org-cycle
  1003. :type 'boolean)
  1004. (defcustom org-cycle-emulate-tab t
  1005. "Where should `org-cycle' emulate TAB.
  1006. nil Never
  1007. white Only in completely white lines
  1008. whitestart Only at the beginning of lines, before the first non-white char
  1009. t Everywhere except in headlines
  1010. exc-hl-bol Everywhere except at the start of a headline
  1011. If TAB is used in a place where it does not emulate TAB, the current subtree
  1012. visibility is cycled."
  1013. :group 'org-cycle
  1014. :type '(choice (const :tag "Never" nil)
  1015. (const :tag "Only in completely white lines" white)
  1016. (const :tag "Before first char in a line" whitestart)
  1017. (const :tag "Everywhere except in headlines" t)
  1018. (const :tag "Everywhere except at bol in headlines" exc-hl-bol)))
  1019. (defcustom org-cycle-separator-lines 2
  1020. "Number of empty lines needed to keep an empty line between collapsed trees.
  1021. If you leave an empty line between the end of a subtree and the following
  1022. headline, this empty line is hidden when the subtree is folded.
  1023. Org-mode will leave (exactly) one empty line visible if the number of
  1024. empty lines is equal or larger to the number given in this variable.
  1025. So the default 2 means at least 2 empty lines after the end of a subtree
  1026. are needed to produce free space between a collapsed subtree and the
  1027. following headline.
  1028. If the number is negative, and the number of empty lines is at least -N,
  1029. all empty lines are shown.
  1030. Special case: when 0, never leave empty lines in collapsed view."
  1031. :group 'org-cycle
  1032. :type 'integer)
  1033. (put 'org-cycle-separator-lines 'safe-local-variable 'integerp)
  1034. (defcustom org-pre-cycle-hook nil
  1035. "Hook that is run before visibility cycling is happening.
  1036. The function(s) in this hook must accept a single argument which indicates
  1037. the new state that will be set right after running this hook. The
  1038. argument is a symbol. Before a global state change, it can have the values
  1039. `overview', `content', or `all'. Before a local state change, it can have
  1040. the values `folded', `children', or `subtree'."
  1041. :group 'org-cycle
  1042. :type 'hook)
  1043. (defcustom org-cycle-hook '(org-cycle-hide-archived-subtrees
  1044. org-cycle-hide-drawers
  1045. org-cycle-hide-inline-tasks
  1046. org-cycle-show-empty-lines
  1047. org-optimize-window-after-visibility-change)
  1048. "Hook that is run after `org-cycle' has changed the buffer visibility.
  1049. The function(s) in this hook must accept a single argument which indicates
  1050. the new state that was set by the most recent `org-cycle' command. The
  1051. argument is a symbol. After a global state change, it can have the values
  1052. `overview', `contents', or `all'. After a local state change, it can have
  1053. the values `folded', `children', or `subtree'."
  1054. :group 'org-cycle
  1055. :type 'hook)
  1056. (defgroup org-edit-structure nil
  1057. "Options concerning structure editing in Org-mode."
  1058. :tag "Org Edit Structure"
  1059. :group 'org-structure)
  1060. (defcustom org-odd-levels-only nil
  1061. "Non-nil means skip even levels and only use odd levels for the outline.
  1062. This has the effect that two stars are being added/taken away in
  1063. promotion/demotion commands. It also influences how levels are
  1064. handled by the exporters.
  1065. Changing it requires restart of `font-lock-mode' to become effective
  1066. for fontification also in regions already fontified.
  1067. You may also set this on a per-file basis by adding one of the following
  1068. lines to the buffer:
  1069. #+STARTUP: odd
  1070. #+STARTUP: oddeven"
  1071. :group 'org-edit-structure
  1072. :group 'org-appearance
  1073. :type 'boolean)
  1074. (defcustom org-adapt-indentation t
  1075. "Non-nil means adapt indentation to outline node level.
  1076. When this variable is set, Org assumes that you write outlines by
  1077. indenting text in each node to align with the headline (after the stars).
  1078. The following issues are influenced by this variable:
  1079. - When this is set and the *entire* text in an entry is indented, the
  1080. indentation is increased by one space in a demotion command, and
  1081. decreased by one in a promotion command. If any line in the entry
  1082. body starts with text at column 0, indentation is not changed at all.
  1083. - Property drawers and planning information is inserted indented when
  1084. this variable s set. When nil, they will not be indented.
  1085. - TAB indents a line relative to context. The lines below a headline
  1086. will be indented when this variable is set.
  1087. Note that this is all about true indentation, by adding and removing
  1088. space characters. See also `org-indent.el' which does level-dependent
  1089. indentation in a virtual way, i.e. at display time in Emacs."
  1090. :group 'org-edit-structure
  1091. :type 'boolean)
  1092. (defcustom org-special-ctrl-a/e nil
  1093. "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
  1094. When t, `C-a' will bring back the cursor to the beginning of the
  1095. headline text, i.e. after the stars and after a possible TODO
  1096. keyword. In an item, this will be the position after bullet and
  1097. check-box, if any. When the cursor is already at that position,
  1098. another `C-a' will bring it to the beginning of the line.
  1099. `C-e' will jump to the end of the headline, ignoring the presence
  1100. of tags in the headline. A second `C-e' will then jump to the
  1101. true end of the line, after any tags. This also means that, when
  1102. this variable is non-nil, `C-e' also will never jump beyond the
  1103. end of the heading of a folded section, i.e. not after the
  1104. ellipses.
  1105. When set to the symbol `reversed', the first `C-a' or `C-e' works
  1106. normally, going to the true line boundary first. Only a directly
  1107. following, identical keypress will bring the cursor to the
  1108. special positions.
  1109. This may also be a cons cell where the behavior for `C-a' and
  1110. `C-e' is set separately."
  1111. :group 'org-edit-structure
  1112. :type '(choice
  1113. (const :tag "off" nil)
  1114. (const :tag "on: after stars/bullet and before tags first" t)
  1115. (const :tag "reversed: true line boundary first" reversed)
  1116. (cons :tag "Set C-a and C-e separately"
  1117. (choice :tag "Special C-a"
  1118. (const :tag "off" nil)
  1119. (const :tag "on: after stars/bullet first" t)
  1120. (const :tag "reversed: before stars/bullet first" reversed))
  1121. (choice :tag "Special C-e"
  1122. (const :tag "off" nil)
  1123. (const :tag "on: before tags first" t)
  1124. (const :tag "reversed: after tags first" reversed)))))
  1125. (org-defvaralias 'org-special-ctrl-a 'org-special-ctrl-a/e)
  1126. (defcustom org-special-ctrl-k nil
  1127. "Non-nil means `C-k' will behave specially in headlines.
  1128. When nil, `C-k' will call the default `kill-line' command.
  1129. When t, the following will happen while the cursor is in the headline:
  1130. - When the cursor is at the beginning of a headline, kill the entire
  1131. line and possible the folded subtree below the line.
  1132. - When in the middle of the headline text, kill the headline up to the tags.
  1133. - When after the headline text, kill the tags."
  1134. :group 'org-edit-structure
  1135. :type 'boolean)
  1136. (defcustom org-ctrl-k-protect-subtree nil
  1137. "Non-nil means, do not delete a hidden subtree with C-k.
  1138. When set to the symbol `error', simply throw an error when C-k is
  1139. used to kill (part-of) a headline that has hidden text behind it.
  1140. Any other non-nil value will result in a query to the user, if it is
  1141. OK to kill that hidden subtree. When nil, kill without remorse."
  1142. :group 'org-edit-structure
  1143. :version "24.1"
  1144. :type '(choice
  1145. (const :tag "Do not protect hidden subtrees" nil)
  1146. (const :tag "Protect hidden subtrees with a security query" t)
  1147. (const :tag "Never kill a hidden subtree with C-k" error)))
  1148. (defcustom org-catch-invisible-edits nil
  1149. "Check if in invisible region before inserting or deleting a character.
  1150. Valid values are:
  1151. nil Do not check, so just do invisible edits.
  1152. error Throw an error and do nothing.
  1153. show Make point visible, and do the requested edit.
  1154. show-and-error Make point visible, then throw an error and abort the edit.
  1155. smart Make point visible, and do insertion/deletion if it is
  1156. adjacent to visible text and the change feels predictable.
  1157. Never delete a previously invisible character or add in the
  1158. middle or right after an invisible region. Basically, this
  1159. allows insertion and backward-delete right before ellipses.
  1160. FIXME: maybe in this case we should not even show?"
  1161. :group 'org-edit-structure
  1162. :version "24.1"
  1163. :type '(choice
  1164. (const :tag "Do not check" nil)
  1165. (const :tag "Throw error when trying to edit" error)
  1166. (const :tag "Unhide, but do not do the edit" show-and-error)
  1167. (const :tag "Show invisible part and do the edit" show)
  1168. (const :tag "Be smart and do the right thing" smart)))
  1169. (defcustom org-yank-folded-subtrees t
  1170. "Non-nil means when yanking subtrees, fold them.
  1171. If the kill is a single subtree, or a sequence of subtrees, i.e. if
  1172. it starts with a heading and all other headings in it are either children
  1173. or siblings, then fold all the subtrees. However, do this only if no
  1174. text after the yank would be swallowed into a folded tree by this action."
  1175. :group 'org-edit-structure
  1176. :type 'boolean)
  1177. (defcustom org-yank-adjusted-subtrees nil
  1178. "Non-nil means when yanking subtrees, adjust the level.
  1179. With this setting, `org-paste-subtree' is used to insert the subtree, see
  1180. this function for details."
  1181. :group 'org-edit-structure
  1182. :type 'boolean)
  1183. (defcustom org-M-RET-may-split-line '((default . t))
  1184. "Non-nil means M-RET will split the line at the cursor position.
  1185. When nil, it will go to the end of the line before making a
  1186. new line.
  1187. You may also set this option in a different way for different
  1188. contexts. Valid contexts are:
  1189. headline when creating a new headline
  1190. item when creating a new item
  1191. table in a table field
  1192. default the value to be used for all contexts not explicitly
  1193. customized"
  1194. :group 'org-structure
  1195. :group 'org-table
  1196. :type '(choice
  1197. (const :tag "Always" t)
  1198. (const :tag "Never" nil)
  1199. (repeat :greedy t :tag "Individual contexts"
  1200. (cons
  1201. (choice :tag "Context"
  1202. (const headline)
  1203. (const item)
  1204. (const table)
  1205. (const default))
  1206. (boolean)))))
  1207. (defcustom org-insert-heading-respect-content nil
  1208. "Non-nil means insert new headings after the current subtree.
  1209. When nil, the new heading is created directly after the current line.
  1210. The commands \\[org-insert-heading-respect-content] and \\[org-insert-todo-heading-respect-content] turn
  1211. this variable on for the duration of the command."
  1212. :group 'org-structure
  1213. :type 'boolean)
  1214. (defcustom org-blank-before-new-entry '((heading . auto)
  1215. (plain-list-item . auto))
  1216. "Should `org-insert-heading' leave a blank line before new heading/item?
  1217. The value is an alist, with `heading' and `plain-list-item' as CAR,
  1218. and a boolean flag as CDR. The cdr may also be the symbol `auto', in
  1219. which case Org will look at the surrounding headings/items and try to
  1220. make an intelligent decision whether to insert a blank line or not.
  1221. For plain lists, if `org-list-empty-line-terminates-plain-lists' is set,
  1222. the setting here is ignored and no empty line is inserted to avoid breaking
  1223. the list structure."
  1224. :group 'org-edit-structure
  1225. :type '(list
  1226. (cons (const heading)
  1227. (choice (const :tag "Never" nil)
  1228. (const :tag "Always" t)
  1229. (const :tag "Auto" auto)))
  1230. (cons (const plain-list-item)
  1231. (choice (const :tag "Never" nil)
  1232. (const :tag "Always" t)
  1233. (const :tag "Auto" auto)))))
  1234. (defcustom org-insert-heading-hook nil
  1235. "Hook being run after inserting a new heading."
  1236. :group 'org-edit-structure
  1237. :type 'hook)
  1238. (defcustom org-enable-fixed-width-editor t
  1239. "Non-nil means lines starting with \":\" are treated as fixed-width.
  1240. This currently only means they are never auto-wrapped.
  1241. When nil, such lines will be treated like ordinary lines.
  1242. See also the QUOTE keyword."
  1243. :group 'org-edit-structure
  1244. :type 'boolean)
  1245. (defcustom org-goto-auto-isearch t
  1246. "Non-nil means typing characters in `org-goto' starts incremental search.
  1247. When nil, you can use these keybindings to navigate the buffer:
  1248. q Quit the org-goto interface
  1249. n Go to the next visible heading
  1250. p Go to the previous visible heading
  1251. f Go one heading forward on same level
  1252. b Go one heading backward on same level
  1253. u Go one heading up"
  1254. :group 'org-edit-structure
  1255. :type 'boolean)
  1256. (defgroup org-sparse-trees nil
  1257. "Options concerning sparse trees in Org-mode."
  1258. :tag "Org Sparse Trees"
  1259. :group 'org-structure)
  1260. (defcustom org-highlight-sparse-tree-matches t
  1261. "Non-nil means highlight all matches that define a sparse tree.
  1262. The highlights will automatically disappear the next time the buffer is
  1263. changed by an edit command."
  1264. :group 'org-sparse-trees
  1265. :type 'boolean)
  1266. (defcustom org-remove-highlights-with-change t
  1267. "Non-nil means any change to the buffer will remove temporary highlights.
  1268. Such highlights are created by `org-occur' and `org-clock-display'.
  1269. When nil, `C-c C-c needs to be used to get rid of the highlights.
  1270. The highlights created by `org-preview-latex-fragment' always need
  1271. `C-c C-c' to be removed."
  1272. :group 'org-sparse-trees
  1273. :group 'org-time
  1274. :type 'boolean)
  1275. (defcustom org-occur-hook '(org-first-headline-recenter)
  1276. "Hook that is run after `org-occur' has constructed a sparse tree.
  1277. This can be used to recenter the window to show as much of the structure
  1278. as possible."
  1279. :group 'org-sparse-trees
  1280. :type 'hook)
  1281. (defgroup org-imenu-and-speedbar nil
  1282. "Options concerning imenu and speedbar in Org-mode."
  1283. :tag "Org Imenu and Speedbar"
  1284. :group 'org-structure)
  1285. (defcustom org-imenu-depth 2
  1286. "The maximum level for Imenu access to Org-mode headlines.
  1287. This also applied for speedbar access."
  1288. :group 'org-imenu-and-speedbar
  1289. :type 'integer)
  1290. (defgroup org-table nil
  1291. "Options concerning tables in Org-mode."
  1292. :tag "Org Table"
  1293. :group 'org)
  1294. (defcustom org-enable-table-editor 'optimized
  1295. "Non-nil means lines starting with \"|\" are handled by the table editor.
  1296. When nil, such lines will be treated like ordinary lines.
  1297. When equal to the symbol `optimized', the table editor will be optimized to
  1298. do the following:
  1299. - Automatic overwrite mode in front of whitespace in table fields.
  1300. This makes the structure of the table stay in tact as long as the edited
  1301. field does not exceed the column width.
  1302. - Minimize the number of realigns. Normally, the table is aligned each time
  1303. TAB or RET are pressed to move to another field. With optimization this
  1304. happens only if changes to a field might have changed the column width.
  1305. Optimization requires replacing the functions `self-insert-command',
  1306. `delete-char', and `backward-delete-char' in Org-mode buffers, with a
  1307. slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
  1308. very good at guessing when a re-align will be necessary, but you can always
  1309. force one with \\[org-ctrl-c-ctrl-c].
  1310. If you would like to use the optimized version in Org-mode, but the
  1311. un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
  1312. This variable can be used to turn on and off the table editor during a session,
  1313. but in order to toggle optimization, a restart is required.
  1314. See also the variable `org-table-auto-blank-field'."
  1315. :group 'org-table
  1316. :type '(choice
  1317. (const :tag "off" nil)
  1318. (const :tag "on" t)
  1319. (const :tag "on, optimized" optimized)))
  1320. (defcustom org-self-insert-cluster-for-undo (or (featurep 'xemacs)
  1321. (version<= emacs-version "24.1"))
  1322. "Non-nil means cluster self-insert commands for undo when possible.
  1323. If this is set, then, like in the Emacs command loop, 20 consecutive
  1324. characters will be undone together.
  1325. This is configurable, because there is some impact on typing performance."
  1326. :group 'org-table
  1327. :type 'boolean)
  1328. (defcustom org-table-tab-recognizes-table.el t
  1329. "Non-nil means TAB will automatically notice a table.el table.
  1330. When it sees such a table, it moves point into it and - if necessary -
  1331. calls `table-recognize-table'."
  1332. :group 'org-table-editing
  1333. :type 'boolean)
  1334. (defgroup org-link nil
  1335. "Options concerning links in Org-mode."
  1336. :tag "Org Link"
  1337. :group 'org)
  1338. (defvar org-link-abbrev-alist-local nil
  1339. "Buffer-local version of `org-link-abbrev-alist', which see.
  1340. The value of this is taken from the #+LINK lines.")
  1341. (make-variable-buffer-local 'org-link-abbrev-alist-local)
  1342. (defcustom org-link-abbrev-alist nil
  1343. "Alist of link abbreviations.
  1344. The car of each element is a string, to be replaced at the start of a link.
  1345. The cdrs are replacement values, like (\"linkkey\" . REPLACE). Abbreviated
  1346. links in Org-mode buffers can have an optional tag after a double colon, e.g.
  1347. [[linkkey:tag][description]]
  1348. The 'linkkey' must be a word word, starting with a letter, followed
  1349. by letters, numbers, '-' or '_'.
  1350. If REPLACE is a string, the tag will simply be appended to create the link.
  1351. If the string contains \"%s\", the tag will be inserted there. If the string
  1352. contains \"%h\", it will cause a url-encoded version of the tag to be inserted
  1353. at that point (see the function `url-hexify-string'). If the string contains
  1354. the specifier \"%(my-function)\", then the custom function `my-function' will
  1355. be invoked: this function takes the tag as its only argument and must return
  1356. a string.
  1357. REPLACE may also be a function that will be called with the tag as the
  1358. only argument to create the link, which should be returned as a string.
  1359. See the manual for examples."
  1360. :group 'org-link
  1361. :type '(repeat
  1362. (cons
  1363. (string :tag "Protocol")
  1364. (choice
  1365. (string :tag "Format")
  1366. (function)))))
  1367. (defcustom org-descriptive-links t
  1368. "Non-nil means Org will display descriptive links.
  1369. E.g. [[http://orgmode.org][Org website]] will be displayed as
  1370. \"Org Website\", hiding the link itself and just displaying its
  1371. description. When set to `nil', Org will display the full links
  1372. literally.
  1373. You can interactively set the value of this variable by calling
  1374. `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
  1375. :group 'org-link
  1376. :type 'boolean)
  1377. (defcustom org-link-file-path-type 'adaptive
  1378. "How the path name in file links should be stored.
  1379. Valid values are:
  1380. relative Relative to the current directory, i.e. the directory of the file
  1381. into which the link is being inserted.
  1382. absolute Absolute path, if possible with ~ for home directory.
  1383. noabbrev Absolute path, no abbreviation of home directory.
  1384. adaptive Use relative path for files in the current directory and sub-
  1385. directories of it. For other files, use an absolute path."
  1386. :group 'org-link
  1387. :type '(choice
  1388. (const relative)
  1389. (const absolute)
  1390. (const noabbrev)
  1391. (const adaptive)))
  1392. (defcustom org-activate-links '(bracket angle plain radio tag date footnote)
  1393. "Types of links that should be activated in Org-mode files.
  1394. This is a list of symbols, each leading to the activation of a certain link
  1395. type. In principle, it does not hurt to turn on most link types - there may
  1396. be a small gain when turning off unused link types. The types are:
  1397. bracket The recommended [[link][description]] or [[link]] links with hiding.
  1398. angle Links in angular brackets that may contain whitespace like
  1399. <bbdb:Carsten Dominik>.
  1400. plain Plain links in normal text, no whitespace, like http://google.com.
  1401. radio Text that is matched by a radio target, see manual for details.
  1402. tag Tag settings in a headline (link to tag search).
  1403. date Time stamps (link to calendar).
  1404. footnote Footnote labels.
  1405. Changing this variable requires a restart of Emacs to become effective."
  1406. :group 'org-link
  1407. :type '(set :greedy t
  1408. (const :tag "Double bracket links" bracket)
  1409. (const :tag "Angular bracket links" angle)
  1410. (const :tag "Plain text links" plain)
  1411. (const :tag "Radio target matches" radio)
  1412. (const :tag "Tags" tag)
  1413. (const :tag "Timestamps" date)
  1414. (const :tag "Footnotes" footnote)))
  1415. (defcustom org-make-link-description-function nil
  1416. "Function to use for generating link descriptions from links.
  1417. When nil, the link location will be used. This function must take
  1418. two parameters: the first one is the link, the second one is the
  1419. description generated by `org-insert-link'. The function should
  1420. return the description to use."
  1421. :group 'org-link
  1422. :type '(choice (const nil) (function)))
  1423. (defgroup org-link-store nil
  1424. "Options concerning storing links in Org-mode."
  1425. :tag "Org Store Link"
  1426. :group 'org-link)
  1427. (defcustom org-url-hexify-p t
  1428. "When non-nil, hexify URL when creating a link."
  1429. :type 'boolean
  1430. :version "24.3"
  1431. :group 'org-link-store)
  1432. (defcustom org-email-link-description-format "Email %c: %.30s"
  1433. "Format of the description part of a link to an email or usenet message.
  1434. The following %-escapes will be replaced by corresponding information:
  1435. %F full \"From\" field
  1436. %f name, taken from \"From\" field, address if no name
  1437. %T full \"To\" field
  1438. %t first name in \"To\" field, address if no name
  1439. %c correspondent. Usually \"from NAME\", but if you sent it yourself, it
  1440. will be \"to NAME\". See also the variable `org-from-is-user-regexp'.
  1441. %s subject
  1442. %d date
  1443. %m message-id.
  1444. You may use normal field width specification between the % and the letter.
  1445. This is for example useful to limit the length of the subject.
  1446. Examples: \"%f on: %.30s\", \"Email from %f\", \"Email %c\""
  1447. :group 'org-link-store
  1448. :type 'string)
  1449. (defcustom org-from-is-user-regexp
  1450. (let (r1 r2)
  1451. (when (and user-mail-address (not (string= user-mail-address "")))
  1452. (setq r1 (concat "\\<" (regexp-quote user-mail-address) "\\>")))
  1453. (when (and user-full-name (not (string= user-full-name "")))
  1454. (setq r2 (concat "\\<" (regexp-quote user-full-name) "\\>")))
  1455. (if (and r1 r2) (concat r1 "\\|" r2) (or r1 r2)))
  1456. "Regexp matched against the \"From:\" header of an email or usenet message.
  1457. It should match if the message is from the user him/herself."
  1458. :group 'org-link-store
  1459. :type 'regexp)
  1460. (defcustom org-context-in-file-links t
  1461. "Non-nil means file links from `org-store-link' contain context.
  1462. A search string will be added to the file name with :: as separator and
  1463. used to find the context when the link is activated by the command
  1464. `org-open-at-point'. When this option is t, the entire active region
  1465. will be placed in the search string of the file link. If set to a
  1466. positive integer, only the first n lines of context will be stored.
  1467. Using a prefix arg to the command \\[org-store-link] (`org-store-link')
  1468. negates this setting for the duration of the command."
  1469. :group 'org-link-store
  1470. :type '(choice boolean integer))
  1471. (defcustom org-keep-stored-link-after-insertion nil
  1472. "Non-nil means keep link in list for entire session.
  1473. The command `org-store-link' adds a link pointing to the current
  1474. location to an internal list. These links accumulate during a session.
  1475. The command `org-insert-link' can be used to insert links into any
  1476. Org-mode file (offering completion for all stored links). When this
  1477. option is nil, every link which has been inserted once using \\[org-insert-link]
  1478. will be removed from the list, to make completing the unused links
  1479. more efficient."
  1480. :group 'org-link-store
  1481. :type 'boolean)
  1482. (defgroup org-link-follow nil
  1483. "Options concerning following links in Org-mode."
  1484. :tag "Org Follow Link"
  1485. :group 'org-link)
  1486. (defcustom org-link-translation-function nil
  1487. "Function to translate links with different syntax to Org syntax.
  1488. This can be used to translate links created for example by the Planner
  1489. or emacs-wiki packages to Org syntax.
  1490. The function must accept two parameters, a TYPE containing the link
  1491. protocol name like \"rmail\" or \"gnus\" as a string, and the linked path,
  1492. which is everything after the link protocol. It should return a cons
  1493. with possibly modified values of type and path.
  1494. Org contains a function for this, so if you set this variable to
  1495. `org-translate-link-from-planner', you should be able follow many
  1496. links created by planner."
  1497. :group 'org-link-follow
  1498. :type '(choice (const nil) (function)))
  1499. (defcustom org-follow-link-hook nil
  1500. "Hook that is run after a link has been followed."
  1501. :group 'org-link-follow
  1502. :type 'hook)
  1503. (defcustom org-tab-follows-link nil
  1504. "Non-nil means on links TAB will follow the link.
  1505. Needs to be set before org.el is loaded.
  1506. This really should not be used, it does not make sense, and the
  1507. implementation is bad."
  1508. :group 'org-link-follow
  1509. :type 'boolean)
  1510. (defcustom org-return-follows-link nil
  1511. "Non-nil means on links RET will follow the link.
  1512. In tables, the special behavior of RET has precedence."
  1513. :group 'org-link-follow
  1514. :type 'boolean)
  1515. (defcustom org-mouse-1-follows-link
  1516. (if (boundp 'mouse-1-click-follows-link) mouse-1-click-follows-link t)
  1517. "Non-nil means mouse-1 on a link will follow the link.
  1518. A longer mouse click will still set point. Does not work on XEmacs.
  1519. Needs to be set before org.el is loaded."
  1520. :group 'org-link-follow
  1521. :type 'boolean)
  1522. (defcustom org-mark-ring-length 4
  1523. "Number of different positions to be recorded in the ring.
  1524. Changing this requires a restart of Emacs to work correctly."
  1525. :group 'org-link-follow
  1526. :type 'integer)
  1527. (defcustom org-link-search-must-match-exact-headline 'query-to-create
  1528. "Non-nil means internal links in Org files must exactly match a headline.
  1529. When nil, the link search tries to match a phrase with all words
  1530. in the search text."
  1531. :group 'org-link-follow
  1532. :version "24.1"
  1533. :type '(choice
  1534. (const :tag "Use fuzzy text search" nil)
  1535. (const :tag "Match only exact headline" t)
  1536. (const :tag "Match exact headline or query to create it"
  1537. query-to-create)))
  1538. (defcustom org-link-frame-setup
  1539. '((vm . vm-visit-folder-other-frame)
  1540. (vm-imap . vm-visit-imap-folder-other-frame)
  1541. (gnus . org-gnus-no-new-news)
  1542. (file . find-file-other-window)
  1543. (wl . wl-other-frame))
  1544. "Setup the frame configuration for following links.
  1545. When following a link with Emacs, it may often be useful to display
  1546. this link in another window or frame. This variable can be used to
  1547. set this up for the different types of links.
  1548. For VM, use any of
  1549. `vm-visit-folder'
  1550. `vm-visit-folder-other-window'
  1551. `vm-visit-folder-other-frame'
  1552. For Gnus, use any of
  1553. `gnus'
  1554. `gnus-other-frame'
  1555. `org-gnus-no-new-news'
  1556. For FILE, use any of
  1557. `find-file'
  1558. `find-file-other-window'
  1559. `find-file-other-frame'
  1560. For Wanderlust use any of
  1561. `wl'
  1562. `wl-other-frame'
  1563. For the calendar, use the variable `calendar-setup'.
  1564. For BBDB, it is currently only possible to display the matches in
  1565. another window."
  1566. :group 'org-link-follow
  1567. :type '(list
  1568. (cons (const vm)
  1569. (choice
  1570. (const vm-visit-folder)
  1571. (const vm-visit-folder-other-window)
  1572. (const vm-visit-folder-other-frame)))
  1573. (cons (const vm-imap)
  1574. (choice
  1575. (const vm-visit-imap-folder)
  1576. (const vm-visit-imap-folder-other-window)
  1577. (const vm-visit-imap-folder-other-frame)))
  1578. (cons (const gnus)
  1579. (choice
  1580. (const gnus)
  1581. (const gnus-other-frame)
  1582. (const org-gnus-no-new-news)))
  1583. (cons (const file)
  1584. (choice
  1585. (const find-file)
  1586. (const find-file-other-window)
  1587. (const find-file-other-frame)))
  1588. (cons (const wl)
  1589. (choice
  1590. (const wl)
  1591. (const wl-other-frame)))))
  1592. (defcustom org-display-internal-link-with-indirect-buffer nil
  1593. "Non-nil means use indirect buffer to display infile links.
  1594. Activating internal links (from one location in a file to another location
  1595. in the same file) normally just jumps to the location. When the link is
  1596. activated with a \\[universal-argument] prefix (or with mouse-3), the link \
  1597. is displayed in
  1598. another window. When this option is set, the other window actually displays
  1599. an indirect buffer clone of the current buffer, to avoid any visibility
  1600. changes to the current buffer."
  1601. :group 'org-link-follow
  1602. :type 'boolean)
  1603. (defcustom org-open-non-existing-files nil
  1604. "Non-nil means `org-open-file' will open non-existing files.
  1605. When nil, an error will be generated.
  1606. This variable applies only to external applications because they
  1607. might choke on non-existing files. If the link is to a file that
  1608. will be opened in Emacs, the variable is ignored."
  1609. :group 'org-link-follow
  1610. :type 'boolean)
  1611. (defcustom org-open-directory-means-index-dot-org nil
  1612. "Non-nil means a link to a directory really means to index.org.
  1613. When nil, following a directory link will run dired or open a finder/explorer
  1614. window on that directory."
  1615. :group 'org-link-follow
  1616. :type 'boolean)
  1617. (defcustom org-link-mailto-program '(browse-url "mailto:%a?subject=%s")
  1618. "Function and arguments to call for following mailto links.
  1619. This is a list with the first element being a Lisp function, and the
  1620. remaining elements being arguments to the function. In string arguments,
  1621. %a will be replaced by the address, and %s will be replaced by the subject
  1622. if one was given like in <mailto:arthur@galaxy.org::this subject>."
  1623. :group 'org-link-follow
  1624. :type '(choice
  1625. (const :tag "browse-url" (browse-url-mail "mailto:%a?subject=%s"))
  1626. (const :tag "compose-mail" (compose-mail "%a" "%s"))
  1627. (const :tag "message-mail" (message-mail "%a" "%s"))
  1628. (cons :tag "other" (function) (repeat :tag "argument" sexp))))
  1629. (defcustom org-confirm-shell-link-function 'yes-or-no-p
  1630. "Non-nil means ask for confirmation before executing shell links.
  1631. Shell links can be dangerous: just think about a link
  1632. [[shell:rm -rf ~/*][Google Search]]
  1633. This link would show up in your Org-mode document as \"Google Search\",
  1634. but really it would remove your entire home directory.
  1635. Therefore we advise against setting this variable to nil.
  1636. Just change it to `y-or-n-p' if you want to confirm with a
  1637. single keystroke rather than having to type \"yes\"."
  1638. :group 'org-link-follow
  1639. :type '(choice
  1640. (const :tag "with yes-or-no (safer)" yes-or-no-p)
  1641. (const :tag "with y-or-n (faster)" y-or-n-p)
  1642. (const :tag "no confirmation (dangerous)" nil)))
  1643. (put 'org-confirm-shell-link-function
  1644. 'safe-local-variable
  1645. #'(lambda (x) (member x '(yes-or-no-p y-or-n-p))))
  1646. (defcustom org-confirm-shell-link-not-regexp ""
  1647. "A regexp to skip confirmation for shell links."
  1648. :group 'org-link-follow
  1649. :version "24.1"
  1650. :type 'regexp)
  1651. (defcustom org-confirm-elisp-link-function 'yes-or-no-p
  1652. "Non-nil means ask for confirmation before executing Emacs Lisp links.
  1653. Elisp links can be dangerous: just think about a link
  1654. [[elisp:(shell-command \"rm -rf ~/*\")][Google Search]]
  1655. This link would show up in your Org-mode document as \"Google Search\",
  1656. but really it would remove your entire home directory.
  1657. Therefore we advise against setting this variable to nil.
  1658. Just change it to `y-or-n-p' if you want to confirm with a
  1659. single keystroke rather than having to type \"yes\"."
  1660. :group 'org-link-follow
  1661. :type '(choice
  1662. (const :tag "with yes-or-no (safer)" yes-or-no-p)
  1663. (const :tag "with y-or-n (faster)" y-or-n-p)
  1664. (const :tag "no confirmation (dangerous)" nil)))
  1665. (put 'org-confirm-shell-link-function
  1666. 'safe-local-variable
  1667. #'(lambda (x) (member x '(yes-or-no-p y-or-n-p))))
  1668. (defcustom org-confirm-elisp-link-not-regexp ""
  1669. "A regexp to skip confirmation for Elisp links."
  1670. :group 'org-link-follow
  1671. :version "24.1"
  1672. :type 'regexp)
  1673. (defconst org-file-apps-defaults-gnu
  1674. '((remote . emacs)
  1675. (system . mailcap)
  1676. (t . mailcap))
  1677. "Default file applications on a UNIX or GNU/Linux system.
  1678. See `org-file-apps'.")
  1679. (defconst org-file-apps-defaults-macosx
  1680. '((remote . emacs)
  1681. (t . "open %s")
  1682. (system . "open %s")
  1683. ("ps.gz" . "gv %s")
  1684. ("eps.gz" . "gv %s")
  1685. ("dvi" . "xdvi %s")
  1686. ("fig" . "xfig %s"))
  1687. "Default file applications on a MacOS X system.
  1688. The system \"open\" is known as a default, but we use X11 applications
  1689. for some files for which the OS does not have a good default.
  1690. See `org-file-apps'.")
  1691. (defconst org-file-apps-defaults-windowsnt
  1692. (list
  1693. '(remote . emacs)
  1694. (cons t
  1695. (list (if (featurep 'xemacs)
  1696. 'mswindows-shell-execute
  1697. 'w32-shell-execute)
  1698. "open" 'file))
  1699. (cons 'system
  1700. (list (if (featurep 'xemacs)
  1701. 'mswindows-shell-execute
  1702. 'w32-shell-execute)
  1703. "open" 'file)))
  1704. "Default file applications on a Windows NT system.
  1705. The system \"open\" is used for most files.
  1706. See `org-file-apps'.")
  1707. (defcustom org-file-apps
  1708. '((auto-mode . emacs)
  1709. ("\\.mm\\'" . default)
  1710. ("\\.x?html?\\'" . default)
  1711. ("\\.pdf\\'" . default))
  1712. "External applications for opening `file:path' items in a document.
  1713. Org-mode uses system defaults for different file types, but
  1714. you can use this variable to set the application for a given file
  1715. extension. The entries in this list are cons cells where the car identifies
  1716. files and the cdr the corresponding command. Possible values for the
  1717. file identifier are
  1718. \"string\" A string as a file identifier can be interpreted in different
  1719. ways, depending on its contents:
  1720. - Alphanumeric characters only:
  1721. Match links with this file extension.
  1722. Example: (\"pdf\" . \"evince %s\")
  1723. to open PDFs with evince.
  1724. - Regular expression: Match links where the
  1725. filename matches the regexp. If you want to
  1726. use groups here, use shy groups.
  1727. Example: (\"\\.x?html\\'\" . \"firefox %s\")
  1728. (\"\\(?:xhtml\\|html\\)\" . \"firefox %s\")
  1729. to open *.html and *.xhtml with firefox.
  1730. - Regular expression which contains (non-shy) groups:
  1731. Match links where the whole link, including \"::\", and
  1732. anything after that, matches the regexp.
  1733. In a custom command string, %1, %2, etc. are replaced with
  1734. the parts of the link that were matched by the groups.
  1735. For backwards compatibility, if a command string is given
  1736. that does not use any of the group matches, this case is
  1737. handled identically to the second one (i.e. match against
  1738. file name only).
  1739. In a custom lisp form, you can access the group matches with
  1740. (match-string n link).
  1741. Example: (\"\\.pdf::\\(\\d+\\)\\'\" . \"evince -p %1 %s\")
  1742. to open [[file:document.pdf::5]] with evince at page 5.
  1743. `directory' Matches a directory
  1744. `remote' Matches a remote file, accessible through tramp or efs.
  1745. Remote files most likely should be visited through Emacs
  1746. because external applications cannot handle such paths.
  1747. `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
  1748. so all files Emacs knows how to handle. Using this with
  1749. command `emacs' will open most files in Emacs. Beware that this
  1750. will also open html files inside Emacs, unless you add
  1751. (\"html\" . default) to the list as well.
  1752. t Default for files not matched by any of the other options.
  1753. `system' The system command to open files, like `open' on Windows
  1754. and Mac OS X, and mailcap under GNU/Linux. This is the command
  1755. that will be selected if you call `C-c C-o' with a double
  1756. \\[universal-argument] \\[universal-argument] prefix.
  1757. Possible values for the command are:
  1758. `emacs' The file will be visited by the current Emacs process.
  1759. `default' Use the default application for this file type, which is the
  1760. association for t in the list, most likely in the system-specific
  1761. part.
  1762. This can be used to overrule an unwanted setting in the
  1763. system-specific variable.
  1764. `system' Use the system command for opening files, like \"open\".
  1765. This command is specified by the entry whose car is `system'.
  1766. Most likely, the system-specific version of this variable
  1767. does define this command, but you can overrule/replace it
  1768. here.
  1769. string A command to be executed by a shell; %s will be replaced
  1770. by the path to the file.
  1771. sexp A Lisp form which will be evaluated. The file path will
  1772. be available in the Lisp variable `file'.
  1773. For more examples, see the system specific constants
  1774. `org-file-apps-defaults-macosx'
  1775. `org-file-apps-defaults-windowsnt'
  1776. `org-file-apps-defaults-gnu'."
  1777. :group 'org-link-follow
  1778. :type '(repeat
  1779. (cons (choice :value ""
  1780. (string :tag "Extension")
  1781. (const :tag "System command to open files" system)
  1782. (const :tag "Default for unrecognized files" t)
  1783. (const :tag "Remote file" remote)
  1784. (const :tag "Links to a directory" directory)
  1785. (const :tag "Any files that have Emacs modes"
  1786. auto-mode))
  1787. (choice :value ""
  1788. (const :tag "Visit with Emacs" emacs)
  1789. (const :tag "Use default" default)
  1790. (const :tag "Use the system command" system)
  1791. (string :tag "Command")
  1792. (sexp :tag "Lisp form")))))
  1793. (defcustom org-doi-server-url "http://dx.doi.org/"
  1794. "The URL of the DOI server."
  1795. :type 'string
  1796. :version "24.3"
  1797. :group 'org-link-follow)
  1798. (defgroup org-refile nil
  1799. "Options concerning refiling entries in Org-mode."
  1800. :tag "Org Refile"
  1801. :group 'org)
  1802. (defcustom org-directory "~/org"
  1803. "Directory with org files.
  1804. This is just a default location to look for Org files. There is no need
  1805. at all to put your files into this directory. It is only used in the
  1806. following situations:
  1807. 1. When a capture template specifies a target file that is not an
  1808. absolute path. The path will then be interpreted relative to
  1809. `org-directory'
  1810. 2. When a capture note is filed away in an interactive way (when exiting the
  1811. note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
  1812. with `org-directory' as the default path."
  1813. :group 'org-refile
  1814. :group 'org-remember
  1815. :group 'org-capture
  1816. :type 'directory)
  1817. (defcustom org-default-notes-file (convert-standard-filename "~/.notes")
  1818. "Default target for storing notes.
  1819. Used as a fall back file for org-remember.el and org-capture.el, for
  1820. templates that do not specify a target file."
  1821. :group 'org-refile
  1822. :group 'org-remember
  1823. :group 'org-capture
  1824. :type '(choice
  1825. (const :tag "Default from remember-data-file" nil)
  1826. file))
  1827. (defcustom org-goto-interface 'outline
  1828. "The default interface to be used for `org-goto'.
  1829. Allowed values are:
  1830. outline The interface shows an outline of the relevant file
  1831. and the correct heading is found by moving through
  1832. the outline or by searching with incremental search.
  1833. outline-path-completion Headlines in the current buffer are offered via
  1834. completion. This is the interface also used by
  1835. the refile command."
  1836. :group 'org-refile
  1837. :type '(choice
  1838. (const :tag "Outline" outline)
  1839. (const :tag "Outline-path-completion" outline-path-completion)))
  1840. (defcustom org-goto-max-level 5
  1841. "Maximum target level when running `org-goto' with refile interface."
  1842. :group 'org-refile
  1843. :type 'integer)
  1844. (defcustom org-reverse-note-order nil
  1845. "Non-nil means store new notes at the beginning of a file or entry.
  1846. When nil, new notes will be filed to the end of a file or entry.
  1847. This can also be a list with cons cells of regular expressions that
  1848. are matched against file names, and values."
  1849. :group 'org-remember
  1850. :group 'org-capture
  1851. :group 'org-refile
  1852. :type '(choice
  1853. (const :tag "Reverse always" t)
  1854. (const :tag "Reverse never" nil)
  1855. (repeat :tag "By file name regexp"
  1856. (cons regexp boolean))))
  1857. (defcustom org-log-refile nil
  1858. "Information to record when a task is refiled.
  1859. Possible values are:
  1860. nil Don't add anything
  1861. time Add a time stamp to the task
  1862. note Prompt for a note and add it with template `org-log-note-headings'
  1863. This option can also be set with on a per-file-basis with
  1864. #+STARTUP: nologrefile
  1865. #+STARTUP: logrefile
  1866. #+STARTUP: lognoterefile
  1867. You can have local logging settings for a subtree by setting the LOGGING
  1868. property to one or more of these keywords.
  1869. When bulk-refiling from the agenda, the value `note' is forbidden and
  1870. will temporarily be changed to `time'."
  1871. :group 'org-refile
  1872. :group 'org-progress
  1873. :version "24.1"
  1874. :type '(choice
  1875. (const :tag "No logging" nil)
  1876. (const :tag "Record timestamp" time)
  1877. (const :tag "Record timestamp with note." note)))
  1878. (defcustom org-refile-targets nil
  1879. "Targets for refiling entries with \\[org-refile].
  1880. This is a list of cons cells. Each cell contains:
  1881. - a specification of the files to be considered, either a list of files,
  1882. or a symbol whose function or variable value will be used to retrieve
  1883. a file name or a list of file names. If you use `org-agenda-files' for
  1884. that, all agenda files will be scanned for targets. Nil means consider
  1885. headings in the current buffer.
  1886. - A specification of how to find candidate refile targets. This may be
  1887. any of:
  1888. - a cons cell (:tag . \"TAG\") to identify refile targets by a tag.
  1889. This tag has to be present in all target headlines, inheritance will
  1890. not be considered.
  1891. - a cons cell (:todo . \"KEYWORD\") to identify refile targets by
  1892. todo keyword.
  1893. - a cons cell (:regexp . \"REGEXP\") with a regular expression matching
  1894. headlines that are refiling targets.
  1895. - a cons cell (:level . N). Any headline of level N is considered a target.
  1896. Note that, when `org-odd-levels-only' is set, level corresponds to
  1897. order in hierarchy, not to the number of stars.
  1898. - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
  1899. Note that, when `org-odd-levels-only' is set, level corresponds to
  1900. order in hierarchy, not to the number of stars.
  1901. Each element of this list generates a set of possible targets.
  1902. The union of these sets is presented (with completion) to
  1903. the user by `org-refile'.
  1904. You can set the variable `org-refile-target-verify-function' to a function
  1905. to verify each headline found by the simple criteria above.
  1906. When this variable is nil, all top-level headlines in the current buffer
  1907. are used, equivalent to the value `((nil . (:level . 1))'."
  1908. :group 'org-refile
  1909. :type '(repeat
  1910. (cons
  1911. (choice :value org-agenda-files
  1912. (const :tag "All agenda files" org-agenda-files)
  1913. (const :tag "Current buffer" nil)
  1914. (function) (variable) (file))
  1915. (choice :tag "Identify target headline by"
  1916. (cons :tag "Specific tag" (const :value :tag) (string))
  1917. (cons :tag "TODO keyword" (const :value :todo) (string))
  1918. (cons :tag "Regular expression" (const :value :regexp) (regexp))
  1919. (cons :tag "Level number" (const :value :level) (integer))
  1920. (cons :tag "Max Level number" (const :value :maxlevel) (integer))))))
  1921. (defcustom org-refile-target-verify-function nil
  1922. "Function to verify if the headline at point should be a refile target.
  1923. The function will be called without arguments, with point at the
  1924. beginning of the headline. It should return t and leave point
  1925. where it is if the headline is a valid target for refiling.
  1926. If the target should not be selected, the function must return nil.
  1927. In addition to this, it may move point to a place from where the search
  1928. should be continued. For example, the function may decide that the entire
  1929. subtree of the current entry should be excluded and move point to the end
  1930. of the subtree."
  1931. :group 'org-refile
  1932. :type '(choice
  1933. (const nil)
  1934. (function)))
  1935. (defcustom org-refile-use-cache nil
  1936. "Non-nil means cache refile targets to speed up the process.
  1937. The cache for a particular file will be updated automatically when
  1938. the buffer has been killed, or when any of the marker used for flagging
  1939. refile targets no longer points at a live buffer.
  1940. If you have added new entries to a buffer that might themselves be targets,
  1941. you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
  1942. find that easier, `C-u C-u C-u C-c C-w'."
  1943. :group 'org-refile
  1944. :version "24.1"
  1945. :type 'boolean)
  1946. (defcustom org-refile-use-outline-path nil
  1947. "Non-nil means provide refile targets as paths.
  1948. So a level 3 headline will be available as level1/level2/level3.
  1949. When the value is `file', also include the file name (without directory)
  1950. into the path. In this case, you can also stop the completion after
  1951. the file name, to get entries inserted as top level in the file.
  1952. When `full-file-path', include the full file path."
  1953. :group 'org-refile
  1954. :type '(choice
  1955. (const :tag "Not" nil)
  1956. (const :tag "Yes" t)
  1957. (const :tag "Start with file name" file)
  1958. (const :tag "Start with full file path" full-file-path)))
  1959. (defcustom org-outline-path-complete-in-steps t
  1960. "Non-nil means complete the outline path in hierarchical steps.
  1961. When Org-mode uses the refile interface to select an outline path
  1962. \(see variable `org-refile-use-outline-path'), the completion of
  1963. the path can be done is a single go, or if can be done in steps down
  1964. the headline hierarchy. Going in steps is probably the best if you
  1965. do not use a special completion package like `ido' or `icicles'.
  1966. However, when using these packages, going in one step can be very
  1967. fast, while still showing the whole path to the entry."
  1968. :group 'org-refile
  1969. :type 'boolean)
  1970. (defcustom org-refile-allow-creating-parent-nodes nil
  1971. "Non-nil means allow to create new nodes as refile targets.
  1972. New nodes are then created by adding \"/new node name\" to the completion
  1973. of an existing node. When the value of this variable is `confirm',
  1974. new node creation must be confirmed by the user (recommended)
  1975. When nil, the completion must match an existing entry.
  1976. Note that, if the new heading is not seen by the criteria
  1977. listed in `org-refile-targets', multiple instances of the same
  1978. heading would be created by trying again to file under the new
  1979. heading."
  1980. :group 'org-refile
  1981. :type '(choice
  1982. (const :tag "Never" nil)
  1983. (const :tag "Always" t)
  1984. (const :tag "Prompt for confirmation" confirm)))
  1985. (defcustom org-refile-active-region-within-subtree nil
  1986. "Non-nil means also refile active region within a subtree.
  1987. By default `org-refile' doesn't allow refiling regions if they
  1988. don't contain a set of subtrees, but it might be convenient to
  1989. do so sometimes: in that case, the first line of the region is
  1990. converted to a headline before refiling."
  1991. :group 'org-refile
  1992. :version "24.1"
  1993. :type 'boolean)
  1994. (defgroup org-todo nil
  1995. "Options concerning TODO items in Org-mode."
  1996. :tag "Org TODO"
  1997. :group 'org)
  1998. (defgroup org-progress nil
  1999. "Options concerning Progress logging in Org-mode."
  2000. :tag "Org Progress"
  2001. :group 'org-time)
  2002. (defvar org-todo-interpretation-widgets
  2003. '((:tag "Sequence (cycling hits every state)" sequence)
  2004. (:tag "Type (cycling directly to DONE)" type))
  2005. "The available interpretation symbols for customizing `org-todo-keywords'.
  2006. Interested libraries should add to this list.")
  2007. (defcustom org-todo-keywords '((sequence "TODO" "DONE"))
  2008. "List of TODO entry keyword sequences and their interpretation.
  2009. \\<org-mode-map>This is a list of sequences.
  2010. Each sequence starts with a symbol, either `sequence' or `type',
  2011. indicating if the keywords should be interpreted as a sequence of
  2012. action steps, or as different types of TODO items. The first
  2013. keywords are states requiring action - these states will select a headline
  2014. for inclusion into the global TODO list Org-mode produces. If one of
  2015. the \"keywords\" is the vertical bar, \"|\", the remaining keywords
  2016. signify that no further action is necessary. If \"|\" is not found,
  2017. the last keyword is treated as the only DONE state of the sequence.
  2018. The command \\[org-todo] cycles an entry through these states, and one
  2019. additional state where no keyword is present. For details about this
  2020. cycling, see the manual.
  2021. TODO keywords and interpretation can also be set on a per-file basis with
  2022. the special #+SEQ_TODO and #+TYP_TODO lines.
  2023. Each keyword can optionally specify a character for fast state selection
  2024. \(in combination with the variable `org-use-fast-todo-selection')
  2025. and specifiers for state change logging, using the same syntax that
  2026. is used in the \"#+TODO:\" lines. For example, \"WAIT(w)\" says that
  2027. the WAIT state can be selected with the \"w\" key. \"WAIT(w!)\"
  2028. indicates to record a time stamp each time this state is selected.
  2029. Each keyword may also specify if a timestamp or a note should be
  2030. recorded when entering or leaving the state, by adding additional
  2031. characters in the parenthesis after the keyword. This looks like this:
  2032. \"WAIT(w@/!)\". \"@\" means to add a note (with time), \"!\" means to
  2033. record only the time of the state change. With X and Y being either
  2034. \"@\" or \"!\", \"X/Y\" means use X when entering the state, and use
  2035. Y when leaving the state if and only if the *target* state does not
  2036. define X. You may omit any of the fast-selection key or X or /Y,
  2037. so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
  2038. For backward compatibility, this variable may also be just a list
  2039. of keywords. In this case the interpretation (sequence or type) will be
  2040. taken from the (otherwise obsolete) variable `org-todo-interpretation'."
  2041. :group 'org-todo
  2042. :group 'org-keywords
  2043. :type '(choice
  2044. (repeat :tag "Old syntax, just keywords"
  2045. (string :tag "Keyword"))
  2046. (repeat :tag "New syntax"
  2047. (cons
  2048. (choice
  2049. :tag "Interpretation"
  2050. ;;Quick and dirty way to see
  2051. ;;`org-todo-interpretations'. This takes the
  2052. ;;place of item arguments
  2053. :convert-widget
  2054. (lambda (widget)
  2055. (widget-put widget
  2056. :args (mapcar
  2057. #'(lambda (x)
  2058. (widget-convert
  2059. (cons 'const x)))
  2060. org-todo-interpretation-widgets))
  2061. widget))
  2062. (repeat
  2063. (string :tag "Keyword"))))))
  2064. (defvar org-todo-keywords-1 nil
  2065. "All TODO and DONE keywords active in a buffer.")
  2066. (make-variable-buffer-local 'org-todo-keywords-1)
  2067. (defvar org-todo-keywords-for-agenda nil)
  2068. (defvar org-done-keywords-for-agenda nil)
  2069. (defvar org-drawers-for-agenda nil)
  2070. (defvar org-todo-keyword-alist-for-agenda nil)
  2071. (defvar org-tag-alist-for-agenda nil
  2072. "Alist of all tags from all agenda files.")
  2073. (defvar org-tag-groups-alist-for-agenda nil
  2074. "Alist of all groups tags from all current agenda files.")
  2075. (defvar org-tag-groups-alist nil)
  2076. (make-variable-buffer-local 'org-tag-groups-alist)
  2077. (defvar org-agenda-contributing-files nil)
  2078. (defvar org-not-done-keywords nil)
  2079. (make-variable-buffer-local 'org-not-done-keywords)
  2080. (defvar org-done-keywords nil)
  2081. (make-variable-buffer-local 'org-done-keywords)
  2082. (defvar org-todo-heads nil)
  2083. (make-variable-buffer-local 'org-todo-heads)
  2084. (defvar org-todo-sets nil)
  2085. (make-variable-buffer-local 'org-todo-sets)
  2086. (defvar org-todo-log-states nil)
  2087. (make-variable-buffer-local 'org-todo-log-states)
  2088. (defvar org-todo-kwd-alist nil)
  2089. (make-variable-buffer-local 'org-todo-kwd-alist)
  2090. (defvar org-todo-key-alist nil)
  2091. (make-variable-buffer-local 'org-todo-key-alist)
  2092. (defvar org-todo-key-trigger nil)
  2093. (make-variable-buffer-local 'org-todo-key-trigger)
  2094. (defcustom org-todo-interpretation 'sequence
  2095. "Controls how TODO keywords are interpreted.
  2096. This variable is in principle obsolete and is only used for
  2097. backward compatibility, if the interpretation of todo keywords is
  2098. not given already in `org-todo-keywords'. See that variable for
  2099. more information."
  2100. :group 'org-todo
  2101. :group 'org-keywords
  2102. :type '(choice (const sequence)
  2103. (const type)))
  2104. (defcustom org-use-fast-todo-selection t
  2105. "Non-nil means use the fast todo selection scheme with C-c C-t.
  2106. This variable describes if and under what circumstances the cycling
  2107. mechanism for TODO keywords will be replaced by a single-key, direct
  2108. selection scheme.
  2109. When nil, fast selection is never used.
  2110. When the symbol `prefix', it will be used when `org-todo' is called
  2111. with a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and
  2112. `C-u t' in an agenda buffer.
  2113. When t, fast selection is used by default. In this case, the prefix
  2114. argument forces cycling instead.
  2115. In all cases, the special interface is only used if access keys have
  2116. actually been assigned by the user, i.e. if keywords in the configuration
  2117. are followed by a letter in parenthesis, like TODO(t)."
  2118. :group 'org-todo
  2119. :type '(choice
  2120. (const :tag "Never" nil)
  2121. (const :tag "By default" t)
  2122. (const :tag "Only with C-u C-c C-t" prefix)))
  2123. (defcustom org-provide-todo-statistics t
  2124. "Non-nil means update todo statistics after insert and toggle.
  2125. ALL-HEADLINES means update todo statistics by including headlines
  2126. with no TODO keyword as well, counting them as not done.
  2127. A list of TODO keywords means the same, but skip keywords that are
  2128. not in this list.
  2129. When this is set, todo statistics is updated in the parent of the
  2130. current entry each time a todo state is changed."
  2131. :group 'org-todo
  2132. :type '(choice
  2133. (const :tag "Yes, only for TODO entries" t)
  2134. (const :tag "Yes, including all entries" 'all-headlines)
  2135. (repeat :tag "Yes, for TODOs in this list"
  2136. (string :tag "TODO keyword"))
  2137. (other :tag "No TODO statistics" nil)))
  2138. (defcustom org-hierarchical-todo-statistics t
  2139. "Non-nil means TODO statistics covers just direct children.
  2140. When nil, all entries in the subtree are considered.
  2141. This has only an effect if `org-provide-todo-statistics' is set.
  2142. To set this to nil for only a single subtree, use a COOKIE_DATA
  2143. property and include the word \"recursive\" into the value."
  2144. :group 'org-todo
  2145. :type 'boolean)
  2146. (defcustom org-after-todo-state-change-hook nil
  2147. "Hook which is run after the state of a TODO item was changed.
  2148. The new state (a string with a TODO keyword, or nil) is available in the
  2149. Lisp variable `org-state'."
  2150. :group 'org-todo
  2151. :type 'hook)
  2152. (defvar org-blocker-hook nil
  2153. "Hook for functions that are allowed to block a state change.
  2154. Functions in this hook should not modify the buffer.
  2155. Each function gets as its single argument a property list,
  2156. see `org-trigger-hook' for more information about this list.
  2157. If any of the functions in this hook returns nil, the state change
  2158. is blocked.")
  2159. (defvar org-trigger-hook nil
  2160. "Hook for functions that are triggered by a state change.
  2161. Each function gets as its single argument a property list with at
  2162. least the following elements:
  2163. (:type type-of-change :position pos-at-entry-start
  2164. :from old-state :to new-state)
  2165. Depending on the type, more properties may be present.
  2166. This mechanism is currently implemented for:
  2167. TODO state changes
  2168. ------------------
  2169. :type todo-state-change
  2170. :from previous state (keyword as a string), or nil, or a symbol
  2171. 'todo' or 'done', to indicate the general type of state.
  2172. :to new state, like in :from")
  2173. (defcustom org-enforce-todo-dependencies nil
  2174. "Non-nil means undone TODO entries will block switching the parent to DONE.
  2175. Also, if a parent has an :ORDERED: property, switching an entry to DONE will
  2176. be blocked if any prior sibling is not yet done.
  2177. Finally, if the parent is blocked because of ordered siblings of its own,
  2178. the child will also be blocked."
  2179. :set (lambda (var val)
  2180. (set var val)
  2181. (if val
  2182. (add-hook 'org-blocker-hook
  2183. 'org-block-todo-from-children-or-siblings-or-parent)
  2184. (remove-hook 'org-blocker-hook
  2185. 'org-block-todo-from-children-or-siblings-or-parent)))
  2186. :group 'org-todo
  2187. :type 'boolean)
  2188. (defcustom org-enforce-todo-checkbox-dependencies nil
  2189. "Non-nil means unchecked boxes will block switching the parent to DONE.
  2190. When this is nil, checkboxes have no influence on switching TODO states.
  2191. When non-nil, you first need to check off all check boxes before the TODO
  2192. entry can be switched to DONE.
  2193. This variable needs to be set before org.el is loaded, and you need to
  2194. restart Emacs after a change to make the change effective. The only way
  2195. to change is while Emacs is running is through the customize interface."
  2196. :set (lambda (var val)
  2197. (set var val)
  2198. (if val
  2199. (add-hook 'org-blocker-hook
  2200. 'org-block-todo-from-checkboxes)
  2201. (remove-hook 'org-blocker-hook
  2202. 'org-block-todo-from-checkboxes)))
  2203. :group 'org-todo
  2204. :type 'boolean)
  2205. (defcustom org-treat-insert-todo-heading-as-state-change nil
  2206. "Non-nil means inserting a TODO heading is treated as state change.
  2207. So when the command \\[org-insert-todo-heading] is used, state change
  2208. logging will apply if appropriate. When nil, the new TODO item will
  2209. be inserted directly, and no logging will take place."
  2210. :group 'org-todo
  2211. :type 'boolean)
  2212. (defcustom org-treat-S-cursor-todo-selection-as-state-change t
  2213. "Non-nil means switching TODO states with S-cursor counts as state change.
  2214. This is the default behavior. However, setting this to nil allows a
  2215. convenient way to select a TODO state and bypass any logging associated
  2216. with that."
  2217. :group 'org-todo
  2218. :type 'boolean)
  2219. (defcustom org-todo-state-tags-triggers nil
  2220. "Tag changes that should be triggered by TODO state changes.
  2221. This is a list. Each entry is
  2222. (state-change (tag . flag) .......)
  2223. State-change can be a string with a state, and empty string to indicate the
  2224. state that has no TODO keyword, or it can be one of the symbols `todo'
  2225. or `done', meaning any not-done or done state, respectively."
  2226. :group 'org-todo
  2227. :group 'org-tags
  2228. :type '(repeat
  2229. (cons (choice :tag "When changing to"
  2230. (const :tag "Not-done state" todo)
  2231. (const :tag "Done state" done)
  2232. (string :tag "State"))
  2233. (repeat
  2234. (cons :tag "Tag action"
  2235. (string :tag "Tag")
  2236. (choice (const :tag "Add" t) (const :tag "Remove" nil)))))))
  2237. (defcustom org-log-done nil
  2238. "Information to record when a task moves to the DONE state.
  2239. Possible values are:
  2240. nil Don't add anything, just change the keyword
  2241. time Add a time stamp to the task
  2242. note Prompt for a note and add it with template `org-log-note-headings'
  2243. This option can also be set with on a per-file-basis with
  2244. #+STARTUP: nologdone
  2245. #+STARTUP: logdone
  2246. #+STARTUP: lognotedone
  2247. You can have local logging settings for a subtree by setting the LOGGING
  2248. property to one or more of these keywords."
  2249. :group 'org-todo
  2250. :group 'org-progress
  2251. :type '(choice
  2252. (const :tag "No logging" nil)
  2253. (const :tag "Record CLOSED timestamp" time)
  2254. (const :tag "Record CLOSED timestamp with note." note)))
  2255. ;; Normalize old uses of org-log-done.
  2256. (cond
  2257. ((eq org-log-done t) (setq org-log-done 'time))
  2258. ((and (listp org-log-done) (memq 'done org-log-done))
  2259. (setq org-log-done 'note)))
  2260. (defcustom org-log-reschedule nil
  2261. "Information to record when the scheduling date of a tasks is modified.
  2262. Possible values are:
  2263. nil Don't add anything, just change the date
  2264. time Add a time stamp to the task
  2265. note Prompt for a note and add it with template `org-log-note-headings'
  2266. This option can also be set with on a per-file-basis with
  2267. #+STARTUP: nologreschedule
  2268. #+STARTUP: logreschedule
  2269. #+STARTUP: lognotereschedule"
  2270. :group 'org-todo
  2271. :group 'org-progress
  2272. :type '(choice
  2273. (const :tag "No logging" nil)
  2274. (const :tag "Record timestamp" time)
  2275. (const :tag "Record timestamp with note." note)))
  2276. (defcustom org-log-redeadline nil
  2277. "Information to record when the deadline date of a tasks is modified.
  2278. Possible values are:
  2279. nil Don't add anything, just change the date
  2280. time Add a time stamp to the task
  2281. note Prompt for a note and add it with template `org-log-note-headings'
  2282. This option can also be set with on a per-file-basis with
  2283. #+STARTUP: nologredeadline
  2284. #+STARTUP: logredeadline
  2285. #+STARTUP: lognoteredeadline
  2286. You can have local logging settings for a subtree by setting the LOGGING
  2287. property to one or more of these keywords."
  2288. :group 'org-todo
  2289. :group 'org-progress
  2290. :type '(choice
  2291. (const :tag "No logging" nil)
  2292. (const :tag "Record timestamp" time)
  2293. (const :tag "Record timestamp with note." note)))
  2294. (defcustom org-log-note-clock-out nil
  2295. "Non-nil means record a note when clocking out of an item.
  2296. This can also be configured on a per-file basis by adding one of
  2297. the following lines anywhere in the buffer:
  2298. #+STARTUP: lognoteclock-out
  2299. #+STARTUP: nolognoteclock-out"
  2300. :group 'org-todo
  2301. :group 'org-progress
  2302. :type 'boolean)
  2303. (defcustom org-log-done-with-time t
  2304. "Non-nil means the CLOSED time stamp will contain date and time.
  2305. When nil, only the date will be recorded."
  2306. :group 'org-progress
  2307. :type 'boolean)
  2308. (defcustom org-log-note-headings
  2309. '((done . "CLOSING NOTE %t")
  2310. (state . "State %-12s from %-12S %t")
  2311. (note . "Note taken on %t")
  2312. (reschedule . "Rescheduled from %S on %t")
  2313. (delschedule . "Not scheduled, was %S on %t")
  2314. (redeadline . "New deadline from %S on %t")
  2315. (deldeadline . "Removed deadline, was %S on %t")
  2316. (refile . "Refiled on %t")
  2317. (clock-out . ""))
  2318. "Headings for notes added to entries.
  2319. The value is an alist, with the car being a symbol indicating the note
  2320. context, and the cdr is the heading to be used. The heading may also be the
  2321. empty string.
  2322. %t in the heading will be replaced by a time stamp.
  2323. %T will be an active time stamp instead the default inactive one
  2324. %d will be replaced by a short-format time stamp.
  2325. %D will be replaced by an active short-format time stamp.
  2326. %s will be replaced by the new TODO state, in double quotes.
  2327. %S will be replaced by the old TODO state, in double quotes.
  2328. %u will be replaced by the user name.
  2329. %U will be replaced by the full user name.
  2330. In fact, it is not a good idea to change the `state' entry, because
  2331. agenda log mode depends on the format of these entries."
  2332. :group 'org-todo
  2333. :group 'org-progress
  2334. :type '(list :greedy t
  2335. (cons (const :tag "Heading when closing an item" done) string)
  2336. (cons (const :tag
  2337. "Heading when changing todo state (todo sequence only)"
  2338. state) string)
  2339. (cons (const :tag "Heading when just taking a note" note) string)
  2340. (cons (const :tag "Heading when clocking out" clock-out) string)
  2341. (cons (const :tag "Heading when an item is no longer scheduled" delschedule) string)
  2342. (cons (const :tag "Heading when rescheduling" reschedule) string)
  2343. (cons (const :tag "Heading when changing deadline" redeadline) string)
  2344. (cons (const :tag "Heading when deleting a deadline" deldeadline) string)
  2345. (cons (const :tag "Heading when refiling" refile) string)))
  2346. (unless (assq 'note org-log-note-headings)
  2347. (push '(note . "%t") org-log-note-headings))
  2348. (defcustom org-log-into-drawer nil
  2349. "Non-nil means insert state change notes and time stamps into a drawer.
  2350. When nil, state changes notes will be inserted after the headline and
  2351. any scheduling and clock lines, but not inside a drawer.
  2352. The value of this variable should be the name of the drawer to use.
  2353. LOGBOOK is proposed as the default drawer for this purpose, you can
  2354. also set this to a string to define the drawer of your choice.
  2355. A value of t is also allowed, representing \"LOGBOOK\".
  2356. A value of t or nil can also be set with on a per-file-basis with
  2357. #+STARTUP: logdrawer
  2358. #+STARTUP: nologdrawer
  2359. If this variable is set, `org-log-state-notes-insert-after-drawers'
  2360. will be ignored.
  2361. You can set the property LOG_INTO_DRAWER to overrule this setting for
  2362. a subtree."
  2363. :group 'org-todo
  2364. :group 'org-progress
  2365. :type '(choice
  2366. (const :tag "Not into a drawer" nil)
  2367. (const :tag "LOGBOOK" t)
  2368. (string :tag "Other")))
  2369. (org-defvaralias 'org-log-state-notes-into-drawer 'org-log-into-drawer)
  2370. (defun org-log-into-drawer ()
  2371. "Return the value of `org-log-into-drawer', but let properties overrule.
  2372. If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
  2373. used instead of the default value."
  2374. (let ((p (org-entry-get nil "LOG_INTO_DRAWER" 'inherit t)))
  2375. (cond
  2376. ((not p) org-log-into-drawer)
  2377. ((equal p "nil") nil)
  2378. ((equal p "t") "LOGBOOK")
  2379. (t p))))
  2380. (defcustom org-log-state-notes-insert-after-drawers nil
  2381. "Non-nil means insert state change notes after any drawers in entry.
  2382. Only the drawers that *immediately* follow the headline and the
  2383. deadline/scheduled line are skipped.
  2384. When nil, insert notes right after the heading and perhaps the line
  2385. with deadline/scheduling if present.
  2386. This variable will have no effect if `org-log-into-drawer' is
  2387. set."
  2388. :group 'org-todo
  2389. :group 'org-progress
  2390. :type 'boolean)
  2391. (defcustom org-log-states-order-reversed t
  2392. "Non-nil means the latest state note will be directly after heading.
  2393. When nil, the state change notes will be ordered according to time.
  2394. This option can also be set with on a per-file-basis with
  2395. #+STARTUP: logstatesreversed
  2396. #+STARTUP: nologstatesreversed"
  2397. :group 'org-todo
  2398. :group 'org-progress
  2399. :type 'boolean)
  2400. (defcustom org-todo-repeat-to-state nil
  2401. "The TODO state to which a repeater should return the repeating task.
  2402. By default this is the first task in a TODO sequence, or the previous state
  2403. in a TODO_TYP set. But you can specify another task here.
  2404. alternatively, set the :REPEAT_TO_STATE: property of the entry."
  2405. :group 'org-todo
  2406. :version "24.1"
  2407. :type '(choice (const :tag "Head of sequence" nil)
  2408. (string :tag "Specific state")))
  2409. (defcustom org-log-repeat 'time
  2410. "Non-nil means record moving through the DONE state when triggering repeat.
  2411. An auto-repeating task is immediately switched back to TODO when
  2412. marked DONE. If you are not logging state changes (by adding \"@\"
  2413. or \"!\" to the TODO keyword definition), or set `org-log-done' to
  2414. record a closing note, there will be no record of the task moving
  2415. through DONE. This variable forces taking a note anyway.
  2416. nil Don't force a record
  2417. time Record a time stamp
  2418. note Prompt for a note and add it with template `org-log-note-headings'
  2419. This option can also be set with on a per-file-basis with
  2420. #+STARTUP: nologrepeat
  2421. #+STARTUP: logrepeat
  2422. #+STARTUP: lognoterepeat
  2423. You can have local logging settings for a subtree by setting the LOGGING
  2424. property to one or more of these keywords."
  2425. :group 'org-todo
  2426. :group 'org-progress
  2427. :type '(choice
  2428. (const :tag "Don't force a record" nil)
  2429. (const :tag "Force recording the DONE state" time)
  2430. (const :tag "Force recording a note with the DONE state" note)))
  2431. (defgroup org-priorities nil
  2432. "Priorities in Org-mode."
  2433. :tag "Org Priorities"
  2434. :group 'org-todo)
  2435. (defcustom org-enable-priority-commands t
  2436. "Non-nil means priority commands are active.
  2437. When nil, these commands will be disabled, so that you never accidentally
  2438. set a priority."
  2439. :group 'org-priorities
  2440. :type 'boolean)
  2441. (defcustom org-highest-priority ?A
  2442. "The highest priority of TODO items. A character like ?A, ?B etc.
  2443. Must have a smaller ASCII number than `org-lowest-priority'."
  2444. :group 'org-priorities
  2445. :type 'character)
  2446. (defcustom org-lowest-priority ?C
  2447. "The lowest priority of TODO items. A character like ?A, ?B etc.
  2448. Must have a larger ASCII number than `org-highest-priority'."
  2449. :group 'org-priorities
  2450. :type 'character)
  2451. (defcustom org-default-priority ?B
  2452. "The default priority of TODO items.
  2453. This is the priority an item gets if no explicit priority is given.
  2454. When starting to cycle on an empty priority the first step in the cycle
  2455. depends on `org-priority-start-cycle-with-default'. The resulting first
  2456. step priority must not exceed the range from `org-highest-priority' to
  2457. `org-lowest-priority' which means that `org-default-priority' has to be
  2458. in this range exclusive or inclusive the range boundaries. Else the
  2459. first step refuses to set the default and the second will fall back
  2460. to (depending on the command used) the highest or lowest priority."
  2461. :group 'org-priorities
  2462. :type 'character)
  2463. (defcustom org-priority-start-cycle-with-default t
  2464. "Non-nil means start with default priority when starting to cycle.
  2465. When this is nil, the first step in the cycle will be (depending on the
  2466. command used) one higher or lower than the default priority.
  2467. See also `org-default-priority'."
  2468. :group 'org-priorities
  2469. :type 'boolean)
  2470. (defcustom org-get-priority-function nil
  2471. "Function to extract the priority from a string.
  2472. The string is normally the headline. If this is nil Org computes the
  2473. priority from the priority cookie like [#A] in the headline. It returns
  2474. an integer, increasing by 1000 for each priority level.
  2475. The user can set a different function here, which should take a string
  2476. as an argument and return the numeric priority."
  2477. :group 'org-priorities
  2478. :version "24.1"
  2479. :type '(choice
  2480. (const nil)
  2481. (function)))
  2482. (defgroup org-time nil
  2483. "Options concerning time stamps and deadlines in Org-mode."
  2484. :tag "Org Time"
  2485. :group 'org)
  2486. (defcustom org-insert-labeled-timestamps-at-point nil
  2487. "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
  2488. When nil, these labeled time stamps are forces into the second line of an
  2489. entry, just after the headline. When scheduling from the global TODO list,
  2490. the time stamp will always be forced into the second line."
  2491. :group 'org-time
  2492. :type 'boolean)
  2493. (defconst org-time-stamp-formats '("<%Y-%m-%d %a>" . "<%Y-%m-%d %a %H:%M>")
  2494. "Formats for `format-time-string' which are used for time stamps.
  2495. It is not recommended to change this constant.")
  2496. (defcustom org-time-stamp-rounding-minutes '(0 5)
  2497. "Number of minutes to round time stamps to.
  2498. These are two values, the first applies when first creating a time stamp.
  2499. The second applies when changing it with the commands `S-up' and `S-down'.
  2500. When changing the time stamp, this means that it will change in steps
  2501. of N minutes, as given by the second value.
  2502. When a setting is 0 or 1, insert the time unmodified. Useful rounding
  2503. numbers should be factors of 60, so for example 5, 10, 15.
  2504. When this is larger than 1, you can still force an exact time stamp by using
  2505. a double prefix argument to a time stamp command like `C-c .' or `C-c !',
  2506. and by using a prefix arg to `S-up/down' to specify the exact number
  2507. of minutes to shift."
  2508. :group 'org-time
  2509. :get #'(lambda (var) ; Make sure both elements are there
  2510. (if (integerp (default-value var))
  2511. (list (default-value var) 5)
  2512. (default-value var)))
  2513. :type '(list
  2514. (integer :tag "when inserting times")
  2515. (integer :tag "when modifying times")))
  2516. ;; Normalize old customizations of this variable.
  2517. (when (integerp org-time-stamp-rounding-minutes)
  2518. (setq org-time-stamp-rounding-minutes
  2519. (list org-time-stamp-rounding-minutes
  2520. org-time-stamp-rounding-minutes)))
  2521. (defcustom org-display-custom-times nil
  2522. "Non-nil means overlay custom formats over all time stamps.
  2523. The formats are defined through the variable `org-time-stamp-custom-formats'.
  2524. To turn this on on a per-file basis, insert anywhere in the file:
  2525. #+STARTUP: customtime"
  2526. :group 'org-time
  2527. :set 'set-default
  2528. :type 'sexp)
  2529. (make-variable-buffer-local 'org-display-custom-times)
  2530. (defcustom org-time-stamp-custom-formats
  2531. '("<%m/%d/%y %a>" . "<%m/%d/%y %a %H:%M>") ; american
  2532. "Custom formats for time stamps. See `format-time-string' for the syntax.
  2533. These are overlaid over the default ISO format if the variable
  2534. `org-display-custom-times' is set. Time like %H:%M should be at the
  2535. end of the second format. The custom formats are also honored by export
  2536. commands, if custom time display is turned on at the time of export."
  2537. :group 'org-time
  2538. :type 'sexp)
  2539. (defun org-time-stamp-format (&optional long inactive)
  2540. "Get the right format for a time string."
  2541. (let ((f (if long (cdr org-time-stamp-formats)
  2542. (car org-time-stamp-formats))))
  2543. (if inactive
  2544. (concat "[" (substring f 1 -1) "]")
  2545. f)))
  2546. (defcustom org-time-clocksum-format
  2547. '(:days "%dd " :hours "%d" :require-hours t :minutes ":%02d" :require-minutes t)
  2548. "The format string used when creating CLOCKSUM lines.
  2549. This is also used when Org mode generates a time duration.
  2550. The value can be a single format string containing two
  2551. %-sequences, which will be filled with the number of hours and
  2552. minutes in that order.
  2553. Alternatively, the value can be a plist associating any of the
  2554. keys :years, :months, :weeks, :days, :hours or :minutes with
  2555. format strings. The time duration is formatted using only the
  2556. time components that are needed and concatenating the results.
  2557. If a time unit in absent, it falls back to the next smallest
  2558. unit.
  2559. The keys :require-years, :require-months, :require-days,
  2560. :require-weeks, :require-hours, :require-minutes are also
  2561. meaningful. A non-nil value for these keys indicates that the
  2562. corresponding time component should always be included, even if
  2563. its value is 0.
  2564. For example,
  2565. \(:days \"%dd\" :hours \"%d\" :require-hours t :minutes \":%02d\"
  2566. :require-minutes t)
  2567. means durations longer than a day will be expressed in days,
  2568. hours and minutes, and durations less than a day will always be
  2569. expressed in hours and minutes (even for durations less than an
  2570. hour).
  2571. The value
  2572. \(:days \"%dd\" :minutes \"%dm\")
  2573. means durations longer than a day will be expressed in days and
  2574. minutes, and durations less than a day will be expressed entirely
  2575. in minutes (even for durations longer than an hour)."
  2576. :group 'org-time
  2577. :group 'org-clock
  2578. :version "24.4"
  2579. :package-version '(Org . "8.0")
  2580. :type '(choice (string :tag "Format string")
  2581. (set :tag "Plist"
  2582. (group :inline t (const :tag "Years" :years)
  2583. (string :tag "Format string"))
  2584. (group :inline t
  2585. (const :tag "Always show years" :require-years)
  2586. (const t))
  2587. (group :inline t (const :tag "Months" :months)
  2588. (string :tag "Format string"))
  2589. (group :inline t
  2590. (const :tag "Always show months" :require-months)
  2591. (const t))
  2592. (group :inline t (const :tag "Weeks" :weeks)
  2593. (string :tag "Format string"))
  2594. (group :inline t
  2595. (const :tag "Always show weeks" :require-weeks)
  2596. (const t))
  2597. (group :inline t (const :tag "Days" :days)
  2598. (string :tag "Format string"))
  2599. (group :inline t
  2600. (const :tag "Always show days" :require-days)
  2601. (const t))
  2602. (group :inline t (const :tag "Hours" :hours)
  2603. (string :tag "Format string"))
  2604. (group :inline t
  2605. (const :tag "Always show hours" :require-hours)
  2606. (const t))
  2607. (group :inline t (const :tag "Minutes" :minutes)
  2608. (string :tag "Format string"))
  2609. (group :inline t
  2610. (const :tag "Always show minutes" :require-minutes)
  2611. (const t)))))
  2612. (defcustom org-time-clocksum-use-fractional nil
  2613. "When non-nil, \\[org-clock-display] uses fractional times.
  2614. See `org-time-clocksum-format' for more on time clock formats."
  2615. :group 'org-time
  2616. :group 'org-clock
  2617. :version "24.3"
  2618. :type 'boolean)
  2619. (defcustom org-time-clocksum-use-effort-durations nil
  2620. "When non-nil, \\[org-clock-display] uses effort durations.
  2621. E.g. by default, one day is considered to be a 8 hours effort,
  2622. so a task that has been clocked for 16 hours will be displayed
  2623. as during 2 days in the clock display or in the clocktable.
  2624. See `org-effort-durations' on how to set effort durations
  2625. and `org-time-clocksum-format' for more on time clock formats."
  2626. :group 'org-time
  2627. :group 'org-clock
  2628. :version "24.4"
  2629. :package-version '(Org . "8.0")
  2630. :type 'boolean)
  2631. (defcustom org-time-clocksum-fractional-format "%.2f"
  2632. "The format string used when creating CLOCKSUM lines,
  2633. or when Org mode generates a time duration, if
  2634. `org-time-clocksum-use-fractional' is enabled.
  2635. The value can be a single format string containing one
  2636. %-sequence, which will be filled with the number of hours as
  2637. a float.
  2638. Alternatively, the value can be a plist associating any of the
  2639. keys :years, :months, :weeks, :days, :hours or :minutes with
  2640. a format string. The time duration is formatted using the
  2641. largest time unit which gives a non-zero integer part. If all
  2642. specified formats have zero integer part, the smallest time unit
  2643. is used."
  2644. :group 'org-time
  2645. :type '(choice (string :tag "Format string")
  2646. (set (group :inline t (const :tag "Years" :years)
  2647. (string :tag "Format string"))
  2648. (group :inline t (const :tag "Months" :months)
  2649. (string :tag "Format string"))
  2650. (group :inline t (const :tag "Weeks" :weeks)
  2651. (string :tag "Format string"))
  2652. (group :inline t (const :tag "Days" :days)
  2653. (string :tag "Format string"))
  2654. (group :inline t (const :tag "Hours" :hours)
  2655. (string :tag "Format string"))
  2656. (group :inline t (const :tag "Minutes" :minutes)
  2657. (string :tag "Format string")))))
  2658. (defcustom org-deadline-warning-days 14
  2659. "Number of days before expiration during which a deadline becomes active.
  2660. This variable governs the display in sparse trees and in the agenda.
  2661. When 0 or negative, it means use this number (the absolute value of it)
  2662. even if a deadline has a different individual lead time specified.
  2663. Custom commands can set this variable in the options section."
  2664. :group 'org-time
  2665. :group 'org-agenda-daily/weekly
  2666. :type 'integer)
  2667. (defcustom org-scheduled-delay-days 0
  2668. "Number of days before a scheduled item becomes active.
  2669. This variable governs the display in sparse trees and in the agenda.
  2670. The default value (i.e. 0) means: don't delay scheduled item.
  2671. When negative, it means use this number (the absolute value of it)
  2672. even if a scheduled item has a different individual delay time
  2673. specified.
  2674. Custom commands can set this variable in the options section."
  2675. :group 'org-time
  2676. :group 'org-agenda-daily/weekly
  2677. :version "24.4"
  2678. :package-version '(Org . "8.0")
  2679. :type 'integer)
  2680. (defcustom org-read-date-prefer-future t
  2681. "Non-nil means assume future for incomplete date input from user.
  2682. This affects the following situations:
  2683. 1. The user gives a month but not a year.
  2684. For example, if it is April and you enter \"feb 2\", this will be read
  2685. as Feb 2, *next* year. \"May 5\", however, will be this year.
  2686. 2. The user gives a day, but no month.
  2687. For example, if today is the 15th, and you enter \"3\", Org-mode will
  2688. read this as the third of *next* month. However, if you enter \"17\",
  2689. it will be considered as *this* month.
  2690. If you set this variable to the symbol `time', then also the following
  2691. will work:
  2692. 3. If the user gives a time.
  2693. If the time is before now, it will be interpreted as tomorrow.
  2694. Currently none of this works for ISO week specifications.
  2695. When this option is nil, the current day, month and year will always be
  2696. used as defaults.
  2697. See also `org-agenda-jump-prefer-future'."
  2698. :group 'org-time
  2699. :type '(choice
  2700. (const :tag "Never" nil)
  2701. (const :tag "Check month and day" t)
  2702. (const :tag "Check month, day, and time" time)))
  2703. (defcustom org-agenda-jump-prefer-future 'org-read-date-prefer-future
  2704. "Should the agenda jump command prefer the future for incomplete dates?
  2705. The default is to do the same as configured in `org-read-date-prefer-future'.
  2706. But you can also set a deviating value here.
  2707. This may t or nil, or the symbol `org-read-date-prefer-future'."
  2708. :group 'org-agenda
  2709. :group 'org-time
  2710. :version "24.1"
  2711. :type '(choice
  2712. (const :tag "Use org-read-date-prefer-future"
  2713. org-read-date-prefer-future)
  2714. (const :tag "Never" nil)
  2715. (const :tag "Always" t)))
  2716. (defcustom org-read-date-force-compatible-dates t
  2717. "Should date/time prompt force dates that are guaranteed to work in Emacs?
  2718. Depending on the system Emacs is running on, certain dates cannot
  2719. be represented with the type used internally to represent time.
  2720. Dates between 1970-1-1 and 2038-1-1 can always be represented
  2721. correctly. Some systems allow for earlier dates, some for later,
  2722. some for both. One way to find out it to insert any date into an
  2723. Org buffer, putting the cursor on the year and hitting S-up and
  2724. S-down to test the range.
  2725. When this variable is set to t, the date/time prompt will not let
  2726. you specify dates outside the 1970-2037 range, so it is certain that
  2727. these dates will work in whatever version of Emacs you are
  2728. running, and also that you can move a file from one Emacs implementation
  2729. to another. WHenever Org is forcing the year for you, it will display
  2730. a message and beep.
  2731. When this variable is nil, Org will check if the date is
  2732. representable in the specific Emacs implementation you are using.
  2733. If not, it will force a year, usually the current year, and beep
  2734. to remind you. Currently this setting is not recommended because
  2735. the likelihood that you will open your Org files in an Emacs that
  2736. has limited date range is not negligible.
  2737. A workaround for this problem is to use diary sexp dates for time
  2738. stamps outside of this range."
  2739. :group 'org-time
  2740. :version "24.1"
  2741. :type 'boolean)
  2742. (defcustom org-read-date-display-live t
  2743. "Non-nil means display current interpretation of date prompt live.
  2744. This display will be in an overlay, in the minibuffer."
  2745. :group 'org-time
  2746. :type 'boolean)
  2747. (defcustom org-read-date-popup-calendar t
  2748. "Non-nil means pop up a calendar when prompting for a date.
  2749. In the calendar, the date can be selected with mouse-1. However, the
  2750. minibuffer will also be active, and you can simply enter the date as well.
  2751. When nil, only the minibuffer will be available."
  2752. :group 'org-time
  2753. :type 'boolean)
  2754. (org-defvaralias 'org-popup-calendar-for-date-prompt
  2755. 'org-read-date-popup-calendar)
  2756. (make-obsolete-variable
  2757. 'org-read-date-minibuffer-setup-hook
  2758. "Set `org-read-date-minibuffer-local-map' instead." "24.4")
  2759. (defcustom org-read-date-minibuffer-setup-hook nil
  2760. "Hook to be used to set up keys for the date/time interface.
  2761. Add key definitions to `minibuffer-local-map', which will be a
  2762. temporary copy.
  2763. WARNING: This option is obsolete, you should use
  2764. `org-read-date-minibuffer-local-map' to set up keys."
  2765. :group 'org-time
  2766. :type 'hook)
  2767. (defcustom org-extend-today-until 0
  2768. "The hour when your day really ends. Must be an integer.
  2769. This has influence for the following applications:
  2770. - When switching the agenda to \"today\". It it is still earlier than
  2771. the time given here, the day recognized as TODAY is actually yesterday.
  2772. - When a date is read from the user and it is still before the time given
  2773. here, the current date and time will be assumed to be yesterday, 23:59.
  2774. Also, timestamps inserted in capture templates follow this rule.
  2775. IMPORTANT: This is a feature whose implementation is and likely will
  2776. remain incomplete. Really, it is only here because past midnight seems to
  2777. be the favorite working time of John Wiegley :-)"
  2778. :group 'org-time
  2779. :type 'integer)
  2780. (defcustom org-use-effective-time nil
  2781. "If non-nil, consider `org-extend-today-until' when creating timestamps.
  2782. For example, if `org-extend-today-until' is 8, and it's 4am, then the
  2783. \"effective time\" of any timestamps between midnight and 8am will be
  2784. 23:59 of the previous day."
  2785. :group 'org-time
  2786. :version "24.1"
  2787. :type 'boolean)
  2788. (defcustom org-use-last-clock-out-time-as-effective-time nil
  2789. "When non-nil, use the last clock out time for `org-todo'.
  2790. Note that this option has precedence over the combined use of
  2791. `org-use-effective-time' and `org-extend-today-until'."
  2792. :group 'org-time
  2793. :version "24.4"
  2794. :package-version '(Org . "8.0")
  2795. :type 'boolean)
  2796. (defcustom org-edit-timestamp-down-means-later nil
  2797. "Non-nil means S-down will increase the time in a time stamp.
  2798. When nil, S-up will increase."
  2799. :group 'org-time
  2800. :type 'boolean)
  2801. (defcustom org-calendar-follow-timestamp-change t
  2802. "Non-nil means make the calendar window follow timestamp changes.
  2803. When a timestamp is modified and the calendar window is visible, it will be
  2804. moved to the new date."
  2805. :group 'org-time
  2806. :type 'boolean)
  2807. (defgroup org-tags nil
  2808. "Options concerning tags in Org-mode."
  2809. :tag "Org Tags"
  2810. :group 'org)
  2811. (defcustom org-tag-alist nil
  2812. "List of tags allowed in Org-mode files.
  2813. When this list is nil, Org-mode will base TAG input on what is already in the
  2814. buffer.
  2815. The value of this variable is an alist, the car of each entry must be a
  2816. keyword as a string, the cdr may be a character that is used to select
  2817. that tag through the fast-tag-selection interface.
  2818. See the manual for details."
  2819. :group 'org-tags
  2820. :type '(repeat
  2821. (choice
  2822. (cons (string :tag "Tag name")
  2823. (character :tag "Access char"))
  2824. (list :tag "Start radio group"
  2825. (const :startgroup)
  2826. (option (string :tag "Group description")))
  2827. (list :tag "Group tags delimiter"
  2828. (const :grouptags))
  2829. (list :tag "End radio group"
  2830. (const :endgroup)
  2831. (option (string :tag "Group description")))
  2832. (const :tag "New line" (:newline)))))
  2833. (defcustom org-tag-persistent-alist nil
  2834. "List of tags that will always appear in all Org-mode files.
  2835. This is in addition to any in buffer settings or customizations
  2836. of `org-tag-alist'.
  2837. When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
  2838. The value of this variable is an alist, the car of each entry must be a
  2839. keyword as a string, the cdr may be a character that is used to select
  2840. that tag through the fast-tag-selection interface.
  2841. See the manual for details.
  2842. To disable these tags on a per-file basis, insert anywhere in the file:
  2843. #+STARTUP: noptag"
  2844. :group 'org-tags
  2845. :type '(repeat
  2846. (choice
  2847. (cons (string :tag "Tag name")
  2848. (character :tag "Access char"))
  2849. (const :tag "Start radio group" (:startgroup))
  2850. (const :tag "Group tags delimiter" (:grouptags))
  2851. (const :tag "End radio group" (:endgroup))
  2852. (const :tag "New line" (:newline)))))
  2853. (defcustom org-complete-tags-always-offer-all-agenda-tags nil
  2854. "If non-nil, always offer completion for all tags of all agenda files.
  2855. Instead of customizing this variable directly, you might want to
  2856. set it locally for capture buffers, because there no list of
  2857. tags in that file can be created dynamically (there are none).
  2858. (add-hook 'org-capture-mode-hook
  2859. (lambda ()
  2860. (set (make-local-variable
  2861. 'org-complete-tags-always-offer-all-agenda-tags)
  2862. t)))"
  2863. :group 'org-tags
  2864. :version "24.1"
  2865. :type 'boolean)
  2866. (defvar org-file-tags nil
  2867. "List of tags that can be inherited by all entries in the file.
  2868. The tags will be inherited if the variable `org-use-tag-inheritance'
  2869. says they should be.
  2870. This variable is populated from #+FILETAGS lines.")
  2871. (defcustom org-use-fast-tag-selection 'auto
  2872. "Non-nil means use fast tag selection scheme.
  2873. This is a special interface to select and deselect tags with single keys.
  2874. When nil, fast selection is never used.
  2875. When the symbol `auto', fast selection is used if and only if selection
  2876. characters for tags have been configured, either through the variable
  2877. `org-tag-alist' or through a #+TAGS line in the buffer.
  2878. When t, fast selection is always used and selection keys are assigned
  2879. automatically if necessary."
  2880. :group 'org-tags
  2881. :type '(choice
  2882. (const :tag "Always" t)
  2883. (const :tag "Never" nil)
  2884. (const :tag "When selection characters are configured" auto)))
  2885. (defcustom org-fast-tag-selection-single-key nil
  2886. "Non-nil means fast tag selection exits after first change.
  2887. When nil, you have to press RET to exit it.
  2888. During fast tag selection, you can toggle this flag with `C-c'.
  2889. This variable can also have the value `expert'. In this case, the window
  2890. displaying the tags menu is not even shown, until you press C-c again."
  2891. :group 'org-tags
  2892. :type '(choice
  2893. (const :tag "No" nil)
  2894. (const :tag "Yes" t)
  2895. (const :tag "Expert" expert)))
  2896. (defvar org-fast-tag-selection-include-todo nil
  2897. "Non-nil means fast tags selection interface will also offer TODO states.
  2898. This is an undocumented feature, you should not rely on it.")
  2899. (defcustom org-tags-column (if (featurep 'xemacs) -76 -77)
  2900. "The column to which tags should be indented in a headline.
  2901. If this number is positive, it specifies the column. If it is negative,
  2902. it means that the tags should be flushright to that column. For example,
  2903. -80 works well for a normal 80 character screen.
  2904. When 0, place tags directly after headline text, with only one space in
  2905. between."
  2906. :group 'org-tags
  2907. :type 'integer)
  2908. (defcustom org-auto-align-tags t
  2909. "Non-nil keeps tags aligned when modifying headlines.
  2910. Some operations (i.e. demoting) change the length of a headline and
  2911. therefore shift the tags around. With this option turned on, after
  2912. each such operation the tags are again aligned to `org-tags-column'."
  2913. :group 'org-tags
  2914. :type 'boolean)
  2915. (defcustom org-use-tag-inheritance t
  2916. "Non-nil means tags in levels apply also for sublevels.
  2917. When nil, only the tags directly given in a specific line apply there.
  2918. This may also be a list of tags that should be inherited, or a regexp that
  2919. matches tags that should be inherited. Additional control is possible
  2920. with the variable `org-tags-exclude-from-inheritance' which gives an
  2921. explicit list of tags to be excluded from inheritance, even if the value of
  2922. `org-use-tag-inheritance' would select it for inheritance.
  2923. If this option is t, a match early-on in a tree can lead to a large
  2924. number of matches in the subtree when constructing the agenda or creating
  2925. a sparse tree. If you only want to see the first match in a tree during
  2926. a search, check out the variable `org-tags-match-list-sublevels'."
  2927. :group 'org-tags
  2928. :type '(choice
  2929. (const :tag "Not" nil)
  2930. (const :tag "Always" t)
  2931. (repeat :tag "Specific tags" (string :tag "Tag"))
  2932. (regexp :tag "Tags matched by regexp")))
  2933. (defcustom org-tags-exclude-from-inheritance nil
  2934. "List of tags that should never be inherited.
  2935. This is a way to exclude a few tags from inheritance. For way to do
  2936. the opposite, to actively allow inheritance for selected tags,
  2937. see the variable `org-use-tag-inheritance'."
  2938. :group 'org-tags
  2939. :type '(repeat (string :tag "Tag")))
  2940. (defun org-tag-inherit-p (tag)
  2941. "Check if TAG is one that should be inherited."
  2942. (cond
  2943. ((member tag org-tags-exclude-from-inheritance) nil)
  2944. ((eq org-use-tag-inheritance t) t)
  2945. ((not org-use-tag-inheritance) nil)
  2946. ((stringp org-use-tag-inheritance)
  2947. (string-match org-use-tag-inheritance tag))
  2948. ((listp org-use-tag-inheritance)
  2949. (member tag org-use-tag-inheritance))
  2950. (t (error "Invalid setting of `org-use-tag-inheritance'"))))
  2951. (defcustom org-tags-match-list-sublevels t
  2952. "Non-nil means list also sublevels of headlines matching a search.
  2953. This variable applies to tags/property searches, and also to stuck
  2954. projects because this search is based on a tags match as well.
  2955. When set to the symbol `indented', sublevels are indented with
  2956. leading dots.
  2957. Because of tag inheritance (see variable `org-use-tag-inheritance'),
  2958. the sublevels of a headline matching a tag search often also match
  2959. the same search. Listing all of them can create very long lists.
  2960. Setting this variable to nil causes subtrees of a match to be skipped.
  2961. This variable is semi-obsolete and probably should always be true. It
  2962. is better to limit inheritance to certain tags using the variables
  2963. `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
  2964. :group 'org-tags
  2965. :type '(choice
  2966. (const :tag "No, don't list them" nil)
  2967. (const :tag "Yes, do list them" t)
  2968. (const :tag "List them, indented with leading dots" indented)))
  2969. (defcustom org-tags-sort-function nil
  2970. "When set, tags are sorted using this function as a comparator."
  2971. :group 'org-tags
  2972. :type '(choice
  2973. (const :tag "No sorting" nil)
  2974. (const :tag "Alphabetical" string<)
  2975. (const :tag "Reverse alphabetical" string>)
  2976. (function :tag "Custom function" nil)))
  2977. (defvar org-tags-history nil
  2978. "History of minibuffer reads for tags.")
  2979. (defvar org-last-tags-completion-table nil
  2980. "The last used completion table for tags.")
  2981. (defvar org-after-tags-change-hook nil
  2982. "Hook that is run after the tags in a line have changed.")
  2983. (defgroup org-properties nil
  2984. "Options concerning properties in Org-mode."
  2985. :tag "Org Properties"
  2986. :group 'org)
  2987. (defcustom org-property-format "%-10s %s"
  2988. "How property key/value pairs should be formatted by `indent-line'.
  2989. When `indent-line' hits a property definition, it will format the line
  2990. according to this format, mainly to make sure that the values are
  2991. lined-up with respect to each other."
  2992. :group 'org-properties
  2993. :type 'string)
  2994. (defcustom org-properties-postprocess-alist nil
  2995. "Alist of properties and functions to adjust inserted values.
  2996. Elements of this alist must be of the form
  2997. ([string] [function])
  2998. where [string] must be a property name and [function] must be a
  2999. lambda expression: this lambda expression must take one argument,
  3000. the value to adjust, and return the new value as a string.
  3001. For example, this element will allow the property \"Remaining\"
  3002. to be updated wrt the relation between the \"Effort\" property
  3003. and the clock summary:
  3004. ((\"Remaining\" (lambda(value)
  3005. (let ((clocksum (org-clock-sum-current-item))
  3006. (effort (org-duration-string-to-minutes
  3007. (org-entry-get (point) \"Effort\"))))
  3008. (org-minutes-to-clocksum-string (- effort clocksum))))))"
  3009. :group 'org-properties
  3010. :version "24.1"
  3011. :type '(alist :key-type (string :tag "Property")
  3012. :value-type (function :tag "Function")))
  3013. (defcustom org-use-property-inheritance nil
  3014. "Non-nil means properties apply also for sublevels.
  3015. This setting is chiefly used during property searches. Turning it on can
  3016. cause significant overhead when doing a search, which is why it is not
  3017. on by default.
  3018. When nil, only the properties directly given in the current entry count.
  3019. When t, every property is inherited. The value may also be a list of
  3020. properties that should have inheritance, or a regular expression matching
  3021. properties that should be inherited.
  3022. However, note that some special properties use inheritance under special
  3023. circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
  3024. and the properties ending in \"_ALL\" when they are used as descriptor
  3025. for valid values of a property.
  3026. Note for programmers:
  3027. When querying an entry with `org-entry-get', you can control if inheritance
  3028. should be used. By default, `org-entry-get' looks only at the local
  3029. properties. You can request inheritance by setting the inherit argument
  3030. to t (to force inheritance) or to `selective' (to respect the setting
  3031. in this variable)."
  3032. :group 'org-properties
  3033. :type '(choice
  3034. (const :tag "Not" nil)
  3035. (const :tag "Always" t)
  3036. (repeat :tag "Specific properties" (string :tag "Property"))
  3037. (regexp :tag "Properties matched by regexp")))
  3038. (defun org-property-inherit-p (property)
  3039. "Check if PROPERTY is one that should be inherited."
  3040. (cond
  3041. ((eq org-use-property-inheritance t) t)
  3042. ((not org-use-property-inheritance) nil)
  3043. ((stringp org-use-property-inheritance)
  3044. (string-match org-use-property-inheritance property))
  3045. ((listp org-use-property-inheritance)
  3046. (member property org-use-property-inheritance))
  3047. (t (error "Invalid setting of `org-use-property-inheritance'"))))
  3048. (defcustom org-columns-default-format "%25ITEM %TODO %3PRIORITY %TAGS"
  3049. "The default column format, if no other format has been defined.
  3050. This variable can be set on the per-file basis by inserting a line
  3051. #+COLUMNS: %25ITEM ....."
  3052. :group 'org-properties
  3053. :type 'string)
  3054. (defcustom org-columns-ellipses ".."
  3055. "The ellipses to be used when a field in column view is truncated.
  3056. When this is the empty string, as many characters as possible are shown,
  3057. but then there will be no visual indication that the field has been truncated.
  3058. When this is a string of length N, the last N characters of a truncated
  3059. field are replaced by this string. If the column is narrower than the
  3060. ellipses string, only part of the ellipses string will be shown."
  3061. :group 'org-properties
  3062. :type 'string)
  3063. (defcustom org-columns-modify-value-for-display-function nil
  3064. "Function that modifies values for display in column view.
  3065. For example, it can be used to cut out a certain part from a time stamp.
  3066. The function must take 2 arguments:
  3067. column-title The title of the column (*not* the property name)
  3068. value The value that should be modified.
  3069. The function should return the value that should be displayed,
  3070. or nil if the normal value should be used."
  3071. :group 'org-properties
  3072. :type '(choice (const nil) (function)))
  3073. (defcustom org-effort-property "Effort"
  3074. "The property that is being used to keep track of effort estimates.
  3075. Effort estimates given in this property need to have the format H:MM."
  3076. :group 'org-properties
  3077. :group 'org-progress
  3078. :type '(string :tag "Property"))
  3079. (defconst org-global-properties-fixed
  3080. '(("VISIBILITY_ALL" . "folded children content all")
  3081. ("CLOCK_MODELINE_TOTAL_ALL" . "current today repeat all auto"))
  3082. "List of property/value pairs that can be inherited by any entry.
  3083. These are fixed values, for the preset properties. The user variable
  3084. that can be used to add to this list is `org-global-properties'.
  3085. The entries in this list are cons cells where the car is a property
  3086. name and cdr is a string with the value. If the value represents
  3087. multiple items like an \"_ALL\" property, separate the items by
  3088. spaces.")
  3089. (defcustom org-global-properties nil
  3090. "List of property/value pairs that can be inherited by any entry.
  3091. This list will be combined with the constant `org-global-properties-fixed'.
  3092. The entries in this list are cons cells where the car is a property
  3093. name and cdr is a string with the value.
  3094. You can set buffer-local values for the same purpose in the variable
  3095. `org-file-properties' this by adding lines like
  3096. #+PROPERTY: NAME VALUE"
  3097. :group 'org-properties
  3098. :type '(repeat
  3099. (cons (string :tag "Property")
  3100. (string :tag "Value"))))
  3101. (defvar org-file-properties nil
  3102. "List of property/value pairs that can be inherited by any entry.
  3103. Valid for the current buffer.
  3104. This variable is populated from #+PROPERTY lines.")
  3105. (make-variable-buffer-local 'org-file-properties)
  3106. (defgroup org-agenda nil
  3107. "Options concerning agenda views in Org-mode."
  3108. :tag "Org Agenda"
  3109. :group 'org)
  3110. (defvar org-category nil
  3111. "Variable used by org files to set a category for agenda display.
  3112. Such files should use a file variable to set it, for example
  3113. # -*- mode: org; org-category: \"ELisp\"
  3114. or contain a special line
  3115. #+CATEGORY: ELisp
  3116. If the file does not specify a category, then file's base name
  3117. is used instead.")
  3118. (make-variable-buffer-local 'org-category)
  3119. (put 'org-category 'safe-local-variable #'(lambda (x) (or (symbolp x) (stringp x))))
  3120. (defcustom org-agenda-files nil
  3121. "The files to be used for agenda display.
  3122. Entries may be added to this list with \\[org-agenda-file-to-front] and removed with
  3123. \\[org-remove-file]. You can also use customize to edit the list.
  3124. If an entry is a directory, all files in that directory that are matched by
  3125. `org-agenda-file-regexp' will be part of the file list.
  3126. If the value of the variable is not a list but a single file name, then
  3127. the list of agenda files is actually stored and maintained in that file, one
  3128. agenda file per line. In this file paths can be given relative to
  3129. `org-directory'. Tilde expansion and environment variable substitution
  3130. are also made."
  3131. :group 'org-agenda
  3132. :type '(choice
  3133. (repeat :tag "List of files and directories" file)
  3134. (file :tag "Store list in a file\n" :value "~/.agenda_files")))
  3135. (defcustom org-agenda-file-regexp "\\`[^.].*\\.org\\'"
  3136. "Regular expression to match files for `org-agenda-files'.
  3137. If any element in the list in that variable contains a directory instead
  3138. of a normal file, all files in that directory that are matched by this
  3139. regular expression will be included."
  3140. :group 'org-agenda
  3141. :type 'regexp)
  3142. (defcustom org-agenda-text-search-extra-files nil
  3143. "List of extra files to be searched by text search commands.
  3144. These files will be searched in addition to the agenda files by the
  3145. commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
  3146. Note that these files will only be searched for text search commands,
  3147. not for the other agenda views like todo lists, tag searches or the weekly
  3148. agenda. This variable is intended to list notes and possibly archive files
  3149. that should also be searched by these two commands.
  3150. In fact, if the first element in the list is the symbol `agenda-archives',
  3151. then all archive files of all agenda files will be added to the search
  3152. scope."
  3153. :group 'org-agenda
  3154. :type '(set :greedy t
  3155. (const :tag "Agenda Archives" agenda-archives)
  3156. (repeat :inline t (file))))
  3157. (org-defvaralias 'org-agenda-multi-occur-extra-files
  3158. 'org-agenda-text-search-extra-files)
  3159. (defcustom org-agenda-skip-unavailable-files nil
  3160. "Non-nil means to just skip non-reachable files in `org-agenda-files'.
  3161. A nil value means to remove them, after a query, from the list."
  3162. :group 'org-agenda
  3163. :type 'boolean)
  3164. (defcustom org-calendar-to-agenda-key [?c]
  3165. "The key to be installed in `calendar-mode-map' for switching to the agenda.
  3166. The command `org-calendar-goto-agenda' will be bound to this key. The
  3167. default is the character `c' because then `c' can be used to switch back and
  3168. forth between agenda and calendar."
  3169. :group 'org-agenda
  3170. :type 'sexp)
  3171. (defcustom org-calendar-insert-diary-entry-key [?i]
  3172. "The key to be installed in `calendar-mode-map' for adding diary entries.
  3173. This option is irrelevant until `org-agenda-diary-file' has been configured
  3174. to point to an Org-mode file. When that is the case, the command
  3175. `org-agenda-diary-entry' will be bound to the key given here, by default
  3176. `i'. In the calendar, `i' normally adds entries to `diary-file'. So
  3177. if you want to continue doing this, you need to change this to a different
  3178. key."
  3179. :group 'org-agenda
  3180. :type 'sexp)
  3181. (defcustom org-agenda-diary-file 'diary-file
  3182. "File to which to add new entries with the `i' key in agenda and calendar.
  3183. When this is the symbol `diary-file', the functionality in the Emacs
  3184. calendar will be used to add entries to the `diary-file'. But when this
  3185. points to a file, `org-agenda-diary-entry' will be used instead."
  3186. :group 'org-agenda
  3187. :type '(choice
  3188. (const :tag "The standard Emacs diary file" diary-file)
  3189. (file :tag "Special Org file diary entries")))
  3190. (eval-after-load "calendar"
  3191. '(progn
  3192. (org-defkey calendar-mode-map org-calendar-to-agenda-key
  3193. 'org-calendar-goto-agenda)
  3194. (add-hook 'calendar-mode-hook
  3195. (lambda ()
  3196. (unless (eq org-agenda-diary-file 'diary-file)
  3197. (define-key calendar-mode-map
  3198. org-calendar-insert-diary-entry-key
  3199. 'org-agenda-diary-entry))))))
  3200. (defgroup org-latex nil
  3201. "Options for embedding LaTeX code into Org-mode."
  3202. :tag "Org LaTeX"
  3203. :group 'org)
  3204. (defcustom org-format-latex-options
  3205. '(:foreground default :background default :scale 1.0
  3206. :html-foreground "Black" :html-background "Transparent"
  3207. :html-scale 1.0 :matchers ("begin" "$1" "$" "$$" "\\(" "\\["))
  3208. "Options for creating images from LaTeX fragments.
  3209. This is a property list with the following properties:
  3210. :foreground the foreground color for images embedded in Emacs, e.g. \"Black\".
  3211. `default' means use the foreground of the default face.
  3212. `auto' means use the foreground from the text face.
  3213. :background the background color, or \"Transparent\".
  3214. `default' means use the background of the default face.
  3215. `auto' means use the background from the text face.
  3216. :scale a scaling factor for the size of the images, to get more pixels
  3217. :html-foreground, :html-background, :html-scale
  3218. the same numbers for HTML export.
  3219. :matchers a list indicating which matchers should be used to
  3220. find LaTeX fragments. Valid members of this list are:
  3221. \"begin\" find environments
  3222. \"$1\" find single characters surrounded by $.$
  3223. \"$\" find math expressions surrounded by $...$
  3224. \"$$\" find math expressions surrounded by $$....$$
  3225. \"\\(\" find math expressions surrounded by \\(...\\)
  3226. \"\\ [\" find math expressions surrounded by \\ [...\\]"
  3227. :group 'org-latex
  3228. :type 'plist)
  3229. (defcustom org-format-latex-signal-error t
  3230. "Non-nil means signal an error when image creation of LaTeX snippets fails.
  3231. When nil, just push out a message."
  3232. :group 'org-latex
  3233. :version "24.1"
  3234. :type 'boolean)
  3235. (defcustom org-latex-to-mathml-jar-file nil
  3236. "Value of\"%j\" in `org-latex-to-mathml-convert-command'.
  3237. Use this to specify additional executable file say a jar file.
  3238. When using MathToWeb as the converter, specify the full-path to
  3239. your mathtoweb.jar file."
  3240. :group 'org-latex
  3241. :version "24.1"
  3242. :type '(choice
  3243. (const :tag "None" nil)
  3244. (file :tag "JAR file" :must-match t)))
  3245. (defcustom org-latex-to-mathml-convert-command nil
  3246. "Command to convert LaTeX fragments to MathML.
  3247. Replace format-specifiers in the command as noted below and use
  3248. `shell-command' to convert LaTeX to MathML.
  3249. %j: Executable file in fully expanded form as specified by
  3250. `org-latex-to-mathml-jar-file'.
  3251. %I: Input LaTeX file in fully expanded form
  3252. %o: Output MathML file
  3253. This command is used by `org-create-math-formula'.
  3254. When using MathToWeb as the converter, set this to
  3255. \"java -jar %j -unicode -force -df %o %I\"."
  3256. :group 'org-latex
  3257. :version "24.1"
  3258. :type '(choice
  3259. (const :tag "None" nil)
  3260. (string :tag "\nShell command")))
  3261. (defcustom org-latex-create-formula-image-program 'dvipng
  3262. "Program to convert LaTeX fragments with.
  3263. dvipng Process the LaTeX fragments to dvi file, then convert
  3264. dvi files to png files using dvipng.
  3265. This will also include processing of non-math environments.
  3266. imagemagick Convert the LaTeX fragments to pdf files and use imagemagick
  3267. to convert pdf files to png files"
  3268. :group 'org-latex
  3269. :version "24.1"
  3270. :type '(choice
  3271. (const :tag "dvipng" dvipng)
  3272. (const :tag "imagemagick" imagemagick)))
  3273. (defcustom org-latex-preview-ltxpng-directory "ltxpng/"
  3274. "Path to store latex preview images.
  3275. A relative path here creates many directories relative to the
  3276. processed org files paths. An absolute path puts all preview
  3277. images at the same place."
  3278. :group 'org-latex
  3279. :version "24.3"
  3280. :type 'string)
  3281. (defun org-format-latex-mathml-available-p ()
  3282. "Return t if `org-latex-to-mathml-convert-command' is usable."
  3283. (save-match-data
  3284. (when (and (boundp 'org-latex-to-mathml-convert-command)
  3285. org-latex-to-mathml-convert-command)
  3286. (let ((executable (car (split-string
  3287. org-latex-to-mathml-convert-command))))
  3288. (when (executable-find executable)
  3289. (if (string-match
  3290. "%j" org-latex-to-mathml-convert-command)
  3291. (file-readable-p org-latex-to-mathml-jar-file)
  3292. t))))))
  3293. (defcustom org-format-latex-header "\\documentclass{article}
  3294. \\usepackage[usenames]{color}
  3295. \\usepackage{amsmath}
  3296. \\usepackage[mathscr]{eucal}
  3297. \[PACKAGES]
  3298. \[DEFAULT-PACKAGES]
  3299. \\pagestyle{empty} % do not remove
  3300. % The settings below are copied from fullpage.sty
  3301. \\setlength{\\textwidth}{\\paperwidth}
  3302. \\addtolength{\\textwidth}{-3cm}
  3303. \\setlength{\\oddsidemargin}{1.5cm}
  3304. \\addtolength{\\oddsidemargin}{-2.54cm}
  3305. \\setlength{\\evensidemargin}{\\oddsidemargin}
  3306. \\setlength{\\textheight}{\\paperheight}
  3307. \\addtolength{\\textheight}{-\\headheight}
  3308. \\addtolength{\\textheight}{-\\headsep}
  3309. \\addtolength{\\textheight}{-\\footskip}
  3310. \\addtolength{\\textheight}{-3cm}
  3311. \\setlength{\\topmargin}{1.5cm}
  3312. \\addtolength{\\topmargin}{-2.54cm}"
  3313. "The document header used for processing LaTeX fragments.
  3314. It is imperative that this header make sure that no page number
  3315. appears on the page. The package defined in the variables
  3316. `org-latex-default-packages-alist' and `org-latex-packages-alist'
  3317. will either replace the placeholder \"[PACKAGES]\" in this
  3318. header, or they will be appended."
  3319. :group 'org-latex
  3320. :type 'string)
  3321. (defun org-set-packages-alist (var val)
  3322. "Set the packages alist and make sure it has 3 elements per entry."
  3323. (set var (mapcar (lambda (x)
  3324. (if (and (consp x) (= (length x) 2))
  3325. (list (car x) (nth 1 x) t)
  3326. x))
  3327. val)))
  3328. (defun org-get-packages-alist (var)
  3329. "Get the packages alist and make sure it has 3 elements per entry."
  3330. (mapcar (lambda (x)
  3331. (if (and (consp x) (= (length x) 2))
  3332. (list (car x) (nth 1 x) t)
  3333. x))
  3334. (default-value var)))
  3335. (defcustom org-latex-default-packages-alist
  3336. '(("AUTO" "inputenc" t)
  3337. ("T1" "fontenc" t)
  3338. ("" "fixltx2e" nil)
  3339. ("" "graphicx" t)
  3340. ("" "longtable" nil)
  3341. ("" "float" nil)
  3342. ("" "wrapfig" nil)
  3343. ("normalem" "ulem" t)
  3344. ("" "textcomp" t)
  3345. ("" "marvosym" t)
  3346. ("" "wasysym" t)
  3347. ("" "amssymb" t)
  3348. ("" "amstext" nil)
  3349. ("" "hyperref" nil)
  3350. "\\tolerance=1000")
  3351. "Alist of default packages to be inserted in the header.
  3352. Change this only if one of the packages here causes an
  3353. incompatibility with another package you are using.
  3354. The packages in this list are needed by one part or another of
  3355. Org mode to function properly:
  3356. - inputenc, fontenc: for basic font and character selection
  3357. - amstext: for subscript and superscript
  3358. - textcomp, marvosymb, wasysym, amssymb: for various symbols used
  3359. for interpreting the entities in `org-entities'. You can skip
  3360. some of these packages if you don't use any of their symbols.
  3361. - ulem: for underline and strike-through
  3362. - graphicx: for including images
  3363. - float, wrapfig: for figure placement
  3364. - longtable: for long tables
  3365. - hyperref: for cross references
  3366. Therefore you should not modify this variable unless you know
  3367. what you are doing. The one reason to change it anyway is that
  3368. you might be loading some other package that conflicts with one
  3369. of the default packages. Each cell is of the format
  3370. \( \"options\" \"package\" snippet-flag). If SNIPPET-FLAG is t,
  3371. the package also needs to be included when compiling LaTeX
  3372. snippets into images for inclusion into non-LaTeX output."
  3373. :group 'org-latex
  3374. :group 'org-export-latex
  3375. :set 'org-set-packages-alist
  3376. :get 'org-get-packages-alist
  3377. :version "24.1"
  3378. :type '(repeat
  3379. (choice
  3380. (list :tag "options/package pair"
  3381. (string :tag "options")
  3382. (string :tag "package")
  3383. (boolean :tag "Snippet"))
  3384. (string :tag "A line of LaTeX"))))
  3385. (defcustom org-latex-packages-alist nil
  3386. "Alist of packages to be inserted in every LaTeX header.
  3387. These will be inserted after `org-latex-default-packages-alist'.
  3388. Each cell is of the format:
  3389. \(\"options\" \"package\" snippet-flag)
  3390. SNIPPET-FLAG, when t, indicates that this package is also needed
  3391. when turning LaTeX snippets into images for inclusion into
  3392. non-LaTeX output.
  3393. Make sure that you only list packages here which:
  3394. - you want in every file
  3395. - do not conflict with the setup in `org-format-latex-header'.
  3396. - do not conflict with the default packages in
  3397. `org-latex-default-packages-alist'."
  3398. :group 'org-latex
  3399. :group 'org-export-latex
  3400. :set 'org-set-packages-alist
  3401. :get 'org-get-packages-alist
  3402. :type '(repeat
  3403. (choice
  3404. (list :tag "options/package pair"
  3405. (string :tag "options")
  3406. (string :tag "package")
  3407. (boolean :tag "Snippet"))
  3408. (string :tag "A line of LaTeX"))))
  3409. (defgroup org-appearance nil
  3410. "Settings for Org-mode appearance."
  3411. :tag "Org Appearance"
  3412. :group 'org)
  3413. (defcustom org-level-color-stars-only nil
  3414. "Non-nil means fontify only the stars in each headline.
  3415. When nil, the entire headline is fontified.
  3416. Changing it requires restart of `font-lock-mode' to become effective
  3417. also in regions already fontified."
  3418. :group 'org-appearance
  3419. :type 'boolean)
  3420. (defcustom org-hide-leading-stars nil
  3421. "Non-nil means hide the first N-1 stars in a headline.
  3422. This works by using the face `org-hide' for these stars. This
  3423. face is white for a light background, and black for a dark
  3424. background. You may have to customize the face `org-hide' to
  3425. make this work.
  3426. Changing it requires restart of `font-lock-mode' to become effective
  3427. also in regions already fontified.
  3428. You may also set this on a per-file basis by adding one of the following
  3429. lines to the buffer:
  3430. #+STARTUP: hidestars
  3431. #+STARTUP: showstars"
  3432. :group 'org-appearance
  3433. :type 'boolean)
  3434. (defcustom org-hidden-keywords nil
  3435. "List of symbols corresponding to keywords to be hidden the org buffer.
  3436. For example, a value '(title) for this list will make the document's title
  3437. appear in the buffer without the initial #+TITLE: keyword."
  3438. :group 'org-appearance
  3439. :version "24.1"
  3440. :type '(set (const :tag "#+AUTHOR" author)
  3441. (const :tag "#+DATE" date)
  3442. (const :tag "#+EMAIL" email)
  3443. (const :tag "#+TITLE" title)))
  3444. (defcustom org-custom-properties nil
  3445. "List of properties (as strings) with a special meaning.
  3446. The default use of these custom properties is to let the user
  3447. hide them with `org-toggle-custom-properties-visibility'."
  3448. :group 'org-properties
  3449. :group 'org-appearance
  3450. :version "24.3"
  3451. :type '(repeat (string :tag "Property Name")))
  3452. (defcustom org-fontify-done-headline nil
  3453. "Non-nil means change the face of a headline if it is marked DONE.
  3454. Normally, only the TODO/DONE keyword indicates the state of a headline.
  3455. When this is non-nil, the headline after the keyword is set to the
  3456. `org-headline-done' as an additional indication."
  3457. :group 'org-appearance
  3458. :type 'boolean)
  3459. (defcustom org-fontify-emphasized-text t
  3460. "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
  3461. Changing this variable requires a restart of Emacs to take effect."
  3462. :group 'org-appearance
  3463. :type 'boolean)
  3464. (defcustom org-fontify-whole-heading-line nil
  3465. "Non-nil means fontify the whole line for headings.
  3466. This is useful when setting a background color for the
  3467. org-level-* faces."
  3468. :group 'org-appearance
  3469. :type 'boolean)
  3470. (defcustom org-highlight-latex-and-related nil
  3471. "Non-nil means highlight LaTeX related syntax in the buffer.
  3472. When non nil, the value should be a list containing any of the
  3473. following symbols:
  3474. `latex' Highlight LaTeX snippets and environments.
  3475. `script' Highlight subscript and superscript.
  3476. `entities' Highlight entities."
  3477. :group 'org-appearance
  3478. :version "24.4"
  3479. :package-version '(Org . "8.0")
  3480. :type '(choice
  3481. (const :tag "No highlighting" nil)
  3482. (set :greedy t :tag "Highlight"
  3483. (const :tag "LaTeX snippets and environments" latex)
  3484. (const :tag "Subscript and superscript" script)
  3485. (const :tag "Entities" entities))))
  3486. (defcustom org-hide-emphasis-markers nil
  3487. "Non-nil mean font-lock should hide the emphasis marker characters."
  3488. :group 'org-appearance
  3489. :type 'boolean)
  3490. (defcustom org-pretty-entities nil
  3491. "Non-nil means show entities as UTF8 characters.
  3492. When nil, the \\name form remains in the buffer."
  3493. :group 'org-appearance
  3494. :version "24.1"
  3495. :type 'boolean)
  3496. (defcustom org-pretty-entities-include-sub-superscripts t
  3497. "Non-nil means, pretty entity display includes formatting sub/superscripts."
  3498. :group 'org-appearance
  3499. :version "24.1"
  3500. :type 'boolean)
  3501. (defvar org-emph-re nil
  3502. "Regular expression for matching emphasis.
  3503. After a match, the match groups contain these elements:
  3504. 0 The match of the full regular expression, including the characters
  3505. before and after the proper match
  3506. 1 The character before the proper match, or empty at beginning of line
  3507. 2 The proper match, including the leading and trailing markers
  3508. 3 The leading marker like * or /, indicating the type of highlighting
  3509. 4 The text between the emphasis markers, not including the markers
  3510. 5 The character after the match, empty at the end of a line")
  3511. (defvar org-verbatim-re nil
  3512. "Regular expression for matching verbatim text.")
  3513. (defvar org-emphasis-regexp-components) ; defined just below
  3514. (defvar org-emphasis-alist) ; defined just below
  3515. (defun org-set-emph-re (var val)
  3516. "Set variable and compute the emphasis regular expression."
  3517. (set var val)
  3518. (when (and (boundp 'org-emphasis-alist)
  3519. (boundp 'org-emphasis-regexp-components)
  3520. org-emphasis-alist org-emphasis-regexp-components)
  3521. (let* ((e org-emphasis-regexp-components)
  3522. (pre (car e))
  3523. (post (nth 1 e))
  3524. (border (nth 2 e))
  3525. (body (nth 3 e))
  3526. (nl (nth 4 e))
  3527. (body1 (concat body "*?"))
  3528. (markers (mapconcat 'car org-emphasis-alist ""))
  3529. (vmarkers (mapconcat
  3530. (lambda (x) (if (eq (nth 2 x) 'verbatim) (car x) ""))
  3531. org-emphasis-alist "")))
  3532. ;; make sure special characters appear at the right position in the class
  3533. (if (string-match "\\^" markers)
  3534. (setq markers (concat (replace-match "" t t markers) "^")))
  3535. (if (string-match "-" markers)
  3536. (setq markers (concat (replace-match "" t t markers) "-")))
  3537. (if (string-match "\\^" vmarkers)
  3538. (setq vmarkers (concat (replace-match "" t t vmarkers) "^")))
  3539. (if (string-match "-" vmarkers)
  3540. (setq vmarkers (concat (replace-match "" t t vmarkers) "-")))
  3541. (if (> nl 0)
  3542. (setq body1 (concat body1 "\\(?:\n" body "*?\\)\\{0,"
  3543. (int-to-string nl) "\\}")))
  3544. ;; Make the regexp
  3545. (setq org-emph-re
  3546. (concat "\\([" pre "]\\|^\\)"
  3547. "\\("
  3548. "\\([" markers "]\\)"
  3549. "\\("
  3550. "[^" border "]\\|"
  3551. "[^" border "]"
  3552. body1
  3553. "[^" border "]"
  3554. "\\)"
  3555. "\\3\\)"
  3556. "\\([" post "]\\|$\\)"))
  3557. (setq org-verbatim-re
  3558. (concat "\\([" pre "]\\|^\\)"
  3559. "\\("
  3560. "\\([" vmarkers "]\\)"
  3561. "\\("
  3562. "[^" border "]\\|"
  3563. "[^" border "]"
  3564. body1
  3565. "[^" border "]"
  3566. "\\)"
  3567. "\\3\\)"
  3568. "\\([" post "]\\|$\\)")))))
  3569. ;; This used to be a defcustom (Org <8.0) but allowing the users to
  3570. ;; set this option proved cumbersome. See this message/thread:
  3571. ;; http://article.gmane.org/gmane.emacs.orgmode/68681
  3572. (defvar org-emphasis-regexp-components
  3573. '(" \t('\"{" "- \t.,:!?;'\")}\\" " \t\r\n,\"'" "." 1)
  3574. "Components used to build the regular expression for emphasis.
  3575. This is a list with five entries. Terminology: In an emphasis string
  3576. like \" *strong word* \", we call the initial space PREMATCH, the final
  3577. space POSTMATCH, the stars MARKERS, \"s\" and \"d\" are BORDER characters
  3578. and \"trong wor\" is the body. The different components in this variable
  3579. specify what is allowed/forbidden in each part:
  3580. pre Chars allowed as prematch. Beginning of line will be allowed too.
  3581. post Chars allowed as postmatch. End of line will be allowed too.
  3582. border The chars *forbidden* as border characters.
  3583. body-regexp A regexp like \".\" to match a body character. Don't use
  3584. non-shy groups here, and don't allow newline here.
  3585. newline The maximum number of newlines allowed in an emphasis exp.
  3586. You need to reload Org or to restart Emacs after customizing this.")
  3587. (defcustom org-emphasis-alist
  3588. `(("*" bold)
  3589. ("/" italic)
  3590. ("_" underline)
  3591. ("=" org-code verbatim)
  3592. ("~" org-verbatim verbatim)
  3593. ("+" ,(if (featurep 'xemacs) 'org-table '(:strike-through t))))
  3594. "Alist of characters and faces to emphasize text.
  3595. Text starting and ending with a special character will be emphasized,
  3596. for example *bold*, _underlined_ and /italic/. This variable sets the
  3597. marker characters and the face to be used by font-lock for highlighting
  3598. in Org-mode Emacs buffers.
  3599. You need to reload Org or to restart Emacs after customizing this."
  3600. :group 'org-appearance
  3601. :set 'org-set-emph-re
  3602. :version "24.4"
  3603. :package-version '(Org . "8.0")
  3604. :type '(repeat
  3605. (list
  3606. (string :tag "Marker character")
  3607. (choice
  3608. (face :tag "Font-lock-face")
  3609. (plist :tag "Face property list"))
  3610. (option (const verbatim)))))
  3611. (defvar org-protecting-blocks
  3612. '("src" "example" "latex" "ascii" "html" "ditaa" "dot" "r" "R")
  3613. "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
  3614. This is needed for font-lock setup.")
  3615. ;;; Miscellaneous options
  3616. (defgroup org-completion nil
  3617. "Completion in Org-mode."
  3618. :tag "Org Completion"
  3619. :group 'org)
  3620. (defcustom org-completion-use-ido nil
  3621. "Non-nil means use ido completion wherever possible.
  3622. Note that `ido-mode' must be active for this variable to be relevant.
  3623. If you decide to turn this variable on, you might well want to turn off
  3624. `org-outline-path-complete-in-steps'.
  3625. See also `org-completion-use-iswitchb'."
  3626. :group 'org-completion
  3627. :type 'boolean)
  3628. (defcustom org-completion-use-iswitchb nil
  3629. "Non-nil means use iswitchb completion wherever possible.
  3630. Note that `iswitchb-mode' must be active for this variable to be relevant.
  3631. If you decide to turn this variable on, you might well want to turn off
  3632. `org-outline-path-complete-in-steps'.
  3633. Note that this variable has only an effect if `org-completion-use-ido' is nil."
  3634. :group 'org-completion
  3635. :type 'boolean)
  3636. (defcustom org-completion-fallback-command 'hippie-expand
  3637. "The expansion command called by \\[pcomplete] in normal context.
  3638. Normal means, no org-mode-specific context."
  3639. :group 'org-completion
  3640. :type 'function)
  3641. ;;; Functions and variables from their packages
  3642. ;; Declared here to avoid compiler warnings
  3643. ;; XEmacs only
  3644. (defvar outline-mode-menu-heading)
  3645. (defvar outline-mode-menu-show)
  3646. (defvar outline-mode-menu-hide)
  3647. (defvar zmacs-regions) ; XEmacs regions
  3648. ;; Emacs only
  3649. (defvar mark-active)
  3650. ;; Various packages
  3651. (declare-function calendar-absolute-from-iso "cal-iso" (date))
  3652. (declare-function calendar-forward-day "cal-move" (arg))
  3653. (declare-function calendar-goto-date "cal-move" (date))
  3654. (declare-function calendar-goto-today "cal-move" ())
  3655. (declare-function calendar-iso-from-absolute "cal-iso" (date))
  3656. (defvar calc-embedded-close-formula)
  3657. (defvar calc-embedded-open-formula)
  3658. (declare-function cdlatex-tab "ext:cdlatex" ())
  3659. (declare-function cdlatex-compute-tables "ext:cdlatex" ())
  3660. (declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
  3661. (defvar font-lock-unfontify-region-function)
  3662. (declare-function iswitchb-read-buffer "iswitchb"
  3663. (prompt &optional default require-match start matches-set))
  3664. (defvar iswitchb-temp-buflist)
  3665. (declare-function org-gnus-follow-link "org-gnus" (&optional group article))
  3666. (defvar org-agenda-tags-todo-honor-ignore-options)
  3667. (declare-function org-agenda-skip "org-agenda" ())
  3668. (declare-function
  3669. org-agenda-format-item "org-agenda"
  3670. (extra txt &optional level category tags dotime noprefix remove-re habitp))
  3671. (declare-function org-agenda-new-marker "org-agenda" (&optional pos))
  3672. (declare-function org-agenda-change-all-lines "org-agenda"
  3673. (newhead hdmarker &optional fixface just-this))
  3674. (declare-function org-agenda-set-restriction-lock "org-agenda" (&optional type))
  3675. (declare-function org-agenda-maybe-redo "org-agenda" ())
  3676. (declare-function org-agenda-save-markers-for-cut-and-paste "org-agenda"
  3677. (beg end))
  3678. (declare-function org-agenda-copy-local-variable "org-agenda" (var))
  3679. (declare-function org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
  3680. "org-agenda" (&optional end))
  3681. (declare-function org-inlinetask-remove-END-maybe "org-inlinetask" ())
  3682. (declare-function org-inlinetask-in-task-p "org-inlinetask" ())
  3683. (declare-function org-inlinetask-goto-beginning "org-inlinetask" ())
  3684. (declare-function org-inlinetask-goto-end "org-inlinetask" ())
  3685. (declare-function org-indent-mode "org-indent" (&optional arg))
  3686. (declare-function parse-time-string "parse-time" (string))
  3687. (declare-function org-attach-reveal "org-attach" (&optional if-exists))
  3688. (declare-function orgtbl-send-table "org-table" (&optional maybe))
  3689. (defvar remember-data-file)
  3690. (defvar texmathp-why)
  3691. (declare-function speedbar-line-directory "speedbar" (&optional depth))
  3692. (declare-function table--at-cell-p "table" (position &optional object at-column))
  3693. (defvar org-latex-regexps)
  3694. ;;; Autoload and prepare some org modules
  3695. ;; Some table stuff that needs to be defined here, because it is used
  3696. ;; by the functions setting up org-mode or checking for table context.
  3697. (defconst org-table-any-line-regexp "^[ \t]*\\(|\\|\\+-[-+]\\)"
  3698. "Detect an org-type or table-type table.")
  3699. (defconst org-table-line-regexp "^[ \t]*|"
  3700. "Detect an org-type table line.")
  3701. (defconst org-table-dataline-regexp "^[ \t]*|[^-]"
  3702. "Detect an org-type table line.")
  3703. (defconst org-table-hline-regexp "^[ \t]*|-"
  3704. "Detect an org-type table hline.")
  3705. (defconst org-table1-hline-regexp "^[ \t]*\\+-[-+]"
  3706. "Detect a table-type table hline.")
  3707. (defconst org-table-any-border-regexp "^[ \t]*[^|+ \t]"
  3708. "Detect the first line outside a table when searching from within it.
  3709. This works for both table types.")
  3710. ;; Autoload the functions in org-table.el that are needed by functions here.
  3711. (eval-and-compile
  3712. (org-autoload "org-table"
  3713. '(org-table-begin org-table-blank-field org-table-end)))
  3714. (defconst org-TBLFM-regexp "^[ \t]*#\\+TBLFM: "
  3715. "Detect a #+TBLFM line.")
  3716. ;;;###autoload
  3717. (defun turn-on-orgtbl ()
  3718. "Unconditionally turn on `orgtbl-mode'."
  3719. (require 'org-table)
  3720. (orgtbl-mode 1))
  3721. (defun org-at-table-p (&optional table-type)
  3722. "Return t if the cursor is inside an org-type table.
  3723. If TABLE-TYPE is non-nil, also check for table.el-type tables."
  3724. (if org-enable-table-editor
  3725. (save-excursion
  3726. (beginning-of-line 1)
  3727. (looking-at (if table-type org-table-any-line-regexp
  3728. org-table-line-regexp)))
  3729. nil))
  3730. (defsubst org-table-p () (org-at-table-p))
  3731. (defun org-at-table.el-p ()
  3732. "Return t if and only if we are at a table.el table."
  3733. (and (org-at-table-p 'any)
  3734. (save-excursion
  3735. (goto-char (org-table-begin 'any))
  3736. (looking-at org-table1-hline-regexp))))
  3737. (defun org-table-recognize-table.el ()
  3738. "If there is a table.el table nearby, recognize it and move into it."
  3739. (if org-table-tab-recognizes-table.el
  3740. (if (org-at-table.el-p)
  3741. (progn
  3742. (beginning-of-line 1)
  3743. (if (looking-at org-table-dataline-regexp)
  3744. nil
  3745. (if (looking-at org-table1-hline-regexp)
  3746. (progn
  3747. (beginning-of-line 2)
  3748. (if (looking-at org-table-any-border-regexp)
  3749. (beginning-of-line -1)))))
  3750. (if (re-search-forward "|" (org-table-end t) t)
  3751. (progn
  3752. (require 'table)
  3753. (if (table--at-cell-p (point))
  3754. t
  3755. (message "recognizing table.el table...")
  3756. (table-recognize-table)
  3757. (message "recognizing table.el table...done")))
  3758. (error "This should not happen"))
  3759. t)
  3760. nil)
  3761. nil))
  3762. (defun org-at-table-hline-p ()
  3763. "Return t if the cursor is inside a hline in a table."
  3764. (if org-enable-table-editor
  3765. (save-excursion
  3766. (beginning-of-line 1)
  3767. (looking-at org-table-hline-regexp))
  3768. nil))
  3769. (defun org-table-map-tables (function &optional quietly)
  3770. "Apply FUNCTION to the start of all tables in the buffer."
  3771. (save-excursion
  3772. (save-restriction
  3773. (widen)
  3774. (goto-char (point-min))
  3775. (while (re-search-forward org-table-any-line-regexp nil t)
  3776. (unless quietly
  3777. (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size))))
  3778. (beginning-of-line 1)
  3779. (when (and (looking-at org-table-line-regexp)
  3780. ;; Exclude tables in src/example/verbatim/clocktable blocks
  3781. (not (org-in-block-p '("src" "example" "verbatim" "clocktable"))))
  3782. (save-excursion (funcall function))
  3783. (or (looking-at org-table-line-regexp)
  3784. (forward-char 1)))
  3785. (re-search-forward org-table-any-border-regexp nil 1))))
  3786. (unless quietly (message "Mapping tables: done")))
  3787. ;; Declare and autoload functions from org-agenda.el
  3788. (eval-and-compile
  3789. (org-autoload "org-agenda"
  3790. '(org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
  3791. (declare-function org-clock-save-markers-for-cut-and-paste "org-clock" (beg end))
  3792. (declare-function org-clock-update-mode-line "org-clock" ())
  3793. (declare-function org-resolve-clocks "org-clock"
  3794. (&optional also-non-dangling-p prompt last-valid))
  3795. (defun org-at-TBLFM-p (&optional pos)
  3796. "Return t when point (or POS) is in #+TBLFM line."
  3797. (save-excursion
  3798. (let ((pos pos)))
  3799. (goto-char (or pos (point)))
  3800. (beginning-of-line 1)
  3801. (looking-at org-TBLFM-regexp)))
  3802. (defvar org-clock-start-time)
  3803. (defvar org-clock-marker (make-marker)
  3804. "Marker recording the last clock-in.")
  3805. (defvar org-clock-hd-marker (make-marker)
  3806. "Marker recording the last clock-in, but the headline position.")
  3807. (defvar org-clock-heading ""
  3808. "The heading of the current clock entry.")
  3809. (defun org-clock-is-active ()
  3810. "Return the buffer where the clock is currently running.
  3811. Return nil if no clock is running."
  3812. (marker-buffer org-clock-marker))
  3813. (eval-and-compile
  3814. (org-autoload "org-clock" '(org-clock-remove-overlays
  3815. org-clock-update-time-maybe
  3816. org-clocktable-shift)))
  3817. (defun org-check-running-clock ()
  3818. "Check if the current buffer contains the running clock.
  3819. If yes, offer to stop it and to save the buffer with the changes."
  3820. (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
  3821. (y-or-n-p (format "Clock-out in buffer %s before killing it? "
  3822. (buffer-name))))
  3823. (org-clock-out)
  3824. (when (y-or-n-p "Save changed buffer?")
  3825. (save-buffer))))
  3826. (defun org-clocktable-try-shift (dir n)
  3827. "Check if this line starts a clock table, if yes, shift the time block."
  3828. (when (org-match-line "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>")
  3829. (org-clocktable-shift dir n)))
  3830. ;;;###autoload
  3831. (defun org-clock-persistence-insinuate ()
  3832. "Set up hooks for clock persistence."
  3833. (require 'org-clock)
  3834. (add-hook 'org-mode-hook 'org-clock-load)
  3835. (add-hook 'kill-emacs-hook 'org-clock-save))
  3836. ;; Define the variable already here, to make sure we have it.
  3837. (defvar org-indent-mode nil
  3838. "Non-nil if Org-Indent mode is enabled.
  3839. Use the command `org-indent-mode' to change this variable.")
  3840. ;; Autoload archiving code
  3841. ;; The stuff that is needed for cycling and tags has to be defined here.
  3842. (defgroup org-archive nil
  3843. "Options concerning archiving in Org-mode."
  3844. :tag "Org Archive"
  3845. :group 'org-structure)
  3846. (defcustom org-archive-location "%s_archive::"
  3847. "The location where subtrees should be archived.
  3848. The value of this variable is a string, consisting of two parts,
  3849. separated by a double-colon. The first part is a filename and
  3850. the second part is a headline.
  3851. When the filename is omitted, archiving happens in the same file.
  3852. %s in the filename will be replaced by the current file
  3853. name (without the directory part). Archiving to a different file
  3854. is useful to keep archived entries from contributing to the
  3855. Org-mode Agenda.
  3856. The archived entries will be filed as subtrees of the specified
  3857. headline. When the headline is omitted, the subtrees are simply
  3858. filed away at the end of the file, as top-level entries. Also in
  3859. the heading you can use %s to represent the file name, this can be
  3860. useful when using the same archive for a number of different files.
  3861. Here are a few examples:
  3862. \"%s_archive::\"
  3863. If the current file is Projects.org, archive in file
  3864. Projects.org_archive, as top-level trees. This is the default.
  3865. \"::* Archived Tasks\"
  3866. Archive in the current file, under the top-level headline
  3867. \"* Archived Tasks\".
  3868. \"~/org/archive.org::\"
  3869. Archive in file ~/org/archive.org (absolute path), as top-level trees.
  3870. \"~/org/archive.org::* From %s\"
  3871. Archive in file ~/org/archive.org (absolute path), under headlines
  3872. \"From FILENAME\" where file name is the current file name.
  3873. \"~/org/datetree.org::datetree/* Finished Tasks\"
  3874. The \"datetree/\" string is special, signifying to archive
  3875. items to the datetree. Items are placed in either the CLOSED
  3876. date of the item, or the current date if there is no CLOSED date.
  3877. The heading will be a subentry to the current date. There doesn't
  3878. need to be a heading, but there always needs to be a slash after
  3879. datetree. For example, to store archived items directly in the
  3880. datetree, use \"~/org/datetree.org::datetree/\".
  3881. \"basement::** Finished Tasks\"
  3882. Archive in file ./basement (relative path), as level 3 trees
  3883. below the level 2 heading \"** Finished Tasks\".
  3884. You may set this option on a per-file basis by adding to the buffer a
  3885. line like
  3886. #+ARCHIVE: basement::** Finished Tasks
  3887. You may also define it locally for a subtree by setting an ARCHIVE property
  3888. in the entry. If such a property is found in an entry, or anywhere up
  3889. the hierarchy, it will be used."
  3890. :group 'org-archive
  3891. :type 'string)
  3892. (defcustom org-archive-tag "ARCHIVE"
  3893. "The tag that marks a subtree as archived.
  3894. An archived subtree does not open during visibility cycling, and does
  3895. not contribute to the agenda listings.
  3896. After changing this, font-lock must be restarted in the relevant buffers to
  3897. get the proper fontification."
  3898. :group 'org-archive
  3899. :group 'org-keywords
  3900. :type 'string)
  3901. (defcustom org-agenda-skip-archived-trees t
  3902. "Non-nil means the agenda will skip any items located in archived trees.
  3903. An archived tree is a tree marked with the tag ARCHIVE. The use of this
  3904. variable is no longer recommended, you should leave it at the value t.
  3905. Instead, use the key `v' to cycle the archives-mode in the agenda."
  3906. :group 'org-archive
  3907. :group 'org-agenda-skip
  3908. :type 'boolean)
  3909. (defcustom org-columns-skip-archived-trees t
  3910. "Non-nil means ignore archived trees when creating column view."
  3911. :group 'org-archive
  3912. :group 'org-properties
  3913. :type 'boolean)
  3914. (defcustom org-cycle-open-archived-trees nil
  3915. "Non-nil means `org-cycle' will open archived trees.
  3916. An archived tree is a tree marked with the tag ARCHIVE.
  3917. When nil, archived trees will stay folded. You can still open them with
  3918. normal outline commands like `show-all', but not with the cycling commands."
  3919. :group 'org-archive
  3920. :group 'org-cycle
  3921. :type 'boolean)
  3922. (defcustom org-sparse-tree-open-archived-trees nil
  3923. "Non-nil means sparse tree construction shows matches in archived trees.
  3924. When nil, matches in these trees are highlighted, but the trees are kept in
  3925. collapsed state."
  3926. :group 'org-archive
  3927. :group 'org-sparse-trees
  3928. :type 'boolean)
  3929. (defcustom org-sparse-tree-default-date-type 'scheduled-or-deadline
  3930. "The default date type when building a sparse tree.
  3931. When this is nil, a date is a scheduled or a deadline timestamp.
  3932. Otherwise, these types are allowed:
  3933. all: all timestamps
  3934. active: only active timestamps (<...>)
  3935. inactive: only inactive timestamps (<...)
  3936. scheduled: only scheduled timestamps
  3937. deadline: only deadline timestamps"
  3938. :type '(choice (const :tag "Scheduled or deadline" scheduled-or-deadline)
  3939. (const :tag "All timestamps" all)
  3940. (const :tag "Only active timestamps" active)
  3941. (const :tag "Only inactive timestamps" inactive)
  3942. (const :tag "Only scheduled timestamps" scheduled)
  3943. (const :tag "Only deadline timestamps" deadline)
  3944. (const :tag "Only closed timestamps" closed))
  3945. :version "24.3"
  3946. :group 'org-sparse-trees)
  3947. (defun org-cycle-hide-archived-subtrees (state)
  3948. "Re-hide all archived subtrees after a visibility state change."
  3949. (when (and (not org-cycle-open-archived-trees)
  3950. (not (memq state '(overview folded))))
  3951. (save-excursion
  3952. (let* ((globalp (memq state '(contents all)))
  3953. (beg (if globalp (point-min) (point)))
  3954. (end (if globalp (point-max) (org-end-of-subtree t))))
  3955. (org-hide-archived-subtrees beg end)
  3956. (goto-char beg)
  3957. (if (looking-at (concat ".*:" org-archive-tag ":"))
  3958. (message "%s" (substitute-command-keys
  3959. "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
  3960. (defun org-force-cycle-archived ()
  3961. "Cycle subtree even if it is archived."
  3962. (interactive)
  3963. (setq this-command 'org-cycle)
  3964. (let ((org-cycle-open-archived-trees t))
  3965. (call-interactively 'org-cycle)))
  3966. (defun org-hide-archived-subtrees (beg end)
  3967. "Re-hide all archived subtrees after a visibility state change."
  3968. (save-excursion
  3969. (let* ((re (concat ":" org-archive-tag ":")))
  3970. (goto-char beg)
  3971. (while (re-search-forward re end t)
  3972. (when (org-at-heading-p)
  3973. (org-flag-subtree t)
  3974. (org-end-of-subtree t))))))
  3975. (declare-function outline-end-of-heading "outline" ())
  3976. (declare-function outline-flag-region "outline" (from to flag))
  3977. (defun org-flag-subtree (flag)
  3978. (save-excursion
  3979. (org-back-to-heading t)
  3980. (outline-end-of-heading)
  3981. (outline-flag-region (point)
  3982. (progn (org-end-of-subtree t) (point))
  3983. flag)))
  3984. (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
  3985. (eval-and-compile
  3986. (org-autoload "org-archive"
  3987. '(org-add-archive-files)))
  3988. ;; Autoload Column View Code
  3989. (declare-function org-columns-number-to-string "org-colview" (n fmt &optional printf))
  3990. (declare-function org-columns-get-format-and-top-level "org-colview" ())
  3991. (declare-function org-columns-compute "org-colview" (property))
  3992. (org-autoload (if (featurep 'xemacs) "org-colview-xemacs" "org-colview")
  3993. '(org-columns-number-to-string
  3994. org-columns-get-format-and-top-level
  3995. org-columns-compute
  3996. org-columns-remove-overlays))
  3997. ;; Autoload ID code
  3998. (declare-function org-id-store-link "org-id")
  3999. (declare-function org-id-locations-load "org-id")
  4000. (declare-function org-id-locations-save "org-id")
  4001. (defvar org-id-track-globally)
  4002. (org-autoload "org-id"
  4003. '(org-id-new
  4004. org-id-copy
  4005. org-id-get-with-outline-path-completion
  4006. org-id-get-with-outline-drilling))
  4007. ;;; Variables for pre-computed regular expressions, all buffer local
  4008. (defvar org-drawer-regexp "^[ \t]*:PROPERTIES:[ \t]*$"
  4009. "Matches first line of a hidden block.")
  4010. (make-variable-buffer-local 'org-drawer-regexp)
  4011. (defvar org-todo-regexp nil
  4012. "Matches any of the TODO state keywords.")
  4013. (make-variable-buffer-local 'org-todo-regexp)
  4014. (defvar org-not-done-regexp nil
  4015. "Matches any of the TODO state keywords except the last one.")
  4016. (make-variable-buffer-local 'org-not-done-regexp)
  4017. (defvar org-not-done-heading-regexp nil
  4018. "Matches a TODO headline that is not done.")
  4019. (make-variable-buffer-local 'org-not-done-regexp)
  4020. (defvar org-todo-line-regexp nil
  4021. "Matches a headline and puts TODO state into group 2 if present.")
  4022. (make-variable-buffer-local 'org-todo-line-regexp)
  4023. (defvar org-complex-heading-regexp nil
  4024. "Matches a headline and puts everything into groups:
  4025. group 1: the stars
  4026. group 2: The todo keyword, maybe
  4027. group 3: Priority cookie
  4028. group 4: True headline
  4029. group 5: Tags")
  4030. (make-variable-buffer-local 'org-complex-heading-regexp)
  4031. (defvar org-complex-heading-regexp-format nil
  4032. "Printf format to make regexp to match an exact headline.
  4033. This regexp will match the headline of any node which has the
  4034. exact headline text that is put into the format, but may have any
  4035. TODO state, priority and tags.")
  4036. (make-variable-buffer-local 'org-complex-heading-regexp-format)
  4037. (defvar org-todo-line-tags-regexp nil
  4038. "Matches a headline and puts TODO state into group 2 if present.
  4039. Also put tags into group 4 if tags are present.")
  4040. (make-variable-buffer-local 'org-todo-line-tags-regexp)
  4041. (defvar org-ds-keyword-length 12
  4042. "Maximum length of the DEADLINE and SCHEDULED keywords.")
  4043. (make-variable-buffer-local 'org-ds-keyword-length)
  4044. (defvar org-deadline-regexp nil
  4045. "Matches the DEADLINE keyword.")
  4046. (make-variable-buffer-local 'org-deadline-regexp)
  4047. (defvar org-deadline-time-regexp nil
  4048. "Matches the DEADLINE keyword together with a time stamp.")
  4049. (make-variable-buffer-local 'org-deadline-time-regexp)
  4050. (defvar org-deadline-time-hour-regexp nil
  4051. "Matches the DEADLINE keyword together with a time-and-hour stamp.")
  4052. (make-variable-buffer-local 'org-deadline-time-hour-regexp)
  4053. (defvar org-deadline-line-regexp nil
  4054. "Matches the DEADLINE keyword and the rest of the line.")
  4055. (make-variable-buffer-local 'org-deadline-line-regexp)
  4056. (defvar org-scheduled-regexp nil
  4057. "Matches the SCHEDULED keyword.")
  4058. (make-variable-buffer-local 'org-scheduled-regexp)
  4059. (defvar org-scheduled-time-regexp nil
  4060. "Matches the SCHEDULED keyword together with a time stamp.")
  4061. (make-variable-buffer-local 'org-scheduled-time-regexp)
  4062. (defvar org-scheduled-time-hour-regexp nil
  4063. "Matches the SCHEDULED keyword together with a time-and-hour stamp.")
  4064. (make-variable-buffer-local 'org-scheduled-time-hour-regexp)
  4065. (defvar org-closed-time-regexp nil
  4066. "Matches the CLOSED keyword together with a time stamp.")
  4067. (make-variable-buffer-local 'org-closed-time-regexp)
  4068. (defvar org-keyword-time-regexp nil
  4069. "Matches any of the 4 keywords, together with the time stamp.")
  4070. (make-variable-buffer-local 'org-keyword-time-regexp)
  4071. (defvar org-keyword-time-not-clock-regexp nil
  4072. "Matches any of the 3 keywords, together with the time stamp.")
  4073. (make-variable-buffer-local 'org-keyword-time-not-clock-regexp)
  4074. (defvar org-maybe-keyword-time-regexp nil
  4075. "Matches a timestamp, possibly preceded by a keyword.")
  4076. (make-variable-buffer-local 'org-maybe-keyword-time-regexp)
  4077. (defvar org-all-time-keywords nil
  4078. "List of time keywords.")
  4079. (make-variable-buffer-local 'org-all-time-keywords)
  4080. (defconst org-plain-time-of-day-regexp
  4081. (concat
  4082. "\\(\\<[012]?[0-9]"
  4083. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  4084. "\\(--?"
  4085. "\\(\\<[012]?[0-9]"
  4086. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  4087. "\\)?")
  4088. "Regular expression to match a plain time or time range.
  4089. Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
  4090. groups carry important information:
  4091. 0 the full match
  4092. 1 the first time, range or not
  4093. 8 the second time, if it is a range.")
  4094. (defconst org-plain-time-extension-regexp
  4095. (concat
  4096. "\\(\\<[012]?[0-9]"
  4097. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  4098. "\\+\\([0-9]+\\)\\(:\\([0-5][0-9]\\)\\)?")
  4099. "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
  4100. Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
  4101. groups carry important information:
  4102. 0 the full match
  4103. 7 hours of duration
  4104. 9 minutes of duration")
  4105. (defconst org-stamp-time-of-day-regexp
  4106. (concat
  4107. "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} +\\sw+ +\\)"
  4108. "\\([012][0-9]:[0-5][0-9]\\(-\\([012][0-9]:[0-5][0-9]\\)\\)?[^\n\r>]*?\\)>"
  4109. "\\(--?"
  4110. "<\\1\\([012][0-9]:[0-5][0-9]\\)>\\)?")
  4111. "Regular expression to match a timestamp time or time range.
  4112. After a match, the following groups carry important information:
  4113. 0 the full match
  4114. 1 date plus weekday, for back referencing to make sure both times are on the same day
  4115. 2 the first time, range or not
  4116. 4 the second time, if it is a range.")
  4117. (defconst org-startup-options
  4118. '(("fold" org-startup-folded t)
  4119. ("overview" org-startup-folded t)
  4120. ("nofold" org-startup-folded nil)
  4121. ("showall" org-startup-folded nil)
  4122. ("showeverything" org-startup-folded showeverything)
  4123. ("content" org-startup-folded content)
  4124. ("indent" org-startup-indented t)
  4125. ("noindent" org-startup-indented nil)
  4126. ("hidestars" org-hide-leading-stars t)
  4127. ("showstars" org-hide-leading-stars nil)
  4128. ("odd" org-odd-levels-only t)
  4129. ("oddeven" org-odd-levels-only nil)
  4130. ("align" org-startup-align-all-tables t)
  4131. ("noalign" org-startup-align-all-tables nil)
  4132. ("inlineimages" org-startup-with-inline-images t)
  4133. ("noinlineimages" org-startup-with-inline-images nil)
  4134. ("latexpreview" org-startup-with-latex-preview t)
  4135. ("nolatexpreview" org-startup-with-latex-preview nil)
  4136. ("customtime" org-display-custom-times t)
  4137. ("logdone" org-log-done time)
  4138. ("lognotedone" org-log-done note)
  4139. ("nologdone" org-log-done nil)
  4140. ("lognoteclock-out" org-log-note-clock-out t)
  4141. ("nolognoteclock-out" org-log-note-clock-out nil)
  4142. ("logrepeat" org-log-repeat state)
  4143. ("lognoterepeat" org-log-repeat note)
  4144. ("logdrawer" org-log-into-drawer t)
  4145. ("nologdrawer" org-log-into-drawer nil)
  4146. ("logstatesreversed" org-log-states-order-reversed t)
  4147. ("nologstatesreversed" org-log-states-order-reversed nil)
  4148. ("nologrepeat" org-log-repeat nil)
  4149. ("logreschedule" org-log-reschedule time)
  4150. ("lognotereschedule" org-log-reschedule note)
  4151. ("nologreschedule" org-log-reschedule nil)
  4152. ("logredeadline" org-log-redeadline time)
  4153. ("lognoteredeadline" org-log-redeadline note)
  4154. ("nologredeadline" org-log-redeadline nil)
  4155. ("logrefile" org-log-refile time)
  4156. ("lognoterefile" org-log-refile note)
  4157. ("nologrefile" org-log-refile nil)
  4158. ("fninline" org-footnote-define-inline t)
  4159. ("nofninline" org-footnote-define-inline nil)
  4160. ("fnlocal" org-footnote-section nil)
  4161. ("fnauto" org-footnote-auto-label t)
  4162. ("fnprompt" org-footnote-auto-label nil)
  4163. ("fnconfirm" org-footnote-auto-label confirm)
  4164. ("fnplain" org-footnote-auto-label plain)
  4165. ("fnadjust" org-footnote-auto-adjust t)
  4166. ("nofnadjust" org-footnote-auto-adjust nil)
  4167. ("constcgs" constants-unit-system cgs)
  4168. ("constSI" constants-unit-system SI)
  4169. ("noptag" org-tag-persistent-alist nil)
  4170. ("hideblocks" org-hide-block-startup t)
  4171. ("nohideblocks" org-hide-block-startup nil)
  4172. ("beamer" org-startup-with-beamer-mode t)
  4173. ("entitiespretty" org-pretty-entities t)
  4174. ("entitiesplain" org-pretty-entities nil))
  4175. "Variable associated with STARTUP options for org-mode.
  4176. Each element is a list of three items: the startup options (as written
  4177. in the #+STARTUP line), the corresponding variable, and the value to set
  4178. this variable to if the option is found. An optional forth element PUSH
  4179. means to push this value onto the list in the variable.")
  4180. (defun org-update-property-plist (key val props)
  4181. "Update PROPS with KEY and VAL."
  4182. (let* ((appending (string= "+" (substring key (- (length key) 1))))
  4183. (key (if appending (substring key 0 (- (length key) 1)) key))
  4184. (remainder (org-remove-if (lambda (p) (string= (car p) key)) props))
  4185. (previous (cdr (assoc key props))))
  4186. (if appending
  4187. (cons (cons key (if previous (concat previous " " val) val)) remainder)
  4188. (cons (cons key val) remainder))))
  4189. (defconst org-block-regexp
  4190. "^[ \t]*#\\+begin_?\\([^ \n]+\\)\\(\\([^\n]+\\)\\)?\n\\([^\000]+?\\)#\\+end_?\\1[ \t]*$"
  4191. "Regular expression for hiding blocks.")
  4192. (defconst org-heading-keyword-regexp-format
  4193. "^\\(\\*+\\)\\(?: +%s\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
  4194. "Printf format for a regexp matching a headline with some keyword.
  4195. This regexp will match the headline of any node which has the
  4196. exact keyword that is put into the format. The keyword isn't in
  4197. any group by default, but the stars and the body are.")
  4198. (defconst org-heading-keyword-maybe-regexp-format
  4199. "^\\(\\*+\\)\\(?: +%s\\)?\\(?: +\\(.*?\\)\\)?[ \t]*$"
  4200. "Printf format for a regexp matching a headline, possibly with some keyword.
  4201. This regexp can match any headline with the specified keyword, or
  4202. without a keyword. The keyword isn't in any group by default,
  4203. but the stars and the body are.")
  4204. (defcustom org-group-tags t
  4205. "When non-nil (the default), use group tags.
  4206. This can be turned on/off through `org-toggle-tags-groups'."
  4207. :group 'org-tags
  4208. :group 'org-startup
  4209. :type 'boolean)
  4210. (defun org-toggle-tags-groups ()
  4211. "Toggle support for group tags.
  4212. Support for group tags is controlled by the option
  4213. `org-group-tags', which is non-nil by default."
  4214. (interactive)
  4215. (setq org-group-tags (not org-group-tags))
  4216. (cond ((and (derived-mode-p 'org-agenda-mode)
  4217. org-group-tags)
  4218. (org-agenda-redo))
  4219. ((derived-mode-p 'org-mode)
  4220. (let ((org-inhibit-startup t)) (org-mode))))
  4221. (message "Groups tags support has been turned %s"
  4222. (if org-group-tags "on" "off")))
  4223. (defun org-set-regexps-and-options-for-tags ()
  4224. "Precompute variables used for tags."
  4225. (when (derived-mode-p 'org-mode)
  4226. (org-set-local 'org-file-tags nil)
  4227. (let ((re (org-make-options-regexp '("FILETAGS" "TAGS")))
  4228. (splitre "[ \t]+")
  4229. (start 0)
  4230. tags ftags key value)
  4231. (save-excursion
  4232. (save-restriction
  4233. (widen)
  4234. (goto-char (point-min))
  4235. (while (re-search-forward re nil t)
  4236. (setq key (upcase (org-match-string-no-properties 1))
  4237. value (org-match-string-no-properties 2))
  4238. (if (stringp value) (setq value (org-trim value)))
  4239. (cond
  4240. ((equal key "TAGS")
  4241. (setq tags (append tags (if tags '("\\n") nil)
  4242. (org-split-string value splitre))))
  4243. ((equal key "FILETAGS")
  4244. (when (string-match "\\S-" value)
  4245. (setq ftags
  4246. (append
  4247. ftags
  4248. (apply 'append
  4249. (mapcar (lambda (x) (org-split-string x ":"))
  4250. (org-split-string value)))))))))))
  4251. ;; Process the file tags.
  4252. (and ftags (org-set-local 'org-file-tags
  4253. (mapcar 'org-add-prop-inherited ftags)))
  4254. (org-set-local 'org-tag-groups-alist nil)
  4255. ;; Process the tags.
  4256. (when (and (not tags) org-tag-alist)
  4257. (setq tags
  4258. (mapcar
  4259. (lambda (tg) (cond ((eq (car tg) :startgroup) "{")
  4260. ((eq (car tg) :endgroup) "}")
  4261. ((eq (car tg) :grouptags) ":")
  4262. ((eq (car tg) :newline) "\n")
  4263. (t (concat (car tg)
  4264. (if (characterp (cdr tg))
  4265. (format "(%s)" (char-to-string (cdr tg))) "")))))
  4266. org-tag-alist)))
  4267. (let (e tgs g)
  4268. (while (setq e (pop tags))
  4269. (cond
  4270. ((equal e "{")
  4271. (progn (push '(:startgroup) tgs)
  4272. (when (equal (nth 1 tags) ":")
  4273. (push (list (replace-regexp-in-string
  4274. "(.+)$" "" (nth 0 tags)))
  4275. org-tag-groups-alist)
  4276. (setq g 0))))
  4277. ((equal e ":") (push '(:grouptags) tgs))
  4278. ((equal e "}") (push '(:endgroup) tgs) (if g (setq g nil)))
  4279. ((equal e "\\n") (push '(:newline) tgs))
  4280. ((string-match (org-re "^\\([[:alnum:]_@#%]+\\)(\\(.\\))$") e)
  4281. (push (cons (match-string 1 e)
  4282. (string-to-char (match-string 2 e))) tgs)
  4283. (if (and g (> g 0))
  4284. (setcar org-tag-groups-alist
  4285. (append (car org-tag-groups-alist)
  4286. (list (match-string 1 e)))))
  4287. (if g (setq g (1+ g))))
  4288. (t (push (list e) tgs)
  4289. (if (and g (> g 0))
  4290. (setcar org-tag-groups-alist
  4291. (append (car org-tag-groups-alist) (list e))))
  4292. (if g (setq g (1+ g))))))
  4293. (org-set-local 'org-tag-alist nil)
  4294. (while (setq e (pop tgs))
  4295. (or (and (stringp (car e))
  4296. (assoc (car e) org-tag-alist))
  4297. (push e org-tag-alist)))
  4298. ;; Return a list with tag variables
  4299. (list org-file-tags org-tag-alist org-tag-groups-alist)))))
  4300. (defvar org-ota nil)
  4301. (defun org-set-regexps-and-options ()
  4302. "Precompute regular expressions used in the current buffer."
  4303. (when (derived-mode-p 'org-mode)
  4304. (org-set-local 'org-todo-kwd-alist nil)
  4305. (org-set-local 'org-todo-key-alist nil)
  4306. (org-set-local 'org-todo-key-trigger nil)
  4307. (org-set-local 'org-todo-keywords-1 nil)
  4308. (org-set-local 'org-done-keywords nil)
  4309. (org-set-local 'org-todo-heads nil)
  4310. (org-set-local 'org-todo-sets nil)
  4311. (org-set-local 'org-todo-log-states nil)
  4312. (org-set-local 'org-file-properties nil)
  4313. (let ((re (org-make-options-regexp
  4314. '("CATEGORY" "TODO" "COLUMNS" "STARTUP" "ARCHIVE"
  4315. "LINK" "PRIORITIES" "CONSTANTS" "PROPERTY" "DRAWERS"
  4316. "SETUPFILE" "OPTIONS")
  4317. "\\(?:[a-zA-Z][0-9a-zA-Z_]*_TODO\\)"))
  4318. (splitre "[ \t]+")
  4319. (scripts org-use-sub-superscripts)
  4320. kwds kws0 kwsa key log value cat arch const links hw dws
  4321. tail sep kws1 prio props drawers ext-setup-or-nil setup-contents
  4322. (start 0))
  4323. (save-excursion
  4324. (save-restriction
  4325. (widen)
  4326. (goto-char (point-min))
  4327. (while
  4328. (or (and
  4329. ext-setup-or-nil
  4330. (not org-ota)
  4331. (let (ret)
  4332. (with-temp-buffer
  4333. (insert ext-setup-or-nil)
  4334. (let ((major-mode 'org-mode) org-ota)
  4335. (setq ret (save-match-data
  4336. (org-set-regexps-and-options-for-tags)))))
  4337. ;; Append setupfile tags to existing tags
  4338. (setq org-ota t)
  4339. (setq org-file-tags
  4340. (delq nil (append org-file-tags (nth 0 ret)))
  4341. org-tag-alist
  4342. (delq nil (append org-tag-alist (nth 1 ret)))
  4343. org-tag-groups-alist
  4344. (delq nil (append org-tag-groups-alist (nth 2 ret))))))
  4345. (and ext-setup-or-nil
  4346. (string-match re ext-setup-or-nil start)
  4347. (setq start (match-end 0)))
  4348. (and (setq ext-setup-or-nil nil start 0)
  4349. (re-search-forward re nil t)))
  4350. (setq key (upcase (match-string 1 ext-setup-or-nil))
  4351. value (org-match-string-no-properties 2 ext-setup-or-nil))
  4352. (if (stringp value) (setq value (org-trim value)))
  4353. (cond
  4354. ((equal key "CATEGORY")
  4355. (setq cat value))
  4356. ((member key '("SEQ_TODO" "TODO"))
  4357. (push (cons 'sequence (org-split-string value splitre)) kwds))
  4358. ((equal key "TYP_TODO")
  4359. (push (cons 'type (org-split-string value splitre)) kwds))
  4360. ((string-match "\\`\\([a-zA-Z][0-9a-zA-Z_]*\\)_TODO\\'" key)
  4361. ;; general TODO-like setup
  4362. (push (cons (intern (downcase (match-string 1 key)))
  4363. (org-split-string value splitre)) kwds))
  4364. ((equal key "COLUMNS")
  4365. (org-set-local 'org-columns-default-format value))
  4366. ((equal key "LINK")
  4367. (when (string-match "^\\(\\S-+\\)[ \t]+\\(.+\\)" value)
  4368. (push (cons (match-string 1 value)
  4369. (org-trim (match-string 2 value)))
  4370. links)))
  4371. ((equal key "PRIORITIES")
  4372. (setq prio (org-split-string value " +")))
  4373. ((equal key "PROPERTY")
  4374. (when (string-match "\\(\\S-+\\)\\s-+\\(.*\\)" value)
  4375. (setq props (org-update-property-plist (match-string 1 value)
  4376. (match-string 2 value)
  4377. props))))
  4378. ((equal key "DRAWERS")
  4379. (setq drawers (delete-dups (append org-drawers (org-split-string value splitre)))))
  4380. ((equal key "CONSTANTS")
  4381. (org-table-set-constants))
  4382. ((equal key "STARTUP")
  4383. (let ((opts (org-split-string value splitre))
  4384. l var val)
  4385. (while (setq l (pop opts))
  4386. (when (setq l (assoc l org-startup-options))
  4387. (setq var (nth 1 l) val (nth 2 l))
  4388. (if (not (nth 3 l))
  4389. (set (make-local-variable var) val)
  4390. (if (not (listp (symbol-value var)))
  4391. (set (make-local-variable var) nil))
  4392. (set (make-local-variable var) (symbol-value var))
  4393. (add-to-list var val))))))
  4394. ((equal key "ARCHIVE")
  4395. (setq arch value)
  4396. (remove-text-properties 0 (length arch)
  4397. '(face t fontified t) arch))
  4398. ((equal key "OPTIONS")
  4399. (if (string-match "\\([ \t]\\|\\`\\)\\^:\\(t\\|nil\\|{}\\)" value)
  4400. (setq scripts (read (match-string 2 value)))))
  4401. ((and (equal key "SETUPFILE")
  4402. ;; Prevent checking in Gnus messages
  4403. (not buffer-read-only))
  4404. (setq setup-contents (org-file-contents
  4405. (expand-file-name
  4406. (org-remove-double-quotes value))
  4407. 'noerror))
  4408. (if (not ext-setup-or-nil)
  4409. (setq ext-setup-or-nil setup-contents start 0)
  4410. (setq ext-setup-or-nil
  4411. (concat (substring ext-setup-or-nil 0 start)
  4412. "\n" setup-contents "\n"
  4413. (substring ext-setup-or-nil start)))))))
  4414. ;; search for property blocks
  4415. (goto-char (point-min))
  4416. (while (re-search-forward org-block-regexp nil t)
  4417. (when (equal "PROPERTY" (upcase (match-string 1)))
  4418. (setq value (replace-regexp-in-string
  4419. "[\n\r]" " " (match-string 4)))
  4420. (when (string-match "\\(\\S-+\\)\\s-+\\(.*\\)" value)
  4421. (setq props (org-update-property-plist (match-string 1 value)
  4422. (match-string 2 value)
  4423. props)))))))
  4424. (org-set-local 'org-use-sub-superscripts scripts)
  4425. (when cat
  4426. (org-set-local 'org-category (intern cat))
  4427. (push (cons "CATEGORY" cat) props))
  4428. (when prio
  4429. (if (< (length prio) 3) (setq prio '("A" "C" "B")))
  4430. (setq prio (mapcar 'string-to-char prio))
  4431. (org-set-local 'org-highest-priority (nth 0 prio))
  4432. (org-set-local 'org-lowest-priority (nth 1 prio))
  4433. (org-set-local 'org-default-priority (nth 2 prio)))
  4434. (and props (org-set-local 'org-file-properties (nreverse props)))
  4435. (and drawers (org-set-local 'org-drawers drawers))
  4436. (and arch (org-set-local 'org-archive-location arch))
  4437. (and links (setq org-link-abbrev-alist-local (nreverse links)))
  4438. ;; Process the TODO keywords
  4439. (unless kwds
  4440. ;; Use the global values as if they had been given locally.
  4441. (setq kwds (default-value 'org-todo-keywords))
  4442. (if (stringp (car kwds))
  4443. (setq kwds (list (cons org-todo-interpretation
  4444. (default-value 'org-todo-keywords)))))
  4445. (setq kwds (reverse kwds)))
  4446. (setq kwds (nreverse kwds))
  4447. (let (inter kws kw)
  4448. (while (setq kws (pop kwds))
  4449. (let ((kws (or
  4450. (run-hook-with-args-until-success
  4451. 'org-todo-setup-filter-hook kws)
  4452. kws)))
  4453. (setq inter (pop kws) sep (member "|" kws)
  4454. kws0 (delete "|" (copy-sequence kws))
  4455. kwsa nil
  4456. kws1 (mapcar
  4457. (lambda (x)
  4458. ;; 1 2
  4459. (if (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?.*?)\\)?$" x)
  4460. (progn
  4461. (setq kw (match-string 1 x)
  4462. key (and (match-end 2) (match-string 2 x))
  4463. log (org-extract-log-state-settings x))
  4464. (push (cons kw (and key (string-to-char key))) kwsa)
  4465. (and log (push log org-todo-log-states))
  4466. kw)
  4467. (error "Invalid TODO keyword %s" x)))
  4468. kws0)
  4469. kwsa (if kwsa (append '((:startgroup))
  4470. (nreverse kwsa)
  4471. '((:endgroup))))
  4472. hw (car kws1)
  4473. dws (if sep (org-remove-keyword-keys (cdr sep)) (last kws1))
  4474. tail (list inter hw (car dws) (org-last dws))))
  4475. (add-to-list 'org-todo-heads hw 'append)
  4476. (push kws1 org-todo-sets)
  4477. (setq org-done-keywords (append org-done-keywords dws nil))
  4478. (setq org-todo-key-alist (append org-todo-key-alist kwsa))
  4479. (mapc (lambda (x) (push (cons x tail) org-todo-kwd-alist)) kws1)
  4480. (setq org-todo-keywords-1 (append org-todo-keywords-1 kws1 nil)))
  4481. (setq org-todo-sets (nreverse org-todo-sets)
  4482. org-todo-kwd-alist (nreverse org-todo-kwd-alist)
  4483. org-todo-key-trigger (delq nil (mapcar 'cdr org-todo-key-alist))
  4484. org-todo-key-alist (org-assign-fast-keys org-todo-key-alist)))
  4485. ;; Compute the regular expressions and other local variables.
  4486. ;; Using `org-outline-regexp-bol' would complicate them much,
  4487. ;; because of the fixed white space at the end of that string.
  4488. (if (not org-done-keywords)
  4489. (setq org-done-keywords (and org-todo-keywords-1
  4490. (list (org-last org-todo-keywords-1)))))
  4491. (setq org-ds-keyword-length (+ 2 (max (length org-deadline-string)
  4492. (length org-scheduled-string)
  4493. (length org-clock-string)
  4494. (length org-closed-string)))
  4495. org-drawer-regexp
  4496. (concat "^[ \t]*:\\("
  4497. (mapconcat 'regexp-quote org-drawers "\\|")
  4498. "\\):[ \t]*$")
  4499. org-not-done-keywords
  4500. (org-delete-all org-done-keywords (copy-sequence org-todo-keywords-1))
  4501. org-todo-regexp
  4502. (concat "\\("
  4503. (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
  4504. "\\)")
  4505. org-not-done-regexp
  4506. (concat "\\("
  4507. (mapconcat 'regexp-quote org-not-done-keywords "\\|")
  4508. "\\)")
  4509. org-not-done-heading-regexp
  4510. (format org-heading-keyword-regexp-format org-not-done-regexp)
  4511. org-todo-line-regexp
  4512. (format org-heading-keyword-maybe-regexp-format org-todo-regexp)
  4513. org-complex-heading-regexp
  4514. (concat "^\\(\\*+\\)"
  4515. "\\(?: +" org-todo-regexp "\\)?"
  4516. "\\(?: +\\(\\[#.\\]\\)\\)?"
  4517. "\\(?: +\\(.*?\\)\\)??"
  4518. (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)?")
  4519. "[ \t]*$")
  4520. org-complex-heading-regexp-format
  4521. (concat "^\\(\\*+\\)"
  4522. "\\(?: +" org-todo-regexp "\\)?"
  4523. "\\(?: +\\(\\[#.\\]\\)\\)?"
  4524. "\\(?: +"
  4525. ;; Stats cookies can be stuck to body.
  4526. "\\(?:\\[[0-9%%/]+\\] *\\)?"
  4527. "\\(%s\\)"
  4528. "\\(?: *\\[[0-9%%/]+\\]\\)?"
  4529. "\\)"
  4530. (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%%:]+:\\)\\)?")
  4531. "[ \t]*$")
  4532. org-todo-line-tags-regexp
  4533. (concat "^\\(\\*+\\)"
  4534. "\\(?: +" org-todo-regexp "\\)?"
  4535. "\\(?: +\\(.*?\\)\\)??"
  4536. (org-re "\\(?:[ \t]+\\(:[[:alnum:]:_@#%]+:\\)\\)?")
  4537. "[ \t]*$")
  4538. org-deadline-regexp (concat "\\<" org-deadline-string)
  4539. org-deadline-time-regexp
  4540. (concat "\\<" org-deadline-string " *<\\([^>]+\\)>")
  4541. org-deadline-time-hour-regexp
  4542. (concat "\\<" org-deadline-string
  4543. " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
  4544. org-deadline-line-regexp
  4545. (concat "\\<\\(" org-deadline-string "\\).*")
  4546. org-scheduled-regexp
  4547. (concat "\\<" org-scheduled-string)
  4548. org-scheduled-time-regexp
  4549. (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>")
  4550. org-scheduled-time-hour-regexp
  4551. (concat "\\<" org-scheduled-string
  4552. " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
  4553. org-closed-time-regexp
  4554. (concat "\\<" org-closed-string " *\\[\\([^]]+\\)\\]")
  4555. org-keyword-time-regexp
  4556. (concat "\\<\\(" org-scheduled-string
  4557. "\\|" org-deadline-string
  4558. "\\|" org-closed-string
  4559. "\\|" org-clock-string "\\)"
  4560. " *[[<]\\([^]>]+\\)[]>]")
  4561. org-keyword-time-not-clock-regexp
  4562. (concat "\\<\\(" org-scheduled-string
  4563. "\\|" org-deadline-string
  4564. "\\|" org-closed-string
  4565. "\\)"
  4566. " *[[<]\\([^]>]+\\)[]>]")
  4567. org-maybe-keyword-time-regexp
  4568. (concat "\\(\\<\\(" org-scheduled-string
  4569. "\\|" org-deadline-string
  4570. "\\|" org-closed-string
  4571. "\\|" org-clock-string "\\)\\)?"
  4572. " *\\([[<][0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?[]>]\\|<%%([^\r\n>]*>\\)")
  4573. org-all-time-keywords
  4574. (mapcar (lambda (w) (substring w 0 -1))
  4575. (list org-scheduled-string org-deadline-string
  4576. org-clock-string org-closed-string)))
  4577. (setq org-ota nil)
  4578. (org-compute-latex-and-related-regexp))))
  4579. (defun org-file-contents (file &optional noerror)
  4580. "Return the contents of FILE, as a string."
  4581. (if (or (not file)
  4582. (not (file-readable-p file)))
  4583. (if noerror
  4584. (message "Cannot read file \"%s\"" file)
  4585. (error "Cannot read file \"%s\"" file))
  4586. (with-temp-buffer
  4587. (insert-file-contents file)
  4588. (buffer-string))))
  4589. (defun org-extract-log-state-settings (x)
  4590. "Extract the log state setting from a TODO keyword string.
  4591. This will extract info from a string like \"WAIT(w@/!)\"."
  4592. (let (kw key log1 log2)
  4593. (when (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?\\([!@]\\)?\\(?:/\\([!@]\\)\\)?)\\)?$" x)
  4594. (setq kw (match-string 1 x)
  4595. key (and (match-end 2) (match-string 2 x))
  4596. log1 (and (match-end 3) (match-string 3 x))
  4597. log2 (and (match-end 4) (match-string 4 x)))
  4598. (and (or log1 log2)
  4599. (list kw
  4600. (and log1 (if (equal log1 "!") 'time 'note))
  4601. (and log2 (if (equal log2 "!") 'time 'note)))))))
  4602. (defun org-remove-keyword-keys (list)
  4603. "Remove a pair of parenthesis at the end of each string in LIST."
  4604. (mapcar (lambda (x)
  4605. (if (string-match "(.*)$" x)
  4606. (substring x 0 (match-beginning 0))
  4607. x))
  4608. list))
  4609. (defun org-assign-fast-keys (alist)
  4610. "Assign fast keys to a keyword-key alist.
  4611. Respect keys that are already there."
  4612. (let (new e (alt ?0))
  4613. (while (setq e (pop alist))
  4614. (if (or (memq (car e) '(:newline :grouptags :endgroup :startgroup))
  4615. (cdr e)) ;; Key already assigned.
  4616. (push e new)
  4617. (let ((clist (string-to-list (downcase (car e))))
  4618. (used (append new alist)))
  4619. (when (= (car clist) ?@)
  4620. (pop clist))
  4621. (while (and clist (rassoc (car clist) used))
  4622. (pop clist))
  4623. (unless clist
  4624. (while (rassoc alt used)
  4625. (incf alt)))
  4626. (push (cons (car e) (or (car clist) alt)) new))))
  4627. (nreverse new)))
  4628. ;;; Some variables used in various places
  4629. (defvar org-window-configuration nil
  4630. "Used in various places to store a window configuration.")
  4631. (defvar org-selected-window nil
  4632. "Used in various places to store a window configuration.")
  4633. (defvar org-finish-function nil
  4634. "Function to be called when `C-c C-c' is used.
  4635. This is for getting out of special buffers like capture.")
  4636. ;; FIXME: Occasionally check by commenting these, to make sure
  4637. ;; no other functions uses these, forgetting to let-bind them.
  4638. (org-no-warnings (defvar entry)) ;; unprefixed, from calendar.el
  4639. (defvar org-last-state)
  4640. (org-no-warnings (defvar date)) ;; unprefixed, from calendar.el
  4641. ;; Defined somewhere in this file, but used before definition.
  4642. (defvar org-entities) ;; defined in org-entities.el
  4643. (defvar org-struct-menu)
  4644. (defvar org-org-menu)
  4645. (defvar org-tbl-menu)
  4646. ;;;; Define the Org-mode
  4647. ;; We use a before-change function to check if a table might need
  4648. ;; an update.
  4649. (defvar org-table-may-need-update t
  4650. "Indicates that a table might need an update.
  4651. This variable is set by `org-before-change-function'.
  4652. `org-table-align' sets it back to nil.")
  4653. (defun org-before-change-function (beg end)
  4654. "Every change indicates that a table might need an update."
  4655. (setq org-table-may-need-update t))
  4656. (defvar org-mode-map)
  4657. (defvar org-inhibit-startup nil) ; Dynamically-scoped param.
  4658. (defvar org-inhibit-startup-visibility-stuff nil) ; Dynamically-scoped param.
  4659. (defvar org-agenda-keep-modes nil) ; Dynamically-scoped param.
  4660. (defvar org-inhibit-logging nil) ; Dynamically-scoped param.
  4661. (defvar org-inhibit-blocking nil) ; Dynamically-scoped param.
  4662. (defvar org-table-buffer-is-an nil)
  4663. (defvar bidi-paragraph-direction)
  4664. (defvar buffer-face-mode-face)
  4665. (require 'outline)
  4666. (if (and (not (keymapp outline-mode-map)) (featurep 'allout))
  4667. (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"))
  4668. (require 'noutline "noutline" 'noerror) ;; stock XEmacs does not have it
  4669. ;; Other stuff we need.
  4670. (require 'time-date)
  4671. (unless (fboundp 'time-subtract) (defalias 'time-subtract 'subtract-time))
  4672. (require 'easymenu)
  4673. (require 'overlay)
  4674. ;; (require 'org-macs) moved higher up in the file before it is first used
  4675. (require 'org-entities)
  4676. ;; (require 'org-compat) moved higher up in the file before it is first used
  4677. (require 'org-faces)
  4678. (require 'org-list)
  4679. (require 'org-pcomplete)
  4680. (require 'org-src)
  4681. (require 'org-footnote)
  4682. (require 'org-macro)
  4683. ;; babel
  4684. (require 'ob)
  4685. ;;;###autoload
  4686. (define-derived-mode org-mode outline-mode "Org"
  4687. "Outline-based notes management and organizer, alias
  4688. \"Carsten's outline-mode for keeping track of everything.\"
  4689. Org-mode develops organizational tasks around a NOTES file which
  4690. contains information about projects as plain text. Org-mode is
  4691. implemented on top of outline-mode, which is ideal to keep the content
  4692. of large files well structured. It supports ToDo items, deadlines and
  4693. time stamps, which magically appear in the diary listing of the Emacs
  4694. calendar. Tables are easily created with a built-in table editor.
  4695. Plain text URL-like links connect to websites, emails (VM), Usenet
  4696. messages (Gnus), BBDB entries, and any files related to the project.
  4697. For printing and sharing of notes, an Org-mode file (or a part of it)
  4698. can be exported as a structured ASCII or HTML file.
  4699. The following commands are available:
  4700. \\{org-mode-map}"
  4701. ;; Get rid of Outline menus, they are not needed
  4702. ;; Need to do this here because define-derived-mode sets up
  4703. ;; the keymap so late. Still, it is a waste to call this each time
  4704. ;; we switch another buffer into org-mode.
  4705. (if (featurep 'xemacs)
  4706. (when (boundp 'outline-mode-menu-heading)
  4707. ;; Assume this is Greg's port, it uses easymenu
  4708. (easy-menu-remove outline-mode-menu-heading)
  4709. (easy-menu-remove outline-mode-menu-show)
  4710. (easy-menu-remove outline-mode-menu-hide))
  4711. (define-key org-mode-map [menu-bar headings] 'undefined)
  4712. (define-key org-mode-map [menu-bar hide] 'undefined)
  4713. (define-key org-mode-map [menu-bar show] 'undefined))
  4714. (org-load-modules-maybe)
  4715. (easy-menu-add org-org-menu)
  4716. (easy-menu-add org-tbl-menu)
  4717. (org-install-agenda-files-menu)
  4718. (if org-descriptive-links (add-to-invisibility-spec '(org-link)))
  4719. (add-to-invisibility-spec '(org-cwidth))
  4720. (add-to-invisibility-spec '(org-hide-block . t))
  4721. (when (featurep 'xemacs)
  4722. (org-set-local 'line-move-ignore-invisible t))
  4723. (org-set-local 'outline-regexp org-outline-regexp)
  4724. (org-set-local 'outline-level 'org-outline-level)
  4725. (setq bidi-paragraph-direction 'left-to-right)
  4726. (when (and org-ellipsis
  4727. (fboundp 'set-display-table-slot) (boundp 'buffer-display-table)
  4728. (fboundp 'make-glyph-code))
  4729. (unless org-display-table
  4730. (setq org-display-table (make-display-table)))
  4731. (set-display-table-slot
  4732. org-display-table 4
  4733. (vconcat (mapcar
  4734. (lambda (c) (make-glyph-code c (and (not (stringp org-ellipsis))
  4735. org-ellipsis)))
  4736. (if (stringp org-ellipsis) org-ellipsis "..."))))
  4737. (setq buffer-display-table org-display-table))
  4738. (org-set-regexps-and-options-for-tags)
  4739. (org-set-regexps-and-options)
  4740. (org-set-font-lock-defaults)
  4741. (when (and org-tag-faces (not org-tags-special-faces-re))
  4742. ;; tag faces set outside customize.... force initialization.
  4743. (org-set-tag-faces 'org-tag-faces org-tag-faces))
  4744. ;; Calc embedded
  4745. (org-set-local 'calc-embedded-open-mode "# ")
  4746. ;; Modify a few syntax entries
  4747. (modify-syntax-entry ?@ "w")
  4748. (modify-syntax-entry ?\" "\"")
  4749. (if org-startup-truncated (setq truncate-lines t))
  4750. (when org-startup-indented (require 'org-indent) (org-indent-mode 1))
  4751. (org-set-local 'font-lock-unfontify-region-function
  4752. 'org-unfontify-region)
  4753. ;; Activate before-change-function
  4754. (org-set-local 'org-table-may-need-update t)
  4755. (org-add-hook 'before-change-functions 'org-before-change-function nil
  4756. 'local)
  4757. ;; Check for running clock before killing a buffer
  4758. (org-add-hook 'kill-buffer-hook 'org-check-running-clock nil 'local)
  4759. ;; Initialize macros templates.
  4760. (org-macro-initialize-templates)
  4761. ;; Initialize radio targets.
  4762. (org-update-radio-target-regexp)
  4763. ;; Indentation.
  4764. (org-set-local 'indent-line-function 'org-indent-line)
  4765. (org-set-local 'indent-region-function 'org-indent-region)
  4766. ;; Filling and auto-filling.
  4767. (org-setup-filling)
  4768. ;; Comments.
  4769. (org-setup-comments-handling)
  4770. ;; Beginning/end of defun
  4771. (org-set-local 'beginning-of-defun-function 'org-backward-element)
  4772. (org-set-local 'end-of-defun-function 'org-forward-element)
  4773. ;; Next error for sparse trees
  4774. (org-set-local 'next-error-function 'org-occur-next-match)
  4775. ;; Make sure dependence stuff works reliably, even for users who set it
  4776. ;; too late :-(
  4777. (if org-enforce-todo-dependencies
  4778. (add-hook 'org-blocker-hook
  4779. 'org-block-todo-from-children-or-siblings-or-parent)
  4780. (remove-hook 'org-blocker-hook
  4781. 'org-block-todo-from-children-or-siblings-or-parent))
  4782. (if org-enforce-todo-checkbox-dependencies
  4783. (add-hook 'org-blocker-hook
  4784. 'org-block-todo-from-checkboxes)
  4785. (remove-hook 'org-blocker-hook
  4786. 'org-block-todo-from-checkboxes))
  4787. ;; Align options lines
  4788. (org-set-local
  4789. 'align-mode-rules-list
  4790. '((org-in-buffer-settings
  4791. (regexp . "^#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
  4792. (modes . '(org-mode)))))
  4793. ;; Imenu
  4794. (org-set-local 'imenu-create-index-function
  4795. 'org-imenu-get-tree)
  4796. ;; Make isearch reveal context
  4797. (if (or (featurep 'xemacs)
  4798. (not (boundp 'outline-isearch-open-invisible-function)))
  4799. ;; Emacs 21 and XEmacs make use of the hook
  4800. (org-add-hook 'isearch-mode-end-hook 'org-isearch-end 'append 'local)
  4801. ;; Emacs 22 deals with this through a special variable
  4802. (org-set-local 'outline-isearch-open-invisible-function
  4803. (lambda (&rest ignore) (org-show-context 'isearch)))
  4804. (org-add-hook 'isearch-mode-end-hook 'org-fix-ellipsis-at-bol 'append 'local))
  4805. ;; Setup the pcomplete hooks
  4806. (set (make-local-variable 'pcomplete-command-completion-function)
  4807. 'org-pcomplete-initial)
  4808. (set (make-local-variable 'pcomplete-command-name-function)
  4809. 'org-command-at-point)
  4810. (set (make-local-variable 'pcomplete-default-completion-function)
  4811. 'ignore)
  4812. (set (make-local-variable 'pcomplete-parse-arguments-function)
  4813. 'org-parse-arguments)
  4814. (set (make-local-variable 'pcomplete-termination-string) "")
  4815. (when (>= emacs-major-version 23)
  4816. (set (make-local-variable 'buffer-face-mode-face) 'org-default))
  4817. ;; If empty file that did not turn on org-mode automatically, make it to.
  4818. (if (and org-insert-mode-line-in-empty-file
  4819. (org-called-interactively-p 'any)
  4820. (= (point-min) (point-max)))
  4821. (insert "# -*- mode: org -*-\n\n"))
  4822. (unless org-inhibit-startup
  4823. (org-unmodified
  4824. (and org-startup-with-beamer-mode (org-beamer-mode))
  4825. (when org-startup-align-all-tables
  4826. (org-table-map-tables 'org-table-align 'quietly))
  4827. (when org-startup-with-inline-images
  4828. (org-display-inline-images))
  4829. (when org-startup-with-latex-preview
  4830. (org-preview-latex-fragment))
  4831. (unless org-inhibit-startup-visibility-stuff
  4832. (org-set-startup-visibility))))
  4833. ;; Try to set org-hide correctly
  4834. (set-face-foreground 'org-hide (org-find-invisible-foreground)))
  4835. ;; Update `customize-package-emacs-version-alist'
  4836. (add-to-list 'customize-package-emacs-version-alist
  4837. '(Org ("6.21b" . "23.1") ("6.33x" . "23.2")
  4838. ("7.8.11" . "24.1") ("7.9.4" . "24.3")
  4839. ("8.0" . "24.4")))
  4840. (defvar org-mode-transpose-word-syntax-table
  4841. (let ((st (make-syntax-table)))
  4842. (mapc (lambda(c) (modify-syntax-entry
  4843. (string-to-char (car c)) "w p" st))
  4844. org-emphasis-alist)
  4845. st))
  4846. (when (fboundp 'abbrev-table-put)
  4847. (abbrev-table-put org-mode-abbrev-table
  4848. :parents (list text-mode-abbrev-table)))
  4849. (put 'org-mode 'flyspell-mode-predicate 'org-mode-flyspell-verify)
  4850. (defsubst org-fix-ellipsis-at-bol ()
  4851. (save-excursion (goto-char (window-start)) (recenter 0)))
  4852. (defun org-find-invisible-foreground ()
  4853. (let ((candidates (remove
  4854. "unspecified-bg"
  4855. (nconc
  4856. (list (face-background 'default)
  4857. (face-background 'org-default))
  4858. (mapcar
  4859. (lambda (alist)
  4860. (when (boundp alist)
  4861. (cdr (assoc 'background-color (symbol-value alist)))))
  4862. '(default-frame-alist initial-frame-alist window-system-default-frame-alist))
  4863. (list (face-foreground 'org-hide))))))
  4864. (car (remove nil candidates))))
  4865. (defun org-current-time (&optional rounding-minutes past)
  4866. "Current time, possibly rounded to ROUNDING-MINUTES.
  4867. When ROUNDING-MINUTES is not an integer, fall back on the car of
  4868. `org-time-stamp-rounding-minutes'. When PAST is non-nil, ensure
  4869. the rounding returns a past time."
  4870. (let ((r (or (and (integerp rounding-minutes) rounding-minutes)
  4871. (car org-time-stamp-rounding-minutes)))
  4872. (time (decode-time)) res)
  4873. (if (< r 1)
  4874. (current-time)
  4875. (setq res
  4876. (apply 'encode-time
  4877. (append (list 0 (* r (floor (+ .5 (/ (float (nth 1 time)) r)))))
  4878. (nthcdr 2 time))))
  4879. (if (and past (< (org-float-time (time-subtract (current-time) res)) 0))
  4880. (seconds-to-time (- (org-float-time res) (* r 60)))
  4881. res))))
  4882. (defun org-today ()
  4883. "Return today date, considering `org-extend-today-until'."
  4884. (time-to-days
  4885. (time-subtract (current-time)
  4886. (list 0 (* 3600 org-extend-today-until) 0))))
  4887. ;;;; Font-Lock stuff, including the activators
  4888. (defvar org-mouse-map (make-sparse-keymap))
  4889. (org-defkey org-mouse-map [mouse-2] 'org-open-at-mouse)
  4890. (org-defkey org-mouse-map [mouse-3] 'org-find-file-at-mouse)
  4891. (when org-mouse-1-follows-link
  4892. (org-defkey org-mouse-map [follow-link] 'mouse-face))
  4893. (when org-tab-follows-link
  4894. (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
  4895. (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
  4896. (require 'font-lock)
  4897. (defconst org-non-link-chars "]\t\n\r<>")
  4898. (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "news"
  4899. "shell" "elisp" "doi" "message"))
  4900. (defvar org-link-types-re nil
  4901. "Matches a link that has a url-like prefix like \"http:\"")
  4902. (defvar org-link-re-with-space nil
  4903. "Matches a link with spaces, optional angular brackets around it.")
  4904. (defvar org-link-re-with-space2 nil
  4905. "Matches a link with spaces, optional angular brackets around it.")
  4906. (defvar org-link-re-with-space3 nil
  4907. "Matches a link with spaces, only for internal part in bracket links.")
  4908. (defvar org-angle-link-re nil
  4909. "Matches link with angular brackets, spaces are allowed.")
  4910. (defvar org-plain-link-re nil
  4911. "Matches plain link, without spaces.")
  4912. (defvar org-bracket-link-regexp nil
  4913. "Matches a link in double brackets.")
  4914. (defvar org-bracket-link-analytic-regexp nil
  4915. "Regular expression used to analyze links.
  4916. Here is what the match groups contain after a match:
  4917. 1: http:
  4918. 2: http
  4919. 3: path
  4920. 4: [desc]
  4921. 5: desc")
  4922. (defvar org-bracket-link-analytic-regexp++ nil
  4923. "Like `org-bracket-link-analytic-regexp', but include coderef internal type.")
  4924. (defvar org-any-link-re nil
  4925. "Regular expression matching any link.")
  4926. (defconst org-match-sexp-depth 3
  4927. "Number of stacked braces for sub/superscript matching.")
  4928. (defun org-create-multibrace-regexp (left right n)
  4929. "Create a regular expression which will match a balanced sexp.
  4930. Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
  4931. as single character strings.
  4932. The regexp returned will match the entire expression including the
  4933. delimiters. It will also define a single group which contains the
  4934. match except for the outermost delimiters. The maximum depth of
  4935. stacked delimiters is N. Escaping delimiters is not possible."
  4936. (let* ((nothing (concat "[^" left right "]*?"))
  4937. (or "\\|")
  4938. (re nothing)
  4939. (next (concat "\\(?:" nothing left nothing right "\\)+" nothing)))
  4940. (while (> n 1)
  4941. (setq n (1- n)
  4942. re (concat re or next)
  4943. next (concat "\\(?:" nothing left next right "\\)+" nothing)))
  4944. (concat left "\\(" re "\\)" right)))
  4945. (defvar org-match-substring-regexp
  4946. (concat
  4947. "\\(\\S-\\)\\([_^]\\)\\("
  4948. "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
  4949. "\\|"
  4950. "\\(" (org-create-multibrace-regexp "(" ")" org-match-sexp-depth) "\\)"
  4951. "\\|"
  4952. "\\(\\(?:\\*\\|[-+]?[^-+*!@#$%^_ \t\r\n,:\"?<>~;./{}=()]+\\)\\)\\)")
  4953. "The regular expression matching a sub- or superscript.")
  4954. (defvar org-match-substring-with-braces-regexp
  4955. (concat
  4956. "\\(\\S-\\)\\([_^]\\)\\("
  4957. "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
  4958. "\\)")
  4959. "The regular expression matching a sub- or superscript, forcing braces.")
  4960. (defun org-make-link-regexps ()
  4961. "Update the link regular expressions.
  4962. This should be called after the variable `org-link-types' has changed."
  4963. (setq org-link-types-re
  4964. (concat
  4965. "\\`\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):")
  4966. org-link-re-with-space
  4967. (concat
  4968. "<?\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4969. "\\([^" org-non-link-chars " ]"
  4970. "[^" org-non-link-chars "]*"
  4971. "[^" org-non-link-chars " ]\\)>?")
  4972. org-link-re-with-space2
  4973. (concat
  4974. "<?\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4975. "\\([^" org-non-link-chars " ]"
  4976. "[^\t\n\r]*"
  4977. "[^" org-non-link-chars " ]\\)>?")
  4978. org-link-re-with-space3
  4979. (concat
  4980. "<?\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4981. "\\([^" org-non-link-chars " ]"
  4982. "[^\t\n\r]*\\)")
  4983. org-angle-link-re
  4984. (concat
  4985. "<\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4986. "\\([^" org-non-link-chars " ]"
  4987. "[^" org-non-link-chars "]*"
  4988. "\\)>")
  4989. org-plain-link-re
  4990. (concat
  4991. "\\<\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4992. (org-re "\\([^ \t\n()<>]+\\(?:([[:word:]0-9_]+)\\|\\([^[:punct:] \t\n]\\|/\\)\\)\\)"))
  4993. ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
  4994. org-bracket-link-regexp
  4995. "\\[\\[\\([^][]+\\)\\]\\(\\[\\([^][]+\\)\\]\\)?\\]"
  4996. org-bracket-link-analytic-regexp
  4997. (concat
  4998. "\\[\\["
  4999. "\\(\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):\\)?"
  5000. "\\([^]]+\\)"
  5001. "\\]"
  5002. "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
  5003. "\\]")
  5004. org-bracket-link-analytic-regexp++
  5005. (concat
  5006. "\\[\\["
  5007. "\\(\\(" (mapconcat 'regexp-quote (cons "coderef" org-link-types) "\\|") "\\):\\)?"
  5008. "\\([^]]+\\)"
  5009. "\\]"
  5010. "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
  5011. "\\]")
  5012. org-any-link-re
  5013. (concat "\\(" org-bracket-link-regexp "\\)\\|\\("
  5014. org-angle-link-re "\\)\\|\\("
  5015. org-plain-link-re "\\)")))
  5016. (org-make-link-regexps)
  5017. (defconst org-ts-regexp "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)>"
  5018. "Regular expression for fast time stamp matching.")
  5019. (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
  5020. "Regular expression for fast time stamp matching.")
  5021. (defconst org-ts-regexp0
  5022. "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\( +[^]+0-9>\r\n -]+\\)?\\( +\\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
  5023. "Regular expression matching time strings for analysis.
  5024. This one does not require the space after the date, so it can be used
  5025. on a string that terminates immediately after the date.")
  5026. (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
  5027. "Regular expression matching time strings for analysis.")
  5028. (defconst org-ts-regexp2 (concat "<" org-ts-regexp1 "[^>\n]\\{0,16\\}>")
  5029. "Regular expression matching time stamps, with groups.")
  5030. (defconst org-ts-regexp3 (concat "[[<]" org-ts-regexp1 "[^]>\n]\\{0,16\\}[]>]")
  5031. "Regular expression matching time stamps (also [..]), with groups.")
  5032. (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
  5033. "Regular expression matching a time stamp range.")
  5034. (defconst org-tr-regexp-both
  5035. (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
  5036. "Regular expression matching a time stamp range.")
  5037. (defconst org-tsr-regexp (concat org-ts-regexp "\\(--?-?"
  5038. org-ts-regexp "\\)?")
  5039. "Regular expression matching a time stamp or time stamp range.")
  5040. (defconst org-tsr-regexp-both
  5041. (concat org-ts-regexp-both "\\(--?-?"
  5042. org-ts-regexp-both "\\)?")
  5043. "Regular expression matching a time stamp or time stamp range.
  5044. The time stamps may be either active or inactive.")
  5045. (defvar org-emph-face nil)
  5046. (defun org-do-emphasis-faces (limit)
  5047. "Run through the buffer and add overlays to emphasized strings."
  5048. (let (rtn a)
  5049. (while (and (not rtn) (re-search-forward org-emph-re limit t))
  5050. (if (not (= (char-after (match-beginning 3))
  5051. (char-after (match-beginning 4))))
  5052. (progn
  5053. (setq rtn t)
  5054. (setq a (assoc (match-string 3) org-emphasis-alist))
  5055. (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
  5056. 'face
  5057. (nth 1 a))
  5058. (and (nth 4 a)
  5059. (org-remove-flyspell-overlays-in
  5060. (match-beginning 0) (match-end 0)))
  5061. (add-text-properties (match-beginning 2) (match-end 2)
  5062. '(font-lock-multiline t org-emphasis t))
  5063. (when org-hide-emphasis-markers
  5064. (add-text-properties (match-end 4) (match-beginning 5)
  5065. '(invisible org-link))
  5066. (add-text-properties (match-beginning 3) (match-end 3)
  5067. '(invisible org-link)))))
  5068. (backward-char 1))
  5069. rtn))
  5070. (defun org-emphasize (&optional char)
  5071. "Insert or change an emphasis, i.e. a font like bold or italic.
  5072. If there is an active region, change that region to a new emphasis.
  5073. If there is no region, just insert the marker characters and position
  5074. the cursor between them.
  5075. CHAR should be the marker character. If it is a space, it means to
  5076. remove the emphasis of the selected region.
  5077. If CHAR is not given (for example in an interactive call) it will be
  5078. prompted for."
  5079. (interactive)
  5080. (let ((erc org-emphasis-regexp-components)
  5081. (prompt "")
  5082. (string "") beg end move c s)
  5083. (if (org-region-active-p)
  5084. (setq beg (region-beginning) end (region-end)
  5085. string (buffer-substring beg end))
  5086. (setq move t))
  5087. (unless char
  5088. (message "Emphasis marker or tag: [%s]"
  5089. (mapconcat (lambda(e) (car e)) org-emphasis-alist ""))
  5090. (setq char (read-char-exclusive)))
  5091. (if (equal char ?\ )
  5092. (setq s "" move nil)
  5093. (unless (assoc (char-to-string char) org-emphasis-alist)
  5094. (user-error "No such emphasis marker: \"%c\"" char))
  5095. (setq s (char-to-string char)))
  5096. (while (and (> (length string) 1)
  5097. (equal (substring string 0 1) (substring string -1))
  5098. (assoc (substring string 0 1) org-emphasis-alist))
  5099. (setq string (substring string 1 -1)))
  5100. (setq string (concat s string s))
  5101. (if beg (delete-region beg end))
  5102. (unless (or (bolp)
  5103. (string-match (concat "[" (nth 0 erc) "\n]")
  5104. (char-to-string (char-before (point)))))
  5105. (insert " "))
  5106. (unless (or (eobp)
  5107. (string-match (concat "[" (nth 1 erc) "\n]")
  5108. (char-to-string (char-after (point)))))
  5109. (insert " ") (backward-char 1))
  5110. (insert string)
  5111. (and move (backward-char 1))))
  5112. (defconst org-nonsticky-props
  5113. '(mouse-face highlight keymap invisible intangible help-echo org-linked-text htmlize-link))
  5114. (defsubst org-rear-nonsticky-at (pos)
  5115. (add-text-properties (1- pos) pos (list 'rear-nonsticky org-nonsticky-props)))
  5116. (defun org-activate-plain-links (limit)
  5117. "Run through the buffer and add overlays to links."
  5118. (let (f hl)
  5119. (when (and (re-search-forward (concat org-plain-link-re) limit t)
  5120. (not (org-in-src-block-p)))
  5121. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  5122. (setq f (get-text-property (match-beginning 0) 'face))
  5123. (setq hl (org-match-string-no-properties 0))
  5124. (if (or (eq f 'org-tag)
  5125. (and (listp f) (memq 'org-tag f)))
  5126. nil
  5127. (add-text-properties (match-beginning 0) (match-end 0)
  5128. (list 'mouse-face 'highlight
  5129. 'face 'org-link
  5130. 'htmlize-link `(:uri ,hl)
  5131. 'keymap org-mouse-map))
  5132. (org-rear-nonsticky-at (match-end 0)))
  5133. t)))
  5134. (defun org-activate-code (limit)
  5135. (if (re-search-forward "^[ \t]*\\(:\\(?: .*\\|$\\)\n?\\)" limit t)
  5136. (progn
  5137. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  5138. (remove-text-properties (match-beginning 0) (match-end 0)
  5139. '(display t invisible t intangible t))
  5140. t)))
  5141. (defcustom org-src-fontify-natively nil
  5142. "When non-nil, fontify code in code blocks."
  5143. :type 'boolean
  5144. :version "24.1"
  5145. :group 'org-appearance
  5146. :group 'org-babel)
  5147. (defcustom org-allow-promoting-top-level-subtree nil
  5148. "When non-nil, allow promoting a top level subtree.
  5149. The leading star of the top level headline will be replaced
  5150. by a #."
  5151. :type 'boolean
  5152. :version "24.1"
  5153. :group 'org-appearance)
  5154. (defun org-fontify-meta-lines-and-blocks (limit)
  5155. (condition-case nil
  5156. (org-fontify-meta-lines-and-blocks-1 limit)
  5157. (error (message "org-mode fontification error"))))
  5158. (defun org-fontify-meta-lines-and-blocks-1 (limit)
  5159. "Fontify #+ lines and blocks."
  5160. (let ((case-fold-search t))
  5161. (if (re-search-forward
  5162. "^\\([ \t]*#\\(\\(\\+[a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
  5163. limit t)
  5164. (let ((beg (match-beginning 0))
  5165. (block-start (match-end 0))
  5166. (block-end nil)
  5167. (lang (match-string 7))
  5168. (beg1 (line-beginning-position 2))
  5169. (dc1 (downcase (match-string 2)))
  5170. (dc3 (downcase (match-string 3)))
  5171. end end1 quoting block-type ovl)
  5172. (cond
  5173. ((member dc1 '("+html:" "+ascii:" "+latex:"))
  5174. ;; a single line of backend-specific content
  5175. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  5176. (remove-text-properties (match-beginning 0) (match-end 0)
  5177. '(display t invisible t intangible t))
  5178. (add-text-properties (match-beginning 1) (match-end 3)
  5179. '(font-lock-fontified t face org-meta-line))
  5180. (add-text-properties (match-beginning 6) (+ (match-end 6) 1)
  5181. '(font-lock-fontified t face org-block))
  5182. ; for backend-specific code
  5183. t)
  5184. ((and (match-end 4) (equal dc3 "+begin"))
  5185. ;; Truly a block
  5186. (setq block-type (downcase (match-string 5))
  5187. quoting (member block-type org-protecting-blocks))
  5188. (when (re-search-forward
  5189. (concat "^[ \t]*#\\+end" (match-string 4) "\\>.*")
  5190. nil t) ;; on purpose, we look further than LIMIT
  5191. (setq end (min (point-max) (match-end 0))
  5192. end1 (min (point-max) (1- (match-beginning 0))))
  5193. (setq block-end (match-beginning 0))
  5194. (when quoting
  5195. (remove-text-properties beg end
  5196. '(display t invisible t intangible t)))
  5197. (add-text-properties
  5198. beg end
  5199. '(font-lock-fontified t font-lock-multiline t))
  5200. (add-text-properties beg beg1 '(face org-meta-line))
  5201. (add-text-properties end1 (min (point-max) (1+ end))
  5202. '(face org-meta-line)) ; for end_src
  5203. (cond
  5204. ((and lang (not (string= lang "")) org-src-fontify-natively)
  5205. (org-src-font-lock-fontify-block lang block-start block-end)
  5206. ;; remove old background overlays
  5207. (mapc (lambda (ov)
  5208. (if (eq (overlay-get ov 'face) 'org-block-background)
  5209. (delete-overlay ov)))
  5210. (overlays-at (/ (+ beg1 block-end) 2)))
  5211. ;; add a background overlay
  5212. (setq ovl (make-overlay beg1 block-end))
  5213. (overlay-put ovl 'face 'org-block-background)
  5214. (overlay-put ovl 'evaporate t)) ;; make it go away when empty
  5215. (quoting
  5216. (add-text-properties beg1 (min (point-max) (1+ end1))
  5217. '(face org-block))) ; end of source block
  5218. ((not org-fontify-quote-and-verse-blocks))
  5219. ((string= block-type "quote")
  5220. (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-quote)))
  5221. ((string= block-type "verse")
  5222. (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-verse))))
  5223. (add-text-properties beg beg1 '(face org-block-begin-line))
  5224. (add-text-properties (min (point-max) (1+ end)) (min (point-max) (1+ end1))
  5225. '(face org-block-end-line))
  5226. t))
  5227. ((member dc1 '("+title:" "+author:" "+email:" "+date:"))
  5228. (add-text-properties
  5229. beg (match-end 3)
  5230. (if (member (intern (substring dc1 0 -1)) org-hidden-keywords)
  5231. '(font-lock-fontified t invisible t)
  5232. '(font-lock-fontified t face org-document-info-keyword)))
  5233. (add-text-properties
  5234. (match-beginning 6) (min (point-max) (1+ (match-end 6)))
  5235. (if (string-equal dc1 "+title:")
  5236. '(font-lock-fontified t face org-document-title)
  5237. '(font-lock-fontified t face org-document-info))))
  5238. ((or (equal dc1 "+results")
  5239. (member dc1 '("+begin:" "+end:" "+caption:" "+label:"
  5240. "+orgtbl:" "+tblfm:" "+tblname:" "+results:"
  5241. "+call:" "+header:" "+headers:" "+name:"))
  5242. (and (match-end 4) (equal dc3 "+attr")))
  5243. (add-text-properties
  5244. beg (match-end 0)
  5245. '(font-lock-fontified t face org-meta-line))
  5246. t)
  5247. ((member dc3 '(" " ""))
  5248. (add-text-properties
  5249. beg (match-end 0)
  5250. '(font-lock-fontified t face font-lock-comment-face)))
  5251. ((not (member (char-after beg) '(?\ ?\t)))
  5252. ;; just any other in-buffer setting, but not indented
  5253. (add-text-properties
  5254. beg (match-end 0)
  5255. '(font-lock-fontified t face org-meta-line))
  5256. t)
  5257. (t nil))))))
  5258. (defun org-activate-angle-links (limit)
  5259. "Run through the buffer and add overlays to links."
  5260. (if (and (re-search-forward org-angle-link-re limit t)
  5261. (not (org-in-src-block-p)))
  5262. (progn
  5263. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  5264. (add-text-properties (match-beginning 0) (match-end 0)
  5265. (list 'mouse-face 'highlight
  5266. 'keymap org-mouse-map))
  5267. (org-rear-nonsticky-at (match-end 0))
  5268. t)))
  5269. (defun org-activate-footnote-links (limit)
  5270. "Run through the buffer and add overlays to footnotes."
  5271. (let ((fn (org-footnote-next-reference-or-definition limit)))
  5272. (when fn
  5273. (let ((beg (nth 1 fn)) (end (nth 2 fn)))
  5274. (org-remove-flyspell-overlays-in beg end)
  5275. (add-text-properties beg end
  5276. (list 'mouse-face 'highlight
  5277. 'keymap org-mouse-map
  5278. 'help-echo
  5279. (if (= (point-at-bol) beg)
  5280. "Footnote definition"
  5281. "Footnote reference")
  5282. 'font-lock-fontified t
  5283. 'font-lock-multiline t
  5284. 'face 'org-footnote))))))
  5285. (defun org-activate-bracket-links (limit)
  5286. "Run through the buffer and add overlays to bracketed links."
  5287. (if (and (re-search-forward org-bracket-link-regexp limit t)
  5288. (not (org-in-src-block-p)))
  5289. (let* ((hl (org-match-string-no-properties 1))
  5290. (help (concat "LINK: " (save-match-data (org-link-unescape hl))))
  5291. (ip (org-maybe-intangible
  5292. (list 'invisible 'org-link
  5293. 'keymap org-mouse-map 'mouse-face 'highlight
  5294. 'font-lock-multiline t 'help-echo help
  5295. 'htmlize-link `(:uri ,hl))))
  5296. (vp (list 'keymap org-mouse-map 'mouse-face 'highlight
  5297. 'font-lock-multiline t 'help-echo help
  5298. 'htmlize-link `(:uri ,hl))))
  5299. ;; We need to remove the invisible property here. Table narrowing
  5300. ;; may have made some of this invisible.
  5301. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  5302. (remove-text-properties (match-beginning 0) (match-end 0)
  5303. '(invisible nil))
  5304. (if (match-end 3)
  5305. (progn
  5306. (add-text-properties (match-beginning 0) (match-beginning 3) ip)
  5307. (org-rear-nonsticky-at (match-beginning 3))
  5308. (add-text-properties (match-beginning 3) (match-end 3) vp)
  5309. (org-rear-nonsticky-at (match-end 3))
  5310. (add-text-properties (match-end 3) (match-end 0) ip)
  5311. (org-rear-nonsticky-at (match-end 0)))
  5312. (add-text-properties (match-beginning 0) (match-beginning 1) ip)
  5313. (org-rear-nonsticky-at (match-beginning 1))
  5314. (add-text-properties (match-beginning 1) (match-end 1) vp)
  5315. (org-rear-nonsticky-at (match-end 1))
  5316. (add-text-properties (match-end 1) (match-end 0) ip)
  5317. (org-rear-nonsticky-at (match-end 0)))
  5318. t)))
  5319. (defun org-activate-dates (limit)
  5320. "Run through the buffer and add overlays to dates."
  5321. (if (and (re-search-forward org-tsr-regexp-both limit t)
  5322. (not (equal (char-before (match-beginning 0)) 91)))
  5323. (progn
  5324. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  5325. (add-text-properties (match-beginning 0) (match-end 0)
  5326. (list 'mouse-face 'highlight
  5327. 'keymap org-mouse-map))
  5328. (org-rear-nonsticky-at (match-end 0))
  5329. (when org-display-custom-times
  5330. (if (match-end 3)
  5331. (org-display-custom-time (match-beginning 3) (match-end 3)))
  5332. (org-display-custom-time (match-beginning 1) (match-end 1)))
  5333. t)))
  5334. (defvar org-target-link-regexp nil
  5335. "Regular expression matching radio targets in plain text.")
  5336. (make-variable-buffer-local 'org-target-link-regexp)
  5337. (defvar org-target-regexp "<<\\([^<>\n\r]+\\)>>"
  5338. "Regular expression matching a link target.")
  5339. (defvar org-radio-target-regexp "<<<\\([^<>\n\r]+\\)>>>"
  5340. "Regular expression matching a radio target.")
  5341. (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
  5342. "Regular expression matching any target.")
  5343. (defun org-activate-target-links (limit)
  5344. "Run through the buffer and add overlays to target matches."
  5345. (when org-target-link-regexp
  5346. (let ((case-fold-search t))
  5347. (if (re-search-forward org-target-link-regexp limit t)
  5348. (progn
  5349. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  5350. (add-text-properties (match-beginning 0) (match-end 0)
  5351. (list 'mouse-face 'highlight
  5352. 'keymap org-mouse-map
  5353. 'help-echo "Radio target link"
  5354. 'org-linked-text t))
  5355. (org-rear-nonsticky-at (match-end 0))
  5356. t)))))
  5357. (defun org-update-radio-target-regexp ()
  5358. "Find all radio targets in this file and update the regular expression."
  5359. (interactive)
  5360. (when (memq 'radio org-activate-links)
  5361. (setq org-target-link-regexp
  5362. (org-make-target-link-regexp (org-all-targets 'radio)))
  5363. (org-restart-font-lock)))
  5364. (defun org-hide-wide-columns (limit)
  5365. (let (s e)
  5366. (setq s (text-property-any (point) (or limit (point-max))
  5367. 'org-cwidth t))
  5368. (when s
  5369. (setq e (next-single-property-change s 'org-cwidth))
  5370. (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
  5371. (goto-char e)
  5372. t)))
  5373. (defvar org-latex-and-related-regexp nil
  5374. "Regular expression for highlighting LaTeX, entities and sub/superscript.")
  5375. (defvar org-match-substring-regexp)
  5376. (defvar org-match-substring-with-braces-regexp)
  5377. (defun org-compute-latex-and-related-regexp ()
  5378. "Compute regular expression for LaTeX, entities and sub/superscript.
  5379. Result depends on variable `org-highlight-latex-and-related'."
  5380. (org-set-local
  5381. 'org-latex-and-related-regexp
  5382. (let* ((re-sub
  5383. (cond ((not (memq 'script org-highlight-latex-and-related)) nil)
  5384. ((eq org-use-sub-superscripts '{})
  5385. (list org-match-substring-with-braces-regexp))
  5386. (org-use-sub-superscripts (list org-match-substring-regexp))))
  5387. (re-latex
  5388. (when (memq 'latex org-highlight-latex-and-related)
  5389. (let ((matchers (plist-get org-format-latex-options :matchers)))
  5390. (delq nil
  5391. (mapcar (lambda (x)
  5392. (and (member (car x) matchers) (nth 1 x)))
  5393. org-latex-regexps)))))
  5394. (re-entities
  5395. (when (memq 'entities org-highlight-latex-and-related)
  5396. (list "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)"))))
  5397. (mapconcat 'identity (append re-latex re-entities re-sub) "\\|"))))
  5398. (defun org-do-latex-and-related (limit)
  5399. "Highlight LaTeX snippets and environments, entities and sub/superscript.
  5400. LIMIT bounds the search for syntax to highlight. Stop at first
  5401. highlighted object, if any. Return t if some highlighting was
  5402. done, nil otherwise."
  5403. (when (org-string-nw-p org-latex-and-related-regexp)
  5404. (catch 'found
  5405. (while (re-search-forward org-latex-and-related-regexp limit t)
  5406. (unless (memq (car-safe (get-text-property (1+ (match-beginning 0))
  5407. 'face))
  5408. '(org-code org-verbatim underline))
  5409. (let ((offset (if (memq (char-after (1+ (match-beginning 0)))
  5410. '(?_ ?^))
  5411. 1
  5412. 0)))
  5413. (font-lock-prepend-text-property
  5414. (+ offset (match-beginning 0)) (match-end 0)
  5415. 'face 'org-latex-and-related)
  5416. (add-text-properties (+ offset (match-beginning 0)) (match-end 0)
  5417. '(font-lock-multiline t)))
  5418. (throw 'found t)))
  5419. nil)))
  5420. (defun org-restart-font-lock ()
  5421. "Restart `font-lock-mode', to force refontification."
  5422. (when (and (boundp 'font-lock-mode) font-lock-mode)
  5423. (font-lock-mode -1)
  5424. (font-lock-mode 1)))
  5425. (defun org-all-targets (&optional radio)
  5426. "Return a list of all targets in this file.
  5427. When optional argument RADIO is non-nil, only find radio
  5428. targets."
  5429. (let ((re (if radio org-radio-target-regexp org-target-regexp)) rtn)
  5430. (save-excursion
  5431. (goto-char (point-min))
  5432. (while (re-search-forward re nil t)
  5433. ;; Make sure point is really within the object.
  5434. (backward-char)
  5435. (let ((obj (org-element-context)))
  5436. (when (memq (org-element-type obj) '(radio-target target))
  5437. (add-to-list 'rtn (downcase (org-element-property :value obj))))))
  5438. rtn)))
  5439. (defun org-make-target-link-regexp (targets)
  5440. "Make regular expression matching all strings in TARGETS.
  5441. The regular expression finds the targets also if there is a line break
  5442. between words."
  5443. (and targets
  5444. (concat
  5445. "\\<\\("
  5446. (mapconcat
  5447. (lambda (x)
  5448. (setq x (regexp-quote x))
  5449. (while (string-match " +" x)
  5450. (setq x (replace-match "\\s-+" t t x)))
  5451. x)
  5452. targets
  5453. "\\|")
  5454. "\\)\\>")))
  5455. (defun org-activate-tags (limit)
  5456. (if (re-search-forward (org-re "^\\*+.*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \r\n]") limit t)
  5457. (progn
  5458. (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
  5459. (add-text-properties (match-beginning 1) (match-end 1)
  5460. (list 'mouse-face 'highlight
  5461. 'keymap org-mouse-map))
  5462. (org-rear-nonsticky-at (match-end 1))
  5463. t)))
  5464. (defun org-outline-level ()
  5465. "Compute the outline level of the heading at point.
  5466. If this is called at a normal headline, the level is the number of stars.
  5467. Use `org-reduced-level' to remove the effect of `org-odd-levels'."
  5468. (save-excursion
  5469. (if (not (condition-case nil
  5470. (org-back-to-heading t)
  5471. (error nil)))
  5472. 0
  5473. (looking-at org-outline-regexp)
  5474. (1- (- (match-end 0) (match-beginning 0))))))
  5475. (defvar org-font-lock-keywords nil)
  5476. (defsubst org-re-property (property &optional literal)
  5477. "Return a regexp matching a PROPERTY line.
  5478. Match group 3 will be set to the value if it exists."
  5479. (concat "^\\(?4:[ \t]*\\)\\(?1::\\(?2:"
  5480. (if literal property (regexp-quote property))
  5481. "\\):\\)[ \t]+\\(?3:[^ \t\r\n].*?\\)\\(?5:[ \t]*\\)$"))
  5482. (defconst org-property-re
  5483. (org-re-property ".*?" 'literal)
  5484. "Regular expression matching a property line.
  5485. There are four matching groups:
  5486. 1: :PROPKEY: including the leading and trailing colon,
  5487. 2: PROPKEY without the leading and trailing colon,
  5488. 3: PROPVAL without leading or trailing spaces,
  5489. 4: the indentation of the current line,
  5490. 5: trailing whitespace.")
  5491. (defvar org-font-lock-hook nil
  5492. "Functions to be called for special font lock stuff.")
  5493. (defvar org-font-lock-set-keywords-hook nil
  5494. "Functions that can manipulate `org-font-lock-extra-keywords'.
  5495. This is called after `org-font-lock-extra-keywords' is defined, but before
  5496. it is installed to be used by font lock. This can be useful if something
  5497. needs to be inserted at a specific position in the font-lock sequence.")
  5498. (defun org-font-lock-hook (limit)
  5499. "Run `org-font-lock-hook' within LIMIT."
  5500. (run-hook-with-args 'org-font-lock-hook limit))
  5501. (defun org-set-font-lock-defaults ()
  5502. "Set font lock defaults for the current buffer."
  5503. (let* ((em org-fontify-emphasized-text)
  5504. (lk org-activate-links)
  5505. (org-font-lock-extra-keywords
  5506. (list
  5507. ;; Call the hook
  5508. '(org-font-lock-hook)
  5509. ;; Headlines
  5510. `(,(if org-fontify-whole-heading-line
  5511. "^\\(\\**\\)\\(\\* \\)\\(.*\n?\\)"
  5512. "^\\(\\**\\)\\(\\* \\)\\(.*\\)")
  5513. (1 (org-get-level-face 1))
  5514. (2 (org-get-level-face 2))
  5515. (3 (org-get-level-face 3)))
  5516. ;; Table lines
  5517. '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
  5518. (1 'org-table t))
  5519. ;; Table internals
  5520. '("^[ \t]*|\\(?:.*?|\\)? *\\(:?=[^|\n]*\\)" (1 'org-formula t))
  5521. '("^[ \t]*| *\\([#*]\\) *|" (1 'org-formula t))
  5522. '("^[ \t]*|\\( *\\([$!_^/]\\) *|.*\\)|" (1 'org-formula t))
  5523. '("| *\\(<[lrc]?[0-9]*>\\)" (1 'org-formula t))
  5524. ;; Drawers
  5525. (list org-drawer-regexp '(0 'org-special-keyword t))
  5526. (list "^[ \t]*:END:" '(0 'org-special-keyword t))
  5527. ;; Properties
  5528. (list org-property-re
  5529. '(1 'org-special-keyword t)
  5530. '(3 'org-property-value t))
  5531. ;; Links
  5532. (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
  5533. (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
  5534. (if (memq 'plain lk) '(org-activate-plain-links (0 'org-link t)))
  5535. (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
  5536. (if (memq 'radio lk) '(org-activate-target-links (0 'org-link t)))
  5537. (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
  5538. (if (memq 'footnote lk) '(org-activate-footnote-links))
  5539. ;; Targets.
  5540. (list org-any-target-regexp '(0 'org-target t))
  5541. ;; Diary sexps.
  5542. '("^&?%%(.*\\|<%%([^>\n]*?>" (0 'org-sexp-date t))
  5543. ;; Macro
  5544. '("{{{.+}}}" (0 'org-macro t))
  5545. '(org-hide-wide-columns (0 nil append))
  5546. ;; TODO keyword
  5547. (list (format org-heading-keyword-regexp-format
  5548. org-todo-regexp)
  5549. '(2 (org-get-todo-face 2) t))
  5550. ;; DONE
  5551. (if org-fontify-done-headline
  5552. (list (format org-heading-keyword-regexp-format
  5553. (concat
  5554. "\\(?:"
  5555. (mapconcat 'regexp-quote org-done-keywords "\\|")
  5556. "\\)"))
  5557. '(2 'org-headline-done t))
  5558. nil)
  5559. ;; Priorities
  5560. '(org-font-lock-add-priority-faces)
  5561. ;; Tags
  5562. '(org-font-lock-add-tag-faces)
  5563. ;; Tags groups
  5564. (if (and org-group-tags org-tag-groups-alist)
  5565. (list (concat org-outline-regexp-bol ".+\\(:"
  5566. (regexp-opt (mapcar 'car org-tag-groups-alist))
  5567. ":\\).*$")
  5568. '(1 'org-tag-group prepend)))
  5569. ;; Special keywords
  5570. (list (concat "\\<" org-deadline-string) '(0 'org-special-keyword t))
  5571. (list (concat "\\<" org-scheduled-string) '(0 'org-special-keyword t))
  5572. (list (concat "\\<" org-closed-string) '(0 'org-special-keyword t))
  5573. (list (concat "\\<" org-clock-string) '(0 'org-special-keyword t))
  5574. ;; Emphasis
  5575. (if em
  5576. (if (featurep 'xemacs)
  5577. '(org-do-emphasis-faces (0 nil append))
  5578. '(org-do-emphasis-faces)))
  5579. ;; Checkboxes
  5580. '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
  5581. 1 'org-checkbox prepend)
  5582. (if (cdr (assq 'checkbox org-list-automatic-rules))
  5583. '("\\[\\([0-9]*%\\)\\]\\|\\[\\([0-9]*\\)/\\([0-9]*\\)\\]"
  5584. (0 (org-get-checkbox-statistics-face) t)))
  5585. ;; Description list items
  5586. '("^[ \t]*[-+*][ \t]+\\(.*?[ \t]+::\\)\\([ \t]+\\|$\\)"
  5587. 1 'org-list-dt prepend)
  5588. ;; ARCHIVEd headings
  5589. (list (concat
  5590. org-outline-regexp-bol
  5591. "\\(.*:" org-archive-tag ":.*\\)")
  5592. '(1 'org-archived prepend))
  5593. ;; Specials
  5594. '(org-do-latex-and-related)
  5595. '(org-fontify-entities)
  5596. '(org-raise-scripts)
  5597. ;; Code
  5598. '(org-activate-code (1 'org-code t))
  5599. ;; COMMENT
  5600. (list (format org-heading-keyword-regexp-format
  5601. (concat "\\("
  5602. org-comment-string "\\|" org-quote-string
  5603. "\\)"))
  5604. '(2 'org-special-keyword t))
  5605. ;; Blocks and meta lines
  5606. '(org-fontify-meta-lines-and-blocks))))
  5607. (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
  5608. (run-hooks 'org-font-lock-set-keywords-hook)
  5609. ;; Now set the full font-lock-keywords
  5610. (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
  5611. (org-set-local 'font-lock-defaults
  5612. '(org-font-lock-keywords t nil nil backward-paragraph))
  5613. (kill-local-variable 'font-lock-keywords) nil))
  5614. (defun org-toggle-pretty-entities ()
  5615. "Toggle the composition display of entities as UTF8 characters."
  5616. (interactive)
  5617. (org-set-local 'org-pretty-entities (not org-pretty-entities))
  5618. (org-restart-font-lock)
  5619. (if org-pretty-entities
  5620. (message "Entities are now displayed as UTF8 characters")
  5621. (save-restriction
  5622. (widen)
  5623. (org-decompose-region (point-min) (point-max))
  5624. (message "Entities are now displayed as plain text"))))
  5625. (defvar org-custom-properties-overlays nil
  5626. "List of overlays used for custom properties.")
  5627. (make-variable-buffer-local 'org-custom-properties-overlays)
  5628. (defun org-toggle-custom-properties-visibility ()
  5629. "Display or hide properties in `org-custom-properties'."
  5630. (interactive)
  5631. (if org-custom-properties-overlays
  5632. (progn (mapc 'delete-overlay org-custom-properties-overlays)
  5633. (setq org-custom-properties-overlays nil))
  5634. (unless (not org-custom-properties)
  5635. (save-excursion
  5636. (save-restriction
  5637. (widen)
  5638. (goto-char (point-min))
  5639. (while (re-search-forward org-property-re nil t)
  5640. (mapc (lambda(p)
  5641. (when (equal p (substring (match-string 1) 1 -1))
  5642. (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
  5643. (overlay-put o 'invisible t)
  5644. (overlay-put o 'org-custom-property t)
  5645. (push o org-custom-properties-overlays))))
  5646. org-custom-properties)))))))
  5647. (defun org-fontify-entities (limit)
  5648. "Find an entity to fontify."
  5649. (let (ee)
  5650. (when org-pretty-entities
  5651. (catch 'match
  5652. (while (re-search-forward
  5653. "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]\n]\\)"
  5654. limit t)
  5655. (if (and (not (org-in-indented-comment-line))
  5656. (setq ee (org-entity-get (match-string 1)))
  5657. (= (length (nth 6 ee)) 1))
  5658. (let*
  5659. ((end (if (equal (match-string 2) "{}")
  5660. (match-end 2)
  5661. (match-end 1))))
  5662. (add-text-properties
  5663. (match-beginning 0) end
  5664. (list 'font-lock-fontified t))
  5665. (compose-region (match-beginning 0) end
  5666. (nth 6 ee) nil)
  5667. (backward-char 1)
  5668. (throw 'match t))))
  5669. nil))))
  5670. (defun org-fontify-like-in-org-mode (s &optional odd-levels)
  5671. "Fontify string S like in Org-mode."
  5672. (with-temp-buffer
  5673. (insert s)
  5674. (let ((org-odd-levels-only odd-levels))
  5675. (org-mode)
  5676. (font-lock-fontify-buffer)
  5677. (buffer-string))))
  5678. (defvar org-m nil)
  5679. (defvar org-l nil)
  5680. (defvar org-f nil)
  5681. (defun org-get-level-face (n)
  5682. "Get the right face for match N in font-lock matching of headlines."
  5683. (setq org-l (- (match-end 2) (match-beginning 1) 1))
  5684. (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
  5685. (if org-cycle-level-faces
  5686. (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
  5687. (setq org-f (nth (1- (min org-l org-n-level-faces)) org-level-faces)))
  5688. (cond
  5689. ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
  5690. ((eq n 2) org-f)
  5691. (t (if org-level-color-stars-only nil org-f))))
  5692. (defun org-get-todo-face (kwd)
  5693. "Get the right face for a TODO keyword KWD.
  5694. If KWD is a number, get the corresponding match group."
  5695. (if (numberp kwd) (setq kwd (match-string kwd)))
  5696. (or (org-face-from-face-or-color
  5697. 'todo 'org-todo (cdr (assoc kwd org-todo-keyword-faces)))
  5698. (and (member kwd org-done-keywords) 'org-done)
  5699. 'org-todo))
  5700. (defun org-face-from-face-or-color (context inherit face-or-color)
  5701. "Create a face list that inherits INHERIT, but sets the foreground color.
  5702. When FACE-OR-COLOR is not a string, just return it."
  5703. (if (stringp face-or-color)
  5704. (list :inherit inherit
  5705. (cdr (assoc context org-faces-easy-properties))
  5706. face-or-color)
  5707. face-or-color))
  5708. (defun org-font-lock-add-tag-faces (limit)
  5709. "Add the special tag faces."
  5710. (when (and org-tag-faces org-tags-special-faces-re)
  5711. (while (re-search-forward org-tags-special-faces-re limit t)
  5712. (add-text-properties (match-beginning 1) (match-end 1)
  5713. (list 'face (org-get-tag-face 1)
  5714. 'font-lock-fontified t))
  5715. (backward-char 1))))
  5716. (defun org-font-lock-add-priority-faces (limit)
  5717. "Add the special priority faces."
  5718. (while (re-search-forward "\\[#\\([A-Z0-9]\\)\\]" limit t)
  5719. (when (save-match-data (org-at-heading-p))
  5720. (add-text-properties
  5721. (match-beginning 0) (match-end 0)
  5722. (list 'face (or (org-face-from-face-or-color
  5723. 'priority 'org-priority
  5724. (cdr (assoc (char-after (match-beginning 1))
  5725. org-priority-faces)))
  5726. 'org-priority)
  5727. 'font-lock-fontified t)))))
  5728. (defun org-get-tag-face (kwd)
  5729. "Get the right face for a TODO keyword KWD.
  5730. If KWD is a number, get the corresponding match group."
  5731. (if (numberp kwd) (setq kwd (match-string kwd)))
  5732. (or (org-face-from-face-or-color
  5733. 'tag 'org-tag (cdr (assoc kwd org-tag-faces)))
  5734. 'org-tag))
  5735. (defun org-unfontify-region (beg end &optional maybe_loudly)
  5736. "Remove fontification and activation overlays from links."
  5737. (font-lock-default-unfontify-region beg end)
  5738. (let* ((buffer-undo-list t)
  5739. (inhibit-read-only t) (inhibit-point-motion-hooks t)
  5740. (inhibit-modification-hooks t)
  5741. deactivate-mark buffer-file-name buffer-file-truename)
  5742. (org-decompose-region beg end)
  5743. (remove-text-properties beg end
  5744. '(mouse-face t keymap t org-linked-text t
  5745. invisible t intangible t
  5746. org-no-flyspell t org-emphasis t))
  5747. (org-remove-font-lock-display-properties beg end)))
  5748. (defconst org-script-display '(((raise -0.3) (height 0.7))
  5749. ((raise 0.3) (height 0.7))
  5750. ((raise -0.5))
  5751. ((raise 0.5)))
  5752. "Display properties for showing superscripts and subscripts.")
  5753. (defun org-remove-font-lock-display-properties (beg end)
  5754. "Remove specific display properties that have been added by font lock.
  5755. The will remove the raise properties that are used to show superscripts
  5756. and subscripts."
  5757. (let (next prop)
  5758. (while (< beg end)
  5759. (setq next (next-single-property-change beg 'display nil end)
  5760. prop (get-text-property beg 'display))
  5761. (if (member prop org-script-display)
  5762. (put-text-property beg next 'display nil))
  5763. (setq beg next))))
  5764. (defun org-raise-scripts (limit)
  5765. "Add raise properties to sub/superscripts."
  5766. (when (and org-pretty-entities org-pretty-entities-include-sub-superscripts)
  5767. (if (re-search-forward
  5768. (if (eq org-use-sub-superscripts t)
  5769. org-match-substring-regexp
  5770. org-match-substring-with-braces-regexp)
  5771. limit t)
  5772. (let* ((pos (point)) table-p comment-p
  5773. (mpos (match-beginning 3))
  5774. (emph-p (get-text-property mpos 'org-emphasis))
  5775. (link-p (get-text-property mpos 'mouse-face))
  5776. (keyw-p (eq 'org-special-keyword (get-text-property mpos 'face))))
  5777. (goto-char (point-at-bol))
  5778. (setq table-p (org-looking-at-p org-table-dataline-regexp)
  5779. comment-p (org-looking-at-p "^[ \t]*#[ +]"))
  5780. (goto-char pos)
  5781. ;; Handle a_b^c
  5782. (if (member (char-after) '(?_ ?^)) (goto-char (1- pos)))
  5783. (if (or comment-p emph-p link-p keyw-p)
  5784. t
  5785. (put-text-property (match-beginning 3) (match-end 0)
  5786. 'display
  5787. (if (equal (char-after (match-beginning 2)) ?^)
  5788. (nth (if table-p 3 1) org-script-display)
  5789. (nth (if table-p 2 0) org-script-display)))
  5790. (add-text-properties (match-beginning 2) (match-end 2)
  5791. (list 'invisible t
  5792. 'org-dwidth t 'org-dwidth-n 1))
  5793. (if (and (eq (char-after (match-beginning 3)) ?{)
  5794. (eq (char-before (match-end 3)) ?}))
  5795. (progn
  5796. (add-text-properties
  5797. (match-beginning 3) (1+ (match-beginning 3))
  5798. (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))
  5799. (add-text-properties
  5800. (1- (match-end 3)) (match-end 3)
  5801. (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))))
  5802. t)))))
  5803. ;;;; Visibility cycling, including org-goto and indirect buffer
  5804. ;;; Cycling
  5805. (defvar org-cycle-global-status nil)
  5806. (make-variable-buffer-local 'org-cycle-global-status)
  5807. (put 'org-cycle-global-status 'org-state t)
  5808. (defvar org-cycle-subtree-status nil)
  5809. (make-variable-buffer-local 'org-cycle-subtree-status)
  5810. (put 'org-cycle-subtree-status 'org-state t)
  5811. (defvar org-inlinetask-min-level)
  5812. ;;;###autoload
  5813. (defun org-cycle (&optional arg)
  5814. "TAB-action and visibility cycling for Org-mode.
  5815. This is the command invoked in Org-mode by the TAB key. Its main purpose
  5816. is outline visibility cycling, but it also invokes other actions
  5817. in special contexts.
  5818. - When this function is called with a prefix argument, rotate the entire
  5819. buffer through 3 states (global cycling)
  5820. 1. OVERVIEW: Show only top-level headlines.
  5821. 2. CONTENTS: Show all headlines of all levels, but no body text.
  5822. 3. SHOW ALL: Show everything.
  5823. When called with two `C-u C-u' prefixes, switch to the startup visibility,
  5824. determined by the variable `org-startup-folded', and by any VISIBILITY
  5825. properties in the buffer.
  5826. When called with three `C-u C-u C-u' prefixed, show the entire buffer,
  5827. including any drawers.
  5828. - When inside a table, re-align the table and move to the next field.
  5829. - When point is at the beginning of a headline, rotate the subtree started
  5830. by this line through 3 different states (local cycling)
  5831. 1. FOLDED: Only the main headline is shown.
  5832. 2. CHILDREN: The main headline and the direct children are shown.
  5833. From this state, you can move to one of the children
  5834. and zoom in further.
  5835. 3. SUBTREE: Show the entire subtree, including body text.
  5836. If there is no subtree, switch directly from CHILDREN to FOLDED.
  5837. - When point is at the beginning of an empty headline and the variable
  5838. `org-cycle-level-after-item/entry-creation' is set, cycle the level
  5839. of the headline by demoting and promoting it to likely levels. This
  5840. speeds up creation document structure by pressing TAB once or several
  5841. times right after creating a new headline.
  5842. - When there is a numeric prefix, go up to a heading with level ARG, do
  5843. a `show-subtree' and return to the previous cursor position. If ARG
  5844. is negative, go up that many levels.
  5845. - When point is not at the beginning of a headline, execute the global
  5846. binding for TAB, which is re-indenting the line. See the option
  5847. `org-cycle-emulate-tab' for details.
  5848. - Special case: if point is at the beginning of the buffer and there is
  5849. no headline in line 1, this function will act as if called with prefix arg
  5850. (C-u TAB, same as S-TAB) also when called without prefix arg.
  5851. But only if also the variable `org-cycle-global-at-bob' is t."
  5852. (interactive "P")
  5853. (org-load-modules-maybe)
  5854. (unless (or (run-hook-with-args-until-success 'org-tab-first-hook)
  5855. (and org-cycle-level-after-item/entry-creation
  5856. (or (org-cycle-level)
  5857. (org-cycle-item-indentation))))
  5858. (let* (message-log-max ; Don't populate the *Messages* buffer
  5859. (limit-level
  5860. (or org-cycle-max-level
  5861. (and (boundp 'org-inlinetask-min-level)
  5862. org-inlinetask-min-level
  5863. (1- org-inlinetask-min-level))))
  5864. (nstars (and limit-level
  5865. (if org-odd-levels-only
  5866. (and limit-level (1- (* limit-level 2)))
  5867. limit-level)))
  5868. (org-outline-regexp
  5869. (if (not (derived-mode-p 'org-mode))
  5870. outline-regexp
  5871. (concat "\\*" (if nstars (format "\\{1,%d\\} " nstars) "+ "))))
  5872. (bob-special (and org-cycle-global-at-bob (not arg) (bobp)
  5873. (not (looking-at org-outline-regexp))))
  5874. (org-cycle-hook
  5875. (if bob-special
  5876. (delq 'org-optimize-window-after-visibility-change
  5877. (copy-sequence org-cycle-hook))
  5878. org-cycle-hook))
  5879. (pos (point)))
  5880. (if (or bob-special (equal arg '(4)))
  5881. ;; special case: use global cycling
  5882. (setq arg t))
  5883. (cond
  5884. ((equal arg '(16))
  5885. (setq last-command 'dummy)
  5886. (org-set-startup-visibility)
  5887. (message "Startup visibility, plus VISIBILITY properties"))
  5888. ((equal arg '(64))
  5889. (show-all)
  5890. (message "Entire buffer visible, including drawers"))
  5891. ;; Table: enter it or move to the next field.
  5892. ((org-at-table-p 'any)
  5893. (if (org-at-table.el-p)
  5894. (message "Use C-c ' to edit table.el tables")
  5895. (if arg (org-table-edit-field t)
  5896. (org-table-justify-field-maybe)
  5897. (call-interactively 'org-table-next-field))))
  5898. ((run-hook-with-args-until-success
  5899. 'org-tab-after-check-for-table-hook))
  5900. ;; Global cycling: delegate to `org-cycle-internal-global'.
  5901. ((eq arg t) (org-cycle-internal-global))
  5902. ;; Drawers: delegate to `org-flag-drawer'.
  5903. ((and org-drawers org-drawer-regexp
  5904. (save-excursion
  5905. (beginning-of-line 1)
  5906. (looking-at org-drawer-regexp)))
  5907. (org-flag-drawer ; toggle block visibility
  5908. (not (get-char-property (match-end 0) 'invisible))))
  5909. ;; Show-subtree, ARG levels up from here.
  5910. ((integerp arg)
  5911. (save-excursion
  5912. (org-back-to-heading)
  5913. (outline-up-heading (if (< arg 0) (- arg)
  5914. (- (funcall outline-level) arg)))
  5915. (org-show-subtree)))
  5916. ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
  5917. ((and (featurep 'org-inlinetask)
  5918. (org-inlinetask-at-task-p)
  5919. (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
  5920. (org-inlinetask-toggle-visibility))
  5921. ((org-try-cdlatex-tab))
  5922. ;; At an item/headline: delegate to `org-cycle-internal-local'.
  5923. ((and (or (and org-cycle-include-plain-lists (org-at-item-p))
  5924. (save-excursion (beginning-of-line 1)
  5925. (looking-at org-outline-regexp)))
  5926. (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
  5927. (org-cycle-internal-local))
  5928. ;; From there: TAB emulation and template completion.
  5929. (buffer-read-only (org-back-to-heading))
  5930. ((run-hook-with-args-until-success
  5931. 'org-tab-after-check-for-cycling-hook))
  5932. ((org-try-structure-completion))
  5933. ((run-hook-with-args-until-success
  5934. 'org-tab-before-tab-emulation-hook))
  5935. ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
  5936. (or (not (bolp))
  5937. (not (looking-at org-outline-regexp))))
  5938. (call-interactively (global-key-binding "\t")))
  5939. ((if (and (memq org-cycle-emulate-tab '(white whitestart))
  5940. (save-excursion (beginning-of-line 1) (looking-at "[ \t]*"))
  5941. (or (and (eq org-cycle-emulate-tab 'white)
  5942. (= (match-end 0) (point-at-eol)))
  5943. (and (eq org-cycle-emulate-tab 'whitestart)
  5944. (>= (match-end 0) pos))))
  5945. t
  5946. (eq org-cycle-emulate-tab t))
  5947. (call-interactively (global-key-binding "\t")))
  5948. (t (save-excursion
  5949. (org-back-to-heading)
  5950. (org-cycle)))))))
  5951. (defun org-cycle-internal-global ()
  5952. "Do the global cycling action."
  5953. ;; Hack to avoid display of messages for .org attachments in Gnus
  5954. (let (message-log-max ; Don't populate the *Messages* buffer
  5955. (ga (string-match "\\*fontification" (buffer-name))))
  5956. (cond
  5957. ((and (eq last-command this-command)
  5958. (eq org-cycle-global-status 'overview))
  5959. ;; We just created the overview - now do table of contents
  5960. ;; This can be slow in very large buffers, so indicate action
  5961. (run-hook-with-args 'org-pre-cycle-hook 'contents)
  5962. (unless ga (message "CONTENTS..."))
  5963. (org-content)
  5964. (unless ga (message "CONTENTS...done"))
  5965. (setq org-cycle-global-status 'contents)
  5966. (run-hook-with-args 'org-cycle-hook 'contents))
  5967. ((and (eq last-command this-command)
  5968. (eq org-cycle-global-status 'contents))
  5969. ;; We just showed the table of contents - now show everything
  5970. (run-hook-with-args 'org-pre-cycle-hook 'all)
  5971. (show-all)
  5972. (unless ga (message "SHOW ALL"))
  5973. (setq org-cycle-global-status 'all)
  5974. (run-hook-with-args 'org-cycle-hook 'all))
  5975. (t
  5976. ;; Default action: go to overview
  5977. (run-hook-with-args 'org-pre-cycle-hook 'overview)
  5978. (org-overview)
  5979. (unless ga (message "OVERVIEW"))
  5980. (setq org-cycle-global-status 'overview)
  5981. (run-hook-with-args 'org-cycle-hook 'overview)))))
  5982. (defun org-cycle-internal-local ()
  5983. "Do the local cycling action."
  5984. (let (message-log-max ; Don't populate the *Messages* buffer
  5985. (goal-column 0) eoh eol eos has-children children-skipped struct)
  5986. ;; First, determine end of headline (EOH), end of subtree or item
  5987. ;; (EOS), and if item or heading has children (HAS-CHILDREN).
  5988. (save-excursion
  5989. (if (org-at-item-p)
  5990. (progn
  5991. (beginning-of-line)
  5992. (setq struct (org-list-struct))
  5993. (setq eoh (point-at-eol))
  5994. (setq eos (org-list-get-item-end-before-blank (point) struct))
  5995. (setq has-children (org-list-has-child-p (point) struct)))
  5996. (org-back-to-heading)
  5997. (setq eoh (save-excursion (outline-end-of-heading) (point)))
  5998. (setq eos (save-excursion (1- (org-end-of-subtree t t))))
  5999. (setq has-children
  6000. (or (save-excursion
  6001. (let ((level (funcall outline-level)))
  6002. (outline-next-heading)
  6003. (and (org-at-heading-p t)
  6004. (> (funcall outline-level) level))))
  6005. (save-excursion
  6006. (org-list-search-forward (org-item-beginning-re) eos t)))))
  6007. ;; Determine end invisible part of buffer (EOL)
  6008. (beginning-of-line 2)
  6009. ;; XEmacs doesn't have `next-single-char-property-change'
  6010. (if (featurep 'xemacs)
  6011. (while (and (not (eobp)) ;; this is like `next-line'
  6012. (get-char-property (1- (point)) 'invisible))
  6013. (beginning-of-line 2))
  6014. (while (and (not (eobp)) ;; this is like `next-line'
  6015. (get-char-property (1- (point)) 'invisible))
  6016. (goto-char (next-single-char-property-change (point) 'invisible))
  6017. (and (eolp) (beginning-of-line 2))))
  6018. (setq eol (point)))
  6019. ;; Find out what to do next and set `this-command'
  6020. (cond
  6021. ((= eos eoh)
  6022. ;; Nothing is hidden behind this heading
  6023. (unless (org-before-first-heading-p)
  6024. (run-hook-with-args 'org-pre-cycle-hook 'empty))
  6025. (message "EMPTY ENTRY")
  6026. (setq org-cycle-subtree-status nil)
  6027. (save-excursion
  6028. (goto-char eos)
  6029. (outline-next-heading)
  6030. (if (outline-invisible-p) (org-flag-heading nil))))
  6031. ((and (or (>= eol eos)
  6032. (not (string-match "\\S-" (buffer-substring eol eos))))
  6033. (or has-children
  6034. (not (setq children-skipped
  6035. org-cycle-skip-children-state-if-no-children))))
  6036. ;; Entire subtree is hidden in one line: children view
  6037. (unless (org-before-first-heading-p)
  6038. (run-hook-with-args 'org-pre-cycle-hook 'children))
  6039. (if (org-at-item-p)
  6040. (org-list-set-item-visibility (point-at-bol) struct 'children)
  6041. (org-show-entry)
  6042. (org-with-limited-levels (show-children))
  6043. ;; FIXME: This slows down the func way too much.
  6044. ;; How keep drawers hidden in subtree anyway?
  6045. ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
  6046. ;; (org-cycle-hide-drawers 'subtree))
  6047. ;; Fold every list in subtree to top-level items.
  6048. (when (eq org-cycle-include-plain-lists 'integrate)
  6049. (save-excursion
  6050. (org-back-to-heading)
  6051. (while (org-list-search-forward (org-item-beginning-re) eos t)
  6052. (beginning-of-line 1)
  6053. (let* ((struct (org-list-struct))
  6054. (prevs (org-list-prevs-alist struct))
  6055. (end (org-list-get-bottom-point struct)))
  6056. (mapc (lambda (e) (org-list-set-item-visibility e struct 'folded))
  6057. (org-list-get-all-items (point) struct prevs))
  6058. (goto-char (if (< end eos) end eos)))))))
  6059. (message "CHILDREN")
  6060. (save-excursion
  6061. (goto-char eos)
  6062. (outline-next-heading)
  6063. (if (outline-invisible-p) (org-flag-heading nil)))
  6064. (setq org-cycle-subtree-status 'children)
  6065. (unless (org-before-first-heading-p)
  6066. (run-hook-with-args 'org-cycle-hook 'children)))
  6067. ((or children-skipped
  6068. (and (eq last-command this-command)
  6069. (eq org-cycle-subtree-status 'children)))
  6070. ;; We just showed the children, or no children are there,
  6071. ;; now show everything.
  6072. (unless (org-before-first-heading-p)
  6073. (run-hook-with-args 'org-pre-cycle-hook 'subtree))
  6074. (outline-flag-region eoh eos nil)
  6075. (message (if children-skipped "SUBTREE (NO CHILDREN)" "SUBTREE"))
  6076. (setq org-cycle-subtree-status 'subtree)
  6077. (unless (org-before-first-heading-p)
  6078. (run-hook-with-args 'org-cycle-hook 'subtree)))
  6079. (t
  6080. ;; Default action: hide the subtree.
  6081. (run-hook-with-args 'org-pre-cycle-hook 'folded)
  6082. (outline-flag-region eoh eos t)
  6083. (message "FOLDED")
  6084. (setq org-cycle-subtree-status 'folded)
  6085. (unless (org-before-first-heading-p)
  6086. (run-hook-with-args 'org-cycle-hook 'folded))))))
  6087. ;;;###autoload
  6088. (defun org-global-cycle (&optional arg)
  6089. "Cycle the global visibility. For details see `org-cycle'.
  6090. With \\[universal-argument] prefix arg, switch to startup visibility.
  6091. With a numeric prefix, show all headlines up to that level."
  6092. (interactive "P")
  6093. (let ((org-cycle-include-plain-lists
  6094. (if (derived-mode-p 'org-mode) org-cycle-include-plain-lists nil)))
  6095. (cond
  6096. ((integerp arg)
  6097. (show-all)
  6098. (hide-sublevels arg)
  6099. (setq org-cycle-global-status 'contents))
  6100. ((equal arg '(4))
  6101. (org-set-startup-visibility)
  6102. (message "Startup visibility, plus VISIBILITY properties."))
  6103. (t
  6104. (org-cycle '(4))))))
  6105. (defun org-set-startup-visibility ()
  6106. "Set the visibility required by startup options and properties."
  6107. (cond
  6108. ((eq org-startup-folded t)
  6109. (org-cycle '(4)))
  6110. ((eq org-startup-folded 'content)
  6111. (let ((this-command 'org-cycle) (last-command 'org-cycle))
  6112. (org-cycle '(4)) (org-cycle '(4)))))
  6113. (unless (eq org-startup-folded 'showeverything)
  6114. (if org-hide-block-startup (org-hide-block-all))
  6115. (org-set-visibility-according-to-property 'no-cleanup)
  6116. (org-cycle-hide-archived-subtrees 'all)
  6117. (org-cycle-hide-drawers 'all)
  6118. (org-cycle-show-empty-lines t)))
  6119. (defun org-set-visibility-according-to-property (&optional no-cleanup)
  6120. "Switch subtree visibilities according to :VISIBILITY: property."
  6121. (interactive)
  6122. (let (org-show-entry-below state)
  6123. (save-excursion
  6124. (goto-char (point-min))
  6125. (while (re-search-forward
  6126. "^[ \t]*:VISIBILITY:[ \t]+\\([a-z]+\\)"
  6127. nil t)
  6128. (setq state (match-string 1))
  6129. (save-excursion
  6130. (org-back-to-heading t)
  6131. (hide-subtree)
  6132. (org-reveal)
  6133. (cond
  6134. ((equal state '("fold" "folded"))
  6135. (hide-subtree))
  6136. ((equal state "children")
  6137. (org-show-hidden-entry)
  6138. (show-children))
  6139. ((equal state "content")
  6140. (save-excursion
  6141. (save-restriction
  6142. (org-narrow-to-subtree)
  6143. (org-content))))
  6144. ((member state '("all" "showall"))
  6145. (show-subtree)))))
  6146. (unless no-cleanup
  6147. (org-cycle-hide-archived-subtrees 'all)
  6148. (org-cycle-hide-drawers 'all)
  6149. (org-cycle-show-empty-lines 'all)))))
  6150. ;; This function uses outline-regexp instead of the more fundamental
  6151. ;; org-outline-regexp so that org-cycle-global works outside of Org
  6152. ;; buffers, where outline-regexp is needed.
  6153. (defun org-overview ()
  6154. "Switch to overview mode, showing only top-level headlines.
  6155. Really, this shows all headlines with level equal or greater than the level
  6156. of the first headline in the buffer. This is important, because if the
  6157. first headline is not level one, then (hide-sublevels 1) gives confusing
  6158. results."
  6159. (interactive)
  6160. (let ((l (org-current-line))
  6161. (level (save-excursion
  6162. (goto-char (point-min))
  6163. (if (re-search-forward (concat "^" outline-regexp) nil t)
  6164. (progn
  6165. (goto-char (match-beginning 0))
  6166. (funcall outline-level))))))
  6167. (and level (hide-sublevels level))
  6168. (recenter '(4))
  6169. (org-goto-line l)))
  6170. (defun org-content (&optional arg)
  6171. "Show all headlines in the buffer, like a table of contents.
  6172. With numerical argument N, show content up to level N."
  6173. (interactive "P")
  6174. (save-excursion
  6175. ;; Visit all headings and show their offspring
  6176. (and (integerp arg) (org-overview))
  6177. (goto-char (point-max))
  6178. (catch 'exit
  6179. (while (and (progn (condition-case nil
  6180. (outline-previous-visible-heading 1)
  6181. (error (goto-char (point-min))))
  6182. t)
  6183. (looking-at org-outline-regexp))
  6184. (if (integerp arg)
  6185. (show-children (1- arg))
  6186. (show-branches))
  6187. (if (bobp) (throw 'exit nil))))))
  6188. (defun org-optimize-window-after-visibility-change (state)
  6189. "Adjust the window after a change in outline visibility.
  6190. This function is the default value of the hook `org-cycle-hook'."
  6191. (when (get-buffer-window (current-buffer))
  6192. (cond
  6193. ((eq state 'content) nil)
  6194. ((eq state 'all) nil)
  6195. ((eq state 'folded) nil)
  6196. ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
  6197. ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
  6198. (defun org-remove-empty-overlays-at (pos)
  6199. "Remove outline overlays that do not contain non-white stuff."
  6200. (mapc
  6201. (lambda (o)
  6202. (and (eq 'outline (overlay-get o 'invisible))
  6203. (not (string-match "\\S-" (buffer-substring (overlay-start o)
  6204. (overlay-end o))))
  6205. (delete-overlay o)))
  6206. (overlays-at pos)))
  6207. (defun org-clean-visibility-after-subtree-move ()
  6208. "Fix visibility issues after moving a subtree."
  6209. ;; First, find a reasonable region to look at:
  6210. ;; Start two siblings above, end three below
  6211. (let* ((beg (save-excursion
  6212. (and (org-get-last-sibling)
  6213. (org-get-last-sibling))
  6214. (point)))
  6215. (end (save-excursion
  6216. (and (org-get-next-sibling)
  6217. (org-get-next-sibling)
  6218. (org-get-next-sibling))
  6219. (if (org-at-heading-p)
  6220. (point-at-eol)
  6221. (point))))
  6222. (level (looking-at "\\*+"))
  6223. (re (if level (concat "^" (regexp-quote (match-string 0)) " "))))
  6224. (save-excursion
  6225. (save-restriction
  6226. (narrow-to-region beg end)
  6227. (when re
  6228. ;; Properly fold already folded siblings
  6229. (goto-char (point-min))
  6230. (while (re-search-forward re nil t)
  6231. (if (and (not (outline-invisible-p))
  6232. (save-excursion
  6233. (goto-char (point-at-eol)) (outline-invisible-p)))
  6234. (hide-entry))))
  6235. (org-cycle-show-empty-lines 'overview)
  6236. (org-cycle-hide-drawers 'overview)))))
  6237. (defun org-cycle-show-empty-lines (state)
  6238. "Show empty lines above all visible headlines.
  6239. The region to be covered depends on STATE when called through
  6240. `org-cycle-hook'. Lisp program can use t for STATE to get the
  6241. entire buffer covered. Note that an empty line is only shown if there
  6242. are at least `org-cycle-separator-lines' empty lines before the headline."
  6243. (when (not (= org-cycle-separator-lines 0))
  6244. (save-excursion
  6245. (let* ((n (abs org-cycle-separator-lines))
  6246. (re (cond
  6247. ((= n 1) "\\(\n[ \t]*\n\\*+\\) ")
  6248. ((= n 2) "^[ \t]*\\(\n[ \t]*\n\\*+\\) ")
  6249. (t (let ((ns (number-to-string (- n 2))))
  6250. (concat "^\\(?:[ \t]*\n\\)\\{" ns "," ns "\\}"
  6251. "[ \t]*\\(\n[ \t]*\n\\*+\\) ")))))
  6252. beg end b e)
  6253. (cond
  6254. ((memq state '(overview contents t))
  6255. (setq beg (point-min) end (point-max)))
  6256. ((memq state '(children folded))
  6257. (setq beg (point) end (progn (org-end-of-subtree t t)
  6258. (beginning-of-line 2)
  6259. (point)))))
  6260. (when beg
  6261. (goto-char beg)
  6262. (while (re-search-forward re end t)
  6263. (unless (get-char-property (match-end 1) 'invisible)
  6264. (setq e (match-end 1))
  6265. (if (< org-cycle-separator-lines 0)
  6266. (setq b (save-excursion
  6267. (goto-char (match-beginning 0))
  6268. (org-back-over-empty-lines)
  6269. (if (save-excursion
  6270. (goto-char (max (point-min) (1- (point))))
  6271. (org-at-heading-p))
  6272. (1- (point))
  6273. (point))))
  6274. (setq b (match-beginning 1)))
  6275. (outline-flag-region b e nil)))))))
  6276. ;; Never hide empty lines at the end of the file.
  6277. (save-excursion
  6278. (goto-char (point-max))
  6279. (outline-previous-heading)
  6280. (outline-end-of-heading)
  6281. (if (and (looking-at "[ \t\n]+")
  6282. (= (match-end 0) (point-max)))
  6283. (outline-flag-region (point) (match-end 0) nil))))
  6284. (defun org-show-empty-lines-in-parent ()
  6285. "Move to the parent and re-show empty lines before visible headlines."
  6286. (save-excursion
  6287. (let ((context (if (org-up-heading-safe) 'children 'overview)))
  6288. (org-cycle-show-empty-lines context))))
  6289. (defun org-files-list ()
  6290. "Return `org-agenda-files' list, plus all open org-mode files.
  6291. This is useful for operations that need to scan all of a user's
  6292. open and agenda-wise Org files."
  6293. (let ((files (mapcar 'expand-file-name (org-agenda-files))))
  6294. (dolist (buf (buffer-list))
  6295. (with-current-buffer buf
  6296. (if (and (derived-mode-p 'org-mode) (buffer-file-name))
  6297. (let ((file (expand-file-name (buffer-file-name))))
  6298. (unless (member file files)
  6299. (push file files))))))
  6300. files))
  6301. (defsubst org-entry-beginning-position ()
  6302. "Return the beginning position of the current entry."
  6303. (save-excursion (outline-back-to-heading t) (point)))
  6304. (defsubst org-entry-end-position ()
  6305. "Return the end position of the current entry."
  6306. (save-excursion (outline-next-heading) (point)))
  6307. (defun org-cycle-hide-drawers (state)
  6308. "Re-hide all drawers after a visibility state change."
  6309. (when (and (derived-mode-p 'org-mode)
  6310. (not (memq state '(overview folded contents))))
  6311. (save-excursion
  6312. (let* ((globalp (memq state '(contents all)))
  6313. (beg (if globalp (point-min) (point)))
  6314. (end (if globalp (point-max)
  6315. (if (eq state 'children)
  6316. (save-excursion (outline-next-heading) (point))
  6317. (org-end-of-subtree t)))))
  6318. (goto-char beg)
  6319. (while (re-search-forward org-drawer-regexp end t)
  6320. (org-flag-drawer t))))))
  6321. (defun org-cycle-hide-inline-tasks (state)
  6322. "Re-hide inline task when switching to 'contents visibility state."
  6323. (when (and (eq state 'contents)
  6324. (boundp 'org-inlinetask-min-level)
  6325. org-inlinetask-min-level)
  6326. (hide-sublevels (1- org-inlinetask-min-level))))
  6327. (defun org-flag-drawer (flag)
  6328. "When FLAG is non-nil, hide the drawer we are within.
  6329. Otherwise make it visible."
  6330. (save-excursion
  6331. (beginning-of-line 1)
  6332. (when (looking-at "^[ \t]*:[a-zA-Z][a-zA-Z0-9]*:")
  6333. (let ((b (match-end 0)))
  6334. (if (re-search-forward
  6335. "^[ \t]*:END:"
  6336. (save-excursion (outline-next-heading) (point)) t)
  6337. (outline-flag-region b (point-at-eol) flag)
  6338. (user-error ":END: line missing at position %s" b))))))
  6339. (defun org-subtree-end-visible-p ()
  6340. "Is the end of the current subtree visible?"
  6341. (pos-visible-in-window-p
  6342. (save-excursion (org-end-of-subtree t) (point))))
  6343. (defun org-first-headline-recenter (&optional N)
  6344. "Move cursor to the first headline and recenter the headline.
  6345. Optional argument N means put the headline into the Nth line of the window."
  6346. (goto-char (point-min))
  6347. (when (re-search-forward (concat "^\\(" org-outline-regexp "\\)") nil t)
  6348. (beginning-of-line)
  6349. (recenter (prefix-numeric-value N))))
  6350. ;;; Saving and restoring visibility
  6351. (defun org-outline-overlay-data (&optional use-markers)
  6352. "Return a list of the locations of all outline overlays.
  6353. These are overlays with the `invisible' property value `outline'.
  6354. The return value is a list of cons cells, with start and stop
  6355. positions for each overlay.
  6356. If USE-MARKERS is set, return the positions as markers."
  6357. (let (beg end)
  6358. (save-excursion
  6359. (save-restriction
  6360. (widen)
  6361. (delq nil
  6362. (mapcar (lambda (o)
  6363. (when (eq (overlay-get o 'invisible) 'outline)
  6364. (setq beg (overlay-start o)
  6365. end (overlay-end o))
  6366. (and beg end (> end beg)
  6367. (if use-markers
  6368. (cons (move-marker (make-marker) beg)
  6369. (move-marker (make-marker) end))
  6370. (cons beg end)))))
  6371. (overlays-in (point-min) (point-max))))))))
  6372. (defun org-set-outline-overlay-data (data)
  6373. "Create visibility overlays for all positions in DATA.
  6374. DATA should have been made by `org-outline-overlay-data'."
  6375. (let (o)
  6376. (save-excursion
  6377. (save-restriction
  6378. (widen)
  6379. (show-all)
  6380. (mapc (lambda (c)
  6381. (outline-flag-region (car c) (cdr c) t))
  6382. data)))))
  6383. ;;; Folding of blocks
  6384. (defvar org-hide-block-overlays nil
  6385. "Overlays hiding blocks.")
  6386. (make-variable-buffer-local 'org-hide-block-overlays)
  6387. (defun org-block-map (function &optional start end)
  6388. "Call FUNCTION at the head of all source blocks in the current buffer.
  6389. Optional arguments START and END can be used to limit the range."
  6390. (let ((start (or start (point-min)))
  6391. (end (or end (point-max))))
  6392. (save-excursion
  6393. (goto-char start)
  6394. (while (and (< (point) end) (re-search-forward org-block-regexp end t))
  6395. (save-excursion
  6396. (save-match-data
  6397. (goto-char (match-beginning 0))
  6398. (funcall function)))))))
  6399. (defun org-hide-block-toggle-all ()
  6400. "Toggle the visibility of all blocks in the current buffer."
  6401. (org-block-map #'org-hide-block-toggle))
  6402. (defun org-hide-block-all ()
  6403. "Fold all blocks in the current buffer."
  6404. (interactive)
  6405. (org-show-block-all)
  6406. (org-block-map #'org-hide-block-toggle-maybe))
  6407. (defun org-show-block-all ()
  6408. "Unfold all blocks in the current buffer."
  6409. (interactive)
  6410. (mapc 'delete-overlay org-hide-block-overlays)
  6411. (setq org-hide-block-overlays nil))
  6412. (defun org-hide-block-toggle-maybe ()
  6413. "Toggle visibility of block at point."
  6414. (interactive)
  6415. (let ((case-fold-search t))
  6416. (if (save-excursion
  6417. (beginning-of-line 1)
  6418. (looking-at org-block-regexp))
  6419. (progn (org-hide-block-toggle)
  6420. t) ;; to signal that we took action
  6421. nil))) ;; to signal that we did not
  6422. (defun org-hide-block-toggle (&optional force)
  6423. "Toggle the visibility of the current block."
  6424. (interactive)
  6425. (save-excursion
  6426. (beginning-of-line)
  6427. (if (re-search-forward org-block-regexp nil t)
  6428. (let ((start (- (match-beginning 4) 1)) ;; beginning of body
  6429. (end (match-end 0)) ;; end of entire body
  6430. ov)
  6431. (if (memq t (mapcar (lambda (overlay)
  6432. (eq (overlay-get overlay 'invisible)
  6433. 'org-hide-block))
  6434. (overlays-at start)))
  6435. (if (or (not force) (eq force 'off))
  6436. (mapc (lambda (ov)
  6437. (when (member ov org-hide-block-overlays)
  6438. (setq org-hide-block-overlays
  6439. (delq ov org-hide-block-overlays)))
  6440. (when (eq (overlay-get ov 'invisible)
  6441. 'org-hide-block)
  6442. (delete-overlay ov)))
  6443. (overlays-at start)))
  6444. (setq ov (make-overlay start end))
  6445. (overlay-put ov 'invisible 'org-hide-block)
  6446. ;; make the block accessible to isearch
  6447. (overlay-put
  6448. ov 'isearch-open-invisible
  6449. (lambda (ov)
  6450. (when (member ov org-hide-block-overlays)
  6451. (setq org-hide-block-overlays
  6452. (delq ov org-hide-block-overlays)))
  6453. (when (eq (overlay-get ov 'invisible)
  6454. 'org-hide-block)
  6455. (delete-overlay ov))))
  6456. (push ov org-hide-block-overlays)))
  6457. (user-error "Not looking at a source block"))))
  6458. ;; org-tab-after-check-for-cycling-hook
  6459. (add-hook 'org-tab-first-hook 'org-hide-block-toggle-maybe)
  6460. ;; Remove overlays when changing major mode
  6461. (add-hook 'org-mode-hook
  6462. (lambda () (org-add-hook 'change-major-mode-hook
  6463. 'org-show-block-all 'append 'local)))
  6464. ;;; Org-goto
  6465. (defvar org-goto-window-configuration nil)
  6466. (defvar org-goto-marker nil)
  6467. (defvar org-goto-map)
  6468. (defun org-goto-map ()
  6469. "Set the keymap `org-goto'."
  6470. (setq org-goto-map
  6471. (let ((map (make-sparse-keymap)))
  6472. (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command
  6473. mouse-drag-region universal-argument org-occur))
  6474. cmd)
  6475. (while (setq cmd (pop cmds))
  6476. (substitute-key-definition cmd cmd map global-map)))
  6477. (suppress-keymap map)
  6478. (org-defkey map "\C-m" 'org-goto-ret)
  6479. (org-defkey map [(return)] 'org-goto-ret)
  6480. (org-defkey map [(left)] 'org-goto-left)
  6481. (org-defkey map [(right)] 'org-goto-right)
  6482. (org-defkey map [(control ?g)] 'org-goto-quit)
  6483. (org-defkey map "\C-i" 'org-cycle)
  6484. (org-defkey map [(tab)] 'org-cycle)
  6485. (org-defkey map [(down)] 'outline-next-visible-heading)
  6486. (org-defkey map [(up)] 'outline-previous-visible-heading)
  6487. (if org-goto-auto-isearch
  6488. (if (fboundp 'define-key-after)
  6489. (define-key-after map [t] 'org-goto-local-auto-isearch)
  6490. nil)
  6491. (org-defkey map "q" 'org-goto-quit)
  6492. (org-defkey map "n" 'outline-next-visible-heading)
  6493. (org-defkey map "p" 'outline-previous-visible-heading)
  6494. (org-defkey map "f" 'outline-forward-same-level)
  6495. (org-defkey map "b" 'outline-backward-same-level)
  6496. (org-defkey map "u" 'outline-up-heading))
  6497. (org-defkey map "/" 'org-occur)
  6498. (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
  6499. (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
  6500. (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
  6501. (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
  6502. (org-defkey map "\C-c\C-u" 'outline-up-heading)
  6503. map)))
  6504. (defconst org-goto-help
  6505. "Browse buffer copy, to find location or copy text.%s
  6506. RET=jump to location C-g=quit and return to previous location
  6507. \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
  6508. (defvar org-goto-start-pos) ; dynamically scoped parameter
  6509. (defun org-goto (&optional alternative-interface)
  6510. "Look up a different location in the current file, keeping current visibility.
  6511. When you want look-up or go to a different location in a
  6512. document, the fastest way is often to fold the entire buffer and
  6513. then dive into the tree. This method has the disadvantage, that
  6514. the previous location will be folded, which may not be what you
  6515. want.
  6516. This command works around this by showing a copy of the current
  6517. buffer in an indirect buffer, in overview mode. You can dive
  6518. into the tree in that copy, use org-occur and incremental search
  6519. to find a location. When pressing RET or `Q', the command
  6520. returns to the original buffer in which the visibility is still
  6521. unchanged. After RET it will also jump to the location selected
  6522. in the indirect buffer and expose the headline hierarchy above.
  6523. With a prefix argument, use the alternative interface: e.g. if
  6524. `org-goto-interface' is 'outline use 'outline-path-completion."
  6525. (interactive "P")
  6526. (org-goto-map)
  6527. (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
  6528. (org-refile-use-outline-path t)
  6529. (org-refile-target-verify-function nil)
  6530. (interface
  6531. (if (not alternative-interface)
  6532. org-goto-interface
  6533. (if (eq org-goto-interface 'outline)
  6534. 'outline-path-completion
  6535. 'outline)))
  6536. (org-goto-start-pos (point))
  6537. (selected-point
  6538. (if (eq interface 'outline)
  6539. (car (org-get-location (current-buffer) org-goto-help))
  6540. (let ((pa (org-refile-get-location "Goto" nil nil t)))
  6541. (org-refile-check-position pa)
  6542. (nth 3 pa)))))
  6543. (if selected-point
  6544. (progn
  6545. (org-mark-ring-push org-goto-start-pos)
  6546. (goto-char selected-point)
  6547. (if (or (outline-invisible-p) (org-invisible-p2))
  6548. (org-show-context 'org-goto)))
  6549. (message "Quit"))))
  6550. (defvar org-goto-selected-point nil) ; dynamically scoped parameter
  6551. (defvar org-goto-exit-command nil) ; dynamically scoped parameter
  6552. (defvar org-goto-local-auto-isearch-map) ; defined below
  6553. (defun org-get-location (buf help)
  6554. "Let the user select a location in the Org-mode buffer BUF.
  6555. This function uses a recursive edit. It returns the selected position
  6556. or nil."
  6557. (org-no-popups
  6558. (let ((isearch-mode-map org-goto-local-auto-isearch-map)
  6559. (isearch-hide-immediately nil)
  6560. (isearch-search-fun-function
  6561. (lambda () 'org-goto-local-search-headings))
  6562. (org-goto-selected-point org-goto-exit-command))
  6563. (save-excursion
  6564. (save-window-excursion
  6565. (delete-other-windows)
  6566. (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
  6567. (org-pop-to-buffer-same-window
  6568. (condition-case nil
  6569. (make-indirect-buffer (current-buffer) "*org-goto*")
  6570. (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
  6571. (with-output-to-temp-buffer "*Org Help*"
  6572. (princ (format help (if org-goto-auto-isearch
  6573. " Just type for auto-isearch."
  6574. " n/p/f/b/u to navigate, q to quit."))))
  6575. (org-fit-window-to-buffer (get-buffer-window "*Org Help*"))
  6576. (setq buffer-read-only nil)
  6577. (let ((org-startup-truncated t)
  6578. (org-startup-folded nil)
  6579. (org-startup-align-all-tables nil))
  6580. (org-mode)
  6581. (org-overview))
  6582. (setq buffer-read-only t)
  6583. (if (and (boundp 'org-goto-start-pos)
  6584. (integer-or-marker-p org-goto-start-pos))
  6585. (let ((org-show-hierarchy-above t)
  6586. (org-show-siblings t)
  6587. (org-show-following-heading t))
  6588. (goto-char org-goto-start-pos)
  6589. (and (outline-invisible-p) (org-show-context)))
  6590. (goto-char (point-min)))
  6591. (let (org-special-ctrl-a/e) (org-beginning-of-line))
  6592. (message "Select location and press RET")
  6593. (use-local-map org-goto-map)
  6594. (recursive-edit)))
  6595. (kill-buffer "*org-goto*")
  6596. (cons org-goto-selected-point org-goto-exit-command))))
  6597. (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
  6598. (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
  6599. (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
  6600. (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
  6601. (defun org-goto-local-search-headings (string bound noerror)
  6602. "Search and make sure that any matches are in headlines."
  6603. (catch 'return
  6604. (while (if isearch-forward
  6605. (search-forward string bound noerror)
  6606. (search-backward string bound noerror))
  6607. (when (let ((context (mapcar 'car (save-match-data (org-context)))))
  6608. (and (member :headline context)
  6609. (not (member :tags context))))
  6610. (throw 'return (point))))))
  6611. (defun org-goto-local-auto-isearch ()
  6612. "Start isearch."
  6613. (interactive)
  6614. (goto-char (point-min))
  6615. (let ((keys (this-command-keys)))
  6616. (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
  6617. (isearch-mode t)
  6618. (isearch-process-search-char (string-to-char keys)))))
  6619. (defun org-goto-ret (&optional arg)
  6620. "Finish `org-goto' by going to the new location."
  6621. (interactive "P")
  6622. (setq org-goto-selected-point (point)
  6623. org-goto-exit-command 'return)
  6624. (throw 'exit nil))
  6625. (defun org-goto-left ()
  6626. "Finish `org-goto' by going to the new location."
  6627. (interactive)
  6628. (if (org-at-heading-p)
  6629. (progn
  6630. (beginning-of-line 1)
  6631. (setq org-goto-selected-point (point)
  6632. org-goto-exit-command 'left)
  6633. (throw 'exit nil))
  6634. (user-error "Not on a heading")))
  6635. (defun org-goto-right ()
  6636. "Finish `org-goto' by going to the new location."
  6637. (interactive)
  6638. (if (org-at-heading-p)
  6639. (progn
  6640. (setq org-goto-selected-point (point)
  6641. org-goto-exit-command 'right)
  6642. (throw 'exit nil))
  6643. (user-error "Not on a heading")))
  6644. (defun org-goto-quit ()
  6645. "Finish `org-goto' without cursor motion."
  6646. (interactive)
  6647. (setq org-goto-selected-point nil)
  6648. (setq org-goto-exit-command 'quit)
  6649. (throw 'exit nil))
  6650. ;;; Indirect buffer display of subtrees
  6651. (defvar org-indirect-dedicated-frame nil
  6652. "This is the frame being used for indirect tree display.")
  6653. (defvar org-last-indirect-buffer nil)
  6654. (defun org-tree-to-indirect-buffer (&optional arg)
  6655. "Create indirect buffer and narrow it to current subtree.
  6656. With a numerical prefix ARG, go up to this level and then take that tree.
  6657. If ARG is negative, go up that many levels.
  6658. If `org-indirect-buffer-display' is not `new-frame', the command removes the
  6659. indirect buffer previously made with this command, to avoid proliferation of
  6660. indirect buffers. However, when you call the command with a \
  6661. \\[universal-argument] prefix, or
  6662. when `org-indirect-buffer-display' is `new-frame', the last buffer
  6663. is kept so that you can work with several indirect buffers at the same time.
  6664. If `org-indirect-buffer-display' is `dedicated-frame', the \
  6665. \\[universal-argument] prefix also
  6666. requests that a new frame be made for the new buffer, so that the dedicated
  6667. frame is not changed."
  6668. (interactive "P")
  6669. (let ((cbuf (current-buffer))
  6670. (cwin (selected-window))
  6671. (pos (point))
  6672. beg end level heading ibuf)
  6673. (save-excursion
  6674. (org-back-to-heading t)
  6675. (when (numberp arg)
  6676. (setq level (org-outline-level))
  6677. (if (< arg 0) (setq arg (+ level arg)))
  6678. (while (> (setq level (org-outline-level)) arg)
  6679. (org-up-heading-safe)))
  6680. (setq beg (point)
  6681. heading (org-get-heading))
  6682. (org-end-of-subtree t t)
  6683. (if (org-at-heading-p) (backward-char 1))
  6684. (setq end (point)))
  6685. (if (and (buffer-live-p org-last-indirect-buffer)
  6686. (not (eq org-indirect-buffer-display 'new-frame))
  6687. (not arg))
  6688. (kill-buffer org-last-indirect-buffer))
  6689. (setq ibuf (org-get-indirect-buffer cbuf)
  6690. org-last-indirect-buffer ibuf)
  6691. (cond
  6692. ((or (eq org-indirect-buffer-display 'new-frame)
  6693. (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
  6694. (select-frame (make-frame))
  6695. (delete-other-windows)
  6696. (org-pop-to-buffer-same-window ibuf)
  6697. (org-set-frame-title heading))
  6698. ((eq org-indirect-buffer-display 'dedicated-frame)
  6699. (raise-frame
  6700. (select-frame (or (and org-indirect-dedicated-frame
  6701. (frame-live-p org-indirect-dedicated-frame)
  6702. org-indirect-dedicated-frame)
  6703. (setq org-indirect-dedicated-frame (make-frame)))))
  6704. (delete-other-windows)
  6705. (org-pop-to-buffer-same-window ibuf)
  6706. (org-set-frame-title (concat "Indirect: " heading)))
  6707. ((eq org-indirect-buffer-display 'current-window)
  6708. (org-pop-to-buffer-same-window ibuf))
  6709. ((eq org-indirect-buffer-display 'other-window)
  6710. (pop-to-buffer ibuf))
  6711. (t (error "Invalid value")))
  6712. (if (featurep 'xemacs)
  6713. (save-excursion (org-mode) (turn-on-font-lock)))
  6714. (narrow-to-region beg end)
  6715. (show-all)
  6716. (goto-char pos)
  6717. (run-hook-with-args 'org-cycle-hook 'all)
  6718. (and (window-live-p cwin) (select-window cwin))))
  6719. (defun org-get-indirect-buffer (&optional buffer)
  6720. (setq buffer (or buffer (current-buffer)))
  6721. (let ((n 1) (base (buffer-name buffer)) bname)
  6722. (while (buffer-live-p
  6723. (get-buffer (setq bname (concat base "-" (number-to-string n)))))
  6724. (setq n (1+ n)))
  6725. (condition-case nil
  6726. (make-indirect-buffer buffer bname 'clone)
  6727. (error (make-indirect-buffer buffer bname)))))
  6728. (defun org-set-frame-title (title)
  6729. "Set the title of the current frame to the string TITLE."
  6730. ;; FIXME: how to name a single frame in XEmacs???
  6731. (unless (featurep 'xemacs)
  6732. (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
  6733. ;;;; Structure editing
  6734. ;;; Inserting headlines
  6735. (defun org-previous-line-empty-p (&optional next)
  6736. "Is the previous line a blank line?
  6737. When NEXT is non-nil, check the next line instead."
  6738. (save-excursion
  6739. (and (not (bobp))
  6740. (or (beginning-of-line (if next 2 0)) t)
  6741. (save-match-data
  6742. (looking-at "[ \t]*$")))))
  6743. (defun org-insert-heading (&optional arg invisible-ok)
  6744. "Insert a new heading or item with same depth at point.
  6745. If point is in a plain list and ARG is nil, create a new list item.
  6746. With one universal prefix argument, insert a heading even in lists.
  6747. With two universal prefix arguments, insert the heading at the end
  6748. of the parent subtree.
  6749. If point is at the beginning of a headline, insert a sibling before
  6750. the current headline. If point is not at the beginning, split the line
  6751. and create a new headline with the text in the current line after point
  6752. \(see `org-M-RET-may-split-line' on how to modify this behavior).
  6753. If point is at the beginning of a normal line, turn this line into
  6754. a heading.
  6755. When INVISIBLE-OK is set, stop at invisible headlines when going back.
  6756. This is important for non-interactive uses of the command."
  6757. (interactive "P")
  6758. (if (org-called-interactively-p 'any) (org-reveal))
  6759. (let ((itemp (org-in-item-p))
  6760. (may-split (org-get-alist-option org-M-RET-may-split-line 'headline))
  6761. (respect-content (or org-insert-heading-respect-content
  6762. (equal arg '(16))))
  6763. (initial-content "")
  6764. (adjust-empty-lines t))
  6765. (cond
  6766. ((or (= (buffer-size) 0)
  6767. (and (not (save-excursion
  6768. (and (ignore-errors (org-back-to-heading invisible-ok))
  6769. (org-at-heading-p))))
  6770. (or arg (not itemp))))
  6771. ;; At beginning of buffer or so hight up that only a heading makes sense.
  6772. (insert
  6773. (if (or (bobp) (org-previous-line-empty-p)) "" "\n")
  6774. (if (org-in-src-block-p) ",* " "* "))
  6775. (run-hooks 'org-insert-heading-hook))
  6776. ((and itemp (not (equal arg '(4))))
  6777. ;; Insert an item
  6778. (org-insert-item))
  6779. (t
  6780. ;; Insert a heading
  6781. (save-restriction
  6782. (widen)
  6783. (let* ((level nil)
  6784. (on-heading (org-at-heading-p))
  6785. (empty-line-p (if on-heading
  6786. (org-previous-line-empty-p)
  6787. ;; We will decide later
  6788. nil))
  6789. ;; Get a level string to fall back on
  6790. (fix-level
  6791. (save-excursion
  6792. (org-back-to-heading t)
  6793. (if (org-previous-line-empty-p) (setq empty-line-p t))
  6794. (looking-at org-outline-regexp)
  6795. (make-string (1- (length (match-string 0))) ?*)))
  6796. (stars
  6797. (save-excursion
  6798. (condition-case nil
  6799. (progn
  6800. (org-back-to-heading invisible-ok)
  6801. (when (and (not on-heading)
  6802. (featurep 'org-inlinetask)
  6803. (integerp org-inlinetask-min-level)
  6804. (>= (length (match-string 0))
  6805. org-inlinetask-min-level))
  6806. ;; Find a heading level before the inline task
  6807. (while (and (setq level (org-up-heading-safe))
  6808. (>= level org-inlinetask-min-level)))
  6809. (if (org-at-heading-p)
  6810. (org-back-to-heading invisible-ok)
  6811. (error "This should not happen")))
  6812. (unless (and (save-excursion
  6813. (save-match-data
  6814. (org-backward-heading-same-level
  6815. 1 invisible-ok))
  6816. (= (point) (match-beginning 0)))
  6817. (not (org-previous-line-empty-p t)))
  6818. (setq empty-line-p (or empty-line-p
  6819. (org-previous-line-empty-p))))
  6820. (match-string 0))
  6821. (error (or fix-level "* ")))))
  6822. (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
  6823. (blank (if (eq blank-a 'auto) empty-line-p blank-a))
  6824. pos hide-previous previous-pos)
  6825. ;; If we insert after content, move there and clean up whitespace
  6826. (when respect-content
  6827. (org-end-of-subtree nil t)
  6828. (when (looking-at "^\\*")
  6829. (backward-char 1)
  6830. (insert "\n")))
  6831. ;; If we are splitting, grab the text that should be moved to the new headline
  6832. (when may-split
  6833. (if (org-on-heading-p)
  6834. ;; This is a heading, we split intelligently (keeping tags)
  6835. (let ((pos (point)))
  6836. (goto-char (point-at-bol))
  6837. (unless (looking-at org-complex-heading-regexp)
  6838. (error "This should not happen"))
  6839. (when (and (match-beginning 4)
  6840. (> pos (match-beginning 4))
  6841. (< pos (match-end 4)))
  6842. (setq initial-content (buffer-substring pos (match-end 4)))
  6843. (goto-char pos)
  6844. (delete-region (point) (match-end 4))
  6845. (if (looking-at "[ \t]*$")
  6846. (replace-match "")
  6847. (insert (make-string (length initial-content) ?\ )))
  6848. (setq initial-content (org-trim initial-content)))
  6849. (goto-char pos))
  6850. ;; a normal line
  6851. (unless (bolp)
  6852. (setq initial-content (buffer-substring (point) (point-at-eol)))
  6853. (delete-region (point) (point-at-eol))
  6854. (setq initial-content (org-trim initial-content)))))
  6855. ;; If we are at the beginning of the line, insert before it. Else after
  6856. (cond
  6857. ((and (bolp) (looking-at "[ \t]*$")))
  6858. ((and (bolp) (not (looking-at "[ \t]*$")))
  6859. (open-line 1))
  6860. (t
  6861. (goto-char (point-at-eol))
  6862. (insert "\n")))
  6863. ;; Insert the new heading
  6864. (insert stars)
  6865. (just-one-space)
  6866. (insert initial-content)
  6867. (if adjust-empty-lines
  6868. (if (and blank (not (org-previous-line-empty-p)))
  6869. (org-N-empty-lines-before-current (if blank 1 0))))
  6870. (run-hooks 'org-insert-heading-hook)))))))
  6871. (defun org-N-empty-lines-before-current (N)
  6872. "Make the number of empty lines before current exactly N.
  6873. So this will delete or add empty lines."
  6874. (save-excursion
  6875. (goto-char (point-at-bol))
  6876. (if (looking-back "\\s-+" nil 'greedy)
  6877. (replace-match ""))
  6878. (or (bobp) (insert "\n"))
  6879. (while (> N 0)
  6880. (insert "\n")
  6881. (setq N (1- N)))))
  6882. (defun org-get-heading (&optional no-tags no-todo)
  6883. "Return the heading of the current entry, without the stars.
  6884. When NO-TAGS is non-nil, don't include tags.
  6885. When NO-TODO is non-nil, don't include TODO keywords."
  6886. (save-excursion
  6887. (org-back-to-heading t)
  6888. (cond
  6889. ((and no-tags no-todo)
  6890. (looking-at org-complex-heading-regexp)
  6891. (match-string 4))
  6892. (no-tags
  6893. (looking-at (concat org-outline-regexp
  6894. "\\(.*?\\)"
  6895. "\\(?:[ \t]+:[[:alnum:]:_@#%]+:\\)?[ \t]*$"))
  6896. (match-string 1))
  6897. (no-todo
  6898. (looking-at org-todo-line-regexp)
  6899. (match-string 3))
  6900. (t (looking-at org-heading-regexp)
  6901. (match-string 2)))))
  6902. (defvar orgstruct-mode) ; defined below
  6903. (defun org-heading-components ()
  6904. "Return the components of the current heading.
  6905. This is a list with the following elements:
  6906. - the level as an integer
  6907. - the reduced level, different if `org-odd-levels-only' is set.
  6908. - the TODO keyword, or nil
  6909. - the priority character, like ?A, or nil if no priority is given
  6910. - the headline text itself, or the tags string if no headline text
  6911. - the tags string, or nil."
  6912. (save-excursion
  6913. (org-back-to-heading t)
  6914. (if (let (case-fold-search)
  6915. (looking-at
  6916. (if orgstruct-mode
  6917. org-heading-regexp
  6918. org-complex-heading-regexp)))
  6919. (if orgstruct-mode
  6920. (list (length (match-string 1))
  6921. (org-reduced-level (length (match-string 1)))
  6922. nil
  6923. nil
  6924. (match-string 2)
  6925. nil)
  6926. (list (length (match-string 1))
  6927. (org-reduced-level (length (match-string 1)))
  6928. (org-match-string-no-properties 2)
  6929. (and (match-end 3) (aref (match-string 3) 2))
  6930. (org-match-string-no-properties 4)
  6931. (org-match-string-no-properties 5))))))
  6932. (defun org-get-entry ()
  6933. "Get the entry text, after heading, entire subtree."
  6934. (save-excursion
  6935. (org-back-to-heading t)
  6936. (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
  6937. (defun org-insert-heading-after-current ()
  6938. "Insert a new heading with same level as current, after current subtree."
  6939. (interactive)
  6940. (org-back-to-heading)
  6941. (org-insert-heading)
  6942. (org-move-subtree-down)
  6943. (end-of-line 1))
  6944. (defun org-insert-heading-respect-content (&optional arg invisible-ok)
  6945. "Insert heading with `org-insert-heading-respect-content' set to t."
  6946. (interactive "P")
  6947. (let ((org-insert-heading-respect-content t))
  6948. (org-insert-heading '(4) invisible-ok)))
  6949. (defun org-insert-todo-heading-respect-content (&optional force-state)
  6950. "Insert TODO heading with `org-insert-heading-respect-content' set to t."
  6951. (interactive "P")
  6952. (let ((org-insert-heading-respect-content t))
  6953. (org-insert-todo-heading force-state t)))
  6954. (defun org-insert-todo-heading (arg &optional force-heading)
  6955. "Insert a new heading with the same level and TODO state as current heading.
  6956. If the heading has no TODO state, or if the state is DONE, use the first
  6957. state (TODO by default). Also one prefix arg, force first state. With two
  6958. prefix args, force inserting at the end of the parent subtree."
  6959. (interactive "P")
  6960. (when (or force-heading (not (org-insert-item 'checkbox)))
  6961. (org-insert-heading (or (and (equal arg '(16)) '(16))
  6962. force-heading))
  6963. (save-excursion
  6964. (org-back-to-heading)
  6965. (outline-previous-heading)
  6966. (looking-at org-todo-line-regexp))
  6967. (let*
  6968. ((new-mark-x
  6969. (if (or arg
  6970. (not (match-beginning 2))
  6971. (member (match-string 2) org-done-keywords))
  6972. (car org-todo-keywords-1)
  6973. (match-string 2)))
  6974. (new-mark
  6975. (or
  6976. (run-hook-with-args-until-success
  6977. 'org-todo-get-default-hook new-mark-x nil)
  6978. new-mark-x)))
  6979. (beginning-of-line 1)
  6980. (and (looking-at org-outline-regexp) (goto-char (match-end 0))
  6981. (if org-treat-insert-todo-heading-as-state-change
  6982. (org-todo new-mark)
  6983. (insert new-mark " "))))
  6984. (when org-provide-todo-statistics
  6985. (org-update-parent-todo-statistics))))
  6986. (defun org-insert-subheading (arg)
  6987. "Insert a new subheading and demote it.
  6988. Works for outline headings and for plain lists alike."
  6989. (interactive "P")
  6990. (org-insert-heading arg)
  6991. (cond
  6992. ((org-at-heading-p) (org-do-demote))
  6993. ((org-at-item-p) (org-indent-item))))
  6994. (defun org-insert-todo-subheading (arg)
  6995. "Insert a new subheading with TODO keyword or checkbox and demote it.
  6996. Works for outline headings and for plain lists alike."
  6997. (interactive "P")
  6998. (org-insert-todo-heading arg)
  6999. (cond
  7000. ((org-at-heading-p) (org-do-demote))
  7001. ((org-at-item-p) (org-indent-item))))
  7002. ;;; Promotion and Demotion
  7003. (defvar org-after-demote-entry-hook nil
  7004. "Hook run after an entry has been demoted.
  7005. The cursor will be at the beginning of the entry.
  7006. When a subtree is being demoted, the hook will be called for each node.")
  7007. (defvar org-after-promote-entry-hook nil
  7008. "Hook run after an entry has been promoted.
  7009. The cursor will be at the beginning of the entry.
  7010. When a subtree is being promoted, the hook will be called for each node.")
  7011. (defun org-promote-subtree ()
  7012. "Promote the entire subtree.
  7013. See also `org-promote'."
  7014. (interactive)
  7015. (save-excursion
  7016. (org-with-limited-levels (org-map-tree 'org-promote)))
  7017. (org-fix-position-after-promote))
  7018. (defun org-demote-subtree ()
  7019. "Demote the entire subtree. See `org-demote'.
  7020. See also `org-promote'."
  7021. (interactive)
  7022. (save-excursion
  7023. (org-with-limited-levels (org-map-tree 'org-demote)))
  7024. (org-fix-position-after-promote))
  7025. (defun org-do-promote ()
  7026. "Promote the current heading higher up the tree.
  7027. If the region is active in `transient-mark-mode', promote all headings
  7028. in the region."
  7029. (interactive)
  7030. (save-excursion
  7031. (if (org-region-active-p)
  7032. (org-map-region 'org-promote (region-beginning) (region-end))
  7033. (org-promote)))
  7034. (org-fix-position-after-promote))
  7035. (defun org-do-demote ()
  7036. "Demote the current heading lower down the tree.
  7037. If the region is active in `transient-mark-mode', demote all headings
  7038. in the region."
  7039. (interactive)
  7040. (save-excursion
  7041. (if (org-region-active-p)
  7042. (org-map-region 'org-demote (region-beginning) (region-end))
  7043. (org-demote)))
  7044. (org-fix-position-after-promote))
  7045. (defun org-fix-position-after-promote ()
  7046. "Make sure that after pro/demotion cursor position is right."
  7047. (let ((pos (point)))
  7048. (when (save-excursion
  7049. (beginning-of-line 1)
  7050. (looking-at org-todo-line-regexp)
  7051. (or (equal pos (match-end 1)) (equal pos (match-end 2))))
  7052. (cond ((eobp) (insert " "))
  7053. ((eolp) (insert " "))
  7054. ((equal (char-after) ?\ ) (forward-char 1))))))
  7055. (defun org-current-level ()
  7056. "Return the level of the current entry, or nil if before the first headline.
  7057. The level is the number of stars at the beginning of the headline."
  7058. (save-excursion
  7059. (org-with-limited-levels
  7060. (if (ignore-errors (org-back-to-heading t))
  7061. (funcall outline-level)))))
  7062. (defun org-get-previous-line-level ()
  7063. "Return the outline depth of the last headline before the current line.
  7064. Returns 0 for the first headline in the buffer, and nil if before the
  7065. first headline."
  7066. (let ((current-level (org-current-level))
  7067. (prev-level (when (> (line-number-at-pos) 1)
  7068. (save-excursion
  7069. (beginning-of-line 0)
  7070. (org-current-level)))))
  7071. (cond ((null current-level) nil) ; Before first headline
  7072. ((null prev-level) 0) ; At first headline
  7073. (prev-level))))
  7074. (defun org-reduced-level (l)
  7075. "Compute the effective level of a heading.
  7076. This takes into account the setting of `org-odd-levels-only'."
  7077. (cond
  7078. ((zerop l) 0)
  7079. (org-odd-levels-only (1+ (floor (/ l 2))))
  7080. (t l)))
  7081. (defun org-level-increment ()
  7082. "Return the number of stars that will be added or removed at a
  7083. time to headlines when structure editing, based on the value of
  7084. `org-odd-levels-only'."
  7085. (if org-odd-levels-only 2 1))
  7086. (defun org-get-valid-level (level &optional change)
  7087. "Rectify a level change under the influence of `org-odd-levels-only'
  7088. LEVEL is a current level, CHANGE is by how much the level should be
  7089. modified. Even if CHANGE is nil, LEVEL may be returned modified because
  7090. even level numbers will become the next higher odd number."
  7091. (if org-odd-levels-only
  7092. (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
  7093. ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
  7094. ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
  7095. (max 1 (+ level (or change 0)))))
  7096. (if (boundp 'define-obsolete-function-alias)
  7097. (if (or (featurep 'xemacs) (< emacs-major-version 23))
  7098. (define-obsolete-function-alias 'org-get-legal-level
  7099. 'org-get-valid-level)
  7100. (define-obsolete-function-alias 'org-get-legal-level
  7101. 'org-get-valid-level "23.1")))
  7102. (defvar org-called-with-limited-levels nil) ;; Dynamically bound in
  7103. ;; ̀org-with-limited-levels'
  7104. (defun org-promote ()
  7105. "Promote the current heading higher up the tree.
  7106. If the region is active in `transient-mark-mode', promote all headings
  7107. in the region."
  7108. (org-back-to-heading t)
  7109. (let* ((level (save-match-data (funcall outline-level)))
  7110. (after-change-functions (remove 'flyspell-after-change-function
  7111. after-change-functions))
  7112. (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
  7113. (diff (abs (- level (length up-head) -1))))
  7114. (cond ((and (= level 1) org-called-with-limited-levels
  7115. org-allow-promoting-top-level-subtree)
  7116. (replace-match "# " nil t))
  7117. ((= level 1)
  7118. (user-error "Cannot promote to level 0. UNDO to recover if necessary"))
  7119. (t (replace-match up-head nil t)))
  7120. ;; Fixup tag positioning
  7121. (unless (= level 1)
  7122. (and org-auto-align-tags (org-set-tags nil t))
  7123. (if org-adapt-indentation (org-fixup-indentation (- diff))))
  7124. (run-hooks 'org-after-promote-entry-hook)))
  7125. (defun org-demote ()
  7126. "Demote the current heading lower down the tree.
  7127. If the region is active in `transient-mark-mode', demote all headings
  7128. in the region."
  7129. (org-back-to-heading t)
  7130. (let* ((level (save-match-data (funcall outline-level)))
  7131. (after-change-functions (remove 'flyspell-after-change-function
  7132. after-change-functions))
  7133. (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
  7134. (diff (abs (- level (length down-head) -1))))
  7135. (replace-match down-head nil t)
  7136. ;; Fixup tag positioning
  7137. (and org-auto-align-tags (org-set-tags nil t))
  7138. (if org-adapt-indentation (org-fixup-indentation diff))
  7139. (run-hooks 'org-after-demote-entry-hook)))
  7140. (defun org-cycle-level ()
  7141. "Cycle the level of an empty headline through possible states.
  7142. This goes first to child, then to parent, level, then up the hierarchy.
  7143. After top level, it switches back to sibling level."
  7144. (interactive)
  7145. (let ((org-adapt-indentation nil))
  7146. (when (org-point-at-end-of-empty-headline)
  7147. (setq this-command 'org-cycle-level) ; Only needed for caching
  7148. (let ((cur-level (org-current-level))
  7149. (prev-level (org-get-previous-line-level)))
  7150. (cond
  7151. ;; If first headline in file, promote to top-level.
  7152. ((= prev-level 0)
  7153. (loop repeat (/ (- cur-level 1) (org-level-increment))
  7154. do (org-do-promote)))
  7155. ;; If same level as prev, demote one.
  7156. ((= prev-level cur-level)
  7157. (org-do-demote))
  7158. ;; If parent is top-level, promote to top level if not already.
  7159. ((= prev-level 1)
  7160. (loop repeat (/ (- cur-level 1) (org-level-increment))
  7161. do (org-do-promote)))
  7162. ;; If top-level, return to prev-level.
  7163. ((= cur-level 1)
  7164. (loop repeat (/ (- prev-level 1) (org-level-increment))
  7165. do (org-do-demote)))
  7166. ;; If less than prev-level, promote one.
  7167. ((< cur-level prev-level)
  7168. (org-do-promote))
  7169. ;; If deeper than prev-level, promote until higher than
  7170. ;; prev-level.
  7171. ((> cur-level prev-level)
  7172. (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
  7173. do (org-do-promote))))
  7174. t))))
  7175. (defun org-map-tree (fun)
  7176. "Call FUN for every heading underneath the current one."
  7177. (org-back-to-heading)
  7178. (let ((level (funcall outline-level)))
  7179. (save-excursion
  7180. (funcall fun)
  7181. (while (and (progn
  7182. (outline-next-heading)
  7183. (> (funcall outline-level) level))
  7184. (not (eobp)))
  7185. (funcall fun)))))
  7186. (defun org-map-region (fun beg end)
  7187. "Call FUN for every heading between BEG and END."
  7188. (let ((org-ignore-region t))
  7189. (save-excursion
  7190. (setq end (copy-marker end))
  7191. (goto-char beg)
  7192. (if (and (re-search-forward org-outline-regexp-bol nil t)
  7193. (< (point) end))
  7194. (funcall fun))
  7195. (while (and (progn
  7196. (outline-next-heading)
  7197. (< (point) end))
  7198. (not (eobp)))
  7199. (funcall fun)))))
  7200. (defvar org-property-end-re) ; silence byte-compiler
  7201. (defun org-fixup-indentation (diff)
  7202. "Change the indentation in the current entry by DIFF.
  7203. However, if any line in the current entry has no indentation, or if it
  7204. would end up with no indentation after the change, nothing at all is done."
  7205. (save-excursion
  7206. (let ((end (save-excursion (outline-next-heading)
  7207. (point-marker)))
  7208. (prohibit (if (> diff 0)
  7209. "^\\S-"
  7210. (concat "^ \\{0," (int-to-string (- diff)) "\\}\\S-")))
  7211. col)
  7212. (unless (save-excursion (end-of-line 1)
  7213. (re-search-forward prohibit end t))
  7214. (while (and (< (point) end)
  7215. (re-search-forward "^[ \t]+" end t))
  7216. (goto-char (match-end 0))
  7217. (setq col (current-column))
  7218. (if (< diff 0) (replace-match ""))
  7219. (org-indent-to-column (+ diff col))))
  7220. (move-marker end nil))))
  7221. (defun org-convert-to-odd-levels ()
  7222. "Convert an org-mode file with all levels allowed to one with odd levels.
  7223. This will leave level 1 alone, convert level 2 to level 3, level 3 to
  7224. level 5 etc."
  7225. (interactive)
  7226. (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
  7227. (let ((outline-level 'org-outline-level)
  7228. (org-odd-levels-only nil) n)
  7229. (save-excursion
  7230. (goto-char (point-min))
  7231. (while (re-search-forward "^\\*\\*+ " nil t)
  7232. (setq n (- (length (match-string 0)) 2))
  7233. (while (>= (setq n (1- n)) 0)
  7234. (org-demote))
  7235. (end-of-line 1))))))
  7236. (defun org-convert-to-oddeven-levels ()
  7237. "Convert an org-mode file with only odd levels to one with odd/even levels.
  7238. This promotes level 3 to level 2, level 5 to level 3 etc. If the
  7239. file contains a section with an even level, conversion would
  7240. destroy the structure of the file. An error is signaled in this
  7241. case."
  7242. (interactive)
  7243. (goto-char (point-min))
  7244. ;; First check if there are no even levels
  7245. (when (re-search-forward "^\\(\\*\\*\\)+ " nil t)
  7246. (org-show-context t)
  7247. (error "Not all levels are odd in this file. Conversion not possible"))
  7248. (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
  7249. (let ((outline-regexp org-outline-regexp)
  7250. (outline-level 'org-outline-level)
  7251. (org-odd-levels-only nil) n)
  7252. (save-excursion
  7253. (goto-char (point-min))
  7254. (while (re-search-forward "^\\*\\*+ " nil t)
  7255. (setq n (/ (1- (length (match-string 0))) 2))
  7256. (while (>= (setq n (1- n)) 0)
  7257. (org-promote))
  7258. (end-of-line 1))))))
  7259. (defun org-tr-level (n)
  7260. "Make N odd if required."
  7261. (if org-odd-levels-only (1+ (/ n 2)) n))
  7262. ;;; Vertical tree motion, cutting and pasting of subtrees
  7263. (defun org-move-subtree-up (&optional arg)
  7264. "Move the current subtree up past ARG headlines of the same level."
  7265. (interactive "p")
  7266. (org-move-subtree-down (- (prefix-numeric-value arg))))
  7267. (defun org-move-subtree-down (&optional arg)
  7268. "Move the current subtree down past ARG headlines of the same level."
  7269. (interactive "p")
  7270. (setq arg (prefix-numeric-value arg))
  7271. (let ((movfunc (if (> arg 0) 'org-get-next-sibling
  7272. 'org-get-last-sibling))
  7273. (ins-point (make-marker))
  7274. (cnt (abs arg))
  7275. (col (current-column))
  7276. beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
  7277. ;; Select the tree
  7278. (org-back-to-heading)
  7279. (setq beg0 (point))
  7280. (save-excursion
  7281. (setq ne-beg (org-back-over-empty-lines))
  7282. (setq beg (point)))
  7283. (save-match-data
  7284. (save-excursion (outline-end-of-heading)
  7285. (setq folded (outline-invisible-p)))
  7286. (outline-end-of-subtree))
  7287. (outline-next-heading)
  7288. (setq ne-end (org-back-over-empty-lines))
  7289. (setq end (point))
  7290. (goto-char beg0)
  7291. (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
  7292. ;; include less whitespace
  7293. (save-excursion
  7294. (goto-char beg)
  7295. (forward-line (- ne-beg ne-end))
  7296. (setq beg (point))))
  7297. ;; Find insertion point, with error handling
  7298. (while (> cnt 0)
  7299. (or (and (funcall movfunc) (looking-at org-outline-regexp))
  7300. (progn (goto-char beg0)
  7301. (user-error "Cannot move past superior level or buffer limit")))
  7302. (setq cnt (1- cnt)))
  7303. (if (> arg 0)
  7304. ;; Moving forward - still need to move over subtree
  7305. (progn (org-end-of-subtree t t)
  7306. (save-excursion
  7307. (org-back-over-empty-lines)
  7308. (or (bolp) (newline)))))
  7309. (setq ne-ins (org-back-over-empty-lines))
  7310. (move-marker ins-point (point))
  7311. (setq txt (buffer-substring beg end))
  7312. (org-save-markers-in-region beg end)
  7313. (delete-region beg end)
  7314. (org-remove-empty-overlays-at beg)
  7315. (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
  7316. (or (bobp) (outline-flag-region (1- (point)) (point) nil))
  7317. (and (not (bolp)) (looking-at "\n") (forward-char 1))
  7318. (let ((bbb (point)))
  7319. (insert-before-markers txt)
  7320. (org-reinstall-markers-in-region bbb)
  7321. (move-marker ins-point bbb))
  7322. (or (bolp) (insert "\n"))
  7323. (setq ins-end (point))
  7324. (goto-char ins-point)
  7325. (org-skip-whitespace)
  7326. (when (and (< arg 0)
  7327. (org-first-sibling-p)
  7328. (> ne-ins ne-beg))
  7329. ;; Move whitespace back to beginning
  7330. (save-excursion
  7331. (goto-char ins-end)
  7332. (let ((kill-whole-line t))
  7333. (kill-line (- ne-ins ne-beg)) (point)))
  7334. (insert (make-string (- ne-ins ne-beg) ?\n)))
  7335. (move-marker ins-point nil)
  7336. (if folded
  7337. (hide-subtree)
  7338. (org-show-entry)
  7339. (show-children)
  7340. (org-cycle-hide-drawers 'children))
  7341. (org-clean-visibility-after-subtree-move)
  7342. ;; move back to the initial column we were at
  7343. (move-to-column col)))
  7344. (defvar org-subtree-clip ""
  7345. "Clipboard for cut and paste of subtrees.
  7346. This is actually only a copy of the kill, because we use the normal kill
  7347. ring. We need it to check if the kill was created by `org-copy-subtree'.")
  7348. (defvar org-subtree-clip-folded nil
  7349. "Was the last copied subtree folded?
  7350. This is used to fold the tree back after pasting.")
  7351. (defun org-cut-subtree (&optional n)
  7352. "Cut the current subtree into the clipboard.
  7353. With prefix arg N, cut this many sequential subtrees.
  7354. This is a short-hand for marking the subtree and then cutting it."
  7355. (interactive "p")
  7356. (org-copy-subtree n 'cut))
  7357. (defun org-copy-subtree (&optional n cut force-store-markers nosubtrees)
  7358. "Copy the current subtree it in the clipboard.
  7359. With prefix arg N, copy this many sequential subtrees.
  7360. This is a short-hand for marking the subtree and then copying it.
  7361. If CUT is non-nil, actually cut the subtree.
  7362. If FORCE-STORE-MARKERS is non-nil, store the relative locations
  7363. of some markers in the region, even if CUT is non-nil. This is
  7364. useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
  7365. (interactive "p")
  7366. (let (beg end folded (beg0 (point)))
  7367. (if (org-called-interactively-p 'any)
  7368. (org-back-to-heading nil) ; take what looks like a subtree
  7369. (org-back-to-heading t)) ; take what is really there
  7370. (setq beg (point))
  7371. (skip-chars-forward " \t\r\n")
  7372. (save-match-data
  7373. (if nosubtrees
  7374. (outline-next-heading)
  7375. (save-excursion (outline-end-of-heading)
  7376. (setq folded (outline-invisible-p)))
  7377. (condition-case nil
  7378. (org-forward-heading-same-level (1- n) t)
  7379. (error nil))
  7380. (org-end-of-subtree t t)))
  7381. (setq end (point))
  7382. (goto-char beg0)
  7383. (when (> end beg)
  7384. (setq org-subtree-clip-folded folded)
  7385. (when (or cut force-store-markers)
  7386. (org-save-markers-in-region beg end))
  7387. (if cut (kill-region beg end) (copy-region-as-kill beg end))
  7388. (setq org-subtree-clip (current-kill 0))
  7389. (message "%s: Subtree(s) with %d characters"
  7390. (if cut "Cut" "Copied")
  7391. (length org-subtree-clip)))))
  7392. (defun org-paste-subtree (&optional level tree for-yank)
  7393. "Paste the clipboard as a subtree, with modification of headline level.
  7394. The entire subtree is promoted or demoted in order to match a new headline
  7395. level.
  7396. If the cursor is at the beginning of a headline, the same level as
  7397. that headline is used to paste the tree.
  7398. If not, the new level is derived from the *visible* headings
  7399. before and after the insertion point, and taken to be the inferior headline
  7400. level of the two. So if the previous visible heading is level 3 and the
  7401. next is level 4 (or vice versa), level 4 will be used for insertion.
  7402. This makes sure that the subtree remains an independent subtree and does
  7403. not swallow low level entries.
  7404. You can also force a different level, either by using a numeric prefix
  7405. argument, or by inserting the heading marker by hand. For example, if the
  7406. cursor is after \"*****\", then the tree will be shifted to level 5.
  7407. If optional TREE is given, use this text instead of the kill ring.
  7408. When FOR-YANK is set, this is called by `org-yank'. In this case, do not
  7409. move back over whitespace before inserting, and move point to the end of
  7410. the inserted text when done."
  7411. (interactive "P")
  7412. (setq tree (or tree (and kill-ring (current-kill 0))))
  7413. (unless (org-kill-is-subtree-p tree)
  7414. (user-error "%s"
  7415. (substitute-command-keys
  7416. "The kill is not a (set of) tree(s) - please use \\[yank] to yank anyway")))
  7417. (org-with-limited-levels
  7418. (let* ((visp (not (outline-invisible-p)))
  7419. (txt tree)
  7420. (^re_ "\\(\\*+\\)[ \t]*")
  7421. (old-level (if (string-match org-outline-regexp-bol txt)
  7422. (- (match-end 0) (match-beginning 0) 1)
  7423. -1))
  7424. (force-level (cond (level (prefix-numeric-value level))
  7425. ((and (looking-at "[ \t]*$")
  7426. (string-match
  7427. "^\\*+$" (buffer-substring
  7428. (point-at-bol) (point))))
  7429. (- (match-end 1) (match-beginning 1)))
  7430. ((and (bolp)
  7431. (looking-at org-outline-regexp))
  7432. (- (match-end 0) (point) 1))))
  7433. (previous-level (save-excursion
  7434. (condition-case nil
  7435. (progn
  7436. (outline-previous-visible-heading 1)
  7437. (if (looking-at ^re_)
  7438. (- (match-end 0) (match-beginning 0) 1)
  7439. 1))
  7440. (error 1))))
  7441. (next-level (save-excursion
  7442. (condition-case nil
  7443. (progn
  7444. (or (looking-at org-outline-regexp)
  7445. (outline-next-visible-heading 1))
  7446. (if (looking-at ^re_)
  7447. (- (match-end 0) (match-beginning 0) 1)
  7448. 1))
  7449. (error 1))))
  7450. (new-level (or force-level (max previous-level next-level)))
  7451. (shift (if (or (= old-level -1)
  7452. (= new-level -1)
  7453. (= old-level new-level))
  7454. 0
  7455. (- new-level old-level)))
  7456. (delta (if (> shift 0) -1 1))
  7457. (func (if (> shift 0) 'org-demote 'org-promote))
  7458. (org-odd-levels-only nil)
  7459. beg end newend)
  7460. ;; Remove the forced level indicator
  7461. (if force-level
  7462. (delete-region (point-at-bol) (point)))
  7463. ;; Paste
  7464. (beginning-of-line (if (bolp) 1 2))
  7465. (setq beg (point))
  7466. (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
  7467. (insert-before-markers txt)
  7468. (unless (string-match "\n\\'" txt) (insert "\n"))
  7469. (setq newend (point))
  7470. (org-reinstall-markers-in-region beg)
  7471. (setq end (point))
  7472. (goto-char beg)
  7473. (skip-chars-forward " \t\n\r")
  7474. (setq beg (point))
  7475. (if (and (outline-invisible-p) visp)
  7476. (save-excursion (outline-show-heading)))
  7477. ;; Shift if necessary
  7478. (unless (= shift 0)
  7479. (save-restriction
  7480. (narrow-to-region beg end)
  7481. (while (not (= shift 0))
  7482. (org-map-region func (point-min) (point-max))
  7483. (setq shift (+ delta shift)))
  7484. (goto-char (point-min))
  7485. (setq newend (point-max))))
  7486. (when (or (org-called-interactively-p 'interactive) for-yank)
  7487. (message "Clipboard pasted as level %d subtree" new-level))
  7488. (if (and (not for-yank) ; in this case, org-yank will decide about folding
  7489. kill-ring
  7490. (eq org-subtree-clip (current-kill 0))
  7491. org-subtree-clip-folded)
  7492. ;; The tree was folded before it was killed/copied
  7493. (hide-subtree))
  7494. (and for-yank (goto-char newend)))))
  7495. (defun org-kill-is-subtree-p (&optional txt)
  7496. "Check if the current kill is an outline subtree, or a set of trees.
  7497. Returns nil if kill does not start with a headline, or if the first
  7498. headline level is not the largest headline level in the tree.
  7499. So this will actually accept several entries of equal levels as well,
  7500. which is OK for `org-paste-subtree'.
  7501. If optional TXT is given, check this string instead of the current kill."
  7502. (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
  7503. (re (org-get-limited-outline-regexp))
  7504. (^re (concat "^" re))
  7505. (start-level (and kill
  7506. (string-match
  7507. (concat "\\`\\([ \t\n\r]*?\n\\)?\\(" re "\\)")
  7508. kill)
  7509. (- (match-end 2) (match-beginning 2) 1)))
  7510. (start (1+ (or (match-beginning 2) -1))))
  7511. (if (not start-level)
  7512. (progn
  7513. nil) ;; does not even start with a heading
  7514. (catch 'exit
  7515. (while (setq start (string-match ^re kill (1+ start)))
  7516. (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
  7517. (throw 'exit nil)))
  7518. t))))
  7519. (defvar org-markers-to-move nil
  7520. "Markers that should be moved with a cut-and-paste operation.
  7521. Those markers are stored together with their positions relative to
  7522. the start of the region.")
  7523. (defun org-save-markers-in-region (beg end)
  7524. "Check markers in region.
  7525. If these markers are between BEG and END, record their position relative
  7526. to BEG, so that after moving the block of text, we can put the markers back
  7527. into place.
  7528. This function gets called just before an entry or tree gets cut from the
  7529. buffer. After re-insertion, `org-reinstall-markers-in-region' must be
  7530. called immediately, to move the markers with the entries."
  7531. (setq org-markers-to-move nil)
  7532. (when (featurep 'org-clock)
  7533. (org-clock-save-markers-for-cut-and-paste beg end))
  7534. (when (featurep 'org-agenda)
  7535. (org-agenda-save-markers-for-cut-and-paste beg end)))
  7536. (defun org-check-and-save-marker (marker beg end)
  7537. "Check if MARKER is between BEG and END.
  7538. If yes, remember the marker and the distance to BEG."
  7539. (when (and (marker-buffer marker)
  7540. (equal (marker-buffer marker) (current-buffer)))
  7541. (if (and (>= marker beg) (< marker end))
  7542. (push (cons marker (- marker beg)) org-markers-to-move))))
  7543. (defun org-reinstall-markers-in-region (beg)
  7544. "Move all remembered markers to their position relative to BEG."
  7545. (mapc (lambda (x)
  7546. (move-marker (car x) (+ beg (cdr x))))
  7547. org-markers-to-move)
  7548. (setq org-markers-to-move nil))
  7549. (defun org-narrow-to-subtree ()
  7550. "Narrow buffer to the current subtree."
  7551. (interactive)
  7552. (save-excursion
  7553. (save-match-data
  7554. (org-with-limited-levels
  7555. (narrow-to-region
  7556. (progn (org-back-to-heading t) (point))
  7557. (progn (org-end-of-subtree t t)
  7558. (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
  7559. (point)))))))
  7560. (defun org-narrow-to-block ()
  7561. "Narrow buffer to the current block."
  7562. (interactive)
  7563. (let* ((case-fold-search t)
  7564. (blockp (org-between-regexps-p "^[ \t]*#\\+begin_.*"
  7565. "^[ \t]*#\\+end_.*")))
  7566. (if blockp
  7567. (narrow-to-region (car blockp) (cdr blockp))
  7568. (user-error "Not in a block"))))
  7569. (eval-when-compile
  7570. (defvar org-property-drawer-re))
  7571. (defvar org-property-start-re) ;; defined below
  7572. (defun org-clone-subtree-with-time-shift (n &optional shift)
  7573. "Clone the task (subtree) at point N times.
  7574. The clones will be inserted as siblings.
  7575. In interactive use, the user will be prompted for the number of
  7576. clones to be produced. If the entry has a timestamp, the user
  7577. will also be prompted for a time shift, which may be a repeater
  7578. as used in time stamps, for example `+3d'. To disable this,
  7579. you can call the function with a universal prefix argument.
  7580. When a valid repeater is given and the entry contains any time
  7581. stamps, the clones will become a sequence in time, with time
  7582. stamps in the subtree shifted for each clone produced. If SHIFT
  7583. is nil or the empty string, time stamps will be left alone. The
  7584. ID property of the original subtree is removed.
  7585. If the original subtree did contain time stamps with a repeater,
  7586. the following will happen:
  7587. - the repeater will be removed in each clone
  7588. - an additional clone will be produced, with the current, unshifted
  7589. date(s) in the entry.
  7590. - the original entry will be placed *after* all the clones, with
  7591. repeater intact.
  7592. - the start days in the repeater in the original entry will be shifted
  7593. to past the last clone.
  7594. In this way you can spell out a number of instances of a repeating task,
  7595. and still retain the repeater to cover future instances of the task."
  7596. (interactive "nNumber of clones to produce: ")
  7597. (let ((shift
  7598. (or shift
  7599. (if (and (not (equal current-prefix-arg '(4)))
  7600. (save-excursion
  7601. (re-search-forward org-ts-regexp-both
  7602. (save-excursion
  7603. (org-end-of-subtree t)
  7604. (point)) t)))
  7605. (read-from-minibuffer
  7606. "Date shift per clone (e.g. +1w, empty to copy unchanged): ")
  7607. ""))) ;; No time shift
  7608. (n-no-remove -1)
  7609. (drawer-re org-drawer-regexp)
  7610. beg end template task idprop
  7611. shift-n shift-what doshift nmin nmax)
  7612. (if (not (and (integerp n) (> n 0)))
  7613. (error "Invalid number of replications %s" n))
  7614. (if (and (setq doshift (and (stringp shift) (string-match "\\S-" shift)))
  7615. (not (string-match "\\`[ \t]*\\+?\\([0-9]+\\)\\([hdwmy]\\)[ \t]*\\'"
  7616. shift)))
  7617. (error "Invalid shift specification %s" shift))
  7618. (when doshift
  7619. (setq shift-n (string-to-number (match-string 1 shift))
  7620. shift-what (cdr (assoc (match-string 2 shift)
  7621. '(("d" . day) ("w" . week)
  7622. ("m" . month) ("y" . year))))))
  7623. (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
  7624. (setq nmin 1 nmax n)
  7625. (org-back-to-heading t)
  7626. (setq beg (point))
  7627. (setq idprop (org-entry-get nil "ID"))
  7628. (org-end-of-subtree t t)
  7629. (or (bolp) (insert "\n"))
  7630. (setq end (point))
  7631. (setq template (buffer-substring beg end))
  7632. (when (and doshift
  7633. (string-match "<[^<>\n]+ [.+]?\\+[0-9]+[hdwmy][^<>\n]*>" template))
  7634. (delete-region beg end)
  7635. (setq end beg)
  7636. (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
  7637. (goto-char end)
  7638. (loop for n from nmin to nmax do
  7639. ;; prepare clone
  7640. (with-temp-buffer
  7641. (insert template)
  7642. (org-mode)
  7643. (goto-char (point-min))
  7644. (org-show-subtree)
  7645. (and idprop (if org-clone-delete-id
  7646. (org-entry-delete nil "ID")
  7647. (org-id-get-create t)))
  7648. (unless (= n 0)
  7649. (while (re-search-forward "^[ \t]*CLOCK:.*$" nil t)
  7650. (kill-whole-line))
  7651. (goto-char (point-min))
  7652. (while (re-search-forward drawer-re nil t)
  7653. (mapc (lambda (d)
  7654. (org-remove-empty-drawer-at d (point))) org-drawers)))
  7655. (goto-char (point-min))
  7656. (when doshift
  7657. (while (re-search-forward org-ts-regexp-both nil t)
  7658. (org-timestamp-change (* n shift-n) shift-what))
  7659. (unless (= n n-no-remove)
  7660. (goto-char (point-min))
  7661. (while (re-search-forward org-ts-regexp nil t)
  7662. (save-excursion
  7663. (goto-char (match-beginning 0))
  7664. (if (looking-at "<[^<>\n]+\\( +[.+]?\\+[0-9]+[hdwmy]\\)")
  7665. (delete-region (match-beginning 1) (match-end 1)))))))
  7666. (setq task (buffer-string)))
  7667. (insert task))
  7668. (goto-char beg)))
  7669. ;;; Outline Sorting
  7670. (defun org-sort (with-case)
  7671. "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
  7672. Optional argument WITH-CASE means sort case-sensitively."
  7673. (interactive "P")
  7674. (cond
  7675. ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
  7676. ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
  7677. (t
  7678. (org-call-with-arg 'org-sort-entries with-case))))
  7679. (defun org-sort-remove-invisible (s)
  7680. "Remove invisible links from string S."
  7681. (remove-text-properties 0 (length s) org-rm-props s)
  7682. (while (string-match org-bracket-link-regexp s)
  7683. (setq s (replace-match (if (match-end 2)
  7684. (match-string 3 s)
  7685. (match-string 1 s)) t t s)))
  7686. (let ((st (format " %s " s)))
  7687. (while (string-match org-emph-re st)
  7688. (setq st (replace-match (format " %s " (match-string 4 st)) t t st)))
  7689. (setq s (substring st 1 -1)))
  7690. s)
  7691. (defvar org-priority-regexp) ; defined later in the file
  7692. (defvar org-after-sorting-entries-or-items-hook nil
  7693. "Hook that is run after a bunch of entries or items have been sorted.
  7694. When children are sorted, the cursor is in the parent line when this
  7695. hook gets called. When a region or a plain list is sorted, the cursor
  7696. will be in the first entry of the sorted region/list.")
  7697. (defun org-sort-entries
  7698. (&optional with-case sorting-type getkey-func compare-func property)
  7699. "Sort entries on a certain level of an outline tree.
  7700. If there is an active region, the entries in the region are sorted.
  7701. Else, if the cursor is before the first entry, sort the top-level items.
  7702. Else, the children of the entry at point are sorted.
  7703. Sorting can be alphabetically, numerically, by date/time as given by
  7704. a time stamp, by a property, by priority order, or by a custom function.
  7705. The command prompts for the sorting type unless it has been given to the
  7706. function through the SORTING-TYPE argument, which needs to be a character,
  7707. \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?o ?O ?r ?R ?f ?F). Here is the
  7708. precise meaning of each character:
  7709. n Numerically, by converting the beginning of the entry/item to a number.
  7710. a Alphabetically, ignoring the TODO keyword and the priority, if any.
  7711. o By order of TODO keywords.
  7712. t By date/time, either the first active time stamp in the entry, or, if
  7713. none exist, by the first inactive one.
  7714. s By the scheduled date/time.
  7715. d By deadline date/time.
  7716. c By creation time, which is assumed to be the first inactive time stamp
  7717. at the beginning of a line.
  7718. p By priority according to the cookie.
  7719. r By the value of a property.
  7720. Capital letters will reverse the sort order.
  7721. If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
  7722. called with point at the beginning of the record. It must return either
  7723. a string or a number that should serve as the sorting key for that record.
  7724. Comparing entries ignores case by default. However, with an optional argument
  7725. WITH-CASE, the sorting considers case as well.
  7726. Sorting is done against the visible part of the headlines, it ignores hidden
  7727. links."
  7728. (interactive "P")
  7729. (let ((case-func (if with-case 'identity 'downcase))
  7730. (cmstr
  7731. ;; The clock marker is lost when using `sort-subr', let's
  7732. ;; store the clocking string.
  7733. (when (equal (marker-buffer org-clock-marker) (current-buffer))
  7734. (save-excursion
  7735. (goto-char org-clock-marker)
  7736. (looking-back "^.*") (match-string-no-properties 0))))
  7737. start beg end stars re re2
  7738. txt what tmp)
  7739. ;; Find beginning and end of region to sort
  7740. (cond
  7741. ((org-region-active-p)
  7742. ;; we will sort the region
  7743. (setq end (region-end)
  7744. what "region")
  7745. (goto-char (region-beginning))
  7746. (if (not (org-at-heading-p)) (outline-next-heading))
  7747. (setq start (point)))
  7748. ((or (org-at-heading-p)
  7749. (condition-case nil (progn (org-back-to-heading) t) (error nil)))
  7750. ;; we will sort the children of the current headline
  7751. (org-back-to-heading)
  7752. (setq start (point)
  7753. end (progn (org-end-of-subtree t t)
  7754. (or (bolp) (insert "\n"))
  7755. (org-back-over-empty-lines)
  7756. (point))
  7757. what "children")
  7758. (goto-char start)
  7759. (show-subtree)
  7760. (outline-next-heading))
  7761. (t
  7762. ;; we will sort the top-level entries in this file
  7763. (goto-char (point-min))
  7764. (or (org-at-heading-p) (outline-next-heading))
  7765. (setq start (point))
  7766. (goto-char (point-max))
  7767. (beginning-of-line 1)
  7768. (when (looking-at ".*?\\S-")
  7769. ;; File ends in a non-white line
  7770. (end-of-line 1)
  7771. (insert "\n"))
  7772. (setq end (point-max))
  7773. (setq what "top-level")
  7774. (goto-char start)
  7775. (show-all)))
  7776. (setq beg (point))
  7777. (if (>= beg end) (user-error "Nothing to sort"))
  7778. (looking-at "\\(\\*+\\)")
  7779. (setq stars (match-string 1)
  7780. re (concat "^" (regexp-quote stars) " +")
  7781. re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[ \t\n]")
  7782. txt (buffer-substring beg end))
  7783. (if (not (equal (substring txt -1) "\n")) (setq txt (concat txt "\n")))
  7784. (if (and (not (equal stars "*")) (string-match re2 txt))
  7785. (user-error "Region to sort contains a level above the first entry"))
  7786. (unless sorting-type
  7787. (message
  7788. "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
  7789. [t]ime [s]cheduled [d]eadline [c]reated
  7790. A/N/P/R/O/F/T/S/D/C means reversed:"
  7791. what)
  7792. (setq sorting-type (read-char-exclusive))
  7793. (unless getkey-func
  7794. (and (= (downcase sorting-type) ?f)
  7795. (setq getkey-func
  7796. (org-icompleting-read "Sort using function: "
  7797. obarray 'fboundp t nil nil))
  7798. (setq getkey-func (intern getkey-func))))
  7799. (and (= (downcase sorting-type) ?r)
  7800. (not property)
  7801. (setq property
  7802. (org-icompleting-read "Property: "
  7803. (mapcar 'list (org-buffer-property-keys t))
  7804. nil t))))
  7805. (message "Sorting entries...")
  7806. (save-restriction
  7807. (narrow-to-region start end)
  7808. (let ((dcst (downcase sorting-type))
  7809. (case-fold-search nil)
  7810. (now (current-time)))
  7811. (sort-subr
  7812. (/= dcst sorting-type)
  7813. ;; This function moves to the beginning character of the "record" to
  7814. ;; be sorted.
  7815. (lambda nil
  7816. (if (re-search-forward re nil t)
  7817. (goto-char (match-beginning 0))
  7818. (goto-char (point-max))))
  7819. ;; This function moves to the last character of the "record" being
  7820. ;; sorted.
  7821. (lambda nil
  7822. (save-match-data
  7823. (condition-case nil
  7824. (outline-forward-same-level 1)
  7825. (error
  7826. (goto-char (point-max))))))
  7827. ;; This function returns the value that gets sorted against.
  7828. (lambda nil
  7829. (cond
  7830. ((= dcst ?n)
  7831. (if (looking-at org-complex-heading-regexp)
  7832. (string-to-number (org-sort-remove-invisible (match-string 4)))
  7833. nil))
  7834. ((= dcst ?a)
  7835. (if (looking-at org-complex-heading-regexp)
  7836. (funcall case-func (org-sort-remove-invisible (match-string 4)))
  7837. nil))
  7838. ((= dcst ?t)
  7839. (let ((end (save-excursion (outline-next-heading) (point))))
  7840. (if (or (re-search-forward org-ts-regexp end t)
  7841. (re-search-forward org-ts-regexp-both end t))
  7842. (org-time-string-to-seconds (match-string 0))
  7843. (org-float-time now))))
  7844. ((= dcst ?c)
  7845. (let ((end (save-excursion (outline-next-heading) (point))))
  7846. (if (re-search-forward
  7847. (concat "^[ \t]*\\[" org-ts-regexp1 "\\]")
  7848. end t)
  7849. (org-time-string-to-seconds (match-string 0))
  7850. (org-float-time now))))
  7851. ((= dcst ?s)
  7852. (let ((end (save-excursion (outline-next-heading) (point))))
  7853. (if (re-search-forward org-scheduled-time-regexp end t)
  7854. (org-time-string-to-seconds (match-string 1))
  7855. (org-float-time now))))
  7856. ((= dcst ?d)
  7857. (let ((end (save-excursion (outline-next-heading) (point))))
  7858. (if (re-search-forward org-deadline-time-regexp end t)
  7859. (org-time-string-to-seconds (match-string 1))
  7860. (org-float-time now))))
  7861. ((= dcst ?p)
  7862. (if (re-search-forward org-priority-regexp (point-at-eol) t)
  7863. (string-to-char (match-string 2))
  7864. org-default-priority))
  7865. ((= dcst ?r)
  7866. (or (org-entry-get nil property) ""))
  7867. ((= dcst ?o)
  7868. (if (looking-at org-complex-heading-regexp)
  7869. (- 9999 (length (member (match-string 2)
  7870. org-todo-keywords-1)))))
  7871. ((= dcst ?f)
  7872. (if getkey-func
  7873. (progn
  7874. (setq tmp (funcall getkey-func))
  7875. (if (stringp tmp) (setq tmp (funcall case-func tmp)))
  7876. tmp)
  7877. (error "Invalid key function `%s'" getkey-func)))
  7878. (t (error "Invalid sorting type `%c'" sorting-type))))
  7879. nil
  7880. (cond
  7881. ((= dcst ?a) 'string<)
  7882. ((= dcst ?f) compare-func)
  7883. ((member dcst '(?p ?t ?s ?d ?c)) '<)))))
  7884. (run-hooks 'org-after-sorting-entries-or-items-hook)
  7885. ;; Reset the clock marker if needed
  7886. (when cmstr
  7887. (save-excursion
  7888. (goto-char start)
  7889. (search-forward cmstr nil t)
  7890. (move-marker org-clock-marker (point))))
  7891. (message "Sorting entries...done")))
  7892. (defun org-do-sort (table what &optional with-case sorting-type)
  7893. "Sort TABLE of WHAT according to SORTING-TYPE.
  7894. The user will be prompted for the SORTING-TYPE if the call to this
  7895. function does not specify it. WHAT is only for the prompt, to indicate
  7896. what is being sorted. The sorting key will be extracted from
  7897. the car of the elements of the table.
  7898. If WITH-CASE is non-nil, the sorting will be case-sensitive."
  7899. (unless sorting-type
  7900. (message
  7901. "Sort %s: [a]lphabetic, [n]umeric, [t]ime. A/N/T means reversed:"
  7902. what)
  7903. (setq sorting-type (read-char-exclusive)))
  7904. (let ((dcst (downcase sorting-type))
  7905. extractfun comparefun)
  7906. ;; Define the appropriate functions
  7907. (cond
  7908. ((= dcst ?n)
  7909. (setq extractfun 'string-to-number
  7910. comparefun (if (= dcst sorting-type) '< '>)))
  7911. ((= dcst ?a)
  7912. (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
  7913. (lambda(x) (downcase (org-sort-remove-invisible x))))
  7914. comparefun (if (= dcst sorting-type)
  7915. 'string<
  7916. (lambda (a b) (and (not (string< a b))
  7917. (not (string= a b)))))))
  7918. ((= dcst ?t)
  7919. (setq extractfun
  7920. (lambda (x)
  7921. (if (or (string-match org-ts-regexp x)
  7922. (string-match org-ts-regexp-both x))
  7923. (org-float-time
  7924. (org-time-string-to-time (match-string 0 x)))
  7925. 0))
  7926. comparefun (if (= dcst sorting-type) '< '>)))
  7927. (t (error "Invalid sorting type `%c'" sorting-type)))
  7928. (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
  7929. table)
  7930. (lambda (a b) (funcall comparefun (car a) (car b))))))
  7931. ;;; The orgstruct minor mode
  7932. ;; Define a minor mode which can be used in other modes in order to
  7933. ;; integrate the org-mode structure editing commands.
  7934. ;; This is really a hack, because the org-mode structure commands use
  7935. ;; keys which normally belong to the major mode. Here is how it
  7936. ;; works: The minor mode defines all the keys necessary to operate the
  7937. ;; structure commands, but wraps the commands into a function which
  7938. ;; tests if the cursor is currently at a headline or a plain list
  7939. ;; item. If that is the case, the structure command is used,
  7940. ;; temporarily setting many Org-mode variables like regular
  7941. ;; expressions for filling etc. However, when any of those keys is
  7942. ;; used at a different location, function uses `key-binding' to look
  7943. ;; up if the key has an associated command in another currently active
  7944. ;; keymap (minor modes, major mode, global), and executes that
  7945. ;; command. There might be problems if any of the keys is otherwise
  7946. ;; used as a prefix key.
  7947. (defcustom orgstruct-heading-prefix-regexp nil
  7948. "Regexp that matches the custom prefix of Org headlines in
  7949. orgstruct(++)-mode."
  7950. :group 'org
  7951. :version "24.4"
  7952. :package-version '(Org . "8.0")
  7953. :type 'string)
  7954. ;;;###autoload(put 'orgstruct-heading-prefix-regexp 'safe-local-variable 'stringp)
  7955. (defcustom orgstruct-setup-hook nil
  7956. "Hook run after orgstruct-mode-map is filled."
  7957. :group 'org
  7958. :version "24.4"
  7959. :package-version '(Org . "8.0")
  7960. :type 'hook)
  7961. (defvar orgstruct-initialized nil)
  7962. (defvar org-local-vars nil
  7963. "List of local variables, for use by `orgstruct-mode'.")
  7964. ;;;###autoload
  7965. (define-minor-mode orgstruct-mode
  7966. "Toggle the minor mode `orgstruct-mode'.
  7967. This mode is for using Org-mode structure commands in other
  7968. modes. The following keys behave as if Org-mode were active, if
  7969. the cursor is on a headline, or on a plain list item (both as
  7970. defined by Org-mode)."
  7971. nil " OrgStruct" (make-sparse-keymap)
  7972. (funcall (if orgstruct-mode
  7973. 'add-to-invisibility-spec
  7974. 'remove-from-invisibility-spec)
  7975. '(outline . t))
  7976. (when orgstruct-mode
  7977. (org-load-modules-maybe)
  7978. (unless orgstruct-initialized
  7979. (orgstruct-setup)
  7980. (setq orgstruct-initialized t))))
  7981. ;;;###autoload
  7982. (defun turn-on-orgstruct ()
  7983. "Unconditionally turn on `orgstruct-mode'."
  7984. (orgstruct-mode 1))
  7985. (defvar org-fb-vars nil)
  7986. (make-variable-buffer-local 'org-fb-vars)
  7987. (defun orgstruct++-mode (&optional arg)
  7988. "Toggle `orgstruct-mode', the enhanced version of it.
  7989. In addition to setting orgstruct-mode, this also exports all
  7990. indentation and autofilling variables from org-mode into the
  7991. buffer. It will also recognize item context in multiline items."
  7992. (interactive "P")
  7993. (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
  7994. (if (< arg 1)
  7995. (progn (orgstruct-mode -1)
  7996. (mapc (lambda(v)
  7997. (org-set-local (car v)
  7998. (if (eq (car-safe (cadr v)) 'quote) (cadadr v) (cadr v))))
  7999. org-fb-vars))
  8000. (orgstruct-mode 1)
  8001. (setq org-fb-vars nil)
  8002. (unless org-local-vars
  8003. (setq org-local-vars (org-get-local-variables)))
  8004. (let (var val)
  8005. (mapc
  8006. (lambda (x)
  8007. (when (string-match
  8008. "^\\(paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|fill-prefix\\|indent-\\)"
  8009. (symbol-name (car x)))
  8010. (setq var (car x) val (nth 1 x))
  8011. (push (list var `(quote ,(eval var))) org-fb-vars)
  8012. (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
  8013. org-local-vars)
  8014. (org-set-local 'orgstruct-is-++ t))))
  8015. (defvar orgstruct-is-++ nil
  8016. "Is `orgstruct-mode' in ++ version in the current-buffer?")
  8017. (make-variable-buffer-local 'orgstruct-is-++)
  8018. ;;;###autoload
  8019. (defun turn-on-orgstruct++ ()
  8020. "Unconditionally turn on `orgstruct++-mode'."
  8021. (orgstruct++-mode 1))
  8022. (defun orgstruct-error ()
  8023. "Error when there is no default binding for a structure key."
  8024. (interactive)
  8025. (funcall (if (fboundp 'user-error)
  8026. 'user-error
  8027. 'error)
  8028. "This key has no function outside structure elements"))
  8029. (defun orgstruct-setup ()
  8030. "Setup orgstruct keymap."
  8031. (dolist (cell '((org-demote . t)
  8032. (org-metaleft . t)
  8033. (org-metaright . t)
  8034. (org-promote . t)
  8035. (org-shiftmetaleft . t)
  8036. (org-shiftmetaright . t)
  8037. org-backward-element
  8038. org-backward-heading-same-level
  8039. org-ctrl-c-ret
  8040. org-ctrl-c-minus
  8041. org-ctrl-c-star
  8042. org-cycle
  8043. org-forward-heading-same-level
  8044. org-insert-heading
  8045. org-insert-heading-respect-content
  8046. org-kill-note-or-show-branches
  8047. org-mark-subtree
  8048. org-meta-return
  8049. org-metadown
  8050. org-metaup
  8051. org-narrow-to-subtree
  8052. org-promote-subtree
  8053. org-reveal
  8054. org-shiftdown
  8055. org-shiftleft
  8056. org-shiftmetadown
  8057. org-shiftmetaup
  8058. org-shiftright
  8059. org-shifttab
  8060. org-shifttab
  8061. org-shiftup
  8062. org-show-subtree
  8063. org-sort
  8064. org-up-element
  8065. outline-demote
  8066. outline-next-visible-heading
  8067. outline-previous-visible-heading
  8068. outline-promote
  8069. outline-up-heading
  8070. show-children))
  8071. (let ((f (or (car-safe cell) cell))
  8072. (disable-when-heading-prefix (cdr-safe cell)))
  8073. (when (fboundp f)
  8074. (let ((new-bindings))
  8075. (dolist (binding (nconc (where-is-internal f org-mode-map)
  8076. (where-is-internal f outline-mode-map)))
  8077. (push binding new-bindings)
  8078. ;; TODO use local-function-key-map
  8079. (dolist (rep '(("<tab>" . "TAB")
  8080. ("<return>" . "RET")
  8081. ("<escape>" . "ESC")
  8082. ("<delete>" . "DEL")))
  8083. (setq binding (read-kbd-macro
  8084. (let ((case-fold-search))
  8085. (replace-regexp-in-string
  8086. (regexp-quote (cdr rep))
  8087. (car rep)
  8088. (key-description binding)))))
  8089. (pushnew binding new-bindings :test 'equal)))
  8090. (dolist (binding new-bindings)
  8091. (let ((key (lookup-key orgstruct-mode-map binding)))
  8092. (when (or (not key) (numberp key))
  8093. (condition-case nil
  8094. (org-defkey orgstruct-mode-map
  8095. binding
  8096. (orgstruct-make-binding f binding disable-when-heading-prefix))
  8097. (error nil)))))))))
  8098. (run-hooks 'orgstruct-setup-hook))
  8099. (defun orgstruct-make-binding (fun key disable-when-heading-prefix)
  8100. "Create a function for binding in the structure minor mode.
  8101. FUN is the command to call inside a table. KEY is the key that
  8102. should be checked in for a command to execute outside of tables.
  8103. Non-nil DISABLE-WHEN-HEADING-PREFIX means to disable the command
  8104. if `orgstruct-heading-prefix-regexp' is non-nil."
  8105. (let ((name (concat "orgstruct-hijacker-" (symbol-name fun))))
  8106. (let ((nname name)
  8107. (i 0))
  8108. (while (fboundp (intern nname))
  8109. (setq nname (format "%s-%d" name (setq i (1+ i)))))
  8110. (setq name (intern nname)))
  8111. (eval
  8112. (let ((bindings '((org-heading-regexp
  8113. (concat "^"
  8114. orgstruct-heading-prefix-regexp
  8115. "\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ ]*$"))
  8116. (org-outline-regexp
  8117. (concat orgstruct-heading-prefix-regexp "\\*+ "))
  8118. (org-outline-regexp-bol
  8119. (concat "^" org-outline-regexp))
  8120. (outline-regexp org-outline-regexp)
  8121. (outline-heading-end-regexp "\n")
  8122. (outline-level 'org-outline-level)
  8123. (outline-heading-alist))))
  8124. `(defun ,name (arg)
  8125. ,(concat "In Structure, run `" (symbol-name fun) "'.\n"
  8126. "Outside of structure, run the binding of `"
  8127. (key-description key) "'."
  8128. (when disable-when-heading-prefix
  8129. (concat
  8130. "\nIf `orgstruct-heading-prefix-regexp' is non-nil, this command will always fall\n"
  8131. "back to the default binding due to limitations of Org's implementation of\n"
  8132. "`" (symbol-name fun) "'.")))
  8133. (interactive "p")
  8134. (let* ((disable
  8135. ,(when disable-when-heading-prefix
  8136. '(and orgstruct-heading-prefix-regexp
  8137. (not (string= orgstruct-heading-prefix-regexp "")))))
  8138. (fallback
  8139. (or disable
  8140. (not
  8141. (let* ,bindings
  8142. (org-context-p 'headline 'item
  8143. ,(when (memq fun
  8144. '(org-insert-heading
  8145. org-insert-heading-respect-content
  8146. org-meta-return))
  8147. '(when orgstruct-is-++
  8148. 'item-body))))))))
  8149. (if fallback
  8150. (let* ((orgstruct-mode)
  8151. (binding
  8152. (loop with key = ,key
  8153. for rep in
  8154. '(nil
  8155. ("<\\([^>]*\\)tab>" . "\\1TAB")
  8156. ("<\\([^>]*\\)return>" . "\\1RET")
  8157. ("<\\([^>]*\\)escape>" . "\\1ESC")
  8158. ("<\\([^>]*\\)delete>" . "\\1DEL"))
  8159. do
  8160. (when rep
  8161. (setq key (read-kbd-macro
  8162. (let ((case-fold-search))
  8163. (replace-regexp-in-string
  8164. (car rep)
  8165. (cdr rep)
  8166. (key-description key))))))
  8167. thereis (key-binding key))))
  8168. (if (keymapp binding)
  8169. (set-temporary-overlay-map binding)
  8170. (let ((func (or binding
  8171. (unless disable
  8172. 'orgstruct-error))))
  8173. (when func
  8174. (call-interactively func)))))
  8175. (org-run-like-in-org-mode
  8176. (lambda ()
  8177. (interactive)
  8178. (let* ,bindings
  8179. (call-interactively ',fun)))))))))
  8180. name))
  8181. (defun org-contextualize-keys (alist contexts)
  8182. "Return valid elements in ALIST depending on CONTEXTS.
  8183. `org-agenda-custom-commands' or `org-capture-templates' are the
  8184. values used for ALIST, and `org-agenda-custom-commands-contexts'
  8185. or `org-capture-templates-contexts' are the associated contexts
  8186. definitions."
  8187. (let ((contexts
  8188. ;; normalize contexts
  8189. (mapcar
  8190. (lambda(c) (cond ((listp (cadr c))
  8191. (list (car c) (car c) (cadr c)))
  8192. ((string= "" (cadr c))
  8193. (list (car c) (car c) (caddr c)))
  8194. (t c))) contexts))
  8195. (a alist) c r s)
  8196. ;; loop over all commands or templates
  8197. (while (setq c (pop a))
  8198. (let (vrules repl)
  8199. (cond
  8200. ((not (assoc (car c) contexts))
  8201. (push c r))
  8202. ((and (assoc (car c) contexts)
  8203. (setq vrules (org-contextualize-validate-key
  8204. (car c) contexts)))
  8205. (mapc (lambda (vr)
  8206. (when (not (equal (car vr) (cadr vr)))
  8207. (setq repl vr))) vrules)
  8208. (if (not repl) (push c r)
  8209. (push (cadr repl) s)
  8210. (push
  8211. (cons (car c)
  8212. (cdr (or (assoc (cadr repl) alist)
  8213. (error "Undefined key `%s' as contextual replacement for `%s'"
  8214. (cadr repl) (car c)))))
  8215. r))))))
  8216. ;; Return limited ALIST, possibly with keys modified, and deduplicated
  8217. (delq
  8218. nil
  8219. (delete-dups
  8220. (mapcar (lambda (x)
  8221. (let ((tpl (car x)))
  8222. (when (not (delq
  8223. nil
  8224. (mapcar (lambda(y)
  8225. (equal y tpl)) s))) x)))
  8226. (reverse r))))))
  8227. (defun org-contextualize-validate-key (key contexts)
  8228. "Check CONTEXTS for agenda or capture KEY."
  8229. (let (r rr res)
  8230. (while (setq r (pop contexts))
  8231. (mapc
  8232. (lambda (rr)
  8233. (when
  8234. (and (equal key (car r))
  8235. (if (functionp rr) (funcall rr)
  8236. (or (and (eq (car rr) 'in-file)
  8237. (buffer-file-name)
  8238. (string-match (cdr rr) (buffer-file-name)))
  8239. (and (eq (car rr) 'in-mode)
  8240. (string-match (cdr rr) (symbol-name major-mode)))
  8241. (and (eq (car rr) 'in-buffer)
  8242. (string-match (cdr rr) (buffer-name)))
  8243. (when (and (eq (car rr) 'not-in-file)
  8244. (buffer-file-name))
  8245. (not (string-match (cdr rr) (buffer-file-name))))
  8246. (when (eq (car rr) 'not-in-mode)
  8247. (not (string-match (cdr rr) (symbol-name major-mode))))
  8248. (when (eq (car rr) 'not-in-buffer)
  8249. (not (string-match (cdr rr) (buffer-name)))))))
  8250. (push r res)))
  8251. (car (last r))))
  8252. (delete-dups (delq nil res))))
  8253. (defun org-context-p (&rest contexts)
  8254. "Check if local context is any of CONTEXTS.
  8255. Possible values in the list of contexts are `table', `headline', and `item'."
  8256. (let ((pos (point)))
  8257. (goto-char (point-at-bol))
  8258. (prog1 (or (and (memq 'table contexts)
  8259. (looking-at "[ \t]*|"))
  8260. (and (memq 'headline contexts)
  8261. (looking-at org-outline-regexp))
  8262. (and (memq 'item contexts)
  8263. (looking-at "[ \t]*\\([-+*] \\|[0-9]+[.)] \\)"))
  8264. (and (memq 'item-body contexts)
  8265. (org-in-item-p)))
  8266. (goto-char pos))))
  8267. (defun org-get-local-variables ()
  8268. "Return a list of all local variables in an Org mode buffer."
  8269. (let (varlist)
  8270. (with-current-buffer (get-buffer-create "*Org tmp*")
  8271. (erase-buffer)
  8272. (org-mode)
  8273. (setq varlist (buffer-local-variables)))
  8274. (kill-buffer "*Org tmp*")
  8275. (delq nil
  8276. (mapcar
  8277. (lambda (x)
  8278. (setq x
  8279. (if (symbolp x)
  8280. (list x)
  8281. (list (car x) (cdr x))))
  8282. (if (and (not (get (car x) 'org-state))
  8283. (string-match
  8284. "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|indent-\\)"
  8285. (symbol-name (car x))))
  8286. x nil))
  8287. varlist))))
  8288. (defun org-clone-local-variables (from-buffer &optional regexp)
  8289. "Clone local variables from FROM-BUFFER.
  8290. Optional argument REGEXP selects variables to clone."
  8291. (mapc
  8292. (lambda (pair)
  8293. (and (symbolp (car pair))
  8294. (or (null regexp)
  8295. (string-match regexp (symbol-name (car pair))))
  8296. (set (make-local-variable (car pair))
  8297. (cdr pair))))
  8298. (buffer-local-variables from-buffer)))
  8299. ;;;###autoload
  8300. (defun org-run-like-in-org-mode (cmd)
  8301. "Run a command, pretending that the current buffer is in Org-mode.
  8302. This will temporarily bind local variables that are typically bound in
  8303. Org-mode to the values they have in Org-mode, and then interactively
  8304. call CMD."
  8305. (org-load-modules-maybe)
  8306. (unless org-local-vars
  8307. (setq org-local-vars (org-get-local-variables)))
  8308. (let (binds)
  8309. (dolist (var org-local-vars)
  8310. (when (or (not (boundp (car var)))
  8311. (eq (symbol-value (car var))
  8312. (default-value (car var))))
  8313. (push (list (car var) `(quote ,(cadr var))) binds)))
  8314. (eval `(let ,binds
  8315. (call-interactively (quote ,cmd))))))
  8316. ;;;; Archiving
  8317. (defun org-get-category (&optional pos force-refresh)
  8318. "Get the category applying to position POS."
  8319. (save-match-data
  8320. (if force-refresh (org-refresh-category-properties))
  8321. (let ((pos (or pos (point))))
  8322. (or (get-text-property pos 'org-category)
  8323. (progn (org-refresh-category-properties)
  8324. (get-text-property pos 'org-category))))))
  8325. (defun org-refresh-category-properties ()
  8326. "Refresh category text properties in the buffer."
  8327. (let ((case-fold-search t)
  8328. (inhibit-read-only t)
  8329. (def-cat (cond
  8330. ((null org-category)
  8331. (if buffer-file-name
  8332. (file-name-sans-extension
  8333. (file-name-nondirectory buffer-file-name))
  8334. "???"))
  8335. ((symbolp org-category) (symbol-name org-category))
  8336. (t org-category)))
  8337. beg end cat pos optionp)
  8338. (org-with-silent-modifications
  8339. (save-excursion
  8340. (save-restriction
  8341. (widen)
  8342. (goto-char (point-min))
  8343. (put-text-property (point) (point-max) 'org-category def-cat)
  8344. (while (re-search-forward
  8345. "^\\(#\\+CATEGORY:\\|[ \t]*:CATEGORY:\\)\\(.*\\)" nil t)
  8346. (setq pos (match-end 0)
  8347. optionp (equal (char-after (match-beginning 0)) ?#)
  8348. cat (org-trim (match-string 2)))
  8349. (if optionp
  8350. (setq beg (point-at-bol) end (point-max))
  8351. (org-back-to-heading t)
  8352. (setq beg (point) end (org-end-of-subtree t t)))
  8353. (put-text-property beg end 'org-category cat)
  8354. (put-text-property beg end 'org-category-position beg)
  8355. (goto-char pos)))))))
  8356. (defun org-refresh-properties (dprop tprop)
  8357. "Refresh buffer text properties.
  8358. DPROP is the drawer property and TPROP is the corresponding text
  8359. property to set."
  8360. (let ((case-fold-search t)
  8361. (inhibit-read-only t) p)
  8362. (org-with-silent-modifications
  8363. (save-excursion
  8364. (save-restriction
  8365. (widen)
  8366. (goto-char (point-min))
  8367. (while (re-search-forward (concat "^[ \t]*:" dprop ": +\\(.*\\)[ \t]*$") nil t)
  8368. (setq p (org-match-string-no-properties 1))
  8369. (save-excursion
  8370. (org-back-to-heading t)
  8371. (put-text-property
  8372. (point-at-bol) (org-end-of-subtree t t) tprop p))))))))
  8373. ;;;; Link Stuff
  8374. ;;; Link abbreviations
  8375. (defun org-link-expand-abbrev (link)
  8376. "Apply replacements as defined in `org-link-abbrev-alist'."
  8377. (if (string-match "^\\([^:]*\\)\\(::?\\(.*\\)\\)?$" link)
  8378. (let* ((key (match-string 1 link))
  8379. (as (or (assoc key org-link-abbrev-alist-local)
  8380. (assoc key org-link-abbrev-alist)))
  8381. (tag (and (match-end 2) (match-string 3 link)))
  8382. rpl)
  8383. (if (not as)
  8384. link
  8385. (setq rpl (cdr as))
  8386. (cond
  8387. ((symbolp rpl) (funcall rpl tag))
  8388. ((string-match "%(\\([^)]+\\))" rpl)
  8389. (replace-match
  8390. (save-match-data
  8391. (funcall (intern-soft (match-string 1 rpl)) tag)) t t rpl))
  8392. ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
  8393. ((string-match "%h" rpl)
  8394. (replace-match (url-hexify-string (or tag "")) t t rpl))
  8395. (t (concat rpl tag)))))
  8396. link))
  8397. ;;; Storing and inserting links
  8398. (defvar org-insert-link-history nil
  8399. "Minibuffer history for links inserted with `org-insert-link'.")
  8400. (defvar org-stored-links nil
  8401. "Contains the links stored with `org-store-link'.")
  8402. (defvar org-store-link-plist nil
  8403. "Plist with info about the most recently link created with `org-store-link'.")
  8404. (defvar org-link-protocols nil
  8405. "Link protocols added to Org-mode using `org-add-link-type'.")
  8406. (defvar org-store-link-functions nil
  8407. "List of functions that are called to create and store a link.
  8408. Each function will be called in turn until one returns a non-nil
  8409. value. Each function should check if it is responsible for creating
  8410. this link (for example by looking at the major mode).
  8411. If not, it must exit and return nil.
  8412. If yes, it should return a non-nil value after a calling
  8413. `org-store-link-props' with a list of properties and values.
  8414. Special properties are:
  8415. :type The link prefix, like \"http\". This must be given.
  8416. :link The link, like \"http://www.astro.uva.nl/~dominik\".
  8417. This is obligatory as well.
  8418. :description Optional default description for the second pair
  8419. of brackets in an Org-mode link. The user can still change
  8420. this when inserting this link into an Org-mode buffer.
  8421. In addition to these, any additional properties can be specified
  8422. and then used in capture templates.")
  8423. (defun org-add-link-type (type &optional follow export)
  8424. "Add TYPE to the list of `org-link-types'.
  8425. Re-compute all regular expressions depending on `org-link-types'
  8426. FOLLOW and EXPORT are two functions.
  8427. FOLLOW should take the link path as the single argument and do whatever
  8428. is necessary to follow the link, for example find a file or display
  8429. a mail message.
  8430. EXPORT should format the link path for export to one of the export formats.
  8431. It should be a function accepting three arguments:
  8432. path the path of the link, the text after the prefix (like \"http:\")
  8433. desc the description of the link, if any, or a description added by
  8434. org-export-normalize-links if there is none
  8435. format the export format, a symbol like `html' or `latex' or `ascii'..
  8436. The function may use the FORMAT information to return different values
  8437. depending on the format. The return value will be put literally into
  8438. the exported file. If the return value is nil, this means Org should
  8439. do what it normally does with links which do not have EXPORT defined.
  8440. Org-mode has a built-in default for exporting links. If you are happy with
  8441. this default, there is no need to define an export function for the link
  8442. type. For a simple example of an export function, see `org-bbdb.el'."
  8443. (add-to-list 'org-link-types type t)
  8444. (org-make-link-regexps)
  8445. (if (assoc type org-link-protocols)
  8446. (setcdr (assoc type org-link-protocols) (list follow export))
  8447. (push (list type follow export) org-link-protocols)))
  8448. (defvar org-agenda-buffer-name) ; Defined in org-agenda.el
  8449. (defvar org-id-link-to-org-use-id) ; Defined in org-id.el
  8450. ;;;###autoload
  8451. (defun org-store-link (arg)
  8452. "\\<org-mode-map>Store an org-link to the current location.
  8453. This link is added to `org-stored-links' and can later be inserted
  8454. into an org-buffer with \\[org-insert-link].
  8455. For some link types, a prefix arg is interpreted.
  8456. For links to Usenet articles, arg negates `org-gnus-prefer-web-links'.
  8457. For file links, arg negates `org-context-in-file-links'.
  8458. A double prefix arg force skipping storing functions that are not
  8459. part of Org's core.
  8460. A triple prefix arg force storing a link for each line in the
  8461. active region."
  8462. (interactive "P")
  8463. (org-load-modules-maybe)
  8464. (if (and (equal arg '(64)) (org-region-active-p))
  8465. (save-excursion
  8466. (let ((end (region-end)))
  8467. (goto-char (region-beginning))
  8468. (set-mark (point))
  8469. (while (< (point-at-eol) end)
  8470. (move-end-of-line 1) (activate-mark)
  8471. (let (current-prefix-arg)
  8472. (call-interactively 'org-store-link))
  8473. (move-beginning-of-line 2)
  8474. (set-mark (point)))))
  8475. (org-with-limited-levels
  8476. (setq org-store-link-plist nil)
  8477. (let (link cpltxt desc description search
  8478. txt custom-id agenda-link sfuns sfunsn)
  8479. (cond
  8480. ;; Store a link using an external link type
  8481. ((and (not (equal arg '(16)))
  8482. (setq sfuns
  8483. (delq
  8484. nil (mapcar (lambda (f)
  8485. (let (fs) (if (funcall f) (push f fs))))
  8486. org-store-link-functions))
  8487. sfunsn (mapcar (lambda (fu) (symbol-name (car fu))) sfuns))
  8488. (or (and (cdr sfuns)
  8489. (funcall (intern
  8490. (completing-read
  8491. "Which function for creating the link? "
  8492. sfunsn t (car sfunsn)))))
  8493. (funcall (caar sfuns)))
  8494. (setq link (plist-get org-store-link-plist :link)
  8495. desc (or (plist-get org-store-link-plist
  8496. :description) link))))
  8497. ;; Store a link from a source code buffer
  8498. ((org-src-edit-buffer-p)
  8499. (let (label gc)
  8500. (while (or (not label)
  8501. (save-excursion
  8502. (save-restriction
  8503. (widen)
  8504. (goto-char (point-min))
  8505. (re-search-forward
  8506. (regexp-quote (format org-coderef-label-format label))
  8507. nil t))))
  8508. (when label (message "Label exists already") (sit-for 2))
  8509. (setq label (read-string "Code line label: " label)))
  8510. (end-of-line 1)
  8511. (setq link (format org-coderef-label-format label))
  8512. (setq gc (- 79 (length link)))
  8513. (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
  8514. (insert link)
  8515. (setq link (concat "(" label ")") desc nil)))
  8516. ;; We are in the agenda, link to referenced location
  8517. ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
  8518. (let ((m (or (get-text-property (point) 'org-hd-marker)
  8519. (get-text-property (point) 'org-marker))))
  8520. (when m
  8521. (org-with-point-at m
  8522. (setq agenda-link
  8523. (if (org-called-interactively-p 'any)
  8524. (call-interactively 'org-store-link)
  8525. (org-store-link nil)))))))
  8526. ((eq major-mode 'calendar-mode)
  8527. (let ((cd (calendar-cursor-to-date)))
  8528. (setq link
  8529. (format-time-string
  8530. (car org-time-stamp-formats)
  8531. (apply 'encode-time
  8532. (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
  8533. nil nil nil))))
  8534. (org-store-link-props :type "calendar" :date cd)))
  8535. ((eq major-mode 'help-mode)
  8536. (setq link (concat "help:" (save-excursion
  8537. (goto-char (point-min))
  8538. (looking-at "^[^ ]+")
  8539. (match-string 0))))
  8540. (org-store-link-props :type "help"))
  8541. ((eq major-mode 'w3-mode)
  8542. (setq cpltxt (if (and (buffer-name)
  8543. (not (string-match "Untitled" (buffer-name))))
  8544. (buffer-name)
  8545. (url-view-url t))
  8546. link (url-view-url t))
  8547. (org-store-link-props :type "w3" :url (url-view-url t)))
  8548. ((eq major-mode 'image-mode)
  8549. (setq cpltxt (concat "file:"
  8550. (abbreviate-file-name buffer-file-name))
  8551. link cpltxt)
  8552. (org-store-link-props :type "image" :file buffer-file-name))
  8553. ;; In dired, store a link to the file of the current line
  8554. ((eq major-mode 'dired-mode)
  8555. (let ((file (dired-get-filename nil t)))
  8556. (setq file (if file
  8557. (abbreviate-file-name
  8558. (expand-file-name (dired-get-filename nil t)))
  8559. ;; otherwise, no file so use current directory.
  8560. default-directory))
  8561. (setq cpltxt (concat "file:" file)
  8562. link cpltxt)))
  8563. ((setq search (run-hook-with-args-until-success
  8564. 'org-create-file-search-functions))
  8565. (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
  8566. "::" search))
  8567. (setq cpltxt (or description link)))
  8568. ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
  8569. (setq custom-id (org-entry-get nil "CUSTOM_ID"))
  8570. (cond
  8571. ;; Store a link using the target at point
  8572. ((org-in-regexp "[^<]<<\\([^<>]+\\)>>[^>]" 1)
  8573. (setq cpltxt
  8574. (concat "file:"
  8575. (abbreviate-file-name
  8576. (buffer-file-name (buffer-base-buffer)))
  8577. "::" (match-string 1))
  8578. link cpltxt))
  8579. ((and (featurep 'org-id)
  8580. (or (eq org-id-link-to-org-use-id t)
  8581. (and (org-called-interactively-p 'any)
  8582. (or (eq org-id-link-to-org-use-id 'create-if-interactive)
  8583. (and (eq org-id-link-to-org-use-id
  8584. 'create-if-interactive-and-no-custom-id)
  8585. (not custom-id))))
  8586. (and org-id-link-to-org-use-id (org-entry-get nil "ID"))))
  8587. ;; Store a link using the ID at point
  8588. (setq link (condition-case nil
  8589. (prog1 (org-id-store-link)
  8590. (setq desc (plist-get org-store-link-plist
  8591. :description)))
  8592. (error
  8593. ;; Probably before first headline, link only to file
  8594. (concat "file:"
  8595. (abbreviate-file-name
  8596. (buffer-file-name (buffer-base-buffer))))))))
  8597. (t
  8598. ;; Just link to current headline
  8599. (setq cpltxt (concat "file:"
  8600. (abbreviate-file-name
  8601. (buffer-file-name (buffer-base-buffer)))))
  8602. ;; Add a context search string
  8603. (when (org-xor org-context-in-file-links arg)
  8604. (let* ((ee (org-element-at-point))
  8605. (et (org-element-type ee))
  8606. (ev (plist-get (cadr ee) :value))
  8607. (ek (plist-get (cadr ee) :key))
  8608. (eok (and (stringp ek) (string-match "name" ek))))
  8609. (setq txt (cond
  8610. ((org-at-heading-p) nil)
  8611. ((and (eq et 'keyword) eok) ev)
  8612. ((org-region-active-p)
  8613. (buffer-substring (region-beginning) (region-end)))))
  8614. (when (or (null txt) (string-match "\\S-" txt))
  8615. (setq cpltxt
  8616. (concat cpltxt "::"
  8617. (condition-case nil
  8618. (org-make-org-heading-search-string txt)
  8619. (error "")))
  8620. desc (or (and (eq et 'keyword) eok ev)
  8621. (nth 4 (ignore-errors (org-heading-components)))
  8622. "NONE")))))
  8623. (if (string-match "::\\'" cpltxt)
  8624. (setq cpltxt (substring cpltxt 0 -2)))
  8625. (setq link cpltxt))))
  8626. ((buffer-file-name (buffer-base-buffer))
  8627. ;; Just link to this file here.
  8628. (setq cpltxt (concat "file:"
  8629. (abbreviate-file-name
  8630. (buffer-file-name (buffer-base-buffer)))))
  8631. ;; Add a context string.
  8632. (when (org-xor org-context-in-file-links arg)
  8633. (setq txt (if (org-region-active-p)
  8634. (buffer-substring (region-beginning) (region-end))
  8635. (buffer-substring (point-at-bol) (point-at-eol))))
  8636. ;; Only use search option if there is some text.
  8637. (when (string-match "\\S-" txt)
  8638. (setq cpltxt
  8639. (concat cpltxt "::" (org-make-org-heading-search-string txt))
  8640. desc "NONE")))
  8641. (setq link cpltxt))
  8642. ((org-called-interactively-p 'interactive)
  8643. (user-error "No method for storing a link from this buffer"))
  8644. (t (setq link nil)))
  8645. ;; We're done setting link and desc, clean up
  8646. (if (consp link) (setq cpltxt (car link) link (cdr link)))
  8647. (setq link (or link cpltxt)
  8648. desc (or desc cpltxt))
  8649. (cond ((equal desc "NONE") (setq desc nil))
  8650. ((string-match org-bracket-link-analytic-regexp desc)
  8651. (let ((d0 (match-string 3 desc))
  8652. (p0 (match-string 5 desc)))
  8653. (setq desc
  8654. (replace-regexp-in-string
  8655. org-bracket-link-regexp
  8656. (concat (or p0 d0)
  8657. (if (equal (length (match-string 0 desc))
  8658. (length desc)) "*" "")) desc)))))
  8659. ;; Return the link
  8660. (if (not (and (or (org-called-interactively-p 'any)
  8661. executing-kbd-macro) link))
  8662. (or agenda-link (and link (org-make-link-string link desc)))
  8663. (push (list link desc) org-stored-links)
  8664. (message "Stored: %s" (or desc link))
  8665. (when custom-id
  8666. (setq link (concat "file:" (abbreviate-file-name
  8667. (buffer-file-name)) "::#" custom-id))
  8668. (push (list link desc) org-stored-links)))))))
  8669. (defun org-store-link-props (&rest plist)
  8670. "Store link properties, extract names and addresses."
  8671. (let (x adr)
  8672. (when (setq x (plist-get plist :from))
  8673. (setq adr (mail-extract-address-components x))
  8674. (setq plist (plist-put plist :fromname (car adr)))
  8675. (setq plist (plist-put plist :fromaddress (nth 1 adr))))
  8676. (when (setq x (plist-get plist :to))
  8677. (setq adr (mail-extract-address-components x))
  8678. (setq plist (plist-put plist :toname (car adr)))
  8679. (setq plist (plist-put plist :toaddress (nth 1 adr)))))
  8680. (let ((from (plist-get plist :from))
  8681. (to (plist-get plist :to)))
  8682. (when (and from to org-from-is-user-regexp)
  8683. (setq plist
  8684. (plist-put plist :fromto
  8685. (if (string-match org-from-is-user-regexp from)
  8686. (concat "to %t")
  8687. (concat "from %f"))))))
  8688. (setq org-store-link-plist plist))
  8689. (defun org-add-link-props (&rest plist)
  8690. "Add these properties to the link property list."
  8691. (let (key value)
  8692. (while plist
  8693. (setq key (pop plist) value (pop plist))
  8694. (setq org-store-link-plist
  8695. (plist-put org-store-link-plist key value)))))
  8696. (defun org-email-link-description (&optional fmt)
  8697. "Return the description part of an email link.
  8698. This takes information from `org-store-link-plist' and formats it
  8699. according to FMT (default from `org-email-link-description-format')."
  8700. (setq fmt (or fmt org-email-link-description-format))
  8701. (let* ((p org-store-link-plist)
  8702. (to (plist-get p :toaddress))
  8703. (from (plist-get p :fromaddress))
  8704. (table
  8705. (list
  8706. (cons "%c" (plist-get p :fromto))
  8707. (cons "%F" (plist-get p :from))
  8708. (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
  8709. (cons "%T" (plist-get p :to))
  8710. (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
  8711. (cons "%s" (plist-get p :subject))
  8712. (cons "%d" (plist-get p :date))
  8713. (cons "%m" (plist-get p :message-id)))))
  8714. (when (string-match "%c" fmt)
  8715. ;; Check if the user wrote this message
  8716. (if (and org-from-is-user-regexp from to
  8717. (save-match-data (string-match org-from-is-user-regexp from)))
  8718. (setq fmt (replace-match "to %t" t t fmt))
  8719. (setq fmt (replace-match "from %f" t t fmt))))
  8720. (org-replace-escapes fmt table)))
  8721. (defun org-make-org-heading-search-string (&optional string)
  8722. "Make search string for the current headline or STRING."
  8723. (let ((s (or string
  8724. (and (derived-mode-p 'org-mode)
  8725. (save-excursion
  8726. (org-back-to-heading t)
  8727. (org-element-property :raw-value (org-element-at-point))))))
  8728. (lines org-context-in-file-links))
  8729. (or string (setq s (concat "*" s))) ; Add * for headlines
  8730. (setq s (replace-regexp-in-string "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" "" s))
  8731. (when (and string (integerp lines) (> lines 0))
  8732. (let ((slines (org-split-string s "\n")))
  8733. (when (< lines (length slines))
  8734. (setq s (mapconcat
  8735. 'identity
  8736. (reverse (nthcdr (- (length slines) lines)
  8737. (reverse slines))) "\n")))))
  8738. (mapconcat 'identity (org-split-string s "[ \t]+") " ")))
  8739. (defun org-make-link-string (link &optional description)
  8740. "Make a link with brackets, consisting of LINK and DESCRIPTION."
  8741. (unless (string-match "\\S-" link)
  8742. (error "Empty link"))
  8743. (when (and description
  8744. (stringp description)
  8745. (not (string-match "\\S-" description)))
  8746. (setq description nil))
  8747. (when (stringp description)
  8748. ;; Remove brackets from the description, they are fatal.
  8749. (while (string-match "\\[" description)
  8750. (setq description (replace-match "{" t t description)))
  8751. (while (string-match "\\]" description)
  8752. (setq description (replace-match "}" t t description))))
  8753. (when (equal link description)
  8754. ;; No description needed, it is identical
  8755. (setq description nil))
  8756. (when (and (not description)
  8757. (not (string-match (org-image-file-name-regexp) link))
  8758. (not (equal link (org-link-escape link))))
  8759. (setq description (org-extract-attributes link)))
  8760. (setq link
  8761. (cond ((string-match (org-image-file-name-regexp) link) link)
  8762. ((string-match org-link-types-re link)
  8763. (concat (match-string 1 link)
  8764. (org-link-escape (substring link (match-end 1)))))
  8765. (t (org-link-escape link))))
  8766. (concat "[[" link "]"
  8767. (if description (concat "[" description "]") "")
  8768. "]"))
  8769. (defconst org-link-escape-chars
  8770. '(?\ ?\[ ?\] ?\; ?\= ?\+)
  8771. "List of characters that should be escaped in link.
  8772. This is the list that is used for internal purposes.")
  8773. (defconst org-link-escape-chars-browser
  8774. '(?\ ?\")
  8775. "List of escapes for characters that are problematic in links.
  8776. This is the list that is used before handing over to the browser.")
  8777. (defun org-link-escape (text &optional table merge)
  8778. "Return percent escaped representation of TEXT.
  8779. TEXT is a string with the text to escape.
  8780. Optional argument TABLE is a list with characters that should be
  8781. escaped. When nil, `org-link-escape-chars' is used.
  8782. If optional argument MERGE is set, merge TABLE into
  8783. `org-link-escape-chars'."
  8784. (cond
  8785. ((and table merge)
  8786. (mapc (lambda (defchr)
  8787. (unless (member defchr table)
  8788. (setq table (cons defchr table)))) org-link-escape-chars))
  8789. ((null table)
  8790. (setq table org-link-escape-chars)))
  8791. (mapconcat
  8792. (lambda (char)
  8793. (if (or (member char table)
  8794. (and (or (< char 32) (= char 37) (> char 126))
  8795. org-url-hexify-p))
  8796. (mapconcat (lambda (sequence-element)
  8797. (format "%%%.2X" sequence-element))
  8798. (or (encode-coding-char char 'utf-8)
  8799. (error "Unable to percent escape character: %s"
  8800. (char-to-string char))) "")
  8801. (char-to-string char))) text ""))
  8802. (defun org-link-unescape (str)
  8803. "Unhex hexified Unicode strings as returned from the JavaScript function
  8804. encodeURIComponent. E.g. `%C3%B6' is the german o-Umlaut."
  8805. (unless (and (null str) (string= "" str))
  8806. (let ((pos 0) (case-fold-search t) unhexed)
  8807. (while (setq pos (string-match "\\(%[0-9a-f][0-9a-f]\\)+" str pos))
  8808. (setq unhexed (org-link-unescape-compound (match-string 0 str)))
  8809. (setq str (replace-match unhexed t t str))
  8810. (setq pos (+ pos (length unhexed))))))
  8811. str)
  8812. (defun org-link-unescape-compound (hex)
  8813. "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German o-Umlaut.
  8814. Note: this function also decodes single byte encodings like
  8815. `%E1' (a-acute) if not followed by another `%[A-F0-9]{2}' group."
  8816. (save-match-data
  8817. (let* ((bytes (cdr (split-string hex "%")))
  8818. (ret "")
  8819. (eat 0)
  8820. (sum 0))
  8821. (while bytes
  8822. (let* ((val (string-to-number (pop bytes) 16))
  8823. (shift-xor
  8824. (if (= 0 eat)
  8825. (cond
  8826. ((>= val 252) (cons 6 252))
  8827. ((>= val 248) (cons 5 248))
  8828. ((>= val 240) (cons 4 240))
  8829. ((>= val 224) (cons 3 224))
  8830. ((>= val 192) (cons 2 192))
  8831. (t (cons 0 0)))
  8832. (cons 6 128))))
  8833. (if (>= val 192) (setq eat (car shift-xor)))
  8834. (setq val (logxor val (cdr shift-xor)))
  8835. (setq sum (+ (lsh sum (car shift-xor)) val))
  8836. (if (> eat 0) (setq eat (- eat 1)))
  8837. (cond
  8838. ((= 0 eat) ;multi byte
  8839. (setq ret (concat ret (org-char-to-string sum)))
  8840. (setq sum 0))
  8841. ((not bytes) ; single byte(s)
  8842. (setq ret (org-link-unescape-single-byte-sequence hex))))
  8843. )) ;; end (while bytes
  8844. ret )))
  8845. (defun org-link-unescape-single-byte-sequence (hex)
  8846. "Unhexify hex-encoded single byte character sequences."
  8847. (mapconcat (lambda (byte)
  8848. (char-to-string (string-to-number byte 16)))
  8849. (cdr (split-string hex "%")) ""))
  8850. (defun org-xor (a b)
  8851. "Exclusive or."
  8852. (if a (not b) b))
  8853. (defun org-fixup-message-id-for-http (s)
  8854. "Replace special characters in a message id, so it can be used in an http query."
  8855. (when (string-match "%" s)
  8856. (setq s (mapconcat (lambda (c)
  8857. (if (eq c ?%)
  8858. "%25"
  8859. (char-to-string c)))
  8860. s "")))
  8861. (while (string-match "<" s)
  8862. (setq s (replace-match "%3C" t t s)))
  8863. (while (string-match ">" s)
  8864. (setq s (replace-match "%3E" t t s)))
  8865. (while (string-match "@" s)
  8866. (setq s (replace-match "%40" t t s)))
  8867. s)
  8868. (defun org-link-prettify (link)
  8869. "Return a human-readable representation of LINK.
  8870. The car of LINK must be a raw link the cdr of LINK must be either
  8871. a link description or nil."
  8872. (let ((desc (or (cadr link) "<no description>")))
  8873. (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
  8874. "<" (car link) ">")))
  8875. ;;;###autoload
  8876. (defun org-insert-link-global ()
  8877. "Insert a link like Org-mode does.
  8878. This command can be called in any mode to insert a link in Org-mode syntax."
  8879. (interactive)
  8880. (org-load-modules-maybe)
  8881. (org-run-like-in-org-mode 'org-insert-link))
  8882. (defun org-insert-all-links (&optional keep)
  8883. "Insert all links in `org-stored-links'."
  8884. (interactive "P")
  8885. (let ((links (copy-sequence org-stored-links)) l)
  8886. (while (setq l (if keep (pop links) (pop org-stored-links)))
  8887. (insert "- ")
  8888. (org-insert-link nil (car l) (or (cadr l) "<no description>"))
  8889. (insert "\n"))))
  8890. (defun org-link-fontify-links-to-this-file ()
  8891. "Fontify links to the current file in `org-stored-links'."
  8892. (let ((f (buffer-file-name)) a b)
  8893. (setq a (mapcar (lambda(l)
  8894. (let ((ll (car l)))
  8895. (when (and (string-match "^file:\\(.+\\)::" ll)
  8896. (equal f (expand-file-name (match-string 1 ll))))
  8897. ll)))
  8898. org-stored-links))
  8899. (when (featurep 'org-id)
  8900. (setq b (mapcar (lambda(l)
  8901. (let ((ll (car l)))
  8902. (when (and (string-match "^id:\\(.+\\)$" ll)
  8903. (equal f (expand-file-name
  8904. (or (org-id-find-id-file
  8905. (match-string 1 ll)) ""))))
  8906. ll)))
  8907. org-stored-links)))
  8908. (mapcar (lambda(l)
  8909. (put-text-property 0 (length l) 'face 'font-lock-comment-face l))
  8910. (delq nil (append a b)))))
  8911. (defvar org-link-links-in-this-file nil)
  8912. (defun org-insert-link (&optional complete-file link-location default-description)
  8913. "Insert a link. At the prompt, enter the link.
  8914. Completion can be used to insert any of the link protocol prefixes like
  8915. http or ftp in use.
  8916. The history can be used to select a link previously stored with
  8917. `org-store-link'. When the empty string is entered (i.e. if you just
  8918. press RET at the prompt), the link defaults to the most recently
  8919. stored link. As SPC triggers completion in the minibuffer, you need to
  8920. use M-SPC or C-q SPC to force the insertion of a space character.
  8921. You will also be prompted for a description, and if one is given, it will
  8922. be displayed in the buffer instead of the link.
  8923. If there is already a link at point, this command will allow you to edit link
  8924. and description parts.
  8925. With a \\[universal-argument] prefix, prompts for a file to link to. The file name can
  8926. be selected using completion. The path to the file will be relative to the
  8927. current directory if the file is in the current directory or a subdirectory.
  8928. Otherwise, the link will be the absolute path as completed in the minibuffer
  8929. \(i.e. normally ~/path/to/file). You can configure this behavior using the
  8930. option `org-link-file-path-type'.
  8931. With two \\[universal-argument] prefixes, enforce an absolute path even if the file is in
  8932. the current directory or below.
  8933. With three \\[universal-argument] prefixes, negate the meaning of
  8934. `org-keep-stored-link-after-insertion'.
  8935. If `org-make-link-description-function' is non-nil, this function will be
  8936. called with the link target, and the result will be the default
  8937. link description.
  8938. If the LINK-LOCATION parameter is non-nil, this value will be
  8939. used as the link location instead of reading one interactively.
  8940. If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
  8941. be used as the default description."
  8942. (interactive "P")
  8943. (let* ((wcf (current-window-configuration))
  8944. (origbuf (current-buffer))
  8945. (region (if (org-region-active-p)
  8946. (buffer-substring (region-beginning) (region-end))))
  8947. (remove (and region (list (region-beginning) (region-end))))
  8948. (desc region)
  8949. tmphist ; byte-compile incorrectly complains about this
  8950. (link link-location)
  8951. (abbrevs org-link-abbrev-alist-local)
  8952. entry file all-prefixes auto-desc)
  8953. (cond
  8954. (link-location) ; specified by arg, just use it.
  8955. ((org-in-regexp org-bracket-link-regexp 1)
  8956. ;; We do have a link at point, and we are going to edit it.
  8957. (setq remove (list (match-beginning 0) (match-end 0)))
  8958. (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
  8959. (setq link (read-string "Link: "
  8960. (org-link-unescape
  8961. (org-match-string-no-properties 1)))))
  8962. ((or (org-in-regexp org-angle-link-re)
  8963. (org-in-regexp org-plain-link-re))
  8964. ;; Convert to bracket link
  8965. (setq remove (list (match-beginning 0) (match-end 0))
  8966. link (read-string "Link: "
  8967. (org-remove-angle-brackets (match-string 0)))))
  8968. ((member complete-file '((4) (16)))
  8969. ;; Completing read for file names.
  8970. (setq link (org-file-complete-link complete-file)))
  8971. (t
  8972. ;; Read link, with completion for stored links.
  8973. (org-link-fontify-links-to-this-file)
  8974. (org-switch-to-buffer-other-window "*Org Links*")
  8975. (with-current-buffer "*Org Links*"
  8976. (erase-buffer)
  8977. (insert "Insert a link.
  8978. Use TAB to complete link prefixes, then RET for type-specific completion support\n")
  8979. (when org-stored-links
  8980. (insert "\nStored links are available with <up>/<down> or M-p/n (most recent with RET):\n\n")
  8981. (insert (mapconcat 'org-link-prettify
  8982. (reverse org-stored-links) "\n")))
  8983. (goto-char (point-min)))
  8984. (let ((cw (selected-window)))
  8985. (select-window (get-buffer-window "*Org Links*" 'visible))
  8986. (with-current-buffer "*Org Links*" (setq truncate-lines t))
  8987. (unless (pos-visible-in-window-p (point-max))
  8988. (org-fit-window-to-buffer))
  8989. (and (window-live-p cw) (select-window cw)))
  8990. ;; Fake a link history, containing the stored links.
  8991. (setq tmphist (append (mapcar 'car org-stored-links)
  8992. org-insert-link-history))
  8993. (setq all-prefixes (append (mapcar 'car abbrevs)
  8994. (mapcar 'car org-link-abbrev-alist)
  8995. org-link-types))
  8996. (unwind-protect
  8997. (progn
  8998. (setq link
  8999. (org-completing-read
  9000. "Link: "
  9001. (append
  9002. (mapcar (lambda (x) (concat x ":"))
  9003. all-prefixes)
  9004. (mapcar 'car org-stored-links))
  9005. nil nil nil
  9006. 'tmphist
  9007. (caar org-stored-links)))
  9008. (if (not (string-match "\\S-" link))
  9009. (user-error "No link selected"))
  9010. (mapc (lambda(l)
  9011. (when (equal link (cadr l)) (setq link (car l) auto-desc t)))
  9012. org-stored-links)
  9013. (if (or (member link all-prefixes)
  9014. (and (equal ":" (substring link -1))
  9015. (member (substring link 0 -1) all-prefixes)
  9016. (setq link (substring link 0 -1))))
  9017. (setq link (with-current-buffer origbuf
  9018. (org-link-try-special-completion link)))))
  9019. (set-window-configuration wcf)
  9020. (kill-buffer "*Org Links*"))
  9021. (setq entry (assoc link org-stored-links))
  9022. (or entry (push link org-insert-link-history))
  9023. (setq desc (or desc (nth 1 entry)))))
  9024. (if (funcall (if (equal complete-file '(64)) 'not 'identity)
  9025. (not org-keep-stored-link-after-insertion))
  9026. (setq org-stored-links (delq (assoc link org-stored-links)
  9027. org-stored-links)))
  9028. (if (string-match org-plain-link-re link)
  9029. ;; URL-like link, normalize the use of angular brackets.
  9030. (setq link (org-remove-angle-brackets link)))
  9031. ;; Check if we are linking to the current file with a search
  9032. ;; option If yes, simplify the link by using only the search
  9033. ;; option.
  9034. (when (and buffer-file-name
  9035. (string-match "^file:\\(.+?\\)::\\(.+\\)" link))
  9036. (let* ((path (match-string 1 link))
  9037. (case-fold-search nil)
  9038. (search (match-string 2 link)))
  9039. (save-match-data
  9040. (if (equal (file-truename buffer-file-name) (file-truename path))
  9041. ;; We are linking to this same file, with a search option
  9042. (setq link search)))))
  9043. ;; Check if we can/should use a relative path. If yes, simplify the link
  9044. (when (string-match "^\\(file:\\|docview:\\)\\(.*\\)" link)
  9045. (let* ((type (match-string 1 link))
  9046. (path (match-string 2 link))
  9047. (origpath path)
  9048. (case-fold-search nil))
  9049. (cond
  9050. ((or (eq org-link-file-path-type 'absolute)
  9051. (equal complete-file '(16)))
  9052. (setq path (abbreviate-file-name (expand-file-name path))))
  9053. ((eq org-link-file-path-type 'noabbrev)
  9054. (setq path (expand-file-name path)))
  9055. ((eq org-link-file-path-type 'relative)
  9056. (setq path (file-relative-name path)))
  9057. (t
  9058. (save-match-data
  9059. (if (string-match (concat "^" (regexp-quote
  9060. (expand-file-name
  9061. (file-name-as-directory
  9062. default-directory))))
  9063. (expand-file-name path))
  9064. ;; We are linking a file with relative path name.
  9065. (setq path (substring (expand-file-name path)
  9066. (match-end 0)))
  9067. (setq path (abbreviate-file-name (expand-file-name path)))))))
  9068. (setq link (concat type path))
  9069. (if (equal desc origpath)
  9070. (setq desc path))))
  9071. (if org-make-link-description-function
  9072. (setq desc
  9073. (or (condition-case nil
  9074. (funcall org-make-link-description-function link desc)
  9075. (error (progn (message "Can't get link description from `%s'"
  9076. (symbol-name org-make-link-description-function))
  9077. (sit-for 2) nil)))
  9078. (read-string "Description: " default-description)))
  9079. (if default-description (setq desc default-description)
  9080. (setq desc (or (and auto-desc desc)
  9081. (read-string "Description: " desc)))))
  9082. (unless (string-match "\\S-" desc) (setq desc nil))
  9083. (if remove (apply 'delete-region remove))
  9084. (insert (org-make-link-string link desc))))
  9085. (defun org-link-try-special-completion (type)
  9086. "If there is completion support for link type TYPE, offer it."
  9087. (let ((fun (intern (concat "org-" type "-complete-link"))))
  9088. (if (functionp fun)
  9089. (funcall fun)
  9090. (read-string "Link (no completion support): " (concat type ":")))))
  9091. (defun org-file-complete-link (&optional arg)
  9092. "Create a file link using completion."
  9093. (let (file link)
  9094. (setq file (org-iread-file-name "File: "))
  9095. (let ((pwd (file-name-as-directory (expand-file-name ".")))
  9096. (pwd1 (file-name-as-directory (abbreviate-file-name
  9097. (expand-file-name ".")))))
  9098. (cond
  9099. ((equal arg '(16))
  9100. (setq link (concat
  9101. "file:"
  9102. (abbreviate-file-name (expand-file-name file)))))
  9103. ((string-match (concat "^" (regexp-quote pwd1) "\\(.+\\)") file)
  9104. (setq link (concat "file:" (match-string 1 file))))
  9105. ((string-match (concat "^" (regexp-quote pwd) "\\(.+\\)")
  9106. (expand-file-name file))
  9107. (setq link (concat
  9108. "file:" (match-string 1 (expand-file-name file)))))
  9109. (t (setq link (concat "file:" file)))))
  9110. link))
  9111. (defun org-iread-file-name (&rest args)
  9112. "Read-file-name using `ido-mode' speedup if available.
  9113. ARGS are arguments that may be passed to `ido-read-file-name' or `read-file-name'.
  9114. See `read-file-name' for a description of parameters."
  9115. (org-without-partial-completion
  9116. (if (and org-completion-use-ido
  9117. (fboundp 'ido-read-file-name)
  9118. (boundp 'ido-mode) ido-mode
  9119. (listp (second args)))
  9120. (let ((ido-enter-matching-directory nil))
  9121. (apply 'ido-read-file-name args))
  9122. (apply 'read-file-name args))))
  9123. (defun org-completing-read (&rest args)
  9124. "Completing-read with SPACE being a normal character."
  9125. (let ((enable-recursive-minibuffers t)
  9126. (minibuffer-local-completion-map
  9127. (copy-keymap minibuffer-local-completion-map)))
  9128. (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
  9129. (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
  9130. (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
  9131. (apply 'org-icompleting-read args)))
  9132. (defun org-completing-read-no-i (&rest args)
  9133. (let (org-completion-use-ido org-completion-use-iswitchb)
  9134. (apply 'org-completing-read args)))
  9135. (defun org-iswitchb-completing-read (prompt choices &rest args)
  9136. "Use iswitch as a completing-read replacement to choose from choices.
  9137. PROMPT is a string to prompt with. CHOICES is a list of strings to choose
  9138. from."
  9139. (let* ((iswitchb-use-virtual-buffers nil)
  9140. (iswitchb-make-buflist-hook
  9141. (lambda ()
  9142. (setq iswitchb-temp-buflist choices))))
  9143. (iswitchb-read-buffer prompt)))
  9144. (defun org-icompleting-read (&rest args)
  9145. "Completing-read using `ido-mode' or `iswitchb' speedups if available."
  9146. (org-without-partial-completion
  9147. (if (and org-completion-use-ido
  9148. (fboundp 'ido-completing-read)
  9149. (boundp 'ido-mode) ido-mode
  9150. (listp (second args)))
  9151. (let ((ido-enter-matching-directory nil))
  9152. (apply 'ido-completing-read (concat (car args))
  9153. (if (consp (car (nth 1 args)))
  9154. (mapcar 'car (nth 1 args))
  9155. (nth 1 args))
  9156. (cddr args)))
  9157. (if (and org-completion-use-iswitchb
  9158. (boundp 'iswitchb-mode) iswitchb-mode
  9159. (listp (second args)))
  9160. (apply 'org-iswitchb-completing-read (concat (car args))
  9161. (if (consp (car (nth 1 args)))
  9162. (mapcar 'car (nth 1 args))
  9163. (nth 1 args))
  9164. (cddr args))
  9165. (apply 'completing-read args)))))
  9166. (defun org-extract-attributes (s)
  9167. "Extract the attributes cookie from a string and set as text property."
  9168. (let (a attr (start 0) key value)
  9169. (save-match-data
  9170. (when (string-match "{{\\([^}]+\\)}}$" s)
  9171. (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
  9172. (while (string-match "\\([a-zA-Z]+\\)=\"\\([^\"]*\\)\"" a start)
  9173. (setq key (match-string 1 a) value (match-string 2 a)
  9174. start (match-end 0)
  9175. attr (plist-put attr (intern key) value))))
  9176. (org-add-props s nil 'org-attr attr))
  9177. s))
  9178. ;;; Opening/following a link
  9179. (defvar org-link-search-failed nil)
  9180. (defvar org-open-link-functions nil
  9181. "Hook for functions finding a plain text link.
  9182. These functions must take a single argument, the link content.
  9183. They will be called for links that look like [[link text][description]]
  9184. when LINK TEXT does not have a protocol like \"http:\" and does not look
  9185. like a filename (e.g. \"./blue.png\").
  9186. These functions will be called *before* Org attempts to resolve the
  9187. link by doing text searches in the current buffer - so if you want a
  9188. link \"[[target]]\" to still find \"<<target>>\", your function should
  9189. handle this as a special case.
  9190. When the function does handle the link, it must return a non-nil value.
  9191. If it decides that it is not responsible for this link, it must return
  9192. nil to indicate that that Org-mode can continue with other options
  9193. like exact and fuzzy text search.")
  9194. (defun org-next-link (&optional search-backward)
  9195. "Move forward to the next link.
  9196. If the link is in hidden text, expose it."
  9197. (interactive "P")
  9198. (when (and org-link-search-failed (eq this-command last-command))
  9199. (goto-char (point-min))
  9200. (message "Link search wrapped back to beginning of buffer"))
  9201. (setq org-link-search-failed nil)
  9202. (let* ((pos (point))
  9203. (ct (org-context))
  9204. (a (assoc :link ct))
  9205. (srch-fun (if search-backward 're-search-backward 're-search-forward)))
  9206. (cond (a (goto-char (nth (if search-backward 1 2) a)))
  9207. ((looking-at org-any-link-re)
  9208. ;; Don't stay stuck at link without an org-link face
  9209. (forward-char (if search-backward -1 1))))
  9210. (if (funcall srch-fun org-any-link-re nil t)
  9211. (progn
  9212. (goto-char (match-beginning 0))
  9213. (if (outline-invisible-p) (org-show-context)))
  9214. (goto-char pos)
  9215. (setq org-link-search-failed t)
  9216. (message "No further link found"))))
  9217. (defun org-previous-link ()
  9218. "Move backward to the previous link.
  9219. If the link is in hidden text, expose it."
  9220. (interactive)
  9221. (funcall 'org-next-link t))
  9222. (defun org-translate-link (s)
  9223. "Translate a link string if a translation function has been defined."
  9224. (if (and org-link-translation-function
  9225. (fboundp org-link-translation-function)
  9226. (string-match "\\([a-zA-Z0-9]+\\):\\(.*\\)" s))
  9227. (progn
  9228. (setq s (funcall org-link-translation-function
  9229. (match-string 1 s) (match-string 2 s)))
  9230. (concat (car s) ":" (cdr s)))
  9231. s))
  9232. (defun org-translate-link-from-planner (type path)
  9233. "Translate a link from Emacs Planner syntax so that Org can follow it.
  9234. This is still an experimental function, your mileage may vary."
  9235. (cond
  9236. ((member type '("http" "https" "news" "ftp"))
  9237. ;; standard Internet links are the same.
  9238. nil)
  9239. ((and (equal type "irc") (string-match "^//" path))
  9240. ;; Planner has two / at the beginning of an irc link, we have 1.
  9241. ;; We should have zero, actually....
  9242. (setq path (substring path 1)))
  9243. ((and (equal type "lisp") (string-match "^/" path))
  9244. ;; Planner has a slash, we do not.
  9245. (setq type "elisp" path (substring path 1)))
  9246. ((string-match "^//\\(.?*\\)/\\(<.*>\\)$" path)
  9247. ;; A typical message link. Planner has the id after the final slash,
  9248. ;; we separate it with a hash mark
  9249. (setq path (concat (match-string 1 path) "#"
  9250. (org-remove-angle-brackets (match-string 2 path))))))
  9251. (cons type path))
  9252. (defun org-find-file-at-mouse (ev)
  9253. "Open file link or URL at mouse."
  9254. (interactive "e")
  9255. (mouse-set-point ev)
  9256. (org-open-at-point 'in-emacs))
  9257. (defun org-open-at-mouse (ev)
  9258. "Open file link or URL at mouse.
  9259. See the docstring of `org-open-file' for details."
  9260. (interactive "e")
  9261. (mouse-set-point ev)
  9262. (if (eq major-mode 'org-agenda-mode)
  9263. (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
  9264. (org-open-at-point))
  9265. (defvar org-window-config-before-follow-link nil
  9266. "The window configuration before following a link.
  9267. This is saved in case the need arises to restore it.")
  9268. (defvar org-open-link-marker (make-marker)
  9269. "Marker pointing to the location where `org-open-at-point; was called.")
  9270. ;;;###autoload
  9271. (defun org-open-at-point-global ()
  9272. "Follow a link like Org-mode does.
  9273. This command can be called in any mode to follow a link that has
  9274. Org-mode syntax."
  9275. (interactive)
  9276. (org-run-like-in-org-mode 'org-open-at-point))
  9277. ;;;###autoload
  9278. (defun org-open-link-from-string (s &optional arg reference-buffer)
  9279. "Open a link in the string S, as if it was in Org-mode."
  9280. (interactive "sLink: \nP")
  9281. (let ((reference-buffer (or reference-buffer (current-buffer))))
  9282. (with-temp-buffer
  9283. (let ((org-inhibit-startup (not reference-buffer)))
  9284. (org-mode)
  9285. (insert s)
  9286. (goto-char (point-min))
  9287. (when reference-buffer
  9288. (setq org-link-abbrev-alist-local
  9289. (with-current-buffer reference-buffer
  9290. org-link-abbrev-alist-local)))
  9291. (org-open-at-point arg reference-buffer)))))
  9292. (defvar org-open-at-point-functions nil
  9293. "Hook that is run when following a link at point.
  9294. Functions in this hook must return t if they identify and follow
  9295. a link at point. If they don't find anything interesting at point,
  9296. they must return nil.")
  9297. (defvar clean-buffer-list-kill-buffer-names) ; Defined in midnight.el
  9298. (defun org-open-at-point (&optional arg reference-buffer)
  9299. "Open link at or after point.
  9300. If there is no link at point, this function will search forward up to
  9301. the end of the current line.
  9302. Normally, files will be opened by an appropriate application. If the
  9303. optional prefix argument ARG is non-nil, Emacs will visit the file.
  9304. With a double prefix argument, try to open outside of Emacs, in the
  9305. application the system uses for this file type."
  9306. (interactive "P")
  9307. ;; if in a code block, then open the block's results
  9308. (unless (call-interactively #'org-babel-open-src-block-result)
  9309. (org-load-modules-maybe)
  9310. (move-marker org-open-link-marker (point))
  9311. (setq org-window-config-before-follow-link (current-window-configuration))
  9312. (org-remove-occur-highlights nil nil t)
  9313. (cond
  9314. ((and (org-at-heading-p)
  9315. (not (org-at-timestamp-p t))
  9316. (not (org-in-regexp
  9317. (concat org-plain-link-re "\\|"
  9318. org-bracket-link-regexp "\\|"
  9319. org-angle-link-re "\\|"
  9320. "[ \t]:[^ \t\n]+:[ \t]*$")))
  9321. (not (get-text-property (point) 'org-linked-text)))
  9322. (or (let* ((lkall (org-offer-links-in-entry (current-buffer) (point) arg))
  9323. (lk0 (car lkall))
  9324. (lk (if (stringp lk0) (list lk0) lk0))
  9325. (lkend (cdr lkall)))
  9326. (mapcar (lambda(l)
  9327. (search-forward l nil lkend)
  9328. (goto-char (match-beginning 0))
  9329. (org-open-at-point))
  9330. lk))
  9331. (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
  9332. ((run-hook-with-args-until-success 'org-open-at-point-functions))
  9333. ((and (org-at-timestamp-p t)
  9334. (not (org-in-regexp org-bracket-link-regexp)))
  9335. (org-follow-timestamp-link))
  9336. ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
  9337. (not (org-in-regexp org-any-link-re)))
  9338. (org-footnote-action))
  9339. (t
  9340. (let (type path link line search (pos (point)))
  9341. (catch 'match
  9342. (save-excursion
  9343. (skip-chars-forward "^]\n\r")
  9344. (when (org-in-regexp org-bracket-link-regexp 1)
  9345. (setq link (org-extract-attributes
  9346. (org-link-unescape (org-match-string-no-properties 1))))
  9347. (while (string-match " *\n *" link)
  9348. (setq link (replace-match " " t t link)))
  9349. (setq link (org-link-expand-abbrev link))
  9350. (cond
  9351. ((or (file-name-absolute-p link)
  9352. (string-match "^\\.\\.?/" link))
  9353. (setq type "file" path link))
  9354. ((string-match org-link-re-with-space3 link)
  9355. (setq type (match-string 1 link) path (match-string 2 link)))
  9356. ((string-match "^help:+\\(.+\\)" link)
  9357. (setq type "help" path (match-string 1 link)))
  9358. (t (setq type "thisfile" path link)))
  9359. (throw 'match t)))
  9360. (when (get-text-property (point) 'org-linked-text)
  9361. (setq type "thisfile"
  9362. pos (if (get-text-property (1+ (point)) 'org-linked-text)
  9363. (1+ (point)) (point))
  9364. path (buffer-substring
  9365. (or (previous-single-property-change pos 'org-linked-text)
  9366. (point-min))
  9367. (or (next-single-property-change pos 'org-linked-text)
  9368. (point-max)))
  9369. ;; Ensure we will search for a <<<radio>>> link, not
  9370. ;; a simple reference like <<ref>>
  9371. path (concat "<" path))
  9372. (throw 'match t))
  9373. (save-excursion
  9374. (when (or (org-in-regexp org-angle-link-re)
  9375. (let ((match (org-in-regexp org-plain-link-re)))
  9376. ;; Check a plain link is not within a bracket link
  9377. (and match
  9378. (save-excursion
  9379. (progn
  9380. (goto-char (car match))
  9381. (not (org-in-regexp org-bracket-link-regexp))))))
  9382. (let ((line_ending (save-excursion (end-of-line) (point))))
  9383. ;; We are in a line before a plain or bracket link
  9384. (or (re-search-forward org-plain-link-re line_ending t)
  9385. (re-search-forward org-bracket-link-regexp line_ending t))))
  9386. (setq type (match-string 1)
  9387. path (org-link-unescape (match-string 2)))
  9388. (throw 'match t)))
  9389. (save-excursion
  9390. (when (org-in-regexp (org-re "\\(:[[:alnum:]_@#%:]+\\):[ \t]*$"))
  9391. (setq type "tags"
  9392. path (match-string 1))
  9393. (while (string-match ":" path)
  9394. (setq path (replace-match "+" t t path)))
  9395. (throw 'match t)))
  9396. (when (org-in-regexp "<\\([^><\n]+\\)>")
  9397. (setq type "tree-match"
  9398. path (match-string 1))
  9399. (throw 'match t)))
  9400. (unless path
  9401. (user-error "No link found"))
  9402. ;; switch back to reference buffer
  9403. ;; needed when if called in a temporary buffer through
  9404. ;; org-open-link-from-string
  9405. (with-current-buffer (or reference-buffer (current-buffer))
  9406. ;; Remove any trailing spaces in path
  9407. (if (string-match " +\\'" path)
  9408. (setq path (replace-match "" t t path)))
  9409. (if (and org-link-translation-function
  9410. (fboundp org-link-translation-function))
  9411. ;; Check if we need to translate the link
  9412. (let ((tmp (funcall org-link-translation-function type path)))
  9413. (setq type (car tmp) path (cdr tmp))))
  9414. (cond
  9415. ((assoc type org-link-protocols)
  9416. (funcall (nth 1 (assoc type org-link-protocols)) path))
  9417. ((equal type "help")
  9418. (let ((f-or-v (intern path)))
  9419. (cond ((fboundp f-or-v)
  9420. (describe-function f-or-v))
  9421. ((boundp f-or-v)
  9422. (describe-variable f-or-v))
  9423. (t (error "Not a known function or variable")))))
  9424. ((equal type "mailto")
  9425. (let ((cmd (car org-link-mailto-program))
  9426. (args (cdr org-link-mailto-program)) args1
  9427. (address path) (subject "") a)
  9428. (if (string-match "\\(.*\\)::\\(.*\\)" path)
  9429. (setq address (match-string 1 path)
  9430. subject (org-link-escape (match-string 2 path))))
  9431. (while args
  9432. (cond
  9433. ((not (stringp (car args))) (push (pop args) args1))
  9434. (t (setq a (pop args))
  9435. (if (string-match "%a" a)
  9436. (setq a (replace-match address t t a)))
  9437. (if (string-match "%s" a)
  9438. (setq a (replace-match subject t t a)))
  9439. (push a args1))))
  9440. (apply cmd (nreverse args1))))
  9441. ((member type '("http" "https" "ftp" "news"))
  9442. (browse-url
  9443. (concat type ":"
  9444. (if (org-string-match-p
  9445. (concat "[[:nonascii:]"
  9446. org-link-escape-chars-browser "]")
  9447. path)
  9448. (org-link-escape path org-link-escape-chars-browser)
  9449. path))))
  9450. ((string= type "doi")
  9451. (browse-url
  9452. (concat org-doi-server-url
  9453. (if (org-string-match-p
  9454. (concat "[[:nonascii:]"
  9455. org-link-escape-chars-browser "]")
  9456. path)
  9457. (org-link-escape path org-link-escape-chars-browser)
  9458. path))))
  9459. ((member type '("message"))
  9460. (browse-url (concat type ":" path)))
  9461. ((string= type "tags")
  9462. (org-tags-view arg path))
  9463. ((string= type "tree-match")
  9464. (org-occur (concat "\\[" (regexp-quote path) "\\]")))
  9465. ((string= type "file")
  9466. (if (string-match "::\\([0-9]+\\)\\'" path)
  9467. (setq line (string-to-number (match-string 1 path))
  9468. path (substring path 0 (match-beginning 0)))
  9469. (if (string-match "::\\(.+\\)\\'" path)
  9470. (setq search (match-string 1 path)
  9471. path (substring path 0 (match-beginning 0)))))
  9472. (if (string-match "[*?{]" (file-name-nondirectory path))
  9473. (dired path)
  9474. (org-open-file path arg line search)))
  9475. ((string= type "shell")
  9476. (let ((buf (generate-new-buffer "*Org Shell Output"))
  9477. (cmd path))
  9478. (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
  9479. (string-match org-confirm-shell-link-not-regexp cmd))
  9480. (not org-confirm-shell-link-function)
  9481. (funcall org-confirm-shell-link-function
  9482. (format "Execute \"%s\" in shell? "
  9483. (org-add-props cmd nil
  9484. 'face 'org-warning))))
  9485. (progn
  9486. (message "Executing %s" cmd)
  9487. (shell-command cmd buf)
  9488. (if (featurep 'midnight)
  9489. (setq clean-buffer-list-kill-buffer-names
  9490. (cons buf clean-buffer-list-kill-buffer-names))))
  9491. (error "Abort"))))
  9492. ((string= type "elisp")
  9493. (let ((cmd path))
  9494. (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
  9495. (string-match org-confirm-elisp-link-not-regexp cmd))
  9496. (not org-confirm-elisp-link-function)
  9497. (funcall org-confirm-elisp-link-function
  9498. (format "Execute \"%s\" as elisp? "
  9499. (org-add-props cmd nil
  9500. 'face 'org-warning))))
  9501. (message "%s => %s" cmd
  9502. (if (equal (string-to-char cmd) ?\()
  9503. (eval (read cmd))
  9504. (call-interactively (read cmd))))
  9505. (error "Abort"))))
  9506. ((and (string= type "thisfile")
  9507. (run-hook-with-args-until-success
  9508. 'org-open-link-functions path)))
  9509. ((string= type "thisfile")
  9510. (if arg
  9511. (switch-to-buffer-other-window
  9512. (org-get-buffer-for-internal-link (current-buffer)))
  9513. (org-mark-ring-push))
  9514. (let ((cmd `(org-link-search
  9515. ,path
  9516. ,(cond ((equal arg '(4)) ''occur)
  9517. ((equal arg '(16)) ''org-occur))
  9518. ,pos)))
  9519. (condition-case nil (let ((org-link-search-inhibit-query t))
  9520. (eval cmd))
  9521. (error (progn (widen) (eval cmd))))))
  9522. (t (browse-url-at-point)))))))
  9523. (move-marker org-open-link-marker nil)
  9524. (run-hook-with-args 'org-follow-link-hook)))
  9525. (defun org-offer-links-in-entry (buffer marker &optional nth zero)
  9526. "Offer links in the current entry and return the selected link.
  9527. If there is only one link, return it.
  9528. If NTH is an integer, return the NTH link found.
  9529. If ZERO is a string, check also this string for a link, and if
  9530. there is one, return it."
  9531. (with-current-buffer buffer
  9532. (save-excursion
  9533. (save-restriction
  9534. (widen)
  9535. (goto-char marker)
  9536. (let ((re (concat "\\(" org-bracket-link-regexp "\\)\\|"
  9537. "\\(" org-angle-link-re "\\)\\|"
  9538. "\\(" org-plain-link-re "\\)"))
  9539. (cnt ?0)
  9540. (in-emacs (if (integerp nth) nil nth))
  9541. have-zero end links link c)
  9542. (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
  9543. (push (match-string 0 zero) links)
  9544. (setq cnt (1- cnt) have-zero t))
  9545. (save-excursion
  9546. (org-back-to-heading t)
  9547. (setq end (save-excursion (outline-next-heading) (point)))
  9548. (while (re-search-forward re end t)
  9549. (push (match-string 0) links))
  9550. (setq links (org-uniquify (reverse links))))
  9551. (cond
  9552. ((null links)
  9553. (message "No links"))
  9554. ((equal (length links) 1)
  9555. (setq link (car links)))
  9556. ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
  9557. (setq link (nth (if have-zero nth (1- nth)) links)))
  9558. (t ; we have to select a link
  9559. (save-excursion
  9560. (save-window-excursion
  9561. (delete-other-windows)
  9562. (with-output-to-temp-buffer "*Select Link*"
  9563. (mapc (lambda (l)
  9564. (if (not (string-match org-bracket-link-regexp l))
  9565. (princ (format "[%c] %s\n" (incf cnt)
  9566. (org-remove-angle-brackets l)))
  9567. (if (match-end 3)
  9568. (princ (format "[%c] %s (%s)\n" (incf cnt)
  9569. (match-string 3 l) (match-string 1 l)))
  9570. (princ (format "[%c] %s\n" (incf cnt)
  9571. (match-string 1 l))))))
  9572. links))
  9573. (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
  9574. (message "Select link to open, RET to open all:")
  9575. (setq c (read-char-exclusive))
  9576. (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
  9577. (when (equal c ?q) (error "Abort"))
  9578. (if (equal c ?\C-m)
  9579. (setq link links)
  9580. (setq nth (- c ?0))
  9581. (if have-zero (setq nth (1+ nth)))
  9582. (unless (and (integerp nth) (>= (length links) nth))
  9583. (user-error "Invalid link selection"))
  9584. (setq link (nth (1- nth) links)))))
  9585. (cons link end))))))
  9586. ;; Add special file links that specify the way of opening
  9587. (org-add-link-type "file+sys" 'org-open-file-with-system)
  9588. (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
  9589. (defun org-open-file-with-system (path)
  9590. "Open file at PATH using the system way of opening it."
  9591. (org-open-file path 'system))
  9592. (defun org-open-file-with-emacs (path)
  9593. "Open file at PATH in Emacs."
  9594. (org-open-file path 'emacs))
  9595. ;;; File search
  9596. (defvar org-create-file-search-functions nil
  9597. "List of functions to construct the right search string for a file link.
  9598. These functions are called in turn with point at the location to
  9599. which the link should point.
  9600. A function in the hook should first test if it would like to
  9601. handle this file type, for example by checking the `major-mode'
  9602. or the file extension. If it decides not to handle this file, it
  9603. should just return nil to give other functions a chance. If it
  9604. does handle the file, it must return the search string to be used
  9605. when following the link. The search string will be part of the
  9606. file link, given after a double colon, and `org-open-at-point'
  9607. will automatically search for it. If special measures must be
  9608. taken to make the search successful, another function should be
  9609. added to the companion hook `org-execute-file-search-functions',
  9610. which see.
  9611. A function in this hook may also use `setq' to set the variable
  9612. `description' to provide a suggestion for the descriptive text to
  9613. be used for this link when it gets inserted into an Org-mode
  9614. buffer with \\[org-insert-link].")
  9615. (defvar org-execute-file-search-functions nil
  9616. "List of functions to execute a file search triggered by a link.
  9617. Functions added to this hook must accept a single argument, the
  9618. search string that was part of the file link, the part after the
  9619. double colon. The function must first check if it would like to
  9620. handle this search, for example by checking the `major-mode' or
  9621. the file extension. If it decides not to handle this search, it
  9622. should just return nil to give other functions a chance. If it
  9623. does handle the search, it must return a non-nil value to keep
  9624. other functions from trying.
  9625. Each function can access the current prefix argument through the
  9626. variable `current-prefix-arg'. Note that a single prefix is used
  9627. to force opening a link in Emacs, so it may be good to only use a
  9628. numeric or double prefix to guide the search function.
  9629. In case this is needed, a function in this hook can also restore
  9630. the window configuration before `org-open-at-point' was called using:
  9631. (set-window-configuration org-window-config-before-follow-link)")
  9632. (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
  9633. (defun org-link-search (s &optional type avoid-pos stealth)
  9634. "Search for a link search option.
  9635. If S is surrounded by forward slashes, it is interpreted as a
  9636. regular expression. In org-mode files, this will create an `org-occur'
  9637. sparse tree. In ordinary files, `occur' will be used to list matches.
  9638. If the current buffer is in `dired-mode', grep will be used to search
  9639. in all files. If AVOID-POS is given, ignore matches near that position.
  9640. When optional argument STEALTH is non-nil, do not modify
  9641. visibility around point, thus ignoring
  9642. `org-show-hierarchy-above', `org-show-following-heading' and
  9643. `org-show-siblings' variables."
  9644. (let ((case-fold-search t)
  9645. (s0 (mapconcat 'identity (org-split-string s "[ \t\r\n]+") " "))
  9646. (markers (concat "\\(?:" (mapconcat (lambda (x) (regexp-quote (car x)))
  9647. (append '(("") (" ") ("\t") ("\n"))
  9648. org-emphasis-alist)
  9649. "\\|") "\\)"))
  9650. (pos (point))
  9651. (pre nil) (post nil)
  9652. words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
  9653. (cond
  9654. ;; First check if there are any special search functions
  9655. ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
  9656. ;; Now try the builtin stuff
  9657. ((and (equal (string-to-char s0) ?#)
  9658. (> (length s0) 1)
  9659. (save-excursion
  9660. (goto-char (point-min))
  9661. (and
  9662. (re-search-forward
  9663. (concat "^[ \t]*:CUSTOM_ID:[ \t]+"
  9664. (regexp-quote (substring s0 1)) "[ \t]*$") nil t)
  9665. (setq type 'dedicated
  9666. pos (match-beginning 0))))
  9667. ;; There is an exact target for this
  9668. (goto-char pos)
  9669. (org-back-to-heading t)))
  9670. ((save-excursion
  9671. (goto-char (point-min))
  9672. (and
  9673. (re-search-forward
  9674. (concat "<<" (regexp-quote s0) ">>") nil t)
  9675. (setq type 'dedicated
  9676. pos (match-beginning 0))))
  9677. ;; There is an exact target for this
  9678. (goto-char pos))
  9679. ((save-excursion
  9680. (goto-char (point-min))
  9681. (and
  9682. (re-search-forward
  9683. (format "^[ \t]*#\\+NAME: %s" (regexp-quote s0)) nil t)
  9684. (setq type 'dedicated pos (match-beginning 0))))
  9685. ;; Found an element with a matching #+name affiliated keyword.
  9686. (goto-char pos))
  9687. ((and (string-match "^(\\(.*\\))$" s0)
  9688. (save-excursion
  9689. (goto-char (point-min))
  9690. (and
  9691. (re-search-forward
  9692. (concat "[^[]" (regexp-quote
  9693. (format org-coderef-label-format
  9694. (match-string 1 s0))))
  9695. nil t)
  9696. (setq type 'dedicated
  9697. pos (1+ (match-beginning 0))))))
  9698. ;; There is a coderef target for this
  9699. (goto-char pos))
  9700. ((string-match "^/\\(.*\\)/$" s)
  9701. ;; A regular expression
  9702. (cond
  9703. ((derived-mode-p 'org-mode)
  9704. (org-occur (match-string 1 s)))
  9705. (t (org-do-occur (match-string 1 s)))))
  9706. ((and (derived-mode-p 'org-mode) org-link-search-must-match-exact-headline)
  9707. (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
  9708. (goto-char (point-min))
  9709. (cond
  9710. ((let (case-fold-search)
  9711. (re-search-forward (format org-complex-heading-regexp-format
  9712. (regexp-quote s))
  9713. nil t))
  9714. ;; OK, found a match
  9715. (setq type 'dedicated)
  9716. (goto-char (match-beginning 0)))
  9717. ((and (not org-link-search-inhibit-query)
  9718. (eq org-link-search-must-match-exact-headline 'query-to-create)
  9719. (y-or-n-p "No match - create this as a new heading? "))
  9720. (goto-char (point-max))
  9721. (or (bolp) (newline))
  9722. (insert "* " s "\n")
  9723. (beginning-of-line 0))
  9724. (t
  9725. (goto-char pos)
  9726. (error "No match"))))
  9727. (t
  9728. ;; A normal search string
  9729. (when (equal (string-to-char s) ?*)
  9730. ;; Anchor on headlines, post may include tags.
  9731. (setq pre "^\\*+[ \t]+\\(?:\\sw+\\)?[ \t]*"
  9732. post (org-re "[ \t]*\\(?:[ \t]+:[[:alnum:]_@#%:+]:[ \t]*\\)?$")
  9733. s (substring s 1)))
  9734. (remove-text-properties
  9735. 0 (length s)
  9736. '(face nil mouse-face nil keymap nil fontified nil) s)
  9737. ;; Make a series of regular expressions to find a match
  9738. (setq words (org-split-string s "[ \n\r\t]+")
  9739. re0 (concat "\\(<<" (regexp-quote s0) ">>\\)")
  9740. re2 (concat markers "\\(" (mapconcat 'downcase words "[ \t]+")
  9741. "\\)" markers)
  9742. re2a_ (concat "\\(" (mapconcat 'downcase words
  9743. "[ \t\r\n]+") "\\)[ \t\r\n]")
  9744. re2a (concat "[ \t\r\n]" re2a_)
  9745. re4_ (concat "\\(" (mapconcat 'downcase words
  9746. "[^a-zA-Z_\r\n]+") "\\)[^a-zA-Z_]")
  9747. re4 (concat "[^a-zA-Z_]" re4_)
  9748. re1 (concat pre re2 post)
  9749. re3 (concat pre (if pre re4_ re4) post)
  9750. re5 (concat pre ".*" re4)
  9751. re2 (concat pre re2)
  9752. re2a (concat pre (if pre re2a_ re2a))
  9753. re4 (concat pre (if pre re4_ re4))
  9754. reall (concat "\\(" re0 "\\)\\|\\(" re1 "\\)\\|\\(" re2
  9755. "\\)\\|\\(" re3 "\\)\\|\\(" re4 "\\)\\|\\("
  9756. re5 "\\)"))
  9757. (cond
  9758. ((eq type 'org-occur) (org-occur reall))
  9759. ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
  9760. (t (goto-char (point-min))
  9761. (setq type 'fuzzy)
  9762. (if (or (and (org-search-not-self 1 re0 nil t)
  9763. (setq type 'dedicated))
  9764. (org-search-not-self 1 re1 nil t)
  9765. (org-search-not-self 1 re2 nil t)
  9766. (org-search-not-self 1 re2a nil t)
  9767. (org-search-not-self 1 re3 nil t)
  9768. (org-search-not-self 1 re4 nil t)
  9769. (org-search-not-self 1 re5 nil t))
  9770. (goto-char (match-beginning 1))
  9771. (goto-char pos)
  9772. (error "No match"))))))
  9773. (and (derived-mode-p 'org-mode)
  9774. (not stealth)
  9775. (org-show-context 'link-search))
  9776. type))
  9777. (defun org-search-not-self (group &rest args)
  9778. "Execute `re-search-forward', but only accept matches that do not
  9779. enclose the position of `org-open-link-marker'."
  9780. (let ((m org-open-link-marker))
  9781. (catch 'exit
  9782. (while (apply 're-search-forward args)
  9783. (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
  9784. (goto-char (match-end group))
  9785. (if (and (or (not (eq (marker-buffer m) (current-buffer)))
  9786. (> (match-beginning 0) (marker-position m))
  9787. (< (match-end 0) (marker-position m)))
  9788. (save-match-data
  9789. (or (not (org-in-regexp
  9790. org-bracket-link-analytic-regexp 1))
  9791. (not (match-end 4)) ; no description
  9792. (and (<= (match-beginning 4) (point))
  9793. (>= (match-end 4) (point))))))
  9794. (throw 'exit (point))))))))
  9795. (defun org-get-buffer-for-internal-link (buffer)
  9796. "Return a buffer to be used for displaying the link target of internal links."
  9797. (cond
  9798. ((not org-display-internal-link-with-indirect-buffer)
  9799. buffer)
  9800. ((string-match "(Clone)$" (buffer-name buffer))
  9801. (message "Buffer is already a clone, not making another one")
  9802. ;; we also do not modify visibility in this case
  9803. buffer)
  9804. (t ; make a new indirect buffer for displaying the link
  9805. (let* ((bn (buffer-name buffer))
  9806. (ibn (concat bn "(Clone)"))
  9807. (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
  9808. (with-current-buffer ib (org-overview))
  9809. ib))))
  9810. (defun org-do-occur (regexp &optional cleanup)
  9811. "Call the Emacs command `occur'.
  9812. If CLEANUP is non-nil, remove the printout of the regular expression
  9813. in the *Occur* buffer. This is useful if the regex is long and not useful
  9814. to read."
  9815. (occur regexp)
  9816. (when cleanup
  9817. (let ((cwin (selected-window)) win beg end)
  9818. (when (setq win (get-buffer-window "*Occur*"))
  9819. (select-window win))
  9820. (goto-char (point-min))
  9821. (when (re-search-forward "match[a-z]+" nil t)
  9822. (setq beg (match-end 0))
  9823. (if (re-search-forward "^[ \t]*[0-9]+" nil t)
  9824. (setq end (1- (match-beginning 0)))))
  9825. (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
  9826. (goto-char (point-min))
  9827. (select-window cwin))))
  9828. ;;; The mark ring for links jumps
  9829. (defvar org-mark-ring nil
  9830. "Mark ring for positions before jumps in Org-mode.")
  9831. (defvar org-mark-ring-last-goto nil
  9832. "Last position in the mark ring used to go back.")
  9833. ;; Fill and close the ring
  9834. (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
  9835. (loop for i from 1 to org-mark-ring-length do
  9836. (push (make-marker) org-mark-ring))
  9837. (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
  9838. org-mark-ring)
  9839. (defun org-mark-ring-push (&optional pos buffer)
  9840. "Put the current position or POS into the mark ring and rotate it."
  9841. (interactive)
  9842. (setq pos (or pos (point)))
  9843. (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
  9844. (move-marker (car org-mark-ring)
  9845. (or pos (point))
  9846. (or buffer (current-buffer)))
  9847. (message "%s"
  9848. (substitute-command-keys
  9849. "Position saved to mark ring, go back with \\[org-mark-ring-goto].")))
  9850. (defun org-mark-ring-goto (&optional n)
  9851. "Jump to the previous position in the mark ring.
  9852. With prefix arg N, jump back that many stored positions. When
  9853. called several times in succession, walk through the entire ring.
  9854. Org-mode commands jumping to a different position in the current file,
  9855. or to another Org-mode file, automatically push the old position
  9856. onto the ring."
  9857. (interactive "p")
  9858. (let (p m)
  9859. (if (eq last-command this-command)
  9860. (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
  9861. (setq p org-mark-ring))
  9862. (setq org-mark-ring-last-goto p)
  9863. (setq m (car p))
  9864. (org-pop-to-buffer-same-window (marker-buffer m))
  9865. (goto-char m)
  9866. (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
  9867. (defun org-remove-angle-brackets (s)
  9868. (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
  9869. (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
  9870. s)
  9871. (defun org-add-angle-brackets (s)
  9872. (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
  9873. (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
  9874. s)
  9875. (defun org-remove-double-quotes (s)
  9876. (if (equal (substring s 0 1) "\"") (setq s (substring s 1)))
  9877. (if (equal (substring s -1) "\"") (setq s (substring s 0 -1)))
  9878. s)
  9879. ;;; Following specific links
  9880. (defun org-follow-timestamp-link ()
  9881. "Open an agenda view for the time-stamp date/range at point."
  9882. (cond
  9883. ((org-at-date-range-p t)
  9884. (let ((org-agenda-start-on-weekday)
  9885. (t1 (match-string 1))
  9886. (t2 (match-string 2)) tt1 tt2)
  9887. (setq tt1 (time-to-days (org-time-string-to-time t1))
  9888. tt2 (time-to-days (org-time-string-to-time t2)))
  9889. (let ((org-agenda-buffer-tmp-name
  9890. (format "*Org Agenda(a:%s)"
  9891. (concat (substring t1 0 10) "--" (substring t2 0 10)))))
  9892. (org-agenda-list nil tt1 (1+ (- tt2 tt1))))))
  9893. ((org-at-timestamp-p t)
  9894. (let ((org-agenda-buffer-tmp-name
  9895. (format "*Org Agenda(a:%s)" (substring (match-string 1) 0 10))))
  9896. (org-agenda-list nil (time-to-days (org-time-string-to-time
  9897. (substring (match-string 1) 0 10)))
  9898. 1)))
  9899. (t (error "This should not happen"))))
  9900. ;;; Following file links
  9901. (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
  9902. (declare-function mailcap-extension-to-mime "mailcap" (extn))
  9903. (declare-function mailcap-mime-info
  9904. "mailcap" (string &optional request no-decode))
  9905. (defvar org-wait nil)
  9906. (defun org-open-file (path &optional in-emacs line search)
  9907. "Open the file at PATH.
  9908. First, this expands any special file name abbreviations. Then the
  9909. configuration variable `org-file-apps' is checked if it contains an
  9910. entry for this file type, and if yes, the corresponding command is launched.
  9911. If no application is found, Emacs simply visits the file.
  9912. With optional prefix argument IN-EMACS, Emacs will visit the file.
  9913. With a double \\[universal-argument] \\[universal-argument] \
  9914. prefix arg, Org tries to avoid opening in Emacs
  9915. and to use an external application to visit the file.
  9916. Optional LINE specifies a line to go to, optional SEARCH a string
  9917. to search for. If LINE or SEARCH is given, the file will be
  9918. opened in Emacs, unless an entry from org-file-apps that makes
  9919. use of groups in a regexp matches.
  9920. If you want to change the way frames are used when following a
  9921. link, please customize `org-link-frame-setup'.
  9922. If the file does not exist, an error is thrown."
  9923. (let* ((file (if (equal path "")
  9924. buffer-file-name
  9925. (substitute-in-file-name (expand-file-name path))))
  9926. (file-apps (append org-file-apps (org-default-apps)))
  9927. (apps (org-remove-if
  9928. 'org-file-apps-entry-match-against-dlink-p file-apps))
  9929. (apps-dlink (org-remove-if-not
  9930. 'org-file-apps-entry-match-against-dlink-p file-apps))
  9931. (remp (and (assq 'remote apps) (org-file-remote-p file)))
  9932. (dirp (if remp nil (file-directory-p file)))
  9933. (file (if (and dirp org-open-directory-means-index-dot-org)
  9934. (concat (file-name-as-directory file) "index.org")
  9935. file))
  9936. (a-m-a-p (assq 'auto-mode apps))
  9937. (dfile (downcase file))
  9938. ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
  9939. (link (cond ((and (eq line nil)
  9940. (eq search nil))
  9941. file)
  9942. (line
  9943. (concat file "::" (number-to-string line)))
  9944. (search
  9945. (concat file "::" search))))
  9946. (dlink (downcase link))
  9947. (old-buffer (current-buffer))
  9948. (old-pos (point))
  9949. (old-mode major-mode)
  9950. ext cmd link-match-data)
  9951. (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\.gz\\)$" dfile)
  9952. (setq ext (match-string 1 dfile))
  9953. (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\)$" dfile)
  9954. (setq ext (match-string 1 dfile))))
  9955. (cond
  9956. ((member in-emacs '((16) system))
  9957. (setq cmd (cdr (assoc 'system apps))))
  9958. (in-emacs (setq cmd 'emacs))
  9959. (t
  9960. (setq cmd (or (and remp (cdr (assoc 'remote apps)))
  9961. (and dirp (cdr (assoc 'directory apps)))
  9962. ; first, try matching against apps-dlink
  9963. ; if we get a match here, store the match data for later
  9964. (let ((match (assoc-default dlink apps-dlink
  9965. 'string-match)))
  9966. (if match
  9967. (progn (setq link-match-data (match-data))
  9968. match)
  9969. (progn (setq in-emacs (or in-emacs line search))
  9970. nil))) ; if we have no match in apps-dlink,
  9971. ; always open the file in emacs if line or search
  9972. ; is given (for backwards compatibility)
  9973. (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
  9974. 'string-match)
  9975. (cdr (assoc ext apps))
  9976. (cdr (assoc t apps))))))
  9977. (when (eq cmd 'system)
  9978. (setq cmd (cdr (assoc 'system apps))))
  9979. (when (eq cmd 'default)
  9980. (setq cmd (cdr (assoc t apps))))
  9981. (when (eq cmd 'mailcap)
  9982. (require 'mailcap)
  9983. (mailcap-parse-mailcaps)
  9984. (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
  9985. (command (mailcap-mime-info mime-type)))
  9986. (if (stringp command)
  9987. (setq cmd command)
  9988. (setq cmd 'emacs))))
  9989. (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
  9990. (not (file-exists-p file))
  9991. (not org-open-non-existing-files))
  9992. (user-error "No such file: %s" file))
  9993. (cond
  9994. ((and (stringp cmd) (not (string-match "^\\s-*$" cmd)))
  9995. ;; Remove quotes around the file name - we'll use shell-quote-argument.
  9996. (while (string-match "['\"]%s['\"]" cmd)
  9997. (setq cmd (replace-match "%s" t t cmd)))
  9998. (while (string-match "%s" cmd)
  9999. (setq cmd (replace-match
  10000. (save-match-data
  10001. (shell-quote-argument
  10002. (convert-standard-filename file)))
  10003. t t cmd)))
  10004. ;; Replace "%1", "%2" etc. in command with group matches from regex
  10005. (save-match-data
  10006. (let ((match-index 1)
  10007. (number-of-groups (- (/ (length link-match-data) 2) 1)))
  10008. (set-match-data link-match-data)
  10009. (while (<= match-index number-of-groups)
  10010. (let ((regex (concat "%" (number-to-string match-index)))
  10011. (replace-with (match-string match-index dlink)))
  10012. (while (string-match regex cmd)
  10013. (setq cmd (replace-match replace-with t t cmd))))
  10014. (setq match-index (+ match-index 1)))))
  10015. (save-window-excursion
  10016. (message "Running %s...done" cmd)
  10017. (start-process-shell-command cmd nil cmd)
  10018. (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))))
  10019. ((or (stringp cmd)
  10020. (eq cmd 'emacs))
  10021. (funcall (cdr (assq 'file org-link-frame-setup)) file)
  10022. (widen)
  10023. (if line (org-goto-line line)
  10024. (if search (org-link-search search))))
  10025. ((consp cmd)
  10026. (let ((file (convert-standard-filename file)))
  10027. (save-match-data
  10028. (set-match-data link-match-data)
  10029. (eval cmd))))
  10030. (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
  10031. (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
  10032. (or (not (equal old-buffer (current-buffer)))
  10033. (not (equal old-pos (point))))
  10034. (org-mark-ring-push old-pos old-buffer))))
  10035. (defun org-file-apps-entry-match-against-dlink-p (entry)
  10036. "This function returns non-nil if `entry' uses a regular
  10037. expression which should be matched against the whole link by
  10038. org-open-file.
  10039. It assumes that is the case when the entry uses a regular
  10040. expression which has at least one grouping construct and the
  10041. action is either a lisp form or a command string containing
  10042. '%1', i.e. using at least one subexpression match as a
  10043. parameter."
  10044. (let ((selector (car entry))
  10045. (action (cdr entry)))
  10046. (if (stringp selector)
  10047. (and (> (regexp-opt-depth selector) 0)
  10048. (or (and (stringp action)
  10049. (string-match "%[0-9]" action))
  10050. (consp action)))
  10051. nil)))
  10052. (defun org-default-apps ()
  10053. "Return the default applications for this operating system."
  10054. (cond
  10055. ((eq system-type 'darwin)
  10056. org-file-apps-defaults-macosx)
  10057. ((eq system-type 'windows-nt)
  10058. org-file-apps-defaults-windowsnt)
  10059. (t org-file-apps-defaults-gnu)))
  10060. (defun org-apps-regexp-alist (list &optional add-auto-mode)
  10061. "Convert extensions to regular expressions in the cars of LIST.
  10062. Also, weed out any non-string entries, because the return value is used
  10063. only for regexp matching.
  10064. When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
  10065. point to the symbol `emacs', indicating that the file should
  10066. be opened in Emacs."
  10067. (append
  10068. (delq nil
  10069. (mapcar (lambda (x)
  10070. (if (not (stringp (car x)))
  10071. nil
  10072. (if (string-match "\\W" (car x))
  10073. x
  10074. (cons (concat "\\." (car x) "\\'") (cdr x)))))
  10075. list))
  10076. (if add-auto-mode
  10077. (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
  10078. (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
  10079. (defun org-file-remote-p (file)
  10080. "Test whether FILE specifies a location on a remote system.
  10081. Return non-nil if the location is indeed remote.
  10082. For example, the filename \"/user@host:/foo\" specifies a location
  10083. on the system \"/user@host:\"."
  10084. (cond ((fboundp 'file-remote-p)
  10085. (file-remote-p file))
  10086. ((fboundp 'tramp-handle-file-remote-p)
  10087. (tramp-handle-file-remote-p file))
  10088. ((and (boundp 'ange-ftp-name-format)
  10089. (string-match (car ange-ftp-name-format) file))
  10090. t)))
  10091. ;;;; Refiling
  10092. (defun org-get-org-file ()
  10093. "Read a filename, with default directory `org-directory'."
  10094. (let ((default (or org-default-notes-file remember-data-file)))
  10095. (read-file-name (format "File name [%s]: " default)
  10096. (file-name-as-directory org-directory)
  10097. default)))
  10098. (defun org-notes-order-reversed-p ()
  10099. "Check if the current file should receive notes in reversed order."
  10100. (cond
  10101. ((not org-reverse-note-order) nil)
  10102. ((eq t org-reverse-note-order) t)
  10103. ((not (listp org-reverse-note-order)) nil)
  10104. (t (catch 'exit
  10105. (let ((all org-reverse-note-order)
  10106. entry)
  10107. (while (setq entry (pop all))
  10108. (if (string-match (car entry) buffer-file-name)
  10109. (throw 'exit (cdr entry))))
  10110. nil)))))
  10111. (defvar org-refile-target-table nil
  10112. "The list of refile targets, created by `org-refile'.")
  10113. (defvar org-agenda-new-buffers nil
  10114. "Buffers created to visit agenda files.")
  10115. (defvar org-refile-cache nil
  10116. "Cache for refile targets.")
  10117. (defvar org-refile-markers nil
  10118. "All the markers used for caching refile locations.")
  10119. (defun org-refile-marker (pos)
  10120. "Get a new refile marker, but only if caching is in use."
  10121. (if (not org-refile-use-cache)
  10122. pos
  10123. (let ((m (make-marker)))
  10124. (move-marker m pos)
  10125. (push m org-refile-markers)
  10126. m)))
  10127. (defun org-refile-cache-clear ()
  10128. "Clear the refile cache and disable all the markers."
  10129. (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
  10130. (setq org-refile-markers nil)
  10131. (setq org-refile-cache nil)
  10132. (message "Refile cache has been cleared"))
  10133. (defun org-refile-cache-check-set (set)
  10134. "Check if all the markers in the cache still have live buffers."
  10135. (let (marker)
  10136. (catch 'exit
  10137. (while (and set (setq marker (nth 3 (pop set))))
  10138. ;; If `org-refile-use-outline-path' is 'file, marker may be nil
  10139. (when (and marker (null (marker-buffer marker)))
  10140. (message "Please regenerate the refile cache with `C-0 C-c C-w'")
  10141. (sit-for 3)
  10142. (throw 'exit nil)))
  10143. t)))
  10144. (defun org-refile-cache-put (set &rest identifiers)
  10145. "Push the refile targets SET into the cache, under IDENTIFIERS."
  10146. (let* ((key (sha1 (prin1-to-string identifiers)))
  10147. (entry (assoc key org-refile-cache)))
  10148. (if entry
  10149. (setcdr entry set)
  10150. (push (cons key set) org-refile-cache))))
  10151. (defun org-refile-cache-get (&rest identifiers)
  10152. "Retrieve the cached value for refile targets given by IDENTIFIERS."
  10153. (cond
  10154. ((not org-refile-cache) nil)
  10155. ((not org-refile-use-cache) (org-refile-cache-clear) nil)
  10156. (t
  10157. (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
  10158. org-refile-cache))))
  10159. (and set (org-refile-cache-check-set set) set)))))
  10160. (defun org-refile-get-targets (&optional default-buffer excluded-entries)
  10161. "Produce a table with refile targets."
  10162. (let ((case-fold-search nil)
  10163. ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
  10164. (entries (or org-refile-targets '((nil . (:level . 1)))))
  10165. targets tgs txt re files f desc descre fast-path-p level pos0)
  10166. (message "Getting targets...")
  10167. (with-current-buffer (or default-buffer (current-buffer))
  10168. (while (setq entry (pop entries))
  10169. (setq files (car entry) desc (cdr entry))
  10170. (setq fast-path-p nil)
  10171. (cond
  10172. ((null files) (setq files (list (current-buffer))))
  10173. ((eq files 'org-agenda-files)
  10174. (setq files (org-agenda-files 'unrestricted)))
  10175. ((and (symbolp files) (fboundp files))
  10176. (setq files (funcall files)))
  10177. ((and (symbolp files) (boundp files))
  10178. (setq files (symbol-value files))))
  10179. (if (stringp files) (setq files (list files)))
  10180. (cond
  10181. ((eq (car desc) :tag)
  10182. (setq descre (concat "^\\*+[ \t]+.*?:" (regexp-quote (cdr desc)) ":")))
  10183. ((eq (car desc) :todo)
  10184. (setq descre (concat "^\\*+[ \t]+" (regexp-quote (cdr desc)) "[ \t]")))
  10185. ((eq (car desc) :regexp)
  10186. (setq descre (cdr desc)))
  10187. ((eq (car desc) :level)
  10188. (setq descre (concat "^\\*\\{" (number-to-string
  10189. (if org-odd-levels-only
  10190. (1- (* 2 (cdr desc)))
  10191. (cdr desc)))
  10192. "\\}[ \t]")))
  10193. ((eq (car desc) :maxlevel)
  10194. (setq fast-path-p t)
  10195. (setq descre (concat "^\\*\\{1," (number-to-string
  10196. (if org-odd-levels-only
  10197. (1- (* 2 (cdr desc)))
  10198. (cdr desc)))
  10199. "\\}[ \t]")))
  10200. (t (error "Bad refiling target description %s" desc)))
  10201. (while (setq f (pop files))
  10202. (with-current-buffer
  10203. (if (bufferp f) f (org-get-agenda-file-buffer f))
  10204. (or
  10205. (setq tgs (org-refile-cache-get (buffer-file-name) descre))
  10206. (progn
  10207. (if (bufferp f) (setq f (buffer-file-name
  10208. (buffer-base-buffer f))))
  10209. (setq f (and f (expand-file-name f)))
  10210. (if (eq org-refile-use-outline-path 'file)
  10211. (push (list (file-name-nondirectory f) f nil nil) tgs))
  10212. (save-excursion
  10213. (save-restriction
  10214. (widen)
  10215. (goto-char (point-min))
  10216. (while (re-search-forward descre nil t)
  10217. (goto-char (setq pos0 (point-at-bol)))
  10218. (catch 'next
  10219. (when org-refile-target-verify-function
  10220. (save-match-data
  10221. (or (funcall org-refile-target-verify-function)
  10222. (throw 'next t))))
  10223. (when (and (looking-at org-complex-heading-regexp)
  10224. (not (member (match-string 4) excluded-entries))
  10225. (match-string 4))
  10226. (setq level (org-reduced-level
  10227. (- (match-end 1) (match-beginning 1)))
  10228. txt (org-link-display-format (match-string 4))
  10229. txt (replace-regexp-in-string "\\( *\[[0-9]+/?[0-9]*%?\]\\)+$" "" txt)
  10230. re (format org-complex-heading-regexp-format
  10231. (regexp-quote (match-string 4))))
  10232. (when org-refile-use-outline-path
  10233. (setq txt (mapconcat
  10234. 'org-protect-slash
  10235. (append
  10236. (if (eq org-refile-use-outline-path
  10237. 'file)
  10238. (list (file-name-nondirectory
  10239. (buffer-file-name
  10240. (buffer-base-buffer))))
  10241. (if (eq org-refile-use-outline-path
  10242. 'full-file-path)
  10243. (list (buffer-file-name
  10244. (buffer-base-buffer)))))
  10245. (org-get-outline-path fast-path-p
  10246. level txt)
  10247. (list txt))
  10248. "/")))
  10249. (push (list txt f re (org-refile-marker (point)))
  10250. tgs)))
  10251. (when (= (point) pos0)
  10252. ;; verification function has not moved point
  10253. (goto-char (point-at-eol))))))))
  10254. (when org-refile-use-cache
  10255. (org-refile-cache-put tgs (buffer-file-name) descre))
  10256. (setq targets (append tgs targets))))))
  10257. (message "Getting targets...done")
  10258. (nreverse targets)))
  10259. (defun org-protect-slash (s)
  10260. (while (string-match "/" s)
  10261. (setq s (replace-match "\\" t t s)))
  10262. s)
  10263. (defvar org-olpa (make-vector 20 nil))
  10264. (defun org-get-outline-path (&optional fastp level heading)
  10265. "Return the outline path to the current entry, as a list.
  10266. The parameters FASTP, LEVEL, and HEADING are for use by a scanner
  10267. routine which makes outline path derivations for an entire file,
  10268. avoiding backtracing. Refile target collection makes use of that."
  10269. (if fastp
  10270. (progn
  10271. (if (> level 19)
  10272. (error "Outline path failure, more than 19 levels"))
  10273. (loop for i from level upto 19 do
  10274. (aset org-olpa i nil))
  10275. (prog1
  10276. (delq nil (append org-olpa nil))
  10277. (aset org-olpa level heading)))
  10278. (let (rtn case-fold-search)
  10279. (save-excursion
  10280. (save-restriction
  10281. (widen)
  10282. (while (org-up-heading-safe)
  10283. (when (looking-at org-complex-heading-regexp)
  10284. (push (org-trim
  10285. (replace-regexp-in-string
  10286. ;; Remove statistical/checkboxes cookies
  10287. "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" ""
  10288. (org-match-string-no-properties 4)))
  10289. rtn)))
  10290. rtn)))))
  10291. (defun org-format-outline-path (path &optional width prefix separator)
  10292. "Format the outline path PATH for display.
  10293. WIDTH is the maximum number of characters that is available.
  10294. PREFIX is a prefix to be included in the returned string,
  10295. such as the file name.
  10296. SEPARATOR is inserted between the different parts of the path,
  10297. the default is \"/\"."
  10298. (setq width (or width 79))
  10299. (if prefix (setq width (- width (length prefix))))
  10300. (if (not path)
  10301. (or prefix "")
  10302. (let* ((nsteps (length path))
  10303. (total-width (+ nsteps (apply '+ (mapcar 'length path))))
  10304. (maxwidth (if (<= total-width width)
  10305. 10000 ;; everything fits
  10306. ;; we need to shorten the level headings
  10307. (/ (- width nsteps) nsteps)))
  10308. (org-odd-levels-only nil)
  10309. (n 0)
  10310. (total (1+ (length prefix))))
  10311. (setq maxwidth (max maxwidth 10))
  10312. (concat prefix
  10313. (if prefix (or separator "/"))
  10314. (mapconcat
  10315. (lambda (h)
  10316. (setq n (1+ n))
  10317. (if (and (= n nsteps) (< maxwidth 10000))
  10318. (setq maxwidth (- total-width total)))
  10319. (if (< (length h) maxwidth)
  10320. (progn (setq total (+ total (length h) 1)) h)
  10321. (setq h (substring h 0 (- maxwidth 2))
  10322. total (+ total maxwidth 1))
  10323. (if (string-match "[ \t]+\\'" h)
  10324. (setq h (substring h 0 (match-beginning 0))))
  10325. (setq h (concat h "..")))
  10326. (org-add-props h nil 'face
  10327. (nth (% (1- n) org-n-level-faces)
  10328. org-level-faces))
  10329. h)
  10330. path (or separator "/"))))))
  10331. (defun org-display-outline-path (&optional file current separator just-return-string)
  10332. "Display the current outline path in the echo area.
  10333. If FILE is non-nil, prepend the output with the file name.
  10334. If CURRENT is non-nil, append the current heading to the output.
  10335. SEPARATOR is passed through to `org-format-outline-path'. It separates
  10336. the different parts of the path and defaults to \"/\".
  10337. If JUST-RETURN-STRING is non-nil, return a string, don't display a message."
  10338. (interactive "P")
  10339. (let* (case-fold-search
  10340. message-log-max ; Don't populate the *Messages* buffer
  10341. (bfn (buffer-file-name (buffer-base-buffer)))
  10342. (path (and (derived-mode-p 'org-mode) (org-get-outline-path)))
  10343. res)
  10344. (if current (setq path (append path
  10345. (save-excursion
  10346. (org-back-to-heading t)
  10347. (if (looking-at org-complex-heading-regexp)
  10348. (list (match-string 4)))))))
  10349. (setq res
  10350. (org-format-outline-path
  10351. path
  10352. (1- (frame-width))
  10353. (and file bfn (concat (file-name-nondirectory bfn) separator))
  10354. separator))
  10355. (if just-return-string
  10356. (org-no-properties res)
  10357. (let ((message-log-max nil))
  10358. (message "%s" res)))))
  10359. (defvar org-refile-history nil
  10360. "History for refiling operations.")
  10361. (defvar org-after-refile-insert-hook nil
  10362. "Hook run after `org-refile' has inserted its stuff at the new location.
  10363. Note that this is still *before* the stuff will be removed from
  10364. the *old* location.")
  10365. (defvar org-capture-last-stored-marker)
  10366. (defvar org-refile-keep nil
  10367. "Non-nil means `org-refile' will copy instead of refile.")
  10368. (defun org-copy ()
  10369. "Like `org-refile', but copy."
  10370. (interactive)
  10371. (let ((org-refile-keep t))
  10372. (funcall 'org-refile nil nil nil "Copy")))
  10373. (defun org-refile (&optional goto default-buffer rfloc msg)
  10374. "Move the entry or entries at point to another heading.
  10375. The list of target headings is compiled using the information in
  10376. `org-refile-targets', which see.
  10377. At the target location, the entry is filed as a subitem of the target
  10378. heading. Depending on `org-reverse-note-order', the new subitem will
  10379. either be the first or the last subitem.
  10380. If there is an active region, all entries in that region will be moved.
  10381. However, the region must fulfill the requirement that the first heading
  10382. is the first one sets the top-level of the moved text - at most siblings
  10383. below it are allowed.
  10384. With prefix arg GOTO, the command will only visit the target location
  10385. and not actually move anything.
  10386. With a double prefix arg \\[universal-argument] \\[universal-argument], \
  10387. go to the location where the last refiling operation has put the subtree.
  10388. With a numeric prefix argument of `2', refile to the running clock.
  10389. With a numeric prefix argument of `3', emulate `org-refile-keep'
  10390. being set to `t' and copy to the target location, don't move it.
  10391. Beware that keeping refiled entries may result in duplicated ID
  10392. properties.
  10393. RFLOC can be a refile location obtained in a different way.
  10394. MSG is a string to replace \"Refile\" in the default prompt with
  10395. another verb. E.g. `org-copy' sets this parameter to \"Copy\".
  10396. See also `org-refile-use-outline-path' and `org-completion-use-ido'.
  10397. If you are using target caching (see `org-refile-use-cache'),
  10398. you have to clear the target cache in order to find new targets.
  10399. This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
  10400. prefix argument (`C-u C-u C-u C-c C-w')."
  10401. (interactive "P")
  10402. (if (member goto '(0 (64)))
  10403. (org-refile-cache-clear)
  10404. (let* ((actionmsg (or msg "Refile"))
  10405. (cbuf (current-buffer))
  10406. (regionp (org-region-active-p))
  10407. (region-start (and regionp (region-beginning)))
  10408. (region-end (and regionp (region-end)))
  10409. (filename (buffer-file-name (buffer-base-buffer cbuf)))
  10410. (org-refile-keep (if (equal goto 3) t org-refile-keep))
  10411. pos it nbuf file re level reversed)
  10412. (setq last-command nil)
  10413. (when regionp
  10414. (goto-char region-start)
  10415. (or (bolp) (goto-char (point-at-bol)))
  10416. (setq region-start (point))
  10417. (unless (or (org-kill-is-subtree-p
  10418. (buffer-substring region-start region-end))
  10419. (prog1 org-refile-active-region-within-subtree
  10420. (let ((s (point-at-eol)))
  10421. (org-toggle-heading)
  10422. (setq region-end (+ (- (point-at-eol) s) region-end)))))
  10423. (user-error "The region is not a (sequence of) subtree(s)")))
  10424. (if (equal goto '(16))
  10425. (org-refile-goto-last-stored)
  10426. (when (or
  10427. (and (equal goto 2)
  10428. org-clock-hd-marker (marker-buffer org-clock-hd-marker)
  10429. (prog1
  10430. (setq it (list (or org-clock-heading "running clock")
  10431. (buffer-file-name
  10432. (marker-buffer org-clock-hd-marker))
  10433. ""
  10434. (marker-position org-clock-hd-marker)))
  10435. (setq goto nil)))
  10436. (setq it (or rfloc
  10437. (let (heading-text)
  10438. (save-excursion
  10439. (unless goto
  10440. (org-back-to-heading t)
  10441. (setq heading-text
  10442. (nth 4 (org-heading-components))))
  10443. (org-refile-get-location
  10444. (cond (goto "Goto")
  10445. (regionp (concat actionmsg " region to"))
  10446. (t (concat actionmsg " subtree \""
  10447. heading-text "\" to")))
  10448. default-buffer
  10449. (and (not (equal '(4) goto))
  10450. org-refile-allow-creating-parent-nodes)
  10451. goto))))))
  10452. (setq file (nth 1 it)
  10453. re (nth 2 it)
  10454. pos (nth 3 it))
  10455. (if (and (not goto)
  10456. pos
  10457. (equal (buffer-file-name) file)
  10458. (if regionp
  10459. (and (>= pos region-start)
  10460. (<= pos region-end))
  10461. (and (>= pos (point))
  10462. (< pos (save-excursion
  10463. (org-end-of-subtree t t))))))
  10464. (error "Cannot refile to position inside the tree or region"))
  10465. (setq nbuf (or (find-buffer-visiting file)
  10466. (find-file-noselect file)))
  10467. (if (and goto (not (equal goto 3)))
  10468. (progn
  10469. (org-pop-to-buffer-same-window nbuf)
  10470. (goto-char pos)
  10471. (org-show-context 'org-goto))
  10472. (if regionp
  10473. (progn
  10474. (org-kill-new (buffer-substring region-start region-end))
  10475. (org-save-markers-in-region region-start region-end))
  10476. (org-copy-subtree 1 nil t))
  10477. (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
  10478. (find-file-noselect file)))
  10479. (setq reversed (org-notes-order-reversed-p))
  10480. (save-excursion
  10481. (save-restriction
  10482. (widen)
  10483. (if pos
  10484. (progn
  10485. (goto-char pos)
  10486. (looking-at org-outline-regexp)
  10487. (setq level (org-get-valid-level (funcall outline-level) 1))
  10488. (goto-char
  10489. (if reversed
  10490. (or (outline-next-heading) (point-max))
  10491. (or (save-excursion (org-get-next-sibling))
  10492. (org-end-of-subtree t t)
  10493. (point-max)))))
  10494. (setq level 1)
  10495. (if (not reversed)
  10496. (goto-char (point-max))
  10497. (goto-char (point-min))
  10498. (or (outline-next-heading) (goto-char (point-max)))))
  10499. (if (not (bolp)) (newline))
  10500. (org-paste-subtree level)
  10501. (when org-log-refile
  10502. (org-add-log-setup 'refile nil nil 'findpos org-log-refile)
  10503. (unless (eq org-log-refile 'note)
  10504. (save-excursion (org-add-log-note))))
  10505. (and org-auto-align-tags
  10506. (let ((org-loop-over-headlines-in-active-region nil))
  10507. (org-set-tags nil t)))
  10508. (let ((bookmark-name (plist-get org-bookmark-names-plist
  10509. :last-refile)))
  10510. (when bookmark-name
  10511. (with-demoted-errors
  10512. (bookmark-set bookmark-name))))
  10513. ;; If we are refiling for capture, make sure that the
  10514. ;; last-capture pointers point here
  10515. (when (org-bound-and-true-p org-refile-for-capture)
  10516. (let ((bookmark-name (plist-get org-bookmark-names-plist
  10517. :last-capture-marker)))
  10518. (when bookmark-name
  10519. (with-demoted-errors
  10520. (bookmark-set bookmark-name))))
  10521. (move-marker org-capture-last-stored-marker (point)))
  10522. (if (fboundp 'deactivate-mark) (deactivate-mark))
  10523. (run-hooks 'org-after-refile-insert-hook))))
  10524. (unless org-refile-keep
  10525. (if regionp
  10526. (delete-region (point) (+ (point) (- region-end region-start)))
  10527. (delete-region
  10528. (and (org-back-to-heading t) (point))
  10529. (min (buffer-size) (org-end-of-subtree t t) (point)))))
  10530. (when (featurep 'org-inlinetask)
  10531. (org-inlinetask-remove-END-maybe))
  10532. (setq org-markers-to-move nil)
  10533. (message (concat actionmsg " to \"%s\" in file %s: done") (car it) file)))))))
  10534. (defun org-refile-goto-last-stored ()
  10535. "Go to the location where the last refile was stored."
  10536. (interactive)
  10537. (bookmark-jump "org-refile-last-stored")
  10538. (message "This is the location of the last refile"))
  10539. (defun org-refile-get-location (&optional prompt default-buffer new-nodes
  10540. no-exclude)
  10541. "Prompt the user for a refile location, using PROMPT.
  10542. PROMPT should not be suffixed with a colon and a space, because
  10543. this function appends the default value from
  10544. `org-refile-history' automatically, if that is not empty.
  10545. When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
  10546. this is used for the GOTO interface."
  10547. (let ((org-refile-targets org-refile-targets)
  10548. (org-refile-use-outline-path org-refile-use-outline-path)
  10549. excluded-entries)
  10550. (when (and (derived-mode-p 'org-mode)
  10551. (not org-refile-use-cache)
  10552. (not no-exclude))
  10553. (org-map-tree
  10554. (lambda()
  10555. (setq excluded-entries
  10556. (append excluded-entries (list (org-get-heading t t)))))))
  10557. (setq org-refile-target-table
  10558. (org-refile-get-targets default-buffer excluded-entries)))
  10559. (unless org-refile-target-table
  10560. (user-error "No refile targets"))
  10561. (let* ((cbuf (current-buffer))
  10562. (partial-completion-mode nil)
  10563. (cfn (buffer-file-name (buffer-base-buffer cbuf)))
  10564. (cfunc (if (and org-refile-use-outline-path
  10565. org-outline-path-complete-in-steps)
  10566. 'org-olpath-completing-read
  10567. 'org-icompleting-read))
  10568. (extra (if org-refile-use-outline-path "/" ""))
  10569. (cbnex (concat (buffer-name) extra))
  10570. (filename (and cfn (expand-file-name cfn)))
  10571. (tbl (mapcar
  10572. (lambda (x)
  10573. (if (and (not (member org-refile-use-outline-path
  10574. '(file full-file-path)))
  10575. (not (equal filename (nth 1 x))))
  10576. (cons (concat (car x) extra " ("
  10577. (file-name-nondirectory (nth 1 x)) ")")
  10578. (cdr x))
  10579. (cons (concat (car x) extra) (cdr x))))
  10580. org-refile-target-table))
  10581. (completion-ignore-case t)
  10582. cdef
  10583. (prompt (concat prompt
  10584. (or (and (car org-refile-history)
  10585. (concat " (default " (car org-refile-history) ")"))
  10586. (and (assoc cbnex tbl) (setq cdef cbnex)
  10587. (concat " (default " cbnex ")"))) ": "))
  10588. pa answ parent-target child parent old-hist)
  10589. (setq old-hist org-refile-history)
  10590. (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
  10591. nil 'org-refile-history (or cdef (car org-refile-history))))
  10592. (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
  10593. (org-refile-check-position pa)
  10594. (if pa
  10595. (progn
  10596. (when (or (not org-refile-history)
  10597. (not (eq old-hist org-refile-history))
  10598. (not (equal (car pa) (car org-refile-history))))
  10599. (setq org-refile-history
  10600. (cons (car pa) (if (assoc (car org-refile-history) tbl)
  10601. org-refile-history
  10602. (cdr org-refile-history))))
  10603. (if (equal (car org-refile-history) (nth 1 org-refile-history))
  10604. (pop org-refile-history)))
  10605. pa)
  10606. (if (string-match "\\`\\(.*\\)/\\([^/]+\\)\\'" answ)
  10607. (progn
  10608. (setq parent (match-string 1 answ)
  10609. child (match-string 2 answ))
  10610. (setq parent-target (or (assoc parent tbl)
  10611. (assoc (concat parent "/") tbl)))
  10612. (when (and parent-target
  10613. (or (eq new-nodes t)
  10614. (and (eq new-nodes 'confirm)
  10615. (y-or-n-p (format "Create new node \"%s\"? "
  10616. child)))))
  10617. (org-refile-new-child parent-target child)))
  10618. (user-error "Invalid target location")))))
  10619. (declare-function org-string-nw-p "org-macs" (s))
  10620. (defun org-refile-check-position (refile-pointer)
  10621. "Check if the refile pointer matches the headline to which it points."
  10622. (let* ((file (nth 1 refile-pointer))
  10623. (re (nth 2 refile-pointer))
  10624. (pos (nth 3 refile-pointer))
  10625. buffer)
  10626. (if (and (not (markerp pos)) (not file))
  10627. (user-error "Please save the buffer to a file before refiling")
  10628. (when (org-string-nw-p re)
  10629. (setq buffer (if (markerp pos)
  10630. (marker-buffer pos)
  10631. (or (find-buffer-visiting file)
  10632. (find-file-noselect file))))
  10633. (with-current-buffer buffer
  10634. (save-excursion
  10635. (save-restriction
  10636. (widen)
  10637. (goto-char pos)
  10638. (beginning-of-line 1)
  10639. (unless (org-looking-at-p re)
  10640. (user-error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling")))))))))
  10641. (defun org-refile-new-child (parent-target child)
  10642. "Use refile target PARENT-TARGET to add new CHILD below it."
  10643. (unless parent-target
  10644. (error "Cannot find parent for new node"))
  10645. (let ((file (nth 1 parent-target))
  10646. (pos (nth 3 parent-target))
  10647. level)
  10648. (with-current-buffer (or (find-buffer-visiting file)
  10649. (find-file-noselect file))
  10650. (save-excursion
  10651. (save-restriction
  10652. (widen)
  10653. (if pos
  10654. (goto-char pos)
  10655. (goto-char (point-max))
  10656. (if (not (bolp)) (newline)))
  10657. (when (looking-at org-outline-regexp)
  10658. (setq level (funcall outline-level))
  10659. (org-end-of-subtree t t))
  10660. (org-back-over-empty-lines)
  10661. (insert "\n" (make-string
  10662. (if pos (org-get-valid-level level 1) 1) ?*)
  10663. " " child "\n")
  10664. (beginning-of-line 0)
  10665. (list (concat (car parent-target) "/" child) file "" (point)))))))
  10666. (defun org-olpath-completing-read (prompt collection &rest args)
  10667. "Read an outline path like a file name."
  10668. (let ((thetable collection)
  10669. (org-completion-use-ido nil) ; does not work with ido.
  10670. (org-completion-use-iswitchb nil)) ; or iswitchb
  10671. (apply
  10672. 'org-icompleting-read prompt
  10673. (lambda (string predicate &optional flag)
  10674. (let (rtn r f (l (length string)))
  10675. (cond
  10676. ((eq flag nil)
  10677. ;; try completion
  10678. (try-completion string thetable))
  10679. ((eq flag t)
  10680. ;; all-completions
  10681. (setq rtn (all-completions string thetable predicate))
  10682. (mapcar
  10683. (lambda (x)
  10684. (setq r (substring x l))
  10685. (if (string-match " ([^)]*)$" x)
  10686. (setq f (match-string 0 x))
  10687. (setq f ""))
  10688. (if (string-match "/" r)
  10689. (concat string (substring r 0 (match-end 0)) f)
  10690. x))
  10691. rtn))
  10692. ((eq flag 'lambda)
  10693. ;; exact match?
  10694. (assoc string thetable)))))
  10695. args)))
  10696. ;;;; Dynamic blocks
  10697. (defun org-find-dblock (name)
  10698. "Find the first dynamic block with name NAME in the buffer.
  10699. If not found, stay at current position and return nil."
  10700. (let ((case-fold-search t) pos)
  10701. (save-excursion
  10702. (goto-char (point-min))
  10703. (setq pos (and (re-search-forward
  10704. (concat "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+" name "\\>") nil t)
  10705. (match-beginning 0))))
  10706. (if pos (goto-char pos))
  10707. pos))
  10708. (defconst org-dblock-start-re
  10709. "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+\\(\\S-+\\)\\([ \t]+\\(.*\\)\\)?"
  10710. "Matches the start line of a dynamic block, with parameters.")
  10711. (defconst org-dblock-end-re "^[ \t]*#\\+\\(?:END\\|end\\)\\([: \t\r\n]\\|$\\)"
  10712. "Matches the end of a dynamic block.")
  10713. (defun org-create-dblock (plist)
  10714. "Create a dynamic block section, with parameters taken from PLIST.
  10715. PLIST must contain a :name entry which is used as name of the block."
  10716. (when (string-match "\\S-" (buffer-substring (point-at-bol) (point-at-eol)))
  10717. (end-of-line 1)
  10718. (newline))
  10719. (let ((col (current-column))
  10720. (name (plist-get plist :name)))
  10721. (insert "#+BEGIN: " name)
  10722. (while plist
  10723. (if (eq (car plist) :name)
  10724. (setq plist (cddr plist))
  10725. (insert " " (prin1-to-string (pop plist)))))
  10726. (insert "\n\n" (make-string col ?\ ) "#+END:\n")
  10727. (beginning-of-line -2)))
  10728. (defun org-prepare-dblock ()
  10729. "Prepare dynamic block for refresh.
  10730. This empties the block, puts the cursor at the insert position and returns
  10731. the property list including an extra property :name with the block name."
  10732. (unless (looking-at org-dblock-start-re)
  10733. (user-error "Not at a dynamic block"))
  10734. (let* ((begdel (1+ (match-end 0)))
  10735. (name (org-no-properties (match-string 1)))
  10736. (params (append (list :name name)
  10737. (read (concat "(" (match-string 3) ")")))))
  10738. (save-excursion
  10739. (beginning-of-line 1)
  10740. (skip-chars-forward " \t")
  10741. (setq params (plist-put params :indentation-column (current-column))))
  10742. (unless (re-search-forward org-dblock-end-re nil t)
  10743. (error "Dynamic block not terminated"))
  10744. (setq params
  10745. (append params
  10746. (list :content (buffer-substring
  10747. begdel (match-beginning 0)))))
  10748. (delete-region begdel (match-beginning 0))
  10749. (goto-char begdel)
  10750. (open-line 1)
  10751. params))
  10752. (defun org-map-dblocks (&optional command)
  10753. "Apply COMMAND to all dynamic blocks in the current buffer.
  10754. If COMMAND is not given, use `org-update-dblock'."
  10755. (let ((cmd (or command 'org-update-dblock)))
  10756. (save-excursion
  10757. (goto-char (point-min))
  10758. (while (re-search-forward org-dblock-start-re nil t)
  10759. (goto-char (match-beginning 0))
  10760. (save-excursion
  10761. (condition-case nil
  10762. (funcall cmd)
  10763. (error (message "Error during update of dynamic block"))))
  10764. (unless (re-search-forward org-dblock-end-re nil t)
  10765. (error "Dynamic block not terminated"))))))
  10766. (defun org-dblock-update (&optional arg)
  10767. "User command for updating dynamic blocks.
  10768. Update the dynamic block at point. With prefix ARG, update all dynamic
  10769. blocks in the buffer."
  10770. (interactive "P")
  10771. (if arg
  10772. (org-update-all-dblocks)
  10773. (or (looking-at org-dblock-start-re)
  10774. (org-beginning-of-dblock))
  10775. (org-update-dblock)))
  10776. (defun org-update-dblock ()
  10777. "Update the dynamic block at point.
  10778. This means to empty the block, parse for parameters and then call
  10779. the correct writing function."
  10780. (interactive)
  10781. (save-window-excursion
  10782. (let* ((pos (point))
  10783. (line (org-current-line))
  10784. (params (org-prepare-dblock))
  10785. (name (plist-get params :name))
  10786. (indent (plist-get params :indentation-column))
  10787. (cmd (intern (concat "org-dblock-write:" name))))
  10788. (message "Updating dynamic block `%s' at line %d..." name line)
  10789. (funcall cmd params)
  10790. (message "Updating dynamic block `%s' at line %d...done" name line)
  10791. (goto-char pos)
  10792. (when (and indent (> indent 0))
  10793. (setq indent (make-string indent ?\ ))
  10794. (save-excursion
  10795. (org-beginning-of-dblock)
  10796. (forward-line 1)
  10797. (while (not (looking-at org-dblock-end-re))
  10798. (insert indent)
  10799. (beginning-of-line 2))
  10800. (when (looking-at org-dblock-end-re)
  10801. (and (looking-at "[ \t]+")
  10802. (replace-match ""))
  10803. (insert indent)))))))
  10804. (defun org-beginning-of-dblock ()
  10805. "Find the beginning of the dynamic block at point.
  10806. Error if there is no such block at point."
  10807. (let ((pos (point))
  10808. beg)
  10809. (end-of-line 1)
  10810. (if (and (re-search-backward org-dblock-start-re nil t)
  10811. (setq beg (match-beginning 0))
  10812. (re-search-forward org-dblock-end-re nil t)
  10813. (> (match-end 0) pos))
  10814. (goto-char beg)
  10815. (goto-char pos)
  10816. (error "Not in a dynamic block"))))
  10817. (defun org-update-all-dblocks ()
  10818. "Update all dynamic blocks in the buffer.
  10819. This function can be used in a hook."
  10820. (interactive)
  10821. (when (derived-mode-p 'org-mode)
  10822. (org-map-dblocks 'org-update-dblock)))
  10823. ;;;; Completion
  10824. (declare-function org-export-backend-name "org-export" (cl-x))
  10825. (declare-function org-export-backend-options "org-export" (cl-x))
  10826. (defun org-get-export-keywords ()
  10827. "Return a list of all currently understood export keywords.
  10828. Export keywords include options, block names, attributes and
  10829. keywords relative to each registered export back-end."
  10830. (let (keywords)
  10831. (dolist (backend
  10832. (org-bound-and-true-p org-export--registered-backends)
  10833. (delq nil keywords))
  10834. ;; Back-end name (for keywords, like #+LATEX:)
  10835. (push (upcase (symbol-name (org-export-backend-name backend))) keywords)
  10836. (dolist (option-entry (org-export-backend-options backend))
  10837. ;; Back-end options.
  10838. (push (nth 1 option-entry) keywords)))))
  10839. (defconst org-options-keywords
  10840. '("ARCHIVE:" "AUTHOR:" "BIND:" "CATEGORY:" "COLUMNS:" "CREATOR:" "DATE:"
  10841. "DESCRIPTION:" "DRAWERS:" "EMAIL:" "EXCLUDE_TAGS:" "FILETAGS:" "INCLUDE:"
  10842. "INDEX:" "KEYWORDS:" "LANGUAGE:" "MACRO:" "OPTIONS:" "PROPERTY:"
  10843. "PRIORITIES:" "SELECT_TAGS:" "SEQ_TODO:" "SETUPFILE:" "STARTUP:" "TAGS:"
  10844. "TITLE:" "TODO:" "TYP_TODO:" "SELECT_TAGS:" "EXCLUDE_TAGS:"))
  10845. (defcustom org-structure-template-alist
  10846. '(("s" "#+BEGIN_SRC ?\n\n#+END_SRC" "<src lang=\"?\">\n\n</src>")
  10847. ("e" "#+BEGIN_EXAMPLE\n?\n#+END_EXAMPLE" "<example>\n?\n</example>")
  10848. ("q" "#+BEGIN_QUOTE\n?\n#+END_QUOTE" "<quote>\n?\n</quote>")
  10849. ("v" "#+BEGIN_VERSE\n?\n#+END_VERSE" "<verse>\n?\n</verse>")
  10850. ("V" "#+BEGIN_VERBATIM\n?\n#+END_VERBATIM" "<verbatim>\n?\n</verbatim>")
  10851. ("c" "#+BEGIN_CENTER\n?\n#+END_CENTER" "<center>\n?\n</center>")
  10852. ("l" "#+BEGIN_LaTeX\n?\n#+END_LaTeX"
  10853. "<literal style=\"latex\">\n?\n</literal>")
  10854. ("L" "#+LaTeX: " "<literal style=\"latex\">?</literal>")
  10855. ("h" "#+BEGIN_HTML\n?\n#+END_HTML"
  10856. "<literal style=\"html\">\n?\n</literal>")
  10857. ("H" "#+HTML: " "<literal style=\"html\">?</literal>")
  10858. ("a" "#+BEGIN_ASCII\n?\n#+END_ASCII" "")
  10859. ("A" "#+ASCII: " "")
  10860. ("i" "#+INDEX: ?" "#+INDEX: ?")
  10861. ("I" "#+INCLUDE: %file ?"
  10862. "<include file=%file markup=\"?\">"))
  10863. "Structure completion elements.
  10864. This is a list of abbreviation keys and values. The value gets inserted
  10865. if you type `<' followed by the key and then press the completion key,
  10866. usually `M-TAB'. %file will be replaced by a file name after prompting
  10867. for the file using completion. The cursor will be placed at the position
  10868. of the `?` in the template.
  10869. There are two templates for each key, the first uses the original Org syntax,
  10870. the second uses Emacs Muse-like syntax tags. These Muse-like tags become
  10871. the default when the /org-mtags.el/ module has been loaded. See also the
  10872. variable `org-mtags-prefer-muse-templates'."
  10873. :group 'org-completion
  10874. :type '(repeat
  10875. (list
  10876. (string :tag "Key")
  10877. (string :tag "Template")
  10878. (string :tag "Muse Template"))))
  10879. (defun org-try-structure-completion ()
  10880. "Try to complete a structure template before point.
  10881. This looks for strings like \"<e\" on an otherwise empty line and
  10882. expands them."
  10883. (let ((l (buffer-substring (point-at-bol) (point)))
  10884. a)
  10885. (when (and (looking-at "[ \t]*$")
  10886. (string-match "^[ \t]*<\\([a-zA-Z]+\\)$" l)
  10887. (setq a (assoc (match-string 1 l) org-structure-template-alist)))
  10888. (org-complete-expand-structure-template (+ -1 (point-at-bol)
  10889. (match-beginning 1)) a)
  10890. t)))
  10891. (defun org-complete-expand-structure-template (start cell)
  10892. "Expand a structure template."
  10893. (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
  10894. (rpl (nth (if musep 2 1) cell))
  10895. (ind ""))
  10896. (delete-region start (point))
  10897. (when (string-match "\\`#\\+" rpl)
  10898. (cond
  10899. ((bolp))
  10900. ((not (string-match "\\S-" (buffer-substring (point-at-bol) (point))))
  10901. (setq ind (buffer-substring (point-at-bol) (point))))
  10902. (t (newline))))
  10903. (setq start (point))
  10904. (if (string-match "%file" rpl)
  10905. (setq rpl (replace-match
  10906. (concat
  10907. "\""
  10908. (save-match-data
  10909. (abbreviate-file-name (read-file-name "Include file: ")))
  10910. "\"")
  10911. t t rpl)))
  10912. (setq rpl (mapconcat 'identity (split-string rpl "\n")
  10913. (concat "\n" ind)))
  10914. (insert rpl)
  10915. (if (re-search-backward "\\?" start t) (delete-char 1))))
  10916. ;;;; TODO, DEADLINE, Comments
  10917. (defun org-toggle-comment ()
  10918. "Change the COMMENT state of an entry."
  10919. (interactive)
  10920. (save-excursion
  10921. (org-back-to-heading)
  10922. (let (case-fold-search)
  10923. (cond
  10924. ((looking-at (format org-heading-keyword-regexp-format
  10925. org-comment-string))
  10926. (goto-char (match-end 1))
  10927. (looking-at (concat " +" org-comment-string))
  10928. (replace-match "" t t)
  10929. (when (eolp) (insert " ")))
  10930. ((looking-at org-outline-regexp)
  10931. (goto-char (match-end 0))
  10932. (insert org-comment-string " "))))))
  10933. (defvar org-last-todo-state-is-todo nil
  10934. "This is non-nil when the last TODO state change led to a TODO state.
  10935. If the last change removed the TODO tag or switched to DONE, then
  10936. this is nil.")
  10937. (defvar org-setting-tags nil) ; dynamically skipped
  10938. (defvar org-todo-setup-filter-hook nil
  10939. "Hook for functions that pre-filter todo specs.
  10940. Each function takes a todo spec and returns either nil or the spec
  10941. transformed into canonical form." )
  10942. (defvar org-todo-get-default-hook nil
  10943. "Hook for functions that get a default item for todo.
  10944. Each function takes arguments (NEW-MARK OLD-MARK) and returns either
  10945. nil or a string to be used for the todo mark." )
  10946. (defvar org-agenda-headline-snapshot-before-repeat)
  10947. (defun org-current-effective-time ()
  10948. "Return current time adjusted for `org-extend-today-until' variable."
  10949. (let* ((ct (org-current-time))
  10950. (dct (decode-time ct))
  10951. (ct1
  10952. (cond
  10953. (org-use-last-clock-out-time-as-effective-time
  10954. (or (org-clock-get-last-clock-out-time) ct))
  10955. ((and org-use-effective-time (< (nth 2 dct) org-extend-today-until))
  10956. (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct)))
  10957. (t ct))))
  10958. ct1))
  10959. (defun org-todo-yesterday (&optional arg)
  10960. "Like `org-todo' but the time of change will be 23:59 of yesterday."
  10961. (interactive "P")
  10962. (if (eq major-mode 'org-agenda-mode)
  10963. (apply 'org-agenda-todo-yesterday arg)
  10964. (let* ((hour (third (decode-time
  10965. (org-current-time))))
  10966. (org-extend-today-until (1+ hour)))
  10967. (org-todo arg))))
  10968. (defvar org-block-entry-blocking ""
  10969. "First entry preventing the TODO state change.")
  10970. (defun org-todo (&optional arg)
  10971. "Change the TODO state of an item.
  10972. The state of an item is given by a keyword at the start of the heading,
  10973. like
  10974. *** TODO Write paper
  10975. *** DONE Call mom
  10976. The different keywords are specified in the variable `org-todo-keywords'.
  10977. By default the available states are \"TODO\" and \"DONE\".
  10978. So for this example: when the item starts with TODO, it is changed to DONE.
  10979. When it starts with DONE, the DONE is removed. And when neither TODO nor
  10980. DONE are present, add TODO at the beginning of the heading.
  10981. With \\[universal-argument] prefix arg, use completion to determine the new \
  10982. state.
  10983. With numeric prefix arg, switch to that state.
  10984. With a double \\[universal-argument] prefix, switch to the next set of TODO \
  10985. keywords (nextset).
  10986. With a triple \\[universal-argument] prefix, circumvent any state blocking.
  10987. With a numeric prefix arg of 0, inhibit note taking for the change.
  10988. For calling through lisp, arg is also interpreted in the following way:
  10989. 'none -> empty state
  10990. \"\"(empty string) -> switch to empty state
  10991. 'done -> switch to DONE
  10992. 'nextset -> switch to the next set of keywords
  10993. 'previousset -> switch to the previous set of keywords
  10994. \"WAITING\" -> switch to the specified keyword, but only if it
  10995. really is a member of `org-todo-keywords'."
  10996. (interactive "P")
  10997. (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
  10998. (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
  10999. 'region-start-level 'region))
  11000. org-loop-over-headlines-in-active-region)
  11001. (org-map-entries
  11002. `(org-todo ,arg)
  11003. org-loop-over-headlines-in-active-region
  11004. cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
  11005. (if (equal arg '(16)) (setq arg 'nextset))
  11006. (let ((org-blocker-hook org-blocker-hook)
  11007. commentp
  11008. case-fold-search)
  11009. (when (equal arg '(64))
  11010. (setq arg nil org-blocker-hook nil))
  11011. (when (and org-blocker-hook
  11012. (or org-inhibit-blocking
  11013. (org-entry-get nil "NOBLOCKING")))
  11014. (setq org-blocker-hook nil))
  11015. (save-excursion
  11016. (catch 'exit
  11017. (org-back-to-heading t)
  11018. (when (looking-at (concat "^\\*+ " org-comment-string))
  11019. (org-toggle-comment)
  11020. (setq commentp t))
  11021. (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
  11022. (or (looking-at (concat " +" org-todo-regexp "\\( +\\|[ \t]*$\\)"))
  11023. (looking-at "\\(?: *\\|[ \t]*$\\)"))
  11024. (let* ((match-data (match-data))
  11025. (startpos (point-at-bol))
  11026. (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
  11027. (org-log-done org-log-done)
  11028. (org-log-repeat org-log-repeat)
  11029. (org-todo-log-states org-todo-log-states)
  11030. (org-inhibit-logging
  11031. (if (equal arg 0)
  11032. (progn (setq arg nil) 'note) org-inhibit-logging))
  11033. (this (match-string 1))
  11034. (hl-pos (match-beginning 0))
  11035. (head (org-get-todo-sequence-head this))
  11036. (ass (assoc head org-todo-kwd-alist))
  11037. (interpret (nth 1 ass))
  11038. (done-word (nth 3 ass))
  11039. (final-done-word (nth 4 ass))
  11040. (org-last-state (or this ""))
  11041. (completion-ignore-case t)
  11042. (member (member this org-todo-keywords-1))
  11043. (tail (cdr member))
  11044. (org-state (cond
  11045. ((and org-todo-key-trigger
  11046. (or (and (equal arg '(4))
  11047. (eq org-use-fast-todo-selection 'prefix))
  11048. (and (not arg) org-use-fast-todo-selection
  11049. (not (eq org-use-fast-todo-selection
  11050. 'prefix)))))
  11051. ;; Use fast selection
  11052. (org-fast-todo-selection))
  11053. ((and (equal arg '(4))
  11054. (or (not org-use-fast-todo-selection)
  11055. (not org-todo-key-trigger)))
  11056. ;; Read a state with completion
  11057. (org-icompleting-read
  11058. "State: " (mapcar 'list org-todo-keywords-1)
  11059. nil t))
  11060. ((eq arg 'right)
  11061. (if this
  11062. (if tail (car tail) nil)
  11063. (car org-todo-keywords-1)))
  11064. ((eq arg 'left)
  11065. (if (equal member org-todo-keywords-1)
  11066. nil
  11067. (if this
  11068. (nth (- (length org-todo-keywords-1)
  11069. (length tail) 2)
  11070. org-todo-keywords-1)
  11071. (org-last org-todo-keywords-1))))
  11072. ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
  11073. (setq arg nil))) ; hack to fall back to cycling
  11074. (arg
  11075. ;; user or caller requests a specific state
  11076. (cond
  11077. ((equal arg "") nil)
  11078. ((eq arg 'none) nil)
  11079. ((eq arg 'done) (or done-word (car org-done-keywords)))
  11080. ((eq arg 'nextset)
  11081. (or (car (cdr (member head org-todo-heads)))
  11082. (car org-todo-heads)))
  11083. ((eq arg 'previousset)
  11084. (let ((org-todo-heads (reverse org-todo-heads)))
  11085. (or (car (cdr (member head org-todo-heads)))
  11086. (car org-todo-heads))))
  11087. ((car (member arg org-todo-keywords-1)))
  11088. ((stringp arg)
  11089. (user-error "State `%s' not valid in this file" arg))
  11090. ((nth (1- (prefix-numeric-value arg))
  11091. org-todo-keywords-1))))
  11092. ((null member) (or head (car org-todo-keywords-1)))
  11093. ((equal this final-done-word) nil) ;; -> make empty
  11094. ((null tail) nil) ;; -> first entry
  11095. ((memq interpret '(type priority))
  11096. (if (eq this-command last-command)
  11097. (car tail)
  11098. (if (> (length tail) 0)
  11099. (or done-word (car org-done-keywords))
  11100. nil)))
  11101. (t
  11102. (car tail))))
  11103. (org-state (or
  11104. (run-hook-with-args-until-success
  11105. 'org-todo-get-default-hook org-state org-last-state)
  11106. org-state))
  11107. (next (if org-state (concat " " org-state " ") " "))
  11108. (change-plist (list :type 'todo-state-change :from this :to org-state
  11109. :position startpos))
  11110. dolog now-done-p)
  11111. (when org-blocker-hook
  11112. (setq org-last-todo-state-is-todo
  11113. (not (member this org-done-keywords)))
  11114. (unless (save-excursion
  11115. (save-match-data
  11116. (org-with-wide-buffer
  11117. (run-hook-with-args-until-failure
  11118. 'org-blocker-hook change-plist))))
  11119. (if (org-called-interactively-p 'interactive)
  11120. (user-error "TODO state change from %s to %s blocked (by \"%s\")"
  11121. this org-state org-block-entry-blocking)
  11122. ;; fail silently
  11123. (message "TODO state change from %s to %s blocked (by \"%s\")"
  11124. this org-state org-block-entry-blocking)
  11125. (throw 'exit nil))))
  11126. (store-match-data match-data)
  11127. (replace-match next t t)
  11128. (unless (pos-visible-in-window-p hl-pos)
  11129. (message "TODO state changed to %s" (org-trim next)))
  11130. (unless head
  11131. (setq head (org-get-todo-sequence-head org-state)
  11132. ass (assoc head org-todo-kwd-alist)
  11133. interpret (nth 1 ass)
  11134. done-word (nth 3 ass)
  11135. final-done-word (nth 4 ass)))
  11136. (when (memq arg '(nextset previousset))
  11137. (message "Keyword-Set %d/%d: %s"
  11138. (- (length org-todo-sets) -1
  11139. (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
  11140. (length org-todo-sets)
  11141. (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
  11142. (setq org-last-todo-state-is-todo
  11143. (not (member org-state org-done-keywords)))
  11144. (setq now-done-p (and (member org-state org-done-keywords)
  11145. (not (member this org-done-keywords))))
  11146. (and logging (org-local-logging logging))
  11147. (when (and (or org-todo-log-states org-log-done)
  11148. (not (eq org-inhibit-logging t))
  11149. (not (memq arg '(nextset previousset))))
  11150. ;; we need to look at recording a time and note
  11151. (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
  11152. (nth 2 (assoc this org-todo-log-states))))
  11153. (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
  11154. (setq dolog 'time))
  11155. (when (or (and (not org-state) (not org-closed-keep-when-no-todo))
  11156. (and org-state
  11157. (member org-state org-not-done-keywords)
  11158. (not (member this org-not-done-keywords))))
  11159. ;; This is now a todo state and was not one before
  11160. ;; If there was a CLOSED time stamp, get rid of it.
  11161. (org-add-planning-info nil nil 'closed))
  11162. (when (and now-done-p org-log-done)
  11163. ;; It is now done, and it was not done before
  11164. (org-add-planning-info 'closed (org-current-effective-time))
  11165. (if (and (not dolog) (eq 'note org-log-done))
  11166. (org-add-log-setup 'done org-state this 'findpos 'note)))
  11167. (when (and org-state dolog)
  11168. ;; This is a non-nil state, and we need to log it
  11169. (org-add-log-setup 'state org-state this 'findpos dolog)))
  11170. ;; Fixup tag positioning
  11171. (org-todo-trigger-tag-changes org-state)
  11172. (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
  11173. (when org-provide-todo-statistics
  11174. (org-update-parent-todo-statistics))
  11175. (run-hooks 'org-after-todo-state-change-hook)
  11176. (if (and arg (not (member org-state org-done-keywords)))
  11177. (setq head (org-get-todo-sequence-head org-state)))
  11178. (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
  11179. ;; Do we need to trigger a repeat?
  11180. (when now-done-p
  11181. (when (boundp 'org-agenda-headline-snapshot-before-repeat)
  11182. ;; This is for the agenda, take a snapshot of the headline.
  11183. (save-match-data
  11184. (setq org-agenda-headline-snapshot-before-repeat
  11185. (org-get-heading))))
  11186. (org-auto-repeat-maybe org-state))
  11187. ;; Fixup cursor location if close to the keyword
  11188. (if (and (outline-on-heading-p)
  11189. (not (bolp))
  11190. (save-excursion (beginning-of-line 1)
  11191. (looking-at org-todo-line-regexp))
  11192. (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
  11193. (progn
  11194. (goto-char (or (match-end 2) (match-end 1)))
  11195. (and (looking-at " ") (just-one-space))))
  11196. (when org-trigger-hook
  11197. (save-excursion
  11198. (run-hook-with-args 'org-trigger-hook change-plist)))
  11199. (when commentp (org-toggle-comment))))))))
  11200. (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
  11201. "Block turning an entry into a TODO, using the hierarchy.
  11202. This checks whether the current task should be blocked from state
  11203. changes. Such blocking occurs when:
  11204. 1. The task has children which are not all in a completed state.
  11205. 2. A task has a parent with the property :ORDERED:, and there
  11206. are siblings prior to the current task with incomplete
  11207. status.
  11208. 3. The parent of the task is blocked because it has siblings that should
  11209. be done first, or is child of a block grandparent TODO entry."
  11210. (if (not org-enforce-todo-dependencies)
  11211. t ; if locally turned off don't block
  11212. (catch 'dont-block
  11213. ;; If this is not a todo state change, or if this entry is already DONE,
  11214. ;; do not block
  11215. (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
  11216. (member (plist-get change-plist :from)
  11217. (cons 'done org-done-keywords))
  11218. (member (plist-get change-plist :to)
  11219. (cons 'todo org-not-done-keywords))
  11220. (not (plist-get change-plist :to)))
  11221. (throw 'dont-block t))
  11222. ;; If this task has children, and any are undone, it's blocked
  11223. (save-excursion
  11224. (org-back-to-heading t)
  11225. (let ((this-level (funcall outline-level)))
  11226. (outline-next-heading)
  11227. (let ((child-level (funcall outline-level)))
  11228. (while (and (not (eobp))
  11229. (> child-level this-level))
  11230. ;; this todo has children, check whether they are all
  11231. ;; completed
  11232. (if (and (not (org-entry-is-done-p))
  11233. (org-entry-is-todo-p))
  11234. (progn (setq org-block-entry-blocking (org-get-heading))
  11235. (throw 'dont-block nil)))
  11236. (outline-next-heading)
  11237. (setq child-level (funcall outline-level))))))
  11238. ;; Otherwise, if the task's parent has the :ORDERED: property, and
  11239. ;; any previous siblings are undone, it's blocked
  11240. (save-excursion
  11241. (org-back-to-heading t)
  11242. (let* ((pos (point))
  11243. (parent-pos (and (org-up-heading-safe) (point))))
  11244. (if (not parent-pos) (throw 'dont-block t)) ; no parent
  11245. (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
  11246. (forward-line 1)
  11247. (re-search-forward org-not-done-heading-regexp pos t))
  11248. (setq org-block-entry-blocking (match-string 0))
  11249. (throw 'dont-block nil)) ; block, there is an older sibling not done.
  11250. ;; Search further up the hierarchy, to see if an ancestor is blocked
  11251. (while t
  11252. (goto-char parent-pos)
  11253. (if (not (looking-at org-not-done-heading-regexp))
  11254. (throw 'dont-block t)) ; do not block, parent is not a TODO
  11255. (setq pos (point))
  11256. (setq parent-pos (and (org-up-heading-safe) (point)))
  11257. (if (not parent-pos) (throw 'dont-block t)) ; no parent
  11258. (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
  11259. (forward-line 1)
  11260. (re-search-forward org-not-done-heading-regexp pos t)
  11261. (setq org-block-entry-blocking (org-get-heading)))
  11262. (throw 'dont-block nil)))))))) ; block, older sibling not done.
  11263. (defcustom org-track-ordered-property-with-tag nil
  11264. "Should the ORDERED property also be shown as a tag?
  11265. The ORDERED property decides if an entry should require subtasks to be
  11266. completed in sequence. Since a property is not very visible, setting
  11267. this option means that toggling the ORDERED property with the command
  11268. `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
  11269. not relevant for the behavior, but it makes things more visible.
  11270. Note that toggling the tag with tags commands will not change the property
  11271. and therefore not influence behavior!
  11272. This can be t, meaning the tag ORDERED should be used, It can also be a
  11273. string to select a different tag for this task."
  11274. :group 'org-todo
  11275. :type '(choice
  11276. (const :tag "No tracking" nil)
  11277. (const :tag "Track with ORDERED tag" t)
  11278. (string :tag "Use other tag")))
  11279. (defun org-toggle-ordered-property ()
  11280. "Toggle the ORDERED property of the current entry.
  11281. For better visibility, you can track the value of this property with a tag.
  11282. See variable `org-track-ordered-property-with-tag'."
  11283. (interactive)
  11284. (let* ((t1 org-track-ordered-property-with-tag)
  11285. (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
  11286. (save-excursion
  11287. (org-back-to-heading)
  11288. (if (org-entry-get nil "ORDERED")
  11289. (progn
  11290. (org-delete-property "ORDERED" "PROPERTIES")
  11291. (and tag (org-toggle-tag tag 'off))
  11292. (message "Subtasks can be completed in arbitrary order"))
  11293. (org-entry-put nil "ORDERED" "t")
  11294. (and tag (org-toggle-tag tag 'on))
  11295. (message "Subtasks must be completed in sequence")))))
  11296. (defvar org-blocked-by-checkboxes) ; dynamically scoped
  11297. (defun org-block-todo-from-checkboxes (change-plist)
  11298. "Block turning an entry into a TODO, using checkboxes.
  11299. This checks whether the current task should be blocked from state
  11300. changes because there are unchecked boxes in this entry."
  11301. (if (not org-enforce-todo-checkbox-dependencies)
  11302. t ; if locally turned off don't block
  11303. (catch 'dont-block
  11304. ;; If this is not a todo state change, or if this entry is already DONE,
  11305. ;; do not block
  11306. (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
  11307. (member (plist-get change-plist :from)
  11308. (cons 'done org-done-keywords))
  11309. (member (plist-get change-plist :to)
  11310. (cons 'todo org-not-done-keywords))
  11311. (not (plist-get change-plist :to)))
  11312. (throw 'dont-block t))
  11313. ;; If this task has checkboxes that are not checked, it's blocked
  11314. (save-excursion
  11315. (org-back-to-heading t)
  11316. (let ((beg (point)) end)
  11317. (outline-next-heading)
  11318. (setq end (point))
  11319. (goto-char beg)
  11320. (if (org-list-search-forward
  11321. (concat (org-item-beginning-re)
  11322. "\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?"
  11323. "\\[[- ]\\]")
  11324. end t)
  11325. (progn
  11326. (if (boundp 'org-blocked-by-checkboxes)
  11327. (setq org-blocked-by-checkboxes t))
  11328. (throw 'dont-block nil)))))
  11329. t))) ; do not block
  11330. (defun org-entry-blocked-p ()
  11331. "Is the current entry blocked?"
  11332. (org-with-silent-modifications
  11333. (if (org-entry-get nil "NOBLOCKING")
  11334. nil ;; Never block this entry
  11335. (not (run-hook-with-args-until-failure
  11336. 'org-blocker-hook
  11337. (list :type 'todo-state-change
  11338. :position (point)
  11339. :from 'todo
  11340. :to 'done))))))
  11341. (defun org-update-statistics-cookies (all)
  11342. "Update the statistics cookie, either from TODO or from checkboxes.
  11343. This should be called with the cursor in a line with a statistics cookie."
  11344. (interactive "P")
  11345. (if all
  11346. (progn
  11347. (org-update-checkbox-count 'all)
  11348. (org-map-entries 'org-update-parent-todo-statistics))
  11349. (if (not (org-at-heading-p))
  11350. (org-update-checkbox-count)
  11351. (let ((pos (point-marker))
  11352. end l1 l2)
  11353. (ignore-errors (org-back-to-heading t))
  11354. (if (not (org-at-heading-p))
  11355. (org-update-checkbox-count)
  11356. (setq l1 (org-outline-level))
  11357. (setq end (save-excursion
  11358. (outline-next-heading)
  11359. (if (org-at-heading-p) (setq l2 (org-outline-level)))
  11360. (point)))
  11361. (if (and (save-excursion
  11362. (re-search-forward
  11363. "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) \\[[- X]\\]" end t))
  11364. (not (save-excursion (re-search-forward
  11365. ":COOKIE_DATA:.*\\<todo\\>" end t))))
  11366. (org-update-checkbox-count)
  11367. (if (and l2 (> l2 l1))
  11368. (progn
  11369. (goto-char end)
  11370. (org-update-parent-todo-statistics))
  11371. (goto-char pos)
  11372. (beginning-of-line 1)
  11373. (while (re-search-forward
  11374. "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)"
  11375. (point-at-eol) t)
  11376. (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
  11377. (goto-char pos)
  11378. (move-marker pos nil)))))
  11379. (defvar org-entry-property-inherited-from) ;; defined below
  11380. (defun org-update-parent-todo-statistics ()
  11381. "Update any statistics cookie in the parent of the current headline.
  11382. When `org-hierarchical-todo-statistics' is nil, statistics will cover
  11383. the entire subtree and this will travel up the hierarchy and update
  11384. statistics everywhere."
  11385. (let* ((prop (save-excursion (org-up-heading-safe)
  11386. (org-entry-get nil "COOKIE_DATA" 'inherit)))
  11387. (recursive (or (not org-hierarchical-todo-statistics)
  11388. (and prop (string-match "\\<recursive\\>" prop))))
  11389. (lim (or (and prop (marker-position org-entry-property-inherited-from))
  11390. 0))
  11391. (first t)
  11392. (box-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
  11393. level ltoggle l1 new ndel
  11394. (cnt-all 0) (cnt-done 0) is-percent kwd
  11395. checkbox-beg ov ovs ove cookie-present)
  11396. (catch 'exit
  11397. (save-excursion
  11398. (beginning-of-line 1)
  11399. (setq ltoggle (funcall outline-level))
  11400. ;; Three situations are to consider:
  11401. ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
  11402. ;; to the top-level ancestor on the headline;
  11403. ;; 2. If parent has "recursive" property, repeat up to the
  11404. ;; headline setting that property, taking inheritance into
  11405. ;; account;
  11406. ;; 3. Else, move up to direct parent and proceed only once.
  11407. (while (and (setq level (org-up-heading-safe))
  11408. (or recursive first)
  11409. (>= (point) lim))
  11410. (setq first nil cookie-present nil)
  11411. (unless (and level
  11412. (not (string-match
  11413. "\\<checkbox\\>"
  11414. (downcase (or (org-entry-get nil "COOKIE_DATA")
  11415. "")))))
  11416. (throw 'exit nil))
  11417. (while (re-search-forward box-re (point-at-eol) t)
  11418. (setq cnt-all 0 cnt-done 0 cookie-present t)
  11419. (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
  11420. (save-match-data
  11421. (unless (outline-next-heading) (throw 'exit nil))
  11422. (while (and (looking-at org-complex-heading-regexp)
  11423. (> (setq l1 (length (match-string 1))) level))
  11424. (setq kwd (and (or recursive (= l1 ltoggle))
  11425. (match-string 2)))
  11426. (if (or (eq org-provide-todo-statistics 'all-headlines)
  11427. (and (listp org-provide-todo-statistics)
  11428. (or (member kwd org-provide-todo-statistics)
  11429. (member kwd org-done-keywords))))
  11430. (setq cnt-all (1+ cnt-all))
  11431. (if (eq org-provide-todo-statistics t)
  11432. (and kwd (setq cnt-all (1+ cnt-all)))))
  11433. (and (member kwd org-done-keywords)
  11434. (setq cnt-done (1+ cnt-done)))
  11435. (outline-next-heading)))
  11436. (setq new
  11437. (if is-percent
  11438. (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
  11439. (format "[%d/%d]" cnt-done cnt-all))
  11440. ndel (- (match-end 0) checkbox-beg))
  11441. ;; handle overlays when updating cookie from column view
  11442. (when (setq ov (car (overlays-at checkbox-beg)))
  11443. (setq ovs (overlay-start ov) ove (overlay-end ov))
  11444. (delete-overlay ov))
  11445. (goto-char checkbox-beg)
  11446. (insert new)
  11447. (delete-region (point) (+ (point) ndel))
  11448. (when org-auto-align-tags (org-fix-tags-on-the-fly))
  11449. (when ov (move-overlay ov ovs ove)))
  11450. (when cookie-present
  11451. (run-hook-with-args 'org-after-todo-statistics-hook
  11452. cnt-done (- cnt-all cnt-done))))))
  11453. (run-hooks 'org-todo-statistics-hook)))
  11454. (defvar org-after-todo-statistics-hook nil
  11455. "Hook that is called after a TODO statistics cookie has been updated.
  11456. Each function is called with two arguments: the number of not-done entries
  11457. and the number of done entries.
  11458. For example, the following function, when added to this hook, will switch
  11459. an entry to DONE when all children are done, and back to TODO when new
  11460. entries are set to a TODO status. Note that this hook is only called
  11461. when there is a statistics cookie in the headline!
  11462. (defun org-summary-todo (n-done n-not-done)
  11463. \"Switch entry to DONE when all subentries are done, to TODO otherwise.\"
  11464. (let (org-log-done org-log-states) ; turn off logging
  11465. (org-todo (if (= n-not-done 0) \"DONE\" \"TODO\"))))
  11466. ")
  11467. (defvar org-todo-statistics-hook nil
  11468. "Hook that is run whenever Org thinks TODO statistics should be updated.
  11469. This hook runs even if there is no statistics cookie present, in which case
  11470. `org-after-todo-statistics-hook' would not run.")
  11471. (defun org-todo-trigger-tag-changes (state)
  11472. "Apply the changes defined in `org-todo-state-tags-triggers'."
  11473. (let ((l org-todo-state-tags-triggers)
  11474. changes)
  11475. (when (or (not state) (equal state ""))
  11476. (setq changes (append changes (cdr (assoc "" l)))))
  11477. (when (and (stringp state) (> (length state) 0))
  11478. (setq changes (append changes (cdr (assoc state l)))))
  11479. (when (member state org-not-done-keywords)
  11480. (setq changes (append changes (cdr (assoc 'todo l)))))
  11481. (when (member state org-done-keywords)
  11482. (setq changes (append changes (cdr (assoc 'done l)))))
  11483. (dolist (c changes)
  11484. (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
  11485. (defun org-local-logging (value)
  11486. "Get logging settings from a property VALUE."
  11487. (let* (words w a)
  11488. ;; directly set the variables, they are already local.
  11489. (setq org-log-done nil
  11490. org-log-repeat nil
  11491. org-todo-log-states nil)
  11492. (setq words (org-split-string value))
  11493. (while (setq w (pop words))
  11494. (cond
  11495. ((setq a (assoc w org-startup-options))
  11496. (and (member (nth 1 a) '(org-log-done org-log-repeat))
  11497. (set (nth 1 a) (nth 2 a))))
  11498. ((setq a (org-extract-log-state-settings w))
  11499. (and (member (car a) org-todo-keywords-1)
  11500. (push a org-todo-log-states)))))))
  11501. (defun org-get-todo-sequence-head (kwd)
  11502. "Return the head of the TODO sequence to which KWD belongs.
  11503. If KWD is not set, check if there is a text property remembering the
  11504. right sequence."
  11505. (let (p)
  11506. (cond
  11507. ((not kwd)
  11508. (or (get-text-property (point-at-bol) 'org-todo-head)
  11509. (progn
  11510. (setq p (next-single-property-change (point-at-bol) 'org-todo-head
  11511. nil (point-at-eol)))
  11512. (get-text-property p 'org-todo-head))))
  11513. ((not (member kwd org-todo-keywords-1))
  11514. (car org-todo-keywords-1))
  11515. (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
  11516. (defun org-fast-todo-selection ()
  11517. "Fast TODO keyword selection with single keys.
  11518. Returns the new TODO keyword, or nil if no state change should occur."
  11519. (let* ((fulltable org-todo-key-alist)
  11520. (done-keywords org-done-keywords) ;; needed for the faces.
  11521. (maxlen (apply 'max (mapcar
  11522. (lambda (x)
  11523. (if (stringp (car x)) (string-width (car x)) 0))
  11524. fulltable)))
  11525. (expert nil)
  11526. (fwidth (+ maxlen 3 1 3))
  11527. (ncol (/ (- (window-width) 4) fwidth))
  11528. tg cnt e c tbl
  11529. groups ingroup)
  11530. (save-excursion
  11531. (save-window-excursion
  11532. (if expert
  11533. (set-buffer (get-buffer-create " *Org todo*"))
  11534. (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
  11535. (erase-buffer)
  11536. (org-set-local 'org-done-keywords done-keywords)
  11537. (setq tbl fulltable cnt 0)
  11538. (while (setq e (pop tbl))
  11539. (cond
  11540. ((equal e '(:startgroup))
  11541. (push '() groups) (setq ingroup t)
  11542. (when (not (= cnt 0))
  11543. (setq cnt 0)
  11544. (insert "\n"))
  11545. (insert "{ "))
  11546. ((equal e '(:endgroup))
  11547. (setq ingroup nil cnt 0)
  11548. (insert "}\n"))
  11549. ((equal e '(:newline))
  11550. (when (not (= cnt 0))
  11551. (setq cnt 0)
  11552. (insert "\n")
  11553. (setq e (car tbl))
  11554. (while (equal (car tbl) '(:newline))
  11555. (insert "\n")
  11556. (setq tbl (cdr tbl)))))
  11557. (t
  11558. (setq tg (car e) c (cdr e))
  11559. (if ingroup (push tg (car groups)))
  11560. (setq tg (org-add-props tg nil 'face
  11561. (org-get-todo-face tg)))
  11562. (if (and (= cnt 0) (not ingroup)) (insert " "))
  11563. (insert "[" c "] " tg (make-string
  11564. (- fwidth 4 (length tg)) ?\ ))
  11565. (when (= (setq cnt (1+ cnt)) ncol)
  11566. (insert "\n")
  11567. (if ingroup (insert " "))
  11568. (setq cnt 0)))))
  11569. (insert "\n")
  11570. (goto-char (point-min))
  11571. (if (not expert) (org-fit-window-to-buffer))
  11572. (message "[a-z..]:Set [SPC]:clear")
  11573. (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
  11574. (cond
  11575. ((or (= c ?\C-g)
  11576. (and (= c ?q) (not (rassoc c fulltable))))
  11577. (setq quit-flag t))
  11578. ((= c ?\ ) nil)
  11579. ((setq e (rassoc c fulltable) tg (car e))
  11580. tg)
  11581. (t (setq quit-flag t)))))))
  11582. (defun org-entry-is-todo-p ()
  11583. (member (org-get-todo-state) org-not-done-keywords))
  11584. (defun org-entry-is-done-p ()
  11585. (member (org-get-todo-state) org-done-keywords))
  11586. (defun org-get-todo-state ()
  11587. "Return the TODO keyword of the current subtree."
  11588. (save-excursion
  11589. (org-back-to-heading t)
  11590. (and (looking-at org-todo-line-regexp)
  11591. (match-end 2)
  11592. (match-string 2))))
  11593. (defun org-at-date-range-p (&optional inactive-ok)
  11594. "Is the cursor inside a date range?"
  11595. (interactive)
  11596. (save-excursion
  11597. (catch 'exit
  11598. (let ((pos (point)))
  11599. (skip-chars-backward "^[<\r\n")
  11600. (skip-chars-backward "<[")
  11601. (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
  11602. (>= (match-end 0) pos)
  11603. (throw 'exit t))
  11604. (skip-chars-backward "^<[\r\n")
  11605. (skip-chars-backward "<[")
  11606. (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
  11607. (>= (match-end 0) pos)
  11608. (throw 'exit t)))
  11609. nil)))
  11610. (defun org-get-repeat (&optional tagline)
  11611. "Check if there is a deadline/schedule with repeater in this entry."
  11612. (save-match-data
  11613. (save-excursion
  11614. (org-back-to-heading t)
  11615. (and (re-search-forward (if tagline
  11616. (concat tagline "\\s-*" org-repeat-re)
  11617. org-repeat-re)
  11618. (org-entry-end-position) t)
  11619. (match-string-no-properties 1)))))
  11620. (defvar org-last-changed-timestamp)
  11621. (defvar org-last-inserted-timestamp)
  11622. (defvar org-log-post-message)
  11623. (defvar org-log-note-purpose)
  11624. (defvar org-log-note-how)
  11625. (defvar org-log-note-extra)
  11626. (defun org-auto-repeat-maybe (done-word)
  11627. "Check if the current headline contains a repeated deadline/schedule.
  11628. If yes, set TODO state back to what it was and change the base date
  11629. of repeating deadline/scheduled time stamps to new date.
  11630. This function is run automatically after each state change to a DONE state."
  11631. ;; last-state is dynamically scoped into this function
  11632. (let* ((repeat (org-get-repeat))
  11633. (aa (assoc org-last-state org-todo-kwd-alist))
  11634. (interpret (nth 1 aa))
  11635. (head (nth 2 aa))
  11636. (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
  11637. (msg "Entry repeats: ")
  11638. (org-log-done nil)
  11639. (org-todo-log-states nil)
  11640. re type n what ts time to-state)
  11641. (when repeat
  11642. (if (eq org-log-repeat t) (setq org-log-repeat 'state))
  11643. (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
  11644. org-todo-repeat-to-state))
  11645. (unless (and to-state (member to-state org-todo-keywords-1))
  11646. (setq to-state (if (eq interpret 'type) org-last-state head)))
  11647. (org-todo to-state)
  11648. (when (or org-log-repeat (org-entry-get nil "CLOCK"))
  11649. (org-entry-put nil "LAST_REPEAT" (format-time-string
  11650. (org-time-stamp-format t t))))
  11651. (when org-log-repeat
  11652. (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
  11653. (memq 'org-add-log-note post-command-hook))
  11654. ;; OK, we are already setup for some record
  11655. (if (eq org-log-repeat 'note)
  11656. ;; make sure we take a note, not only a time stamp
  11657. (setq org-log-note-how 'note))
  11658. ;; Set up for taking a record
  11659. (org-add-log-setup 'state (or done-word (car org-done-keywords))
  11660. org-last-state
  11661. 'findpos org-log-repeat)))
  11662. (org-back-to-heading t)
  11663. (org-add-planning-info nil nil 'closed)
  11664. (setq re (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
  11665. org-deadline-time-regexp "\\)\\|\\("
  11666. org-ts-regexp "\\)"))
  11667. (while (re-search-forward
  11668. re (save-excursion (outline-next-heading) (point)) t)
  11669. (setq type (if (match-end 1) org-scheduled-string
  11670. (if (match-end 3) org-deadline-string "Plain:"))
  11671. ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
  11672. (when (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts)
  11673. (setq n (string-to-number (match-string 2 ts))
  11674. what (match-string 3 ts))
  11675. (if (equal what "w") (setq n (* n 7) what "d"))
  11676. (if (and (equal what "h") (not (string-match "[0-9]\\{1,2\\}:[0-9]\\{2\\}" ts)))
  11677. (user-error "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
  11678. ;; Preparation, see if we need to modify the start date for the change
  11679. (when (match-end 1)
  11680. (setq time (save-match-data (org-time-string-to-time ts)))
  11681. (cond
  11682. ((equal (match-string 1 ts) ".")
  11683. ;; Shift starting date to today
  11684. (org-timestamp-change
  11685. (- (org-today) (time-to-days time))
  11686. 'day))
  11687. ((equal (match-string 1 ts) "+")
  11688. (let ((nshiftmax 10) (nshift 0))
  11689. (while (or (= nshift 0)
  11690. (<= (time-to-days time)
  11691. (time-to-days (current-time))))
  11692. (when (= (incf nshift) nshiftmax)
  11693. (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
  11694. (error "Abort")))
  11695. (org-timestamp-change n (cdr (assoc what whata)))
  11696. (org-at-timestamp-p t)
  11697. (setq ts (match-string 1))
  11698. (setq time (save-match-data (org-time-string-to-time ts)))))
  11699. (org-timestamp-change (- n) (cdr (assoc what whata)))
  11700. ;; rematch, so that we have everything in place for the real shift
  11701. (org-at-timestamp-p t)
  11702. (setq ts (match-string 1))
  11703. (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts))))
  11704. (save-excursion (org-timestamp-change n (cdr (assoc what whata)) nil t))
  11705. (setq msg (concat msg type " " org-last-changed-timestamp " "))))
  11706. (setq org-log-post-message msg)
  11707. (message "%s" msg))))
  11708. (defun org-show-todo-tree (arg)
  11709. "Make a compact tree which shows all headlines marked with TODO.
  11710. The tree will show the lines where the regexp matches, and all higher
  11711. headlines above the match.
  11712. With a \\[universal-argument] prefix, prompt for a regexp to match.
  11713. With a numeric prefix N, construct a sparse tree for the Nth element
  11714. of `org-todo-keywords-1'."
  11715. (interactive "P")
  11716. (let ((case-fold-search nil)
  11717. (kwd-re
  11718. (cond ((null arg) org-not-done-regexp)
  11719. ((equal arg '(4))
  11720. (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
  11721. (mapcar 'list org-todo-keywords-1))))
  11722. (concat "\\("
  11723. (mapconcat 'identity (org-split-string kwd "|") "\\|")
  11724. "\\)\\>")))
  11725. ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
  11726. (regexp-quote (nth (1- (prefix-numeric-value arg))
  11727. org-todo-keywords-1)))
  11728. (t (user-error "Invalid prefix argument: %s" arg)))))
  11729. (message "%d TODO entries found"
  11730. (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
  11731. (defun org-deadline (arg &optional time)
  11732. "Insert the \"DEADLINE:\" string with a timestamp to make a deadline.
  11733. With one universal prefix argument, remove any deadline from the item.
  11734. With two universal prefix arguments, prompt for a warning delay.
  11735. With argument TIME, set the deadline at the corresponding date. TIME
  11736. can either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
  11737. (interactive "P")
  11738. (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
  11739. (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
  11740. 'region-start-level 'region))
  11741. org-loop-over-headlines-in-active-region)
  11742. (org-map-entries
  11743. `(org-deadline ',arg ,time)
  11744. org-loop-over-headlines-in-active-region
  11745. cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
  11746. (let* ((old-date (org-entry-get nil "DEADLINE"))
  11747. (old-date-time (if old-date (org-time-string-to-time old-date)))
  11748. (repeater (and old-date
  11749. (string-match
  11750. "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
  11751. old-date)
  11752. (match-string 1 old-date))))
  11753. (cond
  11754. ((equal arg '(4))
  11755. (when (and old-date org-log-redeadline)
  11756. (org-add-log-setup 'deldeadline nil old-date 'findpos
  11757. org-log-redeadline))
  11758. (org-remove-timestamp-with-keyword org-deadline-string)
  11759. (message "Item no longer has a deadline."))
  11760. ((equal arg '(16))
  11761. (save-excursion
  11762. (if (re-search-forward
  11763. org-deadline-time-regexp
  11764. (save-excursion (outline-next-heading) (point)) t)
  11765. (let* ((rpl0 (match-string 1))
  11766. (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
  11767. (replace-match
  11768. (concat org-deadline-string
  11769. " <" rpl
  11770. (format " -%dd"
  11771. (abs
  11772. (- (time-to-days
  11773. (save-match-data
  11774. (org-read-date nil t nil "Warn starting from" old-date-time)))
  11775. (time-to-days old-date-time))))
  11776. ">") t t))
  11777. (user-error "No deadline information to update"))))
  11778. (t
  11779. (org-add-planning-info 'deadline time 'closed)
  11780. (when (and old-date org-log-redeadline
  11781. (not (equal old-date
  11782. (substring org-last-inserted-timestamp 1 -1))))
  11783. (org-add-log-setup 'redeadline nil old-date 'findpos
  11784. org-log-redeadline))
  11785. (when repeater
  11786. (save-excursion
  11787. (org-back-to-heading t)
  11788. (when (re-search-forward (concat org-deadline-string " "
  11789. org-last-inserted-timestamp)
  11790. (save-excursion
  11791. (outline-next-heading) (point)) t)
  11792. (goto-char (1- (match-end 0)))
  11793. (insert " " repeater)
  11794. (setq org-last-inserted-timestamp
  11795. (concat (substring org-last-inserted-timestamp 0 -1)
  11796. " " repeater
  11797. (substring org-last-inserted-timestamp -1))))))
  11798. (message "Deadline on %s" org-last-inserted-timestamp))))))
  11799. (defun org-schedule (arg &optional time)
  11800. "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
  11801. With one universal prefix argument, remove any scheduling date from the item.
  11802. With two universal prefix arguments, prompt for a delay cookie.
  11803. With argument TIME, scheduled at the corresponding date. TIME can
  11804. either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
  11805. (interactive "P")
  11806. (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
  11807. (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
  11808. 'region-start-level 'region))
  11809. org-loop-over-headlines-in-active-region)
  11810. (org-map-entries
  11811. `(org-schedule ',arg ,time)
  11812. org-loop-over-headlines-in-active-region
  11813. cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
  11814. (let* ((old-date (org-entry-get nil "SCHEDULED"))
  11815. (old-date-time (if old-date (org-time-string-to-time old-date)))
  11816. (repeater (and old-date
  11817. (string-match
  11818. "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
  11819. old-date)
  11820. (match-string 1 old-date))))
  11821. (cond
  11822. ((equal arg '(4))
  11823. (progn
  11824. (when (and old-date org-log-reschedule)
  11825. (org-add-log-setup 'delschedule nil old-date 'findpos
  11826. org-log-reschedule))
  11827. (org-remove-timestamp-with-keyword org-scheduled-string)
  11828. (message "Item is no longer scheduled.")))
  11829. ((equal arg '(16))
  11830. (save-excursion
  11831. (if (re-search-forward
  11832. org-scheduled-time-regexp
  11833. (save-excursion (outline-next-heading) (point)) t)
  11834. (let* ((rpl0 (match-string 1))
  11835. (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
  11836. (replace-match
  11837. (concat org-scheduled-string
  11838. " <" rpl
  11839. (format " -%dd"
  11840. (abs
  11841. (- (time-to-days
  11842. (save-match-data
  11843. (org-read-date nil t nil "Delay until" old-date-time)))
  11844. (time-to-days old-date-time))))
  11845. ">") t t))
  11846. (user-error "No scheduled information to update"))))
  11847. (t
  11848. (org-add-planning-info 'scheduled time 'closed)
  11849. (when (and old-date org-log-reschedule
  11850. (not (equal old-date
  11851. (substring org-last-inserted-timestamp 1 -1))))
  11852. (org-add-log-setup 'reschedule nil old-date 'findpos
  11853. org-log-reschedule))
  11854. (when repeater
  11855. (save-excursion
  11856. (org-back-to-heading t)
  11857. (when (re-search-forward (concat org-scheduled-string " "
  11858. org-last-inserted-timestamp)
  11859. (save-excursion
  11860. (outline-next-heading) (point)) t)
  11861. (goto-char (1- (match-end 0)))
  11862. (insert " " repeater)
  11863. (setq org-last-inserted-timestamp
  11864. (concat (substring org-last-inserted-timestamp 0 -1)
  11865. " " repeater
  11866. (substring org-last-inserted-timestamp -1))))))
  11867. (message "Scheduled to %s" org-last-inserted-timestamp))))))
  11868. (defun org-get-scheduled-time (pom &optional inherit)
  11869. "Get the scheduled time as a time tuple, of a format suitable
  11870. for calling org-schedule with, or if there is no scheduling,
  11871. returns nil."
  11872. (let ((time (org-entry-get pom "SCHEDULED" inherit)))
  11873. (when time
  11874. (apply 'encode-time (org-parse-time-string time)))))
  11875. (defun org-get-deadline-time (pom &optional inherit)
  11876. "Get the deadline as a time tuple, of a format suitable for
  11877. calling org-deadline with, or if there is no scheduling, returns
  11878. nil."
  11879. (let ((time (org-entry-get pom "DEADLINE" inherit)))
  11880. (when time
  11881. (apply 'encode-time (org-parse-time-string time)))))
  11882. (defun org-remove-timestamp-with-keyword (keyword)
  11883. "Remove all time stamps with KEYWORD in the current entry."
  11884. (let ((re (concat "\\<" (regexp-quote keyword) " +<[^>\n]+>[ \t]*"))
  11885. beg)
  11886. (save-excursion
  11887. (org-back-to-heading t)
  11888. (setq beg (point))
  11889. (outline-next-heading)
  11890. (while (re-search-backward re beg t)
  11891. (replace-match "")
  11892. (if (and (string-match "\\S-" (buffer-substring (point-at-bol) (point)))
  11893. (equal (char-before) ?\ ))
  11894. (backward-delete-char 1)
  11895. (if (string-match "^[ \t]*$" (buffer-substring
  11896. (point-at-bol) (point-at-eol)))
  11897. (delete-region (point-at-bol)
  11898. (min (point-max) (1+ (point-at-eol))))))))))
  11899. (defun org-add-planning-info (what &optional time &rest remove)
  11900. "Insert new timestamp with keyword in the line directly after the headline.
  11901. WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
  11902. If non is given, the user is prompted for a date.
  11903. REMOVE indicates what kind of entries to remove. An old WHAT entry will also
  11904. be removed."
  11905. (interactive)
  11906. (let (org-time-was-given org-end-time-was-given ts
  11907. end default-time default-input)
  11908. (catch 'exit
  11909. (when (and (memq what '(scheduled deadline))
  11910. (or (not time)
  11911. (and (stringp time)
  11912. (string-match "^[-+]+[0-9]" time))))
  11913. ;; Try to get a default date/time from existing timestamp
  11914. (save-excursion
  11915. (org-back-to-heading t)
  11916. (setq end (save-excursion (outline-next-heading) (point)))
  11917. (when (re-search-forward (if (eq what 'scheduled)
  11918. org-scheduled-time-regexp
  11919. org-deadline-time-regexp)
  11920. end t)
  11921. (setq ts (match-string 1)
  11922. default-time
  11923. (apply 'encode-time (org-parse-time-string ts))
  11924. default-input (and ts (org-get-compact-tod ts))))))
  11925. (when what
  11926. (setq time
  11927. (if (stringp time)
  11928. ;; This is a string (relative or absolute), set proper date
  11929. (apply 'encode-time
  11930. (org-read-date-analyze
  11931. time default-time (decode-time default-time)))
  11932. ;; If necessary, get the time from the user
  11933. (or time (org-read-date nil 'to-time nil nil
  11934. default-time default-input)))))
  11935. (when (and org-insert-labeled-timestamps-at-point
  11936. (member what '(scheduled deadline)))
  11937. (insert
  11938. (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
  11939. (org-insert-time-stamp time org-time-was-given
  11940. nil nil nil (list org-end-time-was-given))
  11941. (setq what nil))
  11942. (save-excursion
  11943. (save-restriction
  11944. (let (col list elt ts buffer-invisibility-spec)
  11945. (org-back-to-heading t)
  11946. (looking-at (concat org-outline-regexp "\\( *\\)[^\r\n]*"))
  11947. (goto-char (match-end 1))
  11948. (setq col (current-column))
  11949. (goto-char (match-end 0))
  11950. (if (eobp) (insert "\n") (forward-char 1))
  11951. (when (and (not what)
  11952. (not (looking-at
  11953. (concat "[ \t]*"
  11954. org-keyword-time-not-clock-regexp))))
  11955. ;; Nothing to add, nothing to remove...... :-)
  11956. (throw 'exit nil))
  11957. (if (and (not (looking-at org-outline-regexp))
  11958. (looking-at (concat "[^\r\n]*?" org-keyword-time-regexp
  11959. "[^\r\n]*"))
  11960. (not (equal (match-string 1) org-clock-string)))
  11961. (narrow-to-region (match-beginning 0) (match-end 0))
  11962. (insert-before-markers "\n")
  11963. (backward-char 1)
  11964. (narrow-to-region (point) (point))
  11965. (and org-adapt-indentation (org-indent-to-column col)))
  11966. ;; Check if we have to remove something.
  11967. (setq list (cons what remove))
  11968. (while list
  11969. (setq elt (pop list))
  11970. (when (or (and (eq elt 'scheduled)
  11971. (re-search-forward org-scheduled-time-regexp nil t))
  11972. (and (eq elt 'deadline)
  11973. (re-search-forward org-deadline-time-regexp nil t))
  11974. (and (eq elt 'closed)
  11975. (re-search-forward org-closed-time-regexp nil t)))
  11976. (replace-match "")
  11977. (if (looking-at "--+<[^>]+>") (replace-match ""))))
  11978. (and (looking-at "[ \t]+") (replace-match ""))
  11979. (and org-adapt-indentation (bolp) (org-indent-to-column col))
  11980. (when what
  11981. (insert
  11982. (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
  11983. (cond ((eq what 'scheduled) org-scheduled-string)
  11984. ((eq what 'deadline) org-deadline-string)
  11985. ((eq what 'closed) org-closed-string))
  11986. " ")
  11987. (setq ts (org-insert-time-stamp
  11988. time
  11989. (or org-time-was-given
  11990. (and (eq what 'closed) org-log-done-with-time))
  11991. (eq what 'closed)
  11992. nil nil (list org-end-time-was-given)))
  11993. (insert
  11994. (if (not (or (bolp) (eq (char-before) ?\ )
  11995. (memq (char-after) '(32 10))
  11996. (eobp))) " " ""))
  11997. (end-of-line 1))
  11998. (goto-char (point-min))
  11999. (widen)
  12000. (if (and (looking-at "[ \t]*\n")
  12001. (equal (char-before) ?\n))
  12002. (delete-region (1- (point)) (point-at-eol)))
  12003. ts))))))
  12004. (defvar org-log-note-marker (make-marker))
  12005. (defvar org-log-note-purpose nil)
  12006. (defvar org-log-note-state nil)
  12007. (defvar org-log-note-previous-state nil)
  12008. (defvar org-log-note-how nil)
  12009. (defvar org-log-note-extra nil)
  12010. (defvar org-log-note-window-configuration nil)
  12011. (defvar org-log-note-return-to (make-marker))
  12012. (defvar org-log-note-effective-time nil
  12013. "Remembered current time so that dynamically scoped
  12014. `org-extend-today-until' affects tha timestamps in state change
  12015. log")
  12016. (defvar org-log-post-message nil
  12017. "Message to be displayed after a log note has been stored.
  12018. The auto-repeater uses this.")
  12019. (defun org-add-note ()
  12020. "Add a note to the current entry.
  12021. This is done in the same way as adding a state change note."
  12022. (interactive)
  12023. (org-add-log-setup 'note nil nil 'findpos nil))
  12024. (defvar org-property-end-re)
  12025. (defun org-add-log-setup (&optional purpose state prev-state
  12026. findpos how extra)
  12027. "Set up the post command hook to take a note.
  12028. If this is about to TODO state change, the new state is expected in STATE.
  12029. When FINDPOS is non-nil, find the correct position for the note in
  12030. the current entry. If not, assume that it can be inserted at point.
  12031. HOW is an indicator what kind of note should be created.
  12032. EXTRA is additional text that will be inserted into the notes buffer."
  12033. (let* ((org-log-into-drawer (org-log-into-drawer))
  12034. (drawer (cond ((stringp org-log-into-drawer)
  12035. org-log-into-drawer)
  12036. (org-log-into-drawer "LOGBOOK"))))
  12037. (save-restriction
  12038. (save-excursion
  12039. (when findpos
  12040. (org-back-to-heading t)
  12041. (narrow-to-region (point) (save-excursion
  12042. (outline-next-heading) (point)))
  12043. (looking-at (concat org-outline-regexp "\\( *\\)[^\r\n]*"
  12044. "\\(\n[^\r\n]*?" org-keyword-time-not-clock-regexp
  12045. "[^\r\n]*\\)?"))
  12046. (goto-char (match-end 0))
  12047. (cond
  12048. (drawer
  12049. (if (re-search-forward (concat "^[ \t]*:" drawer ":[ \t]*$")
  12050. nil t)
  12051. (progn
  12052. (goto-char (match-end 0))
  12053. (or org-log-states-order-reversed
  12054. (and (re-search-forward org-property-end-re nil t)
  12055. (goto-char (1- (match-beginning 0))))))
  12056. (insert "\n:" drawer ":\n:END:")
  12057. (beginning-of-line 0)
  12058. (org-indent-line)
  12059. (beginning-of-line 2)
  12060. (org-indent-line)
  12061. (end-of-line 0)))
  12062. ((and org-log-state-notes-insert-after-drawers
  12063. (save-excursion
  12064. (forward-line) (looking-at org-drawer-regexp)))
  12065. (forward-line)
  12066. (while (looking-at org-drawer-regexp)
  12067. (goto-char (match-end 0))
  12068. (re-search-forward org-property-end-re (point-max) t)
  12069. (forward-line))
  12070. (forward-line -1)))
  12071. (unless org-log-states-order-reversed
  12072. (and (= (char-after) ?\n) (forward-char 1))
  12073. (org-skip-over-state-notes)
  12074. (skip-chars-backward " \t\n\r")))
  12075. (move-marker org-log-note-marker (point))
  12076. (setq org-log-note-purpose purpose
  12077. org-log-note-state state
  12078. org-log-note-previous-state prev-state
  12079. org-log-note-how how
  12080. org-log-note-extra extra
  12081. org-log-note-effective-time (org-current-effective-time))
  12082. (add-hook 'post-command-hook 'org-add-log-note 'append)))))
  12083. (defun org-skip-over-state-notes ()
  12084. "Skip past the list of State notes in an entry."
  12085. (if (looking-at "\n[ \t]*- State") (forward-char 1))
  12086. (when (ignore-errors (goto-char (org-in-item-p)))
  12087. (let* ((struct (org-list-struct))
  12088. (prevs (org-list-prevs-alist struct)))
  12089. (while (looking-at "[ \t]*- State")
  12090. (goto-char (or (org-list-get-next-item (point) struct prevs)
  12091. (org-list-get-item-end (point) struct)))))))
  12092. (defun org-add-log-note (&optional purpose)
  12093. "Pop up a window for taking a note, and add this note later at point."
  12094. (remove-hook 'post-command-hook 'org-add-log-note)
  12095. (setq org-log-note-window-configuration (current-window-configuration))
  12096. (delete-other-windows)
  12097. (move-marker org-log-note-return-to (point))
  12098. (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
  12099. (goto-char org-log-note-marker)
  12100. (org-switch-to-buffer-other-window "*Org Note*")
  12101. (erase-buffer)
  12102. (if (memq org-log-note-how '(time state))
  12103. (let (current-prefix-arg) (org-store-log-note))
  12104. (let ((org-inhibit-startup t)) (org-mode))
  12105. (insert (format "# Insert note for %s.
  12106. # Finish with C-c C-c, or cancel with C-c C-k.\n\n"
  12107. (cond
  12108. ((eq org-log-note-purpose 'clock-out) "stopped clock")
  12109. ((eq org-log-note-purpose 'done) "closed todo item")
  12110. ((eq org-log-note-purpose 'state)
  12111. (format "state change from \"%s\" to \"%s\""
  12112. (or org-log-note-previous-state "")
  12113. (or org-log-note-state "")))
  12114. ((eq org-log-note-purpose 'reschedule)
  12115. "rescheduling")
  12116. ((eq org-log-note-purpose 'delschedule)
  12117. "no longer scheduled")
  12118. ((eq org-log-note-purpose 'redeadline)
  12119. "changing deadline")
  12120. ((eq org-log-note-purpose 'deldeadline)
  12121. "removing deadline")
  12122. ((eq org-log-note-purpose 'refile)
  12123. "refiling")
  12124. ((eq org-log-note-purpose 'note)
  12125. "this entry")
  12126. (t (error "This should not happen")))))
  12127. (if org-log-note-extra (insert org-log-note-extra))
  12128. (org-set-local 'org-finish-function 'org-store-log-note)
  12129. (run-hooks 'org-log-buffer-setup-hook)))
  12130. (defvar org-note-abort nil) ; dynamically scoped
  12131. (defun org-store-log-note ()
  12132. "Finish taking a log note, and insert it to where it belongs."
  12133. (let ((txt (buffer-string)))
  12134. (kill-buffer (current-buffer))
  12135. (let ((note (cdr (assq org-log-note-purpose org-log-note-headings)))
  12136. lines ind bul)
  12137. (while (string-match "\\`# .*\n[ \t\n]*" txt)
  12138. (setq txt (replace-match "" t t txt)))
  12139. (if (string-match "\\s-+\\'" txt)
  12140. (setq txt (replace-match "" t t txt)))
  12141. (setq lines (org-split-string txt "\n"))
  12142. (when (and note (string-match "\\S-" note))
  12143. (setq note
  12144. (org-replace-escapes
  12145. note
  12146. (list (cons "%u" (user-login-name))
  12147. (cons "%U" user-full-name)
  12148. (cons "%t" (format-time-string
  12149. (org-time-stamp-format 'long 'inactive)
  12150. org-log-note-effective-time))
  12151. (cons "%T" (format-time-string
  12152. (org-time-stamp-format 'long nil)
  12153. org-log-note-effective-time))
  12154. (cons "%d" (format-time-string
  12155. (org-time-stamp-format nil 'inactive)
  12156. org-log-note-effective-time))
  12157. (cons "%D" (format-time-string
  12158. (org-time-stamp-format nil nil)
  12159. org-log-note-effective-time))
  12160. (cons "%s" (if org-log-note-state
  12161. (concat "\"" org-log-note-state "\"")
  12162. ""))
  12163. (cons "%S" (if org-log-note-previous-state
  12164. (concat "\"" org-log-note-previous-state "\"")
  12165. "\"\"")))))
  12166. (if lines (setq note (concat note " \\\\")))
  12167. (push note lines))
  12168. (when (or current-prefix-arg org-note-abort)
  12169. (when org-log-into-drawer
  12170. (org-remove-empty-drawer-at
  12171. (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
  12172. org-log-note-marker))
  12173. (setq lines nil))
  12174. (when lines
  12175. (with-current-buffer (marker-buffer org-log-note-marker)
  12176. (save-excursion
  12177. (goto-char org-log-note-marker)
  12178. (move-marker org-log-note-marker nil)
  12179. (end-of-line 1)
  12180. (if (not (bolp)) (let ((inhibit-read-only t)) (insert "\n")))
  12181. (setq ind (save-excursion
  12182. (if (ignore-errors (goto-char (org-in-item-p)))
  12183. (let ((struct (org-list-struct)))
  12184. (org-list-get-ind
  12185. (org-list-get-top-point struct) struct))
  12186. (skip-chars-backward " \r\t\n")
  12187. (cond
  12188. ((and (org-at-heading-p)
  12189. org-adapt-indentation)
  12190. (1+ (org-current-level)))
  12191. ((org-at-heading-p) 0)
  12192. (t (org-get-indentation))))))
  12193. (setq bul (org-list-bullet-string "-"))
  12194. (org-indent-line-to ind)
  12195. (insert bul (pop lines))
  12196. (let ((ind-body (+ (length bul) ind)))
  12197. (while lines
  12198. (insert "\n")
  12199. (org-indent-line-to ind-body)
  12200. (insert (pop lines))))
  12201. (message "Note stored")
  12202. (org-back-to-heading t)
  12203. (org-cycle-hide-drawers 'children))
  12204. ;; Fix `buffer-undo-list' when `org-store-log-note' is called
  12205. ;; from within `org-add-log-note' because `buffer-undo-list'
  12206. ;; is then modified outside of `org-with-remote-undo'.
  12207. (when (eq this-command 'org-agenda-todo)
  12208. (setcdr buffer-undo-list (cddr buffer-undo-list)))))))
  12209. ;; Don't add undo information when called from `org-agenda-todo'
  12210. (let ((buffer-undo-list (eq this-command 'org-agenda-todo)))
  12211. (set-window-configuration org-log-note-window-configuration)
  12212. (with-current-buffer (marker-buffer org-log-note-return-to)
  12213. (goto-char org-log-note-return-to))
  12214. (move-marker org-log-note-return-to nil)
  12215. (and org-log-post-message (message "%s" org-log-post-message))))
  12216. (defun org-remove-empty-drawer-at (drawer pos)
  12217. "Remove an empty drawer DRAWER at position POS.
  12218. POS may also be a marker."
  12219. (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
  12220. (save-excursion
  12221. (save-restriction
  12222. (widen)
  12223. (goto-char pos)
  12224. (if (org-in-regexp
  12225. (concat "^[ \t]*:" drawer ":[ \t]*\n[ \t]*:END:[ \t]*\n?") 2)
  12226. (replace-match ""))))))
  12227. (defvar org-ts-type nil)
  12228. (defun org-sparse-tree (&optional arg type)
  12229. "Create a sparse tree, prompt for the details.
  12230. This command can create sparse trees. You first need to select the type
  12231. of match used to create the tree:
  12232. t Show all TODO entries.
  12233. T Show entries with a specific TODO keyword.
  12234. m Show entries selected by a tags/property match.
  12235. p Enter a property name and its value (both with completion on existing
  12236. names/values) and show entries with that property.
  12237. r Show entries matching a regular expression (`/' can be used as well).
  12238. b Show deadlines and scheduled items before a date.
  12239. a Show deadlines and scheduled items after a date.
  12240. d Show deadlines due within `org-deadline-warning-days'.
  12241. D Show deadlines and scheduled items between a date range."
  12242. (interactive "P")
  12243. (let (ans kwd value ts-type)
  12244. (setq type (or type org-sparse-tree-default-date-type))
  12245. (setq org-ts-type type)
  12246. (message "Sparse tree: [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty\n [d]eadlines [b]efore-date [a]fter-date [D]ates range\n [c]ycle through date types: %s"
  12247. (cond ((eq type 'all) "all timestamps")
  12248. ((eq type 'scheduled) "only scheduled")
  12249. ((eq type 'deadline) "only deadline")
  12250. ((eq type 'active) "only active timestamps")
  12251. ((eq type 'inactive) "only inactive timestamps")
  12252. ((eq type 'scheduled-or-deadline) "scheduled/deadline")
  12253. ((eq type 'closed) "with a closed time-stamp")
  12254. (t "scheduled/deadline")))
  12255. (setq ans (read-char-exclusive))
  12256. (cond
  12257. ((equal ans ?c)
  12258. (org-sparse-tree
  12259. arg (cadr (member type '(scheduled-or-deadline
  12260. all scheduled deadline active inactive closed)))))
  12261. ((equal ans ?d)
  12262. (call-interactively 'org-check-deadlines))
  12263. ((equal ans ?b)
  12264. (call-interactively 'org-check-before-date))
  12265. ((equal ans ?a)
  12266. (call-interactively 'org-check-after-date))
  12267. ((equal ans ?D)
  12268. (call-interactively 'org-check-dates-range))
  12269. ((equal ans ?t)
  12270. (call-interactively 'org-show-todo-tree))
  12271. ((equal ans ?T)
  12272. (org-show-todo-tree '(4)))
  12273. ((member ans '(?T ?m))
  12274. (call-interactively 'org-match-sparse-tree))
  12275. ((member ans '(?p ?P))
  12276. (setq kwd (org-icompleting-read "Property: "
  12277. (mapcar 'list (org-buffer-property-keys))))
  12278. (setq value (org-icompleting-read "Value: "
  12279. (mapcar 'list (org-property-values kwd))))
  12280. (unless (string-match "\\`{.*}\\'" value)
  12281. (setq value (concat "\"" value "\"")))
  12282. (org-match-sparse-tree arg (concat kwd "=" value)))
  12283. ((member ans '(?r ?R ?/))
  12284. (call-interactively 'org-occur))
  12285. (t (user-error "No such sparse tree command \"%c\"" ans)))))
  12286. (defvar org-occur-highlights nil
  12287. "List of overlays used for occur matches.")
  12288. (make-variable-buffer-local 'org-occur-highlights)
  12289. (defvar org-occur-parameters nil
  12290. "Parameters of the active org-occur calls.
  12291. This is a list, each call to org-occur pushes as cons cell,
  12292. containing the regular expression and the callback, onto the list.
  12293. The list can contain several entries if `org-occur' has been called
  12294. several time with the KEEP-PREVIOUS argument. Otherwise, this list
  12295. will only contain one set of parameters. When the highlights are
  12296. removed (for example with `C-c C-c', or with the next edit (depending
  12297. on `org-remove-highlights-with-change'), this variable is emptied
  12298. as well.")
  12299. (make-variable-buffer-local 'org-occur-parameters)
  12300. (defun org-occur (regexp &optional keep-previous callback)
  12301. "Make a compact tree which shows all matches of REGEXP.
  12302. The tree will show the lines where the regexp matches, and all higher
  12303. headlines above the match. It will also show the heading after the match,
  12304. to make sure editing the matching entry is easy.
  12305. If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
  12306. call to `org-occur' will be kept, to allow stacking of calls to this
  12307. command.
  12308. If CALLBACK is non-nil, it is a function which is called to confirm
  12309. that the match should indeed be shown."
  12310. (interactive "sRegexp: \nP")
  12311. (when (equal regexp "")
  12312. (user-error "Regexp cannot be empty"))
  12313. (unless keep-previous
  12314. (org-remove-occur-highlights nil nil t))
  12315. (push (cons regexp callback) org-occur-parameters)
  12316. (let ((cnt 0))
  12317. (save-excursion
  12318. (goto-char (point-min))
  12319. (if (or (not keep-previous) ; do not want to keep
  12320. (not org-occur-highlights)) ; no previous matches
  12321. ;; hide everything
  12322. (org-overview))
  12323. (while (re-search-forward regexp nil t)
  12324. (when (or (not callback)
  12325. (save-match-data (funcall callback)))
  12326. (setq cnt (1+ cnt))
  12327. (when org-highlight-sparse-tree-matches
  12328. (org-highlight-new-match (match-beginning 0) (match-end 0)))
  12329. (org-show-context 'occur-tree))))
  12330. (when org-remove-highlights-with-change
  12331. (org-add-hook 'before-change-functions 'org-remove-occur-highlights
  12332. nil 'local))
  12333. (unless org-sparse-tree-open-archived-trees
  12334. (org-hide-archived-subtrees (point-min) (point-max)))
  12335. (run-hooks 'org-occur-hook)
  12336. (if (org-called-interactively-p 'interactive)
  12337. (message "%d match(es) for regexp %s" cnt regexp))
  12338. cnt))
  12339. (defun org-occur-next-match (&optional n reset)
  12340. "Function for `next-error-function' to find sparse tree matches.
  12341. N is the number of matches to move, when negative move backwards.
  12342. RESET is entirely ignored - this function always goes back to the
  12343. starting point when no match is found."
  12344. (let* ((limit (if (< n 0) (point-min) (point-max)))
  12345. (search-func (if (< n 0)
  12346. 'previous-single-char-property-change
  12347. 'next-single-char-property-change))
  12348. (n (abs n))
  12349. (pos (point))
  12350. p1)
  12351. (catch 'exit
  12352. (while (setq p1 (funcall search-func (point) 'org-type))
  12353. (when (equal p1 limit)
  12354. (goto-char pos)
  12355. (error "No more matches"))
  12356. (when (equal (get-char-property p1 'org-type) 'org-occur)
  12357. (setq n (1- n))
  12358. (when (= n 0)
  12359. (goto-char p1)
  12360. (throw 'exit (point))))
  12361. (goto-char p1))
  12362. (goto-char p1)
  12363. (error "No more matches"))))
  12364. (defun org-show-context (&optional key)
  12365. "Make sure point and context are visible.
  12366. How much context is shown depends upon the variables
  12367. `org-show-hierarchy-above', `org-show-following-heading',
  12368. `org-show-entry-below' and `org-show-siblings'."
  12369. (let ((heading-p (org-at-heading-p t))
  12370. (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
  12371. (following-p (org-get-alist-option org-show-following-heading key))
  12372. (entry-p (org-get-alist-option org-show-entry-below key))
  12373. (siblings-p (org-get-alist-option org-show-siblings key)))
  12374. ;; Show heading or entry text
  12375. (if (and heading-p (not entry-p))
  12376. (org-flag-heading nil) ; only show the heading
  12377. (and (or entry-p (outline-invisible-p) (org-invisible-p2))
  12378. (org-show-hidden-entry))) ; show entire entry
  12379. (when following-p
  12380. ;; Show next sibling, or heading below text
  12381. (save-excursion
  12382. (and (if heading-p (org-goto-sibling) (outline-next-heading))
  12383. (org-flag-heading nil))))
  12384. (when siblings-p (org-show-siblings))
  12385. (when hierarchy-p
  12386. ;; show all higher headings, possibly with siblings
  12387. (save-excursion
  12388. (while (and (condition-case nil
  12389. (progn (org-up-heading-all 1) t)
  12390. (error nil))
  12391. (not (bobp)))
  12392. (org-flag-heading nil)
  12393. (when siblings-p (org-show-siblings)))))
  12394. (unless (eq key 'agenda) (org-fix-ellipsis-at-bol))))
  12395. (defvar org-reveal-start-hook nil
  12396. "Hook run before revealing a location.")
  12397. (defun org-reveal (&optional siblings)
  12398. "Show current entry, hierarchy above it, and the following headline.
  12399. This can be used to show a consistent set of context around locations
  12400. exposed with `org-show-hierarchy-above' or `org-show-following-heading'
  12401. not t for the search context.
  12402. With optional argument SIBLINGS, on each level of the hierarchy all
  12403. siblings are shown. This repairs the tree structure to what it would
  12404. look like when opened with hierarchical calls to `org-cycle'.
  12405. With double optional argument \\[universal-argument] \\[universal-argument], \
  12406. go to the parent and show the
  12407. entire tree."
  12408. (interactive "P")
  12409. (run-hooks 'org-reveal-start-hook)
  12410. (let ((org-show-hierarchy-above t)
  12411. (org-show-following-heading t)
  12412. (org-show-siblings (if siblings t org-show-siblings)))
  12413. (org-show-context nil))
  12414. (when (equal siblings '(16))
  12415. (save-excursion
  12416. (when (org-up-heading-safe)
  12417. (org-show-subtree)
  12418. (run-hook-with-args 'org-cycle-hook 'subtree)))))
  12419. (defun org-highlight-new-match (beg end)
  12420. "Highlight from BEG to END and mark the highlight is an occur headline."
  12421. (let ((ov (make-overlay beg end)))
  12422. (overlay-put ov 'face 'secondary-selection)
  12423. (overlay-put ov 'org-type 'org-occur)
  12424. (push ov org-occur-highlights)))
  12425. (defun org-remove-occur-highlights (&optional beg end noremove)
  12426. "Remove the occur highlights from the buffer.
  12427. BEG and END are ignored. If NOREMOVE is nil, remove this function
  12428. from the `before-change-functions' in the current buffer."
  12429. (interactive)
  12430. (unless org-inhibit-highlight-removal
  12431. (mapc 'delete-overlay org-occur-highlights)
  12432. (setq org-occur-highlights nil)
  12433. (setq org-occur-parameters nil)
  12434. (unless noremove
  12435. (remove-hook 'before-change-functions
  12436. 'org-remove-occur-highlights 'local))))
  12437. ;;;; Priorities
  12438. (defvar org-priority-regexp ".*?\\(\\[#\\([A-Z0-9]\\)\\] ?\\)"
  12439. "Regular expression matching the priority indicator.")
  12440. (defvar org-remove-priority-next-time nil)
  12441. (defun org-priority-up ()
  12442. "Increase the priority of the current item."
  12443. (interactive)
  12444. (org-priority 'up))
  12445. (defun org-priority-down ()
  12446. "Decrease the priority of the current item."
  12447. (interactive)
  12448. (org-priority 'down))
  12449. (defun org-priority (&optional action show)
  12450. "Change the priority of an item.
  12451. ACTION can be `set', `up', `down', or a character."
  12452. (interactive "P")
  12453. (if (equal action '(4))
  12454. (org-show-priority)
  12455. (unless org-enable-priority-commands
  12456. (user-error "Priority commands are disabled"))
  12457. (setq action (or action 'set))
  12458. (let (current new news have remove)
  12459. (save-excursion
  12460. (org-back-to-heading t)
  12461. (if (looking-at org-priority-regexp)
  12462. (setq current (string-to-char (match-string 2))
  12463. have t))
  12464. (cond
  12465. ((eq action 'remove)
  12466. (setq remove t new ?\ ))
  12467. ((or (eq action 'set)
  12468. (if (featurep 'xemacs) (characterp action) (integerp action)))
  12469. (if (not (eq action 'set))
  12470. (setq new action)
  12471. (message "Priority %c-%c, SPC to remove: "
  12472. org-highest-priority org-lowest-priority)
  12473. (save-match-data
  12474. (setq new (read-char-exclusive))))
  12475. (if (and (= (upcase org-highest-priority) org-highest-priority)
  12476. (= (upcase org-lowest-priority) org-lowest-priority))
  12477. (setq new (upcase new)))
  12478. (cond ((equal new ?\ ) (setq remove t))
  12479. ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
  12480. (user-error "Priority must be between `%c' and `%c'"
  12481. org-highest-priority org-lowest-priority))))
  12482. ((eq action 'up)
  12483. (setq new (if have
  12484. (1- current) ; normal cycling
  12485. ;; last priority was empty
  12486. (if (eq last-command this-command)
  12487. org-lowest-priority ; wrap around empty to lowest
  12488. ;; default
  12489. (if org-priority-start-cycle-with-default
  12490. org-default-priority
  12491. (1- org-default-priority))))))
  12492. ((eq action 'down)
  12493. (setq new (if have
  12494. (1+ current) ; normal cycling
  12495. ;; last priority was empty
  12496. (if (eq last-command this-command)
  12497. org-highest-priority ; wrap around empty to highest
  12498. ;; default
  12499. (if org-priority-start-cycle-with-default
  12500. org-default-priority
  12501. (1+ org-default-priority))))))
  12502. (t (user-error "Invalid action")))
  12503. (if (or (< (upcase new) org-highest-priority)
  12504. (> (upcase new) org-lowest-priority))
  12505. (if (and (memq action '(up down))
  12506. (not have) (not (eq last-command this-command)))
  12507. ;; `new' is from default priority
  12508. (error
  12509. "The default can not be set, see `org-default-priority' why")
  12510. ;; normal cycling: `new' is beyond highest/lowest priority
  12511. ;; and is wrapped around to the empty priority
  12512. (setq remove t)))
  12513. (setq news (format "%c" new))
  12514. (if have
  12515. (if remove
  12516. (replace-match "" t t nil 1)
  12517. (replace-match news t t nil 2))
  12518. (if remove
  12519. (user-error "No priority cookie found in line")
  12520. (let ((case-fold-search nil))
  12521. (looking-at org-todo-line-regexp))
  12522. (if (match-end 2)
  12523. (progn
  12524. (goto-char (match-end 2))
  12525. (insert " [#" news "]"))
  12526. (goto-char (match-beginning 3))
  12527. (insert "[#" news "] "))))
  12528. (org-preserve-lc (org-set-tags nil 'align)))
  12529. (if remove
  12530. (message "Priority removed")
  12531. (message "Priority of current item set to %s" news)))))
  12532. (defun org-show-priority ()
  12533. "Show the priority of the current item.
  12534. This priority is composed of the main priority given with the [#A] cookies,
  12535. and by additional input from the age of a schedules or deadline entry."
  12536. (interactive)
  12537. (let ((pri (if (eq major-mode 'org-agenda-mode)
  12538. (org-get-at-bol 'priority)
  12539. (save-excursion
  12540. (save-match-data
  12541. (beginning-of-line)
  12542. (and (looking-at org-heading-regexp)
  12543. (org-get-priority (match-string 0))))))))
  12544. (message "Priority is %d" (if pri pri -1000))))
  12545. (defun org-get-priority (s)
  12546. "Find priority cookie and return priority."
  12547. (save-match-data
  12548. (if (functionp org-get-priority-function)
  12549. (funcall org-get-priority-function)
  12550. (if (not (string-match org-priority-regexp s))
  12551. (* 1000 (- org-lowest-priority org-default-priority))
  12552. (* 1000 (- org-lowest-priority
  12553. (string-to-char (match-string 2 s))))))))
  12554. ;;;; Tags
  12555. (defvar org-agenda-archives-mode)
  12556. (defvar org-map-continue-from nil
  12557. "Position from where mapping should continue.
  12558. Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
  12559. (defvar org-scanner-tags nil
  12560. "The current tag list while the tags scanner is running.")
  12561. (defvar org-trust-scanner-tags nil
  12562. "Should `org-get-tags-at' use the tags for the scanner.
  12563. This is for internal dynamical scoping only.
  12564. When this is non-nil, the function `org-get-tags-at' will return the value
  12565. of `org-scanner-tags' instead of building the list by itself. This
  12566. can lead to large speed-ups when the tags scanner is used in a file with
  12567. many entries, and when the list of tags is retrieved, for example to
  12568. obtain a list of properties. Building the tags list for each entry in such
  12569. a file becomes an N^2 operation - but with this variable set, it scales
  12570. as N.")
  12571. (defun org-scan-tags (action matcher todo-only &optional start-level)
  12572. "Sca headline tags with inheritance and produce output ACTION.
  12573. ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
  12574. or `agenda' to produce an entry list for an agenda view. It can also be
  12575. a Lisp form or a function that should be called at each matched headline, in
  12576. this case the return value is a list of all return values from these calls.
  12577. MATCHER is a Lisp form to be evaluated, testing if a given set of tags
  12578. qualifies a headline for inclusion. When TODO-ONLY is non-nil,
  12579. only lines with a not-done TODO keyword are included in the output.
  12580. This should be the same variable that was scoped into
  12581. and set by `org-make-tags-matcher' when it constructed MATCHER.
  12582. START-LEVEL can be a string with asterisks, reducing the scope to
  12583. headlines matching this string."
  12584. (require 'org-agenda)
  12585. (let* ((re (concat "^"
  12586. (if start-level
  12587. ;; Get the correct level to match
  12588. (concat "\\*\\{" (number-to-string start-level) "\\} ")
  12589. org-outline-regexp)
  12590. " *\\(\\<\\("
  12591. (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
  12592. (org-re "\\)\\>\\)? *\\(.*?\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*$")))
  12593. (props (list 'face 'default
  12594. 'done-face 'org-agenda-done
  12595. 'undone-face 'default
  12596. 'mouse-face 'highlight
  12597. 'org-not-done-regexp org-not-done-regexp
  12598. 'org-todo-regexp org-todo-regexp
  12599. 'org-complex-heading-regexp org-complex-heading-regexp
  12600. 'help-echo
  12601. (format "mouse-2 or RET jump to org file %s"
  12602. (abbreviate-file-name
  12603. (or (buffer-file-name (buffer-base-buffer))
  12604. (buffer-name (buffer-base-buffer)))))))
  12605. (org-map-continue-from nil)
  12606. lspos tags tags-list
  12607. (tags-alist (list (cons 0 org-file-tags)))
  12608. (llast 0) rtn rtn1 level category i txt
  12609. todo marker entry priority)
  12610. (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
  12611. (setq action (list 'lambda nil action)))
  12612. (save-excursion
  12613. (goto-char (point-min))
  12614. (when (eq action 'sparse-tree)
  12615. (org-overview)
  12616. (org-remove-occur-highlights))
  12617. (while (let (case-fold-search)
  12618. (re-search-forward re nil t))
  12619. (setq org-map-continue-from nil)
  12620. (catch :skip
  12621. (setq todo (if (match-end 1) (org-match-string-no-properties 2))
  12622. tags (if (match-end 4) (org-match-string-no-properties 4)))
  12623. (goto-char (setq lspos (match-beginning 0)))
  12624. (setq level (org-reduced-level (org-outline-level))
  12625. category (org-get-category))
  12626. (setq i llast llast level)
  12627. ;; remove tag lists from same and sublevels
  12628. (while (>= i level)
  12629. (when (setq entry (assoc i tags-alist))
  12630. (setq tags-alist (delete entry tags-alist)))
  12631. (setq i (1- i)))
  12632. ;; add the next tags
  12633. (when tags
  12634. (setq tags (org-split-string tags ":")
  12635. tags-alist
  12636. (cons (cons level tags) tags-alist)))
  12637. ;; compile tags for current headline
  12638. (setq tags-list
  12639. (if org-use-tag-inheritance
  12640. (apply 'append (mapcar 'cdr (reverse tags-alist)))
  12641. tags)
  12642. org-scanner-tags tags-list)
  12643. (when org-use-tag-inheritance
  12644. (setcdr (car tags-alist)
  12645. (mapcar (lambda (x)
  12646. (setq x (copy-sequence x))
  12647. (org-add-prop-inherited x))
  12648. (cdar tags-alist))))
  12649. (when (and tags org-use-tag-inheritance
  12650. (or (not (eq t org-use-tag-inheritance))
  12651. org-tags-exclude-from-inheritance))
  12652. ;; selective inheritance, remove uninherited ones
  12653. (setcdr (car tags-alist)
  12654. (org-remove-uninherited-tags (cdar tags-alist))))
  12655. (when (and
  12656. ;; eval matcher only when the todo condition is OK
  12657. (and (or (not todo-only) (member todo org-not-done-keywords))
  12658. (let ((case-fold-search t) (org-trust-scanner-tags t))
  12659. (eval matcher)))
  12660. ;; Call the skipper, but return t if it does not skip,
  12661. ;; so that the `and' form continues evaluating
  12662. (progn
  12663. (unless (eq action 'sparse-tree) (org-agenda-skip))
  12664. t)
  12665. ;; Check if timestamps are deselecting this entry
  12666. (or (not todo-only)
  12667. (and (member todo org-not-done-keywords)
  12668. (or (not org-agenda-tags-todo-honor-ignore-options)
  12669. (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item))))))
  12670. ;; select this headline
  12671. (cond
  12672. ((eq action 'sparse-tree)
  12673. (and org-highlight-sparse-tree-matches
  12674. (org-get-heading) (match-end 0)
  12675. (org-highlight-new-match
  12676. (match-beginning 1) (match-end 1)))
  12677. (org-show-context 'tags-tree))
  12678. ((eq action 'agenda)
  12679. (setq txt (org-agenda-format-item
  12680. ""
  12681. (concat
  12682. (if (eq org-tags-match-list-sublevels 'indented)
  12683. (make-string (1- level) ?.) "")
  12684. (org-get-heading))
  12685. level category
  12686. tags-list)
  12687. priority (org-get-priority txt))
  12688. (goto-char lspos)
  12689. (setq marker (org-agenda-new-marker))
  12690. (org-add-props txt props
  12691. 'org-marker marker 'org-hd-marker marker 'org-category category
  12692. 'todo-state todo
  12693. 'priority priority 'type "tagsmatch")
  12694. (push txt rtn))
  12695. ((functionp action)
  12696. (setq org-map-continue-from nil)
  12697. (save-excursion
  12698. (setq rtn1 (funcall action))
  12699. (push rtn1 rtn)))
  12700. (t (user-error "Invalid action")))
  12701. ;; if we are to skip sublevels, jump to end of subtree
  12702. (unless org-tags-match-list-sublevels
  12703. (org-end-of-subtree t)
  12704. (backward-char 1))))
  12705. ;; Get the correct position from where to continue
  12706. (if org-map-continue-from
  12707. (goto-char org-map-continue-from)
  12708. (and (= (point) lspos) (end-of-line 1)))))
  12709. (when (and (eq action 'sparse-tree)
  12710. (not org-sparse-tree-open-archived-trees))
  12711. (org-hide-archived-subtrees (point-min) (point-max)))
  12712. (nreverse rtn)))
  12713. (defun org-remove-uninherited-tags (tags)
  12714. "Remove all tags that are not inherited from the list TAGS."
  12715. (cond
  12716. ((eq org-use-tag-inheritance t)
  12717. (if org-tags-exclude-from-inheritance
  12718. (org-delete-all org-tags-exclude-from-inheritance tags)
  12719. tags))
  12720. ((not org-use-tag-inheritance) nil)
  12721. ((stringp org-use-tag-inheritance)
  12722. (delq nil (mapcar
  12723. (lambda (x)
  12724. (if (and (string-match org-use-tag-inheritance x)
  12725. (not (member x org-tags-exclude-from-inheritance)))
  12726. x nil))
  12727. tags)))
  12728. ((listp org-use-tag-inheritance)
  12729. (delq nil (mapcar
  12730. (lambda (x)
  12731. (if (member x org-use-tag-inheritance) x nil))
  12732. tags)))))
  12733. (defun org-match-sparse-tree (&optional todo-only match)
  12734. "Create a sparse tree according to tags string MATCH.
  12735. MATCH can contain positive and negative selection of tags, like
  12736. \"+WORK+URGENT-WITHBOSS\".
  12737. If optional argument TODO-ONLY is non-nil, only select lines that are
  12738. also TODO lines."
  12739. (interactive "P")
  12740. (org-agenda-prepare-buffers (list (current-buffer)))
  12741. (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
  12742. (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
  12743. (defvar org-cached-props nil)
  12744. (defun org-cached-entry-get (pom property)
  12745. (if (or (eq t org-use-property-inheritance)
  12746. (and (stringp org-use-property-inheritance)
  12747. (string-match org-use-property-inheritance property))
  12748. (and (listp org-use-property-inheritance)
  12749. (member property org-use-property-inheritance)))
  12750. ;; Caching is not possible, check it directly
  12751. (org-entry-get pom property 'inherit)
  12752. ;; Get all properties, so that we can do complicated checks easily
  12753. (cdr (assoc property (or org-cached-props
  12754. (setq org-cached-props
  12755. (org-entry-properties pom)))))))
  12756. (defun org-global-tags-completion-table (&optional files)
  12757. "Return the list of all tags in all agenda buffer/files.
  12758. Optional FILES argument is a list of files which can be used
  12759. instead of the agenda files."
  12760. (save-excursion
  12761. (org-uniquify
  12762. (delq nil
  12763. (apply 'append
  12764. (mapcar
  12765. (lambda (file)
  12766. (set-buffer (find-file-noselect file))
  12767. (append (org-get-buffer-tags)
  12768. (mapcar (lambda (x) (if (stringp (car-safe x))
  12769. (list (car-safe x)) nil))
  12770. org-tag-alist)))
  12771. (if (and files (car files))
  12772. files
  12773. (org-agenda-files))))))))
  12774. (defun org-make-tags-matcher (match)
  12775. "Create the TAGS/TODO matcher form for the selection string MATCH.
  12776. The variable `todo-only' is scoped dynamically into this function.
  12777. It will be set to t if the matcher restricts matching to TODO entries,
  12778. otherwise will not be touched.
  12779. Returns a cons of the selection string MATCH and the constructed
  12780. lisp form implementing the matcher. The matcher is to be evaluated
  12781. at an Org entry, with point on the headline, and returns t if the
  12782. entry matches the selection string MATCH. The returned lisp form
  12783. references two variables with information about the entry, which
  12784. must be bound around the form's evaluation: todo, the TODO keyword
  12785. at the entry (or nil of none); and tags-list, the list of all tags
  12786. at the entry including inherited ones. Additionally, the category
  12787. of the entry (if any) must be specified as the text property
  12788. 'org-category on the headline.
  12789. See also `org-scan-tags'.
  12790. "
  12791. (declare (special todo-only))
  12792. (unless (boundp 'todo-only)
  12793. (error "`org-make-tags-matcher' expects todo-only to be scoped in"))
  12794. (unless match
  12795. ;; Get a new match request, with completion against the global
  12796. ;; tags table and the local tags in current buffer
  12797. (let ((org-last-tags-completion-table
  12798. (org-uniquify
  12799. (delq nil (append (org-get-buffer-tags)
  12800. (org-global-tags-completion-table))))))
  12801. (setq match (org-completing-read-no-i
  12802. "Match: " 'org-tags-completion-function nil nil nil
  12803. 'org-tags-history))))
  12804. ;; Parse the string and create a lisp form
  12805. (let ((match0 match)
  12806. (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
  12807. minus tag mm
  12808. tagsmatch todomatch tagsmatcher todomatcher kwd matcher
  12809. orterms term orlist re-p str-p level-p level-op time-p
  12810. prop-p pn pv po gv rest)
  12811. ;; Expand group tags
  12812. (setq match (org-tags-expand match))
  12813. (if (string-match "/+" match)
  12814. ;; match contains also a todo-matching request
  12815. (progn
  12816. (setq tagsmatch (substring match 0 (match-beginning 0))
  12817. todomatch (substring match (match-end 0)))
  12818. (if (string-match "^!" todomatch)
  12819. (setq todo-only t todomatch (substring todomatch 1)))
  12820. (if (string-match "^\\s-*$" todomatch)
  12821. (setq todomatch nil)))
  12822. ;; only matching tags
  12823. (setq tagsmatch match todomatch nil))
  12824. ;; Make the tags matcher
  12825. (if (or (not tagsmatch) (not (string-match "\\S-" tagsmatch)))
  12826. (setq tagsmatcher t)
  12827. (setq orterms (org-split-string tagsmatch "|") orlist nil)
  12828. (while (setq term (pop orterms))
  12829. (while (and (equal (substring term -1) "\\") orterms)
  12830. (setq term (concat term "|" (pop orterms)))) ; repair bad split
  12831. (while (string-match re term)
  12832. (setq rest (substring term (match-end 0))
  12833. minus (and (match-end 1)
  12834. (equal (match-string 1 term) "-"))
  12835. tag (save-match-data (replace-regexp-in-string
  12836. "\\\\-" "-"
  12837. (match-string 2 term)))
  12838. re-p (equal (string-to-char tag) ?{)
  12839. level-p (match-end 4)
  12840. prop-p (match-end 5)
  12841. mm (cond
  12842. (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
  12843. (level-p
  12844. (setq level-op (org-op-to-function (match-string 3 term)))
  12845. `(,level-op level ,(string-to-number
  12846. (match-string 4 term))))
  12847. (prop-p
  12848. (setq pn (match-string 5 term)
  12849. po (match-string 6 term)
  12850. pv (match-string 7 term)
  12851. re-p (equal (string-to-char pv) ?{)
  12852. str-p (equal (string-to-char pv) ?\")
  12853. time-p (save-match-data
  12854. (string-match "^\"[[<].*[]>]\"$" pv))
  12855. pv (if (or re-p str-p) (substring pv 1 -1) pv))
  12856. (if time-p (setq pv (org-matcher-time pv)))
  12857. (setq po (org-op-to-function po (if time-p 'time str-p)))
  12858. (cond
  12859. ((equal pn "CATEGORY")
  12860. (setq gv '(get-text-property (point) 'org-category)))
  12861. ((equal pn "TODO")
  12862. (setq gv 'todo))
  12863. (t
  12864. (setq gv `(org-cached-entry-get nil ,pn))))
  12865. (if re-p
  12866. (if (eq po 'org<>)
  12867. `(not (string-match ,pv (or ,gv "")))
  12868. `(string-match ,pv (or ,gv "")))
  12869. (if str-p
  12870. `(,po (or ,gv "") ,pv)
  12871. `(,po (string-to-number (or ,gv ""))
  12872. ,(string-to-number pv) ))))
  12873. (t `(member ,tag tags-list)))
  12874. mm (if minus (list 'not mm) mm)
  12875. term rest)
  12876. (push mm tagsmatcher))
  12877. (push (if (> (length tagsmatcher) 1)
  12878. (cons 'and tagsmatcher)
  12879. (car tagsmatcher))
  12880. orlist)
  12881. (setq tagsmatcher nil))
  12882. (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
  12883. (setq tagsmatcher
  12884. (list 'progn '(setq org-cached-props nil) tagsmatcher)))
  12885. ;; Make the todo matcher
  12886. (if (or (not todomatch) (not (string-match "\\S-" todomatch)))
  12887. (setq todomatcher t)
  12888. (setq orterms (org-split-string todomatch "|") orlist nil)
  12889. (while (setq term (pop orterms))
  12890. (while (string-match re term)
  12891. (setq minus (and (match-end 1)
  12892. (equal (match-string 1 term) "-"))
  12893. kwd (match-string 2 term)
  12894. re-p (equal (string-to-char kwd) ?{)
  12895. term (substring term (match-end 0))
  12896. mm (if re-p
  12897. `(string-match ,(substring kwd 1 -1) todo)
  12898. (list 'equal 'todo kwd))
  12899. mm (if minus (list 'not mm) mm))
  12900. (push mm todomatcher))
  12901. (push (if (> (length todomatcher) 1)
  12902. (cons 'and todomatcher)
  12903. (car todomatcher))
  12904. orlist)
  12905. (setq todomatcher nil))
  12906. (setq todomatcher (if (> (length orlist) 1)
  12907. (cons 'or orlist) (car orlist))))
  12908. ;; Return the string and lisp forms of the matcher
  12909. (setq matcher (if todomatcher
  12910. (list 'and tagsmatcher todomatcher)
  12911. tagsmatcher))
  12912. (when todo-only
  12913. (setq matcher (list 'and '(member todo org-not-done-keywords)
  12914. matcher)))
  12915. (cons match0 matcher)))
  12916. (defun org-tags-expand (match &optional single-as-list downcased)
  12917. "Expand group tags in MATCH.
  12918. This replaces every group tag in MATCH with a regexp tag search.
  12919. For example, a group tag \"Work\" defined as { Work : Lab Conf }
  12920. will be replaced like this:
  12921. Work => {\\(?:Work\\|Lab\\|Conf\\)}
  12922. +Work => +{\\(?:Work\\|Lab\\|Conf\\)}
  12923. -Work => -{\\(?:Work\\|Lab\\|Conf\\)}
  12924. Replacing by a regexp preserves the structure of the match.
  12925. E.g., this expansion
  12926. Work|Home => {\\(?:Work\\|Lab\\|Conf\\}|Home
  12927. will match anything tagged with \"Lab\" and \"Home\", or tagged
  12928. with \"Conf\" and \"Home\" or tagged with \"Work\" and \"home\".
  12929. When the optional argument SINGLE-AS-LIST is non-nil, MATCH is
  12930. assumed to be a single group tag, and the function will return
  12931. the list of tags in this group.
  12932. When DOWNCASE is non-nil, expand downcased TAGS."
  12933. (if org-group-tags
  12934. (let* ((case-fold-search t)
  12935. (stable org-mode-syntax-table)
  12936. (tal (or org-tag-groups-alist-for-agenda
  12937. org-tag-groups-alist))
  12938. (tal (if downcased
  12939. (mapcar (lambda(tg) (mapcar 'downcase tg)) tal) tal))
  12940. (tml (mapcar 'car tal))
  12941. (rtnmatch match) rpl)
  12942. ;; @ and _ are allowed as word-components in tags
  12943. (modify-syntax-entry ?@ "w" stable)
  12944. (modify-syntax-entry ?_ "w" stable)
  12945. (while (and tml
  12946. (with-syntax-table stable
  12947. (string-match
  12948. (concat "\\(?1:[+-]?\\)\\(?2:\\<"
  12949. (regexp-opt tml) "\\>\\)") rtnmatch)))
  12950. (let* ((dir (match-string 1 rtnmatch))
  12951. (tag (match-string 2 rtnmatch))
  12952. (tag (if downcased (downcase tag) tag)))
  12953. (setq tml (delete tag tml))
  12954. (when (not (get-text-property 0 'grouptag (match-string 2 rtnmatch)))
  12955. (setq rpl (append (org-uniquify rpl) (assoc tag tal)))
  12956. (setq rpl (concat dir "{\\<" (regexp-opt rpl) "\\>}"))
  12957. (if (stringp rpl) (org-add-props rpl '(grouptag t)))
  12958. (setq rtnmatch (replace-match rpl t t rtnmatch)))))
  12959. (if single-as-list
  12960. (or (reverse rpl) (list rtnmatch))
  12961. rtnmatch))
  12962. (if single-as-list (list (if downcased (downcase match) match))
  12963. match)))
  12964. (defun org-op-to-function (op &optional stringp)
  12965. "Turn an operator into the appropriate function."
  12966. (setq op
  12967. (cond
  12968. ((equal op "<" ) '(< string< org-time<))
  12969. ((equal op ">" ) '(> org-string> org-time>))
  12970. ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
  12971. ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
  12972. ((member op '("=" "==")) '(= string= org-time=))
  12973. ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
  12974. (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
  12975. (defun org<> (a b) (not (= a b)))
  12976. (defun org-string<= (a b) (or (string= a b) (string< a b)))
  12977. (defun org-string>= (a b) (not (string< a b)))
  12978. (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
  12979. (defun org-string<> (a b) (not (string= a b)))
  12980. (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
  12981. (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
  12982. (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
  12983. (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
  12984. (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
  12985. (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
  12986. (defun org-2ft (s)
  12987. "Convert S to a floating point time.
  12988. If S is already a number, just return it. If it is a string, parse
  12989. it as a time string and apply `float-time' to it. If S is nil, just return 0."
  12990. (cond
  12991. ((numberp s) s)
  12992. ((stringp s)
  12993. (condition-case nil
  12994. (float-time (apply 'encode-time (org-parse-time-string s)))
  12995. (error 0.)))
  12996. (t 0.)))
  12997. (defun org-time-today ()
  12998. "Time in seconds today at 0:00.
  12999. Returns the float number of seconds since the beginning of the
  13000. epoch to the beginning of today (00:00)."
  13001. (float-time (apply 'encode-time
  13002. (append '(0 0 0) (nthcdr 3 (decode-time))))))
  13003. (defun org-matcher-time (s)
  13004. "Interpret a time comparison value."
  13005. (save-match-data
  13006. (cond
  13007. ((string= s "<now>") (float-time))
  13008. ((string= s "<today>") (org-time-today))
  13009. ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
  13010. ((string= s "<yesterday>") (- (org-time-today) 86400.0))
  13011. ((string-match "^<\\([-+][0-9]+\\)\\([hdwmy]\\)>$" s)
  13012. (+ (org-time-today)
  13013. (* (string-to-number (match-string 1 s))
  13014. (cdr (assoc (match-string 2 s)
  13015. '(("d" . 86400.0) ("w" . 604800.0)
  13016. ("m" . 2678400.0) ("y" . 31557600.0)))))))
  13017. (t (org-2ft s)))))
  13018. (defun org-match-any-p (re list)
  13019. "Does re match any element of list?"
  13020. (setq list (mapcar (lambda (x) (string-match re x)) list))
  13021. (delq nil list))
  13022. (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
  13023. (defvar org-tags-overlay (make-overlay 1 1))
  13024. (org-detach-overlay org-tags-overlay)
  13025. (defun org-get-local-tags-at (&optional pos)
  13026. "Get a list of tags defined in the current headline."
  13027. (org-get-tags-at pos 'local))
  13028. (defun org-get-local-tags ()
  13029. "Get a list of tags defined in the current headline."
  13030. (org-get-tags-at nil 'local))
  13031. (defun org-get-tags-at (&optional pos local)
  13032. "Get a list of all headline tags applicable at POS.
  13033. POS defaults to point. If tags are inherited, the list contains
  13034. the targets in the same sequence as the headlines appear, i.e.
  13035. the tags of the current headline come last.
  13036. When LOCAL is non-nil, only return tags from the current headline,
  13037. ignore inherited ones."
  13038. (interactive)
  13039. (if (and org-trust-scanner-tags
  13040. (or (not pos) (equal pos (point)))
  13041. (not local))
  13042. org-scanner-tags
  13043. (let (tags ltags lastpos parent)
  13044. (save-excursion
  13045. (save-restriction
  13046. (widen)
  13047. (goto-char (or pos (point)))
  13048. (save-match-data
  13049. (catch 'done
  13050. (condition-case nil
  13051. (progn
  13052. (org-back-to-heading t)
  13053. (while (not (equal lastpos (point)))
  13054. (setq lastpos (point))
  13055. (when (looking-at
  13056. (org-re "[^\r\n]+?:\\([[:alnum:]_@#%:]+\\):[ \t]*$"))
  13057. (setq ltags (org-split-string
  13058. (org-match-string-no-properties 1) ":"))
  13059. (when parent
  13060. (setq ltags (mapcar 'org-add-prop-inherited ltags)))
  13061. (setq tags (append
  13062. (if parent
  13063. (org-remove-uninherited-tags ltags)
  13064. ltags)
  13065. tags)))
  13066. (or org-use-tag-inheritance (throw 'done t))
  13067. (if local (throw 'done t))
  13068. (or (org-up-heading-safe) (error nil))
  13069. (setq parent t)))
  13070. (error nil)))))
  13071. (if local
  13072. tags
  13073. (reverse (delete-dups
  13074. (reverse (append
  13075. (org-remove-uninherited-tags
  13076. org-file-tags) tags)))))))))
  13077. (defun org-add-prop-inherited (s)
  13078. (add-text-properties 0 (length s) '(inherited t) s)
  13079. s)
  13080. (defun org-toggle-tag (tag &optional onoff)
  13081. "Toggle the tag TAG for the current line.
  13082. If ONOFF is `on' or `off', don't toggle but set to this state."
  13083. (let (res current)
  13084. (save-excursion
  13085. (org-back-to-heading t)
  13086. (if (re-search-forward (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t]*$")
  13087. (point-at-eol) t)
  13088. (progn
  13089. (setq current (match-string 1))
  13090. (replace-match ""))
  13091. (setq current ""))
  13092. (setq current (nreverse (org-split-string current ":")))
  13093. (cond
  13094. ((eq onoff 'on)
  13095. (setq res t)
  13096. (or (member tag current) (push tag current)))
  13097. ((eq onoff 'off)
  13098. (or (not (member tag current)) (setq current (delete tag current))))
  13099. (t (if (member tag current)
  13100. (setq current (delete tag current))
  13101. (setq res t)
  13102. (push tag current))))
  13103. (end-of-line 1)
  13104. (if current
  13105. (progn
  13106. (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
  13107. (org-set-tags nil t))
  13108. (delete-horizontal-space))
  13109. (run-hooks 'org-after-tags-change-hook))
  13110. res))
  13111. (defun org-align-tags-here (to-col)
  13112. ;; Assumes that this is a headline
  13113. (let ((pos (point)) (col (current-column)) ncol tags-l p)
  13114. (beginning-of-line 1)
  13115. (if (and (looking-at (org-re ".*?\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
  13116. (< pos (match-beginning 2)))
  13117. (progn
  13118. (setq tags-l (- (match-end 2) (match-beginning 2)))
  13119. (goto-char (match-beginning 1))
  13120. (insert " ")
  13121. (delete-region (point) (1+ (match-beginning 2)))
  13122. (setq ncol (max (current-column)
  13123. (1+ col)
  13124. (if (> to-col 0)
  13125. to-col
  13126. (- (abs to-col) tags-l))))
  13127. (setq p (point))
  13128. (insert (make-string (- ncol (current-column)) ?\ ))
  13129. (setq ncol (current-column))
  13130. (when indent-tabs-mode (tabify p (point-at-eol)))
  13131. (org-move-to-column (min ncol col) t))
  13132. (goto-char pos))))
  13133. (defun org-set-tags-command (&optional arg just-align)
  13134. "Call the set-tags command for the current entry."
  13135. (interactive "P")
  13136. (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
  13137. (org-set-tags arg just-align)
  13138. (save-excursion
  13139. (unless (and (org-region-active-p)
  13140. org-loop-over-headlines-in-active-region)
  13141. (org-back-to-heading t))
  13142. (org-set-tags arg just-align))))
  13143. (defun org-set-tags-to (data)
  13144. "Set the tags of the current entry to DATA, replacing the current tags.
  13145. DATA may be a tags string like :aa:bb:cc:, or a list of tags.
  13146. If DATA is nil or the empty string, any tags will be removed."
  13147. (interactive "sTags: ")
  13148. (setq data
  13149. (cond
  13150. ((eq data nil) "")
  13151. ((equal data "") "")
  13152. ((stringp data)
  13153. (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
  13154. ":"))
  13155. ((listp data)
  13156. (concat ":" (mapconcat 'identity data ":") ":"))))
  13157. (when data
  13158. (save-excursion
  13159. (org-back-to-heading t)
  13160. (when (looking-at org-complex-heading-regexp)
  13161. (if (match-end 5)
  13162. (progn
  13163. (goto-char (match-beginning 5))
  13164. (insert data)
  13165. (delete-region (point) (point-at-eol))
  13166. (org-set-tags nil 'align))
  13167. (goto-char (point-at-eol))
  13168. (insert " " data)
  13169. (org-set-tags nil 'align)))
  13170. (beginning-of-line 1)
  13171. (if (looking-at ".*?\\([ \t]+\\)$")
  13172. (delete-region (match-beginning 1) (match-end 1))))))
  13173. (defun org-align-all-tags ()
  13174. "Align the tags i all headings."
  13175. (interactive)
  13176. (save-excursion
  13177. (or (ignore-errors (org-back-to-heading t))
  13178. (outline-next-heading))
  13179. (if (org-at-heading-p)
  13180. (org-set-tags t)
  13181. (message "No headings"))))
  13182. (defvar org-indent-indentation-per-level)
  13183. (defun org-set-tags (&optional arg just-align)
  13184. "Set the tags for the current headline.
  13185. With prefix ARG, realign all tags in headings in the current buffer."
  13186. (interactive "P")
  13187. (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
  13188. (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
  13189. 'region-start-level 'region))
  13190. org-loop-over-headlines-in-active-region)
  13191. (org-map-entries
  13192. ;; We don't use ARG and JUST-ALIGN here these args are not
  13193. ;; useful when looping over headlines
  13194. `(org-set-tags)
  13195. org-loop-over-headlines-in-active-region
  13196. cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
  13197. (let* ((re org-outline-regexp-bol)
  13198. (current (unless arg (org-get-tags-string)))
  13199. (col (current-column))
  13200. (org-setting-tags t)
  13201. table current-tags inherited-tags ; computed below when needed
  13202. tags p0 c0 c1 rpl di tc level)
  13203. (if arg
  13204. (save-excursion
  13205. (goto-char (point-min))
  13206. (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
  13207. (while (re-search-forward re nil t)
  13208. (org-set-tags nil t)
  13209. (end-of-line 1)))
  13210. (message "All tags realigned to column %d" org-tags-column))
  13211. (if just-align
  13212. (setq tags current)
  13213. ;; Get a new set of tags from the user
  13214. (save-excursion
  13215. (setq table (append org-tag-persistent-alist
  13216. (or org-tag-alist (org-get-buffer-tags))
  13217. (and
  13218. org-complete-tags-always-offer-all-agenda-tags
  13219. (org-global-tags-completion-table
  13220. (org-agenda-files))))
  13221. org-last-tags-completion-table table
  13222. current-tags (org-split-string current ":")
  13223. inherited-tags (nreverse
  13224. (nthcdr (length current-tags)
  13225. (nreverse (org-get-tags-at))))
  13226. tags
  13227. (if (or (eq t org-use-fast-tag-selection)
  13228. (and org-use-fast-tag-selection
  13229. (delq nil (mapcar 'cdr table))))
  13230. (org-fast-tag-selection
  13231. current-tags inherited-tags table
  13232. (if org-fast-tag-selection-include-todo
  13233. org-todo-key-alist))
  13234. (let ((org-add-colon-after-tag-completion (< 1 (length table))))
  13235. (org-trim
  13236. (org-icompleting-read "Tags: "
  13237. 'org-tags-completion-function
  13238. nil nil current 'org-tags-history))))))
  13239. (while (string-match "[-+&]+" tags)
  13240. ;; No boolean logic, just a list
  13241. (setq tags (replace-match ":" t t tags))))
  13242. (setq tags (replace-regexp-in-string "[,]" ":" tags))
  13243. (if org-tags-sort-function
  13244. (setq tags (mapconcat 'identity
  13245. (sort (org-split-string
  13246. tags (org-re "[^[:alnum:]_@#%]+"))
  13247. org-tags-sort-function) ":")))
  13248. (if (string-match "\\`[\t ]*\\'" tags)
  13249. (setq tags "")
  13250. (unless (string-match ":$" tags) (setq tags (concat tags ":")))
  13251. (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
  13252. ;; Insert new tags at the correct column
  13253. (beginning-of-line 1)
  13254. (setq level (or (and (looking-at org-outline-regexp)
  13255. (- (match-end 0) (point) 1))
  13256. 1))
  13257. (cond
  13258. ((and (equal current "") (equal tags "")))
  13259. ((re-search-forward
  13260. (concat "\\([ \t]*" (regexp-quote current) "\\)[ \t]*$")
  13261. (point-at-eol) t)
  13262. (if (equal tags "")
  13263. (setq rpl "")
  13264. (goto-char (match-beginning 0))
  13265. (setq c0 (current-column)
  13266. ;; compute offset for the case of org-indent-mode active
  13267. di (if org-indent-mode
  13268. (* (1- org-indent-indentation-per-level) (1- level))
  13269. 0)
  13270. p0 (if (equal (char-before) ?*) (1+ (point)) (point))
  13271. tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
  13272. c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
  13273. rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
  13274. (replace-match rpl t t)
  13275. (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
  13276. tags)
  13277. (t (error "Tags alignment failed")))
  13278. (org-move-to-column col)
  13279. (unless just-align
  13280. (run-hooks 'org-after-tags-change-hook))))))
  13281. (defun org-change-tag-in-region (beg end tag off)
  13282. "Add or remove TAG for each entry in the region.
  13283. This works in the agenda, and also in an org-mode buffer."
  13284. (interactive
  13285. (list (region-beginning) (region-end)
  13286. (let ((org-last-tags-completion-table
  13287. (if (derived-mode-p 'org-mode)
  13288. (org-uniquify
  13289. (delq nil (append (org-get-buffer-tags)
  13290. (org-global-tags-completion-table))))
  13291. (org-global-tags-completion-table))))
  13292. (org-icompleting-read
  13293. "Tag: " 'org-tags-completion-function nil nil nil
  13294. 'org-tags-history))
  13295. (progn
  13296. (message "[s]et or [r]emove? ")
  13297. (equal (read-char-exclusive) ?r))))
  13298. (if (fboundp 'deactivate-mark) (deactivate-mark))
  13299. (let ((agendap (equal major-mode 'org-agenda-mode))
  13300. l1 l2 m buf pos newhead (cnt 0))
  13301. (goto-char end)
  13302. (setq l2 (1- (org-current-line)))
  13303. (goto-char beg)
  13304. (setq l1 (org-current-line))
  13305. (loop for l from l1 to l2 do
  13306. (org-goto-line l)
  13307. (setq m (get-text-property (point) 'org-hd-marker))
  13308. (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
  13309. (and agendap m))
  13310. (setq buf (if agendap (marker-buffer m) (current-buffer))
  13311. pos (if agendap m (point)))
  13312. (with-current-buffer buf
  13313. (save-excursion
  13314. (save-restriction
  13315. (goto-char pos)
  13316. (setq cnt (1+ cnt))
  13317. (org-toggle-tag tag (if off 'off 'on))
  13318. (setq newhead (org-get-heading)))))
  13319. (and agendap (org-agenda-change-all-lines newhead m))))
  13320. (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
  13321. (defun org-tags-completion-function (string predicate &optional flag)
  13322. (let (s1 s2 rtn (ctable org-last-tags-completion-table)
  13323. (confirm (lambda (x) (stringp (car x)))))
  13324. (if (string-match "^\\(.*[-+:&,|]\\)\\([^-+:&,|]*\\)$" string)
  13325. (setq s1 (match-string 1 string)
  13326. s2 (match-string 2 string))
  13327. (setq s1 "" s2 string))
  13328. (cond
  13329. ((eq flag nil)
  13330. ;; try completion
  13331. (setq rtn (try-completion s2 ctable confirm))
  13332. (if (stringp rtn)
  13333. (setq rtn
  13334. (concat s1 s2 (substring rtn (length s2))
  13335. (if (and org-add-colon-after-tag-completion
  13336. (assoc rtn ctable))
  13337. ":" ""))))
  13338. rtn)
  13339. ((eq flag t)
  13340. ;; all-completions
  13341. (all-completions s2 ctable confirm))
  13342. ((eq flag 'lambda)
  13343. ;; exact match?
  13344. (assoc s2 ctable)))))
  13345. (defun org-fast-tag-insert (kwd tags face &optional end)
  13346. "Insert KDW, and the TAGS, the latter with face FACE.
  13347. Also insert END."
  13348. (insert (format "%-12s" (concat kwd ":"))
  13349. (org-add-props (mapconcat 'identity tags " ") nil 'face face)
  13350. (or end "")))
  13351. (defun org-fast-tag-show-exit (flag)
  13352. (save-excursion
  13353. (org-goto-line 3)
  13354. (if (re-search-forward "[ \t]+Next change exits" (point-at-eol) t)
  13355. (replace-match ""))
  13356. (when flag
  13357. (end-of-line 1)
  13358. (org-move-to-column (- (window-width) 19) t)
  13359. (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
  13360. (defun org-set-current-tags-overlay (current prefix)
  13361. "Add an overlay to CURRENT tag with PREFIX."
  13362. (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
  13363. (if (featurep 'xemacs)
  13364. (org-overlay-display org-tags-overlay (concat prefix s)
  13365. 'secondary-selection)
  13366. (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
  13367. (org-overlay-display org-tags-overlay (concat prefix s)))))
  13368. (defvar org-last-tag-selection-key nil)
  13369. (defun org-fast-tag-selection (current inherited table &optional todo-table)
  13370. "Fast tag selection with single keys.
  13371. CURRENT is the current list of tags in the headline, INHERITED is the
  13372. list of inherited tags, and TABLE is an alist of tags and corresponding keys,
  13373. possibly with grouping information. TODO-TABLE is a similar table with
  13374. TODO keywords, should these have keys assigned to them.
  13375. If the keys are nil, a-z are automatically assigned.
  13376. Returns the new tags string, or nil to not change the current settings."
  13377. (let* ((fulltable (append table todo-table))
  13378. (maxlen (apply 'max (mapcar
  13379. (lambda (x)
  13380. (if (stringp (car x)) (string-width (car x)) 0))
  13381. fulltable)))
  13382. (buf (current-buffer))
  13383. (expert (eq org-fast-tag-selection-single-key 'expert))
  13384. (buffer-tags nil)
  13385. (fwidth (+ maxlen 3 1 3))
  13386. (ncol (/ (- (window-width) 4) fwidth))
  13387. (i-face 'org-done)
  13388. (c-face 'org-todo)
  13389. tg cnt e c char c1 c2 ntable tbl rtn
  13390. ov-start ov-end ov-prefix
  13391. (exit-after-next org-fast-tag-selection-single-key)
  13392. (done-keywords org-done-keywords)
  13393. groups ingroup)
  13394. (save-excursion
  13395. (beginning-of-line 1)
  13396. (if (looking-at
  13397. (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
  13398. (setq ov-start (match-beginning 1)
  13399. ov-end (match-end 1)
  13400. ov-prefix "")
  13401. (setq ov-start (1- (point-at-eol))
  13402. ov-end (1+ ov-start))
  13403. (skip-chars-forward "^\n\r")
  13404. (setq ov-prefix
  13405. (concat
  13406. (buffer-substring (1- (point)) (point))
  13407. (if (> (current-column) org-tags-column)
  13408. " "
  13409. (make-string (- org-tags-column (current-column)) ?\ ))))))
  13410. (move-overlay org-tags-overlay ov-start ov-end)
  13411. (save-window-excursion
  13412. (if expert
  13413. (set-buffer (get-buffer-create " *Org tags*"))
  13414. (delete-other-windows)
  13415. (split-window-vertically)
  13416. (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
  13417. (erase-buffer)
  13418. (org-set-local 'org-done-keywords done-keywords)
  13419. (org-fast-tag-insert "Inherited" inherited i-face "\n")
  13420. (org-fast-tag-insert "Current" current c-face "\n\n")
  13421. (org-fast-tag-show-exit exit-after-next)
  13422. (org-set-current-tags-overlay current ov-prefix)
  13423. (setq tbl fulltable char ?a cnt 0)
  13424. (while (setq e (pop tbl))
  13425. (cond
  13426. ((equal (car e) :startgroup)
  13427. (push '() groups) (setq ingroup t)
  13428. (when (not (= cnt 0))
  13429. (setq cnt 0)
  13430. (insert "\n"))
  13431. (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
  13432. ((equal (car e) :endgroup)
  13433. (setq ingroup nil cnt 0)
  13434. (insert "}" (if (cdr e) (format " (%s) " (cdr e)) "") "\n"))
  13435. ((equal e '(:newline))
  13436. (when (not (= cnt 0))
  13437. (setq cnt 0)
  13438. (insert "\n")
  13439. (setq e (car tbl))
  13440. (while (equal (car tbl) '(:newline))
  13441. (insert "\n")
  13442. (setq tbl (cdr tbl)))))
  13443. ((equal e '(:grouptags)) nil)
  13444. (t
  13445. (setq tg (copy-sequence (car e)) c2 nil)
  13446. (if (cdr e)
  13447. (setq c (cdr e))
  13448. ;; automatically assign a character.
  13449. (setq c1 (string-to-char
  13450. (downcase (substring
  13451. tg (if (= (string-to-char tg) ?@) 1 0)))))
  13452. (if (or (rassoc c1 ntable) (rassoc c1 table))
  13453. (while (or (rassoc char ntable) (rassoc char table))
  13454. (setq char (1+ char)))
  13455. (setq c2 c1))
  13456. (setq c (or c2 char)))
  13457. (if ingroup (push tg (car groups)))
  13458. (setq tg (org-add-props tg nil 'face
  13459. (cond
  13460. ((not (assoc tg table))
  13461. (org-get-todo-face tg))
  13462. ((member tg current) c-face)
  13463. ((member tg inherited) i-face))))
  13464. (if (equal (caar tbl) :grouptags)
  13465. (org-add-props tg nil 'face 'org-tag-group))
  13466. (if (and (= cnt 0) (not ingroup)) (insert " "))
  13467. (insert "[" c "] " tg (make-string
  13468. (- fwidth 4 (length tg)) ?\ ))
  13469. (push (cons tg c) ntable)
  13470. (when (= (setq cnt (1+ cnt)) ncol)
  13471. (insert "\n")
  13472. (if ingroup (insert " "))
  13473. (setq cnt 0)))))
  13474. (setq ntable (nreverse ntable))
  13475. (insert "\n")
  13476. (goto-char (point-min))
  13477. (if (not expert) (org-fit-window-to-buffer))
  13478. (setq rtn
  13479. (catch 'exit
  13480. (while t
  13481. (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
  13482. (if (not groups) "no " "")
  13483. (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
  13484. (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
  13485. (setq org-last-tag-selection-key c)
  13486. (cond
  13487. ((= c ?\r) (throw 'exit t))
  13488. ((= c ?!)
  13489. (setq groups (not groups))
  13490. (goto-char (point-min))
  13491. (while (re-search-forward "[{}]" nil t) (replace-match " ")))
  13492. ((= c ?\C-c)
  13493. (if (not expert)
  13494. (org-fast-tag-show-exit
  13495. (setq exit-after-next (not exit-after-next)))
  13496. (setq expert nil)
  13497. (delete-other-windows)
  13498. (set-window-buffer (split-window-vertically) " *Org tags*")
  13499. (org-switch-to-buffer-other-window " *Org tags*")
  13500. (org-fit-window-to-buffer)))
  13501. ((or (= c ?\C-g)
  13502. (and (= c ?q) (not (rassoc c ntable))))
  13503. (org-detach-overlay org-tags-overlay)
  13504. (setq quit-flag t))
  13505. ((= c ?\ )
  13506. (setq current nil)
  13507. (if exit-after-next (setq exit-after-next 'now)))
  13508. ((= c ?\t)
  13509. (condition-case nil
  13510. (setq tg (org-icompleting-read
  13511. "Tag: "
  13512. (or buffer-tags
  13513. (with-current-buffer buf
  13514. (org-get-buffer-tags)))))
  13515. (quit (setq tg "")))
  13516. (when (string-match "\\S-" tg)
  13517. (add-to-list 'buffer-tags (list tg))
  13518. (if (member tg current)
  13519. (setq current (delete tg current))
  13520. (push tg current)))
  13521. (if exit-after-next (setq exit-after-next 'now)))
  13522. ((setq e (rassoc c todo-table) tg (car e))
  13523. (with-current-buffer buf
  13524. (save-excursion (org-todo tg)))
  13525. (if exit-after-next (setq exit-after-next 'now)))
  13526. ((setq e (rassoc c ntable) tg (car e))
  13527. (if (member tg current)
  13528. (setq current (delete tg current))
  13529. (loop for g in groups do
  13530. (if (member tg g)
  13531. (mapc (lambda (x)
  13532. (setq current (delete x current)))
  13533. g)))
  13534. (push tg current))
  13535. (if exit-after-next (setq exit-after-next 'now))))
  13536. ;; Create a sorted list
  13537. (setq current
  13538. (sort current
  13539. (lambda (a b)
  13540. (assoc b (cdr (memq (assoc a ntable) ntable))))))
  13541. (if (eq exit-after-next 'now) (throw 'exit t))
  13542. (goto-char (point-min))
  13543. (beginning-of-line 2)
  13544. (delete-region (point) (point-at-eol))
  13545. (org-fast-tag-insert "Current" current c-face)
  13546. (org-set-current-tags-overlay current ov-prefix)
  13547. (while (re-search-forward
  13548. (org-re "\\[.\\] \\([[:alnum:]_@#%]+\\)") nil t)
  13549. (setq tg (match-string 1))
  13550. (add-text-properties
  13551. (match-beginning 1) (match-end 1)
  13552. (list 'face
  13553. (cond
  13554. ((member tg current) c-face)
  13555. ((member tg inherited) i-face)
  13556. (t (get-text-property (match-beginning 1) 'face))))))
  13557. (goto-char (point-min)))))
  13558. (org-detach-overlay org-tags-overlay)
  13559. (if rtn
  13560. (mapconcat 'identity current ":")
  13561. nil))))
  13562. (defun org-get-tags-string ()
  13563. "Get the TAGS string in the current headline."
  13564. (unless (org-at-heading-p t)
  13565. (user-error "Not on a heading"))
  13566. (save-excursion
  13567. (beginning-of-line 1)
  13568. (if (looking-at (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
  13569. (org-match-string-no-properties 1)
  13570. "")))
  13571. (defun org-get-tags ()
  13572. "Get the list of tags specified in the current headline."
  13573. (org-split-string (org-get-tags-string) ":"))
  13574. (defun org-get-buffer-tags ()
  13575. "Get a table of all tags used in the buffer, for completion."
  13576. (let (tags)
  13577. (save-excursion
  13578. (goto-char (point-min))
  13579. (while (re-search-forward
  13580. (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t\r\n]") nil t)
  13581. (when (equal (char-after (point-at-bol 0)) ?*)
  13582. (mapc (lambda (x) (add-to-list 'tags x))
  13583. (org-split-string (org-match-string-no-properties 1) ":")))))
  13584. (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
  13585. (mapcar 'list tags)))
  13586. ;;;; The mapping API
  13587. (defun org-map-entries (func &optional match scope &rest skip)
  13588. "Call FUNC at each headline selected by MATCH in SCOPE.
  13589. FUNC is a function or a lisp form. The function will be called without
  13590. arguments, with the cursor positioned at the beginning of the headline.
  13591. The return values of all calls to the function will be collected and
  13592. returned as a list.
  13593. The call to FUNC will be wrapped into a save-excursion form, so FUNC
  13594. does not need to preserve point. After evaluation, the cursor will be
  13595. moved to the end of the line (presumably of the headline of the
  13596. processed entry) and search continues from there. Under some
  13597. circumstances, this may not produce the wanted results. For example,
  13598. if you have removed (e.g. archived) the current (sub)tree it could
  13599. mean that the next entry will be skipped entirely. In such cases, you
  13600. can specify the position from where search should continue by making
  13601. FUNC set the variable `org-map-continue-from' to the desired buffer
  13602. position.
  13603. MATCH is a tags/property/todo match as it is used in the agenda tags view.
  13604. Only headlines that are matched by this query will be considered during
  13605. the iteration. When MATCH is nil or t, all headlines will be
  13606. visited by the iteration.
  13607. SCOPE determines the scope of this command. It can be any of:
  13608. nil The current buffer, respecting the restriction if any
  13609. tree The subtree started with the entry at point
  13610. region The entries within the active region, if any
  13611. region-start-level
  13612. The entries within the active region, but only those at
  13613. the same level than the first one.
  13614. file The current buffer, without restriction
  13615. file-with-archives
  13616. The current buffer, and any archives associated with it
  13617. agenda All agenda files
  13618. agenda-with-archives
  13619. All agenda files with any archive files associated with them
  13620. \(file1 file2 ...)
  13621. If this is a list, all files in the list will be scanned
  13622. The remaining args are treated as settings for the skipping facilities of
  13623. the scanner. The following items can be given here:
  13624. archive skip trees with the archive tag
  13625. comment skip trees with the COMMENT keyword
  13626. function or Emacs Lisp form:
  13627. will be used as value for `org-agenda-skip-function', so
  13628. whenever the function returns a position, FUNC will not be
  13629. called for that entry and search will continue from the
  13630. position returned
  13631. If your function needs to retrieve the tags including inherited tags
  13632. at the *current* entry, you can use the value of the variable
  13633. `org-scanner-tags' which will be much faster than getting the value
  13634. with `org-get-tags-at'. If your function gets properties with
  13635. `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
  13636. to t around the call to `org-entry-properties' to get the same speedup.
  13637. Note that if your function moves around to retrieve tags and properties at
  13638. a *different* entry, you cannot use these techniques."
  13639. (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
  13640. (not (org-region-active-p)))
  13641. (let* ((org-agenda-archives-mode nil) ; just to make sure
  13642. (org-agenda-skip-archived-trees (memq 'archive skip))
  13643. (org-agenda-skip-comment-trees (memq 'comment skip))
  13644. (org-agenda-skip-function
  13645. (car (org-delete-all '(comment archive) skip)))
  13646. (org-tags-match-list-sublevels t)
  13647. (start-level (eq scope 'region-start-level))
  13648. matcher file res
  13649. org-todo-keywords-for-agenda
  13650. org-done-keywords-for-agenda
  13651. org-todo-keyword-alist-for-agenda
  13652. org-drawers-for-agenda
  13653. org-tag-alist-for-agenda
  13654. todo-only)
  13655. (cond
  13656. ((eq match t) (setq matcher t))
  13657. ((eq match nil) (setq matcher t))
  13658. (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
  13659. (save-window-excursion
  13660. (save-restriction
  13661. (cond ((eq scope 'tree)
  13662. (org-back-to-heading t)
  13663. (org-narrow-to-subtree)
  13664. (setq scope nil))
  13665. ((and (or (eq scope 'region) (eq scope 'region-start-level))
  13666. (org-region-active-p))
  13667. ;; If needed, set start-level to a string like "2"
  13668. (when start-level
  13669. (save-excursion
  13670. (goto-char (region-beginning))
  13671. (unless (org-at-heading-p) (outline-next-heading))
  13672. (setq start-level (org-current-level))))
  13673. (narrow-to-region (region-beginning)
  13674. (save-excursion
  13675. (goto-char (region-end))
  13676. (unless (and (bolp) (org-at-heading-p))
  13677. (outline-next-heading))
  13678. (point)))
  13679. (setq scope nil)))
  13680. (if (not scope)
  13681. (progn
  13682. (org-agenda-prepare-buffers
  13683. (list (buffer-file-name (current-buffer))))
  13684. (setq res (org-scan-tags func matcher todo-only start-level)))
  13685. ;; Get the right scope
  13686. (cond
  13687. ((and scope (listp scope) (symbolp (car scope)))
  13688. (setq scope (eval scope)))
  13689. ((eq scope 'agenda)
  13690. (setq scope (org-agenda-files t)))
  13691. ((eq scope 'agenda-with-archives)
  13692. (setq scope (org-agenda-files t))
  13693. (setq scope (org-add-archive-files scope)))
  13694. ((eq scope 'file)
  13695. (setq scope (list (buffer-file-name))))
  13696. ((eq scope 'file-with-archives)
  13697. (setq scope (org-add-archive-files (list (buffer-file-name))))))
  13698. (org-agenda-prepare-buffers scope)
  13699. (while (setq file (pop scope))
  13700. (with-current-buffer (org-find-base-buffer-visiting file)
  13701. (save-excursion
  13702. (save-restriction
  13703. (widen)
  13704. (goto-char (point-min))
  13705. (setq res (append res (org-scan-tags func matcher todo-only))))))))))
  13706. res)))
  13707. ;;;; Properties
  13708. ;;; Setting and retrieving properties
  13709. (defconst org-special-properties
  13710. '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
  13711. "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM" "CLOCKSUM_T")
  13712. "The special properties valid in Org-mode.
  13713. These are properties that are not defined in the property drawer,
  13714. but in some other way.")
  13715. (defconst org-default-properties
  13716. '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
  13717. "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
  13718. "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
  13719. "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
  13720. "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
  13721. "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
  13722. "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
  13723. "Some properties that are used by Org-mode for various purposes.
  13724. Being in this list makes sure that they are offered for completion.")
  13725. (defconst org-property-start-re "^[ \t]*:PROPERTIES:[ \t]*$"
  13726. "Regular expression matching the first line of a property drawer.")
  13727. (defconst org-property-end-re "^[ \t]*:END:[ \t]*$"
  13728. "Regular expression matching the last line of a property drawer.")
  13729. (defconst org-clock-drawer-start-re "^[ \t]*:CLOCK:[ \t]*$"
  13730. "Regular expression matching the first line of a property drawer.")
  13731. (defconst org-clock-drawer-end-re "^[ \t]*:END:[ \t]*$"
  13732. "Regular expression matching the first line of a property drawer.")
  13733. (defconst org-property-drawer-re
  13734. (concat "\\(" org-property-start-re "\\)[^\000]*\\("
  13735. org-property-end-re "\\)\n?")
  13736. "Matches an entire property drawer.")
  13737. (defconst org-clock-drawer-re
  13738. (concat "\\(" org-clock-drawer-start-re "\\)[^\000]*\\("
  13739. org-property-end-re "\\)\n?")
  13740. "Matches an entire clock drawer.")
  13741. (defun org-property-action ()
  13742. "Do an action on properties."
  13743. (interactive)
  13744. (let (c)
  13745. (org-at-property-p)
  13746. (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
  13747. (setq c (read-char-exclusive))
  13748. (cond
  13749. ((equal c ?s)
  13750. (call-interactively 'org-set-property))
  13751. ((equal c ?d)
  13752. (call-interactively 'org-delete-property))
  13753. ((equal c ?D)
  13754. (call-interactively 'org-delete-property-globally))
  13755. ((equal c ?c)
  13756. (call-interactively 'org-compute-property-at-point))
  13757. (t (user-error "No such property action %c" c)))))
  13758. (defun org-inc-effort ()
  13759. "Increment the value of the effort property in the current entry."
  13760. (interactive)
  13761. (org-set-effort nil t))
  13762. (defvar org-clock-effort) ;; Defined in org-clock.el
  13763. (defvar org-clock-current-task) ;; Defined in org-clock.el
  13764. (defun org-set-effort (&optional value increment)
  13765. "Set the effort property of the current entry.
  13766. With numerical prefix arg, use the nth allowed value, 0 stands for the
  13767. 10th allowed value.
  13768. When INCREMENT is non-nil, set the property to the next allowed value."
  13769. (interactive "P")
  13770. (if (equal value 0) (setq value 10))
  13771. (let* ((completion-ignore-case t)
  13772. (prop org-effort-property)
  13773. (cur (org-entry-get nil prop))
  13774. (allowed (org-property-get-allowed-values nil prop 'table))
  13775. (existing (mapcar 'list (org-property-values prop)))
  13776. (heading (nth 4 (org-heading-components)))
  13777. rpl
  13778. (val (cond
  13779. ((stringp value) value)
  13780. ((and allowed (integerp value))
  13781. (or (car (nth (1- value) allowed))
  13782. (car (org-last allowed))))
  13783. ((and allowed increment)
  13784. (or (caadr (member (list cur) allowed))
  13785. (user-error "Allowed effort values are not set")))
  13786. (allowed
  13787. (message "Select 1-9,0, [RET%s]: %s"
  13788. (if cur (concat "=" cur) "")
  13789. (mapconcat 'car allowed " "))
  13790. (setq rpl (read-char-exclusive))
  13791. (if (equal rpl ?\r)
  13792. cur
  13793. (setq rpl (- rpl ?0))
  13794. (if (equal rpl 0) (setq rpl 10))
  13795. (if (and (> rpl 0) (<= rpl (length allowed)))
  13796. (car (nth (1- rpl) allowed))
  13797. (org-completing-read "Effort: " allowed nil))))
  13798. (t
  13799. (let (org-completion-use-ido org-completion-use-iswitchb)
  13800. (org-completing-read
  13801. (concat "Effort " (if (and cur (string-match "\\S-" cur))
  13802. (concat "[" cur "]") "")
  13803. ": ")
  13804. existing nil nil "" nil cur))))))
  13805. (unless (equal (org-entry-get nil prop) val)
  13806. (org-entry-put nil prop val))
  13807. (save-excursion
  13808. (org-back-to-heading t)
  13809. (put-text-property (point-at-bol) (point-at-eol) 'org-effort val))
  13810. (when (string= heading org-clock-current-task)
  13811. (setq org-clock-effort (get-text-property (point-at-bol) 'org-effort))
  13812. (org-clock-update-mode-line))
  13813. (message "%s is now %s" prop val)))
  13814. (defun org-at-property-p ()
  13815. "Is cursor inside a property drawer?"
  13816. (save-excursion
  13817. (when (equal 'node-property (car (org-element-at-point)))
  13818. (beginning-of-line 1)
  13819. (looking-at org-property-re))))
  13820. (defun org-get-property-block (&optional beg end force)
  13821. "Return the (beg . end) range of the body of the property drawer.
  13822. BEG and END are the beginning and end of the current subtree, or of
  13823. the part before the first headline. If they are not given, they will
  13824. be found. If the drawer does not exist and FORCE is non-nil, create
  13825. the drawer."
  13826. (catch 'exit
  13827. (save-excursion
  13828. (let* ((beg (or beg (and (org-before-first-heading-p) (point-min))
  13829. (progn (org-back-to-heading t) (point))))
  13830. (end (or end (and (not (outline-next-heading)) (point-max))
  13831. (point))))
  13832. (goto-char beg)
  13833. (if (re-search-forward org-property-start-re end t)
  13834. (setq beg (1+ (match-end 0)))
  13835. (if force
  13836. (save-excursion
  13837. (org-insert-property-drawer)
  13838. (setq end (progn (outline-next-heading) (point))))
  13839. (throw 'exit nil))
  13840. (goto-char beg)
  13841. (if (re-search-forward org-property-start-re end t)
  13842. (setq beg (1+ (match-end 0)))))
  13843. (if (re-search-forward org-property-end-re end t)
  13844. (setq end (match-beginning 0))
  13845. (or force (throw 'exit nil))
  13846. (goto-char beg)
  13847. (setq end beg)
  13848. (org-indent-line)
  13849. (insert ":END:\n"))
  13850. (cons beg end)))))
  13851. (defun org-entry-properties (&optional pom which specific)
  13852. "Get all properties of the entry at point-or-marker POM.
  13853. This includes the TODO keyword, the tags, time strings for deadline,
  13854. scheduled, and clocking, and any additional properties defined in the
  13855. entry. The return value is an alist, keys may occur multiple times
  13856. if the property key was used several times.
  13857. POM may also be nil, in which case the current entry is used.
  13858. If WHICH is nil or `all', get all properties. If WHICH is
  13859. `special' or `standard', only get that subclass. If WHICH
  13860. is a string only get exactly this property. SPECIFIC can be a string, the
  13861. specific property we are interested in. Specifying it can speed
  13862. things up because then unnecessary parsing is avoided."
  13863. (setq which (or which 'all))
  13864. (org-with-point-at pom
  13865. (let ((clockstr (substring org-clock-string 0 -1))
  13866. (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
  13867. (case-fold-search nil)
  13868. beg end range props sum-props key key1 value string clocksum clocksumt)
  13869. (save-excursion
  13870. (when (condition-case nil
  13871. (and (derived-mode-p 'org-mode) (org-back-to-heading t))
  13872. (error nil))
  13873. (setq beg (point))
  13874. (setq sum-props (get-text-property (point) 'org-summaries))
  13875. (setq clocksum (get-text-property (point) :org-clock-minutes)
  13876. clocksumt (get-text-property (point) :org-clock-minutes-today))
  13877. (outline-next-heading)
  13878. (setq end (point))
  13879. (when (memq which '(all special))
  13880. ;; Get the special properties, like TODO and tags
  13881. (goto-char beg)
  13882. (when (and (or (not specific) (string= specific "TODO"))
  13883. (looking-at org-todo-line-regexp) (match-end 2))
  13884. (push (cons "TODO" (org-match-string-no-properties 2)) props))
  13885. (when (and (or (not specific) (string= specific "PRIORITY"))
  13886. (looking-at org-priority-regexp))
  13887. (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
  13888. (when (or (not specific) (string= specific "FILE"))
  13889. (push (cons "FILE" buffer-file-name) props))
  13890. (when (and (or (not specific) (string= specific "TAGS"))
  13891. (setq value (org-get-tags-string))
  13892. (string-match "\\S-" value))
  13893. (push (cons "TAGS" value) props))
  13894. (when (and (or (not specific) (string= specific "ALLTAGS"))
  13895. (setq value (org-get-tags-at)))
  13896. (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
  13897. ":"))
  13898. props))
  13899. (when (or (not specific) (string= specific "BLOCKED"))
  13900. (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
  13901. (when (or (not specific)
  13902. (member specific
  13903. '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
  13904. "TIMESTAMP" "TIMESTAMP_IA")))
  13905. (catch 'match
  13906. (while (re-search-forward org-maybe-keyword-time-regexp end t)
  13907. (setq key (if (match-end 1)
  13908. (substring (org-match-string-no-properties 1)
  13909. 0 -1))
  13910. string (if (equal key clockstr)
  13911. (org-trim
  13912. (buffer-substring-no-properties
  13913. (match-beginning 3) (goto-char
  13914. (point-at-eol))))
  13915. (substring (org-match-string-no-properties 3)
  13916. 1 -1)))
  13917. ;; Get the correct property name from the key. This is
  13918. ;; necessary if the user has configured time keywords.
  13919. (setq key1 (concat key ":"))
  13920. (cond
  13921. ((not key)
  13922. (setq key
  13923. (if (= (char-after (match-beginning 3)) ?\[)
  13924. "TIMESTAMP_IA" "TIMESTAMP")))
  13925. ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
  13926. ((equal key1 org-deadline-string) (setq key "DEADLINE"))
  13927. ((equal key1 org-closed-string) (setq key "CLOSED"))
  13928. ((equal key1 org-clock-string) (setq key "CLOCK")))
  13929. (if (and specific (equal key specific) (not (equal key "CLOCK")))
  13930. (progn
  13931. (push (cons key string) props)
  13932. ;; no need to search further if match is found
  13933. (throw 'match t))
  13934. (when (or (equal key "CLOCK") (not (assoc key props)))
  13935. (push (cons key string) props)))))))
  13936. (when (memq which '(all standard))
  13937. ;; Get the standard properties, like :PROP: ...
  13938. (setq range (org-get-property-block beg end))
  13939. (when range
  13940. (goto-char (car range))
  13941. (while (re-search-forward org-property-re
  13942. (cdr range) t)
  13943. (setq key (org-match-string-no-properties 2)
  13944. value (org-trim (or (org-match-string-no-properties 3) "")))
  13945. (unless (member key excluded)
  13946. (push (cons key (or value "")) props)))))
  13947. (if clocksum
  13948. (push (cons "CLOCKSUM"
  13949. (org-columns-number-to-string (/ (float clocksum) 60.)
  13950. 'add_times))
  13951. props))
  13952. (if clocksumt
  13953. (push (cons "CLOCKSUM_T"
  13954. (org-columns-number-to-string (/ (float clocksumt) 60.)
  13955. 'add_times))
  13956. props))
  13957. (unless (assoc "CATEGORY" props)
  13958. (push (cons "CATEGORY" (org-get-category)) props))
  13959. (append sum-props (nreverse props)))))))
  13960. (defun org-entry-get (pom property &optional inherit literal-nil)
  13961. "Get value of PROPERTY for entry or content at point-or-marker POM.
  13962. If INHERIT is non-nil and the entry does not have the property,
  13963. then also check higher levels of the hierarchy.
  13964. If INHERIT is the symbol `selective', use inheritance only if the setting
  13965. in `org-use-property-inheritance' selects PROPERTY for inheritance.
  13966. If the property is present but empty, the return value is the empty string.
  13967. If the property is not present at all, nil is returned.
  13968. If LITERAL-NIL is set, return the string value \"nil\" as a string,
  13969. do not interpret it as the list atom nil. This is used for inheritance
  13970. when a \"nil\" value can supersede a non-nil value higher up the hierarchy."
  13971. (org-with-point-at pom
  13972. (if (and inherit (if (eq inherit 'selective)
  13973. (org-property-inherit-p property)
  13974. t))
  13975. (org-entry-get-with-inheritance property literal-nil)
  13976. (if (member property org-special-properties)
  13977. ;; We need a special property. Use `org-entry-properties' to
  13978. ;; retrieve it, but specify the wanted property
  13979. (cdr (assoc property (org-entry-properties nil 'special property)))
  13980. (let ((range (org-get-property-block)))
  13981. (when (and range (not (eq (car range) (cdr range))))
  13982. (let* ((props (list (or (assoc property org-file-properties)
  13983. (assoc property org-global-properties)
  13984. (assoc property org-global-properties-fixed))))
  13985. (ap (lambda (key)
  13986. (when (re-search-forward
  13987. (org-re-property key) (cdr range) t)
  13988. (setq props
  13989. (org-update-property-plist
  13990. key
  13991. (if (match-end 3)
  13992. (org-match-string-no-properties 3) "")
  13993. props)))))
  13994. val)
  13995. (goto-char (car range))
  13996. (funcall ap property)
  13997. (goto-char (car range))
  13998. (while (funcall ap (concat property "+")))
  13999. (setq val (cdr (assoc property props)))
  14000. (when val (if literal-nil val (org-not-nil val))))))))))
  14001. (defun org-property-or-variable-value (var &optional inherit)
  14002. "Check if there is a property fixing the value of VAR.
  14003. If yes, return this value. If not, return the current value of the variable."
  14004. (let ((prop (org-entry-get nil (symbol-name var) inherit)))
  14005. (if (and prop (stringp prop) (string-match "\\S-" prop))
  14006. (read prop)
  14007. (symbol-value var))))
  14008. (defun org-entry-delete (pom property &optional delete-empty-drawer)
  14009. "Delete the property PROPERTY from entry at point-or-marker POM.
  14010. When optional argument DELETE-EMPTY-DRAWER is a string, it defines
  14011. an empty drawer to delete."
  14012. (org-with-point-at pom
  14013. (if (member property org-special-properties)
  14014. nil ; cannot delete these properties.
  14015. (let ((range (org-get-property-block)))
  14016. (if (and range
  14017. (goto-char (car range))
  14018. (re-search-forward
  14019. (org-re-property property)
  14020. (cdr range) t))
  14021. (progn
  14022. (delete-region (match-beginning 0) (1+ (point-at-eol)))
  14023. (and delete-empty-drawer
  14024. (org-remove-empty-drawer-at
  14025. delete-empty-drawer (car range)))
  14026. t)
  14027. nil)))))
  14028. ;; Multi-values properties are properties that contain multiple values
  14029. ;; These values are assumed to be single words, separated by whitespace.
  14030. (defun org-entry-add-to-multivalued-property (pom property value)
  14031. "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
  14032. (let* ((old (org-entry-get pom property))
  14033. (values (and old (org-split-string old "[ \t]"))))
  14034. (setq value (org-entry-protect-space value))
  14035. (unless (member value values)
  14036. (setq values (append values (list value)))
  14037. (org-entry-put pom property
  14038. (mapconcat 'identity values " ")))))
  14039. (defun org-entry-remove-from-multivalued-property (pom property value)
  14040. "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
  14041. (let* ((old (org-entry-get pom property))
  14042. (values (and old (org-split-string old "[ \t]"))))
  14043. (setq value (org-entry-protect-space value))
  14044. (when (member value values)
  14045. (setq values (delete value values))
  14046. (org-entry-put pom property
  14047. (mapconcat 'identity values " ")))))
  14048. (defun org-entry-member-in-multivalued-property (pom property value)
  14049. "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
  14050. (let* ((old (org-entry-get pom property))
  14051. (values (and old (org-split-string old "[ \t]"))))
  14052. (setq value (org-entry-protect-space value))
  14053. (member value values)))
  14054. (defun org-entry-get-multivalued-property (pom property)
  14055. "Return a list of values in a multivalued property."
  14056. (let* ((value (org-entry-get pom property))
  14057. (values (and value (org-split-string value "[ \t]"))))
  14058. (mapcar 'org-entry-restore-space values)))
  14059. (defun org-entry-put-multivalued-property (pom property &rest values)
  14060. "Set multivalued PROPERTY at point-or-marker POM to VALUES.
  14061. VALUES should be a list of strings. Spaces will be protected."
  14062. (org-entry-put pom property
  14063. (mapconcat 'org-entry-protect-space values " "))
  14064. (let* ((value (org-entry-get pom property))
  14065. (values (and value (org-split-string value "[ \t]"))))
  14066. (mapcar 'org-entry-restore-space values)))
  14067. (defun org-entry-protect-space (s)
  14068. "Protect spaces and newline in string S."
  14069. (while (string-match " " s)
  14070. (setq s (replace-match "%20" t t s)))
  14071. (while (string-match "\n" s)
  14072. (setq s (replace-match "%0A" t t s)))
  14073. s)
  14074. (defun org-entry-restore-space (s)
  14075. "Restore spaces and newline in string S."
  14076. (while (string-match "%20" s)
  14077. (setq s (replace-match " " t t s)))
  14078. (while (string-match "%0A" s)
  14079. (setq s (replace-match "\n" t t s)))
  14080. s)
  14081. (defvar org-entry-property-inherited-from (make-marker)
  14082. "Marker pointing to the entry from where a property was inherited.
  14083. Each call to `org-entry-get-with-inheritance' will set this marker to the
  14084. location of the entry where the inheritance search matched. If there was
  14085. no match, the marker will point nowhere.
  14086. Note that also `org-entry-get' calls this function, if the INHERIT flag
  14087. is set.")
  14088. (defun org-entry-get-with-inheritance (property &optional literal-nil)
  14089. "Get PROPERTY of entry or content at point, search higher levels if needed.
  14090. The search will stop at the first ancestor which has the property defined.
  14091. If the value found is \"nil\", return nil to show that the property
  14092. should be considered as undefined (this is the meaning of nil here).
  14093. However, if LITERAL-NIL is set, return the string value \"nil\" instead."
  14094. (move-marker org-entry-property-inherited-from nil)
  14095. (let (tmp)
  14096. (save-excursion
  14097. (save-restriction
  14098. (widen)
  14099. (catch 'ex
  14100. (while t
  14101. (when (setq tmp (org-entry-get nil property nil 'literal-nil))
  14102. (or (ignore-errors (org-back-to-heading t))
  14103. (goto-char (point-min)))
  14104. (move-marker org-entry-property-inherited-from (point))
  14105. (throw 'ex tmp))
  14106. (or (ignore-errors (org-up-heading-safe))
  14107. (throw 'ex nil))))))
  14108. (setq tmp (or tmp
  14109. (cdr (assoc property org-file-properties))
  14110. (cdr (assoc property org-global-properties))
  14111. (cdr (assoc property org-global-properties-fixed))))
  14112. (if literal-nil tmp (org-not-nil tmp))))
  14113. (defvar org-property-changed-functions nil
  14114. "Hook called when the value of a property has changed.
  14115. Each hook function should accept two arguments, the name of the property
  14116. and the new value.")
  14117. (defun org-entry-put (pom property value)
  14118. "Set PROPERTY to VALUE for entry at point-or-marker POM."
  14119. (org-with-point-at pom
  14120. (org-back-to-heading t)
  14121. (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
  14122. range)
  14123. (cond
  14124. ((equal property "TODO")
  14125. (when (and (stringp value) (string-match "\\S-" value)
  14126. (not (member value org-todo-keywords-1)))
  14127. (user-error "\"%s\" is not a valid TODO state" value))
  14128. (if (or (not value)
  14129. (not (string-match "\\S-" value)))
  14130. (setq value 'none))
  14131. (org-todo value)
  14132. (org-set-tags nil 'align))
  14133. ((equal property "PRIORITY")
  14134. (org-priority (if (and value (stringp value) (string-match "\\S-" value))
  14135. (string-to-char value) ?\ ))
  14136. (org-set-tags nil 'align))
  14137. ((equal property "CLOCKSUM")
  14138. (if (not (re-search-forward
  14139. (concat org-clock-string ".*\\]--\\(\\[[^]]+\\]\\)") nil t))
  14140. (error "Cannot find a clock log")
  14141. (goto-char (- (match-end 1) 2))
  14142. (cond
  14143. ((eq value 'earlier) (org-timestamp-down))
  14144. ((eq value 'later) (org-timestamp-up)))
  14145. (org-clock-sum-current-item)))
  14146. ((equal property "SCHEDULED")
  14147. (if (re-search-forward org-scheduled-time-regexp end t)
  14148. (cond
  14149. ((eq value 'earlier) (org-timestamp-change -1 'day))
  14150. ((eq value 'later) (org-timestamp-change 1 'day))
  14151. (t (call-interactively 'org-schedule)))
  14152. (call-interactively 'org-schedule)))
  14153. ((equal property "DEADLINE")
  14154. (if (re-search-forward org-deadline-time-regexp end t)
  14155. (cond
  14156. ((eq value 'earlier) (org-timestamp-change -1 'day))
  14157. ((eq value 'later) (org-timestamp-change 1 'day))
  14158. (t (call-interactively 'org-deadline)))
  14159. (call-interactively 'org-deadline)))
  14160. ((member property org-special-properties)
  14161. (error "The %s property can not yet be set with `org-entry-put'"
  14162. property))
  14163. (t ; a non-special property
  14164. (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
  14165. (setq range (org-get-property-block beg end 'force))
  14166. (goto-char (car range))
  14167. (if (re-search-forward
  14168. (org-re-property property) (cdr range) t)
  14169. (progn
  14170. (delete-region (match-beginning 0) (match-end 0))
  14171. (goto-char (match-beginning 0)))
  14172. (goto-char (cdr range))
  14173. (insert "\n")
  14174. (backward-char 1)
  14175. (org-indent-line))
  14176. (insert ":" property ":")
  14177. (and value (insert " " value))
  14178. (org-indent-line)))))
  14179. (run-hook-with-args 'org-property-changed-functions property value)))
  14180. (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
  14181. "Get all property keys in the current buffer.
  14182. With INCLUDE-SPECIALS, also list the special properties that reflect things
  14183. like tags and TODO state.
  14184. With INCLUDE-DEFAULTS, also include properties that has special meaning
  14185. internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
  14186. and others.
  14187. With INCLUDE-COLUMNS, also include property names given in COLUMN
  14188. formats in the current buffer."
  14189. (let (rtn range cfmt s p)
  14190. (save-excursion
  14191. (save-restriction
  14192. (widen)
  14193. (goto-char (point-min))
  14194. (while (re-search-forward org-property-start-re nil t)
  14195. (setq range (org-get-property-block))
  14196. (goto-char (car range))
  14197. (while (re-search-forward org-property-re
  14198. (cdr range) t)
  14199. (add-to-list 'rtn (org-match-string-no-properties 2)))
  14200. (outline-next-heading))))
  14201. (when include-specials
  14202. (setq rtn (append org-special-properties rtn)))
  14203. (when include-defaults
  14204. (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
  14205. (add-to-list 'rtn org-effort-property))
  14206. (when include-columns
  14207. (save-excursion
  14208. (save-restriction
  14209. (widen)
  14210. (goto-char (point-min))
  14211. (while (re-search-forward
  14212. "^\\(#\\+COLUMNS:\\|[ \t]*:COLUMNS:\\)[ \t]*\\(.*\\)"
  14213. nil t)
  14214. (setq cfmt (match-string 2) s 0)
  14215. (while (string-match (org-re "%[0-9]*\\([-[:alnum:]_]+\\)")
  14216. cfmt s)
  14217. (setq s (match-end 0)
  14218. p (match-string 1 cfmt))
  14219. (unless (or (equal p "ITEM")
  14220. (member p org-special-properties))
  14221. (add-to-list 'rtn (match-string 1 cfmt))))))))
  14222. (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
  14223. (defun org-property-values (key)
  14224. "Return a list of all values of property KEY in the current buffer."
  14225. (save-excursion
  14226. (save-restriction
  14227. (widen)
  14228. (goto-char (point-min))
  14229. (let ((re (org-re-property key))
  14230. values)
  14231. (while (re-search-forward re nil t)
  14232. (add-to-list 'values (org-trim (match-string 3))))
  14233. (delete "" values)))))
  14234. (defun org-insert-property-drawer ()
  14235. "Insert a property drawer into the current entry."
  14236. (org-back-to-heading t)
  14237. (looking-at org-outline-regexp)
  14238. (let ((indent (if org-adapt-indentation
  14239. (- (match-end 0) (match-beginning 0))
  14240. 0))
  14241. (beg (point))
  14242. (re (concat "^[ \t]*" org-keyword-time-regexp))
  14243. end hiddenp)
  14244. (outline-next-heading)
  14245. (setq end (point))
  14246. (goto-char beg)
  14247. (while (re-search-forward re end t))
  14248. (setq hiddenp (outline-invisible-p))
  14249. (end-of-line 1)
  14250. (and (equal (char-after) ?\n) (forward-char 1))
  14251. (while (looking-at "^[ \t]*\\(:CLOCK:\\|:LOGBOOK:\\|CLOCK:\\|:END:\\)")
  14252. (if (member (match-string 1) '("CLOCK:" ":END:"))
  14253. ;; just skip this line
  14254. (beginning-of-line 2)
  14255. ;; Drawer start, find the end
  14256. (re-search-forward "^\\*+ \\|^[ \t]*:END:" nil t)
  14257. (beginning-of-line 1)))
  14258. (org-skip-over-state-notes)
  14259. (skip-chars-backward " \t\n\r")
  14260. (if (eq (char-before) ?*) (forward-char 1))
  14261. (let ((inhibit-read-only t)) (insert "\n:PROPERTIES:\n:END:"))
  14262. (beginning-of-line 0)
  14263. (org-indent-to-column indent)
  14264. (beginning-of-line 2)
  14265. (org-indent-to-column indent)
  14266. (beginning-of-line 0)
  14267. (if hiddenp
  14268. (save-excursion
  14269. (org-back-to-heading t)
  14270. (hide-entry))
  14271. (org-flag-drawer t))))
  14272. (defun org-insert-drawer (&optional arg drawer)
  14273. "Insert a drawer at point.
  14274. Optional argument DRAWER, when non-nil, is a string representing
  14275. drawer's name. Otherwise, the user is prompted for a name.
  14276. If a region is active, insert the drawer around that region
  14277. instead.
  14278. Point is left between drawer's boundaries."
  14279. (interactive "P")
  14280. (let* ((logbook (if (stringp org-log-into-drawer) org-log-into-drawer
  14281. "LOGBOOK"))
  14282. ;; SYSTEM-DRAWERS is a list of drawer names that are used
  14283. ;; internally by Org. They are meant to be inserted
  14284. ;; automatically.
  14285. (system-drawers `("CLOCK" ,logbook "PROPERTIES"))
  14286. ;; Remove system drawers from list. Note: For some reason,
  14287. ;; `org-completing-read' ignores the predicate while
  14288. ;; `completing-read' handles it fine.
  14289. (drawer (if arg "PROPERTIES"
  14290. (or drawer
  14291. (completing-read
  14292. "Drawer: " org-drawers
  14293. (lambda (d) (not (member d system-drawers))))))))
  14294. (cond
  14295. ;; With C-u, fall back on `org-insert-property-drawer'
  14296. (arg (org-insert-property-drawer))
  14297. ;; With an active region, insert a drawer at point.
  14298. ((not (org-region-active-p))
  14299. (progn
  14300. (unless (bolp) (insert "\n"))
  14301. (insert (format ":%s:\n\n:END:\n" drawer))
  14302. (forward-line -2)))
  14303. ;; Otherwise, insert the drawer at point
  14304. (t
  14305. (let ((rbeg (region-beginning))
  14306. (rend (copy-marker (region-end))))
  14307. (unwind-protect
  14308. (progn
  14309. (goto-char rbeg)
  14310. (beginning-of-line)
  14311. (when (save-excursion
  14312. (re-search-forward org-outline-regexp-bol rend t))
  14313. (user-error "Drawers cannot contain headlines"))
  14314. ;; Position point at the beginning of the first
  14315. ;; non-blank line in region. Insert drawer's opening
  14316. ;; there, then indent it.
  14317. (org-skip-whitespace)
  14318. (beginning-of-line)
  14319. (insert ":" drawer ":\n")
  14320. (forward-line -1)
  14321. (indent-for-tab-command)
  14322. ;; Move point to the beginning of the first blank line
  14323. ;; after the last non-blank line in region. Insert
  14324. ;; drawer's closing, then indent it.
  14325. (goto-char rend)
  14326. (skip-chars-backward " \r\t\n")
  14327. (insert "\n:END:")
  14328. (deactivate-mark t)
  14329. (indent-for-tab-command)
  14330. (unless (eolp) (insert "\n")))
  14331. ;; Clear marker, whatever the outcome of insertion is.
  14332. (set-marker rend nil)))))))
  14333. (defvar org-property-set-functions-alist nil
  14334. "Property set function alist.
  14335. Each entry should have the following format:
  14336. (PROPERTY . READ-FUNCTION)
  14337. The read function will be called with the same argument as
  14338. `org-completing-read'.")
  14339. (defun org-set-property-function (property)
  14340. "Get the function that should be used to set PROPERTY.
  14341. This is computed according to `org-property-set-functions-alist'."
  14342. (or (cdr (assoc property org-property-set-functions-alist))
  14343. 'org-completing-read))
  14344. (defun org-read-property-value (property)
  14345. "Read PROPERTY value from user."
  14346. (let* ((completion-ignore-case t)
  14347. (allowed (org-property-get-allowed-values nil property 'table))
  14348. (cur (org-entry-get nil property))
  14349. (prompt (concat property " value"
  14350. (if (and cur (string-match "\\S-" cur))
  14351. (concat " [" cur "]") "") ": "))
  14352. (set-function (org-set-property-function property))
  14353. (val (if allowed
  14354. (funcall set-function prompt allowed nil
  14355. (not (get-text-property 0 'org-unrestricted
  14356. (caar allowed))))
  14357. (let (org-completion-use-ido org-completion-use-iswitchb)
  14358. (funcall set-function prompt
  14359. (mapcar 'list (org-property-values property))
  14360. nil nil "" nil cur)))))
  14361. (if (equal val "")
  14362. cur
  14363. val)))
  14364. (defvar org-last-set-property nil)
  14365. (defvar org-last-set-property-value nil)
  14366. (defun org-read-property-name ()
  14367. "Read a property name."
  14368. (let* ((completion-ignore-case t)
  14369. (keys (org-buffer-property-keys nil t t))
  14370. (default-prop (or (save-excursion
  14371. (save-match-data
  14372. (beginning-of-line)
  14373. (and (looking-at "^\\s-*:\\([^:\n]+\\):")
  14374. (null (string= (match-string 1) "END"))
  14375. (match-string 1))))
  14376. org-last-set-property))
  14377. (property (org-icompleting-read
  14378. (concat "Property"
  14379. (if default-prop (concat " [" default-prop "]") "")
  14380. ": ")
  14381. (mapcar 'list keys)
  14382. nil nil nil nil
  14383. default-prop)))
  14384. (if (member property keys)
  14385. property
  14386. (or (cdr (assoc (downcase property)
  14387. (mapcar (lambda (x) (cons (downcase x) x))
  14388. keys)))
  14389. property))))
  14390. (defun org-set-property-and-value (use-last)
  14391. "Allow to set [PROPERTY]: [value] direction from prompt.
  14392. When use-default, don't even ask, just use the last
  14393. \"[PROPERTY]: [value]\" string from the history."
  14394. (interactive "P")
  14395. (let* ((completion-ignore-case t)
  14396. (pv (or (and use-last org-last-set-property-value)
  14397. (org-completing-read
  14398. "Enter a \"[Property]: [value]\" pair: "
  14399. nil nil nil nil nil
  14400. org-last-set-property-value)))
  14401. prop val)
  14402. (when (string-match "^[ \t]*\\([^:]+\\):[ \t]*\\(.*\\)[ \t]*$" pv)
  14403. (setq prop (match-string 1 pv)
  14404. val (match-string 2 pv))
  14405. (org-set-property prop val))))
  14406. (defun org-set-property (property value)
  14407. "In the current entry, set PROPERTY to VALUE.
  14408. When called interactively, this will prompt for a property name, offering
  14409. completion on existing and default properties. And then it will prompt
  14410. for a value, offering completion either on allowed values (via an inherited
  14411. xxx_ALL property) or on existing values in other instances of this property
  14412. in the current file."
  14413. (interactive (list nil nil))
  14414. (let* ((property (or property (org-read-property-name)))
  14415. (value (or value (org-read-property-value property)))
  14416. (fn (cdr (assoc property org-properties-postprocess-alist))))
  14417. (setq org-last-set-property property)
  14418. (setq org-last-set-property-value (concat property ": " value))
  14419. ;; Possibly postprocess the inserted value:
  14420. (when fn (setq value (funcall fn value)))
  14421. (unless (equal (org-entry-get nil property) value)
  14422. (org-entry-put nil property value))))
  14423. (defun org-delete-property (property &optional delete-empty-drawer)
  14424. "In the current entry, delete PROPERTY.
  14425. When optional argument DELETE-EMPTY-DRAWER is a string, it defines
  14426. an empty drawer to delete."
  14427. (interactive
  14428. (let* ((completion-ignore-case t)
  14429. (prop (org-icompleting-read "Property: "
  14430. (org-entry-properties nil 'standard))))
  14431. (list prop)))
  14432. (message "Property %s %s" property
  14433. (if (org-entry-delete nil property delete-empty-drawer)
  14434. "deleted"
  14435. "was not present in the entry")))
  14436. (defun org-delete-property-globally (property)
  14437. "Remove PROPERTY globally, from all entries."
  14438. (interactive
  14439. (let* ((completion-ignore-case t)
  14440. (prop (org-icompleting-read
  14441. "Globally remove property: "
  14442. (mapcar 'list (org-buffer-property-keys)))))
  14443. (list prop)))
  14444. (save-excursion
  14445. (save-restriction
  14446. (widen)
  14447. (goto-char (point-min))
  14448. (let ((cnt 0))
  14449. (while (re-search-forward
  14450. (org-re-property property)
  14451. nil t)
  14452. (setq cnt (1+ cnt))
  14453. (delete-region (match-beginning 0) (1+ (point-at-eol))))
  14454. (message "Property \"%s\" removed from %d entries" property cnt)))))
  14455. (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
  14456. (defun org-compute-property-at-point ()
  14457. "Compute the property at point.
  14458. This looks for an enclosing column format, extracts the operator and
  14459. then applies it to the property in the column format's scope."
  14460. (interactive)
  14461. (unless (org-at-property-p)
  14462. (user-error "Not at a property"))
  14463. (let ((prop (org-match-string-no-properties 2)))
  14464. (org-columns-get-format-and-top-level)
  14465. (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
  14466. (user-error "No operator defined for property %s" prop))
  14467. (org-columns-compute prop)))
  14468. (defvar org-property-allowed-value-functions nil
  14469. "Hook for functions supplying allowed values for a specific property.
  14470. The functions must take a single argument, the name of the property, and
  14471. return a flat list of allowed values. If \":ETC\" is one of
  14472. the values, this means that these values are intended as defaults for
  14473. completion, but that other values should be allowed too.
  14474. The functions must return nil if they are not responsible for this
  14475. property.")
  14476. (defun org-property-get-allowed-values (pom property &optional table)
  14477. "Get allowed values for the property PROPERTY.
  14478. When TABLE is non-nil, return an alist that can directly be used for
  14479. completion."
  14480. (let (vals)
  14481. (cond
  14482. ((equal property "TODO")
  14483. (setq vals (org-with-point-at pom
  14484. (append org-todo-keywords-1 '("")))))
  14485. ((equal property "PRIORITY")
  14486. (let ((n org-lowest-priority))
  14487. (while (>= n org-highest-priority)
  14488. (push (char-to-string n) vals)
  14489. (setq n (1- n)))))
  14490. ((member property org-special-properties))
  14491. ((setq vals (run-hook-with-args-until-success
  14492. 'org-property-allowed-value-functions property)))
  14493. (t
  14494. (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
  14495. (when (and vals (string-match "\\S-" vals))
  14496. (setq vals (car (read-from-string (concat "(" vals ")"))))
  14497. (setq vals (mapcar (lambda (x)
  14498. (cond ((stringp x) x)
  14499. ((numberp x) (number-to-string x))
  14500. ((symbolp x) (symbol-name x))
  14501. (t "???")))
  14502. vals)))))
  14503. (when (member ":ETC" vals)
  14504. (setq vals (remove ":ETC" vals))
  14505. (org-add-props (car vals) '(org-unrestricted t)))
  14506. (if table (mapcar 'list vals) vals)))
  14507. (defun org-property-previous-allowed-value (&optional previous)
  14508. "Switch to the next allowed value for this property."
  14509. (interactive)
  14510. (org-property-next-allowed-value t))
  14511. (defun org-property-next-allowed-value (&optional previous)
  14512. "Switch to the next allowed value for this property."
  14513. (interactive)
  14514. (unless (org-at-property-p)
  14515. (user-error "Not at a property"))
  14516. (let* ((prop (car (save-match-data (org-split-string (match-string 1) ":"))))
  14517. (key (match-string 2))
  14518. (value (match-string 3))
  14519. (allowed (or (org-property-get-allowed-values (point) key)
  14520. (and (member value '("[ ]" "[-]" "[X]"))
  14521. '("[ ]" "[X]"))))
  14522. (heading (save-match-data (nth 4 (org-heading-components))))
  14523. nval)
  14524. (unless allowed
  14525. (user-error "Allowed values for this property have not been defined"))
  14526. (if previous (setq allowed (reverse allowed)))
  14527. (if (member value allowed)
  14528. (setq nval (car (cdr (member value allowed)))))
  14529. (setq nval (or nval (car allowed)))
  14530. (if (equal nval value)
  14531. (user-error "Only one allowed value for this property"))
  14532. (org-at-property-p)
  14533. (replace-match (concat " :" key ": " nval) t t)
  14534. (org-indent-line)
  14535. (beginning-of-line 1)
  14536. (skip-chars-forward " \t")
  14537. (when (equal prop org-effort-property)
  14538. (save-excursion
  14539. (org-back-to-heading t)
  14540. (put-text-property (point-at-bol) (point-at-eol) 'org-effort nval))
  14541. (when (string= org-clock-current-task heading)
  14542. (setq org-clock-effort nval)
  14543. (org-clock-update-mode-line)))
  14544. (run-hook-with-args 'org-property-changed-functions key nval)))
  14545. (defun org-find-olp (path &optional this-buffer)
  14546. "Return a marker pointing to the entry at outline path OLP.
  14547. If anything goes wrong, throw an error.
  14548. You can wrap this call to catch the error like this:
  14549. (condition-case msg
  14550. (org-mobile-locate-entry (match-string 4))
  14551. (error (nth 1 msg)))
  14552. The return value will then be either a string with the error message,
  14553. or a marker if everything is OK.
  14554. If THIS-BUFFER is set, the outline path does not contain a file,
  14555. only headings."
  14556. (let* ((file (if this-buffer buffer-file-name (pop path)))
  14557. (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
  14558. (level 1)
  14559. (lmin 1)
  14560. (lmax 1)
  14561. limit re end found pos heading cnt flevel)
  14562. (unless buffer (error "File not found :%s" file))
  14563. (with-current-buffer buffer
  14564. (save-excursion
  14565. (save-restriction
  14566. (widen)
  14567. (setq limit (point-max))
  14568. (goto-char (point-min))
  14569. (while (setq heading (pop path))
  14570. (setq re (format org-complex-heading-regexp-format
  14571. (regexp-quote heading)))
  14572. (setq cnt 0 pos (point))
  14573. (while (re-search-forward re end t)
  14574. (setq level (- (match-end 1) (match-beginning 1)))
  14575. (if (and (>= level lmin) (<= level lmax))
  14576. (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
  14577. (when (= cnt 0) (error "Heading not found on level %d: %s"
  14578. lmax heading))
  14579. (when (> cnt 1) (error "Heading not unique on level %d: %s"
  14580. lmax heading))
  14581. (goto-char found)
  14582. (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
  14583. (setq end (save-excursion (org-end-of-subtree t t))))
  14584. (when (org-at-heading-p)
  14585. (point-marker)))))))
  14586. (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
  14587. "Find node HEADING in BUFFER.
  14588. Return a marker to the heading if it was found, or nil if not.
  14589. If POS-ONLY is set, return just the position instead of a marker.
  14590. The heading text must match exact, but it may have a TODO keyword,
  14591. a priority cookie and tags in the standard locations."
  14592. (with-current-buffer (or buffer (current-buffer))
  14593. (save-excursion
  14594. (save-restriction
  14595. (widen)
  14596. (goto-char (point-min))
  14597. (let (case-fold-search)
  14598. (if (re-search-forward
  14599. (format org-complex-heading-regexp-format
  14600. (regexp-quote heading)) nil t)
  14601. (if pos-only
  14602. (match-beginning 0)
  14603. (move-marker (make-marker) (match-beginning 0)))))))))
  14604. (defun org-find-exact-heading-in-directory (heading &optional dir)
  14605. "Find Org node headline HEADING in all .org files in directory DIR.
  14606. When the target headline is found, return a marker to this location."
  14607. (let ((files (directory-files (or dir default-directory)
  14608. nil "\\`[^.#].*\\.org\\'"))
  14609. file visiting m buffer)
  14610. (catch 'found
  14611. (while (setq file (pop files))
  14612. (message "trying %s" file)
  14613. (setq visiting (org-find-base-buffer-visiting file))
  14614. (setq buffer (or visiting (find-file-noselect file)))
  14615. (setq m (org-find-exact-headline-in-buffer
  14616. heading buffer))
  14617. (when (and (not m) (not visiting)) (kill-buffer buffer))
  14618. (and m (throw 'found m))))))
  14619. (defun org-find-entry-with-id (ident)
  14620. "Locate the entry that contains the ID property with exact value IDENT.
  14621. IDENT can be a string, a symbol or a number, this function will search for
  14622. the string representation of it.
  14623. Return the position where this entry starts, or nil if there is no such entry."
  14624. (interactive "sID: ")
  14625. (let ((id (cond
  14626. ((stringp ident) ident)
  14627. ((symbol-name ident) (symbol-name ident))
  14628. ((numberp ident) (number-to-string ident))
  14629. (t (error "IDENT %s must be a string, symbol or number" ident))))
  14630. (case-fold-search nil))
  14631. (save-excursion
  14632. (save-restriction
  14633. (widen)
  14634. (goto-char (point-min))
  14635. (when (re-search-forward
  14636. (concat "^[ \t]*:ID:[ \t]+" (regexp-quote id) "[ \t]*$")
  14637. nil t)
  14638. (org-back-to-heading t)
  14639. (point))))))
  14640. ;;;; Timestamps
  14641. (defvar org-last-changed-timestamp nil)
  14642. (defvar org-last-inserted-timestamp nil
  14643. "The last time stamp inserted with `org-insert-time-stamp'.")
  14644. (defvar org-time-was-given) ; dynamically scoped parameter
  14645. (defvar org-end-time-was-given) ; dynamically scoped parameter
  14646. (defvar org-ts-what) ; dynamically scoped parameter
  14647. (defun org-time-stamp (arg &optional inactive)
  14648. "Prompt for a date/time and insert a time stamp.
  14649. If the user specifies a time like HH:MM or if this command is
  14650. called with at least one prefix argument, the time stamp contains
  14651. the date and the time. Otherwise, only the date is be included.
  14652. All parts of a date not specified by the user is filled in from
  14653. the current date/time. So if you just press return without
  14654. typing anything, the time stamp will represent the current
  14655. date/time.
  14656. If there is already a timestamp at the cursor, it will be
  14657. modified.
  14658. With two universal prefix arguments, insert an active timestamp
  14659. with the current time without prompting the user."
  14660. (interactive "P")
  14661. (let* ((ts nil)
  14662. (default-time
  14663. ;; Default time is either today, or, when entering a range,
  14664. ;; the range start.
  14665. (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
  14666. (save-excursion
  14667. (re-search-backward
  14668. (concat org-ts-regexp "--?-?\\=") ; 1-3 minuses
  14669. (- (point) 20) t)))
  14670. (apply 'encode-time (org-parse-time-string (match-string 1)))
  14671. (current-time)))
  14672. (default-input (and ts (org-get-compact-tod ts)))
  14673. (repeater (save-excursion
  14674. (save-match-data
  14675. (beginning-of-line)
  14676. (when (re-search-forward
  14677. "\\([.+-]+[0-9]+[hdwmy] ?\\)+" ;;\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
  14678. (save-excursion (progn (end-of-line) (point))) t)
  14679. (match-string 0)))))
  14680. org-time-was-given org-end-time-was-given time)
  14681. (cond
  14682. ((and (org-at-timestamp-p t)
  14683. (memq last-command '(org-time-stamp org-time-stamp-inactive))
  14684. (memq this-command '(org-time-stamp org-time-stamp-inactive)))
  14685. (insert "--")
  14686. (setq time (let ((this-command this-command))
  14687. (org-read-date arg 'totime nil nil
  14688. default-time default-input inactive)))
  14689. (org-insert-time-stamp time (or org-time-was-given arg) inactive))
  14690. ((org-at-timestamp-p t)
  14691. (setq time (let ((this-command this-command))
  14692. (org-read-date arg 'totime nil nil default-time default-input inactive)))
  14693. (when (org-at-timestamp-p t) ; just to get the match data
  14694. ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
  14695. (replace-match "")
  14696. (setq org-last-changed-timestamp
  14697. (org-insert-time-stamp
  14698. time (or org-time-was-given arg)
  14699. inactive nil nil (list org-end-time-was-given)))
  14700. (when repeater (goto-char (1- (point))) (insert " " repeater)
  14701. (setq org-last-changed-timestamp
  14702. (concat (substring org-last-inserted-timestamp 0 -1)
  14703. " " repeater ">"))))
  14704. (message "Timestamp updated"))
  14705. ((equal arg '(16))
  14706. (org-insert-time-stamp (current-time) t))
  14707. (t
  14708. (setq time (let ((this-command this-command))
  14709. (org-read-date arg 'totime nil nil default-time default-input inactive)))
  14710. (org-insert-time-stamp time (or org-time-was-given arg) inactive
  14711. nil nil (list org-end-time-was-given))))))
  14712. ;; FIXME: can we use this for something else, like computing time differences?
  14713. (defun org-get-compact-tod (s)
  14714. (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
  14715. (let* ((t1 (match-string 1 s))
  14716. (h1 (string-to-number (match-string 2 s)))
  14717. (m1 (string-to-number (match-string 3 s)))
  14718. (t2 (and (match-end 4) (match-string 5 s)))
  14719. (h2 (and t2 (string-to-number (match-string 6 s))))
  14720. (m2 (and t2 (string-to-number (match-string 7 s))))
  14721. dh dm)
  14722. (if (not t2)
  14723. t1
  14724. (setq dh (- h2 h1) dm (- m2 m1))
  14725. (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
  14726. (concat t1 "+" (number-to-string dh)
  14727. (and (/= 0 dm) (format ":%02d" dm)))))))
  14728. (defun org-time-stamp-inactive (&optional arg)
  14729. "Insert an inactive time stamp.
  14730. An inactive time stamp is enclosed in square brackets instead of angle
  14731. brackets. It is inactive in the sense that it does not trigger agenda entries,
  14732. does not link to the calendar and cannot be changed with the S-cursor keys.
  14733. So these are more for recording a certain time/date."
  14734. (interactive "P")
  14735. (org-time-stamp arg 'inactive))
  14736. (defvar org-date-ovl (make-overlay 1 1))
  14737. (overlay-put org-date-ovl 'face 'org-date-selected)
  14738. (org-detach-overlay org-date-ovl)
  14739. (defvar org-ans1) ; dynamically scoped parameter
  14740. (defvar org-ans2) ; dynamically scoped parameter
  14741. (defvar org-plain-time-of-day-regexp) ; defined below
  14742. (defvar org-overriding-default-time nil) ; dynamically scoped
  14743. (defvar org-read-date-overlay nil)
  14744. (defvar org-dcst nil) ; dynamically scoped
  14745. (defvar org-read-date-history nil)
  14746. (defvar org-read-date-final-answer nil)
  14747. (defvar org-read-date-analyze-futurep nil)
  14748. (defvar org-read-date-analyze-forced-year nil)
  14749. (defvar org-read-date-inactive)
  14750. (defvar org-read-date-minibuffer-local-map
  14751. (let ((map (make-sparse-keymap)))
  14752. (set-keymap-parent map minibuffer-local-map)
  14753. (org-defkey map (kbd ".")
  14754. (lambda () (interactive)
  14755. ;; Are we at the beginning of the prompt?
  14756. (if (looking-back "^[^:]+: ")
  14757. (org-eval-in-calendar '(calendar-goto-today))
  14758. (insert "."))))
  14759. (org-defkey map (kbd "C-.")
  14760. (lambda () (interactive)
  14761. (org-eval-in-calendar '(calendar-goto-today))))
  14762. (org-defkey map [(meta shift left)]
  14763. (lambda () (interactive)
  14764. (org-eval-in-calendar '(calendar-backward-month 1))))
  14765. (org-defkey map [(meta shift right)]
  14766. (lambda () (interactive)
  14767. (org-eval-in-calendar '(calendar-forward-month 1))))
  14768. (org-defkey map [(meta shift up)]
  14769. (lambda () (interactive)
  14770. (org-eval-in-calendar '(calendar-backward-year 1))))
  14771. (org-defkey map [(meta shift down)]
  14772. (lambda () (interactive)
  14773. (org-eval-in-calendar '(calendar-forward-year 1))))
  14774. (org-defkey map [?\e (shift left)]
  14775. (lambda () (interactive)
  14776. (org-eval-in-calendar '(calendar-backward-month 1))))
  14777. (org-defkey map [?\e (shift right)]
  14778. (lambda () (interactive)
  14779. (org-eval-in-calendar '(calendar-forward-month 1))))
  14780. (org-defkey map [?\e (shift up)]
  14781. (lambda () (interactive)
  14782. (org-eval-in-calendar '(calendar-backward-year 1))))
  14783. (org-defkey map [?\e (shift down)]
  14784. (lambda () (interactive)
  14785. (org-eval-in-calendar '(calendar-forward-year 1))))
  14786. (org-defkey map [(shift up)]
  14787. (lambda () (interactive)
  14788. (org-eval-in-calendar '(calendar-backward-week 1))))
  14789. (org-defkey map [(shift down)]
  14790. (lambda () (interactive)
  14791. (org-eval-in-calendar '(calendar-forward-week 1))))
  14792. (org-defkey map [(shift left)]
  14793. (lambda () (interactive)
  14794. (org-eval-in-calendar '(calendar-backward-day 1))))
  14795. (org-defkey map [(shift right)]
  14796. (lambda () (interactive)
  14797. (org-eval-in-calendar '(calendar-forward-day 1))))
  14798. (org-defkey map "!"
  14799. (lambda () (interactive)
  14800. (org-eval-in-calendar '(diary-view-entries))
  14801. (message "")))
  14802. (org-defkey map ">"
  14803. (lambda () (interactive)
  14804. (org-eval-in-calendar '(scroll-calendar-left 1))))
  14805. (org-defkey map "<"
  14806. (lambda () (interactive)
  14807. (org-eval-in-calendar '(scroll-calendar-right 1))))
  14808. (org-defkey map "\C-v"
  14809. (lambda () (interactive)
  14810. (org-eval-in-calendar
  14811. '(calendar-scroll-left-three-months 1))))
  14812. (org-defkey map "\M-v"
  14813. (lambda () (interactive)
  14814. (org-eval-in-calendar
  14815. '(calendar-scroll-right-three-months 1))))
  14816. map)
  14817. "Keymap for minibuffer commands when using `org-read-date'.")
  14818. (defun org-read-date (&optional org-with-time to-time from-string prompt
  14819. default-time default-input inactive)
  14820. "Read a date, possibly a time, and make things smooth for the user.
  14821. The prompt will suggest to enter an ISO date, but you can also enter anything
  14822. which will at least partially be understood by `parse-time-string'.
  14823. Unrecognized parts of the date will default to the current day, month, year,
  14824. hour and minute. If this command is called to replace a timestamp at point,
  14825. or to enter the second timestamp of a range, the default time is taken
  14826. from the existing stamp. Furthermore, the command prefers the future,
  14827. so if you are giving a date where the year is not given, and the day-month
  14828. combination is already past in the current year, it will assume you
  14829. mean next year. For details, see the manual. A few examples:
  14830. 3-2-5 --> 2003-02-05
  14831. feb 15 --> currentyear-02-15
  14832. 2/15 --> currentyear-02-15
  14833. sep 12 9 --> 2009-09-12
  14834. 12:45 --> today 12:45
  14835. 22 sept 0:34 --> currentyear-09-22 0:34
  14836. 12 --> currentyear-currentmonth-12
  14837. Fri --> nearest Friday after today
  14838. -Tue --> last Tuesday
  14839. etc.
  14840. Furthermore you can specify a relative date by giving, as the *first* thing
  14841. in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
  14842. change in days weeks, months, years.
  14843. With a single plus or minus, the date is relative to today. With a double
  14844. plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
  14845. +4d --> four days from today
  14846. +4 --> same as above
  14847. +2w --> two weeks from today
  14848. ++5 --> five days from default date
  14849. The function understands only English month and weekday abbreviations.
  14850. While prompting, a calendar is popped up - you can also select the
  14851. date with the mouse (button 1). The calendar shows a period of three
  14852. months. To scroll it to other months, use the keys `>' and `<'.
  14853. If you don't like the calendar, turn it off with
  14854. \(setq org-read-date-popup-calendar nil)
  14855. With optional argument TO-TIME, the date will immediately be converted
  14856. to an internal time.
  14857. With an optional argument ORG-WITH-TIME, the prompt will suggest to
  14858. also insert a time. Note that when ORG-WITH-TIME is not set, you can
  14859. still enter a time, and this function will inform the calling routine
  14860. about this change. The calling routine may then choose to change the
  14861. format used to insert the time stamp into the buffer to include the time.
  14862. With optional argument FROM-STRING, read from this string instead from
  14863. the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
  14864. the time/date that is used for everything that is not specified by the
  14865. user."
  14866. (require 'parse-time)
  14867. (let* ((org-time-stamp-rounding-minutes
  14868. (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
  14869. (org-dcst org-display-custom-times)
  14870. (ct (org-current-time))
  14871. (org-def (or org-overriding-default-time default-time ct))
  14872. (org-defdecode (decode-time org-def))
  14873. (dummy (progn
  14874. (when (< (nth 2 org-defdecode) org-extend-today-until)
  14875. (setcar (nthcdr 2 org-defdecode) -1)
  14876. (setcar (nthcdr 1 org-defdecode) 59)
  14877. (setq org-def (apply 'encode-time org-defdecode)
  14878. org-defdecode (decode-time org-def)))))
  14879. (mouse-autoselect-window nil) ; Don't let the mouse jump
  14880. (calendar-frame-setup nil)
  14881. (calendar-setup nil)
  14882. (calendar-move-hook nil)
  14883. (calendar-view-diary-initially-flag nil)
  14884. (calendar-view-holidays-initially-flag nil)
  14885. (timestr (format-time-string
  14886. (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
  14887. (prompt (concat (if prompt (concat prompt " ") "")
  14888. (format "Date+time [%s]: " timestr)))
  14889. ans (org-ans0 "") org-ans1 org-ans2 final)
  14890. (cond
  14891. (from-string (setq ans from-string))
  14892. (org-read-date-popup-calendar
  14893. (save-excursion
  14894. (save-window-excursion
  14895. (calendar)
  14896. (org-eval-in-calendar '(setq cursor-type nil) t)
  14897. (unwind-protect
  14898. (progn
  14899. (calendar-forward-day (- (time-to-days org-def)
  14900. (calendar-absolute-from-gregorian
  14901. (calendar-current-date))))
  14902. (org-eval-in-calendar nil t)
  14903. (let* ((old-map (current-local-map))
  14904. (map (copy-keymap calendar-mode-map))
  14905. (minibuffer-local-map
  14906. (copy-keymap org-read-date-minibuffer-local-map)))
  14907. (org-defkey map (kbd "RET") 'org-calendar-select)
  14908. (org-defkey map [mouse-1] 'org-calendar-select-mouse)
  14909. (org-defkey map [mouse-2] 'org-calendar-select-mouse)
  14910. (unwind-protect
  14911. (progn
  14912. (use-local-map map)
  14913. (setq org-read-date-inactive inactive)
  14914. (add-hook 'post-command-hook 'org-read-date-display)
  14915. (setq org-ans0 (read-string prompt default-input
  14916. 'org-read-date-history nil))
  14917. ;; org-ans0: from prompt
  14918. ;; org-ans1: from mouse click
  14919. ;; org-ans2: from calendar motion
  14920. (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
  14921. (remove-hook 'post-command-hook 'org-read-date-display)
  14922. (use-local-map old-map)
  14923. (when org-read-date-overlay
  14924. (delete-overlay org-read-date-overlay)
  14925. (setq org-read-date-overlay nil)))))
  14926. (bury-buffer "*Calendar*")))))
  14927. (t ; Naked prompt only
  14928. (unwind-protect
  14929. (setq ans (read-string prompt default-input
  14930. 'org-read-date-history timestr))
  14931. (when org-read-date-overlay
  14932. (delete-overlay org-read-date-overlay)
  14933. (setq org-read-date-overlay nil)))))
  14934. (setq final (org-read-date-analyze ans org-def org-defdecode))
  14935. (when org-read-date-analyze-forced-year
  14936. (message "Year was forced into %s"
  14937. (if org-read-date-force-compatible-dates
  14938. "compatible range (1970-2037)"
  14939. "range representable on this machine"))
  14940. (ding))
  14941. ;; One round trip to get rid of 34th of August and stuff like that....
  14942. (setq final (decode-time (apply 'encode-time final)))
  14943. (setq org-read-date-final-answer ans)
  14944. (if to-time
  14945. (apply 'encode-time final)
  14946. (if (and (boundp 'org-time-was-given) org-time-was-given)
  14947. (format "%04d-%02d-%02d %02d:%02d"
  14948. (nth 5 final) (nth 4 final) (nth 3 final)
  14949. (nth 2 final) (nth 1 final))
  14950. (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
  14951. (defvar org-def)
  14952. (defvar org-defdecode)
  14953. (defvar org-with-time)
  14954. (defun org-read-date-display ()
  14955. "Display the current date prompt interpretation in the minibuffer."
  14956. (when org-read-date-display-live
  14957. (when org-read-date-overlay
  14958. (delete-overlay org-read-date-overlay))
  14959. (when (minibufferp (current-buffer))
  14960. (save-excursion
  14961. (end-of-line 1)
  14962. (while (not (equal (buffer-substring
  14963. (max (point-min) (- (point) 4)) (point))
  14964. " "))
  14965. (insert " ")))
  14966. (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
  14967. " " (or org-ans1 org-ans2)))
  14968. (org-end-time-was-given nil)
  14969. (f (org-read-date-analyze ans org-def org-defdecode))
  14970. (fmts (if org-dcst
  14971. org-time-stamp-custom-formats
  14972. org-time-stamp-formats))
  14973. (fmt (if (or org-with-time
  14974. (and (boundp 'org-time-was-given) org-time-was-given))
  14975. (cdr fmts)
  14976. (car fmts)))
  14977. (txt (format-time-string fmt (apply 'encode-time f)))
  14978. (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
  14979. (txt (concat "=> " txt)))
  14980. (when (and org-end-time-was-given
  14981. (string-match org-plain-time-of-day-regexp txt))
  14982. (setq txt (concat (substring txt 0 (match-end 0)) "-"
  14983. org-end-time-was-given
  14984. (substring txt (match-end 0)))))
  14985. (when org-read-date-analyze-futurep
  14986. (setq txt (concat txt " (=>F)")))
  14987. (setq org-read-date-overlay
  14988. (make-overlay (1- (point-at-eol)) (point-at-eol)))
  14989. (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
  14990. (defun org-read-date-analyze (ans org-def org-defdecode)
  14991. "Analyze the combined answer of the date prompt."
  14992. ;; FIXME: cleanup and comment
  14993. (let ((nowdecode (decode-time (current-time)))
  14994. delta deltan deltaw deltadef year month day
  14995. hour minute second wday pm h2 m2 tl wday1
  14996. iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
  14997. (setq org-read-date-analyze-futurep nil
  14998. org-read-date-analyze-forced-year nil)
  14999. (when (string-match "\\`[ \t]*\\.[ \t]*\\'" ans)
  15000. (setq ans "+0"))
  15001. (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
  15002. (setq ans (replace-match "" t t ans)
  15003. deltan (car delta)
  15004. deltaw (nth 1 delta)
  15005. deltadef (nth 2 delta)))
  15006. ;; Check if there is an iso week date in there. If yes, store the
  15007. ;; info and postpone interpreting it until the rest of the parsing
  15008. ;; is done.
  15009. (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
  15010. (setq iso-year (if (match-end 1)
  15011. (org-small-year-to-year
  15012. (string-to-number (match-string 1 ans))))
  15013. iso-weekday (if (match-end 3)
  15014. (string-to-number (match-string 3 ans)))
  15015. iso-week (string-to-number (match-string 2 ans)))
  15016. (setq ans (replace-match "" t t ans)))
  15017. ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
  15018. (when (string-match
  15019. "^ *\\(\\([0-9]+\\)-\\)?\\([0-1]?[0-9]\\)-\\([0-3]?[0-9]\\)\\([^-0-9]\\|$\\)" ans)
  15020. (setq year (if (match-end 2)
  15021. (string-to-number (match-string 2 ans))
  15022. (progn (setq kill-year t)
  15023. (string-to-number (format-time-string "%Y"))))
  15024. month (string-to-number (match-string 3 ans))
  15025. day (string-to-number (match-string 4 ans)))
  15026. (if (< year 100) (setq year (+ 2000 year)))
  15027. (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
  15028. t nil ans)))
  15029. ;; Help matching dotted european dates
  15030. (when (string-match
  15031. "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\.\\( ?[1-9][0-9]\\{3\\}\\)?" ans)
  15032. (setq year (if (match-end 3) (string-to-number (match-string 3 ans))
  15033. (setq kill-year t)
  15034. (string-to-number (format-time-string "%Y")))
  15035. day (string-to-number (match-string 1 ans))
  15036. month (string-to-number (match-string 2 ans))
  15037. ans (replace-match (format "%04d-%02d-%02d" year month day)
  15038. t nil ans)))
  15039. ;; Help matching american dates, like 5/30 or 5/30/7
  15040. (when (string-match
  15041. "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
  15042. (setq year (if (match-end 4)
  15043. (string-to-number (match-string 4 ans))
  15044. (progn (setq kill-year t)
  15045. (string-to-number (format-time-string "%Y"))))
  15046. month (string-to-number (match-string 1 ans))
  15047. day (string-to-number (match-string 2 ans)))
  15048. (if (< year 100) (setq year (+ 2000 year)))
  15049. (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
  15050. t nil ans)))
  15051. ;; Help matching am/pm times, because `parse-time-string' does not do that.
  15052. ;; If there is a time with am/pm, and *no* time without it, we convert
  15053. ;; so that matching will be successful.
  15054. (loop for i from 1 to 2 do ; twice, for end time as well
  15055. (when (and (not (string-match "\\(\\`\\|[^+]\\)[012]?[0-9]:[0-9][0-9]\\([ \t\n]\\|$\\)" ans))
  15056. (string-match "\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\(am\\|AM\\|pm\\|PM\\)\\>" ans))
  15057. (setq hour (string-to-number (match-string 1 ans))
  15058. minute (if (match-end 3)
  15059. (string-to-number (match-string 3 ans))
  15060. 0)
  15061. pm (equal ?p
  15062. (string-to-char (downcase (match-string 4 ans)))))
  15063. (if (and (= hour 12) (not pm))
  15064. (setq hour 0)
  15065. (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
  15066. (setq ans (replace-match (format "%02d:%02d" hour minute)
  15067. t t ans))))
  15068. ;; Check if a time range is given as a duration
  15069. (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
  15070. (setq hour (string-to-number (match-string 1 ans))
  15071. h2 (+ hour (string-to-number (match-string 3 ans)))
  15072. minute (string-to-number (match-string 2 ans))
  15073. m2 (+ minute (if (match-end 5) (string-to-number
  15074. (match-string 5 ans))0)))
  15075. (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
  15076. (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
  15077. t t ans)))
  15078. ;; Check if there is a time range
  15079. (when (boundp 'org-end-time-was-given)
  15080. (setq org-time-was-given nil)
  15081. (when (and (string-match org-plain-time-of-day-regexp ans)
  15082. (match-end 8))
  15083. (setq org-end-time-was-given (match-string 8 ans))
  15084. (setq ans (concat (substring ans 0 (match-beginning 7))
  15085. (substring ans (match-end 7))))))
  15086. (setq tl (parse-time-string ans)
  15087. day (or (nth 3 tl) (nth 3 org-defdecode))
  15088. month (or (nth 4 tl)
  15089. (if (and org-read-date-prefer-future
  15090. (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
  15091. (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
  15092. (nth 4 org-defdecode)))
  15093. year (or (and (not kill-year) (nth 5 tl))
  15094. (if (and org-read-date-prefer-future
  15095. (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
  15096. (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
  15097. (nth 5 org-defdecode)))
  15098. hour (or (nth 2 tl) (nth 2 org-defdecode))
  15099. minute (or (nth 1 tl) (nth 1 org-defdecode))
  15100. second (or (nth 0 tl) 0)
  15101. wday (nth 6 tl))
  15102. (when (and (eq org-read-date-prefer-future 'time)
  15103. (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
  15104. (equal day (nth 3 nowdecode))
  15105. (equal month (nth 4 nowdecode))
  15106. (equal year (nth 5 nowdecode))
  15107. (nth 2 tl)
  15108. (or (< (nth 2 tl) (nth 2 nowdecode))
  15109. (and (= (nth 2 tl) (nth 2 nowdecode))
  15110. (nth 1 tl)
  15111. (< (nth 1 tl) (nth 1 nowdecode)))))
  15112. (setq day (1+ day)
  15113. futurep t))
  15114. ;; Special date definitions below
  15115. (cond
  15116. (iso-week
  15117. ;; There was an iso week
  15118. (require 'cal-iso)
  15119. (setq futurep nil)
  15120. (setq year (or iso-year year)
  15121. day (or iso-weekday wday 1)
  15122. wday nil ; to make sure that the trigger below does not match
  15123. iso-date (calendar-gregorian-from-absolute
  15124. (calendar-absolute-from-iso
  15125. (list iso-week day year))))
  15126. ; FIXME: Should we also push ISO weeks into the future?
  15127. ; (when (and org-read-date-prefer-future
  15128. ; (not iso-year)
  15129. ; (< (calendar-absolute-from-gregorian iso-date)
  15130. ; (time-to-days (current-time))))
  15131. ; (setq year (1+ year)
  15132. ; iso-date (calendar-gregorian-from-absolute
  15133. ; (calendar-absolute-from-iso
  15134. ; (list iso-week day year)))))
  15135. (setq month (car iso-date)
  15136. year (nth 2 iso-date)
  15137. day (nth 1 iso-date)))
  15138. (deltan
  15139. (setq futurep nil)
  15140. (unless deltadef
  15141. (let ((now (decode-time (current-time))))
  15142. (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
  15143. (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
  15144. ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
  15145. ((equal deltaw "m") (setq month (+ month deltan)))
  15146. ((equal deltaw "y") (setq year (+ year deltan)))))
  15147. ((and wday (not (nth 3 tl)))
  15148. ;; Weekday was given, but no day, so pick that day in the week
  15149. ;; on or after the derived date.
  15150. (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
  15151. (unless (equal wday wday1)
  15152. (setq day (+ day (% (- wday wday1 -7) 7))))))
  15153. (if (and (boundp 'org-time-was-given)
  15154. (nth 2 tl))
  15155. (setq org-time-was-given t))
  15156. (if (< year 100) (setq year (+ 2000 year)))
  15157. ;; Check of the date is representable
  15158. (if org-read-date-force-compatible-dates
  15159. (progn
  15160. (if (< year 1970)
  15161. (setq year 1970 org-read-date-analyze-forced-year t))
  15162. (if (> year 2037)
  15163. (setq year 2037 org-read-date-analyze-forced-year t)))
  15164. (condition-case nil
  15165. (ignore (encode-time second minute hour day month year))
  15166. (error
  15167. (setq year (nth 5 org-defdecode))
  15168. (setq org-read-date-analyze-forced-year t))))
  15169. (setq org-read-date-analyze-futurep futurep)
  15170. (list second minute hour day month year)))
  15171. (defvar parse-time-weekdays)
  15172. (defun org-read-date-get-relative (s today default)
  15173. "Check string S for special relative date string.
  15174. TODAY and DEFAULT are internal times, for today and for a default.
  15175. Return shift list (N what def-flag)
  15176. WHAT is \"d\", \"w\", \"m\", or \"y\" for day, week, month, year.
  15177. N is the number of WHATs to shift.
  15178. DEF-FLAG is t when a double ++ or -- indicates shift relative to
  15179. the DEFAULT date rather than TODAY."
  15180. (require 'parse-time)
  15181. (when (and
  15182. (string-match
  15183. (concat
  15184. "\\`[ \t]*\\([-+]\\{0,2\\}\\)"
  15185. "\\([0-9]+\\)?"
  15186. "\\([hdwmy]\\|\\(" (mapconcat 'car parse-time-weekdays "\\|") "\\)\\)?"
  15187. "\\([ \t]\\|$\\)") s)
  15188. (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
  15189. (let* ((dir (if (> (match-end 1) (match-beginning 1))
  15190. (string-to-char (substring (match-string 1 s) -1))
  15191. ?+))
  15192. (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
  15193. (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
  15194. (what (if (match-end 3) (match-string 3 s) "d"))
  15195. (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
  15196. (date (if rel default today))
  15197. (wday (nth 6 (decode-time date)))
  15198. delta)
  15199. (if wday1
  15200. (progn
  15201. (setq delta (mod (+ 7 (- wday1 wday)) 7))
  15202. (if (= delta 0) (setq delta 7))
  15203. (if (= dir ?-)
  15204. (progn
  15205. (setq delta (- delta 7))
  15206. (if (= delta 0) (setq delta -7))))
  15207. (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
  15208. (list delta "d" rel))
  15209. (list (* n (if (= dir ?-) -1 1)) what rel)))))
  15210. (defun org-order-calendar-date-args (arg1 arg2 arg3)
  15211. "Turn a user-specified date into the internal representation.
  15212. The internal representation needed by the calendar is (month day year).
  15213. This is a wrapper to handle the brain-dead convention in calendar that
  15214. user function argument order change dependent on argument order."
  15215. (if (boundp 'calendar-date-style)
  15216. (cond
  15217. ((eq calendar-date-style 'american)
  15218. (list arg1 arg2 arg3))
  15219. ((eq calendar-date-style 'european)
  15220. (list arg2 arg1 arg3))
  15221. ((eq calendar-date-style 'iso)
  15222. (list arg2 arg3 arg1)))
  15223. (org-no-warnings ;; european-calendar-style is obsolete as of version 23.1
  15224. (if (org-bound-and-true-p european-calendar-style)
  15225. (list arg2 arg1 arg3)
  15226. (list arg1 arg2 arg3)))))
  15227. (defun org-eval-in-calendar (form &optional keepdate)
  15228. "Eval FORM in the calendar window and return to current window.
  15229. When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
  15230. otherwise stick to the current value of `org-ans2'."
  15231. (let ((sf (selected-frame))
  15232. (sw (selected-window)))
  15233. (select-window (get-buffer-window "*Calendar*" t))
  15234. (eval form)
  15235. (when (and (not keepdate) (calendar-cursor-to-date))
  15236. (let* ((date (calendar-cursor-to-date))
  15237. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  15238. (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
  15239. (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
  15240. (select-window sw)
  15241. (org-select-frame-set-input-focus sf)))
  15242. (defun org-calendar-select ()
  15243. "Return to `org-read-date' with the date currently selected.
  15244. This is used by `org-read-date' in a temporary keymap for the calendar buffer."
  15245. (interactive)
  15246. (when (calendar-cursor-to-date)
  15247. (let* ((date (calendar-cursor-to-date))
  15248. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  15249. (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
  15250. (if (active-minibuffer-window) (exit-minibuffer))))
  15251. (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
  15252. "Insert a date stamp for the date given by the internal TIME.
  15253. WITH-HM means use the stamp format that includes the time of the day.
  15254. INACTIVE means use square brackets instead of angular ones, so that the
  15255. stamp will not contribute to the agenda.
  15256. PRE and POST are optional strings to be inserted before and after the
  15257. stamp.
  15258. The command returns the inserted time stamp."
  15259. (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
  15260. stamp)
  15261. (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
  15262. (insert-before-markers (or pre ""))
  15263. (when (listp extra)
  15264. (setq extra (car extra))
  15265. (if (and (stringp extra)
  15266. (string-match "\\([0-9]+\\):\\([0-9]+\\)" extra))
  15267. (setq extra (format "-%02d:%02d"
  15268. (string-to-number (match-string 1 extra))
  15269. (string-to-number (match-string 2 extra))))
  15270. (setq extra nil)))
  15271. (when extra
  15272. (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
  15273. (insert-before-markers (setq stamp (format-time-string fmt time)))
  15274. (insert-before-markers (or post ""))
  15275. (setq org-last-inserted-timestamp stamp)))
  15276. (defun org-toggle-time-stamp-overlays ()
  15277. "Toggle the use of custom time stamp formats."
  15278. (interactive)
  15279. (setq org-display-custom-times (not org-display-custom-times))
  15280. (unless org-display-custom-times
  15281. (let ((p (point-min)) (bmp (buffer-modified-p)))
  15282. (while (setq p (next-single-property-change p 'display))
  15283. (if (and (get-text-property p 'display)
  15284. (eq (get-text-property p 'face) 'org-date))
  15285. (remove-text-properties
  15286. p (setq p (next-single-property-change p 'display))
  15287. '(display t))))
  15288. (set-buffer-modified-p bmp)))
  15289. (if (featurep 'xemacs)
  15290. (remove-text-properties (point-min) (point-max) '(end-glyph t)))
  15291. (org-restart-font-lock)
  15292. (setq org-table-may-need-update t)
  15293. (if org-display-custom-times
  15294. (message "Time stamps are overlaid with custom format")
  15295. (message "Time stamp overlays removed")))
  15296. (defun org-display-custom-time (beg end)
  15297. "Overlay modified time stamp format over timestamp between BEG and END."
  15298. (let* ((ts (buffer-substring beg end))
  15299. t1 w1 with-hm tf time str w2 (off 0))
  15300. (save-match-data
  15301. (setq t1 (org-parse-time-string ts t))
  15302. (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
  15303. (setq off (- (match-end 0) (match-beginning 0)))))
  15304. (setq end (- end off))
  15305. (setq w1 (- end beg)
  15306. with-hm (and (nth 1 t1) (nth 2 t1))
  15307. tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
  15308. time (org-fix-decoded-time t1)
  15309. str (org-add-props
  15310. (format-time-string
  15311. (substring tf 1 -1) (apply 'encode-time time))
  15312. nil 'mouse-face 'highlight)
  15313. w2 (length str))
  15314. (if (not (= w2 w1))
  15315. (add-text-properties (1+ beg) (+ 2 beg)
  15316. (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
  15317. (if (featurep 'xemacs)
  15318. (progn
  15319. (put-text-property beg end 'invisible t)
  15320. (put-text-property beg end 'end-glyph (make-glyph str)))
  15321. (put-text-property beg end 'display str))))
  15322. (defun org-translate-time (string)
  15323. "Translate all timestamps in STRING to custom format.
  15324. But do this only if the variable `org-display-custom-times' is set."
  15325. (when org-display-custom-times
  15326. (save-match-data
  15327. (let* ((start 0)
  15328. (re org-ts-regexp-both)
  15329. t1 with-hm inactive tf time str beg end)
  15330. (while (setq start (string-match re string start))
  15331. (setq beg (match-beginning 0)
  15332. end (match-end 0)
  15333. t1 (save-match-data
  15334. (org-parse-time-string (substring string beg end) t))
  15335. with-hm (and (nth 1 t1) (nth 2 t1))
  15336. inactive (equal (substring string beg (1+ beg)) "[")
  15337. tf (funcall (if with-hm 'cdr 'car)
  15338. org-time-stamp-custom-formats)
  15339. time (org-fix-decoded-time t1)
  15340. str (format-time-string
  15341. (concat
  15342. (if inactive "[" "<") (substring tf 1 -1)
  15343. (if inactive "]" ">"))
  15344. (apply 'encode-time time))
  15345. string (replace-match str t t string)
  15346. start (+ start (length str)))))))
  15347. string)
  15348. (defun org-fix-decoded-time (time)
  15349. "Set 0 instead of nil for the first 6 elements of time.
  15350. Don't touch the rest."
  15351. (let ((n 0))
  15352. (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
  15353. (define-obsolete-function-alias 'org-days-to-time 'org-time-stamp-to-now "24.4")
  15354. (defun org-time-stamp-to-now (timestamp-string &optional seconds)
  15355. "Difference between TIMESTAMP-STRING and now in days.
  15356. If SECONDS is non-nil, return the difference in seconds."
  15357. (let ((fdiff (if seconds 'org-float-time 'time-to-days)))
  15358. (- (funcall fdiff (org-time-string-to-time timestamp-string))
  15359. (funcall fdiff (current-time)))))
  15360. (defun org-deadline-close (timestamp-string &optional ndays)
  15361. "Is the time in TIMESTAMP-STRING close to the current date?"
  15362. (setq ndays (or ndays (org-get-wdays timestamp-string)))
  15363. (and (< (org-time-stamp-to-now timestamp-string) ndays)
  15364. (not (org-entry-is-done-p))))
  15365. (defun org-get-wdays (ts &optional delay zero-delay)
  15366. "Get the deadline lead time appropriate for timestring TS.
  15367. When DELAY is non-nil, get the delay time for scheduled items
  15368. instead of the deadline lead time. When ZERO-DELAY is non-nil
  15369. and `org-scheduled-delay-days' is 0, enforce 0 as the delay,
  15370. don't try to find the delay cookie in the scheduled timestamp."
  15371. (let ((tv (if delay org-scheduled-delay-days
  15372. org-deadline-warning-days)))
  15373. (cond
  15374. ((or (and delay (< tv 0))
  15375. (and delay zero-delay (<= tv 0))
  15376. (and (not delay) (<= tv 0)))
  15377. ;; Enforce this value no matter what
  15378. (- tv))
  15379. ((string-match "-\\([0-9]+\\)\\([hdwmy]\\)\\(\\'\\|>\\| \\)" ts)
  15380. ;; lead time is specified.
  15381. (floor (* (string-to-number (match-string 1 ts))
  15382. (cdr (assoc (match-string 2 ts)
  15383. '(("d" . 1) ("w" . 7)
  15384. ("m" . 30.4) ("y" . 365.25)
  15385. ("h" . 0.041667)))))))
  15386. ;; go for the default.
  15387. (t tv))))
  15388. (defun org-calendar-select-mouse (ev)
  15389. "Return to `org-read-date' with the date currently selected.
  15390. This is used by `org-read-date' in a temporary keymap for the calendar buffer."
  15391. (interactive "e")
  15392. (mouse-set-point ev)
  15393. (when (calendar-cursor-to-date)
  15394. (let* ((date (calendar-cursor-to-date))
  15395. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  15396. (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
  15397. (if (active-minibuffer-window) (exit-minibuffer))))
  15398. (defun org-check-deadlines (ndays)
  15399. "Check if there are any deadlines due or past due.
  15400. A deadline is considered due if it happens within `org-deadline-warning-days'
  15401. days from today's date. If the deadline appears in an entry marked DONE,
  15402. it is not shown. The prefix arg NDAYS can be used to test that many
  15403. days. If the prefix is a raw \\[universal-argument] prefix, all deadlines are shown."
  15404. (interactive "P")
  15405. (let* ((org-warn-days
  15406. (cond
  15407. ((equal ndays '(4)) 100000)
  15408. (ndays (prefix-numeric-value ndays))
  15409. (t (abs org-deadline-warning-days))))
  15410. (case-fold-search nil)
  15411. (regexp (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
  15412. (callback
  15413. (lambda () (org-deadline-close (match-string 1) org-warn-days))))
  15414. (message "%d deadlines past-due or due within %d days"
  15415. (org-occur regexp nil callback)
  15416. org-warn-days)))
  15417. (defsubst org-re-timestamp (type)
  15418. "Return a regexp for timestamp TYPE.
  15419. Allowed values for TYPE are:
  15420. all: all timestamps
  15421. active: only active timestamps (<...>)
  15422. inactive: only inactive timestamps ([...])
  15423. scheduled: only scheduled timestamps
  15424. deadline: only deadline timestamps
  15425. closed: only closed time-stamps
  15426. When TYPE is nil, fall back on returning a regexp that matches
  15427. both scheduled and deadline timestamps."
  15428. (cond ((eq type 'all) "\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}\\(?: +[^]+0-9> \n -]+\\)?\\(?: +[0-9]\\{1,2\\}:[0-9]\\{2\\}\\)?\\)")
  15429. ((eq type 'active) org-ts-regexp)
  15430. ((eq type 'inactive) "\\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^ \n>]*?\\)\\]")
  15431. ((eq type 'scheduled) (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>"))
  15432. ((eq type 'deadline) (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
  15433. ((eq type 'closed) (concat org-closed-string " \\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^ \n>]*?\\)\\]"))
  15434. ((eq type 'scheduled-or-deadline)
  15435. (concat "\\<\\(?:" org-deadline-string "\\|" org-scheduled-string "\\) *<\\([^>]+\\)>"))))
  15436. (defun org-check-before-date (date)
  15437. "Check if there are deadlines or scheduled entries before DATE."
  15438. (interactive (list (org-read-date)))
  15439. (let ((case-fold-search nil)
  15440. (regexp (org-re-timestamp org-ts-type))
  15441. (callback
  15442. (lambda () (time-less-p
  15443. (org-time-string-to-time (match-string 1))
  15444. (org-time-string-to-time date)))))
  15445. (message "%d entries before %s"
  15446. (org-occur regexp nil callback) date)))
  15447. (defun org-check-after-date (date)
  15448. "Check if there are deadlines or scheduled entries after DATE."
  15449. (interactive (list (org-read-date)))
  15450. (let ((case-fold-search nil)
  15451. (regexp (org-re-timestamp org-ts-type))
  15452. (callback
  15453. (lambda () (not
  15454. (time-less-p
  15455. (org-time-string-to-time (match-string 1))
  15456. (org-time-string-to-time date))))))
  15457. (message "%d entries after %s"
  15458. (org-occur regexp nil callback) date)))
  15459. (defun org-check-dates-range (start-date end-date)
  15460. "Check for deadlines/scheduled entries between START-DATE and END-DATE."
  15461. (interactive (list (org-read-date nil nil nil "Range starts")
  15462. (org-read-date nil nil nil "Range end")))
  15463. (let ((case-fold-search nil)
  15464. (regexp (org-re-timestamp org-ts-type))
  15465. (callback
  15466. (lambda ()
  15467. (let ((match (match-string 1)))
  15468. (and
  15469. (not (time-less-p
  15470. (org-time-string-to-time match)
  15471. (org-time-string-to-time start-date)))
  15472. (time-less-p
  15473. (org-time-string-to-time match)
  15474. (org-time-string-to-time end-date)))))))
  15475. (message "%d entries between %s and %s"
  15476. (org-occur regexp nil callback) start-date end-date)))
  15477. (defun org-evaluate-time-range (&optional to-buffer)
  15478. "Evaluate a time range by computing the difference between start and end.
  15479. Normally the result is just printed in the echo area, but with prefix arg
  15480. TO-BUFFER, the result is inserted just after the date stamp into the buffer.
  15481. If the time range is actually in a table, the result is inserted into the
  15482. next column.
  15483. For time difference computation, a year is assumed to be exactly 365
  15484. days in order to avoid rounding problems."
  15485. (interactive "P")
  15486. (or
  15487. (org-clock-update-time-maybe)
  15488. (save-excursion
  15489. (unless (org-at-date-range-p t)
  15490. (goto-char (point-at-bol))
  15491. (re-search-forward org-tr-regexp-both (point-at-eol) t))
  15492. (if (not (org-at-date-range-p t))
  15493. (user-error "Not at a time-stamp range, and none found in current line")))
  15494. (let* ((ts1 (match-string 1))
  15495. (ts2 (match-string 2))
  15496. (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
  15497. (match-end (match-end 0))
  15498. (time1 (org-time-string-to-time ts1))
  15499. (time2 (org-time-string-to-time ts2))
  15500. (t1 (org-float-time time1))
  15501. (t2 (org-float-time time2))
  15502. (diff (abs (- t2 t1)))
  15503. (negative (< (- t2 t1) 0))
  15504. ;; (ys (floor (* 365 24 60 60)))
  15505. (ds (* 24 60 60))
  15506. (hs (* 60 60))
  15507. (fy "%dy %dd %02d:%02d")
  15508. (fy1 "%dy %dd")
  15509. (fd "%dd %02d:%02d")
  15510. (fd1 "%dd")
  15511. (fh "%02d:%02d")
  15512. y d h m align)
  15513. (if havetime
  15514. (setq ; y (floor (/ diff ys)) diff (mod diff ys)
  15515. y 0
  15516. d (floor (/ diff ds)) diff (mod diff ds)
  15517. h (floor (/ diff hs)) diff (mod diff hs)
  15518. m (floor (/ diff 60)))
  15519. (setq ; y (floor (/ diff ys)) diff (mod diff ys)
  15520. y 0
  15521. d (floor (+ (/ diff ds) 0.5))
  15522. h 0 m 0))
  15523. (if (not to-buffer)
  15524. (message "%s" (org-make-tdiff-string y d h m))
  15525. (if (org-at-table-p)
  15526. (progn
  15527. (goto-char match-end)
  15528. (setq align t)
  15529. (and (looking-at " *|") (goto-char (match-end 0))))
  15530. (goto-char match-end))
  15531. (if (looking-at
  15532. "\\( *-? *[0-9]+y\\)?\\( *[0-9]+d\\)? *[0-9][0-9]:[0-9][0-9]")
  15533. (replace-match ""))
  15534. (if negative (insert " -"))
  15535. (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
  15536. (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
  15537. (insert " " (format fh h m))))
  15538. (if align (org-table-align))
  15539. (message "Time difference inserted")))))
  15540. (defun org-make-tdiff-string (y d h m)
  15541. (let ((fmt "")
  15542. (l nil))
  15543. (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
  15544. l (push y l)))
  15545. (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
  15546. l (push d l)))
  15547. (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
  15548. l (push h l)))
  15549. (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
  15550. l (push m l)))
  15551. (apply 'format fmt (nreverse l))))
  15552. (defun org-time-string-to-time (s &optional buffer pos)
  15553. "Convert a timestamp string into internal time."
  15554. (condition-case errdata
  15555. (apply 'encode-time (org-parse-time-string s))
  15556. (error (error "Bad timestamp `%s'%s\nError was: %s"
  15557. s (if (not (and buffer pos))
  15558. ""
  15559. (format " at %d in buffer `%s'" pos buffer))
  15560. (cdr errdata)))))
  15561. (defun org-time-string-to-seconds (s)
  15562. "Convert a timestamp string to a number of seconds."
  15563. (org-float-time (org-time-string-to-time s)))
  15564. (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
  15565. "Convert a time stamp to an absolute day number.
  15566. If there is a specifier for a cyclic time stamp, get the closest
  15567. date to DAYNR.
  15568. PREFER and SHOW-ALL are passed through to `org-closest-date'.
  15569. The variable `date' is bound by the calendar when this is called."
  15570. (cond
  15571. ((and daynr (string-match "\\`%%\\((.*)\\)" s))
  15572. (if (org-diary-sexp-entry (match-string 1 s) "" date)
  15573. daynr
  15574. (+ daynr 1000)))
  15575. ((and daynr (string-match "\\+[0-9]+[hdwmy]" s))
  15576. (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
  15577. (time-to-days (current-time))) (match-string 0 s)
  15578. prefer show-all))
  15579. (t (time-to-days
  15580. (condition-case errdata
  15581. (apply 'encode-time (org-parse-time-string s))
  15582. (error (error "Bad timestamp `%s'%s\nError was: %s"
  15583. s (if (not (and buffer pos))
  15584. ""
  15585. (format " at %d in buffer `%s'" pos buffer))
  15586. (cdr errdata))))))))
  15587. (defun org-days-to-iso-week (days)
  15588. "Return the iso week number."
  15589. (require 'cal-iso)
  15590. (car (calendar-iso-from-absolute days)))
  15591. (defun org-small-year-to-year (year)
  15592. "Convert 2-digit years into 4-digit years.
  15593. 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2037.
  15594. The year 2000 cannot be abbreviated. Any year larger than 99
  15595. is returned unchanged."
  15596. (if (< year 38)
  15597. (setq year (+ 2000 year))
  15598. (if (< year 100)
  15599. (setq year (+ 1900 year))))
  15600. year)
  15601. (defun org-time-from-absolute (d)
  15602. "Return the time corresponding to date D.
  15603. D may be an absolute day number, or a calendar-type list (month day year)."
  15604. (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
  15605. (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
  15606. (defun org-calendar-holiday ()
  15607. "List of holidays, for Diary display in Org-mode."
  15608. (require 'holidays)
  15609. (let ((hl (funcall
  15610. (if (fboundp 'calendar-check-holidays)
  15611. 'calendar-check-holidays 'check-calendar-holidays) date)))
  15612. (if hl (mapconcat 'identity hl "; "))))
  15613. (defun org-diary-sexp-entry (sexp entry date)
  15614. "Process a SEXP diary ENTRY for DATE."
  15615. (require 'diary-lib)
  15616. (let ((result (if calendar-debug-sexp
  15617. (let ((stack-trace-on-error t))
  15618. (eval (car (read-from-string sexp))))
  15619. (condition-case nil
  15620. (eval (car (read-from-string sexp)))
  15621. (error
  15622. (beep)
  15623. (message "Bad sexp at line %d in %s: %s"
  15624. (org-current-line)
  15625. (buffer-file-name) sexp)
  15626. (sleep-for 2))))))
  15627. (cond ((stringp result) (split-string result "; "))
  15628. ((and (consp result)
  15629. (not (consp (cdr result)))
  15630. (stringp (cdr result))) (cdr result))
  15631. ((and (consp result)
  15632. (stringp (car result))) result)
  15633. (result entry))))
  15634. (defun org-diary-to-ical-string (frombuf)
  15635. "Get iCalendar entries from diary entries in buffer FROMBUF.
  15636. This uses the icalendar.el library."
  15637. (let* ((tmpdir (if (featurep 'xemacs)
  15638. (temp-directory)
  15639. temporary-file-directory))
  15640. (tmpfile (make-temp-name
  15641. (expand-file-name "orgics" tmpdir)))
  15642. buf rtn b e)
  15643. (with-current-buffer frombuf
  15644. (icalendar-export-region (point-min) (point-max) tmpfile)
  15645. (setq buf (find-buffer-visiting tmpfile))
  15646. (set-buffer buf)
  15647. (goto-char (point-min))
  15648. (if (re-search-forward "^BEGIN:VEVENT" nil t)
  15649. (setq b (match-beginning 0)))
  15650. (goto-char (point-max))
  15651. (if (re-search-backward "^END:VEVENT" nil t)
  15652. (setq e (match-end 0)))
  15653. (setq rtn (if (and b e) (concat (buffer-substring b e) "\n") "")))
  15654. (kill-buffer buf)
  15655. (delete-file tmpfile)
  15656. rtn))
  15657. (defun org-closest-date (start current change prefer show-all)
  15658. "Find the date closest to CURRENT that is consistent with START and CHANGE.
  15659. When PREFER is `past', return a date that is either CURRENT or past.
  15660. When PREFER is `future', return a date that is either CURRENT or future.
  15661. When SHOW-ALL is nil, only return the current occurrence of a time stamp."
  15662. ;; Make the proper lists from the dates
  15663. (catch 'exit
  15664. (let ((a1 '(("h" . hour)
  15665. ("d" . day)
  15666. ("w" . week)
  15667. ("m" . month)
  15668. ("y" . year)))
  15669. (shour (nth 2 (org-parse-time-string start)))
  15670. dn dw sday cday n1 n2 n0
  15671. d m y y1 y2 date1 date2 nmonths nm ny m2)
  15672. (setq start (org-date-to-gregorian start)
  15673. current (org-date-to-gregorian
  15674. (if show-all
  15675. current
  15676. (time-to-days (current-time))))
  15677. sday (calendar-absolute-from-gregorian start)
  15678. cday (calendar-absolute-from-gregorian current))
  15679. (if (<= cday sday) (throw 'exit sday))
  15680. (if (string-match "\\(\\+[0-9]+\\)\\([hdwmy]\\)" change)
  15681. (setq dn (string-to-number (match-string 1 change))
  15682. dw (cdr (assoc (match-string 2 change) a1)))
  15683. (user-error "Invalid change specifier: %s" change))
  15684. (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
  15685. (cond
  15686. ((eq dw 'hour)
  15687. (let ((missing-hours
  15688. (mod (+ (- (* 24 (- cday sday)) shour) org-extend-today-until)
  15689. dn)))
  15690. (setq n1 (if (zerop missing-hours) cday
  15691. (- cday (1+ (floor (/ missing-hours 24)))))
  15692. n2 (+ cday (floor (/ (- dn missing-hours) 24))))))
  15693. ((eq dw 'day)
  15694. (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
  15695. n2 (+ n1 dn)))
  15696. ((eq dw 'year)
  15697. (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
  15698. (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
  15699. (setq date1 (list m d y1)
  15700. n1 (calendar-absolute-from-gregorian date1)
  15701. date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
  15702. n2 (calendar-absolute-from-gregorian date2)))
  15703. ((eq dw 'month)
  15704. ;; approx number of month between the two dates
  15705. (setq nmonths (floor (/ (- cday sday) 30.436875)))
  15706. ;; How often does dn fit in there?
  15707. (setq d (nth 1 start) m (car start) y (nth 2 start)
  15708. nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
  15709. m (+ m nm)
  15710. ny (floor (/ m 12))
  15711. y (+ y ny)
  15712. m (- m (* ny 12)))
  15713. (while (> m 12) (setq m (- m 12) y (1+ y)))
  15714. (setq n1 (calendar-absolute-from-gregorian (list m d y)))
  15715. (setq m2 (+ m dn) y2 y)
  15716. (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
  15717. (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
  15718. (while (<= n2 cday)
  15719. (setq n1 n2 m m2 y y2)
  15720. (setq m2 (+ m dn) y2 y)
  15721. (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
  15722. (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
  15723. ;; Make sure n1 is the earlier date
  15724. (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
  15725. (if show-all
  15726. (cond
  15727. ((eq prefer 'past) (if (= cday n2) n2 n1))
  15728. ((eq prefer 'future) (if (= cday n1) n1 n2))
  15729. (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
  15730. (cond
  15731. ((eq prefer 'past) (if (= cday n2) n2 n1))
  15732. ((eq prefer 'future) (if (= cday n1) n1 n2))
  15733. (t (if (= cday n1) n1 n2)))))))
  15734. (defun org-date-to-gregorian (date)
  15735. "Turn any specification of DATE into a Gregorian date for the calendar."
  15736. (cond ((integerp date) (calendar-gregorian-from-absolute date))
  15737. ((and (listp date) (= (length date) 3)) date)
  15738. ((stringp date)
  15739. (setq date (org-parse-time-string date))
  15740. (list (nth 4 date) (nth 3 date) (nth 5 date)))
  15741. ((listp date)
  15742. (list (nth 4 date) (nth 3 date) (nth 5 date)))))
  15743. (defun org-parse-time-string (s &optional nodefault)
  15744. "Parse the standard Org-mode time string.
  15745. This should be a lot faster than the normal `parse-time-string'.
  15746. If time is not given, defaults to 0:00. However, with optional NODEFAULT,
  15747. hour and minute fields will be nil if not given."
  15748. (cond ((string-match org-ts-regexp0 s)
  15749. (list 0
  15750. (if (or (match-beginning 8) (not nodefault))
  15751. (string-to-number (or (match-string 8 s) "0")))
  15752. (if (or (match-beginning 7) (not nodefault))
  15753. (string-to-number (or (match-string 7 s) "0")))
  15754. (string-to-number (match-string 4 s))
  15755. (string-to-number (match-string 3 s))
  15756. (string-to-number (match-string 2 s))
  15757. nil nil nil))
  15758. ((string-match "^<[^>]+>$" s)
  15759. (decode-time (seconds-to-time (org-matcher-time s))))
  15760. (t (error "Not a standard Org-mode time string: %s" s))))
  15761. (defun org-timestamp-up (&optional arg)
  15762. "Increase the date item at the cursor by one.
  15763. If the cursor is on the year, change the year. If it is on the month,
  15764. the day or the time, change that.
  15765. With prefix ARG, change by that many units."
  15766. (interactive "p")
  15767. (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
  15768. (defun org-timestamp-down (&optional arg)
  15769. "Decrease the date item at the cursor by one.
  15770. If the cursor is on the year, change the year. If it is on the month,
  15771. the day or the time, change that.
  15772. With prefix ARG, change by that many units."
  15773. (interactive "p")
  15774. (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
  15775. (defun org-timestamp-up-day (&optional arg)
  15776. "Increase the date in the time stamp by one day.
  15777. With prefix ARG, change that many days."
  15778. (interactive "p")
  15779. (if (and (not (org-at-timestamp-p t))
  15780. (org-at-heading-p))
  15781. (org-todo 'up)
  15782. (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
  15783. (defun org-timestamp-down-day (&optional arg)
  15784. "Decrease the date in the time stamp by one day.
  15785. With prefix ARG, change that many days."
  15786. (interactive "p")
  15787. (if (and (not (org-at-timestamp-p t))
  15788. (org-at-heading-p))
  15789. (org-todo 'down)
  15790. (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
  15791. (defun org-at-timestamp-p (&optional inactive-ok)
  15792. "Determine if the cursor is in or at a timestamp."
  15793. (interactive)
  15794. (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
  15795. (pos (point))
  15796. (ans (or (looking-at tsr)
  15797. (save-excursion
  15798. (skip-chars-backward "^[<\n\r\t")
  15799. (if (> (point) (point-min)) (backward-char 1))
  15800. (and (looking-at tsr)
  15801. (> (- (match-end 0) pos) -1))))))
  15802. (and ans
  15803. (boundp 'org-ts-what)
  15804. (setq org-ts-what
  15805. (cond
  15806. ((= pos (match-beginning 0)) 'bracket)
  15807. ;; Point is considered to be "on the bracket" whether
  15808. ;; it's really on it or right after it.
  15809. ((= pos (1- (match-end 0))) 'bracket)
  15810. ((= pos (match-end 0)) 'after)
  15811. ((org-pos-in-match-range pos 2) 'year)
  15812. ((org-pos-in-match-range pos 3) 'month)
  15813. ((org-pos-in-match-range pos 7) 'hour)
  15814. ((org-pos-in-match-range pos 8) 'minute)
  15815. ((or (org-pos-in-match-range pos 4)
  15816. (org-pos-in-match-range pos 5)) 'day)
  15817. ((and (> pos (or (match-end 8) (match-end 5)))
  15818. (< pos (match-end 0)))
  15819. (- pos (or (match-end 8) (match-end 5))))
  15820. (t 'day))))
  15821. ans))
  15822. (defun org-toggle-timestamp-type ()
  15823. "Toggle the type (<active> or [inactive]) of a time stamp."
  15824. (interactive)
  15825. (when (org-at-timestamp-p t)
  15826. (let ((beg (match-beginning 0)) (end (match-end 0))
  15827. (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
  15828. (save-excursion
  15829. (goto-char beg)
  15830. (while (re-search-forward "[][<>]" end t)
  15831. (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
  15832. t t)))
  15833. (message "Timestamp is now %sactive"
  15834. (if (equal (char-after beg) ?<) "" "in")))))
  15835. (defun org-at-clock-log-p nil
  15836. "Is the cursor on the clock log line?"
  15837. (save-excursion
  15838. (move-beginning-of-line 1)
  15839. (looking-at "^[ \t]*CLOCK:")))
  15840. (defvar org-clock-history) ; defined in org-clock.el
  15841. (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
  15842. (defun org-timestamp-change (n &optional what updown suppress-tmp-delay)
  15843. "Change the date in the time stamp at point.
  15844. The date will be changed by N times WHAT. WHAT can be `day', `month',
  15845. `year', `minute', `second'. If WHAT is not given, the cursor position
  15846. in the timestamp determines what will be changed.
  15847. When SUPPRESS-TMP-DELAY is non-nil, suppress delays like \"--2d\"."
  15848. (let ((origin (point)) origin-cat
  15849. with-hm inactive
  15850. (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
  15851. org-ts-what
  15852. extra rem
  15853. ts time time0 fixnext clrgx)
  15854. (if (not (org-at-timestamp-p t))
  15855. (user-error "Not at a timestamp"))
  15856. (if (and (not what) (eq org-ts-what 'bracket))
  15857. (org-toggle-timestamp-type)
  15858. ;; Point isn't on brackets. Remember the part of the time-stamp
  15859. ;; the point was in. Indeed, size of time-stamps may change,
  15860. ;; but point must be kept in the same category nonetheless.
  15861. (setq origin-cat org-ts-what)
  15862. (if (and (not what) (not (eq org-ts-what 'day))
  15863. org-display-custom-times
  15864. (get-text-property (point) 'display)
  15865. (not (get-text-property (1- (point)) 'display)))
  15866. (setq org-ts-what 'day))
  15867. (setq org-ts-what (or what org-ts-what)
  15868. inactive (= (char-after (match-beginning 0)) ?\[)
  15869. ts (match-string 0))
  15870. (replace-match "")
  15871. (when (string-match
  15872. "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?-?[-+][0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)*\\)[]>]"
  15873. ts)
  15874. (setq extra (match-string 1 ts))
  15875. (if suppress-tmp-delay
  15876. (setq extra (replace-regexp-in-string " --[0-9]+[hdwmy]" "" extra))))
  15877. (if (string-match "^.\\{10\\}.*?[0-9]+:[0-9][0-9]" ts)
  15878. (setq with-hm t))
  15879. (setq time0 (org-parse-time-string ts))
  15880. (when (and updown
  15881. (eq org-ts-what 'minute)
  15882. (not current-prefix-arg))
  15883. ;; This looks like s-up and s-down. Change by one rounding step.
  15884. (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
  15885. (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
  15886. (setcar (cdr time0) (+ (nth 1 time0)
  15887. (if (> n 0) (- rem) (- dm rem))))))
  15888. (setq time
  15889. (encode-time (or (car time0) 0)
  15890. (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
  15891. (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
  15892. (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
  15893. (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
  15894. (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
  15895. (nthcdr 6 time0)))
  15896. (when (and (member org-ts-what '(hour minute))
  15897. extra
  15898. (string-match "-\\([012][0-9]\\):\\([0-5][0-9]\\)" extra))
  15899. (setq extra (org-modify-ts-extra
  15900. extra
  15901. (if (eq org-ts-what 'hour) 2 5)
  15902. n dm)))
  15903. (when (integerp org-ts-what)
  15904. (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
  15905. (if (eq what 'calendar)
  15906. (let ((cal-date (org-get-date-from-calendar)))
  15907. (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
  15908. (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
  15909. (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
  15910. (setcar time0 (or (car time0) 0))
  15911. (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
  15912. (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
  15913. (setq time (apply 'encode-time time0))))
  15914. ;; Insert the new time-stamp, and ensure point stays in the same
  15915. ;; category as before (i.e. not after the last position in that
  15916. ;; category).
  15917. (let ((pos (point)))
  15918. ;; Stay before inserted string. `save-excursion' is of no use.
  15919. (setq org-last-changed-timestamp
  15920. (org-insert-time-stamp time with-hm inactive nil nil extra))
  15921. (goto-char pos))
  15922. (save-match-data
  15923. (looking-at org-ts-regexp3)
  15924. (goto-char (cond
  15925. ;; `day' category ends before `hour' if any, or at
  15926. ;; the end of the day name.
  15927. ((eq origin-cat 'day)
  15928. (min (or (match-beginning 7) (1- (match-end 5))) origin))
  15929. ((eq origin-cat 'hour) (min (match-end 7) origin))
  15930. ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
  15931. ((integerp origin-cat) (min (1- (match-end 0)) origin))
  15932. ;; `year' and `month' have both fixed size: point
  15933. ;; couldn't have moved into another part.
  15934. (t origin))))
  15935. ;; Update clock if on a CLOCK line.
  15936. (org-clock-update-time-maybe)
  15937. ;; Maybe adjust the closest clock in `org-clock-history'
  15938. (when org-clock-adjust-closest
  15939. (if (not (and (org-at-clock-log-p)
  15940. (< 1 (length (delq nil (mapcar 'marker-position
  15941. org-clock-history))))))
  15942. (message "No clock to adjust")
  15943. (cond ((save-excursion ; fix previous clock?
  15944. (re-search-backward org-ts-regexp0 nil t)
  15945. (org-looking-back (concat org-clock-string " \\[")))
  15946. (setq fixnext 1 clrgx (concat org-ts-regexp0 "\\] =>.*$")))
  15947. ((save-excursion ; fix next clock?
  15948. (re-search-backward org-ts-regexp0 nil t)
  15949. (looking-at (concat org-ts-regexp0 "\\] =>")))
  15950. (setq fixnext -1 clrgx (concat org-clock-string " \\[" org-ts-regexp0))))
  15951. (save-window-excursion
  15952. ;; Find closest clock to point, adjust the previous/next one in history
  15953. (let* ((p (save-excursion (org-back-to-heading t)))
  15954. (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
  15955. (clfixnth
  15956. (+ fixnext (- (length cl) (or (length (member (apply #'min cl) cl)) 100))))
  15957. (clfixpos (if (> 0 clfixnth) nil (nth clfixnth org-clock-history))))
  15958. (if (not clfixpos)
  15959. (message "No clock to adjust")
  15960. (save-excursion
  15961. (org-goto-marker-or-bmk clfixpos)
  15962. (org-show-subtree)
  15963. (when (re-search-forward clrgx nil t)
  15964. (goto-char (match-beginning 1))
  15965. (let (org-clock-adjust-closest)
  15966. (org-timestamp-change n org-ts-what updown))
  15967. (message "Clock adjusted in %s for heading: %s"
  15968. (file-name-nondirectory (buffer-file-name))
  15969. (org-get-heading t t)))))))))
  15970. ;; Try to recenter the calendar window, if any.
  15971. (if (and org-calendar-follow-timestamp-change
  15972. (get-buffer-window "*Calendar*" t)
  15973. (memq org-ts-what '(day month year)))
  15974. (org-recenter-calendar (time-to-days time))))))
  15975. (defun org-modify-ts-extra (s pos n dm)
  15976. "Change the different parts of the lead-time and repeat fields in timestamp."
  15977. (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
  15978. ng h m new rem)
  15979. (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
  15980. (cond
  15981. ((or (org-pos-in-match-range pos 2)
  15982. (org-pos-in-match-range pos 3))
  15983. (setq m (string-to-number (match-string 3 s))
  15984. h (string-to-number (match-string 2 s)))
  15985. (if (org-pos-in-match-range pos 2)
  15986. (setq h (+ h n))
  15987. (setq n (* dm (org-no-warnings (signum n))))
  15988. (when (not (= 0 (setq rem (% m dm))))
  15989. (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
  15990. (setq m (+ m n)))
  15991. (if (< m 0) (setq m (+ m 60) h (1- h)))
  15992. (if (> m 59) (setq m (- m 60) h (1+ h)))
  15993. (setq h (min 24 (max 0 h)))
  15994. (setq ng 1 new (format "-%02d:%02d" h m)))
  15995. ((org-pos-in-match-range pos 6)
  15996. (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
  15997. ((org-pos-in-match-range pos 5)
  15998. (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
  15999. ((org-pos-in-match-range pos 9)
  16000. (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
  16001. ((org-pos-in-match-range pos 8)
  16002. (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
  16003. (when ng
  16004. (setq s (concat
  16005. (substring s 0 (match-beginning ng))
  16006. new
  16007. (substring s (match-end ng))))))
  16008. s))
  16009. (defun org-recenter-calendar (date)
  16010. "If the calendar is visible, recenter it to DATE."
  16011. (let ((cwin (get-buffer-window "*Calendar*" t)))
  16012. (when cwin
  16013. (let ((calendar-move-hook nil))
  16014. (with-selected-window cwin
  16015. (calendar-goto-date (if (listp date) date
  16016. (calendar-gregorian-from-absolute date))))))))
  16017. (defun org-goto-calendar (&optional arg)
  16018. "Go to the Emacs calendar at the current date.
  16019. If there is a time stamp in the current line, go to that date.
  16020. A prefix ARG can be used to force the current date."
  16021. (interactive "P")
  16022. (let ((tsr org-ts-regexp) diff
  16023. (calendar-move-hook nil)
  16024. (calendar-view-holidays-initially-flag nil)
  16025. (calendar-view-diary-initially-flag nil))
  16026. (if (or (org-at-timestamp-p)
  16027. (save-excursion
  16028. (beginning-of-line 1)
  16029. (looking-at (concat ".*" tsr))))
  16030. (let ((d1 (time-to-days (current-time)))
  16031. (d2 (time-to-days
  16032. (org-time-string-to-time (match-string 1)))))
  16033. (setq diff (- d2 d1))))
  16034. (calendar)
  16035. (calendar-goto-today)
  16036. (if (and diff (not arg)) (calendar-forward-day diff))))
  16037. (defun org-get-date-from-calendar ()
  16038. "Return a list (month day year) of date at point in calendar."
  16039. (with-current-buffer "*Calendar*"
  16040. (save-match-data
  16041. (calendar-cursor-to-date))))
  16042. (defun org-date-from-calendar ()
  16043. "Insert time stamp corresponding to cursor date in *Calendar* buffer.
  16044. If there is already a time stamp at the cursor position, update it."
  16045. (interactive)
  16046. (if (org-at-timestamp-p t)
  16047. (org-timestamp-change 0 'calendar)
  16048. (let ((cal-date (org-get-date-from-calendar)))
  16049. (org-insert-time-stamp
  16050. (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
  16051. (defcustom org-effort-durations
  16052. `(("h" . 60)
  16053. ("d" . ,(* 60 8))
  16054. ("w" . ,(* 60 8 5))
  16055. ("m" . ,(* 60 8 5 4))
  16056. ("y" . ,(* 60 8 5 40)))
  16057. "Conversion factor to minutes for an effort modifier.
  16058. Each entry has the form (MODIFIER . MINUTES).
  16059. In an effort string, a number followed by MODIFIER is multiplied
  16060. by the specified number of MINUTES to obtain an effort in
  16061. minutes.
  16062. For example, if the value of this variable is ((\"hours\" . 60)), then an
  16063. effort string \"2hours\" is equivalent to 120 minutes."
  16064. :group 'org-agenda
  16065. :version "24.1"
  16066. :type '(alist :key-type (string :tag "Modifier")
  16067. :value-type (number :tag "Minutes")))
  16068. (defun org-minutes-to-clocksum-string (m)
  16069. "Format number of minutes as a clocksum string.
  16070. The format is determined by `org-time-clocksum-format',
  16071. `org-time-clocksum-use-fractional' and
  16072. `org-time-clocksum-fractional-format' and
  16073. `org-time-clocksum-use-effort-durations'."
  16074. (let ((clocksum "")
  16075. (m (round m)) ; Don't allow fractions of minutes
  16076. h d w mo y fmt n)
  16077. (setq h (if org-time-clocksum-use-effort-durations
  16078. (cdr (assoc "h" org-effort-durations)) 60)
  16079. d (if org-time-clocksum-use-effort-durations
  16080. (/ (cdr (assoc "d" org-effort-durations)) h) 24)
  16081. w (if org-time-clocksum-use-effort-durations
  16082. (/ (cdr (assoc "w" org-effort-durations)) (* d h)) 7)
  16083. mo (if org-time-clocksum-use-effort-durations
  16084. (/ (cdr (assoc "m" org-effort-durations)) (* d h)) 30)
  16085. y (if org-time-clocksum-use-effort-durations
  16086. (/ (cdr (assoc "y" org-effort-durations)) (* d h)) 365))
  16087. ;; fractional format
  16088. (if org-time-clocksum-use-fractional
  16089. (cond
  16090. ;; single format string
  16091. ((stringp org-time-clocksum-fractional-format)
  16092. (format org-time-clocksum-fractional-format (/ m (float h))))
  16093. ;; choice of fractional formats for different time units
  16094. ((and (setq fmt (plist-get org-time-clocksum-fractional-format :years))
  16095. (> (/ (truncate m) (* y d h)) 0))
  16096. (format fmt (/ m (* y d (float h)))))
  16097. ((and (setq fmt (plist-get org-time-clocksum-fractional-format :months))
  16098. (> (/ (truncate m) (* mo d h)) 0))
  16099. (format fmt (/ m (* mo d (float h)))))
  16100. ((and (setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
  16101. (> (/ (truncate m) (* w d h)) 0))
  16102. (format fmt (/ m (* w d (float h)))))
  16103. ((and (setq fmt (plist-get org-time-clocksum-fractional-format :days))
  16104. (> (/ (truncate m) (* d h)) 0))
  16105. (format fmt (/ m (* d (float h)))))
  16106. ((and (setq fmt (plist-get org-time-clocksum-fractional-format :hours))
  16107. (> (/ (truncate m) h) 0))
  16108. (format fmt (/ m (float h))))
  16109. ((setq fmt (plist-get org-time-clocksum-fractional-format :minutes))
  16110. (format fmt m))
  16111. ;; fall back to smallest time unit with a format
  16112. ((setq fmt (plist-get org-time-clocksum-fractional-format :hours))
  16113. (format fmt (/ m (float h))))
  16114. ((setq fmt (plist-get org-time-clocksum-fractional-format :days))
  16115. (format fmt (/ m (* d (float h)))))
  16116. ((setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
  16117. (format fmt (/ m (* w d (float h)))))
  16118. ((setq fmt (plist-get org-time-clocksum-fractional-format :months))
  16119. (format fmt (/ m (* mo d (float h)))))
  16120. ((setq fmt (plist-get org-time-clocksum-fractional-format :years))
  16121. (format fmt (/ m (* y d (float h))))))
  16122. ;; standard (non-fractional) format, with single format string
  16123. (if (stringp org-time-clocksum-format)
  16124. (format org-time-clocksum-format (setq n (/ m h)) (- m (* h n)))
  16125. ;; separate formats components
  16126. (and (setq fmt (plist-get org-time-clocksum-format :years))
  16127. (or (> (setq n (/ (truncate m) (* y d h))) 0)
  16128. (plist-get org-time-clocksum-format :require-years))
  16129. (setq clocksum (concat clocksum (format fmt n))
  16130. m (- m (* n y d h))))
  16131. (and (setq fmt (plist-get org-time-clocksum-format :months))
  16132. (or (> (setq n (/ (truncate m) (* mo d h))) 0)
  16133. (plist-get org-time-clocksum-format :require-months))
  16134. (setq clocksum (concat clocksum (format fmt n))
  16135. m (- m (* n mo d h))))
  16136. (and (setq fmt (plist-get org-time-clocksum-format :weeks))
  16137. (or (> (setq n (/ (truncate m) (* w d h))) 0)
  16138. (plist-get org-time-clocksum-format :require-weeks))
  16139. (setq clocksum (concat clocksum (format fmt n))
  16140. m (- m (* n w d h))))
  16141. (and (setq fmt (plist-get org-time-clocksum-format :days))
  16142. (or (> (setq n (/ (truncate m) (* d h))) 0)
  16143. (plist-get org-time-clocksum-format :require-days))
  16144. (setq clocksum (concat clocksum (format fmt n))
  16145. m (- m (* n d h))))
  16146. (and (setq fmt (plist-get org-time-clocksum-format :hours))
  16147. (or (> (setq n (/ (truncate m) h)) 0)
  16148. (plist-get org-time-clocksum-format :require-hours))
  16149. (setq clocksum (concat clocksum (format fmt n))
  16150. m (- m (* n h))))
  16151. (and (setq fmt (plist-get org-time-clocksum-format :minutes))
  16152. (or (> m 0) (plist-get org-time-clocksum-format :require-minutes))
  16153. (setq clocksum (concat clocksum (format fmt m))))
  16154. ;; return formatted time duration
  16155. clocksum))))
  16156. (defalias 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string)
  16157. (make-obsolete 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string
  16158. "Org mode version 8.0")
  16159. (defun org-hours-to-clocksum-string (n)
  16160. (org-minutes-to-clocksum-string (* n 60)))
  16161. (defun org-hh:mm-string-to-minutes (s)
  16162. "Convert a string H:MM to a number of minutes.
  16163. If the string is just a number, interpret it as minutes.
  16164. In fact, the first hh:mm or number in the string will be taken,
  16165. there can be extra stuff in the string.
  16166. If no number is found, the return value is 0."
  16167. (cond
  16168. ((integerp s) s)
  16169. ((string-match "\\([0-9]+\\):\\([0-9]+\\)" s)
  16170. (+ (* (string-to-number (match-string 1 s)) 60)
  16171. (string-to-number (match-string 2 s))))
  16172. ((string-match "\\([0-9]+\\)" s)
  16173. (string-to-number (match-string 1 s)))
  16174. (t 0)))
  16175. (defcustom org-image-actual-width t
  16176. "Should we use the actual width of images when inlining them?
  16177. When set to `t', always use the image width.
  16178. When set to a number, use imagemagick (when available) to set
  16179. the image's width to this value.
  16180. When set to a number in a list, try to get the width from any
  16181. #+ATTR.* keyword if it matches a width specification like
  16182. #+ATTR_HTML: :width 300px
  16183. and fall back on that number if none is found.
  16184. When set to nil, try to get the width from an #+ATTR.* keyword
  16185. and fall back on the original width if none is found.
  16186. This requires Emacs >= 24.1, build with imagemagick support."
  16187. :group 'org-appearance
  16188. :version "24.4"
  16189. :package-version '(Org . "8.0")
  16190. :type '(choice
  16191. (const :tag "Use the image width" t)
  16192. (integer :tag "Use a number of pixels")
  16193. (list :tag "Use #+ATTR* or a number of pixels" (integer))
  16194. (const :tag "Use #+ATTR* or don't resize" nil)))
  16195. (defcustom org-agenda-inhibit-startup nil
  16196. "Inhibit startup when preparing agenda buffers.
  16197. When this variable is `t' (the default), the initialization of
  16198. the Org agenda buffers is inhibited: e.g. the visibility state
  16199. is not set, the tables are not re-aligned, etc."
  16200. :type 'boolean
  16201. :version "24.3"
  16202. :group 'org-agenda)
  16203. (defcustom org-agenda-ignore-drawer-properties nil
  16204. "Avoid updating text properties when building the agenda.
  16205. Properties are used to prepare buffers for effort estimates, appointments,
  16206. and subtree-local categories.
  16207. If you don't use these in the agenda, you can add them to this list and
  16208. agenda building will be a bit faster.
  16209. The value is a list, with zero or more of the symbols `effort', `appt',
  16210. or `category'."
  16211. :type '(set :greedy t
  16212. (const effort)
  16213. (const appt)
  16214. (const category))
  16215. :version "24.3"
  16216. :group 'org-agenda)
  16217. (defun org-duration-string-to-minutes (s &optional output-to-string)
  16218. "Convert a duration string S to minutes.
  16219. A bare number is interpreted as minutes, modifiers can be set by
  16220. customizing `org-effort-durations' (which see).
  16221. Entries containing a colon are interpreted as H:MM by
  16222. `org-hh:mm-string-to-minutes'."
  16223. (let ((result 0)
  16224. (re (concat "\\([0-9.]+\\) *\\("
  16225. (regexp-opt (mapcar 'car org-effort-durations))
  16226. "\\)")))
  16227. (while (string-match re s)
  16228. (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
  16229. (string-to-number (match-string 1 s))))
  16230. (setq s (replace-match "" nil t s)))
  16231. (setq result (floor result))
  16232. (incf result (org-hh:mm-string-to-minutes s))
  16233. (if output-to-string (number-to-string result) result)))
  16234. ;;;; Files
  16235. (defun org-save-all-org-buffers ()
  16236. "Save all Org-mode buffers without user confirmation."
  16237. (interactive)
  16238. (message "Saving all Org-mode buffers...")
  16239. (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
  16240. (when (featurep 'org-id) (org-id-locations-save))
  16241. (message "Saving all Org-mode buffers... done"))
  16242. (defun org-revert-all-org-buffers ()
  16243. "Revert all Org-mode buffers.
  16244. Prompt for confirmation when there are unsaved changes.
  16245. Be sure you know what you are doing before letting this function
  16246. overwrite your changes.
  16247. This function is useful in a setup where one tracks org files
  16248. with a version control system, to revert on one machine after pulling
  16249. changes from another. I believe the procedure must be like this:
  16250. 1. M-x org-save-all-org-buffers
  16251. 2. Pull changes from the other machine, resolve conflicts
  16252. 3. M-x org-revert-all-org-buffers"
  16253. (interactive)
  16254. (unless (yes-or-no-p "Revert all Org buffers from their files? ")
  16255. (user-error "Abort"))
  16256. (save-excursion
  16257. (save-window-excursion
  16258. (mapc
  16259. (lambda (b)
  16260. (when (and (with-current-buffer b (derived-mode-p 'org-mode))
  16261. (with-current-buffer b buffer-file-name))
  16262. (org-pop-to-buffer-same-window b)
  16263. (revert-buffer t 'no-confirm)))
  16264. (buffer-list))
  16265. (when (and (featurep 'org-id) org-id-track-globally)
  16266. (org-id-locations-load)))))
  16267. ;;;; Agenda files
  16268. ;;;###autoload
  16269. (defun org-switchb (&optional arg)
  16270. "Switch between Org buffers.
  16271. With one prefix argument, restrict available buffers to files.
  16272. With two prefix arguments, restrict available buffers to agenda files.
  16273. Defaults to `iswitchb' for buffer name completion.
  16274. Set `org-completion-use-ido' to make it use ido instead."
  16275. (interactive "P")
  16276. (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
  16277. ((equal arg '(16)) (org-buffer-list 'agenda))
  16278. (t (org-buffer-list))))
  16279. (org-completion-use-iswitchb org-completion-use-iswitchb)
  16280. (org-completion-use-ido org-completion-use-ido))
  16281. (unless (or org-completion-use-ido org-completion-use-iswitchb)
  16282. (setq org-completion-use-iswitchb t))
  16283. (org-pop-to-buffer-same-window
  16284. (org-icompleting-read "Org buffer: "
  16285. (mapcar 'list (mapcar 'buffer-name blist))
  16286. nil t))))
  16287. ;;; Define some older names previously used for this functionality
  16288. ;;;###autoload
  16289. (defalias 'org-ido-switchb 'org-switchb)
  16290. ;;;###autoload
  16291. (defalias 'org-iswitchb 'org-switchb)
  16292. (defun org-buffer-list (&optional predicate exclude-tmp)
  16293. "Return a list of Org buffers.
  16294. PREDICATE can be `export', `files' or `agenda'.
  16295. export restrict the list to Export buffers.
  16296. files restrict the list to buffers visiting Org files.
  16297. agenda restrict the list to buffers visiting agenda files.
  16298. If EXCLUDE-TMP is non-nil, ignore temporary buffers."
  16299. (let* ((bfn nil)
  16300. (agenda-files (and (eq predicate 'agenda)
  16301. (mapcar 'file-truename (org-agenda-files t))))
  16302. (filter
  16303. (cond
  16304. ((eq predicate 'files)
  16305. (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
  16306. ((eq predicate 'export)
  16307. (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
  16308. ((eq predicate 'agenda)
  16309. (lambda (b)
  16310. (with-current-buffer b
  16311. (and (derived-mode-p 'org-mode)
  16312. (setq bfn (buffer-file-name b))
  16313. (member (file-truename bfn) agenda-files)))))
  16314. (t (lambda (b) (with-current-buffer b
  16315. (or (derived-mode-p 'org-mode)
  16316. (string-match "\*Org .*Export"
  16317. (buffer-name b)))))))))
  16318. (delq nil
  16319. (mapcar
  16320. (lambda(b)
  16321. (if (and (funcall filter b)
  16322. (or (not exclude-tmp)
  16323. (not (string-match "tmp" (buffer-name b)))))
  16324. b
  16325. nil))
  16326. (buffer-list)))))
  16327. (defun org-agenda-files (&optional unrestricted archives)
  16328. "Get the list of agenda files.
  16329. Optional UNRESTRICTED means return the full list even if a restriction
  16330. is currently in place.
  16331. When ARCHIVES is t, include all archive files that are really being
  16332. used by the agenda files. If ARCHIVE is `ifmode', do this only if
  16333. `org-agenda-archives-mode' is t."
  16334. (let ((files
  16335. (cond
  16336. ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
  16337. ((stringp org-agenda-files) (org-read-agenda-file-list))
  16338. ((listp org-agenda-files) org-agenda-files)
  16339. (t (error "Invalid value of `org-agenda-files'")))))
  16340. (setq files (apply 'append
  16341. (mapcar (lambda (f)
  16342. (if (file-directory-p f)
  16343. (directory-files
  16344. f t org-agenda-file-regexp)
  16345. (list f)))
  16346. files)))
  16347. (when org-agenda-skip-unavailable-files
  16348. (setq files (delq nil
  16349. (mapcar (function
  16350. (lambda (file)
  16351. (and (file-readable-p file) file)))
  16352. files))))
  16353. (when (or (eq archives t)
  16354. (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
  16355. (setq files (org-add-archive-files files)))
  16356. files))
  16357. (defun org-agenda-file-p (&optional file)
  16358. "Return non-nil, if FILE is an agenda file.
  16359. If FILE is omitted, use the file associated with the current
  16360. buffer."
  16361. (member (or file (buffer-file-name))
  16362. (org-agenda-files t)))
  16363. (defun org-edit-agenda-file-list ()
  16364. "Edit the list of agenda files.
  16365. Depending on setup, this either uses customize to edit the variable
  16366. `org-agenda-files', or it visits the file that is holding the list. In the
  16367. latter case, the buffer is set up in a way that saving it automatically kills
  16368. the buffer and restores the previous window configuration."
  16369. (interactive)
  16370. (if (stringp org-agenda-files)
  16371. (let ((cw (current-window-configuration)))
  16372. (find-file org-agenda-files)
  16373. (org-set-local 'org-window-configuration cw)
  16374. (org-add-hook 'after-save-hook
  16375. (lambda ()
  16376. (set-window-configuration
  16377. (prog1 org-window-configuration
  16378. (kill-buffer (current-buffer))))
  16379. (org-install-agenda-files-menu)
  16380. (message "New agenda file list installed"))
  16381. nil 'local)
  16382. (message "%s" (substitute-command-keys
  16383. "Edit list and finish with \\[save-buffer]")))
  16384. (customize-variable 'org-agenda-files)))
  16385. (defun org-store-new-agenda-file-list (list)
  16386. "Set new value for the agenda file list and save it correctly."
  16387. (if (stringp org-agenda-files)
  16388. (let ((fe (org-read-agenda-file-list t)) b u)
  16389. (while (setq b (find-buffer-visiting org-agenda-files))
  16390. (kill-buffer b))
  16391. (with-temp-file org-agenda-files
  16392. (insert
  16393. (mapconcat
  16394. (lambda (f) ;; Keep un-expanded entries.
  16395. (if (setq u (assoc f fe))
  16396. (cdr u)
  16397. f))
  16398. list "\n")
  16399. "\n")))
  16400. (let ((org-mode-hook nil) (org-inhibit-startup t)
  16401. (org-insert-mode-line-in-empty-file nil))
  16402. (setq org-agenda-files list)
  16403. (customize-save-variable 'org-agenda-files org-agenda-files))))
  16404. (defun org-read-agenda-file-list (&optional pair-with-expansion)
  16405. "Read the list of agenda files from a file.
  16406. If PAIR-WITH-EXPANSION is t return pairs with un-expanded
  16407. filenames, used by `org-store-new-agenda-file-list' to write back
  16408. un-expanded file names."
  16409. (when (file-directory-p org-agenda-files)
  16410. (error "`org-agenda-files' cannot be a single directory"))
  16411. (when (stringp org-agenda-files)
  16412. (with-temp-buffer
  16413. (insert-file-contents org-agenda-files)
  16414. (mapcar
  16415. (lambda (f)
  16416. (let ((e (expand-file-name (substitute-in-file-name f)
  16417. org-directory)))
  16418. (if pair-with-expansion
  16419. (cons e f)
  16420. e)))
  16421. (org-split-string (buffer-string) "[ \t\r\n]*?[\r\n][ \t\r\n]*")))))
  16422. ;;;###autoload
  16423. (defun org-cycle-agenda-files ()
  16424. "Cycle through the files in `org-agenda-files'.
  16425. If the current buffer visits an agenda file, find the next one in the list.
  16426. If the current buffer does not, find the first agenda file."
  16427. (interactive)
  16428. (let* ((fs (org-agenda-files t))
  16429. (files (append fs (list (car fs))))
  16430. (tcf (if buffer-file-name (file-truename buffer-file-name)))
  16431. file)
  16432. (unless files (user-error "No agenda files"))
  16433. (catch 'exit
  16434. (while (setq file (pop files))
  16435. (if (equal (file-truename file) tcf)
  16436. (when (car files)
  16437. (find-file (car files))
  16438. (throw 'exit t))))
  16439. (find-file (car fs)))
  16440. (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
  16441. (defun org-agenda-file-to-front (&optional to-end)
  16442. "Move/add the current file to the top of the agenda file list.
  16443. If the file is not present in the list, it is added to the front. If it is
  16444. present, it is moved there. With optional argument TO-END, add/move to the
  16445. end of the list."
  16446. (interactive "P")
  16447. (let ((org-agenda-skip-unavailable-files nil)
  16448. (file-alist (mapcar (lambda (x)
  16449. (cons (file-truename x) x))
  16450. (org-agenda-files t)))
  16451. (ctf (file-truename
  16452. (or buffer-file-name
  16453. (user-error "Please save the current buffer to a file"))))
  16454. x had)
  16455. (setq x (assoc ctf file-alist) had x)
  16456. (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
  16457. (if to-end
  16458. (setq file-alist (append (delq x file-alist) (list x)))
  16459. (setq file-alist (cons x (delq x file-alist))))
  16460. (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
  16461. (org-install-agenda-files-menu)
  16462. (message "File %s to %s of agenda file list"
  16463. (if had "moved" "added") (if to-end "end" "front"))))
  16464. (defun org-remove-file (&optional file)
  16465. "Remove current file from the list of files in variable `org-agenda-files'.
  16466. These are the files which are being checked for agenda entries.
  16467. Optional argument FILE means use this file instead of the current."
  16468. (interactive)
  16469. (let* ((org-agenda-skip-unavailable-files nil)
  16470. (file (or file buffer-file-name
  16471. (user-error "Current buffer does not visit a file")))
  16472. (true-file (file-truename file))
  16473. (afile (abbreviate-file-name file))
  16474. (files (delq nil (mapcar
  16475. (lambda (x)
  16476. (if (equal true-file
  16477. (file-truename x))
  16478. nil x))
  16479. (org-agenda-files t)))))
  16480. (if (not (= (length files) (length (org-agenda-files t))))
  16481. (progn
  16482. (org-store-new-agenda-file-list files)
  16483. (org-install-agenda-files-menu)
  16484. (message "Removed file: %s" afile))
  16485. (message "File was not in list: %s (not removed)" afile))))
  16486. (defun org-file-menu-entry (file)
  16487. (vector file (list 'find-file file) t))
  16488. (defun org-check-agenda-file (file)
  16489. "Make sure FILE exists. If not, ask user what to do."
  16490. (when (not (file-exists-p file))
  16491. (message "Non-existent agenda file %s. [R]emove from list or [A]bort?"
  16492. (abbreviate-file-name file))
  16493. (let ((r (downcase (read-char-exclusive))))
  16494. (cond
  16495. ((equal r ?r)
  16496. (org-remove-file file)
  16497. (throw 'nextfile t))
  16498. (t (error "Abort"))))))
  16499. (defun org-get-agenda-file-buffer (file)
  16500. "Get a buffer visiting FILE. If the buffer needs to be created, add
  16501. it to the list of buffers which might be released later."
  16502. (let ((buf (org-find-base-buffer-visiting file)))
  16503. (if buf
  16504. buf ; just return it
  16505. ;; Make a new buffer and remember it
  16506. (setq buf (find-file-noselect file))
  16507. (if buf (push buf org-agenda-new-buffers))
  16508. buf)))
  16509. (defun org-release-buffers (blist)
  16510. "Release all buffers in list, asking the user for confirmation when needed.
  16511. When a buffer is unmodified, it is just killed. When modified, it is saved
  16512. \(if the user agrees) and then killed."
  16513. (let (buf file)
  16514. (while (setq buf (pop blist))
  16515. (setq file (buffer-file-name buf))
  16516. (when (and (buffer-modified-p buf)
  16517. file
  16518. (y-or-n-p (format "Save file %s? " file)))
  16519. (with-current-buffer buf (save-buffer)))
  16520. (kill-buffer buf))))
  16521. (defun org-agenda-prepare-buffers (files)
  16522. "Create buffers for all agenda files, protect archived trees and comments."
  16523. (interactive)
  16524. (let ((pa '(:org-archived t))
  16525. (pc '(:org-comment t))
  16526. (pall '(:org-archived t :org-comment t))
  16527. (inhibit-read-only t)
  16528. (org-inhibit-startup org-agenda-inhibit-startup)
  16529. (rea (concat ":" org-archive-tag ":"))
  16530. file re)
  16531. (setq org-tag-alist-for-agenda nil
  16532. org-tag-groups-alist-for-agenda nil)
  16533. (save-excursion
  16534. (save-restriction
  16535. (while (setq file (pop files))
  16536. (catch 'nextfile
  16537. (if (bufferp file)
  16538. (set-buffer file)
  16539. (org-check-agenda-file file)
  16540. (set-buffer (org-get-agenda-file-buffer file)))
  16541. (widen)
  16542. (org-set-regexps-and-options-for-tags)
  16543. (goto-char (point-min))
  16544. (let ((case-fold-search t))
  16545. (when (search-forward "#+setupfile" nil t)
  16546. ;; Don't set all regexps and options systematically as
  16547. ;; this is only run for setting agenda tags from setup
  16548. ;; file
  16549. (org-set-regexps-and-options)))
  16550. (or (memq 'category org-agenda-ignore-drawer-properties)
  16551. (org-refresh-category-properties))
  16552. (or (memq 'effort org-agenda-ignore-drawer-properties)
  16553. (org-refresh-properties org-effort-property 'org-effort))
  16554. (or (memq 'appt org-agenda-ignore-drawer-properties)
  16555. (org-refresh-properties "APPT_WARNTIME" 'org-appt-warntime))
  16556. (setq org-todo-keywords-for-agenda
  16557. (append org-todo-keywords-for-agenda org-todo-keywords-1))
  16558. (setq org-done-keywords-for-agenda
  16559. (append org-done-keywords-for-agenda org-done-keywords))
  16560. (setq org-todo-keyword-alist-for-agenda
  16561. (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
  16562. (setq org-drawers-for-agenda
  16563. (append org-drawers-for-agenda org-drawers))
  16564. (setq org-tag-alist-for-agenda
  16565. (org-uniquify
  16566. (append org-tag-alist-for-agenda
  16567. org-tag-alist
  16568. org-tag-persistent-alist)))
  16569. (if org-group-tags
  16570. (setq org-tag-groups-alist-for-agenda
  16571. (org-uniquify-alist
  16572. (append org-tag-groups-alist-for-agenda org-tag-groups-alist))))
  16573. (org-with-silent-modifications
  16574. (save-excursion
  16575. (remove-text-properties (point-min) (point-max) pall)
  16576. (when org-agenda-skip-archived-trees
  16577. (goto-char (point-min))
  16578. (while (re-search-forward rea nil t)
  16579. (if (org-at-heading-p t)
  16580. (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
  16581. (goto-char (point-min))
  16582. (setq re (format org-heading-keyword-regexp-format
  16583. org-comment-string))
  16584. (while (re-search-forward re nil t)
  16585. (add-text-properties
  16586. (match-beginning 0) (org-end-of-subtree t) pc))))))))
  16587. (setq org-todo-keywords-for-agenda
  16588. (org-uniquify org-todo-keywords-for-agenda))
  16589. (setq org-todo-keyword-alist-for-agenda
  16590. (org-uniquify org-todo-keyword-alist-for-agenda))))
  16591. ;;;; CDLaTeX minor mode
  16592. (defvar org-cdlatex-mode-map (make-sparse-keymap)
  16593. "Keymap for the minor `org-cdlatex-mode'.")
  16594. (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
  16595. (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
  16596. (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
  16597. (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
  16598. (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
  16599. (defvar org-cdlatex-texmathp-advice-is-done nil
  16600. "Flag remembering if we have applied the advice to texmathp already.")
  16601. (define-minor-mode org-cdlatex-mode
  16602. "Toggle the minor `org-cdlatex-mode'.
  16603. This mode supports entering LaTeX environment and math in LaTeX fragments
  16604. in Org-mode.
  16605. \\{org-cdlatex-mode-map}"
  16606. nil " OCDL" nil
  16607. (when org-cdlatex-mode
  16608. (require 'cdlatex)
  16609. (run-hooks 'cdlatex-mode-hook)
  16610. (cdlatex-compute-tables))
  16611. (unless org-cdlatex-texmathp-advice-is-done
  16612. (setq org-cdlatex-texmathp-advice-is-done t)
  16613. (defadvice texmathp (around org-math-always-on activate)
  16614. "Always return t in org-mode buffers.
  16615. This is because we want to insert math symbols without dollars even outside
  16616. the LaTeX math segments. If Orgmode thinks that point is actually inside
  16617. an embedded LaTeX fragment, let texmathp do its job.
  16618. \\[org-cdlatex-mode-map]"
  16619. (interactive)
  16620. (let (p)
  16621. (cond
  16622. ((not (derived-mode-p 'org-mode)) ad-do-it)
  16623. ((eq this-command 'cdlatex-math-symbol)
  16624. (setq ad-return-value t
  16625. texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
  16626. (t
  16627. (let ((p (org-inside-LaTeX-fragment-p)))
  16628. (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
  16629. (setq ad-return-value t
  16630. texmathp-why '("Org-mode embedded math" . 0))
  16631. (if p ad-do-it)))))))))
  16632. (defun turn-on-org-cdlatex ()
  16633. "Unconditionally turn on `org-cdlatex-mode'."
  16634. (org-cdlatex-mode 1))
  16635. (defun org-try-cdlatex-tab ()
  16636. "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
  16637. It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
  16638. - inside a LaTeX fragment, or
  16639. - after the first word in a line, where an abbreviation expansion could
  16640. insert a LaTeX environment."
  16641. (when org-cdlatex-mode
  16642. (cond
  16643. ;; Before any word on the line: No expansion possible.
  16644. ((save-excursion (skip-chars-backward " \t") (bolp)) nil)
  16645. ;; Just after first word on the line: Expand it. Make sure it
  16646. ;; cannot happen on headlines, though.
  16647. ((save-excursion
  16648. (skip-chars-backward "a-zA-Z0-9*")
  16649. (skip-chars-backward " \t")
  16650. (and (bolp) (not (org-at-heading-p))))
  16651. (cdlatex-tab) t)
  16652. ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
  16653. (defun org-cdlatex-underscore-caret (&optional arg)
  16654. "Execute `cdlatex-sub-superscript' in LaTeX fragments.
  16655. Revert to the normal definition outside of these fragments."
  16656. (interactive "P")
  16657. (if (org-inside-LaTeX-fragment-p)
  16658. (call-interactively 'cdlatex-sub-superscript)
  16659. (let (org-cdlatex-mode)
  16660. (call-interactively (key-binding (vector last-input-event))))))
  16661. (defun org-cdlatex-math-modify (&optional arg)
  16662. "Execute `cdlatex-math-modify' in LaTeX fragments.
  16663. Revert to the normal definition outside of these fragments."
  16664. (interactive "P")
  16665. (if (org-inside-LaTeX-fragment-p)
  16666. (call-interactively 'cdlatex-math-modify)
  16667. (let (org-cdlatex-mode)
  16668. (call-interactively (key-binding (vector last-input-event))))))
  16669. ;;;; LaTeX fragments
  16670. (defvar org-latex-regexps
  16671. '(("begin" "^[ \t]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^\000]+?\\\\end{\\2}\\)" 1 t)
  16672. ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
  16673. ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
  16674. ("$1" "\\([^$]\\|^\\)\\(\\$[^ \r\n,;.$]\\$\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
  16675. ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
  16676. ("\\(" "\\\\([^\000]*?\\\\)" 0 nil)
  16677. ("\\[" "\\\\\\[[^\000]*?\\\\\\]" 0 nil)
  16678. ("$$" "\\$\\$[^\000]*?\\$\\$" 0 nil))
  16679. "Regular expressions for matching embedded LaTeX.")
  16680. (defun org-inside-LaTeX-fragment-p ()
  16681. "Test if point is inside a LaTeX fragment.
  16682. I.e. after a \\begin, \\(, \\[, $, or $$, without the corresponding closing
  16683. sequence appearing also before point.
  16684. Even though the matchers for math are configurable, this function assumes
  16685. that \\begin, \\(, \\[, and $$ are always used. Only the single dollar
  16686. delimiters are skipped when they have been removed by customization.
  16687. The return value is nil, or a cons cell with the delimiter and the
  16688. position of this delimiter.
  16689. This function does a reasonably good job, but can locally be fooled by
  16690. for example currency specifications. For example it will assume being in
  16691. inline math after \"$22.34\". The LaTeX fragment formatter will only format
  16692. fragments that are properly closed, but during editing, we have to live
  16693. with the uncertainty caused by missing closing delimiters. This function
  16694. looks only before point, not after."
  16695. (catch 'exit
  16696. (let ((pos (point))
  16697. (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
  16698. (lim (progn
  16699. (re-search-backward (concat "^\\(" paragraph-start "\\)") nil t)
  16700. (point)))
  16701. dd-on str (start 0) m re)
  16702. (goto-char pos)
  16703. (when dodollar
  16704. (setq str (concat (buffer-substring lim (point)) "\000 X$.")
  16705. re (nth 1 (assoc "$" org-latex-regexps)))
  16706. (while (string-match re str start)
  16707. (cond
  16708. ((= (match-end 0) (length str))
  16709. (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
  16710. ((= (match-end 0) (- (length str) 5))
  16711. (throw 'exit nil))
  16712. (t (setq start (match-end 0))))))
  16713. (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
  16714. (goto-char pos)
  16715. (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
  16716. (and (match-beginning 2) (throw 'exit nil))
  16717. ;; count $$
  16718. (while (re-search-backward "\\$\\$" lim t)
  16719. (setq dd-on (not dd-on)))
  16720. (goto-char pos)
  16721. (if dd-on (cons "$$" m))))))
  16722. (defun org-inside-latex-macro-p ()
  16723. "Is point inside a LaTeX macro or its arguments?"
  16724. (save-match-data
  16725. (org-in-regexp
  16726. "\\\\[a-zA-Z]+\\*?\\(\\(\\[[^][\n{}]*\\]\\)\\|\\({[^{}\n]*}\\)\\)*")))
  16727. (defvar org-latex-fragment-image-overlays nil
  16728. "List of overlays carrying the images of latex fragments.")
  16729. (make-variable-buffer-local 'org-latex-fragment-image-overlays)
  16730. (defun org-remove-latex-fragment-image-overlays ()
  16731. "Remove all overlays with LaTeX fragment images in current buffer."
  16732. (mapc 'delete-overlay org-latex-fragment-image-overlays)
  16733. (setq org-latex-fragment-image-overlays nil))
  16734. (defun org-preview-latex-fragment (&optional subtree)
  16735. "Preview the LaTeX fragment at point, or all locally or globally.
  16736. If the cursor is in a LaTeX fragment, create the image and overlay
  16737. it over the source code. If there is no fragment at point, display
  16738. all fragments in the current text, from one headline to the next. With
  16739. prefix SUBTREE, display all fragments in the current subtree. With a
  16740. double prefix arg \\[universal-argument] \\[universal-argument], or when \
  16741. the cursor is before the first headline,
  16742. display all fragments in the buffer.
  16743. The images can be removed again with \\[org-ctrl-c-ctrl-c]."
  16744. (interactive "P")
  16745. (unless buffer-file-name
  16746. (user-error "Can't preview LaTeX fragment in a non-file buffer"))
  16747. (when (display-graphic-p)
  16748. (org-remove-latex-fragment-image-overlays)
  16749. (save-excursion
  16750. (save-restriction
  16751. (let (beg end at msg)
  16752. (cond
  16753. ((or (equal subtree '(16))
  16754. (not (save-excursion
  16755. (re-search-backward org-outline-regexp-bol nil t))))
  16756. (setq beg (point-min) end (point-max)
  16757. msg "Creating images for buffer...%s"))
  16758. ((equal subtree '(4))
  16759. (org-back-to-heading)
  16760. (setq beg (point) end (org-end-of-subtree t)
  16761. msg "Creating images for subtree...%s"))
  16762. (t
  16763. (if (setq at (org-inside-LaTeX-fragment-p))
  16764. (goto-char (max (point-min) (- (cdr at) 2)))
  16765. (org-back-to-heading))
  16766. (setq beg (point) end (progn (outline-next-heading) (point))
  16767. msg (if at "Creating image...%s"
  16768. "Creating images for entry...%s"))))
  16769. (message msg "")
  16770. (narrow-to-region beg end)
  16771. (goto-char beg)
  16772. (org-format-latex
  16773. (concat org-latex-preview-ltxpng-directory (file-name-sans-extension
  16774. (file-name-nondirectory
  16775. buffer-file-name)))
  16776. default-directory 'overlays msg at 'forbuffer
  16777. org-latex-create-formula-image-program)
  16778. (message msg "done. Use `C-c C-c' to remove images."))))))
  16779. (defun org-format-latex (prefix &optional dir overlays msg at
  16780. forbuffer processing-type)
  16781. "Replace LaTeX fragments with links to an image, and produce images.
  16782. Some of the options can be changed using the variable
  16783. `org-format-latex-options'."
  16784. (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
  16785. (let* ((prefixnodir (file-name-nondirectory prefix))
  16786. (absprefix (expand-file-name prefix dir))
  16787. (todir (file-name-directory absprefix))
  16788. (opt org-format-latex-options)
  16789. (optnew org-format-latex-options)
  16790. (matchers (plist-get opt :matchers))
  16791. (re-list org-latex-regexps)
  16792. (cnt 0) txt hash link beg end re e checkdir
  16793. string
  16794. m n block-type block linkfile movefile ov)
  16795. ;; Check the different regular expressions
  16796. (while (setq e (pop re-list))
  16797. (setq m (car e) re (nth 1 e) n (nth 2 e) block-type (nth 3 e)
  16798. block (if block-type "\n\n" ""))
  16799. (when (member m matchers)
  16800. (goto-char (point-min))
  16801. (while (re-search-forward re nil t)
  16802. (when (and (or (not at) (equal (cdr at) (match-beginning n)))
  16803. (or (not overlays)
  16804. (not (eq (get-char-property (match-beginning n)
  16805. 'org-overlay-type)
  16806. 'org-latex-overlay))))
  16807. (cond
  16808. ((eq processing-type 'verbatim))
  16809. ((eq processing-type 'mathjax)
  16810. ;; Prepare for MathJax processing.
  16811. (setq string (match-string n))
  16812. (when (member m '("$" "$1"))
  16813. (save-excursion
  16814. (delete-region (match-beginning n) (match-end n))
  16815. (goto-char (match-beginning n))
  16816. (insert (concat "\\(" (substring string 1 -1) "\\)")))))
  16817. ((or (eq processing-type 'dvipng)
  16818. (eq processing-type 'imagemagick))
  16819. ;; Process to an image.
  16820. (setq txt (match-string n)
  16821. beg (match-beginning n) end (match-end n)
  16822. cnt (1+ cnt))
  16823. (let ((face (face-at-point))
  16824. (fg (plist-get opt :foreground))
  16825. (bg (plist-get opt :background))
  16826. ;; Ensure full list is printed.
  16827. print-length print-level)
  16828. (when forbuffer
  16829. ;; Get the colors from the face at point.
  16830. (goto-char beg)
  16831. (when (eq fg 'auto)
  16832. (setq fg (face-attribute face :foreground nil 'default)))
  16833. (when (eq bg 'auto)
  16834. (setq bg (face-attribute face :background nil 'default)))
  16835. (setq optnew (copy-sequence opt))
  16836. (plist-put optnew :foreground fg)
  16837. (plist-put optnew :background bg))
  16838. (setq hash (sha1 (prin1-to-string
  16839. (list org-format-latex-header
  16840. org-latex-default-packages-alist
  16841. org-latex-packages-alist
  16842. org-format-latex-options
  16843. forbuffer txt fg bg)))
  16844. linkfile (format "%s_%s.png" prefix hash)
  16845. movefile (format "%s_%s.png" absprefix hash)))
  16846. (setq link (concat block "[[file:" linkfile "]]" block))
  16847. (if msg (message msg cnt))
  16848. (goto-char beg)
  16849. (unless checkdir ; Ensure the directory exists.
  16850. (setq checkdir t)
  16851. (or (file-directory-p todir) (make-directory todir t)))
  16852. (unless (file-exists-p movefile)
  16853. (org-create-formula-image
  16854. txt movefile optnew forbuffer processing-type))
  16855. (if overlays
  16856. (progn
  16857. (mapc (lambda (o)
  16858. (if (eq (overlay-get o 'org-overlay-type)
  16859. 'org-latex-overlay)
  16860. (delete-overlay o)))
  16861. (overlays-in beg end))
  16862. (setq ov (make-overlay beg end))
  16863. (overlay-put ov 'org-overlay-type 'org-latex-overlay)
  16864. (if (featurep 'xemacs)
  16865. (progn
  16866. (overlay-put ov 'invisible t)
  16867. (overlay-put
  16868. ov 'end-glyph
  16869. (make-glyph (vector 'png :file movefile))))
  16870. (overlay-put
  16871. ov 'display
  16872. (list 'image :type 'png :file movefile :ascent 'center)))
  16873. (push ov org-latex-fragment-image-overlays)
  16874. (goto-char end))
  16875. (delete-region beg end)
  16876. (insert (org-add-props link
  16877. (list 'org-latex-src
  16878. (replace-regexp-in-string
  16879. "\"" "" txt)
  16880. 'org-latex-src-embed-type
  16881. (if block-type 'paragraph 'character))))))
  16882. ((eq processing-type 'mathml)
  16883. ;; Process to MathML
  16884. (unless (save-match-data (org-format-latex-mathml-available-p))
  16885. (user-error "LaTeX to MathML converter not configured"))
  16886. (setq txt (match-string n)
  16887. beg (match-beginning n) end (match-end n)
  16888. cnt (1+ cnt))
  16889. (if msg (message msg cnt))
  16890. (goto-char beg)
  16891. (delete-region beg end)
  16892. (insert (org-format-latex-as-mathml
  16893. txt block-type prefix dir)))
  16894. (t
  16895. (error "Unknown conversion type %s for LaTeX fragments"
  16896. processing-type)))))))))
  16897. (defun org-create-math-formula (latex-frag &optional mathml-file)
  16898. "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
  16899. Use `org-latex-to-mathml-convert-command'. If the conversion is
  16900. sucessful, return the portion between \"<math...> </math>\"
  16901. elements otherwise return nil. When MATHML-FILE is specified,
  16902. write the results in to that file. When invoked as an
  16903. interactive command, prompt for LATEX-FRAG, with initial value
  16904. set to the current active region and echo the results for user
  16905. inspection."
  16906. (interactive (list (let ((frag (when (org-region-active-p)
  16907. (buffer-substring-no-properties
  16908. (region-beginning) (region-end)))))
  16909. (read-string "LaTeX Fragment: " frag nil frag))))
  16910. (unless latex-frag (error "Invalid LaTeX fragment"))
  16911. (let* ((tmp-in-file (file-relative-name
  16912. (make-temp-name (expand-file-name "ltxmathml-in"))))
  16913. (ignore (write-region latex-frag nil tmp-in-file))
  16914. (tmp-out-file (file-relative-name
  16915. (make-temp-name (expand-file-name "ltxmathml-out"))))
  16916. (cmd (format-spec
  16917. org-latex-to-mathml-convert-command
  16918. `((?j . ,(shell-quote-argument
  16919. (expand-file-name org-latex-to-mathml-jar-file)))
  16920. (?I . ,(shell-quote-argument tmp-in-file))
  16921. (?o . ,(shell-quote-argument tmp-out-file)))))
  16922. mathml shell-command-output)
  16923. (when (org-called-interactively-p 'any)
  16924. (unless (org-format-latex-mathml-available-p)
  16925. (user-error "LaTeX to MathML converter not configured")))
  16926. (message "Running %s" cmd)
  16927. (setq shell-command-output (shell-command-to-string cmd))
  16928. (setq mathml
  16929. (when (file-readable-p tmp-out-file)
  16930. (with-current-buffer (find-file-noselect tmp-out-file t)
  16931. (goto-char (point-min))
  16932. (when (re-search-forward
  16933. (concat
  16934. (regexp-quote
  16935. "<math xmlns=\"http://www.w3.org/1998/Math/MathML\">")
  16936. "\\(.\\|\n\\)*"
  16937. (regexp-quote "</math>")) nil t)
  16938. (prog1 (match-string 0) (kill-buffer))))))
  16939. (cond
  16940. (mathml
  16941. (setq mathml
  16942. (concat "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" mathml))
  16943. (when mathml-file
  16944. (write-region mathml nil mathml-file))
  16945. (when (org-called-interactively-p 'any)
  16946. (message mathml)))
  16947. ((message "LaTeX to MathML conversion failed")
  16948. (message shell-command-output)))
  16949. (delete-file tmp-in-file)
  16950. (when (file-exists-p tmp-out-file)
  16951. (delete-file tmp-out-file))
  16952. mathml))
  16953. (defun org-format-latex-as-mathml (latex-frag latex-frag-type
  16954. prefix &optional dir)
  16955. "Use `org-create-math-formula' but check local cache first."
  16956. (let* ((absprefix (expand-file-name prefix dir))
  16957. (print-length nil) (print-level nil)
  16958. (formula-id (concat
  16959. "formula-"
  16960. (sha1
  16961. (prin1-to-string
  16962. (list latex-frag
  16963. org-latex-to-mathml-convert-command)))))
  16964. (formula-cache (format "%s-%s.mathml" absprefix formula-id))
  16965. (formula-cache-dir (file-name-directory formula-cache)))
  16966. (unless (file-directory-p formula-cache-dir)
  16967. (make-directory formula-cache-dir t))
  16968. (unless (file-exists-p formula-cache)
  16969. (org-create-math-formula latex-frag formula-cache))
  16970. (if (file-exists-p formula-cache)
  16971. ;; Successful conversion. Return the link to MathML file.
  16972. (org-add-props
  16973. (format "[[file:%s]]" (file-relative-name formula-cache dir))
  16974. (list 'org-latex-src (replace-regexp-in-string "\"" "" latex-frag)
  16975. 'org-latex-src-embed-type (if latex-frag-type
  16976. 'paragraph 'character)))
  16977. ;; Failed conversion. Return the LaTeX fragment verbatim
  16978. latex-frag)))
  16979. (defun org-create-formula-image (string tofile options buffer &optional type)
  16980. "Create an image from LaTeX source using dvipng or convert.
  16981. This function calls either `org-create-formula-image-with-dvipng'
  16982. or `org-create-formula-image-with-imagemagick' depending on the
  16983. value of `org-latex-create-formula-image-program' or on the value
  16984. of the optional TYPE variable.
  16985. Note: ultimately these two function should be combined as they
  16986. share a good deal of logic."
  16987. (org-check-external-command
  16988. "latex" "needed to convert LaTeX fragments to images")
  16989. (funcall
  16990. (case (or type org-latex-create-formula-image-program)
  16991. ('dvipng
  16992. (org-check-external-command
  16993. "dvipng" "needed to convert LaTeX fragments to images")
  16994. #'org-create-formula-image-with-dvipng)
  16995. ('imagemagick
  16996. (org-check-external-command
  16997. "convert" "you need to install imagemagick")
  16998. #'org-create-formula-image-with-imagemagick)
  16999. (t (error
  17000. "Invalid value of `org-latex-create-formula-image-program'")))
  17001. string tofile options buffer))
  17002. (declare-function org-export-get-backend "ox" (name))
  17003. (declare-function org-export--get-global-options "ox" (&optional backend))
  17004. (declare-function org-export--get-inbuffer-options "ox" (&optional backend))
  17005. (declare-function org-latex-guess-inputenc "ox-latex" (header))
  17006. (declare-function org-latex-guess-babel-language "ox-latex" (header info))
  17007. (defun org-create-formula--latex-header ()
  17008. "Return LaTeX header appropriate for previewing a LaTeX snippet."
  17009. (let ((info (org-combine-plists (org-export--get-global-options
  17010. (org-export-get-backend 'latex))
  17011. (org-export--get-inbuffer-options
  17012. (org-export-get-backend 'latex)))))
  17013. (org-latex-guess-babel-language
  17014. (org-latex-guess-inputenc
  17015. (org-splice-latex-header
  17016. org-format-latex-header
  17017. org-latex-default-packages-alist
  17018. org-latex-packages-alist t
  17019. (plist-get info :latex-header)))
  17020. info)))
  17021. ;; This function borrows from Ganesh Swami's latex2png.el
  17022. (defun org-create-formula-image-with-dvipng (string tofile options buffer)
  17023. "This calls dvipng."
  17024. (require 'ox-latex)
  17025. (let* ((tmpdir (if (featurep 'xemacs)
  17026. (temp-directory)
  17027. temporary-file-directory))
  17028. (texfilebase (make-temp-name
  17029. (expand-file-name "orgtex" tmpdir)))
  17030. (texfile (concat texfilebase ".tex"))
  17031. (dvifile (concat texfilebase ".dvi"))
  17032. (pngfile (concat texfilebase ".png"))
  17033. (fnh (if (featurep 'xemacs)
  17034. (font-height (face-font 'default))
  17035. (face-attribute 'default :height nil)))
  17036. (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
  17037. (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
  17038. (fg (or (plist-get options (if buffer :foreground :html-foreground))
  17039. "Black"))
  17040. (bg (or (plist-get options (if buffer :background :html-background))
  17041. "Transparent")))
  17042. (if (eq fg 'default) (setq fg (org-dvipng-color :foreground))
  17043. (unless (string= fg "Transparent") (setq fg (org-dvipng-color-format fg))))
  17044. (if (eq bg 'default) (setq bg (org-dvipng-color :background))
  17045. (unless (string= bg "Transparent") (setq bg (org-dvipng-color-format bg))))
  17046. (let ((latex-header (org-create-formula--latex-header)))
  17047. (with-temp-file texfile
  17048. (insert latex-header)
  17049. (insert "\n\\begin{document}\n" string "\n\\end{document}\n")))
  17050. (let ((dir default-directory))
  17051. (condition-case nil
  17052. (progn
  17053. (cd tmpdir)
  17054. (call-process "latex" nil nil nil texfile))
  17055. (error nil))
  17056. (cd dir))
  17057. (if (not (file-exists-p dvifile))
  17058. (progn (message "Failed to create dvi file from %s" texfile) nil)
  17059. (condition-case nil
  17060. (if (featurep 'xemacs)
  17061. (call-process "dvipng" nil nil nil
  17062. "-fg" fg "-bg" bg
  17063. "-T" "tight"
  17064. "-o" pngfile
  17065. dvifile)
  17066. (call-process "dvipng" nil nil nil
  17067. "-fg" fg "-bg" bg
  17068. "-D" dpi
  17069. ;;"-x" scale "-y" scale
  17070. "-T" "tight"
  17071. "-o" pngfile
  17072. dvifile))
  17073. (error nil))
  17074. (if (not (file-exists-p pngfile))
  17075. (if org-format-latex-signal-error
  17076. (error "Failed to create png file from %s" texfile)
  17077. (message "Failed to create png file from %s" texfile)
  17078. nil)
  17079. ;; Use the requested file name and clean up
  17080. (copy-file pngfile tofile 'replace)
  17081. (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
  17082. (if (file-exists-p (concat texfilebase e))
  17083. (delete-file (concat texfilebase e))))
  17084. pngfile))))
  17085. (declare-function org-latex-compile "ox-latex" (texfile &optional snippet))
  17086. (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
  17087. "This calls convert, which is included into imagemagick."
  17088. (require 'ox-latex)
  17089. (let* ((tmpdir (if (featurep 'xemacs)
  17090. (temp-directory)
  17091. temporary-file-directory))
  17092. (texfilebase (make-temp-name
  17093. (expand-file-name "orgtex" tmpdir)))
  17094. (texfile (concat texfilebase ".tex"))
  17095. (pdffile (concat texfilebase ".pdf"))
  17096. (pngfile (concat texfilebase ".png"))
  17097. (fnh (if (featurep 'xemacs)
  17098. (font-height (face-font 'default))
  17099. (face-attribute 'default :height nil)))
  17100. (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
  17101. (dpi (number-to-string (* scale (floor (if buffer fnh 120.)))))
  17102. (fg (or (plist-get options (if buffer :foreground :html-foreground))
  17103. "black"))
  17104. (bg (or (plist-get options (if buffer :background :html-background))
  17105. "white")))
  17106. (if (eq fg 'default) (setq fg (org-latex-color :foreground))
  17107. (setq fg (org-latex-color-format fg)))
  17108. (if (eq bg 'default) (setq bg (org-latex-color :background))
  17109. (setq bg (org-latex-color-format
  17110. (if (string= bg "Transparent") "white" bg))))
  17111. (let ((latex-header (org-create-formula--latex-header)))
  17112. (with-temp-file texfile
  17113. (insert latex-header)
  17114. (insert "\n\\begin{document}\n"
  17115. "\\definecolor{fg}{rgb}{" fg "}\n"
  17116. "\\definecolor{bg}{rgb}{" bg "}\n"
  17117. "\n\\pagecolor{bg}\n"
  17118. "\n{\\color{fg}\n"
  17119. string
  17120. "\n}\n"
  17121. "\n\\end{document}\n")))
  17122. (org-latex-compile texfile t)
  17123. (if (not (file-exists-p pdffile))
  17124. (progn (message "Failed to create pdf file from %s" texfile) nil)
  17125. (condition-case nil
  17126. (if (featurep 'xemacs)
  17127. (call-process "convert" nil nil nil
  17128. "-density" "96"
  17129. "-trim"
  17130. "-antialias"
  17131. pdffile
  17132. "-quality" "100"
  17133. ;; "-sharpen" "0x1.0"
  17134. pngfile)
  17135. (call-process "convert" nil nil nil
  17136. "-density" dpi
  17137. "-trim"
  17138. "-antialias"
  17139. pdffile
  17140. "-quality" "100"
  17141. ;; "-sharpen" "0x1.0"
  17142. pngfile))
  17143. (error nil))
  17144. (if (not (file-exists-p pngfile))
  17145. (if org-format-latex-signal-error
  17146. (error "Failed to create png file from %s" texfile)
  17147. (message "Failed to create png file from %s" texfile)
  17148. nil)
  17149. ;; Use the requested file name and clean up
  17150. (copy-file pngfile tofile 'replace)
  17151. (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
  17152. (if (file-exists-p (concat texfilebase e))
  17153. (delete-file (concat texfilebase e))))
  17154. pngfile))))
  17155. (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
  17156. "Fill a LaTeX header template TPL.
  17157. In the template, the following place holders will be recognized:
  17158. [DEFAULT-PACKAGES] \\usepackage statements for DEF-PKG
  17159. [NO-DEFAULT-PACKAGES] do not include DEF-PKG
  17160. [PACKAGES] \\usepackage statements for PKG
  17161. [NO-PACKAGES] do not include PKG
  17162. [EXTRA] the string EXTRA
  17163. [NO-EXTRA] do not include EXTRA
  17164. For backward compatibility, if both the positive and the negative place
  17165. holder is missing, the positive one (without the \"NO-\") will be
  17166. assumed to be present at the end of the template.
  17167. DEF-PKG and PKG are assumed to be alists of options/packagename lists.
  17168. EXTRA is a string.
  17169. SNIPPETS-P indicates if this is run to create snippet images for HTML."
  17170. (let (rpl (end ""))
  17171. (if (string-match "^[ \t]*\\[\\(NO-\\)?DEFAULT-PACKAGES\\][ \t]*\n?" tpl)
  17172. (setq rpl (if (or (match-end 1) (not def-pkg))
  17173. "" (org-latex-packages-to-string def-pkg snippets-p t))
  17174. tpl (replace-match rpl t t tpl))
  17175. (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
  17176. (if (string-match "\\[\\(NO-\\)?PACKAGES\\][ \t]*\n?" tpl)
  17177. (setq rpl (if (or (match-end 1) (not pkg))
  17178. "" (org-latex-packages-to-string pkg snippets-p t))
  17179. tpl (replace-match rpl t t tpl))
  17180. (if pkg (setq end
  17181. (concat end "\n"
  17182. (org-latex-packages-to-string pkg snippets-p)))))
  17183. (if (string-match "\\[\\(NO-\\)?EXTRA\\][ \t]*\n?" tpl)
  17184. (setq rpl (if (or (match-end 1) (not extra))
  17185. "" (concat extra "\n"))
  17186. tpl (replace-match rpl t t tpl))
  17187. (if (and extra (string-match "\\S-" extra))
  17188. (setq end (concat end "\n" extra))))
  17189. (if (string-match "\\S-" end)
  17190. (concat tpl "\n" end)
  17191. tpl)))
  17192. (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
  17193. "Turn an alist of packages into a string with the \\usepackage macros."
  17194. (setq pkg (mapconcat (lambda(p)
  17195. (cond
  17196. ((stringp p) p)
  17197. ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
  17198. (format "%% Package %s omitted" (cadr p)))
  17199. ((equal "" (car p))
  17200. (format "\\usepackage{%s}" (cadr p)))
  17201. (t
  17202. (format "\\usepackage[%s]{%s}"
  17203. (car p) (cadr p)))))
  17204. pkg
  17205. "\n"))
  17206. (if newline (concat pkg "\n") pkg))
  17207. (defun org-dvipng-color (attr)
  17208. "Return a RGB color specification for dvipng."
  17209. (apply 'format "rgb %s %s %s"
  17210. (mapcar 'org-normalize-color
  17211. (if (featurep 'xemacs)
  17212. (color-rgb-components
  17213. (face-property 'default
  17214. (cond ((eq attr :foreground) 'foreground)
  17215. ((eq attr :background) 'background))))
  17216. (color-values (face-attribute 'default attr nil))))))
  17217. (defun org-dvipng-color-format (color-name)
  17218. "Convert COLOR-NAME to a RGB color value for dvipng."
  17219. (apply 'format "rgb %s %s %s"
  17220. (mapcar 'org-normalize-color
  17221. (color-values color-name))))
  17222. (defun org-latex-color (attr)
  17223. "Return a RGB color for the LaTeX color package."
  17224. (apply 'format "%s,%s,%s"
  17225. (mapcar 'org-normalize-color
  17226. (if (featurep 'xemacs)
  17227. (color-rgb-components
  17228. (face-property 'default
  17229. (cond ((eq attr :foreground) 'foreground)
  17230. ((eq attr :background) 'background))))
  17231. (color-values (face-attribute 'default attr nil))))))
  17232. (defun org-latex-color-format (color-name)
  17233. "Convert COLOR-NAME to a RGB color value."
  17234. (apply 'format "%s,%s,%s"
  17235. (mapcar 'org-normalize-color
  17236. (color-values color-name))))
  17237. (defun org-normalize-color (value)
  17238. "Return string to be used as color value for an RGB component."
  17239. (format "%g" (/ value 65535.0)))
  17240. ;; Image display
  17241. (defvar org-inline-image-overlays nil)
  17242. (make-variable-buffer-local 'org-inline-image-overlays)
  17243. (defun org-toggle-inline-images (&optional include-linked)
  17244. "Toggle the display of inline images.
  17245. INCLUDE-LINKED is passed to `org-display-inline-images'."
  17246. (interactive "P")
  17247. (if org-inline-image-overlays
  17248. (progn
  17249. (org-remove-inline-images)
  17250. (message "Inline image display turned off"))
  17251. (org-display-inline-images include-linked)
  17252. (if (and (org-called-interactively-p)
  17253. org-inline-image-overlays)
  17254. (message "%d images displayed inline"
  17255. (length org-inline-image-overlays))
  17256. (message "No images to display inline"))))
  17257. (defun org-redisplay-inline-images ()
  17258. "Refresh the display of inline images."
  17259. (interactive)
  17260. (if (not org-inline-image-overlays)
  17261. (org-toggle-inline-images)
  17262. (org-toggle-inline-images)
  17263. (org-toggle-inline-images)))
  17264. (defun org-display-inline-images (&optional include-linked refresh beg end)
  17265. "Display inline images.
  17266. Normally only links without a description part are inlined, because this
  17267. is how it will work for export. When INCLUDE-LINKED is set, also links
  17268. with a description part will be inlined. This can be nice for a quick
  17269. look at those images, but it does not reflect what exported files will look
  17270. like.
  17271. When REFRESH is set, refresh existing images between BEG and END.
  17272. This will create new image displays only if necessary.
  17273. BEG and END default to the buffer boundaries."
  17274. (interactive "P")
  17275. (when (display-graphic-p)
  17276. (unless refresh
  17277. (org-remove-inline-images)
  17278. (if (fboundp 'clear-image-cache) (clear-image-cache)))
  17279. (save-excursion
  17280. (save-restriction
  17281. (widen)
  17282. (setq beg (or beg (point-min)) end (or end (point-max)))
  17283. (goto-char beg)
  17284. (let ((re (concat "\\[\\[\\(\\(file:\\)\\|\\([./~]\\)\\)\\([^]\n]+?"
  17285. (substring (org-image-file-name-regexp) 0 -2)
  17286. "\\)\\]" (if include-linked "" "\\]")))
  17287. (case-fold-search t)
  17288. old file ov img type attrwidth width)
  17289. (while (re-search-forward re end t)
  17290. (setq old (get-char-property-and-overlay (match-beginning 1)
  17291. 'org-image-overlay)
  17292. file (expand-file-name
  17293. (concat (or (match-string 3) "") (match-string 4))))
  17294. (when (image-type-available-p 'imagemagick)
  17295. (setq attrwidth (if (or (listp org-image-actual-width)
  17296. (null org-image-actual-width))
  17297. (save-excursion
  17298. (save-match-data
  17299. (when (re-search-backward
  17300. "#\\+attr.*:width[ \t]+\\([^ ]+\\)"
  17301. (save-excursion
  17302. (re-search-backward "^[ \t]*$\\|\\`" nil t)) t)
  17303. (string-to-number (match-string 1))))))
  17304. width (cond ((eq org-image-actual-width t) nil)
  17305. ((null org-image-actual-width) attrwidth)
  17306. ((numberp org-image-actual-width)
  17307. org-image-actual-width)
  17308. ((listp org-image-actual-width)
  17309. (or attrwidth (car org-image-actual-width))))
  17310. type (if width 'imagemagick)))
  17311. (when (file-exists-p file)
  17312. (if (and (car-safe old) refresh)
  17313. (image-refresh (overlay-get (cdr old) 'display))
  17314. (setq img (save-match-data (create-image file type nil :width width)))
  17315. (when img
  17316. (setq ov (make-overlay (match-beginning 0) (match-end 0)))
  17317. (overlay-put ov 'display img)
  17318. (overlay-put ov 'face 'default)
  17319. (overlay-put ov 'org-image-overlay t)
  17320. (overlay-put ov 'modification-hooks
  17321. (list 'org-display-inline-remove-overlay))
  17322. (push ov org-inline-image-overlays))))))))))
  17323. (define-obsolete-function-alias
  17324. 'org-display-inline-modification-hook 'org-display-inline-remove-overlay "24.3")
  17325. (defun org-display-inline-remove-overlay (ov after beg end &optional len)
  17326. "Remove inline-display overlay if a corresponding region is modified."
  17327. (let ((inhibit-modification-hooks t))
  17328. (when (and ov after)
  17329. (delete ov org-inline-image-overlays)
  17330. (delete-overlay ov))))
  17331. (defun org-remove-inline-images ()
  17332. "Remove inline display of images."
  17333. (interactive)
  17334. (mapc 'delete-overlay org-inline-image-overlays)
  17335. (setq org-inline-image-overlays nil))
  17336. ;;;; Key bindings
  17337. ;; Outline functions from `outline-mode-prefix-map'
  17338. ;; that can be remapped in Org:
  17339. (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
  17340. (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
  17341. (define-key org-mode-map [remap outline-forward-same-level]
  17342. 'org-forward-heading-same-level)
  17343. (define-key org-mode-map [remap outline-backward-same-level]
  17344. 'org-backward-heading-same-level)
  17345. (define-key org-mode-map [remap show-branches]
  17346. 'org-kill-note-or-show-branches)
  17347. (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
  17348. (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
  17349. (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
  17350. ;; Outline functions from `outline-mode-prefix-map' that can not
  17351. ;; be remapped in Org:
  17352. ;;
  17353. ;; - the column "key binding" shows whether the Outline function is still
  17354. ;; available in Org mode on the same key that it has been bound to in
  17355. ;; Outline mode:
  17356. ;; - "overridden": key used for a different functionality in Org mode
  17357. ;; - else: key still bound to the same Outline function in Org mode
  17358. ;;
  17359. ;; | Outline function | key binding | Org replacement |
  17360. ;; |------------------------------------+-------------+-----------------------|
  17361. ;; | `outline-next-visible-heading' | `C-c C-n' | still same function |
  17362. ;; | `outline-previous-visible-heading' | `C-c C-p' | still same function |
  17363. ;; | `outline-up-heading' | `C-c C-u' | still same function |
  17364. ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
  17365. ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
  17366. ;; | `show-entry' | overridden | no replacement |
  17367. ;; | `show-children' | `C-c C-i' | visibility cycling |
  17368. ;; | `show-branches' | `C-c C-k' | still same function |
  17369. ;; | `show-subtree' | overridden | visibility cycling |
  17370. ;; | `show-all' | overridden | no replacement |
  17371. ;; | `hide-subtree' | overridden | visibility cycling |
  17372. ;; | `hide-body' | overridden | no replacement |
  17373. ;; | `hide-entry' | overridden | visibility cycling |
  17374. ;; | `hide-leaves' | overridden | no replacement |
  17375. ;; | `hide-sublevels' | overridden | no replacement |
  17376. ;; | `hide-other' | overridden | no replacement |
  17377. ;; Make `C-c C-x' a prefix key
  17378. (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
  17379. ;; TAB key with modifiers
  17380. (org-defkey org-mode-map "\C-i" 'org-cycle)
  17381. (org-defkey org-mode-map [(tab)] 'org-cycle)
  17382. (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
  17383. (org-defkey org-mode-map "\M-\t" 'pcomplete)
  17384. ;; The following line is necessary under Suse GNU/Linux
  17385. (unless (featurep 'xemacs)
  17386. (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
  17387. (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
  17388. (define-key org-mode-map [backtab] 'org-shifttab)
  17389. (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
  17390. (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
  17391. (org-defkey org-mode-map [(meta return)] 'org-meta-return)
  17392. ;; Cursor keys with modifiers
  17393. (org-defkey org-mode-map [(meta left)] 'org-metaleft)
  17394. (org-defkey org-mode-map [(meta right)] 'org-metaright)
  17395. (org-defkey org-mode-map [(meta up)] 'org-metaup)
  17396. (org-defkey org-mode-map [(meta down)] 'org-metadown)
  17397. (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
  17398. (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
  17399. (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
  17400. (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
  17401. (org-defkey org-mode-map [(shift up)] 'org-shiftup)
  17402. (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
  17403. (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
  17404. (org-defkey org-mode-map [(shift right)] 'org-shiftright)
  17405. (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
  17406. (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
  17407. (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
  17408. (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
  17409. ;; Babel keys
  17410. (define-key org-mode-map org-babel-key-prefix org-babel-map)
  17411. (mapc (lambda (pair)
  17412. (define-key org-babel-map (car pair) (cdr pair)))
  17413. org-babel-key-bindings)
  17414. ;;; Extra keys for tty access.
  17415. ;; We only set them when really needed because otherwise the
  17416. ;; menus don't show the simple keys
  17417. (when (or org-use-extra-keys
  17418. (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
  17419. (not window-system))
  17420. (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
  17421. (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
  17422. (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
  17423. (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
  17424. (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
  17425. (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
  17426. (org-defkey org-mode-map [?\e (right)] 'org-metaright)
  17427. (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
  17428. (org-defkey org-mode-map [?\e (up)] 'org-metaup)
  17429. (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
  17430. (org-defkey org-mode-map [?\e (down)] 'org-metadown)
  17431. (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
  17432. (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
  17433. (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
  17434. (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
  17435. (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
  17436. (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
  17437. (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
  17438. (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
  17439. (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
  17440. (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
  17441. (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
  17442. (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
  17443. (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
  17444. (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
  17445. (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
  17446. (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
  17447. (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
  17448. ;; All the other keys
  17449. (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
  17450. (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
  17451. (if (boundp 'narrow-map)
  17452. (org-defkey narrow-map "s" 'org-narrow-to-subtree)
  17453. (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
  17454. (if (boundp 'narrow-map)
  17455. (org-defkey narrow-map "b" 'org-narrow-to-block)
  17456. (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
  17457. (if (boundp 'narrow-map)
  17458. (org-defkey narrow-map "e" 'org-narrow-to-element)
  17459. (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
  17460. (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
  17461. (org-defkey org-mode-map "\M-}" 'org-forward-element)
  17462. (org-defkey org-mode-map "\M-{" 'org-backward-element)
  17463. (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
  17464. (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
  17465. (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
  17466. (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
  17467. (org-defkey org-mode-map "\C-c\M-f" 'org-next-block)
  17468. (org-defkey org-mode-map "\C-c\M-b" 'org-previous-block)
  17469. (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
  17470. (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
  17471. (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
  17472. (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
  17473. (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
  17474. (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
  17475. (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
  17476. (org-defkey org-mode-map "\C-c\C-xq" 'org-toggle-tags-groups)
  17477. (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
  17478. (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
  17479. (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
  17480. (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
  17481. (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
  17482. (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
  17483. (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
  17484. (org-defkey org-mode-map "\C-c\M-w" 'org-copy)
  17485. (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
  17486. (org-defkey org-mode-map "\C-c\\" 'org-match-sparse-tree) ; Minor-mode res.
  17487. (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
  17488. (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
  17489. (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
  17490. (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
  17491. (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
  17492. (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
  17493. (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
  17494. (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
  17495. (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
  17496. (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
  17497. (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
  17498. (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
  17499. (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
  17500. (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
  17501. (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
  17502. (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
  17503. (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
  17504. (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
  17505. (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
  17506. (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
  17507. (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
  17508. (org-defkey org-mode-map [(control ?\')] 'org-cycle-agenda-files)
  17509. (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
  17510. (org-defkey org-mode-map "\C-c]" 'org-remove-file)
  17511. (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
  17512. (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
  17513. (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
  17514. (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
  17515. (org-defkey org-mode-map "\C-c^" 'org-sort)
  17516. (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
  17517. (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
  17518. (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
  17519. (org-defkey org-mode-map [remap open-line] 'org-open-line)
  17520. (org-defkey org-mode-map [remap forward-paragraph] 'org-forward-element)
  17521. (org-defkey org-mode-map [remap backward-paragraph] 'org-backward-element)
  17522. (org-defkey org-mode-map "\C-m" 'org-return)
  17523. (org-defkey org-mode-map "\C-j" 'org-return-indent)
  17524. (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
  17525. (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
  17526. (org-defkey org-mode-map "\C-c+" 'org-table-sum)
  17527. (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
  17528. (org-defkey org-mode-map "\C-c'" 'org-edit-special)
  17529. (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
  17530. (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
  17531. (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
  17532. (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
  17533. (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
  17534. (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
  17535. (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
  17536. (org-defkey org-mode-map "\C-c\C-e" 'org-export-dispatch)
  17537. (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
  17538. (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
  17539. (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
  17540. (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
  17541. (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
  17542. (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
  17543. (org-defkey org-mode-map "\M-h" 'org-mark-element)
  17544. (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
  17545. ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
  17546. (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
  17547. (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
  17548. (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
  17549. (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
  17550. (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
  17551. (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
  17552. (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
  17553. (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
  17554. (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
  17555. (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
  17556. (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
  17557. (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
  17558. (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
  17559. (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
  17560. (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
  17561. (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
  17562. (org-defkey org-mode-map "\C-c\C-x\\" 'org-toggle-pretty-entities)
  17563. (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
  17564. (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
  17565. (org-defkey org-mode-map "\C-c\C-xP" 'org-set-property-and-value)
  17566. (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
  17567. (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
  17568. (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
  17569. (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
  17570. (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
  17571. (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
  17572. (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
  17573. (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
  17574. (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
  17575. (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
  17576. (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
  17577. (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
  17578. (define-key org-mode-map "\C-c\C-x!" 'org-reload)
  17579. (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
  17580. (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
  17581. (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
  17582. (when (featurep 'xemacs)
  17583. (org-defkey org-mode-map 'button3 'popup-mode-menu))
  17584. (defconst org-speed-commands-default
  17585. '(
  17586. ("Outline Navigation")
  17587. ("n" . (org-speed-move-safe 'outline-next-visible-heading))
  17588. ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
  17589. ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
  17590. ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
  17591. ("F" . org-next-block)
  17592. ("B" . org-previous-block)
  17593. ("u" . (org-speed-move-safe 'outline-up-heading))
  17594. ("j" . org-goto)
  17595. ("g" . (org-refile t))
  17596. ("Outline Visibility")
  17597. ("c" . org-cycle)
  17598. ("C" . org-shifttab)
  17599. (" " . org-display-outline-path)
  17600. ("s" . org-narrow-to-subtree)
  17601. ("=" . org-columns)
  17602. ("Outline Structure Editing")
  17603. ("U" . org-shiftmetaup)
  17604. ("D" . org-shiftmetadown)
  17605. ("r" . org-metaright)
  17606. ("l" . org-metaleft)
  17607. ("R" . org-shiftmetaright)
  17608. ("L" . org-shiftmetaleft)
  17609. ("i" . (progn (forward-char 1) (call-interactively
  17610. 'org-insert-heading-respect-content)))
  17611. ("^" . org-sort)
  17612. ("w" . org-refile)
  17613. ("a" . org-archive-subtree-default-with-confirmation)
  17614. ("@" . org-mark-subtree)
  17615. ("#" . org-toggle-comment)
  17616. ("Clock Commands")
  17617. ("I" . org-clock-in)
  17618. ("O" . org-clock-out)
  17619. ("Meta Data Editing")
  17620. ("t" . org-todo)
  17621. ("," . (org-priority))
  17622. ("0" . (org-priority ?\ ))
  17623. ("1" . (org-priority ?A))
  17624. ("2" . (org-priority ?B))
  17625. ("3" . (org-priority ?C))
  17626. (":" . org-set-tags-command)
  17627. ("e" . org-set-effort)
  17628. ("E" . org-inc-effort)
  17629. ("W" . (lambda(m) (interactive "sMinutes before warning: ")
  17630. (org-entry-put (point) "APPT_WARNTIME" m)))
  17631. ("Agenda Views etc")
  17632. ("v" . org-agenda)
  17633. ("/" . org-sparse-tree)
  17634. ("Misc")
  17635. ("o" . org-open-at-point)
  17636. ("?" . org-speed-command-help)
  17637. ("<" . (org-agenda-set-restriction-lock 'subtree))
  17638. (">" . (org-agenda-remove-restriction-lock))
  17639. )
  17640. "The default speed commands.")
  17641. (defun org-print-speed-command (e)
  17642. (if (> (length (car e)) 1)
  17643. (progn
  17644. (princ "\n")
  17645. (princ (car e))
  17646. (princ "\n")
  17647. (princ (make-string (length (car e)) ?-))
  17648. (princ "\n"))
  17649. (princ (car e))
  17650. (princ " ")
  17651. (if (symbolp (cdr e))
  17652. (princ (symbol-name (cdr e)))
  17653. (prin1 (cdr e)))
  17654. (princ "\n")))
  17655. (defun org-speed-command-help ()
  17656. "Show the available speed commands."
  17657. (interactive)
  17658. (if (not org-use-speed-commands)
  17659. (user-error "Speed commands are not activated, customize `org-use-speed-commands'")
  17660. (with-output-to-temp-buffer "*Help*"
  17661. (princ "User-defined Speed commands\n===========================\n")
  17662. (mapc 'org-print-speed-command org-speed-commands-user)
  17663. (princ "\n")
  17664. (princ "Built-in Speed commands\n=======================\n")
  17665. (mapc 'org-print-speed-command org-speed-commands-default))
  17666. (with-current-buffer "*Help*"
  17667. (setq truncate-lines t))))
  17668. (defun org-speed-move-safe (cmd)
  17669. "Execute CMD, but make sure that the cursor always ends up in a headline.
  17670. If not, return to the original position and throw an error."
  17671. (interactive)
  17672. (let ((pos (point)))
  17673. (call-interactively cmd)
  17674. (unless (and (bolp) (org-at-heading-p))
  17675. (goto-char pos)
  17676. (error "Boundary reached while executing %s" cmd))))
  17677. (defvar org-self-insert-command-undo-counter 0)
  17678. (defvar org-table-auto-blank-field) ; defined in org-table.el
  17679. (defvar org-speed-command nil)
  17680. (define-obsolete-function-alias
  17681. 'org-speed-command-default-hook 'org-speed-command-activate "24.3")
  17682. (defun org-speed-command-activate (keys)
  17683. "Hook for activating single-letter speed commands.
  17684. `org-speed-commands-default' specifies a minimal command set.
  17685. Use `org-speed-commands-user' for further customization."
  17686. (when (or (and (bolp) (looking-at org-outline-regexp))
  17687. (and (functionp org-use-speed-commands)
  17688. (funcall org-use-speed-commands)))
  17689. (cdr (assoc keys (append org-speed-commands-user
  17690. org-speed-commands-default)))))
  17691. (define-obsolete-function-alias
  17692. 'org-babel-speed-command-hook 'org-babel-speed-command-activate "24.3")
  17693. (defun org-babel-speed-command-activate (keys)
  17694. "Hook for activating single-letter code block commands."
  17695. (when (and (bolp) (looking-at org-babel-src-block-regexp))
  17696. (cdr (assoc keys org-babel-key-bindings))))
  17697. (defcustom org-speed-command-hook
  17698. '(org-speed-command-default-hook org-babel-speed-command-hook)
  17699. "Hook for activating speed commands at strategic locations.
  17700. Hook functions are called in sequence until a valid handler is
  17701. found.
  17702. Each hook takes a single argument, a user-pressed command key
  17703. which is also a `self-insert-command' from the global map.
  17704. Within the hook, examine the cursor position and the command key
  17705. and return nil or a valid handler as appropriate. Handler could
  17706. be one of an interactive command, a function, or a form.
  17707. Set `org-use-speed-commands' to non-nil value to enable this
  17708. hook. The default setting is `org-speed-command-activate'."
  17709. :group 'org-structure
  17710. :version "24.1"
  17711. :type 'hook)
  17712. (defun org-self-insert-command (N)
  17713. "Like `self-insert-command', use overwrite-mode for whitespace in tables.
  17714. If the cursor is in a table looking at whitespace, the whitespace is
  17715. overwritten, and the table is not marked as requiring realignment."
  17716. (interactive "p")
  17717. (org-check-before-invisible-edit 'insert)
  17718. (cond
  17719. ((and org-use-speed-commands
  17720. (setq org-speed-command
  17721. (run-hook-with-args-until-success
  17722. 'org-speed-command-hook (this-command-keys))))
  17723. (cond
  17724. ((commandp org-speed-command)
  17725. (setq this-command org-speed-command)
  17726. (call-interactively org-speed-command))
  17727. ((functionp org-speed-command)
  17728. (funcall org-speed-command))
  17729. ((and org-speed-command (listp org-speed-command))
  17730. (eval org-speed-command))
  17731. (t (let (org-use-speed-commands)
  17732. (call-interactively 'org-self-insert-command)))))
  17733. ((and
  17734. (org-table-p)
  17735. (progn
  17736. ;; check if we blank the field, and if that triggers align
  17737. (and (featurep 'org-table) org-table-auto-blank-field
  17738. (member last-command
  17739. '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
  17740. (if (or (equal (char-after) ?\ ) (looking-at "[^|\n]* |"))
  17741. ;; got extra space, this field does not determine column width
  17742. (let (org-table-may-need-update) (org-table-blank-field))
  17743. ;; no extra space, this field may determine column width
  17744. (org-table-blank-field)))
  17745. t)
  17746. (eq N 1)
  17747. (looking-at "[^|\n]* |"))
  17748. (let (org-table-may-need-update)
  17749. (goto-char (1- (match-end 0)))
  17750. (backward-delete-char 1)
  17751. (goto-char (match-beginning 0))
  17752. (self-insert-command N)))
  17753. (t
  17754. (setq org-table-may-need-update t)
  17755. (self-insert-command N)
  17756. (org-fix-tags-on-the-fly)
  17757. (if org-self-insert-cluster-for-undo
  17758. (if (not (eq last-command 'org-self-insert-command))
  17759. (setq org-self-insert-command-undo-counter 1)
  17760. (if (>= org-self-insert-command-undo-counter 20)
  17761. (setq org-self-insert-command-undo-counter 1)
  17762. (and (> org-self-insert-command-undo-counter 0)
  17763. buffer-undo-list (listp buffer-undo-list)
  17764. (not (cadr buffer-undo-list)) ; remove nil entry
  17765. (setcdr buffer-undo-list (cddr buffer-undo-list)))
  17766. (setq org-self-insert-command-undo-counter
  17767. (1+ org-self-insert-command-undo-counter))))))))
  17768. (defun org-check-before-invisible-edit (kind)
  17769. "Check is editing if kind KIND would be dangerous with invisible text around.
  17770. The detailed reaction depends on the user option `org-catch-invisible-edits'."
  17771. ;; First, try to get out of here as quickly as possible, to reduce overhead
  17772. (if (and org-catch-invisible-edits
  17773. (or (not (boundp 'visible-mode)) (not visible-mode))
  17774. (or (get-char-property (point) 'invisible)
  17775. (get-char-property (max (point-min) (1- (point))) 'invisible)))
  17776. ;; OK, we need to take a closer look
  17777. (let* ((invisible-at-point (get-char-property (point) 'invisible))
  17778. (invisible-before-point (if (bobp) nil (get-char-property
  17779. (1- (point)) 'invisible)))
  17780. (border-and-ok-direction
  17781. (or
  17782. ;; Check if we are acting predictably before invisible text
  17783. (and invisible-at-point (not invisible-before-point)
  17784. (memq kind '(insert delete-backward)))
  17785. ;; Check if we are acting predictably after invisible text
  17786. ;; This works not well, and I have turned it off. It seems
  17787. ;; better to always show and stop after invisible text.
  17788. ;; (and (not invisible-at-point) invisible-before-point
  17789. ;; (memq kind '(insert delete)))
  17790. )))
  17791. (when (or (memq invisible-at-point '(outline org-hide-block t))
  17792. (memq invisible-before-point '(outline org-hide-block t)))
  17793. (if (eq org-catch-invisible-edits 'error)
  17794. (user-error "Editing in invisible areas is prohibited, make them visible first"))
  17795. (if (and org-custom-properties-overlays
  17796. (y-or-n-p "Display invisible properties in this buffer? "))
  17797. (org-toggle-custom-properties-visibility)
  17798. ;; Make the area visible
  17799. (save-excursion
  17800. (if invisible-before-point
  17801. (goto-char (previous-single-char-property-change
  17802. (point) 'invisible)))
  17803. (org-cycle))
  17804. (cond
  17805. ((eq org-catch-invisible-edits 'show)
  17806. ;; That's it, we do the edit after showing
  17807. (message
  17808. "Unfolding invisible region around point before editing")
  17809. (sit-for 1))
  17810. ((and (eq org-catch-invisible-edits 'smart)
  17811. border-and-ok-direction)
  17812. (message "Unfolding invisible region around point before editing"))
  17813. (t
  17814. ;; Don't do the edit, make the user repeat it in full visibility
  17815. (user-error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
  17816. (defun org-fix-tags-on-the-fly ()
  17817. (when (and (equal (char-after (point-at-bol)) ?*)
  17818. (org-at-heading-p))
  17819. (org-align-tags-here org-tags-column)))
  17820. (defun org-delete-backward-char (N)
  17821. "Like `delete-backward-char', insert whitespace at field end in tables.
  17822. When deleting backwards, in tables this function will insert whitespace in
  17823. front of the next \"|\" separator, to keep the table aligned. The table will
  17824. still be marked for re-alignment if the field did fill the entire column,
  17825. because, in this case the deletion might narrow the column."
  17826. (interactive "p")
  17827. (save-match-data
  17828. (org-check-before-invisible-edit 'delete-backward)
  17829. (if (and (org-table-p)
  17830. (eq N 1)
  17831. (string-match "|" (buffer-substring (point-at-bol) (point)))
  17832. (looking-at ".*?|"))
  17833. (let ((pos (point))
  17834. (noalign (looking-at "[^|\n\r]* |"))
  17835. (c org-table-may-need-update))
  17836. (backward-delete-char N)
  17837. (if (not overwrite-mode)
  17838. (progn
  17839. (skip-chars-forward "^|")
  17840. (insert " ")
  17841. (goto-char (1- pos))))
  17842. ;; noalign: if there were two spaces at the end, this field
  17843. ;; does not determine the width of the column.
  17844. (if noalign (setq org-table-may-need-update c)))
  17845. (backward-delete-char N)
  17846. (org-fix-tags-on-the-fly))))
  17847. (defun org-delete-char (N)
  17848. "Like `delete-char', but insert whitespace at field end in tables.
  17849. When deleting characters, in tables this function will insert whitespace in
  17850. front of the next \"|\" separator, to keep the table aligned. The table will
  17851. still be marked for re-alignment if the field did fill the entire column,
  17852. because, in this case the deletion might narrow the column."
  17853. (interactive "p")
  17854. (save-match-data
  17855. (org-check-before-invisible-edit 'delete)
  17856. (if (and (org-table-p)
  17857. (not (bolp))
  17858. (not (= (char-after) ?|))
  17859. (eq N 1))
  17860. (if (looking-at ".*?|")
  17861. (let ((pos (point))
  17862. (noalign (looking-at "[^|\n\r]* |"))
  17863. (c org-table-may-need-update))
  17864. (replace-match
  17865. (concat (substring (match-string 0) 1 -1) " |") nil t)
  17866. (goto-char pos)
  17867. ;; noalign: if there were two spaces at the end, this field
  17868. ;; does not determine the width of the column.
  17869. (if noalign (setq org-table-may-need-update c)))
  17870. (delete-char N))
  17871. (delete-char N)
  17872. (org-fix-tags-on-the-fly))))
  17873. ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
  17874. (put 'org-self-insert-command 'delete-selection t)
  17875. (put 'orgtbl-self-insert-command 'delete-selection t)
  17876. (put 'org-delete-char 'delete-selection 'supersede)
  17877. (put 'org-delete-backward-char 'delete-selection 'supersede)
  17878. (put 'org-yank 'delete-selection 'yank)
  17879. ;; Make `flyspell-mode' delay after some commands
  17880. (put 'org-self-insert-command 'flyspell-delayed t)
  17881. (put 'orgtbl-self-insert-command 'flyspell-delayed t)
  17882. (put 'org-delete-char 'flyspell-delayed t)
  17883. (put 'org-delete-backward-char 'flyspell-delayed t)
  17884. ;; Make pabbrev-mode expand after org-mode commands
  17885. (put 'org-self-insert-command 'pabbrev-expand-after-command t)
  17886. (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
  17887. ;; How to do this: Measure non-white length of current string
  17888. ;; If equal to column width, we should realign.
  17889. (defun org-remap (map &rest commands)
  17890. "In MAP, remap the functions given in COMMANDS.
  17891. COMMANDS is a list of alternating OLDDEF NEWDEF command names."
  17892. (let (new old)
  17893. (while commands
  17894. (setq old (pop commands) new (pop commands))
  17895. (if (fboundp 'command-remapping)
  17896. (org-defkey map (vector 'remap old) new)
  17897. (substitute-key-definition old new map global-map)))))
  17898. (defun org-transpose-words ()
  17899. "Transpose words for Org.
  17900. This uses the `org-mode-transpose-word-syntax-table' syntax
  17901. table, which interprets characters in `org-emphasis-alist' as
  17902. word constituants."
  17903. (interactive)
  17904. (with-syntax-table org-mode-transpose-word-syntax-table
  17905. (call-interactively 'transpose-words)))
  17906. (org-remap org-mode-map 'transpose-words 'org-transpose-words)
  17907. (when (eq org-enable-table-editor 'optimized)
  17908. ;; If the user wants maximum table support, we need to hijack
  17909. ;; some standard editing functions
  17910. (org-remap org-mode-map
  17911. 'self-insert-command 'org-self-insert-command
  17912. 'delete-char 'org-delete-char
  17913. 'delete-backward-char 'org-delete-backward-char)
  17914. (org-defkey org-mode-map "|" 'org-force-self-insert))
  17915. (defvar org-ctrl-c-ctrl-c-hook nil
  17916. "Hook for functions attaching themselves to `C-c C-c'.
  17917. This can be used to add additional functionality to the C-c C-c
  17918. key which executes context-dependent commands. This hook is run
  17919. before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
  17920. run after the last test.
  17921. Each function will be called with no arguments. The function
  17922. must check if the context is appropriate for it to act. If yes,
  17923. it should do its thing and then return a non-nil value. If the
  17924. context is wrong, just do nothing and return nil.")
  17925. (defvar org-ctrl-c-ctrl-c-final-hook nil
  17926. "Hook for functions attaching themselves to `C-c C-c'.
  17927. This can be used to add additional functionality to the C-c C-c
  17928. key which executes context-dependent commands. This hook is run
  17929. after any other test, while `org-ctrl-c-ctrl-c-hook' is run
  17930. before the first test.
  17931. Each function will be called with no arguments. The function
  17932. must check if the context is appropriate for it to act. If yes,
  17933. it should do its thing and then return a non-nil value. If the
  17934. context is wrong, just do nothing and return nil.")
  17935. (defvar org-tab-first-hook nil
  17936. "Hook for functions to attach themselves to TAB.
  17937. See `org-ctrl-c-ctrl-c-hook' for more information.
  17938. This hook runs as the first action when TAB is pressed, even before
  17939. `org-cycle' messes around with the `outline-regexp' to cater for
  17940. inline tasks and plain list item folding.
  17941. If any function in this hook returns t, any other actions that
  17942. would have been caused by TAB (such as table field motion or visibility
  17943. cycling) will not occur.")
  17944. (defvar org-tab-after-check-for-table-hook nil
  17945. "Hook for functions to attach themselves to TAB.
  17946. See `org-ctrl-c-ctrl-c-hook' for more information.
  17947. This hook runs after it has been established that the cursor is not in a
  17948. table, but before checking if the cursor is in a headline or if global cycling
  17949. should be done.
  17950. If any function in this hook returns t, not other actions like visibility
  17951. cycling will be done.")
  17952. (defvar org-tab-after-check-for-cycling-hook nil
  17953. "Hook for functions to attach themselves to TAB.
  17954. See `org-ctrl-c-ctrl-c-hook' for more information.
  17955. This hook runs after it has been established that not table field motion and
  17956. not visibility should be done because of current context. This is probably
  17957. the place where a package like yasnippets can hook in.")
  17958. (defvar org-tab-before-tab-emulation-hook nil
  17959. "Hook for functions to attach themselves to TAB.
  17960. See `org-ctrl-c-ctrl-c-hook' for more information.
  17961. This hook runs after every other options for TAB have been exhausted, but
  17962. before indentation and \t insertion takes place.")
  17963. (defvar org-metaleft-hook nil
  17964. "Hook for functions attaching themselves to `M-left'.
  17965. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17966. (defvar org-metaright-hook nil
  17967. "Hook for functions attaching themselves to `M-right'.
  17968. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17969. (defvar org-metaup-hook nil
  17970. "Hook for functions attaching themselves to `M-up'.
  17971. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17972. (defvar org-metadown-hook nil
  17973. "Hook for functions attaching themselves to `M-down'.
  17974. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17975. (defvar org-shiftmetaleft-hook nil
  17976. "Hook for functions attaching themselves to `M-S-left'.
  17977. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17978. (defvar org-shiftmetaright-hook nil
  17979. "Hook for functions attaching themselves to `M-S-right'.
  17980. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17981. (defvar org-shiftmetaup-hook nil
  17982. "Hook for functions attaching themselves to `M-S-up'.
  17983. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17984. (defvar org-shiftmetadown-hook nil
  17985. "Hook for functions attaching themselves to `M-S-down'.
  17986. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17987. (defvar org-metareturn-hook nil
  17988. "Hook for functions attaching themselves to `M-RET'.
  17989. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17990. (defvar org-shiftup-hook nil
  17991. "Hook for functions attaching themselves to `S-up'.
  17992. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17993. (defvar org-shiftup-final-hook nil
  17994. "Hook for functions attaching themselves to `S-up'.
  17995. This one runs after all other options except shift-select have been excluded.
  17996. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17997. (defvar org-shiftdown-hook nil
  17998. "Hook for functions attaching themselves to `S-down'.
  17999. See `org-ctrl-c-ctrl-c-hook' for more information.")
  18000. (defvar org-shiftdown-final-hook nil
  18001. "Hook for functions attaching themselves to `S-down'.
  18002. This one runs after all other options except shift-select have been excluded.
  18003. See `org-ctrl-c-ctrl-c-hook' for more information.")
  18004. (defvar org-shiftleft-hook nil
  18005. "Hook for functions attaching themselves to `S-left'.
  18006. See `org-ctrl-c-ctrl-c-hook' for more information.")
  18007. (defvar org-shiftleft-final-hook nil
  18008. "Hook for functions attaching themselves to `S-left'.
  18009. This one runs after all other options except shift-select have been excluded.
  18010. See `org-ctrl-c-ctrl-c-hook' for more information.")
  18011. (defvar org-shiftright-hook nil
  18012. "Hook for functions attaching themselves to `S-right'.
  18013. See `org-ctrl-c-ctrl-c-hook' for more information.")
  18014. (defvar org-shiftright-final-hook nil
  18015. "Hook for functions attaching themselves to `S-right'.
  18016. This one runs after all other options except shift-select have been excluded.
  18017. See `org-ctrl-c-ctrl-c-hook' for more information.")
  18018. (defun org-modifier-cursor-error ()
  18019. "Throw an error, a modified cursor command was applied in wrong context."
  18020. (user-error "This command is active in special context like tables, headlines or items"))
  18021. (defun org-shiftselect-error ()
  18022. "Throw an error because Shift-Cursor command was applied in wrong context."
  18023. (if (and (boundp 'shift-select-mode) shift-select-mode)
  18024. (user-error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
  18025. (user-error "This command works only in special context like headlines or timestamps")))
  18026. (defun org-call-for-shift-select (cmd)
  18027. (let ((this-command-keys-shift-translated t))
  18028. (call-interactively cmd)))
  18029. (defun org-shifttab (&optional arg)
  18030. "Global visibility cycling or move to previous table field.
  18031. Call `org-table-previous-field' within a table.
  18032. When ARG is nil, cycle globally through visibility states.
  18033. When ARG is a numeric prefix, show contents of this level."
  18034. (interactive "P")
  18035. (cond
  18036. ((org-at-table-p) (call-interactively 'org-table-previous-field))
  18037. ((integerp arg)
  18038. (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
  18039. (message "Content view to level: %d" arg)
  18040. (org-content (prefix-numeric-value arg2))
  18041. (org-cycle-show-empty-lines t)
  18042. (setq org-cycle-global-status 'overview)))
  18043. (t (call-interactively 'org-global-cycle))))
  18044. (defun org-shiftmetaleft ()
  18045. "Promote subtree or delete table column.
  18046. Calls `org-promote-subtree', `org-outdent-item-tree', or
  18047. `org-table-delete-column', depending on context. See the
  18048. individual commands for more information."
  18049. (interactive)
  18050. (cond
  18051. ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
  18052. ((org-at-table-p) (call-interactively 'org-table-delete-column))
  18053. ((org-at-heading-p) (call-interactively 'org-promote-subtree))
  18054. ((if (not (org-region-active-p)) (org-at-item-p)
  18055. (save-excursion (goto-char (region-beginning))
  18056. (org-at-item-p)))
  18057. (call-interactively 'org-outdent-item-tree))
  18058. (t (org-modifier-cursor-error))))
  18059. (defun org-shiftmetaright ()
  18060. "Demote subtree or insert table column.
  18061. Calls `org-demote-subtree', `org-indent-item-tree', or
  18062. `org-table-insert-column', depending on context. See the
  18063. individual commands for more information."
  18064. (interactive)
  18065. (cond
  18066. ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
  18067. ((org-at-table-p) (call-interactively 'org-table-insert-column))
  18068. ((org-at-heading-p) (call-interactively 'org-demote-subtree))
  18069. ((if (not (org-region-active-p)) (org-at-item-p)
  18070. (save-excursion (goto-char (region-beginning))
  18071. (org-at-item-p)))
  18072. (call-interactively 'org-indent-item-tree))
  18073. (t (org-modifier-cursor-error))))
  18074. (defun org-shiftmetaup (&optional arg)
  18075. "Move subtree up or kill table row.
  18076. Calls `org-move-subtree-up' or `org-table-kill-row' or
  18077. `org-move-item-up' or `org-timestamp-up', depending on context.
  18078. See the individual commands for more information."
  18079. (interactive "P")
  18080. (cond
  18081. ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
  18082. ((org-at-table-p) (call-interactively 'org-table-kill-row))
  18083. ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
  18084. ((org-at-item-p) (call-interactively 'org-move-item-up))
  18085. ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
  18086. (call-interactively 'org-timestamp-up)))
  18087. (t (call-interactively 'org-drag-line-backward))))
  18088. (defun org-shiftmetadown (&optional arg)
  18089. "Move subtree down or insert table row.
  18090. Calls `org-move-subtree-down' or `org-table-insert-row' or
  18091. `org-move-item-down' or `org-timestamp-up', depending on context.
  18092. See the individual commands for more information."
  18093. (interactive "P")
  18094. (cond
  18095. ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
  18096. ((org-at-table-p) (call-interactively 'org-table-insert-row))
  18097. ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
  18098. ((org-at-item-p) (call-interactively 'org-move-item-down))
  18099. ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
  18100. (call-interactively 'org-timestamp-down)))
  18101. (t (call-interactively 'org-drag-line-forward))))
  18102. (defsubst org-hidden-tree-error ()
  18103. (user-error
  18104. "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
  18105. (defun org-metaleft (&optional arg)
  18106. "Promote heading or move table column to left.
  18107. Calls `org-do-promote' or `org-table-move-column', depending on context.
  18108. With no specific context, calls the Emacs default `backward-word'.
  18109. See the individual commands for more information."
  18110. (interactive "P")
  18111. (cond
  18112. ((run-hook-with-args-until-success 'org-metaleft-hook))
  18113. ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
  18114. ((org-with-limited-levels
  18115. (or (org-at-heading-p)
  18116. (and (org-region-active-p)
  18117. (save-excursion
  18118. (goto-char (region-beginning))
  18119. (org-at-heading-p)))))
  18120. (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
  18121. (call-interactively 'org-do-promote))
  18122. ;; At an inline task.
  18123. ((org-at-heading-p)
  18124. (call-interactively 'org-inlinetask-promote))
  18125. ((or (org-at-item-p)
  18126. (and (org-region-active-p)
  18127. (save-excursion
  18128. (goto-char (region-beginning))
  18129. (org-at-item-p))))
  18130. (when (org-check-for-hidden 'items) (org-hidden-tree-error))
  18131. (call-interactively 'org-outdent-item))
  18132. (t (call-interactively 'backward-word))))
  18133. (defun org-metaright (&optional arg)
  18134. "Demote a subtree, a list item or move table column to right.
  18135. In front of a drawer or a block keyword, indent it correctly.
  18136. With no specific context, calls the Emacs default `forward-word'.
  18137. See the individual commands for more information."
  18138. (interactive "P")
  18139. (cond
  18140. ((run-hook-with-args-until-success 'org-metaright-hook))
  18141. ((org-at-table-p) (call-interactively 'org-table-move-column))
  18142. ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
  18143. ((org-at-block-p) (call-interactively 'org-indent-block))
  18144. ((org-with-limited-levels
  18145. (or (org-at-heading-p)
  18146. (and (org-region-active-p)
  18147. (save-excursion
  18148. (goto-char (region-beginning))
  18149. (org-at-heading-p)))))
  18150. (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
  18151. (call-interactively 'org-do-demote))
  18152. ;; At an inline task.
  18153. ((org-at-heading-p)
  18154. (call-interactively 'org-inlinetask-demote))
  18155. ((or (org-at-item-p)
  18156. (and (org-region-active-p)
  18157. (save-excursion
  18158. (goto-char (region-beginning))
  18159. (org-at-item-p))))
  18160. (when (org-check-for-hidden 'items) (org-hidden-tree-error))
  18161. (call-interactively 'org-indent-item))
  18162. (t (call-interactively 'forward-word))))
  18163. (defun org-check-for-hidden (what)
  18164. "Check if there are hidden headlines/items in the current visual line.
  18165. WHAT can be either `headlines' or `items'. If the current line is
  18166. an outline or item heading and it has a folded subtree below it,
  18167. this function returns t, nil otherwise."
  18168. (let ((re (cond
  18169. ((eq what 'headlines) org-outline-regexp-bol)
  18170. ((eq what 'items) (org-item-beginning-re))
  18171. (t (error "This should not happen"))))
  18172. beg end)
  18173. (save-excursion
  18174. (catch 'exit
  18175. (unless (org-region-active-p)
  18176. (setq beg (point-at-bol))
  18177. (beginning-of-line 2)
  18178. (while (and (not (eobp)) ;; this is like `next-line'
  18179. (get-char-property (1- (point)) 'invisible))
  18180. (beginning-of-line 2))
  18181. (setq end (point))
  18182. (goto-char beg)
  18183. (goto-char (point-at-eol))
  18184. (setq end (max end (point)))
  18185. (while (re-search-forward re end t)
  18186. (if (get-char-property (match-beginning 0) 'invisible)
  18187. (throw 'exit t))))
  18188. nil))))
  18189. (defun org-metaup (&optional arg)
  18190. "Move subtree up or move table row up.
  18191. Calls `org-move-subtree-up' or `org-table-move-row' or
  18192. `org-move-item-up', depending on context. See the individual commands
  18193. for more information."
  18194. (interactive "P")
  18195. (cond
  18196. ((run-hook-with-args-until-success 'org-metaup-hook))
  18197. ((org-region-active-p)
  18198. (let* ((a (min (region-beginning) (region-end)))
  18199. (b (1- (max (region-beginning) (region-end))))
  18200. (c (save-excursion (goto-char a)
  18201. (move-beginning-of-line 0)))
  18202. (d (save-excursion (goto-char a)
  18203. (move-end-of-line 0) (point))))
  18204. (transpose-regions a b c d)
  18205. (goto-char c)))
  18206. ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
  18207. ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
  18208. ((org-at-item-p) (call-interactively 'org-move-item-up))
  18209. (t (org-drag-element-backward))))
  18210. (defun org-metadown (&optional arg)
  18211. "Move subtree down or move table row down.
  18212. Calls `org-move-subtree-down' or `org-table-move-row' or
  18213. `org-move-item-down', depending on context. See the individual
  18214. commands for more information."
  18215. (interactive "P")
  18216. (cond
  18217. ((run-hook-with-args-until-success 'org-metadown-hook))
  18218. ((org-region-active-p)
  18219. (let* ((a (min (region-beginning) (region-end)))
  18220. (b (max (region-beginning) (region-end)))
  18221. (c (save-excursion (goto-char b)
  18222. (move-beginning-of-line 1)))
  18223. (d (save-excursion (goto-char b)
  18224. (move-end-of-line 1) (1+ (point)))))
  18225. (transpose-regions a b c d)
  18226. (goto-char d)))
  18227. ((org-at-table-p) (call-interactively 'org-table-move-row))
  18228. ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
  18229. ((org-at-item-p) (call-interactively 'org-move-item-down))
  18230. (t (org-drag-element-forward))))
  18231. (defun org-shiftup (&optional arg)
  18232. "Increase item in timestamp or increase priority of current headline.
  18233. Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
  18234. depending on context. See the individual commands for more information."
  18235. (interactive "P")
  18236. (cond
  18237. ((run-hook-with-args-until-success 'org-shiftup-hook))
  18238. ((and org-support-shift-select (org-region-active-p))
  18239. (org-call-for-shift-select 'previous-line))
  18240. ((org-at-timestamp-p t)
  18241. (call-interactively (if org-edit-timestamp-down-means-later
  18242. 'org-timestamp-down 'org-timestamp-up)))
  18243. ((and (not (eq org-support-shift-select 'always))
  18244. org-enable-priority-commands
  18245. (org-at-heading-p))
  18246. (call-interactively 'org-priority-up))
  18247. ((and (not org-support-shift-select) (org-at-item-p))
  18248. (call-interactively 'org-previous-item))
  18249. ((org-clocktable-try-shift 'up arg))
  18250. ((run-hook-with-args-until-success 'org-shiftup-final-hook))
  18251. (org-support-shift-select
  18252. (org-call-for-shift-select 'previous-line))
  18253. (t (org-shiftselect-error))))
  18254. (defun org-shiftdown (&optional arg)
  18255. "Decrease item in timestamp or decrease priority of current headline.
  18256. Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
  18257. depending on context. See the individual commands for more information."
  18258. (interactive "P")
  18259. (cond
  18260. ((run-hook-with-args-until-success 'org-shiftdown-hook))
  18261. ((and org-support-shift-select (org-region-active-p))
  18262. (org-call-for-shift-select 'next-line))
  18263. ((org-at-timestamp-p t)
  18264. (call-interactively (if org-edit-timestamp-down-means-later
  18265. 'org-timestamp-up 'org-timestamp-down)))
  18266. ((and (not (eq org-support-shift-select 'always))
  18267. org-enable-priority-commands
  18268. (org-at-heading-p))
  18269. (call-interactively 'org-priority-down))
  18270. ((and (not org-support-shift-select) (org-at-item-p))
  18271. (call-interactively 'org-next-item))
  18272. ((org-clocktable-try-shift 'down arg))
  18273. ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
  18274. (org-support-shift-select
  18275. (org-call-for-shift-select 'next-line))
  18276. (t (org-shiftselect-error))))
  18277. (defun org-shiftright (&optional arg)
  18278. "Cycle the thing at point or in the current line, depending on context.
  18279. Depending on context, this does one of the following:
  18280. - switch a timestamp at point one day into the future
  18281. - on a headline, switch to the next TODO keyword.
  18282. - on an item, switch entire list to the next bullet type
  18283. - on a property line, switch to the next allowed value
  18284. - on a clocktable definition line, move time block into the future"
  18285. (interactive "P")
  18286. (cond
  18287. ((run-hook-with-args-until-success 'org-shiftright-hook))
  18288. ((and org-support-shift-select (org-region-active-p))
  18289. (org-call-for-shift-select 'forward-char))
  18290. ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
  18291. ((and (not (eq org-support-shift-select 'always))
  18292. (org-at-heading-p))
  18293. (let ((org-inhibit-logging
  18294. (not org-treat-S-cursor-todo-selection-as-state-change))
  18295. (org-inhibit-blocking
  18296. (not org-treat-S-cursor-todo-selection-as-state-change)))
  18297. (org-call-with-arg 'org-todo 'right)))
  18298. ((or (and org-support-shift-select
  18299. (not (eq org-support-shift-select 'always))
  18300. (org-at-item-bullet-p))
  18301. (and (not org-support-shift-select) (org-at-item-p)))
  18302. (org-call-with-arg 'org-cycle-list-bullet nil))
  18303. ((and (not (eq org-support-shift-select 'always))
  18304. (org-at-property-p))
  18305. (call-interactively 'org-property-next-allowed-value))
  18306. ((org-clocktable-try-shift 'right arg))
  18307. ((run-hook-with-args-until-success 'org-shiftright-final-hook))
  18308. (org-support-shift-select
  18309. (org-call-for-shift-select 'forward-char))
  18310. (t (org-shiftselect-error))))
  18311. (defun org-shiftleft (&optional arg)
  18312. "Cycle the thing at point or in the current line, depending on context.
  18313. Depending on context, this does one of the following:
  18314. - switch a timestamp at point one day into the past
  18315. - on a headline, switch to the previous TODO keyword.
  18316. - on an item, switch entire list to the previous bullet type
  18317. - on a property line, switch to the previous allowed value
  18318. - on a clocktable definition line, move time block into the past"
  18319. (interactive "P")
  18320. (cond
  18321. ((run-hook-with-args-until-success 'org-shiftleft-hook))
  18322. ((and org-support-shift-select (org-region-active-p))
  18323. (org-call-for-shift-select 'backward-char))
  18324. ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
  18325. ((and (not (eq org-support-shift-select 'always))
  18326. (org-at-heading-p))
  18327. (let ((org-inhibit-logging
  18328. (not org-treat-S-cursor-todo-selection-as-state-change))
  18329. (org-inhibit-blocking
  18330. (not org-treat-S-cursor-todo-selection-as-state-change)))
  18331. (org-call-with-arg 'org-todo 'left)))
  18332. ((or (and org-support-shift-select
  18333. (not (eq org-support-shift-select 'always))
  18334. (org-at-item-bullet-p))
  18335. (and (not org-support-shift-select) (org-at-item-p)))
  18336. (org-call-with-arg 'org-cycle-list-bullet 'previous))
  18337. ((and (not (eq org-support-shift-select 'always))
  18338. (org-at-property-p))
  18339. (call-interactively 'org-property-previous-allowed-value))
  18340. ((org-clocktable-try-shift 'left arg))
  18341. ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
  18342. (org-support-shift-select
  18343. (org-call-for-shift-select 'backward-char))
  18344. (t (org-shiftselect-error))))
  18345. (defun org-shiftcontrolright ()
  18346. "Switch to next TODO set."
  18347. (interactive)
  18348. (cond
  18349. ((and org-support-shift-select (org-region-active-p))
  18350. (org-call-for-shift-select 'forward-word))
  18351. ((and (not (eq org-support-shift-select 'always))
  18352. (org-at-heading-p))
  18353. (org-call-with-arg 'org-todo 'nextset))
  18354. (org-support-shift-select
  18355. (org-call-for-shift-select 'forward-word))
  18356. (t (org-shiftselect-error))))
  18357. (defun org-shiftcontrolleft ()
  18358. "Switch to previous TODO set."
  18359. (interactive)
  18360. (cond
  18361. ((and org-support-shift-select (org-region-active-p))
  18362. (org-call-for-shift-select 'backward-word))
  18363. ((and (not (eq org-support-shift-select 'always))
  18364. (org-at-heading-p))
  18365. (org-call-with-arg 'org-todo 'previousset))
  18366. (org-support-shift-select
  18367. (org-call-for-shift-select 'backward-word))
  18368. (t (org-shiftselect-error))))
  18369. (defun org-shiftcontrolup (&optional n)
  18370. "Change timestamps synchronously up in CLOCK log lines.
  18371. Optional argument N tells to change by that many units."
  18372. (interactive "P")
  18373. (cond ((and (not org-support-shift-select)
  18374. (org-at-clock-log-p)
  18375. (org-at-timestamp-p t))
  18376. (org-clock-timestamps-up n))
  18377. (t (org-shiftselect-error))))
  18378. (defun org-shiftcontroldown (&optional n)
  18379. "Change timestamps synchronously down in CLOCK log lines.
  18380. Optional argument N tells to change by that many units."
  18381. (interactive "P")
  18382. (cond ((and (not org-support-shift-select)
  18383. (org-at-clock-log-p)
  18384. (org-at-timestamp-p t))
  18385. (org-clock-timestamps-down n))
  18386. (t (org-shiftselect-error))))
  18387. (defun org-ctrl-c-ret ()
  18388. "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
  18389. (interactive)
  18390. (cond
  18391. ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
  18392. (t (call-interactively 'org-insert-heading))))
  18393. (defun org-find-visible ()
  18394. (let ((s (point)))
  18395. (while (and (not (= (point-max) (setq s (next-overlay-change s))))
  18396. (get-char-property s 'invisible)))
  18397. s))
  18398. (defun org-find-invisible ()
  18399. (let ((s (point)))
  18400. (while (and (not (= (point-max) (setq s (next-overlay-change s))))
  18401. (not (get-char-property s 'invisible))))
  18402. s))
  18403. (defun org-copy-visible (beg end)
  18404. "Copy the visible parts of the region."
  18405. (interactive "r")
  18406. (let (snippets s)
  18407. (save-excursion
  18408. (save-restriction
  18409. (narrow-to-region beg end)
  18410. (setq s (goto-char (point-min)))
  18411. (while (not (= (point) (point-max)))
  18412. (goto-char (org-find-invisible))
  18413. (push (buffer-substring s (point)) snippets)
  18414. (setq s (goto-char (org-find-visible))))))
  18415. (kill-new (apply 'concat (nreverse snippets)))))
  18416. (defun org-copy-special ()
  18417. "Copy region in table or copy current subtree.
  18418. Calls `org-table-copy' or `org-copy-subtree', depending on context.
  18419. See the individual commands for more information."
  18420. (interactive)
  18421. (call-interactively
  18422. (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
  18423. (defun org-cut-special ()
  18424. "Cut region in table or cut current subtree.
  18425. Calls `org-table-copy' or `org-cut-subtree', depending on context.
  18426. See the individual commands for more information."
  18427. (interactive)
  18428. (call-interactively
  18429. (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
  18430. (defun org-paste-special (arg)
  18431. "Paste rectangular region into table, or past subtree relative to level.
  18432. Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
  18433. See the individual commands for more information."
  18434. (interactive "P")
  18435. (if (org-at-table-p)
  18436. (org-table-paste-rectangle)
  18437. (org-paste-subtree arg)))
  18438. (defsubst org-in-fixed-width-region-p ()
  18439. "Is point in a fixed-width region?"
  18440. (save-match-data
  18441. (eq 'fixed-width (org-element-type (org-element-at-point)))))
  18442. (defun org-edit-special (&optional arg)
  18443. "Call a special editor for the element at point.
  18444. When at a table, call the formula editor with `org-table-edit-formulas'.
  18445. When in a source code block, call `org-edit-src-code'.
  18446. When in a fixed-width region, call `org-edit-fixed-width-region'.
  18447. When at an #+INCLUDE keyword, visit the included file.
  18448. On a link, call `ffap' to visit the link at point.
  18449. Otherwise, return a user error."
  18450. (interactive "P")
  18451. (let ((element (org-element-at-point)))
  18452. (assert (not buffer-read-only) nil
  18453. "Buffer is read-only: %s" (buffer-name))
  18454. (case (org-element-type element)
  18455. (src-block
  18456. (if (not arg) (org-edit-src-code)
  18457. (let* ((info (org-babel-get-src-block-info))
  18458. (lang (nth 0 info))
  18459. (params (nth 2 info))
  18460. (session (cdr (assq :session params))))
  18461. (if (not session) (org-edit-src-code)
  18462. ;; At a src-block with a session and function called with
  18463. ;; an ARG: switch to the buffer related to the inferior
  18464. ;; process.
  18465. (switch-to-buffer
  18466. (funcall (intern (concat "org-babel-prep-session:" lang))
  18467. session params))))))
  18468. (keyword
  18469. (if (member (org-element-property :key element) '("INCLUDE" "SETUPFILE"))
  18470. (find-file
  18471. (org-remove-double-quotes
  18472. (car (org-split-string (org-element-property :value element)))))
  18473. (user-error "No special environment to edit here")))
  18474. (table
  18475. (if (eq (org-element-property :type element) 'table.el)
  18476. (org-edit-src-code)
  18477. (call-interactively 'org-table-edit-formulas)))
  18478. ;; Only Org tables contain `table-row' type elements.
  18479. (table-row (call-interactively 'org-table-edit-formulas))
  18480. ((example-block export-block) (org-edit-src-code))
  18481. (fixed-width (org-edit-fixed-width-region))
  18482. (otherwise
  18483. ;; No notable element at point. Though, we may be at a link,
  18484. ;; which is an object. Thus, scan deeper.
  18485. (if (eq (org-element-type (org-element-context element)) 'link)
  18486. (call-interactively 'ffap)
  18487. (user-error "No special environment to edit here"))))))
  18488. (defvar org-table-coordinate-overlays) ; defined in org-table.el
  18489. (defun org-ctrl-c-ctrl-c (&optional arg)
  18490. "Set tags in headline, or update according to changed information at point.
  18491. This command does many different things, depending on context:
  18492. - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
  18493. this is what we do.
  18494. - If the cursor is on a statistics cookie, update it.
  18495. - If the cursor is in a headline, prompt for tags and insert them
  18496. into the current line, aligned to `org-tags-column'. When called
  18497. with prefix arg, realign all tags in the current buffer.
  18498. - If the cursor is in one of the special #+KEYWORD lines, this
  18499. triggers scanning the buffer for these lines and updating the
  18500. information.
  18501. - If the cursor is inside a table, realign the table. This command
  18502. works even if the automatic table editor has been turned off.
  18503. - If the cursor is on a #+TBLFM line, re-apply the formulas to
  18504. the entire table.
  18505. - If the cursor is at a footnote reference or definition, jump to
  18506. the corresponding definition or references, respectively.
  18507. - If the cursor is a the beginning of a dynamic block, update it.
  18508. - If the current buffer is a capture buffer, close note and file it.
  18509. - If the cursor is on a <<<target>>>, update radio targets and
  18510. corresponding links in this buffer.
  18511. - If the cursor is on a numbered item in a plain list, renumber the
  18512. ordered list.
  18513. - If the cursor is on a checkbox, toggle it.
  18514. - If the cursor is on a code block, evaluate it. The variable
  18515. `org-confirm-babel-evaluate' can be used to control prompting
  18516. before code block evaluation, by default every code block
  18517. evaluation requires confirmation. Code block evaluation can be
  18518. inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
  18519. (interactive "P")
  18520. (cond
  18521. ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
  18522. org-occur-highlights
  18523. org-latex-fragment-image-overlays)
  18524. (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
  18525. (org-remove-occur-highlights)
  18526. (org-remove-latex-fragment-image-overlays)
  18527. (message "Temporary highlights/overlays removed from current buffer"))
  18528. ((and (local-variable-p 'org-finish-function (current-buffer))
  18529. (fboundp org-finish-function))
  18530. (funcall org-finish-function))
  18531. ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
  18532. (t
  18533. (let* ((context (org-element-context)) (type (org-element-type context)))
  18534. ;; Test if point is within a blank line.
  18535. (if (save-excursion (beginning-of-line) (looking-at "[ \t]*$"))
  18536. (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
  18537. (user-error "C-c C-c can do nothing useful at this location"))
  18538. ;; For convenience: at the first line of a paragraph on the
  18539. ;; same line as an item, apply function on that item instead.
  18540. (when (eq type 'paragraph)
  18541. (let ((parent (org-element-property :parent context)))
  18542. (when (and (eq (org-element-type parent) 'item)
  18543. (= (point-at-bol) (org-element-property :begin parent)))
  18544. (setq context parent type 'item))))
  18545. ;; When heading text is a link, treat the heading, not the link,
  18546. ;; as the current element
  18547. (when (eq type 'link)
  18548. (let ((parent (org-element-property :parent context)))
  18549. (when (and (eq (org-element-type parent) 'headline))
  18550. (setq context parent type 'headline))))
  18551. ;; Act according to type of element or object at point.
  18552. (case type
  18553. (clock (org-clock-update-time-maybe))
  18554. (dynamic-block
  18555. (save-excursion
  18556. (goto-char (org-element-property :post-affiliated context))
  18557. (org-update-dblock)))
  18558. (footnote-definition
  18559. (goto-char (org-element-property :post-affiliated context))
  18560. (call-interactively 'org-footnote-action))
  18561. (footnote-reference (call-interactively 'org-footnote-action))
  18562. ((headline inlinetask)
  18563. (save-excursion (goto-char (org-element-property :begin context))
  18564. (call-interactively 'org-set-tags)))
  18565. (item
  18566. ;; At an item: a double C-u set checkbox to "[-]"
  18567. ;; unconditionally, whereas a single one will toggle its
  18568. ;; presence. Without an universal argument, if the item
  18569. ;; has a checkbox, toggle it. Otherwise repair the list.
  18570. (let* ((box (org-element-property :checkbox context))
  18571. (struct (org-element-property :structure context))
  18572. (old-struct (copy-tree struct))
  18573. (parents (org-list-parents-alist struct))
  18574. (prevs (org-list-prevs-alist struct))
  18575. (orderedp (org-not-nil (org-entry-get nil "ORDERED"))))
  18576. (org-list-set-checkbox
  18577. (org-element-property :begin context) struct
  18578. (cond ((equal arg '(16)) "[-]")
  18579. ((and (not box) (equal arg '(4))) "[ ]")
  18580. ((or (not box) (equal arg '(4))) nil)
  18581. ((eq box 'on) "[ ]")
  18582. (t "[X]")))
  18583. ;; Mimic `org-list-write-struct' but with grabbing
  18584. ;; a return value from `org-list-struct-fix-box'.
  18585. (org-list-struct-fix-ind struct parents 2)
  18586. (org-list-struct-fix-item-end struct)
  18587. (org-list-struct-fix-bul struct prevs)
  18588. (org-list-struct-fix-ind struct parents)
  18589. (let ((block-item
  18590. (org-list-struct-fix-box struct parents prevs orderedp)))
  18591. (if (and box (equal struct old-struct))
  18592. (if (equal arg '(16))
  18593. (message "Checkboxes already reset")
  18594. (user-error "Cannot toggle this checkbox: %s"
  18595. (if (eq box 'on)
  18596. "all subitems checked"
  18597. "unchecked subitems")))
  18598. (org-list-struct-apply-struct struct old-struct)
  18599. (org-update-checkbox-count-maybe))
  18600. (when block-item
  18601. (message "Checkboxes were removed due to empty box at line %d"
  18602. (org-current-line block-item))))))
  18603. (keyword
  18604. (let ((org-inhibit-startup-visibility-stuff t)
  18605. (org-startup-align-all-tables nil))
  18606. (when (boundp 'org-table-coordinate-overlays)
  18607. (mapc 'delete-overlay org-table-coordinate-overlays)
  18608. (setq org-table-coordinate-overlays nil))
  18609. (org-save-outline-visibility 'use-markers (org-mode-restart)))
  18610. (message "Local setup has been refreshed"))
  18611. (plain-list
  18612. ;; At a plain list, with a double C-u argument, set
  18613. ;; checkboxes of each item to "[-]", whereas a single one
  18614. ;; will toggle their presence according to the state of the
  18615. ;; first item in the list. Without an argument, repair the
  18616. ;; list.
  18617. (let* ((begin (org-element-property :contents-begin context))
  18618. (beginm (move-marker (make-marker) begin))
  18619. (struct (org-element-property :structure context))
  18620. (old-struct (copy-tree struct))
  18621. (first-box (save-excursion
  18622. (goto-char begin)
  18623. (looking-at org-list-full-item-re)
  18624. (match-string-no-properties 3)))
  18625. (new-box (cond ((equal arg '(16)) "[-]")
  18626. ((equal arg '(4)) (unless first-box "[ ]"))
  18627. ((equal first-box "[X]") "[ ]")
  18628. (t "[X]"))))
  18629. (cond
  18630. (arg
  18631. (mapc (lambda (pos) (org-list-set-checkbox pos struct new-box))
  18632. (org-list-get-all-items
  18633. begin struct (org-list-prevs-alist struct))))
  18634. ((and first-box (eq (point) begin))
  18635. ;; For convenience, when point is at bol on the first
  18636. ;; item of the list and no argument is provided, simply
  18637. ;; toggle checkbox of that item, if any.
  18638. (org-list-set-checkbox begin struct new-box)))
  18639. (org-list-write-struct
  18640. struct (org-list-parents-alist struct) old-struct)
  18641. (org-update-checkbox-count-maybe)
  18642. (save-excursion (goto-char beginm) (org-list-send-list 'maybe))))
  18643. ((property-drawer node-property)
  18644. (call-interactively 'org-property-action))
  18645. ((radio-target target)
  18646. (call-interactively 'org-update-radio-target-regexp))
  18647. (statistics-cookie
  18648. (call-interactively 'org-update-statistics-cookies))
  18649. ((table table-cell table-row)
  18650. ;; At a table, recalculate every field and align it. Also
  18651. ;; send the table if necessary. If the table has
  18652. ;; a `table.el' type, just give up. At a table row or
  18653. ;; cell, maybe recalculate line but always align table.
  18654. (if (eq (org-element-property :type context) 'table.el)
  18655. (message "Use C-c ' to edit table.el tables")
  18656. (let ((org-enable-table-editor t))
  18657. (if (or (eq type 'table)
  18658. ;; Check if point is at a TBLFM line.
  18659. (and (eq type 'table-row)
  18660. (= (point) (org-element-property :end context))))
  18661. (save-excursion
  18662. (if (org-at-TBLFM-p)
  18663. (progn (require 'org-table)
  18664. (org-table-calc-current-TBLFM))
  18665. (goto-char (org-element-property :contents-begin context))
  18666. (org-call-with-arg 'org-table-recalculate (or arg t))
  18667. (orgtbl-send-table 'maybe)))
  18668. (org-table-maybe-eval-formula)
  18669. (cond (arg (call-interactively 'org-table-recalculate))
  18670. ((org-table-maybe-recalculate-line))
  18671. (t (org-table-align)))))))
  18672. (timestamp (org-timestamp-change 0 'day))
  18673. (otherwise
  18674. (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
  18675. (user-error
  18676. "C-c C-c can do nothing useful at this location")))))))))
  18677. (defun org-mode-restart ()
  18678. "Restart Org-mode, to scan again for special lines.
  18679. Also updates the keyword regular expressions."
  18680. (interactive)
  18681. (org-mode)
  18682. (message "Org-mode restarted"))
  18683. (defun org-kill-note-or-show-branches ()
  18684. "If this is a Note buffer, abort storing the note. Else call `show-branches'."
  18685. (interactive)
  18686. (if (not org-finish-function)
  18687. (progn
  18688. (hide-subtree)
  18689. (call-interactively 'show-branches))
  18690. (let ((org-note-abort t))
  18691. (funcall org-finish-function))))
  18692. (defun org-open-line (n)
  18693. "Insert a new row in tables, call `open-line' elsewhere."
  18694. (interactive "*p")
  18695. (if (org-at-table-p)
  18696. (org-table-insert-row)
  18697. (open-line n)))
  18698. (defun org-return (&optional indent)
  18699. "Goto next table row or insert a newline.
  18700. Calls `org-table-next-row' or `newline', depending on context.
  18701. See the individual commands for more information."
  18702. (interactive)
  18703. (let (org-ts-what)
  18704. (cond
  18705. ((or (bobp) (org-in-src-block-p))
  18706. (if indent (newline-and-indent) (newline)))
  18707. ((org-at-table-p)
  18708. (org-table-justify-field-maybe)
  18709. (call-interactively 'org-table-next-row))
  18710. ;; when `newline-and-indent' is called within a list, make sure
  18711. ;; text moved stays inside the item.
  18712. ((and (org-in-item-p) indent)
  18713. (if (and (org-at-item-p) (>= (point) (match-end 0)))
  18714. (progn
  18715. (save-match-data (newline))
  18716. (org-indent-line-to (length (match-string 0))))
  18717. (let ((ind (org-get-indentation)))
  18718. (newline)
  18719. (if (org-looking-back org-list-end-re)
  18720. (org-indent-line)
  18721. (org-indent-line-to ind)))))
  18722. ((and org-return-follows-link
  18723. (org-at-timestamp-p t)
  18724. (not (eq org-ts-what 'after)))
  18725. (org-follow-timestamp-link))
  18726. ((and org-return-follows-link
  18727. (let ((tprop (get-text-property (point) 'face)))
  18728. (or (eq tprop 'org-link)
  18729. (and (listp tprop) (memq 'org-link tprop)))))
  18730. (call-interactively 'org-open-at-point))
  18731. ((and (org-at-heading-p)
  18732. (looking-at
  18733. (org-re "\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$")))
  18734. (org-show-entry)
  18735. (end-of-line 1)
  18736. (newline))
  18737. (t (if indent (newline-and-indent) (newline))))))
  18738. (defun org-return-indent ()
  18739. "Goto next table row or insert a newline and indent.
  18740. Calls `org-table-next-row' or `newline-and-indent', depending on
  18741. context. See the individual commands for more information."
  18742. (interactive)
  18743. (org-return t))
  18744. (defun org-ctrl-c-star ()
  18745. "Compute table, or change heading status of lines.
  18746. Calls `org-table-recalculate' or `org-toggle-heading',
  18747. depending on context."
  18748. (interactive)
  18749. (cond
  18750. ((org-at-table-p)
  18751. (call-interactively 'org-table-recalculate))
  18752. (t
  18753. ;; Convert all lines in region to list items
  18754. (call-interactively 'org-toggle-heading))))
  18755. (defun org-ctrl-c-minus ()
  18756. "Insert separator line in table or modify bullet status of line.
  18757. Also turns a plain line or a region of lines into list items.
  18758. Calls `org-table-insert-hline', `org-toggle-item', or
  18759. `org-cycle-list-bullet', depending on context."
  18760. (interactive)
  18761. (cond
  18762. ((org-at-table-p)
  18763. (call-interactively 'org-table-insert-hline))
  18764. ((org-region-active-p)
  18765. (call-interactively 'org-toggle-item))
  18766. ((org-in-item-p)
  18767. (call-interactively 'org-cycle-list-bullet))
  18768. (t
  18769. (call-interactively 'org-toggle-item))))
  18770. (defun org-toggle-item (arg)
  18771. "Convert headings or normal lines to items, items to normal lines.
  18772. If there is no active region, only the current line is considered.
  18773. If the first non blank line in the region is a headline, convert
  18774. all headlines to items, shifting text accordingly.
  18775. If it is an item, convert all items to normal lines.
  18776. If it is normal text, change region into a list of items.
  18777. With a prefix argument ARG, change the region in a single item."
  18778. (interactive "P")
  18779. (let ((shift-text
  18780. (function
  18781. ;; Shift text in current section to IND, from point to END.
  18782. ;; The function leaves point to END line.
  18783. (lambda (ind end)
  18784. (let ((min-i 1000) (end (copy-marker end)))
  18785. ;; First determine the minimum indentation (MIN-I) of
  18786. ;; the text.
  18787. (save-excursion
  18788. (catch 'exit
  18789. (while (< (point) end)
  18790. (let ((i (org-get-indentation)))
  18791. (cond
  18792. ;; Skip blank lines and inline tasks.
  18793. ((looking-at "^[ \t]*$"))
  18794. ((looking-at org-outline-regexp-bol))
  18795. ;; We can't find less than 0 indentation.
  18796. ((zerop i) (throw 'exit (setq min-i 0)))
  18797. ((< i min-i) (setq min-i i))))
  18798. (forward-line))))
  18799. ;; Then indent each line so that a line indented to
  18800. ;; MIN-I becomes indented to IND. Ignore blank lines
  18801. ;; and inline tasks in the process.
  18802. (let ((delta (- ind min-i)))
  18803. (while (< (point) end)
  18804. (unless (or (looking-at "^[ \t]*$")
  18805. (looking-at org-outline-regexp-bol))
  18806. (org-indent-line-to (+ (org-get-indentation) delta)))
  18807. (forward-line)))))))
  18808. (skip-blanks
  18809. (function
  18810. ;; Return beginning of first non-blank line, starting from
  18811. ;; line at POS.
  18812. (lambda (pos)
  18813. (save-excursion
  18814. (goto-char pos)
  18815. (skip-chars-forward " \r\t\n")
  18816. (point-at-bol)))))
  18817. beg end)
  18818. ;; Determine boundaries of changes.
  18819. (if (org-region-active-p)
  18820. (setq beg (funcall skip-blanks (region-beginning))
  18821. end (copy-marker (region-end)))
  18822. (setq beg (funcall skip-blanks (point-at-bol))
  18823. end (copy-marker (point-at-eol))))
  18824. ;; Depending on the starting line, choose an action on the text
  18825. ;; between BEG and END.
  18826. (org-with-limited-levels
  18827. (save-excursion
  18828. (goto-char beg)
  18829. (cond
  18830. ;; Case 1. Start at an item: de-itemize. Note that it only
  18831. ;; happens when a region is active: `org-ctrl-c-minus'
  18832. ;; would call `org-cycle-list-bullet' otherwise.
  18833. ((org-at-item-p)
  18834. (while (< (point) end)
  18835. (when (org-at-item-p)
  18836. (skip-chars-forward " \t")
  18837. (delete-region (point) (match-end 0)))
  18838. (forward-line)))
  18839. ;; Case 2. Start at an heading: convert to items.
  18840. ((org-at-heading-p)
  18841. (let* ((bul (org-list-bullet-string "-"))
  18842. (bul-len (length bul))
  18843. ;; Indentation of the first heading. It should be
  18844. ;; relative to the indentation of its parent, if any.
  18845. (start-ind (save-excursion
  18846. (cond
  18847. ((not org-adapt-indentation) 0)
  18848. ((not (outline-previous-heading)) 0)
  18849. (t (length (match-string 0))))))
  18850. ;; Level of first heading. Further headings will be
  18851. ;; compared to it to determine hierarchy in the list.
  18852. (ref-level (org-reduced-level (org-outline-level))))
  18853. (while (< (point) end)
  18854. (let* ((level (org-reduced-level (org-outline-level)))
  18855. (delta (max 0 (- level ref-level))))
  18856. ;; If current headline is less indented than the first
  18857. ;; one, set it as reference, in order to preserve
  18858. ;; subtrees.
  18859. (when (< level ref-level) (setq ref-level level))
  18860. (replace-match bul t t)
  18861. (org-indent-line-to (+ start-ind (* delta bul-len)))
  18862. ;; Ensure all text down to END (or SECTION-END) belongs
  18863. ;; to the newly created item.
  18864. (let ((section-end (save-excursion
  18865. (or (outline-next-heading) (point)))))
  18866. (forward-line)
  18867. (funcall shift-text
  18868. (+ start-ind (* (1+ delta) bul-len))
  18869. (min end section-end)))))))
  18870. ;; Case 3. Normal line with ARG: make the first line of region
  18871. ;; an item, and shift indentation of others lines to
  18872. ;; set them as item's body.
  18873. (arg (let* ((bul (org-list-bullet-string "-"))
  18874. (bul-len (length bul))
  18875. (ref-ind (org-get-indentation)))
  18876. (skip-chars-forward " \t")
  18877. (insert bul)
  18878. (forward-line)
  18879. (while (< (point) end)
  18880. ;; Ensure that lines less indented than first one
  18881. ;; still get included in item body.
  18882. (funcall shift-text
  18883. (+ ref-ind bul-len)
  18884. (min end (save-excursion (or (outline-next-heading)
  18885. (point)))))
  18886. (forward-line))))
  18887. ;; Case 4. Normal line without ARG: turn each non-item line
  18888. ;; into an item.
  18889. (t
  18890. (while (< (point) end)
  18891. (unless (or (org-at-heading-p) (org-at-item-p))
  18892. (if (looking-at "\\([ \t]*\\)\\(\\S-\\)")
  18893. (replace-match
  18894. (concat "\\1" (org-list-bullet-string "-") "\\2"))))
  18895. (forward-line))))))))
  18896. (defun org-toggle-heading (&optional nstars)
  18897. "Convert headings to normal text, or items or text to headings.
  18898. If there is no active region, only convert the current line.
  18899. With a \\[universal-argument] prefix, convert the whole list at
  18900. point into heading.
  18901. In a region:
  18902. - If the first non blank line is a headline, remove the stars
  18903. from all headlines in the region.
  18904. - If it is a normal line, turn each and every normal line (i.e.,
  18905. not an heading or an item) in the region into headings. If you
  18906. want to convert only the first line of this region, use one
  18907. universal prefix argument.
  18908. - If it is a plain list item, turn all plain list items into headings.
  18909. When converting a line into a heading, the number of stars is chosen
  18910. such that the lines become children of the current entry. However,
  18911. when a numeric prefix argument is given, its value determines the
  18912. number of stars to add."
  18913. (interactive "P")
  18914. (let ((skip-blanks
  18915. (function
  18916. ;; Return beginning of first non-blank line, starting from
  18917. ;; line at POS.
  18918. (lambda (pos)
  18919. (save-excursion
  18920. (goto-char pos)
  18921. (while (org-at-comment-p) (forward-line))
  18922. (skip-chars-forward " \r\t\n")
  18923. (point-at-bol)))))
  18924. beg end toggled)
  18925. ;; Determine boundaries of changes. If a universal prefix has
  18926. ;; been given, put the list in a region. If region ends at a bol,
  18927. ;; do not consider the last line to be in the region.
  18928. (when (and current-prefix-arg (org-at-item-p))
  18929. (if (listp current-prefix-arg) (setq current-prefix-arg 1))
  18930. (org-mark-element))
  18931. (if (org-region-active-p)
  18932. (setq beg (funcall skip-blanks (region-beginning))
  18933. end (copy-marker (save-excursion
  18934. (goto-char (region-end))
  18935. (if (bolp) (point) (point-at-eol)))))
  18936. (setq beg (funcall skip-blanks (point-at-bol))
  18937. end (copy-marker (point-at-eol))))
  18938. ;; Ensure inline tasks don't count as headings.
  18939. (org-with-limited-levels
  18940. (save-excursion
  18941. (goto-char beg)
  18942. (cond
  18943. ;; Case 1. Started at an heading: de-star headings.
  18944. ((org-at-heading-p)
  18945. (while (< (point) end)
  18946. (when (org-at-heading-p t)
  18947. (looking-at org-outline-regexp) (replace-match "")
  18948. (setq toggled t))
  18949. (forward-line)))
  18950. ;; Case 2. Started at an item: change items into headlines.
  18951. ;; One star will be added by `org-list-to-subtree'.
  18952. ((org-at-item-p)
  18953. (let* ((stars (make-string
  18954. ;; subtract the star that will be added again by
  18955. ;; `org-list-to-subtree'
  18956. (if (numberp nstars) (1- nstars)
  18957. (or (org-current-level) 0))
  18958. ?*))
  18959. (add-stars
  18960. (cond (nstars "") ; stars from prefix only
  18961. ((equal stars "") "") ; before first heading
  18962. (org-odd-levels-only "*") ; inside heading, odd
  18963. (t "")))) ; inside heading, oddeven
  18964. (while (< (point) end)
  18965. (when (org-at-item-p)
  18966. ;; Pay attention to cases when region ends before list.
  18967. (let* ((struct (org-list-struct))
  18968. (list-end (min (org-list-get-bottom-point struct) (1+ end))))
  18969. (save-restriction
  18970. (narrow-to-region (point) list-end)
  18971. (insert
  18972. (org-list-to-subtree
  18973. (org-list-parse-list t)
  18974. '(:istart (concat stars add-stars (funcall get-stars depth))
  18975. :icount (concat stars add-stars (funcall get-stars depth)))))))
  18976. (setq toggled t))
  18977. (forward-line))))
  18978. ;; Case 3. Started at normal text: make every line an heading,
  18979. ;; skipping headlines and items.
  18980. (t (let* ((stars
  18981. (make-string
  18982. (if (numberp nstars) nstars (or (org-current-level) 0)) ?*))
  18983. (add-stars
  18984. (cond (nstars "") ; stars from prefix only
  18985. ((equal stars "") "*") ; before first heading
  18986. (org-odd-levels-only "**") ; inside heading, odd
  18987. (t "*"))) ; inside heading, oddeven
  18988. (rpl (concat stars add-stars " "))
  18989. (lend (if (listp nstars) (save-excursion (end-of-line) (point)))))
  18990. (while (< (point) (if (equal nstars '(4)) lend end))
  18991. (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
  18992. (looking-at "\\([ \t]*\\)\\(\\S-\\)"))
  18993. (replace-match (concat rpl (match-string 2))) (setq toggled t))
  18994. (forward-line)))))))
  18995. (unless toggled (message "Cannot toggle heading from here"))))
  18996. (defun org-meta-return (&optional arg)
  18997. "Insert a new heading or wrap a region in a table.
  18998. Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
  18999. See the individual commands for more information."
  19000. (interactive "P")
  19001. (org-check-before-invisible-edit 'insert)
  19002. (cond
  19003. ((run-hook-with-args-until-success 'org-metareturn-hook))
  19004. ((or (org-at-drawer-p) (org-in-drawer-p) (org-at-property-p))
  19005. (newline-and-indent))
  19006. ((org-at-table-p)
  19007. (call-interactively 'org-table-wrap-region))
  19008. (t (call-interactively 'org-insert-heading))))
  19009. ;;; Menu entries
  19010. (defsubst org-in-subtree-not-table-p ()
  19011. "Are we in a subtree and not in a table?"
  19012. (and (not (org-before-first-heading-p))
  19013. (not (org-at-table-p))))
  19014. ;; Define the Org-mode menus
  19015. (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
  19016. '("Tbl"
  19017. ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
  19018. ["Next Field" org-cycle (org-at-table-p)]
  19019. ["Previous Field" org-shifttab (org-at-table-p)]
  19020. ["Next Row" org-return (org-at-table-p)]
  19021. "--"
  19022. ["Blank Field" org-table-blank-field (org-at-table-p)]
  19023. ["Edit Field" org-table-edit-field (org-at-table-p)]
  19024. ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
  19025. "--"
  19026. ("Column"
  19027. ["Move Column Left" org-metaleft (org-at-table-p)]
  19028. ["Move Column Right" org-metaright (org-at-table-p)]
  19029. ["Delete Column" org-shiftmetaleft (org-at-table-p)]
  19030. ["Insert Column" org-shiftmetaright (org-at-table-p)])
  19031. ("Row"
  19032. ["Move Row Up" org-metaup (org-at-table-p)]
  19033. ["Move Row Down" org-metadown (org-at-table-p)]
  19034. ["Delete Row" org-shiftmetaup (org-at-table-p)]
  19035. ["Insert Row" org-shiftmetadown (org-at-table-p)]
  19036. ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
  19037. "--"
  19038. ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
  19039. ("Rectangle"
  19040. ["Copy Rectangle" org-copy-special (org-at-table-p)]
  19041. ["Cut Rectangle" org-cut-special (org-at-table-p)]
  19042. ["Paste Rectangle" org-paste-special (org-at-table-p)]
  19043. ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
  19044. "--"
  19045. ("Calculate"
  19046. ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
  19047. ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
  19048. ["Edit Formulas" org-edit-special (org-at-table-p)]
  19049. "--"
  19050. ["Recalculate line" org-table-recalculate (org-at-table-p)]
  19051. ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
  19052. ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
  19053. "--"
  19054. ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
  19055. "--"
  19056. ["Sum Column/Rectangle" org-table-sum
  19057. (or (org-at-table-p) (org-region-active-p))]
  19058. ["Which Column?" org-table-current-column (org-at-table-p)])
  19059. ["Debug Formulas"
  19060. org-table-toggle-formula-debugger
  19061. :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
  19062. ["Show Col/Row Numbers"
  19063. org-table-toggle-coordinate-overlays
  19064. :style toggle
  19065. :selected (org-bound-and-true-p org-table-overlay-coordinates)]
  19066. "--"
  19067. ["Create" org-table-create (and (not (org-at-table-p))
  19068. org-enable-table-editor)]
  19069. ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
  19070. ["Import from File" org-table-import (not (org-at-table-p))]
  19071. ["Export to File" org-table-export (org-at-table-p)]
  19072. "--"
  19073. ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
  19074. (easy-menu-define org-org-menu org-mode-map "Org menu"
  19075. '("Org"
  19076. ("Show/Hide"
  19077. ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
  19078. ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
  19079. ["Sparse Tree..." org-sparse-tree t]
  19080. ["Reveal Context" org-reveal t]
  19081. ["Show All" show-all t]
  19082. "--"
  19083. ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
  19084. "--"
  19085. ["New Heading" org-insert-heading t]
  19086. ("Navigate Headings"
  19087. ["Up" outline-up-heading t]
  19088. ["Next" outline-next-visible-heading t]
  19089. ["Previous" outline-previous-visible-heading t]
  19090. ["Next Same Level" outline-forward-same-level t]
  19091. ["Previous Same Level" outline-backward-same-level t]
  19092. "--"
  19093. ["Jump" org-goto t])
  19094. ("Edit Structure"
  19095. ["Refile Subtree" org-refile (org-in-subtree-not-table-p)]
  19096. "--"
  19097. ["Move Subtree Up" org-shiftmetaup (org-in-subtree-not-table-p)]
  19098. ["Move Subtree Down" org-shiftmetadown (org-in-subtree-not-table-p)]
  19099. "--"
  19100. ["Copy Subtree" org-copy-special (org-in-subtree-not-table-p)]
  19101. ["Cut Subtree" org-cut-special (org-in-subtree-not-table-p)]
  19102. ["Paste Subtree" org-paste-special (not (org-at-table-p))]
  19103. "--"
  19104. ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
  19105. "--"
  19106. ["Copy visible text" org-copy-visible t]
  19107. "--"
  19108. ["Promote Heading" org-metaleft (org-in-subtree-not-table-p)]
  19109. ["Promote Subtree" org-shiftmetaleft (org-in-subtree-not-table-p)]
  19110. ["Demote Heading" org-metaright (org-in-subtree-not-table-p)]
  19111. ["Demote Subtree" org-shiftmetaright (org-in-subtree-not-table-p)]
  19112. "--"
  19113. ["Sort Region/Children" org-sort t]
  19114. "--"
  19115. ["Convert to odd levels" org-convert-to-odd-levels t]
  19116. ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
  19117. ("Editing"
  19118. ["Emphasis..." org-emphasize t]
  19119. ["Edit Source Example" org-edit-special t]
  19120. "--"
  19121. ["Footnote new/jump" org-footnote-action t]
  19122. ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
  19123. ("Archive"
  19124. ["Archive (default method)" org-archive-subtree-default (org-in-subtree-not-table-p)]
  19125. "--"
  19126. ["Move Subtree to Archive file" org-advertized-archive-subtree (org-in-subtree-not-table-p)]
  19127. ["Toggle ARCHIVE tag" org-toggle-archive-tag (org-in-subtree-not-table-p)]
  19128. ["Move subtree to Archive sibling" org-archive-to-archive-sibling (org-in-subtree-not-table-p)]
  19129. )
  19130. "--"
  19131. ("Hyperlinks"
  19132. ["Store Link (Global)" org-store-link t]
  19133. ["Find existing link to here" org-occur-link-in-agenda-files t]
  19134. ["Insert Link" org-insert-link t]
  19135. ["Follow Link" org-open-at-point t]
  19136. "--"
  19137. ["Next link" org-next-link t]
  19138. ["Previous link" org-previous-link t]
  19139. "--"
  19140. ["Descriptive Links"
  19141. org-toggle-link-display
  19142. :style radio
  19143. :selected org-descriptive-links
  19144. ]
  19145. ["Literal Links"
  19146. org-toggle-link-display
  19147. :style radio
  19148. :selected (not org-descriptive-links)])
  19149. "--"
  19150. ("TODO Lists"
  19151. ["TODO/DONE/-" org-todo t]
  19152. ("Select keyword"
  19153. ["Next keyword" org-shiftright (org-at-heading-p)]
  19154. ["Previous keyword" org-shiftleft (org-at-heading-p)]
  19155. ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
  19156. ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
  19157. ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
  19158. ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
  19159. ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
  19160. "--"
  19161. ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
  19162. :selected org-enforce-todo-dependencies :style toggle :active t]
  19163. "Settings for tree at point"
  19164. ["Do Children sequentially" org-toggle-ordered-property :style radio
  19165. :selected (org-entry-get nil "ORDERED")
  19166. :active org-enforce-todo-dependencies :keys "C-c C-x o"]
  19167. ["Do Children parallel" org-toggle-ordered-property :style radio
  19168. :selected (not (org-entry-get nil "ORDERED"))
  19169. :active org-enforce-todo-dependencies :keys "C-c C-x o"]
  19170. "--"
  19171. ["Set Priority" org-priority t]
  19172. ["Priority Up" org-shiftup t]
  19173. ["Priority Down" org-shiftdown t]
  19174. "--"
  19175. ["Get news from all feeds" org-feed-update-all t]
  19176. ["Go to the inbox of a feed..." org-feed-goto-inbox t]
  19177. ["Customize feeds" (customize-variable 'org-feed-alist) t])
  19178. ("TAGS and Properties"
  19179. ["Set Tags" org-set-tags-command (not (org-before-first-heading-p))]
  19180. ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
  19181. "--"
  19182. ["Set property" org-set-property (not (org-before-first-heading-p))]
  19183. ["Column view of properties" org-columns t]
  19184. ["Insert Column View DBlock" org-insert-columns-dblock t])
  19185. ("Dates and Scheduling"
  19186. ["Timestamp" org-time-stamp (not (org-before-first-heading-p))]
  19187. ["Timestamp (inactive)" org-time-stamp-inactive (not (org-before-first-heading-p))]
  19188. ("Change Date"
  19189. ["1 Day Later" org-shiftright (org-at-timestamp-p)]
  19190. ["1 Day Earlier" org-shiftleft (org-at-timestamp-p)]
  19191. ["1 ... Later" org-shiftup (org-at-timestamp-p)]
  19192. ["1 ... Earlier" org-shiftdown (org-at-timestamp-p)])
  19193. ["Compute Time Range" org-evaluate-time-range t]
  19194. ["Schedule Item" org-schedule (not (org-before-first-heading-p))]
  19195. ["Deadline" org-deadline (not (org-before-first-heading-p))]
  19196. "--"
  19197. ["Custom time format" org-toggle-time-stamp-overlays
  19198. :style radio :selected org-display-custom-times]
  19199. "--"
  19200. ["Goto Calendar" org-goto-calendar t]
  19201. ["Date from Calendar" org-date-from-calendar t]
  19202. "--"
  19203. ["Start/Restart Timer" org-timer-start t]
  19204. ["Pause/Continue Timer" org-timer-pause-or-continue t]
  19205. ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
  19206. ["Insert Timer String" org-timer t]
  19207. ["Insert Timer Item" org-timer-item t])
  19208. ("Logging work"
  19209. ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
  19210. ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
  19211. ["Clock out" org-clock-out t]
  19212. ["Clock cancel" org-clock-cancel t]
  19213. "--"
  19214. ["Mark as default task" org-clock-mark-default-task t]
  19215. ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
  19216. ["Goto running clock" org-clock-goto t]
  19217. "--"
  19218. ["Display times" org-clock-display t]
  19219. ["Create clock table" org-clock-report t]
  19220. "--"
  19221. ["Record DONE time"
  19222. (progn (setq org-log-done (not org-log-done))
  19223. (message "Switching to %s will %s record a timestamp"
  19224. (car org-done-keywords)
  19225. (if org-log-done "automatically" "not")))
  19226. :style toggle :selected org-log-done])
  19227. "--"
  19228. ["Agenda Command..." org-agenda t]
  19229. ["Set Restriction Lock" org-agenda-set-restriction-lock t]
  19230. ("File List for Agenda")
  19231. ("Special views current file"
  19232. ["TODO Tree" org-show-todo-tree t]
  19233. ["Check Deadlines" org-check-deadlines t]
  19234. ["Timeline" org-timeline t]
  19235. ["Tags/Property tree" org-match-sparse-tree t])
  19236. "--"
  19237. ["Export/Publish..." org-export-dispatch t]
  19238. ("LaTeX"
  19239. ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
  19240. :selected org-cdlatex-mode]
  19241. ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
  19242. ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
  19243. ["Modify math symbol" org-cdlatex-math-modify
  19244. (org-inside-LaTeX-fragment-p)]
  19245. ["Insert citation" org-reftex-citation t]
  19246. "--"
  19247. ["Template for BEAMER" (org-beamer-insert-options-template) t])
  19248. "--"
  19249. ("MobileOrg"
  19250. ["Push Files and Views" org-mobile-push t]
  19251. ["Get Captured and Flagged" org-mobile-pull t]
  19252. ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
  19253. "--"
  19254. ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
  19255. "--"
  19256. ("Documentation"
  19257. ["Show Version" org-version t]
  19258. ["Info Documentation" org-info t])
  19259. ("Customize"
  19260. ["Browse Org Group" org-customize t]
  19261. "--"
  19262. ["Expand This Menu" org-create-customize-menu
  19263. (fboundp 'customize-menu-create)])
  19264. ["Send bug report" org-submit-bug-report t]
  19265. "--"
  19266. ("Refresh/Reload"
  19267. ["Refresh setup current buffer" org-mode-restart t]
  19268. ["Reload Org (after update)" org-reload t]
  19269. ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x !"])
  19270. ))
  19271. (defun org-info (&optional node)
  19272. "Read documentation for Org-mode in the info system.
  19273. With optional NODE, go directly to that node."
  19274. (interactive)
  19275. (info (format "(org)%s" (or node ""))))
  19276. ;;;###autoload
  19277. (defun org-submit-bug-report ()
  19278. "Submit a bug report on Org-mode via mail.
  19279. Don't hesitate to report any problems or inaccurate documentation.
  19280. If you don't have setup sending mail from (X)Emacs, please copy the
  19281. output buffer into your mail program, as it gives us important
  19282. information about your Org-mode version and configuration."
  19283. (interactive)
  19284. (require 'reporter)
  19285. (org-load-modules-maybe)
  19286. (org-require-autoloaded-modules)
  19287. (let ((reporter-prompt-for-summary-p "Bug report subject: "))
  19288. (reporter-submit-bug-report
  19289. "emacs-orgmode@gnu.org"
  19290. (org-version nil 'full)
  19291. (let (list)
  19292. (save-window-excursion
  19293. (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
  19294. (delete-other-windows)
  19295. (erase-buffer)
  19296. (insert "You are about to submit a bug report to the Org-mode mailing list.
  19297. We would like to add your full Org-mode and Outline configuration to the
  19298. bug report. This greatly simplifies the work of the maintainer and
  19299. other experts on the mailing list.
  19300. HOWEVER, some variables you have customized may contain private
  19301. information. The names of customers, colleagues, or friends, might
  19302. appear in the form of file names, tags, todo states, or search strings.
  19303. If you answer yes to the prompt, you might want to check and remove
  19304. such private information before sending the email.")
  19305. (add-text-properties (point-min) (point-max) '(face org-warning))
  19306. (when (yes-or-no-p "Include your Org-mode configuration ")
  19307. (mapatoms
  19308. (lambda (v)
  19309. (and (boundp v)
  19310. (string-match "\\`\\(org-\\|outline-\\)" (symbol-name v))
  19311. (or (and (symbol-value v)
  19312. (string-match "\\(-hook\\|-function\\)\\'" (symbol-name v)))
  19313. (and
  19314. (get v 'custom-type) (get v 'standard-value)
  19315. (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
  19316. (push v list)))))
  19317. (kill-buffer (get-buffer "*Warn about privacy*"))
  19318. list))
  19319. nil nil
  19320. "Remember to cover the basics, that is, what you expected to happen and
  19321. what in fact did happen. You don't know how to make a good report? See
  19322. http://orgmode.org/manual/Feedback.html#Feedback
  19323. Your bug report will be posted to the Org-mode mailing list.
  19324. ------------------------------------------------------------------------")
  19325. (save-excursion
  19326. (if (re-search-backward "^\\(Subject: \\)Org-mode version \\(.*?\\);[ \t]*\\(.*\\)" nil t)
  19327. (replace-match "\\1Bug: \\3 [\\2]")))))
  19328. (defun org-install-agenda-files-menu ()
  19329. (let ((bl (buffer-list)))
  19330. (save-excursion
  19331. (while bl
  19332. (set-buffer (pop bl))
  19333. (if (derived-mode-p 'org-mode) (setq bl nil)))
  19334. (when (derived-mode-p 'org-mode)
  19335. (easy-menu-change
  19336. '("Org") "File List for Agenda"
  19337. (append
  19338. (list
  19339. ["Edit File List" (org-edit-agenda-file-list) t]
  19340. ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
  19341. ["Remove Current File from List" org-remove-file t]
  19342. ["Cycle through agenda files" org-cycle-agenda-files t]
  19343. ["Occur in all agenda files" org-occur-in-agenda-files t]
  19344. "--")
  19345. (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
  19346. ;;;; Documentation
  19347. (defun org-require-autoloaded-modules ()
  19348. (interactive)
  19349. (mapc 'require
  19350. '(org-agenda org-archive org-attach org-clock org-colview org-id
  19351. org-remember org-table org-timer)))
  19352. ;;;###autoload
  19353. (defun org-reload (&optional uncompiled)
  19354. "Reload all org lisp files.
  19355. With prefix arg UNCOMPILED, load the uncompiled versions."
  19356. (interactive "P")
  19357. (require 'loadhist)
  19358. (let* ((org-dir (org-find-library-dir "org"))
  19359. (contrib-dir (or (org-find-library-dir "org-contribdir") org-dir))
  19360. (feature-re "^\\(org\\|ob\\|ox\\)\\(-.*\\)?")
  19361. (remove-re (mapconcat 'identity
  19362. (mapcar (lambda (f) (concat "^" f "$"))
  19363. (list (if (featurep 'xemacs)
  19364. "org-colview"
  19365. "org-colview-xemacs")
  19366. "org" "org-loaddefs" "org-version"))
  19367. "\\|"))
  19368. (feats (delete-dups
  19369. (mapcar 'file-name-sans-extension
  19370. (mapcar 'file-name-nondirectory
  19371. (delq nil
  19372. (mapcar 'feature-file
  19373. features))))))
  19374. (lfeat (append
  19375. (sort
  19376. (setq feats
  19377. (delq nil (mapcar
  19378. (lambda (f)
  19379. (if (and (string-match feature-re f)
  19380. (not (string-match remove-re f)))
  19381. f nil))
  19382. feats)))
  19383. 'string-lessp)
  19384. (list "org-version" "org")))
  19385. (load-suffixes (when (boundp 'load-suffixes) load-suffixes))
  19386. (load-suffixes (if uncompiled (reverse load-suffixes) load-suffixes))
  19387. load-uncore load-misses)
  19388. (setq load-misses
  19389. (delq 't
  19390. (mapcar (lambda (f)
  19391. (or (org-load-noerror-mustsuffix (concat org-dir f))
  19392. (and (string= org-dir contrib-dir)
  19393. (org-load-noerror-mustsuffix (concat contrib-dir f)))
  19394. (and (org-load-noerror-mustsuffix (concat (org-find-library-dir f) f))
  19395. (add-to-list 'load-uncore f 'append)
  19396. 't)
  19397. f))
  19398. lfeat)))
  19399. (if load-uncore
  19400. (message "The following feature%s found in load-path, please check if that's correct:\n%s"
  19401. (if (> (length load-uncore) 1) "s were" " was") load-uncore))
  19402. (if load-misses
  19403. (message "Some error occured while reloading Org feature%s\n%s\nPlease check *Messages*!\n%s"
  19404. (if (> (length load-misses) 1) "s" "") load-misses (org-version nil 'full))
  19405. (message "Successfully reloaded Org\n%s" (org-version nil 'full)))))
  19406. ;;;###autoload
  19407. (defun org-customize ()
  19408. "Call the customize function with org as argument."
  19409. (interactive)
  19410. (org-load-modules-maybe)
  19411. (org-require-autoloaded-modules)
  19412. (customize-browse 'org))
  19413. (defun org-create-customize-menu ()
  19414. "Create a full customization menu for Org-mode, insert it into the menu."
  19415. (interactive)
  19416. (org-load-modules-maybe)
  19417. (org-require-autoloaded-modules)
  19418. (if (fboundp 'customize-menu-create)
  19419. (progn
  19420. (easy-menu-change
  19421. '("Org") "Customize"
  19422. `(["Browse Org group" org-customize t]
  19423. "--"
  19424. ,(customize-menu-create 'org)
  19425. ["Set" Custom-set t]
  19426. ["Save" Custom-save t]
  19427. ["Reset to Current" Custom-reset-current t]
  19428. ["Reset to Saved" Custom-reset-saved t]
  19429. ["Reset to Standard Settings" Custom-reset-standard t]))
  19430. (message "\"Org\"-menu now contains full customization menu"))
  19431. (error "Cannot expand menu (outdated version of cus-edit.el)")))
  19432. ;;;; Miscellaneous stuff
  19433. ;;; Generally useful functions
  19434. (defun org-get-at-bol (property)
  19435. "Get text property PROPERTY at beginning of line."
  19436. (get-text-property (point-at-bol) property))
  19437. (defun org-find-text-property-in-string (prop s)
  19438. "Return the first non-nil value of property PROP in string S."
  19439. (or (get-text-property 0 prop s)
  19440. (get-text-property (or (next-single-property-change 0 prop s) 0)
  19441. prop s)))
  19442. (defun org-display-warning (message) ;; Copied from Emacs-Muse
  19443. "Display the given MESSAGE as a warning."
  19444. (if (fboundp 'display-warning)
  19445. (display-warning 'org message
  19446. (if (featurep 'xemacs) 'warning :warning))
  19447. (let ((buf (get-buffer-create "*Org warnings*")))
  19448. (with-current-buffer buf
  19449. (goto-char (point-max))
  19450. (insert "Warning (Org): " message)
  19451. (unless (bolp)
  19452. (newline)))
  19453. (display-buffer buf)
  19454. (sit-for 0))))
  19455. (defun org-eval (form)
  19456. "Eval FORM and return result."
  19457. (condition-case error
  19458. (eval form)
  19459. (error (format "%%![Error: %s]" error))))
  19460. (defun org-in-clocktable-p ()
  19461. "Check if the cursor is in a clocktable."
  19462. (let ((pos (point)) start)
  19463. (save-excursion
  19464. (end-of-line 1)
  19465. (and (re-search-backward "^[ \t]*#\\+BEGIN:[ \t]+clocktable" nil t)
  19466. (setq start (match-beginning 0))
  19467. (re-search-forward "^[ \t]*#\\+END:.*" nil t)
  19468. (>= (match-end 0) pos)
  19469. start))))
  19470. (defun org-in-commented-line ()
  19471. "Is point in a line starting with `#'?"
  19472. (equal (char-after (point-at-bol)) ?#))
  19473. (defun org-in-indented-comment-line ()
  19474. "Is point in a line starting with `#' after some white space?"
  19475. (save-excursion
  19476. (save-match-data
  19477. (goto-char (point-at-bol))
  19478. (looking-at "[ \t]*#"))))
  19479. (defun org-in-verbatim-emphasis ()
  19480. (save-match-data
  19481. (and (org-in-regexp org-emph-re 2)
  19482. (>= (point) (match-beginning 3))
  19483. (<= (point) (match-end 4))
  19484. (member (match-string 3) '("=" "~")))))
  19485. (defun org-goto-marker-or-bmk (marker &optional bookmark)
  19486. "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
  19487. (if (and marker (marker-buffer marker)
  19488. (buffer-live-p (marker-buffer marker)))
  19489. (progn
  19490. (org-pop-to-buffer-same-window (marker-buffer marker))
  19491. (if (or (> marker (point-max)) (< marker (point-min)))
  19492. (widen))
  19493. (goto-char marker)
  19494. (org-show-context 'org-goto))
  19495. (if bookmark
  19496. (bookmark-jump bookmark)
  19497. (error "Cannot find location"))))
  19498. (defun org-quote-csv-field (s)
  19499. "Quote field for inclusion in CSV material."
  19500. (if (string-match "[\",]" s)
  19501. (concat "\"" (mapconcat 'identity (split-string s "\"") "\"\"") "\"")
  19502. s))
  19503. (defun org-force-self-insert (N)
  19504. "Needed to enforce self-insert under remapping."
  19505. (interactive "p")
  19506. (self-insert-command N))
  19507. (defun org-string-width (s)
  19508. "Compute width of string, ignoring invisible characters.
  19509. This ignores character with invisibility property `org-link', and also
  19510. characters with property `org-cwidth', because these will become invisible
  19511. upon the next fontification round."
  19512. (let (b l)
  19513. (when (or (eq t buffer-invisibility-spec)
  19514. (assq 'org-link buffer-invisibility-spec))
  19515. (while (setq b (text-property-any 0 (length s)
  19516. 'invisible 'org-link s))
  19517. (setq s (concat (substring s 0 b)
  19518. (substring s (or (next-single-property-change
  19519. b 'invisible s) (length s)))))))
  19520. (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
  19521. (setq s (concat (substring s 0 b)
  19522. (substring s (or (next-single-property-change
  19523. b 'org-cwidth s) (length s))))))
  19524. (setq l (string-width s) b -1)
  19525. (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
  19526. (setq l (- l (get-text-property b 'org-dwidth-n s))))
  19527. l))
  19528. (defun org-shorten-string (s maxlength)
  19529. "Shorten string S so tht it is no longer than MAXLENGTH characters.
  19530. If the string is shorter or has length MAXLENGTH, just return the
  19531. original string. If it is longer, the functions finds a space in the
  19532. string, breaks this string off at that locations and adds three dots
  19533. as ellipsis. Including the ellipsis, the string will not be longer
  19534. than MAXLENGTH. If finding a good breaking point in the string does
  19535. not work, the string is just chopped off in the middle of a word
  19536. if necessary."
  19537. (if (<= (length s) maxlength)
  19538. s
  19539. (let* ((n (max (- maxlength 4) 1))
  19540. (re (concat "\\`\\(.\\{1," (int-to-string n) "\\}[^ ]\\)\\([ ]\\|\\'\\)")))
  19541. (if (string-match re s)
  19542. (concat (match-string 1 s) "...")
  19543. (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
  19544. (defun org-get-indentation (&optional line)
  19545. "Get the indentation of the current line, interpreting tabs.
  19546. When LINE is given, assume it represents a line and compute its indentation."
  19547. (if line
  19548. (if (string-match "^ *" (org-remove-tabs line))
  19549. (match-end 0))
  19550. (save-excursion
  19551. (beginning-of-line 1)
  19552. (skip-chars-forward " \t")
  19553. (current-column))))
  19554. (defun org-get-string-indentation (s)
  19555. "What indentation has S due to SPACE and TAB at the beginning of the string?"
  19556. (let ((n -1) (i 0) (w tab-width) c)
  19557. (catch 'exit
  19558. (while (< (setq n (1+ n)) (length s))
  19559. (setq c (aref s n))
  19560. (cond ((= c ?\ ) (setq i (1+ i)))
  19561. ((= c ?\t) (setq i (* (/ (+ w i) w) w)))
  19562. (t (throw 'exit t)))))
  19563. i))
  19564. (defun org-remove-tabs (s &optional width)
  19565. "Replace tabulators in S with spaces.
  19566. Assumes that s is a single line, starting in column 0."
  19567. (setq width (or width tab-width))
  19568. (while (string-match "\t" s)
  19569. (setq s (replace-match
  19570. (make-string
  19571. (- (* width (/ (+ (match-beginning 0) width) width))
  19572. (match-beginning 0)) ?\ )
  19573. t t s)))
  19574. s)
  19575. (defun org-fix-indentation (line ind)
  19576. "Fix indentation in LINE.
  19577. IND is a cons cell with target and minimum indentation.
  19578. If the current indentation in LINE is smaller than the minimum,
  19579. leave it alone. If it is larger than ind, set it to the target."
  19580. (let* ((l (org-remove-tabs line))
  19581. (i (org-get-indentation l))
  19582. (i1 (car ind)) (i2 (cdr ind)))
  19583. (if (>= i i2) (setq l (substring line i2)))
  19584. (if (> i1 0)
  19585. (concat (make-string i1 ?\ ) l)
  19586. l)))
  19587. (defun org-remove-indentation (code &optional n)
  19588. "Remove the maximum common indentation from the lines in CODE.
  19589. N may optionally be the number of spaces to remove."
  19590. (with-temp-buffer
  19591. (insert code)
  19592. (org-do-remove-indentation n)
  19593. (buffer-string)))
  19594. (defun org-do-remove-indentation (&optional n)
  19595. "Remove the maximum common indentation from the buffer."
  19596. (untabify (point-min) (point-max))
  19597. (let ((min 10000) re)
  19598. (if n
  19599. (setq min n)
  19600. (goto-char (point-min))
  19601. (while (re-search-forward "^ *[^ \n]" nil t)
  19602. (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
  19603. (unless (or (= min 0) (= min 10000))
  19604. (setq re (format "^ \\{%d\\}" min))
  19605. (goto-char (point-min))
  19606. (while (re-search-forward re nil t)
  19607. (replace-match "")
  19608. (end-of-line 1))
  19609. min)))
  19610. (defun org-fill-template (template alist)
  19611. "Find each %key of ALIST in TEMPLATE and replace it."
  19612. (let ((case-fold-search nil)
  19613. entry key value)
  19614. (setq alist (sort (copy-sequence alist)
  19615. (lambda (a b) (< (length (car a)) (length (car b))))))
  19616. (while (setq entry (pop alist))
  19617. (setq template
  19618. (replace-regexp-in-string
  19619. (concat "%" (regexp-quote (car entry)))
  19620. (or (cdr entry) "") template t t)))
  19621. template))
  19622. (defun org-base-buffer (buffer)
  19623. "Return the base buffer of BUFFER, if it has one. Else return the buffer."
  19624. (if (not buffer)
  19625. buffer
  19626. (or (buffer-base-buffer buffer)
  19627. buffer)))
  19628. (defun org-trim (s)
  19629. "Remove whitespace at beginning and end of string."
  19630. (if (string-match "\\`[ \t\n\r]+" s) (setq s (replace-match "" t t s)))
  19631. (if (string-match "[ \t\n\r]+\\'" s) (setq s (replace-match "" t t s)))
  19632. s)
  19633. (defun org-wrap (string &optional width lines)
  19634. "Wrap string to either a number of lines, or a width in characters.
  19635. If WIDTH is non-nil, the string is wrapped to that width, however many lines
  19636. that costs. If there is a word longer than WIDTH, the text is actually
  19637. wrapped to the length of that word.
  19638. IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
  19639. many lines, whatever width that takes.
  19640. The return value is a list of lines, without newlines at the end."
  19641. (let* ((words (org-split-string string "[ \t\n]+"))
  19642. (maxword (apply 'max (mapcar 'org-string-width words)))
  19643. w ll)
  19644. (cond (width
  19645. (org-do-wrap words (max maxword width)))
  19646. (lines
  19647. (setq w maxword)
  19648. (setq ll (org-do-wrap words maxword))
  19649. (if (<= (length ll) lines)
  19650. ll
  19651. (setq ll words)
  19652. (while (> (length ll) lines)
  19653. (setq w (1+ w))
  19654. (setq ll (org-do-wrap words w)))
  19655. ll))
  19656. (t (error "Cannot wrap this")))))
  19657. (defun org-do-wrap (words width)
  19658. "Create lines of maximum width WIDTH (in characters) from word list WORDS."
  19659. (let (lines line)
  19660. (while words
  19661. (setq line (pop words))
  19662. (while (and words (< (+ (length line) (length (car words))) width))
  19663. (setq line (concat line " " (pop words))))
  19664. (setq lines (push line lines)))
  19665. (nreverse lines)))
  19666. (defun org-split-string (string &optional separators)
  19667. "Splits STRING into substrings at SEPARATORS.
  19668. No empty strings are returned if there are matches at the beginning
  19669. and end of string."
  19670. (let ((rexp (or separators "[ \f\t\n\r\v]+"))
  19671. (start 0)
  19672. notfirst
  19673. (list nil))
  19674. (while (and (string-match rexp string
  19675. (if (and notfirst
  19676. (= start (match-beginning 0))
  19677. (< start (length string)))
  19678. (1+ start) start))
  19679. (< (match-beginning 0) (length string)))
  19680. (setq notfirst t)
  19681. (or (eq (match-beginning 0) 0)
  19682. (and (eq (match-beginning 0) (match-end 0))
  19683. (eq (match-beginning 0) start))
  19684. (setq list
  19685. (cons (substring string start (match-beginning 0))
  19686. list)))
  19687. (setq start (match-end 0)))
  19688. (or (eq start (length string))
  19689. (setq list
  19690. (cons (substring string start)
  19691. list)))
  19692. (nreverse list)))
  19693. (defun org-quote-vert (s)
  19694. "Replace \"|\" with \"\\vert\"."
  19695. (while (string-match "|" s)
  19696. (setq s (replace-match "\\vert" t t s)))
  19697. s)
  19698. (defun org-uuidgen-p (s)
  19699. "Is S an ID created by UUIDGEN?"
  19700. (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
  19701. (defun org-in-src-block-p (&optional inside)
  19702. "Whether point is in a code source block.
  19703. When INSIDE is non-nil, don't consider we are within a src block
  19704. when point is at #+BEGIN_SRC or #+END_SRC."
  19705. (let ((case-fold-search t) ov)
  19706. (or (and (setq ov (overlays-at (point)))
  19707. (memq 'org-block-background
  19708. (overlay-properties (car ov))))
  19709. (and (not inside)
  19710. (save-match-data
  19711. (save-excursion
  19712. (beginning-of-line)
  19713. (looking-at ".*#\\+\\(begin\\|end\\)_src")))))))
  19714. (defun org-context ()
  19715. "Return a list of contexts of the current cursor position.
  19716. If several contexts apply, all are returned.
  19717. Each context entry is a list with a symbol naming the context, and
  19718. two positions indicating start and end of the context. Possible
  19719. contexts are:
  19720. :headline anywhere in a headline
  19721. :headline-stars on the leading stars in a headline
  19722. :todo-keyword on a TODO keyword (including DONE) in a headline
  19723. :tags on the TAGS in a headline
  19724. :priority on the priority cookie in a headline
  19725. :item on the first line of a plain list item
  19726. :item-bullet on the bullet/number of a plain list item
  19727. :checkbox on the checkbox in a plain list item
  19728. :table in an org-mode table
  19729. :table-special on a special filed in a table
  19730. :table-table in a table.el table
  19731. :clocktable in a clocktable
  19732. :src-block in a source block
  19733. :link on a hyperlink
  19734. :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT, QUOTE.
  19735. :target on a <<target>>
  19736. :radio-target on a <<<radio-target>>>
  19737. :latex-fragment on a LaTeX fragment
  19738. :latex-preview on a LaTeX fragment with overlaid preview image
  19739. This function expects the position to be visible because it uses font-lock
  19740. faces as a help to recognize the following contexts: :table-special, :link,
  19741. and :keyword."
  19742. (let* ((f (get-text-property (point) 'face))
  19743. (faces (if (listp f) f (list f)))
  19744. (case-fold-search t)
  19745. (p (point)) clist o)
  19746. ;; First the large context
  19747. (cond
  19748. ((org-at-heading-p t)
  19749. (push (list :headline (point-at-bol) (point-at-eol)) clist)
  19750. (when (progn
  19751. (beginning-of-line 1)
  19752. (looking-at org-todo-line-tags-regexp))
  19753. (push (org-point-in-group p 1 :headline-stars) clist)
  19754. (push (org-point-in-group p 2 :todo-keyword) clist)
  19755. (push (org-point-in-group p 4 :tags) clist))
  19756. (goto-char p)
  19757. (skip-chars-backward "^[\n\r \t") (or (bobp) (backward-char 1))
  19758. (if (looking-at "\\[#[A-Z0-9]\\]")
  19759. (push (org-point-in-group p 0 :priority) clist)))
  19760. ((org-at-item-p)
  19761. (push (org-point-in-group p 2 :item-bullet) clist)
  19762. (push (list :item (point-at-bol)
  19763. (save-excursion (org-end-of-item) (point)))
  19764. clist)
  19765. (and (org-at-item-checkbox-p)
  19766. (push (org-point-in-group p 0 :checkbox) clist)))
  19767. ((org-at-table-p)
  19768. (push (list :table (org-table-begin) (org-table-end)) clist)
  19769. (if (memq 'org-formula faces)
  19770. (push (list :table-special
  19771. (previous-single-property-change p 'face)
  19772. (next-single-property-change p 'face)) clist)))
  19773. ((org-at-table-p 'any)
  19774. (push (list :table-table) clist)))
  19775. (goto-char p)
  19776. (let ((case-fold-search t))
  19777. ;; New the "medium" contexts: clocktables, source blocks
  19778. (cond ((org-in-clocktable-p)
  19779. (push (list :clocktable
  19780. (and (or (looking-at "#\\+BEGIN: clocktable")
  19781. (search-backward "#+BEGIN: clocktable" nil t))
  19782. (match-beginning 0))
  19783. (and (re-search-forward "#\\+END:?" nil t)
  19784. (match-end 0))) clist))
  19785. ((org-in-src-block-p)
  19786. (push (list :src-block
  19787. (and (or (looking-at "#\\+BEGIN_SRC")
  19788. (search-backward "#+BEGIN_SRC" nil t))
  19789. (match-beginning 0))
  19790. (and (search-forward "#+END_SRC" nil t)
  19791. (match-beginning 0))) clist))))
  19792. (goto-char p)
  19793. ;; Now the small context
  19794. (cond
  19795. ((org-at-timestamp-p)
  19796. (push (org-point-in-group p 0 :timestamp) clist))
  19797. ((memq 'org-link faces)
  19798. (push (list :link
  19799. (previous-single-property-change p 'face)
  19800. (next-single-property-change p 'face)) clist))
  19801. ((memq 'org-special-keyword faces)
  19802. (push (list :keyword
  19803. (previous-single-property-change p 'face)
  19804. (next-single-property-change p 'face)) clist))
  19805. ((org-at-target-p)
  19806. (push (org-point-in-group p 0 :target) clist)
  19807. (goto-char (1- (match-beginning 0)))
  19808. (if (looking-at org-radio-target-regexp)
  19809. (push (org-point-in-group p 0 :radio-target) clist))
  19810. (goto-char p))
  19811. ((setq o (car (delq nil
  19812. (mapcar
  19813. (lambda (x)
  19814. (if (memq x org-latex-fragment-image-overlays) x))
  19815. (overlays-at (point))))))
  19816. (push (list :latex-fragment
  19817. (overlay-start o) (overlay-end o)) clist)
  19818. (push (list :latex-preview
  19819. (overlay-start o) (overlay-end o)) clist))
  19820. ((org-inside-LaTeX-fragment-p)
  19821. ;; FIXME: positions wrong.
  19822. (push (list :latex-fragment (point) (point)) clist)))
  19823. (setq clist (nreverse (delq nil clist)))
  19824. clist))
  19825. ;; FIXME: Compare with at-regexp-p Do we need both?
  19826. (defun org-in-regexp (re &optional nlines visually)
  19827. "Check if point is inside a match of regexp.
  19828. Normally only the current line is checked, but you can include NLINES extra
  19829. lines both before and after point into the search.
  19830. If VISUALLY is set, require that the cursor is not after the match but
  19831. really on, so that the block visually is on the match."
  19832. (catch 'exit
  19833. (let ((pos (point))
  19834. (eol (point-at-eol (+ 1 (or nlines 0))))
  19835. (inc (if visually 1 0)))
  19836. (save-excursion
  19837. (beginning-of-line (- 1 (or nlines 0)))
  19838. (while (re-search-forward re eol t)
  19839. (if (and (<= (match-beginning 0) pos)
  19840. (>= (+ inc (match-end 0)) pos))
  19841. (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
  19842. (defun org-at-regexp-p (regexp)
  19843. "Is point inside a match of REGEXP in the current line?"
  19844. (catch 'exit
  19845. (save-excursion
  19846. (let ((pos (point)) (end (point-at-eol)))
  19847. (beginning-of-line 1)
  19848. (while (re-search-forward regexp end t)
  19849. (if (and (<= (match-beginning 0) pos)
  19850. (>= (match-end 0) pos))
  19851. (throw 'exit t)))
  19852. nil))))
  19853. (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
  19854. "Non-nil when point is between matches of START-RE and END-RE.
  19855. Also return a non-nil value when point is on one of the matches.
  19856. Optional arguments LIM-UP and LIM-DOWN bound the search; they are
  19857. buffer positions. Default values are the positions of headlines
  19858. surrounding the point.
  19859. The functions returns a cons cell whose car (resp. cdr) is the
  19860. position before START-RE (resp. after END-RE)."
  19861. (save-match-data
  19862. (let ((pos (point))
  19863. (limit-up (or lim-up (save-excursion (outline-previous-heading))))
  19864. (limit-down (or lim-down (save-excursion (outline-next-heading))))
  19865. beg end)
  19866. (save-excursion
  19867. ;; Point is on a block when on START-RE or if START-RE can be
  19868. ;; found before it...
  19869. (and (or (org-at-regexp-p start-re)
  19870. (re-search-backward start-re limit-up t))
  19871. (setq beg (match-beginning 0))
  19872. ;; ... and END-RE after it...
  19873. (goto-char (match-end 0))
  19874. (re-search-forward end-re limit-down t)
  19875. (> (setq end (match-end 0)) pos)
  19876. ;; ... without another START-RE in-between.
  19877. (goto-char (match-beginning 0))
  19878. (not (re-search-backward start-re (1+ beg) t))
  19879. ;; Return value.
  19880. (cons beg end))))))
  19881. (defun org-in-block-p (names)
  19882. "Non-nil when point belongs to a block whose name belongs to NAMES.
  19883. NAMES is a list of strings containing names of blocks.
  19884. Return first block name matched, or nil. Beware that in case of
  19885. nested blocks, the returned name may not belong to the closest
  19886. block from point."
  19887. (save-match-data
  19888. (catch 'exit
  19889. (let ((case-fold-search t)
  19890. (lim-up (save-excursion (outline-previous-heading)))
  19891. (lim-down (save-excursion (outline-next-heading))))
  19892. (mapc (lambda (name)
  19893. (let ((n (regexp-quote name)))
  19894. (when (org-between-regexps-p
  19895. (concat "^[ \t]*#\\+begin_" n)
  19896. (concat "^[ \t]*#\\+end_" n)
  19897. lim-up lim-down)
  19898. (throw 'exit n))))
  19899. names))
  19900. nil)))
  19901. (defun org-in-drawer-p ()
  19902. "Is point within a drawer?"
  19903. (save-match-data
  19904. (let ((case-fold-search t)
  19905. (lim-up (save-excursion (outline-previous-heading)))
  19906. (lim-down (save-excursion (outline-next-heading))))
  19907. (org-between-regexps-p
  19908. (concat "^[ \t]*:" (regexp-opt org-drawers) ":")
  19909. "^[ \t]*:end:.*$"
  19910. lim-up lim-down))))
  19911. (defun org-occur-in-agenda-files (regexp &optional nlines)
  19912. "Call `multi-occur' with buffers for all agenda files."
  19913. (interactive "sOrg-files matching: \np")
  19914. (let* ((files (org-agenda-files))
  19915. (tnames (mapcar 'file-truename files))
  19916. (extra org-agenda-text-search-extra-files)
  19917. f)
  19918. (when (eq (car extra) 'agenda-archives)
  19919. (setq extra (cdr extra))
  19920. (setq files (org-add-archive-files files)))
  19921. (while (setq f (pop extra))
  19922. (unless (member (file-truename f) tnames)
  19923. (add-to-list 'files f 'append)
  19924. (add-to-list 'tnames (file-truename f) 'append)))
  19925. (multi-occur
  19926. (mapcar (lambda (x)
  19927. (with-current-buffer
  19928. (or (get-file-buffer x) (find-file-noselect x))
  19929. (widen)
  19930. (current-buffer)))
  19931. files)
  19932. regexp)))
  19933. (if (boundp 'occur-mode-find-occurrence-hook)
  19934. ;; Emacs 23
  19935. (add-hook 'occur-mode-find-occurrence-hook
  19936. (lambda ()
  19937. (when (derived-mode-p 'org-mode)
  19938. (org-reveal))))
  19939. ;; Emacs 22
  19940. (defadvice occur-mode-goto-occurrence
  19941. (after org-occur-reveal activate)
  19942. (and (derived-mode-p 'org-mode) (org-reveal)))
  19943. (defadvice occur-mode-goto-occurrence-other-window
  19944. (after org-occur-reveal activate)
  19945. (and (derived-mode-p 'org-mode) (org-reveal)))
  19946. (defadvice occur-mode-display-occurrence
  19947. (after org-occur-reveal activate)
  19948. (when (derived-mode-p 'org-mode)
  19949. (let ((pos (occur-mode-find-occurrence)))
  19950. (with-current-buffer (marker-buffer pos)
  19951. (save-excursion
  19952. (goto-char pos)
  19953. (org-reveal)))))))
  19954. (defun org-occur-link-in-agenda-files ()
  19955. "Create a link and search for it in the agendas.
  19956. The link is not stored in `org-stored-links', it is just created
  19957. for the search purpose."
  19958. (interactive)
  19959. (let ((link (condition-case nil
  19960. (org-store-link nil)
  19961. (error "Unable to create a link to here"))))
  19962. (org-occur-in-agenda-files (regexp-quote link))))
  19963. (defun org-reverse-string (string)
  19964. "Return the reverse of STRING."
  19965. (apply 'string (reverse (string-to-list string))))
  19966. (defsubst org-uniquify (list)
  19967. "Non-destructively remove duplicate elements from LIST."
  19968. (let ((res (copy-sequence list))) (delete-dups res)))
  19969. (defun org-uniquify-alist (alist)
  19970. "Merge elements of ALIST with the same key.
  19971. For example, in this alist:
  19972. \(org-uniquify-alist '((a 1) (b 2) (a 3)))
  19973. => '((a 1 3) (b 2))
  19974. merge (a 1) and (a 3) into (a 1 3).
  19975. The function returns the new ALIST."
  19976. (let (rtn)
  19977. (mapc
  19978. (lambda (e)
  19979. (let (n)
  19980. (if (not (assoc (car e) rtn))
  19981. (push e rtn)
  19982. (setq n (cons (car e) (append (cdr (assoc (car e) rtn)) (cdr e))))
  19983. (setq rtn (assq-delete-all (car e) rtn))
  19984. (push n rtn))))
  19985. alist)
  19986. rtn))
  19987. (defun org-delete-all (elts list)
  19988. "Remove all elements in ELTS from LIST."
  19989. (while elts
  19990. (setq list (delete (pop elts) list)))
  19991. list)
  19992. (defun org-count (cl-item cl-seq)
  19993. "Count the number of occurrences of ITEM in SEQ.
  19994. Taken from `count' in cl-seq.el with all keyword arguments removed."
  19995. (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
  19996. (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
  19997. (while (< cl-start cl-end)
  19998. (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
  19999. (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
  20000. (setq cl-start (1+ cl-start)))
  20001. cl-count))
  20002. (defun org-remove-if (predicate seq)
  20003. "Remove everything from SEQ that fulfills PREDICATE."
  20004. (let (res e)
  20005. (while seq
  20006. (setq e (pop seq))
  20007. (if (not (funcall predicate e)) (push e res)))
  20008. (nreverse res)))
  20009. (defun org-remove-if-not (predicate seq)
  20010. "Remove everything from SEQ that does not fulfill PREDICATE."
  20011. (let (res e)
  20012. (while seq
  20013. (setq e (pop seq))
  20014. (if (funcall predicate e) (push e res)))
  20015. (nreverse res)))
  20016. (defun org-reduce (cl-func cl-seq &rest cl-keys)
  20017. "Reduce two-argument FUNCTION across SEQ.
  20018. Taken from `reduce' in cl-seq.el with all keyword arguments but
  20019. \":initial-value\" removed."
  20020. (let ((cl-accum (cond ((memq :initial-value cl-keys)
  20021. (cadr (memq :initial-value cl-keys)))
  20022. (cl-seq (pop cl-seq))
  20023. (t (funcall cl-func)))))
  20024. (while cl-seq
  20025. (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
  20026. cl-accum))
  20027. (defun org-every (pred seq)
  20028. "Return true if PREDICATE is true of every element of SEQ.
  20029. Adapted from `every' in cl.el."
  20030. (catch 'org-every
  20031. (mapc (lambda (e) (unless (funcall pred e) (throw 'org-every nil))) seq)
  20032. t))
  20033. (defun org-some (pred seq)
  20034. "Return true if PREDICATE is true of any element of SEQ.
  20035. Adapted from `some' in cl.el."
  20036. (catch 'org-some
  20037. (mapc (lambda (e) (when (funcall pred e) (throw 'org-some t))) seq)
  20038. nil))
  20039. (defun org-back-over-empty-lines ()
  20040. "Move backwards over whitespace, to the beginning of the first empty line.
  20041. Returns the number of empty lines passed."
  20042. (let ((pos (point)))
  20043. (if (cdr (assoc 'heading org-blank-before-new-entry))
  20044. (skip-chars-backward " \t\n\r")
  20045. (unless (eobp)
  20046. (forward-line -1)))
  20047. (beginning-of-line 2)
  20048. (goto-char (min (point) pos))
  20049. (count-lines (point) pos)))
  20050. (defun org-skip-whitespace ()
  20051. (skip-chars-forward " \t\n\r"))
  20052. (defun org-point-in-group (point group &optional context)
  20053. "Check if POINT is in match-group GROUP.
  20054. If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
  20055. match. If the match group does not exist or point is not inside it,
  20056. return nil."
  20057. (and (match-beginning group)
  20058. (>= point (match-beginning group))
  20059. (<= point (match-end group))
  20060. (if context
  20061. (list context (match-beginning group) (match-end group))
  20062. t)))
  20063. (defun org-switch-to-buffer-other-window (&rest args)
  20064. "Switch to buffer in a second window on the current frame.
  20065. In particular, do not allow pop-up frames.
  20066. Returns the newly created buffer."
  20067. (org-no-popups
  20068. (apply 'switch-to-buffer-other-window args)))
  20069. (defun org-combine-plists (&rest plists)
  20070. "Create a single property list from all plists in PLISTS.
  20071. The process starts by copying the first list, and then setting properties
  20072. from the other lists. Settings in the last list are the most significant
  20073. ones and overrule settings in the other lists."
  20074. (let ((rtn (copy-sequence (pop plists)))
  20075. p v ls)
  20076. (while plists
  20077. (setq ls (pop plists))
  20078. (while ls
  20079. (setq p (pop ls) v (pop ls))
  20080. (setq rtn (plist-put rtn p v))))
  20081. rtn))
  20082. (defun org-replace-escapes (string table)
  20083. "Replace %-escapes in STRING with values in TABLE.
  20084. TABLE is an association list with keys like \"%a\" and string values.
  20085. The sequences in STRING may contain normal field width and padding information,
  20086. for example \"%-5s\". Replacements happen in the sequence given by TABLE,
  20087. so values can contain further %-escapes if they are define later in TABLE."
  20088. (let ((tbl (copy-alist table))
  20089. (case-fold-search nil)
  20090. (pchg 0)
  20091. e re rpl)
  20092. (while (setq e (pop tbl))
  20093. (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
  20094. (when (and (cdr e) (string-match re (cdr e)))
  20095. (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
  20096. (safe "SREF"))
  20097. (add-text-properties 0 3 (list 'sref sref) safe)
  20098. (setcdr e (replace-match safe t t (cdr e)))))
  20099. (while (string-match re string)
  20100. (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
  20101. (cdr e)))
  20102. (setq string (replace-match rpl t t string))))
  20103. (while (setq pchg (next-property-change pchg string))
  20104. (let ((sref (get-text-property pchg 'sref string)))
  20105. (when (and sref (string-match "SREF" string pchg))
  20106. (setq string (replace-match sref t t string)))))
  20107. string))
  20108. (defun org-sublist (list start end)
  20109. "Return a section of LIST, from START to END.
  20110. Counting starts at 1."
  20111. (let (rtn (c start))
  20112. (setq list (nthcdr (1- start) list))
  20113. (while (and list (<= c end))
  20114. (push (pop list) rtn)
  20115. (setq c (1+ c)))
  20116. (nreverse rtn)))
  20117. (defun org-find-base-buffer-visiting (file)
  20118. "Like `find-buffer-visiting' but always return the base buffer and
  20119. not an indirect buffer."
  20120. (let ((buf (or (get-file-buffer file)
  20121. (find-buffer-visiting file))))
  20122. (if buf
  20123. (or (buffer-base-buffer buf) buf)
  20124. nil)))
  20125. (defun org-image-file-name-regexp (&optional extensions)
  20126. "Return regexp matching the file names of images.
  20127. If EXTENSIONS is given, only match these."
  20128. (if (and (not extensions) (fboundp 'image-file-name-regexp))
  20129. (image-file-name-regexp)
  20130. (let ((image-file-name-extensions
  20131. (or extensions
  20132. '("png" "jpeg" "jpg" "gif" "tiff" "tif"
  20133. "xbm" "xpm" "pbm" "pgm" "ppm"))))
  20134. (concat "\\."
  20135. (regexp-opt (nconc (mapcar 'upcase
  20136. image-file-name-extensions)
  20137. image-file-name-extensions)
  20138. t)
  20139. "\\'"))))
  20140. (defun org-file-image-p (file &optional extensions)
  20141. "Return non-nil if FILE is an image."
  20142. (save-match-data
  20143. (string-match (org-image-file-name-regexp extensions) file)))
  20144. (defun org-get-cursor-date (&optional with-time)
  20145. "Return the date at cursor in as a time.
  20146. This works in the calendar and in the agenda, anywhere else it just
  20147. returns the current time.
  20148. If WITH-TIME is non-nil, returns the time of the event at point (in
  20149. the agenda) or the current time of the day."
  20150. (let (date day defd tp tm hod mod)
  20151. (when with-time
  20152. (setq tp (get-text-property (point) 'time))
  20153. (when (and tp (string-match "\\([0-9][0-9]\\):\\([0-9][0-9]\\)" tp))
  20154. (setq hod (string-to-number (match-string 1 tp))
  20155. mod (string-to-number (match-string 2 tp))))
  20156. (or tp (setq hod (nth 2 (decode-time (current-time)))
  20157. mod (nth 1 (decode-time (current-time))))))
  20158. (cond
  20159. ((eq major-mode 'calendar-mode)
  20160. (setq date (calendar-cursor-to-date)
  20161. defd (encode-time 0 (or mod 0) (or hod 0)
  20162. (nth 1 date) (nth 0 date) (nth 2 date))))
  20163. ((eq major-mode 'org-agenda-mode)
  20164. (setq day (get-text-property (point) 'day))
  20165. (if day
  20166. (setq date (calendar-gregorian-from-absolute day)
  20167. defd (encode-time 0 (or mod 0) (or hod 0)
  20168. (nth 1 date) (nth 0 date) (nth 2 date))))))
  20169. (or defd (current-time))))
  20170. (defun org-mark-subtree (&optional up)
  20171. "Mark the current subtree.
  20172. This puts point at the start of the current subtree, and mark at
  20173. the end. If a numeric prefix UP is given, move up into the
  20174. hierarchy of headlines by UP levels before marking the subtree."
  20175. (interactive "P")
  20176. (org-with-limited-levels
  20177. (cond ((org-at-heading-p) (beginning-of-line))
  20178. ((org-before-first-heading-p) (user-error "Not in a subtree"))
  20179. (t (outline-previous-visible-heading 1))))
  20180. (when up (while (and (> up 0) (org-up-heading-safe)) (decf up)))
  20181. (if (org-called-interactively-p 'any)
  20182. (call-interactively 'org-mark-element)
  20183. (org-mark-element)))
  20184. ;;; Indentation
  20185. (defun org-indent-line ()
  20186. "Indent line depending on context."
  20187. (interactive)
  20188. (let* ((pos (point))
  20189. (itemp (org-at-item-p))
  20190. (case-fold-search t)
  20191. (org-drawer-regexp (or org-drawer-regexp "\000"))
  20192. (inline-task-p (and (featurep 'org-inlinetask)
  20193. (org-inlinetask-in-task-p)))
  20194. (inline-re (and inline-task-p
  20195. (org-inlinetask-outline-regexp)))
  20196. column)
  20197. (if (and orgstruct-is-++ (eq pos (point)))
  20198. (let ((indent-line-function (cadadr (assoc 'indent-line-function org-fb-vars))))
  20199. (indent-according-to-mode))
  20200. (beginning-of-line 1)
  20201. (cond
  20202. ;; Headings
  20203. ((looking-at org-outline-regexp) (setq column 0))
  20204. ;; Footnote definition
  20205. ((looking-at org-footnote-definition-re) (setq column 0))
  20206. ;; Literal examples
  20207. ((looking-at "[ \t]*:\\( \\|$\\)")
  20208. (setq column (org-get-indentation))) ; do nothing
  20209. ;; Lists
  20210. ((ignore-errors (goto-char (org-in-item-p)))
  20211. (setq column (if itemp
  20212. (org-get-indentation)
  20213. (org-list-item-body-column (point))))
  20214. (goto-char pos))
  20215. ;; Drawers
  20216. ((and (looking-at "[ \t]*:END:")
  20217. (save-excursion (re-search-backward org-drawer-regexp nil t)))
  20218. (save-excursion
  20219. (goto-char (1- (match-beginning 1)))
  20220. (setq column (current-column))))
  20221. ;; Special blocks
  20222. ((and (looking-at "[ \t]*#\\+end_\\([a-z]+\\)")
  20223. (save-excursion
  20224. (re-search-backward
  20225. (concat "^[ \t]*#\\+begin_" (downcase (match-string 1))) nil t)))
  20226. (setq column (org-get-indentation (match-string 0))))
  20227. ((and (not (looking-at "[ \t]*#\\+begin_"))
  20228. (org-between-regexps-p "^[ \t]*#\\+begin_" "[ \t]*#\\+end_"))
  20229. (save-excursion
  20230. (re-search-backward "^[ \t]*#\\+begin_\\([a-z]+\\)" nil t))
  20231. (setq column
  20232. (cond ((equal (downcase (match-string 1)) "src")
  20233. ;; src blocks: let `org-edit-src-exit' handle them
  20234. (org-get-indentation))
  20235. ((equal (downcase (match-string 1)) "example")
  20236. (max (org-get-indentation)
  20237. (org-get-indentation (match-string 0))))
  20238. (t
  20239. (org-get-indentation (match-string 0))))))
  20240. ;; This line has nothing special, look at the previous relevant
  20241. ;; line to compute indentation
  20242. (t
  20243. (beginning-of-line 0)
  20244. (while (and (not (bobp))
  20245. (not (looking-at org-table-line-regexp))
  20246. (not (looking-at org-drawer-regexp))
  20247. ;; When point started in an inline task, do not move
  20248. ;; above task starting line.
  20249. (not (and inline-task-p (looking-at inline-re)))
  20250. ;; Skip drawers, blocks, empty lines, verbatim,
  20251. ;; comments, tables, footnotes definitions, lists,
  20252. ;; inline tasks.
  20253. (or (and (looking-at "[ \t]*:END:")
  20254. (re-search-backward org-drawer-regexp nil t))
  20255. (and (looking-at "[ \t]*#\\+end_")
  20256. (re-search-backward "[ \t]*#\\+begin_"nil t))
  20257. (looking-at "[ \t]*[\n:#|]")
  20258. (looking-at org-footnote-definition-re)
  20259. (and (not inline-task-p)
  20260. (featurep 'org-inlinetask)
  20261. (org-inlinetask-in-task-p)
  20262. (or (org-inlinetask-goto-beginning) t))))
  20263. (beginning-of-line 0))
  20264. (cond
  20265. ;; There was a list item above.
  20266. ((ignore-errors (goto-char (org-in-item-p)))
  20267. (goto-char (org-list-get-top-point (org-list-struct)))
  20268. (setq column (org-get-indentation)))
  20269. ;; There was an heading above.
  20270. ((looking-at "\\*+[ \t]+")
  20271. (if (not org-adapt-indentation)
  20272. (setq column 0)
  20273. (goto-char (match-end 0))
  20274. (setq column (current-column))))
  20275. ;; A drawer had started and is unfinished
  20276. ((looking-at org-drawer-regexp)
  20277. (goto-char (1- (match-beginning 1)))
  20278. (setq column (current-column)))
  20279. ;; Else, nothing noticeable found: get indentation and go on.
  20280. (t (setq column (org-get-indentation))))))
  20281. ;; Now apply indentation and move cursor accordingly
  20282. (goto-char pos)
  20283. (if (<= (current-column) (current-indentation))
  20284. (org-indent-line-to column)
  20285. (save-excursion (org-indent-line-to column)))
  20286. ;; Special polishing for properties, see `org-property-format'
  20287. (setq column (current-column))
  20288. (beginning-of-line 1)
  20289. (if (looking-at org-property-re)
  20290. (replace-match (concat (match-string 4)
  20291. (format org-property-format
  20292. (match-string 1) (match-string 3)))
  20293. t t))
  20294. (org-move-to-column column))))
  20295. (defun org-indent-drawer ()
  20296. "Indent the drawer at point."
  20297. (interactive)
  20298. (let ((p (point))
  20299. (e (and (save-excursion (re-search-forward ":END:" nil t))
  20300. (match-end 0)))
  20301. (folded
  20302. (save-excursion
  20303. (end-of-line)
  20304. (when (overlays-at (point))
  20305. (member 'invisible (overlay-properties
  20306. (car (overlays-at (point)))))))))
  20307. (when folded (org-cycle))
  20308. (indent-for-tab-command)
  20309. (while (and (move-beginning-of-line 2) (< (point) e))
  20310. (indent-for-tab-command))
  20311. (goto-char p)
  20312. (when folded (org-cycle)))
  20313. (message "Drawer at point indented"))
  20314. (defun org-indent-block ()
  20315. "Indent the block at point."
  20316. (interactive)
  20317. (let ((p (point))
  20318. (case-fold-search t)
  20319. (e (and (save-excursion (re-search-forward "#\\+end_?\\(?:[a-z]+\\)?" nil t))
  20320. (match-end 0)))
  20321. (folded
  20322. (save-excursion
  20323. (end-of-line)
  20324. (when (overlays-at (point))
  20325. (member 'invisible (overlay-properties
  20326. (car (overlays-at (point)))))))))
  20327. (when folded (org-cycle))
  20328. (indent-for-tab-command)
  20329. (while (and (move-beginning-of-line 2) (< (point) e))
  20330. (indent-for-tab-command))
  20331. (goto-char p)
  20332. (when folded (org-cycle)))
  20333. (message "Block at point indented"))
  20334. (defun org-indent-region (start end)
  20335. "Indent region."
  20336. (interactive "r")
  20337. (save-excursion
  20338. (let ((line-end (org-current-line end)))
  20339. (goto-char start)
  20340. (while (< (org-current-line) line-end)
  20341. (cond ((org-in-src-block-p) (org-src-native-tab-command-maybe))
  20342. (t (call-interactively 'org-indent-line)))
  20343. (move-beginning-of-line 2)))))
  20344. ;;; Filling
  20345. ;; We use our own fill-paragraph and auto-fill functions.
  20346. ;; `org-fill-paragraph' relies on adaptive filling and context
  20347. ;; checking. Appropriate `fill-prefix' is computed with
  20348. ;; `org-adaptive-fill-function'.
  20349. ;; `org-auto-fill-function' takes care of auto-filling. It calls
  20350. ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
  20351. ;; `org-adaptive-fill-function' value. Internally,
  20352. ;; `org-comment-line-break-function' breaks the line.
  20353. ;; `org-setup-filling' installs filling and auto-filling related
  20354. ;; variables during `org-mode' initialization.
  20355. (defvar org-element-paragraph-separate) ; org-element.el
  20356. (defun org-setup-filling ()
  20357. (require 'org-element)
  20358. ;; Prevent auto-fill from inserting unwanted new items.
  20359. (when (boundp 'fill-nobreak-predicate)
  20360. (org-set-local
  20361. 'fill-nobreak-predicate
  20362. (org-uniquify
  20363. (append fill-nobreak-predicate
  20364. '(org-fill-line-break-nobreak-p
  20365. org-fill-paragraph-with-timestamp-nobreak-p)))))
  20366. (let ((paragraph-ending (substring org-element-paragraph-separate 1)))
  20367. (org-set-local 'paragraph-start paragraph-ending)
  20368. (org-set-local 'paragraph-separate paragraph-ending))
  20369. (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
  20370. (org-set-local 'auto-fill-inhibit-regexp nil)
  20371. (org-set-local 'adaptive-fill-function 'org-adaptive-fill-function)
  20372. (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
  20373. (org-set-local 'comment-line-break-function 'org-comment-line-break-function))
  20374. (defun org-fill-line-break-nobreak-p ()
  20375. "Non-nil when a new line at point would create an Org line break."
  20376. (save-excursion
  20377. (skip-chars-backward "[ \t]")
  20378. (skip-chars-backward "\\\\")
  20379. (looking-at "\\\\\\\\\\($\\|[^\\\\]\\)")))
  20380. (defun org-fill-paragraph-with-timestamp-nobreak-p ()
  20381. "Non-nil when a new line at point would split a timestamp."
  20382. (and (org-at-timestamp-p t)
  20383. (not (looking-at org-ts-regexp-both))))
  20384. (declare-function message-in-body-p "message" ())
  20385. (defvar orgtbl-line-start-regexp) ; From org-table.el
  20386. (defun org-adaptive-fill-function ()
  20387. "Compute a fill prefix for the current line.
  20388. Return fill prefix, as a string, or nil if current line isn't
  20389. meant to be filled. For convenience, if `adaptive-fill-regexp'
  20390. matches in paragraphs or comments, use it."
  20391. (let (prefix)
  20392. (catch 'exit
  20393. (when (derived-mode-p 'message-mode)
  20394. (save-excursion
  20395. (beginning-of-line)
  20396. (cond ((or (not (message-in-body-p))
  20397. (looking-at orgtbl-line-start-regexp))
  20398. (throw 'exit nil))
  20399. ((looking-at message-cite-prefix-regexp)
  20400. (throw 'exit (match-string-no-properties 0)))
  20401. ((looking-at org-outline-regexp)
  20402. (throw 'exit (make-string (length (match-string 0)) ? ))))))
  20403. (org-with-wide-buffer
  20404. (let* ((p (line-beginning-position))
  20405. (element (save-excursion
  20406. (beginning-of-line)
  20407. (or (ignore-errors (org-element-at-point))
  20408. (user-error "An element cannot be parsed line %d"
  20409. (line-number-at-pos (point))))))
  20410. (type (org-element-type element))
  20411. (post-affiliated (org-element-property :post-affiliated element)))
  20412. (unless (and post-affiliated (< p post-affiliated))
  20413. (case type
  20414. (comment
  20415. (save-excursion
  20416. (beginning-of-line)
  20417. (looking-at "[ \t]*#")
  20418. (goto-char (match-end 0))
  20419. (let ((comment-prefix (match-string 0)))
  20420. (if (looking-at adaptive-fill-regexp)
  20421. (concat comment-prefix (match-string 0))
  20422. comment-prefix))))
  20423. (footnote-definition "")
  20424. ((item plain-list)
  20425. (make-string (org-list-item-body-column
  20426. (or post-affiliated
  20427. (org-element-property :begin element)))
  20428. ? ))
  20429. (paragraph
  20430. ;; Fill prefix is usually the same as the current line,
  20431. ;; unless the paragraph is at the beginning of an item.
  20432. (let ((parent (org-element-property :parent element)))
  20433. (save-excursion
  20434. (beginning-of-line)
  20435. (cond ((eq (org-element-type parent) 'item)
  20436. (make-string (org-list-item-body-column
  20437. (org-element-property :begin parent))
  20438. ? ))
  20439. ((and adaptive-fill-regexp
  20440. ;; Locally disable
  20441. ;; `adaptive-fill-function' to let
  20442. ;; `fill-context-prefix' handle
  20443. ;; `adaptive-fill-regexp' variable.
  20444. (let (adaptive-fill-function)
  20445. (fill-context-prefix
  20446. post-affiliated
  20447. (org-element-property :end element)))))
  20448. ((looking-at "[ \t]+") (match-string 0))
  20449. (t "")))))
  20450. (comment-block
  20451. ;; Only fill contents if P is within block boundaries.
  20452. (let* ((cbeg (save-excursion (goto-char post-affiliated)
  20453. (forward-line)
  20454. (point)))
  20455. (cend (save-excursion
  20456. (goto-char (org-element-property :end element))
  20457. (skip-chars-backward " \r\t\n")
  20458. (line-beginning-position))))
  20459. (when (and (>= p cbeg) (< p cend))
  20460. (if (save-excursion (beginning-of-line) (looking-at "[ \t]+"))
  20461. (match-string 0)
  20462. "")))))))))))
  20463. (declare-function message-goto-body "message" ())
  20464. (defvar message-cite-prefix-regexp) ; From message.el
  20465. (defun org-fill-paragraph (&optional justify)
  20466. "Fill element at point, when applicable.
  20467. This function only applies to comment blocks, comments, example
  20468. blocks and paragraphs. Also, as a special case, re-align table
  20469. when point is at one.
  20470. If JUSTIFY is non-nil (interactively, with prefix argument),
  20471. justify as well. If `sentence-end-double-space' is non-nil, then
  20472. period followed by one space does not end a sentence, so don't
  20473. break a line there. The variable `fill-column' controls the
  20474. width for filling.
  20475. For convenience, when point is at a plain list, an item or
  20476. a footnote definition, try to fill the first paragraph within."
  20477. (interactive)
  20478. (if (and (derived-mode-p 'message-mode)
  20479. (or (not (message-in-body-p))
  20480. (save-excursion (move-beginning-of-line 1)
  20481. (looking-at message-cite-prefix-regexp))))
  20482. ;; First ensure filling is correct in message-mode.
  20483. (let ((fill-paragraph-function
  20484. (cadadr (assoc 'fill-paragraph-function org-fb-vars)))
  20485. (fill-prefix (cadadr (assoc 'fill-prefix org-fb-vars)))
  20486. (paragraph-start (cadadr (assoc 'paragraph-start org-fb-vars)))
  20487. (paragraph-separate
  20488. (cadadr (assoc 'paragraph-separate org-fb-vars))))
  20489. (fill-paragraph nil))
  20490. (with-syntax-table org-mode-transpose-word-syntax-table
  20491. ;; Move to end of line in order to get the first paragraph
  20492. ;; within a plain list or a footnote definition.
  20493. (let ((element (save-excursion
  20494. (end-of-line)
  20495. (or (ignore-errors (org-element-at-point))
  20496. (user-error "An element cannot be parsed line %d"
  20497. (line-number-at-pos (point)))))))
  20498. ;; First check if point is in a blank line at the beginning of
  20499. ;; the buffer. In that case, ignore filling.
  20500. (case (org-element-type element)
  20501. ;; Use major mode filling function is src blocks.
  20502. (src-block (org-babel-do-key-sequence-in-edit-buffer (kbd "M-q")))
  20503. ;; Align Org tables, leave table.el tables as-is.
  20504. (table-row (org-table-align) t)
  20505. (table
  20506. (when (eq (org-element-property :type element) 'org)
  20507. (save-excursion
  20508. (goto-char (org-element-property :post-affiliated element))
  20509. (org-table-align)))
  20510. t)
  20511. (paragraph
  20512. ;; Paragraphs may contain `line-break' type objects.
  20513. (let ((beg (max (point-min)
  20514. (org-element-property :contents-begin element)))
  20515. (end (min (point-max)
  20516. (org-element-property :contents-end element))))
  20517. ;; Do nothing if point is at an affiliated keyword.
  20518. (if (< (line-end-position) beg) t
  20519. (when (derived-mode-p 'message-mode)
  20520. ;; In `message-mode', do not fill following citation
  20521. ;; in current paragraph nor text before message body.
  20522. (let ((body-start (save-excursion (message-goto-body))))
  20523. (when body-start (setq beg (max body-start beg))))
  20524. (when (save-excursion
  20525. (re-search-forward
  20526. (concat "^" message-cite-prefix-regexp) end t))
  20527. (setq end (match-beginning 0))))
  20528. ;; Fill paragraph, taking line breaks into account.
  20529. ;; For that, slice the paragraph using line breaks as
  20530. ;; separators, and fill the parts in reverse order to
  20531. ;; avoid messing with markers.
  20532. (save-excursion
  20533. (goto-char end)
  20534. (mapc
  20535. (lambda (pos)
  20536. (fill-region-as-paragraph pos (point) justify)
  20537. (goto-char pos))
  20538. ;; Find the list of ending positions for line breaks
  20539. ;; in the current paragraph. Add paragraph
  20540. ;; beginning to include first slice.
  20541. (nreverse
  20542. (cons beg
  20543. (org-element-map
  20544. (org-element--parse-objects
  20545. beg end nil (org-element-restriction 'paragraph))
  20546. 'line-break
  20547. (lambda (lb) (org-element-property :end lb)))))))
  20548. t)))
  20549. ;; Contents of `comment-block' type elements should be
  20550. ;; filled as plain text, but only if point is within block
  20551. ;; markers.
  20552. (comment-block
  20553. (let* ((case-fold-search t)
  20554. (beg (save-excursion
  20555. (goto-char (org-element-property :begin element))
  20556. (re-search-forward "^[ \t]*#\\+begin_comment" nil t)
  20557. (forward-line)
  20558. (point)))
  20559. (end (save-excursion
  20560. (goto-char (org-element-property :end element))
  20561. (re-search-backward "^[ \t]*#\\+end_comment" nil t)
  20562. (line-beginning-position))))
  20563. (if (or (< (point) beg) (> (point) end)) t
  20564. (fill-region-as-paragraph
  20565. (save-excursion (end-of-line)
  20566. (re-search-backward "^[ \t]*$" beg 'move)
  20567. (line-beginning-position))
  20568. (save-excursion (beginning-of-line)
  20569. (re-search-forward "^[ \t]*$" end 'move)
  20570. (line-beginning-position))
  20571. justify))))
  20572. ;; Fill comments.
  20573. (comment
  20574. (let ((begin (org-element-property :post-affiliated element))
  20575. (end (org-element-property :end element)))
  20576. (when (and (>= (point) begin) (<= (point) end))
  20577. (let ((begin (save-excursion
  20578. (end-of-line)
  20579. (if (re-search-backward "^[ \t]*#[ \t]*$" begin t)
  20580. (progn (forward-line) (point))
  20581. begin)))
  20582. (end (save-excursion
  20583. (end-of-line)
  20584. (if (re-search-forward "^[ \t]*#[ \t]*$" end 'move)
  20585. (1- (line-beginning-position))
  20586. (skip-chars-backward " \r\t\n")
  20587. (line-end-position)))))
  20588. ;; Do not fill comments when at a blank line.
  20589. (when (> end begin)
  20590. (let ((fill-prefix
  20591. (save-excursion
  20592. (beginning-of-line)
  20593. (looking-at "[ \t]*#")
  20594. (let ((comment-prefix (match-string 0)))
  20595. (goto-char (match-end 0))
  20596. (if (looking-at adaptive-fill-regexp)
  20597. (concat comment-prefix (match-string 0))
  20598. (concat comment-prefix " "))))))
  20599. (save-excursion
  20600. (fill-region-as-paragraph begin end justify))))))
  20601. t))
  20602. ;; Ignore every other element.
  20603. (otherwise t))))))
  20604. (defun org-auto-fill-function ()
  20605. "Auto-fill function."
  20606. ;; Check if auto-filling is meaningful.
  20607. (let ((fc (current-fill-column)))
  20608. (when (and fc (> (current-column) fc))
  20609. (let* ((fill-prefix (org-adaptive-fill-function))
  20610. ;; Enforce empty fill prefix, if required. Otherwise, it
  20611. ;; will be computed again.
  20612. (adaptive-fill-mode (not (equal fill-prefix ""))))
  20613. (when fill-prefix (do-auto-fill))))))
  20614. (defun org-comment-line-break-function (&optional soft)
  20615. "Break line at point and indent, continuing comment if within one.
  20616. The inserted newline is marked hard if variable
  20617. `use-hard-newlines' is true, unless optional argument SOFT is
  20618. non-nil."
  20619. (if soft (insert-and-inherit ?\n) (newline 1))
  20620. (save-excursion (forward-char -1) (delete-horizontal-space))
  20621. (delete-horizontal-space)
  20622. (indent-to-left-margin)
  20623. (insert-before-markers-and-inherit fill-prefix))
  20624. ;;; Comments
  20625. ;; Org comments syntax is quite complex. It requires the entire line
  20626. ;; to be just a comment. Also, even with the right syntax at the
  20627. ;; beginning of line, some some elements (i.e. verse-block or
  20628. ;; example-block) don't accept comments. Usual Emacs comment commands
  20629. ;; cannot cope with those requirements. Therefore, Org replaces them.
  20630. ;; Org still relies on `comment-dwim', but cannot trust
  20631. ;; `comment-only-p'. So, `comment-region-function' and
  20632. ;; `uncomment-region-function' both point
  20633. ;; to`org-comment-or-uncomment-region'. Eventually,
  20634. ;; `org-insert-comment' takes care of insertion of comments at the
  20635. ;; beginning of line.
  20636. ;; `org-setup-comments-handling' install comments related variables
  20637. ;; during `org-mode' initialization.
  20638. (defun org-setup-comments-handling ()
  20639. (interactive)
  20640. (org-set-local 'comment-use-syntax nil)
  20641. (org-set-local 'comment-start "# ")
  20642. (org-set-local 'comment-start-skip "^\\s-*#\\(?: \\|$\\)")
  20643. (org-set-local 'comment-insert-comment-function 'org-insert-comment)
  20644. (org-set-local 'comment-region-function 'org-comment-or-uncomment-region)
  20645. (org-set-local 'uncomment-region-function 'org-comment-or-uncomment-region))
  20646. (defun org-insert-comment ()
  20647. "Insert an empty comment above current line.
  20648. If the line is empty, insert comment at its beginning."
  20649. (beginning-of-line)
  20650. (if (looking-at "\\s-*$") (replace-match "") (open-line 1))
  20651. (org-indent-line)
  20652. (insert "# "))
  20653. (defvar comment-empty-lines) ; From newcomment.el.
  20654. (defun org-comment-or-uncomment-region (beg end &rest ignore)
  20655. "Comment or uncomment each non-blank line in the region.
  20656. Uncomment each non-blank line between BEG and END if it only
  20657. contains commented lines. Otherwise, comment them."
  20658. (save-restriction
  20659. ;; Restrict region
  20660. (narrow-to-region (save-excursion (goto-char beg)
  20661. (skip-chars-forward " \r\t\n" end)
  20662. (line-beginning-position))
  20663. (save-excursion (goto-char end)
  20664. (skip-chars-backward " \r\t\n" beg)
  20665. (line-end-position)))
  20666. (let ((uncommentp
  20667. ;; UNCOMMENTP is non-nil when every non blank line between
  20668. ;; BEG and END is a comment.
  20669. (save-excursion
  20670. (goto-char (point-min))
  20671. (while (and (not (eobp))
  20672. (let ((element (org-element-at-point)))
  20673. (and (eq (org-element-type element) 'comment)
  20674. (goto-char (min (point-max)
  20675. (org-element-property
  20676. :end element)))))))
  20677. (eobp))))
  20678. (if uncommentp
  20679. ;; Only blank lines and comments in region: uncomment it.
  20680. (save-excursion
  20681. (goto-char (point-min))
  20682. (while (not (eobp))
  20683. (when (looking-at "[ \t]*\\(#\\(?: \\|$\\)\\)")
  20684. (replace-match "" nil nil nil 1))
  20685. (forward-line)))
  20686. ;; Comment each line in region.
  20687. (let ((min-indent (point-max)))
  20688. ;; First find the minimum indentation across all lines.
  20689. (save-excursion
  20690. (goto-char (point-min))
  20691. (while (and (not (eobp)) (not (zerop min-indent)))
  20692. (unless (looking-at "[ \t]*$")
  20693. (setq min-indent (min min-indent (current-indentation))))
  20694. (forward-line)))
  20695. ;; Then loop over all lines.
  20696. (save-excursion
  20697. (goto-char (point-min))
  20698. (while (not (eobp))
  20699. (unless (and (not comment-empty-lines) (looking-at "[ \t]*$"))
  20700. ;; Don't get fooled by invisible text (e.g. link path)
  20701. ;; when moving to column MIN-INDENT.
  20702. (let ((buffer-invisibility-spec nil))
  20703. (org-move-to-column min-indent t))
  20704. (insert comment-start))
  20705. (forward-line))))))))
  20706. ;;; Planning
  20707. ;; This section contains tools to operate on timestamp objects, as
  20708. ;; returned by, e.g. `org-element-context'.
  20709. (defun org-timestamp-has-time-p (timestamp)
  20710. "Non-nil when TIMESTAMP has a time specified."
  20711. (org-element-property :hour-start timestamp))
  20712. (defun org-timestamp-format (timestamp format &optional end utc)
  20713. "Format a TIMESTAMP element into a string.
  20714. FORMAT is a format specifier to be passed to
  20715. `format-time-string'.
  20716. When optional argument END is non-nil, use end of date-range or
  20717. time-range, if possible.
  20718. When optional argument UTC is non-nil, time will be expressed as
  20719. Universal Time."
  20720. (format-time-string
  20721. format
  20722. (apply 'encode-time
  20723. (cons 0
  20724. (mapcar
  20725. (lambda (prop) (or (org-element-property prop timestamp) 0))
  20726. (if end '(:minute-end :hour-end :day-end :month-end :year-end)
  20727. '(:minute-start :hour-start :day-start :month-start
  20728. :year-start)))))
  20729. utc))
  20730. (defun org-timestamp-split-range (timestamp &optional end)
  20731. "Extract a timestamp object from a date or time range.
  20732. TIMESTAMP is a timestamp object. END, when non-nil, means extract
  20733. the end of the range. Otherwise, extract its start.
  20734. Return a new timestamp object sharing the same parent as
  20735. TIMESTAMP."
  20736. (let ((type (org-element-property :type timestamp)))
  20737. (if (memq type '(active inactive diary)) timestamp
  20738. (let ((split-ts (list 'timestamp (copy-sequence (nth 1 timestamp)))))
  20739. ;; Set new type.
  20740. (org-element-put-property
  20741. split-ts :type (if (eq type 'active-range) 'active 'inactive))
  20742. ;; Copy start properties over end properties if END is
  20743. ;; non-nil. Otherwise, copy end properties over `start' ones.
  20744. (let ((p-alist '((:minute-start . :minute-end)
  20745. (:hour-start . :hour-end)
  20746. (:day-start . :day-end)
  20747. (:month-start . :month-end)
  20748. (:year-start . :year-end))))
  20749. (dolist (p-cell p-alist)
  20750. (org-element-put-property
  20751. split-ts
  20752. (funcall (if end 'car 'cdr) p-cell)
  20753. (org-element-property
  20754. (funcall (if end 'cdr 'car) p-cell) split-ts)))
  20755. ;; Eventually refresh `:raw-value'.
  20756. (org-element-put-property split-ts :raw-value nil)
  20757. (org-element-put-property
  20758. split-ts :raw-value (org-element-interpret-data split-ts)))))))
  20759. (defun org-timestamp-translate (timestamp &optional boundary)
  20760. "Apply `org-translate-time' on a TIMESTAMP object.
  20761. When optional argument BOUNDARY is non-nil, it is either the
  20762. symbol `start' or `end'. In this case, only translate the
  20763. starting or ending part of TIMESTAMP if it is a date or time
  20764. range. Otherwise, translate both parts."
  20765. (if (and (not boundary)
  20766. (memq (org-element-property :type timestamp)
  20767. '(active-range inactive-range)))
  20768. (concat
  20769. (org-translate-time
  20770. (org-element-property :raw-value
  20771. (org-timestamp-split-range timestamp)))
  20772. "--"
  20773. (org-translate-time
  20774. (org-element-property :raw-value
  20775. (org-timestamp-split-range timestamp t))))
  20776. (org-translate-time
  20777. (org-element-property
  20778. :raw-value
  20779. (if (not boundary) timestamp
  20780. (org-timestamp-split-range timestamp (eq boundary 'end)))))))
  20781. ;;; Other stuff.
  20782. (defun org-toggle-fixed-width-section (arg)
  20783. "Toggle the fixed-width export.
  20784. If there is no active region, the QUOTE keyword at the current headline is
  20785. inserted or removed. When present, it causes the text between this headline
  20786. and the next to be exported as fixed-width text, and unmodified.
  20787. If there is an active region, this command adds or removes a colon as the
  20788. first character of this line. If the first character of a line is a colon,
  20789. this line is also exported in fixed-width font."
  20790. (interactive "P")
  20791. (let* ((cc 0)
  20792. (regionp (org-region-active-p))
  20793. (beg (if regionp (region-beginning) (point)))
  20794. (end (if regionp (region-end)))
  20795. (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
  20796. (case-fold-search nil)
  20797. (re "[ \t]*\\(:\\(?: \\|$\\)\\)")
  20798. off)
  20799. (if regionp
  20800. (save-excursion
  20801. (goto-char beg)
  20802. (setq cc (current-column))
  20803. (beginning-of-line 1)
  20804. (setq off (looking-at re))
  20805. (while (> nlines 0)
  20806. (setq nlines (1- nlines))
  20807. (beginning-of-line 1)
  20808. (cond
  20809. (arg
  20810. (org-move-to-column cc t)
  20811. (insert ": \n")
  20812. (forward-line -1))
  20813. ((and off (looking-at re))
  20814. (replace-match "" t t nil 1))
  20815. ((not off) (org-move-to-column cc t) (insert ": ")))
  20816. (forward-line 1)))
  20817. (save-excursion
  20818. (org-back-to-heading)
  20819. (cond
  20820. ((looking-at (format org-heading-keyword-regexp-format
  20821. org-quote-string))
  20822. (goto-char (match-end 1))
  20823. (looking-at (concat " +" org-quote-string))
  20824. (replace-match "" t t)
  20825. (when (eolp) (insert " ")))
  20826. ((looking-at org-outline-regexp)
  20827. (goto-char (match-end 0))
  20828. (insert org-quote-string " ")))))))
  20829. (defun org-reftex-citation ()
  20830. "Use reftex-citation to insert a citation into the buffer.
  20831. This looks for a line like
  20832. #+BIBLIOGRAPHY: foo plain option:-d
  20833. and derives from it that foo.bib is the bibliography file relevant
  20834. for this document. It then installs the necessary environment for RefTeX
  20835. to work in this buffer and calls `reftex-citation' to insert a citation
  20836. into the buffer.
  20837. Export of such citations to both LaTeX and HTML is handled by the contributed
  20838. package ox-bibtex by Taru Karttunen."
  20839. (interactive)
  20840. (let ((reftex-docstruct-symbol 'rds)
  20841. (reftex-cite-format "\\cite{%l}")
  20842. rds bib)
  20843. (save-excursion
  20844. (save-restriction
  20845. (widen)
  20846. (let ((case-fold-search t)
  20847. (re "^#\\+bibliography:[ \t]+\\([^ \t\n]+\\)"))
  20848. (if (not (save-excursion
  20849. (or (re-search-forward re nil t)
  20850. (re-search-backward re nil t))))
  20851. (error "No bibliography defined in file")
  20852. (setq bib (concat (match-string 1) ".bib")
  20853. rds (list (list 'bib bib)))))))
  20854. (call-interactively 'reftex-citation)))
  20855. ;;;; Functions extending outline functionality
  20856. (defun org-beginning-of-line (&optional arg)
  20857. "Go to the beginning of the current line. If that is invisible, continue
  20858. to a visible line beginning. This makes the function of C-a more intuitive.
  20859. If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
  20860. first attempt, and only move to after the tags when the cursor is already
  20861. beyond the end of the headline."
  20862. (interactive "P")
  20863. (let ((pos (point))
  20864. (special (if (consp org-special-ctrl-a/e)
  20865. (car org-special-ctrl-a/e)
  20866. org-special-ctrl-a/e))
  20867. refpos)
  20868. (if (org-bound-and-true-p visual-line-mode)
  20869. (beginning-of-visual-line 1)
  20870. (beginning-of-line 1))
  20871. (if (and arg (fboundp 'move-beginning-of-line))
  20872. (call-interactively 'move-beginning-of-line)
  20873. (if (bobp)
  20874. nil
  20875. (backward-char 1)
  20876. (if (org-truely-invisible-p)
  20877. (while (and (not (bobp)) (org-truely-invisible-p))
  20878. (backward-char 1)
  20879. (beginning-of-line 1))
  20880. (forward-char 1))))
  20881. (when special
  20882. (cond
  20883. ((and (looking-at org-complex-heading-regexp)
  20884. (= (char-after (match-end 1)) ?\ ))
  20885. (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
  20886. (point-at-eol)))
  20887. (goto-char
  20888. (if (eq special t)
  20889. (cond ((> pos refpos) refpos)
  20890. ((= pos (point)) refpos)
  20891. (t (point)))
  20892. (cond ((> pos (point)) (point))
  20893. ((not (eq last-command this-command)) (point))
  20894. (t refpos)))))
  20895. ((org-at-item-p)
  20896. ;; Being at an item and not looking at an the item means point
  20897. ;; was previously moved to beginning of a visual line, which
  20898. ;; doesn't contain the item. Therefore, do nothing special,
  20899. ;; just stay here.
  20900. (when (looking-at org-list-full-item-re)
  20901. ;; Set special position at first white space character after
  20902. ;; bullet, and check-box, if any.
  20903. (let ((after-bullet
  20904. (let ((box (match-end 3)))
  20905. (if (not box) (match-end 1)
  20906. (let ((after (char-after box)))
  20907. (if (and after (= after ? )) (1+ box) box))))))
  20908. ;; Special case: Move point to special position when
  20909. ;; currently after it or at beginning of line.
  20910. (if (eq special t)
  20911. (when (or (> pos after-bullet) (= (point) pos))
  20912. (goto-char after-bullet))
  20913. ;; Reversed case: Move point to special position when
  20914. ;; point was already at beginning of line and command is
  20915. ;; repeated.
  20916. (when (and (= (point) pos) (eq last-command this-command))
  20917. (goto-char after-bullet))))))))
  20918. (org-no-warnings
  20919. (and (featurep 'xemacs) (setq zmacs-region-stays t))))
  20920. (setq disable-point-adjustment
  20921. (or (not (invisible-p (point)))
  20922. (not (invisible-p (max (point-min) (1- (point))))))))
  20923. (defun org-end-of-line (&optional arg)
  20924. "Go to the end of the line.
  20925. If this is a headline, and `org-special-ctrl-a/e' is set, ignore
  20926. tags on the first attempt, and only move to after the tags when
  20927. the cursor is already beyond the end of the headline."
  20928. (interactive "P")
  20929. (let ((special (if (consp org-special-ctrl-a/e) (cdr org-special-ctrl-a/e)
  20930. org-special-ctrl-a/e))
  20931. (move-fun (cond ((org-bound-and-true-p visual-line-mode)
  20932. 'end-of-visual-line)
  20933. ((fboundp 'move-end-of-line) 'move-end-of-line)
  20934. (t 'end-of-line))))
  20935. (if (or (not special) arg) (call-interactively move-fun)
  20936. (let* ((element (save-excursion (beginning-of-line)
  20937. (org-element-at-point)))
  20938. (type (org-element-type element)))
  20939. (cond
  20940. ((memq type '(headline inlinetask))
  20941. (let ((pos (point)))
  20942. (beginning-of-line 1)
  20943. (if (looking-at (org-re ".*?\\(?:\\([ \t]*\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*\\)?$"))
  20944. (if (eq special t)
  20945. (if (or (< pos (match-beginning 1)) (= pos (match-end 0)))
  20946. (goto-char (match-beginning 1))
  20947. (goto-char (match-end 0)))
  20948. (if (or (< pos (match-end 0))
  20949. (not (eq this-command last-command)))
  20950. (goto-char (match-end 0))
  20951. (goto-char (match-beginning 1))))
  20952. (call-interactively move-fun))))
  20953. ((org-element-property :hiddenp element)
  20954. ;; If element is hidden, `move-end-of-line' would put point
  20955. ;; after it. Use `end-of-line' to stay on current line.
  20956. (call-interactively 'end-of-line))
  20957. (t (call-interactively move-fun)))))
  20958. (org-no-warnings (and (featurep 'xemacs) (setq zmacs-region-stays t))))
  20959. (setq disable-point-adjustment
  20960. (or (not (invisible-p (point)))
  20961. (not (invisible-p (max (point-min) (1- (point))))))))
  20962. (define-key org-mode-map "\C-a" 'org-beginning-of-line)
  20963. (define-key org-mode-map "\C-e" 'org-end-of-line)
  20964. (defun org-backward-sentence (&optional arg)
  20965. "Go to beginning of sentence, or beginning of table field.
  20966. This will call `backward-sentence' or `org-table-beginning-of-field',
  20967. depending on context."
  20968. (interactive "P")
  20969. (cond
  20970. ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
  20971. (t (call-interactively 'backward-sentence))))
  20972. (defun org-forward-sentence (&optional arg)
  20973. "Go to end of sentence, or end of table field.
  20974. This will call `forward-sentence' or `org-table-end-of-field',
  20975. depending on context."
  20976. (interactive "P")
  20977. (cond
  20978. ((org-at-table-p) (call-interactively 'org-table-end-of-field))
  20979. (t (call-interactively 'forward-sentence))))
  20980. (define-key org-mode-map "\M-a" 'org-backward-sentence)
  20981. (define-key org-mode-map "\M-e" 'org-forward-sentence)
  20982. (defun org-kill-line (&optional arg)
  20983. "Kill line, to tags or end of line."
  20984. (interactive "P")
  20985. (cond
  20986. ((or (not org-special-ctrl-k)
  20987. (bolp)
  20988. (not (org-at-heading-p)))
  20989. (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
  20990. org-ctrl-k-protect-subtree)
  20991. (if (or (eq org-ctrl-k-protect-subtree 'error)
  20992. (not (y-or-n-p "Kill hidden subtree along with headline? ")))
  20993. (user-error "C-k aborted as it would kill a hidden subtree")))
  20994. (call-interactively
  20995. (if (org-bound-and-true-p visual-line-mode) 'kill-visual-line 'kill-line)))
  20996. ((looking-at (org-re ".*?\\S-\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$"))
  20997. (kill-region (point) (match-beginning 1))
  20998. (org-set-tags nil t))
  20999. (t (kill-region (point) (point-at-eol)))))
  21000. (define-key org-mode-map "\C-k" 'org-kill-line)
  21001. (defun org-yank (&optional arg)
  21002. "Yank. If the kill is a subtree, treat it specially.
  21003. This command will look at the current kill and check if is a single
  21004. subtree, or a series of subtrees[1]. If it passes the test, and if the
  21005. cursor is at the beginning of a line or after the stars of a currently
  21006. empty headline, then the yank is handled specially. How exactly depends
  21007. on the value of the following variables, both set by default.
  21008. org-yank-folded-subtrees
  21009. When set, the subtree(s) will be folded after insertion, but only
  21010. if doing so would now swallow text after the yanked text.
  21011. org-yank-adjusted-subtrees
  21012. When set, the subtree will be promoted or demoted in order to
  21013. fit into the local outline tree structure, which means that the level
  21014. will be adjusted so that it becomes the smaller one of the two
  21015. *visible* surrounding headings.
  21016. Any prefix to this command will cause `yank' to be called directly with
  21017. no special treatment. In particular, a simple \\[universal-argument] prefix \
  21018. will just
  21019. plainly yank the text as it is.
  21020. \[1] The test checks if the first non-white line is a heading
  21021. and if there are no other headings with fewer stars."
  21022. (interactive "P")
  21023. (org-yank-generic 'yank arg))
  21024. (defun org-yank-generic (command arg)
  21025. "Perform some yank-like command.
  21026. This function implements the behavior described in the `org-yank'
  21027. documentation. However, it has been generalized to work for any
  21028. interactive command with similar behavior."
  21029. ;; pretend to be command COMMAND
  21030. (setq this-command command)
  21031. (if arg
  21032. (call-interactively command)
  21033. (let ((subtreep ; is kill a subtree, and the yank position appropriate?
  21034. (and (org-kill-is-subtree-p)
  21035. (or (bolp)
  21036. (and (looking-at "[ \t]*$")
  21037. (string-match
  21038. "\\`\\*+\\'"
  21039. (buffer-substring (point-at-bol) (point)))))))
  21040. swallowp)
  21041. (cond
  21042. ((and subtreep org-yank-folded-subtrees)
  21043. (let ((beg (point))
  21044. end)
  21045. (if (and subtreep org-yank-adjusted-subtrees)
  21046. (org-paste-subtree nil nil 'for-yank)
  21047. (call-interactively command))
  21048. (setq end (point))
  21049. (goto-char beg)
  21050. (when (and (bolp) subtreep
  21051. (not (setq swallowp
  21052. (org-yank-folding-would-swallow-text beg end))))
  21053. (org-with-limited-levels
  21054. (or (looking-at org-outline-regexp)
  21055. (re-search-forward org-outline-regexp-bol end t))
  21056. (while (and (< (point) end) (looking-at org-outline-regexp))
  21057. (hide-subtree)
  21058. (org-cycle-show-empty-lines 'folded)
  21059. (condition-case nil
  21060. (outline-forward-same-level 1)
  21061. (error (goto-char end))))))
  21062. (when swallowp
  21063. (message
  21064. "Inserted text not folded because that would swallow text"))
  21065. (goto-char end)
  21066. (skip-chars-forward " \t\n\r")
  21067. (beginning-of-line 1)
  21068. (push-mark beg 'nomsg)))
  21069. ((and subtreep org-yank-adjusted-subtrees)
  21070. (let ((beg (point-at-bol)))
  21071. (org-paste-subtree nil nil 'for-yank)
  21072. (push-mark beg 'nomsg)))
  21073. (t
  21074. (call-interactively command))))))
  21075. (defun org-yank-folding-would-swallow-text (beg end)
  21076. "Would hide-subtree at BEG swallow any text after END?"
  21077. (let (level)
  21078. (org-with-limited-levels
  21079. (save-excursion
  21080. (goto-char beg)
  21081. (when (or (looking-at org-outline-regexp)
  21082. (re-search-forward org-outline-regexp-bol end t))
  21083. (setq level (org-outline-level)))
  21084. (goto-char end)
  21085. (skip-chars-forward " \t\r\n\v\f")
  21086. (if (or (eobp)
  21087. (and (bolp) (looking-at org-outline-regexp)
  21088. (<= (org-outline-level) level)))
  21089. nil ; Nothing would be swallowed
  21090. t))))) ; something would swallow
  21091. (define-key org-mode-map "\C-y" 'org-yank)
  21092. (defun org-truely-invisible-p ()
  21093. "Check if point is at a character currently not visible.
  21094. This version does not only check the character property, but also
  21095. `visible-mode'."
  21096. ;; Early versions of noutline don't have `outline-invisible-p'.
  21097. (if (org-bound-and-true-p visible-mode)
  21098. nil
  21099. (outline-invisible-p)))
  21100. (defun org-invisible-p2 ()
  21101. "Check if point is at a character currently not visible."
  21102. (save-excursion
  21103. (if (and (eolp) (not (bobp))) (backward-char 1))
  21104. ;; Early versions of noutline don't have `outline-invisible-p'.
  21105. (outline-invisible-p)))
  21106. (defun org-back-to-heading (&optional invisible-ok)
  21107. "Call `outline-back-to-heading', but provide a better error message."
  21108. (condition-case nil
  21109. (outline-back-to-heading invisible-ok)
  21110. (error (error "Before first headline at position %d in buffer %s"
  21111. (point) (current-buffer)))))
  21112. (defun org-before-first-heading-p ()
  21113. "Before first heading?"
  21114. (save-excursion
  21115. (end-of-line)
  21116. (null (re-search-backward org-outline-regexp-bol nil t))))
  21117. (defun org-at-heading-p (&optional ignored)
  21118. (outline-on-heading-p t))
  21119. ;; Compatibility alias with Org versions < 7.8.03
  21120. (defalias 'org-on-heading-p 'org-at-heading-p)
  21121. (defun org-at-comment-p nil
  21122. "Is cursor in a line starting with a # character?"
  21123. (save-excursion
  21124. (beginning-of-line)
  21125. (looking-at "^#")))
  21126. (defun org-at-drawer-p nil
  21127. "Is cursor at a drawer keyword?"
  21128. (save-excursion
  21129. (move-beginning-of-line 1)
  21130. (looking-at org-drawer-regexp)))
  21131. (defun org-at-block-p nil
  21132. "Is cursor at a block keyword?"
  21133. (save-excursion
  21134. (move-beginning-of-line 1)
  21135. (looking-at org-block-regexp)))
  21136. (defun org-point-at-end-of-empty-headline ()
  21137. "If point is at the end of an empty headline, return t, else nil.
  21138. If the heading only contains a TODO keyword, it is still still considered
  21139. empty."
  21140. (and (looking-at "[ \t]*$")
  21141. (when org-todo-line-regexp
  21142. (save-excursion
  21143. (beginning-of-line 1)
  21144. (let ((case-fold-search nil))
  21145. (looking-at org-todo-line-regexp)
  21146. (string= (match-string 3) ""))))))
  21147. (defun org-at-heading-or-item-p ()
  21148. (or (org-at-heading-p) (org-at-item-p)))
  21149. (defun org-at-target-p ()
  21150. (or (org-in-regexp org-radio-target-regexp)
  21151. (org-in-regexp org-target-regexp)))
  21152. ;; Compatibility alias with Org versions < 7.8.03
  21153. (defalias 'org-on-target-p 'org-at-target-p)
  21154. (defun org-up-heading-all (arg)
  21155. "Move to the heading line of which the present line is a subheading.
  21156. This function considers both visible and invisible heading lines.
  21157. With argument, move up ARG levels."
  21158. (if (fboundp 'outline-up-heading-all)
  21159. (outline-up-heading-all arg) ; emacs 21 version of outline.el
  21160. (outline-up-heading arg t))) ; emacs 22 version of outline.el
  21161. (defun org-up-heading-safe ()
  21162. "Move to the heading line of which the present line is a subheading.
  21163. This version will not throw an error. It will return the level of the
  21164. headline found, or nil if no higher level is found.
  21165. Also, this function will be a lot faster than `outline-up-heading',
  21166. because it relies on stars being the outline starters. This can really
  21167. make a significant difference in outlines with very many siblings."
  21168. (let (start-level re)
  21169. (org-back-to-heading t)
  21170. (setq start-level (funcall outline-level))
  21171. (if (equal start-level 1)
  21172. nil
  21173. (setq re (concat "^\\*\\{1," (number-to-string (1- start-level)) "\\} "))
  21174. (if (re-search-backward re nil t)
  21175. (funcall outline-level)))))
  21176. (defun org-first-sibling-p ()
  21177. "Is this heading the first child of its parents?"
  21178. (interactive)
  21179. (let ((re org-outline-regexp-bol)
  21180. level l)
  21181. (unless (org-at-heading-p t)
  21182. (user-error "Not at a heading"))
  21183. (setq level (funcall outline-level))
  21184. (save-excursion
  21185. (if (not (re-search-backward re nil t))
  21186. t
  21187. (setq l (funcall outline-level))
  21188. (< l level)))))
  21189. (defun org-goto-sibling (&optional previous)
  21190. "Goto the next sibling, even if it is invisible.
  21191. When PREVIOUS is set, go to the previous sibling instead. Returns t
  21192. when a sibling was found. When none is found, return nil and don't
  21193. move point."
  21194. (let ((fun (if previous 're-search-backward 're-search-forward))
  21195. (pos (point))
  21196. (re org-outline-regexp-bol)
  21197. level l)
  21198. (when (condition-case nil (org-back-to-heading t) (error nil))
  21199. (setq level (funcall outline-level))
  21200. (catch 'exit
  21201. (or previous (forward-char 1))
  21202. (while (funcall fun re nil t)
  21203. (setq l (funcall outline-level))
  21204. (when (< l level) (goto-char pos) (throw 'exit nil))
  21205. (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
  21206. (goto-char pos)
  21207. nil))))
  21208. (defun org-show-siblings ()
  21209. "Show all siblings of the current headline."
  21210. (save-excursion
  21211. (while (org-goto-sibling) (org-flag-heading nil)))
  21212. (save-excursion
  21213. (while (org-goto-sibling 'previous)
  21214. (org-flag-heading nil))))
  21215. (defun org-goto-first-child ()
  21216. "Goto the first child, even if it is invisible.
  21217. Return t when a child was found. Otherwise don't move point and
  21218. return nil."
  21219. (let (level (pos (point)) (re org-outline-regexp-bol))
  21220. (when (condition-case nil (org-back-to-heading t) (error nil))
  21221. (setq level (outline-level))
  21222. (forward-char 1)
  21223. (if (and (re-search-forward re nil t) (> (outline-level) level))
  21224. (progn (goto-char (match-beginning 0)) t)
  21225. (goto-char pos) nil))))
  21226. (defun org-show-hidden-entry ()
  21227. "Show an entry where even the heading is hidden."
  21228. (save-excursion
  21229. (org-show-entry)))
  21230. (defun org-flag-heading (flag &optional entry)
  21231. "Flag the current heading. FLAG non-nil means make invisible.
  21232. When ENTRY is non-nil, show the entire entry."
  21233. (save-excursion
  21234. (org-back-to-heading t)
  21235. ;; Check if we should show the entire entry
  21236. (if entry
  21237. (progn
  21238. (org-show-entry)
  21239. (save-excursion
  21240. (and (outline-next-heading)
  21241. (org-flag-heading nil))))
  21242. (outline-flag-region (max (point-min) (1- (point)))
  21243. (save-excursion (outline-end-of-heading) (point))
  21244. flag))))
  21245. (defun org-get-next-sibling ()
  21246. "Move to next heading of the same level, and return point.
  21247. If there is no such heading, return nil.
  21248. This is like outline-next-sibling, but invisible headings are ok."
  21249. (let ((level (funcall outline-level)))
  21250. (outline-next-heading)
  21251. (while (and (not (eobp)) (> (funcall outline-level) level))
  21252. (outline-next-heading))
  21253. (if (or (eobp) (< (funcall outline-level) level))
  21254. nil
  21255. (point))))
  21256. (defun org-get-last-sibling ()
  21257. "Move to previous heading of the same level, and return point.
  21258. If there is no such heading, return nil."
  21259. (let ((opoint (point))
  21260. (level (funcall outline-level)))
  21261. (outline-previous-heading)
  21262. (when (and (/= (point) opoint) (outline-on-heading-p t))
  21263. (while (and (> (funcall outline-level) level)
  21264. (not (bobp)))
  21265. (outline-previous-heading))
  21266. (if (< (funcall outline-level) level)
  21267. nil
  21268. (point)))))
  21269. (defun org-end-of-subtree (&optional invisible-ok to-heading)
  21270. "Goto to the end of a subtree."
  21271. ;; This contains an exact copy of the original function, but it uses
  21272. ;; `org-back-to-heading', to make it work also in invisible
  21273. ;; trees. And is uses an invisible-ok argument.
  21274. ;; Under Emacs this is not needed, but the old outline.el needs this fix.
  21275. ;; Furthermore, when used inside Org, finding the end of a large subtree
  21276. ;; with many children and grandchildren etc, this can be much faster
  21277. ;; than the outline version.
  21278. (org-back-to-heading invisible-ok)
  21279. (let ((first t)
  21280. (level (funcall outline-level)))
  21281. (if (and (derived-mode-p 'org-mode) (< level 1000))
  21282. ;; A true heading (not a plain list item), in Org-mode
  21283. ;; This means we can easily find the end by looking
  21284. ;; only for the right number of stars. Using a regexp to do
  21285. ;; this is so much faster than using a Lisp loop.
  21286. (let ((re (concat "^\\*\\{1," (int-to-string level) "\\} ")))
  21287. (forward-char 1)
  21288. (and (re-search-forward re nil 'move) (beginning-of-line 1)))
  21289. ;; something else, do it the slow way
  21290. (while (and (not (eobp))
  21291. (or first (> (funcall outline-level) level)))
  21292. (setq first nil)
  21293. (outline-next-heading)))
  21294. (unless to-heading
  21295. (if (memq (preceding-char) '(?\n ?\^M))
  21296. (progn
  21297. ;; Go to end of line before heading
  21298. (forward-char -1)
  21299. (if (memq (preceding-char) '(?\n ?\^M))
  21300. ;; leave blank line before heading
  21301. (forward-char -1))))))
  21302. (point))
  21303. (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
  21304. "Use Org version in org-mode, for dramatic speed-up."
  21305. (if (derived-mode-p 'org-mode)
  21306. (progn
  21307. (org-end-of-subtree nil t)
  21308. (unless (eobp) (backward-char 1)))
  21309. ad-do-it))
  21310. (defun org-end-of-meta-data-and-drawers ()
  21311. "Jump to the first text after meta data and drawers in the current entry.
  21312. This will move over empty lines, lines with planning time stamps,
  21313. clocking lines, and drawers."
  21314. (org-back-to-heading t)
  21315. (let ((end (save-excursion (outline-next-heading) (point)))
  21316. (re (concat "\\(" org-drawer-regexp "\\)"
  21317. "\\|" "[ \t]*" org-keyword-time-regexp)))
  21318. (forward-line 1)
  21319. (while (re-search-forward re end t)
  21320. (if (not (match-end 1))
  21321. ;; empty or planning line
  21322. (forward-line 1)
  21323. ;; a drawer, find the end
  21324. (re-search-forward "^[ \t]*:END:" end 'move)
  21325. (forward-line 1)))
  21326. (and (re-search-forward "[^\n]" nil t) (backward-char 1))
  21327. (point)))
  21328. (defun org-forward-heading-same-level (arg &optional invisible-ok)
  21329. "Move forward to the ARG'th subheading at same level as this one.
  21330. Stop at the first and last subheadings of a superior heading.
  21331. Normally this only looks at visible headings, but when INVISIBLE-OK is
  21332. non-nil it will also look at invisible ones."
  21333. (interactive "p")
  21334. (if (not (ignore-errors (org-back-to-heading invisible-ok)))
  21335. (if (and arg (< arg 0))
  21336. (goto-char (point-min))
  21337. (outline-next-heading))
  21338. (org-at-heading-p)
  21339. (let ((level (- (match-end 0) (match-beginning 0) 1))
  21340. (f (if (and arg (< arg 0))
  21341. 're-search-backward
  21342. 're-search-forward))
  21343. (count (if arg (abs arg) 1))
  21344. (result (point)))
  21345. (while (and (prog1 (> count 0)
  21346. (forward-char (if (and arg (< arg 0)) -1 1)))
  21347. (funcall f org-outline-regexp-bol nil 'move))
  21348. (let ((l (- (match-end 0) (match-beginning 0) 1)))
  21349. (cond ((< l level) (setq count 0))
  21350. ((and (= l level)
  21351. (or invisible-ok
  21352. (progn
  21353. (goto-char (line-beginning-position))
  21354. (not (outline-invisible-p)))))
  21355. (setq count (1- count))
  21356. (when (eq l level)
  21357. (setq result (point)))))))
  21358. (goto-char result))
  21359. (beginning-of-line 1)))
  21360. (defun org-backward-heading-same-level (arg &optional invisible-ok)
  21361. "Move backward to the ARG'th subheading at same level as this one.
  21362. Stop at the first and last subheadings of a superior heading."
  21363. (interactive "p")
  21364. (org-forward-heading-same-level (if arg (- arg) -1) invisible-ok))
  21365. (defun org-next-block (arg &optional backward block-regexp)
  21366. "Jump to the next block.
  21367. With a prefix argument ARG, jump forward ARG many source blocks.
  21368. When BACKWARD is non-nil, jump to the previous block.
  21369. When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
  21370. (interactive "p")
  21371. (let ((re (or block-regexp org-block-regexp))
  21372. (re-search-fn (or (and backward 're-search-backward)
  21373. 're-search-forward)))
  21374. (if (looking-at re) (forward-char 1))
  21375. (condition-case nil
  21376. (funcall re-search-fn re nil nil arg)
  21377. (error (error "No %s code blocks" (if backward "previous" "further" ))))
  21378. (goto-char (match-beginning 0)) (org-show-context)))
  21379. (defun org-previous-block (arg &optional block-regexp)
  21380. "Jump to the previous block.
  21381. With a prefix argument ARG, jump backward ARG many source blocks.
  21382. When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
  21383. (interactive "p")
  21384. (org-next-block arg t block-regexp))
  21385. (defun org-forward-element ()
  21386. "Move forward by one element.
  21387. Move to the next element at the same level, when possible."
  21388. (interactive)
  21389. (cond ((eobp) (user-error "Cannot move further down"))
  21390. ((org-with-limited-levels (org-at-heading-p))
  21391. (let ((origin (point)))
  21392. (goto-char (org-end-of-subtree nil t))
  21393. (unless (org-with-limited-levels (org-at-heading-p))
  21394. (goto-char origin)
  21395. (user-error "Cannot move further down"))))
  21396. (t
  21397. (let* ((elem (org-element-at-point))
  21398. (end (org-element-property :end elem))
  21399. (parent (org-element-property :parent elem)))
  21400. (cond ((and parent (= (org-element-property :contents-end parent) end))
  21401. (goto-char (org-element-property :end parent)))
  21402. ((integer-or-marker-p end) (goto-char end))
  21403. (t (message "No element at point")))))))
  21404. (defun org-backward-element ()
  21405. "Move backward by one element.
  21406. Move to the previous element at the same level, when possible."
  21407. (interactive)
  21408. (cond ((bobp) (user-error "Cannot move further up"))
  21409. ((org-with-limited-levels (org-at-heading-p))
  21410. ;; At a headline, move to the previous one, if any, or stay
  21411. ;; here.
  21412. (let ((origin (point)))
  21413. (org-with-limited-levels (org-backward-heading-same-level 1))
  21414. ;; When current headline has no sibling above, move to its
  21415. ;; parent.
  21416. (when (= (point) origin)
  21417. (or (org-with-limited-levels (org-up-heading-safe))
  21418. (progn (goto-char origin)
  21419. (user-error "Cannot move further up"))))))
  21420. (t
  21421. (let* ((trail (org-element-at-point 'keep-trail))
  21422. (elem (car trail))
  21423. (prev-elem (nth 1 trail))
  21424. (beg (org-element-property :begin elem)))
  21425. (cond
  21426. ;; Move to beginning of current element if point isn't
  21427. ;; there already.
  21428. ((null beg) (message "No element at point"))
  21429. ((/= (point) beg) (goto-char beg))
  21430. (prev-elem (goto-char (org-element-property :begin prev-elem)))
  21431. ((org-before-first-heading-p) (goto-char (point-min)))
  21432. (t (org-back-to-heading)))))))
  21433. (defun org-up-element ()
  21434. "Move to upper element."
  21435. (interactive)
  21436. (if (org-with-limited-levels (org-at-heading-p))
  21437. (unless (org-up-heading-safe) (user-error "No surrounding element"))
  21438. (let* ((elem (org-element-at-point))
  21439. (parent (org-element-property :parent elem)))
  21440. (if parent (goto-char (org-element-property :begin parent))
  21441. (if (org-with-limited-levels (org-before-first-heading-p))
  21442. (user-error "No surrounding element")
  21443. (org-with-limited-levels (org-back-to-heading)))))))
  21444. (defvar org-element-greater-elements)
  21445. (defun org-down-element ()
  21446. "Move to inner element."
  21447. (interactive)
  21448. (let ((element (org-element-at-point)))
  21449. (cond
  21450. ((memq (org-element-type element) '(plain-list table))
  21451. (goto-char (org-element-property :contents-begin element))
  21452. (forward-char))
  21453. ((memq (org-element-type element) org-element-greater-elements)
  21454. ;; If contents are hidden, first disclose them.
  21455. (when (org-element-property :hiddenp element) (org-cycle))
  21456. (goto-char (or (org-element-property :contents-begin element)
  21457. (user-error "No content for this element"))))
  21458. (t (user-error "No inner element")))))
  21459. (defun org-drag-element-backward ()
  21460. "Move backward element at point."
  21461. (interactive)
  21462. (if (org-with-limited-levels (org-at-heading-p)) (org-move-subtree-up)
  21463. (let* ((trail (org-element-at-point 'keep-trail))
  21464. (elem (car trail))
  21465. (prev-elem (nth 1 trail)))
  21466. ;; Error out if no previous element or previous element is
  21467. ;; a parent of the current one.
  21468. (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
  21469. (user-error "Cannot drag element backward")
  21470. (let ((pos (point)))
  21471. (org-element-swap-A-B prev-elem elem)
  21472. (goto-char (+ (org-element-property :begin prev-elem)
  21473. (- pos (org-element-property :begin elem)))))))))
  21474. (defun org-drag-element-forward ()
  21475. "Move forward element at point."
  21476. (interactive)
  21477. (let* ((pos (point))
  21478. (elem (org-element-at-point)))
  21479. (when (= (point-max) (org-element-property :end elem))
  21480. (user-error "Cannot drag element forward"))
  21481. (goto-char (org-element-property :end elem))
  21482. (let ((next-elem (org-element-at-point)))
  21483. (when (or (org-element-nested-p elem next-elem)
  21484. (and (eq (org-element-type next-elem) 'headline)
  21485. (not (eq (org-element-type elem) 'headline))))
  21486. (goto-char pos)
  21487. (user-error "Cannot drag element forward"))
  21488. ;; Compute new position of point: it's shifted by NEXT-ELEM
  21489. ;; body's length (without final blanks) and by the length of
  21490. ;; blanks between ELEM and NEXT-ELEM.
  21491. (let ((size-next (- (save-excursion
  21492. (goto-char (org-element-property :end next-elem))
  21493. (skip-chars-backward " \r\t\n")
  21494. (forward-line)
  21495. ;; Small correction if buffer doesn't end
  21496. ;; with a newline character.
  21497. (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
  21498. (org-element-property :begin next-elem)))
  21499. (size-blank (- (org-element-property :end elem)
  21500. (save-excursion
  21501. (goto-char (org-element-property :end elem))
  21502. (skip-chars-backward " \r\t\n")
  21503. (forward-line)
  21504. (point)))))
  21505. (org-element-swap-A-B elem next-elem)
  21506. (goto-char (+ pos size-next size-blank))))))
  21507. (defun org-drag-line-forward (arg)
  21508. "Drag the line at point ARG lines forward."
  21509. (interactive "p")
  21510. (dotimes (n (abs arg))
  21511. (let ((c (current-column)))
  21512. (if (< 0 arg)
  21513. (progn
  21514. (beginning-of-line 2)
  21515. (transpose-lines 1)
  21516. (beginning-of-line 0))
  21517. (transpose-lines 1)
  21518. (beginning-of-line -1))
  21519. (org-move-to-column c))))
  21520. (defun org-drag-line-backward (arg)
  21521. "Drag the line at point ARG lines backward."
  21522. (interactive "p")
  21523. (org-drag-line-forward (- arg)))
  21524. (defun org-mark-element ()
  21525. "Put point at beginning of this element, mark at end.
  21526. Interactively, if this command is repeated or (in Transient Mark
  21527. mode) if the mark is active, it marks the next element after the
  21528. ones already marked."
  21529. (interactive)
  21530. (let (deactivate-mark)
  21531. (if (and (org-called-interactively-p 'any)
  21532. (or (and (eq last-command this-command) (mark t))
  21533. (and transient-mark-mode mark-active)))
  21534. (set-mark
  21535. (save-excursion
  21536. (goto-char (mark))
  21537. (goto-char (org-element-property :end (org-element-at-point)))))
  21538. (let ((element (org-element-at-point)))
  21539. (end-of-line)
  21540. (push-mark (org-element-property :end element) t t)
  21541. (goto-char (org-element-property :begin element))))))
  21542. (defun org-narrow-to-element ()
  21543. "Narrow buffer to current element."
  21544. (interactive)
  21545. (let ((elem (org-element-at-point)))
  21546. (cond
  21547. ((eq (car elem) 'headline)
  21548. (narrow-to-region
  21549. (org-element-property :begin elem)
  21550. (org-element-property :end elem)))
  21551. ((memq (car elem) org-element-greater-elements)
  21552. (narrow-to-region
  21553. (org-element-property :contents-begin elem)
  21554. (org-element-property :contents-end elem)))
  21555. (t
  21556. (narrow-to-region
  21557. (org-element-property :begin elem)
  21558. (org-element-property :end elem))))))
  21559. (defun org-transpose-element ()
  21560. "Transpose current and previous elements, keeping blank lines between.
  21561. Point is moved after both elements."
  21562. (interactive)
  21563. (org-skip-whitespace)
  21564. (let ((end (org-element-property :end (org-element-at-point))))
  21565. (org-drag-element-backward)
  21566. (goto-char end)))
  21567. (defun org-unindent-buffer ()
  21568. "Un-indent the visible part of the buffer.
  21569. Relative indentation (between items, inside blocks, etc.) isn't
  21570. modified."
  21571. (interactive)
  21572. (unless (eq major-mode 'org-mode)
  21573. (user-error "Cannot un-indent a buffer not in Org mode"))
  21574. (let* ((parse-tree (org-element-parse-buffer 'greater-element))
  21575. unindent-tree ; For byte-compiler.
  21576. (unindent-tree
  21577. (function
  21578. (lambda (contents)
  21579. (mapc
  21580. (lambda (element)
  21581. (if (memq (org-element-type element) '(headline section))
  21582. (funcall unindent-tree (org-element-contents element))
  21583. (save-excursion
  21584. (save-restriction
  21585. (narrow-to-region
  21586. (org-element-property :begin element)
  21587. (org-element-property :end element))
  21588. (org-do-remove-indentation)))))
  21589. (reverse contents))))))
  21590. (funcall unindent-tree (org-element-contents parse-tree))))
  21591. (defun org-show-subtree ()
  21592. "Show everything after this heading at deeper levels."
  21593. (interactive)
  21594. (outline-flag-region
  21595. (point)
  21596. (save-excursion
  21597. (org-end-of-subtree t t))
  21598. nil))
  21599. (defun org-show-entry ()
  21600. "Show the body directly following this heading.
  21601. Show the heading too, if it is currently invisible."
  21602. (interactive)
  21603. (save-excursion
  21604. (condition-case nil
  21605. (progn
  21606. (org-back-to-heading t)
  21607. (outline-flag-region
  21608. (max (point-min) (1- (point)))
  21609. (save-excursion
  21610. (if (re-search-forward
  21611. (concat "[\r\n]\\(" org-outline-regexp "\\)") nil t)
  21612. (match-beginning 1)
  21613. (point-max)))
  21614. nil)
  21615. (org-cycle-hide-drawers 'children))
  21616. (error nil))))
  21617. (defun org-make-options-regexp (kwds &optional extra)
  21618. "Make a regular expression for keyword lines."
  21619. (concat
  21620. "^#\\+\\("
  21621. (mapconcat 'regexp-quote kwds "\\|")
  21622. (if extra (concat "\\|" extra))
  21623. "\\):[ \t]*\\(.*\\)"))
  21624. ;; Make isearch reveal the necessary context
  21625. (defun org-isearch-end ()
  21626. "Reveal context after isearch exits."
  21627. (when isearch-success ; only if search was successful
  21628. (if (featurep 'xemacs)
  21629. ;; Under XEmacs, the hook is run in the correct place,
  21630. ;; we directly show the context.
  21631. (org-show-context 'isearch)
  21632. ;; In Emacs the hook runs *before* restoring the overlays.
  21633. ;; So we have to use a one-time post-command-hook to do this.
  21634. ;; (Emacs 22 has a special variable, see function `org-mode')
  21635. (unless (and (boundp 'isearch-mode-end-hook-quit)
  21636. isearch-mode-end-hook-quit)
  21637. ;; Only when the isearch was not quitted.
  21638. (org-add-hook 'post-command-hook 'org-isearch-post-command
  21639. 'append 'local)))
  21640. (org-fix-ellipsis-at-bol)))
  21641. (defun org-isearch-post-command ()
  21642. "Remove self from hook, and show context."
  21643. (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
  21644. (org-show-context 'isearch))
  21645. ;;;; Integration with and fixes for other packages
  21646. ;;; Imenu support
  21647. (defvar org-imenu-markers nil
  21648. "All markers currently used by Imenu.")
  21649. (make-variable-buffer-local 'org-imenu-markers)
  21650. (defun org-imenu-new-marker (&optional pos)
  21651. "Return a new marker for use by Imenu, and remember the marker."
  21652. (let ((m (make-marker)))
  21653. (move-marker m (or pos (point)))
  21654. (push m org-imenu-markers)
  21655. m))
  21656. (defun org-imenu-get-tree ()
  21657. "Produce the index for Imenu."
  21658. (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
  21659. (setq org-imenu-markers nil)
  21660. (let* ((n org-imenu-depth)
  21661. (re (concat "^" (org-get-limited-outline-regexp)))
  21662. (subs (make-vector (1+ n) nil))
  21663. (last-level 0)
  21664. m level head0 head)
  21665. (save-excursion
  21666. (save-restriction
  21667. (widen)
  21668. (goto-char (point-max))
  21669. (while (re-search-backward re nil t)
  21670. (setq level (org-reduced-level (funcall outline-level)))
  21671. (when (and (<= level n)
  21672. (looking-at org-complex-heading-regexp)
  21673. (setq head0 (org-match-string-no-properties 4)))
  21674. (setq head (org-link-display-format head0)
  21675. m (org-imenu-new-marker))
  21676. (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
  21677. (if (>= level last-level)
  21678. (push (cons head m) (aref subs level))
  21679. (push (cons head (aref subs (1+ level))) (aref subs level))
  21680. (loop for i from (1+ level) to n do (aset subs i nil)))
  21681. (setq last-level level)))))
  21682. (aref subs 1)))
  21683. (eval-after-load "imenu"
  21684. '(progn
  21685. (add-hook 'imenu-after-jump-hook
  21686. (lambda ()
  21687. (if (derived-mode-p 'org-mode)
  21688. (org-show-context 'org-goto))))))
  21689. (defun org-link-display-format (link)
  21690. "Replace a link with its the description.
  21691. If there is no description, use the link target."
  21692. (save-match-data
  21693. (if (string-match org-bracket-link-analytic-regexp link)
  21694. (replace-match (if (match-end 5)
  21695. (match-string 5 link)
  21696. (concat (match-string 1 link)
  21697. (match-string 3 link)))
  21698. nil t link)
  21699. link)))
  21700. (defun org-toggle-link-display ()
  21701. "Toggle the literal or descriptive display of links."
  21702. (interactive)
  21703. (if org-descriptive-links
  21704. (progn (org-remove-from-invisibility-spec '(org-link))
  21705. (org-restart-font-lock)
  21706. (setq org-descriptive-links nil))
  21707. (progn (add-to-invisibility-spec '(org-link))
  21708. (org-restart-font-lock)
  21709. (setq org-descriptive-links t))))
  21710. ;; Speedbar support
  21711. (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
  21712. "Overlay marking the agenda restriction line in speedbar.")
  21713. (overlay-put org-speedbar-restriction-lock-overlay
  21714. 'face 'org-agenda-restriction-lock)
  21715. (overlay-put org-speedbar-restriction-lock-overlay
  21716. 'help-echo "Agendas are currently limited to this item.")
  21717. (org-detach-overlay org-speedbar-restriction-lock-overlay)
  21718. (defun org-speedbar-set-agenda-restriction ()
  21719. "Restrict future agenda commands to the location at point in speedbar.
  21720. To get rid of the restriction, use \\[org-agenda-remove-restriction-lock]."
  21721. (interactive)
  21722. (require 'org-agenda)
  21723. (let (p m tp np dir txt)
  21724. (cond
  21725. ((setq p (text-property-any (point-at-bol) (point-at-eol)
  21726. 'org-imenu t))
  21727. (setq m (get-text-property p 'org-imenu-marker))
  21728. (with-current-buffer (marker-buffer m)
  21729. (goto-char m)
  21730. (org-agenda-set-restriction-lock 'subtree)))
  21731. ((setq p (text-property-any (point-at-bol) (point-at-eol)
  21732. 'speedbar-function 'speedbar-find-file))
  21733. (setq tp (previous-single-property-change
  21734. (1+ p) 'speedbar-function)
  21735. np (next-single-property-change
  21736. tp 'speedbar-function)
  21737. dir (speedbar-line-directory)
  21738. txt (buffer-substring-no-properties (or tp (point-min))
  21739. (or np (point-max))))
  21740. (with-current-buffer (find-file-noselect
  21741. (let ((default-directory dir))
  21742. (expand-file-name txt)))
  21743. (unless (derived-mode-p 'org-mode)
  21744. (user-error "Cannot restrict to non-Org-mode file"))
  21745. (org-agenda-set-restriction-lock 'file)))
  21746. (t (user-error "Don't know how to restrict Org-mode's agenda")))
  21747. (move-overlay org-speedbar-restriction-lock-overlay
  21748. (point-at-bol) (point-at-eol))
  21749. (setq current-prefix-arg nil)
  21750. (org-agenda-maybe-redo)))
  21751. (defvar speedbar-file-key-map)
  21752. (declare-function speedbar-add-supported-extension "speedbar" (extension))
  21753. (eval-after-load "speedbar"
  21754. '(progn
  21755. (speedbar-add-supported-extension ".org")
  21756. (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
  21757. (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
  21758. (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
  21759. (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
  21760. (add-hook 'speedbar-visiting-tag-hook
  21761. (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
  21762. ;;; Fixes and Hacks for problems with other packages
  21763. ;; Make flyspell not check words in links, to not mess up our keymap
  21764. (defvar org-element-affiliated-keywords) ; From org-element.el
  21765. (defvar org-element-block-name-alist) ; From org-element.el
  21766. (defun org-mode-flyspell-verify ()
  21767. "Don't let flyspell put overlays at active buttons, or on
  21768. {todo,all-time,additional-option-like}-keywords."
  21769. (require 'org-element) ; For `org-element-affiliated-keywords'
  21770. (let ((pos (max (1- (point)) (point-min)))
  21771. (word (thing-at-point 'word)))
  21772. (and (not (get-text-property pos 'keymap))
  21773. (not (get-text-property pos 'org-no-flyspell))
  21774. (not (member word org-todo-keywords-1))
  21775. (not (member word org-all-time-keywords))
  21776. (not (member word org-options-keywords))
  21777. (not (member word (mapcar 'car org-startup-options)))
  21778. (not (member-ignore-case word org-element-affiliated-keywords))
  21779. (not (member-ignore-case word (org-get-export-keywords)))
  21780. (not (member-ignore-case
  21781. word (mapcar 'car org-element-block-name-alist)))
  21782. (not (member-ignore-case word '("BEGIN" "END" "ATTR")))
  21783. (not (org-in-src-block-p)))))
  21784. (defun org-remove-flyspell-overlays-in (beg end)
  21785. "Remove flyspell overlays in region."
  21786. (and (org-bound-and-true-p flyspell-mode)
  21787. (fboundp 'flyspell-delete-region-overlays)
  21788. (flyspell-delete-region-overlays beg end))
  21789. (add-text-properties beg end '(org-no-flyspell t)))
  21790. ;; Make `bookmark-jump' shows the jump location if it was hidden.
  21791. (eval-after-load "bookmark"
  21792. '(if (boundp 'bookmark-after-jump-hook)
  21793. ;; We can use the hook
  21794. (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
  21795. ;; Hook not available, use advice
  21796. (defadvice bookmark-jump (after org-make-visible activate)
  21797. "Make the position visible."
  21798. (org-bookmark-jump-unhide))))
  21799. ;; Make sure saveplace shows the location if it was hidden
  21800. (eval-after-load "saveplace"
  21801. '(defadvice save-place-find-file-hook (after org-make-visible activate)
  21802. "Make the position visible."
  21803. (org-bookmark-jump-unhide)))
  21804. ;; Make sure ecb shows the location if it was hidden
  21805. (eval-after-load "ecb"
  21806. '(defadvice ecb-method-clicked (after esf/org-show-context activate)
  21807. "Make hierarchy visible when jumping into location from ECB tree buffer."
  21808. (if (derived-mode-p 'org-mode)
  21809. (org-show-context))))
  21810. (defun org-bookmark-jump-unhide ()
  21811. "Unhide the current position, to show the bookmark location."
  21812. (and (derived-mode-p 'org-mode)
  21813. (or (outline-invisible-p)
  21814. (save-excursion (goto-char (max (point-min) (1- (point))))
  21815. (outline-invisible-p)))
  21816. (org-show-context 'bookmark-jump)))
  21817. ;; Make session.el ignore our circular variable
  21818. (defvar session-globals-exclude)
  21819. (eval-after-load "session"
  21820. '(add-to-list 'session-globals-exclude 'org-mark-ring))
  21821. ;;;; Finish up
  21822. (provide 'org)
  21823. (run-hooks 'org-load-hook)
  21824. ;;; org.el ends here