inspector/remote/RemoteInspectorDebuggable.h

   1 /*
   2  * Copyright (C) 2013 Apple 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
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
  14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
  17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #if ENABLE(REMOTE_INSPECTOR)
  27
  28 #ifndef RemoteInspectorDebuggable_h
  29 #define RemoteInspectorDebuggable_h
  30
  31 #include <CoreFoundation/CFRunLoop.h>
  32 #include <wtf/RetainPtr.h>
  33 #include <wtf/text/WTFString.h>
  34
  35 namespace Inspector {
  36
  37 class FrontendChannel;
  38
  39 struct RemoteInspectorDebuggableInfo;
  40
  41 class JS_EXPORT_PRIVATE RemoteInspectorDebuggable {
  42 public:
  43     RemoteInspectorDebuggable();
  44     virtual ~RemoteInspectorDebuggable();
  45
  46     void init();
  47     void update();
  48
  49     unsigned identifier() const { return m_identifier; }
  50     void setIdentifier(unsigned identifier) { m_identifier = identifier; }
  51
  52     bool remoteDebuggingAllowed() const { return m_allowed; }
  53     void setRemoteDebuggingAllowed(bool);
  54
  55     CFRunLoopRef debuggerRunLoop() { return m_runLoop.get(); }
  56     void setDebuggerRunLoop(CFRunLoopRef runLoop) { m_runLoop = runLoop; }
  57
  58     RemoteInspectorDebuggableInfo info() const;
  59
  60     enum DebuggableType { JavaScript, Web };
  61     virtual DebuggableType type() const = 0;
  62     virtual String name() const { return String(); } // JavaScript and Web
  63     virtual String url() const { return String(); } // Web
  64     virtual bool hasLocalDebugger() const = 0;
  65
  66     virtual void connect(FrontendChannel*, bool isAutomaticInspection) = 0;
  67     virtual void disconnect() = 0;
  68     virtual void dispatchMessageFromRemoteFrontend(const String& message) = 0;
  69     virtual void setIndicating(bool) { } // Default is to do nothing.
  70     virtual void pause() { };
  71
  72     virtual bool automaticInspectionAllowed() const { return false; }
  73     virtual void pauseWaitingForAutomaticInspection();
  74     virtual void unpauseForInitializedInspector();
  75
  76 private:
  77     unsigned m_identifier;
  78     bool m_allowed;
  79     RetainPtr<CFRunLoopRef> m_runLoop;
  80 };
  81
  82 struct RemoteInspectorDebuggableInfo {
  83     RemoteInspectorDebuggableInfo()
  84         : identifier(0)
  85         , type(RemoteInspectorDebuggable::JavaScript)
  86         , hasLocalDebugger(false)
  87         , remoteDebuggingAllowed(false)
  88     {
  89     }
  90
  91     unsigned identifier;
  92     RemoteInspectorDebuggable::DebuggableType type;
  93     String name;
  94     String url;
  95     bool hasLocalDebugger;
  96     bool remoteDebuggingAllowed;
  97 };
  98
  99 } // namespace Inspector
 100
 101 #endif // RemoteInspectorDebuggable_h
 102
 103 #endif // ENABLE(REMOTE_INSPECTOR)