src/third_party/WebKit/public/web/WebDevToolsAgentClient.h

   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 WebDeviceEmulationParams;
  40 struct WebDevToolsMessageData;
  41 struct WebRect;
  42 struct WebSize;
  43
  44 class WebDevToolsAgentClient {
  45 public:
  46     virtual void sendMessageToInspectorFrontend(const WebString&) { }
  47     virtual void sendDebuggerOutput(const WebString&) { }
  48
  49     // Returns the identifier of the entity hosting this agent.
  50     virtual int hostIdentifier() { return -1; }
  51
  52     // Save the agent state in order to pass it later into WebDevToolsAgent::reattach
  53     // if the same client is reattached to another agent.
  54     virtual void saveAgentRuntimeState(const WebString&) { }
  55
  56     class WebKitClientMessageLoop {
  57     public:
  58         virtual ~WebKitClientMessageLoop() { }
  59         virtual void run() = 0;
  60         virtual void quitNow() = 0;
  61     };
  62     virtual WebKitClientMessageLoop* createClientMessageLoop() { return 0; }
  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, double timestamp);
  83
  84     virtual void setTraceEventCallback(const WebString& categoryFilter, TraceEventCallback) { }
  85     virtual void resetTraceEventCallback() { }
  86     virtual void enableTracing(const WebString& categoryFilter) { }
  87     virtual void disableTracing() { }
  88
  89     virtual void startGPUEventsRecording() { }
  90     virtual void stopGPUEventsRecording() { }
  91
  92     // Enables device emulation as specified in params.
  93     virtual void enableDeviceEmulation(const WebDeviceEmulationParams& params) { }
  94
  95     // Cancel emulation started via |enableDeviceEmulation| call.
  96     virtual void disableDeviceEmulation() { }
  97
  98     virtual void setTouchEventEmulationEnabled(bool enabled, bool allowPinch) { }
  99
 100 protected:
 101     ~WebDevToolsAgentClient() { }
 102 };
 103
 104 } // namespace blink
 105
 106 #endif