WebCore/ProgressTracker.h

   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 <wtf/HashMap.h>
  30 #include <wtf/Noncopyable.h>
  31 #include <wtf/RefPtr.h>
  32
  33 namespace WebCore {
  34
  35 class Frame;
  36 class ResourceResponse;
  37 struct ProgressItem;
  38
  39 class ProgressTracker : Noncopyable {
  40 public:
  41     ProgressTracker();
  42     ~ProgressTracker();
  43
  44     unsigned long createUniqueIdentifier();
  45
  46     double estimatedProgress() const;
  47
  48     void progressStarted(Frame*);
  49     void progressCompleted(Frame*);
  50
  51     void incrementProgress(unsigned long identifier, const ResourceResponse&);
  52     void incrementProgress(unsigned long identifier, const char*, int);
  53     void completeProgress(unsigned long identifier);
  54
  55     long long totalPageAndResourceBytesToLoad() const { return m_totalPageAndResourceBytesToLoad; }
  56     long long totalBytesReceived() const { return m_totalBytesReceived; }
  57
  58 private:
  59     void reset();
  60     void finalProgressComplete();
  61
  62     unsigned long m_uniqueIdentifier;
  63
  64     long long m_totalPageAndResourceBytesToLoad;
  65     long long m_totalBytesReceived;
  66     double m_lastNotifiedProgressValue;
  67     double m_lastNotifiedProgressTime;
  68     double m_progressNotificationInterval;
  69     double m_progressNotificationTimeInterval;
  70     bool m_finalProgressChangedSent;
  71     double m_progressValue;
  72     RefPtr<Frame> m_originatingProgressFrame;
  73
  74     int m_numProgressTrackedFrames;
  75     HashMap<unsigned long, ProgressItem*> m_progressItems;
  76 };
  77
  78 }
  79
  80 #endif