Changeset 83576 in webkit


Ignore:
Timestamp:
Apr 12, 2011 4:37:10 AM (13 years ago)
Author:
pfeldman@chromium.org
Message:

2011-04-12 Pavel Feldman <pfeldman@google.com>

Reviewed by Yury Semikhatsky.

Web Inspector: document runtime agent, share remote object definition between domains.
https://bugs.webkit.org/show_bug.cgi?id=58246

  • inspector/Inspector.json:
Location:
trunk/Source/WebCore
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • trunk/Source/WebCore/ChangeLog

    r83575 r83576  
     12011-04-12  Pavel Feldman  <pfeldman@google.com>
     2
     3        Reviewed by Yury Semikhatsky.
     4
     5        Web Inspector: document runtime agent, share remote object definition between domains.
     6        https://bugs.webkit.org/show_bug.cgi?id=58246
     7
     8        * inspector/Inspector.json:
     9
    1102011-04-12  Pavel Feldman  <pfeldman@google.com>
    211
  • trunk/Source/WebCore/inspector/Inspector.json

    r83575 r83576  
    4444                "name": "inspect",
    4545                "parameters": [
    46                     { "name": "object", "$ref": "RemoteObject" },
     46                    { "name": "object", "$ref": "Runtime.RemoteObject" },
    4747                    { "name": "hints", "type": "object" }
    4848                ]
     
    133133    {
    134134        "domain": "Runtime",
    135         "types": [],
     135        "description": "Runtime domain exposes JavaScript runtime by means of remote evaluation and mirror objects. Evaluation results are returned as mirror object that expose type, string representation and unique identifier that can be used for further object interaction. Original objects are maintained in memory unless they are either explicitly released or are released along with the other objects in their object group.",
     136        "types": [
     137            {
     138                "id": "RemoteObject",
     139                "type": "object",
     140                "description": "Mirror object referencing original JavaScript object.",
     141                "properties": {
     142                    "description": { "type": "string", "description": "String representation of the object." },
     143                    "hasChildren": { "type": "integer", "optional": true, "description": "True when this object can be queried for children." },
     144                    "objectId": { "type": "string", "optional": true, "description": "Unique object identifier (for non-primitive values)." },
     145                    "type": { "type": "string", "enum": ["object", "array", "function", "null", "node", "undefined", "string", "number", "boolean", "error", "regexp", "date"], "description": "Object type." }
     146                }
     147            },
     148            {
     149                "id": "RemoteProperty",
     150                "type": "object",
     151                "description": "Mirror object property.",
     152                "properties": {
     153                    "name": { "type": "string", "description": "Property name." },
     154                    "value": { "$ref": "RemoteObject", "description": "Property value." },
     155                    "isGetter": { "type": "string", "description": "True if this property is getter." }
     156                }
     157            }
     158        ],
    136159        "commands": [
    137160            {
    138161                "name": "evaluate",
    139162                "parameters": [
    140                     { "name": "expression", "type": "string" },
    141                     { "name": "objectGroup", "type": "string" },
    142                     { "name": "includeCommandLineAPI", "type": "boolean", "optional": true }
    143                 ],
    144                 "returns": [
    145                     { "name": "result", "$ref": "RuntimeObject" }
    146                 ]
     163                    { "name": "expression", "type": "string", "description": "Expression to evaluate." },
     164                    { "name": "objectGroup", "type": "string", "description": "Symbolic group name that can be used to release multiple objects." },
     165                    { "name": "includeCommandLineAPI", "type": "boolean", "optional": true, "description": "Determines whether Command Line API should be available during the evaluation." }
     166                ],
     167                "returns": [
     168                    { "name": "result", "$ref": "RemoteObject", "description": "Evaluation result." }
     169                ],
     170                "description": "Evaluate expression on global object."
    147171            },
    148172            {
    149173                "name": "evaluateOn",
    150174                "parameters": [
    151                     { "name": "objectId", "type": "string" },
    152                     { "name": "expression", "type": "string" }
    153                 ],
    154                 "returns": [
    155                     { "name": "result", "$ref": "RuntimeObject" }
    156                 ]
     175                    { "name": "objectId", "type": "string", "description": "Identifier of the object to evaluate expression on." },
     176                    { "name": "expression", "type": "string", "description": "Expression to evaluate." }
     177                ],
     178                "returns": [
     179                    { "name": "result", "$ref": "RemoteObject", "description": "Evaluation result." }
     180                ],
     181                "description": "Evaluate expression on given object using it as <code>this</code>."
    157182            },
    158183            {
    159184                "name": "getProperties",
    160185                "parameters": [
    161                     { "name": "objectId", "type": "string" },
    162                     { "name": "ignoreHasOwnProperty", "type": "boolean" }
    163                 ],
    164                 "returns": [
    165                     { "name": "result", "type": "array", "items": { "$ref" : "RuntimeProperty"} }
    166                 ]
     186                    { "name": "objectId", "type": "string", "description": "Identifier of the object to return properties for." },
     187                    { "name": "ignoreHasOwnProperty", "type": "boolean", "description": "If true, returns properties belonging to any element of the prototype chain." }
     188                ],
     189                "returns": [
     190                    { "name": "result", "type": "array", "items": { "$ref" : "RuntimeProperty"}, "description": "Object properties." }
     191                ],
     192                "description": "Returns properties of a given object."
    167193            },
    168194            {
    169195                "name": "setPropertyValue",
    170196                "parameters": [
    171                     { "name": "objectId", "type": "string" },
    172                     { "name": "propertyName", "type": "string" },
    173                     { "name": "expression", "type": "string" }
    174                 ]
     197                    { "name": "objectId", "type": "string", "description": "Identifier of the object to set property on." },
     198                    { "name": "propertyName", "type": "string", "description": "Property name to set value for." },
     199                    { "name": "expression", "type": "string", "description": "Expression to evaluate." }
     200                ],
     201                "description": "Makes property with given name equal to the expression evaluation result."
    175202            },
    176203            {
    177204                "name": "releaseObject",
    178205                "parameters": [
    179                     { "name": "objectId", "type": "string" }
    180                 ]
     206                    { "name": "objectId", "type": "string", "description": "Identifier of the object to release." }
     207                ],
     208                "description": "Releases remote object with given id."
    181209            },
    182210            {
    183211                "name": "releaseObjectGroup",
    184212                "parameters": [
    185                     { "name": "objectGroup", "type": "string" }
    186                 ]
     213                    { "name": "objectGroup", "type": "string", "description": "Symbolic object group name." }
     214                ],
     215                "description": "Releases all remote objects that belong to a given group."
    187216            }
    188217        ]
     
    205234                    "text": { "type": "string", "description": "Message text." },
    206235                    "networkIdentifier": { "type": "integer", "optional": true, "description": "Identifier of the network request associated with the console message." },
    207                     "parameters": { "type": "array", "items": { "$ref": "RuntimeObject" }, "description": "Message parameters in case of the formatted message." },
     236                    "parameters": { "type": "array", "items": { "$ref": "Runtime.RemoteObject" }, "description": "Message parameters in case of the formatted message." },
    208237                    "stackTrace": { "type": "array", "optional": true, "items": { "$ref": "CallFrame" }, "description": "Call frames for assert and error messages." }
    209238                }
     
    889918                ],
    890919                "returns": [
    891                     { "name": "object", "$ref": "Object", "description": "JavaScript object wrapper for given node." }
     920                    { "name": "object", "$ref": "Runtime.RemoteObject", "description": "JavaScript object wrapper for given node." }
    892921                ],
    893922                "description": "Resolves JavaScript node object for given node id."
     
    12921321                "properties": {
    12931322                    "type": { "type": "string",  "enum": ["global", "local", "with", "closure", "catch"], "description": "Scope type." },
    1294                     "object": { "$ref": "RemoteObject", "description": "Object representing the scope." },
    1295                     "this": { "$ref": "RemoteObject", "optional": true, "description": "<code>this</code> object for local scope." }
     1323                    "object": { "$ref": "Runtime.RemoteObject", "description": "Object representing the scope." },
     1324                    "this": { "$ref": "Runtime.RemoteObject", "optional": true, "description": "<code>this</code> object for local scope." }
    12961325                },
    12971326                "description": "Debugger call frame. Array of call frames form call stack."
     
    14111440                ],
    14121441                "returns": [
    1413                     { "name": "result", "$ref": "Object", "description": "Object wrapper for the evaluation result." }
     1442                    { "name": "result", "$ref": "Runtime.RemoteObject", "description": "Object wrapper for the evaluation result." }
    14141443                ],
    14151444                "description": "Evaluates expression on a given call frame."
     
    14191448            {
    14201449                "name": "debuggerWasEnabled",
    1421                 "description": "Fired when debugger gets enabled."
     1450                "description": "Fired when debugger gets enabled (deprecated)."
    14221451            },
    14231452            {
    14241453                "name": "debuggerWasDisabled",
    1425                 "description": "Fired when debugger gets disabled."
     1454                "description": "Fired when debugger gets disabled (deprecated)."
    14261455            },
    14271456            {
Note: See TracChangeset for help on using the changeset viewer.