org.el 554 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589125901259112592125931259412595125961259712598125991260012601126021260312604126051260612607126081260912610126111261212613126141261512616126171261812619126201262112622126231262412625126261262712628126291263012631126321263312634126351263612637126381263912640126411264212643126441264512646126471264812649126501265112652126531265412655126561265712658126591266012661126621266312664126651266612667126681266912670126711267212673126741267512676126771267812679126801268112682126831268412685126861268712688126891269012691126921269312694126951269612697126981269912700127011270212703127041270512706127071270812709127101271112712127131271412715127161271712718127191272012721127221272312724127251272612727127281272912730127311273212733127341273512736127371273812739127401274112742127431274412745127461274712748127491275012751127521275312754127551275612757127581275912760127611276212763127641276512766127671276812769127701277112772127731277412775127761277712778127791278012781127821278312784127851278612787127881278912790127911279212793127941279512796127971279812799128001280112802128031280412805128061280712808128091281012811128121281312814128151281612817128181281912820128211282212823128241282512826128271282812829128301283112832128331283412835128361283712838128391284012841128421284312844128451284612847128481284912850128511285212853128541285512856128571285812859128601286112862128631286412865128661286712868128691287012871128721287312874128751287612877128781287912880128811288212883128841288512886128871288812889128901289112892128931289412895128961289712898128991290012901129021290312904129051290612907129081290912910129111291212913129141291512916129171291812919129201292112922129231292412925129261292712928129291293012931129321293312934129351293612937129381293912940129411294212943129441294512946129471294812949129501295112952129531295412955129561295712958129591296012961129621296312964129651296612967129681296912970129711297212973129741297512976129771297812979129801298112982129831298412985129861298712988129891299012991129921299312994129951299612997129981299913000130011300213003130041300513006130071300813009130101301113012130131301413015130161301713018130191302013021130221302313024130251302613027130281302913030130311303213033130341303513036130371303813039130401304113042130431304413045130461304713048130491305013051130521305313054130551305613057130581305913060130611306213063130641306513066130671306813069130701307113072130731307413075130761307713078130791308013081130821308313084130851308613087130881308913090130911309213093130941309513096130971309813099131001310113102131031310413105131061310713108131091311013111131121311313114131151311613117131181311913120131211312213123131241312513126131271312813129131301313113132131331313413135131361313713138131391314013141131421314313144131451314613147131481314913150131511315213153131541315513156131571315813159131601316113162131631316413165131661316713168131691317013171131721317313174131751317613177131781317913180131811318213183131841318513186131871318813189131901319113192131931319413195131961319713198131991320013201132021320313204132051320613207132081320913210132111321213213132141321513216132171321813219132201322113222132231322413225132261322713228132291323013231132321323313234132351323613237132381323913240132411324213243132441324513246132471324813249132501325113252132531325413255132561325713258132591326013261132621326313264132651326613267132681326913270132711327213273132741327513276132771327813279132801328113282132831328413285132861328713288132891329013291132921329313294132951329613297132981329913300133011330213303133041330513306133071330813309133101331113312133131331413315133161331713318133191332013321133221332313324133251332613327133281332913330133311333213333133341333513336133371333813339133401334113342133431334413345133461334713348133491335013351133521335313354133551335613357133581335913360133611336213363133641336513366133671336813369133701337113372133731337413375133761337713378133791338013381133821338313384133851338613387133881338913390133911339213393133941339513396133971339813399134001340113402134031340413405134061340713408134091341013411134121341313414134151341613417134181341913420134211342213423134241342513426134271342813429134301343113432134331343413435134361343713438134391344013441134421344313444134451344613447134481344913450134511345213453134541345513456134571345813459134601346113462134631346413465134661346713468134691347013471134721347313474134751347613477134781347913480134811348213483134841348513486134871348813489134901349113492134931349413495134961349713498134991350013501135021350313504135051350613507135081350913510135111351213513135141351513516135171351813519135201352113522135231352413525135261352713528135291353013531135321353313534135351353613537135381353913540135411354213543135441354513546135471354813549135501355113552135531355413555135561355713558135591356013561135621356313564135651356613567135681356913570135711357213573135741357513576135771357813579135801358113582135831358413585135861358713588135891359013591135921359313594135951359613597135981359913600136011360213603136041360513606136071360813609136101361113612136131361413615136161361713618136191362013621136221362313624136251362613627136281362913630136311363213633136341363513636136371363813639136401364113642136431364413645136461364713648136491365013651136521365313654136551365613657136581365913660136611366213663136641366513666136671366813669136701367113672136731367413675136761367713678136791368013681136821368313684136851368613687136881368913690136911369213693136941369513696136971369813699137001370113702137031370413705137061370713708137091371013711137121371313714137151371613717137181371913720137211372213723137241372513726137271372813729137301373113732137331373413735137361373713738137391374013741137421374313744137451374613747137481374913750137511375213753137541375513756137571375813759137601376113762137631376413765137661376713768137691377013771137721377313774137751377613777137781377913780137811378213783137841378513786137871378813789137901379113792137931379413795137961379713798137991380013801138021380313804138051380613807138081380913810138111381213813138141381513816138171381813819138201382113822138231382413825138261382713828138291383013831138321383313834138351383613837138381383913840138411384213843138441384513846138471384813849138501385113852138531385413855138561385713858138591386013861138621386313864138651386613867138681386913870138711387213873138741387513876138771387813879138801388113882138831388413885138861388713888138891389013891138921389313894138951389613897138981389913900139011390213903139041390513906139071390813909139101391113912139131391413915139161391713918139191392013921139221392313924139251392613927139281392913930139311393213933139341393513936139371393813939139401394113942139431394413945139461394713948139491395013951139521395313954139551395613957139581395913960139611396213963139641396513966139671396813969139701397113972139731397413975139761397713978139791398013981139821398313984139851398613987139881398913990139911399213993139941399513996139971399813999140001400114002140031400414005140061400714008140091401014011140121401314014140151401614017140181401914020140211402214023140241402514026140271402814029140301403114032140331403414035140361403714038140391404014041140421404314044140451404614047140481404914050140511405214053140541405514056140571405814059140601406114062140631406414065140661406714068140691407014071140721407314074140751407614077140781407914080140811408214083140841408514086140871408814089140901409114092140931409414095140961409714098140991410014101141021410314104141051410614107141081410914110141111411214113141141411514116141171411814119141201412114122141231412414125141261412714128141291413014131141321413314134141351413614137141381413914140141411414214143141441414514146141471414814149141501415114152141531415414155141561415714158141591416014161141621416314164141651416614167141681416914170141711417214173141741417514176141771417814179141801418114182141831418414185141861418714188141891419014191141921419314194141951419614197141981419914200142011420214203142041420514206142071420814209142101421114212142131421414215142161421714218142191422014221142221422314224142251422614227142281422914230142311423214233142341423514236142371423814239142401424114242142431424414245142461424714248142491425014251142521425314254142551425614257142581425914260142611426214263142641426514266142671426814269142701427114272142731427414275142761427714278142791428014281142821428314284142851428614287142881428914290142911429214293142941429514296142971429814299143001430114302143031430414305143061430714308143091431014311143121431314314143151431614317143181431914320143211432214323143241432514326143271432814329143301433114332143331433414335143361433714338143391434014341143421434314344143451434614347143481434914350143511435214353143541435514356143571435814359143601436114362143631436414365143661436714368143691437014371143721437314374143751437614377143781437914380143811438214383143841438514386143871438814389143901439114392143931439414395143961439714398143991440014401144021440314404144051440614407144081440914410144111441214413144141441514416144171441814419144201442114422144231442414425144261442714428144291443014431144321443314434144351443614437144381443914440144411444214443144441444514446144471444814449144501445114452144531445414455144561445714458144591446014461144621446314464144651446614467144681446914470144711447214473144741447514476144771447814479144801448114482144831448414485144861448714488144891449014491144921449314494144951449614497144981449914500145011450214503145041450514506145071450814509145101451114512145131451414515145161451714518145191452014521145221452314524145251452614527145281452914530145311453214533145341453514536145371453814539145401454114542145431454414545145461454714548145491455014551145521455314554145551455614557145581455914560145611456214563145641456514566145671456814569145701457114572145731457414575145761457714578145791458014581145821458314584145851458614587145881458914590145911459214593145941459514596145971459814599146001460114602146031460414605146061460714608146091461014611146121461314614146151461614617146181461914620146211462214623146241462514626146271462814629146301463114632146331463414635146361463714638146391464014641146421464314644146451464614647146481464914650146511465214653146541465514656146571465814659146601466114662146631466414665146661466714668146691467014671146721467314674146751467614677146781467914680146811468214683146841468514686146871468814689146901469114692146931469414695146961469714698146991470014701147021470314704147051470614707147081470914710147111471214713147141471514716147171471814719147201472114722147231472414725147261472714728147291473014731147321473314734147351473614737147381473914740147411474214743147441474514746147471474814749147501475114752147531475414755147561475714758147591476014761147621476314764147651476614767147681476914770147711477214773147741477514776147771477814779147801478114782147831478414785147861478714788147891479014791147921479314794147951479614797147981479914800148011480214803148041480514806148071480814809148101481114812148131481414815148161481714818148191482014821148221482314824148251482614827148281482914830148311483214833148341483514836148371483814839148401484114842148431484414845148461484714848148491485014851148521485314854148551485614857148581485914860148611486214863148641486514866148671486814869148701487114872148731487414875148761487714878148791488014881148821488314884148851488614887148881488914890148911489214893148941489514896148971489814899149001490114902149031490414905149061490714908149091491014911149121491314914149151491614917149181491914920149211492214923149241492514926149271492814929149301493114932149331493414935149361493714938149391494014941149421494314944149451494614947149481494914950149511495214953149541495514956149571495814959
  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, 2009 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.17c
  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. (require 'org-list)
  84. (require 'org-footnote)
  85. ;;;; Customization variables
  86. ;;; Version
  87. (defconst org-version "6.17c"
  88. "The version number of the file org.el.")
  89. (defun org-version (&optional here)
  90. "Show the org-mode version in the echo area.
  91. With prefix arg HERE, insert it at point."
  92. (interactive "P")
  93. (let ((version (format "Org-mode version %s" org-version)))
  94. (message version)
  95. (if here
  96. (insert version))))
  97. ;;; Compatibility constants
  98. ;;; The custom variables
  99. (defgroup org nil
  100. "Outline-based notes management and organizer."
  101. :tag "Org"
  102. :group 'outlines
  103. :group 'hypermedia
  104. :group 'calendar)
  105. (defcustom org-load-hook nil
  106. "Hook that is run after org.el has been loaded."
  107. :group 'org
  108. :type 'hook)
  109. (defvar org-modules) ; defined below
  110. (defvar org-modules-loaded nil
  111. "Have the modules been loaded already?")
  112. (defun org-load-modules-maybe (&optional force)
  113. "Load all extensions listed in `org-modules'."
  114. (when (or force (not org-modules-loaded))
  115. (mapc (lambda (ext)
  116. (condition-case nil (require ext)
  117. (error (message "Problems while trying to load feature `%s'" ext))))
  118. org-modules)
  119. (setq org-modules-loaded t)))
  120. (defun org-set-modules (var value)
  121. "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
  122. (set var value)
  123. (when (featurep 'org)
  124. (org-load-modules-maybe 'force)))
  125. (when (org-bound-and-true-p org-modules)
  126. (let ((a (member 'org-infojs org-modules)))
  127. (and a (setcar a 'org-jsinfo))))
  128. (defcustom org-modules '(org-bbdb org-bibtex org-gnus org-info org-jsinfo org-irc org-mew org-mhe org-rmail org-vm org-w3m org-wl)
  129. "Modules that should always be loaded together with org.el.
  130. If a description starts with <C>, the file is not part of Emacs
  131. and loading it will require that you have downloaded and properly installed
  132. the org-mode distribution.
  133. You can also use this system to load external packages (i.e. neither Org
  134. core modules, not modules from the CONTRIB directory). Just add symbols
  135. to the end of the list. If the package is called org-xyz.el, then you need
  136. to add the symbol `xyz', and the package must have a call to
  137. (provide 'org-xyz)"
  138. :group 'org
  139. :set 'org-set-modules
  140. :type
  141. '(set :greedy t
  142. (const :tag " bbdb: Links to BBDB entries" org-bbdb)
  143. (const :tag " bibtex: Links to BibTeX entries" org-bibtex)
  144. (const :tag " gnus: Links to GNUS folders/messages" org-gnus)
  145. (const :tag " id: Global IDs for identifying entries" org-id)
  146. (const :tag " info: Links to Info nodes" org-info)
  147. (const :tag " jsinfo: Set up Sebastian Rose's JavaScript org-info.js" org-jsinfo)
  148. (const :tag " irc: Links to IRC/ERC chat sessions" org-irc)
  149. (const :tag " mac-message: Links to messages in Apple Mail" org-mac-message)
  150. (const :tag " mew Links to Mew folders/messages" org-mew)
  151. (const :tag " mhe: Links to MHE folders/messages" org-mhe)
  152. (const :tag " rmail: Links to RMAIL folders/messages" org-rmail)
  153. (const :tag " vm: Links to VM folders/messages" org-vm)
  154. (const :tag " wl: Links to Wanderlust folders/messages" org-wl)
  155. (const :tag " w3m: Special cut/past from w3m to Org." org-w3m)
  156. (const :tag " mouse: Additional mouse support" org-mouse)
  157. (const :tag "C annotate-file: Annotate a file with org syntax" org-annotate-file)
  158. (const :tag "C annotation-helper: Call Remember directly from Browser" org-annotation-helper)
  159. (const :tag "C bookmark: Org links to bookmarks" org-bookmark)
  160. (const :tag "C browser-url: Store link, directly from Browser" org-browser-url)
  161. (const :tag "C depend: TODO dependencies for Org-mode" org-depend)
  162. (const :tag "C elisp-symbol: Org links to emacs-lisp symbols" org-elisp-symbol)
  163. (const :tag "C eval: Include command output as text" org-eval)
  164. (const :tag "C eval-light: Evaluate inbuffer-code on demand" org-eval-light)
  165. (const :tag "C expiry: Expiry mechanism for Org entries" org-expiry)
  166. (const :tag "C exp-blocks: Pre-process blocks for export" org-exp-blocks)
  167. (const :tag "C interactive-query: Interactive modification of tags query" org-interactive-query)
  168. (const :tag "C mairix: Hook mairix search into Org for different MUAs" org-mairix)
  169. (const :tag "C man: Support for links to manpages in Org-mode" org-man)
  170. (const :tag "C mtags: Support for muse-like tags" org-mtags)
  171. (const :tag "C panel: Simple routines for us with bad memory" org-panel)
  172. (const :tag "C registry: A registry for Org links" org-registry)
  173. (const :tag "C org2rem: Convert org appointments into reminders" org2rem)
  174. (const :tag "C screen: Visit screen sessions through Org-mode links" org-screen)
  175. (const :tag "C toc: Table of contents for Org-mode buffer" org-toc)
  176. (const :tag "C sqlinsert: Convert Org-mode tables to SQL insertions" orgtbl-sqlinsert)
  177. (repeat :tag "External packages" :inline t (symbol :tag "Package"))))
  178. (defgroup org-startup nil
  179. "Options concerning startup of Org-mode."
  180. :tag "Org Startup"
  181. :group 'org)
  182. (defcustom org-startup-folded t
  183. "Non-nil means, entering Org-mode will switch to OVERVIEW.
  184. This can also be configured on a per-file basis by adding one of
  185. the following lines anywhere in the buffer:
  186. #+STARTUP: fold
  187. #+STARTUP: nofold
  188. #+STARTUP: content"
  189. :group 'org-startup
  190. :type '(choice
  191. (const :tag "nofold: show all" nil)
  192. (const :tag "fold: overview" t)
  193. (const :tag "content: all headlines" content)))
  194. (defcustom org-startup-truncated t
  195. "Non-nil means, entering Org-mode will set `truncate-lines'.
  196. This is useful since some lines containing links can be very long and
  197. uninteresting. Also tables look terrible when wrapped."
  198. :group 'org-startup
  199. :type 'boolean)
  200. (defcustom org-startup-align-all-tables nil
  201. "Non-nil means, align all tables when visiting a file.
  202. This is useful when the column width in tables is forced with <N> cookies
  203. in table fields. Such tables will look correct only after the first re-align.
  204. This can also be configured on a per-file basis by adding one of
  205. the following lines anywhere in the buffer:
  206. #+STARTUP: align
  207. #+STARTUP: noalign"
  208. :group 'org-startup
  209. :type 'boolean)
  210. (defcustom org-insert-mode-line-in-empty-file nil
  211. "Non-nil means insert the first line setting Org-mode in empty files.
  212. When the function `org-mode' is called interactively in an empty file, this
  213. normally means that the file name does not automatically trigger Org-mode.
  214. To ensure that the file will always be in Org-mode in the future, a
  215. line enforcing Org-mode will be inserted into the buffer, if this option
  216. has been set."
  217. :group 'org-startup
  218. :type 'boolean)
  219. (defcustom org-replace-disputed-keys nil
  220. "Non-nil means use alternative key bindings for some keys.
  221. Org-mode uses S-<cursor> keys for changing timestamps and priorities.
  222. These keys are also used by other packages like `CUA-mode' or `windmove.el'.
  223. If you want to use Org-mode together with one of these other modes,
  224. or more generally if you would like to move some Org-mode commands to
  225. other keys, set this variable and configure the keys with the variable
  226. `org-disputed-keys'.
  227. This option is only relevant at load-time of Org-mode, and must be set
  228. *before* org.el is loaded. Changing it requires a restart of Emacs to
  229. become effective."
  230. :group 'org-startup
  231. :type 'boolean)
  232. (defcustom org-use-extra-keys nil
  233. "Non-nil means use extra key sequence definitions for certain
  234. commands. This happens automatically if you run XEmacs or if
  235. window-system is nil. This variable lets you do the same
  236. manually. You must set it before loading org.
  237. Example: on Carbon Emacs 22 running graphically, with an external
  238. keyboard on a Powerbook, the default way of setting M-left might
  239. not work for either Alt or ESC. Setting this variable will make
  240. it work for ESC."
  241. :group 'org-startup
  242. :type 'boolean)
  243. (if (fboundp 'defvaralias)
  244. (defvaralias 'org-CUA-compatible 'org-replace-disputed-keys))
  245. (defcustom org-disputed-keys
  246. '(([(shift up)] . [(meta p)])
  247. ([(shift down)] . [(meta n)])
  248. ([(shift left)] . [(meta -)])
  249. ([(shift right)] . [(meta +)])
  250. ([(control shift right)] . [(meta shift +)])
  251. ([(control shift left)] . [(meta shift -)]))
  252. "Keys for which Org-mode and other modes compete.
  253. This is an alist, cars are the default keys, second element specifies
  254. the alternative to use when `org-replace-disputed-keys' is t.
  255. Keys can be specified in any syntax supported by `define-key'.
  256. The value of this option takes effect only at Org-mode's startup,
  257. therefore you'll have to restart Emacs to apply it after changing."
  258. :group 'org-startup
  259. :type 'alist)
  260. (defun org-key (key)
  261. "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
  262. Or return the original if not disputed."
  263. (if org-replace-disputed-keys
  264. (let* ((nkey (key-description key))
  265. (x (org-find-if (lambda (x)
  266. (equal (key-description (car x)) nkey))
  267. org-disputed-keys)))
  268. (if x (cdr x) key))
  269. key))
  270. (defun org-find-if (predicate seq)
  271. (catch 'exit
  272. (while seq
  273. (if (funcall predicate (car seq))
  274. (throw 'exit (car seq))
  275. (pop seq)))))
  276. (defun org-defkey (keymap key def)
  277. "Define a key, possibly translated, as returned by `org-key'."
  278. (define-key keymap (org-key key) def))
  279. (defcustom org-ellipsis nil
  280. "The ellipsis to use in the Org-mode outline.
  281. When nil, just use the standard three dots. When a string, use that instead,
  282. When a face, use the standard 3 dots, but with the specified face.
  283. The change affects only Org-mode (which will then use its own display table).
  284. Changing this requires executing `M-x org-mode' in a buffer to become
  285. effective."
  286. :group 'org-startup
  287. :type '(choice (const :tag "Default" nil)
  288. (face :tag "Face" :value org-warning)
  289. (string :tag "String" :value "...#")))
  290. (defvar org-display-table nil
  291. "The display table for org-mode, in case `org-ellipsis' is non-nil.")
  292. (defgroup org-keywords nil
  293. "Keywords in Org-mode."
  294. :tag "Org Keywords"
  295. :group 'org)
  296. (defcustom org-deadline-string "DEADLINE:"
  297. "String to mark deadline entries.
  298. A deadline is this string, followed by a time stamp. Should be a word,
  299. terminated by a colon. You can insert a schedule keyword and
  300. a timestamp with \\[org-deadline].
  301. Changes become only effective after restarting Emacs."
  302. :group 'org-keywords
  303. :type 'string)
  304. (defcustom org-scheduled-string "SCHEDULED:"
  305. "String to mark scheduled TODO entries.
  306. A schedule is this string, followed by a time stamp. Should be a word,
  307. terminated by a colon. You can insert a schedule keyword and
  308. a timestamp with \\[org-schedule].
  309. Changes become only effective after restarting Emacs."
  310. :group 'org-keywords
  311. :type 'string)
  312. (defcustom org-closed-string "CLOSED:"
  313. "String used as the prefix for timestamps logging closing a TODO entry."
  314. :group 'org-keywords
  315. :type 'string)
  316. (defcustom org-clock-string "CLOCK:"
  317. "String used as prefix for timestamps clocking work hours on an item."
  318. :group 'org-keywords
  319. :type 'string)
  320. (defcustom org-comment-string "COMMENT"
  321. "Entries starting with this keyword will never be exported.
  322. An entry can be toggled between COMMENT and normal with
  323. \\[org-toggle-comment].
  324. Changes become only effective after restarting Emacs."
  325. :group 'org-keywords
  326. :type 'string)
  327. (defcustom org-quote-string "QUOTE"
  328. "Entries starting with this keyword will be exported in fixed-width font.
  329. Quoting applies only to the text in the entry following the headline, and does
  330. not extend beyond the next headline, even if that is lower level.
  331. An entry can be toggled between QUOTE and normal with
  332. \\[org-toggle-fixed-width-section]."
  333. :group 'org-keywords
  334. :type 'string)
  335. (defconst org-repeat-re
  336. "<[0-9]\\{4\\}-[0-9][0-9]-[0-9][0-9] [^>\n]*\\([.+]?\\+[0-9]+[dwmy]\\)"
  337. "Regular expression for specifying repeated events.
  338. After a match, group 1 contains the repeat expression.")
  339. (defgroup org-structure nil
  340. "Options concerning the general structure of Org-mode files."
  341. :tag "Org Structure"
  342. :group 'org)
  343. (defgroup org-reveal-location nil
  344. "Options about how to make context of a location visible."
  345. :tag "Org Reveal Location"
  346. :group 'org-structure)
  347. (defconst org-context-choice
  348. '(choice
  349. (const :tag "Always" t)
  350. (const :tag "Never" nil)
  351. (repeat :greedy t :tag "Individual contexts"
  352. (cons
  353. (choice :tag "Context"
  354. (const agenda)
  355. (const org-goto)
  356. (const occur-tree)
  357. (const tags-tree)
  358. (const link-search)
  359. (const mark-goto)
  360. (const bookmark-jump)
  361. (const isearch)
  362. (const default))
  363. (boolean))))
  364. "Contexts for the reveal options.")
  365. (defcustom org-show-hierarchy-above '((default . t))
  366. "Non-nil means, show full hierarchy when revealing a location.
  367. Org-mode often shows locations in an org-mode file which might have
  368. been invisible before. When this is set, the hierarchy of headings
  369. above the exposed location is shown.
  370. Turning this off for example for sparse trees makes them very compact.
  371. Instead of t, this can also be an alist specifying this option for different
  372. contexts. Valid contexts are
  373. agenda when exposing an entry from the agenda
  374. org-goto when using the command `org-goto' on key C-c C-j
  375. occur-tree when using the command `org-occur' on key C-c /
  376. tags-tree when constructing a sparse tree based on tags matches
  377. link-search when exposing search matches associated with a link
  378. mark-goto when exposing the jump goal of a mark
  379. bookmark-jump when exposing a bookmark location
  380. isearch when exiting from an incremental search
  381. default default for all contexts not set explicitly"
  382. :group 'org-reveal-location
  383. :type org-context-choice)
  384. (defcustom org-show-following-heading '((default . nil))
  385. "Non-nil means, show following heading when revealing a location.
  386. Org-mode often shows locations in an org-mode file which might have
  387. been invisible before. When this is set, the heading following the
  388. match is shown.
  389. Turning this off for example for sparse trees makes them very compact,
  390. but makes it harder to edit the location of the match. In such a case,
  391. use the command \\[org-reveal] to show more context.
  392. Instead of t, this can also be an alist specifying this option for different
  393. contexts. See `org-show-hierarchy-above' for valid contexts."
  394. :group 'org-reveal-location
  395. :type org-context-choice)
  396. (defcustom org-show-siblings '((default . nil) (isearch t))
  397. "Non-nil means, show all sibling heading when revealing a location.
  398. Org-mode often shows locations in an org-mode file which might have
  399. been invisible before. When this is set, the sibling of the current entry
  400. heading are all made visible. If `org-show-hierarchy-above' is t,
  401. the same happens on each level of the hierarchy above the current entry.
  402. By default this is on for the isearch context, off for all other contexts.
  403. Turning this off for example for sparse trees makes them very compact,
  404. but makes it harder to edit the location of the match. In such a case,
  405. use the command \\[org-reveal] to show more context.
  406. Instead of t, this can also be an alist specifying this option for different
  407. contexts. See `org-show-hierarchy-above' for valid contexts."
  408. :group 'org-reveal-location
  409. :type org-context-choice)
  410. (defcustom org-show-entry-below '((default . nil))
  411. "Non-nil means, show the entry below a headline when revealing a location.
  412. Org-mode often shows locations in an org-mode file which might have
  413. been invisible before. When this is set, the text below the headline that is
  414. exposed is also shown.
  415. By default this is off for all contexts.
  416. Instead of t, this can also be an alist specifying this option for different
  417. contexts. See `org-show-hierarchy-above' for valid contexts."
  418. :group 'org-reveal-location
  419. :type org-context-choice)
  420. (defcustom org-indirect-buffer-display 'other-window
  421. "How should indirect tree buffers be displayed?
  422. This applies to indirect buffers created with the commands
  423. \\[org-tree-to-indirect-buffer] and \\[org-agenda-tree-to-indirect-buffer].
  424. Valid values are:
  425. current-window Display in the current window
  426. other-window Just display in another window.
  427. dedicated-frame Create one new frame, and re-use it each time.
  428. new-frame Make a new frame each time. Note that in this case
  429. previously-made indirect buffers are kept, and you need to
  430. kill these buffers yourself."
  431. :group 'org-structure
  432. :group 'org-agenda-windows
  433. :type '(choice
  434. (const :tag "In current window" current-window)
  435. (const :tag "In current frame, other window" other-window)
  436. (const :tag "Each time a new frame" new-frame)
  437. (const :tag "One dedicated frame" dedicated-frame)))
  438. (defgroup org-cycle nil
  439. "Options concerning visibility cycling in Org-mode."
  440. :tag "Org Cycle"
  441. :group 'org-structure)
  442. (defcustom org-drawers '("PROPERTIES" "CLOCK")
  443. "Names of drawers. Drawers are not opened by cycling on the headline above.
  444. Drawers only open with a TAB on the drawer line itself. A drawer looks like
  445. this:
  446. :DRAWERNAME:
  447. .....
  448. :END:
  449. The drawer \"PROPERTIES\" is special for capturing properties through
  450. the property API.
  451. Drawers can be defined on the per-file basis with a line like:
  452. #+DRAWERS: HIDDEN STATE PROPERTIES"
  453. :group 'org-structure
  454. :type '(repeat (string :tag "Drawer Name")))
  455. (defcustom org-cycle-global-at-bob nil
  456. "Cycle globally if cursor is at beginning of buffer and not at a headline.
  457. This makes it possible to do global cycling without having to use S-TAB or
  458. C-u TAB. For this special case to work, the first line of the buffer
  459. must not be a headline - it may be empty ot some other text. When used in
  460. this way, `org-cycle-hook' is disables temporarily, to make sure the
  461. cursor stays at the beginning of the buffer.
  462. When this option is nil, don't do anything special at the beginning
  463. of the buffer."
  464. :group 'org-cycle
  465. :type 'boolean)
  466. (defcustom org-cycle-emulate-tab t
  467. "Where should `org-cycle' emulate TAB.
  468. nil Never
  469. white Only in completely white lines
  470. whitestart Only at the beginning of lines, before the first non-white char
  471. t Everywhere except in headlines
  472. exc-hl-bol Everywhere except at the start of a headline
  473. If TAB is used in a place where it does not emulate TAB, the current subtree
  474. visibility is cycled."
  475. :group 'org-cycle
  476. :type '(choice (const :tag "Never" nil)
  477. (const :tag "Only in completely white lines" white)
  478. (const :tag "Before first char in a line" whitestart)
  479. (const :tag "Everywhere except in headlines" t)
  480. (const :tag "Everywhere except at bol in headlines" exc-hl-bol)
  481. ))
  482. (defcustom org-cycle-separator-lines 2
  483. "Number of empty lines needed to keep an empty line between collapsed trees.
  484. If you leave an empty line between the end of a subtree and the following
  485. headline, this empty line is hidden when the subtree is folded.
  486. Org-mode will leave (exactly) one empty line visible if the number of
  487. empty lines is equal or larger to the number given in this variable.
  488. So the default 2 means, at least 2 empty lines after the end of a subtree
  489. are needed to produce free space between a collapsed subtree and the
  490. following headline.
  491. Special case: when 0, never leave empty lines in collapsed view."
  492. :group 'org-cycle
  493. :type 'integer)
  494. (put 'org-cycle-separator-lines 'safe-local-variable 'integerp)
  495. (defcustom org-cycle-hook '(org-cycle-hide-archived-subtrees
  496. org-cycle-hide-drawers
  497. org-cycle-show-empty-lines
  498. org-optimize-window-after-visibility-change)
  499. "Hook that is run after `org-cycle' has changed the buffer visibility.
  500. The function(s) in this hook must accept a single argument which indicates
  501. the new state that was set by the most recent `org-cycle' command. The
  502. argument is a symbol. After a global state change, it can have the values
  503. `overview', `content', or `all'. After a local state change, it can have
  504. the values `folded', `children', or `subtree'."
  505. :group 'org-cycle
  506. :type 'hook)
  507. (defgroup org-edit-structure nil
  508. "Options concerning structure editing in Org-mode."
  509. :tag "Org Edit Structure"
  510. :group 'org-structure)
  511. (defcustom org-odd-levels-only nil
  512. "Non-nil means, skip even levels and only use odd levels for the outline.
  513. This has the effect that two stars are being added/taken away in
  514. promotion/demotion commands. It also influences how levels are
  515. handled by the exporters.
  516. Changing it requires restart of `font-lock-mode' to become effective
  517. for fontification also in regions already fontified.
  518. You may also set this on a per-file basis by adding one of the following
  519. lines to the buffer:
  520. #+STARTUP: odd
  521. #+STARTUP: oddeven"
  522. :group 'org-edit-structure
  523. :group 'org-font-lock
  524. :type 'boolean)
  525. (defcustom org-adapt-indentation t
  526. "Non-nil means, adapt indentation when promoting and demoting.
  527. When this is set and the *entire* text in an entry is indented, the
  528. indentation is increased by one space in a demotion command, and
  529. decreased by one in a promotion command. If any line in the entry
  530. body starts at column 0, indentation is not changed at all."
  531. :group 'org-edit-structure
  532. :type 'boolean)
  533. (defcustom org-special-ctrl-a/e nil
  534. "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
  535. When t, `C-a' will bring back the cursor to the beginning of the
  536. headline text, i.e. after the stars and after a possible TODO keyword.
  537. In an item, this will be the position after the bullet.
  538. When the cursor is already at that position, another `C-a' will bring
  539. it to the beginning of the line.
  540. `C-e' will jump to the end of the headline, ignoring the presence of tags
  541. in the headline. A second `C-e' will then jump to the true end of the
  542. line, after any tags.
  543. When set to the symbol `reversed', the first `C-a' or `C-e' works normally,
  544. and only a directly following, identical keypress will bring the cursor
  545. to the special positions."
  546. :group 'org-edit-structure
  547. :type '(choice
  548. (const :tag "off" nil)
  549. (const :tag "after bullet first" t)
  550. (const :tag "border first" reversed)))
  551. (if (fboundp 'defvaralias)
  552. (defvaralias 'org-special-ctrl-a 'org-special-ctrl-a/e))
  553. (defcustom org-special-ctrl-k nil
  554. "Non-nil means `C-k' will behave specially in headlines.
  555. When nil, `C-k' will call the default `kill-line' command.
  556. When t, the following will happen while the cursor is in the headline:
  557. - When the cursor is at the beginning of a headline, kill the entire
  558. line and possible the folded subtree below the line.
  559. - When in the middle of the headline text, kill the headline up to the tags.
  560. - When after the headline text, kill the tags."
  561. :group 'org-edit-structure
  562. :type 'boolean)
  563. (defcustom org-yank-folded-subtrees t
  564. "Non-nil means, when yanking subtrees, fold them.
  565. If the kill is a single subtree, or a sequence of subtrees, i.e. if
  566. it starts with a heading and all other headings in it are either children
  567. or siblings, then fold all the subtrees. However, do this only if no
  568. text after the yank would be swallowed into a folded tree by this action."
  569. :group 'org-edit-structure
  570. :type 'boolean)
  571. (defcustom org-yank-adjusted-subtrees t
  572. "Non-nil means, when yanking subtrees, adjust the level.
  573. With this setting, `org-paste-subtree' is used to insert the subtree, see
  574. this function for details."
  575. :group 'org-edit-structure
  576. :type 'boolean)
  577. (defcustom org-M-RET-may-split-line '((default . t))
  578. "Non-nil means, M-RET will split the line at the cursor position.
  579. When nil, it will go to the end of the line before making a
  580. new line.
  581. You may also set this option in a different way for different
  582. contexts. Valid contexts are:
  583. headline when creating a new headline
  584. item when creating a new item
  585. table in a table field
  586. default the value to be used for all contexts not explicitly
  587. customized"
  588. :group 'org-structure
  589. :group 'org-table
  590. :type '(choice
  591. (const :tag "Always" t)
  592. (const :tag "Never" nil)
  593. (repeat :greedy t :tag "Individual contexts"
  594. (cons
  595. (choice :tag "Context"
  596. (const headline)
  597. (const item)
  598. (const table)
  599. (const default))
  600. (boolean)))))
  601. (defcustom org-insert-heading-respect-content nil
  602. "Non-nil means, insert new headings after the current subtree.
  603. When nil, the new heading is created directly after the current line.
  604. The commands \\[org-insert-heading-respect-content] and
  605. \\[org-insert-todo-heading-respect-content] turn this variable on
  606. for the duration of the command."
  607. :group 'org-structure
  608. :type 'boolean)
  609. (defcustom org-blank-before-new-entry '((heading . nil)
  610. (plain-list-item . nil))
  611. "Should `org-insert-heading' leave a blank line before new heading/item?
  612. The value is an alist, with `heading' and `plain-list-item' as car,
  613. and a boolean flag as cdr."
  614. :group 'org-edit-structure
  615. :type '(list
  616. (cons (const heading) (boolean))
  617. (cons (const plain-list-item) (boolean))))
  618. (defcustom org-insert-heading-hook nil
  619. "Hook being run after inserting a new heading."
  620. :group 'org-edit-structure
  621. :type 'hook)
  622. (defcustom org-enable-fixed-width-editor t
  623. "Non-nil means, lines starting with \":\" are treated as fixed-width.
  624. This currently only means, they are never auto-wrapped.
  625. When nil, such lines will be treated like ordinary lines.
  626. See also the QUOTE keyword."
  627. :group 'org-edit-structure
  628. :type 'boolean)
  629. (defcustom org-edit-src-region-extra nil
  630. "Additional regexps to identify regions for editing with `org-edit-src-code'.
  631. For examples see the function `org-edit-src-find-region-and-lang'.
  632. The regular expression identifying the begin marker should end with a newline,
  633. and the regexp marking the end line should start with a newline, to make sure
  634. there are kept outside the narrowed region."
  635. :group 'org-edit-structure
  636. :type '(repeat
  637. (list
  638. (regexp :tag "begin regexp")
  639. (regexp :tag "end regexp")
  640. (choice :tag "language"
  641. (string :tag "specify")
  642. (integer :tag "from match group")
  643. (const :tag "from `lang' element")
  644. (const :tag "from `style' element")))))
  645. (defcustom org-coderef-label-format "(ref:%s)"
  646. "The default coderef format.
  647. This format string will be used to search for coderef labels in literal
  648. examples (EXAMPLE and SRC blocks). The format can be overwritten
  649. an individual literal example with the -f option, like
  650. #+BEGIN_SRC pascal +n -r -l \"((%s))\"
  651. ...
  652. #+END_SRC
  653. If you want to use this for HTML export, make sure that the format does
  654. not introduce special font-locking, and avoid the HTML special
  655. characters `<', `>', and `&'. The reason for this restriction is that
  656. the labels are searched for only after htmlize has done its job."
  657. :group 'org-edit-structure ; FIXME this is not in the right group
  658. :type 'string)
  659. (defcustom org-edit-fixed-width-region-mode 'artist-mode
  660. "The mode that should be used to edit fixed-width regions.
  661. These are the regions where each line starts with a colon."
  662. :group 'org-edit-structure
  663. :type '(choice
  664. (const artist-mode)
  665. (const picture-mode)
  666. (const fundamental-mode)
  667. (function :tag "Other (specify)")))
  668. (defcustom org-goto-auto-isearch t
  669. "Non-nil means, typing characters in org-goto starts incremental search."
  670. :group 'org-edit-structure
  671. :type 'boolean)
  672. (defgroup org-sparse-trees nil
  673. "Options concerning sparse trees in Org-mode."
  674. :tag "Org Sparse Trees"
  675. :group 'org-structure)
  676. (defcustom org-highlight-sparse-tree-matches t
  677. "Non-nil means, highlight all matches that define a sparse tree.
  678. The highlights will automatically disappear the next time the buffer is
  679. changed by an edit command."
  680. :group 'org-sparse-trees
  681. :type 'boolean)
  682. (defcustom org-remove-highlights-with-change t
  683. "Non-nil means, any change to the buffer will remove temporary highlights.
  684. Such highlights are created by `org-occur' and `org-clock-display'.
  685. When nil, `C-c C-c needs to be used to get rid of the highlights.
  686. The highlights created by `org-preview-latex-fragment' always need
  687. `C-c C-c' to be removed."
  688. :group 'org-sparse-trees
  689. :group 'org-time
  690. :type 'boolean)
  691. (defcustom org-occur-hook '(org-first-headline-recenter)
  692. "Hook that is run after `org-occur' has constructed a sparse tree.
  693. This can be used to recenter the window to show as much of the structure
  694. as possible."
  695. :group 'org-sparse-trees
  696. :type 'hook)
  697. (defgroup org-imenu-and-speedbar nil
  698. "Options concerning imenu and speedbar in Org-mode."
  699. :tag "Org Imenu and Speedbar"
  700. :group 'org-structure)
  701. (defcustom org-imenu-depth 2
  702. "The maximum level for Imenu access to Org-mode headlines.
  703. This also applied for speedbar access."
  704. :group 'org-imenu-and-speedbar
  705. :type 'number)
  706. (defgroup org-table nil
  707. "Options concerning tables in Org-mode."
  708. :tag "Org Table"
  709. :group 'org)
  710. (defcustom org-enable-table-editor 'optimized
  711. "Non-nil means, lines starting with \"|\" are handled by the table editor.
  712. When nil, such lines will be treated like ordinary lines.
  713. When equal to the symbol `optimized', the table editor will be optimized to
  714. do the following:
  715. - Automatic overwrite mode in front of whitespace in table fields.
  716. This makes the structure of the table stay in tact as long as the edited
  717. field does not exceed the column width.
  718. - Minimize the number of realigns. Normally, the table is aligned each time
  719. TAB or RET are pressed to move to another field. With optimization this
  720. happens only if changes to a field might have changed the column width.
  721. Optimization requires replacing the functions `self-insert-command',
  722. `delete-char', and `backward-delete-char' in Org-mode buffers, with a
  723. slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
  724. very good at guessing when a re-align will be necessary, but you can always
  725. force one with \\[org-ctrl-c-ctrl-c].
  726. If you would like to use the optimized version in Org-mode, but the
  727. un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
  728. This variable can be used to turn on and off the table editor during a session,
  729. but in order to toggle optimization, a restart is required.
  730. See also the variable `org-table-auto-blank-field'."
  731. :group 'org-table
  732. :type '(choice
  733. (const :tag "off" nil)
  734. (const :tag "on" t)
  735. (const :tag "on, optimized" optimized)))
  736. (defcustom org-table-tab-recognizes-table.el t
  737. "Non-nil means, TAB will automatically notice a table.el table.
  738. When it sees such a table, it moves point into it and - if necessary -
  739. calls `table-recognize-table'."
  740. :group 'org-table-editing
  741. :type 'boolean)
  742. (defgroup org-link nil
  743. "Options concerning links in Org-mode."
  744. :tag "Org Link"
  745. :group 'org)
  746. (defvar org-link-abbrev-alist-local nil
  747. "Buffer-local version of `org-link-abbrev-alist', which see.
  748. The value of this is taken from the #+LINK lines.")
  749. (make-variable-buffer-local 'org-link-abbrev-alist-local)
  750. (defcustom org-link-abbrev-alist nil
  751. "Alist of link abbreviations.
  752. The car of each element is a string, to be replaced at the start of a link.
  753. The cdrs are replacement values, like (\"linkkey\" . REPLACE). Abbreviated
  754. links in Org-mode buffers can have an optional tag after a double colon, e.g.
  755. [[linkkey:tag][description]]
  756. If REPLACE is a string, the tag will simply be appended to create the link.
  757. If the string contains \"%s\", the tag will be inserted there. Alternatively,
  758. the placeholder \"%h\" will cause a url-encoded version of the tag to
  759. be inserted at that point (see the function `url-hexify-string').
  760. REPLACE may also be a function that will be called with the tag as the
  761. only argument to create the link, which should be returned as a string.
  762. See the manual for examples."
  763. :group 'org-link
  764. :type '(repeat
  765. (cons
  766. (string :tag "Protocol")
  767. (choice
  768. (string :tag "Format")
  769. (function)))))
  770. (defcustom org-descriptive-links t
  771. "Non-nil means, hide link part and only show description of bracket links.
  772. Bracket links are like [[link][description]]. This variable sets the initial
  773. state in new org-mode buffers. The setting can then be toggled on a
  774. per-buffer basis from the Org->Hyperlinks menu."
  775. :group 'org-link
  776. :type 'boolean)
  777. (defcustom org-link-file-path-type 'adaptive
  778. "How the path name in file links should be stored.
  779. Valid values are:
  780. relative Relative to the current directory, i.e. the directory of the file
  781. into which the link is being inserted.
  782. absolute Absolute path, if possible with ~ for home directory.
  783. noabbrev Absolute path, no abbreviation of home directory.
  784. adaptive Use relative path for files in the current directory and sub-
  785. directories of it. For other files, use an absolute path."
  786. :group 'org-link
  787. :type '(choice
  788. (const relative)
  789. (const absolute)
  790. (const noabbrev)
  791. (const adaptive)))
  792. (defcustom org-activate-links '(bracket angle plain radio tag date footnote)
  793. "Types of links that should be activated in Org-mode files.
  794. This is a list of symbols, each leading to the activation of a certain link
  795. type. In principle, it does not hurt to turn on most link types - there may
  796. be a small gain when turning off unused link types. The types are:
  797. bracket The recommended [[link][description]] or [[link]] links with hiding.
  798. angular Links in angular brackets that may contain whitespace like
  799. <bbdb:Carsten Dominik>.
  800. plain Plain links in normal text, no whitespace, like http://google.com.
  801. radio Text that is matched by a radio target, see manual for details.
  802. tag Tag settings in a headline (link to tag search).
  803. date Time stamps (link to calendar).
  804. footnote Footnote labels.
  805. Changing this variable requires a restart of Emacs to become effective."
  806. :group 'org-link
  807. :type '(set :greedy t
  808. (const :tag "Double bracket links (new style)" bracket)
  809. (const :tag "Angular bracket links (old style)" angular)
  810. (const :tag "Plain text links" plain)
  811. (const :tag "Radio target matches" radio)
  812. (const :tag "Tags" tag)
  813. (const :tag "Timestamps" date)
  814. (const :tag "Footnotes" footnote)))
  815. (defcustom org-make-link-description-function nil
  816. "Function to use to generate link descriptions from links. If
  817. nil the link location will be used. This function must take two
  818. parameters; the first is the link and the second the description
  819. org-insert-link has generated, and should return the description
  820. to use."
  821. :group 'org-link
  822. :type 'function)
  823. (defgroup org-link-store nil
  824. "Options concerning storing links in Org-mode."
  825. :tag "Org Store Link"
  826. :group 'org-link)
  827. (defcustom org-email-link-description-format "Email %c: %.30s"
  828. "Format of the description part of a link to an email or usenet message.
  829. The following %-escapes will be replaced by corresponding information:
  830. %F full \"From\" field
  831. %f name, taken from \"From\" field, address if no name
  832. %T full \"To\" field
  833. %t first name in \"To\" field, address if no name
  834. %c correspondent. Usually \"from NAME\", but if you sent it yourself, it
  835. will be \"to NAME\". See also the variable `org-from-is-user-regexp'.
  836. %s subject
  837. %m message-id.
  838. You may use normal field width specification between the % and the letter.
  839. This is for example useful to limit the length of the subject.
  840. Examples: \"%f on: %.30s\", \"Email from %f\", \"Email %c\""
  841. :group 'org-link-store
  842. :type 'string)
  843. (defcustom org-from-is-user-regexp
  844. (let (r1 r2)
  845. (when (and user-mail-address (not (string= user-mail-address "")))
  846. (setq r1 (concat "\\<" (regexp-quote user-mail-address) "\\>")))
  847. (when (and user-full-name (not (string= user-full-name "")))
  848. (setq r2 (concat "\\<" (regexp-quote user-full-name) "\\>")))
  849. (if (and r1 r2) (concat r1 "\\|" r2) (or r1 r2)))
  850. "Regexp matched against the \"From:\" header of an email or usenet message.
  851. It should match if the message is from the user him/herself."
  852. :group 'org-link-store
  853. :type 'regexp)
  854. (defcustom org-link-to-org-use-id 'create-if-interactive
  855. "Non-nil means, storing a link to an Org file will use entry IDs.
  856. Note that before this variable is even considered, org-id must be loaded,
  857. to please customize `org-modules' and turn it on.
  858. The variable can have the following values:
  859. t Create an ID if needed to make a link to the current entry.
  860. create-if-interactive
  861. If `org-store-link' is called directly (interactively, as a user
  862. command), do create an ID to support the link. But when doing the
  863. job for remember, only use the ID if it already exists. The
  864. purpose of this setting is to avoid proliferation of unwanted
  865. IDs, just because you happen to be in an Org file when you
  866. call `org-remember' that automatically and preemptively
  867. creates a link. If you do want to get an ID link in a remember
  868. template to an entry not having an ID, create it first by
  869. explicitly creating a link to it, using `C-c C-l' first.
  870. use-existing
  871. Use existing ID, do not create one.
  872. nil Never use an ID to make a link, instead link using a text search for
  873. the headline text."
  874. :group 'org-link-store
  875. :type '(choice
  876. (const :tag "Create ID to make link" t)
  877. (const :tag "Create if string link interactively"
  878. 'create-if-interactive)
  879. (const :tag "Only use existing" 'use-existing)
  880. (const :tag "Do not use ID to create link" nil)))
  881. (defcustom org-context-in-file-links t
  882. "Non-nil means, file links from `org-store-link' contain context.
  883. A search string will be added to the file name with :: as separator and
  884. used to find the context when the link is activated by the command
  885. `org-open-at-point'.
  886. Using a prefix arg to the command \\[org-store-link] (`org-store-link')
  887. negates this setting for the duration of the command."
  888. :group 'org-link-store
  889. :type 'boolean)
  890. (defcustom org-keep-stored-link-after-insertion nil
  891. "Non-nil means, keep link in list for entire session.
  892. The command `org-store-link' adds a link pointing to the current
  893. location to an internal list. These links accumulate during a session.
  894. The command `org-insert-link' can be used to insert links into any
  895. Org-mode file (offering completion for all stored links). When this
  896. option is nil, every link which has been inserted once using \\[org-insert-link]
  897. will be removed from the list, to make completing the unused links
  898. more efficient."
  899. :group 'org-link-store
  900. :type 'boolean)
  901. (defgroup org-link-follow nil
  902. "Options concerning following links in Org-mode."
  903. :tag "Org Follow Link"
  904. :group 'org-link)
  905. (defcustom org-link-translation-function nil
  906. "Function to translate links with different syntax to Org syntax.
  907. This can be used to translate links created for example by the Planner
  908. or emacs-wiki packages to Org syntax.
  909. The function must accept two parameters, a TYPE containing the link
  910. protocol name like \"rmail\" or \"gnus\" as a string, and the linked path,
  911. which is everything after the link protocol. It should return a cons
  912. with possibly modified values of type and path.
  913. Org contains a function for this, so if you set this variable to
  914. `org-translate-link-from-planner', you should be able follow many
  915. links created by planner."
  916. :group 'org-link-follow
  917. :type 'function)
  918. (defcustom org-follow-link-hook nil
  919. "Hook that is run after a link has been followed."
  920. :group 'org-link-follow
  921. :type 'hook)
  922. (defcustom org-tab-follows-link nil
  923. "Non-nil means, on links TAB will follow the link.
  924. Needs to be set before org.el is loaded."
  925. :group 'org-link-follow
  926. :type 'boolean)
  927. (defcustom org-return-follows-link nil
  928. "Non-nil means, on links RET will follow the link.
  929. Needs to be set before org.el is loaded."
  930. :group 'org-link-follow
  931. :type 'boolean)
  932. (defcustom org-mouse-1-follows-link
  933. (if (boundp 'mouse-1-click-follows-link) mouse-1-click-follows-link t)
  934. "Non-nil means, mouse-1 on a link will follow the link.
  935. A longer mouse click will still set point. Does not work on XEmacs.
  936. Needs to be set before org.el is loaded."
  937. :group 'org-link-follow
  938. :type 'boolean)
  939. (defcustom org-mark-ring-length 4
  940. "Number of different positions to be recorded in the ring
  941. Changing this requires a restart of Emacs to work correctly."
  942. :group 'org-link-follow
  943. :type 'integer)
  944. (defcustom org-link-frame-setup
  945. '((vm . vm-visit-folder-other-frame)
  946. (gnus . gnus-other-frame)
  947. (file . find-file-other-window))
  948. "Setup the frame configuration for following links.
  949. When following a link with Emacs, it may often be useful to display
  950. this link in another window or frame. This variable can be used to
  951. set this up for the different types of links.
  952. For VM, use any of
  953. `vm-visit-folder'
  954. `vm-visit-folder-other-frame'
  955. For Gnus, use any of
  956. `gnus'
  957. `gnus-other-frame'
  958. `org-gnus-no-new-news'
  959. For FILE, use any of
  960. `find-file'
  961. `find-file-other-window'
  962. `find-file-other-frame'
  963. For the calendar, use the variable `calendar-setup'.
  964. For BBDB, it is currently only possible to display the matches in
  965. another window."
  966. :group 'org-link-follow
  967. :type '(list
  968. (cons (const vm)
  969. (choice
  970. (const vm-visit-folder)
  971. (const vm-visit-folder-other-window)
  972. (const vm-visit-folder-other-frame)))
  973. (cons (const gnus)
  974. (choice
  975. (const gnus)
  976. (const gnus-other-frame)
  977. (const org-gnus-no-new-news)))
  978. (cons (const file)
  979. (choice
  980. (const find-file)
  981. (const find-file-other-window)
  982. (const find-file-other-frame)))))
  983. (defcustom org-display-internal-link-with-indirect-buffer nil
  984. "Non-nil means, use indirect buffer to display infile links.
  985. Activating internal links (from one location in a file to another location
  986. in the same file) normally just jumps to the location. When the link is
  987. activated with a C-u prefix (or with mouse-3), the link is displayed in
  988. another window. When this option is set, the other window actually displays
  989. an indirect buffer clone of the current buffer, to avoid any visibility
  990. changes to the current buffer."
  991. :group 'org-link-follow
  992. :type 'boolean)
  993. (defcustom org-open-non-existing-files nil
  994. "Non-nil means, `org-open-file' will open non-existing files.
  995. When nil, an error will be generated."
  996. :group 'org-link-follow
  997. :type 'boolean)
  998. (defcustom org-open-directory-means-index-dot-org nil
  999. "Non-nil means, a link to a directory really means to index.org.
  1000. When nil, following a directory link will run dired or open a finder/explorer
  1001. window on that directory."
  1002. :group 'org-link-follow
  1003. :type 'boolean)
  1004. (defcustom org-link-mailto-program '(browse-url "mailto:%a?subject=%s")
  1005. "Function and arguments to call for following mailto links.
  1006. This is a list with the first element being a lisp function, and the
  1007. remaining elements being arguments to the function. In string arguments,
  1008. %a will be replaced by the address, and %s will be replaced by the subject
  1009. if one was given like in <mailto:arthur@galaxy.org::this subject>."
  1010. :group 'org-link-follow
  1011. :type '(choice
  1012. (const :tag "browse-url" (browse-url-mail "mailto:%a?subject=%s"))
  1013. (const :tag "compose-mail" (compose-mail "%a" "%s"))
  1014. (const :tag "message-mail" (message-mail "%a" "%s"))
  1015. (cons :tag "other" (function) (repeat :tag "argument" sexp))))
  1016. (defcustom org-confirm-shell-link-function 'yes-or-no-p
  1017. "Non-nil means, ask for confirmation before executing shell links.
  1018. Shell links can be dangerous: just think about a link
  1019. [[shell:rm -rf ~/*][Google Search]]
  1020. This link would show up in your Org-mode document as \"Google Search\",
  1021. but really it would remove your entire home directory.
  1022. Therefore we advise against setting this variable to nil.
  1023. Just change it to `y-or-n-p' of you want to confirm with a
  1024. single keystroke rather than having to type \"yes\"."
  1025. :group 'org-link-follow
  1026. :type '(choice
  1027. (const :tag "with yes-or-no (safer)" yes-or-no-p)
  1028. (const :tag "with y-or-n (faster)" y-or-n-p)
  1029. (const :tag "no confirmation (dangerous)" nil)))
  1030. (defcustom org-confirm-elisp-link-function 'yes-or-no-p
  1031. "Non-nil means, ask for confirmation before executing Emacs Lisp links.
  1032. Elisp links can be dangerous: just think about a link
  1033. [[elisp:(shell-command \"rm -rf ~/*\")][Google Search]]
  1034. This link would show up in your Org-mode document as \"Google Search\",
  1035. but really it would remove your entire home directory.
  1036. Therefore we advise against setting this variable to nil.
  1037. Just change it to `y-or-n-p' of you want to confirm with a
  1038. single keystroke rather than having to type \"yes\"."
  1039. :group 'org-link-follow
  1040. :type '(choice
  1041. (const :tag "with yes-or-no (safer)" yes-or-no-p)
  1042. (const :tag "with y-or-n (faster)" y-or-n-p)
  1043. (const :tag "no confirmation (dangerous)" nil)))
  1044. (defconst org-file-apps-defaults-gnu
  1045. '((remote . emacs)
  1046. (system . mailcap)
  1047. (t . mailcap))
  1048. "Default file applications on a UNIX or GNU/Linux system.
  1049. See `org-file-apps'.")
  1050. (defconst org-file-apps-defaults-macosx
  1051. '((remote . emacs)
  1052. (t . "open %s")
  1053. (system . "open %s")
  1054. ("ps.gz" . "gv %s")
  1055. ("eps.gz" . "gv %s")
  1056. ("dvi" . "xdvi %s")
  1057. ("fig" . "xfig %s"))
  1058. "Default file applications on a MacOS X system.
  1059. The system \"open\" is known as a default, but we use X11 applications
  1060. for some files for which the OS does not have a good default.
  1061. See `org-file-apps'.")
  1062. (defconst org-file-apps-defaults-windowsnt
  1063. (list
  1064. '(remote . emacs)
  1065. (cons t
  1066. (list (if (featurep 'xemacs)
  1067. 'mswindows-shell-execute
  1068. 'w32-shell-execute)
  1069. "open" 'file))
  1070. (cons 'system
  1071. (list (if (featurep 'xemacs)
  1072. 'mswindows-shell-execute
  1073. 'w32-shell-execute)
  1074. "open" 'file)))
  1075. "Default file applications on a Windows NT system.
  1076. The system \"open\" is used for most files.
  1077. See `org-file-apps'.")
  1078. (defcustom org-file-apps
  1079. '(
  1080. (auto-mode . emacs)
  1081. ("\\.x?html?\\'" . default)
  1082. ("\\.pdf\\'" . default)
  1083. )
  1084. "External applications for opening `file:path' items in a document.
  1085. Org-mode uses system defaults for different file types, but
  1086. you can use this variable to set the application for a given file
  1087. extension. The entries in this list are cons cells where the car identifies
  1088. files and the cdr the corresponding command. Possible values for the
  1089. file identifier are
  1090. \"regex\" Regular expression matched against the file name. For backward
  1091. compatibility, this can also be a string with only alphanumeric
  1092. characters, which is then interpreted as an extension.
  1093. `directory' Matches a directory
  1094. `remote' Matches a remote file, accessible through tramp or efs.
  1095. Remote files most likely should be visited through Emacs
  1096. because external applications cannot handle such paths.
  1097. `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
  1098. so all files Emacs knows how to handle. Using this with
  1099. command `emacs' will open most files in Emacs. Beware that this
  1100. will also open html files inside Emacs, unless you add
  1101. (\"html\" . default) to the list as well.
  1102. t Default for files not matched by any of the other options.
  1103. `system' The system command to open files, like `open' on Windows
  1104. and Mac OS X, and mailcap under GNU/Linux. This is the command
  1105. that will be selected if you call `C-c C-o' with a double
  1106. `C-u C-u' prefix.
  1107. Possible values for the command are:
  1108. `emacs' The file will be visited by the current Emacs process.
  1109. `default' Use the default application for this file type, which is the
  1110. association for t in the list, most likely in the system-specific
  1111. part.
  1112. This can be used to overrule an unwanted setting in the
  1113. system-specific variable.
  1114. `system' Use the system command for opening files, like \"open\".
  1115. This command is specified by the entry whose car is `system'.
  1116. Most likely, the system-specific version of this variable
  1117. does define this command, but you can overrule/replace it
  1118. here.
  1119. string A command to be executed by a shell; %s will be replaced
  1120. by the path to the file.
  1121. sexp A Lisp form which will be evaluated. The file path will
  1122. be available in the Lisp variable `file'.
  1123. For more examples, see the system specific constants
  1124. `org-file-apps-defaults-macosx'
  1125. `org-file-apps-defaults-windowsnt'
  1126. `org-file-apps-defaults-gnu'."
  1127. :group 'org-link-follow
  1128. :type '(repeat
  1129. (cons (choice :value ""
  1130. (string :tag "Extension")
  1131. (const :tag "System command to open files" system)
  1132. (const :tag "Default for unrecognized files" t)
  1133. (const :tag "Remote file" remote)
  1134. (const :tag "Links to a directory" directory)
  1135. (const :tag "Any files that have Emacs modes"
  1136. auto-mode))
  1137. (choice :value ""
  1138. (const :tag "Visit with Emacs" emacs)
  1139. (const :tag "Use default" default)
  1140. (const :tag "Use the system command" system)
  1141. (string :tag "Command")
  1142. (sexp :tag "Lisp form")))))
  1143. (defgroup org-refile nil
  1144. "Options concerning refiling entries in Org-mode."
  1145. :tag "Org Refile"
  1146. :group 'org)
  1147. (defcustom org-directory "~/org"
  1148. "Directory with org files.
  1149. This directory will be used as default to prompt for org files.
  1150. Used by the hooks for remember.el."
  1151. :group 'org-refile
  1152. :group 'org-remember
  1153. :type 'directory)
  1154. (defcustom org-default-notes-file (convert-standard-filename "~/.notes")
  1155. "Default target for storing notes.
  1156. Used by the hooks for remember.el. This can be a string, or nil to mean
  1157. the value of `remember-data-file'.
  1158. You can set this on a per-template basis with the variable
  1159. `org-remember-templates'."
  1160. :group 'org-refile
  1161. :group 'org-remember
  1162. :type '(choice
  1163. (const :tag "Default from remember-data-file" nil)
  1164. file))
  1165. (defcustom org-goto-interface 'outline
  1166. "The default interface to be used for `org-goto'.
  1167. Allowed values are:
  1168. outline The interface shows an outline of the relevant file
  1169. and the correct heading is found by moving through
  1170. the outline or by searching with incremental search.
  1171. outline-path-completion Headlines in the current buffer are offered via
  1172. completion. This is the interface also used by
  1173. the refile command."
  1174. :group 'org-refile
  1175. :type '(choice
  1176. (const :tag "Outline" outline)
  1177. (const :tag "Outline-path-completion" outline-path-completion)))
  1178. (defcustom org-goto-max-level 5
  1179. "Maximum level to be considered when running org-goto with refile interface."
  1180. :group 'org-refile
  1181. :type 'number)
  1182. (defcustom org-reverse-note-order nil
  1183. "Non-nil means, store new notes at the beginning of a file or entry.
  1184. When nil, new notes will be filed to the end of a file or entry.
  1185. This can also be a list with cons cells of regular expressions that
  1186. are matched against file names, and values."
  1187. :group 'org-remember
  1188. :group 'org-refile
  1189. :type '(choice
  1190. (const :tag "Reverse always" t)
  1191. (const :tag "Reverse never" nil)
  1192. (repeat :tag "By file name regexp"
  1193. (cons regexp boolean))))
  1194. (defcustom org-refile-targets nil
  1195. "Targets for refiling entries with \\[org-refile].
  1196. This is list of cons cells. Each cell contains:
  1197. - a specification of the files to be considered, either a list of files,
  1198. or a symbol whose function or variable value will be used to retrieve
  1199. a file name or a list of file names. If you use `org-agenda-files' for
  1200. that, all agenda files will be scanned for targets. Nil means, consider
  1201. headings in the current buffer.
  1202. - A specification of how to select find candidate refile targets. This
  1203. may be any of
  1204. - a cons cell (:tag . \"TAG\") to identify refile targets by a tag.
  1205. This tag has to be present in all target headlines, inheritance will
  1206. not be considered.
  1207. - a cons cell (:todo . \"KEYWORD\") to identify refile targets by
  1208. todo keyword.
  1209. - a cons cell (:regexp . \"REGEXP\") with a regular expression matching
  1210. headlines that are refiling targets.
  1211. - a cons cell (:level . N). Any headline of level N is considered a target.
  1212. - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
  1213. When this variable is nil, all top-level headlines in the current buffer
  1214. are used, equivalent to the value `((nil . (:level . 1))'."
  1215. :group 'org-refile
  1216. :type '(repeat
  1217. (cons
  1218. (choice :value org-agenda-files
  1219. (const :tag "All agenda files" org-agenda-files)
  1220. (const :tag "Current buffer" nil)
  1221. (function) (variable) (file))
  1222. (choice :tag "Identify target headline by"
  1223. (cons :tag "Specific tag" (const :value :tag) (string))
  1224. (cons :tag "TODO keyword" (const :value :todo) (string))
  1225. (cons :tag "Regular expression" (const :value :regexp) (regexp))
  1226. (cons :tag "Level number" (const :value :level) (integer))
  1227. (cons :tag "Max Level number" (const :value :maxlevel) (integer))))))
  1228. (defcustom org-refile-use-outline-path nil
  1229. "Non-nil means, provide refile targets as paths.
  1230. So a level 3 headline will be available as level1/level2/level3.
  1231. When the value is `file', also include the file name (without directory)
  1232. into the path. When `full-file-path', include the full file path."
  1233. :group 'org-refile
  1234. :type '(choice
  1235. (const :tag "Not" nil)
  1236. (const :tag "Yes" t)
  1237. (const :tag "Start with file name" file)
  1238. (const :tag "Start with full file path" full-file-path)))
  1239. (defcustom org-outline-path-complete-in-steps t
  1240. "Non-nil means, complete the outline path in hierarchical steps.
  1241. When Org-mode uses the refile interface to select an outline path
  1242. \(see variable `org-refile-use-outline-path'), the completion of
  1243. the path can be done is a single go, or if can be done in steps down
  1244. the headline hierarchy. Going in steps is probably the best if you
  1245. do not use a special completion package like `ido' or `icicles'.
  1246. However, when using these packages, going in one step can be very
  1247. fast, while still showing the whole path to the entry."
  1248. :group 'org-refile
  1249. :type 'boolean)
  1250. (defgroup org-todo nil
  1251. "Options concerning TODO items in Org-mode."
  1252. :tag "Org TODO"
  1253. :group 'org)
  1254. (defgroup org-progress nil
  1255. "Options concerning Progress logging in Org-mode."
  1256. :tag "Org Progress"
  1257. :group 'org-time)
  1258. (defcustom org-todo-keywords '((sequence "TODO" "DONE"))
  1259. "List of TODO entry keyword sequences and their interpretation.
  1260. \\<org-mode-map>This is a list of sequences.
  1261. Each sequence starts with a symbol, either `sequence' or `type',
  1262. indicating if the keywords should be interpreted as a sequence of
  1263. action steps, or as different types of TODO items. The first
  1264. keywords are states requiring action - these states will select a headline
  1265. for inclusion into the global TODO list Org-mode produces. If one of
  1266. the \"keywords\" is the vertical bat \"|\" the remaining keywords
  1267. signify that no further action is necessary. If \"|\" is not found,
  1268. the last keyword is treated as the only DONE state of the sequence.
  1269. The command \\[org-todo] cycles an entry through these states, and one
  1270. additional state where no keyword is present. For details about this
  1271. cycling, see the manual.
  1272. TODO keywords and interpretation can also be set on a per-file basis with
  1273. the special #+SEQ_TODO and #+TYP_TODO lines.
  1274. Each keyword can optionally specify a character for fast state selection
  1275. \(in combination with the variable `org-use-fast-todo-selection')
  1276. and specifiers for state change logging, using the same syntax
  1277. that is used in the \"#+TODO:\" lines. For example, \"WAIT(w)\" says
  1278. that the WAIT state can be selected with the \"w\" key. \"WAIT(w!)\"
  1279. indicates to record a time stamp each time this state is selected.
  1280. Each keyword may also specify if a timestamp or a note should be
  1281. recorded when entering or leaving the state, by adding additional
  1282. characters in the parenthesis after the keyword. This looks like this:
  1283. \"WAIT(w@/!)\". \"@\" means to add a note (with time), \"!\" means to
  1284. record only the time of the state change. With X and Y being either
  1285. \"@\" or \"!\", \"X/Y\" means use X when entering the state, and use
  1286. Y when leaving the state if and only if the *target* state does not
  1287. define X. You may omit any of the fast-selection key or X or /Y,
  1288. so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
  1289. For backward compatibility, this variable may also be just a list
  1290. of keywords - in this case the interpretation (sequence or type) will be
  1291. taken from the (otherwise obsolete) variable `org-todo-interpretation'."
  1292. :group 'org-todo
  1293. :group 'org-keywords
  1294. :type '(choice
  1295. (repeat :tag "Old syntax, just keywords"
  1296. (string :tag "Keyword"))
  1297. (repeat :tag "New syntax"
  1298. (cons
  1299. (choice
  1300. :tag "Interpretation"
  1301. (const :tag "Sequence (cycling hits every state)" sequence)
  1302. (const :tag "Type (cycling directly to DONE)" type))
  1303. (repeat
  1304. (string :tag "Keyword"))))))
  1305. (defvar org-todo-keywords-1 nil
  1306. "All TODO and DONE keywords active in a buffer.")
  1307. (make-variable-buffer-local 'org-todo-keywords-1)
  1308. (defvar org-todo-keywords-for-agenda nil)
  1309. (defvar org-done-keywords-for-agenda nil)
  1310. (defvar org-todo-keyword-alist-for-agenda nil)
  1311. (defvar org-tag-alist-for-agenda nil)
  1312. (defvar org-agenda-contributing-files nil)
  1313. (defvar org-not-done-keywords nil)
  1314. (make-variable-buffer-local 'org-not-done-keywords)
  1315. (defvar org-done-keywords nil)
  1316. (make-variable-buffer-local 'org-done-keywords)
  1317. (defvar org-todo-heads nil)
  1318. (make-variable-buffer-local 'org-todo-heads)
  1319. (defvar org-todo-sets nil)
  1320. (make-variable-buffer-local 'org-todo-sets)
  1321. (defvar org-todo-log-states nil)
  1322. (make-variable-buffer-local 'org-todo-log-states)
  1323. (defvar org-todo-kwd-alist nil)
  1324. (make-variable-buffer-local 'org-todo-kwd-alist)
  1325. (defvar org-todo-key-alist nil)
  1326. (make-variable-buffer-local 'org-todo-key-alist)
  1327. (defvar org-todo-key-trigger nil)
  1328. (make-variable-buffer-local 'org-todo-key-trigger)
  1329. (defcustom org-todo-interpretation 'sequence
  1330. "Controls how TODO keywords are interpreted.
  1331. This variable is in principle obsolete and is only used for
  1332. backward compatibility, if the interpretation of todo keywords is
  1333. not given already in `org-todo-keywords'. See that variable for
  1334. more information."
  1335. :group 'org-todo
  1336. :group 'org-keywords
  1337. :type '(choice (const sequence)
  1338. (const type)))
  1339. (defcustom org-use-fast-todo-selection 'prefix
  1340. "Non-nil means, use the fast todo selection scheme with C-c C-t.
  1341. This variable describes if and under what circumstances the cycling
  1342. mechanism for TODO keywords will be replaced by a single-key, direct
  1343. selection scheme.
  1344. When nil, fast selection is never used.
  1345. When the symbol `prefix', it will be used when `org-todo' is called with
  1346. a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
  1347. in an agenda buffer.
  1348. When t, fast selection is used by default. In this case, the prefix
  1349. argument forces cycling instead.
  1350. In all cases, the special interface is only used if access keys have actually
  1351. been assigned by the user, i.e. if keywords in the configuration are followed
  1352. by a letter in parenthesis, like TODO(t)."
  1353. :group 'org-todo
  1354. :type '(choice
  1355. (const :tag "Never" nil)
  1356. (const :tag "By default" t)
  1357. (const :tag "Only with C-u C-c C-t" prefix)))
  1358. (defcustom org-provide-todo-statistics t
  1359. "Non-nil means, update todo statistics after insert and toggle.
  1360. When this is set, todo statistics is updated in the parent of the current
  1361. entry each time a todo state is changed."
  1362. :group 'org-todo
  1363. :type 'boolean)
  1364. (defcustom org-after-todo-state-change-hook nil
  1365. "Hook which is run after the state of a TODO item was changed.
  1366. The new state (a string with a TODO keyword, or nil) is available in the
  1367. Lisp variable `state'."
  1368. :group 'org-todo
  1369. :type 'hook)
  1370. (defcustom org-todo-state-tags-triggers nil
  1371. "Tag changes that should be triggered by TODO state changes.
  1372. This is a list. Each entry is
  1373. (state-change (tag . flag) .......)
  1374. State-change can be a string with a state, and empty string to indicate the
  1375. state that has no TODO keyword, or it can be one of the symbols `todo'
  1376. or `done', meaning any not-done or done state, respectively."
  1377. :group 'org-todo
  1378. :group 'org-tags
  1379. :type '(repeat
  1380. (cons (choice :tag "When changing to"
  1381. (const :tag "Not-done state" todo)
  1382. (const :tag "Done state" done)
  1383. (string :tag "State"))
  1384. (repeat
  1385. (cons :tag "Tag action"
  1386. (string :tag "Tag")
  1387. (choice (const :tag "Add" t) (const :tag "Remove" nil)))))))
  1388. (defcustom org-log-done nil
  1389. "Information to record when a task moves to the DONE state.
  1390. Possible values are:
  1391. nil Don't add anything, just change the keyword
  1392. time Add a time stamp to the task
  1393. note Prompt a closing note and add it with template `org-log-note-headings'
  1394. This option can also be set with on a per-file-basis with
  1395. #+STARTUP: nologdone
  1396. #+STARTUP: logdone
  1397. #+STARTUP: lognotedone
  1398. You can have local logging settings for a subtree by setting the LOGGING
  1399. property to one or more of these keywords."
  1400. :group 'org-todo
  1401. :group 'org-progress
  1402. :type '(choice
  1403. (const :tag "No logging" nil)
  1404. (const :tag "Record CLOSED timestamp" time)
  1405. (const :tag "Record CLOSED timestamp with closing note." note)))
  1406. ;; Normalize old uses of org-log-done.
  1407. (cond
  1408. ((eq org-log-done t) (setq org-log-done 'time))
  1409. ((and (listp org-log-done) (memq 'done org-log-done))
  1410. (setq org-log-done 'note)))
  1411. (defcustom org-log-note-clock-out nil
  1412. "Non-nil means, record a note when clocking out of an item.
  1413. This can also be configured on a per-file basis by adding one of
  1414. the following lines anywhere in the buffer:
  1415. #+STARTUP: lognoteclock-out
  1416. #+STARTUP: nolognoteclock-out"
  1417. :group 'org-todo
  1418. :group 'org-progress
  1419. :type 'boolean)
  1420. (defcustom org-log-done-with-time t
  1421. "Non-nil means, the CLOSED time stamp will contain date and time.
  1422. When nil, only the date will be recorded."
  1423. :group 'org-progress
  1424. :type 'boolean)
  1425. (defcustom org-log-note-headings
  1426. '((done . "CLOSING NOTE %t")
  1427. (state . "State %-12s %t")
  1428. (note . "Note taken on %t")
  1429. (clock-out . ""))
  1430. "Headings for notes added to entries.
  1431. The value is an alist, with the car being a symbol indicating the note
  1432. context, and the cdr is the heading to be used. The heading may also be the
  1433. empty string.
  1434. %t in the heading will be replaced by a time stamp.
  1435. %s will be replaced by the new TODO state, in double quotes.
  1436. %u will be replaced by the user name.
  1437. %U will be replaced by the full user name."
  1438. :group 'org-todo
  1439. :group 'org-progress
  1440. :type '(list :greedy t
  1441. (cons (const :tag "Heading when closing an item" done) string)
  1442. (cons (const :tag
  1443. "Heading when changing todo state (todo sequence only)"
  1444. state) string)
  1445. (cons (const :tag "Heading when just taking a note" note) string)
  1446. (cons (const :tag "Heading when clocking out" clock-out) string)))
  1447. (unless (assq 'note org-log-note-headings)
  1448. (push '(note . "%t") org-log-note-headings))
  1449. (defcustom org-log-state-notes-insert-after-drawers nil
  1450. "Non-nil means, insert state change notes after any drawers in entry.
  1451. Only the drawers that *immediately* follow the headline and the
  1452. deadline/scheduled line are skipped.
  1453. When nil, insert notes right after the heading and perhaps the line
  1454. with deadline/scheduling if present."
  1455. :group 'org-todo
  1456. :group 'org-progress
  1457. :type 'boolean)
  1458. (defcustom org-log-states-order-reversed t
  1459. "Non-nil means, the latest state change note will be directly after heading.
  1460. When nil, the notes will be orderer according to time."
  1461. :group 'org-todo
  1462. :group 'org-progress
  1463. :type 'boolean)
  1464. (defcustom org-log-repeat 'time
  1465. "Non-nil means, record moving through the DONE state when triggering repeat.
  1466. An auto-repeating tasks is immediately switched back to TODO when marked
  1467. done. If you are not logging state changes (by adding \"@\" or \"!\" to
  1468. the TODO keyword definition, or recording a closing note by setting
  1469. `org-log-done', there will be no record of the task moving through DONE.
  1470. This variable forces taking a note anyway. Possible values are:
  1471. nil Don't force a record
  1472. time Record a time stamp
  1473. note Record a note
  1474. This option can also be set with on a per-file-basis with
  1475. #+STARTUP: logrepeat
  1476. #+STARTUP: lognoterepeat
  1477. #+STARTUP: nologrepeat
  1478. You can have local logging settings for a subtree by setting the LOGGING
  1479. property to one or more of these keywords."
  1480. :group 'org-todo
  1481. :group 'org-progress
  1482. :type '(choice
  1483. (const :tag "Don't force a record" nil)
  1484. (const :tag "Force recording the DONE state" time)
  1485. (const :tag "Force recording a note with the DONE state" note)))
  1486. (defgroup org-priorities nil
  1487. "Priorities in Org-mode."
  1488. :tag "Org Priorities"
  1489. :group 'org-todo)
  1490. (defcustom org-highest-priority ?A
  1491. "The highest priority of TODO items. A character like ?A, ?B etc.
  1492. Must have a smaller ASCII number than `org-lowest-priority'."
  1493. :group 'org-priorities
  1494. :type 'character)
  1495. (defcustom org-lowest-priority ?C
  1496. "The lowest priority of TODO items. A character like ?A, ?B etc.
  1497. Must have a larger ASCII number than `org-highest-priority'."
  1498. :group 'org-priorities
  1499. :type 'character)
  1500. (defcustom org-default-priority ?B
  1501. "The default priority of TODO items.
  1502. This is the priority an item get if no explicit priority is given."
  1503. :group 'org-priorities
  1504. :type 'character)
  1505. (defcustom org-priority-start-cycle-with-default t
  1506. "Non-nil means, start with default priority when starting to cycle.
  1507. When this is nil, the first step in the cycle will be (depending on the
  1508. command used) one higher or lower that the default priority."
  1509. :group 'org-priorities
  1510. :type 'boolean)
  1511. (defgroup org-time nil
  1512. "Options concerning time stamps and deadlines in Org-mode."
  1513. :tag "Org Time"
  1514. :group 'org)
  1515. (defcustom org-insert-labeled-timestamps-at-point nil
  1516. "Non-nil means, SCHEDULED and DEADLINE timestamps are inserted at point.
  1517. When nil, these labeled time stamps are forces into the second line of an
  1518. entry, just after the headline. When scheduling from the global TODO list,
  1519. the time stamp will always be forced into the second line."
  1520. :group 'org-time
  1521. :type 'boolean)
  1522. (defconst org-time-stamp-formats '("<%Y-%m-%d %a>" . "<%Y-%m-%d %a %H:%M>")
  1523. "Formats for `format-time-string' which are used for time stamps.
  1524. It is not recommended to change this constant.")
  1525. (defcustom org-time-stamp-rounding-minutes '(0 5)
  1526. "Number of minutes to round time stamps to.
  1527. These are two values, the first applies when first creating a time stamp.
  1528. The second applies when changing it with the commands `S-up' and `S-down'.
  1529. When changing the time stamp, this means that it will change in steps
  1530. of N minutes, as given by the second value.
  1531. When a setting is 0 or 1, insert the time unmodified. Useful rounding
  1532. numbers should be factors of 60, so for example 5, 10, 15.
  1533. When this is larger than 1, you can still force an exact time-stamp by using
  1534. a double prefix argument to a time-stamp command like `C-c .' or `C-c !',
  1535. and by using a prefix arg to `S-up/down' to specify the exact number
  1536. of minutes to shift."
  1537. :group 'org-time
  1538. :get '(lambda (var) ; Make sure all entries have 5 elements
  1539. (if (integerp (default-value var))
  1540. (list (default-value var) 5)
  1541. (default-value var)))
  1542. :type '(list
  1543. (integer :tag "when inserting times")
  1544. (integer :tag "when modifying times")))
  1545. ;; Normalize old customizations of this variable.
  1546. (when (integerp org-time-stamp-rounding-minutes)
  1547. (setq org-time-stamp-rounding-minutes
  1548. (list org-time-stamp-rounding-minutes
  1549. org-time-stamp-rounding-minutes)))
  1550. (defcustom org-display-custom-times nil
  1551. "Non-nil means, overlay custom formats over all time stamps.
  1552. The formats are defined through the variable `org-time-stamp-custom-formats'.
  1553. To turn this on on a per-file basis, insert anywhere in the file:
  1554. #+STARTUP: customtime"
  1555. :group 'org-time
  1556. :set 'set-default
  1557. :type 'sexp)
  1558. (make-variable-buffer-local 'org-display-custom-times)
  1559. (defcustom org-time-stamp-custom-formats
  1560. '("<%m/%d/%y %a>" . "<%m/%d/%y %a %H:%M>") ; american
  1561. "Custom formats for time stamps. See `format-time-string' for the syntax.
  1562. These are overlayed over the default ISO format if the variable
  1563. `org-display-custom-times' is set. Time like %H:%M should be at the
  1564. end of the second format."
  1565. :group 'org-time
  1566. :type 'sexp)
  1567. (defun org-time-stamp-format (&optional long inactive)
  1568. "Get the right format for a time string."
  1569. (let ((f (if long (cdr org-time-stamp-formats)
  1570. (car org-time-stamp-formats))))
  1571. (if inactive
  1572. (concat "[" (substring f 1 -1) "]")
  1573. f)))
  1574. (defcustom org-time-clocksum-format "%d:%02d"
  1575. "The format string used when creating CLOCKSUM lines, or when
  1576. org-mode generates a time duration."
  1577. :group 'org-time
  1578. :type 'string)
  1579. (defcustom org-deadline-warning-days 14
  1580. "No. of days before expiration during which a deadline becomes active.
  1581. This variable governs the display in sparse trees and in the agenda.
  1582. When 0 or negative, it means use this number (the absolute value of it)
  1583. even if a deadline has a different individual lead time specified."
  1584. :group 'org-time
  1585. :group 'org-agenda-daily/weekly
  1586. :type 'number)
  1587. (defcustom org-read-date-prefer-future t
  1588. "Non-nil means, assume future for incomplete date input from user.
  1589. This affects the following situations:
  1590. 1. The user gives a day, but no month.
  1591. For example, if today is the 15th, and you enter \"3\", Org-mode will
  1592. read this as the third of *next* month. However, if you enter \"17\",
  1593. it will be considered as *this* month.
  1594. 2. The user gives a month but not a year.
  1595. For example, if it is april and you enter \"feb 2\", this will be read
  1596. as feb 2, *next* year. \"May 5\", however, will be this year.
  1597. Currently this does not work for ISO week specifications.
  1598. When this option is nil, the current month and year will always be used
  1599. as defaults."
  1600. :group 'org-time
  1601. :type 'boolean)
  1602. (defcustom org-read-date-display-live t
  1603. "Non-nil means, display current interpretation of date prompt live.
  1604. This display will be in an overlay, in the minibuffer."
  1605. :group 'org-time
  1606. :type 'boolean)
  1607. (defcustom org-read-date-popup-calendar t
  1608. "Non-nil means, pop up a calendar when prompting for a date.
  1609. In the calendar, the date can be selected with mouse-1. However, the
  1610. minibuffer will also be active, and you can simply enter the date as well.
  1611. When nil, only the minibuffer will be available."
  1612. :group 'org-time
  1613. :type 'boolean)
  1614. (if (fboundp 'defvaralias)
  1615. (defvaralias 'org-popup-calendar-for-date-prompt
  1616. 'org-read-date-popup-calendar))
  1617. (defcustom org-extend-today-until 0
  1618. "The hour when your day really ends. Must be an integer.
  1619. This has influence for the following applications:
  1620. - When switching the agenda to \"today\". It it is still earlier than
  1621. the time given here, the day recognized as TODAY is actually yesterday.
  1622. - When a date is read from the user and it is still before the time given
  1623. here, the current date and time will be assumed to be yesterday, 23:59.
  1624. Also, timestamps inserted in remember templates follow this rule.
  1625. IMPORTANT: This is a feature whose implementation is and likely will
  1626. remain incomplete. Really, it is only here because past midnight seems to
  1627. be the favorite working time of John Wiegley :-)"
  1628. :group 'org-time
  1629. :type 'number)
  1630. (defcustom org-edit-timestamp-down-means-later nil
  1631. "Non-nil means, S-down will increase the time in a time stamp.
  1632. When nil, S-up will increase."
  1633. :group 'org-time
  1634. :type 'boolean)
  1635. (defcustom org-calendar-follow-timestamp-change t
  1636. "Non-nil means, make the calendar window follow timestamp changes.
  1637. When a timestamp is modified and the calendar window is visible, it will be
  1638. moved to the new date."
  1639. :group 'org-time
  1640. :type 'boolean)
  1641. (defgroup org-tags nil
  1642. "Options concerning tags in Org-mode."
  1643. :tag "Org Tags"
  1644. :group 'org)
  1645. (defcustom org-tag-alist nil
  1646. "List of tags allowed in Org-mode files.
  1647. When this list is nil, Org-mode will base TAG input on what is already in the
  1648. buffer.
  1649. The value of this variable is an alist, the car of each entry must be a
  1650. keyword as a string, the cdr may be a character that is used to select
  1651. that tag through the fast-tag-selection interface.
  1652. See the manual for details."
  1653. :group 'org-tags
  1654. :type '(repeat
  1655. (choice
  1656. (cons (string :tag "Tag name")
  1657. (character :tag "Access char"))
  1658. (const :tag "Start radio group" (:startgroup))
  1659. (const :tag "End radio group" (:endgroup)))))
  1660. (defvar org-file-tags nil
  1661. "List of tags that can be inherited by all entries in the file.
  1662. The tags will be inherited if the variable `org-use-tag-inheritance'
  1663. says they should be.
  1664. This variable is populated from #+TAG lines.")
  1665. (defcustom org-use-fast-tag-selection 'auto
  1666. "Non-nil means, use fast tag selection scheme.
  1667. This is a special interface to select and deselect tags with single keys.
  1668. When nil, fast selection is never used.
  1669. When the symbol `auto', fast selection is used if and only if selection
  1670. characters for tags have been configured, either through the variable
  1671. `org-tag-alist' or through a #+TAGS line in the buffer.
  1672. When t, fast selection is always used and selection keys are assigned
  1673. automatically if necessary."
  1674. :group 'org-tags
  1675. :type '(choice
  1676. (const :tag "Always" t)
  1677. (const :tag "Never" nil)
  1678. (const :tag "When selection characters are configured" 'auto)))
  1679. (defcustom org-fast-tag-selection-single-key nil
  1680. "Non-nil means, fast tag selection exits after first change.
  1681. When nil, you have to press RET to exit it.
  1682. During fast tag selection, you can toggle this flag with `C-c'.
  1683. This variable can also have the value `expert'. In this case, the window
  1684. displaying the tags menu is not even shown, until you press C-c again."
  1685. :group 'org-tags
  1686. :type '(choice
  1687. (const :tag "No" nil)
  1688. (const :tag "Yes" t)
  1689. (const :tag "Expert" expert)))
  1690. (defvar org-fast-tag-selection-include-todo nil
  1691. "Non-nil means, fast tags selection interface will also offer TODO states.
  1692. This is an undocumented feature, you should not rely on it.")
  1693. (defcustom org-tags-column (if (featurep 'xemacs) -79 -80)
  1694. "The column to which tags should be indented in a headline.
  1695. If this number is positive, it specifies the column. If it is negative,
  1696. it means that the tags should be flushright to that column. For example,
  1697. -80 works well for a normal 80 character screen."
  1698. :group 'org-tags
  1699. :type 'integer)
  1700. (defcustom org-auto-align-tags t
  1701. "Non-nil means, realign tags after pro/demotion of TODO state change.
  1702. These operations change the length of a headline and therefore shift
  1703. the tags around. With this options turned on, after each such operation
  1704. the tags are again aligned to `org-tags-column'."
  1705. :group 'org-tags
  1706. :type 'boolean)
  1707. (defcustom org-use-tag-inheritance t
  1708. "Non-nil means, tags in levels apply also for sublevels.
  1709. When nil, only the tags directly given in a specific line apply there.
  1710. This may also be a list of tags that should be inherited, or a regexp that
  1711. matches tags that should be inherited. Additional control is possible
  1712. with the variable `org-tags-exclude-from-inheritance' which gives an
  1713. explicit list of tags to be excluded from inheritance., even if the value of
  1714. `org-use-tag-inheritance' would select it for inheritance.
  1715. If this option is t, a match early-on in a tree can lead to a large
  1716. number of matches in the subtree when constructing the agenda or creating
  1717. a sparse tree. If you only want to see the first match in a tree during
  1718. a search, check out the variable `org-tags-match-list-sublevels'."
  1719. :group 'org-tags
  1720. :type '(choice
  1721. (const :tag "Not" nil)
  1722. (const :tag "Always" t)
  1723. (repeat :tag "Specific tags" (string :tag "Tag"))
  1724. (regexp :tag "Tags matched by regexp")))
  1725. (defcustom org-tags-exclude-from-inheritance nil
  1726. "List of tags that should never be inherited.
  1727. This is a way to exclude a few tags from inheritance. For way to do
  1728. the opposite, to actively allow inheritance for selected tags,
  1729. see the variable `org-use-tag-inheritance'."
  1730. :group 'org-tags
  1731. :type '(repeat (string :tag "Tag")))
  1732. (defun org-tag-inherit-p (tag)
  1733. "Check if TAG is one that should be inherited."
  1734. (cond
  1735. ((member tag org-tags-exclude-from-inheritance) nil)
  1736. ((eq org-use-tag-inheritance t) t)
  1737. ((not org-use-tag-inheritance) nil)
  1738. ((stringp org-use-tag-inheritance)
  1739. (string-match org-use-tag-inheritance tag))
  1740. ((listp org-use-tag-inheritance)
  1741. (member tag org-use-tag-inheritance))
  1742. (t (error "Invalid setting of `org-use-tag-inheritance'"))))
  1743. (defcustom org-tags-match-list-sublevels t
  1744. "Non-nil means list also sublevels of headlines matching tag search.
  1745. Because of tag inheritance (see variable `org-use-tag-inheritance'),
  1746. the sublevels of a headline matching a tag search often also match
  1747. the same search. Listing all of them can create very long lists.
  1748. Setting this variable to nil causes subtrees of a match to be skipped.
  1749. This option is off by default, because inheritance in on. If you turn
  1750. inheritance off, you very likely want to turn this option on.
  1751. As a special case, if the tag search is restricted to TODO items, the
  1752. value of this variable is ignored and sublevels are always checked, to
  1753. make sure all corresponding TODO items find their way into the list.
  1754. This variable is semi-obsolete and probably should always be true. It
  1755. is better to limit inheritance to certain tags using the variables
  1756. `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
  1757. :group 'org-tags
  1758. :type 'boolean)
  1759. (defvar org-tags-history nil
  1760. "History of minibuffer reads for tags.")
  1761. (defvar org-last-tags-completion-table nil
  1762. "The last used completion table for tags.")
  1763. (defvar org-after-tags-change-hook nil
  1764. "Hook that is run after the tags in a line have changed.")
  1765. (defgroup org-properties nil
  1766. "Options concerning properties in Org-mode."
  1767. :tag "Org Properties"
  1768. :group 'org)
  1769. (defcustom org-property-format "%-10s %s"
  1770. "How property key/value pairs should be formatted by `indent-line'.
  1771. When `indent-line' hits a property definition, it will format the line
  1772. according to this format, mainly to make sure that the values are
  1773. lined-up with respect to each other."
  1774. :group 'org-properties
  1775. :type 'string)
  1776. (defcustom org-use-property-inheritance nil
  1777. "Non-nil means, properties apply also for sublevels.
  1778. This setting is chiefly used during property searches. Turning it on can
  1779. cause significant overhead when doing a search, which is why it is not
  1780. on by default.
  1781. When nil, only the properties directly given in the current entry count.
  1782. When t, every property is inherited. The value may also be a list of
  1783. properties that should have inheritance, or a regular expression matching
  1784. properties that should be inherited.
  1785. However, note that some special properties use inheritance under special
  1786. circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
  1787. and the properties ending in \"_ALL\" when they are used as descriptor
  1788. for valid values of a property.
  1789. Note for programmers:
  1790. When querying an entry with `org-entry-get', you can control if inheritance
  1791. should be used. By default, `org-entry-get' looks only at the local
  1792. properties. You can request inheritance by setting the inherit argument
  1793. to t (to force inheritance) or to `selective' (to respect the setting
  1794. in this variable)."
  1795. :group 'org-properties
  1796. :type '(choice
  1797. (const :tag "Not" nil)
  1798. (const :tag "Always" t)
  1799. (repeat :tag "Specific properties" (string :tag "Property"))
  1800. (regexp :tag "Properties matched by regexp")))
  1801. (defun org-property-inherit-p (property)
  1802. "Check if PROPERTY is one that should be inherited."
  1803. (cond
  1804. ((eq org-use-property-inheritance t) t)
  1805. ((not org-use-property-inheritance) nil)
  1806. ((stringp org-use-property-inheritance)
  1807. (string-match org-use-property-inheritance property))
  1808. ((listp org-use-property-inheritance)
  1809. (member property org-use-property-inheritance))
  1810. (t (error "Invalid setting of `org-use-property-inheritance'"))))
  1811. (defcustom org-columns-default-format "%25ITEM %TODO %3PRIORITY %TAGS"
  1812. "The default column format, if no other format has been defined.
  1813. This variable can be set on the per-file basis by inserting a line
  1814. #+COLUMNS: %25ITEM ....."
  1815. :group 'org-properties
  1816. :type 'string)
  1817. (defcustom org-columns-ellipses ".."
  1818. "The ellipses to be used when a field in column view is truncated.
  1819. When this is the empty string, as many characters as possible are shown,
  1820. but then there will be no visual indication that the field has been truncated.
  1821. When this is a string of length N, the last N characters of a truncated
  1822. field are replaced by this string. If the column is narrower than the
  1823. ellipses string, only part of the ellipses string will be shown."
  1824. :group 'org-properties
  1825. :type 'string)
  1826. (defcustom org-columns-modify-value-for-display-function nil
  1827. "Function that modifies values for display in column view.
  1828. For example, it can be used to cut out a certain part from a time stamp.
  1829. The function must take 2 arguments:
  1830. column-title The title of the column (*not* the property name)
  1831. value The value that should be modified.
  1832. The function should return the value that should be displayed,
  1833. or nil if the normal value should be used."
  1834. :group 'org-properties
  1835. :type 'function)
  1836. (defcustom org-effort-property "Effort"
  1837. "The property that is being used to keep track of effort estimates.
  1838. Effort estimates given in this property need to have the format H:MM."
  1839. :group 'org-properties
  1840. :group 'org-progress
  1841. :type '(string :tag "Property"))
  1842. (defconst org-global-properties-fixed
  1843. '(("VISIBILITY_ALL" . "folded children content all"))
  1844. "List of property/value pairs that can be inherited by any entry.
  1845. These are fixed values, for the preset properties.")
  1846. (defcustom org-global-properties nil
  1847. "List of property/value pairs that can be inherited by any entry.
  1848. You can set buffer-local values for the same purpose in the variable
  1849. `org-file-properties' this by adding lines like
  1850. #+PROPERTY: NAME VALUE"
  1851. :group 'org-properties
  1852. :type '(repeat
  1853. (cons (string :tag "Property")
  1854. (string :tag "Value"))))
  1855. (defvar org-file-properties nil
  1856. "List of property/value pairs that can be inherited by any entry.
  1857. Valid for the current buffer.
  1858. This variable is populated from #+PROPERTY lines.")
  1859. (make-variable-buffer-local 'org-file-properties)
  1860. (defgroup org-agenda nil
  1861. "Options concerning agenda views in Org-mode."
  1862. :tag "Org Agenda"
  1863. :group 'org)
  1864. (defvar org-category nil
  1865. "Variable used by org files to set a category for agenda display.
  1866. Such files should use a file variable to set it, for example
  1867. # -*- mode: org; org-category: \"ELisp\"
  1868. or contain a special line
  1869. #+CATEGORY: ELisp
  1870. If the file does not specify a category, then file's base name
  1871. is used instead.")
  1872. (make-variable-buffer-local 'org-category)
  1873. (put 'org-category 'safe-local-variable '(lambda (x) (or (symbolp x) (stringp x))))
  1874. (defcustom org-agenda-files nil
  1875. "The files to be used for agenda display.
  1876. Entries may be added to this list with \\[org-agenda-file-to-front] and removed with
  1877. \\[org-remove-file]. You can also use customize to edit the list.
  1878. If an entry is a directory, all files in that directory that are matched by
  1879. `org-agenda-file-regexp' will be part of the file list.
  1880. If the value of the variable is not a list but a single file name, then
  1881. the list of agenda files is actually stored and maintained in that file, one
  1882. agenda file per line."
  1883. :group 'org-agenda
  1884. :type '(choice
  1885. (repeat :tag "List of files and directories" file)
  1886. (file :tag "Store list in a file\n" :value "~/.agenda_files")))
  1887. (defcustom org-agenda-file-regexp "\\`[^.].*\\.org\\'"
  1888. "Regular expression to match files for `org-agenda-files'.
  1889. If any element in the list in that variable contains a directory instead
  1890. of a normal file, all files in that directory that are matched by this
  1891. regular expression will be included."
  1892. :group 'org-agenda
  1893. :type 'regexp)
  1894. (defcustom org-agenda-text-search-extra-files nil
  1895. "List of extra files to be searched by text search commands.
  1896. These files will be search in addition to the agenda files by the
  1897. commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
  1898. Note that these files will only be searched for text search commands,
  1899. not for the other agenda views like todo lists, tag searches or the weekly
  1900. agenda. This variable is intended to list notes and possibly archive files
  1901. that should also be searched by these two commands.
  1902. In fact, if the first element in the list is the symbol `agenda-archives',
  1903. than all archive files of all agenda files will be added to the search
  1904. scope."
  1905. :group 'org-agenda
  1906. :type '(set :greedy t
  1907. (const :tag "Agenda Archives" agenda-archives)
  1908. (repeat :inline t (file))))
  1909. (if (fboundp 'defvaralias)
  1910. (defvaralias 'org-agenda-multi-occur-extra-files
  1911. 'org-agenda-text-search-extra-files))
  1912. (defcustom org-agenda-skip-unavailable-files nil
  1913. "Non-nil means to just skip non-reachable files in `org-agenda-files'.
  1914. A nil value means to remove them, after a query, from the list."
  1915. :group 'org-agenda
  1916. :type 'boolean)
  1917. (defcustom org-calendar-to-agenda-key [?c]
  1918. "The key to be installed in `calendar-mode-map' for switching to the agenda.
  1919. The command `org-calendar-goto-agenda' will be bound to this key. The
  1920. default is the character `c' because then `c' can be used to switch back and
  1921. forth between agenda and calendar."
  1922. :group 'org-agenda
  1923. :type 'sexp)
  1924. (defcustom org-calendar-agenda-action-key [?k]
  1925. "The key to be installed in `calendar-mode-map' for agenda-action.
  1926. The command `org-agenda-action' will be bound to this key. The
  1927. default is the character `k' because we use the same key in the agenda."
  1928. :group 'org-agenda
  1929. :type 'sexp)
  1930. (eval-after-load "calendar"
  1931. '(progn
  1932. (org-defkey calendar-mode-map org-calendar-to-agenda-key
  1933. 'org-calendar-goto-agenda)
  1934. (org-defkey calendar-mode-map org-calendar-agenda-action-key
  1935. 'org-agenda-action)))
  1936. (defgroup org-latex nil
  1937. "Options for embedding LaTeX code into Org-mode."
  1938. :tag "Org LaTeX"
  1939. :group 'org)
  1940. (defcustom org-format-latex-options
  1941. '(:foreground default :background default :scale 1.0
  1942. :html-foreground "Black" :html-background "Transparent" :html-scale 1.0
  1943. :matchers ("begin" "$" "$$" "\\(" "\\["))
  1944. "Options for creating images from LaTeX fragments.
  1945. This is a property list with the following properties:
  1946. :foreground the foreground color for images embedded in Emacs, e.g. \"Black\".
  1947. `default' means use the foreground of the default face.
  1948. :background the background color, or \"Transparent\".
  1949. `default' means use the background of the default face.
  1950. :scale a scaling factor for the size of the images.
  1951. :html-foreground, :html-background, :html-scale
  1952. the same numbers for HTML export.
  1953. :matchers a list indicating which matchers should be used to
  1954. find LaTeX fragments. Valid members of this list are:
  1955. \"begin\" find environments
  1956. \"$\" find math expressions surrounded by $...$
  1957. \"$$\" find math expressions surrounded by $$....$$
  1958. \"\\(\" find math expressions surrounded by \\(...\\)
  1959. \"\\ [\" find math expressions surrounded by \\ [...\\]"
  1960. :group 'org-latex
  1961. :type 'plist)
  1962. (defcustom org-format-latex-header "\\documentclass{article}
  1963. \\usepackage{fullpage} % do not remove
  1964. \\usepackage{amssymb}
  1965. \\usepackage[usenames]{color}
  1966. \\usepackage{amsmath}
  1967. \\usepackage{latexsym}
  1968. \\usepackage[mathscr]{eucal}
  1969. \\pagestyle{empty} % do not remove"
  1970. "The document header used for processing LaTeX fragments."
  1971. :group 'org-latex
  1972. :type 'string)
  1973. (defgroup org-font-lock nil
  1974. "Font-lock settings for highlighting in Org-mode."
  1975. :tag "Org Font Lock"
  1976. :group 'org)
  1977. (defcustom org-level-color-stars-only nil
  1978. "Non-nil means fontify only the stars in each headline.
  1979. When nil, the entire headline is fontified.
  1980. Changing it requires restart of `font-lock-mode' to become effective
  1981. also in regions already fontified."
  1982. :group 'org-font-lock
  1983. :type 'boolean)
  1984. (defcustom org-hide-leading-stars nil
  1985. "Non-nil means, hide the first N-1 stars in a headline.
  1986. This works by using the face `org-hide' for these stars. This
  1987. face is white for a light background, and black for a dark
  1988. background. You may have to customize the face `org-hide' to
  1989. make this work.
  1990. Changing it requires restart of `font-lock-mode' to become effective
  1991. also in regions already fontified.
  1992. You may also set this on a per-file basis by adding one of the following
  1993. lines to the buffer:
  1994. #+STARTUP: hidestars
  1995. #+STARTUP: showstars"
  1996. :group 'org-font-lock
  1997. :type 'boolean)
  1998. (defcustom org-fontify-done-headline nil
  1999. "Non-nil means, change the face of a headline if it is marked DONE.
  2000. Normally, only the TODO/DONE keyword indicates the state of a headline.
  2001. When this is non-nil, the headline after the keyword is set to the
  2002. `org-headline-done' as an additional indication."
  2003. :group 'org-font-lock
  2004. :type 'boolean)
  2005. (defcustom org-fontify-emphasized-text t
  2006. "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
  2007. Changing this variable requires a restart of Emacs to take effect."
  2008. :group 'org-font-lock
  2009. :type 'boolean)
  2010. (defcustom org-highlight-latex-fragments-and-specials nil
  2011. "Non-nil means, fontify what is treated specially by the exporters."
  2012. :group 'org-font-lock
  2013. :type 'boolean)
  2014. (defcustom org-hide-emphasis-markers nil
  2015. "Non-nil mean font-lock should hide the emphasis marker characters."
  2016. :group 'org-font-lock
  2017. :type 'boolean)
  2018. (defvar org-emph-re nil
  2019. "Regular expression for matching emphasis.")
  2020. (defvar org-verbatim-re nil
  2021. "Regular expression for matching verbatim text.")
  2022. (defvar org-emphasis-regexp-components) ; defined just below
  2023. (defvar org-emphasis-alist) ; defined just below
  2024. (defun org-set-emph-re (var val)
  2025. "Set variable and compute the emphasis regular expression."
  2026. (set var val)
  2027. (when (and (boundp 'org-emphasis-alist)
  2028. (boundp 'org-emphasis-regexp-components)
  2029. org-emphasis-alist org-emphasis-regexp-components)
  2030. (let* ((e org-emphasis-regexp-components)
  2031. (pre (car e))
  2032. (post (nth 1 e))
  2033. (border (nth 2 e))
  2034. (body (nth 3 e))
  2035. (nl (nth 4 e))
  2036. (stacked (and nil (nth 5 e))) ; stacked is no longer allowed, forced to nil
  2037. (body1 (concat body "*?"))
  2038. (markers (mapconcat 'car org-emphasis-alist ""))
  2039. (vmarkers (mapconcat
  2040. (lambda (x) (if (eq (nth 4 x) 'verbatim) (car x) ""))
  2041. org-emphasis-alist "")))
  2042. ;; make sure special characters appear at the right position in the class
  2043. (if (string-match "\\^" markers)
  2044. (setq markers (concat (replace-match "" t t markers) "^")))
  2045. (if (string-match "-" markers)
  2046. (setq markers (concat (replace-match "" t t markers) "-")))
  2047. (if (string-match "\\^" vmarkers)
  2048. (setq vmarkers (concat (replace-match "" t t vmarkers) "^")))
  2049. (if (string-match "-" vmarkers)
  2050. (setq vmarkers (concat (replace-match "" t t vmarkers) "-")))
  2051. (if (> nl 0)
  2052. (setq body1 (concat body1 "\\(?:\n" body "*?\\)\\{0,"
  2053. (int-to-string nl) "\\}")))
  2054. ;; Make the regexp
  2055. (setq org-emph-re
  2056. (concat "\\([" pre (if (and nil stacked) markers) "]\\|^\\)"
  2057. "\\("
  2058. "\\([" markers "]\\)"
  2059. "\\("
  2060. "[^" border "]\\|"
  2061. "[^" border (if (and nil stacked) markers) "]"
  2062. body1
  2063. "[^" border (if (and nil stacked) markers) "]"
  2064. "\\)"
  2065. "\\3\\)"
  2066. "\\([" post (if (and nil stacked) markers) "]\\|$\\)"))
  2067. (setq org-verbatim-re
  2068. (concat "\\([" pre "]\\|^\\)"
  2069. "\\("
  2070. "\\([" vmarkers "]\\)"
  2071. "\\("
  2072. "[^" border "]\\|"
  2073. "[^" border "]"
  2074. body1
  2075. "[^" border "]"
  2076. "\\)"
  2077. "\\3\\)"
  2078. "\\([" post "]\\|$\\)")))))
  2079. (defcustom org-emphasis-regexp-components
  2080. '(" \t('\"" "- \t.,:?;'\")" " \t\r\n,\"'" "." 1)
  2081. "Components used to build the regular expression for emphasis.
  2082. This is a list with 6 entries. Terminology: In an emphasis string
  2083. like \" *strong word* \", we call the initial space PREMATCH, the final
  2084. space POSTMATCH, the stars MARKERS, \"s\" and \"d\" are BORDER characters
  2085. and \"trong wor\" is the body. The different components in this variable
  2086. specify what is allowed/forbidden in each part:
  2087. pre Chars allowed as prematch. Beginning of line will be allowed too.
  2088. post Chars allowed as postmatch. End of line will be allowed too.
  2089. border The chars *forbidden* as border characters.
  2090. body-regexp A regexp like \".\" to match a body character. Don't use
  2091. non-shy groups here, and don't allow newline here.
  2092. newline The maximum number of newlines allowed in an emphasis exp.
  2093. Use customize to modify this, or restart Emacs after changing it."
  2094. :group 'org-font-lock
  2095. :set 'org-set-emph-re
  2096. :type '(list
  2097. (sexp :tag "Allowed chars in pre ")
  2098. (sexp :tag "Allowed chars in post ")
  2099. (sexp :tag "Forbidden chars in border ")
  2100. (sexp :tag "Regexp for body ")
  2101. (integer :tag "number of newlines allowed")
  2102. (option (boolean :tag "Please ignore this button"))))
  2103. (defcustom org-emphasis-alist
  2104. `(("*" bold "<b>" "</b>")
  2105. ("/" italic "<i>" "</i>")
  2106. ("_" underline "<span style=\"text-decoration:underline;\">" "</span>")
  2107. ("=" org-code "<code>" "</code>" verbatim)
  2108. ("~" org-verbatim "<code>" "</code>" verbatim)
  2109. ("+" ,(if (featurep 'xemacs) 'org-table '(:strike-through t))
  2110. "<del>" "</del>")
  2111. )
  2112. "Special syntax for emphasized text.
  2113. Text starting and ending with a special character will be emphasized, for
  2114. example *bold*, _underlined_ and /italic/. This variable sets the marker
  2115. characters, the face to be used by font-lock for highlighting in Org-mode
  2116. Emacs buffers, and the HTML tags to be used for this.
  2117. Use customize to modify this, or restart Emacs after changing it."
  2118. :group 'org-font-lock
  2119. :set 'org-set-emph-re
  2120. :type '(repeat
  2121. (list
  2122. (string :tag "Marker character")
  2123. (choice
  2124. (face :tag "Font-lock-face")
  2125. (plist :tag "Face property list"))
  2126. (string :tag "HTML start tag")
  2127. (string :tag "HTML end tag")
  2128. (option (const verbatim)))))
  2129. ;;; Miscellaneous options
  2130. (defgroup org-completion nil
  2131. "Completion in Org-mode."
  2132. :tag "Org Completion"
  2133. :group 'org)
  2134. (defcustom org-completion-use-ido nil
  2135. "Non-nil means, use ido completion wherever possible.
  2136. Note that `ido-mode' must be active for this variable to be relevant.
  2137. If you decide to turn this variable on, you might well want to turn off
  2138. `org-outline-path-complete-in-steps'."
  2139. :group 'org-completion
  2140. :type 'boolean)
  2141. (defcustom org-completion-fallback-command 'hippie-expand
  2142. "The expansion command called by \\[org-complete] in normal context.
  2143. Normal means, no org-mode-specific context."
  2144. :group 'org-completion
  2145. :type 'function)
  2146. ;;; Functions and variables from ther packages
  2147. ;; Declared here to avoid compiler warnings
  2148. ;; XEmacs only
  2149. (defvar outline-mode-menu-heading)
  2150. (defvar outline-mode-menu-show)
  2151. (defvar outline-mode-menu-hide)
  2152. (defvar zmacs-regions) ; XEmacs regions
  2153. ;; Emacs only
  2154. (defvar mark-active)
  2155. ;; Various packages
  2156. (declare-function calendar-absolute-from-iso "cal-iso" (date))
  2157. (declare-function calendar-forward-day "cal-move" (arg))
  2158. (declare-function calendar-goto-date "cal-move" (date))
  2159. (declare-function calendar-goto-today "cal-move" ())
  2160. (declare-function calendar-iso-from-absolute "cal-iso" (date))
  2161. (defvar calc-embedded-close-formula)
  2162. (defvar calc-embedded-open-formula)
  2163. (declare-function cdlatex-tab "ext:cdlatex" ())
  2164. (declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
  2165. (defvar font-lock-unfontify-region-function)
  2166. (declare-function iswitchb-mode "iswitchb" (&optional arg))
  2167. (declare-function iswitchb-read-buffer (prompt &optional default require-match start matches-set))
  2168. (defvar iswitchb-temp-buflist)
  2169. (declare-function org-gnus-follow-link "org-gnus" (&optional group article))
  2170. (declare-function org-agenda-skip "org-agenda" ())
  2171. (declare-function org-format-agenda-item "org-agenda"
  2172. (extra txt &optional category tags dotime noprefix remove-re))
  2173. (declare-function org-agenda-new-marker "org-agenda" (&optional pos))
  2174. (declare-function org-agenda-change-all-lines "org-agenda"
  2175. (newhead hdmarker &optional fixface just-this))
  2176. (declare-function org-agenda-set-restriction-lock "org-agenda" (&optional type))
  2177. (declare-function org-agenda-maybe-redo "org-agenda" ())
  2178. (declare-function org-agenda-save-markers-for-cut-and-paste "org-agenda"
  2179. (beg end))
  2180. (declare-function org-agenda-copy-local-variable "org-agenda" (var))
  2181. (declare-function parse-time-string "parse-time" (string))
  2182. (declare-function remember "remember" (&optional initial))
  2183. (declare-function remember-buffer-desc "remember" ())
  2184. (declare-function remember-finalize "remember" ())
  2185. (defvar remember-save-after-remembering)
  2186. (defvar remember-data-file)
  2187. (defvar remember-register)
  2188. (defvar remember-buffer)
  2189. (defvar remember-handler-functions)
  2190. (defvar remember-annotation-functions)
  2191. (defvar texmathp-why)
  2192. (declare-function speedbar-line-directory "speedbar" (&optional depth))
  2193. (declare-function table--at-cell-p "table" (position &optional object at-column))
  2194. (defvar w3m-current-url)
  2195. (defvar w3m-current-title)
  2196. (defvar org-latex-regexps)
  2197. ;;; Autoload and prepare some org modules
  2198. ;; Some table stuff that needs to be defined here, because it is used
  2199. ;; by the functions setting up org-mode or checking for table context.
  2200. (defconst org-table-any-line-regexp "^[ \t]*\\(|\\|\\+-[-+]\\)"
  2201. "Detects an org-type or table-type table.")
  2202. (defconst org-table-line-regexp "^[ \t]*|"
  2203. "Detects an org-type table line.")
  2204. (defconst org-table-dataline-regexp "^[ \t]*|[^-]"
  2205. "Detects an org-type table line.")
  2206. (defconst org-table-hline-regexp "^[ \t]*|-"
  2207. "Detects an org-type table hline.")
  2208. (defconst org-table1-hline-regexp "^[ \t]*\\+-[-+]"
  2209. "Detects a table-type table hline.")
  2210. (defconst org-table-any-border-regexp "^[ \t]*[^|+ \t]"
  2211. "Searching from within a table (any type) this finds the first line
  2212. outside the table.")
  2213. ;; Autoload the functions in org-table.el that are needed by functions here.
  2214. (eval-and-compile
  2215. (org-autoload "org-table"
  2216. '(org-table-align org-table-begin org-table-blank-field
  2217. org-table-convert org-table-convert-region org-table-copy-down
  2218. org-table-copy-region org-table-create
  2219. org-table-create-or-convert-from-region
  2220. org-table-create-with-table.el org-table-current-dline
  2221. org-table-cut-region org-table-delete-column org-table-edit-field
  2222. org-table-edit-formulas org-table-end org-table-eval-formula
  2223. org-table-export org-table-field-info
  2224. org-table-get-stored-formulas org-table-goto-column
  2225. org-table-hline-and-move org-table-import org-table-insert-column
  2226. org-table-insert-hline org-table-insert-row org-table-iterate
  2227. org-table-justify-field-maybe org-table-kill-row
  2228. org-table-maybe-eval-formula org-table-maybe-recalculate-line
  2229. org-table-move-column org-table-move-column-left
  2230. org-table-move-column-right org-table-move-row
  2231. org-table-move-row-down org-table-move-row-up
  2232. org-table-next-field org-table-next-row org-table-paste-rectangle
  2233. org-table-previous-field org-table-recalculate
  2234. org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
  2235. org-table-toggle-coordinate-overlays
  2236. org-table-toggle-formula-debugger org-table-wrap-region
  2237. orgtbl-mode turn-on-orgtbl org-table-to-lisp)))
  2238. (defun org-at-table-p (&optional table-type)
  2239. "Return t if the cursor is inside an org-type table.
  2240. If TABLE-TYPE is non-nil, also check for table.el-type tables."
  2241. (if org-enable-table-editor
  2242. (save-excursion
  2243. (beginning-of-line 1)
  2244. (looking-at (if table-type org-table-any-line-regexp
  2245. org-table-line-regexp)))
  2246. nil))
  2247. (defsubst org-table-p () (org-at-table-p))
  2248. (defun org-at-table.el-p ()
  2249. "Return t if and only if we are at a table.el table."
  2250. (and (org-at-table-p 'any)
  2251. (save-excursion
  2252. (goto-char (org-table-begin 'any))
  2253. (looking-at org-table1-hline-regexp))))
  2254. (defun org-table-recognize-table.el ()
  2255. "If there is a table.el table nearby, recognize it and move into it."
  2256. (if org-table-tab-recognizes-table.el
  2257. (if (org-at-table.el-p)
  2258. (progn
  2259. (beginning-of-line 1)
  2260. (if (looking-at org-table-dataline-regexp)
  2261. nil
  2262. (if (looking-at org-table1-hline-regexp)
  2263. (progn
  2264. (beginning-of-line 2)
  2265. (if (looking-at org-table-any-border-regexp)
  2266. (beginning-of-line -1)))))
  2267. (if (re-search-forward "|" (org-table-end t) t)
  2268. (progn
  2269. (require 'table)
  2270. (if (table--at-cell-p (point))
  2271. t
  2272. (message "recognizing table.el table...")
  2273. (table-recognize-table)
  2274. (message "recognizing table.el table...done")))
  2275. (error "This should not happen..."))
  2276. t)
  2277. nil)
  2278. nil))
  2279. (defun org-at-table-hline-p ()
  2280. "Return t if the cursor is inside a hline in a table."
  2281. (if org-enable-table-editor
  2282. (save-excursion
  2283. (beginning-of-line 1)
  2284. (looking-at org-table-hline-regexp))
  2285. nil))
  2286. (defvar org-table-clean-did-remove-column nil)
  2287. (defun org-table-map-tables (function)
  2288. "Apply FUNCTION to the start of all tables in the buffer."
  2289. (save-excursion
  2290. (save-restriction
  2291. (widen)
  2292. (goto-char (point-min))
  2293. (while (re-search-forward org-table-any-line-regexp nil t)
  2294. (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size)))
  2295. (beginning-of-line 1)
  2296. (if (looking-at org-table-line-regexp)
  2297. (save-excursion (funcall function)))
  2298. (re-search-forward org-table-any-border-regexp nil 1))))
  2299. (message "Mapping tables: done"))
  2300. ;; Declare and autoload functions from org-exp.el
  2301. (declare-function org-default-export-plist "org-exp")
  2302. (declare-function org-infile-export-plist "org-exp")
  2303. (declare-function org-get-current-options "org-exp")
  2304. (eval-and-compile
  2305. (org-autoload "org-exp"
  2306. '(org-export org-export-as-ascii org-export-visible
  2307. org-insert-export-options-template org-export-as-html-and-open
  2308. org-export-as-html-batch org-export-as-html-to-buffer
  2309. org-replace-region-by-html org-export-region-as-html
  2310. org-export-as-html org-export-icalendar-this-file
  2311. org-export-icalendar-all-agenda-files
  2312. org-table-clean-before-export
  2313. org-export-icalendar-combine-agenda-files org-export-as-xoxo)))
  2314. ;; Declare and autoload functions from org-agenda.el
  2315. (eval-and-compile
  2316. (org-autoload "org-agenda"
  2317. '(org-agenda org-agenda-list org-search-view
  2318. org-todo-list org-tags-view org-agenda-list-stuck-projects
  2319. org-diary org-agenda-to-appt)))
  2320. ;; Autoload org-remember
  2321. (eval-and-compile
  2322. (org-autoload "org-remember"
  2323. '(org-remember-insinuate org-remember-annotation
  2324. org-remember-apply-template org-remember org-remember-handler)))
  2325. ;; Autoload org-clock.el
  2326. (declare-function org-clock-save-markers-for-cut-and-paste "org-clock"
  2327. (beg end))
  2328. (declare-function org-update-mode-line "org-clock" ())
  2329. (defvar org-clock-start-time)
  2330. (defvar org-clock-marker (make-marker)
  2331. "Marker recording the last clock-in.")
  2332. (eval-and-compile
  2333. (org-autoload
  2334. "org-clock"
  2335. '(org-clock-in org-clock-out org-clock-cancel
  2336. org-clock-goto org-clock-sum org-clock-display
  2337. org-remove-clock-overlays org-clock-report
  2338. org-clocktable-shift org-dblock-write:clocktable
  2339. org-get-clocktable)))
  2340. (defun org-clock-update-time-maybe ()
  2341. "If this is a CLOCK line, update it and return t.
  2342. Otherwise, return nil."
  2343. (interactive)
  2344. (save-excursion
  2345. (beginning-of-line 1)
  2346. (skip-chars-forward " \t")
  2347. (when (looking-at org-clock-string)
  2348. (let ((re (concat "[ \t]*" org-clock-string
  2349. " *[[<]\\([^]>]+\\)[]>]\\(-+[[<]\\([^]>]+\\)[]>]"
  2350. "\\([ \t]*=>.*\\)?\\)?"))
  2351. ts te h m s neg)
  2352. (cond
  2353. ((not (looking-at re))
  2354. nil)
  2355. ((not (match-end 2))
  2356. (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
  2357. (> org-clock-marker (point))
  2358. (<= org-clock-marker (point-at-eol)))
  2359. ;; The clock is running here
  2360. (setq org-clock-start-time
  2361. (apply 'encode-time
  2362. (org-parse-time-string (match-string 1))))
  2363. (org-update-mode-line)))
  2364. (t
  2365. (and (match-end 4) (delete-region (match-beginning 4) (match-end 4)))
  2366. (end-of-line 1)
  2367. (setq ts (match-string 1)
  2368. te (match-string 3))
  2369. (setq s (- (time-to-seconds
  2370. (apply 'encode-time (org-parse-time-string te)))
  2371. (time-to-seconds
  2372. (apply 'encode-time (org-parse-time-string ts))))
  2373. neg (< s 0)
  2374. s (abs s)
  2375. h (floor (/ s 3600))
  2376. s (- s (* 3600 h))
  2377. m (floor (/ s 60))
  2378. s (- s (* 60 s)))
  2379. (insert " => " (format (if neg "-%d:%02d" "%2d:%02d") h m))
  2380. t))))))
  2381. (defun org-check-running-clock ()
  2382. "Check if the current buffer contains the running clock.
  2383. If yes, offer to stop it and to save the buffer with the changes."
  2384. (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
  2385. (y-or-n-p (format "Clock-out in buffer %s before killing it? "
  2386. (buffer-name))))
  2387. (org-clock-out)
  2388. (when (y-or-n-p "Save changed buffer?")
  2389. (save-buffer))))
  2390. (defun org-clocktable-try-shift (dir n)
  2391. "Check if this line starts a clock table, if yes, shift the time block."
  2392. (when (org-match-line "#\\+BEGIN: clocktable\\>")
  2393. (org-clocktable-shift dir n)))
  2394. ;; Autoload org-timer.el
  2395. ;(declare-function org-timer "org-timer")
  2396. (eval-and-compile
  2397. (org-autoload
  2398. "org-timer"
  2399. '(org-timer-start org-timer org-timer-item
  2400. org-timer-change-times-in-region)))
  2401. ;; Autoload archiving code
  2402. ;; The stuff that is needed for cycling and tags has to be defined here.
  2403. (defgroup org-archive nil
  2404. "Options concerning archiving in Org-mode."
  2405. :tag "Org Archive"
  2406. :group 'org-structure)
  2407. (defcustom org-archive-location "%s_archive::"
  2408. "The location where subtrees should be archived.
  2409. The value of this variable is a string, consisting of two parts,
  2410. separated by a double-colon. The first part is a filename and
  2411. the second part is a headline.
  2412. When the filename is omitted, archiving happens in the same file.
  2413. %s in the filename will be replaced by the current file
  2414. name (without the directory part). Archiving to a different file
  2415. is useful to keep archived entries from contributing to the
  2416. Org-mode Agenda.
  2417. The archived entries will be filed as subtrees of the specified
  2418. headline. When the headline is omitted, the subtrees are simply
  2419. filed away at the end of the file, as top-level entries.
  2420. Here are a few examples:
  2421. \"%s_archive::\"
  2422. If the current file is Projects.org, archive in file
  2423. Projects.org_archive, as top-level trees. This is the default.
  2424. \"::* Archived Tasks\"
  2425. Archive in the current file, under the top-level headline
  2426. \"* Archived Tasks\".
  2427. \"~/org/archive.org::\"
  2428. Archive in file ~/org/archive.org (absolute path), as top-level trees.
  2429. \"basement::** Finished Tasks\"
  2430. Archive in file ./basement (relative path), as level 3 trees
  2431. below the level 2 heading \"** Finished Tasks\".
  2432. You may set this option on a per-file basis by adding to the buffer a
  2433. line like
  2434. #+ARCHIVE: basement::** Finished Tasks
  2435. You may also define it locally for a subtree by setting an ARCHIVE property
  2436. in the entry. If such a property is found in an entry, or anywhere up
  2437. the hierarchy, it will be used."
  2438. :group 'org-archive
  2439. :type 'string)
  2440. (defcustom org-archive-tag "ARCHIVE"
  2441. "The tag that marks a subtree as archived.
  2442. An archived subtree does not open during visibility cycling, and does
  2443. not contribute to the agenda listings.
  2444. After changing this, font-lock must be restarted in the relevant buffers to
  2445. get the proper fontification."
  2446. :group 'org-archive
  2447. :group 'org-keywords
  2448. :type 'string)
  2449. (defcustom org-agenda-skip-archived-trees t
  2450. "Non-nil means, the agenda will skip any items located in archived trees.
  2451. An archived tree is a tree marked with the tag ARCHIVE. The use of this
  2452. variable is no longer recommended, you should leave it at the value t.
  2453. Instead, use the key `v' to cycle the archives-mode in the agenda."
  2454. :group 'org-archive
  2455. :group 'org-agenda-skip
  2456. :type 'boolean)
  2457. (defcustom org-cycle-open-archived-trees nil
  2458. "Non-nil means, `org-cycle' will open archived trees.
  2459. An archived tree is a tree marked with the tag ARCHIVE.
  2460. When nil, archived trees will stay folded. You can still open them with
  2461. normal outline commands like `show-all', but not with the cycling commands."
  2462. :group 'org-archive
  2463. :group 'org-cycle
  2464. :type 'boolean)
  2465. (defcustom org-sparse-tree-open-archived-trees nil
  2466. "Non-nil means sparse tree construction shows matches in archived trees.
  2467. When nil, matches in these trees are highlighted, but the trees are kept in
  2468. collapsed state."
  2469. :group 'org-archive
  2470. :group 'org-sparse-trees
  2471. :type 'boolean)
  2472. (defun org-cycle-hide-archived-subtrees (state)
  2473. "Re-hide all archived subtrees after a visibility state change."
  2474. (when (and (not org-cycle-open-archived-trees)
  2475. (not (memq state '(overview folded))))
  2476. (save-excursion
  2477. (let* ((globalp (memq state '(contents all)))
  2478. (beg (if globalp (point-min) (point)))
  2479. (end (if globalp (point-max) (org-end-of-subtree t))))
  2480. (org-hide-archived-subtrees beg end)
  2481. (goto-char beg)
  2482. (if (looking-at (concat ".*:" org-archive-tag ":"))
  2483. (message "%s" (substitute-command-keys
  2484. "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
  2485. (defun org-force-cycle-archived ()
  2486. "Cycle subtree even if it is archived."
  2487. (interactive)
  2488. (setq this-command 'org-cycle)
  2489. (let ((org-cycle-open-archived-trees t))
  2490. (call-interactively 'org-cycle)))
  2491. (defun org-hide-archived-subtrees (beg end)
  2492. "Re-hide all archived subtrees after a visibility state change."
  2493. (save-excursion
  2494. (let* ((re (concat ":" org-archive-tag ":")))
  2495. (goto-char beg)
  2496. (while (re-search-forward re end t)
  2497. (and (org-on-heading-p) (hide-subtree))
  2498. (org-end-of-subtree t)))))
  2499. (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
  2500. (eval-and-compile
  2501. (org-autoload "org-archive"
  2502. '(org-add-archive-files org-archive-subtree
  2503. org-archive-to-archive-sibling org-toggle-archive-tag)))
  2504. ;; Autoload Column View Code
  2505. (declare-function org-columns-number-to-string "org-colview")
  2506. (declare-function org-columns-get-format-and-top-level "org-colview")
  2507. (declare-function org-columns-compute "org-colview")
  2508. (org-autoload (if (featurep 'xemacs) "org-colview-xemacs" "org-colview")
  2509. '(org-columns-number-to-string org-columns-get-format-and-top-level
  2510. org-columns-compute org-agenda-columns org-columns-remove-overlays
  2511. org-columns org-insert-columns-dblock org-dblock-write:columnview))
  2512. ;; Autoload ID code
  2513. (declare-function org-id-store-link "org-id")
  2514. (org-autoload "org-id"
  2515. '(org-id-get-create org-id-new org-id-copy org-id-get
  2516. org-id-get-with-outline-path-completion
  2517. org-id-get-with-outline-drilling
  2518. org-id-goto org-id-find org-id-store-link))
  2519. ;;; Variables for pre-computed regular expressions, all buffer local
  2520. (defvar org-drawer-regexp nil
  2521. "Matches first line of a hidden block.")
  2522. (make-variable-buffer-local 'org-drawer-regexp)
  2523. (defvar org-todo-regexp nil
  2524. "Matches any of the TODO state keywords.")
  2525. (make-variable-buffer-local 'org-todo-regexp)
  2526. (defvar org-not-done-regexp nil
  2527. "Matches any of the TODO state keywords except the last one.")
  2528. (make-variable-buffer-local 'org-not-done-regexp)
  2529. (defvar org-todo-line-regexp nil
  2530. "Matches a headline and puts TODO state into group 2 if present.")
  2531. (make-variable-buffer-local 'org-todo-line-regexp)
  2532. (defvar org-complex-heading-regexp nil
  2533. "Matches a headline and puts everything into groups:
  2534. group 1: the stars
  2535. group 2: The todo keyword, maybe
  2536. group 3: Priority cookie
  2537. group 4: True headline
  2538. group 5: Tags")
  2539. (make-variable-buffer-local 'org-complex-heading-regexp)
  2540. (defvar org-todo-line-tags-regexp nil
  2541. "Matches a headline and puts TODO state into group 2 if present.
  2542. Also put tags into group 4 if tags are present.")
  2543. (make-variable-buffer-local 'org-todo-line-tags-regexp)
  2544. (defvar org-nl-done-regexp nil
  2545. "Matches newline followed by a headline with the DONE keyword.")
  2546. (make-variable-buffer-local 'org-nl-done-regexp)
  2547. (defvar org-looking-at-done-regexp nil
  2548. "Matches the DONE keyword a point.")
  2549. (make-variable-buffer-local 'org-looking-at-done-regexp)
  2550. (defvar org-ds-keyword-length 12
  2551. "Maximum length of the Deadline and SCHEDULED keywords.")
  2552. (make-variable-buffer-local 'org-ds-keyword-length)
  2553. (defvar org-deadline-regexp nil
  2554. "Matches the DEADLINE keyword.")
  2555. (make-variable-buffer-local 'org-deadline-regexp)
  2556. (defvar org-deadline-time-regexp nil
  2557. "Matches the DEADLINE keyword together with a time stamp.")
  2558. (make-variable-buffer-local 'org-deadline-time-regexp)
  2559. (defvar org-deadline-line-regexp nil
  2560. "Matches the DEADLINE keyword and the rest of the line.")
  2561. (make-variable-buffer-local 'org-deadline-line-regexp)
  2562. (defvar org-scheduled-regexp nil
  2563. "Matches the SCHEDULED keyword.")
  2564. (make-variable-buffer-local 'org-scheduled-regexp)
  2565. (defvar org-scheduled-time-regexp nil
  2566. "Matches the SCHEDULED keyword together with a time stamp.")
  2567. (make-variable-buffer-local 'org-scheduled-time-regexp)
  2568. (defvar org-closed-time-regexp nil
  2569. "Matches the CLOSED keyword together with a time stamp.")
  2570. (make-variable-buffer-local 'org-closed-time-regexp)
  2571. (defvar org-keyword-time-regexp nil
  2572. "Matches any of the 4 keywords, together with the time stamp.")
  2573. (make-variable-buffer-local 'org-keyword-time-regexp)
  2574. (defvar org-keyword-time-not-clock-regexp nil
  2575. "Matches any of the 3 keywords, together with the time stamp.")
  2576. (make-variable-buffer-local 'org-keyword-time-not-clock-regexp)
  2577. (defvar org-maybe-keyword-time-regexp nil
  2578. "Matches a timestamp, possibly preceeded by a keyword.")
  2579. (make-variable-buffer-local 'org-maybe-keyword-time-regexp)
  2580. (defvar org-planning-or-clock-line-re nil
  2581. "Matches a line with planning or clock info.")
  2582. (make-variable-buffer-local 'org-planning-or-clock-line-re)
  2583. (defconst org-plain-time-of-day-regexp
  2584. (concat
  2585. "\\(\\<[012]?[0-9]"
  2586. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  2587. "\\(--?"
  2588. "\\(\\<[012]?[0-9]"
  2589. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  2590. "\\)?")
  2591. "Regular expression to match a plain time or time range.
  2592. Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
  2593. groups carry important information:
  2594. 0 the full match
  2595. 1 the first time, range or not
  2596. 8 the second time, if it is a range.")
  2597. (defconst org-plain-time-extension-regexp
  2598. (concat
  2599. "\\(\\<[012]?[0-9]"
  2600. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  2601. "\\+\\([0-9]+\\)\\(:\\([0-5][0-9]\\)\\)?")
  2602. "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
  2603. Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
  2604. groups carry important information:
  2605. 0 the full match
  2606. 7 hours of duration
  2607. 9 minutes of duration")
  2608. (defconst org-stamp-time-of-day-regexp
  2609. (concat
  2610. "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} +\\sw+ +\\)"
  2611. "\\([012][0-9]:[0-5][0-9]\\(-\\([012][0-9]:[0-5][0-9]\\)\\)?[^\n\r>]*?\\)>"
  2612. "\\(--?"
  2613. "<\\1\\([012][0-9]:[0-5][0-9]\\)>\\)?")
  2614. "Regular expression to match a timestamp time or time range.
  2615. After a match, the following groups carry important information:
  2616. 0 the full match
  2617. 1 date plus weekday, for backreferencing to make sure both times on same day
  2618. 2 the first time, range or not
  2619. 4 the second time, if it is a range.")
  2620. (defconst org-startup-options
  2621. '(("fold" org-startup-folded t)
  2622. ("overview" org-startup-folded t)
  2623. ("nofold" org-startup-folded nil)
  2624. ("showall" org-startup-folded nil)
  2625. ("content" org-startup-folded content)
  2626. ("hidestars" org-hide-leading-stars t)
  2627. ("showstars" org-hide-leading-stars nil)
  2628. ("odd" org-odd-levels-only t)
  2629. ("oddeven" org-odd-levels-only nil)
  2630. ("align" org-startup-align-all-tables t)
  2631. ("noalign" org-startup-align-all-tables nil)
  2632. ("customtime" org-display-custom-times t)
  2633. ("logdone" org-log-done time)
  2634. ("lognotedone" org-log-done note)
  2635. ("nologdone" org-log-done nil)
  2636. ("lognoteclock-out" org-log-note-clock-out t)
  2637. ("nolognoteclock-out" org-log-note-clock-out nil)
  2638. ("logrepeat" org-log-repeat state)
  2639. ("lognoterepeat" org-log-repeat note)
  2640. ("nologrepeat" org-log-repeat nil)
  2641. ("fninline" org-footnote-define-inline t)
  2642. ("nofninline" org-footnote-define-inline nil)
  2643. ("fnlocal" org-footnote-section nil)
  2644. ("fnauto" org-footnote-auto-label t)
  2645. ("fnprompt" org-footnote-auto-label nil)
  2646. ("fnconfirm" org-footnote-auto-label confirm)
  2647. ("fnplain" org-footnote-auto-label plain)
  2648. ("constcgs" constants-unit-system cgs)
  2649. ("constSI" constants-unit-system SI))
  2650. "Variable associated with STARTUP options for org-mode.
  2651. Each element is a list of three items: The startup options as written
  2652. in the #+STARTUP line, the corresponding variable, and the value to
  2653. set this variable to if the option is found. An optional forth element PUSH
  2654. means to push this value onto the list in the variable.")
  2655. (defun org-set-regexps-and-options ()
  2656. "Precompute regular expressions for current buffer."
  2657. (when (org-mode-p)
  2658. (org-set-local 'org-todo-kwd-alist nil)
  2659. (org-set-local 'org-todo-key-alist nil)
  2660. (org-set-local 'org-todo-key-trigger nil)
  2661. (org-set-local 'org-todo-keywords-1 nil)
  2662. (org-set-local 'org-done-keywords nil)
  2663. (org-set-local 'org-todo-heads nil)
  2664. (org-set-local 'org-todo-sets nil)
  2665. (org-set-local 'org-todo-log-states nil)
  2666. (org-set-local 'org-file-properties nil)
  2667. (org-set-local 'org-file-tags nil)
  2668. (let ((re (org-make-options-regexp
  2669. '("CATEGORY" "SEQ_TODO" "TYP_TODO" "TODO" "COLUMNS"
  2670. "STARTUP" "ARCHIVE" "FILETAGS" "TAGS" "LINK" "PRIORITIES"
  2671. "CONSTANTS" "PROPERTY" "DRAWERS" "SETUPFILE")))
  2672. (splitre "[ \t]+")
  2673. kwds kws0 kwsa key log value cat arch tags const links hw dws
  2674. tail sep kws1 prio props ftags drawers
  2675. ext-setup-or-nil setup-contents (start 0))
  2676. (save-excursion
  2677. (save-restriction
  2678. (widen)
  2679. (goto-char (point-min))
  2680. (while (or (and ext-setup-or-nil
  2681. (string-match re ext-setup-or-nil start)
  2682. (setq start (match-end 0)))
  2683. (and (setq ext-setup-or-nil nil start 0)
  2684. (re-search-forward re nil t)))
  2685. (setq key (upcase (match-string 1 ext-setup-or-nil))
  2686. value (org-match-string-no-properties 2 ext-setup-or-nil))
  2687. (cond
  2688. ((equal key "CATEGORY")
  2689. (if (string-match "[ \t]+$" value)
  2690. (setq value (replace-match "" t t value)))
  2691. (setq cat value))
  2692. ((member key '("SEQ_TODO" "TODO"))
  2693. (push (cons 'sequence (org-split-string value splitre)) kwds))
  2694. ((equal key "TYP_TODO")
  2695. (push (cons 'type (org-split-string value splitre)) kwds))
  2696. ((equal key "TAGS")
  2697. (setq tags (append tags (org-split-string value splitre))))
  2698. ((equal key "COLUMNS")
  2699. (org-set-local 'org-columns-default-format value))
  2700. ((equal key "LINK")
  2701. (when (string-match "^\\(\\S-+\\)[ \t]+\\(.+\\)" value)
  2702. (push (cons (match-string 1 value)
  2703. (org-trim (match-string 2 value)))
  2704. links)))
  2705. ((equal key "PRIORITIES")
  2706. (setq prio (org-split-string value " +")))
  2707. ((equal key "PROPERTY")
  2708. (when (string-match "\\(\\S-+\\)\\s-+\\(.*\\)" value)
  2709. (push (cons (match-string 1 value) (match-string 2 value))
  2710. props)))
  2711. ((equal key "FILETAGS")
  2712. (when (string-match "\\S-" value)
  2713. (setq ftags
  2714. (append
  2715. ftags
  2716. (apply 'append
  2717. (mapcar (lambda (x) (org-split-string x ":"))
  2718. (org-split-string value)))))))
  2719. ((equal key "DRAWERS")
  2720. (setq drawers (org-split-string value splitre)))
  2721. ((equal key "CONSTANTS")
  2722. (setq const (append const (org-split-string value splitre))))
  2723. ((equal key "STARTUP")
  2724. (let ((opts (org-split-string value splitre))
  2725. l var val)
  2726. (while (setq l (pop opts))
  2727. (when (setq l (assoc l org-startup-options))
  2728. (setq var (nth 1 l) val (nth 2 l))
  2729. (if (not (nth 3 l))
  2730. (set (make-local-variable var) val)
  2731. (if (not (listp (symbol-value var)))
  2732. (set (make-local-variable var) nil))
  2733. (set (make-local-variable var) (symbol-value var))
  2734. (add-to-list var val))))))
  2735. ((equal key "ARCHIVE")
  2736. (string-match " *$" value)
  2737. (setq arch (replace-match "" t t value))
  2738. (remove-text-properties 0 (length arch)
  2739. '(face t fontified t) arch))
  2740. ((equal key "SETUPFILE")
  2741. (setq setup-contents (org-file-contents
  2742. (expand-file-name
  2743. (org-remove-double-quotes value))
  2744. 'noerror))
  2745. (if (not ext-setup-or-nil)
  2746. (setq ext-setup-or-nil setup-contents start 0)
  2747. (setq ext-setup-or-nil
  2748. (concat (substring ext-setup-or-nil 0 start)
  2749. "\n" setup-contents "\n"
  2750. (substring ext-setup-or-nil start)))))
  2751. ))))
  2752. (when cat
  2753. (org-set-local 'org-category (intern cat))
  2754. (push (cons "CATEGORY" cat) props))
  2755. (when prio
  2756. (if (< (length prio) 3) (setq prio '("A" "C" "B")))
  2757. (setq prio (mapcar 'string-to-char prio))
  2758. (org-set-local 'org-highest-priority (nth 0 prio))
  2759. (org-set-local 'org-lowest-priority (nth 1 prio))
  2760. (org-set-local 'org-default-priority (nth 2 prio)))
  2761. (and props (org-set-local 'org-file-properties (nreverse props)))
  2762. (and ftags (org-set-local 'org-file-tags ftags))
  2763. (and drawers (org-set-local 'org-drawers drawers))
  2764. (and arch (org-set-local 'org-archive-location arch))
  2765. (and links (setq org-link-abbrev-alist-local (nreverse links)))
  2766. ;; Process the TODO keywords
  2767. (unless kwds
  2768. ;; Use the global values as if they had been given locally.
  2769. (setq kwds (default-value 'org-todo-keywords))
  2770. (if (stringp (car kwds))
  2771. (setq kwds (list (cons org-todo-interpretation
  2772. (default-value 'org-todo-keywords)))))
  2773. (setq kwds (reverse kwds)))
  2774. (setq kwds (nreverse kwds))
  2775. (let (inter kws kw)
  2776. (while (setq kws (pop kwds))
  2777. (setq inter (pop kws) sep (member "|" kws)
  2778. kws0 (delete "|" (copy-sequence kws))
  2779. kwsa nil
  2780. kws1 (mapcar
  2781. (lambda (x)
  2782. ;; 1 2
  2783. (if (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?.*?)\\)?$" x)
  2784. (progn
  2785. (setq kw (match-string 1 x)
  2786. key (and (match-end 2) (match-string 2 x))
  2787. log (org-extract-log-state-settings x))
  2788. (push (cons kw (and key (string-to-char key))) kwsa)
  2789. (and log (push log org-todo-log-states))
  2790. kw)
  2791. (error "Invalid TODO keyword %s" x)))
  2792. kws0)
  2793. kwsa (if kwsa (append '((:startgroup))
  2794. (nreverse kwsa)
  2795. '((:endgroup))))
  2796. hw (car kws1)
  2797. dws (if sep (org-remove-keyword-keys (cdr sep)) (last kws1))
  2798. tail (list inter hw (car dws) (org-last dws)))
  2799. (add-to-list 'org-todo-heads hw 'append)
  2800. (push kws1 org-todo-sets)
  2801. (setq org-done-keywords (append org-done-keywords dws nil))
  2802. (setq org-todo-key-alist (append org-todo-key-alist kwsa))
  2803. (mapc (lambda (x) (push (cons x tail) org-todo-kwd-alist)) kws1)
  2804. (setq org-todo-keywords-1 (append org-todo-keywords-1 kws1 nil)))
  2805. (setq org-todo-sets (nreverse org-todo-sets)
  2806. org-todo-kwd-alist (nreverse org-todo-kwd-alist)
  2807. org-todo-key-trigger (delq nil (mapcar 'cdr org-todo-key-alist))
  2808. org-todo-key-alist (org-assign-fast-keys org-todo-key-alist)))
  2809. ;; Process the constants
  2810. (when const
  2811. (let (e cst)
  2812. (while (setq e (pop const))
  2813. (if (string-match "^\\([a-zA-Z0][_a-zA-Z0-9]*\\)=\\(.*\\)" e)
  2814. (push (cons (match-string 1 e) (match-string 2 e)) cst)))
  2815. (setq org-table-formula-constants-local cst)))
  2816. ;; Process the tags.
  2817. (when tags
  2818. (let (e tgs)
  2819. (while (setq e (pop tags))
  2820. (cond
  2821. ((equal e "{") (push '(:startgroup) tgs))
  2822. ((equal e "}") (push '(:endgroup) tgs))
  2823. ((string-match (org-re "^\\([[:alnum:]_@]+\\)(\\(.\\))$") e)
  2824. (push (cons (match-string 1 e)
  2825. (string-to-char (match-string 2 e)))
  2826. tgs))
  2827. (t (push (list e) tgs))))
  2828. (org-set-local 'org-tag-alist nil)
  2829. (while (setq e (pop tgs))
  2830. (or (and (stringp (car e))
  2831. (assoc (car e) org-tag-alist))
  2832. (push e org-tag-alist)))))
  2833. ;; Compute the regular expressions and other local variables
  2834. (if (not org-done-keywords)
  2835. (setq org-done-keywords (list (org-last org-todo-keywords-1))))
  2836. (setq org-ds-keyword-length (+ 2 (max (length org-deadline-string)
  2837. (length org-scheduled-string)
  2838. (length org-clock-string)
  2839. (length org-closed-string)))
  2840. org-drawer-regexp
  2841. (concat "^[ \t]*:\\("
  2842. (mapconcat 'regexp-quote org-drawers "\\|")
  2843. "\\):[ \t]*$")
  2844. org-not-done-keywords
  2845. (org-delete-all org-done-keywords (copy-sequence org-todo-keywords-1))
  2846. org-todo-regexp
  2847. (concat "\\<\\(" (mapconcat 'regexp-quote org-todo-keywords-1
  2848. "\\|") "\\)\\>")
  2849. org-not-done-regexp
  2850. (concat "\\<\\("
  2851. (mapconcat 'regexp-quote org-not-done-keywords "\\|")
  2852. "\\)\\>")
  2853. org-todo-line-regexp
  2854. (concat "^\\(\\*+\\)[ \t]+\\(?:\\("
  2855. (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
  2856. "\\)\\>\\)?[ \t]*\\(.*\\)")
  2857. org-complex-heading-regexp
  2858. (concat "^\\(\\*+\\)[ \t]+\\(?:\\("
  2859. (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
  2860. "\\)\\>\\)?\\(?:[ \t]*\\(\\[#.\\]\\)\\)?[ \t]*\\(.*?\\)"
  2861. "\\(?:[ \t]+\\(:[[:alnum:]_@:]+:\\)\\)?[ \t]*$")
  2862. org-nl-done-regexp
  2863. (concat "\n\\*+[ \t]+"
  2864. "\\(?:" (mapconcat 'regexp-quote org-done-keywords "\\|")
  2865. "\\)" "\\>")
  2866. org-todo-line-tags-regexp
  2867. (concat "^\\(\\*+\\)[ \t]+\\(?:\\("
  2868. (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
  2869. (org-re
  2870. "\\)\\>\\)? *\\(.*?\\([ \t]:[[:alnum:]:_@]+:[ \t]*\\)?$\\)"))
  2871. org-looking-at-done-regexp
  2872. (concat "^" "\\(?:"
  2873. (mapconcat 'regexp-quote org-done-keywords "\\|") "\\)"
  2874. "\\>")
  2875. org-deadline-regexp (concat "\\<" org-deadline-string)
  2876. org-deadline-time-regexp
  2877. (concat "\\<" org-deadline-string " *<\\([^>]+\\)>")
  2878. org-deadline-line-regexp
  2879. (concat "\\<\\(" org-deadline-string "\\).*")
  2880. org-scheduled-regexp
  2881. (concat "\\<" org-scheduled-string)
  2882. org-scheduled-time-regexp
  2883. (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>")
  2884. org-closed-time-regexp
  2885. (concat "\\<" org-closed-string " *\\[\\([^]]+\\)\\]")
  2886. org-keyword-time-regexp
  2887. (concat "\\<\\(" org-scheduled-string
  2888. "\\|" org-deadline-string
  2889. "\\|" org-closed-string
  2890. "\\|" org-clock-string "\\)"
  2891. " *[[<]\\([^]>]+\\)[]>]")
  2892. org-keyword-time-not-clock-regexp
  2893. (concat "\\<\\(" org-scheduled-string
  2894. "\\|" org-deadline-string
  2895. "\\|" org-closed-string
  2896. "\\)"
  2897. " *[[<]\\([^]>]+\\)[]>]")
  2898. org-maybe-keyword-time-regexp
  2899. (concat "\\(\\<\\(" org-scheduled-string
  2900. "\\|" org-deadline-string
  2901. "\\|" org-closed-string
  2902. "\\|" org-clock-string "\\)\\)?"
  2903. " *\\([[<][0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} [^]\r\n>]*?[]>]\\|<%%([^\r\n>]*>\\)")
  2904. org-planning-or-clock-line-re
  2905. (concat "\\(?:^[ \t]*\\(" org-scheduled-string
  2906. "\\|" org-deadline-string
  2907. "\\|" org-closed-string "\\|" org-clock-string
  2908. "\\)\\>\\)")
  2909. )
  2910. (org-compute-latex-and-specials-regexp)
  2911. (org-set-font-lock-defaults))))
  2912. (defun org-file-contents (file &optional noerror)
  2913. "Return the contents of FILE, as a string."
  2914. (if (or (not file)
  2915. (not (file-readable-p file)))
  2916. (if noerror
  2917. (progn
  2918. (message "Cannot read file %s" file)
  2919. (ding) (sit-for 2)
  2920. "")
  2921. (error "Cannot read file %s" file))
  2922. (with-temp-buffer
  2923. (insert-file-contents file)
  2924. (buffer-string))))
  2925. (defun org-extract-log-state-settings (x)
  2926. "Extract the log state setting from a TODO keyword string.
  2927. This will extract info from a string like \"WAIT(w@/!)\"."
  2928. (let (kw key log1 log2)
  2929. (when (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?\\([!@]\\)?\\(?:/\\([!@]\\)\\)?)\\)?$" x)
  2930. (setq kw (match-string 1 x)
  2931. key (and (match-end 2) (match-string 2 x))
  2932. log1 (and (match-end 3) (match-string 3 x))
  2933. log2 (and (match-end 4) (match-string 4 x)))
  2934. (and (or log1 log2)
  2935. (list kw
  2936. (and log1 (if (equal log1 "!") 'time 'note))
  2937. (and log2 (if (equal log2 "!") 'time 'note)))))))
  2938. (defun org-remove-keyword-keys (list)
  2939. "Remove a pair of parenthesis at the end of each string in LIST."
  2940. (mapcar (lambda (x)
  2941. (if (string-match "(.*)$" x)
  2942. (substring x 0 (match-beginning 0))
  2943. x))
  2944. list))
  2945. ;; FIXME: this could be done much better, using second characters etc.
  2946. (defun org-assign-fast-keys (alist)
  2947. "Assign fast keys to a keyword-key alist.
  2948. Respect keys that are already there."
  2949. (let (new e k c c1 c2 (char ?a))
  2950. (while (setq e (pop alist))
  2951. (cond
  2952. ((equal e '(:startgroup)) (push e new))
  2953. ((equal e '(:endgroup)) (push e new))
  2954. (t
  2955. (setq k (car e) c2 nil)
  2956. (if (cdr e)
  2957. (setq c (cdr e))
  2958. ;; automatically assign a character.
  2959. (setq c1 (string-to-char
  2960. (downcase (substring
  2961. k (if (= (string-to-char k) ?@) 1 0)))))
  2962. (if (or (rassoc c1 new) (rassoc c1 alist))
  2963. (while (or (rassoc char new) (rassoc char alist))
  2964. (setq char (1+ char)))
  2965. (setq c2 c1))
  2966. (setq c (or c2 char)))
  2967. (push (cons k c) new))))
  2968. (nreverse new)))
  2969. ;;; Some variables used in various places
  2970. (defvar org-window-configuration nil
  2971. "Used in various places to store a window configuration.")
  2972. (defvar org-finish-function nil
  2973. "Function to be called when `C-c C-c' is used.
  2974. This is for getting out of special buffers like remember.")
  2975. ;; FIXME: Occasionally check by commenting these, to make sure
  2976. ;; no other functions uses these, forgetting to let-bind them.
  2977. (defvar entry)
  2978. (defvar state)
  2979. (defvar last-state)
  2980. (defvar date)
  2981. (defvar description)
  2982. ;; Defined somewhere in this file, but used before definition.
  2983. (defvar org-html-entities)
  2984. (defvar org-struct-menu)
  2985. (defvar org-org-menu)
  2986. (defvar org-tbl-menu)
  2987. (defvar org-agenda-keymap)
  2988. ;;;; Define the Org-mode
  2989. (if (and (not (keymapp outline-mode-map)) (featurep 'allout))
  2990. (error "Conflict with outdated version of allout.el. Load org.el before allout.el, or upgrade to newer allout, for example by switching to Emacs 22."))
  2991. ;; We use a before-change function to check if a table might need
  2992. ;; an update.
  2993. (defvar org-table-may-need-update t
  2994. "Indicates that a table might need an update.
  2995. This variable is set by `org-before-change-function'.
  2996. `org-table-align' sets it back to nil.")
  2997. (defun org-before-change-function (beg end)
  2998. "Every change indicates that a table might need an update."
  2999. (setq org-table-may-need-update t))
  3000. (defvar org-mode-map)
  3001. (defvar org-mode-hook nil
  3002. "Mode hook for Org-mode, run after the mode was turned on.")
  3003. (defvar org-inhibit-startup nil) ; Dynamically-scoped param.
  3004. (defvar org-agenda-keep-modes nil) ; Dynamically-scoped param.
  3005. (defvar org-table-buffer-is-an nil)
  3006. (defconst org-outline-regexp "\\*+ ")
  3007. ;;;###autoload
  3008. (define-derived-mode org-mode outline-mode "Org"
  3009. "Outline-based notes management and organizer, alias
  3010. \"Carsten's outline-mode for keeping track of everything.\"
  3011. Org-mode develops organizational tasks around a NOTES file which
  3012. contains information about projects as plain text. Org-mode is
  3013. implemented on top of outline-mode, which is ideal to keep the content
  3014. of large files well structured. It supports ToDo items, deadlines and
  3015. time stamps, which magically appear in the diary listing of the Emacs
  3016. calendar. Tables are easily created with a built-in table editor.
  3017. Plain text URL-like links connect to websites, emails (VM), Usenet
  3018. messages (Gnus), BBDB entries, and any files related to the project.
  3019. For printing and sharing of notes, an Org-mode file (or a part of it)
  3020. can be exported as a structured ASCII or HTML file.
  3021. The following commands are available:
  3022. \\{org-mode-map}"
  3023. ;; Get rid of Outline menus, they are not needed
  3024. ;; Need to do this here because define-derived-mode sets up
  3025. ;; the keymap so late. Still, it is a waste to call this each time
  3026. ;; we switch another buffer into org-mode.
  3027. (if (featurep 'xemacs)
  3028. (when (boundp 'outline-mode-menu-heading)
  3029. ;; Assume this is Greg's port, it used easymenu
  3030. (easy-menu-remove outline-mode-menu-heading)
  3031. (easy-menu-remove outline-mode-menu-show)
  3032. (easy-menu-remove outline-mode-menu-hide))
  3033. (define-key org-mode-map [menu-bar headings] 'undefined)
  3034. (define-key org-mode-map [menu-bar hide] 'undefined)
  3035. (define-key org-mode-map [menu-bar show] 'undefined))
  3036. (org-load-modules-maybe)
  3037. (easy-menu-add org-org-menu)
  3038. (easy-menu-add org-tbl-menu)
  3039. (org-install-agenda-files-menu)
  3040. (if org-descriptive-links (org-add-to-invisibility-spec '(org-link)))
  3041. (org-add-to-invisibility-spec '(org-cwidth))
  3042. (when (featurep 'xemacs)
  3043. (org-set-local 'line-move-ignore-invisible t))
  3044. (org-set-local 'outline-regexp org-outline-regexp)
  3045. (org-set-local 'outline-level 'org-outline-level)
  3046. (when (and org-ellipsis
  3047. (fboundp 'set-display-table-slot) (boundp 'buffer-display-table)
  3048. (fboundp 'make-glyph-code))
  3049. (unless org-display-table
  3050. (setq org-display-table (make-display-table)))
  3051. (set-display-table-slot
  3052. org-display-table 4
  3053. (vconcat (mapcar
  3054. (lambda (c) (make-glyph-code c (and (not (stringp org-ellipsis))
  3055. org-ellipsis)))
  3056. (if (stringp org-ellipsis) org-ellipsis "..."))))
  3057. (setq buffer-display-table org-display-table))
  3058. (org-set-regexps-and-options)
  3059. (when (and org-tag-faces (not org-tags-special-faces-re))
  3060. ;; tag faces set outside customize.... force initialization.
  3061. (org-set-tag-faces 'org-tag-faces org-tag-faces))
  3062. ;; Calc embedded
  3063. (org-set-local 'calc-embedded-open-mode "# ")
  3064. (modify-syntax-entry ?# "<")
  3065. (modify-syntax-entry ?@ "w")
  3066. (if org-startup-truncated (setq truncate-lines t))
  3067. (org-set-local 'font-lock-unfontify-region-function
  3068. 'org-unfontify-region)
  3069. ;; Activate before-change-function
  3070. (org-set-local 'org-table-may-need-update t)
  3071. (org-add-hook 'before-change-functions 'org-before-change-function nil
  3072. 'local)
  3073. ;; Check for running clock before killing a buffer
  3074. (org-add-hook 'kill-buffer-hook 'org-check-running-clock nil 'local)
  3075. ;; Paragraphs and auto-filling
  3076. (org-set-autofill-regexps)
  3077. (setq indent-line-function 'org-indent-line-function)
  3078. (org-update-radio-target-regexp)
  3079. ;; Comment characters
  3080. ; (org-set-local 'comment-start "#") ;; FIXME: this breaks wrapping
  3081. (org-set-local 'comment-padding " ")
  3082. ;; Align options lines
  3083. (org-set-local
  3084. 'align-mode-rules-list
  3085. '((org-in-buffer-settings
  3086. (regexp . "^#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
  3087. (modes . '(org-mode)))))
  3088. ;; Imenu
  3089. (org-set-local 'imenu-create-index-function
  3090. 'org-imenu-get-tree)
  3091. ;; Make isearch reveal context
  3092. (if (or (featurep 'xemacs)
  3093. (not (boundp 'outline-isearch-open-invisible-function)))
  3094. ;; Emacs 21 and XEmacs make use of the hook
  3095. (org-add-hook 'isearch-mode-end-hook 'org-isearch-end 'append 'local)
  3096. ;; Emacs 22 deals with this through a special variable
  3097. (org-set-local 'outline-isearch-open-invisible-function
  3098. (lambda (&rest ignore) (org-show-context 'isearch))))
  3099. ;; If empty file that did not turn on org-mode automatically, make it to.
  3100. (if (and org-insert-mode-line-in-empty-file
  3101. (interactive-p)
  3102. (= (point-min) (point-max)))
  3103. (insert "# -*- mode: org -*-\n\n"))
  3104. (unless org-inhibit-startup
  3105. (when org-startup-align-all-tables
  3106. (let ((bmp (buffer-modified-p)))
  3107. (org-table-map-tables 'org-table-align)
  3108. (set-buffer-modified-p bmp)))
  3109. (org-set-startup-visibility)))
  3110. (put 'org-mode 'flyspell-mode-predicate 'org-mode-flyspell-verify)
  3111. (defun org-current-time ()
  3112. "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
  3113. (if (> (car org-time-stamp-rounding-minutes) 1)
  3114. (let ((r (car org-time-stamp-rounding-minutes))
  3115. (time (decode-time)))
  3116. (apply 'encode-time
  3117. (append (list 0 (* r (floor (+ .5 (/ (float (nth 1 time)) r)))))
  3118. (nthcdr 2 time))))
  3119. (current-time)))
  3120. ;;;; Font-Lock stuff, including the activators
  3121. (defvar org-mouse-map (make-sparse-keymap))
  3122. (org-defkey org-mouse-map
  3123. (if (featurep 'xemacs) [button2] [mouse-2]) 'org-open-at-mouse)
  3124. (org-defkey org-mouse-map
  3125. (if (featurep 'xemacs) [button3] [mouse-3]) 'org-find-file-at-mouse)
  3126. (when org-mouse-1-follows-link
  3127. (org-defkey org-mouse-map [follow-link] 'mouse-face))
  3128. (when org-tab-follows-link
  3129. (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
  3130. (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
  3131. (when org-return-follows-link
  3132. (org-defkey org-mouse-map [(return)] 'org-open-at-point)
  3133. (org-defkey org-mouse-map "\C-m" 'org-open-at-point))
  3134. (require 'font-lock)
  3135. (defconst org-non-link-chars "]\t\n\r<>")
  3136. (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "news"
  3137. "shell" "elisp"))
  3138. (defvar org-link-types-re nil
  3139. "Matches a link that has a url-like prefix like \"http:\"")
  3140. (defvar org-link-re-with-space nil
  3141. "Matches a link with spaces, optional angular brackets around it.")
  3142. (defvar org-link-re-with-space2 nil
  3143. "Matches a link with spaces, optional angular brackets around it.")
  3144. (defvar org-link-re-with-space3 nil
  3145. "Matches a link with spaces, only for internal part in bracket links.")
  3146. (defvar org-angle-link-re nil
  3147. "Matches link with angular brackets, spaces are allowed.")
  3148. (defvar org-plain-link-re nil
  3149. "Matches plain link, without spaces.")
  3150. (defvar org-bracket-link-regexp nil
  3151. "Matches a link in double brackets.")
  3152. (defvar org-bracket-link-analytic-regexp nil
  3153. "Regular expression used to analyze links.
  3154. Here is what the match groups contain after a match:
  3155. 1: http:
  3156. 2: http
  3157. 3: path
  3158. 4: [desc]
  3159. 5: desc")
  3160. (defvar org-bracket-link-analytic-regexp++ nil
  3161. "Like org-bracket-link-analytic-regexp, but include coderef internal type.")
  3162. (defvar org-any-link-re nil
  3163. "Regular expression matching any link.")
  3164. (defun org-make-link-regexps ()
  3165. "Update the link regular expressions.
  3166. This should be called after the variable `org-link-types' has changed."
  3167. (setq org-link-types-re
  3168. (concat
  3169. "\\`\\(" (mapconcat 'identity org-link-types "\\|") "\\):")
  3170. org-link-re-with-space
  3171. (concat
  3172. "<?\\(" (mapconcat 'identity org-link-types "\\|") "\\):"
  3173. "\\([^" org-non-link-chars " ]"
  3174. "[^" org-non-link-chars "]*"
  3175. "[^" org-non-link-chars " ]\\)>?")
  3176. org-link-re-with-space2
  3177. (concat
  3178. "<?\\(" (mapconcat 'identity org-link-types "\\|") "\\):"
  3179. "\\([^" org-non-link-chars " ]"
  3180. "[^\t\n\r]*"
  3181. "[^" org-non-link-chars " ]\\)>?")
  3182. org-link-re-with-space3
  3183. (concat
  3184. "<?\\(" (mapconcat 'identity org-link-types "\\|") "\\):"
  3185. "\\([^" org-non-link-chars " ]"
  3186. "[^\t\n\r]*\\)")
  3187. org-angle-link-re
  3188. (concat
  3189. "<\\(" (mapconcat 'identity org-link-types "\\|") "\\):"
  3190. "\\([^" org-non-link-chars " ]"
  3191. "[^" org-non-link-chars "]*"
  3192. "\\)>")
  3193. org-plain-link-re
  3194. (concat
  3195. "\\<\\(" (mapconcat 'identity org-link-types "\\|") "\\):"
  3196. "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
  3197. org-bracket-link-regexp
  3198. "\\[\\[\\([^][]+\\)\\]\\(\\[\\([^][]+\\)\\]\\)?\\]"
  3199. org-bracket-link-analytic-regexp
  3200. (concat
  3201. "\\[\\["
  3202. "\\(\\(" (mapconcat 'identity org-link-types "\\|") "\\):\\)?"
  3203. "\\([^]]+\\)"
  3204. "\\]"
  3205. "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
  3206. "\\]")
  3207. org-bracket-link-analytic-regexp++
  3208. (concat
  3209. "\\[\\["
  3210. "\\(\\(" (mapconcat 'identity (cons "coderef" org-link-types) "\\|") "\\):\\)?"
  3211. "\\([^]]+\\)"
  3212. "\\]"
  3213. "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
  3214. "\\]")
  3215. org-any-link-re
  3216. (concat "\\(" org-bracket-link-regexp "\\)\\|\\("
  3217. org-angle-link-re "\\)\\|\\("
  3218. org-plain-link-re "\\)")))
  3219. (org-make-link-regexps)
  3220. (defconst org-ts-regexp "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} [^\r\n>]*?\\)>"
  3221. "Regular expression for fast time stamp matching.")
  3222. (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} [^\r\n>]*?\\)[]>]"
  3223. "Regular expression for fast time stamp matching.")
  3224. (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
  3225. "Regular expression matching time strings for analysis.
  3226. This one does not require the space after the date, so it can be used
  3227. on a string that terminates immediately after the date.")
  3228. (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) +\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
  3229. "Regular expression matching time strings for analysis.")
  3230. (defconst org-ts-regexp2 (concat "<" org-ts-regexp1 "[^>\n]\\{0,16\\}>")
  3231. "Regular expression matching time stamps, with groups.")
  3232. (defconst org-ts-regexp3 (concat "[[<]" org-ts-regexp1 "[^]>\n]\\{0,16\\}[]>]")
  3233. "Regular expression matching time stamps (also [..]), with groups.")
  3234. (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
  3235. "Regular expression matching a time stamp range.")
  3236. (defconst org-tr-regexp-both
  3237. (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
  3238. "Regular expression matching a time stamp range.")
  3239. (defconst org-tsr-regexp (concat org-ts-regexp "\\(--?-?"
  3240. org-ts-regexp "\\)?")
  3241. "Regular expression matching a time stamp or time stamp range.")
  3242. (defconst org-tsr-regexp-both (concat org-ts-regexp-both "\\(--?-?"
  3243. org-ts-regexp-both "\\)?")
  3244. "Regular expression matching a time stamp or time stamp range.
  3245. The time stamps may be either active or inactive.")
  3246. (defvar org-emph-face nil)
  3247. (defun org-do-emphasis-faces (limit)
  3248. "Run through the buffer and add overlays to links."
  3249. (let (rtn)
  3250. (while (and (not rtn) (re-search-forward org-emph-re limit t))
  3251. (if (not (= (char-after (match-beginning 3))
  3252. (char-after (match-beginning 4))))
  3253. (progn
  3254. (setq rtn t)
  3255. (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
  3256. 'face
  3257. (nth 1 (assoc (match-string 3)
  3258. org-emphasis-alist)))
  3259. (add-text-properties (match-beginning 2) (match-end 2)
  3260. '(font-lock-multiline t))
  3261. (when org-hide-emphasis-markers
  3262. (add-text-properties (match-end 4) (match-beginning 5)
  3263. '(invisible org-link))
  3264. (add-text-properties (match-beginning 3) (match-end 3)
  3265. '(invisible org-link)))))
  3266. (backward-char 1))
  3267. rtn))
  3268. (defun org-emphasize (&optional char)
  3269. "Insert or change an emphasis, i.e. a font like bold or italic.
  3270. If there is an active region, change that region to a new emphasis.
  3271. If there is no region, just insert the marker characters and position
  3272. the cursor between them.
  3273. CHAR should be either the marker character, or the first character of the
  3274. HTML tag associated with that emphasis. If CHAR is a space, the means
  3275. to remove the emphasis of the selected region.
  3276. If char is not given (for example in an interactive call) it
  3277. will be prompted for."
  3278. (interactive)
  3279. (let ((eal org-emphasis-alist) e det
  3280. (erc org-emphasis-regexp-components)
  3281. (prompt "")
  3282. (string "") beg end move tag c s)
  3283. (if (org-region-active-p)
  3284. (setq beg (region-beginning) end (region-end)
  3285. string (buffer-substring beg end))
  3286. (setq move t))
  3287. (while (setq e (pop eal))
  3288. (setq tag (car (org-split-string (nth 2 e) "[ <>/]+"))
  3289. c (aref tag 0))
  3290. (push (cons c (string-to-char (car e))) det)
  3291. (setq prompt (concat prompt (format " [%s%c]%s" (car e) c
  3292. (substring tag 1)))))
  3293. (setq det (nreverse det))
  3294. (unless char
  3295. (message "%s" (concat "Emphasis marker or tag:" prompt))
  3296. (setq char (read-char-exclusive)))
  3297. (setq char (or (cdr (assoc char det)) char))
  3298. (if (equal char ?\ )
  3299. (setq s "" move nil)
  3300. (unless (assoc (char-to-string char) org-emphasis-alist)
  3301. (error "No such emphasis marker: \"%c\"" char))
  3302. (setq s (char-to-string char)))
  3303. (while (and (> (length string) 1)
  3304. (equal (substring string 0 1) (substring string -1))
  3305. (assoc (substring string 0 1) org-emphasis-alist))
  3306. (setq string (substring string 1 -1)))
  3307. (setq string (concat s string s))
  3308. (if beg (delete-region beg end))
  3309. (unless (or (bolp)
  3310. (string-match (concat "[" (nth 0 erc) "\n]")
  3311. (char-to-string (char-before (point)))))
  3312. (insert " "))
  3313. (unless (string-match (concat "[" (nth 1 erc) "\n]")
  3314. (char-to-string (char-after (point))))
  3315. (insert " ") (backward-char 1))
  3316. (insert string)
  3317. (and move (backward-char 1))))
  3318. (defconst org-nonsticky-props
  3319. '(mouse-face highlight keymap invisible intangible help-echo org-linked-text))
  3320. (defun org-activate-plain-links (limit)
  3321. "Run through the buffer and add overlays to links."
  3322. (catch 'exit
  3323. (let (f)
  3324. (while (re-search-forward org-plain-link-re limit t)
  3325. (setq f (get-text-property (match-beginning 0) 'face))
  3326. (if (or (eq f 'org-tag)
  3327. (and (listp f) (memq 'org-tag f)))
  3328. nil
  3329. (add-text-properties (match-beginning 0) (match-end 0)
  3330. (list 'mouse-face 'highlight
  3331. 'rear-nonsticky org-nonsticky-props
  3332. 'keymap org-mouse-map
  3333. ))
  3334. (throw 'exit t))))))
  3335. (defun org-activate-code (limit)
  3336. (if (re-search-forward "^[ \t]*\\(: .*\n?\\)" limit t)
  3337. (progn
  3338. (remove-text-properties (match-beginning 0) (match-end 0)
  3339. '(display t invisible t intangible t))
  3340. t)))
  3341. (defun org-activate-angle-links (limit)
  3342. "Run through the buffer and add overlays to links."
  3343. (if (re-search-forward org-angle-link-re limit t)
  3344. (progn
  3345. (add-text-properties (match-beginning 0) (match-end 0)
  3346. (list 'mouse-face 'highlight
  3347. 'rear-nonsticky org-nonsticky-props
  3348. 'keymap org-mouse-map
  3349. ))
  3350. t)))
  3351. (defun org-activate-footnote-links (limit)
  3352. "Run through the buffer and add overlays to links."
  3353. (if (re-search-forward "\\[\\([0-9]+\\]\\|fn:[^ \t\r\n:]+?[]:]\\)"
  3354. limit t)
  3355. (progn
  3356. (add-text-properties (match-beginning 0) (match-end 0)
  3357. (list 'mouse-face 'highlight
  3358. 'rear-nonsticky org-nonsticky-props
  3359. 'keymap org-mouse-map
  3360. 'help-echo
  3361. (if (= (point-at-bol) (match-beginning 0))
  3362. "Footnote definition"
  3363. "Footnote reference")
  3364. ))
  3365. t)))
  3366. (defun org-activate-bracket-links (limit)
  3367. "Run through the buffer and add overlays to bracketed links."
  3368. (if (re-search-forward org-bracket-link-regexp limit t)
  3369. (let* ((help (concat "LINK: "
  3370. (org-match-string-no-properties 1)))
  3371. ;; FIXME: above we should remove the escapes.
  3372. ;; but that requires another match, protecting match data,
  3373. ;; a lot of overhead for font-lock.
  3374. (ip (org-maybe-intangible
  3375. (list 'invisible 'org-link 'rear-nonsticky org-nonsticky-props
  3376. 'keymap org-mouse-map 'mouse-face 'highlight
  3377. 'font-lock-multiline t 'help-echo help)))
  3378. (vp (list 'rear-nonsticky org-nonsticky-props
  3379. 'keymap org-mouse-map 'mouse-face 'highlight
  3380. ' font-lock-multiline t 'help-echo help)))
  3381. ;; We need to remove the invisible property here. Table narrowing
  3382. ;; may have made some of this invisible.
  3383. (remove-text-properties (match-beginning 0) (match-end 0)
  3384. '(invisible nil))
  3385. (if (match-end 3)
  3386. (progn
  3387. (add-text-properties (match-beginning 0) (match-beginning 3) ip)
  3388. (add-text-properties (match-beginning 3) (match-end 3) vp)
  3389. (add-text-properties (match-end 3) (match-end 0) ip))
  3390. (add-text-properties (match-beginning 0) (match-beginning 1) ip)
  3391. (add-text-properties (match-beginning 1) (match-end 1) vp)
  3392. (add-text-properties (match-end 1) (match-end 0) ip))
  3393. t)))
  3394. (defun org-activate-dates (limit)
  3395. "Run through the buffer and add overlays to dates."
  3396. (if (re-search-forward org-tsr-regexp-both limit t)
  3397. (progn
  3398. (add-text-properties (match-beginning 0) (match-end 0)
  3399. (list 'mouse-face 'highlight
  3400. 'rear-nonsticky org-nonsticky-props
  3401. 'keymap org-mouse-map))
  3402. (when org-display-custom-times
  3403. (if (match-end 3)
  3404. (org-display-custom-time (match-beginning 3) (match-end 3)))
  3405. (org-display-custom-time (match-beginning 1) (match-end 1)))
  3406. t)))
  3407. (defvar org-target-link-regexp nil
  3408. "Regular expression matching radio targets in plain text.")
  3409. (make-variable-buffer-local 'org-target-link-regexp)
  3410. (defvar org-target-regexp "<<\\([^<>\n\r]+\\)>>"
  3411. "Regular expression matching a link target.")
  3412. (defvar org-radio-target-regexp "<<<\\([^<>\n\r]+\\)>>>"
  3413. "Regular expression matching a radio target.")
  3414. (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
  3415. "Regular expression matching any target.")
  3416. (defun org-activate-target-links (limit)
  3417. "Run through the buffer and add overlays to target matches."
  3418. (when org-target-link-regexp
  3419. (let ((case-fold-search t))
  3420. (if (re-search-forward org-target-link-regexp limit t)
  3421. (progn
  3422. (add-text-properties (match-beginning 0) (match-end 0)
  3423. (list 'mouse-face 'highlight
  3424. 'rear-nonsticky org-nonsticky-props
  3425. 'keymap org-mouse-map
  3426. 'help-echo "Radio target link"
  3427. 'org-linked-text t))
  3428. t)))))
  3429. (defun org-update-radio-target-regexp ()
  3430. "Find all radio targets in this file and update the regular expression."
  3431. (interactive)
  3432. (when (memq 'radio org-activate-links)
  3433. (setq org-target-link-regexp
  3434. (org-make-target-link-regexp (org-all-targets 'radio)))
  3435. (org-restart-font-lock)))
  3436. (defun org-hide-wide-columns (limit)
  3437. (let (s e)
  3438. (setq s (text-property-any (point) (or limit (point-max))
  3439. 'org-cwidth t))
  3440. (when s
  3441. (setq e (next-single-property-change s 'org-cwidth))
  3442. (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
  3443. (goto-char e)
  3444. t)))
  3445. (defvar org-latex-and-specials-regexp nil
  3446. "Regular expression for highlighting export special stuff.")
  3447. (defvar org-match-substring-regexp)
  3448. (defvar org-match-substring-with-braces-regexp)
  3449. (defvar org-export-html-special-string-regexps)
  3450. (defun org-compute-latex-and-specials-regexp ()
  3451. "Compute regular expression for stuff treated specially by exporters."
  3452. (if (not org-highlight-latex-fragments-and-specials)
  3453. (org-set-local 'org-latex-and-specials-regexp nil)
  3454. (require 'org-exp)
  3455. (let*
  3456. ((matchers (plist-get org-format-latex-options :matchers))
  3457. (latexs (delq nil (mapcar (lambda (x) (if (member (car x) matchers) x))
  3458. org-latex-regexps)))
  3459. (options (org-combine-plists (org-default-export-plist)
  3460. (org-infile-export-plist)))
  3461. (org-export-with-sub-superscripts (plist-get options :sub-superscript))
  3462. (org-export-with-LaTeX-fragments (plist-get options :LaTeX-fragments))
  3463. (org-export-with-TeX-macros (plist-get options :TeX-macros))
  3464. (org-export-html-expand (plist-get options :expand-quoted-html))
  3465. (org-export-with-special-strings (plist-get options :special-strings))
  3466. (re-sub
  3467. (cond
  3468. ((equal org-export-with-sub-superscripts '{})
  3469. (list org-match-substring-with-braces-regexp))
  3470. (org-export-with-sub-superscripts
  3471. (list org-match-substring-regexp))
  3472. (t nil)))
  3473. (re-latex
  3474. (if org-export-with-LaTeX-fragments
  3475. (mapcar (lambda (x) (nth 1 x)) latexs)))
  3476. (re-macros
  3477. (if org-export-with-TeX-macros
  3478. (list (concat "\\\\"
  3479. (regexp-opt
  3480. (append (mapcar 'car org-html-entities)
  3481. (if (boundp 'org-latex-entities)
  3482. org-latex-entities nil))
  3483. 'words))) ; FIXME
  3484. ))
  3485. ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
  3486. (re-special (if org-export-with-special-strings
  3487. (mapcar (lambda (x) (car x))
  3488. org-export-html-special-string-regexps)))
  3489. (re-rest
  3490. (delq nil
  3491. (list
  3492. (if org-export-html-expand "@<[^>\n]+>")
  3493. ))))
  3494. (org-set-local
  3495. 'org-latex-and-specials-regexp
  3496. (mapconcat 'identity (append re-latex re-sub re-macros re-special
  3497. re-rest) "\\|")))))
  3498. (defun org-do-latex-and-special-faces (limit)
  3499. "Run through the buffer and add overlays to links."
  3500. (when org-latex-and-specials-regexp
  3501. (let (rtn d)
  3502. (while (and (not rtn) (re-search-forward org-latex-and-specials-regexp
  3503. limit t))
  3504. (if (not (memq (car-safe (get-text-property (1+ (match-beginning 0))
  3505. 'face))
  3506. '(org-code org-verbatim underline)))
  3507. (progn
  3508. (setq rtn t
  3509. d (cond ((member (char-after (1+ (match-beginning 0)))
  3510. '(?_ ?^)) 1)
  3511. (t 0)))
  3512. (font-lock-prepend-text-property
  3513. (+ d (match-beginning 0)) (match-end 0)
  3514. 'face 'org-latex-and-export-specials)
  3515. (add-text-properties (+ d (match-beginning 0)) (match-end 0)
  3516. '(font-lock-multiline t)))))
  3517. rtn)))
  3518. (defun org-restart-font-lock ()
  3519. "Restart font-lock-mode, to force refontification."
  3520. (when (and (boundp 'font-lock-mode) font-lock-mode)
  3521. (font-lock-mode -1)
  3522. (font-lock-mode 1)))
  3523. (defun org-all-targets (&optional radio)
  3524. "Return a list of all targets in this file.
  3525. With optional argument RADIO, only find radio targets."
  3526. (let ((re (if radio org-radio-target-regexp org-target-regexp))
  3527. rtn)
  3528. (save-excursion
  3529. (goto-char (point-min))
  3530. (while (re-search-forward re nil t)
  3531. (add-to-list 'rtn (downcase (org-match-string-no-properties 1))))
  3532. rtn)))
  3533. (defun org-make-target-link-regexp (targets)
  3534. "Make regular expression matching all strings in TARGETS.
  3535. The regular expression finds the targets also if there is a line break
  3536. between words."
  3537. (and targets
  3538. (concat
  3539. "\\<\\("
  3540. (mapconcat
  3541. (lambda (x)
  3542. (while (string-match " +" x)
  3543. (setq x (replace-match "\\s-+" t t x)))
  3544. x)
  3545. targets
  3546. "\\|")
  3547. "\\)\\>")))
  3548. (defun org-activate-tags (limit)
  3549. (if (re-search-forward (org-re "^\\*+.*[ \t]\\(:[[:alnum:]_@:]+:\\)[ \r\n]") limit t)
  3550. (progn
  3551. (add-text-properties (match-beginning 1) (match-end 1)
  3552. (list 'mouse-face 'highlight
  3553. 'rear-nonsticky org-nonsticky-props
  3554. 'keymap org-mouse-map))
  3555. t)))
  3556. (defun org-outline-level ()
  3557. (save-excursion
  3558. (looking-at outline-regexp)
  3559. (if (match-beginning 1)
  3560. (+ (org-get-string-indentation (match-string 1)) 1000)
  3561. (1- (- (match-end 0) (match-beginning 0))))))
  3562. (defvar org-font-lock-keywords nil)
  3563. (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
  3564. "Regular expression matching a property line.")
  3565. (defvar org-font-lock-hook nil
  3566. "Functions to be called for special font lock stuff.")
  3567. (defun org-font-lock-hook (limit)
  3568. (run-hook-with-args 'org-font-lock-hook limit))
  3569. (defun org-set-font-lock-defaults ()
  3570. (let* ((em org-fontify-emphasized-text)
  3571. (lk org-activate-links)
  3572. (org-font-lock-extra-keywords
  3573. (list
  3574. ;; Call the hook
  3575. '(org-font-lock-hook)
  3576. ;; Headlines
  3577. '("^\\(\\**\\)\\(\\* \\)\\(.*\\)" (1 (org-get-level-face 1))
  3578. (2 (org-get-level-face 2)) (3 (org-get-level-face 3)))
  3579. ;; Table lines
  3580. '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
  3581. (1 'org-table t))
  3582. ;; Table internals
  3583. '("^[ \t]*|\\(?:.*?|\\)? *\\(:?=[^|\n]*\\)" (1 'org-formula t))
  3584. '("^[ \t]*| *\\([#*]\\) *|" (1 'org-formula t))
  3585. '("^[ \t]*|\\( *\\([$!_^/]\\) *|.*\\)|" (1 'org-formula t))
  3586. ;; Drawers
  3587. (list org-drawer-regexp '(0 'org-special-keyword t))
  3588. (list "^[ \t]*:END:" '(0 'org-special-keyword t))
  3589. ;; Properties
  3590. (list org-property-re
  3591. '(1 'org-special-keyword t)
  3592. '(3 'org-property-value t))
  3593. (if org-format-transports-properties-p
  3594. '("| *\\(<[0-9]+>\\) *" (1 'org-formula t)))
  3595. ;; Links
  3596. (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
  3597. (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
  3598. (if (memq 'plain lk) '(org-activate-plain-links (0 'org-link t)))
  3599. (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
  3600. (if (memq 'radio lk) '(org-activate-target-links (0 'org-link t)))
  3601. (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
  3602. (if (memq 'footnote lk) '(org-activate-footnote-links
  3603. (0 'org-footnote t)))
  3604. '("^&?%%(.*\\|<%%([^>\n]*?>" (0 'org-sexp-date t))
  3605. '(org-hide-wide-columns (0 nil append))
  3606. ;; TODO lines
  3607. (list (concat "^\\*+[ \t]+" org-todo-regexp)
  3608. '(1 (org-get-todo-face 1) t))
  3609. ;; DONE
  3610. (if org-fontify-done-headline
  3611. (list (concat "^[*]+ +\\<\\("
  3612. (mapconcat 'regexp-quote org-done-keywords "\\|")
  3613. "\\)\\(.*\\)")
  3614. '(2 'org-headline-done t))
  3615. nil)
  3616. ;; Priorities
  3617. (list (concat "\\[#[A-Z0-9]\\]") '(0 'org-special-keyword t))
  3618. ;; Tags
  3619. '(org-font-lock-add-tag-faces)
  3620. ;; Special keywords
  3621. (list (concat "\\<" org-deadline-string) '(0 'org-special-keyword t))
  3622. (list (concat "\\<" org-scheduled-string) '(0 'org-special-keyword t))
  3623. (list (concat "\\<" org-closed-string) '(0 'org-special-keyword t))
  3624. (list (concat "\\<" org-clock-string) '(0 'org-special-keyword t))
  3625. ;; Emphasis
  3626. (if em
  3627. (if (featurep 'xemacs)
  3628. '(org-do-emphasis-faces (0 nil append))
  3629. '(org-do-emphasis-faces)))
  3630. ;; Checkboxes
  3631. '("^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) +\\(\\[[- X]\\]\\)"
  3632. 2 'bold prepend)
  3633. (if org-provide-checkbox-statistics
  3634. '("\\[\\([0-9]*%\\)\\]\\|\\[\\([0-9]*\\)/\\([0-9]*\\)\\]"
  3635. (0 (org-get-checkbox-statistics-face) t)))
  3636. ;; Description list items
  3637. '("^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) +\\(.*? ::\\)"
  3638. 2 'bold prepend)
  3639. (list (concat "^\\*+ \\(.*:" org-archive-tag ":.*\\)")
  3640. '(1 'org-archived prepend))
  3641. ;; Specials
  3642. '(org-do-latex-and-special-faces)
  3643. ;; Code
  3644. '(org-activate-code (1 'org-code t))
  3645. ;; COMMENT
  3646. (list (concat "^\\*+[ \t]+\\<\\(" org-comment-string
  3647. "\\|" org-quote-string "\\)\\>")
  3648. '(1 'org-special-keyword t))
  3649. '("^#.*" (0 'font-lock-comment-face t))
  3650. )))
  3651. (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
  3652. ;; Now set the full font-lock-keywords
  3653. (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
  3654. (org-set-local 'font-lock-defaults
  3655. '(org-font-lock-keywords t nil nil backward-paragraph))
  3656. (kill-local-variable 'font-lock-keywords) nil))
  3657. (defvar org-m nil)
  3658. (defvar org-l nil)
  3659. (defvar org-f nil)
  3660. (defun org-get-level-face (n)
  3661. "Get the right face for match N in font-lock matching of headlines."
  3662. (setq org-l (- (match-end 2) (match-beginning 1) 1))
  3663. (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
  3664. (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
  3665. (cond
  3666. ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
  3667. ((eq n 2) org-f)
  3668. (t (if org-level-color-stars-only nil org-f))))
  3669. (defun org-get-todo-face (kwd)
  3670. "Get the right face for a TODO keyword KWD.
  3671. If KWD is a number, get the corresponding match group."
  3672. (if (numberp kwd) (setq kwd (match-string kwd)))
  3673. (or (cdr (assoc kwd org-todo-keyword-faces))
  3674. (and (member kwd org-done-keywords) 'org-done)
  3675. 'org-todo))
  3676. (defun org-font-lock-add-tag-faces (limit)
  3677. "Add the special tag faces."
  3678. (when (and org-tag-faces org-tags-special-faces-re)
  3679. (while (re-search-forward org-tags-special-faces-re limit t)
  3680. (add-text-properties (match-beginning 1) (match-end 1)
  3681. (list 'face (org-get-tag-face 1)
  3682. 'font-lock-fontified t))
  3683. (backward-char 1))))
  3684. (defun org-get-tag-face (kwd)
  3685. "Get the right face for a TODO keyword KWD.
  3686. If KWD is a number, get the corresponding match group."
  3687. (if (numberp kwd) (setq kwd (match-string kwd)))
  3688. (or (cdr (assoc kwd org-tag-faces))
  3689. 'org-tag))
  3690. (defun org-unfontify-region (beg end &optional maybe_loudly)
  3691. "Remove fontification and activation overlays from links."
  3692. (font-lock-default-unfontify-region beg end)
  3693. (let* ((buffer-undo-list t)
  3694. (inhibit-read-only t) (inhibit-point-motion-hooks t)
  3695. (inhibit-modification-hooks t)
  3696. deactivate-mark buffer-file-name buffer-file-truename)
  3697. (remove-text-properties beg end
  3698. '(mouse-face t keymap t org-linked-text t
  3699. invisible t intangible t))))
  3700. ;;;; Visibility cycling, including org-goto and indirect buffer
  3701. ;;; Cycling
  3702. (defvar org-cycle-global-status nil)
  3703. (make-variable-buffer-local 'org-cycle-global-status)
  3704. (defvar org-cycle-subtree-status nil)
  3705. (make-variable-buffer-local 'org-cycle-subtree-status)
  3706. ;;;###autoload
  3707. (defun org-cycle (&optional arg)
  3708. "Visibility cycling for Org-mode.
  3709. - When this function is called with a prefix argument, rotate the entire
  3710. buffer through 3 states (global cycling)
  3711. 1. OVERVIEW: Show only top-level headlines.
  3712. 2. CONTENTS: Show all headlines of all levels, but no body text.
  3713. 3. SHOW ALL: Show everything.
  3714. When called with two C-u C-u prefixes, switch to the startup visibility,
  3715. determined by the variable `org-startup-folded', and by any VISIBILITY
  3716. properties in the buffer.
  3717. When called with three C-u C-u C-u prefixed, show the entire buffer,
  3718. including drawers.
  3719. - When point is at the beginning of a headline, rotate the subtree started
  3720. by this line through 3 different states (local cycling)
  3721. 1. FOLDED: Only the main headline is shown.
  3722. 2. CHILDREN: The main headline and the direct children are shown.
  3723. From this state, you can move to one of the children
  3724. and zoom in further.
  3725. 3. SUBTREE: Show the entire subtree, including body text.
  3726. - When there is a numeric prefix, go up to a heading with level ARG, do
  3727. a `show-subtree' and return to the previous cursor position. If ARG
  3728. is negative, go up that many levels.
  3729. - When point is not at the beginning of a headline, execute the global
  3730. binding for TAB, which is re-indenting the line. See the option
  3731. `org-cycle-emulate-tab' for details.
  3732. - Special case: if point is at the beginning of the buffer and there is
  3733. no headline in line 1, this function will act as if called with prefix arg.
  3734. But only if also the variable `org-cycle-global-at-bob' is t."
  3735. (interactive "P")
  3736. (org-load-modules-maybe)
  3737. (let* ((outline-regexp
  3738. (if (and (org-mode-p) org-cycle-include-plain-lists)
  3739. "\\(?:\\*+ \\|\\([ \t]*\\)\\([-+*]\\|[0-9]+[.)]\\) \\)"
  3740. outline-regexp))
  3741. (bob-special (and org-cycle-global-at-bob (bobp)
  3742. (not (looking-at outline-regexp))))
  3743. (org-cycle-hook
  3744. (if bob-special
  3745. (delq 'org-optimize-window-after-visibility-change
  3746. (copy-sequence org-cycle-hook))
  3747. org-cycle-hook))
  3748. (pos (point)))
  3749. (if (or bob-special (equal arg '(4)))
  3750. ;; special case: use global cycling
  3751. (setq arg t))
  3752. (cond
  3753. ((equal arg '(16))
  3754. (org-set-startup-visibility)
  3755. (message "Startup visibility, plus VISIBILITY properties"))
  3756. ((equal arg '(64))
  3757. (show-all)
  3758. (message "Entire buffer visible, including drawers"))
  3759. ((org-at-table-p 'any)
  3760. ;; Enter the table or move to the next field in the table
  3761. (or (org-table-recognize-table.el)
  3762. (progn
  3763. (if arg (org-table-edit-field t)
  3764. (org-table-justify-field-maybe)
  3765. (call-interactively 'org-table-next-field)))))
  3766. ((eq arg t) ;; Global cycling
  3767. (cond
  3768. ((and (eq last-command this-command)
  3769. (eq org-cycle-global-status 'overview))
  3770. ;; We just created the overview - now do table of contents
  3771. ;; This can be slow in very large buffers, so indicate action
  3772. (message "CONTENTS...")
  3773. (org-content)
  3774. (message "CONTENTS...done")
  3775. (setq org-cycle-global-status 'contents)
  3776. (run-hook-with-args 'org-cycle-hook 'contents))
  3777. ((and (eq last-command this-command)
  3778. (eq org-cycle-global-status 'contents))
  3779. ;; We just showed the table of contents - now show everything
  3780. (show-all)
  3781. (message "SHOW ALL")
  3782. (setq org-cycle-global-status 'all)
  3783. (run-hook-with-args 'org-cycle-hook 'all))
  3784. (t
  3785. ;; Default action: go to overview
  3786. (org-overview)
  3787. (message "OVERVIEW")
  3788. (setq org-cycle-global-status 'overview)
  3789. (run-hook-with-args 'org-cycle-hook 'overview))))
  3790. ((and org-drawers org-drawer-regexp
  3791. (save-excursion
  3792. (beginning-of-line 1)
  3793. (looking-at org-drawer-regexp)))
  3794. ;; Toggle block visibility
  3795. (org-flag-drawer
  3796. (not (get-char-property (match-end 0) 'invisible))))
  3797. ((integerp arg)
  3798. ;; Show-subtree, ARG levels up from here.
  3799. (save-excursion
  3800. (org-back-to-heading)
  3801. (outline-up-heading (if (< arg 0) (- arg)
  3802. (- (funcall outline-level) arg)))
  3803. (org-show-subtree)))
  3804. ((and (save-excursion (beginning-of-line 1) (looking-at outline-regexp))
  3805. (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
  3806. ;; At a heading: rotate between three different views
  3807. (org-back-to-heading)
  3808. (let ((goal-column 0) eoh eol eos)
  3809. ;; First, some boundaries
  3810. (save-excursion
  3811. (org-back-to-heading)
  3812. (save-excursion
  3813. (beginning-of-line 2)
  3814. (while (and (not (eobp)) ;; this is like `next-line'
  3815. (get-char-property (1- (point)) 'invisible))
  3816. (beginning-of-line 2)) (setq eol (point)))
  3817. (outline-end-of-heading) (setq eoh (point))
  3818. (org-end-of-subtree t)
  3819. (unless (eobp)
  3820. (skip-chars-forward " \t\n")
  3821. (beginning-of-line 1) ; in case this is an item
  3822. )
  3823. (setq eos (1- (point))))
  3824. ;; Find out what to do next and set `this-command'
  3825. (cond
  3826. ((= eos eoh)
  3827. ;; Nothing is hidden behind this heading
  3828. (message "EMPTY ENTRY")
  3829. (setq org-cycle-subtree-status nil)
  3830. (save-excursion
  3831. (goto-char eos)
  3832. (outline-next-heading)
  3833. (if (org-invisible-p) (org-flag-heading nil))))
  3834. ((or (>= eol eos)
  3835. (not (string-match "\\S-" (buffer-substring eol eos))))
  3836. ;; Entire subtree is hidden in one line: open it
  3837. (org-show-entry)
  3838. (show-children)
  3839. (message "CHILDREN")
  3840. (save-excursion
  3841. (goto-char eos)
  3842. (outline-next-heading)
  3843. (if (org-invisible-p) (org-flag-heading nil)))
  3844. (setq org-cycle-subtree-status 'children)
  3845. (run-hook-with-args 'org-cycle-hook 'children))
  3846. ((and (eq last-command this-command)
  3847. (eq org-cycle-subtree-status 'children))
  3848. ;; We just showed the children, now show everything.
  3849. (org-show-subtree)
  3850. (message "SUBTREE")
  3851. (setq org-cycle-subtree-status 'subtree)
  3852. (run-hook-with-args 'org-cycle-hook 'subtree))
  3853. (t
  3854. ;; Default action: hide the subtree.
  3855. (hide-subtree)
  3856. (message "FOLDED")
  3857. (setq org-cycle-subtree-status 'folded)
  3858. (run-hook-with-args 'org-cycle-hook 'folded)))))
  3859. ;; TAB emulation and template completion
  3860. (buffer-read-only (org-back-to-heading))
  3861. ((org-try-structure-completion))
  3862. ((org-try-cdlatex-tab))
  3863. ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
  3864. (or (not (bolp))
  3865. (not (looking-at outline-regexp))))
  3866. (call-interactively (global-key-binding "\t")))
  3867. ((if (and (memq org-cycle-emulate-tab '(white whitestart))
  3868. (save-excursion (beginning-of-line 1) (looking-at "[ \t]*"))
  3869. (or (and (eq org-cycle-emulate-tab 'white)
  3870. (= (match-end 0) (point-at-eol)))
  3871. (and (eq org-cycle-emulate-tab 'whitestart)
  3872. (>= (match-end 0) pos))))
  3873. t
  3874. (eq org-cycle-emulate-tab t))
  3875. (call-interactively (global-key-binding "\t")))
  3876. (t (save-excursion
  3877. (org-back-to-heading)
  3878. (org-cycle))))))
  3879. ;;;###autoload
  3880. (defun org-global-cycle (&optional arg)
  3881. "Cycle the global visibility. For details see `org-cycle'.
  3882. With C-u prefix arg, switch to startup visibility.
  3883. With a numeric prefix, show all headlines up to that level."
  3884. (interactive "P")
  3885. (let ((org-cycle-include-plain-lists
  3886. (if (org-mode-p) org-cycle-include-plain-lists nil)))
  3887. (cond
  3888. ((integerp arg)
  3889. (show-all)
  3890. (hide-sublevels arg)
  3891. (setq org-cycle-global-status 'contents))
  3892. ((equal arg '(4))
  3893. (org-set-startup-visibility)
  3894. (message "Startup visibility, plus VISIBILITY properties."))
  3895. (t
  3896. (org-cycle '(4))))))
  3897. (defun org-set-startup-visibility ()
  3898. "Set the visibility required by startup options and properties."
  3899. (cond
  3900. ((eq org-startup-folded t)
  3901. (org-cycle '(4)))
  3902. ((eq org-startup-folded 'content)
  3903. (let ((this-command 'org-cycle) (last-command 'org-cycle))
  3904. (org-cycle '(4)) (org-cycle '(4)))))
  3905. (org-set-visibility-according-to-property 'no-cleanup)
  3906. (org-cycle-hide-archived-subtrees 'all)
  3907. (org-cycle-hide-drawers 'all)
  3908. (org-cycle-show-empty-lines 'all))
  3909. (defun org-set-visibility-according-to-property (&optional no-cleanup)
  3910. "Switch subtree visibilities according to :VISIBILITY: property."
  3911. (interactive)
  3912. (let (state)
  3913. (save-excursion
  3914. (goto-char (point-min))
  3915. (while (re-search-forward
  3916. "^[ \t]*:VISIBILITY:[ \t]+\\([a-z]+\\)"
  3917. nil t)
  3918. (setq state (match-string 1))
  3919. (save-excursion
  3920. (org-back-to-heading t)
  3921. (hide-subtree)
  3922. (org-reveal)
  3923. (cond
  3924. ((equal state '("fold" "folded"))
  3925. (hide-subtree))
  3926. ((equal state "children")
  3927. (org-show-hidden-entry)
  3928. (show-children))
  3929. ((equal state "content")
  3930. (save-excursion
  3931. (save-restriction
  3932. (org-narrow-to-subtree)
  3933. (org-content))))
  3934. ((member state '("all" "showall"))
  3935. (show-subtree)))))
  3936. (unless no-cleanup
  3937. (org-cycle-hide-archived-subtrees 'all)
  3938. (org-cycle-hide-drawers 'all)
  3939. (org-cycle-show-empty-lines 'all)))))
  3940. (defun org-overview ()
  3941. "Switch to overview mode, showing only top-level headlines.
  3942. Really, this shows all headlines with level equal or greater than the level
  3943. of the first headline in the buffer. This is important, because if the
  3944. first headline is not level one, then (hide-sublevels 1) gives confusing
  3945. results."
  3946. (interactive)
  3947. (let ((level (save-excursion
  3948. (goto-char (point-min))
  3949. (if (re-search-forward (concat "^" outline-regexp) nil t)
  3950. (progn
  3951. (goto-char (match-beginning 0))
  3952. (funcall outline-level))))))
  3953. (and level (hide-sublevels level))))
  3954. (defun org-content (&optional arg)
  3955. "Show all headlines in the buffer, like a table of contents.
  3956. With numerical argument N, show content up to level N."
  3957. (interactive "P")
  3958. (save-excursion
  3959. ;; Visit all headings and show their offspring
  3960. (and (integerp arg) (org-overview))
  3961. (goto-char (point-max))
  3962. (catch 'exit
  3963. (while (and (progn (condition-case nil
  3964. (outline-previous-visible-heading 1)
  3965. (error (goto-char (point-min))))
  3966. t)
  3967. (looking-at outline-regexp))
  3968. (if (integerp arg)
  3969. (show-children (1- arg))
  3970. (show-branches))
  3971. (if (bobp) (throw 'exit nil))))))
  3972. (defun org-optimize-window-after-visibility-change (state)
  3973. "Adjust the window after a change in outline visibility.
  3974. This function is the default value of the hook `org-cycle-hook'."
  3975. (when (get-buffer-window (current-buffer))
  3976. (cond
  3977. ; ((eq state 'overview) (org-first-headline-recenter 1))
  3978. ; ((eq state 'overview) (org-beginning-of-line))
  3979. ((eq state 'content) nil)
  3980. ((eq state 'all) nil)
  3981. ((eq state 'folded) nil)
  3982. ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
  3983. ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
  3984. (defun org-compact-display-after-subtree-move ()
  3985. (let (beg end)
  3986. (save-excursion
  3987. (if (org-up-heading-safe)
  3988. (progn
  3989. (hide-subtree)
  3990. (show-entry)
  3991. (show-children)
  3992. (org-cycle-show-empty-lines 'children)
  3993. (org-cycle-hide-drawers 'children))
  3994. (org-overview)))))
  3995. (defun org-cycle-show-empty-lines (state)
  3996. "Show empty lines above all visible headlines.
  3997. The region to be covered depends on STATE when called through
  3998. `org-cycle-hook'. Lisp program can use t for STATE to get the
  3999. entire buffer covered. Note that an empty line is only shown if there
  4000. are at least `org-cycle-separator-lines' empty lines before the headline."
  4001. (when (> org-cycle-separator-lines 0)
  4002. (save-excursion
  4003. (let* ((n org-cycle-separator-lines)
  4004. (re (cond
  4005. ((= n 1) "\\(\n[ \t]*\n\\*+\\) ")
  4006. ((= n 2) "^[ \t]*\\(\n[ \t]*\n\\*+\\) ")
  4007. (t (let ((ns (number-to-string (- n 2))))
  4008. (concat "^\\(?:[ \t]*\n\\)\\{" ns "," ns "\\}"
  4009. "[ \t]*\\(\n[ \t]*\n\\*+\\) ")))))
  4010. beg end)
  4011. (cond
  4012. ((memq state '(overview contents t))
  4013. (setq beg (point-min) end (point-max)))
  4014. ((memq state '(children folded))
  4015. (setq beg (point) end (progn (org-end-of-subtree t t)
  4016. (beginning-of-line 2)
  4017. (point)))))
  4018. (when beg
  4019. (goto-char beg)
  4020. (while (re-search-forward re end t)
  4021. (if (not (get-char-property (match-end 1) 'invisible))
  4022. (outline-flag-region
  4023. (match-beginning 1) (match-end 1) nil)))))))
  4024. ;; Never hide empty lines at the end of the file.
  4025. (save-excursion
  4026. (goto-char (point-max))
  4027. (outline-previous-heading)
  4028. (outline-end-of-heading)
  4029. (if (and (looking-at "[ \t\n]+")
  4030. (= (match-end 0) (point-max)))
  4031. (outline-flag-region (point) (match-end 0) nil))))
  4032. (defun org-show-empty-lines-in-parent ()
  4033. "Move to the parent and re-show empty lines before visible headlines."
  4034. (save-excursion
  4035. (let ((context (if (org-up-heading-safe) 'children 'overview)))
  4036. (org-cycle-show-empty-lines context))))
  4037. (defun org-cycle-hide-drawers (state)
  4038. "Re-hide all drawers after a visibility state change."
  4039. (when (and (org-mode-p)
  4040. (not (memq state '(overview folded))))
  4041. (save-excursion
  4042. (let* ((globalp (memq state '(contents all)))
  4043. (beg (if globalp (point-min) (point)))
  4044. (end (if globalp (point-max) (org-end-of-subtree t))))
  4045. (goto-char beg)
  4046. (while (re-search-forward org-drawer-regexp end t)
  4047. (org-flag-drawer t))))))
  4048. (defun org-flag-drawer (flag)
  4049. (save-excursion
  4050. (beginning-of-line 1)
  4051. (when (looking-at "^[ \t]*:[a-zA-Z][a-zA-Z0-9]*:")
  4052. (let ((b (match-end 0))
  4053. (outline-regexp org-outline-regexp))
  4054. (if (re-search-forward
  4055. "^[ \t]*:END:"
  4056. (save-excursion (outline-next-heading) (point)) t)
  4057. (outline-flag-region b (point-at-eol) flag)
  4058. (error ":END: line missing"))))))
  4059. (defun org-subtree-end-visible-p ()
  4060. "Is the end of the current subtree visible?"
  4061. (pos-visible-in-window-p
  4062. (save-excursion (org-end-of-subtree t) (point))))
  4063. (defun org-first-headline-recenter (&optional N)
  4064. "Move cursor to the first headline and recenter the headline.
  4065. Optional argument N means, put the headline into the Nth line of the window."
  4066. (goto-char (point-min))
  4067. (when (re-search-forward (concat "^\\(" outline-regexp "\\)") nil t)
  4068. (beginning-of-line)
  4069. (recenter (prefix-numeric-value N))))
  4070. ;;; Org-goto
  4071. (defvar org-goto-window-configuration nil)
  4072. (defvar org-goto-marker nil)
  4073. (defvar org-goto-map
  4074. (let ((map (make-sparse-keymap)))
  4075. (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
  4076. (while (setq cmd (pop cmds))
  4077. (substitute-key-definition cmd cmd map global-map)))
  4078. (suppress-keymap map)
  4079. (org-defkey map "\C-m" 'org-goto-ret)
  4080. (org-defkey map [(return)] 'org-goto-ret)
  4081. (org-defkey map [(left)] 'org-goto-left)
  4082. (org-defkey map [(right)] 'org-goto-right)
  4083. (org-defkey map [(control ?g)] 'org-goto-quit)
  4084. (org-defkey map "\C-i" 'org-cycle)
  4085. (org-defkey map [(tab)] 'org-cycle)
  4086. (org-defkey map [(down)] 'outline-next-visible-heading)
  4087. (org-defkey map [(up)] 'outline-previous-visible-heading)
  4088. (if org-goto-auto-isearch
  4089. (if (fboundp 'define-key-after)
  4090. (define-key-after map [t] 'org-goto-local-auto-isearch)
  4091. nil)
  4092. (org-defkey map "q" 'org-goto-quit)
  4093. (org-defkey map "n" 'outline-next-visible-heading)
  4094. (org-defkey map "p" 'outline-previous-visible-heading)
  4095. (org-defkey map "f" 'outline-forward-same-level)
  4096. (org-defkey map "b" 'outline-backward-same-level)
  4097. (org-defkey map "u" 'outline-up-heading))
  4098. (org-defkey map "/" 'org-occur)
  4099. (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
  4100. (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
  4101. (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
  4102. (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
  4103. (org-defkey map "\C-c\C-u" 'outline-up-heading)
  4104. map))
  4105. (defconst org-goto-help
  4106. "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
  4107. RET=jump to location [Q]uit and return to previous location
  4108. \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
  4109. (defvar org-goto-start-pos) ; dynamically scoped parameter
  4110. ;; FIXME: Docstring doe not mention both interfaces
  4111. (defun org-goto (&optional alternative-interface)
  4112. "Look up a different location in the current file, keeping current visibility.
  4113. When you want look-up or go to a different location in a document, the
  4114. fastest way is often to fold the entire buffer and then dive into the tree.
  4115. This method has the disadvantage, that the previous location will be folded,
  4116. which may not be what you want.
  4117. This command works around this by showing a copy of the current buffer
  4118. in an indirect buffer, in overview mode. You can dive into the tree in
  4119. that copy, use org-occur and incremental search to find a location.
  4120. When pressing RET or `Q', the command returns to the original buffer in
  4121. which the visibility is still unchanged. After RET is will also jump to
  4122. the location selected in the indirect buffer and expose the
  4123. the headline hierarchy above."
  4124. (interactive "P")
  4125. (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
  4126. (org-refile-use-outline-path t)
  4127. (interface
  4128. (if (not alternative-interface)
  4129. org-goto-interface
  4130. (if (eq org-goto-interface 'outline)
  4131. 'outline-path-completion
  4132. 'outline)))
  4133. (org-goto-start-pos (point))
  4134. (selected-point
  4135. (if (eq interface 'outline)
  4136. (car (org-get-location (current-buffer) org-goto-help))
  4137. (nth 3 (org-refile-get-location "Goto: ")))))
  4138. (if selected-point
  4139. (progn
  4140. (org-mark-ring-push org-goto-start-pos)
  4141. (goto-char selected-point)
  4142. (if (or (org-invisible-p) (org-invisible-p2))
  4143. (org-show-context 'org-goto)))
  4144. (message "Quit"))))
  4145. (defvar org-goto-selected-point nil) ; dynamically scoped parameter
  4146. (defvar org-goto-exit-command nil) ; dynamically scoped parameter
  4147. (defvar org-goto-local-auto-isearch-map) ; defined below
  4148. (defun org-get-location (buf help)
  4149. "Let the user select a location in the Org-mode buffer BUF.
  4150. This function uses a recursive edit. It returns the selected position
  4151. or nil."
  4152. (let ((isearch-mode-map org-goto-local-auto-isearch-map)
  4153. (isearch-hide-immediately nil)
  4154. (isearch-search-fun-function
  4155. (lambda () 'org-goto-local-search-headings))
  4156. (org-goto-selected-point org-goto-exit-command))
  4157. (save-excursion
  4158. (save-window-excursion
  4159. (delete-other-windows)
  4160. (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
  4161. (switch-to-buffer
  4162. (condition-case nil
  4163. (make-indirect-buffer (current-buffer) "*org-goto*")
  4164. (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
  4165. (with-output-to-temp-buffer "*Help*"
  4166. (princ help))
  4167. (org-fit-window-to-buffer (get-buffer-window "*Help*"))
  4168. (setq buffer-read-only nil)
  4169. (let ((org-startup-truncated t)
  4170. (org-startup-folded nil)
  4171. (org-startup-align-all-tables nil))
  4172. (org-mode)
  4173. (org-overview))
  4174. (setq buffer-read-only t)
  4175. (if (and (boundp 'org-goto-start-pos)
  4176. (integer-or-marker-p org-goto-start-pos))
  4177. (let ((org-show-hierarchy-above t)
  4178. (org-show-siblings t)
  4179. (org-show-following-heading t))
  4180. (goto-char org-goto-start-pos)
  4181. (and (org-invisible-p) (org-show-context)))
  4182. (goto-char (point-min)))
  4183. (org-beginning-of-line)
  4184. (message "Select location and press RET")
  4185. (use-local-map org-goto-map)
  4186. (recursive-edit)
  4187. ))
  4188. (kill-buffer "*org-goto*")
  4189. (cons org-goto-selected-point org-goto-exit-command)))
  4190. (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
  4191. (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
  4192. (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
  4193. (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
  4194. (defun org-goto-local-search-headings (string bound noerror)
  4195. "Search and make sure that any matches are in headlines."
  4196. (catch 'return
  4197. (while (if isearch-forward
  4198. (search-forward string bound noerror)
  4199. (search-backward string bound noerror))
  4200. (when (let ((context (mapcar 'car (save-match-data (org-context)))))
  4201. (and (member :headline context)
  4202. (not (member :tags context))))
  4203. (throw 'return (point))))))
  4204. (defun org-goto-local-auto-isearch ()
  4205. "Start isearch."
  4206. (interactive)
  4207. (goto-char (point-min))
  4208. (let ((keys (this-command-keys)))
  4209. (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
  4210. (isearch-mode t)
  4211. (isearch-process-search-char (string-to-char keys)))))
  4212. (defun org-goto-ret (&optional arg)
  4213. "Finish `org-goto' by going to the new location."
  4214. (interactive "P")
  4215. (setq org-goto-selected-point (point)
  4216. org-goto-exit-command 'return)
  4217. (throw 'exit nil))
  4218. (defun org-goto-left ()
  4219. "Finish `org-goto' by going to the new location."
  4220. (interactive)
  4221. (if (org-on-heading-p)
  4222. (progn
  4223. (beginning-of-line 1)
  4224. (setq org-goto-selected-point (point)
  4225. org-goto-exit-command 'left)
  4226. (throw 'exit nil))
  4227. (error "Not on a heading")))
  4228. (defun org-goto-right ()
  4229. "Finish `org-goto' by going to the new location."
  4230. (interactive)
  4231. (if (org-on-heading-p)
  4232. (progn
  4233. (setq org-goto-selected-point (point)
  4234. org-goto-exit-command 'right)
  4235. (throw 'exit nil))
  4236. (error "Not on a heading")))
  4237. (defun org-goto-quit ()
  4238. "Finish `org-goto' without cursor motion."
  4239. (interactive)
  4240. (setq org-goto-selected-point nil)
  4241. (setq org-goto-exit-command 'quit)
  4242. (throw 'exit nil))
  4243. ;;; Indirect buffer display of subtrees
  4244. (defvar org-indirect-dedicated-frame nil
  4245. "This is the frame being used for indirect tree display.")
  4246. (defvar org-last-indirect-buffer nil)
  4247. (defun org-tree-to-indirect-buffer (&optional arg)
  4248. "Create indirect buffer and narrow it to current subtree.
  4249. With numerical prefix ARG, go up to this level and then take that tree.
  4250. If ARG is negative, go up that many levels.
  4251. If `org-indirect-buffer-display' is not `new-frame', the command removes the
  4252. indirect buffer previously made with this command, to avoid proliferation of
  4253. indirect buffers. However, when you call the command with a `C-u' prefix, or
  4254. when `org-indirect-buffer-display' is `new-frame', the last buffer
  4255. is kept so that you can work with several indirect buffers at the same time.
  4256. If `org-indirect-buffer-display' is `dedicated-frame', the C-u prefix also
  4257. requests that a new frame be made for the new buffer, so that the dedicated
  4258. frame is not changed."
  4259. (interactive "P")
  4260. (let ((cbuf (current-buffer))
  4261. (cwin (selected-window))
  4262. (pos (point))
  4263. beg end level heading ibuf)
  4264. (save-excursion
  4265. (org-back-to-heading t)
  4266. (when (numberp arg)
  4267. (setq level (org-outline-level))
  4268. (if (< arg 0) (setq arg (+ level arg)))
  4269. (while (> (setq level (org-outline-level)) arg)
  4270. (outline-up-heading 1 t)))
  4271. (setq beg (point)
  4272. heading (org-get-heading))
  4273. (org-end-of-subtree t) (setq end (point)))
  4274. (if (and (buffer-live-p org-last-indirect-buffer)
  4275. (not (eq org-indirect-buffer-display 'new-frame))
  4276. (not arg))
  4277. (kill-buffer org-last-indirect-buffer))
  4278. (setq ibuf (org-get-indirect-buffer cbuf)
  4279. org-last-indirect-buffer ibuf)
  4280. (cond
  4281. ((or (eq org-indirect-buffer-display 'new-frame)
  4282. (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
  4283. (select-frame (make-frame))
  4284. (delete-other-windows)
  4285. (switch-to-buffer ibuf)
  4286. (org-set-frame-title heading))
  4287. ((eq org-indirect-buffer-display 'dedicated-frame)
  4288. (raise-frame
  4289. (select-frame (or (and org-indirect-dedicated-frame
  4290. (frame-live-p org-indirect-dedicated-frame)
  4291. org-indirect-dedicated-frame)
  4292. (setq org-indirect-dedicated-frame (make-frame)))))
  4293. (delete-other-windows)
  4294. (switch-to-buffer ibuf)
  4295. (org-set-frame-title (concat "Indirect: " heading)))
  4296. ((eq org-indirect-buffer-display 'current-window)
  4297. (switch-to-buffer ibuf))
  4298. ((eq org-indirect-buffer-display 'other-window)
  4299. (pop-to-buffer ibuf))
  4300. (t (error "Invalid value.")))
  4301. (if (featurep 'xemacs)
  4302. (save-excursion (org-mode) (turn-on-font-lock)))
  4303. (narrow-to-region beg end)
  4304. (show-all)
  4305. (goto-char pos)
  4306. (and (window-live-p cwin) (select-window cwin))))
  4307. (defun org-get-indirect-buffer (&optional buffer)
  4308. (setq buffer (or buffer (current-buffer)))
  4309. (let ((n 1) (base (buffer-name buffer)) bname)
  4310. (while (buffer-live-p
  4311. (get-buffer (setq bname (concat base "-" (number-to-string n)))))
  4312. (setq n (1+ n)))
  4313. (condition-case nil
  4314. (make-indirect-buffer buffer bname 'clone)
  4315. (error (make-indirect-buffer buffer bname)))))
  4316. (defun org-set-frame-title (title)
  4317. "Set the title of the current frame to the string TITLE."
  4318. ;; FIXME: how to name a single frame in XEmacs???
  4319. (unless (featurep 'xemacs)
  4320. (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
  4321. ;;;; Structure editing
  4322. ;;; Inserting headlines
  4323. (defun org-insert-heading (&optional force-heading)
  4324. "Insert a new heading or item with same depth at point.
  4325. If point is in a plain list and FORCE-HEADING is nil, create a new list item.
  4326. If point is at the beginning of a headline, insert a sibling before the
  4327. current headline. If point is not at the beginning, do not split the line,
  4328. but create the new headline after the current line."
  4329. (interactive "P")
  4330. (if (= (buffer-size) 0)
  4331. (insert "\n* ")
  4332. (when (or force-heading (not (org-insert-item)))
  4333. (let* ((head (save-excursion
  4334. (condition-case nil
  4335. (progn
  4336. (org-back-to-heading)
  4337. (match-string 0))
  4338. (error "*"))))
  4339. (blank (cdr (assq 'heading org-blank-before-new-entry)))
  4340. pos hide-previous previous-pos)
  4341. (cond
  4342. ((and (org-on-heading-p) (bolp)
  4343. (or (bobp)
  4344. (save-excursion (backward-char 1) (not (org-invisible-p)))))
  4345. ;; insert before the current line
  4346. (open-line (if blank 2 1)))
  4347. ((and (bolp)
  4348. (or (bobp)
  4349. (save-excursion
  4350. (backward-char 1) (not (org-invisible-p)))))
  4351. ;; insert right here
  4352. nil)
  4353. (t
  4354. ;; somewhere in the line
  4355. (save-excursion
  4356. (setq previous-pos (point-at-bol))
  4357. (end-of-line)
  4358. (setq hide-previous (org-invisible-p)))
  4359. (and org-insert-heading-respect-content (org-show-subtree))
  4360. (let ((split
  4361. (and (org-get-alist-option org-M-RET-may-split-line 'headline)
  4362. (save-excursion
  4363. (let ((p (point)))
  4364. (goto-char (point-at-bol))
  4365. (and (looking-at org-complex-heading-regexp)
  4366. (> p (match-beginning 4)))))))
  4367. tags pos)
  4368. (cond
  4369. (org-insert-heading-respect-content
  4370. (org-end-of-subtree nil t)
  4371. (or (bolp) (newline))
  4372. (open-line 1))
  4373. ((org-on-heading-p)
  4374. (when hide-previous
  4375. (show-children)
  4376. (org-show-entry))
  4377. (looking-at ".*?\\([ \t]+\\(:[[:alnum:]_@:]+:\\)\\)?[ \t]*$")
  4378. (setq tags (and (match-end 2) (match-string 2)))
  4379. (and (match-end 1)
  4380. (delete-region (match-beginning 1) (match-end 1)))
  4381. (setq pos (point-at-bol))
  4382. (or split (end-of-line 1))
  4383. (delete-horizontal-space)
  4384. (newline (if blank 2 1))
  4385. (when tags
  4386. (save-excursion
  4387. (goto-char pos)
  4388. (end-of-line 1)
  4389. (insert " " tags)
  4390. (org-set-tags nil 'align))))
  4391. (t
  4392. (or split (end-of-line 1))
  4393. (newline (if blank 2 1)))))))
  4394. (insert head) (just-one-space)
  4395. (setq pos (point))
  4396. (end-of-line 1)
  4397. (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
  4398. (when (and org-insert-heading-respect-content hide-previous)
  4399. (save-excursion
  4400. (goto-char previous-pos)
  4401. (hide-subtree)))
  4402. (run-hooks 'org-insert-heading-hook)))))
  4403. (defun org-get-heading (&optional no-tags)
  4404. "Return the heading of the current entry, without the stars."
  4405. (save-excursion
  4406. (org-back-to-heading t)
  4407. (if (looking-at
  4408. (if no-tags
  4409. (org-re "\\*+[ \t]+\\([^\n\r]*?\\)\\([ \t]+:[[:alnum:]:_@]+:[ \t]*\\)?$")
  4410. "\\*+[ \t]+\\([^\r\n]*\\)"))
  4411. (match-string 1) "")))
  4412. (defun org-insert-heading-after-current ()
  4413. "Insert a new heading with same level as current, after current subtree."
  4414. (interactive)
  4415. (org-back-to-heading)
  4416. (org-insert-heading)
  4417. (org-move-subtree-down)
  4418. (end-of-line 1))
  4419. (defun org-insert-heading-respect-content ()
  4420. (interactive)
  4421. (let ((org-insert-heading-respect-content t))
  4422. (org-insert-heading t)))
  4423. (defun org-insert-todo-heading-respect-content (&optional force-state)
  4424. (interactive "P")
  4425. (let ((org-insert-heading-respect-content t))
  4426. (org-insert-todo-heading force-state t)))
  4427. (defun org-insert-todo-heading (arg &optional force-heading)
  4428. "Insert a new heading with the same level and TODO state as current heading.
  4429. If the heading has no TODO state, or if the state is DONE, use the first
  4430. state (TODO by default). Also with prefix arg, force first state."
  4431. (interactive "P")
  4432. (when (or force-heading (not (org-insert-item 'checkbox)))
  4433. (org-insert-heading force-heading)
  4434. (save-excursion
  4435. (org-back-to-heading)
  4436. (outline-previous-heading)
  4437. (looking-at org-todo-line-regexp))
  4438. (if (or arg
  4439. (not (match-beginning 2))
  4440. (member (match-string 2) org-done-keywords))
  4441. (insert (car org-todo-keywords-1) " ")
  4442. (insert (match-string 2) " "))
  4443. (when org-provide-todo-statistics
  4444. (org-update-parent-todo-statistics))))
  4445. (defun org-insert-subheading (arg)
  4446. "Insert a new subheading and demote it.
  4447. Works for outline headings and for plain lists alike."
  4448. (interactive "P")
  4449. (org-insert-heading arg)
  4450. (cond
  4451. ((org-on-heading-p) (org-do-demote))
  4452. ((org-at-item-p) (org-indent-item 1))))
  4453. (defun org-insert-todo-subheading (arg)
  4454. "Insert a new subheading with TODO keyword or checkbox and demote it.
  4455. Works for outline headings and for plain lists alike."
  4456. (interactive "P")
  4457. (org-insert-todo-heading arg)
  4458. (cond
  4459. ((org-on-heading-p) (org-do-demote))
  4460. ((org-at-item-p) (org-indent-item 1))))
  4461. ;;; Promotion and Demotion
  4462. (defun org-promote-subtree ()
  4463. "Promote the entire subtree.
  4464. See also `org-promote'."
  4465. (interactive)
  4466. (save-excursion
  4467. (org-map-tree 'org-promote))
  4468. (org-fix-position-after-promote))
  4469. (defun org-demote-subtree ()
  4470. "Demote the entire subtree. See `org-demote'.
  4471. See also `org-promote'."
  4472. (interactive)
  4473. (save-excursion
  4474. (org-map-tree 'org-demote))
  4475. (org-fix-position-after-promote))
  4476. (defun org-do-promote ()
  4477. "Promote the current heading higher up the tree.
  4478. If the region is active in `transient-mark-mode', promote all headings
  4479. in the region."
  4480. (interactive)
  4481. (save-excursion
  4482. (if (org-region-active-p)
  4483. (org-map-region 'org-promote (region-beginning) (region-end))
  4484. (org-promote)))
  4485. (org-fix-position-after-promote))
  4486. (defun org-do-demote ()
  4487. "Demote the current heading lower down the tree.
  4488. If the region is active in `transient-mark-mode', demote all headings
  4489. in the region."
  4490. (interactive)
  4491. (save-excursion
  4492. (if (org-region-active-p)
  4493. (org-map-region 'org-demote (region-beginning) (region-end))
  4494. (org-demote)))
  4495. (org-fix-position-after-promote))
  4496. (defun org-fix-position-after-promote ()
  4497. "Make sure that after pro/demotion cursor position is right."
  4498. (let ((pos (point)))
  4499. (when (save-excursion
  4500. (beginning-of-line 1)
  4501. (looking-at org-todo-line-regexp)
  4502. (or (equal pos (match-end 1)) (equal pos (match-end 2))))
  4503. (cond ((eobp) (insert " "))
  4504. ((eolp) (insert " "))
  4505. ((equal (char-after) ?\ ) (forward-char 1))))))
  4506. (defun org-reduced-level (l)
  4507. (if org-odd-levels-only (1+ (floor (/ l 2))) l))
  4508. (defun org-get-valid-level (level &optional change)
  4509. "Rectify a level change under the influence of `org-odd-levels-only'
  4510. LEVEL is a current level, CHANGE is by how much the level should be
  4511. modified. Even if CHANGE is nil, LEVEL may be returned modified because
  4512. even level numbers will become the next higher odd number."
  4513. (if org-odd-levels-only
  4514. (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
  4515. ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
  4516. ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
  4517. (max 1 (+ level change))))
  4518. (if (boundp 'define-obsolete-function-alias)
  4519. (if (or (featurep 'xemacs) (< emacs-major-version 23))
  4520. (define-obsolete-function-alias 'org-get-legal-level
  4521. 'org-get-valid-level)
  4522. (define-obsolete-function-alias 'org-get-legal-level
  4523. 'org-get-valid-level "23.1")))
  4524. (defun org-promote ()
  4525. "Promote the current heading higher up the tree.
  4526. If the region is active in `transient-mark-mode', promote all headings
  4527. in the region."
  4528. (org-back-to-heading t)
  4529. (let* ((level (save-match-data (funcall outline-level)))
  4530. (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
  4531. (diff (abs (- level (length up-head) -1))))
  4532. (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
  4533. (replace-match up-head nil t)
  4534. ;; Fixup tag positioning
  4535. (and org-auto-align-tags (org-set-tags nil t))
  4536. (if org-adapt-indentation (org-fixup-indentation (- diff)))))
  4537. (defun org-demote ()
  4538. "Demote the current heading lower down the tree.
  4539. If the region is active in `transient-mark-mode', demote all headings
  4540. in the region."
  4541. (org-back-to-heading t)
  4542. (let* ((level (save-match-data (funcall outline-level)))
  4543. (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
  4544. (diff (abs (- level (length down-head) -1))))
  4545. (replace-match down-head nil t)
  4546. ;; Fixup tag positioning
  4547. (and org-auto-align-tags (org-set-tags nil t))
  4548. (if org-adapt-indentation (org-fixup-indentation diff))))
  4549. (defun org-map-tree (fun)
  4550. "Call FUN for every heading underneath the current one."
  4551. (org-back-to-heading)
  4552. (let ((level (funcall outline-level)))
  4553. (save-excursion
  4554. (funcall fun)
  4555. (while (and (progn
  4556. (outline-next-heading)
  4557. (> (funcall outline-level) level))
  4558. (not (eobp)))
  4559. (funcall fun)))))
  4560. (defun org-map-region (fun beg end)
  4561. "Call FUN for every heading between BEG and END."
  4562. (let ((org-ignore-region t))
  4563. (save-excursion
  4564. (setq end (copy-marker end))
  4565. (goto-char beg)
  4566. (if (and (re-search-forward (concat "^" outline-regexp) nil t)
  4567. (< (point) end))
  4568. (funcall fun))
  4569. (while (and (progn
  4570. (outline-next-heading)
  4571. (< (point) end))
  4572. (not (eobp)))
  4573. (funcall fun)))))
  4574. (defun org-fixup-indentation (diff)
  4575. "Change the indentation in the current entry by DIFF
  4576. However, if any line in the current entry has no indentation, or if it
  4577. would end up with no indentation after the change, nothing at all is done."
  4578. (save-excursion
  4579. (let ((end (save-excursion (outline-next-heading)
  4580. (point-marker)))
  4581. (prohibit (if (> diff 0)
  4582. "^\\S-"
  4583. (concat "^ \\{0," (int-to-string (- diff)) "\\}\\S-")))
  4584. col)
  4585. (unless (save-excursion (end-of-line 1)
  4586. (re-search-forward prohibit end t))
  4587. (while (and (< (point) end)
  4588. (re-search-forward "^[ \t]+" end t))
  4589. (goto-char (match-end 0))
  4590. (setq col (current-column))
  4591. (if (< diff 0) (replace-match ""))
  4592. (org-indent-to-column (+ diff col))))
  4593. (move-marker end nil))))
  4594. (defun org-convert-to-odd-levels ()
  4595. "Convert an org-mode file with all levels allowed to one with odd levels.
  4596. This will leave level 1 alone, convert level 2 to level 3, level 3 to
  4597. level 5 etc."
  4598. (interactive)
  4599. (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
  4600. (let ((org-odd-levels-only nil) n)
  4601. (save-excursion
  4602. (goto-char (point-min))
  4603. (while (re-search-forward "^\\*\\*+ " nil t)
  4604. (setq n (- (length (match-string 0)) 2))
  4605. (while (>= (setq n (1- n)) 0)
  4606. (org-demote))
  4607. (end-of-line 1))))))
  4608. (defun org-convert-to-oddeven-levels ()
  4609. "Convert an org-mode file with only odd levels to one with odd and even levels.
  4610. This promotes level 3 to level 2, level 5 to level 3 etc. If the file contains a
  4611. section with an even level, conversion would destroy the structure of the file. An error
  4612. is signaled in this case."
  4613. (interactive)
  4614. (goto-char (point-min))
  4615. ;; First check if there are no even levels
  4616. (when (re-search-forward "^\\(\\*\\*\\)+ " nil t)
  4617. (org-show-context t)
  4618. (error "Not all levels are odd in this file. Conversion not possible."))
  4619. (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
  4620. (let ((org-odd-levels-only nil) n)
  4621. (save-excursion
  4622. (goto-char (point-min))
  4623. (while (re-search-forward "^\\*\\*+ " nil t)
  4624. (setq n (/ (1- (length (match-string 0))) 2))
  4625. (while (>= (setq n (1- n)) 0)
  4626. (org-promote))
  4627. (end-of-line 1))))))
  4628. (defun org-tr-level (n)
  4629. "Make N odd if required."
  4630. (if org-odd-levels-only (1+ (/ n 2)) n))
  4631. ;;; Vertical tree motion, cutting and pasting of subtrees
  4632. (defun org-move-subtree-up (&optional arg)
  4633. "Move the current subtree up past ARG headlines of the same level."
  4634. (interactive "p")
  4635. (org-move-subtree-down (- (prefix-numeric-value arg))))
  4636. (defun org-move-subtree-down (&optional arg)
  4637. "Move the current subtree down past ARG headlines of the same level."
  4638. (interactive "p")
  4639. (setq arg (prefix-numeric-value arg))
  4640. (let ((movfunc (if (> arg 0) 'outline-get-next-sibling
  4641. 'outline-get-last-sibling))
  4642. (ins-point (make-marker))
  4643. (cnt (abs arg))
  4644. beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
  4645. ;; Select the tree
  4646. (org-back-to-heading)
  4647. (setq beg0 (point))
  4648. (save-excursion
  4649. (setq ne-beg (org-back-over-empty-lines))
  4650. (setq beg (point)))
  4651. (save-match-data
  4652. (save-excursion (outline-end-of-heading)
  4653. (setq folded (org-invisible-p)))
  4654. (outline-end-of-subtree))
  4655. (outline-next-heading)
  4656. (setq ne-end (org-back-over-empty-lines))
  4657. (setq end (point))
  4658. (goto-char beg0)
  4659. (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
  4660. ;; include less whitespace
  4661. (save-excursion
  4662. (goto-char beg)
  4663. (forward-line (- ne-beg ne-end))
  4664. (setq beg (point))))
  4665. ;; Find insertion point, with error handling
  4666. (while (> cnt 0)
  4667. (or (and (funcall movfunc) (looking-at outline-regexp))
  4668. (progn (goto-char beg0)
  4669. (error "Cannot move past superior level or buffer limit")))
  4670. (setq cnt (1- cnt)))
  4671. (if (> arg 0)
  4672. ;; Moving forward - still need to move over subtree
  4673. (progn (org-end-of-subtree t t)
  4674. (save-excursion
  4675. (org-back-over-empty-lines)
  4676. (or (bolp) (newline)))))
  4677. (setq ne-ins (org-back-over-empty-lines))
  4678. (move-marker ins-point (point))
  4679. (setq txt (buffer-substring beg end))
  4680. (org-save-markers-in-region beg end)
  4681. (delete-region beg end)
  4682. (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
  4683. (or (bobp) (outline-flag-region (1- (point)) (point) nil))
  4684. (let ((bbb (point)))
  4685. (insert-before-markers txt)
  4686. (org-reinstall-markers-in-region bbb)
  4687. (move-marker ins-point bbb))
  4688. (or (bolp) (insert "\n"))
  4689. (setq ins-end (point))
  4690. (goto-char ins-point)
  4691. (org-skip-whitespace)
  4692. (when (and (< arg 0)
  4693. (org-first-sibling-p)
  4694. (> ne-ins ne-beg))
  4695. ;; Move whitespace back to beginning
  4696. (save-excursion
  4697. (goto-char ins-end)
  4698. (let ((kill-whole-line t))
  4699. (kill-line (- ne-ins ne-beg)) (point)))
  4700. (insert (make-string (- ne-ins ne-beg) ?\n)))
  4701. (move-marker ins-point nil)
  4702. (org-compact-display-after-subtree-move)
  4703. (org-show-empty-lines-in-parent)
  4704. (unless folded
  4705. (org-show-entry)
  4706. (show-children)
  4707. (org-cycle-hide-drawers 'children))))
  4708. (defvar org-subtree-clip ""
  4709. "Clipboard for cut and paste of subtrees.
  4710. This is actually only a copy of the kill, because we use the normal kill
  4711. ring. We need it to check if the kill was created by `org-copy-subtree'.")
  4712. (defvar org-subtree-clip-folded nil
  4713. "Was the last copied subtree folded?
  4714. This is used to fold the tree back after pasting.")
  4715. (defun org-cut-subtree (&optional n)
  4716. "Cut the current subtree into the clipboard.
  4717. With prefix arg N, cut this many sequential subtrees.
  4718. This is a short-hand for marking the subtree and then cutting it."
  4719. (interactive "p")
  4720. (org-copy-subtree n 'cut))
  4721. (defun org-copy-subtree (&optional n cut force-store-markers)
  4722. "Cut the current subtree into the clipboard.
  4723. With prefix arg N, cut this many sequential subtrees.
  4724. This is a short-hand for marking the subtree and then copying it.
  4725. If CUT is non-nil, actually cut the subtree.
  4726. If FORCE-STORE-MARKERS is non-nil, store the relative locations
  4727. of some markers in the region, even if CUT is non-nil. This is
  4728. useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
  4729. (interactive "p")
  4730. (let (beg end folded (beg0 (point)))
  4731. (if (interactive-p)
  4732. (org-back-to-heading nil) ; take what looks like a subtree
  4733. (org-back-to-heading t)) ; take what is really there
  4734. (org-back-over-empty-lines)
  4735. (setq beg (point))
  4736. (skip-chars-forward " \t\r\n")
  4737. (save-match-data
  4738. (save-excursion (outline-end-of-heading)
  4739. (setq folded (org-invisible-p)))
  4740. (condition-case nil
  4741. (outline-forward-same-level (1- n))
  4742. (error nil))
  4743. (org-end-of-subtree t t))
  4744. (org-back-over-empty-lines)
  4745. (setq end (point))
  4746. (goto-char beg0)
  4747. (when (> end beg)
  4748. (setq org-subtree-clip-folded folded)
  4749. (when (or cut force-store-markers)
  4750. (org-save-markers-in-region beg end))
  4751. (if cut (kill-region beg end) (copy-region-as-kill beg end))
  4752. (setq org-subtree-clip (current-kill 0))
  4753. (message "%s: Subtree(s) with %d characters"
  4754. (if cut "Cut" "Copied")
  4755. (length org-subtree-clip)))))
  4756. (defun org-paste-subtree (&optional level tree for-yank)
  4757. "Paste the clipboard as a subtree, with modification of headline level.
  4758. The entire subtree is promoted or demoted in order to match a new headline
  4759. level.
  4760. If the cursor is at the beginning of a headline, the same level as
  4761. that headline is used to paste the tree
  4762. If not, the new level is derived from the *visible* headings
  4763. before and after the insertion point, and taken to be the inferior headline
  4764. level of the two. So if the previous visible heading is level 3 and the
  4765. next is level 4 (or vice versa), level 4 will be used for insertion.
  4766. This makes sure that the subtree remains an independent subtree and does
  4767. not swallow low level entries.
  4768. You can also force a different level, either by using a numeric prefix
  4769. argument, or by inserting the heading marker by hand. For example, if the
  4770. cursor is after \"*****\", then the tree will be shifted to level 5.
  4771. If optional TREE is given, use this text instead of the kill ring.
  4772. When FOR-YANK is set, this is called by `org-yank'. In this case, do not
  4773. move back over whitespace before inserting, and move point to the end of
  4774. the inserted text when done."
  4775. (interactive "P")
  4776. (unless (org-kill-is-subtree-p tree)
  4777. (error "%s"
  4778. (substitute-command-keys
  4779. "The kill is not a (set of) tree(s) - please use \\[yank] to yank anyway")))
  4780. (let* ((visp (not (org-invisible-p)))
  4781. (txt (or tree (and kill-ring (current-kill 0))))
  4782. (^re (concat "^\\(" outline-regexp "\\)"))
  4783. (re (concat "\\(" outline-regexp "\\)"))
  4784. (^re_ (concat "\\(\\*+\\)[ \t]*"))
  4785. (old-level (if (string-match ^re txt)
  4786. (- (match-end 0) (match-beginning 0) 1)
  4787. -1))
  4788. (force-level (cond (level (prefix-numeric-value level))
  4789. ((and (looking-at "[ \t]*$")
  4790. (string-match
  4791. ^re_ (buffer-substring
  4792. (point-at-bol) (point))))
  4793. (- (match-end 1) (match-beginning 1)))
  4794. ((and (bolp)
  4795. (looking-at org-outline-regexp))
  4796. (- (match-end 0) (point) 1))
  4797. (t nil)))
  4798. (previous-level (save-excursion
  4799. (condition-case nil
  4800. (progn
  4801. (outline-previous-visible-heading 1)
  4802. (if (looking-at re)
  4803. (- (match-end 0) (match-beginning 0) 1)
  4804. 1))
  4805. (error 1))))
  4806. (next-level (save-excursion
  4807. (condition-case nil
  4808. (progn
  4809. (or (looking-at outline-regexp)
  4810. (outline-next-visible-heading 1))
  4811. (if (looking-at re)
  4812. (- (match-end 0) (match-beginning 0) 1)
  4813. 1))
  4814. (error 1))))
  4815. (new-level (or force-level (max previous-level next-level)))
  4816. (shift (if (or (= old-level -1)
  4817. (= new-level -1)
  4818. (= old-level new-level))
  4819. 0
  4820. (- new-level old-level)))
  4821. (delta (if (> shift 0) -1 1))
  4822. (func (if (> shift 0) 'org-demote 'org-promote))
  4823. (org-odd-levels-only nil)
  4824. beg end newend)
  4825. ;; Remove the forced level indicator
  4826. (if force-level
  4827. (delete-region (point-at-bol) (point)))
  4828. ;; Paste
  4829. (beginning-of-line 1)
  4830. (unless for-yank (org-back-over-empty-lines))
  4831. (setq beg (point))
  4832. (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
  4833. (insert-before-markers txt)
  4834. (unless (string-match "\n\\'" txt) (insert "\n"))
  4835. (setq newend (point))
  4836. (org-reinstall-markers-in-region beg)
  4837. (setq end (point))
  4838. (goto-char beg)
  4839. (skip-chars-forward " \t\n\r")
  4840. (setq beg (point))
  4841. (if (and (org-invisible-p) visp)
  4842. (save-excursion (outline-show-heading)))
  4843. ;; Shift if necessary
  4844. (unless (= shift 0)
  4845. (save-restriction
  4846. (narrow-to-region beg end)
  4847. (while (not (= shift 0))
  4848. (org-map-region func (point-min) (point-max))
  4849. (setq shift (+ delta shift)))
  4850. (goto-char (point-min))
  4851. (setq newend (point-max))))
  4852. (when (or (interactive-p) for-yank)
  4853. (message "Clipboard pasted as level %d subtree" new-level))
  4854. (if (and (not for-yank) ; in this case, org-yank will decide about folding
  4855. kill-ring
  4856. (eq org-subtree-clip (current-kill 0))
  4857. org-subtree-clip-folded)
  4858. ;; The tree was folded before it was killed/copied
  4859. (hide-subtree))
  4860. (and for-yank (goto-char newend))))
  4861. (defun org-kill-is-subtree-p (&optional txt)
  4862. "Check if the current kill is an outline subtree, or a set of trees.
  4863. Returns nil if kill does not start with a headline, or if the first
  4864. headline level is not the largest headline level in the tree.
  4865. So this will actually accept several entries of equal levels as well,
  4866. which is OK for `org-paste-subtree'.
  4867. If optional TXT is given, check this string instead of the current kill."
  4868. (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
  4869. (start-level (and kill
  4870. (string-match (concat "\\`\\([ \t\n\r]*?\n\\)?\\("
  4871. org-outline-regexp "\\)")
  4872. kill)
  4873. (- (match-end 2) (match-beginning 2) 1)))
  4874. (re (concat "^" org-outline-regexp))
  4875. (start (1+ (or (match-beginning 2) -1))))
  4876. (if (not start-level)
  4877. (progn
  4878. nil) ;; does not even start with a heading
  4879. (catch 'exit
  4880. (while (setq start (string-match re kill (1+ start)))
  4881. (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
  4882. (throw 'exit nil)))
  4883. t))))
  4884. (defvar org-markers-to-move nil
  4885. "Markers that should be moved with a cut-and-paste operation.
  4886. Those markers are stored together with their positions relative to
  4887. the start of the region.")
  4888. (defun org-save-markers-in-region (beg end)
  4889. "Check markers in region.
  4890. If these markers are between BEG and END, record their position relative
  4891. to BEG, so that after moving the block of text, we can put the markers back
  4892. into place.
  4893. This function gets called just before an entry or tree gets cut from the
  4894. buffer. After re-insertion, `org-reinstall-markers-in-region' must be
  4895. called immediately, to move the markers with the entries."
  4896. (setq org-markers-to-move nil)
  4897. (when (featurep 'org-clock)
  4898. (org-clock-save-markers-for-cut-and-paste beg end))
  4899. (when (featurep 'org-agenda)
  4900. (org-agenda-save-markers-for-cut-and-paste beg end)))
  4901. (defun org-check-and-save-marker (marker beg end)
  4902. "Check if MARKER is between BEG and END.
  4903. If yes, remember the marker and the distance to BEG."
  4904. (when (and (marker-buffer marker)
  4905. (equal (marker-buffer marker) (current-buffer)))
  4906. (if (and (>= marker beg) (< marker end))
  4907. (push (cons marker (- marker beg)) org-markers-to-move))))
  4908. (defun org-reinstall-markers-in-region (beg)
  4909. "Move all remembered markers to their position relative to BEG."
  4910. (mapc (lambda (x)
  4911. (move-marker (car x) (+ beg (cdr x))))
  4912. org-markers-to-move)
  4913. (setq org-markers-to-move nil))
  4914. (defun org-narrow-to-subtree ()
  4915. "Narrow buffer to the current subtree."
  4916. (interactive)
  4917. (save-excursion
  4918. (save-match-data
  4919. (narrow-to-region
  4920. (progn (org-back-to-heading) (point))
  4921. (progn (org-end-of-subtree t) (point))))))
  4922. ;;; Outline Sorting
  4923. (defun org-sort (with-case)
  4924. "Call `org-sort-entries-or-items' or `org-table-sort-lines'.
  4925. Optional argument WITH-CASE means sort case-sensitively."
  4926. (interactive "P")
  4927. (if (org-at-table-p)
  4928. (org-call-with-arg 'org-table-sort-lines with-case)
  4929. (org-call-with-arg 'org-sort-entries-or-items with-case)))
  4930. (defun org-sort-remove-invisible (s)
  4931. (remove-text-properties 0 (length s) org-rm-props s)
  4932. (while (string-match org-bracket-link-regexp s)
  4933. (setq s (replace-match (if (match-end 2)
  4934. (match-string 3 s)
  4935. (match-string 1 s)) t t s)))
  4936. s)
  4937. (defvar org-priority-regexp) ; defined later in the file
  4938. (defun org-sort-entries-or-items
  4939. (&optional with-case sorting-type getkey-func compare-func property)
  4940. "Sort entries on a certain level of an outline tree.
  4941. If there is an active region, the entries in the region are sorted.
  4942. Else, if the cursor is before the first entry, sort the top-level items.
  4943. Else, the children of the entry at point are sorted.
  4944. Sorting can be alphabetically, numerically, and by date/time as given by
  4945. the first time stamp in the entry. The command prompts for the sorting
  4946. type unless it has been given to the function through the SORTING-TYPE
  4947. argument, which needs to a character, any of (?n ?N ?a ?A ?t ?T ?p ?P ?f ?F).
  4948. If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
  4949. called with point at the beginning of the record. It must return either
  4950. a string or a number that should serve as the sorting key for that record.
  4951. Comparing entries ignores case by default. However, with an optional argument
  4952. WITH-CASE, the sorting considers case as well."
  4953. (interactive "P")
  4954. (let ((case-func (if with-case 'identity 'downcase))
  4955. start beg end stars re re2
  4956. txt what tmp plain-list-p)
  4957. ;; Find beginning and end of region to sort
  4958. (cond
  4959. ((org-region-active-p)
  4960. ;; we will sort the region
  4961. (setq end (region-end)
  4962. what "region")
  4963. (goto-char (region-beginning))
  4964. (if (not (org-on-heading-p)) (outline-next-heading))
  4965. (setq start (point)))
  4966. ((org-at-item-p)
  4967. ;; we will sort this plain list
  4968. (org-beginning-of-item-list) (setq start (point))
  4969. (org-end-of-item-list) (setq end (point))
  4970. (goto-char start)
  4971. (setq plain-list-p t
  4972. what "plain list"))
  4973. ((or (org-on-heading-p)
  4974. (condition-case nil (progn (org-back-to-heading) t) (error nil)))
  4975. ;; we will sort the children of the current headline
  4976. (org-back-to-heading)
  4977. (setq start (point)
  4978. end (progn (org-end-of-subtree t t)
  4979. (org-back-over-empty-lines)
  4980. (point))
  4981. what "children")
  4982. (goto-char start)
  4983. (show-subtree)
  4984. (outline-next-heading))
  4985. (t
  4986. ;; we will sort the top-level entries in this file
  4987. (goto-char (point-min))
  4988. (or (org-on-heading-p) (outline-next-heading))
  4989. (setq start (point) end (point-max) what "top-level")
  4990. (goto-char start)
  4991. (show-all)))
  4992. (setq beg (point))
  4993. (if (>= beg end) (error "Nothing to sort"))
  4994. (unless plain-list-p
  4995. (looking-at "\\(\\*+\\)")
  4996. (setq stars (match-string 1)
  4997. re (concat "^" (regexp-quote stars) " +")
  4998. re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[^*]")
  4999. txt (buffer-substring beg end))
  5000. (if (not (equal (substring txt -1) "\n")) (setq txt (concat txt "\n")))
  5001. (if (and (not (equal stars "*")) (string-match re2 txt))
  5002. (error "Region to sort contains a level above the first entry")))
  5003. (unless sorting-type
  5004. (message
  5005. (if plain-list-p
  5006. "Sort %s: [a]lpha [n]umeric [t]ime [f]unc A/N/T/F means reversed:"
  5007. "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:")
  5008. what)
  5009. (setq sorting-type (read-char-exclusive))
  5010. (and (= (downcase sorting-type) ?f)
  5011. (setq getkey-func
  5012. (org-ido-completing-read "Sort using function: "
  5013. obarray 'fboundp t nil nil))
  5014. (setq getkey-func (intern getkey-func)))
  5015. (and (= (downcase sorting-type) ?r)
  5016. (setq property
  5017. (org-ido-completing-read "Property: "
  5018. (mapcar 'list (org-buffer-property-keys t))
  5019. nil t))))
  5020. (message "Sorting entries...")
  5021. (save-restriction
  5022. (narrow-to-region start end)
  5023. (let ((dcst (downcase sorting-type))
  5024. (now (current-time)))
  5025. (sort-subr
  5026. (/= dcst sorting-type)
  5027. ;; This function moves to the beginning character of the "record" to
  5028. ;; be sorted.
  5029. (if plain-list-p
  5030. (lambda nil
  5031. (if (org-at-item-p) t (goto-char (point-max))))
  5032. (lambda nil
  5033. (if (re-search-forward re nil t)
  5034. (goto-char (match-beginning 0))
  5035. (goto-char (point-max)))))
  5036. ;; This function moves to the last character of the "record" being
  5037. ;; sorted.
  5038. (if plain-list-p
  5039. 'org-end-of-item
  5040. (lambda nil
  5041. (save-match-data
  5042. (condition-case nil
  5043. (outline-forward-same-level 1)
  5044. (error
  5045. (goto-char (point-max)))))))
  5046. ;; This function returns the value that gets sorted against.
  5047. (if plain-list-p
  5048. (lambda nil
  5049. (when (looking-at "[ \t]*[-+*0-9.)]+[ \t]+")
  5050. (cond
  5051. ((= dcst ?n)
  5052. (string-to-number (buffer-substring (match-end 0)
  5053. (point-at-eol))))
  5054. ((= dcst ?a)
  5055. (buffer-substring (match-end 0) (point-at-eol)))
  5056. ((= dcst ?t)
  5057. (if (re-search-forward org-ts-regexp
  5058. (point-at-eol) t)
  5059. (org-time-string-to-time (match-string 0))
  5060. now))
  5061. ((= dcst ?f)
  5062. (if getkey-func
  5063. (progn
  5064. (setq tmp (funcall getkey-func))
  5065. (if (stringp tmp) (setq tmp (funcall case-func tmp)))
  5066. tmp)
  5067. (error "Invalid key function `%s'" getkey-func)))
  5068. (t (error "Invalid sorting type `%c'" sorting-type)))))
  5069. (lambda nil
  5070. (cond
  5071. ((= dcst ?n)
  5072. (if (looking-at org-complex-heading-regexp)
  5073. (string-to-number (match-string 4))
  5074. nil))
  5075. ((= dcst ?a)
  5076. (if (looking-at org-complex-heading-regexp)
  5077. (funcall case-func (match-string 4))
  5078. nil))
  5079. ((= dcst ?t)
  5080. (if (re-search-forward org-ts-regexp
  5081. (save-excursion
  5082. (forward-line 2)
  5083. (point)) t)
  5084. (org-time-string-to-time (match-string 0))
  5085. now))
  5086. ((= dcst ?p)
  5087. (if (re-search-forward org-priority-regexp (point-at-eol) t)
  5088. (string-to-char (match-string 2))
  5089. org-default-priority))
  5090. ((= dcst ?r)
  5091. (or (org-entry-get nil property) ""))
  5092. ((= dcst ?o)
  5093. (if (looking-at org-complex-heading-regexp)
  5094. (- 9999 (length (member (match-string 2)
  5095. org-todo-keywords-1)))))
  5096. ((= dcst ?f)
  5097. (if getkey-func
  5098. (progn
  5099. (setq tmp (funcall getkey-func))
  5100. (if (stringp tmp) (setq tmp (funcall case-func tmp)))
  5101. tmp)
  5102. (error "Invalid key function `%s'" getkey-func)))
  5103. (t (error "Invalid sorting type `%c'" sorting-type)))))
  5104. nil
  5105. (cond
  5106. ((= dcst ?a) 'string<)
  5107. ((= dcst ?t) 'time-less-p)
  5108. ((= dcst ?f) compare-func)
  5109. (t nil)))))
  5110. (message "Sorting entries...done")))
  5111. (defun org-do-sort (table what &optional with-case sorting-type)
  5112. "Sort TABLE of WHAT according to SORTING-TYPE.
  5113. The user will be prompted for the SORTING-TYPE if the call to this
  5114. function does not specify it. WHAT is only for the prompt, to indicate
  5115. what is being sorted. The sorting key will be extracted from
  5116. the car of the elements of the table.
  5117. If WITH-CASE is non-nil, the sorting will be case-sensitive."
  5118. (unless sorting-type
  5119. (message
  5120. "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
  5121. what)
  5122. (setq sorting-type (read-char-exclusive)))
  5123. (let ((dcst (downcase sorting-type))
  5124. extractfun comparefun)
  5125. ;; Define the appropriate functions
  5126. (cond
  5127. ((= dcst ?n)
  5128. (setq extractfun 'string-to-number
  5129. comparefun (if (= dcst sorting-type) '< '>)))
  5130. ((= dcst ?a)
  5131. (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
  5132. (lambda(x) (downcase (org-sort-remove-invisible x))))
  5133. comparefun (if (= dcst sorting-type)
  5134. 'string<
  5135. (lambda (a b) (and (not (string< a b))
  5136. (not (string= a b)))))))
  5137. ((= dcst ?t)
  5138. (setq extractfun
  5139. (lambda (x)
  5140. (if (string-match org-ts-regexp x)
  5141. (time-to-seconds
  5142. (org-time-string-to-time (match-string 0 x)))
  5143. 0))
  5144. comparefun (if (= dcst sorting-type) '< '>)))
  5145. (t (error "Invalid sorting type `%c'" sorting-type)))
  5146. (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
  5147. table)
  5148. (lambda (a b) (funcall comparefun (car a) (car b))))))
  5149. ;;; Editing source examples
  5150. (defvar org-exit-edit-mode-map (make-sparse-keymap))
  5151. (define-key org-exit-edit-mode-map "\C-c'" 'org-edit-src-exit)
  5152. (defvar org-edit-src-force-single-line nil)
  5153. (defvar org-edit-src-from-org-mode nil)
  5154. (defvar org-edit-src-picture nil)
  5155. (define-minor-mode org-exit-edit-mode
  5156. "Minor mode installing a single key binding, \"C-c '\" to exit special edit.")
  5157. (defun org-edit-src-code ()
  5158. "Edit the source code example at point.
  5159. An indirect buffer is created, and that buffer is then narrowed to the
  5160. example at point and switched to the correct language mode. When done,
  5161. exit by killing the buffer with \\[org-edit-src-exit]."
  5162. (interactive)
  5163. (let ((line (org-current-line))
  5164. (case-fold-search t)
  5165. (msg (substitute-command-keys
  5166. "Edit, then exit with C-c ' (C-c and single quote)"))
  5167. (info (org-edit-src-find-region-and-lang))
  5168. (org-mode-p (eq major-mode 'org-mode))
  5169. beg end lang lang-f single lfmt)
  5170. (if (not info)
  5171. nil
  5172. (setq beg (nth 0 info)
  5173. end (nth 1 info)
  5174. lang (nth 2 info)
  5175. single (nth 3 info)
  5176. lfmt (nth 4 info)
  5177. lang-f (intern (concat lang "-mode")))
  5178. (unless (functionp lang-f)
  5179. (error "No such language mode: %s" lang-f))
  5180. (goto-line line)
  5181. (if (get-buffer "*Org Edit Src Example*")
  5182. (kill-buffer "*Org Edit Src Example*"))
  5183. (switch-to-buffer (make-indirect-buffer (current-buffer)
  5184. "*Org Edit Src Example*"))
  5185. (narrow-to-region beg end)
  5186. (remove-text-properties beg end '(display nil invisible nil
  5187. intangible nil))
  5188. (let ((org-inhibit-startup t))
  5189. (funcall lang-f))
  5190. (set (make-local-variable 'org-edit-src-force-single-line) single)
  5191. (set (make-local-variable 'org-edit-src-from-org-mode) org-mode-p)
  5192. (when lfmt
  5193. (set (make-local-variable 'org-coderef-label-format) lfmt))
  5194. (when org-mode-p
  5195. (goto-char (point-min))
  5196. (while (re-search-forward "^," nil t)
  5197. (replace-match "")))
  5198. (goto-line line)
  5199. (org-exit-edit-mode)
  5200. (org-set-local 'header-line-format msg)
  5201. (message "%s" msg)
  5202. t)))
  5203. (defun org-edit-fixed-width-region ()
  5204. "Edit the fixed-width ascii drawing at point.
  5205. This must be a region where each line starts with a colon followed by
  5206. a space character.
  5207. An indirect buffer is created, and that buffer is then narrowed to the
  5208. example at point and switched to artist-mode. When done,
  5209. exit by killing the buffer with \\[org-edit-src-exit]."
  5210. (interactive)
  5211. (let ((line (org-current-line))
  5212. (case-fold-search t)
  5213. (msg (substitute-command-keys
  5214. "Edit, then exit with C-c ' (C-c and single quote)"))
  5215. (org-mode-p (eq major-mode 'org-mode))
  5216. beg end lang lang-f)
  5217. (beginning-of-line 1)
  5218. (if (looking-at "[ \t]*[^:\n \t]")
  5219. nil
  5220. (if (looking-at "[ \t]*\\(\n\\|\\'\\)")
  5221. (setq beg (point) end beg)
  5222. (save-excursion
  5223. (if (re-search-backward "^[ \t]*[^:]" nil 'move)
  5224. (setq beg (point-at-bol 2))
  5225. (setq beg (point))))
  5226. (save-excursion
  5227. (if (re-search-forward "^[ \t]*[^:]" nil 'move)
  5228. (setq end (1- (match-beginning 0)))
  5229. (setq end (point))))
  5230. (goto-line line))
  5231. (if (get-buffer "*Org Edit Picture*")
  5232. (kill-buffer "*Org Edit Picture*"))
  5233. (switch-to-buffer (make-indirect-buffer (current-buffer)
  5234. "*Org Edit Picture*"))
  5235. (narrow-to-region beg end)
  5236. (remove-text-properties beg end '(display nil invisible nil
  5237. intangible nil))
  5238. (when (fboundp 'font-lock-unfontify-region)
  5239. (font-lock-unfontify-region (point-min) (point-max)))
  5240. (cond
  5241. ((eq org-edit-fixed-width-region-mode 'artist-mode)
  5242. (fundamental-mode)
  5243. (artist-mode 1))
  5244. (t (funcall org-edit-fixed-width-region-mode)))
  5245. (set (make-local-variable 'org-edit-src-force-single-line) nil)
  5246. (set (make-local-variable 'org-edit-src-from-org-mode) org-mode-p)
  5247. (set (make-local-variable 'org-edit-src-picture) t)
  5248. (goto-char (point-min))
  5249. (while (re-search-forward "^[ \t]*: ?" nil t)
  5250. (replace-match ""))
  5251. (goto-line line)
  5252. (org-exit-edit-mode)
  5253. (org-set-local 'header-line-format msg)
  5254. (message "%s" msg)
  5255. t)))
  5256. (defun org-edit-src-find-region-and-lang ()
  5257. "Find the region and language for a local edit.
  5258. Return a list with beginning and end of the region, a string representing
  5259. the language, a switch telling of the content should be in a single line."
  5260. (let ((re-list
  5261. (append
  5262. org-edit-src-region-extra
  5263. '(
  5264. ("<src\\>[^<]*>[ \t]*\n?" "\n?[ \t]*</src>" lang)
  5265. ("<literal\\>[^<]*>[ \t]*\n?" "\n?[ \t]*</literal>" style)
  5266. ("<example>[ \t]*\n?" "\n?[ \t]*</example>" "fundamental")
  5267. ("<lisp>[ \t]*\n?" "\n?[ \t]*</lisp>" "emacs-lisp")
  5268. ("<perl>[ \t]*\n?" "\n?[ \t]*</perl>" "perl")
  5269. ("<python>[ \t]*\n?" "\n?[ \t]*</python>" "python")
  5270. ("<ruby>[ \t]*\n?" "\n?[ \t]*</ruby>" "ruby")
  5271. ("^#\\+begin_src\\( \\([^ \t\n]+\\)\\)?.*\n" "\n#\\+end_src" 2)
  5272. ("^#\\+begin_example.*\n" "\n#\\+end_example" "fundamental")
  5273. ("^#\\+html:" "\n" "html" single-line)
  5274. ("^#\\+begin_html.*\n" "\n#\\+end_html" "html")
  5275. ("^#\\+begin_latex.*\n" "\n#\\+end_latex" "latex")
  5276. ("^#\\+latex:" "\n" "latex" single-line)
  5277. ("^#\\+begin_ascii.*\n" "\n#\\+end_ascii" "fundamental")
  5278. ("^#\\+ascii:" "\n" "ascii" single-line)
  5279. )))
  5280. (pos (point))
  5281. re re1 re2 single beg end lang lfmt match-re1)
  5282. (catch 'exit
  5283. (while (setq entry (pop re-list))
  5284. (setq re1 (car entry) re2 (nth 1 entry) lang (nth 2 entry)
  5285. single (nth 3 entry))
  5286. (save-excursion
  5287. (if (or (looking-at re1)
  5288. (re-search-backward re1 nil t))
  5289. (progn
  5290. (setq match-re1 (match-string 0))
  5291. (setq beg (match-end 0)
  5292. lang (org-edit-src-get-lang lang)
  5293. lfmt (org-edit-src-get-label-format match-re1))
  5294. (if (and (re-search-forward re2 nil t)
  5295. (>= (match-end 0) pos))
  5296. (throw 'exit (list beg (match-beginning 0)
  5297. lang single lfmt))))
  5298. (if (or (looking-at re2)
  5299. (re-search-forward re2 nil t))
  5300. (progn
  5301. (setq end (match-beginning 0))
  5302. (if (and (re-search-backward re1 nil t)
  5303. (<= (match-beginning 0) pos))
  5304. (progn
  5305. (setq lfmt (org-edit-src-get-label-format
  5306. (match-string 0)))
  5307. (throw 'exit
  5308. (list (match-end 0) end
  5309. (org-edit-src-get-lang lang)
  5310. single lfmt))))))))))))
  5311. (defun org-edit-src-get-lang (lang)
  5312. "Extract the src language."
  5313. (let ((m (match-string 0)))
  5314. (cond
  5315. ((stringp lang) lang)
  5316. ((integerp lang) (match-string lang))
  5317. ((and (eq lang 'lang)
  5318. (string-match "\\<lang=\"\\([^ \t\n\"]+\\)\"" m))
  5319. (match-string 1 m))
  5320. ((and (eq lang 'style)
  5321. (string-match "\\<style=\"\\([^ \t\n\"]+\\)\"" m))
  5322. (match-string 1 m))
  5323. (t "fundamental"))))
  5324. (defun org-edit-src-get-label-format (s)
  5325. "Extract the label format."
  5326. (save-match-data
  5327. (if (string-match "-l[ \t]+\\\\?\"\\([^\t\r\n\"]+\\)\\\\?\"" s)
  5328. (match-string 1 s))))
  5329. (defun org-edit-src-exit ()
  5330. "Exit special edit and protect problematic lines."
  5331. (interactive)
  5332. (unless (buffer-base-buffer (current-buffer))
  5333. (error "This is not an indirect buffer, something is wrong..."))
  5334. (unless (> (point-min) 1)
  5335. (error "This buffer is not narrowed, something is wrong..."))
  5336. (goto-char (point-min))
  5337. (if (looking-at "[ \t\n]*\n") (replace-match ""))
  5338. (if (re-search-forward "\n[ \t\n]*\\'" nil t) (replace-match ""))
  5339. (when (org-bound-and-true-p org-edit-src-force-single-line)
  5340. (goto-char (point-min))
  5341. (while (re-search-forward "\n" nil t)
  5342. (replace-match " "))
  5343. (goto-char (point-min))
  5344. (if (looking-at "\\s-*") (replace-match " "))
  5345. (if (re-search-forward "\\s-+\\'" nil t)
  5346. (replace-match "")))
  5347. (when (org-bound-and-true-p org-edit-src-from-org-mode)
  5348. (goto-char (point-min))
  5349. (while (re-search-forward (if (org-mode-p) "^\\(.\\)" "^\\([*#]\\)") nil t)
  5350. (replace-match ",\\1"))
  5351. (when font-lock-mode
  5352. (font-lock-unfontify-region (point-min) (point-max)))
  5353. (put-text-property (point-min) (point-max) 'font-lock-fontified t))
  5354. (when (org-bound-and-true-p org-edit-src-picture)
  5355. (untabify (point-min) (point-max))
  5356. (goto-char (point-min))
  5357. (while (re-search-forward "^" nil t)
  5358. (replace-match ": "))
  5359. (when font-lock-mode
  5360. (font-lock-unfontify-region (point-min) (point-max)))
  5361. (put-text-property (point-min) (point-max) 'font-lock-fontified t))
  5362. (kill-buffer (current-buffer))
  5363. (and (org-mode-p) (org-restart-font-lock)))
  5364. ;;; The orgstruct minor mode
  5365. ;; Define a minor mode which can be used in other modes in order to
  5366. ;; integrate the org-mode structure editing commands.
  5367. ;; This is really a hack, because the org-mode structure commands use
  5368. ;; keys which normally belong to the major mode. Here is how it
  5369. ;; works: The minor mode defines all the keys necessary to operate the
  5370. ;; structure commands, but wraps the commands into a function which
  5371. ;; tests if the cursor is currently at a headline or a plain list
  5372. ;; item. If that is the case, the structure command is used,
  5373. ;; temporarily setting many Org-mode variables like regular
  5374. ;; expressions for filling etc. However, when any of those keys is
  5375. ;; used at a different location, function uses `key-binding' to look
  5376. ;; up if the key has an associated command in another currently active
  5377. ;; keymap (minor modes, major mode, global), and executes that
  5378. ;; command. There might be problems if any of the keys is otherwise
  5379. ;; used as a prefix key.
  5380. ;; Another challenge is that the key binding for TAB can be tab or \C-i,
  5381. ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
  5382. ;; addresses this by checking explicitly for both bindings.
  5383. (defvar orgstruct-mode-map (make-sparse-keymap)
  5384. "Keymap for the minor `orgstruct-mode'.")
  5385. (defvar org-local-vars nil
  5386. "List of local variables, for use by `orgstruct-mode'")
  5387. ;;;###autoload
  5388. (define-minor-mode orgstruct-mode
  5389. "Toggle the minor more `orgstruct-mode'.
  5390. This mode is for using Org-mode structure commands in other modes.
  5391. The following key behave as if Org-mode was active, if the cursor
  5392. is on a headline, or on a plain list item (both in the definition
  5393. of Org-mode).
  5394. M-up Move entry/item up
  5395. M-down Move entry/item down
  5396. M-left Promote
  5397. M-right Demote
  5398. M-S-up Move entry/item up
  5399. M-S-down Move entry/item down
  5400. M-S-left Promote subtree
  5401. M-S-right Demote subtree
  5402. M-q Fill paragraph and items like in Org-mode
  5403. C-c ^ Sort entries
  5404. C-c - Cycle list bullet
  5405. TAB Cycle item visibility
  5406. M-RET Insert new heading/item
  5407. S-M-RET Insert new TODO heading / Checkbox item
  5408. C-c C-c Set tags / toggle checkbox"
  5409. nil " OrgStruct" nil
  5410. (org-load-modules-maybe)
  5411. (and (orgstruct-setup) (defun orgstruct-setup () nil)))
  5412. ;;;###autoload
  5413. (defun turn-on-orgstruct ()
  5414. "Unconditionally turn on `orgstruct-mode'."
  5415. (orgstruct-mode 1))
  5416. ;;;###autoload
  5417. (defun turn-on-orgstruct++ ()
  5418. "Unconditionally turn on `orgstruct-mode', and force org-mode indentations.
  5419. In addition to setting orgstruct-mode, this also exports all indentation and
  5420. autofilling variables from org-mode into the buffer. Note that turning
  5421. off orgstruct-mode will *not* remove these additional settings."
  5422. (orgstruct-mode 1)
  5423. (let (var val)
  5424. (mapc
  5425. (lambda (x)
  5426. (when (string-match
  5427. "^\\(paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
  5428. (symbol-name (car x)))
  5429. (setq var (car x) val (nth 1 x))
  5430. (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
  5431. org-local-vars)))
  5432. (defun orgstruct-error ()
  5433. "Error when there is no default binding for a structure key."
  5434. (interactive)
  5435. (error "This key has no function outside structure elements"))
  5436. (defun orgstruct-setup ()
  5437. "Setup orgstruct keymaps."
  5438. (let ((nfunc 0)
  5439. (bindings
  5440. (list
  5441. '([(meta up)] org-metaup)
  5442. '([(meta down)] org-metadown)
  5443. '([(meta left)] org-metaleft)
  5444. '([(meta right)] org-metaright)
  5445. '([(meta shift up)] org-shiftmetaup)
  5446. '([(meta shift down)] org-shiftmetadown)
  5447. '([(meta shift left)] org-shiftmetaleft)
  5448. '([(meta shift right)] org-shiftmetaright)
  5449. '([(shift up)] org-shiftup)
  5450. '([(shift down)] org-shiftdown)
  5451. '([(shift left)] org-shiftleft)
  5452. '([(shift right)] org-shiftright)
  5453. '("\C-c\C-c" org-ctrl-c-ctrl-c)
  5454. '("\M-q" fill-paragraph)
  5455. '("\C-c^" org-sort)
  5456. '("\C-c-" org-cycle-list-bullet)))
  5457. elt key fun cmd)
  5458. (while (setq elt (pop bindings))
  5459. (setq nfunc (1+ nfunc))
  5460. (setq key (org-key (car elt))
  5461. fun (nth 1 elt)
  5462. cmd (orgstruct-make-binding fun nfunc key))
  5463. (org-defkey orgstruct-mode-map key cmd))
  5464. ;; Special treatment needed for TAB and RET
  5465. (org-defkey orgstruct-mode-map [(tab)]
  5466. (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
  5467. (org-defkey orgstruct-mode-map "\C-i"
  5468. (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
  5469. (org-defkey orgstruct-mode-map "\M-\C-m"
  5470. (orgstruct-make-binding 'org-insert-heading 105
  5471. "\M-\C-m" [(meta return)]))
  5472. (org-defkey orgstruct-mode-map [(meta return)]
  5473. (orgstruct-make-binding 'org-insert-heading 106
  5474. [(meta return)] "\M-\C-m"))
  5475. (org-defkey orgstruct-mode-map [(shift meta return)]
  5476. (orgstruct-make-binding 'org-insert-todo-heading 107
  5477. [(meta return)] "\M-\C-m"))
  5478. (unless org-local-vars
  5479. (setq org-local-vars (org-get-local-variables)))
  5480. t))
  5481. (defun orgstruct-make-binding (fun n &rest keys)
  5482. "Create a function for binding in the structure minor mode.
  5483. FUN is the command to call inside a table. N is used to create a unique
  5484. command name. KEYS are keys that should be checked in for a command
  5485. to execute outside of tables."
  5486. (eval
  5487. (list 'defun
  5488. (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
  5489. '(arg)
  5490. (concat "In Structure, run `" (symbol-name fun) "'.\n"
  5491. "Outside of structure, run the binding of `"
  5492. (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
  5493. "'.")
  5494. '(interactive "p")
  5495. (list 'if
  5496. '(org-context-p 'headline 'item)
  5497. (list 'org-run-like-in-org-mode (list 'quote fun))
  5498. (list 'let '(orgstruct-mode)
  5499. (list 'call-interactively
  5500. (append '(or)
  5501. (mapcar (lambda (k)
  5502. (list 'key-binding k))
  5503. keys)
  5504. '('orgstruct-error))))))))
  5505. (defun org-context-p (&rest contexts)
  5506. "Check if local context is any of CONTEXTS.
  5507. Possible values in the list of contexts are `table', `headline', and `item'."
  5508. (let ((pos (point)))
  5509. (goto-char (point-at-bol))
  5510. (prog1 (or (and (memq 'table contexts)
  5511. (looking-at "[ \t]*|"))
  5512. (and (memq 'headline contexts)
  5513. ;;????????? (looking-at "\\*+"))
  5514. (looking-at outline-regexp))
  5515. (and (memq 'item contexts)
  5516. (looking-at "[ \t]*\\([-+*] \\|[0-9]+[.)] \\)")))
  5517. (goto-char pos))))
  5518. (defun org-get-local-variables ()
  5519. "Return a list of all local variables in an org-mode buffer."
  5520. (let (varlist)
  5521. (with-current-buffer (get-buffer-create "*Org tmp*")
  5522. (erase-buffer)
  5523. (org-mode)
  5524. (setq varlist (buffer-local-variables)))
  5525. (kill-buffer "*Org tmp*")
  5526. (delq nil
  5527. (mapcar
  5528. (lambda (x)
  5529. (setq x
  5530. (if (symbolp x)
  5531. (list x)
  5532. (list (car x) (list 'quote (cdr x)))))
  5533. (if (string-match
  5534. "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
  5535. (symbol-name (car x)))
  5536. x nil))
  5537. varlist))))
  5538. ;;;###autoload
  5539. (defun org-run-like-in-org-mode (cmd)
  5540. (org-load-modules-maybe)
  5541. (unless org-local-vars
  5542. (setq org-local-vars (org-get-local-variables)))
  5543. (eval (list 'let org-local-vars
  5544. (list 'call-interactively (list 'quote cmd)))))
  5545. ;;;; Archiving
  5546. (defun org-get-category (&optional pos)
  5547. "Get the category applying to position POS."
  5548. (get-text-property (or pos (point)) 'org-category))
  5549. (defun org-refresh-category-properties ()
  5550. "Refresh category text properties in the buffer."
  5551. (let ((def-cat (cond
  5552. ((null org-category)
  5553. (if buffer-file-name
  5554. (file-name-sans-extension
  5555. (file-name-nondirectory buffer-file-name))
  5556. "???"))
  5557. ((symbolp org-category) (symbol-name org-category))
  5558. (t org-category)))
  5559. beg end cat pos optionp)
  5560. (org-unmodified
  5561. (save-excursion
  5562. (save-restriction
  5563. (widen)
  5564. (goto-char (point-min))
  5565. (put-text-property (point) (point-max) 'org-category def-cat)
  5566. (while (re-search-forward
  5567. "^\\(#\\+CATEGORY:\\|[ \t]*:CATEGORY:\\)\\(.*\\)" nil t)
  5568. (setq pos (match-end 0)
  5569. optionp (equal (char-after (match-beginning 0)) ?#)
  5570. cat (org-trim (match-string 2)))
  5571. (if optionp
  5572. (setq beg (point-at-bol) end (point-max))
  5573. (org-back-to-heading t)
  5574. (setq beg (point) end (org-end-of-subtree t t)))
  5575. (put-text-property beg end 'org-category cat)
  5576. (goto-char pos)))))))
  5577. ;;;; Link Stuff
  5578. ;;; Link abbreviations
  5579. (defun org-link-expand-abbrev (link)
  5580. "Apply replacements as defined in `org-link-abbrev-alist."
  5581. (if (string-match "^\\([a-zA-Z][-_a-zA-Z0-9]*\\)\\(::?\\(.*\\)\\)?$" link)
  5582. (let* ((key (match-string 1 link))
  5583. (as (or (assoc key org-link-abbrev-alist-local)
  5584. (assoc key org-link-abbrev-alist)))
  5585. (tag (and (match-end 2) (match-string 3 link)))
  5586. rpl)
  5587. (if (not as)
  5588. link
  5589. (setq rpl (cdr as))
  5590. (cond
  5591. ((symbolp rpl) (funcall rpl tag))
  5592. ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
  5593. ((string-match "%h" rpl)
  5594. (replace-match (url-hexify-string (or tag "")) t t rpl))
  5595. (t (concat rpl tag)))))
  5596. link))
  5597. ;;; Storing and inserting links
  5598. (defvar org-insert-link-history nil
  5599. "Minibuffer history for links inserted with `org-insert-link'.")
  5600. (defvar org-stored-links nil
  5601. "Contains the links stored with `org-store-link'.")
  5602. (defvar org-store-link-plist nil
  5603. "Plist with info about the most recently link created with `org-store-link'.")
  5604. (defvar org-link-protocols nil
  5605. "Link protocols added to Org-mode using `org-add-link-type'.")
  5606. (defvar org-store-link-functions nil
  5607. "List of functions that are called to create and store a link.
  5608. Each function will be called in turn until one returns a non-nil
  5609. value. Each function should check if it is responsible for creating
  5610. this link (for example by looking at the major mode).
  5611. If not, it must exit and return nil.
  5612. If yes, it should return a non-nil value after a calling
  5613. `org-store-link-props' with a list of properties and values.
  5614. Special properties are:
  5615. :type The link prefix. like \"http\". This must be given.
  5616. :link The link, like \"http://www.astro.uva.nl/~dominik\".
  5617. This is obligatory as well.
  5618. :description Optional default description for the second pair
  5619. of brackets in an Org-mode link. The user can still change
  5620. this when inserting this link into an Org-mode buffer.
  5621. In addition to these, any additional properties can be specified
  5622. and then used in remember templates.")
  5623. (defun org-add-link-type (type &optional follow export)
  5624. "Add TYPE to the list of `org-link-types'.
  5625. Re-compute all regular expressions depending on `org-link-types'
  5626. FOLLOW and EXPORT are two functions.
  5627. FOLLOW should take the link path as the single argument and do whatever
  5628. is necessary to follow the link, for example find a file or display
  5629. a mail message.
  5630. EXPORT should format the link path for export to one of the export formats.
  5631. It should be a function accepting three arguments:
  5632. path the path of the link, the text after the prefix (like \"http:\")
  5633. desc the description of the link, if any, nil if there was no description
  5634. format the export format, a symbol like `html' or `latex'.
  5635. The function may use the FORMAT information to return different values
  5636. depending on the format. The return value will be put literally into
  5637. the exported file.
  5638. Org-mode has a built-in default for exporting links. If you are happy with
  5639. this default, there is no need to define an export function for the link
  5640. type. For a simple example of an export function, see `org-bbdb.el'."
  5641. (add-to-list 'org-link-types type t)
  5642. (org-make-link-regexps)
  5643. (if (assoc type org-link-protocols)
  5644. (setcdr (assoc type org-link-protocols) (list follow export))
  5645. (push (list type follow export) org-link-protocols)))
  5646. ;;;###autoload
  5647. (defun org-store-link (arg)
  5648. "\\<org-mode-map>Store an org-link to the current location.
  5649. This link is added to `org-stored-links' and can later be inserted
  5650. into an org-buffer with \\[org-insert-link].
  5651. For some link types, a prefix arg is interpreted:
  5652. For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
  5653. For file links, arg negates `org-context-in-file-links'."
  5654. (interactive "P")
  5655. (org-load-modules-maybe)
  5656. (setq org-store-link-plist nil) ; reset
  5657. (let (link cpltxt desc description search txt)
  5658. (cond
  5659. ((run-hook-with-args-until-success 'org-store-link-functions)
  5660. (setq link (plist-get org-store-link-plist :link)
  5661. desc (or (plist-get org-store-link-plist :description) link)))
  5662. ((equal (buffer-name) "*Org Edit Src Example*")
  5663. (let (label gc)
  5664. (while (or (not label)
  5665. (save-excursion
  5666. (save-restriction
  5667. (widen)
  5668. (goto-char (point-min))
  5669. (re-search-forward
  5670. (regexp-quote (format org-coderef-label-format label))
  5671. nil t))))
  5672. (when label (message "Label exists already") (sit-for 2))
  5673. (setq label (read-string "Code line label: " label)))
  5674. (end-of-line 1)
  5675. (setq link (format org-coderef-label-format label))
  5676. (setq gc (- 79 (length link)))
  5677. (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
  5678. (insert link)
  5679. (setq link (concat "(" label ")") desc nil)))
  5680. ((eq major-mode 'calendar-mode)
  5681. (let ((cd (calendar-cursor-to-date)))
  5682. (setq link
  5683. (format-time-string
  5684. (car org-time-stamp-formats)
  5685. (apply 'encode-time
  5686. (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
  5687. nil nil nil))))
  5688. (org-store-link-props :type "calendar" :date cd)))
  5689. ((eq major-mode 'w3-mode)
  5690. (setq cpltxt (url-view-url t)
  5691. link (org-make-link cpltxt))
  5692. (org-store-link-props :type "w3" :url (url-view-url t)))
  5693. ((eq major-mode 'w3m-mode)
  5694. (setq cpltxt (or w3m-current-title w3m-current-url)
  5695. link (org-make-link w3m-current-url))
  5696. (org-store-link-props :type "w3m" :url (url-view-url t)))
  5697. ((setq search (run-hook-with-args-until-success
  5698. 'org-create-file-search-functions))
  5699. (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
  5700. "::" search))
  5701. (setq cpltxt (or description link)))
  5702. ((eq major-mode 'image-mode)
  5703. (setq cpltxt (concat "file:"
  5704. (abbreviate-file-name buffer-file-name))
  5705. link (org-make-link cpltxt))
  5706. (org-store-link-props :type "image" :file buffer-file-name))
  5707. ((eq major-mode 'dired-mode)
  5708. ;; link to the file in the current line
  5709. (setq cpltxt (concat "file:"
  5710. (abbreviate-file-name
  5711. (expand-file-name
  5712. (dired-get-filename nil t))))
  5713. link (org-make-link cpltxt)))
  5714. ((and buffer-file-name (org-mode-p))
  5715. (cond
  5716. ((org-in-regexp "<<\\(.*?\\)>>")
  5717. (setq cpltxt
  5718. (concat "file:"
  5719. (abbreviate-file-name buffer-file-name)
  5720. "::" (match-string 1))
  5721. link (org-make-link cpltxt)))
  5722. ((and (featurep 'org-id)
  5723. (or (eq org-link-to-org-use-id t)
  5724. (and (eq org-link-to-org-use-id 'create-if-interactive)
  5725. (interactive-p))
  5726. (and org-link-to-org-use-id
  5727. (condition-case nil
  5728. (org-entry-get nil "ID")
  5729. (error nil)))))
  5730. ;; We can make a link using the ID.
  5731. (setq link (condition-case nil
  5732. (prog1 (org-id-store-link)
  5733. (setq desc (plist-get org-store-link-plist
  5734. :description)))
  5735. (error
  5736. ;; probably before first headline, link to file only
  5737. (concat "file:"
  5738. (abbreviate-file-name buffer-file-name))))))
  5739. (t
  5740. ;; Just link to current headline
  5741. (setq cpltxt (concat "file:"
  5742. (abbreviate-file-name buffer-file-name)))
  5743. ;; Add a context search string
  5744. (when (org-xor org-context-in-file-links arg)
  5745. (setq txt (cond
  5746. ((org-on-heading-p) nil)
  5747. ((org-region-active-p)
  5748. (buffer-substring (region-beginning) (region-end)))
  5749. (t nil)))
  5750. (when (or (null txt) (string-match "\\S-" txt))
  5751. (setq cpltxt
  5752. (concat cpltxt "::"
  5753. (condition-case nil
  5754. (org-make-org-heading-search-string txt)
  5755. (error "")))
  5756. desc "NONE")))
  5757. (if (string-match "::\\'" cpltxt)
  5758. (setq cpltxt (substring cpltxt 0 -2)))
  5759. (setq link (org-make-link cpltxt)))))
  5760. ((buffer-file-name (buffer-base-buffer))
  5761. ;; Just link to this file here.
  5762. (setq cpltxt (concat "file:"
  5763. (abbreviate-file-name
  5764. (buffer-file-name (buffer-base-buffer)))))
  5765. ;; Add a context string
  5766. (when (org-xor org-context-in-file-links arg)
  5767. (setq txt (if (org-region-active-p)
  5768. (buffer-substring (region-beginning) (region-end))
  5769. (buffer-substring (point-at-bol) (point-at-eol))))
  5770. ;; Only use search option if there is some text.
  5771. (when (string-match "\\S-" txt)
  5772. (setq cpltxt
  5773. (concat cpltxt "::" (org-make-org-heading-search-string txt))
  5774. desc "NONE")))
  5775. (setq link (org-make-link cpltxt)))
  5776. ((interactive-p)
  5777. (error "Cannot link to a buffer which is not visiting a file"))
  5778. (t (setq link nil)))
  5779. (if (consp link) (setq cpltxt (car link) link (cdr link)))
  5780. (setq link (or link cpltxt)
  5781. desc (or desc cpltxt))
  5782. (if (equal desc "NONE") (setq desc nil))
  5783. (if (and (interactive-p) link)
  5784. (progn
  5785. (setq org-stored-links
  5786. (cons (list link desc) org-stored-links))
  5787. (message "Stored: %s" (or desc link)))
  5788. (and link (org-make-link-string link desc)))))
  5789. (defun org-store-link-props (&rest plist)
  5790. "Store link properties, extract names and addresses."
  5791. (let (x adr)
  5792. (when (setq x (plist-get plist :from))
  5793. (setq adr (mail-extract-address-components x))
  5794. (setq plist (plist-put plist :fromname (car adr)))
  5795. (setq plist (plist-put plist :fromaddress (nth 1 adr))))
  5796. (when (setq x (plist-get plist :to))
  5797. (setq adr (mail-extract-address-components x))
  5798. (setq plist (plist-put plist :toname (car adr)))
  5799. (setq plist (plist-put plist :toaddress (nth 1 adr)))))
  5800. (let ((from (plist-get plist :from))
  5801. (to (plist-get plist :to)))
  5802. (when (and from to org-from-is-user-regexp)
  5803. (setq plist
  5804. (plist-put plist :fromto
  5805. (if (string-match org-from-is-user-regexp from)
  5806. (concat "to %t")
  5807. (concat "from %f"))))))
  5808. (setq org-store-link-plist plist))
  5809. (defun org-add-link-props (&rest plist)
  5810. "Add these properties to the link property list."
  5811. (let (key value)
  5812. (while plist
  5813. (setq key (pop plist) value (pop plist))
  5814. (setq org-store-link-plist
  5815. (plist-put org-store-link-plist key value)))))
  5816. (defun org-email-link-description (&optional fmt)
  5817. "Return the description part of an email link.
  5818. This takes information from `org-store-link-plist' and formats it
  5819. according to FMT (default from `org-email-link-description-format')."
  5820. (setq fmt (or fmt org-email-link-description-format))
  5821. (let* ((p org-store-link-plist)
  5822. (to (plist-get p :toaddress))
  5823. (from (plist-get p :fromaddress))
  5824. (table
  5825. (list
  5826. (cons "%c" (plist-get p :fromto))
  5827. (cons "%F" (plist-get p :from))
  5828. (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
  5829. (cons "%T" (plist-get p :to))
  5830. (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
  5831. (cons "%s" (plist-get p :subject))
  5832. (cons "%m" (plist-get p :message-id)))))
  5833. (when (string-match "%c" fmt)
  5834. ;; Check if the user wrote this message
  5835. (if (and org-from-is-user-regexp from to
  5836. (save-match-data (string-match org-from-is-user-regexp from)))
  5837. (setq fmt (replace-match "to %t" t t fmt))
  5838. (setq fmt (replace-match "from %f" t t fmt))))
  5839. (org-replace-escapes fmt table)))
  5840. (defun org-make-org-heading-search-string (&optional string heading)
  5841. "Make search string for STRING or current headline."
  5842. (interactive)
  5843. (let ((s (or string (org-get-heading))))
  5844. (unless (and string (not heading))
  5845. ;; We are using a headline, clean up garbage in there.
  5846. (if (string-match org-todo-regexp s)
  5847. (setq s (replace-match "" t t s)))
  5848. (if (string-match (org-re ":[[:alnum:]_@:]+:[ \t]*$") s)
  5849. (setq s (replace-match "" t t s)))
  5850. (setq s (org-trim s))
  5851. (if (string-match (concat "^\\(" org-quote-string "\\|"
  5852. org-comment-string "\\)") s)
  5853. (setq s (replace-match "" t t s)))
  5854. (while (string-match org-ts-regexp s)
  5855. (setq s (replace-match "" t t s))))
  5856. (while (string-match "[^a-zA-Z_0-9 \t]+" s)
  5857. (setq s (replace-match " " t t s)))
  5858. (or string (setq s (concat "*" s))) ; Add * for headlines
  5859. (mapconcat 'identity (org-split-string s "[ \t]+") " ")))
  5860. (defun org-make-link (&rest strings)
  5861. "Concatenate STRINGS."
  5862. (apply 'concat strings))
  5863. (defun org-make-link-string (link &optional description)
  5864. "Make a link with brackets, consisting of LINK and DESCRIPTION."
  5865. (unless (string-match "\\S-" link)
  5866. (error "Empty link"))
  5867. (when (stringp description)
  5868. ;; Remove brackets from the description, they are fatal.
  5869. (while (string-match "\\[" description)
  5870. (setq description (replace-match "{" t t description)))
  5871. (while (string-match "\\]" description)
  5872. (setq description (replace-match "}" t t description))))
  5873. (when (equal (org-link-escape link) description)
  5874. ;; No description needed, it is identical
  5875. (setq description nil))
  5876. (when (and (not description)
  5877. (not (equal link (org-link-escape link))))
  5878. (setq description (org-extract-attributes link)))
  5879. (concat "[[" (org-link-escape link) "]"
  5880. (if description (concat "[" description "]") "")
  5881. "]"))
  5882. (defconst org-link-escape-chars
  5883. '((?\ . "%20")
  5884. (?\[ . "%5B")
  5885. (?\] . "%5D")
  5886. (?\340 . "%E0") ; `a
  5887. (?\342 . "%E2") ; ^a
  5888. (?\347 . "%E7") ; ,c
  5889. (?\350 . "%E8") ; `e
  5890. (?\351 . "%E9") ; 'e
  5891. (?\352 . "%EA") ; ^e
  5892. (?\356 . "%EE") ; ^i
  5893. (?\364 . "%F4") ; ^o
  5894. (?\371 . "%F9") ; `u
  5895. (?\373 . "%FB") ; ^u
  5896. (?\; . "%3B")
  5897. (?? . "%3F")
  5898. (?= . "%3D")
  5899. (?+ . "%2B")
  5900. )
  5901. "Association list of escapes for some characters problematic in links.
  5902. This is the list that is used for internal purposes.")
  5903. (defconst org-link-escape-chars-browser
  5904. '((?\ . "%20")) ; 32 for the SPC char
  5905. "Association list of escapes for some characters problematic in links.
  5906. This is the list that is used before handing over to the browser.")
  5907. (defun org-link-escape (text &optional table)
  5908. "Escape characters in TEXT that are problematic for links."
  5909. (setq table (or table org-link-escape-chars))
  5910. (when text
  5911. (let ((re (mapconcat (lambda (x) (regexp-quote
  5912. (char-to-string (car x))))
  5913. table "\\|")))
  5914. (while (string-match re text)
  5915. (setq text
  5916. (replace-match
  5917. (cdr (assoc (string-to-char (match-string 0 text))
  5918. table))
  5919. t t text)))
  5920. text)))
  5921. (defun org-link-unescape (text &optional table)
  5922. "Reverse the action of `org-link-escape'."
  5923. (setq table (or table org-link-escape-chars))
  5924. (when text
  5925. (let ((re (mapconcat (lambda (x) (regexp-quote (cdr x)))
  5926. table "\\|")))
  5927. (while (string-match re text)
  5928. (setq text
  5929. (replace-match
  5930. (char-to-string (car (rassoc (match-string 0 text) table)))
  5931. t t text)))
  5932. text)))
  5933. (defun org-xor (a b)
  5934. "Exclusive or."
  5935. (if a (not b) b))
  5936. (defun org-get-header (header)
  5937. "Find a header field in the current buffer."
  5938. (save-excursion
  5939. (goto-char (point-min))
  5940. (let ((case-fold-search t) s)
  5941. (cond
  5942. ((eq header 'from)
  5943. (if (re-search-forward "^From:\\s-+\\(.*\\)" nil t)
  5944. (setq s (match-string 1)))
  5945. (while (string-match "\"" s)
  5946. (setq s (replace-match "" t t s)))
  5947. (if (string-match "[<(].*" s)
  5948. (setq s (replace-match "" t t s))))
  5949. ((eq header 'message-id)
  5950. (if (re-search-forward "^message-id:\\s-+\\(.*\\)" nil t)
  5951. (setq s (match-string 1))))
  5952. ((eq header 'subject)
  5953. (if (re-search-forward "^subject:\\s-+\\(.*\\)" nil t)
  5954. (setq s (match-string 1)))))
  5955. (if (string-match "\\`[ \t\]+" s) (setq s (replace-match "" t t s)))
  5956. (if (string-match "[ \t\]+\\'" s) (setq s (replace-match "" t t s)))
  5957. s)))
  5958. (defun org-fixup-message-id-for-http (s)
  5959. "Replace special characters in a message id, so it can be used in an http query."
  5960. (while (string-match "<" s)
  5961. (setq s (replace-match "%3C" t t s)))
  5962. (while (string-match ">" s)
  5963. (setq s (replace-match "%3E" t t s)))
  5964. (while (string-match "@" s)
  5965. (setq s (replace-match "%40" t t s)))
  5966. s)
  5967. ;;;###autoload
  5968. (defun org-insert-link-global ()
  5969. "Insert a link like Org-mode does.
  5970. This command can be called in any mode to insert a link in Org-mode syntax."
  5971. (interactive)
  5972. (org-load-modules-maybe)
  5973. (org-run-like-in-org-mode 'org-insert-link))
  5974. (defun org-insert-link (&optional complete-file link-location)
  5975. "Insert a link. At the prompt, enter the link.
  5976. Completion can be used to insert any of the link protocol prefixes like
  5977. http or ftp in use.
  5978. The history can be used to select a link previously stored with
  5979. `org-store-link'. When the empty string is entered (i.e. if you just
  5980. press RET at the prompt), the link defaults to the most recently
  5981. stored link. As SPC triggers completion in the minibuffer, you need to
  5982. use M-SPC or C-q SPC to force the insertion of a space character.
  5983. You will also be prompted for a description, and if one is given, it will
  5984. be displayed in the buffer instead of the link.
  5985. If there is already a link at point, this command will allow you to edit link
  5986. and description parts.
  5987. With a \\[universal-argument] prefix, prompts for a file to link to. The file name can
  5988. be selected using completion. The path to the file will be relative to the
  5989. current directory if the file is in the current directory or a subdirectory.
  5990. Otherwise, the link will be the absolute path as completed in the minibuffer
  5991. \(i.e. normally ~/path/to/file). You can configure this behavior using the
  5992. option `org-link-file-path-type'.
  5993. With two \\[universal-argument] prefixes, enforce an absolute path even if the file is in
  5994. the current directory or below.
  5995. With three \\[universal-argument] prefixes, negate the meaning of
  5996. `org-keep-stored-link-after-insertion'.
  5997. If `org-make-link-description-function' is non-nil, this function will be
  5998. called with the link target, and the result will be the default
  5999. link description.
  6000. If the LINK-LOCATION parameter is non-nil, this value will be
  6001. used as the link location instead of reading one interactively."
  6002. (interactive "P")
  6003. (let* ((wcf (current-window-configuration))
  6004. (region (if (org-region-active-p)
  6005. (buffer-substring (region-beginning) (region-end))))
  6006. (remove (and region (list (region-beginning) (region-end))))
  6007. (desc region)
  6008. tmphist ; byte-compile incorrectly complains about this
  6009. (link link-location)
  6010. entry file)
  6011. (cond
  6012. (link-location) ; specified by arg, just use it.
  6013. ((org-in-regexp org-bracket-link-regexp 1)
  6014. ;; We do have a link at point, and we are going to edit it.
  6015. (setq remove (list (match-beginning 0) (match-end 0)))
  6016. (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
  6017. (setq link (read-string "Link: "
  6018. (org-link-unescape
  6019. (org-match-string-no-properties 1)))))
  6020. ((or (org-in-regexp org-angle-link-re)
  6021. (org-in-regexp org-plain-link-re))
  6022. ;; Convert to bracket link
  6023. (setq remove (list (match-beginning 0) (match-end 0))
  6024. link (read-string "Link: "
  6025. (org-remove-angle-brackets (match-string 0)))))
  6026. ((member complete-file '((4) (16)))
  6027. ;; Completing read for file names.
  6028. (setq file (read-file-name "File: "))
  6029. (let ((pwd (file-name-as-directory (expand-file-name ".")))
  6030. (pwd1 (file-name-as-directory (abbreviate-file-name
  6031. (expand-file-name ".")))))
  6032. (cond
  6033. ((equal complete-file '(16))
  6034. (setq link (org-make-link
  6035. "file:"
  6036. (abbreviate-file-name (expand-file-name file)))))
  6037. ((string-match (concat "^" (regexp-quote pwd1) "\\(.+\\)") file)
  6038. (setq link (org-make-link "file:" (match-string 1 file))))
  6039. ((string-match (concat "^" (regexp-quote pwd) "\\(.+\\)")
  6040. (expand-file-name file))
  6041. (setq link (org-make-link
  6042. "file:" (match-string 1 (expand-file-name file)))))
  6043. (t (setq link (org-make-link "file:" file))))))
  6044. (t
  6045. ;; Read link, with completion for stored links.
  6046. (with-output-to-temp-buffer "*Org Links*"
  6047. (princ "Insert a link. Use TAB to complete valid link prefixes.\n")
  6048. (when org-stored-links
  6049. (princ "\nStored links are available with <up>/<down> or M-p/n (most recent with RET):\n\n")
  6050. (princ (mapconcat
  6051. (lambda (x)
  6052. (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
  6053. (reverse org-stored-links) "\n"))))
  6054. (let ((cw (selected-window)))
  6055. (select-window (get-buffer-window "*Org Links*"))
  6056. (setq truncate-lines t)
  6057. (org-fit-window-to-buffer)
  6058. (select-window cw))
  6059. ;; Fake a link history, containing the stored links.
  6060. (setq tmphist (append (mapcar 'car org-stored-links)
  6061. org-insert-link-history))
  6062. (unwind-protect
  6063. (setq link
  6064. (let ((org-completion-use-ido nil))
  6065. (org-completing-read
  6066. "Link: "
  6067. (append
  6068. (mapcar (lambda (x) (list (concat (car x) ":")))
  6069. (append org-link-abbrev-alist-local org-link-abbrev-alist))
  6070. (mapcar (lambda (x) (list (concat x ":")))
  6071. org-link-types))
  6072. nil nil nil
  6073. 'tmphist
  6074. (or (car (car org-stored-links))))))
  6075. (set-window-configuration wcf)
  6076. (kill-buffer "*Org Links*"))
  6077. (setq entry (assoc link org-stored-links))
  6078. (or entry (push link org-insert-link-history))
  6079. (if (funcall (if (equal complete-file '(64)) 'not 'identity)
  6080. (not org-keep-stored-link-after-insertion))
  6081. (setq org-stored-links (delq (assoc link org-stored-links)
  6082. org-stored-links)))
  6083. (setq desc (or desc (nth 1 entry)))))
  6084. (if (string-match org-plain-link-re link)
  6085. ;; URL-like link, normalize the use of angular brackets.
  6086. (setq link (org-make-link (org-remove-angle-brackets link))))
  6087. ;; Check if we are linking to the current file with a search option
  6088. ;; If yes, simplify the link by using only the search option.
  6089. (when (and buffer-file-name
  6090. (string-match "^file:\\(.+?\\)::\\([^>]+\\)" link))
  6091. (let* ((path (match-string 1 link))
  6092. (case-fold-search nil)
  6093. (search (match-string 2 link)))
  6094. (save-match-data
  6095. (if (equal (file-truename buffer-file-name) (file-truename path))
  6096. ;; We are linking to this same file, with a search option
  6097. (setq link search)))))
  6098. ;; Check if we can/should use a relative path. If yes, simplify the link
  6099. (when (string-match "^file:\\(.*\\)" link)
  6100. (let* ((path (match-string 1 link))
  6101. (origpath path)
  6102. (case-fold-search nil))
  6103. (cond
  6104. ((or (eq org-link-file-path-type 'absolute)
  6105. (equal complete-file '(16)))
  6106. (setq path (abbreviate-file-name (expand-file-name path))))
  6107. ((eq org-link-file-path-type 'noabbrev)
  6108. (setq path (expand-file-name path)))
  6109. ((eq org-link-file-path-type 'relative)
  6110. (setq path (file-relative-name path)))
  6111. (t
  6112. (save-match-data
  6113. (if (string-match (concat "^" (regexp-quote
  6114. (file-name-as-directory
  6115. (expand-file-name "."))))
  6116. (expand-file-name path))
  6117. ;; We are linking a file with relative path name.
  6118. (setq path (substring (expand-file-name path)
  6119. (match-end 0)))
  6120. (setq path (abbreviate-file-name (expand-file-name path)))))))
  6121. (setq link (concat "file:" path))
  6122. (if (equal desc origpath)
  6123. (setq desc path))))
  6124. (if org-make-link-description-function
  6125. (setq desc (funcall org-make-link-description-function link desc)))
  6126. (setq desc (read-string "Description: " desc))
  6127. (unless (string-match "\\S-" desc) (setq desc nil))
  6128. (if remove (apply 'delete-region remove))
  6129. (insert (org-make-link-string link desc))))
  6130. (defun org-completing-read (&rest args)
  6131. "Completing-read with SPACE being a normal character."
  6132. (let ((minibuffer-local-completion-map
  6133. (copy-keymap minibuffer-local-completion-map)))
  6134. (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
  6135. (apply 'org-ido-completing-read args)))
  6136. (defun org-ido-completing-read (&rest args)
  6137. "Completing-read using `ido-mode' speedups if available"
  6138. (if (and org-completion-use-ido
  6139. (fboundp 'ido-completing-read)
  6140. (boundp 'ido-mode) ido-mode
  6141. (listp (second args)))
  6142. (apply 'ido-completing-read (concat (car args)) (cdr args))
  6143. (apply 'completing-read args)))
  6144. (defun org-extract-attributes (s)
  6145. "Extract the attributes cookie from a string and set as text property."
  6146. (let (a attr (start 0) key value)
  6147. (save-match-data
  6148. (when (string-match "{{\\([^}]+\\)}}$" s)
  6149. (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
  6150. (while (string-match "\\([a-zA-Z]+\\)=\"\\([^\"]*\\)\"" a start)
  6151. (setq key (match-string 1 a) value (match-string 2 a)
  6152. start (match-end 0)
  6153. attr (plist-put attr (intern key) value))))
  6154. (org-add-props s nil 'org-attr attr))
  6155. s))
  6156. (defun org-attributes-to-string (plist)
  6157. "Format a property list into an HTML attribute list."
  6158. (let ((s "") key value)
  6159. (while plist
  6160. (setq key (pop plist) value (pop plist))
  6161. (and value
  6162. (setq s (concat s " " (symbol-name key) "=\"" value "\""))))
  6163. s))
  6164. ;;; Opening/following a link
  6165. (defvar org-link-search-failed nil)
  6166. (defun org-next-link ()
  6167. "Move forward to the next link.
  6168. If the link is in hidden text, expose it."
  6169. (interactive)
  6170. (when (and org-link-search-failed (eq this-command last-command))
  6171. (goto-char (point-min))
  6172. (message "Link search wrapped back to beginning of buffer"))
  6173. (setq org-link-search-failed nil)
  6174. (let* ((pos (point))
  6175. (ct (org-context))
  6176. (a (assoc :link ct)))
  6177. (if a (goto-char (nth 2 a)))
  6178. (if (re-search-forward org-any-link-re nil t)
  6179. (progn
  6180. (goto-char (match-beginning 0))
  6181. (if (org-invisible-p) (org-show-context)))
  6182. (goto-char pos)
  6183. (setq org-link-search-failed t)
  6184. (error "No further link found"))))
  6185. (defun org-previous-link ()
  6186. "Move backward to the previous link.
  6187. If the link is in hidden text, expose it."
  6188. (interactive)
  6189. (when (and org-link-search-failed (eq this-command last-command))
  6190. (goto-char (point-max))
  6191. (message "Link search wrapped back to end of buffer"))
  6192. (setq org-link-search-failed nil)
  6193. (let* ((pos (point))
  6194. (ct (org-context))
  6195. (a (assoc :link ct)))
  6196. (if a (goto-char (nth 1 a)))
  6197. (if (re-search-backward org-any-link-re nil t)
  6198. (progn
  6199. (goto-char (match-beginning 0))
  6200. (if (org-invisible-p) (org-show-context)))
  6201. (goto-char pos)
  6202. (setq org-link-search-failed t)
  6203. (error "No further link found"))))
  6204. (defun org-translate-link (s)
  6205. "Translate a link string if a translation function has been defined."
  6206. (if (and org-link-translation-function
  6207. (fboundp org-link-translation-function)
  6208. (string-match "\\([a-zA-Z0-9]+\\):\\(.*\\)" s))
  6209. (progn
  6210. (setq s (funcall org-link-translation-function
  6211. (match-string 1) (match-string 2)))
  6212. (concat (car s) ":" (cdr s)))
  6213. s))
  6214. (defun org-translate-link-from-planner (type path)
  6215. "Translate a link from Emacs Planner syntax so that Org can follow it.
  6216. This is still an experimental function, your mileage may vary."
  6217. (cond
  6218. ((member type '("http" "https" "news" "ftp"))
  6219. ;; standard Internet links are the same.
  6220. nil)
  6221. ((and (equal type "irc") (string-match "^//" path))
  6222. ;; Planner has two / at the beginning of an irc link, we have 1.
  6223. ;; We should have zero, actually....
  6224. (setq path (substring path 1)))
  6225. ((and (equal type "lisp") (string-match "^/" path))
  6226. ;; Planner has a slash, we do not.
  6227. (setq type "elisp" path (substring path 1)))
  6228. ((string-match "^//\\(.?*\\)/\\(<.*>\\)$" path)
  6229. ;; A typical message link. Planner has the id after the fina slash,
  6230. ;; we separate it with a hash mark
  6231. (setq path (concat (match-string 1 path) "#"
  6232. (org-remove-angle-brackets (match-string 2 path)))))
  6233. )
  6234. (cons type path))
  6235. (defun org-find-file-at-mouse (ev)
  6236. "Open file link or URL at mouse."
  6237. (interactive "e")
  6238. (mouse-set-point ev)
  6239. (org-open-at-point 'in-emacs))
  6240. (defun org-open-at-mouse (ev)
  6241. "Open file link or URL at mouse."
  6242. (interactive "e")
  6243. (mouse-set-point ev)
  6244. (if (eq major-mode 'org-agenda-mode)
  6245. (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
  6246. (org-open-at-point))
  6247. (defvar org-window-config-before-follow-link nil
  6248. "The window configuration before following a link.
  6249. This is saved in case the need arises to restore it.")
  6250. (defvar org-open-link-marker (make-marker)
  6251. "Marker pointing to the location where `org-open-at-point; was called.")
  6252. ;;;###autoload
  6253. (defun org-open-at-point-global ()
  6254. "Follow a link like Org-mode does.
  6255. This command can be called in any mode to follow a link that has
  6256. Org-mode syntax."
  6257. (interactive)
  6258. (org-run-like-in-org-mode 'org-open-at-point))
  6259. ;;;###autoload
  6260. (defun org-open-link-from-string (s &optional arg)
  6261. "Open a link in the string S, as if it was in Org-mode."
  6262. (interactive "sLink: \nP")
  6263. (with-temp-buffer
  6264. (let ((org-inhibit-startup t))
  6265. (org-mode)
  6266. (insert s)
  6267. (goto-char (point-min))
  6268. (org-open-at-point arg))))
  6269. (defun org-open-at-point (&optional in-emacs)
  6270. "Open link at or after point.
  6271. If there is no link at point, this function will search forward up to
  6272. the end of the current subtree.
  6273. Normally, files will be opened by an appropriate application. If the
  6274. optional argument IN-EMACS is non-nil, Emacs will visit the file.
  6275. With a double prefix argument, try to open outside of Emacs, in the
  6276. application the system uses for this file type."
  6277. (interactive "P")
  6278. (org-load-modules-maybe)
  6279. (move-marker org-open-link-marker (point))
  6280. (setq org-window-config-before-follow-link (current-window-configuration))
  6281. (org-remove-occur-highlights nil nil t)
  6282. (cond
  6283. ((org-at-timestamp-p t) (org-follow-timestamp-link))
  6284. ((or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
  6285. (org-footnote-action))
  6286. (t
  6287. (let (type path link line search (pos (point)))
  6288. (catch 'match
  6289. (save-excursion
  6290. (skip-chars-forward "^]\n\r")
  6291. (when (org-in-regexp org-bracket-link-regexp)
  6292. (setq link (org-extract-attributes
  6293. (org-link-unescape (org-match-string-no-properties 1))))
  6294. (while (string-match " *\n *" link)
  6295. (setq link (replace-match " " t t link)))
  6296. (setq link (org-link-expand-abbrev link))
  6297. (cond
  6298. ((or (file-name-absolute-p link)
  6299. (string-match "^\\.\\.?/" link))
  6300. (setq type "file" path link))
  6301. ((string-match org-link-re-with-space3 link)
  6302. (setq type (match-string 1 link) path (match-string 2 link)))
  6303. (t (setq type "thisfile" path link)))
  6304. (throw 'match t)))
  6305. (when (get-text-property (point) 'org-linked-text)
  6306. (setq type "thisfile"
  6307. pos (if (get-text-property (1+ (point)) 'org-linked-text)
  6308. (1+ (point)) (point))
  6309. path (buffer-substring
  6310. (previous-single-property-change pos 'org-linked-text)
  6311. (next-single-property-change pos 'org-linked-text)))
  6312. (throw 'match t))
  6313. (save-excursion
  6314. (when (or (org-in-regexp org-angle-link-re)
  6315. (org-in-regexp org-plain-link-re))
  6316. (setq type (match-string 1) path (match-string 2))
  6317. (throw 'match t)))
  6318. (when (org-in-regexp "\\<\\([^><\n]+\\)\\>")
  6319. (setq type "tree-match"
  6320. path (match-string 1))
  6321. (throw 'match t))
  6322. (save-excursion
  6323. (when (org-in-regexp (org-re "\\(:[[:alnum:]_@:]+\\):[ \t]*$"))
  6324. (setq type "tags"
  6325. path (match-string 1))
  6326. (while (string-match ":" path)
  6327. (setq path (replace-match "+" t t path)))
  6328. (throw 'match t))))
  6329. (unless path
  6330. (error "No link found"))
  6331. ;; Remove any trailing spaces in path
  6332. (if (string-match " +\\'" path)
  6333. (setq path (replace-match "" t t path)))
  6334. (if (and org-link-translation-function
  6335. (fboundp org-link-translation-function))
  6336. ;; Check if we need to translate the link
  6337. (let ((tmp (funcall org-link-translation-function type path)))
  6338. (setq type (car tmp) path (cdr tmp))))
  6339. (cond
  6340. ((assoc type org-link-protocols)
  6341. (funcall (nth 1 (assoc type org-link-protocols)) path))
  6342. ((equal type "mailto")
  6343. (let ((cmd (car org-link-mailto-program))
  6344. (args (cdr org-link-mailto-program)) args1
  6345. (address path) (subject "") a)
  6346. (if (string-match "\\(.*\\)::\\(.*\\)" path)
  6347. (setq address (match-string 1 path)
  6348. subject (org-link-escape (match-string 2 path))))
  6349. (while args
  6350. (cond
  6351. ((not (stringp (car args))) (push (pop args) args1))
  6352. (t (setq a (pop args))
  6353. (if (string-match "%a" a)
  6354. (setq a (replace-match address t t a)))
  6355. (if (string-match "%s" a)
  6356. (setq a (replace-match subject t t a)))
  6357. (push a args1))))
  6358. (apply cmd (nreverse args1))))
  6359. ((member type '("http" "https" "ftp" "news"))
  6360. (browse-url (concat type ":" (org-link-escape
  6361. path org-link-escape-chars-browser))))
  6362. ((member type '("message"))
  6363. (browse-url (concat type ":" path)))
  6364. ((string= type "tags")
  6365. (org-tags-view in-emacs path))
  6366. ((string= type "thisfile")
  6367. (if in-emacs
  6368. (switch-to-buffer-other-window
  6369. (org-get-buffer-for-internal-link (current-buffer)))
  6370. (org-mark-ring-push))
  6371. (let ((cmd `(org-link-search
  6372. ,path
  6373. ,(cond ((equal in-emacs '(4)) 'occur)
  6374. ((equal in-emacs '(16)) 'org-occur)
  6375. (t nil))
  6376. ,pos)))
  6377. (condition-case nil (eval cmd)
  6378. (error (progn (widen) (eval cmd))))))
  6379. ((string= type "tree-match")
  6380. (org-occur (concat "\\[" (regexp-quote path) "\\]")))
  6381. ((string= type "file")
  6382. (if (string-match "::\\([0-9]+\\)\\'" path)
  6383. (setq line (string-to-number (match-string 1 path))
  6384. path (substring path 0 (match-beginning 0)))
  6385. (if (string-match "::\\(.+\\)\\'" path)
  6386. (setq search (match-string 1 path)
  6387. path (substring path 0 (match-beginning 0)))))
  6388. (if (string-match "[*?{]" (file-name-nondirectory path))
  6389. (dired path)
  6390. (org-open-file path in-emacs line search)))
  6391. ((string= type "news")
  6392. (require 'org-gnus)
  6393. (org-gnus-follow-link path))
  6394. ((string= type "shell")
  6395. (let ((cmd path))
  6396. (if (or (not org-confirm-shell-link-function)
  6397. (funcall org-confirm-shell-link-function
  6398. (format "Execute \"%s\" in shell? "
  6399. (org-add-props cmd nil
  6400. 'face 'org-warning))))
  6401. (progn
  6402. (message "Executing %s" cmd)
  6403. (shell-command cmd))
  6404. (error "Abort"))))
  6405. ((string= type "elisp")
  6406. (let ((cmd path))
  6407. (if (or (not org-confirm-elisp-link-function)
  6408. (funcall org-confirm-elisp-link-function
  6409. (format "Execute \"%s\" as elisp? "
  6410. (org-add-props cmd nil
  6411. 'face 'org-warning))))
  6412. (message "%s => %s" cmd
  6413. (if (equal (string-to-char cmd) ?\()
  6414. (eval (read cmd))
  6415. (call-interactively (read cmd))))
  6416. (error "Abort"))))
  6417. (t
  6418. (browse-url-at-point))))))
  6419. (move-marker org-open-link-marker nil)
  6420. (run-hook-with-args 'org-follow-link-hook))
  6421. ;;;; Time estimates
  6422. (defun org-get-effort (&optional pom)
  6423. "Get the effort estimate for the current entry."
  6424. (org-entry-get pom org-effort-property))
  6425. ;;; File search
  6426. (defvar org-create-file-search-functions nil
  6427. "List of functions to construct the right search string for a file link.
  6428. These functions are called in turn with point at the location to
  6429. which the link should point.
  6430. A function in the hook should first test if it would like to
  6431. handle this file type, for example by checking the major-mode or
  6432. the file extension. If it decides not to handle this file, it
  6433. should just return nil to give other functions a chance. If it
  6434. does handle the file, it must return the search string to be used
  6435. when following the link. The search string will be part of the
  6436. file link, given after a double colon, and `org-open-at-point'
  6437. will automatically search for it. If special measures must be
  6438. taken to make the search successful, another function should be
  6439. added to the companion hook `org-execute-file-search-functions',
  6440. which see.
  6441. A function in this hook may also use `setq' to set the variable
  6442. `description' to provide a suggestion for the descriptive text to
  6443. be used for this link when it gets inserted into an Org-mode
  6444. buffer with \\[org-insert-link].")
  6445. (defvar org-execute-file-search-functions nil
  6446. "List of functions to execute a file search triggered by a link.
  6447. Functions added to this hook must accept a single argument, the
  6448. search string that was part of the file link, the part after the
  6449. double colon. The function must first check if it would like to
  6450. handle this search, for example by checking the major-mode or the
  6451. file extension. If it decides not to handle this search, it
  6452. should just return nil to give other functions a chance. If it
  6453. does handle the search, it must return a non-nil value to keep
  6454. other functions from trying.
  6455. Each function can access the current prefix argument through the
  6456. variable `current-prefix-argument'. Note that a single prefix is
  6457. used to force opening a link in Emacs, so it may be good to only
  6458. use a numeric or double prefix to guide the search function.
  6459. In case this is needed, a function in this hook can also restore
  6460. the window configuration before `org-open-at-point' was called using:
  6461. (set-window-configuration org-window-config-before-follow-link)")
  6462. (defun org-link-search (s &optional type avoid-pos)
  6463. "Search for a link search option.
  6464. If S is surrounded by forward slashes, it is interpreted as a
  6465. regular expression. In org-mode files, this will create an `org-occur'
  6466. sparse tree. In ordinary files, `occur' will be used to list matches.
  6467. If the current buffer is in `dired-mode', grep will be used to search
  6468. in all files. If AVOID-POS is given, ignore matches near that position."
  6469. (let ((case-fold-search t)
  6470. (s0 (mapconcat 'identity (org-split-string s "[ \t\r\n]+") " "))
  6471. (markers (concat "\\(?:" (mapconcat (lambda (x) (regexp-quote (car x)))
  6472. (append '(("") (" ") ("\t") ("\n"))
  6473. org-emphasis-alist)
  6474. "\\|") "\\)"))
  6475. (pos (point))
  6476. (pre nil) (post nil)
  6477. words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
  6478. (cond
  6479. ;; First check if there are any special
  6480. ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
  6481. ;; Now try the builtin stuff
  6482. ((save-excursion
  6483. (goto-char (point-min))
  6484. (and
  6485. (re-search-forward
  6486. (concat "<<" (regexp-quote s0) ">>") nil t)
  6487. (setq type 'dedicated
  6488. pos (match-beginning 0))))
  6489. ;; There is an exact target for this
  6490. (goto-char pos))
  6491. ((and (string-match "^(\\(.*\\))$" s0)
  6492. (save-excursion
  6493. (goto-char (point-min))
  6494. (and
  6495. (re-search-forward
  6496. (concat "[^[]" (regexp-quote
  6497. (format org-coderef-label-format
  6498. (match-string 1 s0))))
  6499. nil t)
  6500. (setq type 'dedicated
  6501. pos (1+ (match-beginning 0))))))
  6502. ;; There is a coderef target for this
  6503. (goto-char pos))
  6504. ((string-match "^/\\(.*\\)/$" s)
  6505. ;; A regular expression
  6506. (cond
  6507. ((org-mode-p)
  6508. (org-occur (match-string 1 s)))
  6509. ;;((eq major-mode 'dired-mode)
  6510. ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
  6511. (t (org-do-occur (match-string 1 s)))))
  6512. (t
  6513. ;; A normal search strings
  6514. (when (equal (string-to-char s) ?*)
  6515. ;; Anchor on headlines, post may include tags.
  6516. (setq pre "^\\*+[ \t]+\\(?:\\sw+\\)?[ \t]*"
  6517. post (org-re "[ \t]*\\(?:[ \t]+:[[:alnum:]_@:+]:[ \t]*\\)?$")
  6518. s (substring s 1)))
  6519. (remove-text-properties
  6520. 0 (length s)
  6521. '(face nil mouse-face nil keymap nil fontified nil) s)
  6522. ;; Make a series of regular expressions to find a match
  6523. (setq words (org-split-string s "[ \n\r\t]+")
  6524. re0 (concat "\\(<<" (regexp-quote s0) ">>\\)")
  6525. re2 (concat markers "\\(" (mapconcat 'downcase words "[ \t]+")
  6526. "\\)" markers)
  6527. re2a_ (concat "\\(" (mapconcat 'downcase words "[ \t\r\n]+") "\\)[ \t\r\n]")
  6528. re2a (concat "[ \t\r\n]" re2a_)
  6529. re4_ (concat "\\(" (mapconcat 'downcase words "[^a-zA-Z_\r\n]+") "\\)[^a-zA-Z_]")
  6530. re4 (concat "[^a-zA-Z_]" re4_)
  6531. re1 (concat pre re2 post)
  6532. re3 (concat pre (if pre re4_ re4) post)
  6533. re5 (concat pre ".*" re4)
  6534. re2 (concat pre re2)
  6535. re2a (concat pre (if pre re2a_ re2a))
  6536. re4 (concat pre (if pre re4_ re4))
  6537. reall (concat "\\(" re0 "\\)\\|\\(" re1 "\\)\\|\\(" re2
  6538. "\\)\\|\\(" re3 "\\)\\|\\(" re4 "\\)\\|\\("
  6539. re5 "\\)"
  6540. ))
  6541. (cond
  6542. ((eq type 'org-occur) (org-occur reall))
  6543. ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
  6544. (t (goto-char (point-min))
  6545. (setq type 'fuzzy)
  6546. (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
  6547. (org-search-not-self 1 re1 nil t)
  6548. (org-search-not-self 1 re2 nil t)
  6549. (org-search-not-self 1 re2a nil t)
  6550. (org-search-not-self 1 re3 nil t)
  6551. (org-search-not-self 1 re4 nil t)
  6552. (org-search-not-self 1 re5 nil t)
  6553. )
  6554. (goto-char (match-beginning 1))
  6555. (goto-char pos)
  6556. (error "No match")))))
  6557. (t
  6558. ;; Normal string-search
  6559. (goto-char (point-min))
  6560. (if (search-forward s nil t)
  6561. (goto-char (match-beginning 0))
  6562. (error "No match"))))
  6563. (and (org-mode-p) (org-show-context 'link-search))
  6564. type))
  6565. (defun org-search-not-self (group &rest args)
  6566. "Execute `re-search-forward', but only accept matches that do not
  6567. enclose the position of `org-open-link-marker'."
  6568. (let ((m org-open-link-marker))
  6569. (catch 'exit
  6570. (while (apply 're-search-forward args)
  6571. (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
  6572. (goto-char (match-end group))
  6573. (if (and (or (not (eq (marker-buffer m) (current-buffer)))
  6574. (> (match-beginning 0) (marker-position m))
  6575. (< (match-end 0) (marker-position m)))
  6576. (save-match-data
  6577. (or (not (org-in-regexp
  6578. org-bracket-link-analytic-regexp 1))
  6579. (not (match-end 4)) ; no description
  6580. (and (<= (match-beginning 4) (point))
  6581. (>= (match-end 4) (point))))))
  6582. (throw 'exit (point))))))))
  6583. (defun org-get-buffer-for-internal-link (buffer)
  6584. "Return a buffer to be used for displaying the link target of internal links."
  6585. (cond
  6586. ((not org-display-internal-link-with-indirect-buffer)
  6587. buffer)
  6588. ((string-match "(Clone)$" (buffer-name buffer))
  6589. (message "Buffer is already a clone, not making another one")
  6590. ;; we also do not modify visibility in this case
  6591. buffer)
  6592. (t ; make a new indirect buffer for displaying the link
  6593. (let* ((bn (buffer-name buffer))
  6594. (ibn (concat bn "(Clone)"))
  6595. (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
  6596. (with-current-buffer ib (org-overview))
  6597. ib))))
  6598. (defun org-do-occur (regexp &optional cleanup)
  6599. "Call the Emacs command `occur'.
  6600. If CLEANUP is non-nil, remove the printout of the regular expression
  6601. in the *Occur* buffer. This is useful if the regex is long and not useful
  6602. to read."
  6603. (occur regexp)
  6604. (when cleanup
  6605. (let ((cwin (selected-window)) win beg end)
  6606. (when (setq win (get-buffer-window "*Occur*"))
  6607. (select-window win))
  6608. (goto-char (point-min))
  6609. (when (re-search-forward "match[a-z]+" nil t)
  6610. (setq beg (match-end 0))
  6611. (if (re-search-forward "^[ \t]*[0-9]+" nil t)
  6612. (setq end (1- (match-beginning 0)))))
  6613. (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
  6614. (goto-char (point-min))
  6615. (select-window cwin))))
  6616. ;;; The mark ring for links jumps
  6617. (defvar org-mark-ring nil
  6618. "Mark ring for positions before jumps in Org-mode.")
  6619. (defvar org-mark-ring-last-goto nil
  6620. "Last position in the mark ring used to go back.")
  6621. ;; Fill and close the ring
  6622. (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
  6623. (loop for i from 1 to org-mark-ring-length do
  6624. (push (make-marker) org-mark-ring))
  6625. (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
  6626. org-mark-ring)
  6627. (defun org-mark-ring-push (&optional pos buffer)
  6628. "Put the current position or POS into the mark ring and rotate it."
  6629. (interactive)
  6630. (setq pos (or pos (point)))
  6631. (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
  6632. (move-marker (car org-mark-ring)
  6633. (or pos (point))
  6634. (or buffer (current-buffer)))
  6635. (message "%s"
  6636. (substitute-command-keys
  6637. "Position saved to mark ring, go back with \\[org-mark-ring-goto].")))
  6638. (defun org-mark-ring-goto (&optional n)
  6639. "Jump to the previous position in the mark ring.
  6640. With prefix arg N, jump back that many stored positions. When
  6641. called several times in succession, walk through the entire ring.
  6642. Org-mode commands jumping to a different position in the current file,
  6643. or to another Org-mode file, automatically push the old position
  6644. onto the ring."
  6645. (interactive "p")
  6646. (let (p m)
  6647. (if (eq last-command this-command)
  6648. (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
  6649. (setq p org-mark-ring))
  6650. (setq org-mark-ring-last-goto p)
  6651. (setq m (car p))
  6652. (switch-to-buffer (marker-buffer m))
  6653. (goto-char m)
  6654. (if (or (org-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
  6655. (defun org-remove-angle-brackets (s)
  6656. (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
  6657. (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
  6658. s)
  6659. (defun org-add-angle-brackets (s)
  6660. (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
  6661. (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
  6662. s)
  6663. (defun org-remove-double-quotes (s)
  6664. (if (equal (substring s 0 1) "\"") (setq s (substring s 1)))
  6665. (if (equal (substring s -1) "\"") (setq s (substring s 0 -1)))
  6666. s)
  6667. ;;; Following specific links
  6668. (defun org-follow-timestamp-link ()
  6669. (cond
  6670. ((org-at-date-range-p t)
  6671. (let ((org-agenda-start-on-weekday)
  6672. (t1 (match-string 1))
  6673. (t2 (match-string 2)))
  6674. (setq t1 (time-to-days (org-time-string-to-time t1))
  6675. t2 (time-to-days (org-time-string-to-time t2)))
  6676. (org-agenda-list nil t1 (1+ (- t2 t1)))))
  6677. ((org-at-timestamp-p t)
  6678. (org-agenda-list nil (time-to-days (org-time-string-to-time
  6679. (substring (match-string 1) 0 10)))
  6680. 1))
  6681. (t (error "This should not happen"))))
  6682. ;;; Following file links
  6683. (defvar org-wait nil)
  6684. (defun org-open-file (path &optional in-emacs line search)
  6685. "Open the file at PATH.
  6686. First, this expands any special file name abbreviations. Then the
  6687. configuration variable `org-file-apps' is checked if it contains an
  6688. entry for this file type, and if yes, the corresponding command is launched.
  6689. If no application is found, Emacs simply visits the file.
  6690. With optional prefix argument IN-EMACS, Emacs will visit the file.
  6691. With a double C-c C-u prefix arg, Org tries to avoid opening in Emacs
  6692. and o use an external application to visit the file.
  6693. Optional LINE specifies a line to go to, optional SEARCH a string to
  6694. search for. If LINE or SEARCH is given, the file will always be
  6695. opened in Emacs.
  6696. If the file does not exist, an error is thrown."
  6697. (setq in-emacs (or in-emacs line search))
  6698. (let* ((file (if (equal path "")
  6699. buffer-file-name
  6700. (substitute-in-file-name (expand-file-name path))))
  6701. (apps (append org-file-apps (org-default-apps)))
  6702. (remp (and (assq 'remote apps) (org-file-remote-p file)))
  6703. (dirp (if remp nil (file-directory-p file)))
  6704. (file (if (and dirp org-open-directory-means-index-dot-org)
  6705. (concat (file-name-as-directory file) "index.org")
  6706. file))
  6707. (a-m-a-p (assq 'auto-mode apps))
  6708. (dfile (downcase file))
  6709. (old-buffer (current-buffer))
  6710. (old-pos (point))
  6711. (old-mode major-mode)
  6712. ext cmd)
  6713. (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\.gz\\)$" dfile)
  6714. (setq ext (match-string 1 dfile))
  6715. (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\)$" dfile)
  6716. (setq ext (match-string 1 dfile))))
  6717. (cond
  6718. ((equal in-emacs '(16))
  6719. (setq cmd (cdr (assoc 'system apps))))
  6720. (in-emacs (setq cmd 'emacs))
  6721. (t
  6722. (setq cmd (or (and remp (cdr (assoc 'remote apps)))
  6723. (and dirp (cdr (assoc 'directory apps)))
  6724. (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
  6725. 'string-match)
  6726. (cdr (assoc ext apps))
  6727. (cdr (assoc t apps))))))
  6728. (when (eq cmd 'system)
  6729. (setq cmd (cdr (assoc 'system apps))))
  6730. (when (eq cmd 'default)
  6731. (setq cmd (cdr (assoc t apps))))
  6732. (when (eq cmd 'mailcap)
  6733. (require 'mailcap)
  6734. (mailcap-parse-mailcaps)
  6735. (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
  6736. (command (mailcap-mime-info mime-type)))
  6737. (if (stringp command)
  6738. (setq cmd command)
  6739. (setq cmd 'emacs))))
  6740. (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
  6741. (not (file-exists-p file))
  6742. (not org-open-non-existing-files))
  6743. (error "No such file: %s" file))
  6744. (cond
  6745. ((and (stringp cmd) (not (string-match "^\\s-*$" cmd)))
  6746. ;; Remove quotes around the file name - we'll use shell-quote-argument.
  6747. (while (string-match "['\"]%s['\"]" cmd)
  6748. (setq cmd (replace-match "%s" t t cmd)))
  6749. (while (string-match "%s" cmd)
  6750. (setq cmd (replace-match
  6751. (save-match-data
  6752. (shell-quote-argument
  6753. (convert-standard-filename file)))
  6754. t t cmd)))
  6755. (save-window-excursion
  6756. (start-process-shell-command cmd nil cmd)
  6757. (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
  6758. ))
  6759. ((or (stringp cmd)
  6760. (eq cmd 'emacs))
  6761. (funcall (cdr (assq 'file org-link-frame-setup)) file)
  6762. (widen)
  6763. (if line (goto-line line)
  6764. (if search (org-link-search search))))
  6765. ((consp cmd)
  6766. (let ((file (convert-standard-filename file)))
  6767. (eval cmd)))
  6768. (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
  6769. (and (org-mode-p) (eq old-mode 'org-mode)
  6770. (or (not (equal old-buffer (current-buffer)))
  6771. (not (equal old-pos (point))))
  6772. (org-mark-ring-push old-pos old-buffer))))
  6773. (defun org-default-apps ()
  6774. "Return the default applications for this operating system."
  6775. (cond
  6776. ((eq system-type 'darwin)
  6777. org-file-apps-defaults-macosx)
  6778. ((eq system-type 'windows-nt)
  6779. org-file-apps-defaults-windowsnt)
  6780. (t org-file-apps-defaults-gnu)))
  6781. (defun org-apps-regexp-alist (list &optional add-auto-mode)
  6782. "Convert extensions to regular expressions in the cars of LIST.
  6783. Also, weed out any non-string entries, because the return value is used
  6784. only for regexp matching.
  6785. When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
  6786. point to the symbol `emacs', indicating that the file should
  6787. be opened in Emacs."
  6788. (append
  6789. (delq nil
  6790. (mapcar (lambda (x)
  6791. (if (not (stringp (car x)))
  6792. nil
  6793. (if (string-match "\\W" (car x))
  6794. x
  6795. (cons (concat "\\." (car x) "\\'") (cdr x)))))
  6796. list))
  6797. (if add-auto-mode
  6798. (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
  6799. (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
  6800. (defun org-file-remote-p (file)
  6801. "Test whether FILE specifies a location on a remote system.
  6802. Return non-nil if the location is indeed remote.
  6803. For example, the filename \"/user@host:/foo\" specifies a location
  6804. on the system \"/user@host:\"."
  6805. (cond ((fboundp 'file-remote-p)
  6806. (file-remote-p file))
  6807. ((fboundp 'tramp-handle-file-remote-p)
  6808. (tramp-handle-file-remote-p file))
  6809. ((and (boundp 'ange-ftp-name-format)
  6810. (string-match (car ange-ftp-name-format) file))
  6811. t)
  6812. (t nil)))
  6813. ;;;; Refiling
  6814. (defun org-get-org-file ()
  6815. "Read a filename, with default directory `org-directory'."
  6816. (let ((default (or org-default-notes-file remember-data-file)))
  6817. (read-file-name (format "File name [%s]: " default)
  6818. (file-name-as-directory org-directory)
  6819. default)))
  6820. (defun org-notes-order-reversed-p ()
  6821. "Check if the current file should receive notes in reversed order."
  6822. (cond
  6823. ((not org-reverse-note-order) nil)
  6824. ((eq t org-reverse-note-order) t)
  6825. ((not (listp org-reverse-note-order)) nil)
  6826. (t (catch 'exit
  6827. (let ((all org-reverse-note-order)
  6828. entry)
  6829. (while (setq entry (pop all))
  6830. (if (string-match (car entry) buffer-file-name)
  6831. (throw 'exit (cdr entry))))
  6832. nil)))))
  6833. (defvar org-refile-target-table nil
  6834. "The list of refile targets, created by `org-refile'.")
  6835. (defvar org-agenda-new-buffers nil
  6836. "Buffers created to visit agenda files.")
  6837. (defun org-get-refile-targets (&optional default-buffer)
  6838. "Produce a table with refile targets."
  6839. (let ((entries (or org-refile-targets '((nil . (:level . 1)))))
  6840. targets txt re files f desc descre fast-path-p level)
  6841. (message "Getting targets...")
  6842. (with-current-buffer (or default-buffer (current-buffer))
  6843. (while (setq entry (pop entries))
  6844. (setq files (car entry) desc (cdr entry))
  6845. (setq fast-path-p nil)
  6846. (cond
  6847. ((null files) (setq files (list (current-buffer))))
  6848. ((eq files 'org-agenda-files)
  6849. (setq files (org-agenda-files 'unrestricted)))
  6850. ((and (symbolp files) (fboundp files))
  6851. (setq files (funcall files)))
  6852. ((and (symbolp files) (boundp files))
  6853. (setq files (symbol-value files))))
  6854. (if (stringp files) (setq files (list files)))
  6855. (cond
  6856. ((eq (car desc) :tag)
  6857. (setq descre (concat "^\\*+[ \t]+.*?:" (regexp-quote (cdr desc)) ":")))
  6858. ((eq (car desc) :todo)
  6859. (setq descre (concat "^\\*+[ \t]+" (regexp-quote (cdr desc)) "[ \t]")))
  6860. ((eq (car desc) :regexp)
  6861. (setq descre (cdr desc)))
  6862. ((eq (car desc) :level)
  6863. (setq descre (concat "^\\*\\{" (number-to-string
  6864. (if org-odd-levels-only
  6865. (1- (* 2 (cdr desc)))
  6866. (cdr desc)))
  6867. "\\}[ \t]")))
  6868. ((eq (car desc) :maxlevel)
  6869. (setq fast-path-p t)
  6870. (setq descre (concat "^\\*\\{1," (number-to-string
  6871. (if org-odd-levels-only
  6872. (1- (* 2 (cdr desc)))
  6873. (cdr desc)))
  6874. "\\}[ \t]")))
  6875. (t (error "Bad refiling target description %s" desc)))
  6876. (while (setq f (pop files))
  6877. (save-excursion
  6878. (set-buffer (if (bufferp f) f (org-get-agenda-file-buffer f)))
  6879. (if (bufferp f) (setq f (buffer-file-name (buffer-base-buffer f))))
  6880. (setq f (expand-file-name f))
  6881. (save-excursion
  6882. (save-restriction
  6883. (widen)
  6884. (goto-char (point-min))
  6885. (while (re-search-forward descre nil t)
  6886. (goto-char (point-at-bol))
  6887. (when (looking-at org-complex-heading-regexp)
  6888. (setq level (org-reduced-level (- (match-end 1) (match-beginning 1)))
  6889. txt (org-link-display-format (match-string 4))
  6890. re (concat "^" (regexp-quote
  6891. (buffer-substring (match-beginning 1)
  6892. (match-end 4)))))
  6893. (if (match-end 5) (setq re (concat re "[ \t]+"
  6894. (regexp-quote
  6895. (match-string 5)))))
  6896. (setq re (concat re "[ \t]*$"))
  6897. (when org-refile-use-outline-path
  6898. (setq txt (mapconcat 'org-protect-slash
  6899. (append
  6900. (if (eq org-refile-use-outline-path 'file)
  6901. (list (file-name-nondirectory
  6902. (buffer-file-name (buffer-base-buffer))))
  6903. (if (eq org-refile-use-outline-path 'full-file-path)
  6904. (list (buffer-file-name (buffer-base-buffer)))))
  6905. (org-get-outline-path fast-path-p level txt)
  6906. (list txt))
  6907. "/")))
  6908. (push (list txt f re (point)) targets))
  6909. (goto-char (point-at-eol))))))))
  6910. (message "Getting targets...done")
  6911. (nreverse targets))))
  6912. (defun org-protect-slash (s)
  6913. (while (string-match "/" s)
  6914. (setq s (replace-match "\\" t t s)))
  6915. s)
  6916. (defvar org-olpa (make-vector 20 nil))
  6917. (defun org-get-outline-path (&optional fastp level heading)
  6918. "Return the outline path to the current entry, as a list."
  6919. (if fastp
  6920. (progn
  6921. (if (> level 19)
  6922. (error "Outline path failure, more than 19 levels."))
  6923. (loop for i from level upto 19 do
  6924. (aset org-olpa i nil))
  6925. (prog1
  6926. (delq nil (append org-olpa nil))
  6927. (aset org-olpa level heading)))
  6928. (let (rtn)
  6929. (save-excursion
  6930. (while (org-up-heading-safe)
  6931. (when (looking-at org-complex-heading-regexp)
  6932. (push (org-match-string-no-properties 4) rtn)))
  6933. rtn))))
  6934. (defvar org-refile-history nil
  6935. "History for refiling operations.")
  6936. (defun org-refile (&optional goto default-buffer)
  6937. "Move the entry at point to another heading.
  6938. The list of target headings is compiled using the information in
  6939. `org-refile-targets', which see. This list is created before each use
  6940. and will therefore always be up-to-date.
  6941. At the target location, the entry is filed as a subitem of the target heading.
  6942. Depending on `org-reverse-note-order', the new subitem will either be the
  6943. first or the last subitem.
  6944. If there is an active region, all entries in that region will be moved.
  6945. However, the region must fulfil the requirement that the first heading
  6946. is the first one sets the top-level of the moved text - at most siblings
  6947. below it are allowed.
  6948. With prefix arg GOTO, the command will only visit the target location,
  6949. not actually move anything.
  6950. With a double prefix `C-u C-u', go to the location where the last refiling
  6951. operation has put the subtree."
  6952. (interactive "P")
  6953. (let* ((cbuf (current-buffer))
  6954. (regionp (org-region-active-p))
  6955. (region-start (and regionp (region-beginning)))
  6956. (region-end (and regionp (region-end)))
  6957. (region-length (and regionp (- region-end region-start)))
  6958. (filename (buffer-file-name (buffer-base-buffer cbuf)))
  6959. pos it nbuf file re level reversed)
  6960. (when regionp (goto-char region-start)
  6961. (unless (org-kill-is-subtree-p
  6962. (buffer-substring region-start region-end))
  6963. (error "The region is not a (sequence of) subtree(s)")))
  6964. (if (equal goto '(16))
  6965. (org-refile-goto-last-stored)
  6966. (when (setq it (org-refile-get-location
  6967. (if goto "Goto: " "Refile to: ") default-buffer))
  6968. (setq file (nth 1 it)
  6969. re (nth 2 it)
  6970. pos (nth 3 it))
  6971. (if (and (equal (buffer-file-name) file)
  6972. (if regionp
  6973. (and (>= pos region-start)
  6974. (<= pos region-end))
  6975. (and (>= pos (point))
  6976. (< pos (save-excursion
  6977. (org-end-of-subtree t t))))))
  6978. (error "Cannot refile to position inside the tree or region"))
  6979. (setq nbuf (or (find-buffer-visiting file)
  6980. (find-file-noselect file)))
  6981. (if goto
  6982. (progn
  6983. (switch-to-buffer nbuf)
  6984. (goto-char pos)
  6985. (org-show-context 'org-goto))
  6986. (if regionp
  6987. (progn
  6988. (kill-new (buffer-substring region-start region-end))
  6989. (org-save-markers-in-region region-start region-end))
  6990. (org-copy-subtree 1 nil t))
  6991. (save-excursion
  6992. (set-buffer (setq nbuf (or (find-buffer-visiting file)
  6993. (find-file-noselect file))))
  6994. (setq reversed (org-notes-order-reversed-p))
  6995. (save-excursion
  6996. (save-restriction
  6997. (widen)
  6998. (goto-char pos)
  6999. (looking-at outline-regexp)
  7000. (setq level (org-get-valid-level (funcall outline-level) 1))
  7001. (goto-char
  7002. (if reversed
  7003. (or (outline-next-heading) (point-max))
  7004. (or (save-excursion (outline-get-next-sibling))
  7005. (org-end-of-subtree t t)
  7006. (point-max))))
  7007. (if (not (bolp)) (newline))
  7008. (bookmark-set "org-refile-last-stored")
  7009. (org-paste-subtree level))))
  7010. (if regionp
  7011. (delete-region (point) (+ (point) region-length))
  7012. (org-cut-subtree))
  7013. (setq org-markers-to-move nil)
  7014. (message "Refiled to \"%s\"" (car it)))))))
  7015. (defun org-refile-goto-last-stored ()
  7016. "Go to the location where the last refile was stored."
  7017. (interactive)
  7018. (bookmark-jump "org-refile-last-stored")
  7019. (message "This is the location of the last refile"))
  7020. (defun org-refile-get-location (&optional prompt default-buffer)
  7021. "Prompt the user for a refile location, using PROMPT."
  7022. (let ((org-refile-targets org-refile-targets)
  7023. (org-refile-use-outline-path org-refile-use-outline-path))
  7024. (setq org-refile-target-table (org-get-refile-targets default-buffer)))
  7025. (unless org-refile-target-table
  7026. (error "No refile targets"))
  7027. (let* ((cbuf (current-buffer))
  7028. (cfn (buffer-file-name (buffer-base-buffer cbuf)))
  7029. (cfunc (if (and org-refile-use-outline-path
  7030. org-outline-path-complete-in-steps)
  7031. 'org-olpath-completing-read
  7032. 'org-ido-completing-read))
  7033. (extra (if org-refile-use-outline-path "/" ""))
  7034. (filename (and cfn (expand-file-name cfn)))
  7035. (tbl (mapcar
  7036. (lambda (x)
  7037. (if (not (equal filename (nth 1 x)))
  7038. (cons (concat (car x) extra " ("
  7039. (file-name-nondirectory (nth 1 x)) ")")
  7040. (cdr x))
  7041. (cons (concat (car x) extra) (cdr x))))
  7042. org-refile-target-table))
  7043. (completion-ignore-case t))
  7044. (assoc (funcall cfunc prompt tbl nil t nil 'org-refile-history)
  7045. tbl)))
  7046. (defun org-olpath-completing-read (prompt collection &rest args)
  7047. "Read an outline path like a file name."
  7048. (let ((thetable collection))
  7049. (apply
  7050. 'org-ido-completing-read prompt
  7051. (lambda (string predicate &optional flag)
  7052. (let (rtn r s f (l (length string)))
  7053. (cond
  7054. ((eq flag nil)
  7055. ;; try completion
  7056. (try-completion string thetable))
  7057. ((eq flag t)
  7058. ;; all-completions
  7059. (setq rtn (all-completions string thetable predicate))
  7060. (mapcar
  7061. (lambda (x)
  7062. (setq r (substring x l))
  7063. (if (string-match " ([^)]*)$" x)
  7064. (setq f (match-string 0 x))
  7065. (setq f ""))
  7066. (if (string-match "/" r)
  7067. (concat string (substring r 0 (match-end 0)) f)
  7068. x))
  7069. rtn))
  7070. ((eq flag 'lambda)
  7071. ;; exact match?
  7072. (assoc string thetable)))
  7073. ))
  7074. args)))
  7075. ;;;; Dynamic blocks
  7076. (defun org-find-dblock (name)
  7077. "Find the first dynamic block with name NAME in the buffer.
  7078. If not found, stay at current position and return nil."
  7079. (let (pos)
  7080. (save-excursion
  7081. (goto-char (point-min))
  7082. (setq pos (and (re-search-forward (concat "^#\\+BEGIN:[ \t]+" name "\\>")
  7083. nil t)
  7084. (match-beginning 0))))
  7085. (if pos (goto-char pos))
  7086. pos))
  7087. (defconst org-dblock-start-re
  7088. "^#\\+BEGIN:[ \t]+\\(\\S-+\\)\\([ \t]+\\(.*\\)\\)?"
  7089. "Matches the startline of a dynamic block, with parameters.")
  7090. (defconst org-dblock-end-re "^#\\+END\\([: \t\r\n]\\|$\\)"
  7091. "Matches the end of a dynamic block.")
  7092. (defun org-create-dblock (plist)
  7093. "Create a dynamic block section, with parameters taken from PLIST.
  7094. PLIST must contain a :name entry which is used as name of the block."
  7095. (unless (bolp) (newline))
  7096. (let ((name (plist-get plist :name)))
  7097. (insert "#+BEGIN: " name)
  7098. (while plist
  7099. (if (eq (car plist) :name)
  7100. (setq plist (cddr plist))
  7101. (insert " " (prin1-to-string (pop plist)))))
  7102. (insert "\n\n#+END:\n")
  7103. (beginning-of-line -2)))
  7104. (defun org-prepare-dblock ()
  7105. "Prepare dynamic block for refresh.
  7106. This empties the block, puts the cursor at the insert position and returns
  7107. the property list including an extra property :name with the block name."
  7108. (unless (looking-at org-dblock-start-re)
  7109. (error "Not at a dynamic block"))
  7110. (let* ((begdel (1+ (match-end 0)))
  7111. (name (org-no-properties (match-string 1)))
  7112. (params (append (list :name name)
  7113. (read (concat "(" (match-string 3) ")")))))
  7114. (unless (re-search-forward org-dblock-end-re nil t)
  7115. (error "Dynamic block not terminated"))
  7116. (setq params
  7117. (append params
  7118. (list :content (buffer-substring
  7119. begdel (match-beginning 0)))))
  7120. (delete-region begdel (match-beginning 0))
  7121. (goto-char begdel)
  7122. (open-line 1)
  7123. params))
  7124. (defun org-map-dblocks (&optional command)
  7125. "Apply COMMAND to all dynamic blocks in the current buffer.
  7126. If COMMAND is not given, use `org-update-dblock'."
  7127. (let ((cmd (or command 'org-update-dblock))
  7128. pos)
  7129. (save-excursion
  7130. (goto-char (point-min))
  7131. (while (re-search-forward org-dblock-start-re nil t)
  7132. (goto-char (setq pos (match-beginning 0)))
  7133. (condition-case nil
  7134. (funcall cmd)
  7135. (error (message "Error during update of dynamic block")))
  7136. (goto-char pos)
  7137. (unless (re-search-forward org-dblock-end-re nil t)
  7138. (error "Dynamic block not terminated"))))))
  7139. (defun org-dblock-update (&optional arg)
  7140. "User command for updating dynamic blocks.
  7141. Update the dynamic block at point. With prefix ARG, update all dynamic
  7142. blocks in the buffer."
  7143. (interactive "P")
  7144. (if arg
  7145. (org-update-all-dblocks)
  7146. (or (looking-at org-dblock-start-re)
  7147. (org-beginning-of-dblock))
  7148. (org-update-dblock)))
  7149. (defun org-update-dblock ()
  7150. "Update the dynamic block at point
  7151. This means to empty the block, parse for parameters and then call
  7152. the correct writing function."
  7153. (save-window-excursion
  7154. (let* ((pos (point))
  7155. (line (org-current-line))
  7156. (params (org-prepare-dblock))
  7157. (name (plist-get params :name))
  7158. (cmd (intern (concat "org-dblock-write:" name))))
  7159. (message "Updating dynamic block `%s' at line %d..." name line)
  7160. (funcall cmd params)
  7161. (message "Updating dynamic block `%s' at line %d...done" name line)
  7162. (goto-char pos))))
  7163. (defun org-beginning-of-dblock ()
  7164. "Find the beginning of the dynamic block at point.
  7165. Error if there is no such block at point."
  7166. (let ((pos (point))
  7167. beg)
  7168. (end-of-line 1)
  7169. (if (and (re-search-backward org-dblock-start-re nil t)
  7170. (setq beg (match-beginning 0))
  7171. (re-search-forward org-dblock-end-re nil t)
  7172. (> (match-end 0) pos))
  7173. (goto-char beg)
  7174. (goto-char pos)
  7175. (error "Not in a dynamic block"))))
  7176. (defun org-update-all-dblocks ()
  7177. "Update all dynamic blocks in the buffer.
  7178. This function can be used in a hook."
  7179. (when (org-mode-p)
  7180. (org-map-dblocks 'org-update-dblock)))
  7181. ;;;; Completion
  7182. (defconst org-additional-option-like-keywords
  7183. '("BEGIN_HTML" "BEGIN_LaTeX" "END_HTML" "END_LaTeX"
  7184. "ORGTBL" "HTML:" "LaTeX:" "BEGIN:" "END:" "TBLFM"
  7185. "BEGIN_EXAMPLE" "END_EXAMPLE"
  7186. "BEGIN_QUOTE" "END_QUOTE"
  7187. "BEGIN_VERSE" "END_VERSE"
  7188. "BEGIN_SRC" "END_SRC"
  7189. "CAPTION" "LABEL" "ATTR_HTML" "ATTR_LaTeX"))
  7190. (defcustom org-structure-template-alist
  7191. '(
  7192. ("s" "#+begin_src ?\n\n#+end_src"
  7193. "<src lang=\"?\">\n\n</src>")
  7194. ("e" "#+begin_example\n?\n#+end_example"
  7195. "<example>\n?\n</example>")
  7196. ("q" "#+begin_quote\n?\n#+end_quote"
  7197. "<quote>\n?\n</quote>")
  7198. ("v" "#+begin_verse\n?\n#+end_verse"
  7199. "<verse>\n?\n/verse>")
  7200. ("l" "#+begin_latex\n?\n#+end_latex"
  7201. "<literal style=\"latex\">\n?\n</literal>")
  7202. ("L" "#+latex: "
  7203. "<literal style=\"latex\">?</literal>")
  7204. ("h" "#+begin_html\n?\n#+end_html"
  7205. "<literal style=\"html\">\n?\n</literal>")
  7206. ("H" "#+html: "
  7207. "<literal style=\"html\">?</literal>")
  7208. ("a" "#+begin_ascii\n?\n#+end_ascii")
  7209. ("A" "#+ascii: ")
  7210. ("i" "#+include %file ?"
  7211. "<include file=%file markup=\"?\">")
  7212. )
  7213. "Structure completion elements.
  7214. This is a list of abbreviation keys and values. The value gets inserted
  7215. it you type @samp{.} followed by the key and then the completion key,
  7216. usually `M-TAB'. %file will be replaced by a file name after prompting
  7217. for the file using completion.
  7218. There are two templates for each key, the first uses the original Org syntax,
  7219. the second uses Emacs Muse-like syntax tags. These Muse-like tags become
  7220. the default when the /org-mtags.el/ module has been loaded. See also the
  7221. variable `org-mtags-prefer-muse-templates'.
  7222. This is an experimental feature, it is undecided if it is going to stay in."
  7223. :group 'org-completion
  7224. :type '(repeat
  7225. (string :tag "Key")
  7226. (string :tag "Template")
  7227. (string :tag "Muse Template")))
  7228. (defun org-try-structure-completion ()
  7229. "Try to complete a structure template before point.
  7230. This looks for strings like \"<e\" on an otherwise empty line and
  7231. expands them."
  7232. (let ((l (buffer-substring (point-at-bol) (point)))
  7233. a)
  7234. (when (and (looking-at "[ \t]*$")
  7235. (string-match "^[ \t]*<\\([a-z]+\\)$"l)
  7236. (setq a (assoc (match-string 1 l) org-structure-template-alist)))
  7237. (org-complete-expand-structure-template (+ -1 (point-at-bol)
  7238. (match-beginning 1)) a)
  7239. t)))
  7240. (defun org-complete-expand-structure-template (start cell)
  7241. "Expand a structure template."
  7242. (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
  7243. (rpl (nth (if musep 2 1) cell)))
  7244. (delete-region start (point))
  7245. (when (string-match "\\`#\\+" rpl)
  7246. (cond
  7247. ((bolp))
  7248. ((not (string-match "\\S-" (buffer-substring (point-at-bol) (point))))
  7249. (delete-region (point-at-bol) (point)))
  7250. (t (newline))))
  7251. (setq start (point))
  7252. (if (string-match "%file" rpl)
  7253. (setq rpl (replace-match
  7254. (concat
  7255. "\""
  7256. (save-match-data
  7257. (abbreviate-file-name (read-file-name "Include file: ")))
  7258. "\"")
  7259. t t rpl)))
  7260. (insert rpl)
  7261. (if (re-search-backward "\\?" start t) (delete-char 1))))
  7262. (defun org-complete (&optional arg)
  7263. "Perform completion on word at point.
  7264. At the beginning of a headline, this completes TODO keywords as given in
  7265. `org-todo-keywords'.
  7266. If the current word is preceded by a backslash, completes the TeX symbols
  7267. that are supported for HTML support.
  7268. If the current word is preceded by \"#+\", completes special words for
  7269. setting file options.
  7270. In the line after \"#+STARTUP:, complete valid keywords.\"
  7271. At all other locations, this simply calls the value of
  7272. `org-completion-fallback-command'."
  7273. (interactive "P")
  7274. (org-without-partial-completion
  7275. (catch 'exit
  7276. (let* ((a nil)
  7277. (end (point))
  7278. (beg1 (save-excursion
  7279. (skip-chars-backward (org-re "[:alnum:]_@"))
  7280. (point)))
  7281. (beg (save-excursion
  7282. (skip-chars-backward "a-zA-Z0-9_:$")
  7283. (point)))
  7284. (confirm (lambda (x) (stringp (car x))))
  7285. (searchhead (equal (char-before beg) ?*))
  7286. (struct
  7287. (when (and (member (char-before beg1) '(?. ?<))
  7288. (setq a (assoc (buffer-substring beg1 (point))
  7289. org-structure-template-alist)))
  7290. (org-complete-expand-structure-template (1- beg1) a)
  7291. (throw 'exit t)))
  7292. (tag (and (equal (char-before beg1) ?:)
  7293. (equal (char-after (point-at-bol)) ?*)))
  7294. (prop (and (equal (char-before beg1) ?:)
  7295. (not (equal (char-after (point-at-bol)) ?*))))
  7296. (texp (equal (char-before beg) ?\\))
  7297. (link (equal (char-before beg) ?\[))
  7298. (opt (equal (buffer-substring (max (point-at-bol) (- beg 2))
  7299. beg)
  7300. "#+"))
  7301. (startup (string-match "^#\\+STARTUP:.*"
  7302. (buffer-substring (point-at-bol) (point))))
  7303. (completion-ignore-case opt)
  7304. (type nil)
  7305. (tbl nil)
  7306. (table (cond
  7307. (opt
  7308. (setq type :opt)
  7309. (require 'org-exp)
  7310. (append
  7311. (mapcar
  7312. (lambda (x)
  7313. (string-match "^#\\+\\(\\([A-Z_]+:?\\).*\\)" x)
  7314. (cons (match-string 2 x) (match-string 1 x)))
  7315. (org-split-string (org-get-current-options) "\n"))
  7316. (mapcar 'list org-additional-option-like-keywords)))
  7317. (startup
  7318. (setq type :startup)
  7319. org-startup-options)
  7320. (link (append org-link-abbrev-alist-local
  7321. org-link-abbrev-alist))
  7322. (texp
  7323. (setq type :tex)
  7324. org-html-entities)
  7325. ((string-match "\\`\\*+[ \t]+\\'"
  7326. (buffer-substring (point-at-bol) beg))
  7327. (setq type :todo)
  7328. (mapcar 'list org-todo-keywords-1))
  7329. (searchhead
  7330. (setq type :searchhead)
  7331. (save-excursion
  7332. (goto-char (point-min))
  7333. (while (re-search-forward org-todo-line-regexp nil t)
  7334. (push (list
  7335. (org-make-org-heading-search-string
  7336. (match-string 3) t))
  7337. tbl)))
  7338. tbl)
  7339. (tag (setq type :tag beg beg1)
  7340. (or org-tag-alist (org-get-buffer-tags)))
  7341. (prop (setq type :prop beg beg1)
  7342. (mapcar 'list (org-buffer-property-keys nil t t)))
  7343. (t (progn
  7344. (call-interactively org-completion-fallback-command)
  7345. (throw 'exit nil)))))
  7346. (pattern (buffer-substring-no-properties beg end))
  7347. (completion (try-completion pattern table confirm)))
  7348. (cond ((eq completion t)
  7349. (if (not (assoc (upcase pattern) table))
  7350. (message "Already complete")
  7351. (if (and (equal type :opt)
  7352. (not (member (car (assoc (upcase pattern) table))
  7353. org-additional-option-like-keywords)))
  7354. (insert (substring (cdr (assoc (upcase pattern) table))
  7355. (length pattern)))
  7356. (if (memq type '(:tag :prop)) (insert ":")))))
  7357. ((null completion)
  7358. (message "Can't find completion for \"%s\"" pattern)
  7359. (ding))
  7360. ((not (string= pattern completion))
  7361. (delete-region beg end)
  7362. (if (string-match " +$" completion)
  7363. (setq completion (replace-match "" t t completion)))
  7364. (insert completion)
  7365. (if (get-buffer-window "*Completions*")
  7366. (delete-window (get-buffer-window "*Completions*")))
  7367. (if (assoc completion table)
  7368. (if (eq type :todo) (insert " ")
  7369. (if (memq type '(:tag :prop)) (insert ":"))))
  7370. (if (and (equal type :opt) (assoc completion table))
  7371. (message "%s" (substitute-command-keys
  7372. "Press \\[org-complete] again to insert example settings"))))
  7373. (t
  7374. (message "Making completion list...")
  7375. (let ((list (sort (all-completions pattern table confirm)
  7376. 'string<)))
  7377. (with-output-to-temp-buffer "*Completions*"
  7378. (condition-case nil
  7379. ;; Protection needed for XEmacs and emacs 21
  7380. (display-completion-list list pattern)
  7381. (error (display-completion-list list)))))
  7382. (message "Making completion list...%s" "done")))))))
  7383. ;;;; TODO, DEADLINE, Comments
  7384. (defun org-toggle-comment ()
  7385. "Change the COMMENT state of an entry."
  7386. (interactive)
  7387. (save-excursion
  7388. (org-back-to-heading)
  7389. (let (case-fold-search)
  7390. (if (looking-at (concat outline-regexp
  7391. "\\( *\\<" org-comment-string "\\>[ \t]*\\)"))
  7392. (replace-match "" t t nil 1)
  7393. (if (looking-at outline-regexp)
  7394. (progn
  7395. (goto-char (match-end 0))
  7396. (insert org-comment-string " ")))))))
  7397. (defvar org-last-todo-state-is-todo nil
  7398. "This is non-nil when the last TODO state change led to a TODO state.
  7399. If the last change removed the TODO tag or switched to DONE, then
  7400. this is nil.")
  7401. (defvar org-setting-tags nil) ; dynamically skipped
  7402. (defun org-parse-local-options (string var)
  7403. "Parse STRING for startup setting relevant for variable VAR."
  7404. (let ((rtn (symbol-value var))
  7405. e opts)
  7406. (save-match-data
  7407. (if (or (not string) (not (string-match "\\S-" string)))
  7408. rtn
  7409. (setq opts (delq nil (mapcar (lambda (x)
  7410. (setq e (assoc x org-startup-options))
  7411. (if (eq (nth 1 e) var) e nil))
  7412. (org-split-string string "[ \t]+"))))
  7413. (if (not opts)
  7414. rtn
  7415. (setq rtn nil)
  7416. (while (setq e (pop opts))
  7417. (if (not (nth 3 e))
  7418. (setq rtn (nth 2 e))
  7419. (if (not (listp rtn)) (setq rtn nil))
  7420. (push (nth 2 e) rtn)))
  7421. rtn)))))
  7422. (defvar org-blocker-hook nil
  7423. "Hook for functions that are allowed to block a state change.
  7424. Each function gets as its single argument a property list, see
  7425. `org-trigger-hook' for more information about this list.
  7426. If any of the functions in this hook returns nil, the state change
  7427. is blocked.")
  7428. (defvar org-trigger-hook nil
  7429. "Hook for functions that are triggered by a state change.
  7430. Each function gets as its single argument a property list with at least
  7431. the following elements:
  7432. (:type type-of-change :position pos-at-entry-start
  7433. :from old-state :to new-state)
  7434. Depending on the type, more properties may be present.
  7435. This mechanism is currently implemented for:
  7436. TODO state changes
  7437. ------------------
  7438. :type todo-state-change
  7439. :from previous state (keyword as a string), or nil
  7440. :to new state (keyword as a string), or nil")
  7441. (defvar org-agenda-headline-snapshot-before-repeat)
  7442. (defun org-todo (&optional arg)
  7443. "Change the TODO state of an item.
  7444. The state of an item is given by a keyword at the start of the heading,
  7445. like
  7446. *** TODO Write paper
  7447. *** DONE Call mom
  7448. The different keywords are specified in the variable `org-todo-keywords'.
  7449. By default the available states are \"TODO\" and \"DONE\".
  7450. So for this example: when the item starts with TODO, it is changed to DONE.
  7451. When it starts with DONE, the DONE is removed. And when neither TODO nor
  7452. DONE are present, add TODO at the beginning of the heading.
  7453. With C-u prefix arg, use completion to determine the new state.
  7454. With numeric prefix arg, switch to that state.
  7455. For calling through lisp, arg is also interpreted in the following way:
  7456. 'none -> empty state
  7457. \"\"(empty string) -> switch to empty state
  7458. 'done -> switch to DONE
  7459. 'nextset -> switch to the next set of keywords
  7460. 'previousset -> switch to the previous set of keywords
  7461. \"WAITING\" -> switch to the specified keyword, but only if it
  7462. really is a member of `org-todo-keywords'."
  7463. (interactive "P")
  7464. (save-excursion
  7465. (catch 'exit
  7466. (org-back-to-heading)
  7467. (if (looking-at outline-regexp) (goto-char (1- (match-end 0))))
  7468. (or (looking-at (concat " +" org-todo-regexp " *"))
  7469. (looking-at " *"))
  7470. (let* ((match-data (match-data))
  7471. (startpos (point-at-bol))
  7472. (logging (save-match-data (org-entry-get nil "LOGGING" t)))
  7473. (org-log-done org-log-done)
  7474. (org-log-repeat org-log-repeat)
  7475. (org-todo-log-states org-todo-log-states)
  7476. (this (match-string 1))
  7477. (hl-pos (match-beginning 0))
  7478. (head (org-get-todo-sequence-head this))
  7479. (ass (assoc head org-todo-kwd-alist))
  7480. (interpret (nth 1 ass))
  7481. (done-word (nth 3 ass))
  7482. (final-done-word (nth 4 ass))
  7483. (last-state (or this ""))
  7484. (completion-ignore-case t)
  7485. (member (member this org-todo-keywords-1))
  7486. (tail (cdr member))
  7487. (state (cond
  7488. ((and org-todo-key-trigger
  7489. (or (and (equal arg '(4)) (eq org-use-fast-todo-selection 'prefix))
  7490. (and (not arg) org-use-fast-todo-selection
  7491. (not (eq org-use-fast-todo-selection 'prefix)))))
  7492. ;; Use fast selection
  7493. (org-fast-todo-selection))
  7494. ((and (equal arg '(4))
  7495. (or (not org-use-fast-todo-selection)
  7496. (not org-todo-key-trigger)))
  7497. ;; Read a state with completion
  7498. (org-ido-completing-read "State: " (mapcar (lambda(x) (list x))
  7499. org-todo-keywords-1)
  7500. nil t))
  7501. ((eq arg 'right)
  7502. (if this
  7503. (if tail (car tail) nil)
  7504. (car org-todo-keywords-1)))
  7505. ((eq arg 'left)
  7506. (if (equal member org-todo-keywords-1)
  7507. nil
  7508. (if this
  7509. (nth (- (length org-todo-keywords-1) (length tail) 2)
  7510. org-todo-keywords-1)
  7511. (org-last org-todo-keywords-1))))
  7512. ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
  7513. (setq arg nil))) ; hack to fall back to cycling
  7514. (arg
  7515. ;; user or caller requests a specific state
  7516. (cond
  7517. ((equal arg "") nil)
  7518. ((eq arg 'none) nil)
  7519. ((eq arg 'done) (or done-word (car org-done-keywords)))
  7520. ((eq arg 'nextset)
  7521. (or (car (cdr (member head org-todo-heads)))
  7522. (car org-todo-heads)))
  7523. ((eq arg 'previousset)
  7524. (let ((org-todo-heads (reverse org-todo-heads)))
  7525. (or (car (cdr (member head org-todo-heads)))
  7526. (car org-todo-heads))))
  7527. ((car (member arg org-todo-keywords-1)))
  7528. ((nth (1- (prefix-numeric-value arg))
  7529. org-todo-keywords-1))))
  7530. ((null member) (or head (car org-todo-keywords-1)))
  7531. ((equal this final-done-word) nil) ;; -> make empty
  7532. ((null tail) nil) ;; -> first entry
  7533. ((eq interpret 'sequence)
  7534. (car tail))
  7535. ((memq interpret '(type priority))
  7536. (if (eq this-command last-command)
  7537. (car tail)
  7538. (if (> (length tail) 0)
  7539. (or done-word (car org-done-keywords))
  7540. nil)))
  7541. (t nil)))
  7542. (next (if state (concat " " state " ") " "))
  7543. (change-plist (list :type 'todo-state-change :from this :to state
  7544. :position startpos))
  7545. dolog now-done-p)
  7546. (when org-blocker-hook
  7547. (unless (save-excursion
  7548. (save-match-data
  7549. (run-hook-with-args-until-failure
  7550. 'org-blocker-hook change-plist)))
  7551. (if (interactive-p)
  7552. (error "TODO state change from %s to %s blocked" this state)
  7553. ;; fail silently
  7554. (message "TODO state change from %s to %s blocked" this state)
  7555. (throw 'exit nil))))
  7556. (store-match-data match-data)
  7557. (replace-match next t t)
  7558. (unless (pos-visible-in-window-p hl-pos)
  7559. (message "TODO state changed to %s" (org-trim next)))
  7560. (unless head
  7561. (setq head (org-get-todo-sequence-head state)
  7562. ass (assoc head org-todo-kwd-alist)
  7563. interpret (nth 1 ass)
  7564. done-word (nth 3 ass)
  7565. final-done-word (nth 4 ass)))
  7566. (when (memq arg '(nextset previousset))
  7567. (message "Keyword-Set %d/%d: %s"
  7568. (- (length org-todo-sets) -1
  7569. (length (memq (assoc state org-todo-sets) org-todo-sets)))
  7570. (length org-todo-sets)
  7571. (mapconcat 'identity (assoc state org-todo-sets) " ")))
  7572. (setq org-last-todo-state-is-todo
  7573. (not (member state org-done-keywords)))
  7574. (setq now-done-p (and (member state org-done-keywords)
  7575. (not (member this org-done-keywords))))
  7576. (and logging (org-local-logging logging))
  7577. (when (and (or org-todo-log-states org-log-done)
  7578. (not (memq arg '(nextset previousset))))
  7579. ;; we need to look at recording a time and note
  7580. (setq dolog (or (nth 1 (assoc state org-todo-log-states))
  7581. (nth 2 (assoc this org-todo-log-states))))
  7582. (when (and state
  7583. (member state org-not-done-keywords)
  7584. (not (member this org-not-done-keywords)))
  7585. ;; This is now a todo state and was not one before
  7586. ;; If there was a CLOSED time stamp, get rid of it.
  7587. (org-add-planning-info nil nil 'closed))
  7588. (when (and now-done-p org-log-done)
  7589. ;; It is now done, and it was not done before
  7590. (org-add-planning-info 'closed (org-current-time))
  7591. (if (and (not dolog) (eq 'note org-log-done))
  7592. (org-add-log-setup 'done state 'findpos 'note)))
  7593. (when (and state dolog)
  7594. ;; This is a non-nil state, and we need to log it
  7595. (org-add-log-setup 'state state 'findpos dolog)))
  7596. ;; Fixup tag positioning
  7597. (org-todo-trigger-tag-changes state)
  7598. (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
  7599. (when org-provide-todo-statistics
  7600. (org-update-parent-todo-statistics))
  7601. (run-hooks 'org-after-todo-state-change-hook)
  7602. (if (and arg (not (member state org-done-keywords)))
  7603. (setq head (org-get-todo-sequence-head state)))
  7604. (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
  7605. ;; Do we need to trigger a repeat?
  7606. (when now-done-p
  7607. (when (boundp 'org-agenda-headline-snapshot-before-repeat)
  7608. ;; This is for the agenda, take a snapshot of the headline.
  7609. (save-match-data
  7610. (setq org-agenda-headline-snapshot-before-repeat
  7611. (org-get-heading))))
  7612. (org-auto-repeat-maybe state))
  7613. ;; Fixup cursor location if close to the keyword
  7614. (if (and (outline-on-heading-p)
  7615. (not (bolp))
  7616. (save-excursion (beginning-of-line 1)
  7617. (looking-at org-todo-line-regexp))
  7618. (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
  7619. (progn
  7620. (goto-char (or (match-end 2) (match-end 1)))
  7621. (just-one-space)))
  7622. (when org-trigger-hook
  7623. (save-excursion
  7624. (run-hook-with-args 'org-trigger-hook change-plist)))))))
  7625. (defun org-update-parent-todo-statistics ()
  7626. "Update any statistics cookie in the parent of the current headline."
  7627. (interactive)
  7628. (let ((box-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
  7629. level (cnt-all 0) (cnt-done 0) is-percent kwd)
  7630. (catch 'exit
  7631. (save-excursion
  7632. (setq level (org-up-heading-safe))
  7633. (unless (and level
  7634. (re-search-forward box-re (point-at-eol) t))
  7635. (throw 'exit nil))
  7636. (setq is-percent (match-end 2))
  7637. (save-match-data
  7638. (unless (outline-next-heading) (throw 'exit nil))
  7639. (while (looking-at org-todo-line-regexp)
  7640. (setq kwd (match-string 2))
  7641. (and kwd (setq cnt-all (1+ cnt-all)))
  7642. (and (member kwd org-done-keywords)
  7643. (setq cnt-done (1+ cnt-done)))
  7644. (condition-case nil
  7645. (org-forward-same-level 1)
  7646. (error (end-of-line 1)))))
  7647. (replace-match
  7648. (if is-percent
  7649. (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
  7650. (format "[%d/%d]" cnt-done cnt-all)))
  7651. (run-hook-with-args 'org-after-todo-statistics-hook
  7652. cnt-done (- cnt-all cnt-done))))))
  7653. (defvar org-after-todo-statistics-hook nil
  7654. "Hook that is called after a TODO statistics cookie has been updated.
  7655. Each function is called with two arguments: the number of not-done entries
  7656. and the number of done entries.
  7657. For example, the following function, when added to this hook, will switch
  7658. an entry to DONE when all children are done, and back to TODO when new
  7659. entries are set to a TODO status. Note that this hook is only called
  7660. when there is a statistics cookie in the headline!
  7661. (defun org-summary-todo (n-done n-not-done)
  7662. \"Switch entry to DONE when all subentries are done, to TODO otherwise.\"
  7663. (let (org-log-done org-log-states) ; turn off logging
  7664. (org-todo (if (= n-not-done 0) \"DONE\" \"TODO\"))))
  7665. ")
  7666. (defun org-todo-trigger-tag-changes (state)
  7667. "Apply the changes defined in `org-todo-state-tags-triggers'."
  7668. (let ((l org-todo-state-tags-triggers)
  7669. changes)
  7670. (when (or (not state) (equal state ""))
  7671. (setq changes (append changes (cdr (assoc "" l)))))
  7672. (when (and (stringp state) (> (length state) 0))
  7673. (setq changes (append changes (cdr (assoc state l)))))
  7674. (when (member state org-not-done-keywords)
  7675. (setq changes (append changes (cdr (assoc 'todo l)))))
  7676. (when (member state org-done-keywords)
  7677. (setq changes (append changes (cdr (assoc 'done l)))))
  7678. (dolist (c changes)
  7679. (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
  7680. (defun org-local-logging (value)
  7681. "Get logging settings from a property VALUE."
  7682. (let* (words w a)
  7683. ;; directly set the variables, they are already local.
  7684. (setq org-log-done nil
  7685. org-log-repeat nil
  7686. org-todo-log-states nil)
  7687. (setq words (org-split-string value))
  7688. (while (setq w (pop words))
  7689. (cond
  7690. ((setq a (assoc w org-startup-options))
  7691. (and (member (nth 1 a) '(org-log-done org-log-repeat))
  7692. (set (nth 1 a) (nth 2 a))))
  7693. ((setq a (org-extract-log-state-settings w))
  7694. (and (member (car a) org-todo-keywords-1)
  7695. (push a org-todo-log-states)))))))
  7696. (defun org-get-todo-sequence-head (kwd)
  7697. "Return the head of the TODO sequence to which KWD belongs.
  7698. If KWD is not set, check if there is a text property remembering the
  7699. right sequence."
  7700. (let (p)
  7701. (cond
  7702. ((not kwd)
  7703. (or (get-text-property (point-at-bol) 'org-todo-head)
  7704. (progn
  7705. (setq p (next-single-property-change (point-at-bol) 'org-todo-head
  7706. nil (point-at-eol)))
  7707. (get-text-property p 'org-todo-head))))
  7708. ((not (member kwd org-todo-keywords-1))
  7709. (car org-todo-keywords-1))
  7710. (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
  7711. (defun org-fast-todo-selection ()
  7712. "Fast TODO keyword selection with single keys.
  7713. Returns the new TODO keyword, or nil if no state change should occur."
  7714. (let* ((fulltable org-todo-key-alist)
  7715. (done-keywords org-done-keywords) ;; needed for the faces.
  7716. (maxlen (apply 'max (mapcar
  7717. (lambda (x)
  7718. (if (stringp (car x)) (string-width (car x)) 0))
  7719. fulltable)))
  7720. (expert nil)
  7721. (fwidth (+ maxlen 3 1 3))
  7722. (ncol (/ (- (window-width) 4) fwidth))
  7723. tg cnt e c tbl
  7724. groups ingroup)
  7725. (save-window-excursion
  7726. (if expert
  7727. (set-buffer (get-buffer-create " *Org todo*"))
  7728. (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
  7729. (erase-buffer)
  7730. (org-set-local 'org-done-keywords done-keywords)
  7731. (setq tbl fulltable cnt 0)
  7732. (while (setq e (pop tbl))
  7733. (cond
  7734. ((equal e '(:startgroup))
  7735. (push '() groups) (setq ingroup t)
  7736. (when (not (= cnt 0))
  7737. (setq cnt 0)
  7738. (insert "\n"))
  7739. (insert "{ "))
  7740. ((equal e '(:endgroup))
  7741. (setq ingroup nil cnt 0)
  7742. (insert "}\n"))
  7743. (t
  7744. (setq tg (car e) c (cdr e))
  7745. (if ingroup (push tg (car groups)))
  7746. (setq tg (org-add-props tg nil 'face
  7747. (org-get-todo-face tg)))
  7748. (if (and (= cnt 0) (not ingroup)) (insert " "))
  7749. (insert "[" c "] " tg (make-string
  7750. (- fwidth 4 (length tg)) ?\ ))
  7751. (when (= (setq cnt (1+ cnt)) ncol)
  7752. (insert "\n")
  7753. (if ingroup (insert " "))
  7754. (setq cnt 0)))))
  7755. (insert "\n")
  7756. (goto-char (point-min))
  7757. (if (not expert) (org-fit-window-to-buffer))
  7758. (message "[a-z..]:Set [SPC]:clear")
  7759. (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
  7760. (cond
  7761. ((or (= c ?\C-g)
  7762. (and (= c ?q) (not (rassoc c fulltable))))
  7763. (setq quit-flag t))
  7764. ((= c ?\ ) nil)
  7765. ((setq e (rassoc c fulltable) tg (car e))
  7766. tg)
  7767. (t (setq quit-flag t))))))
  7768. (defun org-entry-is-todo-p ()
  7769. (member (org-get-todo-state) org-not-done-keywords))
  7770. (defun org-entry-is-done-p ()
  7771. (member (org-get-todo-state) org-done-keywords))
  7772. (defun org-get-todo-state ()
  7773. (save-excursion
  7774. (org-back-to-heading t)
  7775. (and (looking-at org-todo-line-regexp)
  7776. (match-end 2)
  7777. (match-string 2))))
  7778. (defun org-at-date-range-p (&optional inactive-ok)
  7779. "Is the cursor inside a date range?"
  7780. (interactive)
  7781. (save-excursion
  7782. (catch 'exit
  7783. (let ((pos (point)))
  7784. (skip-chars-backward "^[<\r\n")
  7785. (skip-chars-backward "<[")
  7786. (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
  7787. (>= (match-end 0) pos)
  7788. (throw 'exit t))
  7789. (skip-chars-backward "^<[\r\n")
  7790. (skip-chars-backward "<[")
  7791. (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
  7792. (>= (match-end 0) pos)
  7793. (throw 'exit t)))
  7794. nil)))
  7795. (defun org-get-repeat ()
  7796. "Check if there is a deadline/schedule with repeater in this entry."
  7797. (save-match-data
  7798. (save-excursion
  7799. (org-back-to-heading t)
  7800. (if (re-search-forward
  7801. org-repeat-re (save-excursion (outline-next-heading) (point)) t)
  7802. (match-string 1)))))
  7803. (defvar org-last-changed-timestamp)
  7804. (defvar org-last-inserted-timestamp)
  7805. (defvar org-log-post-message)
  7806. (defvar org-log-note-purpose)
  7807. (defvar org-log-note-how)
  7808. (defvar org-log-note-extra)
  7809. (defun org-auto-repeat-maybe (done-word)
  7810. "Check if the current headline contains a repeated deadline/schedule.
  7811. If yes, set TODO state back to what it was and change the base date
  7812. of repeating deadline/scheduled time stamps to new date.
  7813. This function is run automatically after each state change to a DONE state."
  7814. ;; last-state is dynamically scoped into this function
  7815. (let* ((repeat (org-get-repeat))
  7816. (aa (assoc last-state org-todo-kwd-alist))
  7817. (interpret (nth 1 aa))
  7818. (head (nth 2 aa))
  7819. (whata '(("d" . day) ("m" . month) ("y" . year)))
  7820. (msg "Entry repeats: ")
  7821. (org-log-done nil)
  7822. (org-todo-log-states nil)
  7823. (nshiftmax 10) (nshift 0)
  7824. re type n what ts mb0 time)
  7825. (when repeat
  7826. (if (eq org-log-repeat t) (setq org-log-repeat 'state))
  7827. (org-todo (if (eq interpret 'type) last-state head))
  7828. (when org-log-repeat
  7829. (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
  7830. (memq 'org-add-log-note post-command-hook))
  7831. ;; OK, we are already setup for some record
  7832. (if (eq org-log-repeat 'note)
  7833. ;; make sure we take a note, not only a time stamp
  7834. (setq org-log-note-how 'note))
  7835. ;; Set up for taking a record
  7836. (org-add-log-setup 'state (or done-word (car org-done-keywords))
  7837. 'findpos org-log-repeat)))
  7838. (org-back-to-heading t)
  7839. (org-add-planning-info nil nil 'closed)
  7840. (setq re (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
  7841. org-deadline-time-regexp "\\)\\|\\("
  7842. org-ts-regexp "\\)"))
  7843. (while (re-search-forward
  7844. re (save-excursion (outline-next-heading) (point)) t)
  7845. (setq type (if (match-end 1) org-scheduled-string
  7846. (if (match-end 3) org-deadline-string "Plain:"))
  7847. ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0)))
  7848. mb0 (match-beginning 0))
  7849. (when (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([dwmy]\\)" ts)
  7850. (setq n (string-to-number (match-string 2 ts))
  7851. what (match-string 3 ts))
  7852. (if (equal what "w") (setq n (* n 7) what "d"))
  7853. ;; Preparation, see if we need to modify the start date for the change
  7854. (when (match-end 1)
  7855. (setq time (save-match-data (org-time-string-to-time ts)))
  7856. (cond
  7857. ((equal (match-string 1 ts) ".")
  7858. ;; Shift starting date to today
  7859. (org-timestamp-change
  7860. (- (time-to-days (current-time)) (time-to-days time))
  7861. 'day))
  7862. ((equal (match-string 1 ts) "+")
  7863. (while (or (= nshift 0)
  7864. (<= (time-to-days time) (time-to-days (current-time))))
  7865. (when (= (incf nshift) nshiftmax)
  7866. (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
  7867. (error "Abort")))
  7868. (org-timestamp-change n (cdr (assoc what whata)))
  7869. (org-at-timestamp-p t)
  7870. (setq ts (match-string 1))
  7871. (setq time (save-match-data (org-time-string-to-time ts))))
  7872. (org-timestamp-change (- n) (cdr (assoc what whata)))
  7873. ;; rematch, so that we have everything in place for the real shift
  7874. (org-at-timestamp-p t)
  7875. (setq ts (match-string 1))
  7876. (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([dwmy]\\)" ts))))
  7877. (org-timestamp-change n (cdr (assoc what whata)))
  7878. (setq msg (concat msg type " " org-last-changed-timestamp " "))))
  7879. (setq org-log-post-message msg)
  7880. (message "%s" msg))))
  7881. (defun org-show-todo-tree (arg)
  7882. "Make a compact tree which shows all headlines marked with TODO.
  7883. The tree will show the lines where the regexp matches, and all higher
  7884. headlines above the match.
  7885. With a \\[universal-argument] prefix, also show the DONE entries.
  7886. With a numeric prefix N, construct a sparse tree for the Nth element
  7887. of `org-todo-keywords-1'."
  7888. (interactive "P")
  7889. (let ((case-fold-search nil)
  7890. (kwd-re
  7891. (cond ((null arg) org-not-done-regexp)
  7892. ((equal arg '(4))
  7893. (let ((kwd (org-ido-completing-read "Keyword (or KWD1|KWD2|...): "
  7894. (mapcar 'list org-todo-keywords-1))))
  7895. (concat "\\("
  7896. (mapconcat 'identity (org-split-string kwd "|") "\\|")
  7897. "\\)\\>")))
  7898. ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
  7899. (regexp-quote (nth (1- (prefix-numeric-value arg))
  7900. org-todo-keywords-1)))
  7901. (t (error "Invalid prefix argument: %s" arg)))))
  7902. (message "%d TODO entries found"
  7903. (org-occur (concat "^" outline-regexp " *" kwd-re )))))
  7904. (defun org-deadline (&optional remove time)
  7905. "Insert the \"DEADLINE:\" string with a timestamp to make a deadline.
  7906. With argument REMOVE, remove any deadline from the item.
  7907. When TIME is set, it should be an internal time specification, and the
  7908. scheduling will use the corresponding date."
  7909. (interactive "P")
  7910. (if remove
  7911. (progn
  7912. (org-remove-timestamp-with-keyword org-deadline-string)
  7913. (message "Item no longer has a deadline."))
  7914. (if (org-get-repeat)
  7915. (error "Cannot change deadline on task with repeater, please do that by hand")
  7916. (org-add-planning-info 'deadline time 'closed)
  7917. (message "Deadline on %s" org-last-inserted-timestamp))))
  7918. (defun org-schedule (&optional remove time)
  7919. "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
  7920. With argument REMOVE, remove any scheduling date from the item.
  7921. When TIME is set, it should be an internal time specification, and the
  7922. scheduling will use the corresponding date."
  7923. (interactive "P")
  7924. (if remove
  7925. (progn
  7926. (org-remove-timestamp-with-keyword org-scheduled-string)
  7927. (message "Item is no longer scheduled."))
  7928. (if (org-get-repeat)
  7929. (error "Cannot reschedule task with repeater, please do that by hand")
  7930. (org-add-planning-info 'scheduled time 'closed)
  7931. (message "Scheduled to %s" org-last-inserted-timestamp))))
  7932. (defun org-remove-timestamp-with-keyword (keyword)
  7933. "Remove all time stamps with KEYWORD in the current entry."
  7934. (let ((re (concat "\\<" (regexp-quote keyword) " +<[^>\n]+>[ \t]*"))
  7935. beg)
  7936. (save-excursion
  7937. (org-back-to-heading t)
  7938. (setq beg (point))
  7939. (org-end-of-subtree t t)
  7940. (while (re-search-backward re beg t)
  7941. (replace-match "")
  7942. (if (and (string-match "\\S-" (buffer-substring (point-at-bol) (point)))
  7943. (equal (char-before) ?\ ))
  7944. (backward-delete-char 1)
  7945. (if (string-match "^[ \t]*$" (buffer-substring
  7946. (point-at-bol) (point-at-eol)))
  7947. (delete-region (point-at-bol)
  7948. (min (point-max) (1+ (point-at-eol))))))))))
  7949. (defun org-add-planning-info (what &optional time &rest remove)
  7950. "Insert new timestamp with keyword in the line directly after the headline.
  7951. WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
  7952. If non is given, the user is prompted for a date.
  7953. REMOVE indicates what kind of entries to remove. An old WHAT entry will also
  7954. be removed."
  7955. (interactive)
  7956. (let (org-time-was-given org-end-time-was-given ts
  7957. end default-time default-input)
  7958. (when (and (not time) (memq what '(scheduled deadline)))
  7959. ;; Try to get a default date/time from existing timestamp
  7960. (save-excursion
  7961. (org-back-to-heading t)
  7962. (setq end (save-excursion (outline-next-heading) (point)))
  7963. (when (re-search-forward (if (eq what 'scheduled)
  7964. org-scheduled-time-regexp
  7965. org-deadline-time-regexp)
  7966. end t)
  7967. (setq ts (match-string 1)
  7968. default-time
  7969. (apply 'encode-time (org-parse-time-string ts))
  7970. default-input (and ts (org-get-compact-tod ts))))))
  7971. (when what
  7972. ;; If necessary, get the time from the user
  7973. (setq time (or time (org-read-date nil 'to-time nil nil
  7974. default-time default-input))))
  7975. (when (and org-insert-labeled-timestamps-at-point
  7976. (member what '(scheduled deadline)))
  7977. (insert
  7978. (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
  7979. (org-insert-time-stamp time org-time-was-given
  7980. nil nil nil (list org-end-time-was-given))
  7981. (setq what nil))
  7982. (save-excursion
  7983. (save-restriction
  7984. (let (col list elt ts buffer-invisibility-spec)
  7985. (org-back-to-heading t)
  7986. (looking-at (concat outline-regexp "\\( *\\)[^\r\n]*"))
  7987. (goto-char (match-end 1))
  7988. (setq col (current-column))
  7989. (goto-char (match-end 0))
  7990. (if (eobp) (insert "\n") (forward-char 1))
  7991. (if (and (not (looking-at outline-regexp))
  7992. (looking-at (concat "[^\r\n]*?" org-keyword-time-regexp
  7993. "[^\r\n]*"))
  7994. (not (equal (match-string 1) org-clock-string)))
  7995. (narrow-to-region (match-beginning 0) (match-end 0))
  7996. (insert-before-markers "\n")
  7997. (backward-char 1)
  7998. (narrow-to-region (point) (point))
  7999. (and org-adapt-indentation (org-indent-to-column col)))
  8000. ;; Check if we have to remove something.
  8001. (setq list (cons what remove))
  8002. (while list
  8003. (setq elt (pop list))
  8004. (goto-char (point-min))
  8005. (when (or (and (eq elt 'scheduled)
  8006. (re-search-forward org-scheduled-time-regexp nil t))
  8007. (and (eq elt 'deadline)
  8008. (re-search-forward org-deadline-time-regexp nil t))
  8009. (and (eq elt 'closed)
  8010. (re-search-forward org-closed-time-regexp nil t)))
  8011. (replace-match "")
  8012. (if (looking-at "--+<[^>]+>") (replace-match ""))
  8013. (if (looking-at " +") (replace-match ""))))
  8014. (goto-char (point-max))
  8015. (when what
  8016. (insert
  8017. (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
  8018. (cond ((eq what 'scheduled) org-scheduled-string)
  8019. ((eq what 'deadline) org-deadline-string)
  8020. ((eq what 'closed) org-closed-string))
  8021. " ")
  8022. (setq ts (org-insert-time-stamp
  8023. time
  8024. (or org-time-was-given
  8025. (and (eq what 'closed) org-log-done-with-time))
  8026. (eq what 'closed)
  8027. nil nil (list org-end-time-was-given)))
  8028. (end-of-line 1))
  8029. (goto-char (point-min))
  8030. (widen)
  8031. (if (and (looking-at "[ \t]+\n")
  8032. (equal (char-before) ?\n))
  8033. (delete-region (1- (point)) (point-at-eol)))
  8034. ts)))))
  8035. (defvar org-log-note-marker (make-marker))
  8036. (defvar org-log-note-purpose nil)
  8037. (defvar org-log-note-state nil)
  8038. (defvar org-log-note-how nil)
  8039. (defvar org-log-note-extra nil)
  8040. (defvar org-log-note-window-configuration nil)
  8041. (defvar org-log-note-return-to (make-marker))
  8042. (defvar org-log-post-message nil
  8043. "Message to be displayed after a log note has been stored.
  8044. The auto-repeater uses this.")
  8045. (defun org-add-note ()
  8046. "Add a note to the current entry.
  8047. This is done in the same way as adding a state change note."
  8048. (interactive)
  8049. (org-add-log-setup 'note nil 'findpos nil))
  8050. (defvar org-property-end-re)
  8051. (defun org-add-log-setup (&optional purpose state findpos how &optional extra)
  8052. "Set up the post command hook to take a note.
  8053. If this is about to TODO state change, the new state is expected in STATE.
  8054. When FINDPOS is non-nil, find the correct position for the note in
  8055. the current entry. If not, assume that it can be inserted at point.
  8056. HOW is an indicator what kind of note should be created.
  8057. EXTRA is additional text that will be inserted into the notes buffer."
  8058. (save-restriction
  8059. (save-excursion
  8060. (when findpos
  8061. (org-back-to-heading t)
  8062. (narrow-to-region (point) (save-excursion
  8063. (outline-next-heading) (point)))
  8064. (looking-at (concat outline-regexp "\\( *\\)[^\r\n]*"
  8065. "\\(\n[^\r\n]*?" org-keyword-time-not-clock-regexp
  8066. "[^\r\n]*\\)?"))
  8067. (goto-char (match-end 0))
  8068. (when (and org-log-state-notes-insert-after-drawers
  8069. (save-excursion
  8070. (forward-line) (looking-at org-drawer-regexp)))
  8071. (progn (forward-line)
  8072. (while (looking-at org-drawer-regexp)
  8073. (goto-char (match-end 0))
  8074. (re-search-forward org-property-end-re (point-max) t)
  8075. (forward-line))
  8076. (forward-line -1)))
  8077. (unless org-log-states-order-reversed
  8078. (and (= (char-after) ?\n) (forward-char 1))
  8079. (org-skip-over-state-notes)
  8080. (skip-chars-backward " \t\n\r")))
  8081. (move-marker org-log-note-marker (point))
  8082. (setq org-log-note-purpose purpose
  8083. org-log-note-state state
  8084. org-log-note-how how
  8085. org-log-note-extra extra)
  8086. (add-hook 'post-command-hook 'org-add-log-note 'append))))
  8087. (defun org-skip-over-state-notes ()
  8088. "Skip past the list of State notes in an entry."
  8089. (if (looking-at "\n[ \t]*- State") (forward-char 1))
  8090. (while (looking-at "[ \t]*- State")
  8091. (condition-case nil
  8092. (org-next-item)
  8093. (error (org-end-of-item)))))
  8094. (defun org-add-log-note (&optional purpose)
  8095. "Pop up a window for taking a note, and add this note later at point."
  8096. (remove-hook 'post-command-hook 'org-add-log-note)
  8097. (setq org-log-note-window-configuration (current-window-configuration))
  8098. (delete-other-windows)
  8099. (move-marker org-log-note-return-to (point))
  8100. (switch-to-buffer (marker-buffer org-log-note-marker))
  8101. (goto-char org-log-note-marker)
  8102. (org-switch-to-buffer-other-window "*Org Note*")
  8103. (erase-buffer)
  8104. (if (memq org-log-note-how '(time state))
  8105. (let (current-prefix-arg) (org-store-log-note))
  8106. (let ((org-inhibit-startup t)) (org-mode))
  8107. (insert (format "# Insert note for %s.
  8108. # Finish with C-c C-c, or cancel with C-c C-k.\n\n"
  8109. (cond
  8110. ((eq org-log-note-purpose 'clock-out) "stopped clock")
  8111. ((eq org-log-note-purpose 'done) "closed todo item")
  8112. ((eq org-log-note-purpose 'state)
  8113. (format "state change to \"%s\"" org-log-note-state))
  8114. ((eq org-log-note-purpose 'note)
  8115. "this entry")
  8116. (t (error "This should not happen")))))
  8117. (if org-log-note-extra (insert org-log-note-extra))
  8118. (org-set-local 'org-finish-function 'org-store-log-note)))
  8119. (defvar org-note-abort nil) ; dynamically scoped
  8120. (defun org-store-log-note ()
  8121. "Finish taking a log note, and insert it to where it belongs."
  8122. (let ((txt (buffer-string))
  8123. (note (cdr (assq org-log-note-purpose org-log-note-headings)))
  8124. lines ind)
  8125. (kill-buffer (current-buffer))
  8126. (while (string-match "\\`#.*\n[ \t\n]*" txt)
  8127. (setq txt (replace-match "" t t txt)))
  8128. (if (string-match "\\s-+\\'" txt)
  8129. (setq txt (replace-match "" t t txt)))
  8130. (setq lines (org-split-string txt "\n"))
  8131. (when (and note (string-match "\\S-" note))
  8132. (setq note
  8133. (org-replace-escapes
  8134. note
  8135. (list (cons "%u" (user-login-name))
  8136. (cons "%U" user-full-name)
  8137. (cons "%t" (format-time-string
  8138. (org-time-stamp-format 'long 'inactive)
  8139. (current-time)))
  8140. (cons "%s" (if org-log-note-state
  8141. (concat "\"" org-log-note-state "\"")
  8142. "")))))
  8143. (if lines (setq note (concat note " \\\\")))
  8144. (push note lines))
  8145. (when (or current-prefix-arg org-note-abort) (setq lines nil))
  8146. (when lines
  8147. (save-excursion
  8148. (set-buffer (marker-buffer org-log-note-marker))
  8149. (save-excursion
  8150. (goto-char org-log-note-marker)
  8151. (move-marker org-log-note-marker nil)
  8152. (end-of-line 1)
  8153. (if (not (bolp)) (let ((inhibit-read-only t)) (insert "\n")))
  8154. (indent-relative nil)
  8155. (insert "- " (pop lines))
  8156. (org-indent-line-function)
  8157. (beginning-of-line 1)
  8158. (looking-at "[ \t]*")
  8159. (setq ind (concat (match-string 0) " "))
  8160. (end-of-line 1)
  8161. (while lines (insert "\n" ind (pop lines)))))))
  8162. (set-window-configuration org-log-note-window-configuration)
  8163. (with-current-buffer (marker-buffer org-log-note-return-to)
  8164. (goto-char org-log-note-return-to))
  8165. (move-marker org-log-note-return-to nil)
  8166. (and org-log-post-message (message "%s" org-log-post-message)))
  8167. (defun org-sparse-tree (&optional arg)
  8168. "Create a sparse tree, prompt for the details.
  8169. This command can create sparse trees. You first need to select the type
  8170. of match used to create the tree:
  8171. t Show entries with a specific TODO keyword.
  8172. T Show entries selected by a tags match.
  8173. p Enter a property name and its value (both with completion on existing
  8174. names/values) and show entries with that property.
  8175. r Show entries matching a regular expression
  8176. d Show deadlines due within `org-deadline-warning-days'."
  8177. (interactive "P")
  8178. (let (ans kwd value)
  8179. (message "Sparse tree: [/]regexp [t]odo-kwd [T]ag [p]roperty [d]eadlines [b]efore-date")
  8180. (setq ans (read-char-exclusive))
  8181. (cond
  8182. ((equal ans ?d)
  8183. (call-interactively 'org-check-deadlines))
  8184. ((equal ans ?b)
  8185. (call-interactively 'org-check-before-date))
  8186. ((equal ans ?t)
  8187. (org-show-todo-tree '(4)))
  8188. ((equal ans ?T)
  8189. (call-interactively 'org-tags-sparse-tree))
  8190. ((member ans '(?p ?P))
  8191. (setq kwd (org-ido-completing-read "Property: "
  8192. (mapcar 'list (org-buffer-property-keys))))
  8193. (setq value (org-ido-completing-read "Value: "
  8194. (mapcar 'list (org-property-values kwd))))
  8195. (unless (string-match "\\`{.*}\\'" value)
  8196. (setq value (concat "\"" value "\"")))
  8197. (org-tags-sparse-tree arg (concat kwd "=" value)))
  8198. ((member ans '(?r ?R ?/))
  8199. (call-interactively 'org-occur))
  8200. (t (error "No such sparse tree command \"%c\"" ans)))))
  8201. (defvar org-occur-highlights nil
  8202. "List of overlays used for occur matches.")
  8203. (make-variable-buffer-local 'org-occur-highlights)
  8204. (defvar org-occur-parameters nil
  8205. "Parameters of the active org-occur calls.
  8206. This is a list, each call to org-occur pushes as cons cell,
  8207. containing the regular expression and the callback, onto the list.
  8208. The list can contain several entries if `org-occur' has been called
  8209. several time with the KEEP-PREVIOUS argument. Otherwise, this list
  8210. will only contain one set of parameters. When the highlights are
  8211. removed (for example with `C-c C-c', or with the next edit (depending
  8212. on `org-remove-highlights-with-change'), this variable is emptied
  8213. as well.")
  8214. (make-variable-buffer-local 'org-occur-parameters)
  8215. (defun org-occur (regexp &optional keep-previous callback)
  8216. "Make a compact tree which shows all matches of REGEXP.
  8217. The tree will show the lines where the regexp matches, and all higher
  8218. headlines above the match. It will also show the heading after the match,
  8219. to make sure editing the matching entry is easy.
  8220. If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
  8221. call to `org-occur' will be kept, to allow stacking of calls to this
  8222. command.
  8223. If CALLBACK is non-nil, it is a function which is called to confirm
  8224. that the match should indeed be shown."
  8225. (interactive "sRegexp: \nP")
  8226. (unless keep-previous
  8227. (org-remove-occur-highlights nil nil t))
  8228. (push (cons regexp callback) org-occur-parameters)
  8229. (let ((cnt 0))
  8230. (save-excursion
  8231. (goto-char (point-min))
  8232. (if (or (not keep-previous) ; do not want to keep
  8233. (not org-occur-highlights)) ; no previous matches
  8234. ;; hide everything
  8235. (org-overview))
  8236. (while (re-search-forward regexp nil t)
  8237. (when (or (not callback)
  8238. (save-match-data (funcall callback)))
  8239. (setq cnt (1+ cnt))
  8240. (when org-highlight-sparse-tree-matches
  8241. (org-highlight-new-match (match-beginning 0) (match-end 0)))
  8242. (org-show-context 'occur-tree))))
  8243. (when org-remove-highlights-with-change
  8244. (org-add-hook 'before-change-functions 'org-remove-occur-highlights
  8245. nil 'local))
  8246. (unless org-sparse-tree-open-archived-trees
  8247. (org-hide-archived-subtrees (point-min) (point-max)))
  8248. (run-hooks 'org-occur-hook)
  8249. (if (interactive-p)
  8250. (message "%d match(es) for regexp %s" cnt regexp))
  8251. cnt))
  8252. (defun org-show-context (&optional key)
  8253. "Make sure point and context and visible.
  8254. How much context is shown depends upon the variables
  8255. `org-show-hierarchy-above', `org-show-following-heading'. and
  8256. `org-show-siblings'."
  8257. (let ((heading-p (org-on-heading-p t))
  8258. (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
  8259. (following-p (org-get-alist-option org-show-following-heading key))
  8260. (entry-p (org-get-alist-option org-show-entry-below key))
  8261. (siblings-p (org-get-alist-option org-show-siblings key)))
  8262. (catch 'exit
  8263. ;; Show heading or entry text
  8264. (if (and heading-p (not entry-p))
  8265. (org-flag-heading nil) ; only show the heading
  8266. (and (or entry-p (org-invisible-p) (org-invisible-p2))
  8267. (org-show-hidden-entry))) ; show entire entry
  8268. (when following-p
  8269. ;; Show next sibling, or heading below text
  8270. (save-excursion
  8271. (and (if heading-p (org-goto-sibling) (outline-next-heading))
  8272. (org-flag-heading nil))))
  8273. (when siblings-p (org-show-siblings))
  8274. (when hierarchy-p
  8275. ;; show all higher headings, possibly with siblings
  8276. (save-excursion
  8277. (while (and (condition-case nil
  8278. (progn (org-up-heading-all 1) t)
  8279. (error nil))
  8280. (not (bobp)))
  8281. (org-flag-heading nil)
  8282. (when siblings-p (org-show-siblings))))))))
  8283. (defun org-reveal (&optional siblings)
  8284. "Show current entry, hierarchy above it, and the following headline.
  8285. This can be used to show a consistent set of context around locations
  8286. exposed with `org-show-hierarchy-above' or `org-show-following-heading'
  8287. not t for the search context.
  8288. With optional argument SIBLINGS, on each level of the hierarchy all
  8289. siblings are shown. This repairs the tree structure to what it would
  8290. look like when opened with hierarchical calls to `org-cycle'."
  8291. (interactive "P")
  8292. (let ((org-show-hierarchy-above t)
  8293. (org-show-following-heading t)
  8294. (org-show-siblings (if siblings t org-show-siblings)))
  8295. (org-show-context nil)))
  8296. (defun org-highlight-new-match (beg end)
  8297. "Highlight from BEG to END and mark the highlight is an occur headline."
  8298. (let ((ov (org-make-overlay beg end)))
  8299. (org-overlay-put ov 'face 'secondary-selection)
  8300. (push ov org-occur-highlights)))
  8301. (defun org-remove-occur-highlights (&optional beg end noremove)
  8302. "Remove the occur highlights from the buffer.
  8303. BEG and END are ignored. If NOREMOVE is nil, remove this function
  8304. from the `before-change-functions' in the current buffer."
  8305. (interactive)
  8306. (unless org-inhibit-highlight-removal
  8307. (mapc 'org-delete-overlay org-occur-highlights)
  8308. (setq org-occur-highlights nil)
  8309. (setq org-occur-parameters nil)
  8310. (unless noremove
  8311. (remove-hook 'before-change-functions
  8312. 'org-remove-occur-highlights 'local))))
  8313. ;;;; Priorities
  8314. (defvar org-priority-regexp ".*?\\(\\[#\\([A-Z0-9]\\)\\] ?\\)"
  8315. "Regular expression matching the priority indicator.")
  8316. (defvar org-remove-priority-next-time nil)
  8317. (defun org-priority-up ()
  8318. "Increase the priority of the current item."
  8319. (interactive)
  8320. (org-priority 'up))
  8321. (defun org-priority-down ()
  8322. "Decrease the priority of the current item."
  8323. (interactive)
  8324. (org-priority 'down))
  8325. (defun org-priority (&optional action)
  8326. "Change the priority of an item by ARG.
  8327. ACTION can be `set', `up', `down', or a character."
  8328. (interactive)
  8329. (setq action (or action 'set))
  8330. (let (current new news have remove)
  8331. (save-excursion
  8332. (org-back-to-heading)
  8333. (if (looking-at org-priority-regexp)
  8334. (setq current (string-to-char (match-string 2))
  8335. have t)
  8336. (setq current org-default-priority))
  8337. (cond
  8338. ((or (eq action 'set)
  8339. (if (featurep 'xemacs) (characterp action) (integerp action)))
  8340. (if (not (eq action 'set))
  8341. (setq new action)
  8342. (message "Priority %c-%c, SPC to remove: "
  8343. org-highest-priority org-lowest-priority)
  8344. (setq new (read-char-exclusive)))
  8345. (if (and (= (upcase org-highest-priority) org-highest-priority)
  8346. (= (upcase org-lowest-priority) org-lowest-priority))
  8347. (setq new (upcase new)))
  8348. (cond ((equal new ?\ ) (setq remove t))
  8349. ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
  8350. (error "Priority must be between `%c' and `%c'"
  8351. org-highest-priority org-lowest-priority))))
  8352. ((eq action 'up)
  8353. (if (and (not have) (eq last-command this-command))
  8354. (setq new org-lowest-priority)
  8355. (setq new (if (and org-priority-start-cycle-with-default (not have))
  8356. org-default-priority (1- current)))))
  8357. ((eq action 'down)
  8358. (if (and (not have) (eq last-command this-command))
  8359. (setq new org-highest-priority)
  8360. (setq new (if (and org-priority-start-cycle-with-default (not have))
  8361. org-default-priority (1+ current)))))
  8362. (t (error "Invalid action")))
  8363. (if (or (< (upcase new) org-highest-priority)
  8364. (> (upcase new) org-lowest-priority))
  8365. (setq remove t))
  8366. (setq news (format "%c" new))
  8367. (if have
  8368. (if remove
  8369. (replace-match "" t t nil 1)
  8370. (replace-match news t t nil 2))
  8371. (if remove
  8372. (error "No priority cookie found in line")
  8373. (looking-at org-todo-line-regexp)
  8374. (if (match-end 2)
  8375. (progn
  8376. (goto-char (match-end 2))
  8377. (insert " [#" news "]"))
  8378. (goto-char (match-beginning 3))
  8379. (insert "[#" news "] ")))))
  8380. (org-preserve-lc (org-set-tags nil 'align))
  8381. (if remove
  8382. (message "Priority removed")
  8383. (message "Priority of current item set to %s" news))))
  8384. (defun org-get-priority (s)
  8385. "Find priority cookie and return priority."
  8386. (save-match-data
  8387. (if (not (string-match org-priority-regexp s))
  8388. (* 1000 (- org-lowest-priority org-default-priority))
  8389. (* 1000 (- org-lowest-priority
  8390. (string-to-char (match-string 2 s)))))))
  8391. ;;;; Tags
  8392. (defvar org-agenda-archives-mode)
  8393. (defun org-scan-tags (action matcher &optional todo-only)
  8394. "Scan headline tags with inheritance and produce output ACTION.
  8395. ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
  8396. or `agenda' to produce an entry list for an agenda view. It can also be
  8397. a Lisp form or a function that should be called at each matched headline, in
  8398. this case the return value is a list of all return values from these calls.
  8399. MATCHER is a Lisp form to be evaluated, testing if a given set of tags
  8400. qualifies a headline for inclusion. When TODO-ONLY is non-nil,
  8401. only lines with a TODO keyword are included in the output."
  8402. (let* ((re (concat "[\n\r]" outline-regexp " *\\(\\<\\("
  8403. (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
  8404. (org-re
  8405. "\\>\\)\\)? *\\(.*?\\)\\(:[[:alnum:]_@:]+:\\)?[ \t]*$")))
  8406. (props (list 'face 'default
  8407. 'done-face 'org-done
  8408. 'undone-face 'default
  8409. 'mouse-face 'highlight
  8410. 'org-not-done-regexp org-not-done-regexp
  8411. 'org-todo-regexp org-todo-regexp
  8412. 'keymap org-agenda-keymap
  8413. 'help-echo
  8414. (format "mouse-2 or RET jump to org file %s"
  8415. (abbreviate-file-name
  8416. (or (buffer-file-name (buffer-base-buffer))
  8417. (buffer-name (buffer-base-buffer)))))))
  8418. (case-fold-search nil)
  8419. lspos tags tags-list
  8420. (tags-alist (list (cons 0 (mapcar 'downcase org-file-tags))))
  8421. (llast 0) rtn rtn1 level category i txt
  8422. todo marker entry priority)
  8423. (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
  8424. (setq action (list 'lambda nil action)))
  8425. (save-excursion
  8426. (goto-char (point-min))
  8427. (when (eq action 'sparse-tree)
  8428. (org-overview)
  8429. (org-remove-occur-highlights))
  8430. (while (re-search-forward re nil t)
  8431. (catch :skip
  8432. (setq todo (if (match-end 1) (match-string 2))
  8433. tags (if (match-end 4) (match-string 4)))
  8434. (goto-char (setq lspos (1+ (match-beginning 0))))
  8435. (setq level (org-reduced-level (funcall outline-level))
  8436. category (org-get-category))
  8437. (setq i llast llast level)
  8438. ;; remove tag lists from same and sublevels
  8439. (while (>= i level)
  8440. (when (setq entry (assoc i tags-alist))
  8441. (setq tags-alist (delete entry tags-alist)))
  8442. (setq i (1- i)))
  8443. ;; add the next tags
  8444. (when tags
  8445. (setq tags (mapcar 'downcase (org-split-string tags ":"))
  8446. tags-alist
  8447. (cons (cons level tags) tags-alist)))
  8448. ;; compile tags for current headline
  8449. (setq tags-list
  8450. (if org-use-tag-inheritance
  8451. (apply 'append (mapcar 'cdr (reverse tags-alist)))
  8452. tags))
  8453. (when org-use-tag-inheritance
  8454. (setcdr (car tags-alist)
  8455. (mapcar (lambda (x)
  8456. (setq x (copy-sequence x))
  8457. (org-add-prop-inherited x))
  8458. (cdar tags-alist))))
  8459. (when (and tags org-use-tag-inheritance
  8460. (not (eq t org-use-tag-inheritance)))
  8461. ;; selective inheritance, remove uninherited ones
  8462. (setcdr (car tags-alist)
  8463. (org-remove-uniherited-tags (cdar tags-alist))))
  8464. (when (and (or (not todo-only) (member todo org-not-done-keywords))
  8465. (let ((case-fold-search t)) (eval matcher))
  8466. (or
  8467. (not (member org-archive-tag tags-list))
  8468. ;; we have an archive tag, should we use this anyway?
  8469. (or (not org-agenda-skip-archived-trees)
  8470. (and (eq action 'agenda) org-agenda-archives-mode))))
  8471. (unless (eq action 'sparse-tree) (org-agenda-skip))
  8472. ;; select this headline
  8473. (cond
  8474. ((eq action 'sparse-tree)
  8475. (and org-highlight-sparse-tree-matches
  8476. (org-get-heading) (match-end 0)
  8477. (org-highlight-new-match
  8478. (match-beginning 0) (match-beginning 1)))
  8479. (org-show-context 'tags-tree))
  8480. ((eq action 'agenda)
  8481. (setq txt (org-format-agenda-item
  8482. ""
  8483. (concat
  8484. (if org-tags-match-list-sublevels
  8485. (make-string (1- level) ?.) "")
  8486. (org-get-heading))
  8487. category (org-get-tags-at))
  8488. priority (org-get-priority txt))
  8489. (goto-char lspos)
  8490. (setq marker (org-agenda-new-marker))
  8491. (org-add-props txt props
  8492. 'org-marker marker 'org-hd-marker marker 'org-category category
  8493. 'priority priority 'type "tagsmatch")
  8494. (push txt rtn))
  8495. ((functionp action)
  8496. (save-excursion
  8497. (setq rtn1 (funcall action))
  8498. (push rtn1 rtn))
  8499. (goto-char (point-at-eol)))
  8500. (t (error "Invalid action")))
  8501. ;; if we are to skip sublevels, jump to end of subtree
  8502. (or org-tags-match-list-sublevels (org-end-of-subtree t))))))
  8503. (when (and (eq action 'sparse-tree)
  8504. (not org-sparse-tree-open-archived-trees))
  8505. (org-hide-archived-subtrees (point-min) (point-max)))
  8506. (nreverse rtn)))
  8507. (defun org-remove-uniherited-tags (tags)
  8508. "Remove all tags that are not inherited from the list TAGS."
  8509. (cond
  8510. ((eq org-use-tag-inheritance t)
  8511. (if org-tags-exclude-from-inheritance
  8512. (org-delete-all org-tags-exclude-from-inheritance tags)
  8513. tags))
  8514. ((not org-use-tag-inheritance) nil)
  8515. ((stringp org-use-tag-inheritance)
  8516. (delq nil (mapcar
  8517. (lambda (x)
  8518. (if (and (string-match org-use-tag-inheritance x)
  8519. (not (member x org-tags-exclude-from-inheritance)))
  8520. x nil))
  8521. tags)))
  8522. ((listp org-use-tag-inheritance)
  8523. (delq nil (mapcar
  8524. (lambda (x)
  8525. (if (member x org-use-tag-inheritance) x nil))
  8526. tags)))))
  8527. (defvar todo-only) ;; dynamically scoped
  8528. (defun org-tags-sparse-tree (&optional todo-only match)
  8529. "Create a sparse tree according to tags string MATCH.
  8530. MATCH can contain positive and negative selection of tags, like
  8531. \"+WORK+URGENT-WITHBOSS\".
  8532. If optional argument TODO-ONLY is non-nil, only select lines that are
  8533. also TODO lines."
  8534. (interactive "P")
  8535. (org-prepare-agenda-buffers (list (current-buffer)))
  8536. (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
  8537. (defvar org-cached-props nil)
  8538. (defun org-cached-entry-get (pom property)
  8539. (if (or (eq t org-use-property-inheritance)
  8540. (and (stringp org-use-property-inheritance)
  8541. (string-match org-use-property-inheritance property))
  8542. (and (listp org-use-property-inheritance)
  8543. (member property org-use-property-inheritance)))
  8544. ;; Caching is not possible, check it directly
  8545. (org-entry-get pom property 'inherit)
  8546. ;; Get all properties, so that we can do complicated checks easily
  8547. (cdr (assoc property (or org-cached-props
  8548. (setq org-cached-props
  8549. (org-entry-properties pom)))))))
  8550. (defun org-global-tags-completion-table (&optional files)
  8551. "Return the list of all tags in all agenda buffer/files."
  8552. (save-excursion
  8553. (org-uniquify
  8554. (delq nil
  8555. (apply 'append
  8556. (mapcar
  8557. (lambda (file)
  8558. (set-buffer (find-file-noselect file))
  8559. (append (org-get-buffer-tags)
  8560. (mapcar (lambda (x) (if (stringp (car-safe x))
  8561. (list (car-safe x)) nil))
  8562. org-tag-alist)))
  8563. (if (and files (car files))
  8564. files
  8565. (org-agenda-files))))))))
  8566. (defun org-make-tags-matcher (match)
  8567. "Create the TAGS//TODO matcher form for the selection string MATCH."
  8568. ;; todo-only is scoped dynamically into this function, and the function
  8569. ;; may change it if the matcher asks for it.
  8570. (unless match
  8571. ;; Get a new match request, with completion
  8572. (let ((org-last-tags-completion-table
  8573. (org-global-tags-completion-table)))
  8574. (setq match (org-ido-completing-read
  8575. "Match: " 'org-tags-completion-function nil nil nil
  8576. 'org-tags-history))))
  8577. ;; Parse the string and create a lisp form
  8578. (let ((match0 match)
  8579. (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\([[:alnum:]_]+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@]+\\)"))
  8580. minus tag mm
  8581. tagsmatch todomatch tagsmatcher todomatcher kwd matcher
  8582. orterms term orlist re-p str-p level-p level-op time-p
  8583. prop-p pn pv po cat-p gv rest)
  8584. (if (string-match "/+" match)
  8585. ;; match contains also a todo-matching request
  8586. (progn
  8587. (setq tagsmatch (substring match 0 (match-beginning 0))
  8588. todomatch (substring match (match-end 0)))
  8589. (if (string-match "^!" todomatch)
  8590. (setq todo-only t todomatch (substring todomatch 1)))
  8591. (if (string-match "^\\s-*$" todomatch)
  8592. (setq todomatch nil)))
  8593. ;; only matching tags
  8594. (setq tagsmatch match todomatch nil))
  8595. ;; Make the tags matcher
  8596. (if (or (not tagsmatch) (not (string-match "\\S-" tagsmatch)))
  8597. (setq tagsmatcher t)
  8598. (setq orterms (org-split-string tagsmatch "|") orlist nil)
  8599. (while (setq term (pop orterms))
  8600. (while (and (equal (substring term -1) "\\") orterms)
  8601. (setq term (concat term "|" (pop orterms)))) ; repair bad split
  8602. (while (string-match re term)
  8603. (setq rest (substring term (match-end 0))
  8604. minus (and (match-end 1)
  8605. (equal (match-string 1 term) "-"))
  8606. tag (match-string 2 term)
  8607. re-p (equal (string-to-char tag) ?{)
  8608. level-p (match-end 4)
  8609. prop-p (match-end 5)
  8610. mm (cond
  8611. (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
  8612. (level-p
  8613. (setq level-op (org-op-to-function (match-string 3 term)))
  8614. `(,level-op level ,(string-to-number
  8615. (match-string 4 term))))
  8616. (prop-p
  8617. (setq pn (match-string 5 term)
  8618. po (match-string 6 term)
  8619. pv (match-string 7 term)
  8620. cat-p (equal pn "CATEGORY")
  8621. re-p (equal (string-to-char pv) ?{)
  8622. str-p (equal (string-to-char pv) ?\")
  8623. time-p (save-match-data
  8624. (string-match "^\"[[<].*[]>]\"$" pv))
  8625. pv (if (or re-p str-p) (substring pv 1 -1) pv))
  8626. (if time-p (setq pv (org-matcher-time pv)))
  8627. (setq po (org-op-to-function po (if time-p 'time str-p)))
  8628. (cond
  8629. ((equal pn "CATEGORY")
  8630. (setq gv '(get-text-property (point) 'org-category)))
  8631. ((equal pn "TODO")
  8632. (setq gv 'todo))
  8633. (t
  8634. (setq gv `(org-cached-entry-get nil ,pn))))
  8635. (if re-p
  8636. (if (eq po 'org<>)
  8637. `(not (string-match ,pv (or ,gv "")))
  8638. `(string-match ,pv (or ,gv "")))
  8639. (if str-p
  8640. `(,po (or ,gv "") ,pv)
  8641. `(,po (string-to-number (or ,gv ""))
  8642. ,(string-to-number pv) ))))
  8643. (t `(member ,(downcase tag) tags-list)))
  8644. mm (if minus (list 'not mm) mm)
  8645. term rest)
  8646. (push mm tagsmatcher))
  8647. (push (if (> (length tagsmatcher) 1)
  8648. (cons 'and tagsmatcher)
  8649. (car tagsmatcher))
  8650. orlist)
  8651. (setq tagsmatcher nil))
  8652. (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
  8653. (setq tagsmatcher
  8654. (list 'progn '(setq org-cached-props nil) tagsmatcher)))
  8655. ;; Make the todo matcher
  8656. (if (or (not todomatch) (not (string-match "\\S-" todomatch)))
  8657. (setq todomatcher t)
  8658. (setq orterms (org-split-string todomatch "|") orlist nil)
  8659. (while (setq term (pop orterms))
  8660. (while (string-match re term)
  8661. (setq minus (and (match-end 1)
  8662. (equal (match-string 1 term) "-"))
  8663. kwd (match-string 2 term)
  8664. re-p (equal (string-to-char kwd) ?{)
  8665. term (substring term (match-end 0))
  8666. mm (if re-p
  8667. `(string-match ,(substring kwd 1 -1) todo)
  8668. (list 'equal 'todo kwd))
  8669. mm (if minus (list 'not mm) mm))
  8670. (push mm todomatcher))
  8671. (push (if (> (length todomatcher) 1)
  8672. (cons 'and todomatcher)
  8673. (car todomatcher))
  8674. orlist)
  8675. (setq todomatcher nil))
  8676. (setq todomatcher (if (> (length orlist) 1)
  8677. (cons 'or orlist) (car orlist))))
  8678. ;; Return the string and lisp forms of the matcher
  8679. (setq matcher (if todomatcher
  8680. (list 'and tagsmatcher todomatcher)
  8681. tagsmatcher))
  8682. (cons match0 matcher)))
  8683. (defun org-op-to-function (op &optional stringp)
  8684. "Turn an operator into the appropriate function."
  8685. (setq op
  8686. (cond
  8687. ((equal op "<" ) '(< string< org-time<))
  8688. ((equal op ">" ) '(> org-string> org-time>))
  8689. ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
  8690. ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
  8691. ((member op '("=" "==")) '(= string= org-time=))
  8692. ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
  8693. (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
  8694. (defun org<> (a b) (not (= a b)))
  8695. (defun org-string<= (a b) (or (string= a b) (string< a b)))
  8696. (defun org-string>= (a b) (not (string< a b)))
  8697. (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
  8698. (defun org-string<> (a b) (not (string= a b)))
  8699. (defun org-time= (a b) (= (org-2ft a) (org-2ft b)))
  8700. (defun org-time< (a b) (< (org-2ft a) (org-2ft b)))
  8701. (defun org-time<= (a b) (<= (org-2ft a) (org-2ft b)))
  8702. (defun org-time> (a b) (> (org-2ft a) (org-2ft b)))
  8703. (defun org-time>= (a b) (>= (org-2ft a) (org-2ft b)))
  8704. (defun org-time<> (a b) (org<> (org-2ft a) (org-2ft b)))
  8705. (defun org-2ft (s)
  8706. "Convert S to a floating point time.
  8707. If S is already a number, just return it. If it is a string, parse
  8708. it as a time string and apply `float-time' to it. f S is nil, just return 0."
  8709. (cond
  8710. ((numberp s) s)
  8711. ((stringp s)
  8712. (condition-case nil
  8713. (float-time (apply 'encode-time (org-parse-time-string s)))
  8714. (error 0.)))
  8715. (t 0.)))
  8716. (defun org-time-today ()
  8717. "Time in seconds today at 0:00.
  8718. Returns the float number of seconds since the beginning of the
  8719. epoch to the beginning of today (00:00)."
  8720. (float-time (apply 'encode-time
  8721. (append '(0 0 0) (nthcdr 3 (decode-time))))))
  8722. (defun org-matcher-time (s)
  8723. "Interpret a time comparison value."
  8724. (save-match-data
  8725. (cond
  8726. ((string= s "<now>") (float-time))
  8727. ((string= s "<today>") (org-time-today))
  8728. ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
  8729. ((string= s "<yesterday>") (- (org-time-today) 86400.0))
  8730. ((string-match "^<\\([-+][0-9]+\\)\\([dwmy]\\)>$" s)
  8731. (+ (org-time-today)
  8732. (* (string-to-number (match-string 1 s))
  8733. (cdr (assoc (match-string 2 s)
  8734. '(("d" . 86400.0) ("w" . 604800.0)
  8735. ("m" . 2678400.0) ("y" . 31557600.0)))))))
  8736. (t (org-2ft s)))))
  8737. (defun org-match-any-p (re list)
  8738. "Does re match any element of list?"
  8739. (setq list (mapcar (lambda (x) (string-match re x)) list))
  8740. (delq nil list))
  8741. (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
  8742. (defvar org-tags-overlay (org-make-overlay 1 1))
  8743. (org-detach-overlay org-tags-overlay)
  8744. (defun org-get-local-tags-at (&optional pos)
  8745. "Get a list of tags defined in the current headline."
  8746. (org-get-tags-at pos 'local))
  8747. (defun org-get-local-tags ()
  8748. "Get a list of tags defined in the current headline."
  8749. (org-get-tags-at nil 'local))
  8750. (defun org-get-tags-at (&optional pos local)
  8751. "Get a list of all headline tags applicable at POS.
  8752. POS defaults to point. If tags are inherited, the list contains
  8753. the targets in the same sequence as the headlines appear, i.e.
  8754. the tags of the current headline come last.
  8755. When LOCAL is non-nil, only return tags from the current headline,
  8756. ignore inherited ones."
  8757. (interactive)
  8758. (let (tags ltags lastpos parent)
  8759. (save-excursion
  8760. (save-restriction
  8761. (widen)
  8762. (goto-char (or pos (point)))
  8763. (save-match-data
  8764. (catch 'done
  8765. (condition-case nil
  8766. (progn
  8767. (org-back-to-heading t)
  8768. (while (not (equal lastpos (point)))
  8769. (setq lastpos (point))
  8770. (when (looking-at (org-re "[^\r\n]+?:\\([[:alnum:]_@:]+\\):[ \t]*$"))
  8771. (setq ltags (org-split-string
  8772. (org-match-string-no-properties 1) ":"))
  8773. (when parent
  8774. (setq ltags (mapcar 'org-add-prop-inherited ltags)))
  8775. (setq tags (append
  8776. (if parent
  8777. (org-remove-uniherited-tags ltags)
  8778. ltags)
  8779. tags)))
  8780. (or org-use-tag-inheritance (throw 'done t))
  8781. (if local (throw 'done t))
  8782. (org-up-heading-all 1)
  8783. (setq parent t)))
  8784. (error nil)))))
  8785. (append (org-remove-uniherited-tags org-file-tags) tags))))
  8786. (defun org-add-prop-inherited (s)
  8787. (add-text-properties 0 (length s) '(inherited t) s)
  8788. s)
  8789. (defun org-toggle-tag (tag &optional onoff)
  8790. "Toggle the tag TAG for the current line.
  8791. If ONOFF is `on' or `off', don't toggle but set to this state."
  8792. (let (res current)
  8793. (save-excursion
  8794. (org-back-to-heading t)
  8795. (if (re-search-forward (org-re "[ \t]:\\([[:alnum:]_@:]+\\):[ \t]*$")
  8796. (point-at-eol) t)
  8797. (progn
  8798. (setq current (match-string 1))
  8799. (replace-match ""))
  8800. (setq current ""))
  8801. (setq current (nreverse (org-split-string current ":")))
  8802. (cond
  8803. ((eq onoff 'on)
  8804. (setq res t)
  8805. (or (member tag current) (push tag current)))
  8806. ((eq onoff 'off)
  8807. (or (not (member tag current)) (setq current (delete tag current))))
  8808. (t (if (member tag current)
  8809. (setq current (delete tag current))
  8810. (setq res t)
  8811. (push tag current))))
  8812. (end-of-line 1)
  8813. (if current
  8814. (progn
  8815. (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
  8816. (org-set-tags nil t))
  8817. (delete-horizontal-space))
  8818. (run-hooks 'org-after-tags-change-hook))
  8819. res))
  8820. (defun org-align-tags-here (to-col)
  8821. ;; Assumes that this is a headline
  8822. (let ((pos (point)) (col (current-column)) ncol tags-l p)
  8823. (beginning-of-line 1)
  8824. (if (and (looking-at (org-re ".*?\\([ \t]+\\)\\(:[[:alnum:]_@:]+:\\)[ \t]*$"))
  8825. (< pos (match-beginning 2)))
  8826. (progn
  8827. (setq tags-l (- (match-end 2) (match-beginning 2)))
  8828. (goto-char (match-beginning 1))
  8829. (insert " ")
  8830. (delete-region (point) (1+ (match-beginning 2)))
  8831. (setq ncol (max (1+ (current-column))
  8832. (1+ col)
  8833. (if (> to-col 0)
  8834. to-col
  8835. (- (abs to-col) tags-l))))
  8836. (setq p (point))
  8837. (insert (make-string (- ncol (current-column)) ?\ ))
  8838. (setq ncol (current-column))
  8839. (when indent-tabs-mode (tabify p (point-at-eol)))
  8840. (org-move-to-column (min ncol col) t))
  8841. (goto-char pos))))
  8842. (defun org-set-tags-command (&optional arg just-align)
  8843. "Call the set-tags command for the current entry."
  8844. (interactive "P")
  8845. (if (org-on-heading-p)
  8846. (org-set-tags arg just-align)
  8847. (save-excursion
  8848. (org-back-to-heading t)
  8849. (org-set-tags arg just-align))))
  8850. (defun org-set-tags (&optional arg just-align)
  8851. "Set the tags for the current headline.
  8852. With prefix ARG, realign all tags in headings in the current buffer."
  8853. (interactive "P")
  8854. (let* ((re (concat "^" outline-regexp))
  8855. (current (org-get-tags-string))
  8856. (col (current-column))
  8857. (org-setting-tags t)
  8858. table current-tags inherited-tags ; computed below when needed
  8859. tags p0 c0 c1 rpl)
  8860. (if arg
  8861. (save-excursion
  8862. (goto-char (point-min))
  8863. (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
  8864. (while (re-search-forward re nil t)
  8865. (org-set-tags nil t)
  8866. (end-of-line 1)))
  8867. (message "All tags realigned to column %d" org-tags-column))
  8868. (if just-align
  8869. (setq tags current)
  8870. ;; Get a new set of tags from the user
  8871. (save-excursion
  8872. (setq table (or org-tag-alist (org-get-buffer-tags))
  8873. org-last-tags-completion-table table
  8874. current-tags (org-split-string current ":")
  8875. inherited-tags (nreverse
  8876. (nthcdr (length current-tags)
  8877. (nreverse (org-get-tags-at))))
  8878. tags
  8879. (if (or (eq t org-use-fast-tag-selection)
  8880. (and org-use-fast-tag-selection
  8881. (delq nil (mapcar 'cdr table))))
  8882. (org-fast-tag-selection
  8883. current-tags inherited-tags table
  8884. (if org-fast-tag-selection-include-todo org-todo-key-alist))
  8885. (let ((org-add-colon-after-tag-completion t))
  8886. (org-trim
  8887. (org-without-partial-completion
  8888. (org-ido-completing-read "Tags: " 'org-tags-completion-function
  8889. nil nil current 'org-tags-history)))))))
  8890. (while (string-match "[-+&]+" tags)
  8891. ;; No boolean logic, just a list
  8892. (setq tags (replace-match ":" t t tags))))
  8893. (if (string-match "\\`[\t ]*\\'" tags)
  8894. (setq tags "")
  8895. (unless (string-match ":$" tags) (setq tags (concat tags ":")))
  8896. (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
  8897. ;; Insert new tags at the correct column
  8898. (beginning-of-line 1)
  8899. (cond
  8900. ((and (equal current "") (equal tags "")))
  8901. ((re-search-forward
  8902. (concat "\\([ \t]*" (regexp-quote current) "\\)[ \t]*$")
  8903. (point-at-eol) t)
  8904. (if (equal tags "")
  8905. (setq rpl "")
  8906. (goto-char (match-beginning 0))
  8907. (setq c0 (current-column) p0 (point)
  8908. c1 (max (1+ c0) (if (> org-tags-column 0)
  8909. org-tags-column
  8910. (- (- org-tags-column) (length tags))))
  8911. rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
  8912. (replace-match rpl t t)
  8913. (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
  8914. tags)
  8915. (t (error "Tags alignment failed")))
  8916. (org-move-to-column col)
  8917. (unless just-align
  8918. (run-hooks 'org-after-tags-change-hook)))))
  8919. (defun org-change-tag-in-region (beg end tag off)
  8920. "Add or remove TAG for each entry in the region.
  8921. This works in the agenda, and also in an org-mode buffer."
  8922. (interactive
  8923. (list (region-beginning) (region-end)
  8924. (let ((org-last-tags-completion-table
  8925. (if (org-mode-p)
  8926. (org-get-buffer-tags)
  8927. (org-global-tags-completion-table))))
  8928. (org-ido-completing-read
  8929. "Tag: " 'org-tags-completion-function nil nil nil
  8930. 'org-tags-history))
  8931. (progn
  8932. (message "[s]et or [r]emove? ")
  8933. (equal (read-char-exclusive) ?r))))
  8934. (if (fboundp 'deactivate-mark) (deactivate-mark))
  8935. (let ((agendap (equal major-mode 'org-agenda-mode))
  8936. l1 l2 m buf pos newhead (cnt 0))
  8937. (goto-char end)
  8938. (setq l2 (1- (org-current-line)))
  8939. (goto-char beg)
  8940. (setq l1 (org-current-line))
  8941. (loop for l from l1 to l2 do
  8942. (goto-line l)
  8943. (setq m (get-text-property (point) 'org-hd-marker))
  8944. (when (or (and (org-mode-p) (org-on-heading-p))
  8945. (and agendap m))
  8946. (setq buf (if agendap (marker-buffer m) (current-buffer))
  8947. pos (if agendap m (point)))
  8948. (with-current-buffer buf
  8949. (save-excursion
  8950. (save-restriction
  8951. (goto-char pos)
  8952. (setq cnt (1+ cnt))
  8953. (org-toggle-tag tag (if off 'off 'on))
  8954. (setq newhead (org-get-heading)))))
  8955. (and agendap (org-agenda-change-all-lines newhead m))))
  8956. (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
  8957. (defun org-tags-completion-function (string predicate &optional flag)
  8958. (let (s1 s2 rtn (ctable org-last-tags-completion-table)
  8959. (confirm (lambda (x) (stringp (car x)))))
  8960. (if (string-match "^\\(.*[-+:&|]\\)\\([^-+:&|]*\\)$" string)
  8961. (setq s1 (match-string 1 string)
  8962. s2 (match-string 2 string))
  8963. (setq s1 "" s2 string))
  8964. (cond
  8965. ((eq flag nil)
  8966. ;; try completion
  8967. (setq rtn (try-completion s2 ctable confirm))
  8968. (if (stringp rtn)
  8969. (setq rtn
  8970. (concat s1 s2 (substring rtn (length s2))
  8971. (if (and org-add-colon-after-tag-completion
  8972. (assoc rtn ctable))
  8973. ":" ""))))
  8974. rtn)
  8975. ((eq flag t)
  8976. ;; all-completions
  8977. (all-completions s2 ctable confirm)
  8978. )
  8979. ((eq flag 'lambda)
  8980. ;; exact match?
  8981. (assoc s2 ctable)))
  8982. ))
  8983. (defun org-fast-tag-insert (kwd tags face &optional end)
  8984. "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
  8985. (insert (format "%-12s" (concat kwd ":"))
  8986. (org-add-props (mapconcat 'identity tags " ") nil 'face face)
  8987. (or end "")))
  8988. (defun org-fast-tag-show-exit (flag)
  8989. (save-excursion
  8990. (goto-line 3)
  8991. (if (re-search-forward "[ \t]+Next change exits" (point-at-eol) t)
  8992. (replace-match ""))
  8993. (when flag
  8994. (end-of-line 1)
  8995. (org-move-to-column (- (window-width) 19) t)
  8996. (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
  8997. (defun org-set-current-tags-overlay (current prefix)
  8998. (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
  8999. (if (featurep 'xemacs)
  9000. (org-overlay-display org-tags-overlay (concat prefix s)
  9001. 'secondary-selection)
  9002. (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
  9003. (org-overlay-display org-tags-overlay (concat prefix s)))))
  9004. (defun org-fast-tag-selection (current inherited table &optional todo-table)
  9005. "Fast tag selection with single keys.
  9006. CURRENT is the current list of tags in the headline, INHERITED is the
  9007. list of inherited tags, and TABLE is an alist of tags and corresponding keys,
  9008. possibly with grouping information. TODO-TABLE is a similar table with
  9009. TODO keywords, should these have keys assigned to them.
  9010. If the keys are nil, a-z are automatically assigned.
  9011. Returns the new tags string, or nil to not change the current settings."
  9012. (let* ((fulltable (append table todo-table))
  9013. (maxlen (apply 'max (mapcar
  9014. (lambda (x)
  9015. (if (stringp (car x)) (string-width (car x)) 0))
  9016. fulltable)))
  9017. (buf (current-buffer))
  9018. (expert (eq org-fast-tag-selection-single-key 'expert))
  9019. (buffer-tags nil)
  9020. (fwidth (+ maxlen 3 1 3))
  9021. (ncol (/ (- (window-width) 4) fwidth))
  9022. (i-face 'org-done)
  9023. (c-face 'org-todo)
  9024. tg cnt e c char c1 c2 ntable tbl rtn
  9025. ov-start ov-end ov-prefix
  9026. (exit-after-next org-fast-tag-selection-single-key)
  9027. (done-keywords org-done-keywords)
  9028. groups ingroup)
  9029. (save-excursion
  9030. (beginning-of-line 1)
  9031. (if (looking-at
  9032. (org-re ".*[ \t]\\(:[[:alnum:]_@:]+:\\)[ \t]*$"))
  9033. (setq ov-start (match-beginning 1)
  9034. ov-end (match-end 1)
  9035. ov-prefix "")
  9036. (setq ov-start (1- (point-at-eol))
  9037. ov-end (1+ ov-start))
  9038. (skip-chars-forward "^\n\r")
  9039. (setq ov-prefix
  9040. (concat
  9041. (buffer-substring (1- (point)) (point))
  9042. (if (> (current-column) org-tags-column)
  9043. " "
  9044. (make-string (- org-tags-column (current-column)) ?\ ))))))
  9045. (org-move-overlay org-tags-overlay ov-start ov-end)
  9046. (save-window-excursion
  9047. (if expert
  9048. (set-buffer (get-buffer-create " *Org tags*"))
  9049. (delete-other-windows)
  9050. (split-window-vertically)
  9051. (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
  9052. (erase-buffer)
  9053. (org-set-local 'org-done-keywords done-keywords)
  9054. (org-fast-tag-insert "Inherited" inherited i-face "\n")
  9055. (org-fast-tag-insert "Current" current c-face "\n\n")
  9056. (org-fast-tag-show-exit exit-after-next)
  9057. (org-set-current-tags-overlay current ov-prefix)
  9058. (setq tbl fulltable char ?a cnt 0)
  9059. (while (setq e (pop tbl))
  9060. (cond
  9061. ((equal e '(:startgroup))
  9062. (push '() groups) (setq ingroup t)
  9063. (when (not (= cnt 0))
  9064. (setq cnt 0)
  9065. (insert "\n"))
  9066. (insert "{ "))
  9067. ((equal e '(:endgroup))
  9068. (setq ingroup nil cnt 0)
  9069. (insert "}\n"))
  9070. (t
  9071. (setq tg (car e) c2 nil)
  9072. (if (cdr e)
  9073. (setq c (cdr e))
  9074. ;; automatically assign a character.
  9075. (setq c1 (string-to-char
  9076. (downcase (substring
  9077. tg (if (= (string-to-char tg) ?@) 1 0)))))
  9078. (if (or (rassoc c1 ntable) (rassoc c1 table))
  9079. (while (or (rassoc char ntable) (rassoc char table))
  9080. (setq char (1+ char)))
  9081. (setq c2 c1))
  9082. (setq c (or c2 char)))
  9083. (if ingroup (push tg (car groups)))
  9084. (setq tg (org-add-props tg nil 'face
  9085. (cond
  9086. ((not (assoc tg table))
  9087. (org-get-todo-face tg))
  9088. ((member tg current) c-face)
  9089. ((member tg inherited) i-face)
  9090. (t nil))))
  9091. (if (and (= cnt 0) (not ingroup)) (insert " "))
  9092. (insert "[" c "] " tg (make-string
  9093. (- fwidth 4 (length tg)) ?\ ))
  9094. (push (cons tg c) ntable)
  9095. (when (= (setq cnt (1+ cnt)) ncol)
  9096. (insert "\n")
  9097. (if ingroup (insert " "))
  9098. (setq cnt 0)))))
  9099. (setq ntable (nreverse ntable))
  9100. (insert "\n")
  9101. (goto-char (point-min))
  9102. (if (not expert) (org-fit-window-to-buffer))
  9103. (setq rtn
  9104. (catch 'exit
  9105. (while t
  9106. (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free%s%s"
  9107. (if groups " [!] no groups" " [!]groups")
  9108. (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
  9109. (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
  9110. (cond
  9111. ((= c ?\r) (throw 'exit t))
  9112. ((= c ?!)
  9113. (setq groups (not groups))
  9114. (goto-char (point-min))
  9115. (while (re-search-forward "[{}]" nil t) (replace-match " ")))
  9116. ((= c ?\C-c)
  9117. (if (not expert)
  9118. (org-fast-tag-show-exit
  9119. (setq exit-after-next (not exit-after-next)))
  9120. (setq expert nil)
  9121. (delete-other-windows)
  9122. (split-window-vertically)
  9123. (org-switch-to-buffer-other-window " *Org tags*")
  9124. (org-fit-window-to-buffer)))
  9125. ((or (= c ?\C-g)
  9126. (and (= c ?q) (not (rassoc c ntable))))
  9127. (org-detach-overlay org-tags-overlay)
  9128. (setq quit-flag t))
  9129. ((= c ?\ )
  9130. (setq current nil)
  9131. (if exit-after-next (setq exit-after-next 'now)))
  9132. ((= c ?\t)
  9133. (condition-case nil
  9134. (setq tg (org-ido-completing-read
  9135. "Tag: "
  9136. (or buffer-tags
  9137. (with-current-buffer buf
  9138. (org-get-buffer-tags)))))
  9139. (quit (setq tg "")))
  9140. (when (string-match "\\S-" tg)
  9141. (add-to-list 'buffer-tags (list tg))
  9142. (if (member tg current)
  9143. (setq current (delete tg current))
  9144. (push tg current)))
  9145. (if exit-after-next (setq exit-after-next 'now)))
  9146. ((setq e (rassoc c todo-table) tg (car e))
  9147. (with-current-buffer buf
  9148. (save-excursion (org-todo tg)))
  9149. (if exit-after-next (setq exit-after-next 'now)))
  9150. ((setq e (rassoc c ntable) tg (car e))
  9151. (if (member tg current)
  9152. (setq current (delete tg current))
  9153. (loop for g in groups do
  9154. (if (member tg g)
  9155. (mapc (lambda (x)
  9156. (setq current (delete x current)))
  9157. g)))
  9158. (push tg current))
  9159. (if exit-after-next (setq exit-after-next 'now))))
  9160. ;; Create a sorted list
  9161. (setq current
  9162. (sort current
  9163. (lambda (a b)
  9164. (assoc b (cdr (memq (assoc a ntable) ntable))))))
  9165. (if (eq exit-after-next 'now) (throw 'exit t))
  9166. (goto-char (point-min))
  9167. (beginning-of-line 2)
  9168. (delete-region (point) (point-at-eol))
  9169. (org-fast-tag-insert "Current" current c-face)
  9170. (org-set-current-tags-overlay current ov-prefix)
  9171. (while (re-search-forward
  9172. (org-re "\\[.\\] \\([[:alnum:]_@]+\\)") nil t)
  9173. (setq tg (match-string 1))
  9174. (add-text-properties
  9175. (match-beginning 1) (match-end 1)
  9176. (list 'face
  9177. (cond
  9178. ((member tg current) c-face)
  9179. ((member tg inherited) i-face)
  9180. (t (get-text-property (match-beginning 1) 'face))))))
  9181. (goto-char (point-min)))))
  9182. (org-detach-overlay org-tags-overlay)
  9183. (if rtn
  9184. (mapconcat 'identity current ":")
  9185. nil))))
  9186. (defun org-get-tags-string ()
  9187. "Get the TAGS string in the current headline."
  9188. (unless (org-on-heading-p t)
  9189. (error "Not on a heading"))
  9190. (save-excursion
  9191. (beginning-of-line 1)
  9192. (if (looking-at (org-re ".*[ \t]\\(:[[:alnum:]_@:]+:\\)[ \t]*$"))
  9193. (org-match-string-no-properties 1)
  9194. "")))
  9195. (defun org-get-tags ()
  9196. "Get the list of tags specified in the current headline."
  9197. (org-split-string (org-get-tags-string) ":"))
  9198. (defun org-get-buffer-tags ()
  9199. "Get a table of all tags used in the buffer, for completion."
  9200. (let (tags)
  9201. (save-excursion
  9202. (goto-char (point-min))
  9203. (while (re-search-forward
  9204. (org-re "[ \t]:\\([[:alnum:]_@:]+\\):[ \t\r\n]") nil t)
  9205. (when (equal (char-after (point-at-bol 0)) ?*)
  9206. (mapc (lambda (x) (add-to-list 'tags x))
  9207. (org-split-string (org-match-string-no-properties 1) ":")))))
  9208. (mapcar 'list tags)))
  9209. ;;;; The mapping API
  9210. ;;;###autoload
  9211. (defun org-map-entries (func &optional match scope &rest skip)
  9212. "Call FUNC at each headline selected by MATCH in SCOPE.
  9213. FUNC is a function or a lisp form. The function will be called without
  9214. arguments, with the cursor positioned at the beginning of the headline.
  9215. The return values of all calls to the function will be collected and
  9216. returned as a list.
  9217. MATCH is a tags/property/todo match as it is used in the agenda tags view.
  9218. Only headlines that are matched by this query will be considered during
  9219. the iteration. When MATCH is nil or t, all headlines will be
  9220. visited by the iteration.
  9221. SCOPE determines the scope of this command. It can be any of:
  9222. nil The current buffer, respecting the restriction if any
  9223. tree The subtree started with the entry at point
  9224. file The current buffer, without restriction
  9225. file-with-archives
  9226. The current buffer, and any archives associated with it
  9227. agenda All agenda files
  9228. agenda-with-archives
  9229. All agenda files with any archive files associated with them
  9230. \(file1 file2 ...)
  9231. If this is a list, all files in the list will be scanned
  9232. The remaining args are treated as settings for the skipping facilities of
  9233. the scanner. The following items can be given here:
  9234. archive skip trees with the archive tag.
  9235. comment skip trees with the COMMENT keyword
  9236. function or Emacs Lisp form:
  9237. will be used as value for `org-agenda-skip-function', so whenever
  9238. the the function returns t, FUNC will not be called for that
  9239. entry and search will continue from the point where the
  9240. function leaves it."
  9241. (let* ((org-agenda-archives-mode nil) ; just to make sure
  9242. (org-agenda-skip-archived-trees (memq 'archive skip))
  9243. (org-agenda-skip-comment-trees (memq 'comment skip))
  9244. (org-agenda-skip-function
  9245. (car (org-delete-all '(comment archive) skip)))
  9246. (org-tags-match-list-sublevels t)
  9247. matcher pos file res
  9248. org-todo-keywords-for-agenda
  9249. org-done-keywords-for-agenda
  9250. org-todo-keyword-alist-for-agenda
  9251. org-tag-alist-for-agenda)
  9252. (cond
  9253. ((eq match t) (setq matcher t))
  9254. ((eq match nil) (setq matcher t))
  9255. (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
  9256. (when (eq scope 'tree)
  9257. (org-back-to-heading t)
  9258. (org-narrow-to-subtree)
  9259. (setq scope nil))
  9260. (if (not scope)
  9261. (progn
  9262. (org-prepare-agenda-buffers
  9263. (list (buffer-file-name (current-buffer))))
  9264. (org-scan-tags func matcher))
  9265. ;; Get the right scope
  9266. (setq pos (point))
  9267. (cond
  9268. ((and scope (listp scope) (symbolp (car scope)))
  9269. (setq scope (eval scope)))
  9270. ((eq scope 'agenda)
  9271. (setq scope (org-agenda-files t)))
  9272. ((eq scope 'agenda-with-archives)
  9273. (setq scope (org-agenda-files t))
  9274. (setq scope (org-add-archive-files scope)))
  9275. ((eq scope 'file)
  9276. (setq scope (list (buffer-file-name))))
  9277. ((eq scope 'file-with-archives)
  9278. (setq scope (org-add-archive-files (list (buffer-file-name))))))
  9279. (org-prepare-agenda-buffers scope)
  9280. (while (setq file (pop scope))
  9281. (with-current-buffer (org-find-base-buffer-visiting file)
  9282. (save-excursion
  9283. (save-restriction
  9284. (widen)
  9285. (goto-char (point-min))
  9286. (setq res (append res (org-scan-tags func matcher)))))))
  9287. res)))
  9288. ;;;; Properties
  9289. ;;; Setting and retrieving properties
  9290. (defconst org-special-properties
  9291. '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
  9292. "TIMESTAMP" "TIMESTAMP_IA")
  9293. "The special properties valid in Org-mode.
  9294. These are properties that are not defined in the property drawer,
  9295. but in some other way.")
  9296. (defconst org-default-properties
  9297. '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION"
  9298. "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
  9299. "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
  9300. "EXPORT_FILE_NAME" "EXPORT_TITLE")
  9301. "Some properties that are used by Org-mode for various purposes.
  9302. Being in this list makes sure that they are offered for completion.")
  9303. (defconst org-property-start-re "^[ \t]*:PROPERTIES:[ \t]*$"
  9304. "Regular expression matching the first line of a property drawer.")
  9305. (defconst org-property-end-re "^[ \t]*:END:[ \t]*$"
  9306. "Regular expression matching the first line of a property drawer.")
  9307. (defconst org-clock-drawer-start-re "^[ \t]*:CLOCK:[ \t]*$"
  9308. "Regular expression matching the first line of a property drawer.")
  9309. (defconst org-clock-drawer-end-re "^[ \t]*:END:[ \t]*$"
  9310. "Regular expression matching the first line of a property drawer.")
  9311. (defconst org-property-drawer-re
  9312. (concat "\\(" org-property-start-re "\\)[^\000]*\\("
  9313. org-property-end-re "\\)\n?")
  9314. "Matches an entire property drawer.")
  9315. (defconst org-clock-drawer-re
  9316. (concat "\\(" org-clock-drawer-start-re "\\)[^\000]*\\("
  9317. org-property-end-re "\\)\n?")
  9318. "Matches an entire clock drawer.")
  9319. (defun org-property-action ()
  9320. "Do an action on properties."
  9321. (interactive)
  9322. (let (c)
  9323. (org-at-property-p)
  9324. (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
  9325. (setq c (read-char-exclusive))
  9326. (cond
  9327. ((equal c ?s)
  9328. (call-interactively 'org-set-property))
  9329. ((equal c ?d)
  9330. (call-interactively 'org-delete-property))
  9331. ((equal c ?D)
  9332. (call-interactively 'org-delete-property-globally))
  9333. ((equal c ?c)
  9334. (call-interactively 'org-compute-property-at-point))
  9335. (t (error "No such property action %c" c)))))
  9336. (defun org-at-property-p ()
  9337. "Is the cursor in a property line?"
  9338. ;; FIXME: Does not check if we are actually in the drawer.
  9339. ;; FIXME: also returns true on any drawers.....
  9340. ;; This is used by C-c C-c for property action.
  9341. (save-excursion
  9342. (beginning-of-line 1)
  9343. (looking-at (org-re "^[ \t]*\\(:\\([[:alpha:]][[:alnum:]_-]*\\):\\)[ \t]*\\(.*\\)"))))
  9344. (defun org-get-property-block (&optional beg end force)
  9345. "Return the (beg . end) range of the body of the property drawer.
  9346. BEG and END can be beginning and end of subtree, if not given
  9347. they will be found.
  9348. If the drawer does not exist and FORCE is non-nil, create the drawer."
  9349. (catch 'exit
  9350. (save-excursion
  9351. (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
  9352. (end (or end (progn (outline-next-heading) (point)))))
  9353. (goto-char beg)
  9354. (if (re-search-forward org-property-start-re end t)
  9355. (setq beg (1+ (match-end 0)))
  9356. (if force
  9357. (save-excursion
  9358. (org-insert-property-drawer)
  9359. (setq end (progn (outline-next-heading) (point))))
  9360. (throw 'exit nil))
  9361. (goto-char beg)
  9362. (if (re-search-forward org-property-start-re end t)
  9363. (setq beg (1+ (match-end 0)))))
  9364. (if (re-search-forward org-property-end-re end t)
  9365. (setq end (match-beginning 0))
  9366. (or force (throw 'exit nil))
  9367. (goto-char beg)
  9368. (setq end beg)
  9369. (org-indent-line-function)
  9370. (insert ":END:\n"))
  9371. (cons beg end)))))
  9372. (defun org-entry-properties (&optional pom which)
  9373. "Get all properties of the entry at point-or-marker POM.
  9374. This includes the TODO keyword, the tags, time strings for deadline,
  9375. scheduled, and clocking, and any additional properties defined in the
  9376. entry. The return value is an alist, keys may occur multiple times
  9377. if the property key was used several times.
  9378. POM may also be nil, in which case the current entry is used.
  9379. If WHICH is nil or `all', get all properties. If WHICH is
  9380. `special' or `standard', only get that subclass."
  9381. (setq which (or which 'all))
  9382. (org-with-point-at pom
  9383. (let ((clockstr (substring org-clock-string 0 -1))
  9384. (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY"))
  9385. beg end range props sum-props key value string clocksum)
  9386. (save-excursion
  9387. (when (condition-case nil
  9388. (and (org-mode-p) (org-back-to-heading t))
  9389. (error nil))
  9390. (setq beg (point))
  9391. (setq sum-props (get-text-property (point) 'org-summaries))
  9392. (setq clocksum (get-text-property (point) :org-clock-minutes))
  9393. (outline-next-heading)
  9394. (setq end (point))
  9395. (when (memq which '(all special))
  9396. ;; Get the special properties, like TODO and tags
  9397. (goto-char beg)
  9398. (when (and (looking-at org-todo-line-regexp) (match-end 2))
  9399. (push (cons "TODO" (org-match-string-no-properties 2)) props))
  9400. (when (looking-at org-priority-regexp)
  9401. (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
  9402. (when (and (setq value (org-get-tags-string))
  9403. (string-match "\\S-" value))
  9404. (push (cons "TAGS" value) props))
  9405. (when (setq value (org-get-tags-at))
  9406. (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":") ":"))
  9407. props))
  9408. (while (re-search-forward org-maybe-keyword-time-regexp end t)
  9409. (setq key (if (match-end 1) (substring (org-match-string-no-properties 1) 0 -1))
  9410. string (if (equal key clockstr)
  9411. (org-no-properties
  9412. (org-trim
  9413. (buffer-substring
  9414. (match-beginning 3) (goto-char (point-at-eol)))))
  9415. (substring (org-match-string-no-properties 3) 1 -1)))
  9416. (unless key
  9417. (if (= (char-after (match-beginning 3)) ?\[)
  9418. (setq key "TIMESTAMP_IA")
  9419. (setq key "TIMESTAMP")))
  9420. (when (or (equal key clockstr) (not (assoc key props)))
  9421. (push (cons key string) props)))
  9422. )
  9423. (when (memq which '(all standard))
  9424. ;; Get the standard properties, like :PORP: ...
  9425. (setq range (org-get-property-block beg end))
  9426. (when range
  9427. (goto-char (car range))
  9428. (while (re-search-forward
  9429. (org-re "^[ \t]*:\\([[:alpha:]][[:alnum:]_-]*\\):[ \t]*\\(\\S-.*\\)?")
  9430. (cdr range) t)
  9431. (setq key (org-match-string-no-properties 1)
  9432. value (org-trim (or (org-match-string-no-properties 2) "")))
  9433. (unless (member key excluded)
  9434. (push (cons key (or value "")) props)))))
  9435. (if clocksum
  9436. (push (cons "CLOCKSUM"
  9437. (org-columns-number-to-string (/ (float clocksum) 60.)
  9438. 'add_times))
  9439. props))
  9440. (unless (assoc "CATEGORY" props)
  9441. (setq value (or (org-get-category)
  9442. (progn (org-refresh-category-properties)
  9443. (org-get-category))))
  9444. (push (cons "CATEGORY" value) props))
  9445. (append sum-props (nreverse props)))))))
  9446. (defun org-entry-get (pom property &optional inherit)
  9447. "Get value of PROPERTY for entry at point-or-marker POM.
  9448. If INHERIT is non-nil and the entry does not have the property,
  9449. then also check higher levels of the hierarchy.
  9450. If INHERIT is the symbol `selective', use inheritance only if the setting
  9451. in `org-use-property-inheritance' selects PROPERTY for inheritance.
  9452. If the property is present but empty, the return value is the empty string.
  9453. If the property is not present at all, nil is returned."
  9454. (org-with-point-at pom
  9455. (if (and inherit (if (eq inherit 'selective)
  9456. (org-property-inherit-p property)
  9457. t))
  9458. (org-entry-get-with-inheritance property)
  9459. (if (member property org-special-properties)
  9460. ;; We need a special property. Use brute force, get all properties.
  9461. (cdr (assoc property (org-entry-properties nil 'special)))
  9462. (let ((range (org-get-property-block)))
  9463. (if (and range
  9464. (goto-char (car range))
  9465. (re-search-forward
  9466. (concat "^[ \t]*:" property ":[ \t]*\\(.*[^ \t\r\n\f\v]\\)?")
  9467. (cdr range) t))
  9468. ;; Found the property, return it.
  9469. (if (match-end 1)
  9470. (org-match-string-no-properties 1)
  9471. "")))))))
  9472. (defun org-property-or-variable-value (var &optional inherit)
  9473. "Check if there is a property fixing the value of VAR.
  9474. If yes, return this value. If not, return the current value of the variable."
  9475. (let ((prop (org-entry-get nil (symbol-name var) inherit)))
  9476. (if (and prop (stringp prop) (string-match "\\S-" prop))
  9477. (read prop)
  9478. (symbol-value var))))
  9479. (defun org-entry-delete (pom property)
  9480. "Delete the property PROPERTY from entry at point-or-marker POM."
  9481. (org-with-point-at pom
  9482. (if (member property org-special-properties)
  9483. nil ; cannot delete these properties.
  9484. (let ((range (org-get-property-block)))
  9485. (if (and range
  9486. (goto-char (car range))
  9487. (re-search-forward
  9488. (concat "^[ \t]*:" property ":[ \t]*\\(.*[^ \t\r\n\f\v]\\)")
  9489. (cdr range) t))
  9490. (progn
  9491. (delete-region (match-beginning 0) (1+ (point-at-eol)))
  9492. t)
  9493. nil)))))
  9494. ;; Multi-values properties are properties that contain multiple values
  9495. ;; These values are assumed to be single words, separated by whitespace.
  9496. (defun org-entry-add-to-multivalued-property (pom property value)
  9497. "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
  9498. (let* ((old (org-entry-get pom property))
  9499. (values (and old (org-split-string old "[ \t]"))))
  9500. (setq value (org-entry-protect-space value))
  9501. (unless (member value values)
  9502. (setq values (cons value values))
  9503. (org-entry-put pom property
  9504. (mapconcat 'identity values " ")))))
  9505. (defun org-entry-remove-from-multivalued-property (pom property value)
  9506. "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
  9507. (let* ((old (org-entry-get pom property))
  9508. (values (and old (org-split-string old "[ \t]"))))
  9509. (setq value (org-entry-protect-space value))
  9510. (when (member value values)
  9511. (setq values (delete value values))
  9512. (org-entry-put pom property
  9513. (mapconcat 'identity values " ")))))
  9514. (defun org-entry-member-in-multivalued-property (pom property value)
  9515. "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
  9516. (let* ((old (org-entry-get pom property))
  9517. (values (and old (org-split-string old "[ \t]"))))
  9518. (setq value (org-entry-protect-space value))
  9519. (member value values)))
  9520. (defun org-entry-get-multivalued-property (pom property)
  9521. "Return a list of values in a multivalued property."
  9522. (let* ((value (org-entry-get pom property))
  9523. (values (and value (org-split-string value "[ \t]"))))
  9524. (mapcar 'org-entry-restore-space values)))
  9525. (defun org-entry-put-multivalued-property (pom property &rest values)
  9526. "Set multivalued PROPERTY at point-or-marker POM to VALUES.
  9527. VALUES should be a list of strings. Spaces will be protected."
  9528. (org-entry-put pom property
  9529. (mapconcat 'org-entry-protect-space values " "))
  9530. (let* ((value (org-entry-get pom property))
  9531. (values (and value (org-split-string value "[ \t]"))))
  9532. (mapcar 'org-entry-restore-space values)))
  9533. (defun org-entry-protect-space (s)
  9534. "Protect spaces and newline in string S."
  9535. (while (string-match " " s)
  9536. (setq s (replace-match "%20" t t s)))
  9537. (while (string-match "\n" s)
  9538. (setq s (replace-match "%0A" t t s)))
  9539. s)
  9540. (defun org-entry-restore-space (s)
  9541. "Restore spaces and newline in string S."
  9542. (while (string-match "%20" s)
  9543. (setq s (replace-match " " t t s)))
  9544. (while (string-match "%0A" s)
  9545. (setq s (replace-match "\n" t t s)))
  9546. s)
  9547. (defvar org-entry-property-inherited-from (make-marker)
  9548. "Marker pointing to the entry from where a property was inherited.
  9549. Each call to `org-entry-get-with-inheritance' will set this marker to the
  9550. location of the entry where the inheritance search matched. If there was
  9551. no match, the marker will point nowhere.
  9552. Note that also `org-entry-get' calls this function, if the INHERIT flag
  9553. is set.")
  9554. (defun org-entry-get-with-inheritance (property)
  9555. "Get entry property, and search higher levels if not present."
  9556. (move-marker org-entry-property-inherited-from nil)
  9557. (let (tmp)
  9558. (save-excursion
  9559. (save-restriction
  9560. (widen)
  9561. (catch 'ex
  9562. (while t
  9563. (when (setq tmp (org-entry-get nil property))
  9564. (org-back-to-heading t)
  9565. (move-marker org-entry-property-inherited-from (point))
  9566. (throw 'ex tmp))
  9567. (or (org-up-heading-safe) (throw 'ex nil)))))
  9568. (or tmp
  9569. (cdr (assoc property org-file-properties))
  9570. (cdr (assoc property org-global-properties))
  9571. (cdr (assoc property org-global-properties-fixed))))))
  9572. (defun org-entry-put (pom property value)
  9573. "Set PROPERTY to VALUE for entry at point-or-marker POM."
  9574. (org-with-point-at pom
  9575. (org-back-to-heading t)
  9576. (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
  9577. range)
  9578. (cond
  9579. ((equal property "TODO")
  9580. (when (and (stringp value) (string-match "\\S-" value)
  9581. (not (member value org-todo-keywords-1)))
  9582. (error "\"%s\" is not a valid TODO state" value))
  9583. (if (or (not value)
  9584. (not (string-match "\\S-" value)))
  9585. (setq value 'none))
  9586. (org-todo value)
  9587. (org-set-tags nil 'align))
  9588. ((equal property "PRIORITY")
  9589. (org-priority (if (and value (stringp value) (string-match "\\S-" value))
  9590. (string-to-char value) ?\ ))
  9591. (org-set-tags nil 'align))
  9592. ((equal property "SCHEDULED")
  9593. (if (re-search-forward org-scheduled-time-regexp end t)
  9594. (cond
  9595. ((eq value 'earlier) (org-timestamp-change -1 'day))
  9596. ((eq value 'later) (org-timestamp-change 1 'day))
  9597. (t (call-interactively 'org-schedule)))
  9598. (call-interactively 'org-schedule)))
  9599. ((equal property "DEADLINE")
  9600. (if (re-search-forward org-deadline-time-regexp end t)
  9601. (cond
  9602. ((eq value 'earlier) (org-timestamp-change -1 'day))
  9603. ((eq value 'later) (org-timestamp-change 1 'day))
  9604. (t (call-interactively 'org-deadline)))
  9605. (call-interactively 'org-deadline)))
  9606. ((member property org-special-properties)
  9607. (error "The %s property can not yet be set with `org-entry-put'"
  9608. property))
  9609. (t ; a non-special property
  9610. (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
  9611. (setq range (org-get-property-block beg end 'force))
  9612. (goto-char (car range))
  9613. (if (re-search-forward
  9614. (concat "^[ \t]*:" property ":\\(.*\\)") (cdr range) t)
  9615. (progn
  9616. (delete-region (match-beginning 1) (match-end 1))
  9617. (goto-char (match-beginning 1)))
  9618. (goto-char (cdr range))
  9619. (insert "\n")
  9620. (backward-char 1)
  9621. (org-indent-line-function)
  9622. (insert ":" property ":"))
  9623. (and value (insert " " value))
  9624. (org-indent-line-function)))))))
  9625. (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
  9626. "Get all property keys in the current buffer.
  9627. With INCLUDE-SPECIALS, also list the special properties that reflect things
  9628. like tags and TODO state.
  9629. With INCLUDE-DEFAULTS, also include properties that has special meaning
  9630. internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING.
  9631. With INCLUDE-COLUMNS, also include property names given in COLUMN
  9632. formats in the current buffer."
  9633. (let (rtn range cfmt cols s p)
  9634. (save-excursion
  9635. (save-restriction
  9636. (widen)
  9637. (goto-char (point-min))
  9638. (while (re-search-forward org-property-start-re nil t)
  9639. (setq range (org-get-property-block))
  9640. (goto-char (car range))
  9641. (while (re-search-forward
  9642. (org-re "^[ \t]*:\\([-[:alnum:]_]+\\):")
  9643. (cdr range) t)
  9644. (add-to-list 'rtn (org-match-string-no-properties 1)))
  9645. (outline-next-heading))))
  9646. (when include-specials
  9647. (setq rtn (append org-special-properties rtn)))
  9648. (when include-defaults
  9649. (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties))
  9650. (when include-columns
  9651. (save-excursion
  9652. (save-restriction
  9653. (widen)
  9654. (goto-char (point-min))
  9655. (while (re-search-forward
  9656. "^\\(#\\+COLUMNS:\\|[ \t]*:COLUMNS:\\)[ \t]*\\(.*\\)"
  9657. nil t)
  9658. (setq cfmt (match-string 2) s 0)
  9659. (while (string-match (org-re "%[0-9]*\\([-[:alnum:]_]+\\)")
  9660. cfmt s)
  9661. (setq s (match-end 0)
  9662. p (match-string 1 cfmt))
  9663. (unless (or (equal p "ITEM")
  9664. (member p org-special-properties))
  9665. (add-to-list 'rtn (match-string 1 cfmt))))))))
  9666. (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
  9667. (defun org-property-values (key)
  9668. "Return a list of all values of property KEY."
  9669. (save-excursion
  9670. (save-restriction
  9671. (widen)
  9672. (goto-char (point-min))
  9673. (let ((re (concat "^[ \t]*:" key ":[ \t]*\\(\\S-.*\\)"))
  9674. values)
  9675. (while (re-search-forward re nil t)
  9676. (add-to-list 'values (org-trim (match-string 1))))
  9677. (delete "" values)))))
  9678. (defun org-insert-property-drawer ()
  9679. "Insert a property drawer into the current entry."
  9680. (interactive)
  9681. (org-back-to-heading t)
  9682. (looking-at outline-regexp)
  9683. (let ((indent (- (match-end 0)(match-beginning 0)))
  9684. (beg (point))
  9685. (re (concat "^[ \t]*" org-keyword-time-regexp))
  9686. end hiddenp)
  9687. (outline-next-heading)
  9688. (setq end (point))
  9689. (goto-char beg)
  9690. (while (re-search-forward re end t))
  9691. (setq hiddenp (org-invisible-p))
  9692. (end-of-line 1)
  9693. (and (equal (char-after) ?\n) (forward-char 1))
  9694. (while (looking-at "^[ \t]*\\(:CLOCK:\\|CLOCK\\|:END:\\)")
  9695. (beginning-of-line 2))
  9696. (org-skip-over-state-notes)
  9697. (skip-chars-backward " \t\n\r")
  9698. (if (eq (char-before) ?*) (forward-char 1))
  9699. (let ((inhibit-read-only t)) (insert "\n:PROPERTIES:\n:END:"))
  9700. (beginning-of-line 0)
  9701. (org-indent-to-column indent)
  9702. (beginning-of-line 2)
  9703. (org-indent-to-column indent)
  9704. (beginning-of-line 0)
  9705. (if hiddenp
  9706. (save-excursion
  9707. (org-back-to-heading t)
  9708. (hide-entry))
  9709. (org-flag-drawer t))))
  9710. (defun org-set-property (property value)
  9711. "In the current entry, set PROPERTY to VALUE.
  9712. When called interactively, this will prompt for a property name, offering
  9713. completion on existing and default properties. And then it will prompt
  9714. for a value, offering completion either on allowed values (via an inherited
  9715. xxx_ALL property) or on existing values in other instances of this property
  9716. in the current file."
  9717. (interactive
  9718. (let* ((completion-ignore-case t)
  9719. (keys (org-buffer-property-keys nil t t))
  9720. (prop0 (org-ido-completing-read "Property: " (mapcar 'list keys)))
  9721. (prop (if (member prop0 keys)
  9722. prop0
  9723. (or (cdr (assoc (downcase prop0)
  9724. (mapcar (lambda (x) (cons (downcase x) x))
  9725. keys)))
  9726. prop0)))
  9727. (cur (org-entry-get nil prop))
  9728. (allowed (org-property-get-allowed-values nil prop 'table))
  9729. (existing (mapcar 'list (org-property-values prop)))
  9730. (val (if allowed
  9731. (org-completing-read "Value: " allowed nil 'req-match)
  9732. (org-completing-read
  9733. (concat "Value" (if (and cur (string-match "\\S-" cur))
  9734. (concat "[" cur "]") "")
  9735. ": ")
  9736. existing nil nil "" nil cur))))
  9737. (list prop (if (equal val "") cur val))))
  9738. (unless (equal (org-entry-get nil property) value)
  9739. (org-entry-put nil property value)))
  9740. (defun org-delete-property (property)
  9741. "In the current entry, delete PROPERTY."
  9742. (interactive
  9743. (let* ((completion-ignore-case t)
  9744. (prop (org-ido-completing-read
  9745. "Property: " (org-entry-properties nil 'standard))))
  9746. (list prop)))
  9747. (message "Property %s %s" property
  9748. (if (org-entry-delete nil property)
  9749. "deleted"
  9750. "was not present in the entry")))
  9751. (defun org-delete-property-globally (property)
  9752. "Remove PROPERTY globally, from all entries."
  9753. (interactive
  9754. (let* ((completion-ignore-case t)
  9755. (prop (org-ido-completing-read
  9756. "Globally remove property: "
  9757. (mapcar 'list (org-buffer-property-keys)))))
  9758. (list prop)))
  9759. (save-excursion
  9760. (save-restriction
  9761. (widen)
  9762. (goto-char (point-min))
  9763. (let ((cnt 0))
  9764. (while (re-search-forward
  9765. (concat "^[ \t]*:" (regexp-quote property) ":.*\n?")
  9766. nil t)
  9767. (setq cnt (1+ cnt))
  9768. (replace-match ""))
  9769. (message "Property \"%s\" removed from %d entries" property cnt)))))
  9770. (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
  9771. (defun org-compute-property-at-point ()
  9772. "Compute the property at point.
  9773. This looks for an enclosing column format, extracts the operator and
  9774. then applies it to the property in the column format's scope."
  9775. (interactive)
  9776. (unless (org-at-property-p)
  9777. (error "Not at a property"))
  9778. (let ((prop (org-match-string-no-properties 2)))
  9779. (org-columns-get-format-and-top-level)
  9780. (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
  9781. (error "No operator defined for property %s" prop))
  9782. (org-columns-compute prop)))
  9783. (defun org-property-get-allowed-values (pom property &optional table)
  9784. "Get allowed values for the property PROPERTY.
  9785. When TABLE is non-nil, return an alist that can directly be used for
  9786. completion."
  9787. (let (vals)
  9788. (cond
  9789. ((equal property "TODO")
  9790. (setq vals (org-with-point-at pom
  9791. (append org-todo-keywords-1 '("")))))
  9792. ((equal property "PRIORITY")
  9793. (let ((n org-lowest-priority))
  9794. (while (>= n org-highest-priority)
  9795. (push (char-to-string n) vals)
  9796. (setq n (1- n)))))
  9797. ((member property org-special-properties))
  9798. (t
  9799. (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
  9800. (when (and vals (string-match "\\S-" vals))
  9801. (setq vals (car (read-from-string (concat "(" vals ")"))))
  9802. (setq vals (mapcar (lambda (x)
  9803. (cond ((stringp x) x)
  9804. ((numberp x) (number-to-string x))
  9805. ((symbolp x) (symbol-name x))
  9806. (t "???")))
  9807. vals)))))
  9808. (if table (mapcar 'list vals) vals)))
  9809. (defun org-property-previous-allowed-value (&optional previous)
  9810. "Switch to the next allowed value for this property."
  9811. (interactive)
  9812. (org-property-next-allowed-value t))
  9813. (defun org-property-next-allowed-value (&optional previous)
  9814. "Switch to the next allowed value for this property."
  9815. (interactive)
  9816. (unless (org-at-property-p)
  9817. (error "Not at a property"))
  9818. (let* ((key (match-string 2))
  9819. (value (match-string 3))
  9820. (allowed (or (org-property-get-allowed-values (point) key)
  9821. (and (member value '("[ ]" "[-]" "[X]"))
  9822. '("[ ]" "[X]"))))
  9823. nval)
  9824. (unless allowed
  9825. (error "Allowed values for this property have not been defined"))
  9826. (if previous (setq allowed (reverse allowed)))
  9827. (if (member value allowed)
  9828. (setq nval (car (cdr (member value allowed)))))
  9829. (setq nval (or nval (car allowed)))
  9830. (if (equal nval value)
  9831. (error "Only one allowed value for this property"))
  9832. (org-at-property-p)
  9833. (replace-match (concat " :" key ": " nval) t t)
  9834. (org-indent-line-function)
  9835. (beginning-of-line 1)
  9836. (skip-chars-forward " \t")))
  9837. (defun org-find-entry-with-id (ident)
  9838. "Locate the entry that contains the ID property with exact value IDENT.
  9839. IDENT can be a string, a symbol or a number, this function will search for
  9840. the string representation of it.
  9841. Return the position where this entry starts, or nil if there is no such entry."
  9842. (interactive "sID: ")
  9843. (let ((id (cond
  9844. ((stringp ident) ident)
  9845. ((symbol-name ident) (symbol-name ident))
  9846. ((numberp ident) (number-to-string ident))
  9847. (t (error "IDENT %s must be a string, symbol or number" ident))))
  9848. (case-fold-search nil))
  9849. (save-excursion
  9850. (save-restriction
  9851. (widen)
  9852. (goto-char (point-min))
  9853. (when (re-search-forward
  9854. (concat "^[ \t]*:ID:[ \t]+" (regexp-quote id) "[ \t]*$")
  9855. nil t)
  9856. (org-back-to-heading)
  9857. (point))))))
  9858. ;;;; Timestamps
  9859. (defvar org-last-changed-timestamp nil)
  9860. (defvar org-last-inserted-timestamp nil
  9861. "The last time stamp inserted with `org-insert-time-stamp'.")
  9862. (defvar org-time-was-given) ; dynamically scoped parameter
  9863. (defvar org-end-time-was-given) ; dynamically scoped parameter
  9864. (defvar org-ts-what) ; dynamically scoped parameter
  9865. (defun org-time-stamp (arg &optional inactive)
  9866. "Prompt for a date/time and insert a time stamp.
  9867. If the user specifies a time like HH:MM, or if this command is called
  9868. with a prefix argument, the time stamp will contain date and time.
  9869. Otherwise, only the date will be included. All parts of a date not
  9870. specified by the user will be filled in from the current date/time.
  9871. So if you press just return without typing anything, the time stamp
  9872. will represent the current date/time. If there is already a timestamp
  9873. at the cursor, it will be modified."
  9874. (interactive "P")
  9875. (let* ((ts nil)
  9876. (default-time
  9877. ;; Default time is either today, or, when entering a range,
  9878. ;; the range start.
  9879. (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
  9880. (save-excursion
  9881. (re-search-backward
  9882. (concat org-ts-regexp "--?-?\\=") ; 1-3 minuses
  9883. (- (point) 20) t)))
  9884. (apply 'encode-time (org-parse-time-string (match-string 1)))
  9885. (current-time)))
  9886. (default-input (and ts (org-get-compact-tod ts)))
  9887. org-time-was-given org-end-time-was-given time)
  9888. (cond
  9889. ((and (org-at-timestamp-p t)
  9890. (memq last-command '(org-time-stamp org-time-stamp-inactive))
  9891. (memq this-command '(org-time-stamp org-time-stamp-inactive)))
  9892. (insert "--")
  9893. (setq time (let ((this-command this-command))
  9894. (org-read-date arg 'totime nil nil
  9895. default-time default-input)))
  9896. (org-insert-time-stamp time (or org-time-was-given arg) inactive))
  9897. ((org-at-timestamp-p t)
  9898. (setq time (let ((this-command this-command))
  9899. (org-read-date arg 'totime nil nil default-time default-input)))
  9900. (when (org-at-timestamp-p t) ; just to get the match data
  9901. ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
  9902. (replace-match "")
  9903. (setq org-last-changed-timestamp
  9904. (org-insert-time-stamp
  9905. time (or org-time-was-given arg)
  9906. inactive nil nil (list org-end-time-was-given))))
  9907. (message "Timestamp updated"))
  9908. (t
  9909. (setq time (let ((this-command this-command))
  9910. (org-read-date arg 'totime nil nil default-time default-input)))
  9911. (org-insert-time-stamp time (or org-time-was-given arg) inactive
  9912. nil nil (list org-end-time-was-given))))))
  9913. ;; FIXME: can we use this for something else, like computing time differences?
  9914. (defun org-get-compact-tod (s)
  9915. (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
  9916. (let* ((t1 (match-string 1 s))
  9917. (h1 (string-to-number (match-string 2 s)))
  9918. (m1 (string-to-number (match-string 3 s)))
  9919. (t2 (and (match-end 4) (match-string 5 s)))
  9920. (h2 (and t2 (string-to-number (match-string 6 s))))
  9921. (m2 (and t2 (string-to-number (match-string 7 s))))
  9922. dh dm)
  9923. (if (not t2)
  9924. t1
  9925. (setq dh (- h2 h1) dm (- m2 m1))
  9926. (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
  9927. (concat t1 "+" (number-to-string dh)
  9928. (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
  9929. (defun org-time-stamp-inactive (&optional arg)
  9930. "Insert an inactive time stamp.
  9931. An inactive time stamp is enclosed in square brackets instead of angle
  9932. brackets. It is inactive in the sense that it does not trigger agenda entries,
  9933. does not link to the calendar and cannot be changed with the S-cursor keys.
  9934. So these are more for recording a certain time/date."
  9935. (interactive "P")
  9936. (org-time-stamp arg 'inactive))
  9937. (defvar org-date-ovl (org-make-overlay 1 1))
  9938. (org-overlay-put org-date-ovl 'face 'org-warning)
  9939. (org-detach-overlay org-date-ovl)
  9940. (defvar org-ans1) ; dynamically scoped parameter
  9941. (defvar org-ans2) ; dynamically scoped parameter
  9942. (defvar org-plain-time-of-day-regexp) ; defined below
  9943. (defvar org-overriding-default-time nil) ; dynamically scoped
  9944. (defvar org-read-date-overlay nil)
  9945. (defvar org-dcst nil) ; dynamically scoped
  9946. (defun org-read-date (&optional with-time to-time from-string prompt
  9947. default-time default-input)
  9948. "Read a date, possibly a time, and make things smooth for the user.
  9949. The prompt will suggest to enter an ISO date, but you can also enter anything
  9950. which will at least partially be understood by `parse-time-string'.
  9951. Unrecognized parts of the date will default to the current day, month, year,
  9952. hour and minute. If this command is called to replace a timestamp at point,
  9953. of to enter the second timestamp of a range, the default time is taken from the
  9954. existing stamp. For example,
  9955. 3-2-5 --> 2003-02-05
  9956. feb 15 --> currentyear-02-15
  9957. sep 12 9 --> 2009-09-12
  9958. 12:45 --> today 12:45
  9959. 22 sept 0:34 --> currentyear-09-22 0:34
  9960. 12 --> currentyear-currentmonth-12
  9961. Fri --> nearest Friday (today or later)
  9962. etc.
  9963. Furthermore you can specify a relative date by giving, as the *first* thing
  9964. in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
  9965. change in days weeks, months, years.
  9966. With a single plus or minus, the date is relative to today. With a double
  9967. plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
  9968. +4d --> four days from today
  9969. +4 --> same as above
  9970. +2w --> two weeks from today
  9971. ++5 --> five days from default date
  9972. The function understands only English month and weekday abbreviations,
  9973. but this can be configured with the variables `parse-time-months' and
  9974. `parse-time-weekdays'.
  9975. While prompting, a calendar is popped up - you can also select the
  9976. date with the mouse (button 1). The calendar shows a period of three
  9977. months. To scroll it to other months, use the keys `>' and `<'.
  9978. If you don't like the calendar, turn it off with
  9979. \(setq org-read-date-popup-calendar nil)
  9980. With optional argument TO-TIME, the date will immediately be converted
  9981. to an internal time.
  9982. With an optional argument WITH-TIME, the prompt will suggest to also
  9983. insert a time. Note that when WITH-TIME is not set, you can still
  9984. enter a time, and this function will inform the calling routine about
  9985. this change. The calling routine may then choose to change the format
  9986. used to insert the time stamp into the buffer to include the time.
  9987. With optional argument FROM-STRING, read from this string instead from
  9988. the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
  9989. the time/date that is used for everything that is not specified by the
  9990. user."
  9991. (require 'parse-time)
  9992. (let* ((org-time-stamp-rounding-minutes
  9993. (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
  9994. (org-dcst org-display-custom-times)
  9995. (ct (org-current-time))
  9996. (def (or org-overriding-default-time default-time ct))
  9997. (defdecode (decode-time def))
  9998. (dummy (progn
  9999. (when (< (nth 2 defdecode) org-extend-today-until)
  10000. (setcar (nthcdr 2 defdecode) -1)
  10001. (setcar (nthcdr 1 defdecode) 59)
  10002. (setq def (apply 'encode-time defdecode)
  10003. defdecode (decode-time def)))))
  10004. (calendar-move-hook nil)
  10005. (calendar-view-diary-initially-flag nil)
  10006. (view-diary-entries-initially nil)
  10007. (calendar-view-holidays-initially-flag nil)
  10008. (view-calendar-holidays-initially nil)
  10009. (timestr (format-time-string
  10010. (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
  10011. (prompt (concat (if prompt (concat prompt " ") "")
  10012. (format "Date+time [%s]: " timestr)))
  10013. ans (org-ans0 "") org-ans1 org-ans2 final)
  10014. (cond
  10015. (from-string (setq ans from-string))
  10016. (org-read-date-popup-calendar
  10017. (save-excursion
  10018. (save-window-excursion
  10019. (calendar)
  10020. (calendar-forward-day (- (time-to-days def)
  10021. (calendar-absolute-from-gregorian
  10022. (calendar-current-date))))
  10023. (org-eval-in-calendar nil t)
  10024. (let* ((old-map (current-local-map))
  10025. (map (copy-keymap calendar-mode-map))
  10026. (minibuffer-local-map (copy-keymap minibuffer-local-map)))
  10027. (org-defkey map (kbd "RET") 'org-calendar-select)
  10028. (org-defkey map (if (featurep 'xemacs) [button1] [mouse-1])
  10029. 'org-calendar-select-mouse)
  10030. (org-defkey map (if (featurep 'xemacs) [button2] [mouse-2])
  10031. 'org-calendar-select-mouse)
  10032. (org-defkey minibuffer-local-map [(meta shift left)]
  10033. (lambda () (interactive)
  10034. (org-eval-in-calendar '(calendar-backward-month 1))))
  10035. (org-defkey minibuffer-local-map [(meta shift right)]
  10036. (lambda () (interactive)
  10037. (org-eval-in-calendar '(calendar-forward-month 1))))
  10038. (org-defkey minibuffer-local-map [(meta shift up)]
  10039. (lambda () (interactive)
  10040. (org-eval-in-calendar '(calendar-backward-year 1))))
  10041. (org-defkey minibuffer-local-map [(meta shift down)]
  10042. (lambda () (interactive)
  10043. (org-eval-in-calendar '(calendar-forward-year 1))))
  10044. (org-defkey minibuffer-local-map [(shift up)]
  10045. (lambda () (interactive)
  10046. (org-eval-in-calendar '(calendar-backward-week 1))))
  10047. (org-defkey minibuffer-local-map [(shift down)]
  10048. (lambda () (interactive)
  10049. (org-eval-in-calendar '(calendar-forward-week 1))))
  10050. (org-defkey minibuffer-local-map [(shift left)]
  10051. (lambda () (interactive)
  10052. (org-eval-in-calendar '(calendar-backward-day 1))))
  10053. (org-defkey minibuffer-local-map [(shift right)]
  10054. (lambda () (interactive)
  10055. (org-eval-in-calendar '(calendar-forward-day 1))))
  10056. (org-defkey minibuffer-local-map ">"
  10057. (lambda () (interactive)
  10058. (org-eval-in-calendar '(scroll-calendar-left 1))))
  10059. (org-defkey minibuffer-local-map "<"
  10060. (lambda () (interactive)
  10061. (org-eval-in-calendar '(scroll-calendar-right 1))))
  10062. (unwind-protect
  10063. (progn
  10064. (use-local-map map)
  10065. (add-hook 'post-command-hook 'org-read-date-display)
  10066. (setq org-ans0 (read-string prompt default-input nil nil))
  10067. ;; org-ans0: from prompt
  10068. ;; org-ans1: from mouse click
  10069. ;; org-ans2: from calendar motion
  10070. (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
  10071. (remove-hook 'post-command-hook 'org-read-date-display)
  10072. (use-local-map old-map)
  10073. (when org-read-date-overlay
  10074. (org-delete-overlay org-read-date-overlay)
  10075. (setq org-read-date-overlay nil)))))))
  10076. (t ; Naked prompt only
  10077. (unwind-protect
  10078. (setq ans (read-string prompt default-input nil timestr))
  10079. (when org-read-date-overlay
  10080. (org-delete-overlay org-read-date-overlay)
  10081. (setq org-read-date-overlay nil)))))
  10082. (setq final (org-read-date-analyze ans def defdecode))
  10083. (if to-time
  10084. (apply 'encode-time final)
  10085. (if (and (boundp 'org-time-was-given) org-time-was-given)
  10086. (format "%04d-%02d-%02d %02d:%02d"
  10087. (nth 5 final) (nth 4 final) (nth 3 final)
  10088. (nth 2 final) (nth 1 final))
  10089. (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
  10090. (defvar def)
  10091. (defvar defdecode)
  10092. (defvar with-time)
  10093. (defun org-read-date-display ()
  10094. "Display the current date prompt interpretation in the minibuffer."
  10095. (when org-read-date-display-live
  10096. (when org-read-date-overlay
  10097. (org-delete-overlay org-read-date-overlay))
  10098. (let ((p (point)))
  10099. (end-of-line 1)
  10100. (while (not (equal (buffer-substring
  10101. (max (point-min) (- (point) 4)) (point))
  10102. " "))
  10103. (insert " "))
  10104. (goto-char p))
  10105. (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
  10106. " " (or org-ans1 org-ans2)))
  10107. (org-end-time-was-given nil)
  10108. (f (org-read-date-analyze ans def defdecode))
  10109. (fmts (if org-dcst
  10110. org-time-stamp-custom-formats
  10111. org-time-stamp-formats))
  10112. (fmt (if (or with-time
  10113. (and (boundp 'org-time-was-given) org-time-was-given))
  10114. (cdr fmts)
  10115. (car fmts)))
  10116. (txt (concat "=> " (format-time-string fmt (apply 'encode-time f)))))
  10117. (when (and org-end-time-was-given
  10118. (string-match org-plain-time-of-day-regexp txt))
  10119. (setq txt (concat (substring txt 0 (match-end 0)) "-"
  10120. org-end-time-was-given
  10121. (substring txt (match-end 0)))))
  10122. (setq org-read-date-overlay
  10123. (org-make-overlay (1- (point-at-eol)) (point-at-eol)))
  10124. (org-overlay-display org-read-date-overlay txt 'secondary-selection))))
  10125. (defun org-read-date-analyze (ans def defdecode)
  10126. "Analyse the combined answer of the date prompt."
  10127. ;; FIXME: cleanup and comment
  10128. (let (delta deltan deltaw deltadef year month day
  10129. hour minute second wday pm h2 m2 tl wday1
  10130. iso-year iso-weekday iso-week iso-year iso-date)
  10131. (when (string-match "\\`[ \t]*\\.[ \t]*\\'" ans)
  10132. (setq ans "+0"))
  10133. (when (setq delta (org-read-date-get-relative ans (current-time) def))
  10134. (setq ans (replace-match "" t t ans)
  10135. deltan (car delta)
  10136. deltaw (nth 1 delta)
  10137. deltadef (nth 2 delta)))
  10138. ;; Check if there is an iso week date in there
  10139. ;; If yes, sore the info and postpone interpreting it until the rest
  10140. ;; of the parsing is done
  10141. (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
  10142. (setq iso-year (if (match-end 1) (org-small-year-to-year (string-to-number (match-string 1 ans))))
  10143. iso-weekday (if (match-end 3) (string-to-number (match-string 3 ans)))
  10144. iso-week (string-to-number (match-string 2 ans)))
  10145. (setq ans (replace-match "" t t ans)))
  10146. ;; Help matching ISO dates with single digit month ot day, like 2006-8-11.
  10147. (when (string-match
  10148. "^ *\\(\\([0-9]+\\)-\\)?\\([0-1]?[0-9]\\)-\\([0-3]?[0-9]\\)\\([^-0-9]\\|$\\)" ans)
  10149. (setq year (if (match-end 2)
  10150. (string-to-number (match-string 2 ans))
  10151. (string-to-number (format-time-string "%Y")))
  10152. month (string-to-number (match-string 3 ans))
  10153. day (string-to-number (match-string 4 ans)))
  10154. (if (< year 100) (setq year (+ 2000 year)))
  10155. (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
  10156. t nil ans)))
  10157. ;; Help matching am/pm times, because `parse-time-string' does not do that.
  10158. ;; If there is a time with am/pm, and *no* time without it, we convert
  10159. ;; so that matching will be successful.
  10160. (loop for i from 1 to 2 do ; twice, for end time as well
  10161. (when (and (not (string-match "\\(\\`\\|[^+]\\)[012]?[0-9]:[0-9][0-9]\\([ \t\n]\\|$\\)" ans))
  10162. (string-match "\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\(am\\|AM\\|pm\\|PM\\)\\>" ans))
  10163. (setq hour (string-to-number (match-string 1 ans))
  10164. minute (if (match-end 3)
  10165. (string-to-number (match-string 3 ans))
  10166. 0)
  10167. pm (equal ?p
  10168. (string-to-char (downcase (match-string 4 ans)))))
  10169. (if (and (= hour 12) (not pm))
  10170. (setq hour 0)
  10171. (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
  10172. (setq ans (replace-match (format "%02d:%02d" hour minute)
  10173. t t ans))))
  10174. ;; Check if a time range is given as a duration
  10175. (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
  10176. (setq hour (string-to-number (match-string 1 ans))
  10177. h2 (+ hour (string-to-number (match-string 3 ans)))
  10178. minute (string-to-number (match-string 2 ans))
  10179. m2 (+ minute (if (match-end 5) (string-to-number
  10180. (match-string 5 ans))0)))
  10181. (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
  10182. (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
  10183. t t ans)))
  10184. ;; Check if there is a time range
  10185. (when (boundp 'org-end-time-was-given)
  10186. (setq org-time-was-given nil)
  10187. (when (and (string-match org-plain-time-of-day-regexp ans)
  10188. (match-end 8))
  10189. (setq org-end-time-was-given (match-string 8 ans))
  10190. (setq ans (concat (substring ans 0 (match-beginning 7))
  10191. (substring ans (match-end 7))))))
  10192. (setq tl (parse-time-string ans)
  10193. day (or (nth 3 tl) (nth 3 defdecode))
  10194. month (or (nth 4 tl)
  10195. (if (and org-read-date-prefer-future
  10196. (nth 3 tl) (< (nth 3 tl) (nth 3 defdecode)))
  10197. (1+ (nth 4 defdecode))
  10198. (nth 4 defdecode)))
  10199. year (or (nth 5 tl)
  10200. (if (and org-read-date-prefer-future
  10201. (nth 4 tl) (< (nth 4 tl) (nth 4 defdecode)))
  10202. (1+ (nth 5 defdecode))
  10203. (nth 5 defdecode)))
  10204. hour (or (nth 2 tl) (nth 2 defdecode))
  10205. minute (or (nth 1 tl) (nth 1 defdecode))
  10206. second (or (nth 0 tl) 0)
  10207. wday (nth 6 tl))
  10208. ;; Special date definitions below
  10209. (cond
  10210. (iso-week
  10211. ;; There was an iso week
  10212. (setq year (or iso-year year)
  10213. day (or iso-weekday wday 1)
  10214. wday nil ; to make sure that the trigger below does not match
  10215. iso-date (calendar-gregorian-from-absolute
  10216. (calendar-absolute-from-iso
  10217. (list iso-week day year))))
  10218. ; FIXME: Should we also push ISO weeks into the future?
  10219. ; (when (and org-read-date-prefer-future
  10220. ; (not iso-year)
  10221. ; (< (calendar-absolute-from-gregorian iso-date)
  10222. ; (time-to-days (current-time))))
  10223. ; (setq year (1+ year)
  10224. ; iso-date (calendar-gregorian-from-absolute
  10225. ; (calendar-absolute-from-iso
  10226. ; (list iso-week day year)))))
  10227. (setq month (car iso-date)
  10228. year (nth 2 iso-date)
  10229. day (nth 1 iso-date)))
  10230. (deltan
  10231. (unless deltadef
  10232. (let ((now (decode-time (current-time))))
  10233. (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
  10234. (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
  10235. ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
  10236. ((equal deltaw "m") (setq month (+ month deltan)))
  10237. ((equal deltaw "y") (setq year (+ year deltan)))))
  10238. ((and wday (not (nth 3 tl)))
  10239. ;; Weekday was given, but no day, so pick that day in the week
  10240. ;; on or after the derived date.
  10241. (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
  10242. (unless (equal wday wday1)
  10243. (setq day (+ day (% (- wday wday1 -7) 7))))))
  10244. (if (and (boundp 'org-time-was-given)
  10245. (nth 2 tl))
  10246. (setq org-time-was-given t))
  10247. (if (< year 100) (setq year (+ 2000 year)))
  10248. (if (< year 1970) (setq year (nth 5 defdecode))) ; not representable
  10249. (list second minute hour day month year)))
  10250. (defvar parse-time-weekdays)
  10251. (defun org-read-date-get-relative (s today default)
  10252. "Check string S for special relative date string.
  10253. TODAY and DEFAULT are internal times, for today and for a default.
  10254. Return shift list (N what def-flag)
  10255. WHAT is \"d\", \"w\", \"m\", or \"y\" for day, week, month, year.
  10256. N is the number of WHATs to shift.
  10257. DEF-FLAG is t when a double ++ or -- indicates shift relative to
  10258. the DEFAULT date rather than TODAY."
  10259. (when (and
  10260. (string-match
  10261. (concat
  10262. "\\`[ \t]*\\([-+]\\{0,2\\}\\)"
  10263. "\\([0-9]+\\)?"
  10264. "\\([dwmy]\\|\\(" (mapconcat 'car parse-time-weekdays "\\|") "\\)\\)?"
  10265. "\\([ \t]\\|$\\)") s)
  10266. (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
  10267. (let* ((dir (if (> (match-end 1) (match-beginning 1))
  10268. (string-to-char (substring (match-string 1 s) -1))
  10269. ?+))
  10270. (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
  10271. (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
  10272. (what (if (match-end 3) (match-string 3 s) "d"))
  10273. (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
  10274. (date (if rel default today))
  10275. (wday (nth 6 (decode-time date)))
  10276. delta)
  10277. (if wday1
  10278. (progn
  10279. (setq delta (mod (+ 7 (- wday1 wday)) 7))
  10280. (if (= dir ?-) (setq delta (- delta 7)))
  10281. (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
  10282. (list delta "d" rel))
  10283. (list (* n (if (= dir ?-) -1 1)) what rel)))))
  10284. (defun org-eval-in-calendar (form &optional keepdate)
  10285. "Eval FORM in the calendar window and return to current window.
  10286. Also, store the cursor date in variable org-ans2."
  10287. (let ((sw (selected-window)))
  10288. (select-window (get-buffer-window "*Calendar*"))
  10289. (eval form)
  10290. (when (and (not keepdate) (calendar-cursor-to-date))
  10291. (let* ((date (calendar-cursor-to-date))
  10292. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  10293. (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
  10294. (org-move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
  10295. (select-window sw)))
  10296. (defun org-calendar-select ()
  10297. "Return to `org-read-date' with the date currently selected.
  10298. This is used by `org-read-date' in a temporary keymap for the calendar buffer."
  10299. (interactive)
  10300. (when (calendar-cursor-to-date)
  10301. (let* ((date (calendar-cursor-to-date))
  10302. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  10303. (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
  10304. (if (active-minibuffer-window) (exit-minibuffer))))
  10305. (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
  10306. "Insert a date stamp for the date given by the internal TIME.
  10307. WITH-HM means, use the stamp format that includes the time of the day.
  10308. INACTIVE means use square brackets instead of angular ones, so that the
  10309. stamp will not contribute to the agenda.
  10310. PRE and POST are optional strings to be inserted before and after the
  10311. stamp.
  10312. The command returns the inserted time stamp."
  10313. (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
  10314. stamp)
  10315. (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
  10316. (insert-before-markers (or pre ""))
  10317. (insert-before-markers (setq stamp (format-time-string fmt time)))
  10318. (when (listp extra)
  10319. (setq extra (car extra))
  10320. (if (and (stringp extra)
  10321. (string-match "\\([0-9]+\\):\\([0-9]+\\)" extra))
  10322. (setq extra (format "-%02d:%02d"
  10323. (string-to-number (match-string 1 extra))
  10324. (string-to-number (match-string 2 extra))))
  10325. (setq extra nil)))
  10326. (when extra
  10327. (backward-char 1)
  10328. (insert-before-markers extra)
  10329. (forward-char 1))
  10330. (insert-before-markers (or post ""))
  10331. (setq org-last-inserted-timestamp stamp)))
  10332. (defun org-toggle-time-stamp-overlays ()
  10333. "Toggle the use of custom time stamp formats."
  10334. (interactive)
  10335. (setq org-display-custom-times (not org-display-custom-times))
  10336. (unless org-display-custom-times
  10337. (let ((p (point-min)) (bmp (buffer-modified-p)))
  10338. (while (setq p (next-single-property-change p 'display))
  10339. (if (and (get-text-property p 'display)
  10340. (eq (get-text-property p 'face) 'org-date))
  10341. (remove-text-properties
  10342. p (setq p (next-single-property-change p 'display))
  10343. '(display t))))
  10344. (set-buffer-modified-p bmp)))
  10345. (if (featurep 'xemacs)
  10346. (remove-text-properties (point-min) (point-max) '(end-glyph t)))
  10347. (org-restart-font-lock)
  10348. (setq org-table-may-need-update t)
  10349. (if org-display-custom-times
  10350. (message "Time stamps are overlayed with custom format")
  10351. (message "Time stamp overlays removed")))
  10352. (defun org-display-custom-time (beg end)
  10353. "Overlay modified time stamp format over timestamp between BEG and END."
  10354. (let* ((ts (buffer-substring beg end))
  10355. t1 w1 with-hm tf time str w2 (off 0))
  10356. (save-match-data
  10357. (setq t1 (org-parse-time-string ts t))
  10358. (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\)?\\'" ts)
  10359. (setq off (- (match-end 0) (match-beginning 0)))))
  10360. (setq end (- end off))
  10361. (setq w1 (- end beg)
  10362. with-hm (and (nth 1 t1) (nth 2 t1))
  10363. tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
  10364. time (org-fix-decoded-time t1)
  10365. str (org-add-props
  10366. (format-time-string
  10367. (substring tf 1 -1) (apply 'encode-time time))
  10368. nil 'mouse-face 'highlight)
  10369. w2 (length str))
  10370. (if (not (= w2 w1))
  10371. (add-text-properties (1+ beg) (+ 2 beg)
  10372. (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
  10373. (if (featurep 'xemacs)
  10374. (progn
  10375. (put-text-property beg end 'invisible t)
  10376. (put-text-property beg end 'end-glyph (make-glyph str)))
  10377. (put-text-property beg end 'display str))))
  10378. (defun org-translate-time (string)
  10379. "Translate all timestamps in STRING to custom format.
  10380. But do this only if the variable `org-display-custom-times' is set."
  10381. (when org-display-custom-times
  10382. (save-match-data
  10383. (let* ((start 0)
  10384. (re org-ts-regexp-both)
  10385. t1 with-hm inactive tf time str beg end)
  10386. (while (setq start (string-match re string start))
  10387. (setq beg (match-beginning 0)
  10388. end (match-end 0)
  10389. t1 (save-match-data
  10390. (org-parse-time-string (substring string beg end) t))
  10391. with-hm (and (nth 1 t1) (nth 2 t1))
  10392. inactive (equal (substring string beg (1+ beg)) "[")
  10393. tf (funcall (if with-hm 'cdr 'car)
  10394. org-time-stamp-custom-formats)
  10395. time (org-fix-decoded-time t1)
  10396. str (format-time-string
  10397. (concat
  10398. (if inactive "[" "<") (substring tf 1 -1)
  10399. (if inactive "]" ">"))
  10400. (apply 'encode-time time))
  10401. string (replace-match str t t string)
  10402. start (+ start (length str)))))))
  10403. string)
  10404. (defun org-fix-decoded-time (time)
  10405. "Set 0 instead of nil for the first 6 elements of time.
  10406. Don't touch the rest."
  10407. (let ((n 0))
  10408. (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
  10409. (defun org-days-to-time (timestamp-string)
  10410. "Difference between TIMESTAMP-STRING and now in days."
  10411. (- (time-to-days (org-time-string-to-time timestamp-string))
  10412. (time-to-days (current-time))))
  10413. (defun org-deadline-close (timestamp-string &optional ndays)
  10414. "Is the time in TIMESTAMP-STRING close to the current date?"
  10415. (setq ndays (or ndays (org-get-wdays timestamp-string)))
  10416. (and (< (org-days-to-time timestamp-string) ndays)
  10417. (not (org-entry-is-done-p))))
  10418. (defun org-get-wdays (ts)
  10419. "Get the deadline lead time appropriate for timestring TS."
  10420. (cond
  10421. ((<= org-deadline-warning-days 0)
  10422. ;; 0 or negative, enforce this value no matter what
  10423. (- org-deadline-warning-days))
  10424. ((string-match "-\\([0-9]+\\)\\([dwmy]\\)\\(\\'\\|>\\)" ts)
  10425. ;; lead time is specified.
  10426. (floor (* (string-to-number (match-string 1 ts))
  10427. (cdr (assoc (match-string 2 ts)
  10428. '(("d" . 1) ("w" . 7)
  10429. ("m" . 30.4) ("y" . 365.25)))))))
  10430. ;; go for the default.
  10431. (t org-deadline-warning-days)))
  10432. (defun org-calendar-select-mouse (ev)
  10433. "Return to `org-read-date' with the date currently selected.
  10434. This is used by `org-read-date' in a temporary keymap for the calendar buffer."
  10435. (interactive "e")
  10436. (mouse-set-point ev)
  10437. (when (calendar-cursor-to-date)
  10438. (let* ((date (calendar-cursor-to-date))
  10439. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  10440. (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
  10441. (if (active-minibuffer-window) (exit-minibuffer))))
  10442. (defun org-check-deadlines (ndays)
  10443. "Check if there are any deadlines due or past due.
  10444. A deadline is considered due if it happens within `org-deadline-warning-days'
  10445. days from today's date. If the deadline appears in an entry marked DONE,
  10446. it is not shown. The prefix arg NDAYS can be used to test that many
  10447. days. If the prefix is a raw \\[universal-argument] prefix, all deadlines are shown."
  10448. (interactive "P")
  10449. (let* ((org-warn-days
  10450. (cond
  10451. ((equal ndays '(4)) 100000)
  10452. (ndays (prefix-numeric-value ndays))
  10453. (t (abs org-deadline-warning-days))))
  10454. (case-fold-search nil)
  10455. (regexp (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
  10456. (callback
  10457. (lambda () (org-deadline-close (match-string 1) org-warn-days))))
  10458. (message "%d deadlines past-due or due within %d days"
  10459. (org-occur regexp nil callback)
  10460. org-warn-days)))
  10461. (defun org-check-before-date (date)
  10462. "Check if there are deadlines or scheduled entries before DATE."
  10463. (interactive (list (org-read-date)))
  10464. (let ((case-fold-search nil)
  10465. (regexp (concat "\\<\\(" org-deadline-string
  10466. "\\|" org-scheduled-string
  10467. "\\) *<\\([^>]+\\)>"))
  10468. (callback
  10469. (lambda () (time-less-p
  10470. (org-time-string-to-time (match-string 2))
  10471. (org-time-string-to-time date)))))
  10472. (message "%d entries before %s"
  10473. (org-occur regexp nil callback) date)))
  10474. (defun org-evaluate-time-range (&optional to-buffer)
  10475. "Evaluate a time range by computing the difference between start and end.
  10476. Normally the result is just printed in the echo area, but with prefix arg
  10477. TO-BUFFER, the result is inserted just after the date stamp into the buffer.
  10478. If the time range is actually in a table, the result is inserted into the
  10479. next column.
  10480. For time difference computation, a year is assumed to be exactly 365
  10481. days in order to avoid rounding problems."
  10482. (interactive "P")
  10483. (or
  10484. (org-clock-update-time-maybe)
  10485. (save-excursion
  10486. (unless (org-at-date-range-p t)
  10487. (goto-char (point-at-bol))
  10488. (re-search-forward org-tr-regexp-both (point-at-eol) t))
  10489. (if (not (org-at-date-range-p t))
  10490. (error "Not at a time-stamp range, and none found in current line")))
  10491. (let* ((ts1 (match-string 1))
  10492. (ts2 (match-string 2))
  10493. (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
  10494. (match-end (match-end 0))
  10495. (time1 (org-time-string-to-time ts1))
  10496. (time2 (org-time-string-to-time ts2))
  10497. (t1 (time-to-seconds time1))
  10498. (t2 (time-to-seconds time2))
  10499. (diff (abs (- t2 t1)))
  10500. (negative (< (- t2 t1) 0))
  10501. ;; (ys (floor (* 365 24 60 60)))
  10502. (ds (* 24 60 60))
  10503. (hs (* 60 60))
  10504. (fy "%dy %dd %02d:%02d")
  10505. (fy1 "%dy %dd")
  10506. (fd "%dd %02d:%02d")
  10507. (fd1 "%dd")
  10508. (fh "%02d:%02d")
  10509. y d h m align)
  10510. (if havetime
  10511. (setq ; y (floor (/ diff ys)) diff (mod diff ys)
  10512. y 0
  10513. d (floor (/ diff ds)) diff (mod diff ds)
  10514. h (floor (/ diff hs)) diff (mod diff hs)
  10515. m (floor (/ diff 60)))
  10516. (setq ; y (floor (/ diff ys)) diff (mod diff ys)
  10517. y 0
  10518. d (floor (+ (/ diff ds) 0.5))
  10519. h 0 m 0))
  10520. (if (not to-buffer)
  10521. (message "%s" (org-make-tdiff-string y d h m))
  10522. (if (org-at-table-p)
  10523. (progn
  10524. (goto-char match-end)
  10525. (setq align t)
  10526. (and (looking-at " *|") (goto-char (match-end 0))))
  10527. (goto-char match-end))
  10528. (if (looking-at
  10529. "\\( *-? *[0-9]+y\\)?\\( *[0-9]+d\\)? *[0-9][0-9]:[0-9][0-9]")
  10530. (replace-match ""))
  10531. (if negative (insert " -"))
  10532. (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
  10533. (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
  10534. (insert " " (format fh h m))))
  10535. (if align (org-table-align))
  10536. (message "Time difference inserted")))))
  10537. (defun org-make-tdiff-string (y d h m)
  10538. (let ((fmt "")
  10539. (l nil))
  10540. (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
  10541. l (push y l)))
  10542. (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
  10543. l (push d l)))
  10544. (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
  10545. l (push h l)))
  10546. (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
  10547. l (push m l)))
  10548. (apply 'format fmt (nreverse l))))
  10549. (defun org-time-string-to-time (s)
  10550. (apply 'encode-time (org-parse-time-string s)))
  10551. (defun org-time-string-to-absolute (s &optional daynr prefer show-all)
  10552. "Convert a time stamp to an absolute day number.
  10553. If there is a specifyer for a cyclic time stamp, get the closest date to
  10554. DAYNR.
  10555. PREFER and SHOW-ALL are passed through to `org-closest-date'."
  10556. (cond
  10557. ((and daynr (string-match "\\`%%\\((.*)\\)" s))
  10558. (if (org-diary-sexp-entry (match-string 1 s) "" date)
  10559. daynr
  10560. (+ daynr 1000)))
  10561. ((and daynr (string-match "\\+[0-9]+[dwmy]" s))
  10562. (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
  10563. (time-to-days (current-time))) (match-string 0 s)
  10564. prefer show-all))
  10565. (t (time-to-days (apply 'encode-time (org-parse-time-string s))))))
  10566. (defun org-days-to-iso-week (days)
  10567. "Return the iso week number."
  10568. (require 'cal-iso)
  10569. (car (calendar-iso-from-absolute days)))
  10570. (defun org-small-year-to-year (year)
  10571. "Convert 2-digit years into 4-digit years.
  10572. 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
  10573. The year 2000 cannot be abbreviated. Any year larger than 99
  10574. is returned unchanged."
  10575. (if (< year 38)
  10576. (setq year (+ 2000 year))
  10577. (if (< year 100)
  10578. (setq year (+ 1900 year))))
  10579. year)
  10580. (defun org-time-from-absolute (d)
  10581. "Return the time corresponding to date D.
  10582. D may be an absolute day number, or a calendar-type list (month day year)."
  10583. (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
  10584. (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
  10585. (defun org-calendar-holiday ()
  10586. "List of holidays, for Diary display in Org-mode."
  10587. (require 'holidays)
  10588. (let ((hl (funcall
  10589. (if (fboundp 'calendar-check-holidays)
  10590. 'calendar-check-holidays 'check-calendar-holidays) date)))
  10591. (if hl (mapconcat 'identity hl "; "))))
  10592. (defun org-diary-sexp-entry (sexp entry date)
  10593. "Process a SEXP diary ENTRY for DATE."
  10594. (require 'diary-lib)
  10595. (let ((result (if calendar-debug-sexp
  10596. (let ((stack-trace-on-error t))
  10597. (eval (car (read-from-string sexp))))
  10598. (condition-case nil
  10599. (eval (car (read-from-string sexp)))
  10600. (error
  10601. (beep)
  10602. (message "Bad sexp at line %d in %s: %s"
  10603. (org-current-line)
  10604. (buffer-file-name) sexp)
  10605. (sleep-for 2))))))
  10606. (cond ((stringp result) result)
  10607. ((and (consp result)
  10608. (stringp (cdr result))) (cdr result))
  10609. (result entry)
  10610. (t nil))))
  10611. (defun org-diary-to-ical-string (frombuf)
  10612. "Get iCalendar entries from diary entries in buffer FROMBUF.
  10613. This uses the icalendar.el library."
  10614. (let* ((tmpdir (if (featurep 'xemacs)
  10615. (temp-directory)
  10616. temporary-file-directory))
  10617. (tmpfile (make-temp-name
  10618. (expand-file-name "orgics" tmpdir)))
  10619. buf rtn b e)
  10620. (save-excursion
  10621. (set-buffer frombuf)
  10622. (icalendar-export-region (point-min) (point-max) tmpfile)
  10623. (setq buf (find-buffer-visiting tmpfile))
  10624. (set-buffer buf)
  10625. (goto-char (point-min))
  10626. (if (re-search-forward "^BEGIN:VEVENT" nil t)
  10627. (setq b (match-beginning 0)))
  10628. (goto-char (point-max))
  10629. (if (re-search-backward "^END:VEVENT" nil t)
  10630. (setq e (match-end 0)))
  10631. (setq rtn (if (and b e) (concat (buffer-substring b e) "\n") "")))
  10632. (kill-buffer buf)
  10633. (delete-file tmpfile)
  10634. rtn))
  10635. (defun org-closest-date (start current change prefer show-all)
  10636. "Find the date closest to CURRENT that is consistent with START and CHANGE.
  10637. When PREFER is `past' return a date that is either CURRENT or past.
  10638. When PREFER is `future', return a date that is either CURRENT or future.
  10639. When SHOW-ALL is nil, only return the current occurrence of a time stamp."
  10640. ;; Make the proper lists from the dates
  10641. (catch 'exit
  10642. (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
  10643. dn dw sday cday n1 n2 n0
  10644. d m y y1 y2 date1 date2 nmonths nm ny m2)
  10645. (setq start (org-date-to-gregorian start)
  10646. current (org-date-to-gregorian
  10647. (if show-all
  10648. current
  10649. (time-to-days (current-time))))
  10650. sday (calendar-absolute-from-gregorian start)
  10651. cday (calendar-absolute-from-gregorian current))
  10652. (if (<= cday sday) (throw 'exit sday))
  10653. (if (string-match "\\(\\+[0-9]+\\)\\([dwmy]\\)" change)
  10654. (setq dn (string-to-number (match-string 1 change))
  10655. dw (cdr (assoc (match-string 2 change) a1)))
  10656. (error "Invalid change specifyer: %s" change))
  10657. (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
  10658. (cond
  10659. ((eq dw 'day)
  10660. (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
  10661. n2 (+ n1 dn)))
  10662. ((eq dw 'year)
  10663. (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
  10664. (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
  10665. (setq date1 (list m d y1)
  10666. n1 (calendar-absolute-from-gregorian date1)
  10667. date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
  10668. n2 (calendar-absolute-from-gregorian date2)))
  10669. ((eq dw 'month)
  10670. ;; approx number of month between the two dates
  10671. (setq nmonths (floor (/ (- cday sday) 30.436875)))
  10672. ;; How often does dn fit in there?
  10673. (setq d (nth 1 start) m (car start) y (nth 2 start)
  10674. nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
  10675. m (+ m nm)
  10676. ny (floor (/ m 12))
  10677. y (+ y ny)
  10678. m (- m (* ny 12)))
  10679. (while (> m 12) (setq m (- m 12) y (1+ y)))
  10680. (setq n1 (calendar-absolute-from-gregorian (list m d y)))
  10681. (setq m2 (+ m dn) y2 y)
  10682. (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
  10683. (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
  10684. (while (<= n2 cday)
  10685. (setq n1 n2 m m2 y y2)
  10686. (setq m2 (+ m dn) y2 y)
  10687. (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
  10688. (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
  10689. ;; Make sure n1 is the earlier date
  10690. (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
  10691. (if show-all
  10692. (cond
  10693. ((eq prefer 'past) n1)
  10694. ((eq prefer 'future) (if (= cday n1) n1 n2))
  10695. (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
  10696. (cond
  10697. ((eq prefer 'past) n1)
  10698. ((eq prefer 'future) (if (= cday n1) n1 n2))
  10699. (t (if (= cday n1) n1 n2)))))))
  10700. (defun org-date-to-gregorian (date)
  10701. "Turn any specification of DATE into a gregorian date for the calendar."
  10702. (cond ((integerp date) (calendar-gregorian-from-absolute date))
  10703. ((and (listp date) (= (length date) 3)) date)
  10704. ((stringp date)
  10705. (setq date (org-parse-time-string date))
  10706. (list (nth 4 date) (nth 3 date) (nth 5 date)))
  10707. ((listp date)
  10708. (list (nth 4 date) (nth 3 date) (nth 5 date)))))
  10709. (defun org-parse-time-string (s &optional nodefault)
  10710. "Parse the standard Org-mode time string.
  10711. This should be a lot faster than the normal `parse-time-string'.
  10712. If time is not given, defaults to 0:00. However, with optional NODEFAULT,
  10713. hour and minute fields will be nil if not given."
  10714. (if (string-match org-ts-regexp0 s)
  10715. (list 0
  10716. (if (or (match-beginning 8) (not nodefault))
  10717. (string-to-number (or (match-string 8 s) "0")))
  10718. (if (or (match-beginning 7) (not nodefault))
  10719. (string-to-number (or (match-string 7 s) "0")))
  10720. (string-to-number (match-string 4 s))
  10721. (string-to-number (match-string 3 s))
  10722. (string-to-number (match-string 2 s))
  10723. nil nil nil)
  10724. (make-list 9 0)))
  10725. (defun org-timestamp-up (&optional arg)
  10726. "Increase the date item at the cursor by one.
  10727. If the cursor is on the year, change the year. If it is on the month or
  10728. the day, change that.
  10729. With prefix ARG, change by that many units."
  10730. (interactive "p")
  10731. (org-timestamp-change (prefix-numeric-value arg)))
  10732. (defun org-timestamp-down (&optional arg)
  10733. "Decrease the date item at the cursor by one.
  10734. If the cursor is on the year, change the year. If it is on the month or
  10735. the day, change that.
  10736. With prefix ARG, change by that many units."
  10737. (interactive "p")
  10738. (org-timestamp-change (- (prefix-numeric-value arg))))
  10739. (defun org-timestamp-up-day (&optional arg)
  10740. "Increase the date in the time stamp by one day.
  10741. With prefix ARG, change that many days."
  10742. (interactive "p")
  10743. (if (and (not (org-at-timestamp-p t))
  10744. (org-on-heading-p))
  10745. (org-todo 'up)
  10746. (org-timestamp-change (prefix-numeric-value arg) 'day)))
  10747. (defun org-timestamp-down-day (&optional arg)
  10748. "Decrease the date in the time stamp by one day.
  10749. With prefix ARG, change that many days."
  10750. (interactive "p")
  10751. (if (and (not (org-at-timestamp-p t))
  10752. (org-on-heading-p))
  10753. (org-todo 'down)
  10754. (org-timestamp-change (- (prefix-numeric-value arg)) 'day)))
  10755. (defun org-at-timestamp-p (&optional inactive-ok)
  10756. "Determine if the cursor is in or at a timestamp."
  10757. (interactive)
  10758. (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
  10759. (pos (point))
  10760. (ans (or (looking-at tsr)
  10761. (save-excursion
  10762. (skip-chars-backward "^[<\n\r\t")
  10763. (if (> (point) (point-min)) (backward-char 1))
  10764. (and (looking-at tsr)
  10765. (> (- (match-end 0) pos) -1))))))
  10766. (and ans
  10767. (boundp 'org-ts-what)
  10768. (setq org-ts-what
  10769. (cond
  10770. ((= pos (match-beginning 0)) 'bracket)
  10771. ((= pos (1- (match-end 0))) 'bracket)
  10772. ((org-pos-in-match-range pos 2) 'year)
  10773. ((org-pos-in-match-range pos 3) 'month)
  10774. ((org-pos-in-match-range pos 7) 'hour)
  10775. ((org-pos-in-match-range pos 8) 'minute)
  10776. ((or (org-pos-in-match-range pos 4)
  10777. (org-pos-in-match-range pos 5)) 'day)
  10778. ((and (> pos (or (match-end 8) (match-end 5)))
  10779. (< pos (match-end 0)))
  10780. (- pos (or (match-end 8) (match-end 5))))
  10781. (t 'day))))
  10782. ans))
  10783. (defun org-toggle-timestamp-type ()
  10784. "Toggle the type (<active> or [inactive]) of a time stamp."
  10785. (interactive)
  10786. (when (org-at-timestamp-p t)
  10787. (let ((beg (match-beginning 0)) (end (match-end 0))
  10788. (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
  10789. (save-excursion
  10790. (goto-char beg)
  10791. (while (re-search-forward "[][<>]" end t)
  10792. (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
  10793. t t)))
  10794. (message "Timestamp is now %sactive"
  10795. (if (equal (char-after beg) ?<) "" "in")))))
  10796. (defun org-timestamp-change (n &optional what)
  10797. "Change the date in the time stamp at point.
  10798. The date will be changed by N times WHAT. WHAT can be `day', `month',
  10799. `year', `minute', `second'. If WHAT is not given, the cursor position
  10800. in the timestamp determines what will be changed."
  10801. (let ((pos (point))
  10802. with-hm inactive
  10803. (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
  10804. org-ts-what
  10805. extra rem
  10806. ts time time0)
  10807. (if (not (org-at-timestamp-p t))
  10808. (error "Not at a timestamp"))
  10809. (if (and (not what) (eq org-ts-what 'bracket))
  10810. (org-toggle-timestamp-type)
  10811. (if (and (not what) (not (eq org-ts-what 'day))
  10812. org-display-custom-times
  10813. (get-text-property (point) 'display)
  10814. (not (get-text-property (1- (point)) 'display)))
  10815. (setq org-ts-what 'day))
  10816. (setq org-ts-what (or what org-ts-what)
  10817. inactive (= (char-after (match-beginning 0)) ?\[)
  10818. ts (match-string 0))
  10819. (replace-match "")
  10820. (if (string-match
  10821. "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?[-+][0-9]+[dwmy]\\)*\\)[]>]"
  10822. ts)
  10823. (setq extra (match-string 1 ts)))
  10824. (if (string-match "^.\\{10\\}.*?[0-9]+:[0-9][0-9]" ts)
  10825. (setq with-hm t))
  10826. (setq time0 (org-parse-time-string ts))
  10827. (when (and (eq org-ts-what 'minute)
  10828. (eq current-prefix-arg nil))
  10829. (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
  10830. (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
  10831. (setcar (cdr time0) (+ (nth 1 time0)
  10832. (if (> n 0) (- rem) (- dm rem))))))
  10833. (setq time
  10834. (encode-time (or (car time0) 0)
  10835. (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
  10836. (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
  10837. (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
  10838. (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
  10839. (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
  10840. (nthcdr 6 time0)))
  10841. (when (integerp org-ts-what)
  10842. (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
  10843. (if (eq what 'calendar)
  10844. (let ((cal-date (org-get-date-from-calendar)))
  10845. (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
  10846. (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
  10847. (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
  10848. (setcar time0 (or (car time0) 0))
  10849. (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
  10850. (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
  10851. (setq time (apply 'encode-time time0))))
  10852. (setq org-last-changed-timestamp
  10853. (org-insert-time-stamp time with-hm inactive nil nil extra))
  10854. (org-clock-update-time-maybe)
  10855. (goto-char pos)
  10856. ;; Try to recenter the calendar window, if any
  10857. (if (and org-calendar-follow-timestamp-change
  10858. (get-buffer-window "*Calendar*" t)
  10859. (memq org-ts-what '(day month year)))
  10860. (org-recenter-calendar (time-to-days time))))))
  10861. (defun org-modify-ts-extra (s pos n dm)
  10862. "Change the different parts of the lead-time and repeat fields in timestamp."
  10863. (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
  10864. ng h m new rem)
  10865. (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
  10866. (cond
  10867. ((or (org-pos-in-match-range pos 2)
  10868. (org-pos-in-match-range pos 3))
  10869. (setq m (string-to-number (match-string 3 s))
  10870. h (string-to-number (match-string 2 s)))
  10871. (if (org-pos-in-match-range pos 2)
  10872. (setq h (+ h n))
  10873. (setq n (* dm (org-no-warnings (signum n))))
  10874. (when (not (= 0 (setq rem (% m dm))))
  10875. (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
  10876. (setq m (+ m n)))
  10877. (if (< m 0) (setq m (+ m 60) h (1- h)))
  10878. (if (> m 59) (setq m (- m 60) h (1+ h)))
  10879. (setq h (min 24 (max 0 h)))
  10880. (setq ng 1 new (format "-%02d:%02d" h m)))
  10881. ((org-pos-in-match-range pos 6)
  10882. (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
  10883. ((org-pos-in-match-range pos 5)
  10884. (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
  10885. ((org-pos-in-match-range pos 9)
  10886. (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
  10887. ((org-pos-in-match-range pos 8)
  10888. (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
  10889. (when ng
  10890. (setq s (concat
  10891. (substring s 0 (match-beginning ng))
  10892. new
  10893. (substring s (match-end ng))))))
  10894. s))
  10895. (defun org-recenter-calendar (date)
  10896. "If the calendar is visible, recenter it to DATE."
  10897. (let* ((win (selected-window))
  10898. (cwin (get-buffer-window "*Calendar*" t))
  10899. (calendar-move-hook nil))
  10900. (when cwin
  10901. (select-window cwin)
  10902. (calendar-goto-date (if (listp date) date
  10903. (calendar-gregorian-from-absolute date)))
  10904. (select-window win))))
  10905. (defun org-goto-calendar (&optional arg)
  10906. "Go to the Emacs calendar at the current date.
  10907. If there is a time stamp in the current line, go to that date.
  10908. A prefix ARG can be used to force the current date."
  10909. (interactive "P")
  10910. (let ((tsr org-ts-regexp) diff
  10911. (calendar-move-hook nil)
  10912. (calendar-view-holidays-initially-flag nil)
  10913. (view-calendar-holidays-initially nil)
  10914. (calendar-view-diary-initially-flag nil)
  10915. (view-diary-entries-initially nil))
  10916. (if (or (org-at-timestamp-p)
  10917. (save-excursion
  10918. (beginning-of-line 1)
  10919. (looking-at (concat ".*" tsr))))
  10920. (let ((d1 (time-to-days (current-time)))
  10921. (d2 (time-to-days
  10922. (org-time-string-to-time (match-string 1)))))
  10923. (setq diff (- d2 d1))))
  10924. (calendar)
  10925. (calendar-goto-today)
  10926. (if (and diff (not arg)) (calendar-forward-day diff))))
  10927. (defun org-get-date-from-calendar ()
  10928. "Return a list (month day year) of date at point in calendar."
  10929. (with-current-buffer "*Calendar*"
  10930. (save-match-data
  10931. (calendar-cursor-to-date))))
  10932. (defun org-date-from-calendar ()
  10933. "Insert time stamp corresponding to cursor date in *Calendar* buffer.
  10934. If there is already a time stamp at the cursor position, update it."
  10935. (interactive)
  10936. (if (org-at-timestamp-p t)
  10937. (org-timestamp-change 0 'calendar)
  10938. (let ((cal-date (org-get-date-from-calendar)))
  10939. (org-insert-time-stamp
  10940. (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
  10941. (defun org-minutes-to-hh:mm-string (m)
  10942. "Compute H:MM from a number of minutes."
  10943. (let ((h (/ m 60)))
  10944. (setq m (- m (* 60 h)))
  10945. (format org-time-clocksum-format h m)))
  10946. (defun org-hh:mm-string-to-minutes (s)
  10947. "Convert a string H:MM to a number of minutes."
  10948. (if (string-match "\\([0-9]+\\):\\([0-9]+\\)" s)
  10949. (+ (* (string-to-number (match-string 1 s)) 60)
  10950. (string-to-number (match-string 2 s)))
  10951. 0))
  10952. ;;;; Agenda files
  10953. ;;;###autoload
  10954. (defun org-iswitchb (&optional arg)
  10955. "Use `iswitchb-read-buffer' to prompt for an Org buffer to switch to.
  10956. With a prefix argument, restrict available to files.
  10957. With two prefix arguments, restrict available buffers to agenda files.
  10958. Due to some yet unresolved reason, the global function
  10959. `iswitchb-mode' needs to be active for this function to work."
  10960. (interactive "P")
  10961. (require 'iswitchb)
  10962. (let ((enabled iswitchb-mode) blist)
  10963. (or enabled (iswitchb-mode 1))
  10964. (setq blist (cond ((equal arg '(4)) (org-buffer-list 'files))
  10965. ((equal arg '(16)) (org-buffer-list 'agenda))
  10966. (t (org-buffer-list))))
  10967. (unwind-protect
  10968. (let ((iswitchb-make-buflist-hook
  10969. (lambda ()
  10970. (setq iswitchb-temp-buflist
  10971. (mapcar 'buffer-name blist)))))
  10972. (switch-to-buffer
  10973. (iswitchb-read-buffer
  10974. "Switch-to: " nil t))
  10975. (or enabled (iswitchb-mode -1))))))
  10976. ;;;###autoload
  10977. (defun org-ido-switchb (&optional arg)
  10978. "Use `org-ido-completing-read' to prompt for an Org buffer to switch to.
  10979. With a prefix argument, restrict available to files.
  10980. With two prefix arguments, restrict available buffers to agenda files."
  10981. (interactive "P")
  10982. (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
  10983. ((equal arg '(16)) (org-buffer-list 'agenda))
  10984. (t (org-buffer-list)))))
  10985. (switch-to-buffer
  10986. (org-ido-completing-read "Org buffer: "
  10987. (mapcar 'buffer-name blist)
  10988. nil t))))
  10989. (defun org-buffer-list (&optional predicate exclude-tmp)
  10990. "Return a list of Org buffers.
  10991. PREDICATE can be `export', `files' or `agenda'.
  10992. export restrict the list to Export buffers.
  10993. files restrict the list to buffers visiting Org files.
  10994. agenda restrict the list to buffers visiting agenda files.
  10995. If EXCLUDE-TMP is non-nil, ignore temporary buffers."
  10996. (let* ((bfn nil)
  10997. (agenda-files (and (eq predicate 'agenda)
  10998. (mapcar 'file-truename (org-agenda-files t))))
  10999. (filter
  11000. (cond
  11001. ((eq predicate 'files)
  11002. (lambda (b) (with-current-buffer b (eq major-mode 'org-mode))))
  11003. ((eq predicate 'export)
  11004. (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
  11005. ((eq predicate 'agenda)
  11006. (lambda (b)
  11007. (with-current-buffer b
  11008. (and (eq major-mode 'org-mode)
  11009. (setq bfn (buffer-file-name b))
  11010. (member (file-truename bfn) agenda-files)))))
  11011. (t (lambda (b) (with-current-buffer b
  11012. (or (eq major-mode 'org-mode)
  11013. (string-match "\*Org .*Export"
  11014. (buffer-name b)))))))))
  11015. (delq nil
  11016. (mapcar
  11017. (lambda(b)
  11018. (if (and (funcall filter b)
  11019. (or (not exclude-tmp)
  11020. (not (string-match "tmp" (buffer-name b)))))
  11021. b
  11022. nil))
  11023. (buffer-list)))))
  11024. (defun org-agenda-files (&optional unrestricted archives)
  11025. "Get the list of agenda files.
  11026. Optional UNRESTRICTED means return the full list even if a restriction
  11027. is currently in place.
  11028. When ARCHIVES is t, include all archive files hat are really being
  11029. used by the agenda files. If ARCHIVE is `ifmode', do this only if
  11030. `org-agenda-archives-mode' is t."
  11031. (let ((files
  11032. (cond
  11033. ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
  11034. ((stringp org-agenda-files) (org-read-agenda-file-list))
  11035. ((listp org-agenda-files) org-agenda-files)
  11036. (t (error "Invalid value of `org-agenda-files'")))))
  11037. (setq files (apply 'append
  11038. (mapcar (lambda (f)
  11039. (if (file-directory-p f)
  11040. (directory-files
  11041. f t org-agenda-file-regexp)
  11042. (list f)))
  11043. files)))
  11044. (when org-agenda-skip-unavailable-files
  11045. (setq files (delq nil
  11046. (mapcar (function
  11047. (lambda (file)
  11048. (and (file-readable-p file) file)))
  11049. files))))
  11050. (when (or (eq archives t)
  11051. (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
  11052. (setq files (org-add-archive-files files)))
  11053. files))
  11054. (defun org-edit-agenda-file-list ()
  11055. "Edit the list of agenda files.
  11056. Depending on setup, this either uses customize to edit the variable
  11057. `org-agenda-files', or it visits the file that is holding the list. In the
  11058. latter case, the buffer is set up in a way that saving it automatically kills
  11059. the buffer and restores the previous window configuration."
  11060. (interactive)
  11061. (if (stringp org-agenda-files)
  11062. (let ((cw (current-window-configuration)))
  11063. (find-file org-agenda-files)
  11064. (org-set-local 'org-window-configuration cw)
  11065. (org-add-hook 'after-save-hook
  11066. (lambda ()
  11067. (set-window-configuration
  11068. (prog1 org-window-configuration
  11069. (kill-buffer (current-buffer))))
  11070. (org-install-agenda-files-menu)
  11071. (message "New agenda file list installed"))
  11072. nil 'local)
  11073. (message "%s" (substitute-command-keys
  11074. "Edit list and finish with \\[save-buffer]")))
  11075. (customize-variable 'org-agenda-files)))
  11076. (defun org-store-new-agenda-file-list (list)
  11077. "Set new value for the agenda file list and save it correctly."
  11078. (if (stringp org-agenda-files)
  11079. (let ((f org-agenda-files) b)
  11080. (while (setq b (find-buffer-visiting f)) (kill-buffer b))
  11081. (with-temp-file f
  11082. (insert (mapconcat 'identity list "\n") "\n")))
  11083. (let ((org-mode-hook nil) (default-major-mode 'fundamental-mode))
  11084. (setq org-agenda-files list)
  11085. (customize-save-variable 'org-agenda-files org-agenda-files))))
  11086. (defun org-read-agenda-file-list ()
  11087. "Read the list of agenda files from a file."
  11088. (when (file-directory-p org-agenda-files)
  11089. (error "`org-agenda-files' cannot be a single directory"))
  11090. (when (stringp org-agenda-files)
  11091. (with-temp-buffer
  11092. (insert-file-contents org-agenda-files)
  11093. (org-split-string (buffer-string) "[ \t\r\n]*?[\r\n][ \t\r\n]*"))))
  11094. ;;;###autoload
  11095. (defun org-cycle-agenda-files ()
  11096. "Cycle through the files in `org-agenda-files'.
  11097. If the current buffer visits an agenda file, find the next one in the list.
  11098. If the current buffer does not, find the first agenda file."
  11099. (interactive)
  11100. (let* ((fs (org-agenda-files t))
  11101. (files (append fs (list (car fs))))
  11102. (tcf (if buffer-file-name (file-truename buffer-file-name)))
  11103. file)
  11104. (unless files (error "No agenda files"))
  11105. (catch 'exit
  11106. (while (setq file (pop files))
  11107. (if (equal (file-truename file) tcf)
  11108. (when (car files)
  11109. (find-file (car files))
  11110. (throw 'exit t))))
  11111. (find-file (car fs)))
  11112. (if (buffer-base-buffer) (switch-to-buffer (buffer-base-buffer)))))
  11113. (defun org-agenda-file-to-front (&optional to-end)
  11114. "Move/add the current file to the top of the agenda file list.
  11115. If the file is not present in the list, it is added to the front. If it is
  11116. present, it is moved there. With optional argument TO-END, add/move to the
  11117. end of the list."
  11118. (interactive "P")
  11119. (let ((org-agenda-skip-unavailable-files nil)
  11120. (file-alist (mapcar (lambda (x)
  11121. (cons (file-truename x) x))
  11122. (org-agenda-files t)))
  11123. (ctf (file-truename buffer-file-name))
  11124. x had)
  11125. (setq x (assoc ctf file-alist) had x)
  11126. (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
  11127. (if to-end
  11128. (setq file-alist (append (delq x file-alist) (list x)))
  11129. (setq file-alist (cons x (delq x file-alist))))
  11130. (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
  11131. (org-install-agenda-files-menu)
  11132. (message "File %s to %s of agenda file list"
  11133. (if had "moved" "added") (if to-end "end" "front"))))
  11134. (defun org-remove-file (&optional file)
  11135. "Remove current file from the list of files in variable `org-agenda-files'.
  11136. These are the files which are being checked for agenda entries.
  11137. Optional argument FILE means, use this file instead of the current."
  11138. (interactive)
  11139. (let* ((org-agenda-skip-unavailable-files nil)
  11140. (file (or file buffer-file-name))
  11141. (true-file (file-truename file))
  11142. (afile (abbreviate-file-name file))
  11143. (files (delq nil (mapcar
  11144. (lambda (x)
  11145. (if (equal true-file
  11146. (file-truename x))
  11147. nil x))
  11148. (org-agenda-files t)))))
  11149. (if (not (= (length files) (length (org-agenda-files t))))
  11150. (progn
  11151. (org-store-new-agenda-file-list files)
  11152. (org-install-agenda-files-menu)
  11153. (message "Removed file: %s" afile))
  11154. (message "File was not in list: %s (not removed)" afile))))
  11155. (defun org-file-menu-entry (file)
  11156. (vector file (list 'find-file file) t))
  11157. (defun org-check-agenda-file (file)
  11158. "Make sure FILE exists. If not, ask user what to do."
  11159. (when (not (file-exists-p file))
  11160. (message "non-existent file %s. [R]emove from list or [A]bort?"
  11161. (abbreviate-file-name file))
  11162. (let ((r (downcase (read-char-exclusive))))
  11163. (cond
  11164. ((equal r ?r)
  11165. (org-remove-file file)
  11166. (throw 'nextfile t))
  11167. (t (error "Abort"))))))
  11168. (defun org-get-agenda-file-buffer (file)
  11169. "Get a buffer visiting FILE. If the buffer needs to be created, add
  11170. it to the list of buffers which might be released later."
  11171. (let ((buf (org-find-base-buffer-visiting file)))
  11172. (if buf
  11173. buf ; just return it
  11174. ;; Make a new buffer and remember it
  11175. (setq buf (find-file-noselect file))
  11176. (if buf (push buf org-agenda-new-buffers))
  11177. buf)))
  11178. (defun org-release-buffers (blist)
  11179. "Release all buffers in list, asking the user for confirmation when needed.
  11180. When a buffer is unmodified, it is just killed. When modified, it is saved
  11181. \(if the user agrees) and then killed."
  11182. (let (buf file)
  11183. (while (setq buf (pop blist))
  11184. (setq file (buffer-file-name buf))
  11185. (when (and (buffer-modified-p buf)
  11186. file
  11187. (y-or-n-p (format "Save file %s? " file)))
  11188. (with-current-buffer buf (save-buffer)))
  11189. (kill-buffer buf))))
  11190. (defun org-prepare-agenda-buffers (files)
  11191. "Create buffers for all agenda files, protect archived trees and comments."
  11192. (interactive)
  11193. (let ((pa '(:org-archived t))
  11194. (pc '(:org-comment t))
  11195. (pall '(:org-archived t :org-comment t))
  11196. (inhibit-read-only t)
  11197. (rea (concat ":" org-archive-tag ":"))
  11198. bmp file re)
  11199. (save-excursion
  11200. (save-restriction
  11201. (while (setq file (pop files))
  11202. (if (bufferp file)
  11203. (set-buffer file)
  11204. (org-check-agenda-file file)
  11205. (set-buffer (org-get-agenda-file-buffer file)))
  11206. (widen)
  11207. (setq bmp (buffer-modified-p))
  11208. (org-refresh-category-properties)
  11209. (setq org-todo-keywords-for-agenda
  11210. (append org-todo-keywords-for-agenda org-todo-keywords-1))
  11211. (setq org-done-keywords-for-agenda
  11212. (append org-done-keywords-for-agenda org-done-keywords))
  11213. (setq org-todo-keyword-alist-for-agenda
  11214. (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
  11215. (setq org-tag-alist-for-agenda
  11216. (append org-tag-alist-for-agenda org-tag-alist))
  11217. (save-excursion
  11218. (remove-text-properties (point-min) (point-max) pall)
  11219. (when org-agenda-skip-archived-trees
  11220. (goto-char (point-min))
  11221. (while (re-search-forward rea nil t)
  11222. (if (org-on-heading-p t)
  11223. (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
  11224. (goto-char (point-min))
  11225. (setq re (concat "^\\*+ +" org-comment-string "\\>"))
  11226. (while (re-search-forward re nil t)
  11227. (add-text-properties
  11228. (match-beginning 0) (org-end-of-subtree t) pc)))
  11229. (set-buffer-modified-p bmp))))
  11230. (setq org-todo-keyword-alist-for-agenda
  11231. (org-uniquify org-todo-keyword-alist-for-agenda)
  11232. org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
  11233. ;;;; Embedded LaTeX
  11234. (defvar org-cdlatex-mode-map (make-sparse-keymap)
  11235. "Keymap for the minor `org-cdlatex-mode'.")
  11236. (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
  11237. (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
  11238. (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
  11239. (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
  11240. (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
  11241. (defvar org-cdlatex-texmathp-advice-is-done nil
  11242. "Flag remembering if we have applied the advice to texmathp already.")
  11243. (define-minor-mode org-cdlatex-mode
  11244. "Toggle the minor `org-cdlatex-mode'.
  11245. This mode supports entering LaTeX environment and math in LaTeX fragments
  11246. in Org-mode.
  11247. \\{org-cdlatex-mode-map}"
  11248. nil " OCDL" nil
  11249. (when org-cdlatex-mode (require 'cdlatex))
  11250. (unless org-cdlatex-texmathp-advice-is-done
  11251. (setq org-cdlatex-texmathp-advice-is-done t)
  11252. (defadvice texmathp (around org-math-always-on activate)
  11253. "Always return t in org-mode buffers.
  11254. This is because we want to insert math symbols without dollars even outside
  11255. the LaTeX math segments. If Orgmode thinks that point is actually inside
  11256. an embedded LaTeX fragment, let texmathp do its job.
  11257. \\[org-cdlatex-mode-map]"
  11258. (interactive)
  11259. (let (p)
  11260. (cond
  11261. ((not (org-mode-p)) ad-do-it)
  11262. ((eq this-command 'cdlatex-math-symbol)
  11263. (setq ad-return-value t
  11264. texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
  11265. (t
  11266. (let ((p (org-inside-LaTeX-fragment-p)))
  11267. (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
  11268. (setq ad-return-value t
  11269. texmathp-why '("Org-mode embedded math" . 0))
  11270. (if p ad-do-it)))))))))
  11271. (defun turn-on-org-cdlatex ()
  11272. "Unconditionally turn on `org-cdlatex-mode'."
  11273. (org-cdlatex-mode 1))
  11274. (defun org-inside-LaTeX-fragment-p ()
  11275. "Test if point is inside a LaTeX fragment.
  11276. I.e. after a \\begin, \\(, \\[, $, or $$, without the corresponding closing
  11277. sequence appearing also before point.
  11278. Even though the matchers for math are configurable, this function assumes
  11279. that \\begin, \\(, \\[, and $$ are always used. Only the single dollar
  11280. delimiters are skipped when they have been removed by customization.
  11281. The return value is nil, or a cons cell with the delimiter and
  11282. and the position of this delimiter.
  11283. This function does a reasonably good job, but can locally be fooled by
  11284. for example currency specifications. For example it will assume being in
  11285. inline math after \"$22.34\". The LaTeX fragment formatter will only format
  11286. fragments that are properly closed, but during editing, we have to live
  11287. with the uncertainty caused by missing closing delimiters. This function
  11288. looks only before point, not after."
  11289. (catch 'exit
  11290. (let ((pos (point))
  11291. (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
  11292. (lim (progn
  11293. (re-search-backward (concat "^\\(" paragraph-start "\\)") nil t)
  11294. (point)))
  11295. dd-on str (start 0) m re)
  11296. (goto-char pos)
  11297. (when dodollar
  11298. (setq str (concat (buffer-substring lim (point)) "\000 X$.")
  11299. re (nth 1 (assoc "$" org-latex-regexps)))
  11300. (while (string-match re str start)
  11301. (cond
  11302. ((= (match-end 0) (length str))
  11303. (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
  11304. ((= (match-end 0) (- (length str) 5))
  11305. (throw 'exit nil))
  11306. (t (setq start (match-end 0))))))
  11307. (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
  11308. (goto-char pos)
  11309. (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
  11310. (and (match-beginning 2) (throw 'exit nil))
  11311. ;; count $$
  11312. (while (re-search-backward "\\$\\$" lim t)
  11313. (setq dd-on (not dd-on)))
  11314. (goto-char pos)
  11315. (if dd-on (cons "$$" m))))))
  11316. (defun org-try-cdlatex-tab ()
  11317. "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
  11318. It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
  11319. - inside a LaTeX fragment, or
  11320. - after the first word in a line, where an abbreviation expansion could
  11321. insert a LaTeX environment."
  11322. (when org-cdlatex-mode
  11323. (cond
  11324. ((save-excursion
  11325. (skip-chars-backward "a-zA-Z0-9*")
  11326. (skip-chars-backward " \t")
  11327. (bolp))
  11328. (cdlatex-tab) t)
  11329. ((org-inside-LaTeX-fragment-p)
  11330. (cdlatex-tab) t)
  11331. (t nil))))
  11332. (defun org-cdlatex-underscore-caret (&optional arg)
  11333. "Execute `cdlatex-sub-superscript' in LaTeX fragments.
  11334. Revert to the normal definition outside of these fragments."
  11335. (interactive "P")
  11336. (if (org-inside-LaTeX-fragment-p)
  11337. (call-interactively 'cdlatex-sub-superscript)
  11338. (let (org-cdlatex-mode)
  11339. (call-interactively (key-binding (vector last-input-event))))))
  11340. (defun org-cdlatex-math-modify (&optional arg)
  11341. "Execute `cdlatex-math-modify' in LaTeX fragments.
  11342. Revert to the normal definition outside of these fragments."
  11343. (interactive "P")
  11344. (if (org-inside-LaTeX-fragment-p)
  11345. (call-interactively 'cdlatex-math-modify)
  11346. (let (org-cdlatex-mode)
  11347. (call-interactively (key-binding (vector last-input-event))))))
  11348. (defvar org-latex-fragment-image-overlays nil
  11349. "List of overlays carrying the images of latex fragments.")
  11350. (make-variable-buffer-local 'org-latex-fragment-image-overlays)
  11351. (defun org-remove-latex-fragment-image-overlays ()
  11352. "Remove all overlays with LaTeX fragment images in current buffer."
  11353. (mapc 'org-delete-overlay org-latex-fragment-image-overlays)
  11354. (setq org-latex-fragment-image-overlays nil))
  11355. (defun org-preview-latex-fragment (&optional subtree)
  11356. "Preview the LaTeX fragment at point, or all locally or globally.
  11357. If the cursor is in a LaTeX fragment, create the image and overlay
  11358. it over the source code. If there is no fragment at point, display
  11359. all fragments in the current text, from one headline to the next. With
  11360. prefix SUBTREE, display all fragments in the current subtree. With a
  11361. double prefix `C-u C-u', or when the cursor is before the first headline,
  11362. display all fragments in the buffer.
  11363. The images can be removed again with \\[org-ctrl-c-ctrl-c]."
  11364. (interactive "P")
  11365. (org-remove-latex-fragment-image-overlays)
  11366. (save-excursion
  11367. (save-restriction
  11368. (let (beg end at msg)
  11369. (cond
  11370. ((or (equal subtree '(16))
  11371. (not (save-excursion
  11372. (re-search-backward (concat "^" outline-regexp) nil t))))
  11373. (setq beg (point-min) end (point-max)
  11374. msg "Creating images for buffer...%s"))
  11375. ((equal subtree '(4))
  11376. (org-back-to-heading)
  11377. (setq beg (point) end (org-end-of-subtree t)
  11378. msg "Creating images for subtree...%s"))
  11379. (t
  11380. (if (setq at (org-inside-LaTeX-fragment-p))
  11381. (goto-char (max (point-min) (- (cdr at) 2)))
  11382. (org-back-to-heading))
  11383. (setq beg (point) end (progn (outline-next-heading) (point))
  11384. msg (if at "Creating image...%s"
  11385. "Creating images for entry...%s"))))
  11386. (message msg "")
  11387. (narrow-to-region beg end)
  11388. (goto-char beg)
  11389. (org-format-latex
  11390. (concat "ltxpng/" (file-name-sans-extension
  11391. (file-name-nondirectory
  11392. buffer-file-name)))
  11393. default-directory 'overlays msg at 'forbuffer)
  11394. (message msg "done. Use `C-c C-c' to remove images.")))))
  11395. (defvar org-latex-regexps
  11396. '(("begin" "^[ \t]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^\000]+?\\\\end{\\2}\\)" 1 t)
  11397. ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
  11398. ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
  11399. ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
  11400. ("\\(" "\\\\([^\000]*?\\\\)" 0 nil)
  11401. ("\\[" "\\\\\\[[^\000]*?\\\\\\]" 0 t)
  11402. ("$$" "\\$\\$[^\000]*?\\$\\$" 0 t))
  11403. "Regular expressions for matching embedded LaTeX.")
  11404. (defun org-format-latex (prefix &optional dir overlays msg at forbuffer)
  11405. "Replace LaTeX fragments with links to an image, and produce images."
  11406. (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
  11407. (let* ((prefixnodir (file-name-nondirectory prefix))
  11408. (absprefix (expand-file-name prefix dir))
  11409. (todir (file-name-directory absprefix))
  11410. (opt org-format-latex-options)
  11411. (matchers (plist-get opt :matchers))
  11412. (re-list org-latex-regexps)
  11413. (cnt 0) txt link beg end re e checkdir
  11414. m n block linkfile movefile ov)
  11415. ;; Check if there are old images files with this prefix, and remove them
  11416. (when (file-directory-p todir)
  11417. (mapc 'delete-file
  11418. (directory-files
  11419. todir 'full
  11420. (concat (regexp-quote prefixnodir) "_[0-9]+\\.png$"))))
  11421. ;; Check the different regular expressions
  11422. (while (setq e (pop re-list))
  11423. (setq m (car e) re (nth 1 e) n (nth 2 e)
  11424. block (if (nth 3 e) "\n\n" ""))
  11425. (when (member m matchers)
  11426. (goto-char (point-min))
  11427. (while (re-search-forward re nil t)
  11428. (when (or (not at) (equal (cdr at) (match-beginning n)))
  11429. (setq txt (match-string n)
  11430. beg (match-beginning n) end (match-end n)
  11431. cnt (1+ cnt)
  11432. linkfile (format "%s_%04d.png" prefix cnt)
  11433. movefile (format "%s_%04d.png" absprefix cnt)
  11434. link (concat block "[[file:" linkfile "]]" block))
  11435. (if msg (message msg cnt))
  11436. (goto-char beg)
  11437. (unless checkdir ; make sure the directory exists
  11438. (setq checkdir t)
  11439. (or (file-directory-p todir) (make-directory todir)))
  11440. (org-create-formula-image
  11441. txt movefile opt forbuffer)
  11442. (if overlays
  11443. (progn
  11444. (setq ov (org-make-overlay beg end))
  11445. (if (featurep 'xemacs)
  11446. (progn
  11447. (org-overlay-put ov 'invisible t)
  11448. (org-overlay-put
  11449. ov 'end-glyph
  11450. (make-glyph (vector 'png :file movefile))))
  11451. (org-overlay-put
  11452. ov 'display
  11453. (list 'image :type 'png :file movefile :ascent 'center)))
  11454. (push ov org-latex-fragment-image-overlays)
  11455. (goto-char end))
  11456. (delete-region beg end)
  11457. (insert link))))))))
  11458. ;; This function borrows from Ganesh Swami's latex2png.el
  11459. (defun org-create-formula-image (string tofile options buffer)
  11460. (let* ((tmpdir (if (featurep 'xemacs)
  11461. (temp-directory)
  11462. temporary-file-directory))
  11463. (texfilebase (make-temp-name
  11464. (expand-file-name "orgtex" tmpdir)))
  11465. (texfile (concat texfilebase ".tex"))
  11466. (dvifile (concat texfilebase ".dvi"))
  11467. (pngfile (concat texfilebase ".png"))
  11468. (fnh (if (featurep 'xemacs)
  11469. (font-height (get-face-font 'default))
  11470. (face-attribute 'default :height nil)))
  11471. (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
  11472. (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
  11473. (fg (or (plist-get options (if buffer :foreground :html-foreground))
  11474. "Black"))
  11475. (bg (or (plist-get options (if buffer :background :html-background))
  11476. "Transparent")))
  11477. (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
  11478. (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
  11479. (with-temp-file texfile
  11480. (insert org-format-latex-header
  11481. "\n\\begin{document}\n" string "\n\\end{document}\n"))
  11482. (let ((dir default-directory))
  11483. (condition-case nil
  11484. (progn
  11485. (cd tmpdir)
  11486. (call-process "latex" nil nil nil texfile))
  11487. (error nil))
  11488. (cd dir))
  11489. (if (not (file-exists-p dvifile))
  11490. (progn (message "Failed to create dvi file from %s" texfile) nil)
  11491. (condition-case nil
  11492. (call-process "dvipng" nil nil nil
  11493. "-E" "-fg" fg "-bg" bg
  11494. "-D" dpi
  11495. ;;"-x" scale "-y" scale
  11496. "-T" "tight"
  11497. "-o" pngfile
  11498. dvifile)
  11499. (error nil))
  11500. (if (not (file-exists-p pngfile))
  11501. (progn (message "Failed to create png file from %s" texfile) nil)
  11502. ;; Use the requested file name and clean up
  11503. (copy-file pngfile tofile 'replace)
  11504. (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png") do
  11505. (delete-file (concat texfilebase e)))
  11506. pngfile))))
  11507. (defun org-dvipng-color (attr)
  11508. "Return an rgb color specification for dvipng."
  11509. (apply 'format "rgb %s %s %s"
  11510. (mapcar 'org-normalize-color
  11511. (color-values (face-attribute 'default attr nil)))))
  11512. (defun org-normalize-color (value)
  11513. "Return string to be used as color value for an RGB component."
  11514. (format "%g" (/ value 65535.0)))
  11515. ;;;; Key bindings
  11516. ;; Make `C-c C-x' a prefix key
  11517. (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
  11518. ;; TAB key with modifiers
  11519. (org-defkey org-mode-map "\C-i" 'org-cycle)
  11520. (org-defkey org-mode-map [(tab)] 'org-cycle)
  11521. (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
  11522. (org-defkey org-mode-map [(meta tab)] 'org-complete)
  11523. (org-defkey org-mode-map "\M-\t" 'org-complete)
  11524. (org-defkey org-mode-map "\M-\C-i" 'org-complete)
  11525. ;; The following line is necessary under Suse GNU/Linux
  11526. (unless (featurep 'xemacs)
  11527. (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
  11528. (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
  11529. (define-key org-mode-map [backtab] 'org-shifttab)
  11530. (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
  11531. (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
  11532. (org-defkey org-mode-map [(meta return)] 'org-meta-return)
  11533. ;; Cursor keys with modifiers
  11534. (org-defkey org-mode-map [(meta left)] 'org-metaleft)
  11535. (org-defkey org-mode-map [(meta right)] 'org-metaright)
  11536. (org-defkey org-mode-map [(meta up)] 'org-metaup)
  11537. (org-defkey org-mode-map [(meta down)] 'org-metadown)
  11538. (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
  11539. (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
  11540. (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
  11541. (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
  11542. (org-defkey org-mode-map [(shift up)] 'org-shiftup)
  11543. (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
  11544. (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
  11545. (org-defkey org-mode-map [(shift right)] 'org-shiftright)
  11546. (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
  11547. (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
  11548. ;;; Extra keys for tty access.
  11549. ;; We only set them when really needed because otherwise the
  11550. ;; menus don't show the simple keys
  11551. (when (or org-use-extra-keys
  11552. (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
  11553. (not window-system))
  11554. (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
  11555. (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
  11556. (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
  11557. (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
  11558. (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
  11559. (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
  11560. (org-defkey org-mode-map [?\e (right)] 'org-metaright)
  11561. (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
  11562. (org-defkey org-mode-map [?\e (up)] 'org-metaup)
  11563. (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
  11564. (org-defkey org-mode-map [?\e (down)] 'org-metadown)
  11565. (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
  11566. (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
  11567. (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
  11568. (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
  11569. (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
  11570. (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
  11571. (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
  11572. (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
  11573. (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
  11574. (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
  11575. (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft))
  11576. ;; All the other keys
  11577. (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
  11578. (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
  11579. (if (boundp 'narrow-map)
  11580. (org-defkey narrow-map "s" 'org-narrow-to-subtree)
  11581. (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
  11582. (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
  11583. (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
  11584. (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-toggle-archive-tag)
  11585. (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
  11586. (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
  11587. (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
  11588. (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
  11589. (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
  11590. (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
  11591. (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
  11592. (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
  11593. (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
  11594. (org-defkey org-mode-map "\C-c\C-v" 'org-show-todo-tree)
  11595. (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
  11596. (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
  11597. (org-defkey org-mode-map "\C-c\\" 'org-tags-sparse-tree) ; Minor-mode res.
  11598. (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
  11599. (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
  11600. (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
  11601. (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
  11602. (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
  11603. (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
  11604. (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
  11605. (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
  11606. (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
  11607. (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
  11608. (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
  11609. (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
  11610. (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
  11611. (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
  11612. (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
  11613. (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
  11614. (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
  11615. (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
  11616. (org-defkey org-mode-map [(control ?\')] 'org-cycle-agenda-files)
  11617. (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
  11618. (org-defkey org-mode-map "\C-c]" 'org-remove-file)
  11619. (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
  11620. (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
  11621. (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
  11622. (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
  11623. (org-defkey org-mode-map "\C-c^" 'org-sort)
  11624. (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
  11625. (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
  11626. (org-defkey org-mode-map "\C-c#" 'org-update-checkbox-count)
  11627. (org-defkey org-mode-map "\C-m" 'org-return)
  11628. (org-defkey org-mode-map "\C-j" 'org-return-indent)
  11629. (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
  11630. (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
  11631. (org-defkey org-mode-map "\C-c+" 'org-table-sum)
  11632. (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
  11633. (org-defkey org-mode-map "\C-c'" 'org-edit-special)
  11634. (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
  11635. (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
  11636. (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
  11637. (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
  11638. (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
  11639. (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
  11640. (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
  11641. (org-defkey org-mode-map "\C-c\C-e" 'org-export)
  11642. (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
  11643. (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
  11644. (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
  11645. (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
  11646. (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
  11647. (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
  11648. (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
  11649. (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
  11650. (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
  11651. (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
  11652. (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
  11653. (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
  11654. (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
  11655. (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
  11656. (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
  11657. (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
  11658. (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
  11659. (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
  11660. (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
  11661. (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
  11662. (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
  11663. (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
  11664. (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
  11665. (when (featurep 'xemacs)
  11666. (org-defkey org-mode-map 'button3 'popup-mode-menu))
  11667. (defvar org-table-auto-blank-field) ; defined in org-table.el
  11668. (defun org-self-insert-command (N)
  11669. "Like `self-insert-command', use overwrite-mode for whitespace in tables.
  11670. If the cursor is in a table looking at whitespace, the whitespace is
  11671. overwritten, and the table is not marked as requiring realignment."
  11672. (interactive "p")
  11673. (if (and (org-table-p)
  11674. (progn
  11675. ;; check if we blank the field, and if that triggers align
  11676. (and (featurep 'org-table) org-table-auto-blank-field
  11677. (member last-command
  11678. '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c))
  11679. (if (or (equal (char-after) ?\ ) (looking-at "[^|\n]* |"))
  11680. ;; got extra space, this field does not determine column width
  11681. (let (org-table-may-need-update) (org-table-blank-field))
  11682. ;; no extra space, this field may determine column width
  11683. (org-table-blank-field)))
  11684. t)
  11685. (eq N 1)
  11686. (looking-at "[^|\n]* |"))
  11687. (let (org-table-may-need-update)
  11688. (goto-char (1- (match-end 0)))
  11689. (delete-backward-char 1)
  11690. (goto-char (match-beginning 0))
  11691. (self-insert-command N))
  11692. (setq org-table-may-need-update t)
  11693. (self-insert-command N)
  11694. (org-fix-tags-on-the-fly)))
  11695. (defun org-fix-tags-on-the-fly ()
  11696. (when (and (equal (char-after (point-at-bol)) ?*)
  11697. (org-on-heading-p))
  11698. (org-align-tags-here org-tags-column)))
  11699. (defun org-delete-backward-char (N)
  11700. "Like `delete-backward-char', insert whitespace at field end in tables.
  11701. When deleting backwards, in tables this function will insert whitespace in
  11702. front of the next \"|\" separator, to keep the table aligned. The table will
  11703. still be marked for re-alignment if the field did fill the entire column,
  11704. because, in this case the deletion might narrow the column."
  11705. (interactive "p")
  11706. (if (and (org-table-p)
  11707. (eq N 1)
  11708. (string-match "|" (buffer-substring (point-at-bol) (point)))
  11709. (looking-at ".*?|"))
  11710. (let ((pos (point))
  11711. (noalign (looking-at "[^|\n\r]* |"))
  11712. (c org-table-may-need-update))
  11713. (backward-delete-char N)
  11714. (skip-chars-forward "^|")
  11715. (insert " ")
  11716. (goto-char (1- pos))
  11717. ;; noalign: if there were two spaces at the end, this field
  11718. ;; does not determine the width of the column.
  11719. (if noalign (setq org-table-may-need-update c)))
  11720. (backward-delete-char N)
  11721. (org-fix-tags-on-the-fly)))
  11722. (defun org-delete-char (N)
  11723. "Like `delete-char', but insert whitespace at field end in tables.
  11724. When deleting characters, in tables this function will insert whitespace in
  11725. front of the next \"|\" separator, to keep the table aligned. The table will
  11726. still be marked for re-alignment if the field did fill the entire column,
  11727. because, in this case the deletion might narrow the column."
  11728. (interactive "p")
  11729. (if (and (org-table-p)
  11730. (not (bolp))
  11731. (not (= (char-after) ?|))
  11732. (eq N 1))
  11733. (if (looking-at ".*?|")
  11734. (let ((pos (point))
  11735. (noalign (looking-at "[^|\n\r]* |"))
  11736. (c org-table-may-need-update))
  11737. (replace-match (concat
  11738. (substring (match-string 0) 1 -1)
  11739. " |"))
  11740. (goto-char pos)
  11741. ;; noalign: if there were two spaces at the end, this field
  11742. ;; does not determine the width of the column.
  11743. (if noalign (setq org-table-may-need-update c)))
  11744. (delete-char N))
  11745. (delete-char N)
  11746. (org-fix-tags-on-the-fly)))
  11747. ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
  11748. (put 'org-self-insert-command 'delete-selection t)
  11749. (put 'orgtbl-self-insert-command 'delete-selection t)
  11750. (put 'org-delete-char 'delete-selection 'supersede)
  11751. (put 'org-delete-backward-char 'delete-selection 'supersede)
  11752. ;; Make `flyspell-mode' delay after some commands
  11753. (put 'org-self-insert-command 'flyspell-delayed t)
  11754. (put 'orgtbl-self-insert-command 'flyspell-delayed t)
  11755. (put 'org-delete-char 'flyspell-delayed t)
  11756. (put 'org-delete-backward-char 'flyspell-delayed t)
  11757. ;; Make pabbrev-mode expand after org-mode commands
  11758. (put 'org-self-insert-command 'pabbrev-expand-after-command t)
  11759. (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
  11760. ;; How to do this: Measure non-white length of current string
  11761. ;; If equal to column width, we should realign.
  11762. (defun org-remap (map &rest commands)
  11763. "In MAP, remap the functions given in COMMANDS.
  11764. COMMANDS is a list of alternating OLDDEF NEWDEF command names."
  11765. (let (new old)
  11766. (while commands
  11767. (setq old (pop commands) new (pop commands))
  11768. (if (fboundp 'command-remapping)
  11769. (org-defkey map (vector 'remap old) new)
  11770. (substitute-key-definition old new map global-map)))))
  11771. (when (eq org-enable-table-editor 'optimized)
  11772. ;; If the user wants maximum table support, we need to hijack
  11773. ;; some standard editing functions
  11774. (org-remap org-mode-map
  11775. 'self-insert-command 'org-self-insert-command
  11776. 'delete-char 'org-delete-char
  11777. 'delete-backward-char 'org-delete-backward-char)
  11778. (org-defkey org-mode-map "|" 'org-force-self-insert))
  11779. (defun org-shiftcursor-error ()
  11780. "Throw an error because Shift-Cursor command was applied in wrong context."
  11781. (error "This command is active in special context like tables, headlines or timestamps"))
  11782. (defun org-shifttab (&optional arg)
  11783. "Global visibility cycling or move to previous table field.
  11784. Calls `org-cycle' with argument t, or `org-table-previous-field', depending
  11785. on context.
  11786. See the individual commands for more information."
  11787. (interactive "P")
  11788. (cond
  11789. ((org-at-table-p) (call-interactively 'org-table-previous-field))
  11790. ((integerp arg)
  11791. (message "Content view to level: %d" arg)
  11792. (org-content (prefix-numeric-value arg))
  11793. (setq org-cycle-global-status 'overview))
  11794. (t (call-interactively 'org-global-cycle))))
  11795. (defun org-shiftmetaleft ()
  11796. "Promote subtree or delete table column.
  11797. Calls `org-promote-subtree', `org-outdent-item',
  11798. or `org-table-delete-column', depending on context.
  11799. See the individual commands for more information."
  11800. (interactive)
  11801. (cond
  11802. ((org-at-table-p) (call-interactively 'org-table-delete-column))
  11803. ((org-on-heading-p) (call-interactively 'org-promote-subtree))
  11804. ((org-at-item-p) (call-interactively 'org-outdent-item))
  11805. (t (org-shiftcursor-error))))
  11806. (defun org-shiftmetaright ()
  11807. "Demote subtree or insert table column.
  11808. Calls `org-demote-subtree', `org-indent-item',
  11809. or `org-table-insert-column', depending on context.
  11810. See the individual commands for more information."
  11811. (interactive)
  11812. (cond
  11813. ((org-at-table-p) (call-interactively 'org-table-insert-column))
  11814. ((org-on-heading-p) (call-interactively 'org-demote-subtree))
  11815. ((org-at-item-p) (call-interactively 'org-indent-item))
  11816. (t (org-shiftcursor-error))))
  11817. (defun org-shiftmetaup (&optional arg)
  11818. "Move subtree up or kill table row.
  11819. Calls `org-move-subtree-up' or `org-table-kill-row' or
  11820. `org-move-item-up' depending on context. See the individual commands
  11821. for more information."
  11822. (interactive "P")
  11823. (cond
  11824. ((org-at-table-p) (call-interactively 'org-table-kill-row))
  11825. ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
  11826. ((org-at-item-p) (call-interactively 'org-move-item-up))
  11827. (t (org-shiftcursor-error))))
  11828. (defun org-shiftmetadown (&optional arg)
  11829. "Move subtree down or insert table row.
  11830. Calls `org-move-subtree-down' or `org-table-insert-row' or
  11831. `org-move-item-down', depending on context. See the individual
  11832. commands for more information."
  11833. (interactive "P")
  11834. (cond
  11835. ((org-at-table-p) (call-interactively 'org-table-insert-row))
  11836. ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
  11837. ((org-at-item-p) (call-interactively 'org-move-item-down))
  11838. (t (org-shiftcursor-error))))
  11839. (defun org-metaleft (&optional arg)
  11840. "Promote heading or move table column to left.
  11841. Calls `org-do-promote' or `org-table-move-column', depending on context.
  11842. With no specific context, calls the Emacs default `backward-word'.
  11843. See the individual commands for more information."
  11844. (interactive "P")
  11845. (cond
  11846. ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
  11847. ((or (org-on-heading-p) (org-region-active-p))
  11848. (call-interactively 'org-do-promote))
  11849. ((org-at-item-p) (call-interactively 'org-outdent-item))
  11850. (t (call-interactively 'backward-word))))
  11851. (defun org-metaright (&optional arg)
  11852. "Demote subtree or move table column to right.
  11853. Calls `org-do-demote' or `org-table-move-column', depending on context.
  11854. With no specific context, calls the Emacs default `forward-word'.
  11855. See the individual commands for more information."
  11856. (interactive "P")
  11857. (cond
  11858. ((org-at-table-p) (call-interactively 'org-table-move-column))
  11859. ((or (org-on-heading-p) (org-region-active-p))
  11860. (call-interactively 'org-do-demote))
  11861. ((org-at-item-p) (call-interactively 'org-indent-item))
  11862. (t (call-interactively 'forward-word))))
  11863. (defun org-metaup (&optional arg)
  11864. "Move subtree up or move table row up.
  11865. Calls `org-move-subtree-up' or `org-table-move-row' or
  11866. `org-move-item-up', depending on context. See the individual commands
  11867. for more information."
  11868. (interactive "P")
  11869. (cond
  11870. ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
  11871. ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
  11872. ((org-at-item-p) (call-interactively 'org-move-item-up))
  11873. (t (transpose-lines 1) (beginning-of-line -1))))
  11874. (defun org-metadown (&optional arg)
  11875. "Move subtree down or move table row down.
  11876. Calls `org-move-subtree-down' or `org-table-move-row' or
  11877. `org-move-item-down', depending on context. See the individual
  11878. commands for more information."
  11879. (interactive "P")
  11880. (cond
  11881. ((org-at-table-p) (call-interactively 'org-table-move-row))
  11882. ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
  11883. ((org-at-item-p) (call-interactively 'org-move-item-down))
  11884. (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
  11885. (defun org-shiftup (&optional arg)
  11886. "Increase item in timestamp or increase priority of current headline.
  11887. Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
  11888. depending on context. See the individual commands for more information."
  11889. (interactive "P")
  11890. (cond
  11891. ((org-at-timestamp-p t)
  11892. (call-interactively (if org-edit-timestamp-down-means-later
  11893. 'org-timestamp-down 'org-timestamp-up)))
  11894. ((org-on-heading-p) (call-interactively 'org-priority-up))
  11895. ((org-at-item-p) (call-interactively 'org-previous-item))
  11896. ((org-clocktable-try-shift 'up arg))
  11897. (t (call-interactively 'org-beginning-of-item) (beginning-of-line 1))))
  11898. (defun org-shiftdown (&optional arg)
  11899. "Decrease item in timestamp or decrease priority of current headline.
  11900. Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
  11901. depending on context. See the individual commands for more information."
  11902. (interactive "P")
  11903. (cond
  11904. ((org-at-timestamp-p t)
  11905. (call-interactively (if org-edit-timestamp-down-means-later
  11906. 'org-timestamp-up 'org-timestamp-down)))
  11907. ((org-on-heading-p) (call-interactively 'org-priority-down))
  11908. ((org-clocktable-try-shift 'down arg))
  11909. (t (call-interactively 'org-next-item))))
  11910. (defun org-shiftright (&optional arg)
  11911. "Cycle the thing at point or in the current line, depending on context.
  11912. Depending on context, this does one of the following:
  11913. - switch a timestamp at point one day into the future
  11914. - on a headline, switch to the next TODO keyword.
  11915. - on an item, switch entire list to the next bullet type
  11916. - on a property line, switch to the next allowed value
  11917. - on a clocktable definition line, move time block into the future"
  11918. (interactive "P")
  11919. (cond
  11920. ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
  11921. ((org-on-heading-p) (org-call-with-arg 'org-todo 'right))
  11922. ((org-at-item-p) (org-call-with-arg 'org-cycle-list-bullet nil))
  11923. ((org-at-property-p) (call-interactively 'org-property-next-allowed-value))
  11924. ((org-clocktable-try-shift 'right arg))
  11925. (t (org-shiftcursor-error))))
  11926. (defun org-shiftleft (&optional arg)
  11927. "Cycle the thing at point or in the current line, depending on context.
  11928. Depending on context, this does one of the following:
  11929. - switch a timestamp at point one day into the past
  11930. - on a headline, switch to the previous TODO keyword.
  11931. - on an item, switch entire list to the previous bullet type
  11932. - on a property line, switch to the previous allowed value
  11933. - on a clocktable definition line, move time block into the past"
  11934. (interactive "P")
  11935. (cond
  11936. ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
  11937. ((org-on-heading-p) (org-call-with-arg 'org-todo 'left))
  11938. ((org-at-item-p) (org-call-with-arg 'org-cycle-list-bullet 'previous))
  11939. ((org-at-property-p)
  11940. (call-interactively 'org-property-previous-allowed-value))
  11941. ((org-clocktable-try-shift 'left arg))
  11942. (t (org-shiftcursor-error))))
  11943. (defun org-shiftcontrolright ()
  11944. "Switch to next TODO set."
  11945. (interactive)
  11946. (cond
  11947. ((org-on-heading-p) (org-call-with-arg 'org-todo 'nextset))
  11948. (t (org-shiftcursor-error))))
  11949. (defun org-shiftcontrolleft ()
  11950. "Switch to previous TODO set."
  11951. (interactive)
  11952. (cond
  11953. ((org-on-heading-p) (org-call-with-arg 'org-todo 'previousset))
  11954. (t (org-shiftcursor-error))))
  11955. (defun org-ctrl-c-ret ()
  11956. "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
  11957. (interactive)
  11958. (cond
  11959. ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
  11960. (t (call-interactively 'org-insert-heading))))
  11961. (defun org-copy-special ()
  11962. "Copy region in table or copy current subtree.
  11963. Calls `org-table-copy' or `org-copy-subtree', depending on context.
  11964. See the individual commands for more information."
  11965. (interactive)
  11966. (call-interactively
  11967. (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
  11968. (defun org-cut-special ()
  11969. "Cut region in table or cut current subtree.
  11970. Calls `org-table-copy' or `org-cut-subtree', depending on context.
  11971. See the individual commands for more information."
  11972. (interactive)
  11973. (call-interactively
  11974. (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
  11975. (defun org-paste-special (arg)
  11976. "Paste rectangular region into table, or past subtree relative to level.
  11977. Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
  11978. See the individual commands for more information."
  11979. (interactive "P")
  11980. (if (org-at-table-p)
  11981. (org-table-paste-rectangle)
  11982. (org-paste-subtree arg)))
  11983. (defun org-edit-special ()
  11984. "Call a special editor for the stuff at point.
  11985. When at a table, call the formula editor with `org-table-edit-formulas'.
  11986. When at the first line of an src example, call `org-edit-src-code'.
  11987. When in an #+include line, visit the include file. Otherwise call
  11988. `ffap' to visit the file at point."
  11989. (interactive)
  11990. (cond
  11991. ((org-at-table-p)
  11992. (call-interactively 'org-table-edit-formulas))
  11993. ((save-excursion
  11994. (beginning-of-line 1)
  11995. (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
  11996. (find-file (org-trim (match-string 1))))
  11997. ((org-edit-src-code))
  11998. ((org-edit-fixed-width-region))
  11999. (t (call-interactively 'ffap))))
  12000. (defun org-ctrl-c-ctrl-c (&optional arg)
  12001. "Set tags in headline, or update according to changed information at point.
  12002. This command does many different things, depending on context:
  12003. - If the cursor is in a headline, prompt for tags and insert them
  12004. into the current line, aligned to `org-tags-column'. When called
  12005. with prefix arg, realign all tags in the current buffer.
  12006. - If the cursor is in one of the special #+KEYWORD lines, this
  12007. triggers scanning the buffer for these lines and updating the
  12008. information.
  12009. - If the cursor is inside a table, realign the table. This command
  12010. works even if the automatic table editor has been turned off.
  12011. - If the cursor is on a #+TBLFM line, re-apply the formulas to
  12012. the entire table.
  12013. - If the cursor is at a footnote reference or definition, jump to
  12014. the corresponding definition or references, respectively.
  12015. - If the cursor is a the beginning of a dynamic block, update it.
  12016. - If the cursor is inside a table created by the table.el package,
  12017. activate that table.
  12018. - If the current buffer is a remember buffer, close note and file
  12019. it. A prefix argument of 1 files to the default location
  12020. without further interaction. A prefix argument of 2 files to
  12021. the currently clocking task.
  12022. - If the cursor is on a <<<target>>>, update radio targets and corresponding
  12023. links in this buffer.
  12024. - If the cursor is on a numbered item in a plain list, renumber the
  12025. ordered list.
  12026. - If the cursor is on a checkbox, toggle it."
  12027. (interactive "P")
  12028. (let ((org-enable-table-editor t))
  12029. (cond
  12030. ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
  12031. org-occur-highlights
  12032. org-latex-fragment-image-overlays)
  12033. (and (boundp 'org-clock-overlays) (org-remove-clock-overlays))
  12034. (org-remove-occur-highlights)
  12035. (org-remove-latex-fragment-image-overlays)
  12036. (message "Temporary highlights/overlays removed from current buffer"))
  12037. ((and (local-variable-p 'org-finish-function (current-buffer))
  12038. (fboundp org-finish-function))
  12039. (funcall org-finish-function))
  12040. ((org-at-property-p)
  12041. (call-interactively 'org-property-action))
  12042. ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
  12043. ((org-on-heading-p) (call-interactively 'org-set-tags))
  12044. ((org-at-table.el-p)
  12045. (require 'table)
  12046. (beginning-of-line 1)
  12047. (re-search-forward "|" (save-excursion (end-of-line 2) (point)))
  12048. (call-interactively 'table-recognize-table))
  12049. ((org-at-table-p)
  12050. (org-table-maybe-eval-formula)
  12051. (if arg
  12052. (call-interactively 'org-table-recalculate)
  12053. (org-table-maybe-recalculate-line))
  12054. (call-interactively 'org-table-align))
  12055. ((or (org-footnote-at-reference-p)
  12056. (org-footnote-at-definition-p))
  12057. (call-interactively 'org-footnote-action))
  12058. ((org-at-item-checkbox-p)
  12059. (call-interactively 'org-toggle-checkbox))
  12060. ((org-at-item-p)
  12061. (call-interactively 'org-maybe-renumber-ordered-list))
  12062. ((save-excursion (beginning-of-line 1) (looking-at "#\\+BEGIN:"))
  12063. ;; Dynamic block
  12064. (beginning-of-line 1)
  12065. (save-excursion (org-update-dblock)))
  12066. ((save-excursion (beginning-of-line 1) (looking-at "#\\+\\([A-Z]+\\)"))
  12067. (cond
  12068. ((equal (match-string 1) "TBLFM")
  12069. ;; Recalculate the table before this line
  12070. (save-excursion
  12071. (beginning-of-line 1)
  12072. (skip-chars-backward " \r\n\t")
  12073. (if (org-at-table-p)
  12074. (org-call-with-arg 'org-table-recalculate t))))
  12075. (t
  12076. ; (org-set-regexps-and-options)
  12077. ; (org-restart-font-lock)
  12078. (let ((org-inhibit-startup t)) (org-mode-restart))
  12079. (message "Local setup has been refreshed"))))
  12080. (t (error "C-c C-c can do nothing useful at this location.")))))
  12081. (defun org-mode-restart ()
  12082. "Restart Org-mode, to scan again for special lines.
  12083. Also updates the keyword regular expressions."
  12084. (interactive)
  12085. (org-mode)
  12086. (message "Org-mode restarted"))
  12087. (defun org-kill-note-or-show-branches ()
  12088. "If this is a Note buffer, abort storing the note. Else call `show-branches'."
  12089. (interactive)
  12090. (if (not org-finish-function)
  12091. (call-interactively 'show-branches)
  12092. (let ((org-note-abort t))
  12093. (funcall org-finish-function))))
  12094. (defun org-return (&optional indent)
  12095. "Goto next table row or insert a newline.
  12096. Calls `org-table-next-row' or `newline', depending on context.
  12097. See the individual commands for more information."
  12098. (interactive)
  12099. (cond
  12100. ((bobp) (if indent (newline-and-indent) (newline)))
  12101. ((and (org-at-heading-p)
  12102. (looking-at
  12103. (org-re "\\([ \t]+\\(:[[:alnum:]_@:]+:\\)\\)[ \t]*$")))
  12104. (org-show-entry)
  12105. (end-of-line 1)
  12106. (newline))
  12107. ((org-at-table-p)
  12108. (org-table-justify-field-maybe)
  12109. (call-interactively 'org-table-next-row))
  12110. (t (if indent (newline-and-indent) (newline)))))
  12111. (defun org-return-indent ()
  12112. "Goto next table row or insert a newline and indent.
  12113. Calls `org-table-next-row' or `newline-and-indent', depending on
  12114. context. See the individual commands for more information."
  12115. (interactive)
  12116. (org-return t))
  12117. (defun org-ctrl-c-star ()
  12118. "Compute table, or change heading status of lines.
  12119. Calls `org-table-recalculate' or `org-toggle-region-headings',
  12120. depending on context. This will also turn a plain list item or a normal
  12121. line into a subheading."
  12122. (interactive)
  12123. (cond
  12124. ((org-at-table-p)
  12125. (call-interactively 'org-table-recalculate))
  12126. ((org-region-active-p)
  12127. ;; Convert all lines in region to list items
  12128. (call-interactively 'org-toggle-region-headings))
  12129. ((org-on-heading-p)
  12130. (org-toggle-region-headings (point-at-bol)
  12131. (min (1+ (point-at-eol)) (point-max))))
  12132. ((org-at-item-p)
  12133. ;; Convert to heading
  12134. (let ((level (save-match-data
  12135. (save-excursion
  12136. (condition-case nil
  12137. (progn
  12138. (org-back-to-heading t)
  12139. (funcall outline-level))
  12140. (error 0))))))
  12141. (replace-match
  12142. (concat (make-string (org-get-valid-level level 1) ?*) " ") t t)))
  12143. (t (org-toggle-region-headings (point-at-bol)
  12144. (min (1+ (point-at-eol)) (point-max))))))
  12145. (defun org-ctrl-c-minus ()
  12146. "Insert separator line in table or modify bullet status of line.
  12147. Also turns a plain line or a region of lines into list items.
  12148. Calls `org-table-insert-hline', `org-toggle-region-items', or
  12149. `org-cycle-list-bullet', depending on context."
  12150. (interactive)
  12151. (cond
  12152. ((org-at-table-p)
  12153. (call-interactively 'org-table-insert-hline))
  12154. ((org-on-heading-p)
  12155. ;; Convert to item
  12156. (save-excursion
  12157. (beginning-of-line 1)
  12158. (if (looking-at "\\*+ ")
  12159. (replace-match
  12160. (concat (make-string
  12161. (- (match-end 0) (point) (if org-odd-levels-only 2 1)) ?\ )
  12162. "- ")))))
  12163. ((org-region-active-p)
  12164. ;; Convert all lines in region to list items
  12165. (call-interactively 'org-toggle-region-items))
  12166. ((org-in-item-p)
  12167. (call-interactively 'org-cycle-list-bullet))
  12168. (t (org-toggle-region-items (point-at-bol)
  12169. (min (1+ (point-at-eol)) (point-max))))))
  12170. (defun org-toggle-region-items (beg end)
  12171. "Convert all lines in region to list items.
  12172. If the first line is already an item, convert all list items in the region
  12173. to normal lines."
  12174. (interactive "r")
  12175. (let (l2 l)
  12176. (save-excursion
  12177. (goto-char end)
  12178. (setq l2 (org-current-line))
  12179. (goto-char beg)
  12180. (beginning-of-line 1)
  12181. (setq l (1- (org-current-line)))
  12182. (if (org-at-item-p)
  12183. ;; We already have items, de-itemize
  12184. (while (< (setq l (1+ l)) l2)
  12185. (when (org-at-item-p)
  12186. (goto-char (match-beginning 2))
  12187. (delete-region (match-beginning 2) (match-end 2))
  12188. (and (looking-at "[ \t]+") (replace-match "")))
  12189. (beginning-of-line 2))
  12190. (while (< (setq l (1+ l)) l2)
  12191. (unless (org-at-item-p)
  12192. (if (looking-at "\\([ \t]*\\)\\(\\S-\\)")
  12193. (replace-match "\\1- \\2")))
  12194. (beginning-of-line 2))))))
  12195. (defun org-toggle-region-headings (beg end)
  12196. "Convert all lines in region to list items.
  12197. If the first line is already an item, convert all list items in the region
  12198. to normal lines."
  12199. (interactive "r")
  12200. (let (l2 l)
  12201. (save-excursion
  12202. (goto-char end)
  12203. (setq l2 (org-current-line))
  12204. (goto-char beg)
  12205. (beginning-of-line 1)
  12206. (setq l (1- (org-current-line)))
  12207. (if (org-on-heading-p)
  12208. ;; We already have headlines, de-star them
  12209. (while (< (setq l (1+ l)) l2)
  12210. (when (org-on-heading-p t)
  12211. (and (looking-at outline-regexp) (replace-match "")))
  12212. (beginning-of-line 2))
  12213. (let* ((stars (save-excursion
  12214. (re-search-backward org-complex-heading-regexp nil t)
  12215. (or (match-string 1) "*")))
  12216. (add-stars (if org-odd-levels-only "**" "*"))
  12217. (rpl (concat stars add-stars " \\2")))
  12218. (while (< (setq l (1+ l)) l2)
  12219. (unless (org-on-heading-p)
  12220. (if (looking-at "\\([ \t]*\\)\\(\\S-\\)")
  12221. (replace-match rpl)))
  12222. (beginning-of-line 2)))))))
  12223. (defun org-meta-return (&optional arg)
  12224. "Insert a new heading or wrap a region in a table.
  12225. Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
  12226. See the individual commands for more information."
  12227. (interactive "P")
  12228. (cond
  12229. ((org-at-table-p)
  12230. (call-interactively 'org-table-wrap-region))
  12231. (t (call-interactively 'org-insert-heading))))
  12232. ;;; Menu entries
  12233. ;; Define the Org-mode menus
  12234. (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
  12235. '("Tbl"
  12236. ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
  12237. ["Next Field" org-cycle (org-at-table-p)]
  12238. ["Previous Field" org-shifttab (org-at-table-p)]
  12239. ["Next Row" org-return (org-at-table-p)]
  12240. "--"
  12241. ["Blank Field" org-table-blank-field (org-at-table-p)]
  12242. ["Edit Field" org-table-edit-field (org-at-table-p)]
  12243. ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
  12244. "--"
  12245. ("Column"
  12246. ["Move Column Left" org-metaleft (org-at-table-p)]
  12247. ["Move Column Right" org-metaright (org-at-table-p)]
  12248. ["Delete Column" org-shiftmetaleft (org-at-table-p)]
  12249. ["Insert Column" org-shiftmetaright (org-at-table-p)])
  12250. ("Row"
  12251. ["Move Row Up" org-metaup (org-at-table-p)]
  12252. ["Move Row Down" org-metadown (org-at-table-p)]
  12253. ["Delete Row" org-shiftmetaup (org-at-table-p)]
  12254. ["Insert Row" org-shiftmetadown (org-at-table-p)]
  12255. ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
  12256. "--"
  12257. ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
  12258. ("Rectangle"
  12259. ["Copy Rectangle" org-copy-special (org-at-table-p)]
  12260. ["Cut Rectangle" org-cut-special (org-at-table-p)]
  12261. ["Paste Rectangle" org-paste-special (org-at-table-p)]
  12262. ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
  12263. "--"
  12264. ("Calculate"
  12265. ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
  12266. ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
  12267. ["Edit Formulas" org-edit-special (org-at-table-p)]
  12268. "--"
  12269. ["Recalculate line" org-table-recalculate (org-at-table-p)]
  12270. ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
  12271. ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
  12272. "--"
  12273. ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
  12274. "--"
  12275. ["Sum Column/Rectangle" org-table-sum
  12276. (or (org-at-table-p) (org-region-active-p))]
  12277. ["Which Column?" org-table-current-column (org-at-table-p)])
  12278. ["Debug Formulas"
  12279. org-table-toggle-formula-debugger
  12280. :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
  12281. ["Show Col/Row Numbers"
  12282. org-table-toggle-coordinate-overlays
  12283. :style toggle
  12284. :selected (org-bound-and-true-p org-table-overlay-coordinates)]
  12285. "--"
  12286. ["Create" org-table-create (and (not (org-at-table-p))
  12287. org-enable-table-editor)]
  12288. ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
  12289. ["Import from File" org-table-import (not (org-at-table-p))]
  12290. ["Export to File" org-table-export (org-at-table-p)]
  12291. "--"
  12292. ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
  12293. (easy-menu-define org-org-menu org-mode-map "Org menu"
  12294. '("Org"
  12295. ("Show/Hide"
  12296. ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
  12297. ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
  12298. ["Sparse Tree..." org-sparse-tree t]
  12299. ["Reveal Context" org-reveal t]
  12300. ["Show All" show-all t]
  12301. "--"
  12302. ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
  12303. "--"
  12304. ["New Heading" org-insert-heading t]
  12305. ("Navigate Headings"
  12306. ["Up" outline-up-heading t]
  12307. ["Next" outline-next-visible-heading t]
  12308. ["Previous" outline-previous-visible-heading t]
  12309. ["Next Same Level" outline-forward-same-level t]
  12310. ["Previous Same Level" outline-backward-same-level t]
  12311. "--"
  12312. ["Jump" org-goto t])
  12313. ("Edit Structure"
  12314. ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
  12315. ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
  12316. "--"
  12317. ["Copy Subtree" org-copy-special (not (org-at-table-p))]
  12318. ["Cut Subtree" org-cut-special (not (org-at-table-p))]
  12319. ["Paste Subtree" org-paste-special (not (org-at-table-p))]
  12320. "--"
  12321. ["Promote Heading" org-metaleft (not (org-at-table-p))]
  12322. ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
  12323. ["Demote Heading" org-metaright (not (org-at-table-p))]
  12324. ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
  12325. "--"
  12326. ["Sort Region/Children" org-sort (not (org-at-table-p))]
  12327. "--"
  12328. ["Convert to odd levels" org-convert-to-odd-levels t]
  12329. ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
  12330. ("Editing"
  12331. ["Emphasis..." org-emphasize t]
  12332. ["Edit Source Example" org-edit-special t]
  12333. "--"
  12334. ["Footnote new/jump" org-footnote-action t]
  12335. ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
  12336. ("Archive"
  12337. ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
  12338. ; ["Check and Tag Children" (org-toggle-archive-tag (4))
  12339. ; :active t :keys "C-u C-c C-x C-a"]
  12340. ["Sparse trees open ARCHIVE trees"
  12341. (setq org-sparse-tree-open-archived-trees
  12342. (not org-sparse-tree-open-archived-trees))
  12343. :style toggle :selected org-sparse-tree-open-archived-trees]
  12344. ["Cycling opens ARCHIVE trees"
  12345. (setq org-cycle-open-archived-trees (not org-cycle-open-archived-trees))
  12346. :style toggle :selected org-cycle-open-archived-trees]
  12347. "--"
  12348. ["Move subtree to archive sibling" org-archive-to-archive-sibling t]
  12349. ["Move Subtree to Archive" org-advertized-archive-subtree t]
  12350. ; ["Check and Move Children" (org-archive-subtree '(4))
  12351. ; :active t :keys "C-u C-c C-x C-s"]
  12352. )
  12353. "--"
  12354. ("TODO Lists"
  12355. ["TODO/DONE/-" org-todo t]
  12356. ("Select keyword"
  12357. ["Next keyword" org-shiftright (org-on-heading-p)]
  12358. ["Previous keyword" org-shiftleft (org-on-heading-p)]
  12359. ["Complete Keyword" org-complete (assq :todo-keyword (org-context))]
  12360. ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
  12361. ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
  12362. ["Show TODO Tree" org-show-todo-tree t]
  12363. ["Global TODO list" org-todo-list t]
  12364. "--"
  12365. ["Set Priority" org-priority t]
  12366. ["Priority Up" org-shiftup t]
  12367. ["Priority Down" org-shiftdown t])
  12368. ("TAGS and Properties"
  12369. ["Set Tags" org-set-tags-command t]
  12370. ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
  12371. "--"
  12372. ["Set property" org-set-property t]
  12373. ["Column view of properties" org-columns t]
  12374. ["Insert Column View DBlock" org-insert-columns-dblock t])
  12375. ("Dates and Scheduling"
  12376. ["Timestamp" org-time-stamp t]
  12377. ["Timestamp (inactive)" org-time-stamp-inactive t]
  12378. ("Change Date"
  12379. ["1 Day Later" org-shiftright t]
  12380. ["1 Day Earlier" org-shiftleft t]
  12381. ["1 ... Later" org-shiftup t]
  12382. ["1 ... Earlier" org-shiftdown t])
  12383. ["Compute Time Range" org-evaluate-time-range t]
  12384. ["Schedule Item" org-schedule t]
  12385. ["Deadline" org-deadline t]
  12386. "--"
  12387. ["Custom time format" org-toggle-time-stamp-overlays
  12388. :style radio :selected org-display-custom-times]
  12389. "--"
  12390. ["Goto Calendar" org-goto-calendar t]
  12391. ["Date from Calendar" org-date-from-calendar t]
  12392. "--"
  12393. ["Start/restart timer" org-timer-start t]
  12394. ["Insert timer string" org-timer t]
  12395. ["Insert timer item" org-timer-item t])
  12396. ("Logging work"
  12397. ["Clock in" org-clock-in t]
  12398. ["Clock out" org-clock-out t]
  12399. ["Clock cancel" org-clock-cancel t]
  12400. ["Goto running clock" org-clock-goto t]
  12401. ["Display times" org-clock-display t]
  12402. ["Create clock table" org-clock-report t]
  12403. "--"
  12404. ["Record DONE time"
  12405. (progn (setq org-log-done (not org-log-done))
  12406. (message "Switching to %s will %s record a timestamp"
  12407. (car org-done-keywords)
  12408. (if org-log-done "automatically" "not")))
  12409. :style toggle :selected org-log-done])
  12410. "--"
  12411. ["Agenda Command..." org-agenda t]
  12412. ["Set Restriction Lock" org-agenda-set-restriction-lock t]
  12413. ("File List for Agenda")
  12414. ("Special views current file"
  12415. ["TODO Tree" org-show-todo-tree t]
  12416. ["Check Deadlines" org-check-deadlines t]
  12417. ["Timeline" org-timeline t]
  12418. ["Tags Tree" org-tags-sparse-tree t])
  12419. "--"
  12420. ("Hyperlinks"
  12421. ["Store Link (Global)" org-store-link t]
  12422. ["Insert Link" org-insert-link t]
  12423. ["Follow Link" org-open-at-point t]
  12424. "--"
  12425. ["Next link" org-next-link t]
  12426. ["Previous link" org-previous-link t]
  12427. "--"
  12428. ["Descriptive Links"
  12429. (progn (org-add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
  12430. :style radio
  12431. :selected (member '(org-link) buffer-invisibility-spec)]
  12432. ["Literal Links"
  12433. (progn
  12434. (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
  12435. :style radio
  12436. :selected (not (member '(org-link) buffer-invisibility-spec))])
  12437. "--"
  12438. ["Export/Publish..." org-export t]
  12439. ("LaTeX"
  12440. ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
  12441. :selected org-cdlatex-mode]
  12442. ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
  12443. ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
  12444. ["Modify math symbol" org-cdlatex-math-modify
  12445. (org-inside-LaTeX-fragment-p)]
  12446. ["Export LaTeX fragments as images"
  12447. (if (featurep 'org-exp)
  12448. (setq org-export-with-LaTeX-fragments
  12449. (not org-export-with-LaTeX-fragments))
  12450. (require 'org-exp))
  12451. :style toggle :selected (and (boundp 'org-export-with-LaTeX-fragments)
  12452. org-export-with-LaTeX-fragments)])
  12453. "--"
  12454. ("Documentation"
  12455. ["Show Version" org-version t]
  12456. ["Info Documentation" org-info t])
  12457. ("Customize"
  12458. ["Browse Org Group" org-customize t]
  12459. "--"
  12460. ["Expand This Menu" org-create-customize-menu
  12461. (fboundp 'customize-menu-create)])
  12462. "--"
  12463. ["Refresh setup" org-mode-restart t]
  12464. ))
  12465. (defun org-info (&optional node)
  12466. "Read documentation for Org-mode in the info system.
  12467. With optional NODE, go directly to that node."
  12468. (interactive)
  12469. (info (format "(org)%s" (or node ""))))
  12470. (defun org-install-agenda-files-menu ()
  12471. (let ((bl (buffer-list)))
  12472. (save-excursion
  12473. (while bl
  12474. (set-buffer (pop bl))
  12475. (if (org-mode-p) (setq bl nil)))
  12476. (when (org-mode-p)
  12477. (easy-menu-change
  12478. '("Org") "File List for Agenda"
  12479. (append
  12480. (list
  12481. ["Edit File List" (org-edit-agenda-file-list) t]
  12482. ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
  12483. ["Remove Current File from List" org-remove-file t]
  12484. ["Cycle through agenda files" org-cycle-agenda-files t]
  12485. ["Occur in all agenda files" org-occur-in-agenda-files t]
  12486. "--")
  12487. (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
  12488. ;;;; Documentation
  12489. ;;;###autoload
  12490. (defun org-require-autoloaded-modules ()
  12491. (interactive)
  12492. (mapc 'require
  12493. '(org-agenda org-archive org-clock org-colview
  12494. org-exp org-id org-export-latex org-publish
  12495. org-remember org-table)))
  12496. ;;;###autoload
  12497. (defun org-customize ()
  12498. "Call the customize function with org as argument."
  12499. (interactive)
  12500. (org-load-modules-maybe)
  12501. (org-require-autoloaded-modules)
  12502. (customize-browse 'org))
  12503. (defun org-create-customize-menu ()
  12504. "Create a full customization menu for Org-mode, insert it into the menu."
  12505. (interactive)
  12506. (org-load-modules-maybe)
  12507. (org-require-autoloaded-modules)
  12508. (if (fboundp 'customize-menu-create)
  12509. (progn
  12510. (easy-menu-change
  12511. '("Org") "Customize"
  12512. `(["Browse Org group" org-customize t]
  12513. "--"
  12514. ,(customize-menu-create 'org)
  12515. ["Set" Custom-set t]
  12516. ["Save" Custom-save t]
  12517. ["Reset to Current" Custom-reset-current t]
  12518. ["Reset to Saved" Custom-reset-saved t]
  12519. ["Reset to Standard Settings" Custom-reset-standard t]))
  12520. (message "\"Org\"-menu now contains full customization menu"))
  12521. (error "Cannot expand menu (outdated version of cus-edit.el)")))
  12522. ;;;; Miscellaneous stuff
  12523. ;;; Generally useful functions
  12524. (defun org-find-text-property-in-string (prop s)
  12525. "Return the first non-nil value of property PROP in string S."
  12526. (or (get-text-property 0 prop s)
  12527. (get-text-property (or (next-single-property-change 0 prop s) 0)
  12528. prop s)))
  12529. (defun org-display-warning (message) ;; Copied from Emacs-Muse
  12530. "Display the given MESSAGE as a warning."
  12531. (if (fboundp 'display-warning)
  12532. (display-warning 'org message
  12533. (if (featurep 'xemacs)
  12534. 'warning
  12535. :warning))
  12536. (let ((buf (get-buffer-create "*Org warnings*")))
  12537. (with-current-buffer buf
  12538. (goto-char (point-max))
  12539. (insert "Warning (Org): " message)
  12540. (unless (bolp)
  12541. (newline)))
  12542. (display-buffer buf)
  12543. (sit-for 0))))
  12544. (defun org-goto-marker-or-bmk (marker &optional bookmark)
  12545. "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
  12546. (if (and marker (marker-buffer marker)
  12547. (buffer-live-p (marker-buffer marker)))
  12548. (progn
  12549. (switch-to-buffer (marker-buffer marker))
  12550. (if (or (> marker (point-max)) (< marker (point-min)))
  12551. (widen))
  12552. (goto-char marker)
  12553. (org-show-context 'org-goto))
  12554. (if bookmark
  12555. (bookmark-jump bookmark)
  12556. (error "Cannot find location"))))
  12557. (defun org-quote-csv-field (s)
  12558. "Quote field for inclusion in CSV material."
  12559. (if (string-match "[\",]" s)
  12560. (concat "\"" (mapconcat 'identity (split-string s "\"") "\"\"") "\"")
  12561. s))
  12562. (defun org-plist-delete (plist property)
  12563. "Delete PROPERTY from PLIST.
  12564. This is in contrast to merely setting it to 0."
  12565. (let (p)
  12566. (while plist
  12567. (if (not (eq property (car plist)))
  12568. (setq p (plist-put p (car plist) (nth 1 plist))))
  12569. (setq plist (cddr plist)))
  12570. p))
  12571. (defun org-force-self-insert (N)
  12572. "Needed to enforce self-insert under remapping."
  12573. (interactive "p")
  12574. (self-insert-command N))
  12575. (defun org-string-width (s)
  12576. "Compute width of string, ignoring invisible characters.
  12577. This ignores character with invisibility property `org-link', and also
  12578. characters with property `org-cwidth', because these will become invisible
  12579. upon the next fontification round."
  12580. (let (b l)
  12581. (when (or (eq t buffer-invisibility-spec)
  12582. (assq 'org-link buffer-invisibility-spec))
  12583. (while (setq b (text-property-any 0 (length s)
  12584. 'invisible 'org-link s))
  12585. (setq s (concat (substring s 0 b)
  12586. (substring s (or (next-single-property-change
  12587. b 'invisible s) (length s)))))))
  12588. (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
  12589. (setq s (concat (substring s 0 b)
  12590. (substring s (or (next-single-property-change
  12591. b 'org-cwidth s) (length s))))))
  12592. (setq l (string-width s) b -1)
  12593. (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
  12594. (setq l (- l (get-text-property b 'org-dwidth-n s))))
  12595. l))
  12596. (defun org-get-indentation (&optional line)
  12597. "Get the indentation of the current line, interpreting tabs.
  12598. When LINE is given, assume it represents a line and compute its indentation."
  12599. (if line
  12600. (if (string-match "^ *" (org-remove-tabs line))
  12601. (match-end 0))
  12602. (save-excursion
  12603. (beginning-of-line 1)
  12604. (skip-chars-forward " \t")
  12605. (current-column))))
  12606. (defun org-remove-tabs (s &optional width)
  12607. "Replace tabulators in S with spaces.
  12608. Assumes that s is a single line, starting in column 0."
  12609. (setq width (or width tab-width))
  12610. (while (string-match "\t" s)
  12611. (setq s (replace-match
  12612. (make-string
  12613. (- (* width (/ (+ (match-beginning 0) width) width))
  12614. (match-beginning 0)) ?\ )
  12615. t t s)))
  12616. s)
  12617. (defun org-fix-indentation (line ind)
  12618. "Fix indentation in LINE.
  12619. IND is a cons cell with target and minimum indentation.
  12620. If the current indentation in LINE is smaller than the minimum,
  12621. leave it alone. If it is larger than ind, set it to the target."
  12622. (let* ((l (org-remove-tabs line))
  12623. (i (org-get-indentation l))
  12624. (i1 (car ind)) (i2 (cdr ind)))
  12625. (if (>= i i2) (setq l (substring line i2)))
  12626. (if (> i1 0)
  12627. (concat (make-string i1 ?\ ) l)
  12628. l)))
  12629. (defun org-base-buffer (buffer)
  12630. "Return the base buffer of BUFFER, if it has one. Else return the buffer."
  12631. (if (not buffer)
  12632. buffer
  12633. (or (buffer-base-buffer buffer)
  12634. buffer)))
  12635. (defun org-trim (s)
  12636. "Remove whitespace at beginning and end of string."
  12637. (if (string-match "\\`[ \t\n\r]+" s) (setq s (replace-match "" t t s)))
  12638. (if (string-match "[ \t\n\r]+\\'" s) (setq s (replace-match "" t t s)))
  12639. s)
  12640. (defun org-wrap (string &optional width lines)
  12641. "Wrap string to either a number of lines, or a width in characters.
  12642. If WIDTH is non-nil, the string is wrapped to that width, however many lines
  12643. that costs. If there is a word longer than WIDTH, the text is actually
  12644. wrapped to the length of that word.
  12645. IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
  12646. many lines, whatever width that takes.
  12647. The return value is a list of lines, without newlines at the end."
  12648. (let* ((words (org-split-string string "[ \t\n]+"))
  12649. (maxword (apply 'max (mapcar 'org-string-width words)))
  12650. w ll)
  12651. (cond (width
  12652. (org-do-wrap words (max maxword width)))
  12653. (lines
  12654. (setq w maxword)
  12655. (setq ll (org-do-wrap words maxword))
  12656. (if (<= (length ll) lines)
  12657. ll
  12658. (setq ll words)
  12659. (while (> (length ll) lines)
  12660. (setq w (1+ w))
  12661. (setq ll (org-do-wrap words w)))
  12662. ll))
  12663. (t (error "Cannot wrap this")))))
  12664. (defun org-do-wrap (words width)
  12665. "Create lines of maximum width WIDTH (in characters) from word list WORDS."
  12666. (let (lines line)
  12667. (while words
  12668. (setq line (pop words))
  12669. (while (and words (< (+ (length line) (length (car words))) width))
  12670. (setq line (concat line " " (pop words))))
  12671. (setq lines (push line lines)))
  12672. (nreverse lines)))
  12673. (defun org-split-string (string &optional separators)
  12674. "Splits STRING into substrings at SEPARATORS.
  12675. No empty strings are returned if there are matches at the beginning
  12676. and end of string."
  12677. (let ((rexp (or separators "[ \f\t\n\r\v]+"))
  12678. (start 0)
  12679. notfirst
  12680. (list nil))
  12681. (while (and (string-match rexp string
  12682. (if (and notfirst
  12683. (= start (match-beginning 0))
  12684. (< start (length string)))
  12685. (1+ start) start))
  12686. (< (match-beginning 0) (length string)))
  12687. (setq notfirst t)
  12688. (or (eq (match-beginning 0) 0)
  12689. (and (eq (match-beginning 0) (match-end 0))
  12690. (eq (match-beginning 0) start))
  12691. (setq list
  12692. (cons (substring string start (match-beginning 0))
  12693. list)))
  12694. (setq start (match-end 0)))
  12695. (or (eq start (length string))
  12696. (setq list
  12697. (cons (substring string start)
  12698. list)))
  12699. (nreverse list)))
  12700. (defun org-context ()
  12701. "Return a list of contexts of the current cursor position.
  12702. If several contexts apply, all are returned.
  12703. Each context entry is a list with a symbol naming the context, and
  12704. two positions indicating start and end of the context. Possible
  12705. contexts are:
  12706. :headline anywhere in a headline
  12707. :headline-stars on the leading stars in a headline
  12708. :todo-keyword on a TODO keyword (including DONE) in a headline
  12709. :tags on the TAGS in a headline
  12710. :priority on the priority cookie in a headline
  12711. :item on the first line of a plain list item
  12712. :item-bullet on the bullet/number of a plain list item
  12713. :checkbox on the checkbox in a plain list item
  12714. :table in an org-mode table
  12715. :table-special on a special filed in a table
  12716. :table-table in a table.el table
  12717. :link on a hyperlink
  12718. :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
  12719. :target on a <<target>>
  12720. :radio-target on a <<<radio-target>>>
  12721. :latex-fragment on a LaTeX fragment
  12722. :latex-preview on a LaTeX fragment with overlayed preview image
  12723. This function expects the position to be visible because it uses font-lock
  12724. faces as a help to recognize the following contexts: :table-special, :link,
  12725. and :keyword."
  12726. (let* ((f (get-text-property (point) 'face))
  12727. (faces (if (listp f) f (list f)))
  12728. (p (point)) clist o)
  12729. ;; First the large context
  12730. (cond
  12731. ((org-on-heading-p t)
  12732. (push (list :headline (point-at-bol) (point-at-eol)) clist)
  12733. (when (progn
  12734. (beginning-of-line 1)
  12735. (looking-at org-todo-line-tags-regexp))
  12736. (push (org-point-in-group p 1 :headline-stars) clist)
  12737. (push (org-point-in-group p 2 :todo-keyword) clist)
  12738. (push (org-point-in-group p 4 :tags) clist))
  12739. (goto-char p)
  12740. (skip-chars-backward "^[\n\r \t") (or (eobp) (backward-char 1))
  12741. (if (looking-at "\\[#[A-Z0-9]\\]")
  12742. (push (org-point-in-group p 0 :priority) clist)))
  12743. ((org-at-item-p)
  12744. (push (org-point-in-group p 2 :item-bullet) clist)
  12745. (push (list :item (point-at-bol)
  12746. (save-excursion (org-end-of-item) (point)))
  12747. clist)
  12748. (and (org-at-item-checkbox-p)
  12749. (push (org-point-in-group p 0 :checkbox) clist)))
  12750. ((org-at-table-p)
  12751. (push (list :table (org-table-begin) (org-table-end)) clist)
  12752. (if (memq 'org-formula faces)
  12753. (push (list :table-special
  12754. (previous-single-property-change p 'face)
  12755. (next-single-property-change p 'face)) clist)))
  12756. ((org-at-table-p 'any)
  12757. (push (list :table-table) clist)))
  12758. (goto-char p)
  12759. ;; Now the small context
  12760. (cond
  12761. ((org-at-timestamp-p)
  12762. (push (org-point-in-group p 0 :timestamp) clist))
  12763. ((memq 'org-link faces)
  12764. (push (list :link
  12765. (previous-single-property-change p 'face)
  12766. (next-single-property-change p 'face)) clist))
  12767. ((memq 'org-special-keyword faces)
  12768. (push (list :keyword
  12769. (previous-single-property-change p 'face)
  12770. (next-single-property-change p 'face)) clist))
  12771. ((org-on-target-p)
  12772. (push (org-point-in-group p 0 :target) clist)
  12773. (goto-char (1- (match-beginning 0)))
  12774. (if (looking-at org-radio-target-regexp)
  12775. (push (org-point-in-group p 0 :radio-target) clist))
  12776. (goto-char p))
  12777. ((setq o (car (delq nil
  12778. (mapcar
  12779. (lambda (x)
  12780. (if (memq x org-latex-fragment-image-overlays) x))
  12781. (org-overlays-at (point))))))
  12782. (push (list :latex-fragment
  12783. (org-overlay-start o) (org-overlay-end o)) clist)
  12784. (push (list :latex-preview
  12785. (org-overlay-start o) (org-overlay-end o)) clist))
  12786. ((org-inside-LaTeX-fragment-p)
  12787. ;; FIXME: positions wrong.
  12788. (push (list :latex-fragment (point) (point)) clist)))
  12789. (setq clist (nreverse (delq nil clist)))
  12790. clist))
  12791. ;; FIXME: Compare with at-regexp-p Do we need both?
  12792. (defun org-in-regexp (re &optional nlines visually)
  12793. "Check if point is inside a match of regexp.
  12794. Normally only the current line is checked, but you can include NLINES extra
  12795. lines both before and after point into the search.
  12796. If VISUALLY is set, require that the cursor is not after the match but
  12797. really on, so that the block visually is on the match."
  12798. (catch 'exit
  12799. (let ((pos (point))
  12800. (eol (point-at-eol (+ 1 (or nlines 0))))
  12801. (inc (if visually 1 0)))
  12802. (save-excursion
  12803. (beginning-of-line (- 1 (or nlines 0)))
  12804. (while (re-search-forward re eol t)
  12805. (if (and (<= (match-beginning 0) pos)
  12806. (>= (+ inc (match-end 0)) pos))
  12807. (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
  12808. (defun org-at-regexp-p (regexp)
  12809. "Is point inside a match of REGEXP in the current line?"
  12810. (catch 'exit
  12811. (save-excursion
  12812. (let ((pos (point)) (end (point-at-eol)))
  12813. (beginning-of-line 1)
  12814. (while (re-search-forward regexp end t)
  12815. (if (and (<= (match-beginning 0) pos)
  12816. (>= (match-end 0) pos))
  12817. (throw 'exit t)))
  12818. nil))))
  12819. (defun org-occur-in-agenda-files (regexp &optional nlines)
  12820. "Call `multi-occur' with buffers for all agenda files."
  12821. (interactive "sOrg-files matching: \np")
  12822. (let* ((files (org-agenda-files))
  12823. (tnames (mapcar 'file-truename files))
  12824. (extra org-agenda-text-search-extra-files)
  12825. f)
  12826. (when (eq (car extra) 'agenda-archives)
  12827. (setq extra (cdr extra))
  12828. (setq files (org-add-archive-files files)))
  12829. (while (setq f (pop extra))
  12830. (unless (member (file-truename f) tnames)
  12831. (add-to-list 'files f 'append)
  12832. (add-to-list 'tnames (file-truename f) 'append)))
  12833. (multi-occur
  12834. (mapcar (lambda (x) (or (get-file-buffer x) (find-file-noselect x))) files)
  12835. regexp)))
  12836. (if (boundp 'occur-mode-find-occurrence-hook)
  12837. ;; Emacs 23
  12838. (add-hook 'occur-mode-find-occurrence-hook
  12839. (lambda ()
  12840. (when (org-mode-p)
  12841. (org-reveal))))
  12842. ;; Emacs 22
  12843. (defadvice occur-mode-goto-occurrence
  12844. (after org-occur-reveal activate)
  12845. (and (org-mode-p) (org-reveal)))
  12846. (defadvice occur-mode-goto-occurrence-other-window
  12847. (after org-occur-reveal activate)
  12848. (and (org-mode-p) (org-reveal)))
  12849. (defadvice occur-mode-display-occurrence
  12850. (after org-occur-reveal activate)
  12851. (when (org-mode-p)
  12852. (let ((pos (occur-mode-find-occurrence)))
  12853. (with-current-buffer (marker-buffer pos)
  12854. (save-excursion
  12855. (goto-char pos)
  12856. (org-reveal)))))))
  12857. (defun org-uniquify (list)
  12858. "Remove duplicate elements from LIST."
  12859. (let (res)
  12860. (mapc (lambda (x) (add-to-list 'res x 'append)) list)
  12861. res))
  12862. (defun org-delete-all (elts list)
  12863. "Remove all elements in ELTS from LIST."
  12864. (while elts
  12865. (setq list (delete (pop elts) list)))
  12866. list)
  12867. (defun org-back-over-empty-lines ()
  12868. "Move backwards over whitespace, to the beginning of the first empty line.
  12869. Returns the number of empty lines passed."
  12870. (let ((pos (point)))
  12871. (skip-chars-backward " \t\n\r")
  12872. (beginning-of-line 2)
  12873. (goto-char (min (point) pos))
  12874. (count-lines (point) pos)))
  12875. (defun org-skip-whitespace ()
  12876. (skip-chars-forward " \t\n\r"))
  12877. (defun org-point-in-group (point group &optional context)
  12878. "Check if POINT is in match-group GROUP.
  12879. If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
  12880. match. If the match group does ot exist or point is not inside it,
  12881. return nil."
  12882. (and (match-beginning group)
  12883. (>= point (match-beginning group))
  12884. (<= point (match-end group))
  12885. (if context
  12886. (list context (match-beginning group) (match-end group))
  12887. t)))
  12888. (defun org-switch-to-buffer-other-window (&rest args)
  12889. "Switch to buffer in a second window on the current frame.
  12890. In particular, do not allow pop-up frames."
  12891. (let (pop-up-frames special-display-buffer-names special-display-regexps
  12892. special-display-function)
  12893. (apply 'switch-to-buffer-other-window args)))
  12894. (defun org-combine-plists (&rest plists)
  12895. "Create a single property list from all plists in PLISTS.
  12896. The process starts by copying the first list, and then setting properties
  12897. from the other lists. Settings in the last list are the most significant
  12898. ones and overrule settings in the other lists."
  12899. (let ((rtn (copy-sequence (pop plists)))
  12900. p v ls)
  12901. (while plists
  12902. (setq ls (pop plists))
  12903. (while ls
  12904. (setq p (pop ls) v (pop ls))
  12905. (setq rtn (plist-put rtn p v))))
  12906. rtn))
  12907. (defun org-move-line-down (arg)
  12908. "Move the current line down. 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 (+ 1 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-move-line-up (arg)
  12920. "Move the current line up. With prefix argument, move it past ARG lines."
  12921. (interactive "p")
  12922. (let ((col (current-column))
  12923. beg end pos)
  12924. (beginning-of-line 1) (setq beg (point))
  12925. (beginning-of-line 2) (setq end (point))
  12926. (beginning-of-line (- arg))
  12927. (setq pos (move-marker (make-marker) (point)))
  12928. (insert (delete-and-extract-region beg end))
  12929. (goto-char pos)
  12930. (org-move-to-column col)))
  12931. (defun org-replace-escapes (string table)
  12932. "Replace %-escapes in STRING with values in TABLE.
  12933. TABLE is an association list with keys like \"%a\" and string values.
  12934. The sequences in STRING may contain normal field width and padding information,
  12935. for example \"%-5s\". Replacements happen in the sequence given by TABLE,
  12936. so values can contain further %-escapes if they are define later in TABLE."
  12937. (let ((case-fold-search nil)
  12938. e re rpl)
  12939. (while (setq e (pop table))
  12940. (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
  12941. (while (string-match re string)
  12942. (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
  12943. (cdr e)))
  12944. (setq string (replace-match rpl t t string))))
  12945. string))
  12946. (defun org-sublist (list start end)
  12947. "Return a section of LIST, from START to END.
  12948. Counting starts at 1."
  12949. (let (rtn (c start))
  12950. (setq list (nthcdr (1- start) list))
  12951. (while (and list (<= c end))
  12952. (push (pop list) rtn)
  12953. (setq c (1+ c)))
  12954. (nreverse rtn)))
  12955. (defun org-find-base-buffer-visiting (file)
  12956. "Like `find-buffer-visiting' but alway return the base buffer and
  12957. not an indirect buffer."
  12958. (let ((buf (find-buffer-visiting file)))
  12959. (if buf
  12960. (or (buffer-base-buffer buf) buf)
  12961. nil)))
  12962. (defun org-image-file-name-regexp ()
  12963. "Return regexp matching the file names of images."
  12964. (if (fboundp 'image-file-name-regexp)
  12965. (image-file-name-regexp)
  12966. (let ((image-file-name-extensions
  12967. '("png" "jpeg" "jpg" "gif" "tiff" "tif"
  12968. "xbm" "xpm" "pbm" "pgm" "ppm")))
  12969. (concat "\\."
  12970. (regexp-opt (nconc (mapcar 'upcase
  12971. image-file-name-extensions)
  12972. image-file-name-extensions)
  12973. t)
  12974. "\\'"))))
  12975. (defun org-file-image-p (file)
  12976. "Return non-nil if FILE is an image."
  12977. (save-match-data
  12978. (string-match (org-image-file-name-regexp) file)))
  12979. (defun org-get-cursor-date ()
  12980. "Return the date at cursor in as a time.
  12981. This works in the calendar and in the agenda, anywhere else it just
  12982. returns the current time."
  12983. (let (date day defd)
  12984. (cond
  12985. ((eq major-mode 'calendar-mode)
  12986. (setq date (calendar-cursor-to-date)
  12987. defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  12988. ((eq major-mode 'org-agenda-mode)
  12989. (setq day (get-text-property (point) 'day))
  12990. (if day
  12991. (setq date (calendar-gregorian-from-absolute day)
  12992. defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
  12993. (nth 2 date))))))
  12994. (or defd (current-time))))
  12995. (defvar org-agenda-action-marker (make-marker)
  12996. "Marker pointing to the entry for the next agenda action.")
  12997. (defun org-mark-entry-for-agenda-action ()
  12998. "Mark the current entry as target of an agenda action.
  12999. Agenda actions are actions executed from the agenda with the key `k',
  13000. which make use of the date at the cursor."
  13001. (interactive)
  13002. (move-marker org-agenda-action-marker
  13003. (save-excursion (org-back-to-heading t) (point))
  13004. (current-buffer))
  13005. (message
  13006. "Entry marked for action; press `k' at desired date in agenda or calendar"))
  13007. ;;; Paragraph filling stuff.
  13008. ;; We want this to be just right, so use the full arsenal.
  13009. (defun org-indent-line-function ()
  13010. "Indent line like previous, but further if previous was headline or item."
  13011. (interactive)
  13012. (let* ((pos (point))
  13013. (itemp (org-at-item-p))
  13014. column bpos bcol tpos tcol bullet btype bullet-type)
  13015. ;; Find the previous relevant line
  13016. (beginning-of-line 1)
  13017. (cond
  13018. ((looking-at "#") (setq column 0))
  13019. ((looking-at "\\*+ ") (setq column 0))
  13020. (t
  13021. (beginning-of-line 0)
  13022. (while (and (not (bobp)) (looking-at "[ \t]*[\n:#|]"))
  13023. (beginning-of-line 0))
  13024. (cond
  13025. ((looking-at "\\*+[ \t]+")
  13026. (if (not org-adapt-indentation)
  13027. (setq column 0)
  13028. (goto-char (match-end 0))
  13029. (setq column (current-column))))
  13030. ((org-in-item-p)
  13031. (org-beginning-of-item)
  13032. (looking-at "[ \t]*\\(\\S-+\\)[ \t]*\\(\\[[- X]\\][ \t]*\\|.*? :: \\)?")
  13033. (setq bpos (match-beginning 1) tpos (match-end 0)
  13034. bcol (progn (goto-char bpos) (current-column))
  13035. tcol (progn (goto-char tpos) (current-column))
  13036. bullet (match-string 1)
  13037. bullet-type (if (string-match "[0-9]" bullet) "n" bullet))
  13038. (if (> tcol (+ bcol org-description-max-indent))
  13039. (setq tcol (+ bcol 5)))
  13040. (if (not itemp)
  13041. (setq column tcol)
  13042. (goto-char pos)
  13043. (beginning-of-line 1)
  13044. (if (looking-at "\\S-")
  13045. (progn
  13046. (looking-at "[ \t]*\\(\\S-+\\)[ \t]*")
  13047. (setq bullet (match-string 1)
  13048. btype (if (string-match "[0-9]" bullet) "n" bullet))
  13049. (setq column (if (equal btype bullet-type) bcol tcol)))
  13050. (setq column (org-get-indentation)))))
  13051. (t (setq column (org-get-indentation))))))
  13052. (goto-char pos)
  13053. (if (<= (current-column) (current-indentation))
  13054. (org-indent-line-to column)
  13055. (save-excursion (org-indent-line-to column)))
  13056. (setq column (current-column))
  13057. (beginning-of-line 1)
  13058. (if (looking-at
  13059. "\\([ \t]+\\)\\(:[-_0-9a-zA-Z]+:\\)[ \t]*\\(\\S-.*\\(\\S-\\|$\\)\\)")
  13060. (replace-match (concat "\\1" (format org-property-format
  13061. (match-string 2) (match-string 3)))
  13062. t nil))
  13063. (org-move-to-column column)))
  13064. (defun org-set-autofill-regexps ()
  13065. (interactive)
  13066. ;; In the paragraph separator we include headlines, because filling
  13067. ;; text in a line directly attached to a headline would otherwise
  13068. ;; fill the headline as well.
  13069. (org-set-local 'comment-start-skip "^#+[ \t]*")
  13070. (org-set-local 'paragraph-separate "\f\\|\\*+ \\|[ ]*$\\|[ \t]*[:|]")
  13071. ;; The paragraph starter includes hand-formatted lists.
  13072. (org-set-local 'paragraph-start
  13073. "\f\\|[ ]*$\\|\\*+ \\|\f\\|[ \t]*\\([-+*][ \t]+\\|[0-9]+[.)][ \t]+\\)\\|[ \t]*[:|]")
  13074. ;; Inhibit auto-fill for headers, tables and fixed-width lines.
  13075. ;; But only if the user has not turned off tables or fixed-width regions
  13076. (org-set-local
  13077. 'auto-fill-inhibit-regexp
  13078. (concat "\\*+ \\|#\\+"
  13079. "\\|[ \t]*" org-keyword-time-regexp
  13080. (if (or org-enable-table-editor org-enable-fixed-width-editor)
  13081. (concat
  13082. "\\|[ \t]*["
  13083. (if org-enable-table-editor "|" "")
  13084. (if org-enable-fixed-width-editor ":" "")
  13085. "]"))))
  13086. ;; We use our own fill-paragraph function, to make sure that tables
  13087. ;; and fixed-width regions are not wrapped. That function will pass
  13088. ;; through to `fill-paragraph' when appropriate.
  13089. (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
  13090. ; Adaptive filling: To get full control, first make sure that
  13091. ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
  13092. (org-set-local 'adaptive-fill-regexp "\000")
  13093. (org-set-local 'adaptive-fill-function
  13094. 'org-adaptive-fill-function)
  13095. (org-set-local
  13096. 'align-mode-rules-list
  13097. '((org-in-buffer-settings
  13098. (regexp . "^#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
  13099. (modes . '(org-mode))))))
  13100. (defun org-fill-paragraph (&optional justify)
  13101. "Re-align a table, pass through to fill-paragraph if no table."
  13102. (let ((table-p (org-at-table-p))
  13103. (table.el-p (org-at-table.el-p)))
  13104. (cond ((and (equal (char-after (point-at-bol)) ?*)
  13105. (save-excursion (goto-char (point-at-bol))
  13106. (looking-at outline-regexp)))
  13107. t) ; skip headlines
  13108. (table.el-p t) ; skip table.el tables
  13109. (table-p (org-table-align) t) ; align org-mode tables
  13110. (t nil)))) ; call paragraph-fill
  13111. ;; For reference, this is the default value of adaptive-fill-regexp
  13112. ;; "[ \t]*\\([-|#;>*]+[ \t]*\\|(?[0-9]+[.)][ \t]*\\)*"
  13113. (defun org-adaptive-fill-function ()
  13114. "Return a fill prefix for org-mode files.
  13115. In particular, this makes sure hanging paragraphs for hand-formatted lists
  13116. work correctly."
  13117. (cond ((looking-at "#[ \t]+")
  13118. (match-string 0))
  13119. ((looking-at "[ \t]*\\([-*+] .*? :: \\)")
  13120. (save-excursion
  13121. (if (> (match-end 1) (+ (match-beginning 1)
  13122. org-description-max-indent))
  13123. (goto-char (+ (match-beginning 1) 5))
  13124. (goto-char (match-end 0)))
  13125. (make-string (current-column) ?\ )))
  13126. ((looking-at "[ \t]*\\([-*+] \\|[0-9]+[.)] ?\\)?")
  13127. (save-excursion
  13128. (goto-char (match-end 0))
  13129. (make-string (current-column) ?\ )))
  13130. (t nil)))
  13131. ;;; Other stuff.
  13132. (defun org-toggle-fixed-width-section (arg)
  13133. "Toggle the fixed-width export.
  13134. If there is no active region, the QUOTE keyword at the current headline is
  13135. inserted or removed. When present, it causes the text between this headline
  13136. and the next to be exported as fixed-width text, and unmodified.
  13137. If there is an active region, this command adds or removes a colon as the
  13138. first character of this line. If the first character of a line is a colon,
  13139. this line is also exported in fixed-width font."
  13140. (interactive "P")
  13141. (let* ((cc 0)
  13142. (regionp (org-region-active-p))
  13143. (beg (if regionp (region-beginning) (point)))
  13144. (end (if regionp (region-end)))
  13145. (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
  13146. (case-fold-search nil)
  13147. (re "[ \t]*\\(:\\)")
  13148. off)
  13149. (if regionp
  13150. (save-excursion
  13151. (goto-char beg)
  13152. (setq cc (current-column))
  13153. (beginning-of-line 1)
  13154. (setq off (looking-at re))
  13155. (while (> nlines 0)
  13156. (setq nlines (1- nlines))
  13157. (beginning-of-line 1)
  13158. (cond
  13159. (arg
  13160. (org-move-to-column cc t)
  13161. (insert ":\n")
  13162. (forward-line -1))
  13163. ((and off (looking-at re))
  13164. (replace-match "" t t nil 1))
  13165. ((not off) (org-move-to-column cc t) (insert ":")))
  13166. (forward-line 1)))
  13167. (save-excursion
  13168. (org-back-to-heading)
  13169. (if (looking-at (concat outline-regexp
  13170. "\\( *\\<" org-quote-string "\\>[ \t]*\\)"))
  13171. (replace-match "" t t nil 1)
  13172. (if (looking-at outline-regexp)
  13173. (progn
  13174. (goto-char (match-end 0))
  13175. (insert org-quote-string " "))))))))
  13176. ;;;; Functions extending outline functionality
  13177. (defun org-beginning-of-line (&optional arg)
  13178. "Go to the beginning of the current line. If that is invisible, continue
  13179. to a visible line beginning. This makes the function of C-a more intuitive.
  13180. If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
  13181. first attempt, and only move to after the tags when the cursor is already
  13182. beyond the end of the headline."
  13183. (interactive "P")
  13184. (let ((pos (point)) refpos)
  13185. (beginning-of-line 1)
  13186. (if (bobp)
  13187. nil
  13188. (backward-char 1)
  13189. (if (org-invisible-p)
  13190. (while (and (not (bobp)) (org-invisible-p))
  13191. (backward-char 1)
  13192. (beginning-of-line 1))
  13193. (forward-char 1)))
  13194. (when org-special-ctrl-a/e
  13195. (cond
  13196. ((and (looking-at org-complex-heading-regexp)
  13197. (= (char-after (match-end 1)) ?\ ))
  13198. (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
  13199. (point-at-eol)))
  13200. (goto-char
  13201. (if (eq org-special-ctrl-a/e t)
  13202. (cond ((> pos refpos) refpos)
  13203. ((= pos (point)) refpos)
  13204. (t (point)))
  13205. (cond ((> pos (point)) (point))
  13206. ((not (eq last-command this-command)) (point))
  13207. (t refpos)))))
  13208. ((org-at-item-p)
  13209. (goto-char
  13210. (if (eq org-special-ctrl-a/e t)
  13211. (cond ((> pos (match-end 4)) (match-end 4))
  13212. ((= pos (point)) (match-end 4))
  13213. (t (point)))
  13214. (cond ((> pos (point)) (point))
  13215. ((not (eq last-command this-command)) (point))
  13216. (t (match-end 4))))))))
  13217. (org-no-warnings
  13218. (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
  13219. (defun org-end-of-line (&optional arg)
  13220. "Go to the end of the line.
  13221. If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
  13222. first attempt, and only move to after the tags when the cursor is already
  13223. beyond the end of the headline."
  13224. (interactive "P")
  13225. (if (or (not org-special-ctrl-a/e)
  13226. (not (org-on-heading-p)))
  13227. (end-of-line arg)
  13228. (let ((pos (point)))
  13229. (beginning-of-line 1)
  13230. (if (looking-at (org-re ".*?\\([ \t]*\\)\\(:[[:alnum:]_@:]+:\\)[ \t]*$"))
  13231. (if (eq org-special-ctrl-a/e t)
  13232. (if (or (< pos (match-beginning 1))
  13233. (= pos (match-end 0)))
  13234. (goto-char (match-beginning 1))
  13235. (goto-char (match-end 0)))
  13236. (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
  13237. (goto-char (match-end 0))
  13238. (goto-char (match-beginning 1))))
  13239. (end-of-line arg))))
  13240. (org-no-warnings
  13241. (and (featurep 'xemacs) (setq zmacs-region-stays t))))
  13242. (define-key org-mode-map "\C-a" 'org-beginning-of-line)
  13243. (define-key org-mode-map "\C-e" 'org-end-of-line)
  13244. (defun org-kill-line (&optional arg)
  13245. "Kill line, to tags or end of line."
  13246. (interactive "P")
  13247. (cond
  13248. ((or (not org-special-ctrl-k)
  13249. (bolp)
  13250. (not (org-on-heading-p)))
  13251. (call-interactively 'kill-line))
  13252. ((looking-at (org-re ".*?\\S-\\([ \t]+\\(:[[:alnum:]_@:]+:\\)\\)[ \t]*$"))
  13253. (kill-region (point) (match-beginning 1))
  13254. (org-set-tags nil t))
  13255. (t (kill-region (point) (point-at-eol)))))
  13256. (define-key org-mode-map "\C-k" 'org-kill-line)
  13257. (defun org-yank (&optional arg)
  13258. "Yank. If the kill is a subtree, treat it specially.
  13259. This command will look at the current kill and check if is a single
  13260. subtree, or a series of subtrees[1]. If it passes the test, and if the
  13261. cursor is at the beginning of a line or after the stars of a currently
  13262. empty headline, then the yank is handled specially. How exactly depends
  13263. on the value of the following variables, both set by default.
  13264. org-yank-folded-subtrees
  13265. When set, the subtree(s) will be folded after insertion, but only
  13266. if doing so would now swallow text after the yanked text.
  13267. org-yank-adjusted-subtrees
  13268. When set, the subtree will be promoted or demoted in order to
  13269. fit into the local outline tree structure, which means that the level
  13270. will be adjusted so that it becomes the smaller one of the two
  13271. *visible* surrounding headings.
  13272. Any prefix to this command will cause `yank' to be called directly with
  13273. no special treatment. In particular, a simple `C-u' prefix will just
  13274. plainly yank the text as it is.
  13275. \[1] Basically, the test checks if the first non-white line is a heading
  13276. and if there are no other headings with fewer stars."
  13277. (interactive "P")
  13278. (setq this-command 'yank)
  13279. (if arg
  13280. (call-interactively 'yank)
  13281. (let ((subtreep ; is kill a subtree, and the yank position appropriate?
  13282. (and (org-kill-is-subtree-p)
  13283. (or (bolp)
  13284. (and (looking-at "[ \t]*$")
  13285. (string-match
  13286. "\\`\\*+\\'"
  13287. (buffer-substring (point-at-bol) (point)))))))
  13288. swallowp)
  13289. (cond
  13290. ((and subtreep org-yank-folded-subtrees)
  13291. (let ((beg (point))
  13292. end)
  13293. (if (and subtreep org-yank-adjusted-subtrees)
  13294. (org-paste-subtree nil nil 'for-yank)
  13295. (call-interactively 'yank))
  13296. (setq end (point))
  13297. (goto-char beg)
  13298. (when (and (bolp) subtreep
  13299. (not (setq swallowp
  13300. (org-yank-folding-would-swallow-text beg end))))
  13301. (or (looking-at outline-regexp)
  13302. (re-search-forward (concat "^" outline-regexp) end t))
  13303. (while (and (< (point) end) (looking-at outline-regexp))
  13304. (hide-subtree)
  13305. (org-cycle-show-empty-lines 'folded)
  13306. (condition-case nil
  13307. (outline-forward-same-level 1)
  13308. (error (goto-char end)))))
  13309. (when swallowp
  13310. (message
  13311. "Yanked text not folded because that would swallow text"))
  13312. (goto-char end)
  13313. (skip-chars-forward " \t\n\r")
  13314. (beginning-of-line 1)
  13315. (push-mark beg 'nomsg)))
  13316. ((and subtreep org-yank-adjusted-subtrees)
  13317. (let ((beg (point-at-bol)))
  13318. (org-paste-subtree nil nil 'for-yank)
  13319. (push-mark beg 'nomsg)))
  13320. (t
  13321. (call-interactively 'yank))))))
  13322. (defun org-yank-folding-would-swallow-text (beg end)
  13323. "Would hide-subtree at BEG swallow any text after END?"
  13324. (let (level)
  13325. (save-excursion
  13326. (goto-char beg)
  13327. (when (or (looking-at outline-regexp)
  13328. (re-search-forward (concat "^" outline-regexp) end t))
  13329. (setq level (org-outline-level)))
  13330. (goto-char end)
  13331. (skip-chars-forward " \t\r\n\v\f")
  13332. (if (or (eobp)
  13333. (and (bolp) (looking-at org-outline-regexp)
  13334. (<= (org-outline-level) level)))
  13335. nil ; Nothing would be swallowed
  13336. t)))) ; something would swallow
  13337. (define-key org-mode-map "\C-y" 'org-yank)
  13338. (defun org-invisible-p ()
  13339. "Check if point is at a character currently not visible."
  13340. ;; Early versions of noutline don't have `outline-invisible-p'.
  13341. (if (fboundp 'outline-invisible-p)
  13342. (outline-invisible-p)
  13343. (get-char-property (point) 'invisible)))
  13344. (defun org-invisible-p2 ()
  13345. "Check if point is at a character currently not visible."
  13346. (save-excursion
  13347. (if (and (eolp) (not (bobp))) (backward-char 1))
  13348. ;; Early versions of noutline don't have `outline-invisible-p'.
  13349. (if (fboundp 'outline-invisible-p)
  13350. (outline-invisible-p)
  13351. (get-char-property (point) 'invisible))))
  13352. (defun org-back-to-heading (&optional invisible-ok)
  13353. "Call `outline-back-to-heading', but provide a better error message."
  13354. (condition-case nil
  13355. (outline-back-to-heading invisible-ok)
  13356. (error (error "Before first headline at position %d in buffer %s"
  13357. (point) (current-buffer)))))
  13358. (defun org-before-first-heading-p ()
  13359. "Before first heading?"
  13360. (save-excursion
  13361. (null (re-search-backward "^\\*+ " nil t))))
  13362. (defalias 'org-on-heading-p 'outline-on-heading-p)
  13363. (defalias 'org-at-heading-p 'outline-on-heading-p)
  13364. (defun org-at-heading-or-item-p ()
  13365. (or (org-on-heading-p) (org-at-item-p)))
  13366. (defun org-on-target-p ()
  13367. (or (org-in-regexp org-radio-target-regexp)
  13368. (org-in-regexp org-target-regexp)))
  13369. (defun org-up-heading-all (arg)
  13370. "Move to the heading line of which the present line is a subheading.
  13371. This function considers both visible and invisible heading lines.
  13372. With argument, move up ARG levels."
  13373. (if (fboundp 'outline-up-heading-all)
  13374. (outline-up-heading-all arg) ; emacs 21 version of outline.el
  13375. (outline-up-heading arg t))) ; emacs 22 version of outline.el
  13376. (defun org-up-heading-safe ()
  13377. "Move to the heading line of which the present line is a subheading.
  13378. This version will not throw an error. It will return the level of the
  13379. headline found, or nil if no higher level is found."
  13380. (let (start-level re)
  13381. (org-back-to-heading t)
  13382. (setq start-level (funcall outline-level))
  13383. (if (equal start-level 1)
  13384. nil
  13385. (setq re (concat "^\\*\\{1," (number-to-string (1- start-level)) "\\} "))
  13386. (if (re-search-backward re nil t)
  13387. (funcall outline-level)))))
  13388. (defun org-first-sibling-p ()
  13389. "Is this heading the first child of its parents?"
  13390. (interactive)
  13391. (let ((re (concat "^" outline-regexp))
  13392. level l)
  13393. (unless (org-at-heading-p t)
  13394. (error "Not at a heading"))
  13395. (setq level (funcall outline-level))
  13396. (save-excursion
  13397. (if (not (re-search-backward re nil t))
  13398. t
  13399. (setq l (funcall outline-level))
  13400. (< l level)))))
  13401. (defun org-goto-sibling (&optional previous)
  13402. "Goto the next sibling, even if it is invisible.
  13403. When PREVIOUS is set, go to the previous sibling instead. Returns t
  13404. when a sibling was found. When none is found, return nil and don't
  13405. move point."
  13406. (let ((fun (if previous 're-search-backward 're-search-forward))
  13407. (pos (point))
  13408. (re (concat "^" outline-regexp))
  13409. level l)
  13410. (when (condition-case nil (org-back-to-heading t) (error nil))
  13411. (setq level (funcall outline-level))
  13412. (catch 'exit
  13413. (or previous (forward-char 1))
  13414. (while (funcall fun re nil t)
  13415. (setq l (funcall outline-level))
  13416. (when (< l level) (goto-char pos) (throw 'exit nil))
  13417. (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
  13418. (goto-char pos)
  13419. nil))))
  13420. (defun org-show-siblings ()
  13421. "Show all siblings of the current headline."
  13422. (save-excursion
  13423. (while (org-goto-sibling) (org-flag-heading nil)))
  13424. (save-excursion
  13425. (while (org-goto-sibling 'previous)
  13426. (org-flag-heading nil))))
  13427. (defun org-show-hidden-entry ()
  13428. "Show an entry where even the heading is hidden."
  13429. (save-excursion
  13430. (org-show-entry)))
  13431. (defun org-flag-heading (flag &optional entry)
  13432. "Flag the current heading. FLAG non-nil means make invisible.
  13433. When ENTRY is non-nil, show the entire entry."
  13434. (save-excursion
  13435. (org-back-to-heading t)
  13436. ;; Check if we should show the entire entry
  13437. (if entry
  13438. (progn
  13439. (org-show-entry)
  13440. (save-excursion
  13441. (and (outline-next-heading)
  13442. (org-flag-heading nil))))
  13443. (outline-flag-region (max (point-min) (1- (point)))
  13444. (save-excursion (outline-end-of-heading) (point))
  13445. flag))))
  13446. (defun org-forward-same-level (arg)
  13447. "Move forward to the ARG'th subheading at same level as this one.
  13448. Stop at the first and last subheadings of a superior heading.
  13449. This is like outline-forward-same-level, but invisible headings are ok."
  13450. (interactive "p")
  13451. (org-back-to-heading t)
  13452. (while (> arg 0)
  13453. (let ((point-to-move-to (save-excursion
  13454. (org-get-next-sibling))))
  13455. (if point-to-move-to
  13456. (progn
  13457. (goto-char point-to-move-to)
  13458. (setq arg (1- arg)))
  13459. (progn
  13460. (setq arg 0)
  13461. (error "No following same-level heading"))))))
  13462. (defun org-get-next-sibling ()
  13463. "Move to next heading of the same level, and return point.
  13464. If there is no such heading, return nil.
  13465. This is like outline-next-sibling, but invisible headings are ok."
  13466. (let ((level (funcall outline-level)))
  13467. (outline-next-heading)
  13468. (while (and (not (eobp)) (> (funcall outline-level) level))
  13469. (outline-next-heading))
  13470. (if (or (eobp) (< (funcall outline-level) level))
  13471. nil
  13472. (point))))
  13473. (defun org-end-of-subtree (&optional invisible-OK to-heading)
  13474. ;; This is an exact copy of the original function, but it uses
  13475. ;; `org-back-to-heading', to make it work also in invisible
  13476. ;; trees. And is uses an invisible-OK argument.
  13477. ;; Under Emacs this is not needed, but the old outline.el needs this fix.
  13478. (org-back-to-heading invisible-OK)
  13479. (let ((first t)
  13480. (level (funcall outline-level)))
  13481. (while (and (not (eobp))
  13482. (or first (> (funcall outline-level) level)))
  13483. (setq first nil)
  13484. (outline-next-heading))
  13485. (unless to-heading
  13486. (if (memq (preceding-char) '(?\n ?\^M))
  13487. (progn
  13488. ;; Go to end of line before heading
  13489. (forward-char -1)
  13490. (if (memq (preceding-char) '(?\n ?\^M))
  13491. ;; leave blank line before heading
  13492. (forward-char -1))))))
  13493. (point))
  13494. (defun org-show-subtree ()
  13495. "Show everything after this heading at deeper levels."
  13496. (outline-flag-region
  13497. (point)
  13498. (save-excursion
  13499. (outline-end-of-subtree) (outline-next-heading) (point))
  13500. nil))
  13501. (defun org-show-entry ()
  13502. "Show the body directly following this heading.
  13503. Show the heading too, if it is currently invisible."
  13504. (interactive)
  13505. (save-excursion
  13506. (condition-case nil
  13507. (progn
  13508. (org-back-to-heading t)
  13509. (outline-flag-region
  13510. (max (point-min) (1- (point)))
  13511. (save-excursion
  13512. (re-search-forward
  13513. (concat "[\r\n]\\(" outline-regexp "\\)") nil 'move)
  13514. (or (match-beginning 1) (point-max)))
  13515. nil))
  13516. (error nil))))
  13517. (defun org-make-options-regexp (kwds)
  13518. "Make a regular expression for keyword lines."
  13519. (concat
  13520. "^"
  13521. "#?[ \t]*\\+\\("
  13522. (mapconcat 'regexp-quote kwds "\\|")
  13523. "\\):[ \t]*"
  13524. "\\(.+\\)"))
  13525. ;; Make isearch reveal the necessary context
  13526. (defun org-isearch-end ()
  13527. "Reveal context after isearch exits."
  13528. (when isearch-success ; only if search was successful
  13529. (if (featurep 'xemacs)
  13530. ;; Under XEmacs, the hook is run in the correct place,
  13531. ;; we directly show the context.
  13532. (org-show-context 'isearch)
  13533. ;; In Emacs the hook runs *before* restoring the overlays.
  13534. ;; So we have to use a one-time post-command-hook to do this.
  13535. ;; (Emacs 22 has a special variable, see function `org-mode')
  13536. (unless (and (boundp 'isearch-mode-end-hook-quit)
  13537. isearch-mode-end-hook-quit)
  13538. ;; Only when the isearch was not quitted.
  13539. (org-add-hook 'post-command-hook 'org-isearch-post-command
  13540. 'append 'local)))))
  13541. (defun org-isearch-post-command ()
  13542. "Remove self from hook, and show context."
  13543. (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
  13544. (org-show-context 'isearch))
  13545. ;;;; Integration with and fixes for other packages
  13546. ;;; Imenu support
  13547. (defvar org-imenu-markers nil
  13548. "All markers currently used by Imenu.")
  13549. (make-variable-buffer-local 'org-imenu-markers)
  13550. (defun org-imenu-new-marker (&optional pos)
  13551. "Return a new marker for use by Imenu, and remember the marker."
  13552. (let ((m (make-marker)))
  13553. (move-marker m (or pos (point)))
  13554. (push m org-imenu-markers)
  13555. m))
  13556. (defun org-imenu-get-tree ()
  13557. "Produce the index for Imenu."
  13558. (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
  13559. (setq org-imenu-markers nil)
  13560. (let* ((n org-imenu-depth)
  13561. (re (concat "^" outline-regexp))
  13562. (subs (make-vector (1+ n) nil))
  13563. (last-level 0)
  13564. m tree level head)
  13565. (save-excursion
  13566. (save-restriction
  13567. (widen)
  13568. (goto-char (point-max))
  13569. (while (re-search-backward re nil t)
  13570. (setq level (org-reduced-level (funcall outline-level)))
  13571. (when (<= level n)
  13572. (looking-at org-complex-heading-regexp)
  13573. (setq head (org-link-display-format
  13574. (org-match-string-no-properties 4))
  13575. m (org-imenu-new-marker))
  13576. (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
  13577. (if (>= level last-level)
  13578. (push (cons head m) (aref subs level))
  13579. (push (cons head (aref subs (1+ level))) (aref subs level))
  13580. (loop for i from (1+ level) to n do (aset subs i nil)))
  13581. (setq last-level level)))))
  13582. (aref subs 1)))
  13583. (eval-after-load "imenu"
  13584. '(progn
  13585. (add-hook 'imenu-after-jump-hook
  13586. (lambda ()
  13587. (if (eq major-mode 'org-mode)
  13588. (org-show-context 'org-goto))))))
  13589. (defun org-link-display-format (link)
  13590. "Replace a link with either the description, or the link target
  13591. if no description is present"
  13592. (save-match-data
  13593. (if (string-match org-bracket-link-analytic-regexp link)
  13594. (replace-match (or (match-string 5 link)
  13595. (concat (match-string 1 link)
  13596. (match-string 3 link)))
  13597. nil nil link)
  13598. link)))
  13599. ;; Speedbar support
  13600. (defvar org-speedbar-restriction-lock-overlay (org-make-overlay 1 1)
  13601. "Overlay marking the agenda restriction line in speedbar.")
  13602. (org-overlay-put org-speedbar-restriction-lock-overlay
  13603. 'face 'org-agenda-restriction-lock)
  13604. (org-overlay-put org-speedbar-restriction-lock-overlay
  13605. 'help-echo "Agendas are currently limited to this item.")
  13606. (org-detach-overlay org-speedbar-restriction-lock-overlay)
  13607. (defun org-speedbar-set-agenda-restriction ()
  13608. "Restrict future agenda commands to the location at point in speedbar.
  13609. To get rid of the restriction, use \\[org-agenda-remove-restriction-lock]."
  13610. (interactive)
  13611. (require 'org-agenda)
  13612. (let (p m tp np dir txt w)
  13613. (cond
  13614. ((setq p (text-property-any (point-at-bol) (point-at-eol)
  13615. 'org-imenu t))
  13616. (setq m (get-text-property p 'org-imenu-marker))
  13617. (save-excursion
  13618. (save-restriction
  13619. (set-buffer (marker-buffer m))
  13620. (goto-char m)
  13621. (org-agenda-set-restriction-lock 'subtree))))
  13622. ((setq p (text-property-any (point-at-bol) (point-at-eol)
  13623. 'speedbar-function 'speedbar-find-file))
  13624. (setq tp (previous-single-property-change
  13625. (1+ p) 'speedbar-function)
  13626. np (next-single-property-change
  13627. tp 'speedbar-function)
  13628. dir (speedbar-line-directory)
  13629. txt (buffer-substring-no-properties (or tp (point-min))
  13630. (or np (point-max))))
  13631. (save-excursion
  13632. (save-restriction
  13633. (set-buffer (find-file-noselect
  13634. (let ((default-directory dir))
  13635. (expand-file-name txt))))
  13636. (unless (org-mode-p)
  13637. (error "Cannot restrict to non-Org-mode file"))
  13638. (org-agenda-set-restriction-lock 'file))))
  13639. (t (error "Don't know how to restrict Org-mode's agenda")))
  13640. (org-move-overlay org-speedbar-restriction-lock-overlay
  13641. (point-at-bol) (point-at-eol))
  13642. (setq current-prefix-arg nil)
  13643. (org-agenda-maybe-redo)))
  13644. (eval-after-load "speedbar"
  13645. '(progn
  13646. (speedbar-add-supported-extension ".org")
  13647. (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
  13648. (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
  13649. (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
  13650. (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
  13651. (add-hook 'speedbar-visiting-tag-hook
  13652. (lambda () (and (org-mode-p) (org-show-context 'org-goto))))))
  13653. ;;; Fixes and Hacks for problems with other packages
  13654. ;; Make flyspell not check words in links, to not mess up our keymap
  13655. (defun org-mode-flyspell-verify ()
  13656. "Don't let flyspell put overlays at active buttons."
  13657. (not (get-text-property (point) 'keymap)))
  13658. ;; Make `bookmark-jump' show the jump location if it was hidden.
  13659. (eval-after-load "bookmark"
  13660. '(if (boundp 'bookmark-after-jump-hook)
  13661. ;; We can use the hook
  13662. (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
  13663. ;; Hook not available, use advice
  13664. (defadvice bookmark-jump (after org-make-visible activate)
  13665. "Make the position visible."
  13666. (org-bookmark-jump-unhide))))
  13667. ;; Make sure saveplace show the location if it was hidden
  13668. (eval-after-load "saveplace"
  13669. '(defadvice save-place-find-file-hook (after org-make-visible activate)
  13670. "Make the position visible."
  13671. (org-bookmark-jump-unhide)))
  13672. (defun org-bookmark-jump-unhide ()
  13673. "Unhide the current position, to show the bookmark location."
  13674. (and (org-mode-p)
  13675. (or (org-invisible-p)
  13676. (save-excursion (goto-char (max (point-min) (1- (point))))
  13677. (org-invisible-p)))
  13678. (org-show-context 'bookmark-jump)))
  13679. ;; Make session.el ignore our circular variable
  13680. (eval-after-load "session"
  13681. '(add-to-list 'session-globals-exclude 'org-mark-ring))
  13682. ;;;; Experimental code
  13683. (defun org-closed-in-range ()
  13684. "Sparse tree of items closed in a certain time range.
  13685. Still experimental, may disappear in the future."
  13686. (interactive)
  13687. ;; Get the time interval from the user.
  13688. (let* ((time1 (time-to-seconds
  13689. (org-read-date nil 'to-time nil "Starting date: ")))
  13690. (time2 (time-to-seconds
  13691. (org-read-date nil 'to-time nil "End date:")))
  13692. ;; callback function
  13693. (callback (lambda ()
  13694. (let ((time
  13695. (time-to-seconds
  13696. (apply 'encode-time
  13697. (org-parse-time-string
  13698. (match-string 1))))))
  13699. ;; check if time in interval
  13700. (and (>= time time1) (<= time time2))))))
  13701. ;; make tree, check each match with the callback
  13702. (org-occur "CLOSED: +\\[\\(.*?\\)\\]" nil callback)))
  13703. ;;;; Finish up
  13704. (provide 'org)
  13705. (run-hooks 'org-load-hook)
  13706. ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
  13707. ;;; org.el ends here