Home | History | Annotate | Download | only in timing
      1 /*
      2  * Copyright (C) 2012 Intel 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 PerformanceUserTiming_h
     27 #define PerformanceUserTiming_h
     28 
     29 #include "core/timing/Performance.h"
     30 #include "core/timing/PerformanceTiming.h"
     31 #include "platform/heap/Handle.h"
     32 #include "wtf/HashMap.h"
     33 #include "wtf/PassRefPtr.h"
     34 #include "wtf/RefCounted.h"
     35 #include "wtf/text/StringHash.h"
     36 #include "wtf/text/WTFString.h"
     37 
     38 namespace blink {
     39 
     40 class ExceptionState;
     41 class Performance;
     42 class PerformanceEntry;
     43 
     44 typedef unsigned long long (PerformanceTiming::*NavigationTimingFunction)() const;
     45 typedef WillBeHeapHashMap<String, PerformanceEntryVector> PerformanceEntryMap;
     46 
     47 class UserTiming : public RefCountedWillBeGarbageCollected<UserTiming> {
     48 public:
     49     static PassRefPtrWillBeRawPtr<UserTiming> create(Performance* performance)
     50     {
     51         return adoptRefWillBeNoop(new UserTiming(performance));
     52     }
     53 
     54     void mark(const String& markName, ExceptionState&);
     55     void clearMarks(const String& markName);
     56 
     57     void measure(const String& measureName, const String& startMark, const String& endMark, ExceptionState&);
     58     void clearMeasures(const String& measureName);
     59 
     60     PerformanceEntryVector getMarks() const;
     61     PerformanceEntryVector getMeasures() const;
     62 
     63     PerformanceEntryVector getMarks(const String& name) const;
     64     PerformanceEntryVector getMeasures(const String& name) const;
     65 
     66     void trace(Visitor*);
     67 
     68 private:
     69     explicit UserTiming(Performance*);
     70 
     71     double findExistingMarkStartTime(const String& markName, ExceptionState&);
     72     RawPtrWillBeMember<Performance> m_performance;
     73     PerformanceEntryMap m_marksMap;
     74     PerformanceEntryMap m_measuresMap;
     75 };
     76 
     77 }
     78 
     79 #endif // !defined(PerformanceUserTiming_h)
     80