org.el 906 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589125901259112592125931259412595125961259712598125991260012601126021260312604126051260612607126081260912610126111261212613126141261512616126171261812619126201262112622126231262412625126261262712628126291263012631126321263312634126351263612637126381263912640126411264212643126441264512646126471264812649126501265112652126531265412655126561265712658126591266012661126621266312664126651266612667126681266912670126711267212673126741267512676126771267812679126801268112682126831268412685126861268712688126891269012691126921269312694126951269612697126981269912700127011270212703127041270512706127071270812709127101271112712127131271412715127161271712718127191272012721127221272312724127251272612727127281272912730127311273212733127341273512736127371273812739127401274112742127431274412745127461274712748127491275012751127521275312754127551275612757127581275912760127611276212763127641276512766127671276812769127701277112772127731277412775127761277712778127791278012781127821278312784127851278612787127881278912790127911279212793127941279512796127971279812799128001280112802128031280412805128061280712808128091281012811128121281312814128151281612817128181281912820128211282212823128241282512826128271282812829128301283112832128331283412835128361283712838128391284012841128421284312844128451284612847128481284912850128511285212853128541285512856128571285812859128601286112862128631286412865128661286712868128691287012871128721287312874128751287612877128781287912880128811288212883128841288512886128871288812889128901289112892128931289412895128961289712898128991290012901129021290312904129051290612907129081290912910129111291212913129141291512916129171291812919129201292112922129231292412925129261292712928129291293012931129321293312934129351293612937129381293912940129411294212943129441294512946129471294812949129501295112952129531295412955129561295712958129591296012961129621296312964129651296612967129681296912970129711297212973129741297512976129771297812979129801298112982129831298412985129861298712988129891299012991129921299312994129951299612997129981299913000130011300213003130041300513006130071300813009130101301113012130131301413015130161301713018130191302013021130221302313024130251302613027130281302913030130311303213033130341303513036130371303813039130401304113042130431304413045130461304713048130491305013051130521305313054130551305613057130581305913060130611306213063130641306513066130671306813069130701307113072130731307413075130761307713078130791308013081130821308313084130851308613087130881308913090130911309213093130941309513096130971309813099131001310113102131031310413105131061310713108131091311013111131121311313114131151311613117131181311913120131211312213123131241312513126131271312813129131301313113132131331313413135131361313713138131391314013141131421314313144131451314613147131481314913150131511315213153131541315513156131571315813159131601316113162131631316413165131661316713168131691317013171131721317313174131751317613177131781317913180131811318213183131841318513186131871318813189131901319113192131931319413195131961319713198131991320013201132021320313204132051320613207132081320913210132111321213213132141321513216132171321813219132201322113222132231322413225132261322713228132291323013231132321323313234132351323613237132381323913240132411324213243132441324513246132471324813249132501325113252132531325413255132561325713258132591326013261132621326313264132651326613267132681326913270132711327213273132741327513276132771327813279132801328113282132831328413285132861328713288132891329013291132921329313294132951329613297132981329913300133011330213303133041330513306133071330813309133101331113312133131331413315133161331713318133191332013321133221332313324133251332613327133281332913330133311333213333133341333513336133371333813339133401334113342133431334413345133461334713348133491335013351133521335313354133551335613357133581335913360133611336213363133641336513366133671336813369133701337113372133731337413375133761337713378133791338013381133821338313384133851338613387133881338913390133911339213393133941339513396133971339813399134001340113402134031340413405134061340713408134091341013411134121341313414134151341613417134181341913420134211342213423134241342513426134271342813429134301343113432134331343413435134361343713438134391344013441134421344313444134451344613447134481344913450134511345213453134541345513456134571345813459134601346113462134631346413465134661346713468134691347013471134721347313474134751347613477134781347913480134811348213483134841348513486134871348813489134901349113492134931349413495134961349713498134991350013501135021350313504135051350613507135081350913510135111351213513135141351513516135171351813519135201352113522135231352413525135261352713528135291353013531135321353313534135351353613537135381353913540135411354213543135441354513546135471354813549135501355113552135531355413555135561355713558135591356013561135621356313564135651356613567135681356913570135711357213573135741357513576135771357813579135801358113582135831358413585135861358713588135891359013591135921359313594135951359613597135981359913600136011360213603136041360513606136071360813609136101361113612136131361413615136161361713618136191362013621136221362313624136251362613627136281362913630136311363213633136341363513636136371363813639136401364113642136431364413645136461364713648136491365013651136521365313654136551365613657136581365913660136611366213663136641366513666136671366813669136701367113672136731367413675136761367713678136791368013681136821368313684136851368613687136881368913690136911369213693136941369513696136971369813699137001370113702137031370413705137061370713708137091371013711137121371313714137151371613717137181371913720137211372213723137241372513726137271372813729137301373113732137331373413735137361373713738137391374013741137421374313744137451374613747137481374913750137511375213753137541375513756137571375813759137601376113762137631376413765137661376713768137691377013771137721377313774137751377613777137781377913780137811378213783137841378513786137871378813789137901379113792137931379413795137961379713798137991380013801138021380313804138051380613807138081380913810138111381213813138141381513816138171381813819138201382113822138231382413825138261382713828138291383013831138321383313834138351383613837138381383913840138411384213843138441384513846138471384813849138501385113852138531385413855138561385713858138591386013861138621386313864138651386613867138681386913870138711387213873138741387513876138771387813879138801388113882138831388413885138861388713888138891389013891138921389313894138951389613897138981389913900139011390213903139041390513906139071390813909139101391113912139131391413915139161391713918139191392013921139221392313924139251392613927139281392913930139311393213933139341393513936139371393813939139401394113942139431394413945139461394713948139491395013951139521395313954139551395613957139581395913960139611396213963139641396513966139671396813969139701397113972139731397413975139761397713978139791398013981139821398313984139851398613987139881398913990139911399213993139941399513996139971399813999140001400114002140031400414005140061400714008140091401014011140121401314014140151401614017140181401914020140211402214023140241402514026140271402814029140301403114032140331403414035140361403714038140391404014041140421404314044140451404614047140481404914050140511405214053140541405514056140571405814059140601406114062140631406414065140661406714068140691407014071140721407314074140751407614077140781407914080140811408214083140841408514086140871408814089140901409114092140931409414095140961409714098140991410014101141021410314104141051410614107141081410914110141111411214113141141411514116141171411814119141201412114122141231412414125141261412714128141291413014131141321413314134141351413614137141381413914140141411414214143141441414514146141471414814149141501415114152141531415414155141561415714158141591416014161141621416314164141651416614167141681416914170141711417214173141741417514176141771417814179141801418114182141831418414185141861418714188141891419014191141921419314194141951419614197141981419914200142011420214203142041420514206142071420814209142101421114212142131421414215142161421714218142191422014221142221422314224142251422614227142281422914230142311423214233142341423514236142371423814239142401424114242142431424414245142461424714248142491425014251142521425314254142551425614257142581425914260142611426214263142641426514266142671426814269142701427114272142731427414275142761427714278142791428014281142821428314284142851428614287142881428914290142911429214293142941429514296142971429814299143001430114302143031430414305143061430714308143091431014311143121431314314143151431614317143181431914320143211432214323143241432514326143271432814329143301433114332143331433414335143361433714338143391434014341143421434314344143451434614347143481434914350143511435214353143541435514356143571435814359143601436114362143631436414365143661436714368143691437014371143721437314374143751437614377143781437914380143811438214383143841438514386143871438814389143901439114392143931439414395143961439714398143991440014401144021440314404144051440614407144081440914410144111441214413144141441514416144171441814419144201442114422144231442414425144261442714428144291443014431144321443314434144351443614437144381443914440144411444214443144441444514446144471444814449144501445114452144531445414455144561445714458144591446014461144621446314464144651446614467144681446914470144711447214473144741447514476144771447814479144801448114482144831448414485144861448714488144891449014491144921449314494144951449614497144981449914500145011450214503145041450514506145071450814509145101451114512145131451414515145161451714518145191452014521145221452314524145251452614527145281452914530145311453214533145341453514536145371453814539145401454114542145431454414545145461454714548145491455014551145521455314554145551455614557145581455914560145611456214563145641456514566145671456814569145701457114572145731457414575145761457714578145791458014581145821458314584145851458614587145881458914590145911459214593145941459514596145971459814599146001460114602146031460414605146061460714608146091461014611146121461314614146151461614617146181461914620146211462214623146241462514626146271462814629146301463114632146331463414635146361463714638146391464014641146421464314644146451464614647146481464914650146511465214653146541465514656146571465814659146601466114662146631466414665146661466714668146691467014671146721467314674146751467614677146781467914680146811468214683146841468514686146871468814689146901469114692146931469414695146961469714698146991470014701147021470314704147051470614707147081470914710147111471214713147141471514716147171471814719147201472114722147231472414725147261472714728147291473014731147321473314734147351473614737147381473914740147411474214743147441474514746147471474814749147501475114752147531475414755147561475714758147591476014761147621476314764147651476614767147681476914770147711477214773147741477514776147771477814779147801478114782147831478414785147861478714788147891479014791147921479314794147951479614797147981479914800148011480214803148041480514806148071480814809148101481114812148131481414815148161481714818148191482014821148221482314824148251482614827148281482914830148311483214833148341483514836148371483814839148401484114842148431484414845148461484714848148491485014851148521485314854148551485614857148581485914860148611486214863148641486514866148671486814869148701487114872148731487414875148761487714878148791488014881148821488314884148851488614887148881488914890148911489214893148941489514896148971489814899149001490114902149031490414905149061490714908149091491014911149121491314914149151491614917149181491914920149211492214923149241492514926149271492814929149301493114932149331493414935149361493714938149391494014941149421494314944149451494614947149481494914950149511495214953149541495514956149571495814959149601496114962149631496414965149661496714968149691497014971149721497314974149751497614977149781497914980149811498214983149841498514986149871498814989149901499114992149931499414995149961499714998149991500015001150021500315004150051500615007150081500915010150111501215013150141501515016150171501815019150201502115022150231502415025150261502715028150291503015031150321503315034150351503615037150381503915040150411504215043150441504515046150471504815049150501505115052150531505415055150561505715058150591506015061150621506315064150651506615067150681506915070150711507215073150741507515076150771507815079150801508115082150831508415085150861508715088150891509015091150921509315094150951509615097150981509915100151011510215103151041510515106151071510815109151101511115112151131511415115151161511715118151191512015121151221512315124151251512615127151281512915130151311513215133151341513515136151371513815139151401514115142151431514415145151461514715148151491515015151151521515315154151551515615157151581515915160151611516215163151641516515166151671516815169151701517115172151731517415175151761517715178151791518015181151821518315184151851518615187151881518915190151911519215193151941519515196151971519815199152001520115202152031520415205152061520715208152091521015211152121521315214152151521615217152181521915220152211522215223152241522515226152271522815229152301523115232152331523415235152361523715238152391524015241152421524315244152451524615247152481524915250152511525215253152541525515256152571525815259152601526115262152631526415265152661526715268152691527015271152721527315274152751527615277152781527915280152811528215283152841528515286152871528815289152901529115292152931529415295152961529715298152991530015301153021530315304153051530615307153081530915310153111531215313153141531515316153171531815319153201532115322153231532415325153261532715328153291533015331153321533315334153351533615337153381533915340153411534215343153441534515346153471534815349153501535115352153531535415355153561535715358153591536015361153621536315364153651536615367153681536915370153711537215373153741537515376153771537815379153801538115382153831538415385153861538715388153891539015391153921539315394153951539615397153981539915400154011540215403154041540515406154071540815409154101541115412154131541415415154161541715418154191542015421154221542315424154251542615427154281542915430154311543215433154341543515436154371543815439154401544115442154431544415445154461544715448154491545015451154521545315454154551545615457154581545915460154611546215463154641546515466154671546815469154701547115472154731547415475154761547715478154791548015481154821548315484154851548615487154881548915490154911549215493154941549515496154971549815499155001550115502155031550415505155061550715508155091551015511155121551315514155151551615517155181551915520155211552215523155241552515526155271552815529155301553115532155331553415535155361553715538155391554015541155421554315544155451554615547155481554915550155511555215553155541555515556155571555815559155601556115562155631556415565155661556715568155691557015571155721557315574155751557615577155781557915580155811558215583155841558515586155871558815589155901559115592155931559415595155961559715598155991560015601156021560315604156051560615607156081560915610156111561215613156141561515616156171561815619156201562115622156231562415625156261562715628156291563015631156321563315634156351563615637156381563915640156411564215643156441564515646156471564815649156501565115652156531565415655156561565715658156591566015661156621566315664156651566615667156681566915670156711567215673156741567515676156771567815679156801568115682156831568415685156861568715688156891569015691156921569315694156951569615697156981569915700157011570215703157041570515706157071570815709157101571115712157131571415715157161571715718157191572015721157221572315724157251572615727157281572915730157311573215733157341573515736157371573815739157401574115742157431574415745157461574715748157491575015751157521575315754157551575615757157581575915760157611576215763157641576515766157671576815769157701577115772157731577415775157761577715778157791578015781157821578315784157851578615787157881578915790157911579215793157941579515796157971579815799158001580115802158031580415805158061580715808158091581015811158121581315814158151581615817158181581915820158211582215823158241582515826158271582815829158301583115832158331583415835158361583715838158391584015841158421584315844158451584615847158481584915850158511585215853158541585515856158571585815859158601586115862158631586415865158661586715868158691587015871158721587315874158751587615877158781587915880158811588215883158841588515886158871588815889158901589115892158931589415895158961589715898158991590015901159021590315904159051590615907159081590915910159111591215913159141591515916159171591815919159201592115922159231592415925159261592715928159291593015931159321593315934159351593615937159381593915940159411594215943159441594515946159471594815949159501595115952159531595415955159561595715958159591596015961159621596315964159651596615967159681596915970159711597215973159741597515976159771597815979159801598115982159831598415985159861598715988159891599015991159921599315994159951599615997159981599916000160011600216003160041600516006160071600816009160101601116012160131601416015160161601716018160191602016021160221602316024160251602616027160281602916030160311603216033160341603516036160371603816039160401604116042160431604416045160461604716048160491605016051160521605316054160551605616057160581605916060160611606216063160641606516066160671606816069160701607116072160731607416075160761607716078160791608016081160821608316084160851608616087160881608916090160911609216093160941609516096160971609816099161001610116102161031610416105161061610716108161091611016111161121611316114161151611616117161181611916120161211612216123161241612516126161271612816129161301613116132161331613416135161361613716138161391614016141161421614316144161451614616147161481614916150161511615216153161541615516156161571615816159161601616116162161631616416165161661616716168161691617016171161721617316174161751617616177161781617916180161811618216183161841618516186161871618816189161901619116192161931619416195161961619716198161991620016201162021620316204162051620616207162081620916210162111621216213162141621516216162171621816219162201622116222162231622416225162261622716228162291623016231162321623316234162351623616237162381623916240162411624216243162441624516246162471624816249162501625116252162531625416255162561625716258162591626016261162621626316264162651626616267162681626916270162711627216273162741627516276162771627816279162801628116282162831628416285162861628716288162891629016291162921629316294162951629616297162981629916300163011630216303163041630516306163071630816309163101631116312163131631416315163161631716318163191632016321163221632316324163251632616327163281632916330163311633216333163341633516336163371633816339163401634116342163431634416345163461634716348163491635016351163521635316354163551635616357163581635916360163611636216363163641636516366163671636816369163701637116372163731637416375163761637716378163791638016381163821638316384163851638616387163881638916390163911639216393163941639516396163971639816399164001640116402164031640416405164061640716408164091641016411164121641316414164151641616417164181641916420164211642216423164241642516426164271642816429164301643116432164331643416435164361643716438164391644016441164421644316444164451644616447164481644916450164511645216453164541645516456164571645816459164601646116462164631646416465164661646716468164691647016471164721647316474164751647616477164781647916480164811648216483164841648516486164871648816489164901649116492164931649416495164961649716498164991650016501165021650316504165051650616507165081650916510165111651216513165141651516516165171651816519165201652116522165231652416525165261652716528165291653016531165321653316534165351653616537165381653916540165411654216543165441654516546165471654816549165501655116552165531655416555165561655716558165591656016561165621656316564165651656616567165681656916570165711657216573165741657516576165771657816579165801658116582165831658416585165861658716588165891659016591165921659316594165951659616597165981659916600166011660216603166041660516606166071660816609166101661116612166131661416615166161661716618166191662016621166221662316624166251662616627166281662916630166311663216633166341663516636166371663816639166401664116642166431664416645166461664716648166491665016651166521665316654166551665616657166581665916660166611666216663166641666516666166671666816669166701667116672166731667416675166761667716678166791668016681166821668316684166851668616687166881668916690166911669216693166941669516696166971669816699167001670116702167031670416705167061670716708167091671016711167121671316714167151671616717167181671916720167211672216723167241672516726167271672816729167301673116732167331673416735167361673716738167391674016741167421674316744167451674616747167481674916750167511675216753167541675516756167571675816759167601676116762167631676416765167661676716768167691677016771167721677316774167751677616777167781677916780167811678216783167841678516786167871678816789167901679116792167931679416795167961679716798167991680016801168021680316804168051680616807168081680916810168111681216813168141681516816168171681816819168201682116822168231682416825168261682716828168291683016831168321683316834168351683616837168381683916840168411684216843168441684516846168471684816849168501685116852168531685416855168561685716858168591686016861168621686316864168651686616867168681686916870168711687216873168741687516876168771687816879168801688116882168831688416885168861688716888168891689016891168921689316894168951689616897168981689916900169011690216903169041690516906169071690816909169101691116912169131691416915169161691716918169191692016921169221692316924169251692616927169281692916930169311693216933169341693516936169371693816939169401694116942169431694416945169461694716948169491695016951169521695316954169551695616957169581695916960169611696216963169641696516966169671696816969169701697116972169731697416975169761697716978169791698016981169821698316984169851698616987169881698916990169911699216993169941699516996169971699816999170001700117002170031700417005170061700717008170091701017011170121701317014170151701617017170181701917020170211702217023170241702517026170271702817029170301703117032170331703417035170361703717038170391704017041170421704317044170451704617047170481704917050170511705217053170541705517056170571705817059170601706117062170631706417065170661706717068170691707017071170721707317074170751707617077170781707917080170811708217083170841708517086170871708817089170901709117092170931709417095170961709717098170991710017101171021710317104171051710617107171081710917110171111711217113171141711517116171171711817119171201712117122171231712417125171261712717128171291713017131171321713317134171351713617137171381713917140171411714217143171441714517146171471714817149171501715117152171531715417155171561715717158171591716017161171621716317164171651716617167171681716917170171711717217173171741717517176171771717817179171801718117182171831718417185171861718717188171891719017191171921719317194171951719617197171981719917200172011720217203172041720517206172071720817209172101721117212172131721417215172161721717218172191722017221172221722317224172251722617227172281722917230172311723217233172341723517236172371723817239172401724117242172431724417245172461724717248172491725017251172521725317254172551725617257172581725917260172611726217263172641726517266172671726817269172701727117272172731727417275172761727717278172791728017281172821728317284172851728617287172881728917290172911729217293172941729517296172971729817299173001730117302173031730417305173061730717308173091731017311173121731317314173151731617317173181731917320173211732217323173241732517326173271732817329173301733117332173331733417335173361733717338173391734017341173421734317344173451734617347173481734917350173511735217353173541735517356173571735817359173601736117362173631736417365173661736717368173691737017371173721737317374173751737617377173781737917380173811738217383173841738517386173871738817389173901739117392173931739417395173961739717398173991740017401174021740317404174051740617407174081740917410174111741217413174141741517416174171741817419174201742117422174231742417425174261742717428174291743017431174321743317434174351743617437174381743917440174411744217443174441744517446174471744817449174501745117452174531745417455174561745717458174591746017461174621746317464174651746617467174681746917470174711747217473174741747517476174771747817479174801748117482174831748417485174861748717488174891749017491174921749317494174951749617497174981749917500175011750217503175041750517506175071750817509175101751117512175131751417515175161751717518175191752017521175221752317524175251752617527175281752917530175311753217533175341753517536175371753817539175401754117542175431754417545175461754717548175491755017551175521755317554175551755617557175581755917560175611756217563175641756517566175671756817569175701757117572175731757417575175761757717578175791758017581175821758317584175851758617587175881758917590175911759217593175941759517596175971759817599176001760117602176031760417605176061760717608176091761017611176121761317614176151761617617176181761917620176211762217623176241762517626176271762817629176301763117632176331763417635176361763717638176391764017641176421764317644176451764617647176481764917650176511765217653176541765517656176571765817659176601766117662176631766417665176661766717668176691767017671176721767317674176751767617677176781767917680176811768217683176841768517686176871768817689176901769117692176931769417695176961769717698176991770017701177021770317704177051770617707177081770917710177111771217713177141771517716177171771817719177201772117722177231772417725177261772717728177291773017731177321773317734177351773617737177381773917740177411774217743177441774517746177471774817749177501775117752177531775417755177561775717758177591776017761177621776317764177651776617767177681776917770177711777217773177741777517776177771777817779177801778117782177831778417785177861778717788177891779017791177921779317794177951779617797177981779917800178011780217803178041780517806178071780817809178101781117812178131781417815178161781717818178191782017821178221782317824178251782617827178281782917830178311783217833178341783517836178371783817839178401784117842178431784417845178461784717848178491785017851178521785317854178551785617857178581785917860178611786217863178641786517866178671786817869178701787117872178731787417875178761787717878178791788017881178821788317884178851788617887178881788917890178911789217893178941789517896178971789817899179001790117902179031790417905179061790717908179091791017911179121791317914179151791617917179181791917920179211792217923179241792517926179271792817929179301793117932179331793417935179361793717938179391794017941179421794317944179451794617947179481794917950179511795217953179541795517956179571795817959179601796117962179631796417965179661796717968179691797017971179721797317974179751797617977179781797917980179811798217983179841798517986179871798817989179901799117992179931799417995179961799717998179991800018001180021800318004180051800618007180081800918010180111801218013180141801518016180171801818019180201802118022180231802418025180261802718028180291803018031180321803318034180351803618037180381803918040180411804218043180441804518046180471804818049180501805118052180531805418055180561805718058180591806018061180621806318064180651806618067180681806918070180711807218073180741807518076180771807818079180801808118082180831808418085180861808718088180891809018091180921809318094180951809618097180981809918100181011810218103181041810518106181071810818109181101811118112181131811418115181161811718118181191812018121181221812318124181251812618127181281812918130181311813218133181341813518136181371813818139181401814118142181431814418145181461814718148181491815018151181521815318154181551815618157181581815918160181611816218163181641816518166181671816818169181701817118172181731817418175181761817718178181791818018181181821818318184181851818618187181881818918190181911819218193181941819518196181971819818199182001820118202182031820418205182061820718208182091821018211182121821318214182151821618217182181821918220182211822218223182241822518226182271822818229182301823118232182331823418235182361823718238182391824018241182421824318244182451824618247182481824918250182511825218253182541825518256182571825818259182601826118262182631826418265182661826718268182691827018271182721827318274182751827618277182781827918280182811828218283182841828518286182871828818289182901829118292182931829418295182961829718298182991830018301183021830318304183051830618307183081830918310183111831218313183141831518316183171831818319183201832118322183231832418325183261832718328183291833018331183321833318334183351833618337183381833918340183411834218343183441834518346183471834818349183501835118352183531835418355183561835718358183591836018361183621836318364183651836618367183681836918370183711837218373183741837518376183771837818379183801838118382183831838418385183861838718388183891839018391183921839318394183951839618397183981839918400184011840218403184041840518406184071840818409184101841118412184131841418415184161841718418184191842018421184221842318424184251842618427184281842918430184311843218433184341843518436184371843818439184401844118442184431844418445184461844718448184491845018451184521845318454184551845618457184581845918460184611846218463184641846518466184671846818469184701847118472184731847418475184761847718478184791848018481184821848318484184851848618487184881848918490184911849218493184941849518496184971849818499185001850118502185031850418505185061850718508185091851018511185121851318514185151851618517185181851918520185211852218523185241852518526185271852818529185301853118532185331853418535185361853718538185391854018541185421854318544185451854618547185481854918550185511855218553185541855518556185571855818559185601856118562185631856418565185661856718568185691857018571185721857318574185751857618577185781857918580185811858218583185841858518586185871858818589185901859118592185931859418595185961859718598185991860018601186021860318604186051860618607186081860918610186111861218613186141861518616186171861818619186201862118622186231862418625186261862718628186291863018631186321863318634186351863618637186381863918640186411864218643186441864518646186471864818649186501865118652186531865418655186561865718658186591866018661186621866318664186651866618667186681866918670186711867218673186741867518676186771867818679186801868118682186831868418685186861868718688186891869018691186921869318694186951869618697186981869918700187011870218703187041870518706187071870818709187101871118712187131871418715187161871718718187191872018721187221872318724187251872618727187281872918730187311873218733187341873518736187371873818739187401874118742187431874418745187461874718748187491875018751187521875318754187551875618757187581875918760187611876218763187641876518766187671876818769187701877118772187731877418775187761877718778187791878018781187821878318784187851878618787187881878918790187911879218793187941879518796187971879818799188001880118802188031880418805188061880718808188091881018811188121881318814188151881618817188181881918820188211882218823188241882518826188271882818829188301883118832188331883418835188361883718838188391884018841188421884318844188451884618847188481884918850188511885218853188541885518856188571885818859188601886118862188631886418865188661886718868188691887018871188721887318874188751887618877188781887918880188811888218883188841888518886188871888818889188901889118892188931889418895188961889718898188991890018901189021890318904189051890618907189081890918910189111891218913189141891518916189171891818919189201892118922189231892418925189261892718928189291893018931189321893318934189351893618937189381893918940189411894218943189441894518946189471894818949189501895118952189531895418955189561895718958189591896018961189621896318964189651896618967189681896918970189711897218973189741897518976189771897818979189801898118982189831898418985189861898718988189891899018991189921899318994189951899618997189981899919000190011900219003190041900519006190071900819009190101901119012190131901419015190161901719018190191902019021190221902319024190251902619027190281902919030190311903219033190341903519036190371903819039190401904119042190431904419045190461904719048190491905019051190521905319054190551905619057190581905919060190611906219063190641906519066190671906819069190701907119072190731907419075190761907719078190791908019081190821908319084190851908619087190881908919090190911909219093190941909519096190971909819099191001910119102191031910419105191061910719108191091911019111191121911319114191151911619117191181911919120191211912219123191241912519126191271912819129191301913119132191331913419135191361913719138191391914019141191421914319144191451914619147191481914919150191511915219153191541915519156191571915819159191601916119162191631916419165191661916719168191691917019171191721917319174191751917619177191781917919180191811918219183191841918519186191871918819189191901919119192191931919419195191961919719198191991920019201192021920319204192051920619207192081920919210192111921219213192141921519216192171921819219192201922119222192231922419225192261922719228192291923019231192321923319234192351923619237192381923919240192411924219243192441924519246192471924819249192501925119252192531925419255192561925719258192591926019261192621926319264192651926619267192681926919270192711927219273192741927519276192771927819279192801928119282192831928419285192861928719288192891929019291192921929319294192951929619297192981929919300193011930219303193041930519306193071930819309193101931119312193131931419315193161931719318193191932019321193221932319324193251932619327193281932919330193311933219333193341933519336193371933819339193401934119342193431934419345193461934719348193491935019351193521935319354193551935619357193581935919360193611936219363193641936519366193671936819369193701937119372193731937419375193761937719378193791938019381193821938319384193851938619387193881938919390193911939219393193941939519396193971939819399194001940119402194031940419405194061940719408194091941019411194121941319414194151941619417194181941919420194211942219423194241942519426194271942819429194301943119432194331943419435194361943719438194391944019441194421944319444194451944619447194481944919450194511945219453194541945519456194571945819459194601946119462194631946419465194661946719468194691947019471194721947319474194751947619477194781947919480194811948219483194841948519486194871948819489194901949119492194931949419495194961949719498194991950019501195021950319504195051950619507195081950919510195111951219513195141951519516195171951819519195201952119522195231952419525195261952719528195291953019531195321953319534195351953619537195381953919540195411954219543195441954519546195471954819549195501955119552195531955419555195561955719558195591956019561195621956319564195651956619567195681956919570195711957219573195741957519576195771957819579195801958119582195831958419585195861958719588195891959019591195921959319594195951959619597195981959919600196011960219603196041960519606196071960819609196101961119612196131961419615196161961719618196191962019621196221962319624196251962619627196281962919630196311963219633196341963519636196371963819639196401964119642196431964419645196461964719648196491965019651196521965319654196551965619657196581965919660196611966219663196641966519666196671966819669196701967119672196731967419675196761967719678196791968019681196821968319684196851968619687196881968919690196911969219693196941969519696196971969819699197001970119702197031970419705197061970719708197091971019711197121971319714197151971619717197181971919720197211972219723197241972519726197271972819729197301973119732197331973419735197361973719738197391974019741197421974319744197451974619747197481974919750197511975219753197541975519756197571975819759197601976119762197631976419765197661976719768197691977019771197721977319774197751977619777197781977919780197811978219783197841978519786197871978819789197901979119792197931979419795197961979719798197991980019801198021980319804198051980619807198081980919810198111981219813198141981519816198171981819819198201982119822198231982419825198261982719828198291983019831198321983319834198351983619837198381983919840198411984219843198441984519846198471984819849198501985119852198531985419855198561985719858198591986019861198621986319864198651986619867198681986919870198711987219873198741987519876198771987819879198801988119882198831988419885198861988719888198891989019891198921989319894198951989619897198981989919900199011990219903199041990519906199071990819909199101991119912199131991419915199161991719918199191992019921199221992319924199251992619927199281992919930199311993219933199341993519936199371993819939199401994119942199431994419945199461994719948199491995019951199521995319954199551995619957199581995919960199611996219963199641996519966199671996819969199701997119972199731997419975199761997719978199791998019981199821998319984199851998619987199881998919990199911999219993199941999519996199971999819999200002000120002200032000420005200062000720008200092001020011200122001320014200152001620017200182001920020200212002220023200242002520026200272002820029200302003120032200332003420035200362003720038200392004020041200422004320044200452004620047200482004920050200512005220053200542005520056200572005820059200602006120062200632006420065200662006720068200692007020071200722007320074200752007620077200782007920080200812008220083200842008520086200872008820089200902009120092200932009420095200962009720098200992010020101201022010320104201052010620107201082010920110201112011220113201142011520116201172011820119201202012120122201232012420125201262012720128201292013020131201322013320134201352013620137201382013920140201412014220143201442014520146201472014820149201502015120152201532015420155201562015720158201592016020161201622016320164201652016620167201682016920170201712017220173201742017520176201772017820179201802018120182201832018420185201862018720188201892019020191201922019320194201952019620197201982019920200202012020220203202042020520206202072020820209202102021120212202132021420215202162021720218202192022020221202222022320224202252022620227202282022920230202312023220233202342023520236202372023820239202402024120242202432024420245202462024720248202492025020251202522025320254202552025620257202582025920260202612026220263202642026520266202672026820269202702027120272202732027420275202762027720278202792028020281202822028320284202852028620287202882028920290202912029220293202942029520296202972029820299203002030120302203032030420305203062030720308203092031020311203122031320314203152031620317203182031920320203212032220323203242032520326203272032820329203302033120332203332033420335203362033720338203392034020341203422034320344203452034620347203482034920350203512035220353203542035520356203572035820359203602036120362203632036420365203662036720368203692037020371203722037320374203752037620377203782037920380203812038220383203842038520386203872038820389203902039120392203932039420395203962039720398203992040020401204022040320404204052040620407204082040920410204112041220413204142041520416204172041820419204202042120422204232042420425204262042720428204292043020431204322043320434204352043620437204382043920440204412044220443204442044520446204472044820449204502045120452204532045420455204562045720458204592046020461204622046320464204652046620467204682046920470204712047220473204742047520476204772047820479204802048120482204832048420485204862048720488204892049020491204922049320494204952049620497204982049920500205012050220503205042050520506205072050820509205102051120512205132051420515205162051720518205192052020521205222052320524205252052620527205282052920530205312053220533205342053520536205372053820539205402054120542205432054420545205462054720548205492055020551205522055320554205552055620557205582055920560205612056220563205642056520566205672056820569205702057120572205732057420575205762057720578205792058020581205822058320584205852058620587205882058920590205912059220593205942059520596205972059820599206002060120602206032060420605206062060720608206092061020611206122061320614206152061620617206182061920620206212062220623206242062520626206272062820629206302063120632206332063420635206362063720638206392064020641206422064320644206452064620647206482064920650206512065220653206542065520656206572065820659206602066120662206632066420665206662066720668206692067020671206722067320674206752067620677206782067920680206812068220683206842068520686206872068820689206902069120692206932069420695206962069720698206992070020701207022070320704207052070620707207082070920710207112071220713207142071520716207172071820719207202072120722207232072420725207262072720728207292073020731207322073320734207352073620737207382073920740207412074220743207442074520746207472074820749207502075120752207532075420755207562075720758207592076020761207622076320764207652076620767207682076920770207712077220773207742077520776207772077820779207802078120782207832078420785207862078720788207892079020791207922079320794207952079620797207982079920800208012080220803208042080520806208072080820809208102081120812208132081420815208162081720818208192082020821208222082320824208252082620827208282082920830208312083220833208342083520836208372083820839208402084120842208432084420845208462084720848208492085020851208522085320854208552085620857208582085920860208612086220863208642086520866208672086820869208702087120872208732087420875208762087720878208792088020881208822088320884208852088620887208882088920890208912089220893208942089520896208972089820899209002090120902209032090420905209062090720908209092091020911209122091320914209152091620917209182091920920209212092220923209242092520926209272092820929209302093120932209332093420935209362093720938209392094020941209422094320944209452094620947209482094920950209512095220953209542095520956209572095820959209602096120962209632096420965209662096720968209692097020971209722097320974209752097620977209782097920980209812098220983209842098520986209872098820989209902099120992209932099420995209962099720998209992100021001210022100321004210052100621007210082100921010210112101221013210142101521016210172101821019210202102121022210232102421025210262102721028210292103021031210322103321034210352103621037210382103921040210412104221043210442104521046210472104821049210502105121052210532105421055210562105721058210592106021061210622106321064210652106621067210682106921070210712107221073210742107521076210772107821079210802108121082210832108421085210862108721088210892109021091210922109321094210952109621097210982109921100211012110221103211042110521106211072110821109211102111121112211132111421115211162111721118211192112021121211222112321124211252112621127211282112921130211312113221133211342113521136211372113821139211402114121142211432114421145211462114721148211492115021151211522115321154211552115621157211582115921160211612116221163211642116521166211672116821169211702117121172211732117421175211762117721178211792118021181211822118321184211852118621187211882118921190211912119221193211942119521196211972119821199212002120121202212032120421205212062120721208212092121021211212122121321214212152121621217212182121921220212212122221223212242122521226212272122821229212302123121232212332123421235212362123721238212392124021241212422124321244212452124621247212482124921250212512125221253212542125521256212572125821259212602126121262212632126421265212662126721268212692127021271212722127321274212752127621277212782127921280212812128221283212842128521286212872128821289212902129121292212932129421295212962129721298212992130021301213022130321304213052130621307213082130921310213112131221313213142131521316213172131821319213202132121322213232132421325213262132721328213292133021331213322133321334213352133621337213382133921340213412134221343213442134521346213472134821349213502135121352213532135421355213562135721358213592136021361213622136321364213652136621367213682136921370213712137221373213742137521376213772137821379213802138121382213832138421385213862138721388213892139021391213922139321394213952139621397213982139921400214012140221403214042140521406214072140821409214102141121412214132141421415214162141721418214192142021421214222142321424214252142621427214282142921430214312143221433214342143521436214372143821439214402144121442214432144421445214462144721448214492145021451214522145321454214552145621457214582145921460214612146221463214642146521466214672146821469214702147121472214732147421475214762147721478214792148021481214822148321484214852148621487214882148921490214912149221493214942149521496214972149821499215002150121502215032150421505215062150721508215092151021511215122151321514215152151621517215182151921520215212152221523215242152521526215272152821529215302153121532215332153421535215362153721538215392154021541215422154321544215452154621547215482154921550215512155221553215542155521556215572155821559215602156121562215632156421565215662156721568215692157021571215722157321574215752157621577215782157921580215812158221583215842158521586215872158821589215902159121592215932159421595215962159721598215992160021601216022160321604216052160621607216082160921610216112161221613216142161521616216172161821619216202162121622216232162421625216262162721628216292163021631216322163321634216352163621637216382163921640216412164221643216442164521646216472164821649216502165121652216532165421655216562165721658216592166021661216622166321664216652166621667216682166921670216712167221673216742167521676216772167821679216802168121682216832168421685216862168721688216892169021691216922169321694216952169621697216982169921700217012170221703217042170521706217072170821709217102171121712217132171421715217162171721718217192172021721217222172321724217252172621727217282172921730217312173221733217342173521736217372173821739217402174121742217432174421745217462174721748217492175021751217522175321754217552175621757217582175921760217612176221763217642176521766217672176821769217702177121772217732177421775217762177721778217792178021781217822178321784217852178621787217882178921790217912179221793217942179521796217972179821799218002180121802218032180421805218062180721808218092181021811218122181321814218152181621817218182181921820218212182221823218242182521826218272182821829218302183121832218332183421835218362183721838218392184021841218422184321844218452184621847218482184921850218512185221853218542185521856218572185821859218602186121862218632186421865218662186721868218692187021871218722187321874218752187621877218782187921880218812188221883218842188521886218872188821889218902189121892218932189421895218962189721898218992190021901219022190321904219052190621907219082190921910219112191221913219142191521916219172191821919219202192121922219232192421925219262192721928219292193021931219322193321934219352193621937219382193921940219412194221943219442194521946219472194821949219502195121952219532195421955219562195721958219592196021961219622196321964219652196621967219682196921970219712197221973219742197521976219772197821979219802198121982219832198421985219862198721988219892199021991219922199321994219952199621997219982199922000220012200222003220042200522006220072200822009220102201122012220132201422015220162201722018220192202022021220222202322024220252202622027220282202922030220312203222033220342203522036220372203822039220402204122042220432204422045220462204722048220492205022051220522205322054220552205622057220582205922060220612206222063220642206522066220672206822069220702207122072220732207422075220762207722078220792208022081220822208322084220852208622087220882208922090220912209222093220942209522096220972209822099221002210122102221032210422105221062210722108221092211022111221122211322114221152211622117221182211922120221212212222123221242212522126221272212822129221302213122132221332213422135221362213722138221392214022141221422214322144221452214622147221482214922150221512215222153221542215522156221572215822159221602216122162221632216422165221662216722168221692217022171221722217322174221752217622177221782217922180221812218222183221842218522186221872218822189221902219122192221932219422195221962219722198221992220022201222022220322204222052220622207222082220922210222112221222213222142221522216222172221822219222202222122222222232222422225222262222722228222292223022231222322223322234222352223622237222382223922240222412224222243222442224522246222472224822249222502225122252222532225422255222562225722258222592226022261222622226322264222652226622267222682226922270222712227222273222742227522276222772227822279222802228122282222832228422285222862228722288222892229022291222922229322294222952229622297222982229922300223012230222303223042230522306223072230822309223102231122312223132231422315223162231722318223192232022321223222232322324223252232622327223282232922330223312233222333223342233522336223372233822339223402234122342223432234422345223462234722348223492235022351223522235322354223552235622357223582235922360223612236222363223642236522366223672236822369223702237122372223732237422375223762237722378223792238022381223822238322384223852238622387223882238922390223912239222393223942239522396223972239822399224002240122402224032240422405224062240722408224092241022411224122241322414224152241622417224182241922420224212242222423224242242522426224272242822429224302243122432224332243422435224362243722438224392244022441224422244322444224452244622447224482244922450224512245222453224542245522456224572245822459224602246122462224632246422465224662246722468224692247022471224722247322474224752247622477224782247922480224812248222483224842248522486224872248822489224902249122492224932249422495224962249722498224992250022501225022250322504225052250622507225082250922510225112251222513225142251522516225172251822519225202252122522225232252422525225262252722528225292253022531225322253322534225352253622537225382253922540225412254222543225442254522546225472254822549225502255122552225532255422555225562255722558225592256022561225622256322564225652256622567225682256922570225712257222573225742257522576225772257822579225802258122582225832258422585225862258722588225892259022591225922259322594225952259622597225982259922600226012260222603226042260522606226072260822609226102261122612226132261422615226162261722618226192262022621226222262322624226252262622627226282262922630226312263222633226342263522636226372263822639226402264122642226432264422645226462264722648226492265022651226522265322654226552265622657226582265922660226612266222663226642266522666226672266822669226702267122672226732267422675226762267722678226792268022681226822268322684226852268622687226882268922690226912269222693226942269522696226972269822699227002270122702227032270422705227062270722708227092271022711227122271322714227152271622717227182271922720227212272222723227242272522726227272272822729227302273122732227332273422735227362273722738227392274022741227422274322744227452274622747227482274922750227512275222753227542275522756227572275822759227602276122762227632276422765227662276722768227692277022771227722277322774227752277622777227782277922780227812278222783227842278522786227872278822789227902279122792227932279422795227962279722798227992280022801228022280322804228052280622807228082280922810228112281222813228142281522816228172281822819228202282122822228232282422825228262282722828228292283022831228322283322834228352283622837228382283922840228412284222843228442284522846228472284822849228502285122852228532285422855228562285722858228592286022861228622286322864228652286622867228682286922870228712287222873228742287522876228772287822879228802288122882228832288422885228862288722888228892289022891228922289322894228952289622897228982289922900229012290222903229042290522906229072290822909229102291122912229132291422915229162291722918229192292022921229222292322924229252292622927229282292922930229312293222933229342293522936229372293822939229402294122942229432294422945229462294722948229492295022951229522295322954229552295622957229582295922960229612296222963229642296522966229672296822969229702297122972229732297422975229762297722978229792298022981229822298322984229852298622987229882298922990229912299222993229942299522996229972299822999230002300123002230032300423005230062300723008230092301023011230122301323014230152301623017230182301923020230212302223023230242302523026230272302823029230302303123032230332303423035230362303723038230392304023041230422304323044230452304623047230482304923050230512305223053230542305523056230572305823059230602306123062230632306423065230662306723068230692307023071230722307323074230752307623077230782307923080230812308223083230842308523086230872308823089230902309123092230932309423095230962309723098230992310023101231022310323104231052310623107231082310923110231112311223113231142311523116231172311823119231202312123122231232312423125231262312723128231292313023131231322313323134231352313623137231382313923140231412314223143231442314523146231472314823149231502315123152231532315423155231562315723158231592316023161231622316323164231652316623167231682316923170231712317223173231742317523176231772317823179231802318123182231832318423185231862318723188231892319023191231922319323194231952319623197231982319923200232012320223203232042320523206232072320823209232102321123212232132321423215232162321723218232192322023221232222322323224232252322623227232282322923230232312323223233232342323523236232372323823239232402324123242232432324423245232462324723248232492325023251232522325323254232552325623257232582325923260232612326223263232642326523266232672326823269232702327123272232732327423275232762327723278232792328023281232822328323284232852328623287232882328923290232912329223293232942329523296232972329823299233002330123302233032330423305233062330723308233092331023311233122331323314233152331623317233182331923320233212332223323233242332523326233272332823329233302333123332233332333423335233362333723338233392334023341233422334323344233452334623347233482334923350233512335223353233542335523356233572335823359233602336123362233632336423365233662336723368233692337023371233722337323374233752337623377233782337923380233812338223383233842338523386233872338823389233902339123392233932339423395233962339723398233992340023401234022340323404234052340623407234082340923410234112341223413234142341523416234172341823419234202342123422234232342423425234262342723428234292343023431234322343323434234352343623437234382343923440234412344223443234442344523446234472344823449234502345123452234532345423455234562345723458234592346023461234622346323464234652346623467234682346923470234712347223473234742347523476234772347823479234802348123482234832348423485234862348723488234892349023491234922349323494234952349623497234982349923500235012350223503235042350523506235072350823509235102351123512235132351423515235162351723518235192352023521235222352323524235252352623527235282352923530235312353223533235342353523536235372353823539235402354123542235432354423545235462354723548235492355023551235522355323554235552355623557235582355923560235612356223563235642356523566235672356823569235702357123572235732357423575235762357723578235792358023581235822358323584235852358623587235882358923590235912359223593235942359523596235972359823599236002360123602236032360423605236062360723608236092361023611236122361323614236152361623617236182361923620236212362223623236242362523626236272362823629236302363123632236332363423635236362363723638236392364023641236422364323644236452364623647236482364923650236512365223653236542365523656236572365823659236602366123662236632366423665236662366723668236692367023671236722367323674236752367623677236782367923680236812368223683236842368523686236872368823689236902369123692236932369423695236962369723698236992370023701237022370323704237052370623707237082370923710237112371223713237142371523716237172371823719237202372123722237232372423725237262372723728237292373023731237322373323734237352373623737237382373923740237412374223743237442374523746237472374823749237502375123752237532375423755237562375723758237592376023761237622376323764237652376623767237682376923770237712377223773237742377523776237772377823779237802378123782237832378423785237862378723788237892379023791237922379323794237952379623797237982379923800238012380223803238042380523806238072380823809238102381123812238132381423815238162381723818238192382023821238222382323824238252382623827238282382923830238312383223833238342383523836238372383823839238402384123842238432384423845238462384723848238492385023851238522385323854238552385623857238582385923860238612386223863238642386523866238672386823869238702387123872238732387423875238762387723878238792388023881238822388323884238852388623887238882388923890238912389223893238942389523896238972389823899239002390123902239032390423905239062390723908239092391023911239122391323914239152391623917239182391923920
  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. (const :tag "ebnf2ps" ebnf2ps))
  247. :value-type (boolean :tag "Activate" :value t)))
  248. ;;;; Customization variables
  249. (defcustom org-clone-delete-id nil
  250. "Remove ID property of clones of a subtree.
  251. When non-nil, clones of a subtree don't inherit the ID property.
  252. Otherwise they inherit the ID property with a new unique
  253. identifier."
  254. :type 'boolean
  255. :version "24.1"
  256. :group 'org-id)
  257. ;;; Version
  258. (org-check-version)
  259. ;;;###autoload
  260. (defun org-version (&optional here full message)
  261. "Show the org-mode version in the echo area.
  262. With prefix argument HERE, insert it at point.
  263. When FULL is non-nil, use a verbose version string.
  264. When MESSAGE is non-nil, display a message with the version."
  265. (interactive "P")
  266. (let* ((org-dir (ignore-errors (org-find-library-dir "org")))
  267. (save-load-suffixes (when (boundp 'load-suffixes) load-suffixes))
  268. (load-suffixes (list ".el"))
  269. (org-install-dir (ignore-errors (org-find-library-dir "org-loaddefs")))
  270. (org-trash (or
  271. (and (fboundp 'org-release) (fboundp 'org-git-version))
  272. (org-load-noerror-mustsuffix (concat org-dir "org-version"))))
  273. (load-suffixes save-load-suffixes)
  274. (org-version (org-release))
  275. (git-version (org-git-version))
  276. (version (format "Org-mode version %s (%s @ %s)"
  277. org-version
  278. git-version
  279. (if org-install-dir
  280. (if (string= org-dir org-install-dir)
  281. org-install-dir
  282. (concat "mixed installation! " org-install-dir " and " org-dir))
  283. "org-loaddefs.el can not be found!")))
  284. (_version (if full version org-version)))
  285. (if (org-called-interactively-p 'interactive)
  286. (if here
  287. (insert version)
  288. (message version))
  289. (if message (message _version))
  290. _version)))
  291. (defconst org-version (org-version))
  292. ;;; Compatibility constants
  293. ;;; The custom variables
  294. (defgroup org nil
  295. "Outline-based notes management and organizer."
  296. :tag "Org"
  297. :group 'outlines
  298. :group 'calendar)
  299. (defcustom org-mode-hook nil
  300. "Mode hook for Org-mode, run after the mode was turned on."
  301. :group 'org
  302. :type 'hook)
  303. (defcustom org-load-hook nil
  304. "Hook that is run after org.el has been loaded."
  305. :group 'org
  306. :type 'hook)
  307. (defcustom org-log-buffer-setup-hook nil
  308. "Hook that is run after an Org log buffer is created."
  309. :group 'org
  310. :version "24.1"
  311. :type 'hook)
  312. (defvar org-modules) ; defined below
  313. (defvar org-modules-loaded nil
  314. "Have the modules been loaded already?")
  315. (defun org-load-modules-maybe (&optional force)
  316. "Load all extensions listed in `org-modules'."
  317. (when (or force (not org-modules-loaded))
  318. (mapc (lambda (ext)
  319. (condition-case nil (require ext)
  320. (error (message "Problems while trying to load feature `%s'" ext))))
  321. org-modules)
  322. (setq org-modules-loaded t)))
  323. (defun org-set-modules (var value)
  324. "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
  325. (set var value)
  326. (when (featurep 'org)
  327. (org-load-modules-maybe 'force)))
  328. (defcustom org-modules '(org-w3m org-bbdb org-bibtex org-docview org-gnus org-info org-irc org-mhe org-rmail)
  329. "Modules that should always be loaded together with org.el.
  330. If a description starts with <C>, the file is not part of Emacs
  331. and loading it will require that you have downloaded and properly
  332. installed the Org mode distribution.
  333. You can also use this system to load external packages (i.e. neither Org
  334. core modules, nor modules from the CONTRIB directory). Just add symbols
  335. to the end of the list. If the package is called org-xyz.el, then you need
  336. to add the symbol `xyz', and the package must have a call to:
  337. \(provide 'org-xyz)
  338. For export specific modules, see also `org-export-backends'."
  339. :group 'org
  340. :set 'org-set-modules
  341. :version "24.4"
  342. :package-version '(Org . "8.0")
  343. :type
  344. '(set :greedy t
  345. (const :tag " bbdb: Links to BBDB entries" org-bbdb)
  346. (const :tag " bibtex: Links to BibTeX entries" org-bibtex)
  347. (const :tag " crypt: Encryption of subtrees" org-crypt)
  348. (const :tag " ctags: Access to Emacs tags with links" org-ctags)
  349. (const :tag " docview: Links to doc-view buffers" org-docview)
  350. (const :tag " gnus: Links to GNUS folders/messages" org-gnus)
  351. (const :tag " habit: Track your consistency with habits" org-habit)
  352. (const :tag " id: Global IDs for identifying entries" org-id)
  353. (const :tag " info: Links to Info nodes" org-info)
  354. (const :tag " inlinetask: Tasks independent of outline hierarchy" org-inlinetask)
  355. (const :tag " irc: Links to IRC/ERC chat sessions" org-irc)
  356. (const :tag " mhe: Links to MHE folders/messages" org-mhe)
  357. (const :tag " mouse: Additional mouse support" org-mouse)
  358. (const :tag " protocol: Intercept calls from emacsclient" org-protocol)
  359. (const :tag " rmail: Links to RMAIL folders/messages" org-rmail)
  360. (const :tag " w3m: Special cut/paste from w3m to Org-mode." org-w3m)
  361. (const :tag "C annotate-file: Annotate a file with org syntax" org-annotate-file)
  362. (const :tag "C bookmark: Org-mode links to bookmarks" org-bookmark)
  363. (const :tag "C bullets: Add overlays to headlines stars" org-bullets)
  364. (const :tag "C checklist: Extra functions for checklists in repeated tasks" org-checklist)
  365. (const :tag "C choose: Use TODO keywords to mark decisions states" org-choose)
  366. (const :tag "C collector: Collect properties into tables" org-collector)
  367. (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
  368. (const :tag "C drill: Flashcards and spaced repetition for Org-mode" org-drill)
  369. (const :tag "C elisp-symbol: Org-mode links to emacs-lisp symbols" org-elisp-symbol)
  370. (const :tag "C eshell Support for links to working directories in eshell" org-eshell)
  371. (const :tag "C eval-light: Evaluate inbuffer-code on demand" org-eval-light)
  372. (const :tag "C eval: Include command output as text" org-eval)
  373. (const :tag "C expiry: Expiry mechanism for Org-mode entries" org-expiry)
  374. (const :tag "C favtable: Lookup table of favorite references and links" org-favtable)
  375. (const :tag "C git-link: Provide org links to specific file version" org-git-link)
  376. (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
  377. (const :tag "C invoice: Help manage client invoices in Org-mode" org-invoice)
  378. (const :tag "C jira: Add a jira:ticket protocol to Org-mode" org-jira)
  379. (const :tag "C learn: SuperMemo's incremental learning algorithm" org-learn)
  380. (const :tag "C mac-iCal Imports events from iCal.app to the Emacs diary" org-mac-iCal)
  381. (const :tag "C mac-link: Grab links and url from various mac Applications" org-mac-link)
  382. (const :tag "C mairix: Hook mairix search into Org-mode for different MUAs" org-mairix)
  383. (const :tag "C man: Support for links to manpages in Org-mode" org-man)
  384. (const :tag "C mew: Links to Mew folders/messages" org-mew)
  385. (const :tag "C mtags: Support for muse-like tags" org-mtags)
  386. (const :tag "C notmuch: Provide org links to notmuch searches or messages" org-notmuch)
  387. (const :tag "C panel: Simple routines for us with bad memory" org-panel)
  388. (const :tag "C registry: A registry for Org-mode links" org-registry)
  389. (const :tag "C screen: Visit screen sessions through Org-mode links" org-screen)
  390. (const :tag "C secretary: Team management with org-mode" org-secretary)
  391. (const :tag "C sqlinsert: Convert Org-mode tables to SQL insertions" orgtbl-sqlinsert)
  392. (const :tag "C toc: Table of contents for Org-mode buffer" org-toc)
  393. (const :tag "C track: Keep up with Org-mode development" org-track)
  394. (const :tag "C velocity Something like Notational Velocity for Org" org-velocity)
  395. (const :tag "C vm: Links to VM folders/messages" org-vm)
  396. (const :tag "C wikinodes: CamelCase wiki-like links" org-wikinodes)
  397. (const :tag "C wl: Links to Wanderlust folders/messages" org-wl)
  398. (repeat :tag "External packages" :inline t (symbol :tag "Package"))))
  399. (defvar org-export--registered-backends) ; From ox.el.
  400. (declare-function org-export-derived-backend-p "ox" (backend &rest backends))
  401. (declare-function org-export-backend-name "ox" (backend))
  402. (defcustom org-export-backends '(ascii html icalendar latex)
  403. "List of export back-ends that should be always available.
  404. If a description starts with <C>, the file is not part of Emacs
  405. and loading it will require that you have downloaded and properly
  406. installed the Org mode distribution.
  407. Unlike to `org-modules', libraries in this list will not be
  408. loaded along with Org, but only once the export framework is
  409. needed.
  410. This variable needs to be set before org.el is loaded. If you
  411. need to make a change while Emacs is running, use the customize
  412. interface or run the following code, where VAL stands for the new
  413. value of the variable, after updating it:
  414. \(progn
  415. \(setq org-export--registered-backends
  416. \(org-remove-if-not
  417. \(lambda (backend)
  418. \(let ((name (org-export-backend-name backend)))
  419. \(or (memq name val)
  420. \(catch 'parentp
  421. \(dolist (b val)
  422. \(and (org-export-derived-backend-p b name)
  423. \(throw 'parentp t)))))))
  424. org-export--registered-backends))
  425. \(let ((new-list (mapcar 'org-export-backend-name
  426. org-export--registered-backends)))
  427. \(dolist (backend val)
  428. \(cond
  429. \((not (load (format \"ox-%s\" backend) t t))
  430. \(message \"Problems while trying to load export back-end `%s'\"
  431. backend))
  432. \((not (memq backend new-list)) (push backend new-list))))
  433. \(set-default 'org-export-backends new-list)))
  434. Adding a back-end to this list will also pull the back-end it
  435. depends on, if any."
  436. :group 'org
  437. :group 'org-export
  438. :version "24.4"
  439. :package-version '(Org . "8.0")
  440. :initialize 'custom-initialize-set
  441. :set (lambda (var val)
  442. (if (not (featurep 'ox)) (set-default var val)
  443. ;; Any back-end not required anymore (not present in VAL and not
  444. ;; a parent of any back-end in the new value) is removed from the
  445. ;; list of registered back-ends.
  446. (setq org-export--registered-backends
  447. (org-remove-if-not
  448. (lambda (backend)
  449. (let ((name (org-export-backend-name backend)))
  450. (or (memq name val)
  451. (catch 'parentp
  452. (dolist (b val)
  453. (and (org-export-derived-backend-p b name)
  454. (throw 'parentp t)))))))
  455. org-export--registered-backends))
  456. ;; Now build NEW-LIST of both new back-ends and required
  457. ;; parents.
  458. (let ((new-list (mapcar 'org-export-backend-name
  459. org-export--registered-backends)))
  460. (dolist (backend val)
  461. (cond
  462. ((not (load (format "ox-%s" backend) t t))
  463. (message "Problems while trying to load export back-end `%s'"
  464. backend))
  465. ((not (memq backend new-list)) (push backend new-list))))
  466. ;; Set VAR to that list with fixed dependencies.
  467. (set-default var new-list))))
  468. :type '(set :greedy t
  469. (const :tag " ascii Export buffer to ASCII format" ascii)
  470. (const :tag " beamer Export buffer to Beamer presentation" beamer)
  471. (const :tag " html Export buffer to HTML format" html)
  472. (const :tag " icalendar Export buffer to iCalendar format" icalendar)
  473. (const :tag " latex Export buffer to LaTeX format" latex)
  474. (const :tag " man Export buffer to MAN format" man)
  475. (const :tag " md Export buffer to Markdown format" md)
  476. (const :tag " odt Export buffer to ODT format" odt)
  477. (const :tag " org Export buffer to Org format" org)
  478. (const :tag " texinfo Export buffer to Texinfo format" texinfo)
  479. (const :tag "C confluence Export buffer to Confluence Wiki format" confluence)
  480. (const :tag "C deck Export buffer to deck.js presentations" deck)
  481. (const :tag "C freemind Export buffer to Freemind mindmap format" freemind)
  482. (const :tag "C groff Export buffer to Groff format" groff)
  483. (const :tag "C koma-letter Export buffer to KOMA Scrlttrl2 format" koma-letter)
  484. (const :tag "C RSS 2.0 Export buffer to RSS 2.0 format" rss)
  485. (const :tag "C s5 Export buffer to s5 presentations" s5)
  486. (const :tag "C taskjuggler Export buffer to TaskJuggler format" taskjuggler)))
  487. (eval-after-load 'ox
  488. '(mapc
  489. (lambda (backend)
  490. (condition-case nil (require (intern (format "ox-%s" backend)))
  491. (error (message "Problems while trying to load export back-end `%s'"
  492. backend))))
  493. org-export-backends))
  494. (defcustom org-support-shift-select nil
  495. "Non-nil means make shift-cursor commands select text when possible.
  496. In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
  497. start selecting a region, or enlarge regions started in this way.
  498. In Org-mode, in special contexts, these same keys are used for
  499. other purposes, important enough to compete with shift selection.
  500. Org tries to balance these needs by supporting `shift-select-mode'
  501. outside these special contexts, under control of this variable.
  502. The default of this variable is nil, to avoid confusing behavior. Shifted
  503. cursor keys will then execute Org commands in the following contexts:
  504. - on a headline, changing TODO state (left/right) and priority (up/down)
  505. - on a time stamp, changing the time
  506. - in a plain list item, changing the bullet type
  507. - in a property definition line, switching between allowed values
  508. - in the BEGIN line of a clock table (changing the time block).
  509. Outside these contexts, the commands will throw an error.
  510. When this variable is t and the cursor is not in a special
  511. context, Org-mode will support shift-selection for making and
  512. enlarging regions. To make this more effective, the bullet
  513. cycling will no longer happen anywhere in an item line, but only
  514. if the cursor is exactly on the bullet.
  515. If you set this variable to the symbol `always', then the keys
  516. will not be special in headlines, property lines, and item lines,
  517. to make shift selection work there as well. If this is what you
  518. want, you can use the following alternative commands: `C-c C-t'
  519. and `C-c ,' to change TODO state and priority, `C-u C-u C-c C-t'
  520. can be used to switch TODO sets, `C-c -' to cycle item bullet
  521. types, and properties can be edited by hand or in column view.
  522. However, when the cursor is on a timestamp, shift-cursor commands
  523. will still edit the time stamp - this is just too good to give up.
  524. XEmacs user should have this variable set to nil, because
  525. `shift-select-mode' is in Emacs 23 or later only."
  526. :group 'org
  527. :type '(choice
  528. (const :tag "Never" nil)
  529. (const :tag "When outside special context" t)
  530. (const :tag "Everywhere except timestamps" always)))
  531. (defcustom org-loop-over-headlines-in-active-region nil
  532. "Shall some commands act upon headlines in the active region?
  533. When set to `t', some commands will be performed in all headlines
  534. within the active region.
  535. When set to `start-level', some commands will be performed in all
  536. headlines within the active region, provided that these headlines
  537. are of the same level than the first one.
  538. When set to a string, those commands will be performed on the
  539. matching headlines within the active region. Such string must be
  540. a tags/property/todo match as it is used in the agenda tags view.
  541. The list of commands is: `org-schedule', `org-deadline',
  542. `org-todo', `org-archive-subtree', `org-archive-set-tag' and
  543. `org-archive-to-archive-sibling'. The archiving commands skip
  544. already archived entries."
  545. :type '(choice (const :tag "Don't loop" nil)
  546. (const :tag "All headlines in active region" t)
  547. (const :tag "In active region, headlines at the same level than the first one" 'start-level)
  548. (string :tag "Tags/Property/Todo matcher"))
  549. :version "24.1"
  550. :group 'org-todo
  551. :group 'org-archive)
  552. (defgroup org-startup nil
  553. "Options concerning startup of Org-mode."
  554. :tag "Org Startup"
  555. :group 'org)
  556. (defcustom org-startup-folded t
  557. "Non-nil means entering Org-mode will switch to OVERVIEW.
  558. This can also be configured on a per-file basis by adding one of
  559. the following lines anywhere in the buffer:
  560. #+STARTUP: fold (or `overview', this is equivalent)
  561. #+STARTUP: nofold (or `showall', this is equivalent)
  562. #+STARTUP: content
  563. #+STARTUP: showeverything
  564. By default, this option is ignored when Org opens agenda files
  565. for the first time. If you want the agenda to honor the startup
  566. option, set `org-agenda-inhibit-startup' to nil."
  567. :group 'org-startup
  568. :type '(choice
  569. (const :tag "nofold: show all" nil)
  570. (const :tag "fold: overview" t)
  571. (const :tag "content: all headlines" content)
  572. (const :tag "show everything, even drawers" showeverything)))
  573. (defcustom org-startup-truncated t
  574. "Non-nil means entering Org-mode will set `truncate-lines'.
  575. This is useful since some lines containing links can be very long and
  576. uninteresting. Also tables look terrible when wrapped."
  577. :group 'org-startup
  578. :type 'boolean)
  579. (defcustom org-startup-indented nil
  580. "Non-nil means turn on `org-indent-mode' on startup.
  581. This can also be configured on a per-file basis by adding one of
  582. the following lines anywhere in the buffer:
  583. #+STARTUP: indent
  584. #+STARTUP: noindent"
  585. :group 'org-structure
  586. :type '(choice
  587. (const :tag "Not" nil)
  588. (const :tag "Globally (slow on startup in large files)" t)))
  589. (defcustom org-use-sub-superscripts t
  590. "Non-nil means interpret \"_\" and \"^\" for display.
  591. When this option is turned on, you can use TeX-like syntax for sub- and
  592. superscripts. Several characters after \"_\" or \"^\" will be
  593. considered as a single item - so grouping with {} is normally not
  594. needed. For example, the following things will be parsed as single
  595. sub- or superscripts.
  596. 10^24 or 10^tau several digits will be considered 1 item.
  597. 10^-12 or 10^-tau a leading sign with digits or a word
  598. x^2-y^3 will be read as x^2 - y^3, because items are
  599. terminated by almost any nonword/nondigit char.
  600. x_{i^2} or x^(2-i) braces or parenthesis do grouping.
  601. Still, ambiguity is possible - so when in doubt use {} to enclose
  602. the sub/superscript. If you set this variable to the symbol
  603. `{}', the braces are *required* in order to trigger
  604. interpretations as sub/superscript. This can be helpful in
  605. documents that need \"_\" frequently in plain text."
  606. :group 'org-startup
  607. :version "24.1"
  608. :type '(choice
  609. (const :tag "Always interpret" t)
  610. (const :tag "Only with braces" {})
  611. (const :tag "Never interpret" nil)))
  612. (defcustom org-startup-with-beamer-mode nil
  613. "Non-nil means turn on `org-beamer-mode' on startup.
  614. This can also be configured on a per-file basis by adding one of
  615. the following lines anywhere in the buffer:
  616. #+STARTUP: beamer"
  617. :group 'org-startup
  618. :version "24.1"
  619. :type 'boolean)
  620. (defcustom org-startup-align-all-tables nil
  621. "Non-nil means align all tables when visiting a file.
  622. This is useful when the column width in tables is forced with <N> cookies
  623. in table fields. Such tables will look correct only after the first re-align.
  624. This can also be configured on a per-file basis by adding one of
  625. the following lines anywhere in the buffer:
  626. #+STARTUP: align
  627. #+STARTUP: noalign"
  628. :group 'org-startup
  629. :type 'boolean)
  630. (defcustom org-startup-with-inline-images nil
  631. "Non-nil means show inline images when loading a new Org file.
  632. This can also be configured on a per-file basis by adding one of
  633. the following lines anywhere in the buffer:
  634. #+STARTUP: inlineimages
  635. #+STARTUP: noinlineimages"
  636. :group 'org-startup
  637. :version "24.1"
  638. :type 'boolean)
  639. (defcustom org-startup-with-latex-preview nil
  640. "Non-nil means preview LaTeX fragments when loading a new Org file.
  641. This can also be configured on a per-file basis by adding one of
  642. the followinglines anywhere in the buffer:
  643. #+STARTUP: latexpreview
  644. #+STARTUP: nolatexpreview"
  645. :group 'org-startup
  646. :version "24.4"
  647. :package-version '(Org . "8.0")
  648. :type 'boolean)
  649. (defcustom org-insert-mode-line-in-empty-file nil
  650. "Non-nil means insert the first line setting Org-mode in empty files.
  651. When the function `org-mode' is called interactively in an empty file, this
  652. normally means that the file name does not automatically trigger Org-mode.
  653. To ensure that the file will always be in Org-mode in the future, a
  654. line enforcing Org-mode will be inserted into the buffer, if this option
  655. has been set."
  656. :group 'org-startup
  657. :type 'boolean)
  658. (defcustom org-replace-disputed-keys nil
  659. "Non-nil means use alternative key bindings for some keys.
  660. Org-mode uses S-<cursor> keys for changing timestamps and priorities.
  661. These keys are also used by other packages like shift-selection-mode'
  662. \(built into Emacs 23), `CUA-mode' or `windmove.el'.
  663. If you want to use Org-mode together with one of these other modes,
  664. or more generally if you would like to move some Org-mode commands to
  665. other keys, set this variable and configure the keys with the variable
  666. `org-disputed-keys'.
  667. This option is only relevant at load-time of Org-mode, and must be set
  668. *before* org.el is loaded. Changing it requires a restart of Emacs to
  669. become effective."
  670. :group 'org-startup
  671. :type 'boolean)
  672. (defcustom org-use-extra-keys nil
  673. "Non-nil means use extra key sequence definitions for certain commands.
  674. This happens automatically if you run XEmacs or if `window-system'
  675. is nil. This variable lets you do the same manually. You must
  676. set it before loading org.
  677. Example: on Carbon Emacs 22 running graphically, with an external
  678. keyboard on a Powerbook, the default way of setting M-left might
  679. not work for either Alt or ESC. Setting this variable will make
  680. it work for ESC."
  681. :group 'org-startup
  682. :type 'boolean)
  683. (org-defvaralias 'org-CUA-compatible 'org-replace-disputed-keys)
  684. (defcustom org-disputed-keys
  685. '(([(shift up)] . [(meta p)])
  686. ([(shift down)] . [(meta n)])
  687. ([(shift left)] . [(meta -)])
  688. ([(shift right)] . [(meta +)])
  689. ([(control shift right)] . [(meta shift +)])
  690. ([(control shift left)] . [(meta shift -)]))
  691. "Keys for which Org-mode and other modes compete.
  692. This is an alist, cars are the default keys, second element specifies
  693. the alternative to use when `org-replace-disputed-keys' is t.
  694. Keys can be specified in any syntax supported by `define-key'.
  695. The value of this option takes effect only at Org-mode's startup,
  696. therefore you'll have to restart Emacs to apply it after changing."
  697. :group 'org-startup
  698. :type 'alist)
  699. (defun org-key (key)
  700. "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
  701. Or return the original if not disputed.
  702. Also apply the translations defined in `org-xemacs-key-equivalents'."
  703. (when org-replace-disputed-keys
  704. (let* ((nkey (key-description key))
  705. (x (org-find-if (lambda (x)
  706. (equal (key-description (car x)) nkey))
  707. org-disputed-keys)))
  708. (setq key (if x (cdr x) key))))
  709. (when (featurep 'xemacs)
  710. (setq key (or (cdr (assoc key org-xemacs-key-equivalents)) key)))
  711. key)
  712. (defun org-find-if (predicate seq)
  713. (catch 'exit
  714. (while seq
  715. (if (funcall predicate (car seq))
  716. (throw 'exit (car seq))
  717. (pop seq)))))
  718. (defun org-defkey (keymap key def)
  719. "Define a key, possibly translated, as returned by `org-key'."
  720. (define-key keymap (org-key key) def))
  721. (defcustom org-ellipsis nil
  722. "The ellipsis to use in the Org-mode outline.
  723. When nil, just use the standard three dots. When a string, use that instead,
  724. When a face, use the standard 3 dots, but with the specified face.
  725. The change affects only Org-mode (which will then use its own display table).
  726. Changing this requires executing `M-x org-mode' in a buffer to become
  727. effective."
  728. :group 'org-startup
  729. :type '(choice (const :tag "Default" nil)
  730. (face :tag "Face" :value org-warning)
  731. (string :tag "String" :value "...#")))
  732. (defvar org-display-table nil
  733. "The display table for org-mode, in case `org-ellipsis' is non-nil.")
  734. (defgroup org-keywords nil
  735. "Keywords in Org-mode."
  736. :tag "Org Keywords"
  737. :group 'org)
  738. (defcustom org-deadline-string "DEADLINE:"
  739. "String to mark deadline entries.
  740. A deadline is this string, followed by a time stamp. Should be a word,
  741. terminated by a colon. You can insert a schedule keyword and
  742. a timestamp with \\[org-deadline].
  743. Changes become only effective after restarting Emacs."
  744. :group 'org-keywords
  745. :type 'string)
  746. (defcustom org-scheduled-string "SCHEDULED:"
  747. "String to mark scheduled TODO entries.
  748. A schedule is this string, followed by a time stamp. Should be a word,
  749. terminated by a colon. You can insert a schedule keyword and
  750. a timestamp with \\[org-schedule].
  751. Changes become only effective after restarting Emacs."
  752. :group 'org-keywords
  753. :type 'string)
  754. (defcustom org-closed-string "CLOSED:"
  755. "String used as the prefix for timestamps logging closing a TODO entry."
  756. :group 'org-keywords
  757. :type 'string)
  758. (defcustom org-clock-string "CLOCK:"
  759. "String used as prefix for timestamps clocking work hours on an item."
  760. :group 'org-keywords
  761. :type 'string)
  762. (defcustom org-closed-keep-when-no-todo nil
  763. "Remove CLOSED: time-stamp when switching back to a non-todo state?"
  764. :group 'org-todo
  765. :group 'org-keywords
  766. :version "24.4"
  767. :package-version '(Org . "8.0")
  768. :type 'boolean)
  769. (defconst org-planning-or-clock-line-re (concat "^[ \t]*\\("
  770. org-scheduled-string "\\|"
  771. org-deadline-string "\\|"
  772. org-closed-string "\\|"
  773. org-clock-string "\\)")
  774. "Matches a line with planning or clock info.")
  775. (defcustom org-comment-string "COMMENT"
  776. "Entries starting with this keyword will never be exported.
  777. An entry can be toggled between COMMENT and normal with
  778. \\[org-toggle-comment].
  779. Changes become only effective after restarting Emacs."
  780. :group 'org-keywords
  781. :type 'string)
  782. (defcustom org-quote-string "QUOTE"
  783. "Entries starting with this keyword will be exported in fixed-width font.
  784. Quoting applies only to the text in the entry following the headline, and does
  785. not extend beyond the next headline, even if that is lower level.
  786. An entry can be toggled between QUOTE and normal with
  787. \\[org-toggle-fixed-width-section]."
  788. :group 'org-keywords
  789. :type 'string)
  790. (defconst org-repeat-re
  791. "<[0-9]\\{4\\}-[0-9][0-9]-[0-9][0-9] [^>\n]*?\\([.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)"
  792. "Regular expression for specifying repeated events.
  793. After a match, group 1 contains the repeat expression.")
  794. (defgroup org-structure nil
  795. "Options concerning the general structure of Org-mode files."
  796. :tag "Org Structure"
  797. :group 'org)
  798. (defgroup org-reveal-location nil
  799. "Options about how to make context of a location visible."
  800. :tag "Org Reveal Location"
  801. :group 'org-structure)
  802. (defconst org-context-choice
  803. '(choice
  804. (const :tag "Always" t)
  805. (const :tag "Never" nil)
  806. (repeat :greedy t :tag "Individual contexts"
  807. (cons
  808. (choice :tag "Context"
  809. (const agenda)
  810. (const org-goto)
  811. (const occur-tree)
  812. (const tags-tree)
  813. (const link-search)
  814. (const mark-goto)
  815. (const bookmark-jump)
  816. (const isearch)
  817. (const default))
  818. (boolean))))
  819. "Contexts for the reveal options.")
  820. (defcustom org-show-hierarchy-above '((default . t))
  821. "Non-nil means show full hierarchy when revealing a location.
  822. Org-mode often shows locations in an org-mode file which might have
  823. been invisible before. When this is set, the hierarchy of headings
  824. above the exposed location is shown.
  825. Turning this off for example for sparse trees makes them very compact.
  826. Instead of t, this can also be an alist specifying this option for different
  827. contexts. Valid contexts are
  828. agenda when exposing an entry from the agenda
  829. org-goto when using the command `org-goto' on key C-c C-j
  830. occur-tree when using the command `org-occur' on key C-c /
  831. tags-tree when constructing a sparse tree based on tags matches
  832. link-search when exposing search matches associated with a link
  833. mark-goto when exposing the jump goal of a mark
  834. bookmark-jump when exposing a bookmark location
  835. isearch when exiting from an incremental search
  836. default default for all contexts not set explicitly"
  837. :group 'org-reveal-location
  838. :type org-context-choice)
  839. (defcustom org-show-following-heading '((default . nil))
  840. "Non-nil means show following heading when revealing a location.
  841. Org-mode often shows locations in an org-mode file which might have
  842. been invisible before. When this is set, the heading following the
  843. match is shown.
  844. Turning this off for example for sparse trees makes them very compact,
  845. but makes it harder to edit the location of the match. In such a case,
  846. use the command \\[org-reveal] to show more context.
  847. Instead of t, this can also be an alist specifying this option for different
  848. contexts. See `org-show-hierarchy-above' for valid contexts."
  849. :group 'org-reveal-location
  850. :type org-context-choice)
  851. (defcustom org-show-siblings '((default . nil) (isearch t) (bookmark-jump t))
  852. "Non-nil means show all sibling heading when revealing a location.
  853. Org-mode often shows locations in an org-mode file which might have
  854. been invisible before. When this is set, the sibling of the current entry
  855. heading are all made visible. If `org-show-hierarchy-above' is t,
  856. the same happens on each level of the hierarchy above the current entry.
  857. By default this is on for the isearch context, off for all other contexts.
  858. Turning this off for example for sparse trees makes them very compact,
  859. but makes it harder to edit the location of the match. In such a case,
  860. use the command \\[org-reveal] to show more context.
  861. Instead of t, this can also be an alist specifying this option for different
  862. contexts. See `org-show-hierarchy-above' for valid contexts."
  863. :group 'org-reveal-location
  864. :type org-context-choice
  865. :version "24.4"
  866. :package-version '(Org . "8.0"))
  867. (defcustom org-show-entry-below '((default . nil))
  868. "Non-nil means show the entry below a headline when revealing a location.
  869. Org-mode often shows locations in an org-mode file which might have
  870. been invisible before. When this is set, the text below the headline that is
  871. exposed is also shown.
  872. By default this is off for all contexts.
  873. Instead of t, this can also be an alist specifying this option for different
  874. contexts. See `org-show-hierarchy-above' for valid contexts."
  875. :group 'org-reveal-location
  876. :type org-context-choice)
  877. (defcustom org-indirect-buffer-display 'other-window
  878. "How should indirect tree buffers be displayed?
  879. This applies to indirect buffers created with the commands
  880. \\[org-tree-to-indirect-buffer] and \\[org-agenda-tree-to-indirect-buffer].
  881. Valid values are:
  882. current-window Display in the current window
  883. other-window Just display in another window.
  884. dedicated-frame Create one new frame, and re-use it each time.
  885. new-frame Make a new frame each time. Note that in this case
  886. previously-made indirect buffers are kept, and you need to
  887. kill these buffers yourself."
  888. :group 'org-structure
  889. :group 'org-agenda-windows
  890. :type '(choice
  891. (const :tag "In current window" current-window)
  892. (const :tag "In current frame, other window" other-window)
  893. (const :tag "Each time a new frame" new-frame)
  894. (const :tag "One dedicated frame" dedicated-frame)))
  895. (defcustom org-use-speed-commands nil
  896. "Non-nil means activate single letter commands at beginning of a headline.
  897. This may also be a function to test for appropriate locations where speed
  898. commands should be active."
  899. :group 'org-structure
  900. :type '(choice
  901. (const :tag "Never" nil)
  902. (const :tag "At beginning of headline stars" t)
  903. (function)))
  904. (defcustom org-speed-commands-user nil
  905. "Alist of additional speed commands.
  906. This list will be checked before `org-speed-commands-default'
  907. when the variable `org-use-speed-commands' is non-nil
  908. and when the cursor is at the beginning of a headline.
  909. The car if each entry is a string with a single letter, which must
  910. be assigned to `self-insert-command' in the global map.
  911. The cdr is either a command to be called interactively, a function
  912. to be called, or a form to be evaluated.
  913. An entry that is just a list with a single string will be interpreted
  914. as a descriptive headline that will be added when listing the speed
  915. commands in the Help buffer using the `?' speed command."
  916. :group 'org-structure
  917. :type '(repeat :value ("k" . ignore)
  918. (choice :value ("k" . ignore)
  919. (list :tag "Descriptive Headline" (string :tag "Headline"))
  920. (cons :tag "Letter and Command"
  921. (string :tag "Command letter")
  922. (choice
  923. (function)
  924. (sexp))))))
  925. (defcustom org-bookmark-names-plist
  926. '(:last-capture "org-capture-last-stored"
  927. :last-refile "org-refile-last-stored"
  928. :last-capture-marker "org-capture-last-stored-marker")
  929. "Names for bookmarks automatically set by some Org commands.
  930. This can provide strings as names for a number of bookmakrs Org sets
  931. automatically. The following keys are currently implemented:
  932. :last-capture
  933. :last-capture-marker
  934. :last-refile
  935. When a key does not show up in the property list, the corresponding bookmark
  936. is not set."
  937. :group 'org-structure
  938. :type 'plist)
  939. (defgroup org-cycle nil
  940. "Options concerning visibility cycling in Org-mode."
  941. :tag "Org Cycle"
  942. :group 'org-structure)
  943. (defcustom org-cycle-skip-children-state-if-no-children t
  944. "Non-nil means skip CHILDREN state in entries that don't have any."
  945. :group 'org-cycle
  946. :type 'boolean)
  947. (defcustom org-cycle-max-level nil
  948. "Maximum level which should still be subject to visibility cycling.
  949. Levels higher than this will, for cycling, be treated as text, not a headline.
  950. When `org-odd-levels-only' is set, a value of N in this variable actually
  951. means 2N-1 stars as the limiting headline.
  952. When nil, cycle all levels.
  953. Note that the limiting level of cycling is also influenced by
  954. `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
  955. `org-inlinetask-min-level' is, cycling will be limited to levels one less
  956. than its value."
  957. :group 'org-cycle
  958. :type '(choice
  959. (const :tag "No limit" nil)
  960. (integer :tag "Maximum level")))
  961. (defcustom org-drawers '("PROPERTIES" "CLOCK" "LOGBOOK" "RESULTS")
  962. "Names of drawers. Drawers are not opened by cycling on the headline above.
  963. Drawers only open with a TAB on the drawer line itself. A drawer looks like
  964. this:
  965. :DRAWERNAME:
  966. .....
  967. :END:
  968. The drawer \"PROPERTIES\" is special for capturing properties through
  969. the property API.
  970. Drawers can be defined on the per-file basis with a line like:
  971. #+DRAWERS: HIDDEN STATE PROPERTIES"
  972. :group 'org-structure
  973. :group 'org-cycle
  974. :type '(repeat (string :tag "Drawer Name")))
  975. (defcustom org-hide-block-startup nil
  976. "Non-nil means entering Org-mode will fold all blocks.
  977. This can also be set in on a per-file basis with
  978. #+STARTUP: hideblocks
  979. #+STARTUP: showblocks"
  980. :group 'org-startup
  981. :group 'org-cycle
  982. :type 'boolean)
  983. (defcustom org-cycle-global-at-bob nil
  984. "Cycle globally if cursor is at beginning of buffer and not at a headline.
  985. This makes it possible to do global cycling without having to use S-TAB or
  986. \\[universal-argument] TAB. For this special case to work, the first line
  987. of the buffer must not be a headline -- it may be empty or some other text.
  988. When used in this way, `org-cycle-hook' is disabled temporarily to make
  989. sure the cursor stays at the beginning of the buffer. When this option is
  990. nil, don't do anything special at the beginning of the buffer."
  991. :group 'org-cycle
  992. :type 'boolean)
  993. (defcustom org-cycle-level-after-item/entry-creation t
  994. "Non-nil means cycle entry level or item indentation in new empty entries.
  995. When the cursor is at the end of an empty headline, i.e., with only stars
  996. and maybe a TODO keyword, TAB will then switch the entry to become a child,
  997. and then all possible ancestor states, before returning to the original state.
  998. This makes data entry extremely fast: M-RET to create a new headline,
  999. on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
  1000. When the cursor is at the end of an empty plain list item, one TAB will
  1001. make it a subitem, two or more tabs will back up to make this an item
  1002. higher up in the item hierarchy."
  1003. :group 'org-cycle
  1004. :type 'boolean)
  1005. (defcustom org-cycle-emulate-tab t
  1006. "Where should `org-cycle' emulate TAB.
  1007. nil Never
  1008. white Only in completely white lines
  1009. whitestart Only at the beginning of lines, before the first non-white char
  1010. t Everywhere except in headlines
  1011. exc-hl-bol Everywhere except at the start of a headline
  1012. If TAB is used in a place where it does not emulate TAB, the current subtree
  1013. visibility is cycled."
  1014. :group 'org-cycle
  1015. :type '(choice (const :tag "Never" nil)
  1016. (const :tag "Only in completely white lines" white)
  1017. (const :tag "Before first char in a line" whitestart)
  1018. (const :tag "Everywhere except in headlines" t)
  1019. (const :tag "Everywhere except at bol in headlines" exc-hl-bol)))
  1020. (defcustom org-cycle-separator-lines 2
  1021. "Number of empty lines needed to keep an empty line between collapsed trees.
  1022. If you leave an empty line between the end of a subtree and the following
  1023. headline, this empty line is hidden when the subtree is folded.
  1024. Org-mode will leave (exactly) one empty line visible if the number of
  1025. empty lines is equal or larger to the number given in this variable.
  1026. So the default 2 means at least 2 empty lines after the end of a subtree
  1027. are needed to produce free space between a collapsed subtree and the
  1028. following headline.
  1029. If the number is negative, and the number of empty lines is at least -N,
  1030. all empty lines are shown.
  1031. Special case: when 0, never leave empty lines in collapsed view."
  1032. :group 'org-cycle
  1033. :type 'integer)
  1034. (put 'org-cycle-separator-lines 'safe-local-variable 'integerp)
  1035. (defcustom org-pre-cycle-hook nil
  1036. "Hook that is run before visibility cycling is happening.
  1037. The function(s) in this hook must accept a single argument which indicates
  1038. the new state that will be set right after running this hook. The
  1039. argument is a symbol. Before a global state change, it can have the values
  1040. `overview', `content', or `all'. Before a local state change, it can have
  1041. the values `folded', `children', or `subtree'."
  1042. :group 'org-cycle
  1043. :type 'hook)
  1044. (defcustom org-cycle-hook '(org-cycle-hide-archived-subtrees
  1045. org-cycle-hide-drawers
  1046. org-cycle-hide-inline-tasks
  1047. org-cycle-show-empty-lines
  1048. org-optimize-window-after-visibility-change)
  1049. "Hook that is run after `org-cycle' has changed the buffer visibility.
  1050. The function(s) in this hook must accept a single argument which indicates
  1051. the new state that was set by the most recent `org-cycle' command. The
  1052. argument is a symbol. After a global state change, it can have the values
  1053. `overview', `contents', or `all'. After a local state change, it can have
  1054. the values `folded', `children', or `subtree'."
  1055. :group 'org-cycle
  1056. :type 'hook)
  1057. (defgroup org-edit-structure nil
  1058. "Options concerning structure editing in Org-mode."
  1059. :tag "Org Edit Structure"
  1060. :group 'org-structure)
  1061. (defcustom org-odd-levels-only nil
  1062. "Non-nil means skip even levels and only use odd levels for the outline.
  1063. This has the effect that two stars are being added/taken away in
  1064. promotion/demotion commands. It also influences how levels are
  1065. handled by the exporters.
  1066. Changing it requires restart of `font-lock-mode' to become effective
  1067. for fontification also in regions already fontified.
  1068. You may also set this on a per-file basis by adding one of the following
  1069. lines to the buffer:
  1070. #+STARTUP: odd
  1071. #+STARTUP: oddeven"
  1072. :group 'org-edit-structure
  1073. :group 'org-appearance
  1074. :type 'boolean)
  1075. (defcustom org-adapt-indentation t
  1076. "Non-nil means adapt indentation to outline node level.
  1077. When this variable is set, Org assumes that you write outlines by
  1078. indenting text in each node to align with the headline (after the stars).
  1079. The following issues are influenced by this variable:
  1080. - When this is set and the *entire* text in an entry is indented, the
  1081. indentation is increased by one space in a demotion command, and
  1082. decreased by one in a promotion command. If any line in the entry
  1083. body starts with text at column 0, indentation is not changed at all.
  1084. - Property drawers and planning information is inserted indented when
  1085. this variable s set. When nil, they will not be indented.
  1086. - TAB indents a line relative to context. The lines below a headline
  1087. will be indented when this variable is set.
  1088. Note that this is all about true indentation, by adding and removing
  1089. space characters. See also `org-indent.el' which does level-dependent
  1090. indentation in a virtual way, i.e. at display time in Emacs."
  1091. :group 'org-edit-structure
  1092. :type 'boolean)
  1093. (defcustom org-special-ctrl-a/e nil
  1094. "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
  1095. When t, `C-a' will bring back the cursor to the beginning of the
  1096. headline text, i.e. after the stars and after a possible TODO
  1097. keyword. In an item, this will be the position after bullet and
  1098. check-box, if any. When the cursor is already at that position,
  1099. another `C-a' will bring it to the beginning of the line.
  1100. `C-e' will jump to the end of the headline, ignoring the presence
  1101. of tags in the headline. A second `C-e' will then jump to the
  1102. true end of the line, after any tags. This also means that, when
  1103. this variable is non-nil, `C-e' also will never jump beyond the
  1104. end of the heading of a folded section, i.e. not after the
  1105. ellipses.
  1106. When set to the symbol `reversed', the first `C-a' or `C-e' works
  1107. normally, going to the true line boundary first. Only a directly
  1108. following, identical keypress will bring the cursor to the
  1109. special positions.
  1110. This may also be a cons cell where the behavior for `C-a' and
  1111. `C-e' is set separately."
  1112. :group 'org-edit-structure
  1113. :type '(choice
  1114. (const :tag "off" nil)
  1115. (const :tag "on: after stars/bullet and before tags first" t)
  1116. (const :tag "reversed: true line boundary first" reversed)
  1117. (cons :tag "Set C-a and C-e separately"
  1118. (choice :tag "Special C-a"
  1119. (const :tag "off" nil)
  1120. (const :tag "on: after stars/bullet first" t)
  1121. (const :tag "reversed: before stars/bullet first" reversed))
  1122. (choice :tag "Special C-e"
  1123. (const :tag "off" nil)
  1124. (const :tag "on: before tags first" t)
  1125. (const :tag "reversed: after tags first" reversed)))))
  1126. (org-defvaralias 'org-special-ctrl-a 'org-special-ctrl-a/e)
  1127. (defcustom org-special-ctrl-k nil
  1128. "Non-nil means `C-k' will behave specially in headlines.
  1129. When nil, `C-k' will call the default `kill-line' command.
  1130. When t, the following will happen while the cursor is in the headline:
  1131. - When the cursor is at the beginning of a headline, kill the entire
  1132. line and possible the folded subtree below the line.
  1133. - When in the middle of the headline text, kill the headline up to the tags.
  1134. - When after the headline text, kill the tags."
  1135. :group 'org-edit-structure
  1136. :type 'boolean)
  1137. (defcustom org-ctrl-k-protect-subtree nil
  1138. "Non-nil means, do not delete a hidden subtree with C-k.
  1139. When set to the symbol `error', simply throw an error when C-k is
  1140. used to kill (part-of) a headline that has hidden text behind it.
  1141. Any other non-nil value will result in a query to the user, if it is
  1142. OK to kill that hidden subtree. When nil, kill without remorse."
  1143. :group 'org-edit-structure
  1144. :version "24.1"
  1145. :type '(choice
  1146. (const :tag "Do not protect hidden subtrees" nil)
  1147. (const :tag "Protect hidden subtrees with a security query" t)
  1148. (const :tag "Never kill a hidden subtree with C-k" error)))
  1149. (defcustom org-special-ctrl-o t
  1150. "Non-nil means, make `C-o' insert a row in tables."
  1151. :group 'org-edit-structure
  1152. :type 'boolean)
  1153. (defcustom org-catch-invisible-edits nil
  1154. "Check if in invisible region before inserting or deleting a character.
  1155. Valid values are:
  1156. nil Do not check, so just do invisible edits.
  1157. error Throw an error and do nothing.
  1158. show Make point visible, and do the requested edit.
  1159. show-and-error Make point visible, then throw an error and abort the edit.
  1160. smart Make point visible, and do insertion/deletion if it is
  1161. adjacent to visible text and the change feels predictable.
  1162. Never delete a previously invisible character or add in the
  1163. middle or right after an invisible region. Basically, this
  1164. allows insertion and backward-delete right before ellipses.
  1165. FIXME: maybe in this case we should not even show?"
  1166. :group 'org-edit-structure
  1167. :version "24.1"
  1168. :type '(choice
  1169. (const :tag "Do not check" nil)
  1170. (const :tag "Throw error when trying to edit" error)
  1171. (const :tag "Unhide, but do not do the edit" show-and-error)
  1172. (const :tag "Show invisible part and do the edit" show)
  1173. (const :tag "Be smart and do the right thing" smart)))
  1174. (defcustom org-yank-folded-subtrees t
  1175. "Non-nil means when yanking subtrees, fold them.
  1176. If the kill is a single subtree, or a sequence of subtrees, i.e. if
  1177. it starts with a heading and all other headings in it are either children
  1178. or siblings, then fold all the subtrees. However, do this only if no
  1179. text after the yank would be swallowed into a folded tree by this action."
  1180. :group 'org-edit-structure
  1181. :type 'boolean)
  1182. (defcustom org-yank-adjusted-subtrees nil
  1183. "Non-nil means when yanking subtrees, adjust the level.
  1184. With this setting, `org-paste-subtree' is used to insert the subtree, see
  1185. this function for details."
  1186. :group 'org-edit-structure
  1187. :type 'boolean)
  1188. (defcustom org-M-RET-may-split-line '((default . t))
  1189. "Non-nil means M-RET will split the line at the cursor position.
  1190. When nil, it will go to the end of the line before making a
  1191. new line.
  1192. You may also set this option in a different way for different
  1193. contexts. Valid contexts are:
  1194. headline when creating a new headline
  1195. item when creating a new item
  1196. table in a table field
  1197. default the value to be used for all contexts not explicitly
  1198. customized"
  1199. :group 'org-structure
  1200. :group 'org-table
  1201. :type '(choice
  1202. (const :tag "Always" t)
  1203. (const :tag "Never" nil)
  1204. (repeat :greedy t :tag "Individual contexts"
  1205. (cons
  1206. (choice :tag "Context"
  1207. (const headline)
  1208. (const item)
  1209. (const table)
  1210. (const default))
  1211. (boolean)))))
  1212. (defcustom org-insert-heading-respect-content nil
  1213. "Non-nil means insert new headings after the current subtree.
  1214. When nil, the new heading is created directly after the current line.
  1215. The commands \\[org-insert-heading-respect-content] and \\[org-insert-todo-heading-respect-content] turn
  1216. this variable on for the duration of the command."
  1217. :group 'org-structure
  1218. :type 'boolean)
  1219. (defcustom org-blank-before-new-entry '((heading . auto)
  1220. (plain-list-item . auto))
  1221. "Should `org-insert-heading' leave a blank line before new heading/item?
  1222. The value is an alist, with `heading' and `plain-list-item' as CAR,
  1223. and a boolean flag as CDR. The cdr may also be the symbol `auto', in
  1224. which case Org will look at the surrounding headings/items and try to
  1225. make an intelligent decision whether to insert a blank line or not.
  1226. For plain lists, if `org-list-empty-line-terminates-plain-lists' is set,
  1227. the setting here is ignored and no empty line is inserted to avoid breaking
  1228. the list structure."
  1229. :group 'org-edit-structure
  1230. :type '(list
  1231. (cons (const heading)
  1232. (choice (const :tag "Never" nil)
  1233. (const :tag "Always" t)
  1234. (const :tag "Auto" auto)))
  1235. (cons (const plain-list-item)
  1236. (choice (const :tag "Never" nil)
  1237. (const :tag "Always" t)
  1238. (const :tag "Auto" auto)))))
  1239. (defcustom org-insert-heading-hook nil
  1240. "Hook being run after inserting a new heading."
  1241. :group 'org-edit-structure
  1242. :type 'hook)
  1243. (defcustom org-enable-fixed-width-editor t
  1244. "Non-nil means lines starting with \":\" are treated as fixed-width.
  1245. This currently only means they are never auto-wrapped.
  1246. When nil, such lines will be treated like ordinary lines.
  1247. See also the QUOTE keyword."
  1248. :group 'org-edit-structure
  1249. :type 'boolean)
  1250. (defcustom org-goto-auto-isearch t
  1251. "Non-nil means typing characters in `org-goto' starts incremental search.
  1252. When nil, you can use these keybindings to navigate the buffer:
  1253. q Quit the org-goto interface
  1254. n Go to the next visible heading
  1255. p Go to the previous visible heading
  1256. f Go one heading forward on same level
  1257. b Go one heading backward on same level
  1258. u Go one heading up"
  1259. :group 'org-edit-structure
  1260. :type 'boolean)
  1261. (defgroup org-sparse-trees nil
  1262. "Options concerning sparse trees in Org-mode."
  1263. :tag "Org Sparse Trees"
  1264. :group 'org-structure)
  1265. (defcustom org-highlight-sparse-tree-matches t
  1266. "Non-nil means highlight all matches that define a sparse tree.
  1267. The highlights will automatically disappear the next time the buffer is
  1268. changed by an edit command."
  1269. :group 'org-sparse-trees
  1270. :type 'boolean)
  1271. (defcustom org-remove-highlights-with-change t
  1272. "Non-nil means any change to the buffer will remove temporary highlights.
  1273. Such highlights are created by `org-occur' and `org-clock-display'.
  1274. When nil, `C-c C-c needs to be used to get rid of the highlights.
  1275. The highlights created by `org-preview-latex-fragment' always need
  1276. `C-c C-c' to be removed."
  1277. :group 'org-sparse-trees
  1278. :group 'org-time
  1279. :type 'boolean)
  1280. (defcustom org-occur-hook '(org-first-headline-recenter)
  1281. "Hook that is run after `org-occur' has constructed a sparse tree.
  1282. This can be used to recenter the window to show as much of the structure
  1283. as possible."
  1284. :group 'org-sparse-trees
  1285. :type 'hook)
  1286. (defgroup org-imenu-and-speedbar nil
  1287. "Options concerning imenu and speedbar in Org-mode."
  1288. :tag "Org Imenu and Speedbar"
  1289. :group 'org-structure)
  1290. (defcustom org-imenu-depth 2
  1291. "The maximum level for Imenu access to Org-mode headlines.
  1292. This also applied for speedbar access."
  1293. :group 'org-imenu-and-speedbar
  1294. :type 'integer)
  1295. (defgroup org-table nil
  1296. "Options concerning tables in Org-mode."
  1297. :tag "Org Table"
  1298. :group 'org)
  1299. (defcustom org-enable-table-editor 'optimized
  1300. "Non-nil means lines starting with \"|\" are handled by the table editor.
  1301. When nil, such lines will be treated like ordinary lines.
  1302. When equal to the symbol `optimized', the table editor will be optimized to
  1303. do the following:
  1304. - Automatic overwrite mode in front of whitespace in table fields.
  1305. This makes the structure of the table stay in tact as long as the edited
  1306. field does not exceed the column width.
  1307. - Minimize the number of realigns. Normally, the table is aligned each time
  1308. TAB or RET are pressed to move to another field. With optimization this
  1309. happens only if changes to a field might have changed the column width.
  1310. Optimization requires replacing the functions `self-insert-command',
  1311. `delete-char', and `backward-delete-char' in Org-mode buffers, with a
  1312. slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
  1313. very good at guessing when a re-align will be necessary, but you can always
  1314. force one with \\[org-ctrl-c-ctrl-c].
  1315. If you would like to use the optimized version in Org-mode, but the
  1316. un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
  1317. This variable can be used to turn on and off the table editor during a session,
  1318. but in order to toggle optimization, a restart is required.
  1319. See also the variable `org-table-auto-blank-field'."
  1320. :group 'org-table
  1321. :type '(choice
  1322. (const :tag "off" nil)
  1323. (const :tag "on" t)
  1324. (const :tag "on, optimized" optimized)))
  1325. (defcustom org-self-insert-cluster-for-undo (or (featurep 'xemacs)
  1326. (version<= emacs-version "24.1"))
  1327. "Non-nil means cluster self-insert commands for undo when possible.
  1328. If this is set, then, like in the Emacs command loop, 20 consecutive
  1329. characters will be undone together.
  1330. This is configurable, because there is some impact on typing performance."
  1331. :group 'org-table
  1332. :type 'boolean)
  1333. (defcustom org-table-tab-recognizes-table.el t
  1334. "Non-nil means TAB will automatically notice a table.el table.
  1335. When it sees such a table, it moves point into it and - if necessary -
  1336. calls `table-recognize-table'."
  1337. :group 'org-table-editing
  1338. :type 'boolean)
  1339. (defgroup org-link nil
  1340. "Options concerning links in Org-mode."
  1341. :tag "Org Link"
  1342. :group 'org)
  1343. (defvar org-link-abbrev-alist-local nil
  1344. "Buffer-local version of `org-link-abbrev-alist', which see.
  1345. The value of this is taken from the #+LINK lines.")
  1346. (make-variable-buffer-local 'org-link-abbrev-alist-local)
  1347. (defcustom org-link-abbrev-alist nil
  1348. "Alist of link abbreviations.
  1349. The car of each element is a string, to be replaced at the start of a link.
  1350. The cdrs are replacement values, like (\"linkkey\" . REPLACE). Abbreviated
  1351. links in Org-mode buffers can have an optional tag after a double colon, e.g.
  1352. [[linkkey:tag][description]]
  1353. The 'linkkey' must be a word word, starting with a letter, followed
  1354. by letters, numbers, '-' or '_'.
  1355. If REPLACE is a string, the tag will simply be appended to create the link.
  1356. If the string contains \"%s\", the tag will be inserted there. If the string
  1357. contains \"%h\", it will cause a url-encoded version of the tag to be inserted
  1358. at that point (see the function `url-hexify-string'). If the string contains
  1359. the specifier \"%(my-function)\", then the custom function `my-function' will
  1360. be invoked: this function takes the tag as its only argument and must return
  1361. a string.
  1362. REPLACE may also be a function that will be called with the tag as the
  1363. only argument to create the link, which should be returned as a string.
  1364. See the manual for examples."
  1365. :group 'org-link
  1366. :type '(repeat
  1367. (cons
  1368. (string :tag "Protocol")
  1369. (choice
  1370. (string :tag "Format")
  1371. (function)))))
  1372. (defcustom org-descriptive-links t
  1373. "Non-nil means Org will display descriptive links.
  1374. E.g. [[http://orgmode.org][Org website]] will be displayed as
  1375. \"Org Website\", hiding the link itself and just displaying its
  1376. description. When set to `nil', Org will display the full links
  1377. literally.
  1378. You can interactively set the value of this variable by calling
  1379. `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
  1380. :group 'org-link
  1381. :type 'boolean)
  1382. (defcustom org-link-file-path-type 'adaptive
  1383. "How the path name in file links should be stored.
  1384. Valid values are:
  1385. relative Relative to the current directory, i.e. the directory of the file
  1386. into which the link is being inserted.
  1387. absolute Absolute path, if possible with ~ for home directory.
  1388. noabbrev Absolute path, no abbreviation of home directory.
  1389. adaptive Use relative path for files in the current directory and sub-
  1390. directories of it. For other files, use an absolute path."
  1391. :group 'org-link
  1392. :type '(choice
  1393. (const relative)
  1394. (const absolute)
  1395. (const noabbrev)
  1396. (const adaptive)))
  1397. (defcustom org-activate-links '(bracket angle plain radio tag date footnote)
  1398. "Types of links that should be activated in Org-mode files.
  1399. This is a list of symbols, each leading to the activation of a certain link
  1400. type. In principle, it does not hurt to turn on most link types - there may
  1401. be a small gain when turning off unused link types. The types are:
  1402. bracket The recommended [[link][description]] or [[link]] links with hiding.
  1403. angle Links in angular brackets that may contain whitespace like
  1404. <bbdb:Carsten Dominik>.
  1405. plain Plain links in normal text, no whitespace, like http://google.com.
  1406. radio Text that is matched by a radio target, see manual for details.
  1407. tag Tag settings in a headline (link to tag search).
  1408. date Time stamps (link to calendar).
  1409. footnote Footnote labels.
  1410. Changing this variable requires a restart of Emacs to become effective."
  1411. :group 'org-link
  1412. :type '(set :greedy t
  1413. (const :tag "Double bracket links" bracket)
  1414. (const :tag "Angular bracket links" angle)
  1415. (const :tag "Plain text links" plain)
  1416. (const :tag "Radio target matches" radio)
  1417. (const :tag "Tags" tag)
  1418. (const :tag "Timestamps" date)
  1419. (const :tag "Footnotes" footnote)))
  1420. (defcustom org-make-link-description-function nil
  1421. "Function to use for generating link descriptions from links.
  1422. When nil, the link location will be used. This function must take
  1423. two parameters: the first one is the link, the second one is the
  1424. description generated by `org-insert-link'. The function should
  1425. return the description to use."
  1426. :group 'org-link
  1427. :type '(choice (const nil) (function)))
  1428. (defgroup org-link-store nil
  1429. "Options concerning storing links in Org-mode."
  1430. :tag "Org Store Link"
  1431. :group 'org-link)
  1432. (defcustom org-url-hexify-p t
  1433. "When non-nil, hexify URL when creating a link."
  1434. :type 'boolean
  1435. :version "24.3"
  1436. :group 'org-link-store)
  1437. (defcustom org-email-link-description-format "Email %c: %.30s"
  1438. "Format of the description part of a link to an email or usenet message.
  1439. The following %-escapes will be replaced by corresponding information:
  1440. %F full \"From\" field
  1441. %f name, taken from \"From\" field, address if no name
  1442. %T full \"To\" field
  1443. %t first name in \"To\" field, address if no name
  1444. %c correspondent. Usually \"from NAME\", but if you sent it yourself, it
  1445. will be \"to NAME\". See also the variable `org-from-is-user-regexp'.
  1446. %s subject
  1447. %d date
  1448. %m message-id.
  1449. You may use normal field width specification between the % and the letter.
  1450. This is for example useful to limit the length of the subject.
  1451. Examples: \"%f on: %.30s\", \"Email from %f\", \"Email %c\""
  1452. :group 'org-link-store
  1453. :type 'string)
  1454. (defcustom org-from-is-user-regexp
  1455. (let (r1 r2)
  1456. (when (and user-mail-address (not (string= user-mail-address "")))
  1457. (setq r1 (concat "\\<" (regexp-quote user-mail-address) "\\>")))
  1458. (when (and user-full-name (not (string= user-full-name "")))
  1459. (setq r2 (concat "\\<" (regexp-quote user-full-name) "\\>")))
  1460. (if (and r1 r2) (concat r1 "\\|" r2) (or r1 r2)))
  1461. "Regexp matched against the \"From:\" header of an email or usenet message.
  1462. It should match if the message is from the user him/herself."
  1463. :group 'org-link-store
  1464. :type 'regexp)
  1465. (defcustom org-context-in-file-links t
  1466. "Non-nil means file links from `org-store-link' contain context.
  1467. A search string will be added to the file name with :: as separator and
  1468. used to find the context when the link is activated by the command
  1469. `org-open-at-point'. When this option is t, the entire active region
  1470. will be placed in the search string of the file link. If set to a
  1471. positive integer, only the first n lines of context will be stored.
  1472. Using a prefix arg to the command \\[org-store-link] (`org-store-link')
  1473. negates this setting for the duration of the command."
  1474. :group 'org-link-store
  1475. :type '(choice boolean integer))
  1476. (defcustom org-keep-stored-link-after-insertion nil
  1477. "Non-nil means keep link in list for entire session.
  1478. The command `org-store-link' adds a link pointing to the current
  1479. location to an internal list. These links accumulate during a session.
  1480. The command `org-insert-link' can be used to insert links into any
  1481. Org-mode file (offering completion for all stored links). When this
  1482. option is nil, every link which has been inserted once using \\[org-insert-link]
  1483. will be removed from the list, to make completing the unused links
  1484. more efficient."
  1485. :group 'org-link-store
  1486. :type 'boolean)
  1487. (defgroup org-link-follow nil
  1488. "Options concerning following links in Org-mode."
  1489. :tag "Org Follow Link"
  1490. :group 'org-link)
  1491. (defcustom org-link-translation-function nil
  1492. "Function to translate links with different syntax to Org syntax.
  1493. This can be used to translate links created for example by the Planner
  1494. or emacs-wiki packages to Org syntax.
  1495. The function must accept two parameters, a TYPE containing the link
  1496. protocol name like \"rmail\" or \"gnus\" as a string, and the linked path,
  1497. which is everything after the link protocol. It should return a cons
  1498. with possibly modified values of type and path.
  1499. Org contains a function for this, so if you set this variable to
  1500. `org-translate-link-from-planner', you should be able follow many
  1501. links created by planner."
  1502. :group 'org-link-follow
  1503. :type '(choice (const nil) (function)))
  1504. (defcustom org-follow-link-hook nil
  1505. "Hook that is run after a link has been followed."
  1506. :group 'org-link-follow
  1507. :type 'hook)
  1508. (defcustom org-tab-follows-link nil
  1509. "Non-nil means on links TAB will follow the link.
  1510. Needs to be set before org.el is loaded.
  1511. This really should not be used, it does not make sense, and the
  1512. implementation is bad."
  1513. :group 'org-link-follow
  1514. :type 'boolean)
  1515. (defcustom org-return-follows-link nil
  1516. "Non-nil means on links RET will follow the link.
  1517. In tables, the special behavior of RET has precedence."
  1518. :group 'org-link-follow
  1519. :type 'boolean)
  1520. (defcustom org-mouse-1-follows-link
  1521. (if (boundp 'mouse-1-click-follows-link) mouse-1-click-follows-link t)
  1522. "Non-nil means mouse-1 on a link will follow the link.
  1523. A longer mouse click will still set point. Does not work on XEmacs.
  1524. Needs to be set before org.el is loaded."
  1525. :group 'org-link-follow
  1526. :type 'boolean)
  1527. (defcustom org-mark-ring-length 4
  1528. "Number of different positions to be recorded in the ring.
  1529. Changing this requires a restart of Emacs to work correctly."
  1530. :group 'org-link-follow
  1531. :type 'integer)
  1532. (defcustom org-link-search-must-match-exact-headline 'query-to-create
  1533. "Non-nil means internal links in Org files must exactly match a headline.
  1534. When nil, the link search tries to match a phrase with all words
  1535. in the search text."
  1536. :group 'org-link-follow
  1537. :version "24.1"
  1538. :type '(choice
  1539. (const :tag "Use fuzzy text search" nil)
  1540. (const :tag "Match only exact headline" t)
  1541. (const :tag "Match exact headline or query to create it"
  1542. query-to-create)))
  1543. (defcustom org-link-frame-setup
  1544. '((vm . vm-visit-folder-other-frame)
  1545. (vm-imap . vm-visit-imap-folder-other-frame)
  1546. (gnus . org-gnus-no-new-news)
  1547. (file . find-file-other-window)
  1548. (wl . wl-other-frame))
  1549. "Setup the frame configuration for following links.
  1550. When following a link with Emacs, it may often be useful to display
  1551. this link in another window or frame. This variable can be used to
  1552. set this up for the different types of links.
  1553. For VM, use any of
  1554. `vm-visit-folder'
  1555. `vm-visit-folder-other-window'
  1556. `vm-visit-folder-other-frame'
  1557. For Gnus, use any of
  1558. `gnus'
  1559. `gnus-other-frame'
  1560. `org-gnus-no-new-news'
  1561. For FILE, use any of
  1562. `find-file'
  1563. `find-file-other-window'
  1564. `find-file-other-frame'
  1565. For Wanderlust use any of
  1566. `wl'
  1567. `wl-other-frame'
  1568. For the calendar, use the variable `calendar-setup'.
  1569. For BBDB, it is currently only possible to display the matches in
  1570. another window."
  1571. :group 'org-link-follow
  1572. :type '(list
  1573. (cons (const vm)
  1574. (choice
  1575. (const vm-visit-folder)
  1576. (const vm-visit-folder-other-window)
  1577. (const vm-visit-folder-other-frame)))
  1578. (cons (const vm-imap)
  1579. (choice
  1580. (const vm-visit-imap-folder)
  1581. (const vm-visit-imap-folder-other-window)
  1582. (const vm-visit-imap-folder-other-frame)))
  1583. (cons (const gnus)
  1584. (choice
  1585. (const gnus)
  1586. (const gnus-other-frame)
  1587. (const org-gnus-no-new-news)))
  1588. (cons (const file)
  1589. (choice
  1590. (const find-file)
  1591. (const find-file-other-window)
  1592. (const find-file-other-frame)))
  1593. (cons (const wl)
  1594. (choice
  1595. (const wl)
  1596. (const wl-other-frame)))))
  1597. (defcustom org-display-internal-link-with-indirect-buffer nil
  1598. "Non-nil means use indirect buffer to display infile links.
  1599. Activating internal links (from one location in a file to another location
  1600. in the same file) normally just jumps to the location. When the link is
  1601. activated with a \\[universal-argument] prefix (or with mouse-3), the link \
  1602. is displayed in
  1603. another window. When this option is set, the other window actually displays
  1604. an indirect buffer clone of the current buffer, to avoid any visibility
  1605. changes to the current buffer."
  1606. :group 'org-link-follow
  1607. :type 'boolean)
  1608. (defcustom org-open-non-existing-files nil
  1609. "Non-nil means `org-open-file' will open non-existing files.
  1610. When nil, an error will be generated.
  1611. This variable applies only to external applications because they
  1612. might choke on non-existing files. If the link is to a file that
  1613. will be opened in Emacs, the variable is ignored."
  1614. :group 'org-link-follow
  1615. :type 'boolean)
  1616. (defcustom org-open-directory-means-index-dot-org nil
  1617. "Non-nil means a link to a directory really means to index.org.
  1618. When nil, following a directory link will run dired or open a finder/explorer
  1619. window on that directory."
  1620. :group 'org-link-follow
  1621. :type 'boolean)
  1622. (defcustom org-link-mailto-program '(browse-url "mailto:%a?subject=%s")
  1623. "Function and arguments to call for following mailto links.
  1624. This is a list with the first element being a Lisp function, and the
  1625. remaining elements being arguments to the function. In string arguments,
  1626. %a will be replaced by the address, and %s will be replaced by the subject
  1627. if one was given like in <mailto:arthur@galaxy.org::this subject>."
  1628. :group 'org-link-follow
  1629. :type '(choice
  1630. (const :tag "browse-url" (browse-url-mail "mailto:%a?subject=%s"))
  1631. (const :tag "compose-mail" (compose-mail "%a" "%s"))
  1632. (const :tag "message-mail" (message-mail "%a" "%s"))
  1633. (cons :tag "other" (function) (repeat :tag "argument" sexp))))
  1634. (defcustom org-confirm-shell-link-function 'yes-or-no-p
  1635. "Non-nil means ask for confirmation before executing shell links.
  1636. Shell links can be dangerous: just think about a link
  1637. [[shell:rm -rf ~/*][Google Search]]
  1638. This link would show up in your Org-mode document as \"Google Search\",
  1639. but really it would remove your entire home directory.
  1640. Therefore we advise against setting this variable to nil.
  1641. Just change it to `y-or-n-p' if you want to confirm with a
  1642. single keystroke rather than having to type \"yes\"."
  1643. :group 'org-link-follow
  1644. :type '(choice
  1645. (const :tag "with yes-or-no (safer)" yes-or-no-p)
  1646. (const :tag "with y-or-n (faster)" y-or-n-p)
  1647. (const :tag "no confirmation (dangerous)" nil)))
  1648. (put 'org-confirm-shell-link-function
  1649. 'safe-local-variable
  1650. #'(lambda (x) (member x '(yes-or-no-p y-or-n-p))))
  1651. (defcustom org-confirm-shell-link-not-regexp ""
  1652. "A regexp to skip confirmation for shell links."
  1653. :group 'org-link-follow
  1654. :version "24.1"
  1655. :type 'regexp)
  1656. (defcustom org-confirm-elisp-link-function 'yes-or-no-p
  1657. "Non-nil means ask for confirmation before executing Emacs Lisp links.
  1658. Elisp links can be dangerous: just think about a link
  1659. [[elisp:(shell-command \"rm -rf ~/*\")][Google Search]]
  1660. This link would show up in your Org-mode document as \"Google Search\",
  1661. but really it would remove your entire home directory.
  1662. Therefore we advise against setting this variable to nil.
  1663. Just change it to `y-or-n-p' if you want to confirm with a
  1664. single keystroke rather than having to type \"yes\"."
  1665. :group 'org-link-follow
  1666. :type '(choice
  1667. (const :tag "with yes-or-no (safer)" yes-or-no-p)
  1668. (const :tag "with y-or-n (faster)" y-or-n-p)
  1669. (const :tag "no confirmation (dangerous)" nil)))
  1670. (put 'org-confirm-shell-link-function
  1671. 'safe-local-variable
  1672. #'(lambda (x) (member x '(yes-or-no-p y-or-n-p))))
  1673. (defcustom org-confirm-elisp-link-not-regexp ""
  1674. "A regexp to skip confirmation for Elisp links."
  1675. :group 'org-link-follow
  1676. :version "24.1"
  1677. :type 'regexp)
  1678. (defconst org-file-apps-defaults-gnu
  1679. '((remote . emacs)
  1680. (system . mailcap)
  1681. (t . mailcap))
  1682. "Default file applications on a UNIX or GNU/Linux system.
  1683. See `org-file-apps'.")
  1684. (defconst org-file-apps-defaults-macosx
  1685. '((remote . emacs)
  1686. (t . "open %s")
  1687. (system . "open %s")
  1688. ("ps.gz" . "gv %s")
  1689. ("eps.gz" . "gv %s")
  1690. ("dvi" . "xdvi %s")
  1691. ("fig" . "xfig %s"))
  1692. "Default file applications on a MacOS X system.
  1693. The system \"open\" is known as a default, but we use X11 applications
  1694. for some files for which the OS does not have a good default.
  1695. See `org-file-apps'.")
  1696. (defconst org-file-apps-defaults-windowsnt
  1697. (list
  1698. '(remote . emacs)
  1699. (cons t
  1700. (list (if (featurep 'xemacs)
  1701. 'mswindows-shell-execute
  1702. 'w32-shell-execute)
  1703. "open" 'file))
  1704. (cons 'system
  1705. (list (if (featurep 'xemacs)
  1706. 'mswindows-shell-execute
  1707. 'w32-shell-execute)
  1708. "open" 'file)))
  1709. "Default file applications on a Windows NT system.
  1710. The system \"open\" is used for most files.
  1711. See `org-file-apps'.")
  1712. (defcustom org-file-apps
  1713. '((auto-mode . emacs)
  1714. ("\\.mm\\'" . default)
  1715. ("\\.x?html?\\'" . default)
  1716. ("\\.pdf\\'" . default))
  1717. "External applications for opening `file:path' items in a document.
  1718. Org-mode uses system defaults for different file types, but
  1719. you can use this variable to set the application for a given file
  1720. extension. The entries in this list are cons cells where the car identifies
  1721. files and the cdr the corresponding command. Possible values for the
  1722. file identifier are
  1723. \"string\" A string as a file identifier can be interpreted in different
  1724. ways, depending on its contents:
  1725. - Alphanumeric characters only:
  1726. Match links with this file extension.
  1727. Example: (\"pdf\" . \"evince %s\")
  1728. to open PDFs with evince.
  1729. - Regular expression: Match links where the
  1730. filename matches the regexp. If you want to
  1731. use groups here, use shy groups.
  1732. Example: (\"\\.x?html\\'\" . \"firefox %s\")
  1733. (\"\\(?:xhtml\\|html\\)\" . \"firefox %s\")
  1734. to open *.html and *.xhtml with firefox.
  1735. - Regular expression which contains (non-shy) groups:
  1736. Match links where the whole link, including \"::\", and
  1737. anything after that, matches the regexp.
  1738. In a custom command string, %1, %2, etc. are replaced with
  1739. the parts of the link that were matched by the groups.
  1740. For backwards compatibility, if a command string is given
  1741. that does not use any of the group matches, this case is
  1742. handled identically to the second one (i.e. match against
  1743. file name only).
  1744. In a custom lisp form, you can access the group matches with
  1745. (match-string n link).
  1746. Example: (\"\\.pdf::\\(\\d+\\)\\'\" . \"evince -p %1 %s\")
  1747. to open [[file:document.pdf::5]] with evince at page 5.
  1748. `directory' Matches a directory
  1749. `remote' Matches a remote file, accessible through tramp or efs.
  1750. Remote files most likely should be visited through Emacs
  1751. because external applications cannot handle such paths.
  1752. `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
  1753. so all files Emacs knows how to handle. Using this with
  1754. command `emacs' will open most files in Emacs. Beware that this
  1755. will also open html files inside Emacs, unless you add
  1756. (\"html\" . default) to the list as well.
  1757. t Default for files not matched by any of the other options.
  1758. `system' The system command to open files, like `open' on Windows
  1759. and Mac OS X, and mailcap under GNU/Linux. This is the command
  1760. that will be selected if you call `C-c C-o' with a double
  1761. \\[universal-argument] \\[universal-argument] prefix.
  1762. Possible values for the command are:
  1763. `emacs' The file will be visited by the current Emacs process.
  1764. `default' Use the default application for this file type, which is the
  1765. association for t in the list, most likely in the system-specific
  1766. part.
  1767. This can be used to overrule an unwanted setting in the
  1768. system-specific variable.
  1769. `system' Use the system command for opening files, like \"open\".
  1770. This command is specified by the entry whose car is `system'.
  1771. Most likely, the system-specific version of this variable
  1772. does define this command, but you can overrule/replace it
  1773. here.
  1774. string A command to be executed by a shell; %s will be replaced
  1775. by the path to the file.
  1776. sexp A Lisp form which will be evaluated. The file path will
  1777. be available in the Lisp variable `file'.
  1778. For more examples, see the system specific constants
  1779. `org-file-apps-defaults-macosx'
  1780. `org-file-apps-defaults-windowsnt'
  1781. `org-file-apps-defaults-gnu'."
  1782. :group 'org-link-follow
  1783. :type '(repeat
  1784. (cons (choice :value ""
  1785. (string :tag "Extension")
  1786. (const :tag "System command to open files" system)
  1787. (const :tag "Default for unrecognized files" t)
  1788. (const :tag "Remote file" remote)
  1789. (const :tag "Links to a directory" directory)
  1790. (const :tag "Any files that have Emacs modes"
  1791. auto-mode))
  1792. (choice :value ""
  1793. (const :tag "Visit with Emacs" emacs)
  1794. (const :tag "Use default" default)
  1795. (const :tag "Use the system command" system)
  1796. (string :tag "Command")
  1797. (sexp :tag "Lisp form")))))
  1798. (defcustom org-doi-server-url "http://dx.doi.org/"
  1799. "The URL of the DOI server."
  1800. :type 'string
  1801. :version "24.3"
  1802. :group 'org-link-follow)
  1803. (defgroup org-refile nil
  1804. "Options concerning refiling entries in Org-mode."
  1805. :tag "Org Refile"
  1806. :group 'org)
  1807. (defcustom org-directory "~/org"
  1808. "Directory with org files.
  1809. This is just a default location to look for Org files. There is no need
  1810. at all to put your files into this directory. It is only used in the
  1811. following situations:
  1812. 1. When a capture template specifies a target file that is not an
  1813. absolute path. The path will then be interpreted relative to
  1814. `org-directory'
  1815. 2. When a capture note is filed away in an interactive way (when exiting the
  1816. note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
  1817. with `org-directory' as the default path."
  1818. :group 'org-refile
  1819. :group 'org-remember
  1820. :group 'org-capture
  1821. :type 'directory)
  1822. (defcustom org-default-notes-file (convert-standard-filename "~/.notes")
  1823. "Default target for storing notes.
  1824. Used as a fall back file for org-remember.el and org-capture.el, for
  1825. templates that do not specify a target file."
  1826. :group 'org-refile
  1827. :group 'org-remember
  1828. :group 'org-capture
  1829. :type '(choice
  1830. (const :tag "Default from remember-data-file" nil)
  1831. file))
  1832. (defcustom org-goto-interface 'outline
  1833. "The default interface to be used for `org-goto'.
  1834. Allowed values are:
  1835. outline The interface shows an outline of the relevant file
  1836. and the correct heading is found by moving through
  1837. the outline or by searching with incremental search.
  1838. outline-path-completion Headlines in the current buffer are offered via
  1839. completion. This is the interface also used by
  1840. the refile command."
  1841. :group 'org-refile
  1842. :type '(choice
  1843. (const :tag "Outline" outline)
  1844. (const :tag "Outline-path-completion" outline-path-completion)))
  1845. (defcustom org-goto-max-level 5
  1846. "Maximum target level when running `org-goto' with refile interface."
  1847. :group 'org-refile
  1848. :type 'integer)
  1849. (defcustom org-reverse-note-order nil
  1850. "Non-nil means store new notes at the beginning of a file or entry.
  1851. When nil, new notes will be filed to the end of a file or entry.
  1852. This can also be a list with cons cells of regular expressions that
  1853. are matched against file names, and values."
  1854. :group 'org-remember
  1855. :group 'org-capture
  1856. :group 'org-refile
  1857. :type '(choice
  1858. (const :tag "Reverse always" t)
  1859. (const :tag "Reverse never" nil)
  1860. (repeat :tag "By file name regexp"
  1861. (cons regexp boolean))))
  1862. (defcustom org-log-refile nil
  1863. "Information to record when a task is refiled.
  1864. Possible values are:
  1865. nil Don't add anything
  1866. time Add a time stamp to the task
  1867. note Prompt for a note and add it with template `org-log-note-headings'
  1868. This option can also be set with on a per-file-basis with
  1869. #+STARTUP: nologrefile
  1870. #+STARTUP: logrefile
  1871. #+STARTUP: lognoterefile
  1872. You can have local logging settings for a subtree by setting the LOGGING
  1873. property to one or more of these keywords.
  1874. When bulk-refiling from the agenda, the value `note' is forbidden and
  1875. will temporarily be changed to `time'."
  1876. :group 'org-refile
  1877. :group 'org-progress
  1878. :version "24.1"
  1879. :type '(choice
  1880. (const :tag "No logging" nil)
  1881. (const :tag "Record timestamp" time)
  1882. (const :tag "Record timestamp with note." note)))
  1883. (defcustom org-refile-targets nil
  1884. "Targets for refiling entries with \\[org-refile].
  1885. This is a list of cons cells. Each cell contains:
  1886. - a specification of the files to be considered, either a list of files,
  1887. or a symbol whose function or variable value will be used to retrieve
  1888. a file name or a list of file names. If you use `org-agenda-files' for
  1889. that, all agenda files will be scanned for targets. Nil means consider
  1890. headings in the current buffer.
  1891. - A specification of how to find candidate refile targets. This may be
  1892. any of:
  1893. - a cons cell (:tag . \"TAG\") to identify refile targets by a tag.
  1894. This tag has to be present in all target headlines, inheritance will
  1895. not be considered.
  1896. - a cons cell (:todo . \"KEYWORD\") to identify refile targets by
  1897. todo keyword.
  1898. - a cons cell (:regexp . \"REGEXP\") with a regular expression matching
  1899. headlines that are refiling targets.
  1900. - a cons cell (:level . N). Any headline of level N is considered a target.
  1901. Note that, when `org-odd-levels-only' is set, level corresponds to
  1902. order in hierarchy, not to the number of stars.
  1903. - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
  1904. Note that, when `org-odd-levels-only' is set, level corresponds to
  1905. order in hierarchy, not to the number of stars.
  1906. Each element of this list generates a set of possible targets.
  1907. The union of these sets is presented (with completion) to
  1908. the user by `org-refile'.
  1909. You can set the variable `org-refile-target-verify-function' to a function
  1910. to verify each headline found by the simple criteria above.
  1911. When this variable is nil, all top-level headlines in the current buffer
  1912. are used, equivalent to the value `((nil . (:level . 1))'."
  1913. :group 'org-refile
  1914. :type '(repeat
  1915. (cons
  1916. (choice :value org-agenda-files
  1917. (const :tag "All agenda files" org-agenda-files)
  1918. (const :tag "Current buffer" nil)
  1919. (function) (variable) (file))
  1920. (choice :tag "Identify target headline by"
  1921. (cons :tag "Specific tag" (const :value :tag) (string))
  1922. (cons :tag "TODO keyword" (const :value :todo) (string))
  1923. (cons :tag "Regular expression" (const :value :regexp) (regexp))
  1924. (cons :tag "Level number" (const :value :level) (integer))
  1925. (cons :tag "Max Level number" (const :value :maxlevel) (integer))))))
  1926. (defcustom org-refile-target-verify-function nil
  1927. "Function to verify if the headline at point should be a refile target.
  1928. The function will be called without arguments, with point at the
  1929. beginning of the headline. It should return t and leave point
  1930. where it is if the headline is a valid target for refiling.
  1931. If the target should not be selected, the function must return nil.
  1932. In addition to this, it may move point to a place from where the search
  1933. should be continued. For example, the function may decide that the entire
  1934. subtree of the current entry should be excluded and move point to the end
  1935. of the subtree."
  1936. :group 'org-refile
  1937. :type '(choice
  1938. (const nil)
  1939. (function)))
  1940. (defcustom org-refile-use-cache nil
  1941. "Non-nil means cache refile targets to speed up the process.
  1942. The cache for a particular file will be updated automatically when
  1943. the buffer has been killed, or when any of the marker used for flagging
  1944. refile targets no longer points at a live buffer.
  1945. If you have added new entries to a buffer that might themselves be targets,
  1946. you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
  1947. find that easier, `C-u C-u C-u C-c C-w'."
  1948. :group 'org-refile
  1949. :version "24.1"
  1950. :type 'boolean)
  1951. (defcustom org-refile-use-outline-path nil
  1952. "Non-nil means provide refile targets as paths.
  1953. So a level 3 headline will be available as level1/level2/level3.
  1954. When the value is `file', also include the file name (without directory)
  1955. into the path. In this case, you can also stop the completion after
  1956. the file name, to get entries inserted as top level in the file.
  1957. When `full-file-path', include the full file path."
  1958. :group 'org-refile
  1959. :type '(choice
  1960. (const :tag "Not" nil)
  1961. (const :tag "Yes" t)
  1962. (const :tag "Start with file name" file)
  1963. (const :tag "Start with full file path" full-file-path)))
  1964. (defcustom org-outline-path-complete-in-steps t
  1965. "Non-nil means complete the outline path in hierarchical steps.
  1966. When Org-mode uses the refile interface to select an outline path
  1967. \(see variable `org-refile-use-outline-path'), the completion of
  1968. the path can be done is a single go, or if can be done in steps down
  1969. the headline hierarchy. Going in steps is probably the best if you
  1970. do not use a special completion package like `ido' or `icicles'.
  1971. However, when using these packages, going in one step can be very
  1972. fast, while still showing the whole path to the entry."
  1973. :group 'org-refile
  1974. :type 'boolean)
  1975. (defcustom org-refile-allow-creating-parent-nodes nil
  1976. "Non-nil means allow to create new nodes as refile targets.
  1977. New nodes are then created by adding \"/new node name\" to the completion
  1978. of an existing node. When the value of this variable is `confirm',
  1979. new node creation must be confirmed by the user (recommended)
  1980. When nil, the completion must match an existing entry.
  1981. Note that, if the new heading is not seen by the criteria
  1982. listed in `org-refile-targets', multiple instances of the same
  1983. heading would be created by trying again to file under the new
  1984. heading."
  1985. :group 'org-refile
  1986. :type '(choice
  1987. (const :tag "Never" nil)
  1988. (const :tag "Always" t)
  1989. (const :tag "Prompt for confirmation" confirm)))
  1990. (defcustom org-refile-active-region-within-subtree nil
  1991. "Non-nil means also refile active region within a subtree.
  1992. By default `org-refile' doesn't allow refiling regions if they
  1993. don't contain a set of subtrees, but it might be convenient to
  1994. do so sometimes: in that case, the first line of the region is
  1995. converted to a headline before refiling."
  1996. :group 'org-refile
  1997. :version "24.1"
  1998. :type 'boolean)
  1999. (defgroup org-todo nil
  2000. "Options concerning TODO items in Org-mode."
  2001. :tag "Org TODO"
  2002. :group 'org)
  2003. (defgroup org-progress nil
  2004. "Options concerning Progress logging in Org-mode."
  2005. :tag "Org Progress"
  2006. :group 'org-time)
  2007. (defvar org-todo-interpretation-widgets
  2008. '((:tag "Sequence (cycling hits every state)" sequence)
  2009. (:tag "Type (cycling directly to DONE)" type))
  2010. "The available interpretation symbols for customizing `org-todo-keywords'.
  2011. Interested libraries should add to this list.")
  2012. (defcustom org-todo-keywords '((sequence "TODO" "DONE"))
  2013. "List of TODO entry keyword sequences and their interpretation.
  2014. \\<org-mode-map>This is a list of sequences.
  2015. Each sequence starts with a symbol, either `sequence' or `type',
  2016. indicating if the keywords should be interpreted as a sequence of
  2017. action steps, or as different types of TODO items. The first
  2018. keywords are states requiring action - these states will select a headline
  2019. for inclusion into the global TODO list Org-mode produces. If one of
  2020. the \"keywords\" is the vertical bar, \"|\", the remaining keywords
  2021. signify that no further action is necessary. If \"|\" is not found,
  2022. the last keyword is treated as the only DONE state of the sequence.
  2023. The command \\[org-todo] cycles an entry through these states, and one
  2024. additional state where no keyword is present. For details about this
  2025. cycling, see the manual.
  2026. TODO keywords and interpretation can also be set on a per-file basis with
  2027. the special #+SEQ_TODO and #+TYP_TODO lines.
  2028. Each keyword can optionally specify a character for fast state selection
  2029. \(in combination with the variable `org-use-fast-todo-selection')
  2030. and specifiers for state change logging, using the same syntax that
  2031. is used in the \"#+TODO:\" lines. For example, \"WAIT(w)\" says that
  2032. the WAIT state can be selected with the \"w\" key. \"WAIT(w!)\"
  2033. indicates to record a time stamp each time this state is selected.
  2034. Each keyword may also specify if a timestamp or a note should be
  2035. recorded when entering or leaving the state, by adding additional
  2036. characters in the parenthesis after the keyword. This looks like this:
  2037. \"WAIT(w@/!)\". \"@\" means to add a note (with time), \"!\" means to
  2038. record only the time of the state change. With X and Y being either
  2039. \"@\" or \"!\", \"X/Y\" means use X when entering the state, and use
  2040. Y when leaving the state if and only if the *target* state does not
  2041. define X. You may omit any of the fast-selection key or X or /Y,
  2042. so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
  2043. For backward compatibility, this variable may also be just a list
  2044. of keywords. In this case the interpretation (sequence or type) will be
  2045. taken from the (otherwise obsolete) variable `org-todo-interpretation'."
  2046. :group 'org-todo
  2047. :group 'org-keywords
  2048. :type '(choice
  2049. (repeat :tag "Old syntax, just keywords"
  2050. (string :tag "Keyword"))
  2051. (repeat :tag "New syntax"
  2052. (cons
  2053. (choice
  2054. :tag "Interpretation"
  2055. ;;Quick and dirty way to see
  2056. ;;`org-todo-interpretations'. This takes the
  2057. ;;place of item arguments
  2058. :convert-widget
  2059. (lambda (widget)
  2060. (widget-put widget
  2061. :args (mapcar
  2062. #'(lambda (x)
  2063. (widget-convert
  2064. (cons 'const x)))
  2065. org-todo-interpretation-widgets))
  2066. widget))
  2067. (repeat
  2068. (string :tag "Keyword"))))))
  2069. (defvar org-todo-keywords-1 nil
  2070. "All TODO and DONE keywords active in a buffer.")
  2071. (make-variable-buffer-local 'org-todo-keywords-1)
  2072. (defvar org-todo-keywords-for-agenda nil)
  2073. (defvar org-done-keywords-for-agenda nil)
  2074. (defvar org-drawers-for-agenda nil)
  2075. (defvar org-todo-keyword-alist-for-agenda nil)
  2076. (defvar org-tag-alist-for-agenda nil
  2077. "Alist of all tags from all agenda files.")
  2078. (defvar org-tag-groups-alist-for-agenda nil
  2079. "Alist of all groups tags from all current agenda files.")
  2080. (defvar org-tag-groups-alist nil)
  2081. (make-variable-buffer-local 'org-tag-groups-alist)
  2082. (defvar org-agenda-contributing-files nil)
  2083. (defvar org-not-done-keywords nil)
  2084. (make-variable-buffer-local 'org-not-done-keywords)
  2085. (defvar org-done-keywords nil)
  2086. (make-variable-buffer-local 'org-done-keywords)
  2087. (defvar org-todo-heads nil)
  2088. (make-variable-buffer-local 'org-todo-heads)
  2089. (defvar org-todo-sets nil)
  2090. (make-variable-buffer-local 'org-todo-sets)
  2091. (defvar org-todo-log-states nil)
  2092. (make-variable-buffer-local 'org-todo-log-states)
  2093. (defvar org-todo-kwd-alist nil)
  2094. (make-variable-buffer-local 'org-todo-kwd-alist)
  2095. (defvar org-todo-key-alist nil)
  2096. (make-variable-buffer-local 'org-todo-key-alist)
  2097. (defvar org-todo-key-trigger nil)
  2098. (make-variable-buffer-local 'org-todo-key-trigger)
  2099. (defcustom org-todo-interpretation 'sequence
  2100. "Controls how TODO keywords are interpreted.
  2101. This variable is in principle obsolete and is only used for
  2102. backward compatibility, if the interpretation of todo keywords is
  2103. not given already in `org-todo-keywords'. See that variable for
  2104. more information."
  2105. :group 'org-todo
  2106. :group 'org-keywords
  2107. :type '(choice (const sequence)
  2108. (const type)))
  2109. (defcustom org-use-fast-todo-selection t
  2110. "Non-nil means use the fast todo selection scheme with C-c C-t.
  2111. This variable describes if and under what circumstances the cycling
  2112. mechanism for TODO keywords will be replaced by a single-key, direct
  2113. selection scheme.
  2114. When nil, fast selection is never used.
  2115. When the symbol `prefix', it will be used when `org-todo' is called
  2116. with a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and
  2117. `C-u t' in an agenda buffer.
  2118. When t, fast selection is used by default. In this case, the prefix
  2119. argument forces cycling instead.
  2120. In all cases, the special interface is only used if access keys have
  2121. actually been assigned by the user, i.e. if keywords in the configuration
  2122. are followed by a letter in parenthesis, like TODO(t)."
  2123. :group 'org-todo
  2124. :type '(choice
  2125. (const :tag "Never" nil)
  2126. (const :tag "By default" t)
  2127. (const :tag "Only with C-u C-c C-t" prefix)))
  2128. (defcustom org-provide-todo-statistics t
  2129. "Non-nil means update todo statistics after insert and toggle.
  2130. ALL-HEADLINES means update todo statistics by including headlines
  2131. with no TODO keyword as well, counting them as not done.
  2132. A list of TODO keywords means the same, but skip keywords that are
  2133. not in this list.
  2134. When this is set, todo statistics is updated in the parent of the
  2135. current entry each time a todo state is changed."
  2136. :group 'org-todo
  2137. :type '(choice
  2138. (const :tag "Yes, only for TODO entries" t)
  2139. (const :tag "Yes, including all entries" 'all-headlines)
  2140. (repeat :tag "Yes, for TODOs in this list"
  2141. (string :tag "TODO keyword"))
  2142. (other :tag "No TODO statistics" nil)))
  2143. (defcustom org-hierarchical-todo-statistics t
  2144. "Non-nil means TODO statistics covers just direct children.
  2145. When nil, all entries in the subtree are considered.
  2146. This has only an effect if `org-provide-todo-statistics' is set.
  2147. To set this to nil for only a single subtree, use a COOKIE_DATA
  2148. property and include the word \"recursive\" into the value."
  2149. :group 'org-todo
  2150. :type 'boolean)
  2151. (defcustom org-after-todo-state-change-hook nil
  2152. "Hook which is run after the state of a TODO item was changed.
  2153. The new state (a string with a TODO keyword, or nil) is available in the
  2154. Lisp variable `org-state'."
  2155. :group 'org-todo
  2156. :type 'hook)
  2157. (defvar org-blocker-hook nil
  2158. "Hook for functions that are allowed to block a state change.
  2159. Functions in this hook should not modify the buffer.
  2160. Each function gets as its single argument a property list,
  2161. see `org-trigger-hook' for more information about this list.
  2162. If any of the functions in this hook returns nil, the state change
  2163. is blocked.")
  2164. (defvar org-trigger-hook nil
  2165. "Hook for functions that are triggered by a state change.
  2166. Each function gets as its single argument a property list with at
  2167. least the following elements:
  2168. (:type type-of-change :position pos-at-entry-start
  2169. :from old-state :to new-state)
  2170. Depending on the type, more properties may be present.
  2171. This mechanism is currently implemented for:
  2172. TODO state changes
  2173. ------------------
  2174. :type todo-state-change
  2175. :from previous state (keyword as a string), or nil, or a symbol
  2176. 'todo' or 'done', to indicate the general type of state.
  2177. :to new state, like in :from")
  2178. (defcustom org-enforce-todo-dependencies nil
  2179. "Non-nil means undone TODO entries will block switching the parent to DONE.
  2180. Also, if a parent has an :ORDERED: property, switching an entry to DONE will
  2181. be blocked if any prior sibling is not yet done.
  2182. Finally, if the parent is blocked because of ordered siblings of its own,
  2183. the child will also be blocked."
  2184. :set (lambda (var val)
  2185. (set var val)
  2186. (if val
  2187. (add-hook 'org-blocker-hook
  2188. 'org-block-todo-from-children-or-siblings-or-parent)
  2189. (remove-hook 'org-blocker-hook
  2190. 'org-block-todo-from-children-or-siblings-or-parent)))
  2191. :group 'org-todo
  2192. :type 'boolean)
  2193. (defcustom org-enforce-todo-checkbox-dependencies nil
  2194. "Non-nil means unchecked boxes will block switching the parent to DONE.
  2195. When this is nil, checkboxes have no influence on switching TODO states.
  2196. When non-nil, you first need to check off all check boxes before the TODO
  2197. entry can be switched to DONE.
  2198. This variable needs to be set before org.el is loaded, and you need to
  2199. restart Emacs after a change to make the change effective. The only way
  2200. to change is while Emacs is running is through the customize interface."
  2201. :set (lambda (var val)
  2202. (set var val)
  2203. (if val
  2204. (add-hook 'org-blocker-hook
  2205. 'org-block-todo-from-checkboxes)
  2206. (remove-hook 'org-blocker-hook
  2207. 'org-block-todo-from-checkboxes)))
  2208. :group 'org-todo
  2209. :type 'boolean)
  2210. (defcustom org-treat-insert-todo-heading-as-state-change nil
  2211. "Non-nil means inserting a TODO heading is treated as state change.
  2212. So when the command \\[org-insert-todo-heading] is used, state change
  2213. logging will apply if appropriate. When nil, the new TODO item will
  2214. be inserted directly, and no logging will take place."
  2215. :group 'org-todo
  2216. :type 'boolean)
  2217. (defcustom org-treat-S-cursor-todo-selection-as-state-change t
  2218. "Non-nil means switching TODO states with S-cursor counts as state change.
  2219. This is the default behavior. However, setting this to nil allows a
  2220. convenient way to select a TODO state and bypass any logging associated
  2221. with that."
  2222. :group 'org-todo
  2223. :type 'boolean)
  2224. (defcustom org-todo-state-tags-triggers nil
  2225. "Tag changes that should be triggered by TODO state changes.
  2226. This is a list. Each entry is
  2227. (state-change (tag . flag) .......)
  2228. State-change can be a string with a state, and empty string to indicate the
  2229. state that has no TODO keyword, or it can be one of the symbols `todo'
  2230. or `done', meaning any not-done or done state, respectively."
  2231. :group 'org-todo
  2232. :group 'org-tags
  2233. :type '(repeat
  2234. (cons (choice :tag "When changing to"
  2235. (const :tag "Not-done state" todo)
  2236. (const :tag "Done state" done)
  2237. (string :tag "State"))
  2238. (repeat
  2239. (cons :tag "Tag action"
  2240. (string :tag "Tag")
  2241. (choice (const :tag "Add" t) (const :tag "Remove" nil)))))))
  2242. (defcustom org-log-done nil
  2243. "Information to record when a task moves to the DONE state.
  2244. Possible values are:
  2245. nil Don't add anything, just change the keyword
  2246. time Add a time stamp to the task
  2247. note Prompt for a note and add it with template `org-log-note-headings'
  2248. This option can also be set with on a per-file-basis with
  2249. #+STARTUP: nologdone
  2250. #+STARTUP: logdone
  2251. #+STARTUP: lognotedone
  2252. You can have local logging settings for a subtree by setting the LOGGING
  2253. property to one or more of these keywords."
  2254. :group 'org-todo
  2255. :group 'org-progress
  2256. :type '(choice
  2257. (const :tag "No logging" nil)
  2258. (const :tag "Record CLOSED timestamp" time)
  2259. (const :tag "Record CLOSED timestamp with note." note)))
  2260. ;; Normalize old uses of org-log-done.
  2261. (cond
  2262. ((eq org-log-done t) (setq org-log-done 'time))
  2263. ((and (listp org-log-done) (memq 'done org-log-done))
  2264. (setq org-log-done 'note)))
  2265. (defcustom org-log-reschedule nil
  2266. "Information to record when the scheduling date of a tasks is modified.
  2267. Possible values are:
  2268. nil Don't add anything, just change the date
  2269. time Add a time stamp to the task
  2270. note Prompt for a note and add it with template `org-log-note-headings'
  2271. This option can also be set with on a per-file-basis with
  2272. #+STARTUP: nologreschedule
  2273. #+STARTUP: logreschedule
  2274. #+STARTUP: lognotereschedule"
  2275. :group 'org-todo
  2276. :group 'org-progress
  2277. :type '(choice
  2278. (const :tag "No logging" nil)
  2279. (const :tag "Record timestamp" time)
  2280. (const :tag "Record timestamp with note." note)))
  2281. (defcustom org-log-redeadline nil
  2282. "Information to record when the deadline date of a tasks is modified.
  2283. Possible values are:
  2284. nil Don't add anything, just change the date
  2285. time Add a time stamp to the task
  2286. note Prompt for a note and add it with template `org-log-note-headings'
  2287. This option can also be set with on a per-file-basis with
  2288. #+STARTUP: nologredeadline
  2289. #+STARTUP: logredeadline
  2290. #+STARTUP: lognoteredeadline
  2291. You can have local logging settings for a subtree by setting the LOGGING
  2292. property to one or more of these keywords."
  2293. :group 'org-todo
  2294. :group 'org-progress
  2295. :type '(choice
  2296. (const :tag "No logging" nil)
  2297. (const :tag "Record timestamp" time)
  2298. (const :tag "Record timestamp with note." note)))
  2299. (defcustom org-log-note-clock-out nil
  2300. "Non-nil means record a note when clocking out of an item.
  2301. This can also be configured on a per-file basis by adding one of
  2302. the following lines anywhere in the buffer:
  2303. #+STARTUP: lognoteclock-out
  2304. #+STARTUP: nolognoteclock-out"
  2305. :group 'org-todo
  2306. :group 'org-progress
  2307. :type 'boolean)
  2308. (defcustom org-log-done-with-time t
  2309. "Non-nil means the CLOSED time stamp will contain date and time.
  2310. When nil, only the date will be recorded."
  2311. :group 'org-progress
  2312. :type 'boolean)
  2313. (defcustom org-log-note-headings
  2314. '((done . "CLOSING NOTE %t")
  2315. (state . "State %-12s from %-12S %t")
  2316. (note . "Note taken on %t")
  2317. (reschedule . "Rescheduled from %S on %t")
  2318. (delschedule . "Not scheduled, was %S on %t")
  2319. (redeadline . "New deadline from %S on %t")
  2320. (deldeadline . "Removed deadline, was %S on %t")
  2321. (refile . "Refiled on %t")
  2322. (clock-out . ""))
  2323. "Headings for notes added to entries.
  2324. The value is an alist, with the car being a symbol indicating the note
  2325. context, and the cdr is the heading to be used. The heading may also be the
  2326. empty string.
  2327. %t in the heading will be replaced by a time stamp.
  2328. %T will be an active time stamp instead the default inactive one
  2329. %d will be replaced by a short-format time stamp.
  2330. %D will be replaced by an active short-format time stamp.
  2331. %s will be replaced by the new TODO state, in double quotes.
  2332. %S will be replaced by the old TODO state, in double quotes.
  2333. %u will be replaced by the user name.
  2334. %U will be replaced by the full user name.
  2335. In fact, it is not a good idea to change the `state' entry, because
  2336. agenda log mode depends on the format of these entries."
  2337. :group 'org-todo
  2338. :group 'org-progress
  2339. :type '(list :greedy t
  2340. (cons (const :tag "Heading when closing an item" done) string)
  2341. (cons (const :tag
  2342. "Heading when changing todo state (todo sequence only)"
  2343. state) string)
  2344. (cons (const :tag "Heading when just taking a note" note) string)
  2345. (cons (const :tag "Heading when clocking out" clock-out) string)
  2346. (cons (const :tag "Heading when an item is no longer scheduled" delschedule) string)
  2347. (cons (const :tag "Heading when rescheduling" reschedule) string)
  2348. (cons (const :tag "Heading when changing deadline" redeadline) string)
  2349. (cons (const :tag "Heading when deleting a deadline" deldeadline) string)
  2350. (cons (const :tag "Heading when refiling" refile) string)))
  2351. (unless (assq 'note org-log-note-headings)
  2352. (push '(note . "%t") org-log-note-headings))
  2353. (defcustom org-log-into-drawer nil
  2354. "Non-nil means insert state change notes and time stamps into a drawer.
  2355. When nil, state changes notes will be inserted after the headline and
  2356. any scheduling and clock lines, but not inside a drawer.
  2357. The value of this variable should be the name of the drawer to use.
  2358. LOGBOOK is proposed as the default drawer for this purpose, you can
  2359. also set this to a string to define the drawer of your choice.
  2360. A value of t is also allowed, representing \"LOGBOOK\".
  2361. A value of t or nil can also be set with on a per-file-basis with
  2362. #+STARTUP: logdrawer
  2363. #+STARTUP: nologdrawer
  2364. If this variable is set, `org-log-state-notes-insert-after-drawers'
  2365. will be ignored.
  2366. You can set the property LOG_INTO_DRAWER to overrule this setting for
  2367. a subtree."
  2368. :group 'org-todo
  2369. :group 'org-progress
  2370. :type '(choice
  2371. (const :tag "Not into a drawer" nil)
  2372. (const :tag "LOGBOOK" t)
  2373. (string :tag "Other")))
  2374. (org-defvaralias 'org-log-state-notes-into-drawer 'org-log-into-drawer)
  2375. (defun org-log-into-drawer ()
  2376. "Return the value of `org-log-into-drawer', but let properties overrule.
  2377. If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
  2378. used instead of the default value."
  2379. (let ((p (org-entry-get nil "LOG_INTO_DRAWER" 'inherit t)))
  2380. (cond
  2381. ((not p) org-log-into-drawer)
  2382. ((equal p "nil") nil)
  2383. ((equal p "t") "LOGBOOK")
  2384. (t p))))
  2385. (defcustom org-log-state-notes-insert-after-drawers nil
  2386. "Non-nil means insert state change notes after any drawers in entry.
  2387. Only the drawers that *immediately* follow the headline and the
  2388. deadline/scheduled line are skipped.
  2389. When nil, insert notes right after the heading and perhaps the line
  2390. with deadline/scheduling if present.
  2391. This variable will have no effect if `org-log-into-drawer' is
  2392. set."
  2393. :group 'org-todo
  2394. :group 'org-progress
  2395. :type 'boolean)
  2396. (defcustom org-log-states-order-reversed t
  2397. "Non-nil means the latest state note will be directly after heading.
  2398. When nil, the state change notes will be ordered according to time.
  2399. This option can also be set with on a per-file-basis with
  2400. #+STARTUP: logstatesreversed
  2401. #+STARTUP: nologstatesreversed"
  2402. :group 'org-todo
  2403. :group 'org-progress
  2404. :type 'boolean)
  2405. (defcustom org-todo-repeat-to-state nil
  2406. "The TODO state to which a repeater should return the repeating task.
  2407. By default this is the first task in a TODO sequence, or the previous state
  2408. in a TODO_TYP set. But you can specify another task here.
  2409. alternatively, set the :REPEAT_TO_STATE: property of the entry."
  2410. :group 'org-todo
  2411. :version "24.1"
  2412. :type '(choice (const :tag "Head of sequence" nil)
  2413. (string :tag "Specific state")))
  2414. (defcustom org-log-repeat 'time
  2415. "Non-nil means record moving through the DONE state when triggering repeat.
  2416. An auto-repeating task is immediately switched back to TODO when
  2417. marked DONE. If you are not logging state changes (by adding \"@\"
  2418. or \"!\" to the TODO keyword definition), or set `org-log-done' to
  2419. record a closing note, there will be no record of the task moving
  2420. through DONE. This variable forces taking a note anyway.
  2421. nil Don't force a record
  2422. time Record a time stamp
  2423. note Prompt for a note and add it with template `org-log-note-headings'
  2424. This option can also be set with on a per-file-basis with
  2425. #+STARTUP: nologrepeat
  2426. #+STARTUP: logrepeat
  2427. #+STARTUP: lognoterepeat
  2428. You can have local logging settings for a subtree by setting the LOGGING
  2429. property to one or more of these keywords."
  2430. :group 'org-todo
  2431. :group 'org-progress
  2432. :type '(choice
  2433. (const :tag "Don't force a record" nil)
  2434. (const :tag "Force recording the DONE state" time)
  2435. (const :tag "Force recording a note with the DONE state" note)))
  2436. (defgroup org-priorities nil
  2437. "Priorities in Org-mode."
  2438. :tag "Org Priorities"
  2439. :group 'org-todo)
  2440. (defcustom org-enable-priority-commands t
  2441. "Non-nil means priority commands are active.
  2442. When nil, these commands will be disabled, so that you never accidentally
  2443. set a priority."
  2444. :group 'org-priorities
  2445. :type 'boolean)
  2446. (defcustom org-highest-priority ?A
  2447. "The highest priority of TODO items. A character like ?A, ?B etc.
  2448. Must have a smaller ASCII number than `org-lowest-priority'."
  2449. :group 'org-priorities
  2450. :type 'character)
  2451. (defcustom org-lowest-priority ?C
  2452. "The lowest priority of TODO items. A character like ?A, ?B etc.
  2453. Must have a larger ASCII number than `org-highest-priority'."
  2454. :group 'org-priorities
  2455. :type 'character)
  2456. (defcustom org-default-priority ?B
  2457. "The default priority of TODO items.
  2458. This is the priority an item gets if no explicit priority is given.
  2459. When starting to cycle on an empty priority the first step in the cycle
  2460. depends on `org-priority-start-cycle-with-default'. The resulting first
  2461. step priority must not exceed the range from `org-highest-priority' to
  2462. `org-lowest-priority' which means that `org-default-priority' has to be
  2463. in this range exclusive or inclusive the range boundaries. Else the
  2464. first step refuses to set the default and the second will fall back
  2465. to (depending on the command used) the highest or lowest priority."
  2466. :group 'org-priorities
  2467. :type 'character)
  2468. (defcustom org-priority-start-cycle-with-default t
  2469. "Non-nil means start with default priority when starting to cycle.
  2470. When this is nil, the first step in the cycle will be (depending on the
  2471. command used) one higher or lower than the default priority.
  2472. See also `org-default-priority'."
  2473. :group 'org-priorities
  2474. :type 'boolean)
  2475. (defcustom org-get-priority-function nil
  2476. "Function to extract the priority from a string.
  2477. The string is normally the headline. If this is nil Org computes the
  2478. priority from the priority cookie like [#A] in the headline. It returns
  2479. an integer, increasing by 1000 for each priority level.
  2480. The user can set a different function here, which should take a string
  2481. as an argument and return the numeric priority."
  2482. :group 'org-priorities
  2483. :version "24.1"
  2484. :type '(choice
  2485. (const nil)
  2486. (function)))
  2487. (defgroup org-time nil
  2488. "Options concerning time stamps and deadlines in Org-mode."
  2489. :tag "Org Time"
  2490. :group 'org)
  2491. (defcustom org-insert-labeled-timestamps-at-point nil
  2492. "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
  2493. When nil, these labeled time stamps are forces into the second line of an
  2494. entry, just after the headline. When scheduling from the global TODO list,
  2495. the time stamp will always be forced into the second line."
  2496. :group 'org-time
  2497. :type 'boolean)
  2498. (defconst org-time-stamp-formats '("<%Y-%m-%d %a>" . "<%Y-%m-%d %a %H:%M>")
  2499. "Formats for `format-time-string' which are used for time stamps.
  2500. It is not recommended to change this constant.")
  2501. (defcustom org-time-stamp-rounding-minutes '(0 5)
  2502. "Number of minutes to round time stamps to.
  2503. These are two values, the first applies when first creating a time stamp.
  2504. The second applies when changing it with the commands `S-up' and `S-down'.
  2505. When changing the time stamp, this means that it will change in steps
  2506. of N minutes, as given by the second value.
  2507. When a setting is 0 or 1, insert the time unmodified. Useful rounding
  2508. numbers should be factors of 60, so for example 5, 10, 15.
  2509. When this is larger than 1, you can still force an exact time stamp by using
  2510. a double prefix argument to a time stamp command like `C-c .' or `C-c !',
  2511. and by using a prefix arg to `S-up/down' to specify the exact number
  2512. of minutes to shift."
  2513. :group 'org-time
  2514. :get #'(lambda (var) ; Make sure both elements are there
  2515. (if (integerp (default-value var))
  2516. (list (default-value var) 5)
  2517. (default-value var)))
  2518. :type '(list
  2519. (integer :tag "when inserting times")
  2520. (integer :tag "when modifying times")))
  2521. ;; Normalize old customizations of this variable.
  2522. (when (integerp org-time-stamp-rounding-minutes)
  2523. (setq org-time-stamp-rounding-minutes
  2524. (list org-time-stamp-rounding-minutes
  2525. org-time-stamp-rounding-minutes)))
  2526. (defcustom org-display-custom-times nil
  2527. "Non-nil means overlay custom formats over all time stamps.
  2528. The formats are defined through the variable `org-time-stamp-custom-formats'.
  2529. To turn this on on a per-file basis, insert anywhere in the file:
  2530. #+STARTUP: customtime"
  2531. :group 'org-time
  2532. :set 'set-default
  2533. :type 'sexp)
  2534. (make-variable-buffer-local 'org-display-custom-times)
  2535. (defcustom org-time-stamp-custom-formats
  2536. '("<%m/%d/%y %a>" . "<%m/%d/%y %a %H:%M>") ; american
  2537. "Custom formats for time stamps. See `format-time-string' for the syntax.
  2538. These are overlaid over the default ISO format if the variable
  2539. `org-display-custom-times' is set. Time like %H:%M should be at the
  2540. end of the second format. The custom formats are also honored by export
  2541. commands, if custom time display is turned on at the time of export."
  2542. :group 'org-time
  2543. :type 'sexp)
  2544. (defun org-time-stamp-format (&optional long inactive)
  2545. "Get the right format for a time string."
  2546. (let ((f (if long (cdr org-time-stamp-formats)
  2547. (car org-time-stamp-formats))))
  2548. (if inactive
  2549. (concat "[" (substring f 1 -1) "]")
  2550. f)))
  2551. (defcustom org-time-clocksum-format
  2552. '(:days "%dd " :hours "%d" :require-hours t :minutes ":%02d" :require-minutes t)
  2553. "The format string used when creating CLOCKSUM lines.
  2554. This is also used when Org mode generates a time duration.
  2555. The value can be a single format string containing two
  2556. %-sequences, which will be filled with the number of hours and
  2557. minutes in that order.
  2558. Alternatively, the value can be a plist associating any of the
  2559. keys :years, :months, :weeks, :days, :hours or :minutes with
  2560. format strings. The time duration is formatted using only the
  2561. time components that are needed and concatenating the results.
  2562. If a time unit in absent, it falls back to the next smallest
  2563. unit.
  2564. The keys :require-years, :require-months, :require-days,
  2565. :require-weeks, :require-hours, :require-minutes are also
  2566. meaningful. A non-nil value for these keys indicates that the
  2567. corresponding time component should always be included, even if
  2568. its value is 0.
  2569. For example,
  2570. \(:days \"%dd\" :hours \"%d\" :require-hours t :minutes \":%02d\"
  2571. :require-minutes t)
  2572. means durations longer than a day will be expressed in days,
  2573. hours and minutes, and durations less than a day will always be
  2574. expressed in hours and minutes (even for durations less than an
  2575. hour).
  2576. The value
  2577. \(:days \"%dd\" :minutes \"%dm\")
  2578. means durations longer than a day will be expressed in days and
  2579. minutes, and durations less than a day will be expressed entirely
  2580. in minutes (even for durations longer than an hour)."
  2581. :group 'org-time
  2582. :group 'org-clock
  2583. :version "24.4"
  2584. :package-version '(Org . "8.0")
  2585. :type '(choice (string :tag "Format string")
  2586. (set :tag "Plist"
  2587. (group :inline t (const :tag "Years" :years)
  2588. (string :tag "Format string"))
  2589. (group :inline t
  2590. (const :tag "Always show years" :require-years)
  2591. (const t))
  2592. (group :inline t (const :tag "Months" :months)
  2593. (string :tag "Format string"))
  2594. (group :inline t
  2595. (const :tag "Always show months" :require-months)
  2596. (const t))
  2597. (group :inline t (const :tag "Weeks" :weeks)
  2598. (string :tag "Format string"))
  2599. (group :inline t
  2600. (const :tag "Always show weeks" :require-weeks)
  2601. (const t))
  2602. (group :inline t (const :tag "Days" :days)
  2603. (string :tag "Format string"))
  2604. (group :inline t
  2605. (const :tag "Always show days" :require-days)
  2606. (const t))
  2607. (group :inline t (const :tag "Hours" :hours)
  2608. (string :tag "Format string"))
  2609. (group :inline t
  2610. (const :tag "Always show hours" :require-hours)
  2611. (const t))
  2612. (group :inline t (const :tag "Minutes" :minutes)
  2613. (string :tag "Format string"))
  2614. (group :inline t
  2615. (const :tag "Always show minutes" :require-minutes)
  2616. (const t)))))
  2617. (defcustom org-time-clocksum-use-fractional nil
  2618. "When non-nil, \\[org-clock-display] uses fractional times.
  2619. See `org-time-clocksum-format' for more on time clock formats."
  2620. :group 'org-time
  2621. :group 'org-clock
  2622. :version "24.3"
  2623. :type 'boolean)
  2624. (defcustom org-time-clocksum-use-effort-durations nil
  2625. "When non-nil, \\[org-clock-display] uses effort durations.
  2626. E.g. by default, one day is considered to be a 8 hours effort,
  2627. so a task that has been clocked for 16 hours will be displayed
  2628. as during 2 days in the clock display or in the clocktable.
  2629. See `org-effort-durations' on how to set effort durations
  2630. and `org-time-clocksum-format' for more on time clock formats."
  2631. :group 'org-time
  2632. :group 'org-clock
  2633. :version "24.4"
  2634. :package-version '(Org . "8.0")
  2635. :type 'boolean)
  2636. (defcustom org-time-clocksum-fractional-format "%.2f"
  2637. "The format string used when creating CLOCKSUM lines,
  2638. or when Org mode generates a time duration, if
  2639. `org-time-clocksum-use-fractional' is enabled.
  2640. The value can be a single format string containing one
  2641. %-sequence, which will be filled with the number of hours as
  2642. a float.
  2643. Alternatively, the value can be a plist associating any of the
  2644. keys :years, :months, :weeks, :days, :hours or :minutes with
  2645. a format string. The time duration is formatted using the
  2646. largest time unit which gives a non-zero integer part. If all
  2647. specified formats have zero integer part, the smallest time unit
  2648. is used."
  2649. :group 'org-time
  2650. :type '(choice (string :tag "Format string")
  2651. (set (group :inline t (const :tag "Years" :years)
  2652. (string :tag "Format string"))
  2653. (group :inline t (const :tag "Months" :months)
  2654. (string :tag "Format string"))
  2655. (group :inline t (const :tag "Weeks" :weeks)
  2656. (string :tag "Format string"))
  2657. (group :inline t (const :tag "Days" :days)
  2658. (string :tag "Format string"))
  2659. (group :inline t (const :tag "Hours" :hours)
  2660. (string :tag "Format string"))
  2661. (group :inline t (const :tag "Minutes" :minutes)
  2662. (string :tag "Format string")))))
  2663. (defcustom org-deadline-warning-days 14
  2664. "Number of days before expiration during which a deadline becomes active.
  2665. This variable governs the display in sparse trees and in the agenda.
  2666. When 0 or negative, it means use this number (the absolute value of it)
  2667. even if a deadline has a different individual lead time specified.
  2668. Custom commands can set this variable in the options section."
  2669. :group 'org-time
  2670. :group 'org-agenda-daily/weekly
  2671. :type 'integer)
  2672. (defcustom org-scheduled-delay-days 0
  2673. "Number of days before a scheduled item becomes active.
  2674. This variable governs the display in sparse trees and in the agenda.
  2675. The default value (i.e. 0) means: don't delay scheduled item.
  2676. When negative, it means use this number (the absolute value of it)
  2677. even if a scheduled item has a different individual delay time
  2678. specified.
  2679. Custom commands can set this variable in the options section."
  2680. :group 'org-time
  2681. :group 'org-agenda-daily/weekly
  2682. :version "24.4"
  2683. :package-version '(Org . "8.0")
  2684. :type 'integer)
  2685. (defcustom org-read-date-prefer-future t
  2686. "Non-nil means assume future for incomplete date input from user.
  2687. This affects the following situations:
  2688. 1. The user gives a month but not a year.
  2689. For example, if it is April and you enter \"feb 2\", this will be read
  2690. as Feb 2, *next* year. \"May 5\", however, will be this year.
  2691. 2. The user gives a day, but no month.
  2692. For example, if today is the 15th, and you enter \"3\", Org-mode will
  2693. read this as the third of *next* month. However, if you enter \"17\",
  2694. it will be considered as *this* month.
  2695. If you set this variable to the symbol `time', then also the following
  2696. will work:
  2697. 3. If the user gives a time.
  2698. If the time is before now, it will be interpreted as tomorrow.
  2699. Currently none of this works for ISO week specifications.
  2700. When this option is nil, the current day, month and year will always be
  2701. used as defaults.
  2702. See also `org-agenda-jump-prefer-future'."
  2703. :group 'org-time
  2704. :type '(choice
  2705. (const :tag "Never" nil)
  2706. (const :tag "Check month and day" t)
  2707. (const :tag "Check month, day, and time" time)))
  2708. (defcustom org-agenda-jump-prefer-future 'org-read-date-prefer-future
  2709. "Should the agenda jump command prefer the future for incomplete dates?
  2710. The default is to do the same as configured in `org-read-date-prefer-future'.
  2711. But you can also set a deviating value here.
  2712. This may t or nil, or the symbol `org-read-date-prefer-future'."
  2713. :group 'org-agenda
  2714. :group 'org-time
  2715. :version "24.1"
  2716. :type '(choice
  2717. (const :tag "Use org-read-date-prefer-future"
  2718. org-read-date-prefer-future)
  2719. (const :tag "Never" nil)
  2720. (const :tag "Always" t)))
  2721. (defcustom org-read-date-force-compatible-dates t
  2722. "Should date/time prompt force dates that are guaranteed to work in Emacs?
  2723. Depending on the system Emacs is running on, certain dates cannot
  2724. be represented with the type used internally to represent time.
  2725. Dates between 1970-1-1 and 2038-1-1 can always be represented
  2726. correctly. Some systems allow for earlier dates, some for later,
  2727. some for both. One way to find out it to insert any date into an
  2728. Org buffer, putting the cursor on the year and hitting S-up and
  2729. S-down to test the range.
  2730. When this variable is set to t, the date/time prompt will not let
  2731. you specify dates outside the 1970-2037 range, so it is certain that
  2732. these dates will work in whatever version of Emacs you are
  2733. running, and also that you can move a file from one Emacs implementation
  2734. to another. WHenever Org is forcing the year for you, it will display
  2735. a message and beep.
  2736. When this variable is nil, Org will check if the date is
  2737. representable in the specific Emacs implementation you are using.
  2738. If not, it will force a year, usually the current year, and beep
  2739. to remind you. Currently this setting is not recommended because
  2740. the likelihood that you will open your Org files in an Emacs that
  2741. has limited date range is not negligible.
  2742. A workaround for this problem is to use diary sexp dates for time
  2743. stamps outside of this range."
  2744. :group 'org-time
  2745. :version "24.1"
  2746. :type 'boolean)
  2747. (defcustom org-read-date-display-live t
  2748. "Non-nil means display current interpretation of date prompt live.
  2749. This display will be in an overlay, in the minibuffer."
  2750. :group 'org-time
  2751. :type 'boolean)
  2752. (defcustom org-read-date-popup-calendar t
  2753. "Non-nil means pop up a calendar when prompting for a date.
  2754. In the calendar, the date can be selected with mouse-1. However, the
  2755. minibuffer will also be active, and you can simply enter the date as well.
  2756. When nil, only the minibuffer will be available."
  2757. :group 'org-time
  2758. :type 'boolean)
  2759. (org-defvaralias 'org-popup-calendar-for-date-prompt
  2760. 'org-read-date-popup-calendar)
  2761. (make-obsolete-variable
  2762. 'org-read-date-minibuffer-setup-hook
  2763. "Set `org-read-date-minibuffer-local-map' instead." "24.4")
  2764. (defcustom org-read-date-minibuffer-setup-hook nil
  2765. "Hook to be used to set up keys for the date/time interface.
  2766. Add key definitions to `minibuffer-local-map', which will be a
  2767. temporary copy.
  2768. WARNING: This option is obsolete, you should use
  2769. `org-read-date-minibuffer-local-map' to set up keys."
  2770. :group 'org-time
  2771. :type 'hook)
  2772. (defcustom org-extend-today-until 0
  2773. "The hour when your day really ends. Must be an integer.
  2774. This has influence for the following applications:
  2775. - When switching the agenda to \"today\". It it is still earlier than
  2776. the time given here, the day recognized as TODAY is actually yesterday.
  2777. - When a date is read from the user and it is still before the time given
  2778. here, the current date and time will be assumed to be yesterday, 23:59.
  2779. Also, timestamps inserted in capture templates follow this rule.
  2780. IMPORTANT: This is a feature whose implementation is and likely will
  2781. remain incomplete. Really, it is only here because past midnight seems to
  2782. be the favorite working time of John Wiegley :-)"
  2783. :group 'org-time
  2784. :type 'integer)
  2785. (defcustom org-use-effective-time nil
  2786. "If non-nil, consider `org-extend-today-until' when creating timestamps.
  2787. For example, if `org-extend-today-until' is 8, and it's 4am, then the
  2788. \"effective time\" of any timestamps between midnight and 8am will be
  2789. 23:59 of the previous day."
  2790. :group 'org-time
  2791. :version "24.1"
  2792. :type 'boolean)
  2793. (defcustom org-use-last-clock-out-time-as-effective-time nil
  2794. "When non-nil, use the last clock out time for `org-todo'.
  2795. Note that this option has precedence over the combined use of
  2796. `org-use-effective-time' and `org-extend-today-until'."
  2797. :group 'org-time
  2798. :version "24.4"
  2799. :package-version '(Org . "8.0")
  2800. :type 'boolean)
  2801. (defcustom org-edit-timestamp-down-means-later nil
  2802. "Non-nil means S-down will increase the time in a time stamp.
  2803. When nil, S-up will increase."
  2804. :group 'org-time
  2805. :type 'boolean)
  2806. (defcustom org-calendar-follow-timestamp-change t
  2807. "Non-nil means make the calendar window follow timestamp changes.
  2808. When a timestamp is modified and the calendar window is visible, it will be
  2809. moved to the new date."
  2810. :group 'org-time
  2811. :type 'boolean)
  2812. (defgroup org-tags nil
  2813. "Options concerning tags in Org-mode."
  2814. :tag "Org Tags"
  2815. :group 'org)
  2816. (defcustom org-tag-alist nil
  2817. "List of tags allowed in Org-mode files.
  2818. When this list is nil, Org-mode will base TAG input on what is already in the
  2819. buffer.
  2820. The value of this variable is an alist, the car of each entry must be a
  2821. keyword as a string, the cdr may be a character that is used to select
  2822. that tag through the fast-tag-selection interface.
  2823. See the manual for details."
  2824. :group 'org-tags
  2825. :type '(repeat
  2826. (choice
  2827. (cons (string :tag "Tag name")
  2828. (character :tag "Access char"))
  2829. (list :tag "Start radio group"
  2830. (const :startgroup)
  2831. (option (string :tag "Group description")))
  2832. (list :tag "Group tags delimiter"
  2833. (const :grouptags))
  2834. (list :tag "End radio group"
  2835. (const :endgroup)
  2836. (option (string :tag "Group description")))
  2837. (const :tag "New line" (:newline)))))
  2838. (defcustom org-tag-persistent-alist nil
  2839. "List of tags that will always appear in all Org-mode files.
  2840. This is in addition to any in buffer settings or customizations
  2841. of `org-tag-alist'.
  2842. When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
  2843. The value of this variable is an alist, the car of each entry must be a
  2844. keyword as a string, the cdr may be a character that is used to select
  2845. that tag through the fast-tag-selection interface.
  2846. See the manual for details.
  2847. To disable these tags on a per-file basis, insert anywhere in the file:
  2848. #+STARTUP: noptag"
  2849. :group 'org-tags
  2850. :type '(repeat
  2851. (choice
  2852. (cons (string :tag "Tag name")
  2853. (character :tag "Access char"))
  2854. (const :tag "Start radio group" (:startgroup))
  2855. (const :tag "Group tags delimiter" (:grouptags))
  2856. (const :tag "End radio group" (:endgroup))
  2857. (const :tag "New line" (:newline)))))
  2858. (defcustom org-complete-tags-always-offer-all-agenda-tags nil
  2859. "If non-nil, always offer completion for all tags of all agenda files.
  2860. Instead of customizing this variable directly, you might want to
  2861. set it locally for capture buffers, because there no list of
  2862. tags in that file can be created dynamically (there are none).
  2863. (add-hook 'org-capture-mode-hook
  2864. (lambda ()
  2865. (set (make-local-variable
  2866. 'org-complete-tags-always-offer-all-agenda-tags)
  2867. t)))"
  2868. :group 'org-tags
  2869. :version "24.1"
  2870. :type 'boolean)
  2871. (defvar org-file-tags nil
  2872. "List of tags that can be inherited by all entries in the file.
  2873. The tags will be inherited if the variable `org-use-tag-inheritance'
  2874. says they should be.
  2875. This variable is populated from #+FILETAGS lines.")
  2876. (defcustom org-use-fast-tag-selection 'auto
  2877. "Non-nil means use fast tag selection scheme.
  2878. This is a special interface to select and deselect tags with single keys.
  2879. When nil, fast selection is never used.
  2880. When the symbol `auto', fast selection is used if and only if selection
  2881. characters for tags have been configured, either through the variable
  2882. `org-tag-alist' or through a #+TAGS line in the buffer.
  2883. When t, fast selection is always used and selection keys are assigned
  2884. automatically if necessary."
  2885. :group 'org-tags
  2886. :type '(choice
  2887. (const :tag "Always" t)
  2888. (const :tag "Never" nil)
  2889. (const :tag "When selection characters are configured" auto)))
  2890. (defcustom org-fast-tag-selection-single-key nil
  2891. "Non-nil means fast tag selection exits after first change.
  2892. When nil, you have to press RET to exit it.
  2893. During fast tag selection, you can toggle this flag with `C-c'.
  2894. This variable can also have the value `expert'. In this case, the window
  2895. displaying the tags menu is not even shown, until you press C-c again."
  2896. :group 'org-tags
  2897. :type '(choice
  2898. (const :tag "No" nil)
  2899. (const :tag "Yes" t)
  2900. (const :tag "Expert" expert)))
  2901. (defvar org-fast-tag-selection-include-todo nil
  2902. "Non-nil means fast tags selection interface will also offer TODO states.
  2903. This is an undocumented feature, you should not rely on it.")
  2904. (defcustom org-tags-column (if (featurep 'xemacs) -76 -77)
  2905. "The column to which tags should be indented in a headline.
  2906. If this number is positive, it specifies the column. If it is negative,
  2907. it means that the tags should be flushright to that column. For example,
  2908. -80 works well for a normal 80 character screen.
  2909. When 0, place tags directly after headline text, with only one space in
  2910. between."
  2911. :group 'org-tags
  2912. :type 'integer)
  2913. (defcustom org-auto-align-tags t
  2914. "Non-nil keeps tags aligned when modifying headlines.
  2915. Some operations (i.e. demoting) change the length of a headline and
  2916. therefore shift the tags around. With this option turned on, after
  2917. each such operation the tags are again aligned to `org-tags-column'."
  2918. :group 'org-tags
  2919. :type 'boolean)
  2920. (defcustom org-use-tag-inheritance t
  2921. "Non-nil means tags in levels apply also for sublevels.
  2922. When nil, only the tags directly given in a specific line apply there.
  2923. This may also be a list of tags that should be inherited, or a regexp that
  2924. matches tags that should be inherited. Additional control is possible
  2925. with the variable `org-tags-exclude-from-inheritance' which gives an
  2926. explicit list of tags to be excluded from inheritance, even if the value of
  2927. `org-use-tag-inheritance' would select it for inheritance.
  2928. If this option is t, a match early-on in a tree can lead to a large
  2929. number of matches in the subtree when constructing the agenda or creating
  2930. a sparse tree. If you only want to see the first match in a tree during
  2931. a search, check out the variable `org-tags-match-list-sublevels'."
  2932. :group 'org-tags
  2933. :type '(choice
  2934. (const :tag "Not" nil)
  2935. (const :tag "Always" t)
  2936. (repeat :tag "Specific tags" (string :tag "Tag"))
  2937. (regexp :tag "Tags matched by regexp")))
  2938. (defcustom org-tags-exclude-from-inheritance nil
  2939. "List of tags that should never be inherited.
  2940. This is a way to exclude a few tags from inheritance. For way to do
  2941. the opposite, to actively allow inheritance for selected tags,
  2942. see the variable `org-use-tag-inheritance'."
  2943. :group 'org-tags
  2944. :type '(repeat (string :tag "Tag")))
  2945. (defun org-tag-inherit-p (tag)
  2946. "Check if TAG is one that should be inherited."
  2947. (cond
  2948. ((member tag org-tags-exclude-from-inheritance) nil)
  2949. ((eq org-use-tag-inheritance t) t)
  2950. ((not org-use-tag-inheritance) nil)
  2951. ((stringp org-use-tag-inheritance)
  2952. (string-match org-use-tag-inheritance tag))
  2953. ((listp org-use-tag-inheritance)
  2954. (member tag org-use-tag-inheritance))
  2955. (t (error "Invalid setting of `org-use-tag-inheritance'"))))
  2956. (defcustom org-tags-match-list-sublevels t
  2957. "Non-nil means list also sublevels of headlines matching a search.
  2958. This variable applies to tags/property searches, and also to stuck
  2959. projects because this search is based on a tags match as well.
  2960. When set to the symbol `indented', sublevels are indented with
  2961. leading dots.
  2962. Because of tag inheritance (see variable `org-use-tag-inheritance'),
  2963. the sublevels of a headline matching a tag search often also match
  2964. the same search. Listing all of them can create very long lists.
  2965. Setting this variable to nil causes subtrees of a match to be skipped.
  2966. This variable is semi-obsolete and probably should always be true. It
  2967. is better to limit inheritance to certain tags using the variables
  2968. `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
  2969. :group 'org-tags
  2970. :type '(choice
  2971. (const :tag "No, don't list them" nil)
  2972. (const :tag "Yes, do list them" t)
  2973. (const :tag "List them, indented with leading dots" indented)))
  2974. (defcustom org-tags-sort-function nil
  2975. "When set, tags are sorted using this function as a comparator."
  2976. :group 'org-tags
  2977. :type '(choice
  2978. (const :tag "No sorting" nil)
  2979. (const :tag "Alphabetical" string<)
  2980. (const :tag "Reverse alphabetical" string>)
  2981. (function :tag "Custom function" nil)))
  2982. (defvar org-tags-history nil
  2983. "History of minibuffer reads for tags.")
  2984. (defvar org-last-tags-completion-table nil
  2985. "The last used completion table for tags.")
  2986. (defvar org-after-tags-change-hook nil
  2987. "Hook that is run after the tags in a line have changed.")
  2988. (defgroup org-properties nil
  2989. "Options concerning properties in Org-mode."
  2990. :tag "Org Properties"
  2991. :group 'org)
  2992. (defcustom org-property-format "%-10s %s"
  2993. "How property key/value pairs should be formatted by `indent-line'.
  2994. When `indent-line' hits a property definition, it will format the line
  2995. according to this format, mainly to make sure that the values are
  2996. lined-up with respect to each other."
  2997. :group 'org-properties
  2998. :type 'string)
  2999. (defcustom org-properties-postprocess-alist nil
  3000. "Alist of properties and functions to adjust inserted values.
  3001. Elements of this alist must be of the form
  3002. ([string] [function])
  3003. where [string] must be a property name and [function] must be a
  3004. lambda expression: this lambda expression must take one argument,
  3005. the value to adjust, and return the new value as a string.
  3006. For example, this element will allow the property \"Remaining\"
  3007. to be updated wrt the relation between the \"Effort\" property
  3008. and the clock summary:
  3009. ((\"Remaining\" (lambda(value)
  3010. (let ((clocksum (org-clock-sum-current-item))
  3011. (effort (org-duration-string-to-minutes
  3012. (org-entry-get (point) \"Effort\"))))
  3013. (org-minutes-to-clocksum-string (- effort clocksum))))))"
  3014. :group 'org-properties
  3015. :version "24.1"
  3016. :type '(alist :key-type (string :tag "Property")
  3017. :value-type (function :tag "Function")))
  3018. (defcustom org-use-property-inheritance nil
  3019. "Non-nil means properties apply also for sublevels.
  3020. This setting is chiefly used during property searches. Turning it on can
  3021. cause significant overhead when doing a search, which is why it is not
  3022. on by default.
  3023. When nil, only the properties directly given in the current entry count.
  3024. When t, every property is inherited. The value may also be a list of
  3025. properties that should have inheritance, or a regular expression matching
  3026. properties that should be inherited.
  3027. However, note that some special properties use inheritance under special
  3028. circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
  3029. and the properties ending in \"_ALL\" when they are used as descriptor
  3030. for valid values of a property.
  3031. Note for programmers:
  3032. When querying an entry with `org-entry-get', you can control if inheritance
  3033. should be used. By default, `org-entry-get' looks only at the local
  3034. properties. You can request inheritance by setting the inherit argument
  3035. to t (to force inheritance) or to `selective' (to respect the setting
  3036. in this variable)."
  3037. :group 'org-properties
  3038. :type '(choice
  3039. (const :tag "Not" nil)
  3040. (const :tag "Always" t)
  3041. (repeat :tag "Specific properties" (string :tag "Property"))
  3042. (regexp :tag "Properties matched by regexp")))
  3043. (defun org-property-inherit-p (property)
  3044. "Check if PROPERTY is one that should be inherited."
  3045. (cond
  3046. ((eq org-use-property-inheritance t) t)
  3047. ((not org-use-property-inheritance) nil)
  3048. ((stringp org-use-property-inheritance)
  3049. (string-match org-use-property-inheritance property))
  3050. ((listp org-use-property-inheritance)
  3051. (member property org-use-property-inheritance))
  3052. (t (error "Invalid setting of `org-use-property-inheritance'"))))
  3053. (defcustom org-columns-default-format "%25ITEM %TODO %3PRIORITY %TAGS"
  3054. "The default column format, if no other format has been defined.
  3055. This variable can be set on the per-file basis by inserting a line
  3056. #+COLUMNS: %25ITEM ....."
  3057. :group 'org-properties
  3058. :type 'string)
  3059. (defcustom org-columns-ellipses ".."
  3060. "The ellipses to be used when a field in column view is truncated.
  3061. When this is the empty string, as many characters as possible are shown,
  3062. but then there will be no visual indication that the field has been truncated.
  3063. When this is a string of length N, the last N characters of a truncated
  3064. field are replaced by this string. If the column is narrower than the
  3065. ellipses string, only part of the ellipses string will be shown."
  3066. :group 'org-properties
  3067. :type 'string)
  3068. (defcustom org-columns-modify-value-for-display-function nil
  3069. "Function that modifies values for display in column view.
  3070. For example, it can be used to cut out a certain part from a time stamp.
  3071. The function must take 2 arguments:
  3072. column-title The title of the column (*not* the property name)
  3073. value The value that should be modified.
  3074. The function should return the value that should be displayed,
  3075. or nil if the normal value should be used."
  3076. :group 'org-properties
  3077. :type '(choice (const nil) (function)))
  3078. (defcustom org-effort-property "Effort"
  3079. "The property that is being used to keep track of effort estimates.
  3080. Effort estimates given in this property need to have the format H:MM."
  3081. :group 'org-properties
  3082. :group 'org-progress
  3083. :type '(string :tag "Property"))
  3084. (defconst org-global-properties-fixed
  3085. '(("VISIBILITY_ALL" . "folded children content all")
  3086. ("CLOCK_MODELINE_TOTAL_ALL" . "current today repeat all auto"))
  3087. "List of property/value pairs that can be inherited by any entry.
  3088. These are fixed values, for the preset properties. The user variable
  3089. that can be used to add to this list is `org-global-properties'.
  3090. The entries in this list are cons cells where the car is a property
  3091. name and cdr is a string with the value. If the value represents
  3092. multiple items like an \"_ALL\" property, separate the items by
  3093. spaces.")
  3094. (defcustom org-global-properties nil
  3095. "List of property/value pairs that can be inherited by any entry.
  3096. This list will be combined with the constant `org-global-properties-fixed'.
  3097. The entries in this list are cons cells where the car is a property
  3098. name and cdr is a string with the value.
  3099. You can set buffer-local values for the same purpose in the variable
  3100. `org-file-properties' this by adding lines like
  3101. #+PROPERTY: NAME VALUE"
  3102. :group 'org-properties
  3103. :type '(repeat
  3104. (cons (string :tag "Property")
  3105. (string :tag "Value"))))
  3106. (defvar org-file-properties nil
  3107. "List of property/value pairs that can be inherited by any entry.
  3108. Valid for the current buffer.
  3109. This variable is populated from #+PROPERTY lines.")
  3110. (make-variable-buffer-local 'org-file-properties)
  3111. (defgroup org-agenda nil
  3112. "Options concerning agenda views in Org-mode."
  3113. :tag "Org Agenda"
  3114. :group 'org)
  3115. (defvar org-category nil
  3116. "Variable used by org files to set a category for agenda display.
  3117. Such files should use a file variable to set it, for example
  3118. # -*- mode: org; org-category: \"ELisp\"
  3119. or contain a special line
  3120. #+CATEGORY: ELisp
  3121. If the file does not specify a category, then file's base name
  3122. is used instead.")
  3123. (make-variable-buffer-local 'org-category)
  3124. (put 'org-category 'safe-local-variable #'(lambda (x) (or (symbolp x) (stringp x))))
  3125. (defcustom org-agenda-files nil
  3126. "The files to be used for agenda display.
  3127. Entries may be added to this list with \\[org-agenda-file-to-front] and removed with
  3128. \\[org-remove-file]. You can also use customize to edit the list.
  3129. If an entry is a directory, all files in that directory that are matched by
  3130. `org-agenda-file-regexp' will be part of the file list.
  3131. If the value of the variable is not a list but a single file name, then
  3132. the list of agenda files is actually stored and maintained in that file, one
  3133. agenda file per line. In this file paths can be given relative to
  3134. `org-directory'. Tilde expansion and environment variable substitution
  3135. are also made."
  3136. :group 'org-agenda
  3137. :type '(choice
  3138. (repeat :tag "List of files and directories" file)
  3139. (file :tag "Store list in a file\n" :value "~/.agenda_files")))
  3140. (defcustom org-agenda-file-regexp "\\`[^.].*\\.org\\'"
  3141. "Regular expression to match files for `org-agenda-files'.
  3142. If any element in the list in that variable contains a directory instead
  3143. of a normal file, all files in that directory that are matched by this
  3144. regular expression will be included."
  3145. :group 'org-agenda
  3146. :type 'regexp)
  3147. (defcustom org-agenda-text-search-extra-files nil
  3148. "List of extra files to be searched by text search commands.
  3149. These files will be searched in addition to the agenda files by the
  3150. commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
  3151. Note that these files will only be searched for text search commands,
  3152. not for the other agenda views like todo lists, tag searches or the weekly
  3153. agenda. This variable is intended to list notes and possibly archive files
  3154. that should also be searched by these two commands.
  3155. In fact, if the first element in the list is the symbol `agenda-archives',
  3156. then all archive files of all agenda files will be added to the search
  3157. scope."
  3158. :group 'org-agenda
  3159. :type '(set :greedy t
  3160. (const :tag "Agenda Archives" agenda-archives)
  3161. (repeat :inline t (file))))
  3162. (org-defvaralias 'org-agenda-multi-occur-extra-files
  3163. 'org-agenda-text-search-extra-files)
  3164. (defcustom org-agenda-skip-unavailable-files nil
  3165. "Non-nil means to just skip non-reachable files in `org-agenda-files'.
  3166. A nil value means to remove them, after a query, from the list."
  3167. :group 'org-agenda
  3168. :type 'boolean)
  3169. (defcustom org-calendar-to-agenda-key [?c]
  3170. "The key to be installed in `calendar-mode-map' for switching to the agenda.
  3171. The command `org-calendar-goto-agenda' will be bound to this key. The
  3172. default is the character `c' because then `c' can be used to switch back and
  3173. forth between agenda and calendar."
  3174. :group 'org-agenda
  3175. :type 'sexp)
  3176. (defcustom org-calendar-insert-diary-entry-key [?i]
  3177. "The key to be installed in `calendar-mode-map' for adding diary entries.
  3178. This option is irrelevant until `org-agenda-diary-file' has been configured
  3179. to point to an Org-mode file. When that is the case, the command
  3180. `org-agenda-diary-entry' will be bound to the key given here, by default
  3181. `i'. In the calendar, `i' normally adds entries to `diary-file'. So
  3182. if you want to continue doing this, you need to change this to a different
  3183. key."
  3184. :group 'org-agenda
  3185. :type 'sexp)
  3186. (defcustom org-agenda-diary-file 'diary-file
  3187. "File to which to add new entries with the `i' key in agenda and calendar.
  3188. When this is the symbol `diary-file', the functionality in the Emacs
  3189. calendar will be used to add entries to the `diary-file'. But when this
  3190. points to a file, `org-agenda-diary-entry' will be used instead."
  3191. :group 'org-agenda
  3192. :type '(choice
  3193. (const :tag "The standard Emacs diary file" diary-file)
  3194. (file :tag "Special Org file diary entries")))
  3195. (eval-after-load "calendar"
  3196. '(progn
  3197. (org-defkey calendar-mode-map org-calendar-to-agenda-key
  3198. 'org-calendar-goto-agenda)
  3199. (add-hook 'calendar-mode-hook
  3200. (lambda ()
  3201. (unless (eq org-agenda-diary-file 'diary-file)
  3202. (define-key calendar-mode-map
  3203. org-calendar-insert-diary-entry-key
  3204. 'org-agenda-diary-entry))))))
  3205. (defgroup org-latex nil
  3206. "Options for embedding LaTeX code into Org-mode."
  3207. :tag "Org LaTeX"
  3208. :group 'org)
  3209. (defcustom org-format-latex-options
  3210. '(:foreground default :background default :scale 1.0
  3211. :html-foreground "Black" :html-background "Transparent"
  3212. :html-scale 1.0 :matchers ("begin" "$1" "$" "$$" "\\(" "\\["))
  3213. "Options for creating images from LaTeX fragments.
  3214. This is a property list with the following properties:
  3215. :foreground the foreground color for images embedded in Emacs, e.g. \"Black\".
  3216. `default' means use the foreground of the default face.
  3217. `auto' means use the foreground from the text face.
  3218. :background the background color, or \"Transparent\".
  3219. `default' means use the background of the default face.
  3220. `auto' means use the background from the text face.
  3221. :scale a scaling factor for the size of the images, to get more pixels
  3222. :html-foreground, :html-background, :html-scale
  3223. the same numbers for HTML export.
  3224. :matchers a list indicating which matchers should be used to
  3225. find LaTeX fragments. Valid members of this list are:
  3226. \"begin\" find environments
  3227. \"$1\" find single characters surrounded by $.$
  3228. \"$\" find math expressions surrounded by $...$
  3229. \"$$\" find math expressions surrounded by $$....$$
  3230. \"\\(\" find math expressions surrounded by \\(...\\)
  3231. \"\\ [\" find math expressions surrounded by \\ [...\\]"
  3232. :group 'org-latex
  3233. :type 'plist)
  3234. (defcustom org-format-latex-signal-error t
  3235. "Non-nil means signal an error when image creation of LaTeX snippets fails.
  3236. When nil, just push out a message."
  3237. :group 'org-latex
  3238. :version "24.1"
  3239. :type 'boolean)
  3240. (defcustom org-latex-to-mathml-jar-file nil
  3241. "Value of\"%j\" in `org-latex-to-mathml-convert-command'.
  3242. Use this to specify additional executable file say a jar file.
  3243. When using MathToWeb as the converter, specify the full-path to
  3244. your mathtoweb.jar file."
  3245. :group 'org-latex
  3246. :version "24.1"
  3247. :type '(choice
  3248. (const :tag "None" nil)
  3249. (file :tag "JAR file" :must-match t)))
  3250. (defcustom org-latex-to-mathml-convert-command nil
  3251. "Command to convert LaTeX fragments to MathML.
  3252. Replace format-specifiers in the command as noted below and use
  3253. `shell-command' to convert LaTeX to MathML.
  3254. %j: Executable file in fully expanded form as specified by
  3255. `org-latex-to-mathml-jar-file'.
  3256. %I: Input LaTeX file in fully expanded form
  3257. %o: Output MathML file
  3258. This command is used by `org-create-math-formula'.
  3259. When using MathToWeb as the converter, set this to
  3260. \"java -jar %j -unicode -force -df %o %I\"."
  3261. :group 'org-latex
  3262. :version "24.1"
  3263. :type '(choice
  3264. (const :tag "None" nil)
  3265. (string :tag "\nShell command")))
  3266. (defcustom org-latex-create-formula-image-program 'dvipng
  3267. "Program to convert LaTeX fragments with.
  3268. dvipng Process the LaTeX fragments to dvi file, then convert
  3269. dvi files to png files using dvipng.
  3270. This will also include processing of non-math environments.
  3271. imagemagick Convert the LaTeX fragments to pdf files and use imagemagick
  3272. to convert pdf files to png files"
  3273. :group 'org-latex
  3274. :version "24.1"
  3275. :type '(choice
  3276. (const :tag "dvipng" dvipng)
  3277. (const :tag "imagemagick" imagemagick)))
  3278. (defcustom org-latex-preview-ltxpng-directory "ltxpng/"
  3279. "Path to store latex preview images.
  3280. A relative path here creates many directories relative to the
  3281. processed org files paths. An absolute path puts all preview
  3282. images at the same place."
  3283. :group 'org-latex
  3284. :version "24.3"
  3285. :type 'string)
  3286. (defun org-format-latex-mathml-available-p ()
  3287. "Return t if `org-latex-to-mathml-convert-command' is usable."
  3288. (save-match-data
  3289. (when (and (boundp 'org-latex-to-mathml-convert-command)
  3290. org-latex-to-mathml-convert-command)
  3291. (let ((executable (car (split-string
  3292. org-latex-to-mathml-convert-command))))
  3293. (when (executable-find executable)
  3294. (if (string-match
  3295. "%j" org-latex-to-mathml-convert-command)
  3296. (file-readable-p org-latex-to-mathml-jar-file)
  3297. t))))))
  3298. (defcustom org-format-latex-header "\\documentclass{article}
  3299. \\usepackage[usenames]{color}
  3300. \[PACKAGES]
  3301. \[DEFAULT-PACKAGES]
  3302. \\pagestyle{empty} % do not remove
  3303. % The settings below are copied from fullpage.sty
  3304. \\setlength{\\textwidth}{\\paperwidth}
  3305. \\addtolength{\\textwidth}{-3cm}
  3306. \\setlength{\\oddsidemargin}{1.5cm}
  3307. \\addtolength{\\oddsidemargin}{-2.54cm}
  3308. \\setlength{\\evensidemargin}{\\oddsidemargin}
  3309. \\setlength{\\textheight}{\\paperheight}
  3310. \\addtolength{\\textheight}{-\\headheight}
  3311. \\addtolength{\\textheight}{-\\headsep}
  3312. \\addtolength{\\textheight}{-\\footskip}
  3313. \\addtolength{\\textheight}{-3cm}
  3314. \\setlength{\\topmargin}{1.5cm}
  3315. \\addtolength{\\topmargin}{-2.54cm}"
  3316. "The document header used for processing LaTeX fragments.
  3317. It is imperative that this header make sure that no page number
  3318. appears on the page. The package defined in the variables
  3319. `org-latex-default-packages-alist' and `org-latex-packages-alist'
  3320. will either replace the placeholder \"[PACKAGES]\" in this
  3321. header, or they will be appended."
  3322. :group 'org-latex
  3323. :type 'string)
  3324. (defun org-set-packages-alist (var val)
  3325. "Set the packages alist and make sure it has 3 elements per entry."
  3326. (set var (mapcar (lambda (x)
  3327. (if (and (consp x) (= (length x) 2))
  3328. (list (car x) (nth 1 x) t)
  3329. x))
  3330. val)))
  3331. (defun org-get-packages-alist (var)
  3332. "Get the packages alist and make sure it has 3 elements per entry."
  3333. (mapcar (lambda (x)
  3334. (if (and (consp x) (= (length x) 2))
  3335. (list (car x) (nth 1 x) t)
  3336. x))
  3337. (default-value var)))
  3338. (defcustom org-latex-default-packages-alist
  3339. '(("AUTO" "inputenc" t)
  3340. ("T1" "fontenc" t)
  3341. ("" "fixltx2e" nil)
  3342. ("" "graphicx" t)
  3343. ("" "longtable" nil)
  3344. ("" "float" nil)
  3345. ("" "wrapfig" nil)
  3346. ("" "rotating" nil)
  3347. ("normalem" "ulem" t)
  3348. ("" "amsmath" t)
  3349. ("" "textcomp" t)
  3350. ("" "marvosym" t)
  3351. ("" "wasysym" t)
  3352. ("" "amssymb" t)
  3353. ("" "hyperref" nil)
  3354. "\\tolerance=1000")
  3355. "Alist of default packages to be inserted in the header.
  3356. Change this only if one of the packages here causes an
  3357. incompatibility with another package you are using.
  3358. The packages in this list are needed by one part or another of
  3359. Org mode to function properly:
  3360. - inputenc, fontenc: for basic font and character selection
  3361. - fixltx2e: Important patches of LaTeX itself
  3362. - graphicx: for including images
  3363. - longtable: For multipage tables
  3364. - float, wrapfig: for figure placement
  3365. - rotating: for sideways figures and tables
  3366. - ulem: for underline and strike-through
  3367. - amsmath: for subscript and superscript and math environments
  3368. - textcomp, marvosymb, wasysym, amssymb: for various symbols used
  3369. for interpreting the entities in `org-entities'. You can skip
  3370. some of these packages if you don't use any of their symbols.
  3371. - hyperref: for cross references
  3372. Therefore you should not modify this variable unless you know
  3373. what you are doing. The one reason to change it anyway is that
  3374. you might be loading some other package that conflicts with one
  3375. of the default packages. Each cell is of the format
  3376. \( \"options\" \"package\" snippet-flag). If SNIPPET-FLAG is t,
  3377. the package also needs to be included when compiling LaTeX
  3378. snippets into images for inclusion into non-LaTeX output."
  3379. :group 'org-latex
  3380. :group 'org-export-latex
  3381. :set 'org-set-packages-alist
  3382. :get 'org-get-packages-alist
  3383. :version "24.1"
  3384. :type '(repeat
  3385. (choice
  3386. (list :tag "options/package pair"
  3387. (string :tag "options")
  3388. (string :tag "package")
  3389. (boolean :tag "Snippet"))
  3390. (string :tag "A line of LaTeX"))))
  3391. (defcustom org-latex-packages-alist nil
  3392. "Alist of packages to be inserted in every LaTeX header.
  3393. These will be inserted after `org-latex-default-packages-alist'.
  3394. Each cell is of the format:
  3395. \(\"options\" \"package\" snippet-flag)
  3396. SNIPPET-FLAG, when t, indicates that this package is also needed
  3397. when turning LaTeX snippets into images for inclusion into
  3398. non-LaTeX output.
  3399. Make sure that you only list packages here which:
  3400. - you want in every file
  3401. - do not conflict with the setup in `org-format-latex-header'.
  3402. - do not conflict with the default packages in
  3403. `org-latex-default-packages-alist'."
  3404. :group 'org-latex
  3405. :group 'org-export-latex
  3406. :set 'org-set-packages-alist
  3407. :get 'org-get-packages-alist
  3408. :type '(repeat
  3409. (choice
  3410. (list :tag "options/package pair"
  3411. (string :tag "options")
  3412. (string :tag "package")
  3413. (boolean :tag "Snippet"))
  3414. (string :tag "A line of LaTeX"))))
  3415. (defgroup org-appearance nil
  3416. "Settings for Org-mode appearance."
  3417. :tag "Org Appearance"
  3418. :group 'org)
  3419. (defcustom org-level-color-stars-only nil
  3420. "Non-nil means fontify only the stars in each headline.
  3421. When nil, the entire headline is fontified.
  3422. Changing it requires restart of `font-lock-mode' to become effective
  3423. also in regions already fontified."
  3424. :group 'org-appearance
  3425. :type 'boolean)
  3426. (defcustom org-hide-leading-stars nil
  3427. "Non-nil means hide the first N-1 stars in a headline.
  3428. This works by using the face `org-hide' for these stars. This
  3429. face is white for a light background, and black for a dark
  3430. background. You may have to customize the face `org-hide' to
  3431. make this work.
  3432. Changing it requires restart of `font-lock-mode' to become effective
  3433. also in regions already fontified.
  3434. You may also set this on a per-file basis by adding one of the following
  3435. lines to the buffer:
  3436. #+STARTUP: hidestars
  3437. #+STARTUP: showstars"
  3438. :group 'org-appearance
  3439. :type 'boolean)
  3440. (defcustom org-hidden-keywords nil
  3441. "List of symbols corresponding to keywords to be hidden the org buffer.
  3442. For example, a value '(title) for this list will make the document's title
  3443. appear in the buffer without the initial #+TITLE: keyword."
  3444. :group 'org-appearance
  3445. :version "24.1"
  3446. :type '(set (const :tag "#+AUTHOR" author)
  3447. (const :tag "#+DATE" date)
  3448. (const :tag "#+EMAIL" email)
  3449. (const :tag "#+TITLE" title)))
  3450. (defcustom org-custom-properties nil
  3451. "List of properties (as strings) with a special meaning.
  3452. The default use of these custom properties is to let the user
  3453. hide them with `org-toggle-custom-properties-visibility'."
  3454. :group 'org-properties
  3455. :group 'org-appearance
  3456. :version "24.3"
  3457. :type '(repeat (string :tag "Property Name")))
  3458. (defcustom org-fontify-done-headline nil
  3459. "Non-nil means change the face of a headline if it is marked DONE.
  3460. Normally, only the TODO/DONE keyword indicates the state of a headline.
  3461. When this is non-nil, the headline after the keyword is set to the
  3462. `org-headline-done' as an additional indication."
  3463. :group 'org-appearance
  3464. :type 'boolean)
  3465. (defcustom org-fontify-emphasized-text t
  3466. "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
  3467. Changing this variable requires a restart of Emacs to take effect."
  3468. :group 'org-appearance
  3469. :type 'boolean)
  3470. (defcustom org-fontify-whole-heading-line nil
  3471. "Non-nil means fontify the whole line for headings.
  3472. This is useful when setting a background color for the
  3473. org-level-* faces."
  3474. :group 'org-appearance
  3475. :type 'boolean)
  3476. (defcustom org-highlight-latex-and-related nil
  3477. "Non-nil means highlight LaTeX related syntax in the buffer.
  3478. When non nil, the value should be a list containing any of the
  3479. following symbols:
  3480. `latex' Highlight LaTeX snippets and environments.
  3481. `script' Highlight subscript and superscript.
  3482. `entities' Highlight entities."
  3483. :group 'org-appearance
  3484. :version "24.4"
  3485. :package-version '(Org . "8.0")
  3486. :type '(choice
  3487. (const :tag "No highlighting" nil)
  3488. (set :greedy t :tag "Highlight"
  3489. (const :tag "LaTeX snippets and environments" latex)
  3490. (const :tag "Subscript and superscript" script)
  3491. (const :tag "Entities" entities))))
  3492. (defcustom org-hide-emphasis-markers nil
  3493. "Non-nil mean font-lock should hide the emphasis marker characters."
  3494. :group 'org-appearance
  3495. :type 'boolean)
  3496. (defcustom org-pretty-entities nil
  3497. "Non-nil means show entities as UTF8 characters.
  3498. When nil, the \\name form remains in the buffer."
  3499. :group 'org-appearance
  3500. :version "24.1"
  3501. :type 'boolean)
  3502. (defcustom org-pretty-entities-include-sub-superscripts t
  3503. "Non-nil means, pretty entity display includes formatting sub/superscripts."
  3504. :group 'org-appearance
  3505. :version "24.1"
  3506. :type 'boolean)
  3507. (defvar org-emph-re nil
  3508. "Regular expression for matching emphasis.
  3509. After a match, the match groups contain these elements:
  3510. 0 The match of the full regular expression, including the characters
  3511. before and after the proper match
  3512. 1 The character before the proper match, or empty at beginning of line
  3513. 2 The proper match, including the leading and trailing markers
  3514. 3 The leading marker like * or /, indicating the type of highlighting
  3515. 4 The text between the emphasis markers, not including the markers
  3516. 5 The character after the match, empty at the end of a line")
  3517. (defvar org-verbatim-re nil
  3518. "Regular expression for matching verbatim text.")
  3519. (defvar org-emphasis-regexp-components) ; defined just below
  3520. (defvar org-emphasis-alist) ; defined just below
  3521. (defun org-set-emph-re (var val)
  3522. "Set variable and compute the emphasis regular expression."
  3523. (set var val)
  3524. (when (and (boundp 'org-emphasis-alist)
  3525. (boundp 'org-emphasis-regexp-components)
  3526. org-emphasis-alist org-emphasis-regexp-components)
  3527. (let* ((e org-emphasis-regexp-components)
  3528. (pre (car e))
  3529. (post (nth 1 e))
  3530. (border (nth 2 e))
  3531. (body (nth 3 e))
  3532. (nl (nth 4 e))
  3533. (body1 (concat body "*?"))
  3534. (markers (mapconcat 'car org-emphasis-alist ""))
  3535. (vmarkers (mapconcat
  3536. (lambda (x) (if (eq (nth 2 x) 'verbatim) (car x) ""))
  3537. org-emphasis-alist "")))
  3538. ;; make sure special characters appear at the right position in the class
  3539. (if (string-match "\\^" markers)
  3540. (setq markers (concat (replace-match "" t t markers) "^")))
  3541. (if (string-match "-" markers)
  3542. (setq markers (concat (replace-match "" t t markers) "-")))
  3543. (if (string-match "\\^" vmarkers)
  3544. (setq vmarkers (concat (replace-match "" t t vmarkers) "^")))
  3545. (if (string-match "-" vmarkers)
  3546. (setq vmarkers (concat (replace-match "" t t vmarkers) "-")))
  3547. (if (> nl 0)
  3548. (setq body1 (concat body1 "\\(?:\n" body "*?\\)\\{0,"
  3549. (int-to-string nl) "\\}")))
  3550. ;; Make the regexp
  3551. (setq org-emph-re
  3552. (concat "\\([" pre "]\\|^\\)"
  3553. "\\("
  3554. "\\([" markers "]\\)"
  3555. "\\("
  3556. "[^" border "]\\|"
  3557. "[^" border "]"
  3558. body1
  3559. "[^" border "]"
  3560. "\\)"
  3561. "\\3\\)"
  3562. "\\([" post "]\\|$\\)"))
  3563. (setq org-verbatim-re
  3564. (concat "\\([" pre "]\\|^\\)"
  3565. "\\("
  3566. "\\([" vmarkers "]\\)"
  3567. "\\("
  3568. "[^" border "]\\|"
  3569. "[^" border "]"
  3570. body1
  3571. "[^" border "]"
  3572. "\\)"
  3573. "\\3\\)"
  3574. "\\([" post "]\\|$\\)")))))
  3575. ;; This used to be a defcustom (Org <8.0) but allowing the users to
  3576. ;; set this option proved cumbersome. See this message/thread:
  3577. ;; http://article.gmane.org/gmane.emacs.orgmode/68681
  3578. (defvar org-emphasis-regexp-components
  3579. '(" \t('\"{" "- \t.,:!?;'\")}\\" " \t\r\n,\"'" "." 1)
  3580. "Components used to build the regular expression for emphasis.
  3581. This is a list with five entries. Terminology: In an emphasis string
  3582. like \" *strong word* \", we call the initial space PREMATCH, the final
  3583. space POSTMATCH, the stars MARKERS, \"s\" and \"d\" are BORDER characters
  3584. and \"trong wor\" is the body. The different components in this variable
  3585. specify what is allowed/forbidden in each part:
  3586. pre Chars allowed as prematch. Beginning of line will be allowed too.
  3587. post Chars allowed as postmatch. End of line will be allowed too.
  3588. border The chars *forbidden* as border characters.
  3589. body-regexp A regexp like \".\" to match a body character. Don't use
  3590. non-shy groups here, and don't allow newline here.
  3591. newline The maximum number of newlines allowed in an emphasis exp.
  3592. You need to reload Org or to restart Emacs after customizing this.")
  3593. (defcustom org-emphasis-alist
  3594. `(("*" bold)
  3595. ("/" italic)
  3596. ("_" underline)
  3597. ("=" org-code verbatim)
  3598. ("~" org-verbatim verbatim)
  3599. ("+" ,(if (featurep 'xemacs) 'org-table '(:strike-through t))))
  3600. "Alist of characters and faces to emphasize text.
  3601. Text starting and ending with a special character will be emphasized,
  3602. for example *bold*, _underlined_ and /italic/. This variable sets the
  3603. marker characters and the face to be used by font-lock for highlighting
  3604. in Org-mode Emacs buffers.
  3605. You need to reload Org or to restart Emacs after customizing this."
  3606. :group 'org-appearance
  3607. :set 'org-set-emph-re
  3608. :version "24.4"
  3609. :package-version '(Org . "8.0")
  3610. :type '(repeat
  3611. (list
  3612. (string :tag "Marker character")
  3613. (choice
  3614. (face :tag "Font-lock-face")
  3615. (plist :tag "Face property list"))
  3616. (option (const verbatim)))))
  3617. (defvar org-protecting-blocks
  3618. '("src" "example" "latex" "ascii" "html" "ditaa" "dot" "r" "R")
  3619. "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
  3620. This is needed for font-lock setup.")
  3621. ;;; Miscellaneous options
  3622. (defgroup org-completion nil
  3623. "Completion in Org-mode."
  3624. :tag "Org Completion"
  3625. :group 'org)
  3626. (defcustom org-completion-use-ido nil
  3627. "Non-nil means use ido completion wherever possible.
  3628. Note that `ido-mode' must be active for this variable to be relevant.
  3629. If you decide to turn this variable on, you might well want to turn off
  3630. `org-outline-path-complete-in-steps'.
  3631. See also `org-completion-use-iswitchb'."
  3632. :group 'org-completion
  3633. :type 'boolean)
  3634. (defcustom org-completion-use-iswitchb nil
  3635. "Non-nil means use iswitchb completion wherever possible.
  3636. Note that `iswitchb-mode' must be active for this variable to be relevant.
  3637. If you decide to turn this variable on, you might well want to turn off
  3638. `org-outline-path-complete-in-steps'.
  3639. Note that this variable has only an effect if `org-completion-use-ido' is nil."
  3640. :group 'org-completion
  3641. :type 'boolean)
  3642. (defcustom org-completion-fallback-command 'hippie-expand
  3643. "The expansion command called by \\[pcomplete] in normal context.
  3644. Normal means, no org-mode-specific context."
  3645. :group 'org-completion
  3646. :type 'function)
  3647. ;;; Functions and variables from their packages
  3648. ;; Declared here to avoid compiler warnings
  3649. ;; XEmacs only
  3650. (defvar outline-mode-menu-heading)
  3651. (defvar outline-mode-menu-show)
  3652. (defvar outline-mode-menu-hide)
  3653. (defvar zmacs-regions) ; XEmacs regions
  3654. ;; Emacs only
  3655. (defvar mark-active)
  3656. ;; Various packages
  3657. (declare-function calendar-absolute-from-iso "cal-iso" (date))
  3658. (declare-function calendar-forward-day "cal-move" (arg))
  3659. (declare-function calendar-goto-date "cal-move" (date))
  3660. (declare-function calendar-goto-today "cal-move" ())
  3661. (declare-function calendar-iso-from-absolute "cal-iso" (date))
  3662. (defvar calc-embedded-close-formula)
  3663. (defvar calc-embedded-open-formula)
  3664. (declare-function cdlatex-tab "ext:cdlatex" ())
  3665. (declare-function cdlatex-compute-tables "ext:cdlatex" ())
  3666. (declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
  3667. (defvar font-lock-unfontify-region-function)
  3668. (declare-function iswitchb-read-buffer "iswitchb"
  3669. (prompt &optional default require-match start matches-set))
  3670. (defvar iswitchb-temp-buflist)
  3671. (declare-function org-gnus-follow-link "org-gnus" (&optional group article))
  3672. (defvar org-agenda-tags-todo-honor-ignore-options)
  3673. (declare-function org-agenda-skip "org-agenda" ())
  3674. (declare-function
  3675. org-agenda-format-item "org-agenda"
  3676. (extra txt &optional level category tags dotime noprefix remove-re habitp))
  3677. (declare-function org-agenda-new-marker "org-agenda" (&optional pos))
  3678. (declare-function org-agenda-change-all-lines "org-agenda"
  3679. (newhead hdmarker &optional fixface just-this))
  3680. (declare-function org-agenda-set-restriction-lock "org-agenda" (&optional type))
  3681. (declare-function org-agenda-maybe-redo "org-agenda" ())
  3682. (declare-function org-agenda-save-markers-for-cut-and-paste "org-agenda"
  3683. (beg end))
  3684. (declare-function org-agenda-copy-local-variable "org-agenda" (var))
  3685. (declare-function org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
  3686. "org-agenda" (&optional end))
  3687. (declare-function org-inlinetask-remove-END-maybe "org-inlinetask" ())
  3688. (declare-function org-inlinetask-in-task-p "org-inlinetask" ())
  3689. (declare-function org-inlinetask-goto-beginning "org-inlinetask" ())
  3690. (declare-function org-inlinetask-goto-end "org-inlinetask" ())
  3691. (declare-function org-indent-mode "org-indent" (&optional arg))
  3692. (declare-function parse-time-string "parse-time" (string))
  3693. (declare-function org-attach-reveal "org-attach" (&optional if-exists))
  3694. (declare-function orgtbl-send-table "org-table" (&optional maybe))
  3695. (defvar remember-data-file)
  3696. (defvar texmathp-why)
  3697. (declare-function speedbar-line-directory "speedbar" (&optional depth))
  3698. (declare-function table--at-cell-p "table" (position &optional object at-column))
  3699. (defvar org-latex-regexps)
  3700. ;;; Autoload and prepare some org modules
  3701. ;; Some table stuff that needs to be defined here, because it is used
  3702. ;; by the functions setting up org-mode or checking for table context.
  3703. (defconst org-table-any-line-regexp "^[ \t]*\\(|\\|\\+-[-+]\\)"
  3704. "Detect an org-type or table-type table.")
  3705. (defconst org-table-line-regexp "^[ \t]*|"
  3706. "Detect an org-type table line.")
  3707. (defconst org-table-dataline-regexp "^[ \t]*|[^-]"
  3708. "Detect an org-type table line.")
  3709. (defconst org-table-hline-regexp "^[ \t]*|-"
  3710. "Detect an org-type table hline.")
  3711. (defconst org-table1-hline-regexp "^[ \t]*\\+-[-+]"
  3712. "Detect a table-type table hline.")
  3713. (defconst org-table-any-border-regexp "^[ \t]*[^|+ \t]"
  3714. "Detect the first line outside a table when searching from within it.
  3715. This works for both table types.")
  3716. ;; Autoload the functions in org-table.el that are needed by functions here.
  3717. (eval-and-compile
  3718. (org-autoload "org-table"
  3719. '(org-table-begin org-table-blank-field org-table-end)))
  3720. (defconst org-TBLFM-regexp "^[ \t]*#\\+TBLFM: "
  3721. "Detect a #+TBLFM line.")
  3722. ;;;###autoload
  3723. (defun turn-on-orgtbl ()
  3724. "Unconditionally turn on `orgtbl-mode'."
  3725. (require 'org-table)
  3726. (orgtbl-mode 1))
  3727. (defun org-at-table-p (&optional table-type)
  3728. "Return t if the cursor is inside an org-type table.
  3729. If TABLE-TYPE is non-nil, also check for table.el-type tables."
  3730. (if org-enable-table-editor
  3731. (save-excursion
  3732. (beginning-of-line 1)
  3733. (looking-at (if table-type org-table-any-line-regexp
  3734. org-table-line-regexp)))
  3735. nil))
  3736. (defsubst org-table-p () (org-at-table-p))
  3737. (defun org-at-table.el-p ()
  3738. "Return t if and only if we are at a table.el table."
  3739. (and (org-at-table-p 'any)
  3740. (save-excursion
  3741. (goto-char (org-table-begin 'any))
  3742. (looking-at org-table1-hline-regexp))))
  3743. (defun org-table-recognize-table.el ()
  3744. "If there is a table.el table nearby, recognize it and move into it."
  3745. (if org-table-tab-recognizes-table.el
  3746. (if (org-at-table.el-p)
  3747. (progn
  3748. (beginning-of-line 1)
  3749. (if (looking-at org-table-dataline-regexp)
  3750. nil
  3751. (if (looking-at org-table1-hline-regexp)
  3752. (progn
  3753. (beginning-of-line 2)
  3754. (if (looking-at org-table-any-border-regexp)
  3755. (beginning-of-line -1)))))
  3756. (if (re-search-forward "|" (org-table-end t) t)
  3757. (progn
  3758. (require 'table)
  3759. (if (table--at-cell-p (point))
  3760. t
  3761. (message "recognizing table.el table...")
  3762. (table-recognize-table)
  3763. (message "recognizing table.el table...done")))
  3764. (error "This should not happen"))
  3765. t)
  3766. nil)
  3767. nil))
  3768. (defun org-at-table-hline-p ()
  3769. "Return t if the cursor is inside a hline in a table."
  3770. (if org-enable-table-editor
  3771. (save-excursion
  3772. (beginning-of-line 1)
  3773. (looking-at org-table-hline-regexp))
  3774. nil))
  3775. (defun org-table-map-tables (function &optional quietly)
  3776. "Apply FUNCTION to the start of all tables in the buffer."
  3777. (save-excursion
  3778. (save-restriction
  3779. (widen)
  3780. (goto-char (point-min))
  3781. (while (re-search-forward org-table-any-line-regexp nil t)
  3782. (unless quietly
  3783. (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size))))
  3784. (beginning-of-line 1)
  3785. (when (and (looking-at org-table-line-regexp)
  3786. ;; Exclude tables in src/example/verbatim/clocktable blocks
  3787. (not (org-in-block-p '("src" "example" "verbatim" "clocktable"))))
  3788. (save-excursion (funcall function))
  3789. (or (looking-at org-table-line-regexp)
  3790. (forward-char 1)))
  3791. (re-search-forward org-table-any-border-regexp nil 1))))
  3792. (unless quietly (message "Mapping tables: done")))
  3793. ;; Declare and autoload functions from org-agenda.el
  3794. (eval-and-compile
  3795. (org-autoload "org-agenda"
  3796. '(org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
  3797. (declare-function org-clock-save-markers-for-cut-and-paste "org-clock" (beg end))
  3798. (declare-function org-clock-update-mode-line "org-clock" ())
  3799. (declare-function org-resolve-clocks "org-clock"
  3800. (&optional also-non-dangling-p prompt last-valid))
  3801. (defun org-at-TBLFM-p (&optional pos)
  3802. "Return t when point (or POS) is in #+TBLFM line."
  3803. (save-excursion
  3804. (let ((pos pos)))
  3805. (goto-char (or pos (point)))
  3806. (beginning-of-line 1)
  3807. (looking-at org-TBLFM-regexp)))
  3808. (defvar org-clock-start-time)
  3809. (defvar org-clock-marker (make-marker)
  3810. "Marker recording the last clock-in.")
  3811. (defvar org-clock-hd-marker (make-marker)
  3812. "Marker recording the last clock-in, but the headline position.")
  3813. (defvar org-clock-heading ""
  3814. "The heading of the current clock entry.")
  3815. (defun org-clock-is-active ()
  3816. "Return the buffer where the clock is currently running.
  3817. Return nil if no clock is running."
  3818. (marker-buffer org-clock-marker))
  3819. (eval-and-compile
  3820. (org-autoload "org-clock" '(org-clock-remove-overlays
  3821. org-clock-update-time-maybe
  3822. org-clocktable-shift)))
  3823. (defun org-check-running-clock ()
  3824. "Check if the current buffer contains the running clock.
  3825. If yes, offer to stop it and to save the buffer with the changes."
  3826. (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
  3827. (y-or-n-p (format "Clock-out in buffer %s before killing it? "
  3828. (buffer-name))))
  3829. (org-clock-out)
  3830. (when (y-or-n-p "Save changed buffer?")
  3831. (save-buffer))))
  3832. (defun org-clocktable-try-shift (dir n)
  3833. "Check if this line starts a clock table, if yes, shift the time block."
  3834. (when (org-match-line "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>")
  3835. (org-clocktable-shift dir n)))
  3836. ;;;###autoload
  3837. (defun org-clock-persistence-insinuate ()
  3838. "Set up hooks for clock persistence."
  3839. (require 'org-clock)
  3840. (add-hook 'org-mode-hook 'org-clock-load)
  3841. (add-hook 'kill-emacs-hook 'org-clock-save))
  3842. ;; Define the variable already here, to make sure we have it.
  3843. (defvar org-indent-mode nil
  3844. "Non-nil if Org-Indent mode is enabled.
  3845. Use the command `org-indent-mode' to change this variable.")
  3846. ;; Autoload archiving code
  3847. ;; The stuff that is needed for cycling and tags has to be defined here.
  3848. (defgroup org-archive nil
  3849. "Options concerning archiving in Org-mode."
  3850. :tag "Org Archive"
  3851. :group 'org-structure)
  3852. (defcustom org-archive-location "%s_archive::"
  3853. "The location where subtrees should be archived.
  3854. The value of this variable is a string, consisting of two parts,
  3855. separated by a double-colon. The first part is a filename and
  3856. the second part is a headline.
  3857. When the filename is omitted, archiving happens in the same file.
  3858. %s in the filename will be replaced by the current file
  3859. name (without the directory part). Archiving to a different file
  3860. is useful to keep archived entries from contributing to the
  3861. Org-mode Agenda.
  3862. The archived entries will be filed as subtrees of the specified
  3863. headline. When the headline is omitted, the subtrees are simply
  3864. filed away at the end of the file, as top-level entries. Also in
  3865. the heading you can use %s to represent the file name, this can be
  3866. useful when using the same archive for a number of different files.
  3867. Here are a few examples:
  3868. \"%s_archive::\"
  3869. If the current file is Projects.org, archive in file
  3870. Projects.org_archive, as top-level trees. This is the default.
  3871. \"::* Archived Tasks\"
  3872. Archive in the current file, under the top-level headline
  3873. \"* Archived Tasks\".
  3874. \"~/org/archive.org::\"
  3875. Archive in file ~/org/archive.org (absolute path), as top-level trees.
  3876. \"~/org/archive.org::* From %s\"
  3877. Archive in file ~/org/archive.org (absolute path), under headlines
  3878. \"From FILENAME\" where file name is the current file name.
  3879. \"~/org/datetree.org::datetree/* Finished Tasks\"
  3880. The \"datetree/\" string is special, signifying to archive
  3881. items to the datetree. Items are placed in either the CLOSED
  3882. date of the item, or the current date if there is no CLOSED date.
  3883. The heading will be a subentry to the current date. There doesn't
  3884. need to be a heading, but there always needs to be a slash after
  3885. datetree. For example, to store archived items directly in the
  3886. datetree, use \"~/org/datetree.org::datetree/\".
  3887. \"basement::** Finished Tasks\"
  3888. Archive in file ./basement (relative path), as level 3 trees
  3889. below the level 2 heading \"** Finished Tasks\".
  3890. You may set this option on a per-file basis by adding to the buffer a
  3891. line like
  3892. #+ARCHIVE: basement::** Finished Tasks
  3893. You may also define it locally for a subtree by setting an ARCHIVE property
  3894. in the entry. If such a property is found in an entry, or anywhere up
  3895. the hierarchy, it will be used."
  3896. :group 'org-archive
  3897. :type 'string)
  3898. (defcustom org-archive-tag "ARCHIVE"
  3899. "The tag that marks a subtree as archived.
  3900. An archived subtree does not open during visibility cycling, and does
  3901. not contribute to the agenda listings.
  3902. After changing this, font-lock must be restarted in the relevant buffers to
  3903. get the proper fontification."
  3904. :group 'org-archive
  3905. :group 'org-keywords
  3906. :type 'string)
  3907. (defcustom org-agenda-skip-archived-trees t
  3908. "Non-nil means the agenda will skip any items located in archived trees.
  3909. An archived tree is a tree marked with the tag ARCHIVE. The use of this
  3910. variable is no longer recommended, you should leave it at the value t.
  3911. Instead, use the key `v' to cycle the archives-mode in the agenda."
  3912. :group 'org-archive
  3913. :group 'org-agenda-skip
  3914. :type 'boolean)
  3915. (defcustom org-columns-skip-archived-trees t
  3916. "Non-nil means ignore archived trees when creating column view."
  3917. :group 'org-archive
  3918. :group 'org-properties
  3919. :type 'boolean)
  3920. (defcustom org-cycle-open-archived-trees nil
  3921. "Non-nil means `org-cycle' will open archived trees.
  3922. An archived tree is a tree marked with the tag ARCHIVE.
  3923. When nil, archived trees will stay folded. You can still open them with
  3924. normal outline commands like `show-all', but not with the cycling commands."
  3925. :group 'org-archive
  3926. :group 'org-cycle
  3927. :type 'boolean)
  3928. (defcustom org-sparse-tree-open-archived-trees nil
  3929. "Non-nil means sparse tree construction shows matches in archived trees.
  3930. When nil, matches in these trees are highlighted, but the trees are kept in
  3931. collapsed state."
  3932. :group 'org-archive
  3933. :group 'org-sparse-trees
  3934. :type 'boolean)
  3935. (defcustom org-sparse-tree-default-date-type 'scheduled-or-deadline
  3936. "The default date type when building a sparse tree.
  3937. When this is nil, a date is a scheduled or a deadline timestamp.
  3938. Otherwise, these types are allowed:
  3939. all: all timestamps
  3940. active: only active timestamps (<...>)
  3941. inactive: only inactive timestamps (<...)
  3942. scheduled: only scheduled timestamps
  3943. deadline: only deadline timestamps"
  3944. :type '(choice (const :tag "Scheduled or deadline" scheduled-or-deadline)
  3945. (const :tag "All timestamps" all)
  3946. (const :tag "Only active timestamps" active)
  3947. (const :tag "Only inactive timestamps" inactive)
  3948. (const :tag "Only scheduled timestamps" scheduled)
  3949. (const :tag "Only deadline timestamps" deadline)
  3950. (const :tag "Only closed timestamps" closed))
  3951. :version "24.3"
  3952. :group 'org-sparse-trees)
  3953. (defun org-cycle-hide-archived-subtrees (state)
  3954. "Re-hide all archived subtrees after a visibility state change."
  3955. (when (and (not org-cycle-open-archived-trees)
  3956. (not (memq state '(overview folded))))
  3957. (save-excursion
  3958. (let* ((globalp (memq state '(contents all)))
  3959. (beg (if globalp (point-min) (point)))
  3960. (end (if globalp (point-max) (org-end-of-subtree t))))
  3961. (org-hide-archived-subtrees beg end)
  3962. (goto-char beg)
  3963. (if (looking-at (concat ".*:" org-archive-tag ":"))
  3964. (message "%s" (substitute-command-keys
  3965. "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
  3966. (defun org-force-cycle-archived ()
  3967. "Cycle subtree even if it is archived."
  3968. (interactive)
  3969. (setq this-command 'org-cycle)
  3970. (let ((org-cycle-open-archived-trees t))
  3971. (call-interactively 'org-cycle)))
  3972. (defun org-hide-archived-subtrees (beg end)
  3973. "Re-hide all archived subtrees after a visibility state change."
  3974. (save-excursion
  3975. (let* ((re (concat ":" org-archive-tag ":")))
  3976. (goto-char beg)
  3977. (while (re-search-forward re end t)
  3978. (when (org-at-heading-p)
  3979. (org-flag-subtree t)
  3980. (org-end-of-subtree t))))))
  3981. (declare-function outline-end-of-heading "outline" ())
  3982. (declare-function outline-flag-region "outline" (from to flag))
  3983. (defun org-flag-subtree (flag)
  3984. (save-excursion
  3985. (org-back-to-heading t)
  3986. (outline-end-of-heading)
  3987. (outline-flag-region (point)
  3988. (progn (org-end-of-subtree t) (point))
  3989. flag)))
  3990. (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
  3991. (eval-and-compile
  3992. (org-autoload "org-archive"
  3993. '(org-add-archive-files)))
  3994. ;; Autoload Column View Code
  3995. (declare-function org-columns-number-to-string "org-colview" (n fmt &optional printf))
  3996. (declare-function org-columns-get-format-and-top-level "org-colview" ())
  3997. (declare-function org-columns-compute "org-colview" (property))
  3998. (org-autoload (if (featurep 'xemacs) "org-colview-xemacs" "org-colview")
  3999. '(org-columns-number-to-string
  4000. org-columns-get-format-and-top-level
  4001. org-columns-compute
  4002. org-columns-remove-overlays))
  4003. ;; Autoload ID code
  4004. (declare-function org-id-store-link "org-id")
  4005. (declare-function org-id-locations-load "org-id")
  4006. (declare-function org-id-locations-save "org-id")
  4007. (defvar org-id-track-globally)
  4008. (org-autoload "org-id"
  4009. '(org-id-new
  4010. org-id-copy
  4011. org-id-get-with-outline-path-completion
  4012. org-id-get-with-outline-drilling))
  4013. ;;; Variables for pre-computed regular expressions, all buffer local
  4014. (defvar org-drawer-regexp "^[ \t]*:PROPERTIES:[ \t]*$"
  4015. "Matches first line of a hidden block.")
  4016. (make-variable-buffer-local 'org-drawer-regexp)
  4017. (defvar org-todo-regexp nil
  4018. "Matches any of the TODO state keywords.")
  4019. (make-variable-buffer-local 'org-todo-regexp)
  4020. (defvar org-not-done-regexp nil
  4021. "Matches any of the TODO state keywords except the last one.")
  4022. (make-variable-buffer-local 'org-not-done-regexp)
  4023. (defvar org-not-done-heading-regexp nil
  4024. "Matches a TODO headline that is not done.")
  4025. (make-variable-buffer-local 'org-not-done-regexp)
  4026. (defvar org-todo-line-regexp nil
  4027. "Matches a headline and puts TODO state into group 2 if present.")
  4028. (make-variable-buffer-local 'org-todo-line-regexp)
  4029. (defvar org-complex-heading-regexp nil
  4030. "Matches a headline and puts everything into groups:
  4031. group 1: the stars
  4032. group 2: The todo keyword, maybe
  4033. group 3: Priority cookie
  4034. group 4: True headline
  4035. group 5: Tags")
  4036. (make-variable-buffer-local 'org-complex-heading-regexp)
  4037. (defvar org-complex-heading-regexp-format nil
  4038. "Printf format to make regexp to match an exact headline.
  4039. This regexp will match the headline of any node which has the
  4040. exact headline text that is put into the format, but may have any
  4041. TODO state, priority and tags.")
  4042. (make-variable-buffer-local 'org-complex-heading-regexp-format)
  4043. (defvar org-todo-line-tags-regexp nil
  4044. "Matches a headline and puts TODO state into group 2 if present.
  4045. Also put tags into group 4 if tags are present.")
  4046. (make-variable-buffer-local 'org-todo-line-tags-regexp)
  4047. (defvar org-ds-keyword-length 12
  4048. "Maximum length of the DEADLINE and SCHEDULED keywords.")
  4049. (make-variable-buffer-local 'org-ds-keyword-length)
  4050. (defvar org-deadline-regexp nil
  4051. "Matches the DEADLINE keyword.")
  4052. (make-variable-buffer-local 'org-deadline-regexp)
  4053. (defvar org-deadline-time-regexp nil
  4054. "Matches the DEADLINE keyword together with a time stamp.")
  4055. (make-variable-buffer-local 'org-deadline-time-regexp)
  4056. (defvar org-deadline-time-hour-regexp nil
  4057. "Matches the DEADLINE keyword together with a time-and-hour stamp.")
  4058. (make-variable-buffer-local 'org-deadline-time-hour-regexp)
  4059. (defvar org-deadline-line-regexp nil
  4060. "Matches the DEADLINE keyword and the rest of the line.")
  4061. (make-variable-buffer-local 'org-deadline-line-regexp)
  4062. (defvar org-scheduled-regexp nil
  4063. "Matches the SCHEDULED keyword.")
  4064. (make-variable-buffer-local 'org-scheduled-regexp)
  4065. (defvar org-scheduled-time-regexp nil
  4066. "Matches the SCHEDULED keyword together with a time stamp.")
  4067. (make-variable-buffer-local 'org-scheduled-time-regexp)
  4068. (defvar org-scheduled-time-hour-regexp nil
  4069. "Matches the SCHEDULED keyword together with a time-and-hour stamp.")
  4070. (make-variable-buffer-local 'org-scheduled-time-hour-regexp)
  4071. (defvar org-closed-time-regexp nil
  4072. "Matches the CLOSED keyword together with a time stamp.")
  4073. (make-variable-buffer-local 'org-closed-time-regexp)
  4074. (defvar org-keyword-time-regexp nil
  4075. "Matches any of the 4 keywords, together with the time stamp.")
  4076. (make-variable-buffer-local 'org-keyword-time-regexp)
  4077. (defvar org-keyword-time-not-clock-regexp nil
  4078. "Matches any of the 3 keywords, together with the time stamp.")
  4079. (make-variable-buffer-local 'org-keyword-time-not-clock-regexp)
  4080. (defvar org-maybe-keyword-time-regexp nil
  4081. "Matches a timestamp, possibly preceded by a keyword.")
  4082. (make-variable-buffer-local 'org-maybe-keyword-time-regexp)
  4083. (defvar org-all-time-keywords nil
  4084. "List of time keywords.")
  4085. (make-variable-buffer-local 'org-all-time-keywords)
  4086. (defconst org-plain-time-of-day-regexp
  4087. (concat
  4088. "\\(\\<[012]?[0-9]"
  4089. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  4090. "\\(--?"
  4091. "\\(\\<[012]?[0-9]"
  4092. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  4093. "\\)?")
  4094. "Regular expression to match a plain time or time range.
  4095. Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
  4096. groups carry important information:
  4097. 0 the full match
  4098. 1 the first time, range or not
  4099. 8 the second time, if it is a range.")
  4100. (defconst org-plain-time-extension-regexp
  4101. (concat
  4102. "\\(\\<[012]?[0-9]"
  4103. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  4104. "\\+\\([0-9]+\\)\\(:\\([0-5][0-9]\\)\\)?")
  4105. "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
  4106. Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
  4107. groups carry important information:
  4108. 0 the full match
  4109. 7 hours of duration
  4110. 9 minutes of duration")
  4111. (defconst org-stamp-time-of-day-regexp
  4112. (concat
  4113. "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} +\\sw+ +\\)"
  4114. "\\([012][0-9]:[0-5][0-9]\\(-\\([012][0-9]:[0-5][0-9]\\)\\)?[^\n\r>]*?\\)>"
  4115. "\\(--?"
  4116. "<\\1\\([012][0-9]:[0-5][0-9]\\)>\\)?")
  4117. "Regular expression to match a timestamp time or time range.
  4118. After a match, the following groups carry important information:
  4119. 0 the full match
  4120. 1 date plus weekday, for back referencing to make sure both times are on the same day
  4121. 2 the first time, range or not
  4122. 4 the second time, if it is a range.")
  4123. (defconst org-startup-options
  4124. '(("fold" org-startup-folded t)
  4125. ("overview" org-startup-folded t)
  4126. ("nofold" org-startup-folded nil)
  4127. ("showall" org-startup-folded nil)
  4128. ("showeverything" org-startup-folded showeverything)
  4129. ("content" org-startup-folded content)
  4130. ("indent" org-startup-indented t)
  4131. ("noindent" org-startup-indented nil)
  4132. ("hidestars" org-hide-leading-stars t)
  4133. ("showstars" org-hide-leading-stars nil)
  4134. ("odd" org-odd-levels-only t)
  4135. ("oddeven" org-odd-levels-only nil)
  4136. ("align" org-startup-align-all-tables t)
  4137. ("noalign" org-startup-align-all-tables nil)
  4138. ("inlineimages" org-startup-with-inline-images t)
  4139. ("noinlineimages" org-startup-with-inline-images nil)
  4140. ("latexpreview" org-startup-with-latex-preview t)
  4141. ("nolatexpreview" org-startup-with-latex-preview nil)
  4142. ("customtime" org-display-custom-times t)
  4143. ("logdone" org-log-done time)
  4144. ("lognotedone" org-log-done note)
  4145. ("nologdone" org-log-done nil)
  4146. ("lognoteclock-out" org-log-note-clock-out t)
  4147. ("nolognoteclock-out" org-log-note-clock-out nil)
  4148. ("logrepeat" org-log-repeat state)
  4149. ("lognoterepeat" org-log-repeat note)
  4150. ("logdrawer" org-log-into-drawer t)
  4151. ("nologdrawer" org-log-into-drawer nil)
  4152. ("logstatesreversed" org-log-states-order-reversed t)
  4153. ("nologstatesreversed" org-log-states-order-reversed nil)
  4154. ("nologrepeat" org-log-repeat nil)
  4155. ("logreschedule" org-log-reschedule time)
  4156. ("lognotereschedule" org-log-reschedule note)
  4157. ("nologreschedule" org-log-reschedule nil)
  4158. ("logredeadline" org-log-redeadline time)
  4159. ("lognoteredeadline" org-log-redeadline note)
  4160. ("nologredeadline" org-log-redeadline nil)
  4161. ("logrefile" org-log-refile time)
  4162. ("lognoterefile" org-log-refile note)
  4163. ("nologrefile" org-log-refile nil)
  4164. ("fninline" org-footnote-define-inline t)
  4165. ("nofninline" org-footnote-define-inline nil)
  4166. ("fnlocal" org-footnote-section nil)
  4167. ("fnauto" org-footnote-auto-label t)
  4168. ("fnprompt" org-footnote-auto-label nil)
  4169. ("fnconfirm" org-footnote-auto-label confirm)
  4170. ("fnplain" org-footnote-auto-label plain)
  4171. ("fnadjust" org-footnote-auto-adjust t)
  4172. ("nofnadjust" org-footnote-auto-adjust nil)
  4173. ("constcgs" constants-unit-system cgs)
  4174. ("constSI" constants-unit-system SI)
  4175. ("noptag" org-tag-persistent-alist nil)
  4176. ("hideblocks" org-hide-block-startup t)
  4177. ("nohideblocks" org-hide-block-startup nil)
  4178. ("beamer" org-startup-with-beamer-mode t)
  4179. ("entitiespretty" org-pretty-entities t)
  4180. ("entitiesplain" org-pretty-entities nil))
  4181. "Variable associated with STARTUP options for org-mode.
  4182. Each element is a list of three items: the startup options (as written
  4183. in the #+STARTUP line), the corresponding variable, and the value to set
  4184. this variable to if the option is found. An optional forth element PUSH
  4185. means to push this value onto the list in the variable.")
  4186. (defun org-update-property-plist (key val props)
  4187. "Update PROPS with KEY and VAL."
  4188. (let* ((appending (string= "+" (substring key (- (length key) 1))))
  4189. (key (if appending (substring key 0 (- (length key) 1)) key))
  4190. (remainder (org-remove-if (lambda (p) (string= (car p) key)) props))
  4191. (previous (cdr (assoc key props))))
  4192. (if appending
  4193. (cons (cons key (if previous (concat previous " " val) val)) remainder)
  4194. (cons (cons key val) remainder))))
  4195. (defconst org-block-regexp
  4196. "^[ \t]*#\\+begin_?\\([^ \n]+\\)\\(\\([^\n]+\\)\\)?\n\\([^\000]+?\\)#\\+end_?\\1[ \t]*$"
  4197. "Regular expression for hiding blocks.")
  4198. (defconst org-heading-keyword-regexp-format
  4199. "^\\(\\*+\\)\\(?: +%s\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
  4200. "Printf format for a regexp matching a headline with some keyword.
  4201. This regexp will match the headline of any node which has the
  4202. exact keyword that is put into the format. The keyword isn't in
  4203. any group by default, but the stars and the body are.")
  4204. (defconst org-heading-keyword-maybe-regexp-format
  4205. "^\\(\\*+\\)\\(?: +%s\\)?\\(?: +\\(.*?\\)\\)?[ \t]*$"
  4206. "Printf format for a regexp matching a headline, possibly with some keyword.
  4207. This regexp can match any headline with the specified keyword, or
  4208. without a keyword. The keyword isn't in any group by default,
  4209. but the stars and the body are.")
  4210. (defcustom org-group-tags t
  4211. "When non-nil (the default), use group tags.
  4212. This can be turned on/off through `org-toggle-tags-groups'."
  4213. :group 'org-tags
  4214. :group 'org-startup
  4215. :type 'boolean)
  4216. (defun org-toggle-tags-groups ()
  4217. "Toggle support for group tags.
  4218. Support for group tags is controlled by the option
  4219. `org-group-tags', which is non-nil by default."
  4220. (interactive)
  4221. (setq org-group-tags (not org-group-tags))
  4222. (cond ((and (derived-mode-p 'org-agenda-mode)
  4223. org-group-tags)
  4224. (org-agenda-redo))
  4225. ((derived-mode-p 'org-mode)
  4226. (let ((org-inhibit-startup t)) (org-mode))))
  4227. (message "Groups tags support has been turned %s"
  4228. (if org-group-tags "on" "off")))
  4229. (defun org-set-regexps-and-options-for-tags ()
  4230. "Precompute variables used for tags."
  4231. (when (derived-mode-p 'org-mode)
  4232. (org-set-local 'org-file-tags nil)
  4233. (let ((re (org-make-options-regexp '("FILETAGS" "TAGS")))
  4234. (splitre "[ \t]+")
  4235. (start 0)
  4236. tags ftags key value)
  4237. (save-excursion
  4238. (save-restriction
  4239. (widen)
  4240. (goto-char (point-min))
  4241. (while (re-search-forward re nil t)
  4242. (setq key (upcase (org-match-string-no-properties 1))
  4243. value (org-match-string-no-properties 2))
  4244. (if (stringp value) (setq value (org-trim value)))
  4245. (cond
  4246. ((equal key "TAGS")
  4247. (setq tags (append tags (if tags '("\\n") nil)
  4248. (org-split-string value splitre))))
  4249. ((equal key "FILETAGS")
  4250. (when (string-match "\\S-" value)
  4251. (setq ftags
  4252. (append
  4253. ftags
  4254. (apply 'append
  4255. (mapcar (lambda (x) (org-split-string x ":"))
  4256. (org-split-string value)))))))))))
  4257. ;; Process the file tags.
  4258. (and ftags (org-set-local 'org-file-tags
  4259. (mapcar 'org-add-prop-inherited ftags)))
  4260. (org-set-local 'org-tag-groups-alist nil)
  4261. ;; Process the tags.
  4262. (when (and (not tags) org-tag-alist)
  4263. (setq tags
  4264. (mapcar
  4265. (lambda (tg) (cond ((eq (car tg) :startgroup) "{")
  4266. ((eq (car tg) :endgroup) "}")
  4267. ((eq (car tg) :grouptags) ":")
  4268. ((eq (car tg) :newline) "\n")
  4269. (t (concat (car tg)
  4270. (if (characterp (cdr tg))
  4271. (format "(%s)" (char-to-string (cdr tg))) "")))))
  4272. org-tag-alist)))
  4273. (let (e tgs g)
  4274. (while (setq e (pop tags))
  4275. (cond
  4276. ((equal e "{")
  4277. (progn (push '(:startgroup) tgs)
  4278. (when (equal (nth 1 tags) ":")
  4279. (push (list (replace-regexp-in-string
  4280. "(.+)$" "" (nth 0 tags)))
  4281. org-tag-groups-alist)
  4282. (setq g 0))))
  4283. ((equal e ":") (push '(:grouptags) tgs))
  4284. ((equal e "}") (push '(:endgroup) tgs) (if g (setq g nil)))
  4285. ((equal e "\\n") (push '(:newline) tgs))
  4286. ((string-match (org-re "^\\([[:alnum:]_@#%]+\\)(\\(.\\))$") e)
  4287. (push (cons (match-string 1 e)
  4288. (string-to-char (match-string 2 e))) tgs)
  4289. (if (and g (> g 0))
  4290. (setcar org-tag-groups-alist
  4291. (append (car org-tag-groups-alist)
  4292. (list (match-string 1 e)))))
  4293. (if g (setq g (1+ g))))
  4294. (t (push (list e) tgs)
  4295. (if (and g (> g 0))
  4296. (setcar org-tag-groups-alist
  4297. (append (car org-tag-groups-alist) (list e))))
  4298. (if g (setq g (1+ g))))))
  4299. (org-set-local 'org-tag-alist nil)
  4300. (while (setq e (pop tgs))
  4301. (or (and (stringp (car e))
  4302. (assoc (car e) org-tag-alist))
  4303. (push e org-tag-alist)))
  4304. ;; Return a list with tag variables
  4305. (list org-file-tags org-tag-alist org-tag-groups-alist)))))
  4306. (defvar org-ota nil)
  4307. (defun org-set-regexps-and-options ()
  4308. "Precompute regular expressions used in the current buffer."
  4309. (when (derived-mode-p 'org-mode)
  4310. (org-set-local 'org-todo-kwd-alist nil)
  4311. (org-set-local 'org-todo-key-alist nil)
  4312. (org-set-local 'org-todo-key-trigger nil)
  4313. (org-set-local 'org-todo-keywords-1 nil)
  4314. (org-set-local 'org-done-keywords nil)
  4315. (org-set-local 'org-todo-heads nil)
  4316. (org-set-local 'org-todo-sets nil)
  4317. (org-set-local 'org-todo-log-states nil)
  4318. (org-set-local 'org-file-properties nil)
  4319. (let ((re (org-make-options-regexp
  4320. '("CATEGORY" "TODO" "COLUMNS" "STARTUP" "ARCHIVE"
  4321. "LINK" "PRIORITIES" "CONSTANTS" "PROPERTY" "DRAWERS"
  4322. "SETUPFILE" "OPTIONS")
  4323. "\\(?:[a-zA-Z][0-9a-zA-Z_]*_TODO\\)"))
  4324. (splitre "[ \t]+")
  4325. (scripts org-use-sub-superscripts)
  4326. kwds kws0 kwsa key log value cat arch const links hw dws
  4327. tail sep kws1 prio props drawers ext-setup-or-nil setup-contents
  4328. (start 0))
  4329. (save-excursion
  4330. (save-restriction
  4331. (widen)
  4332. (goto-char (point-min))
  4333. (while
  4334. (or (and
  4335. ext-setup-or-nil
  4336. (not org-ota)
  4337. (let (ret)
  4338. (with-temp-buffer
  4339. (insert ext-setup-or-nil)
  4340. (let ((major-mode 'org-mode) org-ota)
  4341. (setq ret (save-match-data
  4342. (org-set-regexps-and-options-for-tags)))))
  4343. ;; Append setupfile tags to existing tags
  4344. (setq org-ota t)
  4345. (setq org-file-tags
  4346. (delq nil (append org-file-tags (nth 0 ret)))
  4347. org-tag-alist
  4348. (delq nil (append org-tag-alist (nth 1 ret)))
  4349. org-tag-groups-alist
  4350. (delq nil (append org-tag-groups-alist (nth 2 ret))))))
  4351. (and ext-setup-or-nil
  4352. (string-match re ext-setup-or-nil start)
  4353. (setq start (match-end 0)))
  4354. (and (setq ext-setup-or-nil nil start 0)
  4355. (re-search-forward re nil t)))
  4356. (setq key (upcase (match-string 1 ext-setup-or-nil))
  4357. value (org-match-string-no-properties 2 ext-setup-or-nil))
  4358. (if (stringp value) (setq value (org-trim value)))
  4359. (cond
  4360. ((equal key "CATEGORY")
  4361. (setq cat value))
  4362. ((member key '("SEQ_TODO" "TODO"))
  4363. (push (cons 'sequence (org-split-string value splitre)) kwds))
  4364. ((equal key "TYP_TODO")
  4365. (push (cons 'type (org-split-string value splitre)) kwds))
  4366. ((string-match "\\`\\([a-zA-Z][0-9a-zA-Z_]*\\)_TODO\\'" key)
  4367. ;; general TODO-like setup
  4368. (push (cons (intern (downcase (match-string 1 key)))
  4369. (org-split-string value splitre)) kwds))
  4370. ((equal key "COLUMNS")
  4371. (org-set-local 'org-columns-default-format value))
  4372. ((equal key "LINK")
  4373. (when (string-match "^\\(\\S-+\\)[ \t]+\\(.+\\)" value)
  4374. (push (cons (match-string 1 value)
  4375. (org-trim (match-string 2 value)))
  4376. links)))
  4377. ((equal key "PRIORITIES")
  4378. (setq prio (org-split-string value " +")))
  4379. ((equal key "PROPERTY")
  4380. (when (string-match "\\(\\S-+\\)\\s-+\\(.*\\)" value)
  4381. (setq props (org-update-property-plist (match-string 1 value)
  4382. (match-string 2 value)
  4383. props))))
  4384. ((equal key "DRAWERS")
  4385. (setq drawers (delete-dups (append org-drawers (org-split-string value splitre)))))
  4386. ((equal key "CONSTANTS")
  4387. (org-table-set-constants))
  4388. ((equal key "STARTUP")
  4389. (let ((opts (org-split-string value splitre))
  4390. l var val)
  4391. (while (setq l (pop opts))
  4392. (when (setq l (assoc l org-startup-options))
  4393. (setq var (nth 1 l) val (nth 2 l))
  4394. (if (not (nth 3 l))
  4395. (set (make-local-variable var) val)
  4396. (if (not (listp (symbol-value var)))
  4397. (set (make-local-variable var) nil))
  4398. (set (make-local-variable var) (symbol-value var))
  4399. (add-to-list var val))))))
  4400. ((equal key "ARCHIVE")
  4401. (setq arch value)
  4402. (remove-text-properties 0 (length arch)
  4403. '(face t fontified t) arch))
  4404. ((equal key "OPTIONS")
  4405. (if (string-match "\\([ \t]\\|\\`\\)\\^:\\(t\\|nil\\|{}\\)" value)
  4406. (setq scripts (read (match-string 2 value)))))
  4407. ((and (equal key "SETUPFILE")
  4408. ;; Prevent checking in Gnus messages
  4409. (not buffer-read-only))
  4410. (setq setup-contents (org-file-contents
  4411. (expand-file-name
  4412. (org-remove-double-quotes value))
  4413. 'noerror))
  4414. (if (not ext-setup-or-nil)
  4415. (setq ext-setup-or-nil setup-contents start 0)
  4416. (setq ext-setup-or-nil
  4417. (concat (substring ext-setup-or-nil 0 start)
  4418. "\n" setup-contents "\n"
  4419. (substring ext-setup-or-nil start)))))))
  4420. ;; search for property blocks
  4421. (goto-char (point-min))
  4422. (while (re-search-forward org-block-regexp nil t)
  4423. (when (equal "PROPERTY" (upcase (match-string 1)))
  4424. (setq value (replace-regexp-in-string
  4425. "[\n\r]" " " (match-string 4)))
  4426. (when (string-match "\\(\\S-+\\)\\s-+\\(.*\\)" value)
  4427. (setq props (org-update-property-plist (match-string 1 value)
  4428. (match-string 2 value)
  4429. props)))))))
  4430. (org-set-local 'org-use-sub-superscripts scripts)
  4431. (when cat
  4432. (org-set-local 'org-category (intern cat))
  4433. (push (cons "CATEGORY" cat) props))
  4434. (when prio
  4435. (if (< (length prio) 3) (setq prio '("A" "C" "B")))
  4436. (setq prio (mapcar 'string-to-char prio))
  4437. (org-set-local 'org-highest-priority (nth 0 prio))
  4438. (org-set-local 'org-lowest-priority (nth 1 prio))
  4439. (org-set-local 'org-default-priority (nth 2 prio)))
  4440. (and props (org-set-local 'org-file-properties (nreverse props)))
  4441. (and drawers (org-set-local 'org-drawers drawers))
  4442. (and arch (org-set-local 'org-archive-location arch))
  4443. (and links (setq org-link-abbrev-alist-local (nreverse links)))
  4444. ;; Process the TODO keywords
  4445. (unless kwds
  4446. ;; Use the global values as if they had been given locally.
  4447. (setq kwds (default-value 'org-todo-keywords))
  4448. (if (stringp (car kwds))
  4449. (setq kwds (list (cons org-todo-interpretation
  4450. (default-value 'org-todo-keywords)))))
  4451. (setq kwds (reverse kwds)))
  4452. (setq kwds (nreverse kwds))
  4453. (let (inter kws kw)
  4454. (while (setq kws (pop kwds))
  4455. (let ((kws (or
  4456. (run-hook-with-args-until-success
  4457. 'org-todo-setup-filter-hook kws)
  4458. kws)))
  4459. (setq inter (pop kws) sep (member "|" kws)
  4460. kws0 (delete "|" (copy-sequence kws))
  4461. kwsa nil
  4462. kws1 (mapcar
  4463. (lambda (x)
  4464. ;; 1 2
  4465. (if (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?.*?)\\)?$" x)
  4466. (progn
  4467. (setq kw (match-string 1 x)
  4468. key (and (match-end 2) (match-string 2 x))
  4469. log (org-extract-log-state-settings x))
  4470. (push (cons kw (and key (string-to-char key))) kwsa)
  4471. (and log (push log org-todo-log-states))
  4472. kw)
  4473. (error "Invalid TODO keyword %s" x)))
  4474. kws0)
  4475. kwsa (if kwsa (append '((:startgroup))
  4476. (nreverse kwsa)
  4477. '((:endgroup))))
  4478. hw (car kws1)
  4479. dws (if sep (org-remove-keyword-keys (cdr sep)) (last kws1))
  4480. tail (list inter hw (car dws) (org-last dws))))
  4481. (add-to-list 'org-todo-heads hw 'append)
  4482. (push kws1 org-todo-sets)
  4483. (setq org-done-keywords (append org-done-keywords dws nil))
  4484. (setq org-todo-key-alist (append org-todo-key-alist kwsa))
  4485. (mapc (lambda (x) (push (cons x tail) org-todo-kwd-alist)) kws1)
  4486. (setq org-todo-keywords-1 (append org-todo-keywords-1 kws1 nil)))
  4487. (setq org-todo-sets (nreverse org-todo-sets)
  4488. org-todo-kwd-alist (nreverse org-todo-kwd-alist)
  4489. org-todo-key-trigger (delq nil (mapcar 'cdr org-todo-key-alist))
  4490. org-todo-key-alist (org-assign-fast-keys org-todo-key-alist)))
  4491. ;; Compute the regular expressions and other local variables.
  4492. ;; Using `org-outline-regexp-bol' would complicate them much,
  4493. ;; because of the fixed white space at the end of that string.
  4494. (if (not org-done-keywords)
  4495. (setq org-done-keywords (and org-todo-keywords-1
  4496. (list (org-last org-todo-keywords-1)))))
  4497. (setq org-ds-keyword-length (+ 2 (max (length org-deadline-string)
  4498. (length org-scheduled-string)
  4499. (length org-clock-string)
  4500. (length org-closed-string)))
  4501. org-drawer-regexp
  4502. (concat "^[ \t]*:\\("
  4503. (mapconcat 'regexp-quote org-drawers "\\|")
  4504. "\\):[ \t]*$")
  4505. org-not-done-keywords
  4506. (org-delete-all org-done-keywords (copy-sequence org-todo-keywords-1))
  4507. org-todo-regexp
  4508. (concat "\\("
  4509. (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
  4510. "\\)")
  4511. org-not-done-regexp
  4512. (concat "\\("
  4513. (mapconcat 'regexp-quote org-not-done-keywords "\\|")
  4514. "\\)")
  4515. org-not-done-heading-regexp
  4516. (format org-heading-keyword-regexp-format org-not-done-regexp)
  4517. org-todo-line-regexp
  4518. (format org-heading-keyword-maybe-regexp-format org-todo-regexp)
  4519. org-complex-heading-regexp
  4520. (concat "^\\(\\*+\\)"
  4521. "\\(?: +" org-todo-regexp "\\)?"
  4522. "\\(?: +\\(\\[#.\\]\\)\\)?"
  4523. "\\(?: +\\(.*?\\)\\)??"
  4524. (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)?")
  4525. "[ \t]*$")
  4526. org-complex-heading-regexp-format
  4527. (concat "^\\(\\*+\\)"
  4528. "\\(?: +" org-todo-regexp "\\)?"
  4529. "\\(?: +\\(\\[#.\\]\\)\\)?"
  4530. "\\(?: +"
  4531. ;; Stats cookies can be stuck to body.
  4532. "\\(?:\\[[0-9%%/]+\\] *\\)?"
  4533. "\\(%s\\)"
  4534. "\\(?: *\\[[0-9%%/]+\\]\\)?"
  4535. "\\)"
  4536. (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%%:]+:\\)\\)?")
  4537. "[ \t]*$")
  4538. org-todo-line-tags-regexp
  4539. (concat "^\\(\\*+\\)"
  4540. "\\(?: +" org-todo-regexp "\\)?"
  4541. "\\(?: +\\(.*?\\)\\)??"
  4542. (org-re "\\(?:[ \t]+\\(:[[:alnum:]:_@#%]+:\\)\\)?")
  4543. "[ \t]*$")
  4544. org-deadline-regexp (concat "\\<" org-deadline-string)
  4545. org-deadline-time-regexp
  4546. (concat "\\<" org-deadline-string " *<\\([^>]+\\)>")
  4547. org-deadline-time-hour-regexp
  4548. (concat "\\<" org-deadline-string
  4549. " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
  4550. org-deadline-line-regexp
  4551. (concat "\\<\\(" org-deadline-string "\\).*")
  4552. org-scheduled-regexp
  4553. (concat "\\<" org-scheduled-string)
  4554. org-scheduled-time-regexp
  4555. (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>")
  4556. org-scheduled-time-hour-regexp
  4557. (concat "\\<" org-scheduled-string
  4558. " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
  4559. org-closed-time-regexp
  4560. (concat "\\<" org-closed-string " *\\[\\([^]]+\\)\\]")
  4561. org-keyword-time-regexp
  4562. (concat "\\<\\(" org-scheduled-string
  4563. "\\|" org-deadline-string
  4564. "\\|" org-closed-string
  4565. "\\|" org-clock-string "\\)"
  4566. " *[[<]\\([^]>]+\\)[]>]")
  4567. org-keyword-time-not-clock-regexp
  4568. (concat "\\<\\(" org-scheduled-string
  4569. "\\|" org-deadline-string
  4570. "\\|" org-closed-string
  4571. "\\)"
  4572. " *[[<]\\([^]>]+\\)[]>]")
  4573. org-maybe-keyword-time-regexp
  4574. (concat "\\(\\<\\(" org-scheduled-string
  4575. "\\|" org-deadline-string
  4576. "\\|" org-closed-string
  4577. "\\|" org-clock-string "\\)\\)?"
  4578. " *\\([[<][0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?[]>]\\|<%%([^\r\n>]*>\\)")
  4579. org-all-time-keywords
  4580. (mapcar (lambda (w) (substring w 0 -1))
  4581. (list org-scheduled-string org-deadline-string
  4582. org-clock-string org-closed-string)))
  4583. (setq org-ota nil)
  4584. (org-compute-latex-and-related-regexp))))
  4585. (defun org-file-contents (file &optional noerror)
  4586. "Return the contents of FILE, as a string."
  4587. (if (or (not file)
  4588. (not (file-readable-p file)))
  4589. (if noerror
  4590. (message "Cannot read file \"%s\"" file)
  4591. (error "Cannot read file \"%s\"" file))
  4592. (with-temp-buffer
  4593. (insert-file-contents file)
  4594. (buffer-string))))
  4595. (defun org-extract-log-state-settings (x)
  4596. "Extract the log state setting from a TODO keyword string.
  4597. This will extract info from a string like \"WAIT(w@/!)\"."
  4598. (let (kw key log1 log2)
  4599. (when (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?\\([!@]\\)?\\(?:/\\([!@]\\)\\)?)\\)?$" x)
  4600. (setq kw (match-string 1 x)
  4601. key (and (match-end 2) (match-string 2 x))
  4602. log1 (and (match-end 3) (match-string 3 x))
  4603. log2 (and (match-end 4) (match-string 4 x)))
  4604. (and (or log1 log2)
  4605. (list kw
  4606. (and log1 (if (equal log1 "!") 'time 'note))
  4607. (and log2 (if (equal log2 "!") 'time 'note)))))))
  4608. (defun org-remove-keyword-keys (list)
  4609. "Remove a pair of parenthesis at the end of each string in LIST."
  4610. (mapcar (lambda (x)
  4611. (if (string-match "(.*)$" x)
  4612. (substring x 0 (match-beginning 0))
  4613. x))
  4614. list))
  4615. (defun org-assign-fast-keys (alist)
  4616. "Assign fast keys to a keyword-key alist.
  4617. Respect keys that are already there."
  4618. (let (new e (alt ?0))
  4619. (while (setq e (pop alist))
  4620. (if (or (memq (car e) '(:newline :grouptags :endgroup :startgroup))
  4621. (cdr e)) ;; Key already assigned.
  4622. (push e new)
  4623. (let ((clist (string-to-list (downcase (car e))))
  4624. (used (append new alist)))
  4625. (when (= (car clist) ?@)
  4626. (pop clist))
  4627. (while (and clist (rassoc (car clist) used))
  4628. (pop clist))
  4629. (unless clist
  4630. (while (rassoc alt used)
  4631. (incf alt)))
  4632. (push (cons (car e) (or (car clist) alt)) new))))
  4633. (nreverse new)))
  4634. ;;; Some variables used in various places
  4635. (defvar org-window-configuration nil
  4636. "Used in various places to store a window configuration.")
  4637. (defvar org-selected-window nil
  4638. "Used in various places to store a window configuration.")
  4639. (defvar org-finish-function nil
  4640. "Function to be called when `C-c C-c' is used.
  4641. This is for getting out of special buffers like capture.")
  4642. ;; FIXME: Occasionally check by commenting these, to make sure
  4643. ;; no other functions uses these, forgetting to let-bind them.
  4644. (org-no-warnings (defvar entry)) ;; unprefixed, from calendar.el
  4645. (defvar org-last-state)
  4646. (org-no-warnings (defvar date)) ;; unprefixed, from calendar.el
  4647. ;; Defined somewhere in this file, but used before definition.
  4648. (defvar org-entities) ;; defined in org-entities.el
  4649. (defvar org-struct-menu)
  4650. (defvar org-org-menu)
  4651. (defvar org-tbl-menu)
  4652. ;;;; Define the Org-mode
  4653. ;; We use a before-change function to check if a table might need
  4654. ;; an update.
  4655. (defvar org-table-may-need-update t
  4656. "Indicates that a table might need an update.
  4657. This variable is set by `org-before-change-function'.
  4658. `org-table-align' sets it back to nil.")
  4659. (defun org-before-change-function (beg end)
  4660. "Every change indicates that a table might need an update."
  4661. (setq org-table-may-need-update t))
  4662. (defvar org-mode-map)
  4663. (defvar org-inhibit-startup nil) ; Dynamically-scoped param.
  4664. (defvar org-inhibit-startup-visibility-stuff nil) ; Dynamically-scoped param.
  4665. (defvar org-agenda-keep-modes nil) ; Dynamically-scoped param.
  4666. (defvar org-inhibit-logging nil) ; Dynamically-scoped param.
  4667. (defvar org-inhibit-blocking nil) ; Dynamically-scoped param.
  4668. (defvar org-table-buffer-is-an nil)
  4669. (defvar bidi-paragraph-direction)
  4670. (defvar buffer-face-mode-face)
  4671. (require 'outline)
  4672. (if (and (not (keymapp outline-mode-map)) (featurep 'allout))
  4673. (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"))
  4674. (require 'noutline "noutline" 'noerror) ;; stock XEmacs does not have it
  4675. ;; Other stuff we need.
  4676. (require 'time-date)
  4677. (unless (fboundp 'time-subtract) (defalias 'time-subtract 'subtract-time))
  4678. (require 'easymenu)
  4679. (require 'overlay)
  4680. ;; (require 'org-macs) moved higher up in the file before it is first used
  4681. (require 'org-entities)
  4682. ;; (require 'org-compat) moved higher up in the file before it is first used
  4683. (require 'org-faces)
  4684. (require 'org-list)
  4685. (require 'org-pcomplete)
  4686. (require 'org-src)
  4687. (require 'org-footnote)
  4688. (require 'org-macro)
  4689. ;; babel
  4690. (require 'ob)
  4691. ;;;###autoload
  4692. (define-derived-mode org-mode outline-mode "Org"
  4693. "Outline-based notes management and organizer, alias
  4694. \"Carsten's outline-mode for keeping track of everything.\"
  4695. Org-mode develops organizational tasks around a NOTES file which
  4696. contains information about projects as plain text. Org-mode is
  4697. implemented on top of outline-mode, which is ideal to keep the content
  4698. of large files well structured. It supports ToDo items, deadlines and
  4699. time stamps, which magically appear in the diary listing of the Emacs
  4700. calendar. Tables are easily created with a built-in table editor.
  4701. Plain text URL-like links connect to websites, emails (VM), Usenet
  4702. messages (Gnus), BBDB entries, and any files related to the project.
  4703. For printing and sharing of notes, an Org-mode file (or a part of it)
  4704. can be exported as a structured ASCII or HTML file.
  4705. The following commands are available:
  4706. \\{org-mode-map}"
  4707. ;; Get rid of Outline menus, they are not needed
  4708. ;; Need to do this here because define-derived-mode sets up
  4709. ;; the keymap so late. Still, it is a waste to call this each time
  4710. ;; we switch another buffer into org-mode.
  4711. (if (featurep 'xemacs)
  4712. (when (boundp 'outline-mode-menu-heading)
  4713. ;; Assume this is Greg's port, it uses easymenu
  4714. (easy-menu-remove outline-mode-menu-heading)
  4715. (easy-menu-remove outline-mode-menu-show)
  4716. (easy-menu-remove outline-mode-menu-hide))
  4717. (define-key org-mode-map [menu-bar headings] 'undefined)
  4718. (define-key org-mode-map [menu-bar hide] 'undefined)
  4719. (define-key org-mode-map [menu-bar show] 'undefined))
  4720. (org-load-modules-maybe)
  4721. (easy-menu-add org-org-menu)
  4722. (easy-menu-add org-tbl-menu)
  4723. (org-install-agenda-files-menu)
  4724. (if org-descriptive-links (add-to-invisibility-spec '(org-link)))
  4725. (add-to-invisibility-spec '(org-cwidth))
  4726. (add-to-invisibility-spec '(org-hide-block . t))
  4727. (when (featurep 'xemacs)
  4728. (org-set-local 'line-move-ignore-invisible t))
  4729. (org-set-local 'outline-regexp org-outline-regexp)
  4730. (org-set-local 'outline-level 'org-outline-level)
  4731. (setq bidi-paragraph-direction 'left-to-right)
  4732. (when (and org-ellipsis
  4733. (fboundp 'set-display-table-slot) (boundp 'buffer-display-table)
  4734. (fboundp 'make-glyph-code))
  4735. (unless org-display-table
  4736. (setq org-display-table (make-display-table)))
  4737. (set-display-table-slot
  4738. org-display-table 4
  4739. (vconcat (mapcar
  4740. (lambda (c) (make-glyph-code c (and (not (stringp org-ellipsis))
  4741. org-ellipsis)))
  4742. (if (stringp org-ellipsis) org-ellipsis "..."))))
  4743. (setq buffer-display-table org-display-table))
  4744. (org-set-regexps-and-options-for-tags)
  4745. (org-set-regexps-and-options)
  4746. (org-set-font-lock-defaults)
  4747. (when (and org-tag-faces (not org-tags-special-faces-re))
  4748. ;; tag faces set outside customize.... force initialization.
  4749. (org-set-tag-faces 'org-tag-faces org-tag-faces))
  4750. ;; Calc embedded
  4751. (org-set-local 'calc-embedded-open-mode "# ")
  4752. ;; Modify a few syntax entries
  4753. (modify-syntax-entry ?@ "w")
  4754. (modify-syntax-entry ?\" "\"")
  4755. (if org-startup-truncated (setq truncate-lines t))
  4756. (when org-startup-indented (require 'org-indent) (org-indent-mode 1))
  4757. (org-set-local 'font-lock-unfontify-region-function
  4758. 'org-unfontify-region)
  4759. ;; Activate before-change-function
  4760. (org-set-local 'org-table-may-need-update t)
  4761. (org-add-hook 'before-change-functions 'org-before-change-function nil
  4762. 'local)
  4763. ;; Check for running clock before killing a buffer
  4764. (org-add-hook 'kill-buffer-hook 'org-check-running-clock nil 'local)
  4765. ;; Initialize macros templates.
  4766. (org-macro-initialize-templates)
  4767. ;; Initialize radio targets.
  4768. (org-update-radio-target-regexp)
  4769. ;; Indentation.
  4770. (org-set-local 'indent-line-function 'org-indent-line)
  4771. (org-set-local 'indent-region-function 'org-indent-region)
  4772. ;; Filling and auto-filling.
  4773. (org-setup-filling)
  4774. ;; Comments.
  4775. (org-setup-comments-handling)
  4776. ;; Beginning/end of defun
  4777. (org-set-local 'beginning-of-defun-function 'org-backward-element)
  4778. (org-set-local 'end-of-defun-function 'org-forward-element)
  4779. ;; Next error for sparse trees
  4780. (org-set-local 'next-error-function 'org-occur-next-match)
  4781. ;; Make sure dependence stuff works reliably, even for users who set it
  4782. ;; too late :-(
  4783. (if org-enforce-todo-dependencies
  4784. (add-hook 'org-blocker-hook
  4785. 'org-block-todo-from-children-or-siblings-or-parent)
  4786. (remove-hook 'org-blocker-hook
  4787. 'org-block-todo-from-children-or-siblings-or-parent))
  4788. (if org-enforce-todo-checkbox-dependencies
  4789. (add-hook 'org-blocker-hook
  4790. 'org-block-todo-from-checkboxes)
  4791. (remove-hook 'org-blocker-hook
  4792. 'org-block-todo-from-checkboxes))
  4793. ;; Align options lines
  4794. (org-set-local
  4795. 'align-mode-rules-list
  4796. '((org-in-buffer-settings
  4797. (regexp . "^#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
  4798. (modes . '(org-mode)))))
  4799. ;; Imenu
  4800. (org-set-local 'imenu-create-index-function
  4801. 'org-imenu-get-tree)
  4802. ;; Make isearch reveal context
  4803. (if (or (featurep 'xemacs)
  4804. (not (boundp 'outline-isearch-open-invisible-function)))
  4805. ;; Emacs 21 and XEmacs make use of the hook
  4806. (org-add-hook 'isearch-mode-end-hook 'org-isearch-end 'append 'local)
  4807. ;; Emacs 22 deals with this through a special variable
  4808. (org-set-local 'outline-isearch-open-invisible-function
  4809. (lambda (&rest ignore) (org-show-context 'isearch)))
  4810. (org-add-hook 'isearch-mode-end-hook 'org-fix-ellipsis-at-bol 'append 'local))
  4811. ;; Setup the pcomplete hooks
  4812. (set (make-local-variable 'pcomplete-command-completion-function)
  4813. 'org-pcomplete-initial)
  4814. (set (make-local-variable 'pcomplete-command-name-function)
  4815. 'org-command-at-point)
  4816. (set (make-local-variable 'pcomplete-default-completion-function)
  4817. 'ignore)
  4818. (set (make-local-variable 'pcomplete-parse-arguments-function)
  4819. 'org-parse-arguments)
  4820. (set (make-local-variable 'pcomplete-termination-string) "")
  4821. (when (>= emacs-major-version 23)
  4822. (set (make-local-variable 'buffer-face-mode-face) 'org-default))
  4823. ;; If empty file that did not turn on org-mode automatically, make it to.
  4824. (if (and org-insert-mode-line-in-empty-file
  4825. (org-called-interactively-p 'any)
  4826. (= (point-min) (point-max)))
  4827. (insert "# -*- mode: org -*-\n\n"))
  4828. (unless org-inhibit-startup
  4829. (org-unmodified
  4830. (and org-startup-with-beamer-mode (org-beamer-mode))
  4831. (when org-startup-align-all-tables
  4832. (org-table-map-tables 'org-table-align 'quietly))
  4833. (when org-startup-with-inline-images
  4834. (org-display-inline-images))
  4835. (when org-startup-with-latex-preview
  4836. (org-preview-latex-fragment))
  4837. (unless org-inhibit-startup-visibility-stuff
  4838. (org-set-startup-visibility))))
  4839. ;; Try to set org-hide correctly
  4840. (set-face-foreground 'org-hide (org-find-invisible-foreground)))
  4841. ;; Update `customize-package-emacs-version-alist'
  4842. (add-to-list 'customize-package-emacs-version-alist
  4843. '(Org ("6.21b" . "23.1") ("6.33x" . "23.2")
  4844. ("7.8.11" . "24.1") ("7.9.4" . "24.3")
  4845. ("8.0" . "24.4")))
  4846. (defvar org-mode-transpose-word-syntax-table
  4847. (let ((st (make-syntax-table)))
  4848. (mapc (lambda(c) (modify-syntax-entry
  4849. (string-to-char (car c)) "w p" st))
  4850. org-emphasis-alist)
  4851. st))
  4852. (when (fboundp 'abbrev-table-put)
  4853. (abbrev-table-put org-mode-abbrev-table
  4854. :parents (list text-mode-abbrev-table)))
  4855. (put 'org-mode 'flyspell-mode-predicate 'org-mode-flyspell-verify)
  4856. (defsubst org-fix-ellipsis-at-bol ()
  4857. (save-excursion (goto-char (window-start)) (recenter 0)))
  4858. (defun org-find-invisible-foreground ()
  4859. (let ((candidates (remove
  4860. "unspecified-bg"
  4861. (nconc
  4862. (list (face-background 'default)
  4863. (face-background 'org-default))
  4864. (mapcar
  4865. (lambda (alist)
  4866. (when (boundp alist)
  4867. (cdr (assoc 'background-color (symbol-value alist)))))
  4868. '(default-frame-alist initial-frame-alist window-system-default-frame-alist))
  4869. (list (face-foreground 'org-hide))))))
  4870. (car (remove nil candidates))))
  4871. (defun org-current-time (&optional rounding-minutes past)
  4872. "Current time, possibly rounded to ROUNDING-MINUTES.
  4873. When ROUNDING-MINUTES is not an integer, fall back on the car of
  4874. `org-time-stamp-rounding-minutes'. When PAST is non-nil, ensure
  4875. the rounding returns a past time."
  4876. (let ((r (or (and (integerp rounding-minutes) rounding-minutes)
  4877. (car org-time-stamp-rounding-minutes)))
  4878. (time (decode-time)) res)
  4879. (if (< r 1)
  4880. (current-time)
  4881. (setq res
  4882. (apply 'encode-time
  4883. (append (list 0 (* r (floor (+ .5 (/ (float (nth 1 time)) r)))))
  4884. (nthcdr 2 time))))
  4885. (if (and past (< (org-float-time (time-subtract (current-time) res)) 0))
  4886. (seconds-to-time (- (org-float-time res) (* r 60)))
  4887. res))))
  4888. (defun org-today ()
  4889. "Return today date, considering `org-extend-today-until'."
  4890. (time-to-days
  4891. (time-subtract (current-time)
  4892. (list 0 (* 3600 org-extend-today-until) 0))))
  4893. ;;;; Font-Lock stuff, including the activators
  4894. (defvar org-mouse-map (make-sparse-keymap))
  4895. (org-defkey org-mouse-map [mouse-2] 'org-open-at-mouse)
  4896. (org-defkey org-mouse-map [mouse-3] 'org-find-file-at-mouse)
  4897. (when org-mouse-1-follows-link
  4898. (org-defkey org-mouse-map [follow-link] 'mouse-face))
  4899. (when org-tab-follows-link
  4900. (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
  4901. (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
  4902. (require 'font-lock)
  4903. (defconst org-non-link-chars "]\t\n\r<>")
  4904. (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "news"
  4905. "shell" "elisp" "doi" "message"))
  4906. (defvar org-link-types-re nil
  4907. "Matches a link that has a url-like prefix like \"http:\"")
  4908. (defvar org-link-re-with-space nil
  4909. "Matches a link with spaces, optional angular brackets around it.")
  4910. (defvar org-link-re-with-space2 nil
  4911. "Matches a link with spaces, optional angular brackets around it.")
  4912. (defvar org-link-re-with-space3 nil
  4913. "Matches a link with spaces, only for internal part in bracket links.")
  4914. (defvar org-angle-link-re nil
  4915. "Matches link with angular brackets, spaces are allowed.")
  4916. (defvar org-plain-link-re nil
  4917. "Matches plain link, without spaces.")
  4918. (defvar org-bracket-link-regexp nil
  4919. "Matches a link in double brackets.")
  4920. (defvar org-bracket-link-analytic-regexp nil
  4921. "Regular expression used to analyze links.
  4922. Here is what the match groups contain after a match:
  4923. 1: http:
  4924. 2: http
  4925. 3: path
  4926. 4: [desc]
  4927. 5: desc")
  4928. (defvar org-bracket-link-analytic-regexp++ nil
  4929. "Like `org-bracket-link-analytic-regexp', but include coderef internal type.")
  4930. (defvar org-any-link-re nil
  4931. "Regular expression matching any link.")
  4932. (defconst org-match-sexp-depth 3
  4933. "Number of stacked braces for sub/superscript matching.")
  4934. (defun org-create-multibrace-regexp (left right n)
  4935. "Create a regular expression which will match a balanced sexp.
  4936. Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
  4937. as single character strings.
  4938. The regexp returned will match the entire expression including the
  4939. delimiters. It will also define a single group which contains the
  4940. match except for the outermost delimiters. The maximum depth of
  4941. stacked delimiters is N. Escaping delimiters is not possible."
  4942. (let* ((nothing (concat "[^" left right "]*?"))
  4943. (or "\\|")
  4944. (re nothing)
  4945. (next (concat "\\(?:" nothing left nothing right "\\)+" nothing)))
  4946. (while (> n 1)
  4947. (setq n (1- n)
  4948. re (concat re or next)
  4949. next (concat "\\(?:" nothing left next right "\\)+" nothing)))
  4950. (concat left "\\(" re "\\)" right)))
  4951. (defvar org-match-substring-regexp
  4952. (concat
  4953. "\\(\\S-\\)\\([_^]\\)\\("
  4954. "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
  4955. "\\|"
  4956. "\\(" (org-create-multibrace-regexp "(" ")" org-match-sexp-depth) "\\)"
  4957. "\\|"
  4958. "\\(\\(?:\\*\\|[-+]?[^-+*!@#$%^_ \t\r\n,:\"?<>~;./{}=()]+\\)\\)\\)")
  4959. "The regular expression matching a sub- or superscript.")
  4960. (defvar org-match-substring-with-braces-regexp
  4961. (concat
  4962. "\\(\\S-\\)\\([_^]\\)\\("
  4963. "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
  4964. "\\)")
  4965. "The regular expression matching a sub- or superscript, forcing braces.")
  4966. (defun org-make-link-regexps ()
  4967. "Update the link regular expressions.
  4968. This should be called after the variable `org-link-types' has changed."
  4969. (setq org-link-types-re
  4970. (concat
  4971. "\\`\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):")
  4972. org-link-re-with-space
  4973. (concat
  4974. "<?\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4975. "\\([^" org-non-link-chars " ]"
  4976. "[^" org-non-link-chars "]*"
  4977. "[^" org-non-link-chars " ]\\)>?")
  4978. org-link-re-with-space2
  4979. (concat
  4980. "<?\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4981. "\\([^" org-non-link-chars " ]"
  4982. "[^\t\n\r]*"
  4983. "[^" org-non-link-chars " ]\\)>?")
  4984. org-link-re-with-space3
  4985. (concat
  4986. "<?\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4987. "\\([^" org-non-link-chars " ]"
  4988. "[^\t\n\r]*\\)")
  4989. org-angle-link-re
  4990. (concat
  4991. "<\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4992. "\\([^" org-non-link-chars " ]"
  4993. "[^" org-non-link-chars "]*"
  4994. "\\)>")
  4995. org-plain-link-re
  4996. (concat
  4997. "\\<\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4998. (org-re "\\([^ \t\n()<>]+\\(?:([[:word:]0-9_]+)\\|\\([^[:punct:] \t\n]\\|/\\)\\)\\)"))
  4999. ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
  5000. org-bracket-link-regexp
  5001. "\\[\\[\\([^][]+\\)\\]\\(\\[\\([^][]+\\)\\]\\)?\\]"
  5002. org-bracket-link-analytic-regexp
  5003. (concat
  5004. "\\[\\["
  5005. "\\(\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):\\)?"
  5006. "\\([^]]+\\)"
  5007. "\\]"
  5008. "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
  5009. "\\]")
  5010. org-bracket-link-analytic-regexp++
  5011. (concat
  5012. "\\[\\["
  5013. "\\(\\(" (mapconcat 'regexp-quote (cons "coderef" org-link-types) "\\|") "\\):\\)?"
  5014. "\\([^]]+\\)"
  5015. "\\]"
  5016. "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
  5017. "\\]")
  5018. org-any-link-re
  5019. (concat "\\(" org-bracket-link-regexp "\\)\\|\\("
  5020. org-angle-link-re "\\)\\|\\("
  5021. org-plain-link-re "\\)")))
  5022. (org-make-link-regexps)
  5023. (defconst org-ts-regexp "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)>"
  5024. "Regular expression for fast time stamp matching.")
  5025. (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
  5026. "Regular expression for fast time stamp matching.")
  5027. (defconst org-ts-regexp0
  5028. "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\( +[^]+0-9>\r\n -]+\\)?\\( +\\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
  5029. "Regular expression matching time strings for analysis.
  5030. This one does not require the space after the date, so it can be used
  5031. on a string that terminates immediately after the date.")
  5032. (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
  5033. "Regular expression matching time strings for analysis.")
  5034. (defconst org-ts-regexp2 (concat "<" org-ts-regexp1 "[^>\n]\\{0,16\\}>")
  5035. "Regular expression matching time stamps, with groups.")
  5036. (defconst org-ts-regexp3 (concat "[[<]" org-ts-regexp1 "[^]>\n]\\{0,16\\}[]>]")
  5037. "Regular expression matching time stamps (also [..]), with groups.")
  5038. (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
  5039. "Regular expression matching a time stamp range.")
  5040. (defconst org-tr-regexp-both
  5041. (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
  5042. "Regular expression matching a time stamp range.")
  5043. (defconst org-tsr-regexp (concat org-ts-regexp "\\(--?-?"
  5044. org-ts-regexp "\\)?")
  5045. "Regular expression matching a time stamp or time stamp range.")
  5046. (defconst org-tsr-regexp-both
  5047. (concat org-ts-regexp-both "\\(--?-?"
  5048. org-ts-regexp-both "\\)?")
  5049. "Regular expression matching a time stamp or time stamp range.
  5050. The time stamps may be either active or inactive.")
  5051. (defvar org-emph-face nil)
  5052. (defun org-do-emphasis-faces (limit)
  5053. "Run through the buffer and add overlays to emphasized strings."
  5054. (let (rtn a)
  5055. (while (and (not rtn) (re-search-forward org-emph-re limit t))
  5056. (if (not (= (char-after (match-beginning 3))
  5057. (char-after (match-beginning 4))))
  5058. (progn
  5059. (setq rtn t)
  5060. (setq a (assoc (match-string 3) org-emphasis-alist))
  5061. (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
  5062. 'face
  5063. (nth 1 a))
  5064. (and (nth 4 a)
  5065. (org-remove-flyspell-overlays-in
  5066. (match-beginning 0) (match-end 0)))
  5067. (add-text-properties (match-beginning 2) (match-end 2)
  5068. '(font-lock-multiline t org-emphasis t))
  5069. (when org-hide-emphasis-markers
  5070. (add-text-properties (match-end 4) (match-beginning 5)
  5071. '(invisible org-link))
  5072. (add-text-properties (match-beginning 3) (match-end 3)
  5073. '(invisible org-link)))))
  5074. (backward-char 1))
  5075. rtn))
  5076. (defun org-emphasize (&optional char)
  5077. "Insert or change an emphasis, i.e. a font like bold or italic.
  5078. If there is an active region, change that region to a new emphasis.
  5079. If there is no region, just insert the marker characters and position
  5080. the cursor between them.
  5081. CHAR should be the marker character. If it is a space, it means to
  5082. remove the emphasis of the selected region.
  5083. If CHAR is not given (for example in an interactive call) it will be
  5084. prompted for."
  5085. (interactive)
  5086. (let ((erc org-emphasis-regexp-components)
  5087. (prompt "")
  5088. (string "") beg end move c s)
  5089. (if (org-region-active-p)
  5090. (setq beg (region-beginning) end (region-end)
  5091. string (buffer-substring beg end))
  5092. (setq move t))
  5093. (unless char
  5094. (message "Emphasis marker or tag: [%s]"
  5095. (mapconcat (lambda(e) (car e)) org-emphasis-alist ""))
  5096. (setq char (read-char-exclusive)))
  5097. (if (equal char ?\ )
  5098. (setq s "" move nil)
  5099. (unless (assoc (char-to-string char) org-emphasis-alist)
  5100. (user-error "No such emphasis marker: \"%c\"" char))
  5101. (setq s (char-to-string char)))
  5102. (while (and (> (length string) 1)
  5103. (equal (substring string 0 1) (substring string -1))
  5104. (assoc (substring string 0 1) org-emphasis-alist))
  5105. (setq string (substring string 1 -1)))
  5106. (setq string (concat s string s))
  5107. (if beg (delete-region beg end))
  5108. (unless (or (bolp)
  5109. (string-match (concat "[" (nth 0 erc) "\n]")
  5110. (char-to-string (char-before (point)))))
  5111. (insert " "))
  5112. (unless (or (eobp)
  5113. (string-match (concat "[" (nth 1 erc) "\n]")
  5114. (char-to-string (char-after (point)))))
  5115. (insert " ") (backward-char 1))
  5116. (insert string)
  5117. (and move (backward-char 1))))
  5118. (defconst org-nonsticky-props
  5119. '(mouse-face highlight keymap invisible intangible help-echo org-linked-text htmlize-link))
  5120. (defsubst org-rear-nonsticky-at (pos)
  5121. (add-text-properties (1- pos) pos (list 'rear-nonsticky org-nonsticky-props)))
  5122. (defun org-activate-plain-links (limit)
  5123. "Run through the buffer and add overlays to links."
  5124. (let (f hl)
  5125. (when (and (re-search-forward (concat org-plain-link-re) limit t)
  5126. (not (org-in-src-block-p)))
  5127. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  5128. (setq f (get-text-property (match-beginning 0) 'face))
  5129. (setq hl (org-match-string-no-properties 0))
  5130. (if (or (eq f 'org-tag)
  5131. (and (listp f) (memq 'org-tag f)))
  5132. nil
  5133. (add-text-properties (match-beginning 0) (match-end 0)
  5134. (list 'mouse-face 'highlight
  5135. 'face 'org-link
  5136. 'htmlize-link `(:uri ,hl)
  5137. 'keymap org-mouse-map))
  5138. (org-rear-nonsticky-at (match-end 0)))
  5139. t)))
  5140. (defun org-activate-code (limit)
  5141. (if (re-search-forward "^[ \t]*\\(:\\(?: .*\\|$\\)\n?\\)" limit t)
  5142. (progn
  5143. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  5144. (remove-text-properties (match-beginning 0) (match-end 0)
  5145. '(display t invisible t intangible t))
  5146. t)))
  5147. (defcustom org-src-fontify-natively nil
  5148. "When non-nil, fontify code in code blocks."
  5149. :type 'boolean
  5150. :version "24.1"
  5151. :group 'org-appearance
  5152. :group 'org-babel)
  5153. (defcustom org-allow-promoting-top-level-subtree nil
  5154. "When non-nil, allow promoting a top level subtree.
  5155. The leading star of the top level headline will be replaced
  5156. by a #."
  5157. :type 'boolean
  5158. :version "24.1"
  5159. :group 'org-appearance)
  5160. (defun org-fontify-meta-lines-and-blocks (limit)
  5161. (condition-case nil
  5162. (org-fontify-meta-lines-and-blocks-1 limit)
  5163. (error (message "org-mode fontification error"))))
  5164. (defun org-fontify-meta-lines-and-blocks-1 (limit)
  5165. "Fontify #+ lines and blocks."
  5166. (let ((case-fold-search t))
  5167. (if (re-search-forward
  5168. "^\\([ \t]*#\\(\\(\\+[a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
  5169. limit t)
  5170. (let ((beg (match-beginning 0))
  5171. (block-start (match-end 0))
  5172. (block-end nil)
  5173. (lang (match-string 7))
  5174. (beg1 (line-beginning-position 2))
  5175. (dc1 (downcase (match-string 2)))
  5176. (dc3 (downcase (match-string 3)))
  5177. end end1 quoting block-type ovl)
  5178. (cond
  5179. ((member dc1 '("+html:" "+ascii:" "+latex:"))
  5180. ;; a single line of backend-specific content
  5181. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  5182. (remove-text-properties (match-beginning 0) (match-end 0)
  5183. '(display t invisible t intangible t))
  5184. (add-text-properties (match-beginning 1) (match-end 3)
  5185. '(font-lock-fontified t face org-meta-line))
  5186. (add-text-properties (match-beginning 6) (+ (match-end 6) 1)
  5187. '(font-lock-fontified t face org-block))
  5188. ; for backend-specific code
  5189. t)
  5190. ((and (match-end 4) (equal dc3 "+begin"))
  5191. ;; Truly a block
  5192. (setq block-type (downcase (match-string 5))
  5193. quoting (member block-type org-protecting-blocks))
  5194. (when (re-search-forward
  5195. (concat "^[ \t]*#\\+end" (match-string 4) "\\>.*")
  5196. nil t) ;; on purpose, we look further than LIMIT
  5197. (setq end (min (point-max) (match-end 0))
  5198. end1 (min (point-max) (1- (match-beginning 0))))
  5199. (setq block-end (match-beginning 0))
  5200. (when quoting
  5201. (remove-text-properties beg end
  5202. '(display t invisible t intangible t)))
  5203. (add-text-properties
  5204. beg end
  5205. '(font-lock-fontified t font-lock-multiline t))
  5206. (add-text-properties beg beg1 '(face org-meta-line))
  5207. (add-text-properties end1 (min (point-max) (1+ end))
  5208. '(face org-meta-line)) ; for end_src
  5209. (cond
  5210. ((and lang (not (string= lang "")) org-src-fontify-natively)
  5211. (org-src-font-lock-fontify-block lang block-start block-end)
  5212. ;; remove old background overlays
  5213. (mapc (lambda (ov)
  5214. (if (eq (overlay-get ov 'face) 'org-block-background)
  5215. (delete-overlay ov)))
  5216. (overlays-at (/ (+ beg1 block-end) 2)))
  5217. ;; add a background overlay
  5218. (setq ovl (make-overlay beg1 block-end))
  5219. (overlay-put ovl 'face 'org-block-background)
  5220. (overlay-put ovl 'evaporate t)) ;; make it go away when empty
  5221. (quoting
  5222. (add-text-properties beg1 (min (point-max) (1+ end1))
  5223. '(face org-block))) ; end of source block
  5224. ((not org-fontify-quote-and-verse-blocks))
  5225. ((string= block-type "quote")
  5226. (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-quote)))
  5227. ((string= block-type "verse")
  5228. (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-verse))))
  5229. (add-text-properties beg beg1 '(face org-block-begin-line))
  5230. (add-text-properties (min (point-max) (1+ end)) (min (point-max) (1+ end1))
  5231. '(face org-block-end-line))
  5232. t))
  5233. ((member dc1 '("+title:" "+author:" "+email:" "+date:"))
  5234. (add-text-properties
  5235. beg (match-end 3)
  5236. (if (member (intern (substring dc1 0 -1)) org-hidden-keywords)
  5237. '(font-lock-fontified t invisible t)
  5238. '(font-lock-fontified t face org-document-info-keyword)))
  5239. (add-text-properties
  5240. (match-beginning 6) (min (point-max) (1+ (match-end 6)))
  5241. (if (string-equal dc1 "+title:")
  5242. '(font-lock-fontified t face org-document-title)
  5243. '(font-lock-fontified t face org-document-info))))
  5244. ((or (equal dc1 "+results")
  5245. (member dc1 '("+begin:" "+end:" "+caption:" "+label:"
  5246. "+orgtbl:" "+tblfm:" "+tblname:" "+results:"
  5247. "+call:" "+header:" "+headers:" "+name:"))
  5248. (and (match-end 4) (equal dc3 "+attr")))
  5249. (add-text-properties
  5250. beg (match-end 0)
  5251. '(font-lock-fontified t face org-meta-line))
  5252. t)
  5253. ((member dc3 '(" " ""))
  5254. (add-text-properties
  5255. beg (match-end 0)
  5256. '(font-lock-fontified t face font-lock-comment-face)))
  5257. ((not (member (char-after beg) '(?\ ?\t)))
  5258. ;; just any other in-buffer setting, but not indented
  5259. (add-text-properties
  5260. beg (match-end 0)
  5261. '(font-lock-fontified t face org-meta-line))
  5262. t)
  5263. (t nil))))))
  5264. (defun org-activate-angle-links (limit)
  5265. "Run through the buffer and add overlays to links."
  5266. (if (and (re-search-forward org-angle-link-re limit t)
  5267. (not (org-in-src-block-p)))
  5268. (progn
  5269. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  5270. (add-text-properties (match-beginning 0) (match-end 0)
  5271. (list 'mouse-face 'highlight
  5272. 'keymap org-mouse-map))
  5273. (org-rear-nonsticky-at (match-end 0))
  5274. t)))
  5275. (defun org-activate-footnote-links (limit)
  5276. "Run through the buffer and add overlays to footnotes."
  5277. (let ((fn (org-footnote-next-reference-or-definition limit)))
  5278. (when fn
  5279. (let ((beg (nth 1 fn)) (end (nth 2 fn)))
  5280. (org-remove-flyspell-overlays-in beg end)
  5281. (add-text-properties beg end
  5282. (list 'mouse-face 'highlight
  5283. 'keymap org-mouse-map
  5284. 'help-echo
  5285. (if (= (point-at-bol) beg)
  5286. "Footnote definition"
  5287. "Footnote reference")
  5288. 'font-lock-fontified t
  5289. 'font-lock-multiline t
  5290. 'face 'org-footnote))))))
  5291. (defun org-activate-bracket-links (limit)
  5292. "Run through the buffer and add overlays to bracketed links."
  5293. (if (and (re-search-forward org-bracket-link-regexp limit t)
  5294. (not (org-in-src-block-p)))
  5295. (let* ((hl (org-match-string-no-properties 1))
  5296. (help (concat "LINK: " (save-match-data (org-link-unescape hl))))
  5297. (ip (org-maybe-intangible
  5298. (list 'invisible 'org-link
  5299. 'keymap org-mouse-map 'mouse-face 'highlight
  5300. 'font-lock-multiline t 'help-echo help
  5301. 'htmlize-link `(:uri ,hl))))
  5302. (vp (list 'keymap org-mouse-map 'mouse-face 'highlight
  5303. 'font-lock-multiline t 'help-echo help
  5304. 'htmlize-link `(:uri ,hl))))
  5305. ;; We need to remove the invisible property here. Table narrowing
  5306. ;; may have made some of this invisible.
  5307. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  5308. (remove-text-properties (match-beginning 0) (match-end 0)
  5309. '(invisible nil))
  5310. (if (match-end 3)
  5311. (progn
  5312. (add-text-properties (match-beginning 0) (match-beginning 3) ip)
  5313. (org-rear-nonsticky-at (match-beginning 3))
  5314. (add-text-properties (match-beginning 3) (match-end 3) vp)
  5315. (org-rear-nonsticky-at (match-end 3))
  5316. (add-text-properties (match-end 3) (match-end 0) ip)
  5317. (org-rear-nonsticky-at (match-end 0)))
  5318. (add-text-properties (match-beginning 0) (match-beginning 1) ip)
  5319. (org-rear-nonsticky-at (match-beginning 1))
  5320. (add-text-properties (match-beginning 1) (match-end 1) vp)
  5321. (org-rear-nonsticky-at (match-end 1))
  5322. (add-text-properties (match-end 1) (match-end 0) ip)
  5323. (org-rear-nonsticky-at (match-end 0)))
  5324. t)))
  5325. (defun org-activate-dates (limit)
  5326. "Run through the buffer and add overlays to dates."
  5327. (if (and (re-search-forward org-tsr-regexp-both limit t)
  5328. (not (equal (char-before (match-beginning 0)) 91)))
  5329. (progn
  5330. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  5331. (add-text-properties (match-beginning 0) (match-end 0)
  5332. (list 'mouse-face 'highlight
  5333. 'keymap org-mouse-map))
  5334. (org-rear-nonsticky-at (match-end 0))
  5335. (when org-display-custom-times
  5336. (if (match-end 3)
  5337. (org-display-custom-time (match-beginning 3) (match-end 3)))
  5338. (org-display-custom-time (match-beginning 1) (match-end 1)))
  5339. t)))
  5340. (defvar org-target-link-regexp nil
  5341. "Regular expression matching radio targets in plain text.")
  5342. (make-variable-buffer-local 'org-target-link-regexp)
  5343. (defvar org-target-regexp "<<\\([^<>\n\r]+\\)>>"
  5344. "Regular expression matching a link target.")
  5345. (defvar org-radio-target-regexp "<<<\\([^<>\n\r]+\\)>>>"
  5346. "Regular expression matching a radio target.")
  5347. (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
  5348. "Regular expression matching any target.")
  5349. (defun org-activate-target-links (limit)
  5350. "Run through the buffer and add overlays to target matches."
  5351. (when org-target-link-regexp
  5352. (let ((case-fold-search t))
  5353. (if (re-search-forward org-target-link-regexp limit t)
  5354. (progn
  5355. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  5356. (add-text-properties (match-beginning 0) (match-end 0)
  5357. (list 'mouse-face 'highlight
  5358. 'keymap org-mouse-map
  5359. 'help-echo "Radio target link"
  5360. 'org-linked-text t))
  5361. (org-rear-nonsticky-at (match-end 0))
  5362. t)))))
  5363. (defun org-update-radio-target-regexp ()
  5364. "Find all radio targets in this file and update the regular expression."
  5365. (interactive)
  5366. (when (memq 'radio org-activate-links)
  5367. (setq org-target-link-regexp
  5368. (org-make-target-link-regexp (org-all-targets 'radio)))
  5369. (org-restart-font-lock)))
  5370. (defun org-hide-wide-columns (limit)
  5371. (let (s e)
  5372. (setq s (text-property-any (point) (or limit (point-max))
  5373. 'org-cwidth t))
  5374. (when s
  5375. (setq e (next-single-property-change s 'org-cwidth))
  5376. (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
  5377. (goto-char e)
  5378. t)))
  5379. (defvar org-latex-and-related-regexp nil
  5380. "Regular expression for highlighting LaTeX, entities and sub/superscript.")
  5381. (defvar org-match-substring-regexp)
  5382. (defvar org-match-substring-with-braces-regexp)
  5383. (defun org-compute-latex-and-related-regexp ()
  5384. "Compute regular expression for LaTeX, entities and sub/superscript.
  5385. Result depends on variable `org-highlight-latex-and-related'."
  5386. (org-set-local
  5387. 'org-latex-and-related-regexp
  5388. (let* ((re-sub
  5389. (cond ((not (memq 'script org-highlight-latex-and-related)) nil)
  5390. ((eq org-use-sub-superscripts '{})
  5391. (list org-match-substring-with-braces-regexp))
  5392. (org-use-sub-superscripts (list org-match-substring-regexp))))
  5393. (re-latex
  5394. (when (memq 'latex org-highlight-latex-and-related)
  5395. (let ((matchers (plist-get org-format-latex-options :matchers)))
  5396. (delq nil
  5397. (mapcar (lambda (x)
  5398. (and (member (car x) matchers) (nth 1 x)))
  5399. org-latex-regexps)))))
  5400. (re-entities
  5401. (when (memq 'entities org-highlight-latex-and-related)
  5402. (list "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)"))))
  5403. (mapconcat 'identity (append re-latex re-entities re-sub) "\\|"))))
  5404. (defun org-do-latex-and-related (limit)
  5405. "Highlight LaTeX snippets and environments, entities and sub/superscript.
  5406. LIMIT bounds the search for syntax to highlight. Stop at first
  5407. highlighted object, if any. Return t if some highlighting was
  5408. done, nil otherwise."
  5409. (when (org-string-nw-p org-latex-and-related-regexp)
  5410. (catch 'found
  5411. (while (re-search-forward org-latex-and-related-regexp limit t)
  5412. (unless (memq (car-safe (get-text-property (1+ (match-beginning 0))
  5413. 'face))
  5414. '(org-code org-verbatim underline))
  5415. (let ((offset (if (memq (char-after (1+ (match-beginning 0)))
  5416. '(?_ ?^))
  5417. 1
  5418. 0)))
  5419. (font-lock-prepend-text-property
  5420. (+ offset (match-beginning 0)) (match-end 0)
  5421. 'face 'org-latex-and-related)
  5422. (add-text-properties (+ offset (match-beginning 0)) (match-end 0)
  5423. '(font-lock-multiline t)))
  5424. (throw 'found t)))
  5425. nil)))
  5426. (defun org-restart-font-lock ()
  5427. "Restart `font-lock-mode', to force refontification."
  5428. (when (and (boundp 'font-lock-mode) font-lock-mode)
  5429. (font-lock-mode -1)
  5430. (font-lock-mode 1)))
  5431. (defun org-all-targets (&optional radio)
  5432. "Return a list of all targets in this file.
  5433. When optional argument RADIO is non-nil, only find radio
  5434. targets."
  5435. (let ((re (if radio org-radio-target-regexp org-target-regexp)) rtn)
  5436. (save-excursion
  5437. (goto-char (point-min))
  5438. (while (re-search-forward re nil t)
  5439. ;; Make sure point is really within the object.
  5440. (backward-char)
  5441. (let ((obj (org-element-context)))
  5442. (when (memq (org-element-type obj) '(radio-target target))
  5443. (add-to-list 'rtn (downcase (org-element-property :value obj))))))
  5444. rtn)))
  5445. (defun org-make-target-link-regexp (targets)
  5446. "Make regular expression matching all strings in TARGETS.
  5447. The regular expression finds the targets also if there is a line break
  5448. between words."
  5449. (and targets
  5450. (concat
  5451. "\\<\\("
  5452. (mapconcat
  5453. (lambda (x)
  5454. (setq x (regexp-quote x))
  5455. (while (string-match " +" x)
  5456. (setq x (replace-match "\\s-+" t t x)))
  5457. x)
  5458. targets
  5459. "\\|")
  5460. "\\)\\>")))
  5461. (defun org-activate-tags (limit)
  5462. (if (re-search-forward (org-re "^\\*+.*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \r\n]") limit t)
  5463. (progn
  5464. (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
  5465. (add-text-properties (match-beginning 1) (match-end 1)
  5466. (list 'mouse-face 'highlight
  5467. 'keymap org-mouse-map))
  5468. (org-rear-nonsticky-at (match-end 1))
  5469. t)))
  5470. (defun org-outline-level ()
  5471. "Compute the outline level of the heading at point.
  5472. If this is called at a normal headline, the level is the number of stars.
  5473. Use `org-reduced-level' to remove the effect of `org-odd-levels'."
  5474. (save-excursion
  5475. (if (not (condition-case nil
  5476. (org-back-to-heading t)
  5477. (error nil)))
  5478. 0
  5479. (looking-at org-outline-regexp)
  5480. (1- (- (match-end 0) (match-beginning 0))))))
  5481. (defvar org-font-lock-keywords nil)
  5482. (defsubst org-re-property (property &optional literal)
  5483. "Return a regexp matching a PROPERTY line.
  5484. Match group 3 will be set to the value if it exists."
  5485. (concat "^\\(?4:[ \t]*\\)\\(?1::\\(?2:"
  5486. (if literal property (regexp-quote property))
  5487. "\\):\\)[ \t]+\\(?3:[^ \t\r\n].*?\\)\\(?5:[ \t]*\\)$"))
  5488. (defconst org-property-re
  5489. (org-re-property ".*?" 'literal)
  5490. "Regular expression matching a property line.
  5491. There are four matching groups:
  5492. 1: :PROPKEY: including the leading and trailing colon,
  5493. 2: PROPKEY without the leading and trailing colon,
  5494. 3: PROPVAL without leading or trailing spaces,
  5495. 4: the indentation of the current line,
  5496. 5: trailing whitespace.")
  5497. (defvar org-font-lock-hook nil
  5498. "Functions to be called for special font lock stuff.")
  5499. (defvar org-font-lock-set-keywords-hook nil
  5500. "Functions that can manipulate `org-font-lock-extra-keywords'.
  5501. This is called after `org-font-lock-extra-keywords' is defined, but before
  5502. it is installed to be used by font lock. This can be useful if something
  5503. needs to be inserted at a specific position in the font-lock sequence.")
  5504. (defun org-font-lock-hook (limit)
  5505. "Run `org-font-lock-hook' within LIMIT."
  5506. (run-hook-with-args 'org-font-lock-hook limit))
  5507. (defun org-set-font-lock-defaults ()
  5508. "Set font lock defaults for the current buffer."
  5509. (let* ((em org-fontify-emphasized-text)
  5510. (lk org-activate-links)
  5511. (org-font-lock-extra-keywords
  5512. (list
  5513. ;; Call the hook
  5514. '(org-font-lock-hook)
  5515. ;; Headlines
  5516. `(,(if org-fontify-whole-heading-line
  5517. "^\\(\\**\\)\\(\\* \\)\\(.*\n?\\)"
  5518. "^\\(\\**\\)\\(\\* \\)\\(.*\\)")
  5519. (1 (org-get-level-face 1))
  5520. (2 (org-get-level-face 2))
  5521. (3 (org-get-level-face 3)))
  5522. ;; Table lines
  5523. '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
  5524. (1 'org-table t))
  5525. ;; Table internals
  5526. '("^[ \t]*|\\(?:.*?|\\)? *\\(:?=[^|\n]*\\)" (1 'org-formula t))
  5527. '("^[ \t]*| *\\([#*]\\) *|" (1 'org-formula t))
  5528. '("^[ \t]*|\\( *\\([$!_^/]\\) *|.*\\)|" (1 'org-formula t))
  5529. '("| *\\(<[lrc]?[0-9]*>\\)" (1 'org-formula t))
  5530. ;; Drawers
  5531. (list org-drawer-regexp '(0 'org-special-keyword t))
  5532. (list "^[ \t]*:END:" '(0 'org-special-keyword t))
  5533. ;; Properties
  5534. (list org-property-re
  5535. '(1 'org-special-keyword t)
  5536. '(3 'org-property-value t))
  5537. ;; Links
  5538. (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
  5539. (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
  5540. (if (memq 'plain lk) '(org-activate-plain-links (0 'org-link t)))
  5541. (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
  5542. (if (memq 'radio lk) '(org-activate-target-links (0 'org-link t)))
  5543. (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
  5544. (if (memq 'footnote lk) '(org-activate-footnote-links))
  5545. ;; Targets.
  5546. (list org-any-target-regexp '(0 'org-target t))
  5547. ;; Diary sexps.
  5548. '("^&?%%(.*\\|<%%([^>\n]*?>" (0 'org-sexp-date t))
  5549. ;; Macro
  5550. '("{{{.+}}}" (0 'org-macro t))
  5551. '(org-hide-wide-columns (0 nil append))
  5552. ;; TODO keyword
  5553. (list (format org-heading-keyword-regexp-format
  5554. org-todo-regexp)
  5555. '(2 (org-get-todo-face 2) t))
  5556. ;; DONE
  5557. (if org-fontify-done-headline
  5558. (list (format org-heading-keyword-regexp-format
  5559. (concat
  5560. "\\(?:"
  5561. (mapconcat 'regexp-quote org-done-keywords "\\|")
  5562. "\\)"))
  5563. '(2 'org-headline-done t))
  5564. nil)
  5565. ;; Priorities
  5566. '(org-font-lock-add-priority-faces)
  5567. ;; Tags
  5568. '(org-font-lock-add-tag-faces)
  5569. ;; Tags groups
  5570. (if (and org-group-tags org-tag-groups-alist)
  5571. (list (concat org-outline-regexp-bol ".+\\(:"
  5572. (regexp-opt (mapcar 'car org-tag-groups-alist))
  5573. ":\\).*$")
  5574. '(1 'org-tag-group prepend)))
  5575. ;; Special keywords
  5576. (list (concat "\\<" org-deadline-string) '(0 'org-special-keyword t))
  5577. (list (concat "\\<" org-scheduled-string) '(0 'org-special-keyword t))
  5578. (list (concat "\\<" org-closed-string) '(0 'org-special-keyword t))
  5579. (list (concat "\\<" org-clock-string) '(0 'org-special-keyword t))
  5580. ;; Emphasis
  5581. (if em
  5582. (if (featurep 'xemacs)
  5583. '(org-do-emphasis-faces (0 nil append))
  5584. '(org-do-emphasis-faces)))
  5585. ;; Checkboxes
  5586. '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
  5587. 1 'org-checkbox prepend)
  5588. (if (cdr (assq 'checkbox org-list-automatic-rules))
  5589. '("\\[\\([0-9]*%\\)\\]\\|\\[\\([0-9]*\\)/\\([0-9]*\\)\\]"
  5590. (0 (org-get-checkbox-statistics-face) t)))
  5591. ;; Description list items
  5592. '("^[ \t]*[-+*][ \t]+\\(.*?[ \t]+::\\)\\([ \t]+\\|$\\)"
  5593. 1 'org-list-dt prepend)
  5594. ;; ARCHIVEd headings
  5595. (list (concat
  5596. org-outline-regexp-bol
  5597. "\\(.*:" org-archive-tag ":.*\\)")
  5598. '(1 'org-archived prepend))
  5599. ;; Specials
  5600. '(org-do-latex-and-related)
  5601. '(org-fontify-entities)
  5602. '(org-raise-scripts)
  5603. ;; Code
  5604. '(org-activate-code (1 'org-code t))
  5605. ;; COMMENT
  5606. (list (format org-heading-keyword-regexp-format
  5607. (concat "\\("
  5608. org-comment-string "\\|" org-quote-string
  5609. "\\)"))
  5610. '(2 'org-special-keyword t))
  5611. ;; Blocks and meta lines
  5612. '(org-fontify-meta-lines-and-blocks))))
  5613. (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
  5614. (run-hooks 'org-font-lock-set-keywords-hook)
  5615. ;; Now set the full font-lock-keywords
  5616. (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
  5617. (org-set-local 'font-lock-defaults
  5618. '(org-font-lock-keywords t nil nil backward-paragraph))
  5619. (kill-local-variable 'font-lock-keywords) nil))
  5620. (defun org-toggle-pretty-entities ()
  5621. "Toggle the composition display of entities as UTF8 characters."
  5622. (interactive)
  5623. (org-set-local 'org-pretty-entities (not org-pretty-entities))
  5624. (org-restart-font-lock)
  5625. (if org-pretty-entities
  5626. (message "Entities are now displayed as UTF8 characters")
  5627. (save-restriction
  5628. (widen)
  5629. (org-decompose-region (point-min) (point-max))
  5630. (message "Entities are now displayed as plain text"))))
  5631. (defvar org-custom-properties-overlays nil
  5632. "List of overlays used for custom properties.")
  5633. (make-variable-buffer-local 'org-custom-properties-overlays)
  5634. (defun org-toggle-custom-properties-visibility ()
  5635. "Display or hide properties in `org-custom-properties'."
  5636. (interactive)
  5637. (if org-custom-properties-overlays
  5638. (progn (mapc 'delete-overlay org-custom-properties-overlays)
  5639. (setq org-custom-properties-overlays nil))
  5640. (unless (not org-custom-properties)
  5641. (save-excursion
  5642. (save-restriction
  5643. (widen)
  5644. (goto-char (point-min))
  5645. (while (re-search-forward org-property-re nil t)
  5646. (mapc (lambda(p)
  5647. (when (equal p (substring (match-string 1) 1 -1))
  5648. (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
  5649. (overlay-put o 'invisible t)
  5650. (overlay-put o 'org-custom-property t)
  5651. (push o org-custom-properties-overlays))))
  5652. org-custom-properties)))))))
  5653. (defun org-fontify-entities (limit)
  5654. "Find an entity to fontify."
  5655. (let (ee)
  5656. (when org-pretty-entities
  5657. (catch 'match
  5658. (while (re-search-forward
  5659. "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]\n]\\)"
  5660. limit t)
  5661. (if (and (not (org-in-indented-comment-line))
  5662. (setq ee (org-entity-get (match-string 1)))
  5663. (= (length (nth 6 ee)) 1))
  5664. (let*
  5665. ((end (if (equal (match-string 2) "{}")
  5666. (match-end 2)
  5667. (match-end 1))))
  5668. (add-text-properties
  5669. (match-beginning 0) end
  5670. (list 'font-lock-fontified t))
  5671. (compose-region (match-beginning 0) end
  5672. (nth 6 ee) nil)
  5673. (backward-char 1)
  5674. (throw 'match t))))
  5675. nil))))
  5676. (defun org-fontify-like-in-org-mode (s &optional odd-levels)
  5677. "Fontify string S like in Org-mode."
  5678. (with-temp-buffer
  5679. (insert s)
  5680. (let ((org-odd-levels-only odd-levels))
  5681. (org-mode)
  5682. (font-lock-fontify-buffer)
  5683. (buffer-string))))
  5684. (defvar org-m nil)
  5685. (defvar org-l nil)
  5686. (defvar org-f nil)
  5687. (defun org-get-level-face (n)
  5688. "Get the right face for match N in font-lock matching of headlines."
  5689. (setq org-l (- (match-end 2) (match-beginning 1) 1))
  5690. (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
  5691. (if org-cycle-level-faces
  5692. (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
  5693. (setq org-f (nth (1- (min org-l org-n-level-faces)) org-level-faces)))
  5694. (cond
  5695. ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
  5696. ((eq n 2) org-f)
  5697. (t (if org-level-color-stars-only nil org-f))))
  5698. (defun org-get-todo-face (kwd)
  5699. "Get the right face for a TODO keyword KWD.
  5700. If KWD is a number, get the corresponding match group."
  5701. (if (numberp kwd) (setq kwd (match-string kwd)))
  5702. (or (org-face-from-face-or-color
  5703. 'todo 'org-todo (cdr (assoc kwd org-todo-keyword-faces)))
  5704. (and (member kwd org-done-keywords) 'org-done)
  5705. 'org-todo))
  5706. (defun org-face-from-face-or-color (context inherit face-or-color)
  5707. "Create a face list that inherits INHERIT, but sets the foreground color.
  5708. When FACE-OR-COLOR is not a string, just return it."
  5709. (if (stringp face-or-color)
  5710. (list :inherit inherit
  5711. (cdr (assoc context org-faces-easy-properties))
  5712. face-or-color)
  5713. face-or-color))
  5714. (defun org-font-lock-add-tag-faces (limit)
  5715. "Add the special tag faces."
  5716. (when (and org-tag-faces org-tags-special-faces-re)
  5717. (while (re-search-forward org-tags-special-faces-re limit t)
  5718. (add-text-properties (match-beginning 1) (match-end 1)
  5719. (list 'face (org-get-tag-face 1)
  5720. 'font-lock-fontified t))
  5721. (backward-char 1))))
  5722. (defun org-font-lock-add-priority-faces (limit)
  5723. "Add the special priority faces."
  5724. (while (re-search-forward "\\[#\\([A-Z0-9]\\)\\]" limit t)
  5725. (when (save-match-data (org-at-heading-p))
  5726. (add-text-properties
  5727. (match-beginning 0) (match-end 0)
  5728. (list 'face (or (org-face-from-face-or-color
  5729. 'priority 'org-priority
  5730. (cdr (assoc (char-after (match-beginning 1))
  5731. org-priority-faces)))
  5732. 'org-priority)
  5733. 'font-lock-fontified t)))))
  5734. (defun org-get-tag-face (kwd)
  5735. "Get the right face for a TODO keyword KWD.
  5736. If KWD is a number, get the corresponding match group."
  5737. (if (numberp kwd) (setq kwd (match-string kwd)))
  5738. (or (org-face-from-face-or-color
  5739. 'tag 'org-tag (cdr (assoc kwd org-tag-faces)))
  5740. 'org-tag))
  5741. (defun org-unfontify-region (beg end &optional maybe_loudly)
  5742. "Remove fontification and activation overlays from links."
  5743. (font-lock-default-unfontify-region beg end)
  5744. (let* ((buffer-undo-list t)
  5745. (inhibit-read-only t) (inhibit-point-motion-hooks t)
  5746. (inhibit-modification-hooks t)
  5747. deactivate-mark buffer-file-name buffer-file-truename)
  5748. (org-decompose-region beg end)
  5749. (remove-text-properties beg end
  5750. '(mouse-face t keymap t org-linked-text t
  5751. invisible t intangible t
  5752. org-no-flyspell t org-emphasis t))
  5753. (org-remove-font-lock-display-properties beg end)))
  5754. (defconst org-script-display '(((raise -0.3) (height 0.7))
  5755. ((raise 0.3) (height 0.7))
  5756. ((raise -0.5))
  5757. ((raise 0.5)))
  5758. "Display properties for showing superscripts and subscripts.")
  5759. (defun org-remove-font-lock-display-properties (beg end)
  5760. "Remove specific display properties that have been added by font lock.
  5761. The will remove the raise properties that are used to show superscripts
  5762. and subscripts."
  5763. (let (next prop)
  5764. (while (< beg end)
  5765. (setq next (next-single-property-change beg 'display nil end)
  5766. prop (get-text-property beg 'display))
  5767. (if (member prop org-script-display)
  5768. (put-text-property beg next 'display nil))
  5769. (setq beg next))))
  5770. (defun org-raise-scripts (limit)
  5771. "Add raise properties to sub/superscripts."
  5772. (when (and org-pretty-entities org-pretty-entities-include-sub-superscripts)
  5773. (if (re-search-forward
  5774. (if (eq org-use-sub-superscripts t)
  5775. org-match-substring-regexp
  5776. org-match-substring-with-braces-regexp)
  5777. limit t)
  5778. (let* ((pos (point)) table-p comment-p
  5779. (mpos (match-beginning 3))
  5780. (emph-p (get-text-property mpos 'org-emphasis))
  5781. (link-p (get-text-property mpos 'mouse-face))
  5782. (keyw-p (eq 'org-special-keyword (get-text-property mpos 'face))))
  5783. (goto-char (point-at-bol))
  5784. (setq table-p (org-looking-at-p org-table-dataline-regexp)
  5785. comment-p (org-looking-at-p "^[ \t]*#[ +]"))
  5786. (goto-char pos)
  5787. ;; Handle a_b^c
  5788. (if (member (char-after) '(?_ ?^)) (goto-char (1- pos)))
  5789. (if (or comment-p emph-p link-p keyw-p)
  5790. t
  5791. (put-text-property (match-beginning 3) (match-end 0)
  5792. 'display
  5793. (if (equal (char-after (match-beginning 2)) ?^)
  5794. (nth (if table-p 3 1) org-script-display)
  5795. (nth (if table-p 2 0) org-script-display)))
  5796. (add-text-properties (match-beginning 2) (match-end 2)
  5797. (list 'invisible t
  5798. 'org-dwidth t 'org-dwidth-n 1))
  5799. (if (and (eq (char-after (match-beginning 3)) ?{)
  5800. (eq (char-before (match-end 3)) ?}))
  5801. (progn
  5802. (add-text-properties
  5803. (match-beginning 3) (1+ (match-beginning 3))
  5804. (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))
  5805. (add-text-properties
  5806. (1- (match-end 3)) (match-end 3)
  5807. (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))))
  5808. t)))))
  5809. ;;;; Visibility cycling, including org-goto and indirect buffer
  5810. ;;; Cycling
  5811. (defvar org-cycle-global-status nil)
  5812. (make-variable-buffer-local 'org-cycle-global-status)
  5813. (put 'org-cycle-global-status 'org-state t)
  5814. (defvar org-cycle-subtree-status nil)
  5815. (make-variable-buffer-local 'org-cycle-subtree-status)
  5816. (put 'org-cycle-subtree-status 'org-state t)
  5817. (defvar org-inlinetask-min-level)
  5818. (defun org-unlogged-message (&rest args)
  5819. "Display a message, but avoid logging it in the *Messages* buffer."
  5820. (let ((message-log-max nil))
  5821. (apply 'message args)))
  5822. ;;;###autoload
  5823. (defun org-cycle (&optional arg)
  5824. "TAB-action and visibility cycling for Org-mode.
  5825. This is the command invoked in Org-mode by the TAB key. Its main purpose
  5826. is outline visibility cycling, but it also invokes other actions
  5827. in special contexts.
  5828. - When this function is called with a prefix argument, rotate the entire
  5829. buffer through 3 states (global cycling)
  5830. 1. OVERVIEW: Show only top-level headlines.
  5831. 2. CONTENTS: Show all headlines of all levels, but no body text.
  5832. 3. SHOW ALL: Show everything.
  5833. When called with two `C-u C-u' prefixes, switch to the startup visibility,
  5834. determined by the variable `org-startup-folded', and by any VISIBILITY
  5835. properties in the buffer.
  5836. When called with three `C-u C-u C-u' prefixed, show the entire buffer,
  5837. including any drawers.
  5838. - When inside a table, re-align the table and move to the next field.
  5839. - When point is at the beginning of a headline, rotate the subtree started
  5840. by this line through 3 different states (local cycling)
  5841. 1. FOLDED: Only the main headline is shown.
  5842. 2. CHILDREN: The main headline and the direct children are shown.
  5843. From this state, you can move to one of the children
  5844. and zoom in further.
  5845. 3. SUBTREE: Show the entire subtree, including body text.
  5846. If there is no subtree, switch directly from CHILDREN to FOLDED.
  5847. - When point is at the beginning of an empty headline and the variable
  5848. `org-cycle-level-after-item/entry-creation' is set, cycle the level
  5849. of the headline by demoting and promoting it to likely levels. This
  5850. speeds up creation document structure by pressing TAB once or several
  5851. times right after creating a new headline.
  5852. - When there is a numeric prefix, go up to a heading with level ARG, do
  5853. a `show-subtree' and return to the previous cursor position. If ARG
  5854. is negative, go up that many levels.
  5855. - When point is not at the beginning of a headline, execute the global
  5856. binding for TAB, which is re-indenting the line. See the option
  5857. `org-cycle-emulate-tab' for details.
  5858. - Special case: if point is at the beginning of the buffer and there is
  5859. no headline in line 1, this function will act as if called with prefix arg
  5860. (C-u TAB, same as S-TAB) also when called without prefix arg.
  5861. But only if also the variable `org-cycle-global-at-bob' is t."
  5862. (interactive "P")
  5863. (org-load-modules-maybe)
  5864. (unless (or (run-hook-with-args-until-success 'org-tab-first-hook)
  5865. (and org-cycle-level-after-item/entry-creation
  5866. (or (org-cycle-level)
  5867. (org-cycle-item-indentation))))
  5868. (let* ((limit-level
  5869. (or org-cycle-max-level
  5870. (and (boundp 'org-inlinetask-min-level)
  5871. org-inlinetask-min-level
  5872. (1- org-inlinetask-min-level))))
  5873. (nstars (and limit-level
  5874. (if org-odd-levels-only
  5875. (and limit-level (1- (* limit-level 2)))
  5876. limit-level)))
  5877. (org-outline-regexp
  5878. (if (not (derived-mode-p 'org-mode))
  5879. outline-regexp
  5880. (concat "\\*" (if nstars (format "\\{1,%d\\} " nstars) "+ "))))
  5881. (bob-special (and org-cycle-global-at-bob (not arg) (bobp)
  5882. (not (looking-at org-outline-regexp))))
  5883. (org-cycle-hook
  5884. (if bob-special
  5885. (delq 'org-optimize-window-after-visibility-change
  5886. (copy-sequence org-cycle-hook))
  5887. org-cycle-hook))
  5888. (pos (point)))
  5889. (if (or bob-special (equal arg '(4)))
  5890. ;; special case: use global cycling
  5891. (setq arg t))
  5892. (cond
  5893. ((equal arg '(16))
  5894. (setq last-command 'dummy)
  5895. (org-set-startup-visibility)
  5896. (org-unlogged-message "Startup visibility, plus VISIBILITY properties"))
  5897. ((equal arg '(64))
  5898. (show-all)
  5899. (org-unlogged-message "Entire buffer visible, including drawers"))
  5900. ;; Table: enter it or move to the next field.
  5901. ((org-at-table-p 'any)
  5902. (if (org-at-table.el-p)
  5903. (message "Use C-c ' to edit table.el tables")
  5904. (if arg (org-table-edit-field t)
  5905. (org-table-justify-field-maybe)
  5906. (call-interactively 'org-table-next-field))))
  5907. ((run-hook-with-args-until-success
  5908. 'org-tab-after-check-for-table-hook))
  5909. ;; Global cycling: delegate to `org-cycle-internal-global'.
  5910. ((eq arg t) (org-cycle-internal-global))
  5911. ;; Drawers: delegate to `org-flag-drawer'.
  5912. ((and org-drawers org-drawer-regexp
  5913. (save-excursion
  5914. (beginning-of-line 1)
  5915. (looking-at org-drawer-regexp)))
  5916. (org-flag-drawer ; toggle block visibility
  5917. (not (get-char-property (match-end 0) 'invisible))))
  5918. ;; Show-subtree, ARG levels up from here.
  5919. ((integerp arg)
  5920. (save-excursion
  5921. (org-back-to-heading)
  5922. (outline-up-heading (if (< arg 0) (- arg)
  5923. (- (funcall outline-level) arg)))
  5924. (org-show-subtree)))
  5925. ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
  5926. ((and (featurep 'org-inlinetask)
  5927. (org-inlinetask-at-task-p)
  5928. (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
  5929. (org-inlinetask-toggle-visibility))
  5930. ((org-try-cdlatex-tab))
  5931. ;; At an item/headline: delegate to `org-cycle-internal-local'.
  5932. ((and (or (and org-cycle-include-plain-lists (org-at-item-p))
  5933. (save-excursion (beginning-of-line 1)
  5934. (looking-at org-outline-regexp)))
  5935. (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
  5936. (org-cycle-internal-local))
  5937. ;; From there: TAB emulation and template completion.
  5938. (buffer-read-only (org-back-to-heading))
  5939. ((run-hook-with-args-until-success
  5940. 'org-tab-after-check-for-cycling-hook))
  5941. ((org-try-structure-completion))
  5942. ((run-hook-with-args-until-success
  5943. 'org-tab-before-tab-emulation-hook))
  5944. ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
  5945. (or (not (bolp))
  5946. (not (looking-at org-outline-regexp))))
  5947. (call-interactively (global-key-binding "\t")))
  5948. ((if (and (memq org-cycle-emulate-tab '(white whitestart))
  5949. (save-excursion (beginning-of-line 1) (looking-at "[ \t]*"))
  5950. (or (and (eq org-cycle-emulate-tab 'white)
  5951. (= (match-end 0) (point-at-eol)))
  5952. (and (eq org-cycle-emulate-tab 'whitestart)
  5953. (>= (match-end 0) pos))))
  5954. t
  5955. (eq org-cycle-emulate-tab t))
  5956. (call-interactively (global-key-binding "\t")))
  5957. (t (save-excursion
  5958. (org-back-to-heading)
  5959. (org-cycle)))))))
  5960. (defun org-cycle-internal-global ()
  5961. "Do the global cycling action."
  5962. ;; Hack to avoid display of messages for .org attachments in Gnus
  5963. (let ((ga (string-match "\\*fontification" (buffer-name))))
  5964. (cond
  5965. ((and (eq last-command this-command)
  5966. (eq org-cycle-global-status 'overview))
  5967. ;; We just created the overview - now do table of contents
  5968. ;; This can be slow in very large buffers, so indicate action
  5969. (run-hook-with-args 'org-pre-cycle-hook 'contents)
  5970. (unless ga (org-unlogged-message "CONTENTS..."))
  5971. (org-content)
  5972. (unless ga (org-unlogged-message "CONTENTS...done"))
  5973. (setq org-cycle-global-status 'contents)
  5974. (run-hook-with-args 'org-cycle-hook 'contents))
  5975. ((and (eq last-command this-command)
  5976. (eq org-cycle-global-status 'contents))
  5977. ;; We just showed the table of contents - now show everything
  5978. (run-hook-with-args 'org-pre-cycle-hook 'all)
  5979. (show-all)
  5980. (unless ga (org-unlogged-message "SHOW ALL"))
  5981. (setq org-cycle-global-status 'all)
  5982. (run-hook-with-args 'org-cycle-hook 'all))
  5983. (t
  5984. ;; Default action: go to overview
  5985. (run-hook-with-args 'org-pre-cycle-hook 'overview)
  5986. (org-overview)
  5987. (unless ga (org-unlogged-message "OVERVIEW"))
  5988. (setq org-cycle-global-status 'overview)
  5989. (run-hook-with-args 'org-cycle-hook 'overview)))))
  5990. (defun org-cycle-internal-local ()
  5991. "Do the local cycling action."
  5992. (let ((goal-column 0) eoh eol eos has-children children-skipped struct)
  5993. ;; First, determine end of headline (EOH), end of subtree or item
  5994. ;; (EOS), and if item or heading has children (HAS-CHILDREN).
  5995. (save-excursion
  5996. (if (org-at-item-p)
  5997. (progn
  5998. (beginning-of-line)
  5999. (setq struct (org-list-struct))
  6000. (setq eoh (point-at-eol))
  6001. (setq eos (org-list-get-item-end-before-blank (point) struct))
  6002. (setq has-children (org-list-has-child-p (point) struct)))
  6003. (org-back-to-heading)
  6004. (setq eoh (save-excursion (outline-end-of-heading) (point)))
  6005. (setq eos (save-excursion (1- (org-end-of-subtree t t))))
  6006. (setq has-children
  6007. (or (save-excursion
  6008. (let ((level (funcall outline-level)))
  6009. (outline-next-heading)
  6010. (and (org-at-heading-p t)
  6011. (> (funcall outline-level) level))))
  6012. (save-excursion
  6013. (org-list-search-forward (org-item-beginning-re) eos t)))))
  6014. ;; Determine end invisible part of buffer (EOL)
  6015. (beginning-of-line 2)
  6016. ;; XEmacs doesn't have `next-single-char-property-change'
  6017. (if (featurep 'xemacs)
  6018. (while (and (not (eobp)) ;; this is like `next-line'
  6019. (get-char-property (1- (point)) 'invisible))
  6020. (beginning-of-line 2))
  6021. (while (and (not (eobp)) ;; this is like `next-line'
  6022. (get-char-property (1- (point)) 'invisible))
  6023. (goto-char (next-single-char-property-change (point) 'invisible))
  6024. (and (eolp) (beginning-of-line 2))))
  6025. (setq eol (point)))
  6026. ;; Find out what to do next and set `this-command'
  6027. (cond
  6028. ((= eos eoh)
  6029. ;; Nothing is hidden behind this heading
  6030. (unless (org-before-first-heading-p)
  6031. (run-hook-with-args 'org-pre-cycle-hook 'empty))
  6032. (org-unlogged-message "EMPTY ENTRY")
  6033. (setq org-cycle-subtree-status nil)
  6034. (save-excursion
  6035. (goto-char eos)
  6036. (outline-next-heading)
  6037. (if (outline-invisible-p) (org-flag-heading nil))))
  6038. ((and (or (>= eol eos)
  6039. (not (string-match "\\S-" (buffer-substring eol eos))))
  6040. (or has-children
  6041. (not (setq children-skipped
  6042. org-cycle-skip-children-state-if-no-children))))
  6043. ;; Entire subtree is hidden in one line: children view
  6044. (unless (org-before-first-heading-p)
  6045. (run-hook-with-args 'org-pre-cycle-hook 'children))
  6046. (if (org-at-item-p)
  6047. (org-list-set-item-visibility (point-at-bol) struct 'children)
  6048. (org-show-entry)
  6049. (org-with-limited-levels (show-children))
  6050. ;; FIXME: This slows down the func way too much.
  6051. ;; How keep drawers hidden in subtree anyway?
  6052. ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
  6053. ;; (org-cycle-hide-drawers 'subtree))
  6054. ;; Fold every list in subtree to top-level items.
  6055. (when (eq org-cycle-include-plain-lists 'integrate)
  6056. (save-excursion
  6057. (org-back-to-heading)
  6058. (while (org-list-search-forward (org-item-beginning-re) eos t)
  6059. (beginning-of-line 1)
  6060. (let* ((struct (org-list-struct))
  6061. (prevs (org-list-prevs-alist struct))
  6062. (end (org-list-get-bottom-point struct)))
  6063. (mapc (lambda (e) (org-list-set-item-visibility e struct 'folded))
  6064. (org-list-get-all-items (point) struct prevs))
  6065. (goto-char (if (< end eos) end eos)))))))
  6066. (org-unlogged-message "CHILDREN")
  6067. (save-excursion
  6068. (goto-char eos)
  6069. (outline-next-heading)
  6070. (if (outline-invisible-p) (org-flag-heading nil)))
  6071. (setq org-cycle-subtree-status 'children)
  6072. (unless (org-before-first-heading-p)
  6073. (run-hook-with-args 'org-cycle-hook 'children)))
  6074. ((or children-skipped
  6075. (and (eq last-command this-command)
  6076. (eq org-cycle-subtree-status 'children)))
  6077. ;; We just showed the children, or no children are there,
  6078. ;; now show everything.
  6079. (unless (org-before-first-heading-p)
  6080. (run-hook-with-args 'org-pre-cycle-hook 'subtree))
  6081. (outline-flag-region eoh eos nil)
  6082. (org-unlogged-message
  6083. (if children-skipped "SUBTREE (NO CHILDREN)" "SUBTREE"))
  6084. (setq org-cycle-subtree-status 'subtree)
  6085. (unless (org-before-first-heading-p)
  6086. (run-hook-with-args 'org-cycle-hook 'subtree)))
  6087. (t
  6088. ;; Default action: hide the subtree.
  6089. (run-hook-with-args 'org-pre-cycle-hook 'folded)
  6090. (outline-flag-region eoh eos t)
  6091. (org-unlogged-message "FOLDED")
  6092. (setq org-cycle-subtree-status 'folded)
  6093. (unless (org-before-first-heading-p)
  6094. (run-hook-with-args 'org-cycle-hook 'folded))))))
  6095. ;;;###autoload
  6096. (defun org-global-cycle (&optional arg)
  6097. "Cycle the global visibility. For details see `org-cycle'.
  6098. With \\[universal-argument] prefix arg, switch to startup visibility.
  6099. With a numeric prefix, show all headlines up to that level."
  6100. (interactive "P")
  6101. (let ((org-cycle-include-plain-lists
  6102. (if (derived-mode-p 'org-mode) org-cycle-include-plain-lists nil)))
  6103. (cond
  6104. ((integerp arg)
  6105. (show-all)
  6106. (hide-sublevels arg)
  6107. (setq org-cycle-global-status 'contents))
  6108. ((equal arg '(4))
  6109. (org-set-startup-visibility)
  6110. (org-unlogged-message "Startup visibility, plus VISIBILITY properties."))
  6111. (t
  6112. (org-cycle '(4))))))
  6113. (defun org-set-startup-visibility ()
  6114. "Set the visibility required by startup options and properties."
  6115. (cond
  6116. ((eq org-startup-folded t)
  6117. (org-cycle '(4)))
  6118. ((eq org-startup-folded 'content)
  6119. (let ((this-command 'org-cycle) (last-command 'org-cycle))
  6120. (org-cycle '(4)) (org-cycle '(4)))))
  6121. (unless (eq org-startup-folded 'showeverything)
  6122. (if org-hide-block-startup (org-hide-block-all))
  6123. (org-set-visibility-according-to-property 'no-cleanup)
  6124. (org-cycle-hide-archived-subtrees 'all)
  6125. (org-cycle-hide-drawers 'all)
  6126. (org-cycle-show-empty-lines t)))
  6127. (defun org-set-visibility-according-to-property (&optional no-cleanup)
  6128. "Switch subtree visibilities according to :VISIBILITY: property."
  6129. (interactive)
  6130. (let (org-show-entry-below state)
  6131. (save-excursion
  6132. (goto-char (point-min))
  6133. (while (re-search-forward
  6134. "^[ \t]*:VISIBILITY:[ \t]+\\([a-z]+\\)"
  6135. nil t)
  6136. (setq state (match-string 1))
  6137. (save-excursion
  6138. (org-back-to-heading t)
  6139. (hide-subtree)
  6140. (org-reveal)
  6141. (cond
  6142. ((equal state '("fold" "folded"))
  6143. (hide-subtree))
  6144. ((equal state "children")
  6145. (org-show-hidden-entry)
  6146. (show-children))
  6147. ((equal state "content")
  6148. (save-excursion
  6149. (save-restriction
  6150. (org-narrow-to-subtree)
  6151. (org-content))))
  6152. ((member state '("all" "showall"))
  6153. (show-subtree)))))
  6154. (unless no-cleanup
  6155. (org-cycle-hide-archived-subtrees 'all)
  6156. (org-cycle-hide-drawers 'all)
  6157. (org-cycle-show-empty-lines 'all)))))
  6158. ;; This function uses outline-regexp instead of the more fundamental
  6159. ;; org-outline-regexp so that org-cycle-global works outside of Org
  6160. ;; buffers, where outline-regexp is needed.
  6161. (defun org-overview ()
  6162. "Switch to overview mode, showing only top-level headlines.
  6163. Really, this shows all headlines with level equal or greater than the level
  6164. of the first headline in the buffer. This is important, because if the
  6165. first headline is not level one, then (hide-sublevels 1) gives confusing
  6166. results."
  6167. (interactive)
  6168. (let ((pos (point))
  6169. (level (save-excursion
  6170. (goto-char (point-min))
  6171. (if (re-search-forward (concat "^" outline-regexp) nil t)
  6172. (progn
  6173. (goto-char (match-beginning 0))
  6174. (funcall outline-level))))))
  6175. (and level (hide-sublevels level))
  6176. (recenter '(4))
  6177. (goto-char pos)))
  6178. (defun org-content (&optional arg)
  6179. "Show all headlines in the buffer, like a table of contents.
  6180. With numerical argument N, show content up to level N."
  6181. (interactive "P")
  6182. (save-excursion
  6183. ;; Visit all headings and show their offspring
  6184. (and (integerp arg) (org-overview))
  6185. (goto-char (point-max))
  6186. (catch 'exit
  6187. (while (and (progn (condition-case nil
  6188. (outline-previous-visible-heading 1)
  6189. (error (goto-char (point-min))))
  6190. t)
  6191. (looking-at org-outline-regexp))
  6192. (if (integerp arg)
  6193. (show-children (1- arg))
  6194. (show-branches))
  6195. (if (bobp) (throw 'exit nil))))))
  6196. (defun org-optimize-window-after-visibility-change (state)
  6197. "Adjust the window after a change in outline visibility.
  6198. This function is the default value of the hook `org-cycle-hook'."
  6199. (when (get-buffer-window (current-buffer))
  6200. (cond
  6201. ((eq state 'content) nil)
  6202. ((eq state 'all) nil)
  6203. ((eq state 'folded) nil)
  6204. ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
  6205. ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
  6206. (defun org-remove-empty-overlays-at (pos)
  6207. "Remove outline overlays that do not contain non-white stuff."
  6208. (mapc
  6209. (lambda (o)
  6210. (and (eq 'outline (overlay-get o 'invisible))
  6211. (not (string-match "\\S-" (buffer-substring (overlay-start o)
  6212. (overlay-end o))))
  6213. (delete-overlay o)))
  6214. (overlays-at pos)))
  6215. (defun org-clean-visibility-after-subtree-move ()
  6216. "Fix visibility issues after moving a subtree."
  6217. ;; First, find a reasonable region to look at:
  6218. ;; Start two siblings above, end three below
  6219. (let* ((beg (save-excursion
  6220. (and (org-get-last-sibling)
  6221. (org-get-last-sibling))
  6222. (point)))
  6223. (end (save-excursion
  6224. (and (org-get-next-sibling)
  6225. (org-get-next-sibling)
  6226. (org-get-next-sibling))
  6227. (if (org-at-heading-p)
  6228. (point-at-eol)
  6229. (point))))
  6230. (level (looking-at "\\*+"))
  6231. (re (if level (concat "^" (regexp-quote (match-string 0)) " "))))
  6232. (save-excursion
  6233. (save-restriction
  6234. (narrow-to-region beg end)
  6235. (when re
  6236. ;; Properly fold already folded siblings
  6237. (goto-char (point-min))
  6238. (while (re-search-forward re nil t)
  6239. (if (and (not (outline-invisible-p))
  6240. (save-excursion
  6241. (goto-char (point-at-eol)) (outline-invisible-p)))
  6242. (hide-entry))))
  6243. (org-cycle-show-empty-lines 'overview)
  6244. (org-cycle-hide-drawers 'overview)))))
  6245. (defun org-cycle-show-empty-lines (state)
  6246. "Show empty lines above all visible headlines.
  6247. The region to be covered depends on STATE when called through
  6248. `org-cycle-hook'. Lisp program can use t for STATE to get the
  6249. entire buffer covered. Note that an empty line is only shown if there
  6250. are at least `org-cycle-separator-lines' empty lines before the headline."
  6251. (when (not (= org-cycle-separator-lines 0))
  6252. (save-excursion
  6253. (let* ((n (abs org-cycle-separator-lines))
  6254. (re (cond
  6255. ((= n 1) "\\(\n[ \t]*\n\\*+\\) ")
  6256. ((= n 2) "^[ \t]*\\(\n[ \t]*\n\\*+\\) ")
  6257. (t (let ((ns (number-to-string (- n 2))))
  6258. (concat "^\\(?:[ \t]*\n\\)\\{" ns "," ns "\\}"
  6259. "[ \t]*\\(\n[ \t]*\n\\*+\\) ")))))
  6260. beg end b e)
  6261. (cond
  6262. ((memq state '(overview contents t))
  6263. (setq beg (point-min) end (point-max)))
  6264. ((memq state '(children folded))
  6265. (setq beg (point) end (progn (org-end-of-subtree t t)
  6266. (beginning-of-line 2)
  6267. (point)))))
  6268. (when beg
  6269. (goto-char beg)
  6270. (while (re-search-forward re end t)
  6271. (unless (get-char-property (match-end 1) 'invisible)
  6272. (setq e (match-end 1))
  6273. (if (< org-cycle-separator-lines 0)
  6274. (setq b (save-excursion
  6275. (goto-char (match-beginning 0))
  6276. (org-back-over-empty-lines)
  6277. (if (save-excursion
  6278. (goto-char (max (point-min) (1- (point))))
  6279. (org-at-heading-p))
  6280. (1- (point))
  6281. (point))))
  6282. (setq b (match-beginning 1)))
  6283. (outline-flag-region b e nil)))))))
  6284. ;; Never hide empty lines at the end of the file.
  6285. (save-excursion
  6286. (goto-char (point-max))
  6287. (outline-previous-heading)
  6288. (outline-end-of-heading)
  6289. (if (and (looking-at "[ \t\n]+")
  6290. (= (match-end 0) (point-max)))
  6291. (outline-flag-region (point) (match-end 0) nil))))
  6292. (defun org-show-empty-lines-in-parent ()
  6293. "Move to the parent and re-show empty lines before visible headlines."
  6294. (save-excursion
  6295. (let ((context (if (org-up-heading-safe) 'children 'overview)))
  6296. (org-cycle-show-empty-lines context))))
  6297. (defun org-files-list ()
  6298. "Return `org-agenda-files' list, plus all open org-mode files.
  6299. This is useful for operations that need to scan all of a user's
  6300. open and agenda-wise Org files."
  6301. (let ((files (mapcar 'expand-file-name (org-agenda-files))))
  6302. (dolist (buf (buffer-list))
  6303. (with-current-buffer buf
  6304. (if (and (derived-mode-p 'org-mode) (buffer-file-name))
  6305. (let ((file (expand-file-name (buffer-file-name))))
  6306. (unless (member file files)
  6307. (push file files))))))
  6308. files))
  6309. (defsubst org-entry-beginning-position ()
  6310. "Return the beginning position of the current entry."
  6311. (save-excursion (outline-back-to-heading t) (point)))
  6312. (defsubst org-entry-end-position ()
  6313. "Return the end position of the current entry."
  6314. (save-excursion (outline-next-heading) (point)))
  6315. (defun org-cycle-hide-drawers (state)
  6316. "Re-hide all drawers after a visibility state change."
  6317. (when (and (derived-mode-p 'org-mode)
  6318. (not (memq state '(overview folded contents))))
  6319. (save-excursion
  6320. (let* ((globalp (memq state '(contents all)))
  6321. (beg (if globalp (point-min) (point)))
  6322. (end (if globalp (point-max)
  6323. (if (eq state 'children)
  6324. (save-excursion (outline-next-heading) (point))
  6325. (org-end-of-subtree t)))))
  6326. (goto-char beg)
  6327. (while (re-search-forward org-drawer-regexp end t)
  6328. (org-flag-drawer t))))))
  6329. (defun org-cycle-hide-inline-tasks (state)
  6330. "Re-hide inline task when switching to 'contents visibility state."
  6331. (when (and (eq state 'contents)
  6332. (boundp 'org-inlinetask-min-level)
  6333. org-inlinetask-min-level)
  6334. (hide-sublevels (1- org-inlinetask-min-level))))
  6335. (defun org-flag-drawer (flag)
  6336. "When FLAG is non-nil, hide the drawer we are within.
  6337. Otherwise make it visible."
  6338. (save-excursion
  6339. (beginning-of-line 1)
  6340. (when (looking-at "^[ \t]*:[a-zA-Z][a-zA-Z0-9]*:")
  6341. (let ((b (match-end 0)))
  6342. (if (re-search-forward
  6343. "^[ \t]*:END:"
  6344. (save-excursion (outline-next-heading) (point)) t)
  6345. (outline-flag-region b (point-at-eol) flag)
  6346. (user-error ":END: line missing at position %s" b))))))
  6347. (defun org-subtree-end-visible-p ()
  6348. "Is the end of the current subtree visible?"
  6349. (pos-visible-in-window-p
  6350. (save-excursion (org-end-of-subtree t) (point))))
  6351. (defun org-first-headline-recenter (&optional N)
  6352. "Move cursor to the first headline and recenter the headline.
  6353. Optional argument N means put the headline into the Nth line of the window."
  6354. (goto-char (point-min))
  6355. (when (re-search-forward (concat "^\\(" org-outline-regexp "\\)") nil t)
  6356. (beginning-of-line)
  6357. (recenter (prefix-numeric-value N))))
  6358. ;;; Saving and restoring visibility
  6359. (defun org-outline-overlay-data (&optional use-markers)
  6360. "Return a list of the locations of all outline overlays.
  6361. These are overlays with the `invisible' property value `outline'.
  6362. The return value is a list of cons cells, with start and stop
  6363. positions for each overlay.
  6364. If USE-MARKERS is set, return the positions as markers."
  6365. (let (beg end)
  6366. (save-excursion
  6367. (save-restriction
  6368. (widen)
  6369. (delq nil
  6370. (mapcar (lambda (o)
  6371. (when (eq (overlay-get o 'invisible) 'outline)
  6372. (setq beg (overlay-start o)
  6373. end (overlay-end o))
  6374. (and beg end (> end beg)
  6375. (if use-markers
  6376. (cons (move-marker (make-marker) beg)
  6377. (move-marker (make-marker) end))
  6378. (cons beg end)))))
  6379. (overlays-in (point-min) (point-max))))))))
  6380. (defun org-set-outline-overlay-data (data)
  6381. "Create visibility overlays for all positions in DATA.
  6382. DATA should have been made by `org-outline-overlay-data'."
  6383. (let (o)
  6384. (save-excursion
  6385. (save-restriction
  6386. (widen)
  6387. (show-all)
  6388. (mapc (lambda (c)
  6389. (outline-flag-region (car c) (cdr c) t))
  6390. data)))))
  6391. ;;; Folding of blocks
  6392. (defvar org-hide-block-overlays nil
  6393. "Overlays hiding blocks.")
  6394. (make-variable-buffer-local 'org-hide-block-overlays)
  6395. (defun org-block-map (function &optional start end)
  6396. "Call FUNCTION at the head of all source blocks in the current buffer.
  6397. Optional arguments START and END can be used to limit the range."
  6398. (let ((start (or start (point-min)))
  6399. (end (or end (point-max))))
  6400. (save-excursion
  6401. (goto-char start)
  6402. (while (and (< (point) end) (re-search-forward org-block-regexp end t))
  6403. (save-excursion
  6404. (save-match-data
  6405. (goto-char (match-beginning 0))
  6406. (funcall function)))))))
  6407. (defun org-hide-block-toggle-all ()
  6408. "Toggle the visibility of all blocks in the current buffer."
  6409. (org-block-map #'org-hide-block-toggle))
  6410. (defun org-hide-block-all ()
  6411. "Fold all blocks in the current buffer."
  6412. (interactive)
  6413. (org-show-block-all)
  6414. (org-block-map #'org-hide-block-toggle-maybe))
  6415. (defun org-show-block-all ()
  6416. "Unfold all blocks in the current buffer."
  6417. (interactive)
  6418. (mapc 'delete-overlay org-hide-block-overlays)
  6419. (setq org-hide-block-overlays nil))
  6420. (defun org-hide-block-toggle-maybe ()
  6421. "Toggle visibility of block at point."
  6422. (interactive)
  6423. (let ((case-fold-search t))
  6424. (if (save-excursion
  6425. (beginning-of-line 1)
  6426. (looking-at org-block-regexp))
  6427. (progn (org-hide-block-toggle)
  6428. t) ;; to signal that we took action
  6429. nil))) ;; to signal that we did not
  6430. (defun org-hide-block-toggle (&optional force)
  6431. "Toggle the visibility of the current block."
  6432. (interactive)
  6433. (save-excursion
  6434. (beginning-of-line)
  6435. (if (re-search-forward org-block-regexp nil t)
  6436. (let ((start (- (match-beginning 4) 1)) ;; beginning of body
  6437. (end (match-end 0)) ;; end of entire body
  6438. ov)
  6439. (if (memq t (mapcar (lambda (overlay)
  6440. (eq (overlay-get overlay 'invisible)
  6441. 'org-hide-block))
  6442. (overlays-at start)))
  6443. (if (or (not force) (eq force 'off))
  6444. (mapc (lambda (ov)
  6445. (when (member ov org-hide-block-overlays)
  6446. (setq org-hide-block-overlays
  6447. (delq ov org-hide-block-overlays)))
  6448. (when (eq (overlay-get ov 'invisible)
  6449. 'org-hide-block)
  6450. (delete-overlay ov)))
  6451. (overlays-at start)))
  6452. (setq ov (make-overlay start end))
  6453. (overlay-put ov 'invisible 'org-hide-block)
  6454. ;; make the block accessible to isearch
  6455. (overlay-put
  6456. ov 'isearch-open-invisible
  6457. (lambda (ov)
  6458. (when (member ov org-hide-block-overlays)
  6459. (setq org-hide-block-overlays
  6460. (delq ov org-hide-block-overlays)))
  6461. (when (eq (overlay-get ov 'invisible)
  6462. 'org-hide-block)
  6463. (delete-overlay ov))))
  6464. (push ov org-hide-block-overlays)))
  6465. (user-error "Not looking at a source block"))))
  6466. ;; org-tab-after-check-for-cycling-hook
  6467. (add-hook 'org-tab-first-hook 'org-hide-block-toggle-maybe)
  6468. ;; Remove overlays when changing major mode
  6469. (add-hook 'org-mode-hook
  6470. (lambda () (org-add-hook 'change-major-mode-hook
  6471. 'org-show-block-all 'append 'local)))
  6472. ;;; Org-goto
  6473. (defvar org-goto-window-configuration nil)
  6474. (defvar org-goto-marker nil)
  6475. (defvar org-goto-map)
  6476. (defun org-goto-map ()
  6477. "Set the keymap `org-goto'."
  6478. (setq org-goto-map
  6479. (let ((map (make-sparse-keymap)))
  6480. (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command
  6481. mouse-drag-region universal-argument org-occur))
  6482. cmd)
  6483. (while (setq cmd (pop cmds))
  6484. (substitute-key-definition cmd cmd map global-map)))
  6485. (suppress-keymap map)
  6486. (org-defkey map "\C-m" 'org-goto-ret)
  6487. (org-defkey map [(return)] 'org-goto-ret)
  6488. (org-defkey map [(left)] 'org-goto-left)
  6489. (org-defkey map [(right)] 'org-goto-right)
  6490. (org-defkey map [(control ?g)] 'org-goto-quit)
  6491. (org-defkey map "\C-i" 'org-cycle)
  6492. (org-defkey map [(tab)] 'org-cycle)
  6493. (org-defkey map [(down)] 'outline-next-visible-heading)
  6494. (org-defkey map [(up)] 'outline-previous-visible-heading)
  6495. (if org-goto-auto-isearch
  6496. (if (fboundp 'define-key-after)
  6497. (define-key-after map [t] 'org-goto-local-auto-isearch)
  6498. nil)
  6499. (org-defkey map "q" 'org-goto-quit)
  6500. (org-defkey map "n" 'outline-next-visible-heading)
  6501. (org-defkey map "p" 'outline-previous-visible-heading)
  6502. (org-defkey map "f" 'outline-forward-same-level)
  6503. (org-defkey map "b" 'outline-backward-same-level)
  6504. (org-defkey map "u" 'outline-up-heading))
  6505. (org-defkey map "/" 'org-occur)
  6506. (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
  6507. (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
  6508. (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
  6509. (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
  6510. (org-defkey map "\C-c\C-u" 'outline-up-heading)
  6511. map)))
  6512. (defconst org-goto-help
  6513. "Browse buffer copy, to find location or copy text.%s
  6514. RET=jump to location C-g=quit and return to previous location
  6515. \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
  6516. (defvar org-goto-start-pos) ; dynamically scoped parameter
  6517. (defun org-goto (&optional alternative-interface)
  6518. "Look up a different location in the current file, keeping current visibility.
  6519. When you want look-up or go to a different location in a
  6520. document, the fastest way is often to fold the entire buffer and
  6521. then dive into the tree. This method has the disadvantage, that
  6522. the previous location will be folded, which may not be what you
  6523. want.
  6524. This command works around this by showing a copy of the current
  6525. buffer in an indirect buffer, in overview mode. You can dive
  6526. into the tree in that copy, use org-occur and incremental search
  6527. to find a location. When pressing RET or `Q', the command
  6528. returns to the original buffer in which the visibility is still
  6529. unchanged. After RET it will also jump to the location selected
  6530. in the indirect buffer and expose the headline hierarchy above.
  6531. With a prefix argument, use the alternative interface: e.g. if
  6532. `org-goto-interface' is 'outline use 'outline-path-completion."
  6533. (interactive "P")
  6534. (org-goto-map)
  6535. (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
  6536. (org-refile-use-outline-path t)
  6537. (org-refile-target-verify-function nil)
  6538. (interface
  6539. (if (not alternative-interface)
  6540. org-goto-interface
  6541. (if (eq org-goto-interface 'outline)
  6542. 'outline-path-completion
  6543. 'outline)))
  6544. (org-goto-start-pos (point))
  6545. (selected-point
  6546. (if (eq interface 'outline)
  6547. (car (org-get-location (current-buffer) org-goto-help))
  6548. (let ((pa (org-refile-get-location "Goto" nil nil t)))
  6549. (org-refile-check-position pa)
  6550. (nth 3 pa)))))
  6551. (if selected-point
  6552. (progn
  6553. (org-mark-ring-push org-goto-start-pos)
  6554. (goto-char selected-point)
  6555. (if (or (outline-invisible-p) (org-invisible-p2))
  6556. (org-show-context 'org-goto)))
  6557. (message "Quit"))))
  6558. (defvar org-goto-selected-point nil) ; dynamically scoped parameter
  6559. (defvar org-goto-exit-command nil) ; dynamically scoped parameter
  6560. (defvar org-goto-local-auto-isearch-map) ; defined below
  6561. (defun org-get-location (buf help)
  6562. "Let the user select a location in the Org-mode buffer BUF.
  6563. This function uses a recursive edit. It returns the selected position
  6564. or nil."
  6565. (org-no-popups
  6566. (let ((isearch-mode-map org-goto-local-auto-isearch-map)
  6567. (isearch-hide-immediately nil)
  6568. (isearch-search-fun-function
  6569. (lambda () 'org-goto-local-search-headings))
  6570. (org-goto-selected-point org-goto-exit-command))
  6571. (save-excursion
  6572. (save-window-excursion
  6573. (delete-other-windows)
  6574. (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
  6575. (org-pop-to-buffer-same-window
  6576. (condition-case nil
  6577. (make-indirect-buffer (current-buffer) "*org-goto*")
  6578. (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
  6579. (with-output-to-temp-buffer "*Org Help*"
  6580. (princ (format help (if org-goto-auto-isearch
  6581. " Just type for auto-isearch."
  6582. " n/p/f/b/u to navigate, q to quit."))))
  6583. (org-fit-window-to-buffer (get-buffer-window "*Org Help*"))
  6584. (setq buffer-read-only nil)
  6585. (let ((org-startup-truncated t)
  6586. (org-startup-folded nil)
  6587. (org-startup-align-all-tables nil))
  6588. (org-mode)
  6589. (org-overview))
  6590. (setq buffer-read-only t)
  6591. (if (and (boundp 'org-goto-start-pos)
  6592. (integer-or-marker-p org-goto-start-pos))
  6593. (let ((org-show-hierarchy-above t)
  6594. (org-show-siblings t)
  6595. (org-show-following-heading t))
  6596. (goto-char org-goto-start-pos)
  6597. (and (outline-invisible-p) (org-show-context)))
  6598. (goto-char (point-min)))
  6599. (let (org-special-ctrl-a/e) (org-beginning-of-line))
  6600. (message "Select location and press RET")
  6601. (use-local-map org-goto-map)
  6602. (recursive-edit)))
  6603. (kill-buffer "*org-goto*")
  6604. (cons org-goto-selected-point org-goto-exit-command))))
  6605. (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
  6606. (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
  6607. (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
  6608. (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
  6609. (defun org-goto-local-search-headings (string bound noerror)
  6610. "Search and make sure that any matches are in headlines."
  6611. (catch 'return
  6612. (while (if isearch-forward
  6613. (search-forward string bound noerror)
  6614. (search-backward string bound noerror))
  6615. (when (let ((context (mapcar 'car (save-match-data (org-context)))))
  6616. (and (member :headline context)
  6617. (not (member :tags context))))
  6618. (throw 'return (point))))))
  6619. (defun org-goto-local-auto-isearch ()
  6620. "Start isearch."
  6621. (interactive)
  6622. (goto-char (point-min))
  6623. (let ((keys (this-command-keys)))
  6624. (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
  6625. (isearch-mode t)
  6626. (isearch-process-search-char (string-to-char keys)))))
  6627. (defun org-goto-ret (&optional arg)
  6628. "Finish `org-goto' by going to the new location."
  6629. (interactive "P")
  6630. (setq org-goto-selected-point (point)
  6631. org-goto-exit-command 'return)
  6632. (throw 'exit nil))
  6633. (defun org-goto-left ()
  6634. "Finish `org-goto' by going to the new location."
  6635. (interactive)
  6636. (if (org-at-heading-p)
  6637. (progn
  6638. (beginning-of-line 1)
  6639. (setq org-goto-selected-point (point)
  6640. org-goto-exit-command 'left)
  6641. (throw 'exit nil))
  6642. (user-error "Not on a heading")))
  6643. (defun org-goto-right ()
  6644. "Finish `org-goto' by going to the new location."
  6645. (interactive)
  6646. (if (org-at-heading-p)
  6647. (progn
  6648. (setq org-goto-selected-point (point)
  6649. org-goto-exit-command 'right)
  6650. (throw 'exit nil))
  6651. (user-error "Not on a heading")))
  6652. (defun org-goto-quit ()
  6653. "Finish `org-goto' without cursor motion."
  6654. (interactive)
  6655. (setq org-goto-selected-point nil)
  6656. (setq org-goto-exit-command 'quit)
  6657. (throw 'exit nil))
  6658. ;;; Indirect buffer display of subtrees
  6659. (defvar org-indirect-dedicated-frame nil
  6660. "This is the frame being used for indirect tree display.")
  6661. (defvar org-last-indirect-buffer nil)
  6662. (defun org-tree-to-indirect-buffer (&optional arg)
  6663. "Create indirect buffer and narrow it to current subtree.
  6664. With a numerical prefix ARG, go up to this level and then take that tree.
  6665. If ARG is negative, go up that many levels.
  6666. If `org-indirect-buffer-display' is not `new-frame', the command removes the
  6667. indirect buffer previously made with this command, to avoid proliferation of
  6668. indirect buffers. However, when you call the command with a \
  6669. \\[universal-argument] prefix, or
  6670. when `org-indirect-buffer-display' is `new-frame', the last buffer
  6671. is kept so that you can work with several indirect buffers at the same time.
  6672. If `org-indirect-buffer-display' is `dedicated-frame', the \
  6673. \\[universal-argument] prefix also
  6674. requests that a new frame be made for the new buffer, so that the dedicated
  6675. frame is not changed."
  6676. (interactive "P")
  6677. (let ((cbuf (current-buffer))
  6678. (cwin (selected-window))
  6679. (pos (point))
  6680. beg end level heading ibuf)
  6681. (save-excursion
  6682. (org-back-to-heading t)
  6683. (when (numberp arg)
  6684. (setq level (org-outline-level))
  6685. (if (< arg 0) (setq arg (+ level arg)))
  6686. (while (> (setq level (org-outline-level)) arg)
  6687. (org-up-heading-safe)))
  6688. (setq beg (point)
  6689. heading (org-get-heading))
  6690. (org-end-of-subtree t t)
  6691. (if (org-at-heading-p) (backward-char 1))
  6692. (setq end (point)))
  6693. (if (and (buffer-live-p org-last-indirect-buffer)
  6694. (not (eq org-indirect-buffer-display 'new-frame))
  6695. (not arg))
  6696. (kill-buffer org-last-indirect-buffer))
  6697. (setq ibuf (org-get-indirect-buffer cbuf)
  6698. org-last-indirect-buffer ibuf)
  6699. (cond
  6700. ((or (eq org-indirect-buffer-display 'new-frame)
  6701. (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
  6702. (select-frame (make-frame))
  6703. (delete-other-windows)
  6704. (org-pop-to-buffer-same-window ibuf)
  6705. (org-set-frame-title heading))
  6706. ((eq org-indirect-buffer-display 'dedicated-frame)
  6707. (raise-frame
  6708. (select-frame (or (and org-indirect-dedicated-frame
  6709. (frame-live-p org-indirect-dedicated-frame)
  6710. org-indirect-dedicated-frame)
  6711. (setq org-indirect-dedicated-frame (make-frame)))))
  6712. (delete-other-windows)
  6713. (org-pop-to-buffer-same-window ibuf)
  6714. (org-set-frame-title (concat "Indirect: " heading)))
  6715. ((eq org-indirect-buffer-display 'current-window)
  6716. (org-pop-to-buffer-same-window ibuf))
  6717. ((eq org-indirect-buffer-display 'other-window)
  6718. (pop-to-buffer ibuf))
  6719. (t (error "Invalid value")))
  6720. (if (featurep 'xemacs)
  6721. (save-excursion (org-mode) (turn-on-font-lock)))
  6722. (narrow-to-region beg end)
  6723. (show-all)
  6724. (goto-char pos)
  6725. (run-hook-with-args 'org-cycle-hook 'all)
  6726. (and (window-live-p cwin) (select-window cwin))))
  6727. (defun org-get-indirect-buffer (&optional buffer)
  6728. (setq buffer (or buffer (current-buffer)))
  6729. (let ((n 1) (base (buffer-name buffer)) bname)
  6730. (while (buffer-live-p
  6731. (get-buffer (setq bname (concat base "-" (number-to-string n)))))
  6732. (setq n (1+ n)))
  6733. (condition-case nil
  6734. (make-indirect-buffer buffer bname 'clone)
  6735. (error (make-indirect-buffer buffer bname)))))
  6736. (defun org-set-frame-title (title)
  6737. "Set the title of the current frame to the string TITLE."
  6738. ;; FIXME: how to name a single frame in XEmacs???
  6739. (unless (featurep 'xemacs)
  6740. (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
  6741. ;;;; Structure editing
  6742. ;;; Inserting headlines
  6743. (defun org-previous-line-empty-p (&optional next)
  6744. "Is the previous line a blank line?
  6745. When NEXT is non-nil, check the next line instead."
  6746. (save-excursion
  6747. (and (not (bobp))
  6748. (or (beginning-of-line (if next 2 0)) t)
  6749. (save-match-data
  6750. (looking-at "[ \t]*$")))))
  6751. (defun org-insert-heading (&optional arg invisible-ok)
  6752. "Insert a new heading or item with same depth at point.
  6753. If point is in a plain list and ARG is nil, create a new list item.
  6754. With one universal prefix argument, insert a heading even in lists.
  6755. With two universal prefix arguments, insert the heading at the end
  6756. of the parent subtree.
  6757. If point is at the beginning of a headline, insert a sibling before
  6758. the current headline. If point is not at the beginning, split the line
  6759. and create a new headline with the text in the current line after point
  6760. \(see `org-M-RET-may-split-line' on how to modify this behavior).
  6761. If point is at the beginning of a normal line, turn this line into
  6762. a heading.
  6763. When INVISIBLE-OK is set, stop at invisible headlines when going back.
  6764. This is important for non-interactive uses of the command."
  6765. (interactive "P")
  6766. (if (org-called-interactively-p 'any) (org-reveal))
  6767. (let ((itemp (org-in-item-p))
  6768. (may-split (org-get-alist-option org-M-RET-may-split-line 'headline))
  6769. (respect-content (or org-insert-heading-respect-content
  6770. (equal arg '(16))))
  6771. (initial-content "")
  6772. (adjust-empty-lines t))
  6773. (cond
  6774. ((or (= (buffer-size) 0)
  6775. (and (not (save-excursion
  6776. (and (ignore-errors (org-back-to-heading invisible-ok))
  6777. (org-at-heading-p))))
  6778. (or arg (not itemp))))
  6779. ;; At beginning of buffer or so high up that only a heading
  6780. ;; makes sense.
  6781. (insert
  6782. (if (or (bobp) (org-previous-line-empty-p)) "" "\n")
  6783. (if (org-in-src-block-p) ",* " "* "))
  6784. (run-hooks 'org-insert-heading-hook))
  6785. ((and itemp (not (equal arg '(4))))
  6786. ;; Insert an item
  6787. (org-insert-item))
  6788. (t
  6789. ;; Insert a heading
  6790. (save-restriction
  6791. (widen)
  6792. (let* ((level nil)
  6793. (on-heading (org-at-heading-p))
  6794. (empty-line-p (if on-heading
  6795. (org-previous-line-empty-p)
  6796. ;; We will decide later
  6797. nil))
  6798. ;; Get a level string to fall back on
  6799. (fix-level
  6800. (save-excursion
  6801. (org-back-to-heading t)
  6802. (if (org-previous-line-empty-p) (setq empty-line-p t))
  6803. (looking-at org-outline-regexp)
  6804. (make-string (1- (length (match-string 0))) ?*)))
  6805. (stars
  6806. (save-excursion
  6807. (condition-case nil
  6808. (progn
  6809. (org-back-to-heading invisible-ok)
  6810. (when (and (not on-heading)
  6811. (featurep 'org-inlinetask)
  6812. (integerp org-inlinetask-min-level)
  6813. (>= (length (match-string 0))
  6814. org-inlinetask-min-level))
  6815. ;; Find a heading level before the inline task
  6816. (while (and (setq level (org-up-heading-safe))
  6817. (>= level org-inlinetask-min-level)))
  6818. (if (org-at-heading-p)
  6819. (org-back-to-heading invisible-ok)
  6820. (error "This should not happen")))
  6821. (unless (and (save-excursion
  6822. (save-match-data
  6823. (org-backward-heading-same-level
  6824. 1 invisible-ok))
  6825. (= (point) (match-beginning 0)))
  6826. (not (org-previous-line-empty-p t)))
  6827. (setq empty-line-p (or empty-line-p
  6828. (org-previous-line-empty-p))))
  6829. (match-string 0))
  6830. (error (or fix-level "* ")))))
  6831. (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
  6832. (blank (if (eq blank-a 'auto) empty-line-p blank-a))
  6833. pos hide-previous previous-pos)
  6834. ;; If we insert after content, move there and clean up whitespace
  6835. (when respect-content
  6836. (org-end-of-subtree nil t)
  6837. (skip-chars-backward " \r\n")
  6838. (and (looking-at "[ \t]+") (replace-match ""))
  6839. (unless (eobp) (forward-char 1))
  6840. (when (looking-at "^\\*")
  6841. (unless (bobp) (backward-char 1))
  6842. (insert "\n")))
  6843. ;; If we are splitting, grab the text that should be moved to the new headline
  6844. (when may-split
  6845. (if (org-on-heading-p)
  6846. ;; This is a heading, we split intelligently (keeping tags)
  6847. (let ((pos (point)))
  6848. (goto-char (point-at-bol))
  6849. (unless (looking-at org-complex-heading-regexp)
  6850. (error "This should not happen"))
  6851. (when (and (match-beginning 4)
  6852. (> pos (match-beginning 4))
  6853. (< pos (match-end 4)))
  6854. (setq initial-content (buffer-substring pos (match-end 4)))
  6855. (goto-char pos)
  6856. (delete-region (point) (match-end 4))
  6857. (if (looking-at "[ \t]*$")
  6858. (replace-match "")
  6859. (insert (make-string (length initial-content) ?\ )))
  6860. (setq initial-content (org-trim initial-content)))
  6861. (goto-char pos))
  6862. ;; a normal line
  6863. (unless (bolp)
  6864. (setq initial-content (buffer-substring (point) (point-at-eol)))
  6865. (delete-region (point) (point-at-eol))
  6866. (setq initial-content (org-trim initial-content)))))
  6867. ;; If we are at the beginning of the line, insert before it. Else after
  6868. (cond
  6869. ((and (bolp) (looking-at "[ \t]*$")))
  6870. ((and (bolp) (not (looking-at "[ \t]*$")))
  6871. (open-line 1))
  6872. (t
  6873. (goto-char (point-at-eol))
  6874. (insert "\n")))
  6875. ;; Insert the new heading
  6876. (insert stars)
  6877. (just-one-space)
  6878. (insert initial-content)
  6879. (when adjust-empty-lines
  6880. (if (or (not blank)
  6881. (and blank (not (org-previous-line-empty-p))))
  6882. (org-N-empty-lines-before-current (if blank 1 0))))
  6883. (run-hooks 'org-insert-heading-hook)))))))
  6884. (defun org-N-empty-lines-before-current (N)
  6885. "Make the number of empty lines before current exactly N.
  6886. So this will delete or add empty lines."
  6887. (save-excursion
  6888. (goto-char (point-at-bol))
  6889. (if (looking-back "\\s-+" nil 'greedy)
  6890. (replace-match ""))
  6891. (or (bobp) (insert "\n"))
  6892. (while (> N 0)
  6893. (insert "\n")
  6894. (setq N (1- N)))))
  6895. (defun org-get-heading (&optional no-tags no-todo)
  6896. "Return the heading of the current entry, without the stars.
  6897. When NO-TAGS is non-nil, don't include tags.
  6898. When NO-TODO is non-nil, don't include TODO keywords."
  6899. (save-excursion
  6900. (org-back-to-heading t)
  6901. (cond
  6902. ((and no-tags no-todo)
  6903. (looking-at org-complex-heading-regexp)
  6904. (match-string 4))
  6905. (no-tags
  6906. (looking-at (concat org-outline-regexp
  6907. "\\(.*?\\)"
  6908. "\\(?:[ \t]+:[[:alnum:]:_@#%]+:\\)?[ \t]*$"))
  6909. (match-string 1))
  6910. (no-todo
  6911. (looking-at org-todo-line-regexp)
  6912. (match-string 3))
  6913. (t (looking-at org-heading-regexp)
  6914. (match-string 2)))))
  6915. (defvar orgstruct-mode) ; defined below
  6916. (defun org-heading-components ()
  6917. "Return the components of the current heading.
  6918. This is a list with the following elements:
  6919. - the level as an integer
  6920. - the reduced level, different if `org-odd-levels-only' is set.
  6921. - the TODO keyword, or nil
  6922. - the priority character, like ?A, or nil if no priority is given
  6923. - the headline text itself, or the tags string if no headline text
  6924. - the tags string, or nil."
  6925. (save-excursion
  6926. (org-back-to-heading t)
  6927. (if (let (case-fold-search)
  6928. (looking-at
  6929. (if orgstruct-mode
  6930. org-heading-regexp
  6931. org-complex-heading-regexp)))
  6932. (if orgstruct-mode
  6933. (list (length (match-string 1))
  6934. (org-reduced-level (length (match-string 1)))
  6935. nil
  6936. nil
  6937. (match-string 2)
  6938. nil)
  6939. (list (length (match-string 1))
  6940. (org-reduced-level (length (match-string 1)))
  6941. (org-match-string-no-properties 2)
  6942. (and (match-end 3) (aref (match-string 3) 2))
  6943. (org-match-string-no-properties 4)
  6944. (org-match-string-no-properties 5))))))
  6945. (defun org-get-entry ()
  6946. "Get the entry text, after heading, entire subtree."
  6947. (save-excursion
  6948. (org-back-to-heading t)
  6949. (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
  6950. (defun org-insert-heading-after-current ()
  6951. "Insert a new heading with same level as current, after current subtree."
  6952. (interactive)
  6953. (org-back-to-heading)
  6954. (org-insert-heading)
  6955. (org-move-subtree-down)
  6956. (end-of-line 1))
  6957. (defun org-insert-heading-respect-content (&optional arg invisible-ok)
  6958. "Insert heading with `org-insert-heading-respect-content' set to t."
  6959. (interactive "P")
  6960. (let ((org-insert-heading-respect-content t))
  6961. (org-insert-heading '(4) invisible-ok)))
  6962. (defun org-insert-todo-heading-respect-content (&optional force-state)
  6963. "Insert TODO heading with `org-insert-heading-respect-content' set to t."
  6964. (interactive "P")
  6965. (let ((org-insert-heading-respect-content t))
  6966. (org-insert-todo-heading force-state '(4))))
  6967. (defun org-insert-todo-heading (arg &optional force-heading)
  6968. "Insert a new heading with the same level and TODO state as current heading.
  6969. If the heading has no TODO state, or if the state is DONE, use the first
  6970. state (TODO by default). Also one prefix arg, force first state. With two
  6971. prefix args, force inserting at the end of the parent subtree."
  6972. (interactive "P")
  6973. (when (or force-heading (not (org-insert-item 'checkbox)))
  6974. (org-insert-heading (or (and (equal arg '(16)) '(16))
  6975. force-heading))
  6976. (save-excursion
  6977. (org-back-to-heading)
  6978. (outline-previous-heading)
  6979. (looking-at org-todo-line-regexp))
  6980. (let*
  6981. ((new-mark-x
  6982. (if (or arg
  6983. (not (match-beginning 2))
  6984. (member (match-string 2) org-done-keywords))
  6985. (car org-todo-keywords-1)
  6986. (match-string 2)))
  6987. (new-mark
  6988. (or
  6989. (run-hook-with-args-until-success
  6990. 'org-todo-get-default-hook new-mark-x nil)
  6991. new-mark-x)))
  6992. (beginning-of-line 1)
  6993. (and (looking-at org-outline-regexp) (goto-char (match-end 0))
  6994. (if org-treat-insert-todo-heading-as-state-change
  6995. (org-todo new-mark)
  6996. (insert new-mark " "))))
  6997. (when org-provide-todo-statistics
  6998. (org-update-parent-todo-statistics))))
  6999. (defun org-insert-subheading (arg)
  7000. "Insert a new subheading and demote it.
  7001. Works for outline headings and for plain lists alike."
  7002. (interactive "P")
  7003. (org-insert-heading arg)
  7004. (cond
  7005. ((org-at-heading-p) (org-do-demote))
  7006. ((org-at-item-p) (org-indent-item))))
  7007. (defun org-insert-todo-subheading (arg)
  7008. "Insert a new subheading with TODO keyword or checkbox and demote it.
  7009. Works for outline headings and for plain lists alike."
  7010. (interactive "P")
  7011. (org-insert-todo-heading arg)
  7012. (cond
  7013. ((org-at-heading-p) (org-do-demote))
  7014. ((org-at-item-p) (org-indent-item))))
  7015. ;;; Promotion and Demotion
  7016. (defvar org-after-demote-entry-hook nil
  7017. "Hook run after an entry has been demoted.
  7018. The cursor will be at the beginning of the entry.
  7019. When a subtree is being demoted, the hook will be called for each node.")
  7020. (defvar org-after-promote-entry-hook nil
  7021. "Hook run after an entry has been promoted.
  7022. The cursor will be at the beginning of the entry.
  7023. When a subtree is being promoted, the hook will be called for each node.")
  7024. (defun org-promote-subtree ()
  7025. "Promote the entire subtree.
  7026. See also `org-promote'."
  7027. (interactive)
  7028. (save-excursion
  7029. (org-with-limited-levels (org-map-tree 'org-promote)))
  7030. (org-fix-position-after-promote))
  7031. (defun org-demote-subtree ()
  7032. "Demote the entire subtree. See `org-demote'.
  7033. See also `org-promote'."
  7034. (interactive)
  7035. (save-excursion
  7036. (org-with-limited-levels (org-map-tree 'org-demote)))
  7037. (org-fix-position-after-promote))
  7038. (defun org-do-promote ()
  7039. "Promote the current heading higher up the tree.
  7040. If the region is active in `transient-mark-mode', promote all headings
  7041. in the region."
  7042. (interactive)
  7043. (save-excursion
  7044. (if (org-region-active-p)
  7045. (org-map-region 'org-promote (region-beginning) (region-end))
  7046. (org-promote)))
  7047. (org-fix-position-after-promote))
  7048. (defun org-do-demote ()
  7049. "Demote the current heading lower down the tree.
  7050. If the region is active in `transient-mark-mode', demote all headings
  7051. in the region."
  7052. (interactive)
  7053. (save-excursion
  7054. (if (org-region-active-p)
  7055. (org-map-region 'org-demote (region-beginning) (region-end))
  7056. (org-demote)))
  7057. (org-fix-position-after-promote))
  7058. (defun org-fix-position-after-promote ()
  7059. "Make sure that after pro/demotion cursor position is right."
  7060. (let ((pos (point)))
  7061. (when (save-excursion
  7062. (beginning-of-line 1)
  7063. (looking-at org-todo-line-regexp)
  7064. (or (equal pos (match-end 1)) (equal pos (match-end 2))))
  7065. (cond ((eobp) (insert " "))
  7066. ((eolp) (insert " "))
  7067. ((equal (char-after) ?\ ) (forward-char 1))))))
  7068. (defun org-current-level ()
  7069. "Return the level of the current entry, or nil if before the first headline.
  7070. The level is the number of stars at the beginning of the headline."
  7071. (save-excursion
  7072. (org-with-limited-levels
  7073. (if (ignore-errors (org-back-to-heading t))
  7074. (funcall outline-level)))))
  7075. (defun org-get-previous-line-level ()
  7076. "Return the outline depth of the last headline before the current line.
  7077. Returns 0 for the first headline in the buffer, and nil if before the
  7078. first headline."
  7079. (let ((current-level (org-current-level))
  7080. (prev-level (when (> (line-number-at-pos) 1)
  7081. (save-excursion
  7082. (beginning-of-line 0)
  7083. (org-current-level)))))
  7084. (cond ((null current-level) nil) ; Before first headline
  7085. ((null prev-level) 0) ; At first headline
  7086. (prev-level))))
  7087. (defun org-reduced-level (l)
  7088. "Compute the effective level of a heading.
  7089. This takes into account the setting of `org-odd-levels-only'."
  7090. (cond
  7091. ((zerop l) 0)
  7092. (org-odd-levels-only (1+ (floor (/ l 2))))
  7093. (t l)))
  7094. (defun org-level-increment ()
  7095. "Return the number of stars that will be added or removed at a
  7096. time to headlines when structure editing, based on the value of
  7097. `org-odd-levels-only'."
  7098. (if org-odd-levels-only 2 1))
  7099. (defun org-get-valid-level (level &optional change)
  7100. "Rectify a level change under the influence of `org-odd-levels-only'
  7101. LEVEL is a current level, CHANGE is by how much the level should be
  7102. modified. Even if CHANGE is nil, LEVEL may be returned modified because
  7103. even level numbers will become the next higher odd number."
  7104. (if org-odd-levels-only
  7105. (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
  7106. ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
  7107. ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
  7108. (max 1 (+ level (or change 0)))))
  7109. (if (boundp 'define-obsolete-function-alias)
  7110. (if (or (featurep 'xemacs) (< emacs-major-version 23))
  7111. (define-obsolete-function-alias 'org-get-legal-level
  7112. 'org-get-valid-level)
  7113. (define-obsolete-function-alias 'org-get-legal-level
  7114. 'org-get-valid-level "23.1")))
  7115. (defvar org-called-with-limited-levels nil) ;; Dynamically bound in
  7116. ;; ̀org-with-limited-levels'
  7117. (defun org-promote ()
  7118. "Promote the current heading higher up the tree.
  7119. If the region is active in `transient-mark-mode', promote all headings
  7120. in the region."
  7121. (org-back-to-heading t)
  7122. (let* ((level (save-match-data (funcall outline-level)))
  7123. (after-change-functions (remove 'flyspell-after-change-function
  7124. after-change-functions))
  7125. (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
  7126. (diff (abs (- level (length up-head) -1))))
  7127. (cond ((and (= level 1) org-called-with-limited-levels
  7128. org-allow-promoting-top-level-subtree)
  7129. (replace-match "# " nil t))
  7130. ((= level 1)
  7131. (user-error "Cannot promote to level 0. UNDO to recover if necessary"))
  7132. (t (replace-match up-head nil t)))
  7133. ;; Fixup tag positioning
  7134. (unless (= level 1)
  7135. (and org-auto-align-tags (org-set-tags nil t))
  7136. (if org-adapt-indentation (org-fixup-indentation (- diff))))
  7137. (run-hooks 'org-after-promote-entry-hook)))
  7138. (defun org-demote ()
  7139. "Demote the current heading lower down the tree.
  7140. If the region is active in `transient-mark-mode', demote all headings
  7141. in the region."
  7142. (org-back-to-heading t)
  7143. (let* ((level (save-match-data (funcall outline-level)))
  7144. (after-change-functions (remove 'flyspell-after-change-function
  7145. after-change-functions))
  7146. (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
  7147. (diff (abs (- level (length down-head) -1))))
  7148. (replace-match down-head nil t)
  7149. ;; Fixup tag positioning
  7150. (and org-auto-align-tags (org-set-tags nil t))
  7151. (if org-adapt-indentation (org-fixup-indentation diff))
  7152. (run-hooks 'org-after-demote-entry-hook)))
  7153. (defun org-cycle-level ()
  7154. "Cycle the level of an empty headline through possible states.
  7155. This goes first to child, then to parent, level, then up the hierarchy.
  7156. After top level, it switches back to sibling level."
  7157. (interactive)
  7158. (let ((org-adapt-indentation nil))
  7159. (when (org-point-at-end-of-empty-headline)
  7160. (setq this-command 'org-cycle-level) ; Only needed for caching
  7161. (let ((cur-level (org-current-level))
  7162. (prev-level (org-get-previous-line-level)))
  7163. (cond
  7164. ;; If first headline in file, promote to top-level.
  7165. ((= prev-level 0)
  7166. (loop repeat (/ (- cur-level 1) (org-level-increment))
  7167. do (org-do-promote)))
  7168. ;; If same level as prev, demote one.
  7169. ((= prev-level cur-level)
  7170. (org-do-demote))
  7171. ;; If parent is top-level, promote to top level if not already.
  7172. ((= prev-level 1)
  7173. (loop repeat (/ (- cur-level 1) (org-level-increment))
  7174. do (org-do-promote)))
  7175. ;; If top-level, return to prev-level.
  7176. ((= cur-level 1)
  7177. (loop repeat (/ (- prev-level 1) (org-level-increment))
  7178. do (org-do-demote)))
  7179. ;; If less than prev-level, promote one.
  7180. ((< cur-level prev-level)
  7181. (org-do-promote))
  7182. ;; If deeper than prev-level, promote until higher than
  7183. ;; prev-level.
  7184. ((> cur-level prev-level)
  7185. (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
  7186. do (org-do-promote))))
  7187. t))))
  7188. (defun org-map-tree (fun)
  7189. "Call FUN for every heading underneath the current one."
  7190. (org-back-to-heading)
  7191. (let ((level (funcall outline-level)))
  7192. (save-excursion
  7193. (funcall fun)
  7194. (while (and (progn
  7195. (outline-next-heading)
  7196. (> (funcall outline-level) level))
  7197. (not (eobp)))
  7198. (funcall fun)))))
  7199. (defun org-map-region (fun beg end)
  7200. "Call FUN for every heading between BEG and END."
  7201. (let ((org-ignore-region t))
  7202. (save-excursion
  7203. (setq end (copy-marker end))
  7204. (goto-char beg)
  7205. (if (and (re-search-forward org-outline-regexp-bol nil t)
  7206. (< (point) end))
  7207. (funcall fun))
  7208. (while (and (progn
  7209. (outline-next-heading)
  7210. (< (point) end))
  7211. (not (eobp)))
  7212. (funcall fun)))))
  7213. (defvar org-property-end-re) ; silence byte-compiler
  7214. (defun org-fixup-indentation (diff)
  7215. "Change the indentation in the current entry by DIFF.
  7216. However, if any line in the current entry has no indentation, or if it
  7217. would end up with no indentation after the change, nothing at all is done."
  7218. (save-excursion
  7219. (let ((end (save-excursion (outline-next-heading)
  7220. (point-marker)))
  7221. (prohibit (if (> diff 0)
  7222. "^\\S-"
  7223. (concat "^ \\{0," (int-to-string (- diff)) "\\}\\S-")))
  7224. col)
  7225. (unless (save-excursion (end-of-line 1)
  7226. (re-search-forward prohibit end t))
  7227. (while (and (< (point) end)
  7228. (re-search-forward "^[ \t]+" end t))
  7229. (goto-char (match-end 0))
  7230. (setq col (current-column))
  7231. (if (< diff 0) (replace-match ""))
  7232. (org-indent-to-column (+ diff col))))
  7233. (move-marker end nil))))
  7234. (defun org-convert-to-odd-levels ()
  7235. "Convert an org-mode file with all levels allowed to one with odd levels.
  7236. This will leave level 1 alone, convert level 2 to level 3, level 3 to
  7237. level 5 etc."
  7238. (interactive)
  7239. (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
  7240. (let ((outline-level 'org-outline-level)
  7241. (org-odd-levels-only nil) n)
  7242. (save-excursion
  7243. (goto-char (point-min))
  7244. (while (re-search-forward "^\\*\\*+ " nil t)
  7245. (setq n (- (length (match-string 0)) 2))
  7246. (while (>= (setq n (1- n)) 0)
  7247. (org-demote))
  7248. (end-of-line 1))))))
  7249. (defun org-convert-to-oddeven-levels ()
  7250. "Convert an org-mode file with only odd levels to one with odd/even levels.
  7251. This promotes level 3 to level 2, level 5 to level 3 etc. If the
  7252. file contains a section with an even level, conversion would
  7253. destroy the structure of the file. An error is signaled in this
  7254. case."
  7255. (interactive)
  7256. (goto-char (point-min))
  7257. ;; First check if there are no even levels
  7258. (when (re-search-forward "^\\(\\*\\*\\)+ " nil t)
  7259. (org-show-context t)
  7260. (error "Not all levels are odd in this file. Conversion not possible"))
  7261. (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
  7262. (let ((outline-regexp org-outline-regexp)
  7263. (outline-level 'org-outline-level)
  7264. (org-odd-levels-only nil) n)
  7265. (save-excursion
  7266. (goto-char (point-min))
  7267. (while (re-search-forward "^\\*\\*+ " nil t)
  7268. (setq n (/ (1- (length (match-string 0))) 2))
  7269. (while (>= (setq n (1- n)) 0)
  7270. (org-promote))
  7271. (end-of-line 1))))))
  7272. (defun org-tr-level (n)
  7273. "Make N odd if required."
  7274. (if org-odd-levels-only (1+ (/ n 2)) n))
  7275. ;;; Vertical tree motion, cutting and pasting of subtrees
  7276. (defun org-move-subtree-up (&optional arg)
  7277. "Move the current subtree up past ARG headlines of the same level."
  7278. (interactive "p")
  7279. (org-move-subtree-down (- (prefix-numeric-value arg))))
  7280. (defun org-move-subtree-down (&optional arg)
  7281. "Move the current subtree down past ARG headlines of the same level."
  7282. (interactive "p")
  7283. (setq arg (prefix-numeric-value arg))
  7284. (let ((movfunc (if (> arg 0) 'org-get-next-sibling
  7285. 'org-get-last-sibling))
  7286. (ins-point (make-marker))
  7287. (cnt (abs arg))
  7288. (col (current-column))
  7289. beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
  7290. ;; Select the tree
  7291. (org-back-to-heading)
  7292. (setq beg0 (point))
  7293. (save-excursion
  7294. (setq ne-beg (org-back-over-empty-lines))
  7295. (setq beg (point)))
  7296. (save-match-data
  7297. (save-excursion (outline-end-of-heading)
  7298. (setq folded (outline-invisible-p)))
  7299. (outline-end-of-subtree))
  7300. (outline-next-heading)
  7301. (setq ne-end (org-back-over-empty-lines))
  7302. (setq end (point))
  7303. (goto-char beg0)
  7304. (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
  7305. ;; include less whitespace
  7306. (save-excursion
  7307. (goto-char beg)
  7308. (forward-line (- ne-beg ne-end))
  7309. (setq beg (point))))
  7310. ;; Find insertion point, with error handling
  7311. (while (> cnt 0)
  7312. (or (and (funcall movfunc) (looking-at org-outline-regexp))
  7313. (progn (goto-char beg0)
  7314. (user-error "Cannot move past superior level or buffer limit")))
  7315. (setq cnt (1- cnt)))
  7316. (if (> arg 0)
  7317. ;; Moving forward - still need to move over subtree
  7318. (progn (org-end-of-subtree t t)
  7319. (save-excursion
  7320. (org-back-over-empty-lines)
  7321. (or (bolp) (newline)))))
  7322. (setq ne-ins (org-back-over-empty-lines))
  7323. (move-marker ins-point (point))
  7324. (setq txt (buffer-substring beg end))
  7325. (org-save-markers-in-region beg end)
  7326. (delete-region beg end)
  7327. (org-remove-empty-overlays-at beg)
  7328. (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
  7329. (or (bobp) (outline-flag-region (1- (point)) (point) nil))
  7330. (and (not (bolp)) (looking-at "\n") (forward-char 1))
  7331. (let ((bbb (point)))
  7332. (insert-before-markers txt)
  7333. (org-reinstall-markers-in-region bbb)
  7334. (move-marker ins-point bbb))
  7335. (or (bolp) (insert "\n"))
  7336. (setq ins-end (point))
  7337. (goto-char ins-point)
  7338. (org-skip-whitespace)
  7339. (when (and (< arg 0)
  7340. (org-first-sibling-p)
  7341. (> ne-ins ne-beg))
  7342. ;; Move whitespace back to beginning
  7343. (save-excursion
  7344. (goto-char ins-end)
  7345. (let ((kill-whole-line t))
  7346. (kill-line (- ne-ins ne-beg)) (point)))
  7347. (insert (make-string (- ne-ins ne-beg) ?\n)))
  7348. (move-marker ins-point nil)
  7349. (if folded
  7350. (hide-subtree)
  7351. (org-show-entry)
  7352. (show-children)
  7353. (org-cycle-hide-drawers 'children))
  7354. (org-clean-visibility-after-subtree-move)
  7355. ;; move back to the initial column we were at
  7356. (move-to-column col)))
  7357. (defvar org-subtree-clip ""
  7358. "Clipboard for cut and paste of subtrees.
  7359. This is actually only a copy of the kill, because we use the normal kill
  7360. ring. We need it to check if the kill was created by `org-copy-subtree'.")
  7361. (defvar org-subtree-clip-folded nil
  7362. "Was the last copied subtree folded?
  7363. This is used to fold the tree back after pasting.")
  7364. (defun org-cut-subtree (&optional n)
  7365. "Cut the current subtree into the clipboard.
  7366. With prefix arg N, cut this many sequential subtrees.
  7367. This is a short-hand for marking the subtree and then cutting it."
  7368. (interactive "p")
  7369. (org-copy-subtree n 'cut))
  7370. (defun org-copy-subtree (&optional n cut force-store-markers nosubtrees)
  7371. "Copy the current subtree it in the clipboard.
  7372. With prefix arg N, copy this many sequential subtrees.
  7373. This is a short-hand for marking the subtree and then copying it.
  7374. If CUT is non-nil, actually cut the subtree.
  7375. If FORCE-STORE-MARKERS is non-nil, store the relative locations
  7376. of some markers in the region, even if CUT is non-nil. This is
  7377. useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
  7378. (interactive "p")
  7379. (let (beg end folded (beg0 (point)))
  7380. (if (org-called-interactively-p 'any)
  7381. (org-back-to-heading nil) ; take what looks like a subtree
  7382. (org-back-to-heading t)) ; take what is really there
  7383. (setq beg (point))
  7384. (skip-chars-forward " \t\r\n")
  7385. (save-match-data
  7386. (if nosubtrees
  7387. (outline-next-heading)
  7388. (save-excursion (outline-end-of-heading)
  7389. (setq folded (outline-invisible-p)))
  7390. (condition-case nil
  7391. (org-forward-heading-same-level (1- n) t)
  7392. (error nil))
  7393. (org-end-of-subtree t t)))
  7394. (setq end (point))
  7395. (goto-char beg0)
  7396. (when (> end beg)
  7397. (setq org-subtree-clip-folded folded)
  7398. (when (or cut force-store-markers)
  7399. (org-save-markers-in-region beg end))
  7400. (if cut (kill-region beg end) (copy-region-as-kill beg end))
  7401. (setq org-subtree-clip (current-kill 0))
  7402. (message "%s: Subtree(s) with %d characters"
  7403. (if cut "Cut" "Copied")
  7404. (length org-subtree-clip)))))
  7405. (defun org-paste-subtree (&optional level tree for-yank)
  7406. "Paste the clipboard as a subtree, with modification of headline level.
  7407. The entire subtree is promoted or demoted in order to match a new headline
  7408. level.
  7409. If the cursor is at the beginning of a headline, the same level as
  7410. that headline is used to paste the tree.
  7411. If not, the new level is derived from the *visible* headings
  7412. before and after the insertion point, and taken to be the inferior headline
  7413. level of the two. So if the previous visible heading is level 3 and the
  7414. next is level 4 (or vice versa), level 4 will be used for insertion.
  7415. This makes sure that the subtree remains an independent subtree and does
  7416. not swallow low level entries.
  7417. You can also force a different level, either by using a numeric prefix
  7418. argument, or by inserting the heading marker by hand. For example, if the
  7419. cursor is after \"*****\", then the tree will be shifted to level 5.
  7420. If optional TREE is given, use this text instead of the kill ring.
  7421. When FOR-YANK is set, this is called by `org-yank'. In this case, do not
  7422. move back over whitespace before inserting, and move point to the end of
  7423. the inserted text when done."
  7424. (interactive "P")
  7425. (setq tree (or tree (and kill-ring (current-kill 0))))
  7426. (unless (org-kill-is-subtree-p tree)
  7427. (user-error "%s"
  7428. (substitute-command-keys
  7429. "The kill is not a (set of) tree(s) - please use \\[yank] to yank anyway")))
  7430. (org-with-limited-levels
  7431. (let* ((visp (not (outline-invisible-p)))
  7432. (txt tree)
  7433. (^re_ "\\(\\*+\\)[ \t]*")
  7434. (old-level (if (string-match org-outline-regexp-bol txt)
  7435. (- (match-end 0) (match-beginning 0) 1)
  7436. -1))
  7437. (force-level (cond (level (prefix-numeric-value level))
  7438. ((and (looking-at "[ \t]*$")
  7439. (string-match
  7440. "^\\*+$" (buffer-substring
  7441. (point-at-bol) (point))))
  7442. (- (match-end 1) (match-beginning 1)))
  7443. ((and (bolp)
  7444. (looking-at org-outline-regexp))
  7445. (- (match-end 0) (point) 1))))
  7446. (previous-level (save-excursion
  7447. (condition-case nil
  7448. (progn
  7449. (outline-previous-visible-heading 1)
  7450. (if (looking-at ^re_)
  7451. (- (match-end 0) (match-beginning 0) 1)
  7452. 1))
  7453. (error 1))))
  7454. (next-level (save-excursion
  7455. (condition-case nil
  7456. (progn
  7457. (or (looking-at org-outline-regexp)
  7458. (outline-next-visible-heading 1))
  7459. (if (looking-at ^re_)
  7460. (- (match-end 0) (match-beginning 0) 1)
  7461. 1))
  7462. (error 1))))
  7463. (new-level (or force-level (max previous-level next-level)))
  7464. (shift (if (or (= old-level -1)
  7465. (= new-level -1)
  7466. (= old-level new-level))
  7467. 0
  7468. (- new-level old-level)))
  7469. (delta (if (> shift 0) -1 1))
  7470. (func (if (> shift 0) 'org-demote 'org-promote))
  7471. (org-odd-levels-only nil)
  7472. beg end newend)
  7473. ;; Remove the forced level indicator
  7474. (if force-level
  7475. (delete-region (point-at-bol) (point)))
  7476. ;; Paste
  7477. (beginning-of-line (if (bolp) 1 2))
  7478. (setq beg (point))
  7479. (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
  7480. (insert-before-markers txt)
  7481. (unless (string-match "\n\\'" txt) (insert "\n"))
  7482. (setq newend (point))
  7483. (org-reinstall-markers-in-region beg)
  7484. (setq end (point))
  7485. (goto-char beg)
  7486. (skip-chars-forward " \t\n\r")
  7487. (setq beg (point))
  7488. (if (and (outline-invisible-p) visp)
  7489. (save-excursion (outline-show-heading)))
  7490. ;; Shift if necessary
  7491. (unless (= shift 0)
  7492. (save-restriction
  7493. (narrow-to-region beg end)
  7494. (while (not (= shift 0))
  7495. (org-map-region func (point-min) (point-max))
  7496. (setq shift (+ delta shift)))
  7497. (goto-char (point-min))
  7498. (setq newend (point-max))))
  7499. (when (or (org-called-interactively-p 'interactive) for-yank)
  7500. (message "Clipboard pasted as level %d subtree" new-level))
  7501. (if (and (not for-yank) ; in this case, org-yank will decide about folding
  7502. kill-ring
  7503. (eq org-subtree-clip (current-kill 0))
  7504. org-subtree-clip-folded)
  7505. ;; The tree was folded before it was killed/copied
  7506. (hide-subtree))
  7507. (and for-yank (goto-char newend)))))
  7508. (defun org-kill-is-subtree-p (&optional txt)
  7509. "Check if the current kill is an outline subtree, or a set of trees.
  7510. Returns nil if kill does not start with a headline, or if the first
  7511. headline level is not the largest headline level in the tree.
  7512. So this will actually accept several entries of equal levels as well,
  7513. which is OK for `org-paste-subtree'.
  7514. If optional TXT is given, check this string instead of the current kill."
  7515. (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
  7516. (re (org-get-limited-outline-regexp))
  7517. (^re (concat "^" re))
  7518. (start-level (and kill
  7519. (string-match
  7520. (concat "\\`\\([ \t\n\r]*?\n\\)?\\(" re "\\)")
  7521. kill)
  7522. (- (match-end 2) (match-beginning 2) 1)))
  7523. (start (1+ (or (match-beginning 2) -1))))
  7524. (if (not start-level)
  7525. (progn
  7526. nil) ;; does not even start with a heading
  7527. (catch 'exit
  7528. (while (setq start (string-match ^re kill (1+ start)))
  7529. (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
  7530. (throw 'exit nil)))
  7531. t))))
  7532. (defvar org-markers-to-move nil
  7533. "Markers that should be moved with a cut-and-paste operation.
  7534. Those markers are stored together with their positions relative to
  7535. the start of the region.")
  7536. (defun org-save-markers-in-region (beg end)
  7537. "Check markers in region.
  7538. If these markers are between BEG and END, record their position relative
  7539. to BEG, so that after moving the block of text, we can put the markers back
  7540. into place.
  7541. This function gets called just before an entry or tree gets cut from the
  7542. buffer. After re-insertion, `org-reinstall-markers-in-region' must be
  7543. called immediately, to move the markers with the entries."
  7544. (setq org-markers-to-move nil)
  7545. (when (featurep 'org-clock)
  7546. (org-clock-save-markers-for-cut-and-paste beg end))
  7547. (when (featurep 'org-agenda)
  7548. (org-agenda-save-markers-for-cut-and-paste beg end)))
  7549. (defun org-check-and-save-marker (marker beg end)
  7550. "Check if MARKER is between BEG and END.
  7551. If yes, remember the marker and the distance to BEG."
  7552. (when (and (marker-buffer marker)
  7553. (equal (marker-buffer marker) (current-buffer)))
  7554. (if (and (>= marker beg) (< marker end))
  7555. (push (cons marker (- marker beg)) org-markers-to-move))))
  7556. (defun org-reinstall-markers-in-region (beg)
  7557. "Move all remembered markers to their position relative to BEG."
  7558. (mapc (lambda (x)
  7559. (move-marker (car x) (+ beg (cdr x))))
  7560. org-markers-to-move)
  7561. (setq org-markers-to-move nil))
  7562. (defun org-narrow-to-subtree ()
  7563. "Narrow buffer to the current subtree."
  7564. (interactive)
  7565. (save-excursion
  7566. (save-match-data
  7567. (org-with-limited-levels
  7568. (narrow-to-region
  7569. (progn (org-back-to-heading t) (point))
  7570. (progn (org-end-of-subtree t t)
  7571. (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
  7572. (point)))))))
  7573. (defun org-narrow-to-block ()
  7574. "Narrow buffer to the current block."
  7575. (interactive)
  7576. (let* ((case-fold-search t)
  7577. (blockp (org-between-regexps-p "^[ \t]*#\\+begin_.*"
  7578. "^[ \t]*#\\+end_.*")))
  7579. (if blockp
  7580. (narrow-to-region (car blockp) (cdr blockp))
  7581. (user-error "Not in a block"))))
  7582. (eval-when-compile
  7583. (defvar org-property-drawer-re))
  7584. (defvar org-property-start-re) ;; defined below
  7585. (defun org-clone-subtree-with-time-shift (n &optional shift)
  7586. "Clone the task (subtree) at point N times.
  7587. The clones will be inserted as siblings.
  7588. In interactive use, the user will be prompted for the number of
  7589. clones to be produced. If the entry has a timestamp, the user
  7590. will also be prompted for a time shift, which may be a repeater
  7591. as used in time stamps, for example `+3d'. To disable this,
  7592. you can call the function with a universal prefix argument.
  7593. When a valid repeater is given and the entry contains any time
  7594. stamps, the clones will become a sequence in time, with time
  7595. stamps in the subtree shifted for each clone produced. If SHIFT
  7596. is nil or the empty string, time stamps will be left alone. The
  7597. ID property of the original subtree is removed.
  7598. If the original subtree did contain time stamps with a repeater,
  7599. the following will happen:
  7600. - the repeater will be removed in each clone
  7601. - an additional clone will be produced, with the current, unshifted
  7602. date(s) in the entry.
  7603. - the original entry will be placed *after* all the clones, with
  7604. repeater intact.
  7605. - the start days in the repeater in the original entry will be shifted
  7606. to past the last clone.
  7607. In this way you can spell out a number of instances of a repeating task,
  7608. and still retain the repeater to cover future instances of the task."
  7609. (interactive "nNumber of clones to produce: ")
  7610. (let ((shift
  7611. (or shift
  7612. (if (and (not (equal current-prefix-arg '(4)))
  7613. (save-excursion
  7614. (re-search-forward org-ts-regexp-both
  7615. (save-excursion
  7616. (org-end-of-subtree t)
  7617. (point)) t)))
  7618. (read-from-minibuffer
  7619. "Date shift per clone (e.g. +1w, empty to copy unchanged): ")
  7620. ""))) ;; No time shift
  7621. (n-no-remove -1)
  7622. (drawer-re org-drawer-regexp)
  7623. beg end template task idprop
  7624. shift-n shift-what doshift nmin nmax)
  7625. (if (not (and (integerp n) (> n 0)))
  7626. (error "Invalid number of replications %s" n))
  7627. (if (and (setq doshift (and (stringp shift) (string-match "\\S-" shift)))
  7628. (not (string-match "\\`[ \t]*\\+?\\([0-9]+\\)\\([hdwmy]\\)[ \t]*\\'"
  7629. shift)))
  7630. (error "Invalid shift specification %s" shift))
  7631. (when doshift
  7632. (setq shift-n (string-to-number (match-string 1 shift))
  7633. shift-what (cdr (assoc (match-string 2 shift)
  7634. '(("d" . day) ("w" . week)
  7635. ("m" . month) ("y" . year))))))
  7636. (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
  7637. (setq nmin 1 nmax n)
  7638. (org-back-to-heading t)
  7639. (setq beg (point))
  7640. (setq idprop (org-entry-get nil "ID"))
  7641. (org-end-of-subtree t t)
  7642. (or (bolp) (insert "\n"))
  7643. (setq end (point))
  7644. (setq template (buffer-substring beg end))
  7645. (when (and doshift
  7646. (string-match "<[^<>\n]+ [.+]?\\+[0-9]+[hdwmy][^<>\n]*>" template))
  7647. (delete-region beg end)
  7648. (setq end beg)
  7649. (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
  7650. (goto-char end)
  7651. (loop for n from nmin to nmax do
  7652. ;; prepare clone
  7653. (with-temp-buffer
  7654. (insert template)
  7655. (org-mode)
  7656. (goto-char (point-min))
  7657. (org-show-subtree)
  7658. (and idprop (if org-clone-delete-id
  7659. (org-entry-delete nil "ID")
  7660. (org-id-get-create t)))
  7661. (unless (= n 0)
  7662. (while (re-search-forward "^[ \t]*CLOCK:.*$" nil t)
  7663. (kill-whole-line))
  7664. (goto-char (point-min))
  7665. (while (re-search-forward drawer-re nil t)
  7666. (mapc (lambda (d)
  7667. (org-remove-empty-drawer-at d (point))) org-drawers)))
  7668. (goto-char (point-min))
  7669. (when doshift
  7670. (while (re-search-forward org-ts-regexp-both nil t)
  7671. (org-timestamp-change (* n shift-n) shift-what))
  7672. (unless (= n n-no-remove)
  7673. (goto-char (point-min))
  7674. (while (re-search-forward org-ts-regexp nil t)
  7675. (save-excursion
  7676. (goto-char (match-beginning 0))
  7677. (if (looking-at "<[^<>\n]+\\( +[.+]?\\+[0-9]+[hdwmy]\\)")
  7678. (delete-region (match-beginning 1) (match-end 1)))))))
  7679. (setq task (buffer-string)))
  7680. (insert task))
  7681. (goto-char beg)))
  7682. ;;; Outline Sorting
  7683. (defun org-sort (with-case)
  7684. "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
  7685. Optional argument WITH-CASE means sort case-sensitively."
  7686. (interactive "P")
  7687. (cond
  7688. ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
  7689. ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
  7690. (t
  7691. (org-call-with-arg 'org-sort-entries with-case))))
  7692. (defun org-sort-remove-invisible (s)
  7693. "Remove invisible links from string S."
  7694. (remove-text-properties 0 (length s) org-rm-props s)
  7695. (while (string-match org-bracket-link-regexp s)
  7696. (setq s (replace-match (if (match-end 2)
  7697. (match-string 3 s)
  7698. (match-string 1 s)) t t s)))
  7699. (let ((st (format " %s " s)))
  7700. (while (string-match org-emph-re st)
  7701. (setq st (replace-match (format " %s " (match-string 4 st)) t t st)))
  7702. (setq s (substring st 1 -1)))
  7703. s)
  7704. (defvar org-priority-regexp) ; defined later in the file
  7705. (defvar org-after-sorting-entries-or-items-hook nil
  7706. "Hook that is run after a bunch of entries or items have been sorted.
  7707. When children are sorted, the cursor is in the parent line when this
  7708. hook gets called. When a region or a plain list is sorted, the cursor
  7709. will be in the first entry of the sorted region/list.")
  7710. (defun org-sort-entries
  7711. (&optional with-case sorting-type getkey-func compare-func property)
  7712. "Sort entries on a certain level of an outline tree.
  7713. If there is an active region, the entries in the region are sorted.
  7714. Else, if the cursor is before the first entry, sort the top-level items.
  7715. Else, the children of the entry at point are sorted.
  7716. Sorting can be alphabetically, numerically, by date/time as given by
  7717. a time stamp, by a property, by priority order, or by a custom function.
  7718. The command prompts for the sorting type unless it has been given to the
  7719. function through the SORTING-TYPE argument, which needs to be a character,
  7720. \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?o ?O ?r ?R ?f ?F). Here is the
  7721. precise meaning of each character:
  7722. n Numerically, by converting the beginning of the entry/item to a number.
  7723. a Alphabetically, ignoring the TODO keyword and the priority, if any.
  7724. o By order of TODO keywords.
  7725. t By date/time, either the first active time stamp in the entry, or, if
  7726. none exist, by the first inactive one.
  7727. s By the scheduled date/time.
  7728. d By deadline date/time.
  7729. c By creation time, which is assumed to be the first inactive time stamp
  7730. at the beginning of a line.
  7731. p By priority according to the cookie.
  7732. r By the value of a property.
  7733. Capital letters will reverse the sort order.
  7734. If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
  7735. called with point at the beginning of the record. It must return either
  7736. a string or a number that should serve as the sorting key for that record.
  7737. Comparing entries ignores case by default. However, with an optional argument
  7738. WITH-CASE, the sorting considers case as well.
  7739. Sorting is done against the visible part of the headlines, it ignores hidden
  7740. links."
  7741. (interactive "P")
  7742. (let ((case-func (if with-case 'identity 'downcase))
  7743. (cmstr
  7744. ;; The clock marker is lost when using `sort-subr', let's
  7745. ;; store the clocking string.
  7746. (when (equal (marker-buffer org-clock-marker) (current-buffer))
  7747. (save-excursion
  7748. (goto-char org-clock-marker)
  7749. (looking-back "^.*") (match-string-no-properties 0))))
  7750. start beg end stars re re2
  7751. txt what tmp)
  7752. ;; Find beginning and end of region to sort
  7753. (cond
  7754. ((org-region-active-p)
  7755. ;; we will sort the region
  7756. (setq end (region-end)
  7757. what "region")
  7758. (goto-char (region-beginning))
  7759. (if (not (org-at-heading-p)) (outline-next-heading))
  7760. (setq start (point)))
  7761. ((or (org-at-heading-p)
  7762. (condition-case nil (progn (org-back-to-heading) t) (error nil)))
  7763. ;; we will sort the children of the current headline
  7764. (org-back-to-heading)
  7765. (setq start (point)
  7766. end (progn (org-end-of-subtree t t)
  7767. (or (bolp) (insert "\n"))
  7768. (org-back-over-empty-lines)
  7769. (point))
  7770. what "children")
  7771. (goto-char start)
  7772. (show-subtree)
  7773. (outline-next-heading))
  7774. (t
  7775. ;; we will sort the top-level entries in this file
  7776. (goto-char (point-min))
  7777. (or (org-at-heading-p) (outline-next-heading))
  7778. (setq start (point))
  7779. (goto-char (point-max))
  7780. (beginning-of-line 1)
  7781. (when (looking-at ".*?\\S-")
  7782. ;; File ends in a non-white line
  7783. (end-of-line 1)
  7784. (insert "\n"))
  7785. (setq end (point-max))
  7786. (setq what "top-level")
  7787. (goto-char start)
  7788. (show-all)))
  7789. (setq beg (point))
  7790. (if (>= beg end) (user-error "Nothing to sort"))
  7791. (looking-at "\\(\\*+\\)")
  7792. (setq stars (match-string 1)
  7793. re (concat "^" (regexp-quote stars) " +")
  7794. re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[ \t\n]")
  7795. txt (buffer-substring beg end))
  7796. (if (not (equal (substring txt -1) "\n")) (setq txt (concat txt "\n")))
  7797. (if (and (not (equal stars "*")) (string-match re2 txt))
  7798. (user-error "Region to sort contains a level above the first entry"))
  7799. (unless sorting-type
  7800. (message
  7801. "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
  7802. [t]ime [s]cheduled [d]eadline [c]reated
  7803. A/N/P/R/O/F/T/S/D/C means reversed:"
  7804. what)
  7805. (setq sorting-type (read-char-exclusive))
  7806. (unless getkey-func
  7807. (and (= (downcase sorting-type) ?f)
  7808. (setq getkey-func
  7809. (org-icompleting-read "Sort using function: "
  7810. obarray 'fboundp t nil nil))
  7811. (setq getkey-func (intern getkey-func))))
  7812. (and (= (downcase sorting-type) ?r)
  7813. (not property)
  7814. (setq property
  7815. (org-icompleting-read "Property: "
  7816. (mapcar 'list (org-buffer-property-keys t))
  7817. nil t))))
  7818. (message "Sorting entries...")
  7819. (save-restriction
  7820. (narrow-to-region start end)
  7821. (let ((dcst (downcase sorting-type))
  7822. (case-fold-search nil)
  7823. (now (current-time)))
  7824. (sort-subr
  7825. (/= dcst sorting-type)
  7826. ;; This function moves to the beginning character of the "record" to
  7827. ;; be sorted.
  7828. (lambda nil
  7829. (if (re-search-forward re nil t)
  7830. (goto-char (match-beginning 0))
  7831. (goto-char (point-max))))
  7832. ;; This function moves to the last character of the "record" being
  7833. ;; sorted.
  7834. (lambda nil
  7835. (save-match-data
  7836. (condition-case nil
  7837. (outline-forward-same-level 1)
  7838. (error
  7839. (goto-char (point-max))))))
  7840. ;; This function returns the value that gets sorted against.
  7841. (lambda nil
  7842. (cond
  7843. ((= dcst ?n)
  7844. (if (looking-at org-complex-heading-regexp)
  7845. (string-to-number (org-sort-remove-invisible (match-string 4)))
  7846. nil))
  7847. ((= dcst ?a)
  7848. (if (looking-at org-complex-heading-regexp)
  7849. (funcall case-func (org-sort-remove-invisible (match-string 4)))
  7850. nil))
  7851. ((= dcst ?t)
  7852. (let ((end (save-excursion (outline-next-heading) (point))))
  7853. (if (or (re-search-forward org-ts-regexp end t)
  7854. (re-search-forward org-ts-regexp-both end t))
  7855. (org-time-string-to-seconds (match-string 0))
  7856. (org-float-time now))))
  7857. ((= dcst ?c)
  7858. (let ((end (save-excursion (outline-next-heading) (point))))
  7859. (if (re-search-forward
  7860. (concat "^[ \t]*\\[" org-ts-regexp1 "\\]")
  7861. end t)
  7862. (org-time-string-to-seconds (match-string 0))
  7863. (org-float-time now))))
  7864. ((= dcst ?s)
  7865. (let ((end (save-excursion (outline-next-heading) (point))))
  7866. (if (re-search-forward org-scheduled-time-regexp end t)
  7867. (org-time-string-to-seconds (match-string 1))
  7868. (org-float-time now))))
  7869. ((= dcst ?d)
  7870. (let ((end (save-excursion (outline-next-heading) (point))))
  7871. (if (re-search-forward org-deadline-time-regexp end t)
  7872. (org-time-string-to-seconds (match-string 1))
  7873. (org-float-time now))))
  7874. ((= dcst ?p)
  7875. (if (re-search-forward org-priority-regexp (point-at-eol) t)
  7876. (string-to-char (match-string 2))
  7877. org-default-priority))
  7878. ((= dcst ?r)
  7879. (or (org-entry-get nil property) ""))
  7880. ((= dcst ?o)
  7881. (if (looking-at org-complex-heading-regexp)
  7882. (- 9999 (length (member (match-string 2)
  7883. org-todo-keywords-1)))))
  7884. ((= dcst ?f)
  7885. (if getkey-func
  7886. (progn
  7887. (setq tmp (funcall getkey-func))
  7888. (if (stringp tmp) (setq tmp (funcall case-func tmp)))
  7889. tmp)
  7890. (error "Invalid key function `%s'" getkey-func)))
  7891. (t (error "Invalid sorting type `%c'" sorting-type))))
  7892. nil
  7893. (cond
  7894. ((= dcst ?a) 'string<)
  7895. ((= dcst ?f) compare-func)
  7896. ((member dcst '(?p ?t ?s ?d ?c)) '<)))))
  7897. (run-hooks 'org-after-sorting-entries-or-items-hook)
  7898. ;; Reset the clock marker if needed
  7899. (when cmstr
  7900. (save-excursion
  7901. (goto-char start)
  7902. (search-forward cmstr nil t)
  7903. (move-marker org-clock-marker (point))))
  7904. (message "Sorting entries...done")))
  7905. (defun org-do-sort (table what &optional with-case sorting-type)
  7906. "Sort TABLE of WHAT according to SORTING-TYPE.
  7907. The user will be prompted for the SORTING-TYPE if the call to this
  7908. function does not specify it. WHAT is only for the prompt, to indicate
  7909. what is being sorted. The sorting key will be extracted from
  7910. the car of the elements of the table.
  7911. If WITH-CASE is non-nil, the sorting will be case-sensitive."
  7912. (unless sorting-type
  7913. (message
  7914. "Sort %s: [a]lphabetic, [n]umeric, [t]ime. A/N/T means reversed:"
  7915. what)
  7916. (setq sorting-type (read-char-exclusive)))
  7917. (let ((dcst (downcase sorting-type))
  7918. extractfun comparefun)
  7919. ;; Define the appropriate functions
  7920. (cond
  7921. ((= dcst ?n)
  7922. (setq extractfun 'string-to-number
  7923. comparefun (if (= dcst sorting-type) '< '>)))
  7924. ((= dcst ?a)
  7925. (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
  7926. (lambda(x) (downcase (org-sort-remove-invisible x))))
  7927. comparefun (if (= dcst sorting-type)
  7928. 'string<
  7929. (lambda (a b) (and (not (string< a b))
  7930. (not (string= a b)))))))
  7931. ((= dcst ?t)
  7932. (setq extractfun
  7933. (lambda (x)
  7934. (if (or (string-match org-ts-regexp x)
  7935. (string-match org-ts-regexp-both x))
  7936. (org-float-time
  7937. (org-time-string-to-time (match-string 0 x)))
  7938. 0))
  7939. comparefun (if (= dcst sorting-type) '< '>)))
  7940. (t (error "Invalid sorting type `%c'" sorting-type)))
  7941. (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
  7942. table)
  7943. (lambda (a b) (funcall comparefun (car a) (car b))))))
  7944. ;;; The orgstruct minor mode
  7945. ;; Define a minor mode which can be used in other modes in order to
  7946. ;; integrate the org-mode structure editing commands.
  7947. ;; This is really a hack, because the org-mode structure commands use
  7948. ;; keys which normally belong to the major mode. Here is how it
  7949. ;; works: The minor mode defines all the keys necessary to operate the
  7950. ;; structure commands, but wraps the commands into a function which
  7951. ;; tests if the cursor is currently at a headline or a plain list
  7952. ;; item. If that is the case, the structure command is used,
  7953. ;; temporarily setting many Org-mode variables like regular
  7954. ;; expressions for filling etc. However, when any of those keys is
  7955. ;; used at a different location, function uses `key-binding' to look
  7956. ;; up if the key has an associated command in another currently active
  7957. ;; keymap (minor modes, major mode, global), and executes that
  7958. ;; command. There might be problems if any of the keys is otherwise
  7959. ;; used as a prefix key.
  7960. (defcustom orgstruct-heading-prefix-regexp nil
  7961. "Regexp that matches the custom prefix of Org headlines in
  7962. orgstruct(++)-mode."
  7963. :group 'org
  7964. :version "24.4"
  7965. :package-version '(Org . "8.0")
  7966. :type 'string)
  7967. ;;;###autoload(put 'orgstruct-heading-prefix-regexp 'safe-local-variable 'stringp)
  7968. (defcustom orgstruct-setup-hook nil
  7969. "Hook run after orgstruct-mode-map is filled."
  7970. :group 'org
  7971. :version "24.4"
  7972. :package-version '(Org . "8.0")
  7973. :type 'hook)
  7974. (defvar orgstruct-initialized nil)
  7975. (defvar org-local-vars nil
  7976. "List of local variables, for use by `orgstruct-mode'.")
  7977. ;;;###autoload
  7978. (define-minor-mode orgstruct-mode
  7979. "Toggle the minor mode `orgstruct-mode'.
  7980. This mode is for using Org-mode structure commands in other
  7981. modes. The following keys behave as if Org-mode were active, if
  7982. the cursor is on a headline, or on a plain list item (both as
  7983. defined by Org-mode)."
  7984. nil " OrgStruct" (make-sparse-keymap)
  7985. (funcall (if orgstruct-mode
  7986. 'add-to-invisibility-spec
  7987. 'remove-from-invisibility-spec)
  7988. '(outline . t))
  7989. (when orgstruct-mode
  7990. (org-load-modules-maybe)
  7991. (unless orgstruct-initialized
  7992. (orgstruct-setup)
  7993. (setq orgstruct-initialized t))))
  7994. ;;;###autoload
  7995. (defun turn-on-orgstruct ()
  7996. "Unconditionally turn on `orgstruct-mode'."
  7997. (orgstruct-mode 1))
  7998. (defvar org-fb-vars nil)
  7999. (make-variable-buffer-local 'org-fb-vars)
  8000. (defun orgstruct++-mode (&optional arg)
  8001. "Toggle `orgstruct-mode', the enhanced version of it.
  8002. In addition to setting orgstruct-mode, this also exports all
  8003. indentation and autofilling variables from org-mode into the
  8004. buffer. It will also recognize item context in multiline items."
  8005. (interactive "P")
  8006. (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
  8007. (if (< arg 1)
  8008. (progn (orgstruct-mode -1)
  8009. (mapc (lambda(v)
  8010. (org-set-local (car v)
  8011. (if (eq (car-safe (cadr v)) 'quote) (cadadr v) (cadr v))))
  8012. org-fb-vars))
  8013. (orgstruct-mode 1)
  8014. (setq org-fb-vars nil)
  8015. (unless org-local-vars
  8016. (setq org-local-vars (org-get-local-variables)))
  8017. (let (var val)
  8018. (mapc
  8019. (lambda (x)
  8020. (when (string-match
  8021. "^\\(paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|fill-prefix\\|indent-\\)"
  8022. (symbol-name (car x)))
  8023. (setq var (car x) val (nth 1 x))
  8024. (push (list var `(quote ,(eval var))) org-fb-vars)
  8025. (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
  8026. org-local-vars)
  8027. (org-set-local 'orgstruct-is-++ t))))
  8028. (defvar orgstruct-is-++ nil
  8029. "Is `orgstruct-mode' in ++ version in the current-buffer?")
  8030. (make-variable-buffer-local 'orgstruct-is-++)
  8031. ;;;###autoload
  8032. (defun turn-on-orgstruct++ ()
  8033. "Unconditionally turn on `orgstruct++-mode'."
  8034. (orgstruct++-mode 1))
  8035. (defun orgstruct-error ()
  8036. "Error when there is no default binding for a structure key."
  8037. (interactive)
  8038. (funcall (if (fboundp 'user-error)
  8039. 'user-error
  8040. 'error)
  8041. "This key has no function outside structure elements"))
  8042. (defun orgstruct-setup ()
  8043. "Setup orgstruct keymap."
  8044. (dolist (cell '((org-demote . t)
  8045. (org-metaleft . t)
  8046. (org-metaright . t)
  8047. (org-promote . t)
  8048. (org-shiftmetaleft . t)
  8049. (org-shiftmetaright . t)
  8050. org-backward-element
  8051. org-backward-heading-same-level
  8052. org-ctrl-c-ret
  8053. org-ctrl-c-minus
  8054. org-ctrl-c-star
  8055. org-cycle
  8056. org-forward-heading-same-level
  8057. org-insert-heading
  8058. org-insert-heading-respect-content
  8059. org-kill-note-or-show-branches
  8060. org-mark-subtree
  8061. org-meta-return
  8062. org-metadown
  8063. org-metaup
  8064. org-narrow-to-subtree
  8065. org-promote-subtree
  8066. org-reveal
  8067. org-shiftdown
  8068. org-shiftleft
  8069. org-shiftmetadown
  8070. org-shiftmetaup
  8071. org-shiftright
  8072. org-shifttab
  8073. org-shifttab
  8074. org-shiftup
  8075. org-show-subtree
  8076. org-sort
  8077. org-up-element
  8078. outline-demote
  8079. outline-next-visible-heading
  8080. outline-previous-visible-heading
  8081. outline-promote
  8082. outline-up-heading
  8083. show-children))
  8084. (let ((f (or (car-safe cell) cell))
  8085. (disable-when-heading-prefix (cdr-safe cell)))
  8086. (when (fboundp f)
  8087. (let ((new-bindings))
  8088. (dolist (binding (nconc (where-is-internal f org-mode-map)
  8089. (where-is-internal f outline-mode-map)))
  8090. (push binding new-bindings)
  8091. ;; TODO use local-function-key-map
  8092. (dolist (rep '(("<tab>" . "TAB")
  8093. ("<return>" . "RET")
  8094. ("<escape>" . "ESC")
  8095. ("<delete>" . "DEL")))
  8096. (setq binding (read-kbd-macro
  8097. (let ((case-fold-search))
  8098. (replace-regexp-in-string
  8099. (regexp-quote (cdr rep))
  8100. (car rep)
  8101. (key-description binding)))))
  8102. (pushnew binding new-bindings :test 'equal)))
  8103. (dolist (binding new-bindings)
  8104. (let ((key (lookup-key orgstruct-mode-map binding)))
  8105. (when (or (not key) (numberp key))
  8106. (condition-case nil
  8107. (org-defkey orgstruct-mode-map
  8108. binding
  8109. (orgstruct-make-binding f binding disable-when-heading-prefix))
  8110. (error nil)))))))))
  8111. (run-hooks 'orgstruct-setup-hook))
  8112. (defun orgstruct-make-binding (fun key disable-when-heading-prefix)
  8113. "Create a function for binding in the structure minor mode.
  8114. FUN is the command to call inside a table. KEY is the key that
  8115. should be checked in for a command to execute outside of tables.
  8116. Non-nil DISABLE-WHEN-HEADING-PREFIX means to disable the command
  8117. if `orgstruct-heading-prefix-regexp' is non-nil."
  8118. (let ((name (concat "orgstruct-hijacker-" (symbol-name fun))))
  8119. (let ((nname name)
  8120. (i 0))
  8121. (while (fboundp (intern nname))
  8122. (setq nname (format "%s-%d" name (setq i (1+ i)))))
  8123. (setq name (intern nname)))
  8124. (eval
  8125. (let ((bindings '((org-heading-regexp
  8126. (concat "^"
  8127. orgstruct-heading-prefix-regexp
  8128. "\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ ]*$"))
  8129. (org-outline-regexp
  8130. (concat orgstruct-heading-prefix-regexp "\\*+ "))
  8131. (org-outline-regexp-bol
  8132. (concat "^" org-outline-regexp))
  8133. (outline-regexp org-outline-regexp)
  8134. (outline-heading-end-regexp "\n")
  8135. (outline-level 'org-outline-level)
  8136. (outline-heading-alist))))
  8137. `(defun ,name (arg)
  8138. ,(concat "In Structure, run `" (symbol-name fun) "'.\n"
  8139. "Outside of structure, run the binding of `"
  8140. (key-description key) "'."
  8141. (when disable-when-heading-prefix
  8142. (concat
  8143. "\nIf `orgstruct-heading-prefix-regexp' is non-nil, this command will always fall\n"
  8144. "back to the default binding due to limitations of Org's implementation of\n"
  8145. "`" (symbol-name fun) "'.")))
  8146. (interactive "p")
  8147. (let* ((disable
  8148. ,(when disable-when-heading-prefix
  8149. '(and orgstruct-heading-prefix-regexp
  8150. (not (string= orgstruct-heading-prefix-regexp "")))))
  8151. (fallback
  8152. (or disable
  8153. (not
  8154. (let* ,bindings
  8155. (org-context-p 'headline 'item
  8156. ,(when (memq fun
  8157. '(org-insert-heading
  8158. org-insert-heading-respect-content
  8159. org-meta-return))
  8160. '(when orgstruct-is-++
  8161. 'item-body))))))))
  8162. (if fallback
  8163. (let* ((orgstruct-mode)
  8164. (binding
  8165. (loop with key = ,key
  8166. for rep in
  8167. '(nil
  8168. ("<\\([^>]*\\)tab>" . "\\1TAB")
  8169. ("<\\([^>]*\\)return>" . "\\1RET")
  8170. ("<\\([^>]*\\)escape>" . "\\1ESC")
  8171. ("<\\([^>]*\\)delete>" . "\\1DEL"))
  8172. do
  8173. (when rep
  8174. (setq key (read-kbd-macro
  8175. (let ((case-fold-search))
  8176. (replace-regexp-in-string
  8177. (car rep)
  8178. (cdr rep)
  8179. (key-description key))))))
  8180. thereis (key-binding key))))
  8181. (if (keymapp binding)
  8182. (set-temporary-overlay-map binding)
  8183. (let ((func (or binding
  8184. (unless disable
  8185. 'orgstruct-error))))
  8186. (when func
  8187. (call-interactively func)))))
  8188. (org-run-like-in-org-mode
  8189. (lambda ()
  8190. (interactive)
  8191. (let* ,bindings
  8192. (call-interactively ',fun)))))))))
  8193. name))
  8194. (defun org-contextualize-keys (alist contexts)
  8195. "Return valid elements in ALIST depending on CONTEXTS.
  8196. `org-agenda-custom-commands' or `org-capture-templates' are the
  8197. values used for ALIST, and `org-agenda-custom-commands-contexts'
  8198. or `org-capture-templates-contexts' are the associated contexts
  8199. definitions."
  8200. (let ((contexts
  8201. ;; normalize contexts
  8202. (mapcar
  8203. (lambda(c) (cond ((listp (cadr c))
  8204. (list (car c) (car c) (cadr c)))
  8205. ((string= "" (cadr c))
  8206. (list (car c) (car c) (caddr c)))
  8207. (t c))) contexts))
  8208. (a alist) c r s)
  8209. ;; loop over all commands or templates
  8210. (while (setq c (pop a))
  8211. (let (vrules repl)
  8212. (cond
  8213. ((not (assoc (car c) contexts))
  8214. (push c r))
  8215. ((and (assoc (car c) contexts)
  8216. (setq vrules (org-contextualize-validate-key
  8217. (car c) contexts)))
  8218. (mapc (lambda (vr)
  8219. (when (not (equal (car vr) (cadr vr)))
  8220. (setq repl vr))) vrules)
  8221. (if (not repl) (push c r)
  8222. (push (cadr repl) s)
  8223. (push
  8224. (cons (car c)
  8225. (cdr (or (assoc (cadr repl) alist)
  8226. (error "Undefined key `%s' as contextual replacement for `%s'"
  8227. (cadr repl) (car c)))))
  8228. r))))))
  8229. ;; Return limited ALIST, possibly with keys modified, and deduplicated
  8230. (delq
  8231. nil
  8232. (delete-dups
  8233. (mapcar (lambda (x)
  8234. (let ((tpl (car x)))
  8235. (when (not (delq
  8236. nil
  8237. (mapcar (lambda(y)
  8238. (equal y tpl)) s))) x)))
  8239. (reverse r))))))
  8240. (defun org-contextualize-validate-key (key contexts)
  8241. "Check CONTEXTS for agenda or capture KEY."
  8242. (let (r rr res)
  8243. (while (setq r (pop contexts))
  8244. (mapc
  8245. (lambda (rr)
  8246. (when
  8247. (and (equal key (car r))
  8248. (if (functionp rr) (funcall rr)
  8249. (or (and (eq (car rr) 'in-file)
  8250. (buffer-file-name)
  8251. (string-match (cdr rr) (buffer-file-name)))
  8252. (and (eq (car rr) 'in-mode)
  8253. (string-match (cdr rr) (symbol-name major-mode)))
  8254. (and (eq (car rr) 'in-buffer)
  8255. (string-match (cdr rr) (buffer-name)))
  8256. (when (and (eq (car rr) 'not-in-file)
  8257. (buffer-file-name))
  8258. (not (string-match (cdr rr) (buffer-file-name))))
  8259. (when (eq (car rr) 'not-in-mode)
  8260. (not (string-match (cdr rr) (symbol-name major-mode))))
  8261. (when (eq (car rr) 'not-in-buffer)
  8262. (not (string-match (cdr rr) (buffer-name)))))))
  8263. (push r res)))
  8264. (car (last r))))
  8265. (delete-dups (delq nil res))))
  8266. (defun org-context-p (&rest contexts)
  8267. "Check if local context is any of CONTEXTS.
  8268. Possible values in the list of contexts are `table', `headline', and `item'."
  8269. (let ((pos (point)))
  8270. (goto-char (point-at-bol))
  8271. (prog1 (or (and (memq 'table contexts)
  8272. (looking-at "[ \t]*|"))
  8273. (and (memq 'headline contexts)
  8274. (looking-at org-outline-regexp))
  8275. (and (memq 'item contexts)
  8276. (looking-at "[ \t]*\\([-+*] \\|[0-9]+[.)] \\)"))
  8277. (and (memq 'item-body contexts)
  8278. (org-in-item-p)))
  8279. (goto-char pos))))
  8280. (defun org-get-local-variables ()
  8281. "Return a list of all local variables in an Org mode buffer."
  8282. (let (varlist)
  8283. (with-current-buffer (get-buffer-create "*Org tmp*")
  8284. (erase-buffer)
  8285. (org-mode)
  8286. (setq varlist (buffer-local-variables)))
  8287. (kill-buffer "*Org tmp*")
  8288. (delq nil
  8289. (mapcar
  8290. (lambda (x)
  8291. (setq x
  8292. (if (symbolp x)
  8293. (list x)
  8294. (list (car x) (cdr x))))
  8295. (if (and (not (get (car x) 'org-state))
  8296. (string-match
  8297. "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|indent-\\)"
  8298. (symbol-name (car x))))
  8299. x nil))
  8300. varlist))))
  8301. (defun org-clone-local-variables (from-buffer &optional regexp)
  8302. "Clone local variables from FROM-BUFFER.
  8303. Optional argument REGEXP selects variables to clone."
  8304. (mapc
  8305. (lambda (pair)
  8306. (and (symbolp (car pair))
  8307. (or (null regexp)
  8308. (string-match regexp (symbol-name (car pair))))
  8309. (set (make-local-variable (car pair))
  8310. (cdr pair))))
  8311. (buffer-local-variables from-buffer)))
  8312. ;;;###autoload
  8313. (defun org-run-like-in-org-mode (cmd)
  8314. "Run a command, pretending that the current buffer is in Org-mode.
  8315. This will temporarily bind local variables that are typically bound in
  8316. Org-mode to the values they have in Org-mode, and then interactively
  8317. call CMD."
  8318. (org-load-modules-maybe)
  8319. (unless org-local-vars
  8320. (setq org-local-vars (org-get-local-variables)))
  8321. (let (binds)
  8322. (dolist (var org-local-vars)
  8323. (when (or (not (boundp (car var)))
  8324. (eq (symbol-value (car var))
  8325. (default-value (car var))))
  8326. (push (list (car var) `(quote ,(cadr var))) binds)))
  8327. (eval `(let ,binds
  8328. (call-interactively (quote ,cmd))))))
  8329. ;;;; Archiving
  8330. (defun org-get-category (&optional pos force-refresh)
  8331. "Get the category applying to position POS."
  8332. (save-match-data
  8333. (if force-refresh (org-refresh-category-properties))
  8334. (let ((pos (or pos (point))))
  8335. (or (get-text-property pos 'org-category)
  8336. (progn (org-refresh-category-properties)
  8337. (get-text-property pos 'org-category))))))
  8338. (defun org-refresh-category-properties ()
  8339. "Refresh category text properties in the buffer."
  8340. (let ((case-fold-search t)
  8341. (inhibit-read-only t)
  8342. (def-cat (cond
  8343. ((null org-category)
  8344. (if buffer-file-name
  8345. (file-name-sans-extension
  8346. (file-name-nondirectory buffer-file-name))
  8347. "???"))
  8348. ((symbolp org-category) (symbol-name org-category))
  8349. (t org-category)))
  8350. beg end cat pos optionp)
  8351. (org-with-silent-modifications
  8352. (save-excursion
  8353. (save-restriction
  8354. (widen)
  8355. (goto-char (point-min))
  8356. (put-text-property (point) (point-max) 'org-category def-cat)
  8357. (while (re-search-forward
  8358. "^\\(#\\+CATEGORY:\\|[ \t]*:CATEGORY:\\)\\(.*\\)" nil t)
  8359. (setq pos (match-end 0)
  8360. optionp (equal (char-after (match-beginning 0)) ?#)
  8361. cat (org-trim (match-string 2)))
  8362. (if optionp
  8363. (setq beg (point-at-bol) end (point-max))
  8364. (org-back-to-heading t)
  8365. (setq beg (point) end (org-end-of-subtree t t)))
  8366. (put-text-property beg end 'org-category cat)
  8367. (put-text-property beg end 'org-category-position beg)
  8368. (goto-char pos)))))))
  8369. (defun org-refresh-properties (dprop tprop)
  8370. "Refresh buffer text properties.
  8371. DPROP is the drawer property and TPROP is the corresponding text
  8372. property to set."
  8373. (let ((case-fold-search t)
  8374. (inhibit-read-only t) p)
  8375. (org-with-silent-modifications
  8376. (save-excursion
  8377. (save-restriction
  8378. (widen)
  8379. (goto-char (point-min))
  8380. (while (re-search-forward (concat "^[ \t]*:" dprop ": +\\(.*\\)[ \t]*$") nil t)
  8381. (setq p (org-match-string-no-properties 1))
  8382. (save-excursion
  8383. (org-back-to-heading t)
  8384. (put-text-property
  8385. (point-at-bol) (org-end-of-subtree t t) tprop p))))))))
  8386. ;;;; Link Stuff
  8387. ;;; Link abbreviations
  8388. (defun org-link-expand-abbrev (link)
  8389. "Apply replacements as defined in `org-link-abbrev-alist'."
  8390. (if (string-match "^\\([^:]*\\)\\(::?\\(.*\\)\\)?$" link)
  8391. (let* ((key (match-string 1 link))
  8392. (as (or (assoc key org-link-abbrev-alist-local)
  8393. (assoc key org-link-abbrev-alist)))
  8394. (tag (and (match-end 2) (match-string 3 link)))
  8395. rpl)
  8396. (if (not as)
  8397. link
  8398. (setq rpl (cdr as))
  8399. (cond
  8400. ((symbolp rpl) (funcall rpl tag))
  8401. ((string-match "%(\\([^)]+\\))" rpl)
  8402. (replace-match
  8403. (save-match-data
  8404. (funcall (intern-soft (match-string 1 rpl)) tag)) t t rpl))
  8405. ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
  8406. ((string-match "%h" rpl)
  8407. (replace-match (url-hexify-string (or tag "")) t t rpl))
  8408. (t (concat rpl tag)))))
  8409. link))
  8410. ;;; Storing and inserting links
  8411. (defvar org-insert-link-history nil
  8412. "Minibuffer history for links inserted with `org-insert-link'.")
  8413. (defvar org-stored-links nil
  8414. "Contains the links stored with `org-store-link'.")
  8415. (defvar org-store-link-plist nil
  8416. "Plist with info about the most recently link created with `org-store-link'.")
  8417. (defvar org-link-protocols nil
  8418. "Link protocols added to Org-mode using `org-add-link-type'.")
  8419. (defvar org-store-link-functions nil
  8420. "List of functions that are called to create and store a link.
  8421. Each function will be called in turn until one returns a non-nil
  8422. value. Each function should check if it is responsible for creating
  8423. this link (for example by looking at the major mode).
  8424. If not, it must exit and return nil.
  8425. If yes, it should return a non-nil value after a calling
  8426. `org-store-link-props' with a list of properties and values.
  8427. Special properties are:
  8428. :type The link prefix, like \"http\". This must be given.
  8429. :link The link, like \"http://www.astro.uva.nl/~dominik\".
  8430. This is obligatory as well.
  8431. :description Optional default description for the second pair
  8432. of brackets in an Org-mode link. The user can still change
  8433. this when inserting this link into an Org-mode buffer.
  8434. In addition to these, any additional properties can be specified
  8435. and then used in capture templates.")
  8436. (defun org-add-link-type (type &optional follow export)
  8437. "Add TYPE to the list of `org-link-types'.
  8438. Re-compute all regular expressions depending on `org-link-types'
  8439. FOLLOW and EXPORT are two functions.
  8440. FOLLOW should take the link path as the single argument and do whatever
  8441. is necessary to follow the link, for example find a file or display
  8442. a mail message.
  8443. EXPORT should format the link path for export to one of the export formats.
  8444. It should be a function accepting three arguments:
  8445. path the path of the link, the text after the prefix (like \"http:\")
  8446. desc the description of the link, if any, or a description added by
  8447. org-export-normalize-links if there is none
  8448. format the export format, a symbol like `html' or `latex' or `ascii'..
  8449. The function may use the FORMAT information to return different values
  8450. depending on the format. The return value will be put literally into
  8451. the exported file. If the return value is nil, this means Org should
  8452. do what it normally does with links which do not have EXPORT defined.
  8453. Org-mode has a built-in default for exporting links. If you are happy with
  8454. this default, there is no need to define an export function for the link
  8455. type. For a simple example of an export function, see `org-bbdb.el'."
  8456. (add-to-list 'org-link-types type t)
  8457. (org-make-link-regexps)
  8458. (if (assoc type org-link-protocols)
  8459. (setcdr (assoc type org-link-protocols) (list follow export))
  8460. (push (list type follow export) org-link-protocols)))
  8461. (defvar org-agenda-buffer-name) ; Defined in org-agenda.el
  8462. (defvar org-id-link-to-org-use-id) ; Defined in org-id.el
  8463. ;;;###autoload
  8464. (defun org-store-link (arg)
  8465. "\\<org-mode-map>Store an org-link to the current location.
  8466. This link is added to `org-stored-links' and can later be inserted
  8467. into an org-buffer with \\[org-insert-link].
  8468. For some link types, a prefix arg is interpreted.
  8469. For links to Usenet articles, arg negates `org-gnus-prefer-web-links'.
  8470. For file links, arg negates `org-context-in-file-links'.
  8471. A double prefix arg force skipping storing functions that are not
  8472. part of Org's core.
  8473. A triple prefix arg force storing a link for each line in the
  8474. active region."
  8475. (interactive "P")
  8476. (org-load-modules-maybe)
  8477. (if (and (equal arg '(64)) (org-region-active-p))
  8478. (save-excursion
  8479. (let ((end (region-end)))
  8480. (goto-char (region-beginning))
  8481. (set-mark (point))
  8482. (while (< (point-at-eol) end)
  8483. (move-end-of-line 1) (activate-mark)
  8484. (let (current-prefix-arg)
  8485. (call-interactively 'org-store-link))
  8486. (move-beginning-of-line 2)
  8487. (set-mark (point)))))
  8488. (org-with-limited-levels
  8489. (setq org-store-link-plist nil)
  8490. (let (link cpltxt desc description search
  8491. txt custom-id agenda-link sfuns sfunsn)
  8492. (cond
  8493. ;; Store a link using an external link type
  8494. ((and (not (equal arg '(16)))
  8495. (setq sfuns
  8496. (delq
  8497. nil (mapcar (lambda (f)
  8498. (let (fs) (if (funcall f) (push f fs))))
  8499. org-store-link-functions))
  8500. sfunsn (mapcar (lambda (fu) (symbol-name (car fu))) sfuns))
  8501. (or (and (cdr sfuns)
  8502. (funcall (intern
  8503. (completing-read
  8504. "Which function for creating the link? "
  8505. sfunsn t (car sfunsn)))))
  8506. (funcall (caar sfuns)))
  8507. (setq link (plist-get org-store-link-plist :link)
  8508. desc (or (plist-get org-store-link-plist
  8509. :description) link))))
  8510. ;; Store a link from a source code buffer
  8511. ((org-src-edit-buffer-p)
  8512. (let (label gc)
  8513. (while (or (not label)
  8514. (save-excursion
  8515. (save-restriction
  8516. (widen)
  8517. (goto-char (point-min))
  8518. (re-search-forward
  8519. (regexp-quote (format org-coderef-label-format label))
  8520. nil t))))
  8521. (when label (message "Label exists already") (sit-for 2))
  8522. (setq label (read-string "Code line label: " label)))
  8523. (end-of-line 1)
  8524. (setq link (format org-coderef-label-format label))
  8525. (setq gc (- 79 (length link)))
  8526. (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
  8527. (insert link)
  8528. (setq link (concat "(" label ")") desc nil)))
  8529. ;; We are in the agenda, link to referenced location
  8530. ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
  8531. (let ((m (or (get-text-property (point) 'org-hd-marker)
  8532. (get-text-property (point) 'org-marker))))
  8533. (when m
  8534. (org-with-point-at m
  8535. (setq agenda-link
  8536. (if (org-called-interactively-p 'any)
  8537. (call-interactively 'org-store-link)
  8538. (org-store-link nil)))))))
  8539. ((eq major-mode 'calendar-mode)
  8540. (let ((cd (calendar-cursor-to-date)))
  8541. (setq link
  8542. (format-time-string
  8543. (car org-time-stamp-formats)
  8544. (apply 'encode-time
  8545. (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
  8546. nil nil nil))))
  8547. (org-store-link-props :type "calendar" :date cd)))
  8548. ((eq major-mode 'help-mode)
  8549. (setq link (concat "help:" (save-excursion
  8550. (goto-char (point-min))
  8551. (looking-at "^[^ ]+")
  8552. (match-string 0))))
  8553. (org-store-link-props :type "help"))
  8554. ((eq major-mode 'w3-mode)
  8555. (setq cpltxt (if (and (buffer-name)
  8556. (not (string-match "Untitled" (buffer-name))))
  8557. (buffer-name)
  8558. (url-view-url t))
  8559. link (url-view-url t))
  8560. (org-store-link-props :type "w3" :url (url-view-url t)))
  8561. ((eq major-mode 'image-mode)
  8562. (setq cpltxt (concat "file:"
  8563. (abbreviate-file-name buffer-file-name))
  8564. link cpltxt)
  8565. (org-store-link-props :type "image" :file buffer-file-name))
  8566. ;; In dired, store a link to the file of the current line
  8567. ((eq major-mode 'dired-mode)
  8568. (let ((file (dired-get-filename nil t)))
  8569. (setq file (if file
  8570. (abbreviate-file-name
  8571. (expand-file-name (dired-get-filename nil t)))
  8572. ;; otherwise, no file so use current directory.
  8573. default-directory))
  8574. (setq cpltxt (concat "file:" file)
  8575. link cpltxt)))
  8576. ((setq search (run-hook-with-args-until-success
  8577. 'org-create-file-search-functions))
  8578. (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
  8579. "::" search))
  8580. (setq cpltxt (or description link)))
  8581. ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
  8582. (setq custom-id (org-entry-get nil "CUSTOM_ID"))
  8583. (cond
  8584. ;; Store a link using the target at point
  8585. ((org-in-regexp "[^<]<<\\([^<>]+\\)>>[^>]" 1)
  8586. (setq cpltxt
  8587. (concat "file:"
  8588. (abbreviate-file-name
  8589. (buffer-file-name (buffer-base-buffer)))
  8590. "::" (match-string 1))
  8591. link cpltxt))
  8592. ((and (featurep 'org-id)
  8593. (or (eq org-id-link-to-org-use-id t)
  8594. (and (org-called-interactively-p 'any)
  8595. (or (eq org-id-link-to-org-use-id 'create-if-interactive)
  8596. (and (eq org-id-link-to-org-use-id
  8597. 'create-if-interactive-and-no-custom-id)
  8598. (not custom-id))))
  8599. (and org-id-link-to-org-use-id (org-entry-get nil "ID"))))
  8600. ;; Store a link using the ID at point
  8601. (setq link (condition-case nil
  8602. (prog1 (org-id-store-link)
  8603. (setq desc (plist-get org-store-link-plist
  8604. :description)))
  8605. (error
  8606. ;; Probably before first headline, link only to file
  8607. (concat "file:"
  8608. (abbreviate-file-name
  8609. (buffer-file-name (buffer-base-buffer))))))))
  8610. (t
  8611. ;; Just link to current headline
  8612. (setq cpltxt (concat "file:"
  8613. (abbreviate-file-name
  8614. (buffer-file-name (buffer-base-buffer)))))
  8615. ;; Add a context search string
  8616. (when (org-xor org-context-in-file-links arg)
  8617. (let* ((ee (org-element-at-point))
  8618. (et (org-element-type ee))
  8619. (ev (plist-get (cadr ee) :value))
  8620. (ek (plist-get (cadr ee) :key))
  8621. (eok (and (stringp ek) (string-match "name" ek))))
  8622. (setq txt (cond
  8623. ((org-at-heading-p) nil)
  8624. ((and (eq et 'keyword) eok) ev)
  8625. ((org-region-active-p)
  8626. (buffer-substring (region-beginning) (region-end)))))
  8627. (when (or (null txt) (string-match "\\S-" txt))
  8628. (setq cpltxt
  8629. (concat cpltxt "::"
  8630. (condition-case nil
  8631. (org-make-org-heading-search-string txt)
  8632. (error "")))
  8633. desc (or (and (eq et 'keyword) eok ev)
  8634. (nth 4 (ignore-errors (org-heading-components)))
  8635. "NONE")))))
  8636. (if (string-match "::\\'" cpltxt)
  8637. (setq cpltxt (substring cpltxt 0 -2)))
  8638. (setq link cpltxt))))
  8639. ((buffer-file-name (buffer-base-buffer))
  8640. ;; Just link to this file here.
  8641. (setq cpltxt (concat "file:"
  8642. (abbreviate-file-name
  8643. (buffer-file-name (buffer-base-buffer)))))
  8644. ;; Add a context string.
  8645. (when (org-xor org-context-in-file-links arg)
  8646. (setq txt (if (org-region-active-p)
  8647. (buffer-substring (region-beginning) (region-end))
  8648. (buffer-substring (point-at-bol) (point-at-eol))))
  8649. ;; Only use search option if there is some text.
  8650. (when (string-match "\\S-" txt)
  8651. (setq cpltxt
  8652. (concat cpltxt "::" (org-make-org-heading-search-string txt))
  8653. desc "NONE")))
  8654. (setq link cpltxt))
  8655. ((org-called-interactively-p 'interactive)
  8656. (user-error "No method for storing a link from this buffer"))
  8657. (t (setq link nil)))
  8658. ;; We're done setting link and desc, clean up
  8659. (if (consp link) (setq cpltxt (car link) link (cdr link)))
  8660. (setq link (or link cpltxt)
  8661. desc (or desc cpltxt))
  8662. (cond ((equal desc "NONE") (setq desc nil))
  8663. ((string-match org-bracket-link-analytic-regexp desc)
  8664. (let ((d0 (match-string 3 desc))
  8665. (p0 (match-string 5 desc)))
  8666. (setq desc
  8667. (replace-regexp-in-string
  8668. org-bracket-link-regexp
  8669. (concat (or p0 d0)
  8670. (if (equal (length (match-string 0 desc))
  8671. (length desc)) "*" "")) desc)))))
  8672. ;; Return the link
  8673. (if (not (and (or (org-called-interactively-p 'any)
  8674. executing-kbd-macro) link))
  8675. (or agenda-link (and link (org-make-link-string link desc)))
  8676. (push (list link desc) org-stored-links)
  8677. (message "Stored: %s" (or desc link))
  8678. (when custom-id
  8679. (setq link (concat "file:" (abbreviate-file-name
  8680. (buffer-file-name)) "::#" custom-id))
  8681. (push (list link desc) org-stored-links)))))))
  8682. (defun org-store-link-props (&rest plist)
  8683. "Store link properties, extract names and addresses."
  8684. (let (x adr)
  8685. (when (setq x (plist-get plist :from))
  8686. (setq adr (mail-extract-address-components x))
  8687. (setq plist (plist-put plist :fromname (car adr)))
  8688. (setq plist (plist-put plist :fromaddress (nth 1 adr))))
  8689. (when (setq x (plist-get plist :to))
  8690. (setq adr (mail-extract-address-components x))
  8691. (setq plist (plist-put plist :toname (car adr)))
  8692. (setq plist (plist-put plist :toaddress (nth 1 adr)))))
  8693. (let ((from (plist-get plist :from))
  8694. (to (plist-get plist :to)))
  8695. (when (and from to org-from-is-user-regexp)
  8696. (setq plist
  8697. (plist-put plist :fromto
  8698. (if (string-match org-from-is-user-regexp from)
  8699. (concat "to %t")
  8700. (concat "from %f"))))))
  8701. (setq org-store-link-plist plist))
  8702. (defun org-add-link-props (&rest plist)
  8703. "Add these properties to the link property list."
  8704. (let (key value)
  8705. (while plist
  8706. (setq key (pop plist) value (pop plist))
  8707. (setq org-store-link-plist
  8708. (plist-put org-store-link-plist key value)))))
  8709. (defun org-email-link-description (&optional fmt)
  8710. "Return the description part of an email link.
  8711. This takes information from `org-store-link-plist' and formats it
  8712. according to FMT (default from `org-email-link-description-format')."
  8713. (setq fmt (or fmt org-email-link-description-format))
  8714. (let* ((p org-store-link-plist)
  8715. (to (plist-get p :toaddress))
  8716. (from (plist-get p :fromaddress))
  8717. (table
  8718. (list
  8719. (cons "%c" (plist-get p :fromto))
  8720. (cons "%F" (plist-get p :from))
  8721. (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
  8722. (cons "%T" (plist-get p :to))
  8723. (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
  8724. (cons "%s" (plist-get p :subject))
  8725. (cons "%d" (plist-get p :date))
  8726. (cons "%m" (plist-get p :message-id)))))
  8727. (when (string-match "%c" fmt)
  8728. ;; Check if the user wrote this message
  8729. (if (and org-from-is-user-regexp from to
  8730. (save-match-data (string-match org-from-is-user-regexp from)))
  8731. (setq fmt (replace-match "to %t" t t fmt))
  8732. (setq fmt (replace-match "from %f" t t fmt))))
  8733. (org-replace-escapes fmt table)))
  8734. (defun org-make-org-heading-search-string (&optional string)
  8735. "Make search string for the current headline or STRING."
  8736. (let ((s (or string
  8737. (and (derived-mode-p 'org-mode)
  8738. (save-excursion
  8739. (org-back-to-heading t)
  8740. (org-element-property :raw-value (org-element-at-point))))))
  8741. (lines org-context-in-file-links))
  8742. (or string (setq s (concat "*" s))) ; Add * for headlines
  8743. (setq s (replace-regexp-in-string "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" "" s))
  8744. (when (and string (integerp lines) (> lines 0))
  8745. (let ((slines (org-split-string s "\n")))
  8746. (when (< lines (length slines))
  8747. (setq s (mapconcat
  8748. 'identity
  8749. (reverse (nthcdr (- (length slines) lines)
  8750. (reverse slines))) "\n")))))
  8751. (mapconcat 'identity (org-split-string s "[ \t]+") " ")))
  8752. (defun org-make-link-string (link &optional description)
  8753. "Make a link with brackets, consisting of LINK and DESCRIPTION."
  8754. (unless (string-match "\\S-" link)
  8755. (error "Empty link"))
  8756. (when (and description
  8757. (stringp description)
  8758. (not (string-match "\\S-" description)))
  8759. (setq description nil))
  8760. (when (stringp description)
  8761. ;; Remove brackets from the description, they are fatal.
  8762. (while (string-match "\\[" description)
  8763. (setq description (replace-match "{" t t description)))
  8764. (while (string-match "\\]" description)
  8765. (setq description (replace-match "}" t t description))))
  8766. (when (equal link description)
  8767. ;; No description needed, it is identical
  8768. (setq description nil))
  8769. (when (and (not description)
  8770. (not (string-match (org-image-file-name-regexp) link))
  8771. (not (equal link (org-link-escape link))))
  8772. (setq description (org-extract-attributes link)))
  8773. (setq link
  8774. (cond ((string-match (org-image-file-name-regexp) link) link)
  8775. ((string-match org-link-types-re link)
  8776. (concat (match-string 1 link)
  8777. (org-link-escape (substring link (match-end 1)))))
  8778. (t (org-link-escape link))))
  8779. (concat "[[" link "]"
  8780. (if description (concat "[" description "]") "")
  8781. "]"))
  8782. (defconst org-link-escape-chars
  8783. ;;%20 %2B %3B %3D %5B %5D
  8784. '(?\ ?\+ ?\; ?\= ?\[ ?\])
  8785. "List of characters that should be escaped in link.
  8786. This is the list that is used for internal purposes.")
  8787. (defconst org-link-escape-chars-browser
  8788. ;;%20 %22
  8789. '(?\ ?\")
  8790. "List of escapes for characters that are problematic in links.
  8791. This is the list that is used before handing over to the browser.")
  8792. (defun org-link-escape (text &optional table merge)
  8793. "Return percent escaped representation of TEXT.
  8794. TEXT is a string with the text to escape.
  8795. Optional argument TABLE is a list with characters that should be
  8796. escaped. When nil, `org-link-escape-chars' is used.
  8797. If optional argument MERGE is set, merge TABLE into
  8798. `org-link-escape-chars'."
  8799. (cond
  8800. ((and table merge)
  8801. (mapc (lambda (defchr)
  8802. (unless (member defchr table)
  8803. (setq table (cons defchr table)))) org-link-escape-chars))
  8804. ((null table)
  8805. (setq table org-link-escape-chars)))
  8806. (mapconcat
  8807. (lambda (char)
  8808. (if (or (member char table)
  8809. (and (or (< char 32) (= char ?\%) (> char 126))
  8810. org-url-hexify-p))
  8811. (mapconcat (lambda (sequence-element)
  8812. (format "%%%.2X" sequence-element))
  8813. (or (encode-coding-char char 'utf-8)
  8814. (error "Unable to percent escape character: %s"
  8815. (char-to-string char))) "")
  8816. (char-to-string char))) text ""))
  8817. (defun org-link-escape-browser (text)
  8818. (if (org-string-match-p
  8819. (concat "[[:nonascii:]" org-link-escape-chars-browser "]")
  8820. text)
  8821. (org-link-escape text org-link-escape-chars-browser)
  8822. text))
  8823. (defun org-link-unescape (str)
  8824. "Unhex hexified Unicode strings as returned from the JavaScript function
  8825. encodeURIComponent. E.g. `%C3%B6' is the german o-Umlaut."
  8826. (unless (and (null str) (string= "" str))
  8827. (let ((pos 0) (case-fold-search t) unhexed)
  8828. (while (setq pos (string-match "\\(%[0-9a-f][0-9a-f]\\)+" str pos))
  8829. (setq unhexed (org-link-unescape-compound (match-string 0 str)))
  8830. (setq str (replace-match unhexed t t str))
  8831. (setq pos (+ pos (length unhexed))))))
  8832. str)
  8833. (defun org-link-unescape-compound (hex)
  8834. "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German o-Umlaut.
  8835. Note: this function also decodes single byte encodings like
  8836. `%E1' (a-acute) if not followed by another `%[A-F0-9]{2}' group."
  8837. (save-match-data
  8838. (let* ((bytes (cdr (split-string hex "%")))
  8839. (ret "")
  8840. (eat 0)
  8841. (sum 0))
  8842. (while bytes
  8843. (let* ((val (string-to-number (pop bytes) 16))
  8844. (shift-xor
  8845. (if (= 0 eat)
  8846. (cond
  8847. ((>= val 252) (cons 6 252))
  8848. ((>= val 248) (cons 5 248))
  8849. ((>= val 240) (cons 4 240))
  8850. ((>= val 224) (cons 3 224))
  8851. ((>= val 192) (cons 2 192))
  8852. (t (cons 0 0)))
  8853. (cons 6 128))))
  8854. (if (>= val 192) (setq eat (car shift-xor)))
  8855. (setq val (logxor val (cdr shift-xor)))
  8856. (setq sum (+ (lsh sum (car shift-xor)) val))
  8857. (if (> eat 0) (setq eat (- eat 1)))
  8858. (cond
  8859. ((= 0 eat) ;multi byte
  8860. (setq ret (concat ret (org-char-to-string sum)))
  8861. (setq sum 0))
  8862. ((not bytes) ; single byte(s)
  8863. (setq ret (org-link-unescape-single-byte-sequence hex))))
  8864. )) ;; end (while bytes
  8865. ret )))
  8866. (defun org-link-unescape-single-byte-sequence (hex)
  8867. "Unhexify hex-encoded single byte character sequences."
  8868. (mapconcat (lambda (byte)
  8869. (char-to-string (string-to-number byte 16)))
  8870. (cdr (split-string hex "%")) ""))
  8871. (defun org-xor (a b)
  8872. "Exclusive or."
  8873. (if a (not b) b))
  8874. (defun org-fixup-message-id-for-http (s)
  8875. "Replace special characters in a message id, so it can be used in an http query."
  8876. (when (string-match "%" s)
  8877. (setq s (mapconcat (lambda (c)
  8878. (if (eq c ?%)
  8879. "%25"
  8880. (char-to-string c)))
  8881. s "")))
  8882. (while (string-match "<" s)
  8883. (setq s (replace-match "%3C" t t s)))
  8884. (while (string-match ">" s)
  8885. (setq s (replace-match "%3E" t t s)))
  8886. (while (string-match "@" s)
  8887. (setq s (replace-match "%40" t t s)))
  8888. s)
  8889. (defun org-link-prettify (link)
  8890. "Return a human-readable representation of LINK.
  8891. The car of LINK must be a raw link the cdr of LINK must be either
  8892. a link description or nil."
  8893. (let ((desc (or (cadr link) "<no description>")))
  8894. (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
  8895. "<" (car link) ">")))
  8896. ;;;###autoload
  8897. (defun org-insert-link-global ()
  8898. "Insert a link like Org-mode does.
  8899. This command can be called in any mode to insert a link in Org-mode syntax."
  8900. (interactive)
  8901. (org-load-modules-maybe)
  8902. (org-run-like-in-org-mode 'org-insert-link))
  8903. (defun org-insert-all-links (&optional keep)
  8904. "Insert all links in `org-stored-links'."
  8905. (interactive "P")
  8906. (let ((links (copy-sequence org-stored-links)) l)
  8907. (while (setq l (if keep (pop links) (pop org-stored-links)))
  8908. (insert "- ")
  8909. (org-insert-link nil (car l) (or (cadr l) "<no description>"))
  8910. (insert "\n"))))
  8911. (defun org-link-fontify-links-to-this-file ()
  8912. "Fontify links to the current file in `org-stored-links'."
  8913. (let ((f (buffer-file-name)) a b)
  8914. (setq a (mapcar (lambda(l)
  8915. (let ((ll (car l)))
  8916. (when (and (string-match "^file:\\(.+\\)::" ll)
  8917. (equal f (expand-file-name (match-string 1 ll))))
  8918. ll)))
  8919. org-stored-links))
  8920. (when (featurep 'org-id)
  8921. (setq b (mapcar (lambda(l)
  8922. (let ((ll (car l)))
  8923. (when (and (string-match "^id:\\(.+\\)$" ll)
  8924. (equal f (expand-file-name
  8925. (or (org-id-find-id-file
  8926. (match-string 1 ll)) ""))))
  8927. ll)))
  8928. org-stored-links)))
  8929. (mapcar (lambda(l)
  8930. (put-text-property 0 (length l) 'face 'font-lock-comment-face l))
  8931. (delq nil (append a b)))))
  8932. (defvar org-link-links-in-this-file nil)
  8933. (defun org-insert-link (&optional complete-file link-location default-description)
  8934. "Insert a link. At the prompt, enter the link.
  8935. Completion can be used to insert any of the link protocol prefixes like
  8936. http or ftp in use.
  8937. The history can be used to select a link previously stored with
  8938. `org-store-link'. When the empty string is entered (i.e. if you just
  8939. press RET at the prompt), the link defaults to the most recently
  8940. stored link. As SPC triggers completion in the minibuffer, you need to
  8941. use M-SPC or C-q SPC to force the insertion of a space character.
  8942. You will also be prompted for a description, and if one is given, it will
  8943. be displayed in the buffer instead of the link.
  8944. If there is already a link at point, this command will allow you to edit link
  8945. and description parts.
  8946. With a \\[universal-argument] prefix, prompts for a file to link to. The file name can
  8947. be selected using completion. The path to the file will be relative to the
  8948. current directory if the file is in the current directory or a subdirectory.
  8949. Otherwise, the link will be the absolute path as completed in the minibuffer
  8950. \(i.e. normally ~/path/to/file). You can configure this behavior using the
  8951. option `org-link-file-path-type'.
  8952. With two \\[universal-argument] prefixes, enforce an absolute path even if the file is in
  8953. the current directory or below.
  8954. With three \\[universal-argument] prefixes, negate the meaning of
  8955. `org-keep-stored-link-after-insertion'.
  8956. If `org-make-link-description-function' is non-nil, this function will be
  8957. called with the link target, and the result will be the default
  8958. link description.
  8959. If the LINK-LOCATION parameter is non-nil, this value will be
  8960. used as the link location instead of reading one interactively.
  8961. If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
  8962. be used as the default description."
  8963. (interactive "P")
  8964. (let* ((wcf (current-window-configuration))
  8965. (origbuf (current-buffer))
  8966. (region (if (org-region-active-p)
  8967. (buffer-substring (region-beginning) (region-end))))
  8968. (remove (and region (list (region-beginning) (region-end))))
  8969. (desc region)
  8970. tmphist ; byte-compile incorrectly complains about this
  8971. (link link-location)
  8972. (abbrevs org-link-abbrev-alist-local)
  8973. entry file all-prefixes auto-desc)
  8974. (cond
  8975. (link-location) ; specified by arg, just use it.
  8976. ((org-in-regexp org-bracket-link-regexp 1)
  8977. ;; We do have a link at point, and we are going to edit it.
  8978. (setq remove (list (match-beginning 0) (match-end 0)))
  8979. (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
  8980. (setq link (read-string "Link: "
  8981. (org-link-unescape
  8982. (org-match-string-no-properties 1)))))
  8983. ((or (org-in-regexp org-angle-link-re)
  8984. (org-in-regexp org-plain-link-re))
  8985. ;; Convert to bracket link
  8986. (setq remove (list (match-beginning 0) (match-end 0))
  8987. link (read-string "Link: "
  8988. (org-remove-angle-brackets (match-string 0)))))
  8989. ((member complete-file '((4) (16)))
  8990. ;; Completing read for file names.
  8991. (setq link (org-file-complete-link complete-file)))
  8992. (t
  8993. ;; Read link, with completion for stored links.
  8994. (org-link-fontify-links-to-this-file)
  8995. (org-switch-to-buffer-other-window "*Org Links*")
  8996. (with-current-buffer "*Org Links*"
  8997. (erase-buffer)
  8998. (insert "Insert a link.
  8999. Use TAB to complete link prefixes, then RET for type-specific completion support\n")
  9000. (when org-stored-links
  9001. (insert "\nStored links are available with <up>/<down> or M-p/n (most recent with RET):\n\n")
  9002. (insert (mapconcat 'org-link-prettify
  9003. (reverse org-stored-links) "\n")))
  9004. (goto-char (point-min)))
  9005. (let ((cw (selected-window)))
  9006. (select-window (get-buffer-window "*Org Links*" 'visible))
  9007. (with-current-buffer "*Org Links*" (setq truncate-lines t))
  9008. (unless (pos-visible-in-window-p (point-max))
  9009. (org-fit-window-to-buffer))
  9010. (and (window-live-p cw) (select-window cw)))
  9011. ;; Fake a link history, containing the stored links.
  9012. (setq tmphist (append (mapcar 'car org-stored-links)
  9013. org-insert-link-history))
  9014. (setq all-prefixes (append (mapcar 'car abbrevs)
  9015. (mapcar 'car org-link-abbrev-alist)
  9016. org-link-types))
  9017. (unwind-protect
  9018. (progn
  9019. (setq link
  9020. (org-completing-read
  9021. "Link: "
  9022. (append
  9023. (mapcar (lambda (x) (concat x ":"))
  9024. all-prefixes)
  9025. (mapcar 'car org-stored-links))
  9026. nil nil nil
  9027. 'tmphist
  9028. (caar org-stored-links)))
  9029. (if (not (string-match "\\S-" link))
  9030. (user-error "No link selected"))
  9031. (mapc (lambda(l)
  9032. (when (equal link (cadr l)) (setq link (car l) auto-desc t)))
  9033. org-stored-links)
  9034. (if (or (member link all-prefixes)
  9035. (and (equal ":" (substring link -1))
  9036. (member (substring link 0 -1) all-prefixes)
  9037. (setq link (substring link 0 -1))))
  9038. (setq link (with-current-buffer origbuf
  9039. (org-link-try-special-completion link)))))
  9040. (set-window-configuration wcf)
  9041. (kill-buffer "*Org Links*"))
  9042. (setq entry (assoc link org-stored-links))
  9043. (or entry (push link org-insert-link-history))
  9044. (setq desc (or desc (nth 1 entry)))))
  9045. (if (funcall (if (equal complete-file '(64)) 'not 'identity)
  9046. (not org-keep-stored-link-after-insertion))
  9047. (setq org-stored-links (delq (assoc link org-stored-links)
  9048. org-stored-links)))
  9049. (if (string-match org-plain-link-re link)
  9050. ;; URL-like link, normalize the use of angular brackets.
  9051. (setq link (org-remove-angle-brackets link)))
  9052. ;; Check if we are linking to the current file with a search
  9053. ;; option If yes, simplify the link by using only the search
  9054. ;; option.
  9055. (when (and buffer-file-name
  9056. (string-match "^file:\\(.+?\\)::\\(.+\\)" link))
  9057. (let* ((path (match-string 1 link))
  9058. (case-fold-search nil)
  9059. (search (match-string 2 link)))
  9060. (save-match-data
  9061. (if (equal (file-truename buffer-file-name) (file-truename path))
  9062. ;; We are linking to this same file, with a search option
  9063. (setq link search)))))
  9064. ;; Check if we can/should use a relative path. If yes, simplify the link
  9065. (when (string-match "^\\(file:\\|docview:\\)\\(.*\\)" link)
  9066. (let* ((type (match-string 1 link))
  9067. (path (match-string 2 link))
  9068. (origpath path)
  9069. (case-fold-search nil))
  9070. (cond
  9071. ((or (eq org-link-file-path-type 'absolute)
  9072. (equal complete-file '(16)))
  9073. (setq path (abbreviate-file-name (expand-file-name path))))
  9074. ((eq org-link-file-path-type 'noabbrev)
  9075. (setq path (expand-file-name path)))
  9076. ((eq org-link-file-path-type 'relative)
  9077. (setq path (file-relative-name path)))
  9078. (t
  9079. (save-match-data
  9080. (if (string-match (concat "^" (regexp-quote
  9081. (expand-file-name
  9082. (file-name-as-directory
  9083. default-directory))))
  9084. (expand-file-name path))
  9085. ;; We are linking a file with relative path name.
  9086. (setq path (substring (expand-file-name path)
  9087. (match-end 0)))
  9088. (setq path (abbreviate-file-name (expand-file-name path)))))))
  9089. (setq link (concat type path))
  9090. (if (equal desc origpath)
  9091. (setq desc path))))
  9092. (if org-make-link-description-function
  9093. (setq desc
  9094. (or (condition-case nil
  9095. (funcall org-make-link-description-function link desc)
  9096. (error (progn (message "Can't get link description from `%s'"
  9097. (symbol-name org-make-link-description-function))
  9098. (sit-for 2) nil)))
  9099. (read-string "Description: " default-description)))
  9100. (if default-description (setq desc default-description)
  9101. (setq desc (or (and auto-desc desc)
  9102. (read-string "Description: " desc)))))
  9103. (unless (string-match "\\S-" desc) (setq desc nil))
  9104. (if remove (apply 'delete-region remove))
  9105. (insert (org-make-link-string link desc))))
  9106. (defun org-link-try-special-completion (type)
  9107. "If there is completion support for link type TYPE, offer it."
  9108. (let ((fun (intern (concat "org-" type "-complete-link"))))
  9109. (if (functionp fun)
  9110. (funcall fun)
  9111. (read-string "Link (no completion support): " (concat type ":")))))
  9112. (defun org-file-complete-link (&optional arg)
  9113. "Create a file link using completion."
  9114. (let (file link)
  9115. (setq file (org-iread-file-name "File: "))
  9116. (let ((pwd (file-name-as-directory (expand-file-name ".")))
  9117. (pwd1 (file-name-as-directory (abbreviate-file-name
  9118. (expand-file-name ".")))))
  9119. (cond
  9120. ((equal arg '(16))
  9121. (setq link (concat
  9122. "file:"
  9123. (abbreviate-file-name (expand-file-name file)))))
  9124. ((string-match (concat "^" (regexp-quote pwd1) "\\(.+\\)") file)
  9125. (setq link (concat "file:" (match-string 1 file))))
  9126. ((string-match (concat "^" (regexp-quote pwd) "\\(.+\\)")
  9127. (expand-file-name file))
  9128. (setq link (concat
  9129. "file:" (match-string 1 (expand-file-name file)))))
  9130. (t (setq link (concat "file:" file)))))
  9131. link))
  9132. (defun org-iread-file-name (&rest args)
  9133. "Read-file-name using `ido-mode' speedup if available.
  9134. ARGS are arguments that may be passed to `ido-read-file-name' or `read-file-name'.
  9135. See `read-file-name' for a description of parameters."
  9136. (org-without-partial-completion
  9137. (if (and org-completion-use-ido
  9138. (fboundp 'ido-read-file-name)
  9139. (boundp 'ido-mode) ido-mode
  9140. (listp (second args)))
  9141. (let ((ido-enter-matching-directory nil))
  9142. (apply 'ido-read-file-name args))
  9143. (apply 'read-file-name args))))
  9144. (defun org-completing-read (&rest args)
  9145. "Completing-read with SPACE being a normal character."
  9146. (let ((enable-recursive-minibuffers t)
  9147. (minibuffer-local-completion-map
  9148. (copy-keymap minibuffer-local-completion-map)))
  9149. (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
  9150. (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
  9151. (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
  9152. (apply 'org-icompleting-read args)))
  9153. (defun org-completing-read-no-i (&rest args)
  9154. (let (org-completion-use-ido org-completion-use-iswitchb)
  9155. (apply 'org-completing-read args)))
  9156. (defun org-iswitchb-completing-read (prompt choices &rest args)
  9157. "Use iswitch as a completing-read replacement to choose from choices.
  9158. PROMPT is a string to prompt with. CHOICES is a list of strings to choose
  9159. from."
  9160. (let* ((iswitchb-use-virtual-buffers nil)
  9161. (iswitchb-make-buflist-hook
  9162. (lambda ()
  9163. (setq iswitchb-temp-buflist choices))))
  9164. (iswitchb-read-buffer prompt)))
  9165. (defun org-icompleting-read (&rest args)
  9166. "Completing-read using `ido-mode' or `iswitchb' speedups if available."
  9167. (org-without-partial-completion
  9168. (if (and org-completion-use-ido
  9169. (fboundp 'ido-completing-read)
  9170. (boundp 'ido-mode) ido-mode
  9171. (listp (second args)))
  9172. (let ((ido-enter-matching-directory nil))
  9173. (apply 'ido-completing-read (concat (car args))
  9174. (if (consp (car (nth 1 args)))
  9175. (mapcar 'car (nth 1 args))
  9176. (nth 1 args))
  9177. (cddr args)))
  9178. (if (and org-completion-use-iswitchb
  9179. (boundp 'iswitchb-mode) iswitchb-mode
  9180. (listp (second args)))
  9181. (apply 'org-iswitchb-completing-read (concat (car args))
  9182. (if (consp (car (nth 1 args)))
  9183. (mapcar 'car (nth 1 args))
  9184. (nth 1 args))
  9185. (cddr args))
  9186. (apply 'completing-read args)))))
  9187. (defun org-extract-attributes (s)
  9188. "Extract the attributes cookie from a string and set as text property."
  9189. (let (a attr (start 0) key value)
  9190. (save-match-data
  9191. (when (string-match "{{\\([^}]+\\)}}$" s)
  9192. (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
  9193. (while (string-match "\\([a-zA-Z]+\\)=\"\\([^\"]*\\)\"" a start)
  9194. (setq key (match-string 1 a) value (match-string 2 a)
  9195. start (match-end 0)
  9196. attr (plist-put attr (intern key) value))))
  9197. (org-add-props s nil 'org-attr attr))
  9198. s))
  9199. ;;; Opening/following a link
  9200. (defvar org-link-search-failed nil)
  9201. (defvar org-open-link-functions nil
  9202. "Hook for functions finding a plain text link.
  9203. These functions must take a single argument, the link content.
  9204. They will be called for links that look like [[link text][description]]
  9205. when LINK TEXT does not have a protocol like \"http:\" and does not look
  9206. like a filename (e.g. \"./blue.png\").
  9207. These functions will be called *before* Org attempts to resolve the
  9208. link by doing text searches in the current buffer - so if you want a
  9209. link \"[[target]]\" to still find \"<<target>>\", your function should
  9210. handle this as a special case.
  9211. When the function does handle the link, it must return a non-nil value.
  9212. If it decides that it is not responsible for this link, it must return
  9213. nil to indicate that that Org-mode can continue with other options
  9214. like exact and fuzzy text search.")
  9215. (defun org-next-link (&optional search-backward)
  9216. "Move forward to the next link.
  9217. If the link is in hidden text, expose it."
  9218. (interactive "P")
  9219. (when (and org-link-search-failed (eq this-command last-command))
  9220. (goto-char (point-min))
  9221. (message "Link search wrapped back to beginning of buffer"))
  9222. (setq org-link-search-failed nil)
  9223. (let* ((pos (point))
  9224. (ct (org-context))
  9225. (a (assoc :link ct))
  9226. (srch-fun (if search-backward 're-search-backward 're-search-forward)))
  9227. (cond (a (goto-char (nth (if search-backward 1 2) a)))
  9228. ((looking-at org-any-link-re)
  9229. ;; Don't stay stuck at link without an org-link face
  9230. (forward-char (if search-backward -1 1))))
  9231. (if (funcall srch-fun org-any-link-re nil t)
  9232. (progn
  9233. (goto-char (match-beginning 0))
  9234. (if (outline-invisible-p) (org-show-context)))
  9235. (goto-char pos)
  9236. (setq org-link-search-failed t)
  9237. (message "No further link found"))))
  9238. (defun org-previous-link ()
  9239. "Move backward to the previous link.
  9240. If the link is in hidden text, expose it."
  9241. (interactive)
  9242. (funcall 'org-next-link t))
  9243. (defun org-translate-link (s)
  9244. "Translate a link string if a translation function has been defined."
  9245. (if (and org-link-translation-function
  9246. (fboundp org-link-translation-function)
  9247. (string-match "\\([a-zA-Z0-9]+\\):\\(.*\\)" s))
  9248. (progn
  9249. (setq s (funcall org-link-translation-function
  9250. (match-string 1 s) (match-string 2 s)))
  9251. (concat (car s) ":" (cdr s)))
  9252. s))
  9253. (defun org-translate-link-from-planner (type path)
  9254. "Translate a link from Emacs Planner syntax so that Org can follow it.
  9255. This is still an experimental function, your mileage may vary."
  9256. (cond
  9257. ((member type '("http" "https" "news" "ftp"))
  9258. ;; standard Internet links are the same.
  9259. nil)
  9260. ((and (equal type "irc") (string-match "^//" path))
  9261. ;; Planner has two / at the beginning of an irc link, we have 1.
  9262. ;; We should have zero, actually....
  9263. (setq path (substring path 1)))
  9264. ((and (equal type "lisp") (string-match "^/" path))
  9265. ;; Planner has a slash, we do not.
  9266. (setq type "elisp" path (substring path 1)))
  9267. ((string-match "^//\\(.?*\\)/\\(<.*>\\)$" path)
  9268. ;; A typical message link. Planner has the id after the final slash,
  9269. ;; we separate it with a hash mark
  9270. (setq path (concat (match-string 1 path) "#"
  9271. (org-remove-angle-brackets (match-string 2 path))))))
  9272. (cons type path))
  9273. (defun org-find-file-at-mouse (ev)
  9274. "Open file link or URL at mouse."
  9275. (interactive "e")
  9276. (mouse-set-point ev)
  9277. (org-open-at-point 'in-emacs))
  9278. (defun org-open-at-mouse (ev)
  9279. "Open file link or URL at mouse.
  9280. See the docstring of `org-open-file' for details."
  9281. (interactive "e")
  9282. (mouse-set-point ev)
  9283. (if (eq major-mode 'org-agenda-mode)
  9284. (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
  9285. (org-open-at-point))
  9286. (defvar org-window-config-before-follow-link nil
  9287. "The window configuration before following a link.
  9288. This is saved in case the need arises to restore it.")
  9289. (defvar org-open-link-marker (make-marker)
  9290. "Marker pointing to the location where `org-open-at-point; was called.")
  9291. ;;;###autoload
  9292. (defun org-open-at-point-global ()
  9293. "Follow a link like Org-mode does.
  9294. This command can be called in any mode to follow a link that has
  9295. Org-mode syntax."
  9296. (interactive)
  9297. (org-run-like-in-org-mode 'org-open-at-point))
  9298. ;;;###autoload
  9299. (defun org-open-link-from-string (s &optional arg reference-buffer)
  9300. "Open a link in the string S, as if it was in Org-mode."
  9301. (interactive "sLink: \nP")
  9302. (let ((reference-buffer (or reference-buffer (current-buffer))))
  9303. (with-temp-buffer
  9304. (let ((org-inhibit-startup (not reference-buffer)))
  9305. (org-mode)
  9306. (insert s)
  9307. (goto-char (point-min))
  9308. (when reference-buffer
  9309. (setq org-link-abbrev-alist-local
  9310. (with-current-buffer reference-buffer
  9311. org-link-abbrev-alist-local)))
  9312. (org-open-at-point arg reference-buffer)))))
  9313. (defvar org-open-at-point-functions nil
  9314. "Hook that is run when following a link at point.
  9315. Functions in this hook must return t if they identify and follow
  9316. a link at point. If they don't find anything interesting at point,
  9317. they must return nil.")
  9318. (defvar clean-buffer-list-kill-buffer-names) ; Defined in midnight.el
  9319. (defun org-open-at-point (&optional arg reference-buffer)
  9320. "Open link at or after point.
  9321. If there is no link at point, this function will search forward up to
  9322. the end of the current line.
  9323. Normally, files will be opened by an appropriate application. If the
  9324. optional prefix argument ARG is non-nil, Emacs will visit the file.
  9325. With a double prefix argument, try to open outside of Emacs, in the
  9326. application the system uses for this file type."
  9327. (interactive "P")
  9328. ;; if in a code block, then open the block's results
  9329. (unless (call-interactively #'org-babel-open-src-block-result)
  9330. (org-load-modules-maybe)
  9331. (move-marker org-open-link-marker (point))
  9332. (setq org-window-config-before-follow-link (current-window-configuration))
  9333. (org-remove-occur-highlights nil nil t)
  9334. (cond
  9335. ((and (org-at-heading-p)
  9336. (not (org-at-timestamp-p t))
  9337. (not (org-in-regexp
  9338. (concat org-plain-link-re "\\|"
  9339. org-bracket-link-regexp "\\|"
  9340. org-angle-link-re "\\|"
  9341. "[ \t]:[^ \t\n]+:[ \t]*$")))
  9342. (not (get-text-property (point) 'org-linked-text)))
  9343. (or (let* ((lkall (org-offer-links-in-entry (current-buffer) (point) arg))
  9344. (lk0 (car lkall))
  9345. (lk (if (stringp lk0) (list lk0) lk0))
  9346. (lkend (cdr lkall)))
  9347. (mapcar (lambda(l)
  9348. (search-forward l nil lkend)
  9349. (goto-char (match-beginning 0))
  9350. (org-open-at-point))
  9351. lk))
  9352. (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
  9353. ((run-hook-with-args-until-success 'org-open-at-point-functions))
  9354. ((and (org-at-timestamp-p t)
  9355. (not (org-in-regexp org-bracket-link-regexp)))
  9356. (org-follow-timestamp-link))
  9357. ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
  9358. (not (org-in-regexp org-any-link-re)))
  9359. (org-footnote-action))
  9360. (t
  9361. (let (type path link line search (pos (point)))
  9362. (catch 'match
  9363. (save-excursion
  9364. (skip-chars-forward "^]\n\r")
  9365. (when (org-in-regexp org-bracket-link-regexp 1)
  9366. (setq link (org-extract-attributes
  9367. (org-link-unescape (org-match-string-no-properties 1))))
  9368. (while (string-match " *\n *" link)
  9369. (setq link (replace-match " " t t link)))
  9370. (setq link (org-link-expand-abbrev link))
  9371. (cond
  9372. ((or (file-name-absolute-p link)
  9373. (string-match "^\\.\\.?/" link))
  9374. (setq type "file" path link))
  9375. ((string-match org-link-re-with-space3 link)
  9376. (setq type (match-string 1 link) path (match-string 2 link)))
  9377. ((string-match "^help:+\\(.+\\)" link)
  9378. (setq type "help" path (match-string 1 link)))
  9379. (t (setq type "thisfile" path link)))
  9380. (throw 'match t)))
  9381. (when (get-text-property (point) 'org-linked-text)
  9382. (setq type "thisfile"
  9383. pos (if (get-text-property (1+ (point)) 'org-linked-text)
  9384. (1+ (point)) (point))
  9385. path (buffer-substring
  9386. (or (previous-single-property-change pos 'org-linked-text)
  9387. (point-min))
  9388. (or (next-single-property-change pos 'org-linked-text)
  9389. (point-max)))
  9390. ;; Ensure we will search for a <<<radio>>> link, not
  9391. ;; a simple reference like <<ref>>
  9392. path (concat "<" path))
  9393. (throw 'match t))
  9394. (save-excursion
  9395. (when (or (org-in-regexp org-angle-link-re)
  9396. (let ((match (org-in-regexp org-plain-link-re)))
  9397. ;; Check a plain link is not within a bracket link
  9398. (and match
  9399. (save-excursion
  9400. (progn
  9401. (goto-char (car match))
  9402. (not (org-in-regexp org-bracket-link-regexp))))))
  9403. (let ((line_ending (save-excursion (end-of-line) (point))))
  9404. ;; We are in a line before a plain or bracket link
  9405. (or (re-search-forward org-plain-link-re line_ending t)
  9406. (re-search-forward org-bracket-link-regexp line_ending t))))
  9407. (setq type (match-string 1)
  9408. path (org-link-unescape (match-string 2)))
  9409. (throw 'match t)))
  9410. (save-excursion
  9411. (when (org-in-regexp (org-re "\\(:[[:alnum:]_@#%:]+\\):[ \t]*$"))
  9412. (setq type "tags"
  9413. path (match-string 1))
  9414. (while (string-match ":" path)
  9415. (setq path (replace-match "+" t t path)))
  9416. (throw 'match t)))
  9417. (when (org-in-regexp "<\\([^><\n]+\\)>")
  9418. (setq type "tree-match"
  9419. path (match-string 1))
  9420. (throw 'match t)))
  9421. (unless path
  9422. (user-error "No link found"))
  9423. ;; switch back to reference buffer
  9424. ;; needed when if called in a temporary buffer through
  9425. ;; org-open-link-from-string
  9426. (with-current-buffer (or reference-buffer (current-buffer))
  9427. ;; Remove any trailing spaces in path
  9428. (if (string-match " +\\'" path)
  9429. (setq path (replace-match "" t t path)))
  9430. (if (and org-link-translation-function
  9431. (fboundp org-link-translation-function))
  9432. ;; Check if we need to translate the link
  9433. (let ((tmp (funcall org-link-translation-function type path)))
  9434. (setq type (car tmp) path (cdr tmp))))
  9435. (cond
  9436. ((assoc type org-link-protocols)
  9437. (funcall (nth 1 (assoc type org-link-protocols)) path))
  9438. ((equal type "help")
  9439. (let ((f-or-v (intern path)))
  9440. (cond ((fboundp f-or-v)
  9441. (describe-function f-or-v))
  9442. ((boundp f-or-v)
  9443. (describe-variable f-or-v))
  9444. (t (error "Not a known function or variable")))))
  9445. ((equal type "mailto")
  9446. (let ((cmd (car org-link-mailto-program))
  9447. (args (cdr org-link-mailto-program)) args1
  9448. (address path) (subject "") a)
  9449. (if (string-match "\\(.*\\)::\\(.*\\)" path)
  9450. (setq address (match-string 1 path)
  9451. subject (org-link-escape (match-string 2 path))))
  9452. (while args
  9453. (cond
  9454. ((not (stringp (car args))) (push (pop args) args1))
  9455. (t (setq a (pop args))
  9456. (if (string-match "%a" a)
  9457. (setq a (replace-match address t t a)))
  9458. (if (string-match "%s" a)
  9459. (setq a (replace-match subject t t a)))
  9460. (push a args1))))
  9461. (apply cmd (nreverse args1))))
  9462. ((member type '("http" "https" "ftp" "news"))
  9463. (browse-url (concat type ":" (org-link-escape-browser path))))
  9464. ((string= type "doi")
  9465. (browse-url (concat org-doi-server-url
  9466. (org-link-escape-browser path))))
  9467. ((member type '("message"))
  9468. (browse-url (concat type ":" path)))
  9469. ((string= type "tags")
  9470. (org-tags-view arg path))
  9471. ((string= type "tree-match")
  9472. (org-occur (concat "\\[" (regexp-quote path) "\\]")))
  9473. ((string= type "file")
  9474. (if (string-match "::\\([0-9]+\\)\\'" path)
  9475. (setq line (string-to-number (match-string 1 path))
  9476. path (substring path 0 (match-beginning 0)))
  9477. (if (string-match "::\\(.+\\)\\'" path)
  9478. (setq search (match-string 1 path)
  9479. path (substring path 0 (match-beginning 0)))))
  9480. (if (string-match "[*?{]" (file-name-nondirectory path))
  9481. (dired path)
  9482. (org-open-file path arg line search)))
  9483. ((string= type "shell")
  9484. (let ((buf (generate-new-buffer "*Org Shell Output"))
  9485. (cmd path))
  9486. (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
  9487. (string-match org-confirm-shell-link-not-regexp cmd))
  9488. (not org-confirm-shell-link-function)
  9489. (funcall org-confirm-shell-link-function
  9490. (format "Execute \"%s\" in shell? "
  9491. (org-add-props cmd nil
  9492. 'face 'org-warning))))
  9493. (progn
  9494. (message "Executing %s" cmd)
  9495. (shell-command cmd buf)
  9496. (if (featurep 'midnight)
  9497. (setq clean-buffer-list-kill-buffer-names
  9498. (cons buf clean-buffer-list-kill-buffer-names))))
  9499. (error "Abort"))))
  9500. ((string= type "elisp")
  9501. (let ((cmd path))
  9502. (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
  9503. (string-match org-confirm-elisp-link-not-regexp cmd))
  9504. (not org-confirm-elisp-link-function)
  9505. (funcall org-confirm-elisp-link-function
  9506. (format "Execute \"%s\" as elisp? "
  9507. (org-add-props cmd nil
  9508. 'face 'org-warning))))
  9509. (message "%s => %s" cmd
  9510. (if (equal (string-to-char cmd) ?\()
  9511. (eval (read cmd))
  9512. (call-interactively (read cmd))))
  9513. (error "Abort"))))
  9514. ((and (string= type "thisfile")
  9515. (or (run-hook-with-args-until-success
  9516. 'org-open-link-functions path)
  9517. (and (string-match "^id:" link)
  9518. (or (featurep 'org-id) (require 'org-id))
  9519. (progn
  9520. (funcall (nth 1 (assoc "id" org-link-protocols))
  9521. (substring path 3))
  9522. t)))))
  9523. ((string= type "thisfile")
  9524. (if arg
  9525. (switch-to-buffer-other-window
  9526. (org-get-buffer-for-internal-link (current-buffer)))
  9527. (org-mark-ring-push))
  9528. (let ((cmd `(org-link-search
  9529. ,path
  9530. ,(cond ((equal arg '(4)) ''occur)
  9531. ((equal arg '(16)) ''org-occur))
  9532. ,pos)))
  9533. (condition-case nil (let ((org-link-search-inhibit-query t))
  9534. (eval cmd))
  9535. (error (progn (widen) (eval cmd))))))
  9536. (t (browse-url-at-point)))))))
  9537. (move-marker org-open-link-marker nil)
  9538. (run-hook-with-args 'org-follow-link-hook)))
  9539. (defun org-offer-links-in-entry (buffer marker &optional nth zero)
  9540. "Offer links in the current entry and return the selected link.
  9541. If there is only one link, return it.
  9542. If NTH is an integer, return the NTH link found.
  9543. If ZERO is a string, check also this string for a link, and if
  9544. there is one, return it."
  9545. (with-current-buffer buffer
  9546. (save-excursion
  9547. (save-restriction
  9548. (widen)
  9549. (goto-char marker)
  9550. (let ((re (concat "\\(" org-bracket-link-regexp "\\)\\|"
  9551. "\\(" org-angle-link-re "\\)\\|"
  9552. "\\(" org-plain-link-re "\\)"))
  9553. (cnt ?0)
  9554. (in-emacs (if (integerp nth) nil nth))
  9555. have-zero end links link c)
  9556. (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
  9557. (push (match-string 0 zero) links)
  9558. (setq cnt (1- cnt) have-zero t))
  9559. (save-excursion
  9560. (org-back-to-heading t)
  9561. (setq end (save-excursion (outline-next-heading) (point)))
  9562. (while (re-search-forward re end t)
  9563. (push (match-string 0) links))
  9564. (setq links (org-uniquify (reverse links))))
  9565. (cond
  9566. ((null links)
  9567. (message "No links"))
  9568. ((equal (length links) 1)
  9569. (setq link (car links)))
  9570. ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
  9571. (setq link (nth (if have-zero nth (1- nth)) links)))
  9572. (t ; we have to select a link
  9573. (save-excursion
  9574. (save-window-excursion
  9575. (delete-other-windows)
  9576. (with-output-to-temp-buffer "*Select Link*"
  9577. (mapc (lambda (l)
  9578. (if (not (string-match org-bracket-link-regexp l))
  9579. (princ (format "[%c] %s\n" (incf cnt)
  9580. (org-remove-angle-brackets l)))
  9581. (if (match-end 3)
  9582. (princ (format "[%c] %s (%s)\n" (incf cnt)
  9583. (match-string 3 l) (match-string 1 l)))
  9584. (princ (format "[%c] %s\n" (incf cnt)
  9585. (match-string 1 l))))))
  9586. links))
  9587. (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
  9588. (message "Select link to open, RET to open all:")
  9589. (setq c (read-char-exclusive))
  9590. (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
  9591. (when (equal c ?q) (error "Abort"))
  9592. (if (equal c ?\C-m)
  9593. (setq link links)
  9594. (setq nth (- c ?0))
  9595. (if have-zero (setq nth (1+ nth)))
  9596. (unless (and (integerp nth) (>= (length links) nth))
  9597. (user-error "Invalid link selection"))
  9598. (setq link (nth (1- nth) links)))))
  9599. (cons link end))))))
  9600. ;; Add special file links that specify the way of opening
  9601. (org-add-link-type "file+sys" 'org-open-file-with-system)
  9602. (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
  9603. (defun org-open-file-with-system (path)
  9604. "Open file at PATH using the system way of opening it."
  9605. (org-open-file path 'system))
  9606. (defun org-open-file-with-emacs (path)
  9607. "Open file at PATH in Emacs."
  9608. (org-open-file path 'emacs))
  9609. ;;; File search
  9610. (defvar org-create-file-search-functions nil
  9611. "List of functions to construct the right search string for a file link.
  9612. These functions are called in turn with point at the location to
  9613. which the link should point.
  9614. A function in the hook should first test if it would like to
  9615. handle this file type, for example by checking the `major-mode'
  9616. or the file extension. If it decides not to handle this file, it
  9617. should just return nil to give other functions a chance. If it
  9618. does handle the file, it must return the search string to be used
  9619. when following the link. The search string will be part of the
  9620. file link, given after a double colon, and `org-open-at-point'
  9621. will automatically search for it. If special measures must be
  9622. taken to make the search successful, another function should be
  9623. added to the companion hook `org-execute-file-search-functions',
  9624. which see.
  9625. A function in this hook may also use `setq' to set the variable
  9626. `description' to provide a suggestion for the descriptive text to
  9627. be used for this link when it gets inserted into an Org-mode
  9628. buffer with \\[org-insert-link].")
  9629. (defvar org-execute-file-search-functions nil
  9630. "List of functions to execute a file search triggered by a link.
  9631. Functions added to this hook must accept a single argument, the
  9632. search string that was part of the file link, the part after the
  9633. double colon. The function must first check if it would like to
  9634. handle this search, for example by checking the `major-mode' or
  9635. the file extension. If it decides not to handle this search, it
  9636. should just return nil to give other functions a chance. If it
  9637. does handle the search, it must return a non-nil value to keep
  9638. other functions from trying.
  9639. Each function can access the current prefix argument through the
  9640. variable `current-prefix-arg'. Note that a single prefix is used
  9641. to force opening a link in Emacs, so it may be good to only use a
  9642. numeric or double prefix to guide the search function.
  9643. In case this is needed, a function in this hook can also restore
  9644. the window configuration before `org-open-at-point' was called using:
  9645. (set-window-configuration org-window-config-before-follow-link)")
  9646. (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
  9647. (defun org-link-search (s &optional type avoid-pos stealth)
  9648. "Search for a link search option.
  9649. If S is surrounded by forward slashes, it is interpreted as a
  9650. regular expression. In org-mode files, this will create an `org-occur'
  9651. sparse tree. In ordinary files, `occur' will be used to list matches.
  9652. If the current buffer is in `dired-mode', grep will be used to search
  9653. in all files. If AVOID-POS is given, ignore matches near that position.
  9654. When optional argument STEALTH is non-nil, do not modify
  9655. visibility around point, thus ignoring
  9656. `org-show-hierarchy-above', `org-show-following-heading' and
  9657. `org-show-siblings' variables."
  9658. (let ((case-fold-search t)
  9659. (s0 (mapconcat 'identity (org-split-string s "[ \t\r\n]+") " "))
  9660. (markers (concat "\\(?:" (mapconcat (lambda (x) (regexp-quote (car x)))
  9661. (append '(("") (" ") ("\t") ("\n"))
  9662. org-emphasis-alist)
  9663. "\\|") "\\)"))
  9664. (pos (point))
  9665. (pre nil) (post nil)
  9666. words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
  9667. (cond
  9668. ;; First check if there are any special search functions
  9669. ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
  9670. ;; Now try the builtin stuff
  9671. ((and (equal (string-to-char s0) ?#)
  9672. (> (length s0) 1)
  9673. (save-excursion
  9674. (goto-char (point-min))
  9675. (and
  9676. (re-search-forward
  9677. (concat "^[ \t]*:CUSTOM_ID:[ \t]+"
  9678. (regexp-quote (substring s0 1)) "[ \t]*$") nil t)
  9679. (setq type 'dedicated
  9680. pos (match-beginning 0))))
  9681. ;; There is an exact target for this
  9682. (goto-char pos)
  9683. (org-back-to-heading t)))
  9684. ((save-excursion
  9685. (goto-char (point-min))
  9686. (and
  9687. (re-search-forward
  9688. (concat "<<" (regexp-quote s0) ">>") nil t)
  9689. (setq type 'dedicated
  9690. pos (match-beginning 0))))
  9691. ;; There is an exact target for this
  9692. (goto-char pos))
  9693. ((save-excursion
  9694. (goto-char (point-min))
  9695. (and
  9696. (re-search-forward
  9697. (format "^[ \t]*#\\+NAME: %s" (regexp-quote s0)) nil t)
  9698. (setq type 'dedicated pos (match-beginning 0))))
  9699. ;; Found an element with a matching #+name affiliated keyword.
  9700. (goto-char pos))
  9701. ((and (string-match "^(\\(.*\\))$" s0)
  9702. (save-excursion
  9703. (goto-char (point-min))
  9704. (and
  9705. (re-search-forward
  9706. (concat "[^[]" (regexp-quote
  9707. (format org-coderef-label-format
  9708. (match-string 1 s0))))
  9709. nil t)
  9710. (setq type 'dedicated
  9711. pos (1+ (match-beginning 0))))))
  9712. ;; There is a coderef target for this
  9713. (goto-char pos))
  9714. ((string-match "^/\\(.*\\)/$" s)
  9715. ;; A regular expression
  9716. (cond
  9717. ((derived-mode-p 'org-mode)
  9718. (org-occur (match-string 1 s)))
  9719. (t (org-do-occur (match-string 1 s)))))
  9720. ((and (derived-mode-p 'org-mode) org-link-search-must-match-exact-headline)
  9721. (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
  9722. (goto-char (point-min))
  9723. (cond
  9724. ((let (case-fold-search)
  9725. (re-search-forward (format org-complex-heading-regexp-format
  9726. (regexp-quote s))
  9727. nil t))
  9728. ;; OK, found a match
  9729. (setq type 'dedicated)
  9730. (goto-char (match-beginning 0)))
  9731. ((and (not org-link-search-inhibit-query)
  9732. (eq org-link-search-must-match-exact-headline 'query-to-create)
  9733. (y-or-n-p "No match - create this as a new heading? "))
  9734. (goto-char (point-max))
  9735. (or (bolp) (newline))
  9736. (insert "* " s "\n")
  9737. (beginning-of-line 0))
  9738. (t
  9739. (goto-char pos)
  9740. (error "No match"))))
  9741. (t
  9742. ;; A normal search string
  9743. (when (equal (string-to-char s) ?*)
  9744. ;; Anchor on headlines, post may include tags.
  9745. (setq pre "^\\*+[ \t]+\\(?:\\sw+\\)?[ \t]*"
  9746. post (org-re "[ \t]*\\(?:[ \t]+:[[:alnum:]_@#%:+]:[ \t]*\\)?$")
  9747. s (substring s 1)))
  9748. (remove-text-properties
  9749. 0 (length s)
  9750. '(face nil mouse-face nil keymap nil fontified nil) s)
  9751. ;; Make a series of regular expressions to find a match
  9752. (setq words (org-split-string s "[ \n\r\t]+")
  9753. re0 (concat "\\(<<" (regexp-quote s0) ">>\\)")
  9754. re2 (concat markers "\\(" (mapconcat 'downcase words "[ \t]+")
  9755. "\\)" markers)
  9756. re2a_ (concat "\\(" (mapconcat 'downcase words
  9757. "[ \t\r\n]+") "\\)[ \t\r\n]")
  9758. re2a (concat "[ \t\r\n]" re2a_)
  9759. re4_ (concat "\\(" (mapconcat 'downcase words
  9760. "[^a-zA-Z_\r\n]+") "\\)[^a-zA-Z_]")
  9761. re4 (concat "[^a-zA-Z_]" re4_)
  9762. re1 (concat pre re2 post)
  9763. re3 (concat pre (if pre re4_ re4) post)
  9764. re5 (concat pre ".*" re4)
  9765. re2 (concat pre re2)
  9766. re2a (concat pre (if pre re2a_ re2a))
  9767. re4 (concat pre (if pre re4_ re4))
  9768. reall (concat "\\(" re0 "\\)\\|\\(" re1 "\\)\\|\\(" re2
  9769. "\\)\\|\\(" re3 "\\)\\|\\(" re4 "\\)\\|\\("
  9770. re5 "\\)"))
  9771. (cond
  9772. ((eq type 'org-occur) (org-occur reall))
  9773. ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
  9774. (t (goto-char (point-min))
  9775. (setq type 'fuzzy)
  9776. (if (or (and (org-search-not-self 1 re0 nil t)
  9777. (setq type 'dedicated))
  9778. (org-search-not-self 1 re1 nil t)
  9779. (org-search-not-self 1 re2 nil t)
  9780. (org-search-not-self 1 re2a nil t)
  9781. (org-search-not-self 1 re3 nil t)
  9782. (org-search-not-self 1 re4 nil t)
  9783. (org-search-not-self 1 re5 nil t))
  9784. (goto-char (match-beginning 1))
  9785. (goto-char pos)
  9786. (error "No match"))))))
  9787. (and (derived-mode-p 'org-mode)
  9788. (not stealth)
  9789. (org-show-context 'link-search))
  9790. type))
  9791. (defun org-search-not-self (group &rest args)
  9792. "Execute `re-search-forward', but only accept matches that do not
  9793. enclose the position of `org-open-link-marker'."
  9794. (let ((m org-open-link-marker))
  9795. (catch 'exit
  9796. (while (apply 're-search-forward args)
  9797. (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
  9798. (goto-char (match-end group))
  9799. (if (and (or (not (eq (marker-buffer m) (current-buffer)))
  9800. (> (match-beginning 0) (marker-position m))
  9801. (< (match-end 0) (marker-position m)))
  9802. (save-match-data
  9803. (or (not (org-in-regexp
  9804. org-bracket-link-analytic-regexp 1))
  9805. (not (match-end 4)) ; no description
  9806. (and (<= (match-beginning 4) (point))
  9807. (>= (match-end 4) (point))))))
  9808. (throw 'exit (point))))))))
  9809. (defun org-get-buffer-for-internal-link (buffer)
  9810. "Return a buffer to be used for displaying the link target of internal links."
  9811. (cond
  9812. ((not org-display-internal-link-with-indirect-buffer)
  9813. buffer)
  9814. ((string-match "(Clone)$" (buffer-name buffer))
  9815. (message "Buffer is already a clone, not making another one")
  9816. ;; we also do not modify visibility in this case
  9817. buffer)
  9818. (t ; make a new indirect buffer for displaying the link
  9819. (let* ((bn (buffer-name buffer))
  9820. (ibn (concat bn "(Clone)"))
  9821. (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
  9822. (with-current-buffer ib (org-overview))
  9823. ib))))
  9824. (defun org-do-occur (regexp &optional cleanup)
  9825. "Call the Emacs command `occur'.
  9826. If CLEANUP is non-nil, remove the printout of the regular expression
  9827. in the *Occur* buffer. This is useful if the regex is long and not useful
  9828. to read."
  9829. (occur regexp)
  9830. (when cleanup
  9831. (let ((cwin (selected-window)) win beg end)
  9832. (when (setq win (get-buffer-window "*Occur*"))
  9833. (select-window win))
  9834. (goto-char (point-min))
  9835. (when (re-search-forward "match[a-z]+" nil t)
  9836. (setq beg (match-end 0))
  9837. (if (re-search-forward "^[ \t]*[0-9]+" nil t)
  9838. (setq end (1- (match-beginning 0)))))
  9839. (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
  9840. (goto-char (point-min))
  9841. (select-window cwin))))
  9842. ;;; The mark ring for links jumps
  9843. (defvar org-mark-ring nil
  9844. "Mark ring for positions before jumps in Org-mode.")
  9845. (defvar org-mark-ring-last-goto nil
  9846. "Last position in the mark ring used to go back.")
  9847. ;; Fill and close the ring
  9848. (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
  9849. (loop for i from 1 to org-mark-ring-length do
  9850. (push (make-marker) org-mark-ring))
  9851. (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
  9852. org-mark-ring)
  9853. (defun org-mark-ring-push (&optional pos buffer)
  9854. "Put the current position or POS into the mark ring and rotate it."
  9855. (interactive)
  9856. (setq pos (or pos (point)))
  9857. (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
  9858. (move-marker (car org-mark-ring)
  9859. (or pos (point))
  9860. (or buffer (current-buffer)))
  9861. (message "%s"
  9862. (substitute-command-keys
  9863. "Position saved to mark ring, go back with \\[org-mark-ring-goto].")))
  9864. (defun org-mark-ring-goto (&optional n)
  9865. "Jump to the previous position in the mark ring.
  9866. With prefix arg N, jump back that many stored positions. When
  9867. called several times in succession, walk through the entire ring.
  9868. Org-mode commands jumping to a different position in the current file,
  9869. or to another Org-mode file, automatically push the old position
  9870. onto the ring."
  9871. (interactive "p")
  9872. (let (p m)
  9873. (if (eq last-command this-command)
  9874. (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
  9875. (setq p org-mark-ring))
  9876. (setq org-mark-ring-last-goto p)
  9877. (setq m (car p))
  9878. (org-pop-to-buffer-same-window (marker-buffer m))
  9879. (goto-char m)
  9880. (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
  9881. (defun org-remove-angle-brackets (s)
  9882. (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
  9883. (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
  9884. s)
  9885. (defun org-add-angle-brackets (s)
  9886. (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
  9887. (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
  9888. s)
  9889. (defun org-remove-double-quotes (s)
  9890. (if (equal (substring s 0 1) "\"") (setq s (substring s 1)))
  9891. (if (equal (substring s -1) "\"") (setq s (substring s 0 -1)))
  9892. s)
  9893. ;;; Following specific links
  9894. (defun org-follow-timestamp-link ()
  9895. "Open an agenda view for the time-stamp date/range at point."
  9896. (cond
  9897. ((org-at-date-range-p t)
  9898. (let ((org-agenda-start-on-weekday)
  9899. (t1 (match-string 1))
  9900. (t2 (match-string 2)) tt1 tt2)
  9901. (setq tt1 (time-to-days (org-time-string-to-time t1))
  9902. tt2 (time-to-days (org-time-string-to-time t2)))
  9903. (let ((org-agenda-buffer-tmp-name
  9904. (format "*Org Agenda(a:%s)"
  9905. (concat (substring t1 0 10) "--" (substring t2 0 10)))))
  9906. (org-agenda-list nil tt1 (1+ (- tt2 tt1))))))
  9907. ((org-at-timestamp-p t)
  9908. (let ((org-agenda-buffer-tmp-name
  9909. (format "*Org Agenda(a:%s)" (substring (match-string 1) 0 10))))
  9910. (org-agenda-list nil (time-to-days (org-time-string-to-time
  9911. (substring (match-string 1) 0 10)))
  9912. 1)))
  9913. (t (error "This should not happen"))))
  9914. ;;; Following file links
  9915. (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
  9916. (declare-function mailcap-extension-to-mime "mailcap" (extn))
  9917. (declare-function mailcap-mime-info
  9918. "mailcap" (string &optional request no-decode))
  9919. (defvar org-wait nil)
  9920. (defun org-open-file (path &optional in-emacs line search)
  9921. "Open the file at PATH.
  9922. First, this expands any special file name abbreviations. Then the
  9923. configuration variable `org-file-apps' is checked if it contains an
  9924. entry for this file type, and if yes, the corresponding command is launched.
  9925. If no application is found, Emacs simply visits the file.
  9926. With optional prefix argument IN-EMACS, Emacs will visit the file.
  9927. With a double \\[universal-argument] \\[universal-argument] \
  9928. prefix arg, Org tries to avoid opening in Emacs
  9929. and to use an external application to visit the file.
  9930. Optional LINE specifies a line to go to, optional SEARCH a string
  9931. to search for. If LINE or SEARCH is given, the file will be
  9932. opened in Emacs, unless an entry from org-file-apps that makes
  9933. use of groups in a regexp matches.
  9934. If you want to change the way frames are used when following a
  9935. link, please customize `org-link-frame-setup'.
  9936. If the file does not exist, an error is thrown."
  9937. (let* ((file (if (equal path "")
  9938. buffer-file-name
  9939. (substitute-in-file-name (expand-file-name path))))
  9940. (file-apps (append org-file-apps (org-default-apps)))
  9941. (apps (org-remove-if
  9942. 'org-file-apps-entry-match-against-dlink-p file-apps))
  9943. (apps-dlink (org-remove-if-not
  9944. 'org-file-apps-entry-match-against-dlink-p file-apps))
  9945. (remp (and (assq 'remote apps) (org-file-remote-p file)))
  9946. (dirp (if remp nil (file-directory-p file)))
  9947. (file (if (and dirp org-open-directory-means-index-dot-org)
  9948. (concat (file-name-as-directory file) "index.org")
  9949. file))
  9950. (a-m-a-p (assq 'auto-mode apps))
  9951. (dfile (downcase file))
  9952. ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
  9953. (link (cond ((and (eq line nil)
  9954. (eq search nil))
  9955. file)
  9956. (line
  9957. (concat file "::" (number-to-string line)))
  9958. (search
  9959. (concat file "::" search))))
  9960. (dlink (downcase link))
  9961. (old-buffer (current-buffer))
  9962. (old-pos (point))
  9963. (old-mode major-mode)
  9964. ext cmd link-match-data)
  9965. (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\.gz\\)$" dfile)
  9966. (setq ext (match-string 1 dfile))
  9967. (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\)$" dfile)
  9968. (setq ext (match-string 1 dfile))))
  9969. (cond
  9970. ((member in-emacs '((16) system))
  9971. (setq cmd (cdr (assoc 'system apps))))
  9972. (in-emacs (setq cmd 'emacs))
  9973. (t
  9974. (setq cmd (or (and remp (cdr (assoc 'remote apps)))
  9975. (and dirp (cdr (assoc 'directory apps)))
  9976. ; first, try matching against apps-dlink
  9977. ; if we get a match here, store the match data for later
  9978. (let ((match (assoc-default dlink apps-dlink
  9979. 'string-match)))
  9980. (if match
  9981. (progn (setq link-match-data (match-data))
  9982. match)
  9983. (progn (setq in-emacs (or in-emacs line search))
  9984. nil))) ; if we have no match in apps-dlink,
  9985. ; always open the file in emacs if line or search
  9986. ; is given (for backwards compatibility)
  9987. (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
  9988. 'string-match)
  9989. (cdr (assoc ext apps))
  9990. (cdr (assoc t apps))))))
  9991. (when (eq cmd 'system)
  9992. (setq cmd (cdr (assoc 'system apps))))
  9993. (when (eq cmd 'default)
  9994. (setq cmd (cdr (assoc t apps))))
  9995. (when (eq cmd 'mailcap)
  9996. (require 'mailcap)
  9997. (mailcap-parse-mailcaps)
  9998. (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
  9999. (command (mailcap-mime-info mime-type)))
  10000. (if (stringp command)
  10001. (setq cmd command)
  10002. (setq cmd 'emacs))))
  10003. (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
  10004. (not (file-exists-p file))
  10005. (not org-open-non-existing-files))
  10006. (user-error "No such file: %s" file))
  10007. (cond
  10008. ((and (stringp cmd) (not (string-match "^\\s-*$" cmd)))
  10009. ;; Remove quotes around the file name - we'll use shell-quote-argument.
  10010. (while (string-match "['\"]%s['\"]" cmd)
  10011. (setq cmd (replace-match "%s" t t cmd)))
  10012. (while (string-match "%s" cmd)
  10013. (setq cmd (replace-match
  10014. (save-match-data
  10015. (shell-quote-argument
  10016. (convert-standard-filename file)))
  10017. t t cmd)))
  10018. ;; Replace "%1", "%2" etc. in command with group matches from regex
  10019. (save-match-data
  10020. (let ((match-index 1)
  10021. (number-of-groups (- (/ (length link-match-data) 2) 1)))
  10022. (set-match-data link-match-data)
  10023. (while (<= match-index number-of-groups)
  10024. (let ((regex (concat "%" (number-to-string match-index)))
  10025. (replace-with (match-string match-index dlink)))
  10026. (while (string-match regex cmd)
  10027. (setq cmd (replace-match replace-with t t cmd))))
  10028. (setq match-index (+ match-index 1)))))
  10029. (save-window-excursion
  10030. (message "Running %s...done" cmd)
  10031. (start-process-shell-command cmd nil cmd)
  10032. (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))))
  10033. ((or (stringp cmd)
  10034. (eq cmd 'emacs))
  10035. (funcall (cdr (assq 'file org-link-frame-setup)) file)
  10036. (widen)
  10037. (if line (org-goto-line line)
  10038. (if search (org-link-search search))))
  10039. ((consp cmd)
  10040. (let ((file (convert-standard-filename file)))
  10041. (save-match-data
  10042. (set-match-data link-match-data)
  10043. (eval cmd))))
  10044. (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
  10045. (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
  10046. (or (not (equal old-buffer (current-buffer)))
  10047. (not (equal old-pos (point))))
  10048. (org-mark-ring-push old-pos old-buffer))))
  10049. (defun org-file-apps-entry-match-against-dlink-p (entry)
  10050. "This function returns non-nil if `entry' uses a regular
  10051. expression which should be matched against the whole link by
  10052. org-open-file.
  10053. It assumes that is the case when the entry uses a regular
  10054. expression which has at least one grouping construct and the
  10055. action is either a lisp form or a command string containing
  10056. '%1', i.e. using at least one subexpression match as a
  10057. parameter."
  10058. (let ((selector (car entry))
  10059. (action (cdr entry)))
  10060. (if (stringp selector)
  10061. (and (> (regexp-opt-depth selector) 0)
  10062. (or (and (stringp action)
  10063. (string-match "%[0-9]" action))
  10064. (consp action)))
  10065. nil)))
  10066. (defun org-default-apps ()
  10067. "Return the default applications for this operating system."
  10068. (cond
  10069. ((eq system-type 'darwin)
  10070. org-file-apps-defaults-macosx)
  10071. ((eq system-type 'windows-nt)
  10072. org-file-apps-defaults-windowsnt)
  10073. (t org-file-apps-defaults-gnu)))
  10074. (defun org-apps-regexp-alist (list &optional add-auto-mode)
  10075. "Convert extensions to regular expressions in the cars of LIST.
  10076. Also, weed out any non-string entries, because the return value is used
  10077. only for regexp matching.
  10078. When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
  10079. point to the symbol `emacs', indicating that the file should
  10080. be opened in Emacs."
  10081. (append
  10082. (delq nil
  10083. (mapcar (lambda (x)
  10084. (if (not (stringp (car x)))
  10085. nil
  10086. (if (string-match "\\W" (car x))
  10087. x
  10088. (cons (concat "\\." (car x) "\\'") (cdr x)))))
  10089. list))
  10090. (if add-auto-mode
  10091. (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
  10092. (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
  10093. (defun org-file-remote-p (file)
  10094. "Test whether FILE specifies a location on a remote system.
  10095. Return non-nil if the location is indeed remote.
  10096. For example, the filename \"/user@host:/foo\" specifies a location
  10097. on the system \"/user@host:\"."
  10098. (cond ((fboundp 'file-remote-p)
  10099. (file-remote-p file))
  10100. ((fboundp 'tramp-handle-file-remote-p)
  10101. (tramp-handle-file-remote-p file))
  10102. ((and (boundp 'ange-ftp-name-format)
  10103. (string-match (car ange-ftp-name-format) file))
  10104. t)))
  10105. ;;;; Refiling
  10106. (defun org-get-org-file ()
  10107. "Read a filename, with default directory `org-directory'."
  10108. (let ((default (or org-default-notes-file remember-data-file)))
  10109. (read-file-name (format "File name [%s]: " default)
  10110. (file-name-as-directory org-directory)
  10111. default)))
  10112. (defun org-notes-order-reversed-p ()
  10113. "Check if the current file should receive notes in reversed order."
  10114. (cond
  10115. ((not org-reverse-note-order) nil)
  10116. ((eq t org-reverse-note-order) t)
  10117. ((not (listp org-reverse-note-order)) nil)
  10118. (t (catch 'exit
  10119. (let ((all org-reverse-note-order)
  10120. entry)
  10121. (while (setq entry (pop all))
  10122. (if (string-match (car entry) buffer-file-name)
  10123. (throw 'exit (cdr entry))))
  10124. nil)))))
  10125. (defvar org-refile-target-table nil
  10126. "The list of refile targets, created by `org-refile'.")
  10127. (defvar org-agenda-new-buffers nil
  10128. "Buffers created to visit agenda files.")
  10129. (defvar org-refile-cache nil
  10130. "Cache for refile targets.")
  10131. (defvar org-refile-markers nil
  10132. "All the markers used for caching refile locations.")
  10133. (defun org-refile-marker (pos)
  10134. "Get a new refile marker, but only if caching is in use."
  10135. (if (not org-refile-use-cache)
  10136. pos
  10137. (let ((m (make-marker)))
  10138. (move-marker m pos)
  10139. (push m org-refile-markers)
  10140. m)))
  10141. (defun org-refile-cache-clear ()
  10142. "Clear the refile cache and disable all the markers."
  10143. (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
  10144. (setq org-refile-markers nil)
  10145. (setq org-refile-cache nil)
  10146. (message "Refile cache has been cleared"))
  10147. (defun org-refile-cache-check-set (set)
  10148. "Check if all the markers in the cache still have live buffers."
  10149. (let (marker)
  10150. (catch 'exit
  10151. (while (and set (setq marker (nth 3 (pop set))))
  10152. ;; If `org-refile-use-outline-path' is 'file, marker may be nil
  10153. (when (and marker (null (marker-buffer marker)))
  10154. (message "Please regenerate the refile cache with `C-0 C-c C-w'")
  10155. (sit-for 3)
  10156. (throw 'exit nil)))
  10157. t)))
  10158. (defun org-refile-cache-put (set &rest identifiers)
  10159. "Push the refile targets SET into the cache, under IDENTIFIERS."
  10160. (let* ((key (sha1 (prin1-to-string identifiers)))
  10161. (entry (assoc key org-refile-cache)))
  10162. (if entry
  10163. (setcdr entry set)
  10164. (push (cons key set) org-refile-cache))))
  10165. (defun org-refile-cache-get (&rest identifiers)
  10166. "Retrieve the cached value for refile targets given by IDENTIFIERS."
  10167. (cond
  10168. ((not org-refile-cache) nil)
  10169. ((not org-refile-use-cache) (org-refile-cache-clear) nil)
  10170. (t
  10171. (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
  10172. org-refile-cache))))
  10173. (and set (org-refile-cache-check-set set) set)))))
  10174. (defun org-refile-get-targets (&optional default-buffer excluded-entries)
  10175. "Produce a table with refile targets."
  10176. (let ((case-fold-search nil)
  10177. ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
  10178. (entries (or org-refile-targets '((nil . (:level . 1)))))
  10179. targets tgs txt re files f desc descre fast-path-p level pos0)
  10180. (message "Getting targets...")
  10181. (with-current-buffer (or default-buffer (current-buffer))
  10182. (while (setq entry (pop entries))
  10183. (setq files (car entry) desc (cdr entry))
  10184. (setq fast-path-p nil)
  10185. (cond
  10186. ((null files) (setq files (list (current-buffer))))
  10187. ((eq files 'org-agenda-files)
  10188. (setq files (org-agenda-files 'unrestricted)))
  10189. ((and (symbolp files) (fboundp files))
  10190. (setq files (funcall files)))
  10191. ((and (symbolp files) (boundp files))
  10192. (setq files (symbol-value files))))
  10193. (if (stringp files) (setq files (list files)))
  10194. (cond
  10195. ((eq (car desc) :tag)
  10196. (setq descre (concat "^\\*+[ \t]+.*?:" (regexp-quote (cdr desc)) ":")))
  10197. ((eq (car desc) :todo)
  10198. (setq descre (concat "^\\*+[ \t]+" (regexp-quote (cdr desc)) "[ \t]")))
  10199. ((eq (car desc) :regexp)
  10200. (setq descre (cdr desc)))
  10201. ((eq (car desc) :level)
  10202. (setq descre (concat "^\\*\\{" (number-to-string
  10203. (if org-odd-levels-only
  10204. (1- (* 2 (cdr desc)))
  10205. (cdr desc)))
  10206. "\\}[ \t]")))
  10207. ((eq (car desc) :maxlevel)
  10208. (setq fast-path-p t)
  10209. (setq descre (concat "^\\*\\{1," (number-to-string
  10210. (if org-odd-levels-only
  10211. (1- (* 2 (cdr desc)))
  10212. (cdr desc)))
  10213. "\\}[ \t]")))
  10214. (t (error "Bad refiling target description %s" desc)))
  10215. (while (setq f (pop files))
  10216. (with-current-buffer
  10217. (if (bufferp f) f (org-get-agenda-file-buffer f))
  10218. (or
  10219. (setq tgs (org-refile-cache-get (buffer-file-name) descre))
  10220. (progn
  10221. (if (bufferp f) (setq f (buffer-file-name
  10222. (buffer-base-buffer f))))
  10223. (setq f (and f (expand-file-name f)))
  10224. (if (eq org-refile-use-outline-path 'file)
  10225. (push (list (file-name-nondirectory f) f nil nil) tgs))
  10226. (save-excursion
  10227. (save-restriction
  10228. (widen)
  10229. (goto-char (point-min))
  10230. (while (re-search-forward descre nil t)
  10231. (goto-char (setq pos0 (point-at-bol)))
  10232. (catch 'next
  10233. (when org-refile-target-verify-function
  10234. (save-match-data
  10235. (or (funcall org-refile-target-verify-function)
  10236. (throw 'next t))))
  10237. (when (and (looking-at org-complex-heading-regexp)
  10238. (not (member (match-string 4) excluded-entries))
  10239. (match-string 4))
  10240. (setq level (org-reduced-level
  10241. (- (match-end 1) (match-beginning 1)))
  10242. txt (org-link-display-format (match-string 4))
  10243. txt (replace-regexp-in-string "\\( *\[[0-9]+/?[0-9]*%?\]\\)+$" "" txt)
  10244. re (format org-complex-heading-regexp-format
  10245. (regexp-quote (match-string 4))))
  10246. (when org-refile-use-outline-path
  10247. (setq txt (mapconcat
  10248. 'org-protect-slash
  10249. (append
  10250. (if (eq org-refile-use-outline-path
  10251. 'file)
  10252. (list (file-name-nondirectory
  10253. (buffer-file-name
  10254. (buffer-base-buffer))))
  10255. (if (eq org-refile-use-outline-path
  10256. 'full-file-path)
  10257. (list (buffer-file-name
  10258. (buffer-base-buffer)))))
  10259. (org-get-outline-path fast-path-p
  10260. level txt)
  10261. (list txt))
  10262. "/")))
  10263. (push (list txt f re (org-refile-marker (point)))
  10264. tgs)))
  10265. (when (= (point) pos0)
  10266. ;; verification function has not moved point
  10267. (goto-char (point-at-eol))))))))
  10268. (when org-refile-use-cache
  10269. (org-refile-cache-put tgs (buffer-file-name) descre))
  10270. (setq targets (append tgs targets))))))
  10271. (message "Getting targets...done")
  10272. (nreverse targets)))
  10273. (defun org-protect-slash (s)
  10274. (while (string-match "/" s)
  10275. (setq s (replace-match "\\" t t s)))
  10276. s)
  10277. (defvar org-olpa (make-vector 20 nil))
  10278. (defun org-get-outline-path (&optional fastp level heading)
  10279. "Return the outline path to the current entry, as a list.
  10280. The parameters FASTP, LEVEL, and HEADING are for use by a scanner
  10281. routine which makes outline path derivations for an entire file,
  10282. avoiding backtracing. Refile target collection makes use of that."
  10283. (if fastp
  10284. (progn
  10285. (if (> level 19)
  10286. (error "Outline path failure, more than 19 levels"))
  10287. (loop for i from level upto 19 do
  10288. (aset org-olpa i nil))
  10289. (prog1
  10290. (delq nil (append org-olpa nil))
  10291. (aset org-olpa level heading)))
  10292. (let (rtn case-fold-search)
  10293. (save-excursion
  10294. (save-restriction
  10295. (widen)
  10296. (while (org-up-heading-safe)
  10297. (when (looking-at org-complex-heading-regexp)
  10298. (push (org-trim
  10299. (replace-regexp-in-string
  10300. ;; Remove statistical/checkboxes cookies
  10301. "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" ""
  10302. (org-match-string-no-properties 4)))
  10303. rtn)))
  10304. rtn)))))
  10305. (defun org-format-outline-path (path &optional width prefix separator)
  10306. "Format the outline path PATH for display.
  10307. WIDTH is the maximum number of characters that is available.
  10308. PREFIX is a prefix to be included in the returned string,
  10309. such as the file name.
  10310. SEPARATOR is inserted between the different parts of the path,
  10311. the default is \"/\"."
  10312. (setq width (or width 79))
  10313. (if prefix (setq width (- width (length prefix))))
  10314. (if (not path)
  10315. (or prefix "")
  10316. (let* ((nsteps (length path))
  10317. (total-width (+ nsteps (apply '+ (mapcar 'length path))))
  10318. (maxwidth (if (<= total-width width)
  10319. 10000 ;; everything fits
  10320. ;; we need to shorten the level headings
  10321. (/ (- width nsteps) nsteps)))
  10322. (org-odd-levels-only nil)
  10323. (n 0)
  10324. (total (1+ (length prefix))))
  10325. (setq maxwidth (max maxwidth 10))
  10326. (concat prefix
  10327. (if prefix (or separator "/"))
  10328. (mapconcat
  10329. (lambda (h)
  10330. (setq n (1+ n))
  10331. (if (and (= n nsteps) (< maxwidth 10000))
  10332. (setq maxwidth (- total-width total)))
  10333. (if (< (length h) maxwidth)
  10334. (progn (setq total (+ total (length h) 1)) h)
  10335. (setq h (substring h 0 (- maxwidth 2))
  10336. total (+ total maxwidth 1))
  10337. (if (string-match "[ \t]+\\'" h)
  10338. (setq h (substring h 0 (match-beginning 0))))
  10339. (setq h (concat h "..")))
  10340. (org-add-props h nil 'face
  10341. (nth (% (1- n) org-n-level-faces)
  10342. org-level-faces))
  10343. h)
  10344. path (or separator "/"))))))
  10345. (defun org-display-outline-path (&optional file current separator just-return-string)
  10346. "Display the current outline path in the echo area.
  10347. If FILE is non-nil, prepend the output with the file name.
  10348. If CURRENT is non-nil, append the current heading to the output.
  10349. SEPARATOR is passed through to `org-format-outline-path'. It separates
  10350. the different parts of the path and defaults to \"/\".
  10351. If JUST-RETURN-STRING is non-nil, return a string, don't display a message."
  10352. (interactive "P")
  10353. (let* (case-fold-search
  10354. (bfn (buffer-file-name (buffer-base-buffer)))
  10355. (path (and (derived-mode-p 'org-mode) (org-get-outline-path)))
  10356. res)
  10357. (if current (setq path (append path
  10358. (save-excursion
  10359. (org-back-to-heading t)
  10360. (if (looking-at org-complex-heading-regexp)
  10361. (list (match-string 4)))))))
  10362. (setq res
  10363. (org-format-outline-path
  10364. path
  10365. (1- (frame-width))
  10366. (and file bfn (concat (file-name-nondirectory bfn) separator))
  10367. separator))
  10368. (if just-return-string
  10369. (org-no-properties res)
  10370. (org-unlogged-message "%s" res))))
  10371. (defvar org-refile-history nil
  10372. "History for refiling operations.")
  10373. (defvar org-after-refile-insert-hook nil
  10374. "Hook run after `org-refile' has inserted its stuff at the new location.
  10375. Note that this is still *before* the stuff will be removed from
  10376. the *old* location.")
  10377. (defvar org-capture-last-stored-marker)
  10378. (defvar org-refile-keep nil
  10379. "Non-nil means `org-refile' will copy instead of refile.")
  10380. (defun org-copy ()
  10381. "Like `org-refile', but copy."
  10382. (interactive)
  10383. (let ((org-refile-keep t))
  10384. (funcall 'org-refile nil nil nil "Copy")))
  10385. (defun org-refile (&optional goto default-buffer rfloc msg)
  10386. "Move the entry or entries at point to another heading.
  10387. The list of target headings is compiled using the information in
  10388. `org-refile-targets', which see.
  10389. At the target location, the entry is filed as a subitem of the target
  10390. heading. Depending on `org-reverse-note-order', the new subitem will
  10391. either be the first or the last subitem.
  10392. If there is an active region, all entries in that region will be moved.
  10393. However, the region must fulfill the requirement that the first heading
  10394. is the first one sets the top-level of the moved text - at most siblings
  10395. below it are allowed.
  10396. With prefix arg GOTO, the command will only visit the target location
  10397. and not actually move anything.
  10398. With a double prefix arg \\[universal-argument] \\[universal-argument], \
  10399. go to the location where the last refiling operation has put the subtree.
  10400. With a numeric prefix argument of `2', refile to the running clock.
  10401. With a numeric prefix argument of `3', emulate `org-refile-keep'
  10402. being set to `t' and copy to the target location, don't move it.
  10403. Beware that keeping refiled entries may result in duplicated ID
  10404. properties.
  10405. RFLOC can be a refile location obtained in a different way.
  10406. MSG is a string to replace \"Refile\" in the default prompt with
  10407. another verb. E.g. `org-copy' sets this parameter to \"Copy\".
  10408. See also `org-refile-use-outline-path' and `org-completion-use-ido'.
  10409. If you are using target caching (see `org-refile-use-cache'),
  10410. you have to clear the target cache in order to find new targets.
  10411. This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
  10412. prefix argument (`C-u C-u C-u C-c C-w')."
  10413. (interactive "P")
  10414. (if (member goto '(0 (64)))
  10415. (org-refile-cache-clear)
  10416. (let* ((actionmsg (or msg "Refile"))
  10417. (cbuf (current-buffer))
  10418. (regionp (org-region-active-p))
  10419. (region-start (and regionp (region-beginning)))
  10420. (region-end (and regionp (region-end)))
  10421. (filename (buffer-file-name (buffer-base-buffer cbuf)))
  10422. (org-refile-keep (if (equal goto 3) t org-refile-keep))
  10423. pos it nbuf file re level reversed)
  10424. (setq last-command nil)
  10425. (when regionp
  10426. (goto-char region-start)
  10427. (or (bolp) (goto-char (point-at-bol)))
  10428. (setq region-start (point))
  10429. (unless (or (org-kill-is-subtree-p
  10430. (buffer-substring region-start region-end))
  10431. (prog1 org-refile-active-region-within-subtree
  10432. (let ((s (point-at-eol)))
  10433. (org-toggle-heading)
  10434. (setq region-end (+ (- (point-at-eol) s) region-end)))))
  10435. (user-error "The region is not a (sequence of) subtree(s)")))
  10436. (if (equal goto '(16))
  10437. (org-refile-goto-last-stored)
  10438. (when (or
  10439. (and (equal goto 2)
  10440. org-clock-hd-marker (marker-buffer org-clock-hd-marker)
  10441. (prog1
  10442. (setq it (list (or org-clock-heading "running clock")
  10443. (buffer-file-name
  10444. (marker-buffer org-clock-hd-marker))
  10445. ""
  10446. (marker-position org-clock-hd-marker)))
  10447. (setq goto nil)))
  10448. (setq it (or rfloc
  10449. (let (heading-text)
  10450. (save-excursion
  10451. (unless goto
  10452. (org-back-to-heading t)
  10453. (setq heading-text
  10454. (nth 4 (org-heading-components))))
  10455. (org-refile-get-location
  10456. (cond (goto "Goto")
  10457. (regionp (concat actionmsg " region to"))
  10458. (t (concat actionmsg " subtree \""
  10459. heading-text "\" to")))
  10460. default-buffer
  10461. (and (not (equal '(4) goto))
  10462. org-refile-allow-creating-parent-nodes)
  10463. goto))))))
  10464. (setq file (nth 1 it)
  10465. re (nth 2 it)
  10466. pos (nth 3 it))
  10467. (if (and (not goto)
  10468. pos
  10469. (equal (buffer-file-name) file)
  10470. (if regionp
  10471. (and (>= pos region-start)
  10472. (<= pos region-end))
  10473. (and (>= pos (point))
  10474. (< pos (save-excursion
  10475. (org-end-of-subtree t t))))))
  10476. (error "Cannot refile to position inside the tree or region"))
  10477. (setq nbuf (or (find-buffer-visiting file)
  10478. (find-file-noselect file)))
  10479. (if (and goto (not (equal goto 3)))
  10480. (progn
  10481. (org-pop-to-buffer-same-window nbuf)
  10482. (goto-char pos)
  10483. (org-show-context 'org-goto))
  10484. (if regionp
  10485. (progn
  10486. (org-kill-new (buffer-substring region-start region-end))
  10487. (org-save-markers-in-region region-start region-end))
  10488. (org-copy-subtree 1 nil t))
  10489. (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
  10490. (find-file-noselect file)))
  10491. (setq reversed (org-notes-order-reversed-p))
  10492. (save-excursion
  10493. (save-restriction
  10494. (widen)
  10495. (if pos
  10496. (progn
  10497. (goto-char pos)
  10498. (looking-at org-outline-regexp)
  10499. (setq level (org-get-valid-level (funcall outline-level) 1))
  10500. (goto-char
  10501. (if reversed
  10502. (or (outline-next-heading) (point-max))
  10503. (or (save-excursion (org-get-next-sibling))
  10504. (org-end-of-subtree t t)
  10505. (point-max)))))
  10506. (setq level 1)
  10507. (if (not reversed)
  10508. (goto-char (point-max))
  10509. (goto-char (point-min))
  10510. (or (outline-next-heading) (goto-char (point-max)))))
  10511. (if (not (bolp)) (newline))
  10512. (org-paste-subtree level)
  10513. (when org-log-refile
  10514. (org-add-log-setup 'refile nil nil 'findpos org-log-refile)
  10515. (unless (eq org-log-refile 'note)
  10516. (save-excursion (org-add-log-note))))
  10517. (and org-auto-align-tags
  10518. (let ((org-loop-over-headlines-in-active-region nil))
  10519. (org-set-tags nil t)))
  10520. (let ((bookmark-name (plist-get org-bookmark-names-plist
  10521. :last-refile)))
  10522. (when bookmark-name
  10523. (with-demoted-errors
  10524. (bookmark-set bookmark-name))))
  10525. ;; If we are refiling for capture, make sure that the
  10526. ;; last-capture pointers point here
  10527. (when (org-bound-and-true-p org-refile-for-capture)
  10528. (let ((bookmark-name (plist-get org-bookmark-names-plist
  10529. :last-capture-marker)))
  10530. (when bookmark-name
  10531. (with-demoted-errors
  10532. (bookmark-set bookmark-name))))
  10533. (move-marker org-capture-last-stored-marker (point)))
  10534. (if (fboundp 'deactivate-mark) (deactivate-mark))
  10535. (run-hooks 'org-after-refile-insert-hook))))
  10536. (unless org-refile-keep
  10537. (if regionp
  10538. (delete-region (point) (+ (point) (- region-end region-start)))
  10539. (delete-region
  10540. (and (org-back-to-heading t) (point))
  10541. (min (buffer-size) (org-end-of-subtree t t) (point)))))
  10542. (when (featurep 'org-inlinetask)
  10543. (org-inlinetask-remove-END-maybe))
  10544. (setq org-markers-to-move nil)
  10545. (message (concat actionmsg " to \"%s\" in file %s: done") (car it) file)))))))
  10546. (defun org-refile-goto-last-stored ()
  10547. "Go to the location where the last refile was stored."
  10548. (interactive)
  10549. (bookmark-jump "org-refile-last-stored")
  10550. (message "This is the location of the last refile"))
  10551. (defun org-refile-get-location (&optional prompt default-buffer new-nodes
  10552. no-exclude)
  10553. "Prompt the user for a refile location, using PROMPT.
  10554. PROMPT should not be suffixed with a colon and a space, because
  10555. this function appends the default value from
  10556. `org-refile-history' automatically, if that is not empty.
  10557. When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
  10558. this is used for the GOTO interface."
  10559. (let ((org-refile-targets org-refile-targets)
  10560. (org-refile-use-outline-path org-refile-use-outline-path)
  10561. excluded-entries)
  10562. (when (and (derived-mode-p 'org-mode)
  10563. (not org-refile-use-cache)
  10564. (not no-exclude))
  10565. (org-map-tree
  10566. (lambda()
  10567. (setq excluded-entries
  10568. (append excluded-entries (list (org-get-heading t t)))))))
  10569. (setq org-refile-target-table
  10570. (org-refile-get-targets default-buffer excluded-entries)))
  10571. (unless org-refile-target-table
  10572. (user-error "No refile targets"))
  10573. (let* ((cbuf (current-buffer))
  10574. (partial-completion-mode nil)
  10575. (cfn (buffer-file-name (buffer-base-buffer cbuf)))
  10576. (cfunc (if (and org-refile-use-outline-path
  10577. org-outline-path-complete-in-steps)
  10578. 'org-olpath-completing-read
  10579. 'org-icompleting-read))
  10580. (extra (if org-refile-use-outline-path "/" ""))
  10581. (cbnex (concat (buffer-name) extra))
  10582. (filename (and cfn (expand-file-name cfn)))
  10583. (tbl (mapcar
  10584. (lambda (x)
  10585. (if (and (not (member org-refile-use-outline-path
  10586. '(file full-file-path)))
  10587. (not (equal filename (nth 1 x))))
  10588. (cons (concat (car x) extra " ("
  10589. (file-name-nondirectory (nth 1 x)) ")")
  10590. (cdr x))
  10591. (cons (concat (car x) extra) (cdr x))))
  10592. org-refile-target-table))
  10593. (completion-ignore-case t)
  10594. cdef
  10595. (prompt (concat prompt
  10596. (or (and (car org-refile-history)
  10597. (concat " (default " (car org-refile-history) ")"))
  10598. (and (assoc cbnex tbl) (setq cdef cbnex)
  10599. (concat " (default " cbnex ")"))) ": "))
  10600. pa answ parent-target child parent old-hist)
  10601. (setq old-hist org-refile-history)
  10602. (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
  10603. nil 'org-refile-history (or cdef (car org-refile-history))))
  10604. (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
  10605. (org-refile-check-position pa)
  10606. (if pa
  10607. (progn
  10608. (when (or (not org-refile-history)
  10609. (not (eq old-hist org-refile-history))
  10610. (not (equal (car pa) (car org-refile-history))))
  10611. (setq org-refile-history
  10612. (cons (car pa) (if (assoc (car org-refile-history) tbl)
  10613. org-refile-history
  10614. (cdr org-refile-history))))
  10615. (if (equal (car org-refile-history) (nth 1 org-refile-history))
  10616. (pop org-refile-history)))
  10617. pa)
  10618. (if (string-match "\\`\\(.*\\)/\\([^/]+\\)\\'" answ)
  10619. (progn
  10620. (setq parent (match-string 1 answ)
  10621. child (match-string 2 answ))
  10622. (setq parent-target (or (assoc parent tbl)
  10623. (assoc (concat parent "/") tbl)))
  10624. (when (and parent-target
  10625. (or (eq new-nodes t)
  10626. (and (eq new-nodes 'confirm)
  10627. (y-or-n-p (format "Create new node \"%s\"? "
  10628. child)))))
  10629. (org-refile-new-child parent-target child)))
  10630. (user-error "Invalid target location")))))
  10631. (declare-function org-string-nw-p "org-macs" (s))
  10632. (defun org-refile-check-position (refile-pointer)
  10633. "Check if the refile pointer matches the headline to which it points."
  10634. (let* ((file (nth 1 refile-pointer))
  10635. (re (nth 2 refile-pointer))
  10636. (pos (nth 3 refile-pointer))
  10637. buffer)
  10638. (if (and (not (markerp pos)) (not file))
  10639. (user-error "Please save the buffer to a file before refiling")
  10640. (when (org-string-nw-p re)
  10641. (setq buffer (if (markerp pos)
  10642. (marker-buffer pos)
  10643. (or (find-buffer-visiting file)
  10644. (find-file-noselect file))))
  10645. (with-current-buffer buffer
  10646. (save-excursion
  10647. (save-restriction
  10648. (widen)
  10649. (goto-char pos)
  10650. (beginning-of-line 1)
  10651. (unless (org-looking-at-p re)
  10652. (user-error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling")))))))))
  10653. (defun org-refile-new-child (parent-target child)
  10654. "Use refile target PARENT-TARGET to add new CHILD below it."
  10655. (unless parent-target
  10656. (error "Cannot find parent for new node"))
  10657. (let ((file (nth 1 parent-target))
  10658. (pos (nth 3 parent-target))
  10659. level)
  10660. (with-current-buffer (or (find-buffer-visiting file)
  10661. (find-file-noselect file))
  10662. (save-excursion
  10663. (save-restriction
  10664. (widen)
  10665. (if pos
  10666. (goto-char pos)
  10667. (goto-char (point-max))
  10668. (if (not (bolp)) (newline)))
  10669. (when (looking-at org-outline-regexp)
  10670. (setq level (funcall outline-level))
  10671. (org-end-of-subtree t t))
  10672. (org-back-over-empty-lines)
  10673. (insert "\n" (make-string
  10674. (if pos (org-get-valid-level level 1) 1) ?*)
  10675. " " child "\n")
  10676. (beginning-of-line 0)
  10677. (list (concat (car parent-target) "/" child) file "" (point)))))))
  10678. (defun org-olpath-completing-read (prompt collection &rest args)
  10679. "Read an outline path like a file name."
  10680. (let ((thetable collection)
  10681. (org-completion-use-ido nil) ; does not work with ido.
  10682. (org-completion-use-iswitchb nil)) ; or iswitchb
  10683. (apply
  10684. 'org-icompleting-read prompt
  10685. (lambda (string predicate &optional flag)
  10686. (let (rtn r f (l (length string)))
  10687. (cond
  10688. ((eq flag nil)
  10689. ;; try completion
  10690. (try-completion string thetable))
  10691. ((eq flag t)
  10692. ;; all-completions
  10693. (setq rtn (all-completions string thetable predicate))
  10694. (mapcar
  10695. (lambda (x)
  10696. (setq r (substring x l))
  10697. (if (string-match " ([^)]*)$" x)
  10698. (setq f (match-string 0 x))
  10699. (setq f ""))
  10700. (if (string-match "/" r)
  10701. (concat string (substring r 0 (match-end 0)) f)
  10702. x))
  10703. rtn))
  10704. ((eq flag 'lambda)
  10705. ;; exact match?
  10706. (assoc string thetable)))))
  10707. args)))
  10708. ;;;; Dynamic blocks
  10709. (defun org-find-dblock (name)
  10710. "Find the first dynamic block with name NAME in the buffer.
  10711. If not found, stay at current position and return nil."
  10712. (let ((case-fold-search t) pos)
  10713. (save-excursion
  10714. (goto-char (point-min))
  10715. (setq pos (and (re-search-forward
  10716. (concat "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+" name "\\>") nil t)
  10717. (match-beginning 0))))
  10718. (if pos (goto-char pos))
  10719. pos))
  10720. (defconst org-dblock-start-re
  10721. "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+\\(\\S-+\\)\\([ \t]+\\(.*\\)\\)?"
  10722. "Matches the start line of a dynamic block, with parameters.")
  10723. (defconst org-dblock-end-re "^[ \t]*#\\+\\(?:END\\|end\\)\\([: \t\r\n]\\|$\\)"
  10724. "Matches the end of a dynamic block.")
  10725. (defun org-create-dblock (plist)
  10726. "Create a dynamic block section, with parameters taken from PLIST.
  10727. PLIST must contain a :name entry which is used as name of the block."
  10728. (when (string-match "\\S-" (buffer-substring (point-at-bol) (point-at-eol)))
  10729. (end-of-line 1)
  10730. (newline))
  10731. (let ((col (current-column))
  10732. (name (plist-get plist :name)))
  10733. (insert "#+BEGIN: " name)
  10734. (while plist
  10735. (if (eq (car plist) :name)
  10736. (setq plist (cddr plist))
  10737. (insert " " (prin1-to-string (pop plist)))))
  10738. (insert "\n\n" (make-string col ?\ ) "#+END:\n")
  10739. (beginning-of-line -2)))
  10740. (defun org-prepare-dblock ()
  10741. "Prepare dynamic block for refresh.
  10742. This empties the block, puts the cursor at the insert position and returns
  10743. the property list including an extra property :name with the block name."
  10744. (unless (looking-at org-dblock-start-re)
  10745. (user-error "Not at a dynamic block"))
  10746. (let* ((begdel (1+ (match-end 0)))
  10747. (name (org-no-properties (match-string 1)))
  10748. (params (append (list :name name)
  10749. (read (concat "(" (match-string 3) ")")))))
  10750. (save-excursion
  10751. (beginning-of-line 1)
  10752. (skip-chars-forward " \t")
  10753. (setq params (plist-put params :indentation-column (current-column))))
  10754. (unless (re-search-forward org-dblock-end-re nil t)
  10755. (error "Dynamic block not terminated"))
  10756. (setq params
  10757. (append params
  10758. (list :content (buffer-substring
  10759. begdel (match-beginning 0)))))
  10760. (delete-region begdel (match-beginning 0))
  10761. (goto-char begdel)
  10762. (open-line 1)
  10763. params))
  10764. (defun org-map-dblocks (&optional command)
  10765. "Apply COMMAND to all dynamic blocks in the current buffer.
  10766. If COMMAND is not given, use `org-update-dblock'."
  10767. (let ((cmd (or command 'org-update-dblock)))
  10768. (save-excursion
  10769. (goto-char (point-min))
  10770. (while (re-search-forward org-dblock-start-re nil t)
  10771. (goto-char (match-beginning 0))
  10772. (save-excursion
  10773. (condition-case nil
  10774. (funcall cmd)
  10775. (error (message "Error during update of dynamic block"))))
  10776. (unless (re-search-forward org-dblock-end-re nil t)
  10777. (error "Dynamic block not terminated"))))))
  10778. (defun org-dblock-update (&optional arg)
  10779. "User command for updating dynamic blocks.
  10780. Update the dynamic block at point. With prefix ARG, update all dynamic
  10781. blocks in the buffer."
  10782. (interactive "P")
  10783. (if arg
  10784. (org-update-all-dblocks)
  10785. (or (looking-at org-dblock-start-re)
  10786. (org-beginning-of-dblock))
  10787. (org-update-dblock)))
  10788. (defun org-update-dblock ()
  10789. "Update the dynamic block at point.
  10790. This means to empty the block, parse for parameters and then call
  10791. the correct writing function."
  10792. (interactive)
  10793. (save-window-excursion
  10794. (let* ((pos (point))
  10795. (line (org-current-line))
  10796. (params (org-prepare-dblock))
  10797. (name (plist-get params :name))
  10798. (indent (plist-get params :indentation-column))
  10799. (cmd (intern (concat "org-dblock-write:" name))))
  10800. (message "Updating dynamic block `%s' at line %d..." name line)
  10801. (funcall cmd params)
  10802. (message "Updating dynamic block `%s' at line %d...done" name line)
  10803. (goto-char pos)
  10804. (when (and indent (> indent 0))
  10805. (setq indent (make-string indent ?\ ))
  10806. (save-excursion
  10807. (org-beginning-of-dblock)
  10808. (forward-line 1)
  10809. (while (not (looking-at org-dblock-end-re))
  10810. (insert indent)
  10811. (beginning-of-line 2))
  10812. (when (looking-at org-dblock-end-re)
  10813. (and (looking-at "[ \t]+")
  10814. (replace-match ""))
  10815. (insert indent)))))))
  10816. (defun org-beginning-of-dblock ()
  10817. "Find the beginning of the dynamic block at point.
  10818. Error if there is no such block at point."
  10819. (let ((pos (point))
  10820. beg)
  10821. (end-of-line 1)
  10822. (if (and (re-search-backward org-dblock-start-re nil t)
  10823. (setq beg (match-beginning 0))
  10824. (re-search-forward org-dblock-end-re nil t)
  10825. (> (match-end 0) pos))
  10826. (goto-char beg)
  10827. (goto-char pos)
  10828. (error "Not in a dynamic block"))))
  10829. (defun org-update-all-dblocks ()
  10830. "Update all dynamic blocks in the buffer.
  10831. This function can be used in a hook."
  10832. (interactive)
  10833. (when (derived-mode-p 'org-mode)
  10834. (org-map-dblocks 'org-update-dblock)))
  10835. ;;;; Completion
  10836. (declare-function org-export-backend-name "org-export" (cl-x))
  10837. (declare-function org-export-backend-options "org-export" (cl-x))
  10838. (defun org-get-export-keywords ()
  10839. "Return a list of all currently understood export keywords.
  10840. Export keywords include options, block names, attributes and
  10841. keywords relative to each registered export back-end."
  10842. (let (keywords)
  10843. (dolist (backend
  10844. (org-bound-and-true-p org-export--registered-backends)
  10845. (delq nil keywords))
  10846. ;; Back-end name (for keywords, like #+LATEX:)
  10847. (push (upcase (symbol-name (org-export-backend-name backend))) keywords)
  10848. (dolist (option-entry (org-export-backend-options backend))
  10849. ;; Back-end options.
  10850. (push (nth 1 option-entry) keywords)))))
  10851. (defconst org-options-keywords
  10852. '("ARCHIVE:" "AUTHOR:" "BIND:" "CATEGORY:" "COLUMNS:" "CREATOR:" "DATE:"
  10853. "DESCRIPTION:" "DRAWERS:" "EMAIL:" "EXCLUDE_TAGS:" "FILETAGS:" "INCLUDE:"
  10854. "INDEX:" "KEYWORDS:" "LANGUAGE:" "MACRO:" "OPTIONS:" "PROPERTY:"
  10855. "PRIORITIES:" "SELECT_TAGS:" "SEQ_TODO:" "SETUPFILE:" "STARTUP:" "TAGS:"
  10856. "TITLE:" "TODO:" "TYP_TODO:" "SELECT_TAGS:" "EXCLUDE_TAGS:"))
  10857. (defcustom org-structure-template-alist
  10858. '(("s" "#+BEGIN_SRC ?\n\n#+END_SRC" "<src lang=\"?\">\n\n</src>")
  10859. ("e" "#+BEGIN_EXAMPLE\n?\n#+END_EXAMPLE" "<example>\n?\n</example>")
  10860. ("q" "#+BEGIN_QUOTE\n?\n#+END_QUOTE" "<quote>\n?\n</quote>")
  10861. ("v" "#+BEGIN_VERSE\n?\n#+END_VERSE" "<verse>\n?\n</verse>")
  10862. ("V" "#+BEGIN_VERBATIM\n?\n#+END_VERBATIM" "<verbatim>\n?\n</verbatim>")
  10863. ("c" "#+BEGIN_CENTER\n?\n#+END_CENTER" "<center>\n?\n</center>")
  10864. ("l" "#+BEGIN_LaTeX\n?\n#+END_LaTeX"
  10865. "<literal style=\"latex\">\n?\n</literal>")
  10866. ("L" "#+LaTeX: " "<literal style=\"latex\">?</literal>")
  10867. ("h" "#+BEGIN_HTML\n?\n#+END_HTML"
  10868. "<literal style=\"html\">\n?\n</literal>")
  10869. ("H" "#+HTML: " "<literal style=\"html\">?</literal>")
  10870. ("a" "#+BEGIN_ASCII\n?\n#+END_ASCII" "")
  10871. ("A" "#+ASCII: " "")
  10872. ("i" "#+INDEX: ?" "#+INDEX: ?")
  10873. ("I" "#+INCLUDE: %file ?"
  10874. "<include file=%file markup=\"?\">"))
  10875. "Structure completion elements.
  10876. This is a list of abbreviation keys and values. The value gets inserted
  10877. if you type `<' followed by the key and then press the completion key,
  10878. usually `M-TAB'. %file will be replaced by a file name after prompting
  10879. for the file using completion. The cursor will be placed at the position
  10880. of the `?` in the template.
  10881. There are two templates for each key, the first uses the original Org syntax,
  10882. the second uses Emacs Muse-like syntax tags. These Muse-like tags become
  10883. the default when the /org-mtags.el/ module has been loaded. See also the
  10884. variable `org-mtags-prefer-muse-templates'."
  10885. :group 'org-completion
  10886. :type '(repeat
  10887. (list
  10888. (string :tag "Key")
  10889. (string :tag "Template")
  10890. (string :tag "Muse Template"))))
  10891. (defun org-try-structure-completion ()
  10892. "Try to complete a structure template before point.
  10893. This looks for strings like \"<e\" on an otherwise empty line and
  10894. expands them."
  10895. (let ((l (buffer-substring (point-at-bol) (point)))
  10896. a)
  10897. (when (and (looking-at "[ \t]*$")
  10898. (string-match "^[ \t]*<\\([a-zA-Z]+\\)$" l)
  10899. (setq a (assoc (match-string 1 l) org-structure-template-alist)))
  10900. (org-complete-expand-structure-template (+ -1 (point-at-bol)
  10901. (match-beginning 1)) a)
  10902. t)))
  10903. (defun org-complete-expand-structure-template (start cell)
  10904. "Expand a structure template."
  10905. (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
  10906. (rpl (nth (if musep 2 1) cell))
  10907. (ind ""))
  10908. (delete-region start (point))
  10909. (when (string-match "\\`#\\+" rpl)
  10910. (cond
  10911. ((bolp))
  10912. ((not (string-match "\\S-" (buffer-substring (point-at-bol) (point))))
  10913. (setq ind (buffer-substring (point-at-bol) (point))))
  10914. (t (newline))))
  10915. (setq start (point))
  10916. (if (string-match "%file" rpl)
  10917. (setq rpl (replace-match
  10918. (concat
  10919. "\""
  10920. (save-match-data
  10921. (abbreviate-file-name (read-file-name "Include file: ")))
  10922. "\"")
  10923. t t rpl)))
  10924. (setq rpl (mapconcat 'identity (split-string rpl "\n")
  10925. (concat "\n" ind)))
  10926. (insert rpl)
  10927. (if (re-search-backward "\\?" start t) (delete-char 1))))
  10928. ;;;; TODO, DEADLINE, Comments
  10929. (defun org-toggle-comment ()
  10930. "Change the COMMENT state of an entry."
  10931. (interactive)
  10932. (save-excursion
  10933. (org-back-to-heading)
  10934. (let (case-fold-search)
  10935. (cond
  10936. ((looking-at (format org-heading-keyword-regexp-format
  10937. org-comment-string))
  10938. (goto-char (match-end 1))
  10939. (looking-at (concat " +" org-comment-string))
  10940. (replace-match "" t t)
  10941. (when (eolp) (insert " ")))
  10942. ((looking-at org-outline-regexp)
  10943. (goto-char (match-end 0))
  10944. (insert org-comment-string " "))))))
  10945. (defvar org-last-todo-state-is-todo nil
  10946. "This is non-nil when the last TODO state change led to a TODO state.
  10947. If the last change removed the TODO tag or switched to DONE, then
  10948. this is nil.")
  10949. (defvar org-setting-tags nil) ; dynamically skipped
  10950. (defvar org-todo-setup-filter-hook nil
  10951. "Hook for functions that pre-filter todo specs.
  10952. Each function takes a todo spec and returns either nil or the spec
  10953. transformed into canonical form." )
  10954. (defvar org-todo-get-default-hook nil
  10955. "Hook for functions that get a default item for todo.
  10956. Each function takes arguments (NEW-MARK OLD-MARK) and returns either
  10957. nil or a string to be used for the todo mark." )
  10958. (defvar org-agenda-headline-snapshot-before-repeat)
  10959. (defun org-current-effective-time ()
  10960. "Return current time adjusted for `org-extend-today-until' variable."
  10961. (let* ((ct (org-current-time))
  10962. (dct (decode-time ct))
  10963. (ct1
  10964. (cond
  10965. (org-use-last-clock-out-time-as-effective-time
  10966. (or (org-clock-get-last-clock-out-time) ct))
  10967. ((and org-use-effective-time (< (nth 2 dct) org-extend-today-until))
  10968. (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct)))
  10969. (t ct))))
  10970. ct1))
  10971. (defun org-todo-yesterday (&optional arg)
  10972. "Like `org-todo' but the time of change will be 23:59 of yesterday."
  10973. (interactive "P")
  10974. (if (eq major-mode 'org-agenda-mode)
  10975. (apply 'org-agenda-todo-yesterday arg)
  10976. (let* ((hour (third (decode-time
  10977. (org-current-time))))
  10978. (org-extend-today-until (1+ hour)))
  10979. (org-todo arg))))
  10980. (defvar org-block-entry-blocking ""
  10981. "First entry preventing the TODO state change.")
  10982. (defun org-todo (&optional arg)
  10983. "Change the TODO state of an item.
  10984. The state of an item is given by a keyword at the start of the heading,
  10985. like
  10986. *** TODO Write paper
  10987. *** DONE Call mom
  10988. The different keywords are specified in the variable `org-todo-keywords'.
  10989. By default the available states are \"TODO\" and \"DONE\".
  10990. So for this example: when the item starts with TODO, it is changed to DONE.
  10991. When it starts with DONE, the DONE is removed. And when neither TODO nor
  10992. DONE are present, add TODO at the beginning of the heading.
  10993. With \\[universal-argument] prefix arg, use completion to determine the new \
  10994. state.
  10995. With numeric prefix arg, switch to that state.
  10996. With a double \\[universal-argument] prefix, switch to the next set of TODO \
  10997. keywords (nextset).
  10998. With a triple \\[universal-argument] prefix, circumvent any state blocking.
  10999. With a numeric prefix arg of 0, inhibit note taking for the change.
  11000. For calling through lisp, arg is also interpreted in the following way:
  11001. 'none -> empty state
  11002. \"\"(empty string) -> switch to empty state
  11003. 'done -> switch to DONE
  11004. 'nextset -> switch to the next set of keywords
  11005. 'previousset -> switch to the previous set of keywords
  11006. \"WAITING\" -> switch to the specified keyword, but only if it
  11007. really is a member of `org-todo-keywords'."
  11008. (interactive "P")
  11009. (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
  11010. (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
  11011. 'region-start-level 'region))
  11012. org-loop-over-headlines-in-active-region)
  11013. (org-map-entries
  11014. `(org-todo ,arg)
  11015. org-loop-over-headlines-in-active-region
  11016. cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
  11017. (if (equal arg '(16)) (setq arg 'nextset))
  11018. (let ((org-blocker-hook org-blocker-hook)
  11019. commentp
  11020. case-fold-search)
  11021. (when (equal arg '(64))
  11022. (setq arg nil org-blocker-hook nil))
  11023. (when (and org-blocker-hook
  11024. (or org-inhibit-blocking
  11025. (org-entry-get nil "NOBLOCKING")))
  11026. (setq org-blocker-hook nil))
  11027. (save-excursion
  11028. (catch 'exit
  11029. (org-back-to-heading t)
  11030. (when (looking-at (concat "^\\*+ " org-comment-string))
  11031. (org-toggle-comment)
  11032. (setq commentp t))
  11033. (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
  11034. (or (looking-at (concat " +" org-todo-regexp "\\( +\\|[ \t]*$\\)"))
  11035. (looking-at "\\(?: *\\|[ \t]*$\\)"))
  11036. (let* ((match-data (match-data))
  11037. (startpos (point-at-bol))
  11038. (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
  11039. (org-log-done org-log-done)
  11040. (org-log-repeat org-log-repeat)
  11041. (org-todo-log-states org-todo-log-states)
  11042. (org-inhibit-logging
  11043. (if (equal arg 0)
  11044. (progn (setq arg nil) 'note) org-inhibit-logging))
  11045. (this (match-string 1))
  11046. (hl-pos (match-beginning 0))
  11047. (head (org-get-todo-sequence-head this))
  11048. (ass (assoc head org-todo-kwd-alist))
  11049. (interpret (nth 1 ass))
  11050. (done-word (nth 3 ass))
  11051. (final-done-word (nth 4 ass))
  11052. (org-last-state (or this ""))
  11053. (completion-ignore-case t)
  11054. (member (member this org-todo-keywords-1))
  11055. (tail (cdr member))
  11056. (org-state (cond
  11057. ((and org-todo-key-trigger
  11058. (or (and (equal arg '(4))
  11059. (eq org-use-fast-todo-selection 'prefix))
  11060. (and (not arg) org-use-fast-todo-selection
  11061. (not (eq org-use-fast-todo-selection
  11062. 'prefix)))))
  11063. ;; Use fast selection
  11064. (org-fast-todo-selection))
  11065. ((and (equal arg '(4))
  11066. (or (not org-use-fast-todo-selection)
  11067. (not org-todo-key-trigger)))
  11068. ;; Read a state with completion
  11069. (org-icompleting-read
  11070. "State: " (mapcar 'list org-todo-keywords-1)
  11071. nil t))
  11072. ((eq arg 'right)
  11073. (if this
  11074. (if tail (car tail) nil)
  11075. (car org-todo-keywords-1)))
  11076. ((eq arg 'left)
  11077. (if (equal member org-todo-keywords-1)
  11078. nil
  11079. (if this
  11080. (nth (- (length org-todo-keywords-1)
  11081. (length tail) 2)
  11082. org-todo-keywords-1)
  11083. (org-last org-todo-keywords-1))))
  11084. ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
  11085. (setq arg nil))) ; hack to fall back to cycling
  11086. (arg
  11087. ;; user or caller requests a specific state
  11088. (cond
  11089. ((equal arg "") nil)
  11090. ((eq arg 'none) nil)
  11091. ((eq arg 'done) (or done-word (car org-done-keywords)))
  11092. ((eq arg 'nextset)
  11093. (or (car (cdr (member head org-todo-heads)))
  11094. (car org-todo-heads)))
  11095. ((eq arg 'previousset)
  11096. (let ((org-todo-heads (reverse org-todo-heads)))
  11097. (or (car (cdr (member head org-todo-heads)))
  11098. (car org-todo-heads))))
  11099. ((car (member arg org-todo-keywords-1)))
  11100. ((stringp arg)
  11101. (user-error "State `%s' not valid in this file" arg))
  11102. ((nth (1- (prefix-numeric-value arg))
  11103. org-todo-keywords-1))))
  11104. ((null member) (or head (car org-todo-keywords-1)))
  11105. ((equal this final-done-word) nil) ;; -> make empty
  11106. ((null tail) nil) ;; -> first entry
  11107. ((memq interpret '(type priority))
  11108. (if (eq this-command last-command)
  11109. (car tail)
  11110. (if (> (length tail) 0)
  11111. (or done-word (car org-done-keywords))
  11112. nil)))
  11113. (t
  11114. (car tail))))
  11115. (org-state (or
  11116. (run-hook-with-args-until-success
  11117. 'org-todo-get-default-hook org-state org-last-state)
  11118. org-state))
  11119. (next (if org-state (concat " " org-state " ") " "))
  11120. (change-plist (list :type 'todo-state-change :from this :to org-state
  11121. :position startpos))
  11122. dolog now-done-p)
  11123. (when org-blocker-hook
  11124. (setq org-last-todo-state-is-todo
  11125. (not (member this org-done-keywords)))
  11126. (unless (save-excursion
  11127. (save-match-data
  11128. (org-with-wide-buffer
  11129. (run-hook-with-args-until-failure
  11130. 'org-blocker-hook change-plist))))
  11131. (if (org-called-interactively-p 'interactive)
  11132. (user-error "TODO state change from %s to %s blocked (by \"%s\")"
  11133. this org-state org-block-entry-blocking)
  11134. ;; fail silently
  11135. (message "TODO state change from %s to %s blocked (by \"%s\")"
  11136. this org-state org-block-entry-blocking)
  11137. (throw 'exit nil))))
  11138. (store-match-data match-data)
  11139. (replace-match next t t)
  11140. (unless (pos-visible-in-window-p hl-pos)
  11141. (message "TODO state changed to %s" (org-trim next)))
  11142. (unless head
  11143. (setq head (org-get-todo-sequence-head org-state)
  11144. ass (assoc head org-todo-kwd-alist)
  11145. interpret (nth 1 ass)
  11146. done-word (nth 3 ass)
  11147. final-done-word (nth 4 ass)))
  11148. (when (memq arg '(nextset previousset))
  11149. (message "Keyword-Set %d/%d: %s"
  11150. (- (length org-todo-sets) -1
  11151. (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
  11152. (length org-todo-sets)
  11153. (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
  11154. (setq org-last-todo-state-is-todo
  11155. (not (member org-state org-done-keywords)))
  11156. (setq now-done-p (and (member org-state org-done-keywords)
  11157. (not (member this org-done-keywords))))
  11158. (and logging (org-local-logging logging))
  11159. (when (and (or org-todo-log-states org-log-done)
  11160. (not (eq org-inhibit-logging t))
  11161. (not (memq arg '(nextset previousset))))
  11162. ;; we need to look at recording a time and note
  11163. (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
  11164. (nth 2 (assoc this org-todo-log-states))))
  11165. (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
  11166. (setq dolog 'time))
  11167. (when (or (and (not org-state) (not org-closed-keep-when-no-todo))
  11168. (and org-state
  11169. (member org-state org-not-done-keywords)
  11170. (not (member this org-not-done-keywords))))
  11171. ;; This is now a todo state and was not one before
  11172. ;; If there was a CLOSED time stamp, get rid of it.
  11173. (org-add-planning-info nil nil 'closed))
  11174. (when (and now-done-p org-log-done)
  11175. ;; It is now done, and it was not done before
  11176. (org-add-planning-info 'closed (org-current-effective-time))
  11177. (if (and (not dolog) (eq 'note org-log-done))
  11178. (org-add-log-setup 'done org-state this 'findpos 'note)))
  11179. (when (and org-state dolog)
  11180. ;; This is a non-nil state, and we need to log it
  11181. (org-add-log-setup 'state org-state this 'findpos dolog)))
  11182. ;; Fixup tag positioning
  11183. (org-todo-trigger-tag-changes org-state)
  11184. (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
  11185. (when org-provide-todo-statistics
  11186. (org-update-parent-todo-statistics))
  11187. (run-hooks 'org-after-todo-state-change-hook)
  11188. (if (and arg (not (member org-state org-done-keywords)))
  11189. (setq head (org-get-todo-sequence-head org-state)))
  11190. (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
  11191. ;; Do we need to trigger a repeat?
  11192. (when now-done-p
  11193. (when (boundp 'org-agenda-headline-snapshot-before-repeat)
  11194. ;; This is for the agenda, take a snapshot of the headline.
  11195. (save-match-data
  11196. (setq org-agenda-headline-snapshot-before-repeat
  11197. (org-get-heading))))
  11198. (org-auto-repeat-maybe org-state))
  11199. ;; Fixup cursor location if close to the keyword
  11200. (if (and (outline-on-heading-p)
  11201. (not (bolp))
  11202. (save-excursion (beginning-of-line 1)
  11203. (looking-at org-todo-line-regexp))
  11204. (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
  11205. (progn
  11206. (goto-char (or (match-end 2) (match-end 1)))
  11207. (and (looking-at " ") (just-one-space))))
  11208. (when org-trigger-hook
  11209. (save-excursion
  11210. (run-hook-with-args 'org-trigger-hook change-plist)))
  11211. (when commentp (org-toggle-comment))))))))
  11212. (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
  11213. "Block turning an entry into a TODO, using the hierarchy.
  11214. This checks whether the current task should be blocked from state
  11215. changes. Such blocking occurs when:
  11216. 1. The task has children which are not all in a completed state.
  11217. 2. A task has a parent with the property :ORDERED:, and there
  11218. are siblings prior to the current task with incomplete
  11219. status.
  11220. 3. The parent of the task is blocked because it has siblings that should
  11221. be done first, or is child of a block grandparent TODO entry."
  11222. (if (not org-enforce-todo-dependencies)
  11223. t ; if locally turned off don't block
  11224. (catch 'dont-block
  11225. ;; If this is not a todo state change, or if this entry is already DONE,
  11226. ;; do not block
  11227. (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
  11228. (member (plist-get change-plist :from)
  11229. (cons 'done org-done-keywords))
  11230. (member (plist-get change-plist :to)
  11231. (cons 'todo org-not-done-keywords))
  11232. (not (plist-get change-plist :to)))
  11233. (throw 'dont-block t))
  11234. ;; If this task has children, and any are undone, it's blocked
  11235. (save-excursion
  11236. (org-back-to-heading t)
  11237. (let ((this-level (funcall outline-level)))
  11238. (outline-next-heading)
  11239. (let ((child-level (funcall outline-level)))
  11240. (while (and (not (eobp))
  11241. (> child-level this-level))
  11242. ;; this todo has children, check whether they are all
  11243. ;; completed
  11244. (if (and (not (org-entry-is-done-p))
  11245. (org-entry-is-todo-p))
  11246. (progn (setq org-block-entry-blocking (org-get-heading))
  11247. (throw 'dont-block nil)))
  11248. (outline-next-heading)
  11249. (setq child-level (funcall outline-level))))))
  11250. ;; Otherwise, if the task's parent has the :ORDERED: property, and
  11251. ;; any previous siblings are undone, it's blocked
  11252. (save-excursion
  11253. (org-back-to-heading t)
  11254. (let* ((pos (point))
  11255. (parent-pos (and (org-up-heading-safe) (point))))
  11256. (if (not parent-pos) (throw 'dont-block t)) ; no parent
  11257. (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
  11258. (forward-line 1)
  11259. (re-search-forward org-not-done-heading-regexp pos t))
  11260. (setq org-block-entry-blocking (match-string 0))
  11261. (throw 'dont-block nil)) ; block, there is an older sibling not done.
  11262. ;; Search further up the hierarchy, to see if an ancestor is blocked
  11263. (while t
  11264. (goto-char parent-pos)
  11265. (if (not (looking-at org-not-done-heading-regexp))
  11266. (throw 'dont-block t)) ; do not block, parent is not a TODO
  11267. (setq pos (point))
  11268. (setq parent-pos (and (org-up-heading-safe) (point)))
  11269. (if (not parent-pos) (throw 'dont-block t)) ; no parent
  11270. (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
  11271. (forward-line 1)
  11272. (re-search-forward org-not-done-heading-regexp pos t)
  11273. (setq org-block-entry-blocking (org-get-heading)))
  11274. (throw 'dont-block nil)))))))) ; block, older sibling not done.
  11275. (defcustom org-track-ordered-property-with-tag nil
  11276. "Should the ORDERED property also be shown as a tag?
  11277. The ORDERED property decides if an entry should require subtasks to be
  11278. completed in sequence. Since a property is not very visible, setting
  11279. this option means that toggling the ORDERED property with the command
  11280. `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
  11281. not relevant for the behavior, but it makes things more visible.
  11282. Note that toggling the tag with tags commands will not change the property
  11283. and therefore not influence behavior!
  11284. This can be t, meaning the tag ORDERED should be used, It can also be a
  11285. string to select a different tag for this task."
  11286. :group 'org-todo
  11287. :type '(choice
  11288. (const :tag "No tracking" nil)
  11289. (const :tag "Track with ORDERED tag" t)
  11290. (string :tag "Use other tag")))
  11291. (defun org-toggle-ordered-property ()
  11292. "Toggle the ORDERED property of the current entry.
  11293. For better visibility, you can track the value of this property with a tag.
  11294. See variable `org-track-ordered-property-with-tag'."
  11295. (interactive)
  11296. (let* ((t1 org-track-ordered-property-with-tag)
  11297. (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
  11298. (save-excursion
  11299. (org-back-to-heading)
  11300. (if (org-entry-get nil "ORDERED")
  11301. (progn
  11302. (org-delete-property "ORDERED" "PROPERTIES")
  11303. (and tag (org-toggle-tag tag 'off))
  11304. (message "Subtasks can be completed in arbitrary order"))
  11305. (org-entry-put nil "ORDERED" "t")
  11306. (and tag (org-toggle-tag tag 'on))
  11307. (message "Subtasks must be completed in sequence")))))
  11308. (defvar org-blocked-by-checkboxes) ; dynamically scoped
  11309. (defun org-block-todo-from-checkboxes (change-plist)
  11310. "Block turning an entry into a TODO, using checkboxes.
  11311. This checks whether the current task should be blocked from state
  11312. changes because there are unchecked boxes in this entry."
  11313. (if (not org-enforce-todo-checkbox-dependencies)
  11314. t ; if locally turned off don't block
  11315. (catch 'dont-block
  11316. ;; If this is not a todo state change, or if this entry is already DONE,
  11317. ;; do not block
  11318. (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
  11319. (member (plist-get change-plist :from)
  11320. (cons 'done org-done-keywords))
  11321. (member (plist-get change-plist :to)
  11322. (cons 'todo org-not-done-keywords))
  11323. (not (plist-get change-plist :to)))
  11324. (throw 'dont-block t))
  11325. ;; If this task has checkboxes that are not checked, it's blocked
  11326. (save-excursion
  11327. (org-back-to-heading t)
  11328. (let ((beg (point)) end)
  11329. (outline-next-heading)
  11330. (setq end (point))
  11331. (goto-char beg)
  11332. (if (org-list-search-forward
  11333. (concat (org-item-beginning-re)
  11334. "\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?"
  11335. "\\[[- ]\\]")
  11336. end t)
  11337. (progn
  11338. (if (boundp 'org-blocked-by-checkboxes)
  11339. (setq org-blocked-by-checkboxes t))
  11340. (throw 'dont-block nil)))))
  11341. t))) ; do not block
  11342. (defun org-entry-blocked-p ()
  11343. "Is the current entry blocked?"
  11344. (org-with-silent-modifications
  11345. (if (org-entry-get nil "NOBLOCKING")
  11346. nil ;; Never block this entry
  11347. (not (run-hook-with-args-until-failure
  11348. 'org-blocker-hook
  11349. (list :type 'todo-state-change
  11350. :position (point)
  11351. :from 'todo
  11352. :to 'done))))))
  11353. (defun org-update-statistics-cookies (all)
  11354. "Update the statistics cookie, either from TODO or from checkboxes.
  11355. This should be called with the cursor in a line with a statistics cookie."
  11356. (interactive "P")
  11357. (if all
  11358. (progn
  11359. (org-update-checkbox-count 'all)
  11360. (org-map-entries 'org-update-parent-todo-statistics))
  11361. (if (not (org-at-heading-p))
  11362. (org-update-checkbox-count)
  11363. (let ((pos (point-marker))
  11364. end l1 l2)
  11365. (ignore-errors (org-back-to-heading t))
  11366. (if (not (org-at-heading-p))
  11367. (org-update-checkbox-count)
  11368. (setq l1 (org-outline-level))
  11369. (setq end (save-excursion
  11370. (outline-next-heading)
  11371. (if (org-at-heading-p) (setq l2 (org-outline-level)))
  11372. (point)))
  11373. (if (and (save-excursion
  11374. (re-search-forward
  11375. "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) \\[[- X]\\]" end t))
  11376. (not (save-excursion (re-search-forward
  11377. ":COOKIE_DATA:.*\\<todo\\>" end t))))
  11378. (org-update-checkbox-count)
  11379. (if (and l2 (> l2 l1))
  11380. (progn
  11381. (goto-char end)
  11382. (org-update-parent-todo-statistics))
  11383. (goto-char pos)
  11384. (beginning-of-line 1)
  11385. (while (re-search-forward
  11386. "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)"
  11387. (point-at-eol) t)
  11388. (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
  11389. (goto-char pos)
  11390. (move-marker pos nil)))))
  11391. (defvar org-entry-property-inherited-from) ;; defined below
  11392. (defun org-update-parent-todo-statistics ()
  11393. "Update any statistics cookie in the parent of the current headline.
  11394. When `org-hierarchical-todo-statistics' is nil, statistics will cover
  11395. the entire subtree and this will travel up the hierarchy and update
  11396. statistics everywhere."
  11397. (let* ((prop (save-excursion (org-up-heading-safe)
  11398. (org-entry-get nil "COOKIE_DATA" 'inherit)))
  11399. (recursive (or (not org-hierarchical-todo-statistics)
  11400. (and prop (string-match "\\<recursive\\>" prop))))
  11401. (lim (or (and prop (marker-position org-entry-property-inherited-from))
  11402. 0))
  11403. (first t)
  11404. (box-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
  11405. level ltoggle l1 new ndel
  11406. (cnt-all 0) (cnt-done 0) is-percent kwd
  11407. checkbox-beg ov ovs ove cookie-present)
  11408. (catch 'exit
  11409. (save-excursion
  11410. (beginning-of-line 1)
  11411. (setq ltoggle (funcall outline-level))
  11412. ;; Three situations are to consider:
  11413. ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
  11414. ;; to the top-level ancestor on the headline;
  11415. ;; 2. If parent has "recursive" property, repeat up to the
  11416. ;; headline setting that property, taking inheritance into
  11417. ;; account;
  11418. ;; 3. Else, move up to direct parent and proceed only once.
  11419. (while (and (setq level (org-up-heading-safe))
  11420. (or recursive first)
  11421. (>= (point) lim))
  11422. (setq first nil cookie-present nil)
  11423. (unless (and level
  11424. (not (string-match
  11425. "\\<checkbox\\>"
  11426. (downcase (or (org-entry-get nil "COOKIE_DATA")
  11427. "")))))
  11428. (throw 'exit nil))
  11429. (while (re-search-forward box-re (point-at-eol) t)
  11430. (setq cnt-all 0 cnt-done 0 cookie-present t)
  11431. (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
  11432. (save-match-data
  11433. (unless (outline-next-heading) (throw 'exit nil))
  11434. (while (and (looking-at org-complex-heading-regexp)
  11435. (> (setq l1 (length (match-string 1))) level))
  11436. (setq kwd (and (or recursive (= l1 ltoggle))
  11437. (match-string 2)))
  11438. (if (or (eq org-provide-todo-statistics 'all-headlines)
  11439. (and (listp org-provide-todo-statistics)
  11440. (or (member kwd org-provide-todo-statistics)
  11441. (member kwd org-done-keywords))))
  11442. (setq cnt-all (1+ cnt-all))
  11443. (if (eq org-provide-todo-statistics t)
  11444. (and kwd (setq cnt-all (1+ cnt-all)))))
  11445. (and (member kwd org-done-keywords)
  11446. (setq cnt-done (1+ cnt-done)))
  11447. (outline-next-heading)))
  11448. (setq new
  11449. (if is-percent
  11450. (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
  11451. (format "[%d/%d]" cnt-done cnt-all))
  11452. ndel (- (match-end 0) checkbox-beg))
  11453. ;; handle overlays when updating cookie from column view
  11454. (when (setq ov (car (overlays-at checkbox-beg)))
  11455. (setq ovs (overlay-start ov) ove (overlay-end ov))
  11456. (delete-overlay ov))
  11457. (goto-char checkbox-beg)
  11458. (insert new)
  11459. (delete-region (point) (+ (point) ndel))
  11460. (when org-auto-align-tags (org-fix-tags-on-the-fly))
  11461. (when ov (move-overlay ov ovs ove)))
  11462. (when cookie-present
  11463. (run-hook-with-args 'org-after-todo-statistics-hook
  11464. cnt-done (- cnt-all cnt-done))))))
  11465. (run-hooks 'org-todo-statistics-hook)))
  11466. (defvar org-after-todo-statistics-hook nil
  11467. "Hook that is called after a TODO statistics cookie has been updated.
  11468. Each function is called with two arguments: the number of not-done entries
  11469. and the number of done entries.
  11470. For example, the following function, when added to this hook, will switch
  11471. an entry to DONE when all children are done, and back to TODO when new
  11472. entries are set to a TODO status. Note that this hook is only called
  11473. when there is a statistics cookie in the headline!
  11474. (defun org-summary-todo (n-done n-not-done)
  11475. \"Switch entry to DONE when all subentries are done, to TODO otherwise.\"
  11476. (let (org-log-done org-log-states) ; turn off logging
  11477. (org-todo (if (= n-not-done 0) \"DONE\" \"TODO\"))))
  11478. ")
  11479. (defvar org-todo-statistics-hook nil
  11480. "Hook that is run whenever Org thinks TODO statistics should be updated.
  11481. This hook runs even if there is no statistics cookie present, in which case
  11482. `org-after-todo-statistics-hook' would not run.")
  11483. (defun org-todo-trigger-tag-changes (state)
  11484. "Apply the changes defined in `org-todo-state-tags-triggers'."
  11485. (let ((l org-todo-state-tags-triggers)
  11486. changes)
  11487. (when (or (not state) (equal state ""))
  11488. (setq changes (append changes (cdr (assoc "" l)))))
  11489. (when (and (stringp state) (> (length state) 0))
  11490. (setq changes (append changes (cdr (assoc state l)))))
  11491. (when (member state org-not-done-keywords)
  11492. (setq changes (append changes (cdr (assoc 'todo l)))))
  11493. (when (member state org-done-keywords)
  11494. (setq changes (append changes (cdr (assoc 'done l)))))
  11495. (dolist (c changes)
  11496. (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
  11497. (defun org-local-logging (value)
  11498. "Get logging settings from a property VALUE."
  11499. (let* (words w a)
  11500. ;; directly set the variables, they are already local.
  11501. (setq org-log-done nil
  11502. org-log-repeat nil
  11503. org-todo-log-states nil)
  11504. (setq words (org-split-string value))
  11505. (while (setq w (pop words))
  11506. (cond
  11507. ((setq a (assoc w org-startup-options))
  11508. (and (member (nth 1 a) '(org-log-done org-log-repeat))
  11509. (set (nth 1 a) (nth 2 a))))
  11510. ((setq a (org-extract-log-state-settings w))
  11511. (and (member (car a) org-todo-keywords-1)
  11512. (push a org-todo-log-states)))))))
  11513. (defun org-get-todo-sequence-head (kwd)
  11514. "Return the head of the TODO sequence to which KWD belongs.
  11515. If KWD is not set, check if there is a text property remembering the
  11516. right sequence."
  11517. (let (p)
  11518. (cond
  11519. ((not kwd)
  11520. (or (get-text-property (point-at-bol) 'org-todo-head)
  11521. (progn
  11522. (setq p (next-single-property-change (point-at-bol) 'org-todo-head
  11523. nil (point-at-eol)))
  11524. (get-text-property p 'org-todo-head))))
  11525. ((not (member kwd org-todo-keywords-1))
  11526. (car org-todo-keywords-1))
  11527. (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
  11528. (defun org-fast-todo-selection ()
  11529. "Fast TODO keyword selection with single keys.
  11530. Returns the new TODO keyword, or nil if no state change should occur."
  11531. (let* ((fulltable org-todo-key-alist)
  11532. (done-keywords org-done-keywords) ;; needed for the faces.
  11533. (maxlen (apply 'max (mapcar
  11534. (lambda (x)
  11535. (if (stringp (car x)) (string-width (car x)) 0))
  11536. fulltable)))
  11537. (expert nil)
  11538. (fwidth (+ maxlen 3 1 3))
  11539. (ncol (/ (- (window-width) 4) fwidth))
  11540. tg cnt e c tbl
  11541. groups ingroup)
  11542. (save-excursion
  11543. (save-window-excursion
  11544. (if expert
  11545. (set-buffer (get-buffer-create " *Org todo*"))
  11546. (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
  11547. (erase-buffer)
  11548. (org-set-local 'org-done-keywords done-keywords)
  11549. (setq tbl fulltable cnt 0)
  11550. (while (setq e (pop tbl))
  11551. (cond
  11552. ((equal e '(:startgroup))
  11553. (push '() groups) (setq ingroup t)
  11554. (when (not (= cnt 0))
  11555. (setq cnt 0)
  11556. (insert "\n"))
  11557. (insert "{ "))
  11558. ((equal e '(:endgroup))
  11559. (setq ingroup nil cnt 0)
  11560. (insert "}\n"))
  11561. ((equal e '(:newline))
  11562. (when (not (= cnt 0))
  11563. (setq cnt 0)
  11564. (insert "\n")
  11565. (setq e (car tbl))
  11566. (while (equal (car tbl) '(:newline))
  11567. (insert "\n")
  11568. (setq tbl (cdr tbl)))))
  11569. (t
  11570. (setq tg (car e) c (cdr e))
  11571. (if ingroup (push tg (car groups)))
  11572. (setq tg (org-add-props tg nil 'face
  11573. (org-get-todo-face tg)))
  11574. (if (and (= cnt 0) (not ingroup)) (insert " "))
  11575. (insert "[" c "] " tg (make-string
  11576. (- fwidth 4 (length tg)) ?\ ))
  11577. (when (= (setq cnt (1+ cnt)) ncol)
  11578. (insert "\n")
  11579. (if ingroup (insert " "))
  11580. (setq cnt 0)))))
  11581. (insert "\n")
  11582. (goto-char (point-min))
  11583. (if (not expert) (org-fit-window-to-buffer))
  11584. (message "[a-z..]:Set [SPC]:clear")
  11585. (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
  11586. (cond
  11587. ((or (= c ?\C-g)
  11588. (and (= c ?q) (not (rassoc c fulltable))))
  11589. (setq quit-flag t))
  11590. ((= c ?\ ) nil)
  11591. ((setq e (rassoc c fulltable) tg (car e))
  11592. tg)
  11593. (t (setq quit-flag t)))))))
  11594. (defun org-entry-is-todo-p ()
  11595. (member (org-get-todo-state) org-not-done-keywords))
  11596. (defun org-entry-is-done-p ()
  11597. (member (org-get-todo-state) org-done-keywords))
  11598. (defun org-get-todo-state ()
  11599. "Return the TODO keyword of the current subtree."
  11600. (save-excursion
  11601. (org-back-to-heading t)
  11602. (and (looking-at org-todo-line-regexp)
  11603. (match-end 2)
  11604. (match-string 2))))
  11605. (defun org-at-date-range-p (&optional inactive-ok)
  11606. "Is the cursor inside a date range?"
  11607. (interactive)
  11608. (save-excursion
  11609. (catch 'exit
  11610. (let ((pos (point)))
  11611. (skip-chars-backward "^[<\r\n")
  11612. (skip-chars-backward "<[")
  11613. (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
  11614. (>= (match-end 0) pos)
  11615. (throw 'exit t))
  11616. (skip-chars-backward "^<[\r\n")
  11617. (skip-chars-backward "<[")
  11618. (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
  11619. (>= (match-end 0) pos)
  11620. (throw 'exit t)))
  11621. nil)))
  11622. (defun org-get-repeat (&optional tagline)
  11623. "Check if there is a deadline/schedule with repeater in this entry."
  11624. (save-match-data
  11625. (save-excursion
  11626. (org-back-to-heading t)
  11627. (and (re-search-forward (if tagline
  11628. (concat tagline "\\s-*" org-repeat-re)
  11629. org-repeat-re)
  11630. (org-entry-end-position) t)
  11631. (match-string-no-properties 1)))))
  11632. (defvar org-last-changed-timestamp)
  11633. (defvar org-last-inserted-timestamp)
  11634. (defvar org-log-post-message)
  11635. (defvar org-log-note-purpose)
  11636. (defvar org-log-note-how)
  11637. (defvar org-log-note-extra)
  11638. (defun org-auto-repeat-maybe (done-word)
  11639. "Check if the current headline contains a repeated deadline/schedule.
  11640. If yes, set TODO state back to what it was and change the base date
  11641. of repeating deadline/scheduled time stamps to new date.
  11642. This function is run automatically after each state change to a DONE state."
  11643. ;; last-state is dynamically scoped into this function
  11644. (let* ((repeat (org-get-repeat))
  11645. (aa (assoc org-last-state org-todo-kwd-alist))
  11646. (interpret (nth 1 aa))
  11647. (head (nth 2 aa))
  11648. (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
  11649. (msg "Entry repeats: ")
  11650. (org-log-done nil)
  11651. (org-todo-log-states nil)
  11652. re type n what ts time to-state)
  11653. (when repeat
  11654. (if (eq org-log-repeat t) (setq org-log-repeat 'state))
  11655. (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
  11656. org-todo-repeat-to-state))
  11657. (unless (and to-state (member to-state org-todo-keywords-1))
  11658. (setq to-state (if (eq interpret 'type) org-last-state head)))
  11659. (org-todo to-state)
  11660. (when (or org-log-repeat (org-entry-get nil "CLOCK"))
  11661. (org-entry-put nil "LAST_REPEAT" (format-time-string
  11662. (org-time-stamp-format t t))))
  11663. (when org-log-repeat
  11664. (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
  11665. (memq 'org-add-log-note post-command-hook))
  11666. ;; OK, we are already setup for some record
  11667. (if (eq org-log-repeat 'note)
  11668. ;; make sure we take a note, not only a time stamp
  11669. (setq org-log-note-how 'note))
  11670. ;; Set up for taking a record
  11671. (org-add-log-setup 'state (or done-word (car org-done-keywords))
  11672. org-last-state
  11673. 'findpos org-log-repeat)))
  11674. (org-back-to-heading t)
  11675. (org-add-planning-info nil nil 'closed)
  11676. (setq re (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
  11677. org-deadline-time-regexp "\\)\\|\\("
  11678. org-ts-regexp "\\)"))
  11679. (while (re-search-forward
  11680. re (save-excursion (outline-next-heading) (point)) t)
  11681. (setq type (if (match-end 1) org-scheduled-string
  11682. (if (match-end 3) org-deadline-string "Plain:"))
  11683. ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
  11684. (when (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts)
  11685. (setq n (string-to-number (match-string 2 ts))
  11686. what (match-string 3 ts))
  11687. (if (equal what "w") (setq n (* n 7) what "d"))
  11688. (if (and (equal what "h") (not (string-match "[0-9]\\{1,2\\}:[0-9]\\{2\\}" ts)))
  11689. (user-error "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
  11690. ;; Preparation, see if we need to modify the start date for the change
  11691. (when (match-end 1)
  11692. (setq time (save-match-data (org-time-string-to-time ts)))
  11693. (cond
  11694. ((equal (match-string 1 ts) ".")
  11695. ;; Shift starting date to today
  11696. (org-timestamp-change
  11697. (- (org-today) (time-to-days time))
  11698. 'day))
  11699. ((equal (match-string 1 ts) "+")
  11700. (let ((nshiftmax 10) (nshift 0))
  11701. (while (or (= nshift 0)
  11702. (<= (time-to-days time)
  11703. (time-to-days (current-time))))
  11704. (when (= (incf nshift) nshiftmax)
  11705. (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
  11706. (error "Abort")))
  11707. (org-timestamp-change n (cdr (assoc what whata)))
  11708. (org-at-timestamp-p t)
  11709. (setq ts (match-string 1))
  11710. (setq time (save-match-data (org-time-string-to-time ts)))))
  11711. (org-timestamp-change (- n) (cdr (assoc what whata)))
  11712. ;; rematch, so that we have everything in place for the real shift
  11713. (org-at-timestamp-p t)
  11714. (setq ts (match-string 1))
  11715. (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts))))
  11716. (save-excursion (org-timestamp-change n (cdr (assoc what whata)) nil t))
  11717. (setq msg (concat msg type " " org-last-changed-timestamp " "))))
  11718. (setq org-log-post-message msg)
  11719. (message "%s" msg))))
  11720. (defun org-show-todo-tree (arg)
  11721. "Make a compact tree which shows all headlines marked with TODO.
  11722. The tree will show the lines where the regexp matches, and all higher
  11723. headlines above the match.
  11724. With a \\[universal-argument] prefix, prompt for a regexp to match.
  11725. With a numeric prefix N, construct a sparse tree for the Nth element
  11726. of `org-todo-keywords-1'."
  11727. (interactive "P")
  11728. (let ((case-fold-search nil)
  11729. (kwd-re
  11730. (cond ((null arg) org-not-done-regexp)
  11731. ((equal arg '(4))
  11732. (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
  11733. (mapcar 'list org-todo-keywords-1))))
  11734. (concat "\\("
  11735. (mapconcat 'identity (org-split-string kwd "|") "\\|")
  11736. "\\)\\>")))
  11737. ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
  11738. (regexp-quote (nth (1- (prefix-numeric-value arg))
  11739. org-todo-keywords-1)))
  11740. (t (user-error "Invalid prefix argument: %s" arg)))))
  11741. (message "%d TODO entries found"
  11742. (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
  11743. (defun org-deadline (arg &optional time)
  11744. "Insert the \"DEADLINE:\" string with a timestamp to make a deadline.
  11745. With one universal prefix argument, remove any deadline from the item.
  11746. With two universal prefix arguments, prompt for a warning delay.
  11747. With argument TIME, set the deadline at the corresponding date. TIME
  11748. can either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
  11749. (interactive "P")
  11750. (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
  11751. (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
  11752. 'region-start-level 'region))
  11753. org-loop-over-headlines-in-active-region)
  11754. (org-map-entries
  11755. `(org-deadline ',arg ,time)
  11756. org-loop-over-headlines-in-active-region
  11757. cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
  11758. (let* ((old-date (org-entry-get nil "DEADLINE"))
  11759. (old-date-time (if old-date (org-time-string-to-time old-date)))
  11760. (repeater (and old-date
  11761. (string-match
  11762. "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
  11763. old-date)
  11764. (match-string 1 old-date))))
  11765. (cond
  11766. ((equal arg '(4))
  11767. (when (and old-date org-log-redeadline)
  11768. (org-add-log-setup 'deldeadline nil old-date 'findpos
  11769. org-log-redeadline))
  11770. (org-remove-timestamp-with-keyword org-deadline-string)
  11771. (message "Item no longer has a deadline."))
  11772. ((equal arg '(16))
  11773. (save-excursion
  11774. (if (re-search-forward
  11775. org-deadline-time-regexp
  11776. (save-excursion (outline-next-heading) (point)) t)
  11777. (let* ((rpl0 (match-string 1))
  11778. (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
  11779. (replace-match
  11780. (concat org-deadline-string
  11781. " <" rpl
  11782. (format " -%dd"
  11783. (abs
  11784. (- (time-to-days
  11785. (save-match-data
  11786. (org-read-date nil t nil "Warn starting from" old-date-time)))
  11787. (time-to-days old-date-time))))
  11788. ">") t t))
  11789. (user-error "No deadline information to update"))))
  11790. (t
  11791. (org-add-planning-info 'deadline time 'closed)
  11792. (when (and old-date org-log-redeadline
  11793. (not (equal old-date
  11794. (substring org-last-inserted-timestamp 1 -1))))
  11795. (org-add-log-setup 'redeadline nil old-date 'findpos
  11796. org-log-redeadline))
  11797. (when repeater
  11798. (save-excursion
  11799. (org-back-to-heading t)
  11800. (when (re-search-forward (concat org-deadline-string " "
  11801. org-last-inserted-timestamp)
  11802. (save-excursion
  11803. (outline-next-heading) (point)) t)
  11804. (goto-char (1- (match-end 0)))
  11805. (insert " " repeater)
  11806. (setq org-last-inserted-timestamp
  11807. (concat (substring org-last-inserted-timestamp 0 -1)
  11808. " " repeater
  11809. (substring org-last-inserted-timestamp -1))))))
  11810. (message "Deadline on %s" org-last-inserted-timestamp))))))
  11811. (defun org-schedule (arg &optional time)
  11812. "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
  11813. With one universal prefix argument, remove any scheduling date from the item.
  11814. With two universal prefix arguments, prompt for a delay cookie.
  11815. With argument TIME, scheduled at the corresponding date. TIME can
  11816. either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
  11817. (interactive "P")
  11818. (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
  11819. (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
  11820. 'region-start-level 'region))
  11821. org-loop-over-headlines-in-active-region)
  11822. (org-map-entries
  11823. `(org-schedule ',arg ,time)
  11824. org-loop-over-headlines-in-active-region
  11825. cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
  11826. (let* ((old-date (org-entry-get nil "SCHEDULED"))
  11827. (old-date-time (if old-date (org-time-string-to-time old-date)))
  11828. (repeater (and old-date
  11829. (string-match
  11830. "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
  11831. old-date)
  11832. (match-string 1 old-date))))
  11833. (cond
  11834. ((equal arg '(4))
  11835. (progn
  11836. (when (and old-date org-log-reschedule)
  11837. (org-add-log-setup 'delschedule nil old-date 'findpos
  11838. org-log-reschedule))
  11839. (org-remove-timestamp-with-keyword org-scheduled-string)
  11840. (message "Item is no longer scheduled.")))
  11841. ((equal arg '(16))
  11842. (save-excursion
  11843. (if (re-search-forward
  11844. org-scheduled-time-regexp
  11845. (save-excursion (outline-next-heading) (point)) t)
  11846. (let* ((rpl0 (match-string 1))
  11847. (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
  11848. (replace-match
  11849. (concat org-scheduled-string
  11850. " <" rpl
  11851. (format " -%dd"
  11852. (abs
  11853. (- (time-to-days
  11854. (save-match-data
  11855. (org-read-date nil t nil "Delay until" old-date-time)))
  11856. (time-to-days old-date-time))))
  11857. ">") t t))
  11858. (user-error "No scheduled information to update"))))
  11859. (t
  11860. (org-add-planning-info 'scheduled time 'closed)
  11861. (when (and old-date org-log-reschedule
  11862. (not (equal old-date
  11863. (substring org-last-inserted-timestamp 1 -1))))
  11864. (org-add-log-setup 'reschedule nil old-date 'findpos
  11865. org-log-reschedule))
  11866. (when repeater
  11867. (save-excursion
  11868. (org-back-to-heading t)
  11869. (when (re-search-forward (concat org-scheduled-string " "
  11870. org-last-inserted-timestamp)
  11871. (save-excursion
  11872. (outline-next-heading) (point)) t)
  11873. (goto-char (1- (match-end 0)))
  11874. (insert " " repeater)
  11875. (setq org-last-inserted-timestamp
  11876. (concat (substring org-last-inserted-timestamp 0 -1)
  11877. " " repeater
  11878. (substring org-last-inserted-timestamp -1))))))
  11879. (message "Scheduled to %s" org-last-inserted-timestamp))))))
  11880. (defun org-get-scheduled-time (pom &optional inherit)
  11881. "Get the scheduled time as a time tuple, of a format suitable
  11882. for calling org-schedule with, or if there is no scheduling,
  11883. returns nil."
  11884. (let ((time (org-entry-get pom "SCHEDULED" inherit)))
  11885. (when time
  11886. (apply 'encode-time (org-parse-time-string time)))))
  11887. (defun org-get-deadline-time (pom &optional inherit)
  11888. "Get the deadline as a time tuple, of a format suitable for
  11889. calling org-deadline with, or if there is no scheduling, returns
  11890. nil."
  11891. (let ((time (org-entry-get pom "DEADLINE" inherit)))
  11892. (when time
  11893. (apply 'encode-time (org-parse-time-string time)))))
  11894. (defun org-remove-timestamp-with-keyword (keyword)
  11895. "Remove all time stamps with KEYWORD in the current entry."
  11896. (let ((re (concat "\\<" (regexp-quote keyword) " +<[^>\n]+>[ \t]*"))
  11897. beg)
  11898. (save-excursion
  11899. (org-back-to-heading t)
  11900. (setq beg (point))
  11901. (outline-next-heading)
  11902. (while (re-search-backward re beg t)
  11903. (replace-match "")
  11904. (if (and (string-match "\\S-" (buffer-substring (point-at-bol) (point)))
  11905. (equal (char-before) ?\ ))
  11906. (backward-delete-char 1)
  11907. (if (string-match "^[ \t]*$" (buffer-substring
  11908. (point-at-bol) (point-at-eol)))
  11909. (delete-region (point-at-bol)
  11910. (min (point-max) (1+ (point-at-eol))))))))))
  11911. (defun org-add-planning-info (what &optional time &rest remove)
  11912. "Insert new timestamp with keyword in the line directly after the headline.
  11913. WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
  11914. If non is given, the user is prompted for a date.
  11915. REMOVE indicates what kind of entries to remove. An old WHAT entry will also
  11916. be removed."
  11917. (interactive)
  11918. (let (org-time-was-given org-end-time-was-given ts
  11919. end default-time default-input)
  11920. (catch 'exit
  11921. (when (and (memq what '(scheduled deadline))
  11922. (or (not time)
  11923. (and (stringp time)
  11924. (string-match "^[-+]+[0-9]" time))))
  11925. ;; Try to get a default date/time from existing timestamp
  11926. (save-excursion
  11927. (org-back-to-heading t)
  11928. (setq end (save-excursion (outline-next-heading) (point)))
  11929. (when (re-search-forward (if (eq what 'scheduled)
  11930. org-scheduled-time-regexp
  11931. org-deadline-time-regexp)
  11932. end t)
  11933. (setq ts (match-string 1)
  11934. default-time
  11935. (apply 'encode-time (org-parse-time-string ts))
  11936. default-input (and ts (org-get-compact-tod ts))))))
  11937. (when what
  11938. (setq time
  11939. (if (stringp time)
  11940. ;; This is a string (relative or absolute), set proper date
  11941. (apply 'encode-time
  11942. (org-read-date-analyze
  11943. time default-time (decode-time default-time)))
  11944. ;; If necessary, get the time from the user
  11945. (or time (org-read-date nil 'to-time nil nil
  11946. default-time default-input)))))
  11947. (when (and org-insert-labeled-timestamps-at-point
  11948. (member what '(scheduled deadline)))
  11949. (insert
  11950. (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
  11951. (org-insert-time-stamp time org-time-was-given
  11952. nil nil nil (list org-end-time-was-given))
  11953. (setq what nil))
  11954. (save-excursion
  11955. (save-restriction
  11956. (let (col list elt ts buffer-invisibility-spec)
  11957. (org-back-to-heading t)
  11958. (looking-at (concat org-outline-regexp "\\( *\\)[^\r\n]*"))
  11959. (goto-char (match-end 1))
  11960. (setq col (current-column))
  11961. (goto-char (match-end 0))
  11962. (if (eobp) (insert "\n") (forward-char 1))
  11963. (when (and (not what)
  11964. (not (looking-at
  11965. (concat "[ \t]*"
  11966. org-keyword-time-not-clock-regexp))))
  11967. ;; Nothing to add, nothing to remove...... :-)
  11968. (throw 'exit nil))
  11969. (if (and (not (looking-at org-outline-regexp))
  11970. (looking-at (concat "[^\r\n]*?" org-keyword-time-regexp
  11971. "[^\r\n]*"))
  11972. (not (equal (match-string 1) org-clock-string)))
  11973. (narrow-to-region (match-beginning 0) (match-end 0))
  11974. (insert-before-markers "\n")
  11975. (backward-char 1)
  11976. (narrow-to-region (point) (point))
  11977. (and org-adapt-indentation (org-indent-to-column col)))
  11978. ;; Check if we have to remove something.
  11979. (setq list (cons what remove))
  11980. (while list
  11981. (setq elt (pop list))
  11982. (when (or (and (eq elt 'scheduled)
  11983. (re-search-forward org-scheduled-time-regexp nil t))
  11984. (and (eq elt 'deadline)
  11985. (re-search-forward org-deadline-time-regexp nil t))
  11986. (and (eq elt 'closed)
  11987. (re-search-forward org-closed-time-regexp nil t)))
  11988. (replace-match "")
  11989. (if (looking-at "--+<[^>]+>") (replace-match ""))))
  11990. (and (looking-at "[ \t]+") (replace-match ""))
  11991. (and org-adapt-indentation (bolp) (org-indent-to-column col))
  11992. (when what
  11993. (insert
  11994. (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
  11995. (cond ((eq what 'scheduled) org-scheduled-string)
  11996. ((eq what 'deadline) org-deadline-string)
  11997. ((eq what 'closed) org-closed-string))
  11998. " ")
  11999. (setq ts (org-insert-time-stamp
  12000. time
  12001. (or org-time-was-given
  12002. (and (eq what 'closed) org-log-done-with-time))
  12003. (eq what 'closed)
  12004. nil nil (list org-end-time-was-given)))
  12005. (insert
  12006. (if (not (or (bolp) (eq (char-before) ?\ )
  12007. (memq (char-after) '(32 10))
  12008. (eobp))) " " ""))
  12009. (end-of-line 1))
  12010. (goto-char (point-min))
  12011. (widen)
  12012. (if (and (looking-at "[ \t]*\n")
  12013. (equal (char-before) ?\n))
  12014. (delete-region (1- (point)) (point-at-eol)))
  12015. ts))))))
  12016. (defvar org-log-note-marker (make-marker))
  12017. (defvar org-log-note-purpose nil)
  12018. (defvar org-log-note-state nil)
  12019. (defvar org-log-note-previous-state nil)
  12020. (defvar org-log-note-how nil)
  12021. (defvar org-log-note-extra nil)
  12022. (defvar org-log-note-window-configuration nil)
  12023. (defvar org-log-note-return-to (make-marker))
  12024. (defvar org-log-note-effective-time nil
  12025. "Remembered current time so that dynamically scoped
  12026. `org-extend-today-until' affects tha timestamps in state change
  12027. log")
  12028. (defvar org-log-post-message nil
  12029. "Message to be displayed after a log note has been stored.
  12030. The auto-repeater uses this.")
  12031. (defun org-add-note ()
  12032. "Add a note to the current entry.
  12033. This is done in the same way as adding a state change note."
  12034. (interactive)
  12035. (org-add-log-setup 'note nil nil 'findpos nil))
  12036. (defvar org-property-end-re)
  12037. (defun org-add-log-setup (&optional purpose state prev-state
  12038. findpos how extra)
  12039. "Set up the post command hook to take a note.
  12040. If this is about to TODO state change, the new state is expected in STATE.
  12041. When FINDPOS is non-nil, find the correct position for the note in
  12042. the current entry. If not, assume that it can be inserted at point.
  12043. HOW is an indicator what kind of note should be created.
  12044. EXTRA is additional text that will be inserted into the notes buffer."
  12045. (let* ((org-log-into-drawer (org-log-into-drawer))
  12046. (drawer (cond ((stringp org-log-into-drawer)
  12047. org-log-into-drawer)
  12048. (org-log-into-drawer "LOGBOOK"))))
  12049. (save-restriction
  12050. (save-excursion
  12051. (when findpos
  12052. (org-back-to-heading t)
  12053. (narrow-to-region (point) (save-excursion
  12054. (outline-next-heading) (point)))
  12055. (looking-at (concat org-outline-regexp "\\( *\\)[^\r\n]*"
  12056. "\\(\n[^\r\n]*?" org-keyword-time-not-clock-regexp
  12057. "[^\r\n]*\\)?"))
  12058. (goto-char (match-end 0))
  12059. (cond
  12060. (drawer
  12061. (if (re-search-forward (concat "^[ \t]*:" drawer ":[ \t]*$")
  12062. nil t)
  12063. (progn
  12064. (goto-char (match-end 0))
  12065. (or org-log-states-order-reversed
  12066. (and (re-search-forward org-property-end-re nil t)
  12067. (goto-char (1- (match-beginning 0))))))
  12068. (insert "\n:" drawer ":\n:END:")
  12069. (beginning-of-line 0)
  12070. (org-indent-line)
  12071. (beginning-of-line 2)
  12072. (org-indent-line)
  12073. (end-of-line 0)))
  12074. ((and org-log-state-notes-insert-after-drawers
  12075. (save-excursion
  12076. (forward-line) (looking-at org-drawer-regexp)))
  12077. (forward-line)
  12078. (while (looking-at org-drawer-regexp)
  12079. (goto-char (match-end 0))
  12080. (re-search-forward org-property-end-re (point-max) t)
  12081. (forward-line))
  12082. (forward-line -1)))
  12083. (unless org-log-states-order-reversed
  12084. (and (= (char-after) ?\n) (forward-char 1))
  12085. (org-skip-over-state-notes)
  12086. (skip-chars-backward " \t\n\r")))
  12087. (move-marker org-log-note-marker (point))
  12088. (setq org-log-note-purpose purpose
  12089. org-log-note-state state
  12090. org-log-note-previous-state prev-state
  12091. org-log-note-how how
  12092. org-log-note-extra extra
  12093. org-log-note-effective-time (org-current-effective-time))
  12094. (add-hook 'post-command-hook 'org-add-log-note 'append)))))
  12095. (defun org-skip-over-state-notes ()
  12096. "Skip past the list of State notes in an entry."
  12097. (if (looking-at "\n[ \t]*- State") (forward-char 1))
  12098. (when (ignore-errors (goto-char (org-in-item-p)))
  12099. (let* ((struct (org-list-struct))
  12100. (prevs (org-list-prevs-alist struct)))
  12101. (while (looking-at "[ \t]*- State")
  12102. (goto-char (or (org-list-get-next-item (point) struct prevs)
  12103. (org-list-get-item-end (point) struct)))))))
  12104. (defun org-add-log-note (&optional purpose)
  12105. "Pop up a window for taking a note, and add this note later at point."
  12106. (remove-hook 'post-command-hook 'org-add-log-note)
  12107. (setq org-log-note-window-configuration (current-window-configuration))
  12108. (delete-other-windows)
  12109. (move-marker org-log-note-return-to (point))
  12110. (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
  12111. (goto-char org-log-note-marker)
  12112. (org-switch-to-buffer-other-window "*Org Note*")
  12113. (erase-buffer)
  12114. (if (memq org-log-note-how '(time state))
  12115. (let (current-prefix-arg) (org-store-log-note))
  12116. (let ((org-inhibit-startup t)) (org-mode))
  12117. (insert (format "# Insert note for %s.
  12118. # Finish with C-c C-c, or cancel with C-c C-k.\n\n"
  12119. (cond
  12120. ((eq org-log-note-purpose 'clock-out) "stopped clock")
  12121. ((eq org-log-note-purpose 'done) "closed todo item")
  12122. ((eq org-log-note-purpose 'state)
  12123. (format "state change from \"%s\" to \"%s\""
  12124. (or org-log-note-previous-state "")
  12125. (or org-log-note-state "")))
  12126. ((eq org-log-note-purpose 'reschedule)
  12127. "rescheduling")
  12128. ((eq org-log-note-purpose 'delschedule)
  12129. "no longer scheduled")
  12130. ((eq org-log-note-purpose 'redeadline)
  12131. "changing deadline")
  12132. ((eq org-log-note-purpose 'deldeadline)
  12133. "removing deadline")
  12134. ((eq org-log-note-purpose 'refile)
  12135. "refiling")
  12136. ((eq org-log-note-purpose 'note)
  12137. "this entry")
  12138. (t (error "This should not happen")))))
  12139. (if org-log-note-extra (insert org-log-note-extra))
  12140. (org-set-local 'org-finish-function 'org-store-log-note)
  12141. (run-hooks 'org-log-buffer-setup-hook)))
  12142. (defvar org-note-abort nil) ; dynamically scoped
  12143. (defun org-store-log-note ()
  12144. "Finish taking a log note, and insert it to where it belongs."
  12145. (let ((txt (buffer-string)))
  12146. (kill-buffer (current-buffer))
  12147. (let ((note (cdr (assq org-log-note-purpose org-log-note-headings)))
  12148. lines ind bul)
  12149. (while (string-match "\\`# .*\n[ \t\n]*" txt)
  12150. (setq txt (replace-match "" t t txt)))
  12151. (if (string-match "\\s-+\\'" txt)
  12152. (setq txt (replace-match "" t t txt)))
  12153. (setq lines (org-split-string txt "\n"))
  12154. (when (and note (string-match "\\S-" note))
  12155. (setq note
  12156. (org-replace-escapes
  12157. note
  12158. (list (cons "%u" (user-login-name))
  12159. (cons "%U" user-full-name)
  12160. (cons "%t" (format-time-string
  12161. (org-time-stamp-format 'long 'inactive)
  12162. org-log-note-effective-time))
  12163. (cons "%T" (format-time-string
  12164. (org-time-stamp-format 'long nil)
  12165. org-log-note-effective-time))
  12166. (cons "%d" (format-time-string
  12167. (org-time-stamp-format nil 'inactive)
  12168. org-log-note-effective-time))
  12169. (cons "%D" (format-time-string
  12170. (org-time-stamp-format nil nil)
  12171. org-log-note-effective-time))
  12172. (cons "%s" (if org-log-note-state
  12173. (concat "\"" org-log-note-state "\"")
  12174. ""))
  12175. (cons "%S" (if org-log-note-previous-state
  12176. (concat "\"" org-log-note-previous-state "\"")
  12177. "\"\"")))))
  12178. (if lines (setq note (concat note " \\\\")))
  12179. (push note lines))
  12180. (when (or current-prefix-arg org-note-abort)
  12181. (when org-log-into-drawer
  12182. (org-remove-empty-drawer-at
  12183. (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
  12184. org-log-note-marker))
  12185. (setq lines nil))
  12186. (when lines
  12187. (with-current-buffer (marker-buffer org-log-note-marker)
  12188. (save-excursion
  12189. (goto-char org-log-note-marker)
  12190. (move-marker org-log-note-marker nil)
  12191. (end-of-line 1)
  12192. (if (not (bolp)) (let ((inhibit-read-only t)) (insert "\n")))
  12193. (setq ind (save-excursion
  12194. (if (ignore-errors (goto-char (org-in-item-p)))
  12195. (let ((struct (org-list-struct)))
  12196. (org-list-get-ind
  12197. (org-list-get-top-point struct) struct))
  12198. (skip-chars-backward " \r\t\n")
  12199. (cond
  12200. ((and (org-at-heading-p)
  12201. org-adapt-indentation)
  12202. (1+ (org-current-level)))
  12203. ((org-at-heading-p) 0)
  12204. (t (org-get-indentation))))))
  12205. (setq bul (org-list-bullet-string "-"))
  12206. (org-indent-line-to ind)
  12207. (insert bul (pop lines))
  12208. (let ((ind-body (+ (length bul) ind)))
  12209. (while lines
  12210. (insert "\n")
  12211. (org-indent-line-to ind-body)
  12212. (insert (pop lines))))
  12213. (message "Note stored")
  12214. (org-back-to-heading t)
  12215. (org-cycle-hide-drawers 'children))
  12216. ;; Fix `buffer-undo-list' when `org-store-log-note' is called
  12217. ;; from within `org-add-log-note' because `buffer-undo-list'
  12218. ;; is then modified outside of `org-with-remote-undo'.
  12219. (when (eq this-command 'org-agenda-todo)
  12220. (setcdr buffer-undo-list (cddr buffer-undo-list)))))))
  12221. ;; Don't add undo information when called from `org-agenda-todo'
  12222. (let ((buffer-undo-list (eq this-command 'org-agenda-todo)))
  12223. (set-window-configuration org-log-note-window-configuration)
  12224. (with-current-buffer (marker-buffer org-log-note-return-to)
  12225. (goto-char org-log-note-return-to))
  12226. (move-marker org-log-note-return-to nil)
  12227. (and org-log-post-message (message "%s" org-log-post-message))))
  12228. (defun org-remove-empty-drawer-at (drawer pos)
  12229. "Remove an empty drawer DRAWER at position POS.
  12230. POS may also be a marker."
  12231. (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
  12232. (save-excursion
  12233. (save-restriction
  12234. (widen)
  12235. (goto-char pos)
  12236. (if (org-in-regexp
  12237. (concat "^[ \t]*:" drawer ":[ \t]*\n[ \t]*:END:[ \t]*\n?") 2)
  12238. (replace-match ""))))))
  12239. (defvar org-ts-type nil)
  12240. (defun org-sparse-tree (&optional arg type)
  12241. "Create a sparse tree, prompt for the details.
  12242. This command can create sparse trees. You first need to select the type
  12243. of match used to create the tree:
  12244. t Show all TODO entries.
  12245. T Show entries with a specific TODO keyword.
  12246. m Show entries selected by a tags/property match.
  12247. p Enter a property name and its value (both with completion on existing
  12248. names/values) and show entries with that property.
  12249. r Show entries matching a regular expression (`/' can be used as well).
  12250. b Show deadlines and scheduled items before a date.
  12251. a Show deadlines and scheduled items after a date.
  12252. d Show deadlines due within `org-deadline-warning-days'.
  12253. D Show deadlines and scheduled items between a date range."
  12254. (interactive "P")
  12255. (let (ans kwd value ts-type)
  12256. (setq type (or type org-sparse-tree-default-date-type))
  12257. (setq org-ts-type type)
  12258. (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"
  12259. (cond ((eq type 'all) "all timestamps")
  12260. ((eq type 'scheduled) "only scheduled")
  12261. ((eq type 'deadline) "only deadline")
  12262. ((eq type 'active) "only active timestamps")
  12263. ((eq type 'inactive) "only inactive timestamps")
  12264. ((eq type 'scheduled-or-deadline) "scheduled/deadline")
  12265. ((eq type 'closed) "with a closed time-stamp")
  12266. (t "scheduled/deadline")))
  12267. (setq ans (read-char-exclusive))
  12268. (cond
  12269. ((equal ans ?c)
  12270. (org-sparse-tree
  12271. arg (cadr (member type '(scheduled-or-deadline
  12272. all scheduled deadline active inactive closed)))))
  12273. ((equal ans ?d)
  12274. (call-interactively 'org-check-deadlines))
  12275. ((equal ans ?b)
  12276. (call-interactively 'org-check-before-date))
  12277. ((equal ans ?a)
  12278. (call-interactively 'org-check-after-date))
  12279. ((equal ans ?D)
  12280. (call-interactively 'org-check-dates-range))
  12281. ((equal ans ?t)
  12282. (call-interactively 'org-show-todo-tree))
  12283. ((equal ans ?T)
  12284. (org-show-todo-tree '(4)))
  12285. ((member ans '(?T ?m))
  12286. (call-interactively 'org-match-sparse-tree))
  12287. ((member ans '(?p ?P))
  12288. (setq kwd (org-icompleting-read "Property: "
  12289. (mapcar 'list (org-buffer-property-keys))))
  12290. (setq value (org-icompleting-read "Value: "
  12291. (mapcar 'list (org-property-values kwd))))
  12292. (unless (string-match "\\`{.*}\\'" value)
  12293. (setq value (concat "\"" value "\"")))
  12294. (org-match-sparse-tree arg (concat kwd "=" value)))
  12295. ((member ans '(?r ?R ?/))
  12296. (call-interactively 'org-occur))
  12297. (t (user-error "No such sparse tree command \"%c\"" ans)))))
  12298. (defvar org-occur-highlights nil
  12299. "List of overlays used for occur matches.")
  12300. (make-variable-buffer-local 'org-occur-highlights)
  12301. (defvar org-occur-parameters nil
  12302. "Parameters of the active org-occur calls.
  12303. This is a list, each call to org-occur pushes as cons cell,
  12304. containing the regular expression and the callback, onto the list.
  12305. The list can contain several entries if `org-occur' has been called
  12306. several time with the KEEP-PREVIOUS argument. Otherwise, this list
  12307. will only contain one set of parameters. When the highlights are
  12308. removed (for example with `C-c C-c', or with the next edit (depending
  12309. on `org-remove-highlights-with-change'), this variable is emptied
  12310. as well.")
  12311. (make-variable-buffer-local 'org-occur-parameters)
  12312. (defun org-occur (regexp &optional keep-previous callback)
  12313. "Make a compact tree which shows all matches of REGEXP.
  12314. The tree will show the lines where the regexp matches, and all higher
  12315. headlines above the match. It will also show the heading after the match,
  12316. to make sure editing the matching entry is easy.
  12317. If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
  12318. call to `org-occur' will be kept, to allow stacking of calls to this
  12319. command.
  12320. If CALLBACK is non-nil, it is a function which is called to confirm
  12321. that the match should indeed be shown."
  12322. (interactive "sRegexp: \nP")
  12323. (when (equal regexp "")
  12324. (user-error "Regexp cannot be empty"))
  12325. (unless keep-previous
  12326. (org-remove-occur-highlights nil nil t))
  12327. (push (cons regexp callback) org-occur-parameters)
  12328. (let ((cnt 0))
  12329. (save-excursion
  12330. (goto-char (point-min))
  12331. (if (or (not keep-previous) ; do not want to keep
  12332. (not org-occur-highlights)) ; no previous matches
  12333. ;; hide everything
  12334. (org-overview))
  12335. (while (re-search-forward regexp nil t)
  12336. (when (or (not callback)
  12337. (save-match-data (funcall callback)))
  12338. (setq cnt (1+ cnt))
  12339. (when org-highlight-sparse-tree-matches
  12340. (org-highlight-new-match (match-beginning 0) (match-end 0)))
  12341. (org-show-context 'occur-tree))))
  12342. (when org-remove-highlights-with-change
  12343. (org-add-hook 'before-change-functions 'org-remove-occur-highlights
  12344. nil 'local))
  12345. (unless org-sparse-tree-open-archived-trees
  12346. (org-hide-archived-subtrees (point-min) (point-max)))
  12347. (run-hooks 'org-occur-hook)
  12348. (if (org-called-interactively-p 'interactive)
  12349. (message "%d match(es) for regexp %s" cnt regexp))
  12350. cnt))
  12351. (defun org-occur-next-match (&optional n reset)
  12352. "Function for `next-error-function' to find sparse tree matches.
  12353. N is the number of matches to move, when negative move backwards.
  12354. RESET is entirely ignored - this function always goes back to the
  12355. starting point when no match is found."
  12356. (let* ((limit (if (< n 0) (point-min) (point-max)))
  12357. (search-func (if (< n 0)
  12358. 'previous-single-char-property-change
  12359. 'next-single-char-property-change))
  12360. (n (abs n))
  12361. (pos (point))
  12362. p1)
  12363. (catch 'exit
  12364. (while (setq p1 (funcall search-func (point) 'org-type))
  12365. (when (equal p1 limit)
  12366. (goto-char pos)
  12367. (error "No more matches"))
  12368. (when (equal (get-char-property p1 'org-type) 'org-occur)
  12369. (setq n (1- n))
  12370. (when (= n 0)
  12371. (goto-char p1)
  12372. (throw 'exit (point))))
  12373. (goto-char p1))
  12374. (goto-char p1)
  12375. (error "No more matches"))))
  12376. (defun org-show-context (&optional key)
  12377. "Make sure point and context are visible.
  12378. How much context is shown depends upon the variables
  12379. `org-show-hierarchy-above', `org-show-following-heading',
  12380. `org-show-entry-below' and `org-show-siblings'."
  12381. (let ((heading-p (org-at-heading-p t))
  12382. (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
  12383. (following-p (org-get-alist-option org-show-following-heading key))
  12384. (entry-p (org-get-alist-option org-show-entry-below key))
  12385. (siblings-p (org-get-alist-option org-show-siblings key)))
  12386. ;; Show heading or entry text
  12387. (if (and heading-p (not entry-p))
  12388. (org-flag-heading nil) ; only show the heading
  12389. (and (or entry-p (outline-invisible-p) (org-invisible-p2))
  12390. (org-show-hidden-entry))) ; show entire entry
  12391. (when following-p
  12392. ;; Show next sibling, or heading below text
  12393. (save-excursion
  12394. (and (if heading-p (org-goto-sibling) (outline-next-heading))
  12395. (org-flag-heading nil))))
  12396. (when siblings-p (org-show-siblings))
  12397. (when hierarchy-p
  12398. ;; show all higher headings, possibly with siblings
  12399. (save-excursion
  12400. (while (and (condition-case nil
  12401. (progn (org-up-heading-all 1) t)
  12402. (error nil))
  12403. (not (bobp)))
  12404. (org-flag-heading nil)
  12405. (when siblings-p (org-show-siblings)))))
  12406. (unless (eq key 'agenda) (org-fix-ellipsis-at-bol))))
  12407. (defvar org-reveal-start-hook nil
  12408. "Hook run before revealing a location.")
  12409. (defun org-reveal (&optional siblings)
  12410. "Show current entry, hierarchy above it, and the following headline.
  12411. This can be used to show a consistent set of context around locations
  12412. exposed with `org-show-hierarchy-above' or `org-show-following-heading'
  12413. not t for the search context.
  12414. With optional argument SIBLINGS, on each level of the hierarchy all
  12415. siblings are shown. This repairs the tree structure to what it would
  12416. look like when opened with hierarchical calls to `org-cycle'.
  12417. With double optional argument \\[universal-argument] \\[universal-argument], \
  12418. go to the parent and show the
  12419. entire tree."
  12420. (interactive "P")
  12421. (run-hooks 'org-reveal-start-hook)
  12422. (let ((org-show-hierarchy-above t)
  12423. (org-show-following-heading t)
  12424. (org-show-siblings (if siblings t org-show-siblings)))
  12425. (org-show-context nil))
  12426. (when (equal siblings '(16))
  12427. (save-excursion
  12428. (when (org-up-heading-safe)
  12429. (org-show-subtree)
  12430. (run-hook-with-args 'org-cycle-hook 'subtree)))))
  12431. (defun org-highlight-new-match (beg end)
  12432. "Highlight from BEG to END and mark the highlight is an occur headline."
  12433. (let ((ov (make-overlay beg end)))
  12434. (overlay-put ov 'face 'secondary-selection)
  12435. (overlay-put ov 'org-type 'org-occur)
  12436. (push ov org-occur-highlights)))
  12437. (defun org-remove-occur-highlights (&optional beg end noremove)
  12438. "Remove the occur highlights from the buffer.
  12439. BEG and END are ignored. If NOREMOVE is nil, remove this function
  12440. from the `before-change-functions' in the current buffer."
  12441. (interactive)
  12442. (unless org-inhibit-highlight-removal
  12443. (mapc 'delete-overlay org-occur-highlights)
  12444. (setq org-occur-highlights nil)
  12445. (setq org-occur-parameters nil)
  12446. (unless noremove
  12447. (remove-hook 'before-change-functions
  12448. 'org-remove-occur-highlights 'local))))
  12449. ;;;; Priorities
  12450. (defvar org-priority-regexp ".*?\\(\\[#\\([A-Z0-9]\\)\\] ?\\)"
  12451. "Regular expression matching the priority indicator.")
  12452. (defvar org-remove-priority-next-time nil)
  12453. (defun org-priority-up ()
  12454. "Increase the priority of the current item."
  12455. (interactive)
  12456. (org-priority 'up))
  12457. (defun org-priority-down ()
  12458. "Decrease the priority of the current item."
  12459. (interactive)
  12460. (org-priority 'down))
  12461. (defun org-priority (&optional action show)
  12462. "Change the priority of an item.
  12463. ACTION can be `set', `up', `down', or a character."
  12464. (interactive "P")
  12465. (if (equal action '(4))
  12466. (org-show-priority)
  12467. (unless org-enable-priority-commands
  12468. (user-error "Priority commands are disabled"))
  12469. (setq action (or action 'set))
  12470. (let (current new news have remove)
  12471. (save-excursion
  12472. (org-back-to-heading t)
  12473. (if (looking-at org-priority-regexp)
  12474. (setq current (string-to-char (match-string 2))
  12475. have t))
  12476. (cond
  12477. ((eq action 'remove)
  12478. (setq remove t new ?\ ))
  12479. ((or (eq action 'set)
  12480. (if (featurep 'xemacs) (characterp action) (integerp action)))
  12481. (if (not (eq action 'set))
  12482. (setq new action)
  12483. (message "Priority %c-%c, SPC to remove: "
  12484. org-highest-priority org-lowest-priority)
  12485. (save-match-data
  12486. (setq new (read-char-exclusive))))
  12487. (if (and (= (upcase org-highest-priority) org-highest-priority)
  12488. (= (upcase org-lowest-priority) org-lowest-priority))
  12489. (setq new (upcase new)))
  12490. (cond ((equal new ?\ ) (setq remove t))
  12491. ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
  12492. (user-error "Priority must be between `%c' and `%c'"
  12493. org-highest-priority org-lowest-priority))))
  12494. ((eq action 'up)
  12495. (setq new (if have
  12496. (1- current) ; normal cycling
  12497. ;; last priority was empty
  12498. (if (eq last-command this-command)
  12499. org-lowest-priority ; wrap around empty to lowest
  12500. ;; default
  12501. (if org-priority-start-cycle-with-default
  12502. org-default-priority
  12503. (1- org-default-priority))))))
  12504. ((eq action 'down)
  12505. (setq new (if have
  12506. (1+ current) ; normal cycling
  12507. ;; last priority was empty
  12508. (if (eq last-command this-command)
  12509. org-highest-priority ; wrap around empty to highest
  12510. ;; default
  12511. (if org-priority-start-cycle-with-default
  12512. org-default-priority
  12513. (1+ org-default-priority))))))
  12514. (t (user-error "Invalid action")))
  12515. (if (or (< (upcase new) org-highest-priority)
  12516. (> (upcase new) org-lowest-priority))
  12517. (if (and (memq action '(up down))
  12518. (not have) (not (eq last-command this-command)))
  12519. ;; `new' is from default priority
  12520. (error
  12521. "The default can not be set, see `org-default-priority' why")
  12522. ;; normal cycling: `new' is beyond highest/lowest priority
  12523. ;; and is wrapped around to the empty priority
  12524. (setq remove t)))
  12525. (setq news (format "%c" new))
  12526. (if have
  12527. (if remove
  12528. (replace-match "" t t nil 1)
  12529. (replace-match news t t nil 2))
  12530. (if remove
  12531. (user-error "No priority cookie found in line")
  12532. (let ((case-fold-search nil))
  12533. (looking-at org-todo-line-regexp))
  12534. (if (match-end 2)
  12535. (progn
  12536. (goto-char (match-end 2))
  12537. (insert " [#" news "]"))
  12538. (goto-char (match-beginning 3))
  12539. (insert "[#" news "] "))))
  12540. (org-preserve-lc (org-set-tags nil 'align)))
  12541. (if remove
  12542. (message "Priority removed")
  12543. (message "Priority of current item set to %s" news)))))
  12544. (defun org-show-priority ()
  12545. "Show the priority of the current item.
  12546. This priority is composed of the main priority given with the [#A] cookies,
  12547. and by additional input from the age of a schedules or deadline entry."
  12548. (interactive)
  12549. (let ((pri (if (eq major-mode 'org-agenda-mode)
  12550. (org-get-at-bol 'priority)
  12551. (save-excursion
  12552. (save-match-data
  12553. (beginning-of-line)
  12554. (and (looking-at org-heading-regexp)
  12555. (org-get-priority (match-string 0))))))))
  12556. (message "Priority is %d" (if pri pri -1000))))
  12557. (defun org-get-priority (s)
  12558. "Find priority cookie and return priority."
  12559. (save-match-data
  12560. (if (functionp org-get-priority-function)
  12561. (funcall org-get-priority-function)
  12562. (if (not (string-match org-priority-regexp s))
  12563. (* 1000 (- org-lowest-priority org-default-priority))
  12564. (* 1000 (- org-lowest-priority
  12565. (string-to-char (match-string 2 s))))))))
  12566. ;;;; Tags
  12567. (defvar org-agenda-archives-mode)
  12568. (defvar org-map-continue-from nil
  12569. "Position from where mapping should continue.
  12570. Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
  12571. (defvar org-scanner-tags nil
  12572. "The current tag list while the tags scanner is running.")
  12573. (defvar org-trust-scanner-tags nil
  12574. "Should `org-get-tags-at' use the tags for the scanner.
  12575. This is for internal dynamical scoping only.
  12576. When this is non-nil, the function `org-get-tags-at' will return the value
  12577. of `org-scanner-tags' instead of building the list by itself. This
  12578. can lead to large speed-ups when the tags scanner is used in a file with
  12579. many entries, and when the list of tags is retrieved, for example to
  12580. obtain a list of properties. Building the tags list for each entry in such
  12581. a file becomes an N^2 operation - but with this variable set, it scales
  12582. as N.")
  12583. (defun org-scan-tags (action matcher todo-only &optional start-level)
  12584. "Sca headline tags with inheritance and produce output ACTION.
  12585. ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
  12586. or `agenda' to produce an entry list for an agenda view. It can also be
  12587. a Lisp form or a function that should be called at each matched headline, in
  12588. this case the return value is a list of all return values from these calls.
  12589. MATCHER is a Lisp form to be evaluated, testing if a given set of tags
  12590. qualifies a headline for inclusion. When TODO-ONLY is non-nil,
  12591. only lines with a not-done TODO keyword are included in the output.
  12592. This should be the same variable that was scoped into
  12593. and set by `org-make-tags-matcher' when it constructed MATCHER.
  12594. START-LEVEL can be a string with asterisks, reducing the scope to
  12595. headlines matching this string."
  12596. (require 'org-agenda)
  12597. (let* ((re (concat "^"
  12598. (if start-level
  12599. ;; Get the correct level to match
  12600. (concat "\\*\\{" (number-to-string start-level) "\\} ")
  12601. org-outline-regexp)
  12602. " *\\(\\<\\("
  12603. (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
  12604. (org-re "\\)\\>\\)? *\\(.*?\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*$")))
  12605. (props (list 'face 'default
  12606. 'done-face 'org-agenda-done
  12607. 'undone-face 'default
  12608. 'mouse-face 'highlight
  12609. 'org-not-done-regexp org-not-done-regexp
  12610. 'org-todo-regexp org-todo-regexp
  12611. 'org-complex-heading-regexp org-complex-heading-regexp
  12612. 'help-echo
  12613. (format "mouse-2 or RET jump to org file %s"
  12614. (abbreviate-file-name
  12615. (or (buffer-file-name (buffer-base-buffer))
  12616. (buffer-name (buffer-base-buffer)))))))
  12617. (org-map-continue-from nil)
  12618. lspos tags tags-list
  12619. (tags-alist (list (cons 0 org-file-tags)))
  12620. (llast 0) rtn rtn1 level category i txt
  12621. todo marker entry priority)
  12622. (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
  12623. (setq action (list 'lambda nil action)))
  12624. (save-excursion
  12625. (goto-char (point-min))
  12626. (when (eq action 'sparse-tree)
  12627. (org-overview)
  12628. (org-remove-occur-highlights))
  12629. (while (let (case-fold-search)
  12630. (re-search-forward re nil t))
  12631. (setq org-map-continue-from nil)
  12632. (catch :skip
  12633. (setq todo (if (match-end 1) (org-match-string-no-properties 2))
  12634. tags (if (match-end 4) (org-match-string-no-properties 4)))
  12635. (goto-char (setq lspos (match-beginning 0)))
  12636. (setq level (org-reduced-level (org-outline-level))
  12637. category (org-get-category))
  12638. (setq i llast llast level)
  12639. ;; remove tag lists from same and sublevels
  12640. (while (>= i level)
  12641. (when (setq entry (assoc i tags-alist))
  12642. (setq tags-alist (delete entry tags-alist)))
  12643. (setq i (1- i)))
  12644. ;; add the next tags
  12645. (when tags
  12646. (setq tags (org-split-string tags ":")
  12647. tags-alist
  12648. (cons (cons level tags) tags-alist)))
  12649. ;; compile tags for current headline
  12650. (setq tags-list
  12651. (if org-use-tag-inheritance
  12652. (apply 'append (mapcar 'cdr (reverse tags-alist)))
  12653. tags)
  12654. org-scanner-tags tags-list)
  12655. (when org-use-tag-inheritance
  12656. (setcdr (car tags-alist)
  12657. (mapcar (lambda (x)
  12658. (setq x (copy-sequence x))
  12659. (org-add-prop-inherited x))
  12660. (cdar tags-alist))))
  12661. (when (and tags org-use-tag-inheritance
  12662. (or (not (eq t org-use-tag-inheritance))
  12663. org-tags-exclude-from-inheritance))
  12664. ;; selective inheritance, remove uninherited ones
  12665. (setcdr (car tags-alist)
  12666. (org-remove-uninherited-tags (cdar tags-alist))))
  12667. (when (and
  12668. ;; eval matcher only when the todo condition is OK
  12669. (and (or (not todo-only) (member todo org-not-done-keywords))
  12670. (let ((case-fold-search t) (org-trust-scanner-tags t))
  12671. (eval matcher)))
  12672. ;; Call the skipper, but return t if it does not skip,
  12673. ;; so that the `and' form continues evaluating
  12674. (progn
  12675. (unless (eq action 'sparse-tree) (org-agenda-skip))
  12676. t)
  12677. ;; Check if timestamps are deselecting this entry
  12678. (or (not todo-only)
  12679. (and (member todo org-not-done-keywords)
  12680. (or (not org-agenda-tags-todo-honor-ignore-options)
  12681. (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item))))))
  12682. ;; select this headline
  12683. (cond
  12684. ((eq action 'sparse-tree)
  12685. (and org-highlight-sparse-tree-matches
  12686. (org-get-heading) (match-end 0)
  12687. (org-highlight-new-match
  12688. (match-beginning 1) (match-end 1)))
  12689. (org-show-context 'tags-tree))
  12690. ((eq action 'agenda)
  12691. (setq txt (org-agenda-format-item
  12692. ""
  12693. (concat
  12694. (if (eq org-tags-match-list-sublevels 'indented)
  12695. (make-string (1- level) ?.) "")
  12696. (org-get-heading))
  12697. level category
  12698. tags-list)
  12699. priority (org-get-priority txt))
  12700. (goto-char lspos)
  12701. (setq marker (org-agenda-new-marker))
  12702. (org-add-props txt props
  12703. 'org-marker marker 'org-hd-marker marker 'org-category category
  12704. 'todo-state todo
  12705. 'priority priority 'type "tagsmatch")
  12706. (push txt rtn))
  12707. ((functionp action)
  12708. (setq org-map-continue-from nil)
  12709. (save-excursion
  12710. (setq rtn1 (funcall action))
  12711. (push rtn1 rtn)))
  12712. (t (user-error "Invalid action")))
  12713. ;; if we are to skip sublevels, jump to end of subtree
  12714. (unless org-tags-match-list-sublevels
  12715. (org-end-of-subtree t)
  12716. (backward-char 1))))
  12717. ;; Get the correct position from where to continue
  12718. (if org-map-continue-from
  12719. (goto-char org-map-continue-from)
  12720. (and (= (point) lspos) (end-of-line 1)))))
  12721. (when (and (eq action 'sparse-tree)
  12722. (not org-sparse-tree-open-archived-trees))
  12723. (org-hide-archived-subtrees (point-min) (point-max)))
  12724. (nreverse rtn)))
  12725. (defun org-remove-uninherited-tags (tags)
  12726. "Remove all tags that are not inherited from the list TAGS."
  12727. (cond
  12728. ((eq org-use-tag-inheritance t)
  12729. (if org-tags-exclude-from-inheritance
  12730. (org-delete-all org-tags-exclude-from-inheritance tags)
  12731. tags))
  12732. ((not org-use-tag-inheritance) nil)
  12733. ((stringp org-use-tag-inheritance)
  12734. (delq nil (mapcar
  12735. (lambda (x)
  12736. (if (and (string-match org-use-tag-inheritance x)
  12737. (not (member x org-tags-exclude-from-inheritance)))
  12738. x nil))
  12739. tags)))
  12740. ((listp org-use-tag-inheritance)
  12741. (delq nil (mapcar
  12742. (lambda (x)
  12743. (if (member x org-use-tag-inheritance) x nil))
  12744. tags)))))
  12745. (defun org-match-sparse-tree (&optional todo-only match)
  12746. "Create a sparse tree according to tags string MATCH.
  12747. MATCH can contain positive and negative selection of tags, like
  12748. \"+WORK+URGENT-WITHBOSS\".
  12749. If optional argument TODO-ONLY is non-nil, only select lines that are
  12750. also TODO lines."
  12751. (interactive "P")
  12752. (org-agenda-prepare-buffers (list (current-buffer)))
  12753. (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
  12754. (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
  12755. (defvar org-cached-props nil)
  12756. (defun org-cached-entry-get (pom property)
  12757. (if (or (eq t org-use-property-inheritance)
  12758. (and (stringp org-use-property-inheritance)
  12759. (string-match org-use-property-inheritance property))
  12760. (and (listp org-use-property-inheritance)
  12761. (member property org-use-property-inheritance)))
  12762. ;; Caching is not possible, check it directly
  12763. (org-entry-get pom property 'inherit)
  12764. ;; Get all properties, so that we can do complicated checks easily
  12765. (cdr (assoc property (or org-cached-props
  12766. (setq org-cached-props
  12767. (org-entry-properties pom)))))))
  12768. (defun org-global-tags-completion-table (&optional files)
  12769. "Return the list of all tags in all agenda buffer/files.
  12770. Optional FILES argument is a list of files which can be used
  12771. instead of the agenda files."
  12772. (save-excursion
  12773. (org-uniquify
  12774. (delq nil
  12775. (apply 'append
  12776. (mapcar
  12777. (lambda (file)
  12778. (set-buffer (find-file-noselect file))
  12779. (append (org-get-buffer-tags)
  12780. (mapcar (lambda (x) (if (stringp (car-safe x))
  12781. (list (car-safe x)) nil))
  12782. org-tag-alist)))
  12783. (if (and files (car files))
  12784. files
  12785. (org-agenda-files))))))))
  12786. (defun org-make-tags-matcher (match)
  12787. "Create the TAGS/TODO matcher form for the selection string MATCH.
  12788. The variable `todo-only' is scoped dynamically into this function.
  12789. It will be set to t if the matcher restricts matching to TODO entries,
  12790. otherwise will not be touched.
  12791. Returns a cons of the selection string MATCH and the constructed
  12792. lisp form implementing the matcher. The matcher is to be evaluated
  12793. at an Org entry, with point on the headline, and returns t if the
  12794. entry matches the selection string MATCH. The returned lisp form
  12795. references two variables with information about the entry, which
  12796. must be bound around the form's evaluation: todo, the TODO keyword
  12797. at the entry (or nil of none); and tags-list, the list of all tags
  12798. at the entry including inherited ones. Additionally, the category
  12799. of the entry (if any) must be specified as the text property
  12800. 'org-category on the headline.
  12801. See also `org-scan-tags'.
  12802. "
  12803. (declare (special todo-only))
  12804. (unless (boundp 'todo-only)
  12805. (error "`org-make-tags-matcher' expects todo-only to be scoped in"))
  12806. (unless match
  12807. ;; Get a new match request, with completion against the global
  12808. ;; tags table and the local tags in current buffer
  12809. (let ((org-last-tags-completion-table
  12810. (org-uniquify
  12811. (delq nil (append (org-get-buffer-tags)
  12812. (org-global-tags-completion-table))))))
  12813. (setq match (org-completing-read-no-i
  12814. "Match: " 'org-tags-completion-function nil nil nil
  12815. 'org-tags-history))))
  12816. ;; Parse the string and create a lisp form
  12817. (let ((match0 match)
  12818. (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
  12819. minus tag mm
  12820. tagsmatch todomatch tagsmatcher todomatcher kwd matcher
  12821. orterms term orlist re-p str-p level-p level-op time-p
  12822. prop-p pn pv po gv rest (start 0) (ss 0))
  12823. ;; Expand group tags
  12824. (setq match (org-tags-expand match))
  12825. ;; Check if there is a TODO part of this match, which would be the
  12826. ;; part after a "/". TO make sure that this slash is not part of
  12827. ;; a property value to be matched against, we also check that there
  12828. ;; is no " after that slash.
  12829. ;; First, find the last slash
  12830. (while (string-match "/+" match ss)
  12831. (setq start (match-beginning 0) ss (match-end 0)))
  12832. (if (and (string-match "/+" match start)
  12833. (not (save-match-data (string-match "\"" match start))))
  12834. ;; match contains also a todo-matching request
  12835. (progn
  12836. (setq tagsmatch (substring match 0 (match-beginning 0))
  12837. todomatch (substring match (match-end 0)))
  12838. (if (string-match "^!" todomatch)
  12839. (setq todo-only t todomatch (substring todomatch 1)))
  12840. (if (string-match "^\\s-*$" todomatch)
  12841. (setq todomatch nil)))
  12842. ;; only matching tags
  12843. (setq tagsmatch match todomatch nil))
  12844. ;; Make the tags matcher
  12845. (if (or (not tagsmatch) (not (string-match "\\S-" tagsmatch)))
  12846. (setq tagsmatcher t)
  12847. (setq orterms (org-split-string tagsmatch "|") orlist nil)
  12848. (while (setq term (pop orterms))
  12849. (while (and (equal (substring term -1) "\\") orterms)
  12850. (setq term (concat term "|" (pop orterms)))) ; repair bad split
  12851. (while (string-match re term)
  12852. (setq rest (substring term (match-end 0))
  12853. minus (and (match-end 1)
  12854. (equal (match-string 1 term) "-"))
  12855. tag (save-match-data (replace-regexp-in-string
  12856. "\\\\-" "-"
  12857. (match-string 2 term)))
  12858. re-p (equal (string-to-char tag) ?{)
  12859. level-p (match-end 4)
  12860. prop-p (match-end 5)
  12861. mm (cond
  12862. (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
  12863. (level-p
  12864. (setq level-op (org-op-to-function (match-string 3 term)))
  12865. `(,level-op level ,(string-to-number
  12866. (match-string 4 term))))
  12867. (prop-p
  12868. (setq pn (match-string 5 term)
  12869. po (match-string 6 term)
  12870. pv (match-string 7 term)
  12871. re-p (equal (string-to-char pv) ?{)
  12872. str-p (equal (string-to-char pv) ?\")
  12873. time-p (save-match-data
  12874. (string-match "^\"[[<].*[]>]\"$" pv))
  12875. pv (if (or re-p str-p) (substring pv 1 -1) pv))
  12876. (if time-p (setq pv (org-matcher-time pv)))
  12877. (setq po (org-op-to-function po (if time-p 'time str-p)))
  12878. (cond
  12879. ((equal pn "CATEGORY")
  12880. (setq gv '(get-text-property (point) 'org-category)))
  12881. ((equal pn "TODO")
  12882. (setq gv 'todo))
  12883. (t
  12884. (setq gv `(org-cached-entry-get nil ,pn))))
  12885. (if re-p
  12886. (if (eq po 'org<>)
  12887. `(not (string-match ,pv (or ,gv "")))
  12888. `(string-match ,pv (or ,gv "")))
  12889. (if str-p
  12890. `(,po (or ,gv "") ,pv)
  12891. `(,po (string-to-number (or ,gv ""))
  12892. ,(string-to-number pv) ))))
  12893. (t `(member ,tag tags-list)))
  12894. mm (if minus (list 'not mm) mm)
  12895. term rest)
  12896. (push mm tagsmatcher))
  12897. (push (if (> (length tagsmatcher) 1)
  12898. (cons 'and tagsmatcher)
  12899. (car tagsmatcher))
  12900. orlist)
  12901. (setq tagsmatcher nil))
  12902. (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
  12903. (setq tagsmatcher
  12904. (list 'progn '(setq org-cached-props nil) tagsmatcher)))
  12905. ;; Make the todo matcher
  12906. (if (or (not todomatch) (not (string-match "\\S-" todomatch)))
  12907. (setq todomatcher t)
  12908. (setq orterms (org-split-string todomatch "|") orlist nil)
  12909. (while (setq term (pop orterms))
  12910. (while (string-match re term)
  12911. (setq minus (and (match-end 1)
  12912. (equal (match-string 1 term) "-"))
  12913. kwd (match-string 2 term)
  12914. re-p (equal (string-to-char kwd) ?{)
  12915. term (substring term (match-end 0))
  12916. mm (if re-p
  12917. `(string-match ,(substring kwd 1 -1) todo)
  12918. (list 'equal 'todo kwd))
  12919. mm (if minus (list 'not mm) mm))
  12920. (push mm todomatcher))
  12921. (push (if (> (length todomatcher) 1)
  12922. (cons 'and todomatcher)
  12923. (car todomatcher))
  12924. orlist)
  12925. (setq todomatcher nil))
  12926. (setq todomatcher (if (> (length orlist) 1)
  12927. (cons 'or orlist) (car orlist))))
  12928. ;; Return the string and lisp forms of the matcher
  12929. (setq matcher (if todomatcher
  12930. (list 'and tagsmatcher todomatcher)
  12931. tagsmatcher))
  12932. (when todo-only
  12933. (setq matcher (list 'and '(member todo org-not-done-keywords)
  12934. matcher)))
  12935. (cons match0 matcher)))
  12936. (defun org-tags-expand (match &optional single-as-list downcased)
  12937. "Expand group tags in MATCH.
  12938. This replaces every group tag in MATCH with a regexp tag search.
  12939. For example, a group tag \"Work\" defined as { Work : Lab Conf }
  12940. will be replaced like this:
  12941. Work => {\\(?:Work\\|Lab\\|Conf\\)}
  12942. +Work => +{\\(?:Work\\|Lab\\|Conf\\)}
  12943. -Work => -{\\(?:Work\\|Lab\\|Conf\\)}
  12944. Replacing by a regexp preserves the structure of the match.
  12945. E.g., this expansion
  12946. Work|Home => {\\(?:Work\\|Lab\\|Conf\\}|Home
  12947. will match anything tagged with \"Lab\" and \"Home\", or tagged
  12948. with \"Conf\" and \"Home\" or tagged with \"Work\" and \"home\".
  12949. When the optional argument SINGLE-AS-LIST is non-nil, MATCH is
  12950. assumed to be a single group tag, and the function will return
  12951. the list of tags in this group.
  12952. When DOWNCASE is non-nil, expand downcased TAGS."
  12953. (if org-group-tags
  12954. (let* ((case-fold-search t)
  12955. (stable org-mode-syntax-table)
  12956. (tal (or org-tag-groups-alist-for-agenda
  12957. org-tag-groups-alist))
  12958. (tal (if downcased
  12959. (mapcar (lambda(tg) (mapcar 'downcase tg)) tal) tal))
  12960. (tml (mapcar 'car tal))
  12961. (rtnmatch match) rpl)
  12962. ;; @ and _ are allowed as word-components in tags
  12963. (modify-syntax-entry ?@ "w" stable)
  12964. (modify-syntax-entry ?_ "w" stable)
  12965. (while (and tml
  12966. (with-syntax-table stable
  12967. (string-match
  12968. (concat "\\(?1:[+-]?\\)\\(?2:\\<"
  12969. (regexp-opt tml) "\\>\\)") rtnmatch)))
  12970. (let* ((dir (match-string 1 rtnmatch))
  12971. (tag (match-string 2 rtnmatch))
  12972. (tag (if downcased (downcase tag) tag)))
  12973. (setq tml (delete tag tml))
  12974. (when (not (get-text-property 0 'grouptag (match-string 2 rtnmatch)))
  12975. (setq rpl (append (org-uniquify rpl) (assoc tag tal)))
  12976. (setq rpl (concat dir "{\\<" (regexp-opt rpl) "\\>}"))
  12977. (if (stringp rpl) (org-add-props rpl '(grouptag t)))
  12978. (setq rtnmatch (replace-match rpl t t rtnmatch)))))
  12979. (if single-as-list
  12980. (or (reverse rpl) (list rtnmatch))
  12981. rtnmatch))
  12982. (if single-as-list (list (if downcased (downcase match) match))
  12983. match)))
  12984. (defun org-op-to-function (op &optional stringp)
  12985. "Turn an operator into the appropriate function."
  12986. (setq op
  12987. (cond
  12988. ((equal op "<" ) '(< string< org-time<))
  12989. ((equal op ">" ) '(> org-string> org-time>))
  12990. ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
  12991. ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
  12992. ((member op '("=" "==")) '(= string= org-time=))
  12993. ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
  12994. (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
  12995. (defun org<> (a b) (not (= a b)))
  12996. (defun org-string<= (a b) (or (string= a b) (string< a b)))
  12997. (defun org-string>= (a b) (not (string< a b)))
  12998. (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
  12999. (defun org-string<> (a b) (not (string= a b)))
  13000. (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
  13001. (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
  13002. (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
  13003. (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
  13004. (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
  13005. (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
  13006. (defun org-2ft (s)
  13007. "Convert S to a floating point time.
  13008. If S is already a number, just return it. If it is a string, parse
  13009. it as a time string and apply `float-time' to it. If S is nil, just return 0."
  13010. (cond
  13011. ((numberp s) s)
  13012. ((stringp s)
  13013. (condition-case nil
  13014. (float-time (apply 'encode-time (org-parse-time-string s)))
  13015. (error 0.)))
  13016. (t 0.)))
  13017. (defun org-time-today ()
  13018. "Time in seconds today at 0:00.
  13019. Returns the float number of seconds since the beginning of the
  13020. epoch to the beginning of today (00:00)."
  13021. (float-time (apply 'encode-time
  13022. (append '(0 0 0) (nthcdr 3 (decode-time))))))
  13023. (defun org-matcher-time (s)
  13024. "Interpret a time comparison value."
  13025. (save-match-data
  13026. (cond
  13027. ((string= s "<now>") (float-time))
  13028. ((string= s "<today>") (org-time-today))
  13029. ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
  13030. ((string= s "<yesterday>") (- (org-time-today) 86400.0))
  13031. ((string-match "^<\\([-+][0-9]+\\)\\([hdwmy]\\)>$" s)
  13032. (+ (org-time-today)
  13033. (* (string-to-number (match-string 1 s))
  13034. (cdr (assoc (match-string 2 s)
  13035. '(("d" . 86400.0) ("w" . 604800.0)
  13036. ("m" . 2678400.0) ("y" . 31557600.0)))))))
  13037. (t (org-2ft s)))))
  13038. (defun org-match-any-p (re list)
  13039. "Does re match any element of list?"
  13040. (setq list (mapcar (lambda (x) (string-match re x)) list))
  13041. (delq nil list))
  13042. (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
  13043. (defvar org-tags-overlay (make-overlay 1 1))
  13044. (org-detach-overlay org-tags-overlay)
  13045. (defun org-get-local-tags-at (&optional pos)
  13046. "Get a list of tags defined in the current headline."
  13047. (org-get-tags-at pos 'local))
  13048. (defun org-get-local-tags ()
  13049. "Get a list of tags defined in the current headline."
  13050. (org-get-tags-at nil 'local))
  13051. (defun org-get-tags-at (&optional pos local)
  13052. "Get a list of all headline tags applicable at POS.
  13053. POS defaults to point. If tags are inherited, the list contains
  13054. the targets in the same sequence as the headlines appear, i.e.
  13055. the tags of the current headline come last.
  13056. When LOCAL is non-nil, only return tags from the current headline,
  13057. ignore inherited ones."
  13058. (interactive)
  13059. (if (and org-trust-scanner-tags
  13060. (or (not pos) (equal pos (point)))
  13061. (not local))
  13062. org-scanner-tags
  13063. (let (tags ltags lastpos parent)
  13064. (save-excursion
  13065. (save-restriction
  13066. (widen)
  13067. (goto-char (or pos (point)))
  13068. (save-match-data
  13069. (catch 'done
  13070. (condition-case nil
  13071. (progn
  13072. (org-back-to-heading t)
  13073. (while (not (equal lastpos (point)))
  13074. (setq lastpos (point))
  13075. (when (looking-at
  13076. (org-re "[^\r\n]+?:\\([[:alnum:]_@#%:]+\\):[ \t]*$"))
  13077. (setq ltags (org-split-string
  13078. (org-match-string-no-properties 1) ":"))
  13079. (when parent
  13080. (setq ltags (mapcar 'org-add-prop-inherited ltags)))
  13081. (setq tags (append
  13082. (if parent
  13083. (org-remove-uninherited-tags ltags)
  13084. ltags)
  13085. tags)))
  13086. (or org-use-tag-inheritance (throw 'done t))
  13087. (if local (throw 'done t))
  13088. (or (org-up-heading-safe) (error nil))
  13089. (setq parent t)))
  13090. (error nil)))))
  13091. (if local
  13092. tags
  13093. (reverse (delete-dups
  13094. (reverse (append
  13095. (org-remove-uninherited-tags
  13096. org-file-tags) tags)))))))))
  13097. (defun org-add-prop-inherited (s)
  13098. (add-text-properties 0 (length s) '(inherited t) s)
  13099. s)
  13100. (defun org-toggle-tag (tag &optional onoff)
  13101. "Toggle the tag TAG for the current line.
  13102. If ONOFF is `on' or `off', don't toggle but set to this state."
  13103. (let (res current)
  13104. (save-excursion
  13105. (org-back-to-heading t)
  13106. (if (re-search-forward (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t]*$")
  13107. (point-at-eol) t)
  13108. (progn
  13109. (setq current (match-string 1))
  13110. (replace-match ""))
  13111. (setq current ""))
  13112. (setq current (nreverse (org-split-string current ":")))
  13113. (cond
  13114. ((eq onoff 'on)
  13115. (setq res t)
  13116. (or (member tag current) (push tag current)))
  13117. ((eq onoff 'off)
  13118. (or (not (member tag current)) (setq current (delete tag current))))
  13119. (t (if (member tag current)
  13120. (setq current (delete tag current))
  13121. (setq res t)
  13122. (push tag current))))
  13123. (end-of-line 1)
  13124. (if current
  13125. (progn
  13126. (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
  13127. (org-set-tags nil t))
  13128. (delete-horizontal-space))
  13129. (run-hooks 'org-after-tags-change-hook))
  13130. res))
  13131. (defun org-align-tags-here (to-col)
  13132. ;; Assumes that this is a headline
  13133. (let ((pos (point)) (col (current-column)) ncol tags-l p)
  13134. (beginning-of-line 1)
  13135. (if (and (looking-at (org-re ".*?\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
  13136. (< pos (match-beginning 2)))
  13137. (progn
  13138. (setq tags-l (- (match-end 2) (match-beginning 2)))
  13139. (goto-char (match-beginning 1))
  13140. (insert " ")
  13141. (delete-region (point) (1+ (match-beginning 2)))
  13142. (setq ncol (max (current-column)
  13143. (1+ col)
  13144. (if (> to-col 0)
  13145. to-col
  13146. (- (abs to-col) tags-l))))
  13147. (setq p (point))
  13148. (insert (make-string (- ncol (current-column)) ?\ ))
  13149. (setq ncol (current-column))
  13150. (when indent-tabs-mode (tabify p (point-at-eol)))
  13151. (org-move-to-column (min ncol col) t))
  13152. (goto-char pos))))
  13153. (defun org-set-tags-command (&optional arg just-align)
  13154. "Call the set-tags command for the current entry."
  13155. (interactive "P")
  13156. (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
  13157. (org-set-tags arg just-align)
  13158. (save-excursion
  13159. (unless (and (org-region-active-p)
  13160. org-loop-over-headlines-in-active-region)
  13161. (org-back-to-heading t))
  13162. (org-set-tags arg just-align))))
  13163. (defun org-set-tags-to (data)
  13164. "Set the tags of the current entry to DATA, replacing the current tags.
  13165. DATA may be a tags string like :aa:bb:cc:, or a list of tags.
  13166. If DATA is nil or the empty string, any tags will be removed."
  13167. (interactive "sTags: ")
  13168. (setq data
  13169. (cond
  13170. ((eq data nil) "")
  13171. ((equal data "") "")
  13172. ((stringp data)
  13173. (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
  13174. ":"))
  13175. ((listp data)
  13176. (concat ":" (mapconcat 'identity data ":") ":"))))
  13177. (when data
  13178. (save-excursion
  13179. (org-back-to-heading t)
  13180. (when (looking-at org-complex-heading-regexp)
  13181. (if (match-end 5)
  13182. (progn
  13183. (goto-char (match-beginning 5))
  13184. (insert data)
  13185. (delete-region (point) (point-at-eol))
  13186. (org-set-tags nil 'align))
  13187. (goto-char (point-at-eol))
  13188. (insert " " data)
  13189. (org-set-tags nil 'align)))
  13190. (beginning-of-line 1)
  13191. (if (looking-at ".*?\\([ \t]+\\)$")
  13192. (delete-region (match-beginning 1) (match-end 1))))))
  13193. (defun org-align-all-tags ()
  13194. "Align the tags i all headings."
  13195. (interactive)
  13196. (save-excursion
  13197. (or (ignore-errors (org-back-to-heading t))
  13198. (outline-next-heading))
  13199. (if (org-at-heading-p)
  13200. (org-set-tags t)
  13201. (message "No headings"))))
  13202. (defvar org-indent-indentation-per-level)
  13203. (defun org-set-tags (&optional arg just-align)
  13204. "Set the tags for the current headline.
  13205. With prefix ARG, realign all tags in headings in the current buffer."
  13206. (interactive "P")
  13207. (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
  13208. (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
  13209. 'region-start-level 'region))
  13210. org-loop-over-headlines-in-active-region)
  13211. (org-map-entries
  13212. ;; We don't use ARG and JUST-ALIGN here these args are not
  13213. ;; useful when looping over headlines
  13214. `(org-set-tags)
  13215. org-loop-over-headlines-in-active-region
  13216. cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
  13217. (let* ((re org-outline-regexp-bol)
  13218. (current (unless arg (org-get-tags-string)))
  13219. (col (current-column))
  13220. (org-setting-tags t)
  13221. table current-tags inherited-tags ; computed below when needed
  13222. tags p0 c0 c1 rpl di tc level)
  13223. (if arg
  13224. (save-excursion
  13225. (goto-char (point-min))
  13226. (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
  13227. (while (re-search-forward re nil t)
  13228. (org-set-tags nil t)
  13229. (end-of-line 1)))
  13230. (message "All tags realigned to column %d" org-tags-column))
  13231. (if just-align
  13232. (setq tags current)
  13233. ;; Get a new set of tags from the user
  13234. (save-excursion
  13235. (setq table (append org-tag-persistent-alist
  13236. (or org-tag-alist (org-get-buffer-tags))
  13237. (and
  13238. org-complete-tags-always-offer-all-agenda-tags
  13239. (org-global-tags-completion-table
  13240. (org-agenda-files))))
  13241. org-last-tags-completion-table table
  13242. current-tags (org-split-string current ":")
  13243. inherited-tags (nreverse
  13244. (nthcdr (length current-tags)
  13245. (nreverse (org-get-tags-at))))
  13246. tags
  13247. (if (or (eq t org-use-fast-tag-selection)
  13248. (and org-use-fast-tag-selection
  13249. (delq nil (mapcar 'cdr table))))
  13250. (org-fast-tag-selection
  13251. current-tags inherited-tags table
  13252. (if org-fast-tag-selection-include-todo
  13253. org-todo-key-alist))
  13254. (let ((org-add-colon-after-tag-completion (< 1 (length table))))
  13255. (org-trim
  13256. (org-icompleting-read "Tags: "
  13257. 'org-tags-completion-function
  13258. nil nil current 'org-tags-history))))))
  13259. (while (string-match "[-+&]+" tags)
  13260. ;; No boolean logic, just a list
  13261. (setq tags (replace-match ":" t t tags))))
  13262. (setq tags (replace-regexp-in-string "[,]" ":" tags))
  13263. (if org-tags-sort-function
  13264. (setq tags (mapconcat 'identity
  13265. (sort (org-split-string
  13266. tags (org-re "[^[:alnum:]_@#%]+"))
  13267. org-tags-sort-function) ":")))
  13268. (if (string-match "\\`[\t ]*\\'" tags)
  13269. (setq tags "")
  13270. (unless (string-match ":$" tags) (setq tags (concat tags ":")))
  13271. (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
  13272. ;; Insert new tags at the correct column
  13273. (beginning-of-line 1)
  13274. (setq level (or (and (looking-at org-outline-regexp)
  13275. (- (match-end 0) (point) 1))
  13276. 1))
  13277. (cond
  13278. ((and (equal current "") (equal tags "")))
  13279. ((re-search-forward
  13280. (concat "\\([ \t]*" (regexp-quote current) "\\)[ \t]*$")
  13281. (point-at-eol) t)
  13282. (if (equal tags "")
  13283. (setq rpl "")
  13284. (goto-char (match-beginning 0))
  13285. (setq c0 (current-column)
  13286. ;; compute offset for the case of org-indent-mode active
  13287. di (if org-indent-mode
  13288. (* (1- org-indent-indentation-per-level) (1- level))
  13289. 0)
  13290. p0 (if (equal (char-before) ?*) (1+ (point)) (point))
  13291. tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
  13292. c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
  13293. rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
  13294. (replace-match rpl t t)
  13295. (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
  13296. tags)
  13297. (t (error "Tags alignment failed")))
  13298. (org-move-to-column col)
  13299. (unless just-align
  13300. (run-hooks 'org-after-tags-change-hook))))))
  13301. (defun org-change-tag-in-region (beg end tag off)
  13302. "Add or remove TAG for each entry in the region.
  13303. This works in the agenda, and also in an org-mode buffer."
  13304. (interactive
  13305. (list (region-beginning) (region-end)
  13306. (let ((org-last-tags-completion-table
  13307. (if (derived-mode-p 'org-mode)
  13308. (org-uniquify
  13309. (delq nil (append (org-get-buffer-tags)
  13310. (org-global-tags-completion-table))))
  13311. (org-global-tags-completion-table))))
  13312. (org-icompleting-read
  13313. "Tag: " 'org-tags-completion-function nil nil nil
  13314. 'org-tags-history))
  13315. (progn
  13316. (message "[s]et or [r]emove? ")
  13317. (equal (read-char-exclusive) ?r))))
  13318. (if (fboundp 'deactivate-mark) (deactivate-mark))
  13319. (let ((agendap (equal major-mode 'org-agenda-mode))
  13320. l1 l2 m buf pos newhead (cnt 0))
  13321. (goto-char end)
  13322. (setq l2 (1- (org-current-line)))
  13323. (goto-char beg)
  13324. (setq l1 (org-current-line))
  13325. (loop for l from l1 to l2 do
  13326. (org-goto-line l)
  13327. (setq m (get-text-property (point) 'org-hd-marker))
  13328. (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
  13329. (and agendap m))
  13330. (setq buf (if agendap (marker-buffer m) (current-buffer))
  13331. pos (if agendap m (point)))
  13332. (with-current-buffer buf
  13333. (save-excursion
  13334. (save-restriction
  13335. (goto-char pos)
  13336. (setq cnt (1+ cnt))
  13337. (org-toggle-tag tag (if off 'off 'on))
  13338. (setq newhead (org-get-heading)))))
  13339. (and agendap (org-agenda-change-all-lines newhead m))))
  13340. (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
  13341. (defun org-tags-completion-function (string predicate &optional flag)
  13342. (let (s1 s2 rtn (ctable org-last-tags-completion-table)
  13343. (confirm (lambda (x) (stringp (car x)))))
  13344. (if (string-match "^\\(.*[-+:&,|]\\)\\([^-+:&,|]*\\)$" string)
  13345. (setq s1 (match-string 1 string)
  13346. s2 (match-string 2 string))
  13347. (setq s1 "" s2 string))
  13348. (cond
  13349. ((eq flag nil)
  13350. ;; try completion
  13351. (setq rtn (try-completion s2 ctable confirm))
  13352. (if (stringp rtn)
  13353. (setq rtn
  13354. (concat s1 s2 (substring rtn (length s2))
  13355. (if (and org-add-colon-after-tag-completion
  13356. (assoc rtn ctable))
  13357. ":" ""))))
  13358. rtn)
  13359. ((eq flag t)
  13360. ;; all-completions
  13361. (all-completions s2 ctable confirm))
  13362. ((eq flag 'lambda)
  13363. ;; exact match?
  13364. (assoc s2 ctable)))))
  13365. (defun org-fast-tag-insert (kwd tags face &optional end)
  13366. "Insert KDW, and the TAGS, the latter with face FACE.
  13367. Also insert END."
  13368. (insert (format "%-12s" (concat kwd ":"))
  13369. (org-add-props (mapconcat 'identity tags " ") nil 'face face)
  13370. (or end "")))
  13371. (defun org-fast-tag-show-exit (flag)
  13372. (save-excursion
  13373. (org-goto-line 3)
  13374. (if (re-search-forward "[ \t]+Next change exits" (point-at-eol) t)
  13375. (replace-match ""))
  13376. (when flag
  13377. (end-of-line 1)
  13378. (org-move-to-column (- (window-width) 19) t)
  13379. (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
  13380. (defun org-set-current-tags-overlay (current prefix)
  13381. "Add an overlay to CURRENT tag with PREFIX."
  13382. (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
  13383. (if (featurep 'xemacs)
  13384. (org-overlay-display org-tags-overlay (concat prefix s)
  13385. 'secondary-selection)
  13386. (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
  13387. (org-overlay-display org-tags-overlay (concat prefix s)))))
  13388. (defvar org-last-tag-selection-key nil)
  13389. (defun org-fast-tag-selection (current inherited table &optional todo-table)
  13390. "Fast tag selection with single keys.
  13391. CURRENT is the current list of tags in the headline, INHERITED is the
  13392. list of inherited tags, and TABLE is an alist of tags and corresponding keys,
  13393. possibly with grouping information. TODO-TABLE is a similar table with
  13394. TODO keywords, should these have keys assigned to them.
  13395. If the keys are nil, a-z are automatically assigned.
  13396. Returns the new tags string, or nil to not change the current settings."
  13397. (let* ((fulltable (append table todo-table))
  13398. (maxlen (apply 'max (mapcar
  13399. (lambda (x)
  13400. (if (stringp (car x)) (string-width (car x)) 0))
  13401. fulltable)))
  13402. (buf (current-buffer))
  13403. (expert (eq org-fast-tag-selection-single-key 'expert))
  13404. (buffer-tags nil)
  13405. (fwidth (+ maxlen 3 1 3))
  13406. (ncol (/ (- (window-width) 4) fwidth))
  13407. (i-face 'org-done)
  13408. (c-face 'org-todo)
  13409. tg cnt e c char c1 c2 ntable tbl rtn
  13410. ov-start ov-end ov-prefix
  13411. (exit-after-next org-fast-tag-selection-single-key)
  13412. (done-keywords org-done-keywords)
  13413. groups ingroup)
  13414. (save-excursion
  13415. (beginning-of-line 1)
  13416. (if (looking-at
  13417. (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
  13418. (setq ov-start (match-beginning 1)
  13419. ov-end (match-end 1)
  13420. ov-prefix "")
  13421. (setq ov-start (1- (point-at-eol))
  13422. ov-end (1+ ov-start))
  13423. (skip-chars-forward "^\n\r")
  13424. (setq ov-prefix
  13425. (concat
  13426. (buffer-substring (1- (point)) (point))
  13427. (if (> (current-column) org-tags-column)
  13428. " "
  13429. (make-string (- org-tags-column (current-column)) ?\ ))))))
  13430. (move-overlay org-tags-overlay ov-start ov-end)
  13431. (save-window-excursion
  13432. (if expert
  13433. (set-buffer (get-buffer-create " *Org tags*"))
  13434. (delete-other-windows)
  13435. (split-window-vertically)
  13436. (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
  13437. (erase-buffer)
  13438. (org-set-local 'org-done-keywords done-keywords)
  13439. (org-fast-tag-insert "Inherited" inherited i-face "\n")
  13440. (org-fast-tag-insert "Current" current c-face "\n\n")
  13441. (org-fast-tag-show-exit exit-after-next)
  13442. (org-set-current-tags-overlay current ov-prefix)
  13443. (setq tbl fulltable char ?a cnt 0)
  13444. (while (setq e (pop tbl))
  13445. (cond
  13446. ((equal (car e) :startgroup)
  13447. (push '() groups) (setq ingroup t)
  13448. (when (not (= cnt 0))
  13449. (setq cnt 0)
  13450. (insert "\n"))
  13451. (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
  13452. ((equal (car e) :endgroup)
  13453. (setq ingroup nil cnt 0)
  13454. (insert "}" (if (cdr e) (format " (%s) " (cdr e)) "") "\n"))
  13455. ((equal e '(:newline))
  13456. (when (not (= cnt 0))
  13457. (setq cnt 0)
  13458. (insert "\n")
  13459. (setq e (car tbl))
  13460. (while (equal (car tbl) '(:newline))
  13461. (insert "\n")
  13462. (setq tbl (cdr tbl)))))
  13463. ((equal e '(:grouptags)) nil)
  13464. (t
  13465. (setq tg (copy-sequence (car e)) c2 nil)
  13466. (if (cdr e)
  13467. (setq c (cdr e))
  13468. ;; automatically assign a character.
  13469. (setq c1 (string-to-char
  13470. (downcase (substring
  13471. tg (if (= (string-to-char tg) ?@) 1 0)))))
  13472. (if (or (rassoc c1 ntable) (rassoc c1 table))
  13473. (while (or (rassoc char ntable) (rassoc char table))
  13474. (setq char (1+ char)))
  13475. (setq c2 c1))
  13476. (setq c (or c2 char)))
  13477. (if ingroup (push tg (car groups)))
  13478. (setq tg (org-add-props tg nil 'face
  13479. (cond
  13480. ((not (assoc tg table))
  13481. (org-get-todo-face tg))
  13482. ((member tg current) c-face)
  13483. ((member tg inherited) i-face))))
  13484. (if (equal (caar tbl) :grouptags)
  13485. (org-add-props tg nil 'face 'org-tag-group))
  13486. (if (and (= cnt 0) (not ingroup)) (insert " "))
  13487. (insert "[" c "] " tg (make-string
  13488. (- fwidth 4 (length tg)) ?\ ))
  13489. (push (cons tg c) ntable)
  13490. (when (= (setq cnt (1+ cnt)) ncol)
  13491. (insert "\n")
  13492. (if ingroup (insert " "))
  13493. (setq cnt 0)))))
  13494. (setq ntable (nreverse ntable))
  13495. (insert "\n")
  13496. (goto-char (point-min))
  13497. (if (not expert) (org-fit-window-to-buffer))
  13498. (setq rtn
  13499. (catch 'exit
  13500. (while t
  13501. (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
  13502. (if (not groups) "no " "")
  13503. (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
  13504. (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
  13505. (setq org-last-tag-selection-key c)
  13506. (cond
  13507. ((= c ?\r) (throw 'exit t))
  13508. ((= c ?!)
  13509. (setq groups (not groups))
  13510. (goto-char (point-min))
  13511. (while (re-search-forward "[{}]" nil t) (replace-match " ")))
  13512. ((= c ?\C-c)
  13513. (if (not expert)
  13514. (org-fast-tag-show-exit
  13515. (setq exit-after-next (not exit-after-next)))
  13516. (setq expert nil)
  13517. (delete-other-windows)
  13518. (set-window-buffer (split-window-vertically) " *Org tags*")
  13519. (org-switch-to-buffer-other-window " *Org tags*")
  13520. (org-fit-window-to-buffer)))
  13521. ((or (= c ?\C-g)
  13522. (and (= c ?q) (not (rassoc c ntable))))
  13523. (org-detach-overlay org-tags-overlay)
  13524. (setq quit-flag t))
  13525. ((= c ?\ )
  13526. (setq current nil)
  13527. (if exit-after-next (setq exit-after-next 'now)))
  13528. ((= c ?\t)
  13529. (condition-case nil
  13530. (setq tg (org-icompleting-read
  13531. "Tag: "
  13532. (or buffer-tags
  13533. (with-current-buffer buf
  13534. (org-get-buffer-tags)))))
  13535. (quit (setq tg "")))
  13536. (when (string-match "\\S-" tg)
  13537. (add-to-list 'buffer-tags (list tg))
  13538. (if (member tg current)
  13539. (setq current (delete tg current))
  13540. (push tg current)))
  13541. (if exit-after-next (setq exit-after-next 'now)))
  13542. ((setq e (rassoc c todo-table) tg (car e))
  13543. (with-current-buffer buf
  13544. (save-excursion (org-todo tg)))
  13545. (if exit-after-next (setq exit-after-next 'now)))
  13546. ((setq e (rassoc c ntable) tg (car e))
  13547. (if (member tg current)
  13548. (setq current (delete tg current))
  13549. (loop for g in groups do
  13550. (if (member tg g)
  13551. (mapc (lambda (x)
  13552. (setq current (delete x current)))
  13553. g)))
  13554. (push tg current))
  13555. (if exit-after-next (setq exit-after-next 'now))))
  13556. ;; Create a sorted list
  13557. (setq current
  13558. (sort current
  13559. (lambda (a b)
  13560. (assoc b (cdr (memq (assoc a ntable) ntable))))))
  13561. (if (eq exit-after-next 'now) (throw 'exit t))
  13562. (goto-char (point-min))
  13563. (beginning-of-line 2)
  13564. (delete-region (point) (point-at-eol))
  13565. (org-fast-tag-insert "Current" current c-face)
  13566. (org-set-current-tags-overlay current ov-prefix)
  13567. (while (re-search-forward
  13568. (org-re "\\[.\\] \\([[:alnum:]_@#%]+\\)") nil t)
  13569. (setq tg (match-string 1))
  13570. (add-text-properties
  13571. (match-beginning 1) (match-end 1)
  13572. (list 'face
  13573. (cond
  13574. ((member tg current) c-face)
  13575. ((member tg inherited) i-face)
  13576. (t (get-text-property (match-beginning 1) 'face))))))
  13577. (goto-char (point-min)))))
  13578. (org-detach-overlay org-tags-overlay)
  13579. (if rtn
  13580. (mapconcat 'identity current ":")
  13581. nil))))
  13582. (defun org-get-tags-string ()
  13583. "Get the TAGS string in the current headline."
  13584. (unless (org-at-heading-p t)
  13585. (user-error "Not on a heading"))
  13586. (save-excursion
  13587. (beginning-of-line 1)
  13588. (if (looking-at (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
  13589. (org-match-string-no-properties 1)
  13590. "")))
  13591. (defun org-get-tags ()
  13592. "Get the list of tags specified in the current headline."
  13593. (org-split-string (org-get-tags-string) ":"))
  13594. (defun org-get-buffer-tags ()
  13595. "Get a table of all tags used in the buffer, for completion."
  13596. (let (tags)
  13597. (save-excursion
  13598. (goto-char (point-min))
  13599. (while (re-search-forward
  13600. (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t\r\n]") nil t)
  13601. (when (equal (char-after (point-at-bol 0)) ?*)
  13602. (mapc (lambda (x) (add-to-list 'tags x))
  13603. (org-split-string (org-match-string-no-properties 1) ":")))))
  13604. (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
  13605. (mapcar 'list tags)))
  13606. ;;;; The mapping API
  13607. (defun org-map-entries (func &optional match scope &rest skip)
  13608. "Call FUNC at each headline selected by MATCH in SCOPE.
  13609. FUNC is a function or a lisp form. The function will be called without
  13610. arguments, with the cursor positioned at the beginning of the headline.
  13611. The return values of all calls to the function will be collected and
  13612. returned as a list.
  13613. The call to FUNC will be wrapped into a save-excursion form, so FUNC
  13614. does not need to preserve point. After evaluation, the cursor will be
  13615. moved to the end of the line (presumably of the headline of the
  13616. processed entry) and search continues from there. Under some
  13617. circumstances, this may not produce the wanted results. For example,
  13618. if you have removed (e.g. archived) the current (sub)tree it could
  13619. mean that the next entry will be skipped entirely. In such cases, you
  13620. can specify the position from where search should continue by making
  13621. FUNC set the variable `org-map-continue-from' to the desired buffer
  13622. position.
  13623. MATCH is a tags/property/todo match as it is used in the agenda tags view.
  13624. Only headlines that are matched by this query will be considered during
  13625. the iteration. When MATCH is nil or t, all headlines will be
  13626. visited by the iteration.
  13627. SCOPE determines the scope of this command. It can be any of:
  13628. nil The current buffer, respecting the restriction if any
  13629. tree The subtree started with the entry at point
  13630. region The entries within the active region, if any
  13631. region-start-level
  13632. The entries within the active region, but only those at
  13633. the same level than the first one.
  13634. file The current buffer, without restriction
  13635. file-with-archives
  13636. The current buffer, and any archives associated with it
  13637. agenda All agenda files
  13638. agenda-with-archives
  13639. All agenda files with any archive files associated with them
  13640. \(file1 file2 ...)
  13641. If this is a list, all files in the list will be scanned
  13642. The remaining args are treated as settings for the skipping facilities of
  13643. the scanner. The following items can be given here:
  13644. archive skip trees with the archive tag
  13645. comment skip trees with the COMMENT keyword
  13646. function or Emacs Lisp form:
  13647. will be used as value for `org-agenda-skip-function', so
  13648. whenever the function returns a position, FUNC will not be
  13649. called for that entry and search will continue from the
  13650. position returned
  13651. If your function needs to retrieve the tags including inherited tags
  13652. at the *current* entry, you can use the value of the variable
  13653. `org-scanner-tags' which will be much faster than getting the value
  13654. with `org-get-tags-at'. If your function gets properties with
  13655. `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
  13656. to t around the call to `org-entry-properties' to get the same speedup.
  13657. Note that if your function moves around to retrieve tags and properties at
  13658. a *different* entry, you cannot use these techniques."
  13659. (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
  13660. (not (org-region-active-p)))
  13661. (let* ((org-agenda-archives-mode nil) ; just to make sure
  13662. (org-agenda-skip-archived-trees (memq 'archive skip))
  13663. (org-agenda-skip-comment-trees (memq 'comment skip))
  13664. (org-agenda-skip-function
  13665. (car (org-delete-all '(comment archive) skip)))
  13666. (org-tags-match-list-sublevels t)
  13667. (start-level (eq scope 'region-start-level))
  13668. matcher file res
  13669. org-todo-keywords-for-agenda
  13670. org-done-keywords-for-agenda
  13671. org-todo-keyword-alist-for-agenda
  13672. org-drawers-for-agenda
  13673. org-tag-alist-for-agenda
  13674. todo-only)
  13675. (cond
  13676. ((eq match t) (setq matcher t))
  13677. ((eq match nil) (setq matcher t))
  13678. (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
  13679. (save-window-excursion
  13680. (save-restriction
  13681. (cond ((eq scope 'tree)
  13682. (org-back-to-heading t)
  13683. (org-narrow-to-subtree)
  13684. (setq scope nil))
  13685. ((and (or (eq scope 'region) (eq scope 'region-start-level))
  13686. (org-region-active-p))
  13687. ;; If needed, set start-level to a string like "2"
  13688. (when start-level
  13689. (save-excursion
  13690. (goto-char (region-beginning))
  13691. (unless (org-at-heading-p) (outline-next-heading))
  13692. (setq start-level (org-current-level))))
  13693. (narrow-to-region (region-beginning)
  13694. (save-excursion
  13695. (goto-char (region-end))
  13696. (unless (and (bolp) (org-at-heading-p))
  13697. (outline-next-heading))
  13698. (point)))
  13699. (setq scope nil)))
  13700. (if (not scope)
  13701. (progn
  13702. (org-agenda-prepare-buffers
  13703. (list (buffer-file-name (current-buffer))))
  13704. (setq res (org-scan-tags func matcher todo-only start-level)))
  13705. ;; Get the right scope
  13706. (cond
  13707. ((and scope (listp scope) (symbolp (car scope)))
  13708. (setq scope (eval scope)))
  13709. ((eq scope 'agenda)
  13710. (setq scope (org-agenda-files t)))
  13711. ((eq scope 'agenda-with-archives)
  13712. (setq scope (org-agenda-files t))
  13713. (setq scope (org-add-archive-files scope)))
  13714. ((eq scope 'file)
  13715. (setq scope (list (buffer-file-name))))
  13716. ((eq scope 'file-with-archives)
  13717. (setq scope (org-add-archive-files (list (buffer-file-name))))))
  13718. (org-agenda-prepare-buffers scope)
  13719. (while (setq file (pop scope))
  13720. (with-current-buffer (org-find-base-buffer-visiting file)
  13721. (save-excursion
  13722. (save-restriction
  13723. (widen)
  13724. (goto-char (point-min))
  13725. (setq res (append res (org-scan-tags func matcher todo-only))))))))))
  13726. res)))
  13727. ;;;; Properties
  13728. ;;; Setting and retrieving properties
  13729. (defconst org-special-properties
  13730. '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
  13731. "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM" "CLOCKSUM_T")
  13732. "The special properties valid in Org-mode.
  13733. These are properties that are not defined in the property drawer,
  13734. but in some other way.")
  13735. (defconst org-default-properties
  13736. '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
  13737. "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
  13738. "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
  13739. "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
  13740. "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
  13741. "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
  13742. "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
  13743. "Some properties that are used by Org-mode for various purposes.
  13744. Being in this list makes sure that they are offered for completion.")
  13745. (defconst org-property-start-re "^[ \t]*:PROPERTIES:[ \t]*$"
  13746. "Regular expression matching the first line of a property drawer.")
  13747. (defconst org-property-end-re "^[ \t]*:END:[ \t]*$"
  13748. "Regular expression matching the last line of a property drawer.")
  13749. (defconst org-clock-drawer-start-re "^[ \t]*:CLOCK:[ \t]*$"
  13750. "Regular expression matching the first line of a property drawer.")
  13751. (defconst org-clock-drawer-end-re "^[ \t]*:END:[ \t]*$"
  13752. "Regular expression matching the first line of a property drawer.")
  13753. (defconst org-property-drawer-re
  13754. (concat "\\(" org-property-start-re "\\)[^\000]*?\\("
  13755. org-property-end-re "\\)\n?")
  13756. "Matches an entire property drawer.")
  13757. (defconst org-clock-drawer-re
  13758. (concat "\\(" org-clock-drawer-start-re "\\)[^\000]*?\\("
  13759. org-property-end-re "\\)\n?")
  13760. "Matches an entire clock drawer.")
  13761. (defun org-property-action ()
  13762. "Do an action on properties."
  13763. (interactive)
  13764. (let (c)
  13765. (org-at-property-p)
  13766. (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
  13767. (setq c (read-char-exclusive))
  13768. (cond
  13769. ((equal c ?s)
  13770. (call-interactively 'org-set-property))
  13771. ((equal c ?d)
  13772. (call-interactively 'org-delete-property))
  13773. ((equal c ?D)
  13774. (call-interactively 'org-delete-property-globally))
  13775. ((equal c ?c)
  13776. (call-interactively 'org-compute-property-at-point))
  13777. (t (user-error "No such property action %c" c)))))
  13778. (defun org-inc-effort ()
  13779. "Increment the value of the effort property in the current entry."
  13780. (interactive)
  13781. (org-set-effort nil t))
  13782. (defvar org-clock-effort) ;; Defined in org-clock.el
  13783. (defvar org-clock-current-task) ;; Defined in org-clock.el
  13784. (defun org-set-effort (&optional value increment)
  13785. "Set the effort property of the current entry.
  13786. With numerical prefix arg, use the nth allowed value, 0 stands for the
  13787. 10th allowed value.
  13788. When INCREMENT is non-nil, set the property to the next allowed value."
  13789. (interactive "P")
  13790. (if (equal value 0) (setq value 10))
  13791. (let* ((completion-ignore-case t)
  13792. (prop org-effort-property)
  13793. (cur (org-entry-get nil prop))
  13794. (allowed (org-property-get-allowed-values nil prop 'table))
  13795. (existing (mapcar 'list (org-property-values prop)))
  13796. (heading (nth 4 (org-heading-components)))
  13797. rpl
  13798. (val (cond
  13799. ((stringp value) value)
  13800. ((and allowed (integerp value))
  13801. (or (car (nth (1- value) allowed))
  13802. (car (org-last allowed))))
  13803. ((and allowed increment)
  13804. (or (caadr (member (list cur) allowed))
  13805. (user-error "Allowed effort values are not set")))
  13806. (allowed
  13807. (message "Select 1-9,0, [RET%s]: %s"
  13808. (if cur (concat "=" cur) "")
  13809. (mapconcat 'car allowed " "))
  13810. (setq rpl (read-char-exclusive))
  13811. (if (equal rpl ?\r)
  13812. cur
  13813. (setq rpl (- rpl ?0))
  13814. (if (equal rpl 0) (setq rpl 10))
  13815. (if (and (> rpl 0) (<= rpl (length allowed)))
  13816. (car (nth (1- rpl) allowed))
  13817. (org-completing-read "Effort: " allowed nil))))
  13818. (t
  13819. (let (org-completion-use-ido org-completion-use-iswitchb)
  13820. (org-completing-read
  13821. (concat "Effort " (if (and cur (string-match "\\S-" cur))
  13822. (concat "[" cur "]") "")
  13823. ": ")
  13824. existing nil nil "" nil cur))))))
  13825. (unless (equal (org-entry-get nil prop) val)
  13826. (org-entry-put nil prop val))
  13827. (save-excursion
  13828. (org-back-to-heading t)
  13829. (put-text-property (point-at-bol) (point-at-eol) 'org-effort val))
  13830. (when (string= heading org-clock-current-task)
  13831. (setq org-clock-effort (get-text-property (point-at-bol) 'org-effort))
  13832. (org-clock-update-mode-line))
  13833. (message "%s is now %s" prop val)))
  13834. (defun org-at-property-p ()
  13835. "Is cursor inside a property drawer?"
  13836. (save-excursion
  13837. (when (equal 'node-property (car (org-element-at-point)))
  13838. (beginning-of-line 1)
  13839. (looking-at org-property-re))))
  13840. (defun org-get-property-block (&optional beg end force)
  13841. "Return the (beg . end) range of the body of the property drawer.
  13842. BEG and END are the beginning and end of the current subtree, or of
  13843. the part before the first headline. If they are not given, they will
  13844. be found. If the drawer does not exist and FORCE is non-nil, create
  13845. the drawer."
  13846. (catch 'exit
  13847. (save-excursion
  13848. (let* ((beg (or beg (and (org-before-first-heading-p) (point-min))
  13849. (progn (org-back-to-heading t) (point))))
  13850. (end (or end (and (not (outline-next-heading)) (point-max))
  13851. (point))))
  13852. (goto-char beg)
  13853. (if (re-search-forward org-property-start-re end t)
  13854. (setq beg (1+ (match-end 0)))
  13855. (if force
  13856. (save-excursion
  13857. (org-insert-property-drawer)
  13858. (setq end (progn (outline-next-heading) (point))))
  13859. (throw 'exit nil))
  13860. (goto-char beg)
  13861. (if (re-search-forward org-property-start-re end t)
  13862. (setq beg (1+ (match-end 0)))))
  13863. (if (re-search-forward org-property-end-re end t)
  13864. (setq end (match-beginning 0))
  13865. (or force (throw 'exit nil))
  13866. (goto-char beg)
  13867. (setq end beg)
  13868. (org-indent-line)
  13869. (insert ":END:\n"))
  13870. (cons beg end)))))
  13871. (defun org-entry-properties (&optional pom which specific)
  13872. "Get all properties of the entry at point-or-marker POM.
  13873. This includes the TODO keyword, the tags, time strings for deadline,
  13874. scheduled, and clocking, and any additional properties defined in the
  13875. entry. The return value is an alist, keys may occur multiple times
  13876. if the property key was used several times.
  13877. POM may also be nil, in which case the current entry is used.
  13878. If WHICH is nil or `all', get all properties. If WHICH is
  13879. `special' or `standard', only get that subclass. If WHICH
  13880. is a string only get exactly this property. SPECIFIC can be a string, the
  13881. specific property we are interested in. Specifying it can speed
  13882. things up because then unnecessary parsing is avoided."
  13883. (setq which (or which 'all))
  13884. (org-with-point-at pom
  13885. (let ((clockstr (substring org-clock-string 0 -1))
  13886. (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
  13887. (case-fold-search nil)
  13888. beg end range props sum-props key key1 value string clocksum clocksumt)
  13889. (save-excursion
  13890. (when (condition-case nil
  13891. (and (derived-mode-p 'org-mode) (org-back-to-heading t))
  13892. (error nil))
  13893. (setq beg (point))
  13894. (setq sum-props (get-text-property (point) 'org-summaries))
  13895. (setq clocksum (get-text-property (point) :org-clock-minutes)
  13896. clocksumt (get-text-property (point) :org-clock-minutes-today))
  13897. (outline-next-heading)
  13898. (setq end (point))
  13899. (when (memq which '(all special))
  13900. ;; Get the special properties, like TODO and tags
  13901. (goto-char beg)
  13902. (when (and (or (not specific) (string= specific "TODO"))
  13903. (looking-at org-todo-line-regexp) (match-end 2))
  13904. (push (cons "TODO" (org-match-string-no-properties 2)) props))
  13905. (when (and (or (not specific) (string= specific "PRIORITY"))
  13906. (looking-at org-priority-regexp))
  13907. (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
  13908. (when (or (not specific) (string= specific "FILE"))
  13909. (push (cons "FILE" buffer-file-name) props))
  13910. (when (and (or (not specific) (string= specific "TAGS"))
  13911. (setq value (org-get-tags-string))
  13912. (string-match "\\S-" value))
  13913. (push (cons "TAGS" value) props))
  13914. (when (and (or (not specific) (string= specific "ALLTAGS"))
  13915. (setq value (org-get-tags-at)))
  13916. (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
  13917. ":"))
  13918. props))
  13919. (when (or (not specific) (string= specific "BLOCKED"))
  13920. (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
  13921. (when (or (not specific)
  13922. (member specific
  13923. '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
  13924. "TIMESTAMP" "TIMESTAMP_IA")))
  13925. (catch 'match
  13926. (while (re-search-forward org-maybe-keyword-time-regexp end t)
  13927. (setq key (if (match-end 1)
  13928. (substring (org-match-string-no-properties 1)
  13929. 0 -1))
  13930. string (if (equal key clockstr)
  13931. (org-trim
  13932. (buffer-substring-no-properties
  13933. (match-beginning 3) (goto-char
  13934. (point-at-eol))))
  13935. (substring (org-match-string-no-properties 3)
  13936. 1 -1)))
  13937. ;; Get the correct property name from the key. This is
  13938. ;; necessary if the user has configured time keywords.
  13939. (setq key1 (concat key ":"))
  13940. (cond
  13941. ((not key)
  13942. (setq key
  13943. (if (= (char-after (match-beginning 3)) ?\[)
  13944. "TIMESTAMP_IA" "TIMESTAMP")))
  13945. ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
  13946. ((equal key1 org-deadline-string) (setq key "DEADLINE"))
  13947. ((equal key1 org-closed-string) (setq key "CLOSED"))
  13948. ((equal key1 org-clock-string) (setq key "CLOCK")))
  13949. (if (and specific (equal key specific) (not (equal key "CLOCK")))
  13950. (progn
  13951. (push (cons key string) props)
  13952. ;; no need to search further if match is found
  13953. (throw 'match t))
  13954. (when (or (equal key "CLOCK") (not (assoc key props)))
  13955. (push (cons key string) props)))))))
  13956. (when (memq which '(all standard))
  13957. ;; Get the standard properties, like :PROP: ...
  13958. (setq range (org-get-property-block beg end))
  13959. (when range
  13960. (goto-char (car range))
  13961. (while (re-search-forward org-property-re
  13962. (cdr range) t)
  13963. (setq key (org-match-string-no-properties 2)
  13964. value (org-trim (or (org-match-string-no-properties 3) "")))
  13965. (unless (member key excluded)
  13966. (push (cons key (or value "")) props)))))
  13967. (if clocksum
  13968. (push (cons "CLOCKSUM"
  13969. (org-columns-number-to-string (/ (float clocksum) 60.)
  13970. 'add_times))
  13971. props))
  13972. (if clocksumt
  13973. (push (cons "CLOCKSUM_T"
  13974. (org-columns-number-to-string (/ (float clocksumt) 60.)
  13975. 'add_times))
  13976. props))
  13977. (unless (assoc "CATEGORY" props)
  13978. (push (cons "CATEGORY" (org-get-category)) props))
  13979. (append sum-props (nreverse props)))))))
  13980. (defun org-entry-get (pom property &optional inherit literal-nil)
  13981. "Get value of PROPERTY for entry or content at point-or-marker POM.
  13982. If INHERIT is non-nil and the entry does not have the property,
  13983. then also check higher levels of the hierarchy.
  13984. If INHERIT is the symbol `selective', use inheritance only if the setting
  13985. in `org-use-property-inheritance' selects PROPERTY for inheritance.
  13986. If the property is present but empty, the return value is the empty string.
  13987. If the property is not present at all, nil is returned.
  13988. If LITERAL-NIL is set, return the string value \"nil\" as a string,
  13989. do not interpret it as the list atom nil. This is used for inheritance
  13990. when a \"nil\" value can supersede a non-nil value higher up the hierarchy."
  13991. (org-with-point-at pom
  13992. (if (and inherit (if (eq inherit 'selective)
  13993. (org-property-inherit-p property)
  13994. t))
  13995. (org-entry-get-with-inheritance property literal-nil)
  13996. (if (member property org-special-properties)
  13997. ;; We need a special property. Use `org-entry-properties' to
  13998. ;; retrieve it, but specify the wanted property
  13999. (cdr (assoc property (org-entry-properties nil 'special property)))
  14000. (let ((range (org-get-property-block)))
  14001. (when (and range (not (eq (car range) (cdr range))))
  14002. (let* ((props (list (or (assoc property org-file-properties)
  14003. (assoc property org-global-properties)
  14004. (assoc property org-global-properties-fixed))))
  14005. (ap (lambda (key)
  14006. (when (re-search-forward
  14007. (org-re-property key) (cdr range) t)
  14008. (setq props
  14009. (org-update-property-plist
  14010. key
  14011. (if (match-end 3)
  14012. (org-match-string-no-properties 3) "")
  14013. props)))))
  14014. val)
  14015. (goto-char (car range))
  14016. (funcall ap property)
  14017. (goto-char (car range))
  14018. (while (funcall ap (concat property "+")))
  14019. (setq val (cdr (assoc property props)))
  14020. (when val (if literal-nil val (org-not-nil val))))))))))
  14021. (defun org-property-or-variable-value (var &optional inherit)
  14022. "Check if there is a property fixing the value of VAR.
  14023. If yes, return this value. If not, return the current value of the variable."
  14024. (let ((prop (org-entry-get nil (symbol-name var) inherit)))
  14025. (if (and prop (stringp prop) (string-match "\\S-" prop))
  14026. (read prop)
  14027. (symbol-value var))))
  14028. (defun org-entry-delete (pom property &optional delete-empty-drawer)
  14029. "Delete the property PROPERTY from entry at point-or-marker POM.
  14030. When optional argument DELETE-EMPTY-DRAWER is a string, it defines
  14031. an empty drawer to delete."
  14032. (org-with-point-at pom
  14033. (if (member property org-special-properties)
  14034. nil ; cannot delete these properties.
  14035. (let ((range (org-get-property-block)))
  14036. (if (and range
  14037. (goto-char (car range))
  14038. (re-search-forward
  14039. (org-re-property property)
  14040. (cdr range) t))
  14041. (progn
  14042. (delete-region (match-beginning 0) (1+ (point-at-eol)))
  14043. (and delete-empty-drawer
  14044. (org-remove-empty-drawer-at
  14045. delete-empty-drawer (car range)))
  14046. t)
  14047. nil)))))
  14048. ;; Multi-values properties are properties that contain multiple values
  14049. ;; These values are assumed to be single words, separated by whitespace.
  14050. (defun org-entry-add-to-multivalued-property (pom property value)
  14051. "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
  14052. (let* ((old (org-entry-get pom property))
  14053. (values (and old (org-split-string old "[ \t]"))))
  14054. (setq value (org-entry-protect-space value))
  14055. (unless (member value values)
  14056. (setq values (append values (list value)))
  14057. (org-entry-put pom property
  14058. (mapconcat 'identity values " ")))))
  14059. (defun org-entry-remove-from-multivalued-property (pom property value)
  14060. "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
  14061. (let* ((old (org-entry-get pom property))
  14062. (values (and old (org-split-string old "[ \t]"))))
  14063. (setq value (org-entry-protect-space value))
  14064. (when (member value values)
  14065. (setq values (delete value values))
  14066. (org-entry-put pom property
  14067. (mapconcat 'identity values " ")))))
  14068. (defun org-entry-member-in-multivalued-property (pom property value)
  14069. "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
  14070. (let* ((old (org-entry-get pom property))
  14071. (values (and old (org-split-string old "[ \t]"))))
  14072. (setq value (org-entry-protect-space value))
  14073. (member value values)))
  14074. (defun org-entry-get-multivalued-property (pom property)
  14075. "Return a list of values in a multivalued property."
  14076. (let* ((value (org-entry-get pom property))
  14077. (values (and value (org-split-string value "[ \t]"))))
  14078. (mapcar 'org-entry-restore-space values)))
  14079. (defun org-entry-put-multivalued-property (pom property &rest values)
  14080. "Set multivalued PROPERTY at point-or-marker POM to VALUES.
  14081. VALUES should be a list of strings. Spaces will be protected."
  14082. (org-entry-put pom property
  14083. (mapconcat 'org-entry-protect-space values " "))
  14084. (let* ((value (org-entry-get pom property))
  14085. (values (and value (org-split-string value "[ \t]"))))
  14086. (mapcar 'org-entry-restore-space values)))
  14087. (defun org-entry-protect-space (s)
  14088. "Protect spaces and newline in string S."
  14089. (while (string-match " " s)
  14090. (setq s (replace-match "%20" t t s)))
  14091. (while (string-match "\n" s)
  14092. (setq s (replace-match "%0A" t t s)))
  14093. s)
  14094. (defun org-entry-restore-space (s)
  14095. "Restore spaces and newline in string S."
  14096. (while (string-match "%20" s)
  14097. (setq s (replace-match " " t t s)))
  14098. (while (string-match "%0A" s)
  14099. (setq s (replace-match "\n" t t s)))
  14100. s)
  14101. (defvar org-entry-property-inherited-from (make-marker)
  14102. "Marker pointing to the entry from where a property was inherited.
  14103. Each call to `org-entry-get-with-inheritance' will set this marker to the
  14104. location of the entry where the inheritance search matched. If there was
  14105. no match, the marker will point nowhere.
  14106. Note that also `org-entry-get' calls this function, if the INHERIT flag
  14107. is set.")
  14108. (defun org-entry-get-with-inheritance (property &optional literal-nil)
  14109. "Get PROPERTY of entry or content at point, search higher levels if needed.
  14110. The search will stop at the first ancestor which has the property defined.
  14111. If the value found is \"nil\", return nil to show that the property
  14112. should be considered as undefined (this is the meaning of nil here).
  14113. However, if LITERAL-NIL is set, return the string value \"nil\" instead."
  14114. (move-marker org-entry-property-inherited-from nil)
  14115. (let (tmp)
  14116. (save-excursion
  14117. (save-restriction
  14118. (widen)
  14119. (catch 'ex
  14120. (while t
  14121. (when (setq tmp (org-entry-get nil property nil 'literal-nil))
  14122. (or (ignore-errors (org-back-to-heading t))
  14123. (goto-char (point-min)))
  14124. (move-marker org-entry-property-inherited-from (point))
  14125. (throw 'ex tmp))
  14126. (or (ignore-errors (org-up-heading-safe))
  14127. (throw 'ex nil))))))
  14128. (setq tmp (or tmp
  14129. (cdr (assoc property org-file-properties))
  14130. (cdr (assoc property org-global-properties))
  14131. (cdr (assoc property org-global-properties-fixed))))
  14132. (if literal-nil tmp (org-not-nil tmp))))
  14133. (defvar org-property-changed-functions nil
  14134. "Hook called when the value of a property has changed.
  14135. Each hook function should accept two arguments, the name of the property
  14136. and the new value.")
  14137. (defun org-entry-put (pom property value)
  14138. "Set PROPERTY to VALUE for entry at point-or-marker POM."
  14139. (org-with-point-at pom
  14140. (org-back-to-heading t)
  14141. (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
  14142. range)
  14143. (cond
  14144. ((equal property "TODO")
  14145. (when (and (stringp value) (string-match "\\S-" value)
  14146. (not (member value org-todo-keywords-1)))
  14147. (user-error "\"%s\" is not a valid TODO state" value))
  14148. (if (or (not value)
  14149. (not (string-match "\\S-" value)))
  14150. (setq value 'none))
  14151. (org-todo value)
  14152. (org-set-tags nil 'align))
  14153. ((equal property "PRIORITY")
  14154. (org-priority (if (and value (stringp value) (string-match "\\S-" value))
  14155. (string-to-char value) ?\ ))
  14156. (org-set-tags nil 'align))
  14157. ((equal property "CLOCKSUM")
  14158. (if (not (re-search-forward
  14159. (concat org-clock-string ".*\\]--\\(\\[[^]]+\\]\\)") nil t))
  14160. (error "Cannot find a clock log")
  14161. (goto-char (- (match-end 1) 2))
  14162. (cond
  14163. ((eq value 'earlier) (org-timestamp-down))
  14164. ((eq value 'later) (org-timestamp-up)))
  14165. (org-clock-sum-current-item)))
  14166. ((equal property "SCHEDULED")
  14167. (if (re-search-forward org-scheduled-time-regexp end t)
  14168. (cond
  14169. ((eq value 'earlier) (org-timestamp-change -1 'day))
  14170. ((eq value 'later) (org-timestamp-change 1 'day))
  14171. (t (call-interactively 'org-schedule)))
  14172. (call-interactively 'org-schedule)))
  14173. ((equal property "DEADLINE")
  14174. (if (re-search-forward org-deadline-time-regexp end t)
  14175. (cond
  14176. ((eq value 'earlier) (org-timestamp-change -1 'day))
  14177. ((eq value 'later) (org-timestamp-change 1 'day))
  14178. (t (call-interactively 'org-deadline)))
  14179. (call-interactively 'org-deadline)))
  14180. ((member property org-special-properties)
  14181. (error "The %s property can not yet be set with `org-entry-put'"
  14182. property))
  14183. (t ; a non-special property
  14184. (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
  14185. (setq range (org-get-property-block beg end 'force))
  14186. (goto-char (car range))
  14187. (if (re-search-forward
  14188. (org-re-property property) (cdr range) t)
  14189. (progn
  14190. (delete-region (match-beginning 0) (match-end 0))
  14191. (goto-char (match-beginning 0)))
  14192. (goto-char (cdr range))
  14193. (insert "\n")
  14194. (backward-char 1)
  14195. (org-indent-line))
  14196. (insert ":" property ":")
  14197. (and value (insert " " value))
  14198. (org-indent-line)))))
  14199. (run-hook-with-args 'org-property-changed-functions property value)))
  14200. (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
  14201. "Get all property keys in the current buffer.
  14202. With INCLUDE-SPECIALS, also list the special properties that reflect things
  14203. like tags and TODO state.
  14204. With INCLUDE-DEFAULTS, also include properties that has special meaning
  14205. internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
  14206. and others.
  14207. With INCLUDE-COLUMNS, also include property names given in COLUMN
  14208. formats in the current buffer."
  14209. (let (rtn range cfmt s p)
  14210. (save-excursion
  14211. (save-restriction
  14212. (widen)
  14213. (goto-char (point-min))
  14214. (while (re-search-forward org-property-start-re nil t)
  14215. (setq range (org-get-property-block))
  14216. (goto-char (car range))
  14217. (while (re-search-forward org-property-re
  14218. (cdr range) t)
  14219. (add-to-list 'rtn (org-match-string-no-properties 2)))
  14220. (outline-next-heading))))
  14221. (when include-specials
  14222. (setq rtn (append org-special-properties rtn)))
  14223. (when include-defaults
  14224. (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
  14225. (add-to-list 'rtn org-effort-property))
  14226. (when include-columns
  14227. (save-excursion
  14228. (save-restriction
  14229. (widen)
  14230. (goto-char (point-min))
  14231. (while (re-search-forward
  14232. "^\\(#\\+COLUMNS:\\|[ \t]*:COLUMNS:\\)[ \t]*\\(.*\\)"
  14233. nil t)
  14234. (setq cfmt (match-string 2) s 0)
  14235. (while (string-match (org-re "%[0-9]*\\([-[:alnum:]_]+\\)")
  14236. cfmt s)
  14237. (setq s (match-end 0)
  14238. p (match-string 1 cfmt))
  14239. (unless (or (equal p "ITEM")
  14240. (member p org-special-properties))
  14241. (add-to-list 'rtn (match-string 1 cfmt))))))))
  14242. (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
  14243. (defun org-property-values (key)
  14244. "Return a list of all values of property KEY in the current buffer."
  14245. (save-excursion
  14246. (save-restriction
  14247. (widen)
  14248. (goto-char (point-min))
  14249. (let ((re (org-re-property key))
  14250. values)
  14251. (while (re-search-forward re nil t)
  14252. (add-to-list 'values (org-trim (match-string 3))))
  14253. (delete "" values)))))
  14254. (defun org-insert-property-drawer ()
  14255. "Insert a property drawer into the current entry."
  14256. (org-back-to-heading t)
  14257. (looking-at org-outline-regexp)
  14258. (let ((indent (if org-adapt-indentation
  14259. (- (match-end 0) (match-beginning 0))
  14260. 0))
  14261. (beg (point))
  14262. (re (concat "^[ \t]*" org-keyword-time-regexp))
  14263. end hiddenp)
  14264. (outline-next-heading)
  14265. (setq end (point))
  14266. (goto-char beg)
  14267. (while (re-search-forward re end t))
  14268. (setq hiddenp (outline-invisible-p))
  14269. (end-of-line 1)
  14270. (and (equal (char-after) ?\n) (forward-char 1))
  14271. (while (looking-at "^[ \t]*\\(:CLOCK:\\|:LOGBOOK:\\|CLOCK:\\|:END:\\)")
  14272. (if (member (match-string 1) '("CLOCK:" ":END:"))
  14273. ;; just skip this line
  14274. (beginning-of-line 2)
  14275. ;; Drawer start, find the end
  14276. (re-search-forward "^\\*+ \\|^[ \t]*:END:" nil t)
  14277. (beginning-of-line 1)))
  14278. (org-skip-over-state-notes)
  14279. (skip-chars-backward " \t\n\r")
  14280. (if (and (eq (char-before) ?*) (not (eq (char-after) ?\n)))
  14281. (forward-char 1))
  14282. (goto-char (point-at-eol))
  14283. (let ((inhibit-read-only t)) (insert "\n:PROPERTIES:\n:END:"))
  14284. (beginning-of-line 0)
  14285. (org-indent-to-column indent)
  14286. (beginning-of-line 2)
  14287. (org-indent-to-column indent)
  14288. (beginning-of-line 0)
  14289. (if hiddenp
  14290. (save-excursion
  14291. (org-back-to-heading t)
  14292. (hide-entry))
  14293. (org-flag-drawer t))))
  14294. (defun org-insert-drawer (&optional arg drawer)
  14295. "Insert a drawer at point.
  14296. Optional argument DRAWER, when non-nil, is a string representing
  14297. drawer's name. Otherwise, the user is prompted for a name.
  14298. If a region is active, insert the drawer around that region
  14299. instead.
  14300. Point is left between drawer's boundaries."
  14301. (interactive "P")
  14302. (let* ((logbook (if (stringp org-log-into-drawer) org-log-into-drawer
  14303. "LOGBOOK"))
  14304. ;; SYSTEM-DRAWERS is a list of drawer names that are used
  14305. ;; internally by Org. They are meant to be inserted
  14306. ;; automatically.
  14307. (system-drawers `("CLOCK" ,logbook "PROPERTIES"))
  14308. ;; Remove system drawers from list. Note: For some reason,
  14309. ;; `org-completing-read' ignores the predicate while
  14310. ;; `completing-read' handles it fine.
  14311. (drawer (if arg "PROPERTIES"
  14312. (or drawer
  14313. (completing-read
  14314. "Drawer: " org-drawers
  14315. (lambda (d) (not (member d system-drawers))))))))
  14316. (cond
  14317. ;; With C-u, fall back on `org-insert-property-drawer'
  14318. (arg (org-insert-property-drawer))
  14319. ;; With an active region, insert a drawer at point.
  14320. ((not (org-region-active-p))
  14321. (progn
  14322. (unless (bolp) (insert "\n"))
  14323. (insert (format ":%s:\n\n:END:\n" drawer))
  14324. (forward-line -2)))
  14325. ;; Otherwise, insert the drawer at point
  14326. (t
  14327. (let ((rbeg (region-beginning))
  14328. (rend (copy-marker (region-end))))
  14329. (unwind-protect
  14330. (progn
  14331. (goto-char rbeg)
  14332. (beginning-of-line)
  14333. (when (save-excursion
  14334. (re-search-forward org-outline-regexp-bol rend t))
  14335. (user-error "Drawers cannot contain headlines"))
  14336. ;; Position point at the beginning of the first
  14337. ;; non-blank line in region. Insert drawer's opening
  14338. ;; there, then indent it.
  14339. (org-skip-whitespace)
  14340. (beginning-of-line)
  14341. (insert ":" drawer ":\n")
  14342. (forward-line -1)
  14343. (indent-for-tab-command)
  14344. ;; Move point to the beginning of the first blank line
  14345. ;; after the last non-blank line in region. Insert
  14346. ;; drawer's closing, then indent it.
  14347. (goto-char rend)
  14348. (skip-chars-backward " \r\t\n")
  14349. (insert "\n:END:")
  14350. (deactivate-mark t)
  14351. (indent-for-tab-command)
  14352. (unless (eolp) (insert "\n")))
  14353. ;; Clear marker, whatever the outcome of insertion is.
  14354. (set-marker rend nil)))))))
  14355. (defvar org-property-set-functions-alist nil
  14356. "Property set function alist.
  14357. Each entry should have the following format:
  14358. (PROPERTY . READ-FUNCTION)
  14359. The read function will be called with the same argument as
  14360. `org-completing-read'.")
  14361. (defun org-set-property-function (property)
  14362. "Get the function that should be used to set PROPERTY.
  14363. This is computed according to `org-property-set-functions-alist'."
  14364. (or (cdr (assoc property org-property-set-functions-alist))
  14365. 'org-completing-read))
  14366. (defun org-read-property-value (property)
  14367. "Read PROPERTY value from user."
  14368. (let* ((completion-ignore-case t)
  14369. (allowed (org-property-get-allowed-values nil property 'table))
  14370. (cur (org-entry-get nil property))
  14371. (prompt (concat property " value"
  14372. (if (and cur (string-match "\\S-" cur))
  14373. (concat " [" cur "]") "") ": "))
  14374. (set-function (org-set-property-function property))
  14375. (val (if allowed
  14376. (funcall set-function prompt allowed nil
  14377. (not (get-text-property 0 'org-unrestricted
  14378. (caar allowed))))
  14379. (let (org-completion-use-ido org-completion-use-iswitchb)
  14380. (funcall set-function prompt
  14381. (mapcar 'list (org-property-values property))
  14382. nil nil "" nil cur)))))
  14383. (if (equal val "")
  14384. cur
  14385. val)))
  14386. (defvar org-last-set-property nil)
  14387. (defvar org-last-set-property-value nil)
  14388. (defun org-read-property-name ()
  14389. "Read a property name."
  14390. (let* ((completion-ignore-case t)
  14391. (keys (org-buffer-property-keys nil t t))
  14392. (default-prop (or (save-excursion
  14393. (save-match-data
  14394. (beginning-of-line)
  14395. (and (looking-at "^\\s-*:\\([^:\n]+\\):")
  14396. (null (string= (match-string 1) "END"))
  14397. (match-string 1))))
  14398. org-last-set-property))
  14399. (property (org-icompleting-read
  14400. (concat "Property"
  14401. (if default-prop (concat " [" default-prop "]") "")
  14402. ": ")
  14403. (mapcar 'list keys)
  14404. nil nil nil nil
  14405. default-prop)))
  14406. (if (member property keys)
  14407. property
  14408. (or (cdr (assoc (downcase property)
  14409. (mapcar (lambda (x) (cons (downcase x) x))
  14410. keys)))
  14411. property))))
  14412. (defun org-set-property-and-value (use-last)
  14413. "Allow to set [PROPERTY]: [value] direction from prompt.
  14414. When use-default, don't even ask, just use the last
  14415. \"[PROPERTY]: [value]\" string from the history."
  14416. (interactive "P")
  14417. (let* ((completion-ignore-case t)
  14418. (pv (or (and use-last org-last-set-property-value)
  14419. (org-completing-read
  14420. "Enter a \"[Property]: [value]\" pair: "
  14421. nil nil nil nil nil
  14422. org-last-set-property-value)))
  14423. prop val)
  14424. (when (string-match "^[ \t]*\\([^:]+\\):[ \t]*\\(.*\\)[ \t]*$" pv)
  14425. (setq prop (match-string 1 pv)
  14426. val (match-string 2 pv))
  14427. (org-set-property prop val))))
  14428. (defun org-set-property (property value)
  14429. "In the current entry, set PROPERTY to VALUE.
  14430. When called interactively, this will prompt for a property name, offering
  14431. completion on existing and default properties. And then it will prompt
  14432. for a value, offering completion either on allowed values (via an inherited
  14433. xxx_ALL property) or on existing values in other instances of this property
  14434. in the current file."
  14435. (interactive (list nil nil))
  14436. (let* ((property (or property (org-read-property-name)))
  14437. (value (or value (org-read-property-value property)))
  14438. (fn (cdr (assoc property org-properties-postprocess-alist))))
  14439. (setq org-last-set-property property)
  14440. (setq org-last-set-property-value (concat property ": " value))
  14441. ;; Possibly postprocess the inserted value:
  14442. (when fn (setq value (funcall fn value)))
  14443. (unless (equal (org-entry-get nil property) value)
  14444. (org-entry-put nil property value))))
  14445. (defun org-delete-property (property &optional delete-empty-drawer)
  14446. "In the current entry, delete PROPERTY.
  14447. When optional argument DELETE-EMPTY-DRAWER is a string, it defines
  14448. an empty drawer to delete."
  14449. (interactive
  14450. (let* ((completion-ignore-case t)
  14451. (prop (org-icompleting-read "Property: "
  14452. (org-entry-properties nil 'standard))))
  14453. (list prop)))
  14454. (message "Property %s %s" property
  14455. (if (org-entry-delete nil property delete-empty-drawer)
  14456. "deleted"
  14457. "was not present in the entry")))
  14458. (defun org-delete-property-globally (property)
  14459. "Remove PROPERTY globally, from all entries."
  14460. (interactive
  14461. (let* ((completion-ignore-case t)
  14462. (prop (org-icompleting-read
  14463. "Globally remove property: "
  14464. (mapcar 'list (org-buffer-property-keys)))))
  14465. (list prop)))
  14466. (save-excursion
  14467. (save-restriction
  14468. (widen)
  14469. (goto-char (point-min))
  14470. (let ((cnt 0))
  14471. (while (re-search-forward
  14472. (org-re-property property)
  14473. nil t)
  14474. (setq cnt (1+ cnt))
  14475. (delete-region (match-beginning 0) (1+ (point-at-eol))))
  14476. (message "Property \"%s\" removed from %d entries" property cnt)))))
  14477. (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
  14478. (defun org-compute-property-at-point ()
  14479. "Compute the property at point.
  14480. This looks for an enclosing column format, extracts the operator and
  14481. then applies it to the property in the column format's scope."
  14482. (interactive)
  14483. (unless (org-at-property-p)
  14484. (user-error "Not at a property"))
  14485. (let ((prop (org-match-string-no-properties 2)))
  14486. (org-columns-get-format-and-top-level)
  14487. (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
  14488. (user-error "No operator defined for property %s" prop))
  14489. (org-columns-compute prop)))
  14490. (defvar org-property-allowed-value-functions nil
  14491. "Hook for functions supplying allowed values for a specific property.
  14492. The functions must take a single argument, the name of the property, and
  14493. return a flat list of allowed values. If \":ETC\" is one of
  14494. the values, this means that these values are intended as defaults for
  14495. completion, but that other values should be allowed too.
  14496. The functions must return nil if they are not responsible for this
  14497. property.")
  14498. (defun org-property-get-allowed-values (pom property &optional table)
  14499. "Get allowed values for the property PROPERTY.
  14500. When TABLE is non-nil, return an alist that can directly be used for
  14501. completion."
  14502. (let (vals)
  14503. (cond
  14504. ((equal property "TODO")
  14505. (setq vals (org-with-point-at pom
  14506. (append org-todo-keywords-1 '("")))))
  14507. ((equal property "PRIORITY")
  14508. (let ((n org-lowest-priority))
  14509. (while (>= n org-highest-priority)
  14510. (push (char-to-string n) vals)
  14511. (setq n (1- n)))))
  14512. ((member property org-special-properties))
  14513. ((setq vals (run-hook-with-args-until-success
  14514. 'org-property-allowed-value-functions property)))
  14515. (t
  14516. (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
  14517. (when (and vals (string-match "\\S-" vals))
  14518. (setq vals (car (read-from-string (concat "(" vals ")"))))
  14519. (setq vals (mapcar (lambda (x)
  14520. (cond ((stringp x) x)
  14521. ((numberp x) (number-to-string x))
  14522. ((symbolp x) (symbol-name x))
  14523. (t "???")))
  14524. vals)))))
  14525. (when (member ":ETC" vals)
  14526. (setq vals (remove ":ETC" vals))
  14527. (org-add-props (car vals) '(org-unrestricted t)))
  14528. (if table (mapcar 'list vals) vals)))
  14529. (defun org-property-previous-allowed-value (&optional previous)
  14530. "Switch to the next allowed value for this property."
  14531. (interactive)
  14532. (org-property-next-allowed-value t))
  14533. (defun org-property-next-allowed-value (&optional previous)
  14534. "Switch to the next allowed value for this property."
  14535. (interactive)
  14536. (unless (org-at-property-p)
  14537. (user-error "Not at a property"))
  14538. (let* ((prop (car (save-match-data (org-split-string (match-string 1) ":"))))
  14539. (key (match-string 2))
  14540. (value (match-string 3))
  14541. (allowed (or (org-property-get-allowed-values (point) key)
  14542. (and (member value '("[ ]" "[-]" "[X]"))
  14543. '("[ ]" "[X]"))))
  14544. (heading (save-match-data (nth 4 (org-heading-components))))
  14545. nval)
  14546. (unless allowed
  14547. (user-error "Allowed values for this property have not been defined"))
  14548. (if previous (setq allowed (reverse allowed)))
  14549. (if (member value allowed)
  14550. (setq nval (car (cdr (member value allowed)))))
  14551. (setq nval (or nval (car allowed)))
  14552. (if (equal nval value)
  14553. (user-error "Only one allowed value for this property"))
  14554. (org-at-property-p)
  14555. (replace-match (concat " :" key ": " nval) t t)
  14556. (org-indent-line)
  14557. (beginning-of-line 1)
  14558. (skip-chars-forward " \t")
  14559. (when (equal prop org-effort-property)
  14560. (save-excursion
  14561. (org-back-to-heading t)
  14562. (put-text-property (point-at-bol) (point-at-eol) 'org-effort nval))
  14563. (when (string= org-clock-current-task heading)
  14564. (setq org-clock-effort nval)
  14565. (org-clock-update-mode-line)))
  14566. (run-hook-with-args 'org-property-changed-functions key nval)))
  14567. (defun org-find-olp (path &optional this-buffer)
  14568. "Return a marker pointing to the entry at outline path OLP.
  14569. If anything goes wrong, throw an error.
  14570. You can wrap this call to catch the error like this:
  14571. (condition-case msg
  14572. (org-mobile-locate-entry (match-string 4))
  14573. (error (nth 1 msg)))
  14574. The return value will then be either a string with the error message,
  14575. or a marker if everything is OK.
  14576. If THIS-BUFFER is set, the outline path does not contain a file,
  14577. only headings."
  14578. (let* ((file (if this-buffer buffer-file-name (pop path)))
  14579. (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
  14580. (level 1)
  14581. (lmin 1)
  14582. (lmax 1)
  14583. limit re end found pos heading cnt flevel)
  14584. (unless buffer (error "File not found :%s" file))
  14585. (with-current-buffer buffer
  14586. (save-excursion
  14587. (save-restriction
  14588. (widen)
  14589. (setq limit (point-max))
  14590. (goto-char (point-min))
  14591. (while (setq heading (pop path))
  14592. (setq re (format org-complex-heading-regexp-format
  14593. (regexp-quote heading)))
  14594. (setq cnt 0 pos (point))
  14595. (while (re-search-forward re end t)
  14596. (setq level (- (match-end 1) (match-beginning 1)))
  14597. (if (and (>= level lmin) (<= level lmax))
  14598. (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
  14599. (when (= cnt 0) (error "Heading not found on level %d: %s"
  14600. lmax heading))
  14601. (when (> cnt 1) (error "Heading not unique on level %d: %s"
  14602. lmax heading))
  14603. (goto-char found)
  14604. (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
  14605. (setq end (save-excursion (org-end-of-subtree t t))))
  14606. (when (org-at-heading-p)
  14607. (point-marker)))))))
  14608. (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
  14609. "Find node HEADING in BUFFER.
  14610. Return a marker to the heading if it was found, or nil if not.
  14611. If POS-ONLY is set, return just the position instead of a marker.
  14612. The heading text must match exact, but it may have a TODO keyword,
  14613. a priority cookie and tags in the standard locations."
  14614. (with-current-buffer (or buffer (current-buffer))
  14615. (save-excursion
  14616. (save-restriction
  14617. (widen)
  14618. (goto-char (point-min))
  14619. (let (case-fold-search)
  14620. (if (re-search-forward
  14621. (format org-complex-heading-regexp-format
  14622. (regexp-quote heading)) nil t)
  14623. (if pos-only
  14624. (match-beginning 0)
  14625. (move-marker (make-marker) (match-beginning 0)))))))))
  14626. (defun org-find-exact-heading-in-directory (heading &optional dir)
  14627. "Find Org node headline HEADING in all .org files in directory DIR.
  14628. When the target headline is found, return a marker to this location."
  14629. (let ((files (directory-files (or dir default-directory)
  14630. nil "\\`[^.#].*\\.org\\'"))
  14631. file visiting m buffer)
  14632. (catch 'found
  14633. (while (setq file (pop files))
  14634. (message "trying %s" file)
  14635. (setq visiting (org-find-base-buffer-visiting file))
  14636. (setq buffer (or visiting (find-file-noselect file)))
  14637. (setq m (org-find-exact-headline-in-buffer
  14638. heading buffer))
  14639. (when (and (not m) (not visiting)) (kill-buffer buffer))
  14640. (and m (throw 'found m))))))
  14641. (defun org-find-entry-with-id (ident)
  14642. "Locate the entry that contains the ID property with exact value IDENT.
  14643. IDENT can be a string, a symbol or a number, this function will search for
  14644. the string representation of it.
  14645. Return the position where this entry starts, or nil if there is no such entry."
  14646. (interactive "sID: ")
  14647. (let ((id (cond
  14648. ((stringp ident) ident)
  14649. ((symbol-name ident) (symbol-name ident))
  14650. ((numberp ident) (number-to-string ident))
  14651. (t (error "IDENT %s must be a string, symbol or number" ident))))
  14652. (case-fold-search nil))
  14653. (save-excursion
  14654. (save-restriction
  14655. (widen)
  14656. (goto-char (point-min))
  14657. (when (re-search-forward
  14658. (concat "^[ \t]*:ID:[ \t]+" (regexp-quote id) "[ \t]*$")
  14659. nil t)
  14660. (org-back-to-heading t)
  14661. (point))))))
  14662. ;;;; Timestamps
  14663. (defvar org-last-changed-timestamp nil)
  14664. (defvar org-last-inserted-timestamp nil
  14665. "The last time stamp inserted with `org-insert-time-stamp'.")
  14666. (defvar org-time-was-given) ; dynamically scoped parameter
  14667. (defvar org-end-time-was-given) ; dynamically scoped parameter
  14668. (defvar org-ts-what) ; dynamically scoped parameter
  14669. (defun org-time-stamp (arg &optional inactive)
  14670. "Prompt for a date/time and insert a time stamp.
  14671. If the user specifies a time like HH:MM or if this command is
  14672. called with at least one prefix argument, the time stamp contains
  14673. the date and the time. Otherwise, only the date is be included.
  14674. All parts of a date not specified by the user is filled in from
  14675. the current date/time. So if you just press return without
  14676. typing anything, the time stamp will represent the current
  14677. date/time.
  14678. If there is already a timestamp at the cursor, it will be
  14679. modified.
  14680. With two universal prefix arguments, insert an active timestamp
  14681. with the current time without prompting the user.
  14682. When called from lisp, the timestamp is inactive if INACTIVE is
  14683. non-nil."
  14684. (interactive "P")
  14685. (let* ((ts nil)
  14686. (default-time
  14687. ;; Default time is either today, or, when entering a range,
  14688. ;; the range start.
  14689. (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
  14690. (save-excursion
  14691. (re-search-backward
  14692. (concat org-ts-regexp "--?-?\\=") ; 1-3 minuses
  14693. (- (point) 20) t)))
  14694. (apply 'encode-time (org-parse-time-string (match-string 1)))
  14695. (current-time)))
  14696. (default-input (and ts (org-get-compact-tod ts)))
  14697. (repeater (save-excursion
  14698. (save-match-data
  14699. (beginning-of-line)
  14700. (when (re-search-forward
  14701. "\\([.+-]+[0-9]+[hdwmy] ?\\)+" ;;\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
  14702. (save-excursion (progn (end-of-line) (point))) t)
  14703. (match-string 0)))))
  14704. org-time-was-given org-end-time-was-given time)
  14705. (cond
  14706. ((and (org-at-timestamp-p t)
  14707. (memq last-command '(org-time-stamp org-time-stamp-inactive))
  14708. (memq this-command '(org-time-stamp org-time-stamp-inactive)))
  14709. (insert "--")
  14710. (setq time (let ((this-command this-command))
  14711. (org-read-date arg 'totime nil nil
  14712. default-time default-input inactive)))
  14713. (org-insert-time-stamp time (or org-time-was-given arg) inactive))
  14714. ((org-at-timestamp-p t)
  14715. (setq time (let ((this-command this-command))
  14716. (org-read-date arg 'totime nil nil default-time default-input inactive)))
  14717. (when (org-at-timestamp-p t) ; just to get the match data
  14718. ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
  14719. (replace-match "")
  14720. (setq org-last-changed-timestamp
  14721. (org-insert-time-stamp
  14722. time (or org-time-was-given arg)
  14723. inactive nil nil (list org-end-time-was-given)))
  14724. (when repeater (goto-char (1- (point))) (insert " " repeater)
  14725. (setq org-last-changed-timestamp
  14726. (concat (substring org-last-inserted-timestamp 0 -1)
  14727. " " repeater ">"))))
  14728. (message "Timestamp updated"))
  14729. ((equal arg '(16))
  14730. (org-insert-time-stamp (current-time) t inactive))
  14731. (t
  14732. (setq time (let ((this-command this-command))
  14733. (org-read-date arg 'totime nil nil default-time default-input inactive)))
  14734. (org-insert-time-stamp time (or org-time-was-given arg) inactive
  14735. nil nil (list org-end-time-was-given))))))
  14736. ;; FIXME: can we use this for something else, like computing time differences?
  14737. (defun org-get-compact-tod (s)
  14738. (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
  14739. (let* ((t1 (match-string 1 s))
  14740. (h1 (string-to-number (match-string 2 s)))
  14741. (m1 (string-to-number (match-string 3 s)))
  14742. (t2 (and (match-end 4) (match-string 5 s)))
  14743. (h2 (and t2 (string-to-number (match-string 6 s))))
  14744. (m2 (and t2 (string-to-number (match-string 7 s))))
  14745. dh dm)
  14746. (if (not t2)
  14747. t1
  14748. (setq dh (- h2 h1) dm (- m2 m1))
  14749. (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
  14750. (concat t1 "+" (number-to-string dh)
  14751. (and (/= 0 dm) (format ":%02d" dm)))))))
  14752. (defun org-time-stamp-inactive (&optional arg)
  14753. "Insert an inactive time stamp.
  14754. An inactive time stamp is enclosed in square brackets instead of angle
  14755. brackets. It is inactive in the sense that it does not trigger agenda entries,
  14756. does not link to the calendar and cannot be changed with the S-cursor keys.
  14757. So these are more for recording a certain time/date."
  14758. (interactive "P")
  14759. (org-time-stamp arg 'inactive))
  14760. (defvar org-date-ovl (make-overlay 1 1))
  14761. (overlay-put org-date-ovl 'face 'org-date-selected)
  14762. (org-detach-overlay org-date-ovl)
  14763. (defvar org-ans1) ; dynamically scoped parameter
  14764. (defvar org-ans2) ; dynamically scoped parameter
  14765. (defvar org-plain-time-of-day-regexp) ; defined below
  14766. (defvar org-overriding-default-time nil) ; dynamically scoped
  14767. (defvar org-read-date-overlay nil)
  14768. (defvar org-dcst nil) ; dynamically scoped
  14769. (defvar org-read-date-history nil)
  14770. (defvar org-read-date-final-answer nil)
  14771. (defvar org-read-date-analyze-futurep nil)
  14772. (defvar org-read-date-analyze-forced-year nil)
  14773. (defvar org-read-date-inactive)
  14774. (defvar org-read-date-minibuffer-local-map
  14775. (let* ((org-replace-disputed-keys nil)
  14776. (map (make-sparse-keymap)))
  14777. (set-keymap-parent map minibuffer-local-map)
  14778. (org-defkey map (kbd ".")
  14779. (lambda () (interactive)
  14780. ;; Are we at the beginning of the prompt?
  14781. (if (looking-back "^[^:]+: ")
  14782. (org-eval-in-calendar '(calendar-goto-today))
  14783. (insert "."))))
  14784. (org-defkey map (kbd "C-.")
  14785. (lambda () (interactive)
  14786. (org-eval-in-calendar '(calendar-goto-today))))
  14787. (org-defkey map [(meta shift left)]
  14788. (lambda () (interactive)
  14789. (org-eval-in-calendar '(calendar-backward-month 1))))
  14790. (org-defkey map [(meta shift right)]
  14791. (lambda () (interactive)
  14792. (org-eval-in-calendar '(calendar-forward-month 1))))
  14793. (org-defkey map [(meta shift up)]
  14794. (lambda () (interactive)
  14795. (org-eval-in-calendar '(calendar-backward-year 1))))
  14796. (org-defkey map [(meta shift down)]
  14797. (lambda () (interactive)
  14798. (org-eval-in-calendar '(calendar-forward-year 1))))
  14799. (org-defkey map [?\e (shift left)]
  14800. (lambda () (interactive)
  14801. (org-eval-in-calendar '(calendar-backward-month 1))))
  14802. (org-defkey map [?\e (shift right)]
  14803. (lambda () (interactive)
  14804. (org-eval-in-calendar '(calendar-forward-month 1))))
  14805. (org-defkey map [?\e (shift up)]
  14806. (lambda () (interactive)
  14807. (org-eval-in-calendar '(calendar-backward-year 1))))
  14808. (org-defkey map [?\e (shift down)]
  14809. (lambda () (interactive)
  14810. (org-eval-in-calendar '(calendar-forward-year 1))))
  14811. (org-defkey map [(shift up)]
  14812. (lambda () (interactive)
  14813. (org-eval-in-calendar '(calendar-backward-week 1))))
  14814. (org-defkey map [(shift down)]
  14815. (lambda () (interactive)
  14816. (org-eval-in-calendar '(calendar-forward-week 1))))
  14817. (org-defkey map [(shift left)]
  14818. (lambda () (interactive)
  14819. (org-eval-in-calendar '(calendar-backward-day 1))))
  14820. (org-defkey map [(shift right)]
  14821. (lambda () (interactive)
  14822. (org-eval-in-calendar '(calendar-forward-day 1))))
  14823. (org-defkey map "!"
  14824. (lambda () (interactive)
  14825. (org-eval-in-calendar '(diary-view-entries))
  14826. (message "")))
  14827. (org-defkey map ">"
  14828. (lambda () (interactive)
  14829. (org-eval-in-calendar '(scroll-calendar-left 1))))
  14830. (org-defkey map "<"
  14831. (lambda () (interactive)
  14832. (org-eval-in-calendar '(scroll-calendar-right 1))))
  14833. (org-defkey map "\C-v"
  14834. (lambda () (interactive)
  14835. (org-eval-in-calendar
  14836. '(calendar-scroll-left-three-months 1))))
  14837. (org-defkey map "\M-v"
  14838. (lambda () (interactive)
  14839. (org-eval-in-calendar
  14840. '(calendar-scroll-right-three-months 1))))
  14841. map)
  14842. "Keymap for minibuffer commands when using `org-read-date'.")
  14843. (defun org-read-date (&optional org-with-time to-time from-string prompt
  14844. default-time default-input inactive)
  14845. "Read a date, possibly a time, and make things smooth for the user.
  14846. The prompt will suggest to enter an ISO date, but you can also enter anything
  14847. which will at least partially be understood by `parse-time-string'.
  14848. Unrecognized parts of the date will default to the current day, month, year,
  14849. hour and minute. If this command is called to replace a timestamp at point,
  14850. or to enter the second timestamp of a range, the default time is taken
  14851. from the existing stamp. Furthermore, the command prefers the future,
  14852. so if you are giving a date where the year is not given, and the day-month
  14853. combination is already past in the current year, it will assume you
  14854. mean next year. For details, see the manual. A few examples:
  14855. 3-2-5 --> 2003-02-05
  14856. feb 15 --> currentyear-02-15
  14857. 2/15 --> currentyear-02-15
  14858. sep 12 9 --> 2009-09-12
  14859. 12:45 --> today 12:45
  14860. 22 sept 0:34 --> currentyear-09-22 0:34
  14861. 12 --> currentyear-currentmonth-12
  14862. Fri --> nearest Friday after today
  14863. -Tue --> last Tuesday
  14864. etc.
  14865. Furthermore you can specify a relative date by giving, as the *first* thing
  14866. in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
  14867. change in days weeks, months, years.
  14868. With a single plus or minus, the date is relative to today. With a double
  14869. plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
  14870. +4d --> four days from today
  14871. +4 --> same as above
  14872. +2w --> two weeks from today
  14873. ++5 --> five days from default date
  14874. The function understands only English month and weekday abbreviations.
  14875. While prompting, a calendar is popped up - you can also select the
  14876. date with the mouse (button 1). The calendar shows a period of three
  14877. months. To scroll it to other months, use the keys `>' and `<'.
  14878. If you don't like the calendar, turn it off with
  14879. \(setq org-read-date-popup-calendar nil)
  14880. With optional argument TO-TIME, the date will immediately be converted
  14881. to an internal time.
  14882. With an optional argument ORG-WITH-TIME, the prompt will suggest to
  14883. also insert a time. Note that when ORG-WITH-TIME is not set, you can
  14884. still enter a time, and this function will inform the calling routine
  14885. about this change. The calling routine may then choose to change the
  14886. format used to insert the time stamp into the buffer to include the time.
  14887. With optional argument FROM-STRING, read from this string instead from
  14888. the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
  14889. the time/date that is used for everything that is not specified by the
  14890. user."
  14891. (require 'parse-time)
  14892. (let* ((org-time-stamp-rounding-minutes
  14893. (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
  14894. (org-dcst org-display-custom-times)
  14895. (ct (org-current-time))
  14896. (org-def (or org-overriding-default-time default-time ct))
  14897. (org-defdecode (decode-time org-def))
  14898. (dummy (progn
  14899. (when (< (nth 2 org-defdecode) org-extend-today-until)
  14900. (setcar (nthcdr 2 org-defdecode) -1)
  14901. (setcar (nthcdr 1 org-defdecode) 59)
  14902. (setq org-def (apply 'encode-time org-defdecode)
  14903. org-defdecode (decode-time org-def)))))
  14904. (mouse-autoselect-window nil) ; Don't let the mouse jump
  14905. (calendar-frame-setup nil)
  14906. (calendar-setup nil)
  14907. (calendar-move-hook nil)
  14908. (calendar-view-diary-initially-flag nil)
  14909. (calendar-view-holidays-initially-flag nil)
  14910. (timestr (format-time-string
  14911. (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
  14912. (prompt (concat (if prompt (concat prompt " ") "")
  14913. (format "Date+time [%s]: " timestr)))
  14914. ans (org-ans0 "") org-ans1 org-ans2 final)
  14915. (cond
  14916. (from-string (setq ans from-string))
  14917. (org-read-date-popup-calendar
  14918. (save-excursion
  14919. (save-window-excursion
  14920. (calendar)
  14921. (org-eval-in-calendar '(setq cursor-type nil) t)
  14922. (unwind-protect
  14923. (progn
  14924. (calendar-forward-day (- (time-to-days org-def)
  14925. (calendar-absolute-from-gregorian
  14926. (calendar-current-date))))
  14927. (org-eval-in-calendar nil t)
  14928. (let* ((old-map (current-local-map))
  14929. (map (copy-keymap calendar-mode-map))
  14930. (minibuffer-local-map
  14931. (copy-keymap org-read-date-minibuffer-local-map)))
  14932. (org-defkey map (kbd "RET") 'org-calendar-select)
  14933. (org-defkey map [mouse-1] 'org-calendar-select-mouse)
  14934. (org-defkey map [mouse-2] 'org-calendar-select-mouse)
  14935. (unwind-protect
  14936. (progn
  14937. (use-local-map map)
  14938. (setq org-read-date-inactive inactive)
  14939. (add-hook 'post-command-hook 'org-read-date-display)
  14940. (setq org-ans0 (read-string prompt default-input
  14941. 'org-read-date-history nil))
  14942. ;; org-ans0: from prompt
  14943. ;; org-ans1: from mouse click
  14944. ;; org-ans2: from calendar motion
  14945. (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
  14946. (remove-hook 'post-command-hook 'org-read-date-display)
  14947. (use-local-map old-map)
  14948. (when org-read-date-overlay
  14949. (delete-overlay org-read-date-overlay)
  14950. (setq org-read-date-overlay nil)))))
  14951. (bury-buffer "*Calendar*")))))
  14952. (t ; Naked prompt only
  14953. (unwind-protect
  14954. (setq ans (read-string prompt default-input
  14955. 'org-read-date-history timestr))
  14956. (when org-read-date-overlay
  14957. (delete-overlay org-read-date-overlay)
  14958. (setq org-read-date-overlay nil)))))
  14959. (setq final (org-read-date-analyze ans org-def org-defdecode))
  14960. (when org-read-date-analyze-forced-year
  14961. (message "Year was forced into %s"
  14962. (if org-read-date-force-compatible-dates
  14963. "compatible range (1970-2037)"
  14964. "range representable on this machine"))
  14965. (ding))
  14966. ;; One round trip to get rid of 34th of August and stuff like that....
  14967. (setq final (decode-time (apply 'encode-time final)))
  14968. (setq org-read-date-final-answer ans)
  14969. (if to-time
  14970. (apply 'encode-time final)
  14971. (if (and (boundp 'org-time-was-given) org-time-was-given)
  14972. (format "%04d-%02d-%02d %02d:%02d"
  14973. (nth 5 final) (nth 4 final) (nth 3 final)
  14974. (nth 2 final) (nth 1 final))
  14975. (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
  14976. (defvar org-def)
  14977. (defvar org-defdecode)
  14978. (defvar org-with-time)
  14979. (defun org-read-date-display ()
  14980. "Display the current date prompt interpretation in the minibuffer."
  14981. (when org-read-date-display-live
  14982. (when org-read-date-overlay
  14983. (delete-overlay org-read-date-overlay))
  14984. (when (minibufferp (current-buffer))
  14985. (save-excursion
  14986. (end-of-line 1)
  14987. (while (not (equal (buffer-substring
  14988. (max (point-min) (- (point) 4)) (point))
  14989. " "))
  14990. (insert " ")))
  14991. (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
  14992. " " (or org-ans1 org-ans2)))
  14993. (org-end-time-was-given nil)
  14994. (f (org-read-date-analyze ans org-def org-defdecode))
  14995. (fmts (if org-dcst
  14996. org-time-stamp-custom-formats
  14997. org-time-stamp-formats))
  14998. (fmt (if (or org-with-time
  14999. (and (boundp 'org-time-was-given) org-time-was-given))
  15000. (cdr fmts)
  15001. (car fmts)))
  15002. (txt (format-time-string fmt (apply 'encode-time f)))
  15003. (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
  15004. (txt (concat "=> " txt)))
  15005. (when (and org-end-time-was-given
  15006. (string-match org-plain-time-of-day-regexp txt))
  15007. (setq txt (concat (substring txt 0 (match-end 0)) "-"
  15008. org-end-time-was-given
  15009. (substring txt (match-end 0)))))
  15010. (when org-read-date-analyze-futurep
  15011. (setq txt (concat txt " (=>F)")))
  15012. (setq org-read-date-overlay
  15013. (make-overlay (1- (point-at-eol)) (point-at-eol)))
  15014. (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
  15015. (defun org-read-date-analyze (ans org-def org-defdecode)
  15016. "Analyze the combined answer of the date prompt."
  15017. ;; FIXME: cleanup and comment
  15018. (let ((nowdecode (decode-time (current-time)))
  15019. delta deltan deltaw deltadef year month day
  15020. hour minute second wday pm h2 m2 tl wday1
  15021. iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
  15022. (setq org-read-date-analyze-futurep nil
  15023. org-read-date-analyze-forced-year nil)
  15024. (when (string-match "\\`[ \t]*\\.[ \t]*\\'" ans)
  15025. (setq ans "+0"))
  15026. (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
  15027. (setq ans (replace-match "" t t ans)
  15028. deltan (car delta)
  15029. deltaw (nth 1 delta)
  15030. deltadef (nth 2 delta)))
  15031. ;; Check if there is an iso week date in there. If yes, store the
  15032. ;; info and postpone interpreting it until the rest of the parsing
  15033. ;; is done.
  15034. (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
  15035. (setq iso-year (if (match-end 1)
  15036. (org-small-year-to-year
  15037. (string-to-number (match-string 1 ans))))
  15038. iso-weekday (if (match-end 3)
  15039. (string-to-number (match-string 3 ans)))
  15040. iso-week (string-to-number (match-string 2 ans)))
  15041. (setq ans (replace-match "" t t ans)))
  15042. ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
  15043. (when (string-match
  15044. "^ *\\(\\([0-9]+\\)-\\)?\\([0-1]?[0-9]\\)-\\([0-3]?[0-9]\\)\\([^-0-9]\\|$\\)" ans)
  15045. (setq year (if (match-end 2)
  15046. (string-to-number (match-string 2 ans))
  15047. (progn (setq kill-year t)
  15048. (string-to-number (format-time-string "%Y"))))
  15049. month (string-to-number (match-string 3 ans))
  15050. day (string-to-number (match-string 4 ans)))
  15051. (if (< year 100) (setq year (+ 2000 year)))
  15052. (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
  15053. t nil ans)))
  15054. ;; Help matching dotted european dates
  15055. (when (string-match
  15056. "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\.\\( ?[1-9][0-9]\\{3\\}\\)?" ans)
  15057. (setq year (if (match-end 3) (string-to-number (match-string 3 ans))
  15058. (setq kill-year t)
  15059. (string-to-number (format-time-string "%Y")))
  15060. day (string-to-number (match-string 1 ans))
  15061. month (string-to-number (match-string 2 ans))
  15062. ans (replace-match (format "%04d-%02d-%02d" year month day)
  15063. t nil ans)))
  15064. ;; Help matching american dates, like 5/30 or 5/30/7
  15065. (when (string-match
  15066. "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
  15067. (setq year (if (match-end 4)
  15068. (string-to-number (match-string 4 ans))
  15069. (progn (setq kill-year t)
  15070. (string-to-number (format-time-string "%Y"))))
  15071. month (string-to-number (match-string 1 ans))
  15072. day (string-to-number (match-string 2 ans)))
  15073. (if (< year 100) (setq year (+ 2000 year)))
  15074. (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
  15075. t nil ans)))
  15076. ;; Help matching am/pm times, because `parse-time-string' does not do that.
  15077. ;; If there is a time with am/pm, and *no* time without it, we convert
  15078. ;; so that matching will be successful.
  15079. (loop for i from 1 to 2 do ; twice, for end time as well
  15080. (when (and (not (string-match "\\(\\`\\|[^+]\\)[012]?[0-9]:[0-9][0-9]\\([ \t\n]\\|$\\)" ans))
  15081. (string-match "\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\(am\\|AM\\|pm\\|PM\\)\\>" ans))
  15082. (setq hour (string-to-number (match-string 1 ans))
  15083. minute (if (match-end 3)
  15084. (string-to-number (match-string 3 ans))
  15085. 0)
  15086. pm (equal ?p
  15087. (string-to-char (downcase (match-string 4 ans)))))
  15088. (if (and (= hour 12) (not pm))
  15089. (setq hour 0)
  15090. (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
  15091. (setq ans (replace-match (format "%02d:%02d" hour minute)
  15092. t t ans))))
  15093. ;; Check if a time range is given as a duration
  15094. (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
  15095. (setq hour (string-to-number (match-string 1 ans))
  15096. h2 (+ hour (string-to-number (match-string 3 ans)))
  15097. minute (string-to-number (match-string 2 ans))
  15098. m2 (+ minute (if (match-end 5) (string-to-number
  15099. (match-string 5 ans))0)))
  15100. (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
  15101. (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
  15102. t t ans)))
  15103. ;; Check if there is a time range
  15104. (when (boundp 'org-end-time-was-given)
  15105. (setq org-time-was-given nil)
  15106. (when (and (string-match org-plain-time-of-day-regexp ans)
  15107. (match-end 8))
  15108. (setq org-end-time-was-given (match-string 8 ans))
  15109. (setq ans (concat (substring ans 0 (match-beginning 7))
  15110. (substring ans (match-end 7))))))
  15111. (setq tl (parse-time-string ans)
  15112. day (or (nth 3 tl) (nth 3 org-defdecode))
  15113. month (or (nth 4 tl)
  15114. (if (and org-read-date-prefer-future
  15115. (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
  15116. (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
  15117. (nth 4 org-defdecode)))
  15118. year (or (and (not kill-year) (nth 5 tl))
  15119. (if (and org-read-date-prefer-future
  15120. (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
  15121. (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
  15122. (nth 5 org-defdecode)))
  15123. hour (or (nth 2 tl) (nth 2 org-defdecode))
  15124. minute (or (nth 1 tl) (nth 1 org-defdecode))
  15125. second (or (nth 0 tl) 0)
  15126. wday (nth 6 tl))
  15127. (when (and (eq org-read-date-prefer-future 'time)
  15128. (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
  15129. (equal day (nth 3 nowdecode))
  15130. (equal month (nth 4 nowdecode))
  15131. (equal year (nth 5 nowdecode))
  15132. (nth 2 tl)
  15133. (or (< (nth 2 tl) (nth 2 nowdecode))
  15134. (and (= (nth 2 tl) (nth 2 nowdecode))
  15135. (nth 1 tl)
  15136. (< (nth 1 tl) (nth 1 nowdecode)))))
  15137. (setq day (1+ day)
  15138. futurep t))
  15139. ;; Special date definitions below
  15140. (cond
  15141. (iso-week
  15142. ;; There was an iso week
  15143. (require 'cal-iso)
  15144. (setq futurep nil)
  15145. (setq year (or iso-year year)
  15146. day (or iso-weekday wday 1)
  15147. wday nil ; to make sure that the trigger below does not match
  15148. iso-date (calendar-gregorian-from-absolute
  15149. (calendar-absolute-from-iso
  15150. (list iso-week day year))))
  15151. ; FIXME: Should we also push ISO weeks into the future?
  15152. ; (when (and org-read-date-prefer-future
  15153. ; (not iso-year)
  15154. ; (< (calendar-absolute-from-gregorian iso-date)
  15155. ; (time-to-days (current-time))))
  15156. ; (setq year (1+ year)
  15157. ; iso-date (calendar-gregorian-from-absolute
  15158. ; (calendar-absolute-from-iso
  15159. ; (list iso-week day year)))))
  15160. (setq month (car iso-date)
  15161. year (nth 2 iso-date)
  15162. day (nth 1 iso-date)))
  15163. (deltan
  15164. (setq futurep nil)
  15165. (unless deltadef
  15166. (let ((now (decode-time (current-time))))
  15167. (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
  15168. (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
  15169. ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
  15170. ((equal deltaw "m") (setq month (+ month deltan)))
  15171. ((equal deltaw "y") (setq year (+ year deltan)))))
  15172. ((and wday (not (nth 3 tl)))
  15173. ;; Weekday was given, but no day, so pick that day in the week
  15174. ;; on or after the derived date.
  15175. (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
  15176. (unless (equal wday wday1)
  15177. (setq day (+ day (% (- wday wday1 -7) 7))))))
  15178. (if (and (boundp 'org-time-was-given)
  15179. (nth 2 tl))
  15180. (setq org-time-was-given t))
  15181. (if (< year 100) (setq year (+ 2000 year)))
  15182. ;; Check of the date is representable
  15183. (if org-read-date-force-compatible-dates
  15184. (progn
  15185. (if (< year 1970)
  15186. (setq year 1970 org-read-date-analyze-forced-year t))
  15187. (if (> year 2037)
  15188. (setq year 2037 org-read-date-analyze-forced-year t)))
  15189. (condition-case nil
  15190. (ignore (encode-time second minute hour day month year))
  15191. (error
  15192. (setq year (nth 5 org-defdecode))
  15193. (setq org-read-date-analyze-forced-year t))))
  15194. (setq org-read-date-analyze-futurep futurep)
  15195. (list second minute hour day month year)))
  15196. (defvar parse-time-weekdays)
  15197. (defun org-read-date-get-relative (s today default)
  15198. "Check string S for special relative date string.
  15199. TODAY and DEFAULT are internal times, for today and for a default.
  15200. Return shift list (N what def-flag)
  15201. WHAT is \"d\", \"w\", \"m\", or \"y\" for day, week, month, year.
  15202. N is the number of WHATs to shift.
  15203. DEF-FLAG is t when a double ++ or -- indicates shift relative to
  15204. the DEFAULT date rather than TODAY."
  15205. (require 'parse-time)
  15206. (when (and
  15207. (string-match
  15208. (concat
  15209. "\\`[ \t]*\\([-+]\\{0,2\\}\\)"
  15210. "\\([0-9]+\\)?"
  15211. "\\([hdwmy]\\|\\(" (mapconcat 'car parse-time-weekdays "\\|") "\\)\\)?"
  15212. "\\([ \t]\\|$\\)") s)
  15213. (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
  15214. (let* ((dir (if (> (match-end 1) (match-beginning 1))
  15215. (string-to-char (substring (match-string 1 s) -1))
  15216. ?+))
  15217. (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
  15218. (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
  15219. (what (if (match-end 3) (match-string 3 s) "d"))
  15220. (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
  15221. (date (if rel default today))
  15222. (wday (nth 6 (decode-time date)))
  15223. delta)
  15224. (if wday1
  15225. (progn
  15226. (setq delta (mod (+ 7 (- wday1 wday)) 7))
  15227. (if (= delta 0) (setq delta 7))
  15228. (if (= dir ?-)
  15229. (progn
  15230. (setq delta (- delta 7))
  15231. (if (= delta 0) (setq delta -7))))
  15232. (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
  15233. (list delta "d" rel))
  15234. (list (* n (if (= dir ?-) -1 1)) what rel)))))
  15235. (defun org-order-calendar-date-args (arg1 arg2 arg3)
  15236. "Turn a user-specified date into the internal representation.
  15237. The internal representation needed by the calendar is (month day year).
  15238. This is a wrapper to handle the brain-dead convention in calendar that
  15239. user function argument order change dependent on argument order."
  15240. (if (boundp 'calendar-date-style)
  15241. (cond
  15242. ((eq calendar-date-style 'american)
  15243. (list arg1 arg2 arg3))
  15244. ((eq calendar-date-style 'european)
  15245. (list arg2 arg1 arg3))
  15246. ((eq calendar-date-style 'iso)
  15247. (list arg2 arg3 arg1)))
  15248. (org-no-warnings ;; european-calendar-style is obsolete as of version 23.1
  15249. (if (org-bound-and-true-p european-calendar-style)
  15250. (list arg2 arg1 arg3)
  15251. (list arg1 arg2 arg3)))))
  15252. (defun org-eval-in-calendar (form &optional keepdate)
  15253. "Eval FORM in the calendar window and return to current window.
  15254. When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
  15255. otherwise stick to the current value of `org-ans2'."
  15256. (let ((sf (selected-frame))
  15257. (sw (selected-window)))
  15258. (select-window (get-buffer-window "*Calendar*" t))
  15259. (eval form)
  15260. (when (and (not keepdate) (calendar-cursor-to-date))
  15261. (let* ((date (calendar-cursor-to-date))
  15262. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  15263. (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
  15264. (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
  15265. (select-window sw)
  15266. (org-select-frame-set-input-focus sf)))
  15267. (defun org-calendar-select ()
  15268. "Return to `org-read-date' with the date currently selected.
  15269. This is used by `org-read-date' in a temporary keymap for the calendar buffer."
  15270. (interactive)
  15271. (when (calendar-cursor-to-date)
  15272. (let* ((date (calendar-cursor-to-date))
  15273. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  15274. (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
  15275. (if (active-minibuffer-window) (exit-minibuffer))))
  15276. (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
  15277. "Insert a date stamp for the date given by the internal TIME.
  15278. WITH-HM means use the stamp format that includes the time of the day.
  15279. INACTIVE means use square brackets instead of angular ones, so that the
  15280. stamp will not contribute to the agenda.
  15281. PRE and POST are optional strings to be inserted before and after the
  15282. stamp.
  15283. The command returns the inserted time stamp."
  15284. (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
  15285. stamp)
  15286. (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
  15287. (insert-before-markers (or pre ""))
  15288. (when (listp extra)
  15289. (setq extra (car extra))
  15290. (if (and (stringp extra)
  15291. (string-match "\\([0-9]+\\):\\([0-9]+\\)" extra))
  15292. (setq extra (format "-%02d:%02d"
  15293. (string-to-number (match-string 1 extra))
  15294. (string-to-number (match-string 2 extra))))
  15295. (setq extra nil)))
  15296. (when extra
  15297. (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
  15298. (insert-before-markers (setq stamp (format-time-string fmt time)))
  15299. (insert-before-markers (or post ""))
  15300. (setq org-last-inserted-timestamp stamp)))
  15301. (defun org-toggle-time-stamp-overlays ()
  15302. "Toggle the use of custom time stamp formats."
  15303. (interactive)
  15304. (setq org-display-custom-times (not org-display-custom-times))
  15305. (unless org-display-custom-times
  15306. (let ((p (point-min)) (bmp (buffer-modified-p)))
  15307. (while (setq p (next-single-property-change p 'display))
  15308. (if (and (get-text-property p 'display)
  15309. (eq (get-text-property p 'face) 'org-date))
  15310. (remove-text-properties
  15311. p (setq p (next-single-property-change p 'display))
  15312. '(display t))))
  15313. (set-buffer-modified-p bmp)))
  15314. (if (featurep 'xemacs)
  15315. (remove-text-properties (point-min) (point-max) '(end-glyph t)))
  15316. (org-restart-font-lock)
  15317. (setq org-table-may-need-update t)
  15318. (if org-display-custom-times
  15319. (message "Time stamps are overlaid with custom format")
  15320. (message "Time stamp overlays removed")))
  15321. (defun org-display-custom-time (beg end)
  15322. "Overlay modified time stamp format over timestamp between BEG and END."
  15323. (let* ((ts (buffer-substring beg end))
  15324. t1 w1 with-hm tf time str w2 (off 0))
  15325. (save-match-data
  15326. (setq t1 (org-parse-time-string ts t))
  15327. (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
  15328. (setq off (- (match-end 0) (match-beginning 0)))))
  15329. (setq end (- end off))
  15330. (setq w1 (- end beg)
  15331. with-hm (and (nth 1 t1) (nth 2 t1))
  15332. tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
  15333. time (org-fix-decoded-time t1)
  15334. str (org-add-props
  15335. (format-time-string
  15336. (substring tf 1 -1) (apply 'encode-time time))
  15337. nil 'mouse-face 'highlight)
  15338. w2 (length str))
  15339. (if (not (= w2 w1))
  15340. (add-text-properties (1+ beg) (+ 2 beg)
  15341. (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
  15342. (if (featurep 'xemacs)
  15343. (progn
  15344. (put-text-property beg end 'invisible t)
  15345. (put-text-property beg end 'end-glyph (make-glyph str)))
  15346. (put-text-property beg end 'display str))))
  15347. (defun org-translate-time (string)
  15348. "Translate all timestamps in STRING to custom format.
  15349. But do this only if the variable `org-display-custom-times' is set."
  15350. (when org-display-custom-times
  15351. (save-match-data
  15352. (let* ((start 0)
  15353. (re org-ts-regexp-both)
  15354. t1 with-hm inactive tf time str beg end)
  15355. (while (setq start (string-match re string start))
  15356. (setq beg (match-beginning 0)
  15357. end (match-end 0)
  15358. t1 (save-match-data
  15359. (org-parse-time-string (substring string beg end) t))
  15360. with-hm (and (nth 1 t1) (nth 2 t1))
  15361. inactive (equal (substring string beg (1+ beg)) "[")
  15362. tf (funcall (if with-hm 'cdr 'car)
  15363. org-time-stamp-custom-formats)
  15364. time (org-fix-decoded-time t1)
  15365. str (format-time-string
  15366. (concat
  15367. (if inactive "[" "<") (substring tf 1 -1)
  15368. (if inactive "]" ">"))
  15369. (apply 'encode-time time))
  15370. string (replace-match str t t string)
  15371. start (+ start (length str)))))))
  15372. string)
  15373. (defun org-fix-decoded-time (time)
  15374. "Set 0 instead of nil for the first 6 elements of time.
  15375. Don't touch the rest."
  15376. (let ((n 0))
  15377. (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
  15378. (define-obsolete-function-alias 'org-days-to-time 'org-time-stamp-to-now "24.4")
  15379. (defun org-time-stamp-to-now (timestamp-string &optional seconds)
  15380. "Difference between TIMESTAMP-STRING and now in days.
  15381. If SECONDS is non-nil, return the difference in seconds."
  15382. (let ((fdiff (if seconds 'org-float-time 'time-to-days)))
  15383. (- (funcall fdiff (org-time-string-to-time timestamp-string))
  15384. (funcall fdiff (current-time)))))
  15385. (defun org-deadline-close (timestamp-string &optional ndays)
  15386. "Is the time in TIMESTAMP-STRING close to the current date?"
  15387. (setq ndays (or ndays (org-get-wdays timestamp-string)))
  15388. (and (< (org-time-stamp-to-now timestamp-string) ndays)
  15389. (not (org-entry-is-done-p))))
  15390. (defun org-get-wdays (ts &optional delay zero-delay)
  15391. "Get the deadline lead time appropriate for timestring TS.
  15392. When DELAY is non-nil, get the delay time for scheduled items
  15393. instead of the deadline lead time. When ZERO-DELAY is non-nil
  15394. and `org-scheduled-delay-days' is 0, enforce 0 as the delay,
  15395. don't try to find the delay cookie in the scheduled timestamp."
  15396. (let ((tv (if delay org-scheduled-delay-days
  15397. org-deadline-warning-days)))
  15398. (cond
  15399. ((or (and delay (< tv 0))
  15400. (and delay zero-delay (<= tv 0))
  15401. (and (not delay) (<= tv 0)))
  15402. ;; Enforce this value no matter what
  15403. (- tv))
  15404. ((string-match "-\\([0-9]+\\)\\([hdwmy]\\)\\(\\'\\|>\\| \\)" ts)
  15405. ;; lead time is specified.
  15406. (floor (* (string-to-number (match-string 1 ts))
  15407. (cdr (assoc (match-string 2 ts)
  15408. '(("d" . 1) ("w" . 7)
  15409. ("m" . 30.4) ("y" . 365.25)
  15410. ("h" . 0.041667)))))))
  15411. ;; go for the default.
  15412. (t tv))))
  15413. (defun org-calendar-select-mouse (ev)
  15414. "Return to `org-read-date' with the date currently selected.
  15415. This is used by `org-read-date' in a temporary keymap for the calendar buffer."
  15416. (interactive "e")
  15417. (mouse-set-point ev)
  15418. (when (calendar-cursor-to-date)
  15419. (let* ((date (calendar-cursor-to-date))
  15420. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  15421. (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
  15422. (if (active-minibuffer-window) (exit-minibuffer))))
  15423. (defun org-check-deadlines (ndays)
  15424. "Check if there are any deadlines due or past due.
  15425. A deadline is considered due if it happens within `org-deadline-warning-days'
  15426. days from today's date. If the deadline appears in an entry marked DONE,
  15427. it is not shown. The prefix arg NDAYS can be used to test that many
  15428. days. If the prefix is a raw \\[universal-argument] prefix, all deadlines are shown."
  15429. (interactive "P")
  15430. (let* ((org-warn-days
  15431. (cond
  15432. ((equal ndays '(4)) 100000)
  15433. (ndays (prefix-numeric-value ndays))
  15434. (t (abs org-deadline-warning-days))))
  15435. (case-fold-search nil)
  15436. (regexp (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
  15437. (callback
  15438. (lambda () (org-deadline-close (match-string 1) org-warn-days))))
  15439. (message "%d deadlines past-due or due within %d days"
  15440. (org-occur regexp nil callback)
  15441. org-warn-days)))
  15442. (defsubst org-re-timestamp (type)
  15443. "Return a regexp for timestamp TYPE.
  15444. Allowed values for TYPE are:
  15445. all: all timestamps
  15446. active: only active timestamps (<...>)
  15447. inactive: only inactive timestamps ([...])
  15448. scheduled: only scheduled timestamps
  15449. deadline: only deadline timestamps
  15450. closed: only closed time-stamps
  15451. When TYPE is nil, fall back on returning a regexp that matches
  15452. both scheduled and deadline timestamps."
  15453. (cond ((eq type 'all) "\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}\\(?: +[^]+0-9> \n -]+\\)?\\(?: +[0-9]\\{1,2\\}:[0-9]\\{2\\}\\)?\\)")
  15454. ((eq type 'active) org-ts-regexp)
  15455. ((eq type 'inactive) "\\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^ \n>]*?\\)\\]")
  15456. ((eq type 'scheduled) (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>"))
  15457. ((eq type 'deadline) (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
  15458. ((eq type 'closed) (concat org-closed-string " \\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^ \n>]*?\\)\\]"))
  15459. ((eq type 'scheduled-or-deadline)
  15460. (concat "\\<\\(?:" org-deadline-string "\\|" org-scheduled-string "\\) *<\\([^>]+\\)>"))))
  15461. (defun org-check-before-date (date)
  15462. "Check if there are deadlines or scheduled entries before DATE."
  15463. (interactive (list (org-read-date)))
  15464. (let ((case-fold-search nil)
  15465. (regexp (org-re-timestamp org-ts-type))
  15466. (callback
  15467. (lambda () (time-less-p
  15468. (org-time-string-to-time (match-string 1))
  15469. (org-time-string-to-time date)))))
  15470. (message "%d entries before %s"
  15471. (org-occur regexp nil callback) date)))
  15472. (defun org-check-after-date (date)
  15473. "Check if there are deadlines or scheduled entries after DATE."
  15474. (interactive (list (org-read-date)))
  15475. (let ((case-fold-search nil)
  15476. (regexp (org-re-timestamp org-ts-type))
  15477. (callback
  15478. (lambda () (not
  15479. (time-less-p
  15480. (org-time-string-to-time (match-string 1))
  15481. (org-time-string-to-time date))))))
  15482. (message "%d entries after %s"
  15483. (org-occur regexp nil callback) date)))
  15484. (defun org-check-dates-range (start-date end-date)
  15485. "Check for deadlines/scheduled entries between START-DATE and END-DATE."
  15486. (interactive (list (org-read-date nil nil nil "Range starts")
  15487. (org-read-date nil nil nil "Range end")))
  15488. (let ((case-fold-search nil)
  15489. (regexp (org-re-timestamp org-ts-type))
  15490. (callback
  15491. (lambda ()
  15492. (let ((match (match-string 1)))
  15493. (and
  15494. (not (time-less-p
  15495. (org-time-string-to-time match)
  15496. (org-time-string-to-time start-date)))
  15497. (time-less-p
  15498. (org-time-string-to-time match)
  15499. (org-time-string-to-time end-date)))))))
  15500. (message "%d entries between %s and %s"
  15501. (org-occur regexp nil callback) start-date end-date)))
  15502. (defun org-evaluate-time-range (&optional to-buffer)
  15503. "Evaluate a time range by computing the difference between start and end.
  15504. Normally the result is just printed in the echo area, but with prefix arg
  15505. TO-BUFFER, the result is inserted just after the date stamp into the buffer.
  15506. If the time range is actually in a table, the result is inserted into the
  15507. next column.
  15508. For time difference computation, a year is assumed to be exactly 365
  15509. days in order to avoid rounding problems."
  15510. (interactive "P")
  15511. (or
  15512. (org-clock-update-time-maybe)
  15513. (save-excursion
  15514. (unless (org-at-date-range-p t)
  15515. (goto-char (point-at-bol))
  15516. (re-search-forward org-tr-regexp-both (point-at-eol) t))
  15517. (if (not (org-at-date-range-p t))
  15518. (user-error "Not at a time-stamp range, and none found in current line")))
  15519. (let* ((ts1 (match-string 1))
  15520. (ts2 (match-string 2))
  15521. (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
  15522. (match-end (match-end 0))
  15523. (time1 (org-time-string-to-time ts1))
  15524. (time2 (org-time-string-to-time ts2))
  15525. (t1 (org-float-time time1))
  15526. (t2 (org-float-time time2))
  15527. (diff (abs (- t2 t1)))
  15528. (negative (< (- t2 t1) 0))
  15529. ;; (ys (floor (* 365 24 60 60)))
  15530. (ds (* 24 60 60))
  15531. (hs (* 60 60))
  15532. (fy "%dy %dd %02d:%02d")
  15533. (fy1 "%dy %dd")
  15534. (fd "%dd %02d:%02d")
  15535. (fd1 "%dd")
  15536. (fh "%02d:%02d")
  15537. y d h m align)
  15538. (if havetime
  15539. (setq ; y (floor (/ diff ys)) diff (mod diff ys)
  15540. y 0
  15541. d (floor (/ diff ds)) diff (mod diff ds)
  15542. h (floor (/ diff hs)) diff (mod diff hs)
  15543. m (floor (/ diff 60)))
  15544. (setq ; y (floor (/ diff ys)) diff (mod diff ys)
  15545. y 0
  15546. d (floor (+ (/ diff ds) 0.5))
  15547. h 0 m 0))
  15548. (if (not to-buffer)
  15549. (message "%s" (org-make-tdiff-string y d h m))
  15550. (if (org-at-table-p)
  15551. (progn
  15552. (goto-char match-end)
  15553. (setq align t)
  15554. (and (looking-at " *|") (goto-char (match-end 0))))
  15555. (goto-char match-end))
  15556. (if (looking-at
  15557. "\\( *-? *[0-9]+y\\)?\\( *[0-9]+d\\)? *[0-9][0-9]:[0-9][0-9]")
  15558. (replace-match ""))
  15559. (if negative (insert " -"))
  15560. (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
  15561. (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
  15562. (insert " " (format fh h m))))
  15563. (if align (org-table-align))
  15564. (message "Time difference inserted")))))
  15565. (defun org-make-tdiff-string (y d h m)
  15566. (let ((fmt "")
  15567. (l nil))
  15568. (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
  15569. l (push y l)))
  15570. (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
  15571. l (push d l)))
  15572. (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
  15573. l (push h l)))
  15574. (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
  15575. l (push m l)))
  15576. (apply 'format fmt (nreverse l))))
  15577. (defun org-time-string-to-time (s &optional buffer pos)
  15578. "Convert a timestamp string into internal time."
  15579. (condition-case errdata
  15580. (apply 'encode-time (org-parse-time-string s))
  15581. (error (error "Bad timestamp `%s'%s\nError was: %s"
  15582. s (if (not (and buffer pos))
  15583. ""
  15584. (format " at %d in buffer `%s'" pos buffer))
  15585. (cdr errdata)))))
  15586. (defun org-time-string-to-seconds (s)
  15587. "Convert a timestamp string to a number of seconds."
  15588. (org-float-time (org-time-string-to-time s)))
  15589. (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
  15590. "Convert a time stamp to an absolute day number.
  15591. If there is a specifier for a cyclic time stamp, get the closest
  15592. date to DAYNR.
  15593. PREFER and SHOW-ALL are passed through to `org-closest-date'.
  15594. The variable `date' is bound by the calendar when this is called."
  15595. (cond
  15596. ((and daynr (string-match "\\`%%\\((.*)\\)" s))
  15597. (if (org-diary-sexp-entry (match-string 1 s) "" date)
  15598. daynr
  15599. (+ daynr 1000)))
  15600. ((and daynr (string-match "\\+[0-9]+[hdwmy]" s))
  15601. (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
  15602. (time-to-days (current-time))) (match-string 0 s)
  15603. prefer show-all))
  15604. (t (time-to-days
  15605. (condition-case errdata
  15606. (apply 'encode-time (org-parse-time-string s))
  15607. (error (error "Bad timestamp `%s'%s\nError was: %s"
  15608. s (if (not (and buffer pos))
  15609. ""
  15610. (format " at %d in buffer `%s'" pos buffer))
  15611. (cdr errdata))))))))
  15612. (defun org-days-to-iso-week (days)
  15613. "Return the iso week number."
  15614. (require 'cal-iso)
  15615. (car (calendar-iso-from-absolute days)))
  15616. (defun org-small-year-to-year (year)
  15617. "Convert 2-digit years into 4-digit years.
  15618. 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2037.
  15619. The year 2000 cannot be abbreviated. Any year larger than 99
  15620. is returned unchanged."
  15621. (if (< year 38)
  15622. (setq year (+ 2000 year))
  15623. (if (< year 100)
  15624. (setq year (+ 1900 year))))
  15625. year)
  15626. (defun org-time-from-absolute (d)
  15627. "Return the time corresponding to date D.
  15628. D may be an absolute day number, or a calendar-type list (month day year)."
  15629. (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
  15630. (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
  15631. (defun org-calendar-holiday ()
  15632. "List of holidays, for Diary display in Org-mode."
  15633. (require 'holidays)
  15634. (let ((hl (funcall
  15635. (if (fboundp 'calendar-check-holidays)
  15636. 'calendar-check-holidays 'check-calendar-holidays) date)))
  15637. (if hl (mapconcat 'identity hl "; "))))
  15638. (defun org-diary-sexp-entry (sexp entry date)
  15639. "Process a SEXP diary ENTRY for DATE."
  15640. (require 'diary-lib)
  15641. (let ((result (if calendar-debug-sexp
  15642. (let ((stack-trace-on-error t))
  15643. (eval (car (read-from-string sexp))))
  15644. (condition-case nil
  15645. (eval (car (read-from-string sexp)))
  15646. (error
  15647. (beep)
  15648. (message "Bad sexp at line %d in %s: %s"
  15649. (org-current-line)
  15650. (buffer-file-name) sexp)
  15651. (sleep-for 2))))))
  15652. (cond ((stringp result) (split-string result "; "))
  15653. ((and (consp result)
  15654. (not (consp (cdr result)))
  15655. (stringp (cdr result))) (cdr result))
  15656. ((and (consp result)
  15657. (stringp (car result))) result)
  15658. (result entry))))
  15659. (defun org-diary-to-ical-string (frombuf)
  15660. "Get iCalendar entries from diary entries in buffer FROMBUF.
  15661. This uses the icalendar.el library."
  15662. (let* ((tmpdir (if (featurep 'xemacs)
  15663. (temp-directory)
  15664. temporary-file-directory))
  15665. (tmpfile (make-temp-name
  15666. (expand-file-name "orgics" tmpdir)))
  15667. buf rtn b e)
  15668. (with-current-buffer frombuf
  15669. (icalendar-export-region (point-min) (point-max) tmpfile)
  15670. (setq buf (find-buffer-visiting tmpfile))
  15671. (set-buffer buf)
  15672. (goto-char (point-min))
  15673. (if (re-search-forward "^BEGIN:VEVENT" nil t)
  15674. (setq b (match-beginning 0)))
  15675. (goto-char (point-max))
  15676. (if (re-search-backward "^END:VEVENT" nil t)
  15677. (setq e (match-end 0)))
  15678. (setq rtn (if (and b e) (concat (buffer-substring b e) "\n") "")))
  15679. (kill-buffer buf)
  15680. (delete-file tmpfile)
  15681. rtn))
  15682. (defun org-closest-date (start current change prefer show-all)
  15683. "Find the date closest to CURRENT that is consistent with START and CHANGE.
  15684. When PREFER is `past', return a date that is either CURRENT or past.
  15685. When PREFER is `future', return a date that is either CURRENT or future.
  15686. When SHOW-ALL is nil, only return the current occurrence of a time stamp."
  15687. ;; Make the proper lists from the dates
  15688. (catch 'exit
  15689. (let ((a1 '(("h" . hour)
  15690. ("d" . day)
  15691. ("w" . week)
  15692. ("m" . month)
  15693. ("y" . year)))
  15694. (shour (nth 2 (org-parse-time-string start)))
  15695. dn dw sday cday n1 n2 n0
  15696. d m y y1 y2 date1 date2 nmonths nm ny m2)
  15697. (setq start (org-date-to-gregorian start)
  15698. current (org-date-to-gregorian
  15699. (if show-all
  15700. current
  15701. (time-to-days (current-time))))
  15702. sday (calendar-absolute-from-gregorian start)
  15703. cday (calendar-absolute-from-gregorian current))
  15704. (if (<= cday sday) (throw 'exit sday))
  15705. (if (string-match "\\(\\+[0-9]+\\)\\([hdwmy]\\)" change)
  15706. (setq dn (string-to-number (match-string 1 change))
  15707. dw (cdr (assoc (match-string 2 change) a1)))
  15708. (user-error "Invalid change specifier: %s" change))
  15709. (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
  15710. (cond
  15711. ((eq dw 'hour)
  15712. (let ((missing-hours
  15713. (mod (+ (- (* 24 (- cday sday)) shour) org-extend-today-until)
  15714. dn)))
  15715. (setq n1 (if (zerop missing-hours) cday
  15716. (- cday (1+ (floor (/ missing-hours 24)))))
  15717. n2 (+ cday (floor (/ (- dn missing-hours) 24))))))
  15718. ((eq dw 'day)
  15719. (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
  15720. n2 (+ n1 dn)))
  15721. ((eq dw 'year)
  15722. (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
  15723. (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
  15724. (setq date1 (list m d y1)
  15725. n1 (calendar-absolute-from-gregorian date1)
  15726. date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
  15727. n2 (calendar-absolute-from-gregorian date2)))
  15728. ((eq dw 'month)
  15729. ;; approx number of month between the two dates
  15730. (setq nmonths (floor (/ (- cday sday) 30.436875)))
  15731. ;; How often does dn fit in there?
  15732. (setq d (nth 1 start) m (car start) y (nth 2 start)
  15733. nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
  15734. m (+ m nm)
  15735. ny (floor (/ m 12))
  15736. y (+ y ny)
  15737. m (- m (* ny 12)))
  15738. (while (> m 12) (setq m (- m 12) y (1+ y)))
  15739. (setq n1 (calendar-absolute-from-gregorian (list m d y)))
  15740. (setq m2 (+ m dn) y2 y)
  15741. (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
  15742. (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
  15743. (while (<= n2 cday)
  15744. (setq n1 n2 m m2 y y2)
  15745. (setq m2 (+ m dn) y2 y)
  15746. (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
  15747. (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
  15748. ;; Make sure n1 is the earlier date
  15749. (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
  15750. (if show-all
  15751. (cond
  15752. ((eq prefer 'past) (if (= cday n2) n2 n1))
  15753. ((eq prefer 'future) (if (= cday n1) n1 n2))
  15754. (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
  15755. (cond
  15756. ((eq prefer 'past) (if (= cday n2) n2 n1))
  15757. ((eq prefer 'future) (if (= cday n1) n1 n2))
  15758. (t (if (= cday n1) n1 n2)))))))
  15759. (defun org-date-to-gregorian (date)
  15760. "Turn any specification of DATE into a Gregorian date for the calendar."
  15761. (cond ((integerp date) (calendar-gregorian-from-absolute date))
  15762. ((and (listp date) (= (length date) 3)) date)
  15763. ((stringp date)
  15764. (setq date (org-parse-time-string date))
  15765. (list (nth 4 date) (nth 3 date) (nth 5 date)))
  15766. ((listp date)
  15767. (list (nth 4 date) (nth 3 date) (nth 5 date)))))
  15768. (defun org-parse-time-string (s &optional nodefault)
  15769. "Parse the standard Org-mode time string.
  15770. This should be a lot faster than the normal `parse-time-string'.
  15771. If time is not given, defaults to 0:00. However, with optional NODEFAULT,
  15772. hour and minute fields will be nil if not given."
  15773. (cond ((string-match org-ts-regexp0 s)
  15774. (list 0
  15775. (if (or (match-beginning 8) (not nodefault))
  15776. (string-to-number (or (match-string 8 s) "0")))
  15777. (if (or (match-beginning 7) (not nodefault))
  15778. (string-to-number (or (match-string 7 s) "0")))
  15779. (string-to-number (match-string 4 s))
  15780. (string-to-number (match-string 3 s))
  15781. (string-to-number (match-string 2 s))
  15782. nil nil nil))
  15783. ((string-match "^<[^>]+>$" s)
  15784. (decode-time (seconds-to-time (org-matcher-time s))))
  15785. (t (error "Not a standard Org-mode time string: %s" s))))
  15786. (defun org-timestamp-up (&optional arg)
  15787. "Increase the date item at the cursor by one.
  15788. If the cursor is on the year, change the year. If it is on the month,
  15789. the day or the time, change that.
  15790. With prefix ARG, change by that many units."
  15791. (interactive "p")
  15792. (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
  15793. (defun org-timestamp-down (&optional arg)
  15794. "Decrease the date item at the cursor by one.
  15795. If the cursor is on the year, change the year. If it is on the month,
  15796. the day or the time, change that.
  15797. With prefix ARG, change by that many units."
  15798. (interactive "p")
  15799. (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
  15800. (defun org-timestamp-up-day (&optional arg)
  15801. "Increase the date in the time stamp by one day.
  15802. With prefix ARG, change that many days."
  15803. (interactive "p")
  15804. (if (and (not (org-at-timestamp-p t))
  15805. (org-at-heading-p))
  15806. (org-todo 'up)
  15807. (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
  15808. (defun org-timestamp-down-day (&optional arg)
  15809. "Decrease the date in the time stamp by one day.
  15810. With prefix ARG, change that many days."
  15811. (interactive "p")
  15812. (if (and (not (org-at-timestamp-p t))
  15813. (org-at-heading-p))
  15814. (org-todo 'down)
  15815. (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
  15816. (defun org-at-timestamp-p (&optional inactive-ok)
  15817. "Determine if the cursor is in or at a timestamp."
  15818. (interactive)
  15819. (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
  15820. (pos (point))
  15821. (ans (or (looking-at tsr)
  15822. (save-excursion
  15823. (skip-chars-backward "^[<\n\r\t")
  15824. (if (> (point) (point-min)) (backward-char 1))
  15825. (and (looking-at tsr)
  15826. (> (- (match-end 0) pos) -1))))))
  15827. (and ans
  15828. (boundp 'org-ts-what)
  15829. (setq org-ts-what
  15830. (cond
  15831. ((= pos (match-beginning 0)) 'bracket)
  15832. ;; Point is considered to be "on the bracket" whether
  15833. ;; it's really on it or right after it.
  15834. ((= pos (1- (match-end 0))) 'bracket)
  15835. ((= pos (match-end 0)) 'after)
  15836. ((org-pos-in-match-range pos 2) 'year)
  15837. ((org-pos-in-match-range pos 3) 'month)
  15838. ((org-pos-in-match-range pos 7) 'hour)
  15839. ((org-pos-in-match-range pos 8) 'minute)
  15840. ((or (org-pos-in-match-range pos 4)
  15841. (org-pos-in-match-range pos 5)) 'day)
  15842. ((and (> pos (or (match-end 8) (match-end 5)))
  15843. (< pos (match-end 0)))
  15844. (- pos (or (match-end 8) (match-end 5))))
  15845. (t 'day))))
  15846. ans))
  15847. (defun org-toggle-timestamp-type ()
  15848. "Toggle the type (<active> or [inactive]) of a time stamp."
  15849. (interactive)
  15850. (when (org-at-timestamp-p t)
  15851. (let ((beg (match-beginning 0)) (end (match-end 0))
  15852. (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
  15853. (save-excursion
  15854. (goto-char beg)
  15855. (while (re-search-forward "[][<>]" end t)
  15856. (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
  15857. t t)))
  15858. (message "Timestamp is now %sactive"
  15859. (if (equal (char-after beg) ?<) "" "in")))))
  15860. (defun org-at-clock-log-p nil
  15861. "Is the cursor on the clock log line?"
  15862. (save-excursion
  15863. (move-beginning-of-line 1)
  15864. (looking-at "^[ \t]*CLOCK:")))
  15865. (defvar org-clock-history) ; defined in org-clock.el
  15866. (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
  15867. (defun org-timestamp-change (n &optional what updown suppress-tmp-delay)
  15868. "Change the date in the time stamp at point.
  15869. The date will be changed by N times WHAT. WHAT can be `day', `month',
  15870. `year', `minute', `second'. If WHAT is not given, the cursor position
  15871. in the timestamp determines what will be changed.
  15872. When SUPPRESS-TMP-DELAY is non-nil, suppress delays like \"--2d\"."
  15873. (let ((origin (point)) origin-cat
  15874. with-hm inactive
  15875. (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
  15876. org-ts-what
  15877. extra rem
  15878. ts time time0 fixnext clrgx)
  15879. (if (not (org-at-timestamp-p t))
  15880. (user-error "Not at a timestamp"))
  15881. (if (and (not what) (eq org-ts-what 'bracket))
  15882. (org-toggle-timestamp-type)
  15883. ;; Point isn't on brackets. Remember the part of the time-stamp
  15884. ;; the point was in. Indeed, size of time-stamps may change,
  15885. ;; but point must be kept in the same category nonetheless.
  15886. (setq origin-cat org-ts-what)
  15887. (if (and (not what) (not (eq org-ts-what 'day))
  15888. org-display-custom-times
  15889. (get-text-property (point) 'display)
  15890. (not (get-text-property (1- (point)) 'display)))
  15891. (setq org-ts-what 'day))
  15892. (setq org-ts-what (or what org-ts-what)
  15893. inactive (= (char-after (match-beginning 0)) ?\[)
  15894. ts (match-string 0))
  15895. (replace-match "")
  15896. (when (string-match
  15897. "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?-?[-+][0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)*\\)[]>]"
  15898. ts)
  15899. (setq extra (match-string 1 ts))
  15900. (if suppress-tmp-delay
  15901. (setq extra (replace-regexp-in-string " --[0-9]+[hdwmy]" "" extra))))
  15902. (if (string-match "^.\\{10\\}.*?[0-9]+:[0-9][0-9]" ts)
  15903. (setq with-hm t))
  15904. (setq time0 (org-parse-time-string ts))
  15905. (when (and updown
  15906. (eq org-ts-what 'minute)
  15907. (not current-prefix-arg))
  15908. ;; This looks like s-up and s-down. Change by one rounding step.
  15909. (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
  15910. (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
  15911. (setcar (cdr time0) (+ (nth 1 time0)
  15912. (if (> n 0) (- rem) (- dm rem))))))
  15913. (setq time
  15914. (encode-time (or (car time0) 0)
  15915. (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
  15916. (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
  15917. (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
  15918. (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
  15919. (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
  15920. (nthcdr 6 time0)))
  15921. (when (and (member org-ts-what '(hour minute))
  15922. extra
  15923. (string-match "-\\([012][0-9]\\):\\([0-5][0-9]\\)" extra))
  15924. (setq extra (org-modify-ts-extra
  15925. extra
  15926. (if (eq org-ts-what 'hour) 2 5)
  15927. n dm)))
  15928. (when (integerp org-ts-what)
  15929. (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
  15930. (if (eq what 'calendar)
  15931. (let ((cal-date (org-get-date-from-calendar)))
  15932. (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
  15933. (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
  15934. (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
  15935. (setcar time0 (or (car time0) 0))
  15936. (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
  15937. (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
  15938. (setq time (apply 'encode-time time0))))
  15939. ;; Insert the new time-stamp, and ensure point stays in the same
  15940. ;; category as before (i.e. not after the last position in that
  15941. ;; category).
  15942. (let ((pos (point)))
  15943. ;; Stay before inserted string. `save-excursion' is of no use.
  15944. (setq org-last-changed-timestamp
  15945. (org-insert-time-stamp time with-hm inactive nil nil extra))
  15946. (goto-char pos))
  15947. (save-match-data
  15948. (looking-at org-ts-regexp3)
  15949. (goto-char (cond
  15950. ;; `day' category ends before `hour' if any, or at
  15951. ;; the end of the day name.
  15952. ((eq origin-cat 'day)
  15953. (min (or (match-beginning 7) (1- (match-end 5))) origin))
  15954. ((eq origin-cat 'hour) (min (match-end 7) origin))
  15955. ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
  15956. ((integerp origin-cat) (min (1- (match-end 0)) origin))
  15957. ;; `year' and `month' have both fixed size: point
  15958. ;; couldn't have moved into another part.
  15959. (t origin))))
  15960. ;; Update clock if on a CLOCK line.
  15961. (org-clock-update-time-maybe)
  15962. ;; Maybe adjust the closest clock in `org-clock-history'
  15963. (when org-clock-adjust-closest
  15964. (if (not (and (org-at-clock-log-p)
  15965. (< 1 (length (delq nil (mapcar 'marker-position
  15966. org-clock-history))))))
  15967. (message "No clock to adjust")
  15968. (cond ((save-excursion ; fix previous clock?
  15969. (re-search-backward org-ts-regexp0 nil t)
  15970. (org-looking-back (concat org-clock-string " \\[")))
  15971. (setq fixnext 1 clrgx (concat org-ts-regexp0 "\\] =>.*$")))
  15972. ((save-excursion ; fix next clock?
  15973. (re-search-backward org-ts-regexp0 nil t)
  15974. (looking-at (concat org-ts-regexp0 "\\] =>")))
  15975. (setq fixnext -1 clrgx (concat org-clock-string " \\[" org-ts-regexp0))))
  15976. (save-window-excursion
  15977. ;; Find closest clock to point, adjust the previous/next one in history
  15978. (let* ((p (save-excursion (org-back-to-heading t)))
  15979. (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
  15980. (clfixnth
  15981. (+ fixnext (- (length cl) (or (length (member (apply #'min cl) cl)) 100))))
  15982. (clfixpos (if (> 0 clfixnth) nil (nth clfixnth org-clock-history))))
  15983. (if (not clfixpos)
  15984. (message "No clock to adjust")
  15985. (save-excursion
  15986. (org-goto-marker-or-bmk clfixpos)
  15987. (org-show-subtree)
  15988. (when (re-search-forward clrgx nil t)
  15989. (goto-char (match-beginning 1))
  15990. (let (org-clock-adjust-closest)
  15991. (org-timestamp-change n org-ts-what updown))
  15992. (message "Clock adjusted in %s for heading: %s"
  15993. (file-name-nondirectory (buffer-file-name))
  15994. (org-get-heading t t)))))))))
  15995. ;; Try to recenter the calendar window, if any.
  15996. (if (and org-calendar-follow-timestamp-change
  15997. (get-buffer-window "*Calendar*" t)
  15998. (memq org-ts-what '(day month year)))
  15999. (org-recenter-calendar (time-to-days time))))))
  16000. (defun org-modify-ts-extra (s pos n dm)
  16001. "Change the different parts of the lead-time and repeat fields in timestamp."
  16002. (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
  16003. ng h m new rem)
  16004. (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
  16005. (cond
  16006. ((or (org-pos-in-match-range pos 2)
  16007. (org-pos-in-match-range pos 3))
  16008. (setq m (string-to-number (match-string 3 s))
  16009. h (string-to-number (match-string 2 s)))
  16010. (if (org-pos-in-match-range pos 2)
  16011. (setq h (+ h n))
  16012. (setq n (* dm (org-no-warnings (signum n))))
  16013. (when (not (= 0 (setq rem (% m dm))))
  16014. (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
  16015. (setq m (+ m n)))
  16016. (if (< m 0) (setq m (+ m 60) h (1- h)))
  16017. (if (> m 59) (setq m (- m 60) h (1+ h)))
  16018. (setq h (min 24 (max 0 h)))
  16019. (setq ng 1 new (format "-%02d:%02d" h m)))
  16020. ((org-pos-in-match-range pos 6)
  16021. (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
  16022. ((org-pos-in-match-range pos 5)
  16023. (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
  16024. ((org-pos-in-match-range pos 9)
  16025. (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
  16026. ((org-pos-in-match-range pos 8)
  16027. (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
  16028. (when ng
  16029. (setq s (concat
  16030. (substring s 0 (match-beginning ng))
  16031. new
  16032. (substring s (match-end ng))))))
  16033. s))
  16034. (defun org-recenter-calendar (date)
  16035. "If the calendar is visible, recenter it to DATE."
  16036. (let ((cwin (get-buffer-window "*Calendar*" t)))
  16037. (when cwin
  16038. (let ((calendar-move-hook nil))
  16039. (with-selected-window cwin
  16040. (calendar-goto-date (if (listp date) date
  16041. (calendar-gregorian-from-absolute date))))))))
  16042. (defun org-goto-calendar (&optional arg)
  16043. "Go to the Emacs calendar at the current date.
  16044. If there is a time stamp in the current line, go to that date.
  16045. A prefix ARG can be used to force the current date."
  16046. (interactive "P")
  16047. (let ((tsr org-ts-regexp) diff
  16048. (calendar-move-hook nil)
  16049. (calendar-view-holidays-initially-flag nil)
  16050. (calendar-view-diary-initially-flag nil))
  16051. (if (or (org-at-timestamp-p)
  16052. (save-excursion
  16053. (beginning-of-line 1)
  16054. (looking-at (concat ".*" tsr))))
  16055. (let ((d1 (time-to-days (current-time)))
  16056. (d2 (time-to-days
  16057. (org-time-string-to-time (match-string 1)))))
  16058. (setq diff (- d2 d1))))
  16059. (calendar)
  16060. (calendar-goto-today)
  16061. (if (and diff (not arg)) (calendar-forward-day diff))))
  16062. (defun org-get-date-from-calendar ()
  16063. "Return a list (month day year) of date at point in calendar."
  16064. (with-current-buffer "*Calendar*"
  16065. (save-match-data
  16066. (calendar-cursor-to-date))))
  16067. (defun org-date-from-calendar ()
  16068. "Insert time stamp corresponding to cursor date in *Calendar* buffer.
  16069. If there is already a time stamp at the cursor position, update it."
  16070. (interactive)
  16071. (if (org-at-timestamp-p t)
  16072. (org-timestamp-change 0 'calendar)
  16073. (let ((cal-date (org-get-date-from-calendar)))
  16074. (org-insert-time-stamp
  16075. (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
  16076. (defcustom org-effort-durations
  16077. `(("h" . 60)
  16078. ("d" . ,(* 60 8))
  16079. ("w" . ,(* 60 8 5))
  16080. ("m" . ,(* 60 8 5 4))
  16081. ("y" . ,(* 60 8 5 40)))
  16082. "Conversion factor to minutes for an effort modifier.
  16083. Each entry has the form (MODIFIER . MINUTES).
  16084. In an effort string, a number followed by MODIFIER is multiplied
  16085. by the specified number of MINUTES to obtain an effort in
  16086. minutes.
  16087. For example, if the value of this variable is ((\"hours\" . 60)), then an
  16088. effort string \"2hours\" is equivalent to 120 minutes."
  16089. :group 'org-agenda
  16090. :version "24.1"
  16091. :type '(alist :key-type (string :tag "Modifier")
  16092. :value-type (number :tag "Minutes")))
  16093. (defun org-minutes-to-clocksum-string (m)
  16094. "Format number of minutes as a clocksum string.
  16095. The format is determined by `org-time-clocksum-format',
  16096. `org-time-clocksum-use-fractional' and
  16097. `org-time-clocksum-fractional-format' and
  16098. `org-time-clocksum-use-effort-durations'."
  16099. (let ((clocksum "")
  16100. (m (round m)) ; Don't allow fractions of minutes
  16101. h d w mo y fmt n)
  16102. (setq h (if org-time-clocksum-use-effort-durations
  16103. (cdr (assoc "h" org-effort-durations)) 60)
  16104. d (if org-time-clocksum-use-effort-durations
  16105. (/ (cdr (assoc "d" org-effort-durations)) h) 24)
  16106. w (if org-time-clocksum-use-effort-durations
  16107. (/ (cdr (assoc "w" org-effort-durations)) (* d h)) 7)
  16108. mo (if org-time-clocksum-use-effort-durations
  16109. (/ (cdr (assoc "m" org-effort-durations)) (* d h)) 30)
  16110. y (if org-time-clocksum-use-effort-durations
  16111. (/ (cdr (assoc "y" org-effort-durations)) (* d h)) 365))
  16112. ;; fractional format
  16113. (if org-time-clocksum-use-fractional
  16114. (cond
  16115. ;; single format string
  16116. ((stringp org-time-clocksum-fractional-format)
  16117. (format org-time-clocksum-fractional-format (/ m (float h))))
  16118. ;; choice of fractional formats for different time units
  16119. ((and (setq fmt (plist-get org-time-clocksum-fractional-format :years))
  16120. (> (/ (truncate m) (* y d h)) 0))
  16121. (format fmt (/ m (* y d (float h)))))
  16122. ((and (setq fmt (plist-get org-time-clocksum-fractional-format :months))
  16123. (> (/ (truncate m) (* mo d h)) 0))
  16124. (format fmt (/ m (* mo d (float h)))))
  16125. ((and (setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
  16126. (> (/ (truncate m) (* w d h)) 0))
  16127. (format fmt (/ m (* w d (float h)))))
  16128. ((and (setq fmt (plist-get org-time-clocksum-fractional-format :days))
  16129. (> (/ (truncate m) (* d h)) 0))
  16130. (format fmt (/ m (* d (float h)))))
  16131. ((and (setq fmt (plist-get org-time-clocksum-fractional-format :hours))
  16132. (> (/ (truncate m) h) 0))
  16133. (format fmt (/ m (float h))))
  16134. ((setq fmt (plist-get org-time-clocksum-fractional-format :minutes))
  16135. (format fmt m))
  16136. ;; fall back to smallest time unit with a format
  16137. ((setq fmt (plist-get org-time-clocksum-fractional-format :hours))
  16138. (format fmt (/ m (float h))))
  16139. ((setq fmt (plist-get org-time-clocksum-fractional-format :days))
  16140. (format fmt (/ m (* d (float h)))))
  16141. ((setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
  16142. (format fmt (/ m (* w d (float h)))))
  16143. ((setq fmt (plist-get org-time-clocksum-fractional-format :months))
  16144. (format fmt (/ m (* mo d (float h)))))
  16145. ((setq fmt (plist-get org-time-clocksum-fractional-format :years))
  16146. (format fmt (/ m (* y d (float h))))))
  16147. ;; standard (non-fractional) format, with single format string
  16148. (if (stringp org-time-clocksum-format)
  16149. (format org-time-clocksum-format (setq n (/ m h)) (- m (* h n)))
  16150. ;; separate formats components
  16151. (and (setq fmt (plist-get org-time-clocksum-format :years))
  16152. (or (> (setq n (/ (truncate m) (* y d h))) 0)
  16153. (plist-get org-time-clocksum-format :require-years))
  16154. (setq clocksum (concat clocksum (format fmt n))
  16155. m (- m (* n y d h))))
  16156. (and (setq fmt (plist-get org-time-clocksum-format :months))
  16157. (or (> (setq n (/ (truncate m) (* mo d h))) 0)
  16158. (plist-get org-time-clocksum-format :require-months))
  16159. (setq clocksum (concat clocksum (format fmt n))
  16160. m (- m (* n mo d h))))
  16161. (and (setq fmt (plist-get org-time-clocksum-format :weeks))
  16162. (or (> (setq n (/ (truncate m) (* w d h))) 0)
  16163. (plist-get org-time-clocksum-format :require-weeks))
  16164. (setq clocksum (concat clocksum (format fmt n))
  16165. m (- m (* n w d h))))
  16166. (and (setq fmt (plist-get org-time-clocksum-format :days))
  16167. (or (> (setq n (/ (truncate m) (* d h))) 0)
  16168. (plist-get org-time-clocksum-format :require-days))
  16169. (setq clocksum (concat clocksum (format fmt n))
  16170. m (- m (* n d h))))
  16171. (and (setq fmt (plist-get org-time-clocksum-format :hours))
  16172. (or (> (setq n (/ (truncate m) h)) 0)
  16173. (plist-get org-time-clocksum-format :require-hours))
  16174. (setq clocksum (concat clocksum (format fmt n))
  16175. m (- m (* n h))))
  16176. (and (setq fmt (plist-get org-time-clocksum-format :minutes))
  16177. (or (> m 0) (plist-get org-time-clocksum-format :require-minutes))
  16178. (setq clocksum (concat clocksum (format fmt m))))
  16179. ;; return formatted time duration
  16180. clocksum))))
  16181. (defalias 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string)
  16182. (make-obsolete 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string
  16183. "Org mode version 8.0")
  16184. (defun org-hours-to-clocksum-string (n)
  16185. (org-minutes-to-clocksum-string (* n 60)))
  16186. (defun org-hh:mm-string-to-minutes (s)
  16187. "Convert a string H:MM to a number of minutes.
  16188. If the string is just a number, interpret it as minutes.
  16189. In fact, the first hh:mm or number in the string will be taken,
  16190. there can be extra stuff in the string.
  16191. If no number is found, the return value is 0."
  16192. (cond
  16193. ((integerp s) s)
  16194. ((string-match "\\([0-9]+\\):\\([0-9]+\\)" s)
  16195. (+ (* (string-to-number (match-string 1 s)) 60)
  16196. (string-to-number (match-string 2 s))))
  16197. ((string-match "\\([0-9]+\\)" s)
  16198. (string-to-number (match-string 1 s)))
  16199. (t 0)))
  16200. (defcustom org-image-actual-width t
  16201. "Should we use the actual width of images when inlining them?
  16202. When set to `t', always use the image width.
  16203. When set to a number, use imagemagick (when available) to set
  16204. the image's width to this value.
  16205. When set to a number in a list, try to get the width from any
  16206. #+ATTR.* keyword if it matches a width specification like
  16207. #+ATTR_HTML: :width 300px
  16208. and fall back on that number if none is found.
  16209. When set to nil, try to get the width from an #+ATTR.* keyword
  16210. and fall back on the original width if none is found.
  16211. This requires Emacs >= 24.1, build with imagemagick support."
  16212. :group 'org-appearance
  16213. :version "24.4"
  16214. :package-version '(Org . "8.0")
  16215. :type '(choice
  16216. (const :tag "Use the image width" t)
  16217. (integer :tag "Use a number of pixels")
  16218. (list :tag "Use #+ATTR* or a number of pixels" (integer))
  16219. (const :tag "Use #+ATTR* or don't resize" nil)))
  16220. (defcustom org-agenda-inhibit-startup nil
  16221. "Inhibit startup when preparing agenda buffers.
  16222. When this variable is `t' (the default), the initialization of
  16223. the Org agenda buffers is inhibited: e.g. the visibility state
  16224. is not set, the tables are not re-aligned, etc."
  16225. :type 'boolean
  16226. :version "24.3"
  16227. :group 'org-agenda)
  16228. (defcustom org-agenda-ignore-drawer-properties nil
  16229. "Avoid updating text properties when building the agenda.
  16230. Properties are used to prepare buffers for effort estimates, appointments,
  16231. and subtree-local categories.
  16232. If you don't use these in the agenda, you can add them to this list and
  16233. agenda building will be a bit faster.
  16234. The value is a list, with zero or more of the symbols `effort', `appt',
  16235. or `category'."
  16236. :type '(set :greedy t
  16237. (const effort)
  16238. (const appt)
  16239. (const category))
  16240. :version "24.3"
  16241. :group 'org-agenda)
  16242. (defun org-duration-string-to-minutes (s &optional output-to-string)
  16243. "Convert a duration string S to minutes.
  16244. A bare number is interpreted as minutes, modifiers can be set by
  16245. customizing `org-effort-durations' (which see).
  16246. Entries containing a colon are interpreted as H:MM by
  16247. `org-hh:mm-string-to-minutes'."
  16248. (let ((result 0)
  16249. (re (concat "\\([0-9.]+\\) *\\("
  16250. (regexp-opt (mapcar 'car org-effort-durations))
  16251. "\\)")))
  16252. (while (string-match re s)
  16253. (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
  16254. (string-to-number (match-string 1 s))))
  16255. (setq s (replace-match "" nil t s)))
  16256. (setq result (floor result))
  16257. (incf result (org-hh:mm-string-to-minutes s))
  16258. (if output-to-string (number-to-string result) result)))
  16259. ;;;; Files
  16260. (defun org-save-all-org-buffers ()
  16261. "Save all Org-mode buffers without user confirmation."
  16262. (interactive)
  16263. (message "Saving all Org-mode buffers...")
  16264. (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
  16265. (when (featurep 'org-id) (org-id-locations-save))
  16266. (message "Saving all Org-mode buffers... done"))
  16267. (defun org-revert-all-org-buffers ()
  16268. "Revert all Org-mode buffers.
  16269. Prompt for confirmation when there are unsaved changes.
  16270. Be sure you know what you are doing before letting this function
  16271. overwrite your changes.
  16272. This function is useful in a setup where one tracks org files
  16273. with a version control system, to revert on one machine after pulling
  16274. changes from another. I believe the procedure must be like this:
  16275. 1. M-x org-save-all-org-buffers
  16276. 2. Pull changes from the other machine, resolve conflicts
  16277. 3. M-x org-revert-all-org-buffers"
  16278. (interactive)
  16279. (unless (yes-or-no-p "Revert all Org buffers from their files? ")
  16280. (user-error "Abort"))
  16281. (save-excursion
  16282. (save-window-excursion
  16283. (mapc
  16284. (lambda (b)
  16285. (when (and (with-current-buffer b (derived-mode-p 'org-mode))
  16286. (with-current-buffer b buffer-file-name))
  16287. (org-pop-to-buffer-same-window b)
  16288. (revert-buffer t 'no-confirm)))
  16289. (buffer-list))
  16290. (when (and (featurep 'org-id) org-id-track-globally)
  16291. (org-id-locations-load)))))
  16292. ;;;; Agenda files
  16293. ;;;###autoload
  16294. (defun org-switchb (&optional arg)
  16295. "Switch between Org buffers.
  16296. With one prefix argument, restrict available buffers to files.
  16297. With two prefix arguments, restrict available buffers to agenda files.
  16298. Defaults to `iswitchb' for buffer name completion.
  16299. Set `org-completion-use-ido' to make it use ido instead."
  16300. (interactive "P")
  16301. (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
  16302. ((equal arg '(16)) (org-buffer-list 'agenda))
  16303. (t (org-buffer-list))))
  16304. (org-completion-use-iswitchb org-completion-use-iswitchb)
  16305. (org-completion-use-ido org-completion-use-ido))
  16306. (unless (or org-completion-use-ido org-completion-use-iswitchb)
  16307. (setq org-completion-use-iswitchb t))
  16308. (org-pop-to-buffer-same-window
  16309. (org-icompleting-read "Org buffer: "
  16310. (mapcar 'list (mapcar 'buffer-name blist))
  16311. nil t))))
  16312. ;;; Define some older names previously used for this functionality
  16313. ;;;###autoload
  16314. (defalias 'org-ido-switchb 'org-switchb)
  16315. ;;;###autoload
  16316. (defalias 'org-iswitchb 'org-switchb)
  16317. (defun org-buffer-list (&optional predicate exclude-tmp)
  16318. "Return a list of Org buffers.
  16319. PREDICATE can be `export', `files' or `agenda'.
  16320. export restrict the list to Export buffers.
  16321. files restrict the list to buffers visiting Org files.
  16322. agenda restrict the list to buffers visiting agenda files.
  16323. If EXCLUDE-TMP is non-nil, ignore temporary buffers."
  16324. (let* ((bfn nil)
  16325. (agenda-files (and (eq predicate 'agenda)
  16326. (mapcar 'file-truename (org-agenda-files t))))
  16327. (filter
  16328. (cond
  16329. ((eq predicate 'files)
  16330. (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
  16331. ((eq predicate 'export)
  16332. (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
  16333. ((eq predicate 'agenda)
  16334. (lambda (b)
  16335. (with-current-buffer b
  16336. (and (derived-mode-p 'org-mode)
  16337. (setq bfn (buffer-file-name b))
  16338. (member (file-truename bfn) agenda-files)))))
  16339. (t (lambda (b) (with-current-buffer b
  16340. (or (derived-mode-p 'org-mode)
  16341. (string-match "\*Org .*Export"
  16342. (buffer-name b)))))))))
  16343. (delq nil
  16344. (mapcar
  16345. (lambda(b)
  16346. (if (and (funcall filter b)
  16347. (or (not exclude-tmp)
  16348. (not (string-match "tmp" (buffer-name b)))))
  16349. b
  16350. nil))
  16351. (buffer-list)))))
  16352. (defun org-agenda-files (&optional unrestricted archives)
  16353. "Get the list of agenda files.
  16354. Optional UNRESTRICTED means return the full list even if a restriction
  16355. is currently in place.
  16356. When ARCHIVES is t, include all archive files that are really being
  16357. used by the agenda files. If ARCHIVE is `ifmode', do this only if
  16358. `org-agenda-archives-mode' is t."
  16359. (let ((files
  16360. (cond
  16361. ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
  16362. ((stringp org-agenda-files) (org-read-agenda-file-list))
  16363. ((listp org-agenda-files) org-agenda-files)
  16364. (t (error "Invalid value of `org-agenda-files'")))))
  16365. (setq files (apply 'append
  16366. (mapcar (lambda (f)
  16367. (if (file-directory-p f)
  16368. (directory-files
  16369. f t org-agenda-file-regexp)
  16370. (list f)))
  16371. files)))
  16372. (when org-agenda-skip-unavailable-files
  16373. (setq files (delq nil
  16374. (mapcar (function
  16375. (lambda (file)
  16376. (and (file-readable-p file) file)))
  16377. files))))
  16378. (when (or (eq archives t)
  16379. (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
  16380. (setq files (org-add-archive-files files)))
  16381. files))
  16382. (defun org-agenda-file-p (&optional file)
  16383. "Return non-nil, if FILE is an agenda file.
  16384. If FILE is omitted, use the file associated with the current
  16385. buffer."
  16386. (member (or file (buffer-file-name))
  16387. (org-agenda-files t)))
  16388. (defun org-edit-agenda-file-list ()
  16389. "Edit the list of agenda files.
  16390. Depending on setup, this either uses customize to edit the variable
  16391. `org-agenda-files', or it visits the file that is holding the list. In the
  16392. latter case, the buffer is set up in a way that saving it automatically kills
  16393. the buffer and restores the previous window configuration."
  16394. (interactive)
  16395. (if (stringp org-agenda-files)
  16396. (let ((cw (current-window-configuration)))
  16397. (find-file org-agenda-files)
  16398. (org-set-local 'org-window-configuration cw)
  16399. (org-add-hook 'after-save-hook
  16400. (lambda ()
  16401. (set-window-configuration
  16402. (prog1 org-window-configuration
  16403. (kill-buffer (current-buffer))))
  16404. (org-install-agenda-files-menu)
  16405. (message "New agenda file list installed"))
  16406. nil 'local)
  16407. (message "%s" (substitute-command-keys
  16408. "Edit list and finish with \\[save-buffer]")))
  16409. (customize-variable 'org-agenda-files)))
  16410. (defun org-store-new-agenda-file-list (list)
  16411. "Set new value for the agenda file list and save it correctly."
  16412. (if (stringp org-agenda-files)
  16413. (let ((fe (org-read-agenda-file-list t)) b u)
  16414. (while (setq b (find-buffer-visiting org-agenda-files))
  16415. (kill-buffer b))
  16416. (with-temp-file org-agenda-files
  16417. (insert
  16418. (mapconcat
  16419. (lambda (f) ;; Keep un-expanded entries.
  16420. (if (setq u (assoc f fe))
  16421. (cdr u)
  16422. f))
  16423. list "\n")
  16424. "\n")))
  16425. (let ((org-mode-hook nil) (org-inhibit-startup t)
  16426. (org-insert-mode-line-in-empty-file nil))
  16427. (setq org-agenda-files list)
  16428. (customize-save-variable 'org-agenda-files org-agenda-files))))
  16429. (defun org-read-agenda-file-list (&optional pair-with-expansion)
  16430. "Read the list of agenda files from a file.
  16431. If PAIR-WITH-EXPANSION is t return pairs with un-expanded
  16432. filenames, used by `org-store-new-agenda-file-list' to write back
  16433. un-expanded file names."
  16434. (when (file-directory-p org-agenda-files)
  16435. (error "`org-agenda-files' cannot be a single directory"))
  16436. (when (stringp org-agenda-files)
  16437. (with-temp-buffer
  16438. (insert-file-contents org-agenda-files)
  16439. (mapcar
  16440. (lambda (f)
  16441. (let ((e (expand-file-name (substitute-in-file-name f)
  16442. org-directory)))
  16443. (if pair-with-expansion
  16444. (cons e f)
  16445. e)))
  16446. (org-split-string (buffer-string) "[ \t\r\n]*?[\r\n][ \t\r\n]*")))))
  16447. ;;;###autoload
  16448. (defun org-cycle-agenda-files ()
  16449. "Cycle through the files in `org-agenda-files'.
  16450. If the current buffer visits an agenda file, find the next one in the list.
  16451. If the current buffer does not, find the first agenda file."
  16452. (interactive)
  16453. (let* ((fs (org-agenda-files t))
  16454. (files (append fs (list (car fs))))
  16455. (tcf (if buffer-file-name (file-truename buffer-file-name)))
  16456. file)
  16457. (unless files (user-error "No agenda files"))
  16458. (catch 'exit
  16459. (while (setq file (pop files))
  16460. (if (equal (file-truename file) tcf)
  16461. (when (car files)
  16462. (find-file (car files))
  16463. (throw 'exit t))))
  16464. (find-file (car fs)))
  16465. (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
  16466. (defun org-agenda-file-to-front (&optional to-end)
  16467. "Move/add the current file to the top of the agenda file list.
  16468. If the file is not present in the list, it is added to the front. If it is
  16469. present, it is moved there. With optional argument TO-END, add/move to the
  16470. end of the list."
  16471. (interactive "P")
  16472. (let ((org-agenda-skip-unavailable-files nil)
  16473. (file-alist (mapcar (lambda (x)
  16474. (cons (file-truename x) x))
  16475. (org-agenda-files t)))
  16476. (ctf (file-truename
  16477. (or buffer-file-name
  16478. (user-error "Please save the current buffer to a file"))))
  16479. x had)
  16480. (setq x (assoc ctf file-alist) had x)
  16481. (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
  16482. (if to-end
  16483. (setq file-alist (append (delq x file-alist) (list x)))
  16484. (setq file-alist (cons x (delq x file-alist))))
  16485. (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
  16486. (org-install-agenda-files-menu)
  16487. (message "File %s to %s of agenda file list"
  16488. (if had "moved" "added") (if to-end "end" "front"))))
  16489. (defun org-remove-file (&optional file)
  16490. "Remove current file from the list of files in variable `org-agenda-files'.
  16491. These are the files which are being checked for agenda entries.
  16492. Optional argument FILE means use this file instead of the current."
  16493. (interactive)
  16494. (let* ((org-agenda-skip-unavailable-files nil)
  16495. (file (or file buffer-file-name
  16496. (user-error "Current buffer does not visit a file")))
  16497. (true-file (file-truename file))
  16498. (afile (abbreviate-file-name file))
  16499. (files (delq nil (mapcar
  16500. (lambda (x)
  16501. (if (equal true-file
  16502. (file-truename x))
  16503. nil x))
  16504. (org-agenda-files t)))))
  16505. (if (not (= (length files) (length (org-agenda-files t))))
  16506. (progn
  16507. (org-store-new-agenda-file-list files)
  16508. (org-install-agenda-files-menu)
  16509. (message "Removed file: %s" afile))
  16510. (message "File was not in list: %s (not removed)" afile))))
  16511. (defun org-file-menu-entry (file)
  16512. (vector file (list 'find-file file) t))
  16513. (defun org-check-agenda-file (file)
  16514. "Make sure FILE exists. If not, ask user what to do."
  16515. (when (not (file-exists-p file))
  16516. (message "Non-existent agenda file %s. [R]emove from list or [A]bort?"
  16517. (abbreviate-file-name file))
  16518. (let ((r (downcase (read-char-exclusive))))
  16519. (cond
  16520. ((equal r ?r)
  16521. (org-remove-file file)
  16522. (throw 'nextfile t))
  16523. (t (error "Abort"))))))
  16524. (defun org-get-agenda-file-buffer (file)
  16525. "Get a buffer visiting FILE. If the buffer needs to be created, add
  16526. it to the list of buffers which might be released later."
  16527. (let ((buf (org-find-base-buffer-visiting file)))
  16528. (if buf
  16529. buf ; just return it
  16530. ;; Make a new buffer and remember it
  16531. (setq buf (find-file-noselect file))
  16532. (if buf (push buf org-agenda-new-buffers))
  16533. buf)))
  16534. (defun org-release-buffers (blist)
  16535. "Release all buffers in list, asking the user for confirmation when needed.
  16536. When a buffer is unmodified, it is just killed. When modified, it is saved
  16537. \(if the user agrees) and then killed."
  16538. (let (buf file)
  16539. (while (setq buf (pop blist))
  16540. (setq file (buffer-file-name buf))
  16541. (when (and (buffer-modified-p buf)
  16542. file
  16543. (y-or-n-p (format "Save file %s? " file)))
  16544. (with-current-buffer buf (save-buffer)))
  16545. (kill-buffer buf))))
  16546. (defun org-agenda-prepare-buffers (files)
  16547. "Create buffers for all agenda files, protect archived trees and comments."
  16548. (interactive)
  16549. (let ((pa '(:org-archived t))
  16550. (pc '(:org-comment t))
  16551. (pall '(:org-archived t :org-comment t))
  16552. (inhibit-read-only t)
  16553. (org-inhibit-startup org-agenda-inhibit-startup)
  16554. (rea (concat ":" org-archive-tag ":"))
  16555. file re)
  16556. (setq org-tag-alist-for-agenda nil
  16557. org-tag-groups-alist-for-agenda nil)
  16558. (save-excursion
  16559. (save-restriction
  16560. (while (setq file (pop files))
  16561. (catch 'nextfile
  16562. (if (bufferp file)
  16563. (set-buffer file)
  16564. (org-check-agenda-file file)
  16565. (set-buffer (org-get-agenda-file-buffer file)))
  16566. (widen)
  16567. (org-set-regexps-and-options-for-tags)
  16568. (goto-char (point-min))
  16569. (let ((case-fold-search t))
  16570. (when (search-forward "#+setupfile" nil t)
  16571. ;; Don't set all regexps and options systematically as
  16572. ;; this is only run for setting agenda tags from setup
  16573. ;; file
  16574. (org-set-regexps-and-options)))
  16575. (or (memq 'category org-agenda-ignore-drawer-properties)
  16576. (org-refresh-category-properties))
  16577. (or (memq 'effort org-agenda-ignore-drawer-properties)
  16578. (org-refresh-properties org-effort-property 'org-effort))
  16579. (or (memq 'appt org-agenda-ignore-drawer-properties)
  16580. (org-refresh-properties "APPT_WARNTIME" 'org-appt-warntime))
  16581. (setq org-todo-keywords-for-agenda
  16582. (append org-todo-keywords-for-agenda org-todo-keywords-1))
  16583. (setq org-done-keywords-for-agenda
  16584. (append org-done-keywords-for-agenda org-done-keywords))
  16585. (setq org-todo-keyword-alist-for-agenda
  16586. (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
  16587. (setq org-drawers-for-agenda
  16588. (append org-drawers-for-agenda org-drawers))
  16589. (setq org-tag-alist-for-agenda
  16590. (org-uniquify
  16591. (append org-tag-alist-for-agenda
  16592. org-tag-alist
  16593. org-tag-persistent-alist)))
  16594. (if org-group-tags
  16595. (setq org-tag-groups-alist-for-agenda
  16596. (org-uniquify-alist
  16597. (append org-tag-groups-alist-for-agenda org-tag-groups-alist))))
  16598. (org-with-silent-modifications
  16599. (save-excursion
  16600. (remove-text-properties (point-min) (point-max) pall)
  16601. (when org-agenda-skip-archived-trees
  16602. (goto-char (point-min))
  16603. (while (re-search-forward rea nil t)
  16604. (if (org-at-heading-p t)
  16605. (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
  16606. (goto-char (point-min))
  16607. (setq re (format org-heading-keyword-regexp-format
  16608. org-comment-string))
  16609. (while (re-search-forward re nil t)
  16610. (add-text-properties
  16611. (match-beginning 0) (org-end-of-subtree t) pc))))))))
  16612. (setq org-todo-keywords-for-agenda
  16613. (org-uniquify org-todo-keywords-for-agenda))
  16614. (setq org-todo-keyword-alist-for-agenda
  16615. (org-uniquify org-todo-keyword-alist-for-agenda))))
  16616. ;;;; CDLaTeX minor mode
  16617. (defvar org-cdlatex-mode-map (make-sparse-keymap)
  16618. "Keymap for the minor `org-cdlatex-mode'.")
  16619. (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
  16620. (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
  16621. (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
  16622. (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
  16623. (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
  16624. (defvar org-cdlatex-texmathp-advice-is-done nil
  16625. "Flag remembering if we have applied the advice to texmathp already.")
  16626. (define-minor-mode org-cdlatex-mode
  16627. "Toggle the minor `org-cdlatex-mode'.
  16628. This mode supports entering LaTeX environment and math in LaTeX fragments
  16629. in Org-mode.
  16630. \\{org-cdlatex-mode-map}"
  16631. nil " OCDL" nil
  16632. (when org-cdlatex-mode
  16633. (require 'cdlatex)
  16634. (run-hooks 'cdlatex-mode-hook)
  16635. (cdlatex-compute-tables))
  16636. (unless org-cdlatex-texmathp-advice-is-done
  16637. (setq org-cdlatex-texmathp-advice-is-done t)
  16638. (defadvice texmathp (around org-math-always-on activate)
  16639. "Always return t in org-mode buffers.
  16640. This is because we want to insert math symbols without dollars even outside
  16641. the LaTeX math segments. If Orgmode thinks that point is actually inside
  16642. an embedded LaTeX fragment, let texmathp do its job.
  16643. \\[org-cdlatex-mode-map]"
  16644. (interactive)
  16645. (let (p)
  16646. (cond
  16647. ((not (derived-mode-p 'org-mode)) ad-do-it)
  16648. ((eq this-command 'cdlatex-math-symbol)
  16649. (setq ad-return-value t
  16650. texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
  16651. (t
  16652. (let ((p (org-inside-LaTeX-fragment-p)))
  16653. (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
  16654. (setq ad-return-value t
  16655. texmathp-why '("Org-mode embedded math" . 0))
  16656. (if p ad-do-it)))))))))
  16657. (defun turn-on-org-cdlatex ()
  16658. "Unconditionally turn on `org-cdlatex-mode'."
  16659. (org-cdlatex-mode 1))
  16660. (defun org-try-cdlatex-tab ()
  16661. "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
  16662. It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
  16663. - inside a LaTeX fragment, or
  16664. - after the first word in a line, where an abbreviation expansion could
  16665. insert a LaTeX environment."
  16666. (when org-cdlatex-mode
  16667. (cond
  16668. ;; Before any word on the line: No expansion possible.
  16669. ((save-excursion (skip-chars-backward " \t") (bolp)) nil)
  16670. ;; Just after first word on the line: Expand it. Make sure it
  16671. ;; cannot happen on headlines, though.
  16672. ((save-excursion
  16673. (skip-chars-backward "a-zA-Z0-9*")
  16674. (skip-chars-backward " \t")
  16675. (and (bolp) (not (org-at-heading-p))))
  16676. (cdlatex-tab) t)
  16677. ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
  16678. (defun org-cdlatex-underscore-caret (&optional arg)
  16679. "Execute `cdlatex-sub-superscript' in LaTeX fragments.
  16680. Revert to the normal definition outside of these fragments."
  16681. (interactive "P")
  16682. (if (org-inside-LaTeX-fragment-p)
  16683. (call-interactively 'cdlatex-sub-superscript)
  16684. (let (org-cdlatex-mode)
  16685. (call-interactively (key-binding (vector last-input-event))))))
  16686. (defun org-cdlatex-math-modify (&optional arg)
  16687. "Execute `cdlatex-math-modify' in LaTeX fragments.
  16688. Revert to the normal definition outside of these fragments."
  16689. (interactive "P")
  16690. (if (org-inside-LaTeX-fragment-p)
  16691. (call-interactively 'cdlatex-math-modify)
  16692. (let (org-cdlatex-mode)
  16693. (call-interactively (key-binding (vector last-input-event))))))
  16694. ;;;; LaTeX fragments
  16695. (defvar org-latex-regexps
  16696. '(("begin" "^[ \t]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^\000]+?\\\\end{\\2}\\)" 1 t)
  16697. ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
  16698. ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
  16699. ("$1" "\\([^$]\\|^\\)\\(\\$[^ \r\n,;.$]\\$\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
  16700. ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
  16701. ("\\(" "\\\\([^\000]*?\\\\)" 0 nil)
  16702. ("\\[" "\\\\\\[[^\000]*?\\\\\\]" 0 nil)
  16703. ("$$" "\\$\\$[^\000]*?\\$\\$" 0 nil))
  16704. "Regular expressions for matching embedded LaTeX.")
  16705. (defun org-inside-LaTeX-fragment-p ()
  16706. "Test if point is inside a LaTeX fragment.
  16707. I.e. after a \\begin, \\(, \\[, $, or $$, without the corresponding closing
  16708. sequence appearing also before point.
  16709. Even though the matchers for math are configurable, this function assumes
  16710. that \\begin, \\(, \\[, and $$ are always used. Only the single dollar
  16711. delimiters are skipped when they have been removed by customization.
  16712. The return value is nil, or a cons cell with the delimiter and the
  16713. position of this delimiter.
  16714. This function does a reasonably good job, but can locally be fooled by
  16715. for example currency specifications. For example it will assume being in
  16716. inline math after \"$22.34\". The LaTeX fragment formatter will only format
  16717. fragments that are properly closed, but during editing, we have to live
  16718. with the uncertainty caused by missing closing delimiters. This function
  16719. looks only before point, not after."
  16720. (catch 'exit
  16721. (let ((pos (point))
  16722. (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
  16723. (lim (progn
  16724. (re-search-backward (concat "^\\(" paragraph-start "\\)") nil t)
  16725. (point)))
  16726. dd-on str (start 0) m re)
  16727. (goto-char pos)
  16728. (when dodollar
  16729. (setq str (concat (buffer-substring lim (point)) "\000 X$.")
  16730. re (nth 1 (assoc "$" org-latex-regexps)))
  16731. (while (string-match re str start)
  16732. (cond
  16733. ((= (match-end 0) (length str))
  16734. (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
  16735. ((= (match-end 0) (- (length str) 5))
  16736. (throw 'exit nil))
  16737. (t (setq start (match-end 0))))))
  16738. (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
  16739. (goto-char pos)
  16740. (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
  16741. (and (match-beginning 2) (throw 'exit nil))
  16742. ;; count $$
  16743. (while (re-search-backward "\\$\\$" lim t)
  16744. (setq dd-on (not dd-on)))
  16745. (goto-char pos)
  16746. (if dd-on (cons "$$" m))))))
  16747. (defun org-inside-latex-macro-p ()
  16748. "Is point inside a LaTeX macro or its arguments?"
  16749. (save-match-data
  16750. (org-in-regexp
  16751. "\\\\[a-zA-Z]+\\*?\\(\\(\\[[^][\n{}]*\\]\\)\\|\\({[^{}\n]*}\\)\\)*")))
  16752. (defvar org-latex-fragment-image-overlays nil
  16753. "List of overlays carrying the images of latex fragments.")
  16754. (make-variable-buffer-local 'org-latex-fragment-image-overlays)
  16755. (defun org-remove-latex-fragment-image-overlays ()
  16756. "Remove all overlays with LaTeX fragment images in current buffer."
  16757. (mapc 'delete-overlay org-latex-fragment-image-overlays)
  16758. (setq org-latex-fragment-image-overlays nil))
  16759. (defun org-preview-latex-fragment (&optional subtree)
  16760. "Preview the LaTeX fragment at point, or all locally or globally.
  16761. If the cursor is in a LaTeX fragment, create the image and overlay
  16762. it over the source code. If there is no fragment at point, display
  16763. all fragments in the current text, from one headline to the next. With
  16764. prefix SUBTREE, display all fragments in the current subtree. With a
  16765. double prefix arg \\[universal-argument] \\[universal-argument], or when \
  16766. the cursor is before the first headline,
  16767. display all fragments in the buffer.
  16768. The images can be removed again with \\[org-ctrl-c-ctrl-c]."
  16769. (interactive "P")
  16770. (unless buffer-file-name
  16771. (user-error "Can't preview LaTeX fragment in a non-file buffer"))
  16772. (when (display-graphic-p)
  16773. (org-remove-latex-fragment-image-overlays)
  16774. (save-excursion
  16775. (save-restriction
  16776. (let (beg end at msg)
  16777. (cond
  16778. ((or (equal subtree '(16))
  16779. (not (save-excursion
  16780. (re-search-backward org-outline-regexp-bol nil t))))
  16781. (setq beg (point-min) end (point-max)
  16782. msg "Creating images for buffer...%s"))
  16783. ((equal subtree '(4))
  16784. (org-back-to-heading)
  16785. (setq beg (point) end (org-end-of-subtree t)
  16786. msg "Creating images for subtree...%s"))
  16787. (t
  16788. (if (setq at (org-inside-LaTeX-fragment-p))
  16789. (goto-char (max (point-min) (- (cdr at) 2)))
  16790. (org-back-to-heading))
  16791. (setq beg (point) end (progn (outline-next-heading) (point))
  16792. msg (if at "Creating image...%s"
  16793. "Creating images for entry...%s"))))
  16794. (message msg "")
  16795. (narrow-to-region beg end)
  16796. (goto-char beg)
  16797. (org-format-latex
  16798. (concat org-latex-preview-ltxpng-directory (file-name-sans-extension
  16799. (file-name-nondirectory
  16800. buffer-file-name)))
  16801. default-directory 'overlays msg at 'forbuffer
  16802. org-latex-create-formula-image-program)
  16803. (message msg "done. Use `C-c C-c' to remove images."))))))
  16804. (defun org-format-latex (prefix &optional dir overlays msg at
  16805. forbuffer processing-type)
  16806. "Replace LaTeX fragments with links to an image, and produce images.
  16807. Some of the options can be changed using the variable
  16808. `org-format-latex-options'."
  16809. (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
  16810. (let* ((prefixnodir (file-name-nondirectory prefix))
  16811. (absprefix (expand-file-name prefix dir))
  16812. (todir (file-name-directory absprefix))
  16813. (opt org-format-latex-options)
  16814. (optnew org-format-latex-options)
  16815. (matchers (plist-get opt :matchers))
  16816. (re-list org-latex-regexps)
  16817. (cnt 0) txt hash link beg end re e checkdir
  16818. string
  16819. m n block-type block linkfile movefile ov)
  16820. ;; Check the different regular expressions
  16821. (while (setq e (pop re-list))
  16822. (setq m (car e) re (nth 1 e) n (nth 2 e) block-type (nth 3 e)
  16823. block (if block-type "\n\n" ""))
  16824. (when (member m matchers)
  16825. (goto-char (point-min))
  16826. (while (re-search-forward re nil t)
  16827. (when (and (or (not at) (equal (cdr at) (match-beginning n)))
  16828. (or (not overlays)
  16829. (not (eq (get-char-property (match-beginning n)
  16830. 'org-overlay-type)
  16831. 'org-latex-overlay))))
  16832. (cond
  16833. ((eq processing-type 'verbatim))
  16834. ((eq processing-type 'mathjax)
  16835. ;; Prepare for MathJax processing.
  16836. (setq string (match-string n))
  16837. (when (member m '("$" "$1"))
  16838. (save-excursion
  16839. (delete-region (match-beginning n) (match-end n))
  16840. (goto-char (match-beginning n))
  16841. (insert (concat "\\(" (substring string 1 -1) "\\)")))))
  16842. ((or (eq processing-type 'dvipng)
  16843. (eq processing-type 'imagemagick))
  16844. ;; Process to an image.
  16845. (setq txt (match-string n)
  16846. beg (match-beginning n) end (match-end n)
  16847. cnt (1+ cnt))
  16848. (let ((face (face-at-point))
  16849. (fg (plist-get opt :foreground))
  16850. (bg (plist-get opt :background))
  16851. ;; Ensure full list is printed.
  16852. print-length print-level)
  16853. (when forbuffer
  16854. ;; Get the colors from the face at point.
  16855. (goto-char beg)
  16856. (when (eq fg 'auto)
  16857. (setq fg (face-attribute face :foreground nil 'default)))
  16858. (when (eq bg 'auto)
  16859. (setq bg (face-attribute face :background nil 'default)))
  16860. (setq optnew (copy-sequence opt))
  16861. (plist-put optnew :foreground fg)
  16862. (plist-put optnew :background bg))
  16863. (setq hash (sha1 (prin1-to-string
  16864. (list org-format-latex-header
  16865. org-latex-default-packages-alist
  16866. org-latex-packages-alist
  16867. org-format-latex-options
  16868. forbuffer txt fg bg)))
  16869. linkfile (format "%s_%s.png" prefix hash)
  16870. movefile (format "%s_%s.png" absprefix hash)))
  16871. (setq link (concat block "[[file:" linkfile "]]" block))
  16872. (if msg (message msg cnt))
  16873. (goto-char beg)
  16874. (unless checkdir ; Ensure the directory exists.
  16875. (setq checkdir t)
  16876. (or (file-directory-p todir) (make-directory todir t)))
  16877. (unless (file-exists-p movefile)
  16878. (org-create-formula-image
  16879. txt movefile optnew forbuffer processing-type))
  16880. (if overlays
  16881. (progn
  16882. (mapc (lambda (o)
  16883. (if (eq (overlay-get o 'org-overlay-type)
  16884. 'org-latex-overlay)
  16885. (delete-overlay o)))
  16886. (overlays-in beg end))
  16887. (setq ov (make-overlay beg end))
  16888. (overlay-put ov 'org-overlay-type 'org-latex-overlay)
  16889. (if (featurep 'xemacs)
  16890. (progn
  16891. (overlay-put ov 'invisible t)
  16892. (overlay-put
  16893. ov 'end-glyph
  16894. (make-glyph (vector 'png :file movefile))))
  16895. (overlay-put
  16896. ov 'display
  16897. (list 'image :type 'png :file movefile :ascent 'center)))
  16898. (push ov org-latex-fragment-image-overlays)
  16899. (goto-char end))
  16900. (delete-region beg end)
  16901. (insert (org-add-props link
  16902. (list 'org-latex-src
  16903. (replace-regexp-in-string
  16904. "\"" "" txt)
  16905. 'org-latex-src-embed-type
  16906. (if block-type 'paragraph 'character))))))
  16907. ((eq processing-type 'mathml)
  16908. ;; Process to MathML
  16909. (unless (save-match-data (org-format-latex-mathml-available-p))
  16910. (user-error "LaTeX to MathML converter not configured"))
  16911. (setq txt (match-string n)
  16912. beg (match-beginning n) end (match-end n)
  16913. cnt (1+ cnt))
  16914. (if msg (message msg cnt))
  16915. (goto-char beg)
  16916. (delete-region beg end)
  16917. (insert (org-format-latex-as-mathml
  16918. txt block-type prefix dir)))
  16919. (t
  16920. (error "Unknown conversion type %s for LaTeX fragments"
  16921. processing-type)))))))))
  16922. (defun org-create-math-formula (latex-frag &optional mathml-file)
  16923. "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
  16924. Use `org-latex-to-mathml-convert-command'. If the conversion is
  16925. sucessful, return the portion between \"<math...> </math>\"
  16926. elements otherwise return nil. When MATHML-FILE is specified,
  16927. write the results in to that file. When invoked as an
  16928. interactive command, prompt for LATEX-FRAG, with initial value
  16929. set to the current active region and echo the results for user
  16930. inspection."
  16931. (interactive (list (let ((frag (when (org-region-active-p)
  16932. (buffer-substring-no-properties
  16933. (region-beginning) (region-end)))))
  16934. (read-string "LaTeX Fragment: " frag nil frag))))
  16935. (unless latex-frag (error "Invalid LaTeX fragment"))
  16936. (let* ((tmp-in-file (file-relative-name
  16937. (make-temp-name (expand-file-name "ltxmathml-in"))))
  16938. (ignore (write-region latex-frag nil tmp-in-file))
  16939. (tmp-out-file (file-relative-name
  16940. (make-temp-name (expand-file-name "ltxmathml-out"))))
  16941. (cmd (format-spec
  16942. org-latex-to-mathml-convert-command
  16943. `((?j . ,(shell-quote-argument
  16944. (expand-file-name org-latex-to-mathml-jar-file)))
  16945. (?I . ,(shell-quote-argument tmp-in-file))
  16946. (?o . ,(shell-quote-argument tmp-out-file)))))
  16947. mathml shell-command-output)
  16948. (when (org-called-interactively-p 'any)
  16949. (unless (org-format-latex-mathml-available-p)
  16950. (user-error "LaTeX to MathML converter not configured")))
  16951. (message "Running %s" cmd)
  16952. (setq shell-command-output (shell-command-to-string cmd))
  16953. (setq mathml
  16954. (when (file-readable-p tmp-out-file)
  16955. (with-current-buffer (find-file-noselect tmp-out-file t)
  16956. (goto-char (point-min))
  16957. (when (re-search-forward
  16958. (concat
  16959. (regexp-quote
  16960. "<math xmlns=\"http://www.w3.org/1998/Math/MathML\">")
  16961. "\\(.\\|\n\\)*"
  16962. (regexp-quote "</math>")) nil t)
  16963. (prog1 (match-string 0) (kill-buffer))))))
  16964. (cond
  16965. (mathml
  16966. (setq mathml
  16967. (concat "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" mathml))
  16968. (when mathml-file
  16969. (write-region mathml nil mathml-file))
  16970. (when (org-called-interactively-p 'any)
  16971. (message mathml)))
  16972. ((message "LaTeX to MathML conversion failed")
  16973. (message shell-command-output)))
  16974. (delete-file tmp-in-file)
  16975. (when (file-exists-p tmp-out-file)
  16976. (delete-file tmp-out-file))
  16977. mathml))
  16978. (defun org-format-latex-as-mathml (latex-frag latex-frag-type
  16979. prefix &optional dir)
  16980. "Use `org-create-math-formula' but check local cache first."
  16981. (let* ((absprefix (expand-file-name prefix dir))
  16982. (print-length nil) (print-level nil)
  16983. (formula-id (concat
  16984. "formula-"
  16985. (sha1
  16986. (prin1-to-string
  16987. (list latex-frag
  16988. org-latex-to-mathml-convert-command)))))
  16989. (formula-cache (format "%s-%s.mathml" absprefix formula-id))
  16990. (formula-cache-dir (file-name-directory formula-cache)))
  16991. (unless (file-directory-p formula-cache-dir)
  16992. (make-directory formula-cache-dir t))
  16993. (unless (file-exists-p formula-cache)
  16994. (org-create-math-formula latex-frag formula-cache))
  16995. (if (file-exists-p formula-cache)
  16996. ;; Successful conversion. Return the link to MathML file.
  16997. (org-add-props
  16998. (format "[[file:%s]]" (file-relative-name formula-cache dir))
  16999. (list 'org-latex-src (replace-regexp-in-string "\"" "" latex-frag)
  17000. 'org-latex-src-embed-type (if latex-frag-type
  17001. 'paragraph 'character)))
  17002. ;; Failed conversion. Return the LaTeX fragment verbatim
  17003. latex-frag)))
  17004. (defun org-create-formula-image (string tofile options buffer &optional type)
  17005. "Create an image from LaTeX source using dvipng or convert.
  17006. This function calls either `org-create-formula-image-with-dvipng'
  17007. or `org-create-formula-image-with-imagemagick' depending on the
  17008. value of `org-latex-create-formula-image-program' or on the value
  17009. of the optional TYPE variable.
  17010. Note: ultimately these two function should be combined as they
  17011. share a good deal of logic."
  17012. (org-check-external-command
  17013. "latex" "needed to convert LaTeX fragments to images")
  17014. (funcall
  17015. (case (or type org-latex-create-formula-image-program)
  17016. ('dvipng
  17017. (org-check-external-command
  17018. "dvipng" "needed to convert LaTeX fragments to images")
  17019. #'org-create-formula-image-with-dvipng)
  17020. ('imagemagick
  17021. (org-check-external-command
  17022. "convert" "you need to install imagemagick")
  17023. #'org-create-formula-image-with-imagemagick)
  17024. (t (error
  17025. "Invalid value of `org-latex-create-formula-image-program'")))
  17026. string tofile options buffer))
  17027. (declare-function org-export-get-backend "ox" (name))
  17028. (declare-function org-export--get-global-options "ox" (&optional backend))
  17029. (declare-function org-export--get-inbuffer-options "ox" (&optional backend))
  17030. (declare-function org-latex-guess-inputenc "ox-latex" (header))
  17031. (declare-function org-latex-guess-babel-language "ox-latex" (header info))
  17032. (defun org-create-formula--latex-header ()
  17033. "Return LaTeX header appropriate for previewing a LaTeX snippet."
  17034. (let ((info (org-combine-plists (org-export--get-global-options
  17035. (org-export-get-backend 'latex))
  17036. (org-export--get-inbuffer-options
  17037. (org-export-get-backend 'latex)))))
  17038. (org-latex-guess-babel-language
  17039. (org-latex-guess-inputenc
  17040. (org-splice-latex-header
  17041. org-format-latex-header
  17042. org-latex-default-packages-alist
  17043. org-latex-packages-alist t
  17044. (plist-get info :latex-header)))
  17045. info)))
  17046. ;; This function borrows from Ganesh Swami's latex2png.el
  17047. (defun org-create-formula-image-with-dvipng (string tofile options buffer)
  17048. "This calls dvipng."
  17049. (require 'ox-latex)
  17050. (let* ((tmpdir (if (featurep 'xemacs)
  17051. (temp-directory)
  17052. temporary-file-directory))
  17053. (texfilebase (make-temp-name
  17054. (expand-file-name "orgtex" tmpdir)))
  17055. (texfile (concat texfilebase ".tex"))
  17056. (dvifile (concat texfilebase ".dvi"))
  17057. (pngfile (concat texfilebase ".png"))
  17058. (fnh (if (featurep 'xemacs)
  17059. (font-height (face-font 'default))
  17060. (face-attribute 'default :height nil)))
  17061. (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
  17062. (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
  17063. (fg (or (plist-get options (if buffer :foreground :html-foreground))
  17064. "Black"))
  17065. (bg (or (plist-get options (if buffer :background :html-background))
  17066. "Transparent")))
  17067. (if (eq fg 'default) (setq fg (org-dvipng-color :foreground))
  17068. (unless (string= fg "Transparent") (setq fg (org-dvipng-color-format fg))))
  17069. (if (eq bg 'default) (setq bg (org-dvipng-color :background))
  17070. (unless (string= bg "Transparent") (setq bg (org-dvipng-color-format bg))))
  17071. (let ((latex-header (org-create-formula--latex-header)))
  17072. (with-temp-file texfile
  17073. (insert latex-header)
  17074. (insert "\n\\begin{document}\n" string "\n\\end{document}\n")))
  17075. (let ((dir default-directory))
  17076. (condition-case nil
  17077. (progn
  17078. (cd tmpdir)
  17079. (call-process "latex" nil nil nil texfile))
  17080. (error nil))
  17081. (cd dir))
  17082. (if (not (file-exists-p dvifile))
  17083. (progn (message "Failed to create dvi file from %s" texfile) nil)
  17084. (condition-case nil
  17085. (if (featurep 'xemacs)
  17086. (call-process "dvipng" nil nil nil
  17087. "-fg" fg "-bg" bg
  17088. "-T" "tight"
  17089. "-o" pngfile
  17090. dvifile)
  17091. (call-process "dvipng" nil nil nil
  17092. "-fg" fg "-bg" bg
  17093. "-D" dpi
  17094. ;;"-x" scale "-y" scale
  17095. "-T" "tight"
  17096. "-o" pngfile
  17097. dvifile))
  17098. (error nil))
  17099. (if (not (file-exists-p pngfile))
  17100. (if org-format-latex-signal-error
  17101. (error "Failed to create png file from %s" texfile)
  17102. (message "Failed to create png file from %s" texfile)
  17103. nil)
  17104. ;; Use the requested file name and clean up
  17105. (copy-file pngfile tofile 'replace)
  17106. (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
  17107. (if (file-exists-p (concat texfilebase e))
  17108. (delete-file (concat texfilebase e))))
  17109. pngfile))))
  17110. (declare-function org-latex-compile "ox-latex" (texfile &optional snippet))
  17111. (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
  17112. "This calls convert, which is included into imagemagick."
  17113. (require 'ox-latex)
  17114. (let* ((tmpdir (if (featurep 'xemacs)
  17115. (temp-directory)
  17116. temporary-file-directory))
  17117. (texfilebase (make-temp-name
  17118. (expand-file-name "orgtex" tmpdir)))
  17119. (texfile (concat texfilebase ".tex"))
  17120. (pdffile (concat texfilebase ".pdf"))
  17121. (pngfile (concat texfilebase ".png"))
  17122. (fnh (if (featurep 'xemacs)
  17123. (font-height (face-font 'default))
  17124. (face-attribute 'default :height nil)))
  17125. (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
  17126. (dpi (number-to-string (* scale (floor (if buffer fnh 120.)))))
  17127. (fg (or (plist-get options (if buffer :foreground :html-foreground))
  17128. "black"))
  17129. (bg (or (plist-get options (if buffer :background :html-background))
  17130. "white")))
  17131. (if (eq fg 'default) (setq fg (org-latex-color :foreground))
  17132. (setq fg (org-latex-color-format fg)))
  17133. (if (eq bg 'default) (setq bg (org-latex-color :background))
  17134. (setq bg (org-latex-color-format
  17135. (if (string= bg "Transparent") "white" bg))))
  17136. (let ((latex-header (org-create-formula--latex-header)))
  17137. (with-temp-file texfile
  17138. (insert latex-header)
  17139. (insert "\n\\begin{document}\n"
  17140. "\\definecolor{fg}{rgb}{" fg "}\n"
  17141. "\\definecolor{bg}{rgb}{" bg "}\n"
  17142. "\n\\pagecolor{bg}\n"
  17143. "\n{\\color{fg}\n"
  17144. string
  17145. "\n}\n"
  17146. "\n\\end{document}\n")))
  17147. (org-latex-compile texfile t)
  17148. (if (not (file-exists-p pdffile))
  17149. (progn (message "Failed to create pdf file from %s" texfile) nil)
  17150. (condition-case nil
  17151. (if (featurep 'xemacs)
  17152. (call-process "convert" nil nil nil
  17153. "-density" "96"
  17154. "-trim"
  17155. "-antialias"
  17156. pdffile
  17157. "-quality" "100"
  17158. ;; "-sharpen" "0x1.0"
  17159. pngfile)
  17160. (call-process "convert" nil nil nil
  17161. "-density" dpi
  17162. "-trim"
  17163. "-antialias"
  17164. pdffile
  17165. "-quality" "100"
  17166. ;; "-sharpen" "0x1.0"
  17167. pngfile))
  17168. (error nil))
  17169. (if (not (file-exists-p pngfile))
  17170. (if org-format-latex-signal-error
  17171. (error "Failed to create png file from %s" texfile)
  17172. (message "Failed to create png file from %s" texfile)
  17173. nil)
  17174. ;; Use the requested file name and clean up
  17175. (copy-file pngfile tofile 'replace)
  17176. (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
  17177. (if (file-exists-p (concat texfilebase e))
  17178. (delete-file (concat texfilebase e))))
  17179. pngfile))))
  17180. (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
  17181. "Fill a LaTeX header template TPL.
  17182. In the template, the following place holders will be recognized:
  17183. [DEFAULT-PACKAGES] \\usepackage statements for DEF-PKG
  17184. [NO-DEFAULT-PACKAGES] do not include DEF-PKG
  17185. [PACKAGES] \\usepackage statements for PKG
  17186. [NO-PACKAGES] do not include PKG
  17187. [EXTRA] the string EXTRA
  17188. [NO-EXTRA] do not include EXTRA
  17189. For backward compatibility, if both the positive and the negative place
  17190. holder is missing, the positive one (without the \"NO-\") will be
  17191. assumed to be present at the end of the template.
  17192. DEF-PKG and PKG are assumed to be alists of options/packagename lists.
  17193. EXTRA is a string.
  17194. SNIPPETS-P indicates if this is run to create snippet images for HTML."
  17195. (let (rpl (end ""))
  17196. (if (string-match "^[ \t]*\\[\\(NO-\\)?DEFAULT-PACKAGES\\][ \t]*\n?" tpl)
  17197. (setq rpl (if (or (match-end 1) (not def-pkg))
  17198. "" (org-latex-packages-to-string def-pkg snippets-p t))
  17199. tpl (replace-match rpl t t tpl))
  17200. (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
  17201. (if (string-match "\\[\\(NO-\\)?PACKAGES\\][ \t]*\n?" tpl)
  17202. (setq rpl (if (or (match-end 1) (not pkg))
  17203. "" (org-latex-packages-to-string pkg snippets-p t))
  17204. tpl (replace-match rpl t t tpl))
  17205. (if pkg (setq end
  17206. (concat end "\n"
  17207. (org-latex-packages-to-string pkg snippets-p)))))
  17208. (if (string-match "\\[\\(NO-\\)?EXTRA\\][ \t]*\n?" tpl)
  17209. (setq rpl (if (or (match-end 1) (not extra))
  17210. "" (concat extra "\n"))
  17211. tpl (replace-match rpl t t tpl))
  17212. (if (and extra (string-match "\\S-" extra))
  17213. (setq end (concat end "\n" extra))))
  17214. (if (string-match "\\S-" end)
  17215. (concat tpl "\n" end)
  17216. tpl)))
  17217. (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
  17218. "Turn an alist of packages into a string with the \\usepackage macros."
  17219. (setq pkg (mapconcat (lambda(p)
  17220. (cond
  17221. ((stringp p) p)
  17222. ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
  17223. (format "%% Package %s omitted" (cadr p)))
  17224. ((equal "" (car p))
  17225. (format "\\usepackage{%s}" (cadr p)))
  17226. (t
  17227. (format "\\usepackage[%s]{%s}"
  17228. (car p) (cadr p)))))
  17229. pkg
  17230. "\n"))
  17231. (if newline (concat pkg "\n") pkg))
  17232. (defun org-dvipng-color (attr)
  17233. "Return a RGB color specification for dvipng."
  17234. (apply 'format "rgb %s %s %s"
  17235. (mapcar 'org-normalize-color
  17236. (if (featurep 'xemacs)
  17237. (color-rgb-components
  17238. (face-property 'default
  17239. (cond ((eq attr :foreground) 'foreground)
  17240. ((eq attr :background) 'background))))
  17241. (color-values (face-attribute 'default attr nil))))))
  17242. (defun org-dvipng-color-format (color-name)
  17243. "Convert COLOR-NAME to a RGB color value for dvipng."
  17244. (apply 'format "rgb %s %s %s"
  17245. (mapcar 'org-normalize-color
  17246. (color-values color-name))))
  17247. (defun org-latex-color (attr)
  17248. "Return a RGB color for the LaTeX color package."
  17249. (apply 'format "%s,%s,%s"
  17250. (mapcar 'org-normalize-color
  17251. (if (featurep 'xemacs)
  17252. (color-rgb-components
  17253. (face-property 'default
  17254. (cond ((eq attr :foreground) 'foreground)
  17255. ((eq attr :background) 'background))))
  17256. (color-values (face-attribute 'default attr nil))))))
  17257. (defun org-latex-color-format (color-name)
  17258. "Convert COLOR-NAME to a RGB color value."
  17259. (apply 'format "%s,%s,%s"
  17260. (mapcar 'org-normalize-color
  17261. (color-values color-name))))
  17262. (defun org-normalize-color (value)
  17263. "Return string to be used as color value for an RGB component."
  17264. (format "%g" (/ value 65535.0)))
  17265. ;; Image display
  17266. (defvar org-inline-image-overlays nil)
  17267. (make-variable-buffer-local 'org-inline-image-overlays)
  17268. (defun org-toggle-inline-images (&optional include-linked)
  17269. "Toggle the display of inline images.
  17270. INCLUDE-LINKED is passed to `org-display-inline-images'."
  17271. (interactive "P")
  17272. (if org-inline-image-overlays
  17273. (progn
  17274. (org-remove-inline-images)
  17275. (message "Inline image display turned off"))
  17276. (org-display-inline-images include-linked)
  17277. (if (and (org-called-interactively-p)
  17278. org-inline-image-overlays)
  17279. (message "%d images displayed inline"
  17280. (length org-inline-image-overlays))
  17281. (message "No images to display inline"))))
  17282. (defun org-redisplay-inline-images ()
  17283. "Refresh the display of inline images."
  17284. (interactive)
  17285. (if (not org-inline-image-overlays)
  17286. (org-toggle-inline-images)
  17287. (org-toggle-inline-images)
  17288. (org-toggle-inline-images)))
  17289. (defun org-display-inline-images (&optional include-linked refresh beg end)
  17290. "Display inline images.
  17291. Normally only links without a description part are inlined, because this
  17292. is how it will work for export. When INCLUDE-LINKED is set, also links
  17293. with a description part will be inlined. This can be nice for a quick
  17294. look at those images, but it does not reflect what exported files will look
  17295. like.
  17296. When REFRESH is set, refresh existing images between BEG and END.
  17297. This will create new image displays only if necessary.
  17298. BEG and END default to the buffer boundaries."
  17299. (interactive "P")
  17300. (when (display-graphic-p)
  17301. (unless refresh
  17302. (org-remove-inline-images)
  17303. (if (fboundp 'clear-image-cache) (clear-image-cache)))
  17304. (save-excursion
  17305. (save-restriction
  17306. (widen)
  17307. (setq beg (or beg (point-min)) end (or end (point-max)))
  17308. (goto-char beg)
  17309. (let ((re (concat "\\[\\[\\(\\(file:\\)\\|\\([./~]\\)\\)\\([^]\n]+?"
  17310. (substring (org-image-file-name-regexp) 0 -2)
  17311. "\\)\\]" (if include-linked "" "\\]")))
  17312. (case-fold-search t)
  17313. old file ov img type attrwidth width)
  17314. (while (re-search-forward re end t)
  17315. (setq old (get-char-property-and-overlay (match-beginning 1)
  17316. 'org-image-overlay)
  17317. file (expand-file-name
  17318. (concat (or (match-string 3) "") (match-string 4))))
  17319. (when (image-type-available-p 'imagemagick)
  17320. (setq attrwidth (if (or (listp org-image-actual-width)
  17321. (null org-image-actual-width))
  17322. (save-excursion
  17323. (save-match-data
  17324. (when (re-search-backward
  17325. "#\\+attr.*:width[ \t]+\\([^ ]+\\)"
  17326. (save-excursion
  17327. (re-search-backward "^[ \t]*$\\|\\`" nil t)) t)
  17328. (string-to-number (match-string 1))))))
  17329. width (cond ((eq org-image-actual-width t) nil)
  17330. ((null org-image-actual-width) attrwidth)
  17331. ((numberp org-image-actual-width)
  17332. org-image-actual-width)
  17333. ((listp org-image-actual-width)
  17334. (or attrwidth (car org-image-actual-width))))
  17335. type (if width 'imagemagick)))
  17336. (when (file-exists-p file)
  17337. (if (and (car-safe old) refresh)
  17338. (image-refresh (overlay-get (cdr old) 'display))
  17339. (setq img (save-match-data (create-image file type nil :width width)))
  17340. (when img
  17341. (setq ov (make-overlay (match-beginning 0) (match-end 0)))
  17342. (overlay-put ov 'display img)
  17343. (overlay-put ov 'face 'default)
  17344. (overlay-put ov 'org-image-overlay t)
  17345. (overlay-put ov 'modification-hooks
  17346. (list 'org-display-inline-remove-overlay))
  17347. (push ov org-inline-image-overlays))))))))))
  17348. (define-obsolete-function-alias
  17349. 'org-display-inline-modification-hook 'org-display-inline-remove-overlay "24.3")
  17350. (defun org-display-inline-remove-overlay (ov after beg end &optional len)
  17351. "Remove inline-display overlay if a corresponding region is modified."
  17352. (let ((inhibit-modification-hooks t))
  17353. (when (and ov after)
  17354. (delete ov org-inline-image-overlays)
  17355. (delete-overlay ov))))
  17356. (defun org-remove-inline-images ()
  17357. "Remove inline display of images."
  17358. (interactive)
  17359. (mapc 'delete-overlay org-inline-image-overlays)
  17360. (setq org-inline-image-overlays nil))
  17361. ;;;; Key bindings
  17362. ;; Outline functions from `outline-mode-prefix-map'
  17363. ;; that can be remapped in Org:
  17364. (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
  17365. (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
  17366. (define-key org-mode-map [remap outline-forward-same-level]
  17367. 'org-forward-heading-same-level)
  17368. (define-key org-mode-map [remap outline-backward-same-level]
  17369. 'org-backward-heading-same-level)
  17370. (define-key org-mode-map [remap show-branches]
  17371. 'org-kill-note-or-show-branches)
  17372. (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
  17373. (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
  17374. (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
  17375. ;; Outline functions from `outline-mode-prefix-map' that can not
  17376. ;; be remapped in Org:
  17377. ;;
  17378. ;; - the column "key binding" shows whether the Outline function is still
  17379. ;; available in Org mode on the same key that it has been bound to in
  17380. ;; Outline mode:
  17381. ;; - "overridden": key used for a different functionality in Org mode
  17382. ;; - else: key still bound to the same Outline function in Org mode
  17383. ;;
  17384. ;; | Outline function | key binding | Org replacement |
  17385. ;; |------------------------------------+-------------+-----------------------|
  17386. ;; | `outline-next-visible-heading' | `C-c C-n' | still same function |
  17387. ;; | `outline-previous-visible-heading' | `C-c C-p' | still same function |
  17388. ;; | `outline-up-heading' | `C-c C-u' | still same function |
  17389. ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
  17390. ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
  17391. ;; | `show-entry' | overridden | no replacement |
  17392. ;; | `show-children' | `C-c C-i' | visibility cycling |
  17393. ;; | `show-branches' | `C-c C-k' | still same function |
  17394. ;; | `show-subtree' | overridden | visibility cycling |
  17395. ;; | `show-all' | overridden | no replacement |
  17396. ;; | `hide-subtree' | overridden | visibility cycling |
  17397. ;; | `hide-body' | overridden | no replacement |
  17398. ;; | `hide-entry' | overridden | visibility cycling |
  17399. ;; | `hide-leaves' | overridden | no replacement |
  17400. ;; | `hide-sublevels' | overridden | no replacement |
  17401. ;; | `hide-other' | overridden | no replacement |
  17402. ;; Make `C-c C-x' a prefix key
  17403. (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
  17404. ;; TAB key with modifiers
  17405. (org-defkey org-mode-map "\C-i" 'org-cycle)
  17406. (org-defkey org-mode-map [(tab)] 'org-cycle)
  17407. (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
  17408. (org-defkey org-mode-map "\M-\t" 'pcomplete)
  17409. ;; The following line is necessary under Suse GNU/Linux
  17410. (unless (featurep 'xemacs)
  17411. (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
  17412. (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
  17413. (define-key org-mode-map [backtab] 'org-shifttab)
  17414. (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
  17415. (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
  17416. (org-defkey org-mode-map [(meta return)] 'org-meta-return)
  17417. ;; Cursor keys with modifiers
  17418. (org-defkey org-mode-map [(meta left)] 'org-metaleft)
  17419. (org-defkey org-mode-map [(meta right)] 'org-metaright)
  17420. (org-defkey org-mode-map [(meta up)] 'org-metaup)
  17421. (org-defkey org-mode-map [(meta down)] 'org-metadown)
  17422. (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
  17423. (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
  17424. (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
  17425. (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
  17426. (org-defkey org-mode-map [(shift up)] 'org-shiftup)
  17427. (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
  17428. (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
  17429. (org-defkey org-mode-map [(shift right)] 'org-shiftright)
  17430. (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
  17431. (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
  17432. (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
  17433. (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
  17434. ;; Babel keys
  17435. (define-key org-mode-map org-babel-key-prefix org-babel-map)
  17436. (mapc (lambda (pair)
  17437. (define-key org-babel-map (car pair) (cdr pair)))
  17438. org-babel-key-bindings)
  17439. ;;; Extra keys for tty access.
  17440. ;; We only set them when really needed because otherwise the
  17441. ;; menus don't show the simple keys
  17442. (when (or org-use-extra-keys
  17443. (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
  17444. (not window-system))
  17445. (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
  17446. (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
  17447. (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
  17448. (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
  17449. (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
  17450. (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
  17451. (org-defkey org-mode-map [?\e (right)] 'org-metaright)
  17452. (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
  17453. (org-defkey org-mode-map [?\e (up)] 'org-metaup)
  17454. (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
  17455. (org-defkey org-mode-map [?\e (down)] 'org-metadown)
  17456. (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
  17457. (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
  17458. (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
  17459. (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
  17460. (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
  17461. (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
  17462. (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
  17463. (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
  17464. (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
  17465. (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
  17466. (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
  17467. (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
  17468. (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
  17469. (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
  17470. (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
  17471. (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
  17472. (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
  17473. ;; All the other keys
  17474. (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
  17475. (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
  17476. (if (boundp 'narrow-map)
  17477. (org-defkey narrow-map "s" 'org-narrow-to-subtree)
  17478. (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
  17479. (if (boundp 'narrow-map)
  17480. (org-defkey narrow-map "b" 'org-narrow-to-block)
  17481. (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
  17482. (if (boundp 'narrow-map)
  17483. (org-defkey narrow-map "e" 'org-narrow-to-element)
  17484. (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
  17485. (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
  17486. (org-defkey org-mode-map "\M-}" 'org-forward-element)
  17487. (org-defkey org-mode-map "\M-{" 'org-backward-element)
  17488. (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
  17489. (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
  17490. (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
  17491. (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
  17492. (org-defkey org-mode-map "\C-c\M-f" 'org-next-block)
  17493. (org-defkey org-mode-map "\C-c\M-b" 'org-previous-block)
  17494. (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
  17495. (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
  17496. (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
  17497. (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
  17498. (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
  17499. (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
  17500. (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
  17501. (org-defkey org-mode-map "\C-c\C-xq" 'org-toggle-tags-groups)
  17502. (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
  17503. (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
  17504. (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
  17505. (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
  17506. (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
  17507. (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
  17508. (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
  17509. (org-defkey org-mode-map "\C-c\M-w" 'org-copy)
  17510. (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
  17511. (org-defkey org-mode-map "\C-c\\" 'org-match-sparse-tree) ; Minor-mode res.
  17512. (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
  17513. (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
  17514. (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
  17515. (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
  17516. (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
  17517. (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
  17518. (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
  17519. (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
  17520. (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
  17521. (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
  17522. (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
  17523. (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
  17524. (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
  17525. (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
  17526. (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
  17527. (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
  17528. (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
  17529. (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
  17530. (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
  17531. (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
  17532. (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
  17533. (org-defkey org-mode-map [(control ?\')] 'org-cycle-agenda-files)
  17534. (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
  17535. (org-defkey org-mode-map "\C-c]" 'org-remove-file)
  17536. (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
  17537. (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
  17538. (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
  17539. (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
  17540. (org-defkey org-mode-map "\C-c^" 'org-sort)
  17541. (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
  17542. (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
  17543. (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
  17544. (org-defkey org-mode-map [remap open-line] 'org-open-line)
  17545. (org-defkey org-mode-map [remap forward-paragraph] 'org-forward-paragraph)
  17546. (org-defkey org-mode-map [remap backward-paragraph] 'org-backward-paragraph)
  17547. (org-defkey org-mode-map "\C-m" 'org-return)
  17548. (org-defkey org-mode-map "\C-j" 'org-return-indent)
  17549. (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
  17550. (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
  17551. (org-defkey org-mode-map "\C-c+" 'org-table-sum)
  17552. (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
  17553. (org-defkey org-mode-map "\C-c'" 'org-edit-special)
  17554. (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
  17555. (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
  17556. (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
  17557. (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
  17558. (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
  17559. (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
  17560. (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
  17561. (org-defkey org-mode-map "\C-c\C-e" 'org-export-dispatch)
  17562. (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
  17563. (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
  17564. (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
  17565. (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
  17566. (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
  17567. (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
  17568. (org-defkey org-mode-map "\M-h" 'org-mark-element)
  17569. (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
  17570. ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
  17571. (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
  17572. (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
  17573. (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
  17574. (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
  17575. (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
  17576. (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
  17577. (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
  17578. (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
  17579. (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
  17580. (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
  17581. (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
  17582. (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
  17583. (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
  17584. (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
  17585. (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
  17586. (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
  17587. (org-defkey org-mode-map "\C-c\C-x\\" 'org-toggle-pretty-entities)
  17588. (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
  17589. (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
  17590. (org-defkey org-mode-map "\C-c\C-xP" 'org-set-property-and-value)
  17591. (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
  17592. (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
  17593. (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
  17594. (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
  17595. (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
  17596. (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
  17597. (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
  17598. (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
  17599. (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
  17600. (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
  17601. (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
  17602. (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
  17603. (define-key org-mode-map "\C-c\C-x!" 'org-reload)
  17604. (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
  17605. (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
  17606. (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
  17607. (when (featurep 'xemacs)
  17608. (org-defkey org-mode-map 'button3 'popup-mode-menu))
  17609. (defconst org-speed-commands-default
  17610. '(
  17611. ("Outline Navigation")
  17612. ("n" . (org-speed-move-safe 'outline-next-visible-heading))
  17613. ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
  17614. ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
  17615. ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
  17616. ("F" . org-next-block)
  17617. ("B" . org-previous-block)
  17618. ("u" . (org-speed-move-safe 'outline-up-heading))
  17619. ("j" . org-goto)
  17620. ("g" . (org-refile t))
  17621. ("Outline Visibility")
  17622. ("c" . org-cycle)
  17623. ("C" . org-shifttab)
  17624. (" " . org-display-outline-path)
  17625. ("s" . org-narrow-to-subtree)
  17626. ("=" . org-columns)
  17627. ("Outline Structure Editing")
  17628. ("U" . org-shiftmetaup)
  17629. ("D" . org-shiftmetadown)
  17630. ("r" . org-metaright)
  17631. ("l" . org-metaleft)
  17632. ("R" . org-shiftmetaright)
  17633. ("L" . org-shiftmetaleft)
  17634. ("i" . (progn (forward-char 1) (call-interactively
  17635. 'org-insert-heading-respect-content)))
  17636. ("^" . org-sort)
  17637. ("w" . org-refile)
  17638. ("a" . org-archive-subtree-default-with-confirmation)
  17639. ("@" . org-mark-subtree)
  17640. ("#" . org-toggle-comment)
  17641. ("Clock Commands")
  17642. ("I" . org-clock-in)
  17643. ("O" . org-clock-out)
  17644. ("Meta Data Editing")
  17645. ("t" . org-todo)
  17646. ("," . (org-priority))
  17647. ("0" . (org-priority ?\ ))
  17648. ("1" . (org-priority ?A))
  17649. ("2" . (org-priority ?B))
  17650. ("3" . (org-priority ?C))
  17651. (":" . org-set-tags-command)
  17652. ("e" . org-set-effort)
  17653. ("E" . org-inc-effort)
  17654. ("W" . (lambda(m) (interactive "sMinutes before warning: ")
  17655. (org-entry-put (point) "APPT_WARNTIME" m)))
  17656. ("Agenda Views etc")
  17657. ("v" . org-agenda)
  17658. ("/" . org-sparse-tree)
  17659. ("Misc")
  17660. ("o" . org-open-at-point)
  17661. ("?" . org-speed-command-help)
  17662. ("<" . (org-agenda-set-restriction-lock 'subtree))
  17663. (">" . (org-agenda-remove-restriction-lock))
  17664. )
  17665. "The default speed commands.")
  17666. (defun org-print-speed-command (e)
  17667. (if (> (length (car e)) 1)
  17668. (progn
  17669. (princ "\n")
  17670. (princ (car e))
  17671. (princ "\n")
  17672. (princ (make-string (length (car e)) ?-))
  17673. (princ "\n"))
  17674. (princ (car e))
  17675. (princ " ")
  17676. (if (symbolp (cdr e))
  17677. (princ (symbol-name (cdr e)))
  17678. (prin1 (cdr e)))
  17679. (princ "\n")))
  17680. (defun org-speed-command-help ()
  17681. "Show the available speed commands."
  17682. (interactive)
  17683. (if (not org-use-speed-commands)
  17684. (user-error "Speed commands are not activated, customize `org-use-speed-commands'")
  17685. (with-output-to-temp-buffer "*Help*"
  17686. (princ "User-defined Speed commands\n===========================\n")
  17687. (mapc 'org-print-speed-command org-speed-commands-user)
  17688. (princ "\n")
  17689. (princ "Built-in Speed commands\n=======================\n")
  17690. (mapc 'org-print-speed-command org-speed-commands-default))
  17691. (with-current-buffer "*Help*"
  17692. (setq truncate-lines t))))
  17693. (defun org-speed-move-safe (cmd)
  17694. "Execute CMD, but make sure that the cursor always ends up in a headline.
  17695. If not, return to the original position and throw an error."
  17696. (interactive)
  17697. (let ((pos (point)))
  17698. (call-interactively cmd)
  17699. (unless (and (bolp) (org-at-heading-p))
  17700. (goto-char pos)
  17701. (error "Boundary reached while executing %s" cmd))))
  17702. (defvar org-self-insert-command-undo-counter 0)
  17703. (defvar org-table-auto-blank-field) ; defined in org-table.el
  17704. (defvar org-speed-command nil)
  17705. (define-obsolete-function-alias
  17706. 'org-speed-command-default-hook 'org-speed-command-activate "24.3")
  17707. (defun org-speed-command-activate (keys)
  17708. "Hook for activating single-letter speed commands.
  17709. `org-speed-commands-default' specifies a minimal command set.
  17710. Use `org-speed-commands-user' for further customization."
  17711. (when (or (and (bolp) (looking-at org-outline-regexp))
  17712. (and (functionp org-use-speed-commands)
  17713. (funcall org-use-speed-commands)))
  17714. (cdr (assoc keys (append org-speed-commands-user
  17715. org-speed-commands-default)))))
  17716. (define-obsolete-function-alias
  17717. 'org-babel-speed-command-hook 'org-babel-speed-command-activate "24.3")
  17718. (defun org-babel-speed-command-activate (keys)
  17719. "Hook for activating single-letter code block commands."
  17720. (when (and (bolp) (looking-at org-babel-src-block-regexp))
  17721. (cdr (assoc keys org-babel-key-bindings))))
  17722. (defcustom org-speed-command-hook
  17723. '(org-speed-command-default-hook org-babel-speed-command-hook)
  17724. "Hook for activating speed commands at strategic locations.
  17725. Hook functions are called in sequence until a valid handler is
  17726. found.
  17727. Each hook takes a single argument, a user-pressed command key
  17728. which is also a `self-insert-command' from the global map.
  17729. Within the hook, examine the cursor position and the command key
  17730. and return nil or a valid handler as appropriate. Handler could
  17731. be one of an interactive command, a function, or a form.
  17732. Set `org-use-speed-commands' to non-nil value to enable this
  17733. hook. The default setting is `org-speed-command-activate'."
  17734. :group 'org-structure
  17735. :version "24.1"
  17736. :type 'hook)
  17737. (defun org-self-insert-command (N)
  17738. "Like `self-insert-command', use overwrite-mode for whitespace in tables.
  17739. If the cursor is in a table looking at whitespace, the whitespace is
  17740. overwritten, and the table is not marked as requiring realignment."
  17741. (interactive "p")
  17742. (org-check-before-invisible-edit 'insert)
  17743. (cond
  17744. ((and org-use-speed-commands
  17745. (setq org-speed-command
  17746. (run-hook-with-args-until-success
  17747. 'org-speed-command-hook (this-command-keys))))
  17748. (cond
  17749. ((commandp org-speed-command)
  17750. (setq this-command org-speed-command)
  17751. (call-interactively org-speed-command))
  17752. ((functionp org-speed-command)
  17753. (funcall org-speed-command))
  17754. ((and org-speed-command (listp org-speed-command))
  17755. (eval org-speed-command))
  17756. (t (let (org-use-speed-commands)
  17757. (call-interactively 'org-self-insert-command)))))
  17758. ((and
  17759. (org-table-p)
  17760. (progn
  17761. ;; check if we blank the field, and if that triggers align
  17762. (and (featurep 'org-table) org-table-auto-blank-field
  17763. (member last-command
  17764. '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
  17765. (if (or (equal (char-after) ?\ ) (looking-at "[^|\n]* |"))
  17766. ;; got extra space, this field does not determine column width
  17767. (let (org-table-may-need-update) (org-table-blank-field))
  17768. ;; no extra space, this field may determine column width
  17769. (org-table-blank-field)))
  17770. t)
  17771. (eq N 1)
  17772. (looking-at "[^|\n]* |"))
  17773. (let (org-table-may-need-update)
  17774. (goto-char (1- (match-end 0)))
  17775. (backward-delete-char 1)
  17776. (goto-char (match-beginning 0))
  17777. (self-insert-command N)))
  17778. (t
  17779. (setq org-table-may-need-update t)
  17780. (self-insert-command N)
  17781. (org-fix-tags-on-the-fly)
  17782. (if org-self-insert-cluster-for-undo
  17783. (if (not (eq last-command 'org-self-insert-command))
  17784. (setq org-self-insert-command-undo-counter 1)
  17785. (if (>= org-self-insert-command-undo-counter 20)
  17786. (setq org-self-insert-command-undo-counter 1)
  17787. (and (> org-self-insert-command-undo-counter 0)
  17788. buffer-undo-list (listp buffer-undo-list)
  17789. (not (cadr buffer-undo-list)) ; remove nil entry
  17790. (setcdr buffer-undo-list (cddr buffer-undo-list)))
  17791. (setq org-self-insert-command-undo-counter
  17792. (1+ org-self-insert-command-undo-counter))))))))
  17793. (defun org-check-before-invisible-edit (kind)
  17794. "Check is editing if kind KIND would be dangerous with invisible text around.
  17795. The detailed reaction depends on the user option `org-catch-invisible-edits'."
  17796. ;; First, try to get out of here as quickly as possible, to reduce overhead
  17797. (if (and org-catch-invisible-edits
  17798. (or (not (boundp 'visible-mode)) (not visible-mode))
  17799. (or (get-char-property (point) 'invisible)
  17800. (get-char-property (max (point-min) (1- (point))) 'invisible)))
  17801. ;; OK, we need to take a closer look
  17802. (let* ((invisible-at-point (get-char-property (point) 'invisible))
  17803. (invisible-before-point (if (bobp) nil (get-char-property
  17804. (1- (point)) 'invisible)))
  17805. (border-and-ok-direction
  17806. (or
  17807. ;; Check if we are acting predictably before invisible text
  17808. (and invisible-at-point (not invisible-before-point)
  17809. (memq kind '(insert delete-backward)))
  17810. ;; Check if we are acting predictably after invisible text
  17811. ;; This works not well, and I have turned it off. It seems
  17812. ;; better to always show and stop after invisible text.
  17813. ;; (and (not invisible-at-point) invisible-before-point
  17814. ;; (memq kind '(insert delete)))
  17815. )))
  17816. (when (or (memq invisible-at-point '(outline org-hide-block t))
  17817. (memq invisible-before-point '(outline org-hide-block t)))
  17818. (if (eq org-catch-invisible-edits 'error)
  17819. (user-error "Editing in invisible areas is prohibited, make them visible first"))
  17820. (if (and org-custom-properties-overlays
  17821. (y-or-n-p "Display invisible properties in this buffer? "))
  17822. (org-toggle-custom-properties-visibility)
  17823. ;; Make the area visible
  17824. (save-excursion
  17825. (if invisible-before-point
  17826. (goto-char (previous-single-char-property-change
  17827. (point) 'invisible)))
  17828. (org-cycle))
  17829. (cond
  17830. ((eq org-catch-invisible-edits 'show)
  17831. ;; That's it, we do the edit after showing
  17832. (message
  17833. "Unfolding invisible region around point before editing")
  17834. (sit-for 1))
  17835. ((and (eq org-catch-invisible-edits 'smart)
  17836. border-and-ok-direction)
  17837. (message "Unfolding invisible region around point before editing"))
  17838. (t
  17839. ;; Don't do the edit, make the user repeat it in full visibility
  17840. (user-error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
  17841. (defun org-fix-tags-on-the-fly ()
  17842. (when (and (equal (char-after (point-at-bol)) ?*)
  17843. (org-at-heading-p))
  17844. (org-align-tags-here org-tags-column)))
  17845. (defun org-delete-backward-char (N)
  17846. "Like `delete-backward-char', insert whitespace at field end in tables.
  17847. When deleting backwards, in tables this function will insert whitespace in
  17848. front of the next \"|\" separator, to keep the table aligned. The table will
  17849. still be marked for re-alignment if the field did fill the entire column,
  17850. because, in this case the deletion might narrow the column."
  17851. (interactive "p")
  17852. (save-match-data
  17853. (org-check-before-invisible-edit 'delete-backward)
  17854. (if (and (org-table-p)
  17855. (eq N 1)
  17856. (string-match "|" (buffer-substring (point-at-bol) (point)))
  17857. (looking-at ".*?|"))
  17858. (let ((pos (point))
  17859. (noalign (looking-at "[^|\n\r]* |"))
  17860. (c org-table-may-need-update))
  17861. (backward-delete-char N)
  17862. (if (not overwrite-mode)
  17863. (progn
  17864. (skip-chars-forward "^|")
  17865. (insert " ")
  17866. (goto-char (1- 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. (backward-delete-char N)
  17871. (org-fix-tags-on-the-fly))))
  17872. (defun org-delete-char (N)
  17873. "Like `delete-char', but insert whitespace at field end in tables.
  17874. When deleting characters, in tables this function will insert whitespace in
  17875. front of the next \"|\" separator, to keep the table aligned. The table will
  17876. still be marked for re-alignment if the field did fill the entire column,
  17877. because, in this case the deletion might narrow the column."
  17878. (interactive "p")
  17879. (save-match-data
  17880. (org-check-before-invisible-edit 'delete)
  17881. (if (and (org-table-p)
  17882. (not (bolp))
  17883. (not (= (char-after) ?|))
  17884. (eq N 1))
  17885. (if (looking-at ".*?|")
  17886. (let ((pos (point))
  17887. (noalign (looking-at "[^|\n\r]* |"))
  17888. (c org-table-may-need-update))
  17889. (replace-match
  17890. (concat (substring (match-string 0) 1 -1) " |") nil t)
  17891. (goto-char pos)
  17892. ;; noalign: if there were two spaces at the end, this field
  17893. ;; does not determine the width of the column.
  17894. (if noalign (setq org-table-may-need-update c)))
  17895. (delete-char N))
  17896. (delete-char N)
  17897. (org-fix-tags-on-the-fly))))
  17898. ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
  17899. (put 'org-self-insert-command 'delete-selection t)
  17900. (put 'orgtbl-self-insert-command 'delete-selection t)
  17901. (put 'org-delete-char 'delete-selection 'supersede)
  17902. (put 'org-delete-backward-char 'delete-selection 'supersede)
  17903. (put 'org-yank 'delete-selection 'yank)
  17904. ;; Make `flyspell-mode' delay after some commands
  17905. (put 'org-self-insert-command 'flyspell-delayed t)
  17906. (put 'orgtbl-self-insert-command 'flyspell-delayed t)
  17907. (put 'org-delete-char 'flyspell-delayed t)
  17908. (put 'org-delete-backward-char 'flyspell-delayed t)
  17909. ;; Make pabbrev-mode expand after org-mode commands
  17910. (put 'org-self-insert-command 'pabbrev-expand-after-command t)
  17911. (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
  17912. ;; How to do this: Measure non-white length of current string
  17913. ;; If equal to column width, we should realign.
  17914. (defun org-remap (map &rest commands)
  17915. "In MAP, remap the functions given in COMMANDS.
  17916. COMMANDS is a list of alternating OLDDEF NEWDEF command names."
  17917. (let (new old)
  17918. (while commands
  17919. (setq old (pop commands) new (pop commands))
  17920. (if (fboundp 'command-remapping)
  17921. (org-defkey map (vector 'remap old) new)
  17922. (substitute-key-definition old new map global-map)))))
  17923. (defun org-transpose-words ()
  17924. "Transpose words for Org.
  17925. This uses the `org-mode-transpose-word-syntax-table' syntax
  17926. table, which interprets characters in `org-emphasis-alist' as
  17927. word constituants."
  17928. (interactive)
  17929. (with-syntax-table org-mode-transpose-word-syntax-table
  17930. (call-interactively 'transpose-words)))
  17931. (org-remap org-mode-map 'transpose-words 'org-transpose-words)
  17932. (when (eq org-enable-table-editor 'optimized)
  17933. ;; If the user wants maximum table support, we need to hijack
  17934. ;; some standard editing functions
  17935. (org-remap org-mode-map
  17936. 'self-insert-command 'org-self-insert-command
  17937. 'delete-char 'org-delete-char
  17938. 'delete-backward-char 'org-delete-backward-char)
  17939. (org-defkey org-mode-map "|" 'org-force-self-insert))
  17940. (defvar org-ctrl-c-ctrl-c-hook nil
  17941. "Hook for functions attaching themselves to `C-c C-c'.
  17942. This can be used to add additional functionality to the C-c C-c
  17943. key which executes context-dependent commands. This hook is run
  17944. before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
  17945. run after the last test.
  17946. Each function will be called with no arguments. The function
  17947. must check if the context is appropriate for it to act. If yes,
  17948. it should do its thing and then return a non-nil value. If the
  17949. context is wrong, just do nothing and return nil.")
  17950. (defvar org-ctrl-c-ctrl-c-final-hook nil
  17951. "Hook for functions attaching themselves to `C-c C-c'.
  17952. This can be used to add additional functionality to the C-c C-c
  17953. key which executes context-dependent commands. This hook is run
  17954. after any other test, while `org-ctrl-c-ctrl-c-hook' is run
  17955. before the first test.
  17956. Each function will be called with no arguments. The function
  17957. must check if the context is appropriate for it to act. If yes,
  17958. it should do its thing and then return a non-nil value. If the
  17959. context is wrong, just do nothing and return nil.")
  17960. (defvar org-tab-first-hook nil
  17961. "Hook for functions to attach themselves to TAB.
  17962. See `org-ctrl-c-ctrl-c-hook' for more information.
  17963. This hook runs as the first action when TAB is pressed, even before
  17964. `org-cycle' messes around with the `outline-regexp' to cater for
  17965. inline tasks and plain list item folding.
  17966. If any function in this hook returns t, any other actions that
  17967. would have been caused by TAB (such as table field motion or visibility
  17968. cycling) will not occur.")
  17969. (defvar org-tab-after-check-for-table-hook nil
  17970. "Hook for functions to attach themselves to TAB.
  17971. See `org-ctrl-c-ctrl-c-hook' for more information.
  17972. This hook runs after it has been established that the cursor is not in a
  17973. table, but before checking if the cursor is in a headline or if global cycling
  17974. should be done.
  17975. If any function in this hook returns t, not other actions like visibility
  17976. cycling will be done.")
  17977. (defvar org-tab-after-check-for-cycling-hook nil
  17978. "Hook for functions to attach themselves to TAB.
  17979. See `org-ctrl-c-ctrl-c-hook' for more information.
  17980. This hook runs after it has been established that not table field motion and
  17981. not visibility should be done because of current context. This is probably
  17982. the place where a package like yasnippets can hook in.")
  17983. (defvar org-tab-before-tab-emulation-hook nil
  17984. "Hook for functions to attach themselves to TAB.
  17985. See `org-ctrl-c-ctrl-c-hook' for more information.
  17986. This hook runs after every other options for TAB have been exhausted, but
  17987. before indentation and \t insertion takes place.")
  17988. (defvar org-metaleft-hook nil
  17989. "Hook for functions attaching themselves to `M-left'.
  17990. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17991. (defvar org-metaright-hook nil
  17992. "Hook for functions attaching themselves to `M-right'.
  17993. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17994. (defvar org-metaup-hook nil
  17995. "Hook for functions attaching themselves to `M-up'.
  17996. See `org-ctrl-c-ctrl-c-hook' for more information.")
  17997. (defvar org-metadown-hook nil
  17998. "Hook for functions attaching themselves to `M-down'.
  17999. See `org-ctrl-c-ctrl-c-hook' for more information.")
  18000. (defvar org-shiftmetaleft-hook nil
  18001. "Hook for functions attaching themselves to `M-S-left'.
  18002. See `org-ctrl-c-ctrl-c-hook' for more information.")
  18003. (defvar org-shiftmetaright-hook nil
  18004. "Hook for functions attaching themselves to `M-S-right'.
  18005. See `org-ctrl-c-ctrl-c-hook' for more information.")
  18006. (defvar org-shiftmetaup-hook nil
  18007. "Hook for functions attaching themselves to `M-S-up'.
  18008. See `org-ctrl-c-ctrl-c-hook' for more information.")
  18009. (defvar org-shiftmetadown-hook nil
  18010. "Hook for functions attaching themselves to `M-S-down'.
  18011. See `org-ctrl-c-ctrl-c-hook' for more information.")
  18012. (defvar org-metareturn-hook nil
  18013. "Hook for functions attaching themselves to `M-RET'.
  18014. See `org-ctrl-c-ctrl-c-hook' for more information.")
  18015. (defvar org-shiftup-hook nil
  18016. "Hook for functions attaching themselves to `S-up'.
  18017. See `org-ctrl-c-ctrl-c-hook' for more information.")
  18018. (defvar org-shiftup-final-hook nil
  18019. "Hook for functions attaching themselves to `S-up'.
  18020. This one runs after all other options except shift-select have been excluded.
  18021. See `org-ctrl-c-ctrl-c-hook' for more information.")
  18022. (defvar org-shiftdown-hook nil
  18023. "Hook for functions attaching themselves to `S-down'.
  18024. See `org-ctrl-c-ctrl-c-hook' for more information.")
  18025. (defvar org-shiftdown-final-hook nil
  18026. "Hook for functions attaching themselves to `S-down'.
  18027. This one runs after all other options except shift-select have been excluded.
  18028. See `org-ctrl-c-ctrl-c-hook' for more information.")
  18029. (defvar org-shiftleft-hook nil
  18030. "Hook for functions attaching themselves to `S-left'.
  18031. See `org-ctrl-c-ctrl-c-hook' for more information.")
  18032. (defvar org-shiftleft-final-hook nil
  18033. "Hook for functions attaching themselves to `S-left'.
  18034. This one runs after all other options except shift-select have been excluded.
  18035. See `org-ctrl-c-ctrl-c-hook' for more information.")
  18036. (defvar org-shiftright-hook nil
  18037. "Hook for functions attaching themselves to `S-right'.
  18038. See `org-ctrl-c-ctrl-c-hook' for more information.")
  18039. (defvar org-shiftright-final-hook nil
  18040. "Hook for functions attaching themselves to `S-right'.
  18041. This one runs after all other options except shift-select have been excluded.
  18042. See `org-ctrl-c-ctrl-c-hook' for more information.")
  18043. (defun org-modifier-cursor-error ()
  18044. "Throw an error, a modified cursor command was applied in wrong context."
  18045. (user-error "This command is active in special context like tables, headlines or items"))
  18046. (defun org-shiftselect-error ()
  18047. "Throw an error because Shift-Cursor command was applied in wrong context."
  18048. (if (and (boundp 'shift-select-mode) shift-select-mode)
  18049. (user-error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
  18050. (user-error "This command works only in special context like headlines or timestamps")))
  18051. (defun org-call-for-shift-select (cmd)
  18052. (let ((this-command-keys-shift-translated t))
  18053. (call-interactively cmd)))
  18054. (defun org-shifttab (&optional arg)
  18055. "Global visibility cycling or move to previous table field.
  18056. Call `org-table-previous-field' within a table.
  18057. When ARG is nil, cycle globally through visibility states.
  18058. When ARG is a numeric prefix, show contents of this level."
  18059. (interactive "P")
  18060. (cond
  18061. ((org-at-table-p) (call-interactively 'org-table-previous-field))
  18062. ((integerp arg)
  18063. (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
  18064. (message "Content view to level: %d" arg)
  18065. (org-content (prefix-numeric-value arg2))
  18066. (org-cycle-show-empty-lines t)
  18067. (setq org-cycle-global-status 'overview)))
  18068. (t (call-interactively 'org-global-cycle))))
  18069. (defun org-shiftmetaleft ()
  18070. "Promote subtree or delete table column.
  18071. Calls `org-promote-subtree', `org-outdent-item-tree', or
  18072. `org-table-delete-column', depending on context. See the
  18073. individual commands for more information."
  18074. (interactive)
  18075. (cond
  18076. ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
  18077. ((org-at-table-p) (call-interactively 'org-table-delete-column))
  18078. ((org-at-heading-p) (call-interactively 'org-promote-subtree))
  18079. ((if (not (org-region-active-p)) (org-at-item-p)
  18080. (save-excursion (goto-char (region-beginning))
  18081. (org-at-item-p)))
  18082. (call-interactively 'org-outdent-item-tree))
  18083. (t (org-modifier-cursor-error))))
  18084. (defun org-shiftmetaright ()
  18085. "Demote subtree or insert table column.
  18086. Calls `org-demote-subtree', `org-indent-item-tree', or
  18087. `org-table-insert-column', depending on context. See the
  18088. individual commands for more information."
  18089. (interactive)
  18090. (cond
  18091. ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
  18092. ((org-at-table-p) (call-interactively 'org-table-insert-column))
  18093. ((org-at-heading-p) (call-interactively 'org-demote-subtree))
  18094. ((if (not (org-region-active-p)) (org-at-item-p)
  18095. (save-excursion (goto-char (region-beginning))
  18096. (org-at-item-p)))
  18097. (call-interactively 'org-indent-item-tree))
  18098. (t (org-modifier-cursor-error))))
  18099. (defun org-shiftmetaup (&optional arg)
  18100. "Move subtree up or kill table row.
  18101. Calls `org-move-subtree-up' or `org-table-kill-row' or
  18102. `org-move-item-up' or `org-timestamp-up', depending on context.
  18103. See the individual commands for more information."
  18104. (interactive "P")
  18105. (cond
  18106. ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
  18107. ((org-at-table-p) (call-interactively 'org-table-kill-row))
  18108. ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
  18109. ((org-at-item-p) (call-interactively 'org-move-item-up))
  18110. ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
  18111. (call-interactively 'org-timestamp-up)))
  18112. (t (call-interactively 'org-drag-line-backward))))
  18113. (defun org-shiftmetadown (&optional arg)
  18114. "Move subtree down or insert table row.
  18115. Calls `org-move-subtree-down' or `org-table-insert-row' or
  18116. `org-move-item-down' or `org-timestamp-up', depending on context.
  18117. See the individual commands for more information."
  18118. (interactive "P")
  18119. (cond
  18120. ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
  18121. ((org-at-table-p) (call-interactively 'org-table-insert-row))
  18122. ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
  18123. ((org-at-item-p) (call-interactively 'org-move-item-down))
  18124. ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
  18125. (call-interactively 'org-timestamp-down)))
  18126. (t (call-interactively 'org-drag-line-forward))))
  18127. (defsubst org-hidden-tree-error ()
  18128. (user-error
  18129. "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
  18130. (defun org-metaleft (&optional arg)
  18131. "Promote heading or move table column to left.
  18132. Calls `org-do-promote' or `org-table-move-column', depending on context.
  18133. With no specific context, calls the Emacs default `backward-word'.
  18134. See the individual commands for more information."
  18135. (interactive "P")
  18136. (cond
  18137. ((run-hook-with-args-until-success 'org-metaleft-hook))
  18138. ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
  18139. ((org-with-limited-levels
  18140. (or (org-at-heading-p)
  18141. (and (org-region-active-p)
  18142. (save-excursion
  18143. (goto-char (region-beginning))
  18144. (org-at-heading-p)))))
  18145. (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
  18146. (call-interactively 'org-do-promote))
  18147. ;; At an inline task.
  18148. ((org-at-heading-p)
  18149. (call-interactively 'org-inlinetask-promote))
  18150. ((or (org-at-item-p)
  18151. (and (org-region-active-p)
  18152. (save-excursion
  18153. (goto-char (region-beginning))
  18154. (org-at-item-p))))
  18155. (when (org-check-for-hidden 'items) (org-hidden-tree-error))
  18156. (call-interactively 'org-outdent-item))
  18157. (t (call-interactively 'backward-word))))
  18158. (defun org-metaright (&optional arg)
  18159. "Demote a subtree, a list item or move table column to right.
  18160. In front of a drawer or a block keyword, indent it correctly.
  18161. With no specific context, calls the Emacs default `forward-word'.
  18162. See the individual commands for more information."
  18163. (interactive "P")
  18164. (cond
  18165. ((run-hook-with-args-until-success 'org-metaright-hook))
  18166. ((org-at-table-p) (call-interactively 'org-table-move-column))
  18167. ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
  18168. ((org-at-block-p) (call-interactively 'org-indent-block))
  18169. ((org-with-limited-levels
  18170. (or (org-at-heading-p)
  18171. (and (org-region-active-p)
  18172. (save-excursion
  18173. (goto-char (region-beginning))
  18174. (org-at-heading-p)))))
  18175. (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
  18176. (call-interactively 'org-do-demote))
  18177. ;; At an inline task.
  18178. ((org-at-heading-p)
  18179. (call-interactively 'org-inlinetask-demote))
  18180. ((or (org-at-item-p)
  18181. (and (org-region-active-p)
  18182. (save-excursion
  18183. (goto-char (region-beginning))
  18184. (org-at-item-p))))
  18185. (when (org-check-for-hidden 'items) (org-hidden-tree-error))
  18186. (call-interactively 'org-indent-item))
  18187. (t (call-interactively 'forward-word))))
  18188. (defun org-check-for-hidden (what)
  18189. "Check if there are hidden headlines/items in the current visual line.
  18190. WHAT can be either `headlines' or `items'. If the current line is
  18191. an outline or item heading and it has a folded subtree below it,
  18192. this function returns t, nil otherwise."
  18193. (let ((re (cond
  18194. ((eq what 'headlines) org-outline-regexp-bol)
  18195. ((eq what 'items) (org-item-beginning-re))
  18196. (t (error "This should not happen"))))
  18197. beg end)
  18198. (save-excursion
  18199. (catch 'exit
  18200. (unless (org-region-active-p)
  18201. (setq beg (point-at-bol))
  18202. (beginning-of-line 2)
  18203. (while (and (not (eobp)) ;; this is like `next-line'
  18204. (get-char-property (1- (point)) 'invisible))
  18205. (beginning-of-line 2))
  18206. (setq end (point))
  18207. (goto-char beg)
  18208. (goto-char (point-at-eol))
  18209. (setq end (max end (point)))
  18210. (while (re-search-forward re end t)
  18211. (if (get-char-property (match-beginning 0) 'invisible)
  18212. (throw 'exit t))))
  18213. nil))))
  18214. (defun org-metaup (&optional arg)
  18215. "Move subtree up or move table row up.
  18216. Calls `org-move-subtree-up' or `org-table-move-row' or
  18217. `org-move-item-up', depending on context. See the individual commands
  18218. for more information."
  18219. (interactive "P")
  18220. (cond
  18221. ((run-hook-with-args-until-success 'org-metaup-hook))
  18222. ((org-region-active-p)
  18223. (let* ((a (min (region-beginning) (region-end)))
  18224. (b (1- (max (region-beginning) (region-end))))
  18225. (c (save-excursion (goto-char a)
  18226. (move-beginning-of-line 0)))
  18227. (d (save-excursion (goto-char a)
  18228. (move-end-of-line 0) (point))))
  18229. (transpose-regions a b c d)
  18230. (goto-char c)))
  18231. ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
  18232. ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
  18233. ((org-at-item-p) (call-interactively 'org-move-item-up))
  18234. (t (org-drag-element-backward))))
  18235. (defun org-metadown (&optional arg)
  18236. "Move subtree down or move table row down.
  18237. Calls `org-move-subtree-down' or `org-table-move-row' or
  18238. `org-move-item-down', depending on context. See the individual
  18239. commands for more information."
  18240. (interactive "P")
  18241. (cond
  18242. ((run-hook-with-args-until-success 'org-metadown-hook))
  18243. ((org-region-active-p)
  18244. (let* ((a (min (region-beginning) (region-end)))
  18245. (b (max (region-beginning) (region-end)))
  18246. (c (save-excursion (goto-char b)
  18247. (move-beginning-of-line 1)))
  18248. (d (save-excursion (goto-char b)
  18249. (move-end-of-line 1) (1+ (point)))))
  18250. (transpose-regions a b c d)
  18251. (goto-char d)))
  18252. ((org-at-table-p) (call-interactively 'org-table-move-row))
  18253. ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
  18254. ((org-at-item-p) (call-interactively 'org-move-item-down))
  18255. (t (org-drag-element-forward))))
  18256. (defun org-shiftup (&optional arg)
  18257. "Increase item in timestamp or increase priority of current headline.
  18258. Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
  18259. depending on context. See the individual commands for more information."
  18260. (interactive "P")
  18261. (cond
  18262. ((run-hook-with-args-until-success 'org-shiftup-hook))
  18263. ((and org-support-shift-select (org-region-active-p))
  18264. (org-call-for-shift-select 'previous-line))
  18265. ((org-at-timestamp-p t)
  18266. (call-interactively (if org-edit-timestamp-down-means-later
  18267. 'org-timestamp-down 'org-timestamp-up)))
  18268. ((and (not (eq org-support-shift-select 'always))
  18269. org-enable-priority-commands
  18270. (org-at-heading-p))
  18271. (call-interactively 'org-priority-up))
  18272. ((and (not org-support-shift-select) (org-at-item-p))
  18273. (call-interactively 'org-previous-item))
  18274. ((org-clocktable-try-shift 'up arg))
  18275. ((run-hook-with-args-until-success 'org-shiftup-final-hook))
  18276. (org-support-shift-select
  18277. (org-call-for-shift-select 'previous-line))
  18278. (t (org-shiftselect-error))))
  18279. (defun org-shiftdown (&optional arg)
  18280. "Decrease item in timestamp or decrease priority of current headline.
  18281. Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
  18282. depending on context. See the individual commands for more information."
  18283. (interactive "P")
  18284. (cond
  18285. ((run-hook-with-args-until-success 'org-shiftdown-hook))
  18286. ((and org-support-shift-select (org-region-active-p))
  18287. (org-call-for-shift-select 'next-line))
  18288. ((org-at-timestamp-p t)
  18289. (call-interactively (if org-edit-timestamp-down-means-later
  18290. 'org-timestamp-up 'org-timestamp-down)))
  18291. ((and (not (eq org-support-shift-select 'always))
  18292. org-enable-priority-commands
  18293. (org-at-heading-p))
  18294. (call-interactively 'org-priority-down))
  18295. ((and (not org-support-shift-select) (org-at-item-p))
  18296. (call-interactively 'org-next-item))
  18297. ((org-clocktable-try-shift 'down arg))
  18298. ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
  18299. (org-support-shift-select
  18300. (org-call-for-shift-select 'next-line))
  18301. (t (org-shiftselect-error))))
  18302. (defun org-shiftright (&optional arg)
  18303. "Cycle the thing at point or in the current line, depending on context.
  18304. Depending on context, this does one of the following:
  18305. - switch a timestamp at point one day into the future
  18306. - on a headline, switch to the next TODO keyword.
  18307. - on an item, switch entire list to the next bullet type
  18308. - on a property line, switch to the next allowed value
  18309. - on a clocktable definition line, move time block into the future"
  18310. (interactive "P")
  18311. (cond
  18312. ((run-hook-with-args-until-success 'org-shiftright-hook))
  18313. ((and org-support-shift-select (org-region-active-p))
  18314. (org-call-for-shift-select 'forward-char))
  18315. ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
  18316. ((and (not (eq org-support-shift-select 'always))
  18317. (org-at-heading-p))
  18318. (let ((org-inhibit-logging
  18319. (not org-treat-S-cursor-todo-selection-as-state-change))
  18320. (org-inhibit-blocking
  18321. (not org-treat-S-cursor-todo-selection-as-state-change)))
  18322. (org-call-with-arg 'org-todo 'right)))
  18323. ((or (and org-support-shift-select
  18324. (not (eq org-support-shift-select 'always))
  18325. (org-at-item-bullet-p))
  18326. (and (not org-support-shift-select) (org-at-item-p)))
  18327. (org-call-with-arg 'org-cycle-list-bullet nil))
  18328. ((and (not (eq org-support-shift-select 'always))
  18329. (org-at-property-p))
  18330. (call-interactively 'org-property-next-allowed-value))
  18331. ((org-clocktable-try-shift 'right arg))
  18332. ((run-hook-with-args-until-success 'org-shiftright-final-hook))
  18333. (org-support-shift-select
  18334. (org-call-for-shift-select 'forward-char))
  18335. (t (org-shiftselect-error))))
  18336. (defun org-shiftleft (&optional arg)
  18337. "Cycle the thing at point or in the current line, depending on context.
  18338. Depending on context, this does one of the following:
  18339. - switch a timestamp at point one day into the past
  18340. - on a headline, switch to the previous TODO keyword.
  18341. - on an item, switch entire list to the previous bullet type
  18342. - on a property line, switch to the previous allowed value
  18343. - on a clocktable definition line, move time block into the past"
  18344. (interactive "P")
  18345. (cond
  18346. ((run-hook-with-args-until-success 'org-shiftleft-hook))
  18347. ((and org-support-shift-select (org-region-active-p))
  18348. (org-call-for-shift-select 'backward-char))
  18349. ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
  18350. ((and (not (eq org-support-shift-select 'always))
  18351. (org-at-heading-p))
  18352. (let ((org-inhibit-logging
  18353. (not org-treat-S-cursor-todo-selection-as-state-change))
  18354. (org-inhibit-blocking
  18355. (not org-treat-S-cursor-todo-selection-as-state-change)))
  18356. (org-call-with-arg 'org-todo 'left)))
  18357. ((or (and org-support-shift-select
  18358. (not (eq org-support-shift-select 'always))
  18359. (org-at-item-bullet-p))
  18360. (and (not org-support-shift-select) (org-at-item-p)))
  18361. (org-call-with-arg 'org-cycle-list-bullet 'previous))
  18362. ((and (not (eq org-support-shift-select 'always))
  18363. (org-at-property-p))
  18364. (call-interactively 'org-property-previous-allowed-value))
  18365. ((org-clocktable-try-shift 'left arg))
  18366. ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
  18367. (org-support-shift-select
  18368. (org-call-for-shift-select 'backward-char))
  18369. (t (org-shiftselect-error))))
  18370. (defun org-shiftcontrolright ()
  18371. "Switch to next TODO set."
  18372. (interactive)
  18373. (cond
  18374. ((and org-support-shift-select (org-region-active-p))
  18375. (org-call-for-shift-select 'forward-word))
  18376. ((and (not (eq org-support-shift-select 'always))
  18377. (org-at-heading-p))
  18378. (org-call-with-arg 'org-todo 'nextset))
  18379. (org-support-shift-select
  18380. (org-call-for-shift-select 'forward-word))
  18381. (t (org-shiftselect-error))))
  18382. (defun org-shiftcontrolleft ()
  18383. "Switch to previous TODO set."
  18384. (interactive)
  18385. (cond
  18386. ((and org-support-shift-select (org-region-active-p))
  18387. (org-call-for-shift-select 'backward-word))
  18388. ((and (not (eq org-support-shift-select 'always))
  18389. (org-at-heading-p))
  18390. (org-call-with-arg 'org-todo 'previousset))
  18391. (org-support-shift-select
  18392. (org-call-for-shift-select 'backward-word))
  18393. (t (org-shiftselect-error))))
  18394. (defun org-shiftcontrolup (&optional n)
  18395. "Change timestamps synchronously up in CLOCK log lines.
  18396. Optional argument N tells to change by that many units."
  18397. (interactive "P")
  18398. (cond ((and (not org-support-shift-select)
  18399. (org-at-clock-log-p)
  18400. (org-at-timestamp-p t))
  18401. (org-clock-timestamps-up n))
  18402. (t (org-shiftselect-error))))
  18403. (defun org-shiftcontroldown (&optional n)
  18404. "Change timestamps synchronously down in CLOCK log lines.
  18405. Optional argument N tells to change by that many units."
  18406. (interactive "P")
  18407. (cond ((and (not org-support-shift-select)
  18408. (org-at-clock-log-p)
  18409. (org-at-timestamp-p t))
  18410. (org-clock-timestamps-down n))
  18411. (t (org-shiftselect-error))))
  18412. (defun org-ctrl-c-ret ()
  18413. "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
  18414. (interactive)
  18415. (cond
  18416. ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
  18417. (t (call-interactively 'org-insert-heading))))
  18418. (defun org-find-visible ()
  18419. (let ((s (point)))
  18420. (while (and (not (= (point-max) (setq s (next-overlay-change s))))
  18421. (get-char-property s 'invisible)))
  18422. s))
  18423. (defun org-find-invisible ()
  18424. (let ((s (point)))
  18425. (while (and (not (= (point-max) (setq s (next-overlay-change s))))
  18426. (not (get-char-property s 'invisible))))
  18427. s))
  18428. (defun org-copy-visible (beg end)
  18429. "Copy the visible parts of the region."
  18430. (interactive "r")
  18431. (let (snippets s)
  18432. (save-excursion
  18433. (save-restriction
  18434. (narrow-to-region beg end)
  18435. (setq s (goto-char (point-min)))
  18436. (while (not (= (point) (point-max)))
  18437. (goto-char (org-find-invisible))
  18438. (push (buffer-substring s (point)) snippets)
  18439. (setq s (goto-char (org-find-visible))))))
  18440. (kill-new (apply 'concat (nreverse snippets)))))
  18441. (defun org-copy-special ()
  18442. "Copy region in table or copy current subtree.
  18443. Calls `org-table-copy' or `org-copy-subtree', depending on context.
  18444. See the individual commands for more information."
  18445. (interactive)
  18446. (call-interactively
  18447. (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
  18448. (defun org-cut-special ()
  18449. "Cut region in table or cut current subtree.
  18450. Calls `org-table-copy' or `org-cut-subtree', depending on context.
  18451. See the individual commands for more information."
  18452. (interactive)
  18453. (call-interactively
  18454. (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
  18455. (defun org-paste-special (arg)
  18456. "Paste rectangular region into table, or past subtree relative to level.
  18457. Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
  18458. See the individual commands for more information."
  18459. (interactive "P")
  18460. (if (org-at-table-p)
  18461. (org-table-paste-rectangle)
  18462. (org-paste-subtree arg)))
  18463. (defsubst org-in-fixed-width-region-p ()
  18464. "Is point in a fixed-width region?"
  18465. (save-match-data
  18466. (eq 'fixed-width (org-element-type (org-element-at-point)))))
  18467. (defun org-edit-special (&optional arg)
  18468. "Call a special editor for the element at point.
  18469. When at a table, call the formula editor with `org-table-edit-formulas'.
  18470. When in a source code block, call `org-edit-src-code'.
  18471. When in a fixed-width region, call `org-edit-fixed-width-region'.
  18472. When at an #+INCLUDE keyword, visit the included file.
  18473. On a link, call `ffap' to visit the link at point.
  18474. Otherwise, return a user error."
  18475. (interactive "P")
  18476. (let ((element (org-element-at-point)))
  18477. (assert (not buffer-read-only) nil
  18478. "Buffer is read-only: %s" (buffer-name))
  18479. (case (org-element-type element)
  18480. (src-block
  18481. (if (not arg) (org-edit-src-code)
  18482. (let* ((info (org-babel-get-src-block-info))
  18483. (lang (nth 0 info))
  18484. (params (nth 2 info))
  18485. (session (cdr (assq :session params))))
  18486. (if (not session) (org-edit-src-code)
  18487. ;; At a src-block with a session and function called with
  18488. ;; an ARG: switch to the buffer related to the inferior
  18489. ;; process.
  18490. (switch-to-buffer
  18491. (funcall (intern (concat "org-babel-prep-session:" lang))
  18492. session params))))))
  18493. (keyword
  18494. (if (member (org-element-property :key element) '("INCLUDE" "SETUPFILE"))
  18495. (find-file
  18496. (org-remove-double-quotes
  18497. (car (org-split-string (org-element-property :value element)))))
  18498. (user-error "No special environment to edit here")))
  18499. (table
  18500. (if (eq (org-element-property :type element) 'table.el)
  18501. (org-edit-src-code)
  18502. (call-interactively 'org-table-edit-formulas)))
  18503. ;; Only Org tables contain `table-row' type elements.
  18504. (table-row (call-interactively 'org-table-edit-formulas))
  18505. ((example-block export-block) (org-edit-src-code))
  18506. (fixed-width (org-edit-fixed-width-region))
  18507. (otherwise
  18508. ;; No notable element at point. Though, we may be at a link,
  18509. ;; which is an object. Thus, scan deeper.
  18510. (if (eq (org-element-type (org-element-context element)) 'link)
  18511. (call-interactively 'ffap)
  18512. (user-error "No special environment to edit here"))))))
  18513. (defvar org-table-coordinate-overlays) ; defined in org-table.el
  18514. (defun org-ctrl-c-ctrl-c (&optional arg)
  18515. "Set tags in headline, or update according to changed information at point.
  18516. This command does many different things, depending on context:
  18517. - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
  18518. this is what we do.
  18519. - If the cursor is on a statistics cookie, update it.
  18520. - If the cursor is in a headline, prompt for tags and insert them
  18521. into the current line, aligned to `org-tags-column'. When called
  18522. with prefix arg, realign all tags in the current buffer.
  18523. - If the cursor is in one of the special #+KEYWORD lines, this
  18524. triggers scanning the buffer for these lines and updating the
  18525. information.
  18526. - If the cursor is inside a table, realign the table. This command
  18527. works even if the automatic table editor has been turned off.
  18528. - If the cursor is on a #+TBLFM line, re-apply the formulas to
  18529. the entire table.
  18530. - If the cursor is at a footnote reference or definition, jump to
  18531. the corresponding definition or references, respectively.
  18532. - If the cursor is a the beginning of a dynamic block, update it.
  18533. - If the current buffer is a capture buffer, close note and file it.
  18534. - If the cursor is on a <<<target>>>, update radio targets and
  18535. corresponding links in this buffer.
  18536. - If the cursor is on a numbered item in a plain list, renumber the
  18537. ordered list.
  18538. - If the cursor is on a checkbox, toggle it.
  18539. - If the cursor is on a code block, evaluate it. The variable
  18540. `org-confirm-babel-evaluate' can be used to control prompting
  18541. before code block evaluation, by default every code block
  18542. evaluation requires confirmation. Code block evaluation can be
  18543. inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
  18544. (interactive "P")
  18545. (cond
  18546. ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
  18547. org-occur-highlights
  18548. org-latex-fragment-image-overlays)
  18549. (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
  18550. (org-remove-occur-highlights)
  18551. (org-remove-latex-fragment-image-overlays)
  18552. (message "Temporary highlights/overlays removed from current buffer"))
  18553. ((and (local-variable-p 'org-finish-function (current-buffer))
  18554. (fboundp org-finish-function))
  18555. (funcall org-finish-function))
  18556. ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
  18557. (t
  18558. (let* ((context (org-element-context)) (type (org-element-type context)))
  18559. ;; Test if point is within a blank line.
  18560. (if (save-excursion (beginning-of-line) (looking-at "[ \t]*$"))
  18561. (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
  18562. (user-error "C-c C-c can do nothing useful at this location"))
  18563. ;; When at a link, act according to the parent instead.
  18564. (when (eq type 'link)
  18565. (setq context (org-element-property :parent context))
  18566. (setq type (org-element-type context)))
  18567. ;; For convenience: at the first line of a paragraph on the
  18568. ;; same line as an item, apply function on that item instead.
  18569. (when (eq type 'paragraph)
  18570. (let ((parent (org-element-property :parent context)))
  18571. (when (and (eq (org-element-type parent) 'item)
  18572. (= (point-at-bol) (org-element-property :begin parent)))
  18573. (setq context parent type 'item))))
  18574. ;; Act according to type of element or object at point.
  18575. (case type
  18576. (clock (org-clock-update-time-maybe))
  18577. (dynamic-block
  18578. (save-excursion
  18579. (goto-char (org-element-property :post-affiliated context))
  18580. (org-update-dblock)))
  18581. (footnote-definition
  18582. (goto-char (org-element-property :post-affiliated context))
  18583. (call-interactively 'org-footnote-action))
  18584. (footnote-reference (call-interactively 'org-footnote-action))
  18585. ((headline inlinetask)
  18586. (save-excursion (goto-char (org-element-property :begin context))
  18587. (call-interactively 'org-set-tags)))
  18588. (item
  18589. ;; At an item: a double C-u set checkbox to "[-]"
  18590. ;; unconditionally, whereas a single one will toggle its
  18591. ;; presence. Without an universal argument, if the item
  18592. ;; has a checkbox, toggle it. Otherwise repair the list.
  18593. (let* ((box (org-element-property :checkbox context))
  18594. (struct (org-element-property :structure context))
  18595. (old-struct (copy-tree struct))
  18596. (parents (org-list-parents-alist struct))
  18597. (prevs (org-list-prevs-alist struct))
  18598. (orderedp (org-not-nil (org-entry-get nil "ORDERED"))))
  18599. (org-list-set-checkbox
  18600. (org-element-property :begin context) struct
  18601. (cond ((equal arg '(16)) "[-]")
  18602. ((and (not box) (equal arg '(4))) "[ ]")
  18603. ((or (not box) (equal arg '(4))) nil)
  18604. ((eq box 'on) "[ ]")
  18605. (t "[X]")))
  18606. ;; Mimic `org-list-write-struct' but with grabbing
  18607. ;; a return value from `org-list-struct-fix-box'.
  18608. (org-list-struct-fix-ind struct parents 2)
  18609. (org-list-struct-fix-item-end struct)
  18610. (org-list-struct-fix-bul struct prevs)
  18611. (org-list-struct-fix-ind struct parents)
  18612. (let ((block-item
  18613. (org-list-struct-fix-box struct parents prevs orderedp)))
  18614. (if (and box (equal struct old-struct))
  18615. (if (equal arg '(16))
  18616. (message "Checkboxes already reset")
  18617. (user-error "Cannot toggle this checkbox: %s"
  18618. (if (eq box 'on)
  18619. "all subitems checked"
  18620. "unchecked subitems")))
  18621. (org-list-struct-apply-struct struct old-struct)
  18622. (org-update-checkbox-count-maybe))
  18623. (when block-item
  18624. (message "Checkboxes were removed due to empty box at line %d"
  18625. (org-current-line block-item))))))
  18626. (keyword
  18627. (let ((org-inhibit-startup-visibility-stuff t)
  18628. (org-startup-align-all-tables nil))
  18629. (when (boundp 'org-table-coordinate-overlays)
  18630. (mapc 'delete-overlay org-table-coordinate-overlays)
  18631. (setq org-table-coordinate-overlays nil))
  18632. (org-save-outline-visibility 'use-markers (org-mode-restart)))
  18633. (message "Local setup has been refreshed"))
  18634. (plain-list
  18635. ;; At a plain list, with a double C-u argument, set
  18636. ;; checkboxes of each item to "[-]", whereas a single one
  18637. ;; will toggle their presence according to the state of the
  18638. ;; first item in the list. Without an argument, repair the
  18639. ;; list.
  18640. (let* ((begin (org-element-property :contents-begin context))
  18641. (beginm (move-marker (make-marker) begin))
  18642. (struct (org-element-property :structure context))
  18643. (old-struct (copy-tree struct))
  18644. (first-box (save-excursion
  18645. (goto-char begin)
  18646. (looking-at org-list-full-item-re)
  18647. (match-string-no-properties 3)))
  18648. (new-box (cond ((equal arg '(16)) "[-]")
  18649. ((equal arg '(4)) (unless first-box "[ ]"))
  18650. ((equal first-box "[X]") "[ ]")
  18651. (t "[X]"))))
  18652. (cond
  18653. (arg
  18654. (mapc (lambda (pos) (org-list-set-checkbox pos struct new-box))
  18655. (org-list-get-all-items
  18656. begin struct (org-list-prevs-alist struct))))
  18657. ((and first-box (eq (point) begin))
  18658. ;; For convenience, when point is at bol on the first
  18659. ;; item of the list and no argument is provided, simply
  18660. ;; toggle checkbox of that item, if any.
  18661. (org-list-set-checkbox begin struct new-box)))
  18662. (org-list-write-struct
  18663. struct (org-list-parents-alist struct) old-struct)
  18664. (org-update-checkbox-count-maybe)
  18665. (save-excursion (goto-char beginm) (org-list-send-list 'maybe))))
  18666. ((property-drawer node-property)
  18667. (call-interactively 'org-property-action))
  18668. ((radio-target target)
  18669. (call-interactively 'org-update-radio-target-regexp))
  18670. (statistics-cookie
  18671. (call-interactively 'org-update-statistics-cookies))
  18672. ((table table-cell table-row)
  18673. ;; At a table, recalculate every field and align it. Also
  18674. ;; send the table if necessary. If the table has
  18675. ;; a `table.el' type, just give up. At a table row or
  18676. ;; cell, maybe recalculate line but always align table.
  18677. (if (eq (org-element-property :type context) 'table.el)
  18678. (message "Use C-c ' to edit table.el tables")
  18679. (let ((org-enable-table-editor t))
  18680. (if (or (eq type 'table)
  18681. ;; Check if point is at a TBLFM line.
  18682. (and (eq type 'table-row)
  18683. (= (point) (org-element-property :end context))))
  18684. (save-excursion
  18685. (if (org-at-TBLFM-p)
  18686. (progn (require 'org-table)
  18687. (org-table-calc-current-TBLFM))
  18688. (goto-char (org-element-property :contents-begin context))
  18689. (org-call-with-arg 'org-table-recalculate (or arg t))
  18690. (orgtbl-send-table 'maybe)))
  18691. (org-table-maybe-eval-formula)
  18692. (cond (arg (call-interactively 'org-table-recalculate))
  18693. ((org-table-maybe-recalculate-line))
  18694. (t (org-table-align)))))))
  18695. (timestamp (org-timestamp-change 0 'day))
  18696. (otherwise
  18697. (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
  18698. (user-error
  18699. "C-c C-c can do nothing useful at this location")))))))))
  18700. (defun org-mode-restart ()
  18701. "Restart Org-mode, to scan again for special lines.
  18702. Also updates the keyword regular expressions."
  18703. (interactive)
  18704. (org-mode)
  18705. (message "Org-mode restarted"))
  18706. (defun org-kill-note-or-show-branches ()
  18707. "If this is a Note buffer, abort storing the note. Else call `show-branches'."
  18708. (interactive)
  18709. (if (not org-finish-function)
  18710. (progn
  18711. (hide-subtree)
  18712. (call-interactively 'show-branches))
  18713. (let ((org-note-abort t))
  18714. (funcall org-finish-function))))
  18715. (defun org-open-line (n)
  18716. "Insert a new row in tables, call `open-line' elsewhere.
  18717. If `org-special-ctrl-o' is nil, just call `open-line' everywhere."
  18718. (interactive "*p")
  18719. (cond
  18720. ((not org-special-ctrl-o)
  18721. (open-line n))
  18722. ((org-at-table-p)
  18723. (org-table-insert-row))
  18724. (t
  18725. (open-line n))))
  18726. (defun org-return (&optional indent)
  18727. "Goto next table row or insert a newline.
  18728. Calls `org-table-next-row' or `newline', depending on context.
  18729. See the individual commands for more information."
  18730. (interactive)
  18731. (let (org-ts-what)
  18732. (cond
  18733. ((or (bobp) (org-in-src-block-p))
  18734. (if indent (newline-and-indent) (newline)))
  18735. ((org-at-table-p)
  18736. (org-table-justify-field-maybe)
  18737. (call-interactively 'org-table-next-row))
  18738. ;; when `newline-and-indent' is called within a list, make sure
  18739. ;; text moved stays inside the item.
  18740. ((and (org-in-item-p) indent)
  18741. (if (and (org-at-item-p) (>= (point) (match-end 0)))
  18742. (progn
  18743. (save-match-data (newline))
  18744. (org-indent-line-to (length (match-string 0))))
  18745. (let ((ind (org-get-indentation)))
  18746. (newline)
  18747. (if (org-looking-back org-list-end-re)
  18748. (org-indent-line)
  18749. (org-indent-line-to ind)))))
  18750. ((and org-return-follows-link
  18751. (org-at-timestamp-p t)
  18752. (not (eq org-ts-what 'after)))
  18753. (org-follow-timestamp-link))
  18754. ((and org-return-follows-link
  18755. (let ((tprop (get-text-property (point) 'face)))
  18756. (or (eq tprop 'org-link)
  18757. (and (listp tprop) (memq 'org-link tprop)))))
  18758. (call-interactively 'org-open-at-point))
  18759. ((and (org-at-heading-p)
  18760. (looking-at
  18761. (org-re "\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$")))
  18762. (org-show-entry)
  18763. (end-of-line 1)
  18764. (newline))
  18765. (t (if indent (newline-and-indent) (newline))))))
  18766. (defun org-return-indent ()
  18767. "Goto next table row or insert a newline and indent.
  18768. Calls `org-table-next-row' or `newline-and-indent', depending on
  18769. context. See the individual commands for more information."
  18770. (interactive)
  18771. (org-return t))
  18772. (defun org-ctrl-c-star ()
  18773. "Compute table, or change heading status of lines.
  18774. Calls `org-table-recalculate' or `org-toggle-heading',
  18775. depending on context."
  18776. (interactive)
  18777. (cond
  18778. ((org-at-table-p)
  18779. (call-interactively 'org-table-recalculate))
  18780. (t
  18781. ;; Convert all lines in region to list items
  18782. (call-interactively 'org-toggle-heading))))
  18783. (defun org-ctrl-c-minus ()
  18784. "Insert separator line in table or modify bullet status of line.
  18785. Also turns a plain line or a region of lines into list items.
  18786. Calls `org-table-insert-hline', `org-toggle-item', or
  18787. `org-cycle-list-bullet', depending on context."
  18788. (interactive)
  18789. (cond
  18790. ((org-at-table-p)
  18791. (call-interactively 'org-table-insert-hline))
  18792. ((org-region-active-p)
  18793. (call-interactively 'org-toggle-item))
  18794. ((org-in-item-p)
  18795. (call-interactively 'org-cycle-list-bullet))
  18796. (t
  18797. (call-interactively 'org-toggle-item))))
  18798. (defun org-toggle-item (arg)
  18799. "Convert headings or normal lines to items, items to normal lines.
  18800. If there is no active region, only the current line is considered.
  18801. If the first non blank line in the region is a headline, convert
  18802. all headlines to items, shifting text accordingly.
  18803. If it is an item, convert all items to normal lines.
  18804. If it is normal text, change region into a list of items.
  18805. With a prefix argument ARG, change the region in a single item."
  18806. (interactive "P")
  18807. (let ((shift-text
  18808. (function
  18809. ;; Shift text in current section to IND, from point to END.
  18810. ;; The function leaves point to END line.
  18811. (lambda (ind end)
  18812. (let ((min-i 1000) (end (copy-marker end)))
  18813. ;; First determine the minimum indentation (MIN-I) of
  18814. ;; the text.
  18815. (save-excursion
  18816. (catch 'exit
  18817. (while (< (point) end)
  18818. (let ((i (org-get-indentation)))
  18819. (cond
  18820. ;; Skip blank lines and inline tasks.
  18821. ((looking-at "^[ \t]*$"))
  18822. ((looking-at org-outline-regexp-bol))
  18823. ;; We can't find less than 0 indentation.
  18824. ((zerop i) (throw 'exit (setq min-i 0)))
  18825. ((< i min-i) (setq min-i i))))
  18826. (forward-line))))
  18827. ;; Then indent each line so that a line indented to
  18828. ;; MIN-I becomes indented to IND. Ignore blank lines
  18829. ;; and inline tasks in the process.
  18830. (let ((delta (- ind min-i)))
  18831. (while (< (point) end)
  18832. (unless (or (looking-at "^[ \t]*$")
  18833. (looking-at org-outline-regexp-bol))
  18834. (org-indent-line-to (+ (org-get-indentation) delta)))
  18835. (forward-line)))))))
  18836. (skip-blanks
  18837. (function
  18838. ;; Return beginning of first non-blank line, starting from
  18839. ;; line at POS.
  18840. (lambda (pos)
  18841. (save-excursion
  18842. (goto-char pos)
  18843. (skip-chars-forward " \r\t\n")
  18844. (point-at-bol)))))
  18845. beg end)
  18846. ;; Determine boundaries of changes.
  18847. (if (org-region-active-p)
  18848. (setq beg (funcall skip-blanks (region-beginning))
  18849. end (copy-marker (region-end)))
  18850. (setq beg (funcall skip-blanks (point-at-bol))
  18851. end (copy-marker (point-at-eol))))
  18852. ;; Depending on the starting line, choose an action on the text
  18853. ;; between BEG and END.
  18854. (org-with-limited-levels
  18855. (save-excursion
  18856. (goto-char beg)
  18857. (cond
  18858. ;; Case 1. Start at an item: de-itemize. Note that it only
  18859. ;; happens when a region is active: `org-ctrl-c-minus'
  18860. ;; would call `org-cycle-list-bullet' otherwise.
  18861. ((org-at-item-p)
  18862. (while (< (point) end)
  18863. (when (org-at-item-p)
  18864. (skip-chars-forward " \t")
  18865. (delete-region (point) (match-end 0)))
  18866. (forward-line)))
  18867. ;; Case 2. Start at an heading: convert to items.
  18868. ((org-at-heading-p)
  18869. (let* ((bul (org-list-bullet-string "-"))
  18870. (bul-len (length bul))
  18871. ;; Indentation of the first heading. It should be
  18872. ;; relative to the indentation of its parent, if any.
  18873. (start-ind (save-excursion
  18874. (cond
  18875. ((not org-adapt-indentation) 0)
  18876. ((not (outline-previous-heading)) 0)
  18877. (t (length (match-string 0))))))
  18878. ;; Level of first heading. Further headings will be
  18879. ;; compared to it to determine hierarchy in the list.
  18880. (ref-level (org-reduced-level (org-outline-level))))
  18881. (while (< (point) end)
  18882. (let* ((level (org-reduced-level (org-outline-level)))
  18883. (delta (max 0 (- level ref-level))))
  18884. ;; If current headline is less indented than the first
  18885. ;; one, set it as reference, in order to preserve
  18886. ;; subtrees.
  18887. (when (< level ref-level) (setq ref-level level))
  18888. (replace-match bul t t)
  18889. (org-indent-line-to (+ start-ind (* delta bul-len)))
  18890. ;; Ensure all text down to END (or SECTION-END) belongs
  18891. ;; to the newly created item.
  18892. (let ((section-end (save-excursion
  18893. (or (outline-next-heading) (point)))))
  18894. (forward-line)
  18895. (funcall shift-text
  18896. (+ start-ind (* (1+ delta) bul-len))
  18897. (min end section-end)))))))
  18898. ;; Case 3. Normal line with ARG: make the first line of region
  18899. ;; an item, and shift indentation of others lines to
  18900. ;; set them as item's body.
  18901. (arg (let* ((bul (org-list-bullet-string "-"))
  18902. (bul-len (length bul))
  18903. (ref-ind (org-get-indentation)))
  18904. (skip-chars-forward " \t")
  18905. (insert bul)
  18906. (forward-line)
  18907. (while (< (point) end)
  18908. ;; Ensure that lines less indented than first one
  18909. ;; still get included in item body.
  18910. (funcall shift-text
  18911. (+ ref-ind bul-len)
  18912. (min end (save-excursion (or (outline-next-heading)
  18913. (point)))))
  18914. (forward-line))))
  18915. ;; Case 4. Normal line without ARG: turn each non-item line
  18916. ;; into an item.
  18917. (t
  18918. (while (< (point) end)
  18919. (unless (or (org-at-heading-p) (org-at-item-p))
  18920. (if (looking-at "\\([ \t]*\\)\\(\\S-\\)")
  18921. (replace-match
  18922. (concat "\\1" (org-list-bullet-string "-") "\\2"))))
  18923. (forward-line))))))))
  18924. (defun org-toggle-heading (&optional nstars)
  18925. "Convert headings to normal text, or items or text to headings.
  18926. If there is no active region, only convert the current line.
  18927. With a \\[universal-argument] prefix, convert the whole list at
  18928. point into heading.
  18929. In a region:
  18930. - If the first non blank line is a headline, remove the stars
  18931. from all headlines in the region.
  18932. - If it is a normal line, turn each and every normal line (i.e.,
  18933. not an heading or an item) in the region into headings. If you
  18934. want to convert only the first line of this region, use one
  18935. universal prefix argument.
  18936. - If it is a plain list item, turn all plain list items into headings.
  18937. When converting a line into a heading, the number of stars is chosen
  18938. such that the lines become children of the current entry. However,
  18939. when a numeric prefix argument is given, its value determines the
  18940. number of stars to add."
  18941. (interactive "P")
  18942. (let ((skip-blanks
  18943. (function
  18944. ;; Return beginning of first non-blank line, starting from
  18945. ;; line at POS.
  18946. (lambda (pos)
  18947. (save-excursion
  18948. (goto-char pos)
  18949. (while (org-at-comment-p) (forward-line))
  18950. (skip-chars-forward " \r\t\n")
  18951. (point-at-bol)))))
  18952. beg end toggled)
  18953. ;; Determine boundaries of changes. If a universal prefix has
  18954. ;; been given, put the list in a region. If region ends at a bol,
  18955. ;; do not consider the last line to be in the region.
  18956. (when (and current-prefix-arg (org-at-item-p))
  18957. (if (listp current-prefix-arg) (setq current-prefix-arg 1))
  18958. (org-mark-element))
  18959. (if (org-region-active-p)
  18960. (setq beg (funcall skip-blanks (region-beginning))
  18961. end (copy-marker (save-excursion
  18962. (goto-char (region-end))
  18963. (if (bolp) (point) (point-at-eol)))))
  18964. (setq beg (funcall skip-blanks (point-at-bol))
  18965. end (copy-marker (point-at-eol))))
  18966. ;; Ensure inline tasks don't count as headings.
  18967. (org-with-limited-levels
  18968. (save-excursion
  18969. (goto-char beg)
  18970. (cond
  18971. ;; Case 1. Started at an heading: de-star headings.
  18972. ((org-at-heading-p)
  18973. (while (< (point) end)
  18974. (when (org-at-heading-p t)
  18975. (looking-at org-outline-regexp) (replace-match "")
  18976. (setq toggled t))
  18977. (forward-line)))
  18978. ;; Case 2. Started at an item: change items into headlines.
  18979. ;; One star will be added by `org-list-to-subtree'.
  18980. ((org-at-item-p)
  18981. (let* ((stars (make-string
  18982. ;; subtract the star that will be added again by
  18983. ;; `org-list-to-subtree'
  18984. (if (numberp nstars) (1- nstars)
  18985. (or (org-current-level) 0))
  18986. ?*))
  18987. (add-stars
  18988. (cond (nstars "") ; stars from prefix only
  18989. ((equal stars "") "") ; before first heading
  18990. (org-odd-levels-only "*") ; inside heading, odd
  18991. (t "")))) ; inside heading, oddeven
  18992. (while (< (point) end)
  18993. (when (org-at-item-p)
  18994. ;; Pay attention to cases when region ends before list.
  18995. (let* ((struct (org-list-struct))
  18996. (list-end (min (org-list-get-bottom-point struct) (1+ end))))
  18997. (save-restriction
  18998. (narrow-to-region (point) list-end)
  18999. (insert
  19000. (org-list-to-subtree
  19001. (org-list-parse-list t)
  19002. '(:istart (concat stars add-stars (funcall get-stars depth))
  19003. :icount (concat stars add-stars (funcall get-stars depth)))))))
  19004. (setq toggled t))
  19005. (forward-line))))
  19006. ;; Case 3. Started at normal text: make every line an heading,
  19007. ;; skipping headlines and items.
  19008. (t (let* ((stars
  19009. (make-string
  19010. (if (numberp nstars) nstars (or (org-current-level) 0)) ?*))
  19011. (add-stars
  19012. (cond (nstars "") ; stars from prefix only
  19013. ((equal stars "") "*") ; before first heading
  19014. (org-odd-levels-only "**") ; inside heading, odd
  19015. (t "*"))) ; inside heading, oddeven
  19016. (rpl (concat stars add-stars " "))
  19017. (lend (if (listp nstars) (save-excursion (end-of-line) (point)))))
  19018. (while (< (point) (if (equal nstars '(4)) lend end))
  19019. (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
  19020. (looking-at "\\([ \t]*\\)\\(\\S-\\)"))
  19021. (replace-match (concat rpl (match-string 2))) (setq toggled t))
  19022. (forward-line)))))))
  19023. (unless toggled (message "Cannot toggle heading from here"))))
  19024. (defun org-meta-return (&optional arg)
  19025. "Insert a new heading or wrap a region in a table.
  19026. Calls `org-insert-heading' or `org-table-wrap-region', depending
  19027. on context. See the individual commands for more information."
  19028. (interactive "P")
  19029. (org-check-before-invisible-edit 'insert)
  19030. (or (run-hook-with-args-until-success 'org-metareturn-hook)
  19031. (let* ((element (org-element-at-point))
  19032. (type (org-element-type element)))
  19033. (when (eq type 'table-row)
  19034. (setq element (org-element-property :parent element))
  19035. (setq type 'table))
  19036. (if (and (eq type 'table)
  19037. (eq (org-element-property :type element) 'org)
  19038. (>= (point) (org-element-property :contents-begin element))
  19039. (< (point) (org-element-property :contents-end element)))
  19040. (call-interactively 'org-table-wrap-region)
  19041. (call-interactively 'org-insert-heading)))))
  19042. ;;; Menu entries
  19043. (defsubst org-in-subtree-not-table-p ()
  19044. "Are we in a subtree and not in a table?"
  19045. (and (not (org-before-first-heading-p))
  19046. (not (org-at-table-p))))
  19047. ;; Define the Org-mode menus
  19048. (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
  19049. '("Tbl"
  19050. ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
  19051. ["Next Field" org-cycle (org-at-table-p)]
  19052. ["Previous Field" org-shifttab (org-at-table-p)]
  19053. ["Next Row" org-return (org-at-table-p)]
  19054. "--"
  19055. ["Blank Field" org-table-blank-field (org-at-table-p)]
  19056. ["Edit Field" org-table-edit-field (org-at-table-p)]
  19057. ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
  19058. "--"
  19059. ("Column"
  19060. ["Move Column Left" org-metaleft (org-at-table-p)]
  19061. ["Move Column Right" org-metaright (org-at-table-p)]
  19062. ["Delete Column" org-shiftmetaleft (org-at-table-p)]
  19063. ["Insert Column" org-shiftmetaright (org-at-table-p)])
  19064. ("Row"
  19065. ["Move Row Up" org-metaup (org-at-table-p)]
  19066. ["Move Row Down" org-metadown (org-at-table-p)]
  19067. ["Delete Row" org-shiftmetaup (org-at-table-p)]
  19068. ["Insert Row" org-shiftmetadown (org-at-table-p)]
  19069. ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
  19070. "--"
  19071. ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
  19072. ("Rectangle"
  19073. ["Copy Rectangle" org-copy-special (org-at-table-p)]
  19074. ["Cut Rectangle" org-cut-special (org-at-table-p)]
  19075. ["Paste Rectangle" org-paste-special (org-at-table-p)]
  19076. ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
  19077. "--"
  19078. ("Calculate"
  19079. ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
  19080. ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
  19081. ["Edit Formulas" org-edit-special (org-at-table-p)]
  19082. "--"
  19083. ["Recalculate line" org-table-recalculate (org-at-table-p)]
  19084. ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
  19085. ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
  19086. "--"
  19087. ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
  19088. "--"
  19089. ["Sum Column/Rectangle" org-table-sum
  19090. (or (org-at-table-p) (org-region-active-p))]
  19091. ["Which Column?" org-table-current-column (org-at-table-p)])
  19092. ["Debug Formulas"
  19093. org-table-toggle-formula-debugger
  19094. :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
  19095. ["Show Col/Row Numbers"
  19096. org-table-toggle-coordinate-overlays
  19097. :style toggle
  19098. :selected (org-bound-and-true-p org-table-overlay-coordinates)]
  19099. "--"
  19100. ["Create" org-table-create (and (not (org-at-table-p))
  19101. org-enable-table-editor)]
  19102. ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
  19103. ["Import from File" org-table-import (not (org-at-table-p))]
  19104. ["Export to File" org-table-export (org-at-table-p)]
  19105. "--"
  19106. ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
  19107. (easy-menu-define org-org-menu org-mode-map "Org menu"
  19108. '("Org"
  19109. ("Show/Hide"
  19110. ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
  19111. ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
  19112. ["Sparse Tree..." org-sparse-tree t]
  19113. ["Reveal Context" org-reveal t]
  19114. ["Show All" show-all t]
  19115. "--"
  19116. ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
  19117. "--"
  19118. ["New Heading" org-insert-heading t]
  19119. ("Navigate Headings"
  19120. ["Up" outline-up-heading t]
  19121. ["Next" outline-next-visible-heading t]
  19122. ["Previous" outline-previous-visible-heading t]
  19123. ["Next Same Level" outline-forward-same-level t]
  19124. ["Previous Same Level" outline-backward-same-level t]
  19125. "--"
  19126. ["Jump" org-goto t])
  19127. ("Edit Structure"
  19128. ["Refile Subtree" org-refile (org-in-subtree-not-table-p)]
  19129. "--"
  19130. ["Move Subtree Up" org-shiftmetaup (org-in-subtree-not-table-p)]
  19131. ["Move Subtree Down" org-shiftmetadown (org-in-subtree-not-table-p)]
  19132. "--"
  19133. ["Copy Subtree" org-copy-special (org-in-subtree-not-table-p)]
  19134. ["Cut Subtree" org-cut-special (org-in-subtree-not-table-p)]
  19135. ["Paste Subtree" org-paste-special (not (org-at-table-p))]
  19136. "--"
  19137. ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
  19138. "--"
  19139. ["Copy visible text" org-copy-visible t]
  19140. "--"
  19141. ["Promote Heading" org-metaleft (org-in-subtree-not-table-p)]
  19142. ["Promote Subtree" org-shiftmetaleft (org-in-subtree-not-table-p)]
  19143. ["Demote Heading" org-metaright (org-in-subtree-not-table-p)]
  19144. ["Demote Subtree" org-shiftmetaright (org-in-subtree-not-table-p)]
  19145. "--"
  19146. ["Sort Region/Children" org-sort t]
  19147. "--"
  19148. ["Convert to odd levels" org-convert-to-odd-levels t]
  19149. ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
  19150. ("Editing"
  19151. ["Emphasis..." org-emphasize t]
  19152. ["Edit Source Example" org-edit-special t]
  19153. "--"
  19154. ["Footnote new/jump" org-footnote-action t]
  19155. ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
  19156. ("Archive"
  19157. ["Archive (default method)" org-archive-subtree-default (org-in-subtree-not-table-p)]
  19158. "--"
  19159. ["Move Subtree to Archive file" org-advertized-archive-subtree (org-in-subtree-not-table-p)]
  19160. ["Toggle ARCHIVE tag" org-toggle-archive-tag (org-in-subtree-not-table-p)]
  19161. ["Move subtree to Archive sibling" org-archive-to-archive-sibling (org-in-subtree-not-table-p)]
  19162. )
  19163. "--"
  19164. ("Hyperlinks"
  19165. ["Store Link (Global)" org-store-link t]
  19166. ["Find existing link to here" org-occur-link-in-agenda-files t]
  19167. ["Insert Link" org-insert-link t]
  19168. ["Follow Link" org-open-at-point t]
  19169. "--"
  19170. ["Next link" org-next-link t]
  19171. ["Previous link" org-previous-link t]
  19172. "--"
  19173. ["Descriptive Links"
  19174. org-toggle-link-display
  19175. :style radio
  19176. :selected org-descriptive-links
  19177. ]
  19178. ["Literal Links"
  19179. org-toggle-link-display
  19180. :style radio
  19181. :selected (not org-descriptive-links)])
  19182. "--"
  19183. ("TODO Lists"
  19184. ["TODO/DONE/-" org-todo t]
  19185. ("Select keyword"
  19186. ["Next keyword" org-shiftright (org-at-heading-p)]
  19187. ["Previous keyword" org-shiftleft (org-at-heading-p)]
  19188. ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
  19189. ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
  19190. ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
  19191. ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
  19192. ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
  19193. "--"
  19194. ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
  19195. :selected org-enforce-todo-dependencies :style toggle :active t]
  19196. "Settings for tree at point"
  19197. ["Do Children sequentially" org-toggle-ordered-property :style radio
  19198. :selected (org-entry-get nil "ORDERED")
  19199. :active org-enforce-todo-dependencies :keys "C-c C-x o"]
  19200. ["Do Children parallel" org-toggle-ordered-property :style radio
  19201. :selected (not (org-entry-get nil "ORDERED"))
  19202. :active org-enforce-todo-dependencies :keys "C-c C-x o"]
  19203. "--"
  19204. ["Set Priority" org-priority t]
  19205. ["Priority Up" org-shiftup t]
  19206. ["Priority Down" org-shiftdown t]
  19207. "--"
  19208. ["Get news from all feeds" org-feed-update-all t]
  19209. ["Go to the inbox of a feed..." org-feed-goto-inbox t]
  19210. ["Customize feeds" (customize-variable 'org-feed-alist) t])
  19211. ("TAGS and Properties"
  19212. ["Set Tags" org-set-tags-command (not (org-before-first-heading-p))]
  19213. ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
  19214. "--"
  19215. ["Set property" org-set-property (not (org-before-first-heading-p))]
  19216. ["Column view of properties" org-columns t]
  19217. ["Insert Column View DBlock" org-insert-columns-dblock t])
  19218. ("Dates and Scheduling"
  19219. ["Timestamp" org-time-stamp (not (org-before-first-heading-p))]
  19220. ["Timestamp (inactive)" org-time-stamp-inactive (not (org-before-first-heading-p))]
  19221. ("Change Date"
  19222. ["1 Day Later" org-shiftright (org-at-timestamp-p)]
  19223. ["1 Day Earlier" org-shiftleft (org-at-timestamp-p)]
  19224. ["1 ... Later" org-shiftup (org-at-timestamp-p)]
  19225. ["1 ... Earlier" org-shiftdown (org-at-timestamp-p)])
  19226. ["Compute Time Range" org-evaluate-time-range t]
  19227. ["Schedule Item" org-schedule (not (org-before-first-heading-p))]
  19228. ["Deadline" org-deadline (not (org-before-first-heading-p))]
  19229. "--"
  19230. ["Custom time format" org-toggle-time-stamp-overlays
  19231. :style radio :selected org-display-custom-times]
  19232. "--"
  19233. ["Goto Calendar" org-goto-calendar t]
  19234. ["Date from Calendar" org-date-from-calendar t]
  19235. "--"
  19236. ["Start/Restart Timer" org-timer-start t]
  19237. ["Pause/Continue Timer" org-timer-pause-or-continue t]
  19238. ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
  19239. ["Insert Timer String" org-timer t]
  19240. ["Insert Timer Item" org-timer-item t])
  19241. ("Logging work"
  19242. ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
  19243. ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
  19244. ["Clock out" org-clock-out t]
  19245. ["Clock cancel" org-clock-cancel t]
  19246. "--"
  19247. ["Mark as default task" org-clock-mark-default-task t]
  19248. ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
  19249. ["Goto running clock" org-clock-goto t]
  19250. "--"
  19251. ["Display times" org-clock-display t]
  19252. ["Create clock table" org-clock-report t]
  19253. "--"
  19254. ["Record DONE time"
  19255. (progn (setq org-log-done (not org-log-done))
  19256. (message "Switching to %s will %s record a timestamp"
  19257. (car org-done-keywords)
  19258. (if org-log-done "automatically" "not")))
  19259. :style toggle :selected org-log-done])
  19260. "--"
  19261. ["Agenda Command..." org-agenda t]
  19262. ["Set Restriction Lock" org-agenda-set-restriction-lock t]
  19263. ("File List for Agenda")
  19264. ("Special views current file"
  19265. ["TODO Tree" org-show-todo-tree t]
  19266. ["Check Deadlines" org-check-deadlines t]
  19267. ["Timeline" org-timeline t]
  19268. ["Tags/Property tree" org-match-sparse-tree t])
  19269. "--"
  19270. ["Export/Publish..." org-export-dispatch t]
  19271. ("LaTeX"
  19272. ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
  19273. :selected org-cdlatex-mode]
  19274. ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
  19275. ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
  19276. ["Modify math symbol" org-cdlatex-math-modify
  19277. (org-inside-LaTeX-fragment-p)]
  19278. ["Insert citation" org-reftex-citation t]
  19279. "--"
  19280. ["Template for BEAMER" (org-beamer-insert-options-template) t])
  19281. "--"
  19282. ("MobileOrg"
  19283. ["Push Files and Views" org-mobile-push t]
  19284. ["Get Captured and Flagged" org-mobile-pull t]
  19285. ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
  19286. "--"
  19287. ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
  19288. "--"
  19289. ("Documentation"
  19290. ["Show Version" org-version t]
  19291. ["Info Documentation" org-info t])
  19292. ("Customize"
  19293. ["Browse Org Group" org-customize t]
  19294. "--"
  19295. ["Expand This Menu" org-create-customize-menu
  19296. (fboundp 'customize-menu-create)])
  19297. ["Send bug report" org-submit-bug-report t]
  19298. "--"
  19299. ("Refresh/Reload"
  19300. ["Refresh setup current buffer" org-mode-restart t]
  19301. ["Reload Org (after update)" org-reload t]
  19302. ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x !"])
  19303. ))
  19304. (defun org-info (&optional node)
  19305. "Read documentation for Org-mode in the info system.
  19306. With optional NODE, go directly to that node."
  19307. (interactive)
  19308. (info (format "(org)%s" (or node ""))))
  19309. ;;;###autoload
  19310. (defun org-submit-bug-report ()
  19311. "Submit a bug report on Org-mode via mail.
  19312. Don't hesitate to report any problems or inaccurate documentation.
  19313. If you don't have setup sending mail from (X)Emacs, please copy the
  19314. output buffer into your mail program, as it gives us important
  19315. information about your Org-mode version and configuration."
  19316. (interactive)
  19317. (require 'reporter)
  19318. (org-load-modules-maybe)
  19319. (org-require-autoloaded-modules)
  19320. (let ((reporter-prompt-for-summary-p "Bug report subject: "))
  19321. (reporter-submit-bug-report
  19322. "emacs-orgmode@gnu.org"
  19323. (org-version nil 'full)
  19324. (let (list)
  19325. (save-window-excursion
  19326. (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
  19327. (delete-other-windows)
  19328. (erase-buffer)
  19329. (insert "You are about to submit a bug report to the Org-mode mailing list.
  19330. We would like to add your full Org-mode and Outline configuration to the
  19331. bug report. This greatly simplifies the work of the maintainer and
  19332. other experts on the mailing list.
  19333. HOWEVER, some variables you have customized may contain private
  19334. information. The names of customers, colleagues, or friends, might
  19335. appear in the form of file names, tags, todo states, or search strings.
  19336. If you answer yes to the prompt, you might want to check and remove
  19337. such private information before sending the email.")
  19338. (add-text-properties (point-min) (point-max) '(face org-warning))
  19339. (when (yes-or-no-p "Include your Org-mode configuration ")
  19340. (mapatoms
  19341. (lambda (v)
  19342. (and (boundp v)
  19343. (string-match "\\`\\(org-\\|outline-\\)" (symbol-name v))
  19344. (or (and (symbol-value v)
  19345. (string-match "\\(-hook\\|-function\\)\\'" (symbol-name v)))
  19346. (and
  19347. (get v 'custom-type) (get v 'standard-value)
  19348. (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
  19349. (push v list)))))
  19350. (kill-buffer (get-buffer "*Warn about privacy*"))
  19351. list))
  19352. nil nil
  19353. "Remember to cover the basics, that is, what you expected to happen and
  19354. what in fact did happen. You don't know how to make a good report? See
  19355. http://orgmode.org/manual/Feedback.html#Feedback
  19356. Your bug report will be posted to the Org-mode mailing list.
  19357. ------------------------------------------------------------------------")
  19358. (save-excursion
  19359. (if (re-search-backward "^\\(Subject: \\)Org-mode version \\(.*?\\);[ \t]*\\(.*\\)" nil t)
  19360. (replace-match "\\1Bug: \\3 [\\2]")))))
  19361. (defun org-install-agenda-files-menu ()
  19362. (let ((bl (buffer-list)))
  19363. (save-excursion
  19364. (while bl
  19365. (set-buffer (pop bl))
  19366. (if (derived-mode-p 'org-mode) (setq bl nil)))
  19367. (when (derived-mode-p 'org-mode)
  19368. (easy-menu-change
  19369. '("Org") "File List for Agenda"
  19370. (append
  19371. (list
  19372. ["Edit File List" (org-edit-agenda-file-list) t]
  19373. ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
  19374. ["Remove Current File from List" org-remove-file t]
  19375. ["Cycle through agenda files" org-cycle-agenda-files t]
  19376. ["Occur in all agenda files" org-occur-in-agenda-files t]
  19377. "--")
  19378. (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
  19379. ;;;; Documentation
  19380. (defun org-require-autoloaded-modules ()
  19381. (interactive)
  19382. (mapc 'require
  19383. '(org-agenda org-archive org-attach org-clock org-colview org-id
  19384. org-remember org-table org-timer)))
  19385. ;;;###autoload
  19386. (defun org-reload (&optional uncompiled)
  19387. "Reload all org lisp files.
  19388. With prefix arg UNCOMPILED, load the uncompiled versions."
  19389. (interactive "P")
  19390. (require 'loadhist)
  19391. (let* ((org-dir (org-find-library-dir "org"))
  19392. (contrib-dir (or (org-find-library-dir "org-contribdir") org-dir))
  19393. (feature-re "^\\(org\\|ob\\|ox\\)\\(-.*\\)?")
  19394. (remove-re (mapconcat 'identity
  19395. (mapcar (lambda (f) (concat "^" f "$"))
  19396. (list (if (featurep 'xemacs)
  19397. "org-colview"
  19398. "org-colview-xemacs")
  19399. "org" "org-loaddefs" "org-version"))
  19400. "\\|"))
  19401. (feats (delete-dups
  19402. (mapcar 'file-name-sans-extension
  19403. (mapcar 'file-name-nondirectory
  19404. (delq nil
  19405. (mapcar 'feature-file
  19406. features))))))
  19407. (lfeat (append
  19408. (sort
  19409. (setq feats
  19410. (delq nil (mapcar
  19411. (lambda (f)
  19412. (if (and (string-match feature-re f)
  19413. (not (string-match remove-re f)))
  19414. f nil))
  19415. feats)))
  19416. 'string-lessp)
  19417. (list "org-version" "org")))
  19418. (load-suffixes (when (boundp 'load-suffixes) load-suffixes))
  19419. (load-suffixes (if uncompiled (reverse load-suffixes) load-suffixes))
  19420. load-uncore load-misses)
  19421. (setq load-misses
  19422. (delq 't
  19423. (mapcar (lambda (f)
  19424. (or (org-load-noerror-mustsuffix (concat org-dir f))
  19425. (and (string= org-dir contrib-dir)
  19426. (org-load-noerror-mustsuffix (concat contrib-dir f)))
  19427. (and (org-load-noerror-mustsuffix (concat (org-find-library-dir f) f))
  19428. (add-to-list 'load-uncore f 'append)
  19429. 't)
  19430. f))
  19431. lfeat)))
  19432. (if load-uncore
  19433. (message "The following feature%s found in load-path, please check if that's correct:\n%s"
  19434. (if (> (length load-uncore) 1) "s were" " was") load-uncore))
  19435. (if load-misses
  19436. (message "Some error occured while reloading Org feature%s\n%s\nPlease check *Messages*!\n%s"
  19437. (if (> (length load-misses) 1) "s" "") load-misses (org-version nil 'full))
  19438. (message "Successfully reloaded Org\n%s" (org-version nil 'full)))))
  19439. ;;;###autoload
  19440. (defun org-customize ()
  19441. "Call the customize function with org as argument."
  19442. (interactive)
  19443. (org-load-modules-maybe)
  19444. (org-require-autoloaded-modules)
  19445. (customize-browse 'org))
  19446. (defun org-create-customize-menu ()
  19447. "Create a full customization menu for Org-mode, insert it into the menu."
  19448. (interactive)
  19449. (org-load-modules-maybe)
  19450. (org-require-autoloaded-modules)
  19451. (if (fboundp 'customize-menu-create)
  19452. (progn
  19453. (easy-menu-change
  19454. '("Org") "Customize"
  19455. `(["Browse Org group" org-customize t]
  19456. "--"
  19457. ,(customize-menu-create 'org)
  19458. ["Set" Custom-set t]
  19459. ["Save" Custom-save t]
  19460. ["Reset to Current" Custom-reset-current t]
  19461. ["Reset to Saved" Custom-reset-saved t]
  19462. ["Reset to Standard Settings" Custom-reset-standard t]))
  19463. (message "\"Org\"-menu now contains full customization menu"))
  19464. (error "Cannot expand menu (outdated version of cus-edit.el)")))
  19465. ;;;; Miscellaneous stuff
  19466. ;;; Generally useful functions
  19467. (defun org-get-at-bol (property)
  19468. "Get text property PROPERTY at beginning of line."
  19469. (get-text-property (point-at-bol) property))
  19470. (defun org-find-text-property-in-string (prop s)
  19471. "Return the first non-nil value of property PROP in string S."
  19472. (or (get-text-property 0 prop s)
  19473. (get-text-property (or (next-single-property-change 0 prop s) 0)
  19474. prop s)))
  19475. (defun org-display-warning (message) ;; Copied from Emacs-Muse
  19476. "Display the given MESSAGE as a warning."
  19477. (if (fboundp 'display-warning)
  19478. (display-warning 'org message
  19479. (if (featurep 'xemacs) 'warning :warning))
  19480. (let ((buf (get-buffer-create "*Org warnings*")))
  19481. (with-current-buffer buf
  19482. (goto-char (point-max))
  19483. (insert "Warning (Org): " message)
  19484. (unless (bolp)
  19485. (newline)))
  19486. (display-buffer buf)
  19487. (sit-for 0))))
  19488. (defun org-eval (form)
  19489. "Eval FORM and return result."
  19490. (condition-case error
  19491. (eval form)
  19492. (error (format "%%![Error: %s]" error))))
  19493. (defun org-in-clocktable-p ()
  19494. "Check if the cursor is in a clocktable."
  19495. (let ((pos (point)) start)
  19496. (save-excursion
  19497. (end-of-line 1)
  19498. (and (re-search-backward "^[ \t]*#\\+BEGIN:[ \t]+clocktable" nil t)
  19499. (setq start (match-beginning 0))
  19500. (re-search-forward "^[ \t]*#\\+END:.*" nil t)
  19501. (>= (match-end 0) pos)
  19502. start))))
  19503. (defun org-in-commented-line ()
  19504. "Is point in a line starting with `#'?"
  19505. (equal (char-after (point-at-bol)) ?#))
  19506. (defun org-in-indented-comment-line ()
  19507. "Is point in a line starting with `#' after some white space?"
  19508. (save-excursion
  19509. (save-match-data
  19510. (goto-char (point-at-bol))
  19511. (looking-at "[ \t]*#"))))
  19512. (defun org-in-verbatim-emphasis ()
  19513. (save-match-data
  19514. (and (org-in-regexp org-emph-re 2)
  19515. (>= (point) (match-beginning 3))
  19516. (<= (point) (match-end 4))
  19517. (member (match-string 3) '("=" "~")))))
  19518. (defun org-goto-marker-or-bmk (marker &optional bookmark)
  19519. "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
  19520. (if (and marker (marker-buffer marker)
  19521. (buffer-live-p (marker-buffer marker)))
  19522. (progn
  19523. (org-pop-to-buffer-same-window (marker-buffer marker))
  19524. (if (or (> marker (point-max)) (< marker (point-min)))
  19525. (widen))
  19526. (goto-char marker)
  19527. (org-show-context 'org-goto))
  19528. (if bookmark
  19529. (bookmark-jump bookmark)
  19530. (error "Cannot find location"))))
  19531. (defun org-quote-csv-field (s)
  19532. "Quote field for inclusion in CSV material."
  19533. (if (string-match "[\",]" s)
  19534. (concat "\"" (mapconcat 'identity (split-string s "\"") "\"\"") "\"")
  19535. s))
  19536. (defun org-force-self-insert (N)
  19537. "Needed to enforce self-insert under remapping."
  19538. (interactive "p")
  19539. (self-insert-command N))
  19540. (defun org-string-width (s)
  19541. "Compute width of string, ignoring invisible characters.
  19542. This ignores character with invisibility property `org-link', and also
  19543. characters with property `org-cwidth', because these will become invisible
  19544. upon the next fontification round."
  19545. (let (b l)
  19546. (when (or (eq t buffer-invisibility-spec)
  19547. (assq 'org-link buffer-invisibility-spec))
  19548. (while (setq b (text-property-any 0 (length s)
  19549. 'invisible 'org-link s))
  19550. (setq s (concat (substring s 0 b)
  19551. (substring s (or (next-single-property-change
  19552. b 'invisible s) (length s)))))))
  19553. (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
  19554. (setq s (concat (substring s 0 b)
  19555. (substring s (or (next-single-property-change
  19556. b 'org-cwidth s) (length s))))))
  19557. (setq l (string-width s) b -1)
  19558. (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
  19559. (setq l (- l (get-text-property b 'org-dwidth-n s))))
  19560. l))
  19561. (defun org-shorten-string (s maxlength)
  19562. "Shorten string S so tht it is no longer than MAXLENGTH characters.
  19563. If the string is shorter or has length MAXLENGTH, just return the
  19564. original string. If it is longer, the functions finds a space in the
  19565. string, breaks this string off at that locations and adds three dots
  19566. as ellipsis. Including the ellipsis, the string will not be longer
  19567. than MAXLENGTH. If finding a good breaking point in the string does
  19568. not work, the string is just chopped off in the middle of a word
  19569. if necessary."
  19570. (if (<= (length s) maxlength)
  19571. s
  19572. (let* ((n (max (- maxlength 4) 1))
  19573. (re (concat "\\`\\(.\\{1," (int-to-string n) "\\}[^ ]\\)\\([ ]\\|\\'\\)")))
  19574. (if (string-match re s)
  19575. (concat (match-string 1 s) "...")
  19576. (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
  19577. (defun org-get-indentation (&optional line)
  19578. "Get the indentation of the current line, interpreting tabs.
  19579. When LINE is given, assume it represents a line and compute its indentation."
  19580. (if line
  19581. (if (string-match "^ *" (org-remove-tabs line))
  19582. (match-end 0))
  19583. (save-excursion
  19584. (beginning-of-line 1)
  19585. (skip-chars-forward " \t")
  19586. (current-column))))
  19587. (defun org-get-string-indentation (s)
  19588. "What indentation has S due to SPACE and TAB at the beginning of the string?"
  19589. (let ((n -1) (i 0) (w tab-width) c)
  19590. (catch 'exit
  19591. (while (< (setq n (1+ n)) (length s))
  19592. (setq c (aref s n))
  19593. (cond ((= c ?\ ) (setq i (1+ i)))
  19594. ((= c ?\t) (setq i (* (/ (+ w i) w) w)))
  19595. (t (throw 'exit t)))))
  19596. i))
  19597. (defun org-remove-tabs (s &optional width)
  19598. "Replace tabulators in S with spaces.
  19599. Assumes that s is a single line, starting in column 0."
  19600. (setq width (or width tab-width))
  19601. (while (string-match "\t" s)
  19602. (setq s (replace-match
  19603. (make-string
  19604. (- (* width (/ (+ (match-beginning 0) width) width))
  19605. (match-beginning 0)) ?\ )
  19606. t t s)))
  19607. s)
  19608. (defun org-fix-indentation (line ind)
  19609. "Fix indentation in LINE.
  19610. IND is a cons cell with target and minimum indentation.
  19611. If the current indentation in LINE is smaller than the minimum,
  19612. leave it alone. If it is larger than ind, set it to the target."
  19613. (let* ((l (org-remove-tabs line))
  19614. (i (org-get-indentation l))
  19615. (i1 (car ind)) (i2 (cdr ind)))
  19616. (if (>= i i2) (setq l (substring line i2)))
  19617. (if (> i1 0)
  19618. (concat (make-string i1 ?\ ) l)
  19619. l)))
  19620. (defun org-remove-indentation (code &optional n)
  19621. "Remove the maximum common indentation from the lines in CODE.
  19622. N may optionally be the number of spaces to remove."
  19623. (with-temp-buffer
  19624. (insert code)
  19625. (org-do-remove-indentation n)
  19626. (buffer-string)))
  19627. (defun org-do-remove-indentation (&optional n)
  19628. "Remove the maximum common indentation from the buffer."
  19629. (untabify (point-min) (point-max))
  19630. (let ((min 10000) re)
  19631. (if n
  19632. (setq min n)
  19633. (goto-char (point-min))
  19634. (while (re-search-forward "^ *[^ \n]" nil t)
  19635. (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
  19636. (unless (or (= min 0) (= min 10000))
  19637. (setq re (format "^ \\{%d\\}" min))
  19638. (goto-char (point-min))
  19639. (while (re-search-forward re nil t)
  19640. (replace-match "")
  19641. (end-of-line 1))
  19642. min)))
  19643. (defun org-fill-template (template alist)
  19644. "Find each %key of ALIST in TEMPLATE and replace it."
  19645. (let ((case-fold-search nil)
  19646. entry key value)
  19647. (setq alist (sort (copy-sequence alist)
  19648. (lambda (a b) (< (length (car a)) (length (car b))))))
  19649. (while (setq entry (pop alist))
  19650. (setq template
  19651. (replace-regexp-in-string
  19652. (concat "%" (regexp-quote (car entry)))
  19653. (or (cdr entry) "") template t t)))
  19654. template))
  19655. (defun org-base-buffer (buffer)
  19656. "Return the base buffer of BUFFER, if it has one. Else return the buffer."
  19657. (if (not buffer)
  19658. buffer
  19659. (or (buffer-base-buffer buffer)
  19660. buffer)))
  19661. (defun org-trim (s)
  19662. "Remove whitespace at beginning and end of string."
  19663. (if (string-match "\\`[ \t\n\r]+" s) (setq s (replace-match "" t t s)))
  19664. (if (string-match "[ \t\n\r]+\\'" s) (setq s (replace-match "" t t s)))
  19665. s)
  19666. (defun org-wrap (string &optional width lines)
  19667. "Wrap string to either a number of lines, or a width in characters.
  19668. If WIDTH is non-nil, the string is wrapped to that width, however many lines
  19669. that costs. If there is a word longer than WIDTH, the text is actually
  19670. wrapped to the length of that word.
  19671. IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
  19672. many lines, whatever width that takes.
  19673. The return value is a list of lines, without newlines at the end."
  19674. (let* ((words (org-split-string string "[ \t\n]+"))
  19675. (maxword (apply 'max (mapcar 'org-string-width words)))
  19676. w ll)
  19677. (cond (width
  19678. (org-do-wrap words (max maxword width)))
  19679. (lines
  19680. (setq w maxword)
  19681. (setq ll (org-do-wrap words maxword))
  19682. (if (<= (length ll) lines)
  19683. ll
  19684. (setq ll words)
  19685. (while (> (length ll) lines)
  19686. (setq w (1+ w))
  19687. (setq ll (org-do-wrap words w)))
  19688. ll))
  19689. (t (error "Cannot wrap this")))))
  19690. (defun org-do-wrap (words width)
  19691. "Create lines of maximum width WIDTH (in characters) from word list WORDS."
  19692. (let (lines line)
  19693. (while words
  19694. (setq line (pop words))
  19695. (while (and words (< (+ (length line) (length (car words))) width))
  19696. (setq line (concat line " " (pop words))))
  19697. (setq lines (push line lines)))
  19698. (nreverse lines)))
  19699. (defun org-split-string (string &optional separators)
  19700. "Splits STRING into substrings at SEPARATORS.
  19701. No empty strings are returned if there are matches at the beginning
  19702. and end of string."
  19703. (let ((rexp (or separators "[ \f\t\n\r\v]+"))
  19704. (start 0)
  19705. notfirst
  19706. (list nil))
  19707. (while (and (string-match rexp string
  19708. (if (and notfirst
  19709. (= start (match-beginning 0))
  19710. (< start (length string)))
  19711. (1+ start) start))
  19712. (< (match-beginning 0) (length string)))
  19713. (setq notfirst t)
  19714. (or (eq (match-beginning 0) 0)
  19715. (and (eq (match-beginning 0) (match-end 0))
  19716. (eq (match-beginning 0) start))
  19717. (setq list
  19718. (cons (substring string start (match-beginning 0))
  19719. list)))
  19720. (setq start (match-end 0)))
  19721. (or (eq start (length string))
  19722. (setq list
  19723. (cons (substring string start)
  19724. list)))
  19725. (nreverse list)))
  19726. (defun org-quote-vert (s)
  19727. "Replace \"|\" with \"\\vert\"."
  19728. (while (string-match "|" s)
  19729. (setq s (replace-match "\\vert" t t s)))
  19730. s)
  19731. (defun org-uuidgen-p (s)
  19732. "Is S an ID created by UUIDGEN?"
  19733. (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
  19734. (defun org-in-src-block-p (&optional inside)
  19735. "Whether point is in a code source block.
  19736. When INSIDE is non-nil, don't consider we are within a src block
  19737. when point is at #+BEGIN_SRC or #+END_SRC."
  19738. (let ((case-fold-search t) ov)
  19739. (or (and (setq ov (overlays-at (point)))
  19740. (memq 'org-block-background
  19741. (overlay-properties (car ov))))
  19742. (and (not inside)
  19743. (save-match-data
  19744. (save-excursion
  19745. (beginning-of-line)
  19746. (looking-at ".*#\\+\\(begin\\|end\\)_src")))))))
  19747. (defun org-context ()
  19748. "Return a list of contexts of the current cursor position.
  19749. If several contexts apply, all are returned.
  19750. Each context entry is a list with a symbol naming the context, and
  19751. two positions indicating start and end of the context. Possible
  19752. contexts are:
  19753. :headline anywhere in a headline
  19754. :headline-stars on the leading stars in a headline
  19755. :todo-keyword on a TODO keyword (including DONE) in a headline
  19756. :tags on the TAGS in a headline
  19757. :priority on the priority cookie in a headline
  19758. :item on the first line of a plain list item
  19759. :item-bullet on the bullet/number of a plain list item
  19760. :checkbox on the checkbox in a plain list item
  19761. :table in an org-mode table
  19762. :table-special on a special filed in a table
  19763. :table-table in a table.el table
  19764. :clocktable in a clocktable
  19765. :src-block in a source block
  19766. :link on a hyperlink
  19767. :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT, QUOTE.
  19768. :target on a <<target>>
  19769. :radio-target on a <<<radio-target>>>
  19770. :latex-fragment on a LaTeX fragment
  19771. :latex-preview on a LaTeX fragment with overlaid preview image
  19772. This function expects the position to be visible because it uses font-lock
  19773. faces as a help to recognize the following contexts: :table-special, :link,
  19774. and :keyword."
  19775. (let* ((f (get-text-property (point) 'face))
  19776. (faces (if (listp f) f (list f)))
  19777. (case-fold-search t)
  19778. (p (point)) clist o)
  19779. ;; First the large context
  19780. (cond
  19781. ((org-at-heading-p t)
  19782. (push (list :headline (point-at-bol) (point-at-eol)) clist)
  19783. (when (progn
  19784. (beginning-of-line 1)
  19785. (looking-at org-todo-line-tags-regexp))
  19786. (push (org-point-in-group p 1 :headline-stars) clist)
  19787. (push (org-point-in-group p 2 :todo-keyword) clist)
  19788. (push (org-point-in-group p 4 :tags) clist))
  19789. (goto-char p)
  19790. (skip-chars-backward "^[\n\r \t") (or (bobp) (backward-char 1))
  19791. (if (looking-at "\\[#[A-Z0-9]\\]")
  19792. (push (org-point-in-group p 0 :priority) clist)))
  19793. ((org-at-item-p)
  19794. (push (org-point-in-group p 2 :item-bullet) clist)
  19795. (push (list :item (point-at-bol)
  19796. (save-excursion (org-end-of-item) (point)))
  19797. clist)
  19798. (and (org-at-item-checkbox-p)
  19799. (push (org-point-in-group p 0 :checkbox) clist)))
  19800. ((org-at-table-p)
  19801. (push (list :table (org-table-begin) (org-table-end)) clist)
  19802. (if (memq 'org-formula faces)
  19803. (push (list :table-special
  19804. (previous-single-property-change p 'face)
  19805. (next-single-property-change p 'face)) clist)))
  19806. ((org-at-table-p 'any)
  19807. (push (list :table-table) clist)))
  19808. (goto-char p)
  19809. (let ((case-fold-search t))
  19810. ;; New the "medium" contexts: clocktables, source blocks
  19811. (cond ((org-in-clocktable-p)
  19812. (push (list :clocktable
  19813. (and (or (looking-at "#\\+BEGIN: clocktable")
  19814. (search-backward "#+BEGIN: clocktable" nil t))
  19815. (match-beginning 0))
  19816. (and (re-search-forward "#\\+END:?" nil t)
  19817. (match-end 0))) clist))
  19818. ((org-in-src-block-p)
  19819. (push (list :src-block
  19820. (and (or (looking-at "#\\+BEGIN_SRC")
  19821. (search-backward "#+BEGIN_SRC" nil t))
  19822. (match-beginning 0))
  19823. (and (search-forward "#+END_SRC" nil t)
  19824. (match-beginning 0))) clist))))
  19825. (goto-char p)
  19826. ;; Now the small context
  19827. (cond
  19828. ((org-at-timestamp-p)
  19829. (push (org-point-in-group p 0 :timestamp) clist))
  19830. ((memq 'org-link faces)
  19831. (push (list :link
  19832. (previous-single-property-change p 'face)
  19833. (next-single-property-change p 'face)) clist))
  19834. ((memq 'org-special-keyword faces)
  19835. (push (list :keyword
  19836. (previous-single-property-change p 'face)
  19837. (next-single-property-change p 'face)) clist))
  19838. ((org-at-target-p)
  19839. (push (org-point-in-group p 0 :target) clist)
  19840. (goto-char (1- (match-beginning 0)))
  19841. (if (looking-at org-radio-target-regexp)
  19842. (push (org-point-in-group p 0 :radio-target) clist))
  19843. (goto-char p))
  19844. ((setq o (car (delq nil
  19845. (mapcar
  19846. (lambda (x)
  19847. (if (memq x org-latex-fragment-image-overlays) x))
  19848. (overlays-at (point))))))
  19849. (push (list :latex-fragment
  19850. (overlay-start o) (overlay-end o)) clist)
  19851. (push (list :latex-preview
  19852. (overlay-start o) (overlay-end o)) clist))
  19853. ((org-inside-LaTeX-fragment-p)
  19854. ;; FIXME: positions wrong.
  19855. (push (list :latex-fragment (point) (point)) clist)))
  19856. (setq clist (nreverse (delq nil clist)))
  19857. clist))
  19858. ;; FIXME: Compare with at-regexp-p Do we need both?
  19859. (defun org-in-regexp (re &optional nlines visually)
  19860. "Check if point is inside a match of regexp.
  19861. Normally only the current line is checked, but you can include NLINES extra
  19862. lines both before and after point into the search.
  19863. If VISUALLY is set, require that the cursor is not after the match but
  19864. really on, so that the block visually is on the match."
  19865. (catch 'exit
  19866. (let ((pos (point))
  19867. (eol (point-at-eol (+ 1 (or nlines 0))))
  19868. (inc (if visually 1 0)))
  19869. (save-excursion
  19870. (beginning-of-line (- 1 (or nlines 0)))
  19871. (while (re-search-forward re eol t)
  19872. (if (and (<= (match-beginning 0) pos)
  19873. (>= (+ inc (match-end 0)) pos))
  19874. (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
  19875. (defun org-at-regexp-p (regexp)
  19876. "Is point inside a match of REGEXP in the current line?"
  19877. (catch 'exit
  19878. (save-excursion
  19879. (let ((pos (point)) (end (point-at-eol)))
  19880. (beginning-of-line 1)
  19881. (while (re-search-forward regexp end t)
  19882. (if (and (<= (match-beginning 0) pos)
  19883. (>= (match-end 0) pos))
  19884. (throw 'exit t)))
  19885. nil))))
  19886. (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
  19887. "Non-nil when point is between matches of START-RE and END-RE.
  19888. Also return a non-nil value when point is on one of the matches.
  19889. Optional arguments LIM-UP and LIM-DOWN bound the search; they are
  19890. buffer positions. Default values are the positions of headlines
  19891. surrounding the point.
  19892. The functions returns a cons cell whose car (resp. cdr) is the
  19893. position before START-RE (resp. after END-RE)."
  19894. (save-match-data
  19895. (let ((pos (point))
  19896. (limit-up (or lim-up (save-excursion (outline-previous-heading))))
  19897. (limit-down (or lim-down (save-excursion (outline-next-heading))))
  19898. beg end)
  19899. (save-excursion
  19900. ;; Point is on a block when on START-RE or if START-RE can be
  19901. ;; found before it...
  19902. (and (or (org-at-regexp-p start-re)
  19903. (re-search-backward start-re limit-up t))
  19904. (setq beg (match-beginning 0))
  19905. ;; ... and END-RE after it...
  19906. (goto-char (match-end 0))
  19907. (re-search-forward end-re limit-down t)
  19908. (> (setq end (match-end 0)) pos)
  19909. ;; ... without another START-RE in-between.
  19910. (goto-char (match-beginning 0))
  19911. (not (re-search-backward start-re (1+ beg) t))
  19912. ;; Return value.
  19913. (cons beg end))))))
  19914. (defun org-in-block-p (names)
  19915. "Non-nil when point belongs to a block whose name belongs to NAMES.
  19916. NAMES is a list of strings containing names of blocks.
  19917. Return first block name matched, or nil. Beware that in case of
  19918. nested blocks, the returned name may not belong to the closest
  19919. block from point."
  19920. (save-match-data
  19921. (catch 'exit
  19922. (let ((case-fold-search t)
  19923. (lim-up (save-excursion (outline-previous-heading)))
  19924. (lim-down (save-excursion (outline-next-heading))))
  19925. (mapc (lambda (name)
  19926. (let ((n (regexp-quote name)))
  19927. (when (org-between-regexps-p
  19928. (concat "^[ \t]*#\\+begin_" n)
  19929. (concat "^[ \t]*#\\+end_" n)
  19930. lim-up lim-down)
  19931. (throw 'exit n))))
  19932. names))
  19933. nil)))
  19934. (defun org-in-drawer-p ()
  19935. "Is point within a drawer?"
  19936. (save-match-data
  19937. (let ((case-fold-search t)
  19938. (lim-up (save-excursion (outline-previous-heading)))
  19939. (lim-down (save-excursion (outline-next-heading))))
  19940. (org-between-regexps-p
  19941. (concat "^[ \t]*:" (regexp-opt org-drawers) ":")
  19942. "^[ \t]*:end:.*$"
  19943. lim-up lim-down))))
  19944. (defun org-occur-in-agenda-files (regexp &optional nlines)
  19945. "Call `multi-occur' with buffers for all agenda files."
  19946. (interactive "sOrg-files matching: \np")
  19947. (let* ((files (org-agenda-files))
  19948. (tnames (mapcar 'file-truename files))
  19949. (extra org-agenda-text-search-extra-files)
  19950. f)
  19951. (when (eq (car extra) 'agenda-archives)
  19952. (setq extra (cdr extra))
  19953. (setq files (org-add-archive-files files)))
  19954. (while (setq f (pop extra))
  19955. (unless (member (file-truename f) tnames)
  19956. (add-to-list 'files f 'append)
  19957. (add-to-list 'tnames (file-truename f) 'append)))
  19958. (multi-occur
  19959. (mapcar (lambda (x)
  19960. (with-current-buffer
  19961. (or (get-file-buffer x) (find-file-noselect x))
  19962. (widen)
  19963. (current-buffer)))
  19964. files)
  19965. regexp)))
  19966. (if (boundp 'occur-mode-find-occurrence-hook)
  19967. ;; Emacs 23
  19968. (add-hook 'occur-mode-find-occurrence-hook
  19969. (lambda ()
  19970. (when (derived-mode-p 'org-mode)
  19971. (org-reveal))))
  19972. ;; Emacs 22
  19973. (defadvice occur-mode-goto-occurrence
  19974. (after org-occur-reveal activate)
  19975. (and (derived-mode-p 'org-mode) (org-reveal)))
  19976. (defadvice occur-mode-goto-occurrence-other-window
  19977. (after org-occur-reveal activate)
  19978. (and (derived-mode-p 'org-mode) (org-reveal)))
  19979. (defadvice occur-mode-display-occurrence
  19980. (after org-occur-reveal activate)
  19981. (when (derived-mode-p 'org-mode)
  19982. (let ((pos (occur-mode-find-occurrence)))
  19983. (with-current-buffer (marker-buffer pos)
  19984. (save-excursion
  19985. (goto-char pos)
  19986. (org-reveal)))))))
  19987. (defun org-occur-link-in-agenda-files ()
  19988. "Create a link and search for it in the agendas.
  19989. The link is not stored in `org-stored-links', it is just created
  19990. for the search purpose."
  19991. (interactive)
  19992. (let ((link (condition-case nil
  19993. (org-store-link nil)
  19994. (error "Unable to create a link to here"))))
  19995. (org-occur-in-agenda-files (regexp-quote link))))
  19996. (defun org-reverse-string (string)
  19997. "Return the reverse of STRING."
  19998. (apply 'string (reverse (string-to-list string))))
  19999. (defsubst org-uniquify (list)
  20000. "Non-destructively remove duplicate elements from LIST."
  20001. (let ((res (copy-sequence list))) (delete-dups res)))
  20002. (defun org-uniquify-alist (alist)
  20003. "Merge elements of ALIST with the same key.
  20004. For example, in this alist:
  20005. \(org-uniquify-alist '((a 1) (b 2) (a 3)))
  20006. => '((a 1 3) (b 2))
  20007. merge (a 1) and (a 3) into (a 1 3).
  20008. The function returns the new ALIST."
  20009. (let (rtn)
  20010. (mapc
  20011. (lambda (e)
  20012. (let (n)
  20013. (if (not (assoc (car e) rtn))
  20014. (push e rtn)
  20015. (setq n (cons (car e) (append (cdr (assoc (car e) rtn)) (cdr e))))
  20016. (setq rtn (assq-delete-all (car e) rtn))
  20017. (push n rtn))))
  20018. alist)
  20019. rtn))
  20020. (defun org-delete-all (elts list)
  20021. "Remove all elements in ELTS from LIST."
  20022. (while elts
  20023. (setq list (delete (pop elts) list)))
  20024. list)
  20025. (defun org-count (cl-item cl-seq)
  20026. "Count the number of occurrences of ITEM in SEQ.
  20027. Taken from `count' in cl-seq.el with all keyword arguments removed."
  20028. (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
  20029. (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
  20030. (while (< cl-start cl-end)
  20031. (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
  20032. (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
  20033. (setq cl-start (1+ cl-start)))
  20034. cl-count))
  20035. (defun org-remove-if (predicate seq)
  20036. "Remove everything from SEQ that fulfills PREDICATE."
  20037. (let (res e)
  20038. (while seq
  20039. (setq e (pop seq))
  20040. (if (not (funcall predicate e)) (push e res)))
  20041. (nreverse res)))
  20042. (defun org-remove-if-not (predicate seq)
  20043. "Remove everything from SEQ that does not fulfill PREDICATE."
  20044. (let (res e)
  20045. (while seq
  20046. (setq e (pop seq))
  20047. (if (funcall predicate e) (push e res)))
  20048. (nreverse res)))
  20049. (defun org-reduce (cl-func cl-seq &rest cl-keys)
  20050. "Reduce two-argument FUNCTION across SEQ.
  20051. Taken from `reduce' in cl-seq.el with all keyword arguments but
  20052. \":initial-value\" removed."
  20053. (let ((cl-accum (cond ((memq :initial-value cl-keys)
  20054. (cadr (memq :initial-value cl-keys)))
  20055. (cl-seq (pop cl-seq))
  20056. (t (funcall cl-func)))))
  20057. (while cl-seq
  20058. (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
  20059. cl-accum))
  20060. (defun org-every (pred seq)
  20061. "Return true if PREDICATE is true of every element of SEQ.
  20062. Adapted from `every' in cl.el."
  20063. (catch 'org-every
  20064. (mapc (lambda (e) (unless (funcall pred e) (throw 'org-every nil))) seq)
  20065. t))
  20066. (defun org-some (pred seq)
  20067. "Return true if PREDICATE is true of any element of SEQ.
  20068. Adapted from `some' in cl.el."
  20069. (catch 'org-some
  20070. (mapc (lambda (e) (when (funcall pred e) (throw 'org-some t))) seq)
  20071. nil))
  20072. (defun org-back-over-empty-lines ()
  20073. "Move backwards over whitespace, to the beginning of the first empty line.
  20074. Returns the number of empty lines passed."
  20075. (let ((pos (point)))
  20076. (if (cdr (assoc 'heading org-blank-before-new-entry))
  20077. (skip-chars-backward " \t\n\r")
  20078. (unless (eobp)
  20079. (forward-line -1)))
  20080. (beginning-of-line 2)
  20081. (goto-char (min (point) pos))
  20082. (count-lines (point) pos)))
  20083. (defun org-skip-whitespace ()
  20084. (skip-chars-forward " \t\n\r"))
  20085. (defun org-point-in-group (point group &optional context)
  20086. "Check if POINT is in match-group GROUP.
  20087. If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
  20088. match. If the match group does not exist or point is not inside it,
  20089. return nil."
  20090. (and (match-beginning group)
  20091. (>= point (match-beginning group))
  20092. (<= point (match-end group))
  20093. (if context
  20094. (list context (match-beginning group) (match-end group))
  20095. t)))
  20096. (defun org-switch-to-buffer-other-window (&rest args)
  20097. "Switch to buffer in a second window on the current frame.
  20098. In particular, do not allow pop-up frames.
  20099. Returns the newly created buffer."
  20100. (org-no-popups
  20101. (apply 'switch-to-buffer-other-window args)))
  20102. (defun org-combine-plists (&rest plists)
  20103. "Create a single property list from all plists in PLISTS.
  20104. The process starts by copying the first list, and then setting properties
  20105. from the other lists. Settings in the last list are the most significant
  20106. ones and overrule settings in the other lists."
  20107. (let ((rtn (copy-sequence (pop plists)))
  20108. p v ls)
  20109. (while plists
  20110. (setq ls (pop plists))
  20111. (while ls
  20112. (setq p (pop ls) v (pop ls))
  20113. (setq rtn (plist-put rtn p v))))
  20114. rtn))
  20115. (defun org-replace-escapes (string table)
  20116. "Replace %-escapes in STRING with values in TABLE.
  20117. TABLE is an association list with keys like \"%a\" and string values.
  20118. The sequences in STRING may contain normal field width and padding information,
  20119. for example \"%-5s\". Replacements happen in the sequence given by TABLE,
  20120. so values can contain further %-escapes if they are define later in TABLE."
  20121. (let ((tbl (copy-alist table))
  20122. (case-fold-search nil)
  20123. (pchg 0)
  20124. e re rpl)
  20125. (while (setq e (pop tbl))
  20126. (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
  20127. (when (and (cdr e) (string-match re (cdr e)))
  20128. (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
  20129. (safe "SREF"))
  20130. (add-text-properties 0 3 (list 'sref sref) safe)
  20131. (setcdr e (replace-match safe t t (cdr e)))))
  20132. (while (string-match re string)
  20133. (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
  20134. (cdr e)))
  20135. (setq string (replace-match rpl t t string))))
  20136. (while (setq pchg (next-property-change pchg string))
  20137. (let ((sref (get-text-property pchg 'sref string)))
  20138. (when (and sref (string-match "SREF" string pchg))
  20139. (setq string (replace-match sref t t string)))))
  20140. string))
  20141. (defun org-sublist (list start end)
  20142. "Return a section of LIST, from START to END.
  20143. Counting starts at 1."
  20144. (let (rtn (c start))
  20145. (setq list (nthcdr (1- start) list))
  20146. (while (and list (<= c end))
  20147. (push (pop list) rtn)
  20148. (setq c (1+ c)))
  20149. (nreverse rtn)))
  20150. (defun org-find-base-buffer-visiting (file)
  20151. "Like `find-buffer-visiting' but always return the base buffer and
  20152. not an indirect buffer."
  20153. (let ((buf (or (get-file-buffer file)
  20154. (find-buffer-visiting file))))
  20155. (if buf
  20156. (or (buffer-base-buffer buf) buf)
  20157. nil)))
  20158. (defun org-image-file-name-regexp (&optional extensions)
  20159. "Return regexp matching the file names of images.
  20160. If EXTENSIONS is given, only match these."
  20161. (if (and (not extensions) (fboundp 'image-file-name-regexp))
  20162. (image-file-name-regexp)
  20163. (let ((image-file-name-extensions
  20164. (or extensions
  20165. '("png" "jpeg" "jpg" "gif" "tiff" "tif"
  20166. "xbm" "xpm" "pbm" "pgm" "ppm"))))
  20167. (concat "\\."
  20168. (regexp-opt (nconc (mapcar 'upcase
  20169. image-file-name-extensions)
  20170. image-file-name-extensions)
  20171. t)
  20172. "\\'"))))
  20173. (defun org-file-image-p (file &optional extensions)
  20174. "Return non-nil if FILE is an image."
  20175. (save-match-data
  20176. (string-match (org-image-file-name-regexp extensions) file)))
  20177. (defun org-get-cursor-date (&optional with-time)
  20178. "Return the date at cursor in as a time.
  20179. This works in the calendar and in the agenda, anywhere else it just
  20180. returns the current time.
  20181. If WITH-TIME is non-nil, returns the time of the event at point (in
  20182. the agenda) or the current time of the day."
  20183. (let (date day defd tp tm hod mod)
  20184. (when with-time
  20185. (setq tp (get-text-property (point) 'time))
  20186. (when (and tp (string-match "\\([0-9][0-9]\\):\\([0-9][0-9]\\)" tp))
  20187. (setq hod (string-to-number (match-string 1 tp))
  20188. mod (string-to-number (match-string 2 tp))))
  20189. (or tp (setq hod (nth 2 (decode-time (current-time)))
  20190. mod (nth 1 (decode-time (current-time))))))
  20191. (cond
  20192. ((eq major-mode 'calendar-mode)
  20193. (setq date (calendar-cursor-to-date)
  20194. defd (encode-time 0 (or mod 0) (or hod 0)
  20195. (nth 1 date) (nth 0 date) (nth 2 date))))
  20196. ((eq major-mode 'org-agenda-mode)
  20197. (setq day (get-text-property (point) 'day))
  20198. (if day
  20199. (setq date (calendar-gregorian-from-absolute day)
  20200. defd (encode-time 0 (or mod 0) (or hod 0)
  20201. (nth 1 date) (nth 0 date) (nth 2 date))))))
  20202. (or defd (current-time))))
  20203. (defun org-mark-subtree (&optional up)
  20204. "Mark the current subtree.
  20205. This puts point at the start of the current subtree, and mark at
  20206. the end. If a numeric prefix UP is given, move up into the
  20207. hierarchy of headlines by UP levels before marking the subtree."
  20208. (interactive "P")
  20209. (org-with-limited-levels
  20210. (cond ((org-at-heading-p) (beginning-of-line))
  20211. ((org-before-first-heading-p) (user-error "Not in a subtree"))
  20212. (t (outline-previous-visible-heading 1))))
  20213. (when up (while (and (> up 0) (org-up-heading-safe)) (decf up)))
  20214. (if (org-called-interactively-p 'any)
  20215. (call-interactively 'org-mark-element)
  20216. (org-mark-element)))
  20217. ;;; Indentation
  20218. (defun org-indent-line ()
  20219. "Indent line depending on context."
  20220. (interactive)
  20221. (let* ((pos (point))
  20222. (itemp (org-at-item-p))
  20223. (case-fold-search t)
  20224. (org-drawer-regexp (or org-drawer-regexp "\000"))
  20225. (inline-task-p (and (featurep 'org-inlinetask)
  20226. (org-inlinetask-in-task-p)))
  20227. (inline-re (and inline-task-p
  20228. (org-inlinetask-outline-regexp)))
  20229. column)
  20230. (if (and orgstruct-is-++ (eq pos (point)))
  20231. (let ((indent-line-function (cadadr (assoc 'indent-line-function org-fb-vars))))
  20232. (indent-according-to-mode))
  20233. (beginning-of-line 1)
  20234. (cond
  20235. ;; Headings
  20236. ((looking-at org-outline-regexp) (setq column 0))
  20237. ;; Footnote definition
  20238. ((looking-at org-footnote-definition-re) (setq column 0))
  20239. ;; Literal examples
  20240. ((looking-at "[ \t]*:\\( \\|$\\)")
  20241. (setq column (org-get-indentation))) ; do nothing
  20242. ;; Lists
  20243. ((ignore-errors (goto-char (org-in-item-p)))
  20244. (setq column (if itemp
  20245. (org-get-indentation)
  20246. (org-list-item-body-column (point))))
  20247. (goto-char pos))
  20248. ;; Drawers
  20249. ((and (looking-at "[ \t]*:END:")
  20250. (save-excursion (re-search-backward org-drawer-regexp nil t)))
  20251. (save-excursion
  20252. (goto-char (1- (match-beginning 1)))
  20253. (setq column (current-column))))
  20254. ;; Special blocks
  20255. ((and (looking-at "[ \t]*#\\+end_\\([a-z]+\\)")
  20256. (save-excursion
  20257. (re-search-backward
  20258. (concat "^[ \t]*#\\+begin_" (downcase (match-string 1))) nil t)))
  20259. (setq column (org-get-indentation (match-string 0))))
  20260. ((and (not (looking-at "[ \t]*#\\+begin_"))
  20261. (org-between-regexps-p "^[ \t]*#\\+begin_" "[ \t]*#\\+end_"))
  20262. (save-excursion
  20263. (re-search-backward "^[ \t]*#\\+begin_\\([a-z]+\\)" nil t))
  20264. (setq column
  20265. (cond ((equal (downcase (match-string 1)) "src")
  20266. ;; src blocks: let `org-edit-src-exit' handle them
  20267. (org-get-indentation))
  20268. ((equal (downcase (match-string 1)) "example")
  20269. (max (org-get-indentation)
  20270. (org-get-indentation (match-string 0))))
  20271. (t
  20272. (org-get-indentation (match-string 0))))))
  20273. ;; This line has nothing special, look at the previous relevant
  20274. ;; line to compute indentation
  20275. (t
  20276. (beginning-of-line 0)
  20277. (while (and (not (bobp))
  20278. (not (looking-at org-table-line-regexp))
  20279. (not (looking-at org-drawer-regexp))
  20280. ;; When point started in an inline task, do not move
  20281. ;; above task starting line.
  20282. (not (and inline-task-p (looking-at inline-re)))
  20283. ;; Skip drawers, blocks, empty lines, verbatim,
  20284. ;; comments, tables, footnotes definitions, lists,
  20285. ;; inline tasks.
  20286. (or (and (looking-at "[ \t]*:END:")
  20287. (re-search-backward org-drawer-regexp nil t))
  20288. (and (looking-at "[ \t]*#\\+end_")
  20289. (re-search-backward "[ \t]*#\\+begin_"nil t))
  20290. (looking-at "[ \t]*[\n:#|]")
  20291. (looking-at org-footnote-definition-re)
  20292. (and (not inline-task-p)
  20293. (featurep 'org-inlinetask)
  20294. (org-inlinetask-in-task-p)
  20295. (or (org-inlinetask-goto-beginning) t))))
  20296. (beginning-of-line 0))
  20297. (cond
  20298. ;; There was a list item above.
  20299. ((ignore-errors (goto-char (org-in-item-p)))
  20300. (goto-char (org-list-get-top-point (org-list-struct)))
  20301. (setq column (org-get-indentation)))
  20302. ;; There was an heading above.
  20303. ((looking-at "\\*+[ \t]+")
  20304. (if (not org-adapt-indentation)
  20305. (setq column 0)
  20306. (goto-char (match-end 0))
  20307. (setq column (current-column))))
  20308. ;; A drawer had started and is unfinished
  20309. ((looking-at org-drawer-regexp)
  20310. (goto-char (1- (match-beginning 1)))
  20311. (setq column (current-column)))
  20312. ;; Else, nothing noticeable found: get indentation and go on.
  20313. (t (setq column (org-get-indentation))))))
  20314. ;; Now apply indentation and move cursor accordingly
  20315. (goto-char pos)
  20316. (if (<= (current-column) (current-indentation))
  20317. (org-indent-line-to column)
  20318. (save-excursion (org-indent-line-to column)))
  20319. ;; Special polishing for properties, see `org-property-format'
  20320. (setq column (current-column))
  20321. (beginning-of-line 1)
  20322. (if (looking-at org-property-re)
  20323. (replace-match (concat (match-string 4)
  20324. (format org-property-format
  20325. (match-string 1) (match-string 3)))
  20326. t t))
  20327. (org-move-to-column column))))
  20328. (defun org-indent-drawer ()
  20329. "Indent the drawer at point."
  20330. (interactive)
  20331. (let ((p (point))
  20332. (e (and (save-excursion (re-search-forward ":END:" nil t))
  20333. (match-end 0)))
  20334. (folded
  20335. (save-excursion
  20336. (end-of-line)
  20337. (when (overlays-at (point))
  20338. (member 'invisible (overlay-properties
  20339. (car (overlays-at (point)))))))))
  20340. (when folded (org-cycle))
  20341. (indent-for-tab-command)
  20342. (while (and (move-beginning-of-line 2) (< (point) e))
  20343. (indent-for-tab-command))
  20344. (goto-char p)
  20345. (when folded (org-cycle)))
  20346. (message "Drawer at point indented"))
  20347. (defun org-indent-block ()
  20348. "Indent the block at point."
  20349. (interactive)
  20350. (let ((p (point))
  20351. (case-fold-search t)
  20352. (e (and (save-excursion (re-search-forward "#\\+end_?\\(?:[a-z]+\\)?" nil t))
  20353. (match-end 0)))
  20354. (folded
  20355. (save-excursion
  20356. (end-of-line)
  20357. (when (overlays-at (point))
  20358. (member 'invisible (overlay-properties
  20359. (car (overlays-at (point)))))))))
  20360. (when folded (org-cycle))
  20361. (indent-for-tab-command)
  20362. (while (and (move-beginning-of-line 2) (< (point) e))
  20363. (indent-for-tab-command))
  20364. (goto-char p)
  20365. (when folded (org-cycle)))
  20366. (message "Block at point indented"))
  20367. (defun org-indent-region (start end)
  20368. "Indent region."
  20369. (interactive "r")
  20370. (save-excursion
  20371. (let ((line-end (org-current-line end)))
  20372. (goto-char start)
  20373. (while (< (org-current-line) line-end)
  20374. (cond ((org-in-src-block-p t) (org-src-native-tab-command-maybe))
  20375. (t (call-interactively 'org-indent-line)))
  20376. (move-beginning-of-line 2)))))
  20377. ;;; Filling
  20378. ;; We use our own fill-paragraph and auto-fill functions.
  20379. ;; `org-fill-paragraph' relies on adaptive filling and context
  20380. ;; checking. Appropriate `fill-prefix' is computed with
  20381. ;; `org-adaptive-fill-function'.
  20382. ;; `org-auto-fill-function' takes care of auto-filling. It calls
  20383. ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
  20384. ;; `org-adaptive-fill-function' value. Internally,
  20385. ;; `org-comment-line-break-function' breaks the line.
  20386. ;; `org-setup-filling' installs filling and auto-filling related
  20387. ;; variables during `org-mode' initialization.
  20388. (defvar org-element-paragraph-separate) ; org-element.el
  20389. (defun org-setup-filling ()
  20390. (require 'org-element)
  20391. ;; Prevent auto-fill from inserting unwanted new items.
  20392. (when (boundp 'fill-nobreak-predicate)
  20393. (org-set-local
  20394. 'fill-nobreak-predicate
  20395. (org-uniquify
  20396. (append fill-nobreak-predicate
  20397. '(org-fill-line-break-nobreak-p
  20398. org-fill-paragraph-with-timestamp-nobreak-p)))))
  20399. (let ((paragraph-ending (substring org-element-paragraph-separate 1)))
  20400. (org-set-local 'paragraph-start paragraph-ending)
  20401. (org-set-local 'paragraph-separate paragraph-ending))
  20402. (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
  20403. (org-set-local 'auto-fill-inhibit-regexp nil)
  20404. (org-set-local 'adaptive-fill-function 'org-adaptive-fill-function)
  20405. (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
  20406. (org-set-local 'comment-line-break-function 'org-comment-line-break-function))
  20407. (defun org-fill-line-break-nobreak-p ()
  20408. "Non-nil when a new line at point would create an Org line break."
  20409. (save-excursion
  20410. (skip-chars-backward "[ \t]")
  20411. (skip-chars-backward "\\\\")
  20412. (looking-at "\\\\\\\\\\($\\|[^\\\\]\\)")))
  20413. (defun org-fill-paragraph-with-timestamp-nobreak-p ()
  20414. "Non-nil when a new line at point would split a timestamp."
  20415. (and (org-at-timestamp-p t)
  20416. (not (looking-at org-ts-regexp-both))))
  20417. (declare-function message-in-body-p "message" ())
  20418. (defvar orgtbl-line-start-regexp) ; From org-table.el
  20419. (defun org-adaptive-fill-function ()
  20420. "Compute a fill prefix for the current line.
  20421. Return fill prefix, as a string, or nil if current line isn't
  20422. meant to be filled. For convenience, if `adaptive-fill-regexp'
  20423. matches in paragraphs or comments, use it."
  20424. (catch 'exit
  20425. (when (derived-mode-p 'message-mode)
  20426. (save-excursion
  20427. (beginning-of-line)
  20428. (cond ((or (not (message-in-body-p))
  20429. (looking-at orgtbl-line-start-regexp))
  20430. (throw 'exit nil))
  20431. ((looking-at message-cite-prefix-regexp)
  20432. (throw 'exit (match-string-no-properties 0)))
  20433. ((looking-at org-outline-regexp)
  20434. (throw 'exit (make-string (length (match-string 0)) ? ))))))
  20435. (org-with-wide-buffer
  20436. (let* ((p (line-beginning-position))
  20437. (element (save-excursion
  20438. (beginning-of-line)
  20439. (or (ignore-errors (org-element-at-point))
  20440. (user-error "An element cannot be parsed line %d"
  20441. (line-number-at-pos (point))))))
  20442. (type (org-element-type element))
  20443. (post-affiliated (org-element-property :post-affiliated element)))
  20444. (unless (and post-affiliated (< p post-affiliated))
  20445. (case type
  20446. (comment
  20447. (save-excursion
  20448. (beginning-of-line)
  20449. (looking-at "[ \t]*")
  20450. (concat (match-string 0) "# ")))
  20451. (footnote-definition "")
  20452. ((item plain-list)
  20453. (make-string (org-list-item-body-column
  20454. (or post-affiliated
  20455. (org-element-property :begin element)))
  20456. ? ))
  20457. (paragraph
  20458. ;; Fill prefix is usually the same as the current line,
  20459. ;; unless the paragraph is at the beginning of an item.
  20460. (let ((parent (org-element-property :parent element)))
  20461. (save-excursion
  20462. (beginning-of-line)
  20463. (cond ((eq (org-element-type parent) 'item)
  20464. (make-string (org-list-item-body-column
  20465. (org-element-property :begin parent))
  20466. ? ))
  20467. ((and adaptive-fill-regexp
  20468. ;; Locally disable
  20469. ;; `adaptive-fill-function' to let
  20470. ;; `fill-context-prefix' handle
  20471. ;; `adaptive-fill-regexp' variable.
  20472. (let (adaptive-fill-function)
  20473. (fill-context-prefix
  20474. post-affiliated
  20475. (org-element-property :end element)))))
  20476. ((looking-at "[ \t]+") (match-string 0))
  20477. (t "")))))
  20478. (comment-block
  20479. ;; Only fill contents if P is within block boundaries.
  20480. (let* ((cbeg (save-excursion (goto-char post-affiliated)
  20481. (forward-line)
  20482. (point)))
  20483. (cend (save-excursion
  20484. (goto-char (org-element-property :end element))
  20485. (skip-chars-backward " \r\t\n")
  20486. (line-beginning-position))))
  20487. (when (and (>= p cbeg) (< p cend))
  20488. (if (save-excursion (beginning-of-line) (looking-at "[ \t]+"))
  20489. (match-string 0)
  20490. ""))))))))))
  20491. (declare-function message-goto-body "message" ())
  20492. (defvar message-cite-prefix-regexp) ; From message.el
  20493. (defun org-fill-paragraph (&optional justify)
  20494. "Fill element at point, when applicable.
  20495. This function only applies to comment blocks, comments, example
  20496. blocks and paragraphs. Also, as a special case, re-align table
  20497. when point is at one.
  20498. If JUSTIFY is non-nil (interactively, with prefix argument),
  20499. justify as well. If `sentence-end-double-space' is non-nil, then
  20500. period followed by one space does not end a sentence, so don't
  20501. break a line there. The variable `fill-column' controls the
  20502. width for filling.
  20503. For convenience, when point is at a plain list, an item or
  20504. a footnote definition, try to fill the first paragraph within."
  20505. (interactive)
  20506. (if (and (derived-mode-p 'message-mode)
  20507. (or (not (message-in-body-p))
  20508. (save-excursion (move-beginning-of-line 1)
  20509. (looking-at message-cite-prefix-regexp))))
  20510. ;; First ensure filling is correct in message-mode.
  20511. (let ((fill-paragraph-function
  20512. (cadadr (assoc 'fill-paragraph-function org-fb-vars)))
  20513. (fill-prefix (cadadr (assoc 'fill-prefix org-fb-vars)))
  20514. (paragraph-start (cadadr (assoc 'paragraph-start org-fb-vars)))
  20515. (paragraph-separate
  20516. (cadadr (assoc 'paragraph-separate org-fb-vars))))
  20517. (fill-paragraph nil))
  20518. (with-syntax-table org-mode-transpose-word-syntax-table
  20519. ;; Move to end of line in order to get the first paragraph
  20520. ;; within a plain list or a footnote definition.
  20521. (let ((element (save-excursion
  20522. (end-of-line)
  20523. (or (ignore-errors (org-element-at-point))
  20524. (user-error "An element cannot be parsed line %d"
  20525. (line-number-at-pos (point)))))))
  20526. ;; First check if point is in a blank line at the beginning of
  20527. ;; the buffer. In that case, ignore filling.
  20528. (case (org-element-type element)
  20529. ;; Use major mode filling function is src blocks.
  20530. (src-block (org-babel-do-key-sequence-in-edit-buffer (kbd "M-q")))
  20531. ;; Align Org tables, leave table.el tables as-is.
  20532. (table-row (org-table-align) t)
  20533. (table
  20534. (when (eq (org-element-property :type element) 'org)
  20535. (save-excursion
  20536. (goto-char (org-element-property :post-affiliated element))
  20537. (org-table-align)))
  20538. t)
  20539. (paragraph
  20540. ;; Paragraphs may contain `line-break' type objects.
  20541. (let ((beg (max (point-min)
  20542. (org-element-property :contents-begin element)))
  20543. (end (min (point-max)
  20544. (org-element-property :contents-end element))))
  20545. ;; Do nothing if point is at an affiliated keyword.
  20546. (if (< (line-end-position) beg) t
  20547. (when (derived-mode-p 'message-mode)
  20548. ;; In `message-mode', do not fill following citation
  20549. ;; in current paragraph nor text before message body.
  20550. (let ((body-start (save-excursion (message-goto-body))))
  20551. (when body-start (setq beg (max body-start beg))))
  20552. (when (save-excursion
  20553. (re-search-forward
  20554. (concat "^" message-cite-prefix-regexp) end t))
  20555. (setq end (match-beginning 0))))
  20556. ;; Fill paragraph, taking line breaks into account.
  20557. ;; For that, slice the paragraph using line breaks as
  20558. ;; separators, and fill the parts in reverse order to
  20559. ;; avoid messing with markers.
  20560. (save-excursion
  20561. (goto-char end)
  20562. (mapc
  20563. (lambda (pos)
  20564. (fill-region-as-paragraph pos (point) justify)
  20565. (goto-char pos))
  20566. ;; Find the list of ending positions for line breaks
  20567. ;; in the current paragraph. Add paragraph
  20568. ;; beginning to include first slice.
  20569. (nreverse
  20570. (cons beg
  20571. (org-element-map
  20572. (org-element--parse-objects
  20573. beg end nil (org-element-restriction 'paragraph))
  20574. 'line-break
  20575. (lambda (lb) (org-element-property :end lb)))))))
  20576. t)))
  20577. ;; Contents of `comment-block' type elements should be
  20578. ;; filled as plain text, but only if point is within block
  20579. ;; markers.
  20580. (comment-block
  20581. (let* ((case-fold-search t)
  20582. (beg (save-excursion
  20583. (goto-char (org-element-property :begin element))
  20584. (re-search-forward "^[ \t]*#\\+begin_comment" nil t)
  20585. (forward-line)
  20586. (point)))
  20587. (end (save-excursion
  20588. (goto-char (org-element-property :end element))
  20589. (re-search-backward "^[ \t]*#\\+end_comment" nil t)
  20590. (line-beginning-position))))
  20591. (if (or (< (point) beg) (> (point) end)) t
  20592. (fill-region-as-paragraph
  20593. (save-excursion (end-of-line)
  20594. (re-search-backward "^[ \t]*$" beg 'move)
  20595. (line-beginning-position))
  20596. (save-excursion (beginning-of-line)
  20597. (re-search-forward "^[ \t]*$" end 'move)
  20598. (line-beginning-position))
  20599. justify))))
  20600. ;; Fill comments.
  20601. (comment
  20602. (let ((begin (org-element-property :post-affiliated element))
  20603. (end (org-element-property :end element)))
  20604. (when (and (>= (point) begin) (<= (point) end))
  20605. (let ((begin (save-excursion
  20606. (end-of-line)
  20607. (if (re-search-backward "^[ \t]*#[ \t]*$" begin t)
  20608. (progn (forward-line) (point))
  20609. begin)))
  20610. (end (save-excursion
  20611. (end-of-line)
  20612. (if (re-search-forward "^[ \t]*#[ \t]*$" end 'move)
  20613. (1- (line-beginning-position))
  20614. (skip-chars-backward " \r\t\n")
  20615. (line-end-position)))))
  20616. ;; Do not fill comments when at a blank line.
  20617. (when (> end begin)
  20618. (let ((fill-prefix
  20619. (save-excursion
  20620. (beginning-of-line)
  20621. (looking-at "[ \t]*#")
  20622. (let ((comment-prefix (match-string 0)))
  20623. (goto-char (match-end 0))
  20624. (if (looking-at adaptive-fill-regexp)
  20625. (concat comment-prefix (match-string 0))
  20626. (concat comment-prefix " "))))))
  20627. (save-excursion
  20628. (fill-region-as-paragraph begin end justify))))))
  20629. t))
  20630. ;; Ignore every other element.
  20631. (otherwise t))))))
  20632. (defun org-auto-fill-function ()
  20633. "Auto-fill function."
  20634. ;; Check if auto-filling is meaningful.
  20635. (let ((fc (current-fill-column)))
  20636. (when (and fc (> (current-column) fc))
  20637. (let* ((fill-prefix (org-adaptive-fill-function))
  20638. ;; Enforce empty fill prefix, if required. Otherwise, it
  20639. ;; will be computed again.
  20640. (adaptive-fill-mode (not (equal fill-prefix ""))))
  20641. (when fill-prefix (do-auto-fill))))))
  20642. (defun org-comment-line-break-function (&optional soft)
  20643. "Break line at point and indent, continuing comment if within one.
  20644. The inserted newline is marked hard if variable
  20645. `use-hard-newlines' is true, unless optional argument SOFT is
  20646. non-nil."
  20647. (if soft (insert-and-inherit ?\n) (newline 1))
  20648. (save-excursion (forward-char -1) (delete-horizontal-space))
  20649. (delete-horizontal-space)
  20650. (indent-to-left-margin)
  20651. (insert-before-markers-and-inherit fill-prefix))
  20652. ;;; Comments
  20653. ;; Org comments syntax is quite complex. It requires the entire line
  20654. ;; to be just a comment. Also, even with the right syntax at the
  20655. ;; beginning of line, some some elements (i.e. verse-block or
  20656. ;; example-block) don't accept comments. Usual Emacs comment commands
  20657. ;; cannot cope with those requirements. Therefore, Org replaces them.
  20658. ;; Org still relies on `comment-dwim', but cannot trust
  20659. ;; `comment-only-p'. So, `comment-region-function' and
  20660. ;; `uncomment-region-function' both point
  20661. ;; to`org-comment-or-uncomment-region'. Eventually,
  20662. ;; `org-insert-comment' takes care of insertion of comments at the
  20663. ;; beginning of line.
  20664. ;; `org-setup-comments-handling' install comments related variables
  20665. ;; during `org-mode' initialization.
  20666. (defun org-setup-comments-handling ()
  20667. (interactive)
  20668. (org-set-local 'comment-use-syntax nil)
  20669. (org-set-local 'comment-start "# ")
  20670. (org-set-local 'comment-start-skip "^\\s-*#\\(?: \\|$\\)")
  20671. (org-set-local 'comment-insert-comment-function 'org-insert-comment)
  20672. (org-set-local 'comment-region-function 'org-comment-or-uncomment-region)
  20673. (org-set-local 'uncomment-region-function 'org-comment-or-uncomment-region))
  20674. (defun org-insert-comment ()
  20675. "Insert an empty comment above current line.
  20676. If the line is empty, insert comment at its beginning."
  20677. (beginning-of-line)
  20678. (if (looking-at "\\s-*$") (replace-match "") (open-line 1))
  20679. (org-indent-line)
  20680. (insert "# "))
  20681. (defvar comment-empty-lines) ; From newcomment.el.
  20682. (defun org-comment-or-uncomment-region (beg end &rest ignore)
  20683. "Comment or uncomment each non-blank line in the region.
  20684. Uncomment each non-blank line between BEG and END if it only
  20685. contains commented lines. Otherwise, comment them."
  20686. (save-restriction
  20687. ;; Restrict region
  20688. (narrow-to-region (save-excursion (goto-char beg)
  20689. (skip-chars-forward " \r\t\n" end)
  20690. (line-beginning-position))
  20691. (save-excursion (goto-char end)
  20692. (skip-chars-backward " \r\t\n" beg)
  20693. (line-end-position)))
  20694. (let ((uncommentp
  20695. ;; UNCOMMENTP is non-nil when every non blank line between
  20696. ;; BEG and END is a comment.
  20697. (save-excursion
  20698. (goto-char (point-min))
  20699. (while (and (not (eobp))
  20700. (let ((element (org-element-at-point)))
  20701. (and (eq (org-element-type element) 'comment)
  20702. (goto-char (min (point-max)
  20703. (org-element-property
  20704. :end element)))))))
  20705. (eobp))))
  20706. (if uncommentp
  20707. ;; Only blank lines and comments in region: uncomment it.
  20708. (save-excursion
  20709. (goto-char (point-min))
  20710. (while (not (eobp))
  20711. (when (looking-at "[ \t]*\\(#\\(?: \\|$\\)\\)")
  20712. (replace-match "" nil nil nil 1))
  20713. (forward-line)))
  20714. ;; Comment each line in region.
  20715. (let ((min-indent (point-max)))
  20716. ;; First find the minimum indentation across all lines.
  20717. (save-excursion
  20718. (goto-char (point-min))
  20719. (while (and (not (eobp)) (not (zerop min-indent)))
  20720. (unless (looking-at "[ \t]*$")
  20721. (setq min-indent (min min-indent (current-indentation))))
  20722. (forward-line)))
  20723. ;; Then loop over all lines.
  20724. (save-excursion
  20725. (goto-char (point-min))
  20726. (while (not (eobp))
  20727. (unless (and (not comment-empty-lines) (looking-at "[ \t]*$"))
  20728. ;; Don't get fooled by invisible text (e.g. link path)
  20729. ;; when moving to column MIN-INDENT.
  20730. (let ((buffer-invisibility-spec nil))
  20731. (org-move-to-column min-indent t))
  20732. (insert comment-start))
  20733. (forward-line))))))))
  20734. ;;; Planning
  20735. ;; This section contains tools to operate on timestamp objects, as
  20736. ;; returned by, e.g. `org-element-context'.
  20737. (defun org-timestamp-has-time-p (timestamp)
  20738. "Non-nil when TIMESTAMP has a time specified."
  20739. (org-element-property :hour-start timestamp))
  20740. (defun org-timestamp-format (timestamp format &optional end utc)
  20741. "Format a TIMESTAMP element into a string.
  20742. FORMAT is a format specifier to be passed to
  20743. `format-time-string'.
  20744. When optional argument END is non-nil, use end of date-range or
  20745. time-range, if possible.
  20746. When optional argument UTC is non-nil, time will be expressed as
  20747. Universal Time."
  20748. (format-time-string
  20749. format
  20750. (apply 'encode-time
  20751. (cons 0
  20752. (mapcar
  20753. (lambda (prop) (or (org-element-property prop timestamp) 0))
  20754. (if end '(:minute-end :hour-end :day-end :month-end :year-end)
  20755. '(:minute-start :hour-start :day-start :month-start
  20756. :year-start)))))
  20757. utc))
  20758. (defun org-timestamp-split-range (timestamp &optional end)
  20759. "Extract a timestamp object from a date or time range.
  20760. TIMESTAMP is a timestamp object. END, when non-nil, means extract
  20761. the end of the range. Otherwise, extract its start.
  20762. Return a new timestamp object sharing the same parent as
  20763. TIMESTAMP."
  20764. (let ((type (org-element-property :type timestamp)))
  20765. (if (memq type '(active inactive diary)) timestamp
  20766. (let ((split-ts (list 'timestamp (copy-sequence (nth 1 timestamp)))))
  20767. ;; Set new type.
  20768. (org-element-put-property
  20769. split-ts :type (if (eq type 'active-range) 'active 'inactive))
  20770. ;; Copy start properties over end properties if END is
  20771. ;; non-nil. Otherwise, copy end properties over `start' ones.
  20772. (let ((p-alist '((:minute-start . :minute-end)
  20773. (:hour-start . :hour-end)
  20774. (:day-start . :day-end)
  20775. (:month-start . :month-end)
  20776. (:year-start . :year-end))))
  20777. (dolist (p-cell p-alist)
  20778. (org-element-put-property
  20779. split-ts
  20780. (funcall (if end 'car 'cdr) p-cell)
  20781. (org-element-property
  20782. (funcall (if end 'cdr 'car) p-cell) split-ts)))
  20783. ;; Eventually refresh `:raw-value'.
  20784. (org-element-put-property split-ts :raw-value nil)
  20785. (org-element-put-property
  20786. split-ts :raw-value (org-element-interpret-data split-ts)))))))
  20787. (defun org-timestamp-translate (timestamp &optional boundary)
  20788. "Apply `org-translate-time' on a TIMESTAMP object.
  20789. When optional argument BOUNDARY is non-nil, it is either the
  20790. symbol `start' or `end'. In this case, only translate the
  20791. starting or ending part of TIMESTAMP if it is a date or time
  20792. range. Otherwise, translate both parts."
  20793. (if (and (not boundary)
  20794. (memq (org-element-property :type timestamp)
  20795. '(active-range inactive-range)))
  20796. (concat
  20797. (org-translate-time
  20798. (org-element-property :raw-value
  20799. (org-timestamp-split-range timestamp)))
  20800. "--"
  20801. (org-translate-time
  20802. (org-element-property :raw-value
  20803. (org-timestamp-split-range timestamp t))))
  20804. (org-translate-time
  20805. (org-element-property
  20806. :raw-value
  20807. (if (not boundary) timestamp
  20808. (org-timestamp-split-range timestamp (eq boundary 'end)))))))
  20809. ;;; Other stuff.
  20810. (defun org-toggle-fixed-width-section (arg)
  20811. "Toggle the fixed-width export.
  20812. If there is no active region, the QUOTE keyword at the current headline is
  20813. inserted or removed. When present, it causes the text between this headline
  20814. and the next to be exported as fixed-width text, and unmodified.
  20815. If there is an active region, this command adds or removes a colon as the
  20816. first character of this line. If the first character of a line is a colon,
  20817. this line is also exported in fixed-width font."
  20818. (interactive "P")
  20819. (let* ((cc 0)
  20820. (regionp (org-region-active-p))
  20821. (beg (if regionp (region-beginning) (point)))
  20822. (end (if regionp (region-end)))
  20823. (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
  20824. (case-fold-search nil)
  20825. (re "[ \t]*\\(:\\(?: \\|$\\)\\)")
  20826. off)
  20827. (if regionp
  20828. (save-excursion
  20829. (goto-char beg)
  20830. (setq cc (current-column))
  20831. (beginning-of-line 1)
  20832. (setq off (looking-at re))
  20833. (while (> nlines 0)
  20834. (setq nlines (1- nlines))
  20835. (beginning-of-line 1)
  20836. (cond
  20837. (arg
  20838. (org-move-to-column cc t)
  20839. (insert ": \n")
  20840. (forward-line -1))
  20841. ((and off (looking-at re))
  20842. (replace-match "" t t nil 1))
  20843. ((not off) (org-move-to-column cc t) (insert ": ")))
  20844. (forward-line 1)))
  20845. (save-excursion
  20846. (org-back-to-heading)
  20847. (cond
  20848. ((looking-at (format org-heading-keyword-regexp-format
  20849. org-quote-string))
  20850. (goto-char (match-end 1))
  20851. (looking-at (concat " +" org-quote-string))
  20852. (replace-match "" t t)
  20853. (when (eolp) (insert " ")))
  20854. ((looking-at org-outline-regexp)
  20855. (goto-char (match-end 0))
  20856. (insert org-quote-string " ")))))))
  20857. (defun org-reftex-citation ()
  20858. "Use reftex-citation to insert a citation into the buffer.
  20859. This looks for a line like
  20860. #+BIBLIOGRAPHY: foo plain option:-d
  20861. and derives from it that foo.bib is the bibliography file relevant
  20862. for this document. It then installs the necessary environment for RefTeX
  20863. to work in this buffer and calls `reftex-citation' to insert a citation
  20864. into the buffer.
  20865. Export of such citations to both LaTeX and HTML is handled by the contributed
  20866. package ox-bibtex by Taru Karttunen."
  20867. (interactive)
  20868. (let ((reftex-docstruct-symbol 'rds)
  20869. (reftex-cite-format "\\cite{%l}")
  20870. rds bib)
  20871. (save-excursion
  20872. (save-restriction
  20873. (widen)
  20874. (let ((case-fold-search t)
  20875. (re "^#\\+bibliography:[ \t]+\\([^ \t\n]+\\)"))
  20876. (if (not (save-excursion
  20877. (or (re-search-forward re nil t)
  20878. (re-search-backward re nil t))))
  20879. (error "No bibliography defined in file")
  20880. (setq bib (concat (match-string 1) ".bib")
  20881. rds (list (list 'bib bib)))))))
  20882. (call-interactively 'reftex-citation)))
  20883. ;;;; Functions extending outline functionality
  20884. (defun org-beginning-of-line (&optional arg)
  20885. "Go to the beginning of the current line. If that is invisible, continue
  20886. to a visible line beginning. This makes the function of C-a more intuitive.
  20887. If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
  20888. first attempt, and only move to after the tags when the cursor is already
  20889. beyond the end of the headline."
  20890. (interactive "P")
  20891. (let ((pos (point))
  20892. (special (if (consp org-special-ctrl-a/e)
  20893. (car org-special-ctrl-a/e)
  20894. org-special-ctrl-a/e))
  20895. deactivate-mark refpos)
  20896. (if (org-bound-and-true-p visual-line-mode)
  20897. (beginning-of-visual-line 1)
  20898. (beginning-of-line 1))
  20899. (if (and arg (fboundp 'move-beginning-of-line))
  20900. (call-interactively 'move-beginning-of-line)
  20901. (if (bobp)
  20902. nil
  20903. (backward-char 1)
  20904. (if (org-truely-invisible-p)
  20905. (while (and (not (bobp)) (org-truely-invisible-p))
  20906. (backward-char 1)
  20907. (beginning-of-line 1))
  20908. (forward-char 1))))
  20909. (when special
  20910. (cond
  20911. ((and (looking-at org-complex-heading-regexp)
  20912. (= (char-after (match-end 1)) ?\ ))
  20913. (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
  20914. (point-at-eol)))
  20915. (goto-char
  20916. (if (eq special t)
  20917. (cond ((> pos refpos) refpos)
  20918. ((= pos (point)) refpos)
  20919. (t (point)))
  20920. (cond ((> pos (point)) (point))
  20921. ((not (eq last-command this-command)) (point))
  20922. (t refpos)))))
  20923. ((org-at-item-p)
  20924. ;; Being at an item and not looking at an the item means point
  20925. ;; was previously moved to beginning of a visual line, which
  20926. ;; doesn't contain the item. Therefore, do nothing special,
  20927. ;; just stay here.
  20928. (when (looking-at org-list-full-item-re)
  20929. ;; Set special position at first white space character after
  20930. ;; bullet, and check-box, if any.
  20931. (let ((after-bullet
  20932. (let ((box (match-end 3)))
  20933. (if (not box) (match-end 1)
  20934. (let ((after (char-after box)))
  20935. (if (and after (= after ? )) (1+ box) box))))))
  20936. ;; Special case: Move point to special position when
  20937. ;; currently after it or at beginning of line.
  20938. (if (eq special t)
  20939. (when (or (> pos after-bullet) (= (point) pos))
  20940. (goto-char after-bullet))
  20941. ;; Reversed case: Move point to special position when
  20942. ;; point was already at beginning of line and command is
  20943. ;; repeated.
  20944. (when (and (= (point) pos) (eq last-command this-command))
  20945. (goto-char after-bullet))))))))
  20946. (org-no-warnings
  20947. (and (featurep 'xemacs) (setq zmacs-region-stays t))))
  20948. (setq disable-point-adjustment
  20949. (or (not (invisible-p (point)))
  20950. (not (invisible-p (max (point-min) (1- (point))))))))
  20951. (defun org-end-of-line (&optional arg)
  20952. "Go to the end of the line.
  20953. If this is a headline, and `org-special-ctrl-a/e' is set, ignore
  20954. tags on the first attempt, and only move to after the tags when
  20955. the cursor is already beyond the end of the headline."
  20956. (interactive "P")
  20957. (let ((special (if (consp org-special-ctrl-a/e) (cdr org-special-ctrl-a/e)
  20958. org-special-ctrl-a/e))
  20959. (move-fun (cond ((org-bound-and-true-p visual-line-mode)
  20960. 'end-of-visual-line)
  20961. ((fboundp 'move-end-of-line) 'move-end-of-line)
  20962. (t 'end-of-line)))
  20963. deactivate-mark)
  20964. (if (or (not special) arg) (call-interactively move-fun)
  20965. (let* ((element (save-excursion (beginning-of-line)
  20966. (org-element-at-point)))
  20967. (type (org-element-type element)))
  20968. (cond
  20969. ((memq type '(headline inlinetask))
  20970. (let ((pos (point)))
  20971. (beginning-of-line 1)
  20972. (if (looking-at (org-re ".*?\\(?:\\([ \t]*\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*\\)?$"))
  20973. (if (eq special t)
  20974. (if (or (< pos (match-beginning 1)) (= pos (match-end 0)))
  20975. (goto-char (match-beginning 1))
  20976. (goto-char (match-end 0)))
  20977. (if (or (< pos (match-end 0))
  20978. (not (eq this-command last-command)))
  20979. (goto-char (match-end 0))
  20980. (goto-char (match-beginning 1))))
  20981. (call-interactively move-fun))))
  20982. ((outline-invisible-p (line-end-position))
  20983. ;; If element is hidden, `move-end-of-line' would put point
  20984. ;; after it. Use `end-of-line' to stay on current line.
  20985. (call-interactively 'end-of-line))
  20986. (t (call-interactively move-fun)))))
  20987. (org-no-warnings (and (featurep 'xemacs) (setq zmacs-region-stays t))))
  20988. (setq disable-point-adjustment
  20989. (or (not (invisible-p (point)))
  20990. (not (invisible-p (max (point-min) (1- (point))))))))
  20991. (define-key org-mode-map "\C-a" 'org-beginning-of-line)
  20992. (define-key org-mode-map "\C-e" 'org-end-of-line)
  20993. (defun org-backward-sentence (&optional arg)
  20994. "Go to beginning of sentence, or beginning of table field.
  20995. This will call `backward-sentence' or `org-table-beginning-of-field',
  20996. depending on context."
  20997. (interactive "P")
  20998. (cond
  20999. ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
  21000. (t (call-interactively 'backward-sentence))))
  21001. (defun org-forward-sentence (&optional arg)
  21002. "Go to end of sentence, or end of table field.
  21003. This will call `forward-sentence' or `org-table-end-of-field',
  21004. depending on context."
  21005. (interactive "P")
  21006. (cond
  21007. ((org-at-table-p) (call-interactively 'org-table-end-of-field))
  21008. (t (call-interactively 'forward-sentence))))
  21009. (define-key org-mode-map "\M-a" 'org-backward-sentence)
  21010. (define-key org-mode-map "\M-e" 'org-forward-sentence)
  21011. (defun org-kill-line (&optional arg)
  21012. "Kill line, to tags or end of line."
  21013. (interactive "P")
  21014. (cond
  21015. ((or (not org-special-ctrl-k)
  21016. (bolp)
  21017. (not (org-at-heading-p)))
  21018. (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
  21019. org-ctrl-k-protect-subtree)
  21020. (if (or (eq org-ctrl-k-protect-subtree 'error)
  21021. (not (y-or-n-p "Kill hidden subtree along with headline? ")))
  21022. (user-error "C-k aborted as it would kill a hidden subtree")))
  21023. (call-interactively
  21024. (if (org-bound-and-true-p visual-line-mode) 'kill-visual-line 'kill-line)))
  21025. ((looking-at (org-re ".*?\\S-\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$"))
  21026. (kill-region (point) (match-beginning 1))
  21027. (org-set-tags nil t))
  21028. (t (kill-region (point) (point-at-eol)))))
  21029. (define-key org-mode-map "\C-k" 'org-kill-line)
  21030. (defun org-yank (&optional arg)
  21031. "Yank. If the kill is a subtree, treat it specially.
  21032. This command will look at the current kill and check if is a single
  21033. subtree, or a series of subtrees[1]. If it passes the test, and if the
  21034. cursor is at the beginning of a line or after the stars of a currently
  21035. empty headline, then the yank is handled specially. How exactly depends
  21036. on the value of the following variables, both set by default.
  21037. org-yank-folded-subtrees
  21038. When set, the subtree(s) will be folded after insertion, but only
  21039. if doing so would now swallow text after the yanked text.
  21040. org-yank-adjusted-subtrees
  21041. When set, the subtree will be promoted or demoted in order to
  21042. fit into the local outline tree structure, which means that the level
  21043. will be adjusted so that it becomes the smaller one of the two
  21044. *visible* surrounding headings.
  21045. Any prefix to this command will cause `yank' to be called directly with
  21046. no special treatment. In particular, a simple \\[universal-argument] prefix \
  21047. will just
  21048. plainly yank the text as it is.
  21049. \[1] The test checks if the first non-white line is a heading
  21050. and if there are no other headings with fewer stars."
  21051. (interactive "P")
  21052. (org-yank-generic 'yank arg))
  21053. (defun org-yank-generic (command arg)
  21054. "Perform some yank-like command.
  21055. This function implements the behavior described in the `org-yank'
  21056. documentation. However, it has been generalized to work for any
  21057. interactive command with similar behavior."
  21058. ;; pretend to be command COMMAND
  21059. (setq this-command command)
  21060. (if arg
  21061. (call-interactively command)
  21062. (let ((subtreep ; is kill a subtree, and the yank position appropriate?
  21063. (and (org-kill-is-subtree-p)
  21064. (or (bolp)
  21065. (and (looking-at "[ \t]*$")
  21066. (string-match
  21067. "\\`\\*+\\'"
  21068. (buffer-substring (point-at-bol) (point)))))))
  21069. swallowp)
  21070. (cond
  21071. ((and subtreep org-yank-folded-subtrees)
  21072. (let ((beg (point))
  21073. end)
  21074. (if (and subtreep org-yank-adjusted-subtrees)
  21075. (org-paste-subtree nil nil 'for-yank)
  21076. (call-interactively command))
  21077. (setq end (point))
  21078. (goto-char beg)
  21079. (when (and (bolp) subtreep
  21080. (not (setq swallowp
  21081. (org-yank-folding-would-swallow-text beg end))))
  21082. (org-with-limited-levels
  21083. (or (looking-at org-outline-regexp)
  21084. (re-search-forward org-outline-regexp-bol end t))
  21085. (while (and (< (point) end) (looking-at org-outline-regexp))
  21086. (hide-subtree)
  21087. (org-cycle-show-empty-lines 'folded)
  21088. (condition-case nil
  21089. (outline-forward-same-level 1)
  21090. (error (goto-char end))))))
  21091. (when swallowp
  21092. (message
  21093. "Inserted text not folded because that would swallow text"))
  21094. (goto-char end)
  21095. (skip-chars-forward " \t\n\r")
  21096. (beginning-of-line 1)
  21097. (push-mark beg 'nomsg)))
  21098. ((and subtreep org-yank-adjusted-subtrees)
  21099. (let ((beg (point-at-bol)))
  21100. (org-paste-subtree nil nil 'for-yank)
  21101. (push-mark beg 'nomsg)))
  21102. (t
  21103. (call-interactively command))))))
  21104. (defun org-yank-folding-would-swallow-text (beg end)
  21105. "Would hide-subtree at BEG swallow any text after END?"
  21106. (let (level)
  21107. (org-with-limited-levels
  21108. (save-excursion
  21109. (goto-char beg)
  21110. (when (or (looking-at org-outline-regexp)
  21111. (re-search-forward org-outline-regexp-bol end t))
  21112. (setq level (org-outline-level)))
  21113. (goto-char end)
  21114. (skip-chars-forward " \t\r\n\v\f")
  21115. (if (or (eobp)
  21116. (and (bolp) (looking-at org-outline-regexp)
  21117. (<= (org-outline-level) level)))
  21118. nil ; Nothing would be swallowed
  21119. t))))) ; something would swallow
  21120. (define-key org-mode-map "\C-y" 'org-yank)
  21121. (defun org-truely-invisible-p ()
  21122. "Check if point is at a character currently not visible.
  21123. This version does not only check the character property, but also
  21124. `visible-mode'."
  21125. ;; Early versions of noutline don't have `outline-invisible-p'.
  21126. (if (org-bound-and-true-p visible-mode)
  21127. nil
  21128. (outline-invisible-p)))
  21129. (defun org-invisible-p2 ()
  21130. "Check if point is at a character currently not visible."
  21131. (save-excursion
  21132. (if (and (eolp) (not (bobp))) (backward-char 1))
  21133. ;; Early versions of noutline don't have `outline-invisible-p'.
  21134. (outline-invisible-p)))
  21135. (defun org-back-to-heading (&optional invisible-ok)
  21136. "Call `outline-back-to-heading', but provide a better error message."
  21137. (condition-case nil
  21138. (outline-back-to-heading invisible-ok)
  21139. (error (error "Before first headline at position %d in buffer %s"
  21140. (point) (current-buffer)))))
  21141. (defun org-before-first-heading-p ()
  21142. "Before first heading?"
  21143. (save-excursion
  21144. (end-of-line)
  21145. (null (re-search-backward org-outline-regexp-bol nil t))))
  21146. (defun org-at-heading-p (&optional ignored)
  21147. (outline-on-heading-p t))
  21148. ;; Compatibility alias with Org versions < 7.8.03
  21149. (defalias 'org-on-heading-p 'org-at-heading-p)
  21150. (defun org-at-comment-p nil
  21151. "Is cursor in a line starting with a # character?"
  21152. (save-excursion
  21153. (beginning-of-line)
  21154. (looking-at "^#")))
  21155. (defun org-at-drawer-p nil
  21156. "Is cursor at a drawer keyword?"
  21157. (save-excursion
  21158. (move-beginning-of-line 1)
  21159. (looking-at org-drawer-regexp)))
  21160. (defun org-at-block-p nil
  21161. "Is cursor at a block keyword?"
  21162. (save-excursion
  21163. (move-beginning-of-line 1)
  21164. (looking-at org-block-regexp)))
  21165. (defun org-point-at-end-of-empty-headline ()
  21166. "If point is at the end of an empty headline, return t, else nil.
  21167. If the heading only contains a TODO keyword, it is still still considered
  21168. empty."
  21169. (and (looking-at "[ \t]*$")
  21170. (when org-todo-line-regexp
  21171. (save-excursion
  21172. (beginning-of-line 1)
  21173. (let ((case-fold-search nil))
  21174. (looking-at org-todo-line-regexp)
  21175. (string= (match-string 3) ""))))))
  21176. (defun org-at-heading-or-item-p ()
  21177. (or (org-at-heading-p) (org-at-item-p)))
  21178. (defun org-at-target-p ()
  21179. (or (org-in-regexp org-radio-target-regexp)
  21180. (org-in-regexp org-target-regexp)))
  21181. ;; Compatibility alias with Org versions < 7.8.03
  21182. (defalias 'org-on-target-p 'org-at-target-p)
  21183. (defun org-up-heading-all (arg)
  21184. "Move to the heading line of which the present line is a subheading.
  21185. This function considers both visible and invisible heading lines.
  21186. With argument, move up ARG levels."
  21187. (if (fboundp 'outline-up-heading-all)
  21188. (outline-up-heading-all arg) ; emacs 21 version of outline.el
  21189. (outline-up-heading arg t))) ; emacs 22 version of outline.el
  21190. (defun org-up-heading-safe ()
  21191. "Move to the heading line of which the present line is a subheading.
  21192. This version will not throw an error. It will return the level of the
  21193. headline found, or nil if no higher level is found.
  21194. Also, this function will be a lot faster than `outline-up-heading',
  21195. because it relies on stars being the outline starters. This can really
  21196. make a significant difference in outlines with very many siblings."
  21197. (let (start-level re)
  21198. (org-back-to-heading t)
  21199. (setq start-level (funcall outline-level))
  21200. (if (equal start-level 1)
  21201. nil
  21202. (setq re (concat "^\\*\\{1," (number-to-string (1- start-level)) "\\} "))
  21203. (if (re-search-backward re nil t)
  21204. (funcall outline-level)))))
  21205. (defun org-first-sibling-p ()
  21206. "Is this heading the first child of its parents?"
  21207. (interactive)
  21208. (let ((re org-outline-regexp-bol)
  21209. level l)
  21210. (unless (org-at-heading-p t)
  21211. (user-error "Not at a heading"))
  21212. (setq level (funcall outline-level))
  21213. (save-excursion
  21214. (if (not (re-search-backward re nil t))
  21215. t
  21216. (setq l (funcall outline-level))
  21217. (< l level)))))
  21218. (defun org-goto-sibling (&optional previous)
  21219. "Goto the next sibling, even if it is invisible.
  21220. When PREVIOUS is set, go to the previous sibling instead. Returns t
  21221. when a sibling was found. When none is found, return nil and don't
  21222. move point."
  21223. (let ((fun (if previous 're-search-backward 're-search-forward))
  21224. (pos (point))
  21225. (re org-outline-regexp-bol)
  21226. level l)
  21227. (when (condition-case nil (org-back-to-heading t) (error nil))
  21228. (setq level (funcall outline-level))
  21229. (catch 'exit
  21230. (or previous (forward-char 1))
  21231. (while (funcall fun re nil t)
  21232. (setq l (funcall outline-level))
  21233. (when (< l level) (goto-char pos) (throw 'exit nil))
  21234. (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
  21235. (goto-char pos)
  21236. nil))))
  21237. (defun org-show-siblings ()
  21238. "Show all siblings of the current headline."
  21239. (save-excursion
  21240. (while (org-goto-sibling) (org-flag-heading nil)))
  21241. (save-excursion
  21242. (while (org-goto-sibling 'previous)
  21243. (org-flag-heading nil))))
  21244. (defun org-goto-first-child ()
  21245. "Goto the first child, even if it is invisible.
  21246. Return t when a child was found. Otherwise don't move point and
  21247. return nil."
  21248. (let (level (pos (point)) (re org-outline-regexp-bol))
  21249. (when (condition-case nil (org-back-to-heading t) (error nil))
  21250. (setq level (outline-level))
  21251. (forward-char 1)
  21252. (if (and (re-search-forward re nil t) (> (outline-level) level))
  21253. (progn (goto-char (match-beginning 0)) t)
  21254. (goto-char pos) nil))))
  21255. (defun org-show-hidden-entry ()
  21256. "Show an entry where even the heading is hidden."
  21257. (save-excursion
  21258. (org-show-entry)))
  21259. (defun org-flag-heading (flag &optional entry)
  21260. "Flag the current heading. FLAG non-nil means make invisible.
  21261. When ENTRY is non-nil, show the entire entry."
  21262. (save-excursion
  21263. (org-back-to-heading t)
  21264. ;; Check if we should show the entire entry
  21265. (if entry
  21266. (progn
  21267. (org-show-entry)
  21268. (save-excursion
  21269. (and (outline-next-heading)
  21270. (org-flag-heading nil))))
  21271. (outline-flag-region (max (point-min) (1- (point)))
  21272. (save-excursion (outline-end-of-heading) (point))
  21273. flag))))
  21274. (defun org-get-next-sibling ()
  21275. "Move to next heading of the same level, and return point.
  21276. If there is no such heading, return nil.
  21277. This is like outline-next-sibling, but invisible headings are ok."
  21278. (let ((level (funcall outline-level)))
  21279. (outline-next-heading)
  21280. (while (and (not (eobp)) (> (funcall outline-level) level))
  21281. (outline-next-heading))
  21282. (if (or (eobp) (< (funcall outline-level) level))
  21283. nil
  21284. (point))))
  21285. (defun org-get-last-sibling ()
  21286. "Move to previous heading of the same level, and return point.
  21287. If there is no such heading, return nil."
  21288. (let ((opoint (point))
  21289. (level (funcall outline-level)))
  21290. (outline-previous-heading)
  21291. (when (and (/= (point) opoint) (outline-on-heading-p t))
  21292. (while (and (> (funcall outline-level) level)
  21293. (not (bobp)))
  21294. (outline-previous-heading))
  21295. (if (< (funcall outline-level) level)
  21296. nil
  21297. (point)))))
  21298. (defun org-end-of-subtree (&optional invisible-ok to-heading)
  21299. "Goto to the end of a subtree."
  21300. ;; This contains an exact copy of the original function, but it uses
  21301. ;; `org-back-to-heading', to make it work also in invisible
  21302. ;; trees. And is uses an invisible-ok argument.
  21303. ;; Under Emacs this is not needed, but the old outline.el needs this fix.
  21304. ;; Furthermore, when used inside Org, finding the end of a large subtree
  21305. ;; with many children and grandchildren etc, this can be much faster
  21306. ;; than the outline version.
  21307. (org-back-to-heading invisible-ok)
  21308. (let ((first t)
  21309. (level (funcall outline-level)))
  21310. (if (and (derived-mode-p 'org-mode) (< level 1000))
  21311. ;; A true heading (not a plain list item), in Org-mode
  21312. ;; This means we can easily find the end by looking
  21313. ;; only for the right number of stars. Using a regexp to do
  21314. ;; this is so much faster than using a Lisp loop.
  21315. (let ((re (concat "^\\*\\{1," (int-to-string level) "\\} ")))
  21316. (forward-char 1)
  21317. (and (re-search-forward re nil 'move) (beginning-of-line 1)))
  21318. ;; something else, do it the slow way
  21319. (while (and (not (eobp))
  21320. (or first (> (funcall outline-level) level)))
  21321. (setq first nil)
  21322. (outline-next-heading)))
  21323. (unless to-heading
  21324. (if (memq (preceding-char) '(?\n ?\^M))
  21325. (progn
  21326. ;; Go to end of line before heading
  21327. (forward-char -1)
  21328. (if (memq (preceding-char) '(?\n ?\^M))
  21329. ;; leave blank line before heading
  21330. (forward-char -1))))))
  21331. (point))
  21332. (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
  21333. "Use Org version in org-mode, for dramatic speed-up."
  21334. (if (derived-mode-p 'org-mode)
  21335. (progn
  21336. (org-end-of-subtree nil t)
  21337. (unless (eobp) (backward-char 1)))
  21338. ad-do-it))
  21339. (defun org-end-of-meta-data-and-drawers ()
  21340. "Jump to the first text after meta data and drawers in the current entry.
  21341. This will move over empty lines, lines with planning time stamps,
  21342. clocking lines, and drawers."
  21343. (org-back-to-heading t)
  21344. (let ((end (save-excursion (outline-next-heading) (point)))
  21345. (re (concat "\\(" org-drawer-regexp "\\)"
  21346. "\\|" "[ \t]*" org-keyword-time-regexp)))
  21347. (forward-line 1)
  21348. (while (re-search-forward re end t)
  21349. (if (not (match-end 1))
  21350. ;; empty or planning line
  21351. (forward-line 1)
  21352. ;; a drawer, find the end
  21353. (re-search-forward "^[ \t]*:END:" end 'move)
  21354. (forward-line 1)))
  21355. (and (re-search-forward "[^\n]" nil t) (backward-char 1))
  21356. (point)))
  21357. (defun org-forward-heading-same-level (arg &optional invisible-ok)
  21358. "Move forward to the ARG'th subheading at same level as this one.
  21359. Stop at the first and last subheadings of a superior heading.
  21360. Normally this only looks at visible headings, but when INVISIBLE-OK is
  21361. non-nil it will also look at invisible ones."
  21362. (interactive "p")
  21363. (if (not (ignore-errors (org-back-to-heading invisible-ok)))
  21364. (if (and arg (< arg 0))
  21365. (goto-char (point-min))
  21366. (outline-next-heading))
  21367. (org-at-heading-p)
  21368. (let ((level (- (match-end 0) (match-beginning 0) 1))
  21369. (f (if (and arg (< arg 0))
  21370. 're-search-backward
  21371. 're-search-forward))
  21372. (count (if arg (abs arg) 1))
  21373. (result (point)))
  21374. (while (and (prog1 (> count 0)
  21375. (forward-char (if (and arg (< arg 0)) -1 1)))
  21376. (funcall f org-outline-regexp-bol nil 'move))
  21377. (let ((l (- (match-end 0) (match-beginning 0) 1)))
  21378. (cond ((< l level) (setq count 0))
  21379. ((and (= l level)
  21380. (or invisible-ok
  21381. (progn
  21382. (goto-char (line-beginning-position))
  21383. (not (outline-invisible-p)))))
  21384. (setq count (1- count))
  21385. (when (eq l level)
  21386. (setq result (point)))))))
  21387. (goto-char result))
  21388. (beginning-of-line 1)))
  21389. (defun org-backward-heading-same-level (arg &optional invisible-ok)
  21390. "Move backward to the ARG'th subheading at same level as this one.
  21391. Stop at the first and last subheadings of a superior heading."
  21392. (interactive "p")
  21393. (org-forward-heading-same-level (if arg (- arg) -1) invisible-ok))
  21394. (defun org-next-block (arg &optional backward block-regexp)
  21395. "Jump to the next block.
  21396. With a prefix argument ARG, jump forward ARG many source blocks.
  21397. When BACKWARD is non-nil, jump to the previous block.
  21398. When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
  21399. (interactive "p")
  21400. (let ((re (or block-regexp org-block-regexp))
  21401. (re-search-fn (or (and backward 're-search-backward)
  21402. 're-search-forward)))
  21403. (if (looking-at re) (forward-char 1))
  21404. (condition-case nil
  21405. (funcall re-search-fn re nil nil arg)
  21406. (error (error "No %s code blocks" (if backward "previous" "further" ))))
  21407. (goto-char (match-beginning 0)) (org-show-context)))
  21408. (defun org-previous-block (arg &optional block-regexp)
  21409. "Jump to the previous block.
  21410. With a prefix argument ARG, jump backward ARG many source blocks.
  21411. When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
  21412. (interactive "p")
  21413. (org-next-block arg t block-regexp))
  21414. (defun org-forward-paragraph ()
  21415. "Move forward to beginning of next paragraph or equivalent.
  21416. The function moves point to the beginning of the next visible
  21417. structural element, which can be a paragraph, a table, a list
  21418. item, etc. It also provides some special moves for convenience:
  21419. - On an affiliated keyword, jump to the beginning of the
  21420. relative element.
  21421. - On an item or a footnote definition, move to the second
  21422. element inside, if any.
  21423. - On a table or a property drawer, jump after it.
  21424. - On a verse or source block, stop after blank lines."
  21425. (interactive)
  21426. (when (eobp) (user-error "Cannot move further down"))
  21427. (let* ((deactivate-mark nil)
  21428. (element (org-element-at-point))
  21429. (type (org-element-type element))
  21430. (post-affiliated (org-element-property :post-affiliated element))
  21431. (contents-begin (org-element-property :contents-begin element))
  21432. (contents-end (org-element-property :contents-end element))
  21433. (end (let ((end (org-element-property :end element)) (parent element))
  21434. (while (and (setq parent (org-element-property :parent parent))
  21435. (= (org-element-property :contents-end parent) end))
  21436. (setq end (org-element-property :end parent)))
  21437. end)))
  21438. (cond ((not element)
  21439. (skip-chars-forward " \r\t\n")
  21440. (or (eobp) (beginning-of-line)))
  21441. ;; On affiliated keywords, move to element's beginning.
  21442. ((and post-affiliated (< (point) post-affiliated))
  21443. (goto-char post-affiliated))
  21444. ;; At a table row, move to the end of the table. Similarly,
  21445. ;; at a node property, move to the end of the property
  21446. ;; drawer.
  21447. ((memq type '(node-property table-row))
  21448. (goto-char (org-element-property
  21449. :end (org-element-property :parent element))))
  21450. ((memq type '(property-drawer table)) (goto-char end))
  21451. ;; Consider blank lines as separators in verse and source
  21452. ;; blocks to ease editing.
  21453. ((memq type '(src-block verse-block))
  21454. (when (eq type 'src-block)
  21455. (setq contents-end
  21456. (save-excursion (goto-char end)
  21457. (skip-chars-backward " \r\t\n")
  21458. (line-beginning-position))))
  21459. (beginning-of-line)
  21460. (when (looking-at "[ \t]*$") (skip-chars-forward " \r\t\n"))
  21461. (if (not (re-search-forward "^[ \t]*$" contents-end t))
  21462. (goto-char end)
  21463. (skip-chars-forward " \r\t\n")
  21464. (if (= (point) contents-end) (goto-char end)
  21465. (beginning-of-line))))
  21466. ;; With no contents, just skip element.
  21467. ((not contents-begin) (goto-char end))
  21468. ;; If contents are invisible, skip the element altogether.
  21469. ((outline-invisible-p (line-end-position))
  21470. (case type
  21471. (headline
  21472. (org-with-limited-levels (outline-next-visible-heading 1)))
  21473. ;; At a plain list, make sure we move to the next item
  21474. ;; instead of skipping the whole list.
  21475. (plain-list (forward-char)
  21476. (org-forward-paragraph))
  21477. (otherwise (goto-char end))))
  21478. ((>= (point) contents-end) (goto-char end))
  21479. ((>= (point) contents-begin)
  21480. ;; This can only happen on paragraphs and plain lists.
  21481. (case type
  21482. (paragraph (goto-char end))
  21483. ;; At a plain list, try to move to second element in
  21484. ;; first item, if possible.
  21485. (plain-list (end-of-line)
  21486. (org-forward-paragraph))))
  21487. ;; When contents start on the middle of a line (e.g. in
  21488. ;; items and footnote definitions), try to reach first
  21489. ;; element starting after current line.
  21490. ((> (line-end-position) contents-begin)
  21491. (end-of-line)
  21492. (org-forward-paragraph))
  21493. (t (goto-char contents-begin)))))
  21494. (defun org-backward-paragraph ()
  21495. "Move backward to start of previous paragraph or equivalent.
  21496. The function moves point to the beginning of the current
  21497. structural element, which can be a paragraph, a table, a list
  21498. item, etc., or to the beginning of the previous visible one if
  21499. point is already there. It also provides some special moves for
  21500. convenience:
  21501. - On an affiliated keyword, jump to the first one.
  21502. - On a table or a property drawer, move to its beginning.
  21503. - On a verse or source block, stop before blank lines."
  21504. (interactive)
  21505. (when (bobp) (user-error "Cannot move further up"))
  21506. (let* ((deactivate-mark nil)
  21507. (element (org-element-at-point))
  21508. (type (org-element-type element))
  21509. (contents-begin (org-element-property :contents-begin element))
  21510. (contents-end (org-element-property :contents-end element))
  21511. (post-affiliated (org-element-property :post-affiliated element))
  21512. (begin (org-element-property :begin element)))
  21513. (cond
  21514. ((not element) (goto-char (point-min)))
  21515. ((= (point) begin)
  21516. (backward-char)
  21517. (org-backward-paragraph))
  21518. ((and post-affiliated (<= (point) post-affiliated)) (goto-char begin))
  21519. ((memq type '(node-property table-row))
  21520. (goto-char (org-element-property
  21521. :post-affiliated (org-element-property :parent element))))
  21522. ((memq type '(property-drawer table)) (goto-char begin))
  21523. ((memq type '(src-block verse-block))
  21524. (when (eq type 'src-block)
  21525. (setq contents-begin
  21526. (save-excursion (goto-char begin) (forward-line) (point))))
  21527. (if (= (point) contents-begin) (goto-char post-affiliated)
  21528. ;; Inside a verse block, see blank lines as paragraph
  21529. ;; separators.
  21530. (let ((origin (point)))
  21531. (skip-chars-backward " \r\t\n" contents-begin)
  21532. (when (re-search-backward "^[ \t]*$" contents-begin 'move)
  21533. (skip-chars-forward " \r\t\n" origin)
  21534. (if (= (point) origin) (goto-char contents-begin)
  21535. (beginning-of-line))))))
  21536. ((not contents-begin) (goto-char (or post-affiliated begin)))
  21537. ((eq type 'paragraph)
  21538. (goto-char contents-begin)
  21539. ;; When at first paragraph in an item or a footnote definition,
  21540. ;; move directly to beginning of line.
  21541. (let ((parent-contents
  21542. (org-element-property
  21543. :contents-begin (org-element-property :parent element))))
  21544. (when (and parent-contents (= parent-contents contents-begin))
  21545. (beginning-of-line))))
  21546. ;; At the end of a greater element, move to the beginning of the
  21547. ;; last element within.
  21548. ((>= (point) contents-end)
  21549. (goto-char (1- contents-end))
  21550. (org-backward-paragraph))
  21551. (t (goto-char (or post-affiliated begin))))
  21552. ;; Ensure we never leave point invisible.
  21553. (when (outline-invisible-p (point)) (beginning-of-visual-line))))
  21554. (defun org-forward-element ()
  21555. "Move forward by one element.
  21556. Move to the next element at the same level, when possible."
  21557. (interactive)
  21558. (cond ((eobp) (user-error "Cannot move further down"))
  21559. ((org-with-limited-levels (org-at-heading-p))
  21560. (let ((origin (point)))
  21561. (goto-char (org-end-of-subtree nil t))
  21562. (unless (org-with-limited-levels (org-at-heading-p))
  21563. (goto-char origin)
  21564. (user-error "Cannot move further down"))))
  21565. (t
  21566. (let* ((elem (org-element-at-point))
  21567. (end (org-element-property :end elem))
  21568. (parent (org-element-property :parent elem)))
  21569. (cond ((and parent (= (org-element-property :contents-end parent) end))
  21570. (goto-char (org-element-property :end parent)))
  21571. ((integer-or-marker-p end) (goto-char end))
  21572. (t (message "No element at point")))))))
  21573. (defun org-backward-element ()
  21574. "Move backward by one element.
  21575. Move to the previous element at the same level, when possible."
  21576. (interactive)
  21577. (cond ((bobp) (user-error "Cannot move further up"))
  21578. ((org-with-limited-levels (org-at-heading-p))
  21579. ;; At a headline, move to the previous one, if any, or stay
  21580. ;; here.
  21581. (let ((origin (point)))
  21582. (org-with-limited-levels (org-backward-heading-same-level 1))
  21583. ;; When current headline has no sibling above, move to its
  21584. ;; parent.
  21585. (when (= (point) origin)
  21586. (or (org-with-limited-levels (org-up-heading-safe))
  21587. (progn (goto-char origin)
  21588. (user-error "Cannot move further up"))))))
  21589. (t
  21590. (let* ((trail (org-element-at-point 'keep-trail))
  21591. (elem (car trail))
  21592. (prev-elem (nth 1 trail))
  21593. (beg (org-element-property :begin elem)))
  21594. (cond
  21595. ;; Move to beginning of current element if point isn't
  21596. ;; there already.
  21597. ((null beg) (message "No element at point"))
  21598. ((/= (point) beg) (goto-char beg))
  21599. (prev-elem (goto-char (org-element-property :begin prev-elem)))
  21600. ((org-before-first-heading-p) (goto-char (point-min)))
  21601. (t (org-back-to-heading)))))))
  21602. (defun org-up-element ()
  21603. "Move to upper element."
  21604. (interactive)
  21605. (if (org-with-limited-levels (org-at-heading-p))
  21606. (unless (org-up-heading-safe) (user-error "No surrounding element"))
  21607. (let* ((elem (org-element-at-point))
  21608. (parent (org-element-property :parent elem)))
  21609. (if parent (goto-char (org-element-property :begin parent))
  21610. (if (org-with-limited-levels (org-before-first-heading-p))
  21611. (user-error "No surrounding element")
  21612. (org-with-limited-levels (org-back-to-heading)))))))
  21613. (defvar org-element-greater-elements)
  21614. (defun org-down-element ()
  21615. "Move to inner element."
  21616. (interactive)
  21617. (let ((element (org-element-at-point)))
  21618. (cond
  21619. ((memq (org-element-type element) '(plain-list table))
  21620. (goto-char (org-element-property :contents-begin element))
  21621. (forward-char))
  21622. ((memq (org-element-type element) org-element-greater-elements)
  21623. ;; If contents are hidden, first disclose them.
  21624. (when (outline-invisible-p (line-end-position)) (org-cycle))
  21625. (goto-char (or (org-element-property :contents-begin element)
  21626. (user-error "No content for this element"))))
  21627. (t (user-error "No inner element")))))
  21628. (defun org-drag-element-backward ()
  21629. "Move backward element at point."
  21630. (interactive)
  21631. (if (org-with-limited-levels (org-at-heading-p)) (org-move-subtree-up)
  21632. (let* ((trail (org-element-at-point 'keep-trail))
  21633. (elem (car trail))
  21634. (prev-elem (nth 1 trail)))
  21635. ;; Error out if no previous element or previous element is
  21636. ;; a parent of the current one.
  21637. (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
  21638. (user-error "Cannot drag element backward")
  21639. (let ((pos (point)))
  21640. (org-element-swap-A-B prev-elem elem)
  21641. (goto-char (+ (org-element-property :begin prev-elem)
  21642. (- pos (org-element-property :begin elem)))))))))
  21643. (defun org-drag-element-forward ()
  21644. "Move forward element at point."
  21645. (interactive)
  21646. (let* ((pos (point))
  21647. (elem (org-element-at-point)))
  21648. (when (= (point-max) (org-element-property :end elem))
  21649. (user-error "Cannot drag element forward"))
  21650. (goto-char (org-element-property :end elem))
  21651. (let ((next-elem (org-element-at-point)))
  21652. (when (or (org-element-nested-p elem next-elem)
  21653. (and (eq (org-element-type next-elem) 'headline)
  21654. (not (eq (org-element-type elem) 'headline))))
  21655. (goto-char pos)
  21656. (user-error "Cannot drag element forward"))
  21657. ;; Compute new position of point: it's shifted by NEXT-ELEM
  21658. ;; body's length (without final blanks) and by the length of
  21659. ;; blanks between ELEM and NEXT-ELEM.
  21660. (let ((size-next (- (save-excursion
  21661. (goto-char (org-element-property :end next-elem))
  21662. (skip-chars-backward " \r\t\n")
  21663. (forward-line)
  21664. ;; Small correction if buffer doesn't end
  21665. ;; with a newline character.
  21666. (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
  21667. (org-element-property :begin next-elem)))
  21668. (size-blank (- (org-element-property :end elem)
  21669. (save-excursion
  21670. (goto-char (org-element-property :end elem))
  21671. (skip-chars-backward " \r\t\n")
  21672. (forward-line)
  21673. (point)))))
  21674. (org-element-swap-A-B elem next-elem)
  21675. (goto-char (+ pos size-next size-blank))))))
  21676. (defun org-drag-line-forward (arg)
  21677. "Drag the line at point ARG lines forward."
  21678. (interactive "p")
  21679. (dotimes (n (abs arg))
  21680. (let ((c (current-column)))
  21681. (if (< 0 arg)
  21682. (progn
  21683. (beginning-of-line 2)
  21684. (transpose-lines 1)
  21685. (beginning-of-line 0))
  21686. (transpose-lines 1)
  21687. (beginning-of-line -1))
  21688. (org-move-to-column c))))
  21689. (defun org-drag-line-backward (arg)
  21690. "Drag the line at point ARG lines backward."
  21691. (interactive "p")
  21692. (org-drag-line-forward (- arg)))
  21693. (defun org-mark-element ()
  21694. "Put point at beginning of this element, mark at end.
  21695. Interactively, if this command is repeated or (in Transient Mark
  21696. mode) if the mark is active, it marks the next element after the
  21697. ones already marked."
  21698. (interactive)
  21699. (let (deactivate-mark)
  21700. (if (and (org-called-interactively-p 'any)
  21701. (or (and (eq last-command this-command) (mark t))
  21702. (and transient-mark-mode mark-active)))
  21703. (set-mark
  21704. (save-excursion
  21705. (goto-char (mark))
  21706. (goto-char (org-element-property :end (org-element-at-point)))))
  21707. (let ((element (org-element-at-point)))
  21708. (end-of-line)
  21709. (push-mark (org-element-property :end element) t t)
  21710. (goto-char (org-element-property :begin element))))))
  21711. (defun org-narrow-to-element ()
  21712. "Narrow buffer to current element."
  21713. (interactive)
  21714. (let ((elem (org-element-at-point)))
  21715. (cond
  21716. ((eq (car elem) 'headline)
  21717. (narrow-to-region
  21718. (org-element-property :begin elem)
  21719. (org-element-property :end elem)))
  21720. ((memq (car elem) org-element-greater-elements)
  21721. (narrow-to-region
  21722. (org-element-property :contents-begin elem)
  21723. (org-element-property :contents-end elem)))
  21724. (t
  21725. (narrow-to-region
  21726. (org-element-property :begin elem)
  21727. (org-element-property :end elem))))))
  21728. (defun org-transpose-element ()
  21729. "Transpose current and previous elements, keeping blank lines between.
  21730. Point is moved after both elements."
  21731. (interactive)
  21732. (org-skip-whitespace)
  21733. (let ((end (org-element-property :end (org-element-at-point))))
  21734. (org-drag-element-backward)
  21735. (goto-char end)))
  21736. (defun org-unindent-buffer ()
  21737. "Un-indent the visible part of the buffer.
  21738. Relative indentation (between items, inside blocks, etc.) isn't
  21739. modified."
  21740. (interactive)
  21741. (unless (eq major-mode 'org-mode)
  21742. (user-error "Cannot un-indent a buffer not in Org mode"))
  21743. (let* ((parse-tree (org-element-parse-buffer 'greater-element))
  21744. unindent-tree ; For byte-compiler.
  21745. (unindent-tree
  21746. (function
  21747. (lambda (contents)
  21748. (mapc
  21749. (lambda (element)
  21750. (if (memq (org-element-type element) '(headline section))
  21751. (funcall unindent-tree (org-element-contents element))
  21752. (save-excursion
  21753. (save-restriction
  21754. (narrow-to-region
  21755. (org-element-property :begin element)
  21756. (org-element-property :end element))
  21757. (org-do-remove-indentation)))))
  21758. (reverse contents))))))
  21759. (funcall unindent-tree (org-element-contents parse-tree))))
  21760. (defun org-show-subtree ()
  21761. "Show everything after this heading at deeper levels."
  21762. (interactive)
  21763. (outline-flag-region
  21764. (point)
  21765. (save-excursion
  21766. (org-end-of-subtree t t))
  21767. nil))
  21768. (defun org-show-entry ()
  21769. "Show the body directly following this heading.
  21770. Show the heading too, if it is currently invisible."
  21771. (interactive)
  21772. (save-excursion
  21773. (condition-case nil
  21774. (progn
  21775. (org-back-to-heading t)
  21776. (outline-flag-region
  21777. (max (point-min) (1- (point)))
  21778. (save-excursion
  21779. (if (re-search-forward
  21780. (concat "[\r\n]\\(" org-outline-regexp "\\)") nil t)
  21781. (match-beginning 1)
  21782. (point-max)))
  21783. nil)
  21784. (org-cycle-hide-drawers 'children))
  21785. (error nil))))
  21786. (defun org-make-options-regexp (kwds &optional extra)
  21787. "Make a regular expression for keyword lines."
  21788. (concat
  21789. "^#\\+\\("
  21790. (mapconcat 'regexp-quote kwds "\\|")
  21791. (if extra (concat "\\|" extra))
  21792. "\\):[ \t]*\\(.*\\)"))
  21793. ;; Make isearch reveal the necessary context
  21794. (defun org-isearch-end ()
  21795. "Reveal context after isearch exits."
  21796. (when isearch-success ; only if search was successful
  21797. (if (featurep 'xemacs)
  21798. ;; Under XEmacs, the hook is run in the correct place,
  21799. ;; we directly show the context.
  21800. (org-show-context 'isearch)
  21801. ;; In Emacs the hook runs *before* restoring the overlays.
  21802. ;; So we have to use a one-time post-command-hook to do this.
  21803. ;; (Emacs 22 has a special variable, see function `org-mode')
  21804. (unless (and (boundp 'isearch-mode-end-hook-quit)
  21805. isearch-mode-end-hook-quit)
  21806. ;; Only when the isearch was not quitted.
  21807. (org-add-hook 'post-command-hook 'org-isearch-post-command
  21808. 'append 'local)))
  21809. (org-fix-ellipsis-at-bol)))
  21810. (defun org-isearch-post-command ()
  21811. "Remove self from hook, and show context."
  21812. (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
  21813. (org-show-context 'isearch))
  21814. ;;;; Integration with and fixes for other packages
  21815. ;;; Imenu support
  21816. (defvar org-imenu-markers nil
  21817. "All markers currently used by Imenu.")
  21818. (make-variable-buffer-local 'org-imenu-markers)
  21819. (defun org-imenu-new-marker (&optional pos)
  21820. "Return a new marker for use by Imenu, and remember the marker."
  21821. (let ((m (make-marker)))
  21822. (move-marker m (or pos (point)))
  21823. (push m org-imenu-markers)
  21824. m))
  21825. (defun org-imenu-get-tree ()
  21826. "Produce the index for Imenu."
  21827. (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
  21828. (setq org-imenu-markers nil)
  21829. (let* ((n org-imenu-depth)
  21830. (re (concat "^" (org-get-limited-outline-regexp)))
  21831. (subs (make-vector (1+ n) nil))
  21832. (last-level 0)
  21833. m level head0 head)
  21834. (save-excursion
  21835. (save-restriction
  21836. (widen)
  21837. (goto-char (point-max))
  21838. (while (re-search-backward re nil t)
  21839. (setq level (org-reduced-level (funcall outline-level)))
  21840. (when (and (<= level n)
  21841. (looking-at org-complex-heading-regexp)
  21842. (setq head0 (org-match-string-no-properties 4)))
  21843. (setq head (org-link-display-format head0)
  21844. m (org-imenu-new-marker))
  21845. (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
  21846. (if (>= level last-level)
  21847. (push (cons head m) (aref subs level))
  21848. (push (cons head (aref subs (1+ level))) (aref subs level))
  21849. (loop for i from (1+ level) to n do (aset subs i nil)))
  21850. (setq last-level level)))))
  21851. (aref subs 1)))
  21852. (eval-after-load "imenu"
  21853. '(progn
  21854. (add-hook 'imenu-after-jump-hook
  21855. (lambda ()
  21856. (if (derived-mode-p 'org-mode)
  21857. (org-show-context 'org-goto))))))
  21858. (defun org-link-display-format (link)
  21859. "Replace a link with its the description.
  21860. If there is no description, use the link target."
  21861. (save-match-data
  21862. (if (string-match org-bracket-link-analytic-regexp link)
  21863. (replace-match (if (match-end 5)
  21864. (match-string 5 link)
  21865. (concat (match-string 1 link)
  21866. (match-string 3 link)))
  21867. nil t link)
  21868. link)))
  21869. (defun org-toggle-link-display ()
  21870. "Toggle the literal or descriptive display of links."
  21871. (interactive)
  21872. (if org-descriptive-links
  21873. (progn (org-remove-from-invisibility-spec '(org-link))
  21874. (org-restart-font-lock)
  21875. (setq org-descriptive-links nil))
  21876. (progn (add-to-invisibility-spec '(org-link))
  21877. (org-restart-font-lock)
  21878. (setq org-descriptive-links t))))
  21879. ;; Speedbar support
  21880. (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
  21881. "Overlay marking the agenda restriction line in speedbar.")
  21882. (overlay-put org-speedbar-restriction-lock-overlay
  21883. 'face 'org-agenda-restriction-lock)
  21884. (overlay-put org-speedbar-restriction-lock-overlay
  21885. 'help-echo "Agendas are currently limited to this item.")
  21886. (org-detach-overlay org-speedbar-restriction-lock-overlay)
  21887. (defun org-speedbar-set-agenda-restriction ()
  21888. "Restrict future agenda commands to the location at point in speedbar.
  21889. To get rid of the restriction, use \\[org-agenda-remove-restriction-lock]."
  21890. (interactive)
  21891. (require 'org-agenda)
  21892. (let (p m tp np dir txt)
  21893. (cond
  21894. ((setq p (text-property-any (point-at-bol) (point-at-eol)
  21895. 'org-imenu t))
  21896. (setq m (get-text-property p 'org-imenu-marker))
  21897. (with-current-buffer (marker-buffer m)
  21898. (goto-char m)
  21899. (org-agenda-set-restriction-lock 'subtree)))
  21900. ((setq p (text-property-any (point-at-bol) (point-at-eol)
  21901. 'speedbar-function 'speedbar-find-file))
  21902. (setq tp (previous-single-property-change
  21903. (1+ p) 'speedbar-function)
  21904. np (next-single-property-change
  21905. tp 'speedbar-function)
  21906. dir (speedbar-line-directory)
  21907. txt (buffer-substring-no-properties (or tp (point-min))
  21908. (or np (point-max))))
  21909. (with-current-buffer (find-file-noselect
  21910. (let ((default-directory dir))
  21911. (expand-file-name txt)))
  21912. (unless (derived-mode-p 'org-mode)
  21913. (user-error "Cannot restrict to non-Org-mode file"))
  21914. (org-agenda-set-restriction-lock 'file)))
  21915. (t (user-error "Don't know how to restrict Org-mode's agenda")))
  21916. (move-overlay org-speedbar-restriction-lock-overlay
  21917. (point-at-bol) (point-at-eol))
  21918. (setq current-prefix-arg nil)
  21919. (org-agenda-maybe-redo)))
  21920. (defvar speedbar-file-key-map)
  21921. (declare-function speedbar-add-supported-extension "speedbar" (extension))
  21922. (eval-after-load "speedbar"
  21923. '(progn
  21924. (speedbar-add-supported-extension ".org")
  21925. (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
  21926. (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
  21927. (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
  21928. (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
  21929. (add-hook 'speedbar-visiting-tag-hook
  21930. (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
  21931. ;;; Fixes and Hacks for problems with other packages
  21932. ;; Make flyspell not check words in links, to not mess up our keymap
  21933. (defvar org-element-affiliated-keywords) ; From org-element.el
  21934. (defvar org-element-block-name-alist) ; From org-element.el
  21935. (defun org-mode-flyspell-verify ()
  21936. "Don't let flyspell put overlays at active buttons, or on
  21937. {todo,all-time,additional-option-like}-keywords."
  21938. (require 'org-element) ; For `org-element-affiliated-keywords'
  21939. (let ((pos (max (1- (point)) (point-min)))
  21940. (word (thing-at-point 'word)))
  21941. (and (not (get-text-property pos 'keymap))
  21942. (not (get-text-property pos 'org-no-flyspell))
  21943. (not (member word org-todo-keywords-1))
  21944. (not (member word org-all-time-keywords))
  21945. (not (member word org-options-keywords))
  21946. (not (member word (mapcar 'car org-startup-options)))
  21947. (not (member-ignore-case word org-element-affiliated-keywords))
  21948. (not (member-ignore-case word (org-get-export-keywords)))
  21949. (not (member-ignore-case
  21950. word (mapcar 'car org-element-block-name-alist)))
  21951. (not (member-ignore-case word '("BEGIN" "END" "ATTR")))
  21952. (not (org-in-src-block-p)))))
  21953. (defun org-remove-flyspell-overlays-in (beg end)
  21954. "Remove flyspell overlays in region."
  21955. (and (org-bound-and-true-p flyspell-mode)
  21956. (fboundp 'flyspell-delete-region-overlays)
  21957. (flyspell-delete-region-overlays beg end))
  21958. (add-text-properties beg end '(org-no-flyspell t)))
  21959. ;; Make `bookmark-jump' shows the jump location if it was hidden.
  21960. (eval-after-load "bookmark"
  21961. '(if (boundp 'bookmark-after-jump-hook)
  21962. ;; We can use the hook
  21963. (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
  21964. ;; Hook not available, use advice
  21965. (defadvice bookmark-jump (after org-make-visible activate)
  21966. "Make the position visible."
  21967. (org-bookmark-jump-unhide))))
  21968. ;; Make sure saveplace shows the location if it was hidden
  21969. (eval-after-load "saveplace"
  21970. '(defadvice save-place-find-file-hook (after org-make-visible activate)
  21971. "Make the position visible."
  21972. (org-bookmark-jump-unhide)))
  21973. ;; Make sure ecb shows the location if it was hidden
  21974. (eval-after-load "ecb"
  21975. '(defadvice ecb-method-clicked (after esf/org-show-context activate)
  21976. "Make hierarchy visible when jumping into location from ECB tree buffer."
  21977. (if (derived-mode-p 'org-mode)
  21978. (org-show-context))))
  21979. (defun org-bookmark-jump-unhide ()
  21980. "Unhide the current position, to show the bookmark location."
  21981. (and (derived-mode-p 'org-mode)
  21982. (or (outline-invisible-p)
  21983. (save-excursion (goto-char (max (point-min) (1- (point))))
  21984. (outline-invisible-p)))
  21985. (org-show-context 'bookmark-jump)))
  21986. ;; Make session.el ignore our circular variable
  21987. (defvar session-globals-exclude)
  21988. (eval-after-load "session"
  21989. '(add-to-list 'session-globals-exclude 'org-mark-ring))
  21990. ;;;; Finish up
  21991. (provide 'org)
  21992. (run-hooks 'org-load-hook)
  21993. ;;; org.el ends here