Home | History | Annotate | Download | only in inspector
      1 /*
      2  * Copyright (C) 2011 Google Inc. All rights reserved.
      3  *
      4  * Redistribution and use in source and binary forms, with or without
      5  * modification, are permitted provided that the following conditions are
      6  * met:
      7  *
      8  *     * Redistributions of source code must retain the above copyright
      9  * notice, this list of conditions and the following disclaimer.
     10  *     * Redistributions in binary form must reproduce the above
     11  * copyright notice, this list of conditions and the following disclaimer
     12  * in the documentation and/or other materials provided with the
     13  * distribution.
     14  *     * Neither the name of Google Inc. nor the names of its
     15  * contributors may be used to endorse or promote products derived from
     16  * this software without specific prior written permission.
     17  *
     18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
     21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
     24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     29  */
     30 
     31 #ifndef InspectorPageAgent_h
     32 #define InspectorPageAgent_h
     33 
     34 #if ENABLE(INSPECTOR)
     35 
     36 #include "PlatformString.h"
     37 #include <wtf/RefCounted.h>
     38 #include <wtf/Vector.h>
     39 
     40 namespace WebCore {
     41 
     42 class DOMWrapperWorld;
     43 class Frame;
     44 class Frontend;
     45 class InjectedScriptManager;
     46 class InspectorArray;
     47 class InspectorFrontend;
     48 class InstrumentingAgents;
     49 class Page;
     50 
     51 typedef String ErrorString;
     52 
     53 class InspectorPageAgent {
     54     WTF_MAKE_NONCOPYABLE(InspectorPageAgent);
     55 public:
     56     static PassOwnPtr<InspectorPageAgent> create(InstrumentingAgents*, Page*, InjectedScriptManager*);
     57 
     58     // Page API for InspectorFrontend
     59     void addScriptToEvaluateOnLoad(ErrorString*, const String& source);
     60     void removeAllScriptsToEvaluateOnLoad(ErrorString*);
     61     void reloadPage(ErrorString*, const bool* const optionalIgnoreCache);
     62     void openInInspectedWindow(ErrorString*, const String& url);
     63     void setUserAgentOverride(ErrorString*, const String& userAgent);
     64     void getCookies(ErrorString*, RefPtr<InspectorArray>* cookies, WTF::String* cookiesString);
     65     void deleteCookie(ErrorString*, const String& cookieName, const String& domain);
     66 
     67     // InspectorInstrumentation API
     68     void inspectedURLChanged(const String& url);
     69     void didCommitLoad(const String& url);
     70     void didClearWindowObjectInWorld(Frame*, DOMWrapperWorld*);
     71     void domContentEventFired();
     72     void loadEventFired();
     73 
     74     void setFrontend(InspectorFrontend*);
     75     void clearFrontend();
     76     void restore();
     77     void applyUserAgentOverride(String* userAgent) const;
     78 
     79 private:
     80     InspectorPageAgent(InstrumentingAgents*, Page*, InjectedScriptManager*);
     81 
     82     InstrumentingAgents* m_instrumentingAgents;
     83     Page* m_inspectedPage;
     84     InjectedScriptManager* m_injectedScriptManager;
     85     InspectorFrontend* m_frontend;
     86     Vector<String> m_scriptsToEvaluateOnLoad;
     87     String m_userAgentOverride;
     88 };
     89 
     90 
     91 } // namespace WebCore
     92 
     93 #endif // ENABLE(INSPECTOR)
     94 
     95 #endif // !defined(InspectorPagerAgent_h)
     96