summaryrefslogtreecommitdiffstats
path: root/testing/web-platform/tests/editing/include/editor-test-utils.js
blob: 24527d4a7931f7f41d34ec1150f82fe0867f6b3b (plain)
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
/**
 * EditorTestUtils is a helper utilities to test HTML editor.  This can be
 * instantiated per an editing host.  If you test `designMode`, the editing
 * host should be the <body> element.
 * Note that if you want to use sendKey in a sub-document, you need to include
 * testdriver.js (and related files) from the sub-document before creating this.
 */
class EditorTestUtils {
  kShift = "\uE008";
  kMeta = "\uE03d";
  kControl = "\uE009";
  kAlt = "\uE00A";

  editingHost;

  constructor(aEditingHost, aHarnessWindow = window) {
    this.editingHost = aEditingHost;
    if (aHarnessWindow != this.window && this.window.test_driver) {
      this.window.test_driver.set_test_context(aHarnessWindow);
    }
  }

  get document() {
    return this.editingHost.ownerDocument;
  }
  get window() {
    return this.document.defaultView;
  }
  get selection() {
    return this.window.getSelection();
  }

  sendKey(key, modifier) {
    if (!modifier) {
      return this.window.test_driver.send_keys(this.editingHost, key)
        .catch(() => {
          return new this.window.test_driver.Actions()
          .keyDown(key)
          .keyUp(key)
          .send();
        });
    }
    return new this.window.test_driver.Actions()
      .keyDown(modifier)
      .keyDown(key)
      .keyUp(key)
      .keyUp(modifier)
      .send();
  }

  sendDeleteKey(modifier) {
    const kDeleteKey = "\uE017";
    return this.sendKey(kDeleteKey, modifier);
  }

  sendBackspaceKey(modifier) {
    const kBackspaceKey = "\uE003";
    return this.sendKey(kBackspaceKey, modifier);
  }

  sendArrowLeftKey(modifier) {
    const kArrowLeft = "\uE012";
    return this.sendKey(kArrowLeft, modifier);
  }

  sendArrowRightKey(modifier) {
    const kArrowRight = "\uE014";
    return this.sendKey(kArrowRight, modifier);
  }

  sendHomeKey(modifier) {
    const kHome = "\uE011";
    return this.sendKey(kHome, modifier);
  }

  sendEndKey(modifier) {
    const kEnd = "\uE010";
    return this.sendKey(kEnd, modifier);
  }

  sendEnterKey(modifier) {
    const kEnter = "\uE007";
    return this.sendKey(kEnter, modifier);
  }

  sendSelectAllShortcutKey() {
    return this.sendKey(
      "a",
      this.window.navigator.platform.includes("Mac")
        ? this.kMeta
        : this.kControl
    );
  }

  // Similar to `setupDiv` in editing/include/tests.js, this method sets
  // innerHTML value of this.editingHost, and sets multiple selection ranges
  // specified with the markers.
  // - `[` specifies start boundary in a text node
  // - `{` specifies start boundary before a node
  // - `]` specifies end boundary in a text node
  // - `}` specifies end boundary after a node
  //
  // options can have following fields:
  // - selection: how to set selection, "addRange" (default),
  //              "setBaseAndExtent", "setBaseAndExtent-reverse".
  setupEditingHost(innerHTMLWithRangeMarkers, options = {}) {
    if (!options.selection) {
      options.selection = "addRange";
    }
    const startBoundaries = innerHTMLWithRangeMarkers.match(/\{|\[/g) || [];
    const endBoundaries = innerHTMLWithRangeMarkers.match(/\}|\]/g) || [];
    if (startBoundaries.length !== endBoundaries.length) {
      throw "Should match number of open/close markers";
    }

    this.editingHost.innerHTML = innerHTMLWithRangeMarkers;
    this.editingHost.focus();

    if (startBoundaries.length === 0) {
      // Don't remove the range for now since some tests may assume that
      // setting innerHTML does not remove all selection ranges.
      return;
    }

    let getNextRangeAndDeleteMarker = startNode => {
      let getNextLeafNode = node => {
        let inclusiveDeepestFirstChildNode = container => {
          while (container.firstChild) {
            container = container.firstChild;
          }
          return container;
        };
        if (node.hasChildNodes()) {
          return inclusiveDeepestFirstChildNode(node);
        }
        if (node === this.editingHost) {
          return null;
        }
        if (node.nextSibling) {
          return inclusiveDeepestFirstChildNode(node.nextSibling);
        }
        let nextSibling = (child => {
          for (
            let parent = child.parentElement;
            parent && parent != this.editingHost;
            parent = parent.parentElement
          ) {
            if (parent.nextSibling) {
              return parent.nextSibling;
            }
          }
          return null;
        })(node);
        if (!nextSibling) {
          return null;
        }
        return inclusiveDeepestFirstChildNode(nextSibling);
      };
      let scanMarkerInTextNode = (textNode, offset) => {
        return /[\{\[\]\}]/.exec(textNode.data.substr(offset));
      };
      let startMarker = ((startContainer, startOffset) => {
        let scanStartMakerInTextNode = (textNode, offset) => {
          let scanResult = scanMarkerInTextNode(textNode, offset);
          if (scanResult === null) {
            return null;
          }
          if (scanResult[0] === "}" || scanResult[0] === "]") {
            throw "An end marker is found before a start marker";
          }
          return {
            marker: scanResult[0],
            container: textNode,
            offset: scanResult.index + offset,
          };
        };
        if (startContainer.nodeType === Node.TEXT_NODE) {
          let scanResult = scanStartMakerInTextNode(
            startContainer,
            startOffset
          );
          if (scanResult !== null) {
            return scanResult;
          }
        }
        let nextNode = startContainer;
        while ((nextNode = getNextLeafNode(nextNode))) {
          if (nextNode.nodeType === Node.TEXT_NODE) {
            let scanResult = scanStartMakerInTextNode(nextNode, 0);
            if (scanResult !== null) {
              return scanResult;
            }
            continue;
          }
        }
        return null;
      })(startNode, 0);
      if (startMarker === null) {
        return null;
      }
      let endMarker = ((startContainer, startOffset) => {
        let scanEndMarkerInTextNode = (textNode, offset) => {
          let scanResult = scanMarkerInTextNode(textNode, offset);
          if (scanResult === null) {
            return null;
          }
          if (scanResult[0] === "{" || scanResult[0] === "[") {
            throw "A start marker is found before an end marker";
          }
          return {
            marker: scanResult[0],
            container: textNode,
            offset: scanResult.index + offset,
          };
        };
        if (startContainer.nodeType === Node.TEXT_NODE) {
          let scanResult = scanEndMarkerInTextNode(startContainer, startOffset);
          if (scanResult !== null) {
            return scanResult;
          }
        }
        let nextNode = startContainer;
        while ((nextNode = getNextLeafNode(nextNode))) {
          if (nextNode.nodeType === Node.TEXT_NODE) {
            let scanResult = scanEndMarkerInTextNode(nextNode, 0);
            if (scanResult !== null) {
              return scanResult;
            }
            continue;
          }
        }
        return null;
      })(startMarker.container, startMarker.offset + 1);
      if (endMarker === null) {
        throw "Found an open marker, but not found corresponding close marker";
      }
      let indexOfContainer = (container, child) => {
        let offset = 0;
        for (let node = container.firstChild; node; node = node.nextSibling) {
          if (node == child) {
            return offset;
          }
          offset++;
        }
        throw "child must be a child node of container";
      };
      let deleteFoundMarkers = () => {
        let removeNode = node => {
          let container = node.parentElement;
          let offset = indexOfContainer(container, node);
          node.remove();
          return { container, offset };
        };
        if (startMarker.container == endMarker.container) {
          // If the text node becomes empty, remove it and set collapsed range
          // to the position where there is the text node.
          if (startMarker.container.length === 2) {
            if (!/[\[\{][\]\}]/.test(startMarker.container.data)) {
              throw `Unexpected text node (data: "${startMarker.container.data}")`;
            }
            let { container, offset } = removeNode(startMarker.container);
            startMarker.container = endMarker.container = container;
            startMarker.offset = endMarker.offset = offset;
            startMarker.marker = endMarker.marker = "";
            return;
          }
          startMarker.container.data = `${startMarker.container.data.substring(
            0,
            startMarker.offset
          )}${startMarker.container.data.substring(
            startMarker.offset + 1,
            endMarker.offset
          )}${startMarker.container.data.substring(endMarker.offset + 1)}`;
          if (startMarker.offset >= startMarker.container.length) {
            startMarker.offset = endMarker.offset =
              startMarker.container.length;
            return;
          }
          endMarker.offset--; // remove the start marker's length
          if (endMarker.offset > endMarker.container.length) {
            endMarker.offset = endMarker.container.length;
          }
          return;
        }
        if (startMarker.container.length === 1) {
          let { container, offset } = removeNode(startMarker.container);
          startMarker.container = container;
          startMarker.offset = offset;
          startMarker.marker = "";
        } else {
          startMarker.container.data = `${startMarker.container.data.substring(
            0,
            startMarker.offset
          )}${startMarker.container.data.substring(startMarker.offset + 1)}`;
        }
        if (endMarker.container.length === 1) {
          let { container, offset } = removeNode(endMarker.container);
          endMarker.container = container;
          endMarker.offset = offset;
          endMarker.marker = "";
        } else {
          endMarker.container.data = `${endMarker.container.data.substring(
            0,
            endMarker.offset
          )}${endMarker.container.data.substring(endMarker.offset + 1)}`;
        }
      };
      deleteFoundMarkers();

      let handleNodeSelectMarker = () => {
        if (startMarker.marker === "{") {
          if (startMarker.offset === 0) {
            // The range start with the text node.
            let container = startMarker.container.parentElement;
            startMarker.offset = indexOfContainer(
              container,
              startMarker.container
            );
            startMarker.container = container;
          } else if (startMarker.offset === startMarker.container.data.length) {
            // The range start after the text node.
            let container = startMarker.container.parentElement;
            startMarker.offset =
              indexOfContainer(container, startMarker.container) + 1;
            startMarker.container = container;
          } else {
            throw 'Start marker "{" is allowed start or end of a text node';
          }
        }
        if (endMarker.marker === "}") {
          if (endMarker.offset === 0) {
            // The range ends before the text node.
            let container = endMarker.container.parentElement;
            endMarker.offset = indexOfContainer(container, endMarker.container);
            endMarker.container = container;
          } else if (endMarker.offset === endMarker.container.data.length) {
            // The range ends with the text node.
            let container = endMarker.container.parentElement;
            endMarker.offset =
              indexOfContainer(container, endMarker.container) + 1;
            endMarker.container = container;
          } else {
            throw 'End marker "}" is allowed start or end of a text node';
          }
        }
      };
      handleNodeSelectMarker();

      let range = document.createRange();
      range.setStart(startMarker.container, startMarker.offset);
      range.setEnd(endMarker.container, endMarker.offset);
      return range;
    };

    let ranges = [];
    for (
      let range = getNextRangeAndDeleteMarker(this.editingHost.firstChild);
      range;
      range = getNextRangeAndDeleteMarker(range.endContainer)
    ) {
      ranges.push(range);
    }

    if (options.selection != "addRange" && ranges.length > 1) {
      throw `Failed due to invalid selection option, ${options.selection}, for multiple selection ranges`;
    }

    this.selection.removeAllRanges();
    for (const range of ranges) {
      if (options.selection == "addRange") {
        this.selection.addRange(range);
      } else if (options.selection == "setBaseAndExtent") {
        this.selection.setBaseAndExtent(
          range.startContainer,
          range.startOffset,
          range.endContainer,
          range.endOffset
        );
      } else if (options.selection == "setBaseAndExtent-reverse") {
        this.selection.setBaseAndExtent(
          range.endContainer,
          range.endOffset,
          range.startContainer,
          range.startOffset
        );
      } else {
        throw `Failed due to invalid selection option, ${options.selection}`;
      }
    }

    if (this.selection.rangeCount != ranges.length) {
      throw `Failed to set selection to the given ranges whose length is ${ranges.length}, but only ${this.selection.rangeCount} ranges are added`;
    }
  }

  // Originated from normalizeSerializedStyle in include/tests.js
  normalizeStyleAttributeValues() {
    for (const element of Array.from(
      this.editingHost.querySelectorAll("[style]")
    )) {
      element.setAttribute(
        "style",
        element
          .getAttribute("style")
          // Random spacing differences
          .replace(/; ?$/, "")
          .replace(/: /g, ":")
          // Gecko likes "transparent"
          .replace(/transparent/g, "rgba(0, 0, 0, 0)")
          // WebKit likes to look overly precise
          .replace(/, 0.496094\)/g, ", 0.5)")
          // Gecko converts anything with full alpha to "transparent" which
          // then becomes "rgba(0, 0, 0, 0)", so we have to make other
          // browsers match
          .replace(/rgba\([0-9]+, [0-9]+, [0-9]+, 0\)/g, "rgba(0, 0, 0, 0)")
      );
    }
  }
}