Adding upstream version 115.7.0esr.upstream/115.7.0esrupstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 335 insertions, 0 deletions

diff --git a/layout/base/tests/marionette/selection.py b/layout/base/tests/marionette/selection.py
new file mode 100644
index 0000000000..6cfe155927
--- /dev/null
+++ b/layout/base/tests/marionette/selection.py
@@ -0,0 +1,335 @@
+# -*- coding: utf-8 -*-
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+from marionette_driver.marionette import Actions, errors
+
+
+class CaretActions(Actions):
+    def __init__(self, marionette):
+        super(CaretActions, self).__init__(marionette)
+        self._reset_action_chain()
+
+    def _reset_action_chain(self):
+        self.mouse_chain = self.sequence(
+            "pointer", "pointer_id", {"pointerType": "mouse"}
+        )
+        self.key_chain = self.sequence("key", "keyboard_id")
+
+    def flick(self, element, x1, y1, x2, y2, duration=200):
+        """Perform a flick gesture on the target element.
+
+        :param element: The element to perform the flick gesture on.
+        :param x1: Starting x-coordinate of flick, relative to the top left
+                   corner of the element.
+        :param y1: Starting y-coordinate of flick, relative to the top left
+                   corner of the element.
+        :param x2: Ending x-coordinate of flick, relative to the top left
+                   corner of the element.
+        :param y2: Ending y-coordinate of flick, relative to the top left
+                   corner of the element.
+
+        """
+        rect = element.rect
+        el_x, el_y = rect["x"], rect["y"]
+
+        # Add element's (x, y) to make the coordinate relative to the viewport.
+        from_x, from_y = int(el_x + x1), int(el_y + y1)
+        to_x, to_y = int(el_x + x2), int(el_y + y2)
+
+        self.mouse_chain.pointer_move(from_x, from_y).pointer_down().pointer_move(
+            to_x, to_y, duration=duration
+        ).pointer_up()
+        return self
+
+    def send_keys(self, keys):
+        """Perform a keyDown and keyUp action for each character in `keys`.
+
+        :param keys: String of keys to perform key actions with.
+
+        """
+        self.key_chain.send_keys(keys)
+        return self
+
+    def perform(self):
+        """Perform the action chain built so far to the server side for execution
+        and clears the current chain of actions.
+
+        Warning: This method performs all the mouse actions before all the key
+        actions!
+
+        """
+        self.mouse_chain.perform()
+        self.key_chain.perform()
+        self._reset_action_chain()
+
+
+class SelectionManager(object):
+    """Interface for manipulating the selection and carets of the element.
+
+    We call the blinking cursor (nsCaret) as cursor, and call AccessibleCaret as
+    caret for short.
+
+    Simple usage example:
+
+    ::
+
+        element = marionette.find_element(By.ID, 'input')
+        sel = SelectionManager(element)
+        sel.move_caret_to_front()
+
+    """
+
+    def __init__(self, element):
+        self.element = element
+
+    def _input_or_textarea(self):
+        """Return True if element is either <input> or <textarea>."""
+        return self.element.tag_name in ("input", "textarea")
+
+    def js_selection_cmd(self):
+        """Return a command snippet to get selection object.
+
+        If the element is <input> or <textarea>, return the selection object
+        associated with it. Otherwise, return the current selection object.
+
+        Note: "element" must be provided as the first argument to
+        execute_script().
+
+        """
+        if self._input_or_textarea():
+            # We must unwrap sel so that DOMRect could be returned to Python
+            # side.
+            return """var sel = arguments[0].editor.selection;"""
+        else:
+            return """var sel = window.getSelection();"""
+
+    def move_cursor_by_offset(self, offset, backward=False):
+        """Move cursor in the element by character offset.
+
+        :param offset: Move the cursor to the direction by offset characters.
+        :param backward: Optional, True to move backward; Default to False to
+         move forward.
+
+        """
+        cmd = (
+            self.js_selection_cmd()
+            + """
+              for (let i = 0; i < {0}; ++i) {{
+                  sel.modify("move", "{1}", "character");
+              }}
+              """.format(
+                offset, "backward" if backward else "forward"
+            )
+        )
+
+        self.element.marionette.execute_script(
+            cmd, script_args=(self.element,), sandbox="system"
+        )
+
+    def move_cursor_to_front(self):
+        """Move cursor in the element to the front of the content."""
+        if self._input_or_textarea():
+            cmd = """arguments[0].setSelectionRange(0, 0);"""
+        else:
+            cmd = """var sel = window.getSelection();
+                  sel.collapse(arguments[0].firstChild, 0);"""
+
+        self.element.marionette.execute_script(
+            cmd, script_args=(self.element,), sandbox=None
+        )
+
+    def move_cursor_to_end(self):
+        """Move cursor in the element to the end of the content."""
+        if self._input_or_textarea():
+            cmd = """var len = arguments[0].value.length;
+                  arguments[0].setSelectionRange(len, len);"""
+        else:
+            cmd = """var sel = window.getSelection();
+                  sel.collapse(arguments[0].lastChild, arguments[0].lastChild.length);"""
+
+        self.element.marionette.execute_script(
+            cmd, script_args=(self.element,), sandbox=None
+        )
+
+    def selection_rect_list(self, idx):
+        """Return the selection's DOMRectList object for the range at given idx.
+
+        If the element is either <input> or <textarea>, return the DOMRectList of
+        the range at given idx of the selection within the element. Otherwise,
+        return the DOMRectList of the of the range at given idx of current selection.
+
+        """
+        cmd = (
+            self.js_selection_cmd()
+            + """return sel.getRangeAt({}).getClientRects();""".format(idx)
+        )
+        return self.element.marionette.execute_script(
+            cmd, script_args=(self.element,), sandbox="system"
+        )
+
+    def range_count(self):
+        """Get selection's range count"""
+        cmd = self.js_selection_cmd() + """return sel.rangeCount;"""
+        return self.element.marionette.execute_script(
+            cmd, script_args=(self.element,), sandbox="system"
+        )
+
+    def _selection_location_helper(self, location_type):
+        """Return the start and end location of the selection in the element.
+
+        Return a tuple containing two pairs of (x, y) coordinates of the start
+        and end locations in the element. The coordinates are relative to the
+        top left-hand corner of the element. Both ltr and rtl directions are
+        considered.
+
+        """
+        range_count = self.range_count()
+        if range_count <= 0:
+            raise errors.MarionetteException(
+                "Expect at least one range object in Selection, but found nothing!"
+            )
+
+        # FIXME (Bug 1682382): We shouldn't need the retry for-loops if
+        # selection_rect_list() can reliably return a valid list.
+        retry_times = 3
+        for _ in range(retry_times):
+            try:
+                first_rect_list = self.selection_rect_list(0)
+                first_rect = first_rect_list["0"]
+                break
+            except KeyError:
+                continue
+        else:
+            raise errors.MarionetteException(
+                "Expect at least one rect in the first range, but found nothing!"
+            )
+
+        for _ in range(retry_times):
+            try:
+                # Making a selection over some non-selectable elements can
+                # create multiple ranges.
+                last_rect_list = (
+                    first_rect_list
+                    if range_count == 1
+                    else self.selection_rect_list(range_count - 1)
+                )
+                last_list_length = last_rect_list["length"]
+                last_rect = last_rect_list[str(last_list_length - 1)]
+                break
+            except KeyError:
+                continue
+        else:
+            raise errors.MarionetteException(
+                "Expect at least one rect in the last range, but found nothing!"
+            )
+
+        origin_x, origin_y = self.element.rect["x"], self.element.rect["y"]
+
+        if self.element.get_property("dir") == "rtl":  # such as Arabic
+            start_pos, end_pos = "right", "left"
+        else:
+            start_pos, end_pos = "left", "right"
+
+        # Calculate y offset according to different needs.
+        if location_type == "center":
+            start_y_offset = first_rect["height"] / 2.0
+            end_y_offset = last_rect["height"] / 2.0
+        elif location_type == "caret":
+            # Selection carets' tip are below the bottom of the two ends of the
+            # selection. Add 5px to y should be sufficient to locate them.
+            caret_tip_y_offset = 5
+            start_y_offset = first_rect["height"] + caret_tip_y_offset
+            end_y_offset = last_rect["height"] + caret_tip_y_offset
+        else:
+            start_y_offset = end_y_offset = 0
+
+        caret1_x = first_rect[start_pos] - origin_x
+        caret1_y = first_rect["top"] + start_y_offset - origin_y
+        caret2_x = last_rect[end_pos] - origin_x
+        caret2_y = last_rect["top"] + end_y_offset - origin_y
+
+        return ((caret1_x, caret1_y), (caret2_x, caret2_y))
+
+    def selection_location(self):
+        """Return the start and end location of the selection in the element.
+
+        Return a tuple containing two pairs of (x, y) coordinates of the start
+        and end of the selection. The coordinates are relative to the top
+        left-hand corner of the element. Both ltr and rtl direction are
+        considered.
+
+        """
+        return self._selection_location_helper("center")
+
+    def carets_location(self):
+        """Return a pair of the two carets' location.
+
+        Return a tuple containing two pairs of (x, y) coordinates of the two
+        carets' tip. The coordinates are relative to the top left-hand corner of
+        the element. Both ltr and rtl direction are considered.
+
+        """
+        return self._selection_location_helper("caret")
+
+    def cursor_location(self):
+        """Return the blanking cursor's center location within the element.
+
+        Return (x, y) coordinates of the cursor's center relative to the top
+        left-hand corner of the element.
+
+        """
+        return self._selection_location_helper("center")[0]
+
+    def first_caret_location(self):
+        """Return the first caret's location.
+
+        Return (x, y) coordinates of the first caret's tip relative to the top
+        left-hand corner of the element.
+
+        """
+        return self.carets_location()[0]
+
+    def second_caret_location(self):
+        """Return the second caret's location.
+
+        Return (x, y) coordinates of the second caret's tip relative to the top
+        left-hand corner of the element.
+
+        """
+        return self.carets_location()[1]
+
+    def select_all(self):
+        """Select all the content in the element."""
+        if self._input_or_textarea():
+            cmd = """var len = arguments[0].value.length;
+                  arguments[0].focus();
+                  arguments[0].setSelectionRange(0, len);"""
+        else:
+            cmd = """var range = document.createRange();
+                  range.setStart(arguments[0].firstChild, 0);
+                  range.setEnd(arguments[0].lastChild, arguments[0].lastChild.length);
+                  var sel = window.getSelection();
+                  sel.removeAllRanges();
+                  sel.addRange(range);"""
+
+        self.element.marionette.execute_script(
+            cmd, script_args=(self.element,), sandbox=None
+        )
+
+    @property
+    def content(self):
+        """Return all the content of the element."""
+        if self._input_or_textarea():
+            return self.element.get_property("value")
+        else:
+            return self.element.text
+
+    @property
+    def selected_content(self):
+        """Return the selected portion of the content in the element."""
+        cmd = self.js_selection_cmd() + """return sel.toString();"""
+        return self.element.marionette.execute_script(
+            cmd, script_args=(self.element,), sandbox="system"
+        )