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 "platform/heap/Handle.h"
30#include "wtf/FastAllocBase.h"
31#include "wtf/Forward.h"
32#include "wtf/HashMap.h"
33#include "wtf/Noncopyable.h"
34#include "wtf/OwnPtr.h"
35
36namespace blink {
37
38class LocalFrame;
39class ResourceResponse;
40struct ProgressItem;
41
42// FIXME: This is only used on Android. Android is the only Chrome
43// browser which shows a progress bar during loading.
44// We should find a better way for Android to get this data and remove this!
45class ProgressTracker FINAL : public NoBaseWillBeGarbageCollectedFinalized<ProgressTracker> {
46    WTF_MAKE_NONCOPYABLE(ProgressTracker); WTF_MAKE_FAST_ALLOCATED_WILL_BE_REMOVED;
47public:
48    static PassOwnPtrWillBeRawPtr<ProgressTracker> create(LocalFrame*);
49
50    ~ProgressTracker();
51    void trace(Visitor*);
52    void dispose();
53
54    double estimatedProgress() const;
55
56    void progressStarted();
57    void progressCompleted();
58
59    void incrementProgress(unsigned long identifier, const ResourceResponse&);
60    void incrementProgress(unsigned long identifier, const char*, int);
61    void completeProgress(unsigned long identifier);
62
63    long long totalPageAndResourceBytesToLoad() const { return m_totalPageAndResourceBytesToLoad; }
64    long long totalBytesReceived() const { return m_totalBytesReceived; }
65
66private:
67    explicit ProgressTracker(LocalFrame*);
68
69    void reset();
70
71    RawPtrWillBeMember<LocalFrame> m_frame;
72    bool m_inProgress;
73    long long m_totalPageAndResourceBytesToLoad;
74    long long m_totalBytesReceived;
75    double m_lastNotifiedProgressValue;
76    double m_lastNotifiedProgressTime;
77    double m_progressNotificationInterval;
78    double m_progressNotificationTimeInterval;
79    bool m_finalProgressChangedSent;
80    double m_progressValue;
81
82    HashMap<unsigned long, OwnPtr<ProgressItem> > m_progressItems;
83};
84
85}
86
87#endif
88