DBThread.h

Go to the documentation of this file.

#ifndef OSMSCOUT_CLIENT_QT_DBTHREAD_H
#define OSMSCOUT_CLIENT_QT_DBTHREAD_H

/*
 OSMScout - a Qt backend for libosmscout and libosmscout-map
 Copyright (C) 2010  Tim Teulings
 Copyright (C) 2016  Lukáš Karas

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.

  This library 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
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
 */

#include <QtGui>
#include <QThread>
#include <QMetaType>
#include <QMutex>
#include <QTime>
#include <QTimer>
#include <QReadWriteLock>

#include <osmscout/LocationEntry.h>
#include <osmscout/BasemapDatabase.h>
#include <osmscout/Database.h>
#include <osmscout/LocationService.h>
#include <osmscout/MapService.h>
#include <osmscout/MapPainterQt.h>

#include <osmscout/Settings.h>
#include <osmscout/TileCache.h>
#include <osmscout/OsmTileDownloader.h>
#include <osmscout/MapManager.h>
#include <osmscout/DBInstance.h>
#include <osmscout/DBJob.h>

namespace osmscout {

struct MapViewStruct
{
  osmscout::GeoCoord      coord;
  osmscout::Bearing       angle; // canvas clockwise
  osmscout::Magnification magnification;
  size_t                  width;
  size_t                  height;
  double                  dpi;
};

inline bool operator!=(const MapViewStruct &r1, const MapViewStruct &r2)
{
    return r1.coord!=r2.coord ||
      r1.angle!=r2.angle ||
      r1.magnification!=r2.magnification ||
      r1.width!=r2.width ||
      r1.height!=r2.height ||
      r1.dpi!=r2.dpi;
}

struct DatabaseLoadedResponse
{
    osmscout::GeoBox boundingBox;
};

enum DatabaseCoverage{
  Outside = 0,
  Covered = 1,
  Intersects = 2,
};

class OSMSCOUT_CLIENT_QT_API DBThread : public QObject
{
  friend class OSMScoutQt; // accessing to protected constructor

  Q_OBJECT
  Q_PROPERTY(QString stylesheetFilename READ GetStylesheetFilename NOTIFY stylesheetFilenameChanged)

public:
  using SynchronousDBJob = std::function<void (const std::list<DBInstanceRef> &)>;

signals:
  void initialisationFinished(const DatabaseLoadedResponse& response);
  void stylesheetFilenameChanged();
  void databaseLoadFinished(osmscout::GeoBox boundingBox);
  void styleErrorsChanged();

public slots:
  void ToggleDaylight();
  void onMapDPIChange(double dpi);
  void SetStyleFlag(const QString &key, bool value);
  void ReloadStyle(const QString &suffix="");
  void LoadStyle(QString stylesheetFilename,
                 std::unordered_map<std::string,bool> stylesheetFlags,
                 const QString &suffix="");
  void Initialize();
  void onDatabaseListChanged(QList<QDir> databaseDirectories);

  void FlushCaches(qint64 idleMs);

protected:
  QThread                            *backgroundThread;
  MapManagerRef                      mapManager;
  QString                            basemapLookupDirectory;
  SettingsRef                        settings;

  double                             mapDpi;
  double                             physicalDpi;

  mutable QReadWriteLock             lock;

  osmscout::BasemapDatabaseParameter basemapDatabaseParameter;
  osmscout::BasemapDatabaseRef       basemapDatabase;
  osmscout::DatabaseParameter        databaseParameter;
  std::list<DBInstanceRef>           databases;

  QString                            stylesheetFilename;
  QString                            iconDirectory;
  std::unordered_map<std::string,bool>
                                     stylesheetFlags;
  bool                               daylight;

  bool                               renderError;
  QList<StyleError>                  styleErrors;

  std::vector<std::string>           customPoiTypes;

protected:

  bool isInitializedInternal();

public:
  DBThread(QThread *backgroundThread,
           QString basemapLookupDirectory,
           QString iconDirectory,
           SettingsRef settings,
           MapManagerRef mapManager,
           const std::vector<std::string> &customPoiTypes);

  ~DBThread() override;

  bool isInitialized();

  const DatabaseLoadedResponse loadedResponse() const;

  DatabaseCoverage databaseCoverage(const osmscout::Magnification &magnification,
                                    const osmscout::GeoBox &bbox);

  double GetMapDpi() const;

  double GetPhysicalDpi() const;

  inline QString GetStylesheetFilename() const
  {
    return stylesheetFilename;
  }

  const QList<StyleError> &GetStyleErrors() const
  {
      return styleErrors;
  }

  const QMap<QString,bool> GetStyleFlags() const;

  void RunJob(DBJob *job);

  void RunSynchronousJob(SynchronousDBJob job);

};

using DBThreadRef = std::shared_ptr<DBThread>;

}

Q_DECLARE_METATYPE(osmscout::MapViewStruct)
Q_DECLARE_METATYPE(osmscout::DatabaseLoadedResponse)

#endif