/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
 *
 * ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is mozilla.org code.
 *
 * The Initial Developer of the Original Code is
 * Netscape Communications Corporation.
 * Portions created by the Initial Developer are Copyright (C) 1998
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */


#ifndef nsTopProgressManager_h__
#define nsTopProgressManager_h__

#include "nsProgressManager.h"
#include "nsTime.h"

struct AggregateTransferInfo {
    PRUint32 ObjectCount;
    PRUint32 CompleteCount;
    PRUint32 SuspendedCount;
    PRUint32 MSecRemaining;
    PRUint32 BytesReceived;
    PRUint32 ContentLength;
    PRUint32 UnknownLengthCount;
};



/**
 * An <b>nsTopProgressManager</b> is a progress manager that is associated
 * with a top-level window context. It does the dirty work of managing the
 * progress bar and the status text.
 */
class nsTopProgressManager : public nsProgressManager
{
protected:
    /**
     * A table of URLs that we are monitoring progress for. The table is
     * keyed by <b>URL_Structs</b>, the values are <b>nsTransfer</b>
     * objects.
     */
    PLHashTable* fURLs;

    /**
     * The time at which the progress manager was created.
     */
    nsTime fActualStart;

    /**
     * The time at which the progress bar thinks we were created. This is used
     * with to make progress seem "monotonic": it is "slipped" backwards
     * when a transfer stalls so that the percentage complete stays constant.
     */
    nsTime fProgressBarStart;

    /**
     * The current amount of progress shown on the chrome's progress bar
     */
    PRUint16 fProgress;

    /**
     * The default status message to display if nothing more appropriate
     * is around.
     */
    char* fDefaultStatus;

    /**
     * An FE timeout object that is used to periodically update the
     * status bar.
     */
    void* fTimeout;

    /**
     * The FE timeout callback.
     */
    static void TimeoutCallback(void* self);

    /**
     * Called to update the status bar.
     */
    virtual void Tick(void);


    /**
     * Update the progress bar
     */
    virtual void UpdateProgressBar(AggregateTransferInfo& info);


    /**
     * Update the status message
     */
    virtual void UpdateStatusMessage(AggregateTransferInfo& info);


public:
    nsTopProgressManager(MWContext* context);
    virtual ~nsTopProgressManager(void);

    NS_IMETHOD
    OnStartBinding(const URL_Struct* url);

    NS_IMETHOD
    OnProgress(const URL_Struct* url, PRUint32 bytesReceived, PRUint32 contentLength);

    NS_IMETHOD
    OnStatus(const URL_Struct* url, const char* message);

    NS_IMETHOD
    OnSuspend(const URL_Struct* url);

    NS_IMETHOD
    OnResume(const URL_Struct* url);

    NS_IMETHOD
    OnStopBinding(const URL_Struct* url, PRInt32 status, const char* message);
};


#endif // nsTopProgressManager_h__