Home | History | Annotate | Download | only in web 
      1 /*
      2  * Copyright (C) 2009 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 WebDevToolsAgentClient_h
     32 #define WebDevToolsAgentClient_h
     33 
     34 #include "../platform/WebCString.h"
     35 #include "../platform/WebCommon.h"
     36 
     37 namespace WebKit {
     38 class WebString;
     39 struct WebDevToolsMessageData;
     40 
     41 class WebDevToolsAgentClient {
     42 public:
     43     virtual void sendMessageToInspectorFrontend(const WebString&) { }
     44     virtual void sendDebuggerOutput(const WebString&) { }
     45 
     46     // Returns the identifier of the entity hosting this agent.
     47     virtual int hostIdentifier() { return -1; }
     48 
     49     // Save the agent state in order to pass it later into WebDevToolsAgent::reattach
     50     // if the same client is reattached to another agent.
     51     virtual void saveAgentRuntimeState(const WebString&) { }
     52 
     53     class WebKitClientMessageLoop {
     54     public:
     55         virtual ~WebKitClientMessageLoop() { }
     56         virtual void run() = 0;
     57         virtual void quitNow() = 0;
     58     };
     59     virtual WebKitClientMessageLoop* createClientMessageLoop() { return 0; }
     60 
     61     virtual void clearBrowserCache() { }
     62     virtual void clearBrowserCookies() { }
     63 
     64     class AllocatedObjectVisitor {
     65     public:
     66         virtual bool visitObject(const void* ptr) = 0;
     67     protected:
     68         virtual ~AllocatedObjectVisitor() { }
     69     };
     70     virtual void visitAllocatedObjects(AllocatedObjectVisitor*) { }
     71 
     72     class InstrumentedObjectSizeProvider {
     73     public:
     74         virtual size_t objectSize(const void* ptr) const = 0;
     75     protected:
     76         virtual ~InstrumentedObjectSizeProvider() { }
     77     };
     78     virtual void dumpUncountedAllocatedObjects(const InstrumentedObjectSizeProvider*) { }
     79 
     80     typedef void (*TraceEventCallback)(char phase, const unsigned char*, const char* name, unsigned long long id,
     81         int numArgs, const char* const* argNames, const unsigned char* argTypes, const unsigned long long* argValues,
     82         unsigned char flags);
     83 
     84     virtual void setTraceEventCallback(TraceEventCallback) { }
     85 
     86 protected:
     87     ~WebDevToolsAgentClient() { }
     88 };
     89 
     90 } // namespace WebKit
     91 
     92 #endif
     93