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 <osmscout/DataTileCache.h>
#include <osmscout/DBThread.h>
#include <osmscout/LookupModule.h>
#include <osmscout/MapRenderer.h>
#include <osmscout/Router.h>
#include <osmscout/SearchModule.h>
#include <osmscout/StyleModule.h>
#include <osmscout/NavigationModule.h>
#include <osmscout/POILookupModule.h>
#include <osmscout/VoiceManager.h>
#include <osmscout/ElevationModule.h>

#include <osmscout/ClientQtImportExport.h>

#include <atomic>

namespace osmscout {

class OSMScoutQt;

class OSMSCOUT_CLIENT_QT_API OSMScoutQtBuilder{
private:
  QSettings *settingsStorage{nullptr};

  QString onlineTileProviders;
  QString mapProviders;
  QString 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& WithOnlineTileProviders(const QString &onlineTileProviders)
  {
    this->onlineTileProviders=onlineTileProviders;
    return *this;
  }

  inline OSMScoutQtBuilder& WithMapProviders(const QString &mapProviders)
  {
    this->mapProviders=mapProviders;
    return *this;
  }

  inline OSMScoutQtBuilder& WithVoiceProviders(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;
  VoiceManagerRef voiceManager; // created lazy

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;
  VoiceManagerRef GetVoiceManager();

  LookupModule* MakeLookupModule();
  MapRenderer* MakeMapRenderer(RenderingType type);
  Router* MakeRouter();
  NavigationModule* MakeNavigation();
  SearchModule *MakeSearchModule();
  StyleModule *MakeStyleModule();
  POILookupModule *MakePOILookupModule();
  ElevationModule *MakeElevationModule();

  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();
};

}

Q_DECLARE_METATYPE(osmscout::TileRef)
Q_DECLARE_METATYPE(osmscout::BreakerRef)

#endif /* OSMSCOUT_CLIENT_QT_OSMSCOUTQT_H */