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 #if ENABLE(INSPECTOR)
  34
  35 #include "InspectorJSBackendDispatchers.h"
  36 #include "InspectorJSFrontendDispatchers.h"
  37 #include "inspector/InspectorAgentBase.h"
  38 #include <wtf/Forward.h>
  39 #include <wtf/Vector.h>
  40
  41 namespace Inspector {
  42
  43 class InspectorObject;
  44 class InstrumentingAgents;
  45 class InspectorInspectorBackendDispatcher;
  46 class InspectorInspectorFrontendDispatchers;
  47
  48 typedef String ErrorString;
  49
  50 class JS_EXPORT_PRIVATE InspectorAgent final : public InspectorAgentBase, public InspectorInspectorBackendDispatcherHandler {
  51     WTF_MAKE_NONCOPYABLE(InspectorAgent);
  52     WTF_MAKE_FAST_ALLOCATED;
  53 public:
  54     InspectorAgent();
  55     virtual ~InspectorAgent();
  56
  57     virtual void didCreateFrontendAndBackend(InspectorFrontendChannel*, InspectorBackendDispatcher*) override;
  58     virtual void willDestroyFrontendAndBackend(InspectorDisconnectReason reason) override;
  59
  60     virtual void enable(ErrorString*) override;
  61     virtual void disable(ErrorString*) override;
  62
  63     void inspect(PassRefPtr<TypeBuilder::Runtime::RemoteObject> objectToInspect, PassRefPtr<InspectorObject> hints);
  64     void evaluateForTestInFrontend(const String& script);
  65
  66 private:
  67     std::unique_ptr<InspectorInspectorFrontendDispatcher> m_frontendDispatcher;
  68     RefPtr<InspectorInspectorBackendDispatcher> m_backendDispatcher;
  69     Vector<String> m_pendingEvaluateTestCommands;
  70     std::pair<RefPtr<TypeBuilder::Runtime::RemoteObject>, RefPtr<InspectorObject>> m_pendingInspectData;
  71     bool m_enabled;
  72 };
  73
  74 } // namespace Inspector
  75
  76 #endif // ENABLE(INSPECTOR)
  77
  78 #endif // !defined(InspectorAgent_h)