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
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
| | ;;; cperl-mode-tests.el --- Test for cperl-mode -*- lexical-binding: t -*-
;; Copyright (C) 2020-2022 Free Software Foundation, Inc.
;; Author: Harald Jörg <haj@posteo.de>
;; Maintainer: Harald Jörg
;; Keywords: internal
;; URL: https://github.com/HaraldJoerg/cperl-mode
;; 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 <https://www.gnu.org/licenses/>.
;;; Commentary:
;; This is a collection of tests for CPerl-mode.
;;; Code:
(defvar cperl-test-mode #'cperl-mode)
(require 'cperl-mode)
(require 'ert)
(require 'ert-x)
;;; Utilities
(defun cperl-test-ppss (text regexp)
"Return the `syntax-ppss' after the last character matched by REGEXP in TEXT."
(interactive)
(with-temp-buffer
(insert text)
(funcall cperl-test-mode)
(goto-char (point-min))
(re-search-forward regexp)
(syntax-ppss)))
(defmacro cperl--run-test-cases (file &rest body)
"Run all test cases in FILE with BODY.
This macro helps with tests which reformat Perl code, e.g. when
indenting or rearranging flow control. It extracts source code
snippets and corresponding expected results from a resource file,
runs BODY on the snippets, and compares the resulting buffer with
the expected results.
Test cases in FILE are formatted like this:
# -------- NAME: input --------
Your input to the test case comes here.
Both input and expected output may span several lines.
# -------- NAME: expected output --------
The expected output from running BODY on the input goes here.
# -------- NAME: end --------
You can have many of these blocks in one test file. You can
chose a NAME for each block, which is passed to the `should'
clause for easy identification of the first test case that
failed (if any). Text outside these the blocks is ignored by the
tests, so you can use it to document the test cases if you wish."
`(with-temp-buffer
(insert-file-contents ,file)
(goto-char (point-min))
(while (re-search-forward
(concat "^# ?-+ \\_<\\(?1:.+?\\)\\_>: input ?-+\n"
"\\(?2:\\(?:.*\n\\)+?\\)"
"# ?-+ \\1: expected output ?-+\n"
"\\(?3:\\(?:.*\n\\)+?\\)"
"# ?-+ \\1: end ?-+")
nil t)
(let ((name (match-string 1))
(code (match-string 2))
(expected (match-string 3))
got)
(with-temp-buffer
(insert code)
(goto-char (point-min))
(funcall cperl-test-mode)
,@body
(setq expected (concat "test case " name ":\n" expected))
(setq got (concat "test case " name ":\n" (buffer-string)))
(should (equal got expected)))))))
;;; Indentation tests
(ert-deftest cperl-test-indent-exp ()
"Run various tests for `cperl-indent-exp' edge cases.
These exercise some standard blocks and also the special
treatment for Perl expressions where a closing paren isn't the
end of the statement."
(skip-unless (eq cperl-test-mode #'cperl-mode))
(cperl--run-test-cases
(ert-resource-file "cperl-indent-exp.pl")
(cperl-indent-exp))) ; here we go!
(ert-deftest cperl-test-indent-styles ()
(skip-unless (eq cperl-test-mode #'cperl-mode))
(cperl--run-test-cases
(ert-resource-file "cperl-indent-styles.pl")
(cperl-set-style "PBP")
(indent-region (point-min) (point-max)) ; here we go!
(cperl-set-style-back)))
;;; Fontification tests
(ert-deftest cperl-test-fontify-punct-vars ()
"Test fontification of Perl's punctiation variables.
Perl has variable names containing unbalanced quotes for the list
separator $\" and pre- and postmatch $` and $'. A reference to
these variables, for example \\$\", should not cause the dollar
to be escaped, which would then start a string beginning with the
quote character. This used to be broken in cperl-mode at some
point in the distant past, and is still broken in perl-mode. "
(skip-unless (eq cperl-test-mode #'cperl-mode))
(let ((file (ert-resource-file "fontify-punctuation-vars.pl")))
(with-temp-buffer
(insert-file-contents file)
(goto-char (point-min))
(funcall cperl-test-mode)
(while (search-forward "##" nil t)
;; The third element of syntax-ppss is true if in a string,
;; which would indicate bad interpretation of the quote. The
;; fourth element is true if in a comment, which should be the
;; case.
(should (equal (nth 3 (syntax-ppss)) nil))
(should (equal (nth 4 (syntax-ppss)) t))))))
(ert-deftest cperl-test-fontify-declarations ()
"Test that declarations and package usage use consistent fontification."
(with-temp-buffer
(funcall cperl-test-mode)
(insert "package Foo::Bar;\n")
(insert "use Fee::Fie::Foe::Foo\n;")
(insert "my $xyzzy = 'PLUGH';\n")
(goto-char (point-min))
(font-lock-ensure)
(search-forward "Bar")
(should (equal (get-text-property (match-beginning 0) 'face)
'font-lock-function-name-face))
(search-forward "use") ; This was buggy in perl-mode
(should (equal (get-text-property (match-beginning 0) 'face)
'font-lock-keyword-face))
(search-forward "my")
(should (equal (get-text-property (match-beginning 0) 'face)
'font-lock-keyword-face))))
(ert-deftest cperl-test-fontify-attrs-and-signatures ()
"Test fontification of the various combinations of subroutine
attributes, prototypes and signatures."
(skip-unless (eq cperl-test-mode #'cperl-mode))
(let ((file (ert-resource-file "proto-and-attrs.pl")))
(with-temp-buffer
(insert-file-contents file)
(goto-char (point-min))
(funcall cperl-test-mode)
(font-lock-ensure)
;; Named subroutines
(while (search-forward-regexp "\\_<sub_[[:digit:]]+" nil t)
(should (equal (get-text-property (match-beginning 0) 'face)
'font-lock-function-name-face))
(let ((start-of-sub (match-beginning 0))
(end-of-sub (save-excursion (search-forward "}") (point))))
;; Prototypes are shown as strings
(when (search-forward-regexp " ([$%@*]*) " end-of-sub t)
(should (equal (get-text-property (1+ (match-beginning 0)) 'face)
'font-lock-string-face)))
(goto-char start-of-sub)
(when (search-forward-regexp "\\(:[a-z]+\\)\\((.*?)\\)?" end-of-sub t)
(should (equal (get-text-property (match-beginning 1) 'face)
'font-lock-constant-face))
(when (match-beginning 2)
(should (equal (get-text-property (match-beginning 2) 'face)
'font-lock-string-face))))
(goto-char end-of-sub)))
;; Anonymous subroutines
(while (search-forward-regexp "= sub" nil t)
(let ((start-of-sub (match-beginning 0))
(end-of-sub (save-excursion (search-forward "}") (point))))
;; Prototypes are shown as strings
(when (search-forward-regexp " ([$%@*]*) " end-of-sub t)
(should (equal (get-text-property (1+ (match-beginning 0)) 'face)
'font-lock-string-face)))
(goto-char start-of-sub)
(when (search-forward-regexp "\\(:[a-z]+\\)\\((.*?)\\)?" end-of-sub t)
(should (equal (get-text-property (match-beginning 1) 'face)
'font-lock-constant-face))
(when (match-beginning 2)
(should (equal (get-text-property (match-beginning 2) 'face)
'font-lock-string-face))))
(goto-char end-of-sub))))))
(ert-deftest cperl-test-fontify-special-variables ()
"Test fontification of variables like $^T or ${^ENCODING}.
These can occur as \"local\" aliases."
(skip-unless (eq cperl-test-mode #'cperl-mode))
(with-temp-buffer
(insert "local ($^I, ${^UNICODE});\n")
(goto-char (point-min))
(funcall cperl-test-mode)
(font-lock-ensure)
(search-forward "$")
(should (equal (get-text-property (point) 'face)
'font-lock-variable-name-face))
(search-forward "$")
(should (equal (get-text-property (point) 'face)
'font-lock-variable-name-face))))
(ert-deftest cperl-test-identify-heredoc ()
"Test whether a construct containing \"<<\" followed by a
bareword is properly identified for a here-document if
appropriate."
(let ((here-docs
'("$text .= <<DELIM;" ; mutator concatenating a here-doc
"func($arg) . <<DELIM;" ; concatenating a return value
"func 1, <<DELIM;" ; a function taking two arguments
))
;; There forms are currently mishandled in `perl-mode' :-(
(here-docs-cperl
'("print {a} <<DELIM;" ; printing to a file handle
"system $prog <<DELIM;" ; lie about the program's name
))
(_undecidable
'("foo <<bar") ; could be either "foo() <<bar"
; or "foo(<<bar)"
))
(dolist (code (append here-docs (if (eq cperl-test-mode #'cperl-mode)
here-docs-cperl)))
(with-temp-buffer
(insert code "\n\nDELIM\n")
(funcall cperl-test-mode)
(goto-char (point-min))
(forward-line 1)
;; We should now be within a here-doc.
(let ((ppss (syntax-ppss)))
(should (and (nth 8 ppss) (nth 4 ppss))))
))))
(ert-deftest cperl-test-identify-no-heredoc ()
"Test whether a construct containing \"<<\" which is not a
here-document is properly rejected."
(let (
(not-here-docs
'("while (<<>>) {" ; double angle bracket operator
"expr <<func();" ; left shift by a return value
"$var <<func;" ; left shift by a return value
"($var+1) <<func;" ; same for an expression
"$hash{key} <<func;" ; same for a hash element
"or $var <<func;" ; same for an expression
"sorted $by <<func" ; _not_ a call to sort
))
(_undecidable
'("foo <<bar" ; could be either "foo() <<bar"
; or "foo(<<bar)"
"$foo = <<;") ; empty delim forbidden since 5.28
))
(dolist (code not-here-docs)
(with-temp-buffer
(insert code "\n\n")
(funcall cperl-test-mode)
(goto-char (point-min))
(forward-line 1)
;; Point is not within a here-doc (nor string nor comment).
(let ((ppss (syntax-ppss)))
(should-not (nth 8 ppss)))
))))
(ert-deftest cperl-test-here-doc-missing-end ()
"Verify that a missing here-document terminator gives a message.
This message prints the terminator which wasn't found and is only
issued by CPerl mode."
(skip-unless (eq cperl-test-mode #'cperl-mode))
(ert-with-message-capture collected-messages
(with-temp-buffer
(insert "my $foo = <<HERE\n")
(insert "some text here\n")
(goto-char (point-min))
(funcall cperl-test-mode)
(cperl-find-pods-heres)
(should (string-match "End of here-document [‘'`]HERE[’']"
collected-messages))))
(ert-with-message-capture collected-messages
(with-temp-buffer
(insert "my $foo = <<HERE . <<'THERE'\n")
(insert "some text here\n")
(insert "HERE\n")
(insert "more text here\n")
(goto-char (point-min))
(funcall cperl-test-mode)
(cperl-find-pods-heres)
(should (string-match "End of here-document [‘'`]THERE[’']"
collected-messages)))))
(defvar perl-continued-statement-offset)
(defvar perl-indent-level)
(defconst cperl--tests-heredoc-face
(if (equal cperl-test-mode 'perl-mode) 'perl-heredoc
'font-lock-string-face))
(defconst cperl--tests-heredoc-delim-face
(if (equal cperl-test-mode 'perl-mode) 'perl-heredoc
'font-lock-constant-face))
(ert-deftest cperl-test-heredocs ()
"Test that HERE-docs are fontified with the appropriate face."
(require 'perl-mode)
(let ((file (ert-resource-file "here-docs.pl"))
(cperl-continued-statement-offset perl-continued-statement-offset)
(case-fold-search nil))
(with-temp-buffer
(insert-file-contents file)
(goto-char (point-min))
(funcall cperl-test-mode)
(indent-region (point-min) (point-max))
(font-lock-ensure (point-min) (point-max))
(while (search-forward "## test case" nil t)
(save-excursion
(while (search-forward "look-here" nil t)
(should (equal
(get-text-property (match-beginning 0) 'face)
cperl--tests-heredoc-face))
(beginning-of-line)
(should (null (looking-at "[ \t]")))
(forward-line 1)))
(should (re-search-forward
(concat "^\\([ \t]*\\)" ; the actual indentation amount
"\\([^ \t\n].*?\\)\\(no\\)?indent")
nil t))
(should (equal (- (match-end 1) (match-beginning 1))
(if (match-beginning 3) 0
perl-indent-level)))))))
;;; Grammar based tests: unit tests
(defun cperl-test--validate-regexp (regexp valid &optional invalid)
"Runs tests for elements of VALID and INVALID lists against REGEXP.
Tests with elements from VALID must match, tests with elements
from INVALID must not match. The match string must be equal to
the whole string."
(funcall cperl-test-mode)
(dolist (string valid)
(should (string-match regexp string))
(should (string= (match-string 0 string) string)))
(when invalid
(dolist (string invalid)
(should-not
(and (string-match regexp string)
(string= (match-string 0 string) string))))))
(ert-deftest cperl-test-ws-rx ()
"Tests capture of very simple regular expressions (yawn)."
(skip-unless (eq cperl-test-mode #'cperl-mode))
(let ((valid
'(" " "\t" "\n"))
(invalid
'("a" " " "")))
(cperl-test--validate-regexp (rx (eval cperl--ws-rx))
valid invalid)))
(ert-deftest cperl-test-ws+-rx ()
"Tests sequences of whitespace and comment lines."
(skip-unless (eq cperl-test-mode #'cperl-mode))
(let ((valid
`(" " "\t#\n" "\n# \n"
,(concat "# comment\n" "# comment\n" "\n" "#comment\n")))
(invalid
'("=head1 NAME\n" )))
(cperl-test--validate-regexp (rx (eval cperl--ws+-rx))
valid invalid)))
(ert-deftest cperl-test-version-regexp ()
"Tests the regexp for recommended syntax of versions in Perl."
(skip-unless (eq cperl-test-mode #'cperl-mode))
(let ((valid
'("1" "1.1" "1.1_1" "5.032001"
"v120.100.103"))
(invalid
'("alpha" "0." ".123" "1E2"
"v1.1" ; a "v" version string needs at least 3 components
;; bad examples from "Version numbers should be boring"
;; by xdg AKA David A. Golden
"1.20alpha" "2.34beta2" "2.00R3")))
(cperl-test--validate-regexp cperl--version-regexp
valid invalid)))
(ert-deftest cperl-test-package-regexp ()
"Tests the regular expression of Perl package names with versions.
Also includes valid cases with whitespace in strange places."
(skip-unless (eq cperl-test-mode #'cperl-mode))
(let ((valid
'("package Foo"
"package Foo::Bar"
"package Foo::Bar v1.2.3"
"package Foo::Bar::Baz 1.1"
"package \nFoo::Bar\n 1.00"))
(invalid
'("package Foo;" ; semicolon must not be included
"package Foo 1.1 {" ; nor the opening brace
"packageFoo" ; not a package declaration
"package Foo1.1" ; invalid package name
"class O3D::Sphere"))) ; class not yet supported
(cperl-test--validate-regexp (rx (eval cperl--package-rx))
valid invalid)))
(ert-deftest cperl-test-identifier-rx ()
"Test valid and invalid identifiers (no sigils)."
(skip-unless (eq cperl-test-mode #'cperl-mode))
(let ((valid
'("foo" "FOO" "f_oo" "a123"
"manĝis")) ; Unicode is allowed!
(invalid
'("$foo" ; no sigils allowed (yet)
"Foo::bar" ; no package qualifiers allowed
"lots_of_€"))) ; € is not alphabetic
(cperl-test--validate-regexp (rx (eval cperl--basic-identifier-rx))
valid invalid)))
;;; Test unicode identifier in various places
(defun cperl--test-unicode-setup (code string)
"Insert CODE, prepare it for tests, and find STRING.
Invoke the appropriate major mode, ensure fontification, and set
point after the first occurrence of STRING (no regexp!)."
(insert code)
(funcall cperl-test-mode)
(font-lock-ensure)
(goto-char (point-min))
(search-forward string))
(ert-deftest cperl-test-unicode-labels ()
"Verify that non-ASCII labels are processed correctly."
(with-temp-buffer
(cperl--test-unicode-setup "LABEł: for ($manĝi) { say; }" "LAB")
(should (equal (get-text-property (point) 'face)
'font-lock-constant-face))))
(ert-deftest cperl-test-unicode-sub ()
(with-temp-buffer
(cperl--test-unicode-setup
(concat "use strict;\n" ; distinguish bob from b-o-f
"sub ℏ {\n"
" 6.62607015e-34\n"
"};")
"sub ") ; point is before "ℏ"
;; Testing fontification
;; FIXME 2021-09-10: This tests succeeds because cperl-mode
;; accepts almost anything as a sub name for fontification. For
;; example, it fontifies "sub @ {...;}" which is a syntax error in
;; Perl. I let this pass for the moment.
(should (equal (get-text-property (point) 'face)
'font-lock-function-name-face))
;; Testing `beginning-of-defun'. Not available in perl-mode,
;; where it jumps to the beginning of the buffer.
(when (eq cperl-test-mode #'cperl-mode)
(goto-char (point-min))
(search-forward "-34")
(beginning-of-defun)
(should (looking-at "sub")))))
(ert-deftest cperl-test-unicode-varname ()
(with-temp-buffer
(cperl--test-unicode-setup
(concat "use strict;\n"
"my $π = 3.1415926535897932384626433832795028841971;\n"
"\n"
"my $manĝi = $π;\n"
"__END__\n")
"my $") ; perl-mode doesn't fontify the sigil, so include it here
;; Testing fontification
;; FIXME 2021-09-10: This test succeeds in cperl-mode because the
;; π character is "not ASCII alphabetic", so it treats $π as a
;; punctuation variable. The following two `should' forms with a
;; longer variable name were added for stronger verification.
(should (equal (get-text-property (point) 'face)
'font-lock-variable-name-face))
;; Test both ends of a longer variable name
(search-forward "my $") ; again skip the sigil
(should (equal (get-text-property (point) 'face)
'font-lock-variable-name-face))
(search-forward "manĝi")
(should (equal (get-text-property (1- (match-end 0)) 'face)
'font-lock-variable-name-face))))
(ert-deftest cperl-test-unicode-varname-list ()
"Verify that all elements of a variable list are fontified."
(let ((hash-face (if (eq cperl-test-mode #'perl-mode)
'perl-non-scalar-variable
'cperl-hash-face))
(array-face (if (eq cperl-test-mode #'perl-mode)
'perl-non-scalar-variable
'cperl-array-face)))
(with-temp-buffer
(cperl--test-unicode-setup
"my (%äsh,@ärräy,$scâlâr);" "%")
(should (equal (get-text-property (point) 'face)
hash-face))
(search-forward "@")
(should (equal (get-text-property (point) 'face)
array-face))
(search-forward "scâlâr")
(should (equal (get-text-property (match-beginning 0) 'face)
'font-lock-variable-name-face))
(should (equal (get-text-property (1- (match-end 0)) 'face)
'font-lock-variable-name-face)))
;; Now with package-qualified variables
(with-temp-buffer
(cperl--test-unicode-setup
"local (%Søme::äsh,@Søme::ärräy,$Søme::scâlâr);" "%")
(should (equal (get-text-property (point) 'face)
hash-face))
(search-forward "Søme::") ; test basic identifier
(should (equal (get-text-property (point) 'face)
hash-face))
(search-forward "@") ; test package name
(should (equal (get-text-property (point) 'face)
array-face))
(search-forward "Søme::") ; test basic identifier
(should (equal (get-text-property (point) 'face)
array-face))
(search-forward "Søme") ; test package name
(should (equal (get-text-property (match-beginning 0) 'face)
'font-lock-variable-name-face))
(should (equal (get-text-property (1- (match-end 0)) 'face)
'font-lock-variable-name-face))
(search-forward "scâlâr") ; test basic identifier
(should (equal (get-text-property (match-beginning 0) 'face)
'font-lock-variable-name-face))
(should (equal (get-text-property (1- (match-end 0)) 'face)
'font-lock-variable-name-face)))))
(ert-deftest cperl-test-unicode-arrays ()
"Test fontification of array access."
;; Perl mode just looks at the sigil, for element access
(skip-unless (eq cperl-test-mode #'cperl-mode))
;; simple array element
(with-temp-buffer
(cperl--test-unicode-setup
"$ärräy[1] = 7;" "$")
(should (equal (get-text-property (point) 'face)
'cperl-array-face)))
;; array slice
(with-temp-buffer
(cperl--test-unicode-setup
"@ärräy[(1..3)] = (4..6);" "@")
(should (equal (get-text-property (point) 'face)
'cperl-array-face)))
;; array max index
(with-temp-buffer
(cperl--test-unicode-setup
"$#ärräy = 1;" "$")
(should (equal (get-text-property (point) 'face)
'cperl-array-face)))
;; array dereference
(with-temp-buffer
(cperl--test-unicode-setup
"@$ärräy = (1,2,3)" "@")
(should (equal (get-text-property (1- (point)) 'face)
'cperl-array-face))
(should (equal (get-text-property (1+ (point)) 'face)
'font-lock-variable-name-face))))
(ert-deftest cperl-test-unicode-hashes ()
"Test fontification of hash access."
;; Perl mode just looks at the sigil, for element access
(skip-unless (eq cperl-test-mode #'cperl-mode))
;; simple hash element
(with-temp-buffer
(cperl--test-unicode-setup
"$häsh{'a'} = 7;" "$")
(should (equal (get-text-property (point) 'face)
'cperl-hash-face)))
;; hash array slice
(with-temp-buffer
(cperl--test-unicode-setup
"@häsh{(1..3)} = (4..6);" "@")
(should (equal (get-text-property (point) 'face)
'cperl-hash-face)))
;; hash subset
(with-temp-buffer
(cperl--test-unicode-setup
"my %hash = %häsh{'a',2,3};" "= %")
(should (equal (get-text-property (point) 'face)
'cperl-hash-face)))
;; hash dereference
(with-temp-buffer
(cperl--test-unicode-setup
"%$äsh = (key => 'value');" "%")
(should (equal (get-text-property (1- (point)) 'face)
'cperl-hash-face))
(should (equal (get-text-property (1+ (point)) 'face)
'font-lock-variable-name-face))))
(ert-deftest cperl-test-unicode-hashref ()
"Verify that a hashref access disambiguates {s}.
CPerl mode takes the token \"s\" as a substitution unless
detected otherwise. Not for perl-mode: it doesn't stringify
bareword hash keys and doesn't recognize a substitution
\"s}foo}bar}\""
(skip-unless (eq cperl-test-mode #'cperl-mode))
(with-temp-buffer
(cperl--test-unicode-setup "$häshref->{s} # }}" "{")
(should (equal (get-text-property (point) 'face)
'font-lock-string-face))
(should (equal (get-text-property (1+ (point)) 'face)
nil))))
(ert-deftest cperl-test-unicode-proto ()
;; perl-mode doesn't fontify prototypes at all
(skip-unless (eq cperl-test-mode #'cperl-mode))
(with-temp-buffer
(cperl--test-unicode-setup
(concat "sub prötötyped ($) {\n"
" ...;"
"}\n")
"prötötyped (")
(should (equal (get-text-property (point) 'face)
'font-lock-string-face))))
(ert-deftest cperl-test-unicode-fhs ()
(with-temp-buffer
(cperl--test-unicode-setup
(concat "while (<BAREWÖRD>) {\n"
" ...;)\n"
"}\n")
"while (<") ; point is before the first char of the handle
;; Testing fontification
;; FIXME 2021-09-10: perl-mode.el and cperl-mode.el handle these
;; completely differently. perl-mode interprets barewords as
;; constants, cperl-mode does not fontify them. Both treat
;; non-barewords as globs, which are not fontified by perl-mode,
;; but fontified as strings in cperl-mode. We keep (and test)
;; that behavior "as is" because both bareword filehandles and
;; <glob> syntax are no longer recommended.
(let ((bareword-face
(if (equal cperl-test-mode 'perl-mode) 'font-lock-constant-face
nil)))
(should (equal (get-text-property (point) 'face)
bareword-face)))))
(ert-deftest cperl-test-unicode-hashkeys ()
"Test stringification of bareword hash keys. Not in perl-mode.
perl-mode generally does not stringify bareword hash keys."
(skip-unless (eq cperl-test-mode #'cperl-mode))
;; Plain hash key
(with-temp-buffer
(cperl--test-unicode-setup
"$häsh { kéy }" "{ ")
(should (equal (get-text-property (point) 'face)
'font-lock-string-face)))
;; Nested hash key
(with-temp-buffer
(cperl--test-unicode-setup
"$häsh { kéy } { kèy }" "} { ")
(should (equal (get-text-property (point) 'face)
'font-lock-string-face)))
;; Key => value
(with-temp-buffer
(cperl--test-unicode-setup
"( kéy => 'value'," "( ")
(should (equal (get-text-property (point) 'face)
'font-lock-string-face))))
(ert-deftest cperl-test-word-at-point ()
"Test whether the function captures non-ASCII words."
(skip-unless (eq cperl-test-mode #'cperl-mode))
(let ((words '("rôle" "café" "ångström"
"Data::Dump::dump"
"_underscore")))
(dolist (word words)
(with-temp-buffer
(insert " + ") ; this will be the suffix
(beginning-of-line)
(insert ")") ; A non-word char
(insert word)
(should (string= word (cperl-word-at-point-hard)))))))
;;; Function test: Building an index for imenu
(ert-deftest cperl-test-imenu-index ()
"Test index creation for imenu.
This test relies on the specific layout of the index alist as
created by CPerl mode, so skip it for Perl mode."
(skip-unless (eq cperl-test-mode #'cperl-mode))
(with-temp-buffer
(insert-file-contents (ert-resource-file "grammar.pl"))
(cperl-mode)
(let ((index (cperl-imenu--create-perl-index))
current-list)
(setq current-list (assoc-string "+Unsorted List+..." index))
(should current-list)
(let ((expected '("(main)::outside"
"Package::in_package"
"Shoved::elsewhere"
"Package::prototyped"
"Versioned::Package::versioned"
"Block::attr"
"Versioned::Package::outer"
"lexical"
"Versioned::Block::signatured"
"Package::in_package_again"
"Erdős::Number::erdős_number")))
(dolist (sub expected)
(should (assoc-string sub index)))))))
;;; Tests for issues reported in the Bug Tracker
(ert-deftest cperl-test-bug-997 ()
"Test that we distinguish a regexp match when there's nothing before it."
(let ((code "# some comment\n\n/fontify me/;\n"))
(with-temp-buffer
(funcall cperl-test-mode)
(insert code)
(font-lock-ensure)
(goto-char (point-min))
(search-forward "/f")
(should (equal (get-text-property (point) 'face)
'font-lock-string-face)))))
(defun cperl-test--run-bug-10483 ()
"Runs a short program, intended to be under timer scrutiny.
This function is intended to be used by an Emacs subprocess in
batch mode. The message buffer is used to report the result of
running `cperl-indent-exp' for a very simple input. The result
is expected to be different from the input, to verify that
indentation actually takes place.."
(let ((code "poop ('foo', \n'bar')")) ; see the bug report
(message "Test Bug#10483 started")
(with-temp-buffer
(insert code)
(funcall cperl-test-mode)
(goto-char (point-min))
(search-forward "poop")
(cperl-indent-exp)
(message "%s" (buffer-string)))))
(ert-deftest cperl-test-bug-10483 ()
"Check that indenting certain perl code does not loop forever.
This verifies that indenting a piece of code that ends in a paren
without a statement terminator on the same line does not loop
forever. The test starts an asynchronous Emacs batch process
under timeout control."
:tags '(:expensive-test)
(skip-unless (not (getenv "EMACS_HYDRA_CI"))) ; FIXME times out
(skip-unless (not (< emacs-major-version 28))) ; times out in older Emacsen
(skip-unless (eq cperl-test-mode #'cperl-mode))
(let* ((emacs (concat invocation-directory invocation-name))
(test-function 'cperl-test--run-bug-10483)
(test-function-name (symbol-name test-function))
(test-file (symbol-file test-function 'defun))
(ran-out-of-time nil)
(process-connection-type nil)
runner)
(with-temp-buffer
(with-timeout (2
(delete-process runner)
(setq ran-out-of-time t))
(setq runner (start-process "speedy"
(current-buffer)
emacs
"-batch"
"--quick"
"--load" test-file
"--funcall" test-function-name))
(while (accept-process-output runner)))
(should (equal ran-out-of-time nil))
(goto-char (point-min))
;; just a very simple test for indentation: This should
;; be rather robust with regard to indentation defaults
(should (string-match
"poop ('foo', \n 'bar')" (buffer-string))))))
(ert-deftest cperl-test-bug-14343 ()
"Verify that inserting text into a HERE-doc string with Elisp
does not break fontification."
(with-temp-buffer
(insert "my $string = <<HERE;\n"
"One line of text.\n"
"Last line of this string.\n"
"HERE\n")
(funcall cperl-test-mode)
(font-lock-ensure)
(goto-char (point-min))
(search-forward "One line")
(should (equal (get-text-property (point) 'face)
cperl--tests-heredoc-face))
(beginning-of-line)
(insert "Another line if text.\n")
(font-lock-ensure)
(forward-line -1)
(should (equal (get-text-property (point) 'face)
cperl--tests-heredoc-face))
(search-forward "HERE")
(beginning-of-line)
(should (equal (get-text-property (point) 'face)
cperl--tests-heredoc-delim-face)))
;; insert into an empty here-document
(with-temp-buffer
(insert "print <<HERE;\n"
"HERE\n")
(funcall cperl-test-mode)
(font-lock-ensure)
(goto-char (point-min))
(forward-line)
(should (equal (get-text-property (point) 'face)
cperl--tests-heredoc-delim-face))
;; Insert a newline into the empty here-document
(goto-char (point-min))
(forward-line)
(insert "\n")
(search-forward "HERE")
(beginning-of-line)
(should (equal (get-text-property (point) 'face)
cperl--tests-heredoc-delim-face))
;; Insert text at the beginning of the here-doc
(goto-char (point-min))
(forward-line)
(insert "text")
(font-lock-ensure)
(search-backward "text")
(should (equal (get-text-property (point) 'face)
cperl--tests-heredoc-face))
(search-forward "HERE")
(beginning-of-line)
(should (equal (get-text-property (point) 'face)
cperl--tests-heredoc-delim-face))
;; Insert a new line immediately before the delimiter
;; (That's where the point is anyway)
(insert "A new line\n")
(font-lock-ensure)
;; The delimiter is still the delimiter
(should (equal (get-text-property (point) 'face)
cperl--tests-heredoc-delim-face))
(forward-line -1)
;; The new line has been "added" to the here-document
(should (equal (get-text-property (point) 'face)
cperl--tests-heredoc-face))))
(ert-deftest cperl-test-bug-16368 ()
"Verify that `cperl-forward-group-in-re' doesn't hide errors."
(skip-unless (eq cperl-test-mode #'cperl-mode))
(let ((code "/(\\d{4})(?{2}/;") ; the regex from the bug report
(result))
(with-temp-buffer
(insert code)
(goto-char 9)
(setq result (cperl-forward-group-in-re))
(should (equal (car result) 'scan-error))
(should (equal (nth 1 result) "Unbalanced parentheses"))
(should (= (point) 9)))) ; point remains unchanged on error
(let ((code "/(\\d{4})(?{2})/;") ; here all parens are balanced
(result))
(with-temp-buffer
(insert code)
(goto-char 9)
(setq result (cperl-forward-group-in-re))
(should (equal result nil))
(should (= (point) 15))))) ; point has skipped the group
(ert-deftest cperl-test-bug-19709 ()
"Verify that indentation of closing paren works as intended.
Note that Perl mode has no setting for close paren offset, per
documentation it does the right thing anyway."
(cperl--run-test-cases
(ert-resource-file "cperl-bug-19709.pl")
;; settings from the bug report
(setq-local cperl-indent-level 4)
(setq-local cperl-indent-parens-as-block t)
(setq-local cperl-close-paren-offset -4)
;; same, adapted for per-mode
(setq-local perl-indent-level 4)
(setq-local perl-indent-parens-as-block t)
(while (null (eobp))
(cperl-indent-command)
(forward-line 1))))
(ert-deftest cperl-test-bug-22355 ()
"Verify that substitutions are fontified directly after \"|&\".
Regular expressions are strings in both perl-mode and cperl-mode."
(with-temp-buffer
(insert-file-contents (ert-resource-file "cperl-bug-22355.pl"))
(funcall cperl-test-mode)
(goto-char (point-min))
;; Just check for the start of the string
(search-forward "{")
(should (nth 3 (syntax-ppss)))))
(ert-deftest cperl-test-bug-23992 ()
"Verify that substitutions are fontified directly after \"|&\".
Regular expressions are strings in both perl-mode and cperl-mode."
(with-temp-buffer
(insert-file-contents (ert-resource-file "cperl-bug-23992.pl"))
(funcall cperl-test-mode)
(goto-char (point-min))
;; "or" operator, with spaces
(search-forward "RIGHT")
(should (nth 3 (syntax-ppss)))
;; "or" operator, without spaces
(search-forward "RIGHT")
(should (nth 3 (syntax-ppss)))
;; "and" operator, with spaces
(search-forward "RIGHT")
(should (nth 3 (syntax-ppss)))
;; "and" operator, without spaces
(search-forward "RIGHT")
(should (nth 3 (syntax-ppss)))))
(ert-deftest cperl-test-bug-25098 ()
"Verify that a quotelike operator is recognized after a fat comma \"=>\".
Related, check that calling a method named q is not mistaken as a
quotelike operator."
(with-temp-buffer
(insert-file-contents (ert-resource-file "cperl-bug-25098.pl"))
(funcall cperl-test-mode)
(goto-char (point-min))
;; good example from the bug report, with a space
(search-forward "q{")
(should (nth 3 (syntax-ppss)))
;; bad (but now fixed) example from the bug report, without space
(search-forward "q{")
(should (nth 3 (syntax-ppss)))
;; calling a method "q" (parens instead of braces to make it valid)
(search-forward "q(")
(should-not (nth 3 (syntax-ppss)))))
(ert-deftest cperl-test-bug-28650 ()
"Verify that regular expressions are recognized after 'return'.
The test uses the syntax property \"inside a string\" for the
text in regular expressions, which is non-nil for both cperl-mode
and perl-mode."
(with-temp-buffer
(insert-file-contents (ert-resource-file "cperl-bug-26850.pl"))
(goto-char (point-min))
(re-search-forward "sub interesting {[^}]*}")
(should-not (equal (nth 3 (cperl-test-ppss (match-string 0) "Today"))
nil))
(re-search-forward "sub boring {[^}]*}")
(should-not (equal (nth 3 (cperl-test-ppss (match-string 0) "likes\\?"))
nil))))
(ert-deftest cperl-test-bug-30393 ()
"Verify that indentation is not disturbed by an open paren in col 0.
Perl is not Lisp: An open paren in column 0 does not start a function."
(cperl--run-test-cases
(ert-resource-file "cperl-bug-30393.pl")
(while (null (eobp))
(cperl-indent-command)
(forward-line 1))))
(ert-deftest cperl-test-bug-37127 ()
"Verify that closing a paren in a regex goes without a message.
Also check that the message is issued if the regex terminator is
missing."
;; The actual fix for this bug is in simple.el, which is not
;; backported to older versions of Emacs. Therefore we skip this
;; test if we're running Emacs 27 or older.
(skip-unless (< 27 emacs-major-version))
;; Part one: Regex is ok, no messages
(ert-with-message-capture collected-messages
(with-temp-buffer
(insert "$_ =~ /(./;")
(funcall cperl-test-mode)
(goto-char (point-min))
(search-forward ".")
(let ((last-command-event ?\))
;; Don't emit "Matches ..." even if not visible (e.g. in batch).
(blink-matching-paren 'jump-offscreen))
(self-insert-command 1)
;; `self-insert-command' doesn't call `blink-matching-open' in
;; batch mode, so we need to call it explicitly.
(blink-matching-open))
(syntax-propertize (point-max)))
(should (string-equal collected-messages "")))
;; part two: Regex terminator missing -> message
(when (eq cperl-test-mode #'cperl-mode)
;; This test is only run in `cperl-mode' because only cperl-mode
;; emits a message to warn about such unclosed REs.
(ert-with-message-capture collected-messages
(with-temp-buffer
(insert "$_ =~ /(..;")
(goto-char (point-min))
(funcall cperl-test-mode)
(search-forward ".")
(let ((last-command-event ?\)))
(self-insert-command 1))
(syntax-propertize (point-max)))
(should (string-match "^End of .* string/RE"
collected-messages)))))
(ert-deftest cperl-test-bug-42168 ()
"Verify that '/' is a division after ++ or --, not a regexp.
Reported in https://github.com/jrockway/cperl-mode/issues/45.
If seen as regular expression, then the slash is displayed using
font-lock-constant-face. If seen as a division, then it doesn't
have a face property."
:tags '(:fontification)
;; The next two Perl expressions have divisions. The slash does not
;; start a string.
(let ((code "{ $a++ / $b }"))
(should (equal (nth 8 (cperl-test-ppss code "/")) nil)))
(let ((code "{ $a-- / $b }"))
(should (equal (nth 8 (cperl-test-ppss code "/")) nil)))
;; The next two Perl expressions have regular expressions. The slash
;; starts a string.
(let ((code "{ $a+ / $b } # /"))
(should (equal (nth 8 (cperl-test-ppss code "/")) 7)))
(let ((code "{ $a- / $b } # /"))
(should (equal (nth 8 (cperl-test-ppss code "/")) 7))))
(ert-deftest cperl-test-bug-45255 ()
"Verify that \"<<>>\" is recognized as not starting a HERE-doc."
(let ((code (concat "while (<<>>) {\n"
" ...;\n"
"}\n")))
;; The yadda-yadda operator should not be in a string.
(should (equal (nth 8 (cperl-test-ppss code "\\.")) nil))))
(ert-deftest cperl-test-bug-47112 ()
"Check that in a bareword starting with a quote-like operator
followed by an underscore is not interpreted as that quote-like
operator. Also check that a quote-like operator followed by a
colon (which is, like ?_, a symbol in CPerl mode) _is_ identified
as that quote like operator."
(with-temp-buffer
(funcall cperl-test-mode)
(insert "sub y_max { q:bar:; y _bar_foo_; }")
(goto-char (point-min))
(syntax-propertize (point-max))
(font-lock-ensure)
(search-forward "max")
(should (equal (get-text-property (match-beginning 0) 'face)
'font-lock-function-name-face))
(search-forward "bar")
(should (equal (get-text-property (match-beginning 0) 'face)
'font-lock-string-face))
; perl-mode doesn't highlight
(when (eq cperl-test-mode #'cperl-mode)
(search-forward "_")
(should (equal (get-text-property (match-beginning 0) 'face)
(if (eq cperl-test-mode #'cperl-mode)
'font-lock-constant-face
font-lock-string-face))))))
(ert-deftest cperl-test-hyperactive-electric-else ()
"Demonstrate cperl-electric-else behavior.
If `cperl-electric-keywords' is true, keywords like \"else\" and
\"continue\" are expanded by a following empty block, with the
cursor in the appropriate position to write that block. This,
however, must not happen when the keyword occurs in a variable
\"$else\" or \"$continue\"."
(skip-unless (eq cperl-test-mode #'cperl-mode))
;; `self-insert-command' takes a second argument only since Emacs 27
(skip-unless (not (< emacs-major-version 27)))
(with-temp-buffer
(setq cperl-electric-keywords t)
(cperl-mode)
(insert "continue")
(self-insert-command 1 ?\ )
(indent-region (point-min) (point-max))
(goto-char (point-min))
;; cperl-mode creates a block here
(should (search-forward-regexp "continue {\n[[:blank:]]+\n}")))
(with-temp-buffer
(setq cperl-electric-keywords t)
(cperl-mode)
(insert "$continue")
(self-insert-command 1 ?\ )
(indent-region (point-min) (point-max))
(goto-char (point-min))
;; No block should have been created here
(should-not (search-forward-regexp "{" nil t))))
(ert-deftest cperl-test-bug-47598 ()
"Check that a file test followed by ? is no longer interpreted
as a regex."
;; Testing the text from the bug report
(with-temp-buffer
(insert "my $f = -f ? 'file'\n")
(insert " : -l ? [readlink]\n")
(insert " : -d ? 'dir'\n")
(insert " : 'unknown';\n")
(funcall cperl-test-mode)
;; Perl mode doesn't highlight file tests as functions, so we
;; can't test for the function's face. But we can verify that the
;; function is not a string.
(goto-char (point-min))
(search-forward "?")
(should-not (nth 3 (syntax-ppss (point)))))
;; Testing the actual targets for the regexp: m?foo? (still valid)
;; and ?foo? (invalid since Perl 5.22)
(with-temp-buffer
(insert "m?foo?;")
(funcall cperl-test-mode)
(should (nth 3 (syntax-ppss 3))))
(with-temp-buffer
(insert " ?foo?;")
(funcall cperl-test-mode)
(should-not (nth 3 (syntax-ppss 3)))))
(ert-deftest test-indentation ()
(ert-test-erts-file (ert-resource-file "cperl-indents.erts")))
;;; cperl-mode-tests.el ends here
|