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
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
| | ;;; lisp-tests.el --- Test Lisp editing commands -*- lexical-binding: t; -*-
;; Copyright (C) 2013-2017 Free Software Foundation, Inc.
;; Author: Aaron S. Hawley <aaron.s.hawley@gmail.com>
;; Author: Stefan Monnier <monnier@iro.umontreal.ca>
;; Author: Daniel Colascione <dancol@dancol.org>
;; Author: Marcin Borkowski <mbork@mbork.pl>
;; Keywords: internal
;; 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 <https://www.gnu.org/licenses/>.
;;; Commentary:
;; Testing of `forward-sexp' and related functions.
;;; Code:
(require 'ert)
(require 'python)
(require 'cl-lib)
(ert-deftest lisp-forward-sexp-1-empty-parens ()
"Test basics of \\[forward-sexp]."
(with-temp-buffer
(insert "()")
(goto-char (point-min))
(should (null
(forward-sexp 1)))))
(ert-deftest lisp-forward-sexp-1-error-mismatch ()
"Test basics of \\[forward-sexp]."
(with-temp-buffer
(insert "(")
(goto-char (point-min))
(should-error
(forward-sexp 1))))
(ert-deftest lisp-backward-sexp-1-empty-parens ()
"Test basics of \\[backward-sexp]."
(with-temp-buffer
(insert "()")
(should (null
(forward-sexp -1)))))
(ert-deftest lisp-backward-sexp-1-error-mismatch ()
"Test mismatched parens with \\[backward-sexp]."
(with-temp-buffer
(insert "(")
(should-error
(forward-sexp -1))))
(ert-deftest lisp-forward-sexp-1-eobp ()
"Test \\[forward-sexp] at `eobp'."
(with-temp-buffer
(insert "()")
(should (null ;; (should-error ;; No, per #13994
(forward-sexp 1)))))
(ert-deftest lisp-backward-sexp-1-eobp ()
"Test \\[backward-sexp] at `bobp'."
(with-temp-buffer
(insert "()")
(goto-char (point-min))
(should (null ;; (should-error ;; No, per #13994
(forward-sexp -1)))))
(ert-deftest lisp-forward-sexp-2-eobp ()
"Test \\[forward-sexp] beyond `eobp'."
(with-temp-buffer
(insert "()")
(goto-char (point-min))
(should (null ;; (should-error ;; No, per #13994
(forward-sexp 2)))
(should (eobp))))
(ert-deftest lisp-backward-sexp-2-bobp ()
"Test \\[backward-sexp] beyond `bobp'."
(with-temp-buffer
(insert "()")
(should (null ;; (should-error ;; No, per #13994
(forward-sexp -2)))
(should (bobp))))
(ert-deftest lisp-forward-sexp-2-eobp-and-subsequent ()
"Test \\[forward-sexp] beyond `eobp' and again."
(with-temp-buffer
(insert "()")
(goto-char (point-min))
(should (null ;; (should-error ;; No, per #13994
(forward-sexp 2)))
(should (eobp))
(should (null ;; (should-error ;; No, per #13994
(forward-sexp 1)))))
(ert-deftest lisp-backward-sexp-2-bobp-and-subsequent ()
"Test \\[backward-sexp] ahead of `bobp' and again."
(with-temp-buffer
(insert "()")
(should (null ;; (should-error ;; No, per #13994
(forward-sexp -2)))
(should (bobp))
(should (null ;; (should-error ;; No, per #13994
(forward-sexp -1)))))
(ert-deftest lisp-delete-pair-parens ()
"Test \\[delete-pair] with parens."
(with-temp-buffer
(insert "(foo)")
(goto-char (point-min))
(delete-pair)
(should (string-equal "foo" (buffer-string)))))
(ert-deftest lisp-delete-pair-quotation-marks ()
"Test \\[delete-pair] with quotation marks."
(with-temp-buffer
(insert "\"foo\"")
(goto-char (point-min))
(delete-pair)
(should (string-equal "foo" (buffer-string)))))
(ert-deftest lisp-delete-pair-quotes-in-text-mode ()
"Test \\[delete-pair] against string in Text Mode for #15014."
(with-temp-buffer
(text-mode)
(insert "\"foo\"")
(goto-char (point-min))
(delete-pair)
(should (string-equal "fo\"" (buffer-string)))))
(ert-deftest lisp-delete-pair-quotes-text-mode-syntax-table ()
"Test \\[delete-pair] with modified Text Mode syntax for #15014."
(with-temp-buffer
(text-mode)
(let ((st (copy-syntax-table text-mode-syntax-table)))
(with-syntax-table st
;; (modify-syntax-entry ?\" "." text-mode-syntax-table)
(modify-syntax-entry ?\" "$" st)
(insert "\"foo\"")
(goto-char (point-min))
(delete-pair)
(should (string-equal "foo" (buffer-string)))))))
(ert-deftest lisp-forward-sexp-elisp-inside-symbol ()
"Test \\[forward-sexp] on symbol in Emacs Lisp Mode for #20492."
(with-temp-buffer
(emacs-lisp-mode)
(insert "hide-ifdef-env ")
(insert (concat (number-sequence 32 126)))
(goto-char (point-min))
(re-search-forward "hide" nil t) ;; (forward-char 4)
(should (looking-at "-"))
(forward-sexp)
(should (looking-at " "))))
(ert-deftest lisp-forward-sexp-elisp-quoted-symbol ()
"Test \\[forward-sexp] on symbol in Emacs Lisp Mode for #20492."
(with-temp-buffer
(emacs-lisp-mode)
(insert "`hide-ifdef-env'.")
(goto-char (point-min))
(re-search-forward "hide" nil t) ;; (forward-char 5)
(should (= ?- (char-after)))
(forward-sexp)
(should (= ?. (char-before)))))
(ert-deftest lisp-forward-sexp-python-triple-quoted-string ()
"Test \\[forward-sexp] on Python doc strings for #11321."
(with-temp-buffer
(insert "\"\"\"Triple-quoted string\"\"\"")
(goto-char (point-min))
(let ((python-indent-guess-indent-offset nil))
(python-mode))
(forward-sexp)
(should (eobp))))
(ert-deftest lisp-forward-sexp-python-triple-quotes-string ()
"Test \\[forward-sexp] on Python doc strings for #11321."
(with-temp-buffer
(insert "'''Triple-quoted string'''")
(goto-char (point-min))
(let ((python-indent-guess-indent-offset nil))
(python-mode))
(forward-sexp)
(should (eobp))))
(ert-deftest lisp-forward-sexp-emacs-lisp-semi-char-error ()
"Test \\[forward-sexp] on expression with unquoted semicolon per #4030."
(with-temp-buffer
(emacs-lisp-mode)
(insert "(insert ?;)")
(goto-char (point-min))
(should-error (forward-sexp)))) ;; FIXME: Shouldn't be an error.
(ert-deftest lisp-forward-sexp-emacs-lisp-quote-char ()
"Test \\[forward-sexp] on expression with unquoted quote per #4030."
(with-temp-buffer
(emacs-lisp-mode)
(insert "(insert ?\")")
(goto-char (point-min))
(should-error (forward-sexp)))) ;; FIXME: Shouldn't be an error.
;; Test some core Elisp rules.
(ert-deftest core-elisp-tests-1-defvar-in-let ()
"Test some core Elisp rules."
(with-temp-buffer
;; Check that when defvar is run within a let-binding, the toplevel default
;; is properly initialized.
(should (equal (list (let ((c-e-x 1)) (defvar c-e-x 2) c-e-x) c-e-x)
'(1 2)))
(should (equal (list (let ((c-e-x 1))
(defcustom c-e-x 2 "doc" :group 'blah :type 'integer) c-e-x)
c-e-x)
'(1 2)))))
(ert-deftest core-elisp-tests-2-window-configurations ()
"Test properties of window-configurations."
(let ((wc (current-window-configuration)))
(with-current-buffer (window-buffer (frame-selected-window))
(push-mark)
(activate-mark))
(set-window-configuration wc)
(should (or (not mark-active) (mark)))))
(ert-deftest core-elisp-tests-3-backquote ()
(should (eq 3 (eval ``,,'(+ 1 2)))))
;; Test up-list and backward-up-list.
(defun lisp-run-up-list-test (fn data start instructions)
(cl-labels ((posof (thing)
(and (symbolp thing)
(= (length (symbol-name thing)) 1)
(- (aref (symbol-name thing) 0) ?a -1))))
(with-temp-buffer
(set-syntax-table (make-syntax-table))
;; Use a syntax table in which single quote is a string
;; character so that we can embed the test data in a lisp string
;; literal.
(modify-syntax-entry ?\' "\"")
(insert data)
(goto-char (posof start))
(dolist (instruction instructions)
(cond ((posof instruction)
(funcall fn)
(should (eql (point) (posof instruction))))
((symbolp instruction)
(should-error (funcall fn)
:type instruction))
(t (cl-assert nil nil "unknown ins")))))))
(defmacro define-lisp-up-list-test (name fn data start &rest expected)
`(ert-deftest ,name ()
(lisp-run-up-list-test ,fn ,data ',start ',expected)))
(define-lisp-up-list-test up-list-basic
(lambda () (up-list))
(or "(1 1 (1 1) 1 (1 1) 1)")
;; abcdefghijklmnopqrstuv
i k v scan-error)
(define-lisp-up-list-test up-list-with-forward-sexp-function
(lambda ()
(let ((forward-sexp-function
(lambda (&optional arg)
(let ((forward-sexp-function nil))
(forward-sexp arg)))))
(up-list)))
(or "(1 1 (1 1) 1 (1 1) 1)")
;; abcdefghijklmnopqrstuv
i k v scan-error)
(define-lisp-up-list-test up-list-out-of-string
(lambda () (up-list 1 t))
(or "1 (1 '2 2 (2 2 2' 1) 1")
;; abcdefghijklmnopqrstuvwxy
o r u scan-error)
(define-lisp-up-list-test up-list-cross-string
(lambda () (up-list 1 t))
(or "(1 '2 ( 2' 1 '2 ) 2' 1)")
;; abcdefghijklmnopqrstuvwxy
i r u x scan-error)
(define-lisp-up-list-test up-list-no-cross-string
(lambda () (up-list 1 t t))
(or "(1 '2 ( 2' 1 '2 ) 2' 1)")
;; abcdefghijklmnopqrstuvwxy
i k x scan-error)
(define-lisp-up-list-test backward-up-list-basic
(lambda () (backward-up-list))
(or "(1 1 (1 1) 1 (1 1) 1)")
;; abcdefghijklmnopqrstuv
i f a scan-error)
;;; Helpers
(eval-and-compile
(defvar elisp-test-point-position-regex "=!\\([a-zA-Z0-9-]+\\)="
"A regexp matching placeholders for point position for
`elisp-tests-with-temp-buffer'."))
;; Copied and heavily modified from `python-tests-with-temp-buffer'
(defmacro elisp-tests-with-temp-buffer (contents &rest body)
"Create an `emacs-lisp-mode' enabled temp buffer with CONTENTS.
BODY is the code to be executed within the temp buffer. Point is
always located at the beginning of buffer. CONTENTS is an
expression that must evaluate to a string at compile time. Words
of the form =!NAME= in CONTENTS are removed, and a for each one a
variable called NAME is bound to the position of the word's
start."
(declare (indent 1) (debug (def-form body)))
(let* ((var-pos nil)
(text (with-temp-buffer
(insert (eval contents))
(goto-char (point-min))
(while (re-search-forward elisp-test-point-position-regex nil t)
(push (list (intern (match-string-no-properties 1))
(match-beginning 0))
var-pos)
(delete-region (match-beginning 0)
(match-end 0)))
(buffer-string))))
`(with-temp-buffer
(emacs-lisp-mode)
(insert ,text)
(goto-char (point-min))
(let ,var-pos
;; Let the =!POSITION= variables be ignorable.
,@(mapcar (lambda (v-p) `(ignore ,(car v-p))) var-pos)
,@body))))
;;; mark-defun
(eval-and-compile
(defvar mark-defun-test-buffer
";; Comment header
=!before-1=
\(defun func-1 (arg)
=!inside-1=\"docstring\"
body)
=!after-1==!before-2=
;; Comment before a defun
\(d=!inside-2=efun func-2 (arg)
\"docstring\"
body)
=!after-2==!before-3=
\(defun func-3 (arg)
\"docstring\"=!inside-3=
body)
=!after-3==!before-4=(defun func-4 (arg)
\"docstring\"=!inside-4=
body)
=!after-4=
;; end
"
"Test buffer for `mark-defun'."))
(ert-deftest mark-defun-no-arg-region-inactive ()
"Test `mark-defun' with no prefix argument and inactive
region."
(setq last-command nil)
(elisp-tests-with-temp-buffer
mark-defun-test-buffer
;; mark-defun inside a defun, with comments and an empty line
;; before
(goto-char inside-1)
(mark-defun)
(should (= (point) before-1))
(should (= (mark) after-1))
;; mark-defun inside a defun with comments before
(deactivate-mark)
(goto-char inside-2)
(mark-defun)
(should (= (point) before-2))
(should (= (mark) after-2))
;; mark-defun inside a defun with empty line before
(deactivate-mark)
(goto-char inside-3)
(mark-defun)
(should (= (point) before-3))
(should (= (mark) after-3))
;; mark-defun inside a defun with another one right before
(deactivate-mark)
(goto-char inside-4)
(mark-defun)
(should (= (point) before-4))
(should (= (mark) after-4))
;; mark-defun between a comment and a defun
(deactivate-mark)
(goto-char before-1)
(mark-defun)
(should (= (point) before-1))
(should (= (mark) after-1))
;; mark-defun between defuns
(deactivate-mark)
(goto-char before-3)
(mark-defun)
(should (= (point) before-3))
(should (= (mark) after-3))
;; mark-defun in comment right before the defun
(deactivate-mark)
(goto-char before-2)
(mark-defun)
(should (= (point) before-2))
(should (= (mark) after-2))))
(ert-deftest mark-defun-no-arg-region-active ()
"Test `mark-defun' with no prefix argument and active
region."
(transient-mark-mode 1)
(setq last-command nil)
(elisp-tests-with-temp-buffer
mark-defun-test-buffer
;; mark-defun when a defun is marked
(goto-char before-1)
(set-mark after-1)
(mark-defun)
(should (= (point) before-1))
(should (= (mark) after-2))
;; mark-defun when two defuns are marked
(deactivate-mark)
(goto-char before-1)
(set-mark after-2)
(mark-defun)
(should (= (point) before-1))
(should (= (mark) after-3))))
(ert-deftest mark-defun-arg-region-active ()
"Test `mark-defun' with a prefix arg and active region."
(transient-mark-mode 1)
(setq last-command nil)
(elisp-tests-with-temp-buffer
mark-defun-test-buffer
;; mark-defun with positive arg when a defun is marked
(goto-char before-1)
(set-mark after-1)
(mark-defun 2)
(should (= (point) before-1))
(should (= (mark) after-3))
;; mark-defun with arg=-1 when a defun is marked
(goto-char before-2)
(set-mark after-2)
(mark-defun -1)
(should (= (point) before-1))
(should (= (mark) after-2))
;; mark-defun with arg=-2 when a defun is marked
(goto-char before-3)
(set-mark after-3)
(mark-defun -2)
(should (= (point) before-1))
(should (= (mark) after-3))))
(ert-deftest mark-defun-pos-arg-region-inactive ()
"Test `mark-defun' with positive argument and inactive
region."
(setq last-command nil)
(elisp-tests-with-temp-buffer
mark-defun-test-buffer
;; mark-defun with positive arg inside a defun
(goto-char inside-1)
(mark-defun 2)
(should (= (point) before-1))
(should (= (mark) after-2))
;; mark-defun with positive arg between defuns
(deactivate-mark)
(goto-char before-3)
(mark-defun 2)
(should (= (point) before-3))
(should (= (mark) after-4))
;; mark-defun with positive arg in a comment
(deactivate-mark)
(goto-char before-2)
(mark-defun 2)
(should (= (point) before-2))
(should (= (mark) after-3))))
(ert-deftest mark-defun-neg-arg-region-inactive ()
"Test `mark-defun' with negative argument and inactive
region."
(setq last-command nil)
(elisp-tests-with-temp-buffer
mark-defun-test-buffer
;; mark-defun with arg=-1 inside a defun
(goto-char inside-1)
(mark-defun -1)
(should (= (point) before-1))
(should (= (mark) after-1))
;; mark-defun with arg=-1 between defuns
(deactivate-mark)
(goto-char after-2)
(mark-defun -1)
(should (= (point) before-2))
(should (= (mark) after-2))
;; mark-defun with arg=-1 in a comment
;; (this is probably not an optimal behavior...)
(deactivate-mark)
(goto-char before-2)
(mark-defun -1)
(should (= (point) before-1))
(should (= (mark) after-1))
;; mark-defun with arg=-2 inside a defun
(deactivate-mark)
(goto-char inside-4)
(mark-defun -2)
(should (= (point) before-3))
(should (= (mark) after-4))
;; mark-defun with arg=-2 between defuns
(deactivate-mark)
(goto-char before-3)
(mark-defun -2)
(should (= (point) before-1))
(should (= (mark) after-2)))
(elisp-tests-with-temp-buffer ; test case submitted by Drew Adams
"(defun a ()
nil)
=!before-b=(defun b ()
=!in-b= nil)
=!after-b=;;;;
\(defun c ()
nil)
"
(setq last-command nil)
(goto-char in-b)
(mark-defun -1)
(should (= (point) before-b))
(should (= (mark) after-b))))
(ert-deftest mark-defun-bob ()
"Test `mark-defun' at the beginning of buffer."
;; Bob, comment, newline, defun
(setq last-command nil)
(elisp-tests-with-temp-buffer
";; Comment at the bob
=!before=
\(defun func (arg)=!inside=
\"docstring\"
body)
=!after="
(goto-char inside)
(mark-defun)
(should (= (point) before))
(should (= (mark) after)))
;; Bob, newline, comment, defun
(elisp-tests-with-temp-buffer
"=!before=
;; Comment before the defun
\(defun func (arg)=!inside=
\"docstring\"
body)
=!after="
(goto-char inside)
(mark-defun)
(should (= (point) before))
(should (= (mark) after)))
;; Bob, comment, defun
(elisp-tests-with-temp-buffer
"=!before=;; Comment at the bob before the defun
\(defun func (arg)=!inside=
\"docstring\"
body)
=!after="
(goto-char inside)
(mark-defun)
(should (= (point) before))
(should (= (mark) after)))
;; Bob, newline, comment, newline, defun
(elisp-tests-with-temp-buffer
"
;; Comment before the defun
=!before=
\(defun func (arg)=!inside=
\"docstring\"
body)
=!after="
(goto-char inside)
(mark-defun)
(should (= (point) before))
(should (= (mark) after))))
(provide 'lisp-tests)
;;; lisp-tests.el ends here
|