Source/WebCore/bindings/v8/ScriptDebugServer.h

   1 /*
   2  * Copyright (c) 2010, 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 ScriptDebugServer_h
  32 #define ScriptDebugServer_h
  33
  34 #if ENABLE(JAVASCRIPT_DEBUGGER)
  35
  36 #include "OwnHandle.h"
  37 #include "PlatformString.h"
  38 #include "ScriptBreakpoint.h"
  39 #include "Timer.h"
  40 #include <v8-debug.h>
  41 #include <wtf/HashMap.h>
  42 #include <wtf/Noncopyable.h>
  43 #include <wtf/PassOwnPtr.h>
  44 #include <wtf/text/StringHash.h>
  45
  46 namespace WebCore {
  47
  48 class ScriptDebugListener;
  49 class ScriptObject;
  50 class ScriptValue;
  51
  52 class ScriptDebugServer {
  53     WTF_MAKE_NONCOPYABLE(ScriptDebugServer);
  54 public:
  55     String setBreakpoint(const String& sourceID, const ScriptBreakpoint&, int* actualLineNumber, int* actualColumnNumber);
  56     void removeBreakpoint(const String& breakpointId);
  57     void clearBreakpoints();
  58     void setBreakpointsActivated(bool activated);
  59     void activateBreakpoints() { setBreakpointsActivated(true); }
  60     void deactivateBreakpoints() { setBreakpointsActivated(false); }
  61
  62     enum PauseOnExceptionsState {
  63         DontPauseOnExceptions,
  64         PauseOnAllExceptions,
  65         PauseOnUncaughtExceptions
  66     };
  67     PauseOnExceptionsState pauseOnExceptionsState();
  68     void setPauseOnExceptionsState(PauseOnExceptionsState pauseOnExceptionsState);
  69
  70     void setPauseOnNextStatement(bool pause);
  71     void breakProgram();
  72     void continueProgram();
  73     void stepIntoStatement();
  74     void stepOverStatement();
  75     void stepOutOfFunction();
  76
  77     bool setScriptSource(const String& sourceID, const String& newContent, bool preview, String* error, ScriptValue* newCallFrames, ScriptObject* result);
  78
  79     void recompileAllJSFunctionsSoon() { }
  80     void recompileAllJSFunctions(Timer<ScriptDebugServer>* = 0) { }
  81
  82     class Task {
  83     public:
  84         virtual ~Task() { }
  85         virtual void run() = 0;
  86     };
  87     static void interruptAndRun(PassOwnPtr<Task>);
  88     void runPendingTasks();
  89
  90 protected:
  91     ScriptDebugServer();
  92     ~ScriptDebugServer() { }
  93
  94     ScriptValue currentCallFrame();
  95
  96     virtual ScriptDebugListener* getDebugListenerForContext(v8::Handle<v8::Context>) = 0;
  97     virtual void runMessageLoopOnPause(v8::Handle<v8::Context>) = 0;
  98     virtual void quitMessageLoopOnPause() = 0;
  99
 100     static v8::Handle<v8::Value> breakProgramCallback(const v8::Arguments& args);
 101     void breakProgram(v8::Handle<v8::Object> executionState, v8::Handle<v8::Value> exception);
 102
 103     static void v8DebugEventCallback(const v8::Debug::EventDetails& eventDetails);
 104     void handleV8DebugEvent(const v8::Debug::EventDetails& eventDetails);
 105
 106     void dispatchDidParseSource(ScriptDebugListener* listener, v8::Handle<v8::Object> sourceObject);
 107
 108     void ensureDebuggerScriptCompiled();
 109
 110     bool isPaused();
 111
 112     PauseOnExceptionsState m_pauseOnExceptionsState;
 113     OwnHandle<v8::Object> m_debuggerScript;
 114     OwnHandle<v8::Object> m_executionState;
 115     v8::Local<v8::Context> m_pausedContext;
 116
 117     bool m_breakpointsActivated;
 118     OwnHandle<v8::FunctionTemplate> m_breakProgramCallbackTemplate;
 119 };
 120
 121 } // namespace WebCore
 122
 123 #endif // ENABLE(JAVASCRIPT_DEBUGGER)
 124
 125 #endif // ScriptDebugServer_h