Pulsars.hpp

/*
 * Copyright (C) 2012 Alexander Wolf
 *
 * 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 _PULSARS_HPP_
#define _PULSARS_HPP_

#include "StelObjectModule.hpp"
#include "StelObject.hpp"
#include "StelFader.hpp"
#include "StelTextureTypes.hpp"
#include "Pulsar.hpp"
#include <QFont>
#include <QVariantMap>
#include <QDateTime>
#include <QList>
#include <QSharedPointer>

class QNetworkAccessManager;
class QNetworkReply;
class QSettings;
class QTimer;
class QPixmap;
class StelButton;
class PulsarsDialog;

class StelPainter;

typedef QSharedPointer<Pulsar> PulsarP;

class Pulsars : public StelObjectModule
{
    Q_OBJECT
    Q_PROPERTY(bool pulsarsVisible READ getFlagShowPulsars WRITE setFlagShowPulsars)
public: 
    enum UpdateState {
        Updating,       
        CompleteNoUpdates,  
        CompleteUpdates,    
        DownloadError,      
        OtherError      
    };

    Pulsars();
    virtual ~Pulsars();

    // Methods defined in the StelModule class
    virtual void init();
    virtual void deinit();
    virtual void update(double) {;}
    virtual void draw(StelCore* core);
    virtual void drawPointer(StelCore* core, StelPainter& painter);
    virtual double getCallOrder(StelModuleActionName actionName) const;

    // Methods defined in StelObjectManager class
    virtual QList<StelObjectP> searchAround(const Vec3d& v, double limitFov, const StelCore* core) const;

    virtual StelObjectP searchByNameI18n(const QString& nameI18n) const;

    virtual StelObjectP searchByName(const QString& name) const;

    virtual QStringList listMatchingObjectsI18n(const QString& objPrefix, int maxNbItem=5, bool useStartOfWords=false) const;
    virtual QStringList listMatchingObjects(const QString& objPrefix, int maxNbItem=5, bool useStartOfWords=false) const;
    virtual QStringList listAllObjects(bool inEnglish) const;
    virtual QStringList listAllObjectsByType(const QString& objType, bool inEnglish) const { Q_UNUSED(objType) Q_UNUSED(inEnglish) return QStringList(); }
    virtual QString getName() const { return "Pulsars"; }

    PulsarP getByID(const QString& id);

    virtual bool configureGui(bool show=true);

    void restoreDefaults(void);

    void readSettingsFromConfig(void);

    void saveSettingsToConfig(void);

    bool getUpdatesEnabled(void) {return updatesEnabled;}
    void setUpdatesEnabled(bool b) {updatesEnabled=b;}

    bool getDisplayMode(void);
    void setDisplayMode(bool b);

    bool getGlitchFlag(void);
    void setGlitchFlag(bool b);

    QString getMarkerColor(bool mtype = true);
    void setMarkerColor(QString c, bool mtype = true);

    void setEnableAtStartup(bool b) { enableAtStartup=b; }
    bool getEnableAtStartup(void) { return enableAtStartup; }

    QDateTime getLastUpdate(void) {return lastUpdate;}

    int getUpdateFrequencyDays(void) {return updateFrequencyDays;}
    void setUpdateFrequencyDays(int days) {updateFrequencyDays = days;}

    int getSecondsToUpdate(void);

    UpdateState getUpdateState(void) {return updateState;}

    int getCountPulsars(void) {return PsrCount;}

signals:
    void updateStateChanged(Pulsars::UpdateState state);

    void jsonUpdateComplete(void);

public slots:
    void updateJSON(void);

    void setFlagShowPulsars(bool b) { flagShowPulsars=b; }
    bool getFlagShowPulsars(void) { return flagShowPulsars; }

    void displayMessage(const QString& message, const QString hexColor="#999999");
    void messageTimeout(void);

    void setFlagShowPulsarsButton(bool b);
    bool getFlagShowPulsarsButton(void) { return flagShowPulsarsButton; }


private:
    // Font used for displaying our text
    QFont font;

    // if existing, delete Satellites section in main config.ini, then create with default values
    void restoreDefaultConfigIni(void);

    // Upgrade config.ini: rename old key settings to new
    void upgradeConfigIni(void);

    void restoreDefaultJsonFile(void);

    void readJsonFile(void);

    bool backupJsonFile(bool deleteOriginal=false);

    int getJsonFileFormatVersion(void);

    bool checkJsonFileFormat(void);

    QVariantMap loadPSRMap(QString path=QString());

    void setPSRMap(const QVariantMap& map);

    QString jsonCatalogPath;

    StelTextureSP texPointer;
    QList<PulsarP> psr;

    int PsrCount;

    // variables and functions for the updater
    UpdateState updateState;
    QNetworkAccessManager* downloadMgr;
    QString updateUrl;  
    QTimer* updateTimer;
    QTimer* messageTimer;
    QList<int> messageIDs;
    bool updatesEnabled;
    QDateTime lastUpdate;
    int updateFrequencyDays;    
    bool enableAtStartup;

    QSettings* conf;

    // GUI
    PulsarsDialog* configDialog;
    bool flagShowPulsars;
    bool flagShowPulsarsButton;
    QPixmap* OnIcon;
    QPixmap* OffIcon;
    QPixmap* GlowIcon;
    StelButton* toolbarButton;
    class StelProgressController* progressBar;


private slots:
    void checkForUpdate(void);
    void updateDownloadComplete(QNetworkReply* reply);

};



#include <QObject>
#include "StelPluginInterface.hpp"

class PulsarsStelPluginInterface : public QObject, public StelPluginInterface
{
    Q_OBJECT
    Q_PLUGIN_METADATA(IID StelPluginInterface_iid)
    Q_INTERFACES(StelPluginInterface)
public:
    virtual StelModule* getStelModule() const;
    virtual StelPluginInfo getPluginInfo() const;
};

#endif /*_PULSARS_HPP_*/