[DevTools] Consolidate overlay-related functionality in Overlay domain

third_party/WebKit/Source/core/inspector/browser_protocol.json

 {
     "version": { "major": "1", "minor": "2" },
     "domains": [{
         "domain": "Inspector",
         "experimental": true,
         "types": [],
         "commands": [
             {
                 "name": "enable",
                 "description": "Enables inspector domain notifications."
@@ skipping 451 matching lines @@
             },
             {
                 "name": "handleJavaScriptDialog",
                 "description": "Accepts or dismisses a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload).",
                 "parameters": [
                     { "name": "accept", "type": "boolean", "description": "Whether to accept or dismiss the dialog." },
                     { "name": "promptText", "type": "string", "optional": true, "description": "The text to enter into the dialog prompt before accepting. Used only if this is a prompt dialog." }
                 ]
             },
             {
-                "name": "configureOverlay",
-                "parameters": [
-                    { "name": "suspended", "type": "boolean", "optional": true, "description": "Whether overlay should be suspended and not consume any resources." },
-                    { "name": "message", "type": "string", "optional": true, "description": "Overlay message to display." }
-                ],
-                "experimental": true,
-                "description": "Configures overlay."
-            },
-            {
                 "name": "getAppManifest",
                 "experimental": true,
                 "returns": [
                     { "name": "url", "type": "string", "description": "Manifest location." },
                     { "name": "errors", "type": "array", "items": { "$ref": "AppManifestError" } },
                     { "name": "data", "type": "string", "optional": true, "description": "Manifest content." }
                 ]
             },
             {
                 "name": "requestAppBanner",
@@ skipping 147 matching lines @@
                 "parameters": [
                     { "name": "isInMainFrame", "type": "boolean", "description": "Whether the navigation is taking place in the main frame or in a subframe." },
                     { "name": "isRedirect", "type": "boolean", "description": "Whether the navigation has encountered a server redirect or not." },
                     { "name": "navigationId", "type": "integer" },
                     { "name": "url", "type": "string", "description": "URL of requested navigation." }
                 ]
             }
         ]
     },
     {
-        "domain": "Rendering",
-        "description": "This domain allows to control rendering of the page.",
+        "domain": "Overlay",
+        "description": "This domain provides various functionality related to drawing atop the inspected page.",
+        "dependencies": ["DOM", "Page", "Runtime"],
         "experimental": true,
+        "types": [
+            {
+                "id": "HighlightConfig",
+                "type": "object",
+                "properties": [
+                    { "name": "showInfo", "type": "boolean", "optional": true, "description": "Whether the node info tooltip should be shown (default: false)." },
+                    { "name": "showRulers", "type": "boolean", "optional": true, "description": "Whether the rulers should be shown (default: false)." },
+                    { "name": "showExtensionLines", "type": "boolean", "optional": true, "description": "Whether the extension lines from node to the rulers should be shown (default: false)." },
+                    { "name": "displayAsMaterial", "type": "boolean", "optional": true},
+                    { "name": "contentColor", "$ref": "DOM.RGBA", "optional": true, "description": "The content box highlight fill color (default: transparent)." },
+                    { "name": "paddingColor", "$ref": "DOM.RGBA", "optional": true, "description": "The padding highlight fill color (default: transparent)." },
+                    { "name": "borderColor", "$ref": "DOM.RGBA", "optional": true, "description": "The border highlight fill color (default: transparent)." },
+                    { "name": "marginColor", "$ref": "DOM.RGBA", "optional": true, "description": "The margin highlight fill color (default: transparent)." },
+                    { "name": "eventTargetColor", "$ref": "DOM.RGBA", "optional": true, "description": "The event target element highlight fill color (default: transparent)." },
+                    { "name": "shapeColor", "$ref": "DOM.RGBA", "optional": true, "description": "The shape outside fill color (default: transparent)." },
+                    { "name": "shapeMarginColor", "$ref": "DOM.RGBA", "optional": true, "description": "The shape margin fill color (default: transparent)." },
+                    { "name": "selectorList", "type": "string", "optional": true, "description": "Selectors to highlight relevant nodes."}
+                ],
+                "description": "Configuration data for the highlighting of page elements."
+            },
+            {
+                "id": "InspectMode",
+                "type": "string",
+                "enum": [
+                    "searchForNode",
+                    "searchForUAShadowDOM",
+                    "none"
+                ]
+            }
+        ],
         "commands": [
             {
+                "name": "enable",
+                "description": "Enables domain notifications."
+            },
+            {
+                "name": "disable",
+                "description": "Disables domain notifications."
+            },
+            {
                 "name": "setShowPaintRects",
                 "description": "Requests that backend shows paint rectangles",
                 "parameters": [
                     { "name": "result", "type": "boolean", "description": "True for showing paint rectangles" }
                 ]
             },
             {
                 "name": "setShowDebugBorders",
                 "description": "Requests that backend shows debug borders on layers",
                 "parameters": [
@@ skipping 13 matching lines @@
                 "parameters": [
                     { "name": "show", "type": "boolean", "description": "True for showing scroll bottleneck rects" }
                 ]
             },
             {
                 "name": "setShowViewportSizeOnResize",
                 "description": "Paints viewport size upon main frame resize.",
                 "parameters": [
                     { "name": "show", "type": "boolean", "description": "Whether to paint size or not." }
                 ]
+            },
+            {
+                "name": "setPausedInDebuggerMessage",
+                "parameters": [
+                    { "name": "message", "type": "string", "optional": true, "description": "The message to display, also triggers resume and step over controls." }
+                ]
+            },
+            {
+                "name": "setSuspended",
+                "parameters": [
+                    { "name": "suspended", "type": "boolean", "description": "Whether overlay should be suspended and not consume any resources until resumed." }
+                ]
+            },
+            {
+                "name": "setInspectMode",
+                "description": "Enters the 'inspect' mode. In this mode, elements that user is hovering over are highlighted. Backend then generates 'inspectNodeRequested' event upon element selection.",
+                "parameters": [
+                    { "name": "mode", "$ref": "InspectMode", "description": "Set an inspection mode." },
+                    { "name": "highlightConfig", "$ref": "HighlightConfig", "optional": true, "description": "A descriptor for the highlight appearance of hovered-over nodes. May be omitted if <code>enabled == false</code>." }
+                ]
+            },
+            {
+                "name": "highlightRect",
+                "description": "Highlights given rectangle. Coordinates are absolute with respect to the main frame viewport.",
+                "parameters": [
+                    { "name": "x", "type": "integer", "description": "X coordinate" },
+                    { "name": "y", "type": "integer", "description": "Y coordinate" },
+                    { "name": "width", "type": "integer", "description": "Rectangle width" },
+                    { "name": "height", "type": "integer", "description": "Rectangle height" },
+                    { "name": "color", "$ref": "DOM.RGBA", "optional": true, "description": "The highlight fill color (default: transparent)." },
+                    { "name": "outlineColor", "$ref": "DOM.RGBA", "optional": true, "description": "The highlight outline color (default: transparent)." }
+                ]
+            },
+            {
+                "name": "highlightQuad",
+                "description": "Highlights given quad. Coordinates are absolute with respect to the main frame viewport.",
+                "parameters": [
+                    { "name": "quad", "$ref": "DOM.Quad", "description": "Quad to highlight" },
+                    { "name": "color", "$ref": "DOM.RGBA", "optional": true, "description": "The highlight fill color (default: transparent)." },
+                    { "name": "outlineColor", "$ref": "DOM.RGBA", "optional": true, "description": "The highlight outline color (default: transparent)." }
+                ]
+            },
+            {
+                "name": "highlightNode",
+                "description": "Highlights DOM node with given id or with the given JavaScript object wrapper. Either nodeId or objectId must be specified.",
+                "parameters": [
+                    { "name": "highlightConfig", "$ref": "HighlightConfig",  "description": "A descriptor for the highlight appearance." },
+                    { "name": "nodeId", "$ref": "DOM.NodeId", "optional": true, "description": "Identifier of the node to highlight." },
+                    { "name": "backendNodeId", "$ref": "DOM.BackendNodeId", "optional": true, "description": "Identifier of the backend node to highlight." },
+                    { "name": "objectId", "$ref": "Runtime.RemoteObjectId", "optional": true, "description": "JavaScript object id of the node to be highlighted." }
+                ]
+            },
+            {
+                "name": "highlightFrame",
+                "description": "Highlights owner element of the frame with given id.",
+                "parameters": [
+                    { "name": "frameId", "$ref": "Page.FrameId", "description": "Identifier of the frame to highlight." },
+                    { "name": "contentColor", "$ref": "DOM.RGBA", "optional": true, "description": "The content box highlight fill color (default: transparent)." },
+                    { "name": "contentOutlineColor", "$ref": "DOM.RGBA", "optional": true, "description": "The content box highlight outline color (default: transparent)." }
+                ]
+            },
+            {
+                "name": "hideHighlight",
+                "description": "Hides any highlight."
+            },
+            {
+                "name": "getHighlightObjectForTest",
+                "description": "For testing.",
+                "parameters": [
+                    { "name": "nodeId", "$ref": "DOM.NodeId", "description": "Id of the node to get highlight object for." }
+                ],
+                "returns": [
+                    { "name": "highlight", "type": "object", "description": "Highlight data for the node." }
+                ]
+            }
+        ],
+        "events": [
+            {
+                "name": "nodeHighlightRequested",
+                "description": "Fired when the node should be highlighted. This happens after call to <code>setInspectMode</code>.",
+                "parameters": [
+                    { "name": "nodeId", "$ref": "DOM.NodeId" }
+                ]
+            },
+            {
+                "name": "inspectNodeRequested",
+                "description": "Fired when the node should be inspected. This happens after call to <code>setInspectMode</code> or when user manually inspects an element.",
+                "parameters": [
+                    { "name": "backendNodeId", "$ref": "DOM.BackendNodeId", "description": "Id of the node to inspect." }
+                ]
             }
         ]
     },
     {
         "domain": "Emulation",
         "description": "This domain emulates different environments for the page.",
         "dependencies": ["DOM"],
         "types": [
             {
                 "id": "ScreenOrientation",
@@ skipping 1435 matching lines @@
                 "id": "Rect",
                 "type": "object",
                 "experimental": true,
                 "properties": [
                     { "name": "x", "type": "number", "description": "X coordinate" },
                     { "name": "y", "type": "number", "description": "Y coordinate" },
                     { "name": "width", "type": "number", "description": "Rectangle width" },
                     { "name": "height", "type": "number", "description": "Rectangle height" }
                 ],
                 "description": "Rectangle."
-            },
-            {
-                "id": "HighlightConfig",
-                "type": "object",
-                "properties": [
-                    { "name": "showInfo", "type": "boolean", "optional": true, "description": "Whether the node info tooltip should be shown (default: false)." },
-                    { "name": "showRulers", "type": "boolean", "optional": true, "description": "Whether the rulers should be shown (default: false)." },
-                    { "name": "showExtensionLines", "type": "boolean", "optional": true, "description": "Whether the extension lines from node to the rulers should be shown (default: false)." },
-                    { "name": "displayAsMaterial", "type": "boolean", "optional": true, "experimental": true},
-                    { "name": "contentColor", "$ref": "RGBA", "optional": true, "description": "The content box highlight fill color (default: transparent)." },
-                    { "name": "paddingColor", "$ref": "RGBA", "optional": true, "description": "The padding highlight fill color (default: transparent)." },
-                    { "name": "borderColor", "$ref": "RGBA", "optional": true, "description": "The border highlight fill color (default: transparent)." },
-                    { "name": "marginColor", "$ref": "RGBA", "optional": true, "description": "The margin highlight fill color (default: transparent)." },
-                    { "name": "eventTargetColor", "$ref": "RGBA", "optional": true, "experimental": true, "description": "The event target element highlight fill color (default: transparent)." },
-                    { "name": "shapeColor", "$ref": "RGBA", "optional": true, "experimental": true, "description": "The shape outside fill color (default: transparent)." },
-                    { "name": "shapeMarginColor", "$ref": "RGBA", "optional": true, "experimental": true, "description": "The shape margin fill color (default: transparent)." },
-                    { "name": "selectorList", "type": "string", "optional": true, "description": "Selectors to highlight relevant nodes."}
-                ],
-                "description": "Configuration data for the highlighting of page elements."
-            },
-            {
-                "id": "InspectMode",
-                "type": "string",
-                "experimental": true,
-                "enum": [
-                    "searchForNode",
-                    "searchForUAShadowDOM",
-                    "none"
-                ]
             }
         ],
         "commands": [
             {
                 "name": "enable",
                 "description": "Enables DOM agent for the given page."
             },
             {
                 "name": "disable",
                 "description": "Disables DOM agent for the given page."
@@ skipping 170 matching lines @@
                 "name": "requestNode",
                 "parameters": [
                     { "name": "objectId", "$ref": "Runtime.RemoteObjectId", "description": "JavaScript object id to convert into node." }
                 ],
                 "returns": [
                     { "name": "nodeId", "$ref": "NodeId", "description": "Node id for given object." }
                 ],
                 "description": "Requests that the node is sent to the caller given the JavaScript node object reference. All nodes that form the path from the node to the root are also sent to the client as a series of <code>setChildNodes</code> notifications."
             },
             {
-                "name": "setInspectMode",
-                "experimental": true,
-                "parameters": [
-                    { "name": "mode", "$ref": "InspectMode", "description": "Set an inspection mode." },
-                    { "name": "highlightConfig", "$ref": "HighlightConfig", "optional": true, "description": "A descriptor for the highlight appearance of hovered-over nodes. May be omitted if <code>enabled == false</code>." }
-                ],
-                "description": "Enters the 'inspect' mode. In this mode, elements that user is hovering over are highlighted. Backend then generates 'inspectNodeRequested' event upon element selection."
-            },
-            {
                 "name": "highlightRect",
-                "parameters": [
-                    { "name": "x", "type": "integer", "description": "X coordinate" },
-                    { "name": "y", "type": "integer", "description": "Y coordinate" },
-                    { "name": "width", "type": "integer", "description": "Rectangle width" },
-                    { "name": "height", "type": "integer", "description": "Rectangle height" },
-                    { "name": "color", "$ref": "RGBA", "optional": true, "description": "The highlight fill color (default: transparent)." },
-                    { "name": "outlineColor", "$ref": "RGBA", "optional": true, "description": "The highlight outline color (default: transparent)." }
-                ],
-                "description": "Highlights given rectangle. Coordinates are absolute with respect to the main frame viewport."
-            },
-            {
-                "name": "highlightQuad",
-                "parameters": [
-                    { "name": "quad", "$ref": "Quad", "description": "Quad to highlight" },
-                    { "name": "color", "$ref": "RGBA", "optional": true, "description": "The highlight fill color (default: transparent)." },
-                    { "name": "outlineColor", "$ref": "RGBA", "optional": true, "description": "The highlight outline color (default: transparent)." }
-                ],
-                "description": "Highlights given quad. Coordinates are absolute with respect to the main frame viewport.",
-                "experimental": true
+                "description": "Highlights given rectangle.",
+                "redirect": "Overlay"
             },
             {
                 "name": "highlightNode",
-                "parameters": [
-                    { "name": "highlightConfig", "$ref": "HighlightConfig",  "description": "A descriptor for the highlight appearance." },
-                    { "name": "nodeId", "$ref": "NodeId", "optional": true, "description": "Identifier of the node to highlight." },
-                    { "name": "backendNodeId", "$ref": "BackendNodeId", "optional": true, "description": "Identifier of the backend node to highlight." },
-                    { "name": "objectId", "$ref": "Runtime.RemoteObjectId", "optional": true, "description": "JavaScript object id of the node to be highlighted.", "experimental": true }
-                ],
-                "description": "Highlights DOM node with given id or with the given JavaScript object wrapper. Either nodeId or objectId must be specified."
+                "description": "Highlights DOM node.",
+                "redirect": "Overlay"
             },
             {
                 "name": "hideHighlight",
-                "description": "Hides DOM node highlight."
-            },
-            {
-                "name": "highlightFrame",
-                "parameters": [
-                    { "name": "frameId", "$ref": "Page.FrameId", "description": "Identifier of the frame to highlight." },
-                    { "name": "contentColor", "$ref": "RGBA", "optional": true, "description": "The content box highlight fill color (default: transparent)." },
-                    { "name": "contentOutlineColor", "$ref": "RGBA", "optional": true, "description": "The content box highlight outline color (default: transparent)." }
-                ],
-                "description": "Highlights owner element of the frame with given id.",
-                "experimental": true
+                "description": "Hides any highlight.",
+                "redirect": "Overlay"
             },
             {
                 "name": "pushNodeByPathToFrontend",
                 "parameters": [
                     { "name": "path", "type": "string", "description": "Path to node in the proprietary format." }
                 ],
                 "returns": [
                     { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node for given path." }
                 ],
                 "description": "Requests that the node is sent to the caller given its path. // FIXME, use XPath",
@@ skipping 123 matching lines @@
             {
                 "name": "getRelayoutBoundary",
                 "parameters": [
                     { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node." }
                 ],
                 "returns": [
                     { "name": "nodeId", "$ref": "NodeId", "description": "Relayout boundary node id for the given node." }
                 ],
                 "description": "Returns the id of the nearest ancestor that is a relayout boundary.",
                 "experimental": true
-            },
-            {
-                "name": "getHighlightObjectForTest",
-                "parameters": [
-                    { "name": "nodeId", "$ref": "NodeId", "description": "Id of the node to get highlight object for." }
-                ],
-                "returns": [
-                    { "name": "highlight", "type": "object", "description": "Highlight data for the node." }
-                ],
-                "description": "For testing.",
-                "experimental": true
             }
         ],
         "events": [
             {
                 "name": "documentUpdated",
                 "description": "Fired when <code>Document</code> has been totally updated. Node ids are no longer valid."
             },
             {
-                "name": "inspectNodeRequested",
-                "parameters": [
-                    { "name": "backendNodeId", "$ref": "BackendNodeId", "description": "Id of the node to inspect." }
-                ],
-                "description": "Fired when the node should be inspected. This happens after call to <code>setInspectMode</code>.",
-                "experimental" : true
-            },
-            {
                 "name": "setChildNodes",
                 "parameters": [
                     { "name": "parentId", "$ref": "NodeId", "description": "Parent node id to populate with children." },
                     { "name": "nodes", "type": "array", "items": { "$ref": "Node" }, "description": "Child nodes array." }
                 ],
                 "description": "Fired when backend wants to provide client with the missing DOM structure. This happens upon most of the calls requesting node ids."
             },
             {
                 "name": "attributeModified",
                 "parameters": [
@@ skipping 89 matching lines @@
                 "experimental": true
             },
             {
                 "name": "distributedNodesUpdated",
                 "parameters": [
                     { "name": "insertionPointId", "$ref": "NodeId", "description": "Insertion point where distrubuted nodes were updated." },
                     { "name": "distributedNodes", "type": "array", "items": { "$ref": "BackendNode" }, "description": "Distributed nodes for given insertion point." }
                 ],
                 "description": "Called when distrubution is changed.",
                 "experimental": true
-            },
-            {
-                "name": "nodeHighlightRequested",
-                "parameters": [
-                    {"name": "nodeId", "$ref": "NodeId"}
-                ],
-                "experimental": true
             }
         ]
     },
     {
         "domain": "CSS",
         "experimental": true,
         "description": "This domain exposes CSS read/write operations. All CSS objects (stylesheets, rules, and styles) have an associated <code>id</code> used in subsequent operations on the related object. Each object type has a specific <code>id</code> structure, and those are not interchangeable between objects of different kinds. CSS objects can be loaded using the <code>get*ForNode()</code> calls (which accept a DOM node id). A client can also discover all the existing stylesheets with the <code>getAllStyleSheets()</code> method (or keeping track of the <code>styleSheetAdded</code>/<code>styleSheetRemoved</code> events) and subsequently load the required stylesheet contents using the <code>getStyleSheet[Text]()</code> methods.",
         "dependencies": ["DOM"],
         "types": [
             {
@@ skipping 1915 matching lines @@
                 "parameters": [
                     { "name": "windowId", "$ref": "WindowID", "description": "Browser window id." }
                 ],
                 "returns": [
                     { "name": "bounds", "$ref": "Bounds", "description": "Bounds information of the window. When window state is 'minimized', the restored window position and size are returned." }
                 ]
             }
         ]
     }]
 }