OSMScoutQt.h

Go to the documentation of this file.

#ifndef OSMSCOUT_CLIENT_QT_OSMSCOUTQT_H
#define OSMSCOUT_CLIENT_QT_OSMSCOUTQT_H
 
/*
 OSMScout - a Qt backend for libosmscout and libosmscout-map
 Copyright (C) 2017 Lukas 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 <QSettings>
 
#include <osmscoutmap/DataTileCache.h>
 
#include <osmscoutclient/MapManager.h>
#include <osmscoutclient/DBThread.h>
#include <osmscoutclient/POILookupModule.h>
 
#include <osmscoutclientqt/LookupModule.h>
#include <osmscoutclientqt/MapDownloader.h>
#include <osmscoutclientqt/MapRenderer.h>
#include <osmscoutclientqt/Router.h>
#include <osmscoutclientqt/SearchModule.h>
#include <osmscoutclientqt/StyleModule.h>
#include <osmscoutclientqt/NavigationModule.h>
#include <osmscoutclientqt/VoiceManager.h>
#include <osmscoutclientqt/ElevationModule.h>
#include <osmscoutclientqt/IconLookup.h>
 
#include <osmscoutclientqt/ClientQtImportExport.h>
 
#include <atomic>
 
namespace osmscout {
 
class OSMScoutQt;

class OSMSCOUT_CLIENT_QT_API OSMScoutQtBuilder{
private:
  QSettings *settingsStorage{nullptr};
 
  QStringList onlineTileProviders;
  QStringList mapProviders;
  QStringList voiceProviders;
  QStringList mapLookupDirectories;
  QString basemapLookupDirectory;
  QString cacheLocation;
  QString iconDirectory;
  QStringList customPoiTypes;
 
  size_t onlineTileCacheSize{100};
  size_t offlineTileCacheSize{200};
 
  QString voiceLookupDirectory;
 
  QString styleSheetDirectory;
  bool styleSheetDirectoryConfigured{false};
 
  QString styleSheetFile;
  bool styleSheetFileConfigured{false};
 
  QString appName{"UnspecifiedApp"};
  QString appVersion{"v?"};
 
public:
  OSMScoutQtBuilder();
 
  virtual ~OSMScoutQtBuilder();

  inline OSMScoutQtBuilder& WithSettingsStorage(QSettings *providedStorage)
  {
    this->settingsStorage=providedStorage;
    return *this;
  }
 
  inline OSMScoutQtBuilder& AddOnlineTileProviders(const QString &onlineTileProviders)
  {
    this->onlineTileProviders << onlineTileProviders;
    return *this;
  }
 
  inline OSMScoutQtBuilder& AddMapProviders(const QString &mapProviders)
  {
    this->mapProviders << mapProviders;
    return *this;
  }
 
  inline OSMScoutQtBuilder& AddVoiceProviders(const QString &voiceProviders)
  {
    this->voiceProviders << voiceProviders;
    return *this;
  }
 
  inline OSMScoutQtBuilder& WithMapLookupDirectories(const QStringList &mapLookupDirectories)
  {
    this->mapLookupDirectories=mapLookupDirectories;
    return *this;
  }
 
  inline OSMScoutQtBuilder& WithBasemapLookupDirectory(const QString &basemapLookupDirectory)
  {
    this->basemapLookupDirectory=basemapLookupDirectory;
    return *this;
  }
 
  inline OSMScoutQtBuilder& WithVoiceLookupDirectory(const QString &voiceLookupDirectory)
  {
    this->voiceLookupDirectory=voiceLookupDirectory;
    return *this;
  }
 
  inline OSMScoutQtBuilder& AddMapLookupDirectories(const QString &mapLookupDirectory)
  {
    this->mapLookupDirectories << mapLookupDirectory;
    return *this;
  }
 
  inline OSMScoutQtBuilder& WithCustomPoiTypes(const QStringList &customPoiTypes)
  {
    this->customPoiTypes=customPoiTypes;
    return *this;
  }
 
  inline OSMScoutQtBuilder& AddCustomPoiType(const QString &typeName)
  {
    this->customPoiTypes << typeName;
    return *this;
  }
 
  inline OSMScoutQtBuilder& WithCacheLocation(const QString &cacheLocation)
  {
    this->cacheLocation=cacheLocation;
    return *this;
  }
 
  inline OSMScoutQtBuilder& WithIconDirectory(const QString &iconDirectory)
  {
    this->iconDirectory=iconDirectory;
    return *this;
  }
 
  inline OSMScoutQtBuilder& WithStyleSheetDirectory(const QString &styleSheetDirectory)
  {
    this->styleSheetDirectory=styleSheetDirectory;
    this->styleSheetDirectoryConfigured=true;
    return *this;
  }
 
  inline OSMScoutQtBuilder& WithStyleSheetFile(QString styleSheetFile)
  {
    this->styleSheetFile=styleSheetFile;
    this->styleSheetFileConfigured=true;
    return *this;
  }
 
  inline OSMScoutQtBuilder& WithTileCacheSizes(size_t onlineTileCacheSize,
                                               size_t offlineTileCacheSize){
    this->onlineTileCacheSize=onlineTileCacheSize;
    this->offlineTileCacheSize=offlineTileCacheSize;
    return *this;
  }
 
  inline OSMScoutQtBuilder& WithUserAgent(const QString &appName,
                                          const QString &appVersion){
    this->appName=appName;
    this->appVersion=appVersion;
    return *this;
  }
 
  bool Init();
};

using OSMScoutQtBuilderRef = std::shared_ptr<OSMScoutQtBuilder>;

enum RenderingType {
  PlaneRendering = 0,
  TiledRendering = 1
};

class OSMSCOUT_CLIENT_QT_API OSMScoutQt : public QObject {
  Q_OBJECT
  friend class OSMScoutQtBuilder;
 
private:
  SettingsRef      settings;
  MapManagerRef    mapManager;
  DBThreadRef      dbThread;
  QString          iconDirectory;
  QString          cacheLocation;
  size_t           onlineTileCacheSize;
  size_t           offlineTileCacheSize;
  QString          userAgent;
  std::atomic_int  liveBackgroundThreads;
 
  std::mutex       mutex;
  MapDownloaderRef mapDownloader; // created lazy, guarded by mutex
  VoiceManagerRef  voiceManager; // created lazy, guarded by mutex
 
private:
  OSMScoutQt(SettingsRef settings,
             MapManagerRef mapManager,
             QString basemapLookupDirectory,
             QString iconDirectory,
             QString cacheLocation,
             size_t onlineTileCacheSize,
             size_t offlineTileCacheSize,
             QString userAgent,
             QStringList customPoiTypes);
 
public slots:
  void threadFinished();
 
public:
  ~OSMScoutQt() override;

  QThread *makeThread(QString name);

  bool waitForReleasingResources(unsigned long mSleep, unsigned long maxCount) const;
 
  DBThreadRef GetDBThread() const;
  SettingsRef GetSettings() const;
  MapManagerRef GetMapManager() const;
  MapDownloaderRef GetMapDownloader();
  VoiceManagerRef GetVoiceManager();
 
  LookupModule* MakeLookupModule();
  MapRenderer* MakeMapRenderer(RenderingType type);
  Router* MakeRouter();
  NavigationModule* MakeNavigation();
  SearchModule *MakeSearchModule();
  StyleModule *MakeStyleModule();
  POILookupModule *MakePOILookupModule();
  ElevationModule *MakeElevationModule();
  IconLookup *MakeIconLookup();
 
  QString GetUserAgent() const;
  QString GetCacheLocation() const;
  size_t  GetOnlineTileCacheSize() const;
  QString GetIconDirectory() const;
 
  static void RegisterQmlTypes(const char *uri="net.sf.libosmscout.map",
                               int versionMajor=1,
                               int versionMinor=0);
 
  static OSMScoutQtBuilder NewInstance();
  static OSMScoutQt& GetInstance();
  static void FreeInstance();
};
 
}
 
#endif /* OSMSCOUT_CLIENT_QT_OSMSCOUTQT_H */