src/third_party/WebKit/Source/core/inspector/InspectorInspectorAgent.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 Computer, 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 InspectorInspectorAgent_h
  31 #define InspectorInspectorAgent_h
  32
  33 #include "core/InspectorFrontend.h"
  34 #include "core/inspector/InspectorBaseAgent.h"
  35 #include "wtf/HashMap.h"
  36 #include "wtf/PassOwnPtr.h"
  37 #include "wtf/Vector.h"
  38
  39 namespace blink {
  40
  41 class LocalFrame;
  42 class InjectedScriptManager;
  43 class JSONObject;
  44 class Page;
  45
  46 typedef String ErrorString;
  47
  48 class InspectorInspectorAgent final : public InspectorBaseAgent<InspectorInspectorAgent>, public InspectorBackendDispatcher::InspectorCommandHandler {
  49     WTF_MAKE_NONCOPYABLE(InspectorInspectorAgent);
  50 public:
  51     static PassOwnPtrWillBeRawPtr<InspectorInspectorAgent> create(Page* page, InjectedScriptManager* injectedScriptManager)
  52     {
  53         return adoptPtrWillBeNoop(new InspectorInspectorAgent(page, injectedScriptManager));
  54     }
  55
  56     virtual ~InspectorInspectorAgent();
  57     virtual void trace(Visitor*) override;
  58
  59     // Inspector front-end API.
  60     virtual void enable(ErrorString*) override;
  61     virtual void disable(ErrorString*) override;
  62     virtual void reset(ErrorString*) override;
  63
  64     virtual void init() override;
  65     virtual void setFrontend(InspectorFrontend*) override;
  66     virtual void clearFrontend() override;
  67
  68     void didClearDocumentOfWindowObject(LocalFrame*);
  69
  70     void domContentLoadedEventFired(LocalFrame*);
  71
  72     bool hasFrontend() const { return m_frontend; }
  73
  74     // Generic code called from custom implementations.
  75     void evaluateForTestInFrontend(long testCallId, const String& script);
  76
  77     void setInjectedScriptForOrigin(const String& origin, const String& source);
  78
  79     void inspect(PassRefPtr<TypeBuilder::Runtime::RemoteObject> objectToInspect, PassRefPtr<JSONObject> hints);
  80
  81 private:
  82     InspectorInspectorAgent(Page*, InjectedScriptManager*);
  83
  84     RawPtrWillBeMember<Page> m_inspectedPage;
  85     InspectorFrontend::Inspector* m_frontend;
  86     RawPtrWillBeMember<InjectedScriptManager> m_injectedScriptManager;
  87
  88     Vector<pair<long, String> > m_pendingEvaluateTestCommands;
  89     pair<RefPtr<TypeBuilder::Runtime::RemoteObject>, RefPtr<JSONObject> > m_pendingInspectData;
  90     typedef HashMap<String, String> InjectedScriptForOriginMap;
  91     InjectedScriptForOriginMap m_injectedScriptForOrigin;
  92 };
  93
  94 } // namespace blink
  95
  96 #endif // !defined(InspectorInspectorAgent_h)