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