2011-03-18 Geoffrey Garen <ggaren@apple.com>
[WebKit-https.git] / Source / JavaScriptCore / profiler / ProfileGenerator.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  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25  
26 #ifndef ProfileGenerator_h
27 #define ProfileGenerator_h
28
29 #include "Profile.h"
30 #include <wtf/PassRefPtr.h>
31 #include <wtf/RefCounted.h>
32 #include <wtf/RefPtr.h>
33
34 namespace JSC {
35
36     class ExecState;
37     class JSGlobalObject;
38     class Profile;
39     class ProfileNode;
40     class UString;
41     struct CallIdentifier;    
42
43     class ProfileGenerator : public RefCounted<ProfileGenerator>  {
44     public:
45         static PassRefPtr<ProfileGenerator> create(ExecState*, const UString& title, unsigned uid);
46
47         // Members
48         const UString& title() const;
49         PassRefPtr<Profile> profile() const { return m_profile; }
50         JSGlobalObject* origin() const { return m_origin; }
51         unsigned profileGroup() const { return m_profileGroup; }
52
53         // Collecting
54         void willExecute(ExecState* callerCallFrame, const CallIdentifier&);
55         void didExecute(ExecState* callerCallFrame, const CallIdentifier&);
56
57         void exceptionUnwind(ExecState* handlerCallFrame, const CallIdentifier&);
58
59         // Stopping Profiling
60         void stopProfiling();
61
62         typedef void (ProfileGenerator::*ProfileFunction)(ExecState* callerOrHandlerCallFrame, const CallIdentifier& callIdentifier);
63
64     private:
65         ProfileGenerator(ExecState*, const UString& title, unsigned uid);
66         void addParentForConsoleStart(ExecState*);
67
68         void removeProfileStart();
69         void removeProfileEnd();
70
71         RefPtr<Profile> m_profile;
72         JSGlobalObject* m_origin;
73         unsigned m_profileGroup;
74         RefPtr<ProfileNode> m_head;
75         RefPtr<ProfileNode> m_currentNode;
76     };
77
78 } // namespace JSC
79
80 #endif // ProfileGenerator_h