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 blink {
     38 class WebString;
     39 struct WebDevToolsMessageData;
     40 struct WebRect;
     41 struct WebSize;
     42 
     43 class WebDevToolsAgentClient {
     44 public:
     45     virtual void sendMessageToInspectorFrontend(const WebString&) { }
     46     virtual void sendDebuggerOutput(const WebString&) { }
     47 
     48     // Returns the identifier of the entity hosting this agent.
     49     virtual int hostIdentifier() { return -1; }
     50 
     51     // Save the agent state in order to pass it later into WebDevToolsAgent::reattach
     52     // if the same client is reattached to another agent.
     53     virtual void saveAgentRuntimeState(const WebString&) { }
     54 
     55     class WebKitClientMessageLoop {
     56     public:
     57         virtual ~WebKitClientMessageLoop() { }
     58         virtual void run() = 0;
     59         virtual void quitNow() = 0;
     60     };
     61     virtual WebKitClientMessageLoop* createClientMessageLoop() { return 0; }
     62 
     63     virtual void clearBrowserCache() { }
     64     virtual void clearBrowserCookies() { }
     65 
     66     class AllocatedObjectVisitor {
     67     public:
     68         virtual bool visitObject(const void* ptr) = 0;
     69     protected:
     70         virtual ~AllocatedObjectVisitor() { }
     71     };
     72     virtual void visitAllocatedObjects(AllocatedObjectVisitor*) { }
     73 
     74     class InstrumentedObjectSizeProvider {
     75     public:
     76         virtual size_t objectSize(const void* ptr) const = 0;
     77     protected:
     78         virtual ~InstrumentedObjectSizeProvider() { }
     79     };
     80     virtual void dumpUncountedAllocatedObjects(const InstrumentedObjectSizeProvider*) { }
     81 
     82     typedef void (*TraceEventCallback)(char phase, const unsigned char*, const char* name, unsigned long long id,
     83         int numArgs, const char* const* argNames, const unsigned char* argTypes, const unsigned long long* argValues,
     84         unsigned char flags, double timestamp);
     85 
     86     virtual void setTraceEventCallback(TraceEventCallback) { }
     87 
     88     virtual void startGPUEventsRecording() { }
     89     virtual void stopGPUEventsRecording() { }
     90 
     91     // Called to emulate device dimensions, scale factor and input. Window should
     92     // occupy the whole device screen, while the view should be located at |viewRect|.
     93     // x-coordinate of |screenRect| defines the left and right gutters' width,
     94     // y-coordinate defines the top and bottom gutters' height.
     95     // With |fitToView| set, contents should be scaled down to fit into embedder window.
     96     // All sizes are measured in device independent pixels.
     97     virtual void enableDeviceEmulation(
     98         const WebRect& screenRect, const WebRect& viewRect,
     99         float deviceScaleFactor, bool fitToView) { }
    100 
    101     // Cancel emulation started via |enableDeviceEmulation| call.
    102     virtual void disableDeviceEmulation() { }
    103 
    104 protected:
    105     ~WebDevToolsAgentClient() { }
    106 };
    107 
    108 } // namespace blink
    109 
    110 #endif
    111