1/*
2 * Copyright (C) 2007 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 COMPUTER, 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 COMPUTER, 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 ProgressTracker_h
27#define ProgressTracker_h
28
29#include "Timer.h"
30#include <wtf/Forward.h>
31#include <wtf/HashMap.h>
32#include <wtf/Noncopyable.h>
33#include <wtf/OwnPtr.h>
34#include <wtf/RefPtr.h>
35
36namespace WebCore {
37
38class Frame;
39class ResourceResponse;
40struct ProgressItem;
41
42class ProgressTracker {
43    WTF_MAKE_NONCOPYABLE(ProgressTracker); WTF_MAKE_FAST_ALLOCATED;
44public:
45    ~ProgressTracker();
46
47    static PassOwnPtr<ProgressTracker> create();
48    static unsigned long createUniqueIdentifier();
49
50    double estimatedProgress() const;
51
52    void progressStarted(Frame*);
53    void progressCompleted(Frame*);
54
55    void incrementProgress(unsigned long identifier, const ResourceResponse&);
56    void incrementProgress(unsigned long identifier, const char*, int);
57    void completeProgress(unsigned long identifier);
58
59    long long totalPageAndResourceBytesToLoad() const { return m_totalPageAndResourceBytesToLoad; }
60    long long totalBytesReceived() const { return m_totalBytesReceived; }
61
62    bool isMainLoadProgressing() const;
63
64private:
65    ProgressTracker();
66
67    void reset();
68    void finalProgressComplete();
69
70    void progressHeartbeatTimerFired(Timer<ProgressTracker>*);
71
72    static unsigned long s_uniqueIdentifier;
73
74    long long m_totalPageAndResourceBytesToLoad;
75    long long m_totalBytesReceived;
76    double m_lastNotifiedProgressValue;
77    double m_lastNotifiedProgressTime;
78    double m_progressNotificationInterval;
79    double m_progressNotificationTimeInterval;
80    bool m_finalProgressChangedSent;
81    double m_progressValue;
82    RefPtr<Frame> m_originatingProgressFrame;
83
84    int m_numProgressTrackedFrames;
85    HashMap<unsigned long, OwnPtr<ProgressItem> > m_progressItems;
86
87    Timer<ProgressTracker> m_progressHeartbeatTimer;
88    unsigned m_heartbeatsWithNoProgress;
89    long long m_totalBytesReceivedBeforePreviousHeartbeat;
90};
91
92}
93
94#endif
95