Home | History | Annotate | Download | only in inspector 
      1 /*
      2  * Copyright (C) 2011 Google Inc. All rights reserved.
      3  *
      4  * Redistribution and use in source and binary forms, with or without
      5  * modification, are permitted provided that the following conditions are
      6  * met:
      7  *
      8  *     * Redistributions of source code must retain the above copyright
      9  * notice, this list of conditions and the following disclaimer.
     10  *     * Redistributions in binary form must reproduce the above
     11  * copyright notice, this list of conditions and the following disclaimer
     12  * in the documentation and/or other materials provided with the
     13  * distribution.
     14  *     * Neither the name of Google Inc. nor the names of its
     15  * contributors may be used to endorse or promote products derived from
     16  * this software without specific prior written permission.
     17  *
     18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
     21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
     24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     29  */
     30 
     31 #ifndef InspectorRuntimeAgent_h
     32 #define InspectorRuntimeAgent_h
     33 
     34 
     35 #include "core/inspector/InspectorBaseAgent.h"
     36 #include "wtf/Forward.h"
     37 #include "wtf/Noncopyable.h"
     38 
     39 namespace WebCore {
     40 
     41 class InjectedScript;
     42 class InjectedScriptManager;
     43 class InstrumentingAgents;
     44 class JSONArray;
     45 class ScriptDebugServer;
     46 
     47 typedef String ErrorString;
     48 
     49 class InspectorRuntimeAgent : public InspectorBaseAgent<InspectorRuntimeAgent>, public InspectorBackendDispatcher::RuntimeCommandHandler {
     50     WTF_MAKE_NONCOPYABLE(InspectorRuntimeAgent);
     51 public:
     52     virtual ~InspectorRuntimeAgent();
     53 
     54     bool enabled() { return m_enabled; }
     55     // Part of the protocol.
     56     virtual void enable(ErrorString*) { m_enabled = true; }
     57     virtual void disable(ErrorString*) { m_enabled = false; }
     58     virtual void evaluate(ErrorString*,
     59                   const String& expression,
     60                   const String* objectGroup,
     61                   const bool* includeCommandLineAPI,
     62                   const bool* doNotPauseOnExceptionsAndMuteConsole,
     63                   const int* executionContextId,
     64                   const bool* returnByValue,
     65                   const bool* generatePreview,
     66                   RefPtr<TypeBuilder::Runtime::RemoteObject>& result,
     67                   TypeBuilder::OptOutput<bool>* wasThrown);
     68     virtual void callFunctionOn(ErrorString*,
     69                         const String& objectId,
     70                         const String& expression,
     71                         const RefPtr<JSONArray>* optionalArguments,
     72                         const bool* doNotPauseOnExceptionsAndMuteConsole,
     73                         const bool* returnByValue,
     74                         const bool* generatePreview,
     75                         RefPtr<TypeBuilder::Runtime::RemoteObject>& result,
     76                         TypeBuilder::OptOutput<bool>* wasThrown);
     77     virtual void releaseObject(ErrorString*, const String& objectId);
     78     virtual void getProperties(ErrorString*, const String& objectId, const bool* ownProperties, const bool* accessorPropertiesOnly, RefPtr<TypeBuilder::Array<TypeBuilder::Runtime::PropertyDescriptor> >& result, RefPtr<TypeBuilder::Array<TypeBuilder::Runtime::InternalPropertyDescriptor> >& internalProperties);
     79     virtual void releaseObjectGroup(ErrorString*, const String& objectGroup);
     80     virtual void run(ErrorString*);
     81 
     82 protected:
     83     InspectorRuntimeAgent(InstrumentingAgents*, InspectorCompositeState*, InjectedScriptManager*, ScriptDebugServer*);
     84     virtual InjectedScript injectedScriptForEval(ErrorString*, const int* executionContextId) = 0;
     85 
     86     virtual void muteConsole() = 0;
     87     virtual void unmuteConsole() = 0;
     88 
     89     InjectedScriptManager* injectedScriptManager() { return m_injectedScriptManager; }
     90     bool m_enabled;
     91 
     92 private:
     93     InjectedScriptManager* m_injectedScriptManager;
     94     ScriptDebugServer* m_scriptDebugServer;
     95 };
     96 
     97 } // namespace WebCore
     98 
     99 #endif // InspectorRuntimeAgent_h
    100