MultiLevelJsonBase.hpp

/*
 * Copyright (C) 2008 Fabien Chereau
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Suite 500, Boston, MA  02110-1335, USA.
 */

#ifndef _MULTILEVELJSONBASE_HPP_
#define _MULTILEVELJSONBASE_HPP_

#include "StelSkyLayer.hpp"

#include <QList>
#include <QString>
#include <QVariantMap>
#include <QNetworkReply>

class QIODevice;
class StelCore;

class MultiLevelJsonBase : public StelSkyLayer
{
    Q_OBJECT

    friend class JsonLoadThread;

public:
    MultiLevelJsonBase(MultiLevelJsonBase* parent=NULL);

    void initFromUrl(const QString& url);

    void initFromQVariantMap(const QVariantMap& map);

    ~MultiLevelJsonBase();

    QString getShortName() const {return shortName;}

    bool hasErrorOccured() const {return errorOccured;}

    int getLevel() const {return parent()==NULL ? 0 : (qobject_cast<MultiLevelJsonBase*>(parent()))->getLevel()+1;}

    QVariantMap toQVariantMap() const;

    void scheduleChildsDeletion();

private slots:
    void downloadFinished();
    void jsonLoadFinished();

protected:
    virtual void loadFromQVariantMap(const QVariantMap& map)=0;

    bool isDeletionScheduled() const {return timeWhenDeletionScheduled>0.;}

    QString shortName;

    QString baseUrl;

    QString contructorUrl;

    QList<MultiLevelJsonBase*> subTiles;

    bool errorOccured;

    void updatePercent(int tot, int numToBeLoaded);

    void deleteUnusedSubTiles();

    bool downloading;

    void cancelDeletion();

    static QVariantMap loadFromJSON(QIODevice& input, bool qZcompressed=false, bool gzCompressed=false);

private:
    QString getBaseUrl() const {return baseUrl;}

    // Used to download remote JSON files if needed
    class QNetworkReply* httpReply;

    // The delay after which a scheduled deletion will occur
    float deletionDelay;

    class JsonLoadThread* loadThread;

    // Time at which deletion was first scheduled
    double timeWhenDeletionScheduled;

    // The temporary map filled in a thread
    QVariantMap temporaryResultMap;

    bool loadingState;
    int lastPercent;

    static class QNetworkAccessManager* networkAccessManager;

    static QNetworkAccessManager& getNetworkAccessManager();
};

#endif // _MULTILEVELJSONBASE_HPP_