org-table.el 218 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909
  1. ;;; org-table.el --- The Table Editor for Org -*- lexical-binding: t; -*-
  2. ;; Copyright (C) 2004-2018 Free Software Foundation, Inc.
  3. ;; Author: Carsten Dominik <carsten at orgmode dot org>
  4. ;; Keywords: outlines, hypermedia, calendar, wp
  5. ;; Homepage: https://orgmode.org
  6. ;;
  7. ;; This file is part of GNU Emacs.
  8. ;;
  9. ;; GNU Emacs is free software: you can redistribute it and/or modify
  10. ;; it under the terms of the GNU General Public License as published by
  11. ;; the Free Software Foundation, either version 3 of the License, or
  12. ;; (at your option) any later version.
  13. ;; GNU Emacs is distributed in the hope that it will be useful,
  14. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. ;; GNU General Public License for more details.
  17. ;; You should have received a copy of the GNU General Public License
  18. ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
  19. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  20. ;;
  21. ;;; Commentary:
  22. ;; This file contains the table editor and spreadsheet for Org mode.
  23. ;; Watch out: Here we are talking about two different kind of tables.
  24. ;; Most of the code is for the tables created with the Org mode table editor.
  25. ;; Sometimes, we talk about tables created and edited with the table.el
  26. ;; Emacs package. We call the former org-type tables, and the latter
  27. ;; table.el-type tables.
  28. ;;; Code:
  29. (require 'cl-lib)
  30. (require 'org)
  31. (declare-function org-element-at-point "org-element" ())
  32. (declare-function org-element-contents "org-element" (element))
  33. (declare-function org-element-extract-element "org-element" (element))
  34. (declare-function org-element-interpret-data "org-element" (data))
  35. (declare-function org-element-lineage "org-element"
  36. (blob &optional types with-self))
  37. (declare-function org-element-map "org-element"
  38. (data types fun
  39. &optional info first-match no-recursion with-affiliated))
  40. (declare-function org-element-parse-buffer "org-element"
  41. (&optional granularity visible-only))
  42. (declare-function org-element-property "org-element" (property element))
  43. (declare-function org-element-type "org-element" (element))
  44. (declare-function org-export-create-backend "ox" (&rest rest) t)
  45. (declare-function org-export-data-with-backend "ox" (data backend info))
  46. (declare-function org-export-filter-apply-functions "ox"
  47. (filters value info))
  48. (declare-function org-export-first-sibling-p "ox" (blob info))
  49. (declare-function org-export-get-backend "ox" (name))
  50. (declare-function org-export-get-environment "ox"
  51. (&optional backend subtreep ext-plist))
  52. (declare-function org-export-install-filters "ox" (info))
  53. (declare-function org-export-table-has-special-column-p "ox" (table))
  54. (declare-function org-export-table-row-is-special-p "ox" (table-row info))
  55. (declare-function calc-eval "calc" (str &optional separator &rest args))
  56. (defvar constants-unit-system)
  57. (defvar org-element-use-cache)
  58. (defvar org-export-filters-alist)
  59. (defvar org-table-follow-field-mode)
  60. (defvar orgtbl-mode) ; defined below
  61. (defvar orgtbl-mode-menu) ; defined when orgtbl mode get initialized
  62. (defvar sort-fold-case)
  63. (defvar orgtbl-after-send-table-hook nil
  64. "Hook for functions attaching to `C-c C-c', if the table is sent.
  65. This can be used to add additional functionality after the table is sent
  66. to the receiver position, otherwise, if table is not sent, the functions
  67. are not run.")
  68. (defvar org-table-TBLFM-begin-regexp "^[ \t]*|.*\n[ \t]*#\\+TBLFM: ")
  69. (defcustom orgtbl-optimized t
  70. "Non-nil means use the optimized table editor version for `orgtbl-mode'.
  71. In the optimized version, the table editor takes over all simple keys that
  72. normally just insert a character. In tables, the characters are inserted
  73. in a way to minimize disturbing the table structure (i.e. in overwrite mode
  74. for empty fields). Outside tables, the correct binding of the keys is
  75. restored.
  76. Changing this variable requires a restart of Emacs to become
  77. effective."
  78. :group 'org-table
  79. :type 'boolean)
  80. (defcustom orgtbl-radio-table-templates
  81. '((latex-mode "% BEGIN RECEIVE ORGTBL %n
  82. % END RECEIVE ORGTBL %n
  83. \\begin{comment}
  84. #+ORGTBL: SEND %n orgtbl-to-latex :splice nil :skip 0
  85. | | |
  86. \\end{comment}\n")
  87. (texinfo-mode "@c BEGIN RECEIVE ORGTBL %n
  88. @c END RECEIVE ORGTBL %n
  89. @ignore
  90. #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
  91. | | |
  92. @end ignore\n")
  93. (html-mode "<!-- BEGIN RECEIVE ORGTBL %n -->
  94. <!-- END RECEIVE ORGTBL %n -->
  95. <!--
  96. #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
  97. | | |
  98. -->\n")
  99. (org-mode "#+ BEGIN RECEIVE ORGTBL %n
  100. #+ END RECEIVE ORGTBL %n
  101. #+ORGTBL: SEND %n orgtbl-to-orgtbl :splice nil :skip 0
  102. | | |
  103. "))
  104. "Templates for radio tables in different major modes.
  105. Each template must define lines that will be treated as a comment and that
  106. must contain the \"BEGIN RECEIVE ORGTBL %n\" and \"END RECEIVE ORGTBL\"
  107. lines where \"%n\" will be replaced with the name of the table during
  108. insertion of the template. The transformed table will later be inserted
  109. between these lines.
  110. The template should also contain a minimal table in a multiline comment.
  111. If multiline comments are not possible in the buffer language,
  112. you can pack it into a string that will not be used when the code
  113. is compiled or executed. Above the table will you need a line with
  114. the fixed string \"#+ORGTBL: SEND\", followed by instruction on how to
  115. convert the table into a data structure useful in the
  116. language of the buffer. Check the manual for the section on
  117. \"Translator functions\", and more generally check out
  118. the Info node `(org)Tables in arbitrary syntax'.
  119. All occurrences of %n in a template will be replaced with the name of the
  120. table, obtained by prompting the user."
  121. :group 'org-table
  122. :type '(repeat
  123. (list (symbol :tag "Major mode")
  124. (string :tag "Format"))))
  125. (defgroup org-table-settings nil
  126. "Settings for tables in Org mode."
  127. :tag "Org Table Settings"
  128. :group 'org-table)
  129. (defcustom org-table-default-size "5x2"
  130. "The default size for newly created tables, Columns x Rows."
  131. :group 'org-table-settings
  132. :type 'string)
  133. (defcustom org-table-number-regexp
  134. "^\\([<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%:]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$"
  135. "Regular expression for recognizing numbers in table columns.
  136. If a table column contains mostly numbers, it will be aligned to the
  137. right. If not, it will be aligned to the left.
  138. The default value of this option is a regular expression which allows
  139. anything which looks remotely like a number as used in scientific
  140. context. For example, all of the following will be considered a
  141. number:
  142. 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
  143. Other options offered by the customize interface are more restrictive."
  144. :group 'org-table-settings
  145. :type '(choice
  146. (const :tag "Positive Integers"
  147. "^[0-9]+$")
  148. (const :tag "Integers"
  149. "^[-+]?[0-9]+$")
  150. (const :tag "Floating Point Numbers"
  151. "^[-+]?\\([0-9]*\\.[0-9]+\\|[0-9]+\\.[0-9]*\\)$")
  152. (const :tag "Floating Point Number or Integer"
  153. "^[-+]?\\([0-9]*\\.[0-9]+\\|[0-9]+\\.?[0-9]*\\)$")
  154. (const :tag "Exponential, Floating point, Integer"
  155. "^[-+]?[0-9.]+\\([eEdD][-+0-9]+\\)?$")
  156. (const :tag "Very General Number-Like, including hex and Calc radix"
  157. "^\\([<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$")
  158. (const :tag "Very General Number-Like, including hex and Calc radix, allows comma as decimal mark"
  159. "^\\([<>]?[-+^.,0-9]*[0-9][-+^.0-9eEdDx()%]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$")
  160. (string :tag "Regexp:")))
  161. (defcustom org-table-number-fraction 0.5
  162. "Fraction of numbers in a column required to make the column align right.
  163. In a column all non-white fields are considered. If at least
  164. this fraction of fields is matched by `org-table-number-regexp',
  165. alignment to the right border applies."
  166. :group 'org-table-settings
  167. :type 'number)
  168. (defgroup org-table-editing nil
  169. "Behavior of tables during editing in Org mode."
  170. :tag "Org Table Editing"
  171. :group 'org-table)
  172. (defcustom org-table-automatic-realign t
  173. "Non-nil means automatically re-align table when pressing TAB or RETURN.
  174. When nil, aligning is only done with `\\[org-table-align]', or after column
  175. removal/insertion."
  176. :group 'org-table-editing
  177. :type 'boolean)
  178. (defcustom org-table-auto-blank-field t
  179. "Non-nil means automatically blank table field when starting to type into it.
  180. This only happens when typing immediately after a field motion
  181. command (TAB, S-TAB or RET)."
  182. :group 'org-table-editing
  183. :type 'boolean)
  184. (defcustom org-table-exit-follow-field-mode-when-leaving-table t
  185. "Non-nil means automatically exit the follow mode.
  186. When nil, the follow mode will stay on and be active in any table
  187. the cursor enters. Since the table follow filed mode messes with the
  188. window configuration, it is not recommended to set this variable to nil,
  189. except maybe locally in a special file that has mostly tables with long
  190. fields."
  191. :group 'org-table
  192. :version "24.1"
  193. :type 'boolean)
  194. (defcustom org-table-fix-formulas-confirm nil
  195. "Whether the user should confirm when Org fixes formulas."
  196. :group 'org-table-editing
  197. :version "24.1"
  198. :type '(choice
  199. (const :tag "with yes-or-no" yes-or-no-p)
  200. (const :tag "with y-or-n" y-or-n-p)
  201. (const :tag "no confirmation" nil)))
  202. (defcustom org-table-tab-jumps-over-hlines t
  203. "Non-nil means tab in the last column of a table with jump over a hline.
  204. If a horizontal separator line is following the current line,
  205. `org-table-next-field' can either create a new row before that line, or jump
  206. over the line. When this option is nil, a new line will be created before
  207. this line."
  208. :group 'org-table-editing
  209. :type 'boolean)
  210. (defgroup org-table-calculation nil
  211. "Options concerning tables in Org mode."
  212. :tag "Org Table Calculation"
  213. :group 'org-table)
  214. (defcustom org-table-use-standard-references 'from
  215. "Non-nil means using table references like B3 instead of @3$2.
  216. Possible values are:
  217. nil never use them
  218. from accept as input, do not present for editing
  219. t accept as input and present for editing"
  220. :group 'org-table-calculation
  221. :type '(choice
  222. (const :tag "Never, don't even check user input for them" nil)
  223. (const :tag "Always, both as user input, and when editing" t)
  224. (const :tag "Convert user input, don't offer during editing" from)))
  225. (defcustom org-table-copy-increment t
  226. "Non-nil means increment when copying current field with \
  227. `\\[org-table-copy-down]'."
  228. :group 'org-table-calculation
  229. :version "26.1"
  230. :package-version '(Org . "8.3")
  231. :type '(choice
  232. (const :tag "Use the difference between the current and the above fields" t)
  233. (integer :tag "Use a number" 1)
  234. (const :tag "Don't increment the value when copying a field" nil)))
  235. (defcustom org-calc-default-modes
  236. '(calc-internal-prec 12
  237. calc-float-format (float 8)
  238. calc-angle-mode deg
  239. calc-prefer-frac nil
  240. calc-symbolic-mode nil
  241. calc-date-format (YYYY "-" MM "-" DD " " Www (" " hh ":" mm))
  242. calc-display-working-message t
  243. )
  244. "List with Calc mode settings for use in `calc-eval' for table formulas.
  245. The list must contain alternating symbols (Calc modes variables and values).
  246. Don't remove any of the default settings, just change the values. Org mode
  247. relies on the variables to be present in the list."
  248. :group 'org-table-calculation
  249. :type 'plist)
  250. (defcustom org-table-duration-custom-format 'hours
  251. "Format for the output of calc computations like $1+$2;t.
  252. The default value is `hours', and will output the results as a
  253. number of hours. Other allowed values are `seconds', `minutes' and
  254. `days', and the output will be a fraction of seconds, minutes or
  255. days. `hh:mm' selects to use hours and minutes, ignoring seconds.
  256. The `U' flag in a table formula will select this specific format for
  257. a single formula."
  258. :group 'org-table-calculation
  259. :version "24.1"
  260. :type '(choice (symbol :tag "Seconds" 'seconds)
  261. (symbol :tag "Minutes" 'minutes)
  262. (symbol :tag "Hours " 'hours)
  263. (symbol :tag "Days " 'days)
  264. (symbol :tag "HH:MM " 'hh:mm)))
  265. (defcustom org-table-duration-hour-zero-padding t
  266. "Non-nil means hours in table duration computations should be zero-padded.
  267. So this is about 08:32:34 versus 8:33:34."
  268. :group 'org-table-calculation
  269. :version "26.1"
  270. :package-version '(Org . "9.1")
  271. :type 'boolean
  272. :safe #'booleanp)
  273. (defcustom org-table-formula-field-format "%s"
  274. "Format for fields which contain the result of a formula.
  275. For example, using \"~%s~\" will display the result within tilde
  276. characters. Beware that modifying the display can prevent the
  277. field from being used in another formula."
  278. :group 'org-table-settings
  279. :version "24.1"
  280. :type 'string)
  281. (defcustom org-table-formula-evaluate-inline t
  282. "Non-nil means TAB and RET evaluate a formula in current table field.
  283. If the current field starts with an equal sign, it is assumed to be a formula
  284. which should be evaluated as described in the manual and in the documentation
  285. string of the command `org-table-eval-formula'. This feature requires the
  286. Emacs calc package.
  287. When this variable is nil, formula calculation is only available through
  288. the command `\\[org-table-eval-formula]'."
  289. :group 'org-table-calculation
  290. :type 'boolean)
  291. (defcustom org-table-formula-use-constants t
  292. "Non-nil means interpret constants in formulas in tables.
  293. A constant looks like `$c' or `$Grav' and will be replaced before evaluation
  294. by the value given in `org-table-formula-constants', or by a value obtained
  295. from the `constants.el' package."
  296. :group 'org-table-calculation
  297. :type 'boolean)
  298. (defcustom org-table-formula-constants nil
  299. "Alist with constant names and values, for use in table formulas.
  300. The car of each element is a name of a constant, without the `$' before it.
  301. The cdr is the value as a string. For example, if you'd like to use the
  302. speed of light in a formula, you would configure
  303. (setq org-table-formula-constants \\='((\"c\" . \"299792458.\")))
  304. and then use it in an equation like `$1*$c'.
  305. Constants can also be defined on a per-file basis using a line like
  306. #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6"
  307. :group 'org-table-calculation
  308. :type '(repeat
  309. (cons (string :tag "name")
  310. (string :tag "value"))))
  311. (defcustom org-table-allow-automatic-line-recalculation t
  312. "Non-nil means lines marked with |#| or |*| will be recomputed automatically.
  313. \\<org-mode-map>\
  314. Automatically means when `TAB' or `RET' or `\\[org-ctrl-c-ctrl-c]' \
  315. are pressed in the line."
  316. :group 'org-table-calculation
  317. :type 'boolean)
  318. (defcustom org-table-relative-ref-may-cross-hline t
  319. "Non-nil means relative formula references may cross hlines.
  320. Here are the allowed values:
  321. nil Relative references may not cross hlines. They will reference the
  322. field next to the hline instead. Coming from below, the reference
  323. will be to the field below the hline. Coming from above, it will be
  324. to the field above.
  325. t Relative references may cross hlines.
  326. error An attempt to cross a hline will throw an error.
  327. It is probably good to never set this variable to nil, for the sake of
  328. portability of tables."
  329. :group 'org-table-calculation
  330. :type '(choice
  331. (const :tag "Allow to cross" t)
  332. (const :tag "Stick to hline" nil)
  333. (const :tag "Error on attempt to cross" error)))
  334. (defcustom org-table-formula-create-columns nil
  335. "Non-nil means evaluation of formula can add new columns.
  336. When non-nil, evaluating an out-of-bounds field can insert as
  337. many columns as needed. When set to `warn', issue a warning when
  338. doing so. When set to `prompt', ask user before creating a new
  339. column. Otherwise, throw an error."
  340. :group 'org-table-calculation
  341. :version "26.1"
  342. :package-version '(Org . "8.3")
  343. :type '(choice
  344. (const :tag "Out-of-bounds field generates an error (default)" nil)
  345. (const :tag "Out-of-bounds field silently adds columns as needed" t)
  346. (const :tag "Out-of-bounds field adds columns, but issues a warning" warn)
  347. (const :tag "Prompt user when setting an out-of-bounds field" prompt)))
  348. (defgroup org-table-import-export nil
  349. "Options concerning table import and export in Org mode."
  350. :tag "Org Table Import Export"
  351. :group 'org-table)
  352. (defcustom org-table-export-default-format "orgtbl-to-tsv"
  353. "Default export parameters for `org-table-export'.
  354. These can be overridden for a specific table by setting the
  355. TABLE_EXPORT_FORMAT property. See the manual section on orgtbl
  356. radio tables for the different export transformations and
  357. available parameters."
  358. :group 'org-table-import-export
  359. :type 'string)
  360. (defcustom org-table-convert-region-max-lines 999
  361. "Max lines that `org-table-convert-region' will attempt to process.
  362. The function can be slow on larger regions; this safety feature
  363. prevents it from hanging emacs."
  364. :group 'org-table-import-export
  365. :type 'integer
  366. :version "26.1"
  367. :package-version '(Org . "8.3"))
  368. (defcustom org-table-shrunk-column-indicator "…"
  369. "String to be displayed in a shrunk column."
  370. :group 'org-table-editing
  371. :type 'string
  372. :version "27.1"
  373. :package-version '(Org . "9.2")
  374. :safe (lambda (v) (and (stringp v) (not (equal v "")))))
  375. (defconst org-table-auto-recalculate-regexp "^[ \t]*| *# *\\(|\\|$\\)"
  376. "Regexp matching a line marked for automatic recalculation.")
  377. (defconst org-table-recalculate-regexp "^[ \t]*| *[#*] *\\(|\\|$\\)"
  378. "Regexp matching a line marked for recalculation.")
  379. (defconst org-table-calculate-mark-regexp "^[ \t]*| *[!$^_#*] *\\(|\\|$\\)"
  380. "Regexp matching a line marked for calculation.")
  381. (defconst org-table-border-regexp "^[ \t]*[^| \t]"
  382. "Regexp matching any line outside an Org table.")
  383. (defvar org-table-last-highlighted-reference nil)
  384. (defvar org-table-formula-history nil)
  385. (defvar org-table-column-names nil
  386. "Alist with column names, derived from the `!' line.
  387. This variable is initialized with `org-table-analyze'.")
  388. (defvar org-table-column-name-regexp nil
  389. "Regular expression matching the current column names.
  390. This variable is initialized with `org-table-analyze'.")
  391. (defvar org-table-local-parameters nil
  392. "Alist with parameter names, derived from the `$' line.
  393. This variable is initialized with `org-table-analyze'.")
  394. (defvar org-table-named-field-locations nil
  395. "Alist with locations of named fields.
  396. Associations follow the pattern (NAME LINE COLUMN) where
  397. NAME is the name of the field as a string,
  398. LINE is the number of lines from the beginning of the table,
  399. COLUMN is the column of the field, as an integer.
  400. This variable is initialized with `org-table-analyze'.")
  401. (defvar org-table-current-line-types nil
  402. "Table row types in current table.
  403. This variable is initialized with `org-table-analyze'.")
  404. (defvar org-table-current-begin-pos nil
  405. "Current table begin position, as a marker.
  406. This variable is initialized with `org-table-analyze'.")
  407. (defvar org-table-current-ncol nil
  408. "Number of columns in current table.
  409. This variable is initialized with `org-table-analyze'.")
  410. (defvar org-table-dlines nil
  411. "Vector of data line line numbers in the current table.
  412. Line numbers are counted from the beginning of the table. This
  413. variable is initialized with `org-table-analyze'.")
  414. (defvar org-table-hlines nil
  415. "Vector of hline line numbers in the current table.
  416. Line numbers are counted from the beginning of the table. This
  417. variable is initialized with `org-table-analyze'.")
  418. (defconst org-table-range-regexp
  419. "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
  420. ;; 1 2 3 4 5
  421. "Regular expression for matching ranges in formulas.")
  422. (defconst org-table-range-regexp2
  423. (concat
  424. "\\(" "@[-0-9I$&]+" "\\|" "[a-zA-Z]\\{1,2\\}\\([0-9]+\\|&\\)" "\\|" "\\$[a-zA-Z0-9]+" "\\)"
  425. "\\.\\."
  426. "\\(" "@?[-0-9I$&]+" "\\|" "[a-zA-Z]\\{1,2\\}\\([0-9]+\\|&\\)" "\\|" "\\$[a-zA-Z0-9]+" "\\)")
  427. "Match a range for reference display.")
  428. (defconst org-table-translate-regexp
  429. (concat "\\(" "@[-0-9I$]+" "\\|" "[a-zA-Z]\\{1,2\\}\\([0-9]+\\|&\\)" "\\)")
  430. "Match a reference that needs translation, for reference display.")
  431. (defconst org-table-separator-space
  432. (propertize " " 'display '(space :width 1))
  433. "Space used around fields when aligning the table.
  434. This space serves as a segment separator for the purposes of the
  435. bidirectional reordering.")
  436. (defmacro org-table-save-field (&rest body)
  437. "Save current field; execute BODY; restore field.
  438. Field is restored even in case of abnormal exit."
  439. (declare (debug (body)))
  440. (org-with-gensyms (line column)
  441. `(let ((,line (copy-marker (line-beginning-position)))
  442. (,column (org-table-current-column)))
  443. (unwind-protect
  444. (progn ,@body)
  445. (goto-char ,line)
  446. (org-table-goto-column ,column)
  447. (set-marker ,line nil)))))
  448. ;;; See org-macs.el for the definition of org-table-with-shrunk-field,
  449. ;;; including the reason why it is defined there and not here.
  450. (defmacro org-table-with-shrunk-columns (&rest body)
  451. "Expand all columns before executing BODY, then shrink them again."
  452. (declare (debug (body)))
  453. (org-with-gensyms (shrunk-columns begin end)
  454. `(let ((,begin (copy-marker (org-table-begin)))
  455. (,end (copy-marker (org-table-end) t))
  456. (,shrunk-columns (org-table--list-shrunk-columns)))
  457. (org-with-point-at ,begin (org-table-expand ,begin ,end))
  458. (unwind-protect
  459. (progn ,@body)
  460. (org-table--shrink-columns ,shrunk-columns ,begin ,end)
  461. (set-marker ,begin nil)
  462. (set-marker ,end nil)))))
  463. ;;;###autoload
  464. (defun org-table-create-with-table.el ()
  465. "Use the table.el package to insert a new table.
  466. If there is already a table at point, convert between Org tables
  467. and table.el tables."
  468. (interactive)
  469. (require 'table)
  470. (cond
  471. ((and (org-at-table.el-p)
  472. (y-or-n-p "Convert table to Org table? "))
  473. (org-table-convert))
  474. ((and (org-at-table-p)
  475. (y-or-n-p "Convert table to table.el table? "))
  476. (org-table-align)
  477. (org-table-convert))
  478. (t (call-interactively 'table-insert))))
  479. ;;;###autoload
  480. (defun org-table-create-or-convert-from-region (arg)
  481. "Convert region to table, or create an empty table.
  482. If there is an active region, convert it to a table, using the function
  483. `org-table-convert-region'. See the documentation of that function
  484. to learn how the prefix argument is interpreted to determine the field
  485. separator.
  486. If there is no such region, create an empty table with `org-table-create'."
  487. (interactive "P")
  488. (if (org-region-active-p)
  489. (org-table-convert-region (region-beginning) (region-end) arg)
  490. (org-table-create arg)))
  491. ;;;###autoload
  492. (defun org-table-create (&optional size)
  493. "Query for a size and insert a table skeleton.
  494. SIZE is a string Columns x Rows like for example \"3x2\"."
  495. (interactive "P")
  496. (unless size
  497. (setq size (read-string
  498. (concat "Table size Columns x Rows [e.g. "
  499. org-table-default-size "]: ")
  500. "" nil org-table-default-size)))
  501. (let* ((pos (point))
  502. (indent (make-string (current-column) ?\ ))
  503. (split (org-split-string size " *x *"))
  504. (rows (string-to-number (nth 1 split)))
  505. (columns (string-to-number (car split)))
  506. (line (concat (apply 'concat indent "|" (make-list columns " |"))
  507. "\n")))
  508. (if (string-match "^[ \t]*$" (buffer-substring-no-properties
  509. (point-at-bol) (point)))
  510. (beginning-of-line 1)
  511. (newline))
  512. ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
  513. (dotimes (_ rows) (insert line))
  514. (goto-char pos)
  515. (when (> rows 1)
  516. ;; Insert a hline after the first row.
  517. (end-of-line 1)
  518. (insert "\n|-")
  519. (goto-char pos))
  520. (org-table-align)))
  521. ;;;###autoload
  522. (defun org-table-convert-region (beg0 end0 &optional separator)
  523. "Convert region to a table.
  524. The region goes from BEG0 to END0, but these borders will be moved
  525. slightly, to make sure a beginning of line in the first line is included.
  526. SEPARATOR specifies the field separator in the lines. It can have the
  527. following values:
  528. (4) Use the comma as a field separator
  529. (16) Use a TAB as field separator
  530. (64) Prompt for a regular expression as field separator
  531. integer When a number, use that many spaces, or a TAB, as field separator
  532. regexp When a regular expression, use it to match the separator
  533. nil When nil, the command tries to be smart and figure out the
  534. separator in the following way:
  535. - when each line contains a TAB, assume TAB-separated material
  536. - when each line contains a comma, assume CSV material
  537. - else, assume one or more SPACE characters as separator."
  538. (interactive "r\nP")
  539. (let* ((beg (min beg0 end0))
  540. (end (max beg0 end0))
  541. re)
  542. (if (> (count-lines beg end) org-table-convert-region-max-lines)
  543. (user-error "Region is longer than `org-table-convert-region-max-lines' (%s) lines; not converting"
  544. org-table-convert-region-max-lines)
  545. (when (equal separator '(64))
  546. (setq separator (read-regexp "Regexp for field separator")))
  547. (goto-char beg)
  548. (beginning-of-line 1)
  549. (setq beg (point-marker))
  550. (goto-char end)
  551. (if (bolp) (backward-char 1) (end-of-line 1))
  552. (setq end (point-marker))
  553. ;; Get the right field separator
  554. (unless separator
  555. (goto-char beg)
  556. (setq separator
  557. (cond
  558. ((not (re-search-forward "^[^\n\t]+$" end t)) '(16))
  559. ((not (re-search-forward "^[^\n,]+$" end t)) '(4))
  560. (t 1))))
  561. (goto-char beg)
  562. (if (equal separator '(4))
  563. (while (< (point) end)
  564. ;; parse the csv stuff
  565. (cond
  566. ((looking-at "^") (insert "| "))
  567. ((looking-at "[ \t]*$") (replace-match " |") (beginning-of-line 2))
  568. ((looking-at "[ \t]*\"\\([^\"\n]*\\)\"")
  569. (replace-match "\\1")
  570. (if (looking-at "\"") (insert "\"")))
  571. ((looking-at "[^,\n]+") (goto-char (match-end 0)))
  572. ((looking-at "[ \t]*,") (replace-match " | "))
  573. (t (beginning-of-line 2))))
  574. (setq re (cond
  575. ((equal separator '(4)) "^\\|\"?[ \t]*,[ \t]*\"?")
  576. ((equal separator '(16)) "^\\|\t")
  577. ((integerp separator)
  578. (if (< separator 1)
  579. (user-error "Number of spaces in separator must be >= 1")
  580. (format "^ *\\| *\t *\\| \\{%d,\\}" separator)))
  581. ((stringp separator)
  582. (format "^ *\\|%s" separator))
  583. (t (error "This should not happen"))))
  584. (while (re-search-forward re end t)
  585. (replace-match "| " t t)))
  586. (goto-char beg)
  587. (org-table-align))))
  588. ;;;###autoload
  589. (defun org-table-import (file separator)
  590. "Import FILE as a table.
  591. The command tries to be smart and figure out the separator in the
  592. following way:
  593. - when each line contains a TAB, assume TAB-separated material
  594. - when each line contains a comma, assume CSV material
  595. - else, assume one or more SPACE characters as separator.
  596. When non-nil, SEPARATOR specifies the field separator in the
  597. lines. It can have the following values:
  598. (4) Use the comma as a field separator
  599. (16) Use a TAB as field separator
  600. (64) Prompt for a regular expression as field separator
  601. integer When a number, use that many spaces, or a TAB, as field separator
  602. regexp When a regular expression, use it to match the separator."
  603. (interactive "f\nP")
  604. (unless (bolp) (insert "\n"))
  605. (let ((beg (point))
  606. (pm (point-max)))
  607. (insert-file-contents file)
  608. (org-table-convert-region beg (+ (point) (- (point-max) pm)) separator)))
  609. ;;;###autoload
  610. (defun org-table-export (&optional file format)
  611. "Export table to a file, with configurable format.
  612. Such a file can be imported into usual spreadsheet programs.
  613. FILE can be the output file name. If not given, it will be taken
  614. from a TABLE_EXPORT_FILE property in the current entry or higher
  615. up in the hierarchy, or the user will be prompted for a file
  616. name. FORMAT can be an export format, of the same kind as it
  617. used when `orgtbl-mode' sends a table in a different format.
  618. The command suggests a format depending on TABLE_EXPORT_FORMAT,
  619. whether it is set locally or up in the hierarchy, then on the
  620. extension of the given file name, and finally on the variable
  621. `org-table-export-default-format'."
  622. (interactive)
  623. (unless (org-at-table-p) (user-error "No table at point"))
  624. (org-table-align) ; Make sure we have everything we need.
  625. (let ((file (or file (org-entry-get (point) "TABLE_EXPORT_FILE" t))))
  626. (unless file
  627. (setq file (read-file-name "Export table to: "))
  628. (unless (or (not (file-exists-p file))
  629. (y-or-n-p (format "Overwrite file %s? " file)))
  630. (user-error "File not written")))
  631. (when (file-directory-p file)
  632. (user-error "This is a directory path, not a file"))
  633. (when (and (buffer-file-name (buffer-base-buffer))
  634. (file-equal-p
  635. (file-truename file)
  636. (file-truename (buffer-file-name (buffer-base-buffer)))))
  637. (user-error "Please specify a file name that is different from current"))
  638. (let ((fileext (concat (file-name-extension file) "$"))
  639. (format (or format (org-entry-get (point) "TABLE_EXPORT_FORMAT" t))))
  640. (unless format
  641. (let* ((formats '("orgtbl-to-tsv" "orgtbl-to-csv" "orgtbl-to-latex"
  642. "orgtbl-to-html" "orgtbl-to-generic"
  643. "orgtbl-to-texinfo" "orgtbl-to-orgtbl"
  644. "orgtbl-to-unicode"))
  645. (deffmt-readable
  646. (replace-regexp-in-string
  647. "\t" "\\t"
  648. (replace-regexp-in-string
  649. "\n" "\\n"
  650. (or (car (delq nil
  651. (mapcar
  652. (lambda (f)
  653. (and (string-match-p fileext f) f))
  654. formats)))
  655. org-table-export-default-format)
  656. t t) t t)))
  657. (setq format
  658. (org-completing-read
  659. "Format: " formats nil nil deffmt-readable))))
  660. (if (string-match "\\([^ \t\r\n]+\\)\\( +.*\\)?" format)
  661. (let ((transform (intern (match-string 1 format)))
  662. (params (and (match-end 2)
  663. (read (concat "(" (match-string 2 format) ")"))))
  664. (table (org-table-to-lisp
  665. (buffer-substring-no-properties
  666. (org-table-begin) (org-table-end)))))
  667. (unless (fboundp transform)
  668. (user-error "No such transformation function %s" transform))
  669. (let (buf)
  670. (with-current-buffer (find-file-noselect file)
  671. (setq buf (current-buffer))
  672. (erase-buffer)
  673. (fundamental-mode)
  674. (insert (funcall transform table params) "\n")
  675. (save-buffer))
  676. (kill-buffer buf))
  677. (message "Export done."))
  678. (user-error "TABLE_EXPORT_FORMAT invalid")))))
  679. (defvar org-table-aligned-begin-marker (make-marker)
  680. "Marker at the beginning of the table last aligned.
  681. Used to check if cursor still is in that table, to minimize realignment.")
  682. (defvar org-table-aligned-end-marker (make-marker)
  683. "Marker at the end of the table last aligned.
  684. Used to check if cursor still is in that table, to minimize realignment.")
  685. (defvar org-table-last-alignment nil
  686. "List of flags for flushright alignment, from the last re-alignment.
  687. This is being used to correctly align a single field after TAB or RET.")
  688. (defvar org-table-last-column-widths nil
  689. "List of max width of fields in each column.
  690. This is being used to correctly align a single field after TAB or RET.")
  691. (defvar-local org-table-formula-debug nil
  692. "Non-nil means debug table formulas.
  693. When nil, simply write \"#ERROR\" in corrupted fields.")
  694. (defvar-local org-table-overlay-coordinates nil
  695. "Overlay coordinates after each align of a table.")
  696. (defvar org-last-recalc-line nil)
  697. (defun org-table--align-field (field width align)
  698. "Format FIELD according to column WIDTH and alignement ALIGN.
  699. FIELD is a string. WIDTH is a number. ALIGN is either \"c\",
  700. \"l\" or\"r\"."
  701. (let* ((spaces (- width (org-string-width field)))
  702. (prefix (pcase align
  703. ("l" "")
  704. ("r" (make-string spaces ?\s))
  705. ("c" (make-string (/ spaces 2) ?\s))))
  706. (suffix (make-string (- spaces (length prefix)) ?\s)))
  707. (concat org-table-separator-space
  708. prefix
  709. field
  710. suffix
  711. org-table-separator-space)))
  712. ;;;###autoload
  713. (defun org-table-align ()
  714. "Align the table at point by aligning all vertical bars."
  715. (interactive)
  716. (let ((beg (org-table-begin))
  717. (end (copy-marker (org-table-end))))
  718. (org-table-save-field
  719. ;; Make sure invisible characters in the table are at the right
  720. ;; place since column widths take them into account.
  721. (org-font-lock-ensure beg end)
  722. (move-marker org-table-aligned-begin-marker beg)
  723. (move-marker org-table-aligned-end-marker end)
  724. (goto-char beg)
  725. (org-table-with-shrunk-columns
  726. (let* ((indent (progn (looking-at "[ \t]*") (match-string 0)))
  727. ;; Table's rows as lists of fields. Rules are replaced
  728. ;; by nil. Trailing spaces are removed.
  729. (fields (mapcar
  730. (lambda (l)
  731. (and (not (string-match-p org-table-hline-regexp l))
  732. (org-split-string l "[ \t]*|[ \t]*")))
  733. (split-string (buffer-substring beg end) "\n" t)))
  734. ;; Compute number of columns. If the table contains no
  735. ;; field, create a default table and bail out.
  736. (columns-number
  737. (if fields (apply #'max (mapcar #'length fields))
  738. (kill-region beg end)
  739. (org-table-create org-table-default-size)
  740. (user-error "Empty table - created default table")))
  741. (widths nil)
  742. (alignments nil))
  743. ;; Compute alignment and width for each column.
  744. (dotimes (i columns-number)
  745. (let* ((max-width 1)
  746. (fixed-align? nil)
  747. (numbers 0)
  748. (non-empty 0))
  749. (dolist (row fields)
  750. (let ((cell (or (nth i row) "")))
  751. (setq max-width (max max-width (org-string-width cell)))
  752. (cond (fixed-align? nil)
  753. ((equal cell "") nil)
  754. ((string-match "\\`<\\([lrc]\\)[0-9]*>\\'" cell)
  755. (setq fixed-align? (match-string 1 cell)))
  756. (t
  757. (cl-incf non-empty)
  758. (when (string-match-p org-table-number-regexp cell)
  759. (cl-incf numbers))))))
  760. (push max-width widths)
  761. (push (cond
  762. (fixed-align?)
  763. ((>= numbers (* org-table-number-fraction non-empty)) "r")
  764. (t "l"))
  765. alignments)))
  766. (setq widths (nreverse widths))
  767. (setq alignments (nreverse alignments))
  768. ;; Store alignment of this table, for later editing of single
  769. ;; fields.
  770. (setq org-table-last-alignment alignments)
  771. (setq org-table-last-column-widths widths)
  772. ;; Build new table rows. Only replace rows that actually
  773. ;; changed.
  774. (dolist (row fields)
  775. (let ((previous (buffer-substring (point) (line-end-position)))
  776. (new
  777. (format "%s|%s|"
  778. indent
  779. (if (null row) ;horizontal rule
  780. (mapconcat (lambda (w) (make-string (+ 2 w) ?-))
  781. widths
  782. "+")
  783. (let ((cells ;add missing fields
  784. (append row
  785. (make-list (- columns-number
  786. (length row))
  787. ""))))
  788. (mapconcat #'identity
  789. (cl-mapcar #'org-table--align-field
  790. cells
  791. widths
  792. alignments)
  793. "|"))))))
  794. (if (equal new previous)
  795. (forward-line)
  796. (insert new "\n")
  797. (delete-region (point) (line-beginning-position 2)))))
  798. (set-marker end nil)
  799. (when org-table-overlay-coordinates (org-table-overlay-coordinates))
  800. (setq org-table-may-need-update nil))))))
  801. ;;;###autoload
  802. (defun org-table-begin (&optional table-type)
  803. "Find the beginning of the table and return its position.
  804. With a non-nil optional argument TABLE-TYPE, return the beginning
  805. of a table.el-type table. This function assumes point is on
  806. a table."
  807. (cond (table-type
  808. (org-element-property :post-affiliated (org-element-at-point)))
  809. ((save-excursion
  810. (and (re-search-backward org-table-border-regexp nil t)
  811. (line-beginning-position 2))))
  812. (t (point-min))))
  813. ;;;###autoload
  814. (defun org-table-end (&optional table-type)
  815. "Find the end of the table and return its position.
  816. With a non-nil optional argument TABLE-TYPE, return the end of
  817. a table.el-type table. This function assumes point is on
  818. a table."
  819. (save-excursion
  820. (cond (table-type
  821. (goto-char (org-element-property :end (org-element-at-point)))
  822. (skip-chars-backward " \t\n")
  823. (line-beginning-position 2))
  824. ((re-search-forward org-table-border-regexp nil t)
  825. (match-beginning 0))
  826. ;; When the line right after the table is the last line in
  827. ;; the buffer with trailing spaces but no final newline
  828. ;; character, be sure to catch the correct ending at its
  829. ;; beginning. In any other case, ending is expected to be
  830. ;; at point max.
  831. (t (goto-char (point-max))
  832. (skip-chars-backward " \t")
  833. (if (bolp) (point) (line-end-position))))))
  834. ;;;###autoload
  835. (defun org-table-justify-field-maybe (&optional new)
  836. "Justify the current field, text to left, number to right.
  837. Optional argument NEW may specify text to replace the current field content."
  838. (cond
  839. ((and (not new) org-table-may-need-update)) ; Realignment will happen anyway
  840. ((org-at-table-hline-p))
  841. ((and (not new)
  842. (or (not (eq (marker-buffer org-table-aligned-begin-marker)
  843. (current-buffer)))
  844. (< (point) org-table-aligned-begin-marker)
  845. (>= (point) org-table-aligned-end-marker)))
  846. ;; This is not the same table, force a full re-align.
  847. (setq org-table-may-need-update t))
  848. (t
  849. ;; Realign the current field, based on previous full realign.
  850. (let ((pos (point))
  851. (col (org-table-current-column)))
  852. (when (> col 0)
  853. (skip-chars-backward "^|")
  854. (if (not (looking-at " *\\([^|\n]*?\\) *\\(|\\|$\\)"))
  855. (setq org-table-may-need-update t)
  856. (let* ((align (nth (1- col) org-table-last-alignment))
  857. (width (nth (1- col) org-table-last-column-widths))
  858. (cell (match-string 0))
  859. (field (match-string 1))
  860. (properly-closed? (/= (match-beginning 2) (match-end 2)))
  861. (new-cell
  862. (save-match-data
  863. (cond (org-table-may-need-update
  864. (format " %s |" (or new field)))
  865. ((not properly-closed?)
  866. (setq org-table-may-need-update t)
  867. (format " %s |" (or new field)))
  868. ((not new)
  869. (concat (org-table--align-field field width align)
  870. "|"))
  871. ((<= (org-string-width new) width)
  872. (concat (org-table--align-field new width align)
  873. "|"))
  874. (t
  875. (setq org-table-may-need-update t)
  876. (format " %s |" new))))))
  877. (unless (equal new-cell cell)
  878. (let (org-table-may-need-update)
  879. (replace-match new-cell t t)))
  880. (goto-char pos))))))))
  881. ;;;###autoload
  882. (defun org-table-next-field ()
  883. "Go to the next field in the current table, creating new lines as needed.
  884. Before doing so, re-align the table if necessary."
  885. (interactive)
  886. (org-table-maybe-eval-formula)
  887. (org-table-maybe-recalculate-line)
  888. (when (and org-table-automatic-realign
  889. org-table-may-need-update)
  890. (org-table-align))
  891. (let ((end (org-table-end)))
  892. (if (org-at-table-hline-p)
  893. (end-of-line 1))
  894. (condition-case nil
  895. (progn
  896. (re-search-forward "|" end)
  897. (if (looking-at "[ \t]*$")
  898. (re-search-forward "|" end))
  899. (if (and (looking-at "-")
  900. org-table-tab-jumps-over-hlines
  901. (re-search-forward "^[ \t]*|\\([^-]\\)" end t))
  902. (goto-char (match-beginning 1)))
  903. (if (looking-at "-")
  904. (progn
  905. (beginning-of-line 0)
  906. (org-table-insert-row 'below))
  907. (if (looking-at " ") (forward-char 1))))
  908. (error
  909. (org-table-insert-row 'below)))))
  910. ;;;###autoload
  911. (defun org-table-previous-field ()
  912. "Go to the previous field in the table.
  913. Before doing so, re-align the table if necessary."
  914. (interactive)
  915. (org-table-justify-field-maybe)
  916. (org-table-maybe-recalculate-line)
  917. (when (and org-table-automatic-realign
  918. org-table-may-need-update)
  919. (org-table-align))
  920. (when (org-at-table-hline-p)
  921. (end-of-line))
  922. (let ((start (org-table-begin))
  923. (origin (point)))
  924. (condition-case nil
  925. (progn
  926. (search-backward "|" start nil 2)
  927. (while (looking-at-p "|\\(?:-\\|[ \t]*$\\)")
  928. (search-backward "|" start)))
  929. (error
  930. (goto-char origin)
  931. (user-error "Cannot move to previous table field"))))
  932. (when (looking-at "| ?")
  933. (goto-char (match-end 0))))
  934. (defun org-table-beginning-of-field (&optional n)
  935. "Move to the beginning of the current table field.
  936. If already at or before the beginning, move to the beginning of the
  937. previous field.
  938. With numeric argument N, move N-1 fields backward first."
  939. (interactive "p")
  940. (let ((pos (point)))
  941. (while (> n 1)
  942. (setq n (1- n))
  943. (org-table-previous-field))
  944. (if (not (re-search-backward "|" (point-at-bol 0) t))
  945. (user-error "No more table fields before the current")
  946. (goto-char (match-end 0))
  947. (and (looking-at " ") (forward-char 1)))
  948. (when (>= (point) pos) (org-table-beginning-of-field 2))))
  949. (defun org-table-end-of-field (&optional n)
  950. "Move to the end of the current table field.
  951. If already at or after the end, move to the end of the next table field.
  952. With numeric argument N, move N-1 fields forward first."
  953. (interactive "p")
  954. (let ((pos (point)))
  955. (while (> n 1)
  956. (setq n (1- n))
  957. (org-table-next-field))
  958. (when (re-search-forward "|" (point-at-eol 1) t)
  959. (backward-char 1)
  960. (skip-chars-backward " ")
  961. (when (and (equal (char-before (point)) ?|) (equal (char-after (point)) ?\s))
  962. (forward-char 1)))
  963. (when (<= (point) pos) (org-table-end-of-field 2))))
  964. ;;;###autoload
  965. (defun org-table-next-row ()
  966. "Go to the next row (same column) in the current table.
  967. Before doing so, re-align the table if necessary."
  968. (interactive)
  969. (org-table-maybe-eval-formula)
  970. (org-table-maybe-recalculate-line)
  971. (if (and org-table-automatic-realign
  972. org-table-may-need-update)
  973. (org-table-align))
  974. (let ((col (org-table-current-column)))
  975. (beginning-of-line 2)
  976. (when (or (not (org-at-table-p))
  977. (org-at-table-hline-p))
  978. (beginning-of-line 0)
  979. (org-table-insert-row 'below))
  980. (org-table-goto-column col)
  981. (skip-chars-backward "^|\n\r")
  982. (when (looking-at " ") (forward-char))))
  983. ;;;###autoload
  984. (defun org-table-copy-down (n)
  985. "Copy the value of the current field one row below.
  986. If the field at the cursor is empty, copy the content of the
  987. nearest non-empty field above. With argument N, use the Nth
  988. non-empty field.
  989. If the current field is not empty, it is copied down to the next
  990. row, and the cursor is moved with it. Therefore, repeating this
  991. command causes the column to be filled row-by-row.
  992. If the variable `org-table-copy-increment' is non-nil and the
  993. field is an integer or a timestamp, it will be incremented while
  994. copying. By default, increment by the difference between the
  995. value in the current field and the one in the field above. To
  996. increment using a fixed integer, set `org-table-copy-increment'
  997. to a number. In the case of a timestamp, increment by days."
  998. (interactive "p")
  999. (let* ((colpos (org-table-current-column))
  1000. (col (current-column))
  1001. (field (save-excursion (org-table-get-field)))
  1002. (field-up (or (save-excursion
  1003. (org-table-get (1- (org-table-current-line))
  1004. (org-table-current-column))) ""))
  1005. (non-empty (string-match "[^ \t]" field))
  1006. (non-empty-up (string-match "[^ \t]" field-up))
  1007. (beg (org-table-begin))
  1008. (orig-n n)
  1009. txt txt-up inc)
  1010. (org-table-check-inside-data-field)
  1011. (if (not non-empty)
  1012. (save-excursion
  1013. (setq txt
  1014. (catch 'exit
  1015. (while (progn (beginning-of-line 1)
  1016. (re-search-backward org-table-dataline-regexp
  1017. beg t))
  1018. (org-table-goto-column colpos t)
  1019. (if (and (looking-at
  1020. "|[ \t]*\\([^| \t][^|]*?\\)[ \t]*|")
  1021. (<= (setq n (1- n)) 0))
  1022. (throw 'exit (match-string 1))))))
  1023. (setq field-up
  1024. (catch 'exit
  1025. (while (progn (beginning-of-line 1)
  1026. (re-search-backward org-table-dataline-regexp
  1027. beg t))
  1028. (org-table-goto-column colpos t)
  1029. (if (and (looking-at
  1030. "|[ \t]*\\([^| \t][^|]*?\\)[ \t]*|")
  1031. (<= (setq n (1- n)) 0))
  1032. (throw 'exit (match-string 1))))))
  1033. (setq non-empty-up (and field-up (string-match "[^ \t]" field-up))))
  1034. ;; Above field was not empty, go down to the next row. Skip
  1035. ;; alignment since we do it at the end of the process anyway.
  1036. (setq txt (org-trim field))
  1037. (let ((org-table-may-need-update nil)) (org-table-next-row))
  1038. (org-table-blank-field))
  1039. (if non-empty-up (setq txt-up (org-trim field-up)))
  1040. (setq inc (cond
  1041. ((numberp org-table-copy-increment) org-table-copy-increment)
  1042. (txt-up (cond ((and (string-match org-ts-regexp3 txt-up)
  1043. (string-match org-ts-regexp3 txt))
  1044. (- (org-time-string-to-absolute txt)
  1045. (org-time-string-to-absolute txt-up)))
  1046. ((string-match org-ts-regexp3 txt) 1)
  1047. ((string-match "\\([-+]\\)?\\(?:[0-9]+\\)?\\(?:\.[0-9]+\\)?" txt-up)
  1048. (- (string-to-number txt)
  1049. (string-to-number (match-string 0 txt-up))))
  1050. (t 1)))
  1051. (t 1)))
  1052. (if (not txt)
  1053. (user-error "No non-empty field found")
  1054. (if (and org-table-copy-increment
  1055. (not (equal orig-n 0))
  1056. (string-match-p "^[-+^/*0-9eE.]+$" txt)
  1057. (< (string-to-number txt) 100000000))
  1058. (setq txt (calc-eval (concat txt "+" (number-to-string inc)))))
  1059. (insert txt)
  1060. (org-move-to-column col)
  1061. (if (and org-table-copy-increment (org-at-timestamp-p 'lax))
  1062. (org-timestamp-up-day inc)
  1063. (org-table-maybe-recalculate-line))
  1064. (org-table-align)
  1065. (org-move-to-column col))))
  1066. (defun org-table-check-inside-data-field (&optional noerror assume-table)
  1067. "Non-nil when point is inside a table data field.
  1068. Raise an error otherwise, unless NOERROR is non-nil. In that
  1069. case, return nil if point is not inside a data field. When
  1070. optional argument ASSUME-TABLE is non-nil, assume point is within
  1071. a table."
  1072. (cond ((and (or assume-table (org-at-table-p))
  1073. (not (save-excursion (skip-chars-backward " \t") (bolp)))
  1074. (not (org-at-table-hline-p))
  1075. (not (looking-at-p "[ \t]*$"))))
  1076. (noerror nil)
  1077. (t (user-error "Not in table data field"))))
  1078. (defvar org-table-clip nil
  1079. "Clipboard for table regions.")
  1080. (defun org-table-get (line column)
  1081. "Get the field in table line LINE, column COLUMN.
  1082. If LINE is larger than the number of data lines in the table, the function
  1083. returns nil. However, if COLUMN is too large, we will simply return an
  1084. empty string.
  1085. If LINE is nil, use the current line.
  1086. If COLUMN is nil, use the current column."
  1087. (setq column (or column (org-table-current-column)))
  1088. (save-excursion
  1089. (and (or (not line) (org-table-goto-line line))
  1090. (org-trim (org-table-get-field column)))))
  1091. (defun org-table-put (line column value &optional align)
  1092. "Put VALUE into line LINE, column COLUMN.
  1093. When ALIGN is set, also realign the table."
  1094. (setq column (or column (org-table-current-column)))
  1095. (prog1 (save-excursion
  1096. (and (or (not line) (org-table-goto-line line))
  1097. (progn (org-table-goto-column column nil 'force) t)
  1098. (org-table-get-field column value)))
  1099. (and align (org-table-align))))
  1100. (defun org-table-current-line ()
  1101. "Return the index of the current data line."
  1102. (let ((pos (point)) (end (org-table-end)) (cnt 0))
  1103. (save-excursion
  1104. (goto-char (org-table-begin))
  1105. (while (and (re-search-forward org-table-dataline-regexp end t)
  1106. (setq cnt (1+ cnt))
  1107. (< (point-at-eol) pos))))
  1108. cnt))
  1109. (defun org-table-goto-line (N)
  1110. "Go to the Nth data line in the current table.
  1111. Return t when the line exists, nil if it does not exist."
  1112. (goto-char (org-table-begin))
  1113. (let ((end (org-table-end)) (cnt 0))
  1114. (while (and (re-search-forward org-table-dataline-regexp end t)
  1115. (< (setq cnt (1+ cnt)) N)))
  1116. (= cnt N)))
  1117. ;;;###autoload
  1118. (defun org-table-blank-field ()
  1119. "Blank the current table field or active region."
  1120. (interactive)
  1121. (org-table-check-inside-data-field)
  1122. (if (and (called-interactively-p 'any) (org-region-active-p))
  1123. (let (org-table-clip)
  1124. (org-table-cut-region (region-beginning) (region-end)))
  1125. (skip-chars-backward "^|")
  1126. (backward-char 1)
  1127. (if (looking-at "|[^|\n]+")
  1128. (let* ((pos (match-beginning 0))
  1129. (match (match-string 0))
  1130. (len (org-string-width match)))
  1131. (replace-match (concat "|" (make-string (1- len) ?\ )))
  1132. (goto-char (+ 2 pos))
  1133. (substring match 1)))))
  1134. (defun org-table-get-field (&optional n replace)
  1135. "Return the value of the field in column N of current row.
  1136. N defaults to current column. If REPLACE is a string, replace
  1137. field with this value. The return value is always the old
  1138. value."
  1139. (when n (org-table-goto-column n))
  1140. (skip-chars-backward "^|\n")
  1141. (if (or (bolp) (looking-at-p "[ \t]*$"))
  1142. ;; Before first column or after last one.
  1143. ""
  1144. (looking-at "[^|\r\n]*")
  1145. (let* ((pos (match-beginning 0))
  1146. (val (buffer-substring pos (match-end 0))))
  1147. (when replace
  1148. (org-table-with-shrunk-field
  1149. (replace-match (if (equal replace "") " " replace) t t)))
  1150. (goto-char (min (line-end-position) (1+ pos)))
  1151. val)))
  1152. ;;;###autoload
  1153. (defun org-table-field-info (_arg)
  1154. "Show info about the current field, and highlight any reference at point."
  1155. (interactive "P")
  1156. (unless (org-at-table-p) (user-error "Not at a table"))
  1157. (org-table-analyze)
  1158. (save-excursion
  1159. (let* ((pos (point))
  1160. (col (org-table-current-column))
  1161. (cname (car (rassoc (int-to-string col) org-table-column-names)))
  1162. (name (car (rassoc (list (count-lines org-table-current-begin-pos
  1163. (line-beginning-position))
  1164. col)
  1165. org-table-named-field-locations)))
  1166. (eql (org-table-expand-lhs-ranges
  1167. (mapcar
  1168. (lambda (e)
  1169. (cons (org-table-formula-handle-first/last-rc (car e))
  1170. (cdr e)))
  1171. (org-table-get-stored-formulas))))
  1172. (dline (org-table-current-dline))
  1173. (ref (format "@%d$%d" dline col))
  1174. (ref1 (org-table-convert-refs-to-an ref))
  1175. ;; Prioritize field formulas over column formulas.
  1176. (fequation (or (assoc name eql) (assoc ref eql)))
  1177. (cequation (assoc (format "$%d" col) eql))
  1178. (eqn (or fequation cequation)))
  1179. (let ((p (and eqn (get-text-property 0 :orig-eqn (car eqn)))))
  1180. (when p (setq eqn p)))
  1181. (goto-char pos)
  1182. (ignore-errors (org-table-show-reference 'local))
  1183. (message "line @%d, col $%s%s, ref @%d$%d or %s%s%s"
  1184. dline col
  1185. (if cname (concat " or $" cname) "")
  1186. dline col ref1
  1187. (if name (concat " or $" name) "")
  1188. ;; FIXME: formula info not correct if special table line
  1189. (if eqn
  1190. (concat ", formula: "
  1191. (org-table-formula-to-user
  1192. (concat
  1193. (if (or (string-prefix-p "$" (car eqn))
  1194. (string-prefix-p "@" (car eqn)))
  1195. ""
  1196. "$")
  1197. (car eqn) "=" (cdr eqn))))
  1198. "")))))
  1199. (defun org-table-current-column ()
  1200. "Return current column number."
  1201. (interactive)
  1202. (save-excursion
  1203. (let ((pos (point)))
  1204. (beginning-of-line)
  1205. (if (not (search-forward "|" pos t)) 0
  1206. (let ((column 1)
  1207. (separator (if (org-at-table-hline-p) "[+|]" "|")))
  1208. (while (re-search-forward separator pos t) (cl-incf column))
  1209. column)))))
  1210. (defun org-table-current-dline ()
  1211. "Find out what table data line we are in.
  1212. Only data lines count for this."
  1213. (save-excursion
  1214. (let ((c 0)
  1215. (pos (line-beginning-position)))
  1216. (goto-char (org-table-begin))
  1217. (while (<= (point) pos)
  1218. (when (looking-at org-table-dataline-regexp) (cl-incf c))
  1219. (forward-line))
  1220. c)))
  1221. ;;;###autoload
  1222. (defun org-table-goto-column (n &optional on-delim force)
  1223. "Move the cursor to the Nth column in the current table line.
  1224. With optional argument ON-DELIM, stop with point before the left delimiter
  1225. of the field.
  1226. If there are less than N fields, just go to after the last delimiter.
  1227. However, when FORCE is non-nil, create new columns if necessary."
  1228. (interactive "p")
  1229. (beginning-of-line 1)
  1230. (when (> n 0)
  1231. (while (and (> (setq n (1- n)) -1)
  1232. (or (search-forward "|" (point-at-eol) t)
  1233. (and force
  1234. (progn (end-of-line 1)
  1235. (skip-chars-backward "^|")
  1236. (insert " | ")
  1237. t)))))
  1238. (when (and force (not (looking-at ".*|")))
  1239. (save-excursion (end-of-line 1) (insert " | ")))
  1240. (if on-delim
  1241. (backward-char 1)
  1242. (if (looking-at " ") (forward-char 1)))))
  1243. ;;;###autoload
  1244. (defun org-table-insert-column ()
  1245. "Insert a new column into the table."
  1246. (interactive)
  1247. (unless (org-at-table-p) (user-error "Not at a table"))
  1248. (org-table-find-dataline)
  1249. (let ((col (max 1 (org-table-current-column)))
  1250. (beg (org-table-begin))
  1251. (end (copy-marker (org-table-end)))
  1252. (shrunk-columns (org-table--list-shrunk-columns)))
  1253. (org-table-expand beg end)
  1254. (save-excursion
  1255. (goto-char beg)
  1256. (while (< (point) end)
  1257. (unless (org-at-table-hline-p)
  1258. (org-table-goto-column col t)
  1259. (unless (search-forward "|" (line-end-position) t 2)
  1260. ;; Add missing vertical bar at the end of the row.
  1261. (end-of-line)
  1262. (insert "|"))
  1263. (insert " |"))
  1264. (forward-line)))
  1265. (org-table-goto-column (1+ col))
  1266. (org-table-align)
  1267. ;; Shift appropriately stored shrunk column numbers, then hide the
  1268. ;; columns again.
  1269. (org-table--shrink-columns (mapcar (lambda (c) (if (<= c col) c (1+ c)))
  1270. shrunk-columns)
  1271. beg end)
  1272. (set-marker end nil)
  1273. ;; Fix TBLFM formulas, if desirable.
  1274. (when (or (not org-table-fix-formulas-confirm)
  1275. (funcall org-table-fix-formulas-confirm "Fix formulas? "))
  1276. (org-table-fix-formulas "$" nil (1- col) 1)
  1277. (org-table-fix-formulas "$LR" nil (1- col) 1))))
  1278. (defun org-table-find-dataline ()
  1279. "Find a data line in the current table, which is needed for column commands.
  1280. This function assumes point is in a table. Raise an error when
  1281. there is no data row below."
  1282. (or (not (org-at-table-hline-p))
  1283. (let ((col (current-column))
  1284. (end (org-table-end)))
  1285. (forward-line)
  1286. (while (and (< (point) end) (org-at-table-hline-p))
  1287. (forward-line))
  1288. (when (>= (point) end)
  1289. (user-error "Cannot find data row for column operation"))
  1290. (org-move-to-column col)
  1291. t)))
  1292. (defun org-table-line-to-dline (line &optional above)
  1293. "Turn a buffer line number into a data line number.
  1294. If there is no data line in this line, return nil.
  1295. If there is no matching dline (most likely the reference was
  1296. a hline), the first dline below it is used. When ABOVE is
  1297. non-nil, the one above is used."
  1298. (let ((min 1)
  1299. (max (1- (length org-table-dlines))))
  1300. (cond ((or (> (aref org-table-dlines min) line)
  1301. (< (aref org-table-dlines max) line))
  1302. nil)
  1303. ((= line (aref org-table-dlines max)) max)
  1304. (t (catch 'exit
  1305. (while (> (- max min) 1)
  1306. (let* ((mean (/ (+ max min) 2))
  1307. (v (aref org-table-dlines mean)))
  1308. (cond ((= v line) (throw 'exit mean))
  1309. ((> v line) (setq max mean))
  1310. (t (setq min mean)))))
  1311. (cond ((= line (aref org-table-dlines max)) max)
  1312. ((= line (aref org-table-dlines min)) min)
  1313. (above min)
  1314. (t max)))))))
  1315. ;;;###autoload
  1316. (defun org-table-delete-column ()
  1317. "Delete a column from the table."
  1318. (interactive)
  1319. (unless (org-at-table-p) (user-error "Not at a table"))
  1320. (org-table-find-dataline)
  1321. (org-table-check-inside-data-field nil t)
  1322. (let* ((col (org-table-current-column))
  1323. (beg (org-table-begin))
  1324. (end (copy-marker (org-table-end)))
  1325. (shrunk-columns (remq col (org-table--list-shrunk-columns))))
  1326. (org-table-expand beg end)
  1327. (org-table-save-field
  1328. (goto-char beg)
  1329. (while (< (point) end)
  1330. (if (org-at-table-hline-p)
  1331. nil
  1332. (org-table-goto-column col t)
  1333. (and (looking-at "|[^|\n]+|")
  1334. (replace-match "|")))
  1335. (forward-line)))
  1336. (org-table-goto-column (max 1 (1- col)))
  1337. (org-table-align)
  1338. ;; Shift appropriately stored shrunk column numbers, then hide the
  1339. ;; columns again.
  1340. (org-table--shrink-columns (mapcar (lambda (c) (if (< c col) c (1- c)))
  1341. shrunk-columns)
  1342. beg end)
  1343. (set-marker end nil)
  1344. ;; Fix TBLFM formulas, if desirable.
  1345. (when (or (not org-table-fix-formulas-confirm)
  1346. (funcall org-table-fix-formulas-confirm "Fix formulas? "))
  1347. (org-table-fix-formulas
  1348. "$" (list (cons (number-to-string col) "INVALID")) col -1 col)
  1349. (org-table-fix-formulas
  1350. "$LR" (list (cons (number-to-string col) "INVALID")) col -1 col))))
  1351. ;;;###autoload
  1352. (defun org-table-move-column-right ()
  1353. "Move column to the right."
  1354. (interactive)
  1355. (org-table-move-column nil))
  1356. ;;;###autoload
  1357. (defun org-table-move-column-left ()
  1358. "Move column to the left."
  1359. (interactive)
  1360. (org-table-move-column 'left))
  1361. ;;;###autoload
  1362. (defun org-table-move-column (&optional left)
  1363. "Move the current column to the right. With arg LEFT, move to the left."
  1364. (interactive "P")
  1365. (unless (org-at-table-p) (user-error "Not at a table"))
  1366. (org-table-find-dataline)
  1367. (org-table-check-inside-data-field nil t)
  1368. (let* ((col (org-table-current-column))
  1369. (col1 (if left (1- col) col))
  1370. (colpos (if left (1- col) (1+ col)))
  1371. (beg (org-table-begin))
  1372. (end (copy-marker (org-table-end))))
  1373. (when (and left (= col 1))
  1374. (user-error "Cannot move column further left"))
  1375. (when (and (not left) (looking-at "[^|\n]*|[^|\n]*$"))
  1376. (user-error "Cannot move column further right"))
  1377. (let ((shrunk-columns (org-table--list-shrunk-columns)))
  1378. (org-table-expand beg end)
  1379. (org-table-save-field
  1380. (goto-char beg)
  1381. (while (< (point) end)
  1382. (unless (org-at-table-hline-p)
  1383. (org-table-goto-column col1 t)
  1384. (when (looking-at "|\\([^|\n]+\\)|\\([^|\n]+\\)|")
  1385. (transpose-regions
  1386. (match-beginning 1) (match-end 1)
  1387. (match-beginning 2) (match-end 2))))
  1388. (forward-line)))
  1389. (org-table-goto-column colpos)
  1390. (org-table-align)
  1391. ;; Shift appropriately stored shrunk column numbers, then shrink
  1392. ;; the columns again.
  1393. (org-table--shrink-columns
  1394. (mapcar (lambda (c)
  1395. (cond ((and (= col c) left) (1- c))
  1396. ((= col c) (1+ c))
  1397. ((and (= col (1+ c)) left) (1+ c))
  1398. ((and (= col (1- c)) (not left) (1- c)))
  1399. (t c)))
  1400. shrunk-columns)
  1401. beg end)
  1402. (set-marker end nil)
  1403. ;; Fix TBLFM formulas, if desirable.
  1404. (when (or (not org-table-fix-formulas-confirm)
  1405. (funcall org-table-fix-formulas-confirm "Fix formulas? "))
  1406. (org-table-fix-formulas
  1407. "$" (list (cons (number-to-string col) (number-to-string colpos))
  1408. (cons (number-to-string colpos) (number-to-string col))))
  1409. (org-table-fix-formulas
  1410. "$LR" (list
  1411. (cons (number-to-string col) (number-to-string colpos))
  1412. (cons (number-to-string colpos) (number-to-string col))))))))
  1413. ;;;###autoload
  1414. (defun org-table-move-row-down ()
  1415. "Move table row down."
  1416. (interactive)
  1417. (org-table-move-row nil))
  1418. ;;;###autoload
  1419. (defun org-table-move-row-up ()
  1420. "Move table row up."
  1421. (interactive)
  1422. (org-table-move-row 'up))
  1423. ;;;###autoload
  1424. (defun org-table-move-row (&optional up)
  1425. "Move the current table line down. With arg UP, move it up."
  1426. (interactive "P")
  1427. (let* ((col (current-column))
  1428. (pos (point))
  1429. (hline1p (save-excursion (beginning-of-line 1)
  1430. (looking-at org-table-hline-regexp)))
  1431. (dline1 (org-table-current-dline))
  1432. (dline2 (+ dline1 (if up -1 1)))
  1433. (tonew (if up 0 2))
  1434. hline2p)
  1435. (when (and up (= (point-min) (line-beginning-position)))
  1436. (user-error "Cannot move row further"))
  1437. (beginning-of-line tonew)
  1438. (when (or (and (not up) (eobp)) (not (org-at-table-p)))
  1439. (goto-char pos)
  1440. (user-error "Cannot move row further"))
  1441. (org-table-with-shrunk-columns
  1442. (setq hline2p (looking-at org-table-hline-regexp))
  1443. (goto-char pos)
  1444. (let ((row (delete-and-extract-region (line-beginning-position)
  1445. (line-beginning-position 2))))
  1446. (beginning-of-line tonew)
  1447. (unless (bolp) (insert "\n")) ;at eob without a newline
  1448. (insert row)
  1449. (unless (bolp) (insert "\n")) ;missing final newline in ROW
  1450. (beginning-of-line 0)
  1451. (org-move-to-column col)
  1452. (unless (or hline1p hline2p
  1453. (not (or (not org-table-fix-formulas-confirm)
  1454. (funcall org-table-fix-formulas-confirm
  1455. "Fix formulas? "))))
  1456. (org-table-fix-formulas
  1457. "@" (list
  1458. (cons (number-to-string dline1) (number-to-string dline2))
  1459. (cons (number-to-string dline2) (number-to-string dline1)))))))))
  1460. ;;;###autoload
  1461. (defun org-table-insert-row (&optional arg)
  1462. "Insert a new row above the current line into the table.
  1463. With prefix ARG, insert below the current line."
  1464. (interactive "P")
  1465. (unless (org-at-table-p) (user-error "Not at a table"))
  1466. (org-table-with-shrunk-columns
  1467. (let* ((line (buffer-substring (line-beginning-position) (line-end-position)))
  1468. (new (org-table-clean-line line)))
  1469. ;; Fix the first field if necessary
  1470. (when (string-match "^[ \t]*| *[#$] *|" line)
  1471. (setq new (replace-match (match-string 0 line) t t new)))
  1472. (beginning-of-line (if arg 2 1))
  1473. ;; Buffer may not end of a newline character, so ensure
  1474. ;; (beginning-of-line 2) moves point to a new line.
  1475. (unless (bolp) (insert "\n"))
  1476. (let (org-table-may-need-update) (insert-before-markers new "\n"))
  1477. (beginning-of-line 0)
  1478. (re-search-forward "| ?" (line-end-position) t)
  1479. (when (or org-table-may-need-update org-table-overlay-coordinates)
  1480. (org-table-align))
  1481. (when (or (not org-table-fix-formulas-confirm)
  1482. (funcall org-table-fix-formulas-confirm "Fix formulas? "))
  1483. (org-table-fix-formulas "@" nil (1- (org-table-current-dline)) 1)))))
  1484. ;;;###autoload
  1485. (defun org-table-insert-hline (&optional above)
  1486. "Insert a horizontal-line below the current line into the table.
  1487. With prefix ABOVE, insert above the current line."
  1488. (interactive "P")
  1489. (unless (org-at-table-p) (user-error "Not at a table"))
  1490. (when (eobp) (save-excursion (insert "\n")))
  1491. (unless (string-match-p "|[ \t]*$" (org-current-line-string))
  1492. (org-table-align))
  1493. (org-table-with-shrunk-columns
  1494. (let ((line (org-table-clean-line
  1495. (buffer-substring (point-at-bol) (point-at-eol))))
  1496. (col (current-column)))
  1497. (while (string-match "|\\( +\\)|" line)
  1498. (setq line (replace-match
  1499. (concat "+" (make-string (- (match-end 1) (match-beginning 1))
  1500. ?-) "|") t t line)))
  1501. (and (string-match "\\+" line) (setq line (replace-match "|" t t line)))
  1502. (beginning-of-line (if above 1 2))
  1503. (insert line "\n")
  1504. (beginning-of-line (if above 1 -1))
  1505. (org-move-to-column col)
  1506. (when org-table-overlay-coordinates (org-table-align)))))
  1507. ;;;###autoload
  1508. (defun org-table-hline-and-move (&optional same-column)
  1509. "Insert a hline and move to the row below that line."
  1510. (interactive "P")
  1511. (let ((col (org-table-current-column)))
  1512. (org-table-maybe-eval-formula)
  1513. (org-table-maybe-recalculate-line)
  1514. (org-table-insert-hline)
  1515. (end-of-line 2)
  1516. (if (looking-at "\n[ \t]*|-")
  1517. (progn (insert "\n|") (org-table-align))
  1518. (org-table-next-field))
  1519. (if same-column (org-table-goto-column col))))
  1520. (defun org-table-clean-line (s)
  1521. "Convert a table line S into a string with only \"|\" and space.
  1522. In particular, this does handle wide and invisible characters."
  1523. (if (string-match "^[ \t]*|-" s)
  1524. ;; It's a hline, just map the characters
  1525. (setq s (mapconcat (lambda (x) (if (member x '(?| ?+)) "|" " ")) s ""))
  1526. (while (string-match "|\\([ \t]*?[^ \t\r\n|][^\r\n|]*\\)|" s)
  1527. (setq s (replace-match
  1528. (concat "|" (make-string (org-string-width (match-string 1 s))
  1529. ?\ ) "|")
  1530. t t s)))
  1531. s))
  1532. ;;;###autoload
  1533. (defun org-table-kill-row ()
  1534. "Delete the current row or horizontal line from the table."
  1535. (interactive)
  1536. (unless (org-at-table-p) (user-error "Not at a table"))
  1537. (let ((col (current-column))
  1538. (dline (and (not (org-match-line org-table-hline-regexp))
  1539. (org-table-current-dline))))
  1540. (org-table-with-shrunk-columns
  1541. (kill-region (point-at-bol) (min (1+ (point-at-eol)) (point-max)))
  1542. (if (not (org-at-table-p)) (beginning-of-line 0))
  1543. (org-move-to-column col)
  1544. (when (and dline
  1545. (or (not org-table-fix-formulas-confirm)
  1546. (funcall org-table-fix-formulas-confirm "Fix formulas? ")))
  1547. (org-table-fix-formulas
  1548. "@" (list (cons (number-to-string dline) "INVALID")) dline -1 dline)))))
  1549. ;;;###autoload
  1550. (defun org-table-sort-lines
  1551. (&optional with-case sorting-type getkey-func compare-func interactive?)
  1552. "Sort table lines according to the column at point.
  1553. The position of point indicates the column to be used for
  1554. sorting, and the range of lines is the range between the nearest
  1555. horizontal separator lines, or the entire table of no such lines
  1556. exist. If point is before the first column, you will be prompted
  1557. for the sorting column. If there is an active region, the mark
  1558. specifies the first line and the sorting column, while point
  1559. should be in the last line to be included into the sorting.
  1560. The command then prompts for the sorting type which can be
  1561. alphabetically, numerically, or by time (as given in a time stamp
  1562. in the field, or as a HH:MM value). Sorting in reverse order is
  1563. also possible.
  1564. With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive
  1565. if the locale allows for it.
  1566. If SORTING-TYPE is specified when this function is called from a Lisp
  1567. program, no prompting will take place. SORTING-TYPE must be a character,
  1568. any of (?a ?A ?n ?N ?t ?T ?f ?F) where the capital letters indicate that
  1569. sorting should be done in reverse order.
  1570. If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
  1571. a function to be called to extract the key. It must return a value
  1572. that is compatible with COMPARE-FUNC, the function used to compare
  1573. entries.
  1574. A non-nil value for INTERACTIVE? is used to signal that this
  1575. function is being called interactively."
  1576. (interactive (list current-prefix-arg nil nil nil t))
  1577. (when (org-region-active-p) (goto-char (region-beginning)))
  1578. ;; Point must be either within a field or before a data line.
  1579. (save-excursion
  1580. (skip-chars-backward " \t")
  1581. (when (bolp) (search-forward "|" (line-end-position) t))
  1582. (org-table-check-inside-data-field))
  1583. ;; Set appropriate case sensitivity and column used for sorting.
  1584. (let ((column (let ((c (org-table-current-column)))
  1585. (cond ((> c 0) c)
  1586. (interactive?
  1587. (read-number "Use column N for sorting: "))
  1588. (t 1))))
  1589. (sorting-type
  1590. (or sorting-type
  1591. (read-char-exclusive "Sort Table: [a]lphabetic, [n]umeric, \
  1592. \[t]ime, [f]unc. A/N/T/F means reversed: ")))
  1593. (start (org-table-begin))
  1594. (end (org-table-end)))
  1595. (save-restriction
  1596. ;; Narrow buffer to appropriate sorting area.
  1597. (if (org-region-active-p)
  1598. (progn (goto-char (region-beginning))
  1599. (narrow-to-region
  1600. (point)
  1601. (save-excursion (goto-char (region-end))
  1602. (line-beginning-position 2))))
  1603. (narrow-to-region
  1604. (save-excursion
  1605. (if (re-search-backward org-table-hline-regexp start t)
  1606. (line-beginning-position 2)
  1607. start))
  1608. (if (save-excursion (re-search-forward org-table-hline-regexp end t))
  1609. (match-beginning 0)
  1610. end)))
  1611. ;; Determine arguments for `sort-subr'. Also record original
  1612. ;; position. `org-table-save-field' cannot help here since
  1613. ;; sorting is too much destructive.
  1614. (let* ((coordinates
  1615. (cons (count-lines (point-min) (line-beginning-position))
  1616. (current-column)))
  1617. (extract-key-from-field
  1618. ;; Function to be called on the contents of the field
  1619. ;; used for sorting in the current row.
  1620. (cl-case sorting-type
  1621. ((?n ?N) #'string-to-number)
  1622. ((?a ?A) #'org-sort-remove-invisible)
  1623. ((?t ?T)
  1624. (lambda (f)
  1625. (cond ((string-match org-ts-regexp-both f)
  1626. (float-time
  1627. (org-time-string-to-time (match-string 0 f))))
  1628. ((org-duration-p f) (org-duration-to-minutes f))
  1629. ((string-match "\\<[0-9]+:[0-9]\\{2\\}\\>" f)
  1630. (org-duration-to-minutes (match-string 0 f)))
  1631. (t 0))))
  1632. ((?f ?F)
  1633. (or getkey-func
  1634. (and interactive?
  1635. (org-read-function "Function for extracting keys: "))
  1636. (error "Missing key extractor to sort rows")))
  1637. (t (user-error "Invalid sorting type `%c'" sorting-type))))
  1638. (predicate
  1639. (cl-case sorting-type
  1640. ((?n ?N ?t ?T) #'<)
  1641. ((?a ?A) (if with-case #'org-string-collate-lessp
  1642. (lambda (s1 s2) (org-string-collate-lessp s1 s2 nil t))))
  1643. ((?f ?F)
  1644. (or compare-func
  1645. (and interactive?
  1646. (org-read-function
  1647. "Function for comparing keys (empty for default \
  1648. `sort-subr' predicate): "
  1649. 'allow-empty))))))
  1650. (shrunk-columns (remq column (org-table--list-shrunk-columns))))
  1651. (goto-char (point-min))
  1652. (sort-subr (memq sorting-type '(?A ?N ?T ?F))
  1653. (lambda ()
  1654. (forward-line)
  1655. (while (and (not (eobp))
  1656. (not (looking-at org-table-dataline-regexp)))
  1657. (forward-line)))
  1658. #'end-of-line
  1659. (lambda ()
  1660. (funcall extract-key-from-field
  1661. (org-trim (org-table-get-field column))))
  1662. nil
  1663. predicate)
  1664. ;; Hide all columns but the one being sorted.
  1665. (org-table--shrink-columns shrunk-columns start end)
  1666. ;; Move back to initial field.
  1667. (forward-line (car coordinates))
  1668. (move-to-column (cdr coordinates))))))
  1669. ;;;###autoload
  1670. (defun org-table-cut-region (beg end)
  1671. "Copy region in table to the clipboard and blank all relevant fields.
  1672. If there is no active region, use just the field at point."
  1673. (interactive (list
  1674. (if (org-region-active-p) (region-beginning) (point))
  1675. (if (org-region-active-p) (region-end) (point))))
  1676. (org-table-copy-region beg end 'cut))
  1677. ;;;###autoload
  1678. (defun org-table-copy-region (beg end &optional cut)
  1679. "Copy rectangular region in table to clipboard.
  1680. A special clipboard is used which can only be accessed with
  1681. `org-table-paste-rectangle'. Return the region copied, as a list
  1682. of lists of fields."
  1683. (interactive (list
  1684. (if (org-region-active-p) (region-beginning) (point))
  1685. (if (org-region-active-p) (region-end) (point))
  1686. current-prefix-arg))
  1687. (goto-char (min beg end))
  1688. (org-table-check-inside-data-field)
  1689. (let ((beg (line-beginning-position))
  1690. (c01 (org-table-current-column))
  1691. region)
  1692. (goto-char (max beg end))
  1693. (org-table-check-inside-data-field nil t)
  1694. (let* ((end (copy-marker (line-end-position)))
  1695. (c02 (org-table-current-column))
  1696. (column-start (min c01 c02))
  1697. (column-end (max c01 c02))
  1698. (column-number (1+ (- column-end column-start)))
  1699. (rpl (and cut " ")))
  1700. (goto-char beg)
  1701. (while (< (point) end)
  1702. (unless (org-at-table-hline-p)
  1703. ;; Collect every cell between COLUMN-START and COLUMN-END.
  1704. (let (cols)
  1705. (dotimes (c column-number)
  1706. (push (org-table-get-field (+ c column-start) rpl) cols))
  1707. (push (nreverse cols) region)))
  1708. (forward-line))
  1709. (set-marker end nil))
  1710. (when cut (org-table-align))
  1711. (message (substitute-command-keys "Cells in the region copied, use \
  1712. \\[org-table-paste-rectangle] to paste them in a table."))
  1713. (setq org-table-clip (nreverse region))))
  1714. ;;;###autoload
  1715. (defun org-table-paste-rectangle ()
  1716. "Paste a rectangular region into a table.
  1717. The upper right corner ends up in the current field. All involved fields
  1718. will be overwritten. If the rectangle does not fit into the present table,
  1719. the table is enlarged as needed. The process ignores horizontal separator
  1720. lines."
  1721. (interactive)
  1722. (unless (consp org-table-clip)
  1723. (user-error "First cut/copy a region to paste!"))
  1724. (org-table-check-inside-data-field)
  1725. (let* ((column (org-table-current-column))
  1726. (org-table-automatic-realign nil))
  1727. (org-table-save-field
  1728. (dolist (row org-table-clip)
  1729. (while (org-at-table-hline-p) (forward-line))
  1730. ;; If we left the table, create a new row.
  1731. (when (and (bolp) (not (looking-at "[ \t]*|")))
  1732. (end-of-line 0)
  1733. (org-table-next-field))
  1734. (let ((c column))
  1735. (dolist (field row)
  1736. (org-table-goto-column c nil 'force)
  1737. (org-table-get-field nil field)
  1738. (cl-incf c)))
  1739. (forward-line)))
  1740. (org-table-align)))
  1741. ;;;###autoload
  1742. (defun org-table-convert ()
  1743. "Convert from `org-mode' table to table.el and back.
  1744. Obviously, this only works within limits. When an Org table is converted
  1745. to table.el, all horizontal separator lines get lost, because table.el uses
  1746. these as cell boundaries and has no notion of horizontal lines. A table.el
  1747. table can be converted to an Org table only if it does not do row or column
  1748. spanning. Multiline cells will become multiple cells. Beware, Org mode
  1749. does not test if the table can be successfully converted - it blindly
  1750. applies a recipe that works for simple tables."
  1751. (interactive)
  1752. (require 'table)
  1753. (if (org-at-table.el-p)
  1754. ;; convert to Org table
  1755. (let ((beg (copy-marker (org-table-begin t)))
  1756. (end (copy-marker (org-table-end t))))
  1757. (table-unrecognize-region beg end)
  1758. (goto-char beg)
  1759. (while (re-search-forward "^\\([ \t]*\\)\\+-.*\n" end t)
  1760. (replace-match ""))
  1761. (goto-char beg))
  1762. (if (org-at-table-p)
  1763. ;; convert to table.el table
  1764. (let ((beg (copy-marker (org-table-begin)))
  1765. (end (copy-marker (org-table-end))))
  1766. ;; first, get rid of all horizontal lines
  1767. (goto-char beg)
  1768. (while (re-search-forward "^\\([ \t]*\\)|-.*\n" end t)
  1769. (replace-match ""))
  1770. ;; insert a hline before first
  1771. (goto-char beg)
  1772. (org-table-insert-hline 'above)
  1773. (beginning-of-line -1)
  1774. ;; insert a hline after each line
  1775. (while (progn (beginning-of-line 3) (< (point) end))
  1776. (org-table-insert-hline))
  1777. (goto-char beg)
  1778. (setq end (move-marker end (org-table-end)))
  1779. ;; replace "+" at beginning and ending of hlines
  1780. (while (re-search-forward "^\\([ \t]*\\)|-" end t)
  1781. (replace-match "\\1+-"))
  1782. (goto-char beg)
  1783. (while (re-search-forward "-|[ \t]*$" end t)
  1784. (replace-match "-+"))
  1785. (goto-char beg)))))
  1786. (defun org-table-transpose-table-at-point ()
  1787. "Transpose Org table at point and eliminate hlines.
  1788. So a table like
  1789. | 1 | 2 | 4 | 5 |
  1790. |---+---+---+---|
  1791. | a | b | c | d |
  1792. | e | f | g | h |
  1793. will be transposed as
  1794. | 1 | a | e |
  1795. | 2 | b | f |
  1796. | 4 | c | g |
  1797. | 5 | d | h |
  1798. Note that horizontal lines disappear."
  1799. (interactive)
  1800. (let* ((table (delete 'hline (org-table-to-lisp)))
  1801. (dline_old (org-table-current-line))
  1802. (col_old (org-table-current-column))
  1803. (contents (mapcar (lambda (_)
  1804. (let ((tp table))
  1805. (mapcar
  1806. (lambda (_)
  1807. (prog1
  1808. (pop (car tp))
  1809. (setq tp (cdr tp))))
  1810. table)))
  1811. (car table))))
  1812. (goto-char (org-table-begin))
  1813. (re-search-forward "|")
  1814. (backward-char)
  1815. (delete-region (point) (org-table-end))
  1816. (insert (mapconcat
  1817. (lambda(x)
  1818. (concat "| " (mapconcat 'identity x " | " ) " |\n" ))
  1819. contents ""))
  1820. (org-table-goto-line col_old)
  1821. (org-table-goto-column dline_old))
  1822. (org-table-align))
  1823. ;;;###autoload
  1824. (defun org-table-wrap-region (arg)
  1825. "Wrap several fields in a column like a paragraph.
  1826. This is useful if you'd like to spread the contents of a field over several
  1827. lines, in order to keep the table compact.
  1828. If there is an active region, and both point and mark are in the same column,
  1829. the text in the column is wrapped to minimum width for the given number of
  1830. lines. Generally, this makes the table more compact. A prefix ARG may be
  1831. used to change the number of desired lines. For example, \
  1832. `C-2 \\[org-table-wrap-region]'
  1833. formats the selected text to two lines. If the region was longer than two
  1834. lines, the remaining lines remain empty. A negative prefix argument reduces
  1835. the current number of lines by that amount. The wrapped text is pasted back
  1836. into the table. If you formatted it to more lines than it was before, fields
  1837. further down in the table get overwritten - so you might need to make space in
  1838. the table first.
  1839. If there is no region, the current field is split at the cursor position and
  1840. the text fragment to the right of the cursor is prepended to the field one
  1841. line down.
  1842. If there is no region, but you specify a prefix ARG, the current field gets
  1843. blank, and the content is appended to the field above."
  1844. (interactive "P")
  1845. (org-table-check-inside-data-field)
  1846. (if (org-region-active-p)
  1847. ;; There is a region: fill as a paragraph.
  1848. (let ((start (region-beginning)))
  1849. (org-table-cut-region (region-beginning) (region-end))
  1850. (when (> (length (car org-table-clip)) 1)
  1851. (user-error "Region must be limited to single column"))
  1852. (let ((nlines (cond ((not arg) (length org-table-clip))
  1853. ((< arg 1) (+ (length org-table-clip) arg))
  1854. (t arg))))
  1855. (setq org-table-clip
  1856. (mapcar #'list
  1857. (org-wrap (mapconcat #'car org-table-clip " ")
  1858. nil
  1859. nlines))))
  1860. (goto-char start)
  1861. (org-table-paste-rectangle))
  1862. ;; No region, split the current field at point.
  1863. (unless (org-get-alist-option org-M-RET-may-split-line 'table)
  1864. (skip-chars-forward "^\r\n|"))
  1865. (cond
  1866. (arg ; Combine with field above.
  1867. (let ((s (org-table-blank-field))
  1868. (col (org-table-current-column)))
  1869. (forward-line -1)
  1870. (while (org-at-table-hline-p) (forward-line -1))
  1871. (org-table-goto-column col)
  1872. (skip-chars-forward "^|")
  1873. (skip-chars-backward " ")
  1874. (insert " " (org-trim s))
  1875. (org-table-align)))
  1876. ((looking-at "\\([^|]+\\)+|") ; Split field.
  1877. (let ((s (match-string 1)))
  1878. (replace-match " |")
  1879. (goto-char (match-beginning 0))
  1880. (org-table-next-row)
  1881. (insert (org-trim s) " ")
  1882. (org-table-align)))
  1883. (t (org-table-next-row)))))
  1884. (defvar org-field-marker nil)
  1885. ;;;###autoload
  1886. (defun org-table-edit-field (arg)
  1887. "Edit table field in a different window.
  1888. This is mainly useful for fields that contain hidden parts.
  1889. When called with a `\\[universal-argument]' prefix, just make the full field
  1890. visible so that it can be edited in place.
  1891. When called with a `\\[universal-argument] \\[universal-argument]' prefix, \
  1892. toggle `org-table-follow-field-mode'."
  1893. (interactive "P")
  1894. (unless (org-at-table-p) (user-error "Not at a table"))
  1895. (cond
  1896. ((equal arg '(16))
  1897. (org-table-follow-field-mode (if org-table-follow-field-mode -1 1)))
  1898. (arg
  1899. (let ((b (save-excursion (skip-chars-backward "^|") (point)))
  1900. (e (save-excursion (skip-chars-forward "^|\r\n") (point))))
  1901. (remove-text-properties b e '(invisible t intangible t))
  1902. (if (and (boundp 'font-lock-mode) font-lock-mode)
  1903. (font-lock-fontify-block))))
  1904. (t
  1905. (let ((pos (point-marker))
  1906. (coord
  1907. (if (eq org-table-use-standard-references t)
  1908. (concat (org-number-to-letters (org-table-current-column))
  1909. (int-to-string (org-table-current-dline)))
  1910. (concat "@" (int-to-string (org-table-current-dline))
  1911. "$" (int-to-string (org-table-current-column)))))
  1912. (field (org-table-get-field))
  1913. (cw (current-window-configuration))
  1914. p)
  1915. (goto-char pos)
  1916. (org-switch-to-buffer-other-window "*Org Table Edit Field*")
  1917. (when (and (local-variable-p 'org-field-marker)
  1918. (markerp org-field-marker))
  1919. (move-marker org-field-marker nil))
  1920. (erase-buffer)
  1921. (insert "#\n# Edit field " coord " and finish with C-c C-c\n#\n")
  1922. (let ((org-inhibit-startup t)) (org-mode))
  1923. (auto-fill-mode -1)
  1924. (setq truncate-lines nil)
  1925. (setq word-wrap t)
  1926. (goto-char (setq p (point-max)))
  1927. (insert (org-trim field))
  1928. (remove-text-properties p (point-max) '(invisible t intangible t))
  1929. (goto-char p)
  1930. (setq-local org-finish-function 'org-table-finish-edit-field)
  1931. (setq-local org-window-configuration cw)
  1932. (setq-local org-field-marker pos)
  1933. (message "Edit and finish with C-c C-c")))))
  1934. (defun org-table-finish-edit-field ()
  1935. "Finish editing a table data field.
  1936. Remove all newline characters, insert the result into the table, realign
  1937. the table and kill the editing buffer."
  1938. (let ((pos org-field-marker)
  1939. (cw org-window-configuration)
  1940. (cb (current-buffer))
  1941. text)
  1942. (goto-char (point-min))
  1943. (while (re-search-forward "^#.*\n?" nil t) (replace-match ""))
  1944. (while (re-search-forward "\\([ \t]*\n[ \t]*\\)+" nil t)
  1945. (replace-match " "))
  1946. (setq text (org-trim (buffer-string)))
  1947. (set-window-configuration cw)
  1948. (kill-buffer cb)
  1949. (select-window (get-buffer-window (marker-buffer pos)))
  1950. (goto-char pos)
  1951. (move-marker pos nil)
  1952. (org-table-check-inside-data-field)
  1953. (org-table-get-field nil text)
  1954. (org-table-align)
  1955. (message "New field value inserted")))
  1956. (define-minor-mode org-table-follow-field-mode
  1957. "Minor mode to make the table field editor window follow the cursor.
  1958. When this mode is active, the field editor window will always show the
  1959. current field. The mode exits automatically when the cursor leaves the
  1960. table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
  1961. nil " TblFollow" nil
  1962. (if org-table-follow-field-mode
  1963. (add-hook 'post-command-hook 'org-table-follow-fields-with-editor
  1964. 'append 'local)
  1965. (remove-hook 'post-command-hook 'org-table-follow-fields-with-editor 'local)
  1966. (let* ((buf (get-buffer "*Org Table Edit Field*"))
  1967. (win (and buf (get-buffer-window buf))))
  1968. (when win (delete-window win))
  1969. (when buf
  1970. (with-current-buffer buf
  1971. (move-marker org-field-marker nil))
  1972. (kill-buffer buf)))))
  1973. (defun org-table-follow-fields-with-editor ()
  1974. (if (and org-table-exit-follow-field-mode-when-leaving-table
  1975. (not (org-at-table-p)))
  1976. ;; We have left the table, exit the follow mode
  1977. (org-table-follow-field-mode -1)
  1978. (when (org-table-check-inside-data-field 'noerror)
  1979. (let ((win (selected-window)))
  1980. (org-table-edit-field nil)
  1981. (org-fit-window-to-buffer)
  1982. (select-window win)))))
  1983. (defvar org-timecnt) ; dynamically scoped parameter
  1984. ;;;###autoload
  1985. (defun org-table-sum (&optional beg end nlast)
  1986. "Sum numbers in region of current table column.
  1987. The result will be displayed in the echo area, and will be available
  1988. as kill to be inserted with \\[yank].
  1989. If there is an active region, it is interpreted as a rectangle and all
  1990. numbers in that rectangle will be summed. If there is no active
  1991. region and point is located in a table column, sum all numbers in that
  1992. column.
  1993. If at least one number looks like a time HH:MM or HH:MM:SS, all other
  1994. numbers are assumed to be times as well (in decimal hours) and the
  1995. numbers are added as such.
  1996. If NLAST is a number, only the NLAST fields will actually be summed."
  1997. (interactive)
  1998. (save-excursion
  1999. (let (col (org-timecnt 0) diff h m s org-table-clip)
  2000. (cond
  2001. ((and beg end)) ; beg and end given explicitly
  2002. ((org-region-active-p)
  2003. (setq beg (region-beginning) end (region-end)))
  2004. (t
  2005. (setq col (org-table-current-column))
  2006. (goto-char (org-table-begin))
  2007. (unless (re-search-forward "^[ \t]*|[^-]" nil t)
  2008. (user-error "No table data"))
  2009. (org-table-goto-column col)
  2010. (setq beg (point))
  2011. (goto-char (org-table-end))
  2012. (unless (re-search-backward "^[ \t]*|[^-]" nil t)
  2013. (user-error "No table data"))
  2014. (org-table-goto-column col)
  2015. (setq end (point))))
  2016. (let* ((items (apply 'append (org-table-copy-region beg end)))
  2017. (items1 (cond ((not nlast) items)
  2018. ((>= nlast (length items)) items)
  2019. (t (setq items (reverse items))
  2020. (setcdr (nthcdr (1- nlast) items) nil)
  2021. (nreverse items))))
  2022. (numbers (delq nil (mapcar 'org-table-get-number-for-summing
  2023. items1)))
  2024. (res (apply '+ numbers))
  2025. (sres (if (= org-timecnt 0)
  2026. (number-to-string res)
  2027. (setq diff (* 3600 res)
  2028. h (floor (/ diff 3600)) diff (mod diff 3600)
  2029. m (floor (/ diff 60)) diff (mod diff 60)
  2030. s diff)
  2031. (format "%.0f:%02.0f:%02.0f" h m s))))
  2032. (kill-new sres)
  2033. (when (called-interactively-p 'interactive)
  2034. (message "%s" (substitute-command-keys
  2035. (format "Sum of %d items: %-20s \
  2036. \(\\[yank] will insert result into buffer)" (length numbers) sres))))
  2037. sres))))
  2038. (defun org-table-get-number-for-summing (s)
  2039. (let (n)
  2040. (if (string-match "^ *|? *" s)
  2041. (setq s (replace-match "" nil nil s)))
  2042. (if (string-match " *|? *$" s)
  2043. (setq s (replace-match "" nil nil s)))
  2044. (setq n (string-to-number s))
  2045. (cond
  2046. ((and (string-match "0" s)
  2047. (string-match "\\`[-+ \t0.edED]+\\'" s)) 0)
  2048. ((string-match "\\`[ \t]+\\'" s) nil)
  2049. ((string-match "\\`\\([0-9]+\\):\\([0-9]+\\)\\(:\\([0-9]+\\)\\)?\\'" s)
  2050. (let ((h (string-to-number (or (match-string 1 s) "0")))
  2051. (m (string-to-number (or (match-string 2 s) "0")))
  2052. (s (string-to-number (or (match-string 4 s) "0"))))
  2053. (if (boundp 'org-timecnt) (setq org-timecnt (1+ org-timecnt)))
  2054. (* 1.0 (+ h (/ m 60.0) (/ s 3600.0)))))
  2055. ((equal n 0) nil)
  2056. (t n))))
  2057. (defun org-table-current-field-formula (&optional key noerror)
  2058. "Return the formula active for the current field.
  2059. Assumes that table is already analyzed. If KEY is given, return
  2060. the key to this formula. Otherwise return the formula preceded
  2061. with \"=\" or \":=\"."
  2062. (let* ((line (count-lines org-table-current-begin-pos
  2063. (line-beginning-position)))
  2064. (row (org-table-line-to-dline line)))
  2065. (cond
  2066. (row
  2067. (let* ((col (org-table-current-column))
  2068. (name (car (rassoc (list line col)
  2069. org-table-named-field-locations)))
  2070. (scol (format "$%d" col))
  2071. (ref (format "@%d$%d" (org-table-current-dline) col))
  2072. (stored-list (org-table-get-stored-formulas noerror))
  2073. (ass (or (assoc name stored-list)
  2074. (assoc ref stored-list)
  2075. (assoc scol stored-list))))
  2076. (cond (key (car ass))
  2077. (ass (concat (if (string-match-p "^[0-9]+$" (car ass)) "=" ":=")
  2078. (cdr ass))))))
  2079. (noerror nil)
  2080. (t (error "No formula active for the current field")))))
  2081. (defun org-table-get-formula (&optional equation named)
  2082. "Read a formula from the minibuffer, offer stored formula as default.
  2083. When NAMED is non-nil, look for a named equation."
  2084. (let* ((stored-list (org-table-get-stored-formulas))
  2085. (name (car (rassoc (list (count-lines org-table-current-begin-pos
  2086. (line-beginning-position))
  2087. (org-table-current-column))
  2088. org-table-named-field-locations)))
  2089. (ref (format "@%d$%d"
  2090. (org-table-current-dline)
  2091. (org-table-current-column)))
  2092. (scol (cond
  2093. ((not named) (format "$%d" (org-table-current-column)))
  2094. ((and name (not (string-match "\\`LR[0-9]+\\'" name))) name)
  2095. (t ref)))
  2096. (name (or name ref))
  2097. (org-table-may-need-update nil)
  2098. (stored (cdr (assoc scol stored-list)))
  2099. (eq (cond
  2100. ((and stored equation (string-match-p "^ *=? *$" equation))
  2101. stored)
  2102. ((stringp equation) equation)
  2103. (t
  2104. (org-table-formula-from-user
  2105. (read-string
  2106. (org-table-formula-to-user
  2107. (format "%s formula %s=" (if named "Field" "Column") scol))
  2108. (if stored (org-table-formula-to-user stored) "")
  2109. 'org-table-formula-history)))))
  2110. mustsave)
  2111. (unless (org-string-nw-p eq)
  2112. ;; Remove formula.
  2113. (setq stored-list (delq (assoc scol stored-list) stored-list))
  2114. (org-table-store-formulas stored-list)
  2115. (user-error "Formula removed"))
  2116. (when (string-match "^ *=?" eq) (setq eq (replace-match "" t t eq)))
  2117. (when (string-match " *$" eq) (setq eq (replace-match "" t t eq)))
  2118. (when (and name (not named))
  2119. ;; We set the column equation, delete the named one.
  2120. (setq stored-list (delq (assoc name stored-list) stored-list)
  2121. mustsave t))
  2122. (if stored
  2123. (setcdr (assoc scol stored-list) eq)
  2124. (setq stored-list (cons (cons scol eq) stored-list)))
  2125. (when (or mustsave (not (equal stored eq)))
  2126. (org-table-store-formulas stored-list))
  2127. eq))
  2128. (defun org-table-store-formulas (alist &optional location)
  2129. "Store the list of formulas below the current table.
  2130. If optional argument LOCATION is a buffer position, insert it at
  2131. LOCATION instead."
  2132. (save-excursion
  2133. (if location
  2134. (progn (goto-char location) (beginning-of-line))
  2135. (goto-char (org-table-end)))
  2136. (let ((case-fold-search t))
  2137. (if (looking-at "\\([ \t]*\n\\)*[ \t]*\\(#\\+TBLFM:\\)\\(.*\n?\\)")
  2138. (progn
  2139. ;; Don't overwrite TBLFM, we might use text properties to
  2140. ;; store stuff.
  2141. (goto-char (match-beginning 3))
  2142. (delete-region (match-beginning 3) (match-end 0)))
  2143. (org-indent-line)
  2144. (insert (or (match-string 2) "#+TBLFM:")))
  2145. (insert " "
  2146. (mapconcat (lambda (x) (concat (car x) "=" (cdr x)))
  2147. (sort alist #'org-table-formula-less-p)
  2148. "::")
  2149. "\n"))))
  2150. (defsubst org-table-formula-make-cmp-string (a)
  2151. (when (string-match "\\`$[<>]" a)
  2152. (let ((arrow (string-to-char (substring a 1))))
  2153. ;; Fake a high number to make sure this is sorted at the end.
  2154. (setq a (org-table-formula-handle-first/last-rc a))
  2155. (setq a (format "$%d" (+ 10000
  2156. (if (= arrow ?<) -1000 0)
  2157. (string-to-number (substring a 1)))))))
  2158. (when (string-match
  2159. "^\\(@\\([0-9]+\\)\\)?\\(\\$?\\([0-9]+\\)\\)?\\(\\$?[a-zA-Z0-9]+\\)?"
  2160. a)
  2161. (concat
  2162. (if (match-end 2)
  2163. (format "@%05d" (string-to-number (match-string 2 a))) "")
  2164. (if (match-end 4)
  2165. (format "$%05d" (string-to-number (match-string 4 a))) "")
  2166. (if (match-end 5)
  2167. (concat "@@" (match-string 5 a))))))
  2168. (defun org-table-formula-less-p (a b)
  2169. "Compare two formulas for sorting."
  2170. (let ((as (org-table-formula-make-cmp-string (car a)))
  2171. (bs (org-table-formula-make-cmp-string (car b))))
  2172. (and as bs (string< as bs))))
  2173. ;;;###autoload
  2174. (defun org-table-get-stored-formulas (&optional noerror location)
  2175. "Return an alist with the stored formulas directly after current table.
  2176. By default, only return active formulas, i.e., formulas located
  2177. on the first line after the table. However, if optional argument
  2178. LOCATION is a buffer position, consider the formulas there."
  2179. (save-excursion
  2180. (if location
  2181. (progn (goto-char location) (beginning-of-line))
  2182. (goto-char (org-table-end)))
  2183. (let ((case-fold-search t))
  2184. (when (looking-at "\\([ \t]*\n\\)*[ \t]*#\\+TBLFM: *\\(.*\\)")
  2185. (let ((strings (org-split-string (match-string-no-properties 2)
  2186. " *:: *"))
  2187. eq-alist seen)
  2188. (dolist (string strings (nreverse eq-alist))
  2189. (when (string-match "\\`\\(@[-+I<>0-9.$@]+\\|\\$\\([_a-zA-Z0-9]+\\|\
  2190. \[<>]+\\)\\) *= *\\(.*[^ \t]\\)"
  2191. string)
  2192. (let ((lhs
  2193. (let ((m (match-string 1 string)))
  2194. (cond
  2195. ((not (match-end 2)) m)
  2196. ;; Is it a column reference?
  2197. ((string-match-p "\\`$\\([0-9]+\\|[<>]+\\)\\'" m) m)
  2198. ;; Since named columns are not possible in
  2199. ;; LHS, assume this is a named field.
  2200. (t (match-string 2 string)))))
  2201. (rhs (match-string 3 string)))
  2202. (push (cons lhs rhs) eq-alist)
  2203. (cond
  2204. ((not (member lhs seen)) (push lhs seen))
  2205. (noerror
  2206. (message
  2207. "Double definition `%s=' in TBLFM line, please fix by hand"
  2208. lhs)
  2209. (ding)
  2210. (sit-for 2))
  2211. (t
  2212. (user-error
  2213. "Double definition `%s=' in TBLFM line, please fix by hand"
  2214. lhs)))))))))))
  2215. (defun org-table-fix-formulas (key replace &optional limit delta remove)
  2216. "Modify the equations after the table structure has been edited.
  2217. KEY is \"@\" or \"$\". REPLACE is an alist of numbers to replace.
  2218. For all numbers larger than LIMIT, shift them by DELTA."
  2219. (save-excursion
  2220. (goto-char (org-table-end))
  2221. (while (let ((case-fold-search t)) (looking-at "[ \t]*#\\+tblfm:"))
  2222. (let ((msg "The formulas in #+TBLFM have been updated")
  2223. (re (concat key "\\([0-9]+\\)"))
  2224. (re2
  2225. (when remove
  2226. (if (or (equal key "$") (equal key "$LR"))
  2227. (format "\\(@[0-9]+\\)?%s%d=.*?\\(::\\|$\\)"
  2228. (regexp-quote key) remove)
  2229. (format "@%d\\$[0-9]+=.*?\\(::\\|$\\)" remove))))
  2230. s n a)
  2231. (when remove
  2232. (while (re-search-forward re2 (point-at-eol) t)
  2233. (unless (save-match-data (org-in-regexp "remote([^)]+?)"))
  2234. (if (equal (char-before (match-beginning 0)) ?.)
  2235. (user-error
  2236. "Change makes TBLFM term %s invalid, use undo to recover"
  2237. (match-string 0))
  2238. (replace-match "")))))
  2239. (while (re-search-forward re (point-at-eol) t)
  2240. (unless (save-match-data (org-in-regexp "remote([^)]+?)"))
  2241. (setq s (match-string 1) n (string-to-number s))
  2242. (cond
  2243. ((setq a (assoc s replace))
  2244. (replace-match (concat key (cdr a)) t t)
  2245. (message msg))
  2246. ((and limit (> n limit))
  2247. (replace-match (concat key (int-to-string (+ n delta))) t t)
  2248. (message msg))))))
  2249. (forward-line))))
  2250. ;;;###autoload
  2251. (defun org-table-maybe-eval-formula ()
  2252. "Check if the current field starts with \"=\" or \":=\".
  2253. If yes, store the formula and apply it."
  2254. ;; We already know we are in a table. Get field will only return a formula
  2255. ;; when appropriate. It might return a separator line, but no problem.
  2256. (when org-table-formula-evaluate-inline
  2257. (let* ((field (org-trim (or (org-table-get-field) "")))
  2258. named eq)
  2259. (when (string-match "^:?=\\(.*[^=]\\)$" field)
  2260. (setq named (equal (string-to-char field) ?:)
  2261. eq (match-string 1 field))
  2262. (org-table-eval-formula (and named '(4))
  2263. (org-table-formula-from-user eq))))))
  2264. (defvar org-recalc-commands nil
  2265. "List of commands triggering the recalculation of a line.
  2266. Will be filled automatically during use.")
  2267. (defvar org-recalc-marks
  2268. '((" " . "Unmarked: no special line, no automatic recalculation")
  2269. ("#" . "Automatically recalculate this line upon TAB, RET, and C-c C-c in the line")
  2270. ("*" . "Recalculate only when entire table is recalculated with `C-u C-c *'")
  2271. ("!" . "Column name definition line. Reference in formula as $name.")
  2272. ("$" . "Parameter definition line name=value. Reference in formula as $name.")
  2273. ("_" . "Names for values in row below this one.")
  2274. ("^" . "Names for values in row above this one.")))
  2275. ;;;###autoload
  2276. (defun org-table-rotate-recalc-marks (&optional newchar)
  2277. "Rotate the recalculation mark in the first column.
  2278. If in any row, the first field is not consistent with a mark,
  2279. insert a new column for the markers.
  2280. When there is an active region, change all the lines in the region,
  2281. after prompting for the marking character.
  2282. After each change, a message will be displayed indicating the meaning
  2283. of the new mark."
  2284. (interactive)
  2285. (unless (org-at-table-p) (user-error "Not at a table"))
  2286. (let* ((region (org-region-active-p))
  2287. (l1 (and region
  2288. (save-excursion (goto-char (region-beginning))
  2289. (copy-marker (line-beginning-position)))))
  2290. (l2 (and region
  2291. (save-excursion (goto-char (region-end))
  2292. (copy-marker (line-beginning-position)))))
  2293. (l (copy-marker (line-beginning-position)))
  2294. (col (org-table-current-column))
  2295. (newchar (if region
  2296. (char-to-string
  2297. (read-char-exclusive
  2298. "Change region to what mark? Type # * ! $ or SPC: "))
  2299. newchar))
  2300. (no-special-column
  2301. (save-excursion
  2302. (goto-char (org-table-begin))
  2303. (re-search-forward
  2304. "^[ \t]*|[^-|][^|]*[^#!$*_^| \t][^|]*|" (org-table-end) t))))
  2305. (when (and newchar (not (assoc newchar org-recalc-marks)))
  2306. (user-error "Invalid character `%s' in `org-table-rotate-recalc-marks'"
  2307. newchar))
  2308. (when l1 (goto-char l1))
  2309. (save-excursion
  2310. (beginning-of-line)
  2311. (unless (looking-at org-table-dataline-regexp)
  2312. (user-error "Not at a table data line")))
  2313. (when no-special-column
  2314. (org-table-goto-column 1)
  2315. (org-table-insert-column))
  2316. (let ((previous-line-end (line-end-position))
  2317. (newchar
  2318. (save-excursion
  2319. (beginning-of-line)
  2320. (cond ((not (looking-at "^[ \t]*| *\\([#!$*^_ ]\\) *|")) "#")
  2321. (newchar)
  2322. (t (cadr (member (match-string 1)
  2323. (append (mapcar #'car org-recalc-marks)
  2324. '(" ")))))))))
  2325. ;; Rotate mark in first row.
  2326. (org-table-get-field 1 (format " %s " newchar))
  2327. ;; Rotate marks in additional rows if a region is active.
  2328. (when region
  2329. (save-excursion
  2330. (forward-line)
  2331. (while (<= (point) l2)
  2332. (when (looking-at org-table-dataline-regexp)
  2333. (org-table-get-field 1 (format " %s " newchar)))
  2334. (forward-line))))
  2335. ;; Only align if rotation actually changed lines' length.
  2336. (when (/= previous-line-end (line-end-position)) (org-table-align)))
  2337. (goto-char l)
  2338. (org-table-goto-column (if no-special-column (1+ col) col))
  2339. (when l1 (set-marker l1 nil))
  2340. (when l2 (set-marker l2 nil))
  2341. (set-marker l nil)
  2342. (when (called-interactively-p 'interactive)
  2343. (message "%s" (cdr (assoc newchar org-recalc-marks))))))
  2344. ;;;###autoload
  2345. (defun org-table-analyze ()
  2346. "Analyze table at point and store results.
  2347. This function sets up the following dynamically scoped variables:
  2348. `org-table-column-name-regexp',
  2349. `org-table-column-names',
  2350. `org-table-current-begin-pos',
  2351. `org-table-current-line-types',
  2352. `org-table-current-ncol',
  2353. `org-table-dlines',
  2354. `org-table-hlines',
  2355. `org-table-local-parameters',
  2356. `org-table-named-field-locations'."
  2357. (let ((beg (org-table-begin))
  2358. (end (org-table-end)))
  2359. (save-excursion
  2360. (goto-char beg)
  2361. ;; Extract column names.
  2362. (setq org-table-column-names nil)
  2363. (when (save-excursion
  2364. (re-search-forward "^[ \t]*| *! *\\(|.*\\)" end t))
  2365. (let ((c 1))
  2366. (dolist (name (org-split-string (match-string 1) " *| *"))
  2367. (cl-incf c)
  2368. (when (string-match "\\`[a-zA-Z][_a-zA-Z0-9]*\\'" name)
  2369. (push (cons name (int-to-string c)) org-table-column-names)))))
  2370. (setq org-table-column-names (nreverse org-table-column-names))
  2371. (setq org-table-column-name-regexp
  2372. (format "\\$\\(%s\\)\\>"
  2373. (regexp-opt (mapcar #'car org-table-column-names) t)))
  2374. ;; Extract local parameters.
  2375. (setq org-table-local-parameters nil)
  2376. (save-excursion
  2377. (while (re-search-forward "^[ \t]*| *\\$ *\\(|.*\\)" end t)
  2378. (dolist (field (org-split-string (match-string 1) " *| *"))
  2379. (when (string-match
  2380. "\\`\\([a-zA-Z][_a-zA-Z0-9]*\\|%\\) *= *\\(.*\\)" field)
  2381. (push (cons (match-string 1 field) (match-string 2 field))
  2382. org-table-local-parameters)))))
  2383. ;; Update named fields locations. We minimize `count-lines'
  2384. ;; processing by storing last known number of lines in LAST.
  2385. (setq org-table-named-field-locations nil)
  2386. (save-excursion
  2387. (let ((last (cons (point) 0)))
  2388. (while (re-search-forward "^[ \t]*| *\\([_^]\\) *\\(|.*\\)" end t)
  2389. (let ((c (match-string 1))
  2390. (fields (org-split-string (match-string 2) " *| *")))
  2391. (save-excursion
  2392. (forward-line (if (equal c "_") 1 -1))
  2393. (let ((fields1
  2394. (and (looking-at "^[ \t]*|[^|]*\\(|.*\\)")
  2395. (org-split-string (match-string 1) " *| *")))
  2396. (line (cl-incf (cdr last) (count-lines (car last) (point))))
  2397. (col 1))
  2398. (setcar last (point)) ; Update last known position.
  2399. (while (and fields fields1)
  2400. (let ((field (pop fields))
  2401. (v (pop fields1)))
  2402. (cl-incf col)
  2403. (when (and (stringp field)
  2404. (stringp v)
  2405. (string-match "\\`[a-zA-Z][_a-zA-Z0-9]*\\'"
  2406. field))
  2407. (push (cons field v) org-table-local-parameters)
  2408. (push (list field line col)
  2409. org-table-named-field-locations))))))))))
  2410. ;; Re-use existing markers when possible.
  2411. (if (markerp org-table-current-begin-pos)
  2412. (move-marker org-table-current-begin-pos (point))
  2413. (setq org-table-current-begin-pos (point-marker)))
  2414. ;; Analyze the line types.
  2415. (let ((l 0) hlines dlines types)
  2416. (while (looking-at "[ \t]*|\\(-\\)?")
  2417. (push (if (match-end 1) 'hline 'dline) types)
  2418. (if (match-end 1) (push l hlines) (push l dlines))
  2419. (forward-line)
  2420. (cl-incf l))
  2421. (push 'hline types) ; Add an imaginary extra hline to the end.
  2422. (setq org-table-current-line-types (apply #'vector (nreverse types)))
  2423. (setq org-table-dlines (apply #'vector (cons nil (nreverse dlines))))
  2424. (setq org-table-hlines (apply #'vector (cons nil (nreverse hlines)))))
  2425. ;; Get the number of columns from the first data line in table.
  2426. (goto-char beg)
  2427. (forward-line (aref org-table-dlines 1))
  2428. (let* ((fields
  2429. (org-split-string
  2430. (buffer-substring (line-beginning-position) (line-end-position))
  2431. "[ \t]*|[ \t]*"))
  2432. (nfields (length fields))
  2433. al al2)
  2434. (setq org-table-current-ncol nfields)
  2435. (let ((last-dline
  2436. (aref org-table-dlines (1- (length org-table-dlines)))))
  2437. (dotimes (i nfields)
  2438. (let ((column (1+ i)))
  2439. (push (list (format "LR%d" column) last-dline column) al)
  2440. (push (cons (format "LR%d" column) (nth i fields)) al2))))
  2441. (setq org-table-named-field-locations
  2442. (append org-table-named-field-locations al))
  2443. (setq org-table-local-parameters
  2444. (append org-table-local-parameters al2))))))
  2445. (defun org-table-goto-field (ref &optional create-column-p)
  2446. "Move point to a specific field in the current table.
  2447. REF is either the name of a field its absolute reference, as
  2448. a string. No column is created unless CREATE-COLUMN-P is
  2449. non-nil. If it is a function, it is called with the column
  2450. number as its argument as is used as a predicate to know if the
  2451. column can be created.
  2452. This function assumes the table is already analyzed (i.e., using
  2453. `org-table-analyze')."
  2454. (let* ((coordinates
  2455. (cond
  2456. ((cdr (assoc ref org-table-named-field-locations)))
  2457. ((string-match "\\`@\\([1-9][0-9]*\\)\\$\\([1-9][0-9]*\\)\\'" ref)
  2458. (list (condition-case nil
  2459. (aref org-table-dlines
  2460. (string-to-number (match-string 1 ref)))
  2461. (error (user-error "Invalid row number in %s" ref)))
  2462. (string-to-number (match-string 2 ref))))
  2463. (t (user-error "Unknown field: %s" ref))))
  2464. (line (car coordinates))
  2465. (column (nth 1 coordinates))
  2466. (create-new-column (if (functionp create-column-p)
  2467. (funcall create-column-p column)
  2468. create-column-p)))
  2469. (when coordinates
  2470. (goto-char org-table-current-begin-pos)
  2471. (forward-line line)
  2472. (org-table-goto-column column nil create-new-column))))
  2473. ;;;###autoload
  2474. (defun org-table-maybe-recalculate-line ()
  2475. "Recompute the current line if marked for it, and if we haven't just done it."
  2476. (interactive)
  2477. (and org-table-allow-automatic-line-recalculation
  2478. (not (and (memq last-command org-recalc-commands)
  2479. (eq org-last-recalc-line (line-beginning-position))))
  2480. (save-excursion (beginning-of-line 1)
  2481. (looking-at org-table-auto-recalculate-regexp))
  2482. (org-table-recalculate) t))
  2483. (defvar org-tbl-calc-modes) ;; Dynamically bound in `org-table-eval-formula'
  2484. (defsubst org-set-calc-mode (var &optional value)
  2485. (if (stringp var)
  2486. (setq var (assoc var '(("D" calc-angle-mode deg)
  2487. ("R" calc-angle-mode rad)
  2488. ("F" calc-prefer-frac t)
  2489. ("S" calc-symbolic-mode t)))
  2490. value (nth 2 var) var (nth 1 var)))
  2491. (if (memq var org-tbl-calc-modes)
  2492. (setcar (cdr (memq var org-tbl-calc-modes)) value)
  2493. (cons var (cons value org-tbl-calc-modes)))
  2494. org-tbl-calc-modes)
  2495. ;;;###autoload
  2496. (defun org-table-eval-formula (&optional arg equation
  2497. suppress-align suppress-const
  2498. suppress-store suppress-analysis)
  2499. "Replace the table field value at the cursor by the result of a calculation.
  2500. In a table, this command replaces the value in the current field with the
  2501. result of a formula. It also installs the formula as the \"current\" column
  2502. formula, by storing it in a special line below the table. When called
  2503. with a `\\[universal-argument]' prefix the formula is installed as a \
  2504. field formula.
  2505. When called with a `\\[universal-argument] \\[universal-argument]' prefix, \
  2506. insert the active equation for the field
  2507. back into the current field, so that it can be edited there. This is \
  2508. useful
  2509. in order to use \\<org-table-fedit-map>`\\[org-table-show-reference]' to \
  2510. check the referenced fields.
  2511. When called, the command first prompts for a formula, which is read in
  2512. the minibuffer. Previously entered formulas are available through the
  2513. history list, and the last used formula is offered as a default.
  2514. These stored formulas are adapted correctly when moving, inserting, or
  2515. deleting columns with the corresponding commands.
  2516. The formula can be any algebraic expression understood by the Calc package.
  2517. For details, see the Org mode manual.
  2518. This function can also be called from Lisp programs and offers
  2519. additional arguments: EQUATION can be the formula to apply. If this
  2520. argument is given, the user will not be prompted.
  2521. SUPPRESS-ALIGN is used to speed-up recursive calls by by-passing
  2522. unnecessary aligns.
  2523. SUPPRESS-CONST suppresses the interpretation of constants in the
  2524. formula, assuming that this has been done already outside the
  2525. function.
  2526. SUPPRESS-STORE means the formula should not be stored, either
  2527. because it is already stored, or because it is a modified
  2528. equation that should not overwrite the stored one.
  2529. SUPPRESS-ANALYSIS prevents analyzing the table and checking
  2530. location of point."
  2531. (interactive "P")
  2532. (unless suppress-analysis
  2533. (org-table-check-inside-data-field nil t)
  2534. (org-table-analyze))
  2535. (if (equal arg '(16))
  2536. (let ((eq (org-table-current-field-formula)))
  2537. (org-table-get-field nil eq)
  2538. (org-table-align)
  2539. (setq org-table-may-need-update t))
  2540. (let* (fields
  2541. (ndown (if (integerp arg) arg 1))
  2542. (org-table-automatic-realign nil)
  2543. (case-fold-search nil)
  2544. (down (> ndown 1))
  2545. (formula (if (and equation suppress-store)
  2546. equation
  2547. (org-table-get-formula equation (equal arg '(4)))))
  2548. (n0 (org-table-current-column))
  2549. (org-tbl-calc-modes (copy-sequence org-calc-default-modes))
  2550. (numbers nil) ; was a variable, now fixed default
  2551. (keep-empty nil)
  2552. n form form0 formrpl formrg bw fmt x ev orig c lispp literal
  2553. duration duration-output-format)
  2554. ;; Parse the format string. Since we have a lot of modes, this is
  2555. ;; a lot of work. However, I think calc still uses most of the time.
  2556. (if (string-match ";" formula)
  2557. (let ((tmp (org-split-string formula ";")))
  2558. (setq formula (car tmp)
  2559. fmt (concat (cdr (assoc "%" org-table-local-parameters))
  2560. (nth 1 tmp)))
  2561. (while (string-match "\\([pnfse]\\)\\(-?[0-9]+\\)" fmt)
  2562. (setq c (string-to-char (match-string 1 fmt))
  2563. n (string-to-number (match-string 2 fmt)))
  2564. (if (= c ?p)
  2565. (setq org-tbl-calc-modes (org-set-calc-mode 'calc-internal-prec n))
  2566. (setq org-tbl-calc-modes
  2567. (org-set-calc-mode
  2568. 'calc-float-format
  2569. (list (cdr (assoc c '((?n . float) (?f . fix)
  2570. (?s . sci) (?e . eng))))
  2571. n))))
  2572. (setq fmt (replace-match "" t t fmt)))
  2573. (if (string-match "[tTU]" fmt)
  2574. (let ((ff (match-string 0 fmt)))
  2575. (setq duration t numbers t
  2576. duration-output-format
  2577. (cond ((equal ff "T") nil)
  2578. ((equal ff "t") org-table-duration-custom-format)
  2579. ((equal ff "U") 'hh:mm))
  2580. fmt (replace-match "" t t fmt))))
  2581. (if (string-match "N" fmt)
  2582. (setq numbers t
  2583. fmt (replace-match "" t t fmt)))
  2584. (if (string-match "L" fmt)
  2585. (setq literal t
  2586. fmt (replace-match "" t t fmt)))
  2587. (if (string-match "E" fmt)
  2588. (setq keep-empty t
  2589. fmt (replace-match "" t t fmt)))
  2590. (while (string-match "[DRFS]" fmt)
  2591. (setq org-tbl-calc-modes (org-set-calc-mode (match-string 0 fmt)))
  2592. (setq fmt (replace-match "" t t fmt)))
  2593. (unless (string-match "\\S-" fmt)
  2594. (setq fmt nil))))
  2595. (when (and (not suppress-const) org-table-formula-use-constants)
  2596. (setq formula (org-table-formula-substitute-names formula)))
  2597. (setq orig (or (get-text-property 1 :orig-formula formula) "?"))
  2598. (setq formula (org-table-formula-handle-first/last-rc formula))
  2599. (while (> ndown 0)
  2600. (setq fields (org-split-string
  2601. (org-trim
  2602. (buffer-substring-no-properties
  2603. (line-beginning-position) (line-end-position)))
  2604. " *| *"))
  2605. ;; replace fields with duration values if relevant
  2606. (if duration
  2607. (setq fields
  2608. (mapcar (lambda (x) (org-table-time-string-to-seconds x))
  2609. fields)))
  2610. (if (eq numbers t)
  2611. (setq fields (mapcar
  2612. (lambda (x)
  2613. (if (string-match "\\S-" x)
  2614. (number-to-string (string-to-number x))
  2615. x))
  2616. fields)))
  2617. (setq ndown (1- ndown))
  2618. (setq form (copy-sequence formula)
  2619. lispp (and (> (length form) 2) (equal (substring form 0 2) "'(")))
  2620. (if (and lispp literal) (setq lispp 'literal))
  2621. ;; Insert row and column number of formula result field
  2622. (while (string-match "[@$]#" form)
  2623. (setq form
  2624. (replace-match
  2625. (format "%d"
  2626. (save-match-data
  2627. (if (equal (substring form (match-beginning 0)
  2628. (1+ (match-beginning 0)))
  2629. "@")
  2630. (org-table-current-dline)
  2631. (org-table-current-column))))
  2632. t t form)))
  2633. ;; Check for old vertical references
  2634. (org-table--error-on-old-row-references form)
  2635. ;; Insert remote references
  2636. (setq form (org-table-remote-reference-indirection form))
  2637. (while (string-match "\\<remote([ \t]*\\([^,)]+\\)[ \t]*,[ \t]*\\([^\n)]+\\))" form)
  2638. (setq form
  2639. (replace-match
  2640. (save-match-data
  2641. (org-table-make-reference
  2642. (let ((rmtrng (org-table-get-remote-range
  2643. (match-string 1 form) (match-string 2 form))))
  2644. (if duration
  2645. (if (listp rmtrng)
  2646. (mapcar (lambda(x) (org-table-time-string-to-seconds x)) rmtrng)
  2647. (org-table-time-string-to-seconds rmtrng))
  2648. rmtrng))
  2649. keep-empty numbers lispp))
  2650. t t form)))
  2651. ;; Insert complex ranges
  2652. (while (and (string-match org-table-range-regexp form)
  2653. (> (length (match-string 0 form)) 1))
  2654. (setq formrg
  2655. (save-match-data
  2656. (org-table-get-range
  2657. (match-string 0 form) org-table-current-begin-pos n0)))
  2658. (setq formrpl
  2659. (save-match-data
  2660. (org-table-make-reference
  2661. ;; possibly handle durations
  2662. (if duration
  2663. (if (listp formrg)
  2664. (mapcar (lambda(x) (org-table-time-string-to-seconds x)) formrg)
  2665. (org-table-time-string-to-seconds formrg))
  2666. formrg)
  2667. keep-empty numbers lispp)))
  2668. (if (not (save-match-data
  2669. (string-match (regexp-quote form) formrpl)))
  2670. (setq form (replace-match formrpl t t form))
  2671. (user-error "Spreadsheet error: invalid reference \"%s\"" form)))
  2672. ;; Insert simple ranges, i.e. included in the current row.
  2673. (while (string-match
  2674. "\\$\\(\\([-+]\\)?[0-9]+\\)\\.\\.\\$\\(\\([-+]\\)?[0-9]+\\)"
  2675. form)
  2676. (setq form
  2677. (replace-match
  2678. (save-match-data
  2679. (org-table-make-reference
  2680. (cl-subseq fields
  2681. (+ (if (match-end 2) n0 0)
  2682. (string-to-number (match-string 1 form))
  2683. -1)
  2684. (+ (if (match-end 4) n0 0)
  2685. (string-to-number (match-string 3 form))))
  2686. keep-empty numbers lispp))
  2687. t t form)))
  2688. (setq form0 form)
  2689. ;; Insert the references to fields in same row
  2690. (while (string-match "\\$\\(\\([-+]\\)?[0-9]+\\)" form)
  2691. (setq n (+ (string-to-number (match-string 1 form))
  2692. (if (match-end 2) n0 0))
  2693. x (nth (1- (if (= n 0) n0 (max n 1))) fields)
  2694. formrpl (save-match-data
  2695. (org-table-make-reference
  2696. x keep-empty numbers lispp)))
  2697. (when (or (not x)
  2698. (save-match-data
  2699. (string-match (regexp-quote formula) formrpl)))
  2700. (user-error "Invalid field specifier \"%s\""
  2701. (match-string 0 form)))
  2702. (setq form (replace-match formrpl t t form)))
  2703. (if lispp
  2704. (setq ev (condition-case nil
  2705. (eval (eval (read form)))
  2706. (error "#ERROR"))
  2707. ev (if (numberp ev) (number-to-string ev) ev)
  2708. ev (if duration (org-table-time-seconds-to-string
  2709. (string-to-number ev)
  2710. duration-output-format) ev))
  2711. ;; Use <...> time-stamps so that Calc can handle them.
  2712. (setq form
  2713. (replace-regexp-in-string org-ts-regexp-inactive "<\\1>" form))
  2714. ;; Internationalize local time-stamps by setting locale to
  2715. ;; "C".
  2716. (setq form
  2717. (replace-regexp-in-string
  2718. org-ts-regexp
  2719. (lambda (ts)
  2720. (let ((system-time-locale "C"))
  2721. (format-time-string
  2722. (org-time-stamp-format
  2723. (string-match-p "[0-9]\\{1,2\\}:[0-9]\\{2\\}" ts))
  2724. (apply #'encode-time
  2725. (save-match-data (org-parse-time-string ts))))))
  2726. form t t))
  2727. (setq ev (if (and duration (string-match "^[0-9]+:[0-9]+\\(?::[0-9]+\\)?$" form))
  2728. form
  2729. (calc-eval (cons form org-tbl-calc-modes)
  2730. (when (and (not keep-empty) numbers) 'num)))
  2731. ev (if duration (org-table-time-seconds-to-string
  2732. (if (string-match "^[0-9]+:[0-9]+\\(?::[0-9]+\\)?$" ev)
  2733. (string-to-number (org-table-time-string-to-seconds ev))
  2734. (string-to-number ev))
  2735. duration-output-format)
  2736. ev)))
  2737. (when org-table-formula-debug
  2738. (with-output-to-temp-buffer "*Substitution History*"
  2739. (princ (format "Substitution history of formula
  2740. Orig: %s
  2741. $xyz-> %s
  2742. @r$c-> %s
  2743. $1-> %s\n" orig formula form0 form))
  2744. (if (consp ev)
  2745. (princ (format " %s^\nError: %s"
  2746. (make-string (car ev) ?\-) (nth 1 ev)))
  2747. (princ (format "Result: %s\nFormat: %s\nFinal: %s"
  2748. ev (or fmt "NONE")
  2749. (if fmt (format fmt (string-to-number ev)) ev)))))
  2750. (setq bw (get-buffer-window "*Substitution History*"))
  2751. (org-fit-window-to-buffer bw)
  2752. (unless (and (called-interactively-p 'any) (not ndown))
  2753. (unless (let (inhibit-redisplay)
  2754. (y-or-n-p "Debugging Formula. Continue to next? "))
  2755. (org-table-align)
  2756. (user-error "Abort"))
  2757. (delete-window bw)
  2758. (message "")))
  2759. (when (consp ev) (setq fmt nil ev "#ERROR"))
  2760. (org-table-justify-field-maybe
  2761. (format org-table-formula-field-format
  2762. (cond
  2763. ((not (stringp ev)) ev)
  2764. (fmt (format fmt (string-to-number ev)))
  2765. ;; Replace any active time stamp in the result with
  2766. ;; an inactive one. Dates in tables are likely
  2767. ;; piece of regular data, not meant to appear in the
  2768. ;; agenda.
  2769. (t (replace-regexp-in-string org-ts-regexp "[\\1]" ev)))))
  2770. (if (and down (> ndown 0) (looking-at ".*\n[ \t]*|[^-]"))
  2771. (call-interactively 'org-return)
  2772. (setq ndown 0)))
  2773. (and down (org-table-maybe-recalculate-line))
  2774. (or suppress-align (and org-table-may-need-update
  2775. (org-table-align))))))
  2776. (defun org-table-put-field-property (prop value)
  2777. (save-excursion
  2778. (put-text-property (progn (skip-chars-backward "^|") (point))
  2779. (progn (skip-chars-forward "^|") (point))
  2780. prop value)))
  2781. (defun org-table-get-range (desc &optional tbeg col highlight corners-only)
  2782. "Get a calc vector from a column, according to descriptor DESC.
  2783. Optional arguments TBEG and COL can give the beginning of the table and
  2784. the current column, to avoid unnecessary parsing.
  2785. HIGHLIGHT means just highlight the range.
  2786. When CORNERS-ONLY is set, only return the corners of the range as
  2787. a list (line1 column1 line2 column2) where line1 and line2 are
  2788. line numbers relative to beginning of table, or TBEG, and column1
  2789. and column2 are table column numbers."
  2790. (let* ((desc (if (string-match-p "\\`\\$[0-9]+\\.\\.\\$[0-9]+\\'" desc)
  2791. (replace-regexp-in-string "\\$" "@0$" desc)
  2792. desc))
  2793. (col (or col (org-table-current-column)))
  2794. (tbeg (or tbeg (org-table-begin)))
  2795. (thisline (count-lines tbeg (line-beginning-position))))
  2796. (unless (string-match org-table-range-regexp desc)
  2797. (user-error "Invalid table range specifier `%s'" desc))
  2798. (let ((rangep (match-end 3))
  2799. (r1 (let ((r (and (match-end 1) (match-string 1 desc))))
  2800. (or (save-match-data
  2801. (and (org-string-nw-p r)
  2802. (org-table--descriptor-line r thisline)))
  2803. thisline)))
  2804. (r2 (let ((r (and (match-end 4) (match-string 4 desc))))
  2805. (or (save-match-data
  2806. (and (org-string-nw-p r)
  2807. (org-table--descriptor-line r thisline)))
  2808. thisline)))
  2809. (c1 (let ((c (and (match-end 2) (substring (match-string 2 desc) 1))))
  2810. (if (or (not c) (= (string-to-number c) 0)) col
  2811. (+ (string-to-number c)
  2812. (if (memq (string-to-char c) '(?- ?+)) col 0)))))
  2813. (c2 (let ((c (and (match-end 5) (substring (match-string 5 desc) 1))))
  2814. (if (or (not c) (= (string-to-number c) 0)) col
  2815. (+ (string-to-number c)
  2816. (if (memq (string-to-char c) '(?- ?+)) col 0))))))
  2817. (save-excursion
  2818. (if (and (not corners-only)
  2819. (or (not rangep) (and (= r1 r2) (= c1 c2))))
  2820. ;; Just one field.
  2821. (progn
  2822. (forward-line (- r1 thisline))
  2823. (while (not (looking-at org-table-dataline-regexp))
  2824. (forward-line))
  2825. (prog1 (org-trim (org-table-get-field c1))
  2826. (when highlight (org-table-highlight-rectangle))))
  2827. ;; A range, return a vector. First sort the numbers to get
  2828. ;; a regular rectangle.
  2829. (let ((first-row (min r1 r2))
  2830. (last-row (max r1 r2))
  2831. (first-column (min c1 c2))
  2832. (last-column (max c1 c2)))
  2833. (if corners-only (list first-row first-column last-row last-column)
  2834. ;; Copy the range values into a list.
  2835. (forward-line (- first-row thisline))
  2836. (while (not (looking-at org-table-dataline-regexp))
  2837. (forward-line)
  2838. (cl-incf first-row))
  2839. (org-table-goto-column first-column)
  2840. (let ((beg (point)))
  2841. (forward-line (- last-row first-row))
  2842. (while (not (looking-at org-table-dataline-regexp))
  2843. (forward-line -1))
  2844. (org-table-goto-column last-column)
  2845. (let ((end (point)))
  2846. (when highlight
  2847. (org-table-highlight-rectangle
  2848. beg (progn (skip-chars-forward "^|\n") (point))))
  2849. ;; Return string representation of calc vector.
  2850. (mapcar #'org-trim
  2851. (apply #'append
  2852. (org-table-copy-region beg end))))))))))))
  2853. (defun org-table--descriptor-line (desc cline)
  2854. "Return relative line number corresponding to descriptor DESC.
  2855. The cursor is currently in relative line number CLINE."
  2856. (if (string-match "\\`[0-9]+\\'" desc)
  2857. (aref org-table-dlines (string-to-number desc))
  2858. (when (or (not (string-match
  2859. "^\\(\\([-+]\\)?\\(I+\\)\\)?\\(\\([-+]\\)?\\([0-9]+\\)\\)?"
  2860. ;; 1 2 3 4 5 6
  2861. desc))
  2862. (and (not (match-end 3)) (not (match-end 6)))
  2863. (and (match-end 3) (match-end 6) (not (match-end 5))))
  2864. (user-error "Invalid row descriptor `%s'" desc))
  2865. (let* ((hn (and (match-end 3) (- (match-end 3) (match-beginning 3))))
  2866. (hdir (match-string 2 desc))
  2867. (odir (match-string 5 desc))
  2868. (on (and (match-end 6) (string-to-number (match-string 6 desc))))
  2869. (rel (and (match-end 6)
  2870. (or (and (match-end 1) (not (match-end 3)))
  2871. (match-end 5)))))
  2872. (when (and hn (not hdir))
  2873. (setq cline 0)
  2874. (setq hdir "+")
  2875. (when (eq (aref org-table-current-line-types 0) 'hline) (cl-decf hn)))
  2876. (when (and (not hn) on (not odir)) (user-error "Should never happen"))
  2877. (when hn
  2878. (setq cline
  2879. (org-table--row-type 'hline hn cline (equal hdir "-") nil desc)))
  2880. (when on
  2881. (setq cline
  2882. (org-table--row-type 'dline on cline (equal odir "-") rel desc)))
  2883. cline)))
  2884. (defun org-table--row-type (type n i backwards relative desc)
  2885. "Return relative line of Nth row with type TYPE.
  2886. Search starts from relative line I. When BACKWARDS in non-nil,
  2887. look before I. When RELATIVE is non-nil, the reference is
  2888. relative. DESC is the original descriptor that started the
  2889. search, as a string."
  2890. (let ((l (length org-table-current-line-types)))
  2891. (catch :exit
  2892. (dotimes (_ n)
  2893. (while (and (cl-incf i (if backwards -1 1))
  2894. (>= i 0)
  2895. (< i l)
  2896. (not (eq (aref org-table-current-line-types i) type))
  2897. ;; We are going to cross a hline. Check if this is
  2898. ;; an authorized move.
  2899. (cond
  2900. ((not relative))
  2901. ((not (eq (aref org-table-current-line-types i) 'hline)))
  2902. ((eq org-table-relative-ref-may-cross-hline t))
  2903. ((eq org-table-relative-ref-may-cross-hline 'error)
  2904. (user-error "Row descriptor %s crosses hline" desc))
  2905. (t (cl-decf i (if backwards -1 1)) ; Step back.
  2906. (throw :exit nil)))))))
  2907. (cond ((or (< i 0) (>= i l))
  2908. (user-error "Row descriptor %s leads outside table" desc))
  2909. ;; The last hline doesn't exist. Instead, point to last row
  2910. ;; in table.
  2911. ((= i (1- l)) (1- i))
  2912. (t i))))
  2913. (defun org-table--error-on-old-row-references (s)
  2914. (when (string-match "&[-+0-9I]" s)
  2915. (user-error "Formula contains old &row reference, please rewrite using @-syntax")))
  2916. (defun org-table-make-reference (elements keep-empty numbers lispp)
  2917. "Convert list ELEMENTS to something appropriate to insert into formula.
  2918. KEEP-EMPTY indicated to keep empty fields, default is to skip them.
  2919. NUMBERS indicates that everything should be converted to numbers.
  2920. LISPP non-nil means to return something appropriate for a Lisp
  2921. list, `literal' is for the format specifier L."
  2922. ;; Calc nan (not a number) is used for the conversion of the empty
  2923. ;; field to a reference for several reasons: (i) It is accepted in a
  2924. ;; Calc formula (e. g. "" or "()" would result in a Calc error).
  2925. ;; (ii) In a single field (not in range) it can be distinguished
  2926. ;; from "(nan)" which is the reference made from a single field
  2927. ;; containing "nan".
  2928. (if (stringp elements)
  2929. ;; field reference
  2930. (if lispp
  2931. (if (eq lispp 'literal)
  2932. elements
  2933. (if (and (eq elements "") (not keep-empty))
  2934. ""
  2935. (prin1-to-string
  2936. (if numbers (string-to-number elements) elements))))
  2937. (if (string-match "\\S-" elements)
  2938. (progn
  2939. (when numbers (setq elements (number-to-string
  2940. (string-to-number elements))))
  2941. (concat "(" elements ")"))
  2942. (if (or (not keep-empty) numbers) "(0)" "nan")))
  2943. ;; range reference
  2944. (unless keep-empty
  2945. (setq elements
  2946. (delq nil
  2947. (mapcar (lambda (x) (if (string-match "\\S-" x) x nil))
  2948. elements))))
  2949. (setq elements (or elements '())) ; if delq returns nil then we need '()
  2950. (if lispp
  2951. (mapconcat
  2952. (lambda (x)
  2953. (if (eq lispp 'literal)
  2954. x
  2955. (prin1-to-string (if numbers (string-to-number x) x))))
  2956. elements " ")
  2957. (concat "[" (mapconcat
  2958. (lambda (x)
  2959. (if (string-match "\\S-" x)
  2960. (if numbers
  2961. (number-to-string (string-to-number x))
  2962. x)
  2963. (if (or (not keep-empty) numbers) "0" "nan")))
  2964. elements
  2965. ",") "]"))))
  2966. (defun org-table-message-once-per-second (t1 &rest args)
  2967. "If there has been more than one second since T1, display message.
  2968. ARGS are passed as arguments to the `message' function. Returns
  2969. current time if a message is printed, otherwise returns T1. If
  2970. T1 is nil, always messages."
  2971. (let ((curtime (current-time)))
  2972. (if (or (not t1) (< 0 (nth 1 (time-subtract curtime t1))))
  2973. (progn (apply 'message args)
  2974. curtime)
  2975. t1)))
  2976. ;;;###autoload
  2977. (defun org-table-recalculate (&optional all noalign)
  2978. "Recalculate the current table line by applying all stored formulas.
  2979. With prefix arg ALL, do this for all lines in the table.
  2980. When called with a `\\[universal-argument] \\[universal-argument]' prefix, or \
  2981. if ALL is the symbol `iterate',
  2982. recompute the table until it no longer changes.
  2983. If NOALIGN is not nil, do not re-align the table after the computations
  2984. are done. This is typically used internally to save time, if it is
  2985. known that the table will be realigned a little later anyway."
  2986. (interactive "P")
  2987. (unless (memq this-command org-recalc-commands)
  2988. (push this-command org-recalc-commands))
  2989. (unless (org-at-table-p) (user-error "Not at a table"))
  2990. (if (or (eq all 'iterate) (equal all '(16)))
  2991. (org-table-iterate)
  2992. (org-table-analyze)
  2993. (let* ((eqlist (sort (org-table-get-stored-formulas)
  2994. (lambda (a b) (string< (car a) (car b)))))
  2995. (inhibit-redisplay (not debug-on-error))
  2996. (line-re org-table-dataline-regexp)
  2997. (log-first-time (current-time))
  2998. (log-last-time log-first-time)
  2999. (cnt 0)
  3000. beg end eqlcol eqlfield)
  3001. ;; Insert constants in all formulas.
  3002. (when eqlist
  3003. (org-table-save-field
  3004. ;; Expand equations, then split the equation list between
  3005. ;; column formulas and field formulas.
  3006. (dolist (eq eqlist)
  3007. (let* ((rhs (org-table-formula-substitute-names
  3008. (org-table-formula-handle-first/last-rc (cdr eq))))
  3009. (old-lhs (car eq))
  3010. (lhs
  3011. (org-table-formula-handle-first/last-rc
  3012. (cond
  3013. ((string-match "\\`@-?I+" old-lhs)
  3014. (user-error "Can't assign to hline relative reference"))
  3015. ((string-match "\\`$[<>]" old-lhs)
  3016. (let ((new (org-table-formula-handle-first/last-rc
  3017. old-lhs)))
  3018. (when (assoc new eqlist)
  3019. (user-error "\"%s=\" formula tries to overwrite \
  3020. existing formula for column %s"
  3021. old-lhs
  3022. new))
  3023. new))
  3024. (t old-lhs)))))
  3025. (if (string-match-p "\\`\\$[0-9]+\\'" lhs)
  3026. (push (cons lhs rhs) eqlcol)
  3027. (push (cons lhs rhs) eqlfield))))
  3028. (setq eqlcol (nreverse eqlcol))
  3029. ;; Expand ranges in lhs of formulas
  3030. (setq eqlfield (org-table-expand-lhs-ranges (nreverse eqlfield)))
  3031. ;; Get the correct line range to process.
  3032. (if all
  3033. (progn
  3034. (setq end (copy-marker (org-table-end)))
  3035. (goto-char (setq beg org-table-current-begin-pos))
  3036. (cond
  3037. ((re-search-forward org-table-calculate-mark-regexp end t)
  3038. ;; This is a table with marked lines, compute selected
  3039. ;; lines.
  3040. (setq line-re org-table-recalculate-regexp))
  3041. ;; Move forward to the first non-header line.
  3042. ((and (re-search-forward org-table-dataline-regexp end t)
  3043. (re-search-forward org-table-hline-regexp end t)
  3044. (re-search-forward org-table-dataline-regexp end t))
  3045. (setq beg (match-beginning 0)))
  3046. ;; Just leave BEG at the start of the table.
  3047. (t nil)))
  3048. (setq beg (line-beginning-position)
  3049. end (copy-marker (line-beginning-position 2))))
  3050. (goto-char beg)
  3051. ;; Mark named fields untouchable. Also check if several
  3052. ;; field/range formulas try to set the same field.
  3053. (remove-text-properties beg end '(:org-untouchable t))
  3054. (let ((current-line (count-lines org-table-current-begin-pos
  3055. (line-beginning-position)))
  3056. seen-fields)
  3057. (dolist (eq eqlfield)
  3058. (let* ((name (car eq))
  3059. (location (assoc name org-table-named-field-locations))
  3060. (eq-line (or (nth 1 location)
  3061. (and (string-match "\\`@\\([0-9]+\\)" name)
  3062. (aref org-table-dlines
  3063. (string-to-number
  3064. (match-string 1 name))))))
  3065. (reference
  3066. (if location
  3067. ;; Turn field coordinates associated to NAME
  3068. ;; into an absolute reference.
  3069. (format "@%d$%d"
  3070. (org-table-line-to-dline eq-line)
  3071. (nth 2 location))
  3072. name)))
  3073. (when (member reference seen-fields)
  3074. (user-error "Several field/range formulas try to set %s"
  3075. reference))
  3076. (push reference seen-fields)
  3077. (when (or all (eq eq-line current-line))
  3078. (org-table-goto-field name)
  3079. (org-table-put-field-property :org-untouchable t)))))
  3080. ;; Evaluate the column formulas, but skip fields covered by
  3081. ;; field formulas.
  3082. (goto-char beg)
  3083. (while (re-search-forward line-re end t)
  3084. (unless (string-match "\\` *[_^!$/] *\\'" (org-table-get-field 1))
  3085. ;; Unprotected line, recalculate.
  3086. (cl-incf cnt)
  3087. (when all
  3088. (setq log-last-time
  3089. (org-table-message-once-per-second
  3090. log-last-time
  3091. "Re-applying formulas to full table...(line %d)" cnt)))
  3092. (if (markerp org-last-recalc-line)
  3093. (move-marker org-last-recalc-line (line-beginning-position))
  3094. (setq org-last-recalc-line
  3095. (copy-marker (line-beginning-position))))
  3096. (dolist (entry eqlcol)
  3097. (goto-char org-last-recalc-line)
  3098. (org-table-goto-column
  3099. (string-to-number (substring (car entry) 1)) nil 'force)
  3100. (unless (get-text-property (point) :org-untouchable)
  3101. (org-table-eval-formula
  3102. nil (cdr entry) 'noalign 'nocst 'nostore 'noanalysis)))))
  3103. ;; Evaluate the field formulas.
  3104. (dolist (eq eqlfield)
  3105. (let ((reference (car eq))
  3106. (formula (cdr eq)))
  3107. (setq log-last-time
  3108. (org-table-message-once-per-second
  3109. (and all log-last-time)
  3110. "Re-applying formula to field: %s" (car eq)))
  3111. (org-table-goto-field
  3112. reference
  3113. ;; Possibly create a new column, as long as
  3114. ;; `org-table-formula-create-columns' allows it.
  3115. (let ((column-count (progn (end-of-line)
  3116. (1- (org-table-current-column)))))
  3117. (lambda (column)
  3118. (when (> column 1000)
  3119. (user-error "Formula column target too large"))
  3120. (and (> column column-count)
  3121. (or (eq org-table-formula-create-columns t)
  3122. (and (eq org-table-formula-create-columns 'warn)
  3123. (progn
  3124. (org-display-warning
  3125. "Out-of-bounds formula added columns")
  3126. t))
  3127. (and (eq org-table-formula-create-columns 'prompt)
  3128. (yes-or-no-p
  3129. "Out-of-bounds formula. Add columns? "))
  3130. (user-error
  3131. "Missing columns in the table. Aborting"))))))
  3132. (org-table-eval-formula nil formula t t t t))))
  3133. ;; Clean up markers and internal text property.
  3134. (remove-text-properties (point-min) (point-max) '(org-untouchable t))
  3135. (set-marker end nil)
  3136. (unless noalign
  3137. (when org-table-may-need-update (org-table-align))
  3138. (when all
  3139. (org-table-message-once-per-second
  3140. log-first-time "Re-applying formulas to %d lines... done" cnt)))
  3141. (org-table-message-once-per-second
  3142. (and all log-first-time) "Re-applying formulas... done")))))
  3143. ;;;###autoload
  3144. (defun org-table-iterate (&optional arg)
  3145. "Recalculate the table until it does not change anymore.
  3146. The maximum number of iterations is 10, but you can choose a different value
  3147. with the prefix ARG."
  3148. (interactive "P")
  3149. (let ((imax (if arg (prefix-numeric-value arg) 10))
  3150. (i 0)
  3151. (lasttbl (buffer-substring (org-table-begin) (org-table-end)))
  3152. thistbl)
  3153. (catch 'exit
  3154. (while (< i imax)
  3155. (setq i (1+ i))
  3156. (org-table-recalculate 'all)
  3157. (setq thistbl (buffer-substring (org-table-begin) (org-table-end)))
  3158. (if (not (string= lasttbl thistbl))
  3159. (setq lasttbl thistbl)
  3160. (if (> i 1)
  3161. (message "Convergence after %d iterations" i)
  3162. (message "Table was already stable"))
  3163. (throw 'exit t)))
  3164. (user-error "No convergence after %d iterations" i))))
  3165. ;;;###autoload
  3166. (defun org-table-recalculate-buffer-tables ()
  3167. "Recalculate all tables in the current buffer."
  3168. (interactive)
  3169. (org-with-wide-buffer
  3170. (org-table-map-tables
  3171. (lambda ()
  3172. ;; Reason for separate `org-table-align': When repeating
  3173. ;; (org-table-recalculate t) `org-table-may-need-update' gets in
  3174. ;; the way.
  3175. (org-table-recalculate t t)
  3176. (org-table-align))
  3177. t)))
  3178. ;;;###autoload
  3179. (defun org-table-iterate-buffer-tables ()
  3180. "Iterate all tables in the buffer, to converge inter-table dependencies."
  3181. (interactive)
  3182. (let* ((imax 10)
  3183. (i imax)
  3184. (checksum (md5 (buffer-string)))
  3185. c1)
  3186. (org-with-wide-buffer
  3187. (catch 'exit
  3188. (while (> i 0)
  3189. (setq i (1- i))
  3190. (org-table-map-tables (lambda () (org-table-recalculate t t)) t)
  3191. (if (equal checksum (setq c1 (md5 (buffer-string))))
  3192. (progn
  3193. (org-table-map-tables #'org-table-align t)
  3194. (message "Convergence after %d iterations" (- imax i))
  3195. (throw 'exit t))
  3196. (setq checksum c1)))
  3197. (org-table-map-tables #'org-table-align t)
  3198. (user-error "No convergence after %d iterations" imax)))))
  3199. (defun org-table-calc-current-TBLFM (&optional arg)
  3200. "Apply the #+TBLFM in the line at point to the table."
  3201. (interactive "P")
  3202. (unless (org-at-TBLFM-p) (user-error "Not at a #+TBLFM line"))
  3203. (let ((formula (buffer-substring
  3204. (line-beginning-position)
  3205. (line-end-position))))
  3206. (save-excursion
  3207. ;; Insert a temporary formula at right after the table
  3208. (goto-char (org-table-TBLFM-begin))
  3209. (let ((s (point-marker)))
  3210. (insert formula "\n")
  3211. (let ((e (point-marker)))
  3212. ;; Recalculate the table.
  3213. (beginning-of-line 0) ; move to the inserted line
  3214. (skip-chars-backward " \r\n\t")
  3215. (unwind-protect
  3216. (org-call-with-arg #'org-table-recalculate (or arg t))
  3217. ;; Delete the formula inserted temporarily.
  3218. (delete-region s e)
  3219. (set-marker s nil)
  3220. (set-marker e nil)))))))
  3221. (defun org-table-TBLFM-begin ()
  3222. "Find the beginning of the TBLFM lines and return its position.
  3223. Return nil when the beginning of TBLFM line was not found."
  3224. (save-excursion
  3225. (when (progn (forward-line 1)
  3226. (re-search-backward org-table-TBLFM-begin-regexp nil t))
  3227. (line-beginning-position 2))))
  3228. (defun org-table-expand-lhs-ranges (equations)
  3229. "Expand list of formulas.
  3230. If some of the RHS in the formulas are ranges or a row reference,
  3231. expand them to individual field equations for each field. This
  3232. function assumes the table is already analyzed (i.e., using
  3233. `org-table-analyze')."
  3234. (let (res)
  3235. (dolist (e equations (nreverse res))
  3236. (let ((lhs (car e))
  3237. (rhs (cdr e)))
  3238. (cond
  3239. ((string-match-p "\\`@-?[-+0-9]+\\$-?[0-9]+\\'" lhs)
  3240. ;; This just refers to one fixed field.
  3241. (push e res))
  3242. ((string-match-p "\\`[a-zA-Z][_a-zA-Z0-9]*\\'" lhs)
  3243. ;; This just refers to one fixed named field.
  3244. (push e res))
  3245. ((string-match-p "\\`\\$[0-9]+\\'" lhs)
  3246. ;; Column formulas are treated specially and are not
  3247. ;; expanded.
  3248. (push e res))
  3249. ((string-match "\\`@[0-9]+\\'" lhs)
  3250. (dotimes (ic org-table-current-ncol)
  3251. (push (cons (propertize (format "%s$%d" lhs (1+ ic)) :orig-eqn e)
  3252. rhs)
  3253. res)))
  3254. (t
  3255. (let* ((range (org-table-get-range
  3256. lhs org-table-current-begin-pos 1 nil 'corners))
  3257. (r1 (org-table-line-to-dline (nth 0 range)))
  3258. (c1 (nth 1 range))
  3259. (r2 (org-table-line-to-dline (nth 2 range) 'above))
  3260. (c2 (nth 3 range)))
  3261. (cl-loop for ir from r1 to r2 do
  3262. (cl-loop for ic from c1 to c2 do
  3263. (push (cons (propertize
  3264. (format "@%d$%d" ir ic) :orig-eqn e)
  3265. rhs)
  3266. res))))))))))
  3267. (defun org-table-formula-handle-first/last-rc (s)
  3268. "Replace @<, @>, $<, $> with first/last row/column of the table.
  3269. So @< and $< will always be replaced with @1 and $1, respectively.
  3270. The advantage of these special markers are that structure editing of
  3271. the table will not change them, while @1 and $1 will be modified
  3272. when a line/row is swapped out of that privileged position. So for
  3273. formulas that use a range of rows or columns, it may often be better
  3274. to anchor the formula with \"I\" row markers, or to offset from the
  3275. borders of the table using the @< @> $< $> makers."
  3276. (let (n nmax len char (start 0))
  3277. (while (string-match "\\([@$]\\)\\(<+\\|>+\\)\\|\\(remote([^)]+)\\)"
  3278. s start)
  3279. (if (match-end 3)
  3280. (setq start (match-end 3))
  3281. (setq nmax (if (equal (match-string 1 s) "@")
  3282. (1- (length org-table-dlines))
  3283. org-table-current-ncol)
  3284. len (- (match-end 2) (match-beginning 2))
  3285. char (string-to-char (match-string 2 s))
  3286. n (if (= char ?<)
  3287. len
  3288. (- nmax len -1)))
  3289. (if (or (< n 1) (> n nmax))
  3290. (user-error "Reference \"%s\" in expression \"%s\" points outside table"
  3291. (match-string 0 s) s))
  3292. (setq start (match-beginning 0))
  3293. (setq s (replace-match (format "%s%d" (match-string 1 s) n) t t s)))))
  3294. s)
  3295. (defun org-table-formula-substitute-names (f)
  3296. "Replace $const with values in string F."
  3297. (let ((start 0)
  3298. (pp (/= (string-to-char f) ?'))
  3299. (duration (string-match-p ";.*[Tt].*\\'" f))
  3300. (new (replace-regexp-in-string ; Check for column names.
  3301. org-table-column-name-regexp
  3302. (lambda (m)
  3303. (concat "$" (cdr (assoc (match-string 1 m)
  3304. org-table-column-names))))
  3305. f t t)))
  3306. ;; Parameters and constants.
  3307. (while (setq start
  3308. (string-match
  3309. "\\$\\([a-zA-Z][_a-zA-Z0-9]*\\)\\|\\(\\<remote([^)]*)\\)"
  3310. new start))
  3311. (if (match-end 2) (setq start (match-end 2))
  3312. (cl-incf start)
  3313. ;; When a duration is expected, convert value on the fly.
  3314. (let ((value
  3315. (save-match-data
  3316. (let ((v (org-table-get-constant (match-string 1 new))))
  3317. (if (and (org-string-nw-p v) duration)
  3318. (org-table-time-string-to-seconds v)
  3319. v)))))
  3320. (when value
  3321. (setq new (replace-match
  3322. (concat (and pp "(") value (and pp ")")) t t new))))))
  3323. (if org-table-formula-debug (propertize new :orig-formula f) new)))
  3324. (defun org-table-get-constant (const)
  3325. "Find the value for a parameter or constant in a formula.
  3326. Parameters get priority."
  3327. (or (cdr (assoc const org-table-local-parameters))
  3328. (cdr (assoc const org-table-formula-constants-local))
  3329. (cdr (assoc const org-table-formula-constants))
  3330. (and (fboundp 'constants-get) (constants-get const))
  3331. (and (string= (substring const 0 (min 5 (length const))) "PROP_")
  3332. (org-entry-get nil (substring const 5) 'inherit))
  3333. "#UNDEFINED_NAME"))
  3334. (defvar org-table-fedit-map
  3335. (let ((map (make-sparse-keymap)))
  3336. (org-defkey map "\C-x\C-s" 'org-table-fedit-finish)
  3337. (org-defkey map "\C-c\C-s" 'org-table-fedit-finish)
  3338. (org-defkey map "\C-c\C-c" 'org-table-fedit-finish)
  3339. (org-defkey map "\C-c'" 'org-table-fedit-finish)
  3340. (org-defkey map "\C-c\C-q" 'org-table-fedit-abort)
  3341. (org-defkey map "\C-c?" 'org-table-show-reference)
  3342. (org-defkey map [(meta shift up)] 'org-table-fedit-line-up)
  3343. (org-defkey map [(meta shift down)] 'org-table-fedit-line-down)
  3344. (org-defkey map [(shift up)] 'org-table-fedit-ref-up)
  3345. (org-defkey map [(shift down)] 'org-table-fedit-ref-down)
  3346. (org-defkey map [(shift left)] 'org-table-fedit-ref-left)
  3347. (org-defkey map [(shift right)] 'org-table-fedit-ref-right)
  3348. (org-defkey map [(meta up)] 'org-table-fedit-scroll-down)
  3349. (org-defkey map [(meta down)] 'org-table-fedit-scroll)
  3350. (org-defkey map [(meta tab)] 'lisp-complete-symbol)
  3351. (org-defkey map "\M-\C-i" 'lisp-complete-symbol)
  3352. (org-defkey map [(tab)] 'org-table-fedit-lisp-indent)
  3353. (org-defkey map "\C-i" 'org-table-fedit-lisp-indent)
  3354. (org-defkey map "\C-c\C-r" 'org-table-fedit-toggle-ref-type)
  3355. (org-defkey map "\C-c}" 'org-table-fedit-toggle-coordinates)
  3356. map))
  3357. (easy-menu-define org-table-fedit-menu org-table-fedit-map "Org Edit Formulas Menu"
  3358. '("Edit-Formulas"
  3359. ["Finish and Install" org-table-fedit-finish t]
  3360. ["Finish, Install, and Apply" (org-table-fedit-finish t) :keys "C-u C-c C-c"]
  3361. ["Abort" org-table-fedit-abort t]
  3362. "--"
  3363. ["Pretty-Print Lisp Formula" org-table-fedit-lisp-indent t]
  3364. ["Complete Lisp Symbol" lisp-complete-symbol t]
  3365. "--"
  3366. "Shift Reference at Point"
  3367. ["Up" org-table-fedit-ref-up t]
  3368. ["Down" org-table-fedit-ref-down t]
  3369. ["Left" org-table-fedit-ref-left t]
  3370. ["Right" org-table-fedit-ref-right t]
  3371. "-"
  3372. "Change Test Row for Column Formulas"
  3373. ["Up" org-table-fedit-line-up t]
  3374. ["Down" org-table-fedit-line-down t]
  3375. "--"
  3376. ["Scroll Table Window" org-table-fedit-scroll t]
  3377. ["Scroll Table Window down" org-table-fedit-scroll-down t]
  3378. ["Show Table Grid" org-table-fedit-toggle-coordinates
  3379. :style toggle :selected (with-current-buffer (marker-buffer org-pos)
  3380. org-table-overlay-coordinates)]
  3381. "--"
  3382. ["Standard Refs (B3 instead of @3$2)" org-table-fedit-toggle-ref-type
  3383. :style toggle :selected org-table-buffer-is-an]))
  3384. (defvar org-pos)
  3385. (defvar org-table--fedit-source nil
  3386. "Position of the TBLFM line being edited.")
  3387. ;;;###autoload
  3388. (defun org-table-edit-formulas ()
  3389. "Edit the formulas of the current table in a separate buffer."
  3390. (interactive)
  3391. (let ((at-tblfm (org-at-TBLFM-p)))
  3392. (unless (or at-tblfm (org-at-table-p))
  3393. (user-error "Not at a table"))
  3394. (save-excursion
  3395. ;; Move point within the table before analyzing it.
  3396. (when at-tblfm (re-search-backward "^[ \t]*|"))
  3397. (org-table-analyze))
  3398. (let ((key (org-table-current-field-formula 'key 'noerror))
  3399. (eql (sort (org-table-get-stored-formulas t (and at-tblfm (point)))
  3400. #'org-table-formula-less-p))
  3401. (pos (point-marker))
  3402. (source (copy-marker (line-beginning-position)))
  3403. (startline 1)
  3404. (wc (current-window-configuration))
  3405. (sel-win (selected-window))
  3406. (titles '((column . "# Column Formulas\n")
  3407. (field . "# Field and Range Formulas\n")
  3408. (named . "# Named Field Formulas\n"))))
  3409. (org-switch-to-buffer-other-window "*Edit Formulas*")
  3410. (erase-buffer)
  3411. ;; Keep global-font-lock-mode from turning on font-lock-mode
  3412. (let ((font-lock-global-modes '(not fundamental-mode)))
  3413. (fundamental-mode))
  3414. (setq-local font-lock-global-modes (list 'not major-mode))
  3415. (setq-local org-pos pos)
  3416. (setq-local org-table--fedit-source source)
  3417. (setq-local org-window-configuration wc)
  3418. (setq-local org-selected-window sel-win)
  3419. (use-local-map org-table-fedit-map)
  3420. (add-hook 'post-command-hook #'org-table-fedit-post-command t t)
  3421. (easy-menu-add org-table-fedit-menu)
  3422. (setq startline (org-current-line))
  3423. (dolist (entry eql)
  3424. (let* ((type (cond
  3425. ((string-match "\\`$\\([0-9]+\\|[<>]+\\)\\'" (car entry))
  3426. 'column)
  3427. ((equal (string-to-char (car entry)) ?@) 'field)
  3428. (t 'named)))
  3429. (title (assq type titles)))
  3430. (when title
  3431. (unless (bobp) (insert "\n"))
  3432. (insert
  3433. (org-add-props (cdr title) nil 'face font-lock-comment-face))
  3434. (setq titles (remove title titles)))
  3435. (when (equal key (car entry)) (setq startline (org-current-line)))
  3436. (let ((s (concat
  3437. (if (memq (string-to-char (car entry)) '(?@ ?$)) "" "$")
  3438. (car entry) " = " (cdr entry) "\n")))
  3439. (remove-text-properties 0 (length s) '(face nil) s)
  3440. (insert s))))
  3441. (when (eq org-table-use-standard-references t)
  3442. (org-table-fedit-toggle-ref-type))
  3443. (org-goto-line startline)
  3444. (message "%s" (substitute-command-keys "\\<org-mode-map>\
  3445. Edit formulas, finish with `\\[org-ctrl-c-ctrl-c]' or `\\[org-edit-special]'. \
  3446. See menu for more commands.")))))
  3447. (defun org-table-fedit-post-command ()
  3448. (when (not (memq this-command '(lisp-complete-symbol)))
  3449. (let ((win (selected-window)))
  3450. (save-excursion
  3451. (ignore-errors (org-table-show-reference))
  3452. (select-window win)))))
  3453. (defun org-table-formula-to-user (s)
  3454. "Convert a formula from internal to user representation."
  3455. (if (eq org-table-use-standard-references t)
  3456. (org-table-convert-refs-to-an s)
  3457. s))
  3458. (defun org-table-formula-from-user (s)
  3459. "Convert a formula from user to internal representation."
  3460. (if org-table-use-standard-references
  3461. (org-table-convert-refs-to-rc s)
  3462. s))
  3463. (defun org-table-convert-refs-to-rc (s)
  3464. "Convert spreadsheet references from A7 to @7$28.
  3465. Works for single references, but also for entire formulas and even the
  3466. full TBLFM line."
  3467. (let ((start 0))
  3468. (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^,)]*)\\)" s start)
  3469. (cond
  3470. ((match-end 3)
  3471. ;; format match, just advance
  3472. (setq start (match-end 0)))
  3473. ((and (> (match-beginning 0) 0)
  3474. (equal ?. (aref s (max (1- (match-beginning 0)) 0)))
  3475. (not (equal ?. (aref s (max (- (match-beginning 0) 2) 0)))))
  3476. ;; 3.e5 or something like this.
  3477. (setq start (match-end 0)))
  3478. ((or (> (- (match-end 1) (match-beginning 1)) 2)
  3479. ;; (member (match-string 1 s)
  3480. ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
  3481. )
  3482. ;; function name, just advance
  3483. (setq start (match-end 0)))
  3484. (t
  3485. (setq start (match-beginning 0)
  3486. s (replace-match
  3487. (if (equal (match-string 2 s) "&")
  3488. (format "$%d" (org-letters-to-number (match-string 1 s)))
  3489. (format "@%d$%d"
  3490. (string-to-number (match-string 2 s))
  3491. (org-letters-to-number (match-string 1 s))))
  3492. t t s)))))
  3493. s))
  3494. (defun org-table-convert-refs-to-an (s)
  3495. "Convert spreadsheet references from to @7$28 to AB7.
  3496. Works for single references, but also for entire formulas and even the
  3497. full TBLFM line."
  3498. (while (string-match "@\\([0-9]+\\)\\$\\([0-9]+\\)" s)
  3499. (setq s (replace-match
  3500. (format "%s%d"
  3501. (org-number-to-letters
  3502. (string-to-number (match-string 2 s)))
  3503. (string-to-number (match-string 1 s)))
  3504. t t s)))
  3505. (while (string-match "\\(^\\|[^0-9a-zA-Z]\\)\\$\\([0-9]+\\)" s)
  3506. (setq s (replace-match (concat "\\1"
  3507. (org-number-to-letters
  3508. (string-to-number (match-string 2 s))) "&")
  3509. t nil s)))
  3510. s)
  3511. (defun org-letters-to-number (s)
  3512. "Convert a base 26 number represented by letters into an integer.
  3513. For example: AB -> 28."
  3514. (let ((n 0))
  3515. (setq s (upcase s))
  3516. (while (> (length s) 0)
  3517. (setq n (+ (* n 26) (string-to-char s) (- ?A) 1)
  3518. s (substring s 1)))
  3519. n))
  3520. (defun org-number-to-letters (n)
  3521. "Convert an integer into a base 26 number represented by letters.
  3522. For example: 28 -> AB."
  3523. (let ((s ""))
  3524. (while (> n 0)
  3525. (setq s (concat (char-to-string (+ (mod (1- n) 26) ?A)) s)
  3526. n (/ (1- n) 26)))
  3527. s))
  3528. (defun org-table-time-string-to-seconds (s)
  3529. "Convert a time string into numerical duration in seconds.
  3530. S can be a string matching either -?HH:MM:SS or -?HH:MM.
  3531. If S is a string representing a number, keep this number."
  3532. (if (equal s "")
  3533. s
  3534. (let (hour minus min sec res)
  3535. (cond
  3536. ((and (string-match "\\(-?\\)\\([0-9]+\\):\\([0-9]+\\):\\([0-9]+\\)" s))
  3537. (setq minus (< 0 (length (match-string 1 s)))
  3538. hour (string-to-number (match-string 2 s))
  3539. min (string-to-number (match-string 3 s))
  3540. sec (string-to-number (match-string 4 s)))
  3541. (if minus
  3542. (setq res (- (+ (* hour 3600) (* min 60) sec)))
  3543. (setq res (+ (* hour 3600) (* min 60) sec))))
  3544. ((and (not (string-match org-ts-regexp-both s))
  3545. (string-match "\\(-?\\)\\([0-9]+\\):\\([0-9]+\\)" s))
  3546. (setq minus (< 0 (length (match-string 1 s)))
  3547. hour (string-to-number (match-string 2 s))
  3548. min (string-to-number (match-string 3 s)))
  3549. (if minus
  3550. (setq res (- (+ (* hour 3600) (* min 60))))
  3551. (setq res (+ (* hour 3600) (* min 60)))))
  3552. (t (setq res (string-to-number s))))
  3553. (number-to-string res))))
  3554. (defun org-table-time-seconds-to-string (secs &optional output-format)
  3555. "Convert a number of seconds to a time string.
  3556. If OUTPUT-FORMAT is non-nil, return a number of days, hours,
  3557. minutes or seconds."
  3558. (let* ((secs0 (abs secs))
  3559. (res
  3560. (cond ((eq output-format 'days)
  3561. (format "%.3f" (/ (float secs0) 86400)))
  3562. ((eq output-format 'hours)
  3563. (format "%.2f" (/ (float secs0) 3600)))
  3564. ((eq output-format 'minutes)
  3565. (format "%.1f" (/ (float secs0) 60)))
  3566. ((eq output-format 'seconds)
  3567. (format "%d" secs0))
  3568. ((eq output-format 'hh:mm)
  3569. ;; Ignore seconds
  3570. (substring (format-seconds
  3571. (if org-table-duration-hour-zero-padding
  3572. "%.2h:%.2m:%.2s" "%h:%.2m:%.2s")
  3573. secs0)
  3574. 0 -3))
  3575. (t (format-seconds
  3576. (if org-table-duration-hour-zero-padding
  3577. "%.2h:%.2m:%.2s" "%h:%.2m:%.2s")
  3578. secs0)))))
  3579. (if (< secs 0) (concat "-" res) res)))
  3580. ;;; Columns shrinking
  3581. (defun org-table--shrunk-field ()
  3582. "Non-nil if current field is narrowed.
  3583. When non-nil, return the overlay narrowing the field."
  3584. (cl-some (lambda (o)
  3585. (and (eq 'table-column-hide (overlay-get o 'org-overlay-type))
  3586. o))
  3587. (overlays-at (save-excursion
  3588. (skip-chars-forward (if (org-at-table-hline-p) "^+|"
  3589. "^|")
  3590. (line-end-position))
  3591. (1- (point))))))
  3592. (defun org-table--list-shrunk-columns ()
  3593. "List currently shrunk columns in table at point."
  3594. (save-excursion
  3595. ;; We really check shrunk columns in current row only. It could
  3596. ;; be wrong if all rows do not contain the same number of columns
  3597. ;; (i.e. the table is not properly aligned). As a consequence,
  3598. ;; some columns may not be shrunk again upon aligning the table.
  3599. ;;
  3600. ;; For example, in the following table, cursor is on first row and
  3601. ;; "<>" indicates a shrunk column.
  3602. ;;
  3603. ;; | |
  3604. ;; | | <> |
  3605. ;;
  3606. ;; Aligning table from the first row will not shrink again the
  3607. ;; second row, which was not visible initially.
  3608. ;;
  3609. ;; However, fixing it requires to check every row, which may be
  3610. ;; slow on large tables. Moreover, the hindrance of this
  3611. ;; pathological case is very limited.
  3612. (beginning-of-line)
  3613. (search-forward "|")
  3614. (let ((separator (if (org-at-table-hline-p) "+" "|"))
  3615. (column 1)
  3616. (shrunk (and (org-table--shrunk-field) (list 1)))
  3617. (end (line-end-position)))
  3618. (while (search-forward separator end t)
  3619. (cl-incf column)
  3620. (when (org-table--shrunk-field) (push column shrunk)))
  3621. (nreverse shrunk))))
  3622. (defun org-table--make-shrinking-overlay (start end display field &optional pre)
  3623. "Create an overlay to shrink text between START and END.
  3624. Use string DISPLAY instead of the real text between the two
  3625. buffer positions. FIELD is the real contents of the field, as
  3626. a string, or nil. It is meant to be displayed upon moving the
  3627. mouse onto the overlay.
  3628. Return the overlay."
  3629. (let ((show-before-edit
  3630. (lambda (o &rest _)
  3631. ;; Removing one overlay removes all other overlays in the
  3632. ;; same column.
  3633. (mapc #'delete-overlay
  3634. (cdr (overlay-get o 'org-table-column-overlays)))))
  3635. (o (make-overlay start end)))
  3636. (overlay-put o 'insert-behind-hooks (and (not pre) (list show-before-edit)))
  3637. (overlay-put o 'insert-in-front-hooks (list show-before-edit))
  3638. (overlay-put o 'modification-hooks (list show-before-edit))
  3639. (overlay-put o 'org-overlay-type 'table-column-hide)
  3640. (when (stringp field) (overlay-put o 'help-echo field))
  3641. ;; Make sure overlays stays on top of table coordinates overlays.
  3642. ;; See `org-table-overlay-coordinates'.
  3643. (overlay-put o 'priority 1)
  3644. (org-overlay-display o display 'org-table t)
  3645. o))
  3646. (defun org-table--shrink-field (width start end contents)
  3647. "Shrink a table field to a specified width.
  3648. WIDTH is an integer representing the number of characters to
  3649. display, in addition to `org-table-shrunk-column-indicator'. START
  3650. and END are, respectively, the beginning and ending positions of
  3651. the field. CONTENTS is its trimmed contents, as a string, or
  3652. `hline' for table rules.
  3653. Real field is hidden under one or two overlays. They have the
  3654. following properties:
  3655. `org-overlay-type'
  3656. Set to `table-column-hide'. Used to identify overlays
  3657. responsible for shrinking columns in a table.
  3658. `org-table-column-overlays'
  3659. It is a list with the pattern (siblings . COLUMN-OVERLAYS)
  3660. where COLUMN-OVERLAYS is the list of all overlays hiding the
  3661. same column.
  3662. Whenever the text behind or next to the overlay is modified, all
  3663. the overlays in the column are deleted, effectively displaying
  3664. the column again.
  3665. Return a list of overlays hiding the field, or nil if field is
  3666. already hidden."
  3667. (cond
  3668. ((org-table--shrunk-field) nil) ;already shrunk: bail out
  3669. ((or (= 0 width) ;shrink to one character
  3670. (>= 1 (org-string-width (buffer-substring start end))))
  3671. (list (org-table--make-shrinking-overlay
  3672. start end org-table-shrunk-column-indicator
  3673. (if (eq 'hline contents) "" contents))))
  3674. ((eq contents 'hline) ;no contents to hide
  3675. (list (org-table--make-shrinking-overlay
  3676. start end
  3677. (concat (make-string (max 0 (1+ width)) ?-)
  3678. org-table-shrunk-column-indicator)
  3679. "")))
  3680. (t
  3681. ;; If the field is not empty, consider using two overlays: one for
  3682. ;; the blanks at the beginning of the field, and another one at
  3683. ;; the end of the field. The former ensures a shrunk field is
  3684. ;; always displayed with a single white space character in front
  3685. ;; of it -- e.g., so that even right-aligned fields appear to the
  3686. ;; left -- and the latter cuts the field at WIDTH visible
  3687. ;; characters.
  3688. (let* ((pre-overlay
  3689. (and (not (equal contents ""))
  3690. (org-with-point-at start (looking-at "\\( [ \t]+\\)\\S-"))
  3691. (org-table--make-shrinking-overlay
  3692. start (match-end 1) org-table-separator-space nil 'pre)))
  3693. (post-overlay
  3694. (let* ((start (if pre-overlay (overlay-end pre-overlay)
  3695. (1+ start)))
  3696. (w (org-string-width (buffer-substring start (1- end)))))
  3697. (if (>= width w)
  3698. ;; Field is too short. Extend its size by adding
  3699. ;; white space characters to the right overlay.
  3700. (org-table--make-shrinking-overlay
  3701. (1- end) end (concat (make-string (- width w) ?\s)
  3702. org-table-shrunk-column-indicator)
  3703. contents)
  3704. ;; Find cut location so that WIDTH characters are visible.
  3705. (org-table--make-shrinking-overlay
  3706. (let* ((begin start)
  3707. (lower begin)
  3708. (upper (1- end)))
  3709. (catch :exit
  3710. (while (> (- upper lower) 1)
  3711. (let ((mean (+ (ash lower -1)
  3712. (ash upper -1)
  3713. (logand lower upper 1))))
  3714. (pcase (org-string-width (buffer-substring begin mean))
  3715. ((pred (= width)) (throw :exit mean))
  3716. ((pred (< width)) (setq upper mean))
  3717. (_ (setq lower mean)))))
  3718. upper))
  3719. end org-table-shrunk-column-indicator contents)))))
  3720. (delq nil (list pre-overlay post-overlay))))))
  3721. (defun org-table--read-column-selection (select max)
  3722. "Read column selection select as a list of numbers.
  3723. SELECT is a string containing column ranges, separated by white
  3724. space characters, see `org-table-hide-column' for details. MAX
  3725. is the maximum column number.
  3726. Return value is a sorted list of numbers. Ignore any number
  3727. outside of the [1;MAX] range."
  3728. (catch :all
  3729. (sort
  3730. (delete-dups
  3731. (cl-mapcan
  3732. (lambda (s)
  3733. (cond
  3734. ((member s '("-" "1-")) (throw :all (number-sequence 1 max)))
  3735. ((string-match-p "\\`[0-9]+\\'" s)
  3736. (let ((n (string-to-number s)))
  3737. (and (> n 0) (<= n max) (list n))))
  3738. ((string-match "\\`\\([0-9]+\\)?-\\([0-9]+\\)?\\'" s)
  3739. (let ((n (match-string 1 s))
  3740. (m (match-string 2 s)))
  3741. (number-sequence (if n (max 1 (string-to-number n))
  3742. 1)
  3743. (if m (min max (string-to-number m))
  3744. max))))
  3745. (t nil))) ;invalid specification
  3746. (split-string select)))
  3747. #'<)))
  3748. (defun org-table--shrink-columns (columns beg end)
  3749. "Shrink COLUMNS in a table.
  3750. COLUMNS is a sorted list of column numbers. BEG and END are,
  3751. respectively, the beginning position and the end position of the
  3752. table."
  3753. (org-with-wide-buffer
  3754. (org-font-lock-ensure beg end)
  3755. (dolist (c columns)
  3756. (goto-char beg)
  3757. (let ((width nil)
  3758. (fields nil))
  3759. (while (< (point) end)
  3760. (catch :continue
  3761. (let* ((hline? (org-at-table-hline-p))
  3762. (separator (if hline? "+" "|")))
  3763. ;; Move to COLUMN.
  3764. (search-forward "|")
  3765. (or (= c 1) ;already there
  3766. (search-forward separator (line-end-position) t (1- c))
  3767. (throw :continue nil)) ;skip invalid columns
  3768. ;; Extract boundaries and contents from current field.
  3769. ;; Also set the column's width if we encounter a width
  3770. ;; cookie for the first time.
  3771. (let* ((start (point))
  3772. (end (progn
  3773. (skip-chars-forward (concat "^|" separator)
  3774. (line-end-position))
  3775. (point)))
  3776. (contents (if hline? 'hline
  3777. (org-trim (buffer-substring start end)))))
  3778. (push (list start end contents) fields)
  3779. (when (and (null width)
  3780. (not hline?)
  3781. (string-match "\\`<[lrc]?\\([0-9]+\\)>\\'" contents))
  3782. (setq width (string-to-number (match-string 1 contents)))))))
  3783. (forward-line))
  3784. ;; Link overlays for current field to the other overlays in the
  3785. ;; same column.
  3786. (let ((chain (list 'siblings)))
  3787. (dolist (field fields)
  3788. (dolist (new (apply #'org-table--shrink-field (or width 0) field))
  3789. (push new (cdr chain))
  3790. (overlay-put new 'org-table-column-overlays chain))))))))
  3791. ;;;###autoload
  3792. (defun org-table-toggle-column-width (&optional arg)
  3793. "Shrink or expand current column in an Org table.
  3794. If a width cookie specifies a width W for the column, the first
  3795. W visible characters are displayed. Otherwise, the column is
  3796. shrunk to a single character.
  3797. When point is before the first column or after the last one, ask
  3798. for the columns to shrink or expand, as a list of ranges.
  3799. A column range can be one of the following patterns:
  3800. N column N only
  3801. N-M every column between N and M (both inclusive)
  3802. N- every column between N (inclusive) and the last column
  3803. -M every column between the first one and M (inclusive)
  3804. - every column
  3805. When optional argument ARG is a string, use it as white space
  3806. separated list of column ranges.
  3807. When called with `\\[universal-argument]' prefix, call \
  3808. `org-table-shrink', i.e.,
  3809. shrink columns with a width cookie and expand the others.
  3810. When called with `\\[universal-argument] \\[universal-argument]' \
  3811. prefix, expand all columns."
  3812. (interactive "P")
  3813. (unless (org-at-table-p) (user-error "Not in a table"))
  3814. (let* ((begin (org-table-begin))
  3815. (end (org-table-end))
  3816. ;; Compute an upper bound for the number of columns.
  3817. ;; Nonexistent columns are ignored anyway.
  3818. (max-columns (/ (- (line-end-position) (line-beginning-position)) 2))
  3819. (shrunk (org-table--list-shrunk-columns))
  3820. (columns
  3821. (pcase arg
  3822. (`nil
  3823. (if (save-excursion
  3824. (skip-chars-backward "^|" (line-beginning-position))
  3825. (or (bolp) (looking-at-p "[ \t]*$")))
  3826. ;; Point is either before first column or past last
  3827. ;; one. Ask for columns to operate on.
  3828. (org-table--read-column-selection
  3829. (read-string "Column ranges (e.g. 2-4 6-): ")
  3830. max-columns)
  3831. (list (org-table-current-column))))
  3832. ((pred stringp) (org-table--read-column-selection arg max-columns))
  3833. ((or `(4) `(16)) nil)
  3834. (_ (user-error "Invalid argument: %S" arg)))))
  3835. (pcase arg
  3836. (`(4) (org-table-shrink begin end))
  3837. (`(16) (org-table-expand begin end))
  3838. (_
  3839. (org-table-expand begin end)
  3840. (org-table--shrink-columns
  3841. (cl-set-exclusive-or columns shrunk) begin end)))))
  3842. ;;;###autoload
  3843. (defun org-table-shrink (&optional begin end)
  3844. "Shrink all columns with a width cookie in the table at point.
  3845. Columns without a width cookie are expanded.
  3846. Optional arguments BEGIN and END, when non-nil, specify the
  3847. beginning and end position of the current table."
  3848. (interactive)
  3849. (unless (or begin (org-at-table-p)) (user-error "Not at a table"))
  3850. (org-with-wide-buffer
  3851. (let ((begin (or begin (org-table-begin)))
  3852. (end (or end (org-table-end)))
  3853. (regexp "|[ \t]*<[lrc]?[0-9]+>[ \t]*\\(|\\|$\\)")
  3854. (columns))
  3855. (goto-char begin)
  3856. (while (re-search-forward regexp end t)
  3857. (goto-char (match-beginning 1))
  3858. (cl-pushnew (org-table-current-column) columns))
  3859. (org-table-expand begin end)
  3860. ;; Make sure invisible characters in the table are at the right
  3861. ;; place since column widths take them into account.
  3862. (org-font-lock-ensure begin end)
  3863. (org-table--shrink-columns (sort columns #'<) begin end))))
  3864. ;;;###autoload
  3865. (defun org-table-expand (&optional begin end)
  3866. "Expand all columns in the table at point.
  3867. Optional arguments BEGIN and END, when non-nil, specify the
  3868. beginning and end position of the current table."
  3869. (interactive)
  3870. (unless (or begin (org-at-table-p)) (user-error "Not at a table"))
  3871. (org-with-wide-buffer
  3872. (let ((begin (or begin (org-table-begin)))
  3873. (end (or end (org-table-end))))
  3874. (remove-overlays begin end 'org-overlay-type 'table-column-hide))))
  3875. ;;; Formula editing
  3876. (defun org-table-fedit-convert-buffer (function)
  3877. "Convert all references in this buffer, using FUNCTION."
  3878. (let ((origin (copy-marker (line-beginning-position))))
  3879. (goto-char (point-min))
  3880. (while (not (eobp))
  3881. (insert (funcall function (buffer-substring (point) (line-end-position))))
  3882. (delete-region (point) (line-end-position))
  3883. (forward-line))
  3884. (goto-char origin)
  3885. (set-marker origin nil)))
  3886. (defun org-table-fedit-toggle-ref-type ()
  3887. "Convert all references in the buffer from B3 to @3$2 and back."
  3888. (interactive)
  3889. (setq-local org-table-buffer-is-an (not org-table-buffer-is-an))
  3890. (org-table-fedit-convert-buffer
  3891. (if org-table-buffer-is-an
  3892. 'org-table-convert-refs-to-an 'org-table-convert-refs-to-rc))
  3893. (message "Reference type switched to %s"
  3894. (if org-table-buffer-is-an "A1 etc" "@row$column")))
  3895. (defun org-table-fedit-ref-up ()
  3896. "Shift the reference at point one row/hline up."
  3897. (interactive)
  3898. (org-table-fedit-shift-reference 'up))
  3899. (defun org-table-fedit-ref-down ()
  3900. "Shift the reference at point one row/hline down."
  3901. (interactive)
  3902. (org-table-fedit-shift-reference 'down))
  3903. (defun org-table-fedit-ref-left ()
  3904. "Shift the reference at point one field to the left."
  3905. (interactive)
  3906. (org-table-fedit-shift-reference 'left))
  3907. (defun org-table-fedit-ref-right ()
  3908. "Shift the reference at point one field to the right."
  3909. (interactive)
  3910. (org-table-fedit-shift-reference 'right))
  3911. (defun org-table-fedit-shift-reference (dir)
  3912. (cond
  3913. ((org-in-regexp "\\(\\<[a-zA-Z]\\)&")
  3914. (if (memq dir '(left right))
  3915. (org-rematch-and-replace 1 (eq dir 'left))
  3916. (user-error "Cannot shift reference in this direction")))
  3917. ((org-in-regexp "\\(\\<[a-zA-Z]\\{1,2\\}\\)\\([0-9]+\\)")
  3918. ;; A B3-like reference
  3919. (if (memq dir '(up down))
  3920. (org-rematch-and-replace 2 (eq dir 'up))
  3921. (org-rematch-and-replace 1 (eq dir 'left))))
  3922. ((org-in-regexp
  3923. "\\(@\\|\\.\\.\\)\\([-+]?\\(I+\\>\\|[0-9]+\\)\\)\\(\\$\\([-+]?[0-9]+\\)\\)?")
  3924. ;; An internal reference
  3925. (if (memq dir '(up down))
  3926. (org-rematch-and-replace 2 (eq dir 'up) (match-end 3))
  3927. (org-rematch-and-replace 5 (eq dir 'left))))))
  3928. (defun org-rematch-and-replace (n &optional decr hline)
  3929. "Re-match the group N, and replace it with the shifted reference."
  3930. (or (match-end n) (user-error "Cannot shift reference in this direction"))
  3931. (goto-char (match-beginning n))
  3932. (and (looking-at (regexp-quote (match-string n)))
  3933. (replace-match (org-table-shift-refpart (match-string 0) decr hline)
  3934. t t)))
  3935. (defun org-table-shift-refpart (ref &optional decr hline)
  3936. "Shift a reference part REF.
  3937. If DECR is set, decrease the references row/column, else increase.
  3938. If HLINE is set, this may be a hline reference, it certainly is not
  3939. a translation reference."
  3940. (save-match-data
  3941. (let* ((sign (string-match "^[-+]" ref)) n)
  3942. (if sign (setq sign (substring ref 0 1) ref (substring ref 1)))
  3943. (cond
  3944. ((and hline (string-match "^I+" ref))
  3945. (setq n (string-to-number (concat sign (number-to-string (length ref)))))
  3946. (setq n (+ n (if decr -1 1)))
  3947. (if (= n 0) (setq n (+ n (if decr -1 1))))
  3948. (if sign
  3949. (setq sign (if (< n 0) "-" "+") n (abs n))
  3950. (setq n (max 1 n)))
  3951. (concat sign (make-string n ?I)))
  3952. ((string-match "^[0-9]+" ref)
  3953. (setq n (string-to-number (concat sign ref)))
  3954. (setq n (+ n (if decr -1 1)))
  3955. (if sign
  3956. (concat (if (< n 0) "-" "+") (number-to-string (abs n)))
  3957. (number-to-string (max 1 n))))
  3958. ((string-match "^[a-zA-Z]+" ref)
  3959. (org-number-to-letters
  3960. (max 1 (+ (org-letters-to-number ref) (if decr -1 1)))))
  3961. (t (user-error "Cannot shift reference"))))))
  3962. (defun org-table-fedit-toggle-coordinates ()
  3963. "Toggle the display of coordinates in the referenced table."
  3964. (interactive)
  3965. (let ((pos (marker-position org-pos)))
  3966. (with-current-buffer (marker-buffer org-pos)
  3967. (save-excursion
  3968. (goto-char pos)
  3969. (org-table-toggle-coordinate-overlays)))))
  3970. (defun org-table-fedit-finish (&optional arg)
  3971. "Parse the buffer for formula definitions and install them.
  3972. With prefix ARG, apply the new formulas to the table."
  3973. (interactive "P")
  3974. (org-table-remove-rectangle-highlight)
  3975. (when org-table-use-standard-references
  3976. (org-table-fedit-convert-buffer 'org-table-convert-refs-to-rc)
  3977. (setq org-table-buffer-is-an nil))
  3978. (let ((pos org-pos)
  3979. (sel-win org-selected-window)
  3980. (source org-table--fedit-source)
  3981. eql)
  3982. (goto-char (point-min))
  3983. (while (re-search-forward
  3984. "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
  3985. nil t)
  3986. (let ((var (match-string 1))
  3987. (form (org-trim (match-string 3))))
  3988. (unless (equal form "")
  3989. (while (string-match "[ \t]*\n[ \t]*" form)
  3990. (setq form (replace-match " " t t form)))
  3991. (when (assoc var eql)
  3992. (user-error "Double formulas for %s" var))
  3993. (push (cons var form) eql))))
  3994. (set-window-configuration org-window-configuration)
  3995. (select-window sel-win)
  3996. (goto-char source)
  3997. (org-table-store-formulas eql)
  3998. (set-marker pos nil)
  3999. (set-marker source nil)
  4000. (kill-buffer "*Edit Formulas*")
  4001. (if arg
  4002. (org-table-recalculate 'all)
  4003. (message "New formulas installed - press C-u C-c C-c to apply."))))
  4004. (defun org-table-fedit-abort ()
  4005. "Abort editing formulas, without installing the changes."
  4006. (interactive)
  4007. (org-table-remove-rectangle-highlight)
  4008. (let ((pos org-pos) (sel-win org-selected-window))
  4009. (set-window-configuration org-window-configuration)
  4010. (select-window sel-win)
  4011. (goto-char pos)
  4012. (move-marker pos nil)
  4013. (message "Formula editing aborted without installing changes")))
  4014. (defun org-table-fedit-lisp-indent ()
  4015. "Pretty-print and re-indent Lisp expressions in the Formula Editor."
  4016. (interactive)
  4017. (let ((pos (point)) beg end ind)
  4018. (beginning-of-line 1)
  4019. (cond
  4020. ((looking-at "[ \t]")
  4021. (goto-char pos)
  4022. (call-interactively 'lisp-indent-line))
  4023. ((looking-at "[$&@0-9a-zA-Z]+ *= *[^ \t\n']") (goto-char pos))
  4024. ((not (fboundp 'pp-buffer))
  4025. (user-error "Cannot pretty-print. Command `pp-buffer' is not available"))
  4026. ((looking-at "[$&@0-9a-zA-Z]+ *= *'(")
  4027. (goto-char (- (match-end 0) 2))
  4028. (setq beg (point))
  4029. (setq ind (make-string (current-column) ?\ ))
  4030. (condition-case nil (forward-sexp 1)
  4031. (error
  4032. (user-error "Cannot pretty-print Lisp expression: Unbalanced parenthesis")))
  4033. (setq end (point))
  4034. (save-restriction
  4035. (narrow-to-region beg end)
  4036. (if (eq last-command this-command)
  4037. (progn
  4038. (goto-char (point-min))
  4039. (setq this-command nil)
  4040. (while (re-search-forward "[ \t]*\n[ \t]*" nil t)
  4041. (replace-match " ")))
  4042. (pp-buffer)
  4043. (untabify (point-min) (point-max))
  4044. (goto-char (1+ (point-min)))
  4045. (while (re-search-forward "^." nil t)
  4046. (beginning-of-line 1)
  4047. (insert ind))
  4048. (goto-char (point-max))
  4049. (org-delete-backward-char 1)))
  4050. (goto-char beg))
  4051. (t nil))))
  4052. (defvar org-show-positions nil)
  4053. (defun org-table-show-reference (&optional local)
  4054. "Show the location/value of the $ expression at point.
  4055. When LOCAL is non-nil, show references for the table at point."
  4056. (interactive)
  4057. (org-table-remove-rectangle-highlight)
  4058. (when local (org-table-analyze))
  4059. (catch 'exit
  4060. (let ((pos (if local (point) org-pos))
  4061. (face2 'highlight)
  4062. (org-inhibit-highlight-removal t)
  4063. (win (selected-window))
  4064. (org-show-positions nil)
  4065. var name e what match dest)
  4066. (setq what (cond
  4067. ((org-in-regexp "^@[0-9]+[ \t=]")
  4068. (setq match (concat (substring (match-string 0) 0 -1)
  4069. "$1.."
  4070. (substring (match-string 0) 0 -1)
  4071. "$100"))
  4072. 'range)
  4073. ((or (org-in-regexp org-table-range-regexp2)
  4074. (org-in-regexp org-table-translate-regexp)
  4075. (org-in-regexp org-table-range-regexp))
  4076. (setq match
  4077. (save-match-data
  4078. (org-table-convert-refs-to-rc (match-string 0))))
  4079. 'range)
  4080. ((org-in-regexp "\\$[a-zA-Z][a-zA-Z0-9]*") 'name)
  4081. ((org-in-regexp "\\$[0-9]+") 'column)
  4082. ((not local) nil)
  4083. (t (user-error "No reference at point")))
  4084. match (and what (or match (match-string 0))))
  4085. (when (and match (not (equal (match-beginning 0) (point-at-bol))))
  4086. (org-table-add-rectangle-overlay (match-beginning 0) (match-end 0)
  4087. 'secondary-selection))
  4088. (add-hook 'before-change-functions
  4089. #'org-table-remove-rectangle-highlight)
  4090. (when (eq what 'name) (setq var (substring match 1)))
  4091. (when (eq what 'range)
  4092. (unless (eq (string-to-char match) ?@) (setq match (concat "@" match)))
  4093. (setq match (org-table-formula-substitute-names match)))
  4094. (unless local
  4095. (save-excursion
  4096. (end-of-line)
  4097. (re-search-backward "^\\S-" nil t)
  4098. (beginning-of-line)
  4099. (when (looking-at "\\(\\$[0-9a-zA-Z]+\\|@[0-9]+\\$[0-9]+\\|[a-zA-Z]+\
  4100. \\([0-9]+\\|&\\)\\) *=")
  4101. (setq dest
  4102. (save-match-data
  4103. (org-table-convert-refs-to-rc (match-string 1))))
  4104. (org-table-add-rectangle-overlay
  4105. (match-beginning 1) (match-end 1) face2))))
  4106. (if (and (markerp pos) (marker-buffer pos))
  4107. (if (get-buffer-window (marker-buffer pos))
  4108. (select-window (get-buffer-window (marker-buffer pos)))
  4109. (org-switch-to-buffer-other-window (get-buffer-window
  4110. (marker-buffer pos)))))
  4111. (goto-char pos)
  4112. (org-table-force-dataline)
  4113. (let ((table-start
  4114. (if local org-table-current-begin-pos (org-table-begin))))
  4115. (when dest
  4116. (setq name (substring dest 1))
  4117. (cond
  4118. ((string-match-p "\\`\\$[a-zA-Z][a-zA-Z0-9]*" dest)
  4119. (org-table-goto-field dest))
  4120. ((string-match-p "\\`@\\([1-9][0-9]*\\)\\$\\([1-9][0-9]*\\)\\'"
  4121. dest)
  4122. (org-table-goto-field dest))
  4123. (t (org-table-goto-column (string-to-number name))))
  4124. (move-marker pos (point))
  4125. (org-table-highlight-rectangle nil nil face2))
  4126. (cond
  4127. ((equal dest match))
  4128. ((not match))
  4129. ((eq what 'range)
  4130. (ignore-errors (org-table-get-range match table-start nil 'highlight)))
  4131. ((setq e (assoc var org-table-named-field-locations))
  4132. (org-table-goto-field var)
  4133. (org-table-highlight-rectangle)
  4134. (message "Named field, column %d of line %d" (nth 2 e) (nth 1 e)))
  4135. ((setq e (assoc var org-table-column-names))
  4136. (org-table-goto-column (string-to-number (cdr e)))
  4137. (org-table-highlight-rectangle)
  4138. (goto-char table-start)
  4139. (if (re-search-forward (concat "^[ \t]*| *! *.*?| *\\(" var "\\) *|")
  4140. (org-table-end) t)
  4141. (progn
  4142. (goto-char (match-beginning 1))
  4143. (org-table-highlight-rectangle)
  4144. (message "Named column (column %s)" (cdr e)))
  4145. (user-error "Column name not found")))
  4146. ((eq what 'column)
  4147. ;; Column number.
  4148. (org-table-goto-column (string-to-number (substring match 1)))
  4149. (org-table-highlight-rectangle)
  4150. (message "Column %s" (substring match 1)))
  4151. ((setq e (assoc var org-table-local-parameters))
  4152. (goto-char table-start)
  4153. (if (re-search-forward (concat "^[ \t]*| *\\$ *.*?| *\\(" var "=\\)") nil t)
  4154. (progn
  4155. (goto-char (match-beginning 1))
  4156. (org-table-highlight-rectangle)
  4157. (message "Local parameter."))
  4158. (user-error "Parameter not found")))
  4159. ((not var) (user-error "No reference at point"))
  4160. ((setq e (assoc var org-table-formula-constants-local))
  4161. (message "Local Constant: $%s=%s in #+CONSTANTS line."
  4162. var (cdr e)))
  4163. ((setq e (assoc var org-table-formula-constants))
  4164. (message "Constant: $%s=%s in `org-table-formula-constants'."
  4165. var (cdr e)))
  4166. ((setq e (and (fboundp 'constants-get) (constants-get var)))
  4167. (message "Constant: $%s=%s, from `constants.el'%s."
  4168. var e (format " (%s units)" constants-unit-system)))
  4169. (t (user-error "Undefined name $%s" var)))
  4170. (goto-char pos)
  4171. (when (and org-show-positions
  4172. (not (memq this-command '(org-table-fedit-scroll
  4173. org-table-fedit-scroll-down))))
  4174. (push pos org-show-positions)
  4175. (push table-start org-show-positions)
  4176. (let ((min (apply 'min org-show-positions))
  4177. (max (apply 'max org-show-positions)))
  4178. (set-window-start (selected-window) min)
  4179. (goto-char max)
  4180. (or (pos-visible-in-window-p max)
  4181. (set-window-start (selected-window) max)))))
  4182. (select-window win))))
  4183. (defun org-table-force-dataline ()
  4184. "Move point to the closest data line in a table.
  4185. Raise an error if the table contains no data line. Preserve
  4186. column when moving point."
  4187. (unless (org-match-line org-table-dataline-regexp)
  4188. (let* ((re org-table-dataline-regexp)
  4189. (column (current-column))
  4190. (p1 (save-excursion (re-search-forward re (org-table-end) t)))
  4191. (p2 (save-excursion (re-search-backward re (org-table-begin) t))))
  4192. (cond ((and p1 p2)
  4193. (goto-char (if (< (abs (- p1 (point))) (abs (- p2 (point))))
  4194. p1
  4195. p2)))
  4196. ((or p1 p2) (goto-char (or p1 p2)))
  4197. (t (user-error "No table data line around here")))
  4198. (org-move-to-column column))))
  4199. (defun org-table-fedit-line-up ()
  4200. "Move cursor one line up in the window showing the table."
  4201. (interactive)
  4202. (org-table-fedit-move 'previous-line))
  4203. (defun org-table-fedit-line-down ()
  4204. "Move cursor one line down in the window showing the table."
  4205. (interactive)
  4206. (org-table-fedit-move 'next-line))
  4207. (defun org-table-fedit-move (command)
  4208. "Move the cursor in the window showing the table.
  4209. Use COMMAND to do the motion, repeat if necessary to end up in a data line."
  4210. (let ((org-table-allow-automatic-line-recalculation nil)
  4211. (pos org-pos) (win (selected-window)) p)
  4212. (select-window (get-buffer-window (marker-buffer org-pos)))
  4213. (setq p (point))
  4214. (call-interactively command)
  4215. (while (and (org-at-table-p)
  4216. (org-at-table-hline-p))
  4217. (call-interactively command))
  4218. (or (org-at-table-p) (goto-char p))
  4219. (move-marker pos (point))
  4220. (select-window win)))
  4221. (defun org-table-fedit-scroll (N)
  4222. (interactive "p")
  4223. (let ((other-window-scroll-buffer (marker-buffer org-pos)))
  4224. (scroll-other-window N)))
  4225. (defun org-table-fedit-scroll-down (N)
  4226. (interactive "p")
  4227. (org-table-fedit-scroll (- N)))
  4228. (defvar org-table-rectangle-overlays nil)
  4229. (defun org-table-add-rectangle-overlay (beg end &optional face)
  4230. "Add a new overlay."
  4231. (let ((ov (make-overlay beg end)))
  4232. (overlay-put ov 'face (or face 'secondary-selection))
  4233. (push ov org-table-rectangle-overlays)))
  4234. (defun org-table-highlight-rectangle (&optional beg end face)
  4235. "Highlight rectangular region in a table.
  4236. When buffer positions BEG and END are provided, use them to
  4237. delimit the region to highlight. Otherwise, refer to point. Use
  4238. FACE, when non-nil, for the highlight."
  4239. (let* ((beg (or beg (point)))
  4240. (end (or end (point)))
  4241. (b (min beg end))
  4242. (e (max beg end))
  4243. (start-coordinates
  4244. (save-excursion
  4245. (goto-char b)
  4246. (cons (line-beginning-position) (org-table-current-column))))
  4247. (end-coordinates
  4248. (save-excursion
  4249. (goto-char e)
  4250. (cons (line-beginning-position) (org-table-current-column)))))
  4251. (when (boundp 'org-show-positions)
  4252. (setq org-show-positions (cons b (cons e org-show-positions))))
  4253. (goto-char (car start-coordinates))
  4254. (let ((column-start (min (cdr start-coordinates) (cdr end-coordinates)))
  4255. (column-end (max (cdr start-coordinates) (cdr end-coordinates)))
  4256. (last-row (car end-coordinates)))
  4257. (while (<= (point) last-row)
  4258. (when (looking-at org-table-dataline-regexp)
  4259. (org-table-goto-column column-start)
  4260. (skip-chars-backward "^|\n")
  4261. (let ((p (point)))
  4262. (org-table-goto-column column-end)
  4263. (skip-chars-forward "^|\n")
  4264. (org-table-add-rectangle-overlay p (point) face)))
  4265. (forward-line)))
  4266. (goto-char (car start-coordinates)))
  4267. (add-hook 'before-change-functions #'org-table-remove-rectangle-highlight))
  4268. (defun org-table-remove-rectangle-highlight (&rest _ignore)
  4269. "Remove the rectangle overlays."
  4270. (unless org-inhibit-highlight-removal
  4271. (remove-hook 'before-change-functions 'org-table-remove-rectangle-highlight)
  4272. (mapc 'delete-overlay org-table-rectangle-overlays)
  4273. (setq org-table-rectangle-overlays nil)))
  4274. (defvar-local org-table-coordinate-overlays nil
  4275. "Collects the coordinate grid overlays, so that they can be removed.")
  4276. (defun org-table-overlay-coordinates ()
  4277. "Add overlays to the table at point, to show row/column coordinates."
  4278. (interactive)
  4279. (mapc 'delete-overlay org-table-coordinate-overlays)
  4280. (setq org-table-coordinate-overlays nil)
  4281. (save-excursion
  4282. (let ((id 0) (ih 0) hline eol str ov)
  4283. (goto-char (org-table-begin))
  4284. (while (org-at-table-p)
  4285. (setq eol (point-at-eol))
  4286. (setq ov (make-overlay (point-at-bol) (1+ (point-at-bol))))
  4287. (push ov org-table-coordinate-overlays)
  4288. (setq hline (looking-at org-table-hline-regexp))
  4289. (setq str (if hline (format "I*%-2d" (setq ih (1+ ih)))
  4290. (format "%4d" (setq id (1+ id)))))
  4291. (org-overlay-before-string ov str 'org-special-keyword 'evaporate)
  4292. (when hline
  4293. (let ((ic 0))
  4294. (while (re-search-forward "[+|]\\(-+\\)" eol t)
  4295. (cl-incf ic)
  4296. (let* ((beg (1+ (match-beginning 0)))
  4297. (s1 (format "$%d" ic))
  4298. (s2 (org-number-to-letters ic))
  4299. (str (if (eq t org-table-use-standard-references) s2 s1))
  4300. (ov (make-overlay beg (+ beg (length str)))))
  4301. (push ov org-table-coordinate-overlays)
  4302. (org-overlay-display ov str 'org-special-keyword 'evaporate)))))
  4303. (forward-line)))))
  4304. ;;;###autoload
  4305. (defun org-table-toggle-coordinate-overlays ()
  4306. "Toggle the display of Row/Column numbers in tables."
  4307. (interactive)
  4308. (setq org-table-overlay-coordinates (not org-table-overlay-coordinates))
  4309. (message "Tables Row/Column numbers display turned %s"
  4310. (if org-table-overlay-coordinates "on" "off"))
  4311. (when (and (org-at-table-p) org-table-overlay-coordinates)
  4312. (org-table-align))
  4313. (unless org-table-overlay-coordinates
  4314. (mapc 'delete-overlay org-table-coordinate-overlays)
  4315. (setq org-table-coordinate-overlays nil)))
  4316. ;;;###autoload
  4317. (defun org-table-toggle-formula-debugger ()
  4318. "Toggle the formula debugger in tables."
  4319. (interactive)
  4320. (setq org-table-formula-debug (not org-table-formula-debug))
  4321. (message "Formula debugging has been turned %s"
  4322. (if org-table-formula-debug "on" "off")))
  4323. ;;; The orgtbl minor mode
  4324. ;; Define a minor mode which can be used in other modes in order to
  4325. ;; integrate the Org table editor.
  4326. ;; This is really a hack, because the Org table editor uses several
  4327. ;; keys which normally belong to the major mode, for example the TAB
  4328. ;; and RET keys. Here is how it works: The minor mode defines all the
  4329. ;; keys necessary to operate the table editor, but wraps the commands
  4330. ;; into a function which tests if the cursor is currently inside
  4331. ;; a table. If that is the case, the table editor command is
  4332. ;; executed. However, when any of those keys is used outside a table,
  4333. ;; the function uses `key-binding' to look up if the key has an
  4334. ;; associated command in another currently active keymap (minor modes,
  4335. ;; major mode, global), and executes that command. There might be
  4336. ;; problems if any of the keys used by the table editor is otherwise
  4337. ;; used as a prefix key.
  4338. ;; Another challenge is that the key binding for TAB can be tab or \C-i,
  4339. ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
  4340. ;; addresses this by checking explicitly for both bindings.
  4341. ;; The optimized version (see variable `orgtbl-optimized') takes over
  4342. ;; all keys which are bound to `self-insert-command' in the *global map*.
  4343. ;; Some modes bind other commands to simple characters, for example
  4344. ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
  4345. ;; active, this binding is ignored inside tables and replaced with a
  4346. ;; modified self-insert.
  4347. (defvar orgtbl-mode-map (make-keymap)
  4348. "Keymap for `orgtbl-mode'.")
  4349. (defvar org-old-auto-fill-inhibit-regexp nil
  4350. "Local variable used by `orgtbl-mode'.")
  4351. (defconst orgtbl-line-start-regexp
  4352. "[ \t]*\\(|\\|#\\+\\(tblfm\\|orgtbl\\|tblname\\):\\)"
  4353. "Matches a line belonging to an orgtbl.")
  4354. (defconst orgtbl-extra-font-lock-keywords
  4355. (list (list (concat "^" orgtbl-line-start-regexp ".*")
  4356. 0 (quote 'org-table) 'prepend))
  4357. "Extra `font-lock-keywords' to be added when `orgtbl-mode' is active.")
  4358. ;; Install it as a minor mode.
  4359. (put 'orgtbl-mode :included t)
  4360. (put 'orgtbl-mode :menu-tag "Org Table Mode")
  4361. ;;;###autoload
  4362. (define-minor-mode orgtbl-mode
  4363. "The Org mode table editor as a minor mode for use in other modes."
  4364. :lighter " OrgTbl" :keymap orgtbl-mode-map
  4365. (org-load-modules-maybe)
  4366. (cond
  4367. ((derived-mode-p 'org-mode)
  4368. ;; Exit without error, in case some hook functions calls this by
  4369. ;; accident in Org mode.
  4370. (message "Orgtbl mode is not useful in Org mode, command ignored"))
  4371. (orgtbl-mode
  4372. (and (orgtbl-setup) (defun orgtbl-setup () nil)) ;; FIXME: Yuck!?!
  4373. ;; Make sure we are first in minor-mode-map-alist
  4374. (let ((c (assq 'orgtbl-mode minor-mode-map-alist)))
  4375. ;; FIXME: maybe it should use emulation-mode-map-alists?
  4376. (and c (setq minor-mode-map-alist
  4377. (cons c (delq c minor-mode-map-alist)))))
  4378. (setq-local org-table-may-need-update t)
  4379. (add-hook 'before-change-functions 'org-before-change-function
  4380. nil 'local)
  4381. (setq-local org-old-auto-fill-inhibit-regexp
  4382. auto-fill-inhibit-regexp)
  4383. (setq-local auto-fill-inhibit-regexp
  4384. (if auto-fill-inhibit-regexp
  4385. (concat orgtbl-line-start-regexp "\\|"
  4386. auto-fill-inhibit-regexp)
  4387. orgtbl-line-start-regexp))
  4388. (when (fboundp 'font-lock-add-keywords)
  4389. (font-lock-add-keywords nil orgtbl-extra-font-lock-keywords)
  4390. (org-restart-font-lock))
  4391. (easy-menu-add orgtbl-mode-menu))
  4392. (t
  4393. (setq auto-fill-inhibit-regexp org-old-auto-fill-inhibit-regexp)
  4394. (remove-hook 'before-change-functions 'org-before-change-function t)
  4395. (when (fboundp 'font-lock-remove-keywords)
  4396. (font-lock-remove-keywords nil orgtbl-extra-font-lock-keywords)
  4397. (org-restart-font-lock))
  4398. (easy-menu-remove orgtbl-mode-menu)
  4399. (force-mode-line-update 'all))))
  4400. (defun orgtbl-make-binding (fun n &rest keys)
  4401. "Create a function for binding in the table minor mode.
  4402. FUN is the command to call inside a table. N is used to create a unique
  4403. command name. KEYS are keys that should be checked in for a command
  4404. to execute outside of tables."
  4405. (eval
  4406. (list 'defun
  4407. (intern (concat "orgtbl-hijacker-command-" (int-to-string n)))
  4408. '(arg)
  4409. (concat "In tables, run `" (symbol-name fun) "'.\n"
  4410. "Outside of tables, run the binding of `"
  4411. (mapconcat #'key-description keys "' or `")
  4412. "'.")
  4413. '(interactive "p")
  4414. (list 'if
  4415. '(org-at-table-p)
  4416. (list 'call-interactively (list 'quote fun))
  4417. (list 'let '(orgtbl-mode)
  4418. (list 'call-interactively
  4419. (append '(or)
  4420. (mapcar (lambda (k)
  4421. (list 'key-binding k))
  4422. keys)
  4423. '('orgtbl-error))))))))
  4424. (defun orgtbl-error ()
  4425. "Error when there is no default binding for a table key."
  4426. (interactive)
  4427. (user-error "This key has no function outside tables"))
  4428. (defun orgtbl-setup ()
  4429. "Setup orgtbl keymaps."
  4430. (let ((nfunc 0)
  4431. (bindings
  4432. '(([(meta shift left)] org-table-delete-column)
  4433. ([(meta left)] org-table-move-column-left)
  4434. ([(meta right)] org-table-move-column-right)
  4435. ([(meta shift right)] org-table-insert-column)
  4436. ([(meta shift up)] org-table-kill-row)
  4437. ([(meta shift down)] org-table-insert-row)
  4438. ([(meta up)] org-table-move-row-up)
  4439. ([(meta down)] org-table-move-row-down)
  4440. ("\C-c\C-w" org-table-cut-region)
  4441. ("\C-c\M-w" org-table-copy-region)
  4442. ("\C-c\C-y" org-table-paste-rectangle)
  4443. ("\C-c\C-w" org-table-wrap-region)
  4444. ("\C-c-" org-table-insert-hline)
  4445. ("\C-c}" org-table-toggle-coordinate-overlays)
  4446. ("\C-c{" org-table-toggle-formula-debugger)
  4447. ("\C-m" org-table-next-row)
  4448. ([(shift return)] org-table-copy-down)
  4449. ("\C-c?" org-table-field-info)
  4450. ("\C-c " org-table-blank-field)
  4451. ("\C-c+" org-table-sum)
  4452. ("\C-c=" org-table-eval-formula)
  4453. ("\C-c'" org-table-edit-formulas)
  4454. ("\C-c`" org-table-edit-field)
  4455. ("\C-c*" org-table-recalculate)
  4456. ("\C-c^" org-table-sort-lines)
  4457. ("\M-a" org-table-beginning-of-field)
  4458. ("\M-e" org-table-end-of-field)
  4459. ([(control ?#)] org-table-rotate-recalc-marks)))
  4460. elt key fun cmd)
  4461. (while (setq elt (pop bindings))
  4462. (setq nfunc (1+ nfunc))
  4463. (setq key (org-key (car elt))
  4464. fun (nth 1 elt)
  4465. cmd (orgtbl-make-binding fun nfunc key))
  4466. (org-defkey orgtbl-mode-map key cmd))
  4467. ;; Special treatment needed for TAB, RET and DEL
  4468. (org-defkey orgtbl-mode-map [(return)]
  4469. (orgtbl-make-binding 'orgtbl-ret 100 [(return)] "\C-m"))
  4470. (org-defkey orgtbl-mode-map "\C-m"
  4471. (orgtbl-make-binding 'orgtbl-ret 101 "\C-m" [(return)]))
  4472. (org-defkey orgtbl-mode-map [(tab)]
  4473. (orgtbl-make-binding 'orgtbl-tab 102 [(tab)] "\C-i"))
  4474. (org-defkey orgtbl-mode-map "\C-i"
  4475. (orgtbl-make-binding 'orgtbl-tab 103 "\C-i" [(tab)]))
  4476. (org-defkey orgtbl-mode-map [(shift tab)]
  4477. (orgtbl-make-binding 'org-table-previous-field 104
  4478. [(shift tab)] [(tab)] "\C-i"))
  4479. (org-defkey orgtbl-mode-map [backspace]
  4480. (orgtbl-make-binding 'org-delete-backward-char 109
  4481. [backspace] (kbd "DEL")))
  4482. (org-defkey orgtbl-mode-map [S-iso-lefttab]
  4483. (orgtbl-make-binding 'org-table-previous-field 107
  4484. [S-iso-lefttab] [backtab] [(shift tab)]
  4485. [(tab)] "\C-i"))
  4486. (org-defkey orgtbl-mode-map [backtab]
  4487. (orgtbl-make-binding 'org-table-previous-field 108
  4488. [backtab] [S-iso-lefttab] [(shift tab)]
  4489. [(tab)] "\C-i"))
  4490. (org-defkey orgtbl-mode-map "\M-\C-m"
  4491. (orgtbl-make-binding 'org-table-wrap-region 105
  4492. "\M-\C-m" [(meta return)]))
  4493. (org-defkey orgtbl-mode-map [(meta return)]
  4494. (orgtbl-make-binding 'org-table-wrap-region 106
  4495. [(meta return)] "\M-\C-m"))
  4496. (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
  4497. (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
  4498. (when orgtbl-optimized
  4499. ;; If the user wants maximum table support, we need to hijack
  4500. ;; some standard editing functions
  4501. (org-remap orgtbl-mode-map
  4502. 'self-insert-command 'orgtbl-self-insert-command
  4503. 'delete-char 'org-delete-char
  4504. 'delete-backward-char 'org-delete-backward-char)
  4505. (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
  4506. (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
  4507. '("OrgTbl"
  4508. ["Create or convert" org-table-create-or-convert-from-region
  4509. :active (not (org-at-table-p)) :keys "C-c |" ]
  4510. "--"
  4511. ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
  4512. ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
  4513. ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
  4514. ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
  4515. "--"
  4516. ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
  4517. ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
  4518. ["Copy Field from Above"
  4519. org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
  4520. "--"
  4521. ("Column"
  4522. ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
  4523. ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
  4524. ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
  4525. ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
  4526. ("Row"
  4527. ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
  4528. ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
  4529. ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
  4530. ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
  4531. ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
  4532. "--"
  4533. ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
  4534. ("Rectangle"
  4535. ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
  4536. ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
  4537. ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
  4538. ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
  4539. "--"
  4540. ("Radio tables"
  4541. ["Insert table template" orgtbl-insert-radio-table
  4542. (cl-assoc-if #'derived-mode-p orgtbl-radio-table-templates)]
  4543. ["Comment/uncomment table" orgtbl-toggle-comment t])
  4544. "--"
  4545. ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
  4546. ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
  4547. ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
  4548. ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
  4549. ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
  4550. ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
  4551. ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
  4552. ["Sum Column/Rectangle" org-table-sum
  4553. :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
  4554. ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
  4555. ["Debug Formulas"
  4556. org-table-toggle-formula-debugger :active (org-at-table-p)
  4557. :keys "C-c {"
  4558. :style toggle :selected org-table-formula-debug]
  4559. ["Show Col/Row Numbers"
  4560. org-table-toggle-coordinate-overlays :active (org-at-table-p)
  4561. :keys "C-c }"
  4562. :style toggle :selected org-table-overlay-coordinates]
  4563. "--"
  4564. ("Plot"
  4565. ["Ascii plot" orgtbl-ascii-plot :active (org-at-table-p) :keys "C-c \" a"]
  4566. ["Gnuplot" org-plot/gnuplot :active (org-at-table-p) :keys "C-c \" g"])))
  4567. t))
  4568. (defun orgtbl-ctrl-c-ctrl-c (arg)
  4569. "If the cursor is inside a table, realign the table.
  4570. If it is a table to be sent away to a receiver, do it.
  4571. With prefix arg, also recompute table."
  4572. (interactive "P")
  4573. (let ((case-fold-search t) (pos (point)) action)
  4574. (save-excursion
  4575. (beginning-of-line 1)
  4576. (setq action (cond
  4577. ((looking-at "[ \t]*#\\+ORGTBL:.*\n[ \t]*|") (match-end 0))
  4578. ((looking-at "[ \t]*|") pos)
  4579. ((looking-at "[ \t]*#\\+tblfm:") 'recalc))))
  4580. (cond
  4581. ((integerp action)
  4582. (goto-char action)
  4583. (org-table-maybe-eval-formula)
  4584. (if arg
  4585. (call-interactively 'org-table-recalculate)
  4586. (org-table-maybe-recalculate-line))
  4587. (call-interactively 'org-table-align)
  4588. (when (orgtbl-send-table 'maybe)
  4589. (run-hooks 'orgtbl-after-send-table-hook)))
  4590. ((eq action 'recalc)
  4591. (save-excursion
  4592. (beginning-of-line 1)
  4593. (skip-chars-backward " \r\n\t")
  4594. (if (org-at-table-p)
  4595. (org-call-with-arg 'org-table-recalculate t))))
  4596. (t (let (orgtbl-mode)
  4597. (call-interactively (key-binding "\C-c\C-c")))))))
  4598. (defun orgtbl-create-or-convert-from-region (_arg)
  4599. "Create table or convert region to table, if no conflicting binding.
  4600. This installs the table binding `C-c |', but only if there is no
  4601. conflicting binding to this key outside orgtbl-mode."
  4602. (interactive "P")
  4603. (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
  4604. (if cmd
  4605. (call-interactively cmd)
  4606. (call-interactively 'org-table-create-or-convert-from-region))))
  4607. (defun orgtbl-tab (arg)
  4608. "Justification and field motion for `orgtbl-mode'."
  4609. (interactive "P")
  4610. (if arg (org-table-edit-field t)
  4611. (org-table-justify-field-maybe)
  4612. (org-table-next-field)))
  4613. (defun orgtbl-ret ()
  4614. "Justification and field motion for `orgtbl-mode'."
  4615. (interactive)
  4616. (if (bobp)
  4617. (newline)
  4618. (org-table-justify-field-maybe)
  4619. (org-table-next-row)))
  4620. (defun orgtbl-self-insert-command (N)
  4621. "Like `self-insert-command', use overwrite-mode for whitespace in tables.
  4622. If the cursor is in a table looking at whitespace, the whitespace is
  4623. overwritten, and the table is not marked as requiring realignment."
  4624. (interactive "p")
  4625. (if (and (org-at-table-p)
  4626. (or
  4627. (and org-table-auto-blank-field
  4628. (member last-command
  4629. '(orgtbl-hijacker-command-100
  4630. orgtbl-hijacker-command-101
  4631. orgtbl-hijacker-command-102
  4632. orgtbl-hijacker-command-103
  4633. orgtbl-hijacker-command-104
  4634. orgtbl-hijacker-command-105
  4635. yas/expand))
  4636. (org-table-blank-field))
  4637. t)
  4638. (eq N 1)
  4639. (looking-at "[^|\n]* \\( \\)|"))
  4640. (let (org-table-may-need-update)
  4641. (delete-region (match-beginning 1) (match-end 1))
  4642. (self-insert-command N))
  4643. (setq org-table-may-need-update t)
  4644. (let* (orgtbl-mode
  4645. a
  4646. (cmd (or (key-binding
  4647. (or (and (listp function-key-map)
  4648. (setq a (assoc last-input-event function-key-map))
  4649. (cdr a))
  4650. (vector last-input-event)))
  4651. 'self-insert-command)))
  4652. (call-interactively cmd)
  4653. (if (and org-self-insert-cluster-for-undo
  4654. (eq cmd 'self-insert-command))
  4655. (if (not (eq last-command 'orgtbl-self-insert-command))
  4656. (setq org-self-insert-command-undo-counter 1)
  4657. (if (>= org-self-insert-command-undo-counter 20)
  4658. (setq org-self-insert-command-undo-counter 1)
  4659. (and (> org-self-insert-command-undo-counter 0)
  4660. buffer-undo-list
  4661. (not (cadr buffer-undo-list)) ; remove nil entry
  4662. (setcdr buffer-undo-list (cddr buffer-undo-list)))
  4663. (setq org-self-insert-command-undo-counter
  4664. (1+ org-self-insert-command-undo-counter))))))))
  4665. ;;;###autoload
  4666. (defvar orgtbl-exp-regexp "^\\([-+]?[0-9][0-9.]*\\)[eE]\\([-+]?[0-9]+\\)$"
  4667. "Regular expression matching exponentials as produced by calc.")
  4668. (defun orgtbl-gather-send-defs ()
  4669. "Gather a plist of :name, :transform, :params for each destination before
  4670. a radio table."
  4671. (save-excursion
  4672. (goto-char (org-table-begin))
  4673. (let (rtn)
  4674. (beginning-of-line 0)
  4675. (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
  4676. (let ((name (org-no-properties (match-string 1)))
  4677. (transform (intern (match-string 2)))
  4678. (params (if (match-end 3)
  4679. (read (concat "(" (match-string 3) ")")))))
  4680. (push (list :name name :transform transform :params params)
  4681. rtn)
  4682. (beginning-of-line 0)))
  4683. rtn)))
  4684. (defun orgtbl-send-replace-tbl (name text)
  4685. "Find and replace table NAME with TEXT."
  4686. (save-excursion
  4687. (goto-char (point-min))
  4688. (let* ((location-flag nil)
  4689. (name (regexp-quote name))
  4690. (begin-re (format "BEGIN +RECEIVE +ORGTBL +%s\\([ \t]\\|$\\)" name))
  4691. (end-re (format "END +RECEIVE +ORGTBL +%s\\([ \t]\\|$\\)" name)))
  4692. (while (re-search-forward begin-re nil t)
  4693. (unless location-flag (setq location-flag t))
  4694. (let ((beg (line-beginning-position 2)))
  4695. (unless (re-search-forward end-re nil t)
  4696. (user-error "Cannot find end of receiver location at %d" beg))
  4697. (beginning-of-line)
  4698. (delete-region beg (point))
  4699. (insert text "\n")))
  4700. (unless location-flag
  4701. (user-error "No valid receiver location found in the buffer")))))
  4702. ;;;###autoload
  4703. (defun org-table-to-lisp (&optional txt)
  4704. "Convert the table at point to a Lisp structure.
  4705. The structure will be a list. Each item is either the symbol `hline'
  4706. for a horizontal separator line, or a list of field values as strings.
  4707. The table is taken from the parameter TXT, or from the buffer at point."
  4708. (unless (or txt (org-at-table-p)) (user-error "No table at point"))
  4709. (let ((txt (or txt
  4710. (buffer-substring-no-properties (org-table-begin)
  4711. (org-table-end)))))
  4712. (mapcar (lambda (x)
  4713. (if (string-match org-table-hline-regexp x) 'hline
  4714. (org-split-string (org-trim x) "\\s-*|\\s-*")))
  4715. (org-split-string txt "[ \t]*\n[ \t]*"))))
  4716. (defun orgtbl-send-table (&optional maybe)
  4717. "Send a transformed version of table at point to the receiver position.
  4718. With argument MAYBE, fail quietly if no transformation is defined
  4719. for this table."
  4720. (interactive)
  4721. (catch 'exit
  4722. (unless (org-at-table-p) (user-error "Not at a table"))
  4723. ;; when non-interactive, we assume align has just happened.
  4724. (when (called-interactively-p 'any) (org-table-align))
  4725. (let ((dests (orgtbl-gather-send-defs))
  4726. (table (org-table-to-lisp
  4727. (buffer-substring-no-properties (org-table-begin)
  4728. (org-table-end))))
  4729. (ntbl 0))
  4730. (unless dests
  4731. (if maybe (throw 'exit nil)
  4732. (user-error "Don't know how to transform this table")))
  4733. (dolist (dest dests)
  4734. (let ((name (plist-get dest :name))
  4735. (transform (plist-get dest :transform))
  4736. (params (plist-get dest :params)))
  4737. (unless (fboundp transform)
  4738. (user-error "No such transformation function %s" transform))
  4739. (orgtbl-send-replace-tbl name (funcall transform table params)))
  4740. (cl-incf ntbl))
  4741. (message "Table converted and installed at %d receiver location%s"
  4742. ntbl (if (> ntbl 1) "s" ""))
  4743. (and (> ntbl 0) ntbl))))
  4744. (defun org-remove-by-index (list indices &optional i0)
  4745. "Remove the elements in LIST with indices in INDICES.
  4746. First element has index 0, or I0 if given."
  4747. (if (not indices)
  4748. list
  4749. (if (integerp indices) (setq indices (list indices)))
  4750. (setq i0 (1- (or i0 0)))
  4751. (delq :rm (mapcar (lambda (x)
  4752. (setq i0 (1+ i0))
  4753. (if (memq i0 indices) :rm x))
  4754. list))))
  4755. (defun orgtbl-toggle-comment ()
  4756. "Comment or uncomment the orgtbl at point."
  4757. (interactive)
  4758. (let* ((case-fold-search t)
  4759. (re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
  4760. (re2 (concat "^" orgtbl-line-start-regexp))
  4761. (commented (save-excursion (beginning-of-line 1)
  4762. (cond ((looking-at re1) t)
  4763. ((looking-at re2) nil)
  4764. (t (user-error "Not at an org table")))))
  4765. (re (if commented re1 re2))
  4766. beg end)
  4767. (save-excursion
  4768. (beginning-of-line 1)
  4769. (while (looking-at re) (beginning-of-line 0))
  4770. (beginning-of-line 2)
  4771. (setq beg (point))
  4772. (while (looking-at re) (beginning-of-line 2))
  4773. (setq end (point)))
  4774. (comment-region beg end (if commented '(4) nil))))
  4775. (defun orgtbl-insert-radio-table ()
  4776. "Insert a radio table template appropriate for this major mode."
  4777. (interactive)
  4778. (let* ((e (cl-assoc-if #'derived-mode-p orgtbl-radio-table-templates))
  4779. (txt (nth 1 e))
  4780. name pos)
  4781. (unless e (user-error "No radio table setup defined for %s" major-mode))
  4782. (setq name (read-string "Table name: "))
  4783. (while (string-match "%n" txt)
  4784. (setq txt (replace-match name t t txt)))
  4785. (or (bolp) (insert "\n"))
  4786. (setq pos (point))
  4787. (insert txt)
  4788. (goto-char pos)))
  4789. ;;;###autoload
  4790. (defun orgtbl-to-generic (table params)
  4791. "Convert the orgtbl-mode TABLE to some other format.
  4792. This generic routine can be used for many standard cases.
  4793. TABLE is a list, each entry either the symbol `hline' for
  4794. a horizontal separator line, or a list of fields for that
  4795. line. PARAMS is a property list of parameters that can
  4796. influence the conversion.
  4797. Valid parameters are:
  4798. :backend, :raw
  4799. Export back-end used as a basis to transcode elements of the
  4800. table, when no specific parameter applies to it. It is also
  4801. used to translate cells contents. You can prevent this by
  4802. setting :raw property to a non-nil value.
  4803. :splice
  4804. When non-nil, only convert rows, not the table itself. This is
  4805. equivalent to setting to the empty string both :tstart
  4806. and :tend, which see.
  4807. :skip
  4808. When set to an integer N, skip the first N lines of the table.
  4809. Horizontal separation lines do count for this parameter!
  4810. :skipcols
  4811. List of columns that should be skipped. If the table has
  4812. a column with calculation marks, that column is automatically
  4813. discarded beforehand.
  4814. :hline
  4815. String to be inserted on horizontal separation lines. May be
  4816. nil to ignore these lines altogether.
  4817. :sep
  4818. Separator between two fields, as a string.
  4819. Each in the following group may be either a string or a function
  4820. of no arguments returning a string:
  4821. :tstart, :tend
  4822. Strings to start and end the table. Ignored when :splice is t.
  4823. :lstart, :lend
  4824. Strings to start and end a new table line.
  4825. :llstart, :llend
  4826. Strings to start and end the last table line. Default,
  4827. respectively, to :lstart and :lend.
  4828. Each in the following group may be a string or a function of one
  4829. argument (either the cells in the current row, as a list of
  4830. strings, or the current cell) returning a string:
  4831. :lfmt
  4832. Format string for an entire row, with enough %s to capture all
  4833. fields. When non-nil, :lstart, :lend, and :sep are ignored.
  4834. :llfmt
  4835. Format for the entire last line, defaults to :lfmt.
  4836. :fmt
  4837. A format to be used to wrap the field, should contain %s for
  4838. the original field value. For example, to wrap everything in
  4839. dollars, you could use :fmt \"$%s$\". This may also be
  4840. a property list with column numbers and format strings, or
  4841. functions, e.g.,
  4842. (:fmt (2 \"$%s$\" 4 (lambda (c) (format \"$%s$\" c))))
  4843. :hlstart :hllstart :hlend :hllend :hsep :hlfmt :hllfmt :hfmt
  4844. Same as above, specific for the header lines in the table.
  4845. All lines before the first hline are treated as header. If
  4846. any of these is not present, the data line value is used.
  4847. This may be either a string or a function of two arguments:
  4848. :efmt
  4849. Use this format to print numbers with exponential. The format
  4850. should have %s twice for inserting mantissa and exponent, for
  4851. example \"%s\\\\times10^{%s}\". This may also be a property
  4852. list with column numbers and format strings or functions.
  4853. :fmt will still be applied after :efmt."
  4854. ;; Make sure `org-export-create-backend' is available.
  4855. (require 'ox)
  4856. (let* ((backend (plist-get params :backend))
  4857. (custom-backend
  4858. ;; Build a custom back-end according to PARAMS. Before
  4859. ;; defining a translator, check if there is anything to do.
  4860. ;; When there isn't, let BACKEND handle the element.
  4861. (org-export-create-backend
  4862. :parent (or backend 'org)
  4863. :transcoders
  4864. `((table . ,(org-table--to-generic-table params))
  4865. (table-row . ,(org-table--to-generic-row params))
  4866. (table-cell . ,(org-table--to-generic-cell params))
  4867. ;; Macros are not going to be expanded. However, no
  4868. ;; regular back-end has a transcoder for them. We
  4869. ;; provide one so they are not ignored, but displayed
  4870. ;; as-is instead.
  4871. (macro . (lambda (m c i) (org-element-macro-interpreter m nil))))))
  4872. data info)
  4873. ;; Store TABLE as Org syntax in DATA. Tolerate non-string cells.
  4874. ;; Initialize communication channel in INFO.
  4875. (with-temp-buffer
  4876. (let ((org-inhibit-startup t)) (org-mode))
  4877. (let ((standard-output (current-buffer))
  4878. (org-element-use-cache nil))
  4879. (dolist (e table)
  4880. (cond ((eq e 'hline) (princ "|--\n"))
  4881. ((consp e)
  4882. (princ "| ") (dolist (c e) (princ c) (princ " |"))
  4883. (princ "\n")))))
  4884. ;; Add back-end specific filters, but not user-defined ones. In
  4885. ;; particular, make sure to call parse-tree filters on the
  4886. ;; table.
  4887. (setq info
  4888. (let ((org-export-filters-alist nil))
  4889. (org-export-install-filters
  4890. (org-combine-plists
  4891. (org-export-get-environment backend nil params)
  4892. `(:back-end ,(org-export-get-backend backend))))))
  4893. (setq data
  4894. (org-export-filter-apply-functions
  4895. (plist-get info :filter-parse-tree)
  4896. (org-element-map (org-element-parse-buffer) 'table
  4897. #'identity nil t)
  4898. info)))
  4899. (when (and backend (symbolp backend) (not (org-export-get-backend backend)))
  4900. (user-error "Unknown :backend value"))
  4901. (when (or (not backend) (plist-get info :raw)) (require 'ox-org))
  4902. ;; Handle :skip parameter.
  4903. (let ((skip (plist-get info :skip)))
  4904. (when skip
  4905. (unless (wholenump skip) (user-error "Wrong :skip value"))
  4906. (let ((n 0))
  4907. (org-element-map data 'table-row
  4908. (lambda (row)
  4909. (if (>= n skip) t
  4910. (org-element-extract-element row)
  4911. (cl-incf n)
  4912. nil))
  4913. nil t))))
  4914. ;; Handle :skipcols parameter.
  4915. (let ((skipcols (plist-get info :skipcols)))
  4916. (when skipcols
  4917. (unless (consp skipcols) (user-error "Wrong :skipcols value"))
  4918. (org-element-map data 'table
  4919. (lambda (table)
  4920. (let ((specialp (org-export-table-has-special-column-p table)))
  4921. (dolist (row (org-element-contents table))
  4922. (when (eq (org-element-property :type row) 'standard)
  4923. (let ((c 1))
  4924. (dolist (cell (nthcdr (if specialp 1 0)
  4925. (org-element-contents row)))
  4926. (when (memq c skipcols)
  4927. (org-element-extract-element cell))
  4928. (cl-incf c))))))))))
  4929. ;; Since we are going to export using a low-level mechanism,
  4930. ;; ignore special column and special rows manually.
  4931. (let ((special? (org-export-table-has-special-column-p data))
  4932. ignore)
  4933. (org-element-map data (if special? '(table-cell table-row) 'table-row)
  4934. (lambda (datum)
  4935. (when (if (eq (org-element-type datum) 'table-row)
  4936. (org-export-table-row-is-special-p datum nil)
  4937. (org-export-first-sibling-p datum nil))
  4938. (push datum ignore))))
  4939. (setq info (plist-put info :ignore-list ignore)))
  4940. ;; We use a low-level mechanism to export DATA so as to skip all
  4941. ;; usual pre-processing and post-processing, i.e., hooks, Babel
  4942. ;; code evaluation, include keywords and macro expansion. Only
  4943. ;; back-end specific filters are retained.
  4944. (let ((output (org-export-data-with-backend data custom-backend info)))
  4945. ;; Remove final newline.
  4946. (if (org-string-nw-p output) (substring-no-properties output 0 -1) ""))))
  4947. (defun org-table--generic-apply (value name &optional with-cons &rest args)
  4948. (cond ((null value) nil)
  4949. ((functionp value) `(funcall ',value ,@args))
  4950. ((stringp value)
  4951. (cond ((consp (car args)) `(apply #'format ,value ,@args))
  4952. (args `(format ,value ,@args))
  4953. (t value)))
  4954. ((and with-cons (consp value))
  4955. `(let ((val (cadr (memq column ',value))))
  4956. (cond ((null val) contents)
  4957. ((stringp val) (format val ,@args))
  4958. ((functionp val) (funcall val ,@args))
  4959. (t (user-error "Wrong %s value" ,name)))))
  4960. (t (user-error "Wrong %s value" name))))
  4961. (defun org-table--to-generic-table (params)
  4962. "Return custom table transcoder according to PARAMS.
  4963. PARAMS is a plist. See `orgtbl-to-generic' for more
  4964. information."
  4965. (let ((backend (plist-get params :backend))
  4966. (splice (plist-get params :splice))
  4967. (tstart (plist-get params :tstart))
  4968. (tend (plist-get params :tend)))
  4969. `(lambda (table contents info)
  4970. (concat
  4971. ,(and tstart (not splice)
  4972. `(concat ,(org-table--generic-apply tstart ":tstart") "\n"))
  4973. ,(if (or (not backend) tstart tend splice) 'contents
  4974. `(org-export-with-backend ',backend table contents info))
  4975. ,(org-table--generic-apply (and (not splice) tend) ":tend")))))
  4976. (defun org-table--to-generic-row (params)
  4977. "Return custom table row transcoder according to PARAMS.
  4978. PARAMS is a plist. See `orgtbl-to-generic' for more
  4979. information."
  4980. (let* ((backend (plist-get params :backend))
  4981. (lstart (plist-get params :lstart))
  4982. (llstart (plist-get params :llstart))
  4983. (hlstart (plist-get params :hlstart))
  4984. (hllstart (plist-get params :hllstart))
  4985. (lend (plist-get params :lend))
  4986. (llend (plist-get params :llend))
  4987. (hlend (plist-get params :hlend))
  4988. (hllend (plist-get params :hllend))
  4989. (lfmt (plist-get params :lfmt))
  4990. (llfmt (plist-get params :llfmt))
  4991. (hlfmt (plist-get params :hlfmt))
  4992. (hllfmt (plist-get params :hllfmt)))
  4993. `(lambda (row contents info)
  4994. (if (eq (org-element-property :type row) 'rule)
  4995. ,(cond
  4996. ((plist-member params :hline)
  4997. (org-table--generic-apply (plist-get params :hline) ":hline"))
  4998. (backend `(org-export-with-backend ',backend row nil info)))
  4999. (let ((headerp ,(and (or hlfmt hlstart hlend)
  5000. '(org-export-table-row-in-header-p row info)))
  5001. (last-header-p
  5002. ,(and (or hllfmt hllstart hllend)
  5003. '(org-export-table-row-ends-header-p row info)))
  5004. (lastp (not (org-export-get-next-element row info))))
  5005. (when contents
  5006. ;; Check if we can apply `:lfmt', `:llfmt', `:hlfmt', or
  5007. ;; `:hllfmt' to CONTENTS. Otherwise, fallback on
  5008. ;; `:lstart', `:lend' and their relatives.
  5009. ,(let ((cells
  5010. '(org-element-map row 'table-cell
  5011. (lambda (cell)
  5012. ;; Export all cells, without separators.
  5013. ;;
  5014. ;; Use `org-export-data-with-backend'
  5015. ;; instead of `org-export-data' to eschew
  5016. ;; cached values, which
  5017. ;; ignore :orgtbl-ignore-sep parameter.
  5018. (org-export-data-with-backend
  5019. cell
  5020. (plist-get info :back-end)
  5021. (org-combine-plists info '(:orgtbl-ignore-sep t))))
  5022. info)))
  5023. `(cond
  5024. ,(and hllfmt
  5025. `(last-header-p ,(org-table--generic-apply
  5026. hllfmt ":hllfmt" nil cells)))
  5027. ,(and hlfmt
  5028. `(headerp ,(org-table--generic-apply
  5029. hlfmt ":hlfmt" nil cells)))
  5030. ,(and llfmt
  5031. `(lastp ,(org-table--generic-apply
  5032. llfmt ":llfmt" nil cells)))
  5033. (t
  5034. ,(if lfmt (org-table--generic-apply lfmt ":lfmt" nil cells)
  5035. `(concat
  5036. (cond
  5037. ,(and
  5038. (or hllstart hllend)
  5039. `(last-header-p
  5040. (concat
  5041. ,(org-table--generic-apply hllstart ":hllstart")
  5042. contents
  5043. ,(org-table--generic-apply hllend ":hllend"))))
  5044. ,(and
  5045. (or hlstart hlend)
  5046. `(headerp
  5047. (concat
  5048. ,(org-table--generic-apply hlstart ":hlstart")
  5049. contents
  5050. ,(org-table--generic-apply hlend ":hlend"))))
  5051. ,(and
  5052. (or llstart llend)
  5053. `(lastp
  5054. (concat
  5055. ,(org-table--generic-apply llstart ":llstart")
  5056. contents
  5057. ,(org-table--generic-apply llend ":llend"))))
  5058. (t
  5059. ,(cond
  5060. ((or lstart lend)
  5061. `(concat
  5062. ,(org-table--generic-apply lstart ":lstart")
  5063. contents
  5064. ,(org-table--generic-apply lend ":lend")))
  5065. (backend
  5066. `(org-export-with-backend
  5067. ',backend row contents info))
  5068. (t 'contents)))))))))))))))
  5069. (defun org-table--to-generic-cell (params)
  5070. "Return custom table cell transcoder according to PARAMS.
  5071. PARAMS is a plist. See `orgtbl-to-generic' for more
  5072. information."
  5073. (let* ((backend (plist-get params :backend))
  5074. (efmt (plist-get params :efmt))
  5075. (fmt (plist-get params :fmt))
  5076. (hfmt (plist-get params :hfmt))
  5077. (sep (plist-get params :sep))
  5078. (hsep (plist-get params :hsep)))
  5079. `(lambda (cell contents info)
  5080. ;; Make sure that contents are exported as Org data when :raw
  5081. ;; parameter is non-nil.
  5082. ,(when (and backend (plist-get params :raw))
  5083. `(setq contents
  5084. ;; Since we don't know what are the pseudo object
  5085. ;; types defined in backend, we cannot pass them to
  5086. ;; `org-element-interpret-data'. As a consequence,
  5087. ;; they will be treated as pseudo elements, and will
  5088. ;; have newlines appended instead of spaces.
  5089. ;; Therefore, we must make sure :post-blank value is
  5090. ;; really turned into spaces.
  5091. (replace-regexp-in-string
  5092. "\n" " "
  5093. (org-trim
  5094. (org-element-interpret-data
  5095. (org-element-contents cell))))))
  5096. (let ((headerp ,(and (or hfmt hsep)
  5097. '(org-export-table-row-in-header-p
  5098. (org-export-get-parent-element cell) info)))
  5099. (column
  5100. ;; Call costly `org-export-table-cell-address' only if
  5101. ;; absolutely necessary, i.e., if one
  5102. ;; of :fmt :efmt :hfmt has a "plist type" value.
  5103. ,(and (cl-some (lambda (v) (integerp (car-safe v)))
  5104. (list efmt hfmt fmt))
  5105. '(1+ (cdr (org-export-table-cell-address cell info))))))
  5106. (when contents
  5107. ;; Check if we can apply `:efmt' on CONTENTS.
  5108. ,(when efmt
  5109. `(when (string-match orgtbl-exp-regexp contents)
  5110. (let ((mantissa (match-string 1 contents))
  5111. (exponent (match-string 2 contents)))
  5112. (setq contents ,(org-table--generic-apply
  5113. efmt ":efmt" t 'mantissa 'exponent)))))
  5114. ;; Check if we can apply FMT (or HFMT) on CONTENTS.
  5115. (cond
  5116. ,(and hfmt `(headerp (setq contents ,(org-table--generic-apply
  5117. hfmt ":hfmt" t 'contents))))
  5118. ,(and fmt `(t (setq contents ,(org-table--generic-apply
  5119. fmt ":fmt" t 'contents))))))
  5120. ;; If a separator is provided, use it instead of BACKEND's.
  5121. ;; Separators are ignored when LFMT (or equivalent) is
  5122. ;; provided.
  5123. ,(cond
  5124. ((or hsep sep)
  5125. `(if (or ,(and (not sep) '(not headerp))
  5126. (plist-get info :orgtbl-ignore-sep)
  5127. (not (org-export-get-next-element cell info)))
  5128. ,(if (not backend) 'contents
  5129. `(org-export-with-backend ',backend cell contents info))
  5130. (concat contents
  5131. ,(if (and sep hsep) `(if headerp ,hsep ,sep)
  5132. (or hsep sep)))))
  5133. (backend `(org-export-with-backend ',backend cell contents info))
  5134. (t 'contents))))))
  5135. ;;;###autoload
  5136. (defun orgtbl-to-tsv (table params)
  5137. "Convert the orgtbl-mode table to TAB separated material."
  5138. (orgtbl-to-generic table (org-combine-plists '(:sep "\t") params)))
  5139. ;;;###autoload
  5140. (defun orgtbl-to-csv (table params)
  5141. "Convert the orgtbl-mode table to CSV material.
  5142. This does take care of the proper quoting of fields with comma or quotes."
  5143. (orgtbl-to-generic table
  5144. (org-combine-plists '(:sep "," :fmt org-quote-csv-field)
  5145. params)))
  5146. ;;;###autoload
  5147. (defun orgtbl-to-latex (table params)
  5148. "Convert the orgtbl-mode TABLE to LaTeX.
  5149. TABLE is a list, each entry either the symbol `hline' for
  5150. a horizontal separator line, or a list of fields for that line.
  5151. PARAMS is a property list of parameters that can influence the
  5152. conversion. All parameters from `orgtbl-to-generic' are
  5153. supported. It is also possible to use the following ones:
  5154. :booktabs
  5155. When non-nil, use formal \"booktabs\" style.
  5156. :environment
  5157. Specify environment to use, as a string. If you use
  5158. \"longtable\", you may also want to specify :language property,
  5159. as a string, to get proper continuation strings."
  5160. (require 'ox-latex)
  5161. (orgtbl-to-generic
  5162. table
  5163. (org-combine-plists
  5164. ;; Provide sane default values.
  5165. (list :backend 'latex
  5166. :latex-default-table-mode 'table
  5167. :latex-tables-centered nil
  5168. :latex-tables-booktabs (plist-get params :booktabs)
  5169. :latex-table-scientific-notation nil
  5170. :latex-default-table-environment
  5171. (or (plist-get params :environment) "tabular"))
  5172. params)))
  5173. ;;;###autoload
  5174. (defun orgtbl-to-html (table params)
  5175. "Convert the orgtbl-mode TABLE to HTML.
  5176. TABLE is a list, each entry either the symbol `hline' for
  5177. a horizontal separator line, or a list of fields for that line.
  5178. PARAMS is a property list of parameters that can influence the
  5179. conversion. All parameters from `orgtbl-to-generic' are
  5180. supported. It is also possible to use the following one:
  5181. :attributes
  5182. Attributes and values, as a plist, which will be used in
  5183. <table> tag."
  5184. (require 'ox-html)
  5185. (orgtbl-to-generic
  5186. table
  5187. (org-combine-plists
  5188. ;; Provide sane default values.
  5189. (list :backend 'html
  5190. :html-table-data-tags '("<td%s>" . "</td>")
  5191. :html-table-use-header-tags-for-first-column nil
  5192. :html-table-align-individual-fields t
  5193. :html-table-row-tags '("<tr>" . "</tr>")
  5194. :html-table-attributes
  5195. (if (plist-member params :attributes)
  5196. (plist-get params :attributes)
  5197. '(:border "2" :cellspacing "0" :cellpadding "6" :rules "groups"
  5198. :frame "hsides")))
  5199. params)))
  5200. ;;;###autoload
  5201. (defun orgtbl-to-texinfo (table params)
  5202. "Convert the orgtbl-mode TABLE to Texinfo.
  5203. TABLE is a list, each entry either the symbol `hline' for
  5204. a horizontal separator line, or a list of fields for that line.
  5205. PARAMS is a property list of parameters that can influence the
  5206. conversion. All parameters from `orgtbl-to-generic' are
  5207. supported. It is also possible to use the following one:
  5208. :columns
  5209. Column widths, as a string. When providing column fractions,
  5210. \"@columnfractions\" command can be omitted."
  5211. (require 'ox-texinfo)
  5212. (let ((output
  5213. (orgtbl-to-generic
  5214. table
  5215. (org-combine-plists
  5216. (list :backend 'texinfo
  5217. :texinfo-tables-verbatim nil
  5218. :texinfo-table-scientific-notation nil)
  5219. params)))
  5220. (columns (let ((w (plist-get params :columns)))
  5221. (cond ((not w) nil)
  5222. ((string-match-p "{\\|@columnfractions " w) w)
  5223. (t (concat "@columnfractions " w))))))
  5224. (if (not columns) output
  5225. (replace-regexp-in-string
  5226. "@multitable \\(.*\\)" columns output t nil 1))))
  5227. ;;;###autoload
  5228. (defun orgtbl-to-orgtbl (table params)
  5229. "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
  5230. TABLE is a list, each entry either the symbol `hline' for
  5231. a horizontal separator line, or a list of fields for that line.
  5232. PARAMS is a property list of parameters that can influence the
  5233. conversion. All parameters from `orgtbl-to-generic' are
  5234. supported.
  5235. Useful when slicing one table into many. The :hline, :sep,
  5236. :lstart, and :lend provide orgtbl framing. :tstart and :tend can
  5237. be set to provide ORGTBL directives for the generated table."
  5238. (require 'ox-org)
  5239. (orgtbl-to-generic table (org-combine-plists params (list :backend 'org))))
  5240. (defun orgtbl-to-table.el (table params)
  5241. "Convert the orgtbl-mode TABLE into a table.el table.
  5242. TABLE is a list, each entry either the symbol `hline' for
  5243. a horizontal separator line, or a list of fields for that line.
  5244. PARAMS is a property list of parameters that can influence the
  5245. conversion. All parameters from `orgtbl-to-generic' are
  5246. supported."
  5247. (with-temp-buffer
  5248. (insert (orgtbl-to-orgtbl table params))
  5249. (org-table-align)
  5250. (replace-regexp-in-string
  5251. "-|" "-+"
  5252. (replace-regexp-in-string "|-" "+-" (buffer-substring 1 (buffer-size))))))
  5253. (defun orgtbl-to-unicode (table params)
  5254. "Convert the orgtbl-mode TABLE into a table with unicode characters.
  5255. TABLE is a list, each entry either the symbol `hline' for
  5256. a horizontal separator line, or a list of fields for that line.
  5257. PARAMS is a property list of parameters that can influence the
  5258. conversion. All parameters from `orgtbl-to-generic' are
  5259. supported. It is also possible to use the following ones:
  5260. :ascii-art
  5261. When non-nil, use \"ascii-art-to-unicode\" package to translate
  5262. the table. You can download it here:
  5263. http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el.
  5264. :narrow
  5265. When non-nil, narrow columns width than provided width cookie,
  5266. using \"=>\" as an ellipsis, just like in an Org mode buffer."
  5267. (require 'ox-ascii)
  5268. (orgtbl-to-generic
  5269. table
  5270. (org-combine-plists
  5271. (list :backend 'ascii
  5272. :ascii-charset 'utf-8
  5273. :ascii-table-widen-columns (not (plist-get params :narrow))
  5274. :ascii-table-use-ascii-art (plist-get params :ascii-art))
  5275. params)))
  5276. ;; Put the cursor in a column containing numerical values
  5277. ;; of an Org table,
  5278. ;; type C-c " a
  5279. ;; A new column is added with a bar plot.
  5280. ;; When the table is refreshed (C-u C-c *),
  5281. ;; the plot is updated to reflect the new values.
  5282. (defun orgtbl-ascii-draw (value min max &optional width characters)
  5283. "Draw an ascii bar in a table.
  5284. VALUE is the value to plot, it determines the width of the bar to draw.
  5285. MIN is the value that will be displayed as empty (zero width bar).
  5286. MAX is the value that will draw a bar filling all the WIDTH.
  5287. WIDTH is the span in characters from MIN to MAX.
  5288. CHARACTERS is a string that will compose the bar, with shades of grey
  5289. from pure white to pure black. It defaults to a 10 characters string
  5290. of regular ascii characters."
  5291. (let* ((width (ceiling (or width 12)))
  5292. (characters (or characters " .:;c!lhVHW"))
  5293. (len (1- (length characters)))
  5294. (value (float (if (numberp value)
  5295. value (string-to-number value))))
  5296. (relative (/ (- value min) (- max min)))
  5297. (steps (round (* relative width len))))
  5298. (cond ((< steps 0) "too small")
  5299. ((> steps (* width len)) "too large")
  5300. (t (let* ((int-division (/ steps len))
  5301. (remainder (- steps (* int-division len))))
  5302. (concat (make-string int-division (elt characters len))
  5303. (string (elt characters remainder))))))))
  5304. ;;;###autoload
  5305. (defun orgtbl-ascii-plot (&optional ask)
  5306. "Draw an ASCII bar plot in a column.
  5307. With cursor in a column containing numerical values, this function
  5308. will draw a plot in a new column.
  5309. ASK, if given, is a numeric prefix to override the default 12
  5310. characters width of the plot. ASK may also be the `\\[universal-argument]' \
  5311. prefix,
  5312. which will prompt for the width."
  5313. (interactive "P")
  5314. (let ((col (org-table-current-column))
  5315. (min 1e999) ; 1e999 will be converted to infinity
  5316. (max -1e999) ; which is the desired result
  5317. (table (org-table-to-lisp))
  5318. (length
  5319. (cond ((consp ask)
  5320. (read-number "Length of column " 12))
  5321. ((numberp ask) ask)
  5322. (t 12))))
  5323. ;; Skip any hline a the top of table.
  5324. (while (eq (car table) 'hline) (setq table (cdr table)))
  5325. ;; Skip table header if any.
  5326. (dolist (x (or (cdr (memq 'hline table)) table))
  5327. (when (consp x)
  5328. (setq x (nth (1- col) x))
  5329. (when (string-match
  5330. "^[-+]?\\([0-9]*[.]\\)?[0-9]*\\([eE][+-]?[0-9]+\\)?$"
  5331. x)
  5332. (setq x (string-to-number x))
  5333. (when (> min x) (setq min x))
  5334. (when (< max x) (setq max x)))))
  5335. (org-table-insert-column)
  5336. (org-table-move-column-right)
  5337. (org-table-store-formulas
  5338. (cons
  5339. (cons
  5340. (concat "$" (number-to-string (1+ col)))
  5341. (format "'(%s $%s %s %s %s)"
  5342. "orgtbl-ascii-draw" col min max length))
  5343. (org-table-get-stored-formulas)))
  5344. (org-table-recalculate t)))
  5345. ;; Example of extension: unicode characters
  5346. ;; Here are two examples of different styles.
  5347. ;; Unicode block characters are used to give a smooth effect.
  5348. ;; See http://en.wikipedia.org/wiki/Block_Elements
  5349. ;; Use one of those drawing functions
  5350. ;; - orgtbl-ascii-draw (the default ascii)
  5351. ;; - orgtbl-uc-draw-grid (unicode with a grid effect)
  5352. ;; - orgtbl-uc-draw-cont (smooth unicode)
  5353. ;; This is best viewed with the "DejaVu Sans Mono" font
  5354. ;; (use M-x set-frame-font).
  5355. (defun orgtbl-uc-draw-grid (value min max &optional width)
  5356. "Draw a bar in a table using block unicode characters.
  5357. It is a variant of orgtbl-ascii-draw with Unicode block
  5358. characters, for a smooth display. Bars appear as grids (to the
  5359. extent the font allows)."
  5360. ;; http://en.wikipedia.org/wiki/Block_Elements
  5361. ;; best viewed with the "DejaVu Sans Mono" font.
  5362. (orgtbl-ascii-draw value min max width
  5363. " \u258F\u258E\u258D\u258C\u258B\u258A\u2589"))
  5364. (defun orgtbl-uc-draw-cont (value min max &optional width)
  5365. "Draw a bar in a table using block unicode characters.
  5366. It is a variant of orgtbl-ascii-draw with Unicode block
  5367. characters, for a smooth display. Bars are solid (to the extent
  5368. the font allows)."
  5369. (orgtbl-ascii-draw value min max width
  5370. " \u258F\u258E\u258D\u258C\u258B\u258A\u2589\u2588"))
  5371. (defun org-table-get-remote-range (name-or-id form)
  5372. "Get a field value or a list of values in a range from table at ID.
  5373. NAME-OR-ID may be the name of a table in the current file as set
  5374. by a \"#+NAME:\" directive. The first table following this line
  5375. will then be used. Alternatively, it may be an ID referring to
  5376. any entry, also in a different file. In this case, the first
  5377. table in that entry will be referenced.
  5378. FORM is a field or range descriptor like \"@2$3\" or \"B3\" or
  5379. \"@I$2..@II$2\". All the references must be absolute, not relative.
  5380. The return value is either a single string for a single field, or a
  5381. list of the fields in the rectangle."
  5382. (save-match-data
  5383. (let ((case-fold-search t) (id-loc nil)
  5384. ;; Protect a bunch of variables from being overwritten by
  5385. ;; the context of the remote table.
  5386. org-table-column-names org-table-column-name-regexp
  5387. org-table-local-parameters org-table-named-field-locations
  5388. org-table-current-line-types
  5389. org-table-current-begin-pos org-table-dlines
  5390. org-table-current-ncol
  5391. org-table-hlines
  5392. org-table-last-column-widths
  5393. org-table-last-alignment
  5394. buffer loc)
  5395. (setq form (org-table-convert-refs-to-rc form))
  5396. (org-with-wide-buffer
  5397. (goto-char (point-min))
  5398. (if (re-search-forward
  5399. (concat "^[ \t]*#\\+\\(tbl\\)?name:[ \t]*"
  5400. (regexp-quote name-or-id) "[ \t]*$")
  5401. nil t)
  5402. (setq buffer (current-buffer) loc (match-beginning 0))
  5403. (setq id-loc (org-id-find name-or-id 'marker))
  5404. (unless (and id-loc (markerp id-loc))
  5405. (user-error "Can't find remote table \"%s\"" name-or-id))
  5406. (setq buffer (marker-buffer id-loc)
  5407. loc (marker-position id-loc))
  5408. (move-marker id-loc nil))
  5409. (with-current-buffer buffer
  5410. (org-with-wide-buffer
  5411. (goto-char loc)
  5412. (forward-char 1)
  5413. (unless (and (re-search-forward "^\\(\\*+ \\)\\|^[ \t]*|" nil t)
  5414. (not (match-beginning 1)))
  5415. (user-error "Cannot find a table at NAME or ID %s" name-or-id))
  5416. (org-table-analyze)
  5417. (setq form (org-table-formula-substitute-names
  5418. (org-table-formula-handle-first/last-rc form)))
  5419. (if (and (string-match org-table-range-regexp form)
  5420. (> (length (match-string 0 form)) 1))
  5421. (org-table-get-range
  5422. (match-string 0 form) org-table-current-begin-pos 1)
  5423. form)))))))
  5424. (defun org-table-remote-reference-indirection (form)
  5425. "Return formula with table remote references substituted by indirection.
  5426. For example \"remote($1, @>$2)\" => \"remote(year_2013, @>$1)\".
  5427. This indirection works only with the format @ROW$COLUMN. The
  5428. format \"B3\" is not supported because it can not be
  5429. distinguished from a plain table name or ID."
  5430. (let ((regexp
  5431. ;; Same as in `org-table-eval-formula'.
  5432. (concat "\\<remote([ \t]*\\("
  5433. ;; Allow "$1", "@<", "$-1", "@<<$1" etc.
  5434. "[@$][^ \t,]+"
  5435. "\\)[ \t]*,[ \t]*\\([^\n)]+\\))")))
  5436. (replace-regexp-in-string
  5437. regexp
  5438. (lambda (m)
  5439. (save-match-data
  5440. (let ((eq (org-table-formula-handle-first/last-rc (match-string 1 m))))
  5441. (org-table-get-range
  5442. (if (string-match-p "\\`\\$[0-9]+\\'" eq)
  5443. (concat "@0" eq)
  5444. eq)))))
  5445. form t t 1)))
  5446. (defmacro org-define-lookup-function (mode)
  5447. (let ((mode-str (symbol-name mode))
  5448. (first-p (eq mode 'first))
  5449. (all-p (eq mode 'all)))
  5450. (let ((plural-str (if all-p "s" "")))
  5451. `(defun ,(intern (format "org-lookup-%s" mode-str)) (val s-list r-list &optional predicate)
  5452. ,(format "Find %s occurrence%s of VAL in S-LIST; return corresponding element%s of R-LIST.
  5453. If R-LIST is nil, return matching element%s of S-LIST.
  5454. If PREDICATE is not nil, use it instead of `equal' to match VAL.
  5455. Matching is done by (PREDICATE VAL S), where S is an element of S-LIST.
  5456. This function is generated by a call to the macro `org-define-lookup-function'."
  5457. mode-str plural-str plural-str plural-str)
  5458. (let ,(let ((lvars '((p (or predicate 'equal))
  5459. (sl s-list)
  5460. (rl (or r-list s-list))
  5461. (ret nil))))
  5462. (if first-p (cons '(match-p nil) lvars) lvars))
  5463. (while ,(if first-p '(and (not match-p) sl) 'sl)
  5464. (when (funcall p val (car sl))
  5465. ,(when first-p '(setq match-p t))
  5466. (let ((rval (car rl)))
  5467. (setq ret ,(if all-p '(append ret (list rval)) 'rval))))
  5468. (setq sl (cdr sl) rl (cdr rl)))
  5469. ret)))))
  5470. (org-define-lookup-function first)
  5471. (org-define-lookup-function last)
  5472. (org-define-lookup-function all)
  5473. (provide 'org-table)
  5474. ;; Local variables:
  5475. ;; generated-autoload-file: "org-loaddefs.el"
  5476. ;; End:
  5477. ;;; org-table.el ends here