;;; char-fold-tests.el --- Tests for char-fold.el -*- lexical-binding: t; -*-
;; Copyright (C) 2013-2021 Free Software Foundation, Inc.
;; Author: Artur Malabarba <bruce.connor.am@gmail.com>
;; 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/>.
;;; Code:
(require 'ert)
(require 'char-fold)
(defun char-fold--random-word (n)
(mapconcat (lambda (_) (string (+ 9 (random 117))))
(make-list n nil) ""))
(defun char-fold--ascii-upcase (string)
"Like `upcase' but acts on ASCII characters only."
(replace-regexp-in-string "[a-z]+" 'upcase string))
(defun char-fold--ascii-downcase (string)
"Like `downcase' but acts on ASCII characters only."
(replace-regexp-in-string "[a-z]+" 'downcase string))
(defun char-fold--test-match-exactly (string &rest strings-to-match)
(let ((re (concat "\\`" (char-fold-to-regexp string) "\\'")))
(dolist (it strings-to-match)
(should (string-match re it)))
;; Case folding
(let ((case-fold-search t))
(dolist (it strings-to-match)
(should (string-match (char-fold--ascii-upcase re) (downcase it)))
(should (string-match (char-fold--ascii-downcase re) (upcase it)))))))
(defun char-fold--test-no-match-exactly (string &rest strings-to-match)
(let ((re (concat "\\`" (char-fold-to-regexp string) "\\'")))
(dolist (it strings-to-match)
(should-not (string-match re it)))
;; Case folding
(let ((case-fold-search t))
(dolist (it strings-to-match)
(should-not (string-match (char-fold--ascii-upcase re) (downcase it)))
(should-not (string-match (char-fold--ascii-downcase re) (upcase it)))))))
(defun char-fold--test-search-with-contents (contents string)
(with-temp-buffer
(insert contents)
(goto-char (point-min))
(should (search-forward-regexp (char-fold-to-regexp string) nil 'noerror))
(goto-char (point-min))
(should (char-fold-search-forward string nil 'noerror))
(should (char-fold-search-backward string nil 'noerror))))
(defun char-fold--permutation (strings)
(mapcar (lambda (string)
(cons string (remove string strings)))
strings))
(ert-deftest char-fold--test-consistency ()
(dotimes (n 30)
(let ((w (char-fold--random-word n)))
;; A folded string should always match the original string.
(char-fold--test-search-with-contents w w))))
(ert-deftest char-fold--test-lax-whitespace ()
(dotimes (n 40)
(let ((w1 (char-fold--random-word n))
(w2 (char-fold--random-word n))
(search-spaces-regexp "\\s-+"))
(char-fold--test-search-with-contents
(concat w1 "\s\n\s\t\f\t\n\r\t" w2)
(concat w1 " " w2))
(char-fold--test-search-with-contents
(concat w1 "\s\n\s\t\f\t\n\r\t" w2)
(concat w1 (make-string 10 ?\s) w2)))))
(ert-deftest char-fold--test-multi-defaults ()
(dolist (it '(("ffl" . "ffl") ("ffi" . "ffi")
("fi" . "fi") ("ff" . "ff")
("ä" . "ä")))
(char-fold--test-search-with-contents (cdr it) (car it))
(let ((multi (char-table-extra-slot char-fold-table 0))
(char-fold-table (make-char-table 'char-fold-table)))
(set-char-table-extra-slot char-fold-table 0 multi)
(char-fold--test-match-exactly (car it) (cdr it)))))
(ert-deftest char-fold--test-multi-lax ()
(dolist (it '(("f" . "fi") ("f" . "ff")))
(with-temp-buffer
(insert (cdr it))
(goto-char (point-min))
(should (search-forward-regexp
(char-fold-to-regexp (car it) 'lax) nil 'noerror)))))
(ert-deftest char-fold--test-fold-to-regexp ()
(let ((char-fold-table (make-char-table 'char-fold-table))
(multi (make-char-table 'char-fold-table)))
(set-char-table-extra-slot char-fold-table 0 multi)
(aset char-fold-table ?a "xx")
(aset char-fold-table ?1 "44")
(aset char-fold-table ?\s "-!-")
(char-fold--test-match-exactly "a1a1" "xx44xx44")
(char-fold--test-match-exactly "a1 a 1" "xx44-!--!-xx-!-44")
(aset multi ?a '(("1" . "99")
("2" . "88")
("12" . "77")))
(char-fold--test-match-exactly "a" "xx")
(char-fold--test-match-exactly "a1" "xx44" "99")
(char-fold--test-match-exactly "a12" "77" "xx442" "992")
(char-fold--test-match-exactly "a2" "88")
(aset multi ?1 '(("2" . "yy")))
(char-fold--test-match-exactly "a1" "xx44" "99")
(char-fold--test-match-exactly "a12" "77" "xx442" "992")
;; Support for this case is disabled. See function definition or:
;; https://lists.gnu.org/r/emacs-devel/2015-11/msg02562.html
;; (char-fold--test-match-exactly "a12" "xxyy")
))
(ert-deftest char-fold--speed-test ()
(dolist (string (append '("tty-set-up-initial-frame-face"
"tty-set-up-initial-frame-face-frame-faceframe-faceframe-faceframe-face")
(mapcar #'char-fold--random-word '(10 50 100 50 100))))
;; Make sure we didn't just fallback on the trivial search.
(should-not (string= (regexp-quote string)
(char-fold-to-regexp string)))
(with-temp-buffer
(save-excursion (insert string))
(let ((time (time-to-seconds)))
;; Our initial implementation of case-folding in char-folding
;; created a lot of redundant paths in the regexp. Because of
;; that, if a really long string "almost" matches, the regexp
;; engine took a long time to realize that it doesn't match.
(should-not (char-fold-search-forward (concat string "c") nil 'noerror))
;; Ensure it took less than a second.
(should (< (- (time-to-seconds) time) 1))))))
(ert-deftest char-fold--test-without-customization ()
(let* ((matches
'(
("'" "’")
("e" "ℯ" "ḗ" "ë" "ë")
("ι"
"ί" ;; 1 level decomposition
"ί" ;; 2 level decomposition
"ΐ" ;; 3 level decomposition
)
("ß" "ss")
))
(no-matches
'(
("и" "й")
)))
(dolist (strings matches)
(apply 'char-fold--test-match-exactly strings))
(dolist (strings no-matches)
(apply 'char-fold--test-no-match-exactly strings))))
(ert-deftest char-fold--test-with-customization ()
:tags '(:expensive-test)
;; FIXME: move some language-specific settings to defaults
(let ((char-fold-include
(append char-fold-include
'(
(?o "ø") ;; da no nb nn
(?l "ł") ;; pl
(?æ "ae")
(?→ "->")
(?⇒ "=>")
)))
(char-fold-exclude
(append char-fold-exclude
'(
(?a "å") ;; da no nb nn sv
(?a "ä") ;; et fi sv
(?o "ö") ;; et fi sv
(?n "ñ") ;; es
)))
(char-fold-symmetric t)
(matches
'(
("e" "ℯ" "ḗ" "ë" "ë")
("е" "ё" "ё")
("ι" "ί" "ί" "ΐ")
("ß" "ss")
("o" "ø")
("l" "ł")
("æ" "ae")
("→" "->")
("⇒" "=>")
))
(no-matches
'(
("a" "å")
("a" "ä")
("o" "ö")
("n" "ñ")
("и" "й")
))
;; Don't override global value by char-fold-update-table below
char-fold-table)
(char-fold-update-table)
(dolist (strings matches)
(dolist (permutation (char-fold--permutation strings))
(apply 'char-fold--test-match-exactly permutation)))
(dolist (strings no-matches)
(dolist (permutation (char-fold--permutation strings))
(apply 'char-fold--test-no-match-exactly permutation)))))
(provide 'char-fold-tests)
;;; char-fold-tests.el ends here