src/third_party/WebKit/Source/core/timing/Performance.h

   1 /*
   2  * Copyright (C) 2010 Google Inc. All rights reserved.
   3  * Copyright (C) 2012 Intel 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 are
   7  * met:
   8  *
   9  *     * Redistributions of source code must retain the above copyright
  10  * notice, this list of conditions and the following disclaimer.
  11  *     * Redistributions in binary form must reproduce the above
  12  * copyright notice, this list of conditions and the following disclaimer
  13  * in the documentation and/or other materials provided with the
  14  * distribution.
  15  *     * Neither the name of Google Inc. nor the names of its
  16  * contributors may be used to endorse or promote products derived from
  17  * this software without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  22  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  23  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  29  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30  */
  31
  32 #ifndef Performance_h
  33 #define Performance_h
  34
  35 #include "bindings/v8/ScriptWrappable.h"
  36 #include "core/events/EventTarget.h"
  37 #include "core/frame/DOMWindowProperty.h"
  38 #include "core/timing/MemoryInfo.h"
  39 #include "core/timing/PerformanceEntry.h"
  40 #include "core/timing/PerformanceNavigation.h"
  41 #include "core/timing/PerformanceTiming.h"
  42 #include "platform/heap/Handle.h"
  43 #include "wtf/PassRefPtr.h"
  44 #include "wtf/RefCounted.h"
  45 #include "wtf/RefPtr.h"
  46 #include "wtf/text/WTFString.h"
  47
  48 namespace WebCore {
  49
  50 class Document;
  51 class ExceptionState;
  52 class ResourceRequest;
  53 class ResourceResponse;
  54 class ResourceTimingInfo;
  55 class UserTiming;
  56
  57 typedef WillBeHeapVector<RefPtrWillBeMember<PerformanceEntry> > PerformanceEntryVector;
  58
  59 class Performance FINAL : public RefCountedWillBeRefCountedGarbageCollected<Performance>, public ScriptWrappable, public DOMWindowProperty, public EventTargetWithInlineData {
  60     DEFINE_EVENT_TARGET_REFCOUNTING(RefCountedWillBeRefCountedGarbageCollected<Performance>);
  61 public:
  62     static PassRefPtrWillBeRawPtr<Performance> create(LocalFrame* frame)
  63     {
  64         return adoptRefWillBeRefCountedGarbageCollected(new Performance(frame));
  65     }
  66     virtual ~Performance();
  67
  68     virtual const AtomicString& interfaceName() const OVERRIDE;
  69     virtual ExecutionContext* executionContext() const OVERRIDE;
  70
  71     PassRefPtrWillBeRawPtr<MemoryInfo> memory() const;
  72     PerformanceNavigation* navigation() const;
  73     PerformanceTiming* timing() const;
  74     double now() const;
  75
  76     PerformanceEntryVector getEntries() const;
  77     PerformanceEntryVector getEntriesByType(const String& entryType);
  78     PerformanceEntryVector getEntriesByName(const String& name, const String& entryType);
  79
  80     void webkitClearResourceTimings();
  81     void webkitSetResourceTimingBufferSize(unsigned);
  82
  83     DEFINE_ATTRIBUTE_EVENT_LISTENER(webkitresourcetimingbufferfull);
  84
  85     void addResourceTiming(const ResourceTimingInfo&, Document*);
  86
  87     void mark(const String& markName, ExceptionState&);
  88     void clearMarks(const String& markName);
  89
  90     void measure(const String& measureName, const String& startMark, const String& endMark, ExceptionState&);
  91     void clearMeasures(const String& measureName);
  92
  93     void trace(Visitor*);
  94
  95 private:
  96     explicit Performance(LocalFrame*);
  97
  98     bool isResourceTimingBufferFull();
  99     void addResourceTimingBuffer(PassRefPtrWillBeRawPtr<PerformanceEntry>);
 100
 101     mutable RefPtrWillBeMember<PerformanceNavigation> m_navigation;
 102     mutable RefPtrWillBeMember<PerformanceTiming> m_timing;
 103
 104     PerformanceEntryVector m_resourceTimingBuffer;
 105     unsigned m_resourceTimingBufferSize;
 106     double m_referenceTime;
 107
 108     RefPtrWillBeMember<UserTiming> m_userTiming;
 109 };
 110
 111 }
 112
 113 #endif // Performance_h