aboutsummaryrefslogtreecommitdiffstats
path: root/test/lisp/visual-wrap-tests.el
blob: 4fc033ec69e988179b1020a45dae022c6ff4c9ee (plain) (blame)
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
;;; visual-wrap-tests.el --- Tests for `visual-wrap-prefix-mode'  -*- lexical-binding: t; -*-

;; Copyright (C) 2024-2026 Free Software Foundation, Inc.

;; 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:

;; Tests for `visual-wrap-prefix-mode'.

;;; Code:

(require 'visual-wrap)
(require 'ert)

;;; Tests:

(ert-deftest visual-wrap-tests/simple ()
  "Test adding wrapping properties to text without display properties."
  (with-temp-buffer
    (insert "greetings\n* hello\n* hi")
    (visual-wrap-prefix-function (point-min) (point-max))
    (should (equal-including-properties
             (buffer-string)
             #("greetings\n* hello\n* hi"
               10 12 ( wrap-prefix (space :align-to (2 . width))
                       display (min-width ((2 . width))))
               12 17 ( wrap-prefix (space :align-to (2 . width)))
               18 20 ( wrap-prefix (space :align-to (2 . width))
                       display (min-width ((2 . width))))
               20 22 ( wrap-prefix (space :align-to (2 . width))))))))

(ert-deftest visual-wrap-tests/safe-display ()
  "Test adding wrapping properties to text with safe display properties."
  (with-temp-buffer
    (insert #("* hello" 2 7 (display (raise 1))))
    (visual-wrap-prefix-function (point-min) (point-max))
    (should (equal-including-properties
             (buffer-string)
             #("* hello"
               0 2 ( wrap-prefix (space :align-to (2 . width))
                     display (min-width ((2 . width))))
               2 7 ( wrap-prefix (space :align-to (2 . width))
                     display (raise 1)))))))

(ert-deftest visual-wrap-tests/unsafe-display/within-line ()
  "Test adding wrapping properties to text with unsafe display properties.
When these properties don't extend across multiple lines,
`visual-wrap-prefix-mode' can still add wrapping properties."
  (with-temp-buffer
    (insert #("* [img]" 2 7 (display (image :type bmp))))
    (visual-wrap-prefix-function (point-min) (point-max))
    (should (equal-including-properties
             (buffer-string)
             #("* [img]"
               0 2 ( wrap-prefix (space :align-to (2 . width))
                     display (min-width ((2 . width))))
               2 7 ( wrap-prefix (space :align-to (2 . width))
                     display (image :type bmp)))))))

(ert-deftest visual-wrap-tests/unsafe-display/spanning-lines ()
  "Test adding wrapping properties to text with unsafe display properties.
When these properties do extend across multiple lines,
`visual-wrap-prefix-mode' must avoid adding wrapping properties."
  (with-temp-buffer
    (insert #("* a\n* b" 0 7 (display (image :type bmp))))
    (visual-wrap-prefix-function (point-min) (point-max))
    (should (equal-including-properties
             (buffer-string)
             #("* a\n* b" 0 7 (display (image :type bmp)))))))

(ert-deftest visual-wrap-tests/unsafe-display/multiple-1 ()
  "Test adding wrapping properties to text with unsafe display properties.
This tests a multi-line unsafe display prop immediately followed by a
single-line unsafe display prop.  `visual-wrap-prefix-mode' should *not*
add wrapping properties to either block."
  (with-temp-buffer
    (insert #("* a\n* b"
              0 4 (display ((image :type bmp)))
              4 7 (display ((image :type bmp) (height 1.5)))))
    (visual-wrap-prefix-function (point-min) (point-max))
    (should (equal-including-properties
             (buffer-string)
             ;; NOTE: See the note in `visual-wrap-prefix-function'.  If
             ;; applying the change mentioned there, then this case
             ;; should add wrapping properties to the second block.
             #("* a\n* b"
              0 4 (display ((image :type bmp)))
              4 7 (display ((image :type bmp) (height 1.5))))))))

(ert-deftest visual-wrap-tests/unsafe-display/multiple-2 ()
  "Test adding wrapping properties to text with unsafe display properties.
This tests a multi-line unsafe display prop immediately followed by
another multi-line unsafe display prop.  `visual-wrap-prefix-mode'
should *not* add wrapping properties to either block."
  (with-temp-buffer
    (insert #("* a\n* b\n"
              0 4 (display ((image :type bmp)))
              4 8 (display ((image :type bmp) (height 1.5)))))
    (visual-wrap-prefix-function (point-min) (point-max))
    (should (equal-including-properties
             (buffer-string)
             #("* a\n* b\n"
              0 4 (display ((image :type bmp)))
              4 8 (display ((image :type bmp) (height 1.5))))))))

(ert-deftest visual-wrap-tests/wrap-prefix-stickiness ()
  "Test that `wrap-prefix' doesn't persist across multiple lines when typing.
See bug#76018."
  (with-temp-buffer
    (insert "* this zoo contains goats")
    (visual-wrap-prefix-function (point-min) (point-max))
    (should (equal-including-properties
             (buffer-string)
             #("* this zoo contains goats"
               0  2 ( wrap-prefix (space :align-to (2 . width))
                      display (min-width ((2 . width))))
               2 25 ( wrap-prefix (space :align-to (2 . width))))))
    (let ((start (point)))
      (insert-and-inherit "\n\nit also contains pandas")
      (visual-wrap-prefix-function start (point-max)))
    (should (equal-including-properties
             (buffer-string)
             #("* this zoo contains goats\n\nit also contains pandas"
               0  2 ( wrap-prefix (space :align-to (2 . width))
                      display (min-width ((2 . width))))
               2 25 ( wrap-prefix (space :align-to (2 . width))))))))

(ert-deftest visual-wrap-tests/cleanup ()
  "Test that deactivating `visual-wrap-prefix-mode' cleans up text properties."
  (with-temp-buffer
    (insert "* hello\n* hi")
    (visual-wrap-prefix-function (point-min) (point-max))
    ;; Make sure we've added the visual-wrapping properties.
    (should (equal (text-properties-at (point-min))
                   '( wrap-prefix (space :align-to (2 . width))
                      display (min-width ((2 . width))))))
    (visual-wrap-prefix-mode -1)
    (should (equal-including-properties
             (buffer-string)
             "* hello\n* hi"))))

;; visual-wrap-tests.el ends here