1 ;;;; testcover-ses.el -- Example use of `testcover' to test "SES"
3 ;; Copyright (C) 2002 Free Software Foundation, Inc.
5 ;; Author: Jonathan Yavner <jyavner@engineer.com>
6 ;; Maintainer: Jonathan Yavner <jyavner@engineer.com>
7 ;; Keywords: spreadsheet lisp utility
9 ;; GNU Emacs is free software; you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;; GNU General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs; see the file COPYING. If not, write to the
21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 ;; Boston, MA 02111-1307, USA.
26 ;;;Here are some macros that exercise SES. Set `pause' to t if you want the
27 ;;;macros to pause after each step.
29 (x (if pause
"\x18q" ""))
30 (y "\x18\x06ses-test.ses\r\e<"))
31 ;;Fiddle with the existing spreadsheet
32 (fset 'ses-exercise-example
33 (concat "\x18\x06" data-directory
"ses-example.ses\r\e<"
37 x
"\x10\x10\x06pses-center\r"
41 x
"\x15\x0e\x02\x02\x02"
48 x
"(+ \x18o\x0e\x0e\x06\0\x06\x06"
49 x
"\x15-1\x18o\x03\x12 \x03\x13\r\x02"
52 ;;Create a new spreadsheet
53 (fset 'ses-exercise-new
55 x
"\x03\x10\"%.8g\"\r"
67 x
"\r\x7f\x7f\x7fB3\r"
71 (fset 'ses-exercise-display
72 (concat y
"\e:(revert-buffer t t)\r"
98 x
"\x02\x02\x02\"1234567-1234567-1234567\r\x02"
101 x
"\x0e\"1234567-1234567-1234567\r\x02"
104 x
"\x02\x02\"1234567\r"
108 (fset 'ses-exercise-formulas
109 (concat y
"\e:(revert-buffer t t)\r"
112 x
"(* B1 B2 D1\r\x02"
114 x
"\x0e(apply '+ (ses-range B1 B3)\r\x02"
115 x
"(apply 'ses+ (ses-range B1 B3)\r\x02"
116 x
"\x0e(apply 'ses+ (ses-range A2 A3)\r\x02"
117 x
"\x0e(mapconcat'number-to-string(ses-range B2 B4) \"-\"\r\x02"
118 x
"\x02(apply 'concat (reverse (ses-range A3 D3))\r\x02"
119 x
"\x02(* (+ A2 A3) (ses+ B2 B3)\r\x02"
123 x
"\x10(apply 'ses+ (ses-range E1 E2)\r\x02"
124 x
"\x10(apply 'ses+ (ses-range A5 B5)\r\x02"
125 x
"\x10(apply 'ses+ (ses-range E1 F1)\r\x02"
126 x
"\x10(apply 'ses+ (ses-range D1 E1)\r\x02"
128 x
"(ses-average (ses-range A2 A5)\r\x02"
129 x
"\x0e(apply 'ses+ (ses-range A5 A6)\r\x02"
138 x
"\x06(ses-average (ses-range B3 E3)\r\x02"
140 x
"\x0e\x1012345678\r\x02"
142 ;;Recalculating and reconstructing
143 (fset 'ses-exercise-recalc
144 (concat y
"\e:(revert-buffer t t)\r"
152 x
"\x03\x10\"%.6g\"\r"
154 x
"\e>\x18nw\x06\x06\x06"
155 x
"\0\e>\exdelete-region\r"
158 x
"\0\e>\exdelete-region\r"
163 x
"\x02\"Very long\r"
169 x
"\x02\x02\"Very long2\r"
172 x
"\r\x7f\x7f\x7fC3\r"
173 x
"\x0e\r\x7f\x7f\x7fC2\r"
174 x
"\x10\0\x0e\x06\x03\x03"
176 x
"\x0e\x0e\r\x7f\x7f\x7fC2\r"
177 x
"\x06\0\x02\x10\x10"
184 (fset 'ses-exercise-header-row
185 (concat y
"\e:(revert-buffer t t)\r"
200 ;;Detecting unsafe formulas and printers
201 (fset 'ses-exercise-unsafe
202 (concat y
"\e:(revert-buffer t t)\r"
203 x
"p(lambda (x) (delete-file x))\rn"
204 x
"p(lambda (x) (delete-file \"ses-nothing\"))\ry"
206 x
"\x0e(delete-file \"x\"\rn"
207 x
"(delete-file \"ses-nothing\"\ry\x02"
209 x
"(open-network-stream \"x\" nil \"localhost\" \"smtp\"\ry\x02"
212 ;;Inserting and deleting rows
213 (fset 'ses-exercise-rows
214 (concat y
"\e:(revert-buffer t t)\r"
216 x
"\x03\x10\"%s=\"\r"
224 x
"\x10\x10(not B25\r\x02"
229 x
"\x15100\x0f" ;Make this approx your CPU speed in MHz
231 ;;Inserting and deleting columns
232 (fset 'ses-exercise-columns
233 (concat y
"\e:(revert-buffer t t)\r"
234 x
"\x03\x10\"%s@\"\r"
246 x
"\x03\x10\"%.6g\"\r"
254 x
"\0\x0e\x0e\x06\x06\x03\e\x13D"
256 (fset 'ses-exercise-editing
257 (concat y
"\e:(revert-buffer t t)\r"
258 x
"\x0e\x0e\x0e1\r\x02"
259 x
"\x06(\x02'\x06x\r\x02"
260 x
"\x02\x10\x10\x10\x0f"
265 x
"\x0e\x06\r\x02 10\r"
274 x
"\x02\"Very long\r\x02"
282 x
"\x06\x06\x152\x7f"
287 x
"\"Also very long\r\x02"
291 x
"\x0e\x02'qwerty\r\x02"
292 x
"\x06(concat \x18o\e<\0\x0e\x0e"
293 x
"\x15-1\x18o\x03\x12\r\x02"
294 x
"(apply '+ \x18o\e<\0\x0e\x06\x15-1\x18o\x03\x13\r\x02"
302 x
"\"Another long one\r\x02"
311 (fset 'ses-exercise-sort-column
312 (concat y
"\e:(revert-buffer t t)\r"
318 x
"\0\x10\x10\x10\x03\e\x13A\r"
319 x
"\x0e\0\x10\x10\x10\x03\e\x13B\r"
320 x
"\x10\x10\x06\0\x0e\x0e\x06\x06\x03\e\x13C\r"
322 x
"\x02\0\x0e\x0e\x0e\x15\x03\e\x13C\r"
324 ;;Simple cell printers
325 (fset 'ses-exercise-cell-printers
326 (concat y
"\e:(revert-buffer t t)\r"
327 x
"\x06\"4\x11\t76\r\x02"
341 x
"\x02\0\x06\x06pnil\r"
349 x
"\x03\x10\"%.6g#\"\r"
350 x
"\x03\x10\"%.6g.\"\r"
351 x
"\x03\x10\"%.6g.\"\r"
354 x
"\x0e\"UPCASE\r\x02"
357 x
"p(lambda\x11 (x)\x11 '(\"Hi\"))\r"
358 x
"p(lambda\x11 (x)\x11 '(\"Bye\"))\r"
360 ;;Spanning cell printers
361 (fset 'ses-exercise-spanning-printers
362 (concat y
"\e:(revert-buffer t t)\r"
364 x
"pses-dashfill-span\r"
366 x
"pses-tildefill-span\r"
372 x
"\t\"12345678\r\x02"
373 x
"pses-dashfill-span\r"
388 ;;Cut/copy/paste - within same buffer
389 (fset 'ses-exercise-paste-1buf
390 (concat y
"\e:(revert-buffer t t)\r"
392 x
"\x03\x03\x10\x06\x19"
403 x
"\x10\x10\x06\x15\x19y"
409 x
"\x06pses-dashfill\r"
410 x
"\x02\0\x06\x06\x06\x0e\x0e\x0e"
414 x
"\r\0\x02\x02\x02\ew"
416 x
"\x153\x10(+ G2 H1\r"
420 x
"\x02\x158\x10(ses-average (ses-range G2 H2)\r\x02"
424 x
"\x10\x02(ses-average (ses-range E7 E9)\r\x02"
427 x
"\x02\x02\x10(ses-average (ses-range E7 F7)\r\x02"
430 x
"\x02\x02\x10(ses-average (ses-range D6 E6)\r\x02"
435 x
"pses-tildefill-span\r"
436 x
"\x0e\x06\"Subline A(1)\r\x02"
437 x
"pses-dashfill-span\r"
438 x
"\x02\x10\0\x0e\x0e\x0e\ew\x03\x03"
439 x
"\x01\x10\x10\x10\x10\x10\x10"
441 x
"\0\x0e\x06\x06\ew\x03\x03"
444 ;;Cut/copy/paste - between two buffers
445 (fset 'ses-exercise-paste-2buf
446 (concat y
"\e:(revert-buffer t t)\r"
447 x
"\x06\x0e\eo\"middle\r\x02\0\x06\x0e\x06"
449 x
"\x184bses-test.txt\r"
451 x
"\x05\"xxx\0\x02\x02\x02\x02"
455 x
"\x18o\x05\"\0\x02\x02\x02\x02\x02"
457 x
"\x18o123.45\0\x02\x02\x02\x02\x02\x02"
459 x
"\x18o1 \x02\x02\0\x06\x06\x06\x06\x06\x06\x06"
462 x
"\x06\x18o symb\0\x02\x02\x02\x02"
463 x
"\x17\x18o\x15\x19\ey\x152\ey"
464 x
"\x18o1\t\0\x02\x02"
465 x
"\x17\x18o\x02\x19"
466 x
"w9\n\ep\"<%s>\"\n"
467 x
"\x18o\n2\t\"3\nxxx\t5\n\0\x10\x10"
470 ;;Export text, import it back
471 (fset 'ses-exercise-import-export
472 (concat y
"\e:(revert-buffer t t)\r"
473 x
"\x0e\x0e\x06\0\x06xt"
474 x
"\x184bses-test.txt\r"
475 x
"\n\x19\x15-1\x18o"
476 x
"xT\x18o\x19\x15-1\x18o"
477 x
"\x03\x03\x06'crunch\r\x02"
478 x
"\x10\x10\x10pses-center-span\r"
479 x
"\0\x0e\x0e\x0e\x0exT"
480 x
"\x18o\n\x19\x15-1\x18o"
482 x
"\x06\0\x02\x10\x10xt"
483 x
"\x0e\x0e\0\x15\x19y"
489 (defun ses-exercise-macros ()
490 "Executes all SES coverage-test macros."
491 (dolist (x '(ses-exercise-example
494 ses-exercise-formulas
496 ses-exercise-header-row
501 ses-exercise-sort-column
502 ses-exercise-cell-printers
503 ses-exercise-spanning-printers
504 ses-exercise-paste-1buf
505 ses-exercise-paste-2buf
506 ses-exercise-import-export
))
507 (message "<Testing %s>" x
)
508 (execute-kbd-macro x
)))
510 (defun ses-exercise-signals ()
511 "Exercise code paths that lead to error signals, other than those for
512 spreadsheet files with invalid formatting."
513 (message "<Checking for expected errors>")
514 (switch-to-buffer "ses-test.ses")
518 (dolist (x '((ses-column-widths 14)
519 (ses-column-printers "%s")
520 (ses-column-printers ["%s" "%s" "%s"]) ;Should be two
521 (ses-column-widths [14])
522 (ses-delete-column -99)
523 (ses-delete-column 2)
525 (ses-goto-data 'hogwash)
528 (ses-insert-column -14)
530 (ses-jump 'B8) ;Covered by preceding cell
531 (ses-printer-validate '("%s" t))
532 (ses-printer-validate '([47]))
533 (ses-read-header-row -1)
534 (ses-read-header-row 32767)
535 (ses-relocate-all 0 0 -1 1)
536 (ses-relocate-all 0 0 1 -1)
537 (ses-select (ses-range A1 A2) 'x (ses-range B1 B1))
538 (ses-set-cell 0 0 'hogwash nil)
539 (ses-set-column-width 0 0)
540 (ses-yank-cells #("a\nb"
541 0 1 (ses (A1 nil nil))
542 2 3 (ses (A3 nil nil)))
544 (ses-yank-cells #("ab"
545 0 1 (ses (A1 nil nil))
546 1 2 (ses (A2 nil nil)))
549 (ses-yank-tsf "1\t2\n3" nil)
550 (let ((curcell nil)) (ses-check-curcell))
551 (let ((curcell 'A1)) (ses-check-curcell 'needrange))
552 (let ((curcell '(A1 . A2))) (ses-check-curcell 'end))
553 (let ((curcell '(A1 . A2))) (ses-sort-column "B"))
554 (let ((curcell '(C1 . D2))) (ses-sort-column "B"))
555 (execute-kbd-macro "jB10\n\x152\x04")
556 (execute-kbd-macro [?j ?B ?9 ?\n ?C-@ ?C-f ?C-f cut])
557 (progn (kill-new "x") (execute-kbd-macro "\e>\x19n"))
558 (execute-kbd-macro "\x02\0\ew")))
562 (signal 'singularity-error nil)) ;Shouldn't get here
563 (singularity-error (error "No error from %s?" x))
565 ;;Test quit-handling in ses-update-cells. Cant' use `eval' here.
566 (let ((inhibit-quit t))
570 (ses-update-cells '(A1))
571 (signal 'singularity-error nil))
572 (singularity-error (error "Quit failure in ses-update-cells"))
574 (setq quit-flag nil)))
576 (defun ses-exercise-invalid-spreadsheets ()
577 "Execute code paths that detect invalid spreadsheet files."
578 ;;Detect invalid spreadsheets
579 (let ((p&d "\n\n\f\n(ses-cell A1 nil nil nil nil)\n\n")
580 (cw "(ses-column-widths [7])\n")
581 (cp "(ses-column-printers [ses-center])\n")
582 (dp "(ses-default-printer \"%.7g\")\n")
583 (hr "(ses-header-row 0)\n")
585 (igp ses-initial-global-parameters))
586 (dolist (x (list "(1)"
594 "\n\n\f\n(ses-cell)(2 1 1)"
595 "\n\n\f\n(x)\n(2 1 1)"
596 "\n\n\n\f\n(ses-cell A2)\n(2 2 2)"
597 "\n\n\n\f\n(ses-cell B1)\n(2 2 2)"
598 "\n\n\f\n(ses-cell A1 nil nil nil nil)\n(2 1 1)"
599 (concat p&d "(x)\n(x)\n(x)\n(x)\n" p11)
600 (concat p&d "(ses-column-widths)(x)\n(x)\n(x)\n" p11)
601 (concat p&d cw "(x)\n(x)\n(x)\n(2 1 1)")
602 (concat p&d cw "(ses-column-printers)(x)\n(x)\n" p11)
603 (concat p&d cw cp "(x)\n(x)\n" p11)
604 (concat p&d cw cp "(ses-default-printer)(x)\n" p11)
605 (concat p&d cw cp dp "(x)\n" p11)
606 (concat p&d cw cp dp "(ses-header-row)" p11)
607 (concat p&d cw cp dp hr p11)
608 (concat p&d cw cp dp "\n" hr igp)))
613 (signal 'singularity-error nil)) ;Shouldn't get here
614 (singularity-error (error "%S is an invalid spreadsheet!" x))
617 (defun ses-exercise-startup ()
618 "Prepare for coverage tests"
619 ;;Clean up from any previous runs
620 (condition-case nil (kill-buffer "ses-example.ses") (error nil))
621 (condition-case nil (kill-buffer "ses-test.ses") (error nil))
622 (condition-case nil (delete-file "ses-test.ses") (file-error nil))
623 (delete-other-windows) ;Needed for "\C-xo" in ses-exercise-editing
624 (setq ses-mode-map nil) ;Force rebuild
625 (testcover-unmark-all "ses.el")
627 (let ((testcover-1value-functions
628 ;;forward-line always returns 0, for us.
629 ;;remove-text-properties always returns t for us.
630 ;;ses-recalculate-cell returns the same " " any time curcell is a cons
631 ;;Macros ses-dorange and ses-dotimes-msg generate code that always
633 (append '(forward-line remove-text-properties ses-recalculate-cell
634 ses-dorange ses-dotimes-msg)
635 testcover-1value-functions))
637 ;;These maps get initialized, then never changed again
638 (append '(ses-mode-map ses-mode-print-map ses-mode-edit-map)
639 testcover-constants)))
640 (testcover-start "ses.el" t))
641 (require 'unsafep)) ;In case user has safe-functions = t!
644 ;;;#########################################################################
645 (defun ses-exercise ()
646 "Executes all SES coverage tests and displays the results."
648 (ses-exercise-startup)
649 ;;Run the keyboard-macro tests
650 (let ((safe-functions nil)
651 (ses-initial-size '(1 . 1))
652 (ses-initial-column-width 7)
653 (ses-initial-default-printer "%.7g")
654 (ses-after-entry-functions '(forward-char))
656 (ses-exercise-macros)
657 (ses-exercise-signals)
658 (ses-exercise-invalid-spreadsheets)
659 ;;Upgrade of old-style spreadsheet
661 (insert " \n\n\f\n(ses-cell A1 nil nil nil nil)\n\n(ses-column-widths [7])\n(ses-column-printers [nil])\n(ses-default-printer \"%.7g\")\n\n( ;Global parameters (these are read first)\n 1 ;SES file-format\n 1 ;numrows\n 1 ;numcols\n)\n\n")
663 ;;ses-vector-delete is always called from buffer-undo-list with the same
664 ;;symbol as argument. We'll give it a different one here.
666 (ses-vector-delete 'x 0 0))
667 ;;ses-create-header-string behaves differently in a non-window environment
668 ;;but we always test under windows.
669 (let ((window-system (not window-system)))
671 (ses-create-header-string))
672 ;;Test for nonstandard after-entry functions
673 (let ((ses-after-entry-functions '(forward-line))
675 (ses-read-cell 0 0 1)
676 (ses-read-symbol 0 0 t)))
677 ;;Tests with unsafep disabled
678 (let ((safe-functions t)
680 (message "<Checking safe-functions = t>")
681 (kill-buffer "ses-example.ses")
682 (find-file "ses-example.ses"))
683 ;;Checks for nonstandard default values for new spreadsheets
685 (dolist (x '(("%.6g" 8 (2 . 2))
687 (let ((ses-initial-size (nth 2 x))
688 (ses-initial-column-width (nth 1 x))
689 (ses-initial-default-printer (nth 0 x)))
691 (set-buffer-modified-p t)
693 ;;Test error-handling in command hook, outside a macro.
694 ;;This will ring the bell.
695 (let (curcell-overlay)
697 ;;Due to use of run-with-timer, ses-command-hook sometimes gets called
698 ;;after we switch to another buffer.
699 (switch-to-buffer "*scratch*")
702 (message "<Marking source code>")
703 (testcover-mark-all "ses.el")
704 (testcover-next-mark)
706 (delete-other-windows)
707 (kill-buffer "ses-test.txt")
708 ;;Could do this here: (testcover-end "ses.el")
711 ;; testcover-ses.el ends here.