Home | History | Annotate | Download | only in inspector 
      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 InspectorAgent_h
     31 #define InspectorAgent_h
     32 
     33 #include "core/inspector/InspectorBaseAgent.h"
     34 #include "wtf/Forward.h"
     35 #include "wtf/HashMap.h"
     36 #include "wtf/PassOwnPtr.h"
     37 #include "wtf/Vector.h"
     38 #include "wtf/text/WTFString.h"
     39 
     40 namespace WebCore {
     41 
     42 class DOMWrapperWorld;
     43 class DocumentLoader;
     44 class Frame;
     45 class InjectedScriptManager;
     46 class InspectorFrontend;
     47 class InstrumentingAgents;
     48 class JSONObject;
     49 class KURL;
     50 class Page;
     51 
     52 typedef String ErrorString;
     53 
     54 class InspectorAgent : public InspectorBaseAgent<InspectorAgent>, public InspectorBackendDispatcher::InspectorCommandHandler {
     55     WTF_MAKE_NONCOPYABLE(InspectorAgent);
     56 public:
     57     static PassOwnPtr<InspectorAgent> create(Page* page, InjectedScriptManager* injectedScriptManager, InstrumentingAgents* instrumentingAgents, InspectorCompositeState* state)
     58     {
     59         return adoptPtr(new InspectorAgent(page, injectedScriptManager, instrumentingAgents, state));
     60     }
     61 
     62     virtual ~InspectorAgent();
     63 
     64     // Inspector front-end API.
     65     void enable(ErrorString*);
     66     void disable(ErrorString*);
     67     void reset(ErrorString*);
     68 
     69     KURL inspectedURL() const;
     70     KURL inspectedURLWithoutFragment() const;
     71 
     72     InspectorFrontend* frontend() const { return m_frontend; }
     73 
     74     virtual void setFrontend(InspectorFrontend*);
     75     virtual void clearFrontend();
     76 
     77     void didClearWindowObjectInWorld(Frame*, DOMWrapperWorld*);
     78 
     79     void didCommitLoad(Frame*, DocumentLoader*);
     80     void domContentLoadedEventFired(Frame*);
     81 
     82     bool hasFrontend() const { return m_frontend; }
     83 
     84     // Generic code called from custom implementations.
     85     void evaluateForTestInFrontend(long testCallId, const String& script);
     86 
     87     void setInjectedScriptForOrigin(const String& origin, const String& source);
     88 
     89     void inspect(PassRefPtr<TypeBuilder::Runtime::RemoteObject> objectToInspect, PassRefPtr<JSONObject> hints);
     90 
     91 private:
     92     InspectorAgent(Page*, InjectedScriptManager*, InstrumentingAgents*, InspectorCompositeState*);
     93 
     94     void unbindAllResources();
     95 
     96     void toggleRecordButton(bool);
     97 
     98     bool isMainResourceLoader(DocumentLoader*, const KURL& requestUrl);
     99 
    100     Page* m_inspectedPage;
    101     InspectorFrontend* m_frontend;
    102     InjectedScriptManager* m_injectedScriptManager;
    103 
    104     Vector<pair<long, String> > m_pendingEvaluateTestCommands;
    105     pair<RefPtr<TypeBuilder::Runtime::RemoteObject>, RefPtr<JSONObject> > m_pendingInspectData;
    106     typedef HashMap<String, String> InjectedScriptForOriginMap;
    107     InjectedScriptForOriginMap m_injectedScriptForOrigin;
    108 };
    109 
    110 } // namespace WebCore
    111 
    112 #endif // !defined(InspectorAgent_h)
    113