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 #include "../platform/WebString.h"
  37
  38 namespace blink {
  39
  40 class WebString;
  41 struct WebDeviceEmulationParams;
  42
  43 class WebDevToolsAgentClient {
  44 public:
  45     // Sends response message over the protocol, update agent state on the browser side for
  46     // potential re-attach. |callId| for notifications is 0, |state| for notifications is empty.
  47     virtual void sendProtocolMessage(int callId, const WebString& response, const WebString& state) { }
  48
  49     // Returns process id.
  50     virtual long processId() { return -1; }
  51
  52     // Returns unique identifier of the entity within process.
  53     virtual int debuggerId() { return -1; }
  54
  55     // Resume the inspected renderer that is waiting for DevTools front-end to initialize its state.
  56     virtual void resumeStartup() { }
  57
  58     class WebKitClientMessageLoop {
  59     public:
  60         virtual ~WebKitClientMessageLoop() { }
  61         virtual void run() = 0;
  62         virtual void quitNow() = 0;
  63     };
  64     virtual WebKitClientMessageLoop* createClientMessageLoop() { return 0; }
  65     virtual void willEnterDebugLoop() { }
  66     virtual void didExitDebugLoop() { }
  67
  68     virtual void enableTracing(const WebString& categoryFilter) { }
  69     virtual void disableTracing() { }
  70
  71 protected:
  72     ~WebDevToolsAgentClient() { }
  73 };
  74
  75 } // namespace blink
  76
  77 #endif