WebCore/inspector/InspectorProfilerAgent.h

   1 /*
   2  * Copyright (C) 2010 Apple Inc. All rights reserved.
   3  * Copyright (C) 2010 Google Inc. All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * 1.  Redistributions of source code must retain the above copyright
  10  *     notice, this list of conditions and the following disclaimer.
  11  * 2.  Redistributions in binary form must reproduce the above copyright
  12  *     notice, this list of conditions and the following disclaimer in the
  13  *     documentation and/or other materials provided with the distribution.
  14  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
  15  *     its contributors may be used to endorse or promote products derived
  16  *     from this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
  19  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  20  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  21  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  22  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  23  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  24  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  25  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  */
  29
  30 #ifndef InspectorProfilerAgent_h
  31 #define InspectorProfilerAgent_h
  32
  33 #if ENABLE(JAVASCRIPT_DEBUGGER)
  34
  35 #include "PlatformString.h"
  36 #include <wtf/Forward.h>
  37 #include <wtf/HashMap.h>
  38 #include <wtf/Noncopyable.h>
  39 #include <wtf/PassOwnPtr.h>
  40
  41 namespace WebCore {
  42
  43 class InspectorArray;
  44 class InspectorController;
  45 class InspectorFrontend;
  46 class InspectorObject;
  47 class ScriptHeapSnapshot;
  48 class ScriptProfile;
  49
  50 class InspectorProfilerAgent : public Noncopyable {
  51 public:
  52     static PassOwnPtr<InspectorProfilerAgent> create(InspectorController*);
  53     virtual ~InspectorProfilerAgent();
  54
  55     void addProfile(PassRefPtr<ScriptProfile> prpProfile, unsigned lineNumber, const String& sourceURL);
  56     void addProfileFinishedMessageToConsole(PassRefPtr<ScriptProfile>, unsigned lineNumber, const String& sourceURL);
  57     void addStartProfilingMessageToConsole(const String& title, unsigned lineNumber, const String& sourceURL);
  58     void clearProfiles() { resetState(); }
  59     void disable();
  60     void enable(bool skipRecompile);
  61     bool enabled() { return m_enabled; }
  62     String getCurrentUserInitiatedProfileName(bool incrementProfileNumber = false);
  63     void getProfileHeaders(RefPtr<InspectorArray>* headers);
  64     void getProfile(const String& type, unsigned uid, RefPtr<InspectorObject>* profileObject);
  65     bool isRecordingUserInitiatedProfile() { return m_recordingUserInitiatedProfile; }
  66     void removeProfile(const String& type, unsigned uid);
  67     void resetState();
  68     void setFrontend(InspectorFrontend* frontend) { m_frontend = frontend; }
  69     void startUserInitiatedProfiling();
  70     void stopUserInitiatedProfiling(bool ignoreProfile = false);
  71     void takeHeapSnapshot();
  72     void toggleRecordButton(bool isProfiling);
  73
  74 private:
  75     typedef HashMap<unsigned int, RefPtr<ScriptProfile> > ProfilesMap;
  76     typedef HashMap<unsigned int, RefPtr<ScriptHeapSnapshot> > HeapSnapshotsMap;
  77
  78     InspectorProfilerAgent(InspectorController*);
  79     PassRefPtr<InspectorObject> createProfileHeader(const ScriptProfile& profile);
  80     PassRefPtr<InspectorObject> createSnapshotHeader(const ScriptHeapSnapshot& snapshot);
  81
  82     InspectorController* m_inspectorController;
  83     InspectorFrontend* m_frontend;
  84     bool m_enabled;
  85     bool m_recordingUserInitiatedProfile;
  86     int m_currentUserInitiatedProfileNumber;
  87     unsigned m_nextUserInitiatedProfileNumber;
  88     unsigned m_nextUserInitiatedHeapSnapshotNumber;
  89     ProfilesMap m_profiles;
  90     HeapSnapshotsMap m_snapshots;
  91 };
  92
  93 } // namespace WebCore
  94
  95 #endif // ENABLE(JAVASCRIPT_DEBUGGER)
  96
  97 #endif // !defined(InspectorProfilerAgent_h)