2008-04-18 Kevin McCullough <kmccullough@apple.com>
[WebKit-https.git] / JavaScriptCore / profiler / Profiler.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 Profiler_h
30 #define Profiler_h
31
32 #include "FunctionCallProfile.h"
33 #include <wtf/OwnPtr.h>
34
35 namespace KJS {
36
37     class ExecState;
38     class FunctionImp;
39     class JSObject;
40
41     class Profiler {
42         typedef Vector<UString>::const_iterator NameIterator;
43
44     public:
45         static Profiler* profiler();
46         static void debugLog(UString);
47
48         void startProfiling();
49         void stopProfiling();
50         void willExecute(ExecState*, JSObject* calledFunction);
51         void willExecute(ExecState*, const UString& sourceURL, int startingLineNumber);
52         void didExecute(ExecState*, JSObject* calledFunction);
53         void didExecute(ExecState*, const UString& sourceURL, int startingLineNumber);
54
55         void printDataInspectorStyle() const;
56         void printDataSampleStyle() const;
57
58     private:
59         Profiler()
60             : m_profiling(false)
61         {
62         }
63
64         void insertStackNamesInTree(const Vector<UString>& callStackNames);
65
66         bool m_profiling;
67
68         // FIXME: Make this a vector of FunctionCallProfiles where each one is the
69         // root of a new thread.
70         OwnPtr<FunctionCallProfile> m_callTree;
71     };
72
73 } // namespace KJS
74
75 #endif // Profiler_h