12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767 |
- ;;; ses.el -- Simple Emacs Spreadsheet -*- lexical-binding:t -*-
- ;; Copyright (C) 2002-2015 Free Software Foundation, Inc.
- ;; Author: Jonathan Yavner <jyavner@member.fsf.org>
- ;; Maintainer: Vincent Belaïche <vincentb1@users.sourceforge.net>
- ;; Keywords: spreadsheet Dijkstra
- ;; This file is part of GNU Emacs.
- ;; GNU Emacs is free software: you can redistribute it and/or modify
- ;; it under the terms of the GNU General Public License as published by
- ;; the Free Software Foundation, either version 3 of the License, or
- ;; (at your option) any later version.
- ;; GNU Emacs is distributed in the hope that it will be useful,
- ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
- ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- ;; GNU General Public License for more details.
- ;; You should have received a copy of the GNU General Public License
- ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
- ;;; Commentary:
- ;;; To-do list:
- ;; * M-w should deactivate the mark.
- ;; * offer some way to use absolute cell addressing.
- ;; * Maybe some way to copy a reference to a cell's formula rather than the
- ;; formula itself.
- ;; * split (catch 'cycle ...) call back into one or more functions
- ;; * Use $ or … for truncated fields
- ;; * M-t to transpose 2 columns.
- ;; * M-d should kill the cell under point.
- ;; * C-t to transpose 2 rows.
- ;; * C-k and M-k should be ses-kill-row and ses-kill-column.
- ;; * C-o should insert the row below point rather than above?
- ;; * rows inserted with C-o should inherit formulas from surrounding rows.
- ;; * Add command to make a range of columns be temporarily invisible.
- ;; * Allow paste of one cell to a range of cells -- copy formula to each.
- ;; * Do something about control characters & octal codes in cell print
- ;; areas. Use string-width?
- ;; * Input validation functions. How specified?
- ;; * Faces (colors & styles) in print cells.
- ;; * Move a column by dragging its letter in the header line.
- ;; * Left-margin column for row number.
- ;; * Move a row by dragging its number in the left-margin.
- ;;; Cycle detection
- ;; Cycles used to be detected by stationarity of ses--deferred-recalc. This was
- ;; working fine in most cases, however failed in some cases of several path
- ;; racing together.
- ;;
- ;; The current algorithm is based on Dijkstra's algorithm. The cycle length is
- ;; stored in some cell property. In order not to reset in all cells such
- ;; property at each update, the cycle length is stored in this property along
- ;; with some update attempt id that is incremented at each update. The current
- ;; update id is ses--Dijkstra-attempt-nb. In case there is a cycle the cycle
- ;; length diverge to infinite so it will exceed ses--Dijkstra-weight-bound at
- ;; some point of time that allows detection. Otherwise it converges to the
- ;; longest path length in the update tree.
- ;;; Code:
- (require 'unsafep)
- (require 'macroexp)
- (eval-when-compile (require 'cl-lib))
- ;;----------------------------------------------------------------------------
- ;; User-customizable variables
- ;;----------------------------------------------------------------------------
- (defgroup ses nil
- "Simple Emacs Spreadsheet."
- :tag "SES"
- :group 'applications
- :link '(custom-manual "(ses) Top")
- :prefix "ses-"
- :version "21.1")
- (defcustom ses-initial-size '(1 . 1)
- "Initial size of a new spreadsheet, as a cons (NUMROWS . NUMCOLS)."
- :group 'ses
- :type '(cons (integer :tag "numrows") (integer :tag "numcols")))
- (defcustom ses-initial-column-width 7
- "Initial width of columns in a new spreadsheet."
- :group 'ses
- :type '(integer :match (lambda (widget value) (> value 0))))
- (defcustom ses-initial-default-printer "%.7g"
- "Initial default printer for a new spreadsheet."
- :group 'ses
- :type '(choice string
- (list :tag "Parenthesized string" string)
- function))
- (defcustom ses-after-entry-functions '(forward-char)
- "Things to do after entering a value into a cell.
- An abnormal hook that usually runs a cursor-movement function.
- Each function is called with ARG=1."
- :group 'ses
- :type 'hook
- :options '(forward-char backward-char next-line previous-line))
- (defcustom ses-mode-hook nil
- "Hook functions to be run upon entering SES mode."
- :group 'ses
- :type 'hook)
- ;;----------------------------------------------------------------------------
- ;; Global variables and constants
- ;;----------------------------------------------------------------------------
- (defvar ses-read-cell-history nil
- "List of formulas that have been typed in.")
- (defvar ses-read-printer-history nil
- "List of printer functions that have been typed in.")
- (easy-menu-define ses-header-line-menu nil
- "Context menu when mouse-3 is used on the header-line in an SES buffer."
- '("SES header row"
- ["Set current row" ses-set-header-row t]
- ["Unset row" ses-unset-header-row (> ses--header-row 0)]))
- (defconst ses-mode-map
- (let ((keys `("\C-c\M-\C-l" ses-reconstruct-all
- "\C-c\C-l" ses-recalculate-all
- "\C-c\C-n" ses-renarrow-buffer
- "\C-c\C-c" ses-recalculate-cell
- "\C-c\M-\C-s" ses-sort-column
- "\C-c\M-\C-h" ses-set-header-row
- "\C-c\C-t" ses-truncate-cell
- "\C-c\C-j" ses-jump
- "\C-c\C-p" ses-read-default-printer
- "\M-\C-l" ses-reprint-all
- [?\S-\C-l] ses-reprint-all
- [header-line down-mouse-3] ,ses-header-line-menu
- [header-line mouse-2] ses-sort-column-click))
- (newmap (make-sparse-keymap)))
- (while keys
- (define-key (1value newmap) (car keys) (cadr keys))
- (setq keys (cddr keys)))
- newmap)
- "Local keymap for Simple Emacs Spreadsheet.")
- (easy-menu-define ses-menu ses-mode-map
- "Menu bar menu for SES."
- '("SES"
- ["Insert row" ses-insert-row (ses-in-print-area)]
- ["Delete row" ses-delete-row (ses-in-print-area)]
- ["Insert column" ses-insert-column (ses-in-print-area)]
- ["Delete column" ses-delete-column (ses-in-print-area)]
- ["Set column printer" ses-read-column-printer t]
- ["Set column width" ses-set-column-width t]
- ["Set default printer" ses-read-default-printer t]
- ["Jump to cell" ses-jump t]
- ["Set cell printer" ses-read-cell-printer t]
- ["Recalculate cell" ses-recalculate-cell t]
- ["Truncate cell display" ses-truncate-cell t]
- ["Export values" ses-export-tsv t]
- ["Export formulas" ses-export-tsf t]))
- (defconst ses-mode-edit-map
- (let ((keys '("\C-c\C-r" ses-insert-range
- "\C-c\C-s" ses-insert-ses-range
- [S-mouse-3] ses-insert-range-click
- [C-S-mouse-3] ses-insert-ses-range-click
- "\M-\C-i" lisp-complete-symbol)) ; FIXME obsolete
- (newmap (make-sparse-keymap)))
- (set-keymap-parent newmap minibuffer-local-map)
- (while keys
- (define-key newmap (pop keys) (pop keys)))
- newmap)
- "Local keymap for SES minibuffer cell-editing.")
- ;Local keymap for SES print area
- (defalias 'ses-mode-print-map
- (let ((keys '([backtab] backward-char
- [tab] ses-forward-or-insert
- "\C-i" ses-forward-or-insert ; Needed for ses-coverage.el?
- "\M-o" ses-insert-column
- "\C-o" ses-insert-row
- "\C-m" ses-edit-cell
- "\M-k" ses-delete-column
- "\M-y" ses-yank-pop
- "\C-k" ses-delete-row
- "\C-j" ses-append-row-jump-first-column
- "\M-h" ses-mark-row
- "\M-H" ses-mark-column
- "\C-d" ses-clear-cell-forward
- "\C-?" ses-clear-cell-backward
- "(" ses-read-cell
- "\"" ses-read-cell
- "'" ses-read-symbol
- "=" ses-edit-cell
- "c" ses-recalculate-cell
- "j" ses-jump
- "p" ses-read-cell-printer
- "t" ses-truncate-cell
- "w" ses-set-column-width
- "x" ses-export-keymap
- "\M-p" ses-read-column-printer))
- (repl '(;;We'll replace these wherever they appear in the keymap
- clipboard-kill-region ses-kill-override
- end-of-line ses-end-of-line
- kill-line ses-delete-row
- kill-region ses-kill-override
- open-line ses-insert-row))
- (numeric "0123456789.-")
- (newmap (make-keymap)))
- ;;Get rid of printables
- (suppress-keymap newmap t)
- ;;These keys insert themselves as the beginning of a numeric value
- (dotimes (x (length numeric))
- (define-key newmap (substring numeric x (1+ x)) 'ses-read-cell))
- ;;Override these global functions wherever they're bound
- (while repl
- (substitute-key-definition (car repl) (cadr repl) newmap
- (current-global-map))
- (setq repl (cddr repl)))
- ;;Apparently substitute-key-definition doesn't catch this?
- (define-key newmap [(menu-bar) edit cut] 'ses-kill-override)
- ;;Define our other local keys
- (while keys
- (define-key newmap (car keys) (cadr keys))
- (setq keys (cddr keys)))
- newmap))
- ;;Helptext for ses-mode wants keymap as variable, not function
- (defconst ses-mode-print-map (symbol-function 'ses-mode-print-map))
- ;;Key map used for 'x' key.
- (defalias 'ses-export-keymap
- (let ((map (make-sparse-keymap "SES export")))
- (define-key map "T" (cons " tab-formulas" 'ses-export-tsf))
- (define-key map "t" (cons " tab-values" 'ses-export-tsv))
- map))
- (defconst ses-print-data-boundary "\n\014\n"
- "Marker string denoting the boundary between print area and data area.")
- (defconst ses-initial-global-parameters
- "\n( ;Global parameters (these are read first)\n 2 ;SES file-format\n 1 ;numrows\n 1 ;numcols\n)\n\n"
- "Initial contents for the three-element list at the bottom of the data area.")
- (defconst ses-initial-global-parameters-re
- "\n( ;Global parameters (these are read first)\n [23] ;SES file-format\n [0-9]+ ;numrows\n [0-9]+ ;numcols\n\\( [0-9]+ ;numlocprn\n\\)?)\n\n"
- "Match Global parameters for .")
- (defconst ses-initial-file-trailer
- ";; Local Variables:\n;; mode: ses\n;; End:\n"
- "Initial contents for the file-trailer area at the bottom of the file.")
- (defconst ses-initial-file-contents
- (concat " \n" ; One blank cell in print area.
- ses-print-data-boundary
- "(ses-cell A1 nil nil nil nil)\n" ; One blank cell in data area.
- "\n" ; End-of-row terminator for the one row in data area.
- "(ses-column-widths [7])\n"
- "(ses-column-printers [nil])\n"
- "(ses-default-printer \"%.7g\")\n"
- "(ses-header-row 0)\n"
- ses-initial-global-parameters
- ses-initial-file-trailer)
- "The initial contents of an empty spreadsheet.")
- (defconst ses-box-prop '(:box (:line-width 2 :style released-button))
- "Display properties to create a raised box for cells in the header line.")
- (defconst ses-standard-printer-functions
- '(ses-center ses-center-span ses-dashfill ses-dashfill-span
- ses-tildefill-span)
- "List of print functions to be included in initial history of printer
- functions. None of these standard-printer functions is suitable for use as a
- column printer or a global-default printer because they invoke the column or
- default printer and then modify its output.")
- ;;----------------------------------------------------------------------------
- ;; Local variables and constants
- ;;----------------------------------------------------------------------------
- (eval-and-compile
- (defconst ses-localvars
- '(ses--blank-line ses--cells ses--col-printers
- ses--col-widths ses--curcell ses--curcell-overlay
- ses--default-printer
- (ses--local-printer-hashmap . :hashmap)
- (ses--numlocprn . 0); count of local printers
- ses--deferred-narrow ses--deferred-recalc
- ses--deferred-write ses--file-format
- ses--named-cell-hashmap
- (ses--header-hscroll . -1) ; Flag for "initial recalc needed"
- ses--header-row ses--header-string ses--linewidth
- ses--numcols ses--numrows ses--symbolic-formulas
- ses--data-marker ses--params-marker (ses--Dijkstra-attempt-nb . 0)
- ses--Dijkstra-weight-bound
- ;; This list is useful to speed-up clean-up of symbols when
- ;; an area containing renamed cell is deleted.
- ses--renamed-cell-symb-list
- ;; Global variables that we override
- next-line-add-newlines transient-mark-mode)
- "Buffer-local variables used by SES."))
- (defmacro ses--metaprogramming (exp) (declare (debug t)) (eval exp t))
- (ses--metaprogramming
- `(progn ,@(mapcar (lambda (x) `(defvar ,(or (car-safe x) x))) ses-localvars)))
- (defun ses-set-localvars ()
- "Set buffer-local and initialize some SES variables."
- (dolist (x ses-localvars)
- (cond
- ((symbolp x)
- (set (make-local-variable x) nil))
- ((consp x)
- (cond
- ((integerp (cdr x))
- (set (make-local-variable (car x)) (cdr x)))
- ((eq (cdr x) :hashmap)
- (set (make-local-variable (car x)) (make-hash-table :test 'eq)))
- (t (error "Unexpected initializer `%S' in list `ses-localvars' for entry %S"
- (cdr x) (car x)) ) ))
- (t (error "Unexpected elements `%S' in list `ses-localvars'" x)))))
- ;;; This variable is documented as being permitted in file-locals:
- (put 'ses--symbolic-formulas 'safe-local-variable 'consp)
- (defconst ses-paramlines-plist
- '(ses--col-widths -5 ses--col-printers -4 ses--default-printer -3
- ses--header-row -2 ses--file-format 1 ses--numrows 2
- ses--numcols 3 ses--numlocprn 4)
- "Offsets from 'Global parameters' line to various parameter lines in the
- data area of a spreadsheet.")
- (defconst ses-paramfmt-plist
- '(ses--col-widths "(ses-column-widths %S)"
- ses--col-printers "(ses-column-printers %S)"
- ses--default-printer "(ses-default-printer %S)"
- ses--header-row "(ses-header-row %S)"
- ses--file-format " %S ;SES file-format"
- ses--numrows " %S ;numrows"
- ses--numcols " %S ;numcols"
- ses--numlocprn " %S ;numlocprn")
- "Formats of 'Global parameters' various parameters in the data
- area of a spreadsheet.")
- ;;
- ;; "Side-effect variables". They are set in one function, altered in
- ;; another as a side effect, then read back by the first, as a way of
- ;; passing back more than one value. These declarations are just to make
- ;; the compiler happy, and to conform to standard Emacs-Lisp practice (I
- ;; think the make-local-variable trick above is cleaner).
- ;;
- (defvar ses-relocate-return nil
- "Set by `ses-relocate-formula' and `ses-relocate-range', read by
- `ses-relocate-all'. Set to 'delete if a cell-reference was deleted from a
- formula--so the formula needs recalculation. Set to 'range if the size of a
- `ses-range' was changed--so both the formula's value and list of dependents
- need to be recalculated.")
- (defvar ses-call-printer-return nil
- "Set to t if last cell printer invoked by `ses-call-printer' requested
- left-justification of the result. Set to error-signal if `ses-call-printer'
- encountered an error during printing. Otherwise nil.")
- (defvar ses-start-time nil
- "Time when current operation started. Used by `ses-time-check' to decide
- when to emit a progress message.")
- ;;----------------------------------------------------------------------------
- ;; Macros
- ;;----------------------------------------------------------------------------
- (defmacro ses-get-cell (row col)
- "Return the cell structure that stores information about cell (ROW,COL)."
- (declare (debug t))
- `(aref (aref ses--cells ,row) ,col))
- (cl-defstruct (ses-cell
- (:constructor nil)
- (:constructor ses-make-cell
- (&optional symbol formula printer references))
- (:copier nil)
- ;; This is treated as an 4-elem array in various places.
- ;; Mostly in ses-set-cell.
- (:type vector) ;Not named.
- (:conc-name ses-cell--))
- symbol formula printer references properties)
- (cl-defstruct (ses--locprn
- (:constructor)
- (:constructor ses-make-local-printer-info
- (def &optional (compiled (ses-local-printer-compile def))
- (number ses--numlocprn))))
- def
- compiled
- number
- local-printer-list)
- (defmacro ses-cell-symbol (row &optional col)
- "From a CELL or a pair (ROW,COL), get the symbol that names the local-variable holding its value. (0,0) => A1."
- (declare (debug t))
- `(ses-cell--symbol ,(if col `(ses-get-cell ,row ,col) row)))
- (put 'ses-cell-symbol 'safe-function t)
- (defmacro ses-cell-formula (row &optional col)
- "From a CELL or a pair (ROW,COL), get the function that computes its value."
- (declare (debug t))
- `(ses-cell--formula ,(if col `(ses-get-cell ,row ,col) row)))
- (defmacro ses-cell-printer (row &optional col)
- "From a CELL or a pair (ROW,COL), get the function that prints its value."
- (declare (debug t))
- `(ses-cell--printer ,(if col `(ses-get-cell ,row ,col) row)))
- (defmacro ses-cell-references (row &optional col)
- "From a CELL or a pair (ROW,COL), get the list of symbols for cells whose
- functions refer to its value."
- (declare (debug t))
- `(ses-cell--references ,(if col `(ses-get-cell ,row ,col) row)))
- (defmacro ses-sym-rowcol (sym)
- "From a cell-symbol SYM, gets the cons (row . col). A1 => (0 . 0). Result
- is nil if SYM is not a symbol that names a cell."
- (declare (debug t))
- `(let ((rc (and (symbolp ,sym) (get ,sym 'ses-cell))))
- (if (eq rc :ses-named)
- (gethash ,sym ses--named-cell-hashmap)
- rc)))
- (defun ses-cell-p (cell)
- "Return non-nil if CELL is a cell of current buffer."
- (and (vectorp cell)
- (= (length cell) 5)
- (eq cell (let ((rowcol (ses-sym-rowcol (ses-cell-symbol cell))))
- (and (consp rowcol)
- (ses-get-cell (car rowcol) (cdr rowcol)))))))
- (defmacro ses--letref (vars place &rest body)
- (declare (indent 2) (debug (sexp form &rest body)))
- (gv-letplace (getter setter) place
- `(cl-macrolet ((,(nth 0 vars) () ',getter)
- (,(nth 1 vars) (v) (funcall ',setter v)))
- ,@body)))
- (defmacro ses-cell-property (property-name row &optional col)
- "Get property named PROPERTY-NAME from a CELL or a pair (ROW,COL).
- When COL is omitted, CELL=ROW is a cell object. When COL is
- present ROW and COL are the integer coordinates of the cell of
- interest."
- (declare (debug t))
- `(alist-get ,property-name
- (ses-cell--properties
- ,(if col `(ses-get-cell ,row ,col) row))))
- (defmacro ses-cell-property-pop (property-name row &optional col)
- "From a CELL or a pair (ROW,COL), get and remove the property value of
- the corresponding cell with name PROPERTY-NAME."
- `(ses--letref (pget pset)
- (alist-get ,property-name
- (ses-cell--properties
- ,(if col `(ses-get-cell ,row ,col) row))
- nil t)
- (prog1 (pget) (pset nil))))
- (defmacro ses-cell-value (row &optional col)
- "From a CELL or a pair (ROW,COL), get the current value for that cell."
- (declare (debug t))
- `(symbol-value (ses-cell-symbol ,row ,col)))
- (defmacro ses-col-width (col)
- "Return the width for column COL."
- (declare (debug t))
- `(aref ses--col-widths ,col))
- (defmacro ses-col-printer (col)
- "Return the default printer for column COL."
- (declare (debug t))
- `(aref ses--col-printers ,col))
- (defun ses-is-cell-sym-p (sym)
- "Check whether SYM point at a cell of this spread sheet."
- (let ((rowcol (get sym 'ses-cell)))
- (and rowcol
- (if (eq rowcol :ses-named)
- (and ses--named-cell-hashmap (gethash sym ses--named-cell-hashmap))
- (and (< (car rowcol) ses--numrows)
- (< (cdr rowcol) ses--numcols)
- (eq (ses-cell-symbol (car rowcol) (cdr rowcol)) sym))))))
- (defun ses--cell (sym value formula printer references)
- "Load a cell SYM from the spreadsheet file. Does not recompute VALUE from
- FORMULA, does not reprint using PRINTER, does not check REFERENCES.
- Safety-checking for FORMULA and PRINTER are deferred until first use."
- (let ((rowcol (ses-sym-rowcol sym)))
- (ses-formula-record formula)
- (ses-printer-record printer)
- (unless (or formula (eq value '*skip*))
- (setq formula (macroexp-quote value)))
- (or (atom formula)
- (eq safe-functions t)
- (setq formula `(ses-safe-formula ,formula)))
- (or (not printer)
- (stringp printer)
- (eq safe-functions t)
- (setq printer `(ses-safe-printer ,printer)))
- (setf (ses-get-cell (car rowcol) (cdr rowcol))
- (ses-make-cell sym formula printer references)))
- (set sym value))
- (defun ses-local-printer-compile (printer)
- "Convert local printer function into faster printer
- definition."
- (cond
- ((functionp printer) printer)
- ((stringp printer)
- `(lambda (x) (format ,printer x)))
- (t (error "Invalid printer %S" printer))))
- (defun ses--local-printer (name def)
- "Define a local printer with name NAME and definition DEF.
- Return the printer info."
- (or
- (and (symbolp name)
- (ses-printer-validate def))
- (error "Invalid local printer definition"))
- (and (gethash name ses--local-printer-hashmap)
- (error "Duplicate printer definition %S" name))
- (add-to-list 'ses-read-printer-history (symbol-name name))
- (puthash name
- (ses-make-local-printer-info (ses-safe-printer def))
- ses--local-printer-hashmap))
- (defmacro ses-column-widths (widths)
- "Load the vector of column widths from the spreadsheet file. This is a
- macro to prevent propagate-on-load viruses."
- (or (and (vectorp widths) (= (length widths) ses--numcols))
- (error "Bad column-width vector"))
- ;;To save time later, we also calculate the total width of each line in the
- ;;print area (excluding the terminating newline)
- (setq ses--col-widths widths
- ses--linewidth (apply #'+ -1 (mapcar #'1+ widths))
- ses--blank-line (concat (make-string ses--linewidth ?\s) "\n"))
- t)
- (defmacro ses-column-printers (printers)
- "Load the vector of column printers from the spreadsheet file and checks
- them for safety. This is a macro to prevent propagate-on-load viruses."
- (or (and (vectorp printers) (= (length printers) ses--numcols))
- (error "Bad column-printers vector"))
- (dotimes (x ses--numcols)
- (aset printers x (ses-safe-printer (aref printers x))))
- (setq ses--col-printers printers)
- (mapc #'ses-printer-record printers)
- t)
- (defmacro ses-default-printer (def)
- "Load the global default printer from the spreadsheet file and checks it
- for safety. This is a macro to prevent propagate-on-load viruses."
- (setq ses--default-printer (ses-safe-printer def))
- (ses-printer-record def)
- t)
- (defmacro ses-header-row (row)
- "Load the header row from the spreadsheet file and checks it
- for safety. This is a macro to prevent propagate-on-load viruses."
- (or (and (wholenump row) (or (zerop ses--numrows) (< row ses--numrows)))
- (error "Bad header-row"))
- (setq ses--header-row row)
- t)
- (defmacro ses-dorange (curcell &rest body)
- "Execute BODY repeatedly, with the variables `row' and `col' set to each
- cell in the range specified by CURCELL. The range is available in the
- variables `minrow', `maxrow', `mincol', and `maxcol'."
- (declare (indent defun) (debug (form body)))
- (let ((cur (make-symbol "cur"))
- (min (make-symbol "min"))
- (max (make-symbol "max"))
- (r (make-symbol "r"))
- (c (make-symbol "c")))
- `(let* ((,cur ,curcell)
- (,min (ses-sym-rowcol (if (consp ,cur) (car ,cur) ,cur)))
- (,max (ses-sym-rowcol (if (consp ,cur) (cdr ,cur) ,cur))))
- (let ((minrow (car ,min))
- (maxrow (car ,max))
- (mincol (cdr ,min))
- (maxcol (cdr ,max)))
- (if (or (> minrow maxrow) (> mincol maxcol))
- (error "Empty range"))
- (dotimes (,r (- maxrow minrow -1))
- (let ((row (+ ,r minrow)))
- (dotimes (,c (- maxcol mincol -1))
- (let ((col (+ ,c mincol)))
- ,@body))))))))
- ;;Support for coverage testing.
- (defmacro 1value (form)
- "For code-coverage testing, indicate that FORM is expected to always have
- the same value."
- (declare (debug t))
- form)
- (defmacro noreturn (form)
- "For code-coverage testing, indicate that FORM will always signal an error."
- (declare (debug t))
- form)
- ;;----------------------------------------------------------------------------
- ;; Utility functions
- ;;----------------------------------------------------------------------------
- (defun ses-vector-insert (array idx new)
- "Create a new vector which is one larger than ARRAY and has NEW inserted
- before element IDX."
- (let* ((len (length array))
- (result (make-vector (1+ len) new)))
- (dotimes (x len)
- (aset result
- (if (< x idx) x (1+ x))
- (aref array x)))
- result))
- ;;Allow ARRAY to be a symbol for use in buffer-undo-list
- (defun ses-vector-delete (array idx count)
- "Create a new vector which is a copy of ARRAY with COUNT objects removed
- starting at element IDX. ARRAY is either a vector or a symbol whose value
- is a vector--if a symbol, the new vector is assigned as the symbol's value."
- (let* ((a (if (arrayp array) array (symbol-value array)))
- (len (- (length a) count))
- (result (make-vector len nil)))
- (dotimes (x len)
- (aset result x (aref a (if (< x idx) x (+ x count)))))
- (if (symbolp array)
- (set array result))
- result))
- (defun ses-delete-line (count)
- "Like `kill-line', but no kill ring."
- (let ((pos (point)))
- (forward-line count)
- (delete-region pos (point))))
- (defun ses-printer-validate (printer)
- "Signal an error if PRINTER is not a valid SES cell printer."
- (or (not printer)
- (stringp printer)
- ;; printer is a local printer
- (and (symbolp printer) (gethash printer ses--local-printer-hashmap))
- (functionp printer)
- (and (stringp (car-safe printer)) (not (cdr printer)))
- (error "Invalid printer function %S" printer))
- printer)
- (defun ses-printer-record (printer)
- "Add PRINTER to `ses-read-printer-history' if not already there, after first
- checking that it is a valid printer function."
- (ses-printer-validate printer)
- ;;To speed things up, we avoid calling prin1 for the very common "nil" case.
- (if printer
- (add-to-list 'ses-read-printer-history (prin1-to-string printer))))
- (defun ses-formula-record (formula)
- "If FORMULA is of the form 'symbol, add it to the list of symbolic formulas
- for this spreadsheet."
- (when (and (eq (car-safe formula) 'quote)
- (symbolp (cadr formula)))
- (add-to-list 'ses--symbolic-formulas
- (list (symbol-name (cadr formula))))))
- (defun ses-column-letter (col)
- "Return the alphabetic name of column number COL.
- 0-25 become A-Z; 26-701 become AA-ZZ, and so on."
- (let ((units (char-to-string (+ ?A (% col 26)))))
- (if (< col 26)
- units
- (concat (ses-column-letter (1- (/ col 26))) units))))
- (defun ses-create-cell-symbol (row col)
- "Produce a symbol that names the cell (ROW,COL). (0,0) => 'A1."
- (intern (concat (ses-column-letter col) (number-to-string (1+ row)))))
- (defun ses-decode-cell-symbol (str)
- "Decode a symbol \"A1\" => (0,0). Return nil if STR is not a
- canonical cell name."
- (let (case-fold-search)
- (and (string-match "\\`\\([A-Z]+\\)\\([0-9]+\\)\\'" str)
- (let* ((col-str (match-string-no-properties 1 str))
- (col 0)
- (col-base 1)
- (col-idx (1- (length col-str)))
- (row (1- (string-to-number
- (match-string-no-properties 2 str)))))
- (and (>= row 0)
- (progn
- (while
- (progn
- (setq col (+ col (* (- (aref col-str col-idx) ?A)
- col-base))
- col-base (* col-base 26)
- col-idx (1- col-idx))
- (and (>= col-idx 0)
- (setq col (+ col col-base)))))
- (cons row col)))))))
- (defun ses-create-cell-variable-range (minrow maxrow mincol maxcol)
- "Create buffer-local variables for cells. This is undoable."
- (push `(apply ses-destroy-cell-variable-range ,minrow ,maxrow ,mincol ,maxcol)
- buffer-undo-list)
- (let (sym xrow xcol)
- (dotimes (row (1+ (- maxrow minrow)))
- (dotimes (col (1+ (- maxcol mincol)))
- (setq xrow (+ row minrow)
- xcol (+ col mincol)
- sym (ses-create-cell-symbol xrow xcol))
- (put sym 'ses-cell (cons xrow xcol))
- (make-local-variable sym)))))
- (defun ses-create-cell-variable (sym row col)
- "Create a buffer-local variable `SYM' for cell at position (ROW, COL).
- SYM is the symbol for that variable, ROW and COL are integers for
- row and column of the cell, with numbering starting from 0.
- Return nil in case of failure."
- (unless (local-variable-p sym)
- (make-local-variable sym)
- (if (let (case-fold-search) (string-match-p "\\`[A-Z]+[0-9]+\\'" (symbol-name sym)))
- (put sym 'ses-cell (cons row col))
- (put sym 'ses-cell :ses-named)
- (setq ses--named-cell-hashmap (or ses--named-cell-hashmap (make-hash-table :test 'eq)))
- (puthash sym (cons row col) ses--named-cell-hashmap))))
- ;; We do not delete the ses-cell properties for the cell-variables, in
- ;; case a formula that refers to this cell is in the kill-ring and is
- ;; later pasted back in.
- (defun ses-destroy-cell-variable-range (minrow maxrow mincol maxcol)
- "Destroy buffer-local variables for cells. This is undoable."
- (let (sym)
- (dotimes (row (1+ (- maxrow minrow)))
- (dotimes (col (1+ (- maxcol mincol)))
- (let ((xrow (+ row minrow)) (xcol (+ col mincol)))
- (setq sym (if (and (< xrow ses--numrows) (< xcol ses--numcols))
- (ses-cell-symbol xrow xcol)
- (ses-create-cell-symbol xrow xcol))))
- (if (boundp sym)
- (push `(apply ses-set-with-undo ,sym ,(symbol-value sym))
- buffer-undo-list))
- (kill-local-variable sym))))
- (push `(apply ses-create-cell-variable-range ,minrow ,maxrow ,mincol ,maxcol)
- buffer-undo-list))
- (defun ses-reset-header-string ()
- "Flag the header string for update. Upon undo, the header string will be
- updated again."
- (push '(apply ses-reset-header-string) buffer-undo-list)
- (setq ses--header-hscroll -1))
- ;;Split this code off into a function to avoid coverage-testing difficulties
- (defmacro ses--time-check (format &rest args)
- "If `ses-start-time' is more than a second ago, call `message' with FORMAT
- and ARGS and reset `ses-start-time' to the current time."
- `(when (> (- (float-time) ses-start-time) 1.0)
- (message ,format ,@args)
- (setq ses-start-time (float-time))))
- ;;----------------------------------------------------------------------------
- ;; The cells
- ;;----------------------------------------------------------------------------
- (defmacro ses-set-cell (row col field val)
- "Install VAL as the contents for field FIELD (named by a quoted symbol) of
- cell (ROW,COL). This is undoable. The cell's data will be updated through
- `post-command-hook'."
- `(let ((row ,row)
- (col ,col)
- (val ,val))
- (let* ((cell (ses-get-cell row col))
- (change
- ,(let ((field (progn (cl-assert (eq (car field) 'quote))
- (cadr field))))
- (if (eq field 'value)
- `(ses-set-with-undo (ses-cell-symbol cell) val)
- ;; (let* ((slots (get 'ses-cell 'cl-struct-slots))
- ;; (slot (or (assq field slots)
- ;; (error "Unknown field %S" field)))
- ;; (idx (- (length slots)
- ;; (length (memq slot slots)))))
- ;; `(ses-aset-with-undo cell ,idx val))
- (let ((getter (intern-soft (format "ses-cell--%s" field))))
- `(ses-setter-with-undo
- (eval-when-compile
- (cons #',getter
- (lambda (newval cell)
- (setf (,getter cell) newval))))
- val cell))))))
- (if change
- (add-to-list 'ses--deferred-write (cons row col))))
- nil)) ; Make coverage-tester happy.
- (defun ses-cell-set-formula (row col formula)
- "Store a new formula for (ROW . COL) and enqueue the cell for
- recalculation via `post-command-hook'. Updates the reference lists for the
- cells that this cell refers to. Does not update cell value or reprint the
- cell. To avoid inconsistencies, this function is not interruptible, which
- means Emacs will crash if FORMULA contains a circular list."
- (let* ((cell (ses-get-cell row col))
- (old (ses-cell-formula cell)))
- (let ((sym (ses-cell-symbol cell))
- (oldref (ses-formula-references old))
- (newref (ses-formula-references formula))
- (inhibit-quit t)
- x xrow xcol)
- (cl-pushnew sym ses--deferred-recalc)
- ;;Delete old references from this cell. Skip the ones that are also
- ;;in the new list.
- (dolist (ref oldref)
- (unless (memq ref newref)
- (setq x (ses-sym-rowcol ref)
- xrow (car x)
- xcol (cdr x))
- (ses-set-cell xrow xcol 'references
- (delq sym (ses-cell-references xrow xcol)))))
- ;;Add new ones. Skip ones left over from old list
- (dolist (ref newref)
- (setq x (ses-sym-rowcol ref)
- xrow (car x)
- xcol (cdr x)
- x (ses-cell-references xrow xcol))
- (or (memq sym x)
- (ses-set-cell xrow xcol 'references (cons sym x))))
- (ses-formula-record formula)
- (ses-set-cell row col 'formula formula))))
- (defun ses-repair-cell-reference-all ()
- "Repair cell reference and warn if there was some reference corruption."
- (interactive "*")
- (let (errors)
- ;; Step 1, reset :ses-repair-reference cell property in the whole sheet.
- (dotimes (row ses--numrows)
- (dotimes (col ses--numcols)
- (let ((references (ses-cell-property-pop :ses-repair-reference
- row col)))
- (when references
- (push (list (ses-cell-symbol row col)
- :corrupt-property
- references)
- errors)))))
- ;; Step 2, build new.
- (dotimes (row ses--numrows)
- (dotimes (col ses--numcols)
- (let* ((cell (ses-get-cell row col))
- (sym (ses-cell-symbol cell))
- (formula (ses-cell-formula cell))
- (new-ref (ses-formula-references formula)))
- (dolist (ref new-ref)
- (let ((rowcol (ses-sym-rowcol ref)))
- (cl-pushnew sym (ses-cell-property :ses-repair-reference
- (car rowcol)
- (cdr rowcol))))))))
- ;; Step 3, overwrite with check.
- (dotimes (row ses--numrows)
- (dotimes (col ses--numcols)
- (let* ((cell (ses-get-cell row col))
- (irrelevant (ses-cell-references cell))
- (new-ref (ses-cell-property-pop :ses-repair-reference cell))
- missing)
- (dolist (ref new-ref)
- (if (memq ref irrelevant)
- (setq irrelevant (delq ref irrelevant))
- (push ref missing)))
- (ses-set-cell row col 'references new-ref)
- (when (or missing irrelevant)
- (push `( ,(ses-cell-symbol cell)
- ,@(and missing (list :missing missing))
- ,@(and irrelevant (list :irrelevant irrelevant)))
- errors)))))
- (if errors
- (warn "----------------------------------------------------------------
- Some references were corrupted.
- The following is a list where each element ELT is such
- that (car ELT) is the reference of cell CELL with corruption,
- and (cdr ELT) is a property list where
- * property `:corrupt-property' means that
- property `:ses-repair-reference' of cell CELL was initially non
- nil,
- * property `:missing' is a list of missing references
- * property `:irrelevant' is a list of non needed references
- %S" errors)
- (message "No reference corruption found"))))
- (defun ses-calculate-cell (row col force)
- "Calculate and print the value for cell (ROW,COL) using the cell's formula
- function and print functions, if any. Result is nil for normal operation, or
- the error signal if the formula or print function failed. The old value is
- left unchanged if it was *skip* and the new value is nil.
- Any cells that depend on this cell are queued for update after the end of
- processing for the current keystroke, unless the new value is the same as
- the old and FORCE is nil."
- (let ((cell (ses-get-cell row col))
- cycle-error formula-error printer-error)
- (let ((oldval (ses-cell-value cell))
- (formula (ses-cell-formula cell))
- newval
- this-cell-Dijkstra-attempt+1)
- (when (eq (car-safe formula) 'ses-safe-formula)
- (setq formula (ses-safe-formula (cadr formula)))
- (ses-set-cell row col 'formula formula))
- (condition-case sig
- (setq newval (eval formula t))
- (error
- ;; Variable `sig' can't be nil.
- (nconc sig (list (ses-cell-symbol cell)))
- (setq formula-error sig
- newval '*error*)))
- (if (and (not newval) (eq oldval '*skip*))
- ;; Don't lose the *skip* --- previous field spans this one.
- (setq newval '*skip*))
- (catch 'cycle
- (when (or force (not (eq newval oldval)))
- (cl-pushnew (cons row col) ses--deferred-write :test #'equal) ; In case force=t.
- (ses--letref (pget pset)
- (ses-cell-property :ses-Dijkstra-attempt cell)
- (let ((this-cell-Dijkstra-attempt (pget)))
- (if (null this-cell-Dijkstra-attempt)
- (pset
- (setq this-cell-Dijkstra-attempt
- (cons ses--Dijkstra-attempt-nb 0)))
- (unless (= ses--Dijkstra-attempt-nb
- (car this-cell-Dijkstra-attempt))
- (setcar this-cell-Dijkstra-attempt ses--Dijkstra-attempt-nb)
- (setcdr this-cell-Dijkstra-attempt 0)))
- (setq this-cell-Dijkstra-attempt+1
- (1+ (cdr this-cell-Dijkstra-attempt)))))
- (ses-set-cell row col 'value newval)
- (dolist (ref (ses-cell-references cell))
- (cl-pushnew ref ses--deferred-recalc)
- (ses--letref (pget pset)
- (let ((ref-rowcol (ses-sym-rowcol ref)))
- (ses-cell-property
- :ses-Dijkstra-attempt
- (car ref-rowcol) (cdr ref-rowcol)))
- (let ((ref-cell-Dijkstra-attempt (pget)))
- (if (null ref-cell-Dijkstra-attempt)
- (pset
- (setq ref-cell-Dijkstra-attempt
- (cons ses--Dijkstra-attempt-nb
- this-cell-Dijkstra-attempt+1)))
- (if (= (car ref-cell-Dijkstra-attempt) ses--Dijkstra-attempt-nb)
- (setcdr ref-cell-Dijkstra-attempt
- (max (cdr ref-cell-Dijkstra-attempt)
- this-cell-Dijkstra-attempt+1))
- (setcar ref-cell-Dijkstra-attempt ses--Dijkstra-attempt-nb)
- (setcdr ref-cell-Dijkstra-attempt
- this-cell-Dijkstra-attempt+1)))))
- (when (> this-cell-Dijkstra-attempt+1 ses--Dijkstra-weight-bound)
- ;; Update print of this cell.
- (throw 'cycle (setq formula-error
- `(error ,(format "Found cycle on cells %S"
- (ses-cell-symbol cell)))
- cycle-error formula-error)))))))
- (setq printer-error (ses-print-cell row col))
- (or
- (and cycle-error
- (error (error-message-string cycle-error)))
- formula-error printer-error)))
- (defun ses-clear-cell (row col)
- "Delete formula and printer for cell (ROW,COL)."
- (ses-set-cell row col 'printer nil)
- (ses-cell-set-formula row col nil))
- (defcustom ses-self-reference-early-detection nil
- "True if cycle detection is early for cells that refer to themselves."
- :version "24.1"
- :type 'boolean
- :group 'ses)
- (defun ses-update-cells (list &optional force)
- "Recalculate cells in LIST, checking for dependency loops. Prints
- progress messages every second. Dependent cells are not recalculated
- if the cell's value is unchanged and FORCE is nil."
- (let ((ses--deferred-recalc list)
- (nextlist list)
- (pos (point))
- curlist prevlist this-sym this-rowcol formula)
- (with-temp-message " "
- (while ses--deferred-recalc
- ;; In each loop, recalculate cells that refer only to other cells that
- ;; have already been recalculated or aren't in the recalculation region.
- ;; Repeat until all cells have been processed or until the set of cells
- ;; being worked on stops changing.
- (if prevlist
- (message "Recalculating... (%d cells left)"
- (length ses--deferred-recalc)))
- (setq curlist ses--deferred-recalc
- ses--deferred-recalc nil
- prevlist nextlist)
- (while curlist
- ;; this-sym has to be popped from curlist *BEFORE* the check, and not
- ;; after because of the case of cells referring to themselves.
- (setq this-sym (pop curlist)
- this-rowcol (ses-sym-rowcol this-sym)
- formula (ses-cell-formula (car this-rowcol)
- (cdr this-rowcol)))
- (or (catch 'ref
- (dolist (ref (ses-formula-references formula))
- (if (and ses-self-reference-early-detection (eq ref this-sym))
- (error "Cycle found: cell %S is self-referring" this-sym)
- (when (or (memq ref curlist)
- (memq ref ses--deferred-recalc))
- ;; This cell refers to another that isn't done yet
- (cl-pushnew this-sym ses--deferred-recalc :test #'equal)
- (throw 'ref t)))))
- ;; ses-update-cells is called from post-command-hook, so
- ;; inhibit-quit is implicitly bound to t.
- (when quit-flag
- ;; Abort the recalculation. User will probably undo now.
- (error "Quit"))
- (ses-calculate-cell (car this-rowcol) (cdr this-rowcol) force)))
- (dolist (ref ses--deferred-recalc)
- (cl-pushnew ref nextlist :test #'equal)))
- (when ses--deferred-recalc
- ;; Just couldn't finish these.
- (dolist (x ses--deferred-recalc)
- (let ((this-rowcol (ses-sym-rowcol x)))
- (ses-set-cell (car this-rowcol) (cdr this-rowcol) 'value '*error*)
- (1value (ses-print-cell (car this-rowcol) (cdr this-rowcol)))))
- (error "Circular references: %s" ses--deferred-recalc))
- (message " "))
- ;; Can't use save-excursion here: if the cell under point is updated,
- ;; save-excursion's marker will move past the cell.
- (goto-char pos)))
- ;;----------------------------------------------------------------------------
- ;; The print area
- ;;----------------------------------------------------------------------------
- (defun ses-in-print-area ()
- "Return t if point is in print area of spreadsheet."
- (<= (point) ses--data-marker))
- ;; We turn off point-motion-hooks and explicitly position the cursor, in case
- ;; the intangible properties have gotten screwed up (e.g., when ses-goto-print
- ;; is called during a recursive ses-print-cell).
- (defun ses-goto-print (row col)
- "Move point to print area for cell (ROW,COL)."
- (let ((n 0))
- (goto-char (point-min))
- (forward-line row)
- ;; Calculate column position.
- (dotimes (c col)
- (setq n (+ n (ses-col-width c) 1)))
- ;; Move to the position.
- (and (> n (move-to-column n))
- (eolp)
- ;; Move point to the bol of next line (for TAB at the last cell).
- (forward-char))))
- (defun ses--cell-at-pos (pos &optional object)
- (or (get-text-property pos 'cursor-intangible object)
- ;; (when (> pos (if object 0 (point-min)))
- ;; (get-text-property (1- pos) 'cursor-intangible object))
- ))
- (defun ses--curcell (&optional pos)
- "Return the current cell symbol, or a cons (BEG,END) for a
- region, or nil if cursor is not at a cell."
- (unless pos (setq pos (point)))
- (if (or (not mark-active)
- deactivate-mark
- (= pos (mark t)))
- ;; Single cell.
- (ses--cell-at-pos pos)
- ;; Range.
- (let* ((re (max pos (mark t)))
- (bcell (ses--cell-at-pos (min pos (mark t))))
- (ecell (ses--cell-at-pos (1- re))))
- (when (= re ses--data-marker)
- ;; Correct for overflow.
- (setq ecell (ses--cell-at-pos (- (region-end) 2))))
- (if (and bcell ecell)
- (cons bcell ecell)
- nil))))
- (defun ses-set-curcell ()
- "Set `ses--curcell' to the current cell symbol, or a cons (BEG,END) for a
- region, or nil if cursor is not at a cell."
- (setq ses--curcell (ses--curcell))
- nil)
- (defun ses-check-curcell (&rest args)
- "Signal an error if `ses--curcell' is inappropriate.
- The end marker is appropriate if some argument is 'end.
- A range is appropriate if some argument is 'range.
- A single cell is appropriate unless some argument is 'needrange."
- (if (eq ses--curcell t)
- ;; curcell recalculation was postponed, but user typed ahead.
- (ses-set-curcell))
- (cond
- ((not ses--curcell)
- (or (memq 'end args)
- (error "Not at cell")))
- ((consp ses--curcell)
- (or (memq 'range args)
- (memq 'needrange args)
- (error "Can't use a range")))
- ((memq 'needrange args)
- (error "Need a range"))))
- (defvar ses--row)
- (defvar ses--col)
- (defun ses-print-cell (row col)
- "Format and print the value of cell (ROW,COL) to the print area.
- Use the cell's printer function. If the cell's new print form is too wide,
- it will spill over into the following cell, but will not run off the end of the
- row or overwrite the next non-nil field. Result is nil for normal operation,
- or the error signal if the printer function failed and the cell was formatted
- with \"%s\". If the cell's value is *skip*, nothing is printed because the
- preceding cell has spilled over."
- (catch 'ses-print-cell
- (let* ((cell (ses-get-cell row col))
- (value (ses-cell-value cell))
- (printer (ses-cell-printer cell))
- (maxcol (1+ col))
- text sig startpos x)
- ;; Create the string to print.
- (cond
- ((eq value '*skip*)
- ;; Don't print anything.
- (throw 'ses-print-cell nil))
- ((eq value '*error*)
- (setq text (make-string (ses-col-width col) ?#)))
- (t
- ;; Deferred safety-check on printer.
- (if (eq (car-safe printer) 'ses-safe-printer)
- (ses-set-cell row col 'printer
- (setq printer (ses-safe-printer (cadr printer)))))
- ;; Print the value.
- (setq text
- (let ((ses--row row)
- (ses--col col))
- (ses-call-printer (or printer
- (ses-col-printer col)
- ses--default-printer)
- value)))
- (if (consp ses-call-printer-return)
- ;; Printer returned an error.
- (setq sig ses-call-printer-return))))
- ;; Adjust print width to match column width.
- (let ((width (ses-col-width col))
- (len (string-width text)))
- (cond
- ((< len width)
- ;; Fill field to length with spaces.
- (setq len (make-string (- width len) ?\s)
- text (if (or (stringp value)
- (eq ses-call-printer-return t))
- (concat text len)
- (concat len text))))
- ((> len width)
- ;; Spill over into following cells, if possible.
- (let ((maxwidth width))
- (while (and (> len maxwidth)
- (< maxcol ses--numcols)
- (or (not (setq x (ses-cell-value row maxcol)))
- (eq x '*skip*)))
- (unless x
- ;; Set this cell to '*skip* so it won't overwrite our spillover.
- (ses-set-cell row maxcol 'value '*skip*))
- (setq maxwidth (+ maxwidth (ses-col-width maxcol) 1)
- maxcol (1+ maxcol)))
- (if (<= len maxwidth)
- ;; Fill to complete width of all the fields spanned.
- (setq text (concat text (make-string (- maxwidth len) ?\s)))
- ;; Not enough room to end of line or next non-nil field. Truncate
- ;; if string or decimal; otherwise fill with error indicator.
- (setq sig `(error "Too wide" ,text))
- (cond
- ((stringp value)
- (setq text (truncate-string-to-width text maxwidth 0 ?\s)))
- ((and (numberp value)
- (string-match "\\.[0-9]+" text)
- (>= 0 (setq width
- (- len maxwidth
- (- (match-end 0) (match-beginning 0))))))
- ;; Turn 6.6666666666e+49 into 6.66e+49. Rounding is too hard!
- (setq text (concat (substring text
- 0
- (- (match-beginning 0) width))
- (substring text (match-end 0)))))
- (t
- (setq text (make-string maxwidth ?#)))))))))
- ;; Substitute question marks for tabs and newlines. Newlines are used as
- ;; row-separators; tabs could confuse the reimport logic.
- (setq text (replace-regexp-in-string "[\t\n]" "?" text))
- (ses-goto-print row col)
- (setq startpos (point))
- ;; Install the printed result. This is not interruptible.
- (let ((inhibit-read-only t)
- (inhibit-quit t))
- (delete-region (point) (progn
- (move-to-column (+ (current-column)
- (string-width text)))
- (1+ (point))))
- ;; We use concat instead of inserting separate strings in order to
- ;; reduce the number of cells in the undo list.
- (setq x (concat text (if (< maxcol ses--numcols) " " "\n")))
- ;; We use set-text-properties to prevent a wacky print function from
- ;; inserting rogue properties, and to ensure that the keymap property is
- ;; inherited (is it a bug that only unpropertized strings actually
- ;; inherit from surrounding text?)
- (set-text-properties 0 (length x) nil x)
- (insert-and-inherit x)
- (put-text-property startpos (point) 'cursor-intangible
- (ses-cell-symbol cell))
- (when (and (zerop row) (zerop col))
- ;; Reconstruct special beginning-of-buffer attributes.
- (put-text-property (point-min) (point) 'keymap 'ses-mode-print-map)
- (put-text-property (point-min) (point) 'read-only 'ses)
- (put-text-property (point-min) (1+ (point-min))
- ;; `cursor-intangible' shouldn't be sticky at BOB.
- 'front-sticky '(read-only keymap))))
- (if (= row (1- ses--header-row))
- ;; This line is part of the header --- force recalc.
- (ses-reset-header-string))
- ;; If this cell (or a preceding one on the line) previously spilled over
- ;; and has gotten shorter, redraw following cells on line recursively.
- (when (and (< maxcol ses--numcols)
- (eq (ses-cell-value row maxcol) '*skip*))
- (ses-set-cell row maxcol 'value nil)
- (ses-print-cell row maxcol))
- ;; Return to start of cell.
- (goto-char startpos)
- sig)))
- (defun ses-call-printer (printer &optional value)
- "Invoke PRINTER (a string or parenthesized string or function-symbol or
- lambda of one argument) on VALUE. Result is the printed cell as a string.
- The variable `ses-call-printer-return' is set to t if the printer used
- parenthesis to request left-justification, or the error-signal if the
- printer signaled one (and \"%s\" is used as the default printer), else nil."
- (setq ses-call-printer-return nil)
- (condition-case signal
- (cond
- ((stringp printer)
- (if value
- (format printer value)
- ""))
- ((stringp (car-safe printer))
- (setq ses-call-printer-return t)
- (if value
- (format (car printer) value)
- ""))
- (t
- (setq value
- (funcall
- (or (and (symbolp printer)
- (let ((locprn (gethash printer
- ses--local-printer-hashmap)))
- (and locprn
- (ses--locprn-compiled locprn))))
- printer)
- (or value "")))
- (if (stringp value)
- value
- (or (stringp (car-safe value))
- (error "Printer should return \"string\" or (\"string\")"))
- (setq ses-call-printer-return t)
- (car value))))
- (error
- (setq ses-call-printer-return signal)
- (prin1-to-string value t))))
- (defun ses-adjust-print-width (col change)
- "Insert CHANGE spaces in front of column COL, or at end of line if
- COL=NUMCOLS. Deletes characters if CHANGE < 0. Caller should bind
- `inhibit-quit' to t."
- (let ((inhibit-read-only t)
- (blank (if (> change 0) (make-string change ?\s)))
- (at-end (= col ses--numcols)))
- (ses-set-with-undo 'ses--linewidth (+ ses--linewidth change))
- ;; ses-set-with-undo always returns t for strings.
- (1value (ses-set-with-undo 'ses--blank-line
- (concat (make-string ses--linewidth ?\s) "\n")))
- (dotimes (row ses--numrows)
- (ses-goto-print row col)
- (when at-end
- ;; Insert new columns before newline.
- (backward-char 1))
- (if blank
- (insert blank)
- (delete-char (- change))))))
- (defun ses-print-cell-new-width (row col)
- "Same as `ses-print-cell', except if the cell's value is *skip*,
- the preceding nonskipped cell is reprinted. This function is used
- when the width of cell (ROW,COL) has changed."
- (if (not (eq (ses-cell-value row col) '*skip*))
- (ses-print-cell row col)
- ;;Cell was skipped over - reprint previous
- (ses-goto-print row col)
- (backward-char 1)
- (let ((rowcol (ses-sym-rowcol (ses--cell-at-pos (point)))))
- (ses-print-cell (car rowcol) (cdr rowcol)))))
- ;;----------------------------------------------------------------------------
- ;; The data area
- ;;----------------------------------------------------------------------------
- (defun ses-widen ()
- "Turn off narrowing, to be reenabled at end of command loop."
- (if (buffer-narrowed-p)
- (setq ses--deferred-narrow t))
- (widen))
- (defun ses-goto-data (def &optional col)
- "Move point to data area for (DEF,COL). If DEF is a row
- number, COL is the column number for a data cell -- otherwise DEF
- is one of the symbols ses--col-widths, ses--col-printers,
- ses--default-printer, ses--numrows, or ses--numcols."
- (ses-widen)
- (if col
- ;; It's a cell.
- (progn
- (goto-char ses--data-marker)
- (forward-line (+ 1 (* def (1+ ses--numcols)) col)))
- ;; Convert def-symbol to offset.
- (setq def (plist-get ses-paramlines-plist def))
- (or def (signal 'args-out-of-range nil))
- (goto-char ses--params-marker)
- (forward-line def)))
- (defun ses-file-format-extend-parameter-list (new-file-format)
- "Extend the global parameters list when file format is updated
- from 2 to 3. This happens when local printer function are added
- to a sheet that was created with SES version 2. This is not
- undoable. Return nil when there was no change, and non nil otherwise."
- (save-excursion
- (cond
- ((and (= ses--file-format 2) (= 3 new-file-format))
- (ses-set-parameter 'ses--file-format 3)
- (message "Upgrading from SES-2 to SES-3 file format")
- (ses-widen)
- (goto-char ses--params-marker)
- (forward-line (plist-get ses-paramlines-plist 'ses--numlocprn ))
- (insert (format (plist-get ses-paramfmt-plist 'ses--numlocprn)
- ses--numlocprn)
- ?\n)
- t) )))
- (defun ses-set-parameter (def value &optional elem)
- "Set parameter DEF to VALUE (with undo) and write the value to the data area.
- See `ses-goto-data' for meaning of DEF. Newlines in the data are escaped.
- If ELEM is specified, it is the array subscript within DEF to be set to VALUE."
- (save-excursion
- ;; We call ses-goto-data early, using the old values of numrows and numcols
- ;; in case one of them is being changed.
- (ses-goto-data def)
- (let ((inhibit-read-only t)
- (fmt (plist-get ses-paramfmt-plist
- def))
- oldval)
- (if elem
- (progn
- (setq oldval (aref (symbol-value def) elem))
- (aset (symbol-value def) elem value))
- (setq oldval (symbol-value def))
- (set def value))
- ;; Special undo since it's outside the narrowed buffer.
- (let (buffer-undo-list)
- (delete-region (point) (line-end-position))
- (insert (format fmt (symbol-value def))))
- (push `(apply ses-set-parameter ,def ,oldval ,elem) buffer-undo-list))))
- (defun ses-write-cells ()
- "Write cells in `ses--deferred-write' from local variables to data area.
- Newlines in the data are escaped."
- (let* ((inhibit-read-only t)
- (print-escape-newlines t)
- rowcol row col cell sym formula printer text)
- (setq ses-start-time (float-time))
- (with-temp-message " "
- (save-excursion
- (while ses--deferred-write
- (ses--time-check "Writing... (%d cells left)"
- (length ses--deferred-write))
- (setq rowcol (pop ses--deferred-write)
- row (car rowcol)
- col (cdr rowcol)
- cell (ses-get-cell row col)
- sym (ses-cell-symbol cell)
- formula (ses-cell-formula cell)
- printer (ses-cell-printer cell))
- (if (eq (car-safe formula) 'ses-safe-formula)
- (setq formula (cadr formula)))
- (if (eq (car-safe printer) 'ses-safe-printer)
- (setq printer (cadr printer)))
- (setq text (prin1-to-string
- ;; We could shorten it to (ses-cell SYM VAL) when
- ;; the other parameters are nil, but in practice most
- ;; cells have non-nil `references', so it's
- ;; rather pointless.
- `(ses-cell ,sym
- ,(symbol-value sym)
- ,(unless (equal formula (symbol-value sym))
- formula)
- ,printer
- ,(ses-cell-references cell))))
- (ses-goto-data row col)
- (delete-region (point) (line-end-position))
- (insert text)))
- (message " "))))
- ;;----------------------------------------------------------------------------
- ;; Formula relocation
- ;;----------------------------------------------------------------------------
- (defun ses-formula-references (formula &optional result-so-far)
- "Produce a list of symbols for cells that this FORMULA's value
- refers to. For recursive calls, RESULT-SO-FAR is the list being
- constructed, or t to get a wrong-type-argument error when the
- first reference is found."
- (if (ses-sym-rowcol formula)
- ;; Entire formula is one symbol.
- (cl-pushnew formula result-so-far :test #'equal)
- (if (consp formula)
- (cond
- ((eq (car formula) 'ses-range)
- (dolist (cur
- (cdr (funcall 'macroexpand
- (list 'ses-range (nth 1 formula)
- (nth 2 formula)))))
- (cl-pushnew cur result-so-far :test #'equal)))
- ((null (eq (car formula) 'quote))
- ;;Recursive call for subformulas
- (dolist (cur formula)
- (setq result-so-far (ses-formula-references cur result-so-far))))
- (t
- ;;Ignore other stuff
- ))
- ;; other type of atom are ignored
- ))
- result-so-far)
- (defsubst ses-relocate-symbol (sym rowcol startrow startcol rowincr colincr)
- "Relocate one symbol SYM, which corresponds to ROWCOL (a cons of ROW and
- COL). Cells starting at (STARTROW,STARTCOL) are being shifted
- by (ROWINCR,COLINCR)."
- (let ((row (car rowcol))
- (col (cdr rowcol)))
- (if (or (< row startrow) (< col startcol))
- sym
- (setq row (+ row rowincr)
- col (+ col colincr))
- (if (and (>= row startrow) (>= col startcol)
- (< row ses--numrows) (< col ses--numcols))
- ;;Relocate this variable
- (ses-create-cell-symbol row col)
- ;;Delete reference to a deleted cell
- nil))))
- (defun ses-relocate-formula (formula startrow startcol rowincr colincr)
- "Produce a copy of FORMULA where all symbols that refer to cells in row
- STARTROW or above, and col STARTCOL or above, are altered by adding ROWINCR
- and COLINCR. STARTROW and STARTCOL are 0-based. Example:
- (ses-relocate-formula '(+ A1 B2 D3) 1 2 1 -1)
- => (+ A1 B2 C4)
- If ROWINCR or COLINCR is negative, references to cells being deleted are
- removed. Example:
- (ses-relocate-formula '(+ A1 B2 D3) 0 1 0 -1)
- => (+ A1 C3)
- Sets `ses-relocate-return' to 'delete if cell-references were removed."
- (let (rowcol result)
- (if (or (atom formula) (eq (car formula) 'quote))
- (if (and (setq rowcol (ses-sym-rowcol formula))
- (string-match-p "\\`[A-Z]+[0-9]+\\'" (symbol-name formula)))
- (ses-relocate-symbol formula rowcol
- startrow startcol rowincr colincr)
- formula) ; Pass through as-is.
- (dolist (cur formula)
- (setq rowcol (ses-sym-rowcol cur))
- (cond
- (rowcol
- (setq cur (ses-relocate-symbol cur rowcol
- startrow startcol rowincr colincr))
- (if cur
- (push cur result)
- ;; Reference to a deleted cell. Set a flag in ses-relocate-return.
- ;; don't change the flag if it's already 'range, since range implies
- ;; 'delete.
- (unless ses-relocate-return
- (setq ses-relocate-return 'delete))))
- ((eq (car-safe cur) 'ses-range)
- (setq cur (ses-relocate-range cur startrow startcol rowincr colincr))
- (if cur
- (push cur result)))
- ((or (atom cur) (eq (car cur) 'quote))
- ;; Constants pass through unchanged.
- (push cur result))
- (t
- ;; Recursively copy and alter subformulas.
- (push (ses-relocate-formula cur startrow startcol
- rowincr colincr)
- result))))
- (nreverse result))))
- (defun ses-relocate-range (range startrow startcol rowincr colincr)
- "Relocate one RANGE, of the form '(ses-range min max). Cells starting
- at (STARTROW,STARTCOL) are being shifted by (ROWINCR,COLINCR). Result is the
- new range, or nil if the entire range is deleted. If new rows are being added
- just beyond the end of a row range, or new columns just beyond a column range,
- the new rows/columns will be added to the range. Sets `ses-relocate-return'
- if the range was altered."
- (let* ((minorig (cadr range))
- (minrowcol (ses-sym-rowcol minorig))
- (min (ses-relocate-symbol minorig minrowcol
- startrow startcol
- rowincr colincr))
- (maxorig (nth 2 range))
- (maxrowcol (ses-sym-rowcol maxorig))
- (max (ses-relocate-symbol maxorig maxrowcol
- startrow startcol
- rowincr colincr))
- field)
- (cond
- ((and (not min) (not max))
- (setq range nil)) ; The entire range is deleted.
- ((zerop colincr)
- ;; Inserting or deleting rows.
- (setq field 'car)
- (if (not min)
- ;; Chopped off beginning of range.
- (setq min (ses-create-cell-symbol startrow (cdr minrowcol))
- ses-relocate-return 'range))
- (if (not max)
- (if (> rowincr 0)
- ;; Trying to insert a nonexistent row.
- (setq max (ses-create-cell-symbol (1- ses--numrows)
- (cdr minrowcol)))
- ;; End of range is being deleted.
- (setq max (ses-create-cell-symbol (1- startrow) (cdr minrowcol))
- ses-relocate-return 'range))
- (and (> rowincr 0)
- (= (car maxrowcol) (1- startrow))
- (= (cdr minrowcol) (cdr maxrowcol))
- ;; Insert after ending row of vertical range --- include it.
- (setq max (ses-create-cell-symbol (+ startrow rowincr -1)
- (cdr maxrowcol))))))
- (t
- ;; Inserting or deleting columns.
- (setq field 'cdr)
- (if (not min)
- ;; Chopped off beginning of range.
- (setq min (ses-create-cell-symbol (car minrowcol) startcol)
- ses-relocate-return 'range))
- (if (not max)
- (if (> colincr 0)
- ;; Trying to insert a nonexistent column.
- (setq max (ses-create-cell-symbol (car maxrowcol)
- (1- ses--numcols)))
- ;; End of range is being deleted.
- (setq max (ses-create-cell-symbol (car maxrowcol) (1- startcol))
- ses-relocate-return 'range))
- (and (> colincr 0)
- (= (cdr maxrowcol) (1- startcol))
- (= (car minrowcol) (car maxrowcol))
- ;; Insert after ending column of horizontal range --- include it.
- (setq max (ses-create-cell-symbol (car maxrowcol)
- (+ startcol colincr -1)))))))
- (when range
- (if (/= (- (funcall field maxrowcol)
- (funcall field minrowcol))
- (- (funcall field (ses-sym-rowcol max))
- (funcall field (ses-sym-rowcol min))))
- ;; This range has changed size.
- (setq ses-relocate-return 'range))
- `(ses-range ,min ,max ,@(cl-cdddr range)))))
- (defun ses-relocate-all (minrow mincol rowincr colincr)
- "Alter all cell values, symbols, formulas, and reference-lists to relocate
- the rectangle (MINROW,MINCOL)..(NUMROWS,NUMCOLS) by adding ROWINCR and COLINCR
- to each symbol."
- (let (reform)
- (let (mycell newval xrow)
- (dotimes-with-progress-reporter
- (row ses--numrows) "Relocating formulas..."
- (dotimes (col ses--numcols)
- (setq ses-relocate-return nil
- mycell (ses-get-cell row col)
- newval (ses-relocate-formula (ses-cell-formula mycell)
- minrow mincol rowincr colincr)
- xrow (- row rowincr))
- (ses-set-cell row col 'formula newval)
- (if (eq ses-relocate-return 'range)
- ;; This cell contains a (ses-range X Y) where a cell has been
- ;; inserted or deleted in the middle of the range.
- (push (cons row col) reform))
- (if ses-relocate-return
- ;; This cell referred to a cell that's been deleted or is no
- ;; longer part of the range. We can't fix that now because
- ;; reference lists cells have been partially updated.
- (cl-pushnew (ses-create-cell-symbol row col)
- ses--deferred-recalc :test #'equal))
- (setq newval (ses-relocate-formula (ses-cell-references mycell)
- minrow mincol rowincr colincr))
- (ses-set-cell row col 'references newval)
- (and (>= row minrow) (>= col mincol)
- (let ((sym (ses-cell-symbol row col))
- (xcol (- col colincr)))
- (if (and
- sym
- (>= xrow 0)
- (>= xcol 0)
- (null (eq sym
- (ses-create-cell-symbol xrow xcol))))
- ;; This is a renamed cell, do not update the cell
- ;; name, but just update the coordinate property.
- (put sym 'ses-cell (cons row col))
- (ses-set-cell row col 'symbol
- (setq sym (ses-create-cell-symbol row col)))
- (unless (and (boundp sym) (local-variable-p sym))
- (set (make-local-variable sym) nil)
- (put sym 'ses-cell (cons row col)))))) )))
- ;; Relocate the cell values.
- (let (oldval myrow mycol xrow xcol)
- (cond
- ((and (<= rowincr 0) (<= colincr 0))
- ;; Deletion of rows and/or columns.
- (dotimes-with-progress-reporter
- (row (- ses--numrows minrow)) "Relocating variables..."
- (setq myrow (+ row minrow))
- (dotimes (col (- ses--numcols mincol))
- (setq mycol (+ col mincol)
- xrow (- myrow rowincr)
- xcol (- mycol colincr))
- (let ((sym (ses-cell-symbol myrow mycol))
- (xsym (ses-create-cell-symbol xrow xcol)))
- ;; Make the value relocation only when if the cell is not
- ;; a renamed cell. Otherwise this is not needed.
- (and (eq sym xsym)
- (ses-set-cell myrow mycol 'value
- (if (and (< xrow ses--numrows) (< xcol ses--numcols))
- (ses-cell-value xrow xcol)
- ;;Cell is off the end of the array
- (symbol-value xsym))))))))
- ((and (wholenump rowincr) (wholenump colincr))
- ;; Insertion of rows and/or columns. Run the loop backwards.
- (let ((disty (1- ses--numrows))
- (distx (1- ses--numcols))
- myrow mycol)
- (dotimes-with-progress-reporter
- (row (- ses--numrows minrow)) "Relocating variables..."
- (setq myrow (- disty row))
- (dotimes (col (- ses--numcols mincol))
- (setq mycol (- distx col)
- xrow (- myrow rowincr)
- xcol (- mycol colincr))
- (if (or (< xrow minrow) (< xcol mincol))
- ;; Newly-inserted value.
- (setq oldval nil)
- ;; Transfer old value.
- (setq oldval (ses-cell-value xrow xcol)))
- (ses-set-cell myrow mycol 'value oldval)))
- t)) ; Make testcover happy by returning non-nil here.
- (t
- (error "ROWINCR and COLINCR must have the same sign"))))
- ;; Reconstruct reference lists for cells that contain ses-ranges that have
- ;; changed size.
- (when reform
- (message "Fixing ses-ranges...")
- (let (row col)
- (setq ses-start-time (float-time))
- (while reform
- (ses--time-check "Fixing ses-ranges... (%d left)" (length reform))
- (setq row (caar reform)
- col (cdar reform)
- reform (cdr reform))
- (ses-cell-set-formula row col (ses-cell-formula row col))))
- (message nil))))
- ;;----------------------------------------------------------------------------
- ;; Undo control
- ;;----------------------------------------------------------------------------
- (defun ses-begin-change ()
- "For undo, remember point before we start changing hidden stuff."
- (let ((inhibit-read-only t))
- (insert-and-inherit "X")
- (delete-region (1- (point)) (point))))
- (defun ses-setter-with-undo (accessors newval &rest args)
- "Set a field/variable and record it so it can be undone.
- Result is non-nil if field/variable has changed."
- (let ((oldval (apply (car accessors) args)))
- (unless (equal-including-properties oldval newval)
- (push `(apply ses-setter-with-undo ,accessors ,oldval ,@args)
- buffer-undo-list)
- (apply (cdr accessors) newval args)
- t)))
- (defun ses-aset-with-undo (array idx newval)
- (ses-setter-with-undo (eval-when-compile
- (cons #'aref
- (lambda (newval array idx) (aset array idx newval))))
- newval array idx))
- (defun ses-set-with-undo (sym newval)
- (ses-setter-with-undo
- (eval-when-compile
- (cons (lambda (sym) (if (boundp sym) (symbol-value sym) :ses--unbound))
- (lambda (newval sym) (if (eq newval :ses--unbound)
- (makunbound sym)
- (set sym newval)))))
- newval sym))
- ;;----------------------------------------------------------------------------
- ;; Startup for major mode
- ;;----------------------------------------------------------------------------
- (defun ses-load ()
- "Parse the current buffer and set up buffer-local variables.
- Does not execute cell formulas or print functions."
- (widen)
- ;; Read our global parameters, which should be a 3-element list.
- (goto-char (point-max))
- (search-backward ";; Local Variables:\n" nil t)
- (backward-list 1)
- (setq ses--params-marker (point-marker))
- (let* ((params (ignore-errors (read (current-buffer))))
- (params-len (safe-length params)))
- (or (and (>= params-len 3)
- (<= params-len 4)
- (numberp (car params))
- (numberp (cadr params))
- (>= (cadr params) 0)
- (numberp (nth 2 params))
- (> (nth 2 params) 0)
- (or (<= params-len 3)
- (let ((numlocprn (nth 3 params)))
- (and (integerp numlocprn) (>= numlocprn 0)))))
- (error "Invalid SES file"))
- (setq ses--file-format (car params)
- ses--numrows (cadr params)
- ses--numcols (nth 2 params)
- ses--numlocprn (or (nth 3 params) 0))
- (when (= ses--file-format 1)
- (let (buffer-undo-list) ; This is not undoable.
- (ses-goto-data 'ses--header-row)
- (insert "(ses-header-row 0)\n")
- (ses-set-parameter 'ses--file-format 3)
- (message "Upgrading from SES-1 to SES-2 file format")))
- (or (<= ses--file-format 3)
- (error "This file needs a newer version of the SES library code"))
- ;; Initialize cell array.
- (setq ses--cells (make-vector ses--numrows nil))
- (dotimes (row ses--numrows)
- (aset ses--cells row (make-vector ses--numcols nil)))
- ;; initialize local printer map.
- (clrhash ses--local-printer-hashmap))
- ;; Skip over print area, which we assume is correct.
- (goto-char (point-min))
- (forward-line ses--numrows)
- (or (looking-at-p ses-print-data-boundary)
- (error "Missing marker between print and data areas"))
- (forward-char 1)
- (setq ses--data-marker (point-marker))
- (forward-char (1- (length ses-print-data-boundary)))
- ;; Initialize printer and symbol lists.
- (mapc #'ses-printer-record ses-standard-printer-functions)
- (setq ses--symbolic-formulas nil)
- ;; Load local printer definitions.
- ;; This must be loaded *BEFORE* cells and column printers because the latter
- ;; may call them.
- (save-excursion
- (forward-line (* ses--numrows (1+ ses--numcols)))
- (let ((numlocprn ses--numlocprn))
- (setq ses--numlocprn 0)
- (dotimes (_ numlocprn)
- (let ((x (read (current-buffer))))
- (or (and (looking-at-p "\n")
- (eq (car-safe x) 'ses-local-printer)
- (apply #'ses--local-printer (cdr x)))
- (error "local printer-def error"))
- (setq ses--numlocprn (1+ ses--numlocprn))))))
- ;; Load cell definitions.
- (dotimes (row ses--numrows)
- (dotimes (col ses--numcols)
- (let* ((x (read (current-buffer)))
- (sym (car-safe (cdr-safe x))))
- (or (and (looking-at-p "\n")
- (eq (car-safe x) 'ses-cell)
- (ses-create-cell-variable sym row col))
- (error "Cell-def error"))
- (apply #'ses--cell (cdr x))))
- (or (looking-at-p "\n\n")
- (error "Missing blank line between rows")))
- ;; Skip local printer function declaration --- that were already loaded.
- (forward-line (+ 2 ses--numlocprn))
- ;; Load global parameters.
- (let ((widths (read (current-buffer)))
- (n1 (char-after (point)))
- (printers (read (current-buffer)))
- (n2 (char-after (point)))
- (def-printer (read (current-buffer)))
- (n3 (char-after (point)))
- (head-row (read (current-buffer)))
- (n4 (char-after (point))))
- (or (and (eq (car-safe widths) 'ses-column-widths)
- (= n1 ?\n)
- (eq (car-safe printers) 'ses-column-printers)
- (= n2 ?\n)
- (eq (car-safe def-printer) 'ses-default-printer)
- (= n3 ?\n)
- (eq (car-safe head-row) 'ses-header-row)
- (= n4 ?\n))
- (error "Invalid SES global parameters"))
- (1value (eval widths t))
- (1value (eval def-printer t))
- (1value (eval printers t))
- (1value (eval head-row t)))
- ;; Should be back at global-params.
- (forward-char 1)
- (or (looking-at-p ses-initial-global-parameters-re)
- (error "Problem with column-defs or global-params"))
- ;; Check for overall newline count in definitions area.
- (forward-line 3)
- (let ((start (point)))
- (ses-goto-data 'ses--numrows)
- (or (= (point) start)
- (error "Extraneous newlines someplace?"))))
- (defun ses-setup ()
- "Set up for display of only the printed cell values.
- Narrows the buffer to show only the print area. Gives it `read-only' and
- `intangible' properties. Sets up highlighting for current cell."
- (interactive)
- (let ((end (point-min))
- pos sym)
- (with-silent-modifications
- (ses-goto-data 0 0) ; Include marker between print-area and data-area.
- (set-text-properties (point) (point-max) nil) ; Delete garbage props.
- (mapc #'delete-overlay (overlays-in (point-min) (point-max)))
- ;; The print area is read-only (except for our special commands) and
- ;; uses a special keymap.
- (put-text-property (point-min) (1- (point)) 'read-only 'ses)
- (put-text-property (point-min) (1- (point)) 'keymap 'ses-mode-print-map)
- ;; For the beginning of the buffer, we want the read-only and keymap
- ;; attributes to be inherited from the first character.
- (put-text-property (point-min) (1+ (point-min))
- ;; `cursor-intangible' shouldn't be sticky at BOB.
- 'front-sticky '(read-only keymap))
- ;; Create intangible properties, which also indicate which cell the text
- ;; came from.
- (dotimes-with-progress-reporter (row ses--numrows) "Finding cells..."
- (dotimes (col ses--numcols)
- (setq pos end
- sym (ses-cell-symbol row col))
- (unless (eq (symbol-value sym) '*skip*)
- ;; Include skipped cells following this one.
- (while (and (< col (1- ses--numcols))
- (eq (ses-cell-value row (1+ col)) '*skip*))
- (setq end (+ end (ses-col-width col) 1)
- ;; Beware: Modifying the iteration variable of `dotimes'
- ;; may or may not affect the iteration!
- col (1+ col)))
- (setq end (save-excursion
- (goto-char pos)
- (move-to-column (+ (current-column) (- end pos)
- (ses-col-width col)))
- (if (eolp)
- (+ end (ses-col-width col) 1)
- (forward-char)
- (point))))
- (put-text-property pos end 'cursor-intangible sym))))))
- ;; Create the underlining overlay. It's impossible for (point) to be 2,
- ;; because column A must be at least 1 column wide.
- (setq ses--curcell-overlay (make-overlay (1+ (point-min)) (1+ (point-min))))
- (overlay-put ses--curcell-overlay 'face 'underline))
- (defun ses-cleanup ()
- "Cleanup when changing a buffer from SES mode to something else.
- Delete overlays, remove special text properties."
- (widen)
- (let ((inhibit-read-only t)
- ;; When reverting, hide the buffer name, otherwise Emacs will ask the
- ;; user "the file is modified, do you really want to make modifications
- ;; to this buffer", where the "modifications" refer to the irrelevant
- ;; set-text-properties below.
- (buffer-file-name nil)
- (was-modified (buffer-modified-p)))
- ;; Delete read-only, keymap, and intangible properties.
- (set-text-properties (point-min) (point-max) nil)
- ;; Delete overlay.
- (mapc #'delete-overlay (overlays-in (point-min) (point-max)))
- (unless was-modified
- (restore-buffer-modified-p nil))))
- ;;;###autoload
- (defun ses-mode ()
- "Major mode for Simple Emacs Spreadsheet.
- When you invoke SES in a new buffer, it is divided into cells
- that you can enter data into. You can navigate the cells with
- the arrow keys and add more cells with the tab key. The contents
- of these cells can be numbers, text, or Lisp expressions. (To
- enter text, enclose it in double quotes.)
- In an expression, you can use cell coordinates to refer to the
- contents of another cell. For example, you can sum a range of
- cells with `(+ A1 A2 A3)'. There are specialized functions like
- `ses+' (addition for ranges with empty cells), `ses-average' (for
- performing calculations on cells), and `ses-range' and `ses-select'
- \(for extracting ranges of cells).
- Each cell also has a print function that controls how it is
- displayed.
- Each SES buffer is divided into a print area and a data area.
- Normally, you can simply use SES to look at and manipulate the print
- area, and let SES manage the data area outside the visible region.
- See \"ses-example.ses\" (in `data-directory') for an example
- spreadsheet, and the Info node `(ses)Top.'
- In the following, note the separate keymaps for cell editing mode
- and print mode specifications. Key definitions:
- \\{ses-mode-map}
- These key definitions are active only in the print area (the visible
- part):
- \\{ses-mode-print-map}
- These are active only in the minibuffer, when entering or editing a
- formula:
- \\{ses-mode-edit-map}"
- (interactive)
- (unless (and (boundp 'ses--deferred-narrow)
- (eq ses--deferred-narrow 'ses-mode))
- (kill-all-local-variables)
- (ses-set-localvars)
- (setq major-mode 'ses-mode
- mode-name "SES"
- next-line-add-newlines nil
- truncate-lines t
- ;; SES deliberately puts lots of trailing whitespace in its buffer.
- show-trailing-whitespace nil
- ;; Cell ranges do not work reasonably without this.
- transient-mark-mode t
- ;; Not to use tab characters for safe (tabs may do bad for column
- ;; calculation).
- indent-tabs-mode nil)
- (1value (add-hook 'change-major-mode-hook 'ses-cleanup nil t))
- ;; This makes revert impossible if the buffer is read-only.
- ;; (1value (add-hook 'before-revert-hook 'ses-cleanup nil t))
- (setq header-line-format '(:eval (progn
- (when (/= (window-hscroll)
- ses--header-hscroll)
- ;; Reset ses--header-hscroll first,
- ;; to avoid recursion problems when
- ;; debugging ses-create-header-string
- (setq ses--header-hscroll
- (window-hscroll))
- (ses-create-header-string))
- ses--header-string)))
- (setq-local mode-line-process '(:eval (ses--mode-line-process)))
- (add-hook 'pre-redisplay-functions #'ses--cursor-sensor-highlight
- ;; Highlight the cell after moving cursor out of intangible.
- 'append t)
- (cursor-intangible-mode 1)
- (let ((was-empty (zerop (buffer-size)))
- (was-modified (buffer-modified-p)))
- (save-excursion
- (if was-empty
- ;; Initialize buffer to contain one cell, for now.
- (insert ses-initial-file-contents))
- (ses-load)
- (ses-setup))
- (when was-empty
- (unless (equal ses-initial-default-printer
- (1value ses--default-printer))
- (1value (ses-read-default-printer ses-initial-default-printer)))
- (unless (= ses-initial-column-width (1value (ses-col-width 0)))
- (1value (ses-set-column-width 0 ses-initial-column-width)))
- (ses-set-curcell)
- (if (> (car ses-initial-size) (1value ses--numrows))
- (1value (ses-insert-row (1- (car ses-initial-size)))))
- (if (> (cdr ses-initial-size) (1value ses--numcols))
- (1value (ses-insert-column (1- (cdr ses-initial-size)))))
- (ses-write-cells)
- (restore-buffer-modified-p was-modified)
- (buffer-disable-undo)
- (buffer-enable-undo)
- (goto-char (point-min))))
- (use-local-map ses-mode-map)
- ;; Set the deferred narrowing flag (we can't narrow until after
- ;; after-find-file completes). If .ses is on the auto-load alist and the
- ;; file has "mode: ses", our ses-mode function will be called twice! Use a
- ;; special flag to detect this (will be reset by ses-command-hook). For
- ;; find-alternate-file, post-command-hook doesn't get run for some reason,
- ;; so use an idle timer to make sure.
- (setq ses--deferred-narrow 'ses-mode)
- (1value (add-hook 'post-command-hook 'ses-command-hook nil t))
- (run-with-idle-timer 0.01 nil 'ses-command-hook)
- (run-mode-hooks 'ses-mode-hook)))
- (put 'ses-mode 'mode-class 'special)
- (defun ses-command-hook ()
- "Invoked from `post-command-hook'. If point has moved to a different cell,
- moves the underlining overlay. Performs any recalculations or cell-data
- writes that have been deferred. If buffer-narrowing has been deferred,
- narrows the buffer now."
- (condition-case err
- (when (eq major-mode 'ses-mode) ; Otherwise, not our buffer anymore.
- (when ses--deferred-recalc
- ;; We reset the deferred list before starting on the recalc --- in
- ;; case of error, we don't want to retry the recalc after every
- ;; keystroke!
- (ses-initialize-Dijkstra-attempt)
- (let ((old ses--deferred-recalc))
- (setq ses--deferred-recalc nil)
- (ses-update-cells old)))
- (when ses--deferred-write
- ;; We don't reset the deferred list before starting --- the most
- ;; likely error is keyboard-quit, and we do want to keep trying these
- ;; writes after a quit.
- (ses-write-cells)
- (push '(apply ses-widen) buffer-undo-list))
- (when ses--deferred-narrow
- ;; We're not allowed to narrow the buffer until after-find-file has
- ;; read the local variables at the end of the file. Now it's safe to
- ;; do the narrowing.
- (narrow-to-region (point-min) ses--data-marker)
- (setq ses--deferred-narrow nil)))
- ;; Prevent errors in this post-command-hook from silently erasing the hook!
- (error
- (unless executing-kbd-macro
- (ding))
- (message "%s" (error-message-string err))))
- nil) ; Make coverage-tester happy.
- (defun ses--mode-line-process ()
- (let ((cmlp (window-parameter nil 'ses--mode-line-process))
- (curcell (ses--curcell (window-point))))
- (if (equal curcell (car cmlp))
- (cdr cmlp)
- (let ((mlp
- (cond
- ((not curcell) nil)
- ((atom curcell) (list " cell " (symbol-name curcell)))
- (t
- (list " range "
- (symbol-name (car curcell))
- "-"
- (symbol-name (cdr curcell)))))))
- (set-window-parameter nil 'ses--mode-line-process (cons curcell mlp))
- mlp))))
- (defun ses--cursor-sensor-highlight (window)
- (let ((curcell (ses--curcell))
- (ol (window-parameter window 'ses--curcell-overlay)))
- (unless ol
- (setq ol (make-overlay (point) (point)))
- (overlay-put ol 'window window)
- (overlay-put ol 'face 'underline)
- (set-window-parameter window 'ses--curcell-overlay ol))
- ;; Use underline overlay for single-cells only, turn off otherwise.
- (if (listp curcell)
- (delete-overlay ol)
- (let* ((pos (window-point window))
- (next (next-single-property-change pos 'cursor-intangible)))
- (move-overlay ol pos (1- next))))))
- (defun ses-create-header-string ()
- "Set up `ses--header-string' as the buffer's header line.
- Based on the current set of columns and `window-hscroll' position."
- (let ((totwidth (- (window-hscroll)))
- result width x)
- ;; Leave room for the left-side fringe and scrollbar.
- (push (propertize " " 'display '((space :align-to 0))) result)
- (dotimes (col ses--numcols)
- (setq width (ses-col-width col)
- totwidth (+ totwidth width 1))
- (if (= totwidth 1)
- ;; Scrolled so intercolumn space is leftmost.
- (push " " result))
- (when (> totwidth 1)
- (if (> ses--header-row 0)
- (save-excursion
- (ses-goto-print (1- ses--header-row) col)
- (setq x (buffer-substring-no-properties (point)
- (+ (point) width)))
- ;; Strip trailing space.
- (if (string-match "[ \t]+\\'" x)
- (setq x (substring x 0 (match-beginning 0))))
- ;; Cut off excess text.
- (if (>= (length x) totwidth)
- (setq x (substring x 0 (- totwidth -1)))))
- (setq x (ses-column-letter col)))
- (push (propertize x 'face ses-box-prop) result)
- (push (propertize "."
- 'display `((space :align-to ,(1- totwidth)))
- 'face ses-box-prop)
- result)
- ;; Allow the following space to be squished to make room for the 3-D box
- ;; Coverage test ignores properties, thinks this is always a space!
- (push (1value (propertize " " 'display `((space :align-to ,totwidth))))
- result)))
- (if (> ses--header-row 0)
- (push (propertize (format " [row %d]" ses--header-row)
- 'display '((height (- 1))))
- result))
- (setq ses--header-string (apply #'concat (nreverse result)))))
- ;;----------------------------------------------------------------------------
- ;; Redisplay and recalculation
- ;;----------------------------------------------------------------------------
- (defun ses-jump (sym)
- "Move point to cell SYM."
- (interactive "SJump to cell: ")
- (let ((rowcol (ses-sym-rowcol sym)))
- (or rowcol (error "Invalid cell name"))
- (if (eq (symbol-value sym) '*skip*)
- (error "Cell is covered by preceding cell"))
- (ses-goto-print (car rowcol) (cdr rowcol))))
- (defun ses-jump-safe (cell)
- "Like `ses-jump', but no error if invalid cell."
- (ignore-errors
- (ses-jump cell)))
- (defun ses-reprint-all (&optional nonarrow)
- "Recreate the display area. Calls all printer functions. Narrows to
- print area if NONARROW is nil."
- (interactive "*P")
- (widen)
- (unless nonarrow
- (setq ses--deferred-narrow t))
- (let ((startcell (ses--cell-at-pos (point)))
- (inhibit-read-only t))
- (ses-begin-change)
- (goto-char (point-min))
- (search-forward ses-print-data-boundary)
- (backward-char (length ses-print-data-boundary))
- (delete-region (point-min) (point))
- ;; Insert all blank lines before printing anything, so ses-print-cell can
- ;; find the data area when inserting or deleting *skip* values for cells.
- (dotimes (_ ses--numrows)
- (insert-and-inherit ses--blank-line))
- (dotimes-with-progress-reporter (row ses--numrows) "Reprinting..."
- (if (eq (ses-cell-value row 0) '*skip*)
- ;; Column deletion left a dangling skip.
- (ses-set-cell row 0 'value nil))
- (dotimes (col ses--numcols)
- (ses-print-cell row col))
- (beginning-of-line 2))
- (ses-jump-safe startcell)))
- (defun ses-initialize-Dijkstra-attempt ()
- (setq ses--Dijkstra-attempt-nb (1+ ses--Dijkstra-attempt-nb)
- ses--Dijkstra-weight-bound (* ses--numrows ses--numcols)))
- ;; These functions use the variables 'row' and 'col' that are dynamically bound
- ;; by ses-print-cell. We define these variables at compile-time to make the
- ;; compiler happy.
- ;; (defvar row)
- ;; (defvar col)
- ;; (defvar maxrow)
- ;; (defvar maxcol)
- (defun ses-recalculate-cell ()
- "Recalculate and reprint the current cell or range.
- For an individual cell, shows the error if the formula or printer
- signals one, or otherwise shows the cell's complete value. For a range, the
- cells are recalculated in \"natural\" order, so cells that other cells refer
- to are recalculated first."
- (interactive "*")
- (ses-check-curcell 'range)
- (ses-begin-change)
- (ses-initialize-Dijkstra-attempt)
- (let (sig cur-rowcol)
- (setq ses-start-time (float-time))
- (if (atom ses--curcell)
- (when
- (setq cur-rowcol (ses-sym-rowcol ses--curcell)
- sig (progn
- (setf (ses-cell-property :ses-Dijkstra-attempt
- (car cur-rowcol)
- (cdr cur-rowcol))
- (cons ses--Dijkstra-attempt-nb 0))
- (ses-calculate-cell (car cur-rowcol) (cdr cur-rowcol) t)))
- (nconc sig (list (ses-cell-symbol (car cur-rowcol)
- (cdr cur-rowcol)))))
- ;; First, recalculate all cells that don't refer to other cells and
- ;; produce a list of cells with references.
- (ses-dorange ses--curcell
- (ses--time-check "Recalculating... %s" (ses-cell-symbol row col))
- (condition-case nil
- (progn
- ;; The t causes an error if the cell has references. If no
- ;; references, the t will be the result value.
- (1value (ses-formula-references (ses-cell-formula row col) t))
- (setf (ses-cell-property :ses-Dijkstra-attempt row col)
- (cons ses--Dijkstra-attempt-nb 0))
- (when (setq sig (ses-calculate-cell row col t))
- (nconc sig (list (ses-cell-symbol row col)))))
- (wrong-type-argument
- ;; The formula contains a reference.
- (cl-pushnew (ses-cell-symbol row col) ses--deferred-recalc
- :test #'equal)))))
- ;; Do the update now, so we can force recalculation.
- (let ((x ses--deferred-recalc))
- (setq ses--deferred-recalc nil)
- (condition-case hold
- (ses-update-cells x t)
- (error (setq sig hold))))
- (cond
- (sig
- (message "%s" (error-message-string sig)))
- ((consp ses--curcell)
- (message " "))
- (t
- (princ (symbol-value ses--curcell))))))
- (defun ses-recalculate-all ()
- "Recalculate and reprint all cells."
- (interactive "*")
- (let ((startcell (ses--cell-at-pos (point)))
- (ses--curcell (cons 'A1 (ses-cell-symbol (1- ses--numrows)
- (1- ses--numcols)))))
- (ses-recalculate-cell)
- (ses-jump-safe startcell)))
- (defun ses-truncate-cell ()
- "Reprint current cell, but without spillover into any following blank cells."
- (interactive "*")
- (ses-check-curcell)
- (let* ((rowcol (ses-sym-rowcol ses--curcell))
- (row (car rowcol))
- (col (cdr rowcol)))
- (when (and (< col (1- ses--numcols)) ;;Last column can't spill over, anyway
- (eq (ses-cell-value row (1+ col)) '*skip*))
- ;; This cell has spill-over. We'll momentarily pretend the following cell
- ;; has a t in it.
- (cl-progv
- (list (ses-cell-symbol row (1+ col)))
- '(t)
- (ses-print-cell row col))
- ;; Now remove the *skip*. ses-print-cell is always nil here.
- (ses-set-cell row (1+ col) 'value nil)
- (1value (ses-print-cell row (1+ col))))))
- (defun ses-reconstruct-all ()
- "Reconstruct buffer based on cell data stored in Emacs variables."
- (interactive "*")
- (ses-begin-change)
- ;;Reconstruct reference lists.
- (let (x yrow ycol)
- ;;Delete old reference lists
- (dotimes-with-progress-reporter
- (row ses--numrows) "Deleting references..."
- (dotimes (col ses--numcols)
- (ses-set-cell row col 'references nil)))
- ;;Create new reference lists
- (dotimes-with-progress-reporter
- (row ses--numrows) "Computing references..."
- (dotimes (col ses--numcols)
- (dolist (ref (ses-formula-references (ses-cell-formula row col)))
- (setq x (ses-sym-rowcol ref)
- yrow (car x)
- ycol (cdr x))
- (ses-set-cell yrow ycol 'references
- (cons (ses-cell-symbol row col)
- (ses-cell-references yrow ycol)))))))
- ;; Delete everything and reconstruct basic data area.
- (ses-widen)
- (let ((inhibit-read-only t))
- (goto-char (point-max))
- (if (search-backward ";; Local Variables:\n" nil t)
- (delete-region (point-min) (point))
- ;; Buffer is quite screwed up --- can't even save the user-specified
- ;; locals.
- (delete-region (point-min) (point-max))
- (insert ses-initial-file-trailer)
- (goto-char (point-min)))
- ;; Create a blank display area.
- (dotimes (_ ses--numrows)
- (insert ses--blank-line))
- (insert ses-print-data-boundary)
- (backward-char (1- (length ses-print-data-boundary)))
- (setq ses--data-marker (point-marker))
- (forward-char (1- (length ses-print-data-boundary)))
- ;; Placeholders for cell data.
- (insert (make-string (* ses--numrows (1+ ses--numcols)) ?\n))
- ;; Placeholders for col-widths, col-printers, default-printer, header-row.
- (insert "\n\n\n\n")
- (insert ses-initial-global-parameters)
- (backward-char (1- (length ses-initial-global-parameters)))
- (setq ses--params-marker (point-marker))
- (forward-char (1- (length ses-initial-global-parameters))))
- (ses-set-parameter 'ses--col-widths ses--col-widths)
- (ses-set-parameter 'ses--col-printers ses--col-printers)
- (ses-set-parameter 'ses--default-printer ses--default-printer)
- (ses-set-parameter 'ses--header-row ses--header-row)
- (ses-set-parameter 'ses--numrows ses--numrows)
- (ses-set-parameter 'ses--numcols ses--numcols)
- ;;Keep our old narrowing
- (ses-setup)
- (ses-recalculate-all)
- (goto-char (point-min)))
- ;;----------------------------------------------------------------------------
- ;; Input of cell formulas
- ;;----------------------------------------------------------------------------
- (defun ses-edit-cell (row col newval)
- "Display current cell contents in minibuffer, for editing. Returns nil if
- cell formula was unsafe and user declined confirmation."
- (interactive
- (progn
- (barf-if-buffer-read-only)
- (ses-check-curcell)
- (let* ((rowcol (ses-sym-rowcol ses--curcell))
- (row (car rowcol))
- (col (cdr rowcol))
- (formula (ses-cell-formula row col))
- initial)
- (if (eq (car-safe formula) 'ses-safe-formula)
- (setq formula (cadr formula)))
- (if (eq (car-safe formula) 'quote)
- (setq initial (format "'%S" (cadr formula)))
- (setq initial (prin1-to-string formula)))
- (if (stringp formula)
- ;; Position cursor inside close-quote.
- (setq initial (cons initial (length initial))))
- (list row col
- (read-from-minibuffer (format "Cell %s: " ses--curcell)
- initial
- ses-mode-edit-map
- t ; Convert to Lisp object.
- 'ses-read-cell-history)))))
- (when (ses-warn-unsafe newval 'unsafep)
- (ses-begin-change)
- (ses-cell-set-formula row col newval)
- t))
- (defun ses-read-cell (row col newval)
- "Self-insert for initial character of cell function."
- (interactive
- (let* ((initial (this-command-keys))
- (rowcol (progn (ses-check-curcell) (ses-sym-rowcol ses--curcell)))
- (curval (ses-cell-formula (car rowcol) (cdr rowcol))))
- (barf-if-buffer-read-only)
- (list (car rowcol)
- (cdr rowcol)
- (if (equal initial "\"")
- (progn
- (if (not (stringp curval)) (setq curval nil))
- (read-string (if curval
- (format "String Cell %s (default %s): "
- ses--curcell curval)
- (format "String Cell %s: " ses--curcell))
- nil 'ses-read-string-history curval))
- (read-from-minibuffer
- (format "Cell %s: " ses--curcell)
- (cons (if (equal initial "(") "()" initial) 2)
- ses-mode-edit-map
- t ; Convert to Lisp object.
- 'ses-read-cell-history
- (prin1-to-string (if (eq (car-safe curval) 'ses-safe-formula)
- (cadr curval)
- curval)))))))
- (when (ses-edit-cell row col newval)
- (ses-command-hook) ; Update cell widths before movement.
- (dolist (x ses-after-entry-functions)
- (funcall x 1))))
- (defun ses-read-symbol (row col symb)
- "Self-insert for a symbol as a cell formula. The set of all symbols that
- have been used as formulas in this spreadsheet is available for completions."
- (interactive
- (let ((rowcol (progn (ses-check-curcell) (ses-sym-rowcol ses--curcell)))
- newval)
- (barf-if-buffer-read-only)
- (setq newval (completing-read (format "Cell %s ': " ses--curcell)
- ses--symbolic-formulas))
- (list (car rowcol)
- (cdr rowcol)
- (if (string= newval "")
- nil ; Don't create zero-length symbols!
- (list 'quote (intern newval))))))
- (when (ses-edit-cell row col symb)
- (ses-command-hook) ; Update cell widths before movement.
- (dolist (x ses-after-entry-functions)
- (funcall x 1))))
- (defun ses-clear-cell-forward (count)
- "Delete formula and printer for current cell and then move to next cell.
- With prefix, deletes several cells."
- (interactive "*p")
- (if (< count 0)
- (1value (ses-clear-cell-backward (- count)))
- (ses-check-curcell)
- (ses-begin-change)
- (dotimes (_ count)
- (ses-set-curcell)
- (let ((rowcol (ses-sym-rowcol ses--curcell)))
- (or rowcol (signal 'end-of-buffer nil))
- (ses-clear-cell (car rowcol) (cdr rowcol)))
- (forward-char 1))))
- (defun ses-clear-cell-backward (count)
- "Move to previous cell and then delete it. With prefix, deletes several
- cells."
- (interactive "*p")
- (if (< count 0)
- (1value (ses-clear-cell-forward (- count)))
- (ses-check-curcell 'end)
- (ses-begin-change)
- (dotimes (_ count)
- (backward-char 1) ; Will signal 'beginning-of-buffer if appropriate.
- (ses-set-curcell)
- (let ((rowcol (ses-sym-rowcol ses--curcell)))
- (ses-clear-cell (car rowcol) (cdr rowcol))))))
- ;;----------------------------------------------------------------------------
- ;; Input of cell-printer functions
- ;;----------------------------------------------------------------------------
- (defun ses-read-printer (prompt default)
- "Common code for functions `ses-read-cell-printer', `ses-read-column-printer',
- `ses-read-default-printer' and `ses-define-local-printer'.
- PROMPT should end with \": \". Result is t if operation was
- canceled."
- (barf-if-buffer-read-only)
- (if (eq default t)
- (setq default "")
- (setq prompt (format "%s (default %S): "
- (substring prompt 0 -2)
- default)))
- (let ((new (read-from-minibuffer prompt
- nil ; Initial contents.
- ses-mode-edit-map
- t ; Evaluate the result.
- 'ses-read-printer-history
- (prin1-to-string default))))
- (if (equal new default)
- ;; User changed mind, decided not to change printer.
- (setq new t)
- (ses-printer-validate new)
- (or (not new)
- (stringp new)
- (stringp (car-safe new))
- (and (symbolp new) (gethash new ses--local-printer-hashmap))
- (ses-warn-unsafe new 'unsafep-function)
- (setq new t)))
- new))
- (defun ses-read-cell-printer (newval)
- "Set the printer function for the current cell or range.
- A printer function is either a string (a format control-string with one
- %-sequence -- result from format will be right-justified), or a list of one
- string (result from format will be left-justified), or a lambda-expression of
- one argument, or a symbol that names a function of one argument. In the
- latter two cases, the function's result should be either a string (will be
- right-justified) or a list of one string (will be left-justified)."
- (interactive
- (let ((default t))
- (ses-check-curcell 'range)
- ;;Default is none if not all cells in range have same printer
- (catch 'ses-read-cell-printer
- (ses-dorange ses--curcell
- (let ((x (ses-cell-printer row col)))
- (if (eq (car-safe x) 'ses-safe-printer)
- (setq x (cadr x)))
- (if (eq default t)
- (setq default x)
- (unless (equal default x)
- ;;Range contains differing printer functions
- (setq default t)
- (throw 'ses-read-cell-printer t))))))
- (list (ses-read-printer (format "Cell %S printer: " ses--curcell)
- default))))
- (unless (eq newval t)
- (ses-begin-change)
- (ses-dorange ses--curcell
- (ses-set-cell row col 'printer newval)
- (ses-print-cell row col))))
- (defun ses-read-column-printer (col newval)
- "Set the printer function for the current column.
- See `ses-read-cell-printer' for input forms."
- (interactive
- (let ((col (cdr (ses-sym-rowcol ses--curcell))))
- (ses-check-curcell)
- (list col (ses-read-printer (format "Column %s printer: "
- (ses-column-letter col))
- (ses-col-printer col)))))
- (unless (eq newval t)
- (ses-begin-change)
- (ses-set-parameter 'ses--col-printers newval col)
- (save-excursion
- (dotimes (row ses--numrows)
- (ses-print-cell row col)))))
- (defun ses-read-default-printer (newval)
- "Set the default printer function for cells that have no other.
- See `ses-read-cell-printer' for input forms."
- (interactive
- (list (ses-read-printer "Default printer: " ses--default-printer)))
- (unless (eq newval t)
- (ses-begin-change)
- (ses-set-parameter 'ses--default-printer newval)
- (ses-reprint-all t)))
- ;;----------------------------------------------------------------------------
- ;; Spreadsheet size adjustments
- ;;----------------------------------------------------------------------------
- (defun ses-insert-row (count)
- "Insert a new row before the current one.
- With prefix, insert COUNT rows before current one."
- (interactive "*p")
- (ses-check-curcell 'end)
- (or (> count 0) (signal 'args-out-of-range nil))
- (ses-begin-change)
- (let ((inhibit-quit t)
- (inhibit-read-only t)
- (row (or (car (ses-sym-rowcol ses--curcell)) ses--numrows))
- newrow)
- ;;Create a new set of cell-variables
- (ses-create-cell-variable-range ses--numrows (+ ses--numrows count -1)
- 0 (1- ses--numcols))
- (ses-set-parameter 'ses--numrows (+ ses--numrows count))
- ;;Insert each row
- (ses-goto-print row 0)
- (dotimes-with-progress-reporter (x count) "Inserting row..."
- ;;Create a row of empty cells. The `symbol' fields will be set by
- ;;the call to ses-relocate-all.
- (setq newrow (make-vector ses--numcols nil))
- (dotimes (col ses--numcols)
- (aset newrow col (ses-make-cell)))
- (setq ses--cells (ses-vector-insert ses--cells row newrow))
- (push `(apply ses-vector-delete ses--cells ,row 1) buffer-undo-list)
- (insert ses--blank-line))
- ;;Insert empty lines in cell data area (will be replaced by
- ;;ses-relocate-all)
- (ses-goto-data row 0)
- (insert (make-string (* (1+ ses--numcols) count) ?\n))
- (ses-relocate-all row 0 count 0)
- ;;If any cell printers insert constant text, insert that text
- ;;into the line.
- (let ((cols (mapconcat #'ses-call-printer ses--col-printers nil))
- (global (ses-call-printer ses--default-printer)))
- (if (or (> (length cols) 0) (> (length global) 0))
- (dotimes (x count)
- (dotimes (col ses--numcols)
- ;;These cells are always nil, only constant formatting printed
- (1value (ses-print-cell (+ x row) col))))))
- (when (> ses--header-row row)
- ;;Inserting before header
- (ses-set-parameter 'ses--header-row (+ ses--header-row count))
- (ses-reset-header-string)))
- ;;Reconstruct text attributes
- (ses-setup)
- ;;Prepare for undo
- (push '(apply ses-widen) buffer-undo-list)
- ;;Return to current cell
- (if ses--curcell
- (ses-jump-safe ses--curcell)
- (ses-goto-print (1- ses--numrows) 0)))
- (defun ses-delete-row (count)
- "Delete the current row.
- With prefix, deletes COUNT rows starting from the current one."
- (interactive "*p")
- (ses-check-curcell)
- (or (> count 0) (signal 'args-out-of-range nil))
- (let ((inhibit-quit t)
- (inhibit-read-only t)
- (row (car (ses-sym-rowcol ses--curcell))))
- (setq count (min count (- ses--numrows row)))
- (ses-begin-change)
- (ses-set-parameter 'ses--numrows (- ses--numrows count))
- ;;Delete lines from print area
- (ses-goto-print row 0)
- (ses-delete-line count)
- ;;Delete lines from cell data area
- (ses-goto-data row 0)
- (ses-delete-line (* count (1+ ses--numcols)))
- ;;Relocate variables and formulas
- (ses-set-with-undo 'ses--cells (ses-vector-delete ses--cells row count))
- (ses-relocate-all row 0 (- count) 0)
- (ses-destroy-cell-variable-range ses--numrows (+ ses--numrows count -1)
- 0 (1- ses--numcols))
- (when (> ses--header-row row)
- (if (<= ses--header-row (+ row count))
- ;;Deleting the header row
- (ses-set-parameter 'ses--header-row 0)
- (ses-set-parameter 'ses--header-row (- ses--header-row count)))
- (ses-reset-header-string)))
- ;;Reconstruct attributes
- (ses-setup)
- ;;Prepare for undo
- (push '(apply ses-widen) buffer-undo-list)
- (ses-jump-safe ses--curcell))
- (defun ses-insert-column (count &optional col width printer)
- "Insert a new column before COL (default is the current one).
- With prefix, insert COUNT columns before current one.
- If COL is specified, the new column(s) get the specified WIDTH and PRINTER
- \(otherwise they're taken from the current column)."
- (interactive "*p")
- (ses-check-curcell)
- (or (> count 0) (signal 'args-out-of-range nil))
- (or col
- (setq col (cdr (ses-sym-rowcol ses--curcell))
- width (ses-col-width col)
- printer (ses-col-printer col)))
- (ses-begin-change)
- (let ((inhibit-quit t)
- (inhibit-read-only t)
- (widths ses--col-widths)
- (printers ses--col-printers)
- has-skip)
- ;;Create a new set of cell-variables
- (ses-create-cell-variable-range 0 (1- ses--numrows)
- ses--numcols (+ ses--numcols count -1))
- ;;Insert each column.
- (dotimes-with-progress-reporter (x count) "Inserting column..."
- ;;Create a column of empty cells. The `symbol' fields will be set by
- ;;the call to ses-relocate-all.
- (ses-adjust-print-width col (1+ width))
- (ses-set-parameter 'ses--numcols (1+ ses--numcols))
- (dotimes (row ses--numrows)
- (and (< (1+ col) ses--numcols) (eq (ses-cell-value row col) '*skip*)
- ;;Inserting in the middle of a spill-over
- (setq has-skip t))
- (ses-aset-with-undo ses--cells row
- (ses-vector-insert (aref ses--cells row)
- col (ses-make-cell)))
- ;;Insert empty lines in cell data area (will be replaced by
- ;;ses-relocate-all)
- (ses-goto-data row col)
- (insert ?\n))
- ;; Insert column width and printer.
- (setq widths (ses-vector-insert widths col width)
- printers (ses-vector-insert printers col printer)))
- (ses-set-parameter 'ses--col-widths widths)
- (ses-set-parameter 'ses--col-printers printers)
- (ses-reset-header-string)
- (ses-relocate-all 0 col 0 count)
- (if has-skip
- (ses-reprint-all t)
- (when (or (> (length (ses-call-printer printer)) 0)
- (> (length (ses-call-printer ses--default-printer)) 0))
- ;; Either column printer or global printer inserts some constant text.
- ;; Reprint the new columns to insert that text.
- (dotimes (x ses--numrows)
- (dotimes (y count)
- ;; Always nil here --- this is a blank column.
- (1value (ses-print-cell-new-width x (+ y col))))))
- (ses-setup)))
- (ses-jump-safe ses--curcell))
- (defun ses-delete-column (count)
- "Delete the current column.
- With prefix, deletes COUNT columns starting from the current one."
- (interactive "*p")
- (ses-check-curcell)
- (or (> count 0) (signal 'args-out-of-range nil))
- (let ((inhibit-quit t)
- (inhibit-read-only t)
- (rowcol (ses-sym-rowcol ses--curcell))
- (width 0)
- col origrow has-skip)
- (setq origrow (car rowcol)
- col (cdr rowcol)
- count (min count (- ses--numcols col)))
- (if (= count ses--numcols)
- (error "Can't delete all columns!"))
- ;;Determine width of column(s) being deleted
- (dotimes (x count)
- (setq width (+ width (ses-col-width (+ col x)) 1)))
- (ses-begin-change)
- (ses-set-parameter 'ses--numcols (- ses--numcols count))
- (ses-adjust-print-width col (- width))
- (dotimes-with-progress-reporter (row ses--numrows) "Deleting column..."
- ;;Delete lines from cell data area
- (ses-goto-data row col)
- (ses-delete-line count)
- ;;Delete cells. Check if deletion area begins or ends with a skip.
- (if (or (eq (ses-cell-value row col) '*skip*)
- (and (< col ses--numcols)
- (eq (ses-cell-value row (+ col count)) '*skip*)))
- (setq has-skip t))
- (ses-aset-with-undo ses--cells row
- (ses-vector-delete (aref ses--cells row) col count)))
- ;;Update globals
- (ses-set-parameter 'ses--col-widths
- (ses-vector-delete ses--col-widths col count))
- (ses-set-parameter 'ses--col-printers
- (ses-vector-delete ses--col-printers col count))
- (ses-reset-header-string)
- ;;Relocate variables and formulas
- (ses-relocate-all 0 col 0 (- count))
- (ses-destroy-cell-variable-range 0 (1- ses--numrows)
- ses--numcols (+ ses--numcols count -1))
- (if has-skip
- (ses-reprint-all t)
- (ses-setup))
- (if (>= col ses--numcols)
- (setq col (1- col)))
- (ses-goto-print origrow col)))
- (defun ses-forward-or-insert (&optional count)
- "Move to next cell in row, or inserts a new cell if already in last one, or
- inserts a new row if at bottom of print area. Repeat COUNT times."
- (interactive "p")
- (ses-check-curcell 'end)
- (setq deactivate-mark t) ; Doesn't combine well with ranges.
- (dotimes (x count)
- (ses-set-curcell)
- (if (not ses--curcell)
- (progn ; At bottom of print area.
- (barf-if-buffer-read-only)
- (ses-insert-row 1))
- (let ((col (cdr (ses-sym-rowcol ses--curcell))))
- (when (/= 32
- (char-before (next-single-property-change (point)
- 'cursor-intangible)))
- ;; We're already in last nonskipped cell on line. Need to create a
- ;; new column.
- (barf-if-buffer-read-only)
- (ses-insert-column (- count x)
- ses--numcols
- (ses-col-width col)
- (ses-col-printer col)))))
- (forward-char)))
- (defun ses-append-row-jump-first-column ()
- "Insert a new row after current one and jump to its first column."
- (interactive "*")
- (ses-check-curcell)
- (ses-begin-change)
- (beginning-of-line 2)
- (ses-set-curcell)
- (ses-insert-row 1))
- (defun ses-set-column-width (col newwidth)
- "Set the width of the current column."
- (interactive
- (let ((col (cdr (progn (ses-check-curcell) (ses-sym-rowcol ses--curcell)))))
- (barf-if-buffer-read-only)
- (list col
- (if current-prefix-arg
- (prefix-numeric-value current-prefix-arg)
- (read-from-minibuffer (format "Column %s width (default %d): "
- (ses-column-letter col)
- (ses-col-width col))
- nil ; No initial contents.
- nil ; No override keymap.
- t ; Convert to Lisp object.
- nil ; No history.
- (number-to-string
- (ses-col-width col))))))) ; Default value.
- (if (< newwidth 1)
- (error "Invalid column width"))
- (ses-begin-change)
- (ses-reset-header-string)
- (save-excursion
- (let ((inhibit-quit t))
- (ses-adjust-print-width col (- newwidth (ses-col-width col)))
- (ses-set-parameter 'ses--col-widths newwidth col))
- (dotimes (row ses--numrows)
- (ses-print-cell-new-width row col))))
- ;;----------------------------------------------------------------------------
- ;; Cut and paste, import and export
- ;;----------------------------------------------------------------------------
- (defun ses--advice-copy-region-as-kill (crak-fun beg end &rest args)
- ;; FIXME: Why doesn't it make sense to copy read-only or
- ;; intangible attributes? They're removed upon yank!
- "It doesn't make sense to copy read-only or intangible attributes into the
- kill ring. It probably doesn't make sense to copy keymap properties.
- We'll assume copying front-sticky properties doesn't make sense, either.
- This advice also includes some SES-specific code because otherwise it's too
- hard to override how mouse-1 works."
- (when (> beg end)
- (let ((temp beg))
- (setq beg end
- end temp)))
- (if (not (and (derived-mode-p 'ses-mode)
- (eq (get-text-property beg 'read-only) 'ses)
- (eq (get-text-property (1- end) 'read-only) 'ses)))
- (apply crak-fun beg end args) ; Normal copy-region-as-kill.
- (kill-new (ses-copy-region beg end))
- (if transient-mark-mode
- (setq deactivate-mark t))
- nil))
- (advice-add 'copy-region-as-kill :around #'ses--advice-copy-region-as-kill)
- (defun ses-copy-region (beg end)
- "Treat the region as rectangular. Convert the intangible attributes to
- SES attributes recording the contents of the cell as of the time of copying."
- (when (= end ses--data-marker)
- ;;Avoid overflow situation
- (setq end (1- ses--data-marker)))
- (let* ((x (mapconcat #'ses-copy-region-helper
- (extract-rectangle beg (1- end)) "\n")))
- (remove-text-properties 0 (length x)
- '(read-only t
- cursor-intangible t
- keymap t
- front-sticky t)
- x)
- x))
- (defun ses-copy-region-helper (line)
- "Converts one line (of a rectangle being extracted from a spreadsheet) to
- external form by attaching to each print cell a 'ses attribute that records
- the corresponding data cell."
- (or (> (length line) 1)
- (error "Empty range"))
- (let ((inhibit-read-only t)
- (pos 0)
- mycell next sym rowcol)
- (while pos
- (setq sym (ses--cell-at-pos pos line)
- next (next-single-property-change pos 'cursor-intangible line)
- rowcol (ses-sym-rowcol sym)
- mycell (ses-get-cell (car rowcol) (cdr rowcol)))
- (put-text-property pos (or next (length line))
- 'ses
- (list (ses-cell-symbol mycell)
- (ses-cell-formula mycell)
- (ses-cell-printer mycell))
- line)
- (setq pos next)))
- line)
- (defun ses-kill-override (beg end)
- "Generic override for any commands that kill text.
- We clear the killed cells instead of deleting them."
- (interactive "r")
- (ses-check-curcell 'needrange)
- ;; For some reason, the text-read-only error is not caught by `delete-region',
- ;; so we have to use subterfuge.
- (let ((buffer-read-only t))
- (1value (condition-case nil
- (noreturn (funcall (lookup-key (current-global-map)
- (this-command-keys))
- beg end))
- (buffer-read-only nil)))) ; The expected error.
- ;; Because the buffer was marked read-only, the kill command turned itself
- ;; into a copy. Now we clear the cells or signal the error. First we check
- ;; whether the buffer really is read-only.
- (barf-if-buffer-read-only)
- (ses-begin-change)
- (ses-dorange ses--curcell
- (ses-clear-cell row col))
- (ses-jump (car ses--curcell)))
- (defun ses--advice-yank (yank-fun &optional arg &rest args)
- "In SES mode, the yanked text is inserted as cells.
- If the text contains 'ses attributes (meaning it went to the kill-ring from a
- SES buffer), the formulas and print functions are restored for the cells. If
- the text contains tabs, this is an insertion of tab-separated formulas.
- Otherwise the text is inserted as the formula for the current cell.
- When inserting cells, the formulas are usually relocated to keep the same
- relative references to neighboring cells. This is best if the formulas
- generally refer to other cells within the yanked text. You can use the C-u
- prefix to specify insertion without relocation, which is best when the
- formulas refer to cells outside the yanked text.
- When inserting formulas, the text is treated as a string constant if it doesn't
- make sense as a sexp or would otherwise be considered a symbol. Use 'sym to
- explicitly insert a symbol, or use the C-u prefix to treat all unmarked words
- as symbols."
- (if (not (and (derived-mode-p 'ses-mode)
- (eq (get-text-property (point) 'keymap) 'ses-mode-print-map)))
- (apply yank-fun arg args) ; Normal non-SES yank.
- (ses-check-curcell 'end)
- (push-mark (point))
- (let ((text (current-kill (cond
- ((listp arg) 0)
- ((eq arg '-) -1)
- (t (1- arg))))))
- (or (ses-yank-cells text arg)
- (ses-yank-tsf text arg)
- (ses-yank-one (ses-yank-resize 1 1)
- text
- 0
- (if (memq (aref text (1- (length text))) '(?\t ?\n))
- ;; Just one cell --- delete final tab or newline.
- (1- (length text)))
- arg)))
- (if (consp arg)
- (exchange-point-and-mark))))
- (advice-add 'yank :around #'ses--advice-yank)
- (defun ses-yank-pop (arg)
- "Replace just-yanked stretch of killed text with a different stretch.
- This command is allowed only immediately after a `yank' or a `yank-pop',
- when the region contains a stretch of reinserted previously-killed text.
- We replace it with a different stretch of killed text.
- Unlike standard `yank-pop', this function uses `undo' to delete the
- previous insertion."
- (interactive "*p")
- (or (eq last-command 'yank)
- ;;Use noreturn here just to avoid a "poor-coverage" warning in its
- ;;macro definition.
- (noreturn (error "Previous command was not a yank")))
- (undo)
- (ses-set-curcell)
- (yank (1+ (or arg 1)))
- (setq this-command 'yank))
- (defun ses-yank-cells (text arg)
- "If the TEXT has a proper set of 'ses attributes, insert the text as
- cells, else return nil. The cells are reprinted--the supplied text is
- ignored because the column widths, default printer, etc. at yank time might
- be different from those at kill-time. ARG is a list to indicate that
- formulas are to be inserted without relocation."
- (let ((first (get-text-property 0 'ses text))
- (last (get-text-property (1- (length text)) 'ses text)))
- (when (and first last) ;;Otherwise not proper set of attributes
- (setq first (ses-sym-rowcol (car first))
- last (ses-sym-rowcol (car last)))
- (let* ((needrows (- (car last) (car first) -1))
- (needcols (- (cdr last) (cdr first) -1))
- (rowcol (ses-yank-resize needrows needcols))
- (rowincr (- (car rowcol) (car first)))
- (colincr (- (cdr rowcol) (cdr first)))
- (pos 0)
- myrow mycol x)
- (dotimes-with-progress-reporter (row needrows) "Yanking..."
- (setq myrow (+ row (car rowcol)))
- (dotimes (col needcols)
- (setq mycol (+ col (cdr rowcol))
- last (get-text-property pos 'ses text)
- pos (next-single-property-change pos 'ses text)
- x (ses-sym-rowcol (car last)))
- (if (not last)
- ;; Newline --- all remaining cells on row are skipped.
- (setq x (cons (- myrow rowincr) (+ needcols colincr -1))
- last (list nil nil nil)
- pos (1- pos)))
- (if (/= (car x) (- myrow rowincr))
- (error "Cell row error"))
- (if (< (- mycol colincr) (cdr x))
- ;; Some columns were skipped.
- (let ((oldcol mycol))
- (while (< (- mycol colincr) (cdr x))
- (ses-clear-cell myrow mycol)
- (setq col (1+ col)
- mycol (1+ mycol)))
- (ses-print-cell myrow (1- oldcol)))) ;; This inserts *skip*.
- (when (car last) ; Skip this for *skip* cells.
- (setq x (nth 2 last))
- (unless (equal x (ses-cell-printer myrow mycol))
- (or (not x)
- (stringp x)
- (eq (car-safe x) 'ses-safe-printer)
- (setq x `(ses-safe-printer ,x)))
- (ses-set-cell myrow mycol 'printer x))
- (setq x (cadr last))
- (if (atom arg)
- (setq x (ses-relocate-formula x 0 0 rowincr colincr)))
- (or (atom x)
- (eq (car-safe x) 'ses-safe-formula)
- (setq x `(ses-safe-formula ,x)))
- (ses-cell-set-formula myrow mycol x)))
- (when pos
- (if (get-text-property pos 'ses text)
- (error "Missing newline between rows"))
- (setq pos (next-single-property-change pos 'ses text))))
- t))))
- (defun ses-yank-one (rowcol text from to arg)
- "Insert the substring [FROM,TO] of TEXT as the formula for cell ROWCOL (a
- cons of ROW and COL). Treat plain symbols as strings unless ARG is a list."
- (let ((val (condition-case nil
- (read-from-string text from to)
- (error (cons nil from)))))
- (cond
- ((< (cdr val) (or to (length text)))
- ;; Invalid sexp --- leave it as a string.
- (setq val (substring text from to)))
- ((and (car val) (symbolp (car val)))
- (setq val (if (consp arg)
- (list 'quote (car val)) ; Keep symbol.
- (substring text from to)))) ; Treat symbol as text.
- (t
- (setq val (car val))))
- (let ((row (car rowcol))
- (col (cdr rowcol)))
- (or (atom val)
- (setq val `(ses-safe-formula ,val)))
- (ses-cell-set-formula row col val))))
- (defun ses-yank-tsf (text arg)
- "If TEXT contains tabs and/or newlines, treat the tabs as
- column-separators and the newlines as row-separators and insert the text as
- cell formulas--else return nil. Treat plain symbols as strings unless ARG
- is a list. Ignore a final newline."
- (if (or (not (string-match "[\t\n]" text))
- (= (match-end 0) (length text)))
- ;;Not TSF format
- nil
- (if (/= (aref text (1- (length text))) ?\n)
- (setq text (concat text "\n")))
- (let ((pos -1)
- (spots (list -1))
- (cols 0)
- (needrows 0)
- needcols rowcol)
- ;;Find all the tabs and newlines
- (while (setq pos (string-match "[\t\n]" text (1+ pos)))
- (push pos spots)
- (setq cols (1+ cols))
- (when (eq (aref text pos) ?\n)
- (if (not needcols)
- (setq needcols cols)
- (or (= needcols cols)
- (error "Inconsistent row lengths")))
- (setq cols 0
- needrows (1+ needrows))))
- ;;Insert the formulas
- (setq rowcol (ses-yank-resize needrows needcols))
- (dotimes (row needrows)
- (dotimes (col needcols)
- (ses-yank-one (cons (+ (car rowcol) needrows (- row) -1)
- (+ (cdr rowcol) needcols (- col) -1))
- text (1+ (cadr spots)) (car spots) arg)
- (setq spots (cdr spots))))
- (ses-goto-print (+ (car rowcol) needrows -1)
- (+ (cdr rowcol) needcols -1))
- t)))
- (defun ses-yank-resize (needrows needcols)
- "If this yank will require inserting rows and/or columns, ask for
- confirmation and then insert them. Result is (row,col) for top left of yank
- spot, or error signal if user requests cancel."
- (ses-begin-change)
- (let ((rowcol (if ses--curcell
- (ses-sym-rowcol ses--curcell)
- (cons ses--numrows 0)))
- rowbool colbool)
- (setq needrows (- (+ (car rowcol) needrows) ses--numrows)
- needcols (- (+ (cdr rowcol) needcols) ses--numcols)
- rowbool (> needrows 0)
- colbool (> needcols 0))
- (when (or rowbool colbool)
- ;;Need to insert. Get confirm
- (or (y-or-n-p (format "Yank will insert %s%s%s. Continue? "
- (if rowbool (format "%d rows" needrows) "")
- (if (and rowbool colbool) " and " "")
- (if colbool (format "%d columns" needcols) "")))
- (error "Canceled"))
- (when rowbool
- (let (ses--curcell)
- (save-excursion
- (ses-goto-print ses--numrows 0)
- (ses-insert-row needrows))))
- (when colbool
- (ses-insert-column needcols
- ses--numcols
- (ses-col-width (1- ses--numcols))
- (ses-col-printer (1- ses--numcols)))))
- rowcol))
- (defun ses-export-tsv (_beg _end)
- "Export values from the current range, with tabs between columns and
- newlines between rows. Result is placed in kill ring."
- (interactive "r")
- (ses-export-tab nil))
- (defun ses-export-tsf (_beg _end)
- "Export formulas from the current range, with tabs between columns and
- newlines between rows. Result is placed in kill ring."
- (interactive "r")
- (ses-export-tab t))
- (defun ses-export-tab (want-formulas)
- "Export the current range with tabs between columns and newlines between rows.
- Result is placed in kill ring. The export is values unless WANT-FORMULAS
- is non-nil. Newlines and tabs in the export text are escaped."
- (ses-check-curcell 'needrange)
- (let ((print-escape-newlines t)
- result item)
- (ses-dorange ses--curcell
- (setq item (if want-formulas
- (ses-cell-formula row col)
- (ses-cell-value row col)))
- (if (eq (car-safe item) 'ses-safe-formula)
- ;;Hide our deferred safety-check marker
- (setq item (cadr item)))
- (if (or (not item) (eq item '*skip*))
- (setq item ""))
- (when (eq (car-safe item) 'quote)
- (push "'" result)
- (setq item (cadr item)))
- (setq item (prin1-to-string item t))
- (setq item (replace-regexp-in-string "\t" "\\\\t" item))
- (push item result)
- (cond
- ((< col maxcol)
- (push "\t" result))
- ((< row maxrow)
- (push "\n" result))))
- (setq result (apply #'concat (nreverse result)))
- (kill-new result)))
- ;;----------------------------------------------------------------------------
- ;; Other user commands
- ;;----------------------------------------------------------------------------
- (defun ses-unset-header-row ()
- "Select the default header row."
- (interactive)
- (ses-set-header-row 0))
- (defun ses-set-header-row (row)
- "Set the ROW to display in the header-line.
- With a numerical prefix arg, use that row.
- With no prefix arg, use the current row.
- With a \\[universal-argument] prefix arg, prompt the user.
- The top row is row 1. Selecting row 0 displays the default header row."
- (interactive
- (list (if (numberp current-prefix-arg) current-prefix-arg
- (let ((currow (1+ (car (ses-sym-rowcol ses--curcell)))))
- (if current-prefix-arg
- (read-number "Header row: " currow)
- currow)))))
- (if (or (< row 0) (> row ses--numrows))
- (error "Invalid header-row"))
- (ses-begin-change)
- (let ((oldval ses--header-row))
- (let (buffer-undo-list)
- (ses-set-parameter 'ses--header-row row))
- (push `(apply ses-set-header-row ,oldval) buffer-undo-list))
- (ses-reset-header-string))
- (defun ses-mark-row ()
- "Mark the entirety of current row as a range."
- (interactive)
- (ses-check-curcell 'range)
- (let ((row (car (ses-sym-rowcol (or (car-safe ses--curcell) ses--curcell)))))
- (push-mark (point))
- (ses-goto-print (1+ row) 0)
- (push-mark (point) nil t)
- (ses-goto-print row 0)))
- (defun ses-mark-column ()
- "Mark the entirety of current column as a range."
- (interactive)
- (ses-check-curcell 'range)
- (let ((col (cdr (ses-sym-rowcol (or (car-safe ses--curcell) ses--curcell))))
- (row 0))
- (push-mark (point))
- (ses-goto-print (1- ses--numrows) col)
- (forward-char 1)
- (push-mark (point) nil t)
- (while (eq '*skip* (ses-cell-value row col))
- ;;Skip over initial cells in column that can't be selected
- (setq row (1+ row)))
- (ses-goto-print row col)))
- (defun ses-end-of-line ()
- "Move point to last cell on line."
- (interactive)
- (ses-check-curcell 'end 'range)
- (when ses--curcell ; Otherwise we're at the bottom row, which is empty
- ; anyway.
- (let ((col (1- ses--numcols))
- row rowcol)
- (if (symbolp ses--curcell)
- ;; Single cell.
- (setq row (car (ses-sym-rowcol ses--curcell)))
- ;; Range --- use whichever end of the range the point is at.
- (setq rowcol (ses-sym-rowcol (if (< (point) (mark))
- (car ses--curcell)
- (cdr ses--curcell))))
- ;; If range already includes the last cell in a row, point is actually
- ;; in the following row.
- (if (<= (cdr rowcol) (1- col))
- (setq row (car rowcol))
- (setq row (1+ (car rowcol)))
- (if (= row ses--numrows)
- ;;Already at end - can't go anywhere
- (setq col 0))))
- (when (< row ses--numrows) ; Otherwise it's a range that includes last cell.
- (while (eq (ses-cell-value row col) '*skip*)
- ;; Back to beginning of multi-column cell.
- (setq col (1- col)))
- (ses-goto-print row col)))))
- (defun ses-renarrow-buffer ()
- "Narrow the buffer so only the print area is visible.
- Use after \\[widen]."
- (interactive)
- (setq ses--deferred-narrow t))
- (defun ses-sort-column (sorter &optional reverse)
- "Sort the range by a specified column.
- With prefix, sorts in REVERSE order."
- (interactive "*sSort column: \nP")
- (ses-check-curcell 'needrange)
- (let ((min (ses-sym-rowcol (car ses--curcell)))
- (max (ses-sym-rowcol (cdr ses--curcell))))
- (let ((minrow (car min))
- (mincol (cdr min))
- (maxrow (car max))
- (maxcol (cdr max))
- keys extracts end)
- (setq sorter (cdr (ses-sym-rowcol (intern (concat sorter "1")))))
- (or (and sorter (>= sorter mincol) (<= sorter maxcol))
- (error "Invalid sort column"))
- ;;Get key columns and sort them
- (dotimes (x (- maxrow minrow -1))
- (ses-goto-print (+ minrow x) sorter)
- (setq end (next-single-property-change (point) 'cursor-intangible))
- (push (cons (buffer-substring-no-properties (point) end)
- (+ minrow x))
- keys))
- (setq keys (sort keys #'(lambda (x y) (string< (car x) (car y)))))
- ;;Extract the lines in reverse sorted order
- (or reverse
- (setq keys (nreverse keys)))
- (dolist (x keys)
- (ses-goto-print (cdr x) (1+ maxcol))
- (setq end (point))
- (ses-goto-print (cdr x) mincol)
- (push (ses-copy-region (point) end) extracts))
- (deactivate-mark)
- ;;Paste the lines sequentially
- (dotimes (x (- maxrow minrow -1))
- (ses-goto-print (+ minrow x) mincol)
- (ses-set-curcell)
- (ses-yank-cells (pop extracts) nil)))))
- (defun ses-sort-column-click (event reverse)
- "Mouse version of `ses-sort-column'."
- (interactive "*e\nP")
- (setq event (event-end event))
- (select-window (posn-window event))
- (setq event (car (posn-col-row event))) ; Click column.
- (let ((col 0))
- (while (and (< col ses--numcols) (> event (ses-col-width col)))
- (setq event (- event (ses-col-width col) 1)
- col (1+ col)))
- (if (>= col ses--numcols)
- (ding)
- (ses-sort-column (ses-column-letter col) reverse))))
- (defun ses-insert-range ()
- "Insert into minibuffer the list of cells currently highlighted in the
- spreadsheet."
- (interactive "*")
- (let (x)
- (with-current-buffer (window-buffer minibuffer-scroll-window)
- (ses-command-hook) ; For ses-coverage.
- (ses-check-curcell 'needrange)
- (setq x (cdr (macroexpand `(ses-range ,(car ses--curcell)
- ,(cdr ses--curcell))))))
- (insert (substring (prin1-to-string (nreverse x)) 1 -1))))
- (defun ses-insert-ses-range ()
- "Insert \"(ses-range x y)\" in the minibuffer to represent the currently
- highlighted range in the spreadsheet."
- (interactive "*")
- (let (x)
- (with-current-buffer (window-buffer minibuffer-scroll-window)
- (ses-command-hook) ; For ses-coverage.
- (ses-check-curcell 'needrange)
- (setq x (format "(ses-range %S %S)"
- (car ses--curcell)
- (cdr ses--curcell))))
- (insert x)))
- (defun ses-insert-range-click (event)
- "Mouse version of `ses-insert-range'."
- (interactive "*e")
- (mouse-set-point event)
- (ses-insert-range))
- (defun ses-insert-ses-range-click (event)
- "Mouse version of `ses-insert-ses-range'."
- (interactive "*e")
- (mouse-set-point event)
- (ses-insert-ses-range))
- (defun ses-replace-name-in-formula (formula old-name new-name)
- (let ((new-formula formula))
- (unless (and (consp formula)
- (eq (car-safe formula) 'quote))
- (while formula
- (let ((elt (car-safe formula)))
- (cond
- ((consp elt)
- (setcar formula (ses-replace-name-in-formula elt old-name new-name)))
- ((and (symbolp elt)
- (eq (car-safe formula) old-name))
- (setcar formula new-name))))
- (setq formula (cdr formula))))
- new-formula))
- (defun ses-rename-cell (new-name &optional cell)
- "Rename current cell."
- (interactive "*SEnter new name: ")
- (or
- (and (local-variable-p new-name)
- (ses-is-cell-sym-p new-name)
- (error "Already a cell name"))
- (and (boundp new-name)
- (null (yes-or-no-p
- (format-message
- "`%S' is already bound outside this buffer, continue? "
- new-name)))
- (error "Already a bound cell name")))
- (let* (curcell
- (sym (if (ses-cell-p cell)
- (ses-cell-symbol cell)
- (setq cell nil
- curcell t)
- (ses-check-curcell)
- ses--curcell))
- (rowcol (ses-sym-rowcol sym))
- (row (car rowcol))
- (col (cdr rowcol))
- new-rowcol old-name)
- (setq cell (or cell (ses-get-cell row col))
- old-name (ses-cell-symbol cell)
- new-rowcol (ses-decode-cell-symbol (symbol-name new-name)))
- (if new-rowcol
- (if (equal new-rowcol rowcol)
- (put new-name 'ses-cell rowcol)
- (error "Not a valid name for this cell location"))
- (setq ses--named-cell-hashmap
- (or ses--named-cell-hashmap (make-hash-table :test 'eq)))
- (put new-name 'ses-cell :ses-named)
- (puthash new-name rowcol ses--named-cell-hashmap))
- (push `(ses-rename-cell ,old-name ,cell) buffer-undo-list)
- ;; Replace name by new name in formula of cells refering to renamed cell.
- (dolist (ref (ses-cell-references cell))
- (let* ((x (ses-sym-rowcol ref))
- (xcell (ses-get-cell (car x) (cdr x))))
- (setf (ses-cell-formula xcell)
- (ses-replace-name-in-formula
- (ses-cell-formula xcell)
- sym
- new-name))))
- ;; Replace name by new name in reference list of cells to which renamed
- ;; cell refers to.
- (dolist (ref (ses-formula-references (ses-cell-formula cell)))
- (let* ((x (ses-sym-rowcol ref))
- (xcell (ses-get-cell (car x) (cdr x))))
- (setf (ses-cell-references xcell)
- (cons new-name (delq sym
- (ses-cell-references xcell))))))
- (push new-name ses--renamed-cell-symb-list)
- (set new-name (symbol-value sym))
- (setf (ses-cell--symbol cell) new-name)
- (makunbound sym)
- (and curcell (setq ses--curcell new-name))
- (let* ((pos (point))
- (inhibit-read-only t)
- (col (current-column))
- (end (save-excursion
- (move-to-column (1+ col))
- (if (eolp)
- (+ pos (ses-col-width col) 1)
- (point)))))
- (put-text-property pos end 'cursor-intangible new-name))
- ;; Update the cell name in the mode-line.
- (force-mode-line-update)))
- (defun ses-refresh-local-printer (name _compiled-value) ;FIXME: unused arg?
- "Refresh printout for all cells which use printer NAME.
- NAME should be the name of a locally defined printer.
- Uses the value COMPILED-VALUE for this printer."
- (message "Refreshing cells using printer %S" name)
- (let (new-print)
- (dotimes (row ses--numrows)
- (dotimes (col ses--numcols)
- (let ((cell-printer (ses-cell-printer row col)))
- (when (eq cell-printer name)
- (unless new-print
- (setq new-print t)
- (ses-begin-change))
- (ses-print-cell row col)))))))
- (defun ses-define-local-printer (name)
- "Define a local printer with name NAME."
- (interactive "*SEnter printer name: ")
- (let* ((cur-printer (gethash name ses--local-printer-hashmap))
- (default (and (vectorp cur-printer) (ses--locprn-def cur-printer)))
- create-printer
- (new-def
- (ses-read-printer (format "Enter definition of printer %S: " name)
- default)))
- (cond
- ;; cancelled operation => do nothing
- ((eq new-def t))
- ;; no change => do nothing
- ((and (vectorp cur-printer) (equal new-def default)))
- ;; re-defined printer
- ((vectorp cur-printer)
- (setq create-printer 0)
- (setf (ses--locprn-def cur-printer) new-def)
- (ses-refresh-local-printer
- name
- (setf (ses--locprn-compiled cur-printer)
- (ses-local-printer-compile new-def))))
- ;; new definition
- (t
- (setq create-printer 1)
- (puthash name
- (setq cur-printer
- (ses-make-local-printer-info new-def))
- ses--local-printer-hashmap)))
- (when create-printer
- (let ((printer-def-text
- (concat
- "(ses-local-printer "
- (symbol-name name)
- " "
- (prin1-to-string (ses--locprn-def cur-printer))
- ")")))
- (save-excursion
- (ses-goto-data ses--numrows
- (ses--locprn-number cur-printer))
- (let ((inhibit-read-only t))
- ;; Special undo since it's outside the narrowed buffer.
- (let (buffer-undo-list)
- (if (= create-printer 0)
- (delete-region (point) (line-end-position))
- (insert ?\n)
- (backward-char))
- (insert printer-def-text)
- (when (= create-printer 1)
- (ses-file-format-extend-parameter-list 3)
- (ses-set-parameter 'ses--numlocprn
- (+ ses--numlocprn create-printer))))))))))
- ;;----------------------------------------------------------------------------
- ;; Checking formulas for safety
- ;;----------------------------------------------------------------------------
- (defun ses-safe-printer (printer)
- "Return PRINTER if safe, or the substitute printer `ses-unsafe' otherwise."
- (if (or (stringp printer)
- (stringp (car-safe printer))
- (not printer)
- (and (symbolp printer) (gethash printer ses--local-printer-hashmap))
- (ses-warn-unsafe printer 'unsafep-function))
- printer
- 'ses-unsafe))
- (defun ses-safe-formula (formula)
- "Return FORMULA if safe, or the substitute formula *unsafe* otherwise."
- (if (ses-warn-unsafe formula 'unsafep)
- formula
- `(ses-unsafe ',formula)))
- (defun ses-warn-unsafe (formula checker)
- "Apply CHECKER to FORMULA.
- If result is non-nil, asks user for confirmation about FORMULA,
- which might be unsafe. Returns t if formula is safe or user allows
- execution anyway. Always returns t if `safe-functions' is t."
- (if (eq safe-functions t)
- t
- (setq checker (funcall checker formula))
- (if (not checker)
- t
- (y-or-n-p (format "Formula %S\nmight be unsafe %S. Process it? "
- formula checker)))))
- ;;----------------------------------------------------------------------------
- ;; Standard formulas
- ;;----------------------------------------------------------------------------
- (defun ses--clean-! (&rest x)
- "Clean by `delq' list X from any occurrence of nil or `*skip*'."
- (delq nil (delq '*skip* x)))
- (defun ses--clean-_ (x y)
- "Clean list X by replacing by Y any occurrence of nil or `*skip*'.
- This will change X by making `setcar' on its cons cells."
- (let ((ret x) ret-elt)
- (while ret
- (setq ret-elt (car ret))
- (when (memq ret-elt '(nil *skip*))
- (setcar ret y))
- (setq ret (cdr ret))))
- x)
- (defmacro ses-range (from to &rest rest)
- "Expand to a list of cell-symbols for the range going from
- FROM up to TO. The range automatically expands to include any
- new row or column inserted into its middle. The SES library code
- specifically looks for the symbol `ses-range', so don't create an
- alias for this macro!
- By passing in REST some flags one can configure the way the range
- is read and how it is formatted.
- In the sequel we assume that cells A1, B1, A2 B2 have respective values
- 1 2 3 and 4.
- Readout direction is specified by a `>v', '`>^', `<v', `<^',
- `v>', `v<', `^>', `^<' flag. For historical reasons, in absence
- of such a flag, a default direction of `^<' is assumed. This
- way `(ses-range A1 B2 ^>)' will evaluate to `(1 3 2 4)',
- while `(ses-range A1 B2 >^)' will evaluate to (3 4 1 2).
- If the range is one row, then `>' can be used as a shorthand to
- `>v' or `>^', and `<' to `<v' or `<^'.
- If the range is one column, then `v' can be used as a shorthand to
- `v>' or `v<', and `^' to `^>' or `v<'.
- A `!' flag will remove all cells whose value is nil or `*skip*'.
- A `_' flag will replace nil or `*skip*' by the value following
- the `_' flag. If the `_' flag is the last argument, then they are
- replaced by integer 0.
- A `*', `*1' or `*2' flag will vectorize the range in the sense of
- Calc. See info node `(Calc) Top'. Flag `*' will output either a
- vector or a matrix depending on the number of rows, `*1' will
- flatten the result to a one row vector, and `*2' will make a
- matrix whatever the number of rows.
- Warning: interaction with Calc is experimental and may produce
- confusing results if you are not aware of Calc data format.
- Use `math-format-value' as a printer for Calc objects."
- (let (result-row
- result
- (prev-row -1)
- (reorient-x nil)
- (reorient-y nil)
- transpose vectorize
- (clean 'list))
- (ses-dorange (cons from to)
- (when (/= prev-row row)
- (push result-row result)
- (setq result-row nil))
- (push (ses-cell-symbol row col) result-row)
- (setq prev-row row))
- (push result-row result)
- (while rest
- (let ((x (pop rest)))
- (pcase x
- (`>v (setq transpose nil reorient-x nil reorient-y nil))
- (`>^ (setq transpose nil reorient-x nil reorient-y t))
- (`<^ (setq transpose nil reorient-x t reorient-y t))
- (`<v (setq transpose nil reorient-x t reorient-y nil))
- (`v> (setq transpose t reorient-x nil reorient-y t))
- (`^> (setq transpose t reorient-x nil reorient-y nil))
- (`^< (setq transpose t reorient-x t reorient-y nil))
- (`v< (setq transpose t reorient-x t reorient-y t))
- ((or `* `*2 `*1) (setq vectorize x))
- (`! (setq clean 'ses--clean-!))
- (`_ (setq clean `(lambda (&rest x)
- (ses--clean-_ x ,(if rest (pop rest) 0)))))
- (_
- (cond
- ; shorthands one row
- ((and (null (cddr result)) (memq x '(> <)))
- (push (intern (concat (symbol-name x) "v")) rest))
- ; shorthands one col
- ((and (null (cdar result)) (memq x '(v ^)))
- (push (intern (concat (symbol-name x) ">")) rest))
- (t (error "Unexpected flag `%S' in ses-range" x)))))))
- (if reorient-y
- (setcdr (last result 2) nil)
- (setq result (cdr (nreverse result))))
- (unless reorient-x
- (setq result (mapcar #'nreverse result)))
- (when transpose
- (let ((ret (mapcar (lambda (x) (list x)) (pop result))) iter)
- (while result
- (setq iter ret)
- (dolist (elt (pop result))
- (setcar iter (cons elt (car iter)))
- (setq iter (cdr iter))))
- (setq result ret)))
- (cl-flet ((vectorize-*1
- (clean result)
- (cons clean (cons (quote 'vec) (apply #'append result))))
- (vectorize-*2
- (clean result)
- (cons clean (cons (quote 'vec)
- (mapcar (lambda (x)
- (cons clean (cons (quote 'vec) x)))
- result)))))
- (pcase vectorize
- (`nil (cons clean (apply #'append result)))
- (`*1 (vectorize-*1 clean result))
- (`*2 (vectorize-*2 clean result))
- (`* (funcall (if (cdr result)
- #'vectorize-*2
- #'vectorize-*1)
- clean result))))))
- (defun ses-delete-blanks (&rest args)
- "Return ARGS reversed, with the blank elements (nil and *skip*) removed."
- (let (result)
- (dolist (cur args)
- (unless (memq cur '(nil *skip* *error*))
- (push cur result)))
- result))
- (defun ses+ (&rest args)
- "Compute the sum of the arguments, ignoring blanks."
- (apply #'+ (apply #'ses-delete-blanks args)))
- (defun ses-average (list)
- "Computes the sum of the numbers in LIST, divided by their length. Blanks
- are ignored. Result is always floating-point, even if all args are integers."
- (setq list (apply #'ses-delete-blanks list))
- (/ (float (apply #'+ list)) (length list)))
- (defmacro ses-select (fromrange test torange)
- "Select cells in FROMRANGE that are `equal' to TEST.
- For each match, return the corresponding cell from TORANGE.
- The ranges are macroexpanded but not evaluated so they should be
- either (ses-range BEG END) or (list ...). The TEST is evaluated."
- (setq fromrange (cdr (macroexpand fromrange))
- torange (cdr (macroexpand torange))
- test (eval test t))
- (or (= (length fromrange) (length torange))
- (error "ses-select: Ranges not same length"))
- (let (result)
- (dolist (x fromrange)
- (if (equal test (symbol-value x))
- (push (car torange) result))
- (setq torange (cdr torange)))
- (cons 'list result)))
- ;;All standard formulas are safe
- (dolist (x '(ses-cell-value ses-range ses-delete-blanks ses+ ses-average
- ses-select))
- (put x 'side-effect-free t))
- ;;----------------------------------------------------------------------------
- ;; Standard print functions
- ;;----------------------------------------------------------------------------
- (defun ses-center (value &optional span fill)
- "Print VALUE, centered within column.
- FILL is the fill character for centering (default = space).
- SPAN indicates how many additional rightward columns to include
- in width (default = 0)."
- (let ((printer (or (ses-col-printer ses--col) ses--default-printer))
- (width (ses-col-width ses--col))
- half)
- (or fill (setq fill ?\s))
- (or span (setq span 0))
- (setq value (ses-call-printer printer value))
- (dotimes (x span)
- (setq width (+ width 1 (ses-col-width (+ ses--col span (- x))))))
- ;; Set column width.
- (setq width (- width (string-width value)))
- (if (<= width 0)
- value ; Too large for field, anyway.
- (setq half (make-string (/ width 2) fill))
- (concat half value half
- (if (> (% width 2) 0) (char-to-string fill))))))
- (defun ses-center-span (value &optional fill)
- "Print VALUE, centered within the span that starts in the current column
- and continues until the next nonblank column.
- FILL specifies the fill character (default = space)."
- (let ((end (1+ ses--col)))
- (while (and (< end ses--numcols)
- (memq (ses-cell-value ses--row end) '(nil *skip*)))
- (setq end (1+ end)))
- (ses-center value (- end ses--col 1) fill)))
- (defun ses-dashfill (value &optional span)
- "Print VALUE centered using dashes.
- SPAN indicates how many rightward columns to include in width (default = 0)."
- (ses-center value span ?-))
- (defun ses-dashfill-span (value)
- "Print VALUE, centered using dashes within the span that starts in the
- current column and continues until the next nonblank column."
- (ses-center-span value ?-))
- (defun ses-tildefill-span (value)
- "Print VALUE, centered using tildes within the span that starts in the
- current column and continues until the next nonblank column."
- (ses-center-span value ?~))
- (defun ses-unsafe (_value)
- "Substitute for an unsafe formula or printer."
- (error "Unsafe formula or printer"))
- ;;All standard printers are safe, including ses-unsafe!
- (dolist (x (cons 'ses-unsafe ses-standard-printer-functions))
- (put x 'side-effect-free t))
- (defun ses-unload-function ()
- "Unload the Simple Emacs Spreadsheet."
- (advice-remove 'yank #'ses--advice-yank)
- (advice-remove 'copy-region-as-kill #'ses--advice-copy-region-as-kill)
- ;; Continue standard unloading.
- nil)
- (provide 'ses)
- ;;; ses.el ends here
|