emulation.setScreenOrientationOverride (#925)

WPT tests: web-platform-tests/wpt#53327

Author: sadym-chromium

index.bs

@@ -190,6 +190,13 @@ spec: GEOLOCATION; urlPrefix: https://www.w3.org/TR/geolocation/
     text: GeolocationPositionError; url: #dom-geolocationpositionerror
     text: POSITION_UNAVAILABLE; url: #dom-geolocationpositionerror-position_unavailable
     text: set emulated position data; url: #dfn-set-emulated-position-data
+spec: SCREEN-ORIENTATION; urlPrefix: https://www.w3.org/TR/screen-orientation
+  type: dfn
+    text: current orientation angle; url: #dfn-current-orientation-angle
+    text: current orientation type; url: #dfn-current-orientation-type
+    text: screen orientation; url: #dom-screenorientation
+    text: screen orientation change steps; url: #dfn-screen-orientation-change-steps
+    text: screen orientation values lists; url: #dfn-screen-orientation-values-lists
 spec: HTML; urlPrefix: https://html.spec.whatwg.org/multipage/
   type: dfn
     text: 2D context creation algorithm; url: canvas.html#2d-context-creation-algorithm
@@ -4858,6 +4865,10 @@ TODO: Move it as a hook in the html spec instead.
    1. If [=geolocation overrides map=] [=map/contains=] |user context|,
       [=set emulated position data=] with |navigable| and [=geolocation overrides map=][|user context|].
 
+   1. If [=screen orientation overrides map=] [=map/contains=] |user context|,
+      [=set emulated screen orientation=] with |navigable| and
+      [=screen orientation overrides map=][|user context|].
+
 1. If [=viewport overrides map=] [=map/contains=] |user context|:
 
    1. If |navigable| is a [=/top-level traversable=] and the <code>viewport</code> field of
@@ -5756,7 +5767,8 @@ relating to emulation of browser APIs.
 
 <pre class="cddl" data-cddl-module="remote-cddl">
 EmulationCommand = (
-  emulation.SetGeolocationOverride
+  emulation.SetGeolocationOverride //
+  emulation.SetScreenOrientationOverride
 )
 </pre>
 
@@ -5771,6 +5783,13 @@ A <dfn>geolocation override</dfn> is a [=struct=] with:
 
 A [=remote end=] has a <dfn>geolocation overrides map</dfn> which is a weak map between [=user contexts=] and [=geolocation override=].
 
+A <dfn>screen orientation override</dfn> is a [=struct=] with:
+
+* [=struct/item=] named <dfn attribute for="screen orientation override">natural</dfn> which is a string;
+* [=struct/item=] named <dfn attribute for="screen orientation override">type</dfn> which is a string;
+
+A [=remote end=] has a <dfn>screen orientation overrides map</dfn> which is a weak
+map between [=user contexts=] and [=screen orientation override=].
 
 ### Commands ### {#module-emulation-commands}
 
@@ -5879,6 +5898,130 @@ The [=remote end steps=] with |command parameters| are:
 
 </div>
 
+#### The emulation.setScreenOrientationOverride Command ####  {#command-emulation-setScreenOrientationOverride}
+
+The <dfn export for=commands>emulation.setScreenOrientationOverride</dfn> command
+emulates [=screen orientation=] of the given top-level traversables or user contexts.
+
+<dl>
+   <dt>Command Type</dt>
+   <dd>
+    <pre class="cddl" data-cddl-module="remote-cddl">
+      emulation.SetScreenOrientationOverride = (
+        method: "emulation.setScreenOrientationOverride",
+        params: emulation.SetScreenOrientationOverrideParameters
+      )
+
+      emulation.ScreenOrientationNatural = "portrait" / "landscape"
+      emulation.ScreenOrientationType = "portrait-primary" / "portrait-secondary" / "landscape-primary" / "landscape-secondary"
+
+      emulation.ScreenOrientation = {
+        natural: emulation.ScreenOrientationNatural,
+        type: emulation.ScreenOrientationType
+      }
+
+      emulation.SetScreenOrientationOverrideParameters = {
+        screenOrientation: emulation.ScreenOrientation / null,
+        ? contexts: [+browsingContext.BrowsingContext],
+        ? userContexts: [+browser.UserContext],
+      }
+    </pre>
+   </dd>
+   <dt>Result Type</dt>
+   <dd>
+    <code>
+     EmptyResult
+    </code>
+   </dd>
+</dl>
+
+<div algorithm>
+
+To <dfn>set emulated screen orientation</dfn> given |navigable| and
+|emulated screen orientation|:
+
+Issue: Move this algorithm to screen orientation specification.
+
+1. If |emulated screen orientation| is null:
+
+   1. Set |navigable|'s [=current orientation angle=] to
+      implementation-defined default.
+
+   1. Set |navigable|'s [=current orientation type=] to
+      implementation-defined default.
+
+1. Otherwise:
+
+   1. Let |emulated orientation type| be
+      |emulated screen orientation|["<code>type</code>"].
+
+   1. Let |emulated orientation angle| be the angle associated with
+      |emulated orientation type| for screens with
+      |emulated screen orientation|["<code>natural</code>"] orientations as defined
+      in [=screen orientation values lists=].
+
+   1. Set [=current orientation angle=] to |emulated orientation angle|.
+
+   1. Set [=current orientation type=] to |emulated orientation type|.
+
+1. Run the [=screen orientation change steps=] with the |navigable|'s
+   [=active document=].
+
+</div>
+
+<div algorithm="remote end steps for emulation.setScreenOrientationOverride">
+
+The [=remote end steps=] with |command parameters| are:
+
+1. If the implementation is unable to adjust the [=screen orientations=]
+   parameters with the given |command parameters| for any reason, return
+   [=error=] with [=error code=] [=unsupported operation=].
+
+1. If |command parameters| [=map/contains=] "<code>userContexts</code>"
+   and |command parameters| [=map/contains=] "<code>contexts</code>",
+   return [=error=] with [=error code=] [=invalid argument=].
+
+1. If |command parameters| doesn't [=map/contain=] "<code>userContexts</code>"
+   and |command parameters| doesn't [=map/contain=] "<code>contexts</code>",
+   return [=error=] with [=error code=] [=invalid argument=].
+
+1. Let |emulated screen orientation| be
+   |command parameters|["<code>screenOrientation</code>"].
+
+1. Let |navigables| be a [=/set=].
+
+1. If the <code>contexts</code> field of |command parameters| is present:
+
+   1. Let |navigables| be the result of [=trying=] to
+      [=get valid top-level traversables by ids=] with
+      |command parameters|["<code>contexts</code>"].
+
+1. Otherwise, if the <code>userContexts</code> field of |command parameters| is
+   present:
+
+   1. Let |user contexts| be the result of [=trying=] to [=get valid user contexts=]
+      with |command parameters|["<code>userContexts</code>"].
+
+   1. For each |user context| of |user contexts|:
+
+      1. [=map/Set=] [=screen orientation overrides map=][|user context|] to
+         |emulated screen orientation|.
+
+      1. [=list/For each=] |top-level traversable| of the list of all
+         [=/top-level traversables=] whose [=associated user context=] is
+         |user context|:
+
+         1. [=list/Append=] |top-level traversable| to |navigables|.
+
+1. For each |navigable| of |navigables|:
+
+   1. [=Set emulated screen orientation=] with |navigable| and
+      |emulated screen orientation|.
+
+1. Return [=success=] with data null.
+
+</div>
+
 ## The network Module ## {#module-network}
 
 The <dfn export for=modules>network</dfn> module contains commands and events