src/third_party/WebKit/Source/bindings/core/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 #include "bindings/core/v8/ScopedPersistent.h"
  35 #include "core/InspectorBackendDispatcher.h"
  36 #include "core/inspector/ScriptBreakpoint.h"
  37 #include "core/inspector/ScriptCallStack.h"
  38 #include "core/inspector/ScriptDebugListener.h"
  39 #include "wtf/HashMap.h"
  40 #include "wtf/Noncopyable.h"
  41 #include "wtf/PassOwnPtr.h"
  42 #include "wtf/text/StringHash.h"
  43 #include "wtf/text/WTFString.h"
  44 #include <v8-debug.h>
  45 #include <v8.h>
  46
  47 namespace blink {
  48
  49 class ScriptState;
  50 class ScriptController;
  51 class ScriptDebugListener;
  52 class ScriptSourceCode;
  53 class ScriptValue;
  54 class JavaScriptCallFrame;
  55
  56 class ScriptDebugServer {
  57     WTF_MAKE_NONCOPYABLE(ScriptDebugServer);
  58 public:
  59     String setBreakpoint(const String& sourceID, const ScriptBreakpoint&, int* actualLineNumber, int* actualColumnNumber, bool interstatementLocation);
  60     void removeBreakpoint(const String& breakpointId);
  61     void clearBreakpoints();
  62     void setBreakpointsActivated(bool activated);
  63
  64     enum PauseOnExceptionsState {
  65         DontPauseOnExceptions,
  66         PauseOnAllExceptions,
  67         PauseOnUncaughtExceptions
  68     };
  69     PauseOnExceptionsState pauseOnExceptionsState();
  70     void setPauseOnExceptionsState(PauseOnExceptionsState pauseOnExceptionsState);
  71
  72     void setPauseOnNextStatement(bool pause);
  73     bool pausingOnNextStatement();
  74     bool canBreakProgram();
  75     void breakProgram();
  76     void continueProgram();
  77     void stepIntoStatement();
  78     void stepOverStatement();
  79     void stepOutOfFunction();
  80
  81     bool setScriptSource(const String& sourceID, const String& newContent, bool preview, String* error, RefPtr<TypeBuilder::Debugger::SetScriptSourceError>&, ScriptValue* newCallFrames, RefPtr<JSONObject>* result);
  82     ScriptValue currentCallFrames();
  83     ScriptValue currentCallFramesForAsyncStack();
  84     PassRefPtrWillBeRawPtr<JavaScriptCallFrame> callFrameNoScopes(int index);
  85     int frameCount();
  86
  87     static PassRefPtrWillBeRawPtr<JavaScriptCallFrame> toJavaScriptCallFrameUnsafe(const ScriptValue&);
  88
  89     class Task {
  90     public:
  91         virtual ~Task() { }
  92         virtual void run() = 0;
  93     };
  94     static void interruptAndRun(PassOwnPtr<Task>, v8::Isolate*);
  95     void runPendingTasks();
  96
  97     bool isPaused();
  98     bool runningNestedMessageLoop() { return m_runningNestedMessageLoop; }
  99
 100     v8::Local<v8::Value> functionScopes(v8::Handle<v8::Function>);
 101     v8::Local<v8::Value> collectionEntries(v8::Handle<v8::Object>&);
 102     v8::Local<v8::Value> getInternalProperties(v8::Handle<v8::Object>&);
 103     v8::Handle<v8::Value> setFunctionVariableValue(v8::Handle<v8::Value> functionValue, int scopeNumber, const String& variableName, v8::Handle<v8::Value> newValue);
 104     v8::Local<v8::Value> callDebuggerMethod(const char* functionName, int argc, v8::Handle<v8::Value> argv[]);
 105
 106     virtual void compileScript(ScriptState*, const String& expression, const String& sourceURL, String* scriptId, String* exceptionDetailsText, int* lineNumber, int* columnNumber, RefPtrWillBeRawPtr<ScriptCallStack>* stackTrace);
 107     virtual void clearCompiledScripts();
 108     virtual void runScript(ScriptState*, const String& scriptId, ScriptValue* result, bool* wasThrown, String* exceptionDetailsText, int* lineNumber, int* columnNumber, RefPtrWillBeRawPtr<ScriptCallStack>* stackTrace);
 109     virtual void setPreprocessorSource(const String&) { }
 110     virtual void preprocessBeforeCompile(const v8::Debug::EventDetails&) { }
 111     virtual PassOwnPtr<ScriptSourceCode> preprocess(LocalFrame*, const ScriptSourceCode&);
 112     virtual String preprocessEventListener(LocalFrame*, const String& source, const String& url, const String& functionName);
 113     virtual void clearPreprocessor() { }
 114
 115     virtual void muteWarningsAndDeprecations() { }
 116     virtual void unmuteWarningsAndDeprecations() { }
 117
 118 protected:
 119     explicit ScriptDebugServer(v8::Isolate*);
 120     virtual ~ScriptDebugServer();
 121
 122     virtual ScriptDebugListener* getDebugListenerForContext(v8::Handle<v8::Context>) = 0;
 123     virtual void runMessageLoopOnPause(v8::Handle<v8::Context>) = 0;
 124     virtual void quitMessageLoopOnPause() = 0;
 125
 126     static void breakProgramCallback(const v8::FunctionCallbackInfo<v8::Value>&);
 127     void handleProgramBreak(ScriptState* pausedScriptState, v8::Handle<v8::Object> executionState, v8::Handle<v8::Value> exception, v8::Handle<v8::Array> hitBreakpoints);
 128
 129     static void v8DebugEventCallback(const v8::Debug::EventDetails& eventDetails);
 130     void handleV8DebugEvent(const v8::Debug::EventDetails& eventDetails);
 131
 132     void dispatchDidParseSource(ScriptDebugListener*, v8::Handle<v8::Object> sourceObject, CompileResult);
 133
 134     void ensureDebuggerScriptCompiled();
 135     void discardDebuggerScript();
 136
 137     PauseOnExceptionsState m_pauseOnExceptionsState;
 138     ScopedPersistent<v8::Object> m_debuggerScript;
 139     v8::Local<v8::Object> m_executionState;
 140     RefPtr<ScriptState> m_pausedScriptState;
 141     bool m_breakpointsActivated;
 142     ScopedPersistent<v8::FunctionTemplate> m_breakProgramCallbackTemplate;
 143     HashMap<String, OwnPtr<ScopedPersistent<v8::Script> > > m_compiledScripts;
 144     v8::Isolate* m_isolate;
 145
 146 private:
 147     enum ScopeInfoDetails {
 148         AllScopes,
 149         FastAsyncScopes,
 150         NoScopes // Should be the last option.
 151     };
 152
 153     ScriptValue currentCallFramesInner(ScopeInfoDetails);
 154
 155     PassRefPtrWillBeRawPtr<JavaScriptCallFrame> wrapCallFrames(int maximumLimit, ScopeInfoDetails);
 156
 157     void handleV8AsyncTaskEvent(ScriptDebugListener*, ScriptState* pausedScriptState, v8::Handle<v8::Object> executionState, v8::Handle<v8::Object> eventData);
 158
 159     void handleV8PromiseEvent(ScriptDebugListener*, ScriptState* pausedScriptState, v8::Handle<v8::Object> executionState, v8::Handle<v8::Object> eventData);
 160
 161     bool m_runningNestedMessageLoop;
 162 };
 163
 164 } // namespace blink
 165
 166
 167 #endif // ScriptDebugServer_h