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
  39 class WebString;
  40 struct WebDeviceEmulationParams;
  41 struct WebDevToolsMessageData;
  42 struct WebRect;
  43 struct WebSize;
  44
  45 class WebDevToolsAgentClient {
  46 public:
  47     virtual void sendMessageToInspectorFrontend(const WebString&) { }
  48     virtual void sendDebuggerOutput(const WebString&) { }
  49
  50     // Returns process id.
  51     virtual long processId() { return -1; }
  52
  53     // Returns unique identifier of the entity within process.
  54     virtual int debuggerId() { return -1; }
  55
  56     // Save the agent state in order to pass it later into WebDevToolsAgent::reattach
  57     // if the same client is reattached to another agent.
  58     virtual void saveAgentRuntimeState(const WebString&) { }
  59
  60     class WebKitClientMessageLoop {
  61     public:
  62         virtual ~WebKitClientMessageLoop() { }
  63         virtual void run() = 0;
  64         virtual void quitNow() = 0;
  65     };
  66     virtual WebKitClientMessageLoop* createClientMessageLoop() { return 0; }
  67     virtual void willEnterDebugLoop() { }
  68     virtual void didExitDebugLoop() { }
  69
  70     class AllocatedObjectVisitor {
  71     public:
  72         virtual bool visitObject(const void* ptr) = 0;
  73     protected:
  74         virtual ~AllocatedObjectVisitor() { }
  75     };
  76     virtual void visitAllocatedObjects(AllocatedObjectVisitor*) { }
  77
  78     class InstrumentedObjectSizeProvider {
  79     public:
  80         virtual size_t objectSize(const void* ptr) const = 0;
  81     protected:
  82         virtual ~InstrumentedObjectSizeProvider() { }
  83     };
  84     virtual void dumpUncountedAllocatedObjects(const InstrumentedObjectSizeProvider*) { }
  85
  86     typedef void (*TraceEventCallback)(char phase, const unsigned char*, const char* name, unsigned long long id,
  87         int numArgs, const char* const* argNames, const unsigned char* argTypes, const unsigned long long* argValues,
  88         unsigned char flags, double timestamp);
  89
  90     virtual void setTraceEventCallback(const WebString& categoryFilter, TraceEventCallback) { }
  91     virtual void resetTraceEventCallback() { }
  92     virtual void enableTracing(const WebString& categoryFilter) { }
  93     virtual void disableTracing() { }
  94
  95     virtual void startGPUEventsRecording() { }
  96     virtual void stopGPUEventsRecording() { }
  97
  98     // Enables device emulation as specified in params.
  99     virtual void enableDeviceEmulation(const WebDeviceEmulationParams& params) { }
 100
 101     // Cancel emulation started via |enableDeviceEmulation| call.
 102     virtual void disableDeviceEmulation() { }
 103
 104     virtual void setTouchEventEmulationEnabled(bool enabled, bool allowPinch) { }
 105
 106 protected:
 107     ~WebDevToolsAgentClient() { }
 108 };
 109
 110 } // namespace blink
 111
 112 #endif