2008-05-13 Kevin McCullough <kmccullough@apple.com>
[WebKit-https.git] / JavaScriptCore / profiler / FunctionCallProfile.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 FunctionCallProfile_h
30 #define FunctionCallProfile_h
31
32 #include <kjs/ustring.h>
33 #include <wtf/Deque.h>
34 #include <wtf/RefCounted.h>
35 #include <wtf/RefPtr.h>
36 #include <wtf/StrHash.h>
37
38 namespace KJS {
39
40     class FunctionCallProfile;
41
42     typedef Deque<RefPtr<FunctionCallProfile> >::const_iterator StackIterator;
43     typedef HashCountedSet<UString::Rep*> FunctionCallHashCount;
44
45     class FunctionCallProfile : public RefCounted<FunctionCallProfile> {
46     public:
47         static PassRefPtr<FunctionCallProfile> create(const UString& name) { return adoptRef(new FunctionCallProfile(name)); }
48
49         void willExecute();
50         void didExecute(Vector<UString> stackNames, unsigned int stackIndex);
51
52         void addChild(PassRefPtr<FunctionCallProfile> prpChild);
53         FunctionCallProfile* findChild(const UString& name);
54
55         void stopProfiling();
56
57         UString functionName() const { return m_functionName; }
58         double milliSecs() const { return m_timeSum; }
59         unsigned numberOfCalls() const { return m_numberOfCalls; }
60         const Deque<RefPtr<FunctionCallProfile> >& children() { return m_children; }
61
62         void printDataInspectorStyle(int indentLevel) const;
63         double printDataSampleStyle(int indentLevel, FunctionCallHashCount&) const;
64
65     private:
66         FunctionCallProfile(const UString& name);
67
68         void endAndRecordCall();
69     
70         UString m_functionName;
71         double m_timeSum;
72         double m_startTime;
73         unsigned m_numberOfCalls;
74
75         Deque<RefPtr<FunctionCallProfile> > m_children;
76     };
77
78 } // namespace KJS
79
80 #endif // FunctionCallProfile_h