SolarSystemEditor.hpp

/*
 * Solar System editor plug-in for Stellarium
 * 
 * Copyright (C) 2010 Bogdan Marinov
 * Copyright (C) 2017 Georg Zotti (changes for 0.16)
 *
 * 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 _SOLAR_SYSTEM_EDITOR_HPP_
#define _SOLAR_SYSTEM_EDITOR_HPP_

#include "StelGui.hpp"
#include "StelModule.hpp"
//#include "CAIMainWindow.hpp"

#include <QHash>
#include <QList>
#include <QString>
#include <QVariant>

class SolarSystemManagerWindow;
class SolarSystem;
class QSettings;

typedef QHash<QString, QVariant> SsoElements;

class SolarSystemEditor : public StelModule
{
    Q_OBJECT

public:
    SolarSystemEditor();
    virtual ~SolarSystemEditor();
    
    // Methods inherited from the StelModule class
    virtual void init();
    virtual void deinit(){}
    virtual void update(double deltaTime){Q_UNUSED(deltaTime)}
    virtual void draw(StelCore * core){Q_UNUSED(core)}
    virtual double getCallOrder(StelModuleActionName actionName) const;
    virtual bool configureGui(bool show);
    
    SsoElements readMpcOneLineCometElements(QString oneLineElements) const;

    SsoElements readMpcOneLineMinorPlanetElements(QString oneLineElements) const;
/* DEAD CODE. MAYBE REACTIVATE as scripting function (public slot)?
    SsoElements readXEphemOneLineElements(QString oneLineElements);
*/
    QList<SsoElements> readMpcOneLineCometElementsFromFile(QString filePath) const;

    QList<SsoElements> readMpcOneLineMinorPlanetElementsFromFile(QString filePath) const;

    /*
     * GZ identified as DEAD CODE as of 0.16pre. Maybe reactivate as public slot for scripting use?
    QList<SsoElements> readXEphemOneLineElementsFromFile(QString filePath);
    */

    bool appendToSolarSystemConfigurationFile(SsoElements object);

    bool appendToSolarSystemConfigurationFile(QList<SsoElements>);

    enum UpdateFlag {
        UpdateNameAndNumber = 0x01,
        UpdateType = 0x02, 
        UpdateOrbitalElements = 0x04, 
        UpdateMagnitudeParameters = 0x08 
    };
    Q_DECLARE_FLAGS(UpdateFlags, UpdateFlag)

    
    bool updateSolarSystemConfigurationFile(QList<SsoElements> objects, UpdateFlags flags);

    QHash<QString,QString> getDefaultSsoIdentifiers() const {return defaultSsoIdentifiers;}

    QHash<QString,QString> listAllLoadedSsoIdentifiers() const;

    bool removeSsoWithName(QString name);

    bool copySolarSystemConfigurationFileTo(QString filePath);
    bool replaceSolarSystemConfigurationFileWith(QString filePath);
    bool addFromSolarSystemConfigurationFile(QString filePath);

    QString getCustomSolarSystemFilePath() const {return customSolarSystemFilePath;}
    
public slots:
    void resetSolarSystemToDefault();

signals:
    //TODO: This should be part of SolarSystem::reloadPlanets()
    void solarSystemChanged();

private slots:
    void updateI18n();

private:
    bool isInitialized;

    SolarSystemManagerWindow * mainWindow;

    QSettings * solarSystemConfigurationFile;
    SolarSystem * solarSystem;

    QString customSolarSystemFilePath;
    QString defaultSolarSystemFilePath;
    QString majorSolarSystemFilePath; // install dir's ssystem_major.ini


    QHash<QString,QString> defaultSsoIdentifiers;

    QHash<QString,QString> listAllLoadedObjectsInFile(QString filePath) const;

    bool cloneSolarSystemConfigurationFile() const;

    bool resetSolarSystemConfigurationFile() const;

    static int unpackDayOrMonthNumber (QChar digit);
    static int unpackYearNumber (QChar prefix, int lastTwoDigits);
    static int unpackAlphanumericNumber (QChar prefix, int lastDigit);

    //TODO: This should be public, perhaps?
    static QString unpackMinorPlanetProvisionalDesignation(QString packedDesignation);

    static void updateSsoProperty(QSettings& configuration, SsoElements& properties, QString key);

    static QString convertToGroupName(QString& name, int minorPlanetNumber = 0);
    static QString fixGroupName(QString &name);
};



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

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

#endif //_SOLAR_SYSTEM_EDITOR_HPP_