StelLocationMgr.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 _STELLOCATIONMGR_HPP_
#define _STELLOCATIONMGR_HPP_

#include "StelLocation.hpp"
#include <QString>
#include <QObject>
#include <QMetaType>
#include <QMap>

typedef QList<StelLocation> LocationList;
typedef QMap<QString,StelLocation> LocationMap;
typedef QMap<QByteArray,QByteArray> TimezoneNameMap;

class GPSLookupHelper;

class StelLocationMgr : public QObject
{
    Q_OBJECT

public:
    StelLocationMgr();
    ~StelLocationMgr();

    StelLocationMgr(const LocationList& locations);

    void setLocations(const LocationList& locations);

    LocationList getAll() const {return locations.values();}

    LocationMap getAllMap() const { return locations; }

    const StelLocation locationFromCLI() const;

    const StelLocation& getLastResortLocation() const {return lastResortLocation;}
    
    bool canSaveUserLocation(const StelLocation& loc) const;

    bool saveUserLocation(const StelLocation& loc);

    bool canDeleteUserLocation(const QString& id) const;

    bool deleteUserLocation(const QString& id);

    LocationMap pickLocationsNearby(const QString planetName, const float longitude, const float latitude, const float radiusDegrees);
    LocationMap pickLocationsInCountry(const QString country);

public slots:
    const StelLocation locationForString(const QString& s) const;

    void locationFromIP();

#ifdef ENABLE_GPS
    bool locationFromGPS();
#endif

    static QString sanitizeTimezoneStringForLocationDB(QString tzString);
    static QString sanitizeTimezoneStringFromLocationDB(QString dbString);

signals:
    void locationListChanged();

#ifdef ENABLE_GPS
    void gpsQueryFinished(bool success);
#endif
private slots:
    void changeLocationFromNetworkLookup();
#ifdef ENABLE_GPS
    void changeLocationFromGPSQuery(const StelLocation& loc);
    void gpsQueryError(const QString& err);
#endif
private:
    void generateBinaryLocationFile(const QString& txtFile, bool isUserLocation, const QString& binFile) const;

    static LocationMap loadCities(const QString& fileName, bool isUserLocation);
    static LocationMap loadCitiesBin(const QString& fileName);

    LocationMap locations;
    static TimezoneNameMap locationDBToIANAtranslations;
    
    StelLocation lastResortLocation;

    GPSLookupHelper *nmeaHelper,*libGpsHelper;
};

#endif // _STELLOCATIONMGR_HPP_