2010-08-09 Ilya Tikhonovsky <loislo@chromium.org>
[WebKit-https.git] / WebCore / inspector / front-end / InjectedScriptAccess.js
1 /*
2  * Copyright (C) 2009 Google Inc. All rights reserved.
3  * Copyright (C) 2009 Joseph Pecoraro
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are
7  * met:
8  *
9  *     * Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *     * Redistributions in binary form must reproduce the above
12  * copyright notice, this list of conditions and the following disclaimer
13  * in the documentation and/or other materials provided with the
14  * distribution.
15  *     * Neither the name of Google Inc. nor the names of its
16  * contributors may be used to endorse or promote products derived from
17  * this software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31
32 function InjectedScriptAccess(injectedScriptId) {
33     this._injectedScriptId = injectedScriptId;
34 }
35
36 InjectedScriptAccess.get = function(injectedScriptId)
37 {
38     if (typeof injectedScriptId === "number")
39         return new InjectedScriptAccess(injectedScriptId);
40
41     console.error("Access to injected script with no id");
42     console.trace();
43 }
44
45 InjectedScriptAccess.getDefault = function()
46 {
47     return InjectedScriptAccess.get(0);
48 }
49
50 InjectedScriptAccess.prototype = {};
51
52 InjectedScriptAccess._installHandler = function(methodName, async)
53 {
54     InjectedScriptAccess.prototype[methodName] = function()
55     {
56         var allArgs = Array.prototype.slice.call(arguments);
57         var callback = allArgs[allArgs.length - 1];
58         var argsString = JSON.stringify(Array.prototype.slice.call(allArgs, 0, allArgs.length - 1));
59         
60         function myCallback(result, isException)
61         {
62             if (!isException)
63                 callback(result);
64             else
65                 WebInspector.console.addMessage(WebInspector.ConsoleMessage.createTextMessage("Error dispatching: " + methodName));
66         }
67         var callId = WebInspector.Callback.wrap(myCallback);
68
69         InspectorBackend.dispatchOnInjectedScript(callId, this._injectedScriptId, methodName, argsString, !!async);
70     };
71 }
72
73 // InjectedScriptAccess message forwarding puts some constraints on the way methods are implemented and called:
74 // - Make sure corresponding methods in InjectedScript return non-null and non-undefined values,
75 // - Make sure last parameter of all the InjectedSriptAccess.* calls is a callback function.
76 // We keep these sorted.
77 InjectedScriptAccess._installHandler("evaluate");
78 InjectedScriptAccess._installHandler("evaluateAndStringify");
79 InjectedScriptAccess._installHandler("evaluateInCallFrame");
80 InjectedScriptAccess._installHandler("evaluateOnSelf");
81 InjectedScriptAccess._installHandler("getCompletions");
82 InjectedScriptAccess._installHandler("getProperties");
83 InjectedScriptAccess._installHandler("getPrototypes");
84 InjectedScriptAccess._installHandler("openInInspectedWindow");
85 InjectedScriptAccess._installHandler("pushNodeToFrontend");
86 InjectedScriptAccess._installHandler("setPropertyValue");
87
88 // Some methods can't run synchronously even on the injected script side (such as DB transactions).
89 // Mark them as asynchronous here.
90 InjectedScriptAccess._installHandler("executeSql", true);
91