emacs/test/manual/redisplay-testsuite.el

409 lines
15 KiB
EmacsLisp

;;; redisplay-testsuite.el --- Test suite for redisplay. -*- lexical-binding: t; -*-
;; Copyright (C) 2009-2024 Free Software Foundation, Inc.
;; Author: Chong Yidong <cyd@stupidchicken.com>
;; Keywords: internal
;; Human-Keywords: internal
;; 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:
;; Type M-x test-redisplay RET to generate the test buffer.
;;; Code:
(defun test-insert-overlay (text &rest props)
(let ((opoint (point))
overlay)
(insert text)
(setq overlay (make-overlay opoint (point)))
(while props
(overlay-put overlay (car props) (cadr props))
(setq props (cddr props)))
overlay))
(defun test-redisplay-1 ()
(insert "Test 1: Displaying adjacent and overlapping overlays:\n\n")
(insert " Expected: gnu emacs\n")
(insert " Results: ")
(test-insert-overlay "n" 'before-string "g" 'after-string "u ")
(test-insert-overlay "ma" 'before-string "e" 'after-string "cs")
(insert "\n\n")
(insert " Expected: gnu emacs\n")
(insert " Results: ")
(test-insert-overlay "u" 'before-string "gn")
(test-insert-overlay "ma" 'before-string " e" 'after-string "cs")
(insert "\n\n")
(insert " Expected: gnu emacs\n")
(insert " Results: ")
(test-insert-overlay "XXX" 'display "u "
'before-string "gn" 'after-string "em")
(test-insert-overlay "a" 'after-string "cs")
(insert "\n\n")
(insert " Expected: gnu emacs\n")
(insert " Results: ")
(test-insert-overlay "u " 'before-string "gn" 'after-string "em")
(test-insert-overlay "XXX" 'display "a" 'after-string "cs")
(insert "\n\n"))
(defun test-redisplay-2 ()
(insert "Test 2: Mouse highlighting. Move your mouse over the letters XXX:\n\n")
(insert " Expected: "
(propertize "xxxXXXxxx" 'face 'highlight)
"...---...\n Test: ")
(test-insert-overlay "XXX" 'before-string "xxx" 'after-string "xxx"
'mouse-face 'highlight )
(test-insert-overlay "---" 'before-string "..." 'after-string "...")
(insert "\n\n Expected: "
(propertize "xxxXXX" 'face 'highlight)
"...---...\n Test: ")
(test-insert-overlay "XXX" 'before-string "xxx" 'mouse-face 'highlight)
(test-insert-overlay "---" 'before-string "..." 'after-string "...")
(insert "\n\n Expected: "
(propertize "XXX" 'face 'highlight)
"...---...\n Test: ")
(test-insert-overlay "..." 'display "XXX" 'mouse-face 'highlight)
(test-insert-overlay "---" 'before-string "..." 'after-string "...")
(insert "\n\n Expected: "
(propertize "XXXxxx" 'face 'highlight)
"...\n Test: ")
(test-insert-overlay "..." 'display "XXX" 'after-string "xxx"
'mouse-face 'highlight)
(test-insert-overlay "error" 'display "...")
(insert "\n\n Expected: "
"---..."
(propertize "xxxXXX" 'face 'highlight)
"\n Test: ")
(test-insert-overlay "xxx" 'display "---" 'after-string "...")
(test-insert-overlay "error" 'before-string "xxx" 'display "XXX"
'mouse-face 'highlight)
(insert "\n\n Expected: "
"...---..."
(propertize "xxxXXXxxx" 'face 'highlight)
"\n Test: ")
(test-insert-overlay "---" 'before-string "..." 'after-string "...")
(test-insert-overlay "XXX" 'before-string "xxx" 'after-string "xxx"
'mouse-face 'highlight)
(insert "\n\n Expected: "
"..."
(propertize "XXX" 'face 'highlight)
"...\n Test: ")
(test-insert-overlay "---"
'display (propertize "XXX" 'mouse-face 'highlight)
'before-string "..."
'after-string "...")
(insert "\n\n Expected: "
(propertize "XXX\n" 'face 'highlight)
"\n Test: ")
(test-insert-overlay "XXX\n" 'mouse-face 'highlight)
(insert "\n\n"))
(defun test-redisplay-3 ()
(insert "Test 3: Overlay with strings and images:\n\n")
(let ((img-data "#define x_width 8
#define x_height 8
static unsigned char x_bits[] = {0xff, 0x81, 0xbd, 0xa5, 0xa5, 0xbd, 0x81, 0xff };"))
;; Control
(insert " Expected: AB"
(propertize "X" 'display `(image :data ,img-data :type xbm))
"CD\n")
;; Overlay with before, after, and image display string.
(insert " Result 1: ")
(let ((opoint (point)))
(insert "AXD\n")
(let ((ov (make-overlay (1+ opoint) (+ 2 opoint))))
(overlay-put ov 'before-string "B")
(overlay-put ov 'after-string "C")
(overlay-put ov 'display
`(image :data ,img-data :type xbm))))
;; Overlay with before and after string, and image text prop.
(insert " Result 2: ")
(let ((opoint (point)))
(insert "AXD\n")
(let ((ov (make-overlay (1+ opoint) (+ 2 opoint))))
(overlay-put ov 'before-string "B")
(overlay-put ov 'after-string "C")
(put-text-property (1+ opoint) (+ 2 opoint) 'display
`(image :data ,img-data :type xbm))))
;; Overlays with adjacent before and after strings, and image text
;; prop.
(insert " Result 3: ")
(let ((opoint (point)))
(insert "AXD\n")
(let ((ov1 (make-overlay opoint (1+ opoint)))
(ov2 (make-overlay (+ 2 opoint) (+ 3 opoint))))
(overlay-put ov1 'after-string "B")
(overlay-put ov2 'before-string "C")
(put-text-property (1+ opoint) (+ 2 opoint) 'display
`(image :data ,img-data :type xbm))))
;; Three overlays.
(insert " Result 4: ")
(let ((opoint (point)))
(insert "AXD\n\n")
(let ((ov1 (make-overlay opoint (1+ opoint)))
(ov2 (make-overlay (+ 2 opoint) (+ 3 opoint)))
(ov3 (make-overlay (1+ opoint) (+ 2 opoint))))
(overlay-put ov1 'after-string "B")
(overlay-put ov2 'before-string "C")
(overlay-put ov3 'display `(image :data ,img-data :type xbm))))))
(defun test-redisplay-4 ()
(insert "Test 4: Overlay strings and invisibility:\n\n")
;; Before and after strings with non-nil `invisibility'.
(insert " Expected: ABC\n")
(insert " Result: ")
(let ((opoint (point)))
(insert "ABC\n")
(let ((ov (make-overlay (1+ opoint) (+ 2 opoint))))
(overlay-put ov 'before-string
(propertize "XX" 'invisible
'test-redisplay--simple-invis))
(overlay-put ov 'after-string
(propertize "XX" 'invisible
'test-redisplay--simple-invis))))
;; Before and after strings bogus `invisibility' property (value is
;; not listed in `buffer-invisibility-spec').
(insert "\n Expected: ABC")
(insert "\n Result: ")
(let ((opoint (point)))
(insert "B\n")
(let ((ov (make-overlay opoint (1+ opoint))))
(overlay-put ov 'before-string
(propertize "A" 'invisible 'bogus-invis-spec))
(overlay-put ov 'after-string
(propertize "C" 'invisible 'bogus-invis-spec))))
;; Before/after string with ellipsis `invisibility' property.
(insert "\n Expected: ...B...")
(insert "\n Result: ")
(let ((opoint (point)))
(insert "B\n")
(let ((ov (make-overlay opoint (1+ opoint))))
(overlay-put ov 'before-string
(propertize "A" 'invisible 'test-redisplay--ellipsis-invis))
(overlay-put ov 'after-string
(propertize "C" 'invisible 'test-redisplay--ellipsis-invis))))
;; Before/after string with partial ellipsis `invisibility' property.
(insert "\n Expected: A...ABC...C")
(insert "\n Result: ")
(let ((opoint (point)))
(insert "B\n")
(let ((ov (make-overlay opoint (1+ opoint)))
(a "AAA")
(c "CCC"))
(put-text-property 1 2 'invisible 'test-redisplay--ellipsis-invis a)
(put-text-property 1 2 'invisible 'test-redisplay--ellipsis-invis c)
(overlay-put ov 'before-string a)
(overlay-put ov 'after-string c)))
;; Display string with `invisibility' property.
(insert "\n Expected: ABC")
(insert "\n Result: ")
(let ((opoint (point)))
(insert "AYBC\n")
(let ((ov (make-overlay (1+ opoint) (+ 2 opoint))))
(overlay-put ov 'display
(propertize "XX" 'invisible
'test-redisplay--simple-invis))))
;; Display string with bogus `invisibility' property.
(insert "\n Expected: ABC")
(insert "\n Result: ")
(let ((opoint (point)))
(insert "AXC\n")
(let ((ov (make-overlay (1+ opoint) (+ 2 opoint))))
(overlay-put ov 'display
(propertize "B" 'invisible 'bogus-invis-spec))))
;; Display string with ellipsis `invisibility' property.
(insert "\n Expected: A...C")
(insert "\n Result: ")
(let ((opoint (point)))
(insert "AXC\n")
(let ((ov (make-overlay (1+ opoint) (+ 2 opoint))))
(overlay-put ov 'display
(propertize "B" 'invisible
'test-redisplay--ellipsis-invis))))
;; Display string with partial `invisibility' property.
(insert "\n Expected: A...C")
(insert "\n Result: ")
(let ((opoint (point)))
(insert "X\n")
(let ((ov (make-overlay opoint (1+ opoint)))
(str "ABC"))
(put-text-property 1 2 'invisible 'test-redisplay--ellipsis-invis str)
(overlay-put ov 'display str)))
;; Overlay string over invisible text and non-default face.
(insert "\n Expected: ..." (propertize "ABC" 'face 'highlight) "XYZ")
(insert "\n Result: ")
(insert (propertize "foo" 'invisible 'test-redisplay--ellipsis-invis))
(let ((ov (make-overlay (point) (point))))
(overlay-put ov 'invisible t)
(overlay-put ov 'window (selected-window))
(overlay-put ov 'after-string
(propertize "ABC" 'face 'highlight)))
(insert "XYZ\n")
;; Overlay strings with partial `invisibility' property and with a
;; display property on the before-string.
(insert "\n Expected: ..."
(propertize "DEF" 'display '(image :type xpm :file "close.xpm"))
(propertize "ABC" 'face 'highlight) "XYZ")
(insert "\n Result: ")
(insert (propertize "foo" 'invisible 'test-redisplay--ellipsis-invis))
(let ((ov (make-overlay (point) (point))))
(overlay-put ov 'invisible t)
(overlay-put ov 'window (selected-window))
(overlay-put ov 'after-string
(propertize "ABC" 'face 'highlight))
(overlay-put ov 'before-string
(propertize "DEF"
'display '(image :type xpm :file "close.xpm"))))
(insert "XYZ\n")
;; Overlay string with 2 adjacent and different invisible
;; properties. This caused an infloop before Emacs 25.
(insert "\n Expected: ABC")
(insert "\n Result: ")
(let ((opoint (point)))
(insert "ABC\n")
(let ((ov (make-overlay (1+ opoint) (+ 2 opoint)))
(str (concat (propertize "X"
'invisible 'test-redisplay--simple-invis)
(propertize "Y"
'invisible 'test-redisplay--simple-invis2))))
(overlay-put ov 'after-string str)))
(insert "\n"))
(defvar test-redisplay-5a-expected-overlay nil)
(defvar test-redisplay-5a-result-overlay nil)
(defvar test-redisplay-5b-expected-overlay nil)
(defvar test-redisplay-5b-result-overlay nil)
(defun test-redisplay-5-toggle (_event)
(interactive "e")
(setq display-raw-bytes-as-hex (not display-raw-bytes-as-hex))
(let ((label (if display-raw-bytes-as-hex "\\x80" "\\200")))
(overlay-put test-redisplay-5a-expected-overlay 'display
(propertize label 'face 'escape-glyph)))
(let ((label (if display-raw-bytes-as-hex "\\x3fffc" "\\777774")))
(overlay-put test-redisplay-5b-expected-overlay 'display
(propertize label 'face 'escape-glyph))))
(defun test-redisplay-5 ()
(insert "Test 5: Display of raw bytes:\n\n")
(insert " Expected: ")
(setq test-redisplay-5a-expected-overlay
(test-insert-overlay " " 'display
(propertize "\\200" 'face 'escape-glyph)))
(insert "\n Result: ")
(setq test-redisplay-5a-result-overlay
(test-insert-overlay " " 'display "\200"))
(insert "\n\n")
(insert " Expected: ")
;; This tests a large codepoint, to make sure the internal buffer we
;; use to produce the representation is large enough.
(aset printable-chars #x3fffc nil)
(setq test-redisplay-5b-expected-overlay
(test-insert-overlay " " 'display
(propertize "\\777774" 'face 'escape-glyph)))
(insert "\n Result: ")
(setq test-redisplay-5b-result-overlay
(test-insert-overlay " " 'display (char-to-string #x3fffc)))
(insert "\n\n")
(insert-button "Toggle between octal and hex display"
'action 'test-redisplay-5-toggle)
(insert "\n\n"))
(defun test-redisplay-6 ()
(insert "Test 6: min-width display property:\n\n")
(insert " Expected: 123 45\n")
(insert " Results: "
(propertize "123" 'display '((min-width (5))))
"45")
(insert "\n\n")
(insert " Expected: 12 34 5\n")
(insert " Results: "
(propertize "12" 'display '((min-width (4))))
(propertize "34" 'display '((min-width (4))))
"5")
(insert "\n\n")
(insert " Expected: 1gnu 45\n")
(insert " Results: "
"1"
(propertize "23" 'display
(propertize "gnu" 'display '((min-width (5)))))
"45")
(insert "\n\n")
(insert " Expected: 123 45\n")
(insert " Results: ")
(test-insert-overlay "123" 'display '((min-width (5))))
(insert "45")
(insert "\n\n")
(insert " Expected: 1_23 45\n")
(insert " Results: ")
(insert (propertize "123" 'display '((min-width (5)))))
(let ((overlay (make-overlay (- (point) 1) (- (point) 2))))
(overlay-put overlay 'before-string "_"))
(insert "45")
(insert "\n\n")
(insert (propertize "_" 'display '(left-fringe large-circle))
" Expected: 123 45\n")
(insert " Results: ")
(insert (propertize "123" 'display '((min-width (5)))))
(let ((overlay (make-overlay (- (point) 2) (- (point) 1))))
(overlay-put overlay 'before-string
(propertize "_" 'display '(left-fringe large-circle))))
(insert "45")
(insert "\n\n")
(insert (propertize "_" 'display '(left-fringe large-circle))
" Expected: 123 45\n")
(insert " Results: ")
(insert (propertize "123" 'display '((min-width (5)))))
(let ((overlay1 (make-overlay (- (point) 3) (point)))
(overlay2 (make-overlay (- (point) 2) (- (point) 1))))
(overlay-put overlay1 'display '((min-width (5))))
(overlay-put overlay2 'before-string
(propertize "_" 'display '(left-fringe large-circle))))
(insert "45"))
(defun test-redisplay ()
(interactive)
(let ((buf (get-buffer "*Redisplay Test*")))
(if buf
(kill-buffer buf))
(switch-to-buffer (get-buffer-create "*Redisplay Test*"))
(erase-buffer)
(setq buffer-invisibility-spec
'(test-redisplay--simple-invis
test-redisplay--simple-invis2
(test-redisplay--ellipsis-invis . t)))
(test-redisplay-1)
(test-redisplay-2)
(test-redisplay-3)
(test-redisplay-4)
(test-redisplay-5)
(test-redisplay-6)
(goto-char (point-min))))
;;; redisplay-testsuite.el ends here