inspector/JSGlobalObjectInspectorController.h

   1 /*
   2  * Copyright (C) 2014 Apple 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
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
  14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
  17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #ifndef JSGlobalObjectInspectorController_h
  27 #define JSGlobalObjectInspectorController_h
  28
  29 #if ENABLE(INSPECTOR)
  30
  31 #include "InspectorAgentRegistry.h"
  32 #include "InspectorEnvironment.h"
  33 #include <wtf/Forward.h>
  34 #include <wtf/Noncopyable.h>
  35 #include <wtf/text/WTFString.h>
  36
  37 namespace JSC {
  38 class ConsoleClient;
  39 class ExecState;
  40 class JSGlobalObject;
  41 class JSValue;
  42 }
  43
  44 namespace Inspector {
  45
  46 class InjectedScriptManager;
  47 class InspectorConsoleAgent;
  48 class InspectorBackendDispatcher;
  49 class InspectorConsoleAgent;
  50 class InspectorFrontendChannel;
  51 class JSConsoleClient;
  52 class ScriptCallStack;
  53
  54 class JSGlobalObjectInspectorController final : public InspectorEnvironment {
  55     WTF_MAKE_NONCOPYABLE(JSGlobalObjectInspectorController);
  56     WTF_MAKE_FAST_ALLOCATED;
  57 public:
  58     JSGlobalObjectInspectorController(JSC::JSGlobalObject&);
  59     ~JSGlobalObjectInspectorController();
  60
  61     void connectFrontend(InspectorFrontendChannel*);
  62     void disconnectFrontend(InspectorDisconnectReason reason);
  63     void dispatchMessageFromFrontend(const String&);
  64
  65     void globalObjectDestroyed();
  66
  67     bool includesNativeCallStackWhenReportingExceptions() const { return m_includeNativeCallStackWithExceptions; }
  68     void setIncludesNativeCallStackWhenReportingExceptions(bool includesNativeCallStack) { m_includeNativeCallStackWithExceptions = includesNativeCallStack; }
  69
  70     void reportAPIException(JSC::ExecState*, JSC::JSValue exception);
  71
  72     JSC::ConsoleClient* consoleClient() const;
  73
  74     virtual bool developerExtrasEnabled() const override { return true; }
  75     virtual bool canAccessInspectedScriptState(JSC::ExecState*) const override { return true; }
  76     virtual InspectorFunctionCallHandler functionCallHandler() const override;
  77     virtual InspectorEvaluateHandler evaluateHandler() const override;
  78     virtual void willCallInjectedScriptFunction(JSC::ExecState*, const String&, int) override { }
  79     virtual void didCallInjectedScriptFunction(JSC::ExecState*) override { }
  80
  81 private:
  82     void appendAPIBacktrace(ScriptCallStack* callStack);
  83
  84     JSC::JSGlobalObject& m_globalObject;
  85     std::unique_ptr<InjectedScriptManager> m_injectedScriptManager;
  86     std::unique_ptr<JSConsoleClient> m_consoleClient;
  87     InspectorConsoleAgent* m_consoleAgent;
  88     InspectorAgentRegistry m_agents;
  89     InspectorFrontendChannel* m_inspectorFrontendChannel;
  90     RefPtr<InspectorBackendDispatcher> m_inspectorBackendDispatcher;
  91     bool m_includeNativeCallStackWithExceptions;
  92 };
  93
  94 } // namespace Inspector
  95
  96 #endif // ENABLE(INSPECTOR)
  97
  98 #endif // !defined(JSGlobalObjectInspectorController_h)