WebCore/inspector/JavaScriptDebugServer.h

   1 /*
   2  * Copyright (C) 2008 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  *
   8  * 1.  Redistributions of source code must retain the above copyright
   9  *     notice, this list of conditions and the following disclaimer.
  10  * 2.  Redistributions in binary form must reproduce the above copyright
  11  *     notice, this list of conditions and the following disclaimer in the
  12  *     documentation and/or other materials provided with the distribution.
  13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
  14  *     its contributors may be used to endorse or promote products derived
  15  *     from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
  18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 #ifndef JavaScriptDebugServer_h
  30 #define JavaScriptDebugServer_h
  31
  32 #include <kjs/debugger.h>
  33
  34 #include <wtf/HashMap.h>
  35 #include <wtf/HashSet.h>
  36 #include <wtf/RefPtr.h>
  37
  38 namespace JSC {
  39     class DebuggerCallFrame;
  40 }
  41
  42 namespace WebCore {
  43
  44     class Frame;
  45     class FrameView;
  46     class Page;
  47     class PageGroup;
  48     class PausedTimeouts;
  49     class JavaScriptCallFrame;
  50     class JavaScriptDebugListener;
  51
  52     class JavaScriptDebugServer : JSC::Debugger {
  53     public:
  54         static JavaScriptDebugServer& shared();
  55
  56         void addListener(JavaScriptDebugListener*);
  57         void removeListener(JavaScriptDebugListener*);
  58
  59         void addListener(JavaScriptDebugListener*, Page*);
  60         void removeListener(JavaScriptDebugListener*, Page*);
  61
  62         void addBreakpoint(intptr_t sourceID, unsigned lineNumber);
  63         void removeBreakpoint(intptr_t sourceID, unsigned lineNumber);
  64         bool hasBreakpoint(intptr_t sourceID, unsigned lineNumber) const;
  65         void clearBreakpoints();
  66
  67         bool pauseOnExceptions() const { return m_pauseOnExceptions; }
  68         void setPauseOnExceptions(bool);
  69
  70         void pauseProgram();
  71         void continueProgram();
  72         void stepIntoStatement();
  73         void stepOverStatement();
  74         void stepOutOfFunction();
  75
  76         JavaScriptCallFrame* currentCallFrame();
  77
  78         void pageCreated(Page*);
  79
  80         typedef HashSet<JavaScriptDebugListener*> ListenerSet;
  81         typedef void (JavaScriptDebugListener::*JavaScriptExecutionCallback)();
  82
  83     private:
  84         JavaScriptDebugServer();
  85         ~JavaScriptDebugServer();
  86
  87         bool hasListeners() const { return !m_listeners.isEmpty() || !m_pageListenersMap.isEmpty(); }
  88         bool hasListenersInterestedInPage(Page*);
  89
  90         void setJavaScriptPaused(const PageGroup&, bool paused);
  91         void setJavaScriptPaused(Page*, bool paused);
  92         void setJavaScriptPaused(Frame*, bool paused);
  93         void setJavaScriptPaused(FrameView*, bool paused);
  94
  95         void dispatchFunctionToListeners(JavaScriptExecutionCallback, Page*);
  96         void pauseIfNeeded(Page*);
  97
  98         virtual void sourceParsed(JSC::ExecState*, const JSC::SourceCode&, int errorLine, const JSC::UString& errorMsg);
  99         virtual void callEvent(const JSC::DebuggerCallFrame&, intptr_t sourceID, int lineNumber);
 100         virtual void atStatement(const JSC::DebuggerCallFrame&, intptr_t sourceID, int firstLine);
 101         virtual void returnEvent(const JSC::DebuggerCallFrame&, intptr_t sourceID, int lineNumber);
 102         virtual void exception(const JSC::DebuggerCallFrame&, intptr_t sourceID, int lineNumber);
 103         virtual void willExecuteProgram(const JSC::DebuggerCallFrame&, intptr_t sourceID, int lineno);
 104         virtual void didExecuteProgram(const JSC::DebuggerCallFrame&, intptr_t sourceID, int lineno);
 105         virtual void didReachBreakpoint(const JSC::DebuggerCallFrame&, intptr_t sourceID, int lineno);
 106
 107         typedef HashMap<Page*, ListenerSet*> PageListenersMap;
 108         PageListenersMap m_pageListenersMap;
 109         ListenerSet m_listeners;
 110         bool m_callingListeners;
 111         bool m_pauseOnExceptions;
 112         bool m_pauseOnNextStatement;
 113         bool m_paused;
 114         bool m_doneProcessingDebuggerEvents;
 115         JavaScriptCallFrame* m_pauseOnCallFrame;
 116         RefPtr<JavaScriptCallFrame> m_currentCallFrame;
 117         HashMap<RefPtr<Frame>, PausedTimeouts*> m_pausedTimeouts;
 118         HashMap<intptr_t, HashSet<unsigned>*> m_breakpoints;
 119     };
 120
 121 } // namespace WebCore
 122
 123 #endif // JavaScriptDebugServer_h