devtools-protocol 0.0.1498010 → 0.0.1501221

package/pdl/domains/LayerTree.pdl

@@ -0,0 +1,178 @@
+# Copyright 2017 The Chromium Authors
+# Use of this source code is governed by a BSD-style license that can be
+# found in the LICENSE file.
+#
+# Contributing to Chrome DevTools Protocol: https://goo.gle/devtools-contribution-guide-cdp
+
+experimental domain LayerTree
+  depends on DOM
+
+  # Unique Layer identifier.
+  type LayerId extends string
+
+  # Unique snapshot identifier.
+  type SnapshotId extends string
+
+  # Rectangle where scrolling happens on the main thread.
+  type ScrollRect extends object
+    properties
+      # Rectangle itself.
+      DOM.Rect rect
+      # Reason for rectangle to force scrolling on the main thread
+      enum type
+        RepaintsOnScroll
+        TouchEventHandler
+        WheelEventHandler
+
+  # Sticky position constraints.
+  type StickyPositionConstraint extends object
+    properties
+      # Layout rectangle of the sticky element before being shifted
+      DOM.Rect stickyBoxRect
+      # Layout rectangle of the containing block of the sticky element
+      DOM.Rect containingBlockRect
+      # The nearest sticky layer that shifts the sticky box
+      optional LayerId nearestLayerShiftingStickyBox
+      # The nearest sticky layer that shifts the containing block
+      optional LayerId nearestLayerShiftingContainingBlock
+
+  # Serialized fragment of layer picture along with its offset within the layer.
+  type PictureTile extends object
+    properties
+      # Offset from owning layer left boundary
+      number x
+      # Offset from owning layer top boundary
+      number y
+      # Base64-encoded snapshot data.
+      binary picture
+
+  # Information about a compositing layer.
+  type Layer extends object
+    properties
+      # The unique id for this layer.
+      LayerId layerId
+      # The id of parent (not present for root).
+      optional LayerId parentLayerId
+      # The backend id for the node associated with this layer.
+      optional DOM.BackendNodeId backendNodeId
+      # Offset from parent layer, X coordinate.
+      number offsetX
+      # Offset from parent layer, Y coordinate.
+      number offsetY
+      # Layer width.
+      number width
+      # Layer height.
+      number height
+      # Transformation matrix for layer, default is identity matrix
+      optional array of number transform
+      # Transform anchor point X, absent if no transform specified
+      optional number anchorX
+      # Transform anchor point Y, absent if no transform specified
+      optional number anchorY
+      # Transform anchor point Z, absent if no transform specified
+      optional number anchorZ
+      # Indicates how many time this layer has painted.
+      integer paintCount
+      # Indicates whether this layer hosts any content, rather than being used for
+      # transform/scrolling purposes only.
+      boolean drawsContent
+      # Set if layer is not visible.
+      optional boolean invisible
+      # Rectangles scrolling on main thread only.
+      optional array of ScrollRect scrollRects
+      # Sticky position constraint information
+      optional StickyPositionConstraint stickyPositionConstraint
+
+  # Array of timings, one per paint step.
+  type PaintProfile extends array of number
+
+  # Provides the reasons why the given layer was composited.
+  command compositingReasons
+    parameters
+      # The id of the layer for which we want to get the reasons it was composited.
+      LayerId layerId
+    returns
+      # A list of strings specifying reasons for the given layer to become composited.
+      array of string compositingReasons
+      # A list of strings specifying reason IDs for the given layer to become composited.
+      array of string compositingReasonIds
+
+  # Disables compositing tree inspection.
+  command disable
+
+  # Enables compositing tree inspection.
+  command enable
+
+  # Returns the snapshot identifier.
+  command loadSnapshot
+    parameters
+      # An array of tiles composing the snapshot.
+      array of PictureTile tiles
+    returns
+      # The id of the snapshot.
+      SnapshotId snapshotId
+
+  # Returns the layer snapshot identifier.
+  command makeSnapshot
+    parameters
+      # The id of the layer.
+      LayerId layerId
+    returns
+      # The id of the layer snapshot.
+      SnapshotId snapshotId
+
+  command profileSnapshot
+    parameters
+      # The id of the layer snapshot.
+      SnapshotId snapshotId
+      # The maximum number of times to replay the snapshot (1, if not specified).
+      optional integer minRepeatCount
+      # The minimum duration (in seconds) to replay the snapshot.
+      optional number minDuration
+      # The clip rectangle to apply when replaying the snapshot.
+      optional DOM.Rect clipRect
+    returns
+      # The array of paint profiles, one per run.
+      array of PaintProfile timings
+
+  # Releases layer snapshot captured by the back-end.
+  command releaseSnapshot
+    parameters
+      # The id of the layer snapshot.
+      SnapshotId snapshotId
+
+  # Replays the layer snapshot and returns the resulting bitmap.
+  command replaySnapshot
+    parameters
+      # The id of the layer snapshot.
+      SnapshotId snapshotId
+      # The first step to replay from (replay from the very start if not specified).
+      optional integer fromStep
+      # The last step to replay to (replay till the end if not specified).
+      optional integer toStep
+      # The scale to apply while replaying (defaults to 1).
+      optional number scale
+    returns
+      # A data: URL for resulting image.
+      string dataURL
+
+  # Replays the layer snapshot and returns canvas log.
+  command snapshotCommandLog
+    parameters
+      # The id of the layer snapshot.
+      SnapshotId snapshotId
+    returns
+      # The array of canvas function calls.
+      array of object commandLog
+
+  event layerPainted
+    parameters
+      # The id of the painted layer.
+      LayerId layerId
+      # Clip rectangle.
+      DOM.Rect clip
+
+  event layerTreeDidChange
+    parameters
+      # Layer tree, absent if not in the compositing mode.
+      optional array of Layer layers

package/pdl/domains/Log.pdl

@@ -0,0 +1,93 @@
+# Copyright 2017 The Chromium Authors
+# Use of this source code is governed by a BSD-style license that can be
+# found in the LICENSE file.
+#
+# Contributing to Chrome DevTools Protocol: https://goo.gle/devtools-contribution-guide-cdp
+
+# Provides access to log entries.
+domain Log
+  depends on Runtime
+  depends on Network
+
+  # Log entry.
+  type LogEntry extends object
+    properties
+      # Log entry source.
+      enum source
+        xml
+        javascript
+        network
+        storage
+        appcache
+        rendering
+        security
+        deprecation
+        worker
+        violation
+        intervention
+        recommendation
+        other
+      # Log entry severity.
+      enum level
+        verbose
+        info
+        warning
+        error
+      # Logged text.
+      string text
+      optional enum category
+        cors
+      # Timestamp when this entry was added.
+      Runtime.Timestamp timestamp
+      # URL of the resource if known.
+      optional string url
+      # Line number in the resource.
+      optional integer lineNumber
+      # JavaScript stack trace.
+      optional Runtime.StackTrace stackTrace
+      # Identifier of the network request associated with this entry.
+      optional Network.RequestId networkRequestId
+      # Identifier of the worker associated with this entry.
+      optional string workerId
+      # Call arguments.
+      optional array of Runtime.RemoteObject args
+
+  # Violation configuration setting.
+  type ViolationSetting extends object
+    properties
+      # Violation type.
+      enum name
+        longTask
+        longLayout
+        blockedEvent
+        blockedParser
+        discouragedAPIUse
+        handler
+        recurringHandler
+      # Time threshold to trigger upon.
+      number threshold
+
+  # Clears the log.
+  command clear
+
+  # Disables log domain, prevents further log entries from being reported to the client.
+  command disable
+
+  # Enables log domain, sends the entries collected so far to the client by means of the
+  # `entryAdded` notification.
+  command enable
+
+  # start violation reporting.
+  command startViolationsReport
+    parameters
+      # Configuration for violations.
+      array of ViolationSetting config
+
+  # Stop violation reporting.
+  command stopViolationsReport
+
+  # Issued when new message was logged.
+  event entryAdded
+    parameters
+      # The entry.
+      LogEntry entry

package/pdl/domains/Media.pdl

@@ -0,0 +1,106 @@
+# Copyright 2017 The Chromium Authors
+# Use of this source code is governed by a BSD-style license that can be
+# found in the LICENSE file.
+#
+# Contributing to Chrome DevTools Protocol: https://goo.gle/devtools-contribution-guide-cdp
+
+# This domain allows detailed inspection of media elements.
+experimental domain Media
+
+  # Players will get an ID that is unique within the agent context.
+  type PlayerId extends string
+
+  type Timestamp extends number
+
+  # Have one type per entry in MediaLogRecord::Type
+  # Corresponds to kMessage
+  type PlayerMessage extends object
+    properties
+      # Keep in sync with MediaLogMessageLevel
+      # We are currently keeping the message level 'error' separate from the
+      # PlayerError type because right now they represent different things,
+      # this one being a DVLOG(ERROR) style log message that gets printed
+      # based on what log level is selected in the UI, and the other is a
+      # representation of a media::PipelineStatus object. Soon however we're
+      # going to be moving away from using PipelineStatus for errors and
+      # introducing a new error type which should hopefully let us integrate
+      # the error log level into the PlayerError type.
+      enum level
+        error
+        warning
+        info
+        debug
+      string message
+
+  # Corresponds to kMediaPropertyChange
+  type PlayerProperty extends object
+    properties
+      string name
+      string value
+
+  # Corresponds to kMediaEventTriggered
+  type PlayerEvent extends object
+    properties
+      Timestamp timestamp
+      string value
+
+  # Represents logged source line numbers reported in an error.
+  # NOTE: file and line are from chromium c++ implementation code, not js.
+  type PlayerErrorSourceLocation extends object
+    properties
+      string file
+      integer line
+
+  # Corresponds to kMediaError
+  type PlayerError extends object
+    properties
+      string errorType
+      # Code is the numeric enum entry for a specific set of error codes, such
+      # as PipelineStatusCodes in media/base/pipeline_status.h
+      integer code
+      # A trace of where this error was caused / where it passed through.
+      array of PlayerErrorSourceLocation stack
+      # Errors potentially have a root cause error, ie, a DecoderError might be
+      # caused by an WindowsError
+      array of PlayerError cause
+      # Extra data attached to an error, such as an HRESULT, Video Codec, etc.
+      object data
+
+  # This can be called multiple times, and can be used to set / override /
+  # remove player properties. A null propValue indicates removal.
+  event playerPropertiesChanged
+    parameters
+      PlayerId playerId
+      array of PlayerProperty properties
+
+  # Send events as a list, allowing them to be batched on the browser for less
+  # congestion. If batched, events must ALWAYS be in chronological order.
+  event playerEventsAdded
+    parameters
+      PlayerId playerId
+      array of PlayerEvent events
+
+  # Send a list of any messages that need to be delivered.
+  event playerMessagesLogged
+    parameters
+      PlayerId playerId
+      array of PlayerMessage messages
+
+  # Send a list of any errors that need to be delivered.
+  event playerErrorsRaised
+    parameters
+      PlayerId playerId
+      array of PlayerError errors
+
+  # Called whenever a player is created, or when a new agent joins and receives
+  # a list of active players. If an agent is restored, it will receive the full
+  # list of player ids and all events again.
+  event playersCreated
+    parameters
+      array of PlayerId players
+
+  # Enables the Media domain
+  command enable
+
+  # Disables the Media domain.
+  command disable

package/pdl/domains/Memory.pdl

@@ -0,0 +1,112 @@
+# Copyright 2017 The Chromium Authors
+# Use of this source code is governed by a BSD-style license that can be
+# found in the LICENSE file.
+#
+# Contributing to Chrome DevTools Protocol: https://goo.gle/devtools-contribution-guide-cdp
+
+experimental domain Memory
+
+  # Memory pressure level.
+  type PressureLevel extends string
+    enum
+      moderate
+      critical
+
+  # Retruns current DOM object counters.
+  command getDOMCounters
+    returns
+      integer documents
+      integer nodes
+      integer jsEventListeners
+
+  # Retruns DOM object counters after preparing renderer for leak detection.
+  command getDOMCountersForLeakDetection
+    returns
+      # DOM object counters.
+      array of DOMCounter counters
+
+  # Prepares for leak detection by terminating workers, stopping spellcheckers,
+  # dropping non-essential internal caches, running garbage collections, etc.
+  command prepareForLeakDetection
+
+  # Simulate OomIntervention by purging V8 memory.
+  command forciblyPurgeJavaScriptMemory
+
+  # Enable/disable suppressing memory pressure notifications in all processes.
+  command setPressureNotificationsSuppressed
+    parameters
+      # If true, memory pressure notifications will be suppressed.
+      boolean suppressed
+
+  # Simulate a memory pressure notification in all processes.
+  command simulatePressureNotification
+    parameters
+      # Memory pressure level of the notification.
+      PressureLevel level
+
+  # Start collecting native memory profile.
+  command startSampling
+    parameters
+      # Average number of bytes between samples.
+      optional integer samplingInterval
+      # Do not randomize intervals between samples.
+      optional boolean suppressRandomness
+
+  # Stop collecting native memory profile.
+  command stopSampling
+
+  # Retrieve native memory allocations profile
+  # collected since renderer process startup.
+  command getAllTimeSamplingProfile
+    returns
+      SamplingProfile profile
+
+  # Retrieve native memory allocations profile
+  # collected since browser process startup.
+  command getBrowserSamplingProfile
+    returns
+      SamplingProfile profile
+
+  # Retrieve native memory allocations profile collected since last
+  # `startSampling` call.
+  command getSamplingProfile
+    returns
+      SamplingProfile profile
+
+  # Heap profile sample.
+  type SamplingProfileNode extends object
+    properties
+      # Size of the sampled allocation.
+      number size
+      # Total bytes attributed to this sample.
+      number total
+      # Execution stack at the point of allocation.
+      array of string stack
+
+  # Array of heap profile samples.
+  type SamplingProfile extends object
+    properties
+      array of SamplingProfileNode samples
+      array of Module modules
+
+  # Executable module information
+  type Module extends object
+    properties
+      # Name of the module.
+      string name
+      # UUID of the module.
+      string uuid
+      # Base address where the module is loaded into memory. Encoded as a decimal
+      # or hexadecimal (0x prefixed) string.
+      string baseAddress
+      # Size of the module in bytes.
+      number size
+
+  # DOM object counter data.
+  type DOMCounter extends object
+    properties
+      # Object name. Note: object names should be presumed volatile and clients should not expect
+      # the returned names to be consistent across runs.
+      string name
+      # Object count.
+      integer count