inspector/agents/InspectorAgent.h

   1 /*
   2  * Copyright (C) 2007, 2008, 2009, 2010 Apple Inc. All rights reserved.
   3  * Copyright (C) 2011 Google Inc. All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * 1.  Redistributions of source code must retain the above copyright
  10  *     notice, this list of conditions and the following disclaimer.
  11  * 2.  Redistributions in binary form must reproduce the above copyright
  12  *     notice, this list of conditions and the following disclaimer in the
  13  *     documentation and/or other materials provided with the distribution.
  14  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
  15  *     its contributors may be used to endorse or promote products derived
  16  *     from this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
  19  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  20  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  21  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  22  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  23  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  24  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  25  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  */
  29
  30 #ifndef InspectorAgent_h
  31 #define InspectorAgent_h
  32
  33 #include "InspectorBackendDispatchers.h"
  34 #include "InspectorFrontendDispatchers.h"
  35 #include "inspector/InspectorAgentBase.h"
  36 #include <wtf/Forward.h>
  37 #include <wtf/Vector.h>
  38
  39 namespace Inspector {
  40
  41 class BackendDispatcher;
  42 class InspectorEnvironment;
  43 class InspectorObject;
  44
  45 typedef String ErrorString;
  46
  47 class JS_EXPORT_PRIVATE InspectorAgent final : public InspectorAgentBase, public InspectorBackendDispatcherHandler {
  48     WTF_MAKE_NONCOPYABLE(InspectorAgent);
  49     WTF_MAKE_FAST_ALLOCATED;
  50 public:
  51     InspectorAgent(InspectorEnvironment&);
  52     virtual ~InspectorAgent();
  53
  54     virtual void didCreateFrontendAndBackend(FrontendChannel*, BackendDispatcher*) override;
  55     virtual void willDestroyFrontendAndBackend(DisconnectReason) override;
  56
  57     virtual void enable(ErrorString&) override;
  58     virtual void disable(ErrorString&) override;
  59     virtual void initialized(ErrorString&) override;
  60
  61     void inspect(RefPtr<Protocol::Runtime::RemoteObject>&& objectToInspect, RefPtr<InspectorObject>&& hints);
  62     void evaluateForTestInFrontend(const String& script);
  63
  64 #if ENABLE(INSPECTOR_ALTERNATE_DISPATCHERS)
  65     void activateExtraDomain(const String&);
  66     void activateExtraDomains(const Vector<String>&);
  67 #endif
  68
  69 private:
  70     InspectorEnvironment& m_environment;
  71     std::unique_ptr<InspectorFrontendDispatcher> m_frontendDispatcher;
  72     RefPtr<InspectorBackendDispatcher> m_backendDispatcher;
  73     Vector<String> m_pendingEvaluateTestCommands;
  74     std::pair<RefPtr<Protocol::Runtime::RemoteObject>, RefPtr<InspectorObject>> m_pendingInspectData;
  75 #if ENABLE(INSPECTOR_ALTERNATE_DISPATCHERS)
  76     RefPtr<Inspector::Protocol::Array<String>> m_pendingExtraDomainsData;
  77 #endif
  78     bool m_enabled;
  79 };
  80
  81 } // namespace Inspector
  82
  83 #endif // !defined(InspectorAgent_h)