12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589125901259112592125931259412595125961259712598125991260012601126021260312604126051260612607126081260912610126111261212613126141261512616126171261812619126201262112622126231262412625126261262712628126291263012631126321263312634126351263612637126381263912640126411264212643126441264512646126471264812649126501265112652126531265412655126561265712658126591266012661126621266312664126651266612667126681266912670126711267212673126741267512676126771267812679126801268112682126831268412685126861268712688126891269012691126921269312694126951269612697126981269912700127011270212703127041270512706127071270812709127101271112712127131271412715127161271712718127191272012721127221272312724127251272612727127281272912730127311273212733127341273512736127371273812739127401274112742127431274412745127461274712748127491275012751127521275312754127551275612757127581275912760127611276212763127641276512766127671276812769127701277112772127731277412775127761277712778127791278012781127821278312784127851278612787127881278912790127911279212793127941279512796127971279812799128001280112802128031280412805128061280712808128091281012811128121281312814128151281612817128181281912820128211282212823128241282512826128271282812829128301283112832128331283412835128361283712838128391284012841128421284312844128451284612847128481284912850128511285212853128541285512856128571285812859128601286112862128631286412865128661286712868128691287012871128721287312874128751287612877128781287912880128811288212883128841288512886128871288812889128901289112892128931289412895128961289712898128991290012901129021290312904129051290612907129081290912910129111291212913129141291512916129171291812919129201292112922129231292412925129261292712928129291293012931129321293312934129351293612937129381293912940129411294212943129441294512946129471294812949129501295112952129531295412955129561295712958129591296012961129621296312964129651296612967129681296912970129711297212973129741297512976129771297812979129801298112982129831298412985129861298712988129891299012991129921299312994129951299612997129981299913000130011300213003130041300513006130071300813009130101301113012130131301413015130161301713018130191302013021130221302313024130251302613027130281302913030130311303213033130341303513036130371303813039130401304113042130431304413045130461304713048130491305013051130521305313054130551305613057130581305913060130611306213063130641306513066130671306813069130701307113072130731307413075130761307713078130791308013081130821308313084130851308613087130881308913090 |
- ;;; org.el --- Outline-based notes management and organize
- ;; Carstens outline-mode for keeping track of everything.
- ;; Copyright (C) 2004, 2005, 2006 Free Software Foundation, Inc.
- ;;
- ;; Author: Carsten Dominik <dominik at science dot uva dot nl>
- ;; Keywords: outlines, hypermedia, calendar, wp
- ;; Homepage: http://www.astro.uva.nl/~dominik/Tools/org/
- ;; Version: 4.13
- ;;
- ;; This file is part of GNU Emacs.
- ;;
- ;; GNU Emacs is free software; you can redistribute it and/or modify
- ;; it under the terms of the GNU General Public License as published by
- ;; the Free Software Foundation; either version 2, or (at your option)
- ;; any later version.
- ;; GNU Emacs is distributed in the hope that it will be useful,
- ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
- ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- ;; GNU General Public License for more details.
- ;; You should have received a copy of the GNU General Public License
- ;; along with GNU Emacs; see the file COPYING. If not, write to the
- ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
- ;; Boston, MA 02110-1301, USA.
- ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
- ;;
- ;;; Commentary:
- ;;
- ;; Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
- ;; project planning with a fast and effective plain-text system.
- ;;
- ;; Org-mode develops organizational tasks around a NOTES file that contains
- ;; information about projects as plain text. Org-mode is implemented on top
- ;; of outline-mode - ideal to keep the content of large files well structured.
- ;; It supports ToDo items, deadlines and time stamps, which can be extracted
- ;; to create a daily/weekly agenda that also integrates the diary of the Emacs
- ;; calendar. Tables are easily created with a built-in table editor. Plain
- ;; text URL-like links connect to websites, emails (VM, RMAIL, WANDERLUST),
- ;; Usenet messages (Gnus), BBDB entries, and any files related to the
- ;; projects. For printing and sharing of notes, an Org-mode file (or a part
- ;; of it) can be exported as a structured ASCII file, or as HTML.
- ;;
- ;; Installation
- ;; ------------
- ;; If Org-mode is part of the Emacs distribution or an XEmacs package, you
- ;; only need to copy the following lines to your .emacs file. The last two
- ;; lines define *global* keys for the commands `org-store-link' and
- ;; `org-agenda' - please choose suitable keys yourself.
- ;;
- ;; (add-to-list 'auto-mode-alist '("\\.org$" . org-mode))
- ;; (define-key global-map "\C-cl" 'org-store-link)
- ;; (define-key global-map "\C-ca" 'org-agenda)
- ;;
- ;; If you have downloaded Org-mode from the Web, you must byte-compile
- ;; org.el and put it on your load path. In addition to the Emacs Lisp
- ;; lines above, you also need to add the following lines to .emacs:
- ;;
- ;; (autoload 'org-mode "org" "Org mode" t)
- ;; (autoload 'org-diary "org" "Diary entries from Org mode")
- ;; (autoload 'org-agenda "org" "Multi-file agenda from Org mode" t)
- ;; (autoload 'org-store-link "org" "Store a link to the current location" t)
- ;; (autoload 'orgtbl-mode "org" "Org tables as a minor mode" t)
- ;; (autoload 'turn-on-orgtbl "org" "Org tables as a minor mode")
- ;;
- ;; This setup will put all files with extension ".org" into Org-mode. As
- ;; an alternative, make the first line of a file look like this:
- ;;
- ;; MY PROJECTS -*- mode: org; -*-
- ;;
- ;; which will select Org-mode for this buffer no matter what the file's
- ;; name is.
- ;;
- ;; Documentation
- ;; -------------
- ;; The documentation of Org-mode can be found in the TeXInfo file. The
- ;; distribution also contains a PDF version of it. At the homepage of
- ;; Org-mode, you can read the same text online as HTML. There is also an
- ;; excellent reference card made by Philip Rooke. This card can be found
- ;; in the etc/ directory of Emacs 22.
- ;;
- ;; Changes since version 4.00:
- ;; ---------------------------
- ;; Version 4.13
- ;; - The list of agenda files can be maintainted in an external file.
- ;; - Bug fixes.
- ;;
- ;; Version 4.12
- ;; - Templates for remember buffer. Note that the remember setup changes.
- ;; To set up templates, see `org-remember-templates'.
- ;; - The time in new time stamps can be rounded, see new option
- ;; `org-time-stamp-rounding-minutes'.
- ;; - Bug fixes (there are *always* more bugs).
- ;;
- ;; Version 4.10
- ;; - Bug fixes.
- ;;
- ;; Version 4.09
- ;; - Bug fixes.
- ;; - Small improvements to font-lock support.
- ;; - MHE support finalized.
- ;;
- ;; Version 4.08
- ;; - Bug fixes.
- ;; - Improved MHE support
- ;;
- ;; Version 4.07
- ;; - Bug fixes.
- ;; - Leading stars in headlines can be hidden, so make the outline look
- ;; cleaner.
- ;; - Mouse-1 can be used to follow links.
- ;;
- ;; Version 4.06
- ;; - HTML exporter treats targeted internal links.
- ;; - Bug fixes.
- ;;
- ;; Version 4.05
- ;; - Changes to internal link system (thanks to David Wainberg for ideas).
- ;; - in-file links: [[Search String]] instead of <file:::Search String>
- ;; - automatic links to "radio targets".
- ;; - CamelCase not longer active by default, configure org-activate-camels
- ;; if you want to turn it back on.
- ;; - After following a link, `C-c &' jumps back to it.
- ;; - MH-E link support (thanks to Thomas Baumann).
- ;; - Special table lines are no longer exported.
- ;; - Bug fixes and minor improvements.
- ;;
- ;; Version 4.04
- ;; - Cleanup tags display in agenda.
- ;; - Bug fixes.
- ;;
- ;; Version 4.03
- ;; - Table alignment fixed for use with wide characters.
- ;; - `C-c -' leaves cursor in current table line.
- ;; - The current TAG can be incorporated into the agenda prefix.
- ;; See option `org-agenda-prefix-format' for details.
- ;;
- ;; Version 4.02
- ;; - Minor bug fixes and improvements around tag searches.
- ;; - XEmacs compatibility fixes.
- ;;
- ;; Version 4.01
- ;; - Tags can also be set remotely from agenda buffer.
- ;; - Boolean logic for tag searches.
- ;; - Additional agenda commands can be configured through the variable
- ;; `org-agenda-custom-commands'.
- ;; - Minor bug fixes.
- ;;
- ;;; Code:
- (eval-when-compile (require 'cl) (require 'calendar))
- (require 'outline)
- (require 'time-date)
- (require 'easymenu)
- (defvar calc-embedded-close-formula) ; defined by the calc package
- (defvar calc-embedded-open-formula) ; defined by the calc package
- (defvar font-lock-unfontify-region-function) ; defined by font-lock.el
- ;;; Customization variables
- (defvar org-version "4.13"
- "The version number of the file org.el.")
- (defun org-version ()
- (interactive)
- (message "Org-mode version %s" org-version))
- ;; The following constant is for compatibility with different versions
- ;; of outline.el.
- (defconst org-noutline-p (featurep 'noutline)
- "Are we using the new outline mode?")
- (defgroup org nil
- "Outline-based notes management and organizer."
- :tag "Org"
- :group 'outlines
- :group 'hypermedia
- :group 'calendar)
- (defgroup org-startup nil
- "Options concerning startup of Org-mode."
- :tag "Org Startup"
- :group 'org)
- (defcustom org-CUA-compatible nil
- "Non-nil means use alternative key bindings for S-<cursor movement>.
- Org-mode used S-<cursor movement> for changing timestamps and priorities.
- S-<cursor movement> is also used for example by `CUA-mode' to select text.
- If you want to use Org-mode together with `CUA-mode', Org-mode needs to use
- alternative bindings. Setting this variable to t will replace the following
- keys both in Org-mode and in the Org-agenda buffer.
- S-RET -> C-S-RET
- S-up -> M-p
- S-down -> M-n
- S-left -> M--
- S-right -> M-+
- If you do not like the alternative keys, take a look at the variable
- `org-disputed-keys'.
- This option is only relevant at load-time of Org-mode. Changing it requires
- a restart of Emacs to become effective."
- :group 'org-startup
- :type 'boolean)
- (defvar org-disputed-keys
- '((S-up [(shift up)] [(meta ?p)])
- (S-down [(shift down)] [(meta ?n)])
- (S-left [(shift left)] [(meta ?-)])
- (S-right [(shift right)] [(meta ?+)])
- (S-return [(shift return)] [(control shift return)]))
- "Keys for which Org-mode and other modes compete.
- This is an alist, cars are symbols for lookup, 1st element is the default key,
- second element will be used when `org-CUA-compatible' is t.")
- (defun org-key (key)
- "Select a key according to `org-CUA-compatible'."
- (nth (if org-CUA-compatible 2 1)
- (or (assq key org-disputed-keys)
- (error "Invalid Key %s in `org-key'" key))))
- (defcustom org-startup-folded t
- "Non-nil means, entering Org-mode will switch to OVERVIEW.
- This can also be configured on a per-file basis by adding one of
- the following lines anywhere in the buffer:
- #+STARTUP: fold
- #+STARTUP: nofold
- #+STARTUP: content"
- :group 'org-startup
- :type '(choice
- (const :tag "nofold: show all" nil)
- (const :tag "fold: overview" t)
- (const :tag "content: all headlines" content)))
- (defcustom org-startup-truncated t
- "Non-nil means, entering Org-mode will set `truncate-lines'.
- This is useful since some lines containing links can be very long and
- uninteresting. Also tables look terrible when wrapped."
- :group 'org-startup
- :type 'boolean)
- (defcustom org-startup-with-deadline-check nil
- "Non-nil means, entering Org-mode will run the deadline check.
- This means, if you start editing an org file, you will get an
- immediate reminder of any due deadlines.
- This can also be configured on a per-file basis by adding one of
- the following lines anywhere in the buffer:
- #+STARTUP: dlcheck
- #+STARTUP: nodlcheck"
- :group 'org-startup
- :type 'boolean)
- (defcustom org-insert-mode-line-in-empty-file nil
- "Non-nil means insert the first line setting Org-mode in empty files.
- When the function `org-mode' is called interactively in an empty file, this
- normally means that the file name does not automatically trigger Org-mode.
- To ensure that the file will always be in Org-mode in the future, a
- line enforcing Org-mode will be inserted into the buffer, if this option
- has been set."
- :group 'org-startup
- :type 'boolean)
- (defgroup org-keywords nil
- "Options concerning TODO items in Org-mode."
- :tag "Org Keywords"
- :group 'org)
- (defcustom org-todo-keywords '("TODO" "DONE")
- "List of TODO entry keywords.
- \\<org-mode-map>By default, this is '(\"TODO\" \"DONE\"). The last entry in the list is
- considered to mean that the entry is \"done\". All the other mean that
- action is required, and will make the entry show up in todo lists, diaries
- etc.
- The command \\[org-todo] cycles an entry through these states, and an
- additional state where no keyword is present. For details about this
- cycling, see also the variable `org-todo-interpretation'
- Changes become only effective after restarting Emacs."
- :group 'org-keywords
- :type '(repeat (string :tag "Keyword")))
- (defcustom org-todo-interpretation 'sequence
- "Controls how TODO keywords are interpreted.
- \\<org-mode-map>Possible values are `sequence' and `type'.
- This variable is only relevant if `org-todo-keywords' contains more than two
- states. There are two ways how these keywords can be used:
- - As a sequence in the process of working on a TODO item, for example
- (setq org-todo-keywords '(\"TODO\" \"STARTED\" \"VERIFY\" \"DONE\")
- org-todo-interpretation 'sequence)
- - As different types of TODO items, for example
- (setq org-todo-keywords '(\"URGENT\" \"RELAXED\" \"REMIND\" \"FOR_TOM\" \"DONE\")
- org-todo-interpretation 'type)
- When the states are interpreted as a sequence, \\[org-todo] always cycles
- to the next state, in order to walk through all different states. So with
- \\[org-todo], you turn an empty entry into the state TODO. When you started
- working on the item, you use \\[org-todo] again to switch it to \"STARTED\",
- later to VERIFY and finally to DONE.
- When the states are interpreted as types, \\[org-todo] still cycles through
- when it is called several times in direct succession, in order to initially
- select the type. However, if not called immediately after a previous
- \\[org-todo], it switches from each type directly to DONE. So with the
- above example, you could use `\\[org-todo] \\[org-todo]' to label an entry
- RELAXED. If you later return to this entry and press \\[org-todo] again,
- RELAXED will not be changed REMIND, but directly to DONE.
- You can create a large number of types. To initially select a
- type, it is then best to use \\[universal-argument] \\[org-todo] in order to specify the
- type with completion. Of course, you can also type the keyword
- directly into the buffer. M-TAB completes TODO keywords at the
- beginning of a headline."
- :group 'org-keywords
- :type '(choice (const sequence)
- (const type)))
- (defcustom org-default-priority ?B
- "The default priority of TODO items.
- This is the priority an item get if no explicit priority is given."
- :group 'org-keywords
- :type 'character)
- (defcustom org-lowest-priority ?C
- "The lowest priority of TODO items. A character like ?A, ?B etc."
- :group 'org-keywords
- :type 'character)
- (defcustom org-deadline-string "DEADLINE:"
- "String to mark deadline entries.
- A deadline is this string, followed by a time stamp. Should be a word,
- terminated by a colon. You can insert a schedule keyword and
- a timestamp with \\[org-deadline].
- Changes become only effective after restarting Emacs."
- :group 'org-keywords
- :type 'string)
- (defcustom org-scheduled-string "SCHEDULED:"
- "String to mark scheduled TODO entries.
- A schedule is this string, followed by a time stamp. Should be a word,
- terminated by a colon. You can insert a schedule keyword and
- a timestamp with \\[org-schedule].
- Changes become only effective after restarting Emacs."
- :group 'org-keywords
- :type 'string)
- (defcustom org-closed-string "CLOSED:"
- "String used as the prefix for timestamps logging closing a TODO entry."
- :group 'org-keywords
- :type 'string)
- (defcustom org-comment-string "COMMENT"
- "Entries starting with this keyword will never be exported.
- An entry can be toggled between COMMENT and normal with
- \\[org-toggle-comment].
- Changes become only effective after restarting Emacs."
- :group 'org-keywords
- :type 'string)
- (defcustom org-quote-string "QUOTE"
- "Entries starting with this keyword will be exported in fixed-width font.
- Quoting applies only to the text in the entry following the headline, and does
- not extend beyond the next headline, even if that is lower level.
- An entry can be toggled between QUOTE and normal with
- \\[org-toggle-fixed-width-section]."
- :group 'org-keywords
- :type 'string)
- (defcustom org-after-todo-state-change-hook nil
- "Hook which is run after the state of a TODO item was changed.
- The new state (a string with a TODO keyword, or nil) is available in the
- Lisp variable `state'."
- :group 'org-keywords
- :type 'hook)
- ;; Variables for pre-computed regular expressions, all buffer local
- (defvar org-todo-kwd-priority-p nil
- "Do TODO items have priorities?")
- (make-variable-buffer-local 'org-todo-kwd-priority-p)
- (defvar org-todo-kwd-max-priority nil
- "Maximum priority of TODO items.")
- (make-variable-buffer-local 'org-todo-kwd-max-priority)
- (defvar org-ds-keyword-length 12
- "Maximum length of the Deadline and SCHEDULED keywords.")
- (make-variable-buffer-local 'org-ds-keyword-length)
- (defvar org-done-string nil
- "The last string in `org-todo-keywords', indicating an item is DONE.")
- (make-variable-buffer-local 'org-done-string)
- (defvar org-todo-regexp nil
- "Matches any of the TODO state keywords.")
- (make-variable-buffer-local 'org-todo-regexp)
- (defvar org-not-done-regexp nil
- "Matches any of the TODO state keywords except the last one.")
- (make-variable-buffer-local 'org-not-done-regexp)
- (defvar org-todo-line-regexp nil
- "Matches a headline and puts TODO state into group 2 if present.")
- (make-variable-buffer-local 'org-todo-line-regexp)
- (defvar org-nl-done-regexp nil
- "Matches newline followed by a headline with the DONE keyword.")
- (make-variable-buffer-local 'org-nl-done-regexp)
- (defvar org-looking-at-done-regexp nil
- "Matches the DONE keyword a point.")
- (make-variable-buffer-local 'org-looking-at-done-regexp)
- (defvar org-deadline-regexp nil
- "Matches the DEADLINE keyword.")
- (make-variable-buffer-local 'org-deadline-regexp)
- (defvar org-deadline-time-regexp nil
- "Matches the DEADLINE keyword together with a time stamp.")
- (make-variable-buffer-local 'org-deadline-time-regexp)
- (defvar org-deadline-line-regexp nil
- "Matches the DEADLINE keyword and the rest of the line.")
- (make-variable-buffer-local 'org-deadline-line-regexp)
- (defvar org-scheduled-regexp nil
- "Matches the SCHEDULED keyword.")
- (make-variable-buffer-local 'org-scheduled-regexp)
- (defvar org-scheduled-time-regexp nil
- "Matches the SCHEDULED keyword together with a time stamp.")
- (make-variable-buffer-local 'org-scheduled-time-regexp)
- (defvar org-category nil
- "Variable used by org files to set a category for agenda display.
- Such files should use a file variable to set it, for example
- -*- mode: org; org-category: \"ELisp\"
- or contain a special line
- #+CATEGORY: ELisp
- If the file does not specify a category, then file's base name
- is used instead.")
- (make-variable-buffer-local 'org-category)
- (defgroup org-time nil
- "Options concerning time stamps and deadlines in Org-mode."
- :tag "Org Time"
- :group 'org)
- (defconst org-time-stamp-formats '("<%Y-%m-%d %a>" . "<%Y-%m-%d %a %H:%M>")
- "Formats for `format-time-string' which are used for time stamps.
- It is not recommended to change this constant.")
- (defcustom org-time-stamp-rounding-minutes 0
- "Number of minutes to round time stamps to upon insertion.
- When zero, insert the time unmodified. Useful rounding numbers
- should be factors of 60, so for example 5, 10, 15.
- When this is not zero, you can still force an exact time-stamp by using
- a double prefix argument to a time-stamp command like `C-c .' or `C-c !'."
- :group 'org-time
- :type 'integer)
- (defcustom org-deadline-warning-days 30
- "No. of days before expiration during which a deadline becomes active.
- This variable governs the display in the org file."
- :group 'org-time
- :type 'number)
- (defcustom org-popup-calendar-for-date-prompt t
- "Non-nil means, pop up a calendar when prompting for a date.
- In the calendar, the date can be selected with mouse-1. However, the
- minibuffer will also be active, and you can simply enter the date as well.
- When nil, only the minibuffer will be available."
- :group 'org-time
- :type 'boolean)
- (defcustom org-calendar-follow-timestamp-change t
- "Non-nil means, make the calendar window follow timestamp changes.
- When a timestamp is modified and the calendar window is visible, it will be
- moved to the new date."
- :group 'org-time
- :type 'boolean)
- (defcustom org-log-done nil
- "When set, insert a (non-active) time stamp when TODO entry is marked DONE.
- When the state of an entry is changed from nothing to TODO, remove a previous
- closing date."
- :group 'org-time
- :type 'boolean)
- (defgroup org-agenda nil
- "Options concerning agenda display Org-mode."
- :tag "Org Agenda"
- :group 'org)
- (defcustom org-agenda-files nil
- "The files to be used for agenda display.
- Entries may be added to this list with \\[org-agenda-file-to-front] and removed with
- \\[org-remove-file]. You can also use customize to edit the list.
- If the value of the variable is not a list but a single file name, then
- the list of agenda files is actually stored in that file, one agenda file
- per line"
- :group 'org-agenda
- :type '(choice
- (repeat :tag "List of files" file)
- (file :tag "Store list in a file\n" :value "~/.agenda_files")))
- (defcustom org-agenda-custom-commands '(("w" todo "WAITING"))
- "Custom commands for the agenda.
- These commands will be offered on the splash screen displayed by the
- agenda dispatcher \\[org-agenda]. Each entry is a list of 3 items:
- key The key (a single char as a string) to be associated with the command.
- type The command type, any of the following symbols:
- todo Entries with a specific TODO keyword, in all agenda files.
- tags Tags match in all agenda files.
- todo-tree Sparse tree of specific TODO keyword in *current* file.
- tags-tree Sparse tree with all tags matches in *current* file.
- occur-tree Occur sparse tree for current file.
- match What to search for:
- - a single keyword for TODO keyword searches
- - a tags match expression for tags searches
- - a regular expression for occur searches"
- :group 'org-agenda
- :type '(repeat
- (list (string :tag "Key")
- (choice :tag "Type"
- (const :tag "Tags search in all agenda files" tags)
- (const :tag "TODO keyword search in all agenda files" todo)
- (const :tag "Tags sparse tree in current buffer" tags-tree)
- (const :tag "TODO keyword tree in current buffer" todo-tree)
- (const :tag "Occur tree in current buffer" occur-tree))
- (string :tag "Match"))))
- (defcustom org-select-timeline-window t
- "Non-nil means, after creating a timeline, move cursor into Timeline window.
- When nil, cursor will remain in the current window."
- :group 'org-agenda
- :type 'boolean)
- (defcustom org-select-agenda-window t
- "Non-nil means, after creating an agenda, move cursor into Agenda window.
- When nil, cursor will remain in the current window."
- :group 'org-agenda
- :type 'boolean)
- (defcustom org-fit-agenda-window t
- "Non-nil means, change window size of agenda to fit content."
- :group 'org-agenda
- :type 'boolean)
- (defcustom org-agenda-show-all-dates t
- "Non-nil means, `org-agenda' shows every day in the selected range.
- When nil, only the days which actually have entries are shown."
- :group 'org-agenda
- :type 'boolean)
- ;; FIXME: First day of month works only for current month because it would
- ;; require a variable ndays treatment.
- (defcustom org-agenda-start-on-weekday 1
- "Non-nil means, start the overview always on the specified weekday.
- 0 Denotes Sunday, 1 denotes Monday etc.
- When nil, always start on the current day."
- :group 'org-agenda
- :type '(choice (const :tag "Today" nil)
- (const :tag "First day of month" t)
- (number :tag "Weekday No.")))
- (defcustom org-agenda-ndays 7
- "Number of days to include in overview display."
- :group 'org-agenda
- :type 'number)
- (defcustom org-agenda-include-all-todo t
- "Non-nil means, the agenda will always contain all TODO entries.
- When nil, date-less entries will only be shown if `org-agenda' is called
- with a prefix argument.
- When non-nil, the TODO entries will be listed at the top of the agenda, before
- the entries for specific days."
- :group 'org-agenda
- :type 'boolean)
- (defcustom org-agenda-include-diary nil
- "If non-nil, include in the agenda entries from the Emacs Calendar's diary."
- :group 'org-agenda
- :type 'boolean)
- (defcustom org-calendar-to-agenda-key [?c]
- "The key to be installed in `calendar-mode-map' for switching to the agenda.
- The command `org-calendar-goto-agenda' will be bound to this key. The
- default is the character `c' because then `c' can be used to switch back and
- forth between agenda and calendar."
- :group 'org-agenda
- :type 'sexp)
- (defcustom org-agenda-sorting-strategy '(time-up category-keep priority-down)
- "Sorting structure for the agenda items of a single day.
- This is a list of symbols which will be used in sequence to determine
- if an entry should be listed before another entry. The following
- symbols are recognized:
- time-up Put entries with time-of-day indications first, early first
- time-down Put entries with time-of-day indications first, late first
- category-keep Keep the default order of categories, corresponding to the
- sequence in `org-agenda-files'.
- category-up Sort alphabetically by category, A-Z.
- category-down Sort alphabetically by category, Z-A.
- priority-up Sort numerically by priority, high priority last.
- priority-down Sort numerically by priority, high priority first.
- The different possibilities will be tried in sequence, and testing stops
- if one comparison returns a \"not-equal\". For example, the default
- '(time-up category-keep priority-down)
- means: Pull out all entries having a specified time of day and sort them,
- in order to make a time schedule for the current day the first thing in the
- agenda listing for the day. Of the entries without a time indication, keep
- the grouped in categories, don't sort the categories, but keep them in
- the sequence given in `org-agenda-files'. Within each category sort by
- priority.
- Leaving out `category-keep' would mean that items will be sorted across
- categories by priority."
- :group 'org-agenda
- :type '(repeat
- (choice
- (const time-up)
- (const time-down)
- (const category-keep)
- (const category-up)
- (const category-down)
- (const priority-up)
- (const priority-down))))
- (defcustom org-agenda-prefix-format " %-12:c%?-12t% s"
- "Format specification for the prefix of items in the agenda buffer.
- This format works similar to a printf format, with the following meaning:
- %c the category of the item, \"Diary\" for entries from the diary, or
- as given by the CATEGORY keyword or derived from the file name.
- %T the first tag of the item.
- %t the time-of-day specification if one applies to the entry, in the
- format HH:MM
- %s Scheduling/Deadline information, a short string
- All specifiers work basically like the standard `%s' of printf, but may
- contain two additional characters: A question mark just after the `%' and
- a whitespace/punctuation character just before the final letter.
- If the first character after `%' is a question mark, the entire field
- will only be included if the corresponding value applies to the
- current entry. This is useful for fields which should have fixed
- width when present, but zero width when absent. For example,
- \"%?-12t\" will result in a 12 character time field if a time of the
- day is specified, but will completely disappear in entries which do
- not contain a time.
- If there is punctuation or whitespace character just before the final
- format letter, this character will be appended to the field value if
- the value is not empty. For example, the format \"%-12:c\" leads to
- \"Diary: \" if the category is \"Diary\". If the category were be
- empty, no additional colon would be interted.
- The default value of this option is \" %-12:c%?-12t% s\", meaning:
- - Indent the line with two space characters
- - Give the category in a 12 chars wide field, padded with whitespace on
- the right (because of `-'). Append a colon if there is a category
- (because of `:').
- - If there is a time-of-day, put it into a 12 chars wide field. If no
- time, don't put in an empty field, just skip it (because of '?').
- - Finally, put the scheduling information and append a whitespace.
- As another example, if you don't want the time-of-day of entries in
- the prefix, you could use:
- (setq org-agenda-prefix-format \" %-11:c% s\")
- See also the variables `org-agenda-remove-times-when-in-prefix' and
- `org-agenda-remove-tags-when-in-prefix'."
- :type 'string
- :group 'org-agenda)
- (defcustom org-timeline-prefix-format " % s"
- "Like `org-agenda-prefix-format', but for the timeline of a single file."
- :type 'string
- :group 'org-agenda)
- (defvar org-prefix-format-compiled nil
- "The compiled version of the most recently used prefix format.
- Depending on which command was used last, this may be the compiled version
- of `org-agenda-prefix-format' or `org-timeline-prefix-format'.")
- (defcustom org-agenda-use-time-grid t
- "Non-nil means, show a time grid in the agenda schedule.
- A time grid is a set of lines for specific times (like every two hours between
- 8:00 and 20:00). The items scheduled for a day at specific times are
- sorted in between these lines.
- For details about when the grid will be shown, and what it will look like, see
- the variable `org-agenda-time-grid'."
- :group 'org-agenda
- :type 'boolean)
- (defcustom org-agenda-time-grid
- '((daily today require-timed)
- "----------------"
- (800 1000 1200 1400 1600 1800 2000))
- "The settings for time grid for agenda display.
- This is a list of three items. The first item is again a list. It contains
- symbols specifying conditions when the grid should be displayed:
- daily if the agenda shows a single day
- weekly if the agenda shows an entire week
- today show grid on current date, independent of daily/weekly display
- require-timed show grid only if at least on item has a time specification
- The second item is a string which will be places behing the grid time.
- The third item is a list of integers, indicating the times that should have
- a grid line."
- :group 'org-agenda
- :type
- '(list
- (set :greedy t :tag "Grid Display Options"
- (const :tag "Show grid in single day agenda display" daily)
- (const :tag "Show grid in weekly agenda display" weekly)
- (const :tag "Always show grid for today" today)
- (const :tag "Show grid only if any timed entries are present"
- require-timed)
- (const :tag "Skip grid times already present in an entry"
- remove-match))
- (string :tag "Grid String")
- (repeat :tag "Grid Times" (integer :tag "Time"))))
- (defcustom org-agenda-remove-times-when-in-prefix t
- "Non-nil means, remove duplicate time specifications in agenda items.
- When the format `org-agenda-prefix-format' contains a `%t' specifier, a
- time-of-day specification in a headline or diary entry is extracted and
- placed into the prefix. If this option is non-nil, the original specification
- \(a timestamp or -range, or just a plain time(range) specification like
- 11:30-4pm) will be removed for agenda display. This makes the agenda less
- cluttered.
- The option can be t or nil. It may also be the symbol `beg', indicating
- that the time should only be removed what it is located at the beginning of
- the headline/diary entry."
- :group 'org-agenda
- :type '(choice
- (const :tag "Always" t)
- (const :tag "Never" nil)
- (const :tag "When at beginning of entry" beg)))
- (defcustom org-sort-agenda-notime-is-late t
- "Non-nil means, items without time are considered late.
- This is only relevant for sorting. When t, items which have no explicit
- time like 15:30 will be considered as 24:01, i.e. later than any items which
- do have a time. When nil, the default time is before 0:00. You can use this
- option to decide if the schedule for today should come before or after timeless
- agenda entries."
- :group 'org-agenda
- :type 'boolean)
- (defcustom org-agenda-remove-tags-when-in-prefix nil
- "Non-nil means, the tags from copy of headline in agenda.
- When this is the symbol `prefix', only remove tags when
- `org-agenda-prefix-format' contains a `%T' specifier."
- :group 'org-agenda
- :type '(choice
- (const :tag "Always" t)
- (const :tag "Never" nil)
- (const :tag "When prefix format contains %T" prefix)))
- (defgroup org-structure nil
- "Options concerning structure editing in Org-mode."
- :tag "Org Structure"
- :group 'org)
- (defcustom org-cycle-include-plain-lists nil
- "Non-nil means, include plain lists into visibility cycling.
- This means that during cycling, plain list items will *temporarily* be
- interpreted as outline headlines with a level given by 1000+i where i is the
- indentation of the bullet. In all other operations, plain list items are
- not seen as headlines. For example, you cannot assign a TODO keyword to
- such an item."
- :group 'org-structure
- :type 'boolean)
- (defcustom org-cycle-emulate-tab t
- "Where should `org-cycle' emulate TAB.
- nil Never
- white Only in completely white lines
- t Everywhere except in headlines"
- :group 'org-structure
- :type '(choice (const :tag "Never" nil)
- (const :tag "Only in completely white lines" white)
- (const :tag "Everywhere except in headlines" t)
- ))
- (defcustom org-cycle-hook '(org-optimize-window-after-visibility-change)
- "Hook that is run after `org-cycle' has changed the buffer visibility.
- The function(s) in this hook must accept a single argument which indicates
- the new state that was set by the most recent `org-cycle' command. The
- argument is a symbol. After a global state change, it can have the values
- `overview', `content', or `all'. After a local state change, it can have
- the values `folded', `children', or `subtree'."
- :group 'org-structure
- :type 'hook)
- (defcustom org-highlight-sparse-tree-matches t
- "Non-nil means, highlight all matches that define a sparse tree.
- The highlights will automatically disappear the next time the buffer is
- changed by an edit command."
- :group 'org-structure
- :type 'boolean)
- (defcustom org-show-hierarchy-above t
- "Non-nil means, show full hierarchy when showing a spot in the tree.
- Turning this off makes sparse trees more compact, but also less clear."
- :group 'org-structure
- :type 'boolean)
- (defcustom org-show-following-heading t
- "Non-nil means, show heading following match in `org-occur'.
- When doing an `org-occur' it is useful to show the headline which
- follows the match, even if they do not match the regexp. This makes it
- easier to edit directly inside the sparse tree. However, if you use
- `org-occur' mainly as an overview, the following headlines are
- unnecessary clutter."
- :group 'org-structure
- :type 'boolean)
- (defcustom org-occur-hook '(org-first-headline-recenter)
- "Hook that is run after `org-occur' has constructed a sparse tree.
- This can be used to recenter the window to show as much of the structure
- as possible."
- :group 'org-structure
- :type 'hook)
- (defcustom org-odd-levels-only nil
- "Non-nil means, skip even levels and only use odd levels for the outline.
- This has the effect that two stars are being added/taken away in
- promotion/demotion commands. It also influences how levels are
- handled by the exporters.
- Changing it requires restart of `font-lock-mode' to become effective
- for fontification also in regions already fontified."
- :group 'org-structure
- :group 'org-font-lock
- :type 'boolean)
- (defcustom org-adapt-indentation t
- "Non-nil means, adapt indentation when promoting and demoting.
- When this is set and the *entire* text in an entry is indented, the
- indentation is increased by one space in a demotion command, and
- decreased by one in a promotion command. If any line in the entry
- body starts at column 0, indentation is not changed at all."
- :group 'org-structure
- :type 'boolean)
- (defcustom org-plain-list-ordered-item-terminator t
- "The character that makes a line with leading number an ordered list item.
- Valid values are ?. and ?\). To get both terminators, use t. While
- ?. may look nicer, it creates the danger that a line with leading
- number may be incorrectly interpreted as an item. ?\) therefore is
- the safe choice."
- :group 'org-structure
- :type '(choice (const :tag "dot like in \"2.\"" ?.)
- (const :tag "paren like in \"2)\"" ?\))
- (const :tab "both" t)))
- (defcustom org-auto-renumber-ordered-lists t
- "Non-nil means, automatically renumber ordered plain lists.
- Renumbering happens when the sequence have been changed with
- \\[org-shiftmetaup] or \\[org-shiftmetadown]. After other editing commands,
- use \\[org-ctrl-c-ctrl-c] to trigger renumbering."
- :group 'org-structure
- :type 'boolean)
- (defcustom org-enable-fixed-width-editor t
- "Non-nil means, lines starting with \":\" are treated as fixed-width.
- This currently only means, they are never auto-wrapped.
- When nil, such lines will be treated like ordinary lines.
- See also the QUOTE keyword."
- :group 'org-structure
- :type 'boolean)
- (defcustom org-archive-location "%s_archive::"
- "The location where subtrees should be archived.
- This string consists of two parts, separated by a double-colon.
- The first part is a file name - when omitted, archiving happens in the same
- file. %s will be replaced by the current file name (without directory part).
- Archiving to a different file is useful to keep archived entries from
- contributing to the Org-mode Agenda.
- The part after the double colon is a headline. The archived entries will be
- filed under that headline. When omitted, the subtrees are simply filed away
- at the end of the file, as top-level entries.
- Here are a few examples:
- \"%s_archive::\"
- If the current file is Projects.org, archive in file
- Projects.org_archive, as top-level trees. This is the default.
- \"::* Archived Tasks\"
- Archive in the current file, under the top-level headline
- \"* Archived Tasks\".
- \"~/org/archive.org::\"
- Archive in file ~/org/archive.org (absolute path), as top-level trees.
- \"basement::** Finished Tasks\"
- Archive in file ./basement (relative path), as level 3 trees
- below the level 2 heading \"** Finished Tasks\".
- You may set this option on a per-file basis by adding to the buffer a
- line like
- #+ARCHIVE: basement::** Finished Tasks"
- :group 'org-structure
- :type 'string)
- (defcustom org-archive-mark-done t
- "Non-nil means, mark archived entries as DONE."
- :group 'org-structure
- :type 'boolean)
- (defcustom org-archive-stamp-time t
- "Non-nil means, add a time stamp to archived entries.
- The time stamp will be added directly after the TODO state keyword in the
- first line, so it is probably best to use this in combinations with
- `org-archive-mark-done'."
- :group 'org-structure
- :type 'boolean)
- (defgroup org-tags nil
- "Options concerning startup of Org-mode."
- :tag "Org Tags"
- :group 'org)
- (defcustom org-tags-column 48
- "The column to which tags should be indented in a headline.
- If this number is positive, it specifies the column. If it is negative,
- it means that the tags should be flushright to that column. For example,
- -79 works well for a normal 80 character screen."
- :group 'org-tags
- :type 'integer)
- (defcustom org-auto-align-tags t
- "Non-nil means, realign tags after pro/demotion of TODO state change.
- These operations change the length of a headline and therefore shift
- the tags around. With this options turned on, after each such operation
- the tags are again aligned to `org-tags-column'."
- :group 'org-tags
- :type 'boolean)
- (defcustom org-use-tag-inheritance t
- "Non-nil means, tags in levels apply also for sublevels.
- When nil, only the tags directly given in a specific line apply there.
- If you turn off this option, you very likely want to turn on the
- companion option `org-tags-match-list-sublevels'."
- :group 'org-tags
- :type 'boolean)
- (defcustom org-tags-match-list-sublevels nil
- "Non-nil means list also sublevels of headlines matching tag search.
- Because of tag inheritance (see variable `org-use-tag-inheritance'),
- the sublevels of a headline matching a tag search often also match
- the same search. Listing all of them can create very long lists.
- Setting this variable to nil causes subtrees to be skipped.
- This option is off by default, because inheritance in on. If you turn
- inheritance off, you very likely want to turn this option on.
- As a special case, if the tag search is restricted to TODO items, the
- value of this variable is ignored and sublevels are always checked, to
- make sure all corresponding TODO items find their way into the list."
- :group 'org-tags
- :type 'boolean)
- (defvar org-tags-history nil
- "History of minibuffer reads for tags.")
- (defvar org-last-tags-completion-table nil
- "The last used completion table for tags.")
- (defgroup org-link nil
- "Options concerning links in Org-mode."
- :tag "Org Link"
- :group 'org)
- (defcustom org-tab-follows-link nil
- "Non-nil means, on links TAB will follow the link.
- Needs to be set before org.el is loaded."
- :group 'org-link
- :type 'boolean)
- (defcustom org-return-follows-link nil
- "Non-nil means, on links RET will follow the link.
- Needs to be set before org.el is loaded."
- :group 'org-link
- :type 'boolean)
- (defcustom org-mark-ring-length 4
- "Number of different positions to be recorded in the ring
- Changing this requires a restart of Emacs to work correctly."
- :group 'org-link
- :type 'interger)
- (defcustom org-link-format "<%s>"
- "Default format for linkes in the buffer.
- This is a format string for printf, %s will be replaced by the link text.
- If you want to make sure that your link is always properly terminated,
- include angle brackets into this format, like \"<%s>\". Some people also
- recommend an additional URL: prefix, so the format would be \"<URL:%s>\"."
- :group 'org-link
- :type '(choice
- (const :tag "\"%s\" (e.g. http://www.there.com)" "%s")
- (const :tag "\"<%s>\" (e.g. <http://www.there.com>)" "<%s>")
- (const :tag "\"<URL:%s>\" (e.g. <URL:http://www.there.com>)" "<URL:%s>")
- (string :tag "Other" :value "<%s>")))
- (defcustom org-allow-space-in-links t
- "Non-nil means, file names in links may contain space characters.
- When nil, it becomes possible to put several links into a line.
- Note that in tables, a link never extends accross fields, so in a table
- it is always possible to put several links into a line.
- Changing this variable requires a restart of Emacs of become effective."
- :group 'org-link
- :type 'boolean)
- (defcustom org-radio-targets t
- "Non-nil means activate text matching a link target.
- Radio targets are strings in triple angular brackets, like <<<My Target>>>.
- When this option is set, any occurrence of \"my target\" in normal text
- becomes a link."
- :group 'org-link
- :type 'boolean)
- (defcustom org-activate-camels nil
- "Non-nil means, treat words in CamelCase as in-file links.
- Changing this requires restart of Emacs to become effective."
- :group 'org-link
- :type 'boolean)
- (defcustom org-context-in-file-links t
- "Non-nil means, file links from `org-store-link' contain context.
- A search string will be added to the file name with :: as separator and
- used to find the context when the link is activated by the command
- `org-open-at-point'.
- Using a prefix arg to the command \\[org-store-link] (`org-store-link')
- negates this setting for the duration of the command."
- :group 'org-link
- :type 'boolean)
- (defcustom org-file-link-context-use-camel-case nil
- "Non-nil means, use CamelCase to store a search context in a file link.
- When nil, the search string simply consists of the words of the string."
- :group 'org-link
- :type 'boolean)
- (defcustom org-keep-stored-link-after-insertion nil
- "Non-nil means, keep link in list for entire session.
- The command `org-store-link' adds a link pointing to the current
- location to an internal list. These links accumulate during a session.
- The command `org-insert-link' can be used to insert links into any
- Org-mode file (offering completion for all stored links). When this
- option is nil, every link which has been inserted once using \\[org-insert-link]
- will be removed from the list, to make completing the unused links
- more efficient."
- :group 'org-link
- :type 'boolean)
- (defcustom org-link-frame-setup
- '((vm . vm-visit-folder-other-frame)
- (gnus . gnus-other-frame)
- (file . find-file-other-window))
- "Setup the frame configuration for following links.
- When following a link with Emacs, it may often be useful to display
- this link in another window or frame. This variable can be used to
- set this up for the different types of links.
- For VM, use any of
- `vm-visit-folder'
- `vm-visit-folder-other-frame'
- For Gnus, use any of
- `gnus'
- `gnus-other-frame'
- For FILE, use any of
- `find-file'
- `find-file-other-window'
- `find-file-other-frame'
- For the calendar, use the variable `calendar-setup'.
- For BBDB, it is currently only possible to display the matches in
- another window."
- :group 'org-link
- :type '(list
- (cons (const vm)
- (choice
- (const vm-visit-folder)
- (const vm-visit-folder-other-window)
- (const vm-visit-folder-other-frame)))
- (cons (const gnus)
- (choice
- (const gnus)
- (const gnus-other-frame)))
- (cons (const file)
- (choice
- (const find-file)
- (const find-file-other-window)
- (const find-file-other-frame)))))
- (defcustom org-usenet-links-prefer-google nil
- "Non-nil means, `org-store-link' will create web links to Google groups.
- When nil, Gnus will be used for such links.
- Using a prefix arg to the command \\[org-store-link] (`org-store-link')
- negates this setting for the duration of the command."
- :group 'org-link
- :type 'boolean)
- (defcustom org-open-non-existing-files nil
- "Non-nil means, `org-open-file' will open non-existing file.
- When nil, an error will be generated."
- :group 'org-link
- :type 'boolean)
- (defcustom org-confirm-shell-links t
- "Non-nil means, ask for confirmation before executing shell links.
- The default is true, to keep new users from shooting into their own foot."
- :group 'org-link
- :type 'boolean)
- (defconst org-file-apps-defaults-gnu
- '((t . mailcap))
- "Default file applications on a UNIX or GNU/Linux system.
- See `org-file-apps'.")
- (defconst org-file-apps-defaults-macosx
- '((t . "open %s")
- ("ps" . "gv %s")
- ("ps.gz" . "gv %s")
- ("eps" . "gv %s")
- ("eps.gz" . "gv %s")
- ("dvi" . "xdvi %s")
- ("fig" . "xfig %s"))
- "Default file applications on a MacOS X system.
- The system \"open\" is known as a default, but we use X11 applications
- for some files for which the OS does not have a good default.
- See `org-file-apps'.")
- (defconst org-file-apps-defaults-windowsnt
- '((t . (w32-shell-execute "open" file)))
- "Default file applications on a Windows NT system.
- The system \"open\" is used for most files.
- See `org-file-apps'.")
- (defcustom org-file-apps
- '(
- ("txt" . emacs)
- ("tex" . emacs)
- ("ltx" . emacs)
- ("org" . emacs)
- ("el" . emacs)
- )
- "External applications for opening `file:path' items in a document.
- Org-mode uses system defaults for different file types, but
- you can use this variable to set the application for a given file
- extension. The entries in this list are cons cells with a file extension
- and the corresponding command. Possible values for the command are:
- `emacs' The file will be visited by the current Emacs process.
- `default' Use the default application for this file type.
- string A command to be executed by a shell; %s will be replaced
- by the path to the file.
- sexp A Lisp form which will be evaluated. The file path will
- be available in the Lisp variable `file'.
- For more examples, see the system specific constants
- `org-file-apps-defaults-macosx'
- `org-file-apps-defaults-windowsnt'
- `org-file-apps-defaults-gnu'."
- :group 'org-link
- :type '(repeat
- (cons (choice :value ""
- (string :tag "Extension")
- (const :tag "Default for unrecognized files" t)
- (const :tag "Links to a directory" directory))
- (choice :value ""
- (const :tag "Visit with Emacs" emacs)
- (const :tag "Use system default" default)
- (string :tag "Command")
- (sexp :tag "Lisp form")))))
- (defcustom org-mhe-search-all-folders nil
- "Non-nil means, that the search for the mh-message will be extended to
- all folders if the message cannot be found in the folder given in the link.
- Searching all folders is very effective with one of the search engines
- supported by MH-E, but will be slow with pick."
- :group 'org-link
- :type 'boolean)
- (defgroup org-remember nil
- "Options concerning interaction with remember.el."
- :tag "Org Remember"
- :group 'org)
- (defcustom org-directory "~/org"
- "Directory with org files.
- This directory will be used as default to prompt for org files.
- Used by the hooks for remember.el."
- :group 'org-remember
- :type 'directory)
- (defcustom org-default-notes-file "~/.notes"
- "Default target for storing notes.
- Used by the hooks for remember.el. This can be a string, or nil to mean
- the value of `remember-data-file'."
- :group 'org-remember
- :type '(choice
- (const :tag "Default from remember-data-file" nil)
- file))
- (defcustom org-remember-templates nil
- "Templates for the creation of remember buffers.
- When nil, just let remember make the buffer.
- When not nil, this is a list of 3-element lists. In each entry, the first
- element is a character, a unique key to select this template.
- The second element is the template. The third element is optional and can
- specify a destination file for remember items created with this template.
- The default file is given by `org-default-notes-file'.
- The template specifies the structure of the remember buffer. It should have
- a first line starting with a star, to act as the org-mode headline.
- Furthermore, the following %-escapes will be replaced with content:
- %t time stamp, date only
- %T time stamp with date and time
- %u inactive time stamp, date only
- %U inactive time stamp with date and time
- %n user name
- %a annotation, normally the link created with org-store-link
- %i initial content, the region when remember is called with C-u.
- If %i is indented, the entire inserted text will be indented as well.
- %? This will be removed, and the cursor placed at this position."
- :group 'org-remember
- :type '(repeat :tag "enabled"
- (list :value (?a "\n" nil)
- (character :tag "Selection Key")
- (string :tag "Template")
- (file :tag "Destination file (optional)"))))
- (defcustom org-reverse-note-order nil
- "Non-nil means, store new notes at the beginning of a file or entry.
- When nil, new notes will be filed to the end of a file or entry."
- :group 'org-remember
- :type '(choice
- (const :tag "Reverse always" t)
- (const :tag "Reverse never" nil)
- (repeat :tag "By file name regexp"
- (cons regexp boolean))))
- (defgroup org-table nil
- "Options concerning tables in Org-mode."
- :tag "Org Table"
- :group 'org)
- (defcustom org-enable-table-editor 'optimized
- "Non-nil means, lines starting with \"|\" are handled by the table editor.
- When nil, such lines will be treated like ordinary lines.
- When equal to the symbol `optimized', the table editor will be optimized to
- do the following:
- - Use automatic overwrite mode in front of whitespace in table fields.
- This make the structure of the table stay in tact as long as the edited
- field does not exceed the column width.
- - Minimize the number of realigns. Normally, the table is aligned each time
- TAB or RET are pressed to move to another field. With optimization this
- happens only if changes to a field might have changed the column width.
- Optimization requires replacing the functions `self-insert-command',
- `delete-char', and `backward-delete-char' in Org-mode buffers, with a
- slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
- very good at guessing when a re-align will be necessary, but you can always
- force one with \\[org-ctrl-c-ctrl-c].
- If you would like to use the optimized version in Org-mode, but the
- un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
- This variable can be used to turn on and off the table editor during a session,
- but in order to toggle optimization, a restart is required.
- See also the variable `org-table-auto-blank-field'."
- :group 'org-table
- :type '(choice
- (const :tag "off" nil)
- (const :tag "on" t)
- (const :tag "on, optimized" optimized)))
- ;; FIXME: We could have a third option which makes it jump only over the first
- ;; hline in a table.
- (defcustom org-table-tab-jumps-over-hlines t
- "Non-nil means, tab in the last column of a table with jump over a hline.
- If a horizontal separator line is following the current line,
- `org-table-next-field' can either create a new row before that line, or jump
- over the line. When this option is nil, a new line will be created before
- this line."
- :group 'org-table
- :type 'boolean)
- (defcustom org-table-auto-blank-field t
- "Non-nil means, automatically blank table field when starting to type into it.
- This only happens when typing immediately after a field motion
- command (TAB, S-TAB or RET).
- Only relevant when `org-enable-table-editor' is equal to `optimized'."
- :group 'org-table
- :type 'boolean)
- (defcustom org-table-default-size "5x2"
- "The default size for newly created tables, Columns x Rows."
- :group 'org-table
- :type 'string)
- (defcustom org-table-automatic-realign t
- "Non-nil means, automatically re-align table when pressing TAB or RETURN.
- When nil, aligning is only done with \\[org-table-align], or after column
- removal/insertion."
- :group 'org-table
- :type 'boolean)
- (defcustom org-table-spaces-around-separators '(1 . 1)
- "The number of spaces to be placed before and after separators."
- :group 'org-table
- :type '(cons (number :tag "Before \"|\"") (number :tag " After \"|\"")))
- (defcustom org-table-spaces-around-invisible-separators '(1 . 2)
- "The number of spaces to be placed before and after separators.
- This option applies when the column separators have been made invisible."
- :group 'org-table
- :type '(cons (number :tag "Before \"|\"") (number :tag " After \"|\"")))
- (defcustom org-table-number-regexp "^[<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%]*$"
- "Regular expression for recognizing numbers in table columns.
- If a table column contains mostly numbers, it will be aligned to the
- right. If not, it will be aligned to the left.
- The default value of this option is a regular expression which allows
- anything which looks remotely like a number as used in scientific
- context. For example, all of the following will be considered a
- number:
- 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
- Other options offered by the customize interface are more restrictive."
- :group 'org-table
- :type '(choice
- (const :tag "Positive Integers"
- "^[0-9]+$")
- (const :tag "Integers"
- "^[-+]?[0-9]+$")
- (const :tag "Floating Point Numbers"
- "^[-+]?\\([0-9]*\\.[0-9]+\\|[0-9]+\\.[0-9]*\\)$")
- (const :tag "Floating Point Number or Integer"
- "^[-+]?\\([0-9]*\\.[0-9]+\\|[0-9]+\\.?[0-9]*\\)$")
- (const :tag "Exponential, Floating point, Integer"
- "^[-+]?[0-9.]+\\([eEdD][-+0-9]+\\)?$")
- (const :tag "Very General Number-Like"
- "^[<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%]*$")
- (string :tag "Regexp:")))
- (defcustom org-table-number-fraction 0.5
- "Fraction of numbers in a column required to make the column align right.
- In a column all non-white fields are considered. If at least this
- fraction of fields is matched by `org-table-number-fraction',
- alignment to the right border applies."
- :group 'org-table
- :type 'number)
- (defcustom org-export-highlight-first-table-line t
- "Non-nil means, highlight the first table line.
- In HTML export, this means use <th> instead of <td>.
- In tables created with table.el, this applies to the first table line.
- In Org-mode tables, all lines before the first horizontal separator
- line will be formatted with <th> tags."
- :group 'org-table
- :type 'boolean)
- (defcustom org-table-tab-recognizes-table.el t
- "Non-nil means, TAB will automatically notice a table.el table.
- When it sees such a table, it moves point into it and - if necessary -
- calls `table-recognize-table'."
- :group 'org-table
- :type 'boolean)
- (defgroup org-table-calculation nil
- "Options concerning tables in Org-mode."
- :tag "Org Table Calculation"
- :group 'org)
- (defcustom org-table-copy-increment t
- "Non-nil means, increment when copying current field with \\[org-table-copy-down]."
- :group 'org-table-calculation
- :type 'boolean)
- (defcustom org-calc-default-modes
- '(calc-internal-prec 12
- calc-float-format (float 5)
- calc-angle-mode deg
- calc-prefer-frac nil
- calc-symbolic-mode nil
- calc-date-format (YYYY "-" MM "-" DD " " Www (" " HH ":" mm))
- calc-display-working-message t
- )
- "List with Calc mode settings for use in calc-eval for table formulas.
- The list must contain alternating symbols (Calc modes variables and values).
- Don't remove any of the default settings, just change the values. Org-mode
- relies on the variables to be present in the list."
- :group 'org-table-calculation
- :type 'plist)
- (defcustom org-table-formula-evaluate-inline t
- "Non-nil means, TAB and RET evaluate a formula in current table field.
- If the current field starts with an equal sign, it is assumed to be a formula
- which should be evaluated as described in the manual and in the documentation
- string of the command `org-table-eval-formula'. This feature requires the
- Emacs calc package.
- When this variable is nil, formula calculation is only available through
- the command \\[org-table-eval-formula]."
- :group 'org-table-calculation
- :type 'boolean)
- (defcustom org-table-formula-use-constants t
- "Non-nil means, interpret constants in formulas in tables.
- A constant looks like `$c' or `$Grav' and will be replaced before evaluation
- by the value given in `org-table-formula-constants', or by a value obtained
- from the `constants.el' package."
- :group 'org-table-calculation
- :type 'boolean)
- (defcustom org-table-formula-constants nil
- "Alist with constant names and values, for use in table formulas.
- The car of each element is a name of a constant, without the `$' before it.
- The cdr is the value as a string. For example, if you'd like to use the
- speed of light in a formula, you would configure
- (setq org-table-formula-constants '((\"c\" . \"299792458.\")))
- and then use it in an equation like `$1*$c'."
- :group 'org-table-calculation
- :type '(repeat
- (cons (string :tag "name")
- (string :tag "value"))))
- (defcustom org-table-formula-numbers-only nil
- "Non-nil means, calculate only with numbers in table formulas.
- Then all input fields will be converted to a number, and the result
- must also be a number. When nil, calc's full potential is available
- in table calculations, including symbolics etc."
- :group 'org-table-calculation
- :type 'boolean)
- (defcustom org-table-allow-automatic-line-recalculation t
- "Non-nil means, lines marked with |#| or |*| will be recomputed automatically.
- Automatically means, when TAB or RET or C-c C-c are pressed in the line."
- :group 'org-table-calculation
- :type 'boolean)
- (defgroup org-export nil
- "Options for exporting org-listings."
- :tag "Org Export"
- :group 'org)
- (defcustom org-export-language-setup
- '(("en" "Author" "Date" "Table of Contents")
- ("da" "Ophavsmand" "Dato" "Indhold")
- ("de" "Autor" "Datum" "Inhaltsverzeichnis")
- ("es" "Autor" "Fecha" "\xccndice")
- ("fr" "Auteur" "Date" "Table des Mati\xe8res")
- ("it" "Autore" "Data" "Indice")
- ("nl" "Auteur" "Datum" "Inhoudsopgave")
- ("nn" "Forfattar" "Dato" "Innhold") ;; nn = Norsk (nynorsk)
- ("sv" "F\xf6rfattarens" "Datum" "Inneh\xe5ll"))
- "Terms used in export text, translated to different languages.
- Use the variable `org-export-default-language' to set the language,
- or use the +OPTION lines for a per-file setting."
- :group 'org-export
- :type '(repeat
- (list
- (string :tag "HTML language tag")
- (string :tag "Author")
- (string :tag "Date")
- (string :tag "Table of Contents"))))
- (defcustom org-export-default-language "en"
- "The default language of HTML export, as a string.
- This should have an association in `org-export-language-setup'."
- :group 'org-export
- :type 'string)
- (defcustom org-export-html-style
- "<style type=\"text/css\">
- html {
- font-family: Times, serif;
- font-size: 12pt;
- }
- .title { text-align: center; }
- .todo, .deadline { color: red; }
- .done { color: green; }
- .target { background-color: lavender; }
- pre {
- border: 1pt solid #AEBDCC;
- background-color: #F3F5F7;
- padding: 5pt;
- font-family: courier, monospace;
- }
- table { border-collapse: collapse; }
- td, th {
- vertical-align: top;
- border: 1pt solid #ADB9CC;
- }
- </style>"
- "The default style specification for exported HTML files.
- Since there are different ways of setting style information, this variable
- needs to contain the full HTML structure to provide a style, including the
- surrounding HTML tags. The style specifications should include definitions
- for new classes todo, done, title, and deadline. For example, legal values
- would be:
- <style type=\"text/css\">
- p { font-weight: normal; color: gray; }
- h1 { color: black; }
- .title { text-align: center; }
- .todo, .deadline { color: red; }
- .done { color: green; }
- </style>
- or, if you want to keep the style in a file,
- <link rel=\"stylesheet\" type=\"text/css\" href=\"mystyles.css\">
- As the value of this option simply gets inserted into the HTML <head> header,
- you can \"misuse\" it to add arbitrary text to the header."
- :group 'org-export
- :type 'string)
- (defcustom org-export-headline-levels 3
- "The last level which is still exported as a headline.
- Inferior levels will produce itemize lists when exported.
- Note that a numeric prefix argument to an exporter function overrides
- this setting.
- This option can also be set with the +OPTIONS line, e.g. \"H:2\"."
- :group 'org-export
- :type 'number)
- (defcustom org-export-with-section-numbers t
- "Non-nil means, add section numbers to headlines when exporting.
- This option can also be set with the +OPTIONS line, e.g. \"num:t\"."
- :group 'org-export
- :type 'boolean)
- (defcustom org-export-with-toc t
- "Non-nil means, create a table of contents in exported files.
- The TOC contains headlines with levels up to`org-export-headline-levels'.
- Headlines which contain any TODO items will be marked with \"(*)\" in
- ASCII export, and with red color in HTML output.
- In HTML output, the TOC will be clickable.
- This option can also be set with the +OPTIONS line, e.g. \"toc:nil\"."
- :group 'org-export
- :type 'boolean)
- (defcustom org-export-plain-list-max-depth 20
- "Maximum depth of hand-formatted lists in HTML export.
- Org-mode parses hand-formatted enumeration and bullet lists and
- transforms them to HTML open export. Different indentation of the
- bullet or number indicates different list nesting levels. To avoid
- confusion, only a single level is allowed by default. When this is
- larger than 1, deeper indentation leads to deeper list nesting. For
- example, the default value of 3 allows the following list to be
- formatted correctly in HTML:
- * Fruit
- - Apple
- - Banana
- 1. from Africa
- 2. from South America
- - Pineapple
- * Bread
- * Dairy products"
- :group 'org-export
- :type 'integer)
- (defcustom org-export-preserve-breaks nil
- "Non-nil means, preserve all line breaks when exporting.
- Normally, in HTML output paragraphs will be reformatted. In ASCII
- export, line breaks will always be preserved, regardless of this variable.
- This option can also be set with the +OPTIONS line, e.g. \"\\n:t\"."
- :group 'org-export
- :type 'boolean)
- (defcustom org-export-html-inline-images t
- "Non-nil means, inline images into exported HTML pages.
- The link will still be to the original location of the image file.
- So if you are moving the page, lets say to your public HTML site,
- you will have to move the image and maybe change the link."
- :group 'org-export
- :type 'boolean)
- (defcustom org-export-html-expand t
- "Non-nil means, for HTML export, treat @<...> as HTML tag.
- When nil, these tags will be exported as plain text and therefore
- not be interpreted by a browser.
- This option can also be set with the +OPTIONS line, e.g. \"@:nil\"."
- :group 'org-export
- :type 'boolean)
- (defcustom org-export-with-fixed-width t
- "Non-nil means, lines starting with \":\" will be in fixed width font.
- This can be used to have pre-formatted text, fragments of code etc. For
- example:
- : ;; Some Lisp examples
- : (while (defc cnt)
- : (ding))
- will be looking just like this in also HTML. In ASCII export, this option
- has no effect.
- This option can also be set with the +OPTIONS line, e.g. \"::nil\"."
- :group 'org-export
- :type 'boolean)
- (defcustom org-export-with-tables t
- "If non-nil, lines starting with \"|\" define a table.
- For example:
- | Name | Address | Birthday |
- |-------------+----------+-----------|
- | Arthur Dent | England | 29.2.2100 |
- In ASCII export, this option has no effect.
- This option can also be set with the +OPTIONS line, e.g. \"|:nil\"."
- :group 'org-export
- :type 'boolean)
- (defcustom org-export-table-remove-special-lines t
- "Remove special lines and marking characters in calculating tables.
- This removes the special marking character column from tables that are set
- up for spreadsheet calculations. It also removes the entire lines
- marked with `!', `_', or `^'. The lines with `$' are kept, because
- the values of constants may be useful to have."
- :group 'org-export
- :type 'boolean)
- (defcustom org-export-prefer-native-exporter-for-tables nil
- "Non-nil means, always export tables created with table.el natively.
- Natively means, use the HTML code generator in table.el.
- When nil, Org-mode's own HTML generator is used when possible (i.e. if
- the table does not use row- or column-spanning). This has the
- advantage, that the automatic HTML conversions for math symbols and
- sub/superscripts can be applied. Org-mode's HTML generator is also
- much faster."
- :group 'org-export
- :type 'boolean)
- (defcustom org-export-html-table-tag
- "<table border=1 cellspacing=0 cellpadding=6>"
- "The HTML tag used to start a table.
- This must be a <table> tag, but you may change the options like
- borders and spacing."
- :group 'org-export
- :type 'string)
- (defcustom org-export-with-emphasize t
- "Non-nil means, interpret *word*, /word/, and _word_ as emphasized text.
- If the export target supports emphasizing text, the word will be
- typeset in bold, italic, or underlined, respectively. Works only for
- single words, but you can say: I *really* *mean* *this*.
- In ASCII export, this option has no effect.
- This option can also be set with the +OPTIONS line, e.g. \"*:nil\"."
- :group 'org-export
- :type 'boolean)
- (defcustom org-match-sexp-depth 3
- "Number of stacked braces for sub/superscript matching.
- This has to be set before loading org.el to be effective."
- :group 'org-export
- :type 'integer)
- ;; FIXME: Should () parens be removed as well in sub/superscripts?
- (defcustom org-export-with-sub-superscripts t
- "Non-nil means, interpret \"_\" and \"^\" for export.
- When this option is turned on, you can use TeX-like syntax for sub- and
- superscripts. Several characters after \"_\" or \"^\" will be
- considered as a single item - so grouping with {} is normally not
- needed. For example, the following things will be parsed as single
- sub- or superscripts.
- 10^24 or 10^tau several digits will be considered 1 item.
- 10^-12 or 10^-tau a leading sign with digits or a word
- x^2-y^3 will be read as x^2 - y^3, because items are
- terminated by almost any nonword/nondigit char.
- x_{i^2} or x^(2-i) braces or parenthesis do grouping.
- Still, ambiguity is possible - so when in doubt use {} to enclose the
- sub/superscript.
- In ASCII export, this option has no effect.
- This option can also be set with the +OPTIONS line, e.g. \"^:nil\"."
- :group 'org-export
- :type 'boolean)
- (defcustom org-export-with-TeX-macros t
- "Non-nil means, interpret simple TeX-like macros when exporting.
- For example, HTML export converts \\alpha to α and \\AA to Å.
- No only real TeX macros will work here, but the standard HTML entities
- for math can be used as macro names as well. For a list of supported
- names in HTML export, see the constant `org-html-entities'.
- In ASCII export, this option has no effect.
- This option can also be set with the +OPTIONS line, e.g. \"TeX:nil\"."
- :group 'org-export
- :type 'boolean)
- (defcustom org-export-html-with-timestamp nil
- "If non-nil, write `org-export-html-html-helper-timestamp'
- into the exported HTML text. Otherwise, the buffer will just be saved
- to a file."
- :group 'org-export
- :type 'boolean)
- (defcustom org-export-html-html-helper-timestamp
- "<br><br><hr><p><!-- hhmts start --> <!-- hhmts end -->\n"
- "The HTML tag used as timestamp delimiter for HTML-helper-mode."
- :group 'org-export
- :type 'string)
- (defcustom org-export-ascii-show-new-buffer t
- "Non-nil means, popup buffer containing the exported ASCII text.
- Otherwise the buffer will just be saved to a file and stay hidden."
- :group 'org-export
- :type 'boolean)
- (defcustom org-export-html-show-new-buffer nil
- "Non-nil means, popup buffer containing the exported html text.
- Otherwise, the buffer will just be saved to a file and stay hidden."
- :group 'org-export
- :type 'boolean)
- (defcustom org-combined-agenda-icalendar-file "~/org.ics"
- "The file name for the iCalendar file covering all agenda files.
- This file is created with the command \\[org-export-icalendar-all-agenda-files]."
- :group 'org-export
- :type 'file)
- (defcustom org-icalendar-include-todo nil
- "Non-nil means, export to iCalendar files should also cover TODO items."
- :group 'org-export
- :type 'boolean)
- (defcustom org-icalendar-combined-name "OrgMode"
- "Calendar name for the combined iCalendar representing all agenda files."
- :group 'org-export
- :type 'string)
- (defgroup org-font-lock nil
- "Faces and settings for highlighting in Org-mode."
- :tag "Org Font Lock"
- :group 'org)
- (defcustom org-level-color-stars-only nil
- "Non-nil means fontify only the stars in each headline.
- When nil, the entire headline is fontified.
- Changing it requires restart of `font-lock-mode' to become effective
- also in regions already fontified."
- :group 'org-font-lock
- :type 'boolean)
- (defcustom org-hide-leading-stars nil
- "Non-nil means, hide the first N-1 stars in a headline.
- This works by using the face `org-hide' for these stars. This
- face is white for a light background, and black for a dark
- background. You may have to customize the face `org-hide' to
- make this work.
- Changing it requires restart of `font-lock-mode' to become effective
- also in regions already fontified."
- :group 'org-font-lock
- :type 'boolean)
- (defcustom org-fontify-done-headline nil
- "Non-nil means, change the face of a headline if it is marked DONE.
- Normally, only the TODO/DONE keyword indicates the state of a headline.
- When this is non-nil, the headline after the keyword is set to the
- `org-headline-done' as an additional indication."
- :group 'org-font-lock
- :type 'boolean)
- (defcustom org-fontify-emphasized-text t
- "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
- Changing this variable requires a restart of Emacs to take effect."
- :group 'org-font-lock
- :type 'boolean)
- (defface org-hide
- '(
- (((type tty) (class color)) (:foreground "white"))
- (((class color) (background light)) (:foreground "white"))
- (((class color) (background dark)) (:foreground "black"))
- ; (((class color) (backgro6und light)) (:foreground "grey90"))
- ; (((class color) (background dark)) (:foreground "grey10"))
- (t (:inverse-video nil)))
- "Face used for level 1 headlines."
- :group 'org-font-lock)
- (defface org-level-1 ;; font-lock-function-name-face
- '((((type tty) (class color)) (:foreground "blue" :weight bold))
- (((class color) (background light)) (:foreground "Blue"))
- (((class color) (background dark)) (:foreground "LightSkyBlue"))
- (t (:inverse-video t :bold t)))
- "Face used for level 1 headlines."
- :group 'org-font-lock)
- (defface org-level-2 ;; font-lock-variable-name-face
- '((((type tty) (class color)) (:foreground "yellow" :weight light))
- (((class color) (background light)) (:foreground "DarkGoldenrod"))
- (((class color) (background dark)) (:foreground "LightGoldenrod"))
- (t (:bold t :italic t)))
- "Face used for level 2 headlines."
- :group 'org-font-lock)
- (defface org-level-3 ;; font-lock-keyword-face
- '((((type tty) (class color)) (:foreground "cyan" :weight bold))
- (((class color) (background light)) (:foreground "Purple"))
- (((class color) (background dark)) (:foreground "Cyan"))
- (t (:bold t)))
- "Face used for level 3 headlines."
- :group 'org-font-lock)
- (defface org-level-4 ;; font-lock-comment-face
- '((((type tty pc) (class color) (background light)) (:foreground "red"))
- (((type tty pc) (class color) (background dark)) (:foreground "red1"))
- (((class color) (background light)) (:foreground "Firebrick"))
- (((class color) (background dark)) (:foreground "chocolate1"))
- (t (:bold t :italic t)))
- "Face used for level 4 headlines."
- :group 'org-font-lock)
- (defface org-level-5 ;; font-lock-type-face
- '((((type tty) (class color)) (:foreground "green"))
- (((class color) (background light)) (:foreground "ForestGreen"))
- (((class color) (background dark)) (:foreground "PaleGreen"))
- (t (:bold t :underline t)))
- "Face used for level 5 headlines."
- :group 'org-font-lock)
- (defface org-level-6 ;; font-lock-constant-face
- '((((type tty) (class color)) (:foreground "magenta"))
- (((class color) (background light)) (:foreground "CadetBlue"))
- (((class color) (background dark)) (:foreground "Aquamarine"))
- (t (:bold t :underline t)))
- "Face used for level 6 headlines."
- :group 'org-font-lock)
- (defface org-level-7 ;; font-lock-builtin-face
- '((((type tty) (class color)) (:foreground "blue" :weight light))
- (((class color) (background light)) (:foreground "Orchid"))
- (((class color) (background dark)) (:foreground "LightSteelBlue"))
- (t (:bold t)))
- "Face used for level 7 headlines."
- :group 'org-font-lock)
- (defface org-level-8 ;; font-lock-string-face
- '((((type tty) (class color)) (:foreground "green"))
- (((class color) (background light)) (:foreground "RosyBrown"))
- (((class color) (background dark)) (:foreground "LightSalmon"))
- (t (:italic t)))
- "Face used for level 8 headlines."
- :group 'org-font-lock)
- (defface org-special-keyword ;; font-lock-string-face
- '((((type tty) (class color)) (:foreground "green"))
- (((class color) (background light)) (:foreground "RosyBrown"))
- (((class color) (background dark)) (:foreground "LightSalmon"))
- (t (:italic t)))
- "Face used for special keywords."
- :group 'org-font-lock)
- (defface org-warning ;; font-lock-warning-face
- '((((type tty) (class color)) (:foreground "red"))
- (((class color) (background light)) (:foreground "Red" :bold t))
- (((class color) (background dark)) (:foreground "Red1" :bold t))
- ; (((class color) (background dark)) (:foreground "Pink" :bold t))
- (t (:inverse-video t :bold t)))
- "Face for deadlines and TODO keywords."
- :group 'org-font-lock)
- (defface org-headline-done ;; font-lock-string-face
- '((((type tty) (class color)) (:foreground "green"))
- (((class color) (background light)) (:foreground "RosyBrown"))
- (((class color) (background dark)) (:foreground "LightSalmon"))
- (t (:italic t)))
- "Face used to indicate that a headline is DONE. See also the variable
- `org-fontify-done-headline'."
- :group 'org-font-lock)
- ;; Inheritance does not yet work for xemacs. So we just copy...
- (defface org-deadline-announce
- '((((type tty) (class color)) (:foreground "blue" :weight bold))
- (((class color) (background light)) (:foreground "Blue"))
- (((class color) (background dark)) (:foreground "LightSkyBlue"))
- (t (:inverse-video t :bold t)))
- "Face for upcoming deadlines."
- :group 'org-font-lock)
- (defface org-scheduled-today
- '((((type tty) (class color)) (:foreground "green"))
- (((class color) (background light)) (:foreground "DarkGreen"))
- (((class color) (background dark)) (:foreground "PaleGreen"))
- (t (:bold t :underline t)))
- "Face for items scheduled for a certain day."
- :group 'org-font-lock)
- (defface org-scheduled-previously
- '((((type tty pc) (class color) (background light)) (:foreground "red"))
- (((type tty pc) (class color) (background dark)) (:foreground "red1"))
- (((class color) (background light)) (:foreground "Firebrick"))
- (((class color) (background dark)) (:foreground "chocolate1"))
- (t (:bold t :italic t)))
- "Face for items scheduled previously, and not yet done."
- :group 'org-font-lock)
- (defface org-formula
- '((((type tty pc) (class color) (background light)) (:foreground "red"))
- (((type tty pc) (class color) (background dark)) (:foreground "red1"))
- (((class color) (background light)) (:foreground "Firebrick"))
- (((class color) (background dark)) (:foreground "chocolate1"))
- (t (:bold t :italic t)))
- "Face for formulas."
- :group 'org-font-lock)
- (defface org-link
- '((((type tty) (class color)) (:foreground "cyan" :weight bold))
- (((class color) (background light)) (:foreground "Purple"))
- (((class color) (background dark)) (:foreground "Cyan"))
- (t (:bold t)))
- "Face for links."
- :group 'org-font-lock)
- (defface org-tag
- '((((type tty) (class color)) (:foreground "cyan" :weight bold))
- (((class color) (background light)) (:foreground "Purple" :weight bold))
- (((class color) (background dark)) (:foreground "Cyan" :weight bold))
- (t (:bold t)))
- "Face for tags."
- :group 'org-font-lock)
- (defface org-done ;; font-lock-type-face
- '((((type tty) (class color)) (:foreground "green"))
- (((class color) (background light)) (:foreground "ForestGreen" :bold t))
- (((class color) (background dark)) (:foreground "PaleGreen" :bold t))
- (t (:bold t :underline t)))
- "Face used for DONE."
- :group 'org-font-lock)
- (defface org-table ;; font-lock-function-name-face
- '((((type tty) (class color)) (:foreground "blue" :weight bold))
- (((class color) (background light)) (:foreground "Blue"))
- (((class color) (background dark)) (:foreground "LightSkyBlue"))
- (t (:inverse-video t :bold t)))
- "Face used for tables."
- :group 'org-font-lock)
- (defface org-time-grid ;; font-lock-variable-name-face
- '((((type tty) (class color)) (:foreground "yellow" :weight light))
- (((class color) (background light)) (:foreground "DarkGoldenrod"))
- (((class color) (background dark)) (:foreground "LightGoldenrod"))
- (t (:bold t :italic t)))
- "Face used for time grids."
- :group 'org-font-lock)
- (defvar org-level-faces
- '(org-level-1 org-level-2 org-level-3 org-level-4
- org-level-5 org-level-6 org-level-7 org-level-8
- ))
- (defvar org-n-levels (length org-level-faces))
- (defun org-set-regexps-and-options ()
- "Precompute regular expressions for current buffer."
- (when (eq major-mode 'org-mode)
- (let ((re (org-make-options-regexp
- '("CATEGORY" "SEQ_TODO" "PRI_TODO" "TYP_TODO"
- "STARTUP" "ARCHIVE")))
- (splitre "[ \t]+")
- kwds int key value cat arch)
- (save-excursion
- (save-restriction
- (widen)
- (goto-char (point-min))
- (while (re-search-forward re nil t)
- (setq key (match-string 1) value (match-string 2))
- (cond
- ((equal key "CATEGORY")
- (if (string-match "[ \t]+$" value)
- (setq value (replace-match "" t t value)))
- (setq cat (intern value)))
- ((equal key "SEQ_TODO")
- (setq int 'sequence
- kwds (append kwds (org-split-string value splitre))))
- ((equal key "PRI_TODO")
- (setq int 'priority
- kwds (append kwds (org-split-string value splitre))))
- ((equal key "TYP_TODO")
- (setq int 'type
- kwds (append kwds (org-split-string value splitre))))
- ((equal key "STARTUP")
- (let ((opts (org-split-string value splitre))
- (set '(("fold" org-startup-folded t)
- ("nofold" org-startup-folded nil)
- ("content" org-startup-folded content)
- ("hidestars" org-hide-leading-stars t)
- ("showstars" org-hide-leading-stars nil)
- ("odd" org-odd-levels-only t)
- ("oddeven" org-odd-levels-only nil)
- ("dlcheck" org-startup-with-deadline-check t)
- ("nodlcheck" org-startup-with-deadline-check nil)))
- l var val)
- (while (setq l (assoc (pop opts) set))
- (setq var (nth 1 l) val (nth 2 l))
- (set (make-local-variable var) val))))
- ((equal key "ARCHIVE")
- (string-match " *$" value)
- (setq arch (replace-match "" t t value))
- (remove-text-properties 0 (length arch)
- '(face t fontified t) arch)))
- )))
- (and cat (set (make-local-variable 'org-category) cat))
- (and kwds (set (make-local-variable 'org-todo-keywords) kwds))
- (and arch (set (make-local-variable 'org-archive-location) arch))
- (and int (set (make-local-variable 'org-todo-interpretation) int)))
- ;; Compute the regular expressions and other local variables
- (setq org-todo-kwd-priority-p (equal org-todo-interpretation 'priority)
- org-todo-kwd-max-priority (1- (length org-todo-keywords))
- org-ds-keyword-length (+ 2 (max (length org-deadline-string)
- (length org-scheduled-string)))
- org-done-string
- (nth (1- (length org-todo-keywords)) org-todo-keywords)
- org-todo-regexp
- (concat "\\<\\(" (mapconcat 'regexp-quote org-todo-keywords
- "\\|") "\\)\\>")
- org-not-done-regexp
- (concat "\\<\\("
- (mapconcat 'regexp-quote
- (nreverse (cdr (reverse org-todo-keywords)))
- "\\|")
- "\\)\\>")
- org-todo-line-regexp
- (concat "^\\(\\*+\\)[ \t]*\\("
- (mapconcat 'regexp-quote org-todo-keywords "\\|")
- "\\)? *\\(.*\\)")
- org-nl-done-regexp
- (concat "[\r\n]\\*+[ \t]+" org-done-string "\\>")
- org-looking-at-done-regexp (concat "^" org-done-string "\\>")
- org-deadline-regexp (concat "\\<" org-deadline-string)
- org-deadline-time-regexp
- (concat "\\<" org-deadline-string " *<\\([^>]+\\)>")
- org-deadline-line-regexp
- (concat "\\<\\(" org-deadline-string "\\).*")
- org-scheduled-regexp
- (concat "\\<" org-scheduled-string)
- org-scheduled-time-regexp
- (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>"))
- (org-set-font-lock-defaults)))
- ;; Tell the compiler about dynamically scoped variables,
- ;; and variables from other packages
- (defvar zmacs-regions) ; XEmacs regions
- (defvar original-date) ; dynamically scoped in calendar
- (defvar org-old-auto-fill-inhibit-regexp) ; local variable used by `orgtbl-mode'
- (defvar orgtbl-mode-menu) ; defined when orgtbl mode get initialized
- (defvar org-html-entities) ; defined later in this file
- (defvar org-goto-start-pos) ; dynamically scoped parameter
- (defvar org-time-was-given) ; dynamically scoped parameter
- (defvar org-ts-what) ; dynamically scoped parameter
- (defvar mark-active) ; Emacs only, not available in XEmacs.
- (defvar timecnt) ; dynamically scoped parameter
- (defvar levels-open) ; dynamically scoped parameter
- (defvar title) ; dynamically scoped parameter
- (defvar author) ; dynamically scoped parameter
- (defvar email) ; dynamically scoped parameter
- (defvar text) ; dynamically scoped parameter
- (defvar entry) ; dynamically scoped parameter
- (defvar date) ; dynamically scoped parameter
- (defvar language) ; dynamically scoped parameter
- (defvar options) ; dynamically scoped parameter
- (defvar ans1) ; dynamically scoped parameter
- (defvar ans2) ; dynamically scoped parameter
- (defvar starting-day) ; local variable
- (defvar include-all-loc) ; local variable
- (defvar vm-message-pointer) ; from vm
- (defvar vm-folder-directory) ; from vm
- (defvar wl-summary-buffer-elmo-folder) ; from wanderlust
- (defvar wl-summary-buffer-folder-name) ; from wanderlust
- (defvar gnus-group-name) ; from gnus
- (defvar gnus-article-current) ; from gnus
- (defvar w3m-current-url) ; from w3m
- (defvar mh-progs) ; from MH-E
- (defvar mh-current-folder) ; from MH-E
- (defvar mh-show-folder-buffer) ; from MH-E
- (defvar mh-index-folder) ; from MH-E
- (defvar mh-searcher) ; from MH-E
- (defvar org-selected-point) ; dynamically scoped parameter
- (defvar calendar-mode-map) ; from calendar.el
- (defvar last-arg) ; local variable
- (defvar remember-save-after-remembering) ; from remember.el
- (defvar remember-data-file) ; from remember.el
- (defvar annotation) ; from remember.el, dynamically scoped in `remember-mode'
- (defvar initial) ; from remember.el, dynamically scoped in `remember-mode'
- ;;; Define the mode
- (defvar org-mode-map (copy-keymap outline-mode-map)
- "Keymap for Org-mode.")
- (defvar org-struct-menu) ; defined later in this file
- (defvar org-org-menu) ; defined later in this file
- (defvar org-tbl-menu) ; defined later in this file
- ;; We use a before-change function to check if a table might need
- ;; an update.
- (defvar org-table-may-need-update t
- "Indicates that a table might need an update.
- This variable is set by `org-before-change-function'.
- `org-table-align' sets it back to nil.")
- (defvar org-mode-hook nil)
- (defvar org-inhibit-startup nil) ; Dynamically-scoped param.
- (defvar org-agenda-keep-modes nil) ; Dynamically-scoped param.
- ;;;###autoload
- (define-derived-mode org-mode outline-mode "Org"
- "Outline-based notes management and organizer, alias
- \"Carsten's outline-mode for keeping track of everything.\"
- Org-mode develops organizational tasks around a NOTES file which
- contains information about projects as plain text. Org-mode is
- implemented on top of outline-mode, which is ideal to keep the content
- of large files well structured. It supports ToDo items, deadlines and
- time stamps, which magically appear in the diary listing of the Emacs
- calendar. Tables are easily created with a built-in table editor.
- Plain text URL-like links connect to websites, emails (VM), Usenet
- messages (Gnus), BBDB entries, and any files related to the project.
- For printing and sharing of notes, an Org-mode file (or a part of it)
- can be exported as a structured ASCII or HTML file.
- The following commands are available:
- \\{org-mode-map}"
- (easy-menu-add org-org-menu)
- (easy-menu-add org-tbl-menu)
- (org-install-agenda-files-menu)
- (setq outline-regexp "\\*+")
- ; (setq outline-regexp "\\(?:\\*+\\|[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\) \\)")
- (setq outline-level 'org-outline-level)
- (if org-startup-truncated (setq truncate-lines t))
- (org-set-regexps-and-options)
- (set (make-local-variable 'font-lock-unfontify-region-function)
- 'org-unfontify-region)
- ;; Activate before-change-function
- (set (make-local-variable 'org-table-may-need-update) t)
- (org-add-hook 'before-change-functions 'org-before-change-function nil
- 'local)
- ;; Paragraphs and auto-filling
- (org-set-autofill-regexps)
- (org-update-radio-target-regexp)
- ;; Settings for Calc embedded mode
- (set (make-local-variable 'calc-embedded-open-formula) "|\\|\n")
- (set (make-local-variable 'calc-embedded-close-formula) "|\\|\n")
- (if (and org-insert-mode-line-in-empty-file
- (interactive-p)
- (= (point-min) (point-max)))
- (insert " -*- mode: org -*-\n\n"))
- ;; Get rid of Outline menus, they are not needed
- ;; Need to do this here because define-derived-mode sets up
- ;; the keymap so late.
- (if (featurep 'xemacs)
- (progn
- (delete-menu-item '("Headings"))
- (delete-menu-item '("Show"))
- (delete-menu-item '("Hide"))
- (set-menubar-dirty-flag))
- (define-key org-mode-map [menu-bar headings] 'undefined)
- (define-key org-mode-map [menu-bar hide] 'undefined)
- (define-key org-mode-map [menu-bar show] 'undefined))
- (unless org-inhibit-startup
- (if org-startup-with-deadline-check
- (call-interactively 'org-check-deadlines)
- (cond
- ((eq org-startup-folded t)
- (org-cycle '(4)))
- ((eq org-startup-folded 'content)
- (let ((this-command 'org-cycle) (last-command 'org-cycle))
- (org-cycle '(4)) (org-cycle '(4))))))))
- (defsubst org-current-line (&optional pos)
- (+ (if (bolp) 1 0) (count-lines (point-min) (or pos (point)))))
- (defun org-current-time ()
- "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
- (if (> org-time-stamp-rounding-minutes 0)
- (let ((r org-time-stamp-rounding-minutes)
- (time (decode-time)))
- (apply 'encode-time
- (append (list 0 (* r (floor (+ .5 (/ (float (nth 1 time)) r)))))
- (nthcdr 2 time))))
- (current-time)))
- ;; FIXME: Do we need to copy?
- (defun org-string-props (string &rest properties)
- "Add PROPERTIES to string."
- (add-text-properties 0 (length string) properties string)
- string)
- ;;; Font-Lock stuff
- (defvar org-mouse-map (make-sparse-keymap))
- (define-key org-mouse-map
- (if (featurep 'xemacs) [button2] [mouse-2]) 'org-open-at-mouse)
- (define-key org-mouse-map
- (if (featurep 'xemacs) [button3] [mouse-3]) 'org-find-file-at-mouse)
- (define-key org-mouse-map [follow-link] 'mouse-face)
- (when org-tab-follows-link
- (define-key org-mouse-map [(tab)] 'org-open-at-point)
- (define-key org-mouse-map "\C-i" 'org-open-at-point))
- (when org-return-follows-link
- (define-key org-mouse-map [(return)] 'org-open-at-point)
- (define-key org-mouse-map "\C-m" 'org-open-at-point))
- (require 'font-lock)
- (defconst org-non-link-chars "\t\n\r|<>\000")
- (defconst org-link-regexp
- (if org-allow-space-in-links
- (concat
- "\\(https?\\|ftp\\|mailto\\|file\\|news\\|bbdb\\|vm\\|wl\\|mhe\\|rmail\\|gnus\\|shell\\):\\([^" org-non-link-chars "]+[^ " org-non-link-chars "]\\)")
- (concat
- "\\(https?\\|ftp\\|mailto\\|file\\|news\\|bbdb\\|vm\\|wl\\|mhe\\|rmail\\|gnus\\|shell\\):\\([^ " org-non-link-chars "]+\\)")
- )
- "Regular expression for matching links.")
- (defconst org-link-maybe-angles-regexp
- (concat "<?\\(" org-link-regexp "\\)>?")
- "Matches a link and optionally surrounding angle brackets.")
- (defconst org-protected-link-regexp
- (concat "\000" org-link-regexp "\000")
- "Matches a link and optionally surrounding angle brackets.")
- (defconst org-bracket-link-regexp
- "\\[\\[\\([^]]+\\)\\]\\(\\[\\([^]]+\\)\\]\\)?\\]"
- "Matches a link in double brackets.")
- (defconst org-ts-lengths
- (cons (length (format-time-string (car org-time-stamp-formats)))
- (length (format-time-string (cdr org-time-stamp-formats))))
- "This holds the lengths of the two different time formats.")
- (defconst org-ts-regexp "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}[^\r\n>]*?\\)>"
- "Regular expression for fast time stamp matching.")
- (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}[^\r\n>]*?\\)[]>]"
- "Regular expression for fast time stamp matching.")
- (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\([^0-9>\r\n]*\\)\\(\\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
- "Regular expression matching time strings for analysis.")
- (defconst org-ts-regexp2 (concat "<" org-ts-regexp1 ">")
- "Regular expression matching time stamps, with groups.")
- (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
- "Regular expression matching a time stamp range.")
- (defconst org-tsr-regexp (concat org-ts-regexp "\\(--?-?"
- org-ts-regexp "\\)?")
- "Regular expression matching a time stamp or time stamp range.")
- (defun org-activate-links (limit)
- "Run through the buffer and add overlays to links."
- (if (re-search-forward org-link-regexp limit t)
- (progn
- (add-text-properties (match-beginning 0) (match-end 0)
- (list 'mouse-face 'highlight
- 'keymap org-mouse-map))
- t)))
- (defun org-activate-links2 (limit)
- "Run through the buffer and add overlays to links."
- (if (re-search-forward org-bracket-link-regexp limit t)
- (progn
- (add-text-properties (match-beginning 0) (match-end 0)
- (list 'mouse-face 'highlight
- 'keymap org-mouse-map))
- t)))
- (defun org-activate-dates (limit)
- "Run through the buffer and add overlays to dates."
- (if (re-search-forward org-tsr-regexp limit t)
- (progn
- (add-text-properties (match-beginning 0) (match-end 0)
- (list 'mouse-face 'highlight
- 'keymap org-mouse-map))
- t)))
- (defvar org-target-link-regexp nil
- "Regular expression matching radio targets in plain text.")
- (defvar org-target-regexp "<<\\([^<>\n\r]+\\)>>"
- "Regular expression matching a link target.")
- (defvar org-radio-target-regexp "<<<\\([^<>\n\r]+\\)>>>"
- "Regular expression matching a link target.")
- (defun org-activate-target-links (limit)
- "Run through the buffer and add overlays to target matches."
- (when (and org-radio-targets org-target-link-regexp)
- (let ((case-fold-search t))
- (if (re-search-forward org-target-link-regexp limit t)
- (progn
- (add-text-properties (match-beginning 0) (match-end 0)
- (list 'mouse-face 'highlight
- 'keymap org-mouse-map
- 'org-linked-text t))
- t)))))
- (defun org-update-radio-target-regexp ()
- "Find all radio targets in this file and update the regular expression."
- (interactive)
- (when org-radio-targets
- (setq org-target-link-regexp
- (org-make-target-link-regexp (org-all-targets 'radio)))
- (font-lock-mode -1)
- (font-lock-mode 1)))
- (defun org-all-targets (&optional radio)
- "Return a list of all targets in this file.
- With optional argument RADIO, only find radio targets."
- (let ((re (if radio org-radio-target-regexp org-target-regexp))
- rtn)
- (save-excursion
- (goto-char (point-min))
- (while (re-search-forward re nil t)
- (add-to-list 'rtn (downcase
- (if (fboundp 'match-string-no-properties)
- (match-string-no-properties 1)
- (match-string 1)))))
- rtn)))
- (defun org-make-target-link-regexp (targets)
- "Make regular expression matching all strings in TARGETS.
- The regular expression finds the targets also if there is a line break
- between words."
- (and targets
- (concat
- "\\<\\("
- (mapconcat
- (lambda (x)
- (while (string-match " +" x)
- (setq x (replace-match "\\s-+" t t x)))
- x)
- targets
- "\\|")
- "\\)\\>")))
- (defvar org-camel-regexp "\\*?\\<[A-Z]+[a-z]+[A-Z][a-zA-Z]*\\>"
- "Matches CamelCase words, possibly with a star before it.")
- (defun org-activate-camels (limit)
- "Run through the buffer and add overlays to dates."
- (if org-activate-camels
- (if (re-search-forward org-camel-regexp limit t)
- (progn
- (add-text-properties (match-beginning 0) (match-end 0)
- (list 'mouse-face 'highlight
- 'keymap org-mouse-map))
- t))))
- (defun org-activate-tags (limit)
- (if (re-search-forward "[ \t]\\(:[A-Za-z_@0-9:]+:\\)[ \r\n]" limit t)
- (progn
- (add-text-properties (match-beginning 1) (match-end 1)
- (list 'mouse-face 'highlight
- 'keymap org-mouse-map))
- t)))
- (defun org-font-lock-level ()
- (save-excursion
- (org-back-to-heading t)
- (- (match-end 0) (match-beginning 0))))
- (defun org-outline-level ()
- (save-excursion
- (looking-at outline-regexp)
- (if (match-beginning 1)
- (+ (org-get-string-indentation (match-string 1)) 1000)
- (- (match-end 0) (match-beginning 0)))))
- (defvar org-font-lock-keywords nil)
- (defun org-set-font-lock-defaults ()
- (let* ((em org-fontify-emphasized-text)
- (org-font-lock-extra-keywords
- (list
- '("^\\(\\**\\)\\(\\*\\)\\(.*\\)" (1 (org-get-level-face 1))
- (2 (org-get-level-face 2)) (3 (org-get-level-face 3)))
- '(org-activate-links (0 'org-link t))
- '(org-activate-links2 (0 'org-link t))
- '(org-activate-target-links (0 'org-link t))
- '(org-activate-dates (0 'org-link t))
- '(org-activate-camels (0 'org-link t))
- '(org-activate-tags (1 'org-tag t))
- (list (concat "^\\*+[ \t]*" org-not-done-regexp)
- '(1 'org-warning t))
- (list (concat "\\[#[A-Z]\\]") '(0 'org-special-keyword t))
- (list (concat "\\<" org-deadline-string) '(0 'org-special-keyword t))
- (list (concat "\\<" org-scheduled-string) '(0 'org-special-keyword t))
- (list (concat "\\<" org-closed-string) '(0 'org-special-keyword t))
- (if em '("\\(\\W\\|^\\)\\(\\*\\w+\\*\\)\\(\\W\\|$\\)" 2 'bold))
- (if em '("\\(\\W\\|^\\)\\(/\\w+/\\)\\(\\W\\|$\\)" 2 'italic))
- (if em '("\\(\\W\\|^\\)\\(_\\w+_\\)\\(\\W\\|$\\)" 2 'underline))
- (list (concat "^\\*+[ \t]*\\<\\(" org-comment-string
- "\\|" org-quote-string "\\)\\>")
- '(1 'org-special-keyword t))
- '("^#.*" (0 'font-lock-comment-face t))
- (if org-fontify-done-headline
- (list (concat "^[*]+ +\\<\\(" org-done-string "\\)\\(.*\\)\\>")
- '(1 'org-done t) '(2 'org-headline-done t))
- (list (concat "^[*]+ +\\<\\(" org-done-string "\\)\\>")
- '(1 'org-done t)))
- '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
- (1 'org-table t))
- '("^[ \t]*\\(:.*\\)" (1 'org-table t))
- '("| *\\(:?=[^|\n]*\\)" (1 'org-formula t))
- '("^[ \t]*| *\\([#!$*_^]\\) *|" (1 'org-formula t))
- )))
- (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
- ;; Now set the full font-lock-keywords
- (set (make-local-variable 'org-font-lock-keywords)
- org-font-lock-extra-keywords)
- (set (make-local-variable 'font-lock-defaults)
- '(org-font-lock-keywords t nil nil backward-paragraph))
- (kill-local-variable 'font-lock-keywords) nil))
- (defvar org-m nil)
- (defvar org-l nil)
- (defvar org-f nil)
- (defun org-get-level-face (n)
- "Get the right face for match N in font-lock matching of healdines."
- (setq org-l (- (match-end 2) (match-beginning 1)))
- (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
- ; (setq org-f (nth (1- (% org-l org-n-levels)) org-level-faces))
- (setq org-f (nth (% (1- org-l) org-n-levels) org-level-faces))
- (cond
- ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
- ((eq n 2) org-f)
- (t (if org-level-color-stars-only nil org-f))))
- (defun org-unfontify-region (beg end &optional maybe_loudly)
- "Remove fontification and activation overlays from links."
- (font-lock-default-unfontify-region beg end)
- (let* ((buffer-undo-list t)
- (inhibit-read-only t) (inhibit-point-motion-hooks t)
- (inhibit-modification-hooks t)
- deactivate-mark buffer-file-name buffer-file-truename)
- (remove-text-properties beg end
- '(mouse-face nil keymap nil org-linked-text nil))))
- ;;; Visibility cycling
- (defvar org-cycle-global-status nil)
- (defvar org-cycle-subtree-status nil)
- (defun org-cycle (&optional arg)
- "Visibility cycling for Org-mode.
- - When this function is called with a prefix argument, rotate the entire
- buffer through 3 states (global cycling)
- 1. OVERVIEW: Show only top-level headlines.
- 2. CONTENTS: Show all headlines of all levels, but no body text.
- 3. SHOW ALL: Show everything.
- - When point is at the beginning of a headline, rotate the subtree started
- by this line through 3 different states (local cycling)
- 1. FOLDED: Only the main headline is shown.
- 2. CHILDREN: The main headline and the direct children are shown.
- From this state, you can move to one of the children
- and zoom in further.
- 3. SUBTREE: Show the entire subtree, including body text.
- - When there is a numeric prefix, go up to a heading with level ARG, do
- a `show-subtree' and return to the previous cursor position. If ARG
- is negative, go up that many levels.
- - When point is not at the beginning of a headline, execute
- `indent-relative', like TAB normally does. See the option
- `org-cycle-emulate-tab' for details.
- - Special case: if point is the the beginning of the buffer and there is
- no headline in line 1, this function will act as if called with prefix arg."
- (interactive "P")
- (if (or (and (bobp) (not (looking-at outline-regexp)))
- (equal arg '(4)))
- ;; special case: use global cycling
- (setq arg t))
- (let ((outline-regexp
- (if org-cycle-include-plain-lists
- "\\*+\\|\\([ \t]*\\)\\([-+*]\\|[0-9]+[.)]\\) "
- outline-regexp)))
- (cond
- ((org-at-table-p 'any)
- ;; Enter the table or move to the next field in the table
- (or (org-table-recognize-table.el)
- (progn
- (org-table-justify-field-maybe)
- (org-table-next-field))))
- ((eq arg t) ;; Global cycling
- (cond
- ((and (eq last-command this-command)
- (eq org-cycle-global-status 'overview))
- ;; We just created the overview - now do table of contents
- ;; This can be slow in very large buffers, so indicate action
- (message "CONTENTS...")
- (save-excursion
- ;; Visit all headings and show their offspring
- (goto-char (point-max))
- (catch 'exit
- (while (and (progn (condition-case nil
- (outline-previous-visible-heading 1)
- (error (goto-char (point-min))))
- t)
- (looking-at outline-regexp))
- (show-branches)
- (if (bobp) (throw 'exit nil))))
- (message "CONTENTS...done"))
- (setq org-cycle-global-status 'contents)
- (run-hook-with-args 'org-cycle-hook 'contents))
- ((and (eq last-command this-command)
- (eq org-cycle-global-status 'contents))
- ;; We just showed the table of contents - now show everything
- (show-all)
- (message "SHOW ALL")
- (setq org-cycle-global-status 'all)
- (run-hook-with-args 'org-cycle-hook 'all))
- (t
- ;; Default action: go to overview
- (hide-sublevels 1)
- (message "OVERVIEW")
- (setq org-cycle-global-status 'overview)
- (run-hook-with-args 'org-cycle-hook 'overview))))
- ((integerp arg)
- ;; Show-subtree, ARG levels up from here.
- (save-excursion
- (org-back-to-heading)
- (outline-up-heading (if (< arg 0) (- arg)
- (- (funcall outline-level) arg)))
- (org-show-subtree)))
- ((save-excursion (beginning-of-line 1) (looking-at outline-regexp))
- ;; At a heading: rotate between three different views
- (org-back-to-heading)
- (let ((goal-column 0) eoh eol eos)
- ;; First, some boundaries
- (save-excursion
- (org-back-to-heading)
- (save-excursion
- (beginning-of-line 2)
- (while (and (not (eobp)) ;; this is like `next-line'
- (get-char-property (1- (point)) 'invisible))
- (beginning-of-line 2)) (setq eol (point)))
- (outline-end-of-heading) (setq eoh (point))
- (org-end-of-subtree t) (setq eos (point))
- (outline-next-heading))
- ;; Find out what to do next and set `this-command'
- (cond
- ((= eos eoh)
- ;; Nothing is hidden behind this heading
- (message "EMPTY ENTRY")
- (setq org-cycle-subtree-status nil))
- ((>= eol eos)
- ;; Entire subtree is hidden in one line: open it
- (org-show-entry)
- (show-children)
- (message "CHILDREN")
- (setq org-cycle-subtree-status 'children)
- (run-hook-with-args 'org-cycle-hook 'children))
- ((and (eq last-command this-command)
- (eq org-cycle-subtree-status 'children))
- ;; We just showed the children, now show everything.
- (org-show-subtree)
- (message "SUBTREE")
- (setq org-cycle-subtree-status 'subtree)
- (run-hook-with-args 'org-cycle-hook 'subtree))
- (t
- ;; Default action: hide the subtree.
- (hide-subtree)
- (message "FOLDED")
- (setq org-cycle-subtree-status 'folded)
- (run-hook-with-args 'org-cycle-hook 'folded)))))
- ;; TAB emulation
- (buffer-read-only (org-back-to-heading))
- ((if (and (eq org-cycle-emulate-tab 'white)
- (save-excursion (beginning-of-line 1) (looking-at "[ \t]+$")))
- t
- (eq org-cycle-emulate-tab t))
- (if (and (looking-at "[ \n\r\t]")
- (string-match "^[ \t]*$" (buffer-substring
- (point-at-bol) (point))))
- (progn
- (beginning-of-line 1)
- (and (looking-at "[ \t]+") (replace-match ""))))
- (indent-relative))
- (t (save-excursion
- (org-back-to-heading)
- (org-cycle))))))
- (defun org-optimize-window-after-visibility-change (state)
- "Adjust the window after a change in outline visibility.
- This function is the default value of the hook `org-cycle-hook'."
- (cond
- ((eq state 'overview) (org-first-headline-recenter 1))
- ((eq state 'content) nil)
- ((eq state 'all) nil)
- ((eq state 'folded) nil)
- ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
- ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1)))))
- (defun org-subtree-end-visible-p ()
- "Is the end of the current subtree visible?"
- (pos-visible-in-window-p
- (save-excursion (org-end-of-subtree t) (point))))
- (defun org-first-headline-recenter (&optional N)
- "Move cursor to the first headline and recenter the headline.
- Optional argument N means, put the headline into the Nth line of the window."
- (goto-char (point-min))
- (when (re-search-forward (concat "^" outline-regexp) nil t)
- (beginning-of-line)
- (recenter (prefix-numeric-value N))))
- (defvar org-goto-window-configuration nil)
- (defvar org-goto-marker nil)
- (defvar org-goto-map (make-sparse-keymap))
- (let ((cmds '(isearch-forward isearch-backward)) cmd)
- (while (setq cmd (pop cmds))
- (substitute-key-definition cmd cmd org-goto-map global-map)))
- (define-key org-goto-map "\C-m" 'org-goto-ret)
- (define-key org-goto-map [(left)] 'org-goto-left)
- (define-key org-goto-map [(right)] 'org-goto-right)
- (define-key org-goto-map [(?q)] 'org-goto-quit)
- (define-key org-goto-map [(control ?g)] 'org-goto-quit)
- (define-key org-goto-map "\C-i" 'org-cycle)
- (define-key org-goto-map [(tab)] 'org-cycle)
- (define-key org-goto-map [(down)] 'outline-next-visible-heading)
- (define-key org-goto-map [(up)] 'outline-previous-visible-heading)
- (define-key org-goto-map "n" 'outline-next-visible-heading)
- (define-key org-goto-map "p" 'outline-previous-visible-heading)
- (define-key org-goto-map "f" 'outline-forward-same-level)
- (define-key org-goto-map "b" 'outline-backward-same-level)
- (define-key org-goto-map "u" 'outline-up-heading)
- (define-key org-goto-map "\C-c\C-n" 'outline-next-visible-heading)
- (define-key org-goto-map "\C-c\C-p" 'outline-previous-visible-heading)
- (define-key org-goto-map "\C-c\C-f" 'outline-forward-same-level)
- (define-key org-goto-map "\C-c\C-b" 'outline-backward-same-level)
- (define-key org-goto-map "\C-c\C-u" 'outline-up-heading)
- (let ((l '(1 2 3 4 5 6 7 8 9 0)))
- (while l (define-key org-goto-map (int-to-string (pop l)) 'digit-argument)))
- (defconst org-goto-help
- "Select a location to jump to, press RET
- \[Up]/[Down]=next/prev headline TAB=cycle visibility RET=select [Q]uit")
- (defun org-goto ()
- "Go to a different location of the document, keeping current visibility.
- When you want to go to a different location in a document, the fastest way
- is often to fold the entire buffer and then dive into the tree. This
- method has the disadvantage, that the previous location will be folded,
- which may not be what you want.
- This command works around this by showing a copy of the current buffer in
- overview mode. You can dive into the tree in that copy, to find the
- location you want to reach. When pressing RET, the command returns to the
- original buffer in which the visibility is still unchanged. It then jumps
- to the new location, making it and the headline hierarchy above it visible."
- (interactive)
- (let* ((org-goto-start-pos (point))
- (selected-point
- (org-get-location (current-buffer) org-goto-help)))
- (if selected-point
- (progn
- (org-mark-ring-push org-goto-start-pos)
- (goto-char selected-point)
- (if (or (org-invisible-p) (org-invisible-p2))
- (org-show-hierarchy-above)))
- (error "Quit"))))
- (defun org-get-location (buf help)
- "Let the user select a location in the Org-mode buffer BUF.
- This function uses a recursive edit. It returns the selected position
- or nil."
- (let (org-selected-point)
- (save-excursion
- (save-window-excursion
- (delete-other-windows)
- (switch-to-buffer (get-buffer-create "*org-goto*"))
- (with-output-to-temp-buffer "*Help*"
- (princ help))
- (shrink-window-if-larger-than-buffer (get-buffer-window "*Help*"))
- (setq buffer-read-only nil)
- (erase-buffer)
- (insert-buffer-substring buf)
- (let ((org-startup-truncated t)
- (org-startup-folded t)
- (org-startup-with-deadline-check nil))
- (org-mode))
- (setq buffer-read-only t)
- (if (boundp 'org-goto-start-pos)
- (goto-char org-goto-start-pos)
- (goto-char (point-min)))
- (org-beginning-of-line)
- (message "Select location and press RET")
- ;; now we make sure that during selection, ony very few keys work
- ;; and that it is impossible to switch to another window.
- (let ((gm (current-global-map))
- (overriding-local-map org-goto-map))
- (unwind-protect
- (progn
- (use-global-map org-goto-map)
- (recursive-edit))
- (use-global-map gm)))))
- (kill-buffer "*org-goto*")
- org-selected-point))
- ;; FIXME: It may not be a good idea to temper with the prefix argument...
- (defun org-goto-ret (&optional arg)
- "Finish `org-goto' by going to the new location."
- (interactive "P")
- (setq org-selected-point (point)
- current-prefix-arg arg)
- (throw 'exit nil))
- (defun org-goto-left ()
- "Finish `org-goto' by going to the new location."
- (interactive)
- (if (org-on-heading-p)
- (progn
- (beginning-of-line 1)
- (setq org-selected-point (point)
- current-prefix-arg (- (match-end 0) (match-beginning 0)))
- (throw 'exit nil))
- (error "Not on a heading")))
- (defun org-goto-right ()
- "Finish `org-goto' by going to the new location."
- (interactive)
- (if (org-on-heading-p)
- (progn
- (outline-end-of-subtree)
- (or (eobp) (forward-char 1))
- (setq org-selected-point (point)
- current-prefix-arg (- (match-end 0) (match-beginning 0)))
- (throw 'exit nil))
- (error "Not on a heading")))
- (defun org-goto-quit ()
- "Finish `org-goto' without cursor motion."
- (interactive)
- (setq org-selected-point nil)
- (throw 'exit nil))
- ;;; Promotion, Demotion, Inserting new headlines
- (defvar org-ignore-region nil
- "To temporarily disable the active region.")
- (defun org-insert-heading (&optional force-heading)
- "Insert a new heading or item with same depth at point."
- (interactive "P")
- (when (or force-heading (not (org-insert-item)))
- (let* ((head (save-excursion
- (condition-case nil
- (org-back-to-heading)
- (error (outline-next-heading)))
- (prog1 (match-string 0)
- (funcall outline-level)))))
- (unless (bolp) (newline))
- (insert head)
- (unless (eolp)
- (save-excursion (newline-and-indent)))
- (unless (equal (char-before) ?\ )
- (insert " "))
- (run-hooks 'org-insert-heading-hook))))
- (defun org-insert-item ()
- "Insert a new item at the current level.
- Return t when things worked, nil when we are not in an item."
- (when (save-excursion
- (condition-case nil
- (progn
- (org-beginning-of-item)
- (org-at-item-p)
- t)
- (error nil)))
- (unless (bolp) (newline))
- (insert (match-string 0))
- (org-maybe-renumber-ordered-list)
- t))
- (defun org-insert-todo-heading (arg)
- "Insert a new heading with the same level and TODO state as current heading.
- If the heading has no TODO state, or if the state is DONE, use the first
- state (TODO by default). Also with prefix arg, force first state."
- (interactive "P")
- (org-insert-heading)
- (save-excursion
- (org-back-to-heading)
- (outline-previous-heading)
- (looking-at org-todo-line-regexp))
- (if (or arg
- (not (match-beginning 2))
- (equal (match-string 2) org-done-string))
- (insert (car org-todo-keywords) " ")
- (insert (match-string 2) " ")))
- (defun org-promote-subtree ()
- "Promote the entire subtree.
- See also `org-promote'."
- (interactive)
- (save-excursion
- (org-map-tree 'org-promote)))
- (defun org-demote-subtree ()
- "Demote the entire subtree. See `org-demote'.
- See also `org-promote'."
- (interactive)
- (save-excursion
- (org-map-tree 'org-demote)))
- (defun org-do-promote ()
- "Promote the current heading higher up the tree.
- If the region is active in `transient-mark-mode', promote all headings
- in the region."
- (interactive)
- (save-excursion
- (if (org-region-active-p)
- (org-map-region 'org-promote (region-beginning) (region-end))
- (org-promote)))
- (org-fix-position-after-promote))
- (defun org-do-demote ()
- "Demote the current heading lower down the tree.
- If the region is active in `transient-mark-mode', demote all headings
- in the region."
- (interactive)
- (save-excursion
- (if (org-region-active-p)
- (org-map-region 'org-demote (region-beginning) (region-end))
- (org-demote)))
- (org-fix-position-after-promote))
- (defun org-fix-position-after-promote ()
- "Make sure that after pro/demotion cursor position is right."
- (and (equal (char-after) ?\ )
- (equal (char-before) ?*)
- (forward-char 1)))
- (defun org-get-legal-level (level change)
- "Rectify a level change under the influence of `org-odd-levels-only'
- LEVEL is a current level, CHANGE is by how much the level should be
- modified. Even if CHANGE is nil, LEVEL may be returned modified because
- even level numbers will become the next higher odd number."
- (if org-odd-levels-only
- (cond ((not change) (1+ (* 2 (/ level 2))))
- ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
- ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
- (max 1 (+ level change))))
- (defun org-promote ()
- "Promote the current heading higher up the tree.
- If the region is active in `transient-mark-mode', promote all headings
- in the region."
- (org-back-to-heading t)
- (let* ((level (save-match-data (funcall outline-level)))
- (up-head (make-string (org-get-legal-level level -1) ?*))
- (diff (abs (- level (length up-head)))))
- (if (= level 1) (error "Cannot promote to level 0. UNDO to recover"))
- (replace-match up-head nil t)
- ;; Fixup tag positioning
- (and org-auto-align-tags (org-set-tags nil t))
- (if org-adapt-indentation
- (org-fixup-indentation (if (> diff 1) "^ " "^ ") ""
- (if (> diff 1) "^ ? ?\\S-" "^ ?\\S-")))))
- (defun org-demote ()
- "Demote the current heading lower down the tree.
- If the region is active in `transient-mark-mode', demote all headings
- in the region."
- (org-back-to-heading t)
- (let* ((level (save-match-data (funcall outline-level)))
- (down-head (make-string (org-get-legal-level level 1) ?*))
- (diff (abs (- level (length down-head)))))
- (replace-match down-head nil t)
- ;; Fixup tag positioning
- (and org-auto-align-tags (org-set-tags nil t))
- (if org-adapt-indentation
- (org-fixup-indentation "^ " (if (> diff 1) " " " ") "^\\S-"))))
- (defun org-map-tree (fun)
- "Call FUN for every heading underneath the current one."
- (org-back-to-heading)
- (let ((level (funcall outline-level)))
- (save-excursion
- (funcall fun)
- (while (and (progn
- (outline-next-heading)
- (> (funcall outline-level) level))
- (not (eobp)))
- (funcall fun)))))
- (defun org-map-region (fun beg end)
- "Call FUN for every heading between BEG and END."
- (let ((org-ignore-region t))
- (save-excursion
- (setq end (copy-marker end))
- (goto-char beg)
- (if (and (re-search-forward (concat "^" outline-regexp) nil t)
- (< (point) end))
- (funcall fun))
- (while (and (progn
- (outline-next-heading)
- (< (point) end))
- (not (eobp)))
- (funcall fun)))))
- (defun org-fixup-indentation (from to prohibit)
- "Change the indentation in the current entry by re-replacing FROM with TO.
- However, if the regexp PROHIBIT matches at all, don't do anything.
- This is being used to change indentation along with the length of the
- heading marker. But if there are any lines which are not indented, nothing
- is changed at all."
- (save-excursion
- (let ((end (save-excursion (outline-next-heading)
- (point-marker))))
- (unless (save-excursion (re-search-forward prohibit end t))
- (while (re-search-forward from end t)
- (replace-match to)
- (beginning-of-line 2)))
- (move-marker end nil))))
- ;;; Vertical tree motion, cutting and pasting of subtrees
- (defun org-move-subtree-up (&optional arg)
- "Move the current subtree up past ARG headlines of the same level."
- (interactive "p")
- (org-move-subtree-down (- (prefix-numeric-value arg))))
- (defun org-move-subtree-down (&optional arg)
- "Move the current subtree down past ARG headlines of the same level."
- (interactive "p")
- (setq arg (prefix-numeric-value arg))
- (let ((movfunc (if (> arg 0) 'outline-get-next-sibling
- 'outline-get-last-sibling))
- (ins-point (make-marker))
- (cnt (abs arg))
- beg end txt folded)
- ;; Select the tree
- (org-back-to-heading)
- (setq beg (point))
- (save-match-data
- (save-excursion (outline-end-of-heading)
- (setq folded (org-invisible-p)))
- (outline-end-of-subtree))
- (outline-next-heading)
- (setq end (point))
- ;; Find insertion point, with error handling
- (goto-char beg)
- (while (> cnt 0)
- (or (and (funcall movfunc) (looking-at outline-regexp))
- (progn (goto-char beg)
- (error "Cannot move past superior level or buffer limit")))
- (setq cnt (1- cnt)))
- (if (> arg 0)
- ;; Moving forward - still need to move over subtree
- (progn (outline-end-of-subtree)
- (outline-next-heading)
- (if (not (or (looking-at (concat "^" outline-regexp))
- (bolp)))
- (newline))))
- (move-marker ins-point (point))
- (setq txt (buffer-substring beg end))
- (delete-region beg end)
- (insert txt)
- (goto-char ins-point)
- (if folded (hide-subtree))
- (move-marker ins-point nil)))
- (defvar org-subtree-clip ""
- "Clipboard for cut and paste of subtrees.
- This is actually only a copy of the kill, because we use the normal kill
- ring. We need it to check if the kill was created by `org-copy-subtree'.")
- (defvar org-subtree-clip-folded nil
- "Was the last copied subtree folded?
- This is used to fold the tree back after pasting.")
- (defun org-cut-subtree ()
- "Cut the current subtree into the clipboard.
- This is a short-hand for marking the subtree and then cutting it."
- (interactive)
- (org-copy-subtree 'cut))
- (defun org-copy-subtree (&optional cut)
- "Cut the current subtree into the clipboard.
- This is a short-hand for marking the subtree and then copying it.
- If CUT is non nil, actually cut the subtree."
- (interactive)
- (let (beg end folded)
- (org-back-to-heading)
- (setq beg (point))
- (save-match-data
- (save-excursion (outline-end-of-heading)
- (setq folded (org-invisible-p)))
- (outline-end-of-subtree))
- (if (equal (char-after) ?\n) (forward-char 1))
- (setq end (point))
- (goto-char beg)
- (when (> end beg)
- (setq org-subtree-clip-folded folded)
- (if cut (kill-region beg end) (copy-region-as-kill beg end))
- (setq org-subtree-clip (current-kill 0))
- (message "%s: Subtree with %d characters"
- (if cut "Cut" "Copied")
- (length org-subtree-clip)))))
- (defun org-paste-subtree (&optional level tree)
- "Paste the clipboard as a subtree, with modification of headline level.
- The entire subtree is promoted or demoted in order to match a new headline
- level. By default, the new level is derived from the visible headings
- before and after the insertion point, and taken to be the inferior headline
- level of the two. So if the previous visible heading is level 3 and the
- next is level 4 (or vice versa), level 4 will be used for insertion.
- This makes sure that the subtree remains an independent subtree and does
- not swallow low level entries.
- You can also force a different level, either by using a numeric prefix
- argument, or by inserting the heading marker by hand. For example, if the
- cursor is after \"*****\", then the tree will be shifted to level 5.
- If you want to insert the tree as is, just use \\[yank].
- If optional TREE is given, use this text instead of the kill ring."
- (interactive "P")
- (unless (org-kill-is-subtree-p tree)
- (error
- (substitute-command-keys
- "The kill is not a (set of) tree(s) - please use \\[yank] to yank anyway")))
- (let* ((txt (or tree (current-kill 0)))
- (^re (concat "^\\(" outline-regexp "\\)"))
- (re (concat "\\(" outline-regexp "\\)"))
- (^re_ (concat "\\(" outline-regexp "\\)[ \t]*"))
- (old-level (if (string-match ^re txt)
- (- (match-end 0) (match-beginning 0))
- -1))
- (force-level (cond (level (prefix-numeric-value level))
- ((string-match
- ^re_ (buffer-substring (point-at-bol) (point)))
- (- (match-end 0) (match-beginning 0)))
- (t nil)))
- (previous-level (save-excursion
- (condition-case nil
- (progn
- (outline-previous-visible-heading 1)
- (if (looking-at re)
- (- (match-end 0) (match-beginning 0))
- 1))
- (error 1))))
- (next-level (save-excursion
- (condition-case nil
- (progn
- (outline-next-visible-heading 1)
- (if (looking-at re)
- (- (match-end 0) (match-beginning 0))
- 1))
- (error 1))))
- (new-level (or force-level (max previous-level next-level)))
- (shift (if (or (= old-level -1)
- (= new-level -1)
- (= old-level new-level))
- 0
- (- new-level old-level)))
- (shift1 shift)
- (delta (if (> shift 0) -1 1))
- (func (if (> shift 0) 'org-demote 'org-promote))
- (org-odd-levels-only nil)
- beg end)
- ;; Remove the forces level indicator
- (if force-level
- (delete-region (point-at-bol) (point)))
- ;; Make sure we start at the beginning of an empty line
- (if (not (bolp)) (insert "\n"))
- (if (not (looking-at "[ \t]*$"))
- (progn (insert "\n") (backward-char 1)))
- ;; Paste
- (setq beg (point))
- (insert txt)
- (setq end (point))
- (goto-char beg)
- ;; Shift if necessary
- (if (= shift 0)
- (message "Pasted at level %d, without shift" new-level)
- (save-restriction
- (narrow-to-region beg end)
- (while (not (= shift 0))
- (org-map-region func (point-min) (point-max))
- (setq shift (+ delta shift)))
- (goto-char (point-min))
- (message "Pasted at level %d, with shift by %d levels"
- new-level shift1)))
- (if (and (eq org-subtree-clip (current-kill 0))
- org-subtree-clip-folded)
- ;; The tree was folded before it was killed/copied
- (hide-subtree))))
- (defun org-kill-is-subtree-p (&optional txt)
- "Check if the current kill is an outline subtree, or a set of trees.
- Returns nil if kill does not start with a headline, or if the first
- headline level is not the largest headline level in the tree.
- So this will actually accept several entries of equal levels as well,
- which is OK for `org-paste-subtree'.
- If optional TXT is given, check this string instead of the current kill."
- (let* ((kill (or txt (current-kill 0) ""))
- (start-level (and (string-match (concat "\\`" outline-regexp) kill)
- (- (match-end 0) (match-beginning 0))))
- (re (concat "^" outline-regexp))
- (start 1))
- (if (not start-level)
- nil ;; does not even start with a heading
- (catch 'exit
- (while (setq start (string-match re kill (1+ start)))
- (if (< (- (match-end 0) (match-beginning 0)) start-level)
- (throw 'exit nil)))
- t))))
- ;;; Plain list items
- (defun org-at-item-p ()
- "Is point in a line starting a hand-formatted item?"
- (let ((llt org-plain-list-ordered-item-terminator))
- (save-excursion
- (goto-char (point-at-bol))
- (looking-at
- (cond
- ((eq llt t) "\\([ \t]*\\([-+]\\|\\([0-9]+[.)]\\)\\)\\|[ \t]+\\*\\)\\( \\|$\\)")
- ((= llt ?.) "\\([ \t]*\\([-+]\\|\\([0-9]+\\.\\)\\)\\|[ \t]+\\*\\)\\( \\|$\\)")
- ((= llt ?\)) "\\([ \t]*\\([-+]\\|\\([0-9]+)\\)\\)\\|[ \t]+\\*\\)\\( \\|$\\)")
- (t (error "Invalid value of `org-plain-list-ordered-item-terminator'")))))))
- (defun org-get-indentation ()
- "Get the indentation of the current line, interpreting tabs."
- (save-excursion
- (beginning-of-line 1)
- (skip-chars-forward " \t")
- (current-column)))
- (defun org-beginning-of-item ()
- "Go to the beginning of the current hand-formatted item.
- If the cursor is not in an item, throw an error."
- (let ((pos (point))
- (limit (save-excursion (org-back-to-heading)
- (beginning-of-line 2) (point)))
- ind ind1)
- (if (org-at-item-p)
- (beginning-of-line 1)
- (beginning-of-line 1)
- (skip-chars-forward " \t")
- (setq ind (current-column))
- (if (catch 'exit
- (while t
- (beginning-of-line 0)
- (if (< (point) limit) (throw 'exit nil))
- (unless (looking-at " \t]*$")
- (skip-chars-forward " \t")
- (setq ind1 (current-column))
- (if (< ind1 ind)
- (throw 'exit (org-at-item-p))))))
- nil
- (goto-char pos)
- (error "Not in an item")))))
- (defun org-end-of-item ()
- "Go to the end of the current hand-formatted item.
- If the cursor is not in an item, throw an error."
- (let ((pos (point))
- (limit (save-excursion (outline-next-heading) (point)))
- (ind (save-excursion
- (org-beginning-of-item)
- (skip-chars-forward " \t")
- (current-column)))
- ind1)
- (if (catch 'exit
- (while t
- (beginning-of-line 2)
- (if (>= (point) limit) (throw 'exit t))
- (unless (looking-at "[ \t]*$")
- (skip-chars-forward " \t")
- (setq ind1 (current-column))
- (if (<= ind1 ind) (throw 'exit t)))))
- (beginning-of-line 1)
- (goto-char pos)
- (error "Not in an item"))))
- (defun org-move-item-down (arg)
- "Move the plain list item at point down, i.e. swap with following item.
- Subitems (items with larger indentation) are considered part of the item,
- so this really moves item trees."
- (interactive "p")
- (let (beg end ind ind1 (pos (point)) txt)
- (org-beginning-of-item)
- (setq beg (point))
- (setq ind (org-get-indentation))
- (org-end-of-item)
- (setq end (point))
- (setq ind1 (org-get-indentation))
- (if (and (org-at-item-p) (= ind ind1))
- (progn
- (org-end-of-item)
- (setq txt (buffer-substring beg end))
- (save-excursion
- (delete-region beg end))
- (setq pos (point))
- (insert txt)
- (goto-char pos)
- (org-maybe-renumber-ordered-list))
- (goto-char pos)
- (error "Cannot move this item further down"))))
- (defun org-move-item-up (arg)
- "Move the plain list item at point up, i.e. swap with previous item.
- Subitems (items with larger indentation) are considered part of the item,
- so this really moves item trees."
- (interactive "p")
- (let (beg end ind ind1 (pos (point)) txt)
- (org-beginning-of-item)
- (setq beg (point))
- (setq ind (org-get-indentation))
- (org-end-of-item)
- (setq end (point))
- (goto-char beg)
- (catch 'exit
- (while t
- (beginning-of-line 0)
- (if (looking-at "[ \t]*$")
- nil
- (if (<= (setq ind1 (org-get-indentation)) ind)
- (throw 'exit t)))))
- (condition-case nil
- (org-beginning-of-item)
- (error (goto-char beg)
- (error "Cannot move this item further up")))
- (setq ind1 (org-get-indentation))
- (if (and (org-at-item-p) (= ind ind1))
- (progn
- (setq txt (buffer-substring beg end))
- (save-excursion
- (delete-region beg end))
- (setq pos (point))
- (insert txt)
- (goto-char pos)
- (org-maybe-renumber-ordered-list))
- (goto-char pos)
- (error "Cannot move this item further up"))))
- (defun org-maybe-renumber-ordered-list ()
- "Renumber the ordered list at point if setup allows it.
- This tests the user option `org-auto-renumber-ordered-lists' before
- doing the renumbering."
- (and org-auto-renumber-ordered-lists
- (org-at-item-p)
- (match-beginning 3)
- (org-renumber-ordered-list 1)))
- (defun org-get-string-indentation (s)
- "What indentation has S due to SPACE and TAB at the beginning of the string?"
- (let ((n -1) (i 0) (w tab-width) c)
- (catch 'exit
- (while (< (setq n (1+ n)) (length s))
- (setq c (aref s n))
- (cond ((= c ?\ ) (setq i (1+ i)))
- ((= c ?\t) (setq i (* (/ (+ w i) w) w)))
- (t (throw 'exit t)))))
- i))
- (defun org-renumber-ordered-list (arg)
- "Renumber an ordered plain list.
- Cursor next to be in the first line of an item, the line that starts
- with something like \"1.\" or \"2)\"."
- (interactive "p")
- (unless (and (org-at-item-p)
- (match-beginning 3))
- (error "This is not an ordered list"))
- (let ((line (org-current-line))
- (col (current-column))
- (ind (org-get-string-indentation
- (buffer-substring (point-at-bol) (match-beginning 3))))
- ;; (term (substring (match-string 3) -1))
- ind1 (n (1- arg)))
- ;; find where this list begins
- (catch 'exit
- (while t
- (catch 'next
- (beginning-of-line 0)
- (if (looking-at "[ \t]*$") (throw 'next t))
- (skip-chars-forward " \t") (setq ind1 (current-column))
- (if (or (< ind1 ind)
- (and (= ind1 ind)
- (not (org-at-item-p))))
- (throw 'exit t)))))
- ;; Walk forward and replace these numbers
- (catch 'exit
- (while t
- (catch 'next
- (beginning-of-line 2)
- (if (eobp) (throw 'exit nil))
- (if (looking-at "[ \t]*$") (throw 'next nil))
- (skip-chars-forward " \t") (setq ind1 (current-column))
- (if (> ind1 ind) (throw 'next t))
- (if (< ind1 ind) (throw 'exit t))
- (if (not (org-at-item-p)) (throw 'exit nil))
- (if (not (match-beginning 3))
- (error "unordered bullet in ordered list. Press \\[undo] to recover"))
- (delete-region (match-beginning 3) (1- (match-end 3)))
- (goto-char (match-beginning 3))
- (insert (format "%d" (setq n (1+ n)))))))
- (goto-line line)
- (move-to-column col)))
- (defvar org-last-indent-begin-marker (make-marker))
- (defvar org-last-indent-end-marker (make-marker))
- (defun org-outdent-item (arg)
- "Outdent a local list item."
- (interactive "p")
- (org-indent-item (- arg)))
- (defun org-indent-item (arg)
- "Indent a local list item."
- (interactive "p")
- (unless (org-at-item-p)
- (error "Not on an item"))
- (let (beg end ind ind1)
- (if (memq last-command '(org-shiftmetaright org-shiftmetaleft))
- (setq beg org-last-indent-begin-marker
- end org-last-indent-end-marker)
- (org-beginning-of-item)
- (setq beg (move-marker org-last-indent-begin-marker (point)))
- (org-end-of-item)
- (setq end (move-marker org-last-indent-end-marker (point))))
- (goto-char beg)
- (skip-chars-forward " \t") (setq ind (current-column))
- (if (< (+ arg ind) 0) (error "Cannot outdent beyond margin"))
- (while (< (point) end)
- (beginning-of-line 1)
- (skip-chars-forward " \t") (setq ind1 (current-column))
- (delete-region (point-at-bol) (point))
- (indent-to-column (+ ind1 arg))
- (beginning-of-line 2))
- (goto-char beg)))
- ;;; Archiving
- (defun org-archive-subtree ()
- "Move the current subtree to the archive.
- The archive can be a certain top-level heading in the current file, or in
- a different file. The tree will be moved to that location, the subtree
- heading be marked DONE, and the current time will be added."
- (interactive)
- ;; Save all relevant TODO keyword-relatex variables
- (let ((tr-org-todo-line-regexp org-todo-line-regexp) ; keep despite compiler
- (tr-org-todo-keywords org-todo-keywords)
- (tr-org-todo-interpretation org-todo-interpretation)
- (tr-org-done-string org-done-string)
- (tr-org-todo-regexp org-todo-regexp)
- (tr-org-todo-line-regexp org-todo-line-regexp)
- (this-buffer (current-buffer))
- file heading buffer level newfile-p)
- (if (string-match "\\(.*\\)::\\(.*\\)" org-archive-location)
- (progn
- (setq file (format (match-string 1 org-archive-location)
- (file-name-nondirectory buffer-file-name))
- heading (match-string 2 org-archive-location)))
- (error "Invalid `org-archive-location'"))
- (if (> (length file) 0)
- (setq newfile-p (not (file-exists-p file))
- buffer (find-file-noselect file))
- (setq buffer (current-buffer)))
- (unless buffer
- (error "Cannot access file \"%s\"" file))
- (if (and (> (length heading) 0)
- (string-match "^\\*+" heading))
- (setq level (match-end 0))
- (setq heading nil level 0))
- (save-excursion
- ;; We first only copy, in case something goes wrong
- ;; we need to protect this-command, to avoid kill-region sets it,
- ;; which would lead to duplication of subtrees
- (let (this-command) (org-copy-subtree))
- (set-buffer buffer)
- ;; Enforce org-mode for the archive buffer
- (if (not (eq major-mode 'org-mode))
- ;; Force the mode for future visits.
- (let ((org-insert-mode-line-in-empty-file t))
- (call-interactively 'org-mode)))
- (when newfile-p
- (goto-char (point-max))
- (insert (format "\nArchived entries from file %s\n\n"
- (buffer-file-name this-buffer))))
- ;; Force the TODO keywords of the original buffer
- (let ((org-todo-line-regexp tr-org-todo-line-regexp)
- (org-todo-keywords tr-org-todo-keywords)
- (org-todo-interpretation tr-org-todo-interpretation)
- (org-done-string tr-org-done-string)
- (org-todo-regexp tr-org-todo-regexp)
- (org-todo-line-regexp tr-org-todo-line-regexp))
- (goto-char (point-min))
- (if heading
- (progn
- (if (re-search-forward
- (concat "\\(^\\|\r\\)"
- (regexp-quote heading) "[ \t]*\\($\\|\r\\)")
- nil t)
- (goto-char (match-end 0))
- ;; Heading not found, just insert it at the end
- (goto-char (point-max))
- (or (bolp) (insert "\n"))
- (insert "\n" heading "\n")
- (end-of-line 0))
- ;; Make the heading visible, and the following as well
- (let ((org-show-following-heading t)) (org-show-hierarchy-above))
- (if (re-search-forward
- (concat "^" (regexp-quote (make-string level ?*)) "[ \t]")
- nil t)
- (progn (goto-char (match-beginning 0)) (insert "\n")
- (beginning-of-line 0))
- (goto-char (point-max)) (insert "\n")))
- (goto-char (point-max)) (insert "\n"))
- ;; Paste
- (org-paste-subtree (1+ level))
- ;; Mark the entry as done, i.e. set to last work in org-todo-keywords
- (if org-archive-mark-done
- (org-todo (length org-todo-keywords)))
- ;; Move cursor to right after the TODO keyword
- (when org-archive-stamp-time
- (beginning-of-line 1)
- (looking-at org-todo-line-regexp)
- (goto-char (or (match-end 2) (match-beginning 3)))
- (insert "(" (format-time-string (cdr org-time-stamp-formats)
- (org-current-time))
- ")"))
- ;; Save the buffer, if it is not the same buffer.
- (if (not (eq this-buffer buffer)) (save-buffer))))
- ;; Here we are back in the original buffer. Everything seems to have
- ;; worked. So now cut the tree and finish up.
- (let (this-command) (org-cut-subtree))
- (if (looking-at "[ \t]*$") (kill-line))
- (message "Subtree archived %s"
- (if (eq this-buffer buffer)
- (concat "under heading: " heading)
- (concat "in file: " (abbreviate-file-name file))))))
- ;;; Completion
- (defun org-complete (&optional arg)
- "Perform completion on word at point.
- At the beginning of a headline, this completes TODO keywords as given in
- `org-todo-keywords'.
- If the current word is preceded by a backslash, completes the TeX symbols
- that are supported for HTML support.
- If the current word is preceded by \"#+\", completes special words for
- setting file options.
- At all other locations, this simply calls `ispell-complete-word'."
- (interactive "P")
- (catch 'exit
- (let* ((end (point))
- (beg1 (save-excursion
- (if (equal (char-before (point)) ?\ ) (backward-char 1))
- (skip-chars-backward "a-zA-Z_@0-9")
- (point)))
- (beg (save-excursion
- (if (equal (char-before (point)) ?\ ) (backward-char 1))
- (skip-chars-backward "a-zA-Z0-9_:$")
- (point)))
- (camel (equal (char-before beg) ?*))
- (tag (equal (char-before beg1) ?:))
- (texp (equal (char-before beg) ?\\))
- (opt (equal (buffer-substring (max (point-at-bol) (- beg 2))
- beg)
- "#+"))
- (completion-ignore-case opt)
- (type nil)
- (tbl nil)
- (table (cond
- (opt
- (setq type :opt)
- (mapcar (lambda (x)
- (string-match "^#\\+\\(\\([A-Z_]+:?\\).*\\)" x)
- (cons (match-string 2 x) (match-string 1 x)))
- (org-split-string (org-get-current-options) "\n")))
- (texp
- (setq type :tex)
- org-html-entities)
- ((string-match "\\`\\*+[ \t]*\\'"
- (buffer-substring (point-at-bol) beg))
- (setq type :todo)
- (mapcar 'list org-todo-keywords))
- (camel
- (setq type :camel)
- (save-excursion
- (goto-char (point-min))
- (while (re-search-forward org-todo-line-regexp nil t)
- (push (list
- (if org-file-link-context-use-camel-case
- (org-make-org-heading-camel (match-string 3) t)
- (org-make-org-heading-search-string
- (match-string 3) t)))
- tbl)))
- tbl)
- (tag (setq type :tag beg beg1)
- (org-get-buffer-tags))
- (t (progn (ispell-complete-word arg) (throw 'exit nil)))))
- (pattern (buffer-substring-no-properties beg end))
- (completion (try-completion pattern table)))
- (cond ((eq completion t)
- (if (equal type :opt)
- (insert (substring (cdr (assoc (upcase pattern) table))
- (length pattern)))))
- ((null completion)
- (message "Can't find completion for \"%s\"" pattern)
- (ding))
- ((not (string= pattern completion))
- (delete-region beg end)
- (if (string-match " +$" completion)
- (setq completion (replace-match "" t t completion)))
- (insert completion)
- (if (get-buffer-window "*Completions*")
- (delete-window (get-buffer-window "*Completions*")))
- (if (assoc completion table)
- (if (eq type :todo) (insert " ")
- (if (eq type :tag) (insert ":"))))
- (if (and (equal type :opt) (assoc completion table))
- (message "%s" (substitute-command-keys
- "Press \\[org-complete] again to insert example settings"))))
- (t
- (message "Making completion list...")
- (let ((list (sort (all-completions pattern table) 'string<)))
- (with-output-to-temp-buffer "*Completions*"
- (condition-case nil
- ;; Protection needed for XEmacs and emacs 21
- (display-completion-list list pattern)
- (error (display-completion-list list)))))
- (message "Making completion list...%s" "done"))))))
- ;;; Comments, TODO and DEADLINE
- (defun org-toggle-comment ()
- "Change the COMMENT state of an entry."
- (interactive)
- (save-excursion
- (org-back-to-heading)
- (if (looking-at (concat outline-regexp
- "\\( +\\<" org-comment-string "\\>\\)"))
- (replace-match "" t t nil 1)
- (if (looking-at outline-regexp)
- (progn
- (goto-char (match-end 0))
- (insert " " org-comment-string))))))
- (defvar org-last-todo-state-is-todo nil
- "This is non-nil when the last TODO state change led to a TODO state.
- If the last change removed the TODO tag or switched to DONE, then
- this is nil.")
- (defun org-todo (&optional arg)
- "Change the TODO state of an item.
- The state of an item is given by a keyword at the start of the heading,
- like
- *** TODO Write paper
- *** DONE Call mom
- The different keywords are specified in the variable `org-todo-keywords'.
- By default the available states are \"TODO\" and \"DONE\".
- So for this example: when the item starts with TODO, it is changed to DONE.
- When it starts with DONE, the DONE is removed. And when neither TODO nor
- DONE are present, add TODO at the beginning of the heading.
- With prefix arg, use completion to determine the new state. With numeric
- prefix arg, switch to that state."
- (interactive "P")
- (save-excursion
- (org-back-to-heading)
- (if (looking-at outline-regexp) (goto-char (match-end 0)))
- (or (looking-at (concat " +" org-todo-regexp " *"))
- (looking-at " *"))
- (let* ((this (match-string 1))
- (completion-ignore-case t)
- (member (member this org-todo-keywords))
- (tail (cdr member))
- (state (cond
- ((equal arg '(4))
- ;; Read a state with completion
- (completing-read "State: " (mapcar (lambda(x) (list x))
- org-todo-keywords)
- nil t))
- ((eq arg 'right)
- (if this
- (if tail (car tail) nil)
- (car org-todo-keywords)))
- ((eq arg 'left)
- (if (equal member org-todo-keywords)
- nil
- (if this
- (nth (- (length org-todo-keywords) (length tail) 2)
- org-todo-keywords)
- org-done-string)))
- (arg
- ;; user requests a specific state
- (nth (1- (prefix-numeric-value arg))
- org-todo-keywords))
- ((null member) (car org-todo-keywords))
- ((null tail) nil) ;; -> first entry
- ((eq org-todo-interpretation 'sequence)
- (car tail))
- ((memq org-todo-interpretation '(type priority))
- (if (eq this-command last-command)
- (car tail)
- (if (> (length tail) 0) org-done-string nil)))
- (t nil)))
- (next (if state (concat " " state " ") " ")))
- (replace-match next t t)
- (setq org-last-todo-state-is-todo
- (not (equal state org-done-string)))
- (when org-log-done
- (if (equal state org-done-string)
- (org-log-done)
- (if (not this)
- (org-log-done t))))
- ;; Fixup tag positioning
- (and org-auto-align-tags (org-set-tags nil t))
- (run-hooks 'org-after-todo-state-change-hook)))
- ;; Fixup cursor location if close to the keyword
- (if (and (outline-on-heading-p)
- (not (bolp))
- (save-excursion (beginning-of-line 1)
- (looking-at org-todo-line-regexp))
- (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
- (progn
- (goto-char (or (match-end 2) (match-end 1)))
- (just-one-space))))
- (defun org-log-done (&optional undone)
- "Add a time stamp logging that a TODO entry has been closed.
- When UNDONE is non-nil, remove such a time stamp again."
- (interactive)
- (let (beg end col)
- (save-excursion
- (org-back-to-heading t)
- (setq beg (point))
- (looking-at (concat outline-regexp " *"))
- (goto-char (match-end 0))
- (setq col (current-column))
- (outline-next-heading)
- (setq end (point))
- (goto-char beg)
- (when (re-search-forward (concat
- "[\r\n]\\([ \t]*"
- (regexp-quote org-closed-string)
- " *\\[.*?\\][^\n\r]*[\n\r]?\\)") end t)
- (delete-region (match-beginning 1) (match-end 1)))
- (unless undone
- (org-back-to-heading t)
- (skip-chars-forward "^\n\r")
- (goto-char (min (1+ (point)) (point-max)))
- (when (not (member (char-before) '(?\r ?\n)))
- (insert "\n"))
- (indent-to col)
- (insert org-closed-string " "
- (format-time-string
- (concat "[" (substring (cdr org-time-stamp-formats) 1 -1) "]")
- (org-current-time))
- "\n")))))
- (defun org-show-todo-tree (arg)
- "Make a compact tree which shows all headlines marked with TODO.
- The tree will show the lines where the regexp matches, and all higher
- headlines above the match.
- With \\[universal-argument] prefix, also show the DONE entries.
- With a numeric prefix N, construct a sparse tree for the Nth element
- of `org-todo-keywords'."
- (interactive "P")
- (let ((case-fold-search nil)
- (kwd-re
- (cond ((null arg) org-not-done-regexp)
- ((equal arg '(4)) org-todo-regexp)
- ((<= (prefix-numeric-value arg) (length org-todo-keywords))
- (regexp-quote (nth (1- (prefix-numeric-value arg))
- org-todo-keywords)))
- (t (error "Invalid prefix argument: %s" arg)))))
- (message "%d TODO entries found"
- (org-occur (concat "^" outline-regexp " +" kwd-re )))))
- (defun org-deadline ()
- "Insert the DEADLINE: string to make a deadline.
- A timestamp is also inserted - use \\[org-timestamp-up] and \\[org-timestamp-down]
- to modify it to the correct date."
- (interactive)
- (insert
- org-deadline-string " "
- (format-time-string (car org-time-stamp-formats)
- (org-read-date nil 'to-time)))
- (message "%s" (substitute-command-keys
- "Use \\[org-timestamp-up-day] and \\[org-timestamp-down-day] to change the date.")))
- (defun org-schedule ()
- "Insert the SCHEDULED: string to schedule a TODO item.
- A timestamp is also inserted - use \\[org-timestamp-up] and \\[org-timestamp-down]
- to modify it to the correct date."
- (interactive)
- (insert
- org-scheduled-string " "
- (format-time-string (car org-time-stamp-formats)
- (org-read-date nil 'to-time)))
- (message "%s" (substitute-command-keys
- "Use \\[org-timestamp-up-day] and \\[org-timestamp-down-day] to change the date.")))
- (defun org-occur (regexp &optional callback)
- "Make a compact tree which shows all matches of REGEXP.
- The tree will show the lines where the regexp matches, and all higher
- headlines above the match. It will also show the heading after the match,
- to make sure editing the matching entry is easy.
- If CALLBACK is non-nil, it is a function which is called to confirm
- that the match should indeed be shown."
- (interactive "sRegexp: ")
- (org-remove-occur-highlights nil nil t)
- (setq regexp (org-check-occur-regexp regexp))
- (let ((cnt 0))
- (save-excursion
- (goto-char (point-min))
- (hide-sublevels 1)
- (while (re-search-forward regexp nil t)
- (when (or (not callback)
- (save-match-data (funcall callback)))
- (setq cnt (1+ cnt))
- (org-highlight-new-match (match-beginning 0) (match-end 0))
- (org-show-hierarchy-above))))
- (org-add-hook 'before-change-functions 'org-remove-occur-highlights
- nil 'local)
- (run-hooks 'org-occur-hook)
- (if (interactive-p)
- (message "%d match(es) for regexp %s" cnt regexp))
- cnt))
- (defun org-show-hierarchy-above ()
- "Make sure point and the headings hierarchy above is visible."
- (catch 'exit
- (if (org-on-heading-p t)
- (org-flag-heading nil) ; only show the heading
- (and (or (org-invisible-p) (org-invisible-p2))
- (org-show-hidden-entry))) ; show entire entry
- (save-excursion
- (and org-show-following-heading
- (outline-next-heading)
- (org-flag-heading nil))) ; show the next heading
- (when org-show-hierarchy-above
- (save-excursion ; show all higher headings
- (while (and (condition-case nil
- (progn (org-up-heading-all 1) t)
- (error nil))
- (not (bobp)))
- (org-flag-heading nil))))))
- ;; Overlay compatibility functions
- (defun org-make-overlay (beg end &optional buffer)
- (if (featurep 'xemacs)
- (make-extent beg end buffer)
- (make-overlay beg end buffer)))
- (defun org-delete-overlay (ovl)
- (if (featurep 'xemacs) (delete-extent ovl) (delete-overlay ovl)))
- (defun org-detatch-overlay (ovl)
- (if (featurep 'xemacs) (detach-extent ovl) (delete-overlay ovl)))
- (defun org-move-overlay (ovl beg end &optional buffer)
- (if (featurep 'xemacs)
- (set-extent-endpoints ovl beg end buffer)
- (move-overlay ovl beg end buffer)))
- (defun org-overlay-put (ovl prop value)
- (if (featurep 'xemacs)
- (set-extent-property ovl prop value)
- (overlay-put ovl prop value)))
- (defvar org-occur-highlights nil)
- (defun org-highlight-new-match (beg end)
- "Highlight from BEG to END and mark the highlight is an occur headline."
- (let ((ov (org-make-overlay beg end)))
- (org-overlay-put ov 'face 'secondary-selection)
- (push ov org-occur-highlights)))
- (defun org-remove-occur-highlights (&optional beg end noremove)
- "Remove the occur highlights from the buffer.
- BEG and END are ignored. If NOREMOVE is nil, remove this function
- from the `before-change-functions' in the current buffer."
- (interactive)
- (mapc 'org-delete-overlay org-occur-highlights)
- (setq org-occur-highlights nil)
- (unless noremove
- (remove-hook 'before-change-functions
- 'org-remove-occur-highlights 'local)))
- ;;; Priorities
- (defvar org-priority-regexp ".*?\\(\\[#\\([A-Z]\\)\\] ?\\)"
- "Regular expression matching the priority indicator.")
- (defvar org-remove-priority-next-time nil)
- (defun org-priority-up ()
- "Increase the priority of the current item."
- (interactive)
- (org-priority 'up))
- (defun org-priority-down ()
- "Decrease the priority of the current item."
- (interactive)
- (org-priority 'down))
- (defun org-priority (&optional action)
- "Change the priority of an item by ARG.
- ACTION can be set, up, or down."
- (interactive)
- (setq action (or action 'set))
- (let (current new news have remove)
- (save-excursion
- (org-back-to-heading)
- (if (looking-at org-priority-regexp)
- (setq current (string-to-char (match-string 2))
- have t)
- (setq current org-default-priority))
- (cond
- ((eq action 'set)
- (message "Priority A-%c, SPC to remove: " org-lowest-priority)
- (setq new (read-char-exclusive))
- (cond ((equal new ?\ ) (setq remove t))
- ((or (< (upcase new) ?A) (> (upcase new) org-lowest-priority))
- (error "Priority must be between `%c' and `%c'"
- ?A org-lowest-priority))))
- ((eq action 'up)
- (setq new (1- current)))
- ((eq action 'down)
- (setq new (1+ current)))
- (t (error "Invalid action")))
- (setq new (min (max ?A (upcase new)) org-lowest-priority))
- (setq news (format "%c" new))
- (if have
- (if remove
- (replace-match "" t t nil 1)
- (replace-match news t t nil 2))
- (if remove
- (error "No priority cookie found in line")
- (looking-at org-todo-line-regexp)
- (if (match-end 2)
- (progn
- (goto-char (match-end 2))
- (insert " [#" news "]"))
- (goto-char (match-beginning 3))
- (insert "[#" news "] ")))))
- (if remove
- (message "Priority removed")
- (message "Priority of current item set to %s" news))))
- (defun org-get-priority (s)
- "Find priority cookie and return priority."
- (save-match-data
- (if (not (string-match org-priority-regexp s))
- (* 1000 (- org-lowest-priority org-default-priority))
- (* 1000 (- org-lowest-priority
- (string-to-char (match-string 2 s)))))))
- ;;; Timestamps
- (defvar org-last-changed-timestamp nil)
- (defun org-time-stamp (arg)
- "Prompt for a date/time and insert a time stamp.
- If the user specifies a time like HH:MM, or if this command is called
- with a prefix argument, the time stamp will contain date and time.
- Otherwise, only the date will be included. All parts of a date not
- specified by the user will be filled in from the current date/time.
- So if you press just return without typing anything, the time stamp
- will represent the current date/time. If there is already a timestamp
- at the cursor, it will be modified."
- (interactive "P")
- (let ((fmt (if arg (cdr org-time-stamp-formats)
- (car org-time-stamp-formats)))
- (org-time-was-given nil)
- time)
- (cond
- ((and (org-at-timestamp-p)
- (eq last-command 'org-time-stamp)
- (eq this-command 'org-time-stamp))
- (insert "--")
- (setq time (let ((this-command this-command))
- (org-read-date arg 'totime)))
- (if org-time-was-given (setq fmt (cdr org-time-stamp-formats)))
- (insert (format-time-string fmt time)))
- ((org-at-timestamp-p)
- (setq time (let ((this-command this-command))
- (org-read-date arg 'totime)))
- (and (org-at-timestamp-p) (replace-match
- (setq org-last-changed-timestamp
- (format-time-string fmt time))
- t t))
- (message "Timestamp updated"))
- (t
- (setq time (let ((this-command this-command))
- (org-read-date arg 'totime)))
- (if org-time-was-given (setq fmt (cdr org-time-stamp-formats)))
- (insert (format-time-string fmt time))))))
- (defun org-time-stamp-inactive (&optional arg)
- "Insert an inactive time stamp.
- An inactive time stamp is enclosed in square brackets instead of angle
- brackets. It is inactive in the sense that it does not trigger agenda entries,
- does not link to the calendar and cannot be changed with the S-cursor keys.
- So these are more for recording a certain time/date."
- ;; FIXME: Would it be better not to ask for a date/time here?
- (interactive "P")
- (let ((fmt (if arg (cdr org-time-stamp-formats)
- (car org-time-stamp-formats)))
- (org-time-was-given nil)
- time)
- (setq time (org-read-date arg 'totime))
- (if org-time-was-given (setq fmt (cdr org-time-stamp-formats)))
- (setq fmt (concat "[" (substring fmt 1 -1) "]"))
- (insert (format-time-string fmt time))))
- (defvar org-date-ovl (org-make-overlay 1 1))
- (org-overlay-put org-date-ovl 'face 'org-warning)
- (org-detatch-overlay org-date-ovl)
- ;;; FIXME: Make the function take "Fri" as "next friday"
- ;;; because these are mostly being used to record the current time.
- (defun org-read-date (&optional with-time to-time)
- "Read a date and make things smooth for the user.
- The prompt will suggest to enter an ISO date, but you can also enter anything
- which will at least partially be understood by `parse-time-string'.
- Unrecognized parts of the date will default to the current day, month, year,
- hour and minute. For example,
- 3-2-5 --> 2003-02-05
- feb 15 --> currentyear-02-15
- sep 12 9 --> 2009-09-12
- 12:45 --> today 12:45
- 22 sept 0:34 --> currentyear-09-22 0:34
- 12 --> currentyear-currentmonth-12
- etc.
- The function understands only English month and weekday abbreviations,
- but this can be configured with the variables `parse-time-months' and
- `parse-time-weekdays'.
- While prompting, a calendar is popped up - you can also select the
- date with the mouse (button 1). The calendar shows a period of three
- months. To scroll it to other months, use the keys `>' and `<'.
- If you don't like the calendar, turn it off with
- \(setq org-popup-calendar-for-date-prompt nil)
- With optional argument TO-TIME, the date will immediately be converted
- to an internal time.
- With an optional argument WITH-TIME, the prompt will suggest to also
- insert a time. Note that when WITH-TIME is not set, you can still
- enter a time, and this function will inform the calling routine about
- this change. The calling routine may then choose to change the format
- used to insert the time stamp into the buffer to include the time."
- (require 'parse-time)
- (let* ((org-time-stamp-rounding-minutes
- (if (equal with-time '(16)) 0 org-time-stamp-rounding-minutes))
- (ct (org-current-time))
- (default-time
- ;; Default time is either today, or, when entering a range,
- ;; the range start.
- (if (save-excursion
- (re-search-backward
- (concat org-ts-regexp "--\\=")
- (- (point) 20) t))
- (apply
- 'encode-time
- (mapcar (lambda(x) (or x 0)) ;; FIXME: Problem with timezone?
- (parse-time-string (match-string 1))))
- ct))
- (calendar-move-hook nil)
- (view-diary-entries-initially nil)
- (timestr (format-time-string
- (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") default-time))
- (prompt (format "YYYY-MM-DD [%s]: " timestr))
- ans ans1 ans2
- second minute hour day month year tl)
- (if org-popup-calendar-for-date-prompt
- ;; Also show a calendar for date selection
- ;; Copied (with modifications) from planner.el by John Wiegley
- (save-excursion
- (save-window-excursion
- (calendar)
- (calendar-forward-day (- (time-to-days default-time)
- (calendar-absolute-from-gregorian
- (calendar-current-date))))
- (org-eval-in-calendar nil)
- (let* ((old-map (current-local-map))
- (map (copy-keymap calendar-mode-map))
- (minibuffer-local-map (copy-keymap minibuffer-local-map)))
- (define-key map (kbd "RET") 'org-calendar-select)
- (define-key map (if (featurep 'xemacs) [button1] [mouse-1])
- 'org-calendar-select-mouse)
- (define-key map (if (featurep 'xemacs) [button2] [mouse-2])
- 'org-calendar-select-mouse)
- (define-key minibuffer-local-map [(meta shift left)]
- (lambda () (interactive)
- (org-eval-in-calendar '(calendar-backward-month 1))))
- (define-key minibuffer-local-map [(meta shift right)]
- (lambda () (interactive)
- (org-eval-in-calendar '(calendar-forward-month 1))))
- (define-key minibuffer-local-map [(shift up)]
- (lambda () (interactive)
- (org-eval-in-calendar '(calendar-backward-week 1))))
- (define-key minibuffer-local-map [(shift down)]
- (lambda () (interactive)
- (org-eval-in-calendar '(calendar-forward-week 1))))
- (define-key minibuffer-local-map [(shift left)]
- (lambda () (interactive)
- (org-eval-in-calendar '(calendar-backward-day 1))))
- (define-key minibuffer-local-map [(shift right)]
- (lambda () (interactive)
- (org-eval-in-calendar '(calendar-forward-day 1))))
- (define-key minibuffer-local-map ">"
- (lambda () (interactive)
- (org-eval-in-calendar '(scroll-calendar-left 1))))
- (define-key minibuffer-local-map "<"
- (lambda () (interactive)
- (org-eval-in-calendar '(scroll-calendar-right 1))))
- (unwind-protect
- (progn
- (use-local-map map)
- (setq ans (read-string prompt "" nil nil))
- (if (not (string-match "\\S-" ans)) (setq ans nil))
- (setq ans (or ans1 ans ans2)))
- (use-local-map old-map)))))
- ;; Naked prompt only
- (setq ans (read-string prompt "" nil timestr)))
- (org-detatch-overlay org-date-ovl)
- (if (string-match
- "^ *\\(\\([0-9]+\\)-\\)?\\([0-1]?[0-9]\\)-\\([0-3]?[0-9]\\)\\([^-0-9]\\|$\\)" ans)
- (progn
- (setq year (if (match-end 2)
- (string-to-number (match-string 2 ans))
- (string-to-number (format-time-string "%Y")))
- month (string-to-number (match-string 3 ans))
- day (string-to-number (match-string 4 ans)))
- (if (< year 100) (setq year (+ 2000 year)))
- (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
- t nil ans))))
- (setq tl (parse-time-string ans)
- year (or (nth 5 tl) (string-to-number (format-time-string "%Y" ct)))
- month (or (nth 4 tl) (string-to-number (format-time-string "%m" ct)))
- day (or (nth 3 tl) (string-to-number (format-time-string "%d" ct)))
- hour (or (nth 2 tl) (string-to-number (format-time-string "%H" ct)))
- minute (or (nth 1 tl) (string-to-number (format-time-string "%M" ct)))
- second (or (nth 0 tl) 0))
- (if (and (boundp 'org-time-was-given)
- (nth 2 tl))
- (setq org-time-was-given t))
- (if (< year 100) (setq year (+ 2000 year)))
- (if to-time
- (encode-time second minute hour day month year)
- (if (or (nth 1 tl) (nth 2 tl))
- (format "%04d-%02d-%02d %02d:%02d" year month day hour minute)
- (format "%04d-%02d-%02d" year month day)))))
- (defun org-eval-in-calendar (form)
- "Eval FORM in the calendar window and return to current window.
- Also, store the cursor date in variable ans2."
- (let ((sw (selected-window)))
- (select-window (get-buffer-window "*Calendar*"))
- (eval form)
- (when (calendar-cursor-to-date)
- (let* ((date (calendar-cursor-to-date))
- (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
- (setq ans2 (format-time-string "%Y-%m-%d" time))))
- (org-move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
- (select-window sw)))
- (defun org-calendar-select ()
- "Return to `org-read-date' with the date currently selected.
- This is used by `org-read-date' in a temporary keymap for the calendar buffer."
- (interactive)
- (when (calendar-cursor-to-date)
- (let* ((date (calendar-cursor-to-date))
- (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
- (setq ans1 (format-time-string "%Y-%m-%d" time)))
- (if (active-minibuffer-window) (exit-minibuffer))))
- (defun org-calendar-select-mouse (ev)
- "Return to `org-read-date' with the date currently selected.
- This is used by `org-read-date' in a temporary keymap for the calendar buffer."
- (interactive "e")
- (mouse-set-point ev)
- (when (calendar-cursor-to-date)
- (let* ((date (calendar-cursor-to-date))
- (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
- (setq ans1 (format-time-string "%Y-%m-%d" time)))
- (if (active-minibuffer-window) (exit-minibuffer))))
- (defun org-check-deadlines (ndays)
- "Check if there are any deadlines due or past due.
- A deadline is considered due if it happens within `org-deadline-warning-days'
- days from today's date. If the deadline appears in an entry marked DONE,
- it is not shown. The prefix arg NDAYS can be used to test that many
- days. If the prefix is a raw \\[universal-argument] prefix, all deadlines are shown."
- (interactive "P")
- (let* ((org-warn-days
- (cond
- ((equal ndays '(4)) 100000)
- (ndays (prefix-numeric-value ndays))
- (t org-deadline-warning-days)))
- (case-fold-search nil)
- (regexp (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
- (callback
- (lambda ()
- (and (let ((d1 (time-to-days (current-time)))
- (d2 (time-to-days
- (org-time-string-to-time (match-string 1)))))
- (< (- d2 d1) org-warn-days))
- (not (org-entry-is-done-p))))))
- (message "%d deadlines past-due or due within %d days"
- (org-occur regexp callback)
- org-warn-days)))
- (defun org-evaluate-time-range (&optional to-buffer)
- "Evaluate a time range by computing the difference between start and end.
- Normally the result is just printed in the echo area, but with prefix arg
- TO-BUFFER, the result is inserted just after the date stamp into the buffer.
- If the time range is actually in a table, the result is inserted into the
- next column.
- For time difference computation, a year is assumed to be exactly 365
- days in order to avoid rounding problems."
- (interactive "P")
- (save-excursion
- (unless (org-at-date-range-p)
- (goto-char (point-at-bol))
- (re-search-forward org-tr-regexp (point-at-eol) t))
- (if (not (org-at-date-range-p))
- (error "Not at a time-stamp range, and none found in current line")))
- (let* ((ts1 (match-string 1))
- (ts2 (match-string 2))
- (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
- (match-end (match-end 0))
- (time1 (org-time-string-to-time ts1))
- (time2 (org-time-string-to-time ts2))
- (t1 (time-to-seconds time1))
- (t2 (time-to-seconds time2))
- (diff (abs (- t2 t1)))
- (negative (< (- t2 t1) 0))
- ;; (ys (floor (* 365 24 60 60)))
- (ds (* 24 60 60))
- (hs (* 60 60))
- (fy "%dy %dd %02d:%02d")
- (fy1 "%dy %dd")
- (fd "%dd %02d:%02d")
- (fd1 "%dd")
- (fh "%02d:%02d")
- y d h m align)
- ;; FIXME: Should I re-introduce years, make year refer to same date?
- ;; This would be the only useful way to have years, actually.
- (if havetime
- (setq ; y (floor (/ diff ys)) diff (mod diff ys)
- y 0
- d (floor (/ diff ds)) diff (mod diff ds)
- h (floor (/ diff hs)) diff (mod diff hs)
- m (floor (/ diff 60)))
- (setq ; y (floor (/ diff ys)) diff (mod diff ys)
- y 0
- d (floor (+ (/ diff ds) 0.5))
- h 0 m 0))
- (if (not to-buffer)
- (message (org-make-tdiff-string y d h m))
- (when (org-at-table-p)
- (goto-char match-end)
- (setq align t)
- (and (looking-at " *|") (goto-char (match-end 0))))
- (if (looking-at
- "\\( *-? *[0-9]+y\\)?\\( *[0-9]+d\\)? *[0-9][0-9]:[0-9][0-9]")
- (replace-match ""))
- (if negative (insert " -"))
- (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
- (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
- (insert " " (format fh h m))))
- (if align (org-table-align))
- (message "Time difference inserted"))))
- (defun org-make-tdiff-string (y d h m)
- (let ((fmt "")
- (l nil))
- (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
- l (push y l)))
- (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
- l (push d l)))
- (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
- l (push h l)))
- (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
- l (push m l)))
- (apply 'format fmt (nreverse l))))
- (defun org-time-string-to-time (s)
- (apply 'encode-time (org-parse-time-string s)))
- (defun org-parse-time-string (s &optional nodefault)
- "Parse the standard Org-mode time string.
- This should be a lot faster than the normal `parse-time-string'.
- If time is not given, defaults to 0:00. However, with optional NODEFAULT,
- hour and minute fields will be nil if not given."
- (if (string-match org-ts-regexp1 s)
- (list 0
- (if (or (match-beginning 8) (not nodefault))
- (string-to-number (or (match-string 8 s) "0")))
- (if (or (match-beginning 7) (not nodefault))
- (string-to-number (or (match-string 7 s) "0")))
- (string-to-number (match-string 4 s))
- (string-to-number (match-string 3 s))
- (string-to-number (match-string 2 s))
- nil nil nil)
- (make-list 9 0)))
- (defun org-timestamp-up (&optional arg)
- "Increase the date item at the cursor by one.
- If the cursor is on the year, change the year. If it is on the month or
- the day, change that.
- With prefix ARG, change by that many units."
- (interactive "p")
- (org-timestamp-change (prefix-numeric-value arg)))
- (defun org-timestamp-down (&optional arg)
- "Decrease the date item at the cursor by one.
- If the cursor is on the year, change the year. If it is on the month or
- the day, change that.
- With prefix ARG, change by that many units."
- (interactive "p")
- (org-timestamp-change (- (prefix-numeric-value arg))))
- (defun org-timestamp-up-day (&optional arg)
- "Increase the date in the time stamp by one day.
- With prefix ARG, change that many days."
- (interactive "p")
- (if (and (not (org-at-timestamp-p))
- (org-on-heading-p))
- (org-todo 'up)
- (org-timestamp-change (prefix-numeric-value arg) 'day)))
- (defun org-timestamp-down-day (&optional arg)
- "Decrease the date in the time stamp by one day.
- With prefix ARG, change that many days."
- (interactive "p")
- (if (and (not (org-at-timestamp-p))
- (org-on-heading-p))
- (org-todo 'down)
- (org-timestamp-change (- (prefix-numeric-value arg)) 'day)))
- (defsubst org-pos-in-match-range (pos n)
- (and (match-beginning n)
- (<= (match-beginning n) pos)
- (>= (match-end n) pos)))
- (defun org-at-timestamp-p ()
- "Determine if the cursor is in or at a timestamp."
- (interactive)
- (let* ((tsr org-ts-regexp2)
- (pos (point))
- (ans (or (looking-at tsr)
- (save-excursion
- (skip-chars-backward "^<\n\r\t")
- (if (> (point) 1) (backward-char 1))
- (and (looking-at tsr)
- (> (- (match-end 0) pos) -1))))))
- (and (boundp 'org-ts-what)
- (setq org-ts-what
- (cond
- ((org-pos-in-match-range pos 2) 'year)
- ((org-pos-in-match-range pos 3) 'month)
- ((org-pos-in-match-range pos 7) 'hour)
- ((org-pos-in-match-range pos 8) 'minute)
- ((or (org-pos-in-match-range pos 4)
- (org-pos-in-match-range pos 5)) 'day)
- (t 'day))))
- ans))
- (defun org-timestamp-change (n &optional what)
- "Change the date in the time stamp at point.
- The date will be changed by N times WHAT. WHAT can be `day', `month',
- `year', `minute', `second'. If WHAT is not given, the cursor position
- in the timestamp determines what will be changed."
- (let ((fmt (car org-time-stamp-formats))
- org-ts-what
- (pos (point))
- ts time time0)
- (if (not (org-at-timestamp-p))
- (error "Not at a timestamp"))
- (setq org-ts-what (or what org-ts-what))
- (setq fmt (if (<= (abs (- (cdr org-ts-lengths)
- (- (match-end 0) (match-beginning 0))))
- 1)
- (cdr org-time-stamp-formats)
- (car org-time-stamp-formats)))
- (setq ts (match-string 0))
- (replace-match "")
- (setq time0 (org-parse-time-string ts))
- (setq time
- (apply 'encode-time
- (append
- (list (or (car time0) 0))
- (list (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0)))
- (list (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0)))
- (list (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0)))
- (list (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0)))
- (list (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0)))
- (nthcdr 6 time0))))
- (if (eq what 'calendar)
- (let ((cal-date
- (save-excursion
- (save-match-data
- (set-buffer "*Calendar*")
- (calendar-cursor-to-date)))))
- (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
- (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
- (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
- (setcar time0 (or (car time0) 0))
- (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
- (setcar (nthcdr 2 time0) (or (nth 1 time0) 0))
- (setq time (apply 'encode-time time0))))
- (insert (setq org-last-changed-timestamp (format-time-string fmt time)))
- (goto-char pos)
- ;; Try to recenter the calendar window, if any
- (if (and org-calendar-follow-timestamp-change
- (get-buffer-window "*Calendar*" t)
- (memq org-ts-what '(day month year)))
- (org-recenter-calendar (time-to-days time)))))
- (defun org-recenter-calendar (date)
- "If the calendar is visible, recenter it to DATE."
- (let* ((win (selected-window))
- (cwin (get-buffer-window "*Calendar*" t))
- (calendar-move-hook nil))
- (when cwin
- (select-window cwin)
- (calendar-goto-date (if (listp date) date
- (calendar-gregorian-from-absolute date)))
- (select-window win))))
- (defun org-goto-calendar (&optional arg)
- "Go to the Emacs calendar at the current date.
- If there is a time stamp in the current line, go to that date.
- A prefix ARG can be used to force the current date."
- (interactive "P")
- (let ((tsr org-ts-regexp) diff
- (calendar-move-hook nil)
- (view-diary-entries-initially nil))
- (if (or (org-at-timestamp-p)
- (save-excursion
- (beginning-of-line 1)
- (looking-at (concat ".*" tsr))))
- (let ((d1 (time-to-days (current-time)))
- (d2 (time-to-days
- (org-time-string-to-time (match-string 1)))))
- (setq diff (- d2 d1))))
- (calendar)
- (calendar-goto-today)
- (if (and diff (not arg)) (calendar-forward-day diff))))
- (defun org-date-from-calendar ()
- "Insert time stamp corresponding to cursor date in *Calendar* buffer.
- If there is already a time stamp at the cursor position, update it."
- (interactive)
- (org-timestamp-change 0 'calendar))
- ;;; Agenda, and Diary Integration
- ;;; Define the mode
- (defvar org-agenda-mode-map (make-sparse-keymap)
- "Keymap for `org-agenda-mode'.")
- (defvar org-agenda-menu) ; defined later in this file.
- (defvar org-agenda-follow-mode nil)
- (defvar org-agenda-show-log nil)
- (defvar org-agenda-buffer-name "*Org Agenda*")
- (defvar org-agenda-redo-command nil)
- (defvar org-agenda-mode-hook nil)
- (defvar org-agenda-type nil)
- (defvar org-agenda-force-single-file nil)
- ;;;###autoload
- (defun org-agenda-mode ()
- "Mode for time-sorted view on action items in Org-mode files.
- The following commands are available:
- \\{org-agenda-mode-map}"
- (interactive)
- (kill-all-local-variables)
- (setq major-mode 'org-agenda-mode)
- (setq mode-name "Org-Agenda")
- (use-local-map org-agenda-mode-map)
- (easy-menu-add org-agenda-menu)
- (if org-startup-truncated (setq truncate-lines t))
- (org-add-hook 'post-command-hook 'org-agenda-post-command-hook nil 'local)
- (org-add-hook 'pre-command-hook 'org-unhighlight nil 'local)
- (unless org-agenda-keep-modes
- (setq org-agenda-follow-mode nil
- org-agenda-show-log nil))
- (easy-menu-change
- '("Agenda") "Agenda Files"
- (append
- (list
- (vector
- (if (get 'org-agenda-files 'org-restrict)
- "Restricted to single file"
- "Edit File List")
- '(org-edit-agenda-file-list)
- (not (get 'org-agenda-files 'org-restrict)))
- "--")
- (mapcar 'org-file-menu-entry (org-agenda-files))))
- (org-agenda-set-mode-name)
- (apply
- (if (fboundp 'run-mode-hooks) 'run-mode-hooks 'run-hooks)
- (list 'org-agenda-mode-hook)))
- (define-key org-agenda-mode-map "\C-i" 'org-agenda-goto)
- (define-key org-agenda-mode-map [(tab)] 'org-agenda-goto)
- (define-key org-agenda-mode-map "\C-m" 'org-agenda-switch-to)
- (define-key org-agenda-mode-map " " 'org-agenda-show)
- (define-key org-agenda-mode-map "\C-c\C-t" 'org-agenda-todo)
- (define-key org-agenda-mode-map "o" 'delete-other-windows)
- (define-key org-agenda-mode-map "L" 'org-agenda-recenter)
- (define-key org-agenda-mode-map "t" 'org-agenda-todo)
- (define-key org-agenda-mode-map ":" 'org-agenda-set-tags)
- (define-key org-agenda-mode-map "." 'org-agenda-goto-today)
- (define-key org-agenda-mode-map "d" 'org-agenda-day-view)
- (define-key org-agenda-mode-map "w" 'org-agenda-week-view)
- (define-key org-agenda-mode-map (org-key 'S-right) 'org-agenda-date-later)
- (define-key org-agenda-mode-map (org-key 'S-left) 'org-agenda-date-earlier)
- (define-key org-agenda-mode-map [?\C-c ?\C-x (right)] 'org-agenda-date-later)
- (define-key org-agenda-mode-map [?\C-c ?\C-x (left)] 'org-agenda-date-earlier)
- (define-key org-agenda-mode-map ">" 'org-agenda-date-prompt)
- (let ((l '(1 2 3 4 5 6 7 8 9 0)))
- (while l (define-key org-agenda-mode-map
- (int-to-string (pop l)) 'digit-argument)))
- (define-key org-agenda-mode-map "f" 'org-agenda-follow-mode)
- (define-key org-agenda-mode-map "l" 'org-agenda-log-mode)
- (define-key org-agenda-mode-map "D" 'org-agenda-toggle-diary)
- (define-key org-agenda-mode-map "g" 'org-agenda-toggle-time-grid)
- (define-key org-agenda-mode-map "r" 'org-agenda-redo)
- (define-key org-agenda-mode-map "q" 'org-agenda-quit)
- (define-key org-agenda-mode-map "x" 'org-agenda-exit)
- (define-key org-agenda-mode-map "P" 'org-agenda-show-priority)
- (define-key org-agenda-mode-map "T" 'org-agenda-show-tags)
- (define-key org-agenda-mode-map "n" 'next-line)
- (define-key org-agenda-mode-map "p" 'previous-line)
- (define-key org-agenda-mode-map "\C-n" 'org-agenda-next-date-line)
- (define-key org-agenda-mode-map "\C-p" 'org-agenda-previous-date-line)
- (define-key org-agenda-mode-map "," 'org-agenda-priority)
- (define-key org-agenda-mode-map "\C-c," 'org-agenda-priority)
- (define-key org-agenda-mode-map "i" 'org-agenda-diary-entry)
- (define-key org-agenda-mode-map "c" 'org-agenda-goto-calendar)
- (eval-after-load "calendar"
- '(define-key calendar-mode-map org-calendar-to-agenda-key
- 'org-calendar-goto-agenda))
- (define-key org-agenda-mode-map "C" 'org-agenda-convert-date)
- (define-key org-agenda-mode-map "m" 'org-agenda-phases-of-moon)
- (define-key org-agenda-mode-map "M" 'org-agenda-phases-of-moon)
- (define-key org-agenda-mode-map "s" 'org-agenda-sunrise-sunset)
- (define-key org-agenda-mode-map "S" 'org-agenda-sunrise-sunset)
- (define-key org-agenda-mode-map "h" 'org-agenda-holidays)
- (define-key org-agenda-mode-map "H" 'org-agenda-holidays)
- (define-key org-agenda-mode-map "+" 'org-agenda-priority-up)
- (define-key org-agenda-mode-map "-" 'org-agenda-priority-down)
- (define-key org-agenda-mode-map (org-key 'S-up) 'org-agenda-priority-up)
- (define-key org-agenda-mode-map (org-key 'S-down) 'org-agenda-priority-down)
- (define-key org-agenda-mode-map [?\C-c ?\C-x (up)] 'org-agenda-priority-up)
- (define-key org-agenda-mode-map [?\C-c ?\C-x (down)] 'org-agenda-priority-down)
- (define-key org-agenda-mode-map [(right)] 'org-agenda-later)
- (define-key org-agenda-mode-map [(left)] 'org-agenda-earlier)
- (define-key org-agenda-mode-map "\C-c\C-x\C-c" 'org-export-icalendar-combine-agenda-files)
- (defvar org-agenda-keymap (copy-keymap org-agenda-mode-map)
- "Local keymap for agenda entries from Org-mode.")
- (define-key org-agenda-keymap
- (if (featurep 'xemacs) [(button2)] [(mouse-2)]) 'org-agenda-goto-mouse)
- (define-key org-agenda-keymap
- (if (featurep 'xemacs) [(button3)] [(mouse-3)]) 'org-agenda-show-mouse)
- (define-key org-agenda-keymap [follow-link] 'mouse-face)
- (easy-menu-define org-agenda-menu org-agenda-mode-map "Agenda menu"
- '("Agenda"
- ("Agenda Files")
- "--"
- ["Show" org-agenda-show t]
- ["Go To (other window)" org-agenda-goto t]
- ["Go To (one window)" org-agenda-switch-to t]
- ["Follow Mode" org-agenda-follow-mode
- :style toggle :selected org-agenda-follow-mode :active t]
- "--"
- ["Cycle TODO" org-agenda-todo t]
- ("Tags"
- ["Show all Tags" org-agenda-show-tags t]
- ["Set Tags" org-agenda-set-tags t])
- ("Reschedule"
- ["Reschedule +1 day" org-agenda-date-later (org-agenda-check-type nil 'agenda 'timeline)]
- ["Reschedule -1 day" org-agenda-date-earlier (org-agenda-check-type nil 'agenda 'timeline)]
- "--"
- ["Reschedule to ..." org-agenda-date-prompt (org-agenda-check-type nil 'agenda 'timeline)])
- ("Priority"
- ["Set Priority" org-agenda-priority t]
- ["Increase Priority" org-agenda-priority-up t]
- ["Decrease Priority" org-agenda-priority-down t]
- ["Show Priority" org-agenda-show-priority t])
- "--"
- ;; ["New agenda command" org-agenda t]
- ["Rebuild buffer" org-agenda-redo t]
- "--"
- ["Goto Today" org-agenda-goto-today (org-agenda-check-type nil 'agenda 'timeline)]
- ["Next Dates" org-agenda-later (org-agenda-check-type nil 'agenda)]
- ["Previous Dates" org-agenda-earlier (org-agenda-check-type nil 'agenda)]
- "--"
- ["Day View" org-agenda-day-view :active (org-agenda-check-type nil 'agenda)
- :style radio :selected (equal org-agenda-ndays 1)]
- ["Week View" org-agenda-week-view :active (org-agenda-check-type nil 'agenda)
- :style radio :selected (equal org-agenda-ndays 7)]
- "--"
- ["Show Logbook entries" org-agenda-log-mode
- :style toggle :selected org-agenda-show-log :active (org-agenda-check-type nil 'agenda 'timeline)]
- ["Include Diary" org-agenda-toggle-diary
- :style toggle :selected org-agenda-include-diary :active (org-agenda-check-type nil 'agenda)]
- ["Use Time Grid" org-agenda-toggle-time-grid
- :style toggle :selected org-agenda-use-time-grid :active (org-agenda-check-type nil 'agenda)]
- "--"
- ["New Diary Entry" org-agenda-diary-entry (org-agenda-check-type nil 'agenda 'timeline)]
- ("Calendar Commands"
- ["Goto Calendar" org-agenda-goto-calendar (org-agenda-check-type nil 'agenda 'timeline)]
- ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda 'timeline)]
- ["Sunrise/Sunset" org-agenda-sunrise-sunset (org-agenda-check-type nil 'agenda 'timeline)]
- ["Holidays" org-agenda-holidays (org-agenda-check-type nil 'agenda 'timeline)]
- ["Convert" org-agenda-convert-date (org-agenda-check-type nil 'agenda 'timeline)])
- ["Create iCalendar file" org-export-icalendar-combine-agenda-files t]
- "--"
- ["Quit" org-agenda-quit t]
- ["Exit and Release Buffers" org-agenda-exit t]
- ))
- ;;;###autoload
- (defun org-agenda (arg)
- "Dispatch agenda commands to collect entries to the agenda buffer.
- Prompts for a character to select a command. Any prefix arg will be passed
- on to the selected command. The default selections are:
- a Call `org-agenda' to display the agenda for the current day or week.
- t Call `org-todo-list' to display the global todo list.
- T Call `org-todo-list' to display the global todo list, select only
- entries with a specific TODO keyword (the user gets a prompt).
- m Call `org-tags-view' to display headlines with tags matching
- a condition (the user is prompted for the condition).
- M Like `m', but select only TODO entries, no ordinary headlines.
- More commands can be added by configuring the variable
- `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
- searches can be pre-defined in this way.
- If the current buffer is in Org-mode and visiting a file, you can also
- first press `1' to indicate that the agenda should be temporarily (until the
- next use of \\[org-agenda]) restricted to the current file."
- (interactive "P")
- (catch 'exit
- (let ((restrict-ok (and buffer-file-name (eq major-mode 'org-mode)))
- (custom org-agenda-custom-commands)
- c entry key type string)
- (put 'org-agenda-files 'org-restrict nil)
- (save-window-excursion
- (delete-other-windows)
- (switch-to-buffer-other-window " *Agenda Commands*")
- (erase-buffer)
- (insert
- "Press key for an agenda command:
- --------------------------------
- a Agenda for current week or day
- t List of all TODO entries T Entries with special TODO kwd
- m Match a TAGS query M Like m, but only TODO entries
- C Configure your own agenda commands")
- (while (setq entry (pop custom))
- (setq key (car entry) type (nth 1 entry) string (nth 2 entry))
- (insert (format "\n%-4s%-14s: %s"
- key
- (cond
- ((eq type 'tags) "Tags query")
- ((eq type 'todo) "TODO keyword")
- ((eq type 'tags-tree) "Tags tree")
- ((eq type 'todo-tree) "TODO kwd tree")
- ((eq type 'occur-tree) "Occur tree")
- (t "???"))
- (org-string-props string 'face 'org-link))))
- (goto-char (point-min))
- (if (fboundp 'fit-window-to-buffer) (fit-window-to-buffer))
- (message "Press key for agenda command%s"
- (if restrict-ok ", or [1] to restrict to current file" ""))
- (setq c (read-char-exclusive))
- (message "")
- (when (equal c ?1)
- (if restrict-ok
- (put 'org-agenda-files 'org-restrict (list buffer-file-name))
- (error "Cannot restrict agenda to current buffer"))
- (message "Press key for agenda command%s"
- (if restrict-ok " (restricted to current file)" ""))
- (setq c (read-char-exclusive))
- (message "")))
- (require 'calendar) ; FIXME: can we avoid this for some commands?
- ;; For example the todo list should not need it (but does...)
- (cond
- ((equal c ?C) (customize-variable 'org-agenda-custom-commands))
- ((equal c ?a) (call-interactively 'org-agenda-list))
- ((equal c ?t) (call-interactively 'org-todo-list))
- ((equal c ?T)
- (setq current-prefix-arg (or arg '(4)))
- (call-interactively 'org-todo-list))
- ((equal c ?m) (call-interactively 'org-tags-view))
- ((equal c ?M)
- (setq current-prefix-arg (or arg '(4)))
- (call-interactively 'org-tags-view))
- ((setq entry (assoc (char-to-string c) org-agenda-custom-commands))
- (setq type (nth 1 entry) string (nth 2 entry))
- (cond
- ((eq type 'tags)
- (org-tags-view current-prefix-arg string))
- ((eq type 'todo)
- (org-todo-list string))
- ((eq type 'tags-tree)
- (org-check-for-org-mode)
- (org-tags-sparse-tree current-prefix-arg string))
- ((eq type 'todo-tree)
- (org-check-for-org-mode)
- (org-occur (concat "^" outline-regexp "[ \t]*"
- (regexp-quote string) "\\>")))
- ((eq type 'occur-tree)
- (org-check-for-org-mode)
- (org-occur string))
- (t (error "Invalid custom agenda command type %s" type))))
- (t (error "Invalid key"))))))
- (defun org-check-for-org-mode ()
- "Make sure current buffer is in org-mode. Error if not."
- (or (eq major-mode 'org-mode)
- (error "Cannot execute org-mode agenda command on buffer in %s."
- major-mode)))
- (defun org-fit-agenda-window ()
- "Fit the window to the buffer size."
- (and org-fit-agenda-window
- (fboundp 'fit-window-to-buffer)
- (fit-window-to-buffer nil (/ (* (frame-height) 3) 4)
- (/ (frame-height) 2))))
- (defun org-agenda-files (&optional unrestricted)
- "Get the list of agenda files.
- Optional UNRESTRICTED means return the full list even if a restriction
- is currently in place."
- (cond
- ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
- ((stringp org-agenda-files) (org-read-agenda-file-list))
- ((listp org-agenda-files) org-agenda-files)
- (t (error "Invalid value of `org-agenda-files'"))))
- (defvar org-window-configuration)
- (defun org-edit-agenda-file-list ()
- "Edit the list of agenda files.
- Depending on setup, this either uses customize to edit the variable
- `org-agenda-files', or it visits the file that is holding the list. In the
- latter case, the buffer is set up in a way that saving it automatically kills
- the buffer and restores the previous window configuration."
- (interactive)
- (if (stringp org-agenda-files)
- (let ((cw (current-window-configuration)))
- (find-file org-agenda-files)
- (set (make-local-variable 'org-window-configuration) cw)
- (org-add-hook 'after-save-hook
- (lambda ()
- (set-window-configuration
- (prog1 org-window-configuration
- (kill-buffer (current-buffer))))
- (org-install-agenda-files-menu)
- (message "New agenda file list installed"))
- nil 'local)
- (message (substitute-command-keys
- "Edit list and finish with \\[save-buffer]")))
- (customize-variable 'org-agenda-files)))
- (defun org-store-new-agenda-file-list (list)
- "Set new value for the agenda file list and save it correcly."
- (if (stringp org-agenda-files)
- (let ((f org-agenda-files) b)
- (while (setq b (find-buffer-visiting f)) (kill-buffer b))
- (with-temp-file f
- (insert (mapconcat 'identity list) "\n") "\n"))
- (let ((org-mode-hook nil) (default-major-mode 'fundamental-mode))
- (setq org-agenda-files list)
- (customize-save-variable 'org-agenda-files org-agenda-files))))
- (defun org-read-agenda-file-list ()
- "Read the list of agenda files from a file."
- (when (stringp org-agenda-files)
- (with-temp-buffer
- (insert-file-contents org-agenda-files)
- (org-split-string (buffer-string) "[ \t\r\n]*?[\r\n][ \t\r\n]*"))))
- (defvar org-agenda-markers nil
- "List of all currently active markers created by `org-agenda'.")
- (defvar org-agenda-last-marker-time (time-to-seconds (current-time))
- "Creation time of the last agenda marker.")
- (defun org-agenda-new-marker (&optional pos)
- "Return a new agenda marker.
- Org-mode keeps a list of these markers and resets them when they are
- no longer in use."
- (let ((m (copy-marker (or pos (point)))))
- (setq org-agenda-last-marker-time (time-to-seconds (current-time)))
- (push m org-agenda-markers)
- m))
- (defun org-agenda-maybe-reset-markers (&optional force)
- "Reset markers created by `org-agenda'. But only if they are old enough."
- (if (or force
- (> (- (time-to-seconds (current-time))
- org-agenda-last-marker-time)
- 5))
- (while org-agenda-markers
- (move-marker (pop org-agenda-markers) nil))))
- (defvar org-agenda-new-buffers nil
- "Buffers created to visit agenda files.")
- (defun org-get-agenda-file-buffer (file)
- "Get a buffer visiting FILE. If the buffer needs to be created, add
- it to the list of buffers which might be released later."
- (let ((buf (find-buffer-visiting file)))
- (if buf
- buf ; just return it
- ;; Make a new buffer and remember it
- (setq buf (find-file-noselect file))
- (if buf (push buf org-agenda-new-buffers))
- buf)))
- (defun org-release-buffers (blist)
- "Release all buffers in list, asking the user for confirmation when needed.
- When a buffer is unmodified, it is just killed. When modified, it is saved
- \(if the user agrees) and then killed."
- (let (buf file)
- (while (setq buf (pop blist))
- (setq file (buffer-file-name buf))
- (when (and (buffer-modified-p buf)
- file
- (y-or-n-p (format "Save file %s? " file)))
- (with-current-buffer buf (save-buffer)))
- (kill-buffer buf))))
- (defvar org-respect-restriction nil) ; Dynamically-scoped param.
- (defun org-timeline (&optional include-all keep-modes)
- "Show a time-sorted view of the entries in the current org file.
- Only entries with a time stamp of today or later will be listed. With
- \\[universal-argument] prefix, all unfinished TODO items will also be shown,
- under the current date.
- If the buffer contains an active region, only check the region for
- dates."
- (interactive "P")
- (require 'calendar)
- (org-agenda-maybe-reset-markers 'force)
- (org-compile-prefix-format org-timeline-prefix-format)
- (let* ((dopast t)
- (dotodo include-all)
- (doclosed org-agenda-show-log)
- (org-agenda-keep-modes keep-modes)
- (entry buffer-file-name)
- (org-agenda-files (list buffer-file-name))
- (date (calendar-current-date))
- (win (selected-window))
- (pos1 (point))
- (beg (if (org-region-active-p) (region-beginning) (point-min)))
- (end (if (org-region-active-p) (region-end) (point-max)))
- (day-numbers (org-get-all-dates beg end 'no-ranges
- t doclosed)) ; always include today
- (today (time-to-days (current-time)))
- (org-respect-restriction t)
- (past t)
- args
- s e rtn d)
- (setq org-agenda-redo-command
- (list 'progn
- (list 'switch-to-buffer-other-window (current-buffer))
- (list 'org-timeline (list 'quote include-all) t)))
- (if (not dopast)
- ;; Remove past dates from the list of dates.
- (setq day-numbers (delq nil (mapcar (lambda(x)
- (if (>= x today) x nil))
- day-numbers))))
- (switch-to-buffer-other-window
- (get-buffer-create org-agenda-buffer-name))
- (setq buffer-read-only nil)
- (erase-buffer)
- (org-agenda-mode) (setq buffer-read-only nil)
- (set (make-local-variable 'org-agenda-type) 'timeline)
- (if doclosed (push :closed args))
- (push :timestamp args)
- (if dotodo (push :todo args))
- (while (setq d (pop day-numbers))
- (if (and (>= d today)
- dopast
- past)
- (progn
- (setq past nil)
- (insert (make-string 79 ?-) "\n")))
- (setq date (calendar-gregorian-from-absolute d))
- (setq s (point))
- (setq rtn (apply 'org-agenda-get-day-entries
- entry date args))
- (if (or rtn (equal d today))
- (progn
- (insert (calendar-day-name date) " "
- (number-to-string (extract-calendar-day date)) " "
- (calendar-month-name (extract-calendar-month date)) " "
- (number-to-string (extract-calendar-year date)) "\n")
- (put-text-property s (1- (point)) 'face
- 'org-link)
- (if (equal d today)
- (put-text-property s (1- (point)) 'org-today t))
- (insert (org-finalize-agenda-entries rtn) "\n")
- (put-text-property s (1- (point)) 'day d))))
- (goto-char (point-min))
- (setq buffer-read-only t)
- (goto-char (or (text-property-any (point-min) (point-max) 'org-today t)
- (point-min)))
- (when (not org-select-timeline-window)
- (select-window win)
- (goto-char pos1))))
- ;;;###autoload
- (defun org-agenda-list (&optional include-all start-day ndays keep-modes)
- "Produce a weekly view from all files in variable `org-agenda-files'.
- The view will be for the current week, but from the overview buffer you
- will be able to go to other weeks.
- With one \\[universal-argument] prefix argument INCLUDE-ALL, all unfinished TODO items will
- also be shown, under the current date.
- With two \\[universal-argument] prefix argument INCLUDE-ALL, all TODO entries marked DONE
- on the days are also shown. See the variable `org-log-done' for how
- to turn on logging.
- START-DAY defaults to TODAY, or to the most recent match for the weekday
- given in `org-agenda-start-on-weekday'.
- NDAYS defaults to `org-agenda-ndays'."
- (interactive "P")
- (org-agenda-maybe-reset-markers 'force)
- (org-compile-prefix-format org-agenda-prefix-format)
- (require 'calendar)
- (let* ((org-agenda-start-on-weekday
- (if (or (equal ndays 1)
- (and (null ndays) (equal 1 org-agenda-ndays)))
- nil org-agenda-start-on-weekday))
- (org-agenda-keep-modes keep-modes)
- (thefiles (copy-sequence (org-agenda-files))) ;; FIXME: Why copy???
- (files thefiles)
- (win (selected-window))
- (today (time-to-days (current-time)))
- (sd (or start-day today))
- (start (if (or (null org-agenda-start-on-weekday)
- (< org-agenda-ndays 7))
- sd
- (let* ((nt (calendar-day-of-week
- (calendar-gregorian-from-absolute sd)))
- (n1 org-agenda-start-on-weekday)
- (d (- nt n1)))
- (- sd (+ (if (< d 0) 7 0) d)))))
- (day-numbers (list start))
- (inhibit-redisplay t)
- s e rtn rtnall file date d start-pos end-pos todayp nd)
- (setq org-agenda-redo-command
- (list 'org-agenda-list (list 'quote include-all) start-day ndays t))
- ;; Make the list of days
- (setq ndays (or ndays org-agenda-ndays)
- nd ndays)
- (while (> ndays 1)
- (push (1+ (car day-numbers)) day-numbers)
- (setq ndays (1- ndays)))
- (setq day-numbers (nreverse day-numbers))
- (if (not (equal (current-buffer) (get-buffer org-agenda-buffer-name)))
- (progn
- (delete-other-windows)
- (switch-to-buffer-other-window
- (get-buffer-create org-agenda-buffer-name))))
- (setq buffer-read-only nil)
- (erase-buffer)
- (org-agenda-mode) (setq buffer-read-only nil)
- (set (make-local-variable 'org-agenda-type) 'agenda)
- (set (make-local-variable 'starting-day) (car day-numbers))
- (set (make-local-variable 'include-all-loc) include-all)
- (when (and (or include-all org-agenda-include-all-todo)
- (member today day-numbers))
- (setq files thefiles
- rtnall nil)
- (while (setq file (pop files))
- (catch 'nextfile
- (org-check-agenda-file file)
- (setq date (calendar-gregorian-from-absolute today)
- rtn (org-agenda-get-day-entries
- file date :todo))
- (setq rtnall (append rtnall rtn))))
- (when rtnall
- (insert "ALL CURRENTLY OPEN TODO ITEMS:\n")
- (add-text-properties (point-min) (1- (point))
- (list 'face 'org-link))
- (insert (org-finalize-agenda-entries rtnall) "\n")))
- (while (setq d (pop day-numbers))
- (setq date (calendar-gregorian-from-absolute d)
- s (point))
- (if (or (setq todayp (= d today))
- (and (not start-pos) (= d sd)))
- (setq start-pos (point))
- (if (and start-pos (not end-pos))
- (setq end-pos (point))))
- (setq files thefiles
- rtnall nil)
- (while (setq file (pop files))
- (catch 'nextfile
- (org-check-agenda-file file)
- (if org-agenda-show-log
- (setq rtn (org-agenda-get-day-entries
- file date
- :deadline :scheduled :timestamp :closed))
- (setq rtn (org-agenda-get-day-entries
- file date
- :deadline :scheduled :timestamp)))
- (setq rtnall (append rtnall rtn))))
- (if org-agenda-include-diary
- (progn
- (require 'diary-lib)
- (setq rtn (org-get-entries-from-diary date))
- (setq rtnall (append rtnall rtn))))
- (if (or rtnall org-agenda-show-all-dates)
- (progn
- (insert (format "%-9s %2d %s %4d\n"
- (calendar-day-name date)
- (extract-calendar-day date)
- (calendar-month-name (extract-calendar-month date))
- (extract-calendar-year date)))
- (put-text-property s (1- (point)) 'face
- 'org-link)
- (if rtnall (insert
- (org-finalize-agenda-entries
- (org-agenda-add-time-grid-maybe
- rtnall nd todayp))
- "\n"))
- (put-text-property s (1- (point)) 'day d))))
- (goto-char (point-min))
- (setq buffer-read-only t)
- (org-fit-agenda-window)
- (unless (and (pos-visible-in-window-p (point-min))
- (pos-visible-in-window-p (point-max)))
- (goto-char (1- (point-max)))
- (recenter -1)
- (if (not (pos-visible-in-window-p (or start-pos 1)))
- (progn
- (goto-char (or start-pos 1))
- (recenter 1))))
- (goto-char (or start-pos 1))
- (if (not org-select-agenda-window) (select-window win))
- (message "")))
- (defvar org-select-this-todo-keyword nil)
- ;;;###autoload
- (defun org-todo-list (arg &optional keep-modes)
- "Show all TODO entries from all agenda file in a single list.
- The prefix arg can be used to select a specific TODO keyword and limit
- the list to these. When using \\[universal-argument], you will be prompted
- for a keyword. A numeric prefix directly selects the Nth keyword in
- `org-todo-keywords'."
- (interactive "P")
- (org-agenda-maybe-reset-markers 'force)
- (org-compile-prefix-format org-agenda-prefix-format)
- (let* ((org-agenda-keep-modes keep-modes)
- (today (time-to-days (current-time)))
- (date (calendar-gregorian-from-absolute today))
- (win (selected-window))
- (kwds org-todo-keywords)
- (completion-ignore-case t)
- (org-select-this-todo-keyword
- (if (stringp arg) arg
- (and arg (integerp arg) (nth (1- arg) org-todo-keywords))))
- rtn rtnall files file pos)
- (when (equal arg '(4))
- (setq org-select-this-todo-keyword
- (completing-read "Keyword: " (mapcar 'list org-todo-keywords)
- nil t)))
- (and (equal 0 arg) (setq org-select-this-todo-keyword nil))
- (if (not (equal (current-buffer) (get-buffer org-agenda-buffer-name)))
- (progn
- (delete-other-windows)
- (switch-to-buffer-other-window
- (get-buffer-create org-agenda-buffer-name))))
- (setq buffer-read-only nil)
- (erase-buffer)
- (org-agenda-mode) (setq buffer-read-only nil)
- (set (make-local-variable 'org-agenda-type) 'todo)
- (set (make-local-variable 'last-arg) arg)
- (set (make-local-variable 'org-todo-keywords) kwds)
- (set (make-local-variable 'org-agenda-redo-command)
- '(org-todo-list (or current-prefix-arg last-arg) t))
- (setq files (org-agenda-files)
- rtnall nil)
- (while (setq file (pop files))
- (catch 'nextfile
- (org-check-agenda-file file)
- (setq rtn (org-agenda-get-day-entries file date :todo))
- (setq rtnall (append rtnall rtn))))
- (insert "Global list of TODO items of type: ")
- (add-text-properties (point-min) (1- (point))
- (list 'face 'org-link))
- (setq pos (point))
- (insert (or org-select-this-todo-keyword "ALL") "\n")
- (add-text-properties pos (1- (point)) (list 'face 'org-warning))
- (setq pos (point))
- (insert
- "Available with `N r': (0)ALL "
- (let ((n 0))
- (mapconcat (lambda (x)
- (format "(%d)%s" (setq n (1+ n)) x))
- org-todo-keywords " "))
- "\n")
- (add-text-properties pos (1- (point)) (list 'face 'org-link))
- (when rtnall
- (insert (org-finalize-agenda-entries rtnall) "\n"))
- (goto-char (point-min))
- (setq buffer-read-only t)
- (org-fit-agenda-window)
- (if (not org-select-agenda-window) (select-window win))))
- (defun org-check-agenda-file (file)
- "Make sure FILE exists. If not, ask user what to do."
- (when (not (file-exists-p file))
- (message "non-existent file %s. [R]emove from list or [A]bort?"
- (abbreviate-file-name file))
- (let ((r (downcase (read-char-exclusive))))
- (cond
- ((equal r ?r)
- (org-remove-file file)
- (throw 'nextfile t))
- (t (error "Abort"))))))
- (defun org-agenda-check-type (error &rest types)
- "Check if agenda buffer is of allowed type.
- If ERROR is non-nil, throw an error, otherwise just return nil."
- (if (memq org-agenda-type types)
- t
- (if error
- (error "Now allowed in %s-type agenda buffers" org-agenda-type)
- nil)))
- (defun org-agenda-quit ()
- "Exit agenda by removing the window or the buffer."
- (interactive)
- (let ((buf (current-buffer)))
- (if (not (one-window-p)) (delete-window))
- (kill-buffer buf)
- (org-agenda-maybe-reset-markers 'force)))
- (defun org-agenda-exit ()
- "Exit agenda by removing the window or the buffer.
- Also kill all Org-mode buffers which have been loaded by `org-agenda'.
- Org-mode buffers visited directly by the user will not be touched."
- (interactive)
- (org-release-buffers org-agenda-new-buffers)
- (setq org-agenda-new-buffers nil)
- (org-agenda-quit))
- (defun org-agenda-redo ()
- "Rebuild Agenda.
- When this is the global TODO list, a prefix argument will be interpreted."
- (interactive)
- (message "Rebuilding agenda buffer...")
- (eval org-agenda-redo-command)
- (message "Rebuilding agenda buffer...done"))
- (defun org-agenda-goto-today ()
- "Go to today."
- (interactive)
- (org-agenda-check-type t 'timeline 'agenda)
- (if (boundp 'starting-day)
- (let ((cmd (car org-agenda-redo-command))
- (iall (nth 1 org-agenda-redo-command))
- (nday (nth 3 org-agenda-redo-command))
- (keep (nth 4 org-agenda-redo-command)))
- (eval (list cmd iall nil nday keep)))
- (goto-char (or (text-property-any (point-min) (point-max) 'org-today t)
- (point-min)))))
- (defun org-agenda-later (arg)
- "Go forward in time by `org-agenda-ndays' days.
- With prefix ARG, go forward that many times `org-agenda-ndays'."
- (interactive "p")
- (org-agenda-check-type t 'agenda)
- (org-agenda-list (if (boundp 'include-all-loc) include-all-loc nil)
- (+ starting-day (* arg org-agenda-ndays)) nil t))
- (defun org-agenda-earlier (arg)
- "Go back in time by `org-agenda-ndays' days.
- With prefix ARG, go back that many times `org-agenda-ndays'."
- (interactive "p")
- (org-agenda-check-type t 'agenda)
- (org-agenda-list (if (boundp 'include-all-loc) include-all-loc nil)
- (- starting-day (* arg org-agenda-ndays)) nil t))
- (defun org-agenda-week-view ()
- "Switch to weekly view for agenda."
- (interactive)
- (org-agenda-check-type t 'agenda)
- (setq org-agenda-ndays 7)
- (org-agenda-list include-all-loc
- (or (get-text-property (point) 'day)
- starting-day)
- nil t)
- (org-agenda-set-mode-name)
- (message "Switched to week view"))
- (defun org-agenda-day-view ()
- "Switch to daily view for agenda."
- (interactive)
- (org-agenda-check-type t 'agenda)
- (setq org-agenda-ndays 1)
- (org-agenda-list include-all-loc
- (or (get-text-property (point) 'day)
- starting-day)
- nil t)
- (org-agenda-set-mode-name)
- (message "Switched to day view"))
- (defun org-agenda-next-date-line (&optional arg)
- "Jump to the next line indicating a date in agenda buffer."
- (interactive "p")
- (org-agenda-check-type t 'agenda 'timeline)
- (beginning-of-line 1)
- (if (looking-at "^\\S-") (forward-char 1))
- (if (not (re-search-forward "^\\S-" nil t arg))
- (progn
- (backward-char 1)
- (error "No next date after this line in this buffer")))
- (goto-char (match-beginning 0)))
- (defun org-agenda-previous-date-line (&optional arg)
- "Jump to the previous line indicating a date in agenda buffer."
- (interactive "p")
- (org-agenda-check-type t 'agenda 'timeline)
- (beginning-of-line 1)
- (if (not (re-search-backward "^\\S-" nil t arg))
- (error "No previous date before this line in this buffer")))
- ;; Initialize the highlight
- (defvar org-hl (org-make-overlay 1 1))
- (org-overlay-put org-hl 'face 'highlight)
- (defun org-highlight (begin end &optional buffer)
- "Highlight a region with overlay."
- (funcall (if (featurep 'xemacs) 'set-extent-endpoints 'move-overlay)
- org-hl begin end (or buffer (current-buffer))))
- (defun org-unhighlight ()
- "Detach overlay INDEX."
- (funcall (if (featurep 'xemacs) 'detach-extent 'delete-overlay) org-hl))
- (defun org-agenda-follow-mode ()
- "Toggle follow mode in an agenda buffer."
- (interactive)
- (setq org-agenda-follow-mode (not org-agenda-follow-mode))
- (org-agenda-set-mode-name)
- (message "Follow mode is %s"
- (if org-agenda-follow-mode "on" "off")))
- (defun org-agenda-log-mode ()
- "Toggle log mode in an agenda buffer."
- (interactive)
- (org-agenda-check-type t 'agenda 'timeline)
- (setq org-agenda-show-log (not org-agenda-show-log))
- (org-agenda-set-mode-name)
- (org-agenda-redo)
- (message "Log mode is %s"
- (if org-agenda-show-log "on" "off")))
- (defun org-agenda-toggle-diary ()
- "Toggle diary inclusion in an agenda buffer."
- (interactive)
- (org-agenda-check-type t 'agenda)
- (setq org-agenda-include-diary (not org-agenda-include-diary))
- (org-agenda-redo)
- (org-agenda-set-mode-name)
- (message "Diary inclusion turned %s"
- (if org-agenda-include-diary "on" "off")))
- (defun org-agenda-toggle-time-grid ()
- "Toggle time grid in an agenda buffer."
- (interactive)
- (org-agenda-check-type t 'agenda)
- (setq org-agenda-use-time-grid (not org-agenda-use-time-grid))
- (org-agenda-redo)
- (org-agenda-set-mode-name)
- (message "Time-grid turned %s"
- (if org-agenda-use-time-grid "on" "off")))
- (defun org-agenda-set-mode-name ()
- "Set the mode name to indicate all the small mode settings."
- (setq mode-name
- (concat "Org-Agenda"
- (if (equal org-agenda-ndays 1) " Day" "")
- (if (equal org-agenda-ndays 7) " Week" "")
- (if org-agenda-follow-mode " Follow" "")
- (if org-agenda-include-diary " Diary" "")
- (if org-agenda-use-time-grid " Grid" "")
- (if org-agenda-show-log " Log" "")))
- (force-mode-line-update))
- (defun org-agenda-post-command-hook ()
- (and (eolp) (not (bolp)) (backward-char 1))
- (if (and org-agenda-follow-mode
- (get-text-property (point) 'org-marker))
- (org-agenda-show)))
- (defvar org-disable-agenda-to-diary nil) ;Dynamically-scoped param.
- (defun org-get-entries-from-diary (date)
- "Get the (Emacs Calendar) diary entries for DATE."
- (let* ((fancy-diary-buffer "*temporary-fancy-diary-buffer*")
- (diary-display-hook '(fancy-diary-display))
- (list-diary-entries-hook
- (cons 'org-diary-default-entry list-diary-entries-hook))
- (diary-file-name-prefix-function nil) ; turn this feature off
- (diary-modify-entry-list-string-function 'org-modify-diary-entry-string)
- entries
- (org-disable-agenda-to-diary t))
- (save-excursion
- (save-window-excursion
- (list-diary-entries date 1)))
- (if (not (get-buffer fancy-diary-buffer))
- (setq entries nil)
- (with-current-buffer fancy-diary-buffer
- (setq buffer-read-only nil)
- (if (= (point-max) 1)
- ;; No entries
- (setq entries nil)
- ;; Omit the date and other unnecessary stuff
- (org-agenda-cleanup-fancy-diary)
- ;; Add prefix to each line and extend the text properties
- (if (= (point-max) 1)
- (setq entries nil)
- (setq entries (buffer-substring (point-min) (- (point-max) 1)))))
- (set-buffer-modified-p nil)
- (kill-buffer fancy-diary-buffer)))
- (when entries
- (setq entries (org-split-string entries "\n"))
- (setq entries
- (mapcar
- (lambda (x)
- (setq x (org-format-agenda-item "" x "Diary" nil 'time))
- ;; Extend the text properties to the beginning of the line
- (add-text-properties
- 0 (length x)
- (text-properties-at (1- (length x)) x)
- x)
- x)
- entries)))))
- (defun org-agenda-cleanup-fancy-diary ()
- "Remove unwanted stuff in buffer created by `fancy-diary-display'.
- This gets rid of the date, the underline under the date, and
- the dummy entry installed by `org-mode' to ensure non-empty diary for each
- date. It also removes lines that contain only whitespace."
- (goto-char (point-min))
- (if (looking-at ".*?:[ \t]*")
- (progn
- (replace-match "")
- (re-search-forward "\n=+$" nil t)
- (replace-match "")
- (while (re-search-backward "^ +\n?" nil t) (replace-match "")))
- (re-search-forward "\n=+$" nil t)
- (delete-region (point-min) (min (point-max) (1+ (match-end 0)))))
- (goto-char (point-min))
- (while (re-search-forward "^ +\n" nil t)
- (replace-match ""))
- (goto-char (point-min))
- (if (re-search-forward "^Org-mode dummy\n?" nil t)
- (replace-match "")))
- ;; Make sure entries from the diary have the right text properties.
- (eval-after-load "diary-lib"
- '(if (boundp 'diary-modify-entry-list-string-function)
- ;; We can rely on the hook, nothing to do
- nil
- ;; Hook not avaiable, must use advice to make this work
- (defadvice add-to-diary-list (before org-mark-diary-entry activate)
- "Make the position visible."
- (if (and org-disable-agenda-to-diary ;; called from org-agenda
- (stringp string)
- buffer-file-name)
- (setq string (org-modify-diary-entry-string string))))))
- (defun org-modify-diary-entry-string (string)
- "Add text properties to string, allowing org-mode to act on it."
- (add-text-properties
- 0 (length string)
- (list 'mouse-face 'highlight
- 'keymap org-agenda-keymap
- 'help-echo
- (format
- "mouse-2 or RET jump to diary file %s"
- (abbreviate-file-name buffer-file-name))
- 'org-agenda-diary-link t
- 'org-marker (org-agenda-new-marker (point-at-bol)))
- string)
- string)
- (defun org-diary-default-entry ()
- "Add a dummy entry to the diary.
- Needed to avoid empty dates which mess up holiday display."
- ;; Catch the error if dealing with the new add-to-diary-alist
- (when org-disable-agenda-to-diary
- (condition-case nil
- (add-to-diary-list original-date "Org-mode dummy" "")
- (error
- (add-to-diary-list original-date "Org-mode dummy" "" nil)))))
- (defun org-cycle-agenda-files ()
- "Cycle through the files in `org-agenda-files'.
- If the current buffer visits an agenda file, find the next one in the list.
- If the current buffer does not, find the first agenda file."
- (interactive)
- (let* ((fs (org-agenda-files t))
- (files (append fs (list (car fs))))
- (tcf (if buffer-file-name (file-truename buffer-file-name)))
- file)
- (unless files (error "No agenda files"))
- (catch 'exit
- (while (setq file (pop files))
- (if (equal (file-truename file) tcf)
- (when (car files)
- (find-file (car files))
- (throw 'exit t))))
- (find-file (car fs)))))
- (defun org-agenda-file-to-end ()
- "Move/add the current file to the end of the agenda file list.
- If the file is not present in the list, it is appended to the list. If it is
- present, it is moved there."
- (interactive)
- (org-agenda-file-to-front 'to-end))
- (defun org-agenda-file-to-front (&optional to-end)
- "Move/add the current file to the top of the agenda file list.
- If the file is not present in the list, it is added to the front. If it is
- present, it is moved there. With optional argument TO-END, add/move to the
- end of the list."
- (interactive "P")
- (let ((file-alist (mapcar (lambda (x)
- (cons (file-truename x) x))
- (org-agenda-files t)))
- (ctf (file-truename buffer-file-name))
- x had)
- (setq x (assoc ctf file-alist) had x)
- (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
- (if to-end
- (setq file-alist (append (delq x file-alist) (list x)))
- (setq file-alist (cons x (delq x file-alist))))
- (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
- (org-install-agenda-files-menu)
- (message "File %s to %s of agenda file list"
- (if had "moved" "added") (if to-end "end" "front"))))
- (defun org-remove-file (&optional file)
- "Remove current file from the list of files in variable `org-agenda-files'.
- These are the files which are being checked for agenda entries.
- Optional argument FILE means, use this file instead of the current."
- (interactive)
- (let* ((file (or file buffer-file-name))
- (true-file (file-truename file))
- (afile (abbreviate-file-name file))
- (files (delq nil (mapcar
- (lambda (x)
- (if (equal true-file
- (file-truename x))
- nil x))
- (org-agenda-files t)))))
- (if (not (= (length files) (length (org-agenda-files t))))
- (progn
- (org-store-new-agenda-file-list files)
- (org-install-agenda-files-menu)
- (message "Removed file: %s" afile))
- (message "File was not in list: %s" afile))))
- (defun org-file-menu-entry (file)
- (vector file (list 'find-file file) t))
- ;; FIXME: Maybe we removed a buffer visited through the menu from
- ;; org-agenda-new-buffers, so that the buffer will not be removed
- ;; when exiting the agenda????
- (defun org-get-all-dates (beg end &optional no-ranges force-today inactive)
- "Return a list of all relevant day numbers from BEG to END buffer positions.
- If NO-RANGES is non-nil, include only the start and end dates of a range,
- not every single day in the range. If FORCE-TODAY is non-nil, make
- sure that TODAY is included in the list. If INACTIVE is non-nil, also
- inactive time stamps (those in square brackets) are included."
- (let ((re (if inactive org-ts-regexp-both org-ts-regexp))
- dates date day day1 day2 ts1 ts2)
- (if force-today
- (setq dates (list (time-to-days (current-time)))))
- (save-excursion
- (goto-char beg)
- (while (re-search-forward re end t)
- (setq day (time-to-days (org-time-string-to-time
- (substring (match-string 1) 0 10))))
- (or (memq day dates) (push day dates)))
- (unless no-ranges
- (goto-char beg)
- (while (re-search-forward org-tr-regexp end t)
- (setq ts1 (substring (match-string 1) 0 10)
- ts2 (substring (match-string 2) 0 10)
- day1 (time-to-days (org-time-string-to-time ts1))
- day2 (time-to-days (org-time-string-to-time ts2)))
- (while (< (setq day1 (1+ day1)) day2)
- (or (memq day1 dates) (push day1 dates)))))
- (sort dates '<))))
- ;;;###autoload
- (defun org-diary (&rest args)
- "Return diary information from org-files.
- This function can be used in a \"sexp\" diary entry in the Emacs calendar.
- It accesses org files and extracts information from those files to be
- listed in the diary. The function accepts arguments specifying what
- items should be listed. The following arguments are allowed:
- :timestamp List the headlines of items containing a date stamp or
- date range matching the selected date. Deadlines will
- also be listed, on the expiration day.
- :deadline List any deadlines past due, or due within
- `org-deadline-warning-days'. The listing occurs only
- in the diary for *today*, not at any other date. If
- an entry is marked DONE, it is no longer listed.
- :scheduled List all items which are scheduled for the given date.
- The diary for *today* also contains items which were
- scheduled earlier and are not yet marked DONE.
- :todo List all TODO items from the org-file. This may be a
- long list - so this is not turned on by default.
- Like deadlines, these entries only show up in the
- diary for *today*, not at any other date.
- The call in the diary file should look like this:
- &%%(org-diary) ~/path/to/some/orgfile.org
- Use a separate line for each org file to check. Or, if you omit the file name,
- all files listed in `org-agenda-files' will be checked automatically:
- &%%(org-diary)
- If you don't give any arguments (as in the example above), the default
- arguments (:deadline :scheduled :timestamp) are used. So the example above may
- also be written as
- &%%(org-diary :deadline :timestamp :scheduled)
- The function expects the lisp variables `entry' and `date' to be provided
- by the caller, because this is how the calendar works. Don't use this
- function from a program - use `org-agenda-get-day-entries' instead."
- (org-agenda-maybe-reset-markers)
- (org-compile-prefix-format org-agenda-prefix-format)
- (setq args (or args '(:deadline :scheduled :timestamp)))
- (let* ((files (if (and entry (stringp entry) (string-match "\\S-" entry))
- (list entry)
- (org-agenda-files t)))
- file rtn results)
- ;; If this is called during org-agenda, don't return any entries to
- ;; the calendar. Org Agenda will list these entries itself.
- (if org-disable-agenda-to-diary (setq files nil))
- (while (setq file (pop files))
- (setq rtn (apply 'org-agenda-get-day-entries file date args))
- (setq results (append results rtn)))
- (if results
- (concat (org-finalize-agenda-entries results) "\n"))))
- (defvar org-category-table nil)
- (defun org-get-category-table ()
- "Get the table of categories and positions in current buffer."
- (let (tbl)
- (save-excursion
- (goto-char (point-min))
- (while (re-search-forward "\\(^\\|\r\\)#\\+CATEGORY:[ \t]*\\(.*\\)" nil t)
- (push (cons (point) (org-trim (match-string 2))) tbl)))
- tbl))
- (defun org-get-category (&optional pos)
- "Get the category applying to position POS."
- (if (not org-category-table)
- (cond
- ((null org-category)
- (setq org-category
- (if buffer-file-name
- (file-name-sans-extension
- (file-name-nondirectory buffer-file-name))
- "???")))
- ((symbolp org-category) (symbol-name org-category))
- (t org-category))
- (let ((tbl org-category-table)
- (pos (or pos (point))))
- (while (and tbl (> (caar tbl) pos))
- (pop tbl))
- (or (cdar tbl) (cdr (nth (1- (length org-category-table))
- org-category-table))))))
- (defun org-agenda-get-day-entries (file date &rest args)
- "Does the work for `org-diary' and `org-agenda'.
- FILE is the path to a file to be checked for entries. DATE is date like
- the one returned by `calendar-current-date'. ARGS are symbols indicating
- which kind of entries should be extracted. For details about these, see
- the documentation of `org-diary'."
- (setq args (or args '(:deadline :scheduled :timestamp)))
- (let* ((org-startup-with-deadline-check nil)
- (org-startup-folded nil)
- (buffer (if (file-exists-p file)
- (org-get-agenda-file-buffer file)
- (error "No such file %s" file)))
- arg results rtn)
- (if (not buffer)
- ;; If file does not exist, make sure an error message ends up in diary
- (list (format "ORG-AGENDA-ERROR: No such org-file %s" file))
- (with-current-buffer buffer
- (unless (eq major-mode 'org-mode)
- (error "Agenda file %s is not in `org-mode'" file))
- (setq org-category-table (org-get-category-table))
- (let ((case-fold-search nil))
- (save-excursion
- (save-restriction
- (if org-respect-restriction
- (if (org-region-active-p)
- ;; Respect a region to restrict search
- (narrow-to-region (region-beginning) (region-end)))
- ;; If we work for the calendar or many files,
- ;; get rid of any restriction
- (widen))
- ;; The way we repeatedly append to `results' makes it O(n^2) :-(
- (while (setq arg (pop args))
- (cond
- ((and (eq arg :todo)
- (equal date (calendar-current-date)))
- (setq rtn (org-agenda-get-todos))
- (setq results (append results rtn)))
- ((eq arg :timestamp)
- (setq rtn (org-agenda-get-blocks))
- (setq results (append results rtn))
- (setq rtn (org-agenda-get-timestamps))
- (setq results (append results rtn)))
- ((eq arg :scheduled)
- (setq rtn (org-agenda-get-scheduled))
- (setq results (append results rtn)))
- ((eq arg :closed)
- (setq rtn (org-agenda-get-closed))
- (setq results (append results rtn)))
- ((and (eq arg :deadline)
- (equal date (calendar-current-date)))
- (setq rtn (org-agenda-get-deadlines))
- (setq results (append results rtn))))))))
- results))))
- (defun org-entry-is-done-p ()
- "Is the current entry marked DONE?"
- (save-excursion
- (and (re-search-backward "[\r\n]\\*" nil t)
- (looking-at org-nl-done-regexp))))
- (defun org-at-date-range-p ()
- "Is the cursor inside a date range?"
- (interactive)
- (save-excursion
- (catch 'exit
- (let ((pos (point)))
- (skip-chars-backward "^<\r\n")
- (skip-chars-backward "<")
- (and (looking-at org-tr-regexp)
- (>= (match-end 0) pos)
- (throw 'exit t))
- (skip-chars-backward "^<\r\n")
- (skip-chars-backward "<")
- (and (looking-at org-tr-regexp)
- (>= (match-end 0) pos)
- (throw 'exit t)))
- nil)))
- (defun org-agenda-get-todos ()
- "Return the TODO information for agenda display."
- (let* ((props (list 'face nil
- 'done-face 'org-done
- 'mouse-face 'highlight
- 'keymap org-agenda-keymap
- 'help-echo
- (format "mouse-2 or RET jump to org file %s"
- (abbreviate-file-name buffer-file-name))))
- (regexp (concat "[\n\r]\\*+ *\\("
- (if org-select-this-todo-keyword
- (concat "\\<\\(" org-select-this-todo-keyword
- "\\)\\>")
- org-not-done-regexp)
- "[^\n\r]*\\)"))
- marker priority category tags
- ee txt)
- (goto-char (point-min))
- (while (re-search-forward regexp nil t)
- (goto-char (match-beginning 1))
- (setq marker (org-agenda-new-marker (1+ (match-beginning 0)))
- category (org-get-category)
- tags (org-get-tags-at (point))
- txt (org-format-agenda-item "" (match-string 1) category tags)
- priority
- (+ (org-get-priority txt)
- (if org-todo-kwd-priority-p
- (- org-todo-kwd-max-priority -2
- (length
- (member (match-string 2) org-todo-keywords)))
- 1)))
- (add-text-properties
- 0 (length txt) (append (list 'org-marker marker 'org-hd-marker marker
- 'priority priority 'category category)
- props)
- txt)
- (push txt ee)
- (goto-char (match-end 1)))
- (nreverse ee)))
- (defconst org-agenda-no-heading-message
- "No heading for this item in buffer or region.")
- (defun org-agenda-get-timestamps ()
- "Return the date stamp information for agenda display."
- (let* ((props (list 'face nil
- 'mouse-face 'highlight
- 'keymap org-agenda-keymap
- 'help-echo
- (format "mouse-2 or RET jump to org file %s"
- (abbreviate-file-name buffer-file-name))))
- (regexp (regexp-quote
- (substring
- (format-time-string
- (car org-time-stamp-formats)
- (apply 'encode-time ; DATE bound by calendar
- (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
- 0 11)))
- marker hdmarker deadlinep scheduledp donep tmp priority category
- ee txt timestr tags)
- (goto-char (point-min))
- (while (re-search-forward regexp nil t)
- (if (not (save-match-data (org-at-date-range-p)))
- (progn
- (setq marker (org-agenda-new-marker (match-beginning 0))
- category (org-get-category (match-beginning 0))
- tmp (buffer-substring (max (point-min)
- (- (match-beginning 0)
- org-ds-keyword-length))
- (match-beginning 0))
- timestr (buffer-substring (match-beginning 0) (point-at-eol))
- deadlinep (string-match org-deadline-regexp tmp)
- scheduledp (string-match org-scheduled-regexp tmp)
- donep (org-entry-is-done-p))
- (if (string-match ">" timestr)
- ;; substring should only run to end of time stamp
- (setq timestr (substring timestr 0 (match-end 0))))
- (save-excursion
- (if (re-search-backward "\\(^\\|\r\\)\\*+" nil t)
- (progn
- (goto-char (match-end 1))
- (setq hdmarker (org-agenda-new-marker)
- tags (org-get-tags-at))
- (looking-at "\\*+[ \t]*\\([^\r\n]+\\)")
- (setq txt (org-format-agenda-item
- (format "%s%s"
- (if deadlinep "Deadline: " "")
- (if scheduledp "Scheduled: " ""))
- (match-string 1) category tags timestr)))
- (setq txt org-agenda-no-heading-message))
- (setq priority (org-get-priority txt))
- (add-text-properties
- 0 (length txt) (append (list 'org-marker marker
- 'org-hd-marker hdmarker) props)
- txt)
- (if deadlinep
- (add-text-properties
- 0 (length txt)
- (list 'face
- (if donep 'org-done 'org-warning)
- 'undone-face 'org-warning
- 'done-face 'org-done
- 'category category
- 'priority (+ 100 priority))
- txt)
- (if scheduledp
- (add-text-properties
- 0 (length txt)
- (list 'face 'org-scheduled-today
- 'undone-face 'org-scheduled-today
- 'done-face 'org-done
- 'category category
- priority (+ 99 priority))
- txt)
- (add-text-properties
- 0 (length txt)
- (list 'priority priority 'category category) txt)))
- (push txt ee))
- (outline-next-heading))))
- (nreverse ee)))
- (defun org-agenda-get-closed ()
- "Return the logged TODO entries for agenda display."
- (let* ((props (list 'mouse-face 'highlight
- 'keymap org-agenda-keymap
- 'help-echo
- (format "mouse-2 or RET jump to org file %s"
- (abbreviate-file-name buffer-file-name))))
- (regexp (concat
- "\\<" org-closed-string " *\\["
- (regexp-quote
- (substring
- (format-time-string
- (car org-time-stamp-formats)
- (apply 'encode-time ; DATE bound by calendar
- (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
- 1 11))))
- marker hdmarker priority category tags
- ee txt timestr)
- (goto-char (point-min))
- (while (re-search-forward regexp nil t)
- (if (not (save-match-data (org-at-date-range-p)))
- (progn
- (setq marker (org-agenda-new-marker (match-beginning 0))
- category (org-get-category (match-beginning 0))
- timestr (buffer-substring (match-beginning 0) (point-at-eol))
- ;; donep (org-entry-is-done-p)
- )
- (if (string-match "\\]" timestr)
- ;; substring should only run to end of time stamp
- (setq timestr (substring timestr 0 (match-end 0))))
- (save-excursion
- (if (re-search-backward "\\(^\\|\r\\)\\*+" nil t)
- (progn
- (goto-char (match-end 1))
- (setq hdmarker (org-agenda-new-marker)
- tags (org-get-tags-at))
- (looking-at "\\*+[ \t]*\\([^\r\n]+\\)")
- (setq txt (org-format-agenda-item
- "Closed: "
- (match-string 1) category tags timestr)))
- (setq txt org-agenda-no-heading-message))
- (setq priority 100000)
- (add-text-properties
- 0 (length txt) (append (list 'org-marker marker
- 'org-hd-marker hdmarker
- 'face 'org-done
- 'priority priority
- 'category category
- 'undone-face 'org-warning
- 'done-face 'org-done) props)
- txt)
- (push txt ee))
- (outline-next-heading))))
- (nreverse ee)))
- (defun org-agenda-get-deadlines ()
- "Return the deadline information for agenda display."
- (let* ((wdays org-deadline-warning-days)
- (props (list 'mouse-face 'highlight
- 'keymap org-agenda-keymap
- 'help-echo
- (format "mouse-2 or RET jump to org file %s"
- (abbreviate-file-name buffer-file-name))))
- (regexp org-deadline-time-regexp)
- (todayp (equal date (calendar-current-date))) ; DATE bound by calendar
- (d1 (calendar-absolute-from-gregorian date)) ; DATE bound by calendar
- d2 diff pos pos1 category tags
- ee txt head)
- (goto-char (point-min))
- (while (re-search-forward regexp nil t)
- (setq pos (1- (match-beginning 1))
- d2 (time-to-days
- (org-time-string-to-time (match-string 1)))
- diff (- d2 d1))
- ;; When to show a deadline in the calendar:
- ;; If the expiration is within wdays warning time.
- ;; Past-due deadlines are only shown on the current date
- (if (and (< diff wdays) todayp (not (= diff 0)))
- (save-excursion
- (setq category (org-get-category))
- (if (re-search-backward "\\(^\\|\r\\)\\*+[ \t]*" nil t)
- (progn
- (goto-char (match-end 0))
- (setq pos1 (match-end 1))
- (setq tags (org-get-tags-at pos1))
- (setq head (buffer-substring-no-properties
- (point)
- (progn (skip-chars-forward "^\r\n")
- (point))))
- (if (string-match org-looking-at-done-regexp head)
- (setq txt nil)
- (setq txt (org-format-agenda-item
- (format "In %3d d.: " diff) head category tags))))
- (setq txt org-agenda-no-heading-message))
- (when txt
- (add-text-properties
- 0 (length txt)
- (append
- (list 'org-marker (org-agenda-new-marker pos)
- 'org-hd-marker (org-agenda-new-marker pos1)
- 'priority (+ (- 10 diff) (org-get-priority txt))
- 'category category
- 'face (cond ((<= diff 0) 'org-warning)
- ((<= diff 5) 'org-scheduled-previously)
- (t nil))
- 'undone-face (cond
- ((<= diff 0) 'org-warning)
- ((<= diff 5) 'org-scheduled-previously)
- (t nil))
- 'done-face 'org-done)
- props)
- txt)
- (push txt ee)))))
- ee))
- (defun org-agenda-get-scheduled ()
- "Return the scheduled information for agenda display."
- (let* ((props (list 'face 'org-scheduled-previously
- 'undone-face 'org-scheduled-previously
- 'done-face 'org-done
- 'mouse-face 'highlight
- 'keymap org-agenda-keymap
- 'help-echo
- (format "mouse-2 or RET jump to org file %s"
- (abbreviate-file-name buffer-file-name))))
- (regexp org-scheduled-time-regexp)
- (todayp (equal date (calendar-current-date))) ; DATE bound by calendar
- (d1 (calendar-absolute-from-gregorian date)) ; DATE bound by calendar
- d2 diff pos pos1 category tags
- ee txt head)
- (goto-char (point-min))
- (while (re-search-forward regexp nil t)
- (setq pos (1- (match-beginning 1))
- d2 (time-to-days
- (org-time-string-to-time (match-string 1)))
- diff (- d2 d1))
- ;; When to show a scheduled item in the calendar:
- ;; If it is on or past the date.
- (if (and (< diff 0) todayp)
- (save-excursion
- (setq category (org-get-category))
- (if (re-search-backward "\\(^\\|\r\\)\\*+[ \t]*" nil t)
- (progn
- (goto-char (match-end 0))
- (setq pos1 (match-end 1))
- (setq tags (org-get-tags-at))
- (setq head (buffer-substring-no-properties
- (point)
- (progn (skip-chars-forward "^\r\n") (point))))
- (if (string-match org-looking-at-done-regexp head)
- (setq txt nil)
- (setq txt (org-format-agenda-item
- (format "Sched.%2dx: " (- 1 diff)) head
- category tags))))
- (setq txt org-agenda-no-heading-message))
- (when txt
- (add-text-properties
- 0 (length txt)
- (append (list 'org-marker (org-agenda-new-marker pos)
- 'org-hd-marker (org-agenda-new-marker pos1)
- 'priority (+ (- 5 diff) (org-get-priority txt))
- 'category category)
- props) txt)
- (push txt ee)))))
- ee))
- (defun org-agenda-get-blocks ()
- "Return the date-range information for agenda display."
- (let* ((props (list 'face nil
- 'mouse-face 'highlight
- 'keymap org-agenda-keymap
- 'help-echo
- (format "mouse-2 or RET jump to org file %s"
- (abbreviate-file-name buffer-file-name))))
- (regexp org-tr-regexp)
- (d0 (calendar-absolute-from-gregorian date))
- marker hdmarker ee txt d1 d2 s1 s2 timestr category tags)
- (goto-char (point-min))
- (while (re-search-forward regexp nil t)
- (setq timestr (match-string 0)
- s1 (match-string 1)
- s2 (match-string 2)
- d1 (time-to-days (org-time-string-to-time s1))
- d2 (time-to-days (org-time-string-to-time s2)))
- (if (and (> (- d0 d1) -1) (> (- d2 d0) -1))
- ;; Only allow days between the limits, because the normal
- ;; date stamps will catch the limits.
- (save-excursion
- (setq marker (org-agenda-new-marker (point)))
- (setq category (org-get-category))
- (if (re-search-backward "\\(^\\|\r\\)\\*+" nil t)
- (progn
- (setq hdmarker (org-agenda-new-marker (match-end 1)))
- (goto-char (match-end 1))
- (setq tags (org-get-tags-at))
- (looking-at "\\*+[ \t]*\\([^\r\n]+\\)")
- (setq txt (org-format-agenda-item
- (format (if (= d1 d2) "" "(%d/%d): ")
- (1+ (- d0 d1)) (1+ (- d2 d1)))
- (match-string 1) category tags
- (if (= d0 d1) timestr))))
- (setq txt org-agenda-no-heading-message))
- (add-text-properties
- 0 (length txt) (append (list 'org-marker marker
- 'org-hd-marker hdmarker
- 'priority (org-get-priority txt)
- 'category category)
- props)
- txt)
- (push txt ee)))
- (outline-next-heading))
- ;; Sort the entries by expiration date.
- (nreverse ee)))
- (defconst org-plain-time-of-day-regexp
- (concat
- "\\(\\<[012]?[0-9]"
- "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
- "\\(--?"
- "\\(\\<[012]?[0-9]"
- "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
- "\\)?")
- "Regular expression to match a plain time or time range.
- Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
- groups carry important information:
- 0 the full match
- 1 the first time, range or not
- 8 the second time, if it is a range.")
- (defconst org-stamp-time-of-day-regexp
- (concat
- "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} +[a-zA-Z]+ +\\)"
- "\\([012][0-9]:[0-5][0-9]\\)>"
- "\\(--?"
- "<\\1\\([012][0-9]:[0-5][0-9]\\)>\\)?")
- "Regular expression to match a timestamp time or time range.
- After a match, the following groups carry important information:
- 0 the full match
- 1 date plus weekday, for backreferencing to make sure both times on same day
- 2 the first time, range or not
- 4 the second time, if it is a range.")
- (defvar org-prefix-has-time nil
- "A flag, set by `org-compile-prefix-format'.
- The flag is set if the currently compiled format contains a `%t'.")
- (defvar org-prefix-has-tag nil
- "A flag, set by `org-compile-prefix-format'.
- The flag is set if the currently compiled format contains a `%T'.")
- (defun org-format-agenda-item (extra txt &optional category tags dotime noprefix)
- "Format TXT to be inserted into the agenda buffer.
- In particular, it adds the prefix and corresponding text properties. EXTRA
- must be a string and replaces the `%s' specifier in the prefix format.
- CATEGORY (string, symbol or nil) may be used to overrule the default
- category taken from local variable or file name. It will replace the `%c'
- specifier in the format. DOTIME, when non-nil, indicates that a
- time-of-day should be extracted from TXT for sorting of this entry, and for
- the `%t' specifier in the format. When DOTIME is a string, this string is
- searched for a time before TXT is. NOPREFIX is a flag and indicates that
- only the correctly processes TXT should be returned - this is used by
- `org-agenda-change-all-lines'. TAG can be the tag of the headline."
- (save-match-data
- ;; Diary entries sometimes have extra whitespace at the beginning
- (if (string-match "^ +" txt) (setq txt (replace-match "" nil nil txt)))
- (let* ((category (or category
- org-category
- (if buffer-file-name
- (file-name-sans-extension
- (file-name-nondirectory buffer-file-name))
- "")))
- (tag (or (nth (1- (or (length tags) 0)) tags) ""))
- time ;; needed for the eval of the prefix format
- (ts (if dotime (concat (if (stringp dotime) dotime "") txt)))
- (time-of-day (and dotime (org-get-time-of-day ts)))
- stamp plain s0 s1 s2 rtn)
- (when (and dotime time-of-day org-prefix-has-time)
- ;; Extract starting and ending time and move them to prefix
- (when (or (setq stamp (string-match org-stamp-time-of-day-regexp ts))
- (setq plain (string-match org-plain-time-of-day-regexp ts)))
- (setq s0 (match-string 0 ts)
- s1 (match-string (if plain 1 2) ts)
- s2 (match-string (if plain 8 4) ts))
- ;; If the times are in TXT (not in DOTIMES), and the prefix will list
- ;; them, we might want to remove them there to avoid duplication.
- ;; The user can turn this off with a variable.
- (if (and org-agenda-remove-times-when-in-prefix (or stamp plain)
- (string-match (concat (regexp-quote s0) " *") txt)
- (if (eq org-agenda-remove-times-when-in-prefix 'beg)
- (= (match-beginning 0) 0)
- t))
- (setq txt (replace-match "" nil nil txt))))
- ;; Normalize the time(s) to 24 hour
- (if s1 (setq s1 (org-get-time-of-day s1 'string)))
- (if s2 (setq s2 (org-get-time-of-day s2 'string))))
- (when (and (or (eq org-agenda-remove-tags-when-in-prefix t)
- (and org-agenda-remove-tags-when-in-prefix
- org-prefix-has-tag))
- (string-match ":[a-zA-Z_@0-9:]+:[ \t]*$" txt))
- (setq txt (replace-match "" t t txt)))
- ;; Create the final string
- (if noprefix
- (setq rtn txt)
- ;; Prepare the variables needed in the eval of the compiled format
- (setq time (cond (s2 (concat s1 "-" s2))
- (s1 (concat s1 "......"))
- (t ""))
- extra (or extra "")
- category (if (symbolp category) (symbol-name category) category))
- ;; Evaluate the compiled format
- (setq rtn (concat (eval org-prefix-format-compiled) txt)))
- ;; And finally add the text properties
- (add-text-properties
- 0 (length rtn) (list 'category (downcase category)
- 'tags tags
- 'prefix-length (- (length rtn) (length txt))
- 'time-of-day time-of-day
- 'dotime dotime)
- rtn)
- rtn)))
- (defun org-agenda-add-time-grid-maybe (list ndays todayp)
- (catch 'exit
- (cond ((not org-agenda-use-time-grid) (throw 'exit list))
- ((and todayp (member 'today (car org-agenda-time-grid))))
- ((and (= ndays 1) (member 'daily (car org-agenda-time-grid))))
- ((member 'weekly (car org-agenda-time-grid)))
- (t (throw 'exit list)))
- (let* ((have (delq nil (mapcar
- (lambda (x) (get-text-property 1 'time-of-day x))
- list)))
- (string (nth 1 org-agenda-time-grid))
- (gridtimes (nth 2 org-agenda-time-grid))
- (req (car org-agenda-time-grid))
- (remove (member 'remove-match req))
- new time)
- (if (and (member 'require-timed req) (not have))
- ;; don't show empty grid
- (throw 'exit list))
- (while (setq time (pop gridtimes))
- (unless (and remove (member time have))
- (setq time (int-to-string time))
- (push (org-format-agenda-item
- nil string "" nil ;; FIXME: put a category for the grid?
- (concat (substring time 0 -2) ":" (substring time -2)))
- new)
- (put-text-property
- 1 (length (car new)) 'face 'org-time-grid (car new))))
- (if (member 'time-up org-agenda-sorting-strategy)
- (append new list)
- (append list new)))))
- (defun org-compile-prefix-format (format)
- "Compile the prefix format into a Lisp form that can be evaluated.
- The resulting form is returned and stored in the variable
- `org-prefix-format-compiled'."
- (setq org-prefix-has-time nil org-prefix-has-tag nil)
- (let ((start 0) varform vars var (s format)e c f opt)
- (while (string-match "%\\(\\?\\)?\\([-+]?[0-9.]*\\)\\([ .;,:!?=|/<>]?\\)\\([cts]\\)"
- s start)
- (setq var (cdr (assoc (match-string 4 s)
- '(("c" . category) ("t" . time) ("s" . extra)
- ("T" . tag))))
- c (or (match-string 3 s) "")
- opt (match-beginning 1)
- start (1+ (match-beginning 0)))
- (if (equal var 'time) (setq org-prefix-has-time t))
- (if (equal var 'tag) (setq org-prefix-has-tag t))
- (setq f (concat "%" (match-string 2 s) "s"))
- (if opt
- (setq varform
- `(if (equal "" ,var)
- ""
- (format ,f (if (equal "" ,var) "" (concat ,var ,c)))))
- (setq varform `(format ,f (if (equal ,var "") "" (concat ,var ,c)))))
- (setq s (replace-match "%s" t nil s))
- (push varform vars))
- (setq vars (nreverse vars))
- (setq org-prefix-format-compiled `(format ,s ,@vars))))
- (defun org-get-time-of-day (s &optional string)
- "Check string S for a time of day.
- If found, return it as a military time number between 0 and 2400.
- If not found, return nil.
- The optional STRING argument forces conversion into a 5 character wide string
- HH:MM."
- (save-match-data
- (when
- (or
- (string-match
- "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)\\([AaPp][Mm]\\)?\\> *" s)
- (string-match
- "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\([AaPp][Mm]\\)\\> *" s))
- (let* ((t0 (+ (* 100
- (+ (string-to-number (match-string 1 s))
- (if (and (match-beginning 4)
- (equal (downcase (match-string 4 s)) "pm"))
- 12 0)))
- (if (match-beginning 3)
- (string-to-number (match-string 3 s))
- 0)))
- (t1 (concat " "
- (if (< t0 100) "0" "") (if (< t0 10) "0" "")
- (int-to-string t0))))
- (if string (concat (substring t1 -4 -2) ":" (substring t1 -2)) t0)))))
- (defun org-finalize-agenda-entries (list)
- "Sort and concatenate the agenda items."
- (mapconcat 'identity (sort list 'org-entries-lessp) "\n"))
- (defsubst org-cmp-priority (a b)
- "Compare the priorities of string A and B."
- (let ((pa (or (get-text-property 1 'priority a) 0))
- (pb (or (get-text-property 1 'priority b) 0)))
- (cond ((> pa pb) +1)
- ((< pa pb) -1)
- (t nil))))
- (defsubst org-cmp-category (a b)
- "Compare the string values of categories of strings A and B."
- (let ((ca (or (get-text-property 1 'category a) ""))
- (cb (or (get-text-property 1 'category b) "")))
- (cond ((string-lessp ca cb) -1)
- ((string-lessp cb ca) +1)
- (t nil))))
- (defsubst org-cmp-time (a b)
- "Compare the time-of-day values of strings A and B."
- (let* ((def (if org-sort-agenda-notime-is-late 2401 -1))
- (ta (or (get-text-property 1 'time-of-day a) def))
- (tb (or (get-text-property 1 'time-of-day b) def)))
- (cond ((< ta tb) -1)
- ((< tb ta) +1)
- (t nil))))
- (defun org-entries-lessp (a b)
- "Predicate for sorting agenda entries."
- ;; The following variables will be used when the form is evaluated.
- (let* ((time-up (org-cmp-time a b))
- (time-down (if time-up (- time-up) nil))
- (priority-up (org-cmp-priority a b))
- (priority-down (if priority-up (- priority-up) nil))
- (category-up (org-cmp-category a b))
- (category-down (if category-up (- category-up) nil))
- (category-keep (if category-up +1 nil))) ; FIXME +1 or -1?
- (cdr (assoc
- (eval (cons 'or org-agenda-sorting-strategy))
- '((-1 . t) (1 . nil) (nil . nil))))))
- (defun org-agenda-show-priority ()
- "Show the priority of the current item.
- This priority is composed of the main priority given with the [#A] cookies,
- and by additional input from the age of a schedules or deadline entry."
- (interactive)
- (let* ((pri (get-text-property (point-at-bol) 'priority)))
- (message "Priority is %d" (if pri pri -1000))))
- (defun org-agenda-show-tags ()
- "Show the tags applicable to the current item."
- (interactive)
- (let* ((tags (get-text-property (point-at-bol) 'tags)))
- (if tags
- (message "Tags are :%s:" (mapconcat 'identity tags ":"))
- (message "No tags associated with this line"))))
- (defun org-agenda-goto (&optional highlight)
- "Go to the Org-mode file which contains the item at point."
- (interactive)
- (let* ((marker (or (get-text-property (point) 'org-marker)
- (org-agenda-error)))
- (buffer (marker-buffer marker))
- (pos (marker-position marker)))
- (switch-to-buffer-other-window buffer)
- (widen)
- (goto-char pos)
- (when (eq major-mode 'org-mode)
- (org-show-hidden-entry)
- (save-excursion
- (and (outline-next-heading)
- (org-flag-heading nil)))) ; show the next heading
- (and highlight (org-highlight (point-at-bol) (point-at-eol)))))
- (defun org-agenda-switch-to ()
- "Go to the Org-mode file which contains the item at point."
- (interactive)
- (let* ((marker (or (get-text-property (point) 'org-marker)
- (org-agenda-error)))
- (buffer (marker-buffer marker))
- (pos (marker-position marker)))
- (switch-to-buffer buffer)
- (delete-other-windows)
- (widen)
- (goto-char pos)
- (when (eq major-mode 'org-mode)
- (org-show-hidden-entry)
- (save-excursion
- (and (outline-next-heading)
- (org-flag-heading nil)))))) ; show the next heading
- (defun org-agenda-goto-mouse (ev)
- "Go to the Org-mode file which contains the item at the mouse click."
- (interactive "e")
- (mouse-set-point ev)
- (org-agenda-goto))
- (defun org-agenda-show ()
- "Display the Org-mode file which contains the item at point."
- (interactive)
- (let ((win (selected-window)))
- (org-agenda-goto t)
- (select-window win)))
- (defun org-agenda-recenter (arg)
- "Display the Org-mode file which contains the item at point and recenter."
- (interactive "P")
- (let ((win (selected-window)))
- (org-agenda-goto t)
- (recenter arg)
- (select-window win)))
- (defun org-agenda-show-mouse (ev)
- "Display the Org-mode file which contains the item at the mouse click."
- (interactive "e")
- (mouse-set-point ev)
- (org-agenda-show))
- (defun org-agenda-check-no-diary ()
- "Check if the entry is a diary link and abort if yes."
- (if (get-text-property (point) 'org-agenda-diary-link)
- (org-agenda-error)))
- (defun org-agenda-error ()
- (error "Command not allowed in this line"))
- (defvar org-last-heading-marker (make-marker)
- "Marker pointing to the headline that last changed its TODO state
- by a remote command from the agenda.")
- (defun org-agenda-todo (&optional arg)
- "Cycle TODO state of line at point, also in Org-mode file.
- This changes the line at point, all other lines in the agenda referring to
- the same tree node, and the headline of the tree node in the Org-mode file."
- (interactive "P")
- (org-agenda-check-no-diary)
- (let* ((col (current-column))
- (marker (or (get-text-property (point) 'org-marker)
- (org-agenda-error)))
- (buffer (marker-buffer marker))
- (pos (marker-position marker))
- (hdmarker (get-text-property (point) 'org-hd-marker))
- (buffer-read-only nil)
- newhead)
- (with-current-buffer buffer
- (widen)
- (goto-char pos)
- (org-show-hidden-entry)
- (save-excursion
- (and (outline-next-heading)
- (org-flag-heading nil))) ; show the next heading
- (org-todo arg)
- (forward-char 1)
- (setq newhead (org-get-heading))
- (save-excursion
- (org-back-to-heading)
- (move-marker org-last-heading-marker (point))))
- (beginning-of-line 1)
- (save-excursion
- (org-agenda-change-all-lines newhead hdmarker 'fixface))
- (move-to-column col)))
- (defun org-agenda-change-all-lines (newhead hdmarker &optional fixface)
- "Change all lines in the agenda buffer which match HDMARKER.
- The new content of the line will be NEWHEAD (as modified by
- `org-format-agenda-item'). HDMARKER is checked with
- `equal' against all `org-hd-marker' text properties in the file.
- If FIXFACE is non-nil, the face of each item is modified acording to
- the new TODO state."
- (let* (props m pl undone-face done-face finish new dotime cat tags)
- ; (setq newhead (org-format-agenda-item "x" newhead "x" nil 'noprefix))
- (save-excursion
- (goto-char (point-max))
- (beginning-of-line 1)
- (while (not finish)
- (setq finish (bobp))
- (when (and (setq m (get-text-property (point) 'org-hd-marker))
- (equal m hdmarker))
- (setq props (text-properties-at (point))
- dotime (get-text-property (point) 'dotime)
- cat (get-text-property (point) 'category)
- tags (get-text-property (point) 'tags)
- new (org-format-agenda-item "x" newhead cat tags dotime 'noprefix)
- pl (get-text-property (point) 'prefix-length)
- undone-face (get-text-property (point) 'undone-face)
- done-face (get-text-property (point) 'done-face))
- (move-to-column pl)
- (if (looking-at ".*")
- (progn
- (replace-match new t t)
- (beginning-of-line 1)
- (add-text-properties (point-at-bol) (point-at-eol) props)
- (if fixface
- (add-text-properties
- (point-at-bol) (point-at-eol)
- (list 'face
- (if org-last-todo-state-is-todo
- undone-face done-face))))
- (beginning-of-line 1))
- (error "Line update did not work")))
- (beginning-of-line 0)))))
- (defun org-agenda-priority-up ()
- "Increase the priority of line at point, also in Org-mode file."
- (interactive)
- (org-agenda-priority 'up))
- (defun org-agenda-priority-down ()
- "Decrease the priority of line at point, also in Org-mode file."
- (interactive)
- (org-agenda-priority 'down))
- (defun org-agenda-priority (&optional force-direction)
- "Set the priority of line at point, also in Org-mode file.
- This changes the line at point, all other lines in the agenda referring to
- the same tree node, and the headline of the tree node in the Org-mode file."
- (interactive)
- (org-agenda-check-no-diary)
- (let* ((marker (or (get-text-property (point) 'org-marker)
- (org-agenda-error)))
- (buffer (marker-buffer marker))
- (pos (marker-position marker))
- (hdmarker (get-text-property (point) 'org-hd-marker))
- (buffer-read-only nil)
- newhead)
- (with-current-buffer buffer
- (widen)
- (goto-char pos)
- (org-show-hidden-entry)
- (save-excursion
- (and (outline-next-heading)
- (org-flag-heading nil))) ; show the next heading
- (funcall 'org-priority force-direction)
- (end-of-line 1)
- (setq newhead (org-get-heading)))
- (org-agenda-change-all-lines newhead hdmarker)
- (beginning-of-line 1)))
- (defun org-get-tags-at (&optional pos)
- "Get a list of all headline targs applicable at POS.
- POS defaults to point. If tags are inherited, the list contains
- the targets in the same sequence as the headlines appear, i.e.
- the tags of the current headline come last."
- (interactive)
- (let (tags)
- (save-excursion
- (goto-char (or pos (point)))
- (save-match-data
- (org-back-to-heading t)
- (condition-case nil
- (while t
- (if (looking-at "[^\r\n]+?:\\([a-zA-Z_@0-9:]+\\):[ \t]*\\([\n\r]\\|\\'\\)")
- (setq tags (append (org-split-string (match-string 1) ":") tags)))
- (or org-use-tag-inheritance (error ""))
- (org-up-heading-all 1))
- (error nil))))
- (message "%s" tags)
- tags))
- (defun org-agenda-set-tags ()
- "Set tags for the current headline."
- (interactive)
- (org-agenda-check-no-diary)
- (org-agenda-show) ;;; FIXME This is a stupid hack and should not be needed
- (let* ((hdmarker (or (get-text-property (point) 'org-hd-marker)
- (org-agenda-error)))
- (buffer (marker-buffer hdmarker))
- (pos (marker-position hdmarker))
- (buffer-read-only nil)
- newhead)
- (with-current-buffer buffer
- (widen)
- (goto-char pos)
- (org-show-hidden-entry)
- (save-excursion
- (and (outline-next-heading)
- (org-flag-heading nil))) ; show the next heading
- (call-interactively 'org-set-tags)
- (end-of-line 1)
- (setq newhead (org-get-heading)))
- (org-agenda-change-all-lines newhead hdmarker)
- (beginning-of-line 1)))
- (defun org-agenda-date-later (arg &optional what)
- "Change the date of this item to one day later."
- (interactive "p")
- (org-agenda-check-type t 'agenda 'timeline)
- (org-agenda-check-no-diary)
- (let* ((marker (or (get-text-property (point) 'org-marker)
- (org-agenda-error)))
- (buffer (marker-buffer marker))
- (pos (marker-position marker)))
- (with-current-buffer buffer
- (widen)
- (goto-char pos)
- (if (not (org-at-timestamp-p))
- (error "Cannot find time stamp"))
- (org-timestamp-change arg (or what 'day))
- (message "Time stamp changed to %s" org-last-changed-timestamp))))
- (defun org-agenda-date-earlier (arg &optional what)
- "Change the date of this item to one day earlier."
- (interactive "p")
- (org-agenda-date-later (- arg) what))
- (defun org-agenda-date-prompt (arg)
- "Change the date of this item. Date is prompted for, with default today.
- The prefix ARG is passed to the `org-time-stamp' command and can therefore
- be used to request time specification in the time stamp."
- (interactive "P")
- (org-agenda-check-type t 'agenda 'timeline)
- (org-agenda-check-no-diary)
- (let* ((marker (or (get-text-property (point) 'org-marker)
- (org-agenda-error)))
- (buffer (marker-buffer marker))
- (pos (marker-position marker)))
- (with-current-buffer buffer
- (widen)
- (goto-char pos)
- (if (not (org-at-timestamp-p))
- (error "Cannot find time stamp"))
- (org-time-stamp arg)
- (message "Time stamp changed to %s" org-last-changed-timestamp))))
- (defun org-get-heading ()
- "Return the heading of the current entry, without the stars."
- (save-excursion
- (and (memq (char-before) '(?\n ?\r)) (skip-chars-forward "^\n\r"))
- ;;FIXME???????? (and (bolp) (end-of-line 1))
- (if (and (re-search-backward "[\r\n]\\*" nil t)
- (looking-at "[\r\n]\\*+[ \t]+\\([^\r\n]*\\)"))
- (match-string 1)
- "")))
- (defun org-agenda-diary-entry ()
- "Make a diary entry, like the `i' command from the calendar.
- All the standard commands work: block, weekly etc."
- (interactive)
- (org-agenda-check-type t 'agenda 'timeline)
- (require 'diary-lib)
- (let* ((char (progn
- (message "Diary entry: [d]ay [w]eekly [m]onthly [y]early [a]nniversary [b]lock [c]yclic")
- (read-char-exclusive)))
- (cmd (cdr (assoc char
- '((?d . insert-diary-entry)
- (?w . insert-weekly-diary-entry)
- (?m . insert-monthly-diary-entry)
- (?y . insert-yearly-diary-entry)
- (?a . insert-anniversary-diary-entry)
- (?b . insert-block-diary-entry)
- (?c . insert-cyclic-diary-entry)))))
- (oldf (symbol-function 'calendar-cursor-to-date))
- (point (point))
- (mark (or (mark t) (point))))
- (unless cmd
- (error "No command associated with <%c>" char))
- (unless (and (get-text-property point 'day)
- (or (not (equal ?b char))
- (get-text-property mark 'day)))
- (error "Don't know which date to use for diary entry"))
- ;; We implement this by hacking the `calendar-cursor-to-date' function
- ;; and the `calendar-mark-ring' variable. Saves a lot of code.
- (let ((calendar-mark-ring
- (list (calendar-gregorian-from-absolute
- (or (get-text-property mark 'day)
- (get-text-property point 'day))))))
- (unwind-protect
- (progn
- (fset 'calendar-cursor-to-date
- (lambda (&optional error)
- (calendar-gregorian-from-absolute
- (get-text-property point 'day))))
- (call-interactively cmd))
- (fset 'calendar-cursor-to-date oldf)))))
- (defun org-agenda-execute-calendar-command (cmd)
- "Execute a calendar command from the agenda, with the date associated to
- the cursor position."
- (org-agenda-check-type t 'agenda 'timeline)
- (require 'diary-lib)
- (unless (get-text-property (point) 'day)
- (error "Don't know which date to use for calendar command"))
- (let* ((oldf (symbol-function 'calendar-cursor-to-date))
- (point (point))
- (date (calendar-gregorian-from-absolute
- (get-text-property point 'day)))
- (displayed-day (extract-calendar-day date))
- (displayed-month (extract-calendar-month date))
- (displayed-year (extract-calendar-year date)))
- (unwind-protect
- (progn
- (fset 'calendar-cursor-to-date
- (lambda (&optional error)
- (calendar-gregorian-from-absolute
- (get-text-property point 'day))))
- (call-interactively cmd))
- (fset 'calendar-cursor-to-date oldf))))
- (defun org-agenda-phases-of-moon ()
- "Display the phases of the moon for the 3 months around the cursor date."
- (interactive)
- (org-agenda-execute-calendar-command 'calendar-phases-of-moon))
- (defun org-agenda-holidays ()
- "Display the holidays for the 3 months around the cursor date."
- (interactive)
- (org-agenda-execute-calendar-command 'list-calendar-holidays))
- (defun org-agenda-sunrise-sunset (arg)
- "Display sunrise and sunset for the cursor date.
- Latitude and longitude can be specified with the variables
- `calendar-latitude' and `calendar-longitude'. When called with prefix
- argument, latitude and longitude will be prompted for."
- (interactive "P")
- (let ((calendar-longitude (if arg nil calendar-longitude))
- (calendar-latitude (if arg nil calendar-latitude))
- (calendar-location-name
- (if arg "the given coordinates" calendar-location-name)))
- (org-agenda-execute-calendar-command 'calendar-sunrise-sunset)))
- (defun org-agenda-goto-calendar ()
- "Open the Emacs calendar with the date at the cursor."
- (interactive)
- (org-agenda-check-type t 'agenda 'timeline)
- (let* ((day (or (get-text-property (point) 'day)
- (error "Don't know which date to open in calendar")))
- (date (calendar-gregorian-from-absolute day))
- (calendar-move-hook nil)
- (view-diary-entries-initially nil))
- (calendar)
- (calendar-goto-date date)))
- (defun org-calendar-goto-agenda ()
- "Compute the Org-mode agenda for the calendar date displayed at the cursor.
- This is a command that has to be installed in `calendar-mode-map'."
- (interactive)
- (org-agenda-list nil (calendar-absolute-from-gregorian
- (calendar-cursor-to-date))
- nil t))
- (defun org-agenda-convert-date ()
- (interactive)
- (org-agenda-check-type t 'agenda 'timeline)
- (let ((day (get-text-property (point) 'day))
- date s)
- (unless day
- (error "Don't know which date to convert"))
- (setq date (calendar-gregorian-from-absolute day))
- (setq s (concat
- "Gregorian: " (calendar-date-string date) "\n"
- "ISO: " (calendar-iso-date-string date) "\n"
- "Day of Yr: " (calendar-day-of-year-string date) "\n"
- "Julian: " (calendar-julian-date-string date) "\n"
- "Astron. JD: " (calendar-astro-date-string date)
- " (Julian date number at noon UTC)\n"
- "Hebrew: " (calendar-hebrew-date-string date) " (until sunset)\n"
- "Islamic: " (calendar-islamic-date-string date) " (until sunset)\n"
- "French: " (calendar-french-date-string date) "\n"
- "Mayan: " (calendar-mayan-date-string date) "\n"
- "Coptic: " (calendar-coptic-date-string date) "\n"
- "Ethiopic: " (calendar-ethiopic-date-string date) "\n"
- "Persian: " (calendar-persian-date-string date) "\n"
- "Chinese: " (calendar-chinese-date-string date) "\n"))
- (with-output-to-temp-buffer "*Dates*"
- (princ s))
- (if (fboundp 'fit-window-to-buffer)
- (fit-window-to-buffer (get-buffer-window "*Dates*")))))
- ;;; Tags
- (defun org-scan-tags (action matcher &optional todo-only)
- "Scan headline tags with inheritance and produce output ACTION.
- ACTION can be `sparse-tree' or `agenda'. MATCHER is a Lisp form to be
- evaluated, testing if a given set of tags qualifies a headline for
- inclusion. When TODO-ONLY is non-nil, only lines with a TODO keyword
- are included in the output."
- (let* ((re (concat "[\n\r]" outline-regexp " *\\(\\<\\("
- (mapconcat 'regexp-quote
- (nreverse (cdr (reverse org-todo-keywords)))
- "\\|")
- "\\>\\)\\)? *\\(.*?\\)\\(:[A-Za-z_@0-9:]+:\\)?[ \t]*[\n\r]"))
- (props (list 'face nil
- 'done-face 'org-done
- 'undone-face nil
- 'mouse-face 'highlight
- 'keymap org-agenda-keymap
- 'help-echo
- (format "mouse-2 or RET jump to org file %s"
- (abbreviate-file-name buffer-file-name))))
- lspos
- tags tags-list tags-alist (llast 0) rtn level category i txt
- todo marker)
- (save-excursion
- (goto-char (point-min))
- (when (eq action 'sparse-tree) (hide-sublevels 1))
- (while (re-search-forward re nil t)
- (setq todo (if (match-end 1) (match-string 2))
- tags (if (match-end 4) (match-string 4)))
- (goto-char (setq lspos (1+ (match-beginning 0))))
- (setq level (funcall outline-level)
- category (org-get-category))
- (setq i llast llast level)
- ;; remove tag lists from same and sublevels
- (while (>= i level)
- (when (setq entry (assoc i tags-alist))
- (setq tags-alist (delete entry tags-alist)))
- (setq i (1- i)))
- ;; add the nex tags
- (when tags
- (setq tags (mapcar 'downcase (org-split-string tags ":"))
- tags-alist
- (cons (cons level tags) tags-alist)))
- ;; compile tags for current headline
- (setq tags-list
- (if org-use-tag-inheritance
- (apply 'append (mapcar 'cdr tags-alist))
- tags))
- (when (and (or (not todo-only) todo)
- (eval matcher))
- ;; list this headline
- (if (eq action 'sparse-tree)
- (progn
- (org-show-hierarchy-above))
- (setq txt (org-format-agenda-item
- ""
- (concat
- (if org-tags-match-list-sublevels
- (make-string (1- level) ?.) "")
- (org-get-heading))
- category tags-list))
- (goto-char lspos)
- (setq marker (org-agenda-new-marker))
- (add-text-properties
- 0 (length txt)
- (append (list 'org-marker marker 'org-hd-marker marker
- 'category category)
- props)
- txt)
- (push txt rtn))
- ;; if we are to skip sublevels, jump to end of subtree
- (point)
- (or org-tags-match-list-sublevels (org-end-of-subtree)))))
- (nreverse rtn)))
- (defun org-tags-sparse-tree (&optional arg match)
- "Create a sparse tree according to tags search string MATCH.
- MATCH can contain positive and negative selection of tags, like
- \"+WORK+URGENT-WITHBOSS\"."
- (interactive "P")
- (let ((org-show-following-heading nil)
- (org-show-hierarchy-above nil))
- (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)))))
- (defun org-make-tags-matcher (match)
- "Create the TAGS matcher form for the tags-selecting string MATCH."
- (unless match
- ;; Get a new match request, with completion
- (setq org-last-tags-completion-table
- (or (org-get-buffer-tags)
- org-last-tags-completion-table))
- (setq match (completing-read
- "Tags: " 'org-tags-completion-function nil nil nil
- 'org-tags-history)))
- ;; parse the string and create a lisp form
- (let ((match0 match) minus tag mm matcher orterms term orlist)
- (setq orterms (org-split-string match "|"))
- (while (setq term (pop orterms))
- (while (string-match "^&?\\([-+:]\\)?\\([A-Za-z_@0-9]+\\)" term)
- (setq minus (and (match-end 1)
- (equal (match-string 1 term) "-"))
- tag (match-string 2 term)
- term (substring term (match-end 0))
- mm (list 'member (downcase tag) 'tags-list)
- mm (if minus (list 'not mm) mm))
- (push mm matcher))
- (push (if (> (length matcher) 1) (cons 'and matcher) (car matcher))
- orlist)
- (setq matcher nil))
- (setq matcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
- ;; Return the string and lisp forms of the matcher
- (cons match0 matcher)))
- ;;;###autoload
- (defun org-tags-view (&optional todo-only match keep-modes)
- "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
- The prefix arg TODO-ONLY limits the search to TODO entries."
- (interactive "P")
- (org-agenda-maybe-reset-markers 'force)
- (org-compile-prefix-format org-agenda-prefix-format)
- (let* ((org-agenda-keep-modes keep-modes)
- (org-tags-match-list-sublevels
- (if todo-only t org-tags-match-list-sublevels))
- (win (selected-window))
- (completion-ignore-case t)
- rtn rtnall files file pos matcher
- buffer)
- (setq matcher (org-make-tags-matcher match)
- match (car matcher) matcher (cdr matcher))
- (if (not (equal (current-buffer) (get-buffer org-agenda-buffer-name)))
- (progn
- (delete-other-windows)
- (switch-to-buffer-other-window
- (get-buffer-create org-agenda-buffer-name))))
- (setq buffer-read-only nil)
- (erase-buffer)
- (org-agenda-mode) (setq buffer-read-only nil)
- (set (make-local-variable 'org-agenda-type) 'tags)
- (set (make-local-variable 'org-agenda-redo-command)
- (list 'org-tags-view (list 'quote todo-only)
- (list 'if 'current-prefix-arg nil match) t))
- (setq files (org-agenda-files)
- rtnall nil)
- (while (setq file (pop files))
- (catch 'nextfile
- (org-check-agenda-file file)
- (setq buffer (if (file-exists-p file)
- (org-get-agenda-file-buffer file)
- (error "No such file %s" file)))
- (if (not buffer)
- ;; If file does not exist, merror message to agenda
- (setq rtn (list
- (format "ORG-AGENDA-ERROR: No such org-file %s" file))
- rtnall (append rtnall rtn))
- (with-current-buffer buffer
- (unless (eq major-mode 'org-mode)
- (error "Agenda file %s is not in `org-mode'" file))
- (save-excursion
- (save-restriction
- (if org-respect-restriction
- (if (org-region-active-p)
- ;; Respect a region to restrict search
- (narrow-to-region (region-beginning) (region-end)))
- ;; If we work for the calendar or many files,
- ;; get rid of any restriction
- (widen))
- (setq rtn (org-scan-tags 'agenda matcher todo-only))
- (setq rtnall (append rtnall rtn))))))))
- (insert "Headlines with TAGS match: ")
- (add-text-properties (point-min) (1- (point))
- (list 'face 'org-link))
- (setq pos (point))
- (insert match "\n")
- (add-text-properties pos (1- (point)) (list 'face 'org-warning))
- (setq pos (point))
- (insert "Press `C-u r' to search again with new search string\n")
- (add-text-properties pos (1- (point)) (list 'face 'org-link))
- (when rtnall
- (insert (mapconcat 'identity rtnall "\n")))
- (goto-char (point-min))
- (setq buffer-read-only t)
- (org-fit-agenda-window)
- (if (not org-select-agenda-window) (select-window win))))
- (defvar org-add-colon-after-tag-completion nil) ;; dynamically skoped param
- (defun org-set-tags (&optional arg just-align)
- "Set the tags for the current headline.
- With prefix ARG, realign all tags in headings in the current buffer."
- (interactive)
- (let* (;(inherit (org-get-inherited-tags))
- (re (concat "^" outline-regexp))
- (col (current-column))
- (current (org-get-tags))
- tags hd empty invis)
- (if arg
- (save-excursion
- (goto-char (point-min))
- (while (re-search-forward re nil t)
- (org-set-tags nil t))
- (message "All tags realigned to column %d" org-tags-column))
- (if just-align
- (setq tags current)
- (setq org-last-tags-completion-table
- (or (org-get-buffer-tags)
- org-last-tags-completion-table))
- (setq tags
- (let ((org-add-colon-after-tag-completion t))
- (completing-read "Tags: " 'org-tags-completion-function
- nil nil current 'org-tags-history)))
- (while (string-match "[-+&]+" tags)
- (setq tags (replace-match ":" t t tags))))
- ;; FIXME: still optimize this by not checking when JUST-ALIGN?
- (unless (setq empty (string-match "\\`[\t ]*\\'" tags))
- (unless (string-match ":$" tags) (setq tags (concat tags ":")))
- (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
- (if (equal current "")
- (progn
- (end-of-line 1)
- (or empty (insert-before-markers " ")))
- (beginning-of-line 1)
- (setq invis (org-invisible-p))
- (looking-at (concat "\\(.*\\)\\(" (regexp-quote current) "\\)[ \t]*"))
- (setq hd (match-string 1))
- (delete-region (match-beginning 0) (match-end 0))
- (insert-before-markers (org-trim hd) (if empty "" " ")))
- ;; FIXME: What happens when adding a new tag??? Seems OK!!!
- (unless (equal tags "")
- (move-to-column (max (current-column)
- (if (> org-tags-column 0)
- org-tags-column
- (- (- org-tags-column) (length tags))))
- t)
- (insert-before-markers tags)
- (if (and (not invis) (org-invisible-p))
- (outline-flag-region (point-at-bol) (point) nil)))
- (move-to-column col))))
- (defun org-tags-completion-function (string predicate &optional flag)
- (let (s1 s2 rtn (ctable org-last-tags-completion-table))
- (if (string-match "^\\(.*[-+:&|]\\)\\([^-+:&|]*\\)$" string)
- (setq s1 (match-string 1 string)
- s2 (match-string 2 string))
- (setq s1 "" s2 string))
- (cond
- ((eq flag nil)
- ;; try completion
- (setq rtn (try-completion s2 ctable))
- (if (stringp rtn)
- (concat s1 s2 (substring rtn (length s2))
- (if (and org-add-colon-after-tag-completion
- (assoc rtn ctable))
- ":" "")))
- )
- ((eq flag t)
- ;; all-completions
- (all-completions s2 ctable)
- )
- ((eq flag 'lambda)
- ;; exact match?
- (assoc s2 ctable)))
- ))
- (defun org-get-tags ()
- "Get the TAGS string in the current headline."
- (unless (org-on-heading-p)
- (error "Not on a heading"))
- (save-excursion
- (beginning-of-line 1)
- (if (looking-at ".*[ \t]\\(:[A-Za-z_@0-9:]+:\\)[ \t]*\\(\r\\|$\\)")
- (match-string 1)
- "")))
- (defun org-get-buffer-tags ()
- "Get a table of all tags used in the buffer, for completion."
- (let (tags)
- (save-excursion
- (goto-char (point-min))
- (while (re-search-forward "[ \t]:\\([A-Za-z_@0-9:]+\\):[ \t\r\n]" nil t)
- (mapc (lambda (x) (add-to-list 'tags x))
- (org-split-string (match-string 1) ":"))))
- (mapcar 'list tags)))
- ;;; Link Stuff
- (defun org-find-file-at-mouse (ev)
- "Open file link or URL at mouse."
- (interactive "e")
- (mouse-set-point ev)
- (org-open-at-point 'in-emacs))
- (defun org-open-at-mouse (ev)
- "Open file link or URL at mouse."
- (interactive "e")
- (mouse-set-point ev)
- (org-open-at-point))
- (defun org-open-at-point (&optional in-emacs)
- "Open link at or after point.
- If there is no link at point, this function will search forward up to
- the end of the current subtree.
- Normally, files will be opened by an appropriate application. If the
- optional argument IN-EMACS is non-nil, Emacs will visit the file."
- (interactive "P")
- (org-remove-occur-highlights nil nil t)
- (if (org-at-timestamp-p)
- (org-agenda-list nil (time-to-days (org-time-string-to-time
- (substring (match-string 1) 0 10)))
- 1)
- (let (type path link line search (pos (point)))
- (catch 'match
- (save-excursion
- (skip-chars-forward "^]\n\r")
- (when (and (re-search-backward "\\[\\[" nil t)
- (looking-at org-bracket-link-regexp)
- (<= (match-beginning 0) pos)
- (>= (match-end 0) pos))
- (setq link (match-string 1))
- (while (string-match " *\n *" link)
- (setq link (replace-match " " t t link)))
- (if (string-match org-link-regexp link)
- (setq type (match-string 1 link)
- path (match-string 2 link))
- (setq type "thisfile"
- path link))
- (throw 'match t)))
- (when (get-text-property (point) 'org-linked-text)
- (setq type "thisfile"
- pos (if (get-text-property (1+ (point)) 'org-linked-text)
- (1+ (point)) (point))
- path (buffer-substring
- (previous-single-property-change pos 'org-linked-text)
- (next-single-property-change pos 'org-linked-text)))
- (throw 'match t))
- (save-excursion
- (skip-chars-backward
- (concat (if org-allow-space-in-links "^" "^ ")
- org-non-link-chars))
- (when (or (looking-at org-link-regexp)
- (and (re-search-forward org-link-regexp (point-at-eol) t)
- (<= (match-beginning 0) pos)
- (>= (match-end 0) pos)))
- (setq type (match-string 1)
- path (match-string 2))
- (throw 'match t)))
- (save-excursion
- (skip-chars-backward "^ \t\n\r")
- (when (looking-at "\\(:[A-Za-z_@0-9:]+\\):[ \t\r\n]")
- (setq type "tags"
- path (match-string 1))
- (while (string-match ":" path)
- (setq path (replace-match "+" t t path)))
- (throw 'match t)))
- (save-excursion
- (skip-chars-backward "a-zA-Z_")
- (when (and org-activate-camels
- (looking-at org-camel-regexp))
- (setq type "camel" path (match-string 0))
- (if (equal (char-before) ?*)
- (setq path (concat "*" path))))
- (throw 'match t))
- (save-excursion
- (when (re-search-forward
- org-link-regexp
- (save-excursion
- (condition-case nil
- (progn (outline-end-of-subtree) (max pos (point)))
- (error (end-of-line 1) (point))))
- t)
- (setq type (match-string 1)
- path (match-string 2)))))
- (unless path
- (error "No link found"))
- ;; Remove any trailing spaces in path
- (if (string-match " +\\'" path)
- (setq path (replace-match "" t t path)))
- (cond
- ((member type '("http" "https" "ftp" "mailto" "news"))
- (browse-url (concat type ":" path)))
- ((string= type "tags")
- (org-tags-view in-emacs path))
- ((or (string= type "camel")
- (string= type "thisfile"))
- (org-mark-ring-push)
- (org-link-search
- path
- (cond ((equal in-emacs '(4)) 'occur)
- ((equal in-emacs '(16)) 'org-occur)
- (t nil))))
- ((string= type "file")
- (if (string-match "::?\\([0-9]+\\)\\'" path) ;; second : optional
- (setq line (string-to-number (match-string 1 path))
- path (substring path 0 (match-beginning 0)))
- (if (string-match "::\\(.+\\)\\'" path)
- (setq search (match-string 1 path)
- path (substring path 0 (match-beginning 0)))))
- (org-open-file path in-emacs line search))
- ((string= type "news")
- (org-follow-gnus-link path))
- ((string= type "bbdb")
- (org-follow-bbdb-link path))
- ((string= type "gnus")
- (let (group article)
- (if (not (string-match "\\`\\([^#]+\\)\\(#\\(.*\\)\\)?" path))
- (error "Error in Gnus link"))
- (setq group (match-string 1 path)
- article (match-string 3 path))
- (org-follow-gnus-link group article)))
- ((string= type "vm")
- (let (folder article)
- (if (not (string-match "\\`\\([^#]+\\)\\(#\\(.*\\)\\)?" path))
- (error "Error in VM link"))
- (setq folder (match-string 1 path)
- article (match-string 3 path))
- ;; in-emacs is the prefix arg, will be interpreted as read-only
- (org-follow-vm-link folder article in-emacs)))
- ((string= type "wl")
- (let (folder article)
- (if (not (string-match "\\`\\([^#]+\\)\\(#\\(.*\\)\\)?" path))
- (error "Error in Wanderlust link"))
- (setq folder (match-string 1 path)
- article (match-string 3 path))
- (org-follow-wl-link folder article)))
- ((string= type "mhe")
- (let (folder article)
- (if (not (string-match "\\`\\([^#]+\\)\\(#\\(.*\\)\\)?" path))
- (error "Error in MHE link"))
- (setq folder (match-string 1 path)
- article (match-string 3 path))
- (org-follow-mhe-link folder article)))
- ((string= type "rmail")
- (let (folder article)
- (if (not (string-match "\\`\\([^#]+\\)\\(#\\(.*\\)\\)?" path))
- (error "Error in RMAIL link"))
- (setq folder (match-string 1 path)
- article (match-string 3 path))
- (org-follow-rmail-link folder article)))
- ((string= type "shell")
- (let ((cmd path))
- (while (string-match "@{" cmd)
- (setq cmd (replace-match "<" t t cmd)))
- (while (string-match "@}" cmd)
- (setq cmd (replace-match ">" t t cmd)))
- (if (or (not org-confirm-shell-links)
- (yes-or-no-p (format "Execute \"%s\" in the shell? " cmd)))
- (shell-command cmd)
- (error "Abort"))))
- (t
- (browse-url-at-point))))))
- (defun org-link-search (s &optional type)
- "Search for a link search option.
- When S is a CamelCaseWord, search for a target, or for a sentence containing
- the words. If S is surrounded by forward slashes, it is interpreted as a
- regular expression. In org-mode files, this will create an `org-occur'
- sparse tree. In ordinary files, `occur' will be used to list matches.
- If the current buffer is in `dired-mode', grep will be used to search
- in all files."
- (let ((case-fold-search t)
- (s0 (mapconcat 'identity (org-split-string s "[ \t\r\n]+") " "))
- (pos (point))
- (pre "") (post "")
- words re0 re1 re2 re3 re4 re5 re2a reall camel)
- (cond ((save-excursion
- (goto-char (point-min))
- (and
- (re-search-forward
- (concat "<<" (regexp-quote s0) ">>") nil t)
- (setq pos (match-beginning 0))))
- ;; There is an exact target for this
- (goto-char pos))
- ((string-match "^/\\(.*\\)/$" s)
- ;; A regular expression
- (cond
- ((eq major-mode 'org-mode)
- (org-occur (match-string 1 s)))
- ;;((eq major-mode 'dired-mode)
- ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
- (t (org-do-occur (match-string 1 s)))))
- ((or (setq camel (string-match (concat "^" org-camel-regexp "$") s))
- t)
- ;; A camel or a normal search string
- (when (equal (string-to-char s) ?*)
- ;; Anchor on headlines, post may include tags.
- (setq pre "^\\*+[ \t]*\\(\\sw+\\)?[ \t]*"
- post "[ \t]*\\([ \t]+:[a-zA-Z_@0-9:+]:[ \t]*\\)?$"
- s (substring s 1)))
- (remove-text-properties
- 0 (length s)
- '(face nil mouse-face nil keymap nil fontified nil) s)
- ;; Make a series of regular expressions to find a match
- (setq words
- (if camel
- (org-camel-to-words s)
- (org-split-string s "[ \n\r\t]+"))
- re0 (concat "<<" (regexp-quote s0) ">>")
- re2 (concat "\\<" (mapconcat 'downcase words "[ \t]+") "\\>")
- re2a (concat "\\<" (mapconcat 'downcase words "[ \t\r\n]+") "\\>")
- re4 (concat "\\<" (mapconcat 'downcase words "[^a-zA-Z_\r\n]+") "\\>")
- re1 (concat pre re2 post)
- re3 (concat pre re4 post)
- re5 (concat pre ".*" re4)
- re2 (concat pre re2)
- re2a (concat pre re2a)
- re4 (concat pre re4)
- reall (concat "\\(" re0 "\\)\\|\\(" re1 "\\)\\|\\(" re2
- "\\)\\|\\(" re3 "\\)\\|\\(" re4 "\\)\\|\\("
- re5 "\\)"
- ))
- (cond
- ((eq type 'org-occur) (org-occur reall))
- ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
- (t (goto-char (point-min))
- (if (or (org-search-not-link re0 nil t)
- (org-search-not-link re1 nil t)
- (org-search-not-link re2 nil t)
- (org-search-not-link re2a nil t) ;; FIXME: Right place???
- (org-search-not-link re3 nil t)
- (org-search-not-link re4 nil t)
- (org-search-not-link re5 nil t)
- )
- (goto-char (match-beginning 0))
- (goto-char pos)
- (error "No match")))))
- (t
- ;; Normal string-search
- (goto-char (point-min))
- (if (search-forward s nil t)
- (goto-char (match-beginning 0))
- (error "No match"))))
- (and (eq major-mode 'org-mode) (org-show-hierarchy-above))))
- (defun org-search-not-link (&rest args)
- "Execute `re-search-forward', but only accept matches that are not a link."
- (catch 'exit
- (let ((pos (point)) p1)
- (while (apply 're-search-forward args)
- (setq p1 (point))
- (if (not (save-match-data
- (and (re-search-backward "\\[\\[" nil t)
- (looking-at org-bracket-link-regexp)
- (<= (match-beginning 0) p1)
- (>= (match-end 0) p1))))
- (progn (goto-char (match-end 0))
- (throw 'exit (point)))
- (goto-char (match-end 0)))))))
- (defun org-do-occur (regexp &optional cleanup)
- "Call the Emacs command `occur'.
- If CLEANUP is non-nil, remove the printout of the regular expression
- in the *Occur* buffer. This is useful if the regex is long and not useful
- to read."
- (occur regexp)
- (when cleanup
- (let ((cwin (selected-window)) win beg end)
- (when (setq win (get-buffer-window "*Occur*"))
- (select-window win))
- (goto-char (point-min))
- (when (re-search-forward "match[a-z]+" nil t)
- (setq beg (match-end 0))
- (if (re-search-forward "^[ \t]*[0-9]+" nil t)
- (setq end (1- (match-beginning 0)))))
- (and beg end (let ((buffer-read-only)) (delete-region beg end)))
- (goto-char (point-min))
- (select-window cwin))))
- (defvar org-mark-ring nil
- "Mark ring for positions before jumps in Org-mode.")
- (defvar org-mark-ring-last-goto nil
- "Last position in the mark ring used to go back.")
- ;; Fill and close the ring
- (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
- (loop for i from 1 to org-mark-ring-length do
- (push (make-marker) org-mark-ring))
- (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
- org-mark-ring)
- (defun org-mark-ring-push (&optional pos buffer)
- "Put the current position or POS into the mark ring and rotate it."
- (interactive)
- (setq pos (or pos (point)))
- (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
- (move-marker (car org-mark-ring)
- (or pos (point))
- (or buffer (current-buffer)))
- (message
- (substitute-command-keys
- "Position saved to mark ring, go back with \\[org-mark-ring-goto].")))
- (defun org-mark-ring-goto (&optional n)
- "Jump to the previous position in the mark ring.
- With prefix arg N, jump back that many stored positions. When
- called several times in succession, walk through the entire ring.
- Org-mode commands jumping to a different position in the current file,
- or to another Org-mode file, automatically push the old position
- onto the ring."
- (interactive "p")
- (let (p m)
- (if (eq last-command this-command)
- (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
- (setq p org-mark-ring))
- (setq org-mark-ring-last-goto p)
- (setq m (car p))
- (switch-to-buffer (marker-buffer m))
- (goto-char m)
- (if (or (org-invisible-p) (org-invisible-p2)) (org-show-hierarchy-above))))
- (defun org-camel-to-words (s)
- "Split \"CamelCaseWords\" to (\"Camel\" \"Case\" \"Words\")."
- (let ((case-fold-search nil)
- words)
- (while (string-match "[a-z][A-Z]" s)
- (push (substring s 0 (1+ (match-beginning 0))) words)
- (setq s (substring s (1+ (match-beginning 0)))))
- (nreverse (cons s words))))
- (defun org-remove-angle-brackets (s)
- (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
- (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
- s)
- (defun org-add-angle-brackets (s)
- (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
- (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
- s)
- (defun org-follow-bbdb-link (name)
- "Follow a BBDB link to NAME."
- (require 'bbdb)
- (let ((inhibit-redisplay t)
- (bbdb-electric-p nil))
- (catch 'exit
- ;; Exact match on name
- (bbdb-name (concat "\\`" name "\\'") nil)
- (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
- ;; Exact match on name
- (bbdb-company (concat "\\`" name "\\'") nil)
- (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
- ;; Partial match on name
- (bbdb-name name nil)
- (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
- ;; Partial match on company
- (bbdb-company name nil)
- (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
- ;; General match including network address and notes
- (bbdb name nil)
- (when (= 0 (buffer-size (get-buffer "*BBDB*")))
- (delete-window (get-buffer-window "*BBDB*"))
- (error "No matching BBDB record")))))
- (defun org-follow-gnus-link (&optional group article)
- "Follow a Gnus link to GROUP and ARTICLE."
- (require 'gnus)
- (funcall (cdr (assq 'gnus org-link-frame-setup)))
- (if group (gnus-fetch-group group))
- (if article
- (or (gnus-summary-goto-article article nil 'force)
- (if (fboundp 'gnus-summary-insert-cached-articles)
- (progn
- (gnus-summary-insert-cached-articles)
- (gnus-summary-goto-article article nil 'force))
- (message "Message could not be found.")))))
- (defun org-follow-vm-link (&optional folder article readonly)
- "Follow a VM link to FOLDER and ARTICLE."
- (require 'vm)
- (setq article (org-add-angle-brackets article))
- (if (string-match "^//\\([a-zA-Z]+@\\)?\\([^:]+\\):\\(.*\\)" folder)
- ;; ange-ftp or efs or tramp access
- (let ((user (or (match-string 1 folder) (user-login-name)))
- (host (match-string 2 folder))
- (file (match-string 3 folder)))
- (cond
- ((featurep 'tramp)
- ;; use tramp to access the file
- (if (featurep 'xemacs)
- (setq folder (format "[%s@%s]%s" user host file))
- (setq folder (format "/%s@%s:%s" user host file))))
- (t
- ;; use ange-ftp or efs
- (require (if (featurep 'xemacs) 'efs 'ange-ftp))
- (setq folder (format "/%s@%s:%s" user host file))))))
- (when folder
- (funcall (cdr (assq 'vm org-link-frame-setup)) folder readonly)
- (sit-for 0.1)
- (when article
- (vm-select-folder-buffer)
- (widen)
- (let ((case-fold-search t))
- (goto-char (point-min))
- (if (not (re-search-forward
- (concat "^" "message-id: *" (regexp-quote article))))
- (error "Could not find the specified message in this folder"))
- (vm-isearch-update)
- (vm-isearch-narrow)
- (vm-beginning-of-message)
- (vm-summarize)))))
- (defun org-follow-wl-link (folder article)
- "Follow a Wanderlust link to FOLDER and ARTICLE."
- (setq article (org-add-angle-brackets article))
- (wl-summary-goto-folder-subr folder 'no-sync t nil t)
- (if article (wl-summary-jump-to-msg-by-message-id article ">"))
- (wl-summary-redisplay))
- (defun org-follow-rmail-link (folder article)
- "Follow an RMAIL link to FOLDER and ARTICLE."
- (setq article (org-add-angle-brackets article))
- (let (message-number)
- (save-excursion
- (save-window-excursion
- (rmail (if (string= folder "RMAIL") rmail-file-name folder))
- (setq message-number
- (save-restriction
- (widen)
- (goto-char (point-max))
- (if (re-search-backward
- (concat "^Message-ID:\\s-+" (regexp-quote
- (or article "")))
- nil t)
- (rmail-what-message))))))
- (if message-number
- (progn
- (rmail (if (string= folder "RMAIL") rmail-file-name folder))
- (rmail-show-message message-number)
- message-number)
- (error "Message not found"))))
- ;; mh-e integration based on planner-mode
- (defun org-mhe-get-message-real-folder ()
- "Return the name of the current message real folder, so if you use
- sequences, it will now work."
- (save-excursion
- (let* ((folder
- (if (equal major-mode 'mh-folder-mode)
- mh-current-folder
- ;; Refer to the show buffer
- mh-show-folder-buffer))
- (end-index
- (if (boundp 'mh-index-folder)
- (min (length mh-index-folder) (length folder))))
- )
- ;; a simple test on mh-index-data does not work, because
- ;; mh-index-data is always nil in a show buffer.
- (if (and (boundp 'mh-index-folder)
- (string= mh-index-folder (substring folder 0 end-index)))
- (if (equal major-mode 'mh-show-mode)
- (save-window-excursion
- (when (buffer-live-p (get-buffer folder))
- (progn
- (pop-to-buffer folder)
- (org-mhe-get-message-folder-from-index)
- )
- ))
- (org-mhe-get-message-folder-from-index)
- )
- folder
- )
- )))
- (defun org-mhe-get-message-folder-from-index ()
- "Returns the name of the message folder in a index folder buffer."
- (save-excursion
- (mh-index-previous-folder)
- (re-search-forward "^\\(+.*\\)$" nil t)
- (message (match-string 1))))
- (defun org-mhe-get-message-folder ()
- "Return the name of the current message folder. Be careful if you
- use sequences."
- (save-excursion
- (if (equal major-mode 'mh-folder-mode)
- mh-current-folder
- ;; Refer to the show buffer
- mh-show-folder-buffer)))
- (defun org-mhe-get-message-num ()
- "Return the number of the current message. Be careful if you
- use sequences."
- (save-excursion
- (if (equal major-mode 'mh-folder-mode)
- (mh-get-msg-num nil)
- ;; Refer to the show buffer
- (mh-show-buffer-message-number))))
- (defun org-mhe-get-header (header)
- "Return a header of the message in folder mode. This will create a
- show buffer for the corresponding message. If you have a more clever
- idea..."
- (let* ((folder (org-mhe-get-message-folder))
- (num (org-mhe-get-message-num))
- (buffer (get-buffer-create (concat "show-" folder)))
- (header-field))
- (with-current-buffer buffer
- (mh-display-msg num folder)
- (if (equal major-mode 'mh-folder-mode)
- (mh-header-display)
- (mh-show-header-display))
- (set-buffer buffer)
- (setq header-field (mh-get-header-field header))
- (if (equal major-mode 'mh-folder-mode)
- (mh-show)
- (mh-show-show))
- header-field)))
- (defun org-follow-mhe-link (folder article)
- "Follow an MHE link to FOLDER and ARTICLE.
- If ARTICLE is nil FOLDER is shown. If the configuration variable
- `org-mhe-search-all-folders' is t and `mh-searcher' is pick,
- ARTICLE is searched in all folders. Indexed searches (swish++,
- namazu, and others supported by MH-E) will always search in all
- folders."
- (require 'mh-e)
- (require 'mh-search)
- (require 'mh-utils)
- (mh-find-path)
- (if (not article)
- (mh-visit-folder (mh-normalize-folder-name folder))
- (setq article (org-add-angle-brackets article))
- (mh-search-choose)
- (if (equal mh-searcher 'pick)
- (progn
- (mh-search folder (list "--message-id" article))
- (when (and org-mhe-search-all-folders
- (not (org-mhe-get-message-real-folder)))
- (kill-this-buffer)
- (mh-search "+" (list "--message-id" article))))
- (mh-search "+" article))
- (if (org-mhe-get-message-real-folder)
- (mh-show-msg 1)
- (kill-this-buffer)
- (error "Message not found"))))
- (defun org-open-file (path &optional in-emacs line search)
- "Open the file at PATH.
- First, this expands any special file name abbreviations. Then the
- configuration variable `org-file-apps' is checked if it contains an
- entry for this file type, and if yes, the corresponding command is launched.
- If no application is found, Emacs simply visits the file.
- With optional argument IN-EMACS, Emacs will visit the file.
- Optional LINE specifies a line to go to, optional SEARCH a string to
- search for. If LINE or SEARCH is given, the file will always be
- opened in Emacs.
- If the file does not exist, an error is thrown."
- (setq in-emacs (or in-emacs line search))
- (let* ((file (if (equal path "")
- buffer-file-name
- (convert-standard-filename (org-expand-file-name path))))
- (dirp (file-directory-p file))
- (dfile (downcase file))
- (old-buffer (current-buffer))
- (old-pos (point))
- (old-mode major-mode)
- ext cmd apps)
- (if (and (not (file-exists-p file))
- (not org-open-non-existing-files))
- (error "No such file: %s" file))
- (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\.gz\\)$" dfile)
- (setq ext (match-string 1 dfile))
- (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\)$" dfile)
- (setq ext (match-string 1 dfile))))
- (setq apps (append org-file-apps (org-default-apps)))
- (if in-emacs
- (setq cmd 'emacs)
- (setq cmd (or (and dirp (cdr (assoc 'directory apps)))
- (cdr (assoc ext apps))
- (cdr (assoc t apps)))))
- (when (eq cmd 'mailcap)
- (require 'mailcap)
- (mailcap-parse-mailcaps)
- (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
- (command (mailcap-mime-info mime-type)))
- (if (stringp command)
- (setq cmd command)
- (setq cmd 'emacs))))
- (cond
- ((and (stringp cmd) (not (string-match "^\\s-*$" cmd)))
- (setq cmd (format cmd (concat "\"" file "\"")))
- (save-window-excursion
- (shell-command (concat cmd " &"))))
- ((or (stringp cmd)
- (eq cmd 'emacs))
- (unless (equal (file-truename file) (file-truename (or buffer-file-name "")))
- (funcall (cdr (assq 'file org-link-frame-setup)) file))
- (if line (goto-line line)
- (if search (org-link-search search))))
- ((consp cmd)
- (eval cmd))
- (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
- (and (eq major-mode 'org-mode) (eq old-mode 'org-mode)
- (or (not (equal old-buffer (current-buffer)))
- (not (equal old-pos (point))))
- (org-mark-ring-push old-pos old-buffer))))
- (defun org-default-apps ()
- "Return the default applications for this operating system."
- (cond
- ((eq system-type 'darwin)
- org-file-apps-defaults-macosx)
- ((eq system-type 'windows-nt)
- org-file-apps-defaults-windowsnt)
- (t org-file-apps-defaults-gnu)))
- (defun org-expand-file-name (path)
- "Replace special path abbreviations and expand the file name."
- (expand-file-name path))
- (defvar org-insert-link-history nil
- "Minibuffer history for links inserted with `org-insert-link'.")
- (defvar org-stored-links nil
- "Contains the links stored with `org-store-link'.")
- ;;;###autoload
- (defun org-store-link (arg)
- "\\<org-mode-map>Store an org-link to the current location.
- This link can later be inserted into an org-buffer with
- \\[org-insert-link].
- For some link types, a prefix arg is interpreted:
- For links to usenet articles, arg negates `org-usenet-links-prefer-google'.
- For file links, arg negates `org-context-in-file-links'."
- (interactive "P")
- (let (link cpltxt txt (pos (point)))
- (cond
- ((eq major-mode 'bbdb-mode)
- (setq cpltxt (concat
- "bbdb:"
- (or (bbdb-record-name (bbdb-current-record))
- (bbdb-record-company (bbdb-current-record))))
- link (org-make-link cpltxt)))
- ((eq major-mode 'calendar-mode)
- (let ((cd (calendar-cursor-to-date)))
- (setq link
- (format-time-string
- (car org-time-stamp-formats)
- (apply 'encode-time
- (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
- nil nil nil))))))
- ((or (eq major-mode 'vm-summary-mode)
- (eq major-mode 'vm-presentation-mode))
- (and (eq major-mode 'vm-presentation-mode) (vm-summarize))
- (vm-follow-summary-cursor)
- (save-excursion
- (vm-select-folder-buffer)
- (let* ((message (car vm-message-pointer))
- (folder buffer-file-name)
- (subject (vm-su-subject message))
- (author (vm-su-full-name message))
- (message-id (vm-su-message-id message)))
- (setq message-id (org-remove-angle-brackets message-id))
- (setq folder (abbreviate-file-name folder))
- (if (string-match (concat "^" (regexp-quote vm-folder-directory))
- folder)
- (setq folder (replace-match "" t t folder)))
- (setq cpltxt (concat author " on: " subject))
- (setq link (concat cpltxt "\n "
- (org-make-link
- "vm:" folder "#" message-id))))))
- ((eq major-mode 'wl-summary-mode)
- (let* ((msgnum (wl-summary-message-number))
- (message-id (elmo-message-field wl-summary-buffer-elmo-folder
- msgnum 'message-id))
- (wl-message-entity (elmo-msgdb-overview-get-entity
- msgnum (wl-summary-buffer-msgdb)))
- (author (wl-summary-line-from)) ; FIXME: how to get author name?
- (subject "???")) ; FIXME: How to get subject of email?
- (setq message-id (org-remove-angle-brackets message-id))
- (setq cpltxt (concat author " on: " subject))
- (setq link (concat cpltxt "\n "
- (org-make-link
- "wl:" wl-summary-buffer-folder-name
- "#" message-id)))))
- ((or (equal major-mode 'mh-folder-mode)
- (equal major-mode 'mh-show-mode))
- (let ((from-header (org-mhe-get-header "From:"))
- (to-header (org-mhe-get-header "To:"))
- (subject (org-mhe-get-header "Subject:")))
- (setq cpltxt (concat from-header " on: " subject))
- (setq link (concat cpltxt "\n "
- (org-make-link
- "mhe:" (org-mhe-get-message-real-folder) "#"
- (org-remove-angle-brackets
- (org-mhe-get-header "Message-Id:")))))))
- ((eq major-mode 'rmail-mode)
- (save-excursion
- (save-restriction
- (rmail-narrow-to-non-pruned-header)
- (let ((folder buffer-file-name)
- (message-id (mail-fetch-field "message-id"))
- (author (mail-fetch-field "from"))
- (subject (mail-fetch-field "subject")))
- (setq message-id (org-remove-angle-brackets message-id))
- (setq cpltxt (concat author " on: " subject))
- (setq link (concat cpltxt "\n "
- (org-make-link
- "rmail:" folder "#" message-id)))))))
- ((eq major-mode 'gnus-group-mode)
- (let ((group (cond ((fboundp 'gnus-group-group-name) ; depending on Gnus
- (gnus-group-group-name)) ; version
- ((fboundp 'gnus-group-name)
- (gnus-group-name))
- (t "???"))))
- (setq cpltxt (concat
- (if (org-xor arg org-usenet-links-prefer-google)
- "http://groups.google.com/groups?group="
- "gnus:")
- group)
- link (org-make-link cpltxt))))
- ((memq major-mode '(gnus-summary-mode gnus-article-mode))
- (and (eq major-mode 'gnus-article-mode) (gnus-article-show-summary))
- (gnus-summary-beginning-of-article)
- (let* ((group (car gnus-article-current))
- (article (cdr gnus-article-current))
- (header (gnus-summary-article-header article))
- (author (mail-header-from header))
- (message-id (mail-header-id header))
- (date (mail-header-date header))
- (subject (gnus-summary-subject-string)))
- (setq cpltxt (concat author " on: " subject))
- (if (org-xor arg org-usenet-links-prefer-google)
- (setq link
- (concat
- cpltxt "\n "
- (format "http://groups.google.com/groups?as_umsgid=%s"
- (org-fixup-message-id-for-http message-id))))
- (setq link (concat cpltxt "\n"
- (org-make-link
- "gnus:" group
- "#" (number-to-string article)))))))
- ((eq major-mode 'w3-mode)
- (setq cpltxt (url-view-url t)
- link (org-make-link cpltxt)))
- ((eq major-mode 'w3m-mode)
- (setq cpltxt w3m-current-url
- link (org-make-link cpltxt)))
- ((eq major-mode 'org-mode)
- ;; Just link to current headline
- (setq cpltxt (concat "file:"
- (abbreviate-file-name buffer-file-name)))
- ;; Add a context search string
- (when (org-xor org-context-in-file-links arg)
- ;; Check if we are on a target
- (if (save-excursion
- (skip-chars-forward "^>\n\r")
- (and (re-search-backward "<<" nil t)
- (looking-at "<<\\(.*?\\)>>")
- (<= (match-beginning 0) pos)
- (>= (match-end 0) pos)))
- (setq cpltxt (concat cpltxt "::" (match-string 1)))
- (setq txt (cond
- ((org-on-heading-p) nil)
- ((org-region-active-p)
- (buffer-substring (region-beginning) (region-end)))
- (t (buffer-substring (point-at-bol) (point-at-eol)))))
- (setq cpltxt
- (concat cpltxt "::"
- (if org-file-link-context-use-camel-case
- (org-make-org-heading-camel txt)
- (org-make-org-heading-search-string txt))))))
- (if (string-match "::\\'" cpltxt)
- (setq cpltxt (substring cpltxt 0 -2)))
- (setq link (org-make-link cpltxt)))
- (buffer-file-name
- ;; Just link to this file here.
- (setq cpltxt (concat "file:"
- (abbreviate-file-name buffer-file-name)))
- ;; Add a context string
- (when (org-xor org-context-in-file-links arg)
- (setq txt (if (org-region-active-p)
- (buffer-substring (region-beginning) (region-end))
- (buffer-substring (point-at-bol) (point-at-eol))))
- (setq cpltxt
- (concat cpltxt "::"
- (if org-file-link-context-use-camel-case
- (org-make-org-heading-camel txt)
- (org-make-org-heading-search-string txt)))))
- (setq link (org-make-link cpltxt)))
- ((interactive-p)
- (error "Cannot link to a buffer which is not visiting a file"))
- (t (setq link nil)))
- (if (consp link) (setq cpltxt (car link) link (cdr link)))
- (if (and (interactive-p) link)
- (progn
- (setq org-stored-links
- (cons (cons (or cpltxt link) link) org-stored-links))
- (message "Stored: %s" (or cpltxt link)))
- link)))
- (defun org-make-org-heading-search-string (&optional string heading)
- "Make search string for STRING or current headline."
- (interactive)
- (let ((s (or string (org-get-heading))))
- (unless (and string (not heading))
- ;; We are using a headline, clean up garbage in there.
- (if (string-match org-todo-regexp s)
- (setq s (replace-match "" t t s)))
- (if (string-match ":[a-zA-Z_@0-9:]+:[ \t]*$" s)
- (setq s (replace-match "" t t s)))
- (setq s (org-trim s))
- (if (string-match (concat "^\\(" org-quote-string "\\|"
- org-comment-string "\\)") s)
- (setq s (replace-match "" t t s)))
- (while (string-match org-ts-regexp s)
- (setq s (replace-match "" t t s))))
- (while (string-match "[^a-zA-Z_0-9 \t]+" s)
- (setq s (replace-match " " t t s)))
- (or string (setq s (concat "*" s))) ; Add * for headlines
- (mapconcat 'identity (org-split-string s "[ \t]+") " ")))
- (defun org-make-org-heading-camel (&optional string heading)
- "Make a CamelCase string for STRING or the current headline."
- (interactive)
- (let ((s (or string (org-get-heading))))
- (unless (and string (not heading))
- ;; We are using a headline, clean up garbage in there.
- (if (string-match org-todo-regexp s)
- (setq s (replace-match "" t t s)))
- (if (string-match ":[a-zA-Z_@0-9:]+:[ \t]*$" s)
- (setq s (replace-match "" t t s)))
- (setq s (org-trim s))
- (if (string-match (concat "^\\(" org-quote-string "\\|"
- org-comment-string "\\)") s)
- (setq s (replace-match "" t t s)))
- (while (string-match org-ts-regexp s)
- (setq s (replace-match "" t t s))))
- (while (string-match "[^a-zA-Z_ \t]+" s)
- (setq s (replace-match " " t t s)))
- (or string (setq s (concat "*" s))) ; Add * for headlines
- (mapconcat 'capitalize (org-split-string s "[ \t]+") "")))
- (defun org-make-link (&rest strings)
- "Concatenate STRINGS, format resulting string with `org-link-format'."
- (format org-link-format (apply 'concat strings)))
- (defun org-make-link2 (link &optional description)
- "Make a link with brackets."
- (concat "[[" link "]"
- (if description (concat "[" description "]") "")
- "]"))
- (defun org-xor (a b)
- "Exclusive or."
- (if a (not b) b))
- (defun org-get-header (header)
- "Find a header field in the current buffer."
- (save-excursion
- (goto-char (point-min))
- (let ((case-fold-search t) s)
- (cond
- ((eq header 'from)
- (if (re-search-forward "^From:\\s-+\\(.*\\)" nil t)
- (setq s (match-string 1)))
- (while (string-match "\"" s)
- (setq s (replace-match "" t t s)))
- (if (string-match "[<(].*" s)
- (setq s (replace-match "" t t s))))
- ((eq header 'message-id)
- (if (re-search-forward "^message-id:\\s-+\\(.*\\)" nil t)
- (setq s (match-string 1))))
- ((eq header 'subject)
- (if (re-search-forward "^subject:\\s-+\\(.*\\)" nil t)
- (setq s (match-string 1)))))
- (if (string-match "\\`[ \t\]+" s) (setq s (replace-match "" t t s)))
- (if (string-match "[ \t\]+\\'" s) (setq s (replace-match "" t t s)))
- s)))
- (defun org-fixup-message-id-for-http (s)
- "Replace special characters in a message id, so it can be used in an http query."
- (while (string-match "<" s)
- (setq s (replace-match "%3C" t t s)))
- (while (string-match ">" s)
- (setq s (replace-match "%3E" t t s)))
- (while (string-match "@" s)
- (setq s (replace-match "%40" t t s)))
- s)
- (defun org-insert-link (&optional complete-file)
- "Insert a link. At the prompt, enter the link.
- Completion can be used to select a link previously stored with
- `org-store-link'. When the empty string is entered (i.e. if you just
- press RET at the prompt), the link defaults to the most recently
- stored link. As SPC triggers completion in the minibuffer, you need to
- use M-SPC or C-q SPC to force the insertion of a space character.
- With a \\[universal-argument] prefix, prompts for a file to link to. The file name can be
- selected using completion. The path to the file will be relative to
- the current directory if the file is in the current directory or a
- subdirectory. Otherwise, the link will be the absolute path as
- completed in the minibuffer (i.e. normally ~/path/to/file).
- With two \\[universal-argument] prefixes, enforce an absolute path even if the file
- is in the current directory or below."
- (interactive "P")
- (let ((link (if complete-file
- (read-file-name "File: ")
- (completing-read
- "Link: " org-stored-links nil nil nil
- org-insert-link-history
- (or (car (car org-stored-links))))))
- linktxt matched)
- (if (or (not link) (equal link ""))
- (error "No links available"))
- (if complete-file
- (let ((pwd (file-name-as-directory (expand-file-name "."))))
- (cond
- ((equal complete-file '(16))
- (insert
- (org-make-link
- "file:" (abbreviate-file-name (expand-file-name link)))))
- ((string-match (concat "^" (regexp-quote pwd) "\\(.+\\)")
- (expand-file-name link))
- (insert
- (org-make-link
- "file:" (match-string 1 (expand-file-name link)))))
- (t (insert (org-make-link "file:" link)))))
- (setq linktxt (cdr (assoc link org-stored-links)))
- (if (not org-keep-stored-link-after-insertion)
- (setq org-stored-links (delq (assoc link org-stored-links)
- org-stored-links)))
- (if (not linktxt) (setq link (org-make-link link)))
- (setq link (or linktxt link))
- (when (string-match "<\\<file:\\(.+?\\)::\\([^>]+\\)>" link)
- (let* ((path (match-string 1 link))
- (case-fold-search nil)
- (search (match-string 2 link)))
- (when (save-match-data
- (equal (file-truename buffer-file-name)
- (file-truename path)))
- ;; We are linking to this same file
- (if (and org-file-link-context-use-camel-case
- (save-match-data
- (string-match (concat "^" org-camel-regexp "$") search)))
- (setq link (replace-match search t t link)
- matched t)
- (setq link (replace-match (concat "[[" search "]]")
- t t link)
- matched t)))))
- (let ((lines (org-split-string link "\n")))
- (insert (car lines))
- (setq matched (or matched (string-match org-link-regexp (car lines))))
- (setq lines (cdr lines))
- (while lines
- (insert "\n")
- (if (save-excursion
- (beginning-of-line 0)
- (looking-at "[ \t]+\\S-"))
- (indent-relative))
- (setq matched (or matched
- (string-match org-link-regexp (car lines))))
- (insert (car lines))
- (setq lines (cdr lines))))
- (unless matched
- (error "Add link type: http(s),ftp,mailto,file,news,bbdb,vm,wl,rmail,gnus, or shell")))))
- ;;; Hooks for remember.el
- ;;;###autoload
- (defun org-remember-annotation ()
- "Return a link to the current location as an annotation for remember.el.
- If you are using Org-mode files as target for data storage with
- remember.el, then the annotations should include a link compatible with the
- conventions in Org-mode. This function returns such a link."
- (org-store-link nil))
- (defconst org-remember-help
- "Select a destination location for the note.
- UP/DOWN=headline TAB=cycle visibility [Q]uit RET/<left>/<right>=Store
- RET at beg-of-buf -> Append to file as level 2 headline
- RET on headline -> Store as sublevel entry to current headline
- <left>/<right> -> before/after current headline, same headings level")
- ;;;###autoload
- (defun org-remember-apply-template ()
- "Initialize *remember* buffer with template, invode `org-mode'.
- This function should be placed into `remember-mode-hook' and in fact requires
- to be run from that hook to fucntion properly."
- (when org-remember-templates
- (let* ((entry (if (= (length org-remember-templates) 1)
- (cdar org-remember-templates)
- (message "Select template: %s"
- (mapconcat
- (lambda (x) (char-to-string (car x)))
- org-remember-templates " "))
- (cdr (assoc (read-char-exclusive) org-remember-templates))))
- (tpl (if (consp (cdr entry)) (cadr entry) (cdr entry)))
- (file (if (consp (cdr entry)) (nth 2 entry)))
- (v-t (format-time-string (car org-time-stamp-formats) (org-current-time)))
- (v-T (format-time-string (cdr org-time-stamp-formats) (org-current-time)))
- (v-u (concat "[" (substring v-t 1 -1) "]"))
- (v-U (concat "[" (substring v-T 1 -1) "]"))
- (v-a annotation) ; defined in `remember-mode'
- (v-i initial) ; defined in `remember-mode'
- (v-n user-full-name)
- )
- (unless tpl (setq tpl "") (message "No template") (ding))
- (insert tpl) (goto-char (point-min))
- (while (re-search-forward "%\\([tTuTai]\\)" nil t)
- (when (and initial (equal (match-string 0) "%i"))
- (save-match-data
- (let* ((lead (buffer-substring
- (point-at-bol) (match-beginning 0))))
- (setq v-i (mapconcat 'identity
- (org-split-string initial "\n")
- (concat "\n" lead))))))
- (replace-match
- (or (eval (intern (concat "v-" (match-string 1)))) "")
- t t))
- (let ((org-startup-folded nil)
- (org-startup-with-deadline-check nil))
- (org-mode))
- ; (use-local-map org-mode-map)
- ; (org-set-font-lock-defaults)
- (if (and file (string-match "\\S-" file) (not (file-directory-p file)))
- (set (make-local-variable 'org-default-notes-file) file))
- (goto-char (point-min))
- (if (re-search-forward "%\\?" nil t) (replace-match "")))))
- ;;;###autoload
- (defun org-remember-handler ()
- "Store stuff from remember.el into an org file.
- First prompts for an org file. If the user just presses return, the value
- of `org-default-notes-file' is used.
- Then the command offers the headings tree of the selected file in order to
- file the text at a specific location.
- You can either immediately press RET to get the note appended to the
- file, or you can use vertical cursor motion and visibility cycling (TAB) to
- find a better place. Then press RET or <left> or <right> in insert the note.
- Key Cursor position Note gets inserted
- -----------------------------------------------------------------------------
- RET buffer-start as level 2 heading at end of file
- RET on headline as sublevel of the heading at cursor
- RET no heading at cursor position, level taken from context.
- Or use prefix arg to specify level manually.
- <left> on headline as same level, before current heading
- <right> on headline as same level, after current heading
- So the fastest way to store the note is to press RET RET to append it to
- the default file. This way your current train of thought is not
- interrupted, in accordance with the principles of remember.el. But with
- little extra effort, you can push it directly to the correct location.
- Before being stored away, the function ensures that the text has a
- headline, i.e. a first line that starts with a \"*\". If not, a headline
- is constructed from the current date and some additional data.
- If the variable `org-adapt-indentation' is non-nil, the entire text is
- also indented so that it starts in the same column as the headline
- \(i.e. after the stars).
- See also the variable `org-reverse-note-order'."
- (catch 'quit
- (let* ((txt (buffer-substring (point-min) (point-max)))
- (fastp current-prefix-arg)
- (file (if fastp org-default-notes-file (org-get-org-file)))
- (visiting (find-buffer-visiting file))
- (org-startup-with-deadline-check nil)
- (org-startup-folded nil)
- spos level indent reversed)
- ;; Modify text so that it becomes a nice subtree which can be inserted
- ;; into an org tree.
- (let* ((lines (split-string txt "\n"))
- first)
- ;; remove empty lines at the beginning
- (while (and lines (string-match "^[ \t]*\n" (car lines)))
- (setq lines (cdr lines)))
- (setq first (car lines) lines (cdr lines))
- (if (string-match "^\\*+" first)
- ;; Is already a headline
- (setq indent nil)
- ;; We need to add a headline: Use time and first buffer line
- (setq lines (cons first lines)
- first (concat "* " (current-time-string)
- " (" (remember-buffer-desc) ")")
- indent " "))
- (if (and org-adapt-indentation indent)
- (setq lines (mapcar (lambda (x) (concat indent x)) lines)))
- (setq txt (concat first "\n"
- (mapconcat 'identity lines "\n"))))
- ;; Find the file
- (if (not visiting)
- (find-file-noselect file))
- (with-current-buffer (get-file-buffer file)
- (setq reversed (org-notes-order-reversed-p))
- (save-excursion
- (save-restriction
- (widen)
- ;; Ask the User for a location
- (setq spos (if fastp 1 (org-get-location
- (current-buffer)
- org-remember-help)))
- (if (not spos) (throw 'quit nil)) ; return nil to show we did
- ; not handle this note
- (goto-char spos)
- (cond ((bobp)
- ;; Put it at the start or end, as level 2
- (save-restriction
- (widen)
- (goto-char (if reversed (point-min) (point-max)))
- (if (not (bolp)) (newline))
- (org-paste-subtree 2 txt)))
- ((and (org-on-heading-p nil) (not current-prefix-arg))
- ;; Put it below this entry, at the beg/end of the subtree
- (org-back-to-heading)
- (setq level (funcall outline-level))
- (if reversed
- (outline-end-of-heading)
- (outline-end-of-subtree))
- (if (not (bolp)) (newline))
- (beginning-of-line 1)
- (org-paste-subtree (1+ level) txt))
- (t
- ;; Put it right there, with automatic level determined by
- ;; org-paste-subtree or from prefix arg
- (org-paste-subtree current-prefix-arg txt)))
- (when remember-save-after-remembering
- (save-buffer)
- (if (not visiting) (kill-buffer (current-buffer)))))))))
- t) ;; return t to indicate that we took care of this note.
- (defun org-get-org-file ()
- "Read a filename, with default directory `org-directory'."
- (let ((default (or org-default-notes-file remember-data-file)))
- (read-file-name (format "File name [%s]: " default)
- (file-name-as-directory org-directory)
- default)))
- (defun org-notes-order-reversed-p ()
- "Check if the current file should receive notes in reversed order."
- (cond
- ((not org-reverse-note-order) nil)
- ((eq t org-reverse-note-order) t)
- ((not (listp org-reverse-note-order)) nil)
- (t (catch 'exit
- (let ((all org-reverse-note-order)
- entry)
- (while (setq entry (pop all))
- (if (string-match (car entry) buffer-file-name)
- (throw 'exit (cdr entry))))
- nil)))))
- ;;; Tables
- ;; Watch out: Here we are talking about two different kind of tables.
- ;; Most of the code is for the tables created with the Org-mode table editor.
- ;; Sometimes, we talk about tables created and edited with the table.el
- ;; Emacs package. We call the former org-type tables, and the latter
- ;; table.el-type tables.
- (defun org-before-change-function (beg end)
- "Every change indicates that a table might need an update."
- (setq org-table-may-need-update t))
- (defconst org-table-line-regexp "^[ \t]*|"
- "Detects an org-type table line.")
- (defconst org-table-dataline-regexp "^[ \t]*|[^-]"
- "Detects an org-type table line.")
- (defconst org-table-auto-recalculate-regexp "^[ \t]*| *# *\\(|\\|$\\)"
- "Detects a table line marked for automatic recalculation.")
- (defconst org-table-recalculate-regexp "^[ \t]*| *[#*] *\\(|\\|$\\)"
- "Detects a table line marked for automatic recalculation.")
- (defconst org-table-calculate-mark-regexp "^[ \t]*| *[!$^_#*] *\\(|\\|$\\)"
- "Detects a table line marked for automatic recalculation.")
- (defconst org-table-hline-regexp "^[ \t]*|-"
- "Detects an org-type table hline.")
- (defconst org-table1-hline-regexp "^[ \t]*\\+-[-+]"
- "Detects a table-type table hline.")
- (defconst org-table-any-line-regexp "^[ \t]*\\(|\\|\\+-[-+]\\)"
- "Detects an org-type or table-type table.")
- (defconst org-table-border-regexp "^[ \t]*[^| \t]"
- "Searching from within a table (any type) this finds the first line
- outside the table.")
- (defconst org-table-any-border-regexp "^[ \t]*[^|+ \t]"
- "Searching from within a table (any type) this finds the first line
- outside the table.")
- (defun org-table-create-with-table.el ()
- "Use the table.el package to insert a new table.
- If there is already a table at point, convert between Org-mode tables
- and table.el tables."
- (interactive)
- (require 'table)
- (cond
- ((org-at-table.el-p)
- (if (y-or-n-p "Convert table to Org-mode table? ")
- (org-table-convert)))
- ((org-at-table-p)
- (if (y-or-n-p "Convert table to table.el table? ")
- (org-table-convert)))
- (t (call-interactively 'table-insert))))
- (defun org-table-create (&optional size)
- "Query for a size and insert a table skeleton.
- SIZE is a string Columns x Rows like for example \"3x2\"."
- (interactive "P")
- (unless size
- (setq size (read-string
- (concat "Table size Columns x Rows [e.g. "
- org-table-default-size "]: ")
- "" nil org-table-default-size)))
- (let* ((pos (point))
- (indent (make-string (current-column) ?\ ))
- (split (org-split-string size " *x *"))
- (rows (string-to-number (nth 1 split)))
- (columns (string-to-number (car split)))
- (line (concat (apply 'concat indent "|" (make-list columns " |"))
- "\n")))
- (if (string-match "^[ \t]*$" (buffer-substring-no-properties
- (point-at-bol) (point)))
- (beginning-of-line 1)
- (newline))
- ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
- (dotimes (i rows) (insert line))
- (goto-char pos)
- (if (> rows 1)
- ;; Insert a hline after the first row.
- (progn
- (end-of-line 1)
- (insert "\n|-")
- (goto-char pos)))
- (org-table-align)))
- (defun org-table-convert-region (beg0 end0 nspace)
- "Convert region to a table.
- The region goes from BEG0 to END0, but these borders will be moved
- slightly, to make sure a beginning of line in the first line is included.
- When NSPACE is non-nil, it indicates the minimum number of spaces that
- separate columns (default: just one space)."
- (let* ((beg (min beg0 end0))
- (end (max beg0 end0))
- (tabsep t)
- re)
- (goto-char beg)
- (beginning-of-line 1)
- (setq beg (move-marker (make-marker) (point)))
- (goto-char end)
- (if (bolp) (backward-char 1) (end-of-line 1))
- (setq end (move-marker (make-marker) (point)))
- ;; Lets see if this is tab-separated material. If every nonempty line
- ;; contains a tab, we will assume that it is tab-separated material
- (if nspace
- (setq tabsep nil)
- (goto-char beg)
- (and (re-search-forward "^[^\n\t]+$" end t) (setq tabsep nil)))
- (if nspace (setq tabsep nil))
- (if tabsep
- (setq re "^\\|\t")
- (setq re (format "^ *\\| *\t *\\| \\{%d,\\}"
- (max 1 (prefix-numeric-value nspace)))))
- (goto-char beg)
- (while (re-search-forward re end t)
- (replace-match "|" t t))
- (goto-char beg)
- (insert " ")
- (org-table-align)))
- (defun org-table-import (file arg)
- "Import FILE as a table.
- The file is assumed to be tab-separated. Such files can be produced by most
- spreadsheet and database applications. If no tabs (at least one per line)
- are found, lines will be split on whitespace into fields."
- (interactive "f\nP")
- (or (bolp) (newline))
- (let ((beg (point))
- (pm (point-max)))
- (insert-file-contents file)
- (org-table-convert-region beg (+ (point) (- (point-max) pm)) arg)))
- (defun org-table-export ()
- "Export table as a tab-separated file.
- Such a file can be imported into a spreadsheet program like Excel."
- (interactive)
- (let* ((beg (org-table-begin))
- (end (org-table-end))
- (table (buffer-substring beg end))
- (file (read-file-name "Export table to: "))
- buf)
- (unless (or (not (file-exists-p file))
- (y-or-n-p (format "Overwrite file %s? " file)))
- (error "Abort"))
- (with-current-buffer (find-file-noselect file)
- (setq buf (current-buffer))
- (erase-buffer)
- (fundamental-mode)
- (insert table)
- (goto-char (point-min))
- (while (re-search-forward "^[ \t]*|[ \t]*" nil t)
- (replace-match "" t t)
- (end-of-line 1))
- (goto-char (point-min))
- (while (re-search-forward "[ \t]*|[ \t]*$" nil t)
- (replace-match "" t t)
- (goto-char (min (1+ (point)) (point-max))))
- (goto-char (point-min))
- (while (re-search-forward "^-[-+]*$" nil t)
- (replace-match "")
- (if (looking-at "\n")
- (delete-char 1)))
- (goto-char (point-min))
- (while (re-search-forward "[ \t]*|[ \t]*" nil t)
- (replace-match "\t" t t))
- (save-buffer))
- (kill-buffer buf)))
- (defvar org-table-aligned-begin-marker (make-marker)
- "Marker at the beginning of the table last aligned.
- Used to check if cursor still is in that table, to minimize realignment.")
- (defvar org-table-aligned-end-marker (make-marker)
- "Marker at the end of the table last aligned.
- Used to check if cursor still is in that table, to minimize realignment.")
- (defvar org-table-last-alignment nil
- "List of flags for flushright alignment, from the last re-alignment.
- This is being used to correctly align a single field after TAB or RET.")
- (defvar org-table-last-column-widths nil
- "List of max width of fields in each column.
- This is being used to correctly align a single field after TAB or RET.")
- (defvar org-last-recalc-line nil)
- (defun org-table-align ()
- "Align the table at point by aligning all vertical bars."
- (interactive)
- ;; (message "align") (sit-for 2)
- (let* (
- ;; Limits of table
- (beg (org-table-begin))
- (end (org-table-end))
- ;; Current cursor position
- (linepos (+ (if (bolp) 1 0) (count-lines (point-min) (point))))
- (colpos (org-table-current-column))
- (winstart (window-start))
- text lines (new "") lengths l typenums ty fields maxfields i
- column
- (indent "") cnt frac
- rfmt hfmt
- (spaces (if (org-in-invisibility-spec-p '(org-table))
- org-table-spaces-around-invisible-separators
- org-table-spaces-around-separators))
- (sp1 (car spaces))
- (sp2 (cdr spaces))
- (rfmt1 (concat
- (make-string sp2 ?\ ) "%%%s%ds" (make-string sp1 ?\ ) "|"))
- (hfmt1 (concat
- (make-string sp2 ?-) "%s" (make-string sp1 ?-) "+"))
- emptystrings)
- (untabify beg end)
- ;; (message "Aligning table...")
- ;; Get the rows
- (setq lines (org-split-string
- (buffer-substring-no-properties beg end) "\n"))
- ;; Store the indentation of the first line
- (if (string-match "^ *" (car lines))
- (setq indent (make-string (- (match-end 0) (match-beginning 0)) ?\ )))
- ;; Mark the hlines
- (setq lines (mapcar (lambda (l)
- (if (string-match "^ *|-" l)
- nil
- (if (string-match "[ \t]+$" l)
- (substring l 0 (match-beginning 0))
- l)))
- lines))
- ;; Get the data fields
- (setq fields (mapcar
- (lambda (l)
- (org-split-string l " *| *"))
- (delq nil (copy-sequence lines))))
- ;; How many fields in the longest line?
- (condition-case nil
- (setq maxfields (apply 'max (mapcar 'length fields)))
- (error
- (kill-region beg end)
- (org-table-create org-table-default-size)
- (error "Empty table - created default table")))
- ;; A list of empty string to fill any short rows on output
- (setq emptystrings (make-list maxfields ""))
- ;; Get the maximum length of a field and the most common datatype
- ;; for each column
- (setq i -1)
- (while (< (setq i (1+ i)) maxfields) ;; Loop over all columns
- (setq column (mapcar (lambda (x) (or (nth i x) "")) fields))
- ;; maximum length
- (push (apply 'max 1 (mapcar 'string-width column)) lengths)
- ;; compute the fraction stepwise, ignoring empty fields
- (setq cnt 0 frac 0.0)
- (mapcar
- (lambda (x)
- (if (equal x "")
- nil
- (setq frac ( / (+ (* frac cnt)
- (if (string-match org-table-number-regexp x) 1 0))
- (setq cnt (1+ cnt))))))
- column)
- (push (>= frac org-table-number-fraction) typenums))
- (setq lengths (nreverse lengths)
- typenums (nreverse typenums))
- (setq org-table-last-alignment typenums
- org-table-last-column-widths lengths)
- ;; Compute the formats needed for output of the table
- (setq rfmt (concat indent "|") hfmt (concat indent "|"))
- (while (setq l (pop lengths))
- (setq ty (if (pop typenums) "" "-")) ; number types flushright
- (setq rfmt (concat rfmt (format rfmt1 ty l))
- hfmt (concat hfmt (format hfmt1 (make-string l ?-)))))
- (setq rfmt (concat rfmt "\n")
- hfmt (concat (substring hfmt 0 -1) "|\n"))
- ;; Produce the new table
- ;;(while lines
- ;; (setq l (pop lines))
- ;; (if l
- ;; (setq new (concat new (apply 'format rfmt
- ;; (append (pop fields) emptystrings))))
- ;; (setq new (concat new hfmt))))
- (setq new (mapconcat
- (lambda (l)
- (if l (apply 'format rfmt
- (append (pop fields) emptystrings))
- hfmt))
- lines ""))
- ;; Replace the old one
- (delete-region beg end)
- (move-marker end nil)
- (move-marker org-table-aligned-begin-marker (point))
- (insert new)
- (move-marker org-table-aligned-end-marker (point))
- ;; Try to move to the old location (approximately)
- (goto-line linepos)
- (set-window-start (selected-window) winstart 'noforce)
- (org-table-goto-column colpos)
- (setq org-table-may-need-update nil)
- (if (org-in-invisibility-spec-p '(org-table))
- (org-table-add-invisible-to-vertical-lines))
- ))
- (defun org-table-begin (&optional table-type)
- "Find the beginning of the table and return its position.
- With argument TABLE-TYPE, go to the beginning of a table.el-type table."
- (save-excursion
- (if (not (re-search-backward
- (if table-type org-table-any-border-regexp
- org-table-border-regexp)
- nil t))
- (error "Can't find beginning of table")
- (goto-char (match-beginning 0))
- (beginning-of-line 2)
- (point))))
- (defun org-table-end (&optional table-type)
- "Find the end of the table and return its position.
- With argument TABLE-TYPE, go to the end of a table.el-type table."
- (save-excursion
- (if (not (re-search-forward
- (if table-type org-table-any-border-regexp
- org-table-border-regexp)
- nil t))
- (goto-char (point-max))
- (goto-char (match-beginning 0)))
- (point-marker)))
- (defun org-table-justify-field-maybe (&optional new)
- "Justify the current field, text to left, number to right.
- Optional argument NEW may specify text to replace the current field content."
- (cond
- ((and (not new) org-table-may-need-update)) ; Realignment will happen anyway
- ((org-at-table-hline-p)
- ;; FIXME: I used to enforce realign here, but I think this is not needed.
- ;; (setq org-table-may-need-update t)
- )
- ((and (not new)
- (or (not (equal (marker-buffer org-table-aligned-begin-marker)
- (current-buffer)))
- (< (point) org-table-aligned-begin-marker)
- (>= (point) org-table-aligned-end-marker)))
- ;; This is not the same table, force a full re-align
- (setq org-table-may-need-update t))
- (t ;; realign the current field, based on previous full realign
- (let* ((pos (point)) s
- (col (org-table-current-column))
- (num (nth (1- col) org-table-last-alignment))
- l f n o e)
- (when (> col 0)
- (skip-chars-backward "^|\n")
- (if (looking-at " *\\([^|\n]*?\\) *\\(|\\|$\\)")
- (progn
- (setq s (match-string 1)
- o (match-string 0)
- l (max 1 (- (match-end 0) (match-beginning 0) 3))
- e (not (= (match-beginning 2) (match-end 2))))
- (setq f (format (if num " %%%ds %s" " %%-%ds %s")
- l (if e "|" (setq org-table-may-need-update t) ""))
- n (format f s t t))
- (if new
- (if (<= (length new) l)
- (setq n (format f new t t)) ;; FIXME: why t t?????
- (setq n (concat new "|") org-table-may-need-update t)))
- (or (equal n o)
- (let (org-table-may-need-update)
- (replace-match n))))
- (setq org-table-may-need-update t))
- (goto-char pos))))))
- (defun org-table-next-field ()
- "Go to the next field in the current table, creating new lines as needed.
- Before doing so, re-align the table if necessary."
- (interactive)
- (org-table-maybe-eval-formula)
- (org-table-maybe-recalculate-line)
- (if (and org-table-automatic-realign
- org-table-may-need-update)
- (org-table-align))
- (let ((end (org-table-end)))
- (if (org-at-table-hline-p)
- (end-of-line 1))
- (condition-case nil
- (progn
- (re-search-forward "|" end)
- (if (looking-at "[ \t]*$")
- (re-search-forward "|" end))
- (if (and (looking-at "-")
- org-table-tab-jumps-over-hlines
- (re-search-forward "^[ \t]*|\\([^-]\\)" end t))
- (goto-char (match-beginning 1)))
- (if (looking-at "-")
- (progn
- (beginning-of-line 0)
- (org-table-insert-row 'below))
- (if (looking-at " ") (forward-char 1))))
- (error
- (org-table-insert-row 'below)))))
- (defun org-table-previous-field ()
- "Go to the previous field in the table.
- Before doing so, re-align the table if necessary."
- (interactive)
- (org-table-justify-field-maybe)
- (org-table-maybe-recalculate-line)
- (if (and org-table-automatic-realign
- org-table-may-need-update)
- (org-table-align))
- (if (org-at-table-hline-p)
- (end-of-line 1))
- (re-search-backward "|" (org-table-begin))
- (re-search-backward "|" (org-table-begin))
- (while (looking-at "|\\(-\\|[ \t]*$\\)")
- (re-search-backward "|" (org-table-begin)))
- (if (looking-at "| ?")
- (goto-char (match-end 0))))
- (defun org-table-next-row ()
- "Go to the next row (same column) in the current table.
- Before doing so, re-align the table if necessary."
- (interactive)
- (org-table-maybe-eval-formula)
- (org-table-maybe-recalculate-line)
- (if (or (looking-at "[ \t]*$")
- (save-excursion (skip-chars-backward " \t") (bolp)))
- (newline)
- (if (and org-table-automatic-realign
- org-table-may-need-update)
- (org-table-align))
- (let ((col (org-table-current-column)))
- (beginning-of-line 2)
- (if (or (not (org-at-table-p))
- (org-at-table-hline-p))
- (progn
- (beginning-of-line 0)
- (org-table-insert-row 'below)))
- (org-table-goto-column col)
- (skip-chars-backward "^|\n\r")
- (if (looking-at " ") (forward-char 1)))))
- (defun org-table-copy-down (n)
- "Copy a field down in the current column.
- If the field at the cursor is empty, copy into it the content of the nearest
- non-empty field above. With argument N, use the Nth non-empty field.
- If the current field is not empty, it is copied down to the next row, and
- the cursor is moved with it. Therefore, repeating this command causes the
- column to be filled row-by-row.
- If the variable `org-table-copy-increment' is non-nil and the field is an
- integer, it will be incremented while copying."
- (interactive "p")
- (let* ((colpos (org-table-current-column))
- (field (org-table-get-field))
- (non-empty (string-match "[^ \t]" field))
- (beg (org-table-begin))
- txt)
- (org-table-check-inside-data-field)
- (if non-empty
- (progn
- (setq txt (org-trim field))
- (org-table-next-row)
- (org-table-blank-field))
- (save-excursion
- (setq txt
- (catch 'exit
- (while (progn (beginning-of-line 1)
- (re-search-backward org-table-dataline-regexp
- beg t))
- (org-table-goto-column colpos t)
- (if (and (looking-at
- "|[ \t]*\\([^| \t][^|]*?\\)[ \t]*|")
- (= (setq n (1- n)) 0))
- (throw 'exit (match-string 1))))))))
- (if txt
- (progn
- (if (and org-table-copy-increment
- (string-match "^[0-9]+$" txt))
- (setq txt (format "%d" (+ (string-to-number txt) 1))))
- (insert txt)
- (org-table-maybe-recalculate-line)
- (org-table-align))
- (error "No non-empty field found"))))
- (defun org-table-check-inside-data-field ()
- "Is point inside a table data field?
- I.e. not on a hline or before the first or after the last column?
- This actually throws an error, so it aborts the current command."
- (if (or (not (org-at-table-p))
- (= (org-table-current-column) 0)
- (org-at-table-hline-p)
- (looking-at "[ \t]*$"))
- (error "Not in table data field")))
- (defvar org-table-clip nil
- "Clipboard for table regions.")
- (defun org-table-blank-field ()
- "Blank the current table field or active region."
- (interactive)
- (org-table-check-inside-data-field)
- (if (and (interactive-p) (org-region-active-p))
- (let (org-table-clip)
- (org-table-cut-region (region-beginning) (region-end)))
- (skip-chars-backward "^|")
- (backward-char 1)
- (if (looking-at "|[^|\n]+")
- (let* ((pos (match-beginning 0))
- (match (match-string 0))
- (len (string-width match)))
- (replace-match (concat "|" (make-string (1- len) ?\ )))
- (goto-char (+ 2 pos))
- (substring match 1)))))
- (defun org-table-get-field (&optional n replace)
- "Return the value of the field in column N of current row.
- N defaults to current field.
- If REPLACE is a string, replace field with this value. The return value
- is always the old value."
- (and n (org-table-goto-column n))
- (skip-chars-backward "^|\n")
- (backward-char 1)
- (if (looking-at "|[^|\r\n]*")
- (let* ((pos (match-beginning 0))
- (val (buffer-substring (1+ pos) (match-end 0))))
- (if replace
- (replace-match (concat "|" replace)))
- (goto-char (min (point-at-eol) (+ 2 pos)))
- val)
- (forward-char 1) ""))
- (defun org-table-current-column ()
- "Find out which column we are in.
- When called interactively, column is also displayed in echo area."
- (interactive)
- (if (interactive-p) (org-table-check-inside-data-field))
- (save-excursion
- (let ((cnt 0) (pos (point)))
- (beginning-of-line 1)
- (while (search-forward "|" pos t)
- (setq cnt (1+ cnt)))
- (if (interactive-p) (message "This is table column %d" cnt))
- cnt)))
- (defun org-table-goto-column (n &optional on-delim force)
- "Move the cursor to the Nth column in the current table line.
- With optional argument ON-DELIM, stop with point before the left delimiter
- of the field.
- If there are less than N fields, just go to after the last delimiter.
- However, when FORCE is non-nil, create new columns if necessary."
- (interactive "p")
- (let ((pos (point-at-eol)))
- (beginning-of-line 1)
- (when (> n 0)
- (while (and (> (setq n (1- n)) -1)
- (or (search-forward "|" pos t)
- (and force
- (progn (end-of-line 1)
- (skip-chars-backward "^|")
- (insert " | "))))))
- ; (backward-char 2) t)))))
- (when (and force (not (looking-at ".*|")))
- (save-excursion (end-of-line 1) (insert " | ")))
- (if on-delim
- (backward-char 1)
- (if (looking-at " ") (forward-char 1))))))
- (defun org-at-table-p (&optional table-type)
- "Return t if the cursor is inside an org-type table.
- If TABLE-TYPE is non-nil, also check for table.el-type tables."
- (if org-enable-table-editor
- (save-excursion
- (beginning-of-line 1)
- (looking-at (if table-type org-table-any-line-regexp
- org-table-line-regexp)))
- nil))
- (defun org-at-table.el-p ()
- "Return t if and only if we are at a table.el table."
- (and (org-at-table-p 'any)
- (save-excursion
- (goto-char (org-table-begin 'any))
- (looking-at org-table1-hline-regexp))))
- (defun org-table-recognize-table.el ()
- "If there is a table.el table nearby, recognize it and move into it."
- (if org-table-tab-recognizes-table.el
- (if (org-at-table.el-p)
- (progn
- (beginning-of-line 1)
- (if (looking-at org-table-dataline-regexp)
- nil
- (if (looking-at org-table1-hline-regexp)
- (progn
- (beginning-of-line 2)
- (if (looking-at org-table-any-border-regexp)
- (beginning-of-line -1)))))
- (if (re-search-forward "|" (org-table-end t) t)
- (progn
- (require 'table)
- (if (table--at-cell-p (point))
- t
- (message "recognizing table.el table...")
- (table-recognize-table)
- (message "recognizing table.el table...done")))
- (error "This should not happen..."))
- t)
- nil)
- nil))
- (defun org-at-table-hline-p ()
- "Return t if the cursor is inside a hline in a table."
- (if org-enable-table-editor
- (save-excursion
- (beginning-of-line 1)
- (looking-at org-table-hline-regexp))
- nil))
- (defun org-table-insert-column ()
- "Insert a new column into the table."
- (interactive)
- (if (not (org-at-table-p))
- (error "Not at a table"))
- (org-table-find-dataline)
- (let* ((col (max 1 (org-table-current-column)))
- (beg (org-table-begin))
- (end (org-table-end))
- ;; Current cursor position
- (linepos (+ (if (bolp) 1 0) (count-lines (point-min) (point))))
- (colpos col))
- (goto-char beg)
- (while (< (point) end)
- (if (org-at-table-hline-p)
- nil
- (org-table-goto-column col t)
- (insert "| "))
- (beginning-of-line 2))
- (move-marker end nil)
- (goto-line linepos)
- (org-table-goto-column colpos)
- (org-table-align)
- (org-table-modify-formulas 'insert col)))
- (defun org-table-find-dataline ()
- "Find a dataline in the current table, which is needed for column commands."
- (if (and (org-at-table-p)
- (not (org-at-table-hline-p)))
- t
- (let ((col (current-column))
- (end (org-table-end)))
- (move-to-column col)
- (while (and (< (point) end)
- (or (not (= (current-column) col))
- (org-at-table-hline-p)))
- (beginning-of-line 2)
- (move-to-column col))
- (if (and (org-at-table-p)
- (not (org-at-table-hline-p)))
- t
- (error
- "Please position cursor in a data line for column operations")))))
- (defun org-table-delete-column ()
- "Delete a column into the table."
- (interactive)
- (if (not (org-at-table-p))
- (error "Not at a table"))
- (org-table-find-dataline)
- (org-table-check-inside-data-field)
- (let* ((col (org-table-current-column))
- (beg (org-table-begin))
- (end (org-table-end))
- ;; Current cursor position
- (linepos (+ (if (bolp) 1 0) (count-lines (point-min) (point))))
- (colpos col))
- (goto-char beg)
- (while (< (point) end)
- (if (org-at-table-hline-p)
- nil
- (org-table-goto-column col t)
- (and (looking-at "|[^|\n]+|")
- (replace-match "|")))
- (beginning-of-line 2))
- (move-marker end nil)
- (goto-line linepos)
- (org-table-goto-column colpos)
- (org-table-align)
- (org-table-modify-formulas 'remove col)))
- (defun org-table-move-column-right ()
- "Move column to the right."
- (interactive)
- (org-table-move-column nil))
- (defun org-table-move-column-left ()
- "Move column to the left."
- (interactive)
- (org-table-move-column 'left))
- (defun org-table-move-column (&optional left)
- "Move the current column to the right. With arg LEFT, move to the left."
- (interactive "P")
- (if (not (org-at-table-p))
- (error "Not at a table"))
- (org-table-find-dataline)
- (org-table-check-inside-data-field)
- (let* ((col (org-table-current-column))
- (col1 (if left (1- col) col))
- (beg (org-table-begin))
- (end (org-table-end))
- ;; Current cursor position
- (linepos (+ (if (bolp) 1 0) (count-lines (point-min) (point))))
- (colpos (if left (1- col) (1+ col))))
- (if (and left (= col 1))
- (error "Cannot move column further left"))
- (if (and (not left) (looking-at "[^|\n]*|[^|\n]*$"))
- (error "Cannot move column further right"))
- (goto-char beg)
- (while (< (point) end)
- (if (org-at-table-hline-p)
- nil
- (org-table-goto-column col1 t)
- (and (looking-at "|\\([^|\n]+\\)|\\([^|\n]+\\)|")
- (replace-match "|\\2|\\1|")))
- (beginning-of-line 2))
- (move-marker end nil)
- (goto-line linepos)
- (org-table-goto-column colpos)
- (org-table-align)
- (org-table-modify-formulas 'swap col (if left (1- col) (1+ col)))))
- (defun org-table-move-row-down ()
- "Move table row down."
- (interactive)
- (org-table-move-row nil))
- (defun org-table-move-row-up ()
- "Move table row up."
- (interactive)
- (org-table-move-row 'up))
- (defun org-table-move-row (&optional up)
- "Move the current table line down. With arg UP, move it up."
- (interactive "P")
- (let ((col (current-column))
- (pos (point))
- (tonew (if up 0 2))
- txt)
- (beginning-of-line tonew)
- (if (not (org-at-table-p))
- (progn
- (goto-char pos)
- (error "Cannot move row further")))
- (goto-char pos)
- (beginning-of-line 1)
- (setq pos (point))
- (setq txt (buffer-substring (point) (1+ (point-at-eol))))
- (delete-region (point) (1+ (point-at-eol)))
- (beginning-of-line tonew)
- (insert txt)
- (beginning-of-line 0)
- (move-to-column col)))
- (defun org-table-insert-row (&optional arg)
- "Insert a new row above the current line into the table.
- With prefix ARG, insert below the current line."
- (interactive "P")
- (if (not (org-at-table-p))
- (error "Not at a table"))
- (let* ((line
- (org-expand-wide-chars
- (buffer-substring-no-properties (point-at-bol) (point-at-eol))))
- new)
- (if (string-match "^[ \t]*|-" line)
- (setq new (mapcar (lambda (x) (if (member x '(?| ?+)) ?| ?\ )) line))
- (setq new (mapcar (lambda (x) (if (equal x ?|) ?| ?\ )) line)))
- ;; Fix the first field if necessary
- (setq new (concat new))
- (if (string-match "^[ \t]*| *[#$] *|" line)
- (setq new (replace-match (match-string 0 line) t t new)))
- (beginning-of-line (if arg 2 1))
- (let (org-table-may-need-update)
- (insert-before-markers new)
- (insert-before-markers "\n"))
- (beginning-of-line 0)
- (re-search-forward "| ?" (point-at-eol) t)
- (and org-table-may-need-update (org-table-align))))
- (defun org-table-insert-hline (&optional arg)
- "Insert a horizontal-line below the current line into the table.
- With prefix ARG, insert above the current line."
- (interactive "P")
- (if (not (org-at-table-p))
- (error "Not at a table"))
- (let ((line
- (org-expand-wide-chars
- (buffer-substring-no-properties (point-at-bol) (point-at-eol))))
- (col (current-column))
- start)
- (if (string-match "^[ \t]*|-" line)
- (setq line
- (mapcar (lambda (x) (if (member x '(?| ?+))
- (prog1 (if start ?+ ?|) (setq start t))
- (if start ?- ?\ )))
- line))
- (setq line
- (mapcar (lambda (x) (if (equal x ?|)
- (prog1 (if start ?+ ?|) (setq start t))
- (if start ?- ?\ )))
- line)))
- (beginning-of-line (if arg 1 2))
- (apply 'insert line)
- (if (equal (char-before (point)) ?+)
- (progn (backward-delete-char 1) (insert "|")))
- (insert "\n")
- (beginning-of-line (if arg 1 -1))
- (move-to-column col)))
- (defun org-expand-wide-chars (s)
- "Expand wide characters to spaces."
- (let (w a)
- (mapconcat
- (lambda (x)
- (if (> (setq w (string-width (setq a (char-to-string x)))) 1)
- (make-string w ?\ )
- a))
- s "")))
- (defun org-table-kill-row ()
- "Delete the current row or horizontal line from the table."
- (interactive)
- (if (not (org-at-table-p))
- (error "Not at a table"))
- (let ((col (current-column)))
- (kill-region (point-at-bol) (min (1+ (point-at-eol)) (point-max)))
- (if (not (org-at-table-p)) (beginning-of-line 0))
- (move-to-column col)))
- (defun org-table-sort-lines (beg end numericp)
- "Sort table lines in region.
- Point and mark define the first and last line to include. Both point and
- mark should be in the column that is used for sorting. For example, to
- sort according to column 3, put the mark in the first line to sort, in
- table column 3. Put point into the last line to be included in the sorting,
- also in table column 3. The command will prompt for the sorting method
- \(n for numerical, a for alphanumeric)."
- (interactive "r\nsSorting method: [n]=numeric [a]=alpha: ")
- (setq numericp (string-match "[nN]" numericp))
- (org-table-align) ;; Just to be safe
- (let* (bcol ecol cmp column lns)
- (goto-char beg)
- (org-table-check-inside-data-field)
- (setq column (org-table-current-column)
- beg (move-marker (make-marker) (point-at-bol)))
- (goto-char end)
- (org-table-check-inside-data-field)
- (setq end (move-marker (make-marker) (1+ (point-at-eol))))
- (untabify beg end)
- (goto-char beg)
- (org-table-goto-column column)
- (skip-chars-backward "^|")
- (setq bcol (current-column))
- (org-table-goto-column (1+ column))
- (skip-chars-backward "^|")
- (setq ecol (1- (current-column)))
- (setq cmp (if numericp
- (lambda (a b) (< (car a) (car b)))
- (lambda (a b) (string< (car a) (car b)))))
- (setq lns (mapcar (lambda(x) (cons (org-trim (substring x bcol ecol)) x))
- (split-string (buffer-substring beg end) "\n")))
- (if numericp
- (setq lns (mapcar (lambda(x)
- (cons (string-to-number (car x)) (cdr x)))
- lns)))
- (delete-region beg end)
- (move-marker beg nil)
- (move-marker end nil)
- (insert (mapconcat 'cdr (setq lns (sort lns cmp)) "\n") "\n")
- (message "%d lines sorted %s based on column %d"
- (length lns)
- (if numericp "numerically" "alphabetically") column)))
- (defun org-table-cut-region (beg end)
- "Copy region in table to the clipboard and blank all relevant fields."
- (interactive "r")
- (org-table-copy-region beg end 'cut))
- (defun org-table-copy-region (beg end &optional cut)
- "Copy rectangular region in table to clipboard.
- A special clipboard is used which can only be accessed
- with `org-table-paste-rectangle'."
- (interactive "rP")
- (let* (l01 c01 l02 c02 l1 c1 l2 c2 ic1 ic2
- region cols
- (rpl (if cut " " nil)))
- (goto-char beg)
- (org-table-check-inside-data-field)
- (setq l01 (count-lines (point-min) (point))
- c01 (org-table-current-column))
- (goto-char end)
- (org-table-check-inside-data-field)
- (setq l02 (count-lines (point-min) (point))
- c02 (org-table-current-column))
- (setq l1 (min l01 l02) l2 (max l01 l02)
- c1 (min c01 c02) c2 (max c01 c02))
- (catch 'exit
- (while t
- (catch 'nextline
- (if (> l1 l2) (throw 'exit t))
- (goto-line l1)
- (if (org-at-table-hline-p) (throw 'nextline (setq l1 (1+ l1))))
- (setq cols nil ic1 c1 ic2 c2)
- (while (< ic1 (1+ ic2))
- (push (org-table-get-field ic1 rpl) cols)
- (setq ic1 (1+ ic1)))
- (push (nreverse cols) region)
- (setq l1 (1+ l1)))))
- (setq org-table-clip (nreverse region))
- (if cut (org-table-align))
- org-table-clip))
- (defun org-table-paste-rectangle ()
- "Paste a rectangular region into a table.
- The upper right corner ends up in the current field. All involved fields
- will be overwritten. If the rectangle does not fit into the present table,
- the table is enlarged as needed. The process ignores horizontal separator
- lines."
- (interactive)
- (unless (and org-table-clip (listp org-table-clip))
- (error "First cut/copy a region to paste!"))
- (org-table-check-inside-data-field)
- (let* ((clip org-table-clip)
- (line (count-lines (point-min) (point)))
- (col (org-table-current-column))
- (org-enable-table-editor t)
- (org-table-automatic-realign nil)
- c cols field)
- (while (setq cols (pop clip))
- (while (org-at-table-hline-p) (beginning-of-line 2))
- (if (not (org-at-table-p))
- (progn (end-of-line 0) (org-table-next-field)))
- (setq c col)
- (while (setq field (pop cols))
- (org-table-goto-column c nil 'force)
- (org-table-get-field nil field)
- (setq c (1+ c)))
- (beginning-of-line 2))
- (goto-line line)
- (org-table-goto-column col)
- (org-table-align)))
- (defun org-table-convert ()
- "Convert from `org-mode' table to table.el and back.
- Obviously, this only works within limits. When an Org-mode table is
- converted to table.el, all horizontal separator lines get lost, because
- table.el uses these as cell boundaries and has no notion of horizontal lines.
- A table.el table can be converted to an Org-mode table only if it does not
- do row or column spanning. Multiline cells will become multiple cells.
- Beware, Org-mode does not test if the table can be successfully converted - it
- blindly applies a recipe that works for simple tables."
- (interactive)
- (require 'table)
- (if (org-at-table.el-p)
- ;; convert to Org-mode table
- (let ((beg (move-marker (make-marker) (org-table-begin t)))
- (end (move-marker (make-marker) (org-table-end t))))
- (table-unrecognize-region beg end)
- (goto-char beg)
- (while (re-search-forward "^\\([ \t]*\\)\\+-.*\n" end t)
- (replace-match ""))
- (goto-char beg))
- (if (org-at-table-p)
- ;; convert to table.el table
- (let ((beg (move-marker (make-marker) (org-table-begin)))
- (end (move-marker (make-marker) (org-table-end))))
- ;; first, get rid of all horizontal lines
- (goto-char beg)
- (while (re-search-forward "^\\([ \t]*\\)|-.*\n" end t)
- (replace-match ""))
- ;; insert a hline before first
- (goto-char beg)
- (org-table-insert-hline 'above)
- (beginning-of-line -1)
- ;; insert a hline after each line
- (while (progn (beginning-of-line 3) (< (point) end))
- (org-table-insert-hline))
- (goto-char beg)
- (setq end (move-marker end (org-table-end)))
- ;; replace "+" at beginning and ending of hlines
- (while (re-search-forward "^\\([ \t]*\\)|-" end t)
- (replace-match "\\1+-"))
- (goto-char beg)
- (while (re-search-forward "-|[ \t]*$" end t)
- (replace-match "-+"))
- (goto-char beg)))))
- (defun org-table-wrap-region (arg)
- "Wrap several fields in a column like a paragraph.
- This is useful if you'd like to spread the contents of a field over several
- lines, in order to keep the table compact.
- If there is an active region, and both point and mark are in the same column,
- the text in the column is wrapped to minimum width for the given number of
- lines. Generally, this makes the table more compact. A prefix ARG may be
- used to change the number of desired lines. For example, `C-2 \\[org-table-wrap]'
- formats the selected text to two lines. If the region was longer than two
- lines, the remaining lines remain empty. A negative prefix argument reduces
- the current number of lines by that amount. The wrapped text is pasted back
- into the table. If you formatted it to more lines than it was before, fields
- further down in the table get overwritten - so you might need to make space in
- the table first.
- If there is no region, the current field is split at the cursor position and
- the text fragment to the right of the cursor is prepended to the field one
- line down.
- If there is no region, but you specify a prefix ARG, the current field gets
- blank, and the content is appended to the field above."
- (interactive "P")
- (org-table-check-inside-data-field)
- (if (org-region-active-p)
- ;; There is a region: fill as a paragraph
- (let ((beg (region-beginning))
- nlines)
- (org-table-cut-region (region-beginning) (region-end))
- (if (> (length (car org-table-clip)) 1)
- (error "Region must be limited to single column"))
- (setq nlines (if arg
- (if (< arg 1)
- (+ (length org-table-clip) arg)
- arg)
- (length org-table-clip)))
- (setq org-table-clip
- (mapcar 'list (org-wrap (mapconcat 'car org-table-clip " ")
- nil nlines)))
- (goto-char beg)
- (org-table-paste-rectangle))
- ;; No region, split the current field at point
- (if arg
- ;; combine with field above
- (let ((s (org-table-blank-field))
- (col (org-table-current-column)))
- (beginning-of-line 0)
- (while (org-at-table-hline-p) (beginning-of-line 0))
- (org-table-goto-column col)
- (skip-chars-forward "^|")
- (skip-chars-backward " ")
- (insert " " (org-trim s))
- (org-table-align))
- ;; split field
- (when (looking-at "\\([^|]+\\)+|")
- (let ((s (match-string 1)))
- (replace-match " |")
- (goto-char (match-beginning 0))
- (org-table-next-row)
- (insert (org-trim s) " ")
- (org-table-align))))))
- (defun org-trim (s)
- "Remove whitespace at beginning and end of string."
- (if (string-match "^[ \t]+" s) (setq s (replace-match "" t t s)))
- (if (string-match "[ \t]+$" s) (setq s (replace-match "" t t s)))
- s)
- (defun org-wrap (string &optional width lines)
- "Wrap string to either a number of lines, or a width in characters.
- If WIDTH is non-nil, the string is wrapped to that width, however many lines
- that costs. If there is a word longer than WIDTH, the text is actually
- wrapped to the length of that word.
- IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
- many lines, whatever width that takes.
- The return value is a list of lines, without newlines at the end."
- (let* ((words (org-split-string string "[ \t\n]+"))
- (maxword (apply 'max (mapcar 'string-width words)))
- w ll)
- (cond (width
- (org-do-wrap words (max maxword width)))
- (lines
- (setq w maxword)
- (setq ll (org-do-wrap words maxword))
- (if (<= (length ll) lines)
- ll
- (setq ll words)
- (while (> (length ll) lines)
- (setq w (1+ w))
- (setq ll (org-do-wrap words w)))
- ll))
- (t (error "Cannot wrap this")))))
- (defun org-do-wrap (words width)
- "Create lines of maximum width WIDTH (in characters) from word list WORDS."
- (let (lines line)
- (while words
- (setq line (pop words))
- (while (and words (< (+ (length line) (length (car words))) width))
- (setq line (concat line " " (pop words))))
- (setq lines (push line lines)))
- (nreverse lines)))
- ;; FIXME: I think I can make this more efficient
- (defun org-split-string (string &optional separators)
- "Splits STRING into substrings at SEPARATORS.
- No empty strings are returned if there are matches at the beginning
- and end of string."
- (let ((rexp (or separators "[ \f\t\n\r\v]+"))
- (start 0)
- notfirst
- (list nil))
- (while (and (string-match rexp string
- (if (and notfirst
- (= start (match-beginning 0))
- (< start (length string)))
- (1+ start) start))
- (< (match-beginning 0) (length string)))
- (setq notfirst t)
- (or (eq (match-beginning 0) 0)
- (and (eq (match-beginning 0) (match-end 0))
- (eq (match-beginning 0) start))
- (setq list
- (cons (substring string start (match-beginning 0))
- list)))
- (setq start (match-end 0)))
- (or (eq start (length string))
- (setq list
- (cons (substring string start)
- list)))
- (nreverse list)))
- (defun org-table-add-invisible-to-vertical-lines ()
- "Add an `invisible' property to vertical lines of current table."
- (interactive)
- (let* ((beg (org-table-begin))
- (end (org-table-end))
- (end1))
- (save-excursion
- (goto-char beg)
- (while (< (point) end)
- (setq end1 (point-at-eol))
- (if (looking-at org-table-dataline-regexp)
- (while (re-search-forward "|" end1 t)
- (add-text-properties (1- (point)) (point)
- '(invisible org-table)))
- (while (re-search-forward "[+|]" end1 t)
- (add-text-properties (1- (point)) (point)
- '(invisible org-table))))
- (beginning-of-line 2)))))
- (defun org-table-toggle-vline-visibility (&optional arg)
- "Toggle the visibility of table vertical lines.
- The effect is immediate and on all tables in the file.
- With prefix ARG, make lines invisible when ARG is positive, make lines
- visible when ARG is not positive."
- (interactive "P")
- (let ((action (cond
- ((and arg (> (prefix-numeric-value arg) 0)) 'on)
- ((and arg (< (prefix-numeric-value arg) 1)) 'off)
- (t (if (org-in-invisibility-spec-p '(org-table))
- 'off
- 'on)))))
- (if (eq action 'off)
- (progn
- (org-remove-from-invisibility-spec '(org-table))
- (org-table-map-tables 'org-table-align)
- (message "Vertical table lines visible")
- (if (org-at-table-p)
- (org-table-align)))
- (org-add-to-invisibility-spec '(org-table))
- (org-table-map-tables 'org-table-align)
- (message "Vertical table lines invisible"))
- (redraw-frame (selected-frame))))
- (defun org-table-map-tables (function)
- "Apply FUNCTION to the start of all tables in the buffer."
- (save-excursion
- (save-restriction
- (widen)
- (goto-char (point-min))
- (while (re-search-forward org-table-any-line-regexp nil t)
- (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size)))
- (beginning-of-line 1)
- (if (looking-at org-table-line-regexp)
- (save-excursion (funcall function)))
- (re-search-forward org-table-any-border-regexp nil 1)))))
- (defun org-table-sum (&optional beg end nlast)
- "Sum numbers in region of current table column.
- The result will be displayed in the echo area, and will be available
- as kill to be inserted with \\[yank].
- If there is an active region, it is interpreted as a rectangle and all
- numbers in that rectangle will be summed. If there is no active
- region and point is located in a table column, sum all numbers in that
- column.
- If at least one number looks like a time HH:MM or HH:MM:SS, all other
- numbers are assumed to be times as well (in decimal hours) and the
- numbers are added as such.
- If NLAST is a number, only the NLAST fields will actually be summed."
- (interactive)
- (save-excursion
- (let (col (timecnt 0) diff h m s org-table-clip)
- (cond
- ((and beg end)) ; beg and end given explicitly
- ((org-region-active-p)
- (setq beg (region-beginning) end (region-end)))
- (t
- (setq col (org-table-current-column))
- (goto-char (org-table-begin))
- (unless (re-search-forward "^[ \t]*|[^-]" nil t)
- (error "No table data"))
- (org-table-goto-column col)
- ;not needed? (skip-chars-backward "^|")
- (setq beg (point))
- (goto-char (org-table-end))
- (unless (re-search-backward "^[ \t]*|[^-]" nil t)
- (error "No table data"))
- (org-table-goto-column col)
- ;not needed? (skip-chars-forward "^|")
- (setq end (point))))
- (let* ((items (apply 'append (org-table-copy-region beg end)))
- (items1 (cond ((not nlast) items)
- ((>= nlast (length items)) items)
- (t (setq items (reverse items))
- (setcdr (nthcdr (1- nlast) items) nil)
- (nreverse items))))
- (numbers (delq nil (mapcar 'org-table-get-number-for-summing
- items1)))
- (res (apply '+ numbers))
- (sres (if (= timecnt 0)
- (format "%g" res)
- (setq diff (* 3600 res)
- h (floor (/ diff 3600)) diff (mod diff 3600)
- m (floor (/ diff 60)) diff (mod diff 60)
- s diff)
- (format "%d:%02d:%02d" h m s))))
- (kill-new sres)
- (if (interactive-p)
- (message "%s"
- (substitute-command-keys
- (format "Sum of %d items: %-20s (\\[yank] will insert result into buffer)"
- (length numbers) sres))))
- sres))))
- (defun org-table-get-number-for-summing (s)
- (let (n)
- (if (string-match "^ *|? *" s)
- (setq s (replace-match "" nil nil s)))
- (if (string-match " *|? *$" s)
- (setq s (replace-match "" nil nil s)))
- (setq n (string-to-number s))
- (cond
- ((and (string-match "0" s)
- (string-match "\\`[-+ \t0.edED]+\\'" s)) 0)
- ((string-match "\\`[ \t]+\\'" s) nil)
- ((string-match "\\`\\([0-9]+\\):\\([0-9]+\\)\\(:\\([0-9]+\\)\\)?\\'" s)
- (let ((h (string-to-number (or (match-string 1 s) "0")))
- (m (string-to-number (or (match-string 2 s) "0")))
- (s (string-to-number (or (match-string 4 s) "0"))))
- (if (boundp 'timecnt) (setq timecnt (1+ timecnt)))
- (* 1.0 (+ h (/ m 60.0) (/ s 3600.0)))))
- ((equal n 0) nil)
- (t n))))
- (defun org-table-get-vertical-vector (desc &optional tbeg col)
- "Get a calc vector from a column, accorting to descriptor DESC.
- Optional arguments TBEG and COL can give the beginning of the table and
- the current column, to avoid unnecessary parsing."
- (save-excursion
- (or tbeg (setq tbeg (org-table-begin)))
- (or col (setq col (org-table-current-column)))
- (let (beg end nn n n1 n2 l (thisline (org-current-line)) hline-list)
- (cond
- ((string-match "\\(I+\\)\\(-\\(I+\\)\\)?" desc)
- (setq n1 (- (match-end 1) (match-beginning 1)))
- (if (match-beginning 3)
- (setq n2 (- (match-end 2) (match-beginning 3))))
- (setq n (if n2 (max n1 n2) n1))
- (setq n1 (if n2 (min n1 n2)))
- (setq nn n)
- (while (and (> nn 0)
- (re-search-backward org-table-hline-regexp tbeg t))
- (push (org-current-line) hline-list)
- (setq nn (1- nn)))
- (setq hline-list (nreverse hline-list))
- (goto-line (nth (1- n) hline-list))
- (when (re-search-forward org-table-dataline-regexp)
- (org-table-goto-column col)
- (setq beg (point)))
- (goto-line (if n1 (nth (1- n1) hline-list) thisline))
- (when (re-search-backward org-table-dataline-regexp)
- (org-table-goto-column col)
- (setq end (point)))
- (setq l (apply 'append (org-table-copy-region beg end)))
- (concat "[" (mapconcat (lambda (x) (setq x (org-trim x))
- (if (equal x "") "0" x))
- l ",") "]"))
- ((string-match "\\([0-9]+\\)-\\([0-9]+\\)" desc)
- (setq n1 (string-to-number (match-string 1 desc))
- n2 (string-to-number (match-string 2 desc)))
- (beginning-of-line 1)
- (save-excursion
- (when (re-search-backward org-table-dataline-regexp tbeg t n1)
- (org-table-goto-column col)
- (setq beg (point))))
- (when (re-search-backward org-table-dataline-regexp tbeg t n2)
- (org-table-goto-column col)
- (setq end (point)))
- (setq l (apply 'append (org-table-copy-region beg end)))
- (concat "[" (mapconcat
- (lambda (x) (setq x (org-trim x))
- (if (equal x "") "0" x))
- l ",") "]"))
- ((string-match "\\([0-9]+\\)" desc)
- (beginning-of-line 1)
- (when (re-search-backward org-table-dataline-regexp tbeg t
- (string-to-number (match-string 0 desc)))
- (org-table-goto-column col)
- (org-trim (org-table-get-field))))))))
- (defvar org-table-formula-history nil)
- (defvar org-table-column-names nil
- "Alist with column names, derived from the `!' line.")
- (defvar org-table-column-name-regexp nil
- "Regular expression matching the current column names.")
- (defvar org-table-local-parameters nil
- "Alist with parameter names, derived from the `$' line.")
- (defvar org-table-named-field-locations nil
- "Alist with locations of named fields.")
- (defun org-table-get-formula (&optional equation named)
- "Read a formula from the minibuffer, offer stored formula as default."
- (let* ((name (car (rassoc (list (org-current-line)
- (org-table-current-column))
- org-table-named-field-locations)))
- (scol (if named
- (if name name
- (error "Not in a named field"))
- (int-to-string (org-table-current-column))))
- (dummy (and name (not named)
- (not (y-or-n-p "Replace named-field formula with column equation? " ))
- (error "Abort")))
- (org-table-may-need-update nil)
- (stored-list (org-table-get-stored-formulas))
- (stored (cdr (assoc scol stored-list)))
- (eq (cond
- ((and stored equation (string-match "^ *=? *$" equation))
- stored)
- ((stringp equation)
- equation)
- (t (read-string
- (format "%s formula $%s=" (if named "Field" "Column") scol)
- (or stored "") 'org-table-formula-history
- ;stored
- ))))
- mustsave)
- (when (not (string-match "\\S-" eq))
- ;; remove formula
- (setq stored-list (delq (assoc scol stored-list) stored-list))
- (org-table-store-formulas stored-list)
- (error "Formula removed"))
- (if (string-match "^ *=?" eq) (setq eq (replace-match "" t t eq)))
- (if (string-match " *$" eq) (setq eq (replace-match "" t t eq)))
- (if (and name (not named))
- ;; We set the column equation, delete the named one.
- (setq stored-list (delq (assoc name stored-list) stored-list)
- mustsave t))
- (if stored
- (setcdr (assoc scol stored-list) eq)
- (setq stored-list (cons (cons scol eq) stored-list)))
- (if (or mustsave (not (equal stored eq)))
- (org-table-store-formulas stored-list))
- eq))
- (defun org-table-store-formulas (alist)
- "Store the list of formulas below the current table."
- (setq alist (sort alist (lambda (a b) (string< (car a) (car b)))))
- (save-excursion
- (goto-char (org-table-end))
- (if (looking-at "\\([ \t]*\n\\)*#\\+TBLFM:.*\n?")
- (delete-region (point) (match-end 0)))
- (insert "#+TBLFM: "
- (mapconcat (lambda (x)
- (concat "$" (car x) "=" (cdr x)))
- alist "::")
- "\n")))
- (defun org-table-get-stored-formulas ()
- "Return an alist with the t=stored formulas directly after current table."
- (interactive)
- (let (scol eq eq-alist strings string seen)
- (save-excursion
- (goto-char (org-table-end))
- (when (looking-at "\\([ \t]*\n\\)*#\\+TBLFM: *\\(.*\\)")
- (setq strings (org-split-string (match-string 2) " *:: *"))
- (while (setq string (pop strings))
- (when (string-match "\\$\\([a-zA-Z0-9]+\\) *= *\\(.*[^ \t]\\)" string)
- (setq scol (match-string 1 string)
- eq (match-string 2 string)
- eq-alist (cons (cons scol eq) eq-alist))
- (if (member scol seen)
- (error "Double definition `$%s=' in TBLFM line, please fix by hand" scol)
- (push scol seen))))))
- (nreverse eq-alist)))
- (defun org-table-modify-formulas (action &rest columns)
- "Modify the formulas stored below the current table.
- ACTION can be `remove', `insert', `swap'. For `swap', two column numbers are
- expected, for the other actions only a single column number is needed."
- (let ((list (org-table-get-stored-formulas))
- (nmax (length (org-split-string
- (buffer-substring (point-at-bol) (point-at-eol))
- "|")))
- col col1 col2 scol si sc1 sc2)
- (cond
- ((null list)) ; No action needed if there are no stored formulas
- ((eq action 'remove)
- (setq col (car columns)
- scol (int-to-string col))
- (org-table-replace-in-formulas list scol "INVALID")
- (if (assoc scol list) (setq list (delq (assoc scol list) list)))
- (loop for i from (1+ col) upto nmax by 1 do
- (setq si (int-to-string i))
- (org-table-replace-in-formulas list si (int-to-string (1- i)))
- (if (assoc si list) (setcar (assoc si list)
- (int-to-string (1- i))))))
- ((eq action 'insert)
- (setq col (car columns))
- (loop for i from nmax downto col by 1 do
- (setq si (int-to-string i))
- (org-table-replace-in-formulas list si (int-to-string (1+ i)))
- (if (assoc si list) (setcar (assoc si list)
- (int-to-string (1+ i))))))
- ((eq action 'swap)
- (setq col1 (car columns) col2 (nth 1 columns)
- sc1 (int-to-string col1) sc2 (int-to-string col2))
- ;; Hopefully, ZqZ will never be a name in a table... FIXME:
- (org-table-replace-in-formulas list sc1 "ZqZ")
- (org-table-replace-in-formulas list sc2 sc1)
- (org-table-replace-in-formulas list "ZqZ" sc2)
- (if (assoc sc1 list) (setcar (assoc sc1 list) "ZqZ"))
- (if (assoc sc2 list) (setcar (assoc sc2 list) sc1))
- (if (assoc "ZqZ" list) (setcar (assoc "ZqZ" list) sc2)))
- (t (error "Invalid action in `org-table-modify-formulas'")))
- (if list (org-table-store-formulas list))))
- (defun org-table-replace-in-formulas (list s1 s2)
- (let (elt re s)
- (setq s1 (concat "$" (if (integerp s1) (int-to-string s1) s1))
- s2 (concat "$" (if (integerp s2) (int-to-string s2) s2))
- re (concat (regexp-quote s1) "\\>"))
- (while (setq elt (pop list))
- (setq s (cdr elt))
- (while (string-match re s)
- (setq s (replace-match s2 t t s)))
- (setcdr elt s))))
- (defun org-table-get-specials ()
- "Get the column names and local parameters for this table."
- (save-excursion
- (let ((beg (org-table-begin)) (end (org-table-end))
- names name fields fields1 field cnt c v line col)
- (setq org-table-column-names nil
- org-table-local-parameters nil
- org-table-named-field-locations nil)
- (goto-char beg)
- (when (re-search-forward "^[ \t]*| *! *\\(|.*\\)" end t)
- (setq names (org-split-string (match-string 1) " *| *")
- cnt 1)
- (while (setq name (pop names))
- (setq cnt (1+ cnt))
- (if (string-match "^[a-zA-Z][a-zA-Z0-9]*$" name)
- (push (cons name (int-to-string cnt)) org-table-column-names))))
- (setq org-table-column-names (nreverse org-table-column-names))
- (setq org-table-column-name-regexp
- (concat "\\$\\(" (mapconcat 'car org-table-column-names "\\|") "\\)\\>"))
- (goto-char beg)
- (while (re-search-forward "^[ \t]*| *\\$ *\\(|.*\\)" end t)
- (setq fields (org-split-string (match-string 1) " *| *"))
- (while (setq field (pop fields))
- (if (string-match "^\\([a-zA-Z][a-zA-Z0-9]*\\|%\\) *= *\\(.*\\)" field)
- (push (cons (match-string 1 field) (match-string 2 field))
- org-table-local-parameters))))
- (goto-char beg)
- (while (re-search-forward "^[ \t]*| *\\([_^]\\) *\\(|.*\\)" end t)
- (setq c (match-string 1)
- fields (org-split-string (match-string 2) " *| *"))
- (save-excursion
- (beginning-of-line (if (equal c "_") 2 0))
- (setq line (org-current-line) col 1)
- (and (looking-at "^[ \t]*|[^|]*\\(|.*\\)")
- (setq fields1 (org-split-string (match-string 1) " *| *"))))
- (while (and fields1 (setq field (pop fields)))
- (setq v (pop fields1) col (1+ col))
- (when (and (stringp field) (stringp v)
- (string-match "^[a-zA-Z][a-zA-Z0-9]*$" field))
- (push (cons field v) org-table-local-parameters)
- (push (list field line col) org-table-named-field-locations)))))))
- (defun org-this-word ()
- ;; Get the current word
- (save-excursion
- (let ((beg (progn (skip-chars-backward "^ \t\n") (point)))
- (end (progn (skip-chars-forward "^ \t\n") (point))))
- (buffer-substring-no-properties beg end))))
- (defun org-table-maybe-eval-formula ()
- "Check if the current field starts with \"=\" or \":=\".
- If yes, store the formula and apply it."
- ;; We already know we are in a table. Get field will only return a formula
- ;; when appropriate. It might return a separator line, but no problem.
- (when org-table-formula-evaluate-inline
- (let* ((field (org-trim (or (org-table-get-field) "")))
- named eq)
- (when (string-match "^:?=\\(.*\\)" field)
- (setq named (equal (string-to-char field) ?:)
- eq (match-string 1 field))
- (if (fboundp 'calc-eval)
- (org-table-eval-formula (if named '(4) nil) eq))))))
- (defvar org-recalc-commands nil
- "List of commands triggering the recalculation of a line.
- Will be filled automatically during use.")
- (defvar org-recalc-marks
- '((" " . "Unmarked: no special line, no automatic recalculation")
- ("#" . "Automatically recalculate this line upon TAB, RET, and C-c C-c in the line")
- ("*" . "Recalculate only when entire table is recalculated with `C-u C-c *'")
- ("!" . "Column name definition line. Reference in formula as $name.")
- ("$" . "Parameter definition line name=value. Reference in formula as $name.")
- ("_" . "Names for values in row below this one.")
- ("^" . "Names for values in row above this one.")))
- (defun org-table-rotate-recalc-marks (&optional newchar)
- "Rotate the recalculation mark in the first column.
- If in any row, the first field is not consistent with a mark,
- insert a new column for the markers.
- When there is an active region, change all the lines in the region,
- after prompting for the marking character.
- After each change, a message will be displayed indicating the meaning
- of the new mark."
- (interactive)
- (unless (org-at-table-p) (error "Not at a table"))
- (let* ((marks (append (mapcar 'car org-recalc-marks) '(" ")))
- (beg (org-table-begin))
- (end (org-table-end))
- (l (org-current-line))
- (l1 (if (org-region-active-p) (org-current-line (region-beginning))))
- (l2 (if (org-region-active-p) (org-current-line (region-end))))
- (have-col
- (save-excursion
- (goto-char beg)
- (not (re-search-forward "^[ \t]*|[^-|][^|]*[^#!$*_^| \t][^|]*|" end t))))
- (col (org-table-current-column))
- (forcenew (car (assoc newchar org-recalc-marks)))
- epos new)
- (when l1
- (message "Change region to what mark? Type # * ! $ or SPC: ")
- (setq newchar (char-to-string (read-char-exclusive))
- forcenew (car (assoc newchar org-recalc-marks))))
- (if (and newchar (not forcenew))
- (error "Invalid NEWCHAR `%s' in `org-table-rotate-recalc-marks'"
- newchar))
- (if l1 (goto-line l1))
- (save-excursion
- (beginning-of-line 1)
- (unless (looking-at org-table-dataline-regexp)
- (error "Not at a table data line")))
- (unless have-col
- (org-table-goto-column 1)
- (org-table-insert-column)
- (org-table-goto-column (1+ col)))
- (setq epos (point-at-eol))
- (save-excursion
- (beginning-of-line 1)
- (org-table-get-field
- 1 (if (looking-at "^[ \t]*| *\\([#!$*^_ ]\\) *|")
- (concat " "
- (setq new (or forcenew
- (cadr (member (match-string 1) marks))))
- " ")
- " # ")))
- (if (and l1 l2)
- (progn
- (goto-line l1)
- (while (progn (beginning-of-line 2) (not (= (org-current-line) l2)))
- (and (looking-at org-table-dataline-regexp)
- (org-table-get-field 1 (concat " " new " "))))
- (goto-line l1)))
- (if (not (= epos (point-at-eol))) (org-table-align))
- (goto-line l)
- (and (interactive-p) (message (cdr (assoc new org-recalc-marks))))))
- (defun org-table-maybe-recalculate-line ()
- "Recompute the current line if marked for it, and if we haven't just done it."
- (interactive)
- (and org-table-allow-automatic-line-recalculation
- (not (and (memq last-command org-recalc-commands)
- (equal org-last-recalc-line (org-current-line))))
- (save-excursion (beginning-of-line 1)
- (looking-at org-table-auto-recalculate-regexp))
- (fboundp 'calc-eval)
- (org-table-recalculate) t))
- (defvar org-table-formula-debug nil
- "Non-nil means, debug table formulas.
- When nil, simply write \"#ERROR\" in corrupted fields.")
- (defvar modes)
- (defsubst org-set-calc-mode (var &optional value)
- (if (stringp var)
- (setq var (assoc var '(("D" calc-angle-mode deg)
- ("R" calc-angle-mode rad)
- ("F" calc-prefer-frac t)
- ("S" calc-symbolic-mode t)))
- value (nth 2 var) var (nth 1 var)))
- (if (memq var modes)
- (setcar (cdr (memq var modes)) value)
- (cons var (cons value modes)))
- modes)
- (defun org-table-eval-formula (&optional arg equation
- suppress-align suppress-const
- suppress-store)
- "Replace the table field value at the cursor by the result of a calculation.
- This function makes use of Dave Gillespie's Calc package, in my view the
- most exciting program ever written for GNU Emacs. So you need to have Calc
- installed in order to use this function.
- In a table, this command replaces the value in the current field with the
- result of a formula. It also installs the formula as the \"current\" column
- formula, by storing it in a special line below the table. When called
- with a `C-u' prefix, the current field must ba a named field, and the
- formula is installed as valid in only this specific field.
- When called, the command first prompts for a formula, which is read in
- the minibuffer. Previously entered formulas are available through the
- history list, and the last used formula is offered as a default.
- These stored formulas are adapted correctly when moving, inserting, or
- deleting columns with the corresponding commands.
- The formula can be any algebraic expression understood by the Calc package.
- For details, see the Org-mode manual.
- This function can also be called from Lisp programs and offers
- additional arguments: EQUATION can be the formula to apply. If this
- argument is given, the user will not be prompted. SUPPRESS-ALIGN is
- used to speed-up recursive calls by by-passing unnecessary aligns.
- SUPPRESS-CONST suppresses the interpretation of constants in the
- formula, assuming that this has been done already outside the function.
- SUPPRESS-STORE means the formula should not be stored, either because
- it is already stored, or because it is a modified equation that should
- not overwrite the stored one."
- (interactive "P")
- (require 'calc)
- (org-table-check-inside-data-field)
- (org-table-get-specials)
- (let* (fields
- (ndown (if (integerp arg) arg 1))
- (org-table-automatic-realign nil)
- (case-fold-search nil)
- (down (> ndown 1))
- (formula (if (and equation suppress-store)
- equation
- (org-table-get-formula equation (equal arg '(4)))))
- (n0 (org-table-current-column))
- (modes (copy-sequence org-calc-default-modes))
- n form fmt x ev orig c)
- ;; Parse the format string. Since we have a lot of modes, this is
- ;; a lot of work. However, I think calc still uses most of the time.
- (if (string-match ";" formula)
- (let ((tmp (org-split-string formula ";")))
- (setq formula (car tmp)
- fmt (concat (cdr (assoc "%" org-table-local-parameters))
- (nth 1 tmp)))
- (while (string-match "[pnfse]\\(-?[0-9]+\\)" fmt)
- (setq c (string-to-char (match-string 1 fmt))
- n (string-to-number (or (match-string 1 fmt) "")))
- (if (= c ?p) (setq modes (org-set-calc-mode 'calc-internal-prec n))
- (setq modes (org-set-calc-mode
- 'calc-float-format
- (list (cdr (assoc c '((?n . float) (?f . fix)
- (?s . sci) (?e . eng))))
- n))))
- (setq fmt (replace-match "" t t fmt)))
- (while (string-match "[DRFS]" fmt)
- (setq modes (org-set-calc-mode (match-string 0 fmt)))
- (setq fmt (replace-match "" t t fmt)))
- (unless (string-match "\\S-" fmt)
- (setq fmt nil))))
- (if (and (not suppress-const) org-table-formula-use-constants)
- (setq formula (org-table-formula-substitute-names formula)))
- (setq orig (or (get-text-property 1 :orig-formula formula) "?"))
- (while (> ndown 0)
- (setq fields (org-split-string
- (buffer-substring
- (point-at-bol) (point-at-eol)) " *| *"))
- (if org-table-formula-numbers-only
- (setq fields (mapcar
- (lambda (x) (number-to-string (string-to-number x)))
- fields)))
- (setq ndown (1- ndown))
- (setq form (copy-sequence formula))
- ;; Insert the references to fields in same row
- (while (string-match "\\$\\([0-9]+\\)?" form)
- (setq n (if (match-beginning 1)
- (string-to-number (match-string 1 form))
- n0)
- x (nth (1- n) fields))
- (unless x (error "Invalid field specifier \"%s\""
- (match-string 0 form)))
- (if (equal x "") (setq x "0"))
- (setq form (replace-match (concat "(" x ")") t t form)))
- ;; Insert ranges in current column
- (while (string-match "\\&[-I0-9]+" form)
- (setq form (replace-match
- (save-match-data
- (org-table-get-vertical-vector (match-string 0 form)
- nil n0))
- t t form)))
- (setq ev (calc-eval (cons form modes)
- (if org-table-formula-numbers-only 'num)))
- (when org-table-formula-debug
- (with-output-to-temp-buffer "*Help*"
- (princ (format "Substitution history of formula
- Orig: %s
- $xyz-> %s
- $1-> %s\n" orig formula form))
- (if (listp ev)
- (princ (format " %s^\nError: %s"
- (make-string (car ev) ?\-) (nth 1 ev)))
- (princ (format "Result: %s\nFormat: %s\nFinal: %s"
- ev (or fmt "NONE")
- (if fmt (format fmt (string-to-number ev)) ev)))))
- (shrink-window-if-larger-than-buffer (get-buffer-window "*Help*"))
- (unless (and (interactive-p) (not ndown))
- (unless (let (inhibit-redisplay)
- (y-or-n-p "Debugging Formula. Continue to next? "))
- (org-table-align)
- (error "Abort"))
- (delete-window (get-buffer-window "*Help*"))
- (message "")))
- (if (listp ev) (setq fmt nil ev "#ERROR"))
- (org-table-justify-field-maybe
- (if fmt (format fmt (string-to-number ev)) ev))
- (if (and down (> ndown 0) (looking-at ".*\n[ \t]*|[^-]"))
- (call-interactively 'org-return)
- (setq ndown 0)))
- (and down (org-table-maybe-recalculate-line))
- (or suppress-align (and org-table-may-need-update
- (org-table-align)))))
- (defun org-table-recalculate (&optional all noalign)
- "Recalculate the current table line by applying all stored formulas."
- (interactive "P")
- (or (memq this-command org-recalc-commands)
- (setq org-recalc-commands (cons this-command org-recalc-commands)))
- (unless (org-at-table-p) (error "Not at a table"))
- (org-table-get-specials)
- (let* ((eqlist (sort (org-table-get-stored-formulas)
- (lambda (a b) (string< (car a) (car b)))))
- (inhibit-redisplay t)
- (line-re org-table-dataline-regexp)
- (thisline (+ (if (bolp) 1 0) (count-lines (point-min) (point))))
- (thiscol (org-table-current-column))
- beg end entry eqlnum eqlname eql (cnt 0) eq a name)
- ;; Insert constants in all formulas
- (setq eqlist
- (mapcar (lambda (x)
- (setcdr x (org-table-formula-substitute-names (cdr x)))
- x)
- eqlist))
- ;; Split the equation list
- (while (setq eq (pop eqlist))
- (if (<= (string-to-char (car eq)) ?9)
- (push eq eqlnum)
- (push eq eqlname)))
- (setq eqlnum (nreverse eqlnum) eqlname (nreverse eqlname))
- (if all
- (progn
- (setq end (move-marker (make-marker) (1+ (org-table-end))))
- (goto-char (setq beg (org-table-begin)))
- (if (re-search-forward org-table-calculate-mark-regexp end t)
- ;; This is a table with marked lines, only compute selected lines
- (setq line-re org-table-recalculate-regexp)
- ;; Move forward to the first non-header line
- (if (and (re-search-forward org-table-dataline-regexp end t)
- (re-search-forward org-table-hline-regexp end t)
- (re-search-forward org-table-dataline-regexp end t))
- (setq beg (match-beginning 0))
- nil))) ;; just leave beg where it is
- (setq beg (point-at-bol)
- end (move-marker (make-marker) (1+ (point-at-eol)))))
- (goto-char beg)
- (and all (message "Re-applying formulas to full table..."))
- (while (re-search-forward line-re end t)
- (unless (string-match "^ *[_^!$] *$" (org-table-get-field 1))
- ;; Unprotected line, recalculate
- (and all (message "Re-applying formulas to full table...(line %d)"
- (setq cnt (1+ cnt))))
- (setq org-last-recalc-line (org-current-line))
- (setq eql eqlnum)
- (while (setq entry (pop eql))
- (goto-line org-last-recalc-line)
- (org-table-goto-column (string-to-number (car entry)) nil 'force)
- (org-table-eval-formula nil (cdr entry) 'noalign 'nocst 'nostore))))
- (goto-line thisline)
- (org-table-goto-column thiscol)
- (or noalign (and org-table-may-need-update (org-table-align))
- (and all (message "Re-applying formulas to %d lines...done" cnt)))
- ;; Now do the names fields
- (while (setq eq (pop eqlname))
- (setq name (car eq)
- a (assoc name org-table-named-field-locations))
- (when a
- (message "Re-applying formula to named field: %s" name)
- (goto-line (nth 1 a))
- (org-table-goto-column (nth 2 a))
- (org-table-eval-formula nil (cdr eq) 'noalign 'nocst 'nostore)))
- ;; back to initial position
- (goto-line thisline)
- (org-table-goto-column thiscol)
- (or noalign (and org-table-may-need-update (org-table-align))
- (and all (message "Re-applying formulas...done")))))
- (defun org-table-formula-substitute-names (f)
- "Replace $const with values in string F."
- (let ((start 0) a n1 n2 nn1 nn2 s (f1 f))
- ;; First, check for column names
- (while (setq start (string-match org-table-column-name-regexp f start))
- (setq start (1+ start))
- (setq a (assoc (match-string 1 f) org-table-column-names))
- (setq f (replace-match (concat "$" (cdr a)) t t f)))
- ;; Expand ranges to vectors
- (while (string-match "\\$\\([0-9]+\\)\\.\\.\\.?\\$\\([0-9]+\\)" f)
- (setq n1 (string-to-number (match-string 1 f))
- n2 (string-to-number (match-string 2 f))
- nn1 (1+ (min n1 n2)) nn2 (max n1 n2)
- s (concat "[($" (number-to-string (1- nn1)) ")"))
- (loop for i from nn1 upto nn2 do
- (setq s (concat s ",($" (int-to-string i) ")")))
- (setq s (concat s "]"))
- (if (< n2 n1) (setq s (concat "rev(" s ")")))
- (setq f (replace-match s t t f)))
- ;; Parameters and constants
- (setq start 0)
- (while (setq start (string-match "\\$\\([a-zA-Z][a-zA-Z0-9]*\\)" f start))
- (setq start (1+ start))
- (if (setq a (save-match-data
- (org-table-get-constant (match-string 1 f))))
- (setq f (replace-match (concat "(" a ")") t t f))))
- (if org-table-formula-debug
- (put-text-property 0 (length f) :orig-formula f1 f))
- f))
- (defun org-table-get-constant (const)
- "Find the value for a parameter or constant in a formula.
- Parameters get priority."
- (or (cdr (assoc const org-table-local-parameters))
- (cdr (assoc const org-table-formula-constants))
- (and (fboundp 'constants-get) (constants-get const))
- "#UNDEFINED_NAME"))
- (defvar org-edit-formulas-map (make-sparse-keymap))
- (define-key org-edit-formulas-map "\C-c\C-c" 'org-finish-edit-formulas)
- (define-key org-edit-formulas-map "\C-c\C-q" 'org-abort-edit-formulas)
- (define-key org-edit-formulas-map "\C-c?" 'org-show-variable)
- (defvar org-pos)
- (defun org-table-edit-formulas ()
- "Edit the formulas of the current table in a separate buffer."
- (interactive)
- (unless (org-at-table-p)
- (error "Not at a table"))
- (org-table-get-specials)
- (let ((eql (org-table-get-stored-formulas))
- (pos (move-marker (make-marker) (point)))
- (wc (current-window-configuration))
- entry loc s)
- (switch-to-buffer-other-window "*Edit Formulas*")
- (erase-buffer)
- (fundamental-mode)
- (set (make-local-variable 'org-pos) pos)
- (set (make-local-variable 'org-window-configuration) wc)
- (use-local-map org-edit-formulas-map)
- (setq s "# Edit formulas and finish with `C-c C-c'.
- # Use `C-u C-c C-c' to also appy them immediately to the entire table.
- # Use `C-c ?' to get information about $name at point.
- # To cancel editing, press `C-c C-q'.\n")
- (put-text-property 0 (length s) 'face 'font-lock-comment-face s)
- (insert s)
- (while (setq entry (pop eql))
- (when (setq loc (assoc (car entry) org-table-named-field-locations))
- (setq s (format "# Named formula, referring to column %d in line %d\n"
- (nth 2 loc) (nth 1 loc)))
- (put-text-property 0 (length s) 'face 'font-lock-comment-face s)
- (insert s))
- (setq s (concat "$" (car entry) "=" (cdr entry) "\n"))
- (remove-text-properties 0 (length s) '(face nil) s)
- (insert s))
- (goto-char (point-min))
- (message "Edit formulas and finish with `C-c C-c'.")))
- (defun org-show-variable ()
- "Show the location/value of the $ expression at point."
- (interactive)
- (let (var (pos org-pos) (win (selected-window)) e)
- (save-excursion
- (or (looking-at "\\$") (skip-chars-backward "$a-zA-Z0-9"))
- (if (looking-at "\\$\\([a-zA-Z0-9]+\\)")
- (setq var (match-string 1))
- (error "No variable at point")))
- (cond
- ((setq e (assoc var org-table-named-field-locations))
- (switch-to-buffer-other-window (marker-buffer pos))
- (goto-line (nth 1 e))
- (org-table-goto-column (nth 2 e))
- (select-window win)
- (message "Named field, column %d of line %d" (nth 2 e) (nth 1 e)))
- ((setq e (assoc var org-table-column-names))
- (switch-to-buffer-other-window (marker-buffer pos))
- (goto-char pos)
- (goto-char (org-table-begin))
- (if (re-search-forward (concat "^[ \t]*| *! *.*?| *\\(" var "\\) *|")
- (org-table-end) t)
- (progn
- (goto-char (match-beginning 1))
- (message "Named column (column %s)" (cdr e)))
- (error "Column name not found"))
- (select-window win))
- ((string-match "^[0-9]$" var)
- ;; column number
- (switch-to-buffer-other-window (marker-buffer pos))
- (goto-char pos)
- (goto-char (org-table-begin))
- (recenter 1)
- (if (re-search-forward org-table-dataline-regexp
- (org-table-end) t)
- (progn
- (goto-char (match-beginning 0))
- (org-table-goto-column (string-to-number var))
- (message "Column %s" var))
- (error "Column name not found"))
- (select-window win))
- ((setq e (assoc var org-table-local-parameters))
- (switch-to-buffer-other-window (marker-buffer pos))
- (goto-char pos)
- (goto-char (org-table-begin))
- (if (re-search-forward (concat "^[ \t]*| *\\$ *.*?| *\\(" var "=\\)") nil t)
- (progn
- (goto-char (match-beginning 1))
- (message "Local parameter."))
- (error "Parameter not found"))
- (select-window win))
- (t
- (cond
- ((setq e (assoc var org-table-formula-constants))
- (message "Constant: $%s=%s in `org-table-formula-constants'." var (cdr e)))
- ((setq e (and (fboundp 'constants-get) (constants-get var)))
- (message "Constant: $%s=%s, retrieved from `constants.el'." var e))
- (t (error "Undefined name $%s" var)))))))
- (defun org-finish-edit-formulas (&optional arg)
- "Parse the buffer for formula definitions and install them.
- With prefix ARG, apply the new formulas to the table."
- (interactive "P")
- (let ((pos org-pos) eql)
- (goto-char (point-min))
- (while (re-search-forward "^\\$\\([a-zA-Z0-9]+\\) *= *\\(.*?\\) *$" nil t)
- (push (cons (match-string 1) (match-string 2)) eql))
- (set-window-configuration org-window-configuration)
- (select-window (get-buffer-window (marker-buffer pos)))
- (goto-char pos)
- (unless (org-at-table-p)
- (error "Lost table position - cannot install formulae"))
- (org-table-store-formulas eql)
- (move-marker pos nil)
- (kill-buffer "*Edit Formulas*")
- (if arg
- (org-table-recalculate 'all)
- (message "New formulas installed - press C-u C-c C-c to apply."))))
- (defun org-abort-edit-formulas ()
- "Abort editing formulas, without installing the changes."
- (interactive)
- (let ((pos org-pos))
- (set-window-configuration org-window-configuration)
- (select-window (get-buffer-window (marker-buffer pos)))
- (goto-char pos)
- (message "Formula editing aborted without installing changes")))
- ;;; The orgtbl minor mode
- ;; Define a minor mode which can be used in other modes in order to
- ;; integrate the org-mode table editor.
- ;; This is really a hack, because the org-mode table editor uses several
- ;; keys which normally belong to the major mode, for example the TAB and
- ;; RET keys. Here is how it works: The minor mode defines all the keys
- ;; necessary to operate the table editor, but wraps the commands into a
- ;; function which tests if the cursor is currently inside a table. If that
- ;; is the case, the table editor command is executed. However, when any of
- ;; those keys is used outside a table, the function uses `key-binding' to
- ;; look up if the key has an associated command in another currently active
- ;; keymap (minor modes, major mode, global), and executes that command.
- ;; There might be problems if any of the keys used by the table editor is
- ;; otherwise used as a prefix key.
- ;; Another challenge is that the key binding for TAB can be tab or \C-i,
- ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
- ;; addresses this by checking explicitly for both bindings.
- ;; The optimized version (see variable `orgtbl-optimized') takes over
- ;; all keys which are bound to `self-insert-command' in the *global map*.
- ;; Some modes bind other commands to simple characters, for example
- ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
- ;; active, this binding is ignored inside tables and replaced with a
- ;; modified self-insert.
- (defcustom orgtbl-optimized (eq org-enable-table-editor 'optimized)
- "Non-nil means, use the optimized table editor version for `orgtbl-mode'.
- In the optimized version, the table editor takes over all simple keys that
- normally just insert a character. In tables, the characters are inserted
- in a way to minimize disturbing the table structure (i.e. in overwrite mode
- for empty fields). Outside tables, the correct binding of the keys is
- restored.
- The default for this option is t if the optimized version is also used in
- Org-mode. See the variable `org-enable-table-editor' for details. Changing
- this variable requires a restart of Emacs to become effective."
- :group 'org-table
- :type 'boolean)
- (defvar orgtbl-mode nil
- "Variable controlling `orgtbl-mode', a minor mode enabling the `org-mode'
- table editor in arbitrary modes.")
- (make-variable-buffer-local 'orgtbl-mode)
- (defvar orgtbl-mode-map (make-keymap)
- "Keymap for `orgtbl-mode'.")
- ;;;###autoload
- (defun turn-on-orgtbl ()
- "Unconditionally turn on `orgtbl-mode'."
- (orgtbl-mode 1))
- ;;;###autoload
- (defun orgtbl-mode (&optional arg)
- "The `org-mode' table editor as a minor mode for use in other modes."
- (interactive)
- (if (eq major-mode 'org-mode)
- ;; Exit without error, in case some hook functions calls this
- ;; by accident in org-mode.
- (message "Orgtbl-mode is not useful in org-mode, command ignored")
- (setq orgtbl-mode
- (if arg (> (prefix-numeric-value arg) 0) (not orgtbl-mode)))
- (if orgtbl-mode
- (progn
- (and (orgtbl-setup) (defun orgtbl-setup () nil))
- ;; Make sure we are first in minor-mode-map-alist
- (let ((c (assq 'orgtbl-mode minor-mode-map-alist)))
- (and c (setq minor-mode-map-alist
- (cons c (delq c minor-mode-map-alist)))))
- (set (make-local-variable (quote org-table-may-need-update)) t)
- (org-add-hook 'before-change-functions 'org-before-change-function
- nil 'local)
- (set (make-local-variable 'org-old-auto-fill-inhibit-regexp)
- auto-fill-inhibit-regexp)
- (set (make-local-variable 'auto-fill-inhibit-regexp)
- (if auto-fill-inhibit-regexp
- (concat "\\([ \t]*|\\|" auto-fill-inhibit-regexp)
- "[ \t]*|"))
- (easy-menu-add orgtbl-mode-menu)
- (run-hooks 'orgtbl-mode-hook))
- (setq auto-fill-inhibit-regexp org-old-auto-fill-inhibit-regexp)
- (remove-hook 'before-change-functions 'org-before-change-function t)
- (easy-menu-remove orgtbl-mode-menu)
- (force-mode-line-update 'all))))
- ;; Install it as a minor mode.
- (put 'orgtbl-mode :included t)
- (put 'orgtbl-mode :menu-tag "Org Table Mode")
- (add-minor-mode 'orgtbl-mode " OrgTbl" orgtbl-mode-map)
- (defun orgtbl-make-binding (fun n &rest keys)
- "Create a function for binding in the table minor mode.
- FUN is the command to call inside a table. N is used to create a unique
- command name. KEYS are keys that should be checked in for a command
- to execute outside of tables."
- (eval
- (list 'defun
- (intern (concat "orgtbl-hijacker-command-" (int-to-string n)))
- '(arg)
- (concat "In tables, run `" (symbol-name fun) "'.\n"
- "Outside of tables, run the binding of `"
- (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
- "'.")
- '(interactive "p")
- (list 'if
- '(org-at-table-p)
- (list 'call-interactively (list 'quote fun))
- (list 'let '(orgtbl-mode)
- (list 'call-interactively
- (append '(or)
- (mapcar (lambda (k)
- (list 'key-binding k))
- keys)
- '('orgtbl-error))))))))
- (defun orgtbl-error ()
- "Error when there is no default binding for a table key."
- (interactive)
- (error "This key is has no function outside tables"))
- (defun orgtbl-setup ()
- "Setup orgtbl keymaps."
- (let ((nfunc 0)
- (bindings
- (list
- '([(meta shift left)] org-table-delete-column)
- '([(meta left)] org-table-move-column-left)
- '([(meta right)] org-table-move-column-right)
- '([(meta shift right)] org-table-insert-column)
- '([(meta shift up)] org-table-kill-row)
- '([(meta shift down)] org-table-insert-row)
- '([(meta up)] org-table-move-row-up)
- '([(meta down)] org-table-move-row-down)
- '("\C-c\C-w" org-table-cut-region)
- '("\C-c\M-w" org-table-copy-region)
- '("\C-c\C-y" org-table-paste-rectangle)
- '("\C-c-" org-table-insert-hline)
- ; '([(shift tab)] org-table-previous-field)
- '("\C-m" org-table-next-row)
- (list (org-key 'S-return) 'org-table-copy-down)
- '([(meta return)] org-table-wrap-region)
- '("\C-c\C-q" org-table-wrap-region)
- '("\C-c?" org-table-current-column)
- '("\C-c " org-table-blank-field)
- '("\C-c+" org-table-sum)
- '("\C-c|" org-table-toggle-vline-visibility)
- '("\C-c=" org-table-eval-formula)
- '("\C-c'" org-table-edit-formulas)
- '("\C-c*" org-table-recalculate)
- '("\C-c^" org-table-sort-lines)
- '([(control ?#)] org-table-rotate-recalc-marks)))
- elt key fun cmd)
- (while (setq elt (pop bindings))
- (setq nfunc (1+ nfunc))
- (setq key (car elt)
- fun (nth 1 elt)
- cmd (orgtbl-make-binding fun nfunc key))
- (define-key orgtbl-mode-map key cmd))
- ;; Special treatment needed for TAB and RET
- (define-key orgtbl-mode-map [(return)]
- (orgtbl-make-binding 'orgtbl-ret 100 [(return)] "\C-m"))
- (define-key orgtbl-mode-map "\C-m"
- (orgtbl-make-binding 'orgtbl-ret 101 "\C-m" [(return)]))
- (define-key orgtbl-mode-map [(tab)]
- (orgtbl-make-binding 'orgtbl-tab 102 [(tab)] "\C-i"))
- (define-key orgtbl-mode-map "\C-i"
- (orgtbl-make-binding 'orgtbl-tab 103 "\C-i" [(tab)])))
- (define-key orgtbl-mode-map "\C-i"
- (orgtbl-make-binding 'orgtbl-tab 104 [(shift tab)]))
- (define-key orgtbl-mode-map "\C-c\C-c"
- (orgtbl-make-binding 'org-ctrl-c-ctrl-c 105 "\C-c\C-c"))
- (when orgtbl-optimized
- ;; If the user wants maximum table support, we need to hijack
- ;; some standard editing functions
- (org-remap orgtbl-mode-map
- 'self-insert-command 'orgtbl-self-insert-command
- 'delete-char 'orgtbl-delete-char
- 'delete-backward-char 'orgtbl-delete-backward-char)
- (define-key orgtbl-mode-map "|" 'org-force-self-insert))
- (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
- '("OrgTbl"
- ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
- ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
- ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
- ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
- "--"
- ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
- ["Copy Field from Above"
- org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
- "--"
- ("Column"
- ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
- ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
- ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
- ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
- ("Row"
- ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
- ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
- ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
- ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
- ["Sort lines in region" org-table-sort-lines (org-at-table-p) :keys "C-c ^"]
- "--"
- ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
- ("Rectangle"
- ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
- ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
- ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
- ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
- "--"
- ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
- ["Set Named Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
- ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
- ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
- ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
- ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
- ["Sum Column/Rectangle" org-table-sum
- :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
- ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
- ["Debug Formulas"
- (setq org-table-formula-debug (not org-table-formula-debug))
- :style toggle :selected org-table-formula-debug]
- ))
- t)
- (defun orgtbl-tab ()
- "Justification and field motion for `orgtbl-mode'."
- (interactive)
- (org-table-justify-field-maybe)
- (org-table-next-field))
- (defun orgtbl-ret ()
- "Justification and field motion for `orgtbl-mode'."
- (interactive)
- (org-table-justify-field-maybe)
- (org-table-next-row))
- (defun orgtbl-self-insert-command (N)
- "Like `self-insert-command', use overwrite-mode for whitespace in tables.
- If the cursor is in a table looking at whitespace, the whitespace is
- overwritten, and the table is not marked as requiring realignment."
- (interactive "p")
- (if (and (org-at-table-p)
- (or
- (and org-table-auto-blank-field
- (member last-command
- '(orgtbl-hijacker-command-100
- orgtbl-hijacker-command-101
- orgtbl-hijacker-command-102
- orgtbl-hijacker-command-103
- orgtbl-hijacker-command-104
- orgtbl-hijacker-command-105))
- (org-table-blank-field))
- t)
- (eq N 1)
- (looking-at "[^|\n]* +|"))
- (let (org-table-may-need-update)
- (goto-char (1- (match-end 0)))
- (delete-backward-char 1)
- (goto-char (match-beginning 0))
- (self-insert-command N))
- (setq org-table-may-need-update t)
- (let (orgtbl-mode)
- (call-interactively (key-binding (vector last-input-event))))))
- (defun org-force-self-insert (N)
- "Needed to enforce self-insert under remapping."
- (interactive "p")
- (self-insert-command N))
- (defun orgtbl-delete-backward-char (N)
- "Like `delete-backward-char', insert whitespace at field end in tables.
- When deleting backwards, in tables this function will insert whitespace in
- front of the next \"|\" separator, to keep the table aligned. The table will
- still be marked for re-alignment, because a narrow field may lead to a
- reduced column width."
- (interactive "p")
- (if (and (org-at-table-p)
- (eq N 1)
- (string-match "|" (buffer-substring (point-at-bol) (point)))
- (looking-at ".*?|"))
- (let ((pos (point)))
- (backward-delete-char N)
- (skip-chars-forward "^|")
- (insert " ")
- (goto-char (1- pos)))
- (delete-backward-char N)))
- (defun orgtbl-delete-char (N)
- "Like `delete-char', but insert whitespace at field end in tables.
- When deleting characters, in tables this function will insert whitespace in
- front of the next \"|\" separator, to keep the table aligned. The table
- will still be marked for re-alignment, because a narrow field may lead to
- a reduced column width."
- (interactive "p")
- (if (and (org-at-table-p)
- (not (bolp))
- (not (= (char-after) ?|))
- (eq N 1))
- (if (looking-at ".*?|")
- (let ((pos (point)))
- (replace-match (concat
- (substring (match-string 0) 1 -1)
- " |"))
- (goto-char pos)))
- (delete-char N)))
- ;;; Exporting
- (defconst org-level-max 20)
- (defun org-export-find-first-heading-line (list)
- "Remove all lines from LIST which are before the first headline."
- (let ((orig-list list)
- (re (concat "^" outline-regexp)))
- (while (and list
- (not (string-match re (car list))))
- (pop list))
- (or list orig-list)))
- (defun org-skip-comments (lines)
- "Skip lines starting with \"#\" and subtrees starting with COMMENT."
- (let ((re1 (concat "^\\(\\*+\\)[ \t]+" org-comment-string))
- (re2 "^\\(\\*+\\)[ \t\n\r]")
- rtn line level)
- (while (setq line (pop lines))
- (cond
- ((and (string-match re1 line)
- (setq level (- (match-end 1) (match-beginning 1))))
- ;; Beginning of a COMMENT subtree. Skip it.
- (while (and (setq line (pop lines))
- (or (not (string-match re2 line))
- (> (- (match-end 1) (match-beginning 1)) level))))
- (setq lines (cons line lines)))
- ((string-match "^#" line)
- ;; an ordinary comment line
- )
- ((and org-export-table-remove-special-lines
- (string-match "^[ \t]*| *[!_^] *|" line))
- ;; a special table line that should be removed
- )
- (t (setq rtn (cons line rtn)))))
- (nreverse rtn)))
- ;; ASCII
- (defconst org-ascii-underline '(?\$ ?\# ?^ ?\~ ?\= ?\-)
- "Characters for underlining headings in ASCII export.")
- (defconst org-html-entities
- '(("nbsp")
- ("iexcl")
- ("cent")
- ("pound")
- ("curren")
- ("yen")
- ("brvbar")
- ("sect")
- ("uml")
- ("copy")
- ("ordf")
- ("laquo")
- ("not")
- ("shy")
- ("reg")
- ("macr")
- ("deg")
- ("plusmn")
- ("sup2")
- ("sup3")
- ("acute")
- ("micro")
- ("para")
- ("middot")
- ("odot"."o")
- ("star"."*")
- ("cedil")
- ("sup1")
- ("ordm")
- ("raquo")
- ("frac14")
- ("frac12")
- ("frac34")
- ("iquest")
- ("Agrave")
- ("Aacute")
- ("Acirc")
- ("Atilde")
- ("Auml")
- ("Aring") ("AA"."Å")
- ("AElig")
- ("Ccedil")
- ("Egrave")
- ("Eacute")
- ("Ecirc")
- ("Euml")
- ("Igrave")
- ("Iacute")
- ("Icirc")
- ("Iuml")
- ("ETH")
- ("Ntilde")
- ("Ograve")
- ("Oacute")
- ("Ocirc")
- ("Otilde")
- ("Ouml")
- ("times")
- ("Oslash")
- ("Ugrave")
- ("Uacute")
- ("Ucirc")
- ("Uuml")
- ("Yacute")
- ("THORN")
- ("szlig")
- ("agrave")
- ("aacute")
- ("acirc")
- ("atilde")
- ("auml")
- ("aring")
- ("aelig")
- ("ccedil")
- ("egrave")
- ("eacute")
- ("ecirc")
- ("euml")
- ("igrave")
- ("iacute")
- ("icirc")
- ("iuml")
- ("eth")
- ("ntilde")
- ("ograve")
- ("oacute")
- ("ocirc")
- ("otilde")
- ("ouml")
- ("divide")
- ("oslash")
- ("ugrave")
- ("uacute")
- ("ucirc")
- ("uuml")
- ("yacute")
- ("thorn")
- ("yuml")
- ("fnof")
- ("Alpha")
- ("Beta")
- ("Gamma")
- ("Delta")
- ("Epsilon")
- ("Zeta")
- ("Eta")
- ("Theta")
- ("Iota")
- ("Kappa")
- ("Lambda")
- ("Mu")
- ("Nu")
- ("Xi")
- ("Omicron")
- ("Pi")
- ("Rho")
- ("Sigma")
- ("Tau")
- ("Upsilon")
- ("Phi")
- ("Chi")
- ("Psi")
- ("Omega")
- ("alpha")
- ("beta")
- ("gamma")
- ("delta")
- ("epsilon")
- ("varepsilon"."ε")
- ("zeta")
- ("eta")
- ("theta")
- ("iota")
- ("kappa")
- ("lambda")
- ("mu")
- ("nu")
- ("xi")
- ("omicron")
- ("pi")
- ("rho")
- ("sigmaf") ("varsigma"."ς")
- ("sigma")
- ("tau")
- ("upsilon")
- ("phi")
- ("chi")
- ("psi")
- ("omega")
- ("thetasym") ("vartheta"."ϑ")
- ("upsih")
- ("piv")
- ("bull") ("bullet"."•")
- ("hellip") ("dots"."…")
- ("prime")
- ("Prime")
- ("oline")
- ("frasl")
- ("weierp")
- ("image")
- ("real")
- ("trade")
- ("alefsym")
- ("larr") ("leftarrow"."←") ("gets"."←")
- ("uarr") ("uparrow"."↑")
- ("rarr") ("to"."→") ("rightarrow"."→")
- ("darr")("downarrow"."↓")
- ("harr") ("leftrightarrow"."↔")
- ("crarr") ("hookleftarrow"."↵") ; has round hook, not quite CR
- ("lArr") ("Leftarrow"."⇐")
- ("uArr") ("Uparrow"."⇑")
- ("rArr") ("Rightarrow"."⇒")
- ("dArr") ("Downarrow"."⇓")
- ("hArr") ("Leftrightarrow"."⇔")
- ("forall")
- ("part") ("partial"."∂")
- ("exist") ("exists"."∃")
- ("empty") ("emptyset"."∅")
- ("nabla")
- ("isin") ("in"."∈")
- ("notin")
- ("ni")
- ("prod")
- ("sum")
- ("minus")
- ("lowast") ("ast"."∗")
- ("radic")
- ("prop") ("proptp"."∝")
- ("infin") ("infty"."∞")
- ("ang") ("angle"."∠")
- ("and") ("vee"."∧")
- ("or") ("wedge"."∨")
- ("cap")
- ("cup")
- ("int")
- ("there4")
- ("sim")
- ("cong") ("simeq"."≅")
- ("asymp")("approx"."≈")
- ("ne") ("neq"."≠")
- ("equiv")
- ("le")
- ("ge")
- ("sub") ("subset"."⊂")
- ("sup") ("supset"."⊃")
- ("nsub")
- ("sube")
- ("supe")
- ("oplus")
- ("otimes")
- ("perp")
- ("sdot") ("cdot"."⋅")
- ("lceil")
- ("rceil")
- ("lfloor")
- ("rfloor")
- ("lang")
- ("rang")
- ("loz") ("Diamond"."◊")
- ("spades") ("spadesuit"."♠")
- ("clubs") ("clubsuit"."♣")
- ("hearts") ("diamondsuit"."♥")
- ("diams") ("diamondsuit"."♦")
- ("quot")
- ("amp")
- ("lt")
- ("gt")
- ("OElig")
- ("oelig")
- ("Scaron")
- ("scaron")
- ("Yuml")
- ("circ")
- ("tilde")
- ("ensp")
- ("emsp")
- ("thinsp")
- ("zwnj")
- ("zwj")
- ("lrm")
- ("rlm")
- ("ndash")
- ("mdash")
- ("lsquo")
- ("rsquo")
- ("sbquo")
- ("ldquo")
- ("rdquo")
- ("bdquo")
- ("dagger")
- ("Dagger")
- ("permil")
- ("lsaquo")
- ("rsaquo")
- ("euro")
- ("arccos"."arccos")
- ("arcsin"."arcsin")
- ("arctan"."arctan")
- ("arg"."arg")
- ("cos"."cos")
- ("cosh"."cosh")
- ("cot"."cot")
- ("coth"."coth")
- ("csc"."csc")
- ("deg"."deg")
- ("det"."det")
- ("dim"."dim")
- ("exp"."exp")
- ("gcd"."gcd")
- ("hom"."hom")
- ("inf"."inf")
- ("ker"."ker")
- ("lg"."lg")
- ("lim"."lim")
- ("liminf"."liminf")
- ("limsup"."limsup")
- ("ln"."ln")
- ("log"."log")
- ("max"."max")
- ("min"."min")
- ("Pr"."Pr")
- ("sec"."sec")
- ("sin"."sin")
- ("sinh"."sinh")
- ("sup"."sup")
- ("tan"."tan")
- ("tanh"."tanh")
- )
- "Entities for TeX->HTML translation.
- Entries can be like (\"ent\"), in which case \"\\ent\" will be translated to
- \"&ent;\". An entry can also be a dotted pair like (\"ent\".\"&other;\").
- In that case, \"\\ent\" will be translated to \"&other;\".
- The list contains HTML entities for Latin-1, Greek and other symbols.
- It is supplemented by a number of commonly used TeX macros with appropriate
- translations. There is currently no way for users to extend this.")
- (defun org-cleaned-string-for-export (string)
- "Cleanup a buffer substring so that links can be created safely."
- (interactive)
- (let* ((cb (current-buffer))
- (re-radio (and org-target-link-regexp
- (concat "\\([^<]\\)\\(" org-target-link-regexp "\\)")))
- rtn)
- (save-excursion
- (set-buffer (get-buffer-create " org-mode-tmp"))
- (erase-buffer)
- (insert string)
- (org-mode)
- ;; Find targets in comments and move them out of comments,
- ;; but mark them as targets that should be invisible
- (goto-char (point-min))
- (while (re-search-forward "^#.*?\\(<<<?[^>\r\n]+>>>?\\).*" nil t)
- (replace-match "\\1(INVISIBLE)"))
- ;; Find matches for radio targets and turn them into links
- (goto-char (point-min))
- (when re-radio
- (while (re-search-forward re-radio nil t)
- (replace-match "\\1[[\\2]]")))
- ;; Find all links that contain a newline and put them into a single line
- (goto-char (point-min))
- (while (re-search-forward "\\(\\[\\[[^]]*?\\)[ \t]*\n[ \t]*\\([^]]*\\]\\]\\)" nil t)
- (replace-match "\\1 \\2")
- (goto-char (match-beginning 0)))
- ;; Remove comments
- (goto-char (point-min))
- (while (re-search-forward "^#.*\n?" nil t)
- (replace-match ""))
- (setq rtn (buffer-string)))
- (kill-buffer " org-mode-tmp")
- rtn))
- (defun org-solidify-link-text (s &optional alist)
- "Take link text and make a safe target out of it."
- (save-match-data
- (let* ((rtn
- (mapconcat
- 'identity
- (org-split-string s "[ \t\r\n]+") "--"))
- (a (assoc rtn alist)))
- (or (cdr a) rtn))))
- (defun org-convert-to-odd-levels ()
- "Convert an org-mode file with all levels allowed to one with odd levels.
- This will leave level 1 alone, convert level 2 to level 3, level 3 to
- level 5 etc."
- (interactive)
- (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
- (let ((org-odd-levels-only nil) n)
- (save-excursion
- (goto-char (point-min))
- (while (re-search-forward "^\\*\\*+" nil t)
- (setq n (1- (length (match-string 0))))
- (while (>= (setq n (1- n)) 0)
- (org-demote))
- (end-of-line 1))))))
- (defun org-convert-to-oddeven-levels ()
- "Convert an org-mode file with only odd levels to one with odd and even levels.
- This promotes level 3 to level 2, level 5 to level 3 etc. If the file contains a
- section with an even level, conversion would destroy the structure of the file. An error
- is signaled in this case."
- (interactive)
- (goto-char (point-min))
- ;; First check if there are no even levels
- (when (re-search-forward "^\\(\\*\\*\\)+[^*]" nil t)
- (org-show-hierarchy-above)
- (error "Not all levels are odd in this file. Conversion not possible."))
- (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
- (let ((org-odd-levels-only nil) n)
- (save-excursion
- (goto-char (point-min))
- (while (re-search-forward "^\\*\\*+" nil t)
- (setq n (/ (length (match-string 0)) 2))
- (while (>= (setq n (1- n)) 0)
- (org-promote))
- (end-of-line 1))))))
- (defun org-tr-level (n)
- "Make N odd if required."
- (if org-odd-levels-only (1+ (/ n 2)) n))
- (defvar org-last-level nil) ; dynamically scoped variable
- (defun org-export-as-ascii (arg)
- "Export the outline as a pretty ASCII file.
- If there is an active region, export only the region.
- The prefix ARG specifies how many levels of the outline should become
- underlined headlines. The default is 3."
- (interactive "P")
- (setq-default org-todo-line-regexp org-todo-line-regexp)
- (let* ((region
- (buffer-substring
- (if (org-region-active-p) (region-beginning) (point-min))
- (if (org-region-active-p) (region-end) (point-max))))
- (lines (org-export-find-first-heading-line
- (org-skip-comments
- (org-split-string
- (org-cleaned-string-for-export region)
- "[\r\n]"))))
- (org-startup-with-deadline-check nil)
- (level 0) line txt
- (umax nil)
- (case-fold-search nil)
- (filename (concat (file-name-sans-extension buffer-file-name)
- ".txt"))
- (buffer (find-file-noselect filename))
- (levels-open (make-vector org-level-max nil))
- (date (format-time-string "%Y/%m/%d" (current-time)))
- (time (format-time-string "%X" (org-current-time)))
- (author user-full-name)
- (title (buffer-name))
- (options nil)
- (email user-mail-address)
- (language org-export-default-language)
- (text nil)
- (todo nil)
- (lang-words nil))
- (setq org-last-level 1)
- (org-init-section-numbers)
- (find-file-noselect filename)
- ;; Search for the export key lines
- (org-parse-key-lines)
- (setq lang-words (or (assoc language org-export-language-setup)
- (assoc "en" org-export-language-setup)))
- (if org-export-ascii-show-new-buffer
- (switch-to-buffer-other-window buffer)
- (set-buffer buffer))
- (erase-buffer)
- (fundamental-mode)
- (if options (org-parse-export-options options))
- (setq umax (if arg (prefix-numeric-value arg)
- org-export-headline-levels))
- ;; File header
- (if title (org-insert-centered title ?=))
- (insert "\n")
- (if (or author email)
- (insert (concat (nth 1 lang-words) ": " (or author "")
- (if email (concat " <" email ">") "")
- "\n")))
- (if (and date time)
- (insert (concat (nth 2 lang-words) ": " date " " time "\n")))
- (if text (insert (concat (org-html-expand-for-ascii text) "\n\n")))
- (insert "\n\n")
- (if org-export-with-toc
- (progn
- (insert (nth 3 lang-words) "\n"
- (make-string (length (nth 3 lang-words)) ?=) "\n")
- (mapcar '(lambda (line)
- (if (string-match org-todo-line-regexp
- line)
- ;; This is a headline
- (progn
- (setq level (- (match-end 1) (match-beginning 1))
- level (org-tr-level level)
- txt (match-string 3 line)
- todo
- (or (and (match-beginning 2)
- (not (equal (match-string 2 line)
- org-done-string)))
- ; TODO, not DONE
- (and (= level umax)
- (org-search-todo-below
- line lines level))))
- (setq txt (org-html-expand-for-ascii txt))
- (if org-export-with-section-numbers
- (setq txt (concat (org-section-number level)
- " " txt)))
- (if (<= level umax)
- (progn
- (insert
- (make-string (* (1- level) 4) ?\ )
- (format (if todo "%s (*)\n" "%s\n") txt))
- (setq org-last-level level))
- ))))
- lines)))
- (org-init-section-numbers)
- (while (setq line (pop lines))
- ;; Remove the quoted HTML tags.
- (setq line (org-html-expand-for-ascii line))
- ;; Remove targets
- (while (string-match "<<<?[^<>]*>>>?[ \t]*\n?" line)
- (setq line (replace-match "" t t line)))
- ;; Replace internal links
- (while (string-match org-bracket-link-regexp line)
- (setq line (replace-match
- (if (match-end 3) "[\\3]" "[\\1]")
- t nil line)))
- (cond
- ((string-match "^\\(\\*+\\)[ \t]*\\(.*\\)" line)
- ;; a Headline
- (setq level (org-tr-level (- (match-end 1) (match-beginning 1)))
- txt (match-string 2 line))
- (org-ascii-level-start level txt umax))
- (t (insert line "\n"))))
- (normal-mode)
- (save-buffer)
- (goto-char (point-min))))
- (defun org-search-todo-below (line lines level)
- "Search the subtree below LINE for any TODO entries."
- (let ((rest (cdr (memq line lines)))
- (re org-todo-line-regexp)
- line lv todo)
- (catch 'exit
- (while (setq line (pop rest))
- (if (string-match re line)
- (progn
- (setq lv (- (match-end 1) (match-beginning 1))
- todo (and (match-beginning 2)
- (not (equal (match-string 2 line)
- org-done-string))))
- ; TODO, not DONE
- (if (<= lv level) (throw 'exit nil))
- (if todo (throw 'exit t))))))))
- ;; FIXME: Try to handle <b> and <i> as faces via text properties.
- ;; FIXME: Can I implement *bold*,/italic/ and _underline_ for ASCII export?
- (defun org-html-expand-for-ascii (line)
- "Handle quoted HTML for ASCII export."
- (if org-export-html-expand
- (while (string-match "@<[^<>\n]*>" line)
- ;; We just remove the tags for now.
- (setq line (replace-match "" nil nil line))))
- line)
- (defun org-insert-centered (s &optional underline)
- "Insert the string S centered and underline it with character UNDERLINE."
- (let ((ind (max (/ (- 80 (string-width s)) 2) 0)))
- (insert (make-string ind ?\ ) s "\n")
- (if underline
- (insert (make-string ind ?\ )
- (make-string (string-width s) underline)
- "\n"))))
- (defun org-ascii-level-start (level title umax)
- "Insert a new level in ASCII export."
- (let (char)
- (if (> level umax)
- (insert (make-string (* 2 (- level umax 1)) ?\ ) "* " title "\n")
- (if (or (not (equal (char-before) ?\n))
- (not (equal (char-before (1- (point))) ?\n)))
- (insert "\n"))
- (setq char (nth (- umax level) (reverse org-ascii-underline)))
- (if org-export-with-section-numbers
- (setq title (concat (org-section-number level) " " title)))
- (insert title "\n" (make-string (string-width title) char) "\n"))))
- (defun org-export-copy-visible ()
- "Copy the visible part of the buffer to another buffer, for printing.
- Also removes the first line of the buffer if it specifies a mode,
- and all options lines."
- (interactive)
- (let* ((filename (concat (file-name-sans-extension buffer-file-name)
- ".txt"))
- (buffer (find-file-noselect filename))
- (ore (concat
- (org-make-options-regexp
- '("CATEGORY" "SEQ_TODO" "PRI_TODO" "TYP_TODO"
- "STARTUP" "ARCHIVE"
- "TITLE" "AUTHOR" "EMAIL" "TEXT" "OPTIONS" "LANGUAGE"))
- (if org-noutline-p "\\(\n\\|$\\)" "")))
- s e)
- (with-current-buffer buffer
- (erase-buffer)
- (text-mode))
- (save-excursion
- (setq s (goto-char (point-min)))
- (while (not (= (point) (point-max)))
- (goto-char (org-find-invisible))
- (append-to-buffer buffer s (point))
- (setq s (goto-char (org-find-visible)))))
- (switch-to-buffer-other-window buffer)
- (newline)
- (goto-char (point-min))
- (if (looking-at ".*-\\*- mode:.*\n")
- (replace-match ""))
- (while (re-search-forward ore nil t)
- (replace-match ""))
- (goto-char (point-min))))
- (defun org-find-visible ()
- (if (featurep 'noutline)
- (let ((s (point)))
- (while (and (not (= (point-max) (setq s (next-overlay-change s))))
- (get-char-property s 'invisible)))
- s)
- (skip-chars-forward "^\n")
- (point)))
- (defun org-find-invisible ()
- (if (featurep 'noutline)
- (let ((s (point)))
- (while (and (not (= (point-max) (setq s (next-overlay-change s))))
- (not (get-char-property s 'invisible))))
- s)
- (skip-chars-forward "^\r")
- (point)))
- ;; HTML
- (defun org-get-current-options ()
- "Return a string with current options as keyword options.
- Does include HTML export options as well as TODO and CATEGORY stuff."
- (format
- "#+TITLE: %s
- #+AUTHOR: %s
- #+EMAIL: %s
- #+LANGUAGE: %s
- #+TEXT: Some descriptive text to be emitted. Several lines OK.
- #+OPTIONS: H:%d num:%s toc:%s \\n:%s @:%s ::%s |:%s ^:%s *:%s TeX:%s
- #+CATEGORY: %s
- #+SEQ_TODO: %s
- #+TYP_TODO: %s
- #+STARTUP: %s %s %s %s
- #+ARCHIVE: %s
- "
- (buffer-name) (user-full-name) user-mail-address org-export-default-language
- org-export-headline-levels
- org-export-with-section-numbers
- org-export-with-toc
- org-export-preserve-breaks
- org-export-html-expand
- org-export-with-fixed-width
- org-export-with-tables
- org-export-with-sub-superscripts
- org-export-with-emphasize
- org-export-with-TeX-macros
- (file-name-nondirectory buffer-file-name)
- (if (equal org-todo-interpretation 'sequence)
- (mapconcat 'identity org-todo-keywords " ")
- "TODO FEEDBACK VERIFY DONE")
- (if (equal org-todo-interpretation 'type)
- (mapconcat 'identity org-todo-keywords " ")
- "Me Jason Marie DONE")
- (cdr (assoc org-startup-folded
- '((nil . "nofold")(t . "fold")(content . "content"))))
- (if org-startup-with-deadline-check "dlcheck" "nodlcheck")
- (if org-odd-levels-only "odd" "oddeven")
- (if org-hide-leading-stars "hidestars" "showstars")
- org-archive-location
- ))
- (defun org-insert-export-options-template ()
- "Insert into the buffer a template with information for exporting."
- (interactive)
- (if (not (bolp)) (newline))
- (let ((s (org-get-current-options)))
- (and (string-match "#\\+CATEGORY" s)
- (setq s (substring s 0 (match-beginning 0))))
- (insert s)))
- (defun org-toggle-fixed-width-section (arg)
- "Toggle the fixed-width export.
- If there is no active region, the QUOTE keyword at the current headline is
- inserted or removed. When present, it causes the text between this headline
- and the next to be exported as fixed-width text, and unmodified.
- If there is an active region, this command adds or removes a colon as the
- first character of this line. If the first character of a line is a colon,
- this line is also exported in fixed-width font."
- (interactive "P")
- (let* ((cc 0)
- (regionp (org-region-active-p))
- (beg (if regionp (region-beginning) (point)))
- (end (if regionp (region-end)))
- (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
- (re "[ \t]*\\(:\\)")
- off)
- (if regionp
- (save-excursion
- (goto-char beg)
- (setq cc (current-column))
- (beginning-of-line 1)
- (setq off (looking-at re))
- (while (> nlines 0)
- (setq nlines (1- nlines))
- (beginning-of-line 1)
- (cond
- (arg
- (move-to-column cc t)
- (insert ":\n")
- (forward-line -1))
- ((and off (looking-at re))
- (replace-match "" t t nil 1))
- ((not off) (move-to-column cc t) (insert ":")))
- (forward-line 1)))
- (save-excursion
- (org-back-to-heading)
- (if (looking-at (concat outline-regexp
- "\\( +\\<" org-quote-string "\\>\\)"))
- (replace-match "" t t nil 1)
- (if (looking-at outline-regexp)
- (progn
- (goto-char (match-end 0))
- (insert " " org-quote-string))))))))
- (defun org-export-as-html-and-open (arg)
- "Export the outline as HTML and immediately open it with a browser.
- If there is an active region, export only the region.
- The prefix ARG specifies how many levels of the outline should become
- headlines. The default is 3. Lower levels will become bulleted lists."
- (interactive "P")
- (org-export-as-html arg 'hidden)
- (org-open-file buffer-file-name))
- (defun org-export-as-html-batch ()
- "Call `org-export-as-html', may be used in batch processing as
- emacs --batch
- --load=$HOME/lib/emacs/org.el
- --eval \"(setq org-export-headline-levels 2)\"
- --visit=MyFile --funcall org-export-as-html-batch"
- (org-export-as-html org-export-headline-levels 'hidden))
- (defun org-export-as-html (arg &optional hidden)
- "Export the outline as a pretty HTML file.
- If there is an active region, export only the region.
- The prefix ARG specifies how many levels of the outline should become
- headlines. The default is 3. Lower levels will become bulleted lists."
- (interactive "P")
- (setq-default org-todo-line-regexp org-todo-line-regexp)
- (setq-default org-deadline-line-regexp org-deadline-line-regexp)
- (setq-default org-done-string org-done-string)
- (let* ((style org-export-html-style)
- (odd org-odd-levels-only)
- (region-p (org-region-active-p))
- (region
- (buffer-substring
- (if region-p (region-beginning) (point-min))
- (if region-p (region-end) (point-max))))
- (all_lines
- (org-skip-comments (org-split-string
- (org-cleaned-string-for-export region)
- "[\r\n]")))
- (lines (org-export-find-first-heading-line all_lines))
- (level 0) (line "") (origline "") txt todo
- (umax nil)
- (filename (concat (file-name-sans-extension buffer-file-name)
- ".html"))
- (buffer (find-file-noselect filename))
- (levels-open (make-vector org-level-max nil))
- (date (format-time-string "%Y/%m/%d" (current-time)))
- (time (format-time-string "%X" (org-current-time)))
- (author user-full-name)
- (title (buffer-name))
- (options nil)
- (quote-re (concat "^\\*+[ \t]*" org-quote-string "\\>"))
- (inquote nil)
- (infixed nil)
- (in-local-list nil)
- (local-list-num nil)
- (local-list-indent nil)
- (llt org-plain-list-ordered-item-terminator)
- (email user-mail-address)
- (language org-export-default-language)
- (text nil)
- (lang-words nil)
- (target-alist nil) tg
- (head-count 0) cnt
- (start 0)
- ;; FIXME: The following returns always nil under XEmacs
- (coding-system (and (fboundp 'coding-system-get)
- (boundp 'buffer-file-coding-system)
- buffer-file-coding-system))
- (coding-system-for-write (or coding-system coding-system-for-write))
- (save-buffer-coding-system (or coding-system save-buffer-coding-system))
- (charset (and coding-system
- (coding-system-get coding-system 'mime-charset)))
- table-open type
- table-buffer table-orig-buffer
- ind start-is-num starter
- )
- (message "Exporting...")
- (setq org-last-level 1)
- (org-init-section-numbers)
- ;; Search for the export key lines
- (org-parse-key-lines)
- (setq lang-words (or (assoc language org-export-language-setup)
- (assoc "en" org-export-language-setup)))
- ;; Switch to the output buffer
- (if (or hidden (not org-export-html-show-new-buffer))
- (set-buffer buffer)
- (switch-to-buffer-other-window buffer))
- (erase-buffer)
- (fundamental-mode)
- (let ((case-fold-search nil)
- (org-odd-levels-only odd))
- (if options (org-parse-export-options options))
- (setq umax (if arg (prefix-numeric-value arg)
- org-export-headline-levels))
- ;; File header
- (insert (format
- "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.0 Transitional//EN\"
- \"http://www.w3.org/TR/REC-html40/loose.dtd\">
- <html lang=\"%s\"><head>
- <title>%s</title>
- <meta http-equiv=\"Content-Type\" content=\"text/html;charset=%s\">
- <meta name=generator content=\"Org-mode\">
- <meta name=generated content=\"%s %s\">
- <meta name=author content=\"%s\">
- %s
- </head><body>
- "
- language (org-html-expand title) (or charset "iso-8859-1")
- date time author style))
- (if title (insert (concat "<H1 class=\"title\">"
- (org-html-expand title) "</H1>\n")))
- (if author (insert (concat (nth 1 lang-words) ": " author "\n")))
- (if email (insert (concat "<a href=\"mailto:" email "\"><"
- email "></a>\n")))
- (if (or author email) (insert "<br>\n"))
- (if (and date time) (insert (concat (nth 2 lang-words) ": "
- date " " time "<br>\n")))
- (if text (insert (concat "<p>\n" (org-html-expand text))))
- (if org-export-with-toc
- (progn
- (insert (format "<H2>%s</H2>\n" (nth 3 lang-words)))
- (insert "<ul>\n")
- (setq lines
- (mapcar '(lambda (line)
- (if (string-match org-todo-line-regexp line)
- ;; This is a headline
- (progn
- (setq level (- (match-end 1) (match-beginning 1))
- level (org-tr-level level)
- txt (save-match-data
- (org-html-expand
- (match-string 3 line)))
- todo
- (or (and (match-beginning 2)
- (not (equal (match-string 2 line)
- org-done-string)))
- ; TODO, not DONE
- (and (= level umax)
- (org-search-todo-below
- line lines level))))
- (if org-export-with-section-numbers
- (setq txt (concat (org-section-number level)
- " " txt)))
- (if (<= level umax)
- (progn
- (setq head-count (+ head-count 1))
- (if (> level org-last-level)
- (progn
- (setq cnt (- level org-last-level))
- (while (>= (setq cnt (1- cnt)) 0)
- (insert "<ul>"))
- (insert "\n")))
- (if (< level org-last-level)
- (progn
- (setq cnt (- org-last-level level))
- (while (>= (setq cnt (1- cnt)) 0)
- (insert "</ul>"))
- (insert "\n")))
- ;; Check for targets
- (while (string-match org-target-regexp line)
- (setq tg (match-string 1 line)
- line (replace-match
- (concat "@<span class=\"target\">" tg "@</span> ")
- t t line))
- (push (cons (org-solidify-link-text tg)
- (format "sec-%d" head-count))
- target-alist))
- (while (string-match "<\\(<\\)+\\|>\\(>\\)+" txt)
- (setq txt (replace-match "" t t txt)))
- (insert
- (format
- (if todo
- "<li><a href=\"#sec-%d\"><span class=\"todo\">%s</span></a>\n"
- "<li><a href=\"#sec-%d\">%s</a>\n")
- head-count txt))
- (setq org-last-level level))
- )))
- line)
- lines))
- (while (> org-last-level 0)
- (setq org-last-level (1- org-last-level))
- (insert "</ul>\n"))
- ))
- (setq head-count 0)
- (org-init-section-numbers)
- (while (setq line (pop lines) origline line)
- (catch 'nextline
- ;; end of quote section?
- (when (and inquote (string-match "^\\*+" line))
- (insert "</pre>\n")
- (setq inquote nil))
- ;; inside a quote section?
- (when inquote
- (insert (org-html-protect line) "\n")
- (throw 'nextline nil))
- ;; verbatim lines
- (when (and org-export-with-fixed-width
- (string-match "^[ \t]*:\\(.*\\)" line))
- (when (not infixed)
- (setq infixed t)
- (insert "<pre>\n"))
- (insert (org-html-protect (match-string 1 line)) "\n")
- (when (and lines
- (not (string-match "^[ \t]*\\(:.*\\)"
- (car lines))))
- (setq infixed nil)
- (insert "</pre>\n"))
- (throw 'nextline nil))
- ;; make targets to anchors
- (while (string-match "<<<?\\([^<>]*\\)>>>?\\((INVISIBLE)\\)?[ \t]*\n?" line)
- (cond
- ((match-end 2)
- (setq line (replace-match
- (concat "@<a name=\""
- (org-solidify-link-text (match-string 1 line))
- "\">\\nbsp@</a>")
- t t line)))
- ((and org-export-with-toc (equal (string-to-char line) ?*))
- (setq line (replace-match
- (concat "@<span class=\"target\">" (match-string 1 line) "@</span> ")
- ; (concat "@<i>" (match-string 1 line) "@</i> ")
- t t line)))
- (t
- (setq line (replace-match
- (concat "@<a name=\""
- (org-solidify-link-text (match-string 1 line))
- "\" class=\"target\">" (match-string 1 line) "@</a> ")
- t t line)))))
- ;; Replace internal links
- (while (string-match org-bracket-link-regexp line)
- (setq line (replace-match
- (concat
- "@<a href=\"#"
- (org-solidify-link-text (match-string 1 line) target-alist)
- "\">"
- (match-string (if (match-end 3) 3 1) line)
- "@</a>")
- t t line)))
- ;; Protect the external links
- (setq start 0)
- (while (string-match org-link-maybe-angles-regexp line start)
- (setq start (match-end 0))
- (setq line (replace-match
- (concat "\000" (match-string 1 line) "\000")
- t t line)))
- ;; replace "&" by "&", "<" and ">" by "<" and ">"
- ;; handle @<..> HTML tags (replace "@>..<" by "<..>")
- (setq line (org-html-expand line))
- ;; Format the links
- (setq start 0)
- (while (string-match org-protected-link-regexp line start)
- (setq start (- (match-end 0) 2))
- (setq type (match-string 1 line))
- (cond
- ((member type '("http" "https" "ftp" "mailto" "news"))
- ;; standard URL
- (setq line (replace-match
- ; "<a href=\"\\1:\\2\"><\\1:\\2></a>"
- "<a href=\"\\1:\\2\">\\1:\\2</a>"
- nil nil line)))
- ((string= type "file")
- ;; FILE link
- (let* ((filename (match-string 2 line))
- (abs-p (file-name-absolute-p filename))
- (thefile (if abs-p (expand-file-name filename) filename))
- (thefile (save-match-data
- (if (string-match ":[0-9]+$" thefile)
- (replace-match "" t t thefile)
- thefile)))
- (file-is-image-p
- (save-match-data
- (string-match (org-image-file-name-regexp) thefile))))
- (setq line (replace-match
- (if (and org-export-html-inline-images
- file-is-image-p)
- (concat "<img src=\"" thefile "\"/>")
- (concat "<a href=\"" thefile "\">\\1:\\2</a>"))
- nil nil line))))
- ((member type '("bbdb" "vm" "wl" "mhe" "rmail" "gnus" "shell"))
- (setq line (replace-match
- "<i><\\1:\\2></i>" nil nil line)))))
- ;; TODO items
- (if (and (string-match org-todo-line-regexp line)
- (match-beginning 2))
- (if (equal (match-string 2 line) org-done-string)
- (setq line (replace-match
- "<span class=\"done\">\\2</span>"
- nil nil line 2))
- (setq line (replace-match "<span class=\"todo\">\\2</span>"
- nil nil line 2))))
- ;; DEADLINES
- (if (string-match org-deadline-line-regexp line)
- (progn
- (if (save-match-data
- (string-match "<a href"
- (substring line 0 (match-beginning 0))))
- nil ; Don't do the replacement - it is inside a link
- (setq line (replace-match "<span class=\"deadline\">\\&</span>"
- nil nil line 1)))))
- (cond
- ((string-match "^\\(\\*+\\)[ \t]*\\(.*\\)" line)
- ;; This is a headline
- (setq level (org-tr-level (- (match-end 1) (match-beginning 1)))
- txt (match-string 2 line))
- (if (<= level umax) (setq head-count (+ head-count 1)))
- (when in-local-list
- ;; Close any local lists before inserting a new header line
- (while local-list-num
- (insert (if (car local-list-num) "</ol>\n" "</ul>"))
- (pop local-list-num))
- (setq local-list-indent nil
- in-local-list nil))
- (org-html-level-start level txt umax
- (and org-export-with-toc (<= level umax))
- head-count)
- ;; QUOTES
- (when (string-match quote-re line)
- (insert "<pre>")
- (setq inquote t)))
- ((and org-export-with-tables
- (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)" line))
- (if (not table-open)
- ;; New table starts
- (setq table-open t table-buffer nil table-orig-buffer nil))
- ;; Accumulate lines
- (setq table-buffer (cons line table-buffer)
- table-orig-buffer (cons origline table-orig-buffer))
- (when (or (not lines)
- (not (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)"
- (car lines))))
- (setq table-open nil
- table-buffer (nreverse table-buffer)
- table-orig-buffer (nreverse table-orig-buffer))
- (insert (org-format-table-html table-buffer table-orig-buffer))))
- (t
- ;; Normal lines
- (when (and (> org-export-plain-list-max-depth 0)
- (string-match
- (cond
- ((eq llt t) "^\\([ \t]*\\)\\(\\([-+*]\\)\\|\\([0-9]+[.)]\\)\\)?\\( +[^ \t\n\r]\\|[ \t]*$\\)")
- ((= llt ?.) "^\\([ \t]*\\)\\(\\([-+*]\\)\\|\\([0-9]+\\.\\)\\)?\\( +[^ \t\n\r]\\|[ \t]*$\\)")
- ((= llt ?\)) "^\\( \t]*\\)\\(\\([-+*]\\)\\|\\([0-9]+)\\)\\)?\\( +[^ \t\n\r]\\|[ \t]*$\\)")
- (t (error "Invalid value of `org-plain-list-ordered-item-terminator'")))
- line))
- (setq ind (org-get-string-indentation line)
- start-is-num (match-beginning 4)
- starter (if (match-beginning 2) (match-string 2 line))
- line (substring line (match-beginning 5)))
- (unless (string-match "[^ \t]" line)
- ;; empty line. Pretend indentation is large.
- (setq ind (1+ (or (car local-list-indent) 1))))
- (while (and in-local-list
- (or (and (= ind (car local-list-indent))
- (not starter))
- (< ind (car local-list-indent))))
- (insert (if (car local-list-num) "</ol>\n" "</ul>"))
- (pop local-list-num) (pop local-list-indent)
- (setq in-local-list local-list-indent))
- (cond
- ((and starter
- (or (not in-local-list)
- (> ind (car local-list-indent)))
- (< (length local-list-indent)
- org-export-plain-list-max-depth))
- ;; Start new (level of ) list
- (insert (if start-is-num "<ol>\n<li>\n" "<ul>\n<li>\n"))
- (push start-is-num local-list-num)
- (push ind local-list-indent)
- (setq in-local-list t))
- (starter
- ;; continue current list
- (insert "<li>\n"))))
- ;; Empty lines start a new paragraph. If hand-formatted lists
- ;; are not fully interpreted, lines starting with "-", "+", "*"
- ;; also start a new paragraph.
- (if (string-match "^ [-+*]-\\|^[ \t]*$" line) (insert "<p>"))
- (insert line (if org-export-preserve-breaks "<br>\n" "\n"))))
- ))
- (if org-export-html-with-timestamp
- (insert org-export-html-html-helper-timestamp))
- (insert "</body>\n</html>\n")
- (normal-mode)
- (save-buffer)
- (goto-char (point-min)))))
- (defun org-format-table-html (lines olines)
- "Find out which HTML converter to use and return the HTML code."
- (if (string-match "^[ \t]*|" (car lines))
- ;; A normal org table
- (org-format-org-table-html lines)
- ;; Table made by table.el - test for spanning
- (let* ((hlines (delq nil (mapcar
- (lambda (x)
- (if (string-match "^[ \t]*\\+-" x) x
- nil))
- lines)))
- (first (car hlines))
- (ll (and (string-match "\\S-+" first)
- (match-string 0 first)))
- (re (concat "^[ \t]*" (regexp-quote ll)))
- (spanning (delq nil (mapcar (lambda (x) (not (string-match re x)))
- hlines))))
- (if (and (not spanning)
- (not org-export-prefer-native-exporter-for-tables))
- ;; We can use my own converter with HTML conversions
- (org-format-table-table-html lines)
- ;; Need to use the code generator in table.el, with the original text.
- (org-format-table-table-html-using-table-generate-source olines)))))
- (defun org-format-org-table-html (lines)
- "Format a table into HTML."
- (if (string-match "^[ \t]*|-" (car lines)) (setq lines (cdr lines)))
- (setq lines (nreverse lines))
- (if (string-match "^[ \t]*|-" (car lines)) (setq lines (cdr lines)))
- (setq lines (nreverse lines))
- (when org-export-table-remove-special-lines
- ;; Check if the table has a marking column. If yes remove the
- ;; column and the special lines
- (let* ((special
- (not
- (memq nil
- (mapcar
- (lambda (x)
- (or (string-match "^[ \t]*|-" x)
- (string-match "^[ \t]*| *\\([#!$*_^ ]\\) *|" x)))
- lines)))))
- (if special
- (setq lines
- (delq nil
- (mapcar
- (lambda (x)
- (if (string-match "^[ \t]*| *[!_^] *|" x)
- nil ; ignore this line
- (and (or (string-match "^[ \t]*|-+\\+" x)
- (string-match "^[ \t]*|[^|]*|" x))
- (replace-match "|" t t x))))
- lines))))))
- (let ((head (and org-export-highlight-first-table-line
- (delq nil (mapcar
- (lambda (x) (string-match "^[ \t]*|-" x))
- (cdr lines)))))
- line fields html)
- (setq html (concat org-export-html-table-tag "\n"))
- (while (setq line (pop lines))
- (catch 'next-line
- (if (string-match "^[ \t]*|-" line)
- (progn
- (setq head nil) ;; head ends here, first time around
- ;; ignore this line
- (throw 'next-line t)))
- ;; Break the line into fields
- (setq fields (org-split-string line "[ \t]*|[ \t]*"))
- (setq html (concat
- html
- "<tr>"
- (mapconcat (lambda (x)
- (if head
- (concat "<th>" x "</th>")
- (concat "<td>" x "</td>")))
- fields "")
- "</tr>\n"))))
- (setq html (concat html "</table>\n"))
- html))
- (defun org-fake-empty-table-line (line)
- "Replace everything except \"|\" with spaces."
- (let ((i (length line))
- (newstr (copy-sequence line)))
- (while (> i 0)
- (setq i (1- i))
- (if (not (eq (aref newstr i) ?|))
- (aset newstr i ?\ )))
- newstr))
- (defun org-format-table-table-html (lines)
- "Format a table generated by table.el into HTML.
- This conversion does *not* use `table-generate-source' from table.el.
- This has the advantage that Org-mode's HTML conversions can be used.
- But it has the disadvantage, that no cell- or row-spanning is allowed."
- (let (line field-buffer
- (head org-export-highlight-first-table-line)
- fields html empty)
- (setq html (concat org-export-html-table-tag "\n"))
- (while (setq line (pop lines))
- (setq empty " ")
- (catch 'next-line
- (if (string-match "^[ \t]*\\+-" line)
- (progn
- (if field-buffer
- (progn
- (setq html (concat
- html
- "<tr>"
- (mapconcat
- (lambda (x)
- (if (equal x "") (setq x empty))
- (if head
- (concat "<th>" x "</th>\n")
- (concat "<td>" x "</td>\n")))
- field-buffer "\n")
- "</tr>\n"))
- (setq head nil)
- (setq field-buffer nil)))
- ;; Ignore this line
- (throw 'next-line t)))
- ;; Break the line into fields and store the fields
- (setq fields (org-split-string line "[ \t]*|[ \t]*"))
- (if field-buffer
- (setq field-buffer (mapcar
- (lambda (x)
- (concat x "<br>" (pop fields)))
- field-buffer))
- (setq field-buffer fields))))
- (setq html (concat html "</table>\n"))
- html))
- (defun org-format-table-table-html-using-table-generate-source (lines)
- "Format a table into html, using `table-generate-source' from table.el.
- This has the advantage that cell- or row-spanning is allowed.
- But it has the disadvantage, that Org-mode's HTML conversions cannot be used."
- (require 'table)
- (with-current-buffer (get-buffer-create " org-tmp1 ")
- (erase-buffer)
- (insert (mapconcat 'identity lines "\n"))
- (goto-char (point-min))
- (if (not (re-search-forward "|[^+]" nil t))
- (error "Error processing table"))
- (table-recognize-table)
- (with-current-buffer (get-buffer-create " org-tmp2 ") (erase-buffer))
- (table-generate-source 'html " org-tmp2 ")
- (set-buffer " org-tmp2 ")
- (buffer-substring (point-min) (point-max))))
- (defun org-html-protect (s)
- ;; convert & to &, < to < and > to >
- (let ((start 0))
- (while (string-match "&" s start)
- (setq s (replace-match "&" t t s)
- start (1+ (match-beginning 0))))
- (while (string-match "<" s)
- (setq s (replace-match "<" t t s)))
- (while (string-match ">" s)
- (setq s (replace-match ">" t t s))))
- s)
- (defun org-html-expand (string)
- "Prepare STRING for HTML export. Applies all active conversions."
- ;; First check if there is a link in the line - if yes, apply conversions
- ;; only before the start of the link.
- ;; FIXME: This is no longer correct, because links now have an end.
- (let* ((m (string-match org-link-regexp string))
- (s (if m (substring string 0 m) string))
- (r (if m (substring string m) "")))
- ;; convert & to &, < to < and > to >
- (setq s (org-html-protect s))
- (if org-export-html-expand
- (while (string-match "@<\\([^&]*\\)>" s)
- (setq s (replace-match "<\\1>" nil nil s))))
- (if org-export-with-emphasize
- (setq s (org-export-html-convert-emphasize s)))
- (if org-export-with-sub-superscripts
- (setq s (org-export-html-convert-sub-super s)))
- (if org-export-with-TeX-macros
- (let ((start 0) wd ass)
- (while (setq start (string-match "\\\\\\([a-zA-Z]+\\)" s start))
- (setq wd (match-string 1 s))
- (if (setq ass (assoc wd org-html-entities))
- (setq s (replace-match (or (cdr ass)
- (concat "&" (car ass) ";"))
- t t s))
- (setq start (+ start (length wd)))))))
- (concat s r)))
- (defun org-create-multibrace-regexp (left right n)
- "Create a regular expression which will match a balanced sexp.
- Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
- as single character strings.
- The regexp returned will match the entire expression including the
- delimiters. It will also define a single group which contains the
- match except for the outermost delimiters. The maximum depth of
- stacked delimiters is N. Escaping delimiters is not possible."
- (let* ((nothing (concat "[^" "\\" left "\\" right "]*?"))
- (or "\\|")
- (re nothing)
- (next (concat "\\(?:" nothing left nothing right "\\)+" nothing)))
- (while (> n 1)
- (setq n (1- n)
- re (concat re or next)
- next (concat "\\(?:" nothing left next right "\\)+" nothing)))
- (concat left "\\(" re "\\)" right)))
- (defvar org-match-substring-regexp
- (concat
- "\\([^\\]\\)\\([_^]\\)\\("
- "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
- "\\|"
- "\\(" (org-create-multibrace-regexp "(" ")" org-match-sexp-depth) "\\)"
- "\\|"
- "\\(\\(?:\\*\\|[-+]?[^-+*!@#$%^_ \t\r\n,:\"?<>~;./{}=()]+\\)\\)\\)")
- "The regular expression matching a sub- or superscript.")
- (defun org-export-html-convert-sub-super (string)
- "Convert sub- and superscripts in STRING to HTML."
- (let (key c)
- (while (string-match org-match-substring-regexp string)
- (setq key (if (string= (match-string 2 string) "_") "sub" "sup"))
- (setq c (or (match-string 8 string)
- (match-string 6 string)
- (match-string 5 string)))
- (setq string (replace-match
- (concat (match-string 1 string)
- "<" key ">" c "</" key ">")
- t t string)))
- (while (string-match "\\\\\\([_^]\\)" string)
- (setq string (replace-match (match-string 1 string) t t string))))
- string)
- (defun org-export-html-convert-emphasize (string)
- (let (c (s 0))
- (while (string-match "\\(\\W\\|^\\)\\([*/_]\\)\\(\\w+\\)\\2\\(\\W\\|$\\)" string s)
- (setq c (cdr (assoc (match-string 2 string)
- '(("*" . "b") ("/" . "i") ("_" . "u"))))
- s (+ (match-end 0) 3)
- string (replace-match
- (concat "\\1<" c ">\\3</" c ">\\4") t nil string)))
- string))
- (defun org-parse-key-lines ()
- "Find the special key lines with the information for exporters."
- (save-excursion
- (goto-char 0)
- (let ((re (org-make-options-regexp
- '("TITLE" "AUTHOR" "EMAIL" "TEXT" "OPTIONS" "LANGUAGE")))
- key)
- (while (re-search-forward re nil t)
- (setq key (match-string 1))
- (cond ((string-equal key "TITLE")
- (setq title (match-string 2)))
- ((string-equal key "AUTHOR")
- (setq author (match-string 2)))
- ((string-equal key "EMAIL")
- (setq email (match-string 2)))
- ((string-equal key "LANGUAGE")
- (setq language (match-string 2)))
- ((string-equal key "TEXT")
- (setq text (concat text "\n" (match-string 2))))
- ((string-equal key "OPTIONS")
- (setq options (match-string 2))))))))
- (defun org-parse-export-options (s)
- "Parse the export options line."
- (let ((op '(("H" . org-export-headline-levels)
- ("num" . org-export-with-section-numbers)
- ("toc" . org-export-with-toc)
- ("\\n" . org-export-preserve-breaks)
- ("@" . org-export-html-expand)
- (":" . org-export-with-fixed-width)
- ("|" . org-export-with-tables)
- ("^" . org-export-with-sub-superscripts)
- ("*" . org-export-with-emphasize)
- ("TeX" . org-export-with-TeX-macros)))
- o)
- (while (setq o (pop op))
- (if (string-match (concat (regexp-quote (car o)) ":\\([^ \t\n\r;,.]*\\)")
- s)
- (set (make-local-variable (cdr o))
- (car (read-from-string (match-string 1 s))))))))
- (defun org-html-level-start (level title umax with-toc head-count)
- "Insert a new level in HTML export."
- (let ((l (1+ (max level umax))))
- (while (<= l org-level-max)
- (if (aref levels-open (1- l))
- (progn
- (org-html-level-close l)
- (aset levels-open (1- l) nil)))
- (setq l (1+ l)))
- (if (> level umax)
- (progn
- (if (aref levels-open (1- level))
- (insert "<li>" title "<p>\n")
- (aset levels-open (1- level) t)
- (insert "<ul><li>" title "<p>\n")))
- (if org-export-with-section-numbers
- (setq title (concat (org-section-number level) " " title)))
- (setq level (+ level 1))
- (if with-toc
- (insert (format "\n<H%d><a name=\"sec-%d\">%s</a></H%d>\n"
- level head-count title level))
- (insert (format "\n<H%d>%s</H%d>\n" level title level))))))
- (defun org-html-level-close (&rest args)
- "Terminate one level in HTML export."
- (insert "</ul>"))
- ;; Variable holding the vector with section numbers
- (defvar org-section-numbers (make-vector org-level-max 0))
- (defun org-init-section-numbers ()
- "Initialize the vector for the section numbers."
- (let* ((level -1)
- (numbers (nreverse (org-split-string "" "\\.")))
- (depth (1- (length org-section-numbers)))
- (i depth) number-string)
- (while (>= i 0)
- (if (> i level)
- (aset org-section-numbers i 0)
- (setq number-string (or (car numbers) "0"))
- (if (string-match "\\`[A-Z]\\'" number-string)
- (aset org-section-numbers i
- (- (string-to-char number-string) ?A -1))
- (aset org-section-numbers i (string-to-number number-string)))
- (pop numbers))
- (setq i (1- i)))))
- (defun org-section-number (&optional level)
- "Return a string with the current section number.
- When LEVEL is non-nil, increase section numbers on that level."
- (let* ((depth (1- (length org-section-numbers))) idx n (string ""))
- (when level
- (when (> level -1)
- (aset org-section-numbers
- level (1+ (aref org-section-numbers level))))
- (setq idx (1+ level))
- (while (<= idx depth)
- (if (not (= idx 1))
- (aset org-section-numbers idx 0))
- (setq idx (1+ idx))))
- (setq idx 0)
- (while (<= idx depth)
- (setq n (aref org-section-numbers idx))
- (setq string (concat string (if (not (string= string "")) "." "")
- (int-to-string n)))
- (setq idx (1+ idx)))
- (save-match-data
- (if (string-match "\\`\\([@0]\\.\\)+" string)
- (setq string (replace-match "" nil nil string)))
- (if (string-match "\\(\\.0\\)+\\'" string)
- (setq string (replace-match "" nil nil string))))
- string))
- (defun org-export-icalendar-this-file ()
- "Export current file as an iCalendar file.
- The iCalendar file will be located in the same directory as the Org-mode
- file, but with extension `.ics'."
- (interactive)
- (org-export-icalendar nil buffer-file-name))
- ;;;###autoload
- (defun org-export-icalendar-all-agenda-files ()
- "Export all files in `org-agenda-files' to iCalendar .ics files.
- Each iCalendar file will be located in the same directory as the Org-mode
- file, but with extension `.ics'."
- (interactive)
- (apply 'org-export-icalendar nil (org-agenda-files t)))
- ;;;###autoload
- (defun org-export-icalendar-combine-agenda-files ()
- "Export all files in `org-agenda-files' to a single combined iCalendar file.
- The file is stored under the name `org-combined-agenda-icalendar-file'."
- (interactive)
- (apply 'org-export-icalendar t (org-agenda-files t)))
- (defun org-export-icalendar (combine &rest files)
- "Create iCalendar files for all elements of FILES.
- If COMBINE is non-nil, combine all calendar entries into a single large
- file and store it under the name `org-combined-agenda-icalendar-file'."
- (save-excursion
- (let* (file ical-file ical-buffer category started org-agenda-new-buffers)
- (when combine
- (setq ical-file org-combined-agenda-icalendar-file
- ical-buffer (org-get-agenda-file-buffer ical-file))
- (set-buffer ical-buffer) (erase-buffer))
- (while (setq file (pop files))
- (catch 'nextfile
- (org-check-agenda-file file)
- (unless combine
- (setq ical-file (concat (file-name-sans-extension file) ".ics"))
- (setq ical-buffer (org-get-agenda-file-buffer ical-file))
- (set-buffer ical-buffer) (erase-buffer))
- (set-buffer (org-get-agenda-file-buffer file))
- (setq category (or org-category
- (file-name-sans-extension
- (file-name-nondirectory buffer-file-name))))
- (if (symbolp category) (setq category (symbol-name category)))
- (let ((standard-output ical-buffer))
- (if combine
- (and (not started) (setq started t)
- (org-start-icalendar-file org-icalendar-combined-name))
- (org-start-icalendar-file category))
- (org-print-icalendar-entries combine category)
- (when (or (and combine (not files)) (not combine))
- (org-finish-icalendar-file)
- (set-buffer ical-buffer)
- (save-buffer)
- (run-hooks 'org-after-save-iCalendar-file-hook)))))
- (org-release-buffers org-agenda-new-buffers))))
- (defvar org-after-save-iCalendar-file-hook nil
- "Hook run after an iCalendar file has been saved.
- The iCalendar buffer is still current when this hook is run.
- A good way to use this is to tell a desktop calenndar application to re-read
- the iCalendar file.")
- (defun org-print-icalendar-entries (&optional combine category)
- "Print iCalendar entries for the current Org-mode file to `standard-output'.
- When COMBINE is non nil, add the category to each line."
- (let ((re2 (concat "--?-?\\(" org-ts-regexp "\\)"))
- (dts (org-ical-ts-to-string
- (format-time-string (cdr org-time-stamp-formats) (current-time))
- "DTSTART"))
- hd ts ts2 state (inc t) pos scheduledp deadlinep tmp pri)
- (save-excursion
- (goto-char (point-min))
- (while (re-search-forward org-ts-regexp nil t)
- (setq pos (match-beginning 0)
- ts (match-string 0)
- inc t
- hd (org-get-heading))
- (if (looking-at re2)
- (progn
- (goto-char (match-end 0))
- (setq ts2 (match-string 1) inc nil))
- (setq ts2 ts
- tmp (buffer-substring (max (point-min)
- (- pos org-ds-keyword-length))
- pos)
- deadlinep (string-match org-deadline-regexp tmp)
- scheduledp (string-match org-scheduled-regexp tmp)
- ;; donep (org-entry-is-done-p)
- ))
- (if (or (string-match org-tr-regexp hd)
- (string-match org-ts-regexp hd))
- (setq hd (replace-match "" t t hd)))
- (if combine
- (setq hd (concat hd " (category " category ")")))
- (if deadlinep (setq hd (concat "DL: " hd " This is a deadline")))
- (if scheduledp (setq hd (concat "S: " hd " Scheduled for this date")))
- (princ (format "BEGIN:VEVENT
- %s
- %s
- SUMMARY:%s
- END:VEVENT\n"
- (org-ical-ts-to-string ts "DTSTART")
- (org-ical-ts-to-string ts2 "DTEND" inc)
- hd)))
- (when org-icalendar-include-todo
- (goto-char (point-min))
- (while (re-search-forward org-todo-line-regexp nil t)
- (setq state (match-string 1))
- (unless (equal state org-done-string)
- (setq hd (match-string 3))
- (if (string-match org-priority-regexp hd)
- (setq pri (string-to-char (match-string 2 hd))
- hd (concat (substring hd 0 (match-beginning 1))
- (substring hd (- (match-end 1)))))
- (setq pri org-default-priority))
- (setq pri (floor (1+ (* 8. (/ (float (- org-lowest-priority pri))
- (- org-lowest-priority ?A))))))
- (princ (format "BEGIN:VTODO
- %s
- SUMMARY:%s
- SEQUENCE:1
- PRIORITY:%d
- END:VTODO\n"
- dts hd pri))))))))
- (defun org-start-icalendar-file (name)
- "Start an iCalendar file by inserting the header."
- (let ((user user-full-name)
- (name (or name "unknown"))
- (timezone (cadr (current-time-zone))))
- (princ
- (format "BEGIN:VCALENDAR
- VERSION:2.0
- X-WR-CALNAME:%s
- PRODID:-//%s//Emacs with Org-mode//EN
- X-WR-TIMEZONE:%s
- CALSCALE:GREGORIAN\n" name user timezone))))
- (defun org-finish-icalendar-file ()
- "Finish an iCalendar file by inserting the END statement."
- (princ "END:VCALENDAR\n"))
- (defun org-ical-ts-to-string (s keyword &optional inc)
- "Take a time string S and convert it to iCalendar format.
- KEYWORD is added in front, to make a complete line like DTSTART....
- When INC is non-nil, increase the hour by two (if time string contains
- a time), or the day by one (if it does not contain a time)."
- (let ((t1 (org-parse-time-string s 'nodefault))
- t2 fmt have-time time)
- (if (and (car t1) (nth 1 t1) (nth 2 t1))
- (setq t2 t1 have-time t)
- (setq t2 (org-parse-time-string s)))
- (let ((s (car t2)) (mi (nth 1 t2)) (h (nth 2 t2))
- (d (nth 3 t2)) (m (nth 4 t2)) (y (nth 5 t2)))
- (when inc
- (if have-time (setq h (+ 2 h)) (setq d (1+ d))))
- (setq time (encode-time s mi h d m y)))
- (setq fmt (if have-time ":%Y%m%dT%H%M%S" ";VALUE=DATE:%Y%m%d"))
- (concat keyword (format-time-string fmt time))))
- ;;; Key bindings
- ;; - Bindings in Org-mode map are currently
- ;; 0123456789abcdefghijklmnopqrstuvwxyz!?@#$%^&-+*/=()_{}[]:;"|,.<>~`'\t the alphabet
- ;; abcd fgh j lmnopqrstuvwxyz!? #$ ^ -+*/= [] ; |,.<>~ '\t necessary bindings
- ;; e (?) useful from outline-mode
- ;; i k @ expendable from outline-mode
- ;; 0123456789 % & ()_{} " ` free
- ;; Make `C-c C-x' a prefix key
- (define-key org-mode-map "\C-c\C-x" (make-sparse-keymap))
- ;; TAB key with modifiers
- (define-key org-mode-map "\C-i" 'org-cycle)
- (define-key org-mode-map [(tab)] 'org-cycle)
- (define-key org-mode-map [(meta tab)] 'org-complete)
- (define-key org-mode-map "\M-\C-i" 'org-complete) ; for tty emacs
- ;; The following line is necessary under Suse GNU/Linux
- (unless (featurep 'xemacs)
- (define-key org-mode-map [S-iso-lefttab] 'org-shifttab))
- (define-key org-mode-map [(shift tab)] 'org-shifttab)
- (define-key org-mode-map (org-key 'S-return) 'org-table-copy-down)
- (define-key org-mode-map "\C-c\C-xc" 'org-table-copy-down) ; tty
- (define-key org-mode-map [(meta shift return)] 'org-insert-todo-heading)
- (define-key org-mode-map "\C-c\C-xM" 'org-insert-todo-heading) ; tty
- (define-key org-mode-map [(meta return)] 'org-meta-return)
- (define-key org-mode-map "\C-c\C-xm" 'org-meta-return) ; tty emacs
- (define-key org-mode-map [?\e (return)] 'org-meta-return) ; tty emacs
- ;; Cursor keys with modifiers
- (define-key org-mode-map [(meta left)] 'org-metaleft)
- (define-key org-mode-map [?\e (left)] 'org-metaleft) ; for tty emacs
- (define-key org-mode-map "\C-c\C-xl" 'org-metaleft) ; for tty emacs
- (define-key org-mode-map [(meta right)] 'org-metaright)
- (define-key org-mode-map [?\e (right)] 'org-metaright) ; for tty emacs
- (define-key org-mode-map "\C-c\C-xr" 'org-metaright) ; for tty emacs
- (define-key org-mode-map [(meta up)] 'org-metaup)
- (define-key org-mode-map [?\e (up)] 'org-metaup) ; for tty emacs
- (define-key org-mode-map "\C-c\C-xu" 'org-metaup) ; for tty emacs
- (define-key org-mode-map [(meta down)] 'org-metadown)
- (define-key org-mode-map [?\e (down)] 'org-metadown) ; for tty emacs
- (define-key org-mode-map "\C-c\C-xd" 'org-metadown) ; for tty emacs
- (define-key org-mode-map [(meta shift left)] 'org-shiftmetaleft)
- (define-key org-mode-map "\C-c\C-xL" 'org-shiftmetaleft) ; tty
- (define-key org-mode-map [(meta shift right)] 'org-shiftmetaright)
- (define-key org-mode-map "\C-c\C-xR" 'org-shiftmetaright) ; tty
- (define-key org-mode-map [(meta shift up)] 'org-shiftmetaup)
- (define-key org-mode-map "\C-c\C-xU" 'org-shiftmetaup) ; tty
- (define-key org-mode-map [(meta shift down)] 'org-shiftmetadown)
- (define-key org-mode-map "\C-c\C-xD" 'org-shiftmetadown) ; tty
- (define-key org-mode-map (org-key 'S-up) 'org-shiftup)
- (define-key org-mode-map [?\C-c ?\C-x (up)] 'org-shiftup)
- (define-key org-mode-map (org-key 'S-down) 'org-shiftdown)
- (define-key org-mode-map [?\C-c ?\C-x (down)] 'org-shiftdown)
- (define-key org-mode-map (org-key 'S-left) 'org-shiftleft)
- (define-key org-mode-map [?\C-c ?\C-x (left)] 'org-shiftleft)
- (define-key org-mode-map (org-key 'S-right) 'org-shiftright)
- (define-key org-mode-map [?\C-c ?\C-x (right)] 'org-shiftright)
- ;; All the other keys
- (define-key org-mode-map "\C-c$" 'org-archive-subtree)
- (define-key org-mode-map "\C-c\C-j" 'org-goto)
- (define-key org-mode-map "\C-c\C-t" 'org-todo)
- (define-key org-mode-map "\C-c\C-s" 'org-schedule)
- (define-key org-mode-map "\C-c\C-d" 'org-deadline)
- (define-key org-mode-map "\C-c;" 'org-toggle-comment)
- (define-key org-mode-map "\C-c\C-v" 'org-show-todo-tree)
- (define-key org-mode-map "\C-c\C-w" 'org-check-deadlines)
- (define-key org-mode-map "\C-c/" 'org-occur) ; Minor-mode reserved
- (define-key org-mode-map "\C-c\\" 'org-tags-sparse-tree) ; Minor-mode res.
- (define-key org-mode-map "\C-c\C-m" 'org-insert-heading)
- (define-key org-mode-map "\M-\C-m" 'org-insert-heading)
- (define-key org-mode-map "\C-c\C-l" 'org-insert-link)
- (define-key org-mode-map "\C-c\C-o" 'org-open-at-point)
- (define-key org-mode-map "\C-c%" 'org-mark-ring-push)
- (define-key org-mode-map "\C-c&" 'org-mark-ring-goto)
- (define-key org-mode-map "\C-c\C-z" 'org-time-stamp) ; Alternative binding
- (define-key org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
- (define-key org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
- (define-key org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
- (define-key org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
- (define-key org-mode-map "\C-c>" 'org-goto-calendar)
- (define-key org-mode-map "\C-c<" 'org-date-from-calendar)
- (define-key org-mode-map [(control ?,)] 'org-cycle-agenda-files)
- (define-key org-mode-map "\C-c[" 'org-agenda-file-to-front)
- (define-key org-mode-map "\C-c]" 'org-remove-file)
- (define-key org-mode-map "\C-c\C-r" 'org-timeline)
- (define-key org-mode-map "\C-c-" 'org-table-insert-hline)
- (define-key org-mode-map "\C-c^" 'org-table-sort-lines)
- (define-key org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
- (define-key org-mode-map "\C-m" 'org-return)
- (define-key org-mode-map "\C-c?" 'org-table-current-column)
- (define-key org-mode-map "\C-c " 'org-table-blank-field)
- (define-key org-mode-map "\C-c+" 'org-table-sum)
- (define-key org-mode-map "\C-c|" 'org-table-toggle-vline-visibility)
- (define-key org-mode-map "\C-c=" 'org-table-eval-formula)
- (define-key org-mode-map "\C-c'" 'org-table-edit-formulas)
- (define-key org-mode-map "\C-c*" 'org-table-recalculate)
- (define-key org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
- (define-key org-mode-map "\C-c~" 'org-table-create-with-table.el)
- (define-key org-mode-map "\C-c\C-q" 'org-table-wrap-region)
- (define-key org-mode-map "\C-c\C-xa" 'org-export-as-ascii)
- (define-key org-mode-map "\C-c\C-x\C-a" 'org-export-as-ascii)
- (define-key org-mode-map "\C-c\C-xv" 'org-export-copy-visible)
- (define-key org-mode-map "\C-c\C-x\C-v" 'org-export-copy-visible)
- ;; OPML support is only an option for the future
- ;(define-key org-mode-map "\C-c\C-xo" 'org-export-as-opml)
- ;(define-key org-mode-map "\C-c\C-x\C-o" 'org-export-as-opml)
- (define-key org-mode-map "\C-c\C-xi" 'org-export-icalendar-this-file)
- (define-key org-mode-map "\C-c\C-x\C-i" 'org-export-icalendar-all-agenda-files)
- (define-key org-mode-map "\C-c\C-xc" 'org-export-icalendar-combine-agenda-files)
- (define-key org-mode-map "\C-c\C-x\C-c" 'org-export-icalendar-combine-agenda-files)
- (define-key org-mode-map "\C-c\C-xt" 'org-insert-export-options-template)
- (define-key org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
- (define-key org-mode-map "\C-c\C-xh" 'org-export-as-html)
- (define-key org-mode-map "\C-c\C-xb" 'org-export-as-html-and-open)
- (define-key org-mode-map "\C-c\C-x\C-b" 'org-export-as-html-and-open)
- (define-key org-mode-map "\C-c\C-x\C-k" 'org-cut-special)
- (define-key org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
- (define-key org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
- (define-key org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
- (defsubst org-table-p () (org-at-table-p))
- (defun org-self-insert-command (N)
- "Like `self-insert-command', use overwrite-mode for whitespace in tables.
- If the cursor is in a table looking at whitespace, the whitespace is
- overwritten, and the table is not marked as requiring realignment."
- (interactive "p")
- (if (and (org-table-p)
- (or
- (and org-table-auto-blank-field
- (member last-command
- '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c))
- (org-table-blank-field))
- t)
- (eq N 1)
- (looking-at "[^|\n]* +|"))
- (let (org-table-may-need-update)
- (goto-char (1- (match-end 0)))
- (delete-backward-char 1)
- (goto-char (match-beginning 0))
- (self-insert-command N))
- (setq org-table-may-need-update t)
- (self-insert-command N)))
- ;; FIXME:
- ;; The following two functions might still be optimized to trigger
- ;; re-alignment less frequently.
- (defun org-delete-backward-char (N)
- "Like `delete-backward-char', insert whitespace at field end in tables.
- When deleting backwards, in tables this function will insert whitespace in
- front of the next \"|\" separator, to keep the table aligned. The table will
- still be marked for re-alignment, because a narrow field may lead to a
- reduced column width."
- (interactive "p")
- (if (and (org-table-p)
- (eq N 1)
- (string-match "|" (buffer-substring (point-at-bol) (point)))
- (looking-at ".*?|"))
- (let ((pos (point)))
- (backward-delete-char N)
- (skip-chars-forward "^|")
- (insert " ")
- (goto-char (1- pos)))
- (backward-delete-char N)))
- (defun org-delete-char (N)
- "Like `delete-char', but insert whitespace at field end in tables.
- When deleting characters, in tables this function will insert whitespace in
- front of the next \"|\" separator, to keep the table aligned. The table
- will still be marked for re-alignment, because a narrow field may lead to
- a reduced column width."
- (interactive "p")
- (if (and (org-table-p)
- (not (bolp))
- (not (= (char-after) ?|))
- (eq N 1))
- (if (looking-at ".*?|")
- (let ((pos (point)))
- (replace-match (concat
- (substring (match-string 0) 1 -1)
- " |"))
- (goto-char pos)))
- (delete-char N)))
- ;; How to do this: Measure non-white length of current string
- ;; If equal to column width, we should realign.
- (defun org-remap (map &rest commands)
- "In MAP, remap the functions given in COMMANDS.
- COMMANDS is a list of alternating OLDDEF NEWDEF command names."
- (let (new old)
- (while commands
- (setq old (pop commands) new (pop commands))
- (if (fboundp 'command-remapping)
- (define-key map (vector 'remap old) new)
- (substitute-key-definition old new map global-map)))))
- (when (eq org-enable-table-editor 'optimized)
- ;; If the user wants maximum table support, we need to hijack
- ;; some standard editing functions
- (org-remap org-mode-map
- 'self-insert-command 'org-self-insert-command
- 'delete-char 'org-delete-char
- 'delete-backward-char 'org-delete-backward-char)
- (define-key org-mode-map "|" 'org-force-self-insert))
- (defun org-shiftcursor-error ()
- "Throw an error because Shift-Cursor command was applied in wrong context."
- (error "This command is active in special context like tables, headlines or timestamps"))
- (defun org-shifttab ()
- "Global visibility cycling or move to previous table field.
- Calls `(org-cycle t)' or `org-table-previous-field', depending on context.
- See the individual commands for more information."
- (interactive)
- (cond
- ((org-at-table-p) (org-table-previous-field))
- (t (org-cycle '(4)))))
- (defun org-shiftmetaleft ()
- "Promote subtree or delete table column.
- Calls `org-promote-subtree' or `org-table-delete-column', depending on context.
- See the individual commands for more information."
- (interactive)
- (cond
- ((org-at-table-p) (org-table-delete-column))
- ((org-on-heading-p) (org-promote-subtree))
- ((org-at-item-p) (call-interactively 'org-outdent-item))
- (t (org-shiftcursor-error))))
- (defun org-shiftmetaright ()
- "Demote subtree or insert table column.
- Calls `org-demote-subtree' or `org-table-insert-column', depending on context.
- See the individual commands for more information."
- (interactive)
- (cond
- ((org-at-table-p) (org-table-insert-column))
- ((org-on-heading-p) (org-demote-subtree))
- ((org-at-item-p) (call-interactively 'org-indent-item))
- (t (org-shiftcursor-error))))
- (defun org-shiftmetaup (&optional arg)
- "Move subtree up or kill table row.
- Calls `org-move-subtree-up' or `org-table-kill-row' or
- `org-move-item-up' depending on context. See the individual commands
- for more information."
- (interactive "P")
- (cond
- ((org-at-table-p) (org-table-kill-row))
- ((org-on-heading-p) (org-move-subtree-up arg))
- ((org-at-item-p) (org-move-item-up arg))
- (t (org-shiftcursor-error))))
- (defun org-shiftmetadown (&optional arg)
- "Move subtree down or insert table row.
- Calls `org-move-subtree-down' or `org-table-insert-row' or
- `org-move-item-down', depending on context. See the individual
- commands for more information."
- (interactive "P")
- (cond
- ((org-at-table-p) (org-table-insert-row arg))
- ((org-on-heading-p) (org-move-subtree-down arg))
- ((org-at-item-p) (org-move-item-down arg))
- (t (org-shiftcursor-error))))
- (defun org-metaleft (&optional arg)
- "Promote heading or move table column to left.
- Calls `org-do-promote' or `org-table-move-column', depending on context.
- With no specific context, calls the Emacs default `backward-word'.
- See the individual commands for more information."
- (interactive "P")
- (cond
- ((org-at-table-p) (org-table-move-column 'left))
- ((or (org-on-heading-p) (org-region-active-p)) (org-do-promote))
- (t (backward-word (prefix-numeric-value arg)))))
- (defun org-metaright (&optional arg)
- "Demote subtree or move table column to right.
- Calls `org-do-demote' or `org-table-move-column', depending on context.
- With no specific context, calls the Emacs default `forward-word'.
- See the individual commands for more information."
- (interactive "P")
- (cond
- ((org-at-table-p) (org-table-move-column nil))
- ((or (org-on-heading-p) (org-region-active-p)) (org-do-demote))
- (t (forward-word (prefix-numeric-value arg)))))
- (defun org-metaup (&optional arg)
- "Move subtree up or move table row up.
- Calls `org-move-subtree-up' or `org-table-move-row' or
- `org-move-item-up', depending on context. See the individual commands
- for more information."
- (interactive "P")
- (cond
- ((org-at-table-p) (org-table-move-row 'up))
- ((org-on-heading-p) (org-move-subtree-up arg))
- ((org-at-item-p) (org-move-item-up arg))
- (t (org-shiftcursor-error))))
- (defun org-metadown (&optional arg)
- "Move subtree down or move table row down.
- Calls `org-move-subtree-down' or `org-table-move-row' or
- `org-move-item-down', depending on context. See the individual
- commands for more information."
- (interactive "P")
- (cond
- ((org-at-table-p) (org-table-move-row nil))
- ((org-on-heading-p) (org-move-subtree-down arg))
- ((org-at-item-p) (org-move-item-down arg))
- (t (org-shiftcursor-error))))
- (defun org-shiftup (&optional arg)
- "Increase item in timestamp or increase priority of current item.
- Calls `org-timestamp-up' or `org-priority-up', depending on context.
- See the individual commands for more information."
- (interactive "P")
- (cond
- ((org-at-timestamp-p) (org-timestamp-up arg))
- (t (org-priority-up))))
- (defun org-shiftdown (&optional arg)
- "Decrease item in timestamp or decrease priority of current item.
- Calls `org-timestamp-down' or `org-priority-down', depending on context.
- See the individual commands for more information."
- (interactive "P")
- (cond
- ((org-at-timestamp-p) (org-timestamp-down arg))
- (t (org-priority-down))))
- (defun org-shiftright ()
- "Next TODO keyword or timestamp one day later, depending on context."
- (interactive)
- (cond
- ((org-at-timestamp-p) (org-timestamp-up-day))
- ((org-on-heading-p) (org-todo 'right))
- (t (org-shiftcursor-error))))
- (defun org-shiftleft ()
- "Previous TODO keyword or timestamp one day earlier, depending on context."
- (interactive)
- (cond
- ((org-at-timestamp-p) (org-timestamp-down-day))
- ((org-on-heading-p) (org-todo 'left))
- (t (org-shiftcursor-error))))
- (defun org-copy-special ()
- "Copy region in table or copy current subtree.
- Calls `org-table-copy' or `org-copy-subtree', depending on context.
- See the individual commands for more information."
- (interactive)
- (call-interactively
- (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
- (defun org-cut-special ()
- "Cut region in table or cut current subtree.
- Calls `org-table-copy' or `org-cut-subtree', depending on context.
- See the individual commands for more information."
- (interactive)
- (call-interactively
- (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
- (defun org-paste-special (arg)
- "Paste rectangular region into table, or past subtree relative to level.
- Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
- See the individual commands for more information."
- (interactive "P")
- (if (org-at-table-p)
- (org-table-paste-rectangle)
- (org-paste-subtree arg)))
- (defun org-ctrl-c-ctrl-c (&optional arg)
- "Call realign table, or recognize a table.el table, or update keywords.
- When the cursor is inside a table created by the table.el package,
- activate that table. Otherwise, if the cursor is at a normal table
- created with org.el, re-align that table. This command works even if
- the automatic table editor has been turned off.
- If the cursor is in a headline, prompt for tags and insert them into
- the current line, aligned to `org-tags-column'. When in a headline and
- called with prefix arg, realign all tags in the current buffer.
- If the cursor is in one of the special #+KEYWORD lines, this triggers
- scanning the buffer for these lines and updating the information.
- If the cursor is on a #+TBLFM line, re-apply the formulae to the table."
- (interactive "P")
- (let ((org-enable-table-editor t))
- (cond
- ((and (boundp 'remember-buffer) (equal (buffer-name) remember-buffer))
- (remember-buffer))
- ((org-on-target-p) (org-update-radio-target-regexp))
- ((org-on-heading-p) (org-set-tags arg))
- ((org-at-table.el-p)
- (require 'table)
- (beginning-of-line 1)
- (re-search-forward "|" (save-excursion (end-of-line 2) (point)))
- (table-recognize-table))
- ((org-at-table-p)
- (org-table-maybe-eval-formula)
- (if arg
- (org-table-recalculate t)
- (org-table-maybe-recalculate-line))
- (org-table-align))
- ((org-at-item-p)
- (org-renumber-ordered-list (prefix-numeric-value arg)))
- ((save-excursion (beginning-of-line 1) (looking-at "#\\+\\([A-Z]+\\)"))
- (cond
- ((equal (match-string 1) "TBLFM")
- ;; Recalculate the table before this line
- (save-excursion
- (beginning-of-line 1)
- (skip-chars-backward " \r\n\t")
- (if (org-at-table-p) (org-table-recalculate t))))
- (t
- (org-mode-restart))))
- ((org-region-active-p)
- (org-table-convert-region (region-beginning) (region-end) arg))
- ((condition-case nil
- (and (region-beginning) (region-end))
- (error nil))
- (if (y-or-n-p "Convert inactive region to table? ")
- (org-table-convert-region (region-beginning) (region-end) arg)
- (error "Abort")))
- (t (error "C-c C-c can do nothing useful at this location.")))))
- (defun org-mode-restart ()
- "Restart Org-mode, to scan again for special lines.
- Also updates the keyword regular expressions."
- (interactive)
- (let ((org-inhibit-startup t)) (org-mode))
- (message "Org-mode restarted to refresh keyword and special line setup"))
- (defun org-return ()
- "Goto next table row or insert a newline.
- Calls `org-table-next-row' or `newline', depending on context.
- See the individual commands for more information."
- (interactive)
- (cond
- ((org-at-table-p)
- (org-table-justify-field-maybe)
- (org-table-next-row))
- (t (newline))))
- (defun org-meta-return (&optional arg)
- "Insert a new heading or wrap a region in a table.
- Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
- See the individual commands for more information."
- (interactive "P")
- (cond
- ((org-at-table-p)
- (org-table-wrap-region arg))
- (t (org-insert-heading arg))))
- ;;; Menu entries
- ;; Define the Org-mode menus
- (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
- '("Tbl"
- ["Align" org-ctrl-c-ctrl-c (org-at-table-p)]
- ["Next Field" org-cycle (org-at-table-p)]
- ["Previous Field" org-shifttab (org-at-table-p)]
- ["Next Row" org-return (org-at-table-p)]
- "--"
- ["Blank Field" org-table-blank-field (org-at-table-p)]
- ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
- "--"
- ("Column"
- ["Move Column Left" org-metaleft (org-at-table-p)]
- ["Move Column Right" org-metaright (org-at-table-p)]
- ["Delete Column" org-shiftmetaleft (org-at-table-p)]
- ["Insert Column" org-shiftmetaright (org-at-table-p)])
- ("Row"
- ["Move Row Up" org-metaup (org-at-table-p)]
- ["Move Row Down" org-metadown (org-at-table-p)]
- ["Delete Row" org-shiftmetaup (org-at-table-p)]
- ["Insert Row" org-shiftmetadown (org-at-table-p)]
- ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
- "--"
- ["Insert Hline" org-table-insert-hline (org-at-table-p)])
- ("Rectangle"
- ["Copy Rectangle" org-copy-special (org-at-table-p)]
- ["Cut Rectangle" org-cut-special (org-at-table-p)]
- ["Paste Rectangle" org-paste-special (org-at-table-p)]
- ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
- "--"
- ("Calculate"
- ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
- ["Set Named Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
- ["Edit Formulas" org-table-edit-formulas (org-at-table-p)]
- "--"
- ["Recalculate line" org-table-recalculate (org-at-table-p)]
- ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
- ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
- "--"
- ["Sum Column/Rectangle" org-table-sum
- (or (org-at-table-p) (org-region-active-p))]
- ["Which Column?" org-table-current-column (org-at-table-p)])
- ["Debug Formulas"
- (setq org-table-formula-debug (not org-table-formula-debug))
- :style toggle :selected org-table-formula-debug]
- "--"
- ["Invisible Vlines" org-table-toggle-vline-visibility
- :style toggle :selected (org-in-invisibility-spec-p '(org-table))]
- "--"
- ["Create" org-table-create (and (not (org-at-table-p))
- org-enable-table-editor)]
- ["Convert Region" org-ctrl-c-ctrl-c (not (org-at-table-p 'any))]
- ["Import from File" org-table-import (not (org-at-table-p))]
- ["Export to File" org-table-export (org-at-table-p)]
- "--"
- ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
- (easy-menu-define org-org-menu org-mode-map "Org menu"
- '("Org"
- ["Cycle Visibility" org-cycle (or (bobp) (outline-on-heading-p))]
- ["Cycle Global Visibility" org-shifttab (not (org-at-table-p))]
- ["Sparse Tree" org-occur t]
- ["Show All" show-all t]
- "--"
- ["New Heading" org-insert-heading t]
- ("Navigate Headings"
- ["Up" outline-up-heading t]
- ["Next" outline-next-visible-heading t]
- ["Previous" outline-previous-visible-heading t]
- ["Next Same Level" outline-forward-same-level t]
- ["Previous Same Level" outline-backward-same-level t]
- "--"
- ["Jump" org-goto t])
- ("Edit Structure"
- ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
- ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
- "--"
- ["Copy Subtree" org-copy-special (not (org-at-table-p))]
- ["Cut Subtree" org-cut-special (not (org-at-table-p))]
- ["Paste Subtree" org-paste-special (not (org-at-table-p))]
- "--"
- ["Promote Heading" org-metaleft (not (org-at-table-p))]
- ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
- ["Demote Heading" org-metaright (not (org-at-table-p))]
- ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
- "--"
- ["Archive Subtree" org-archive-subtree t]
- "--"
- ["Convert to odd levels" org-convert-to-odd-levels t]
- ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
- "--"
- ("TODO Lists"
- ["TODO/DONE/-" org-todo t]
- ["Show TODO Tree" org-show-todo-tree t]
- ["Global TODO list" org-todo-list t]
- "--"
- ["Set Priority" org-priority t]
- ["Priority Up" org-shiftup t]
- ["Priority Down" org-shiftdown t])
- ("Dates and Scheduling"
- ["Timestamp" org-time-stamp t]
- ["Timestamp (inactive)" org-time-stamp-inactive t]
- ("Change Date"
- ["1 Day Later" org-timestamp-up-day t]
- ["1 Day Earlier" org-timestamp-down-day t]
- ["1 ... Later" org-shiftup t]
- ["1 ... Earlier" org-shiftdown t])
- ["Compute Time Range" org-evaluate-time-range t]
- ["Schedule Item" org-schedule t]
- ["Deadline" org-deadline t]
- "--"
- ["Goto Calendar" org-goto-calendar t]
- ["Date from Calendar" org-date-from-calendar t])
- "--"
- ["Agenda Command" org-agenda t]
- ("File List for Agenda")
- ("Special views current file"
- ["TODO Tree" org-show-todo-tree t]
- ["Check Deadlines" org-check-deadlines t]
- ["Timeline" org-timeline t]
- ["Tags Tree" org-tags-sparse-tree t])
- "--"
- ("Hyperlinks"
- ["Store Link (Global)" org-store-link t]
- ["Insert Link" org-insert-link t]
- ["Follow Link" org-open-at-point t])
- "--"
- ("Export"
- ["ASCII" org-export-as-ascii t]
- ["Extract Visible Text" org-export-copy-visible t]
- ["HTML" org-export-as-html t]
- ["HTML and Open" org-export-as-html-and-open t]
- ; ["OPML" org-export-as-opml nil]
- "--"
- ["iCalendar this file" org-export-icalendar-this-file t]
- ["iCalendar all agenda files" org-export-icalendar-all-agenda-files
- :active t :keys "C-c C-x C-i"]
- ["iCalendar combined" org-export-icalendar-combine-agenda-files t]
- "--"
- ["Option Template" org-insert-export-options-template t]
- ["Toggle Fixed Width" org-toggle-fixed-width-section t])
- "--"
- ("Documentation"
- ["Show Version" org-version t]
- ["Info Documentation" org-info t])
- ("Customize"
- ["Browse Org Group" org-customize t]
- "--"
- ["Build Full Customize Menu" org-create-customize-menu
- (fboundp 'customize-menu-create)])
- "--"
- ["Refresh setup" org-mode-restart t]
- ))
- (defun org-info (&optional node)
- "Read documentation for Org-mode in the info system.
- With optional NODE, go directly to that node."
- (interactive)
- (require 'info)
- (Info-goto-node (format "(org)%s" (or node ""))))
- (defun org-install-agenda-files-menu ()
- (let ((bl (buffer-list)))
- (save-excursion
- (while bl
- (set-buffer (pop bl))
- (if (eq major-mode 'org-mode) (setq bl nil)))
- (when (eq major-mode 'org-mode)
- (easy-menu-change
- '("Org") "File List for Agenda"
- (append
- (list
- ["Edit File List" (org-edit-agenda-file-list) t]
- ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
- ["Remove Current File from List" org-remove-file t]
- ["Cycle through agenda files" org-cycle-agenda-files t]
- "--")
- (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
- ;;; Documentation
- (defun org-customize ()
- "Call the customize function with org as argument."
- (interactive)
- (customize-browse 'org))
- (defun org-create-customize-menu ()
- "Create a full customization menu for Org-mode, insert it into the menu."
- (interactive)
- (if (fboundp 'customize-menu-create)
- (progn
- (easy-menu-change
- '("Org") "Customize"
- `(["Browse Org group" org-customize t]
- "--"
- ,(customize-menu-create 'org)
- ["Set" Custom-set t]
- ["Save" Custom-save t]
- ["Reset to Current" Custom-reset-current t]
- ["Reset to Saved" Custom-reset-saved t]
- ["Reset to Standard Settings" Custom-reset-standard t]))
- (message "\"Org\"-menu now contains full customization menu"))
- (error "Cannot expand menu (outdated version of cus-edit.el)")))
- ;;; Miscellaneous stuff
- (defun org-move-line-down (arg)
- "Move the current line down. With prefix argument, move it past ARG lines."
- (interactive "p")
- (let ((col (current-column))
- beg end pos)
- (beginning-of-line 1) (setq beg (point))
- (beginning-of-line 2) (setq end (point))
- (beginning-of-line (+ 1 arg))
- (setq pos (move-marker (make-marker) (point)))
- (insert (delete-and-extract-region beg end))
- (goto-char pos)
- (move-to-column col)))
- (defun org-move-line-up (arg)
- "Move the current line up. With prefix argument, move it past ARG lines."
- (interactive "p")
- (let ((col (current-column))
- beg end pos)
- (beginning-of-line 1) (setq beg (point))
- (beginning-of-line 2) (setq end (point))
- (beginning-of-line (- arg))
- (setq pos (move-marker (make-marker) (point)))
- (insert (delete-and-extract-region beg end))
- (goto-char pos)
- (move-to-column col)))
- ;; Paragraph filling stuff.
- ;; We want this to be just right, so use the full arsenal.
- ;; FIXME: This very likely does not work correctly for XEmacs, because the
- ;; filladapt package works slightly differently.
- (defun org-set-autofill-regexps ()
- (interactive)
- ;; In the paragraph separator we include headlines, because filling
- ;; text in a line directly attached to a headline would otherwise
- ;; fill the headline as well.
- (set (make-local-variable 'paragraph-separate) "\f\\|\\*\\|[ ]*$\\|[ \t]*[:|]")
- ;; The paragraph starter includes hand-formatted lists.
- (set (make-local-variable 'paragraph-start)
- "\f\\|[ ]*$\\|\\([*\f]+\\)\\|[ \t]*\\([-+*]\\|[0-9]+[.)][ \t]+\\)\\|[ \t]*[:|]")
- ;; Inhibit auto-fill for headers, tables and fixed-width lines.
- ;; But only if the user has not turned off tables or fixed-width regions
- (set (make-local-variable 'auto-fill-inhibit-regexp)
- (concat "\\*\\|#"
- (if (or org-enable-table-editor org-enable-fixed-width-editor)
- (concat
- "\\|[ \t]*["
- (if org-enable-table-editor "|" "")
- (if org-enable-fixed-width-editor ":" "")
- "]"))))
- ;; We use our own fill-paragraph function, to make sure that tables
- ;; and fixed-width regions are not wrapped. That function will pass
- ;; through to `fill-paragraph' when appropriate.
- (set (make-local-variable 'fill-paragraph-function) 'org-fill-paragraph)
- ;; Adaptive filling: To get full control, first make sure that
- ;; `adaptive-fill-regexp' never matches. Then install our won matcher.
- (setq adaptive-fill-regexp "\000")
- (setq adaptive-fill-function 'org-adaptive-fill-function))
- (defun org-fill-paragraph (&optional justify)
- "Re-align a table, pass through to fill-paragraph if no table."
- (let ((table-p (org-at-table-p))
- (table.el-p (org-at-table.el-p)))
- (cond ((equal (char-after (point-at-bol)) ?*) t) ; skip headlines
- (table.el-p t) ; skip table.el tables
- (table-p (org-table-align) t) ; align org-mode tables
- (t nil)))) ; call paragraph-fill
- ;; For reference, this is the default value of adaptive-fill-regexp
- ;; "[ \t]*\\([-|#;>*]+[ \t]*\\|(?[0-9]+[.)][ \t]*\\)*"
- (defun org-adaptive-fill-function ()
- "Return a fill prefix for org-mode files.
- In particular, this makes sure hanging paragraphs for hand-formatted lists
- work correctly."
- (if (looking-at " *\\([-*+] \\|[0-9]+[.)] \\)?")
- (make-string (- (match-end 0) (match-beginning 0)) ?\ )))
- ;; Functions needed for Emacs/XEmacs region compatibility
- (defun org-add-hook (hook function &optional append local)
- "Add-hook, compatible with both Emacsen."
- (if (and local (featurep 'xemacs))
- (add-local-hook hook function append)
- (add-hook hook function append local)))
- (defun org-region-active-p ()
- "Is `transient-mark-mode' on and the region active?
- Works on both Emacs and XEmacs."
- (if org-ignore-region
- nil
- (if (featurep 'xemacs)
- (and zmacs-regions (region-active-p))
- (and transient-mark-mode mark-active))))
- (defun org-add-to-invisibility-spec (arg)
- "Add elements to `buffer-invisibility-spec'.
- See documentation for `buffer-invisibility-spec' for the kind of elements
- that can be added."
- (cond
- ((fboundp 'add-to-invisibility-spec)
- (add-to-invisibility-spec arg))
- ((or (null buffer-invisibility-spec) (eq buffer-invisibility-spec t))
- (setq buffer-invisibility-spec (list arg)))
- (t
- (setq buffer-invisibility-spec
- (cons arg buffer-invisibility-spec)))))
- (defun org-remove-from-invisibility-spec (arg)
- "Remove elements from `buffer-invisibility-spec'."
- (if (fboundp 'remove-from-invisibility-spec)
- (remove-from-invisibility-spec arg)
- (if (consp buffer-invisibility-spec)
- (setq buffer-invisibility-spec
- (delete arg buffer-invisibility-spec)))))
- (defun org-in-invisibility-spec-p (arg)
- "Is ARG a member of `buffer-invisibility-spec'?"
- (if (consp buffer-invisibility-spec)
- (member arg buffer-invisibility-spec)
- nil))
- (defun org-image-file-name-regexp ()
- "Return regexp matching the file names of images."
- (if (fboundp 'image-file-name-regexp)
- (image-file-name-regexp)
- (let ((image-file-name-extensions
- '("png" "jpeg" "jpg" "gif" "tiff" "tif"
- "xbm" "xpm" "pbm" "pgm" "ppm")))
- (concat "\\."
- (regexp-opt (nconc (mapcar 'upcase
- image-file-name-extensions)
- image-file-name-extensions)
- t)
- "\\'"))))
- ;; Functions needed for compatibility with old outline.el.
- ;; Programming for the old outline.el (that uses selective display
- ;; instead of `invisible' text properties) is a nightmare, mostly
- ;; because regular expressions can no longer be anchored at
- ;; beginning/end of line. Therefore a number of function need special
- ;; treatment when the old outline.el is being used.
- ;; The following functions capture almost the entire compatibility code
- ;; between the different versions of outline-mode. The only other
- ;; places where this is important are the font-lock-keywords, and in
- ;; `org-export-copy-visible'. Search for `org-noutline-p' to find them.
- ;; C-a should go to the beginning of a *visible* line, also in the
- ;; new outline.el. I guess this should be patched into Emacs?
- (defun org-beginning-of-line ()
- "Go to the beginning of the current line. If that is invisible, continue
- to a visible line beginning. This makes the function of C-a more intuitive."
- (interactive)
- (beginning-of-line 1)
- (if (bobp)
- nil
- (backward-char 1)
- (if (org-invisible-p)
- (while (and (not (bobp)) (org-invisible-p))
- (backward-char 1)
- (beginning-of-line 1))
- (forward-char 1))))
- (when org-noutline-p
- (define-key org-mode-map "\C-a" 'org-beginning-of-line))
- ;; FIXME: should I use substitute-key-definition to reach other bindings
- ;; of beginning-of-line?
- (defun org-invisible-p ()
- "Check if point is at a character currently not visible."
- (if org-noutline-p
- ;; Early versions of noutline don't have `outline-invisible-p'.
- (if (fboundp 'outline-invisible-p)
- (outline-invisible-p)
- (get-char-property (point) 'invisible))
- (save-excursion
- (skip-chars-backward "^\r\n")
- (equal (char-before) ?\r))))
- (defun org-invisible-p2 ()
- "Check if point is at a character currently not visible."
- (save-excursion
- (if org-noutline-p
- (progn
- (if (and (eolp) (not (bobp))) (backward-char 1))
- ;; Early versions of noutline don't have `outline-invisible-p'.
- (if (fboundp 'outline-invisible-p)
- (outline-invisible-p)
- (get-char-property (point) 'invisible)))
- (skip-chars-backward "^\r\n")
- (equal (char-before) ?\r))))
- (defun org-back-to-heading (&optional invisible-ok)
- "Move to previous heading line, or beg of this line if it's a heading.
- Only visible heading lines are considered, unless INVISIBLE-OK is non-nil."
- (if org-noutline-p
- (outline-back-to-heading invisible-ok)
- (if (and (memq (char-before) '(?\n ?\r))
- (looking-at outline-regexp))
- t
- (if (re-search-backward (concat (if invisible-ok "\\([\r\n]\\|^\\)" "^")
- outline-regexp)
- nil t)
- (if invisible-ok
- (progn (goto-char (match-end 1))
- (looking-at outline-regexp)))
- (error "Before first heading")))))
- (defun org-on-heading-p (&optional invisible-ok)
- "Return t if point is on a (visible) heading line.
- If INVISIBLE-OK is non-nil, an invisible heading line is ok too."
- (if org-noutline-p
- (outline-on-heading-p 'invisible-ok)
- (save-excursion
- (skip-chars-backward "^\n\r")
- (and (looking-at outline-regexp)
- (or invisible-ok
- (bobp)
- (equal (char-before) ?\n))))))
- (defun org-on-target-p ()
- (let ((pos (point)))
- (save-excursion
- (skip-chars-forward "<")
- (and (re-search-backward "<<" nil t)
- (or (looking-at org-target-regexp)
- (looking-at org-radio-target-regexp))
- (<= (match-beginning 0) pos)
- (>= (match-end 0) pos)))))
- (defun org-up-heading-all (arg)
- "Move to the heading line of which the present line is a subheading.
- This function considers both visible and invisible heading lines.
- With argument, move up ARG levels."
- (if org-noutline-p
- (if (fboundp 'outline-up-heading-all)
- (outline-up-heading-all arg) ; emacs 21 version of outline.el
- (outline-up-heading arg t)) ; emacs 22 version of outline.el
- (org-back-to-heading t)
- (looking-at outline-regexp)
- (if (<= (- (match-end 0) (match-beginning 0)) arg)
- (error "Cannot move up %d levels" arg)
- (re-search-backward
- (concat "[\n\r]" (regexp-quote
- (make-string (- (match-end 0) (match-beginning 0) arg)
- ?*))
- "[^*]"))
- (forward-char 1))))
- (defun org-show-hidden-entry ()
- "Show an entry where even the heading is hidden."
- (save-excursion
- (if (not org-noutline-p)
- (progn
- (org-back-to-heading t)
- (org-flag-heading nil)))
- (org-show-entry)))
- (defun org-check-occur-regexp (regexp)
- "If REGEXP starts with \"^\", modify it to check for \\r as well.
- Of course, only for the old outline mode."
- (if org-noutline-p
- regexp
- (if (string-match "^\\^" regexp)
- (concat "[\n\r]" (substring regexp 1))
- regexp)))
- (defun org-flag-heading (flag &optional entry)
- "Flag the current heading. FLAG non-nil means make invisible.
- When ENTRY is non-nil, show the entire entry."
- (save-excursion
- (org-back-to-heading t)
- (if (not org-noutline-p)
- ;; Make the current headline visible
- (outline-flag-region (max 1 (1- (point))) (point) (if flag ?\r ?\n)))
- ;; Check if we should show the entire entry
- (if entry
- (progn
- (org-show-entry)
- (save-excursion ;; FIXME: Is this the fix for points in the -|
- ;; middle of text? |
- (and (outline-next-heading) ;; |
- (org-flag-heading nil)))) ; show the next heading _|
- (outline-flag-region (max 1 (1- (point)))
- (save-excursion (outline-end-of-heading) (point))
- (if org-noutline-p
- flag
- (if flag ?\r ?\n))))))
- (defun org-end-of-subtree (&optional invisible-OK)
- ;; This is an exact copy of the original function, but it uses
- ;; `org-back-to-heading', to make it work also in invisible
- ;; trees. And is uses an invisible-OK argument.
- ;; Under Emacs this is not needed, but the old outline.el needs this fix.
- (org-back-to-heading invisible-OK)
- (let ((first t)
- (level (funcall outline-level)))
- (while (and (not (eobp))
- (or first (> (funcall outline-level) level)))
- (setq first nil)
- (outline-next-heading))
- (if (memq (preceding-char) '(?\n ?\^M))
- (progn
- ;; Go to end of line before heading
- (forward-char -1)
- (if (memq (preceding-char) '(?\n ?\^M))
- ;; leave blank line before heading
- (forward-char -1))))))
- (defun org-show-subtree ()
- "Show everything after this heading at deeper levels."
- (outline-flag-region
- (point)
- (save-excursion
- (outline-end-of-subtree) (outline-next-heading) (point))
- (if org-noutline-p nil ?\n)))
- (defun org-show-entry ()
- "Show the body directly following this heading.
- Show the heading too, if it is currently invisible."
- (interactive)
- (save-excursion
- (org-back-to-heading t)
- (outline-flag-region
- (1- (point))
- (save-excursion
- (re-search-forward (concat "[\r\n]\\(" outline-regexp "\\)") nil 'move)
- (or (match-beginning 1) (point-max)))
- (if org-noutline-p nil ?\n))))
- (defun org-make-options-regexp (kwds)
- "Make a regular expression for keyword lines."
- (concat
- (if org-noutline-p "^" "[\n\r]")
- "#?[ \t]*\\+\\("
- (mapconcat 'regexp-quote kwds "\\|")
- "\\):[ \t]*"
- (if org-noutline-p "\\(.+\\)" "\\([^\n\r]+\\)")))
- ;; Make `bookmark-jump' show the jump location if it was hidden.
- (eval-after-load "bookmark"
- '(if (boundp 'bookmark-after-jump-hook)
- ;; We can use the hook
- (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
- ;; Hook not available, use advice
- (defadvice bookmark-jump (after org-make-visible activate)
- "Make the position visible."
- (org-bookmark-jump-unhide))))
- (defun org-bookmark-jump-unhide ()
- "Unhide the current position, to show the bookmark location."
- (and (eq major-mode 'org-mode)
- (or (org-invisible-p)
- (save-excursion (goto-char (max (point-min) (1- (point))))
- (org-invisible-p)))
- (org-show-hierarchy-above)))
- ;;; Finish up
- (provide 'org)
- (run-hooks 'org-load-hook)
- ;; Experimental code
- ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
- ;;; org.el ends here
|