File: gnuplot-test-context.el

package info (click to toggle)
gnuplot-mode 1:0.7.0-2014-12-31-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster, sid
  • size: 1,392 kB
  • sloc: lisp: 6,002; sh: 494; makefile: 38
file content (446 lines) | stat: -rw-r--r-- 11,722 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
;;
;; automated tests for gnuplot-mode context matching
;;

(require 'gnuplot-context)

(require 'ert)

(eval-when-compile
  (require 'cl)
  (if (not (fboundp 'ert-deftest))
      (defalias 'ert-deftest 'deftest))

  (if (not (fboundp 'line-number-at-pos))
      (defalias 'line-number-at-pos 'line-number)))

(defun gnuplot-run-tests ()
  (interactive)
  (ert-run-tests-interactively "^gnuplot-"))


;;
(defun gnuplot-tokenize-string (string)
  (with-temp-buffer
    (gnuplot-mode)
    (insert string)
    (when (fboundp 'syntax-propertize)
      (syntax-propertize (point-max)))
    (goto-char (point-max))
    (gnuplot-tokenize)))

(defun gnuplot-simplify-tokens (tokens)
  (mapcar
   (lambda (token)
     (case (gnuplot-token-type token)
       (number
	(string-to-number (gnuplot-token-id token)))

       (string
	(gnuplot-token-id token))

       (end-of-command 'end-of-command)

       (otherwise
	(intern (gnuplot-token-id token)))))
   tokens))

;; compile a single pattern to usable form
(eval-and-compile
  (defun gnuplot-compile-pattern-1 (pattern)
    (gnuplot-compile-grammar `((rule ,pattern)) 'rule)))

;; match a string
(defun gnuplot-match-string (string rule)
  (if (vectorp rule)
      (gnuplot-match-pattern
       rule (gnuplot-tokenize-string string) nil)
    (gnuplot-match-pattern
     gnuplot-compiled-grammar
     (gnuplot-tokenize-string string)
     nil rule)))

;; with-gensyms
(defmacro with-gensyms (symbols &rest forms)
  (declare (indent 1))
  `(let ,(mapcar
	  (lambda (sym)
	    `(,sym (make-symbol ,(symbol-name sym))))
	  symbols)
     ,@forms))

;; test-defining macro
(defmacro should-match (rule &rest pairs)
  (declare (indent 1))
  (with-gensyms (tokens result rest)
    `(let ((rule ,(if (symbolp rule)
		      `(quote ,rule)
		    (gnuplot-compile-pattern-1 rule))))
       ,@(mapcar
	  (lambda (pair)
	    (if (stringp pair)
		(setq pair (list pair)))

	    (let ((string (car pair))
		  (rest (cadr pair)))
	      (if (eq rest :none)		; Shouldn't match anything
		  `(should
		    (null
		     (gnuplot-match-string ,string rule)))
		`(should (equal
			  (gnuplot-simplify-tokens
			   (car (gnuplot-match-string ,string rule)))
			  ,rest)))))
	  pairs))))


;;; The tests

;; Number
(ert-deftest gnuplot-number ()
  (should-match [number]
    ("123")
    (".05")
    ("1e7")))

;; name
(ert-deftest gnuplot-name ()
  (should-match [name]
    ("foo")
    ("name_with_underscores")
    ("var123")))

;; string-constant

;; Note that the id of a string constant token includes the delimiters
(ert-deftest gnuplot-string-constant ()
  (should-match [string]
    ("\"double quoted string\"")
    ("'single quoted'")))

;; sequence
(ert-deftest gnuplot-sequence ()
  (should-match [number name]
    ("1.34 name garbage" '(garbage))
    ("2.718 xy")
    ("1e9 123 2.718281828459045" :none)))

;; either
(ert-deftest gnuplot-either ()
  (should-match
      (either number name)
    ("1359, 349" '(\, 349))
    ("a_name . something" '(\. something))
    ("'quoted string constant' name" :none)))

;; many
(ert-deftest gnuplot-many ()
  (should-match (many number)
    ("123 456 789")
    ("not a number" '(not a number))
    (".89 3.1415 foo" '(foo)))
  (should-match (many name)
    ("foo bar baz")
    ("tom dick harry 1.34" '(1.34))))

;; maybe
(ert-deftest gnuplot-maybe ()
  (should-match (maybe name)
    ("foo bar baz" '(bar baz))
    ("1.23" '(1.23))
    ("'string' quux" '("'string'" quux))))

;; delimited list
(ert-deftest gnuplot-delimited-list ()
  (should-match (delimited-list number ":")
    ("1:2:3")
    ("1e2:2.78")
    ("9")
    ("17:xy" '(: xy))
    ("nan" :none))
  (should-match (delimited-list name ",")
    ("foo,bar,baz")
    ("x,y")
    ("x"))
  (should-match (delimited-list number "-")
    ("1 - 2 - 3, garbage" '(\, garbage))
    ("x - 2 - 3" :none)
    ("1 - 2 - y" '(- y))))

;; keyword
(ert-deftest gnuplot-keyword ()
  (should-match (either (kw ("w" . "ord"))
			(kw ("ot" . "her_word") "ow" "alt"))
    ("word")
    ("w")
    ("wo")
    ("wor")
    ("word thing" '(thing))
    ("o" :none)
    ("ot")
    ("oth")
    ("othx" :none)
    ("ow")
    ("alt")))

;; primary-expression
(ert-deftest gnuplot-primary-expression ()
  (should-match primary-expression
    ("name")
    ("123")
    ("{3,5}")
    ("$23")
    ("\"string\"")
    ("5!! + 2" '(+ 2))
    ("5 ** 9")
    ("foo[3:5]")
    ("(1,2,3)")
    ("fun(3.14,x)")
    ("3!!**2 ," '(\,))
    ("," :none)
    ("]" :none)))

(ert-deftest gnuplot-function-call ()
  (should-match function-call
    "abs(2)"
    "sin(pi*2)"
    "non_built_in(5+2)"
    "sprintf('%s*', columnheader(1))"
    "y(n)"))

;; expression
(ert-deftest gnuplot-infix-expression ()
  (should-match expression
    ("-2")
    ("!~foo ^ bar , " '(\,))
    ("1+2%7 >= 9")
    ("f && g ? 1 + 2 : 5**2")
    ("t ? y(n) : n")
    ("f ? g ? 1 : 2 : 3 + x")
    ("f ? fun(1, 3+5 ** 7) : g > h ? pi:e : garbage"
     '(: garbage))))

;; assignments
(ert-deftest gnuplot-assignment ()
  (should-match lhs
    ("x")
    ("long_identifier")
    ("1.9" :none)
    ("x(y)")
    ("fun(x_, y_) = " '(=))
    ("no_thunks()" '(\( \))))
  (should-match assignment
    ("x=2")
    ("x=y=3, garbage" '(\, garbage))
    ("f(a) = y(x) = 5")))

;; parenthesized exprs (including assignments)
(ert-deftest gnuplot-parenthesized-expression ()
  (should-match parenthesized-expression
    ("(sum = sum + $2, sum/2)")))

;; axis ranges
(ert-deftest gnuplot-axis-range ()
  (should-match axis-range
    ("[-pi:pi]")
    ("[-1:1]")
    ("[t = -10 :30]")
    ("[ ]")
    ("[-2:sin(5)*-8]")
    ("[:200]")
    ("[foo=:200]")
    ("[-pi:]")
    ("[bar=-pi:]")
    ("[baz=1:100*2:3/2]")
    ("[-pi:pi:0.2]")
    ("[\"1/6/93 12:00\":\"5/6/93 12:00\"]")))

;; iteration
(ert-deftest gnuplot-iteration-spec ()
  (should-match iteration-spec
    ("for [x = 1:9]")
    ("for [y=-2*pi:2*pi:0.1]")
    ("for [x = 1:9] for [y=-2*pi:2*pi:0.1]")
    ("for[1:2:3]" :none)))

;; plot expression, ignoring assignments
(ert-deftest gnuplot-plot-expression ()
  (should-match plot-expression
    ("sin(x) + 2")
    ("a=5, foo")
    ("b=9 5+2")
    ("i=3, j=sin(x)+9 k = 1**2!! f(x) garbage" '(garbage))))

;; plot modifiers
(ert-deftest gnuplot-plot-modifier ()
  (should-match plot-modifier
    ("lines 5 + 2")
    ("lw 9")

    ("titl 'string'[2:3]")
    ("notitle 'ignored'")
    ("notitle with lines" '(with lines))

    ("axes x1y2")
    ("axes" :none)
    ("axes 2 + 3" :none)))

(ert-deftest gnuplot-with-modifier ()
  (should-match with-modifier
    ("with impulses")
    ("w points")
    ("with l")
    ("w i")
    ("with boxes")
    ("w lines")
    ("w errorbars")))

(ert-deftest gnuplot-filledcurves ()
  (should-match filledcurves-style-clause
    ("filledcurves closed")
    ("filledcurves x1")
    ("filledcurves x2")
    ("filledcurves y1=0")
    ("filledcurves below y2=42")
    ("filledcurves xy=10,20")))

(ert-deftest gnuplot-plot-command ()
  (should-match plot-command
    ("plot sin(x) with impulses")
    ("plot x w points, x**2")
    ("plot [ ] [-2:5] tan(x), 'data.1' with l")
    ("plot 'leastsq.dat' w i")
    ("plot 'exper.dat' w lines, 'exper.dat' notitle w errorbars")
    ("plot sin(x) with linesp lt 1 pt 3, cos(x) with linesp lt 1 pt 4")
    ("plot 'data' with points pointtype 3 pointsize 2")
    ("plot 'data' using 1:2:4 with points pt 5 pointsize variable")
    ("plot 'd1' t \"good\" w l lt 2 lw 3, 'd2' t \"bad\" w l lt 2 lw 1")
    ("plot x*x with filledcurve closed, 40 with filledcurve y1=10")
    ("plot x*x, (x>=-5 && x<=5 ? 40 : 1/0) with filledcurve y1=10 lt 8")))

;;; set cntrparam
(ert-deftest gnuplot-cntrparam ()
  (should-match set-cntrparam-clause
    ("cntrparam bspline")
    ("cntrparam points 7")
    ("cntrparam order 10")
    ("cntrparam levels auto 5")
    ("cntrparam levels discrete .1,1/exp(1),.9")
    ("cntrparam levels incremental  0,1,4")
    ("cntrparam levels 10")
    ("cntrparam levels incremental 100,50")))



;;
;; test by parsing all the demos from the Gnuplot source tree
;;
;; currently (Oct 2012) successfully parses about 84% of all
;; non-comment lines in the Gnuplot demos, tho I think there are some
;; false negatives in there too.
;;

;; Set this to wherever the gnuplot demos are
(defvar gnuplot-demo-dir (getenv "GNUPLOT_DEMO_DIR"))

(defvar gnuplot-test-result-buffer "*gnuplot parse test results*")
(defvar gnuplot-test-count 0)
(defvar gnuplot-test-success-count 0)

(ert-deftest gnuplot-test-all-demos ()
  (let ((demo-dir-exists (and (stringp gnuplot-demo-dir)
                              (file-directory-p gnuplot-demo-dir))))
    (unless demo-dir-exists
      (message "Directory `%s' not found, skipping test" gnuplot-demo-dir)
      (message "(Set the environment variable GNUPLOT_DEMO_DIR to run it.)"))
    (skip-unless demo-dir-exists)
    (should (> (gnuplot-test-parse-all-demos)
               .83))))

(defun gnuplot-test-parse-all-demos ()
  (interactive)
  (let* ((bufname "*gnuplot parse test results*")
	 (gnuplot-test-result-buffer
	  (progn
	    (and bufname (get-buffer bufname)
		 (kill-buffer bufname))
	    (get-buffer-create bufname)))
	 (gnuplot-test-count 0)
	 (gnuplot-test-success-count 0)
	 (demo-files (directory-files gnuplot-demo-dir t "^[^.].*\\.dem$"))
	 (n-files (length demo-files))
	 (n 0))

    (switch-to-buffer-other-window gnuplot-test-result-buffer)

    (catch 'done
      (dolist (fname demo-files)

	(with-temp-buffer
	  (insert-file-contents fname)
	  (gnuplot-mode)
	  (message "Testing on file %s of %s: %s..."
		   (incf n) n-files fname)
	  (condition-case err
	      (gnuplot-test-parse-buffer (current-buffer) fname)
	    (error
	     (with-current-buffer gnuplot-test-result-buffer
	       (insert (format "ERROR in %s: %s" fname err)))))
	  (message "Testing on file %s of %s: %s... done"
		   n n-files fname)
	  (with-current-buffer gnuplot-test-result-buffer
	    (goto-char (point-max))
	    (recenter)
            (redisplay t)))))
    (let ((success-rate
           (/ (+ gnuplot-test-success-count 0.0)
              gnuplot-test-count)))
      (with-current-buffer gnuplot-test-result-buffer
        (insert (format "\n\nPassed %s out of %s tests (%.2f%%)\n"
                        gnuplot-test-success-count
                        gnuplot-test-count
                        (* 100 success-rate))))
      (compilation-mode)
      success-rate)))

(defun gnuplot-test-parse-buffer (&optional buffer fname)
  (interactive nil)
  (let ((buffer (or buffer (current-buffer)))
	(fname (or fname (buffer-file-name))))
    (with-current-buffer buffer
      (goto-char (point-min))
      (while (not (eobp))
	(let ((ln (line-number-at-pos))
	      (tokens (progn
			(gnuplot-end-of-command)
			(gnuplot-tokenize))))
	  (when (> (length tokens) 1)
	    (let ((result
		   (gnuplot-match-pattern
		    gnuplot-compiled-grammar
		    tokens nil)))
	      (incf gnuplot-test-count)
	      (if (equal result '(nil))
		  (incf gnuplot-test-success-count)
		(let ((cmd
		       (buffer-substring
			(gnuplot-point-at-beginning-of-command)
			(gnuplot-point-at-end-of-command))))
		  (with-current-buffer
		      (get-buffer-create gnuplot-test-result-buffer)
		    (insert
		     (format "FAILED at %s:%s\n\t%s\n" fname ln cmd))
		    (when (not (null result))
		      (insert
		       (format "\tUNMATCHED TOKENS were: %s\n"
			       (gnuplot-simplify-tokens (car result)))))))))))
	(gnuplot-beginning-of-defun -1)))))

(when (boundp 'compilation-error-regexp-alist-alist)
  (add-to-list 'compilation-error-regexp-alist-alist
               '(gnuplot-test-errors
                 "^FAILED at \\([^:]*\\):\\([0-9]*\\)" 1 2))

  (add-to-list 'compilation-error-regexp-alist 'gnuplot-test-errors))

(provide 'gnuplot-test-context)