org.el 544 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589125901259112592125931259412595125961259712598125991260012601126021260312604126051260612607126081260912610126111261212613126141261512616126171261812619126201262112622126231262412625126261262712628126291263012631126321263312634126351263612637126381263912640126411264212643126441264512646126471264812649126501265112652126531265412655126561265712658126591266012661126621266312664126651266612667126681266912670126711267212673126741267512676126771267812679126801268112682126831268412685126861268712688126891269012691126921269312694126951269612697126981269912700127011270212703127041270512706127071270812709127101271112712127131271412715127161271712718127191272012721127221272312724127251272612727127281272912730127311273212733127341273512736127371273812739127401274112742127431274412745127461274712748127491275012751127521275312754127551275612757127581275912760127611276212763127641276512766127671276812769127701277112772127731277412775127761277712778127791278012781127821278312784127851278612787127881278912790127911279212793127941279512796127971279812799128001280112802128031280412805128061280712808128091281012811128121281312814128151281612817128181281912820128211282212823128241282512826128271282812829128301283112832128331283412835128361283712838128391284012841128421284312844128451284612847128481284912850128511285212853128541285512856128571285812859128601286112862128631286412865128661286712868128691287012871128721287312874128751287612877128781287912880128811288212883128841288512886128871288812889128901289112892128931289412895128961289712898128991290012901129021290312904129051290612907129081290912910129111291212913129141291512916129171291812919129201292112922129231292412925129261292712928129291293012931129321293312934129351293612937129381293912940129411294212943129441294512946129471294812949129501295112952129531295412955129561295712958129591296012961129621296312964129651296612967129681296912970129711297212973129741297512976129771297812979129801298112982129831298412985129861298712988129891299012991129921299312994129951299612997129981299913000130011300213003130041300513006130071300813009130101301113012130131301413015130161301713018130191302013021130221302313024130251302613027130281302913030130311303213033130341303513036130371303813039130401304113042130431304413045130461304713048130491305013051130521305313054130551305613057130581305913060130611306213063130641306513066130671306813069130701307113072130731307413075130761307713078130791308013081130821308313084130851308613087130881308913090130911309213093130941309513096130971309813099131001310113102131031310413105131061310713108131091311013111131121311313114131151311613117131181311913120131211312213123131241312513126131271312813129131301313113132131331313413135131361313713138131391314013141131421314313144131451314613147131481314913150131511315213153131541315513156131571315813159131601316113162131631316413165131661316713168131691317013171131721317313174131751317613177131781317913180131811318213183131841318513186131871318813189131901319113192131931319413195131961319713198131991320013201132021320313204132051320613207132081320913210132111321213213132141321513216132171321813219132201322113222132231322413225132261322713228132291323013231132321323313234132351323613237132381323913240132411324213243132441324513246132471324813249132501325113252132531325413255132561325713258132591326013261132621326313264132651326613267132681326913270132711327213273132741327513276132771327813279132801328113282132831328413285132861328713288132891329013291132921329313294132951329613297132981329913300133011330213303133041330513306133071330813309133101331113312133131331413315133161331713318133191332013321133221332313324133251332613327133281332913330133311333213333133341333513336133371333813339133401334113342133431334413345133461334713348133491335013351133521335313354133551335613357133581335913360133611336213363133641336513366133671336813369133701337113372133731337413375133761337713378133791338013381133821338313384133851338613387133881338913390133911339213393133941339513396133971339813399134001340113402134031340413405134061340713408134091341013411134121341313414134151341613417134181341913420134211342213423134241342513426134271342813429134301343113432134331343413435134361343713438134391344013441134421344313444134451344613447134481344913450134511345213453134541345513456134571345813459134601346113462134631346413465134661346713468134691347013471134721347313474134751347613477134781347913480134811348213483134841348513486134871348813489134901349113492134931349413495134961349713498134991350013501135021350313504135051350613507135081350913510135111351213513135141351513516135171351813519135201352113522135231352413525135261352713528135291353013531135321353313534135351353613537135381353913540135411354213543135441354513546135471354813549135501355113552135531355413555135561355713558135591356013561135621356313564135651356613567135681356913570135711357213573135741357513576135771357813579135801358113582135831358413585135861358713588135891359013591135921359313594135951359613597135981359913600136011360213603136041360513606136071360813609136101361113612136131361413615136161361713618136191362013621136221362313624136251362613627136281362913630136311363213633136341363513636136371363813639136401364113642136431364413645136461364713648136491365013651136521365313654136551365613657136581365913660136611366213663136641366513666136671366813669136701367113672136731367413675136761367713678136791368013681136821368313684136851368613687136881368913690136911369213693136941369513696136971369813699137001370113702137031370413705137061370713708137091371013711137121371313714137151371613717137181371913720137211372213723137241372513726137271372813729137301373113732137331373413735137361373713738137391374013741137421374313744137451374613747137481374913750137511375213753137541375513756137571375813759137601376113762137631376413765137661376713768137691377013771137721377313774137751377613777137781377913780137811378213783137841378513786137871378813789137901379113792137931379413795137961379713798137991380013801138021380313804138051380613807138081380913810138111381213813138141381513816138171381813819138201382113822138231382413825138261382713828138291383013831138321383313834138351383613837138381383913840138411384213843138441384513846138471384813849138501385113852138531385413855138561385713858138591386013861138621386313864138651386613867138681386913870138711387213873138741387513876138771387813879138801388113882138831388413885138861388713888138891389013891138921389313894138951389613897138981389913900139011390213903139041390513906139071390813909139101391113912139131391413915139161391713918139191392013921139221392313924139251392613927139281392913930139311393213933139341393513936139371393813939139401394113942139431394413945139461394713948139491395013951139521395313954139551395613957139581395913960139611396213963139641396513966139671396813969139701397113972139731397413975139761397713978139791398013981139821398313984139851398613987139881398913990139911399213993139941399513996139971399813999140001400114002140031400414005140061400714008140091401014011140121401314014140151401614017140181401914020140211402214023140241402514026140271402814029140301403114032140331403414035140361403714038140391404014041140421404314044140451404614047140481404914050140511405214053140541405514056140571405814059140601406114062140631406414065140661406714068140691407014071140721407314074140751407614077140781407914080140811408214083140841408514086140871408814089140901409114092140931409414095140961409714098140991410014101141021410314104141051410614107141081410914110141111411214113141141411514116141171411814119141201412114122141231412414125141261412714128141291413014131141321413314134141351413614137141381413914140141411414214143141441414514146141471414814149141501415114152141531415414155141561415714158141591416014161141621416314164141651416614167141681416914170141711417214173141741417514176141771417814179141801418114182141831418414185141861418714188141891419014191141921419314194141951419614197141981419914200142011420214203142041420514206142071420814209142101421114212142131421414215142161421714218142191422014221142221422314224142251422614227142281422914230142311423214233142341423514236142371423814239142401424114242142431424414245142461424714248142491425014251142521425314254142551425614257142581425914260142611426214263142641426514266142671426814269142701427114272142731427414275142761427714278142791428014281142821428314284142851428614287142881428914290142911429214293142941429514296142971429814299143001430114302143031430414305143061430714308143091431014311143121431314314143151431614317143181431914320143211432214323143241432514326143271432814329143301433114332143331433414335143361433714338143391434014341143421434314344143451434614347143481434914350143511435214353143541435514356143571435814359143601436114362143631436414365143661436714368143691437014371143721437314374143751437614377143781437914380143811438214383143841438514386143871438814389143901439114392143931439414395143961439714398143991440014401144021440314404144051440614407144081440914410144111441214413144141441514416144171441814419144201442114422144231442414425144261442714428144291443014431144321443314434144351443614437144381443914440144411444214443144441444514446144471444814449144501445114452144531445414455144561445714458144591446014461144621446314464144651446614467144681446914470144711447214473144741447514476144771447814479144801448114482144831448414485144861448714488144891449014491144921449314494144951449614497144981449914500145011450214503145041450514506145071450814509145101451114512145131451414515145161451714518145191452014521145221452314524145251452614527145281452914530145311453214533145341453514536145371453814539145401454114542145431454414545145461454714548145491455014551145521455314554145551455614557145581455914560145611456214563145641456514566145671456814569145701457114572145731457414575145761457714578145791458014581145821458314584145851458614587145881458914590145911459214593145941459514596145971459814599146001460114602146031460414605146061460714608146091461014611146121461314614146151461614617146181461914620146211462214623146241462514626146271462814629146301463114632146331463414635146361463714638146391464014641146421464314644146451464614647146481464914650146511465214653146541465514656146571465814659146601466114662146631466414665146661466714668146691467014671146721467314674146751467614677146781467914680146811468214683146841468514686146871468814689146901469114692146931469414695146961469714698146991470014701147021470314704147051470614707147081470914710147111471214713147141471514716147171471814719147201472114722147231472414725147261472714728147291473014731147321473314734147351473614737147381473914740147411474214743147441474514746147471474814749147501475114752147531475414755147561475714758147591476014761147621476314764147651476614767147681476914770147711477214773147741477514776147771477814779147801478114782147831478414785147861478714788147891479014791147921479314794147951479614797147981479914800148011480214803148041480514806148071480814809148101481114812
  1. ;;; org.el --- Outline-based notes management and organizer
  2. ;; Carstens outline-mode for keeping track of everything.
  3. ;; Copyright (C) 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
  4. ;;
  5. ;; Author: Carsten Dominik <carsten at orgmode dot org>
  6. ;; Keywords: outlines, hypermedia, calendar, wp
  7. ;; Homepage: http://orgmode.org
  8. ;; Version: 6.08-pre01
  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. ;;
  24. ;;; Commentary:
  25. ;;
  26. ;; Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
  27. ;; project planning with a fast and effective plain-text system.
  28. ;;
  29. ;; Org-mode develops organizational tasks around NOTES files that contain
  30. ;; information about projects as plain text. Org-mode is implemented on
  31. ;; top of outline-mode, which makes it possible to keep the content of
  32. ;; large files well structured. Visibility cycling and structure editing
  33. ;; help to work with the tree. Tables are easily created with a built-in
  34. ;; table editor. Org-mode supports ToDo items, deadlines, time stamps,
  35. ;; and scheduling. It dynamically compiles entries into an agenda that
  36. ;; utilizes and smoothly integrates much of the Emacs calendar and diary.
  37. ;; Plain text URL-like links connect to websites, emails, Usenet
  38. ;; messages, BBDB entries, and any files related to the projects. For
  39. ;; printing and sharing of notes, an Org-mode file can be exported as a
  40. ;; structured ASCII file, as HTML, or (todo and agenda items only) as an
  41. ;; iCalendar file. It can also serve as a publishing tool for a set of
  42. ;; linked webpages.
  43. ;;
  44. ;; Installation and Activation
  45. ;; ---------------------------
  46. ;; See the corresponding sections in the manual at
  47. ;;
  48. ;; http://orgmode.org/org.html#Installation
  49. ;;
  50. ;; Documentation
  51. ;; -------------
  52. ;; The documentation of Org-mode can be found in the TeXInfo file. The
  53. ;; distribution also contains a PDF version of it. At the homepage of
  54. ;; Org-mode, you can read the same text online as HTML. There is also an
  55. ;; excellent reference card made by Philip Rooke. This card can be found
  56. ;; in the etc/ directory of Emacs 22.
  57. ;;
  58. ;; A list of recent changes can be found at
  59. ;; http://orgmode.org/Changes.html
  60. ;;
  61. ;;; Code:
  62. (defvar org-inhibit-highlight-removal nil) ; dynamically scoped param
  63. (defvar org-table-formula-constants-local nil
  64. "Local version of `org-table-formula-constants'.")
  65. (make-variable-buffer-local 'org-table-formula-constants-local)
  66. ;;;; Require other packages
  67. (eval-when-compile
  68. (require 'cl)
  69. (require 'gnus-sum)
  70. (require 'calendar))
  71. ;; For XEmacs, noutline is not yet provided by outline.el, so arrange for
  72. ;; the file noutline.el being loaded.
  73. (if (featurep 'xemacs) (condition-case nil (require 'noutline)))
  74. ;; We require noutline, which might be provided in outline.el
  75. (require 'outline) (require 'noutline)
  76. ;; Other stuff we need.
  77. (require 'time-date)
  78. (unless (fboundp 'time-subtract) (defalias 'time-subtract 'subtract-time))
  79. (require 'easymenu)
  80. (require 'org-macs)
  81. (require 'org-compat)
  82. (require 'org-faces)
  83. ;;;; Customization variables
  84. ;;; Version
  85. (defconst org-version "6.08-pre01"
  86. "The version number of the file org.el.")
  87. (defun org-version (&optional here)
  88. "Show the org-mode version in the echo area.
  89. With prefix arg HERE, insert it at point."
  90. (interactive "P")
  91. (let ((version (format "Org-mode version %s" org-version)))
  92. (message version)
  93. (if here
  94. (insert version))))
  95. ;;; Compatibility constants
  96. ;;; The custom variables
  97. (defgroup org nil
  98. "Outline-based notes management and organizer."
  99. :tag "Org"
  100. :group 'outlines
  101. :group 'hypermedia
  102. :group 'calendar)
  103. (defcustom org-load-hook nil
  104. "Hook that is run after org.el has been loaded."
  105. :group 'org
  106. :type 'hook)
  107. (defvar org-modules) ; defined below
  108. (defvar org-modules-loaded nil
  109. "Have the modules been loaded already?")
  110. (defun org-load-modules-maybe (&optional force)
  111. "Load all extensions listed in `org-default-extensions'."
  112. (when (or force (not org-modules-loaded))
  113. (mapc (lambda (ext)
  114. (condition-case nil (require ext)
  115. (error (message "Problems while trying to load feature `%s'" ext))))
  116. org-modules)
  117. (setq org-modules-loaded t)))
  118. (defun org-set-modules (var value)
  119. "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
  120. (set var value)
  121. (when (featurep 'org)
  122. (org-load-modules-maybe 'force)))
  123. (when (org-bound-and-true-p org-modules)
  124. (let ((a (member 'org-infojs org-modules)))
  125. (and a (setcar a 'org-jsinfo))))
  126. (defcustom org-modules '(org-bbdb org-bibtex org-gnus org-info org-jsinfo org-irc org-mew org-mhe org-rmail org-vm org-wl)
  127. "Modules that should always be loaded together with org.el.
  128. If a description starts with <C>, the file is not part of Emacs
  129. and loading it will require that you have downloaded and properly installed
  130. the org-mode distribution.
  131. You can also use this system to load external packages (i.e. neither Org
  132. core modules, not modules from the CONTRIB directory). Just add symbols
  133. to the end of the list. If the package is called org-xyz.el, then you need
  134. to add the symbol `xyz', and the package must have a call to
  135. (provide 'org-xyz)"
  136. :group 'org
  137. :set 'org-set-modules
  138. :type
  139. '(set :greedy t
  140. (const :tag " bbdb: Links to BBDB entries" org-bbdb)
  141. (const :tag " bibtex: Links to BibTeX entries" org-bibtex)
  142. (const :tag " gnus: Links to GNUS folders/messages" org-gnus)
  143. (const :tag " id: Global id's for identifying entries" org-id)
  144. (const :tag " info: Links to Info nodes" org-info)
  145. (const :tag " jsinfo: Set up Sebastian Rose's JavaScript org-info.js" org-jsinfo)
  146. (const :tag " irc: Links to IRC/ERC chat sessions" org-irc)
  147. (const :tag " mac-message: Links to messages in Apple Mail" org-mac-message)
  148. (const :tag " mew Links to Mew folders/messages" org-mew)
  149. (const :tag " mhe: Links to MHE folders/messages" org-mhe)
  150. (const :tag " rmail: Links to RMAIL folders/messages" org-rmail)
  151. (const :tag " vm: Links to VM folders/messages" org-vm)
  152. (const :tag " wl: Links to Wanderlust folders/messages" org-wl)
  153. (const :tag " mouse: Additional mouse support" org-mouse)
  154. (const :tag "C annotate-file: Annotate a file with org syntax" org-annotate-file)
  155. (const :tag "C annotation-helper: Call Remeber directly from Browser" org-annotation-helper)
  156. (const :tag "C bookmark: Org links to bookmarks" org-bookmark)
  157. (const :tag "C depend: TODO dependencies for Org-mode" org-depend)
  158. (const :tag "C elisp-symbol: Org links to emacs-lisp symbols" org-elisp-symbol)
  159. (const :tag "C eval: Include command output as text" org-eval)
  160. (const :tag "C expiry: Expiry mechanism for Org entries" org-expiry)
  161. (const :tag "C id: Global id's for identifying entries" org-id)
  162. (const :tag "C interactive-query: Interactive modification of tags query" org-interactive-query)
  163. (const :tag "C mairix: Hook mairix search into Org for different MUAs" org-mairix)
  164. (const :tag "C man: Support for links to manpages in Org-mode" org-man)
  165. (const :tag "C mtags: Support for muse-like tags" org-mtags)
  166. (const :tag "C panel: Simple routines for us with bad memory" org-panel)
  167. (const :tag "C registry: A registry for Org links" org-registry)
  168. (const :tag "C org2rem: Convert org appointments into reminders" org2rem)
  169. (const :tag "C screen: Visit screen sessions through Org-mode links" org-screen)
  170. (const :tag "C toc: Table of contents for Org-mode buffer" org-toc)
  171. (const :tag "C sqlinsert: Convert Org-mode tables to SQL insertions" orgtbl-sqlinsert)
  172. (repeat :tag "External packages" :inline t (symbol :tag "Package"))))
  173. (defgroup org-startup nil
  174. "Options concerning startup of Org-mode."
  175. :tag "Org Startup"
  176. :group 'org)
  177. (defcustom org-startup-folded t
  178. "Non-nil means, entering Org-mode will switch to OVERVIEW.
  179. This can also be configured on a per-file basis by adding one of
  180. the following lines anywhere in the buffer:
  181. #+STARTUP: fold
  182. #+STARTUP: nofold
  183. #+STARTUP: content"
  184. :group 'org-startup
  185. :type '(choice
  186. (const :tag "nofold: show all" nil)
  187. (const :tag "fold: overview" t)
  188. (const :tag "content: all headlines" content)))
  189. (defcustom org-startup-truncated t
  190. "Non-nil means, entering Org-mode will set `truncate-lines'.
  191. This is useful since some lines containing links can be very long and
  192. uninteresting. Also tables look terrible when wrapped."
  193. :group 'org-startup
  194. :type 'boolean)
  195. (defcustom org-startup-align-all-tables nil
  196. "Non-nil means, align all tables when visiting a file.
  197. This is useful when the column width in tables is forced with <N> cookies
  198. in table fields. Such tables will look correct only after the first re-align.
  199. This can also be configured on a per-file basis by adding one of
  200. the following lines anywhere in the buffer:
  201. #+STARTUP: align
  202. #+STARTUP: noalign"
  203. :group 'org-startup
  204. :type 'boolean)
  205. (defcustom org-insert-mode-line-in-empty-file nil
  206. "Non-nil means insert the first line setting Org-mode in empty files.
  207. When the function `org-mode' is called interactively in an empty file, this
  208. normally means that the file name does not automatically trigger Org-mode.
  209. To ensure that the file will always be in Org-mode in the future, a
  210. line enforcing Org-mode will be inserted into the buffer, if this option
  211. has been set."
  212. :group 'org-startup
  213. :type 'boolean)
  214. (defcustom org-replace-disputed-keys nil
  215. "Non-nil means use alternative key bindings for some keys.
  216. Org-mode uses S-<cursor> keys for changing timestamps and priorities.
  217. These keys are also used by other packages like `CUA-mode' or `windmove.el'.
  218. If you want to use Org-mode together with one of these other modes,
  219. or more generally if you would like to move some Org-mode commands to
  220. other keys, set this variable and configure the keys with the variable
  221. `org-disputed-keys'.
  222. This option is only relevant at load-time of Org-mode, and must be set
  223. *before* org.el is loaded. Changing it requires a restart of Emacs to
  224. become effective."
  225. :group 'org-startup
  226. :type 'boolean)
  227. (defcustom org-use-extra-keys nil
  228. "Non-nil means use extra key sequence definitions for certain
  229. commands. This happens automatically if you run XEmacs or if
  230. window-system is nil. This variable lets you do the same
  231. manually. You must set it before loading org.
  232. Example: on Carbon Emacs 22 running graphically, with an external
  233. keyboard on a Powerbook, the default way of setting M-left might
  234. not work for either Alt or ESC. Setting this variable will make
  235. it work for ESC."
  236. :group 'org-startup
  237. :type 'boolean)
  238. (if (fboundp 'defvaralias)
  239. (defvaralias 'org-CUA-compatible 'org-replace-disputed-keys))
  240. (defcustom org-disputed-keys
  241. '(([(shift up)] . [(meta p)])
  242. ([(shift down)] . [(meta n)])
  243. ([(shift left)] . [(meta -)])
  244. ([(shift right)] . [(meta +)])
  245. ([(control shift right)] . [(meta shift +)])
  246. ([(control shift left)] . [(meta shift -)]))
  247. "Keys for which Org-mode and other modes compete.
  248. This is an alist, cars are the default keys, second element specifies
  249. the alternative to use when `org-replace-disputed-keys' is t.
  250. Keys can be specified in any syntax supported by `define-key'.
  251. The value of this option takes effect only at Org-mode's startup,
  252. therefore you'll have to restart Emacs to apply it after changing."
  253. :group 'org-startup
  254. :type 'alist)
  255. (defun org-key (key)
  256. "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
  257. Or return the original if not disputed."
  258. (if org-replace-disputed-keys
  259. (let* ((nkey (key-description key))
  260. (x (org-find-if (lambda (x)
  261. (equal (key-description (car x)) nkey))
  262. org-disputed-keys)))
  263. (if x (cdr x) key))
  264. key))
  265. (defun org-find-if (predicate seq)
  266. (catch 'exit
  267. (while seq
  268. (if (funcall predicate (car seq))
  269. (throw 'exit (car seq))
  270. (pop seq)))))
  271. (defun org-defkey (keymap key def)
  272. "Define a key, possibly translated, as returned by `org-key'."
  273. (define-key keymap (org-key key) def))
  274. (defcustom org-ellipsis nil
  275. "The ellipsis to use in the Org-mode outline.
  276. When nil, just use the standard three dots. When a string, use that instead,
  277. When a face, use the standart 3 dots, but with the specified face.
  278. The change affects only Org-mode (which will then use its own display table).
  279. Changing this requires executing `M-x org-mode' in a buffer to become
  280. effective."
  281. :group 'org-startup
  282. :type '(choice (const :tag "Default" nil)
  283. (face :tag "Face" :value org-warning)
  284. (string :tag "String" :value "...#")))
  285. (defvar org-display-table nil
  286. "The display table for org-mode, in case `org-ellipsis' is non-nil.")
  287. (defgroup org-keywords nil
  288. "Keywords in Org-mode."
  289. :tag "Org Keywords"
  290. :group 'org)
  291. (defcustom org-deadline-string "DEADLINE:"
  292. "String to mark deadline entries.
  293. A deadline is this string, followed by a time stamp. Should be a word,
  294. terminated by a colon. You can insert a schedule keyword and
  295. a timestamp with \\[org-deadline].
  296. Changes become only effective after restarting Emacs."
  297. :group 'org-keywords
  298. :type 'string)
  299. (defcustom org-scheduled-string "SCHEDULED:"
  300. "String to mark scheduled TODO entries.
  301. A schedule is this string, followed by a time stamp. Should be a word,
  302. terminated by a colon. You can insert a schedule keyword and
  303. a timestamp with \\[org-schedule].
  304. Changes become only effective after restarting Emacs."
  305. :group 'org-keywords
  306. :type 'string)
  307. (defcustom org-closed-string "CLOSED:"
  308. "String used as the prefix for timestamps logging closing a TODO entry."
  309. :group 'org-keywords
  310. :type 'string)
  311. (defcustom org-clock-string "CLOCK:"
  312. "String used as prefix for timestamps clocking work hours on an item."
  313. :group 'org-keywords
  314. :type 'string)
  315. (defcustom org-comment-string "COMMENT"
  316. "Entries starting with this keyword will never be exported.
  317. An entry can be toggled between COMMENT and normal with
  318. \\[org-toggle-comment].
  319. Changes become only effective after restarting Emacs."
  320. :group 'org-keywords
  321. :type 'string)
  322. (defcustom org-quote-string "QUOTE"
  323. "Entries starting with this keyword will be exported in fixed-width font.
  324. Quoting applies only to the text in the entry following the headline, and does
  325. not extend beyond the next headline, even if that is lower level.
  326. An entry can be toggled between QUOTE and normal with
  327. \\[org-toggle-fixed-width-section]."
  328. :group 'org-keywords
  329. :type 'string)
  330. (defconst org-repeat-re
  331. "<[0-9]\\{4\\}-[0-9][0-9]-[0-9][0-9] [^>\n]*\\([.+]?\\+[0-9]+[dwmy]\\)"
  332. "Regular expression for specifying repeated events.
  333. After a match, group 1 contains the repeat expression.")
  334. (defgroup org-structure nil
  335. "Options concerning the general structure of Org-mode files."
  336. :tag "Org Structure"
  337. :group 'org)
  338. (defgroup org-reveal-location nil
  339. "Options about how to make context of a location visible."
  340. :tag "Org Reveal Location"
  341. :group 'org-structure)
  342. (defconst org-context-choice
  343. '(choice
  344. (const :tag "Always" t)
  345. (const :tag "Never" nil)
  346. (repeat :greedy t :tag "Individual contexts"
  347. (cons
  348. (choice :tag "Context"
  349. (const agenda)
  350. (const org-goto)
  351. (const occur-tree)
  352. (const tags-tree)
  353. (const link-search)
  354. (const mark-goto)
  355. (const bookmark-jump)
  356. (const isearch)
  357. (const default))
  358. (boolean))))
  359. "Contexts for the reveal options.")
  360. (defcustom org-show-hierarchy-above '((default . t))
  361. "Non-nil means, show full hierarchy when revealing a location.
  362. Org-mode often shows locations in an org-mode file which might have
  363. been invisible before. When this is set, the hierarchy of headings
  364. above the exposed location is shown.
  365. Turning this off for example for sparse trees makes them very compact.
  366. Instead of t, this can also be an alist specifying this option for different
  367. contexts. Valid contexts are
  368. agenda when exposing an entry from the agenda
  369. org-goto when using the command `org-goto' on key C-c C-j
  370. occur-tree when using the command `org-occur' on key C-c /
  371. tags-tree when constructing a sparse tree based on tags matches
  372. link-search when exposing search matches associated with a link
  373. mark-goto when exposing the jump goal of a mark
  374. bookmark-jump when exposing a bookmark location
  375. isearch when exiting from an incremental search
  376. default default for all contexts not set explicitly"
  377. :group 'org-reveal-location
  378. :type org-context-choice)
  379. (defcustom org-show-following-heading '((default . nil))
  380. "Non-nil means, show following heading when revealing a location.
  381. Org-mode often shows locations in an org-mode file which might have
  382. been invisible before. When this is set, the heading following the
  383. match is shown.
  384. Turning this off for example for sparse trees makes them very compact,
  385. but makes it harder to edit the location of the match. In such a case,
  386. use the command \\[org-reveal] to show more context.
  387. Instead of t, this can also be an alist specifying this option for different
  388. contexts. See `org-show-hierarchy-above' for valid contexts."
  389. :group 'org-reveal-location
  390. :type org-context-choice)
  391. (defcustom org-show-siblings '((default . nil) (isearch t))
  392. "Non-nil means, show all sibling heading when revealing a location.
  393. Org-mode often shows locations in an org-mode file which might have
  394. been invisible before. When this is set, the sibling of the current entry
  395. heading are all made visible. If `org-show-hierarchy-above' is t,
  396. the same happens on each level of the hierarchy above the current entry.
  397. By default this is on for the isearch context, off for all other contexts.
  398. Turning this off for example for sparse trees makes them very compact,
  399. but makes it harder to edit the location of the match. In such a case,
  400. use the command \\[org-reveal] to show more context.
  401. Instead of t, this can also be an alist specifying this option for different
  402. contexts. See `org-show-hierarchy-above' for valid contexts."
  403. :group 'org-reveal-location
  404. :type org-context-choice)
  405. (defcustom org-show-entry-below '((default . nil))
  406. "Non-nil means, show the entry below a headline when revealing a location.
  407. Org-mode often shows locations in an org-mode file which might have
  408. been invisible before. When this is set, the text below the headline that is
  409. exposed is also shown.
  410. By default this is off for all contexts.
  411. Instead of t, this can also be an alist specifying this option for different
  412. contexts. See `org-show-hierarchy-above' for valid contexts."
  413. :group 'org-reveal-location
  414. :type org-context-choice)
  415. (defcustom org-indirect-buffer-display 'other-window
  416. "How should indirect tree buffers be displayed?
  417. This applies to indirect buffers created with the commands
  418. \\[org-tree-to-indirect-buffer] and \\[org-agenda-tree-to-indirect-buffer].
  419. Valid values are:
  420. current-window Display in the current window
  421. other-window Just display in another window.
  422. dedicated-frame Create one new frame, and re-use it each time.
  423. new-frame Make a new frame each time. Note that in this case
  424. previously-made indirect buffers are kept, and you need to
  425. kill these buffers yourself."
  426. :group 'org-structure
  427. :group 'org-agenda-windows
  428. :type '(choice
  429. (const :tag "In current window" current-window)
  430. (const :tag "In current frame, other window" other-window)
  431. (const :tag "Each time a new frame" new-frame)
  432. (const :tag "One dedicated frame" dedicated-frame)))
  433. (defgroup org-cycle nil
  434. "Options concerning visibility cycling in Org-mode."
  435. :tag "Org Cycle"
  436. :group 'org-structure)
  437. (defcustom org-drawers '("PROPERTIES" "CLOCK")
  438. "Names of drawers. Drawers are not opened by cycling on the headline above.
  439. Drawers only open with a TAB on the drawer line itself. A drawer looks like
  440. this:
  441. :DRAWERNAME:
  442. .....
  443. :END:
  444. The drawer \"PROPERTIES\" is special for capturing properties through
  445. the property API.
  446. Drawers can be defined on the per-file basis with a line like:
  447. #+DRAWERS: HIDDEN STATE PROPERTIES"
  448. :group 'org-structure
  449. :type '(repeat (string :tag "Drawer Name")))
  450. (defcustom org-cycle-global-at-bob nil
  451. "Cycle globally if cursor is at beginning of buffer and not at a headline.
  452. This makes it possible to do global cycling without having to use S-TAB or
  453. C-u TAB. For this special case to work, the first line of the buffer
  454. must not be a headline - it may be empty ot some other text. When used in
  455. this way, `org-cycle-hook' is disables temporarily, to make sure the
  456. cursor stays at the beginning of the buffer.
  457. When this option is nil, don't do anything special at the beginning
  458. of the buffer."
  459. :group 'org-cycle
  460. :type 'boolean)
  461. (defcustom org-cycle-emulate-tab t
  462. "Where should `org-cycle' emulate TAB.
  463. nil Never
  464. white Only in completely white lines
  465. whitestart Only at the beginning of lines, before the first non-white char
  466. t Everywhere except in headlines
  467. exc-hl-bol Everywhere except at the start of a headline
  468. If TAB is used in a place where it does not emulate TAB, the current subtree
  469. visibility is cycled."
  470. :group 'org-cycle
  471. :type '(choice (const :tag "Never" nil)
  472. (const :tag "Only in completely white lines" white)
  473. (const :tag "Before first char in a line" whitestart)
  474. (const :tag "Everywhere except in headlines" t)
  475. (const :tag "Everywhere except at bol in headlines" exc-hl-bol)
  476. ))
  477. (defcustom org-cycle-separator-lines 2
  478. "Number of empty lines needed to keep an empty line between collapsed trees.
  479. If you leave an empty line between the end of a subtree and the following
  480. headline, this empty line is hidden when the subtree is folded.
  481. Org-mode will leave (exactly) one empty line visible if the number of
  482. empty lines is equal or larger to the number given in this variable.
  483. So the default 2 means, at least 2 empty lines after the end of a subtree
  484. are needed to produce free space between a collapsed subtree and the
  485. following headline.
  486. Special case: when 0, never leave empty lines in collapsed view."
  487. :group 'org-cycle
  488. :type 'integer)
  489. (put 'org-cycle-separator-lines 'safe-local-variable 'integerp)
  490. (defcustom org-cycle-hook '(org-cycle-hide-archived-subtrees
  491. org-cycle-hide-drawers
  492. org-cycle-show-empty-lines
  493. org-optimize-window-after-visibility-change)
  494. "Hook that is run after `org-cycle' has changed the buffer visibility.
  495. The function(s) in this hook must accept a single argument which indicates
  496. the new state that was set by the most recent `org-cycle' command. The
  497. argument is a symbol. After a global state change, it can have the values
  498. `overview', `content', or `all'. After a local state change, it can have
  499. the values `folded', `children', or `subtree'."
  500. :group 'org-cycle
  501. :type 'hook)
  502. (defgroup org-edit-structure nil
  503. "Options concerning structure editing in Org-mode."
  504. :tag "Org Edit Structure"
  505. :group 'org-structure)
  506. (defcustom org-odd-levels-only nil
  507. "Non-nil means, skip even levels and only use odd levels for the outline.
  508. This has the effect that two stars are being added/taken away in
  509. promotion/demotion commands. It also influences how levels are
  510. handled by the exporters.
  511. Changing it requires restart of `font-lock-mode' to become effective
  512. for fontification also in regions already fontified.
  513. You may also set this on a per-file basis by adding one of the following
  514. lines to the buffer:
  515. #+STARTUP: odd
  516. #+STARTUP: oddeven"
  517. :group 'org-edit-structure
  518. :group 'org-font-lock
  519. :type 'boolean)
  520. (defcustom org-adapt-indentation t
  521. "Non-nil means, adapt indentation when promoting and demoting.
  522. When this is set and the *entire* text in an entry is indented, the
  523. indentation is increased by one space in a demotion command, and
  524. decreased by one in a promotion command. If any line in the entry
  525. body starts at column 0, indentation is not changed at all."
  526. :group 'org-edit-structure
  527. :type 'boolean)
  528. (defcustom org-special-ctrl-a/e nil
  529. "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
  530. When t, `C-a' will bring back the cursor to the beginning of the
  531. headline text, i.e. after the stars and after a possible TODO keyword.
  532. In an item, this will be the position after the bullet.
  533. When the cursor is already at that position, another `C-a' will bring
  534. it to the beginning of the line.
  535. `C-e' will jump to the end of the headline, ignoring the presence of tags
  536. in the headline. A second `C-e' will then jump to the true end of the
  537. line, after any tags.
  538. When set to the symbol `reversed', the first `C-a' or `C-e' works normally,
  539. and only a directly following, identical keypress will bring the cursor
  540. to the special positions."
  541. :group 'org-edit-structure
  542. :type '(choice
  543. (const :tag "off" nil)
  544. (const :tag "after bullet first" t)
  545. (const :tag "border first" reversed)))
  546. (if (fboundp 'defvaralias)
  547. (defvaralias 'org-special-ctrl-a 'org-special-ctrl-a/e))
  548. (defcustom org-special-ctrl-k nil
  549. "Non-nil means `C-k' will behave specially in headlines.
  550. When nil, `C-k' will call the default `kill-line' command.
  551. When t, the following will happen while the cursor is in the headline:
  552. - When the cursor is at the beginning of a headline, kill the entire
  553. line and possible the folded subtree below the line.
  554. - When in the middle of the headline text, kill the headline up to the tags.
  555. - When after the headline text, kill the tags."
  556. :group 'org-edit-structure
  557. :type 'boolean)
  558. (defcustom org-yank-folded-subtrees t
  559. "Non-nil means, when yanking subtrees, fold them.
  560. If the kill is a single subtree, or a sequence of subtrees, i.e. if
  561. it starts with a heading and all other headings in it are either children
  562. or siblings, then fold all the subtrees."
  563. :group 'org-edit-structure
  564. :type 'boolean)
  565. (defcustom org-M-RET-may-split-line '((default . t))
  566. "Non-nil means, M-RET will split the line at the cursor position.
  567. When nil, it will go to the end of the line before making a
  568. new line.
  569. You may also set this option in a different way for different
  570. contexts. Valid contexts are:
  571. headline when creating a new headline
  572. item when creating a new item
  573. table in a table field
  574. default the value to be used for all contexts not explicitly
  575. customized"
  576. :group 'org-structure
  577. :group 'org-table
  578. :type '(choice
  579. (const :tag "Always" t)
  580. (const :tag "Never" nil)
  581. (repeat :greedy t :tag "Individual contexts"
  582. (cons
  583. (choice :tag "Context"
  584. (const headline)
  585. (const item)
  586. (const table)
  587. (const default))
  588. (boolean)))))
  589. (defcustom org-insert-heading-respect-content nil
  590. "Non-nil means, insert new headings after the current subtree.
  591. When nil, the new heading is created directly after the current line.
  592. The commands \\[org-insert-heading-respect-content] and
  593. \\[org-insert-todo-heading-respect-content] turn this variable on
  594. for the duration of the command."
  595. :group 'org-structure
  596. :type 'boolean)
  597. (defcustom org-blank-before-new-entry '((heading . nil)
  598. (plain-list-item . nil))
  599. "Should `org-insert-heading' leave a blank line before new heading/item?
  600. The value is an alist, with `heading' and `plain-list-item' as car,
  601. and a boolean flag as cdr."
  602. :group 'org-edit-structure
  603. :type '(list
  604. (cons (const heading) (boolean))
  605. (cons (const plain-list-item) (boolean))))
  606. (defcustom org-insert-heading-hook nil
  607. "Hook being run after inserting a new heading."
  608. :group 'org-edit-structure
  609. :type 'hook)
  610. (defcustom org-enable-fixed-width-editor t
  611. "Non-nil means, lines starting with \":\" are treated as fixed-width.
  612. This currently only means, they are never auto-wrapped.
  613. When nil, such lines will be treated like ordinary lines.
  614. See also the QUOTE keyword."
  615. :group 'org-edit-structure
  616. :type 'boolean)
  617. (defcustom org-edit-fixed-width-region-mode 'artist-mode
  618. "The mode that should be used to edit fixed-width regions.
  619. These are the regions where each line starts with a colon."
  620. :group 'org-edit-structure
  621. :type '(choice
  622. (const artist-mode)
  623. (const picture-mode)
  624. (const fundamental-mode)
  625. (function :tag "Other (specify)")))
  626. (defcustom org-goto-auto-isearch t
  627. "Non-nil means, typing characters in org-goto starts incremental search."
  628. :group 'org-edit-structure
  629. :type 'boolean)
  630. (defgroup org-sparse-trees nil
  631. "Options concerning sparse trees in Org-mode."
  632. :tag "Org Sparse Trees"
  633. :group 'org-structure)
  634. (defcustom org-highlight-sparse-tree-matches t
  635. "Non-nil means, highlight all matches that define a sparse tree.
  636. The highlights will automatically disappear the next time the buffer is
  637. changed by an edit command."
  638. :group 'org-sparse-trees
  639. :type 'boolean)
  640. (defcustom org-remove-highlights-with-change t
  641. "Non-nil means, any change to the buffer will remove temporary highlights.
  642. Such highlights are created by `org-occur' and `org-clock-display'.
  643. When nil, `C-c C-c needs to be used to get rid of the highlights.
  644. The highlights created by `org-preview-latex-fragment' always need
  645. `C-c C-c' to be removed."
  646. :group 'org-sparse-trees
  647. :group 'org-time
  648. :type 'boolean)
  649. (defcustom org-occur-hook '(org-first-headline-recenter)
  650. "Hook that is run after `org-occur' has constructed a sparse tree.
  651. This can be used to recenter the window to show as much of the structure
  652. as possible."
  653. :group 'org-sparse-trees
  654. :type 'hook)
  655. (defgroup org-plain-lists nil
  656. "Options concerning plain lists in Org-mode."
  657. :tag "Org Plain lists"
  658. :group 'org-structure)
  659. (defcustom org-cycle-include-plain-lists nil
  660. "Non-nil means, include plain lists into visibility cycling.
  661. This means that during cycling, plain list items will *temporarily* be
  662. interpreted as outline headlines with a level given by 1000+i where i is the
  663. indentation of the bullet. In all other operations, plain list items are
  664. not seen as headlines. For example, you cannot assign a TODO keyword to
  665. such an item."
  666. :group 'org-plain-lists
  667. :type 'boolean)
  668. (defcustom org-plain-list-ordered-item-terminator t
  669. "The character that makes a line with leading number an ordered list item.
  670. Valid values are ?. and ?\). To get both terminators, use t. While
  671. ?. may look nicer, it creates the danger that a line with leading
  672. number may be incorrectly interpreted as an item. ?\) therefore is
  673. the safe choice."
  674. :group 'org-plain-lists
  675. :type '(choice (const :tag "dot like in \"2.\"" ?.)
  676. (const :tag "paren like in \"2)\"" ?\))
  677. (const :tab "both" t)))
  678. (defcustom org-empty-line-terminates-plain-lists nil
  679. "Non-nil means, an empty line ends all plain list levels.
  680. When nil, empty lines are part of the preceeding item."
  681. :group 'org-plain-lists
  682. :type 'boolean)
  683. (defcustom org-auto-renumber-ordered-lists t
  684. "Non-nil means, automatically renumber ordered plain lists.
  685. Renumbering happens when the sequence have been changed with
  686. \\[org-shiftmetaup] or \\[org-shiftmetadown]. After other editing commands,
  687. use \\[org-ctrl-c-ctrl-c] to trigger renumbering."
  688. :group 'org-plain-lists
  689. :type 'boolean)
  690. (defcustom org-provide-checkbox-statistics t
  691. "Non-nil means, update checkbox statistics after insert and toggle.
  692. When this is set, checkbox statistics is updated each time you either insert
  693. a new checkbox with \\[org-insert-todo-heading] or toggle a checkbox
  694. with \\[org-ctrl-c-ctrl-c\\]."
  695. :group 'org-plain-lists
  696. :type 'boolean)
  697. (defcustom org-description-max-indent 20
  698. "Maximum indentation for the second line of a description list.
  699. When the indentation would be larger than this, it will become
  700. 5 characters instead."
  701. :group 'org-plain-lists
  702. :type 'integer)
  703. (defgroup org-imenu-and-speedbar nil
  704. "Options concerning imenu and speedbar in Org-mode."
  705. :tag "Org Imenu and Speedbar"
  706. :group 'org-structure)
  707. (defcustom org-imenu-depth 2
  708. "The maximum level for Imenu access to Org-mode headlines.
  709. This also applied for speedbar access."
  710. :group 'org-imenu-and-speedbar
  711. :type 'number)
  712. (defgroup org-table nil
  713. "Options concerning tables in Org-mode."
  714. :tag "Org Table"
  715. :group 'org)
  716. (defcustom org-enable-table-editor 'optimized
  717. "Non-nil means, lines starting with \"|\" are handled by the table editor.
  718. When nil, such lines will be treated like ordinary lines.
  719. When equal to the symbol `optimized', the table editor will be optimized to
  720. do the following:
  721. - Automatic overwrite mode in front of whitespace in table fields.
  722. This makes the structure of the table stay in tact as long as the edited
  723. field does not exceed the column width.
  724. - Minimize the number of realigns. Normally, the table is aligned each time
  725. TAB or RET are pressed to move to another field. With optimization this
  726. happens only if changes to a field might have changed the column width.
  727. Optimization requires replacing the functions `self-insert-command',
  728. `delete-char', and `backward-delete-char' in Org-mode buffers, with a
  729. slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
  730. very good at guessing when a re-align will be necessary, but you can always
  731. force one with \\[org-ctrl-c-ctrl-c].
  732. If you would like to use the optimized version in Org-mode, but the
  733. un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
  734. This variable can be used to turn on and off the table editor during a session,
  735. but in order to toggle optimization, a restart is required.
  736. See also the variable `org-table-auto-blank-field'."
  737. :group 'org-table
  738. :type '(choice
  739. (const :tag "off" nil)
  740. (const :tag "on" t)
  741. (const :tag "on, optimized" optimized)))
  742. (defcustom org-table-tab-recognizes-table.el t
  743. "Non-nil means, TAB will automatically notice a table.el table.
  744. When it sees such a table, it moves point into it and - if necessary -
  745. calls `table-recognize-table'."
  746. :group 'org-table-editing
  747. :type 'boolean)
  748. (defgroup org-link nil
  749. "Options concerning links in Org-mode."
  750. :tag "Org Link"
  751. :group 'org)
  752. (defvar org-link-abbrev-alist-local nil
  753. "Buffer-local version of `org-link-abbrev-alist', which see.
  754. The value of this is taken from the #+LINK lines.")
  755. (make-variable-buffer-local 'org-link-abbrev-alist-local)
  756. (defcustom org-link-abbrev-alist nil
  757. "Alist of link abbreviations.
  758. The car of each element is a string, to be replaced at the start of a link.
  759. The cdrs are replacement values, like (\"linkkey\" . REPLACE). Abbreviated
  760. links in Org-mode buffers can have an optional tag after a double colon, e.g.
  761. [[linkkey:tag][description]]
  762. If REPLACE is a string, the tag will simply be appended to create the link.
  763. If the string contains \"%s\", the tag will be inserted there.
  764. REPLACE may also be a function that will be called with the tag as the
  765. only argument to create the link, which should be returned as a string.
  766. See the manual for examples."
  767. :group 'org-link
  768. :type 'alist)
  769. (defcustom org-descriptive-links t
  770. "Non-nil means, hide link part and only show description of bracket links.
  771. Bracket links are like [[link][descritpion]]. This variable sets the initial
  772. state in new org-mode buffers. The setting can then be toggled on a
  773. per-buffer basis from the Org->Hyperlinks menu."
  774. :group 'org-link
  775. :type 'boolean)
  776. (defcustom org-link-file-path-type 'adaptive
  777. "How the path name in file links should be stored.
  778. Valid values are:
  779. relative Relative to the current directory, i.e. the directory of the file
  780. into which the link is being inserted.
  781. absolute Absolute path, if possible with ~ for home directory.
  782. noabbrev Absolute path, no abbreviation of home directory.
  783. adaptive Use relative path for files in the current directory and sub-
  784. directories of it. For other files, use an absolute path."
  785. :group 'org-link
  786. :type '(choice
  787. (const relative)
  788. (const absolute)
  789. (const noabbrev)
  790. (const adaptive)))
  791. (defcustom org-activate-links '(bracket angle plain radio tag date)
  792. "Types of links that should be activated in Org-mode files.
  793. This is a list of symbols, each leading to the activation of a certain link
  794. type. In principle, it does not hurt to turn on most link types - there may
  795. be a small gain when turning off unused link types. The types are:
  796. bracket The recommended [[link][description]] or [[link]] links with hiding.
  797. angular Links in angular brackes that may contain whitespace like
  798. <bbdb:Carsten Dominik>.
  799. plain Plain links in normal text, no whitespace, like http://google.com.
  800. radio Text that is matched by a radio target, see manual for details.
  801. tag Tag settings in a headline (link to tag search).
  802. date Time stamps (link to calendar).
  803. Changing this variable requires a restart of Emacs to become effective."
  804. :group 'org-link
  805. :type '(set (const :tag "Double bracket links (new style)" bracket)
  806. (const :tag "Angular bracket links (old style)" angular)
  807. (const :tag "Plain text links" plain)
  808. (const :tag "Radio target matches" radio)
  809. (const :tag "Tags" tag)
  810. (const :tag "Timestamps" date)))
  811. (defcustom org-make-link-description-function nil
  812. "Function to use to generate link descriptions from links. If
  813. nil the link location will be used. This function must take two
  814. parameters; the first is the link and the second the description
  815. org-insert-link has generated, and should return the description
  816. to use."
  817. :group 'org-link
  818. :type 'function)
  819. (defgroup org-link-store nil
  820. "Options concerning storing links in Org-mode."
  821. :tag "Org Store Link"
  822. :group 'org-link)
  823. (defcustom org-email-link-description-format "Email %c: %.30s"
  824. "Format of the description part of a link to an email or usenet message.
  825. The following %-excapes will be replaced by corresponding information:
  826. %F full \"From\" field
  827. %f name, taken from \"From\" field, address if no name
  828. %T full \"To\" field
  829. %t first name in \"To\" field, address if no name
  830. %c correspondent. Unually \"from NAME\", but if you sent it yourself, it
  831. will be \"to NAME\". See also the variable `org-from-is-user-regexp'.
  832. %s subject
  833. %m message-id.
  834. You may use normal field width specification between the % and the letter.
  835. This is for example useful to limit the length of the subject.
  836. Examples: \"%f on: %.30s\", \"Email from %f\", \"Email %c\""
  837. :group 'org-link-store
  838. :type 'string)
  839. (defcustom org-from-is-user-regexp
  840. (let (r1 r2)
  841. (when (and user-mail-address (not (string= user-mail-address "")))
  842. (setq r1 (concat "\\<" (regexp-quote user-mail-address) "\\>")))
  843. (when (and user-full-name (not (string= user-full-name "")))
  844. (setq r2 (concat "\\<" (regexp-quote user-full-name) "\\>")))
  845. (if (and r1 r2) (concat r1 "\\|" r2) (or r1 r2)))
  846. "Regexp mached against the \"From:\" header of an email or usenet message.
  847. It should match if the message is from the user him/herself."
  848. :group 'org-link-store
  849. :type 'regexp)
  850. (defcustom org-context-in-file-links t
  851. "Non-nil means, file links from `org-store-link' contain context.
  852. A search string will be added to the file name with :: as separator and
  853. used to find the context when the link is activated by the command
  854. `org-open-at-point'.
  855. Using a prefix arg to the command \\[org-store-link] (`org-store-link')
  856. negates this setting for the duration of the command."
  857. :group 'org-link-store
  858. :type 'boolean)
  859. (defcustom org-keep-stored-link-after-insertion nil
  860. "Non-nil means, keep link in list for entire session.
  861. The command `org-store-link' adds a link pointing to the current
  862. location to an internal list. These links accumulate during a session.
  863. The command `org-insert-link' can be used to insert links into any
  864. Org-mode file (offering completion for all stored links). When this
  865. option is nil, every link which has been inserted once using \\[org-insert-link]
  866. will be removed from the list, to make completing the unused links
  867. more efficient."
  868. :group 'org-link-store
  869. :type 'boolean)
  870. (defgroup org-link-follow nil
  871. "Options concerning following links in Org-mode."
  872. :tag "Org Follow Link"
  873. :group 'org-link)
  874. (defcustom org-follow-link-hook nil
  875. "Hook that is run after a link has been followed."
  876. :group 'org-link-follow
  877. :type 'hook)
  878. (defcustom org-tab-follows-link nil
  879. "Non-nil means, on links TAB will follow the link.
  880. Needs to be set before org.el is loaded."
  881. :group 'org-link-follow
  882. :type 'boolean)
  883. (defcustom org-return-follows-link nil
  884. "Non-nil means, on links RET will follow the link.
  885. Needs to be set before org.el is loaded."
  886. :group 'org-link-follow
  887. :type 'boolean)
  888. (defcustom org-mouse-1-follows-link
  889. (if (boundp 'mouse-1-click-follows-link) mouse-1-click-follows-link t)
  890. "Non-nil means, mouse-1 on a link will follow the link.
  891. A longer mouse click will still set point. Does not work on XEmacs.
  892. Needs to be set before org.el is loaded."
  893. :group 'org-link-follow
  894. :type 'boolean)
  895. (defcustom org-mark-ring-length 4
  896. "Number of different positions to be recorded in the ring
  897. Changing this requires a restart of Emacs to work correctly."
  898. :group 'org-link-follow
  899. :type 'interger)
  900. (defcustom org-link-frame-setup
  901. '((vm . vm-visit-folder-other-frame)
  902. (gnus . gnus-other-frame)
  903. (file . find-file-other-window))
  904. "Setup the frame configuration for following links.
  905. When following a link with Emacs, it may often be useful to display
  906. this link in another window or frame. This variable can be used to
  907. set this up for the different types of links.
  908. For VM, use any of
  909. `vm-visit-folder'
  910. `vm-visit-folder-other-frame'
  911. For Gnus, use any of
  912. `gnus'
  913. `gnus-other-frame'
  914. For FILE, use any of
  915. `find-file'
  916. `find-file-other-window'
  917. `find-file-other-frame'
  918. For the calendar, use the variable `calendar-setup'.
  919. For BBDB, it is currently only possible to display the matches in
  920. another window."
  921. :group 'org-link-follow
  922. :type '(list
  923. (cons (const vm)
  924. (choice
  925. (const vm-visit-folder)
  926. (const vm-visit-folder-other-window)
  927. (const vm-visit-folder-other-frame)))
  928. (cons (const gnus)
  929. (choice
  930. (const gnus)
  931. (const gnus-other-frame)))
  932. (cons (const file)
  933. (choice
  934. (const find-file)
  935. (const find-file-other-window)
  936. (const find-file-other-frame)))))
  937. (defcustom org-display-internal-link-with-indirect-buffer nil
  938. "Non-nil means, use indirect buffer to display infile links.
  939. Activating internal links (from one location in a file to another location
  940. in the same file) normally just jumps to the location. When the link is
  941. activated with a C-u prefix (or with mouse-3), the link is displayed in
  942. another window. When this option is set, the other window actually displays
  943. an indirect buffer clone of the current buffer, to avoid any visibility
  944. changes to the current buffer."
  945. :group 'org-link-follow
  946. :type 'boolean)
  947. (defcustom org-open-non-existing-files nil
  948. "Non-nil means, `org-open-file' will open non-existing files.
  949. When nil, an error will be generated."
  950. :group 'org-link-follow
  951. :type 'boolean)
  952. (defcustom org-open-directory-means-index-dot-org nil
  953. "Non-nil means, a link to a directory really means to index.org.
  954. When nil, following a directory link will run dired or open a finder/explorer
  955. window on that directory."
  956. :group 'org-link-follow
  957. :type 'boolean)
  958. (defcustom org-link-mailto-program '(browse-url "mailto:%a?subject=%s")
  959. "Function and arguments to call for following mailto links.
  960. This is a list with the first element being a lisp function, and the
  961. remaining elements being arguments to the function. In string arguments,
  962. %a will be replaced by the address, and %s will be replaced by the subject
  963. if one was given like in <mailto:arthur@galaxy.org::this subject>."
  964. :group 'org-link-follow
  965. :type '(choice
  966. (const :tag "browse-url" (browse-url-mail "mailto:%a?subject=%s"))
  967. (const :tag "compose-mail" (compose-mail "%a" "%s"))
  968. (const :tag "message-mail" (message-mail "%a" "%s"))
  969. (cons :tag "other" (function) (repeat :tag "argument" sexp))))
  970. (defcustom org-confirm-shell-link-function 'yes-or-no-p
  971. "Non-nil means, ask for confirmation before executing shell links.
  972. Shell links can be dangerous: just think about a link
  973. [[shell:rm -rf ~/*][Google Search]]
  974. This link would show up in your Org-mode document as \"Google Search\",
  975. but really it would remove your entire home directory.
  976. Therefore we advise against setting this variable to nil.
  977. Just change it to `y-or-n-p' of you want to confirm with a
  978. single keystroke rather than having to type \"yes\"."
  979. :group 'org-link-follow
  980. :type '(choice
  981. (const :tag "with yes-or-no (safer)" yes-or-no-p)
  982. (const :tag "with y-or-n (faster)" y-or-n-p)
  983. (const :tag "no confirmation (dangerous)" nil)))
  984. (defcustom org-confirm-elisp-link-function 'yes-or-no-p
  985. "Non-nil means, ask for confirmation before executing Emacs Lisp links.
  986. Elisp links can be dangerous: just think about a link
  987. [[elisp:(shell-command \"rm -rf ~/*\")][Google Search]]
  988. This link would show up in your Org-mode document as \"Google Search\",
  989. but really it would remove your entire home directory.
  990. Therefore we advise against setting this variable to nil.
  991. Just change it to `y-or-n-p' of you want to confirm with a
  992. single keystroke rather than having to type \"yes\"."
  993. :group 'org-link-follow
  994. :type '(choice
  995. (const :tag "with yes-or-no (safer)" yes-or-no-p)
  996. (const :tag "with y-or-n (faster)" y-or-n-p)
  997. (const :tag "no confirmation (dangerous)" nil)))
  998. (defconst org-file-apps-defaults-gnu
  999. '((remote . emacs)
  1000. (t . mailcap))
  1001. "Default file applications on a UNIX or GNU/Linux system.
  1002. See `org-file-apps'.")
  1003. (defconst org-file-apps-defaults-macosx
  1004. '((remote . emacs)
  1005. (t . "open %s")
  1006. ("ps" . "gv %s")
  1007. ("ps.gz" . "gv %s")
  1008. ("eps" . "gv %s")
  1009. ("eps.gz" . "gv %s")
  1010. ("dvi" . "xdvi %s")
  1011. ("fig" . "xfig %s"))
  1012. "Default file applications on a MacOS X system.
  1013. The system \"open\" is known as a default, but we use X11 applications
  1014. for some files for which the OS does not have a good default.
  1015. See `org-file-apps'.")
  1016. (defconst org-file-apps-defaults-windowsnt
  1017. (list
  1018. '(remote . emacs)
  1019. (cons t
  1020. (list (if (featurep 'xemacs)
  1021. 'mswindows-shell-execute
  1022. 'w32-shell-execute)
  1023. "open" 'file)))
  1024. "Default file applications on a Windows NT system.
  1025. The system \"open\" is used for most files.
  1026. See `org-file-apps'.")
  1027. (defcustom org-file-apps
  1028. '(
  1029. ("txt" . emacs)
  1030. ("tex" . emacs)
  1031. ("ltx" . emacs)
  1032. ("org" . emacs)
  1033. ("el" . emacs)
  1034. ("bib" . emacs)
  1035. )
  1036. "External applications for opening `file:path' items in a document.
  1037. Org-mode uses system defaults for different file types, but
  1038. you can use this variable to set the application for a given file
  1039. extension. The entries in this list are cons cells where the car identifies
  1040. files and the cdr the corresponding command. Possible values for the
  1041. file identifier are
  1042. \"ext\" A string identifying an extension
  1043. `directory' Matches a directory
  1044. `remote' Matches a remote file, accessible through tramp or efs.
  1045. Remote files most likely should be visited through Emacs
  1046. because external applications cannot handle such paths.
  1047. t Default for all remaining files
  1048. Possible values for the command are:
  1049. `emacs' The file will be visited by the current Emacs process.
  1050. `default' Use the default application for this file type.
  1051. string A command to be executed by a shell; %s will be replaced
  1052. by the path to the file.
  1053. sexp A Lisp form which will be evaluated. The file path will
  1054. be available in the Lisp variable `file'.
  1055. For more examples, see the system specific constants
  1056. `org-file-apps-defaults-macosx'
  1057. `org-file-apps-defaults-windowsnt'
  1058. `org-file-apps-defaults-gnu'."
  1059. :group 'org-link-follow
  1060. :type '(repeat
  1061. (cons (choice :value ""
  1062. (string :tag "Extension")
  1063. (const :tag "Default for unrecognized files" t)
  1064. (const :tag "Remote file" remote)
  1065. (const :tag "Links to a directory" directory))
  1066. (choice :value ""
  1067. (const :tag "Visit with Emacs" emacs)
  1068. (const :tag "Use system default" default)
  1069. (string :tag "Command")
  1070. (sexp :tag "Lisp form")))))
  1071. (defgroup org-refile nil
  1072. "Options concerning refiling entries in Org-mode."
  1073. :tag "Org Remember"
  1074. :group 'org)
  1075. (defcustom org-directory "~/org"
  1076. "Directory with org files.
  1077. This directory will be used as default to prompt for org files.
  1078. Used by the hooks for remember.el."
  1079. :group 'org-refile
  1080. :group 'org-remember
  1081. :type 'directory)
  1082. (defcustom org-default-notes-file "~/.notes"
  1083. "Default target for storing notes.
  1084. Used by the hooks for remember.el. This can be a string, or nil to mean
  1085. the value of `remember-data-file'.
  1086. You can set this on a per-template basis with the variable
  1087. `org-remember-templates'."
  1088. :group 'org-refile
  1089. :group 'org-remember
  1090. :type '(choice
  1091. (const :tag "Default from remember-data-file" nil)
  1092. file))
  1093. (defcustom org-goto-interface 'outline
  1094. "The default interface to be used for `org-goto'.
  1095. Allowed vaues are:
  1096. outline The interface shows an outline of the relevant file
  1097. and the correct heading is found by moving through
  1098. the outline or by searching with incremental search.
  1099. outline-path-completion Headlines in the current buffer are offered via
  1100. completion."
  1101. :group 'org-refile
  1102. :type '(choice
  1103. (const :tag "Outline" outline)
  1104. (const :tag "Outline-path-completion" outline-path-completion)))
  1105. (defcustom org-reverse-note-order nil
  1106. "Non-nil means, store new notes at the beginning of a file or entry.
  1107. When nil, new notes will be filed to the end of a file or entry.
  1108. This can also be a list with cons cells of regular expressions that
  1109. are matched against file names, and values."
  1110. :group 'org-remember
  1111. :type '(choice
  1112. (const :tag "Reverse always" t)
  1113. (const :tag "Reverse never" nil)
  1114. (repeat :tag "By file name regexp"
  1115. (cons regexp boolean))))
  1116. (defcustom org-refile-targets nil
  1117. "Targets for refiling entries with \\[org-refile].
  1118. This is list of cons cells. Each cell contains:
  1119. - a specification of the files to be considered, either a list of files,
  1120. or a symbol whose function or variable value will be used to retrieve
  1121. a file name or a list of file names. Nil means, refile to a different
  1122. heading in the current buffer.
  1123. - A specification of how to find candidate refile targets. This may be
  1124. any of
  1125. - a cons cell (:tag . \"TAG\") to identify refile targets by a tag.
  1126. This tag has to be present in all target headlines, inheritance will
  1127. not be considered.
  1128. - a cons cell (:todo . \"KEYWORD\") to identify refile targets by
  1129. todo keyword.
  1130. - a cons cell (:regexp . \"REGEXP\") with a regular expression matching
  1131. headlines that are refiling targets.
  1132. - a cons cell (:level . N). Any headline of level N is considered a target.
  1133. - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
  1134. When this variable is nil, all top-level headlines in the current buffer
  1135. are used, equivalent to the vlaue `((nil . (:level . 1))'."
  1136. :group 'org-remember
  1137. :type '(repeat
  1138. (cons
  1139. (choice :value org-agenda-files
  1140. (const :tag "All agenda files" org-agenda-files)
  1141. (const :tag "Current buffer" nil)
  1142. (function) (variable) (file))
  1143. (choice :tag "Identify target headline by"
  1144. (cons :tag "Specific tag" (const :tag) (string))
  1145. (cons :tag "TODO keyword" (const :todo) (string))
  1146. (cons :tag "Regular expression" (const :regexp) (regexp))
  1147. (cons :tag "Level number" (const :level) (integer))
  1148. (cons :tag "Max Level number" (const :maxlevel) (integer))))))
  1149. (defcustom org-refile-use-outline-path nil
  1150. "Non-nil means, provide refile targets as paths.
  1151. So a level 3 headline will be available as level1/level2/level3.
  1152. When the value is `file', also include the file name (without directory)
  1153. into the path. When `full-file-path', include the full file path."
  1154. :group 'org-remember
  1155. :type '(choice
  1156. (const :tag "Not" nil)
  1157. (const :tag "Yes" t)
  1158. (const :tag "Start with file name" file)
  1159. (const :tag "Start with full file path" full-file-path)))
  1160. (defgroup org-todo nil
  1161. "Options concerning TODO items in Org-mode."
  1162. :tag "Org TODO"
  1163. :group 'org)
  1164. (defgroup org-progress nil
  1165. "Options concerning Progress logging in Org-mode."
  1166. :tag "Org Progress"
  1167. :group 'org-time)
  1168. (defcustom org-todo-keywords '((sequence "TODO" "DONE"))
  1169. "List of TODO entry keyword sequences and their interpretation.
  1170. \\<org-mode-map>This is a list of sequences.
  1171. Each sequence starts with a symbol, either `sequence' or `type',
  1172. indicating if the keywords should be interpreted as a sequence of
  1173. action steps, or as different types of TODO items. The first
  1174. keywords are states requiring action - these states will select a headline
  1175. for inclusion into the global TODO list Org-mode produces. If one of
  1176. the \"keywords\" is the vertical bat \"|\" the remaining keywords
  1177. signify that no further action is necessary. If \"|\" is not found,
  1178. the last keyword is treated as the only DONE state of the sequence.
  1179. The command \\[org-todo] cycles an entry through these states, and one
  1180. additional state where no keyword is present. For details about this
  1181. cycling, see the manual.
  1182. TODO keywords and interpretation can also be set on a per-file basis with
  1183. the special #+SEQ_TODO and #+TYP_TODO lines.
  1184. Each keyword can optionally specify a character for fast state selection
  1185. \(in combination with the variable `org-use-fast-todo-selection')
  1186. and specifiers for state change logging, using the same syntax
  1187. that is used in the \"#+TODO:\" lines. For example, \"WAIT(w)\" says
  1188. that the WAIT state can be selected with the \"w\" key. \"WAIT(w!)\"
  1189. indicates to record a time stamp each time this state is selected.
  1190. Each keyword may also specify if a timestamp or a note should be
  1191. recorded when entering or leaving the state, by adding additional
  1192. characters in the parenthesis after the keyword. This looks like this:
  1193. \"WAIT(w@/!)\". \"@\" means to add a note (with time), \"!\" means to
  1194. record only the time of the state change. With X and Y being either
  1195. \"@\" or \"!\", \"X/Y\" means use X when entering the state, and use
  1196. Y when leaving the state if and only if the *target* state does not
  1197. define X. You may omit any of the fast-selection key or X or /Y,
  1198. so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
  1199. For backward compatibility, this variable may also be just a list
  1200. of keywords - in this case the interptetation (sequence or type) will be
  1201. taken from the (otherwise obsolete) variable `org-todo-interpretation'."
  1202. :group 'org-todo
  1203. :group 'org-keywords
  1204. :type '(choice
  1205. (repeat :tag "Old syntax, just keywords"
  1206. (string :tag "Keyword"))
  1207. (repeat :tag "New syntax"
  1208. (cons
  1209. (choice
  1210. :tag "Interpretation"
  1211. (const :tag "Sequence (cycling hits every state)" sequence)
  1212. (const :tag "Type (cycling directly to DONE)" type))
  1213. (repeat
  1214. (string :tag "Keyword"))))))
  1215. (defvar org-todo-keywords-1 nil
  1216. "All TODO and DONE keywords active in a buffer.")
  1217. (make-variable-buffer-local 'org-todo-keywords-1)
  1218. (defvar org-todo-keywords-for-agenda nil)
  1219. (defvar org-done-keywords-for-agenda nil)
  1220. (defvar org-todo-keyword-alist-for-agenda nil)
  1221. (defvar org-tag-alist-for-agenda nil)
  1222. (defvar org-agenda-contributing-files nil)
  1223. (defvar org-not-done-keywords nil)
  1224. (make-variable-buffer-local 'org-not-done-keywords)
  1225. (defvar org-done-keywords nil)
  1226. (make-variable-buffer-local 'org-done-keywords)
  1227. (defvar org-todo-heads nil)
  1228. (make-variable-buffer-local 'org-todo-heads)
  1229. (defvar org-todo-sets nil)
  1230. (make-variable-buffer-local 'org-todo-sets)
  1231. (defvar org-todo-log-states nil)
  1232. (make-variable-buffer-local 'org-todo-log-states)
  1233. (defvar org-todo-kwd-alist nil)
  1234. (make-variable-buffer-local 'org-todo-kwd-alist)
  1235. (defvar org-todo-key-alist nil)
  1236. (make-variable-buffer-local 'org-todo-key-alist)
  1237. (defvar org-todo-key-trigger nil)
  1238. (make-variable-buffer-local 'org-todo-key-trigger)
  1239. (defcustom org-todo-interpretation 'sequence
  1240. "Controls how TODO keywords are interpreted.
  1241. This variable is in principle obsolete and is only used for
  1242. backward compatibility, if the interpretation of todo keywords is
  1243. not given already in `org-todo-keywords'. See that variable for
  1244. more information."
  1245. :group 'org-todo
  1246. :group 'org-keywords
  1247. :type '(choice (const sequence)
  1248. (const type)))
  1249. (defcustom org-use-fast-todo-selection 'prefix
  1250. "Non-nil means, use the fast todo selection scheme with C-c C-t.
  1251. This variable describes if and under what circumstances the cycling
  1252. mechanism for TODO keywords will be replaced by a single-key, direct
  1253. selection scheme.
  1254. When nil, fast selection is never used.
  1255. When the symbol `prefix', it will be used when `org-todo' is called with
  1256. a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
  1257. in an agenda buffer.
  1258. When t, fast selection is used by default. In this case, the prefix
  1259. argument forces cycling instead.
  1260. In all cases, the special interface is only used if access keys have actually
  1261. been assigned by the user, i.e. if keywords in the configuration are followed
  1262. by a letter in parenthesis, like TODO(t)."
  1263. :group 'org-todo
  1264. :type '(choice
  1265. (const :tag "Never" nil)
  1266. (const :tag "By default" t)
  1267. (const :tag "Only with C-u C-c C-t" prefix)))
  1268. (defcustom org-provide-todo-statistics t
  1269. "Non-nil means, update todo statistics after insert and toggle.
  1270. When this is set, todo statistics is updated in the parent of the current
  1271. entry each time a todo state is changed."
  1272. :group 'org-todo
  1273. :type 'boolean)
  1274. (defcustom org-after-todo-state-change-hook nil
  1275. "Hook which is run after the state of a TODO item was changed.
  1276. The new state (a string with a TODO keyword, or nil) is available in the
  1277. Lisp variable `state'."
  1278. :group 'org-todo
  1279. :type 'hook)
  1280. (defcustom org-log-done nil
  1281. "Non-nil means, record a CLOSED timestamp when moving an entry to DONE.
  1282. When equal to the list (done), also prompt for a closing note.
  1283. This can also be configured on a per-file basis by adding one of
  1284. the following lines anywhere in the buffer:
  1285. #+STARTUP: logdone
  1286. #+STARTUP: lognotedone
  1287. #+STARTUP: nologdone"
  1288. :group 'org-todo
  1289. :group 'org-progress
  1290. :type '(choice
  1291. (const :tag "No logging" nil)
  1292. (const :tag "Record CLOSED timestamp" time)
  1293. (const :tag "Record CLOSED timestamp with closing note." note)))
  1294. ;; Normalize old uses of org-log-done.
  1295. (cond
  1296. ((eq org-log-done t) (setq org-log-done 'time))
  1297. ((and (listp org-log-done) (memq 'done org-log-done))
  1298. (setq org-log-done 'note)))
  1299. (defcustom org-log-note-clock-out nil
  1300. "Non-nil means, record a note when clocking out of an item.
  1301. This can also be configured on a per-file basis by adding one of
  1302. the following lines anywhere in the buffer:
  1303. #+STARTUP: lognoteclock-out
  1304. #+STARTUP: nolognoteclock-out"
  1305. :group 'org-todo
  1306. :group 'org-progress
  1307. :type 'boolean)
  1308. (defcustom org-log-done-with-time t
  1309. "Non-nil means, the CLOSED time stamp will contain date and time.
  1310. When nil, only the date will be recorded."
  1311. :group 'org-progress
  1312. :type 'boolean)
  1313. (defcustom org-log-note-headings
  1314. '((done . "CLOSING NOTE %t")
  1315. (state . "State %-12s %t")
  1316. (note . "Note taken on %t")
  1317. (clock-out . ""))
  1318. "Headings for notes added to entries.
  1319. The value is an alist, with the car being a symbol indicating the note
  1320. context, and the cdr is the heading to be used. The heading may also be the
  1321. empty string.
  1322. %t in the heading will be replaced by a time stamp.
  1323. %s will be replaced by the new TODO state, in double quotes.
  1324. %u will be replaced by the user name.
  1325. %U will be replaced by the full user name."
  1326. :group 'org-todo
  1327. :group 'org-progress
  1328. :type '(list :greedy t
  1329. (cons (const :tag "Heading when closing an item" done) string)
  1330. (cons (const :tag
  1331. "Heading when changing todo state (todo sequence only)"
  1332. state) string)
  1333. (cons (const :tag "Heading when just taking a note" note) string)
  1334. (cons (const :tag "Heading when clocking out" clock-out) string)))
  1335. (unless (assq 'note org-log-note-headings)
  1336. (push '(note . "%t") org-log-note-headings))
  1337. (defcustom org-log-states-order-reversed t
  1338. "Non-nil means, the latest state change note will be directly after heading.
  1339. When nil, the notes will be orderer according to time."
  1340. :group 'org-todo
  1341. :group 'org-progress
  1342. :type 'boolean)
  1343. (defcustom org-log-repeat 'time
  1344. "Non-nil means, record moving through the DONE state when triggering repeat.
  1345. An auto-repeating tasks is immediately switched back to TODO when marked
  1346. done. If you are not logging state changes (by adding \"@\" or \"!\" to
  1347. the TODO keyword definition, or recording a closing note by setting
  1348. `org-log-done', there will be no record of the task moving through DONE.
  1349. This variable forces taking a note anyway. Possible values are:
  1350. nil Don't force a record
  1351. time Record a time stamp
  1352. note Record a note
  1353. This option can also be set with on a per-file-basis with
  1354. #+STARTUP: logrepeat
  1355. #+STARTUP: lognoterepeat
  1356. #+STARTUP: nologrepeat
  1357. You can have local logging settings for a subtree by setting the LOGGING
  1358. property to one or more of these keywords."
  1359. :group 'org-todo
  1360. :group 'org-progress
  1361. :type '(choice
  1362. (const :tag "Don't force a record" nil)
  1363. (const :tag "Force recording the DONE state" time)
  1364. (const :tag "Force recording a note with the DONE state" note)))
  1365. (defgroup org-priorities nil
  1366. "Priorities in Org-mode."
  1367. :tag "Org Priorities"
  1368. :group 'org-todo)
  1369. (defcustom org-highest-priority ?A
  1370. "The highest priority of TODO items. A character like ?A, ?B etc.
  1371. Must have a smaller ASCII number than `org-lowest-priority'."
  1372. :group 'org-priorities
  1373. :type 'character)
  1374. (defcustom org-lowest-priority ?C
  1375. "The lowest priority of TODO items. A character like ?A, ?B etc.
  1376. Must have a larger ASCII number than `org-highest-priority'."
  1377. :group 'org-priorities
  1378. :type 'character)
  1379. (defcustom org-default-priority ?B
  1380. "The default priority of TODO items.
  1381. This is the priority an item get if no explicit priority is given."
  1382. :group 'org-priorities
  1383. :type 'character)
  1384. (defcustom org-priority-start-cycle-with-default t
  1385. "Non-nil means, start with default priority when starting to cycle.
  1386. When this is nil, the first step in the cycle will be (depending on the
  1387. command used) one higher or lower that the default priority."
  1388. :group 'org-priorities
  1389. :type 'boolean)
  1390. (defgroup org-time nil
  1391. "Options concerning time stamps and deadlines in Org-mode."
  1392. :tag "Org Time"
  1393. :group 'org)
  1394. (defcustom org-insert-labeled-timestamps-at-point nil
  1395. "Non-nil means, SCHEDULED and DEADLINE timestamps are inserted at point.
  1396. When nil, these labeled time stamps are forces into the second line of an
  1397. entry, just after the headline. When scheduling from the global TODO list,
  1398. the time stamp will always be forced into the second line."
  1399. :group 'org-time
  1400. :type 'boolean)
  1401. (defconst org-time-stamp-formats '("<%Y-%m-%d %a>" . "<%Y-%m-%d %a %H:%M>")
  1402. "Formats for `format-time-string' which are used for time stamps.
  1403. It is not recommended to change this constant.")
  1404. (defcustom org-time-stamp-rounding-minutes '(0 5)
  1405. "Number of minutes to round time stamps to.
  1406. These are two values, the first applies when first creating a time stamp.
  1407. The second applies when changing it with the commands `S-up' and `S-down'.
  1408. When changing the time stamp, this means that it will change in steps
  1409. of N minutes, as given by the second value.
  1410. When a setting is 0 or 1, insert the time unmodified. Useful rounding
  1411. numbers should be factors of 60, so for example 5, 10, 15.
  1412. When this is larger than 1, you can still force an exact time-stamp by using
  1413. a double prefix argument to a time-stamp command like `C-c .' or `C-c !',
  1414. and by using a prefix arg to `S-up/down' to specify the exact number
  1415. of minutes to shift."
  1416. :group 'org-time
  1417. :get '(lambda (var) ; Make sure all entries have 5 elements
  1418. (if (integerp (default-value var))
  1419. (list (default-value var) 5)
  1420. (default-value var)))
  1421. :type '(list
  1422. (integer :tag "when inserting times")
  1423. (integer :tag "when modifying times")))
  1424. ;; Normalize old customizations of this variable.
  1425. (when (integerp org-time-stamp-rounding-minutes)
  1426. (setq org-time-stamp-rounding-minutes
  1427. (list org-time-stamp-rounding-minutes
  1428. org-time-stamp-rounding-minutes)))
  1429. (defcustom org-display-custom-times nil
  1430. "Non-nil means, overlay custom formats over all time stamps.
  1431. The formats are defined through the variable `org-time-stamp-custom-formats'.
  1432. To turn this on on a per-file basis, insert anywhere in the file:
  1433. #+STARTUP: customtime"
  1434. :group 'org-time
  1435. :set 'set-default
  1436. :type 'sexp)
  1437. (make-variable-buffer-local 'org-display-custom-times)
  1438. (defcustom org-time-stamp-custom-formats
  1439. '("<%m/%d/%y %a>" . "<%m/%d/%y %a %H:%M>") ; american
  1440. "Custom formats for time stamps. See `format-time-string' for the syntax.
  1441. These are overlayed over the default ISO format if the variable
  1442. `org-display-custom-times' is set. Time like %H:%M should be at the
  1443. end of the second format."
  1444. :group 'org-time
  1445. :type 'sexp)
  1446. (defun org-time-stamp-format (&optional long inactive)
  1447. "Get the right format for a time string."
  1448. (let ((f (if long (cdr org-time-stamp-formats)
  1449. (car org-time-stamp-formats))))
  1450. (if inactive
  1451. (concat "[" (substring f 1 -1) "]")
  1452. f)))
  1453. (defcustom org-time-clocksum-format "%d:%02d"
  1454. "The format string used when creating CLOCKSUM lines, or when
  1455. org-mode generates a time duration."
  1456. :group 'org-time
  1457. :type 'string)
  1458. (defcustom org-deadline-warning-days 14
  1459. "No. of days before expiration during which a deadline becomes active.
  1460. This variable governs the display in sparse trees and in the agenda.
  1461. When 0 or negative, it means use this number (the absolute value of it)
  1462. even if a deadline has a different individual lead time specified."
  1463. :group 'org-time
  1464. :group 'org-agenda-daily/weekly
  1465. :type 'number)
  1466. (defcustom org-read-date-prefer-future t
  1467. "Non-nil means, assume future for incomplete date input from user.
  1468. This affects the following situations:
  1469. 1. The user gives a day, but no month.
  1470. For example, if today is the 15th, and you enter \"3\", Org-mode will
  1471. read this as the third of *next* month. However, if you enter \"17\",
  1472. it will be considered as *this* month.
  1473. 2. The user gives a month but not a year.
  1474. For example, if it is april and you enter \"feb 2\", this will be read
  1475. as feb 2, *next* year. \"May 5\", however, will be this year.
  1476. Currently this does not work for ISO week specifications.
  1477. When this option is nil, the current month and year will always be used
  1478. as defaults."
  1479. :group 'org-time
  1480. :type 'boolean)
  1481. (defcustom org-read-date-display-live t
  1482. "Non-nil means, display current interpretation of date prompt live.
  1483. This display will be in an overlay, in the minibuffer."
  1484. :group 'org-time
  1485. :type 'boolean)
  1486. (defcustom org-read-date-popup-calendar t
  1487. "Non-nil means, pop up a calendar when prompting for a date.
  1488. In the calendar, the date can be selected with mouse-1. However, the
  1489. minibuffer will also be active, and you can simply enter the date as well.
  1490. When nil, only the minibuffer will be available."
  1491. :group 'org-time
  1492. :type 'boolean)
  1493. (if (fboundp 'defvaralias)
  1494. (defvaralias 'org-popup-calendar-for-date-prompt
  1495. 'org-read-date-popup-calendar))
  1496. (defcustom org-extend-today-until 0
  1497. "The hour when your day really ends. Must be an integer.
  1498. This has influence for the following applications:
  1499. - When switching the agenda to \"today\". It it is still earlier than
  1500. the time given here, the day recognized as TODAY is actually yesterday.
  1501. - When a date is read from the user and it is still before the time given
  1502. here, the current date and time will be assumed to be yesterday, 23:59.
  1503. Also, timestamps inserted in remember templates follow this rule.
  1504. IMPORTANT: This is a feature whose implementation is and likely will
  1505. remain incomplete. Really, it is only here because past midnight seems to
  1506. ne the favorite working time of John Wiegley :-)"
  1507. :group 'org-time
  1508. :type 'number)
  1509. (defcustom org-edit-timestamp-down-means-later nil
  1510. "Non-nil means, S-down will increase the time in a time stamp.
  1511. When nil, S-up will increase."
  1512. :group 'org-time
  1513. :type 'boolean)
  1514. (defcustom org-calendar-follow-timestamp-change t
  1515. "Non-nil means, make the calendar window follow timestamp changes.
  1516. When a timestamp is modified and the calendar window is visible, it will be
  1517. moved to the new date."
  1518. :group 'org-time
  1519. :type 'boolean)
  1520. (defgroup org-tags nil
  1521. "Options concerning tags in Org-mode."
  1522. :tag "Org Tags"
  1523. :group 'org)
  1524. (defcustom org-tag-alist nil
  1525. "List of tags allowed in Org-mode files.
  1526. When this list is nil, Org-mode will base TAG input on what is already in the
  1527. buffer.
  1528. The value of this variable is an alist, the car of each entry must be a
  1529. keyword as a string, the cdr may be a character that is used to select
  1530. that tag through the fast-tag-selection interface.
  1531. See the manual for details."
  1532. :group 'org-tags
  1533. :type '(repeat
  1534. (choice
  1535. (cons (string :tag "Tag name")
  1536. (character :tag "Access char"))
  1537. (const :tag "Start radio group" (:startgroup))
  1538. (const :tag "End radio group" (:endgroup)))))
  1539. (defvar org-file-tags nil
  1540. "List of tags that can be inherited by all entries in the file.
  1541. The tags will be inherited if the variable `org-use-tag-inheritance'
  1542. says they should be.
  1543. This variable is populated from #+TAG lines.")
  1544. (defcustom org-use-fast-tag-selection 'auto
  1545. "Non-nil means, use fast tag selection scheme.
  1546. This is a special interface to select and deselect tags with single keys.
  1547. When nil, fast selection is never used.
  1548. When the symbol `auto', fast selection is used if and only if selection
  1549. characters for tags have been configured, either through the variable
  1550. `org-tag-alist' or through a #+TAGS line in the buffer.
  1551. When t, fast selection is always used and selection keys are assigned
  1552. automatically if necessary."
  1553. :group 'org-tags
  1554. :type '(choice
  1555. (const :tag "Always" t)
  1556. (const :tag "Never" nil)
  1557. (const :tag "When selection characters are configured" 'auto)))
  1558. (defcustom org-fast-tag-selection-single-key nil
  1559. "Non-nil means, fast tag selection exits after first change.
  1560. When nil, you have to press RET to exit it.
  1561. During fast tag selection, you can toggle this flag with `C-c'.
  1562. This variable can also have the value `expert'. In this case, the window
  1563. displaying the tags menu is not even shown, until you press C-c again."
  1564. :group 'org-tags
  1565. :type '(choice
  1566. (const :tag "No" nil)
  1567. (const :tag "Yes" t)
  1568. (const :tag "Expert" expert)))
  1569. (defvar org-fast-tag-selection-include-todo nil
  1570. "Non-nil means, fast tags selection interface will also offer TODO states.
  1571. This is an undocumented feature, you should not rely on it.")
  1572. (defcustom org-tags-column (if (featurep 'xemacs) -79 -80)
  1573. "The column to which tags should be indented in a headline.
  1574. If this number is positive, it specifies the column. If it is negative,
  1575. it means that the tags should be flushright to that column. For example,
  1576. -80 works well for a normal 80 character screen."
  1577. :group 'org-tags
  1578. :type 'integer)
  1579. (defcustom org-auto-align-tags t
  1580. "Non-nil means, realign tags after pro/demotion of TODO state change.
  1581. These operations change the length of a headline and therefore shift
  1582. the tags around. With this options turned on, after each such operation
  1583. the tags are again aligned to `org-tags-column'."
  1584. :group 'org-tags
  1585. :type 'boolean)
  1586. (defcustom org-use-tag-inheritance t
  1587. "Non-nil means, tags in levels apply also for sublevels.
  1588. When nil, only the tags directly given in a specific line apply there.
  1589. If this option is t, a match early-on in a tree can lead to a large
  1590. number of matches in the subtree. If you only want to see the first
  1591. match in a tree during a search, check out the variable
  1592. `org-tags-match-list-sublevels'.
  1593. This may also be a list of tags that should be inherited, or a regexp that
  1594. matches tags that should be inherited."
  1595. :group 'org-tags
  1596. :type '(choice
  1597. (const :tag "Not" nil)
  1598. (const :tag "Always" t)
  1599. (repeat :tag "Specific tags" (string :tag "Tag"))
  1600. (regexp :tag "Tags matched by regexp")))
  1601. (defun org-tag-inherit-p (tag)
  1602. "Check if TAG is one that should be inherited."
  1603. (cond
  1604. ((eq org-use-tag-inheritance t) t)
  1605. ((not org-use-tag-inheritance) nil)
  1606. ((stringp org-use-tag-inheritance)
  1607. (string-match org-use-tag-inheritance tag))
  1608. ((listp org-use-tag-inheritance)
  1609. (member tag org-use-tag-inheritance))
  1610. (t (error "Invalid setting of `org-use-tag-inheritance'"))))
  1611. (defcustom org-tags-match-list-sublevels t
  1612. "Non-nil means list also sublevels of headlines matching tag search.
  1613. Because of tag inheritance (see variable `org-use-tag-inheritance'),
  1614. the sublevels of a headline matching a tag search often also match
  1615. the same search. Listing all of them can create very long lists.
  1616. Setting this variable to nil causes subtrees of a match to be skipped.
  1617. This option is off by default, because inheritance in on. If you turn
  1618. inheritance off, you very likely want to turn this option on.
  1619. As a special case, if the tag search is restricted to TODO items, the
  1620. value of this variable is ignored and sublevels are always checked, to
  1621. make sure all corresponding TODO items find their way into the list."
  1622. :group 'org-tags
  1623. :type 'boolean)
  1624. (defvar org-tags-history nil
  1625. "History of minibuffer reads for tags.")
  1626. (defvar org-last-tags-completion-table nil
  1627. "The last used completion table for tags.")
  1628. (defvar org-after-tags-change-hook nil
  1629. "Hook that is run after the tags in a line have changed.")
  1630. (defgroup org-properties nil
  1631. "Options concerning properties in Org-mode."
  1632. :tag "Org Properties"
  1633. :group 'org)
  1634. (defcustom org-property-format "%-10s %s"
  1635. "How property key/value pairs should be formatted by `indent-line'.
  1636. When `indent-line' hits a property definition, it will format the line
  1637. according to this format, mainly to make sure that the values are
  1638. lined-up with respect to each other."
  1639. :group 'org-properties
  1640. :type 'string)
  1641. (defcustom org-use-property-inheritance nil
  1642. "Non-nil means, properties apply also for sublevels.
  1643. This setting is chiefly used during property searches. Turning it on can
  1644. cause significant overhead when doing a search, which is why it is not
  1645. on by default.
  1646. When nil, only the properties directly given in the current entry count.
  1647. When t, every property is inherited. The value may also be a list of
  1648. properties that should have inheritance, or a regular expression matching
  1649. properties that should be inherited.
  1650. However, note that some special properties use inheritance under special
  1651. circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
  1652. and the properties ending in \"_ALL\" when they are used as descriptor
  1653. for valid values of a property.
  1654. Note for programmers:
  1655. When querying an entry with `org-entry-get', you can control if inheritance
  1656. should be used. By default, `org-entry-get' looks only at the local
  1657. properties. You can request inheritance by setting the inherit argument
  1658. to t (to force inheritance) or to `selective' (to respect the setting
  1659. in this variable)."
  1660. :group 'org-properties
  1661. :type '(choice
  1662. (const :tag "Not" nil)
  1663. (const :tag "Always" t)
  1664. (repeat :tag "Specific properties" (string :tag "Property"))
  1665. (regexp :tag "Properties matched by regexp")))
  1666. (defun org-property-inherit-p (property)
  1667. "Check if PROPERTY is one that should be inherited."
  1668. (cond
  1669. ((eq org-use-property-inheritance t) t)
  1670. ((not org-use-property-inheritance) nil)
  1671. ((stringp org-use-property-inheritance)
  1672. (string-match org-use-property-inheritance property))
  1673. ((listp org-use-property-inheritance)
  1674. (member property org-use-property-inheritance))
  1675. (t (error "Invalid setting of `org-use-property-inheritance'"))))
  1676. (defcustom org-columns-default-format "%25ITEM %TODO %3PRIORITY %TAGS"
  1677. "The default column format, if no other format has been defined.
  1678. This variable can be set on the per-file basis by inserting a line
  1679. #+COLUMNS: %25ITEM ....."
  1680. :group 'org-properties
  1681. :type 'string)
  1682. (defcustom org-columns-ellipses ".."
  1683. "The ellipses to be used when a field in column view is truncated.
  1684. When this is the empty string, as many characters as possible are shown,
  1685. but then there will be no visual indication that the field has been truncated.
  1686. When this is a string of length N, the last N characters of a truncated
  1687. field are replaced by this string. If the column is narrower than the
  1688. ellipses string, only part of the ellipses string will be shown."
  1689. :group 'org-properties
  1690. :type 'string)
  1691. (defcustom org-columns-modify-value-for-display-function nil
  1692. "Function that modifies values for display in column view.
  1693. For example, it can be used to cut out a certain part from a time stamp.
  1694. The function must take 2 argments:
  1695. column-title The tite of the column (*not* the property name)
  1696. value The value that should be modified.
  1697. The function should return the value that should be displayed,
  1698. or nil if the normal value should be used."
  1699. :group 'org-properties
  1700. :type 'function)
  1701. (defcustom org-effort-property "Effort"
  1702. "The property that is being used to keep track of effort estimates.
  1703. Effort estimates given in this property need to have the format H:MM."
  1704. :group 'org-properties
  1705. :group 'org-progress
  1706. :type '(string :tag "Property"))
  1707. (defconst org-global-properties-fixed
  1708. '(("VISIBILITY_ALL" . "folded children content all"))
  1709. "List of property/value pairs that can be inherited by any entry.
  1710. These are fixed values, for the preset properties.")
  1711. (defcustom org-global-properties nil
  1712. "List of property/value pairs that can be inherited by any entry.
  1713. You can set buffer-local values for this by adding lines like
  1714. #+PROPERTY: NAME VALUE"
  1715. :group 'org-properties
  1716. :type '(repeat
  1717. (cons (string :tag "Property")
  1718. (string :tag "Value"))))
  1719. (defvar org-file-properties nil
  1720. "List of property/value pairs that can be inherited by any entry.
  1721. Valid for the current buffer.
  1722. This variable is populated from #+PROPERTY lines.")
  1723. (make-variable-buffer-local 'org-file-properties)
  1724. (defgroup org-agenda nil
  1725. "Options concerning agenda views in Org-mode."
  1726. :tag "Org Agenda"
  1727. :group 'org)
  1728. (defvar org-category nil
  1729. "Variable used by org files to set a category for agenda display.
  1730. Such files should use a file variable to set it, for example
  1731. # -*- mode: org; org-category: \"ELisp\"
  1732. or contain a special line
  1733. #+CATEGORY: ELisp
  1734. If the file does not specify a category, then file's base name
  1735. is used instead.")
  1736. (make-variable-buffer-local 'org-category)
  1737. (put 'org-category 'safe-local-variable '(lambda (x) (or (symbolp x) (stringp x))))
  1738. (defcustom org-agenda-files nil
  1739. "The files to be used for agenda display.
  1740. Entries may be added to this list with \\[org-agenda-file-to-front] and removed with
  1741. \\[org-remove-file]. You can also use customize to edit the list.
  1742. If an entry is a directory, all files in that directory that are matched by
  1743. `org-agenda-file-regexp' will be part of the file list.
  1744. If the value of the variable is not a list but a single file name, then
  1745. the list of agenda files is actually stored and maintained in that file, one
  1746. agenda file per line."
  1747. :group 'org-agenda
  1748. :type '(choice
  1749. (repeat :tag "List of files and directories" file)
  1750. (file :tag "Store list in a file\n" :value "~/.agenda_files")))
  1751. (defcustom org-agenda-file-regexp "\\`[^.].*\\.org\\'"
  1752. "Regular expression to match files for `org-agenda-files'.
  1753. If any element in the list in that variable contains a directory instead
  1754. of a normal file, all files in that directory that are matched by this
  1755. regular expression will be included."
  1756. :group 'org-agenda
  1757. :type 'regexp)
  1758. (defcustom org-agenda-text-search-extra-files nil
  1759. "List of extra files to be searched by text search commands.
  1760. These files will be search in addition to the agenda files by the
  1761. commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
  1762. Note that these files will only be searched for text search commands,
  1763. not for the other agenda views like todo lists, tag searches or the weekly
  1764. agenda. This variable is intended to list notes and possibly archive files
  1765. that should also be searched by these two commands.
  1766. In fact, if the first element in the list is the symbol `agenda-archives',
  1767. than all archive files of all agenda files will be added to the search
  1768. scope."
  1769. :group 'org-agenda
  1770. :type '(set :greedy t
  1771. (const :tag "Agenda Archives" agenda-archives)
  1772. (repeat :inline t (file))))
  1773. (if (fboundp 'defvaralias)
  1774. (defvaralias 'org-agenda-multi-occur-extra-files
  1775. 'org-agenda-text-search-extra-files))
  1776. (defcustom org-agenda-skip-unavailable-files nil
  1777. "Non-nil means to just skip non-reachable files in `org-agenda-files'.
  1778. A nil value means to remove them, after a query, from the list."
  1779. :group 'org-agenda
  1780. :type 'boolean)
  1781. (defcustom org-calendar-to-agenda-key [?c]
  1782. "The key to be installed in `calendar-mode-map' for switching to the agenda.
  1783. The command `org-calendar-goto-agenda' will be bound to this key. The
  1784. default is the character `c' because then `c' can be used to switch back and
  1785. forth between agenda and calendar."
  1786. :group 'org-agenda
  1787. :type 'sexp)
  1788. (defcustom org-calendar-agenda-action-key [?k]
  1789. "The key to be installed in `calendar-mode-map' for agenda-action.
  1790. The command `org-agenda-action' will be bound to this key. The
  1791. default is the character `k' because we use the same key in the agenda."
  1792. :group 'org-agenda
  1793. :type 'sexp)
  1794. (eval-after-load "calendar"
  1795. '(progn
  1796. (org-defkey calendar-mode-map org-calendar-to-agenda-key
  1797. 'org-calendar-goto-agenda)
  1798. (org-defkey calendar-mode-map org-calendar-agenda-action-key
  1799. 'org-agenda-action)))
  1800. (defgroup org-latex nil
  1801. "Options for embedding LaTeX code into Org-mode."
  1802. :tag "Org LaTeX"
  1803. :group 'org)
  1804. (defcustom org-format-latex-options
  1805. '(:foreground default :background default :scale 1.0
  1806. :html-foreground "Black" :html-background "Transparent" :html-scale 1.0
  1807. :matchers ("begin" "$" "$$" "\\(" "\\["))
  1808. "Options for creating images from LaTeX fragments.
  1809. This is a property list with the following properties:
  1810. :foreground the foreground color for images embedded in Emacs, e.g. \"Black\".
  1811. `default' means use the foreground of the default face.
  1812. :background the background color, or \"Transparent\".
  1813. `default' means use the background of the default face.
  1814. :scale a scaling factor for the size of the images.
  1815. :html-foreground, :html-background, :html-scale
  1816. the same numbers for HTML export.
  1817. :matchers a list indicating which matchers should be used to
  1818. find LaTeX fragments. Valid members of this list are:
  1819. \"begin\" find environments
  1820. \"$\" find math expressions surrounded by $...$
  1821. \"$$\" find math expressions surrounded by $$....$$
  1822. \"\\(\" find math expressions surrounded by \\(...\\)
  1823. \"\\ [\" find math expressions surrounded by \\ [...\\]"
  1824. :group 'org-latex
  1825. :type 'plist)
  1826. (defcustom org-format-latex-header "\\documentclass{article}
  1827. \\usepackage{fullpage} % do not remove
  1828. \\usepackage{amssymb}
  1829. \\usepackage[usenames]{color}
  1830. \\usepackage{amsmath}
  1831. \\usepackage{latexsym}
  1832. \\usepackage[mathscr]{eucal}
  1833. \\pagestyle{empty} % do not remove"
  1834. "The document header used for processing LaTeX fragments."
  1835. :group 'org-latex
  1836. :type 'string)
  1837. (defgroup org-font-lock nil
  1838. "Font-lock settings for highlighting in Org-mode."
  1839. :tag "Org Font Lock"
  1840. :group 'org)
  1841. (defcustom org-level-color-stars-only nil
  1842. "Non-nil means fontify only the stars in each headline.
  1843. When nil, the entire headline is fontified.
  1844. Changing it requires restart of `font-lock-mode' to become effective
  1845. also in regions already fontified."
  1846. :group 'org-font-lock
  1847. :type 'boolean)
  1848. (defcustom org-hide-leading-stars nil
  1849. "Non-nil means, hide the first N-1 stars in a headline.
  1850. This works by using the face `org-hide' for these stars. This
  1851. face is white for a light background, and black for a dark
  1852. background. You may have to customize the face `org-hide' to
  1853. make this work.
  1854. Changing it requires restart of `font-lock-mode' to become effective
  1855. also in regions already fontified.
  1856. You may also set this on a per-file basis by adding one of the following
  1857. lines to the buffer:
  1858. #+STARTUP: hidestars
  1859. #+STARTUP: showstars"
  1860. :group 'org-font-lock
  1861. :type 'boolean)
  1862. (defcustom org-fontify-done-headline nil
  1863. "Non-nil means, change the face of a headline if it is marked DONE.
  1864. Normally, only the TODO/DONE keyword indicates the state of a headline.
  1865. When this is non-nil, the headline after the keyword is set to the
  1866. `org-headline-done' as an additional indication."
  1867. :group 'org-font-lock
  1868. :type 'boolean)
  1869. (defcustom org-fontify-emphasized-text t
  1870. "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
  1871. Changing this variable requires a restart of Emacs to take effect."
  1872. :group 'org-font-lock
  1873. :type 'boolean)
  1874. (defcustom org-highlight-latex-fragments-and-specials nil
  1875. "Non-nil means, fontify what is treated specially by the exporters."
  1876. :group 'org-font-lock
  1877. :type 'boolean)
  1878. (defcustom org-hide-emphasis-markers nil
  1879. "Non-nil mean font-lock should hide the emphasis marker characters."
  1880. :group 'org-font-lock
  1881. :type 'boolean)
  1882. (defvar org-emph-re nil
  1883. "Regular expression for matching emphasis.")
  1884. (defvar org-verbatim-re nil
  1885. "Regular expression for matching verbatim text.")
  1886. (defvar org-emphasis-regexp-components) ; defined just below
  1887. (defvar org-emphasis-alist) ; defined just below
  1888. (defun org-set-emph-re (var val)
  1889. "Set variable and compute the emphasis regular expression."
  1890. (set var val)
  1891. (when (and (boundp 'org-emphasis-alist)
  1892. (boundp 'org-emphasis-regexp-components)
  1893. org-emphasis-alist org-emphasis-regexp-components)
  1894. (let* ((e org-emphasis-regexp-components)
  1895. (pre (car e))
  1896. (post (nth 1 e))
  1897. (border (nth 2 e))
  1898. (body (nth 3 e))
  1899. (nl (nth 4 e))
  1900. (stacked (and nil (nth 5 e))) ; stacked is no longer allowed, forced to nil
  1901. (body1 (concat body "*?"))
  1902. (markers (mapconcat 'car org-emphasis-alist ""))
  1903. (vmarkers (mapconcat
  1904. (lambda (x) (if (eq (nth 4 x) 'verbatim) (car x) ""))
  1905. org-emphasis-alist "")))
  1906. ;; make sure special characters appear at the right position in the class
  1907. (if (string-match "\\^" markers)
  1908. (setq markers (concat (replace-match "" t t markers) "^")))
  1909. (if (string-match "-" markers)
  1910. (setq markers (concat (replace-match "" t t markers) "-")))
  1911. (if (string-match "\\^" vmarkers)
  1912. (setq vmarkers (concat (replace-match "" t t vmarkers) "^")))
  1913. (if (string-match "-" vmarkers)
  1914. (setq vmarkers (concat (replace-match "" t t vmarkers) "-")))
  1915. (if (> nl 0)
  1916. (setq body1 (concat body1 "\\(?:\n" body "*?\\)\\{0,"
  1917. (int-to-string nl) "\\}")))
  1918. ;; Make the regexp
  1919. (setq org-emph-re
  1920. (concat "\\([" pre (if (and nil stacked) markers) "]\\|^\\)"
  1921. "\\("
  1922. "\\([" markers "]\\)"
  1923. "\\("
  1924. "[^" border "]\\|"
  1925. "[^" border (if (and nil stacked) markers) "]"
  1926. body1
  1927. "[^" border (if (and nil stacked) markers) "]"
  1928. "\\)"
  1929. "\\3\\)"
  1930. "\\([" post (if (and nil stacked) markers) "]\\|$\\)"))
  1931. (setq org-verbatim-re
  1932. (concat "\\([" pre "]\\|^\\)"
  1933. "\\("
  1934. "\\([" vmarkers "]\\)"
  1935. "\\("
  1936. "[^" border "]\\|"
  1937. "[^" border "]"
  1938. body1
  1939. "[^" border "]"
  1940. "\\)"
  1941. "\\3\\)"
  1942. "\\([" post "]\\|$\\)")))))
  1943. (defcustom org-emphasis-regexp-components
  1944. '(" \t('\"" "- \t.,:?;'\")" " \t\r\n,\"'" "." 1)
  1945. "Components used to build the regular expression for emphasis.
  1946. This is a list with 6 entries. Terminology: In an emphasis string
  1947. like \" *strong word* \", we call the initial space PREMATCH, the final
  1948. space POSTMATCH, the stars MARKERS, \"s\" and \"d\" are BORDER characters
  1949. and \"trong wor\" is the body. The different components in this variable
  1950. specify what is allowed/forbidden in each part:
  1951. pre Chars allowed as prematch. Beginning of line will be allowed too.
  1952. post Chars allowed as postmatch. End of line will be allowed too.
  1953. border The chars *forbidden* as border characters.
  1954. body-regexp A regexp like \".\" to match a body character. Don't use
  1955. non-shy groups here, and don't allow newline here.
  1956. newline The maximum number of newlines allowed in an emphasis exp.
  1957. Use customize to modify this, or restart Emacs after changing it."
  1958. :group 'org-font-lock
  1959. :set 'org-set-emph-re
  1960. :type '(list
  1961. (sexp :tag "Allowed chars in pre ")
  1962. (sexp :tag "Allowed chars in post ")
  1963. (sexp :tag "Forbidden chars in border ")
  1964. (sexp :tag "Regexp for body ")
  1965. (integer :tag "number of newlines allowed")
  1966. (option (boolean :tag "Please ignore this button"))))
  1967. (defcustom org-emphasis-alist
  1968. `(("*" bold "<b>" "</b>")
  1969. ("/" italic "<i>" "</i>")
  1970. ("_" underline "<u>" "</u>")
  1971. ("=" org-code "<code>" "</code>" verbatim)
  1972. ("~" org-verbatim "" "" verbatim)
  1973. ("+" ,(if (featurep 'xemacs) 'org-table '(:strike-through t))
  1974. "<del>" "</del>")
  1975. )
  1976. "Special syntax for emphasized text.
  1977. Text starting and ending with a special character will be emphasized, for
  1978. example *bold*, _underlined_ and /italic/. This variable sets the marker
  1979. characters, the face to be used by font-lock for highlighting in Org-mode
  1980. Emacs buffers, and the HTML tags to be used for this.
  1981. Use customize to modify this, or restart Emacs after changing it."
  1982. :group 'org-font-lock
  1983. :set 'org-set-emph-re
  1984. :type '(repeat
  1985. (list
  1986. (string :tag "Marker character")
  1987. (choice
  1988. (face :tag "Font-lock-face")
  1989. (plist :tag "Face property list"))
  1990. (string :tag "HTML start tag")
  1991. (string :tag "HTML end tag")
  1992. (option (const verbatim)))))
  1993. ;;; Miscellaneous options
  1994. (defgroup org-completion nil
  1995. "Completion in Org-mode."
  1996. :tag "Org Completion"
  1997. :group 'org)
  1998. (defcustom org-completion-fallback-command 'hippie-expand
  1999. "The expansion command called by \\[org-complete] in normal context.
  2000. Normal means, no org-mode-specific context."
  2001. :group 'org-completion
  2002. :type 'function)
  2003. ;;; Functions and variables from ther packages
  2004. ;; Declared here to avoid compiler warnings
  2005. ;; XEmacs only
  2006. (defvar outline-mode-menu-heading)
  2007. (defvar outline-mode-menu-show)
  2008. (defvar outline-mode-menu-hide)
  2009. (defvar zmacs-regions) ; XEmacs regions
  2010. ;; Emacs only
  2011. (defvar mark-active)
  2012. ;; Various packages
  2013. (declare-function calendar-absolute-from-iso "cal-iso" (date))
  2014. (declare-function calendar-forward-day "cal-move" (arg))
  2015. (declare-function calendar-goto-date "cal-move" (date))
  2016. (declare-function calendar-goto-today "cal-move" ())
  2017. (declare-function calendar-iso-from-absolute "cal-iso" (date))
  2018. (defvar calc-embedded-close-formula)
  2019. (defvar calc-embedded-open-formula)
  2020. (declare-function cdlatex-tab "ext:cdlatex" ())
  2021. (declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
  2022. (defvar font-lock-unfontify-region-function)
  2023. (declare-function iswitchb-mode "iswitchb" (&optional arg))
  2024. (declare-function iswitchb-read-buffer (prompt &optional default require-match start matches-set))
  2025. (defvar iswitchb-temp-buflist)
  2026. (declare-function org-gnus-follow-link "org-gnus" (&optional group article))
  2027. (declare-function org-agenda-skip "org-agenda" ())
  2028. (declare-function org-format-agenda-item "org-agenda"
  2029. (extra txt &optional category tags dotime noprefix remove-re))
  2030. (declare-function org-agenda-new-marker "org-agenda" (&optional pos))
  2031. (declare-function org-agenda-change-all-lines "org-agenda"
  2032. (newhead hdmarker &optional fixface))
  2033. (declare-function org-agenda-set-restriction-lock "org-agenda" (&optional type))
  2034. (declare-function org-agenda-maybe-redo "org-agenda" ())
  2035. (declare-function org-agenda-save-markers-for-cut-and-paste "org-agenda"
  2036. (beg end))
  2037. (declare-function parse-time-string "parse-time" (string))
  2038. (declare-function remember "remember" (&optional initial))
  2039. (declare-function remember-buffer-desc "remember" ())
  2040. (declare-function remember-finalize "remember" ())
  2041. (defvar remember-save-after-remembering)
  2042. (defvar remember-data-file)
  2043. (defvar remember-register)
  2044. (defvar remember-buffer)
  2045. (defvar remember-handler-functions)
  2046. (defvar remember-annotation-functions)
  2047. (defvar texmathp-why)
  2048. (declare-function speedbar-line-directory "speedbar" (&optional depth))
  2049. (declare-function table--at-cell-p "table" (position &optional object at-column))
  2050. (defvar w3m-current-url)
  2051. (defvar w3m-current-title)
  2052. (defvar org-latex-regexps)
  2053. ;;; Autoload and prepare some org modules
  2054. ;; Some table stuff that needs to be defined here, because it is used
  2055. ;; by the functions setting up org-mode or checking for table context.
  2056. (defconst org-table-any-line-regexp "^[ \t]*\\(|\\|\\+-[-+]\\)"
  2057. "Detects an org-type or table-type table.")
  2058. (defconst org-table-line-regexp "^[ \t]*|"
  2059. "Detects an org-type table line.")
  2060. (defconst org-table-dataline-regexp "^[ \t]*|[^-]"
  2061. "Detects an org-type table line.")
  2062. (defconst org-table-hline-regexp "^[ \t]*|-"
  2063. "Detects an org-type table hline.")
  2064. (defconst org-table1-hline-regexp "^[ \t]*\\+-[-+]"
  2065. "Detects a table-type table hline.")
  2066. (defconst org-table-any-border-regexp "^[ \t]*[^|+ \t]"
  2067. "Searching from within a table (any type) this finds the first line
  2068. outside the table.")
  2069. ;; Autoload the functions in org-table.el that are needed by functions here.
  2070. (eval-and-compile
  2071. (org-autoload "org-table"
  2072. '(org-table-align org-table-begin org-table-blank-field
  2073. org-table-convert org-table-convert-region org-table-copy-down
  2074. org-table-copy-region org-table-create
  2075. org-table-create-or-convert-from-region
  2076. org-table-create-with-table.el org-table-current-dline
  2077. org-table-cut-region org-table-delete-column org-table-edit-field
  2078. org-table-edit-formulas org-table-end org-table-eval-formula
  2079. org-table-export org-table-field-info
  2080. org-table-get-stored-formulas org-table-goto-column
  2081. org-table-hline-and-move org-table-import org-table-insert-column
  2082. org-table-insert-hline org-table-insert-row org-table-iterate
  2083. org-table-justify-field-maybe org-table-kill-row
  2084. org-table-maybe-eval-formula org-table-maybe-recalculate-line
  2085. org-table-move-column org-table-move-column-left
  2086. org-table-move-column-right org-table-move-row
  2087. org-table-move-row-down org-table-move-row-up
  2088. org-table-next-field org-table-next-row org-table-paste-rectangle
  2089. org-table-previous-field org-table-recalculate
  2090. org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
  2091. org-table-toggle-coordinate-overlays
  2092. org-table-toggle-formula-debugger org-table-wrap-region
  2093. orgtbl-mode turn-on-orgtbl org-table-to-lisp)))
  2094. (defun org-at-table-p (&optional table-type)
  2095. "Return t if the cursor is inside an org-type table.
  2096. If TABLE-TYPE is non-nil, also check for table.el-type tables."
  2097. (if org-enable-table-editor
  2098. (save-excursion
  2099. (beginning-of-line 1)
  2100. (looking-at (if table-type org-table-any-line-regexp
  2101. org-table-line-regexp)))
  2102. nil))
  2103. (defsubst org-table-p () (org-at-table-p))
  2104. (defun org-at-table.el-p ()
  2105. "Return t if and only if we are at a table.el table."
  2106. (and (org-at-table-p 'any)
  2107. (save-excursion
  2108. (goto-char (org-table-begin 'any))
  2109. (looking-at org-table1-hline-regexp))))
  2110. (defun org-table-recognize-table.el ()
  2111. "If there is a table.el table nearby, recognize it and move into it."
  2112. (if org-table-tab-recognizes-table.el
  2113. (if (org-at-table.el-p)
  2114. (progn
  2115. (beginning-of-line 1)
  2116. (if (looking-at org-table-dataline-regexp)
  2117. nil
  2118. (if (looking-at org-table1-hline-regexp)
  2119. (progn
  2120. (beginning-of-line 2)
  2121. (if (looking-at org-table-any-border-regexp)
  2122. (beginning-of-line -1)))))
  2123. (if (re-search-forward "|" (org-table-end t) t)
  2124. (progn
  2125. (require 'table)
  2126. (if (table--at-cell-p (point))
  2127. t
  2128. (message "recognizing table.el table...")
  2129. (table-recognize-table)
  2130. (message "recognizing table.el table...done")))
  2131. (error "This should not happen..."))
  2132. t)
  2133. nil)
  2134. nil))
  2135. (defun org-at-table-hline-p ()
  2136. "Return t if the cursor is inside a hline in a table."
  2137. (if org-enable-table-editor
  2138. (save-excursion
  2139. (beginning-of-line 1)
  2140. (looking-at org-table-hline-regexp))
  2141. nil))
  2142. (defvar org-table-clean-did-remove-column nil)
  2143. (defun org-table-map-tables (function)
  2144. "Apply FUNCTION to the start of all tables in the buffer."
  2145. (save-excursion
  2146. (save-restriction
  2147. (widen)
  2148. (goto-char (point-min))
  2149. (while (re-search-forward org-table-any-line-regexp nil t)
  2150. (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size)))
  2151. (beginning-of-line 1)
  2152. (if (looking-at org-table-line-regexp)
  2153. (save-excursion (funcall function)))
  2154. (re-search-forward org-table-any-border-regexp nil 1))))
  2155. (message "Mapping tables: done"))
  2156. ;; Declare and autoload functions from org-exp.el
  2157. (declare-function org-default-export-plist "org-exp")
  2158. (declare-function org-infile-export-plist "org-exp")
  2159. (declare-function org-get-current-options "org-exp")
  2160. (eval-and-compile
  2161. (org-autoload "org-exp"
  2162. '(org-export org-export-as-ascii org-export-visible
  2163. org-insert-export-options-template org-export-as-html-and-open
  2164. org-export-as-html-batch org-export-as-html-to-buffer
  2165. org-replace-region-by-html org-export-region-as-html
  2166. org-export-as-html org-export-icalendar-this-file
  2167. org-export-icalendar-all-agenda-files
  2168. org-table-clean-before-export
  2169. org-export-icalendar-combine-agenda-files org-export-as-xoxo)))
  2170. ;; Declare and autoload functions from org-exp.el
  2171. (eval-and-compile
  2172. (org-autoload "org-exp"
  2173. '(org-agenda org-agenda-list org-search-view
  2174. org-todo-list org-tags-view org-agenda-list-stuck-projects
  2175. org-diary org-agenda-to-appt)))
  2176. ;; Autoload org-remember
  2177. (eval-and-compile
  2178. (org-autoload "org-remember"
  2179. '(org-remember-insinuate org-remember-annotation
  2180. org-remember-apply-template org-remember org-remember-handler)))
  2181. ;; Autoload org-clock.el
  2182. (declare-function org-clock-save-markers-for-cut-and-paste "org-clock"
  2183. (beg end))
  2184. (declare-function org-update-mode-line "org-clock" ())
  2185. (defvar org-clock-start-time)
  2186. (defvar org-clock-marker (make-marker)
  2187. "Marker recording the last clock-in.")
  2188. (eval-and-compile
  2189. (org-autoload
  2190. "org-clock"
  2191. '(org-clock-in org-clock-out org-clock-cancel
  2192. org-clock-goto org-clock-sum org-clock-display
  2193. org-remove-clock-overlays org-clock-report
  2194. org-clocktable-shift org-dblock-write:clocktable
  2195. org-get-clocktable)))
  2196. (defun org-clock-update-time-maybe ()
  2197. "If this is a CLOCK line, update it and return t.
  2198. Otherwise, return nil."
  2199. (interactive)
  2200. (save-excursion
  2201. (beginning-of-line 1)
  2202. (skip-chars-forward " \t")
  2203. (when (looking-at org-clock-string)
  2204. (let ((re (concat "[ \t]*" org-clock-string
  2205. " *[[<]\\([^]>]+\\)[]>]\\(-+[[<]\\([^]>]+\\)[]>]"
  2206. "\\([ \t]*=>.*\\)?\\)?"))
  2207. ts te h m s)
  2208. (cond
  2209. ((not (looking-at re))
  2210. nil)
  2211. ((not (match-end 2))
  2212. (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
  2213. (> org-clock-marker (point))
  2214. (<= org-clock-marker (point-at-eol)))
  2215. ;; The clock is running here
  2216. (setq org-clock-start-time
  2217. (apply 'encode-time
  2218. (org-parse-time-string (match-string 1))))
  2219. (org-update-mode-line)))
  2220. (t
  2221. (and (match-end 4) (delete-region (match-beginning 4) (match-end 4)))
  2222. (end-of-line 1)
  2223. (setq ts (match-string 1)
  2224. te (match-string 3))
  2225. (setq s (- (time-to-seconds
  2226. (apply 'encode-time (org-parse-time-string te)))
  2227. (time-to-seconds
  2228. (apply 'encode-time (org-parse-time-string ts))))
  2229. h (floor (/ s 3600))
  2230. s (- s (* 3600 h))
  2231. m (floor (/ s 60))
  2232. s (- s (* 60 s)))
  2233. (insert " => " (format "%2d:%02d" h m))
  2234. t))))))
  2235. (defun org-check-running-clock ()
  2236. "Check if the current buffer contains the running clock.
  2237. If yes, offer to stop it and to save the buffer with the changes."
  2238. (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
  2239. (y-or-n-p (format "Clock-out in buffer %s before killing it? "
  2240. (buffer-name))))
  2241. (org-clock-out)
  2242. (when (y-or-n-p "Save changed buffer?")
  2243. (save-buffer))))
  2244. (defun org-clocktable-try-shift (dir n)
  2245. "Check if this line starts a clock table, if yes, shift the time block."
  2246. (when (org-match-line "#\\+BEGIN: clocktable\\>")
  2247. (org-clocktable-shift dir n)))
  2248. ;; Autoload archiving code
  2249. ;; The stuff that is needed for cycling and tags has to be defined here.
  2250. (defgroup org-archive nil
  2251. "Options concerning archiving in Org-mode."
  2252. :tag "Org Archive"
  2253. :group 'org-structure)
  2254. (defcustom org-archive-location "%s_archive::"
  2255. "The location where subtrees should be archived.
  2256. Otherwise, the value of this variable is a string, consisting of two
  2257. parts, separated by a double-colon.
  2258. The first part is a file name - when omitted, archiving happens in the same
  2259. file. %s will be replaced by the current file name (without directory part).
  2260. Archiving to a different file is useful to keep archived entries from
  2261. contributing to the Org-mode Agenda.
  2262. The part after the double colon is a headline. The archived entries will be
  2263. filed under that headline. When omitted, the subtrees are simply filed away
  2264. at the end of the file, as top-level entries.
  2265. Here are a few examples:
  2266. \"%s_archive::\"
  2267. If the current file is Projects.org, archive in file
  2268. Projects.org_archive, as top-level trees. This is the default.
  2269. \"::* Archived Tasks\"
  2270. Archive in the current file, under the top-level headline
  2271. \"* Archived Tasks\".
  2272. \"~/org/archive.org::\"
  2273. Archive in file ~/org/archive.org (absolute path), as top-level trees.
  2274. \"basement::** Finished Tasks\"
  2275. Archive in file ./basement (relative path), as level 3 trees
  2276. below the level 2 heading \"** Finished Tasks\".
  2277. You may set this option on a per-file basis by adding to the buffer a
  2278. line like
  2279. #+ARCHIVE: basement::** Finished Tasks
  2280. You may also define it locally for a subtree by setting an ARCHIVE property
  2281. in the entry. If such a property is found in an entry, or anywhere up
  2282. the hierarchy, it will be used."
  2283. :group 'org-archive
  2284. :type 'string)
  2285. (defcustom org-archive-tag "ARCHIVE"
  2286. "The tag that marks a subtree as archived.
  2287. An archived subtree does not open during visibility cycling, and does
  2288. not contribute to the agenda listings.
  2289. After changing this, font-lock must be restarted in the relevant buffers to
  2290. get the proper fontification."
  2291. :group 'org-archive
  2292. :group 'org-keywords
  2293. :type 'string)
  2294. (defcustom org-agenda-skip-archived-trees t
  2295. "Non-nil means, the agenda will skip any items located in archived trees.
  2296. An archived tree is a tree marked with the tag ARCHIVE. The use of this
  2297. variable is no longer recommended, you should leave it at the value t.
  2298. Instead, use the key `v' to cycle the archives-mode in the agenda."
  2299. :group 'org-archive
  2300. :group 'org-agenda-skip
  2301. :type 'boolean)
  2302. (defcustom org-cycle-open-archived-trees nil
  2303. "Non-nil means, `org-cycle' will open archived trees.
  2304. An archived tree is a tree marked with the tag ARCHIVE.
  2305. When nil, archived trees will stay folded. You can still open them with
  2306. normal outline commands like `show-all', but not with the cycling commands."
  2307. :group 'org-archive
  2308. :group 'org-cycle
  2309. :type 'boolean)
  2310. (defcustom org-sparse-tree-open-archived-trees nil
  2311. "Non-nil means sparse tree construction shows matches in archived trees.
  2312. When nil, matches in these trees are highlighted, but the trees are kept in
  2313. collapsed state."
  2314. :group 'org-archive
  2315. :group 'org-sparse-trees
  2316. :type 'boolean)
  2317. (defun org-cycle-hide-archived-subtrees (state)
  2318. "Re-hide all archived subtrees after a visibility state change."
  2319. (when (and (not org-cycle-open-archived-trees)
  2320. (not (memq state '(overview folded))))
  2321. (save-excursion
  2322. (let* ((globalp (memq state '(contents all)))
  2323. (beg (if globalp (point-min) (point)))
  2324. (end (if globalp (point-max) (org-end-of-subtree t))))
  2325. (org-hide-archived-subtrees beg end)
  2326. (goto-char beg)
  2327. (if (looking-at (concat ".*:" org-archive-tag ":"))
  2328. (message "%s" (substitute-command-keys
  2329. "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
  2330. (defun org-force-cycle-archived ()
  2331. "Cycle subtree even if it is archived."
  2332. (interactive)
  2333. (setq this-command 'org-cycle)
  2334. (let ((org-cycle-open-archived-trees t))
  2335. (call-interactively 'org-cycle)))
  2336. (defun org-hide-archived-subtrees (beg end)
  2337. "Re-hide all archived subtrees after a visibility state change."
  2338. (save-excursion
  2339. (let* ((re (concat ":" org-archive-tag ":")))
  2340. (goto-char beg)
  2341. (while (re-search-forward re end t)
  2342. (and (org-on-heading-p) (hide-subtree))
  2343. (org-end-of-subtree t)))))
  2344. (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
  2345. (eval-and-compile
  2346. (org-autoload "org-archive"
  2347. '(org-add-archive-files org-archive-subtree
  2348. org-archive-to-archive-sibling org-toggle-archive-tag)))
  2349. ;; Autoload Column View Code
  2350. (declare-function org-columns-number-to-string "org-colview")
  2351. (declare-function org-columns-get-format-and-top-level "org-colview")
  2352. (declare-function org-columns-compute "org-colview")
  2353. (org-autoload (if (featurep 'xemacs) "org-colview-xemacs" "org-colview")
  2354. '(org-columns-number-to-string org-columns-get-format-and-top-level
  2355. org-columns-compute org-agenda-columns org-columns-remove-overlays
  2356. org-columns org-insert-columns-dblock org-dblock-write:columnview))
  2357. ;; Autoload ID code
  2358. (org-autoload "org-id"
  2359. '(org-id-get-create org-id-new org-id-copy org-id-get
  2360. org-id-get-with-outline-path-completion
  2361. org-id-get-with-outline-drilling
  2362. org-id-goto org-id-find))
  2363. ;;; Variables for pre-computed regular expressions, all buffer local
  2364. (defvar org-drawer-regexp nil
  2365. "Matches first line of a hidden block.")
  2366. (make-variable-buffer-local 'org-drawer-regexp)
  2367. (defvar org-todo-regexp nil
  2368. "Matches any of the TODO state keywords.")
  2369. (make-variable-buffer-local 'org-todo-regexp)
  2370. (defvar org-not-done-regexp nil
  2371. "Matches any of the TODO state keywords except the last one.")
  2372. (make-variable-buffer-local 'org-not-done-regexp)
  2373. (defvar org-todo-line-regexp nil
  2374. "Matches a headline and puts TODO state into group 2 if present.")
  2375. (make-variable-buffer-local 'org-todo-line-regexp)
  2376. (defvar org-complex-heading-regexp nil
  2377. "Matches a headline and puts everything into groups:
  2378. group 1: the stars
  2379. group 2: The todo keyword, maybe
  2380. group 3: Priority cookie
  2381. group 4: True headline
  2382. group 5: Tags")
  2383. (make-variable-buffer-local 'org-complex-heading-regexp)
  2384. (defvar org-todo-line-tags-regexp nil
  2385. "Matches a headline and puts TODO state into group 2 if present.
  2386. Also put tags into group 4 if tags are present.")
  2387. (make-variable-buffer-local 'org-todo-line-tags-regexp)
  2388. (defvar org-nl-done-regexp nil
  2389. "Matches newline followed by a headline with the DONE keyword.")
  2390. (make-variable-buffer-local 'org-nl-done-regexp)
  2391. (defvar org-looking-at-done-regexp nil
  2392. "Matches the DONE keyword a point.")
  2393. (make-variable-buffer-local 'org-looking-at-done-regexp)
  2394. (defvar org-ds-keyword-length 12
  2395. "Maximum length of the Deadline and SCHEDULED keywords.")
  2396. (make-variable-buffer-local 'org-ds-keyword-length)
  2397. (defvar org-deadline-regexp nil
  2398. "Matches the DEADLINE keyword.")
  2399. (make-variable-buffer-local 'org-deadline-regexp)
  2400. (defvar org-deadline-time-regexp nil
  2401. "Matches the DEADLINE keyword together with a time stamp.")
  2402. (make-variable-buffer-local 'org-deadline-time-regexp)
  2403. (defvar org-deadline-line-regexp nil
  2404. "Matches the DEADLINE keyword and the rest of the line.")
  2405. (make-variable-buffer-local 'org-deadline-line-regexp)
  2406. (defvar org-scheduled-regexp nil
  2407. "Matches the SCHEDULED keyword.")
  2408. (make-variable-buffer-local 'org-scheduled-regexp)
  2409. (defvar org-scheduled-time-regexp nil
  2410. "Matches the SCHEDULED keyword together with a time stamp.")
  2411. (make-variable-buffer-local 'org-scheduled-time-regexp)
  2412. (defvar org-closed-time-regexp nil
  2413. "Matches the CLOSED keyword together with a time stamp.")
  2414. (make-variable-buffer-local 'org-closed-time-regexp)
  2415. (defvar org-keyword-time-regexp nil
  2416. "Matches any of the 4 keywords, together with the time stamp.")
  2417. (make-variable-buffer-local 'org-keyword-time-regexp)
  2418. (defvar org-keyword-time-not-clock-regexp nil
  2419. "Matches any of the 3 keywords, together with the time stamp.")
  2420. (make-variable-buffer-local 'org-keyword-time-not-clock-regexp)
  2421. (defvar org-maybe-keyword-time-regexp nil
  2422. "Matches a timestamp, possibly preceeded by a keyword.")
  2423. (make-variable-buffer-local 'org-maybe-keyword-time-regexp)
  2424. (defvar org-planning-or-clock-line-re nil
  2425. "Matches a line with planning or clock info.")
  2426. (make-variable-buffer-local 'org-planning-or-clock-line-re)
  2427. (defconst org-plain-time-of-day-regexp
  2428. (concat
  2429. "\\(\\<[012]?[0-9]"
  2430. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  2431. "\\(--?"
  2432. "\\(\\<[012]?[0-9]"
  2433. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  2434. "\\)?")
  2435. "Regular expression to match a plain time or time range.
  2436. Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
  2437. groups carry important information:
  2438. 0 the full match
  2439. 1 the first time, range or not
  2440. 8 the second time, if it is a range.")
  2441. (defconst org-plain-time-extension-regexp
  2442. (concat
  2443. "\\(\\<[012]?[0-9]"
  2444. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  2445. "\\+\\([0-9]+\\)\\(:\\([0-5][0-9]\\)\\)?")
  2446. "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
  2447. Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
  2448. groups carry important information:
  2449. 0 the full match
  2450. 7 hours of duration
  2451. 9 minutes of duration")
  2452. (defconst org-stamp-time-of-day-regexp
  2453. (concat
  2454. "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} +\\sw+ +\\)"
  2455. "\\([012][0-9]:[0-5][0-9]\\(-\\([012][0-9]:[0-5][0-9]\\)\\)?[^\n\r>]*?\\)>"
  2456. "\\(--?"
  2457. "<\\1\\([012][0-9]:[0-5][0-9]\\)>\\)?")
  2458. "Regular expression to match a timestamp time or time range.
  2459. After a match, the following groups carry important information:
  2460. 0 the full match
  2461. 1 date plus weekday, for backreferencing to make sure both times on same day
  2462. 2 the first time, range or not
  2463. 4 the second time, if it is a range.")
  2464. (defconst org-startup-options
  2465. '(("fold" org-startup-folded t)
  2466. ("overview" org-startup-folded t)
  2467. ("nofold" org-startup-folded nil)
  2468. ("showall" org-startup-folded nil)
  2469. ("content" org-startup-folded content)
  2470. ("hidestars" org-hide-leading-stars t)
  2471. ("showstars" org-hide-leading-stars nil)
  2472. ("odd" org-odd-levels-only t)
  2473. ("oddeven" org-odd-levels-only nil)
  2474. ("align" org-startup-align-all-tables t)
  2475. ("noalign" org-startup-align-all-tables nil)
  2476. ("customtime" org-display-custom-times t)
  2477. ("logdone" org-log-done time)
  2478. ("lognotedone" org-log-done note)
  2479. ("nologdone" org-log-done nil)
  2480. ("lognoteclock-out" org-log-note-clock-out t)
  2481. ("nolognoteclock-out" org-log-note-clock-out nil)
  2482. ("logrepeat" org-log-repeat state)
  2483. ("lognoterepeat" org-log-repeat note)
  2484. ("nologrepeat" org-log-repeat nil)
  2485. ("constcgs" constants-unit-system cgs)
  2486. ("constSI" constants-unit-system SI))
  2487. "Variable associated with STARTUP options for org-mode.
  2488. Each element is a list of three items: The startup options as written
  2489. in the #+STARTUP line, the corresponding variable, and the value to
  2490. set this variable to if the option is found. An optional forth element PUSH
  2491. means to push this value onto the list in the variable.")
  2492. (defun org-set-regexps-and-options ()
  2493. "Precompute regular expressions for current buffer."
  2494. (when (org-mode-p)
  2495. (org-set-local 'org-todo-kwd-alist nil)
  2496. (org-set-local 'org-todo-key-alist nil)
  2497. (org-set-local 'org-todo-key-trigger nil)
  2498. (org-set-local 'org-todo-keywords-1 nil)
  2499. (org-set-local 'org-done-keywords nil)
  2500. (org-set-local 'org-todo-heads nil)
  2501. (org-set-local 'org-todo-sets nil)
  2502. (org-set-local 'org-todo-log-states nil)
  2503. (org-set-local 'org-file-properties nil)
  2504. (org-set-local 'org-file-tags nil)
  2505. (let ((re (org-make-options-regexp
  2506. '("CATEGORY" "SEQ_TODO" "TYP_TODO" "TODO" "COLUMNS"
  2507. "STARTUP" "ARCHIVE" "FILETAGS" "TAGS" "LINK" "PRIORITIES"
  2508. "CONSTANTS" "PROPERTY" "DRAWERS" "SETUPFILE")))
  2509. (splitre "[ \t]+")
  2510. kwds kws0 kwsa key log value cat arch tags const links hw dws
  2511. tail sep kws1 prio props ftags drawers
  2512. ext-setup-or-nil setup-contents (start 0))
  2513. (save-excursion
  2514. (save-restriction
  2515. (widen)
  2516. (goto-char (point-min))
  2517. (while (or (and ext-setup-or-nil
  2518. (string-match re ext-setup-or-nil start)
  2519. (setq start (match-end 0)))
  2520. (and (setq ext-setup-or-nil nil start 0)
  2521. (re-search-forward re nil t)))
  2522. (setq key (upcase (match-string 1 ext-setup-or-nil))
  2523. value (org-match-string-no-properties 2 ext-setup-or-nil))
  2524. (cond
  2525. ((equal key "CATEGORY")
  2526. (if (string-match "[ \t]+$" value)
  2527. (setq value (replace-match "" t t value)))
  2528. (setq cat value))
  2529. ((member key '("SEQ_TODO" "TODO"))
  2530. (push (cons 'sequence (org-split-string value splitre)) kwds))
  2531. ((equal key "TYP_TODO")
  2532. (push (cons 'type (org-split-string value splitre)) kwds))
  2533. ((equal key "TAGS")
  2534. (setq tags (append tags (org-split-string value splitre))))
  2535. ((equal key "COLUMNS")
  2536. (org-set-local 'org-columns-default-format value))
  2537. ((equal key "LINK")
  2538. (when (string-match "^\\(\\S-+\\)[ \t]+\\(.+\\)" value)
  2539. (push (cons (match-string 1 value)
  2540. (org-trim (match-string 2 value)))
  2541. links)))
  2542. ((equal key "PRIORITIES")
  2543. (setq prio (org-split-string value " +")))
  2544. ((equal key "PROPERTY")
  2545. (when (string-match "\\(\\S-+\\)\\s-+\\(.*\\)" value)
  2546. (push (cons (match-string 1 value) (match-string 2 value))
  2547. props)))
  2548. ((equal key "FILETAGS")
  2549. (when (string-match "\\S-" value)
  2550. (setq ftags
  2551. (append
  2552. ftags
  2553. (apply 'append
  2554. (mapcar (lambda (x) (org-split-string x ":"))
  2555. (org-split-string value)))))))
  2556. ((equal key "DRAWERS")
  2557. (setq drawers (org-split-string value splitre)))
  2558. ((equal key "CONSTANTS")
  2559. (setq const (append const (org-split-string value splitre))))
  2560. ((equal key "STARTUP")
  2561. (let ((opts (org-split-string value splitre))
  2562. l var val)
  2563. (while (setq l (pop opts))
  2564. (when (setq l (assoc l org-startup-options))
  2565. (setq var (nth 1 l) val (nth 2 l))
  2566. (if (not (nth 3 l))
  2567. (set (make-local-variable var) val)
  2568. (if (not (listp (symbol-value var)))
  2569. (set (make-local-variable var) nil))
  2570. (set (make-local-variable var) (symbol-value var))
  2571. (add-to-list var val))))))
  2572. ((equal key "ARCHIVE")
  2573. (string-match " *$" value)
  2574. (setq arch (replace-match "" t t value))
  2575. (remove-text-properties 0 (length arch)
  2576. '(face t fontified t) arch))
  2577. ((equal key "SETUPFILE")
  2578. (setq setup-contents (org-file-contents
  2579. (expand-file-name
  2580. (org-remove-double-quotes value))
  2581. 'noerror))
  2582. (if (not ext-setup-or-nil)
  2583. (setq ext-setup-or-nil setup-contents start 0)
  2584. (setq ext-setup-or-nil
  2585. (concat (substring ext-setup-or-nil 0 start)
  2586. "\n" setup-contents "\n"
  2587. (substring ext-setup-or-nil start)))))
  2588. ))))
  2589. (when cat
  2590. (org-set-local 'org-category (intern cat))
  2591. (push (cons "CATEGORY" cat) props))
  2592. (when prio
  2593. (if (< (length prio) 3) (setq prio '("A" "C" "B")))
  2594. (setq prio (mapcar 'string-to-char prio))
  2595. (org-set-local 'org-highest-priority (nth 0 prio))
  2596. (org-set-local 'org-lowest-priority (nth 1 prio))
  2597. (org-set-local 'org-default-priority (nth 2 prio)))
  2598. (and props (org-set-local 'org-file-properties (nreverse props)))
  2599. (and ftags (org-set-local 'org-file-tags ftags))
  2600. (and drawers (org-set-local 'org-drawers drawers))
  2601. (and arch (org-set-local 'org-archive-location arch))
  2602. (and links (setq org-link-abbrev-alist-local (nreverse links)))
  2603. ;; Process the TODO keywords
  2604. (unless kwds
  2605. ;; Use the global values as if they had been given locally.
  2606. (setq kwds (default-value 'org-todo-keywords))
  2607. (if (stringp (car kwds))
  2608. (setq kwds (list (cons org-todo-interpretation
  2609. (default-value 'org-todo-keywords)))))
  2610. (setq kwds (reverse kwds)))
  2611. (setq kwds (nreverse kwds))
  2612. (let (inter kws kw)
  2613. (while (setq kws (pop kwds))
  2614. (setq inter (pop kws) sep (member "|" kws)
  2615. kws0 (delete "|" (copy-sequence kws))
  2616. kwsa nil
  2617. kws1 (mapcar
  2618. (lambda (x)
  2619. ;; 1 2
  2620. (if (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?.*?)\\)?$" x)
  2621. (progn
  2622. (setq kw (match-string 1 x)
  2623. key (and (match-end 2) (match-string 2 x))
  2624. log (org-extract-log-state-settings x))
  2625. (push (cons kw (and key (string-to-char key))) kwsa)
  2626. (and log (push log org-todo-log-states))
  2627. kw)
  2628. (error "Invalid TODO keyword %s" x)))
  2629. kws0)
  2630. kwsa (if kwsa (append '((:startgroup))
  2631. (nreverse kwsa)
  2632. '((:endgroup))))
  2633. hw (car kws1)
  2634. dws (if sep (org-remove-keyword-keys (cdr sep)) (last kws1))
  2635. tail (list inter hw (car dws) (org-last dws)))
  2636. (add-to-list 'org-todo-heads hw 'append)
  2637. (push kws1 org-todo-sets)
  2638. (setq org-done-keywords (append org-done-keywords dws nil))
  2639. (setq org-todo-key-alist (append org-todo-key-alist kwsa))
  2640. (mapc (lambda (x) (push (cons x tail) org-todo-kwd-alist)) kws1)
  2641. (setq org-todo-keywords-1 (append org-todo-keywords-1 kws1 nil)))
  2642. (setq org-todo-sets (nreverse org-todo-sets)
  2643. org-todo-kwd-alist (nreverse org-todo-kwd-alist)
  2644. org-todo-key-trigger (delq nil (mapcar 'cdr org-todo-key-alist))
  2645. org-todo-key-alist (org-assign-fast-keys org-todo-key-alist)))
  2646. ;; Process the constants
  2647. (when const
  2648. (let (e cst)
  2649. (while (setq e (pop const))
  2650. (if (string-match "^\\([a-zA-Z0][_a-zA-Z0-9]*\\)=\\(.*\\)" e)
  2651. (push (cons (match-string 1 e) (match-string 2 e)) cst)))
  2652. (setq org-table-formula-constants-local cst)))
  2653. ;; Process the tags.
  2654. (when tags
  2655. (let (e tgs)
  2656. (while (setq e (pop tags))
  2657. (cond
  2658. ((equal e "{") (push '(:startgroup) tgs))
  2659. ((equal e "}") (push '(:endgroup) tgs))
  2660. ((string-match (org-re "^\\([[:alnum:]_@]+\\)(\\(.\\))$") e)
  2661. (push (cons (match-string 1 e)
  2662. (string-to-char (match-string 2 e)))
  2663. tgs))
  2664. (t (push (list e) tgs))))
  2665. (org-set-local 'org-tag-alist nil)
  2666. (while (setq e (pop tgs))
  2667. (or (and (stringp (car e))
  2668. (assoc (car e) org-tag-alist))
  2669. (push e org-tag-alist)))))
  2670. ;; Compute the regular expressions and other local variables
  2671. (if (not org-done-keywords)
  2672. (setq org-done-keywords (list (org-last org-todo-keywords-1))))
  2673. (setq org-ds-keyword-length (+ 2 (max (length org-deadline-string)
  2674. (length org-scheduled-string)
  2675. (length org-clock-string)
  2676. (length org-closed-string)))
  2677. org-drawer-regexp
  2678. (concat "^[ \t]*:\\("
  2679. (mapconcat 'regexp-quote org-drawers "\\|")
  2680. "\\):[ \t]*$")
  2681. org-not-done-keywords
  2682. (org-delete-all org-done-keywords (copy-sequence org-todo-keywords-1))
  2683. org-todo-regexp
  2684. (concat "\\<\\(" (mapconcat 'regexp-quote org-todo-keywords-1
  2685. "\\|") "\\)\\>")
  2686. org-not-done-regexp
  2687. (concat "\\<\\("
  2688. (mapconcat 'regexp-quote org-not-done-keywords "\\|")
  2689. "\\)\\>")
  2690. org-todo-line-regexp
  2691. (concat "^\\(\\*+\\)[ \t]+\\(?:\\("
  2692. (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
  2693. "\\)\\>\\)?[ \t]*\\(.*\\)")
  2694. org-complex-heading-regexp
  2695. (concat "^\\(\\*+\\)\\(?:[ \t]+\\("
  2696. (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
  2697. "\\)\\>\\)?\\(?:[ \t]*\\(\\[#.\\]\\)\\)?[ \t]*\\(.*?\\)"
  2698. "\\(?:[ \t]+\\(:[[:alnum:]_@:]+:\\)\\)?[ \t]*$")
  2699. org-nl-done-regexp
  2700. (concat "\n\\*+[ \t]+"
  2701. "\\(?:" (mapconcat 'regexp-quote org-done-keywords "\\|")
  2702. "\\)" "\\>")
  2703. org-todo-line-tags-regexp
  2704. (concat "^\\(\\*+\\)[ \t]+\\(?:\\("
  2705. (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
  2706. (org-re
  2707. "\\)\\>\\)? *\\(.*?\\([ \t]:[[:alnum:]:_@]+:[ \t]*\\)?$\\)"))
  2708. org-looking-at-done-regexp
  2709. (concat "^" "\\(?:"
  2710. (mapconcat 'regexp-quote org-done-keywords "\\|") "\\)"
  2711. "\\>")
  2712. org-deadline-regexp (concat "\\<" org-deadline-string)
  2713. org-deadline-time-regexp
  2714. (concat "\\<" org-deadline-string " *<\\([^>]+\\)>")
  2715. org-deadline-line-regexp
  2716. (concat "\\<\\(" org-deadline-string "\\).*")
  2717. org-scheduled-regexp
  2718. (concat "\\<" org-scheduled-string)
  2719. org-scheduled-time-regexp
  2720. (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>")
  2721. org-closed-time-regexp
  2722. (concat "\\<" org-closed-string " *\\[\\([^]]+\\)\\]")
  2723. org-keyword-time-regexp
  2724. (concat "\\<\\(" org-scheduled-string
  2725. "\\|" org-deadline-string
  2726. "\\|" org-closed-string
  2727. "\\|" org-clock-string "\\)"
  2728. " *[[<]\\([^]>]+\\)[]>]")
  2729. org-keyword-time-not-clock-regexp
  2730. (concat "\\<\\(" org-scheduled-string
  2731. "\\|" org-deadline-string
  2732. "\\|" org-closed-string
  2733. "\\)"
  2734. " *[[<]\\([^]>]+\\)[]>]")
  2735. org-maybe-keyword-time-regexp
  2736. (concat "\\(\\<\\(" org-scheduled-string
  2737. "\\|" org-deadline-string
  2738. "\\|" org-closed-string
  2739. "\\|" org-clock-string "\\)\\)?"
  2740. " *\\([[<][0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} [^]\r\n>]*?[]>]\\|<%%([^\r\n>]*>\\)")
  2741. org-planning-or-clock-line-re
  2742. (concat "\\(?:^[ \t]*\\(" org-scheduled-string
  2743. "\\|" org-deadline-string
  2744. "\\|" org-closed-string "\\|" org-clock-string
  2745. "\\)\\>\\)")
  2746. )
  2747. (org-compute-latex-and-specials-regexp)
  2748. (org-set-font-lock-defaults))))
  2749. (defun org-file-contents (file &optional noerror)
  2750. "Return the contents of FILE, as a string."
  2751. (if (or (not file)
  2752. (not (file-readable-p file)))
  2753. (if noerror
  2754. (progn
  2755. (message "Cannot read file %s" file)
  2756. (ding) (sit-for 2)
  2757. "")
  2758. (error "Cannot read file %s" file))
  2759. (with-temp-buffer
  2760. (insert-file-contents file)
  2761. (buffer-string))))
  2762. (defun org-extract-log-state-settings (x)
  2763. "Extract the log state setting from a TODO keyword string.
  2764. This will extract info from a string like \"WAIT(w@/!)\"."
  2765. (let (kw key log1 log2)
  2766. (when (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?\\([!@]\\)?\\(?:/\\([!@]\\)\\)?)\\)?$" x)
  2767. (setq kw (match-string 1 x)
  2768. key (and (match-end 2) (match-string 2 x))
  2769. log1 (and (match-end 3) (match-string 3 x))
  2770. log2 (and (match-end 4) (match-string 4 x)))
  2771. (and (or log1 log2)
  2772. (list kw
  2773. (and log1 (if (equal log1 "!") 'time 'note))
  2774. (and log2 (if (equal log2 "!") 'time 'note)))))))
  2775. (defun org-remove-keyword-keys (list)
  2776. "Remove a pair of parenthesis at the end of each string in LIST."
  2777. (mapcar (lambda (x)
  2778. (if (string-match "(.*)$" x)
  2779. (substring x 0 (match-beginning 0))
  2780. x))
  2781. list))
  2782. ;; FIXME: this could be done much better, using second characters etc.
  2783. (defun org-assign-fast-keys (alist)
  2784. "Assign fast keys to a keyword-key alist.
  2785. Respect keys that are already there."
  2786. (let (new e k c c1 c2 (char ?a))
  2787. (while (setq e (pop alist))
  2788. (cond
  2789. ((equal e '(:startgroup)) (push e new))
  2790. ((equal e '(:endgroup)) (push e new))
  2791. (t
  2792. (setq k (car e) c2 nil)
  2793. (if (cdr e)
  2794. (setq c (cdr e))
  2795. ;; automatically assign a character.
  2796. (setq c1 (string-to-char
  2797. (downcase (substring
  2798. k (if (= (string-to-char k) ?@) 1 0)))))
  2799. (if (or (rassoc c1 new) (rassoc c1 alist))
  2800. (while (or (rassoc char new) (rassoc char alist))
  2801. (setq char (1+ char)))
  2802. (setq c2 c1))
  2803. (setq c (or c2 char)))
  2804. (push (cons k c) new))))
  2805. (nreverse new)))
  2806. ;;; Some variables used in various places
  2807. (defvar org-window-configuration nil
  2808. "Used in various places to store a window configuration.")
  2809. (defvar org-finish-function nil
  2810. "Function to be called when `C-c C-c' is used.
  2811. This is for getting out of special buffers like remember.")
  2812. ;; FIXME: Occasionally check by commenting these, to make sure
  2813. ;; no other functions uses these, forgetting to let-bind them.
  2814. (defvar entry)
  2815. (defvar state)
  2816. (defvar last-state)
  2817. (defvar date)
  2818. (defvar description)
  2819. ;; Defined somewhere in this file, but used before definition.
  2820. (defvar org-html-entities)
  2821. (defvar org-struct-menu)
  2822. (defvar org-org-menu)
  2823. (defvar org-tbl-menu)
  2824. (defvar org-agenda-keymap)
  2825. ;;;; Define the Org-mode
  2826. (if (and (not (keymapp outline-mode-map)) (featurep 'allout))
  2827. (error "Conflict with outdated version of allout.el. Load org.el before allout.el, or ugrade to newer allout, for example by switching to Emacs 22."))
  2828. ;; We use a before-change function to check if a table might need
  2829. ;; an update.
  2830. (defvar org-table-may-need-update t
  2831. "Indicates that a table might need an update.
  2832. This variable is set by `org-before-change-function'.
  2833. `org-table-align' sets it back to nil.")
  2834. (defun org-before-change-function (beg end)
  2835. "Every change indicates that a table might need an update."
  2836. (setq org-table-may-need-update t))
  2837. (defvar org-mode-map)
  2838. (defvar org-mode-hook nil)
  2839. (defvar org-inhibit-startup nil) ; Dynamically-scoped param.
  2840. (defvar org-agenda-keep-modes nil) ; Dynamically-scoped param.
  2841. (defvar org-table-buffer-is-an nil)
  2842. (defconst org-outline-regexp "\\*+ ")
  2843. ;;;###autoload
  2844. (define-derived-mode org-mode outline-mode "Org"
  2845. "Outline-based notes management and organizer, alias
  2846. \"Carsten's outline-mode for keeping track of everything.\"
  2847. Org-mode develops organizational tasks around a NOTES file which
  2848. contains information about projects as plain text. Org-mode is
  2849. implemented on top of outline-mode, which is ideal to keep the content
  2850. of large files well structured. It supports ToDo items, deadlines and
  2851. time stamps, which magically appear in the diary listing of the Emacs
  2852. calendar. Tables are easily created with a built-in table editor.
  2853. Plain text URL-like links connect to websites, emails (VM), Usenet
  2854. messages (Gnus), BBDB entries, and any files related to the project.
  2855. For printing and sharing of notes, an Org-mode file (or a part of it)
  2856. can be exported as a structured ASCII or HTML file.
  2857. The following commands are available:
  2858. \\{org-mode-map}"
  2859. ;; Get rid of Outline menus, they are not needed
  2860. ;; Need to do this here because define-derived-mode sets up
  2861. ;; the keymap so late. Still, it is a waste to call this each time
  2862. ;; we switch another buffer into org-mode.
  2863. (if (featurep 'xemacs)
  2864. (when (boundp 'outline-mode-menu-heading)
  2865. ;; Assume this is Greg's port, it used easymenu
  2866. (easy-menu-remove outline-mode-menu-heading)
  2867. (easy-menu-remove outline-mode-menu-show)
  2868. (easy-menu-remove outline-mode-menu-hide))
  2869. (define-key org-mode-map [menu-bar headings] 'undefined)
  2870. (define-key org-mode-map [menu-bar hide] 'undefined)
  2871. (define-key org-mode-map [menu-bar show] 'undefined))
  2872. (org-load-modules-maybe)
  2873. (easy-menu-add org-org-menu)
  2874. (easy-menu-add org-tbl-menu)
  2875. (org-install-agenda-files-menu)
  2876. (if org-descriptive-links (org-add-to-invisibility-spec '(org-link)))
  2877. (org-add-to-invisibility-spec '(org-cwidth))
  2878. (when (featurep 'xemacs)
  2879. (org-set-local 'line-move-ignore-invisible t))
  2880. (org-set-local 'outline-regexp org-outline-regexp)
  2881. (org-set-local 'outline-level 'org-outline-level)
  2882. (when (and org-ellipsis
  2883. (fboundp 'set-display-table-slot) (boundp 'buffer-display-table)
  2884. (fboundp 'make-glyph-code))
  2885. (unless org-display-table
  2886. (setq org-display-table (make-display-table)))
  2887. (set-display-table-slot
  2888. org-display-table 4
  2889. (vconcat (mapcar
  2890. (lambda (c) (make-glyph-code c (and (not (stringp org-ellipsis))
  2891. org-ellipsis)))
  2892. (if (stringp org-ellipsis) org-ellipsis "..."))))
  2893. (setq buffer-display-table org-display-table))
  2894. (org-set-regexps-and-options)
  2895. ;; Calc embedded
  2896. (org-set-local 'calc-embedded-open-mode "# ")
  2897. (modify-syntax-entry ?# "<")
  2898. (modify-syntax-entry ?@ "w")
  2899. (if org-startup-truncated (setq truncate-lines t))
  2900. (org-set-local 'font-lock-unfontify-region-function
  2901. 'org-unfontify-region)
  2902. ;; Activate before-change-function
  2903. (org-set-local 'org-table-may-need-update t)
  2904. (org-add-hook 'before-change-functions 'org-before-change-function nil
  2905. 'local)
  2906. ;; Check for running clock before killing a buffer
  2907. (org-add-hook 'kill-buffer-hook 'org-check-running-clock nil 'local)
  2908. ;; Paragraphs and auto-filling
  2909. (org-set-autofill-regexps)
  2910. (setq indent-line-function 'org-indent-line-function)
  2911. (org-update-radio-target-regexp)
  2912. ;; Comment characters
  2913. ; (org-set-local 'comment-start "#") ;; FIXME: this breaks wrapping
  2914. (org-set-local 'comment-padding " ")
  2915. ;; Align options lines
  2916. (org-set-local
  2917. 'align-mode-rules-list
  2918. '((org-in-buffer-settings
  2919. (regexp . "^#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
  2920. (modes . '(org-mode)))))
  2921. ;; Imenu
  2922. (org-set-local 'imenu-create-index-function
  2923. 'org-imenu-get-tree)
  2924. ;; Make isearch reveal context
  2925. (if (or (featurep 'xemacs)
  2926. (not (boundp 'outline-isearch-open-invisible-function)))
  2927. ;; Emacs 21 and XEmacs make use of the hook
  2928. (org-add-hook 'isearch-mode-end-hook 'org-isearch-end 'append 'local)
  2929. ;; Emacs 22 deals with this through a special variable
  2930. (org-set-local 'outline-isearch-open-invisible-function
  2931. (lambda (&rest ignore) (org-show-context 'isearch))))
  2932. ;; If empty file that did not turn on org-mode automatically, make it to.
  2933. (if (and org-insert-mode-line-in-empty-file
  2934. (interactive-p)
  2935. (= (point-min) (point-max)))
  2936. (insert "# -*- mode: org -*-\n\n"))
  2937. (unless org-inhibit-startup
  2938. (when org-startup-align-all-tables
  2939. (let ((bmp (buffer-modified-p)))
  2940. (org-table-map-tables 'org-table-align)
  2941. (set-buffer-modified-p bmp)))
  2942. (org-set-startup-visibility)))
  2943. (put 'org-mode 'flyspell-mode-predicate 'org-mode-flyspell-verify)
  2944. (defun org-current-time ()
  2945. "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
  2946. (if (> (car org-time-stamp-rounding-minutes) 1)
  2947. (let ((r (car org-time-stamp-rounding-minutes))
  2948. (time (decode-time)))
  2949. (apply 'encode-time
  2950. (append (list 0 (* r (floor (+ .5 (/ (float (nth 1 time)) r)))))
  2951. (nthcdr 2 time))))
  2952. (current-time)))
  2953. ;;;; Font-Lock stuff, including the activators
  2954. (defvar org-mouse-map (make-sparse-keymap))
  2955. (org-defkey org-mouse-map
  2956. (if (featurep 'xemacs) [button2] [mouse-2]) 'org-open-at-mouse)
  2957. (org-defkey org-mouse-map
  2958. (if (featurep 'xemacs) [button3] [mouse-3]) 'org-find-file-at-mouse)
  2959. (when org-mouse-1-follows-link
  2960. (org-defkey org-mouse-map [follow-link] 'mouse-face))
  2961. (when org-tab-follows-link
  2962. (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
  2963. (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
  2964. (when org-return-follows-link
  2965. (org-defkey org-mouse-map [(return)] 'org-open-at-point)
  2966. (org-defkey org-mouse-map "\C-m" 'org-open-at-point))
  2967. (require 'font-lock)
  2968. (defconst org-non-link-chars "]\t\n\r<>")
  2969. (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "news"
  2970. "shell" "elisp"))
  2971. (defvar org-link-types-re nil
  2972. "Matches a link that has a url-like prefix like \"http:\"")
  2973. (defvar org-link-re-with-space nil
  2974. "Matches a link with spaces, optional angular brackets around it.")
  2975. (defvar org-link-re-with-space2 nil
  2976. "Matches a link with spaces, optional angular brackets around it.")
  2977. (defvar org-angle-link-re nil
  2978. "Matches link with angular brackets, spaces are allowed.")
  2979. (defvar org-plain-link-re nil
  2980. "Matches plain link, without spaces.")
  2981. (defvar org-bracket-link-regexp nil
  2982. "Matches a link in double brackets.")
  2983. (defvar org-bracket-link-analytic-regexp nil
  2984. "Regular expression used to analyze links.
  2985. Here is what the match groups contain after a match:
  2986. 1: http:
  2987. 2: http
  2988. 3: path
  2989. 4: [desc]
  2990. 5: desc")
  2991. (defvar org-any-link-re nil
  2992. "Regular expression matching any link.")
  2993. (defun org-make-link-regexps ()
  2994. "Update the link regular expressions.
  2995. This should be called after the variable `org-link-types' has changed."
  2996. (setq org-link-types-re
  2997. (concat
  2998. "\\`\\(" (mapconcat 'identity org-link-types "\\|") "\\):")
  2999. org-link-re-with-space
  3000. (concat
  3001. "<?\\(" (mapconcat 'identity org-link-types "\\|") "\\):"
  3002. "\\([^" org-non-link-chars " ]"
  3003. "[^" org-non-link-chars "]*"
  3004. "[^" org-non-link-chars " ]\\)>?")
  3005. org-link-re-with-space2
  3006. (concat
  3007. "<?\\(" (mapconcat 'identity org-link-types "\\|") "\\):"
  3008. "\\([^" org-non-link-chars " ]"
  3009. "[^]\t\n\r]*"
  3010. "[^" org-non-link-chars " ]\\)>?")
  3011. org-angle-link-re
  3012. (concat
  3013. "<\\(" (mapconcat 'identity org-link-types "\\|") "\\):"
  3014. "\\([^" org-non-link-chars " ]"
  3015. "[^" org-non-link-chars "]*"
  3016. "\\)>")
  3017. org-plain-link-re
  3018. (concat
  3019. "\\<\\(" (mapconcat 'identity org-link-types "\\|") "\\):"
  3020. "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
  3021. org-bracket-link-regexp
  3022. "\\[\\[\\([^][]+\\)\\]\\(\\[\\([^][]+\\)\\]\\)?\\]"
  3023. org-bracket-link-analytic-regexp
  3024. (concat
  3025. "\\[\\["
  3026. "\\(\\(" (mapconcat 'identity org-link-types "\\|") "\\):\\)?"
  3027. "\\([^]]+\\)"
  3028. "\\]"
  3029. "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
  3030. "\\]")
  3031. org-any-link-re
  3032. (concat "\\(" org-bracket-link-regexp "\\)\\|\\("
  3033. org-angle-link-re "\\)\\|\\("
  3034. org-plain-link-re "\\)")))
  3035. (org-make-link-regexps)
  3036. (defconst org-ts-regexp "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} [^\r\n>]*?\\)>"
  3037. "Regular expression for fast time stamp matching.")
  3038. (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} [^\r\n>]*?\\)[]>]"
  3039. "Regular expression for fast time stamp matching.")
  3040. (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
  3041. "Regular expression matching time strings for analysis.
  3042. This one does not require the space after the date, so it can be used
  3043. on a string that terminates immediately after the date.")
  3044. (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) +\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
  3045. "Regular expression matching time strings for analysis.")
  3046. (defconst org-ts-regexp2 (concat "<" org-ts-regexp1 "[^>\n]\\{0,16\\}>")
  3047. "Regular expression matching time stamps, with groups.")
  3048. (defconst org-ts-regexp3 (concat "[[<]" org-ts-regexp1 "[^]>\n]\\{0,16\\}[]>]")
  3049. "Regular expression matching time stamps (also [..]), with groups.")
  3050. (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
  3051. "Regular expression matching a time stamp range.")
  3052. (defconst org-tr-regexp-both
  3053. (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
  3054. "Regular expression matching a time stamp range.")
  3055. (defconst org-tsr-regexp (concat org-ts-regexp "\\(--?-?"
  3056. org-ts-regexp "\\)?")
  3057. "Regular expression matching a time stamp or time stamp range.")
  3058. (defconst org-tsr-regexp-both (concat org-ts-regexp-both "\\(--?-?"
  3059. org-ts-regexp-both "\\)?")
  3060. "Regular expression matching a time stamp or time stamp range.
  3061. The time stamps may be either active or inactive.")
  3062. (defvar org-emph-face nil)
  3063. (defun org-do-emphasis-faces (limit)
  3064. "Run through the buffer and add overlays to links."
  3065. (let (rtn)
  3066. (while (and (not rtn) (re-search-forward org-emph-re limit t))
  3067. (if (not (= (char-after (match-beginning 3))
  3068. (char-after (match-beginning 4))))
  3069. (progn
  3070. (setq rtn t)
  3071. (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
  3072. 'face
  3073. (nth 1 (assoc (match-string 3)
  3074. org-emphasis-alist)))
  3075. (add-text-properties (match-beginning 2) (match-end 2)
  3076. '(font-lock-multiline t))
  3077. (when org-hide-emphasis-markers
  3078. (add-text-properties (match-end 4) (match-beginning 5)
  3079. '(invisible org-link))
  3080. (add-text-properties (match-beginning 3) (match-end 3)
  3081. '(invisible org-link)))))
  3082. (backward-char 1))
  3083. rtn))
  3084. (defun org-emphasize (&optional char)
  3085. "Insert or change an emphasis, i.e. a font like bold or italic.
  3086. If there is an active region, change that region to a new emphasis.
  3087. If there is no region, just insert the marker characters and position
  3088. the cursor between them.
  3089. CHAR should be either the marker character, or the first character of the
  3090. HTML tag associated with that emphasis. If CHAR is a space, the means
  3091. to remove the emphasis of the selected region.
  3092. If char is not given (for example in an interactive call) it
  3093. will be prompted for."
  3094. (interactive)
  3095. (let ((eal org-emphasis-alist) e det
  3096. (erc org-emphasis-regexp-components)
  3097. (prompt "")
  3098. (string "") beg end move tag c s)
  3099. (if (org-region-active-p)
  3100. (setq beg (region-beginning) end (region-end)
  3101. string (buffer-substring beg end))
  3102. (setq move t))
  3103. (while (setq e (pop eal))
  3104. (setq tag (car (org-split-string (nth 2 e) "[ <>/]+"))
  3105. c (aref tag 0))
  3106. (push (cons c (string-to-char (car e))) det)
  3107. (setq prompt (concat prompt (format " [%s%c]%s" (car e) c
  3108. (substring tag 1)))))
  3109. (unless char
  3110. (message "%s" (concat "Emphasis marker or tag:" prompt))
  3111. (setq char (read-char-exclusive)))
  3112. (setq char (or (cdr (assoc char det)) char))
  3113. (if (equal char ?\ )
  3114. (setq s "" move nil)
  3115. (unless (assoc (char-to-string char) org-emphasis-alist)
  3116. (error "No such emphasis marker: \"%c\"" char))
  3117. (setq s (char-to-string char)))
  3118. (while (and (> (length string) 1)
  3119. (equal (substring string 0 1) (substring string -1))
  3120. (assoc (substring string 0 1) org-emphasis-alist))
  3121. (setq string (substring string 1 -1)))
  3122. (setq string (concat s string s))
  3123. (if beg (delete-region beg end))
  3124. (unless (or (bolp)
  3125. (string-match (concat "[" (nth 0 erc) "\n]")
  3126. (char-to-string (char-before (point)))))
  3127. (insert " "))
  3128. (unless (string-match (concat "[" (nth 1 erc) "\n]")
  3129. (char-to-string (char-after (point))))
  3130. (insert " ") (backward-char 1))
  3131. (insert string)
  3132. (and move (backward-char 1))))
  3133. (defconst org-nonsticky-props
  3134. '(mouse-face highlight keymap invisible intangible help-echo org-linked-text))
  3135. (defun org-activate-plain-links (limit)
  3136. "Run through the buffer and add overlays to links."
  3137. (catch 'exit
  3138. (let (f)
  3139. (while (re-search-forward org-plain-link-re limit t)
  3140. (setq f (get-text-property (match-beginning 0) 'face))
  3141. (if (or (eq f 'org-tag)
  3142. (and (listp f) (memq 'org-tag f)))
  3143. nil
  3144. (add-text-properties (match-beginning 0) (match-end 0)
  3145. (list 'mouse-face 'highlight
  3146. 'rear-nonsticky org-nonsticky-props
  3147. 'keymap org-mouse-map
  3148. ))
  3149. (throw 'exit t))))))
  3150. (defun org-activate-code (limit)
  3151. (if (re-search-forward "^[ \t]*\\(: .*\n?\\)" limit t)
  3152. (progn
  3153. (remove-text-properties (match-beginning 0) (match-end 0)
  3154. '(display t invisible t intangible t))
  3155. t)))
  3156. (defun org-activate-angle-links (limit)
  3157. "Run through the buffer and add overlays to links."
  3158. (if (re-search-forward org-angle-link-re limit t)
  3159. (progn
  3160. (add-text-properties (match-beginning 0) (match-end 0)
  3161. (list 'mouse-face 'highlight
  3162. 'rear-nonsticky org-nonsticky-props
  3163. 'keymap org-mouse-map
  3164. ))
  3165. t)))
  3166. (defun org-activate-bracket-links (limit)
  3167. "Run through the buffer and add overlays to bracketed links."
  3168. (if (re-search-forward org-bracket-link-regexp limit t)
  3169. (let* ((help (concat "LINK: "
  3170. (org-match-string-no-properties 1)))
  3171. ;; FIXME: above we should remove the escapes.
  3172. ;; but that requires another match, protecting match data,
  3173. ;; a lot of overhead for font-lock.
  3174. (ip (org-maybe-intangible
  3175. (list 'invisible 'org-link 'rear-nonsticky org-nonsticky-props
  3176. 'keymap org-mouse-map 'mouse-face 'highlight
  3177. 'font-lock-multiline t 'help-echo help)))
  3178. (vp (list 'rear-nonsticky org-nonsticky-props
  3179. 'keymap org-mouse-map 'mouse-face 'highlight
  3180. ' font-lock-multiline t 'help-echo help)))
  3181. ;; We need to remove the invisible property here. Table narrowing
  3182. ;; may have made some of this invisible.
  3183. (remove-text-properties (match-beginning 0) (match-end 0)
  3184. '(invisible nil))
  3185. (if (match-end 3)
  3186. (progn
  3187. (add-text-properties (match-beginning 0) (match-beginning 3) ip)
  3188. (add-text-properties (match-beginning 3) (match-end 3) vp)
  3189. (add-text-properties (match-end 3) (match-end 0) ip))
  3190. (add-text-properties (match-beginning 0) (match-beginning 1) ip)
  3191. (add-text-properties (match-beginning 1) (match-end 1) vp)
  3192. (add-text-properties (match-end 1) (match-end 0) ip))
  3193. t)))
  3194. (defun org-activate-dates (limit)
  3195. "Run through the buffer and add overlays to dates."
  3196. (if (re-search-forward org-tsr-regexp-both limit t)
  3197. (progn
  3198. (add-text-properties (match-beginning 0) (match-end 0)
  3199. (list 'mouse-face 'highlight
  3200. 'rear-nonsticky org-nonsticky-props
  3201. 'keymap org-mouse-map))
  3202. (when org-display-custom-times
  3203. (if (match-end 3)
  3204. (org-display-custom-time (match-beginning 3) (match-end 3)))
  3205. (org-display-custom-time (match-beginning 1) (match-end 1)))
  3206. t)))
  3207. (defvar org-target-link-regexp nil
  3208. "Regular expression matching radio targets in plain text.")
  3209. (defvar org-target-regexp "<<\\([^<>\n\r]+\\)>>"
  3210. "Regular expression matching a link target.")
  3211. (defvar org-radio-target-regexp "<<<\\([^<>\n\r]+\\)>>>"
  3212. "Regular expression matching a radio target.")
  3213. (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
  3214. "Regular expression matching any target.")
  3215. (defun org-activate-target-links (limit)
  3216. "Run through the buffer and add overlays to target matches."
  3217. (when org-target-link-regexp
  3218. (let ((case-fold-search t))
  3219. (if (re-search-forward org-target-link-regexp limit t)
  3220. (progn
  3221. (add-text-properties (match-beginning 0) (match-end 0)
  3222. (list 'mouse-face 'highlight
  3223. 'rear-nonsticky org-nonsticky-props
  3224. 'keymap org-mouse-map
  3225. 'help-echo "Radio target link"
  3226. 'org-linked-text t))
  3227. t)))))
  3228. (defun org-update-radio-target-regexp ()
  3229. "Find all radio targets in this file and update the regular expression."
  3230. (interactive)
  3231. (when (memq 'radio org-activate-links)
  3232. (setq org-target-link-regexp
  3233. (org-make-target-link-regexp (org-all-targets 'radio)))
  3234. (org-restart-font-lock)))
  3235. (defun org-hide-wide-columns (limit)
  3236. (let (s e)
  3237. (setq s (text-property-any (point) (or limit (point-max))
  3238. 'org-cwidth t))
  3239. (when s
  3240. (setq e (next-single-property-change s 'org-cwidth))
  3241. (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
  3242. (goto-char e)
  3243. t)))
  3244. (defvar org-latex-and-specials-regexp nil
  3245. "Regular expression for highlighting export special stuff.")
  3246. (defvar org-match-substring-regexp)
  3247. (defvar org-match-substring-with-braces-regexp)
  3248. (defvar org-export-html-special-string-regexps)
  3249. (defun org-compute-latex-and-specials-regexp ()
  3250. "Compute regular expression for stuff treated specially by exporters."
  3251. (if (not org-highlight-latex-fragments-and-specials)
  3252. (org-set-local 'org-latex-and-specials-regexp nil)
  3253. (require 'org-exp)
  3254. (let*
  3255. ((matchers (plist-get org-format-latex-options :matchers))
  3256. (latexs (delq nil (mapcar (lambda (x) (if (member (car x) matchers) x))
  3257. org-latex-regexps)))
  3258. (options (org-combine-plists (org-default-export-plist)
  3259. (org-infile-export-plist)))
  3260. (org-export-with-sub-superscripts (plist-get options :sub-superscript))
  3261. (org-export-with-LaTeX-fragments (plist-get options :LaTeX-fragments))
  3262. (org-export-with-TeX-macros (plist-get options :TeX-macros))
  3263. (org-export-html-expand (plist-get options :expand-quoted-html))
  3264. (org-export-with-special-strings (plist-get options :special-strings))
  3265. (re-sub
  3266. (cond
  3267. ((equal org-export-with-sub-superscripts '{})
  3268. (list org-match-substring-with-braces-regexp))
  3269. (org-export-with-sub-superscripts
  3270. (list org-match-substring-regexp))
  3271. (t nil)))
  3272. (re-latex
  3273. (if org-export-with-LaTeX-fragments
  3274. (mapcar (lambda (x) (nth 1 x)) latexs)))
  3275. (re-macros
  3276. (if org-export-with-TeX-macros
  3277. (list (concat "\\\\"
  3278. (regexp-opt
  3279. (append (mapcar 'car org-html-entities)
  3280. (if (boundp 'org-latex-entities)
  3281. org-latex-entities nil))
  3282. 'words))) ; FIXME
  3283. ))
  3284. ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
  3285. (re-special (if org-export-with-special-strings
  3286. (mapcar (lambda (x) (car x))
  3287. org-export-html-special-string-regexps)))
  3288. (re-rest
  3289. (delq nil
  3290. (list
  3291. (if org-export-html-expand "@<[^>\n]+>")
  3292. ))))
  3293. (org-set-local
  3294. 'org-latex-and-specials-regexp
  3295. (mapconcat 'identity (append re-latex re-sub re-macros re-special
  3296. re-rest) "\\|")))))
  3297. (defun org-do-latex-and-special-faces (limit)
  3298. "Run through the buffer and add overlays to links."
  3299. (when org-latex-and-specials-regexp
  3300. (let (rtn d)
  3301. (while (and (not rtn) (re-search-forward org-latex-and-specials-regexp
  3302. limit t))
  3303. (if (not (memq (car-safe (get-text-property (1+ (match-beginning 0))
  3304. 'face))
  3305. '(org-code org-verbatim underline)))
  3306. (progn
  3307. (setq rtn t
  3308. d (cond ((member (char-after (1+ (match-beginning 0)))
  3309. '(?_ ?^)) 1)
  3310. (t 0)))
  3311. (font-lock-prepend-text-property
  3312. (+ d (match-beginning 0)) (match-end 0)
  3313. 'face 'org-latex-and-export-specials)
  3314. (add-text-properties (+ d (match-beginning 0)) (match-end 0)
  3315. '(font-lock-multiline t)))))
  3316. rtn)))
  3317. (defun org-restart-font-lock ()
  3318. "Restart font-lock-mode, to force refontification."
  3319. (when (and (boundp 'font-lock-mode) font-lock-mode)
  3320. (font-lock-mode -1)
  3321. (font-lock-mode 1)))
  3322. (defun org-all-targets (&optional radio)
  3323. "Return a list of all targets in this file.
  3324. With optional argument RADIO, only find radio targets."
  3325. (let ((re (if radio org-radio-target-regexp org-target-regexp))
  3326. rtn)
  3327. (save-excursion
  3328. (goto-char (point-min))
  3329. (while (re-search-forward re nil t)
  3330. (add-to-list 'rtn (downcase (org-match-string-no-properties 1))))
  3331. rtn)))
  3332. (defun org-make-target-link-regexp (targets)
  3333. "Make regular expression matching all strings in TARGETS.
  3334. The regular expression finds the targets also if there is a line break
  3335. between words."
  3336. (and targets
  3337. (concat
  3338. "\\<\\("
  3339. (mapconcat
  3340. (lambda (x)
  3341. (while (string-match " +" x)
  3342. (setq x (replace-match "\\s-+" t t x)))
  3343. x)
  3344. targets
  3345. "\\|")
  3346. "\\)\\>")))
  3347. (defun org-activate-tags (limit)
  3348. (if (re-search-forward (org-re "^\\*+.*[ \t]\\(:[[:alnum:]_@:]+:\\)[ \r\n]") limit t)
  3349. (progn
  3350. (add-text-properties (match-beginning 1) (match-end 1)
  3351. (list 'mouse-face 'highlight
  3352. 'rear-nonsticky org-nonsticky-props
  3353. 'keymap org-mouse-map))
  3354. t)))
  3355. (defun org-outline-level ()
  3356. (save-excursion
  3357. (looking-at outline-regexp)
  3358. (if (match-beginning 1)
  3359. (+ (org-get-string-indentation (match-string 1)) 1000)
  3360. (1- (- (match-end 0) (match-beginning 0))))))
  3361. (defvar org-font-lock-keywords nil)
  3362. (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
  3363. "Regular expression matching a property line.")
  3364. (defvar org-font-lock-hook nil
  3365. "Functions to be called for special font lock stuff.")
  3366. (defun org-font-lock-hook (limit)
  3367. (run-hook-with-args 'org-font-lock-hook limit))
  3368. (defun org-set-font-lock-defaults ()
  3369. (let* ((em org-fontify-emphasized-text)
  3370. (lk org-activate-links)
  3371. (org-font-lock-extra-keywords
  3372. (list
  3373. ;; Call the hook
  3374. '(org-font-lock-hook)
  3375. ;; Headlines
  3376. '("^\\(\\**\\)\\(\\* \\)\\(.*\\)" (1 (org-get-level-face 1))
  3377. (2 (org-get-level-face 2)) (3 (org-get-level-face 3)))
  3378. ;; Table lines
  3379. '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
  3380. (1 'org-table t))
  3381. ;; Table internals
  3382. '("^[ \t]*|\\(?:.*?|\\)? *\\(:?=[^|\n]*\\)" (1 'org-formula t))
  3383. '("^[ \t]*| *\\([#*]\\) *|" (1 'org-formula t))
  3384. '("^[ \t]*|\\( *\\([$!_^/]\\) *|.*\\)|" (1 'org-formula t))
  3385. ;; Drawers
  3386. (list org-drawer-regexp '(0 'org-special-keyword t))
  3387. (list "^[ \t]*:END:" '(0 'org-special-keyword t))
  3388. ;; Properties
  3389. (list org-property-re
  3390. '(1 'org-special-keyword t)
  3391. '(3 'org-property-value t))
  3392. (if org-format-transports-properties-p
  3393. '("| *\\(<[0-9]+>\\) *" (1 'org-formula t)))
  3394. ;; Links
  3395. (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
  3396. (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
  3397. (if (memq 'plain lk) '(org-activate-plain-links (0 'org-link t)))
  3398. (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
  3399. (if (memq 'radio lk) '(org-activate-target-links (0 'org-link t)))
  3400. (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
  3401. '("^&?%%(.*\\|<%%([^>\n]*?>" (0 'org-sexp-date t))
  3402. '(org-hide-wide-columns (0 nil append))
  3403. ;; TODO lines
  3404. (list (concat "^\\*+[ \t]+" org-todo-regexp)
  3405. '(1 (org-get-todo-face 1) t))
  3406. ;; DONE
  3407. (if org-fontify-done-headline
  3408. (list (concat "^[*]+ +\\<\\("
  3409. (mapconcat 'regexp-quote org-done-keywords "\\|")
  3410. "\\)\\(.*\\)")
  3411. '(2 'org-headline-done t))
  3412. nil)
  3413. ;; Priorities
  3414. (list (concat "\\[#[A-Z0-9]\\]") '(0 'org-special-keyword t))
  3415. ;; Special keywords
  3416. (list (concat "\\<" org-deadline-string) '(0 'org-special-keyword t))
  3417. (list (concat "\\<" org-scheduled-string) '(0 'org-special-keyword t))
  3418. (list (concat "\\<" org-closed-string) '(0 'org-special-keyword t))
  3419. (list (concat "\\<" org-clock-string) '(0 'org-special-keyword t))
  3420. ;; Emphasis
  3421. (if em
  3422. (if (featurep 'xemacs)
  3423. '(org-do-emphasis-faces (0 nil append))
  3424. '(org-do-emphasis-faces)))
  3425. ;; Checkboxes
  3426. '("^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) +\\(\\[[- X]\\]\\)"
  3427. 2 'bold prepend)
  3428. (if org-provide-checkbox-statistics
  3429. '("\\[\\([0-9]*%\\)\\]\\|\\[\\([0-9]*\\)/\\([0-9]*\\)\\]"
  3430. (0 (org-get-checkbox-statistics-face) t)))
  3431. ;; Description list items
  3432. '("^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) +\\(.*? ::\\)"
  3433. 2 'bold prepend)
  3434. (list (concat "^\\*+ \\(.*:" org-archive-tag ":.*\\)")
  3435. '(1 'org-archived prepend))
  3436. ;; Specials
  3437. '(org-do-latex-and-special-faces)
  3438. ;; Code
  3439. '(org-activate-code (1 'org-code t))
  3440. ;; COMMENT
  3441. (list (concat "^\\*+[ \t]+\\<\\(" org-comment-string
  3442. "\\|" org-quote-string "\\)\\>")
  3443. '(1 'org-special-keyword t))
  3444. '("^#.*" (0 'font-lock-comment-face t))
  3445. )))
  3446. (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
  3447. ;; Now set the full font-lock-keywords
  3448. (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
  3449. (org-set-local 'font-lock-defaults
  3450. '(org-font-lock-keywords t nil nil backward-paragraph))
  3451. (kill-local-variable 'font-lock-keywords) nil))
  3452. (defvar org-m nil)
  3453. (defvar org-l nil)
  3454. (defvar org-f nil)
  3455. (defun org-get-level-face (n)
  3456. "Get the right face for match N in font-lock matching of healdines."
  3457. (setq org-l (- (match-end 2) (match-beginning 1) 1))
  3458. (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
  3459. (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
  3460. (cond
  3461. ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
  3462. ((eq n 2) org-f)
  3463. (t (if org-level-color-stars-only nil org-f))))
  3464. (defun org-get-todo-face (kwd)
  3465. "Get the right face for a TODO keyword KWD.
  3466. If KWD is a number, get the corresponding match group."
  3467. (if (numberp kwd) (setq kwd (match-string kwd)))
  3468. (or (cdr (assoc kwd org-todo-keyword-faces))
  3469. (and (member kwd org-done-keywords) 'org-done)
  3470. 'org-todo))
  3471. (defun org-unfontify-region (beg end &optional maybe_loudly)
  3472. "Remove fontification and activation overlays from links."
  3473. (font-lock-default-unfontify-region beg end)
  3474. (let* ((buffer-undo-list t)
  3475. (inhibit-read-only t) (inhibit-point-motion-hooks t)
  3476. (inhibit-modification-hooks t)
  3477. deactivate-mark buffer-file-name buffer-file-truename)
  3478. (remove-text-properties beg end
  3479. '(mouse-face t keymap t org-linked-text t
  3480. invisible t intangible t))))
  3481. ;;;; Visibility cycling, including org-goto and indirect buffer
  3482. ;;; Cycling
  3483. (defvar org-cycle-global-status nil)
  3484. (make-variable-buffer-local 'org-cycle-global-status)
  3485. (defvar org-cycle-subtree-status nil)
  3486. (make-variable-buffer-local 'org-cycle-subtree-status)
  3487. ;;;###autoload
  3488. (defun org-cycle (&optional arg)
  3489. "Visibility cycling for Org-mode.
  3490. - When this function is called with a prefix argument, rotate the entire
  3491. buffer through 3 states (global cycling)
  3492. 1. OVERVIEW: Show only top-level headlines.
  3493. 2. CONTENTS: Show all headlines of all levels, but no body text.
  3494. 3. SHOW ALL: Show everything.
  3495. When called with two C-c C-u prefixes, switch to the startup visibility,
  3496. determined by the variable `org-startup-folded', and by any VISIBILITY
  3497. properties in the buffer.
  3498. - When point is at the beginning of a headline, rotate the subtree started
  3499. by this line through 3 different states (local cycling)
  3500. 1. FOLDED: Only the main headline is shown.
  3501. 2. CHILDREN: The main headline and the direct children are shown.
  3502. From this state, you can move to one of the children
  3503. and zoom in further.
  3504. 3. SUBTREE: Show the entire subtree, including body text.
  3505. - When there is a numeric prefix, go up to a heading with level ARG, do
  3506. a `show-subtree' and return to the previous cursor position. If ARG
  3507. is negative, go up that many levels.
  3508. - When point is not at the beginning of a headline, execute the global
  3509. binding for TAB, which is re-indenting the line. See the option
  3510. `org-cycle-emulate-tab' for details.
  3511. - Special case: if point is at the beginning of the buffer and there is
  3512. no headline in line 1, this function will act as if called with prefix arg.
  3513. But only if also the variable `org-cycle-global-at-bob' is t."
  3514. (interactive "P")
  3515. (org-load-modules-maybe)
  3516. (let* ((outline-regexp
  3517. (if (and (org-mode-p) org-cycle-include-plain-lists)
  3518. "\\(?:\\*+ \\|\\([ \t]*\\)\\([-+*]\\|[0-9]+[.)]\\) \\)"
  3519. outline-regexp))
  3520. (bob-special (and org-cycle-global-at-bob (bobp)
  3521. (not (looking-at outline-regexp))))
  3522. (org-cycle-hook
  3523. (if bob-special
  3524. (delq 'org-optimize-window-after-visibility-change
  3525. (copy-sequence org-cycle-hook))
  3526. org-cycle-hook))
  3527. (pos (point)))
  3528. (if (or bob-special (equal arg '(4)))
  3529. ;; special case: use global cycling
  3530. (setq arg t))
  3531. (cond
  3532. ((equal arg '(16))
  3533. (org-set-startup-visibility)
  3534. (message "Startup visibility, plus VISIBILITY properties."))
  3535. ((org-at-table-p 'any)
  3536. ;; Enter the table or move to the next field in the table
  3537. (or (org-table-recognize-table.el)
  3538. (progn
  3539. (if arg (org-table-edit-field t)
  3540. (org-table-justify-field-maybe)
  3541. (call-interactively 'org-table-next-field)))))
  3542. ((eq arg t) ;; Global cycling
  3543. (cond
  3544. ((and (eq last-command this-command)
  3545. (eq org-cycle-global-status 'overview))
  3546. ;; We just created the overview - now do table of contents
  3547. ;; This can be slow in very large buffers, so indicate action
  3548. (message "CONTENTS...")
  3549. (org-content)
  3550. (message "CONTENTS...done")
  3551. (setq org-cycle-global-status 'contents)
  3552. (run-hook-with-args 'org-cycle-hook 'contents))
  3553. ((and (eq last-command this-command)
  3554. (eq org-cycle-global-status 'contents))
  3555. ;; We just showed the table of contents - now show everything
  3556. (show-all)
  3557. (message "SHOW ALL")
  3558. (setq org-cycle-global-status 'all)
  3559. (run-hook-with-args 'org-cycle-hook 'all))
  3560. (t
  3561. ;; Default action: go to overview
  3562. (org-overview)
  3563. (message "OVERVIEW")
  3564. (setq org-cycle-global-status 'overview)
  3565. (run-hook-with-args 'org-cycle-hook 'overview))))
  3566. ((and org-drawers org-drawer-regexp
  3567. (save-excursion
  3568. (beginning-of-line 1)
  3569. (looking-at org-drawer-regexp)))
  3570. ;; Toggle block visibility
  3571. (org-flag-drawer
  3572. (not (get-char-property (match-end 0) 'invisible))))
  3573. ((integerp arg)
  3574. ;; Show-subtree, ARG levels up from here.
  3575. (save-excursion
  3576. (org-back-to-heading)
  3577. (outline-up-heading (if (< arg 0) (- arg)
  3578. (- (funcall outline-level) arg)))
  3579. (org-show-subtree)))
  3580. ((and (save-excursion (beginning-of-line 1) (looking-at outline-regexp))
  3581. (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
  3582. ;; At a heading: rotate between three different views
  3583. (org-back-to-heading)
  3584. (let ((goal-column 0) eoh eol eos)
  3585. ;; First, some boundaries
  3586. (save-excursion
  3587. (org-back-to-heading)
  3588. (save-excursion
  3589. (beginning-of-line 2)
  3590. (while (and (not (eobp)) ;; this is like `next-line'
  3591. (get-char-property (1- (point)) 'invisible))
  3592. (beginning-of-line 2)) (setq eol (point)))
  3593. (outline-end-of-heading) (setq eoh (point))
  3594. (org-end-of-subtree t)
  3595. (unless (eobp)
  3596. (skip-chars-forward " \t\n")
  3597. (beginning-of-line 1) ; in case this is an item
  3598. )
  3599. (setq eos (1- (point))))
  3600. ;; Find out what to do next and set `this-command'
  3601. (cond
  3602. ((= eos eoh)
  3603. ;; Nothing is hidden behind this heading
  3604. (message "EMPTY ENTRY")
  3605. (setq org-cycle-subtree-status nil)
  3606. (save-excursion
  3607. (goto-char eos)
  3608. (outline-next-heading)
  3609. (if (org-invisible-p) (org-flag-heading nil))))
  3610. ((or (>= eol eos)
  3611. (not (string-match "\\S-" (buffer-substring eol eos))))
  3612. ;; Entire subtree is hidden in one line: open it
  3613. (org-show-entry)
  3614. (show-children)
  3615. (message "CHILDREN")
  3616. (save-excursion
  3617. (goto-char eos)
  3618. (outline-next-heading)
  3619. (if (org-invisible-p) (org-flag-heading nil)))
  3620. (setq org-cycle-subtree-status 'children)
  3621. (run-hook-with-args 'org-cycle-hook 'children))
  3622. ((and (eq last-command this-command)
  3623. (eq org-cycle-subtree-status 'children))
  3624. ;; We just showed the children, now show everything.
  3625. (org-show-subtree)
  3626. (message "SUBTREE")
  3627. (setq org-cycle-subtree-status 'subtree)
  3628. (run-hook-with-args 'org-cycle-hook 'subtree))
  3629. (t
  3630. ;; Default action: hide the subtree.
  3631. (hide-subtree)
  3632. (message "FOLDED")
  3633. (setq org-cycle-subtree-status 'folded)
  3634. (run-hook-with-args 'org-cycle-hook 'folded)))))
  3635. ;; TAB emulation and template completion
  3636. (buffer-read-only (org-back-to-heading))
  3637. ((org-try-structure-completion))
  3638. ((org-try-cdlatex-tab))
  3639. ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
  3640. (or (not (bolp))
  3641. (not (looking-at outline-regexp))))
  3642. (call-interactively (global-key-binding "\t")))
  3643. ((if (and (memq org-cycle-emulate-tab '(white whitestart))
  3644. (save-excursion (beginning-of-line 1) (looking-at "[ \t]*"))
  3645. (or (and (eq org-cycle-emulate-tab 'white)
  3646. (= (match-end 0) (point-at-eol)))
  3647. (and (eq org-cycle-emulate-tab 'whitestart)
  3648. (>= (match-end 0) pos))))
  3649. t
  3650. (eq org-cycle-emulate-tab t))
  3651. (call-interactively (global-key-binding "\t")))
  3652. (t (save-excursion
  3653. (org-back-to-heading)
  3654. (org-cycle))))))
  3655. ;;;###autoload
  3656. (defun org-global-cycle (&optional arg)
  3657. "Cycle the global visibility. For details see `org-cycle'.
  3658. With C-u prefix arg, switch to startup visibility.
  3659. With a numeric prefix, show all headlines up to that level."
  3660. (interactive "P")
  3661. (let ((org-cycle-include-plain-lists
  3662. (if (org-mode-p) org-cycle-include-plain-lists nil)))
  3663. (cond
  3664. ((integerp arg)
  3665. (show-all)
  3666. (hide-sublevels arg)
  3667. (setq org-cycle-global-status 'contents))
  3668. ((equal arg '(4))
  3669. (org-set-startup-visibility)
  3670. (message "Startup visibility, plus VISIBILITY properties."))
  3671. (t
  3672. (org-cycle '(4))))))
  3673. (defun org-set-startup-visibility ()
  3674. "Set the visibility required by startup options and properties."
  3675. (cond
  3676. ((eq org-startup-folded t)
  3677. (org-cycle '(4)))
  3678. ((eq org-startup-folded 'content)
  3679. (let ((this-command 'org-cycle) (last-command 'org-cycle))
  3680. (org-cycle '(4)) (org-cycle '(4)))))
  3681. (org-set-visibility-according-to-property 'no-cleanup)
  3682. (org-cycle-hide-archived-subtrees 'all)
  3683. (org-cycle-hide-drawers 'all)
  3684. (org-cycle-show-empty-lines 'all))
  3685. (defun org-set-visibility-according-to-property (&optional no-cleanup)
  3686. "Switch subtree visibilities according to :VISIBILITY: property."
  3687. (interactive)
  3688. (let (state)
  3689. (save-excursion
  3690. (goto-char (point-min))
  3691. (while (re-search-forward
  3692. "^[ \t]*:VISIBILITY:[ \t]+\\([a-z]+\\)"
  3693. nil t)
  3694. (setq state (match-string 1))
  3695. (save-excursion
  3696. (org-back-to-heading t)
  3697. (hide-subtree)
  3698. (org-reveal)
  3699. (cond
  3700. ((equal state '("fold" "folded"))
  3701. (hide-subtree))
  3702. ((equal state "children")
  3703. (org-show-hidden-entry)
  3704. (show-children))
  3705. ((equal state "content")
  3706. (save-excursion
  3707. (save-restriction
  3708. (org-narrow-to-subtree)
  3709. (org-content))))
  3710. ((member state '("all" "showall"))
  3711. (show-subtree)))))
  3712. (unless no-cleanup
  3713. (org-cycle-hide-archived-subtrees 'all)
  3714. (org-cycle-hide-drawers 'all)
  3715. (org-cycle-show-empty-lines 'all)))))
  3716. (defun org-overview ()
  3717. "Switch to overview mode, shoing only top-level headlines.
  3718. Really, this shows all headlines with level equal or greater than the level
  3719. of the first headline in the buffer. This is important, because if the
  3720. first headline is not level one, then (hide-sublevels 1) gives confusing
  3721. results."
  3722. (interactive)
  3723. (let ((level (save-excursion
  3724. (goto-char (point-min))
  3725. (if (re-search-forward (concat "^" outline-regexp) nil t)
  3726. (progn
  3727. (goto-char (match-beginning 0))
  3728. (funcall outline-level))))))
  3729. (and level (hide-sublevels level))))
  3730. (defun org-content (&optional arg)
  3731. "Show all headlines in the buffer, like a table of contents.
  3732. With numerical argument N, show content up to level N."
  3733. (interactive "P")
  3734. (save-excursion
  3735. ;; Visit all headings and show their offspring
  3736. (and (integerp arg) (org-overview))
  3737. (goto-char (point-max))
  3738. (catch 'exit
  3739. (while (and (progn (condition-case nil
  3740. (outline-previous-visible-heading 1)
  3741. (error (goto-char (point-min))))
  3742. t)
  3743. (looking-at outline-regexp))
  3744. (if (integerp arg)
  3745. (show-children (1- arg))
  3746. (show-branches))
  3747. (if (bobp) (throw 'exit nil))))))
  3748. (defun org-optimize-window-after-visibility-change (state)
  3749. "Adjust the window after a change in outline visibility.
  3750. This function is the default value of the hook `org-cycle-hook'."
  3751. (when (get-buffer-window (current-buffer))
  3752. (cond
  3753. ; ((eq state 'overview) (org-first-headline-recenter 1))
  3754. ; ((eq state 'overview) (org-beginning-of-line))
  3755. ((eq state 'content) nil)
  3756. ((eq state 'all) nil)
  3757. ((eq state 'folded) nil)
  3758. ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
  3759. ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
  3760. (defun org-compact-display-after-subtree-move ()
  3761. (let (beg end)
  3762. (save-excursion
  3763. (if (org-up-heading-safe)
  3764. (progn
  3765. (hide-subtree)
  3766. (show-entry)
  3767. (show-children)
  3768. (org-cycle-show-empty-lines 'children)
  3769. (org-cycle-hide-drawers 'children))
  3770. (org-overview)))))
  3771. (defun org-cycle-show-empty-lines (state)
  3772. "Show empty lines above all visible headlines.
  3773. The region to be covered depends on STATE when called through
  3774. `org-cycle-hook'. Lisp program can use t for STATE to get the
  3775. entire buffer covered. Note that an empty line is only shown if there
  3776. are at least `org-cycle-separator-lines' empty lines before the headeline."
  3777. (when (> org-cycle-separator-lines 0)
  3778. (save-excursion
  3779. (let* ((n org-cycle-separator-lines)
  3780. (re (cond
  3781. ((= n 1) "\\(\n[ \t]*\n\\*+\\) ")
  3782. ((= n 2) "^[ \t]*\\(\n[ \t]*\n\\*+\\) ")
  3783. (t (let ((ns (number-to-string (- n 2))))
  3784. (concat "^\\(?:[ \t]*\n\\)\\{" ns "," ns "\\}"
  3785. "[ \t]*\\(\n[ \t]*\n\\*+\\) ")))))
  3786. beg end)
  3787. (cond
  3788. ((memq state '(overview contents t))
  3789. (setq beg (point-min) end (point-max)))
  3790. ((memq state '(children folded))
  3791. (setq beg (point) end (progn (org-end-of-subtree t t)
  3792. (beginning-of-line 2)
  3793. (point)))))
  3794. (when beg
  3795. (goto-char beg)
  3796. (while (re-search-forward re end t)
  3797. (if (not (get-char-property (match-end 1) 'invisible))
  3798. (outline-flag-region
  3799. (match-beginning 1) (match-end 1) nil)))))))
  3800. ;; Never hide empty lines at the end of the file.
  3801. (save-excursion
  3802. (goto-char (point-max))
  3803. (outline-previous-heading)
  3804. (outline-end-of-heading)
  3805. (if (and (looking-at "[ \t\n]+")
  3806. (= (match-end 0) (point-max)))
  3807. (outline-flag-region (point) (match-end 0) nil))))
  3808. (defun org-show-empty-lines-in-parent ()
  3809. "Move to the parent and re-show empty lines before visible headlines."
  3810. (save-excursion
  3811. (let ((context (if (org-up-heading-safe) 'children 'overview)))
  3812. (org-cycle-show-empty-lines context))))
  3813. (defun org-cycle-hide-drawers (state)
  3814. "Re-hide all drawers after a visibility state change."
  3815. (when (and (org-mode-p)
  3816. (not (memq state '(overview folded))))
  3817. (save-excursion
  3818. (let* ((globalp (memq state '(contents all)))
  3819. (beg (if globalp (point-min) (point)))
  3820. (end (if globalp (point-max) (org-end-of-subtree t))))
  3821. (goto-char beg)
  3822. (while (re-search-forward org-drawer-regexp end t)
  3823. (org-flag-drawer t))))))
  3824. (defun org-flag-drawer (flag)
  3825. (save-excursion
  3826. (beginning-of-line 1)
  3827. (when (looking-at "^[ \t]*:[a-zA-Z][a-zA-Z0-9]*:")
  3828. (let ((b (match-end 0))
  3829. (outline-regexp org-outline-regexp))
  3830. (if (re-search-forward
  3831. "^[ \t]*:END:"
  3832. (save-excursion (outline-next-heading) (point)) t)
  3833. (outline-flag-region b (point-at-eol) flag)
  3834. (error ":END: line missing"))))))
  3835. (defun org-subtree-end-visible-p ()
  3836. "Is the end of the current subtree visible?"
  3837. (pos-visible-in-window-p
  3838. (save-excursion (org-end-of-subtree t) (point))))
  3839. (defun org-first-headline-recenter (&optional N)
  3840. "Move cursor to the first headline and recenter the headline.
  3841. Optional argument N means, put the headline into the Nth line of the window."
  3842. (goto-char (point-min))
  3843. (when (re-search-forward (concat "^\\(" outline-regexp "\\)") nil t)
  3844. (beginning-of-line)
  3845. (recenter (prefix-numeric-value N))))
  3846. ;;; Org-goto
  3847. (defvar org-goto-window-configuration nil)
  3848. (defvar org-goto-marker nil)
  3849. (defvar org-goto-map
  3850. (let ((map (make-sparse-keymap)))
  3851. (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
  3852. (while (setq cmd (pop cmds))
  3853. (substitute-key-definition cmd cmd map global-map)))
  3854. (suppress-keymap map)
  3855. (org-defkey map "\C-m" 'org-goto-ret)
  3856. (org-defkey map [(return)] 'org-goto-ret)
  3857. (org-defkey map [(left)] 'org-goto-left)
  3858. (org-defkey map [(right)] 'org-goto-right)
  3859. (org-defkey map [(control ?g)] 'org-goto-quit)
  3860. (org-defkey map "\C-i" 'org-cycle)
  3861. (org-defkey map [(tab)] 'org-cycle)
  3862. (org-defkey map [(down)] 'outline-next-visible-heading)
  3863. (org-defkey map [(up)] 'outline-previous-visible-heading)
  3864. (if org-goto-auto-isearch
  3865. (if (fboundp 'define-key-after)
  3866. (define-key-after map [t] 'org-goto-local-auto-isearch)
  3867. nil)
  3868. (org-defkey map "q" 'org-goto-quit)
  3869. (org-defkey map "n" 'outline-next-visible-heading)
  3870. (org-defkey map "p" 'outline-previous-visible-heading)
  3871. (org-defkey map "f" 'outline-forward-same-level)
  3872. (org-defkey map "b" 'outline-backward-same-level)
  3873. (org-defkey map "u" 'outline-up-heading))
  3874. (org-defkey map "/" 'org-occur)
  3875. (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
  3876. (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
  3877. (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
  3878. (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
  3879. (org-defkey map "\C-c\C-u" 'outline-up-heading)
  3880. map))
  3881. (defconst org-goto-help
  3882. "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
  3883. RET=jump to location [Q]uit and return to previous location
  3884. \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
  3885. (defvar org-goto-start-pos) ; dynamically scoped parameter
  3886. ;; FIXME: Docstring doe not mention both interfaces
  3887. (defun org-goto (&optional alternative-interface)
  3888. "Look up a different location in the current file, keeping current visibility.
  3889. When you want look-up or go to a different location in a document, the
  3890. fastest way is often to fold the entire buffer and then dive into the tree.
  3891. This method has the disadvantage, that the previous location will be folded,
  3892. which may not be what you want.
  3893. This command works around this by showing a copy of the current buffer
  3894. in an indirect buffer, in overview mode. You can dive into the tree in
  3895. that copy, use org-occur and incremental search to find a location.
  3896. When pressing RET or `Q', the command returns to the original buffer in
  3897. which the visibility is still unchanged. After RET is will also jump to
  3898. the location selected in the indirect buffer and expose the
  3899. the headline hierarchy above."
  3900. (interactive "P")
  3901. (let* ((org-refile-targets '((nil . (:maxlevel . 10))))
  3902. (org-refile-use-outline-path t)
  3903. (interface
  3904. (if (not alternative-interface)
  3905. org-goto-interface
  3906. (if (eq org-goto-interface 'outline)
  3907. 'outline-path-completion
  3908. 'outline)))
  3909. (org-goto-start-pos (point))
  3910. (selected-point
  3911. (if (eq interface 'outline)
  3912. (car (org-get-location (current-buffer) org-goto-help))
  3913. (nth 3 (org-refile-get-location "Goto: ")))))
  3914. (if selected-point
  3915. (progn
  3916. (org-mark-ring-push org-goto-start-pos)
  3917. (goto-char selected-point)
  3918. (if (or (org-invisible-p) (org-invisible-p2))
  3919. (org-show-context 'org-goto)))
  3920. (message "Quit"))))
  3921. (defvar org-goto-selected-point nil) ; dynamically scoped parameter
  3922. (defvar org-goto-exit-command nil) ; dynamically scoped parameter
  3923. (defvar org-goto-local-auto-isearch-map) ; defined below
  3924. (defun org-get-location (buf help)
  3925. "Let the user select a location in the Org-mode buffer BUF.
  3926. This function uses a recursive edit. It returns the selected position
  3927. or nil."
  3928. (let ((isearch-mode-map org-goto-local-auto-isearch-map)
  3929. (isearch-hide-immediately nil)
  3930. (isearch-search-fun-function
  3931. (lambda () 'org-goto-local-search-headings))
  3932. (org-goto-selected-point org-goto-exit-command))
  3933. (save-excursion
  3934. (save-window-excursion
  3935. (delete-other-windows)
  3936. (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
  3937. (switch-to-buffer
  3938. (condition-case nil
  3939. (make-indirect-buffer (current-buffer) "*org-goto*")
  3940. (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
  3941. (with-output-to-temp-buffer "*Help*"
  3942. (princ help))
  3943. (shrink-window-if-larger-than-buffer (get-buffer-window "*Help*"))
  3944. (setq buffer-read-only nil)
  3945. (let ((org-startup-truncated t)
  3946. (org-startup-folded nil)
  3947. (org-startup-align-all-tables nil))
  3948. (org-mode)
  3949. (org-overview))
  3950. (setq buffer-read-only t)
  3951. (if (and (boundp 'org-goto-start-pos)
  3952. (integer-or-marker-p org-goto-start-pos))
  3953. (let ((org-show-hierarchy-above t)
  3954. (org-show-siblings t)
  3955. (org-show-following-heading t))
  3956. (goto-char org-goto-start-pos)
  3957. (and (org-invisible-p) (org-show-context)))
  3958. (goto-char (point-min)))
  3959. (org-beginning-of-line)
  3960. (message "Select location and press RET")
  3961. (use-local-map org-goto-map)
  3962. (recursive-edit)
  3963. ))
  3964. (kill-buffer "*org-goto*")
  3965. (cons org-goto-selected-point org-goto-exit-command)))
  3966. (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
  3967. (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
  3968. (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
  3969. (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
  3970. (defun org-goto-local-search-headings (string bound noerror)
  3971. "Search and make sure that any matches are in headlines."
  3972. (catch 'return
  3973. (while (if isearch-forward
  3974. (search-forward string bound noerror)
  3975. (search-backward string bound noerror))
  3976. (when (let ((context (mapcar 'car (save-match-data (org-context)))))
  3977. (and (member :headline context)
  3978. (not (member :tags context))))
  3979. (throw 'return (point))))))
  3980. (defun org-goto-local-auto-isearch ()
  3981. "Start isearch."
  3982. (interactive)
  3983. (goto-char (point-min))
  3984. (let ((keys (this-command-keys)))
  3985. (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
  3986. (isearch-mode t)
  3987. (isearch-process-search-char (string-to-char keys)))))
  3988. (defun org-goto-ret (&optional arg)
  3989. "Finish `org-goto' by going to the new location."
  3990. (interactive "P")
  3991. (setq org-goto-selected-point (point)
  3992. org-goto-exit-command 'return)
  3993. (throw 'exit nil))
  3994. (defun org-goto-left ()
  3995. "Finish `org-goto' by going to the new location."
  3996. (interactive)
  3997. (if (org-on-heading-p)
  3998. (progn
  3999. (beginning-of-line 1)
  4000. (setq org-goto-selected-point (point)
  4001. org-goto-exit-command 'left)
  4002. (throw 'exit nil))
  4003. (error "Not on a heading")))
  4004. (defun org-goto-right ()
  4005. "Finish `org-goto' by going to the new location."
  4006. (interactive)
  4007. (if (org-on-heading-p)
  4008. (progn
  4009. (setq org-goto-selected-point (point)
  4010. org-goto-exit-command 'right)
  4011. (throw 'exit nil))
  4012. (error "Not on a heading")))
  4013. (defun org-goto-quit ()
  4014. "Finish `org-goto' without cursor motion."
  4015. (interactive)
  4016. (setq org-goto-selected-point nil)
  4017. (setq org-goto-exit-command 'quit)
  4018. (throw 'exit nil))
  4019. ;;; Indirect buffer display of subtrees
  4020. (defvar org-indirect-dedicated-frame nil
  4021. "This is the frame being used for indirect tree display.")
  4022. (defvar org-last-indirect-buffer nil)
  4023. (defun org-tree-to-indirect-buffer (&optional arg)
  4024. "Create indirect buffer and narrow it to current subtree.
  4025. With numerical prefix ARG, go up to this level and then take that tree.
  4026. If ARG is negative, go up that many levels.
  4027. If `org-indirect-buffer-display' is not `new-frame', the command removes the
  4028. indirect buffer previously made with this command, to avoid proliferation of
  4029. indirect buffers. However, when you call the command with a `C-u' prefix, or
  4030. when `org-indirect-buffer-display' is `new-frame', the last buffer
  4031. is kept so that you can work with several indirect buffers at the same time.
  4032. If `org-indirect-buffer-display' is `dedicated-frame', the C-u prefix also
  4033. requests that a new frame be made for the new buffer, so that the dedicated
  4034. frame is not changed."
  4035. (interactive "P")
  4036. (let ((cbuf (current-buffer))
  4037. (cwin (selected-window))
  4038. (pos (point))
  4039. beg end level heading ibuf)
  4040. (save-excursion
  4041. (org-back-to-heading t)
  4042. (when (numberp arg)
  4043. (setq level (org-outline-level))
  4044. (if (< arg 0) (setq arg (+ level arg)))
  4045. (while (> (setq level (org-outline-level)) arg)
  4046. (outline-up-heading 1 t)))
  4047. (setq beg (point)
  4048. heading (org-get-heading))
  4049. (org-end-of-subtree t) (setq end (point)))
  4050. (if (and (buffer-live-p org-last-indirect-buffer)
  4051. (not (eq org-indirect-buffer-display 'new-frame))
  4052. (not arg))
  4053. (kill-buffer org-last-indirect-buffer))
  4054. (setq ibuf (org-get-indirect-buffer cbuf)
  4055. org-last-indirect-buffer ibuf)
  4056. (cond
  4057. ((or (eq org-indirect-buffer-display 'new-frame)
  4058. (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
  4059. (select-frame (make-frame))
  4060. (delete-other-windows)
  4061. (switch-to-buffer ibuf)
  4062. (org-set-frame-title heading))
  4063. ((eq org-indirect-buffer-display 'dedicated-frame)
  4064. (raise-frame
  4065. (select-frame (or (and org-indirect-dedicated-frame
  4066. (frame-live-p org-indirect-dedicated-frame)
  4067. org-indirect-dedicated-frame)
  4068. (setq org-indirect-dedicated-frame (make-frame)))))
  4069. (delete-other-windows)
  4070. (switch-to-buffer ibuf)
  4071. (org-set-frame-title (concat "Indirect: " heading)))
  4072. ((eq org-indirect-buffer-display 'current-window)
  4073. (switch-to-buffer ibuf))
  4074. ((eq org-indirect-buffer-display 'other-window)
  4075. (pop-to-buffer ibuf))
  4076. (t (error "Invalid value.")))
  4077. (if (featurep 'xemacs)
  4078. (save-excursion (org-mode) (turn-on-font-lock)))
  4079. (narrow-to-region beg end)
  4080. (show-all)
  4081. (goto-char pos)
  4082. (and (window-live-p cwin) (select-window cwin))))
  4083. (defun org-get-indirect-buffer (&optional buffer)
  4084. (setq buffer (or buffer (current-buffer)))
  4085. (let ((n 1) (base (buffer-name buffer)) bname)
  4086. (while (buffer-live-p
  4087. (get-buffer (setq bname (concat base "-" (number-to-string n)))))
  4088. (setq n (1+ n)))
  4089. (condition-case nil
  4090. (make-indirect-buffer buffer bname 'clone)
  4091. (error (make-indirect-buffer buffer bname)))))
  4092. (defun org-set-frame-title (title)
  4093. "Set the title of the current frame to the string TITLE."
  4094. ;; FIXME: how to name a single frame in XEmacs???
  4095. (unless (featurep 'xemacs)
  4096. (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
  4097. ;;;; Structure editing
  4098. ;;; Inserting headlines
  4099. (defun org-insert-heading (&optional force-heading)
  4100. "Insert a new heading or item with same depth at point.
  4101. If point is in a plain list and FORCE-HEADING is nil, create a new list item.
  4102. If point is at the beginning of a headline, insert a sibling before the
  4103. current headline. If point is not at the beginning, do not split the line,
  4104. but create the new hedline after the current line."
  4105. (interactive "P")
  4106. (if (= (buffer-size) 0)
  4107. (insert "\n* ")
  4108. (when (or force-heading (not (org-insert-item)))
  4109. (let* ((head (save-excursion
  4110. (condition-case nil
  4111. (progn
  4112. (org-back-to-heading)
  4113. (match-string 0))
  4114. (error "*"))))
  4115. (blank (cdr (assq 'heading org-blank-before-new-entry)))
  4116. pos)
  4117. (cond
  4118. ((and (org-on-heading-p) (bolp)
  4119. (or (bobp)
  4120. (save-excursion (backward-char 1) (not (org-invisible-p)))))
  4121. ;; insert before the current line
  4122. (open-line (if blank 2 1)))
  4123. ((and (bolp)
  4124. (or (bobp)
  4125. (save-excursion
  4126. (backward-char 1) (not (org-invisible-p)))))
  4127. ;; insert right here
  4128. nil)
  4129. (t
  4130. ;; in the middle of the line
  4131. (org-show-entry)
  4132. (let ((split
  4133. (org-get-alist-option org-M-RET-may-split-line 'headline))
  4134. tags pos)
  4135. (cond
  4136. (org-insert-heading-respect-content
  4137. (org-end-of-subtree nil t)
  4138. (open-line 1))
  4139. ((org-on-heading-p)
  4140. (looking-at ".*?\\([ \t]+\\(:[[:alnum:]_@:]+:\\)\\)?[ \t]*$")
  4141. (setq tags (and (match-end 2) (match-string 2)))
  4142. (and (match-end 1)
  4143. (delete-region (match-beginning 1) (match-end 1)))
  4144. (setq pos (point-at-bol))
  4145. (or split (end-of-line 1))
  4146. (delete-horizontal-space)
  4147. (newline (if blank 2 1))
  4148. (when tags
  4149. (save-excursion
  4150. (goto-char pos)
  4151. (end-of-line 1)
  4152. (insert " " tags)
  4153. (org-set-tags nil 'align))))
  4154. (t
  4155. (or split (end-of-line 1))
  4156. (newline (if blank 2 1)))))))
  4157. (insert head) (just-one-space)
  4158. (setq pos (point))
  4159. (end-of-line 1)
  4160. (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
  4161. (run-hooks 'org-insert-heading-hook)))))
  4162. (defun org-get-heading (&optional no-tags)
  4163. "Return the heading of the current entry, without the stars."
  4164. (save-excursion
  4165. (org-back-to-heading t)
  4166. (if (looking-at
  4167. (if no-tags
  4168. (org-re "\\*+[ \t]+\\([^\n\r]*?\\)\\([ \t]+:[[:alnum:]:_@]+:[ \t]*\\)?$")
  4169. "\\*+[ \t]+\\([^\r\n]*\\)"))
  4170. (match-string 1) "")))
  4171. (defun org-insert-heading-after-current ()
  4172. "Insert a new heading with same level as current, after current subtree."
  4173. (interactive)
  4174. (org-back-to-heading)
  4175. (org-insert-heading)
  4176. (org-move-subtree-down)
  4177. (end-of-line 1))
  4178. (defun org-insert-heading-respect-content ()
  4179. (interactive)
  4180. (let ((org-insert-heading-respect-content t))
  4181. (call-interactively 'org-insert-heading)))
  4182. (defun org-insert-todo-heading-respect-content ()
  4183. (interactive)
  4184. (let ((org-insert-heading-respect-content t))
  4185. (call-interactively 'org-insert-todo-todo-heading)))
  4186. (defun org-insert-todo-heading (arg)
  4187. "Insert a new heading with the same level and TODO state as current heading.
  4188. If the heading has no TODO state, or if the state is DONE, use the first
  4189. state (TODO by default). Also with prefix arg, force first state."
  4190. (interactive "P")
  4191. (when (not (org-insert-item 'checkbox))
  4192. (org-insert-heading)
  4193. (save-excursion
  4194. (org-back-to-heading)
  4195. (outline-previous-heading)
  4196. (looking-at org-todo-line-regexp))
  4197. (if (or arg
  4198. (not (match-beginning 2))
  4199. (member (match-string 2) org-done-keywords))
  4200. (insert (car org-todo-keywords-1) " ")
  4201. (insert (match-string 2) " "))
  4202. (when org-provide-todo-statistics
  4203. (org-update-parent-todo-statistics))))
  4204. (defun org-insert-subheading (arg)
  4205. "Insert a new subheading and demote it.
  4206. Works for outline headings and for plain lists alike."
  4207. (interactive "P")
  4208. (org-insert-heading arg)
  4209. (cond
  4210. ((org-on-heading-p) (org-do-demote))
  4211. ((org-at-item-p) (org-indent-item 1))))
  4212. (defun org-insert-todo-subheading (arg)
  4213. "Insert a new subheading with TODO keyword or checkbox and demote it.
  4214. Works for outline headings and for plain lists alike."
  4215. (interactive "P")
  4216. (org-insert-todo-heading arg)
  4217. (cond
  4218. ((org-on-heading-p) (org-do-demote))
  4219. ((org-at-item-p) (org-indent-item 1))))
  4220. ;;; Promotion and Demotion
  4221. (defun org-promote-subtree ()
  4222. "Promote the entire subtree.
  4223. See also `org-promote'."
  4224. (interactive)
  4225. (save-excursion
  4226. (org-map-tree 'org-promote))
  4227. (org-fix-position-after-promote))
  4228. (defun org-demote-subtree ()
  4229. "Demote the entire subtree. See `org-demote'.
  4230. See also `org-promote'."
  4231. (interactive)
  4232. (save-excursion
  4233. (org-map-tree 'org-demote))
  4234. (org-fix-position-after-promote))
  4235. (defun org-do-promote ()
  4236. "Promote the current heading higher up the tree.
  4237. If the region is active in `transient-mark-mode', promote all headings
  4238. in the region."
  4239. (interactive)
  4240. (save-excursion
  4241. (if (org-region-active-p)
  4242. (org-map-region 'org-promote (region-beginning) (region-end))
  4243. (org-promote)))
  4244. (org-fix-position-after-promote))
  4245. (defun org-do-demote ()
  4246. "Demote the current heading lower down the tree.
  4247. If the region is active in `transient-mark-mode', demote all headings
  4248. in the region."
  4249. (interactive)
  4250. (save-excursion
  4251. (if (org-region-active-p)
  4252. (org-map-region 'org-demote (region-beginning) (region-end))
  4253. (org-demote)))
  4254. (org-fix-position-after-promote))
  4255. (defun org-fix-position-after-promote ()
  4256. "Make sure that after pro/demotion cursor position is right."
  4257. (let ((pos (point)))
  4258. (when (save-excursion
  4259. (beginning-of-line 1)
  4260. (looking-at org-todo-line-regexp)
  4261. (or (equal pos (match-end 1)) (equal pos (match-end 2))))
  4262. (cond ((eobp) (insert " "))
  4263. ((eolp) (insert " "))
  4264. ((equal (char-after) ?\ ) (forward-char 1))))))
  4265. (defun org-reduced-level (l)
  4266. (if org-odd-levels-only (1+ (floor (/ l 2))) l))
  4267. (defun org-get-valid-level (level &optional change)
  4268. "Rectify a level change under the influence of `org-odd-levels-only'
  4269. LEVEL is a current level, CHANGE is by how much the level should be
  4270. modified. Even if CHANGE is nil, LEVEL may be returned modified because
  4271. even level numbers will become the next higher odd number."
  4272. (if org-odd-levels-only
  4273. (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
  4274. ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
  4275. ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
  4276. (max 1 (+ level change))))
  4277. (if (boundp 'define-obsolete-function-alias)
  4278. (if (or (featurep 'xemacs) (< emacs-major-version 23))
  4279. (define-obsolete-function-alias 'org-get-legal-level
  4280. 'org-get-valid-level)
  4281. (define-obsolete-function-alias 'org-get-legal-level
  4282. 'org-get-valid-level "23.1")))
  4283. (defun org-promote ()
  4284. "Promote the current heading higher up the tree.
  4285. If the region is active in `transient-mark-mode', promote all headings
  4286. in the region."
  4287. (org-back-to-heading t)
  4288. (let* ((level (save-match-data (funcall outline-level)))
  4289. (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
  4290. (diff (abs (- level (length up-head) -1))))
  4291. (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
  4292. (replace-match up-head nil t)
  4293. ;; Fixup tag positioning
  4294. (and org-auto-align-tags (org-set-tags nil t))
  4295. (if org-adapt-indentation (org-fixup-indentation (- diff)))))
  4296. (defun org-demote ()
  4297. "Demote the current heading lower down the tree.
  4298. If the region is active in `transient-mark-mode', demote all headings
  4299. in the region."
  4300. (org-back-to-heading t)
  4301. (let* ((level (save-match-data (funcall outline-level)))
  4302. (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
  4303. (diff (abs (- level (length down-head) -1))))
  4304. (replace-match down-head nil t)
  4305. ;; Fixup tag positioning
  4306. (and org-auto-align-tags (org-set-tags nil t))
  4307. (if org-adapt-indentation (org-fixup-indentation diff))))
  4308. (defun org-map-tree (fun)
  4309. "Call FUN for every heading underneath the current one."
  4310. (org-back-to-heading)
  4311. (let ((level (funcall outline-level)))
  4312. (save-excursion
  4313. (funcall fun)
  4314. (while (and (progn
  4315. (outline-next-heading)
  4316. (> (funcall outline-level) level))
  4317. (not (eobp)))
  4318. (funcall fun)))))
  4319. (defun org-map-region (fun beg end)
  4320. "Call FUN for every heading between BEG and END."
  4321. (let ((org-ignore-region t))
  4322. (save-excursion
  4323. (setq end (copy-marker end))
  4324. (goto-char beg)
  4325. (if (and (re-search-forward (concat "^" outline-regexp) nil t)
  4326. (< (point) end))
  4327. (funcall fun))
  4328. (while (and (progn
  4329. (outline-next-heading)
  4330. (< (point) end))
  4331. (not (eobp)))
  4332. (funcall fun)))))
  4333. (defun org-fixup-indentation (diff)
  4334. "Change the indentation in the current entry by DIFF
  4335. However, if any line in the current entry has no indentation, or if it
  4336. would end up with no indentation after the change, nothing at all is done."
  4337. (save-excursion
  4338. (let ((end (save-excursion (outline-next-heading)
  4339. (point-marker)))
  4340. (prohibit (if (> diff 0)
  4341. "^\\S-"
  4342. (concat "^ \\{0," (int-to-string (- diff)) "\\}\\S-")))
  4343. col)
  4344. (unless (save-excursion (end-of-line 1)
  4345. (re-search-forward prohibit end t))
  4346. (while (and (< (point) end)
  4347. (re-search-forward "^[ \t]+" end t))
  4348. (goto-char (match-end 0))
  4349. (setq col (current-column))
  4350. (if (< diff 0) (replace-match ""))
  4351. (indent-to (+ diff col))))
  4352. (move-marker end nil))))
  4353. (defun org-convert-to-odd-levels ()
  4354. "Convert an org-mode file with all levels allowed to one with odd levels.
  4355. This will leave level 1 alone, convert level 2 to level 3, level 3 to
  4356. level 5 etc."
  4357. (interactive)
  4358. (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
  4359. (let ((org-odd-levels-only nil) n)
  4360. (save-excursion
  4361. (goto-char (point-min))
  4362. (while (re-search-forward "^\\*\\*+ " nil t)
  4363. (setq n (- (length (match-string 0)) 2))
  4364. (while (>= (setq n (1- n)) 0)
  4365. (org-demote))
  4366. (end-of-line 1))))))
  4367. (defun org-convert-to-oddeven-levels ()
  4368. "Convert an org-mode file with only odd levels to one with odd and even levels.
  4369. This promotes level 3 to level 2, level 5 to level 3 etc. If the file contains a
  4370. section with an even level, conversion would destroy the structure of the file. An error
  4371. is signaled in this case."
  4372. (interactive)
  4373. (goto-char (point-min))
  4374. ;; First check if there are no even levels
  4375. (when (re-search-forward "^\\(\\*\\*\\)+ " nil t)
  4376. (org-show-context t)
  4377. (error "Not all levels are odd in this file. Conversion not possible."))
  4378. (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
  4379. (let ((org-odd-levels-only nil) n)
  4380. (save-excursion
  4381. (goto-char (point-min))
  4382. (while (re-search-forward "^\\*\\*+ " nil t)
  4383. (setq n (/ (1- (length (match-string 0))) 2))
  4384. (while (>= (setq n (1- n)) 0)
  4385. (org-promote))
  4386. (end-of-line 1))))))
  4387. (defun org-tr-level (n)
  4388. "Make N odd if required."
  4389. (if org-odd-levels-only (1+ (/ n 2)) n))
  4390. ;;; Vertical tree motion, cutting and pasting of subtrees
  4391. (defun org-move-subtree-up (&optional arg)
  4392. "Move the current subtree up past ARG headlines of the same level."
  4393. (interactive "p")
  4394. (org-move-subtree-down (- (prefix-numeric-value arg))))
  4395. (defun org-move-subtree-down (&optional arg)
  4396. "Move the current subtree down past ARG headlines of the same level."
  4397. (interactive "p")
  4398. (setq arg (prefix-numeric-value arg))
  4399. (let ((movfunc (if (> arg 0) 'outline-get-next-sibling
  4400. 'outline-get-last-sibling))
  4401. (ins-point (make-marker))
  4402. (cnt (abs arg))
  4403. beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
  4404. ;; Select the tree
  4405. (org-back-to-heading)
  4406. (setq beg0 (point))
  4407. (save-excursion
  4408. (setq ne-beg (org-back-over-empty-lines))
  4409. (setq beg (point)))
  4410. (save-match-data
  4411. (save-excursion (outline-end-of-heading)
  4412. (setq folded (org-invisible-p)))
  4413. (outline-end-of-subtree))
  4414. (outline-next-heading)
  4415. (setq ne-end (org-back-over-empty-lines))
  4416. (setq end (point))
  4417. (goto-char beg0)
  4418. (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
  4419. ;; include less whitespace
  4420. (save-excursion
  4421. (goto-char beg)
  4422. (forward-line (- ne-beg ne-end))
  4423. (setq beg (point))))
  4424. ;; Find insertion point, with error handling
  4425. (while (> cnt 0)
  4426. (or (and (funcall movfunc) (looking-at outline-regexp))
  4427. (progn (goto-char beg0)
  4428. (error "Cannot move past superior level or buffer limit")))
  4429. (setq cnt (1- cnt)))
  4430. (if (> arg 0)
  4431. ;; Moving forward - still need to move over subtree
  4432. (progn (org-end-of-subtree t t)
  4433. (save-excursion
  4434. (org-back-over-empty-lines)
  4435. (or (bolp) (newline)))))
  4436. (setq ne-ins (org-back-over-empty-lines))
  4437. (move-marker ins-point (point))
  4438. (setq txt (buffer-substring beg end))
  4439. (org-save-markers-in-region beg end)
  4440. (delete-region beg end)
  4441. (outline-flag-region (1- beg) beg nil)
  4442. (outline-flag-region (1- (point)) (point) nil)
  4443. (let ((bbb (point)))
  4444. (insert-before-markers txt)
  4445. (org-reinstall-markers-in-region bbb)
  4446. (move-marker ins-point bbb))
  4447. (or (bolp) (insert "\n"))
  4448. (setq ins-end (point))
  4449. (goto-char ins-point)
  4450. (org-skip-whitespace)
  4451. (when (and (< arg 0)
  4452. (org-first-sibling-p)
  4453. (> ne-ins ne-beg))
  4454. ;; Move whitespace back to beginning
  4455. (save-excursion
  4456. (goto-char ins-end)
  4457. (let ((kill-whole-line t))
  4458. (kill-line (- ne-ins ne-beg)) (point)))
  4459. (insert (make-string (- ne-ins ne-beg) ?\n)))
  4460. (move-marker ins-point nil)
  4461. (org-compact-display-after-subtree-move)
  4462. (org-show-empty-lines-in-parent)
  4463. (unless folded
  4464. (org-show-entry)
  4465. (show-children)
  4466. (org-cycle-hide-drawers 'children))))
  4467. (defvar org-subtree-clip ""
  4468. "Clipboard for cut and paste of subtrees.
  4469. This is actually only a copy of the kill, because we use the normal kill
  4470. ring. We need it to check if the kill was created by `org-copy-subtree'.")
  4471. (defvar org-subtree-clip-folded nil
  4472. "Was the last copied subtree folded?
  4473. This is used to fold the tree back after pasting.")
  4474. (defun org-cut-subtree (&optional n)
  4475. "Cut the current subtree into the clipboard.
  4476. With prefix arg N, cut this many sequential subtrees.
  4477. This is a short-hand for marking the subtree and then cutting it."
  4478. (interactive "p")
  4479. (org-copy-subtree n 'cut))
  4480. (defun org-copy-subtree (&optional n cut force-store-markers)
  4481. "Cut the current subtree into the clipboard.
  4482. With prefix arg N, cut this many sequential subtrees.
  4483. This is a short-hand for marking the subtree and then copying it.
  4484. If CUT is non-nil, actually cut the subtree.
  4485. If FORCE-STORE-MARKERS is non-nil, store the relative locations
  4486. of some markers in the region, even if CUT is non-nil. This is
  4487. useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
  4488. (interactive "p")
  4489. (let (beg end folded (beg0 (point)))
  4490. (if (interactive-p)
  4491. (org-back-to-heading nil) ; take what looks like a subtree
  4492. (org-back-to-heading t)) ; take what is really there
  4493. (org-back-over-empty-lines)
  4494. (setq beg (point))
  4495. (skip-chars-forward " \t\r\n")
  4496. (save-match-data
  4497. (save-excursion (outline-end-of-heading)
  4498. (setq folded (org-invisible-p)))
  4499. (condition-case nil
  4500. (outline-forward-same-level (1- n))
  4501. (error nil))
  4502. (org-end-of-subtree t t))
  4503. (org-back-over-empty-lines)
  4504. (setq end (point))
  4505. (goto-char beg0)
  4506. (when (> end beg)
  4507. (setq org-subtree-clip-folded folded)
  4508. (when (or cut force-store-markers)
  4509. (org-save-markers-in-region beg end))
  4510. (if cut (kill-region beg end) (copy-region-as-kill beg end))
  4511. (setq org-subtree-clip (current-kill 0))
  4512. (message "%s: Subtree(s) with %d characters"
  4513. (if cut "Cut" "Copied")
  4514. (length org-subtree-clip)))))
  4515. (defun org-paste-subtree (&optional level tree)
  4516. "Paste the clipboard as a subtree, with modification of headline level.
  4517. The entire subtree is promoted or demoted in order to match a new headline
  4518. level. By default, the new level is derived from the visible headings
  4519. before and after the insertion point, and taken to be the inferior headline
  4520. level of the two. So if the previous visible heading is level 3 and the
  4521. next is level 4 (or vice versa), level 4 will be used for insertion.
  4522. This makes sure that the subtree remains an independent subtree and does
  4523. not swallow low level entries.
  4524. You can also force a different level, either by using a numeric prefix
  4525. argument, or by inserting the heading marker by hand. For example, if the
  4526. cursor is after \"*****\", then the tree will be shifted to level 5.
  4527. If you want to insert the tree as is, just use \\[yank].
  4528. If optional TREE is given, use this text instead of the kill ring."
  4529. (interactive "P")
  4530. (unless (org-kill-is-subtree-p tree)
  4531. (error "%s"
  4532. (substitute-command-keys
  4533. "The kill is not a (set of) tree(s) - please use \\[yank] to yank anyway")))
  4534. (let* ((visp (not (org-invisible-p)))
  4535. (txt (or tree (and kill-ring (current-kill 0))))
  4536. (^re (concat "^\\(" outline-regexp "\\)"))
  4537. (re (concat "\\(" outline-regexp "\\)"))
  4538. (^re_ (concat "\\(\\*+\\)[ \t]*"))
  4539. (old-level (if (string-match ^re txt)
  4540. (- (match-end 0) (match-beginning 0) 1)
  4541. -1))
  4542. (force-level (cond (level (prefix-numeric-value level))
  4543. ((string-match
  4544. ^re_ (buffer-substring (point-at-bol) (point)))
  4545. (- (match-end 1) (match-beginning 1)))
  4546. (t nil)))
  4547. (previous-level (save-excursion
  4548. (condition-case nil
  4549. (progn
  4550. (outline-previous-visible-heading 1)
  4551. (if (looking-at re)
  4552. (- (match-end 0) (match-beginning 0) 1)
  4553. 1))
  4554. (error 1))))
  4555. (next-level (save-excursion
  4556. (condition-case nil
  4557. (progn
  4558. (or (looking-at outline-regexp)
  4559. (outline-next-visible-heading 1))
  4560. (if (looking-at re)
  4561. (- (match-end 0) (match-beginning 0) 1)
  4562. 1))
  4563. (error 1))))
  4564. (new-level (or force-level (max previous-level next-level)))
  4565. (shift (if (or (= old-level -1)
  4566. (= new-level -1)
  4567. (= old-level new-level))
  4568. 0
  4569. (- new-level old-level)))
  4570. (delta (if (> shift 0) -1 1))
  4571. (func (if (> shift 0) 'org-demote 'org-promote))
  4572. (org-odd-levels-only nil)
  4573. beg end)
  4574. ;; Remove the forced level indicator
  4575. (if force-level
  4576. (delete-region (point-at-bol) (point)))
  4577. ;; Paste
  4578. (beginning-of-line 1)
  4579. (org-back-over-empty-lines)
  4580. (setq beg (point))
  4581. (insert-before-markers txt)
  4582. (unless (string-match "\n\\'" txt) (insert "\n"))
  4583. (org-reinstall-markers-in-region beg)
  4584. (setq end (point))
  4585. (goto-char beg)
  4586. (skip-chars-forward " \t\n\r")
  4587. (setq beg (point))
  4588. (if (and (org-invisible-p) visp)
  4589. (save-excursion (outline-show-heading)))
  4590. ;; Shift if necessary
  4591. (unless (= shift 0)
  4592. (save-restriction
  4593. (narrow-to-region beg end)
  4594. (while (not (= shift 0))
  4595. (org-map-region func (point-min) (point-max))
  4596. (setq shift (+ delta shift)))
  4597. (goto-char (point-min))))
  4598. (when (interactive-p)
  4599. (message "Clipboard pasted as level %d subtree" new-level))
  4600. (if (and kill-ring
  4601. (eq org-subtree-clip (current-kill 0))
  4602. org-subtree-clip-folded)
  4603. ;; The tree was folded before it was killed/copied
  4604. (hide-subtree))))
  4605. (defun org-kill-is-subtree-p (&optional txt)
  4606. "Check if the current kill is an outline subtree, or a set of trees.
  4607. Returns nil if kill does not start with a headline, or if the first
  4608. headline level is not the largest headline level in the tree.
  4609. So this will actually accept several entries of equal levels as well,
  4610. which is OK for `org-paste-subtree'.
  4611. If optional TXT is given, check this string instead of the current kill."
  4612. (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
  4613. (start-level (and kill
  4614. (string-match (concat "\\`\\([ \t\n\r]*?\n\\)?\\("
  4615. org-outline-regexp "\\)")
  4616. kill)
  4617. (- (match-end 2) (match-beginning 2) 1)))
  4618. (re (concat "^" org-outline-regexp))
  4619. (start (1+ (or (match-beginning 2) -1))))
  4620. (if (not start-level)
  4621. (progn
  4622. nil) ;; does not even start with a heading
  4623. (catch 'exit
  4624. (while (setq start (string-match re kill (1+ start)))
  4625. (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
  4626. (throw 'exit nil)))
  4627. t))))
  4628. (defvar org-markers-to-move nil
  4629. "Markers that should be moved with a cut-and-paste operation.
  4630. Those markers are stored together with their positions relative to
  4631. the start of the region.")
  4632. (defun org-save-markers-in-region (beg end)
  4633. "Check markers in region.
  4634. If these markers are between BEG and END, record their position relative
  4635. to BEG, so that after moving the block of text, we can put the markers back
  4636. into place.
  4637. This function gets called just before an entry or tree gets cut from the
  4638. buffer. After re-insertion, `org-reinstall-markers-in-region' must be
  4639. called immediately, to move the markers with the entries."
  4640. (setq org-markers-to-move nil)
  4641. (when (featurep 'org-clock)
  4642. (org-clock-save-markers-for-cut-and-paste beg end))
  4643. (when (featurep 'org-agenda)
  4644. (org-agenda-save-markers-for-cut-and-paste beg end)))
  4645. (defun org-check-and-save-marker (marker beg end)
  4646. "Check if MARKER is between BEG and END.
  4647. If yes, remember the marker and the distance to BEG."
  4648. (when (and (marker-buffer marker)
  4649. (equal (marker-buffer marker) (current-buffer)))
  4650. (if (and (>= marker beg) (< marker end))
  4651. (push (cons marker (- marker beg)) org-markers-to-move))))
  4652. (defun org-reinstall-markers-in-region (beg)
  4653. "Move all remembered markers to their position relative to BEG."
  4654. (mapc (lambda (x)
  4655. (move-marker (car x) (+ beg (cdr x))))
  4656. org-markers-to-move)
  4657. (setq org-markers-to-move nil))
  4658. (defun org-narrow-to-subtree ()
  4659. "Narrow buffer to the current subtree."
  4660. (interactive)
  4661. (save-excursion
  4662. (save-match-data
  4663. (narrow-to-region
  4664. (progn (org-back-to-heading) (point))
  4665. (progn (org-end-of-subtree t) (point))))))
  4666. ;;; Outline Sorting
  4667. (defun org-sort (with-case)
  4668. "Call `org-sort-entries-or-items' or `org-table-sort-lines'.
  4669. Optional argument WITH-CASE means sort case-sensitively."
  4670. (interactive "P")
  4671. (if (org-at-table-p)
  4672. (org-call-with-arg 'org-table-sort-lines with-case)
  4673. (org-call-with-arg 'org-sort-entries-or-items with-case)))
  4674. (defun org-sort-remove-invisible (s)
  4675. (remove-text-properties 0 (length s) org-rm-props s)
  4676. (while (string-match org-bracket-link-regexp s)
  4677. (setq s (replace-match (if (match-end 2)
  4678. (match-string 3 s)
  4679. (match-string 1 s)) t t s)))
  4680. s)
  4681. (defvar org-priority-regexp) ; defined later in the file
  4682. (defun org-sort-entries-or-items (&optional with-case sorting-type getkey-func property)
  4683. "Sort entries on a certain level of an outline tree.
  4684. If there is an active region, the entries in the region are sorted.
  4685. Else, if the cursor is before the first entry, sort the top-level items.
  4686. Else, the children of the entry at point are sorted.
  4687. Sorting can be alphabetically, numerically, and by date/time as given by
  4688. the first time stamp in the entry. The command prompts for the sorting
  4689. type unless it has been given to the function through the SORTING-TYPE
  4690. argument, which needs to a character, any of (?n ?N ?a ?A ?t ?T ?p ?P ?f ?F).
  4691. If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
  4692. called with point at the beginning of the record. It must return either
  4693. a string or a number that should serve as the sorting key for that record.
  4694. Comparing entries ignores case by default. However, with an optional argument
  4695. WITH-CASE, the sorting considers case as well."
  4696. (interactive "P")
  4697. (let ((case-func (if with-case 'identity 'downcase))
  4698. start beg end stars re re2
  4699. txt what tmp plain-list-p)
  4700. ;; Find beginning and end of region to sort
  4701. (cond
  4702. ((org-region-active-p)
  4703. ;; we will sort the region
  4704. (setq end (region-end)
  4705. what "region")
  4706. (goto-char (region-beginning))
  4707. (if (not (org-on-heading-p)) (outline-next-heading))
  4708. (setq start (point)))
  4709. ((org-at-item-p)
  4710. ;; we will sort this plain list
  4711. (org-beginning-of-item-list) (setq start (point))
  4712. (org-end-of-item-list) (setq end (point))
  4713. (goto-char start)
  4714. (setq plain-list-p t
  4715. what "plain list"))
  4716. ((or (org-on-heading-p)
  4717. (condition-case nil (progn (org-back-to-heading) t) (error nil)))
  4718. ;; we will sort the children of the current headline
  4719. (org-back-to-heading)
  4720. (setq start (point)
  4721. end (progn (org-end-of-subtree t t)
  4722. (org-back-over-empty-lines)
  4723. (point))
  4724. what "children")
  4725. (goto-char start)
  4726. (show-subtree)
  4727. (outline-next-heading))
  4728. (t
  4729. ;; we will sort the top-level entries in this file
  4730. (goto-char (point-min))
  4731. (or (org-on-heading-p) (outline-next-heading))
  4732. (setq start (point) end (point-max) what "top-level")
  4733. (goto-char start)
  4734. (show-all)))
  4735. (setq beg (point))
  4736. (if (>= beg end) (error "Nothing to sort"))
  4737. (unless plain-list-p
  4738. (looking-at "\\(\\*+\\)")
  4739. (setq stars (match-string 1)
  4740. re (concat "^" (regexp-quote stars) " +")
  4741. re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[^*]")
  4742. txt (buffer-substring beg end))
  4743. (if (not (equal (substring txt -1) "\n")) (setq txt (concat txt "\n")))
  4744. (if (and (not (equal stars "*")) (string-match re2 txt))
  4745. (error "Region to sort contains a level above the first entry")))
  4746. (unless sorting-type
  4747. (message
  4748. (if plain-list-p
  4749. "Sort %s: [a]lpha [n]umeric [t]ime [f]unc A/N/T/F means reversed:"
  4750. "Sort %s: [a]lpha [n]umeric [t]ime [p]riority p[r]operty todo[o]rder [f]unc A/N/T/P/O/F means reversed:")
  4751. what)
  4752. (setq sorting-type (read-char-exclusive))
  4753. (and (= (downcase sorting-type) ?f)
  4754. (setq getkey-func
  4755. (completing-read "Sort using function: "
  4756. obarray 'fboundp t nil nil))
  4757. (setq getkey-func (intern getkey-func)))
  4758. (and (= (downcase sorting-type) ?r)
  4759. (setq property
  4760. (completing-read "Property: "
  4761. (mapcar 'list (org-buffer-property-keys t))
  4762. nil t))))
  4763. (message "Sorting entries...")
  4764. (save-restriction
  4765. (narrow-to-region start end)
  4766. (let ((dcst (downcase sorting-type))
  4767. (now (current-time)))
  4768. (sort-subr
  4769. (/= dcst sorting-type)
  4770. ;; This function moves to the beginning character of the "record" to
  4771. ;; be sorted.
  4772. (if plain-list-p
  4773. (lambda nil
  4774. (if (org-at-item-p) t (goto-char (point-max))))
  4775. (lambda nil
  4776. (if (re-search-forward re nil t)
  4777. (goto-char (match-beginning 0))
  4778. (goto-char (point-max)))))
  4779. ;; This function moves to the last character of the "record" being
  4780. ;; sorted.
  4781. (if plain-list-p
  4782. 'org-end-of-item
  4783. (lambda nil
  4784. (save-match-data
  4785. (condition-case nil
  4786. (outline-forward-same-level 1)
  4787. (error
  4788. (goto-char (point-max)))))))
  4789. ;; This function returns the value that gets sorted against.
  4790. (if plain-list-p
  4791. (lambda nil
  4792. (when (looking-at "[ \t]*[-+*0-9.)]+[ \t]+")
  4793. (cond
  4794. ((= dcst ?n)
  4795. (string-to-number (buffer-substring (match-end 0)
  4796. (point-at-eol))))
  4797. ((= dcst ?a)
  4798. (buffer-substring (match-end 0) (point-at-eol)))
  4799. ((= dcst ?t)
  4800. (if (re-search-forward org-ts-regexp
  4801. (point-at-eol) t)
  4802. (org-time-string-to-time (match-string 0))
  4803. now))
  4804. ((= dcst ?f)
  4805. (if getkey-func
  4806. (progn
  4807. (setq tmp (funcall getkey-func))
  4808. (if (stringp tmp) (setq tmp (funcall case-func tmp)))
  4809. tmp)
  4810. (error "Invalid key function `%s'" getkey-func)))
  4811. (t (error "Invalid sorting type `%c'" sorting-type)))))
  4812. (lambda nil
  4813. (cond
  4814. ((= dcst ?n)
  4815. (if (looking-at org-complex-heading-regexp)
  4816. (string-to-number (match-string 4))
  4817. nil))
  4818. ((= dcst ?a)
  4819. (if (looking-at org-complex-heading-regexp)
  4820. (funcall case-func (match-string 4))
  4821. nil))
  4822. ((= dcst ?t)
  4823. (if (re-search-forward org-ts-regexp
  4824. (save-excursion
  4825. (forward-line 2)
  4826. (point)) t)
  4827. (org-time-string-to-time (match-string 0))
  4828. now))
  4829. ((= dcst ?p)
  4830. (if (re-search-forward org-priority-regexp (point-at-eol) t)
  4831. (string-to-char (match-string 2))
  4832. org-default-priority))
  4833. ((= dcst ?r)
  4834. (or (org-entry-get nil property) ""))
  4835. ((= dcst ?o)
  4836. (if (looking-at org-complex-heading-regexp)
  4837. (- 9999 (length (member (match-string 2)
  4838. org-todo-keywords-1)))))
  4839. ((= dcst ?f)
  4840. (if getkey-func
  4841. (progn
  4842. (setq tmp (funcall getkey-func))
  4843. (if (stringp tmp) (setq tmp (funcall case-func tmp)))
  4844. tmp)
  4845. (error "Invalid key function `%s'" getkey-func)))
  4846. (t (error "Invalid sorting type `%c'" sorting-type)))))
  4847. nil
  4848. (cond
  4849. ((= dcst ?a) 'string<)
  4850. ((= dcst ?t) 'time-less-p)
  4851. (t nil)))))
  4852. (message "Sorting entries...done")))
  4853. (defun org-do-sort (table what &optional with-case sorting-type)
  4854. "Sort TABLE of WHAT according to SORTING-TYPE.
  4855. The user will be prompted for the SORTING-TYPE if the call to this
  4856. function does not specify it. WHAT is only for the prompt, to indicate
  4857. what is being sorted. The sorting key will be extracted from
  4858. the car of the elements of the table.
  4859. If WITH-CASE is non-nil, the sorting will be case-sensitive."
  4860. (unless sorting-type
  4861. (message
  4862. "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
  4863. what)
  4864. (setq sorting-type (read-char-exclusive)))
  4865. (let ((dcst (downcase sorting-type))
  4866. extractfun comparefun)
  4867. ;; Define the appropriate functions
  4868. (cond
  4869. ((= dcst ?n)
  4870. (setq extractfun 'string-to-number
  4871. comparefun (if (= dcst sorting-type) '< '>)))
  4872. ((= dcst ?a)
  4873. (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
  4874. (lambda(x) (downcase (org-sort-remove-invisible x))))
  4875. comparefun (if (= dcst sorting-type)
  4876. 'string<
  4877. (lambda (a b) (and (not (string< a b))
  4878. (not (string= a b)))))))
  4879. ((= dcst ?t)
  4880. (setq extractfun
  4881. (lambda (x)
  4882. (if (string-match org-ts-regexp x)
  4883. (time-to-seconds
  4884. (org-time-string-to-time (match-string 0 x)))
  4885. 0))
  4886. comparefun (if (= dcst sorting-type) '< '>)))
  4887. (t (error "Invalid sorting type `%c'" sorting-type)))
  4888. (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
  4889. table)
  4890. (lambda (a b) (funcall comparefun (car a) (car b))))))
  4891. ;;; Editing source examples
  4892. (defvar org-exit-edit-mode-map (make-sparse-keymap))
  4893. (define-key org-exit-edit-mode-map "\C-c'" 'org-edit-src-exit)
  4894. (defvar org-edit-src-force-single-line nil)
  4895. (defvar org-edit-src-from-org-mode nil)
  4896. (defvar org-edit-src-picture nil)
  4897. (define-minor-mode org-exit-edit-mode
  4898. "Minor mode installing a single key binding, \"C-c '\" to exit special edit.")
  4899. (defun org-edit-src-code ()
  4900. "Edit the source code example at point.
  4901. An indirect buffer is created, and that buffer is then narrowed to the
  4902. example at point and switched to the correct language mode. When done,
  4903. exit by killing the buffer with \\[org-edit-src-exit]."
  4904. (interactive)
  4905. (let ((line (org-current-line))
  4906. (case-fold-search t)
  4907. (msg (substitute-command-keys
  4908. "Edit, then exit with C-c ' (C-c and single quote)"))
  4909. (info (org-edit-src-find-region-and-lang))
  4910. (org-mode-p (eq major-mode 'org-mode))
  4911. beg end lang lang-f single)
  4912. (if (not info)
  4913. nil
  4914. (setq beg (nth 0 info)
  4915. end (nth 1 info)
  4916. lang (nth 2 info)
  4917. single (nth 3 info)
  4918. lang-f (intern (concat lang "-mode")))
  4919. (unless (functionp lang-f)
  4920. (error "No such language mode: %s" lang-f))
  4921. (goto-line line)
  4922. (if (get-buffer "*Org Edit Src Example*")
  4923. (kill-buffer "*Org Edit Src Example*"))
  4924. (switch-to-buffer (make-indirect-buffer (current-buffer)
  4925. "*Org Edit Src Example*"))
  4926. (narrow-to-region beg end)
  4927. (remove-text-properties beg end '(display nil invisible nil
  4928. intangible nil))
  4929. (let ((org-inhibit-startup t))
  4930. (funcall lang-f))
  4931. (set (make-local-variable 'org-edit-src-force-single-line) single)
  4932. (set (make-local-variable 'org-edit-src-from-org-mode) org-mode-p)
  4933. (when org-mode-p
  4934. (goto-char (point-min))
  4935. (while (re-search-forward "^," nil t)
  4936. (replace-match "")))
  4937. (goto-line line)
  4938. (org-exit-edit-mode)
  4939. (org-set-local 'header-line-format msg)
  4940. (message "%s" msg)
  4941. t)))
  4942. (defun org-edit-fixed-width-region ()
  4943. "Edit the fixed-width ascii drawing at point.
  4944. This must be a region where each line starts with ca colon followed by
  4945. a space character.
  4946. An indirect buffer is created, and that buffer is then narrowed to the
  4947. example at point and switched to artist-mode. When done,
  4948. exit by killing the buffer with \\[org-edit-src-exit]."
  4949. (interactive)
  4950. (let ((line (org-current-line))
  4951. (case-fold-search t)
  4952. (msg (substitute-command-keys
  4953. "Edit, then exit with C-c ' (C-c and single quote)"))
  4954. (org-mode-p (eq major-mode 'org-mode))
  4955. beg end lang lang-f)
  4956. (beginning-of-line 1)
  4957. (if (looking-at "[ \t]*[^:\n \t]")
  4958. nil
  4959. (if (looking-at "[ \t]*\\(\n\\|\\'\\)]")
  4960. (setq beg (point) end (match-end 0))
  4961. (save-excursion
  4962. (if (re-search-backward "^[ \t]*[^:]" nil 'move)
  4963. (setq beg (point-at-bol 2))
  4964. (setq beg (point))))
  4965. (save-excursion
  4966. (if (re-search-forward "^[ \t]*[^:]" nil 'move)
  4967. (setq end (match-beginning 0))
  4968. (setq end (point))))
  4969. (goto-line line)
  4970. (if (get-buffer "*Org Edit Picture*")
  4971. (kill-buffer "*Org Edit Picture*"))
  4972. (switch-to-buffer (make-indirect-buffer (current-buffer)
  4973. "*Org Edit Picture*"))
  4974. (narrow-to-region beg end)
  4975. (remove-text-properties beg end '(display nil invisible nil
  4976. intangible nil))
  4977. (when (fboundp 'font-lock-unfontify-region)
  4978. (font-lock-unfontify-region (point-min) (point-max)))
  4979. (cond
  4980. ((eq org-edit-fixed-width-region-mode 'artist-mode)
  4981. (fundamental-mode)
  4982. (artist-mode 1))
  4983. (t (funcall org-edit-fixed-width-region-mode)))
  4984. (set (make-local-variable 'org-edit-src-force-single-line) nil)
  4985. (set (make-local-variable 'org-edit-src-from-org-mode) org-mode-p)
  4986. (set (make-local-variable 'org-edit-src-picture) t)
  4987. (goto-char (point-min))
  4988. (while (re-search-forward "^[ \t]*: " nil t)
  4989. (replace-match ""))
  4990. (goto-line line)
  4991. (org-exit-edit-mode)
  4992. (org-set-local 'header-line-format msg)
  4993. (message "%s" msg)
  4994. t))))
  4995. (defun org-edit-src-find-region-and-lang ()
  4996. "Find the region and language for a local edit.
  4997. Return a list with beginning and end of the region, a string representing
  4998. the language, a switch telling of the content should be in a single line."
  4999. (let ((re-list
  5000. '(
  5001. ("<src\\>[^<]*>[ \t]*\n?" "\n?[ \t]*</src>" lang)
  5002. ("<literal\\>[^<]*>[ \t]*\n?" "\n?[ \t]*</literal>" style)
  5003. ("<example>[ \t]*\n?" "\n?[ \t]*</example>" "fundamental")
  5004. ("<lisp>[ \t]*\n?" "\n?[ \t]*</lisp>" "emacs-lisp")
  5005. ("<perl>[ \t]*\n?" "\n?[ \t]*</perl>" "perl")
  5006. ("<python>[ \t]*\n?" "\n?[ \t]*</python>" "python")
  5007. ("<ruby>[ \t]*\n?" "\n?[ \t]*</ruby>" "ruby")
  5008. ("^#\\+begin_src\\( \\([^ \t\n]+\\)\\)?.*\n" "\n#\\+end_src" 2)
  5009. ("^#\\+begin_example.*\n" "^#\\+end_example" "fundamental")
  5010. ("^#\\+html:" "\n" "html" single-line)
  5011. ("^#\\+begin_html.*\n" "\n#\\+end_html" "html")
  5012. ("^#\\+begin_latex.*\n" "\n#\\+end_latex" "latex")
  5013. ("^#\\+latex:" "\n" "latex" single-line)
  5014. ("^#\\+begin_ascii.*\n" "\n#\\+end_ascii" "fundamental")
  5015. ("^#\\+ascii:" "\n" "ascii" single-line)
  5016. ))
  5017. (pos (point))
  5018. re re1 re2 single beg end lang)
  5019. (catch 'exit
  5020. (while (setq entry (pop re-list))
  5021. (setq re1 (car entry) re2 (nth 1 entry) lang (nth 2 entry)
  5022. single (nth 3 entry))
  5023. (save-excursion
  5024. (if (or (looking-at re1)
  5025. (re-search-backward re1 nil t))
  5026. (progn
  5027. (setq beg (match-end 0) lang (org-edit-src-get-lang lang))
  5028. (if (and (re-search-forward re2 nil t)
  5029. (>= (match-end 0) pos))
  5030. (throw 'exit (list beg (match-beginning 0) lang single))))
  5031. (if (or (looking-at re2)
  5032. (re-search-forward re2 nil t))
  5033. (progn
  5034. (setq end (match-beginning 0))
  5035. (if (and (re-search-backward re1 nil t)
  5036. (<= (match-beginning 0) pos))
  5037. (throw 'exit
  5038. (list (match-end 0) end
  5039. (org-edit-src-get-lang lang) single)))))))))))
  5040. (defun org-edit-src-get-lang (lang)
  5041. "Extract the src language."
  5042. (let ((m (match-string 0)))
  5043. (cond
  5044. ((stringp lang) lang)
  5045. ((integerp lang) (match-string lang))
  5046. ((and (eq lang lang)
  5047. (string-match "\\<lang=\"\\([^ \t\n\"]+\\)\"" m))
  5048. (match-string 1 m))
  5049. ((and (eq lang lang)
  5050. (string-match "\\<style=\"\\([^ \t\n\"]+\\)\"" m))
  5051. (match-string 1 m))
  5052. (t "fundamental"))))
  5053. (defun org-edit-src-exit ()
  5054. "Exit special edit and protect problematic lines."
  5055. (interactive)
  5056. (unless (buffer-base-buffer (current-buffer))
  5057. (error "This is not an indirect buffer, something is wrong..."))
  5058. (unless (> (point-min) 1)
  5059. (error "This buffer is not narrowed, something is wrong..."))
  5060. (goto-char (point-min))
  5061. (if (looking-at "[ \t\n]*\n") (replace-match ""))
  5062. (if (re-search-forward "\n[ \t\n]*\\'" nil t) (replace-match ""))
  5063. (when (org-bound-and-true-p org-edit-src-force-single-line)
  5064. (goto-char (point-min))
  5065. (while (re-search-forward "\n" nil t)
  5066. (replace-match " "))
  5067. (goto-char (point-min))
  5068. (if (looking-at "\\s-*") (replace-match " "))
  5069. (if (re-search-forward "\\s-+\\'" nil t)
  5070. (replace-match "")))
  5071. (when (org-bound-and-true-p org-edit-src-from-org-mode)
  5072. (goto-char (point-min))
  5073. (while (re-search-forward (if (org-mode-p) "^\\(.\\)" "^\\([*#]\\)") nil t)
  5074. (replace-match ",\\1"))
  5075. (when font-lock-mode
  5076. (font-lock-unfontify-region (point-min) (point-max)))
  5077. (put-text-property (point-min) (point-max) 'font-lock-fontified t))
  5078. (when (org-bound-and-true-p org-edit-src-picture)
  5079. (goto-char (point-min))
  5080. (while (re-search-forward "^" nil t)
  5081. (replace-match ": "))
  5082. (when font-lock-mode
  5083. (font-lock-unfontify-region (point-min) (point-max)))
  5084. (put-text-property (point-min) (point-max) 'font-lock-fontified t))
  5085. (kill-buffer (current-buffer))
  5086. (and (org-mode-p) (org-restart-font-lock)))
  5087. ;;;; Plain list items, including checkboxes
  5088. ;;; Plain list items
  5089. (defun org-at-item-p ()
  5090. "Is point in a line starting a hand-formatted item?"
  5091. (let ((llt org-plain-list-ordered-item-terminator))
  5092. (save-excursion
  5093. (goto-char (point-at-bol))
  5094. (looking-at
  5095. (cond
  5096. ((eq llt t) "\\([ \t]*\\([-+]\\|\\([0-9]+[.)]\\)\\)\\|[ \t]+\\*\\)\\( \\|$\\)")
  5097. ((= llt ?.) "\\([ \t]*\\([-+]\\|\\([0-9]+\\.\\)\\)\\|[ \t]+\\*\\)\\( \\|$\\)")
  5098. ((= llt ?\)) "\\([ \t]*\\([-+]\\|\\([0-9]+))\\)\\|[ \t]+\\*\\)\\( \\|$\\)")
  5099. (t (error "Invalid value of `org-plain-list-ordered-item-terminator'")))))))
  5100. (defun org-in-item-p ()
  5101. "It the cursor inside a plain list item.
  5102. Does not have to be the first line."
  5103. (save-excursion
  5104. (condition-case nil
  5105. (progn
  5106. (org-beginning-of-item)
  5107. (org-at-item-p)
  5108. t)
  5109. (error nil))))
  5110. (defun org-insert-item (&optional checkbox)
  5111. "Insert a new item at the current level.
  5112. Return t when things worked, nil when we are not in an item."
  5113. (when (save-excursion
  5114. (condition-case nil
  5115. (progn
  5116. (org-beginning-of-item)
  5117. (org-at-item-p)
  5118. (if (org-invisible-p) (error "Invisible item"))
  5119. t)
  5120. (error nil)))
  5121. (let* ((bul (match-string 0))
  5122. (descp (save-excursion (goto-char (match-beginning 0))
  5123. (beginning-of-line 1)
  5124. (save-match-data
  5125. (looking-at "[ \t]*.*? ::"))))
  5126. (eow (save-excursion (beginning-of-line 1) (looking-at "[ \t]*")
  5127. (match-end 0)))
  5128. (blank (cdr (assq 'plain-list-item org-blank-before-new-entry)))
  5129. pos)
  5130. (if descp (setq checkbox nil))
  5131. (cond
  5132. ((and (org-at-item-p) (<= (point) eow))
  5133. ;; before the bullet
  5134. (beginning-of-line 1)
  5135. (open-line (if blank 2 1)))
  5136. ((<= (point) eow)
  5137. (beginning-of-line 1))
  5138. (t
  5139. (unless (org-get-alist-option org-M-RET-may-split-line 'item)
  5140. (end-of-line 1)
  5141. (delete-horizontal-space))
  5142. (newline (if blank 2 1))))
  5143. (insert bul
  5144. (if checkbox "[ ]" "")
  5145. (if descp (concat (if checkbox " " "")
  5146. (read-string "Term: ") " :: ") ""))
  5147. (just-one-space)
  5148. (setq pos (point))
  5149. (end-of-line 1)
  5150. (unless (= (point) pos) (just-one-space) (backward-delete-char 1)))
  5151. (org-maybe-renumber-ordered-list)
  5152. (and checkbox (org-update-checkbox-count-maybe))
  5153. t))
  5154. ;;; Checkboxes
  5155. (defun org-at-item-checkbox-p ()
  5156. "Is point at a line starting a plain-list item with a checklet?"
  5157. (and (org-at-item-p)
  5158. (save-excursion
  5159. (goto-char (match-end 0))
  5160. (skip-chars-forward " \t")
  5161. (looking-at "\\[[- X]\\]"))))
  5162. (defun org-toggle-checkbox (&optional arg)
  5163. "Toggle the checkbox in the current line."
  5164. (interactive "P")
  5165. (catch 'exit
  5166. (let (beg end status (firstnew 'unknown))
  5167. (cond
  5168. ((org-region-active-p)
  5169. (setq beg (region-beginning) end (region-end)))
  5170. ((org-on-heading-p)
  5171. (setq beg (point) end (save-excursion (outline-next-heading) (point))))
  5172. ((org-at-item-checkbox-p)
  5173. (let ((pos (point)))
  5174. (replace-match
  5175. (cond (arg "[-]")
  5176. ((member (match-string 0) '("[ ]" "[-]")) "[X]")
  5177. (t "[ ]"))
  5178. t t)
  5179. (goto-char pos))
  5180. (throw 'exit t))
  5181. (t (error "Not at a checkbox or heading, and no active region")))
  5182. (save-excursion
  5183. (goto-char beg)
  5184. (while (< (point) end)
  5185. (when (org-at-item-checkbox-p)
  5186. (setq status (equal (match-string 0) "[X]"))
  5187. (when (eq firstnew 'unknown)
  5188. (setq firstnew (not status)))
  5189. (replace-match
  5190. (if (if arg (not status) firstnew) "[X]" "[ ]") t t))
  5191. (beginning-of-line 2)))))
  5192. (org-update-checkbox-count-maybe))
  5193. (defun org-update-checkbox-count-maybe ()
  5194. "Update checkbox statistics unless turned off by user."
  5195. (when org-provide-checkbox-statistics
  5196. (org-update-checkbox-count)))
  5197. (defun org-update-checkbox-count (&optional all)
  5198. "Update the checkbox statistics in the current section.
  5199. This will find all statistic cookies like [57%] and [6/12] and update them
  5200. with the current numbers. With optional prefix argument ALL, do this for
  5201. the whole buffer."
  5202. (interactive "P")
  5203. (save-excursion
  5204. (let* ((buffer-invisibility-spec (org-inhibit-invisibility)) ; Emacs 21
  5205. (beg (condition-case nil
  5206. (progn (outline-back-to-heading) (point))
  5207. (error (point-min))))
  5208. (end (move-marker (make-marker)
  5209. (progn (outline-next-heading) (point))))
  5210. (re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
  5211. (re-box "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) +\\(\\[[- X]\\]\\)")
  5212. (re-find (concat re "\\|" re-box))
  5213. beg-cookie end-cookie is-percent c-on c-off lim
  5214. eline curr-ind next-ind continue-from startsearch
  5215. (cstat 0)
  5216. )
  5217. (when all
  5218. (goto-char (point-min))
  5219. (outline-next-heading)
  5220. (setq beg (point) end (point-max)))
  5221. (goto-char end)
  5222. ;; find each statistic cookie
  5223. (while (re-search-backward re-find beg t)
  5224. (setq beg-cookie (match-beginning 1)
  5225. end-cookie (match-end 1)
  5226. cstat (+ cstat (if end-cookie 1 0))
  5227. startsearch (point-at-eol)
  5228. continue-from (point-at-bol)
  5229. is-percent (match-beginning 2)
  5230. lim (cond
  5231. ((org-on-heading-p) (outline-next-heading) (point))
  5232. ((org-at-item-p) (org-end-of-item) (point))
  5233. (t nil))
  5234. c-on 0
  5235. c-off 0)
  5236. (when lim
  5237. ;; find first checkbox for this cookie and gather
  5238. ;; statistics from all that are at this indentation level
  5239. (goto-char startsearch)
  5240. (if (re-search-forward re-box lim t)
  5241. (progn
  5242. (org-beginning-of-item)
  5243. (setq curr-ind (org-get-indentation))
  5244. (setq next-ind curr-ind)
  5245. (while (and (bolp) (org-at-item-p) (= curr-ind next-ind))
  5246. (save-excursion (end-of-line) (setq eline (point)))
  5247. (if (re-search-forward re-box eline t)
  5248. (if (member (match-string 2) '("[ ]" "[-]"))
  5249. (setq c-off (1+ c-off))
  5250. (setq c-on (1+ c-on))
  5251. )
  5252. )
  5253. (org-end-of-item)
  5254. (setq next-ind (org-get-indentation))
  5255. )))
  5256. (goto-char continue-from)
  5257. ;; update cookie
  5258. (when end-cookie
  5259. (delete-region beg-cookie end-cookie)
  5260. (goto-char beg-cookie)
  5261. (insert
  5262. (if is-percent
  5263. (format "[%d%%]" (/ (* 100 c-on) (max 1 (+ c-on c-off))))
  5264. (format "[%d/%d]" c-on (+ c-on c-off)))))
  5265. ;; update items checkbox if it has one
  5266. (when (org-at-item-p)
  5267. (org-beginning-of-item)
  5268. (when (and (> (+ c-on c-off) 0)
  5269. (re-search-forward re-box (point-at-eol) t))
  5270. (setq beg-cookie (match-beginning 2)
  5271. end-cookie (match-end 2))
  5272. (delete-region beg-cookie end-cookie)
  5273. (goto-char beg-cookie)
  5274. (cond ((= c-off 0) (insert "[X]"))
  5275. ((= c-on 0) (insert "[ ]"))
  5276. (t (insert "[-]")))
  5277. )))
  5278. (goto-char continue-from))
  5279. (when (interactive-p)
  5280. (message "Checkbox satistics updated %s (%d places)"
  5281. (if all "in entire file" "in current outline entry") cstat)))))
  5282. (defun org-get-checkbox-statistics-face ()
  5283. "Select the face for checkbox statistics.
  5284. The face will be `org-done' when all relevant boxes are checked. Otherwise
  5285. it will be `org-todo'."
  5286. (if (match-end 1)
  5287. (if (equal (match-string 1) "100%") 'org-done 'org-todo)
  5288. (if (and (> (match-end 2) (match-beginning 2))
  5289. (equal (match-string 2) (match-string 3)))
  5290. 'org-done
  5291. 'org-todo)))
  5292. (defun org-get-indentation (&optional line)
  5293. "Get the indentation of the current line, interpreting tabs.
  5294. When LINE is given, assume it represents a line and compute its indentation."
  5295. (if line
  5296. (if (string-match "^ *" (org-remove-tabs line))
  5297. (match-end 0))
  5298. (save-excursion
  5299. (beginning-of-line 1)
  5300. (skip-chars-forward " \t")
  5301. (current-column))))
  5302. (defun org-remove-tabs (s &optional width)
  5303. "Replace tabulators in S with spaces.
  5304. Assumes that s is a single line, starting in column 0."
  5305. (setq width (or width tab-width))
  5306. (while (string-match "\t" s)
  5307. (setq s (replace-match
  5308. (make-string
  5309. (- (* width (/ (+ (match-beginning 0) width) width))
  5310. (match-beginning 0)) ?\ )
  5311. t t s)))
  5312. s)
  5313. (defun org-fix-indentation (line ind)
  5314. "Fix indentation in LINE.
  5315. IND is a cons cell with target and minimum indentation.
  5316. If the current indenation in LINE is smaller than the minimum,
  5317. leave it alone. If it is larger than ind, set it to the target."
  5318. (let* ((l (org-remove-tabs line))
  5319. (i (org-get-indentation l))
  5320. (i1 (car ind)) (i2 (cdr ind)))
  5321. (if (>= i i2) (setq l (substring line i2)))
  5322. (if (> i1 0)
  5323. (concat (make-string i1 ?\ ) l)
  5324. l)))
  5325. (defun org-beginning-of-item ()
  5326. "Go to the beginning of the current hand-formatted item.
  5327. If the cursor is not in an item, throw an error."
  5328. (interactive)
  5329. (let ((pos (point))
  5330. (limit (save-excursion
  5331. (condition-case nil
  5332. (progn
  5333. (org-back-to-heading)
  5334. (beginning-of-line 2) (point))
  5335. (error (point-min)))))
  5336. (ind-empty (if org-empty-line-terminates-plain-lists 0 10000))
  5337. ind ind1)
  5338. (if (org-at-item-p)
  5339. (beginning-of-line 1)
  5340. (beginning-of-line 1)
  5341. (skip-chars-forward " \t")
  5342. (setq ind (current-column))
  5343. (if (catch 'exit
  5344. (while t
  5345. (beginning-of-line 0)
  5346. (if (or (bobp) (< (point) limit)) (throw 'exit nil))
  5347. (if (looking-at "[ \t]*$")
  5348. (setq ind1 ind-empty)
  5349. (skip-chars-forward " \t")
  5350. (setq ind1 (current-column)))
  5351. (if (< ind1 ind)
  5352. (progn (beginning-of-line 1) (throw 'exit (org-at-item-p))))))
  5353. nil
  5354. (goto-char pos)
  5355. (error "Not in an item")))))
  5356. (defun org-end-of-item ()
  5357. "Go to the end of the current hand-formatted item.
  5358. If the cursor is not in an item, throw an error."
  5359. (interactive)
  5360. (let* ((pos (point))
  5361. ind1
  5362. (ind-empty (if org-empty-line-terminates-plain-lists 0 10000))
  5363. (limit (save-excursion (outline-next-heading) (point)))
  5364. (ind (save-excursion
  5365. (org-beginning-of-item)
  5366. (skip-chars-forward " \t")
  5367. (current-column)))
  5368. (end (catch 'exit
  5369. (while t
  5370. (beginning-of-line 2)
  5371. (if (eobp) (throw 'exit (point)))
  5372. (if (>= (point) limit) (throw 'exit (point-at-bol)))
  5373. (if (looking-at "[ \t]*$")
  5374. (setq ind1 ind-empty)
  5375. (skip-chars-forward " \t")
  5376. (setq ind1 (current-column)))
  5377. (if (<= ind1 ind)
  5378. (throw 'exit (point-at-bol)))))))
  5379. (if end
  5380. (goto-char end)
  5381. (goto-char pos)
  5382. (error "Not in an item"))))
  5383. (defun org-next-item ()
  5384. "Move to the beginning of the next item in the current plain list.
  5385. Error if not at a plain list, or if this is the last item in the list."
  5386. (interactive)
  5387. (let (ind ind1 (pos (point)))
  5388. (org-beginning-of-item)
  5389. (setq ind (org-get-indentation))
  5390. (org-end-of-item)
  5391. (setq ind1 (org-get-indentation))
  5392. (unless (and (org-at-item-p) (= ind ind1))
  5393. (goto-char pos)
  5394. (error "On last item"))))
  5395. (defun org-previous-item ()
  5396. "Move to the beginning of the previous item in the current plain list.
  5397. Error if not at a plain list, or if this is the first item in the list."
  5398. (interactive)
  5399. (let (beg ind ind1 (pos (point)))
  5400. (org-beginning-of-item)
  5401. (setq beg (point))
  5402. (setq ind (org-get-indentation))
  5403. (goto-char beg)
  5404. (catch 'exit
  5405. (while t
  5406. (beginning-of-line 0)
  5407. (if (looking-at "[ \t]*$")
  5408. nil
  5409. (if (<= (setq ind1 (org-get-indentation)) ind)
  5410. (throw 'exit t)))))
  5411. (condition-case nil
  5412. (if (or (not (org-at-item-p))
  5413. (< ind1 (1- ind)))
  5414. (error "")
  5415. (org-beginning-of-item))
  5416. (error (goto-char pos)
  5417. (error "On first item")))))
  5418. (defun org-first-list-item-p ()
  5419. "Is this heading the item in a plain list?"
  5420. (unless (org-at-item-p)
  5421. (error "Not at a plain list item"))
  5422. (org-beginning-of-item)
  5423. (= (point) (save-excursion (org-beginning-of-item-list))))
  5424. (defun org-move-item-down ()
  5425. "Move the plain list item at point down, i.e. swap with following item.
  5426. Subitems (items with larger indentation) are considered part of the item,
  5427. so this really moves item trees."
  5428. (interactive)
  5429. (let (beg beg0 end end0 ind ind1 (pos (point)) txt ne-end ne-beg)
  5430. (org-beginning-of-item)
  5431. (setq beg0 (point))
  5432. (save-excursion
  5433. (setq ne-beg (org-back-over-empty-lines))
  5434. (setq beg (point)))
  5435. (goto-char beg0)
  5436. (setq ind (org-get-indentation))
  5437. (org-end-of-item)
  5438. (setq end0 (point))
  5439. (setq ind1 (org-get-indentation))
  5440. (setq ne-end (org-back-over-empty-lines))
  5441. (setq end (point))
  5442. (goto-char beg0)
  5443. (when (and (org-first-list-item-p) (< ne-end ne-beg))
  5444. ;; include less whitespace
  5445. (save-excursion
  5446. (goto-char beg)
  5447. (forward-line (- ne-beg ne-end))
  5448. (setq beg (point))))
  5449. (goto-char end0)
  5450. (if (and (org-at-item-p) (= ind ind1))
  5451. (progn
  5452. (org-end-of-item)
  5453. (org-back-over-empty-lines)
  5454. (setq txt (buffer-substring beg end))
  5455. (save-excursion
  5456. (delete-region beg end))
  5457. (setq pos (point))
  5458. (insert txt)
  5459. (goto-char pos) (org-skip-whitespace)
  5460. (org-maybe-renumber-ordered-list))
  5461. (goto-char pos)
  5462. (error "Cannot move this item further down"))))
  5463. (defun org-move-item-up (arg)
  5464. "Move the plain list item at point up, i.e. swap with previous item.
  5465. Subitems (items with larger indentation) are considered part of the item,
  5466. so this really moves item trees."
  5467. (interactive "p")
  5468. (let (beg beg0 end ind ind1 (pos (point)) txt
  5469. ne-beg ne-ins ins-end)
  5470. (org-beginning-of-item)
  5471. (setq beg0 (point))
  5472. (setq ind (org-get-indentation))
  5473. (save-excursion
  5474. (setq ne-beg (org-back-over-empty-lines))
  5475. (setq beg (point)))
  5476. (goto-char beg0)
  5477. (org-end-of-item)
  5478. (org-back-over-empty-lines)
  5479. (setq end (point))
  5480. (goto-char beg0)
  5481. (catch 'exit
  5482. (while t
  5483. (beginning-of-line 0)
  5484. (if (looking-at "[ \t]*$")
  5485. (if org-empty-line-terminates-plain-lists
  5486. (progn
  5487. (goto-char pos)
  5488. (error "Cannot move this item further up"))
  5489. nil)
  5490. (if (<= (setq ind1 (org-get-indentation)) ind)
  5491. (throw 'exit t)))))
  5492. (condition-case nil
  5493. (org-beginning-of-item)
  5494. (error (goto-char beg0)
  5495. (error "Cannot move this item further up")))
  5496. (setq ind1 (org-get-indentation))
  5497. (if (and (org-at-item-p) (= ind ind1))
  5498. (progn
  5499. (setq ne-ins (org-back-over-empty-lines))
  5500. (setq txt (buffer-substring beg end))
  5501. (save-excursion
  5502. (delete-region beg end))
  5503. (setq pos (point))
  5504. (insert txt)
  5505. (setq ins-end (point))
  5506. (goto-char pos) (org-skip-whitespace)
  5507. (when (and (org-first-list-item-p) (> ne-ins ne-beg))
  5508. ;; Move whitespace back to beginning
  5509. (save-excursion
  5510. (goto-char ins-end)
  5511. (let ((kill-whole-line t))
  5512. (kill-line (- ne-ins ne-beg)) (point)))
  5513. (insert (make-string (- ne-ins ne-beg) ?\n)))
  5514. (org-maybe-renumber-ordered-list))
  5515. (goto-char pos)
  5516. (error "Cannot move this item further up"))))
  5517. (defun org-maybe-renumber-ordered-list ()
  5518. "Renumber the ordered list at point if setup allows it.
  5519. This tests the user option `org-auto-renumber-ordered-lists' before
  5520. doing the renumbering."
  5521. (interactive)
  5522. (when (and org-auto-renumber-ordered-lists
  5523. (org-at-item-p))
  5524. (if (match-beginning 3)
  5525. (org-renumber-ordered-list 1)
  5526. (org-fix-bullet-type))))
  5527. (defun org-maybe-renumber-ordered-list-safe ()
  5528. (condition-case nil
  5529. (save-excursion
  5530. (org-maybe-renumber-ordered-list))
  5531. (error nil)))
  5532. (defun org-cycle-list-bullet (&optional which)
  5533. "Cycle through the different itemize/enumerate bullets.
  5534. This cycle the entire list level through the sequence:
  5535. `-' -> `+' -> `*' -> `1.' -> `1)'
  5536. If WHICH is a string, use that as the new bullet. If WHICH is an integer,
  5537. 0 meand `-', 1 means `+' etc."
  5538. (interactive "P")
  5539. (org-preserve-lc
  5540. (org-beginning-of-item-list)
  5541. (org-at-item-p)
  5542. (beginning-of-line 1)
  5543. (let ((current (match-string 0))
  5544. (prevp (eq which 'previous))
  5545. new)
  5546. (setq new (cond
  5547. ((and (numberp which)
  5548. (nth (1- which) '("-" "+" "*" "1." "1)"))))
  5549. ((string-match "-" current) (if prevp "1)" "+"))
  5550. ((string-match "\\+" current)
  5551. (if prevp "-" (if (looking-at "\\S-") "1." "*")))
  5552. ((string-match "\\*" current) (if prevp "+" "1."))
  5553. ((string-match "\\." current) (if prevp "*" "1)"))
  5554. ((string-match ")" current) (if prevp "1." "-"))
  5555. (t (error "This should not happen"))))
  5556. (and (looking-at "\\([ \t]*\\)\\S-+") (replace-match (concat "\\1" new)))
  5557. (org-fix-bullet-type)
  5558. (org-maybe-renumber-ordered-list))))
  5559. (defun org-get-string-indentation (s)
  5560. "What indentation has S due to SPACE and TAB at the beginning of the string?"
  5561. (let ((n -1) (i 0) (w tab-width) c)
  5562. (catch 'exit
  5563. (while (< (setq n (1+ n)) (length s))
  5564. (setq c (aref s n))
  5565. (cond ((= c ?\ ) (setq i (1+ i)))
  5566. ((= c ?\t) (setq i (* (/ (+ w i) w) w)))
  5567. (t (throw 'exit t)))))
  5568. i))
  5569. (defun org-renumber-ordered-list (arg)
  5570. "Renumber an ordered plain list.
  5571. Cursor needs to be in the first line of an item, the line that starts
  5572. with something like \"1.\" or \"2)\"."
  5573. (interactive "p")
  5574. (unless (and (org-at-item-p)
  5575. (match-beginning 3))
  5576. (error "This is not an ordered list"))
  5577. (let ((line (org-current-line))
  5578. (col (current-column))
  5579. (ind (org-get-string-indentation
  5580. (buffer-substring (point-at-bol) (match-beginning 3))))
  5581. ;; (term (substring (match-string 3) -1))
  5582. ind1 (n (1- arg))
  5583. fmt bobp)
  5584. ;; find where this list begins
  5585. (org-beginning-of-item-list)
  5586. (setq bobp (bobp))
  5587. (looking-at "[ \t]*[0-9]+\\([.)]\\)")
  5588. (setq fmt (concat "%d" (match-string 1)))
  5589. (beginning-of-line 0)
  5590. ;; walk forward and replace these numbers
  5591. (catch 'exit
  5592. (while t
  5593. (catch 'next
  5594. (if bobp (setq bobp nil) (beginning-of-line 2))
  5595. (if (eobp) (throw 'exit nil))
  5596. (if (looking-at "[ \t]*$") (throw 'next nil))
  5597. (skip-chars-forward " \t") (setq ind1 (current-column))
  5598. (if (> ind1 ind) (throw 'next t))
  5599. (if (< ind1 ind) (throw 'exit t))
  5600. (if (not (org-at-item-p)) (throw 'exit nil))
  5601. (delete-region (match-beginning 2) (match-end 2))
  5602. (goto-char (match-beginning 2))
  5603. (insert (format fmt (setq n (1+ n)))))))
  5604. (goto-line line)
  5605. (org-move-to-column col)))
  5606. (defun org-fix-bullet-type ()
  5607. "Make sure all items in this list have the same bullet as the firsst item."
  5608. (interactive)
  5609. (unless (org-at-item-p) (error "This is not a list"))
  5610. (let ((line (org-current-line))
  5611. (col (current-column))
  5612. (ind (current-indentation))
  5613. ind1 bullet)
  5614. ;; find where this list begins
  5615. (org-beginning-of-item-list)
  5616. (beginning-of-line 1)
  5617. ;; find out what the bullet type is
  5618. (looking-at "[ \t]*\\(\\S-+\\)")
  5619. (setq bullet (match-string 1))
  5620. ;; walk forward and replace these numbers
  5621. (beginning-of-line 0)
  5622. (catch 'exit
  5623. (while t
  5624. (catch 'next
  5625. (beginning-of-line 2)
  5626. (if (eobp) (throw 'exit nil))
  5627. (if (looking-at "[ \t]*$") (throw 'next nil))
  5628. (skip-chars-forward " \t") (setq ind1 (current-column))
  5629. (if (> ind1 ind) (throw 'next t))
  5630. (if (< ind1 ind) (throw 'exit t))
  5631. (if (not (org-at-item-p)) (throw 'exit nil))
  5632. (skip-chars-forward " \t")
  5633. (looking-at "\\S-+")
  5634. (replace-match bullet))))
  5635. (goto-line line)
  5636. (org-move-to-column col)
  5637. (if (string-match "[0-9]" bullet)
  5638. (org-renumber-ordered-list 1))))
  5639. (defun org-beginning-of-item-list ()
  5640. "Go to the beginning of the current item list.
  5641. I.e. to the first item in this list."
  5642. (interactive)
  5643. (org-beginning-of-item)
  5644. (let ((pos (point-at-bol))
  5645. (ind (org-get-indentation))
  5646. ind1)
  5647. ;; find where this list begins
  5648. (catch 'exit
  5649. (while t
  5650. (catch 'next
  5651. (beginning-of-line 0)
  5652. (if (looking-at "[ \t]*$")
  5653. (throw (if (bobp) 'exit 'next) t))
  5654. (skip-chars-forward " \t") (setq ind1 (current-column))
  5655. (if (or (< ind1 ind)
  5656. (and (= ind1 ind)
  5657. (not (org-at-item-p)))
  5658. (and (= (point-at-bol) (point-min))
  5659. (setq pos (point-min))))
  5660. (throw 'exit t)
  5661. (when (org-at-item-p) (setq pos (point-at-bol)))))))
  5662. (goto-char pos)))
  5663. (defun org-end-of-item-list ()
  5664. "Go to the end of the current item list.
  5665. I.e. to the text after the last item."
  5666. (interactive)
  5667. (org-beginning-of-item)
  5668. (let ((pos (point-at-bol))
  5669. (ind (org-get-indentation))
  5670. ind1)
  5671. ;; find where this list begins
  5672. (catch 'exit
  5673. (while t
  5674. (catch 'next
  5675. (beginning-of-line 2)
  5676. (if (looking-at "[ \t]*$")
  5677. (throw (if (eobp) 'exit 'next) t))
  5678. (skip-chars-forward " \t") (setq ind1 (current-column))
  5679. (if (or (< ind1 ind)
  5680. (and (= ind1 ind)
  5681. (not (org-at-item-p)))
  5682. (eobp))
  5683. (progn
  5684. (setq pos (point-at-bol))
  5685. (throw 'exit t))))))
  5686. (goto-char pos)))
  5687. (defvar org-last-indent-begin-marker (make-marker))
  5688. (defvar org-last-indent-end-marker (make-marker))
  5689. (defun org-outdent-item (arg)
  5690. "Outdent a local list item."
  5691. (interactive "p")
  5692. (org-indent-item (- arg)))
  5693. (defun org-indent-item (arg)
  5694. "Indent a local list item."
  5695. (interactive "p")
  5696. (unless (org-at-item-p)
  5697. (error "Not on an item"))
  5698. (save-excursion
  5699. (let (beg end ind ind1 tmp delta ind-down ind-up)
  5700. (if (memq last-command '(org-shiftmetaright org-shiftmetaleft))
  5701. (setq beg org-last-indent-begin-marker
  5702. end org-last-indent-end-marker)
  5703. (org-beginning-of-item)
  5704. (setq beg (move-marker org-last-indent-begin-marker (point)))
  5705. (org-end-of-item)
  5706. (setq end (move-marker org-last-indent-end-marker (point))))
  5707. (goto-char beg)
  5708. (setq tmp (org-item-indent-positions)
  5709. ind (car tmp)
  5710. ind-down (nth 2 tmp)
  5711. ind-up (nth 1 tmp)
  5712. delta (if (> arg 0)
  5713. (if ind-down (- ind-down ind) 2)
  5714. (if ind-up (- ind-up ind) -2)))
  5715. (if (< (+ delta ind) 0) (error "Cannot outdent beyond margin"))
  5716. (while (< (point) end)
  5717. (beginning-of-line 1)
  5718. (skip-chars-forward " \t") (setq ind1 (current-column))
  5719. (delete-region (point-at-bol) (point))
  5720. (or (eolp) (org-indent-to-column (+ ind1 delta)))
  5721. (beginning-of-line 2))))
  5722. (org-fix-bullet-type)
  5723. (org-maybe-renumber-ordered-list-safe)
  5724. (save-excursion
  5725. (beginning-of-line 0)
  5726. (condition-case nil (org-beginning-of-item) (error nil))
  5727. (org-maybe-renumber-ordered-list-safe)))
  5728. (defun org-item-indent-positions ()
  5729. "Return indentation for plain list items.
  5730. This returns a list with three values: The current indentation, the
  5731. parent indentation and the indentation a child should habe.
  5732. Assumes cursor in item line."
  5733. (let* ((bolpos (point-at-bol))
  5734. (ind (org-get-indentation))
  5735. ind-down ind-up pos)
  5736. (save-excursion
  5737. (org-beginning-of-item-list)
  5738. (skip-chars-backward "\n\r \t")
  5739. (when (org-in-item-p)
  5740. (org-beginning-of-item)
  5741. (setq ind-up (org-get-indentation))))
  5742. (setq pos (point))
  5743. (save-excursion
  5744. (cond
  5745. ((and (condition-case nil (progn (org-previous-item) t)
  5746. (error nil))
  5747. (or (forward-char 1) t)
  5748. (re-search-forward "^\\([ \t]*\\([-+]\\|\\([0-9]+[.)]\\)\\)\\|[ \t]+\\*\\)\\( \\|$\\)" bolpos t))
  5749. (setq ind-down (org-get-indentation)))
  5750. ((and (goto-char pos)
  5751. (org-at-item-p))
  5752. (goto-char (match-end 0))
  5753. (skip-chars-forward " \t")
  5754. (setq ind-down (current-column)))))
  5755. (list ind ind-up ind-down)))
  5756. ;;; The orgstruct minor mode
  5757. ;; Define a minor mode which can be used in other modes in order to
  5758. ;; integrate the org-mode structure editing commands.
  5759. ;; This is really a hack, because the org-mode structure commands use
  5760. ;; keys which normally belong to the major mode. Here is how it
  5761. ;; works: The minor mode defines all the keys necessary to operate the
  5762. ;; structure commands, but wraps the commands into a function which
  5763. ;; tests if the cursor is currently at a headline or a plain list
  5764. ;; item. If that is the case, the structure command is used,
  5765. ;; temporarily setting many Org-mode variables like regular
  5766. ;; expressions for filling etc. However, when any of those keys is
  5767. ;; used at a different location, function uses `key-binding' to look
  5768. ;; up if the key has an associated command in another currently active
  5769. ;; keymap (minor modes, major mode, global), and executes that
  5770. ;; command. There might be problems if any of the keys is otherwise
  5771. ;; used as a prefix key.
  5772. ;; Another challenge is that the key binding for TAB can be tab or \C-i,
  5773. ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
  5774. ;; addresses this by checking explicitly for both bindings.
  5775. (defvar orgstruct-mode-map (make-sparse-keymap)
  5776. "Keymap for the minor `orgstruct-mode'.")
  5777. (defvar org-local-vars nil
  5778. "List of local variables, for use by `orgstruct-mode'")
  5779. ;;;###autoload
  5780. (define-minor-mode orgstruct-mode
  5781. "Toggle the minor more `orgstruct-mode'.
  5782. This mode is for using Org-mode structure commands in other modes.
  5783. The following key behave as if Org-mode was active, if the cursor
  5784. is on a headline, or on a plain list item (both in the definition
  5785. of Org-mode).
  5786. M-up Move entry/item up
  5787. M-down Move entry/item down
  5788. M-left Promote
  5789. M-right Demote
  5790. M-S-up Move entry/item up
  5791. M-S-down Move entry/item down
  5792. M-S-left Promote subtree
  5793. M-S-right Demote subtree
  5794. M-q Fill paragraph and items like in Org-mode
  5795. C-c ^ Sort entries
  5796. C-c - Cycle list bullet
  5797. TAB Cycle item visibility
  5798. M-RET Insert new heading/item
  5799. S-M-RET Insert new TODO heading / Chekbox item
  5800. C-c C-c Set tags / toggle checkbox"
  5801. nil " OrgStruct" nil
  5802. (org-load-modules-maybe)
  5803. (and (orgstruct-setup) (defun orgstruct-setup () nil)))
  5804. ;;;###autoload
  5805. (defun turn-on-orgstruct ()
  5806. "Unconditionally turn on `orgstruct-mode'."
  5807. (orgstruct-mode 1))
  5808. ;;;###autoload
  5809. (defun turn-on-orgstruct++ ()
  5810. "Unconditionally turn on `orgstruct-mode', and force org-mode indentations.
  5811. In addition to setting orgstruct-mode, this also exports all indentation and
  5812. autofilling variables from org-mode into the buffer. Note that turning
  5813. off orgstruct-mode will *not* remove these additional settings."
  5814. (orgstruct-mode 1)
  5815. (let (var val)
  5816. (mapc
  5817. (lambda (x)
  5818. (when (string-match
  5819. "^\\(paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
  5820. (symbol-name (car x)))
  5821. (setq var (car x) val (nth 1 x))
  5822. (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
  5823. org-local-vars)))
  5824. (defun orgstruct-error ()
  5825. "Error when there is no default binding for a structure key."
  5826. (interactive)
  5827. (error "This key has no function outside structure elements"))
  5828. (defun orgstruct-setup ()
  5829. "Setup orgstruct keymaps."
  5830. (let ((nfunc 0)
  5831. (bindings
  5832. (list
  5833. '([(meta up)] org-metaup)
  5834. '([(meta down)] org-metadown)
  5835. '([(meta left)] org-metaleft)
  5836. '([(meta right)] org-metaright)
  5837. '([(meta shift up)] org-shiftmetaup)
  5838. '([(meta shift down)] org-shiftmetadown)
  5839. '([(meta shift left)] org-shiftmetaleft)
  5840. '([(meta shift right)] org-shiftmetaright)
  5841. '([(shift up)] org-shiftup)
  5842. '([(shift down)] org-shiftdown)
  5843. '("\C-c\C-c" org-ctrl-c-ctrl-c)
  5844. '("\M-q" fill-paragraph)
  5845. '("\C-c^" org-sort)
  5846. '("\C-c-" org-cycle-list-bullet)))
  5847. elt key fun cmd)
  5848. (while (setq elt (pop bindings))
  5849. (setq nfunc (1+ nfunc))
  5850. (setq key (org-key (car elt))
  5851. fun (nth 1 elt)
  5852. cmd (orgstruct-make-binding fun nfunc key))
  5853. (org-defkey orgstruct-mode-map key cmd))
  5854. ;; Special treatment needed for TAB and RET
  5855. (org-defkey orgstruct-mode-map [(tab)]
  5856. (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
  5857. (org-defkey orgstruct-mode-map "\C-i"
  5858. (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
  5859. (org-defkey orgstruct-mode-map "\M-\C-m"
  5860. (orgstruct-make-binding 'org-insert-heading 105
  5861. "\M-\C-m" [(meta return)]))
  5862. (org-defkey orgstruct-mode-map [(meta return)]
  5863. (orgstruct-make-binding 'org-insert-heading 106
  5864. [(meta return)] "\M-\C-m"))
  5865. (org-defkey orgstruct-mode-map [(shift meta return)]
  5866. (orgstruct-make-binding 'org-insert-todo-heading 107
  5867. [(meta return)] "\M-\C-m"))
  5868. (unless org-local-vars
  5869. (setq org-local-vars (org-get-local-variables)))
  5870. t))
  5871. (defun orgstruct-make-binding (fun n &rest keys)
  5872. "Create a function for binding in the structure minor mode.
  5873. FUN is the command to call inside a table. N is used to create a unique
  5874. command name. KEYS are keys that should be checked in for a command
  5875. to execute outside of tables."
  5876. (eval
  5877. (list 'defun
  5878. (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
  5879. '(arg)
  5880. (concat "In Structure, run `" (symbol-name fun) "'.\n"
  5881. "Outside of structure, run the binding of `"
  5882. (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
  5883. "'.")
  5884. '(interactive "p")
  5885. (list 'if
  5886. '(org-context-p 'headline 'item)
  5887. (list 'org-run-like-in-org-mode (list 'quote fun))
  5888. (list 'let '(orgstruct-mode)
  5889. (list 'call-interactively
  5890. (append '(or)
  5891. (mapcar (lambda (k)
  5892. (list 'key-binding k))
  5893. keys)
  5894. '('orgstruct-error))))))))
  5895. (defun org-context-p (&rest contexts)
  5896. "Check if local context is any of CONTEXTS.
  5897. Possible values in the list of contexts are `table', `headline', and `item'."
  5898. (let ((pos (point)))
  5899. (goto-char (point-at-bol))
  5900. (prog1 (or (and (memq 'table contexts)
  5901. (looking-at "[ \t]*|"))
  5902. (and (memq 'headline contexts)
  5903. ;;????????? (looking-at "\\*+"))
  5904. (looking-at outline-regexp))
  5905. (and (memq 'item contexts)
  5906. (looking-at "[ \t]*\\([-+*] \\|[0-9]+[.)] \\)")))
  5907. (goto-char pos))))
  5908. (defun org-get-local-variables ()
  5909. "Return a list of all local variables in an org-mode buffer."
  5910. (let (varlist)
  5911. (with-current-buffer (get-buffer-create "*Org tmp*")
  5912. (erase-buffer)
  5913. (org-mode)
  5914. (setq varlist (buffer-local-variables)))
  5915. (kill-buffer "*Org tmp*")
  5916. (delq nil
  5917. (mapcar
  5918. (lambda (x)
  5919. (setq x
  5920. (if (symbolp x)
  5921. (list x)
  5922. (list (car x) (list 'quote (cdr x)))))
  5923. (if (string-match
  5924. "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
  5925. (symbol-name (car x)))
  5926. x nil))
  5927. varlist))))
  5928. ;;;###autoload
  5929. (defun org-run-like-in-org-mode (cmd)
  5930. (org-load-modules-maybe)
  5931. (unless org-local-vars
  5932. (setq org-local-vars (org-get-local-variables)))
  5933. (eval (list 'let org-local-vars
  5934. (list 'call-interactively (list 'quote cmd)))))
  5935. ;;;; Archiving
  5936. (defun org-get-category (&optional pos)
  5937. "Get the category applying to position POS."
  5938. (get-text-property (or pos (point)) 'org-category))
  5939. (defun org-refresh-category-properties ()
  5940. "Refresh category text properties in the buffer."
  5941. (let ((def-cat (cond
  5942. ((null org-category)
  5943. (if buffer-file-name
  5944. (file-name-sans-extension
  5945. (file-name-nondirectory buffer-file-name))
  5946. "???"))
  5947. ((symbolp org-category) (symbol-name org-category))
  5948. (t org-category)))
  5949. beg end cat pos optionp)
  5950. (org-unmodified
  5951. (save-excursion
  5952. (save-restriction
  5953. (widen)
  5954. (goto-char (point-min))
  5955. (put-text-property (point) (point-max) 'org-category def-cat)
  5956. (while (re-search-forward
  5957. "^\\(#\\+CATEGORY:\\|[ \t]*:CATEGORY:\\)\\(.*\\)" nil t)
  5958. (setq pos (match-end 0)
  5959. optionp (equal (char-after (match-beginning 0)) ?#)
  5960. cat (org-trim (match-string 2)))
  5961. (if optionp
  5962. (setq beg (point-at-bol) end (point-max))
  5963. (org-back-to-heading t)
  5964. (setq beg (point) end (org-end-of-subtree t t)))
  5965. (put-text-property beg end 'org-category cat)
  5966. (goto-char pos)))))))
  5967. ;;;; Link Stuff
  5968. ;;; Link abbreviations
  5969. (defun org-link-expand-abbrev (link)
  5970. "Apply replacements as defined in `org-link-abbrev-alist."
  5971. (if (string-match "^\\([a-zA-Z][-_a-zA-Z0-9]*\\)\\(::?\\(.*\\)\\)?$" link)
  5972. (let* ((key (match-string 1 link))
  5973. (as (or (assoc key org-link-abbrev-alist-local)
  5974. (assoc key org-link-abbrev-alist)))
  5975. (tag (and (match-end 2) (match-string 3 link)))
  5976. rpl)
  5977. (if (not as)
  5978. link
  5979. (setq rpl (cdr as))
  5980. (cond
  5981. ((symbolp rpl) (funcall rpl tag))
  5982. ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
  5983. (t (concat rpl tag)))))
  5984. link))
  5985. ;;; Storing and inserting links
  5986. (defvar org-insert-link-history nil
  5987. "Minibuffer history for links inserted with `org-insert-link'.")
  5988. (defvar org-stored-links nil
  5989. "Contains the links stored with `org-store-link'.")
  5990. (defvar org-store-link-plist nil
  5991. "Plist with info about the most recently link created with `org-store-link'.")
  5992. (defvar org-link-protocols nil
  5993. "Link protocols added to Org-mode using `org-add-link-type'.")
  5994. (defvar org-store-link-functions nil
  5995. "List of functions that are called to create and store a link.
  5996. Each function will be called in turn until one returns a non-nil
  5997. value. Each function should check if it is responsible for creating
  5998. this link (for example by looking at the major mode).
  5999. If not, it must exit and return nil.
  6000. If yes, it should return a non-nil value after a calling
  6001. `org-store-link-props' with a list of properties and values.
  6002. Special properties are:
  6003. :type The link prefix. like \"http\". This must be given.
  6004. :link The link, like \"http://www.astro.uva.nl/~dominik\".
  6005. This is obligatory as well.
  6006. :description Optional default description for the second pair
  6007. of brackets in an Org-mode link. The user can still change
  6008. this when inserting this link into an Org-mode buffer.
  6009. In addition to these, any additional properties can be specified
  6010. and then used in remember templates.")
  6011. (defun org-add-link-type (type &optional follow export)
  6012. "Add TYPE to the list of `org-link-types'.
  6013. Re-compute all regular expressions depending on `org-link-types'
  6014. FOLLOW and EXPORT are two functions.
  6015. FOLLOW should take the link path as the single argument and do whatever
  6016. is necessary to follow the link, for example find a file or display
  6017. a mail message.
  6018. EXPORT should format the link path for export to one of the export formats.
  6019. It should be a function accepting three arguments:
  6020. path the path of the link, the text after the prefix (like \"http:\")
  6021. desc the description of the link, if any, nil if there was no descripton
  6022. format the export format, a symbol like `html' or `latex'.
  6023. The function may use the FORMAT information to return different values
  6024. depending on the format. The return value will be put literally into
  6025. the exported file.
  6026. Org-mode has a built-in default for exporting links. If you are happy with
  6027. this default, there is no need to define an export function for the link
  6028. type. For a simple example of an export function, see `org-bbdb.el'."
  6029. (add-to-list 'org-link-types type t)
  6030. (org-make-link-regexps)
  6031. (if (assoc type org-link-protocols)
  6032. (setcdr (assoc type org-link-protocols) (list follow export))
  6033. (push (list type follow export) org-link-protocols)))
  6034. ;;;###autoload
  6035. (defun org-store-link (arg)
  6036. "\\<org-mode-map>Store an org-link to the current location.
  6037. This link is added to `org-stored-links' and can later be inserted
  6038. into an org-buffer with \\[org-insert-link].
  6039. For some link types, a prefix arg is interpreted:
  6040. For links to usenet articles, arg negates `org-usenet-links-prefer-google'.
  6041. For file links, arg negates `org-context-in-file-links'."
  6042. (interactive "P")
  6043. (org-load-modules-maybe)
  6044. (setq org-store-link-plist nil) ; reset
  6045. (let (link cpltxt desc description search txt)
  6046. (cond
  6047. ((run-hook-with-args-until-success 'org-store-link-functions)
  6048. (setq link (plist-get org-store-link-plist :link)
  6049. desc (or (plist-get org-store-link-plist :description) link)))
  6050. ((eq major-mode 'calendar-mode)
  6051. (let ((cd (calendar-cursor-to-date)))
  6052. (setq link
  6053. (format-time-string
  6054. (car org-time-stamp-formats)
  6055. (apply 'encode-time
  6056. (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
  6057. nil nil nil))))
  6058. (org-store-link-props :type "calendar" :date cd)))
  6059. ((eq major-mode 'w3-mode)
  6060. (setq cpltxt (url-view-url t)
  6061. link (org-make-link cpltxt))
  6062. (org-store-link-props :type "w3" :url (url-view-url t)))
  6063. ((eq major-mode 'w3m-mode)
  6064. (setq cpltxt (or w3m-current-title w3m-current-url)
  6065. link (org-make-link w3m-current-url))
  6066. (org-store-link-props :type "w3m" :url (url-view-url t)))
  6067. ((setq search (run-hook-with-args-until-success
  6068. 'org-create-file-search-functions))
  6069. (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
  6070. "::" search))
  6071. (setq cpltxt (or description link)))
  6072. ((eq major-mode 'image-mode)
  6073. (setq cpltxt (concat "file:"
  6074. (abbreviate-file-name buffer-file-name))
  6075. link (org-make-link cpltxt))
  6076. (org-store-link-props :type "image" :file buffer-file-name))
  6077. ((eq major-mode 'dired-mode)
  6078. ;; link to the file in the current line
  6079. (setq cpltxt (concat "file:"
  6080. (abbreviate-file-name
  6081. (expand-file-name
  6082. (dired-get-filename nil t))))
  6083. link (org-make-link cpltxt)))
  6084. ((and buffer-file-name (org-mode-p))
  6085. ;; Just link to current headline
  6086. (setq cpltxt (concat "file:"
  6087. (abbreviate-file-name buffer-file-name)))
  6088. ;; Add a context search string
  6089. (when (org-xor org-context-in-file-links arg)
  6090. ;; Check if we are on a target
  6091. (if (org-in-regexp "<<\\(.*?\\)>>")
  6092. (setq cpltxt (concat cpltxt "::" (match-string 1)))
  6093. (setq txt (cond
  6094. ((org-on-heading-p) nil)
  6095. ((org-region-active-p)
  6096. (buffer-substring (region-beginning) (region-end)))
  6097. (t nil)))
  6098. (when (or (null txt) (string-match "\\S-" txt))
  6099. (setq cpltxt
  6100. (concat cpltxt "::"
  6101. (condition-case nil
  6102. (org-make-org-heading-search-string txt)
  6103. (error "")))
  6104. desc "NONE"))))
  6105. (if (string-match "::\\'" cpltxt)
  6106. (setq cpltxt (substring cpltxt 0 -2)))
  6107. (setq link (org-make-link cpltxt)))
  6108. ((buffer-file-name (buffer-base-buffer))
  6109. ;; Just link to this file here.
  6110. (setq cpltxt (concat "file:"
  6111. (abbreviate-file-name
  6112. (buffer-file-name (buffer-base-buffer)))))
  6113. ;; Add a context string
  6114. (when (org-xor org-context-in-file-links arg)
  6115. (setq txt (if (org-region-active-p)
  6116. (buffer-substring (region-beginning) (region-end))
  6117. (buffer-substring (point-at-bol) (point-at-eol))))
  6118. ;; Only use search option if there is some text.
  6119. (when (string-match "\\S-" txt)
  6120. (setq cpltxt
  6121. (concat cpltxt "::" (org-make-org-heading-search-string txt))
  6122. desc "NONE")))
  6123. (setq link (org-make-link cpltxt)))
  6124. ((interactive-p)
  6125. (error "Cannot link to a buffer which is not visiting a file"))
  6126. (t (setq link nil)))
  6127. (if (consp link) (setq cpltxt (car link) link (cdr link)))
  6128. (setq link (or link cpltxt)
  6129. desc (or desc cpltxt))
  6130. (if (equal desc "NONE") (setq desc nil))
  6131. (if (and (interactive-p) link)
  6132. (progn
  6133. (setq org-stored-links
  6134. (cons (list link desc) org-stored-links))
  6135. (message "Stored: %s" (or desc link)))
  6136. (and link (org-make-link-string link desc)))))
  6137. (defun org-store-link-props (&rest plist)
  6138. "Store link properties, extract names and addresses."
  6139. (let (x adr)
  6140. (when (setq x (plist-get plist :from))
  6141. (setq adr (mail-extract-address-components x))
  6142. (plist-put plist :fromname (car adr))
  6143. (plist-put plist :fromaddress (nth 1 adr)))
  6144. (when (setq x (plist-get plist :to))
  6145. (setq adr (mail-extract-address-components x))
  6146. (plist-put plist :toname (car adr))
  6147. (plist-put plist :toaddress (nth 1 adr))))
  6148. (let ((from (plist-get plist :from))
  6149. (to (plist-get plist :to)))
  6150. (when (and from to org-from-is-user-regexp)
  6151. (plist-put plist :fromto
  6152. (if (string-match org-from-is-user-regexp from)
  6153. (concat "to %t")
  6154. (concat "from %f")))))
  6155. (setq org-store-link-plist plist))
  6156. (defun org-add-link-props (&rest plist)
  6157. "Add these properties to the link property list."
  6158. (let (key value)
  6159. (while plist
  6160. (setq key (pop plist) value (pop plist))
  6161. (setq org-store-link-plist
  6162. (plist-put org-store-link-plist key value)))))
  6163. (defun org-email-link-description (&optional fmt)
  6164. "Return the description part of an email link.
  6165. This takes information from `org-store-link-plist' and formats it
  6166. according to FMT (default from `org-email-link-description-format')."
  6167. (setq fmt (or fmt org-email-link-description-format))
  6168. (let* ((p org-store-link-plist)
  6169. (to (plist-get p :toaddress))
  6170. (from (plist-get p :fromaddress))
  6171. (table
  6172. (list
  6173. (cons "%c" (plist-get p :fromto))
  6174. (cons "%F" (plist-get p :from))
  6175. (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
  6176. (cons "%T" (plist-get p :to))
  6177. (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
  6178. (cons "%s" (plist-get p :subject))
  6179. (cons "%m" (plist-get p :message-id)))))
  6180. (when (string-match "%c" fmt)
  6181. ;; Check if the user wrote this message
  6182. (if (and org-from-is-user-regexp from to
  6183. (save-match-data (string-match org-from-is-user-regexp from)))
  6184. (setq fmt (replace-match "to %t" t t fmt))
  6185. (setq fmt (replace-match "from %f" t t fmt))))
  6186. (org-replace-escapes fmt table)))
  6187. (defun org-make-org-heading-search-string (&optional string heading)
  6188. "Make search string for STRING or current headline."
  6189. (interactive)
  6190. (let ((s (or string (org-get-heading))))
  6191. (unless (and string (not heading))
  6192. ;; We are using a headline, clean up garbage in there.
  6193. (if (string-match org-todo-regexp s)
  6194. (setq s (replace-match "" t t s)))
  6195. (if (string-match (org-re ":[[:alnum:]_@:]+:[ \t]*$") s)
  6196. (setq s (replace-match "" t t s)))
  6197. (setq s (org-trim s))
  6198. (if (string-match (concat "^\\(" org-quote-string "\\|"
  6199. org-comment-string "\\)") s)
  6200. (setq s (replace-match "" t t s)))
  6201. (while (string-match org-ts-regexp s)
  6202. (setq s (replace-match "" t t s))))
  6203. (while (string-match "[^a-zA-Z_0-9 \t]+" s)
  6204. (setq s (replace-match " " t t s)))
  6205. (or string (setq s (concat "*" s))) ; Add * for headlines
  6206. (mapconcat 'identity (org-split-string s "[ \t]+") " ")))
  6207. (defun org-make-link (&rest strings)
  6208. "Concatenate STRINGS."
  6209. (apply 'concat strings))
  6210. (defun org-make-link-string (link &optional description)
  6211. "Make a link with brackets, consisting of LINK and DESCRIPTION."
  6212. (unless (string-match "\\S-" link)
  6213. (error "Empty link"))
  6214. (when (stringp description)
  6215. ;; Remove brackets from the description, they are fatal.
  6216. (while (string-match "\\[" description)
  6217. (setq description (replace-match "{" t t description)))
  6218. (while (string-match "\\]" description)
  6219. (setq description (replace-match "}" t t description))))
  6220. (when (equal (org-link-escape link) description)
  6221. ;; No description needed, it is identical
  6222. (setq description nil))
  6223. (when (and (not description)
  6224. (not (equal link (org-link-escape link))))
  6225. (setq description (org-extract-attributes link)))
  6226. (concat "[[" (org-link-escape link) "]"
  6227. (if description (concat "[" description "]") "")
  6228. "]"))
  6229. (defconst org-link-escape-chars
  6230. '((?\ . "%20")
  6231. (?\[ . "%5B")
  6232. (?\] . "%5D")
  6233. (?\340 . "%E0") ; `a
  6234. (?\342 . "%E2") ; ^a
  6235. (?\347 . "%E7") ; ,c
  6236. (?\350 . "%E8") ; `e
  6237. (?\351 . "%E9") ; 'e
  6238. (?\352 . "%EA") ; ^e
  6239. (?\356 . "%EE") ; ^i
  6240. (?\364 . "%F4") ; ^o
  6241. (?\371 . "%F9") ; `u
  6242. (?\373 . "%FB") ; ^u
  6243. (?\; . "%3B")
  6244. (?? . "%3F")
  6245. (?= . "%3D")
  6246. (?+ . "%2B")
  6247. )
  6248. "Association list of escapes for some characters problematic in links.
  6249. This is the list that is used for internal purposes.")
  6250. (defconst org-link-escape-chars-browser
  6251. '((?\ . "%20")) ; 32 for the SPC char
  6252. "Association list of escapes for some characters problematic in links.
  6253. This is the list that is used before handing over to the browser.")
  6254. (defun org-link-escape (text &optional table)
  6255. "Escape charaters in TEXT that are problematic for links."
  6256. (setq table (or table org-link-escape-chars))
  6257. (when text
  6258. (let ((re (mapconcat (lambda (x) (regexp-quote
  6259. (char-to-string (car x))))
  6260. table "\\|")))
  6261. (while (string-match re text)
  6262. (setq text
  6263. (replace-match
  6264. (cdr (assoc (string-to-char (match-string 0 text))
  6265. table))
  6266. t t text)))
  6267. text)))
  6268. (defun org-link-unescape (text &optional table)
  6269. "Reverse the action of `org-link-escape'."
  6270. (setq table (or table org-link-escape-chars))
  6271. (when text
  6272. (let ((re (mapconcat (lambda (x) (regexp-quote (cdr x)))
  6273. table "\\|")))
  6274. (while (string-match re text)
  6275. (setq text
  6276. (replace-match
  6277. (char-to-string (car (rassoc (match-string 0 text) table)))
  6278. t t text)))
  6279. text)))
  6280. (defun org-xor (a b)
  6281. "Exclusive or."
  6282. (if a (not b) b))
  6283. (defun org-get-header (header)
  6284. "Find a header field in the current buffer."
  6285. (save-excursion
  6286. (goto-char (point-min))
  6287. (let ((case-fold-search t) s)
  6288. (cond
  6289. ((eq header 'from)
  6290. (if (re-search-forward "^From:\\s-+\\(.*\\)" nil t)
  6291. (setq s (match-string 1)))
  6292. (while (string-match "\"" s)
  6293. (setq s (replace-match "" t t s)))
  6294. (if (string-match "[<(].*" s)
  6295. (setq s (replace-match "" t t s))))
  6296. ((eq header 'message-id)
  6297. (if (re-search-forward "^message-id:\\s-+\\(.*\\)" nil t)
  6298. (setq s (match-string 1))))
  6299. ((eq header 'subject)
  6300. (if (re-search-forward "^subject:\\s-+\\(.*\\)" nil t)
  6301. (setq s (match-string 1)))))
  6302. (if (string-match "\\`[ \t\]+" s) (setq s (replace-match "" t t s)))
  6303. (if (string-match "[ \t\]+\\'" s) (setq s (replace-match "" t t s)))
  6304. s)))
  6305. (defun org-fixup-message-id-for-http (s)
  6306. "Replace special characters in a message id, so it can be used in an http query."
  6307. (while (string-match "<" s)
  6308. (setq s (replace-match "%3C" t t s)))
  6309. (while (string-match ">" s)
  6310. (setq s (replace-match "%3E" t t s)))
  6311. (while (string-match "@" s)
  6312. (setq s (replace-match "%40" t t s)))
  6313. s)
  6314. ;;;###autoload
  6315. (defun org-insert-link-global ()
  6316. "Insert a link like Org-mode does.
  6317. This command can be called in any mode to insert a link in Org-mode syntax."
  6318. (interactive)
  6319. (org-load-modules-maybe)
  6320. (org-run-like-in-org-mode 'org-insert-link))
  6321. (defun org-insert-link (&optional complete-file link-location)
  6322. "Insert a link. At the prompt, enter the link.
  6323. Completion can be used to select a link previously stored with
  6324. `org-store-link'. When the empty string is entered (i.e. if you just
  6325. press RET at the prompt), the link defaults to the most recently
  6326. stored link. As SPC triggers completion in the minibuffer, you need to
  6327. use M-SPC or C-q SPC to force the insertion of a space character.
  6328. You will also be prompted for a description, and if one is given, it will
  6329. be displayed in the buffer instead of the link.
  6330. If there is already a link at point, this command will allow you to edit link
  6331. and description parts.
  6332. With a \\[universal-argument] prefix, prompts for a file to link to. The file name can
  6333. be selected using completion. The path to the file will be relative to the
  6334. current directory if the file is in the current directory or a subdirectory.
  6335. Otherwise, the link will be the absolute path as completed in the minibuffer
  6336. \(i.e. normally ~/path/to/file).
  6337. With two \\[universal-argument] prefixes, enforce an absolute path even if the file is in
  6338. the current directory or below. With three \\[universal-argument] prefixes, negate the meaning
  6339. of `org-keep-stored-link-after-insertion'.
  6340. If `org-make-link-description-function' is non-nil, this function will be
  6341. called with the link target, and the result will be the default
  6342. link description.
  6343. If the LINK-LOCATION parameter is non-nil, this value will be
  6344. used as the link location instead of reading one interactively."
  6345. (interactive "P")
  6346. (let* ((wcf (current-window-configuration))
  6347. (region (if (org-region-active-p)
  6348. (buffer-substring (region-beginning) (region-end))))
  6349. (remove (and region (list (region-beginning) (region-end))))
  6350. (desc region)
  6351. tmphist ; byte-compile incorrectly complains about this
  6352. (link link-location)
  6353. entry file)
  6354. (cond
  6355. (link-location) ; specified by arg, just use it.
  6356. ((org-in-regexp org-bracket-link-regexp 1)
  6357. ;; We do have a link at point, and we are going to edit it.
  6358. (setq remove (list (match-beginning 0) (match-end 0)))
  6359. (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
  6360. (setq link (read-string "Link: "
  6361. (org-link-unescape
  6362. (org-match-string-no-properties 1)))))
  6363. ((or (org-in-regexp org-angle-link-re)
  6364. (org-in-regexp org-plain-link-re))
  6365. ;; Convert to bracket link
  6366. (setq remove (list (match-beginning 0) (match-end 0))
  6367. link (read-string "Link: "
  6368. (org-remove-angle-brackets (match-string 0)))))
  6369. ((equal complete-file '(4))
  6370. ;; Completing read for file names.
  6371. (setq file (read-file-name "File: "))
  6372. (let ((pwd (file-name-as-directory (expand-file-name ".")))
  6373. (pwd1 (file-name-as-directory (abbreviate-file-name
  6374. (expand-file-name ".")))))
  6375. (cond
  6376. ((equal complete-file '(16))
  6377. (setq link (org-make-link
  6378. "file:"
  6379. (abbreviate-file-name (expand-file-name file)))))
  6380. ((string-match (concat "^" (regexp-quote pwd1) "\\(.+\\)") file)
  6381. (setq link (org-make-link "file:" (match-string 1 file))))
  6382. ((string-match (concat "^" (regexp-quote pwd) "\\(.+\\)")
  6383. (expand-file-name file))
  6384. (setq link (org-make-link
  6385. "file:" (match-string 1 (expand-file-name file)))))
  6386. (t (setq link (org-make-link "file:" file))))))
  6387. (t
  6388. ;; Read link, with completion for stored links.
  6389. (with-output-to-temp-buffer "*Org Links*"
  6390. (princ "Insert a link. Use TAB to complete valid link prefixes.\n")
  6391. (when org-stored-links
  6392. (princ "\nStored links are available with <up>/<down> or M-p/n (most recent with RET):\n\n")
  6393. (princ (mapconcat
  6394. (lambda (x)
  6395. (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
  6396. (reverse org-stored-links) "\n"))))
  6397. (let ((cw (selected-window)))
  6398. (select-window (get-buffer-window "*Org Links*"))
  6399. (shrink-window-if-larger-than-buffer)
  6400. (setq truncate-lines t)
  6401. (select-window cw))
  6402. ;; Fake a link history, containing the stored links.
  6403. (setq tmphist (append (mapcar 'car org-stored-links)
  6404. org-insert-link-history))
  6405. (unwind-protect
  6406. (setq link (org-completing-read
  6407. "Link: "
  6408. (append
  6409. (mapcar (lambda (x) (list (concat (car x) ":")))
  6410. (append org-link-abbrev-alist-local org-link-abbrev-alist))
  6411. (mapcar (lambda (x) (list (concat x ":")))
  6412. org-link-types))
  6413. nil nil nil
  6414. 'tmphist
  6415. (or (car (car org-stored-links)))))
  6416. (set-window-configuration wcf)
  6417. (kill-buffer "*Org Links*"))
  6418. (setq entry (assoc link org-stored-links))
  6419. (or entry (push link org-insert-link-history))
  6420. (if (funcall (if (equal complete-file '(64)) 'not 'identity)
  6421. (not org-keep-stored-link-after-insertion))
  6422. (setq org-stored-links (delq (assoc link org-stored-links)
  6423. org-stored-links)))
  6424. (setq desc (or desc (nth 1 entry)))))
  6425. (if (string-match org-plain-link-re link)
  6426. ;; URL-like link, normalize the use of angular brackets.
  6427. (setq link (org-make-link (org-remove-angle-brackets link))))
  6428. ;; Check if we are linking to the current file with a search option
  6429. ;; If yes, simplify the link by using only the search option.
  6430. (when (and buffer-file-name
  6431. (string-match "\\<file:\\(.+?\\)::\\([^>]+\\)" link))
  6432. (let* ((path (match-string 1 link))
  6433. (case-fold-search nil)
  6434. (search (match-string 2 link)))
  6435. (save-match-data
  6436. (if (equal (file-truename buffer-file-name) (file-truename path))
  6437. ;; We are linking to this same file, with a search option
  6438. (setq link search)))))
  6439. ;; Check if we can/should use a relative path. If yes, simplify the link
  6440. (when (string-match "\\<file:\\(.*\\)" link)
  6441. (let* ((path (match-string 1 link))
  6442. (origpath path)
  6443. (case-fold-search nil))
  6444. (cond
  6445. ((eq org-link-file-path-type 'absolute)
  6446. (setq path (abbreviate-file-name (expand-file-name path))))
  6447. ((eq org-link-file-path-type 'noabbrev)
  6448. (setq path (expand-file-name path)))
  6449. ((eq org-link-file-path-type 'relative)
  6450. (setq path (file-relative-name path)))
  6451. (t
  6452. (save-match-data
  6453. (if (string-match (concat "^" (regexp-quote
  6454. (file-name-as-directory
  6455. (expand-file-name "."))))
  6456. (expand-file-name path))
  6457. ;; We are linking a file with relative path name.
  6458. (setq path (substring (expand-file-name path)
  6459. (match-end 0)))))))
  6460. (setq link (concat "file:" path))
  6461. (if (equal desc origpath)
  6462. (setq desc path))))
  6463. (if org-make-link-description-function
  6464. (setq desc (funcall org-make-link-description-function link desc)))
  6465. (setq desc (read-string "Description: " desc))
  6466. (unless (string-match "\\S-" desc) (setq desc nil))
  6467. (if remove (apply 'delete-region remove))
  6468. (insert (org-make-link-string link desc))))
  6469. (defun org-completing-read (&rest args)
  6470. (let ((minibuffer-local-completion-map
  6471. (copy-keymap minibuffer-local-completion-map)))
  6472. (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
  6473. (apply 'completing-read args)))
  6474. (defun org-extract-attributes (s)
  6475. "Extract the attributes cookie from a string and set as text property."
  6476. (let (a attr (start 0) key value)
  6477. (save-match-data
  6478. (when (string-match "{{\\([^}]+\\)}}$" s)
  6479. (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
  6480. (while (string-match "\\([a-zA-Z]+\\)=\"\\([^\"]*\\)\"" a start)
  6481. (setq key (match-string 1 a) value (match-string 2 a)
  6482. start (match-end 0)
  6483. attr (plist-put attr (intern key) value))))
  6484. (org-add-props s nil 'org-attributes attr))
  6485. s))
  6486. (defun org-attributes-to-string (plist)
  6487. "Format a property list into an HTML attribute list."
  6488. (let ((s "") key value)
  6489. (while plist
  6490. (setq key (pop plist) value (pop plist))
  6491. (setq s (concat s " "(symbol-name key) "=\"" value "\"")))
  6492. s))
  6493. ;;; Opening/following a link
  6494. (defvar org-link-search-failed nil)
  6495. (defun org-next-link ()
  6496. "Move forward to the next link.
  6497. If the link is in hidden text, expose it."
  6498. (interactive)
  6499. (when (and org-link-search-failed (eq this-command last-command))
  6500. (goto-char (point-min))
  6501. (message "Link search wrapped back to beginning of buffer"))
  6502. (setq org-link-search-failed nil)
  6503. (let* ((pos (point))
  6504. (ct (org-context))
  6505. (a (assoc :link ct)))
  6506. (if a (goto-char (nth 2 a)))
  6507. (if (re-search-forward org-any-link-re nil t)
  6508. (progn
  6509. (goto-char (match-beginning 0))
  6510. (if (org-invisible-p) (org-show-context)))
  6511. (goto-char pos)
  6512. (setq org-link-search-failed t)
  6513. (error "No further link found"))))
  6514. (defun org-previous-link ()
  6515. "Move backward to the previous link.
  6516. If the link is in hidden text, expose it."
  6517. (interactive)
  6518. (when (and org-link-search-failed (eq this-command last-command))
  6519. (goto-char (point-max))
  6520. (message "Link search wrapped back to end of buffer"))
  6521. (setq org-link-search-failed nil)
  6522. (let* ((pos (point))
  6523. (ct (org-context))
  6524. (a (assoc :link ct)))
  6525. (if a (goto-char (nth 1 a)))
  6526. (if (re-search-backward org-any-link-re nil t)
  6527. (progn
  6528. (goto-char (match-beginning 0))
  6529. (if (org-invisible-p) (org-show-context)))
  6530. (goto-char pos)
  6531. (setq org-link-search-failed t)
  6532. (error "No further link found"))))
  6533. (defun org-find-file-at-mouse (ev)
  6534. "Open file link or URL at mouse."
  6535. (interactive "e")
  6536. (mouse-set-point ev)
  6537. (org-open-at-point 'in-emacs))
  6538. (defun org-open-at-mouse (ev)
  6539. "Open file link or URL at mouse."
  6540. (interactive "e")
  6541. (mouse-set-point ev)
  6542. (org-open-at-point))
  6543. (defvar org-window-config-before-follow-link nil
  6544. "The window configuration before following a link.
  6545. This is saved in case the need arises to restore it.")
  6546. (defvar org-open-link-marker (make-marker)
  6547. "Marker pointing to the location where `org-open-at-point; was called.")
  6548. ;;;###autoload
  6549. (defun org-open-at-point-global ()
  6550. "Follow a link like Org-mode does.
  6551. This command can be called in any mode to follow a link that has
  6552. Org-mode syntax."
  6553. (interactive)
  6554. (org-run-like-in-org-mode 'org-open-at-point))
  6555. ;;;###autoload
  6556. (defun org-open-link-from-string (s &optional arg)
  6557. "Open a link in the string S, as if it was in Org-mode."
  6558. (interactive "sLink: \nP")
  6559. (with-temp-buffer
  6560. (let ((org-inhibit-startup t))
  6561. (org-mode)
  6562. (insert s)
  6563. (goto-char (point-min))
  6564. (org-open-at-point arg))))
  6565. (defun org-open-at-point (&optional in-emacs)
  6566. "Open link at or after point.
  6567. If there is no link at point, this function will search forward up to
  6568. the end of the current subtree.
  6569. Normally, files will be opened by an appropriate application. If the
  6570. optional argument IN-EMACS is non-nil, Emacs will visit the file."
  6571. (interactive "P")
  6572. (org-load-modules-maybe)
  6573. (move-marker org-open-link-marker (point))
  6574. (setq org-window-config-before-follow-link (current-window-configuration))
  6575. (org-remove-occur-highlights nil nil t)
  6576. (if (org-at-timestamp-p t)
  6577. (org-follow-timestamp-link)
  6578. (let (type path link line search (pos (point)))
  6579. (catch 'match
  6580. (save-excursion
  6581. (skip-chars-forward "^]\n\r")
  6582. (when (org-in-regexp org-bracket-link-regexp)
  6583. (setq link (org-extract-attributes
  6584. (org-link-unescape (org-match-string-no-properties 1))))
  6585. (while (string-match " *\n *" link)
  6586. (setq link (replace-match " " t t link)))
  6587. (setq link (org-link-expand-abbrev link))
  6588. (cond
  6589. ((or (file-name-absolute-p link)
  6590. (string-match "^\\.\\.?/" link))
  6591. (setq type "file" path link))
  6592. ((string-match org-link-re-with-space2 link)
  6593. (setq type (match-string 1 link) path (match-string 2 link)))
  6594. (t (setq type "thisfile" path link)))
  6595. (throw 'match t)))
  6596. (when (get-text-property (point) 'org-linked-text)
  6597. (setq type "thisfile"
  6598. pos (if (get-text-property (1+ (point)) 'org-linked-text)
  6599. (1+ (point)) (point))
  6600. path (buffer-substring
  6601. (previous-single-property-change pos 'org-linked-text)
  6602. (next-single-property-change pos 'org-linked-text)))
  6603. (throw 'match t))
  6604. (save-excursion
  6605. (when (or (org-in-regexp org-angle-link-re)
  6606. (org-in-regexp org-plain-link-re))
  6607. (setq type (match-string 1) path (match-string 2))
  6608. (throw 'match t)))
  6609. (when (org-in-regexp "\\<\\([^><\n]+\\)\\>")
  6610. (setq type "tree-match"
  6611. path (match-string 1))
  6612. (throw 'match t))
  6613. (save-excursion
  6614. (when (org-in-regexp (org-re "\\(:[[:alnum:]_@:]+\\):[ \t]*$"))
  6615. (setq type "tags"
  6616. path (match-string 1))
  6617. (while (string-match ":" path)
  6618. (setq path (replace-match "+" t t path)))
  6619. (throw 'match t))))
  6620. (unless path
  6621. (error "No link found"))
  6622. ;; Remove any trailing spaces in path
  6623. (if (string-match " +\\'" path)
  6624. (setq path (replace-match "" t t path)))
  6625. (cond
  6626. ((assoc type org-link-protocols)
  6627. (funcall (nth 1 (assoc type org-link-protocols)) path))
  6628. ((equal type "mailto")
  6629. (let ((cmd (car org-link-mailto-program))
  6630. (args (cdr org-link-mailto-program)) args1
  6631. (address path) (subject "") a)
  6632. (if (string-match "\\(.*\\)::\\(.*\\)" path)
  6633. (setq address (match-string 1 path)
  6634. subject (org-link-escape (match-string 2 path))))
  6635. (while args
  6636. (cond
  6637. ((not (stringp (car args))) (push (pop args) args1))
  6638. (t (setq a (pop args))
  6639. (if (string-match "%a" a)
  6640. (setq a (replace-match address t t a)))
  6641. (if (string-match "%s" a)
  6642. (setq a (replace-match subject t t a)))
  6643. (push a args1))))
  6644. (apply cmd (nreverse args1))))
  6645. ((member type '("http" "https" "ftp" "news"))
  6646. (browse-url (concat type ":" (org-link-escape
  6647. path org-link-escape-chars-browser))))
  6648. ((member type '("message"))
  6649. (browse-url (concat type ":" path)))
  6650. ((string= type "tags")
  6651. (org-tags-view in-emacs path))
  6652. ((string= type "thisfile")
  6653. (if in-emacs
  6654. (switch-to-buffer-other-window
  6655. (org-get-buffer-for-internal-link (current-buffer)))
  6656. (org-mark-ring-push))
  6657. (let ((cmd `(org-link-search
  6658. ,path
  6659. ,(cond ((equal in-emacs '(4)) 'occur)
  6660. ((equal in-emacs '(16)) 'org-occur)
  6661. (t nil))
  6662. ,pos)))
  6663. (condition-case nil (eval cmd)
  6664. (error (progn (widen) (eval cmd))))))
  6665. ((string= type "tree-match")
  6666. (org-occur (concat "\\[" (regexp-quote path) "\\]")))
  6667. ((string= type "file")
  6668. (if (string-match "::\\([0-9]+\\)\\'" path)
  6669. (setq line (string-to-number (match-string 1 path))
  6670. path (substring path 0 (match-beginning 0)))
  6671. (if (string-match "::\\(.+\\)\\'" path)
  6672. (setq search (match-string 1 path)
  6673. path (substring path 0 (match-beginning 0)))))
  6674. (if (string-match "[*?{]" (file-name-nondirectory path))
  6675. (dired path)
  6676. (org-open-file path in-emacs line search)))
  6677. ((string= type "news")
  6678. (require 'org-gnus)
  6679. (org-gnus-follow-link path))
  6680. ((string= type "shell")
  6681. (let ((cmd path))
  6682. (if (or (not org-confirm-shell-link-function)
  6683. (funcall org-confirm-shell-link-function
  6684. (format "Execute \"%s\" in shell? "
  6685. (org-add-props cmd nil
  6686. 'face 'org-warning))))
  6687. (progn
  6688. (message "Executing %s" cmd)
  6689. (shell-command cmd))
  6690. (error "Abort"))))
  6691. ((string= type "elisp")
  6692. (let ((cmd path))
  6693. (if (or (not org-confirm-elisp-link-function)
  6694. (funcall org-confirm-elisp-link-function
  6695. (format "Execute \"%s\" as elisp? "
  6696. (org-add-props cmd nil
  6697. 'face 'org-warning))))
  6698. (message "%s => %s" cmd (eval (read cmd)))
  6699. (error "Abort"))))
  6700. (t
  6701. (browse-url-at-point)))))
  6702. (move-marker org-open-link-marker nil)
  6703. (run-hook-with-args 'org-follow-link-hook))
  6704. ;;;; Time estimates
  6705. (defun org-get-effort (&optional pom)
  6706. "Get the effort estimate for the current entry."
  6707. (org-entry-get pom org-effort-property))
  6708. ;;; File search
  6709. (defvar org-create-file-search-functions nil
  6710. "List of functions to construct the right search string for a file link.
  6711. These functions are called in turn with point at the location to
  6712. which the link should point.
  6713. A function in the hook should first test if it would like to
  6714. handle this file type, for example by checking the major-mode or
  6715. the file extension. If it decides not to handle this file, it
  6716. should just return nil to give other functions a chance. If it
  6717. does handle the file, it must return the search string to be used
  6718. when following the link. The search string will be part of the
  6719. file link, given after a double colon, and `org-open-at-point'
  6720. will automatically search for it. If special measures must be
  6721. taken to make the search successful, another function should be
  6722. added to the companion hook `org-execute-file-search-functions',
  6723. which see.
  6724. A function in this hook may also use `setq' to set the variable
  6725. `description' to provide a suggestion for the descriptive text to
  6726. be used for this link when it gets inserted into an Org-mode
  6727. buffer with \\[org-insert-link].")
  6728. (defvar org-execute-file-search-functions nil
  6729. "List of functions to execute a file search triggered by a link.
  6730. Functions added to this hook must accept a single argument, the
  6731. search string that was part of the file link, the part after the
  6732. double colon. The function must first check if it would like to
  6733. handle this search, for example by checking the major-mode or the
  6734. file extension. If it decides not to handle this search, it
  6735. should just return nil to give other functions a chance. If it
  6736. does handle the search, it must return a non-nil value to keep
  6737. other functions from trying.
  6738. Each function can access the current prefix argument through the
  6739. variable `current-prefix-argument'. Note that a single prefix is
  6740. used to force opening a link in Emacs, so it may be good to only
  6741. use a numeric or double prefix to guide the search function.
  6742. In case this is needed, a function in this hook can also restore
  6743. the window configuration before `org-open-at-point' was called using:
  6744. (set-window-configuration org-window-config-before-follow-link)")
  6745. (defun org-link-search (s &optional type avoid-pos)
  6746. "Search for a link search option.
  6747. If S is surrounded by forward slashes, it is interpreted as a
  6748. regular expression. In org-mode files, this will create an `org-occur'
  6749. sparse tree. In ordinary files, `occur' will be used to list matches.
  6750. If the current buffer is in `dired-mode', grep will be used to search
  6751. in all files. If AVOID-POS is given, ignore matches near that position."
  6752. (let ((case-fold-search t)
  6753. (s0 (mapconcat 'identity (org-split-string s "[ \t\r\n]+") " "))
  6754. (markers (concat "\\(?:" (mapconcat (lambda (x) (regexp-quote (car x)))
  6755. (append '(("") (" ") ("\t") ("\n"))
  6756. org-emphasis-alist)
  6757. "\\|") "\\)"))
  6758. (pos (point))
  6759. (pre nil) (post nil)
  6760. words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
  6761. (cond
  6762. ;; First check if there are any special
  6763. ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
  6764. ;; Now try the builtin stuff
  6765. ((save-excursion
  6766. (goto-char (point-min))
  6767. (and
  6768. (re-search-forward
  6769. (concat "<<" (regexp-quote s0) ">>") nil t)
  6770. (setq type 'dedicated
  6771. pos (match-beginning 0))))
  6772. ;; There is an exact target for this
  6773. (goto-char pos))
  6774. ((string-match "^/\\(.*\\)/$" s)
  6775. ;; A regular expression
  6776. (cond
  6777. ((org-mode-p)
  6778. (org-occur (match-string 1 s)))
  6779. ;;((eq major-mode 'dired-mode)
  6780. ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
  6781. (t (org-do-occur (match-string 1 s)))))
  6782. (t
  6783. ;; A normal search strings
  6784. (when (equal (string-to-char s) ?*)
  6785. ;; Anchor on headlines, post may include tags.
  6786. (setq pre "^\\*+[ \t]+\\(?:\\sw+\\)?[ \t]*"
  6787. post (org-re "[ \t]*\\(?:[ \t]+:[[:alnum:]_@:+]:[ \t]*\\)?$")
  6788. s (substring s 1)))
  6789. (remove-text-properties
  6790. 0 (length s)
  6791. '(face nil mouse-face nil keymap nil fontified nil) s)
  6792. ;; Make a series of regular expressions to find a match
  6793. (setq words (org-split-string s "[ \n\r\t]+")
  6794. re0 (concat "\\(<<" (regexp-quote s0) ">>\\)")
  6795. re2 (concat markers "\\(" (mapconcat 'downcase words "[ \t]+")
  6796. "\\)" markers)
  6797. re2a_ (concat "\\(" (mapconcat 'downcase words "[ \t\r\n]+") "\\)[ \t\r\n]")
  6798. re2a (concat "[ \t\r\n]" re2a_)
  6799. re4_ (concat "\\(" (mapconcat 'downcase words "[^a-zA-Z_\r\n]+") "\\)[^a-zA-Z_]")
  6800. re4 (concat "[^a-zA-Z_]" re4_)
  6801. re1 (concat pre re2 post)
  6802. re3 (concat pre (if pre re4_ re4) post)
  6803. re5 (concat pre ".*" re4)
  6804. re2 (concat pre re2)
  6805. re2a (concat pre (if pre re2a_ re2a))
  6806. re4 (concat pre (if pre re4_ re4))
  6807. reall (concat "\\(" re0 "\\)\\|\\(" re1 "\\)\\|\\(" re2
  6808. "\\)\\|\\(" re3 "\\)\\|\\(" re4 "\\)\\|\\("
  6809. re5 "\\)"
  6810. ))
  6811. (cond
  6812. ((eq type 'org-occur) (org-occur reall))
  6813. ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
  6814. (t (goto-char (point-min))
  6815. (setq type 'fuzzy)
  6816. (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
  6817. (org-search-not-self 1 re1 nil t)
  6818. (org-search-not-self 1 re2 nil t)
  6819. (org-search-not-self 1 re2a nil t)
  6820. (org-search-not-self 1 re3 nil t)
  6821. (org-search-not-self 1 re4 nil t)
  6822. (org-search-not-self 1 re5 nil t)
  6823. )
  6824. (goto-char (match-beginning 1))
  6825. (goto-char pos)
  6826. (error "No match")))))
  6827. (t
  6828. ;; Normal string-search
  6829. (goto-char (point-min))
  6830. (if (search-forward s nil t)
  6831. (goto-char (match-beginning 0))
  6832. (error "No match"))))
  6833. (and (org-mode-p) (org-show-context 'link-search))
  6834. type))
  6835. (defun org-search-not-self (group &rest args)
  6836. "Execute `re-search-forward', but only accept matches that do not
  6837. enclose the position of `org-open-link-marker'."
  6838. (let ((m org-open-link-marker))
  6839. (catch 'exit
  6840. (while (apply 're-search-forward args)
  6841. (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
  6842. (goto-char (match-end group))
  6843. (if (and (or (not (eq (marker-buffer m) (current-buffer)))
  6844. (> (match-beginning 0) (marker-position m))
  6845. (< (match-end 0) (marker-position m)))
  6846. (save-match-data
  6847. (or (not (org-in-regexp
  6848. org-bracket-link-analytic-regexp 1))
  6849. (not (match-end 4)) ; no description
  6850. (and (<= (match-beginning 4) (point))
  6851. (>= (match-end 4) (point))))))
  6852. (throw 'exit (point))))))))
  6853. (defun org-get-buffer-for-internal-link (buffer)
  6854. "Return a buffer to be used for displaying the link target of internal links."
  6855. (cond
  6856. ((not org-display-internal-link-with-indirect-buffer)
  6857. buffer)
  6858. ((string-match "(Clone)$" (buffer-name buffer))
  6859. (message "Buffer is already a clone, not making another one")
  6860. ;; we also do not modify visibility in this case
  6861. buffer)
  6862. (t ; make a new indirect buffer for displaying the link
  6863. (let* ((bn (buffer-name buffer))
  6864. (ibn (concat bn "(Clone)"))
  6865. (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
  6866. (with-current-buffer ib (org-overview))
  6867. ib))))
  6868. (defun org-do-occur (regexp &optional cleanup)
  6869. "Call the Emacs command `occur'.
  6870. If CLEANUP is non-nil, remove the printout of the regular expression
  6871. in the *Occur* buffer. This is useful if the regex is long and not useful
  6872. to read."
  6873. (occur regexp)
  6874. (when cleanup
  6875. (let ((cwin (selected-window)) win beg end)
  6876. (when (setq win (get-buffer-window "*Occur*"))
  6877. (select-window win))
  6878. (goto-char (point-min))
  6879. (when (re-search-forward "match[a-z]+" nil t)
  6880. (setq beg (match-end 0))
  6881. (if (re-search-forward "^[ \t]*[0-9]+" nil t)
  6882. (setq end (1- (match-beginning 0)))))
  6883. (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
  6884. (goto-char (point-min))
  6885. (select-window cwin))))
  6886. ;;; The mark ring for links jumps
  6887. (defvar org-mark-ring nil
  6888. "Mark ring for positions before jumps in Org-mode.")
  6889. (defvar org-mark-ring-last-goto nil
  6890. "Last position in the mark ring used to go back.")
  6891. ;; Fill and close the ring
  6892. (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
  6893. (loop for i from 1 to org-mark-ring-length do
  6894. (push (make-marker) org-mark-ring))
  6895. (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
  6896. org-mark-ring)
  6897. (defun org-mark-ring-push (&optional pos buffer)
  6898. "Put the current position or POS into the mark ring and rotate it."
  6899. (interactive)
  6900. (setq pos (or pos (point)))
  6901. (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
  6902. (move-marker (car org-mark-ring)
  6903. (or pos (point))
  6904. (or buffer (current-buffer)))
  6905. (message "%s"
  6906. (substitute-command-keys
  6907. "Position saved to mark ring, go back with \\[org-mark-ring-goto].")))
  6908. (defun org-mark-ring-goto (&optional n)
  6909. "Jump to the previous position in the mark ring.
  6910. With prefix arg N, jump back that many stored positions. When
  6911. called several times in succession, walk through the entire ring.
  6912. Org-mode commands jumping to a different position in the current file,
  6913. or to another Org-mode file, automatically push the old position
  6914. onto the ring."
  6915. (interactive "p")
  6916. (let (p m)
  6917. (if (eq last-command this-command)
  6918. (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
  6919. (setq p org-mark-ring))
  6920. (setq org-mark-ring-last-goto p)
  6921. (setq m (car p))
  6922. (switch-to-buffer (marker-buffer m))
  6923. (goto-char m)
  6924. (if (or (org-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
  6925. (defun org-remove-angle-brackets (s)
  6926. (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
  6927. (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
  6928. s)
  6929. (defun org-add-angle-brackets (s)
  6930. (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
  6931. (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
  6932. s)
  6933. (defun org-remove-double-quotes (s)
  6934. (if (equal (substring s 0 1) "\"") (setq s (substring s 1)))
  6935. (if (equal (substring s -1) "\"") (setq s (substring s 0 -1)))
  6936. s)
  6937. ;;; Following specific links
  6938. (defun org-follow-timestamp-link ()
  6939. (cond
  6940. ((org-at-date-range-p t)
  6941. (let ((org-agenda-start-on-weekday)
  6942. (t1 (match-string 1))
  6943. (t2 (match-string 2)))
  6944. (setq t1 (time-to-days (org-time-string-to-time t1))
  6945. t2 (time-to-days (org-time-string-to-time t2)))
  6946. (org-agenda-list nil t1 (1+ (- t2 t1)))))
  6947. ((org-at-timestamp-p t)
  6948. (org-agenda-list nil (time-to-days (org-time-string-to-time
  6949. (substring (match-string 1) 0 10)))
  6950. 1))
  6951. (t (error "This should not happen"))))
  6952. ;;; Following file links
  6953. (defvar org-wait nil)
  6954. (defun org-open-file (path &optional in-emacs line search)
  6955. "Open the file at PATH.
  6956. First, this expands any special file name abbreviations. Then the
  6957. configuration variable `org-file-apps' is checked if it contains an
  6958. entry for this file type, and if yes, the corresponding command is launched.
  6959. If no application is found, Emacs simply visits the file.
  6960. With optional argument IN-EMACS, Emacs will visit the file.
  6961. Optional LINE specifies a line to go to, optional SEARCH a string to
  6962. search for. If LINE or SEARCH is given, the file will always be
  6963. opened in Emacs.
  6964. If the file does not exist, an error is thrown."
  6965. (setq in-emacs (or in-emacs line search))
  6966. (let* ((file (if (equal path "")
  6967. buffer-file-name
  6968. (substitute-in-file-name (expand-file-name path))))
  6969. (apps (append org-file-apps (org-default-apps)))
  6970. (remp (and (assq 'remote apps) (org-file-remote-p file)))
  6971. (dirp (if remp nil (file-directory-p file)))
  6972. (file (if (and dirp org-open-directory-means-index-dot-org)
  6973. (concat (file-name-as-directory file) "index.org")
  6974. file))
  6975. (dfile (downcase file))
  6976. (old-buffer (current-buffer))
  6977. (old-pos (point))
  6978. (old-mode major-mode)
  6979. ext cmd)
  6980. (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\.gz\\)$" dfile)
  6981. (setq ext (match-string 1 dfile))
  6982. (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\)$" dfile)
  6983. (setq ext (match-string 1 dfile))))
  6984. (if in-emacs
  6985. (setq cmd 'emacs)
  6986. (setq cmd (or (and remp (cdr (assoc 'remote apps)))
  6987. (and dirp (cdr (assoc 'directory apps)))
  6988. (cdr (assoc ext apps))
  6989. (cdr (assoc t apps)))))
  6990. (when (eq cmd 'mailcap)
  6991. (require 'mailcap)
  6992. (mailcap-parse-mailcaps)
  6993. (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
  6994. (command (mailcap-mime-info mime-type)))
  6995. (if (stringp command)
  6996. (setq cmd command)
  6997. (setq cmd 'emacs))))
  6998. (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
  6999. (not (file-exists-p file))
  7000. (not org-open-non-existing-files))
  7001. (error "No such file: %s" file))
  7002. (cond
  7003. ((and (stringp cmd) (not (string-match "^\\s-*$" cmd)))
  7004. ;; Remove quotes around the file name - we'll use shell-quote-argument.
  7005. (while (string-match "['\"]%s['\"]" cmd)
  7006. (setq cmd (replace-match "%s" t t cmd)))
  7007. (while (string-match "%s" cmd)
  7008. (setq cmd (replace-match
  7009. (save-match-data
  7010. (shell-quote-argument
  7011. (convert-standard-filename file)))
  7012. t t cmd)))
  7013. (save-window-excursion
  7014. (start-process-shell-command cmd nil cmd)
  7015. (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
  7016. ))
  7017. ((or (stringp cmd)
  7018. (eq cmd 'emacs))
  7019. (funcall (cdr (assq 'file org-link-frame-setup)) file)
  7020. (widen)
  7021. (if line (goto-line line)
  7022. (if search (org-link-search search))))
  7023. ((consp cmd)
  7024. (let ((file (convert-standard-filename file)))
  7025. (eval cmd)))
  7026. (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
  7027. (and (org-mode-p) (eq old-mode 'org-mode)
  7028. (or (not (equal old-buffer (current-buffer)))
  7029. (not (equal old-pos (point))))
  7030. (org-mark-ring-push old-pos old-buffer))))
  7031. (defun org-default-apps ()
  7032. "Return the default applications for this operating system."
  7033. (cond
  7034. ((eq system-type 'darwin)
  7035. org-file-apps-defaults-macosx)
  7036. ((eq system-type 'windows-nt)
  7037. org-file-apps-defaults-windowsnt)
  7038. (t org-file-apps-defaults-gnu)))
  7039. (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
  7040. (defun org-file-remote-p (file)
  7041. "Test whether FILE specifies a location on a remote system.
  7042. Return non-nil if the location is indeed remote.
  7043. For example, the filename \"/user@host:/foo\" specifies a location
  7044. on the system \"/user@host:\"."
  7045. (cond ((fboundp 'file-remote-p)
  7046. (file-remote-p file))
  7047. ((fboundp 'tramp-handle-file-remote-p)
  7048. (tramp-handle-file-remote-p file))
  7049. ((and (boundp 'ange-ftp-name-format)
  7050. (string-match (car ange-ftp-name-format) file))
  7051. t)
  7052. (t nil)))
  7053. ;;;; Refiling
  7054. (defun org-get-org-file ()
  7055. "Read a filename, with default directory `org-directory'."
  7056. (let ((default (or org-default-notes-file remember-data-file)))
  7057. (read-file-name (format "File name [%s]: " default)
  7058. (file-name-as-directory org-directory)
  7059. default)))
  7060. (defun org-notes-order-reversed-p ()
  7061. "Check if the current file should receive notes in reversed order."
  7062. (cond
  7063. ((not org-reverse-note-order) nil)
  7064. ((eq t org-reverse-note-order) t)
  7065. ((not (listp org-reverse-note-order)) nil)
  7066. (t (catch 'exit
  7067. (let ((all org-reverse-note-order)
  7068. entry)
  7069. (while (setq entry (pop all))
  7070. (if (string-match (car entry) buffer-file-name)
  7071. (throw 'exit (cdr entry))))
  7072. nil)))))
  7073. (defvar org-refile-target-table nil
  7074. "The list of refile targets, created by `org-refile'.")
  7075. (defvar org-agenda-new-buffers nil
  7076. "Buffers created to visit agenda files.")
  7077. (defun org-get-refile-targets (&optional default-buffer)
  7078. "Produce a table with refile targets."
  7079. (let ((entries (or org-refile-targets '((nil . (:level . 1)))))
  7080. targets txt re files f desc descre)
  7081. (with-current-buffer (or default-buffer (current-buffer))
  7082. (while (setq entry (pop entries))
  7083. (setq files (car entry) desc (cdr entry))
  7084. (cond
  7085. ((null files) (setq files (list (current-buffer))))
  7086. ((eq files 'org-agenda-files)
  7087. (setq files (org-agenda-files 'unrestricted)))
  7088. ((and (symbolp files) (fboundp files))
  7089. (setq files (funcall files)))
  7090. ((and (symbolp files) (boundp files))
  7091. (setq files (symbol-value files))))
  7092. (if (stringp files) (setq files (list files)))
  7093. (cond
  7094. ((eq (car desc) :tag)
  7095. (setq descre (concat "^\\*+[ \t]+.*?:" (regexp-quote (cdr desc)) ":")))
  7096. ((eq (car desc) :todo)
  7097. (setq descre (concat "^\\*+[ \t]+" (regexp-quote (cdr desc)) "[ \t]")))
  7098. ((eq (car desc) :regexp)
  7099. (setq descre (cdr desc)))
  7100. ((eq (car desc) :level)
  7101. (setq descre (concat "^\\*\\{" (number-to-string
  7102. (if org-odd-levels-only
  7103. (1- (* 2 (cdr desc)))
  7104. (cdr desc)))
  7105. "\\}[ \t]")))
  7106. ((eq (car desc) :maxlevel)
  7107. (setq descre (concat "^\\*\\{1," (number-to-string
  7108. (if org-odd-levels-only
  7109. (1- (* 2 (cdr desc)))
  7110. (cdr desc)))
  7111. "\\}[ \t]")))
  7112. (t (error "Bad refiling target description %s" desc)))
  7113. (while (setq f (pop files))
  7114. (save-excursion
  7115. (set-buffer (if (bufferp f) f (org-get-agenda-file-buffer f)))
  7116. (if (bufferp f) (setq f (buffer-file-name (buffer-base-buffer f))))
  7117. (save-excursion
  7118. (save-restriction
  7119. (widen)
  7120. (goto-char (point-min))
  7121. (while (re-search-forward descre nil t)
  7122. (goto-char (point-at-bol))
  7123. (when (looking-at org-complex-heading-regexp)
  7124. (setq txt (match-string 4)
  7125. re (concat "^" (regexp-quote
  7126. (buffer-substring (match-beginning 1)
  7127. (match-end 4)))))
  7128. (if (match-end 5) (setq re (concat re "[ \t]+"
  7129. (regexp-quote
  7130. (match-string 5)))))
  7131. (setq re (concat re "[ \t]*$"))
  7132. (when org-refile-use-outline-path
  7133. (setq txt (mapconcat 'org-protect-slash
  7134. (append
  7135. (if (eq org-refile-use-outline-path 'file)
  7136. (list (file-name-nondirectory
  7137. (buffer-file-name (buffer-base-buffer))))
  7138. (if (eq org-refile-use-outline-path 'full-file-path)
  7139. (list (buffer-file-name (buffer-base-buffer)))))
  7140. (org-get-outline-path)
  7141. (list txt))
  7142. "/")))
  7143. (push (list txt f re (point)) targets))
  7144. (goto-char (point-at-eol))))))))
  7145. (nreverse targets))))
  7146. (defun org-protect-slash (s)
  7147. (while (string-match "/" s)
  7148. (setq s (replace-match "\\" t t s)))
  7149. s)
  7150. (defun org-get-outline-path ()
  7151. "Return the outline path to the current entry, as a list."
  7152. (let (rtn)
  7153. (save-excursion
  7154. (while (org-up-heading-safe)
  7155. (when (looking-at org-complex-heading-regexp)
  7156. (push (org-match-string-no-properties 4) rtn)))
  7157. rtn)))
  7158. (defvar org-refile-history nil
  7159. "History for refiling operations.")
  7160. (defun org-refile (&optional goto default-buffer)
  7161. "Move the entry at point to another heading.
  7162. The list of target headings is compiled using the information in
  7163. `org-refile-targets', which see. This list is created before each use
  7164. and will therefore always be up-to-date.
  7165. At the target location, the entry is filed as a subitem of the target heading.
  7166. Depending on `org-reverse-note-order', the new subitem will either be the
  7167. first of the last subitem.
  7168. With prefix arg GOTO, the command will only visit the target location,
  7169. not actually move anything.
  7170. With a double prefix `C-u C-u', go to the location where the last refiling
  7171. operation has put the subtree."
  7172. (interactive "P")
  7173. (let* ((cbuf (current-buffer))
  7174. (filename (buffer-file-name (buffer-base-buffer cbuf)))
  7175. pos it nbuf file re level reversed)
  7176. (if (equal goto '(16))
  7177. (org-refile-goto-last-stored)
  7178. (when (setq it (org-refile-get-location
  7179. (if goto "Goto: " "Refile to: ") default-buffer))
  7180. (setq file (nth 1 it)
  7181. re (nth 2 it)
  7182. pos (nth 3 it))
  7183. (setq nbuf (or (find-buffer-visiting file)
  7184. (find-file-noselect file)))
  7185. (if goto
  7186. (progn
  7187. (switch-to-buffer nbuf)
  7188. (goto-char pos)
  7189. (org-show-context 'org-goto))
  7190. (org-copy-subtree 1 nil t)
  7191. (save-excursion
  7192. (set-buffer (setq nbuf (or (find-buffer-visiting file)
  7193. (find-file-noselect file))))
  7194. (setq reversed (org-notes-order-reversed-p))
  7195. (save-excursion
  7196. (save-restriction
  7197. (widen)
  7198. (goto-char pos)
  7199. (looking-at outline-regexp)
  7200. (setq level (org-get-valid-level (funcall outline-level) 1))
  7201. (goto-char
  7202. (if reversed
  7203. (or (outline-next-heading) (point-max))
  7204. (or (save-excursion (outline-get-next-sibling))
  7205. (org-end-of-subtree t t)
  7206. (point-max))))
  7207. (if (not (bolp)) (newline))
  7208. (bookmark-set "org-refile-last-stored")
  7209. (org-paste-subtree level))))
  7210. (org-cut-subtree)
  7211. (setq org-markers-to-move nil)
  7212. (message "Entry refiled to \"%s\"" (car it)))))))
  7213. (defun org-refile-goto-last-stored ()
  7214. "Go to the location where the last refile was stored."
  7215. (interactive)
  7216. (bookmark-jump "org-refile-last-stored")
  7217. (message "This is the location of the last refile"))
  7218. (defun org-refile-get-location (&optional prompt default-buffer)
  7219. "Prompt the user for a refile location, using PROMPT."
  7220. (let ((org-refile-targets org-refile-targets)
  7221. (org-refile-use-outline-path org-refile-use-outline-path))
  7222. (setq org-refile-target-table (org-get-refile-targets default-buffer)))
  7223. (unless org-refile-target-table
  7224. (error "No refile targets"))
  7225. (let* ((cbuf (current-buffer))
  7226. (cfunc (if org-refile-use-outline-path
  7227. 'org-olpath-completing-read
  7228. 'completing-read))
  7229. (extra (if org-refile-use-outline-path "/" ""))
  7230. (filename (buffer-file-name (buffer-base-buffer cbuf)))
  7231. (fname (and filename (file-truename filename)))
  7232. (tbl (mapcar
  7233. (lambda (x)
  7234. (if (not (equal fname (file-truename (nth 1 x))))
  7235. (cons (concat (car x) extra " ("
  7236. (file-name-nondirectory (nth 1 x)) ")")
  7237. (cdr x))
  7238. (cons (concat (car x) extra) (cdr x))))
  7239. org-refile-target-table))
  7240. (completion-ignore-case t))
  7241. (assoc (funcall cfunc prompt tbl nil t nil 'org-refile-history)
  7242. tbl)))
  7243. (defun org-olpath-completing-read (prompt collection &rest args)
  7244. "Read an outline path like a file name."
  7245. (let ((thetable collection))
  7246. (apply
  7247. 'completing-read prompt
  7248. (lambda (string predicate &optional flag)
  7249. (let (rtn r s f (l (length string)))
  7250. (cond
  7251. ((eq flag nil)
  7252. ;; try completion
  7253. (try-completion string thetable))
  7254. ((eq flag t)
  7255. ;; all-completions
  7256. (setq rtn (all-completions string thetable predicate))
  7257. (mapcar
  7258. (lambda (x)
  7259. (setq r (substring x l))
  7260. (if (string-match " ([^)]*)$" x)
  7261. (setq f (match-string 0 x))
  7262. (setq f ""))
  7263. (if (string-match "/" r)
  7264. (concat string (substring r 0 (match-end 0)) f)
  7265. x))
  7266. rtn))
  7267. ((eq flag 'lambda)
  7268. ;; exact match?
  7269. (assoc string thetable)))
  7270. ))
  7271. args)))
  7272. ;;;; Dynamic blocks
  7273. (defun org-find-dblock (name)
  7274. "Find the first dynamic block with name NAME in the buffer.
  7275. If not found, stay at current position and return nil."
  7276. (let (pos)
  7277. (save-excursion
  7278. (goto-char (point-min))
  7279. (setq pos (and (re-search-forward (concat "^#\\+BEGIN:[ \t]+" name "\\>")
  7280. nil t)
  7281. (match-beginning 0))))
  7282. (if pos (goto-char pos))
  7283. pos))
  7284. (defconst org-dblock-start-re
  7285. "^#\\+BEGIN:[ \t]+\\(\\S-+\\)\\([ \t]+\\(.*\\)\\)?"
  7286. "Matches the startline of a dynamic block, with parameters.")
  7287. (defconst org-dblock-end-re "^#\\+END\\([: \t\r\n]\\|$\\)"
  7288. "Matches the end of a dyhamic block.")
  7289. (defun org-create-dblock (plist)
  7290. "Create a dynamic block section, with parameters taken from PLIST.
  7291. PLIST must containe a :name entry which is used as name of the block."
  7292. (unless (bolp) (newline))
  7293. (let ((name (plist-get plist :name)))
  7294. (insert "#+BEGIN: " name)
  7295. (while plist
  7296. (if (eq (car plist) :name)
  7297. (setq plist (cddr plist))
  7298. (insert " " (prin1-to-string (pop plist)))))
  7299. (insert "\n\n#+END:\n")
  7300. (beginning-of-line -2)))
  7301. (defun org-prepare-dblock ()
  7302. "Prepare dynamic block for refresh.
  7303. This empties the block, puts the cursor at the insert position and returns
  7304. the property list including an extra property :name with the block name."
  7305. (unless (looking-at org-dblock-start-re)
  7306. (error "Not at a dynamic block"))
  7307. (let* ((begdel (1+ (match-end 0)))
  7308. (name (org-no-properties (match-string 1)))
  7309. (params (append (list :name name)
  7310. (read (concat "(" (match-string 3) ")")))))
  7311. (unless (re-search-forward org-dblock-end-re nil t)
  7312. (error "Dynamic block not terminated"))
  7313. (setq params
  7314. (append params
  7315. (list :content (buffer-substring
  7316. begdel (match-beginning 0)))))
  7317. (delete-region begdel (match-beginning 0))
  7318. (goto-char begdel)
  7319. (open-line 1)
  7320. params))
  7321. (defun org-map-dblocks (&optional command)
  7322. "Apply COMMAND to all dynamic blocks in the current buffer.
  7323. If COMMAND is not given, use `org-update-dblock'."
  7324. (let ((cmd (or command 'org-update-dblock))
  7325. pos)
  7326. (save-excursion
  7327. (goto-char (point-min))
  7328. (while (re-search-forward org-dblock-start-re nil t)
  7329. (goto-char (setq pos (match-beginning 0)))
  7330. (condition-case nil
  7331. (funcall cmd)
  7332. (error (message "Error during update of dynamic block")))
  7333. (goto-char pos)
  7334. (unless (re-search-forward org-dblock-end-re nil t)
  7335. (error "Dynamic block not terminated"))))))
  7336. (defun org-dblock-update (&optional arg)
  7337. "User command for updating dynamic blocks.
  7338. Update the dynamic block at point. With prefix ARG, update all dynamic
  7339. blocks in the buffer."
  7340. (interactive "P")
  7341. (if arg
  7342. (org-update-all-dblocks)
  7343. (or (looking-at org-dblock-start-re)
  7344. (org-beginning-of-dblock))
  7345. (org-update-dblock)))
  7346. (defun org-update-dblock ()
  7347. "Update the dynamic block at point
  7348. This means to empty the block, parse for parameters and then call
  7349. the correct writing function."
  7350. (save-window-excursion
  7351. (let* ((pos (point))
  7352. (line (org-current-line))
  7353. (params (org-prepare-dblock))
  7354. (name (plist-get params :name))
  7355. (cmd (intern (concat "org-dblock-write:" name))))
  7356. (message "Updating dynamic block `%s' at line %d..." name line)
  7357. (funcall cmd params)
  7358. (message "Updating dynamic block `%s' at line %d...done" name line)
  7359. (goto-char pos))))
  7360. (defun org-beginning-of-dblock ()
  7361. "Find the beginning of the dynamic block at point.
  7362. Error if there is no scuh block at point."
  7363. (let ((pos (point))
  7364. beg)
  7365. (end-of-line 1)
  7366. (if (and (re-search-backward org-dblock-start-re nil t)
  7367. (setq beg (match-beginning 0))
  7368. (re-search-forward org-dblock-end-re nil t)
  7369. (> (match-end 0) pos))
  7370. (goto-char beg)
  7371. (goto-char pos)
  7372. (error "Not in a dynamic block"))))
  7373. (defun org-update-all-dblocks ()
  7374. "Update all dynamic blocks in the buffer.
  7375. This function can be used in a hook."
  7376. (when (org-mode-p)
  7377. (org-map-dblocks 'org-update-dblock)))
  7378. ;;;; Completion
  7379. (defconst org-additional-option-like-keywords
  7380. '("BEGIN_HTML" "BEGIN_LaTeX" "END_HTML" "END_LaTeX"
  7381. "ORGTBL" "HTML:" "LaTeX:" "BEGIN:" "END:" "TBLFM"
  7382. "BEGIN_EXAMPLE" "END_EXAMPLE"
  7383. "BEGIN_QUOTE" "END_QUOTE"
  7384. "BEGIN_VERSE" "END_VERSE"
  7385. "BEGIN_SRC" "END_SRC"))
  7386. (defcustom org-structure-template-alist
  7387. '(
  7388. ("s" "#+begin_src ?\n\n#+end_src"
  7389. "<src lang=\"?\">\n\n</src>")
  7390. ("e" "#+begin_example\n?\n#+end_example"
  7391. "<example>\n?\n</example>")
  7392. ("q" "#+begin_quote\n?\n#+end_quote"
  7393. "<quote>\n?\n</quote>")
  7394. ("v" "#+begin_verse\n?\n#+end_verse"
  7395. "<verse>\n?\n/verse>")
  7396. ("l" "#+begin_latex\n?\n#+end_latex"
  7397. "<literal style=\"latex\">\n?\n</literal>")
  7398. ("L" "#+latex: "
  7399. "<literal style=\"latex\">?</literal>")
  7400. ("h" "#+begin_html\n?\n#+end_html"
  7401. "<literal style=\"html\">\n?\n</literal>")
  7402. ("H" "#+html: "
  7403. "<literal style=\"html\">?</literal>")
  7404. ("a" "#+begin_ascii\n?\n#+end_ascii")
  7405. ("A" "#+ascii: ")
  7406. ("i" "#+include %file ?"
  7407. "<include file=%file markup=\"?\">")
  7408. )
  7409. "Structure completion elements.
  7410. This is a list of abbreviation keys and values. The value gets inserted
  7411. it you type @samp{.} followed by the key and then the completion key,
  7412. usually `M-TAB'. %file will be replaced by a file name after prompting
  7413. for the file uning completion.
  7414. There are two templates for each key, the first uses the original Org syntax,
  7415. the second uses Emacs Muse-like syntax tags. These Muse-like tags become
  7416. the default when the /org-mtags.el/ module has been loaded. See also the
  7417. variable `org-mtags-prefere-muse-templates'.
  7418. This is an experimental feature, it is undecided if it is going to stay in."
  7419. :group 'org-completion
  7420. :type '(repeat
  7421. (string :tag "Key")
  7422. (string :tag "Template")
  7423. (string :tag "Muse Template")))
  7424. (defun org-try-structure-completion ()
  7425. "Try to complete a structure template before point.
  7426. This looks for strings like \"<e\" on an otherwise empty line and
  7427. expands them."
  7428. (let ((l (buffer-substring (point-at-bol) (point)))
  7429. a)
  7430. (when (and (looking-at "[ \t]*$")
  7431. (string-match "^[ \t]*<\\([a-z]+\\)$"l)
  7432. (setq a (assoc (match-string 1 l) org-structure-template-alist)))
  7433. (org-complete-expand-structure-template (+ -1 (point-at-bol)
  7434. (match-beginning 1)) a)
  7435. t)))
  7436. (defun org-complete-expand-structure-template (start cell)
  7437. "Expand a structure template."
  7438. (let* ((musep (org-bound-and-true-p org-mtags-prefere-muse-templates))
  7439. (rpl (nth (if musep 2 1) cell)))
  7440. (delete-region start (point))
  7441. (when (string-match "\\`#\\+" rpl)
  7442. (cond
  7443. ((bolp))
  7444. ((not (string-match "\\S-" (buffer-substring (point-at-bol) (point))))
  7445. (delete-region (point-at-bol) (point)))
  7446. (t (newline))))
  7447. (setq start (point))
  7448. (if (string-match "%file" rpl)
  7449. (setq rpl (replace-match
  7450. (concat
  7451. "\""
  7452. (save-match-data
  7453. (abbreviate-file-name (read-file-name "Include file: ")))
  7454. "\"")
  7455. t t rpl)))
  7456. (insert rpl)
  7457. (if (re-search-backward "\\?" start t) (delete-char 1))))
  7458. (defun org-complete (&optional arg)
  7459. "Perform completion on word at point.
  7460. At the beginning of a headline, this completes TODO keywords as given in
  7461. `org-todo-keywords'.
  7462. If the current word is preceded by a backslash, completes the TeX symbols
  7463. that are supported for HTML support.
  7464. If the current word is preceded by \"#+\", completes special words for
  7465. setting file options.
  7466. In the line after \"#+STARTUP:, complete valid keywords.\"
  7467. At all other locations, this simply calls the value of
  7468. `org-completion-fallback-command'."
  7469. (interactive "P")
  7470. (org-without-partial-completion
  7471. (catch 'exit
  7472. (let* ((a nil)
  7473. (end (point))
  7474. (beg1 (save-excursion
  7475. (skip-chars-backward (org-re "[:alnum:]_@"))
  7476. (point)))
  7477. (beg (save-excursion
  7478. (skip-chars-backward "a-zA-Z0-9_:$")
  7479. (point)))
  7480. (confirm (lambda (x) (stringp (car x))))
  7481. (searchhead (equal (char-before beg) ?*))
  7482. (struct
  7483. (when (and (member (char-before beg1) '(?. ?<))
  7484. (setq a (assoc (buffer-substring beg1 (point))
  7485. org-structure-template-alist)))
  7486. (org-complete-expand-structure-template (1- beg1) a)
  7487. (throw 'exit t)))
  7488. (tag (and (equal (char-before beg1) ?:)
  7489. (equal (char-after (point-at-bol)) ?*)))
  7490. (prop (and (equal (char-before beg1) ?:)
  7491. (not (equal (char-after (point-at-bol)) ?*))))
  7492. (texp (equal (char-before beg) ?\\))
  7493. (link (equal (char-before beg) ?\[))
  7494. (opt (equal (buffer-substring (max (point-at-bol) (- beg 2))
  7495. beg)
  7496. "#+"))
  7497. (startup (string-match "^#\\+STARTUP:.*"
  7498. (buffer-substring (point-at-bol) (point))))
  7499. (completion-ignore-case opt)
  7500. (type nil)
  7501. (tbl nil)
  7502. (table (cond
  7503. (opt
  7504. (setq type :opt)
  7505. (require 'org-exp)
  7506. (append
  7507. (mapcar
  7508. (lambda (x)
  7509. (string-match "^#\\+\\(\\([A-Z_]+:?\\).*\\)" x)
  7510. (cons (match-string 2 x) (match-string 1 x)))
  7511. (org-split-string (org-get-current-options) "\n"))
  7512. (mapcar 'list org-additional-option-like-keywords)))
  7513. (startup
  7514. (setq type :startup)
  7515. org-startup-options)
  7516. (link (append org-link-abbrev-alist-local
  7517. org-link-abbrev-alist))
  7518. (texp
  7519. (setq type :tex)
  7520. org-html-entities)
  7521. ((string-match "\\`\\*+[ \t]+\\'"
  7522. (buffer-substring (point-at-bol) beg))
  7523. (setq type :todo)
  7524. (mapcar 'list org-todo-keywords-1))
  7525. (searchhead
  7526. (setq type :searchhead)
  7527. (save-excursion
  7528. (goto-char (point-min))
  7529. (while (re-search-forward org-todo-line-regexp nil t)
  7530. (push (list
  7531. (org-make-org-heading-search-string
  7532. (match-string 3) t))
  7533. tbl)))
  7534. tbl)
  7535. (tag (setq type :tag beg beg1)
  7536. (or org-tag-alist (org-get-buffer-tags)))
  7537. (prop (setq type :prop beg beg1)
  7538. (mapcar 'list (org-buffer-property-keys nil t t)))
  7539. (t (progn
  7540. (call-interactively org-completion-fallback-command)
  7541. (throw 'exit nil)))))
  7542. (pattern (buffer-substring-no-properties beg end))
  7543. (completion (try-completion pattern table confirm)))
  7544. (cond ((eq completion t)
  7545. (if (not (assoc (upcase pattern) table))
  7546. (message "Already complete")
  7547. (if (and (equal type :opt)
  7548. (not (member (car (assoc (upcase pattern) table))
  7549. org-additional-option-like-keywords)))
  7550. (insert (substring (cdr (assoc (upcase pattern) table))
  7551. (length pattern)))
  7552. (if (memq type '(:tag :prop)) (insert ":")))))
  7553. ((null completion)
  7554. (message "Can't find completion for \"%s\"" pattern)
  7555. (ding))
  7556. ((not (string= pattern completion))
  7557. (delete-region beg end)
  7558. (if (string-match " +$" completion)
  7559. (setq completion (replace-match "" t t completion)))
  7560. (insert completion)
  7561. (if (get-buffer-window "*Completions*")
  7562. (delete-window (get-buffer-window "*Completions*")))
  7563. (if (assoc completion table)
  7564. (if (eq type :todo) (insert " ")
  7565. (if (memq type '(:tag :prop)) (insert ":"))))
  7566. (if (and (equal type :opt) (assoc completion table))
  7567. (message "%s" (substitute-command-keys
  7568. "Press \\[org-complete] again to insert example settings"))))
  7569. (t
  7570. (message "Making completion list...")
  7571. (let ((list (sort (all-completions pattern table confirm)
  7572. 'string<)))
  7573. (with-output-to-temp-buffer "*Completions*"
  7574. (condition-case nil
  7575. ;; Protection needed for XEmacs and emacs 21
  7576. (display-completion-list list pattern)
  7577. (error (display-completion-list list)))))
  7578. (message "Making completion list...%s" "done")))))))
  7579. ;;;; TODO, DEADLINE, Comments
  7580. (defun org-toggle-comment ()
  7581. "Change the COMMENT state of an entry."
  7582. (interactive)
  7583. (save-excursion
  7584. (org-back-to-heading)
  7585. (let (case-fold-search)
  7586. (if (looking-at (concat outline-regexp
  7587. "\\( *\\<" org-comment-string "\\>[ \t]*\\)"))
  7588. (replace-match "" t t nil 1)
  7589. (if (looking-at outline-regexp)
  7590. (progn
  7591. (goto-char (match-end 0))
  7592. (insert org-comment-string " ")))))))
  7593. (defvar org-last-todo-state-is-todo nil
  7594. "This is non-nil when the last TODO state change led to a TODO state.
  7595. If the last change removed the TODO tag or switched to DONE, then
  7596. this is nil.")
  7597. (defvar org-setting-tags nil) ; dynamically skiped
  7598. (defun org-parse-local-options (string var)
  7599. "Parse STRING for startup setting relevant for variable VAR."
  7600. (let ((rtn (symbol-value var))
  7601. e opts)
  7602. (save-match-data
  7603. (if (or (not string) (not (string-match "\\S-" string)))
  7604. rtn
  7605. (setq opts (delq nil (mapcar (lambda (x)
  7606. (setq e (assoc x org-startup-options))
  7607. (if (eq (nth 1 e) var) e nil))
  7608. (org-split-string string "[ \t]+"))))
  7609. (if (not opts)
  7610. rtn
  7611. (setq rtn nil)
  7612. (while (setq e (pop opts))
  7613. (if (not (nth 3 e))
  7614. (setq rtn (nth 2 e))
  7615. (if (not (listp rtn)) (setq rtn nil))
  7616. (push (nth 2 e) rtn)))
  7617. rtn)))))
  7618. (defvar org-blocker-hook nil
  7619. "Hook for functions that are allowed to block a state change.
  7620. Each function gets as its single argument a property list, see
  7621. `org-trigger-hook' for more information about this list.
  7622. If any of the functions in this hook returns nil, the state change
  7623. is blocked.")
  7624. (defvar org-trigger-hook nil
  7625. "Hook for functions that are triggered by a state change.
  7626. Each function gets as its single argument a property list with at least
  7627. the following elements:
  7628. (:type type-of-change :position pos-at-entry-start
  7629. :from old-state :to new-state)
  7630. Depending on the type, more properties may be present.
  7631. This mechanism is currently implemented for:
  7632. TODO state changes
  7633. ------------------
  7634. :type todo-state-change
  7635. :from previous state (keyword as a string), or nil
  7636. :to new state (keyword as a string), or nil")
  7637. (defun org-todo (&optional arg)
  7638. "Change the TODO state of an item.
  7639. The state of an item is given by a keyword at the start of the heading,
  7640. like
  7641. *** TODO Write paper
  7642. *** DONE Call mom
  7643. The different keywords are specified in the variable `org-todo-keywords'.
  7644. By default the available states are \"TODO\" and \"DONE\".
  7645. So for this example: when the item starts with TODO, it is changed to DONE.
  7646. When it starts with DONE, the DONE is removed. And when neither TODO nor
  7647. DONE are present, add TODO at the beginning of the heading.
  7648. With C-u prefix arg, use completion to determine the new state.
  7649. With numeric prefix arg, switch to that state.
  7650. For calling through lisp, arg is also interpreted in the following way:
  7651. 'none -> empty state
  7652. \"\"(empty string) -> switch to empty state
  7653. 'done -> switch to DONE
  7654. 'nextset -> switch to the next set of keywords
  7655. 'previousset -> switch to the previous set of keywords
  7656. \"WAITING\" -> switch to the specified keyword, but only if it
  7657. really is a member of `org-todo-keywords'."
  7658. (interactive "P")
  7659. (save-excursion
  7660. (catch 'exit
  7661. (org-back-to-heading)
  7662. (if (looking-at outline-regexp) (goto-char (1- (match-end 0))))
  7663. (or (looking-at (concat " +" org-todo-regexp " *"))
  7664. (looking-at " *"))
  7665. (let* ((match-data (match-data))
  7666. (startpos (point-at-bol))
  7667. (logging (save-match-data (org-entry-get nil "LOGGING" t)))
  7668. (org-log-done org-log-done)
  7669. (org-log-repeat org-log-repeat)
  7670. (org-todo-log-states org-todo-log-states)
  7671. (this (match-string 1))
  7672. (hl-pos (match-beginning 0))
  7673. (head (org-get-todo-sequence-head this))
  7674. (ass (assoc head org-todo-kwd-alist))
  7675. (interpret (nth 1 ass))
  7676. (done-word (nth 3 ass))
  7677. (final-done-word (nth 4 ass))
  7678. (last-state (or this ""))
  7679. (completion-ignore-case t)
  7680. (member (member this org-todo-keywords-1))
  7681. (tail (cdr member))
  7682. (state (cond
  7683. ((and org-todo-key-trigger
  7684. (or (and (equal arg '(4)) (eq org-use-fast-todo-selection 'prefix))
  7685. (and (not arg) org-use-fast-todo-selection
  7686. (not (eq org-use-fast-todo-selection 'prefix)))))
  7687. ;; Use fast selection
  7688. (org-fast-todo-selection))
  7689. ((and (equal arg '(4))
  7690. (or (not org-use-fast-todo-selection)
  7691. (not org-todo-key-trigger)))
  7692. ;; Read a state with completion
  7693. (completing-read "State: " (mapcar (lambda(x) (list x))
  7694. org-todo-keywords-1)
  7695. nil t))
  7696. ((eq arg 'right)
  7697. (if this
  7698. (if tail (car tail) nil)
  7699. (car org-todo-keywords-1)))
  7700. ((eq arg 'left)
  7701. (if (equal member org-todo-keywords-1)
  7702. nil
  7703. (if this
  7704. (nth (- (length org-todo-keywords-1) (length tail) 2)
  7705. org-todo-keywords-1)
  7706. (org-last org-todo-keywords-1))))
  7707. ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
  7708. (setq arg nil))) ; hack to fall back to cycling
  7709. (arg
  7710. ;; user or caller requests a specific state
  7711. (cond
  7712. ((equal arg "") nil)
  7713. ((eq arg 'none) nil)
  7714. ((eq arg 'done) (or done-word (car org-done-keywords)))
  7715. ((eq arg 'nextset)
  7716. (or (car (cdr (member head org-todo-heads)))
  7717. (car org-todo-heads)))
  7718. ((eq arg 'previousset)
  7719. (let ((org-todo-heads (reverse org-todo-heads)))
  7720. (or (car (cdr (member head org-todo-heads)))
  7721. (car org-todo-heads))))
  7722. ((car (member arg org-todo-keywords-1)))
  7723. ((nth (1- (prefix-numeric-value arg))
  7724. org-todo-keywords-1))))
  7725. ((null member) (or head (car org-todo-keywords-1)))
  7726. ((equal this final-done-word) nil) ;; -> make empty
  7727. ((null tail) nil) ;; -> first entry
  7728. ((eq interpret 'sequence)
  7729. (car tail))
  7730. ((memq interpret '(type priority))
  7731. (if (eq this-command last-command)
  7732. (car tail)
  7733. (if (> (length tail) 0)
  7734. (or done-word (car org-done-keywords))
  7735. nil)))
  7736. (t nil)))
  7737. (next (if state (concat " " state " ") " "))
  7738. (change-plist (list :type 'todo-state-change :from this :to state
  7739. :position startpos))
  7740. dolog now-done-p)
  7741. (when org-blocker-hook
  7742. (unless (save-excursion
  7743. (save-match-data
  7744. (run-hook-with-args-until-failure
  7745. 'org-blocker-hook change-plist)))
  7746. (if (interactive-p)
  7747. (error "TODO state change from %s to %s blocked" this state)
  7748. ;; fail silently
  7749. (message "TODO state change from %s to %s blocked" this state)
  7750. (throw 'exit nil))))
  7751. (store-match-data match-data)
  7752. (replace-match next t t)
  7753. (unless (pos-visible-in-window-p hl-pos)
  7754. (message "TODO state changed to %s" (org-trim next)))
  7755. (unless head
  7756. (setq head (org-get-todo-sequence-head state)
  7757. ass (assoc head org-todo-kwd-alist)
  7758. interpret (nth 1 ass)
  7759. done-word (nth 3 ass)
  7760. final-done-word (nth 4 ass)))
  7761. (when (memq arg '(nextset previousset))
  7762. (message "Keyword-Set %d/%d: %s"
  7763. (- (length org-todo-sets) -1
  7764. (length (memq (assoc state org-todo-sets) org-todo-sets)))
  7765. (length org-todo-sets)
  7766. (mapconcat 'identity (assoc state org-todo-sets) " ")))
  7767. (setq org-last-todo-state-is-todo
  7768. (not (member state org-done-keywords)))
  7769. (setq now-done-p (and (member state org-done-keywords)
  7770. (not (member this org-done-keywords))))
  7771. (and logging (org-local-logging logging))
  7772. (when (and (or org-todo-log-states org-log-done)
  7773. (not (memq arg '(nextset previousset))))
  7774. ;; we need to look at recording a time and note
  7775. (setq dolog (or (nth 1 (assoc state org-todo-log-states))
  7776. (nth 2 (assoc this org-todo-log-states))))
  7777. (when (and state
  7778. (member state org-not-done-keywords)
  7779. (not (member this org-not-done-keywords)))
  7780. ;; This is now a todo state and was not one before
  7781. ;; If there was a CLOSED time stamp, get rid of it.
  7782. (org-add-planning-info nil nil 'closed))
  7783. (when (and now-done-p org-log-done)
  7784. ;; It is now done, and it was not done before
  7785. (org-add-planning-info 'closed (org-current-time))
  7786. (if (and (not dolog) (eq 'note org-log-done))
  7787. (org-add-log-setup 'done state 'findpos 'note)))
  7788. (when (and state dolog)
  7789. ;; This is a non-nil state, and we need to log it
  7790. (org-add-log-setup 'state state 'findpos dolog)))
  7791. ;; Fixup tag positioning
  7792. (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
  7793. (when org-provide-todo-statistics
  7794. (org-update-parent-todo-statistics))
  7795. (run-hooks 'org-after-todo-state-change-hook)
  7796. (if (and arg (not (member state org-done-keywords)))
  7797. (setq head (org-get-todo-sequence-head state)))
  7798. (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
  7799. ;; Do we need to trigger a repeat?
  7800. (when now-done-p (org-auto-repeat-maybe state))
  7801. ;; Fixup cursor location if close to the keyword
  7802. (if (and (outline-on-heading-p)
  7803. (not (bolp))
  7804. (save-excursion (beginning-of-line 1)
  7805. (looking-at org-todo-line-regexp))
  7806. (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
  7807. (progn
  7808. (goto-char (or (match-end 2) (match-end 1)))
  7809. (just-one-space)))
  7810. (when org-trigger-hook
  7811. (save-excursion
  7812. (run-hook-with-args 'org-trigger-hook change-plist)))))))
  7813. (defun org-update-parent-todo-statistics ()
  7814. "Update any statistics cookie in the parent of the current headline."
  7815. (interactive)
  7816. (let ((box-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
  7817. level (cnt-all 0) (cnt-done 0) is-percent kwd)
  7818. (catch 'exit
  7819. (save-excursion
  7820. (setq level (org-up-heading-safe))
  7821. (unless (and level
  7822. (re-search-forward box-re (point-at-eol) t))
  7823. (throw 'exit nil))
  7824. (setq is-percent (match-end 2))
  7825. (save-match-data
  7826. (unless (outline-next-heading) (throw 'exit nil))
  7827. (while (looking-at org-todo-line-regexp)
  7828. (setq kwd (match-string 2))
  7829. (and kwd (setq cnt-all (1+ cnt-all)))
  7830. (and (member kwd org-done-keywords)
  7831. (setq cnt-done (1+ cnt-done)))
  7832. (condition-case nil
  7833. (outline-forward-same-level 1)
  7834. (error (end-of-line 1)))))
  7835. (replace-match
  7836. (if is-percent
  7837. (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
  7838. (format "[%d/%d]" cnt-done cnt-all)))
  7839. (run-hook-with-args 'org-after-todo-statistics-hook
  7840. cnt-done (- cnt-all cnt-done))))))
  7841. (defvar org-after-todo-statistics-hook nil
  7842. "Hook that is called after a TODO statistics cookie has been updated.
  7843. Each function is called with two arguments: the number of not-done entries
  7844. and the number of done entries.
  7845. For example, the following function, when added to this hook, will switch
  7846. an entry to DONE when all children are done, and back to TODO when new
  7847. entries are set to a TODO status. Note that this hook is only called
  7848. when there is a statistics cookie in the headline!
  7849. (defun org-summary-todo (n-done n-not-done)
  7850. \"Switch entry to DONE when all subentries are done, to TODO otherwise.\"
  7851. (let (org-log-done org-log-states) ; turn off logging
  7852. (org-todo (if (= n-not-done 0) \"DONE\" \"TODO\"))))
  7853. ")
  7854. (defun org-local-logging (value)
  7855. "Get logging settings from a property VALUE."
  7856. (let* (words w a)
  7857. ;; directly set the variables, they are already local.
  7858. (setq org-log-done nil
  7859. org-log-repeat nil
  7860. org-todo-log-states nil)
  7861. (setq words (org-split-string value))
  7862. (while (setq w (pop words))
  7863. (cond
  7864. ((setq a (assoc w org-startup-options))
  7865. (and (member (nth 1 a) '(org-log-done org-log-repeat))
  7866. (set (nth 1 a) (nth 2 a))))
  7867. ((setq a (org-extract-log-state-settings w))
  7868. (and (member (car a) org-todo-keywords-1)
  7869. (push a org-todo-log-states)))))))
  7870. (defun org-get-todo-sequence-head (kwd)
  7871. "Return the head of the TODO sequence to which KWD belongs.
  7872. If KWD is not set, check if there is a text property remembering the
  7873. right sequence."
  7874. (let (p)
  7875. (cond
  7876. ((not kwd)
  7877. (or (get-text-property (point-at-bol) 'org-todo-head)
  7878. (progn
  7879. (setq p (next-single-property-change (point-at-bol) 'org-todo-head
  7880. nil (point-at-eol)))
  7881. (get-text-property p 'org-todo-head))))
  7882. ((not (member kwd org-todo-keywords-1))
  7883. (car org-todo-keywords-1))
  7884. (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
  7885. (defun org-fast-todo-selection ()
  7886. "Fast TODO keyword selection with single keys.
  7887. Returns the new TODO keyword, or nil if no state change should occur."
  7888. (let* ((fulltable org-todo-key-alist)
  7889. (done-keywords org-done-keywords) ;; needed for the faces.
  7890. (maxlen (apply 'max (mapcar
  7891. (lambda (x)
  7892. (if (stringp (car x)) (string-width (car x)) 0))
  7893. fulltable)))
  7894. (expert nil)
  7895. (fwidth (+ maxlen 3 1 3))
  7896. (ncol (/ (- (window-width) 4) fwidth))
  7897. tg cnt e c tbl
  7898. groups ingroup)
  7899. (save-window-excursion
  7900. (if expert
  7901. (set-buffer (get-buffer-create " *Org todo*"))
  7902. (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
  7903. (erase-buffer)
  7904. (org-set-local 'org-done-keywords done-keywords)
  7905. (setq tbl fulltable cnt 0)
  7906. (while (setq e (pop tbl))
  7907. (cond
  7908. ((equal e '(:startgroup))
  7909. (push '() groups) (setq ingroup t)
  7910. (when (not (= cnt 0))
  7911. (setq cnt 0)
  7912. (insert "\n"))
  7913. (insert "{ "))
  7914. ((equal e '(:endgroup))
  7915. (setq ingroup nil cnt 0)
  7916. (insert "}\n"))
  7917. (t
  7918. (setq tg (car e) c (cdr e))
  7919. (if ingroup (push tg (car groups)))
  7920. (setq tg (org-add-props tg nil 'face
  7921. (org-get-todo-face tg)))
  7922. (if (and (= cnt 0) (not ingroup)) (insert " "))
  7923. (insert "[" c "] " tg (make-string
  7924. (- fwidth 4 (length tg)) ?\ ))
  7925. (when (= (setq cnt (1+ cnt)) ncol)
  7926. (insert "\n")
  7927. (if ingroup (insert " "))
  7928. (setq cnt 0)))))
  7929. (insert "\n")
  7930. (goto-char (point-min))
  7931. (if (and (not expert) (fboundp 'fit-window-to-buffer))
  7932. (fit-window-to-buffer))
  7933. (message "[a-z..]:Set [SPC]:clear")
  7934. (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
  7935. (cond
  7936. ((or (= c ?\C-g)
  7937. (and (= c ?q) (not (rassoc c fulltable))))
  7938. (setq quit-flag t))
  7939. ((= c ?\ ) nil)
  7940. ((setq e (rassoc c fulltable) tg (car e))
  7941. tg)
  7942. (t (setq quit-flag t))))))
  7943. (defun org-entry-is-todo-p ()
  7944. (member (org-get-todo-state) org-not-done-keywords))
  7945. (defun org-entry-is-done-p ()
  7946. (member (org-get-todo-state) org-done-keywords))
  7947. (defun org-get-todo-state ()
  7948. (save-excursion
  7949. (org-back-to-heading t)
  7950. (and (looking-at org-todo-line-regexp)
  7951. (match-end 2)
  7952. (match-string 2))))
  7953. (defun org-at-date-range-p (&optional inactive-ok)
  7954. "Is the cursor inside a date range?"
  7955. (interactive)
  7956. (save-excursion
  7957. (catch 'exit
  7958. (let ((pos (point)))
  7959. (skip-chars-backward "^[<\r\n")
  7960. (skip-chars-backward "<[")
  7961. (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
  7962. (>= (match-end 0) pos)
  7963. (throw 'exit t))
  7964. (skip-chars-backward "^<[\r\n")
  7965. (skip-chars-backward "<[")
  7966. (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
  7967. (>= (match-end 0) pos)
  7968. (throw 'exit t)))
  7969. nil)))
  7970. (defun org-get-repeat ()
  7971. "Check if there is a deadline/schedule with repeater in this entry."
  7972. (save-match-data
  7973. (save-excursion
  7974. (org-back-to-heading t)
  7975. (if (re-search-forward
  7976. org-repeat-re (save-excursion (outline-next-heading) (point)) t)
  7977. (match-string 1)))))
  7978. (defvar org-last-changed-timestamp)
  7979. (defvar org-last-inserted-timestamp)
  7980. (defvar org-log-post-message)
  7981. (defvar org-log-note-purpose)
  7982. (defvar org-log-note-how)
  7983. (defvar org-log-note-extra)
  7984. (defun org-auto-repeat-maybe (done-word)
  7985. "Check if the current headline contains a repeated deadline/schedule.
  7986. If yes, set TODO state back to what it was and change the base date
  7987. of repeating deadline/scheduled time stamps to new date.
  7988. This function is run automatically after each state change to a DONE state."
  7989. ;; last-state is dynamically scoped into this function
  7990. (let* ((repeat (org-get-repeat))
  7991. (aa (assoc last-state org-todo-kwd-alist))
  7992. (interpret (nth 1 aa))
  7993. (head (nth 2 aa))
  7994. (whata '(("d" . day) ("m" . month) ("y" . year)))
  7995. (msg "Entry repeats: ")
  7996. (org-log-done nil)
  7997. (org-todo-log-states nil)
  7998. (nshiftmax 10) (nshift 0)
  7999. re type n what ts mb0 time)
  8000. (when repeat
  8001. (if (eq org-log-repeat t) (setq org-log-repeat 'state))
  8002. (org-todo (if (eq interpret 'type) last-state head))
  8003. (when org-log-repeat
  8004. (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
  8005. (memq 'org-add-log-note post-command-hook))
  8006. ;; OK, we are already setup for some record
  8007. (if (eq org-log-repeat 'note)
  8008. ;; make sure we take a note, not only a time stamp
  8009. (setq org-log-note-how 'note))
  8010. ;; Set up for taking a record
  8011. (org-add-log-setup 'state (or done-word (car org-done-keywords))
  8012. 'findpos org-log-repeat)))
  8013. (org-back-to-heading t)
  8014. (org-add-planning-info nil nil 'closed)
  8015. (setq re (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
  8016. org-deadline-time-regexp "\\)\\|\\("
  8017. org-ts-regexp "\\)"))
  8018. (while (re-search-forward
  8019. re (save-excursion (outline-next-heading) (point)) t)
  8020. (setq type (if (match-end 1) org-scheduled-string
  8021. (if (match-end 3) org-deadline-string "Plain:"))
  8022. ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0)))
  8023. mb0 (match-beginning 0))
  8024. (when (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([dwmy]\\)" ts)
  8025. (setq n (string-to-number (match-string 2 ts))
  8026. what (match-string 3 ts))
  8027. (if (equal what "w") (setq n (* n 7) what "d"))
  8028. ;; Preparation, see if we need to modify the start date for the change
  8029. (when (match-end 1)
  8030. (setq time (save-match-data (org-time-string-to-time ts)))
  8031. (cond
  8032. ((equal (match-string 1 ts) ".")
  8033. ;; Shift starting date to today
  8034. (org-timestamp-change
  8035. (- (time-to-days (current-time)) (time-to-days time))
  8036. 'day))
  8037. ((equal (match-string 1 ts) "+")
  8038. (while (or (= nshift 0)
  8039. (<= (time-to-days time) (time-to-days (current-time))))
  8040. (when (= (incf nshift) nshiftmax)
  8041. (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
  8042. (error "Abort")))
  8043. (org-timestamp-change n (cdr (assoc what whata)))
  8044. (org-at-timestamp-p t)
  8045. (setq ts (match-string 1))
  8046. (setq time (save-match-data (org-time-string-to-time ts))))
  8047. (org-timestamp-change (- n) (cdr (assoc what whata)))
  8048. ;; rematch, so that we have everything in place for the real shift
  8049. (org-at-timestamp-p t)
  8050. (setq ts (match-string 1))
  8051. (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([dwmy]\\)" ts))))
  8052. (org-timestamp-change n (cdr (assoc what whata)))
  8053. (setq msg (concat msg type org-last-changed-timestamp " "))))
  8054. (setq org-log-post-message msg)
  8055. (message "%s" msg))))
  8056. (defun org-show-todo-tree (arg)
  8057. "Make a compact tree which shows all headlines marked with TODO.
  8058. The tree will show the lines where the regexp matches, and all higher
  8059. headlines above the match.
  8060. With a \\[universal-argument] prefix, also show the DONE entries.
  8061. With a numeric prefix N, construct a sparse tree for the Nth element
  8062. of `org-todo-keywords-1'."
  8063. (interactive "P")
  8064. (let ((case-fold-search nil)
  8065. (kwd-re
  8066. (cond ((null arg) org-not-done-regexp)
  8067. ((equal arg '(4))
  8068. (let ((kwd (completing-read "Keyword (or KWD1|KWD2|...): "
  8069. (mapcar 'list org-todo-keywords-1))))
  8070. (concat "\\("
  8071. (mapconcat 'identity (org-split-string kwd "|") "\\|")
  8072. "\\)\\>")))
  8073. ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
  8074. (regexp-quote (nth (1- (prefix-numeric-value arg))
  8075. org-todo-keywords-1)))
  8076. (t (error "Invalid prefix argument: %s" arg)))))
  8077. (message "%d TODO entries found"
  8078. (org-occur (concat "^" outline-regexp " *" kwd-re )))))
  8079. (defun org-deadline (&optional remove time)
  8080. "Insert the \"DEADLINE:\" string with a timestamp to make a deadline.
  8081. With argument REMOVE, remove any deadline from the item.
  8082. When TIME is set, it should be an internal time specification, and the
  8083. scheduling will use the corresponding date."
  8084. (interactive "P")
  8085. (if remove
  8086. (progn
  8087. (org-remove-timestamp-with-keyword org-deadline-string)
  8088. (message "Item no longer has a deadline."))
  8089. (if (org-get-repeat)
  8090. (error "Cannot change deadline on task with repeater, please do that by hand")
  8091. (org-add-planning-info 'deadline time 'closed)
  8092. (message "Deadline on %s" org-last-inserted-timestamp))))
  8093. (defun org-schedule (&optional remove time)
  8094. "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
  8095. With argument REMOVE, remove any scheduling date from the item.
  8096. When TIME is set, it should be an internal time specification, and the
  8097. scheduling will use the corresponding date."
  8098. (interactive "P")
  8099. (if remove
  8100. (progn
  8101. (org-remove-timestamp-with-keyword org-scheduled-string)
  8102. (message "Item is no longer scheduled."))
  8103. (if (org-get-repeat)
  8104. (error "Cannot reschedule task with repeater, please do that by hand")
  8105. (org-add-planning-info 'scheduled time 'closed)
  8106. (message "Scheduled to %s" org-last-inserted-timestamp))))
  8107. (defun org-remove-timestamp-with-keyword (keyword)
  8108. "Remove all time stamps with KEYWORD in the current entry."
  8109. (let ((re (concat "\\<" (regexp-quote keyword) " +<[^>\n]+>[ \t]*"))
  8110. beg)
  8111. (save-excursion
  8112. (org-back-to-heading t)
  8113. (setq beg (point))
  8114. (org-end-of-subtree t t)
  8115. (while (re-search-backward re beg t)
  8116. (replace-match "")
  8117. (if (and (string-match "\\S-" (buffer-substring (point-at-bol) (point)))
  8118. (equal (char-before) ?\ ))
  8119. (backward-delete-char 1)
  8120. (if (string-match "^[ \t]*$" (buffer-substring
  8121. (point-at-bol) (point-at-eol)))
  8122. (delete-region (point-at-bol)
  8123. (min (point-max) (1+ (point-at-eol))))))))))
  8124. (defun org-add-planning-info (what &optional time &rest remove)
  8125. "Insert new timestamp with keyword in the line directly after the headline.
  8126. WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
  8127. If non is given, the user is prompted for a date.
  8128. REMOVE indicates what kind of entries to remove. An old WHAT entry will also
  8129. be removed."
  8130. (interactive)
  8131. (let (org-time-was-given org-end-time-was-given ts
  8132. end default-time default-input)
  8133. (when (and (not time) (memq what '(scheduled deadline)))
  8134. ;; Try to get a default date/time from existing timestamp
  8135. (save-excursion
  8136. (org-back-to-heading t)
  8137. (setq end (save-excursion (outline-next-heading) (point)))
  8138. (when (re-search-forward (if (eq what 'scheduled)
  8139. org-scheduled-time-regexp
  8140. org-deadline-time-regexp)
  8141. end t)
  8142. (setq ts (match-string 1)
  8143. default-time
  8144. (apply 'encode-time (org-parse-time-string ts))
  8145. default-input (and ts (org-get-compact-tod ts))))))
  8146. (when what
  8147. ;; If necessary, get the time from the user
  8148. (setq time (or time (org-read-date nil 'to-time nil nil
  8149. default-time default-input))))
  8150. (when (and org-insert-labeled-timestamps-at-point
  8151. (member what '(scheduled deadline)))
  8152. (insert
  8153. (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
  8154. (org-insert-time-stamp time org-time-was-given
  8155. nil nil nil (list org-end-time-was-given))
  8156. (setq what nil))
  8157. (save-excursion
  8158. (save-restriction
  8159. (let (col list elt ts buffer-invisibility-spec)
  8160. (org-back-to-heading t)
  8161. (looking-at (concat outline-regexp "\\( *\\)[^\r\n]*"))
  8162. (goto-char (match-end 1))
  8163. (setq col (current-column))
  8164. (goto-char (match-end 0))
  8165. (if (eobp) (insert "\n") (forward-char 1))
  8166. (if (and (not (looking-at outline-regexp))
  8167. (looking-at (concat "[^\r\n]*?" org-keyword-time-regexp
  8168. "[^\r\n]*"))
  8169. (not (equal (match-string 1) org-clock-string)))
  8170. (narrow-to-region (match-beginning 0) (match-end 0))
  8171. (insert-before-markers "\n")
  8172. (backward-char 1)
  8173. (narrow-to-region (point) (point))
  8174. (and org-adapt-indentation (org-indent-to-column col)))
  8175. ;; Check if we have to remove something.
  8176. (setq list (cons what remove))
  8177. (while list
  8178. (setq elt (pop list))
  8179. (goto-char (point-min))
  8180. (when (or (and (eq elt 'scheduled)
  8181. (re-search-forward org-scheduled-time-regexp nil t))
  8182. (and (eq elt 'deadline)
  8183. (re-search-forward org-deadline-time-regexp nil t))
  8184. (and (eq elt 'closed)
  8185. (re-search-forward org-closed-time-regexp nil t)))
  8186. (replace-match "")
  8187. (if (looking-at "--+<[^>]+>") (replace-match ""))
  8188. (if (looking-at " +") (replace-match ""))))
  8189. (goto-char (point-max))
  8190. (when what
  8191. (insert
  8192. (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
  8193. (cond ((eq what 'scheduled) org-scheduled-string)
  8194. ((eq what 'deadline) org-deadline-string)
  8195. ((eq what 'closed) org-closed-string))
  8196. " ")
  8197. (setq ts (org-insert-time-stamp
  8198. time
  8199. (or org-time-was-given
  8200. (and (eq what 'closed) org-log-done-with-time))
  8201. (eq what 'closed)
  8202. nil nil (list org-end-time-was-given)))
  8203. (end-of-line 1))
  8204. (goto-char (point-min))
  8205. (widen)
  8206. (if (and (looking-at "[ \t]+\n")
  8207. (equal (char-before) ?\n))
  8208. (delete-region (1- (point)) (point-at-eol)))
  8209. ts)))))
  8210. (defvar org-log-note-marker (make-marker))
  8211. (defvar org-log-note-purpose nil)
  8212. (defvar org-log-note-state nil)
  8213. (defvar org-log-note-how nil)
  8214. (defvar org-log-note-extra nil)
  8215. (defvar org-log-note-window-configuration nil)
  8216. (defvar org-log-note-return-to (make-marker))
  8217. (defvar org-log-post-message nil
  8218. "Message to be displayed after a log note has been stored.
  8219. The auto-repeater uses this.")
  8220. (defun org-add-note ()
  8221. "Add a note to the current entry.
  8222. This is done in the same way as adding a state change note."
  8223. (interactive)
  8224. (org-add-log-setup 'note nil t nil))
  8225. (defun org-add-log-setup (&optional purpose state findpos how &optional extra)
  8226. "Set up the post command hook to take a note.
  8227. If this is about to TODO state change, the new state is expected in STATE.
  8228. When FINDPOS is non-nil, find the correct position for the note in
  8229. the current entry. If not, assume that it can be inserted at point.
  8230. HOW is an indicator what kind of note should be created.
  8231. EXTRA is additional text that will be inserted into the notes buffer."
  8232. (save-excursion
  8233. (when findpos
  8234. (org-back-to-heading t)
  8235. (looking-at (concat outline-regexp "\\( *\\)[^\r\n]*"
  8236. "\\(\n[^\r\n]*?" org-keyword-time-not-clock-regexp
  8237. "[^\r\n]*\\)?"))
  8238. (goto-char (match-end 0))
  8239. (unless org-log-states-order-reversed
  8240. (and (= (char-after) ?\n) (forward-char 1))
  8241. (org-skip-over-state-notes)
  8242. (skip-chars-backward " \t\n\r")))
  8243. (move-marker org-log-note-marker (point))
  8244. (setq org-log-note-purpose purpose
  8245. org-log-note-state state
  8246. org-log-note-how how
  8247. org-log-note-extra extra)
  8248. (add-hook 'post-command-hook 'org-add-log-note 'append)))
  8249. (defun org-skip-over-state-notes ()
  8250. "Skip past the list of State notes in an entry."
  8251. (if (looking-at "\n[ \t]*- State") (forward-char 1))
  8252. (while (looking-at "[ \t]*- State")
  8253. (condition-case nil
  8254. (org-next-item)
  8255. (error (org-end-of-item)))))
  8256. (defun org-add-log-note (&optional purpose)
  8257. "Pop up a window for taking a note, and add this note later at point."
  8258. (remove-hook 'post-command-hook 'org-add-log-note)
  8259. (setq org-log-note-window-configuration (current-window-configuration))
  8260. (delete-other-windows)
  8261. (move-marker org-log-note-return-to (point))
  8262. (switch-to-buffer (marker-buffer org-log-note-marker))
  8263. (goto-char org-log-note-marker)
  8264. (org-switch-to-buffer-other-window "*Org Note*")
  8265. (erase-buffer)
  8266. (if (memq org-log-note-how '(time state))
  8267. (org-store-log-note)
  8268. (let ((org-inhibit-startup t)) (org-mode))
  8269. (insert (format "# Insert note for %s.
  8270. # Finish with C-c C-c, or cancel with C-c C-k.\n\n"
  8271. (cond
  8272. ((eq org-log-note-purpose 'clock-out) "stopped clock")
  8273. ((eq org-log-note-purpose 'done) "closed todo item")
  8274. ((eq org-log-note-purpose 'state)
  8275. (format "state change to \"%s\"" org-log-note-state))
  8276. ((eq org-log-note-purpose 'note)
  8277. "this entry")
  8278. (t (error "This should not happen")))))
  8279. (if org-log-note-extra (insert org-log-note-extra))
  8280. (org-set-local 'org-finish-function 'org-store-log-note)))
  8281. (defvar org-note-abort nil) ; dynamically scoped
  8282. (defun org-store-log-note ()
  8283. "Finish taking a log note, and insert it to where it belongs."
  8284. (let ((txt (buffer-string))
  8285. (note (cdr (assq org-log-note-purpose org-log-note-headings)))
  8286. lines ind)
  8287. (kill-buffer (current-buffer))
  8288. (while (string-match "\\`#.*\n[ \t\n]*" txt)
  8289. (setq txt (replace-match "" t t txt)))
  8290. (if (string-match "\\s-+\\'" txt)
  8291. (setq txt (replace-match "" t t txt)))
  8292. (setq lines (org-split-string txt "\n"))
  8293. (when (and note (string-match "\\S-" note))
  8294. (setq note
  8295. (org-replace-escapes
  8296. note
  8297. (list (cons "%u" (user-login-name))
  8298. (cons "%U" user-full-name)
  8299. (cons "%t" (format-time-string
  8300. (org-time-stamp-format 'long 'inactive)
  8301. (current-time)))
  8302. (cons "%s" (if org-log-note-state
  8303. (concat "\"" org-log-note-state "\"")
  8304. "")))))
  8305. (if lines (setq note (concat note " \\\\")))
  8306. (push note lines))
  8307. (when (or current-prefix-arg org-note-abort) (setq lines nil))
  8308. (when lines
  8309. (save-excursion
  8310. (set-buffer (marker-buffer org-log-note-marker))
  8311. (save-excursion
  8312. (goto-char org-log-note-marker)
  8313. (move-marker org-log-note-marker nil)
  8314. (end-of-line 1)
  8315. (if (not (bolp)) (let ((inhibit-read-only t)) (insert "\n")))
  8316. (indent-relative nil)
  8317. (insert "- " (pop lines))
  8318. (org-indent-line-function)
  8319. (beginning-of-line 1)
  8320. (looking-at "[ \t]*")
  8321. (setq ind (concat (match-string 0) " "))
  8322. (end-of-line 1)
  8323. (while lines (insert "\n" ind (pop lines)))))))
  8324. (set-window-configuration org-log-note-window-configuration)
  8325. (with-current-buffer (marker-buffer org-log-note-return-to)
  8326. (goto-char org-log-note-return-to))
  8327. (move-marker org-log-note-return-to nil)
  8328. (and org-log-post-message (message "%s" org-log-post-message)))
  8329. (defun org-sparse-tree (&optional arg)
  8330. "Create a sparse tree, prompt for the details.
  8331. This command can create sparse trees. You first need to select the type
  8332. of match used to create the tree:
  8333. t Show entries with a specific TODO keyword.
  8334. T Show entries selected by a tags match.
  8335. p Enter a property name and its value (both with completion on existing
  8336. names/values) and show entries with that property.
  8337. r Show entries matching a regular expression
  8338. d Show deadlines due within `org-deadline-warning-days'."
  8339. (interactive "P")
  8340. (let (ans kwd value)
  8341. (message "Sparse tree: [/]regexp [t]odo-kwd [T]ag [p]roperty [d]eadlines [b]efore-date")
  8342. (setq ans (read-char-exclusive))
  8343. (cond
  8344. ((equal ans ?d)
  8345. (call-interactively 'org-check-deadlines))
  8346. ((equal ans ?b)
  8347. (call-interactively 'org-check-before-date))
  8348. ((equal ans ?t)
  8349. (org-show-todo-tree '(4)))
  8350. ((equal ans ?T)
  8351. (call-interactively 'org-tags-sparse-tree))
  8352. ((member ans '(?p ?P))
  8353. (setq kwd (completing-read "Property: "
  8354. (mapcar 'list (org-buffer-property-keys))))
  8355. (setq value (completing-read "Value: "
  8356. (mapcar 'list (org-property-values kwd))))
  8357. (unless (string-match "\\`{.*}\\'" value)
  8358. (setq value (concat "\"" value "\"")))
  8359. (org-tags-sparse-tree arg (concat kwd "=" value)))
  8360. ((member ans '(?r ?R ?/))
  8361. (call-interactively 'org-occur))
  8362. (t (error "No such sparse tree command \"%c\"" ans)))))
  8363. (defvar org-occur-highlights nil
  8364. "List of overlays used for occur matches.")
  8365. (make-variable-buffer-local 'org-occur-highlights)
  8366. (defvar org-occur-parameters nil
  8367. "Parameters of the active org-occur calls.
  8368. This is a list, each call to org-occur pushes as cons cell,
  8369. containing the regular expression and the callback, onto the list.
  8370. The list can contain several entries if `org-occur' has been called
  8371. several time with the KEEP-PREVIOUS argument. Otherwise, this list
  8372. will only contain one set of parameters. When the highlights are
  8373. removed (for example with `C-c C-c', or with the next edit (depending
  8374. on `org-remove-highlights-with-change'), this variable is emptied
  8375. as well.")
  8376. (make-variable-buffer-local 'org-occur-parameters)
  8377. (defun org-occur (regexp &optional keep-previous callback)
  8378. "Make a compact tree which shows all matches of REGEXP.
  8379. The tree will show the lines where the regexp matches, and all higher
  8380. headlines above the match. It will also show the heading after the match,
  8381. to make sure editing the matching entry is easy.
  8382. If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
  8383. call to `org-occur' will be kept, to allow stacking of calls to this
  8384. command.
  8385. If CALLBACK is non-nil, it is a function which is called to confirm
  8386. that the match should indeed be shown."
  8387. (interactive "sRegexp: \nP")
  8388. (unless keep-previous
  8389. (org-remove-occur-highlights nil nil t))
  8390. (push (cons regexp callback) org-occur-parameters)
  8391. (let ((cnt 0))
  8392. (save-excursion
  8393. (goto-char (point-min))
  8394. (if (or (not keep-previous) ; do not want to keep
  8395. (not org-occur-highlights)) ; no previous matches
  8396. ;; hide everything
  8397. (org-overview))
  8398. (while (re-search-forward regexp nil t)
  8399. (when (or (not callback)
  8400. (save-match-data (funcall callback)))
  8401. (setq cnt (1+ cnt))
  8402. (when org-highlight-sparse-tree-matches
  8403. (org-highlight-new-match (match-beginning 0) (match-end 0)))
  8404. (org-show-context 'occur-tree))))
  8405. (when org-remove-highlights-with-change
  8406. (org-add-hook 'before-change-functions 'org-remove-occur-highlights
  8407. nil 'local))
  8408. (unless org-sparse-tree-open-archived-trees
  8409. (org-hide-archived-subtrees (point-min) (point-max)))
  8410. (run-hooks 'org-occur-hook)
  8411. (if (interactive-p)
  8412. (message "%d match(es) for regexp %s" cnt regexp))
  8413. cnt))
  8414. (defun org-show-context (&optional key)
  8415. "Make sure point and context and visible.
  8416. How much context is shown depends upon the variables
  8417. `org-show-hierarchy-above', `org-show-following-heading'. and
  8418. `org-show-siblings'."
  8419. (let ((heading-p (org-on-heading-p t))
  8420. (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
  8421. (following-p (org-get-alist-option org-show-following-heading key))
  8422. (entry-p (org-get-alist-option org-show-entry-below key))
  8423. (siblings-p (org-get-alist-option org-show-siblings key)))
  8424. (catch 'exit
  8425. ;; Show heading or entry text
  8426. (if (and heading-p (not entry-p))
  8427. (org-flag-heading nil) ; only show the heading
  8428. (and (or entry-p (org-invisible-p) (org-invisible-p2))
  8429. (org-show-hidden-entry))) ; show entire entry
  8430. (when following-p
  8431. ;; Show next sibling, or heading below text
  8432. (save-excursion
  8433. (and (if heading-p (org-goto-sibling) (outline-next-heading))
  8434. (org-flag-heading nil))))
  8435. (when siblings-p (org-show-siblings))
  8436. (when hierarchy-p
  8437. ;; show all higher headings, possibly with siblings
  8438. (save-excursion
  8439. (while (and (condition-case nil
  8440. (progn (org-up-heading-all 1) t)
  8441. (error nil))
  8442. (not (bobp)))
  8443. (org-flag-heading nil)
  8444. (when siblings-p (org-show-siblings))))))))
  8445. (defun org-reveal (&optional siblings)
  8446. "Show current entry, hierarchy above it, and the following headline.
  8447. This can be used to show a consistent set of context around locations
  8448. exposed with `org-show-hierarchy-above' or `org-show-following-heading'
  8449. not t for the search context.
  8450. With optional argument SIBLINGS, on each level of the hierarchy all
  8451. siblings are shown. This repairs the tree structure to what it would
  8452. look like when opened with hierarchical calls to `org-cycle'."
  8453. (interactive "P")
  8454. (let ((org-show-hierarchy-above t)
  8455. (org-show-following-heading t)
  8456. (org-show-siblings (if siblings t org-show-siblings)))
  8457. (org-show-context nil)))
  8458. (defun org-highlight-new-match (beg end)
  8459. "Highlight from BEG to END and mark the highlight is an occur headline."
  8460. (let ((ov (org-make-overlay beg end)))
  8461. (org-overlay-put ov 'face 'secondary-selection)
  8462. (push ov org-occur-highlights)))
  8463. (defun org-remove-occur-highlights (&optional beg end noremove)
  8464. "Remove the occur highlights from the buffer.
  8465. BEG and END are ignored. If NOREMOVE is nil, remove this function
  8466. from the `before-change-functions' in the current buffer."
  8467. (interactive)
  8468. (unless org-inhibit-highlight-removal
  8469. (mapc 'org-delete-overlay org-occur-highlights)
  8470. (setq org-occur-highlights nil)
  8471. (setq org-occur-parameters nil)
  8472. (unless noremove
  8473. (remove-hook 'before-change-functions
  8474. 'org-remove-occur-highlights 'local))))
  8475. ;;;; Priorities
  8476. (defvar org-priority-regexp ".*?\\(\\[#\\([A-Z0-9]\\)\\] ?\\)"
  8477. "Regular expression matching the priority indicator.")
  8478. (defvar org-remove-priority-next-time nil)
  8479. (defun org-priority-up ()
  8480. "Increase the priority of the current item."
  8481. (interactive)
  8482. (org-priority 'up))
  8483. (defun org-priority-down ()
  8484. "Decrease the priority of the current item."
  8485. (interactive)
  8486. (org-priority 'down))
  8487. (defun org-priority (&optional action)
  8488. "Change the priority of an item by ARG.
  8489. ACTION can be `set', `up', `down', or a character."
  8490. (interactive)
  8491. (setq action (or action 'set))
  8492. (let (current new news have remove)
  8493. (save-excursion
  8494. (org-back-to-heading)
  8495. (if (looking-at org-priority-regexp)
  8496. (setq current (string-to-char (match-string 2))
  8497. have t)
  8498. (setq current org-default-priority))
  8499. (cond
  8500. ((or (eq action 'set)
  8501. (if (featurep 'xemacs) (characterp action) (integerp action)))
  8502. (if (not (eq action 'set))
  8503. (setq new action)
  8504. (message "Priority %c-%c, SPC to remove: "
  8505. org-highest-priority org-lowest-priority)
  8506. (setq new (read-char-exclusive)))
  8507. (if (and (= (upcase org-highest-priority) org-highest-priority)
  8508. (= (upcase org-lowest-priority) org-lowest-priority))
  8509. (setq new (upcase new)))
  8510. (cond ((equal new ?\ ) (setq remove t))
  8511. ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
  8512. (error "Priority must be between `%c' and `%c'"
  8513. org-highest-priority org-lowest-priority))))
  8514. ((eq action 'up)
  8515. (if (and (not have) (eq last-command this-command))
  8516. (setq new org-lowest-priority)
  8517. (setq new (if (and org-priority-start-cycle-with-default (not have))
  8518. org-default-priority (1- current)))))
  8519. ((eq action 'down)
  8520. (if (and (not have) (eq last-command this-command))
  8521. (setq new org-highest-priority)
  8522. (setq new (if (and org-priority-start-cycle-with-default (not have))
  8523. org-default-priority (1+ current)))))
  8524. (t (error "Invalid action")))
  8525. (if (or (< (upcase new) org-highest-priority)
  8526. (> (upcase new) org-lowest-priority))
  8527. (setq remove t))
  8528. (setq news (format "%c" new))
  8529. (if have
  8530. (if remove
  8531. (replace-match "" t t nil 1)
  8532. (replace-match news t t nil 2))
  8533. (if remove
  8534. (error "No priority cookie found in line")
  8535. (looking-at org-todo-line-regexp)
  8536. (if (match-end 2)
  8537. (progn
  8538. (goto-char (match-end 2))
  8539. (insert " [#" news "]"))
  8540. (goto-char (match-beginning 3))
  8541. (insert "[#" news "] ")))))
  8542. (org-preserve-lc (org-set-tags nil 'align))
  8543. (if remove
  8544. (message "Priority removed")
  8545. (message "Priority of current item set to %s" news))))
  8546. (defun org-get-priority (s)
  8547. "Find priority cookie and return priority."
  8548. (save-match-data
  8549. (if (not (string-match org-priority-regexp s))
  8550. (* 1000 (- org-lowest-priority org-default-priority))
  8551. (* 1000 (- org-lowest-priority
  8552. (string-to-char (match-string 2 s)))))))
  8553. ;;;; Tags
  8554. (defvar org-agenda-archives-mode)
  8555. (defun org-scan-tags (action matcher &optional todo-only)
  8556. "Scan headline tags with inheritance and produce output ACTION.
  8557. ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
  8558. or `agenda' to produce an entry list for an agenda view. It can also be
  8559. a Lisp form or a function that should be called at each matched headline, in
  8560. this case the return value is a list of all return values from these calls.
  8561. MATCHER is a Lisp form to be evaluated, testing if a given set of tags
  8562. qualifies a headline for inclusion. When TODO-ONLY is non-nil,
  8563. only lines with a TODO keyword are included in the output."
  8564. (let* ((re (concat "[\n\r]" outline-regexp " *\\(\\<\\("
  8565. (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
  8566. (org-re
  8567. "\\>\\)\\)? *\\(.*?\\)\\(:[[:alnum:]_@:]+:\\)?[ \t]*$")))
  8568. (props (list 'face 'default
  8569. 'done-face 'org-done
  8570. 'undone-face 'default
  8571. 'mouse-face 'highlight
  8572. 'org-not-done-regexp org-not-done-regexp
  8573. 'org-todo-regexp org-todo-regexp
  8574. 'keymap org-agenda-keymap
  8575. 'help-echo
  8576. (format "mouse-2 or RET jump to org file %s"
  8577. (abbreviate-file-name
  8578. (or (buffer-file-name (buffer-base-buffer))
  8579. (buffer-name (buffer-base-buffer)))))))
  8580. (case-fold-search nil)
  8581. lspos tags tags-list
  8582. (tags-alist (list (cons 0 (mapcar 'downcase org-file-tags))))
  8583. (llast 0) rtn rtn1 level category i txt
  8584. todo marker entry priority)
  8585. (when (not (member action '(agenda sparse-tree)))
  8586. (setq action (list 'lambda nil action)))
  8587. (save-excursion
  8588. (goto-char (point-min))
  8589. (when (eq action 'sparse-tree)
  8590. (org-overview)
  8591. (org-remove-occur-highlights))
  8592. (while (re-search-forward re nil t)
  8593. (catch :skip
  8594. (setq todo (if (match-end 1) (match-string 2))
  8595. tags (if (match-end 4) (match-string 4)))
  8596. (goto-char (setq lspos (1+ (match-beginning 0))))
  8597. (setq level (org-reduced-level (funcall outline-level))
  8598. category (org-get-category))
  8599. (setq i llast llast level)
  8600. ;; remove tag lists from same and sublevels
  8601. (while (>= i level)
  8602. (when (setq entry (assoc i tags-alist))
  8603. (setq tags-alist (delete entry tags-alist)))
  8604. (setq i (1- i)))
  8605. ;; add the next tags
  8606. (when tags
  8607. (setq tags (mapcar 'downcase (org-split-string tags ":"))
  8608. tags-alist
  8609. (cons (cons level tags) tags-alist)))
  8610. ;; compile tags for current headline
  8611. (setq tags-list
  8612. (if org-use-tag-inheritance
  8613. (apply 'append (mapcar 'cdr tags-alist))
  8614. tags))
  8615. (when (and tags org-use-tag-inheritance
  8616. (not (eq t org-use-tag-inheritance)))
  8617. ;; selective inheritance, remove uninherited ones
  8618. (setcdr (car tags-alist)
  8619. (org-remove-uniherited-tags (cdar tags-alist))))
  8620. (when (and (or (not todo-only) (member todo org-not-done-keywords))
  8621. (let ((case-fold-search t)) (eval matcher))
  8622. (or
  8623. (not (member org-archive-tag tags-list))
  8624. ;; we have an archive tag, should we use this anyway?
  8625. (or (not org-agenda-skip-archived-trees)
  8626. (and (eq action 'agenda) org-agenda-archives-mode))))
  8627. (unless (eq action 'sparse-tree) (org-agenda-skip))
  8628. ;; select this headline
  8629. (cond
  8630. ((eq action 'sparse-tree)
  8631. (and org-highlight-sparse-tree-matches
  8632. (org-get-heading) (match-end 0)
  8633. (org-highlight-new-match
  8634. (match-beginning 0) (match-beginning 1)))
  8635. (org-show-context 'tags-tree))
  8636. ((eq action 'agenda)
  8637. (setq txt (org-format-agenda-item
  8638. ""
  8639. (concat
  8640. (if org-tags-match-list-sublevels
  8641. (make-string (1- level) ?.) "")
  8642. (org-get-heading))
  8643. category tags-list)
  8644. priority (org-get-priority txt))
  8645. (goto-char lspos)
  8646. (setq marker (org-agenda-new-marker))
  8647. (org-add-props txt props
  8648. 'org-marker marker 'org-hd-marker marker 'org-category category
  8649. 'priority priority 'type "tagsmatch")
  8650. (push txt rtn))
  8651. ((functionp action)
  8652. (save-excursion
  8653. (setq rtn1 (funcall action))
  8654. (push rtn1 rtn))
  8655. (goto-char (point-at-eol)))
  8656. (t (error "Invalid action")))
  8657. ;; if we are to skip sublevels, jump to end of subtree
  8658. (or org-tags-match-list-sublevels (org-end-of-subtree t))))))
  8659. (when (and (eq action 'sparse-tree)
  8660. (not org-sparse-tree-open-archived-trees))
  8661. (org-hide-archived-subtrees (point-min) (point-max)))
  8662. (nreverse rtn)))
  8663. (defun org-remove-uniherited-tags (tags)
  8664. "Remove all tags that are not inherited from the list TAGS."
  8665. (cond
  8666. ((eq org-use-tag-inheritance t) tags)
  8667. ((not org-use-tag-inheritance) nil)
  8668. ((stringp org-use-tag-inheritance)
  8669. (delq nil (mapcar
  8670. (lambda (x) (if (string-match org-use-tag-inheritance x) x nil))
  8671. tags)))
  8672. ((listp org-use-tag-inheritance)
  8673. (org-delete-all org-use-tag-inheritance tags))))
  8674. (defvar todo-only) ;; dynamically scoped
  8675. (defun org-tags-sparse-tree (&optional todo-only match)
  8676. "Create a sparse tree according to tags string MATCH.
  8677. MATCH can contain positive and negative selection of tags, like
  8678. \"+WORK+URGENT-WITHBOSS\".
  8679. If optional argument TODO_ONLY is non-nil, only select lines that are
  8680. also TODO lines."
  8681. (interactive "P")
  8682. (org-prepare-agenda-buffers (list (current-buffer)))
  8683. (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
  8684. (defvar org-cached-props nil)
  8685. (defun org-cached-entry-get (pom property)
  8686. (if (or (eq t org-use-property-inheritance)
  8687. (and (stringp org-use-property-inheritance)
  8688. (string-match org-use-property-inheritance property))
  8689. (and (listp org-use-property-inheritance)
  8690. (member property org-use-property-inheritance)))
  8691. ;; Caching is not possible, check it directly
  8692. (org-entry-get pom property 'inherit)
  8693. ;; Get all properties, so that we can do complicated checks easily
  8694. (cdr (assoc property (or org-cached-props
  8695. (setq org-cached-props
  8696. (org-entry-properties pom)))))))
  8697. (defun org-global-tags-completion-table (&optional files)
  8698. "Return the list of all tags in all agenda buffer/files."
  8699. (save-excursion
  8700. (org-uniquify
  8701. (delq nil
  8702. (apply 'append
  8703. (mapcar
  8704. (lambda (file)
  8705. (set-buffer (find-file-noselect file))
  8706. (append (org-get-buffer-tags)
  8707. (mapcar (lambda (x) (if (stringp (car-safe x))
  8708. (list (car-safe x)) nil))
  8709. org-tag-alist)))
  8710. (if (and files (car files))
  8711. files
  8712. (org-agenda-files))))))))
  8713. (defun org-make-tags-matcher (match)
  8714. "Create the TAGS//TODO matcher form for the selection string MATCH."
  8715. ;; todo-only is scoped dynamically into this function, and the function
  8716. ;; may change it it the matcher asksk for it.
  8717. (unless match
  8718. ;; Get a new match request, with completion
  8719. (let ((org-last-tags-completion-table
  8720. (org-global-tags-completion-table)))
  8721. (setq match (completing-read
  8722. "Match: " 'org-tags-completion-function nil nil nil
  8723. 'org-tags-history))))
  8724. ;; Parse the string and create a lisp form
  8725. (let ((match0 match)
  8726. (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\([[:alnum:]_]+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@]+\\)"))
  8727. minus tag mm
  8728. tagsmatch todomatch tagsmatcher todomatcher kwd matcher
  8729. orterms term orlist re-p str-p level-p level-op time-p
  8730. prop-p pn pv po cat-p gv)
  8731. (if (string-match "/+" match)
  8732. ;; match contains also a todo-matching request
  8733. (progn
  8734. (setq tagsmatch (substring match 0 (match-beginning 0))
  8735. todomatch (substring match (match-end 0)))
  8736. (if (string-match "^!" todomatch)
  8737. (setq todo-only t todomatch (substring todomatch 1)))
  8738. (if (string-match "^\\s-*$" todomatch)
  8739. (setq todomatch nil)))
  8740. ;; only matching tags
  8741. (setq tagsmatch match todomatch nil))
  8742. ;; Make the tags matcher
  8743. (if (or (not tagsmatch) (not (string-match "\\S-" tagsmatch)))
  8744. (setq tagsmatcher t)
  8745. (setq orterms (org-split-string tagsmatch "|") orlist nil)
  8746. (while (setq term (pop orterms))
  8747. (while (and (equal (substring term -1) "\\") orterms)
  8748. (setq term (concat term "|" (pop orterms)))) ; repair bad split
  8749. (while (string-match re term)
  8750. (setq minus (and (match-end 1)
  8751. (equal (match-string 1 term) "-"))
  8752. tag (match-string 2 term)
  8753. re-p (equal (string-to-char tag) ?{)
  8754. level-p (match-end 4)
  8755. prop-p (match-end 5)
  8756. mm (cond
  8757. (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
  8758. (level-p
  8759. (setq level-op (org-op-to-function (match-string 3 term)))
  8760. `(,level-op level ,(string-to-number
  8761. (match-string 4 term))))
  8762. (prop-p
  8763. (setq pn (match-string 5 term)
  8764. po (match-string 6 term)
  8765. pv (match-string 7 term)
  8766. cat-p (equal pn "CATEGORY")
  8767. re-p (equal (string-to-char pv) ?{)
  8768. str-p (equal (string-to-char pv) ?\")
  8769. time-p (save-match-data (string-match "^\"<.*>\"$" pv))
  8770. pv (if (or re-p str-p) (substring pv 1 -1) pv))
  8771. (if time-p (setq pv (org-matcher-time pv)))
  8772. (setq po (org-op-to-function po (if time-p 'time str-p)))
  8773. (if (equal pn "CATEGORY")
  8774. (setq gv '(get-text-property (point) 'org-category))
  8775. (setq gv `(org-cached-entry-get nil ,pn)))
  8776. (if re-p
  8777. (if (eq po 'org<>)
  8778. `(not (string-match ,pv (or ,gv "")))
  8779. `(string-match ,pv (or ,gv "")))
  8780. (if str-p
  8781. `(,po (or ,gv "") ,pv)
  8782. `(,po (string-to-number (or ,gv ""))
  8783. ,(string-to-number pv) ))))
  8784. (t `(member ,(downcase tag) tags-list)))
  8785. mm (if minus (list 'not mm) mm)
  8786. term (substring term (match-end 0)))
  8787. (push mm tagsmatcher))
  8788. (push (if (> (length tagsmatcher) 1)
  8789. (cons 'and tagsmatcher)
  8790. (car tagsmatcher))
  8791. orlist)
  8792. (setq tagsmatcher nil))
  8793. (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
  8794. (setq tagsmatcher
  8795. (list 'progn '(setq org-cached-props nil) tagsmatcher)))
  8796. ;; Make the todo matcher
  8797. (if (or (not todomatch) (not (string-match "\\S-" todomatch)))
  8798. (setq todomatcher t)
  8799. (setq orterms (org-split-string todomatch "|") orlist nil)
  8800. (while (setq term (pop orterms))
  8801. (while (string-match re term)
  8802. (setq minus (and (match-end 1)
  8803. (equal (match-string 1 term) "-"))
  8804. kwd (match-string 2 term)
  8805. re-p (equal (string-to-char kwd) ?{)
  8806. term (substring term (match-end 0))
  8807. mm (if re-p
  8808. `(string-match ,(substring kwd 1 -1) todo)
  8809. (list 'equal 'todo kwd))
  8810. mm (if minus (list 'not mm) mm))
  8811. (push mm todomatcher))
  8812. (push (if (> (length todomatcher) 1)
  8813. (cons 'and todomatcher)
  8814. (car todomatcher))
  8815. orlist)
  8816. (setq todomatcher nil))
  8817. (setq todomatcher (if (> (length orlist) 1)
  8818. (cons 'or orlist) (car orlist))))
  8819. ;; Return the string and lisp forms of the matcher
  8820. (setq matcher (if todomatcher
  8821. (list 'and tagsmatcher todomatcher)
  8822. tagsmatcher))
  8823. (cons match0 matcher)))
  8824. (defun org-op-to-function (op &optional stringp)
  8825. "Turn an operator into the appropriate function."
  8826. (setq op
  8827. (cond
  8828. ((equal op "<" ) '(< string< org-time<))
  8829. ((equal op ">" ) '(> org-string> org-time>))
  8830. ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
  8831. ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
  8832. ((member op '("=" "==")) '(= string= org-time=))
  8833. ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
  8834. (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
  8835. (defun org<> (a b) (not (= a b)))
  8836. (defun org-string<= (a b) (or (string= a b) (string< a b)))
  8837. (defun org-string>= (a b) (not (string< a b)))
  8838. (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
  8839. (defun org-string<> (a b) (not (string= a b)))
  8840. (defun org-time= (a b) (= (org-2ft a) (org-2ft b)))
  8841. (defun org-time< (a b) (< (org-2ft a) (org-2ft b)))
  8842. (defun org-time<= (a b) (<= (org-2ft a) (org-2ft b)))
  8843. (defun org-time> (a b) (> (org-2ft a) (org-2ft b)))
  8844. (defun org-time>= (a b) (>= (org-2ft a) (org-2ft b)))
  8845. (defun org-time<> (a b) (org<> (org-2ft a) (org-2ft b)))
  8846. (defun org-2ft (s)
  8847. "Convert S to a floating point time.
  8848. If S is already a number, just return it. If it is a string, parse
  8849. it as a time string and apply `float-time' to it. f S is nil, just return 0."
  8850. (cond
  8851. ((numberp s) s)
  8852. ((stringp s)
  8853. (condition-case nil
  8854. (float-time (apply 'encode-time (org-parse-time-string s)))
  8855. (error 0.)))
  8856. (t 0.)))
  8857. (defun org-matcher-time (s)
  8858. (cond
  8859. ((equal s "<now>") (float-time))
  8860. ((equal s "<today>")
  8861. (float-time (append '(0 0 0) (nthcdr 3 (decode-time)))))
  8862. (t (org-2ft s))))
  8863. (defun org-match-any-p (re list)
  8864. "Does re match any element of list?"
  8865. (setq list (mapcar (lambda (x) (string-match re x)) list))
  8866. (delq nil list))
  8867. (defvar org-add-colon-after-tag-completion nil) ;; dynamically skoped param
  8868. (defvar org-tags-overlay (org-make-overlay 1 1))
  8869. (org-detach-overlay org-tags-overlay)
  8870. (defun org-get-local-tags-at (&optional pos)
  8871. "Get a list of tags defined in the current headline."
  8872. (org-get-tags-at pos 'local))
  8873. (defun org-get-local-tags ()
  8874. "Get a list of tags defined in the current headline."
  8875. (org-get-tags-at nil 'local))
  8876. (defun org-get-tags-at (&optional pos local)
  8877. "Get a list of all headline tags applicable at POS.
  8878. POS defaults to point. If tags are inherited, the list contains
  8879. the targets in the same sequence as the headlines appear, i.e.
  8880. the tags of the current headline come last.
  8881. When LOCAL is non-nil, only return tags from the current headline,
  8882. ignore inherited ones."
  8883. (interactive)
  8884. (let (tags ltags lastpos parent)
  8885. (save-excursion
  8886. (save-restriction
  8887. (widen)
  8888. (goto-char (or pos (point)))
  8889. (save-match-data
  8890. (catch 'done
  8891. (condition-case nil
  8892. (progn
  8893. (org-back-to-heading t)
  8894. (while (not (equal lastpos (point)))
  8895. (setq lastpos (point))
  8896. (when (looking-at (org-re "[^\r\n]+?:\\([[:alnum:]_@:]+\\):[ \t]*$"))
  8897. (setq ltags (org-split-string
  8898. (org-match-string-no-properties 1) ":"))
  8899. (setq tags (append
  8900. (if parent
  8901. (org-remove-uniherited-tags ltags)
  8902. ltags)
  8903. tags)))
  8904. (or org-use-tag-inheritance (throw 'done t))
  8905. (if local (throw 'done t))
  8906. (org-up-heading-all 1)
  8907. (setq parent t)))
  8908. (error nil)))))
  8909. (append (org-remove-uniherited-tags org-file-tags) tags))))
  8910. (defun org-toggle-tag (tag &optional onoff)
  8911. "Toggle the tag TAG for the current line.
  8912. If ONOFF is `on' or `off', don't toggle but set to this state."
  8913. (unless (org-on-heading-p t) (error "Not on headling"))
  8914. (let (res current)
  8915. (save-excursion
  8916. (beginning-of-line)
  8917. (if (re-search-forward (org-re "[ \t]:\\([[:alnum:]_@:]+\\):[ \t]*$")
  8918. (point-at-eol) t)
  8919. (progn
  8920. (setq current (match-string 1))
  8921. (replace-match ""))
  8922. (setq current ""))
  8923. (setq current (nreverse (org-split-string current ":")))
  8924. (cond
  8925. ((eq onoff 'on)
  8926. (setq res t)
  8927. (or (member tag current) (push tag current)))
  8928. ((eq onoff 'off)
  8929. (or (not (member tag current)) (setq current (delete tag current))))
  8930. (t (if (member tag current)
  8931. (setq current (delete tag current))
  8932. (setq res t)
  8933. (push tag current))))
  8934. (end-of-line 1)
  8935. (if current
  8936. (progn
  8937. (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
  8938. (org-set-tags nil t))
  8939. (delete-horizontal-space))
  8940. (run-hooks 'org-after-tags-change-hook))
  8941. res))
  8942. (defun org-align-tags-here (to-col)
  8943. ;; Assumes that this is a headline
  8944. (let ((pos (point)) (col (current-column)) ncol tags-l p)
  8945. (beginning-of-line 1)
  8946. (if (and (looking-at (org-re ".*?\\([ \t]+\\)\\(:[[:alnum:]_@:]+:\\)[ \t]*$"))
  8947. (< pos (match-beginning 2)))
  8948. (progn
  8949. (setq tags-l (- (match-end 2) (match-beginning 2)))
  8950. (goto-char (match-beginning 1))
  8951. (insert " ")
  8952. (delete-region (point) (1+ (match-beginning 2)))
  8953. (setq ncol (max (1+ (current-column))
  8954. (1+ col)
  8955. (if (> to-col 0)
  8956. to-col
  8957. (- (abs to-col) tags-l))))
  8958. (setq p (point))
  8959. (insert (make-string (- ncol (current-column)) ?\ ))
  8960. (setq ncol (current-column))
  8961. (when indent-tabs-mode (tabify p (point-at-eol)))
  8962. (org-move-to-column (min ncol col) t))
  8963. (goto-char pos))))
  8964. (defun org-set-tags (&optional arg just-align)
  8965. "Set the tags for the current headline.
  8966. With prefix ARG, realign all tags in headings in the current buffer."
  8967. (interactive "P")
  8968. (let* ((re (concat "^" outline-regexp))
  8969. (current (org-get-tags-string))
  8970. (col (current-column))
  8971. (org-setting-tags t)
  8972. table current-tags inherited-tags ; computed below when needed
  8973. tags p0 c0 c1 rpl)
  8974. (if arg
  8975. (save-excursion
  8976. (goto-char (point-min))
  8977. (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
  8978. (while (re-search-forward re nil t)
  8979. (org-set-tags nil t)
  8980. (end-of-line 1)))
  8981. (message "All tags realigned to column %d" org-tags-column))
  8982. (if just-align
  8983. (setq tags current)
  8984. ;; Get a new set of tags from the user
  8985. (save-excursion
  8986. (setq table (or org-tag-alist (org-get-buffer-tags))
  8987. org-last-tags-completion-table table
  8988. current-tags (org-split-string current ":")
  8989. inherited-tags (nreverse
  8990. (nthcdr (length current-tags)
  8991. (nreverse (org-get-tags-at))))
  8992. tags
  8993. (if (or (eq t org-use-fast-tag-selection)
  8994. (and org-use-fast-tag-selection
  8995. (delq nil (mapcar 'cdr table))))
  8996. (org-fast-tag-selection
  8997. current-tags inherited-tags table
  8998. (if org-fast-tag-selection-include-todo org-todo-key-alist))
  8999. (let ((org-add-colon-after-tag-completion t))
  9000. (org-trim
  9001. (org-without-partial-completion
  9002. (completing-read "Tags: " 'org-tags-completion-function
  9003. nil nil current 'org-tags-history)))))))
  9004. (while (string-match "[-+&]+" tags)
  9005. ;; No boolean logic, just a list
  9006. (setq tags (replace-match ":" t t tags))))
  9007. (if (string-match "\\`[\t ]*\\'" tags)
  9008. (setq tags "")
  9009. (unless (string-match ":$" tags) (setq tags (concat tags ":")))
  9010. (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
  9011. ;; Insert new tags at the correct column
  9012. (beginning-of-line 1)
  9013. (cond
  9014. ((and (equal current "") (equal tags "")))
  9015. ((re-search-forward
  9016. (concat "\\([ \t]*" (regexp-quote current) "\\)[ \t]*$")
  9017. (point-at-eol) t)
  9018. (if (equal tags "")
  9019. (setq rpl "")
  9020. (goto-char (match-beginning 0))
  9021. (setq c0 (current-column) p0 (point)
  9022. c1 (max (1+ c0) (if (> org-tags-column 0)
  9023. org-tags-column
  9024. (- (- org-tags-column) (length tags))))
  9025. rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
  9026. (replace-match rpl t t)
  9027. (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
  9028. tags)
  9029. (t (error "Tags alignment failed")))
  9030. (org-move-to-column col)
  9031. (unless just-align
  9032. (run-hooks 'org-after-tags-change-hook)))))
  9033. (defun org-change-tag-in-region (beg end tag off)
  9034. "Add or remove TAG for each entry in the region.
  9035. This works in the agenda, and also in an org-mode buffer."
  9036. (interactive
  9037. (list (region-beginning) (region-end)
  9038. (let ((org-last-tags-completion-table
  9039. (if (org-mode-p)
  9040. (org-get-buffer-tags)
  9041. (org-global-tags-completion-table))))
  9042. (completing-read
  9043. "Tag: " 'org-tags-completion-function nil nil nil
  9044. 'org-tags-history))
  9045. (progn
  9046. (message "[s]et or [r]emove? ")
  9047. (equal (read-char-exclusive) ?r))))
  9048. (if (fboundp 'deactivate-mark) (deactivate-mark))
  9049. (let ((agendap (equal major-mode 'org-agenda-mode))
  9050. l1 l2 m buf pos newhead (cnt 0))
  9051. (goto-char end)
  9052. (setq l2 (1- (org-current-line)))
  9053. (goto-char beg)
  9054. (setq l1 (org-current-line))
  9055. (loop for l from l1 to l2 do
  9056. (goto-line l)
  9057. (setq m (get-text-property (point) 'org-hd-marker))
  9058. (when (or (and (org-mode-p) (org-on-heading-p))
  9059. (and agendap m))
  9060. (setq buf (if agendap (marker-buffer m) (current-buffer))
  9061. pos (if agendap m (point)))
  9062. (with-current-buffer buf
  9063. (save-excursion
  9064. (save-restriction
  9065. (goto-char pos)
  9066. (setq cnt (1+ cnt))
  9067. (org-toggle-tag tag (if off 'off 'on))
  9068. (setq newhead (org-get-heading)))))
  9069. (and agendap (org-agenda-change-all-lines newhead m))))
  9070. (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
  9071. (defun org-tags-completion-function (string predicate &optional flag)
  9072. (let (s1 s2 rtn (ctable org-last-tags-completion-table)
  9073. (confirm (lambda (x) (stringp (car x)))))
  9074. (if (string-match "^\\(.*[-+:&|]\\)\\([^-+:&|]*\\)$" string)
  9075. (setq s1 (match-string 1 string)
  9076. s2 (match-string 2 string))
  9077. (setq s1 "" s2 string))
  9078. (cond
  9079. ((eq flag nil)
  9080. ;; try completion
  9081. (setq rtn (try-completion s2 ctable confirm))
  9082. (if (stringp rtn)
  9083. (setq rtn
  9084. (concat s1 s2 (substring rtn (length s2))
  9085. (if (and org-add-colon-after-tag-completion
  9086. (assoc rtn ctable))
  9087. ":" ""))))
  9088. rtn)
  9089. ((eq flag t)
  9090. ;; all-completions
  9091. (all-completions s2 ctable confirm)
  9092. )
  9093. ((eq flag 'lambda)
  9094. ;; exact match?
  9095. (assoc s2 ctable)))
  9096. ))
  9097. (defun org-fast-tag-insert (kwd tags face &optional end)
  9098. "Insert KDW, and the TAGS, the latter with face FACE. Also inser END."
  9099. (insert (format "%-12s" (concat kwd ":"))
  9100. (org-add-props (mapconcat 'identity tags " ") nil 'face face)
  9101. (or end "")))
  9102. (defun org-fast-tag-show-exit (flag)
  9103. (save-excursion
  9104. (goto-line 3)
  9105. (if (re-search-forward "[ \t]+Next change exits" (point-at-eol) t)
  9106. (replace-match ""))
  9107. (when flag
  9108. (end-of-line 1)
  9109. (org-move-to-column (- (window-width) 19) t)
  9110. (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
  9111. (defun org-set-current-tags-overlay (current prefix)
  9112. (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
  9113. (if (featurep 'xemacs)
  9114. (org-overlay-display org-tags-overlay (concat prefix s)
  9115. 'secondary-selection)
  9116. (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
  9117. (org-overlay-display org-tags-overlay (concat prefix s)))))
  9118. (defun org-fast-tag-selection (current inherited table &optional todo-table)
  9119. "Fast tag selection with single keys.
  9120. CURRENT is the current list of tags in the headline, INHERITED is the
  9121. list of inherited tags, and TABLE is an alist of tags and corresponding keys,
  9122. possibly with grouping information. TODO-TABLE is a similar table with
  9123. TODO keywords, should these have keys assigned to them.
  9124. If the keys are nil, a-z are automatically assigned.
  9125. Returns the new tags string, or nil to not change the current settings."
  9126. (let* ((fulltable (append table todo-table))
  9127. (maxlen (apply 'max (mapcar
  9128. (lambda (x)
  9129. (if (stringp (car x)) (string-width (car x)) 0))
  9130. fulltable)))
  9131. (buf (current-buffer))
  9132. (expert (eq org-fast-tag-selection-single-key 'expert))
  9133. (buffer-tags nil)
  9134. (fwidth (+ maxlen 3 1 3))
  9135. (ncol (/ (- (window-width) 4) fwidth))
  9136. (i-face 'org-done)
  9137. (c-face 'org-todo)
  9138. tg cnt e c char c1 c2 ntable tbl rtn
  9139. ov-start ov-end ov-prefix
  9140. (exit-after-next org-fast-tag-selection-single-key)
  9141. (done-keywords org-done-keywords)
  9142. groups ingroup)
  9143. (save-excursion
  9144. (beginning-of-line 1)
  9145. (if (looking-at
  9146. (org-re ".*[ \t]\\(:[[:alnum:]_@:]+:\\)[ \t]*$"))
  9147. (setq ov-start (match-beginning 1)
  9148. ov-end (match-end 1)
  9149. ov-prefix "")
  9150. (setq ov-start (1- (point-at-eol))
  9151. ov-end (1+ ov-start))
  9152. (skip-chars-forward "^\n\r")
  9153. (setq ov-prefix
  9154. (concat
  9155. (buffer-substring (1- (point)) (point))
  9156. (if (> (current-column) org-tags-column)
  9157. " "
  9158. (make-string (- org-tags-column (current-column)) ?\ ))))))
  9159. (org-move-overlay org-tags-overlay ov-start ov-end)
  9160. (save-window-excursion
  9161. (if expert
  9162. (set-buffer (get-buffer-create " *Org tags*"))
  9163. (delete-other-windows)
  9164. (split-window-vertically)
  9165. (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
  9166. (erase-buffer)
  9167. (org-set-local 'org-done-keywords done-keywords)
  9168. (org-fast-tag-insert "Inherited" inherited i-face "\n")
  9169. (org-fast-tag-insert "Current" current c-face "\n\n")
  9170. (org-fast-tag-show-exit exit-after-next)
  9171. (org-set-current-tags-overlay current ov-prefix)
  9172. (setq tbl fulltable char ?a cnt 0)
  9173. (while (setq e (pop tbl))
  9174. (cond
  9175. ((equal e '(:startgroup))
  9176. (push '() groups) (setq ingroup t)
  9177. (when (not (= cnt 0))
  9178. (setq cnt 0)
  9179. (insert "\n"))
  9180. (insert "{ "))
  9181. ((equal e '(:endgroup))
  9182. (setq ingroup nil cnt 0)
  9183. (insert "}\n"))
  9184. (t
  9185. (setq tg (car e) c2 nil)
  9186. (if (cdr e)
  9187. (setq c (cdr e))
  9188. ;; automatically assign a character.
  9189. (setq c1 (string-to-char
  9190. (downcase (substring
  9191. tg (if (= (string-to-char tg) ?@) 1 0)))))
  9192. (if (or (rassoc c1 ntable) (rassoc c1 table))
  9193. (while (or (rassoc char ntable) (rassoc char table))
  9194. (setq char (1+ char)))
  9195. (setq c2 c1))
  9196. (setq c (or c2 char)))
  9197. (if ingroup (push tg (car groups)))
  9198. (setq tg (org-add-props tg nil 'face
  9199. (cond
  9200. ((not (assoc tg table))
  9201. (org-get-todo-face tg))
  9202. ((member tg current) c-face)
  9203. ((member tg inherited) i-face)
  9204. (t nil))))
  9205. (if (and (= cnt 0) (not ingroup)) (insert " "))
  9206. (insert "[" c "] " tg (make-string
  9207. (- fwidth 4 (length tg)) ?\ ))
  9208. (push (cons tg c) ntable)
  9209. (when (= (setq cnt (1+ cnt)) ncol)
  9210. (insert "\n")
  9211. (if ingroup (insert " "))
  9212. (setq cnt 0)))))
  9213. (setq ntable (nreverse ntable))
  9214. (insert "\n")
  9215. (goto-char (point-min))
  9216. (if (and (not expert) (fboundp 'fit-window-to-buffer))
  9217. (fit-window-to-buffer))
  9218. (setq rtn
  9219. (catch 'exit
  9220. (while t
  9221. (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free%s%s"
  9222. (if groups " [!] no groups" " [!]groups")
  9223. (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
  9224. (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
  9225. (cond
  9226. ((= c ?\r) (throw 'exit t))
  9227. ((= c ?!)
  9228. (setq groups (not groups))
  9229. (goto-char (point-min))
  9230. (while (re-search-forward "[{}]" nil t) (replace-match " ")))
  9231. ((= c ?\C-c)
  9232. (if (not expert)
  9233. (org-fast-tag-show-exit
  9234. (setq exit-after-next (not exit-after-next)))
  9235. (setq expert nil)
  9236. (delete-other-windows)
  9237. (split-window-vertically)
  9238. (org-switch-to-buffer-other-window " *Org tags*")
  9239. (and (fboundp 'fit-window-to-buffer)
  9240. (fit-window-to-buffer))))
  9241. ((or (= c ?\C-g)
  9242. (and (= c ?q) (not (rassoc c ntable))))
  9243. (org-detach-overlay org-tags-overlay)
  9244. (setq quit-flag t))
  9245. ((= c ?\ )
  9246. (setq current nil)
  9247. (if exit-after-next (setq exit-after-next 'now)))
  9248. ((= c ?\t)
  9249. (condition-case nil
  9250. (setq tg (completing-read
  9251. "Tag: "
  9252. (or buffer-tags
  9253. (with-current-buffer buf
  9254. (org-get-buffer-tags)))))
  9255. (quit (setq tg "")))
  9256. (when (string-match "\\S-" tg)
  9257. (add-to-list 'buffer-tags (list tg))
  9258. (if (member tg current)
  9259. (setq current (delete tg current))
  9260. (push tg current)))
  9261. (if exit-after-next (setq exit-after-next 'now)))
  9262. ((setq e (rassoc c todo-table) tg (car e))
  9263. (with-current-buffer buf
  9264. (save-excursion (org-todo tg)))
  9265. (if exit-after-next (setq exit-after-next 'now)))
  9266. ((setq e (rassoc c ntable) tg (car e))
  9267. (if (member tg current)
  9268. (setq current (delete tg current))
  9269. (loop for g in groups do
  9270. (if (member tg g)
  9271. (mapc (lambda (x)
  9272. (setq current (delete x current)))
  9273. g)))
  9274. (push tg current))
  9275. (if exit-after-next (setq exit-after-next 'now))))
  9276. ;; Create a sorted list
  9277. (setq current
  9278. (sort current
  9279. (lambda (a b)
  9280. (assoc b (cdr (memq (assoc a ntable) ntable))))))
  9281. (if (eq exit-after-next 'now) (throw 'exit t))
  9282. (goto-char (point-min))
  9283. (beginning-of-line 2)
  9284. (delete-region (point) (point-at-eol))
  9285. (org-fast-tag-insert "Current" current c-face)
  9286. (org-set-current-tags-overlay current ov-prefix)
  9287. (while (re-search-forward
  9288. (org-re "\\[.\\] \\([[:alnum:]_@]+\\)") nil t)
  9289. (setq tg (match-string 1))
  9290. (add-text-properties
  9291. (match-beginning 1) (match-end 1)
  9292. (list 'face
  9293. (cond
  9294. ((member tg current) c-face)
  9295. ((member tg inherited) i-face)
  9296. (t (get-text-property (match-beginning 1) 'face))))))
  9297. (goto-char (point-min)))))
  9298. (org-detach-overlay org-tags-overlay)
  9299. (if rtn
  9300. (mapconcat 'identity current ":")
  9301. nil))))
  9302. (defun org-get-tags-string ()
  9303. "Get the TAGS string in the current headline."
  9304. (unless (org-on-heading-p t)
  9305. (error "Not on a heading"))
  9306. (save-excursion
  9307. (beginning-of-line 1)
  9308. (if (looking-at (org-re ".*[ \t]\\(:[[:alnum:]_@:]+:\\)[ \t]*$"))
  9309. (org-match-string-no-properties 1)
  9310. "")))
  9311. (defun org-get-tags ()
  9312. "Get the list of tags specified in the current headline."
  9313. (org-split-string (org-get-tags-string) ":"))
  9314. (defun org-get-buffer-tags ()
  9315. "Get a table of all tags used in the buffer, for completion."
  9316. (let (tags)
  9317. (save-excursion
  9318. (goto-char (point-min))
  9319. (while (re-search-forward
  9320. (org-re "[ \t]:\\([[:alnum:]_@:]+\\):[ \t\r\n]") nil t)
  9321. (when (equal (char-after (point-at-bol 0)) ?*)
  9322. (mapc (lambda (x) (add-to-list 'tags x))
  9323. (org-split-string (org-match-string-no-properties 1) ":")))))
  9324. (mapcar 'list tags)))
  9325. ;;;; The mapping API
  9326. ;;;###autoload
  9327. (defun org-map-entries (func &optional match scope &rest skip)
  9328. "Call FUNC at each headline selected by MATCH in SCOPE.
  9329. FUNC is a function or a lisp form. The function will be called without
  9330. arguments, with the cursor positioned at the beginning of the headline.
  9331. The return values of all calls to the function will be collected and
  9332. returned as a list.
  9333. MATCH is a tags/property/todo match as it is used in the agenda tags view.
  9334. Only headlines that are matched by this query will be considered during
  9335. the iteration. When MATCH is nil or t, all headlines will be
  9336. visited by the iteration.
  9337. SCOPE determines the scope of this command. It can be any of:
  9338. nil The current buffer, respecting the restriction if any
  9339. tree The subtree started with the entry at point
  9340. file The current buffer, without restriction
  9341. file-with-archives
  9342. The current buffer, and any archives associated with it
  9343. agenda All agenda files
  9344. agenda-with-archives
  9345. All agenda files with any archive files associated with them
  9346. \(file1 file2 ...)
  9347. If this is a list, all files in the list will be scanned
  9348. The remaining args are treated as settings for the skipping facilities of
  9349. the scanner. The following items can be given here:
  9350. archive skip trees with the archive tag.
  9351. comment skip trees with the COMMENT keyword
  9352. function or Emacs Lisp form:
  9353. will be used as value for `org-agenda-skip-function', so whenever
  9354. the the function returns t, FUNC will not be called for that
  9355. entry and search will continue from the point where the
  9356. function leaves it."
  9357. (let* ((org-agenda-archives-mode nil) ; just to make sure
  9358. (org-agenda-skip-archived-trees (memq 'archive skip))
  9359. (org-agenda-skip-comment-trees (memq 'comment skip))
  9360. (org-agenda-skip-function
  9361. (car (org-delete-all '(comment archive) skip)))
  9362. (org-tags-match-list-sublevels t)
  9363. matcher pos file)
  9364. (cond
  9365. ((eq match t) (setq matcher t))
  9366. ((eq match nil) (setq matcher t))
  9367. (t (setq matcher (if match (org-make-tags-matcher match) t))))
  9368. (when (eq scope 'tree)
  9369. (org-back-to-heading t)
  9370. (org-narrow-to-subtree)
  9371. (setq scope nil))
  9372. (if (not scope)
  9373. (progn
  9374. (org-prepare-agenda-buffers
  9375. (list (buffer-file-name (current-buffer))))
  9376. (org-scan-tags func matcher))
  9377. ;; Get the right scope
  9378. (setq pos (point))
  9379. (cond
  9380. ((and scope (listp scope) (symbolp (car scope)))
  9381. (setq scope (eval scope)))
  9382. ((eq scope 'agenda)
  9383. (setq scope (org-agenda-files t)))
  9384. ((eq scope 'agenda-with-archives)
  9385. (setq scope (org-agenda-files t))
  9386. (setq scope (org-add-archive-files scope)))
  9387. ((eq scope 'file)
  9388. (setq scope (list (buffer-file-name))))
  9389. ((eq scope 'file-with-archives)
  9390. (setq scope (org-add-archive-files (list (buffer-file-name))))))
  9391. (org-prepare-agenda-buffers scope)
  9392. (while (setq file (pop scope))
  9393. (with-current-buffer (org-find-base-buffer-visiting file)
  9394. (save-excursion
  9395. (save-restriction
  9396. (widen)
  9397. (goto-char (point-min))
  9398. (org-scan-tags func matcher))))))))
  9399. ;;;; Properties
  9400. ;;; Setting and retrieving properties
  9401. (defconst org-special-properties
  9402. '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "PRIORITY"
  9403. "TIMESTAMP" "TIMESTAMP_IA")
  9404. "The special properties valid in Org-mode.
  9405. These are properties that are not defined in the property drawer,
  9406. but in some other way.")
  9407. (defconst org-default-properties
  9408. '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION"
  9409. "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
  9410. "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
  9411. "EXPORT_FILE_NAME" "EXPORT_TITLE")
  9412. "Some properties that are used by Org-mode for various purposes.
  9413. Being in this list makes sure that they are offered for completion.")
  9414. (defconst org-property-start-re "^[ \t]*:PROPERTIES:[ \t]*$"
  9415. "Regular expression matching the first line of a property drawer.")
  9416. (defconst org-property-end-re "^[ \t]*:END:[ \t]*$"
  9417. "Regular expression matching the first line of a property drawer.")
  9418. (defconst org-clock-drawer-start-re "^[ \t]*:CLOCK:[ \t]*$"
  9419. "Regular expression matching the first line of a property drawer.")
  9420. (defconst org-clock-drawer-end-re "^[ \t]*:END:[ \t]*$"
  9421. "Regular expression matching the first line of a property drawer.")
  9422. (defconst org-property-drawer-re
  9423. (concat "\\(" org-property-start-re "\\)[^\000]*\\("
  9424. org-property-end-re "\\)\n?")
  9425. "Matches an entire property drawer.")
  9426. (defconst org-clock-drawer-re
  9427. (concat "\\(" org-clock-drawer-start-re "\\)[^\000]*\\("
  9428. org-property-end-re "\\)\n?")
  9429. "Matches an entire clock drawer.")
  9430. (defun org-property-action ()
  9431. "Do an action on properties."
  9432. (interactive)
  9433. (let (c)
  9434. (org-at-property-p)
  9435. (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
  9436. (setq c (read-char-exclusive))
  9437. (cond
  9438. ((equal c ?s)
  9439. (call-interactively 'org-set-property))
  9440. ((equal c ?d)
  9441. (call-interactively 'org-delete-property))
  9442. ((equal c ?D)
  9443. (call-interactively 'org-delete-property-globally))
  9444. ((equal c ?c)
  9445. (call-interactively 'org-compute-property-at-point))
  9446. (t (error "No such property action %c" c)))))
  9447. (defun org-at-property-p ()
  9448. "Is the cursor in a property line?"
  9449. ;; FIXME: Does not check if we are actually in the drawer.
  9450. ;; FIXME: also returns true on any drawers.....
  9451. ;; This is used by C-c C-c for property action.
  9452. (save-excursion
  9453. (beginning-of-line 1)
  9454. (looking-at (org-re "^[ \t]*\\(:\\([[:alpha:]][[:alnum:]_-]*\\):\\)[ \t]*\\(.*\\)"))))
  9455. (defun org-get-property-block (&optional beg end force)
  9456. "Return the (beg . end) range of the body of the property drawer.
  9457. BEG and END can be beginning and end of subtree, if not given
  9458. they will be found.
  9459. If the drawer does not exist and FORCE is non-nil, create the drawer."
  9460. (catch 'exit
  9461. (save-excursion
  9462. (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
  9463. (end (or end (progn (outline-next-heading) (point)))))
  9464. (goto-char beg)
  9465. (if (re-search-forward org-property-start-re end t)
  9466. (setq beg (1+ (match-end 0)))
  9467. (if force
  9468. (save-excursion
  9469. (org-insert-property-drawer)
  9470. (setq end (progn (outline-next-heading) (point))))
  9471. (throw 'exit nil))
  9472. (goto-char beg)
  9473. (if (re-search-forward org-property-start-re end t)
  9474. (setq beg (1+ (match-end 0)))))
  9475. (if (re-search-forward org-property-end-re end t)
  9476. (setq end (match-beginning 0))
  9477. (or force (throw 'exit nil))
  9478. (goto-char beg)
  9479. (setq end beg)
  9480. (org-indent-line-function)
  9481. (insert ":END:\n"))
  9482. (cons beg end)))))
  9483. (defun org-entry-properties (&optional pom which)
  9484. "Get all properties of the entry at point-or-marker POM.
  9485. This includes the TODO keyword, the tags, time strings for deadline,
  9486. scheduled, and clocking, and any additional properties defined in the
  9487. entry. The return value is an alist, keys may occur multiple times
  9488. if the property key was used several times.
  9489. POM may also be nil, in which case the current entry is used.
  9490. If WHICH is nil or `all', get all properties. If WHICH is
  9491. `special' or `standard', only get that subclass."
  9492. (setq which (or which 'all))
  9493. (org-with-point-at pom
  9494. (let ((clockstr (substring org-clock-string 0 -1))
  9495. (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY"))
  9496. beg end range props sum-props key value string clocksum)
  9497. (save-excursion
  9498. (when (condition-case nil (org-back-to-heading t) (error nil))
  9499. (setq beg (point))
  9500. (setq sum-props (get-text-property (point) 'org-summaries))
  9501. (setq clocksum (get-text-property (point) :org-clock-minutes))
  9502. (outline-next-heading)
  9503. (setq end (point))
  9504. (when (memq which '(all special))
  9505. ;; Get the special properties, like TODO and tags
  9506. (goto-char beg)
  9507. (when (and (looking-at org-todo-line-regexp) (match-end 2))
  9508. (push (cons "TODO" (org-match-string-no-properties 2)) props))
  9509. (when (looking-at org-priority-regexp)
  9510. (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
  9511. (when (and (setq value (org-get-tags-string))
  9512. (string-match "\\S-" value))
  9513. (push (cons "TAGS" value) props))
  9514. (when (setq value (org-get-tags-at))
  9515. (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":") ":"))
  9516. props))
  9517. (while (re-search-forward org-maybe-keyword-time-regexp end t)
  9518. (setq key (if (match-end 1) (substring (org-match-string-no-properties 1) 0 -1))
  9519. string (if (equal key clockstr)
  9520. (org-no-properties
  9521. (org-trim
  9522. (buffer-substring
  9523. (match-beginning 3) (goto-char (point-at-eol)))))
  9524. (substring (org-match-string-no-properties 3) 1 -1)))
  9525. (unless key
  9526. (if (= (char-after (match-beginning 3)) ?\[)
  9527. (setq key "TIMESTAMP_IA")
  9528. (setq key "TIMESTAMP")))
  9529. (when (or (equal key clockstr) (not (assoc key props)))
  9530. (push (cons key string) props)))
  9531. )
  9532. (when (memq which '(all standard))
  9533. ;; Get the standard properties, like :PORP: ...
  9534. (setq range (org-get-property-block beg end))
  9535. (when range
  9536. (goto-char (car range))
  9537. (while (re-search-forward
  9538. (org-re "^[ \t]*:\\([[:alpha:]][[:alnum:]_-]*\\):[ \t]*\\(\\S-.*\\)?")
  9539. (cdr range) t)
  9540. (setq key (org-match-string-no-properties 1)
  9541. value (org-trim (or (org-match-string-no-properties 2) "")))
  9542. (unless (member key excluded)
  9543. (push (cons key (or value "")) props)))))
  9544. (if clocksum
  9545. (push (cons "CLOCKSUM"
  9546. (org-columns-number-to-string (/ (float clocksum) 60.)
  9547. 'add_times))
  9548. props))
  9549. (append sum-props (nreverse props)))))))
  9550. (defun org-entry-get (pom property &optional inherit)
  9551. "Get value of PROPERTY for entry at point-or-marker POM.
  9552. If INHERIT is non-nil and the entry does not have the property,
  9553. then also check higher levels of the hierarchy.
  9554. If INHERIT is the symbol `selective', use inheritance only if the setting
  9555. in `org-use-property-inheritance' selects PROPERTY for inheritance.
  9556. If the property is present but empty, the return value is the empty string.
  9557. If the property is not present at all, nil is returned."
  9558. (org-with-point-at pom
  9559. (if (and inherit (if (eq inherit 'selective)
  9560. (org-property-inherit-p property)
  9561. t))
  9562. (org-entry-get-with-inheritance property)
  9563. (if (member property org-special-properties)
  9564. ;; We need a special property. Use brute force, get all properties.
  9565. (cdr (assoc property (org-entry-properties nil 'special)))
  9566. (let ((range (org-get-property-block)))
  9567. (if (and range
  9568. (goto-char (car range))
  9569. (re-search-forward
  9570. (concat "^[ \t]*:" property ":[ \t]*\\(.*\\S-\\)?")
  9571. (cdr range) t))
  9572. ;; Found the property, return it.
  9573. (if (match-end 1)
  9574. (org-match-string-no-properties 1)
  9575. "")))))))
  9576. (defun org-property-or-variable-value (var &optional inherit)
  9577. "Check if there is a property fixing the value of VAR.
  9578. If yes, return this value. If not, return the current value of the variable."
  9579. (let ((prop (org-entry-get nil (symbol-name var) inherit)))
  9580. (if (and prop (stringp prop) (string-match "\\S-" prop))
  9581. (read prop)
  9582. (symbol-value var))))
  9583. (defun org-entry-delete (pom property)
  9584. "Delete the property PROPERTY from entry at point-or-marker POM."
  9585. (org-with-point-at pom
  9586. (if (member property org-special-properties)
  9587. nil ; cannot delete these properties.
  9588. (let ((range (org-get-property-block)))
  9589. (if (and range
  9590. (goto-char (car range))
  9591. (re-search-forward
  9592. (concat "^[ \t]*:" property ":[ \t]*\\(.*\\S-\\)")
  9593. (cdr range) t))
  9594. (progn
  9595. (delete-region (match-beginning 0) (1+ (point-at-eol)))
  9596. t)
  9597. nil)))))
  9598. ;; Multi-values properties are properties that contain multiple values
  9599. ;; These values are assumed to be single words, separated by whitespace.
  9600. (defun org-entry-add-to-multivalued-property (pom property value)
  9601. "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
  9602. (let* ((old (org-entry-get pom property))
  9603. (values (and old (org-split-string old "[ \t]"))))
  9604. (unless (member value values)
  9605. (setq values (cons value values))
  9606. (org-entry-put pom property
  9607. (mapconcat 'identity values " ")))))
  9608. (defun org-entry-remove-from-multivalued-property (pom property value)
  9609. "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
  9610. (let* ((old (org-entry-get pom property))
  9611. (values (and old (org-split-string old "[ \t]"))))
  9612. (when (member value values)
  9613. (setq values (delete value values))
  9614. (org-entry-put pom property
  9615. (mapconcat 'identity values " ")))))
  9616. (defun org-entry-member-in-multivalued-property (pom property value)
  9617. "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
  9618. (let* ((old (org-entry-get pom property))
  9619. (values (and old (org-split-string old "[ \t]"))))
  9620. (member value values)))
  9621. (defvar org-entry-property-inherited-from (make-marker))
  9622. (defun org-entry-get-with-inheritance (property)
  9623. "Get entry property, and search higher levels if not present."
  9624. (let (tmp)
  9625. (save-excursion
  9626. (save-restriction
  9627. (widen)
  9628. (catch 'ex
  9629. (while t
  9630. (when (setq tmp (org-entry-get nil property))
  9631. (org-back-to-heading t)
  9632. (move-marker org-entry-property-inherited-from (point))
  9633. (throw 'ex tmp))
  9634. (or (org-up-heading-safe) (throw 'ex nil)))))
  9635. (or tmp
  9636. (cdr (assoc property org-file-properties))
  9637. (cdr (assoc property org-global-properties))
  9638. (cdr (assoc property org-global-properties-fixed))))))
  9639. (defun org-entry-put (pom property value)
  9640. "Set PROPERTY to VALUE for entry at point-or-marker POM."
  9641. (org-with-point-at pom
  9642. (org-back-to-heading t)
  9643. (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
  9644. range)
  9645. (cond
  9646. ((equal property "TODO")
  9647. (when (and (stringp value) (string-match "\\S-" value)
  9648. (not (member value org-todo-keywords-1)))
  9649. (error "\"%s\" is not a valid TODO state" value))
  9650. (if (or (not value)
  9651. (not (string-match "\\S-" value)))
  9652. (setq value 'none))
  9653. (org-todo value)
  9654. (org-set-tags nil 'align))
  9655. ((equal property "PRIORITY")
  9656. (org-priority (if (and value (stringp value) (string-match "\\S-" value))
  9657. (string-to-char value) ?\ ))
  9658. (org-set-tags nil 'align))
  9659. ((equal property "SCHEDULED")
  9660. (if (re-search-forward org-scheduled-time-regexp end t)
  9661. (cond
  9662. ((eq value 'earlier) (org-timestamp-change -1 'day))
  9663. ((eq value 'later) (org-timestamp-change 1 'day))
  9664. (t (call-interactively 'org-schedule)))
  9665. (call-interactively 'org-schedule)))
  9666. ((equal property "DEADLINE")
  9667. (if (re-search-forward org-deadline-time-regexp end t)
  9668. (cond
  9669. ((eq value 'earlier) (org-timestamp-change -1 'day))
  9670. ((eq value 'later) (org-timestamp-change 1 'day))
  9671. (t (call-interactively 'org-deadline)))
  9672. (call-interactively 'org-deadline)))
  9673. ((member property org-special-properties)
  9674. (error "The %s property can not yet be set with `org-entry-put'"
  9675. property))
  9676. (t ; a non-special property
  9677. (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
  9678. (setq range (org-get-property-block beg end 'force))
  9679. (goto-char (car range))
  9680. (if (re-search-forward
  9681. (concat "^[ \t]*:" property ":\\(.*\\)") (cdr range) t)
  9682. (progn
  9683. (delete-region (match-beginning 1) (match-end 1))
  9684. (goto-char (match-beginning 1)))
  9685. (goto-char (cdr range))
  9686. (insert "\n")
  9687. (backward-char 1)
  9688. (org-indent-line-function)
  9689. (insert ":" property ":"))
  9690. (and value (insert " " value))
  9691. (org-indent-line-function)))))))
  9692. (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
  9693. "Get all property keys in the current buffer.
  9694. With INCLUDE-SPECIALS, also list the special properties that relect things
  9695. like tags and TODO state.
  9696. With INCLUDE-DEFAULTS, also include properties that has special meaning
  9697. internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING.
  9698. With INCLUDE-COLUMNS, also include property names given in COLUMN
  9699. formats in the current buffer."
  9700. (let (rtn range cfmt cols s p)
  9701. (save-excursion
  9702. (save-restriction
  9703. (widen)
  9704. (goto-char (point-min))
  9705. (while (re-search-forward org-property-start-re nil t)
  9706. (setq range (org-get-property-block))
  9707. (goto-char (car range))
  9708. (while (re-search-forward
  9709. (org-re "^[ \t]*:\\([-[:alnum:]_]+\\):")
  9710. (cdr range) t)
  9711. (add-to-list 'rtn (org-match-string-no-properties 1)))
  9712. (outline-next-heading))))
  9713. (when include-specials
  9714. (setq rtn (append org-special-properties rtn)))
  9715. (when include-defaults
  9716. (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties))
  9717. (when include-columns
  9718. (save-excursion
  9719. (save-restriction
  9720. (widen)
  9721. (goto-char (point-min))
  9722. (while (re-search-forward
  9723. "^\\(#\\+COLUMNS:\\|[ \t]*:COLUMNS:\\)[ \t]*\\(.*\\)"
  9724. nil t)
  9725. (setq cfmt (match-string 2) s 0)
  9726. (while (string-match (org-re "%[0-9]*\\([-[:alnum:]_]+\\)")
  9727. cfmt s)
  9728. (setq s (match-end 0)
  9729. p (match-string 1 cfmt))
  9730. (unless (or (equal p "ITEM")
  9731. (member p org-special-properties))
  9732. (add-to-list 'rtn (match-string 1 cfmt))))))))
  9733. (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
  9734. (defun org-property-values (key)
  9735. "Return a list of all values of property KEY."
  9736. (save-excursion
  9737. (save-restriction
  9738. (widen)
  9739. (goto-char (point-min))
  9740. (let ((re (concat "^[ \t]*:" key ":[ \t]*\\(\\S-.*\\)"))
  9741. values)
  9742. (while (re-search-forward re nil t)
  9743. (add-to-list 'values (org-trim (match-string 1))))
  9744. (delete "" values)))))
  9745. (defun org-insert-property-drawer ()
  9746. "Insert a property drawer into the current entry."
  9747. (interactive)
  9748. (org-back-to-heading t)
  9749. (looking-at outline-regexp)
  9750. (let ((indent (- (match-end 0)(match-beginning 0)))
  9751. (beg (point))
  9752. (re (concat "^[ \t]*" org-keyword-time-regexp))
  9753. end hiddenp)
  9754. (outline-next-heading)
  9755. (setq end (point))
  9756. (goto-char beg)
  9757. (while (re-search-forward re end t))
  9758. (setq hiddenp (org-invisible-p))
  9759. (end-of-line 1)
  9760. (and (equal (char-after) ?\n) (forward-char 1))
  9761. (while (looking-at "^[ \t]*\\(:CLOCK:\\|CLOCK\\|:END:\\)")
  9762. (beginning-of-line 2))
  9763. (org-skip-over-state-notes)
  9764. (skip-chars-backward " \t\n\r")
  9765. (if (eq (char-before) ?*) (forward-char 1))
  9766. (let ((inhibit-read-only t)) (insert "\n:PROPERTIES:\n:END:"))
  9767. (beginning-of-line 0)
  9768. (org-indent-to-column indent)
  9769. (beginning-of-line 2)
  9770. (org-indent-to-column indent)
  9771. (beginning-of-line 0)
  9772. (if hiddenp
  9773. (save-excursion
  9774. (org-back-to-heading t)
  9775. (hide-entry))
  9776. (org-flag-drawer t))))
  9777. (defun org-set-property (property value)
  9778. "In the current entry, set PROPERTY to VALUE.
  9779. When called interactively, this will prompt for a property name, offering
  9780. completion on existing and default properties. And then it will prompt
  9781. for a value, offering competion either on allowed values (via an inherited
  9782. xxx_ALL property) or on existing values in other instances of this property
  9783. in the current file."
  9784. (interactive
  9785. (let* ((completion-ignore-case t)
  9786. (keys (org-buffer-property-keys nil t t))
  9787. (prop0 (completing-read "Property: " (mapcar 'list keys)))
  9788. (prop (if (member prop0 keys)
  9789. prop0
  9790. (or (cdr (assoc (downcase prop0)
  9791. (mapcar (lambda (x) (cons (downcase x) x))
  9792. keys)))
  9793. prop0)))
  9794. (cur (org-entry-get nil prop))
  9795. (allowed (org-property-get-allowed-values nil prop 'table))
  9796. (existing (mapcar 'list (org-property-values prop)))
  9797. (val (if allowed
  9798. (org-completing-read "Value: " allowed nil 'req-match)
  9799. (org-completing-read
  9800. (concat "Value" (if (and cur (string-match "\\S-" cur))
  9801. (concat "[" cur "]") "")
  9802. ": ")
  9803. existing nil nil "" nil cur))))
  9804. (list prop (if (equal val "") cur val))))
  9805. (unless (equal (org-entry-get nil property) value)
  9806. (org-entry-put nil property value)))
  9807. (defun org-delete-property (property)
  9808. "In the current entry, delete PROPERTY."
  9809. (interactive
  9810. (let* ((completion-ignore-case t)
  9811. (prop (completing-read
  9812. "Property: " (org-entry-properties nil 'standard))))
  9813. (list prop)))
  9814. (message "Property %s %s" property
  9815. (if (org-entry-delete nil property)
  9816. "deleted"
  9817. "was not present in the entry")))
  9818. (defun org-delete-property-globally (property)
  9819. "Remove PROPERTY globally, from all entries."
  9820. (interactive
  9821. (let* ((completion-ignore-case t)
  9822. (prop (completing-read
  9823. "Globally remove property: "
  9824. (mapcar 'list (org-buffer-property-keys)))))
  9825. (list prop)))
  9826. (save-excursion
  9827. (save-restriction
  9828. (widen)
  9829. (goto-char (point-min))
  9830. (let ((cnt 0))
  9831. (while (re-search-forward
  9832. (concat "^[ \t]*:" (regexp-quote property) ":.*\n?")
  9833. nil t)
  9834. (setq cnt (1+ cnt))
  9835. (replace-match ""))
  9836. (message "Property \"%s\" removed from %d entries" property cnt)))))
  9837. (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
  9838. (defun org-compute-property-at-point ()
  9839. "Compute the property at point.
  9840. This looks for an enclosing column format, extracts the operator and
  9841. then applies it to the proerty in the column format's scope."
  9842. (interactive)
  9843. (unless (org-at-property-p)
  9844. (error "Not at a property"))
  9845. (let ((prop (org-match-string-no-properties 2)))
  9846. (org-columns-get-format-and-top-level)
  9847. (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
  9848. (error "No operator defined for property %s" prop))
  9849. (org-columns-compute prop)))
  9850. (defun org-property-get-allowed-values (pom property &optional table)
  9851. "Get allowed values for the property PROPERTY.
  9852. When TABLE is non-nil, return an alist that can directly be used for
  9853. completion."
  9854. (let (vals)
  9855. (cond
  9856. ((equal property "TODO")
  9857. (setq vals (org-with-point-at pom
  9858. (append org-todo-keywords-1 '("")))))
  9859. ((equal property "PRIORITY")
  9860. (let ((n org-lowest-priority))
  9861. (while (>= n org-highest-priority)
  9862. (push (char-to-string n) vals)
  9863. (setq n (1- n)))))
  9864. ((member property org-special-properties))
  9865. (t
  9866. (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
  9867. (when (and vals (string-match "\\S-" vals))
  9868. (setq vals (car (read-from-string (concat "(" vals ")"))))
  9869. (setq vals (mapcar (lambda (x)
  9870. (cond ((stringp x) x)
  9871. ((numberp x) (number-to-string x))
  9872. ((symbolp x) (symbol-name x))
  9873. (t "???")))
  9874. vals)))))
  9875. (if table (mapcar 'list vals) vals)))
  9876. (defun org-property-previous-allowed-value (&optional previous)
  9877. "Switch to the next allowed value for this property."
  9878. (interactive)
  9879. (org-property-next-allowed-value t))
  9880. (defun org-property-next-allowed-value (&optional previous)
  9881. "Switch to the next allowed value for this property."
  9882. (interactive)
  9883. (unless (org-at-property-p)
  9884. (error "Not at a property"))
  9885. (let* ((key (match-string 2))
  9886. (value (match-string 3))
  9887. (allowed (or (org-property-get-allowed-values (point) key)
  9888. (and (member value '("[ ]" "[-]" "[X]"))
  9889. '("[ ]" "[X]"))))
  9890. nval)
  9891. (unless allowed
  9892. (error "Allowed values for this property have not been defined"))
  9893. (if previous (setq allowed (reverse allowed)))
  9894. (if (member value allowed)
  9895. (setq nval (car (cdr (member value allowed)))))
  9896. (setq nval (or nval (car allowed)))
  9897. (if (equal nval value)
  9898. (error "Only one allowed value for this property"))
  9899. (org-at-property-p)
  9900. (replace-match (concat " :" key ": " nval) t t)
  9901. (org-indent-line-function)
  9902. (beginning-of-line 1)
  9903. (skip-chars-forward " \t")))
  9904. (defun org-find-entry-with-id (ident)
  9905. "Locate the entry that contains the ID property with exact value IDENT.
  9906. IDENT can be a string, a symbol or a number, this function will search for
  9907. the string representation of it.
  9908. Return the position where this entry starts, or nil if there is no such entry."
  9909. (let ((id (cond
  9910. ((stringp ident) ident)
  9911. ((symbol-name ident) (symbol-name ident))
  9912. ((numberp ident) (number-to-string ident))
  9913. (t (error "IDENT %s must be a string, symbol or number" ident))))
  9914. (case-fold-search nil))
  9915. (save-excursion
  9916. (save-restriction
  9917. (widen)
  9918. (goto-char (point-min))
  9919. (when (re-search-forward
  9920. (concat "^[ \t]*:ID:[ \t]+" (regexp-quote id) "[ \t]*$")
  9921. nil t)
  9922. (org-back-to-heading)
  9923. (point))))))
  9924. ;;;; Timestamps
  9925. (defvar org-last-changed-timestamp nil)
  9926. (defvar org-last-inserted-timestamp nil
  9927. "The last time stamp inserted with `org-insert-time-stamp'.")
  9928. (defvar org-time-was-given) ; dynamically scoped parameter
  9929. (defvar org-end-time-was-given) ; dynamically scoped parameter
  9930. (defvar org-ts-what) ; dynamically scoped parameter
  9931. (defun org-time-stamp (arg)
  9932. "Prompt for a date/time and insert a time stamp.
  9933. If the user specifies a time like HH:MM, or if this command is called
  9934. with a prefix argument, the time stamp will contain date and time.
  9935. Otherwise, only the date will be included. All parts of a date not
  9936. specified by the user will be filled in from the current date/time.
  9937. So if you press just return without typing anything, the time stamp
  9938. will represent the current date/time. If there is already a timestamp
  9939. at the cursor, it will be modified."
  9940. (interactive "P")
  9941. (let* ((ts nil)
  9942. (default-time
  9943. ;; Default time is either today, or, when entering a range,
  9944. ;; the range start.
  9945. (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
  9946. (save-excursion
  9947. (re-search-backward
  9948. (concat org-ts-regexp "--?-?\\=") ; 1-3 minuses
  9949. (- (point) 20) t)))
  9950. (apply 'encode-time (org-parse-time-string (match-string 1)))
  9951. (current-time)))
  9952. (default-input (and ts (org-get-compact-tod ts)))
  9953. org-time-was-given org-end-time-was-given time)
  9954. (cond
  9955. ((and (org-at-timestamp-p)
  9956. (eq last-command 'org-time-stamp)
  9957. (eq this-command 'org-time-stamp))
  9958. (insert "--")
  9959. (setq time (let ((this-command this-command))
  9960. (org-read-date arg 'totime nil nil default-time default-input)))
  9961. (org-insert-time-stamp time (or org-time-was-given arg)))
  9962. ((org-at-timestamp-p)
  9963. (setq time (let ((this-command this-command))
  9964. (org-read-date arg 'totime nil nil default-time default-input)))
  9965. (when (org-at-timestamp-p) ; just to get the match data
  9966. (replace-match "")
  9967. (setq org-last-changed-timestamp
  9968. (org-insert-time-stamp
  9969. time (or org-time-was-given arg)
  9970. nil nil nil (list org-end-time-was-given))))
  9971. (message "Timestamp updated"))
  9972. (t
  9973. (setq time (let ((this-command this-command))
  9974. (org-read-date arg 'totime nil nil default-time default-input)))
  9975. (org-insert-time-stamp time (or org-time-was-given arg)
  9976. nil nil nil (list org-end-time-was-given))))))
  9977. ;; FIXME: can we use this for something else, like computing time differences?
  9978. (defun org-get-compact-tod (s)
  9979. (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
  9980. (let* ((t1 (match-string 1 s))
  9981. (h1 (string-to-number (match-string 2 s)))
  9982. (m1 (string-to-number (match-string 3 s)))
  9983. (t2 (and (match-end 4) (match-string 5 s)))
  9984. (h2 (and t2 (string-to-number (match-string 6 s))))
  9985. (m2 (and t2 (string-to-number (match-string 7 s))))
  9986. dh dm)
  9987. (if (not t2)
  9988. t1
  9989. (setq dh (- h2 h1) dm (- m2 m1))
  9990. (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
  9991. (concat t1 "+" (number-to-string dh)
  9992. (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
  9993. (defun org-time-stamp-inactive (&optional arg)
  9994. "Insert an inactive time stamp.
  9995. An inactive time stamp is enclosed in square brackets instead of angle
  9996. brackets. It is inactive in the sense that it does not trigger agenda entries,
  9997. does not link to the calendar and cannot be changed with the S-cursor keys.
  9998. So these are more for recording a certain time/date."
  9999. (interactive "P")
  10000. (let (org-time-was-given org-end-time-was-given time)
  10001. (setq time (org-read-date arg 'totime))
  10002. (org-insert-time-stamp time (or org-time-was-given arg) 'inactive
  10003. nil nil (list org-end-time-was-given))))
  10004. (defvar org-date-ovl (org-make-overlay 1 1))
  10005. (org-overlay-put org-date-ovl 'face 'org-warning)
  10006. (org-detach-overlay org-date-ovl)
  10007. (defvar org-ans1) ; dynamically scoped parameter
  10008. (defvar org-ans2) ; dynamically scoped parameter
  10009. (defvar org-plain-time-of-day-regexp) ; defined below
  10010. (defvar org-overriding-default-time nil) ; dynamically scoped
  10011. (defvar org-read-date-overlay nil)
  10012. (defvar org-dcst nil) ; dynamically scoped
  10013. (defun org-read-date (&optional with-time to-time from-string prompt
  10014. default-time default-input)
  10015. "Read a date, possibly a time, and make things smooth for the user.
  10016. The prompt will suggest to enter an ISO date, but you can also enter anything
  10017. which will at least partially be understood by `parse-time-string'.
  10018. Unrecognized parts of the date will default to the current day, month, year,
  10019. hour and minute. If this command is called to replace a timestamp at point,
  10020. of to enter the second timestamp of a range, the default time is taken from the
  10021. existing stamp. For example,
  10022. 3-2-5 --> 2003-02-05
  10023. feb 15 --> currentyear-02-15
  10024. sep 12 9 --> 2009-09-12
  10025. 12:45 --> today 12:45
  10026. 22 sept 0:34 --> currentyear-09-22 0:34
  10027. 12 --> currentyear-currentmonth-12
  10028. Fri --> nearest Friday (today or later)
  10029. etc.
  10030. Furthermore you can specify a relative date by giving, as the *first* thing
  10031. in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
  10032. change in days weeks, months, years.
  10033. With a single plus or minus, the date is relative to today. With a double
  10034. plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
  10035. +4d --> four days from today
  10036. +4 --> same as above
  10037. +2w --> two weeks from today
  10038. ++5 --> five days from default date
  10039. The function understands only English month and weekday abbreviations,
  10040. but this can be configured with the variables `parse-time-months' and
  10041. `parse-time-weekdays'.
  10042. While prompting, a calendar is popped up - you can also select the
  10043. date with the mouse (button 1). The calendar shows a period of three
  10044. months. To scroll it to other months, use the keys `>' and `<'.
  10045. If you don't like the calendar, turn it off with
  10046. \(setq org-read-date-popup-calendar nil)
  10047. With optional argument TO-TIME, the date will immediately be converted
  10048. to an internal time.
  10049. With an optional argument WITH-TIME, the prompt will suggest to also
  10050. insert a time. Note that when WITH-TIME is not set, you can still
  10051. enter a time, and this function will inform the calling routine about
  10052. this change. The calling routine may then choose to change the format
  10053. used to insert the time stamp into the buffer to include the time.
  10054. With optional argument FROM-STRING, read from this string instead from
  10055. the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
  10056. the time/date that is used for everything that is not specified by the
  10057. user."
  10058. (require 'parse-time)
  10059. (let* ((org-time-stamp-rounding-minutes
  10060. (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
  10061. (org-dcst org-display-custom-times)
  10062. (ct (org-current-time))
  10063. (def (or org-overriding-default-time default-time ct))
  10064. (defdecode (decode-time def))
  10065. (dummy (progn
  10066. (when (< (nth 2 defdecode) org-extend-today-until)
  10067. (setcar (nthcdr 2 defdecode) -1)
  10068. (setcar (nthcdr 1 defdecode) 59)
  10069. (setq def (apply 'encode-time defdecode)
  10070. defdecode (decode-time def)))))
  10071. (calendar-move-hook nil)
  10072. (calendar-view-diary-initially-flag nil)
  10073. (view-diary-entries-initially nil)
  10074. (calendar-view-holidays-initially-flag nil)
  10075. (view-calendar-holidays-initially nil)
  10076. (timestr (format-time-string
  10077. (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
  10078. (prompt (concat (if prompt (concat prompt " ") "")
  10079. (format "Date+time [%s]: " timestr)))
  10080. ans (org-ans0 "") org-ans1 org-ans2 final)
  10081. (cond
  10082. (from-string (setq ans from-string))
  10083. (org-read-date-popup-calendar
  10084. (save-excursion
  10085. (save-window-excursion
  10086. (calendar)
  10087. (calendar-forward-day (- (time-to-days def)
  10088. (calendar-absolute-from-gregorian
  10089. (calendar-current-date))))
  10090. (org-eval-in-calendar nil t)
  10091. (let* ((old-map (current-local-map))
  10092. (map (copy-keymap calendar-mode-map))
  10093. (minibuffer-local-map (copy-keymap minibuffer-local-map)))
  10094. (org-defkey map (kbd "RET") 'org-calendar-select)
  10095. (org-defkey map (if (featurep 'xemacs) [button1] [mouse-1])
  10096. 'org-calendar-select-mouse)
  10097. (org-defkey map (if (featurep 'xemacs) [button2] [mouse-2])
  10098. 'org-calendar-select-mouse)
  10099. (org-defkey minibuffer-local-map [(meta shift left)]
  10100. (lambda () (interactive)
  10101. (org-eval-in-calendar '(calendar-backward-month 1))))
  10102. (org-defkey minibuffer-local-map [(meta shift right)]
  10103. (lambda () (interactive)
  10104. (org-eval-in-calendar '(calendar-forward-month 1))))
  10105. (org-defkey minibuffer-local-map [(meta shift up)]
  10106. (lambda () (interactive)
  10107. (org-eval-in-calendar '(calendar-backward-year 1))))
  10108. (org-defkey minibuffer-local-map [(meta shift down)]
  10109. (lambda () (interactive)
  10110. (org-eval-in-calendar '(calendar-forward-year 1))))
  10111. (org-defkey minibuffer-local-map [(shift up)]
  10112. (lambda () (interactive)
  10113. (org-eval-in-calendar '(calendar-backward-week 1))))
  10114. (org-defkey minibuffer-local-map [(shift down)]
  10115. (lambda () (interactive)
  10116. (org-eval-in-calendar '(calendar-forward-week 1))))
  10117. (org-defkey minibuffer-local-map [(shift left)]
  10118. (lambda () (interactive)
  10119. (org-eval-in-calendar '(calendar-backward-day 1))))
  10120. (org-defkey minibuffer-local-map [(shift right)]
  10121. (lambda () (interactive)
  10122. (org-eval-in-calendar '(calendar-forward-day 1))))
  10123. (org-defkey minibuffer-local-map ">"
  10124. (lambda () (interactive)
  10125. (org-eval-in-calendar '(scroll-calendar-left 1))))
  10126. (org-defkey minibuffer-local-map "<"
  10127. (lambda () (interactive)
  10128. (org-eval-in-calendar '(scroll-calendar-right 1))))
  10129. (unwind-protect
  10130. (progn
  10131. (use-local-map map)
  10132. (add-hook 'post-command-hook 'org-read-date-display)
  10133. (setq org-ans0 (read-string prompt default-input nil nil))
  10134. ;; org-ans0: from prompt
  10135. ;; org-ans1: from mouse click
  10136. ;; org-ans2: from calendar motion
  10137. (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
  10138. (remove-hook 'post-command-hook 'org-read-date-display)
  10139. (use-local-map old-map)
  10140. (when org-read-date-overlay
  10141. (org-delete-overlay org-read-date-overlay)
  10142. (setq org-read-date-overlay nil)))))))
  10143. (t ; Naked prompt only
  10144. (unwind-protect
  10145. (setq ans (read-string prompt default-input nil timestr))
  10146. (when org-read-date-overlay
  10147. (org-delete-overlay org-read-date-overlay)
  10148. (setq org-read-date-overlay nil)))))
  10149. (setq final (org-read-date-analyze ans def defdecode))
  10150. (if to-time
  10151. (apply 'encode-time final)
  10152. (if (and (boundp 'org-time-was-given) org-time-was-given)
  10153. (format "%04d-%02d-%02d %02d:%02d"
  10154. (nth 5 final) (nth 4 final) (nth 3 final)
  10155. (nth 2 final) (nth 1 final))
  10156. (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
  10157. (defvar def)
  10158. (defvar defdecode)
  10159. (defvar with-time)
  10160. (defun org-read-date-display ()
  10161. "Display the currrent date prompt interpretation in the minibuffer."
  10162. (when org-read-date-display-live
  10163. (when org-read-date-overlay
  10164. (org-delete-overlay org-read-date-overlay))
  10165. (let ((p (point)))
  10166. (end-of-line 1)
  10167. (while (not (equal (buffer-substring
  10168. (max (point-min) (- (point) 4)) (point))
  10169. " "))
  10170. (insert " "))
  10171. (goto-char p))
  10172. (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
  10173. " " (or org-ans1 org-ans2)))
  10174. (org-end-time-was-given nil)
  10175. (f (org-read-date-analyze ans def defdecode))
  10176. (fmts (if org-dcst
  10177. org-time-stamp-custom-formats
  10178. org-time-stamp-formats))
  10179. (fmt (if (or with-time
  10180. (and (boundp 'org-time-was-given) org-time-was-given))
  10181. (cdr fmts)
  10182. (car fmts)))
  10183. (txt (concat "=> " (format-time-string fmt (apply 'encode-time f)))))
  10184. (when (and org-end-time-was-given
  10185. (string-match org-plain-time-of-day-regexp txt))
  10186. (setq txt (concat (substring txt 0 (match-end 0)) "-"
  10187. org-end-time-was-given
  10188. (substring txt (match-end 0)))))
  10189. (setq org-read-date-overlay
  10190. (org-make-overlay (1- (point-at-eol)) (point-at-eol)))
  10191. (org-overlay-display org-read-date-overlay txt 'secondary-selection))))
  10192. (defun org-read-date-analyze (ans def defdecode)
  10193. "Analyze the combined answer of the date prompt."
  10194. ;; FIXME: cleanup and comment
  10195. (let (delta deltan deltaw deltadef year month day
  10196. hour minute second wday pm h2 m2 tl wday1
  10197. iso-year iso-weekday iso-week iso-year iso-date)
  10198. (when (string-match "\\`[ \t]*\\.[ \t]*\\'" ans)
  10199. (setq ans "+0"))
  10200. (when (setq delta (org-read-date-get-relative ans (current-time) def))
  10201. (setq ans (replace-match "" t t ans)
  10202. deltan (car delta)
  10203. deltaw (nth 1 delta)
  10204. deltadef (nth 2 delta)))
  10205. ;; Check if there is an iso week date in there
  10206. ;; If yes, sore the info and ostpone interpreting it until the rest
  10207. ;; of the parsing is done
  10208. (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
  10209. (setq iso-year (if (match-end 1) (org-small-year-to-year (string-to-number (match-string 1 ans))))
  10210. iso-weekday (if (match-end 3) (string-to-number (match-string 3 ans)))
  10211. iso-week (string-to-number (match-string 2 ans)))
  10212. (setq ans (replace-match "" t t ans)))
  10213. ;; Help matching ISO dates with single digit month ot day, like 2006-8-11.
  10214. (when (string-match
  10215. "^ *\\(\\([0-9]+\\)-\\)?\\([0-1]?[0-9]\\)-\\([0-3]?[0-9]\\)\\([^-0-9]\\|$\\)" ans)
  10216. (setq year (if (match-end 2)
  10217. (string-to-number (match-string 2 ans))
  10218. (string-to-number (format-time-string "%Y")))
  10219. month (string-to-number (match-string 3 ans))
  10220. day (string-to-number (match-string 4 ans)))
  10221. (if (< year 100) (setq year (+ 2000 year)))
  10222. (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
  10223. t nil ans)))
  10224. ;; Help matching am/pm times, because `parse-time-string' does not do that.
  10225. ;; If there is a time with am/pm, and *no* time without it, we convert
  10226. ;; so that matching will be successful.
  10227. (loop for i from 1 to 2 do ; twice, for end time as well
  10228. (when (and (not (string-match "\\(\\`\\|[^+]\\)[012]?[0-9]:[0-9][0-9]\\([ \t\n]\\|$\\)" ans))
  10229. (string-match "\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\(am\\|AM\\|pm\\|PM\\)\\>" ans))
  10230. (setq hour (string-to-number (match-string 1 ans))
  10231. minute (if (match-end 3)
  10232. (string-to-number (match-string 3 ans))
  10233. 0)
  10234. pm (equal ?p
  10235. (string-to-char (downcase (match-string 4 ans)))))
  10236. (if (and (= hour 12) (not pm))
  10237. (setq hour 0)
  10238. (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
  10239. (setq ans (replace-match (format "%02d:%02d" hour minute)
  10240. t t ans))))
  10241. ;; Check if a time range is given as a duration
  10242. (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
  10243. (setq hour (string-to-number (match-string 1 ans))
  10244. h2 (+ hour (string-to-number (match-string 3 ans)))
  10245. minute (string-to-number (match-string 2 ans))
  10246. m2 (+ minute (if (match-end 5) (string-to-number
  10247. (match-string 5 ans))0)))
  10248. (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
  10249. (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
  10250. t t ans)))
  10251. ;; Check if there is a time range
  10252. (when (boundp 'org-end-time-was-given)
  10253. (setq org-time-was-given nil)
  10254. (when (and (string-match org-plain-time-of-day-regexp ans)
  10255. (match-end 8))
  10256. (setq org-end-time-was-given (match-string 8 ans))
  10257. (setq ans (concat (substring ans 0 (match-beginning 7))
  10258. (substring ans (match-end 7))))))
  10259. (setq tl (parse-time-string ans)
  10260. day (or (nth 3 tl) (nth 3 defdecode))
  10261. month (or (nth 4 tl)
  10262. (if (and org-read-date-prefer-future
  10263. (nth 3 tl) (< (nth 3 tl) (nth 3 defdecode)))
  10264. (1+ (nth 4 defdecode))
  10265. (nth 4 defdecode)))
  10266. year (or (nth 5 tl)
  10267. (if (and org-read-date-prefer-future
  10268. (nth 4 tl) (< (nth 4 tl) (nth 4 defdecode)))
  10269. (1+ (nth 5 defdecode))
  10270. (nth 5 defdecode)))
  10271. hour (or (nth 2 tl) (nth 2 defdecode))
  10272. minute (or (nth 1 tl) (nth 1 defdecode))
  10273. second (or (nth 0 tl) 0)
  10274. wday (nth 6 tl))
  10275. ;; Special date definitions below
  10276. (cond
  10277. (iso-week
  10278. ;; There was an iso week
  10279. (setq year (or iso-year year)
  10280. day (or iso-weekday wday 1)
  10281. wday nil ; to make sure that the trigger below does not match
  10282. iso-date (calendar-gregorian-from-absolute
  10283. (calendar-absolute-from-iso
  10284. (list iso-week day year))))
  10285. ; FIXME: Should we also push ISO weeks into the future?
  10286. ; (when (and org-read-date-prefer-future
  10287. ; (not iso-year)
  10288. ; (< (calendar-absolute-from-gregorian iso-date)
  10289. ; (time-to-days (current-time))))
  10290. ; (setq year (1+ year)
  10291. ; iso-date (calendar-gregorian-from-absolute
  10292. ; (calendar-absolute-from-iso
  10293. ; (list iso-week day year)))))
  10294. (setq month (car iso-date)
  10295. year (nth 2 iso-date)
  10296. day (nth 1 iso-date)))
  10297. (deltan
  10298. (unless deltadef
  10299. (let ((now (decode-time (current-time))))
  10300. (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
  10301. (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
  10302. ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
  10303. ((equal deltaw "m") (setq month (+ month deltan)))
  10304. ((equal deltaw "y") (setq year (+ year deltan)))))
  10305. ((and wday (not (nth 3 tl)))
  10306. ;; Weekday was given, but no day, so pick that day in the week
  10307. ;; on or after the derived date.
  10308. (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
  10309. (unless (equal wday wday1)
  10310. (setq day (+ day (% (- wday wday1 -7) 7))))))
  10311. (if (and (boundp 'org-time-was-given)
  10312. (nth 2 tl))
  10313. (setq org-time-was-given t))
  10314. (if (< year 100) (setq year (+ 2000 year)))
  10315. (if (< year 1970) (setq year (nth 5 defdecode))) ; not representable
  10316. (list second minute hour day month year)))
  10317. (defvar parse-time-weekdays)
  10318. (defun org-read-date-get-relative (s today default)
  10319. "Check string S for special relative date string.
  10320. TODAY and DEFAULT are internal times, for today and for a default.
  10321. Return shift list (N what def-flag)
  10322. WHAT is \"d\", \"w\", \"m\", or \"y\" for day, week, month, year.
  10323. N is the number of WHATs to shift.
  10324. DEF-FLAG is t when a double ++ or -- indicates shift relative to
  10325. the DEFAULT date rather than TODAY."
  10326. (when (and
  10327. (string-match
  10328. (concat
  10329. "\\`[ \t]*\\([-+]\\{0,2\\}\\)"
  10330. "\\([0-9]+\\)?"
  10331. "\\([dwmy]\\|\\(" (mapconcat 'car parse-time-weekdays "\\|") "\\)\\)?"
  10332. "\\([ \t]\\|$\\)") s)
  10333. (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
  10334. (let* ((dir (if (> (match-end 1) (match-beginning 1))
  10335. (string-to-char (substring (match-string 1 s) -1))
  10336. ?+))
  10337. (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
  10338. (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
  10339. (what (if (match-end 3) (match-string 3 s) "d"))
  10340. (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
  10341. (date (if rel default today))
  10342. (wday (nth 6 (decode-time date)))
  10343. delta)
  10344. (if wday1
  10345. (progn
  10346. (setq delta (mod (+ 7 (- wday1 wday)) 7))
  10347. (if (= dir ?-) (setq delta (- delta 7)))
  10348. (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
  10349. (list delta "d" rel))
  10350. (list (* n (if (= dir ?-) -1 1)) what rel)))))
  10351. (defun org-eval-in-calendar (form &optional keepdate)
  10352. "Eval FORM in the calendar window and return to current window.
  10353. Also, store the cursor date in variable org-ans2."
  10354. (let ((sw (selected-window)))
  10355. (select-window (get-buffer-window "*Calendar*"))
  10356. (eval form)
  10357. (when (and (not keepdate) (calendar-cursor-to-date))
  10358. (let* ((date (calendar-cursor-to-date))
  10359. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  10360. (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
  10361. (org-move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
  10362. (select-window sw)))
  10363. ; ;; Update the prompt to show new default date
  10364. ; (save-excursion
  10365. ; (goto-char (point-min))
  10366. ; (when (and org-ans2
  10367. ; (re-search-forward "\\[[-0-9]+\\]" nil t)
  10368. ; (get-text-property (match-end 0) 'field))
  10369. ; (let ((inhibit-read-only t))
  10370. ; (replace-match (concat "[" org-ans2 "]") t t)
  10371. ; (add-text-properties (point-min) (1+ (match-end 0))
  10372. ; (text-properties-at (1+ (point-min)))))))))
  10373. (defun org-calendar-select ()
  10374. "Return to `org-read-date' with the date currently selected.
  10375. This is used by `org-read-date' in a temporary keymap for the calendar buffer."
  10376. (interactive)
  10377. (when (calendar-cursor-to-date)
  10378. (let* ((date (calendar-cursor-to-date))
  10379. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  10380. (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
  10381. (if (active-minibuffer-window) (exit-minibuffer))))
  10382. (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
  10383. "Insert a date stamp for the date given by the internal TIME.
  10384. WITH-HM means, use the stamp format that includes the time of the day.
  10385. INACTIVE means use square brackets instead of angular ones, so that the
  10386. stamp will not contribute to the agenda.
  10387. PRE and POST are optional strings to be inserted before and after the
  10388. stamp.
  10389. The command returns the inserted time stamp."
  10390. (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
  10391. stamp)
  10392. (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
  10393. (insert-before-markers (or pre ""))
  10394. (insert-before-markers (setq stamp (format-time-string fmt time)))
  10395. (when (listp extra)
  10396. (setq extra (car extra))
  10397. (if (and (stringp extra)
  10398. (string-match "\\([0-9]+\\):\\([0-9]+\\)" extra))
  10399. (setq extra (format "-%02d:%02d"
  10400. (string-to-number (match-string 1 extra))
  10401. (string-to-number (match-string 2 extra))))
  10402. (setq extra nil)))
  10403. (when extra
  10404. (backward-char 1)
  10405. (insert-before-markers extra)
  10406. (forward-char 1))
  10407. (insert-before-markers (or post ""))
  10408. (setq org-last-inserted-timestamp stamp)))
  10409. (defun org-toggle-time-stamp-overlays ()
  10410. "Toggle the use of custom time stamp formats."
  10411. (interactive)
  10412. (setq org-display-custom-times (not org-display-custom-times))
  10413. (unless org-display-custom-times
  10414. (let ((p (point-min)) (bmp (buffer-modified-p)))
  10415. (while (setq p (next-single-property-change p 'display))
  10416. (if (and (get-text-property p 'display)
  10417. (eq (get-text-property p 'face) 'org-date))
  10418. (remove-text-properties
  10419. p (setq p (next-single-property-change p 'display))
  10420. '(display t))))
  10421. (set-buffer-modified-p bmp)))
  10422. (if (featurep 'xemacs)
  10423. (remove-text-properties (point-min) (point-max) '(end-glyph t)))
  10424. (org-restart-font-lock)
  10425. (setq org-table-may-need-update t)
  10426. (if org-display-custom-times
  10427. (message "Time stamps are overlayed with custom format")
  10428. (message "Time stamp overlays removed")))
  10429. (defun org-display-custom-time (beg end)
  10430. "Overlay modified time stamp format over timestamp between BEG and END."
  10431. (let* ((ts (buffer-substring beg end))
  10432. t1 w1 with-hm tf time str w2 (off 0))
  10433. (save-match-data
  10434. (setq t1 (org-parse-time-string ts t))
  10435. (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\)?\\'" ts)
  10436. (setq off (- (match-end 0) (match-beginning 0)))))
  10437. (setq end (- end off))
  10438. (setq w1 (- end beg)
  10439. with-hm (and (nth 1 t1) (nth 2 t1))
  10440. tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
  10441. time (org-fix-decoded-time t1)
  10442. str (org-add-props
  10443. (format-time-string
  10444. (substring tf 1 -1) (apply 'encode-time time))
  10445. nil 'mouse-face 'highlight)
  10446. w2 (length str))
  10447. (if (not (= w2 w1))
  10448. (add-text-properties (1+ beg) (+ 2 beg)
  10449. (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
  10450. (if (featurep 'xemacs)
  10451. (progn
  10452. (put-text-property beg end 'invisible t)
  10453. (put-text-property beg end 'end-glyph (make-glyph str)))
  10454. (put-text-property beg end 'display str))))
  10455. (defun org-translate-time (string)
  10456. "Translate all timestamps in STRING to custom format.
  10457. But do this only if the variable `org-display-custom-times' is set."
  10458. (when org-display-custom-times
  10459. (save-match-data
  10460. (let* ((start 0)
  10461. (re org-ts-regexp-both)
  10462. t1 with-hm inactive tf time str beg end)
  10463. (while (setq start (string-match re string start))
  10464. (setq beg (match-beginning 0)
  10465. end (match-end 0)
  10466. t1 (save-match-data
  10467. (org-parse-time-string (substring string beg end) t))
  10468. with-hm (and (nth 1 t1) (nth 2 t1))
  10469. inactive (equal (substring string beg (1+ beg)) "[")
  10470. tf (funcall (if with-hm 'cdr 'car)
  10471. org-time-stamp-custom-formats)
  10472. time (org-fix-decoded-time t1)
  10473. str (format-time-string
  10474. (concat
  10475. (if inactive "[" "<") (substring tf 1 -1)
  10476. (if inactive "]" ">"))
  10477. (apply 'encode-time time))
  10478. string (replace-match str t t string)
  10479. start (+ start (length str)))))))
  10480. string)
  10481. (defun org-fix-decoded-time (time)
  10482. "Set 0 instead of nil for the first 6 elements of time.
  10483. Don't touch the rest."
  10484. (let ((n 0))
  10485. (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
  10486. (defun org-days-to-time (timestamp-string)
  10487. "Difference between TIMESTAMP-STRING and now in days."
  10488. (- (time-to-days (org-time-string-to-time timestamp-string))
  10489. (time-to-days (current-time))))
  10490. (defun org-deadline-close (timestamp-string &optional ndays)
  10491. "Is the time in TIMESTAMP-STRING close to the current date?"
  10492. (setq ndays (or ndays (org-get-wdays timestamp-string)))
  10493. (and (< (org-days-to-time timestamp-string) ndays)
  10494. (not (org-entry-is-done-p))))
  10495. (defun org-get-wdays (ts)
  10496. "Get the deadline lead time appropriate for timestring TS."
  10497. (cond
  10498. ((<= org-deadline-warning-days 0)
  10499. ;; 0 or negative, enforce this value no matter what
  10500. (- org-deadline-warning-days))
  10501. ((string-match "-\\([0-9]+\\)\\([dwmy]\\)\\(\\'\\|>\\)" ts)
  10502. ;; lead time is specified.
  10503. (floor (* (string-to-number (match-string 1 ts))
  10504. (cdr (assoc (match-string 2 ts)
  10505. '(("d" . 1) ("w" . 7)
  10506. ("m" . 30.4) ("y" . 365.25)))))))
  10507. ;; go for the default.
  10508. (t org-deadline-warning-days)))
  10509. (defun org-calendar-select-mouse (ev)
  10510. "Return to `org-read-date' with the date currently selected.
  10511. This is used by `org-read-date' in a temporary keymap for the calendar buffer."
  10512. (interactive "e")
  10513. (mouse-set-point ev)
  10514. (when (calendar-cursor-to-date)
  10515. (let* ((date (calendar-cursor-to-date))
  10516. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  10517. (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
  10518. (if (active-minibuffer-window) (exit-minibuffer))))
  10519. (defun org-check-deadlines (ndays)
  10520. "Check if there are any deadlines due or past due.
  10521. A deadline is considered due if it happens within `org-deadline-warning-days'
  10522. days from today's date. If the deadline appears in an entry marked DONE,
  10523. it is not shown. The prefix arg NDAYS can be used to test that many
  10524. days. If the prefix is a raw \\[universal-argument] prefix, all deadlines are shown."
  10525. (interactive "P")
  10526. (let* ((org-warn-days
  10527. (cond
  10528. ((equal ndays '(4)) 100000)
  10529. (ndays (prefix-numeric-value ndays))
  10530. (t (abs org-deadline-warning-days))))
  10531. (case-fold-search nil)
  10532. (regexp (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
  10533. (callback
  10534. (lambda () (org-deadline-close (match-string 1) org-warn-days))))
  10535. (message "%d deadlines past-due or due within %d days"
  10536. (org-occur regexp nil callback)
  10537. org-warn-days)))
  10538. (defun org-check-before-date (date)
  10539. "Check if there are deadlines or scheduled entries before DATE."
  10540. (interactive (list (org-read-date)))
  10541. (let ((case-fold-search nil)
  10542. (regexp (concat "\\<\\(" org-deadline-string
  10543. "\\|" org-scheduled-string
  10544. "\\) *<\\([^>]+\\)>"))
  10545. (callback
  10546. (lambda () (time-less-p
  10547. (org-time-string-to-time (match-string 2))
  10548. (org-time-string-to-time date)))))
  10549. (message "%d entries before %s"
  10550. (org-occur regexp nil callback) date)))
  10551. (defun org-evaluate-time-range (&optional to-buffer)
  10552. "Evaluate a time range by computing the difference between start and end.
  10553. Normally the result is just printed in the echo area, but with prefix arg
  10554. TO-BUFFER, the result is inserted just after the date stamp into the buffer.
  10555. If the time range is actually in a table, the result is inserted into the
  10556. next column.
  10557. For time difference computation, a year is assumed to be exactly 365
  10558. days in order to avoid rounding problems."
  10559. (interactive "P")
  10560. (or
  10561. (org-clock-update-time-maybe)
  10562. (save-excursion
  10563. (unless (org-at-date-range-p t)
  10564. (goto-char (point-at-bol))
  10565. (re-search-forward org-tr-regexp-both (point-at-eol) t))
  10566. (if (not (org-at-date-range-p t))
  10567. (error "Not at a time-stamp range, and none found in current line")))
  10568. (let* ((ts1 (match-string 1))
  10569. (ts2 (match-string 2))
  10570. (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
  10571. (match-end (match-end 0))
  10572. (time1 (org-time-string-to-time ts1))
  10573. (time2 (org-time-string-to-time ts2))
  10574. (t1 (time-to-seconds time1))
  10575. (t2 (time-to-seconds time2))
  10576. (diff (abs (- t2 t1)))
  10577. (negative (< (- t2 t1) 0))
  10578. ;; (ys (floor (* 365 24 60 60)))
  10579. (ds (* 24 60 60))
  10580. (hs (* 60 60))
  10581. (fy "%dy %dd %02d:%02d")
  10582. (fy1 "%dy %dd")
  10583. (fd "%dd %02d:%02d")
  10584. (fd1 "%dd")
  10585. (fh "%02d:%02d")
  10586. y d h m align)
  10587. (if havetime
  10588. (setq ; y (floor (/ diff ys)) diff (mod diff ys)
  10589. y 0
  10590. d (floor (/ diff ds)) diff (mod diff ds)
  10591. h (floor (/ diff hs)) diff (mod diff hs)
  10592. m (floor (/ diff 60)))
  10593. (setq ; y (floor (/ diff ys)) diff (mod diff ys)
  10594. y 0
  10595. d (floor (+ (/ diff ds) 0.5))
  10596. h 0 m 0))
  10597. (if (not to-buffer)
  10598. (message "%s" (org-make-tdiff-string y d h m))
  10599. (if (org-at-table-p)
  10600. (progn
  10601. (goto-char match-end)
  10602. (setq align t)
  10603. (and (looking-at " *|") (goto-char (match-end 0))))
  10604. (goto-char match-end))
  10605. (if (looking-at
  10606. "\\( *-? *[0-9]+y\\)?\\( *[0-9]+d\\)? *[0-9][0-9]:[0-9][0-9]")
  10607. (replace-match ""))
  10608. (if negative (insert " -"))
  10609. (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
  10610. (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
  10611. (insert " " (format fh h m))))
  10612. (if align (org-table-align))
  10613. (message "Time difference inserted")))))
  10614. (defun org-make-tdiff-string (y d h m)
  10615. (let ((fmt "")
  10616. (l nil))
  10617. (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
  10618. l (push y l)))
  10619. (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
  10620. l (push d l)))
  10621. (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
  10622. l (push h l)))
  10623. (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
  10624. l (push m l)))
  10625. (apply 'format fmt (nreverse l))))
  10626. (defun org-time-string-to-time (s)
  10627. (apply 'encode-time (org-parse-time-string s)))
  10628. (defun org-time-string-to-absolute (s &optional daynr prefer show-all)
  10629. "Convert a time stamp to an absolute day number.
  10630. If there is a specifyer for a cyclic time stamp, get the closest date to
  10631. DAYNR.
  10632. PREFER and SHOW_ALL are passed through to `org-closest-date'."
  10633. (cond
  10634. ((and daynr (string-match "\\`%%\\((.*)\\)" s))
  10635. (if (org-diary-sexp-entry (match-string 1 s) "" date)
  10636. daynr
  10637. (+ daynr 1000)))
  10638. ((and daynr (string-match "\\+[0-9]+[dwmy]" s))
  10639. (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
  10640. (time-to-days (current-time))) (match-string 0 s)
  10641. prefer show-all))
  10642. (t (time-to-days (apply 'encode-time (org-parse-time-string s))))))
  10643. (defun org-days-to-iso-week (days)
  10644. "Return the iso week number."
  10645. (require 'cal-iso)
  10646. (car (calendar-iso-from-absolute days)))
  10647. (defun org-small-year-to-year (year)
  10648. "Convert 2-digit years into 4-digit years.
  10649. 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
  10650. The year 2000 cannot be abbreviated. Any year lager than 99
  10651. is retrned unchanged."
  10652. (if (< year 38)
  10653. (setq year (+ 2000 year))
  10654. (if (< year 100)
  10655. (setq year (+ 1900 year))))
  10656. year)
  10657. (defun org-time-from-absolute (d)
  10658. "Return the time corresponding to date D.
  10659. D may be an absolute day number, or a calendar-type list (month day year)."
  10660. (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
  10661. (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
  10662. (defun org-calendar-holiday ()
  10663. "List of holidays, for Diary display in Org-mode."
  10664. (require 'holidays)
  10665. (let ((hl (funcall
  10666. (if (fboundp 'calendar-check-holidays)
  10667. 'calendar-check-holidays 'check-calendar-holidays) date)))
  10668. (if hl (mapconcat 'identity hl "; "))))
  10669. (defun org-diary-sexp-entry (sexp entry date)
  10670. "Process a SEXP diary ENTRY for DATE."
  10671. (require 'diary-lib)
  10672. (let ((result (if calendar-debug-sexp
  10673. (let ((stack-trace-on-error t))
  10674. (eval (car (read-from-string sexp))))
  10675. (condition-case nil
  10676. (eval (car (read-from-string sexp)))
  10677. (error
  10678. (beep)
  10679. (message "Bad sexp at line %d in %s: %s"
  10680. (org-current-line)
  10681. (buffer-file-name) sexp)
  10682. (sleep-for 2))))))
  10683. (cond ((stringp result) result)
  10684. ((and (consp result)
  10685. (stringp (cdr result))) (cdr result))
  10686. (result entry)
  10687. (t nil))))
  10688. (defun org-diary-to-ical-string (frombuf)
  10689. "Get iCalendar entries from diary entries in buffer FROMBUF.
  10690. This uses the icalendar.el library."
  10691. (let* ((tmpdir (if (featurep 'xemacs)
  10692. (temp-directory)
  10693. temporary-file-directory))
  10694. (tmpfile (make-temp-name
  10695. (expand-file-name "orgics" tmpdir)))
  10696. buf rtn b e)
  10697. (save-excursion
  10698. (set-buffer frombuf)
  10699. (icalendar-export-region (point-min) (point-max) tmpfile)
  10700. (setq buf (find-buffer-visiting tmpfile))
  10701. (set-buffer buf)
  10702. (goto-char (point-min))
  10703. (if (re-search-forward "^BEGIN:VEVENT" nil t)
  10704. (setq b (match-beginning 0)))
  10705. (goto-char (point-max))
  10706. (if (re-search-backward "^END:VEVENT" nil t)
  10707. (setq e (match-end 0)))
  10708. (setq rtn (if (and b e) (concat (buffer-substring b e) "\n") "")))
  10709. (kill-buffer buf)
  10710. (delete-file tmpfile)
  10711. rtn))
  10712. (defun org-closest-date (start current change prefer show-all)
  10713. "Find the date closest to CURRENT that is consistent with START and CHANGE.
  10714. When PREFER is `past' return a date that is either CURRENT or past.
  10715. When PREFER is `future', return a date that is either CURRENT or future.
  10716. When SHOW-ALL is nil, only return the current occurence of a time stamp."
  10717. ;; Make the proper lists from the dates
  10718. (catch 'exit
  10719. (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
  10720. dn dw sday cday n1 n2
  10721. d m y y1 y2 date1 date2 nmonths nm ny m2)
  10722. (setq start (org-date-to-gregorian start)
  10723. current (org-date-to-gregorian
  10724. (if show-all
  10725. current
  10726. (time-to-days (current-time))))
  10727. sday (calendar-absolute-from-gregorian start)
  10728. cday (calendar-absolute-from-gregorian current))
  10729. (if (<= cday sday) (throw 'exit sday))
  10730. (if (string-match "\\(\\+[0-9]+\\)\\([dwmy]\\)" change)
  10731. (setq dn (string-to-number (match-string 1 change))
  10732. dw (cdr (assoc (match-string 2 change) a1)))
  10733. (error "Invalid change specifyer: %s" change))
  10734. (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
  10735. (cond
  10736. ((eq dw 'day)
  10737. (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
  10738. n2 (+ n1 dn)))
  10739. ((eq dw 'year)
  10740. (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
  10741. (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
  10742. (setq date1 (list m d y1)
  10743. n1 (calendar-absolute-from-gregorian date1)
  10744. date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
  10745. n2 (calendar-absolute-from-gregorian date2)))
  10746. ((eq dw 'month)
  10747. ;; approx number of month between the two dates
  10748. (setq nmonths (floor (/ (- cday sday) 30.436875)))
  10749. ;; How often does dn fit in there?
  10750. (setq d (nth 1 start) m (car start) y (nth 2 start)
  10751. nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
  10752. m (+ m nm)
  10753. ny (floor (/ m 12))
  10754. y (+ y ny)
  10755. m (- m (* ny 12)))
  10756. (while (> m 12) (setq m (- m 12) y (1+ y)))
  10757. (setq n1 (calendar-absolute-from-gregorian (list m d y)))
  10758. (setq m2 (+ m dn) y2 y)
  10759. (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
  10760. (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
  10761. (while (<= n2 cday)
  10762. (setq n1 n2 m m2 y y2)
  10763. (setq m2 (+ m dn) y2 y)
  10764. (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
  10765. (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
  10766. (if show-all
  10767. (cond
  10768. ((eq prefer 'past) n1)
  10769. ((eq prefer 'future) (if (= cday n1) n1 n2))
  10770. (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
  10771. (cond
  10772. ((eq prefer 'past) n1)
  10773. ((eq prefer 'future) (if (= cday n1) n1 n2))
  10774. (t (if (= cday n1) n1 n2)))))))
  10775. (defun org-date-to-gregorian (date)
  10776. "Turn any specification of DATE into a gregorian date for the calendar."
  10777. (cond ((integerp date) (calendar-gregorian-from-absolute date))
  10778. ((and (listp date) (= (length date) 3)) date)
  10779. ((stringp date)
  10780. (setq date (org-parse-time-string date))
  10781. (list (nth 4 date) (nth 3 date) (nth 5 date)))
  10782. ((listp date)
  10783. (list (nth 4 date) (nth 3 date) (nth 5 date)))))
  10784. (defun org-parse-time-string (s &optional nodefault)
  10785. "Parse the standard Org-mode time string.
  10786. This should be a lot faster than the normal `parse-time-string'.
  10787. If time is not given, defaults to 0:00. However, with optional NODEFAULT,
  10788. hour and minute fields will be nil if not given."
  10789. (if (string-match org-ts-regexp0 s)
  10790. (list 0
  10791. (if (or (match-beginning 8) (not nodefault))
  10792. (string-to-number (or (match-string 8 s) "0")))
  10793. (if (or (match-beginning 7) (not nodefault))
  10794. (string-to-number (or (match-string 7 s) "0")))
  10795. (string-to-number (match-string 4 s))
  10796. (string-to-number (match-string 3 s))
  10797. (string-to-number (match-string 2 s))
  10798. nil nil nil)
  10799. (make-list 9 0)))
  10800. (defun org-timestamp-up (&optional arg)
  10801. "Increase the date item at the cursor by one.
  10802. If the cursor is on the year, change the year. If it is on the month or
  10803. the day, change that.
  10804. With prefix ARG, change by that many units."
  10805. (interactive "p")
  10806. (org-timestamp-change (prefix-numeric-value arg)))
  10807. (defun org-timestamp-down (&optional arg)
  10808. "Decrease the date item at the cursor by one.
  10809. If the cursor is on the year, change the year. If it is on the month or
  10810. the day, change that.
  10811. With prefix ARG, change by that many units."
  10812. (interactive "p")
  10813. (org-timestamp-change (- (prefix-numeric-value arg))))
  10814. (defun org-timestamp-up-day (&optional arg)
  10815. "Increase the date in the time stamp by one day.
  10816. With prefix ARG, change that many days."
  10817. (interactive "p")
  10818. (if (and (not (org-at-timestamp-p t))
  10819. (org-on-heading-p))
  10820. (org-todo 'up)
  10821. (org-timestamp-change (prefix-numeric-value arg) 'day)))
  10822. (defun org-timestamp-down-day (&optional arg)
  10823. "Decrease the date in the time stamp by one day.
  10824. With prefix ARG, change that many days."
  10825. (interactive "p")
  10826. (if (and (not (org-at-timestamp-p t))
  10827. (org-on-heading-p))
  10828. (org-todo 'down)
  10829. (org-timestamp-change (- (prefix-numeric-value arg)) 'day)))
  10830. (defun org-at-timestamp-p (&optional inactive-ok)
  10831. "Determine if the cursor is in or at a timestamp."
  10832. (interactive)
  10833. (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
  10834. (pos (point))
  10835. (ans (or (looking-at tsr)
  10836. (save-excursion
  10837. (skip-chars-backward "^[<\n\r\t")
  10838. (if (> (point) (point-min)) (backward-char 1))
  10839. (and (looking-at tsr)
  10840. (> (- (match-end 0) pos) -1))))))
  10841. (and ans
  10842. (boundp 'org-ts-what)
  10843. (setq org-ts-what
  10844. (cond
  10845. ((= pos (match-beginning 0)) 'bracket)
  10846. ((= pos (1- (match-end 0))) 'bracket)
  10847. ((org-pos-in-match-range pos 2) 'year)
  10848. ((org-pos-in-match-range pos 3) 'month)
  10849. ((org-pos-in-match-range pos 7) 'hour)
  10850. ((org-pos-in-match-range pos 8) 'minute)
  10851. ((or (org-pos-in-match-range pos 4)
  10852. (org-pos-in-match-range pos 5)) 'day)
  10853. ((and (> pos (or (match-end 8) (match-end 5)))
  10854. (< pos (match-end 0)))
  10855. (- pos (or (match-end 8) (match-end 5))))
  10856. (t 'day))))
  10857. ans))
  10858. (defun org-toggle-timestamp-type ()
  10859. "Toggle the type (<active> or [inactive]) of a time stamp."
  10860. (interactive)
  10861. (when (org-at-timestamp-p t)
  10862. (save-excursion
  10863. (goto-char (match-beginning 0))
  10864. (insert (if (equal (char-after) ?<) "[" "<")) (delete-char 1)
  10865. (goto-char (1- (match-end 0)))
  10866. (insert (if (equal (char-after) ?>) "]" ">")) (delete-char 1))
  10867. (message "Timestamp is now %sactive"
  10868. (if (equal (char-before) ?>) "in" ""))))
  10869. (defun org-timestamp-change (n &optional what)
  10870. "Change the date in the time stamp at point.
  10871. The date will be changed by N times WHAT. WHAT can be `day', `month',
  10872. `year', `minute', `second'. If WHAT is not given, the cursor position
  10873. in the timestamp determines what will be changed."
  10874. (let ((pos (point))
  10875. with-hm inactive
  10876. (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
  10877. org-ts-what
  10878. extra rem
  10879. ts time time0)
  10880. (if (not (org-at-timestamp-p t))
  10881. (error "Not at a timestamp"))
  10882. (if (and (not what) (eq org-ts-what 'bracket))
  10883. (org-toggle-timestamp-type)
  10884. (if (and (not what) (not (eq org-ts-what 'day))
  10885. org-display-custom-times
  10886. (get-text-property (point) 'display)
  10887. (not (get-text-property (1- (point)) 'display)))
  10888. (setq org-ts-what 'day))
  10889. (setq org-ts-what (or what org-ts-what)
  10890. inactive (= (char-after (match-beginning 0)) ?\[)
  10891. ts (match-string 0))
  10892. (replace-match "")
  10893. (if (string-match
  10894. "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?[-+][0-9]+[dwmy]\\)*\\)[]>]"
  10895. ts)
  10896. (setq extra (match-string 1 ts)))
  10897. (if (string-match "^.\\{10\\}.*?[0-9]+:[0-9][0-9]" ts)
  10898. (setq with-hm t))
  10899. (setq time0 (org-parse-time-string ts))
  10900. (when (and (eq org-ts-what 'minute)
  10901. (eq current-prefix-arg nil))
  10902. (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
  10903. (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
  10904. (setcar (cdr time0) (+ (nth 1 time0)
  10905. (if (> n 0) (- rem) (- dm rem))))))
  10906. (setq time
  10907. (encode-time (or (car time0) 0)
  10908. (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
  10909. (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
  10910. (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
  10911. (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
  10912. (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
  10913. (nthcdr 6 time0)))
  10914. (when (integerp org-ts-what)
  10915. (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
  10916. (if (eq what 'calendar)
  10917. (let ((cal-date (org-get-date-from-calendar)))
  10918. (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
  10919. (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
  10920. (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
  10921. (setcar time0 (or (car time0) 0))
  10922. (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
  10923. (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
  10924. (setq time (apply 'encode-time time0))))
  10925. (setq org-last-changed-timestamp
  10926. (org-insert-time-stamp time with-hm inactive nil nil extra))
  10927. (org-clock-update-time-maybe)
  10928. (goto-char pos)
  10929. ;; Try to recenter the calendar window, if any
  10930. (if (and org-calendar-follow-timestamp-change
  10931. (get-buffer-window "*Calendar*" t)
  10932. (memq org-ts-what '(day month year)))
  10933. (org-recenter-calendar (time-to-days time))))))
  10934. (defun org-modify-ts-extra (s pos n dm)
  10935. "Change the different parts of the lead-time and repeat fields in timestamp."
  10936. (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
  10937. ng h m new rem)
  10938. (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
  10939. (cond
  10940. ((or (org-pos-in-match-range pos 2)
  10941. (org-pos-in-match-range pos 3))
  10942. (setq m (string-to-number (match-string 3 s))
  10943. h (string-to-number (match-string 2 s)))
  10944. (if (org-pos-in-match-range pos 2)
  10945. (setq h (+ h n))
  10946. (setq n (* dm (org-no-warnings (signum n))))
  10947. (when (not (= 0 (setq rem (% m dm))))
  10948. (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
  10949. (setq m (+ m n)))
  10950. (if (< m 0) (setq m (+ m 60) h (1- h)))
  10951. (if (> m 59) (setq m (- m 60) h (1+ h)))
  10952. (setq h (min 24 (max 0 h)))
  10953. (setq ng 1 new (format "-%02d:%02d" h m)))
  10954. ((org-pos-in-match-range pos 6)
  10955. (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
  10956. ((org-pos-in-match-range pos 5)
  10957. (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
  10958. ((org-pos-in-match-range pos 9)
  10959. (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
  10960. ((org-pos-in-match-range pos 8)
  10961. (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
  10962. (when ng
  10963. (setq s (concat
  10964. (substring s 0 (match-beginning ng))
  10965. new
  10966. (substring s (match-end ng))))))
  10967. s))
  10968. (defun org-recenter-calendar (date)
  10969. "If the calendar is visible, recenter it to DATE."
  10970. (let* ((win (selected-window))
  10971. (cwin (get-buffer-window "*Calendar*" t))
  10972. (calendar-move-hook nil))
  10973. (when cwin
  10974. (select-window cwin)
  10975. (calendar-goto-date (if (listp date) date
  10976. (calendar-gregorian-from-absolute date)))
  10977. (select-window win))))
  10978. (defun org-goto-calendar (&optional arg)
  10979. "Go to the Emacs calendar at the current date.
  10980. If there is a time stamp in the current line, go to that date.
  10981. A prefix ARG can be used to force the current date."
  10982. (interactive "P")
  10983. (let ((tsr org-ts-regexp) diff
  10984. (calendar-move-hook nil)
  10985. (calendar-view-holidays-initially-flag nil)
  10986. (view-calendar-holidays-initially nil)
  10987. (calendar-view-diary-initially-flag nil)
  10988. (view-diary-entries-initially nil))
  10989. (if (or (org-at-timestamp-p)
  10990. (save-excursion
  10991. (beginning-of-line 1)
  10992. (looking-at (concat ".*" tsr))))
  10993. (let ((d1 (time-to-days (current-time)))
  10994. (d2 (time-to-days
  10995. (org-time-string-to-time (match-string 1)))))
  10996. (setq diff (- d2 d1))))
  10997. (calendar)
  10998. (calendar-goto-today)
  10999. (if (and diff (not arg)) (calendar-forward-day diff))))
  11000. (defun org-get-date-from-calendar ()
  11001. "Return a list (month day year) of date at point in calendar."
  11002. (with-current-buffer "*Calendar*"
  11003. (save-match-data
  11004. (calendar-cursor-to-date))))
  11005. (defun org-date-from-calendar ()
  11006. "Insert time stamp corresponding to cursor date in *Calendar* buffer.
  11007. If there is already a time stamp at the cursor position, update it."
  11008. (interactive)
  11009. (if (org-at-timestamp-p t)
  11010. (org-timestamp-change 0 'calendar)
  11011. (let ((cal-date (org-get-date-from-calendar)))
  11012. (org-insert-time-stamp
  11013. (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
  11014. (defun org-minutes-to-hh:mm-string (m)
  11015. "Compute H:MM from a number of minutes."
  11016. (let ((h (/ m 60)))
  11017. (setq m (- m (* 60 h)))
  11018. (format org-time-clocksum-format h m)))
  11019. (defun org-hh:mm-string-to-minutes (s)
  11020. "Convert a string H:MM to a number of minutes."
  11021. (if (string-match "\\([0-9]+\\):\\([0-9]+\\)" s)
  11022. (+ (* (string-to-number (match-string 1 s)) 60)
  11023. (string-to-number (match-string 2 s)))
  11024. 0))
  11025. ;;;; Agenda files
  11026. ;;;###autoload
  11027. (defun org-iswitchb (&optional arg)
  11028. "Use `iswitchb-read-buffer' to prompt for an Org buffer to switch to.
  11029. With a prefix argument, restrict available to files.
  11030. With two prefix arguments, restrict available buffers to agenda files.
  11031. Due to some yet unresolved reason, the global function
  11032. `iswitchb-mode' needs to be active for this function to work."
  11033. (interactive "P")
  11034. (require 'iswitchb)
  11035. (let ((enabled iswitchb-mode) blist)
  11036. (or enabled (iswitchb-mode 1))
  11037. (setq blist (cond ((equal arg '(4)) (org-buffer-list 'files))
  11038. ((equal arg '(16)) (org-buffer-list 'agenda))
  11039. (t (org-buffer-list))))
  11040. (unwind-protect
  11041. (let ((iswitchb-make-buflist-hook
  11042. (lambda ()
  11043. (setq iswitchb-temp-buflist
  11044. (mapcar 'buffer-name blist)))))
  11045. (switch-to-buffer
  11046. (iswitchb-read-buffer
  11047. "Switch-to: " nil t))
  11048. (or enabled (iswitchb-mode -1))))))
  11049. (defun org-buffer-list (&optional predicate exclude-tmp)
  11050. "Return a list of Org buffers.
  11051. PREDICATE can be `export', `files' or `agenda'.
  11052. export restrict the list to Export buffers.
  11053. files restrict the list to buffers visiting Org files.
  11054. agenda restrict the list to buffers visiting agenda files.
  11055. If EXCLUDE-TMP is non-nil, ignore temporary buffers."
  11056. (let* ((bfn nil)
  11057. (agenda-files (and (eq predicate 'agenda)
  11058. (mapcar 'file-truename (org-agenda-files t))))
  11059. (filter
  11060. (cond
  11061. ((eq predicate 'files)
  11062. (lambda (b) (with-current-buffer b (eq major-mode 'org-mode))))
  11063. ((eq predicate 'export)
  11064. (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
  11065. ((eq predicate 'agenda)
  11066. (lambda (b)
  11067. (with-current-buffer b
  11068. (and (eq major-mode 'org-mode)
  11069. (setq bfn (buffer-file-name b))
  11070. (member (file-truename bfn) agenda-files)))))
  11071. (t (lambda (b) (with-current-buffer b
  11072. (or (eq major-mode 'org-mode)
  11073. (string-match "\*Org .*Export"
  11074. (buffer-name b)))))))))
  11075. (delq nil
  11076. (mapcar
  11077. (lambda(b)
  11078. (if (and (funcall filter b)
  11079. (or (not exclude-tmp)
  11080. (not (string-match "tmp" (buffer-name b)))))
  11081. b
  11082. nil))
  11083. (buffer-list)))))
  11084. (defun org-agenda-files (&optional unrestricted archives)
  11085. "Get the list of agenda files.
  11086. Optional UNRESTRICTED means return the full list even if a restriction
  11087. is currently in place.
  11088. When ARCHIVES is t, include all archive files hat are really being
  11089. used by the agenda files. If ARCHIVE is `ifmode', do this only if
  11090. `org-agenda-archives-mode' is t."
  11091. (let ((files
  11092. (cond
  11093. ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
  11094. ((stringp org-agenda-files) (org-read-agenda-file-list))
  11095. ((listp org-agenda-files) org-agenda-files)
  11096. (t (error "Invalid value of `org-agenda-files'")))))
  11097. (setq files (apply 'append
  11098. (mapcar (lambda (f)
  11099. (if (file-directory-p f)
  11100. (directory-files
  11101. f t org-agenda-file-regexp)
  11102. (list f)))
  11103. files)))
  11104. (when org-agenda-skip-unavailable-files
  11105. (setq files (delq nil
  11106. (mapcar (function
  11107. (lambda (file)
  11108. (and (file-readable-p file) file)))
  11109. files))))
  11110. (when (or (eq archives t)
  11111. (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
  11112. (setq files (org-add-archive-files files)))
  11113. files))
  11114. (defun org-edit-agenda-file-list ()
  11115. "Edit the list of agenda files.
  11116. Depending on setup, this either uses customize to edit the variable
  11117. `org-agenda-files', or it visits the file that is holding the list. In the
  11118. latter case, the buffer is set up in a way that saving it automatically kills
  11119. the buffer and restores the previous window configuration."
  11120. (interactive)
  11121. (if (stringp org-agenda-files)
  11122. (let ((cw (current-window-configuration)))
  11123. (find-file org-agenda-files)
  11124. (org-set-local 'org-window-configuration cw)
  11125. (org-add-hook 'after-save-hook
  11126. (lambda ()
  11127. (set-window-configuration
  11128. (prog1 org-window-configuration
  11129. (kill-buffer (current-buffer))))
  11130. (org-install-agenda-files-menu)
  11131. (message "New agenda file list installed"))
  11132. nil 'local)
  11133. (message "%s" (substitute-command-keys
  11134. "Edit list and finish with \\[save-buffer]")))
  11135. (customize-variable 'org-agenda-files)))
  11136. (defun org-store-new-agenda-file-list (list)
  11137. "Set new value for the agenda file list and save it correcly."
  11138. (if (stringp org-agenda-files)
  11139. (let ((f org-agenda-files) b)
  11140. (while (setq b (find-buffer-visiting f)) (kill-buffer b))
  11141. (with-temp-file f
  11142. (insert (mapconcat 'identity list "\n") "\n")))
  11143. (let ((org-mode-hook nil) (default-major-mode 'fundamental-mode))
  11144. (setq org-agenda-files list)
  11145. (customize-save-variable 'org-agenda-files org-agenda-files))))
  11146. (defun org-read-agenda-file-list ()
  11147. "Read the list of agenda files from a file."
  11148. (when (file-directory-p org-agenda-files)
  11149. (error "`org-agenda-files' cannot be a single directory"))
  11150. (when (stringp org-agenda-files)
  11151. (with-temp-buffer
  11152. (insert-file-contents org-agenda-files)
  11153. (org-split-string (buffer-string) "[ \t\r\n]*?[\r\n][ \t\r\n]*"))))
  11154. ;;;###autoload
  11155. (defun org-cycle-agenda-files ()
  11156. "Cycle through the files in `org-agenda-files'.
  11157. If the current buffer visits an agenda file, find the next one in the list.
  11158. If the current buffer does not, find the first agenda file."
  11159. (interactive)
  11160. (let* ((fs (org-agenda-files t))
  11161. (files (append fs (list (car fs))))
  11162. (tcf (if buffer-file-name (file-truename buffer-file-name)))
  11163. file)
  11164. (unless files (error "No agenda files"))
  11165. (catch 'exit
  11166. (while (setq file (pop files))
  11167. (if (equal (file-truename file) tcf)
  11168. (when (car files)
  11169. (find-file (car files))
  11170. (throw 'exit t))))
  11171. (find-file (car fs)))
  11172. (if (buffer-base-buffer) (switch-to-buffer (buffer-base-buffer)))))
  11173. (defun org-agenda-file-to-front (&optional to-end)
  11174. "Move/add the current file to the top of the agenda file list.
  11175. If the file is not present in the list, it is added to the front. If it is
  11176. present, it is moved there. With optional argument TO-END, add/move to the
  11177. end of the list."
  11178. (interactive "P")
  11179. (let ((org-agenda-skip-unavailable-files nil)
  11180. (file-alist (mapcar (lambda (x)
  11181. (cons (file-truename x) x))
  11182. (org-agenda-files t)))
  11183. (ctf (file-truename buffer-file-name))
  11184. x had)
  11185. (setq x (assoc ctf file-alist) had x)
  11186. (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
  11187. (if to-end
  11188. (setq file-alist (append (delq x file-alist) (list x)))
  11189. (setq file-alist (cons x (delq x file-alist))))
  11190. (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
  11191. (org-install-agenda-files-menu)
  11192. (message "File %s to %s of agenda file list"
  11193. (if had "moved" "added") (if to-end "end" "front"))))
  11194. (defun org-remove-file (&optional file)
  11195. "Remove current file from the list of files in variable `org-agenda-files'.
  11196. These are the files which are being checked for agenda entries.
  11197. Optional argument FILE means, use this file instead of the current."
  11198. (interactive)
  11199. (let* ((org-agenda-skip-unavailable-files nil)
  11200. (file (or file buffer-file-name))
  11201. (true-file (file-truename file))
  11202. (afile (abbreviate-file-name file))
  11203. (files (delq nil (mapcar
  11204. (lambda (x)
  11205. (if (equal true-file
  11206. (file-truename x))
  11207. nil x))
  11208. (org-agenda-files t)))))
  11209. (if (not (= (length files) (length (org-agenda-files t))))
  11210. (progn
  11211. (org-store-new-agenda-file-list files)
  11212. (org-install-agenda-files-menu)
  11213. (message "Removed file: %s" afile))
  11214. (message "File was not in list: %s (not removed)" afile))))
  11215. (defun org-file-menu-entry (file)
  11216. (vector file (list 'find-file file) t))
  11217. (defun org-check-agenda-file (file)
  11218. "Make sure FILE exists. If not, ask user what to do."
  11219. (when (not (file-exists-p file))
  11220. (message "non-existent file %s. [R]emove from list or [A]bort?"
  11221. (abbreviate-file-name file))
  11222. (let ((r (downcase (read-char-exclusive))))
  11223. (cond
  11224. ((equal r ?r)
  11225. (org-remove-file file)
  11226. (throw 'nextfile t))
  11227. (t (error "Abort"))))))
  11228. (defun org-get-agenda-file-buffer (file)
  11229. "Get a buffer visiting FILE. If the buffer needs to be created, add
  11230. it to the list of buffers which might be released later."
  11231. (let ((buf (org-find-base-buffer-visiting file)))
  11232. (if buf
  11233. buf ; just return it
  11234. ;; Make a new buffer and remember it
  11235. (setq buf (find-file-noselect file))
  11236. (if buf (push buf org-agenda-new-buffers))
  11237. buf)))
  11238. (defun org-release-buffers (blist)
  11239. "Release all buffers in list, asking the user for confirmation when needed.
  11240. When a buffer is unmodified, it is just killed. When modified, it is saved
  11241. \(if the user agrees) and then killed."
  11242. (let (buf file)
  11243. (while (setq buf (pop blist))
  11244. (setq file (buffer-file-name buf))
  11245. (when (and (buffer-modified-p buf)
  11246. file
  11247. (y-or-n-p (format "Save file %s? " file)))
  11248. (with-current-buffer buf (save-buffer)))
  11249. (kill-buffer buf))))
  11250. (defun org-prepare-agenda-buffers (files)
  11251. "Create buffers for all agenda files, protect archived trees and comments."
  11252. (interactive)
  11253. (let ((pa '(:org-archived t))
  11254. (pc '(:org-comment t))
  11255. (pall '(:org-archived t :org-comment t))
  11256. (inhibit-read-only t)
  11257. (rea (concat ":" org-archive-tag ":"))
  11258. bmp file re)
  11259. (save-excursion
  11260. (save-restriction
  11261. (while (setq file (pop files))
  11262. (if (bufferp file)
  11263. (set-buffer file)
  11264. (org-check-agenda-file file)
  11265. (set-buffer (org-get-agenda-file-buffer file)))
  11266. (widen)
  11267. (setq bmp (buffer-modified-p))
  11268. (org-refresh-category-properties)
  11269. (setq org-todo-keywords-for-agenda
  11270. (append org-todo-keywords-for-agenda org-todo-keywords-1))
  11271. (setq org-done-keywords-for-agenda
  11272. (append org-done-keywords-for-agenda org-done-keywords))
  11273. (setq org-todo-keyword-alist-for-agenda
  11274. (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
  11275. (setq org-tag-alist-for-agenda
  11276. (append org-tag-alist-for-agenda org-tag-alist))
  11277. (save-excursion
  11278. (remove-text-properties (point-min) (point-max) pall)
  11279. (when org-agenda-skip-archived-trees
  11280. (goto-char (point-min))
  11281. (while (re-search-forward rea nil t)
  11282. (if (org-on-heading-p t)
  11283. (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
  11284. (goto-char (point-min))
  11285. (setq re (concat "^\\*+ +" org-comment-string "\\>"))
  11286. (while (re-search-forward re nil t)
  11287. (add-text-properties
  11288. (match-beginning 0) (org-end-of-subtree t) pc)))
  11289. (set-buffer-modified-p bmp))))
  11290. (setq org-todo-keyword-alist-for-agenda
  11291. (org-uniquify org-todo-keyword-alist-for-agenda)
  11292. org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
  11293. ;;;; Embedded LaTeX
  11294. (defvar org-cdlatex-mode-map (make-sparse-keymap)
  11295. "Keymap for the minor `org-cdlatex-mode'.")
  11296. (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
  11297. (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
  11298. (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
  11299. (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
  11300. (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
  11301. (defvar org-cdlatex-texmathp-advice-is-done nil
  11302. "Flag remembering if we have applied the advice to texmathp already.")
  11303. (define-minor-mode org-cdlatex-mode
  11304. "Toggle the minor `org-cdlatex-mode'.
  11305. This mode supports entering LaTeX environment and math in LaTeX fragments
  11306. in Org-mode.
  11307. \\{org-cdlatex-mode-map}"
  11308. nil " OCDL" nil
  11309. (when org-cdlatex-mode (require 'cdlatex))
  11310. (unless org-cdlatex-texmathp-advice-is-done
  11311. (setq org-cdlatex-texmathp-advice-is-done t)
  11312. (defadvice texmathp (around org-math-always-on activate)
  11313. "Always return t in org-mode buffers.
  11314. This is because we want to insert math symbols without dollars even outside
  11315. the LaTeX math segments. If Orgmode thinks that point is actually inside
  11316. en embedded LaTeX fragement, let texmathp do its job.
  11317. \\[org-cdlatex-mode-map]"
  11318. (interactive)
  11319. (let (p)
  11320. (cond
  11321. ((not (org-mode-p)) ad-do-it)
  11322. ((eq this-command 'cdlatex-math-symbol)
  11323. (setq ad-return-value t
  11324. texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
  11325. (t
  11326. (let ((p (org-inside-LaTeX-fragment-p)))
  11327. (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
  11328. (setq ad-return-value t
  11329. texmathp-why '("Org-mode embedded math" . 0))
  11330. (if p ad-do-it)))))))))
  11331. (defun turn-on-org-cdlatex ()
  11332. "Unconditionally turn on `org-cdlatex-mode'."
  11333. (org-cdlatex-mode 1))
  11334. (defun org-inside-LaTeX-fragment-p ()
  11335. "Test if point is inside a LaTeX fragment.
  11336. I.e. after a \\begin, \\(, \\[, $, or $$, without the corresponding closing
  11337. sequence appearing also before point.
  11338. Even though the matchers for math are configurable, this function assumes
  11339. that \\begin, \\(, \\[, and $$ are always used. Only the single dollar
  11340. delimiters are skipped when they have been removed by customization.
  11341. The return value is nil, or a cons cell with the delimiter and
  11342. and the position of this delimiter.
  11343. This function does a reasonably good job, but can locally be fooled by
  11344. for example currency specifications. For example it will assume being in
  11345. inline math after \"$22.34\". The LaTeX fragment formatter will only format
  11346. fragments that are properly closed, but during editing, we have to live
  11347. with the uncertainty caused by missing closing delimiters. This function
  11348. looks only before point, not after."
  11349. (catch 'exit
  11350. (let ((pos (point))
  11351. (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
  11352. (lim (progn
  11353. (re-search-backward (concat "^\\(" paragraph-start "\\)") nil t)
  11354. (point)))
  11355. dd-on str (start 0) m re)
  11356. (goto-char pos)
  11357. (when dodollar
  11358. (setq str (concat (buffer-substring lim (point)) "\000 X$.")
  11359. re (nth 1 (assoc "$" org-latex-regexps)))
  11360. (while (string-match re str start)
  11361. (cond
  11362. ((= (match-end 0) (length str))
  11363. (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
  11364. ((= (match-end 0) (- (length str) 5))
  11365. (throw 'exit nil))
  11366. (t (setq start (match-end 0))))))
  11367. (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
  11368. (goto-char pos)
  11369. (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
  11370. (and (match-beginning 2) (throw 'exit nil))
  11371. ;; count $$
  11372. (while (re-search-backward "\\$\\$" lim t)
  11373. (setq dd-on (not dd-on)))
  11374. (goto-char pos)
  11375. (if dd-on (cons "$$" m))))))
  11376. (defun org-try-cdlatex-tab ()
  11377. "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
  11378. It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
  11379. - inside a LaTeX fragment, or
  11380. - after the first word in a line, where an abbreviation expansion could
  11381. insert a LaTeX environment."
  11382. (when org-cdlatex-mode
  11383. (cond
  11384. ((save-excursion
  11385. (skip-chars-backward "a-zA-Z0-9*")
  11386. (skip-chars-backward " \t")
  11387. (bolp))
  11388. (cdlatex-tab) t)
  11389. ((org-inside-LaTeX-fragment-p)
  11390. (cdlatex-tab) t)
  11391. (t nil))))
  11392. (defun org-cdlatex-underscore-caret (&optional arg)
  11393. "Execute `cdlatex-sub-superscript' in LaTeX fragments.
  11394. Revert to the normal definition outside of these fragments."
  11395. (interactive "P")
  11396. (if (org-inside-LaTeX-fragment-p)
  11397. (call-interactively 'cdlatex-sub-superscript)
  11398. (let (org-cdlatex-mode)
  11399. (call-interactively (key-binding (vector last-input-event))))))
  11400. (defun org-cdlatex-math-modify (&optional arg)
  11401. "Execute `cdlatex-math-modify' in LaTeX fragments.
  11402. Revert to the normal definition outside of these fragments."
  11403. (interactive "P")
  11404. (if (org-inside-LaTeX-fragment-p)
  11405. (call-interactively 'cdlatex-math-modify)
  11406. (let (org-cdlatex-mode)
  11407. (call-interactively (key-binding (vector last-input-event))))))
  11408. (defvar org-latex-fragment-image-overlays nil
  11409. "List of overlays carrying the images of latex fragments.")
  11410. (make-variable-buffer-local 'org-latex-fragment-image-overlays)
  11411. (defun org-remove-latex-fragment-image-overlays ()
  11412. "Remove all overlays with LaTeX fragment images in current buffer."
  11413. (mapc 'org-delete-overlay org-latex-fragment-image-overlays)
  11414. (setq org-latex-fragment-image-overlays nil))
  11415. (defun org-preview-latex-fragment (&optional subtree)
  11416. "Preview the LaTeX fragment at point, or all locally or globally.
  11417. If the cursor is in a LaTeX fragment, create the image and overlay
  11418. it over the source code. If there is no fragment at point, display
  11419. all fragments in the current text, from one headline to the next. With
  11420. prefix SUBTREE, display all fragments in the current subtree. With a
  11421. double prefix `C-u C-u', or when the cursor is before the first headline,
  11422. display all fragments in the buffer.
  11423. The images can be removed again with \\[org-ctrl-c-ctrl-c]."
  11424. (interactive "P")
  11425. (org-remove-latex-fragment-image-overlays)
  11426. (save-excursion
  11427. (save-restriction
  11428. (let (beg end at msg)
  11429. (cond
  11430. ((or (equal subtree '(16))
  11431. (not (save-excursion
  11432. (re-search-backward (concat "^" outline-regexp) nil t))))
  11433. (setq beg (point-min) end (point-max)
  11434. msg "Creating images for buffer...%s"))
  11435. ((equal subtree '(4))
  11436. (org-back-to-heading)
  11437. (setq beg (point) end (org-end-of-subtree t)
  11438. msg "Creating images for subtree...%s"))
  11439. (t
  11440. (if (setq at (org-inside-LaTeX-fragment-p))
  11441. (goto-char (max (point-min) (- (cdr at) 2)))
  11442. (org-back-to-heading))
  11443. (setq beg (point) end (progn (outline-next-heading) (point))
  11444. msg (if at "Creating image...%s"
  11445. "Creating images for entry...%s"))))
  11446. (message msg "")
  11447. (narrow-to-region beg end)
  11448. (goto-char beg)
  11449. (org-format-latex
  11450. (concat "ltxpng/" (file-name-sans-extension
  11451. (file-name-nondirectory
  11452. buffer-file-name)))
  11453. default-directory 'overlays msg at 'forbuffer)
  11454. (message msg "done. Use `C-c C-c' to remove images.")))))
  11455. (defvar org-latex-regexps
  11456. '(("begin" "^[ \t]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^\000]+?\\\\end{\\2}\\)" 1 t)
  11457. ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
  11458. ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
  11459. ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([ .,?;:'\")\000]\\|$\\)" 2 nil)
  11460. ("\\(" "\\\\([^\000]*?\\\\)" 0 nil)
  11461. ("\\[" "\\\\\\[[^\000]*?\\\\\\]" 0 t)
  11462. ("$$" "\\$\\$[^\000]*?\\$\\$" 0 t))
  11463. "Regular expressions for matching embedded LaTeX.")
  11464. (defun org-format-latex (prefix &optional dir overlays msg at forbuffer)
  11465. "Replace LaTeX fragments with links to an image, and produce images."
  11466. (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
  11467. (let* ((prefixnodir (file-name-nondirectory prefix))
  11468. (absprefix (expand-file-name prefix dir))
  11469. (todir (file-name-directory absprefix))
  11470. (opt org-format-latex-options)
  11471. (matchers (plist-get opt :matchers))
  11472. (re-list org-latex-regexps)
  11473. (cnt 0) txt link beg end re e checkdir
  11474. m n block linkfile movefile ov)
  11475. ;; Check if there are old images files with this prefix, and remove them
  11476. (when (file-directory-p todir)
  11477. (mapc 'delete-file
  11478. (directory-files
  11479. todir 'full
  11480. (concat (regexp-quote prefixnodir) "_[0-9]+\\.png$"))))
  11481. ;; Check the different regular expressions
  11482. (while (setq e (pop re-list))
  11483. (setq m (car e) re (nth 1 e) n (nth 2 e)
  11484. block (if (nth 3 e) "\n\n" ""))
  11485. (when (member m matchers)
  11486. (goto-char (point-min))
  11487. (while (re-search-forward re nil t)
  11488. (when (or (not at) (equal (cdr at) (match-beginning n)))
  11489. (setq txt (match-string n)
  11490. beg (match-beginning n) end (match-end n)
  11491. cnt (1+ cnt)
  11492. linkfile (format "%s_%04d.png" prefix cnt)
  11493. movefile (format "%s_%04d.png" absprefix cnt)
  11494. link (concat block "[[file:" linkfile "]]" block))
  11495. (if msg (message msg cnt))
  11496. (goto-char beg)
  11497. (unless checkdir ; make sure the directory exists
  11498. (setq checkdir t)
  11499. (or (file-directory-p todir) (make-directory todir)))
  11500. (org-create-formula-image
  11501. txt movefile opt forbuffer)
  11502. (if overlays
  11503. (progn
  11504. (setq ov (org-make-overlay beg end))
  11505. (if (featurep 'xemacs)
  11506. (progn
  11507. (org-overlay-put ov 'invisible t)
  11508. (org-overlay-put
  11509. ov 'end-glyph
  11510. (make-glyph (vector 'png :file movefile))))
  11511. (org-overlay-put
  11512. ov 'display
  11513. (list 'image :type 'png :file movefile :ascent 'center)))
  11514. (push ov org-latex-fragment-image-overlays)
  11515. (goto-char end))
  11516. (delete-region beg end)
  11517. (insert link))))))))
  11518. ;; This function borrows from Ganesh Swami's latex2png.el
  11519. (defun org-create-formula-image (string tofile options buffer)
  11520. (let* ((tmpdir (if (featurep 'xemacs)
  11521. (temp-directory)
  11522. temporary-file-directory))
  11523. (texfilebase (make-temp-name
  11524. (expand-file-name "orgtex" tmpdir)))
  11525. (texfile (concat texfilebase ".tex"))
  11526. (dvifile (concat texfilebase ".dvi"))
  11527. (pngfile (concat texfilebase ".png"))
  11528. (fnh (if (featurep 'xemacs)
  11529. (font-height (get-face-font 'default))
  11530. (face-attribute 'default :height nil)))
  11531. (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
  11532. (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
  11533. (fg (or (plist-get options (if buffer :foreground :html-foreground))
  11534. "Black"))
  11535. (bg (or (plist-get options (if buffer :background :html-background))
  11536. "Transparent")))
  11537. (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
  11538. (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
  11539. (with-temp-file texfile
  11540. (insert org-format-latex-header
  11541. "\n\\begin{document}\n" string "\n\\end{document}\n"))
  11542. (let ((dir default-directory))
  11543. (condition-case nil
  11544. (progn
  11545. (cd tmpdir)
  11546. (call-process "latex" nil nil nil texfile))
  11547. (error nil))
  11548. (cd dir))
  11549. (if (not (file-exists-p dvifile))
  11550. (progn (message "Failed to create dvi file from %s" texfile) nil)
  11551. (condition-case nil
  11552. (call-process "dvipng" nil nil nil
  11553. "-E" "-fg" fg "-bg" bg
  11554. "-D" dpi
  11555. ;;"-x" scale "-y" scale
  11556. "-T" "tight"
  11557. "-o" pngfile
  11558. dvifile)
  11559. (error nil))
  11560. (if (not (file-exists-p pngfile))
  11561. (progn (message "Failed to create png file from %s" texfile) nil)
  11562. ;; Use the requested file name and clean up
  11563. (copy-file pngfile tofile 'replace)
  11564. (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png") do
  11565. (delete-file (concat texfilebase e)))
  11566. pngfile))))
  11567. (defun org-dvipng-color (attr)
  11568. "Return an rgb color specification for dvipng."
  11569. (apply 'format "rgb %s %s %s"
  11570. (mapcar 'org-normalize-color
  11571. (color-values (face-attribute 'default attr nil)))))
  11572. (defun org-normalize-color (value)
  11573. "Return string to be used as color value for an RGB component."
  11574. (format "%g" (/ value 65535.0)))
  11575. ;;;; Key bindings
  11576. ;; Make `C-c C-x' a prefix key
  11577. (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
  11578. ;; TAB key with modifiers
  11579. (org-defkey org-mode-map "\C-i" 'org-cycle)
  11580. (org-defkey org-mode-map [(tab)] 'org-cycle)
  11581. (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
  11582. (org-defkey org-mode-map [(meta tab)] 'org-complete)
  11583. (org-defkey org-mode-map "\M-\t" 'org-complete)
  11584. (org-defkey org-mode-map "\M-\C-i" 'org-complete)
  11585. ;; The following line is necessary under Suse GNU/Linux
  11586. (unless (featurep 'xemacs)
  11587. (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
  11588. (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
  11589. (define-key org-mode-map [backtab] 'org-shifttab)
  11590. (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
  11591. (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
  11592. (org-defkey org-mode-map [(meta return)] 'org-meta-return)
  11593. ;; Cursor keys with modifiers
  11594. (org-defkey org-mode-map [(meta left)] 'org-metaleft)
  11595. (org-defkey org-mode-map [(meta right)] 'org-metaright)
  11596. (org-defkey org-mode-map [(meta up)] 'org-metaup)
  11597. (org-defkey org-mode-map [(meta down)] 'org-metadown)
  11598. (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
  11599. (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
  11600. (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
  11601. (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
  11602. (org-defkey org-mode-map [(shift up)] 'org-shiftup)
  11603. (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
  11604. (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
  11605. (org-defkey org-mode-map [(shift right)] 'org-shiftright)
  11606. (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
  11607. (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
  11608. ;;; Extra keys for tty access.
  11609. ;; We only set them when really needed because otherwise the
  11610. ;; menus don't show the simple keys
  11611. (when (or org-use-extra-keys
  11612. (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
  11613. (not window-system))
  11614. (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
  11615. (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
  11616. (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
  11617. (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
  11618. (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
  11619. (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
  11620. (org-defkey org-mode-map [?\e (right)] 'org-metaright)
  11621. (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
  11622. (org-defkey org-mode-map [?\e (up)] 'org-metaup)
  11623. (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
  11624. (org-defkey org-mode-map [?\e (down)] 'org-metadown)
  11625. (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
  11626. (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
  11627. (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
  11628. (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
  11629. (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
  11630. (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
  11631. (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
  11632. (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
  11633. (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
  11634. (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
  11635. (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft))
  11636. ;; All the other keys
  11637. (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
  11638. (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
  11639. (if (boundp 'narrow-map)
  11640. (org-defkey narrow-map "s" 'org-narrow-to-subtree)
  11641. (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
  11642. (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
  11643. (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
  11644. (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-toggle-archive-tag)
  11645. (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
  11646. (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
  11647. (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
  11648. (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
  11649. (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
  11650. (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
  11651. (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
  11652. (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
  11653. (org-defkey org-mode-map "\C-c\C-v" 'org-show-todo-tree)
  11654. (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
  11655. (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
  11656. (org-defkey org-mode-map "\C-c\\" 'org-tags-sparse-tree) ; Minor-mode res.
  11657. (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
  11658. (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
  11659. (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
  11660. (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
  11661. (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
  11662. (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
  11663. (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
  11664. (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
  11665. (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
  11666. (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
  11667. (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
  11668. (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
  11669. (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
  11670. (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
  11671. (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
  11672. (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
  11673. (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
  11674. (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
  11675. (org-defkey org-mode-map [(control ?\')] 'org-cycle-agenda-files)
  11676. (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
  11677. (org-defkey org-mode-map "\C-c]" 'org-remove-file)
  11678. (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
  11679. (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
  11680. (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
  11681. (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
  11682. (org-defkey org-mode-map "\C-c^" 'org-sort)
  11683. (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
  11684. (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
  11685. (org-defkey org-mode-map "\C-c#" 'org-update-checkbox-count)
  11686. (org-defkey org-mode-map "\C-m" 'org-return)
  11687. (org-defkey org-mode-map "\C-j" 'org-return-indent)
  11688. (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
  11689. (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
  11690. (org-defkey org-mode-map "\C-c+" 'org-table-sum)
  11691. (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
  11692. (org-defkey org-mode-map "\C-c'" 'org-edit-special)
  11693. (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
  11694. (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
  11695. (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
  11696. (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
  11697. (org-defkey org-mode-map "\C-c\C-q" 'org-table-wrap-region)
  11698. (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
  11699. (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
  11700. (org-defkey org-mode-map "\C-c\C-e" 'org-export)
  11701. (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
  11702. (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
  11703. (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
  11704. (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
  11705. (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
  11706. (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
  11707. (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
  11708. (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
  11709. (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
  11710. (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
  11711. (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
  11712. (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
  11713. (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
  11714. (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
  11715. (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
  11716. (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
  11717. (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
  11718. (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
  11719. (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
  11720. (when (featurep 'xemacs)
  11721. (org-defkey org-mode-map 'button3 'popup-mode-menu))
  11722. (defvar org-table-auto-blank-field) ; defined in org-table.el
  11723. (defun org-self-insert-command (N)
  11724. "Like `self-insert-command', use overwrite-mode for whitespace in tables.
  11725. If the cursor is in a table looking at whitespace, the whitespace is
  11726. overwritten, and the table is not marked as requiring realignment."
  11727. (interactive "p")
  11728. (if (and (org-table-p)
  11729. (progn
  11730. ;; check if we blank the field, and if that triggers align
  11731. (and (featurep 'org-table) org-table-auto-blank-field
  11732. (member last-command
  11733. '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c))
  11734. (if (or (equal (char-after) ?\ ) (looking-at "[^|\n]* |"))
  11735. ;; got extra space, this field does not determine column width
  11736. (let (org-table-may-need-update) (org-table-blank-field))
  11737. ;; no extra space, this field may determine column width
  11738. (org-table-blank-field)))
  11739. t)
  11740. (eq N 1)
  11741. (looking-at "[^|\n]* |"))
  11742. (let (org-table-may-need-update)
  11743. (goto-char (1- (match-end 0)))
  11744. (delete-backward-char 1)
  11745. (goto-char (match-beginning 0))
  11746. (self-insert-command N))
  11747. (setq org-table-may-need-update t)
  11748. (self-insert-command N)
  11749. (org-fix-tags-on-the-fly)))
  11750. (defun org-fix-tags-on-the-fly ()
  11751. (when (and (equal (char-after (point-at-bol)) ?*)
  11752. (org-on-heading-p))
  11753. (org-align-tags-here org-tags-column)))
  11754. (defun org-delete-backward-char (N)
  11755. "Like `delete-backward-char', insert whitespace at field end in tables.
  11756. When deleting backwards, in tables this function will insert whitespace in
  11757. front of the next \"|\" separator, to keep the table aligned. The table will
  11758. still be marked for re-alignment if the field did fill the entire column,
  11759. because, in this case the deletion might narrow the column."
  11760. (interactive "p")
  11761. (if (and (org-table-p)
  11762. (eq N 1)
  11763. (string-match "|" (buffer-substring (point-at-bol) (point)))
  11764. (looking-at ".*?|"))
  11765. (let ((pos (point))
  11766. (noalign (looking-at "[^|\n\r]* |"))
  11767. (c org-table-may-need-update))
  11768. (backward-delete-char N)
  11769. (skip-chars-forward "^|")
  11770. (insert " ")
  11771. (goto-char (1- pos))
  11772. ;; noalign: if there were two spaces at the end, this field
  11773. ;; does not determine the width of the column.
  11774. (if noalign (setq org-table-may-need-update c)))
  11775. (backward-delete-char N)
  11776. (org-fix-tags-on-the-fly)))
  11777. (defun org-delete-char (N)
  11778. "Like `delete-char', but insert whitespace at field end in tables.
  11779. When deleting characters, in tables this function will insert whitespace in
  11780. front of the next \"|\" separator, to keep the table aligned. The table will
  11781. still be marked for re-alignment if the field did fill the entire column,
  11782. because, in this case the deletion might narrow the column."
  11783. (interactive "p")
  11784. (if (and (org-table-p)
  11785. (not (bolp))
  11786. (not (= (char-after) ?|))
  11787. (eq N 1))
  11788. (if (looking-at ".*?|")
  11789. (let ((pos (point))
  11790. (noalign (looking-at "[^|\n\r]* |"))
  11791. (c org-table-may-need-update))
  11792. (replace-match (concat
  11793. (substring (match-string 0) 1 -1)
  11794. " |"))
  11795. (goto-char pos)
  11796. ;; noalign: if there were two spaces at the end, this field
  11797. ;; does not determine the width of the column.
  11798. (if noalign (setq org-table-may-need-update c)))
  11799. (delete-char N))
  11800. (delete-char N)
  11801. (org-fix-tags-on-the-fly)))
  11802. ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
  11803. (put 'org-self-insert-command 'delete-selection t)
  11804. (put 'orgtbl-self-insert-command 'delete-selection t)
  11805. (put 'org-delete-char 'delete-selection 'supersede)
  11806. (put 'org-delete-backward-char 'delete-selection 'supersede)
  11807. ;; Make `flyspell-mode' delay after some commands
  11808. (put 'org-self-insert-command 'flyspell-delayed t)
  11809. (put 'orgtbl-self-insert-command 'flyspell-delayed t)
  11810. (put 'org-delete-char 'flyspell-delayed t)
  11811. (put 'org-delete-backward-char 'flyspell-delayed t)
  11812. ;; Make pabbrev-mode expand after org-mode commands
  11813. (put 'org-self-insert-command 'pabbrev-expand-after-command t)
  11814. (put 'orgybl-self-insert-command 'pabbrev-expand-after-command t)
  11815. ;; How to do this: Measure non-white length of current string
  11816. ;; If equal to column width, we should realign.
  11817. (defun org-remap (map &rest commands)
  11818. "In MAP, remap the functions given in COMMANDS.
  11819. COMMANDS is a list of alternating OLDDEF NEWDEF command names."
  11820. (let (new old)
  11821. (while commands
  11822. (setq old (pop commands) new (pop commands))
  11823. (if (fboundp 'command-remapping)
  11824. (org-defkey map (vector 'remap old) new)
  11825. (substitute-key-definition old new map global-map)))))
  11826. (when (eq org-enable-table-editor 'optimized)
  11827. ;; If the user wants maximum table support, we need to hijack
  11828. ;; some standard editing functions
  11829. (org-remap org-mode-map
  11830. 'self-insert-command 'org-self-insert-command
  11831. 'delete-char 'org-delete-char
  11832. 'delete-backward-char 'org-delete-backward-char)
  11833. (org-defkey org-mode-map "|" 'org-force-self-insert))
  11834. (defun org-shiftcursor-error ()
  11835. "Throw an error because Shift-Cursor command was applied in wrong context."
  11836. (error "This command is active in special context like tables, headlines or timestamps"))
  11837. (defun org-shifttab (&optional arg)
  11838. "Global visibility cycling or move to previous table field.
  11839. Calls `org-cycle' with argument t, or `org-table-previous-field', depending
  11840. on context.
  11841. See the individual commands for more information."
  11842. (interactive "P")
  11843. (cond
  11844. ((org-at-table-p) (call-interactively 'org-table-previous-field))
  11845. ((integerp arg)
  11846. (message "Content view to level: %d" arg)
  11847. (org-content (prefix-numeric-value arg))
  11848. (setq org-cycle-global-status 'overview))
  11849. (t (call-interactively 'org-global-cycle))))
  11850. (defun org-shiftmetaleft ()
  11851. "Promote subtree or delete table column.
  11852. Calls `org-promote-subtree', `org-outdent-item',
  11853. or `org-table-delete-column', depending on context.
  11854. See the individual commands for more information."
  11855. (interactive)
  11856. (cond
  11857. ((org-at-table-p) (call-interactively 'org-table-delete-column))
  11858. ((org-on-heading-p) (call-interactively 'org-promote-subtree))
  11859. ((org-at-item-p) (call-interactively 'org-outdent-item))
  11860. (t (org-shiftcursor-error))))
  11861. (defun org-shiftmetaright ()
  11862. "Demote subtree or insert table column.
  11863. Calls `org-demote-subtree', `org-indent-item',
  11864. or `org-table-insert-column', depending on context.
  11865. See the individual commands for more information."
  11866. (interactive)
  11867. (cond
  11868. ((org-at-table-p) (call-interactively 'org-table-insert-column))
  11869. ((org-on-heading-p) (call-interactively 'org-demote-subtree))
  11870. ((org-at-item-p) (call-interactively 'org-indent-item))
  11871. (t (org-shiftcursor-error))))
  11872. (defun org-shiftmetaup (&optional arg)
  11873. "Move subtree up or kill table row.
  11874. Calls `org-move-subtree-up' or `org-table-kill-row' or
  11875. `org-move-item-up' depending on context. See the individual commands
  11876. for more information."
  11877. (interactive "P")
  11878. (cond
  11879. ((org-at-table-p) (call-interactively 'org-table-kill-row))
  11880. ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
  11881. ((org-at-item-p) (call-interactively 'org-move-item-up))
  11882. (t (org-shiftcursor-error))))
  11883. (defun org-shiftmetadown (&optional arg)
  11884. "Move subtree down or insert table row.
  11885. Calls `org-move-subtree-down' or `org-table-insert-row' or
  11886. `org-move-item-down', depending on context. See the individual
  11887. commands for more information."
  11888. (interactive "P")
  11889. (cond
  11890. ((org-at-table-p) (call-interactively 'org-table-insert-row))
  11891. ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
  11892. ((org-at-item-p) (call-interactively 'org-move-item-down))
  11893. (t (org-shiftcursor-error))))
  11894. (defun org-metaleft (&optional arg)
  11895. "Promote heading or move table column to left.
  11896. Calls `org-do-promote' or `org-table-move-column', depending on context.
  11897. With no specific context, calls the Emacs default `backward-word'.
  11898. See the individual commands for more information."
  11899. (interactive "P")
  11900. (cond
  11901. ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
  11902. ((or (org-on-heading-p) (org-region-active-p))
  11903. (call-interactively 'org-do-promote))
  11904. ((org-at-item-p) (call-interactively 'org-outdent-item))
  11905. (t (call-interactively 'backward-word))))
  11906. (defun org-metaright (&optional arg)
  11907. "Demote subtree or move table column to right.
  11908. Calls `org-do-demote' or `org-table-move-column', depending on context.
  11909. With no specific context, calls the Emacs default `forward-word'.
  11910. See the individual commands for more information."
  11911. (interactive "P")
  11912. (cond
  11913. ((org-at-table-p) (call-interactively 'org-table-move-column))
  11914. ((or (org-on-heading-p) (org-region-active-p))
  11915. (call-interactively 'org-do-demote))
  11916. ((org-at-item-p) (call-interactively 'org-indent-item))
  11917. (t (call-interactively 'forward-word))))
  11918. (defun org-metaup (&optional arg)
  11919. "Move subtree up or move table row up.
  11920. Calls `org-move-subtree-up' or `org-table-move-row' or
  11921. `org-move-item-up', depending on context. See the individual commands
  11922. for more information."
  11923. (interactive "P")
  11924. (cond
  11925. ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
  11926. ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
  11927. ((org-at-item-p) (call-interactively 'org-move-item-up))
  11928. (t (transpose-lines 1) (beginning-of-line -1))))
  11929. (defun org-metadown (&optional arg)
  11930. "Move subtree down or move table row down.
  11931. Calls `org-move-subtree-down' or `org-table-move-row' or
  11932. `org-move-item-down', depending on context. See the individual
  11933. commands for more information."
  11934. (interactive "P")
  11935. (cond
  11936. ((org-at-table-p) (call-interactively 'org-table-move-row))
  11937. ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
  11938. ((org-at-item-p) (call-interactively 'org-move-item-down))
  11939. (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
  11940. (defun org-shiftup (&optional arg)
  11941. "Increase item in timestamp or increase priority of current headline.
  11942. Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
  11943. depending on context. See the individual commands for more information."
  11944. (interactive "P")
  11945. (cond
  11946. ((org-at-timestamp-p t)
  11947. (call-interactively (if org-edit-timestamp-down-means-later
  11948. 'org-timestamp-down 'org-timestamp-up)))
  11949. ((org-on-heading-p) (call-interactively 'org-priority-up))
  11950. ((org-at-item-p) (call-interactively 'org-previous-item))
  11951. ((org-clocktable-try-shift 'up arg))
  11952. (t (call-interactively 'org-beginning-of-item) (beginning-of-line 1))))
  11953. (defun org-shiftdown (&optional arg)
  11954. "Decrease item in timestamp or decrease priority of current headline.
  11955. Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
  11956. depending on context. See the individual commands for more information."
  11957. (interactive "P")
  11958. (cond
  11959. ((org-at-timestamp-p t)
  11960. (call-interactively (if org-edit-timestamp-down-means-later
  11961. 'org-timestamp-up 'org-timestamp-down)))
  11962. ((org-on-heading-p) (call-interactively 'org-priority-down))
  11963. ((org-clocktable-try-shift 'down arg))
  11964. (t (call-interactively 'org-next-item))))
  11965. (defun org-shiftright (&optional arg)
  11966. "Next TODO keyword or timestamp one day later, depending on context."
  11967. (interactive "P")
  11968. (cond
  11969. ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
  11970. ((org-on-heading-p) (org-call-with-arg 'org-todo 'right))
  11971. ((org-at-item-p) (org-call-with-arg 'org-cycle-list-bullet nil))
  11972. ((org-at-property-p) (call-interactively 'org-property-next-allowed-value))
  11973. ((org-clocktable-try-shift 'right arg))
  11974. (t (org-shiftcursor-error))))
  11975. (defun org-shiftleft (&optional arg)
  11976. "Previous TODO keyword or timestamp one day earlier, depending on context."
  11977. (interactive "P")
  11978. (cond
  11979. ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
  11980. ((org-on-heading-p) (org-call-with-arg 'org-todo 'left))
  11981. ((org-at-item-p) (org-call-with-arg 'org-cycle-list-bullet 'previous))
  11982. ((org-at-property-p)
  11983. (call-interactively 'org-property-previous-allowed-value))
  11984. ((org-clocktable-try-shift 'left arg))
  11985. (t (org-shiftcursor-error))))
  11986. (defun org-shiftcontrolright ()
  11987. "Switch to next TODO set."
  11988. (interactive)
  11989. (cond
  11990. ((org-on-heading-p) (org-call-with-arg 'org-todo 'nextset))
  11991. (t (org-shiftcursor-error))))
  11992. (defun org-shiftcontrolleft ()
  11993. "Switch to previous TODO set."
  11994. (interactive)
  11995. (cond
  11996. ((org-on-heading-p) (org-call-with-arg 'org-todo 'previousset))
  11997. (t (org-shiftcursor-error))))
  11998. (defun org-ctrl-c-ret ()
  11999. "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
  12000. (interactive)
  12001. (cond
  12002. ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
  12003. (t (call-interactively 'org-insert-heading))))
  12004. (defun org-copy-special ()
  12005. "Copy region in table or copy current subtree.
  12006. Calls `org-table-copy' or `org-copy-subtree', depending on context.
  12007. See the individual commands for more information."
  12008. (interactive)
  12009. (call-interactively
  12010. (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
  12011. (defun org-cut-special ()
  12012. "Cut region in table or cut current subtree.
  12013. Calls `org-table-copy' or `org-cut-subtree', depending on context.
  12014. See the individual commands for more information."
  12015. (interactive)
  12016. (call-interactively
  12017. (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
  12018. (defun org-paste-special (arg)
  12019. "Paste rectangular region into table, or past subtree relative to level.
  12020. Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
  12021. See the individual commands for more information."
  12022. (interactive "P")
  12023. (if (org-at-table-p)
  12024. (org-table-paste-rectangle)
  12025. (org-paste-subtree arg)))
  12026. (defun org-edit-special ()
  12027. "Call a special editor for the stuff at point.
  12028. When at a table, call the formula editor with `org-table-edit-formulas'.
  12029. When at the first line of an src example, call `org-edit-src-code'.
  12030. When in an #+include line, visit the include file. Otherwise call
  12031. `ffap' to visit the file at point."
  12032. (interactive)
  12033. (cond
  12034. ((org-at-table-p)
  12035. (call-interactively 'org-table-edit-formulas))
  12036. ((save-excursion
  12037. (beginning-of-line 1)
  12038. (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
  12039. (find-file (org-trim (match-string 1))))
  12040. ((org-edit-src-code))
  12041. ((org-edit-fixed-width-region))
  12042. (t (call-interactively 'ffap))))
  12043. (defun org-ctrl-c-ctrl-c (&optional arg)
  12044. "Set tags in headline, or update according to changed information at point.
  12045. This command does many different things, depending on context:
  12046. - If the cursor is in a headline, prompt for tags and insert them
  12047. into the current line, aligned to `org-tags-column'. When called
  12048. with prefix arg, realign all tags in the current buffer.
  12049. - If the cursor is in one of the special #+KEYWORD lines, this
  12050. triggers scanning the buffer for these lines and updating the
  12051. information.
  12052. - If the cursor is inside a table, realign the table. This command
  12053. works even if the automatic table editor has been turned off.
  12054. - If the cursor is on a #+TBLFM line, re-apply the formulas to
  12055. the entire table.
  12056. - If the cursor is a the beginning of a dynamic block, update it.
  12057. - If the cursor is inside a table created by the table.el package,
  12058. activate that table.
  12059. - If the current buffer is a remember buffer, close note and file it.
  12060. with a prefix argument, file it without further interaction to the default
  12061. location.
  12062. - If the cursor is on a <<<target>>>, update radio targets and corresponding
  12063. links in this buffer.
  12064. - If the cursor is on a numbered item in a plain list, renumber the
  12065. ordered list.
  12066. - If the cursor is on a checkbox, toggle it."
  12067. (interactive "P")
  12068. (let ((org-enable-table-editor t))
  12069. (cond
  12070. ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
  12071. org-occur-highlights
  12072. org-latex-fragment-image-overlays)
  12073. (and (boundp 'org-clock-overlays) (org-remove-clock-overlays))
  12074. (org-remove-occur-highlights)
  12075. (org-remove-latex-fragment-image-overlays)
  12076. (message "Temporary highlights/overlays removed from current buffer"))
  12077. ((and (local-variable-p 'org-finish-function (current-buffer))
  12078. (fboundp org-finish-function))
  12079. (funcall org-finish-function))
  12080. ((org-at-property-p)
  12081. (call-interactively 'org-property-action))
  12082. ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
  12083. ((org-on-heading-p) (call-interactively 'org-set-tags))
  12084. ((org-at-table.el-p)
  12085. (require 'table)
  12086. (beginning-of-line 1)
  12087. (re-search-forward "|" (save-excursion (end-of-line 2) (point)))
  12088. (call-interactively 'table-recognize-table))
  12089. ((org-at-table-p)
  12090. (org-table-maybe-eval-formula)
  12091. (if arg
  12092. (call-interactively 'org-table-recalculate)
  12093. (org-table-maybe-recalculate-line))
  12094. (call-interactively 'org-table-align))
  12095. ((org-at-item-checkbox-p)
  12096. (call-interactively 'org-toggle-checkbox))
  12097. ((org-at-item-p)
  12098. (call-interactively 'org-maybe-renumber-ordered-list))
  12099. ((save-excursion (beginning-of-line 1) (looking-at "#\\+BEGIN:"))
  12100. ;; Dynamic block
  12101. (beginning-of-line 1)
  12102. (save-excursion (org-update-dblock)))
  12103. ((save-excursion (beginning-of-line 1) (looking-at "#\\+\\([A-Z]+\\)"))
  12104. (cond
  12105. ((equal (match-string 1) "TBLFM")
  12106. ;; Recalculate the table before this line
  12107. (save-excursion
  12108. (beginning-of-line 1)
  12109. (skip-chars-backward " \r\n\t")
  12110. (if (org-at-table-p)
  12111. (org-call-with-arg 'org-table-recalculate t))))
  12112. (t
  12113. ; (org-set-regexps-and-options)
  12114. ; (org-restart-font-lock)
  12115. (let ((org-inhibit-startup t)) (org-mode-restart))
  12116. (message "Local setup has been refreshed"))))
  12117. (t (error "C-c C-c can do nothing useful at this location.")))))
  12118. (defun org-mode-restart ()
  12119. "Restart Org-mode, to scan again for special lines.
  12120. Also updates the keyword regular expressions."
  12121. (interactive)
  12122. (org-mode)
  12123. (message "Org-mode restarted"))
  12124. (defun org-kill-note-or-show-branches ()
  12125. "If this is a Note buffer, abort storing the note. Else call `show-branches'."
  12126. (interactive)
  12127. (if (not org-finish-function)
  12128. (call-interactively 'show-branches)
  12129. (let ((org-note-abort t))
  12130. (funcall org-finish-function))))
  12131. (defun org-return (&optional indent)
  12132. "Goto next table row or insert a newline.
  12133. Calls `org-table-next-row' or `newline', depending on context.
  12134. See the individual commands for more information."
  12135. (interactive)
  12136. (cond
  12137. ((bobp) (if indent (newline-and-indent) (newline)))
  12138. ((and (org-at-heading-p)
  12139. (looking-at
  12140. (org-re "\\([ \t]+\\(:[[:alnum:]_@:]+:\\)\\)[ \t]*$")))
  12141. (org-show-entry)
  12142. (end-of-line 1)
  12143. (newline))
  12144. ((org-at-table-p)
  12145. (org-table-justify-field-maybe)
  12146. (call-interactively 'org-table-next-row))
  12147. (t (if indent (newline-and-indent) (newline)))))
  12148. (defun org-return-indent ()
  12149. "Goto next table row or insert a newline and indent.
  12150. Calls `org-table-next-row' or `newline-and-indent', depending on
  12151. context. See the individual commands for more information."
  12152. (interactive)
  12153. (org-return t))
  12154. (defun org-ctrl-c-star ()
  12155. "Compute table, or change heading status of lines.
  12156. Calls `org-table-recalculate' or `org-toggle-region-headings',
  12157. depending on context. This will also turn a plain list item or a normal
  12158. line into a subheading."
  12159. (interactive)
  12160. (cond
  12161. ((org-at-table-p)
  12162. (call-interactively 'org-table-recalculate))
  12163. ((org-region-active-p)
  12164. ;; Convert all lines in region to list items
  12165. (call-interactively 'org-toggle-region-headings))
  12166. ((org-on-heading-p)
  12167. (org-toggle-region-headings (point-at-bol)
  12168. (min (1+ (point-at-eol)) (point-max))))
  12169. ((org-at-item-p)
  12170. ;; Convert to heading
  12171. (let ((level (save-match-data
  12172. (save-excursion
  12173. (condition-case nil
  12174. (progn
  12175. (org-back-to-heading t)
  12176. (funcall outline-level))
  12177. (error 0))))))
  12178. (replace-match
  12179. (concat (make-string (org-get-valid-level level 1) ?*) " ") t t)))
  12180. (t (org-toggle-region-headings (point-at-bol)
  12181. (min (1+ (point-at-eol)) (point-max))))))
  12182. (defun org-ctrl-c-minus ()
  12183. "Insert separator line in table or modify bullet status of line.
  12184. Also turns a plain line or a region of lines into list items.
  12185. Calls `org-table-insert-hline', `org-toggle-region-items', or
  12186. `org-cycle-list-bullet', depending on context."
  12187. (interactive)
  12188. (cond
  12189. ((org-at-table-p)
  12190. (call-interactively 'org-table-insert-hline))
  12191. ((org-on-heading-p)
  12192. ;; Convert to item
  12193. (save-excursion
  12194. (beginning-of-line 1)
  12195. (if (looking-at "\\*+ ")
  12196. (replace-match (concat (make-string (- (match-end 0) (point) 1) ?\ ) "- ")))))
  12197. ((org-region-active-p)
  12198. ;; Convert all lines in region to list items
  12199. (call-interactively 'org-toggle-region-items))
  12200. ((org-in-item-p)
  12201. (call-interactively 'org-cycle-list-bullet))
  12202. (t (org-toggle-region-items (point-at-bol)
  12203. (min (1+ (point-at-eol)) (point-max))))))
  12204. (defun org-toggle-region-items (beg end)
  12205. "Convert all lines in region to list items.
  12206. If the first line is already an item, convert all list items in the region
  12207. to normal lines."
  12208. (interactive "r")
  12209. (let (l2 l)
  12210. (save-excursion
  12211. (goto-char end)
  12212. (setq l2 (org-current-line))
  12213. (goto-char beg)
  12214. (beginning-of-line 1)
  12215. (setq l (1- (org-current-line)))
  12216. (if (org-at-item-p)
  12217. ;; We already have items, de-itemize
  12218. (while (< (setq l (1+ l)) l2)
  12219. (when (org-at-item-p)
  12220. (goto-char (match-beginning 2))
  12221. (delete-region (match-beginning 2) (match-end 2))
  12222. (and (looking-at "[ \t]+") (replace-match "")))
  12223. (beginning-of-line 2))
  12224. (while (< (setq l (1+ l)) l2)
  12225. (unless (org-at-item-p)
  12226. (if (looking-at "\\([ \t]*\\)\\(\\S-\\)")
  12227. (replace-match "\\1- \\2")))
  12228. (beginning-of-line 2))))))
  12229. (defun org-toggle-region-headings (beg end)
  12230. "Convert all lines in region to list items.
  12231. If the first line is already an item, convert all list items in the region
  12232. to normal lines."
  12233. (interactive "r")
  12234. (let (l2 l)
  12235. (save-excursion
  12236. (goto-char end)
  12237. (setq l2 (org-current-line))
  12238. (goto-char beg)
  12239. (beginning-of-line 1)
  12240. (setq l (1- (org-current-line)))
  12241. (if (org-on-heading-p)
  12242. ;; We already have headlines, de-star them
  12243. (while (< (setq l (1+ l)) l2)
  12244. (when (org-on-heading-p t)
  12245. (and (looking-at outline-regexp) (replace-match "")))
  12246. (beginning-of-line 2))
  12247. (let* ((stars (save-excursion
  12248. (re-search-backward org-complex-heading-regexp nil t)
  12249. (or (match-string 1) "*")))
  12250. (add-stars (if org-odd-levels-only "**" "*"))
  12251. (rpl (concat stars add-stars " \\2")))
  12252. (while (< (setq l (1+ l)) l2)
  12253. (unless (org-on-heading-p)
  12254. (if (looking-at "\\([ \t]*\\)\\(\\S-\\)")
  12255. (replace-match rpl)))
  12256. (beginning-of-line 2)))))))
  12257. (defun org-meta-return (&optional arg)
  12258. "Insert a new heading or wrap a region in a table.
  12259. Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
  12260. See the individual commands for more information."
  12261. (interactive "P")
  12262. (cond
  12263. ((org-at-table-p)
  12264. (call-interactively 'org-table-wrap-region))
  12265. (t (call-interactively 'org-insert-heading))))
  12266. ;;; Menu entries
  12267. ;; Define the Org-mode menus
  12268. (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
  12269. '("Tbl"
  12270. ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
  12271. ["Next Field" org-cycle (org-at-table-p)]
  12272. ["Previous Field" org-shifttab (org-at-table-p)]
  12273. ["Next Row" org-return (org-at-table-p)]
  12274. "--"
  12275. ["Blank Field" org-table-blank-field (org-at-table-p)]
  12276. ["Edit Field" org-table-edit-field (org-at-table-p)]
  12277. ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
  12278. "--"
  12279. ("Column"
  12280. ["Move Column Left" org-metaleft (org-at-table-p)]
  12281. ["Move Column Right" org-metaright (org-at-table-p)]
  12282. ["Delete Column" org-shiftmetaleft (org-at-table-p)]
  12283. ["Insert Column" org-shiftmetaright (org-at-table-p)])
  12284. ("Row"
  12285. ["Move Row Up" org-metaup (org-at-table-p)]
  12286. ["Move Row Down" org-metadown (org-at-table-p)]
  12287. ["Delete Row" org-shiftmetaup (org-at-table-p)]
  12288. ["Insert Row" org-shiftmetadown (org-at-table-p)]
  12289. ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
  12290. "--"
  12291. ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
  12292. ("Rectangle"
  12293. ["Copy Rectangle" org-copy-special (org-at-table-p)]
  12294. ["Cut Rectangle" org-cut-special (org-at-table-p)]
  12295. ["Paste Rectangle" org-paste-special (org-at-table-p)]
  12296. ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
  12297. "--"
  12298. ("Calculate"
  12299. ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
  12300. ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
  12301. ["Edit Formulas" org-edit-special (org-at-table-p)]
  12302. "--"
  12303. ["Recalculate line" org-table-recalculate (org-at-table-p)]
  12304. ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
  12305. ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
  12306. "--"
  12307. ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
  12308. "--"
  12309. ["Sum Column/Rectangle" org-table-sum
  12310. (or (org-at-table-p) (org-region-active-p))]
  12311. ["Which Column?" org-table-current-column (org-at-table-p)])
  12312. ["Debug Formulas"
  12313. org-table-toggle-formula-debugger
  12314. :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
  12315. ["Show Col/Row Numbers"
  12316. org-table-toggle-coordinate-overlays
  12317. :style toggle
  12318. :selected (org-bound-and-true-p org-table-overlay-coordinates)]
  12319. "--"
  12320. ["Create" org-table-create (and (not (org-at-table-p))
  12321. org-enable-table-editor)]
  12322. ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
  12323. ["Import from File" org-table-import (not (org-at-table-p))]
  12324. ["Export to File" org-table-export (org-at-table-p)]
  12325. "--"
  12326. ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
  12327. (easy-menu-define org-org-menu org-mode-map "Org menu"
  12328. '("Org"
  12329. ("Show/Hide"
  12330. ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
  12331. ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
  12332. ["Sparse Tree..." org-sparse-tree t]
  12333. ["Reveal Context" org-reveal t]
  12334. ["Show All" show-all t]
  12335. "--"
  12336. ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
  12337. "--"
  12338. ["New Heading" org-insert-heading t]
  12339. ("Navigate Headings"
  12340. ["Up" outline-up-heading t]
  12341. ["Next" outline-next-visible-heading t]
  12342. ["Previous" outline-previous-visible-heading t]
  12343. ["Next Same Level" outline-forward-same-level t]
  12344. ["Previous Same Level" outline-backward-same-level t]
  12345. "--"
  12346. ["Jump" org-goto t])
  12347. ("Edit Structure"
  12348. ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
  12349. ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
  12350. "--"
  12351. ["Copy Subtree" org-copy-special (not (org-at-table-p))]
  12352. ["Cut Subtree" org-cut-special (not (org-at-table-p))]
  12353. ["Paste Subtree" org-paste-special (not (org-at-table-p))]
  12354. "--"
  12355. ["Promote Heading" org-metaleft (not (org-at-table-p))]
  12356. ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
  12357. ["Demote Heading" org-metaright (not (org-at-table-p))]
  12358. ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
  12359. "--"
  12360. ["Sort Region/Children" org-sort (not (org-at-table-p))]
  12361. "--"
  12362. ["Convert to odd levels" org-convert-to-odd-levels t]
  12363. ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
  12364. ("Editing"
  12365. ["Emphasis..." org-emphasize t]
  12366. ["Edit Source Example" org-edit-special t])
  12367. ("Archive"
  12368. ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
  12369. ; ["Check and Tag Children" (org-toggle-archive-tag (4))
  12370. ; :active t :keys "C-u C-c C-x C-a"]
  12371. ["Sparse trees open ARCHIVE trees"
  12372. (setq org-sparse-tree-open-archived-trees
  12373. (not org-sparse-tree-open-archived-trees))
  12374. :style toggle :selected org-sparse-tree-open-archived-trees]
  12375. ["Cycling opens ARCHIVE trees"
  12376. (setq org-cycle-open-archived-trees (not org-cycle-open-archived-trees))
  12377. :style toggle :selected org-cycle-open-archived-trees]
  12378. "--"
  12379. ["Move subtree to archive sibling" org-archive-to-archive-sibling t]
  12380. ["Move Subtree to Archive" org-advertized-archive-subtree t]
  12381. ; ["Check and Move Children" (org-archive-subtree '(4))
  12382. ; :active t :keys "C-u C-c C-x C-s"]
  12383. )
  12384. "--"
  12385. ("TODO Lists"
  12386. ["TODO/DONE/-" org-todo t]
  12387. ("Select keyword"
  12388. ["Next keyword" org-shiftright (org-on-heading-p)]
  12389. ["Previous keyword" org-shiftleft (org-on-heading-p)]
  12390. ["Complete Keyword" org-complete (assq :todo-keyword (org-context))]
  12391. ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
  12392. ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
  12393. ["Show TODO Tree" org-show-todo-tree t]
  12394. ["Global TODO list" org-todo-list t]
  12395. "--"
  12396. ["Set Priority" org-priority t]
  12397. ["Priority Up" org-shiftup t]
  12398. ["Priority Down" org-shiftdown t])
  12399. ("TAGS and Properties"
  12400. ["Set Tags" 'org-ctrl-c-ctrl-c (org-at-heading-p)]
  12401. ["Change tag in region" 'org-change-tag-in-region (org-region-active-p)]
  12402. "--"
  12403. ["Set property" 'org-set-property t]
  12404. ["Column view of properties" org-columns t]
  12405. ["Insert Column View DBlock" org-insert-columns-dblock t])
  12406. ("Dates and Scheduling"
  12407. ["Timestamp" org-time-stamp t]
  12408. ["Timestamp (inactive)" org-time-stamp-inactive t]
  12409. ("Change Date"
  12410. ["1 Day Later" org-shiftright t]
  12411. ["1 Day Earlier" org-shiftleft t]
  12412. ["1 ... Later" org-shiftup t]
  12413. ["1 ... Earlier" org-shiftdown t])
  12414. ["Compute Time Range" org-evaluate-time-range t]
  12415. ["Schedule Item" org-schedule t]
  12416. ["Deadline" org-deadline t]
  12417. "--"
  12418. ["Custom time format" org-toggle-time-stamp-overlays
  12419. :style radio :selected org-display-custom-times]
  12420. "--"
  12421. ["Goto Calendar" org-goto-calendar t]
  12422. ["Date from Calendar" org-date-from-calendar t])
  12423. ("Logging work"
  12424. ["Clock in" org-clock-in t]
  12425. ["Clock out" org-clock-out t]
  12426. ["Clock cancel" org-clock-cancel t]
  12427. ["Goto running clock" org-clock-goto t]
  12428. ["Display times" org-clock-display t]
  12429. ["Create clock table" org-clock-report t]
  12430. "--"
  12431. ["Record DONE time"
  12432. (progn (setq org-log-done (not org-log-done))
  12433. (message "Switching to %s will %s record a timestamp"
  12434. (car org-done-keywords)
  12435. (if org-log-done "automatically" "not")))
  12436. :style toggle :selected org-log-done])
  12437. "--"
  12438. ["Agenda Command..." org-agenda t]
  12439. ["Set Restriction Lock" org-agenda-set-restriction-lock t]
  12440. ("File List for Agenda")
  12441. ("Special views current file"
  12442. ["TODO Tree" org-show-todo-tree t]
  12443. ["Check Deadlines" org-check-deadlines t]
  12444. ["Timeline" org-timeline t]
  12445. ["Tags Tree" org-tags-sparse-tree t])
  12446. "--"
  12447. ("Hyperlinks"
  12448. ["Store Link (Global)" org-store-link t]
  12449. ["Insert Link" org-insert-link t]
  12450. ["Follow Link" org-open-at-point t]
  12451. "--"
  12452. ["Next link" org-next-link t]
  12453. ["Previous link" org-previous-link t]
  12454. "--"
  12455. ["Descriptive Links"
  12456. (progn (org-add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
  12457. :style radio
  12458. :selected (member '(org-link) buffer-invisibility-spec)]
  12459. ["Literal Links"
  12460. (progn
  12461. (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
  12462. :style radio
  12463. :selected (not (member '(org-link) buffer-invisibility-spec))])
  12464. "--"
  12465. ["Export/Publish..." org-export t]
  12466. ("LaTeX"
  12467. ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
  12468. :selected org-cdlatex-mode]
  12469. ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
  12470. ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
  12471. ["Modify math symbol" org-cdlatex-math-modify
  12472. (org-inside-LaTeX-fragment-p)]
  12473. ["Export LaTeX fragments as images"
  12474. (if (featurep 'org-exp)
  12475. (setq org-export-with-LaTeX-fragments
  12476. (not org-export-with-LaTeX-fragments))
  12477. (require 'org-exp))
  12478. :style toggle :selected (and (boundp 'org-export-with-LaTeX-fragments)
  12479. org-export-with-LaTeX-fragments)])
  12480. "--"
  12481. ("Documentation"
  12482. ["Show Version" org-version t]
  12483. ["Info Documentation" org-info t])
  12484. ("Customize"
  12485. ["Browse Org Group" org-customize t]
  12486. "--"
  12487. ["Expand This Menu" org-create-customize-menu
  12488. (fboundp 'customize-menu-create)])
  12489. "--"
  12490. ["Refresh setup" org-mode-restart t]
  12491. ))
  12492. (defun org-info (&optional node)
  12493. "Read documentation for Org-mode in the info system.
  12494. With optional NODE, go directly to that node."
  12495. (interactive)
  12496. (info (format "(org)%s" (or node ""))))
  12497. (defun org-install-agenda-files-menu ()
  12498. (let ((bl (buffer-list)))
  12499. (save-excursion
  12500. (while bl
  12501. (set-buffer (pop bl))
  12502. (if (org-mode-p) (setq bl nil)))
  12503. (when (org-mode-p)
  12504. (easy-menu-change
  12505. '("Org") "File List for Agenda"
  12506. (append
  12507. (list
  12508. ["Edit File List" (org-edit-agenda-file-list) t]
  12509. ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
  12510. ["Remove Current File from List" org-remove-file t]
  12511. ["Cycle through agenda files" org-cycle-agenda-files t]
  12512. ["Occur in all agenda files" org-occur-in-agenda-files t]
  12513. "--")
  12514. (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
  12515. ;;;; Documentation
  12516. ;;;###autoload
  12517. (defun org-require-autoloaded-modules ()
  12518. (interactive)
  12519. (mapc 'require
  12520. '(org-agenda org-archive org-clock org-colview
  12521. org-exp org-id org-export-latex org-publish
  12522. org-remember org-table)))
  12523. ;;;###autoload
  12524. (defun org-customize ()
  12525. "Call the customize function with org as argument."
  12526. (interactive)
  12527. (org-load-modules-maybe)
  12528. (org-require-autoloaded-modules)
  12529. (customize-browse 'org))
  12530. (defun org-create-customize-menu ()
  12531. "Create a full customization menu for Org-mode, insert it into the menu."
  12532. (interactive)
  12533. (org-load-modules-maybe)
  12534. (org-require-autoloaded-modules)
  12535. (if (fboundp 'customize-menu-create)
  12536. (progn
  12537. (easy-menu-change
  12538. '("Org") "Customize"
  12539. `(["Browse Org group" org-customize t]
  12540. "--"
  12541. ,(customize-menu-create 'org)
  12542. ["Set" Custom-set t]
  12543. ["Save" Custom-save t]
  12544. ["Reset to Current" Custom-reset-current t]
  12545. ["Reset to Saved" Custom-reset-saved t]
  12546. ["Reset to Standard Settings" Custom-reset-standard t]))
  12547. (message "\"Org\"-menu now contains full customization menu"))
  12548. (error "Cannot expand menu (outdated version of cus-edit.el)")))
  12549. ;;;; Miscellaneous stuff
  12550. ;;; Generally useful functions
  12551. (defun org-display-warning (message) ;; Copied from Emacs-Muse
  12552. "Display the given MESSAGE as a warning."
  12553. (if (fboundp 'display-warning)
  12554. (display-warning 'org message
  12555. (if (featurep 'xemacs)
  12556. 'warning
  12557. :warning))
  12558. (let ((buf (get-buffer-create "*Org warnings*")))
  12559. (with-current-buffer buf
  12560. (goto-char (point-max))
  12561. (insert "Warning (Org): " message)
  12562. (unless (bolp)
  12563. (newline)))
  12564. (display-buffer buf)
  12565. (sit-for 0))))
  12566. (defun org-goto-marker-or-bmk (marker &optional bookmark)
  12567. "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
  12568. (if (and marker (marker-buffer marker)
  12569. (buffer-live-p (marker-buffer marker)))
  12570. (progn
  12571. (switch-to-buffer (marker-buffer marker))
  12572. (if (or (> marker (point-max)) (< marker (point-min)))
  12573. (widen))
  12574. (goto-char marker))
  12575. (if bookmark
  12576. (bookmark-jump bookmark)
  12577. (error "Cannot find location"))))
  12578. (defun org-quote-csv-field (s)
  12579. "Quote field for inclusion in CSV material."
  12580. (if (string-match "[\",]" s)
  12581. (concat "\"" (mapconcat 'identity (split-string s "\"") "\"\"") "\"")
  12582. s))
  12583. (defun org-plist-delete (plist property)
  12584. "Delete PROPERTY from PLIST.
  12585. This is in contrast to merely setting it to 0."
  12586. (let (p)
  12587. (while plist
  12588. (if (not (eq property (car plist)))
  12589. (setq p (plist-put p (car plist) (nth 1 plist))))
  12590. (setq plist (cddr plist)))
  12591. p))
  12592. (defun org-force-self-insert (N)
  12593. "Needed to enforce self-insert under remapping."
  12594. (interactive "p")
  12595. (self-insert-command N))
  12596. (defun org-string-width (s)
  12597. "Compute width of string, ignoring invisible characters.
  12598. This ignores character with invisibility property `org-link', and also
  12599. characters with property `org-cwidth', because these will become invisible
  12600. upon the next fontification round."
  12601. (let (b l)
  12602. (when (or (eq t buffer-invisibility-spec)
  12603. (assq 'org-link buffer-invisibility-spec))
  12604. (while (setq b (text-property-any 0 (length s)
  12605. 'invisible 'org-link s))
  12606. (setq s (concat (substring s 0 b)
  12607. (substring s (or (next-single-property-change
  12608. b 'invisible s) (length s)))))))
  12609. (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
  12610. (setq s (concat (substring s 0 b)
  12611. (substring s (or (next-single-property-change
  12612. b 'org-cwidth s) (length s))))))
  12613. (setq l (string-width s) b -1)
  12614. (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
  12615. (setq l (- l (get-text-property b 'org-dwidth-n s))))
  12616. l))
  12617. (defun org-base-buffer (buffer)
  12618. "Return the base buffer of BUFFER, if it has one. Else return the buffer."
  12619. (if (not buffer)
  12620. buffer
  12621. (or (buffer-base-buffer buffer)
  12622. buffer)))
  12623. (defun org-trim (s)
  12624. "Remove whitespace at beginning and end of string."
  12625. (if (string-match "\\`[ \t\n\r]+" s) (setq s (replace-match "" t t s)))
  12626. (if (string-match "[ \t\n\r]+\\'" s) (setq s (replace-match "" t t s)))
  12627. s)
  12628. (defun org-wrap (string &optional width lines)
  12629. "Wrap string to either a number of lines, or a width in characters.
  12630. If WIDTH is non-nil, the string is wrapped to that width, however many lines
  12631. that costs. If there is a word longer than WIDTH, the text is actually
  12632. wrapped to the length of that word.
  12633. IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
  12634. many lines, whatever width that takes.
  12635. The return value is a list of lines, without newlines at the end."
  12636. (let* ((words (org-split-string string "[ \t\n]+"))
  12637. (maxword (apply 'max (mapcar 'org-string-width words)))
  12638. w ll)
  12639. (cond (width
  12640. (org-do-wrap words (max maxword width)))
  12641. (lines
  12642. (setq w maxword)
  12643. (setq ll (org-do-wrap words maxword))
  12644. (if (<= (length ll) lines)
  12645. ll
  12646. (setq ll words)
  12647. (while (> (length ll) lines)
  12648. (setq w (1+ w))
  12649. (setq ll (org-do-wrap words w)))
  12650. ll))
  12651. (t (error "Cannot wrap this")))))
  12652. (defun org-do-wrap (words width)
  12653. "Create lines of maximum width WIDTH (in characters) from word list WORDS."
  12654. (let (lines line)
  12655. (while words
  12656. (setq line (pop words))
  12657. (while (and words (< (+ (length line) (length (car words))) width))
  12658. (setq line (concat line " " (pop words))))
  12659. (setq lines (push line lines)))
  12660. (nreverse lines)))
  12661. (defun org-split-string (string &optional separators)
  12662. "Splits STRING into substrings at SEPARATORS.
  12663. No empty strings are returned if there are matches at the beginning
  12664. and end of string."
  12665. (let ((rexp (or separators "[ \f\t\n\r\v]+"))
  12666. (start 0)
  12667. notfirst
  12668. (list nil))
  12669. (while (and (string-match rexp string
  12670. (if (and notfirst
  12671. (= start (match-beginning 0))
  12672. (< start (length string)))
  12673. (1+ start) start))
  12674. (< (match-beginning 0) (length string)))
  12675. (setq notfirst t)
  12676. (or (eq (match-beginning 0) 0)
  12677. (and (eq (match-beginning 0) (match-end 0))
  12678. (eq (match-beginning 0) start))
  12679. (setq list
  12680. (cons (substring string start (match-beginning 0))
  12681. list)))
  12682. (setq start (match-end 0)))
  12683. (or (eq start (length string))
  12684. (setq list
  12685. (cons (substring string start)
  12686. list)))
  12687. (nreverse list)))
  12688. (defun org-context ()
  12689. "Return a list of contexts of the current cursor position.
  12690. If several contexts apply, all are returned.
  12691. Each context entry is a list with a symbol naming the context, and
  12692. two positions indicating start and end of the context. Possible
  12693. contexts are:
  12694. :headline anywhere in a headline
  12695. :headline-stars on the leading stars in a headline
  12696. :todo-keyword on a TODO keyword (including DONE) in a headline
  12697. :tags on the TAGS in a headline
  12698. :priority on the priority cookie in a headline
  12699. :item on the first line of a plain list item
  12700. :item-bullet on the bullet/number of a plain list item
  12701. :checkbox on the checkbox in a plain list item
  12702. :table in an org-mode table
  12703. :table-special on a special filed in a table
  12704. :table-table in a table.el table
  12705. :link on a hyperlink
  12706. :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
  12707. :target on a <<target>>
  12708. :radio-target on a <<<radio-target>>>
  12709. :latex-fragment on a LaTeX fragment
  12710. :latex-preview on a LaTeX fragment with overlayed preview image
  12711. This function expects the position to be visible because it uses font-lock
  12712. faces as a help to recognize the following contexts: :table-special, :link,
  12713. and :keyword."
  12714. (let* ((f (get-text-property (point) 'face))
  12715. (faces (if (listp f) f (list f)))
  12716. (p (point)) clist o)
  12717. ;; First the large context
  12718. (cond
  12719. ((org-on-heading-p t)
  12720. (push (list :headline (point-at-bol) (point-at-eol)) clist)
  12721. (when (progn
  12722. (beginning-of-line 1)
  12723. (looking-at org-todo-line-tags-regexp))
  12724. (push (org-point-in-group p 1 :headline-stars) clist)
  12725. (push (org-point-in-group p 2 :todo-keyword) clist)
  12726. (push (org-point-in-group p 4 :tags) clist))
  12727. (goto-char p)
  12728. (skip-chars-backward "^[\n\r \t") (or (eobp) (backward-char 1))
  12729. (if (looking-at "\\[#[A-Z0-9]\\]")
  12730. (push (org-point-in-group p 0 :priority) clist)))
  12731. ((org-at-item-p)
  12732. (push (org-point-in-group p 2 :item-bullet) clist)
  12733. (push (list :item (point-at-bol)
  12734. (save-excursion (org-end-of-item) (point)))
  12735. clist)
  12736. (and (org-at-item-checkbox-p)
  12737. (push (org-point-in-group p 0 :checkbox) clist)))
  12738. ((org-at-table-p)
  12739. (push (list :table (org-table-begin) (org-table-end)) clist)
  12740. (if (memq 'org-formula faces)
  12741. (push (list :table-special
  12742. (previous-single-property-change p 'face)
  12743. (next-single-property-change p 'face)) clist)))
  12744. ((org-at-table-p 'any)
  12745. (push (list :table-table) clist)))
  12746. (goto-char p)
  12747. ;; Now the small context
  12748. (cond
  12749. ((org-at-timestamp-p)
  12750. (push (org-point-in-group p 0 :timestamp) clist))
  12751. ((memq 'org-link faces)
  12752. (push (list :link
  12753. (previous-single-property-change p 'face)
  12754. (next-single-property-change p 'face)) clist))
  12755. ((memq 'org-special-keyword faces)
  12756. (push (list :keyword
  12757. (previous-single-property-change p 'face)
  12758. (next-single-property-change p 'face)) clist))
  12759. ((org-on-target-p)
  12760. (push (org-point-in-group p 0 :target) clist)
  12761. (goto-char (1- (match-beginning 0)))
  12762. (if (looking-at org-radio-target-regexp)
  12763. (push (org-point-in-group p 0 :radio-target) clist))
  12764. (goto-char p))
  12765. ((setq o (car (delq nil
  12766. (mapcar
  12767. (lambda (x)
  12768. (if (memq x org-latex-fragment-image-overlays) x))
  12769. (org-overlays-at (point))))))
  12770. (push (list :latex-fragment
  12771. (org-overlay-start o) (org-overlay-end o)) clist)
  12772. (push (list :latex-preview
  12773. (org-overlay-start o) (org-overlay-end o)) clist))
  12774. ((org-inside-LaTeX-fragment-p)
  12775. ;; FIXME: positions wrong.
  12776. (push (list :latex-fragment (point) (point)) clist)))
  12777. (setq clist (nreverse (delq nil clist)))
  12778. clist))
  12779. ;; FIXME: Compare with at-regexp-p Do we need both?
  12780. (defun org-in-regexp (re &optional nlines visually)
  12781. "Check if point is inside a match of regexp.
  12782. Normally only the current line is checked, but you can include NLINES extra
  12783. lines both before and after point into the search.
  12784. If VISUALLY is set, require that the cursor is not after the match but
  12785. really on, so that the block visually is on the match."
  12786. (catch 'exit
  12787. (let ((pos (point))
  12788. (eol (point-at-eol (+ 1 (or nlines 0))))
  12789. (inc (if visually 1 0)))
  12790. (save-excursion
  12791. (beginning-of-line (- 1 (or nlines 0)))
  12792. (while (re-search-forward re eol t)
  12793. (if (and (<= (match-beginning 0) pos)
  12794. (>= (+ inc (match-end 0)) pos))
  12795. (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
  12796. (defun org-at-regexp-p (regexp)
  12797. "Is point inside a match of REGEXP in the current line?"
  12798. (catch 'exit
  12799. (save-excursion
  12800. (let ((pos (point)) (end (point-at-eol)))
  12801. (beginning-of-line 1)
  12802. (while (re-search-forward regexp end t)
  12803. (if (and (<= (match-beginning 0) pos)
  12804. (>= (match-end 0) pos))
  12805. (throw 'exit t)))
  12806. nil))))
  12807. (defun org-occur-in-agenda-files (regexp &optional nlines)
  12808. "Call `multi-occur' with buffers for all agenda files."
  12809. (interactive "sOrg-files matching: \np")
  12810. (let* ((files (org-agenda-files))
  12811. (tnames (mapcar 'file-truename files))
  12812. (extra org-agenda-text-search-extra-files)
  12813. f)
  12814. (when (eq (car extra) 'agenda-archives)
  12815. (setq extra (cdr extra))
  12816. (setq files (org-add-archive-files files)))
  12817. (while (setq f (pop extra))
  12818. (unless (member (file-truename f) tnames)
  12819. (add-to-list 'files f 'append)
  12820. (add-to-list 'tnames (file-truename f) 'append)))
  12821. (multi-occur
  12822. (mapcar (lambda (x) (or (get-file-buffer x) (find-file-noselect x))) files)
  12823. regexp)))
  12824. (if (boundp 'occur-mode-find-occurrence-hook)
  12825. ;; Emacs 23
  12826. (add-hook 'occur-mode-find-occurrence-hook
  12827. (lambda ()
  12828. (when (org-mode-p)
  12829. (org-reveal))))
  12830. ;; Emacs 22
  12831. (defadvice occur-mode-goto-occurrence
  12832. (after org-occur-reveal activate)
  12833. (and (org-mode-p) (org-reveal)))
  12834. (defadvice occur-mode-goto-occurrence-other-window
  12835. (after org-occur-reveal activate)
  12836. (and (org-mode-p) (org-reveal)))
  12837. (defadvice occur-mode-display-occurrence
  12838. (after org-occur-reveal activate)
  12839. (when (org-mode-p)
  12840. (let ((pos (occur-mode-find-occurrence)))
  12841. (with-current-buffer (marker-buffer pos)
  12842. (save-excursion
  12843. (goto-char pos)
  12844. (org-reveal)))))))
  12845. (defun org-uniquify (list)
  12846. "Remove duplicate elements from LIST."
  12847. (let (res)
  12848. (mapc (lambda (x) (add-to-list 'res x 'append)) list)
  12849. res))
  12850. (defun org-delete-all (elts list)
  12851. "Remove all elements in ELTS from LIST."
  12852. (while elts
  12853. (setq list (delete (pop elts) list)))
  12854. list)
  12855. (defun org-back-over-empty-lines ()
  12856. "Move backwards over witespace, to the beginning of the first empty line.
  12857. Returns the number of empty lines passed."
  12858. (let ((pos (point)))
  12859. (skip-chars-backward " \t\n\r")
  12860. (beginning-of-line 2)
  12861. (goto-char (min (point) pos))
  12862. (count-lines (point) pos)))
  12863. (defun org-skip-whitespace ()
  12864. (skip-chars-forward " \t\n\r"))
  12865. (defun org-point-in-group (point group &optional context)
  12866. "Check if POINT is in match-group GROUP.
  12867. If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
  12868. match. If the match group does ot exist or point is not inside it,
  12869. return nil."
  12870. (and (match-beginning group)
  12871. (>= point (match-beginning group))
  12872. (<= point (match-end group))
  12873. (if context
  12874. (list context (match-beginning group) (match-end group))
  12875. t)))
  12876. (defun org-switch-to-buffer-other-window (&rest args)
  12877. "Switch to buffer in a second window on the current frame.
  12878. In particular, do not allow pop-up frames."
  12879. (let (pop-up-frames special-display-buffer-names special-display-regexps
  12880. special-display-function)
  12881. (apply 'switch-to-buffer-other-window args)))
  12882. (defun org-combine-plists (&rest plists)
  12883. "Create a single property list from all plists in PLISTS.
  12884. The process starts by copying the first list, and then setting properties
  12885. from the other lists. Settings in the last list are the most significant
  12886. ones and overrule settings in the other lists."
  12887. (let ((rtn (copy-sequence (pop plists)))
  12888. p v ls)
  12889. (while plists
  12890. (setq ls (pop plists))
  12891. (while ls
  12892. (setq p (pop ls) v (pop ls))
  12893. (setq rtn (plist-put rtn p v))))
  12894. rtn))
  12895. (defun org-move-line-down (arg)
  12896. "Move the current line down. With prefix argument, move it past ARG lines."
  12897. (interactive "p")
  12898. (let ((col (current-column))
  12899. beg end pos)
  12900. (beginning-of-line 1) (setq beg (point))
  12901. (beginning-of-line 2) (setq end (point))
  12902. (beginning-of-line (+ 1 arg))
  12903. (setq pos (move-marker (make-marker) (point)))
  12904. (insert (delete-and-extract-region beg end))
  12905. (goto-char pos)
  12906. (org-move-to-column col)))
  12907. (defun org-move-line-up (arg)
  12908. "Move the current line up. With prefix argument, move it past ARG lines."
  12909. (interactive "p")
  12910. (let ((col (current-column))
  12911. beg end pos)
  12912. (beginning-of-line 1) (setq beg (point))
  12913. (beginning-of-line 2) (setq end (point))
  12914. (beginning-of-line (- arg))
  12915. (setq pos (move-marker (make-marker) (point)))
  12916. (insert (delete-and-extract-region beg end))
  12917. (goto-char pos)
  12918. (org-move-to-column col)))
  12919. (defun org-replace-escapes (string table)
  12920. "Replace %-escapes in STRING with values in TABLE.
  12921. TABLE is an association list with keys like \"%a\" and string values.
  12922. The sequences in STRING may contain normal field width and padding information,
  12923. for example \"%-5s\". Replacements happen in the sequence given by TABLE,
  12924. so values can contain further %-escapes if they are define later in TABLE."
  12925. (let ((case-fold-search nil)
  12926. e re rpl)
  12927. (while (setq e (pop table))
  12928. (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
  12929. (while (string-match re string)
  12930. (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
  12931. (cdr e)))
  12932. (setq string (replace-match rpl t t string))))
  12933. string))
  12934. (defun org-sublist (list start end)
  12935. "Return a section of LIST, from START to END.
  12936. Counting starts at 1."
  12937. (let (rtn (c start))
  12938. (setq list (nthcdr (1- start) list))
  12939. (while (and list (<= c end))
  12940. (push (pop list) rtn)
  12941. (setq c (1+ c)))
  12942. (nreverse rtn)))
  12943. (defun org-find-base-buffer-visiting (file)
  12944. "Like `find-buffer-visiting' but alway return the base buffer and
  12945. not an indirect buffer."
  12946. (let ((buf (find-buffer-visiting file)))
  12947. (if buf
  12948. (or (buffer-base-buffer buf) buf)
  12949. nil)))
  12950. (defun org-image-file-name-regexp ()
  12951. "Return regexp matching the file names of images."
  12952. (if (fboundp 'image-file-name-regexp)
  12953. (image-file-name-regexp)
  12954. (let ((image-file-name-extensions
  12955. '("png" "jpeg" "jpg" "gif" "tiff" "tif"
  12956. "xbm" "xpm" "pbm" "pgm" "ppm")))
  12957. (concat "\\."
  12958. (regexp-opt (nconc (mapcar 'upcase
  12959. image-file-name-extensions)
  12960. image-file-name-extensions)
  12961. t)
  12962. "\\'"))))
  12963. (defun org-file-image-p (file)
  12964. "Return non-nil if FILE is an image."
  12965. (save-match-data
  12966. (string-match (org-image-file-name-regexp) file)))
  12967. (defun org-get-cursor-date ()
  12968. "Return the date at cursor in as a time.
  12969. This works in the calendar and in the agenda, anywhere else it just
  12970. returns the current time."
  12971. (let (date day defd)
  12972. (cond
  12973. ((eq major-mode 'calendar-mode)
  12974. (setq date (calendar-cursor-to-date)
  12975. defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  12976. ((eq major-mode 'org-agenda-mode)
  12977. (setq day (get-text-property (point) 'day))
  12978. (if day
  12979. (setq date (calendar-gregorian-from-absolute day)
  12980. defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
  12981. (nth 2 date))))))
  12982. (or defd (current-time))))
  12983. (defvar org-agenda-action-marker (make-marker)
  12984. "Marker pointing to the entry for the next agenda action.")
  12985. (defun org-mark-entry-for-agenda-action ()
  12986. "Mark the current entry as target of an agenda action.
  12987. Agenda actions are actions executed from the agenda with the key `k',
  12988. which make use of the date at the cursor."
  12989. (interactive)
  12990. (move-marker org-agenda-action-marker
  12991. (save-excursion (org-back-to-heading t) (point))
  12992. (current-buffer))
  12993. (message
  12994. "Entry marked for action; press `k' at desired date in agenda or calendar"))
  12995. ;;; Paragraph filling stuff.
  12996. ;; We want this to be just right, so use the full arsenal.
  12997. (defun org-indent-line-function ()
  12998. "Indent line like previous, but further if previous was headline or item."
  12999. (interactive)
  13000. (let* ((pos (point))
  13001. (itemp (org-at-item-p))
  13002. column bpos bcol tpos tcol bullet btype bullet-type)
  13003. ;; Find the previous relevant line
  13004. (beginning-of-line 1)
  13005. (cond
  13006. ((looking-at "#") (setq column 0))
  13007. ((looking-at "\\*+ ") (setq column 0))
  13008. (t
  13009. (beginning-of-line 0)
  13010. (while (and (not (bobp)) (looking-at "[ \t]*[\n:#|]"))
  13011. (beginning-of-line 0))
  13012. (cond
  13013. ((looking-at "\\*+[ \t]+")
  13014. (if (not org-adapt-indentation)
  13015. (setq column 0)
  13016. (goto-char (match-end 0))
  13017. (setq column (current-column))))
  13018. ((org-in-item-p)
  13019. (org-beginning-of-item)
  13020. (looking-at "[ \t]*\\(\\S-+\\)[ \t]*\\(\\[[- X]\\][ \t]*\\|.*? :: \\)?")
  13021. (setq bpos (match-beginning 1) tpos (match-end 0)
  13022. bcol (progn (goto-char bpos) (current-column))
  13023. tcol (progn (goto-char tpos) (current-column))
  13024. bullet (match-string 1)
  13025. bullet-type (if (string-match "[0-9]" bullet) "n" bullet))
  13026. (if (> tcol (+ bcol org-description-max-indent))
  13027. (setq tcol (+ bcol 5)))
  13028. (if (not itemp)
  13029. (setq column tcol)
  13030. (goto-char pos)
  13031. (beginning-of-line 1)
  13032. (if (looking-at "\\S-")
  13033. (progn
  13034. (looking-at "[ \t]*\\(\\S-+\\)[ \t]*")
  13035. (setq bullet (match-string 1)
  13036. btype (if (string-match "[0-9]" bullet) "n" bullet))
  13037. (setq column (if (equal btype bullet-type) bcol tcol)))
  13038. (setq column (org-get-indentation)))))
  13039. (t (setq column (org-get-indentation))))))
  13040. (goto-char pos)
  13041. (if (<= (current-column) (current-indentation))
  13042. (org-indent-line-to column)
  13043. (save-excursion (org-indent-line-to column)))
  13044. (setq column (current-column))
  13045. (beginning-of-line 1)
  13046. (if (looking-at
  13047. "\\([ \t]+\\)\\(:[-_0-9a-zA-Z]+:\\)[ \t]*\\(\\S-.*\\(\\S-\\|$\\)\\)")
  13048. (replace-match (concat "\\1" (format org-property-format
  13049. (match-string 2) (match-string 3)))
  13050. t nil))
  13051. (org-move-to-column column)))
  13052. (defun org-set-autofill-regexps ()
  13053. (interactive)
  13054. ;; In the paragraph separator we include headlines, because filling
  13055. ;; text in a line directly attached to a headline would otherwise
  13056. ;; fill the headline as well.
  13057. (org-set-local 'comment-start-skip "^#+[ \t]*")
  13058. (org-set-local 'paragraph-separate "\f\\|\\*+ \\|[ ]*$\\|[ \t]*[:|]")
  13059. ;; The paragraph starter includes hand-formatted lists.
  13060. (org-set-local 'paragraph-start
  13061. "\f\\|[ ]*$\\|\\*+ \\|\f\\|[ \t]*\\([-+*][ \t]+\\|[0-9]+[.)][ \t]+\\)\\|[ \t]*[:|]")
  13062. ;; Inhibit auto-fill for headers, tables and fixed-width lines.
  13063. ;; But only if the user has not turned off tables or fixed-width regions
  13064. (org-set-local
  13065. 'auto-fill-inhibit-regexp
  13066. (concat "\\*+ \\|#\\+"
  13067. "\\|[ \t]*" org-keyword-time-regexp
  13068. (if (or org-enable-table-editor org-enable-fixed-width-editor)
  13069. (concat
  13070. "\\|[ \t]*["
  13071. (if org-enable-table-editor "|" "")
  13072. (if org-enable-fixed-width-editor ":" "")
  13073. "]"))))
  13074. ;; We use our own fill-paragraph function, to make sure that tables
  13075. ;; and fixed-width regions are not wrapped. That function will pass
  13076. ;; through to `fill-paragraph' when appropriate.
  13077. (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
  13078. ; Adaptive filling: To get full control, first make sure that
  13079. ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
  13080. (org-set-local 'adaptive-fill-regexp "\000")
  13081. (org-set-local 'adaptive-fill-function
  13082. 'org-adaptive-fill-function)
  13083. (org-set-local
  13084. 'align-mode-rules-list
  13085. '((org-in-buffer-settings
  13086. (regexp . "^#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
  13087. (modes . '(org-mode))))))
  13088. (defun org-fill-paragraph (&optional justify)
  13089. "Re-align a table, pass through to fill-paragraph if no table."
  13090. (let ((table-p (org-at-table-p))
  13091. (table.el-p (org-at-table.el-p)))
  13092. (cond ((and (equal (char-after (point-at-bol)) ?*)
  13093. (save-excursion (goto-char (point-at-bol))
  13094. (looking-at outline-regexp)))
  13095. t) ; skip headlines
  13096. (table.el-p t) ; skip table.el tables
  13097. (table-p (org-table-align) t) ; align org-mode tables
  13098. (t nil)))) ; call paragraph-fill
  13099. ;; For reference, this is the default value of adaptive-fill-regexp
  13100. ;; "[ \t]*\\([-|#;>*]+[ \t]*\\|(?[0-9]+[.)][ \t]*\\)*"
  13101. (defun org-adaptive-fill-function ()
  13102. "Return a fill prefix for org-mode files.
  13103. In particular, this makes sure hanging paragraphs for hand-formatted lists
  13104. work correctly."
  13105. (cond ((looking-at "#[ \t]+")
  13106. (match-string 0))
  13107. ((looking-at "[ \t]*\\([-*+] .*? :: \\)")
  13108. (save-excursion
  13109. (if (> (match-end 1) (+ (match-beginning 1)
  13110. org-description-max-indent))
  13111. (goto-char (+ (match-beginning 1) 5))
  13112. (goto-char (match-end 0)))
  13113. (make-string (current-column) ?\ )))
  13114. ((looking-at "[ \t]*\\([-*+] \\|[0-9]+[.)] \\)?")
  13115. (save-excursion
  13116. (goto-char (match-end 0))
  13117. (make-string (current-column) ?\ )))
  13118. (t nil)))
  13119. ;;; Other stuff.
  13120. (defun org-toggle-fixed-width-section (arg)
  13121. "Toggle the fixed-width export.
  13122. If there is no active region, the QUOTE keyword at the current headline is
  13123. inserted or removed. When present, it causes the text between this headline
  13124. and the next to be exported as fixed-width text, and unmodified.
  13125. If there is an active region, this command adds or removes a colon as the
  13126. first character of this line. If the first character of a line is a colon,
  13127. this line is also exported in fixed-width font."
  13128. (interactive "P")
  13129. (let* ((cc 0)
  13130. (regionp (org-region-active-p))
  13131. (beg (if regionp (region-beginning) (point)))
  13132. (end (if regionp (region-end)))
  13133. (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
  13134. (case-fold-search nil)
  13135. (re "[ \t]*\\(:\\)")
  13136. off)
  13137. (if regionp
  13138. (save-excursion
  13139. (goto-char beg)
  13140. (setq cc (current-column))
  13141. (beginning-of-line 1)
  13142. (setq off (looking-at re))
  13143. (while (> nlines 0)
  13144. (setq nlines (1- nlines))
  13145. (beginning-of-line 1)
  13146. (cond
  13147. (arg
  13148. (org-move-to-column cc t)
  13149. (insert ":\n")
  13150. (forward-line -1))
  13151. ((and off (looking-at re))
  13152. (replace-match "" t t nil 1))
  13153. ((not off) (org-move-to-column cc t) (insert ":")))
  13154. (forward-line 1)))
  13155. (save-excursion
  13156. (org-back-to-heading)
  13157. (if (looking-at (concat outline-regexp
  13158. "\\( *\\<" org-quote-string "\\>[ \t]*\\)"))
  13159. (replace-match "" t t nil 1)
  13160. (if (looking-at outline-regexp)
  13161. (progn
  13162. (goto-char (match-end 0))
  13163. (insert org-quote-string " "))))))))
  13164. ;;;; Functions extending outline functionality
  13165. (defun org-beginning-of-line (&optional arg)
  13166. "Go to the beginning of the current line. If that is invisible, continue
  13167. to a visible line beginning. This makes the function of C-a more intuitive.
  13168. If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
  13169. first attempt, and only move to after the tags when the cursor is already
  13170. beyond the end of the headline."
  13171. (interactive "P")
  13172. (let ((pos (point)) refpos)
  13173. (beginning-of-line 1)
  13174. (if (bobp)
  13175. nil
  13176. (backward-char 1)
  13177. (if (org-invisible-p)
  13178. (while (and (not (bobp)) (org-invisible-p))
  13179. (backward-char 1)
  13180. (beginning-of-line 1))
  13181. (forward-char 1)))
  13182. (when org-special-ctrl-a/e
  13183. (cond
  13184. ((and (looking-at org-complex-heading-regexp)
  13185. (= (char-after (match-end 1)) ?\ ))
  13186. (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
  13187. (point-at-eol)))
  13188. (goto-char
  13189. (if (eq org-special-ctrl-a/e t)
  13190. (cond ((> pos refpos) refpos)
  13191. ((= pos (point)) refpos)
  13192. (t (point)))
  13193. (cond ((> pos (point)) (point))
  13194. ((not (eq last-command this-command)) (point))
  13195. (t refpos)))))
  13196. ((org-at-item-p)
  13197. (goto-char
  13198. (if (eq org-special-ctrl-a/e t)
  13199. (cond ((> pos (match-end 4)) (match-end 4))
  13200. ((= pos (point)) (match-end 4))
  13201. (t (point)))
  13202. (cond ((> pos (point)) (point))
  13203. ((not (eq last-command this-command)) (point))
  13204. (t (match-end 4))))))))
  13205. (org-no-warnings
  13206. (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
  13207. (defun org-end-of-line (&optional arg)
  13208. "Go to the end of the line.
  13209. If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
  13210. first attempt, and only move to after the tags when the cursor is already
  13211. beyond the end of the headline."
  13212. (interactive "P")
  13213. (if (or (not org-special-ctrl-a/e)
  13214. (not (org-on-heading-p)))
  13215. (end-of-line arg)
  13216. (let ((pos (point)))
  13217. (beginning-of-line 1)
  13218. (if (looking-at (org-re ".*?\\([ \t]*\\)\\(:[[:alnum:]_@:]+:\\)[ \t]*$"))
  13219. (if (eq org-special-ctrl-a/e t)
  13220. (if (or (< pos (match-beginning 1))
  13221. (= pos (match-end 0)))
  13222. (goto-char (match-beginning 1))
  13223. (goto-char (match-end 0)))
  13224. (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
  13225. (goto-char (match-end 0))
  13226. (goto-char (match-beginning 1))))
  13227. (end-of-line arg))))
  13228. (org-no-warnings
  13229. (and (featurep 'xemacs) (setq zmacs-region-stays t))))
  13230. (define-key org-mode-map "\C-a" 'org-beginning-of-line)
  13231. (define-key org-mode-map "\C-e" 'org-end-of-line)
  13232. (defun org-kill-line (&optional arg)
  13233. "Kill line, to tags or end of line."
  13234. (interactive "P")
  13235. (cond
  13236. ((or (not org-special-ctrl-k)
  13237. (bolp)
  13238. (not (org-on-heading-p)))
  13239. (call-interactively 'kill-line))
  13240. ((looking-at (org-re ".*?\\S-\\([ \t]+\\(:[[:alnum:]_@:]+:\\)\\)[ \t]*$"))
  13241. (kill-region (point) (match-beginning 1))
  13242. (org-set-tags nil t))
  13243. (t (kill-region (point) (point-at-eol)))))
  13244. (define-key org-mode-map "\C-k" 'org-kill-line)
  13245. (defun org-yank ()
  13246. "Yank, and if the yanked text is a single subtree, fold it.
  13247. In fact, if the yanked text is a sequence of subtrees, fold all of them."
  13248. (interactive)
  13249. (if org-yank-folded-subtrees
  13250. (let ((beg (point)) end)
  13251. (call-interactively 'yank)
  13252. (setq end (point))
  13253. (goto-char beg)
  13254. (when (and (bolp)
  13255. (org-kill-is-subtree-p))
  13256. (or (looking-at outline-regexp)
  13257. (re-search-forward (concat "^" outline-regexp) end t))
  13258. (while (and (< (point) end) (looking-at outline-regexp))
  13259. (hide-subtree)
  13260. (org-cycle-show-empty-lines 'folded)
  13261. (condition-case nil
  13262. (outline-forward-same-level 1)
  13263. (error (goto-char end)))))
  13264. (goto-char end)
  13265. (skip-chars-forward " \t\n\r"))
  13266. (call-interactively 'yank)))
  13267. (define-key org-mode-map "\C-y" 'org-yank)
  13268. (defun org-invisible-p ()
  13269. "Check if point is at a character currently not visible."
  13270. ;; Early versions of noutline don't have `outline-invisible-p'.
  13271. (if (fboundp 'outline-invisible-p)
  13272. (outline-invisible-p)
  13273. (get-char-property (point) 'invisible)))
  13274. (defun org-invisible-p2 ()
  13275. "Check if point is at a character currently not visible."
  13276. (save-excursion
  13277. (if (and (eolp) (not (bobp))) (backward-char 1))
  13278. ;; Early versions of noutline don't have `outline-invisible-p'.
  13279. (if (fboundp 'outline-invisible-p)
  13280. (outline-invisible-p)
  13281. (get-char-property (point) 'invisible))))
  13282. (defalias 'org-back-to-heading 'outline-back-to-heading)
  13283. (defalias 'org-on-heading-p 'outline-on-heading-p)
  13284. (defalias 'org-at-heading-p 'outline-on-heading-p)
  13285. (defun org-at-heading-or-item-p ()
  13286. (or (org-on-heading-p) (org-at-item-p)))
  13287. (defun org-on-target-p ()
  13288. (or (org-in-regexp org-radio-target-regexp)
  13289. (org-in-regexp org-target-regexp)))
  13290. (defun org-up-heading-all (arg)
  13291. "Move to the heading line of which the present line is a subheading.
  13292. This function considers both visible and invisible heading lines.
  13293. With argument, move up ARG levels."
  13294. (if (fboundp 'outline-up-heading-all)
  13295. (outline-up-heading-all arg) ; emacs 21 version of outline.el
  13296. (outline-up-heading arg t))) ; emacs 22 version of outline.el
  13297. (defun org-up-heading-safe ()
  13298. "Move to the heading line of which the present line is a subheading.
  13299. This version will not throw an error. It will return the level of the
  13300. headline found, or nil if no higher level is found."
  13301. (let ((pos (point)) start-level level
  13302. (re (concat "^" outline-regexp)))
  13303. (catch 'exit
  13304. (outline-back-to-heading t)
  13305. (setq start-level (funcall outline-level))
  13306. (if (equal start-level 1) (throw 'exit nil))
  13307. (while (re-search-backward re nil t)
  13308. (setq level (funcall outline-level))
  13309. (if (< level start-level) (throw 'exit level)))
  13310. nil)))
  13311. (defun org-first-sibling-p ()
  13312. "Is this heading the first child of its parents?"
  13313. (interactive)
  13314. (let ((re (concat "^" outline-regexp))
  13315. level l)
  13316. (unless (org-at-heading-p t)
  13317. (error "Not at a heading"))
  13318. (setq level (funcall outline-level))
  13319. (save-excursion
  13320. (if (not (re-search-backward re nil t))
  13321. t
  13322. (setq l (funcall outline-level))
  13323. (< l level)))))
  13324. (defun org-goto-sibling (&optional previous)
  13325. "Goto the next sibling, even if it is invisible.
  13326. When PREVIOUS is set, go to the previous sibling instead. Returns t
  13327. when a sibling was found. When none is found, return nil and don't
  13328. move point."
  13329. (let ((fun (if previous 're-search-backward 're-search-forward))
  13330. (pos (point))
  13331. (re (concat "^" outline-regexp))
  13332. level l)
  13333. (when (condition-case nil (org-back-to-heading t) (error nil))
  13334. (setq level (funcall outline-level))
  13335. (catch 'exit
  13336. (or previous (forward-char 1))
  13337. (while (funcall fun re nil t)
  13338. (setq l (funcall outline-level))
  13339. (when (< l level) (goto-char pos) (throw 'exit nil))
  13340. (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
  13341. (goto-char pos)
  13342. nil))))
  13343. (defun org-show-siblings ()
  13344. "Show all siblings of the current headline."
  13345. (save-excursion
  13346. (while (org-goto-sibling) (org-flag-heading nil)))
  13347. (save-excursion
  13348. (while (org-goto-sibling 'previous)
  13349. (org-flag-heading nil))))
  13350. (defun org-show-hidden-entry ()
  13351. "Show an entry where even the heading is hidden."
  13352. (save-excursion
  13353. (org-show-entry)))
  13354. (defun org-flag-heading (flag &optional entry)
  13355. "Flag the current heading. FLAG non-nil means make invisible.
  13356. When ENTRY is non-nil, show the entire entry."
  13357. (save-excursion
  13358. (org-back-to-heading t)
  13359. ;; Check if we should show the entire entry
  13360. (if entry
  13361. (progn
  13362. (org-show-entry)
  13363. (save-excursion
  13364. (and (outline-next-heading)
  13365. (org-flag-heading nil))))
  13366. (outline-flag-region (max (point-min) (1- (point)))
  13367. (save-excursion (outline-end-of-heading) (point))
  13368. flag))))
  13369. (defun org-end-of-subtree (&optional invisible-OK to-heading)
  13370. ;; This is an exact copy of the original function, but it uses
  13371. ;; `org-back-to-heading', to make it work also in invisible
  13372. ;; trees. And is uses an invisible-OK argument.
  13373. ;; Under Emacs this is not needed, but the old outline.el needs this fix.
  13374. (org-back-to-heading invisible-OK)
  13375. (let ((first t)
  13376. (level (funcall outline-level)))
  13377. (while (and (not (eobp))
  13378. (or first (> (funcall outline-level) level)))
  13379. (setq first nil)
  13380. (outline-next-heading))
  13381. (unless to-heading
  13382. (if (memq (preceding-char) '(?\n ?\^M))
  13383. (progn
  13384. ;; Go to end of line before heading
  13385. (forward-char -1)
  13386. (if (memq (preceding-char) '(?\n ?\^M))
  13387. ;; leave blank line before heading
  13388. (forward-char -1))))))
  13389. (point))
  13390. (defun org-show-subtree ()
  13391. "Show everything after this heading at deeper levels."
  13392. (outline-flag-region
  13393. (point)
  13394. (save-excursion
  13395. (outline-end-of-subtree) (outline-next-heading) (point))
  13396. nil))
  13397. (defun org-show-entry ()
  13398. "Show the body directly following this heading.
  13399. Show the heading too, if it is currently invisible."
  13400. (interactive)
  13401. (save-excursion
  13402. (condition-case nil
  13403. (progn
  13404. (org-back-to-heading t)
  13405. (outline-flag-region
  13406. (max (point-min) (1- (point)))
  13407. (save-excursion
  13408. (re-search-forward
  13409. (concat "[\r\n]\\(" outline-regexp "\\)") nil 'move)
  13410. (or (match-beginning 1) (point-max)))
  13411. nil))
  13412. (error nil))))
  13413. (defun org-make-options-regexp (kwds)
  13414. "Make a regular expression for keyword lines."
  13415. (concat
  13416. "^"
  13417. "#?[ \t]*\\+\\("
  13418. (mapconcat 'regexp-quote kwds "\\|")
  13419. "\\):[ \t]*"
  13420. "\\(.+\\)"))
  13421. ;; Make isearch reveal the necessary context
  13422. (defun org-isearch-end ()
  13423. "Reveal context after isearch exits."
  13424. (when isearch-success ; only if search was successful
  13425. (if (featurep 'xemacs)
  13426. ;; Under XEmacs, the hook is run in the correct place,
  13427. ;; we directly show the context.
  13428. (org-show-context 'isearch)
  13429. ;; In Emacs the hook runs *before* restoring the overlays.
  13430. ;; So we have to use a one-time post-command-hook to do this.
  13431. ;; (Emacs 22 has a special variable, see function `org-mode')
  13432. (unless (and (boundp 'isearch-mode-end-hook-quit)
  13433. isearch-mode-end-hook-quit)
  13434. ;; Only when the isearch was not quitted.
  13435. (org-add-hook 'post-command-hook 'org-isearch-post-command
  13436. 'append 'local)))))
  13437. (defun org-isearch-post-command ()
  13438. "Remove self from hook, and show context."
  13439. (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
  13440. (org-show-context 'isearch))
  13441. ;;;; Integration with and fixes for other packages
  13442. ;;; Imenu support
  13443. (defvar org-imenu-markers nil
  13444. "All markers currently used by Imenu.")
  13445. (make-variable-buffer-local 'org-imenu-markers)
  13446. (defun org-imenu-new-marker (&optional pos)
  13447. "Return a new marker for use by Imenu, and remember the marker."
  13448. (let ((m (make-marker)))
  13449. (move-marker m (or pos (point)))
  13450. (push m org-imenu-markers)
  13451. m))
  13452. (defun org-imenu-get-tree ()
  13453. "Produce the index for Imenu."
  13454. (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
  13455. (setq org-imenu-markers nil)
  13456. (let* ((n org-imenu-depth)
  13457. (re (concat "^" outline-regexp))
  13458. (subs (make-vector (1+ n) nil))
  13459. (last-level 0)
  13460. m tree level head)
  13461. (save-excursion
  13462. (save-restriction
  13463. (widen)
  13464. (goto-char (point-max))
  13465. (while (re-search-backward re nil t)
  13466. (setq level (org-reduced-level (funcall outline-level)))
  13467. (when (<= level n)
  13468. (looking-at org-complex-heading-regexp)
  13469. (setq head (org-match-string-no-properties 4)
  13470. m (org-imenu-new-marker))
  13471. (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
  13472. (if (>= level last-level)
  13473. (push (cons head m) (aref subs level))
  13474. (push (cons head (aref subs (1+ level))) (aref subs level))
  13475. (loop for i from (1+ level) to n do (aset subs i nil)))
  13476. (setq last-level level)))))
  13477. (aref subs 1)))
  13478. (eval-after-load "imenu"
  13479. '(progn
  13480. (add-hook 'imenu-after-jump-hook
  13481. (lambda ()
  13482. (if (eq major-mode 'org-mode)
  13483. (org-show-context 'org-goto))))))
  13484. ;; Speedbar support
  13485. (defvar org-speedbar-restriction-lock-overlay (org-make-overlay 1 1)
  13486. "Overlay marking the agenda restriction line in speedbar.")
  13487. (org-overlay-put org-speedbar-restriction-lock-overlay
  13488. 'face 'org-agenda-restriction-lock)
  13489. (org-overlay-put org-speedbar-restriction-lock-overlay
  13490. 'help-echo "Agendas are currently limited to this item.")
  13491. (org-detach-overlay org-speedbar-restriction-lock-overlay)
  13492. (defun org-speedbar-set-agenda-restriction ()
  13493. "Restrict future agenda commands to the location at point in speedbar.
  13494. To get rid of the restriction, use \\[org-agenda-remove-restriction-lock]."
  13495. (interactive)
  13496. (require 'org-agenda)
  13497. (let (p m tp np dir txt w)
  13498. (cond
  13499. ((setq p (text-property-any (point-at-bol) (point-at-eol)
  13500. 'org-imenu t))
  13501. (setq m (get-text-property p 'org-imenu-marker))
  13502. (save-excursion
  13503. (save-restriction
  13504. (set-buffer (marker-buffer m))
  13505. (goto-char m)
  13506. (org-agenda-set-restriction-lock 'subtree))))
  13507. ((setq p (text-property-any (point-at-bol) (point-at-eol)
  13508. 'speedbar-function 'speedbar-find-file))
  13509. (setq tp (previous-single-property-change
  13510. (1+ p) 'speedbar-function)
  13511. np (next-single-property-change
  13512. tp 'speedbar-function)
  13513. dir (speedbar-line-directory)
  13514. txt (buffer-substring-no-properties (or tp (point-min))
  13515. (or np (point-max))))
  13516. (save-excursion
  13517. (save-restriction
  13518. (set-buffer (find-file-noselect
  13519. (let ((default-directory dir))
  13520. (expand-file-name txt))))
  13521. (unless (org-mode-p)
  13522. (error "Cannot restrict to non-Org-mode file"))
  13523. (org-agenda-set-restriction-lock 'file))))
  13524. (t (error "Don't know how to restrict Org-mode's agenda")))
  13525. (org-move-overlay org-speedbar-restriction-lock-overlay
  13526. (point-at-bol) (point-at-eol))
  13527. (setq current-prefix-arg nil)
  13528. (org-agenda-maybe-redo)))
  13529. (eval-after-load "speedbar"
  13530. '(progn
  13531. (speedbar-add-supported-extension ".org")
  13532. (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
  13533. (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
  13534. (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
  13535. (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
  13536. (add-hook 'speedbar-visiting-tag-hook
  13537. (lambda () (org-show-context 'org-goto)))))
  13538. ;;; Fixes and Hacks for problems with other packages
  13539. ;; Make flyspell not check words in links, to not mess up our keymap
  13540. (defun org-mode-flyspell-verify ()
  13541. "Don't let flyspell put overlays at active buttons."
  13542. (not (get-text-property (point) 'keymap)))
  13543. ;; Make `bookmark-jump' show the jump location if it was hidden.
  13544. (eval-after-load "bookmark"
  13545. '(if (boundp 'bookmark-after-jump-hook)
  13546. ;; We can use the hook
  13547. (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
  13548. ;; Hook not available, use advice
  13549. (defadvice bookmark-jump (after org-make-visible activate)
  13550. "Make the position visible."
  13551. (org-bookmark-jump-unhide))))
  13552. (defun org-bookmark-jump-unhide ()
  13553. "Unhide the current position, to show the bookmark location."
  13554. (and (org-mode-p)
  13555. (or (org-invisible-p)
  13556. (save-excursion (goto-char (max (point-min) (1- (point))))
  13557. (org-invisible-p)))
  13558. (org-show-context 'bookmark-jump)))
  13559. ;; Make session.el ignore our circular variable
  13560. (eval-after-load "session"
  13561. '(add-to-list 'session-globals-exclude 'org-mark-ring))
  13562. ;;;; Experimental code
  13563. (defun org-closed-in-range ()
  13564. "Sparse tree of items closed in a certain time range.
  13565. Still experimental, may disappear in the future."
  13566. (interactive)
  13567. ;; Get the time interval from the user.
  13568. (let* ((time1 (time-to-seconds
  13569. (org-read-date nil 'to-time nil "Starting date: ")))
  13570. (time2 (time-to-seconds
  13571. (org-read-date nil 'to-time nil "End date:")))
  13572. ;; callback function
  13573. (callback (lambda ()
  13574. (let ((time
  13575. (time-to-seconds
  13576. (apply 'encode-time
  13577. (org-parse-time-string
  13578. (match-string 1))))))
  13579. ;; check if time in interval
  13580. (and (>= time time1) (<= time time2))))))
  13581. ;; make tree, check each match with the callback
  13582. (org-occur "CLOSED: +\\[\\(.*?\\)\\]" nil callback)))
  13583. ;;;; Finish up
  13584. (provide 'org)
  13585. (run-hooks 'org-load-hook)
  13586. ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
  13587. ;;; org.el ends here