Include MLN_WITH_PMTILES to enable or disable PMTiles support

maplibre · Oct 6, 2024 · 5e9e6cc · 5e9e6cc
1 parent a888a1a
commit 5e9e6cc
Show file tree

Hide file tree

Showing 9 changed files with 88 additions and 8 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -11,6 +11,7 @@ option(MLN_WITH_OPENGL "Build with OpenGL renderer" ON)
 option(MLN_WITH_EGL "Build with EGL renderer" OFF)
 option(MLN_WITH_VULKAN "Build with Vulkan renderer" OFF)
 option(MLN_WITH_OSMESA "Build with OSMesa (Software) renderer" OFF)
+option(MLN_WITH_PMTILES "Build with PMTiles support" ON)
 option(MLN_WITH_WERROR "Make all compilation warnings errors" ON)
 option(MLN_LEGACY_RENDERER "Include the legacy rendering pathway" ON)
 option(MLN_DRAWABLE_RENDERER "Include the drawable rendering pathway" OFF)
@@ -1466,7 +1467,7 @@ target_link_libraries(
         mbgl-vendor-earcut.hpp
         mbgl-vendor-eternal
         mbgl-vendor-parsedate
-        mbgl-vendor-pmtiles
+        $<$<BOOL:${MLN_WITH_PMTILES}>:mbgl-vendor-pmtiles>
         mbgl-vendor-polylabel
         mbgl-vendor-protozero
         mbgl-vendor-unique_resource
@@ -1532,6 +1533,14 @@ if(MLN_WITH_VULKAN)
     )
 endif()
 
+if(MLN_WITH_PMTILES)
+    target_compile_definitions(
+        mbgl-core
+        PUBLIC
+            MLN_WITH_PMTILES
+    )
+endif()
+
 set_target_properties(
     mbgl-core
     PROPERTIES

diff --git a/include/mbgl/storage/file_source.hpp b/include/mbgl/storage/file_source.hpp
@@ -25,7 +25,9 @@ enum FileSourceType : uint8_t {
     FileSystem,
     Network,
     Mbtiles,
+#ifdef MLN_WITH_PMTILES
     Pmtiles,
+#endif
     ResourceLoader ///< %Resource loader acts as a proxy and has logic
     /// for request delegation to Asset, Cache, and other
     /// file sources.

diff --git a/platform/android/android.cmake b/platform/android/android.cmake
@@ -61,7 +61,7 @@ target_sources(
         ${PROJECT_SOURCE_DIR}/platform/default/src/mbgl/storage/offline_database.cpp
         ${PROJECT_SOURCE_DIR}/platform/default/src/mbgl/storage/offline_download.cpp
         ${PROJECT_SOURCE_DIR}/platform/default/src/mbgl/storage/online_file_source.cpp
-        ${PROJECT_SOURCE_DIR}/platform/default/src/mbgl/storage/pmtiles_file_source.cpp
+        $<$<BOOL:${MLN_WITH_PMTILES}>:${PROJECT_SOURCE_DIR}/platform/default/src/mbgl/storage/pmtiles_file_source.cpp>
         ${PROJECT_SOURCE_DIR}/platform/default/src/mbgl/storage/sqlite3.cpp
         ${PROJECT_SOURCE_DIR}/platform/default/src/mbgl/text/bidi.cpp
         ${PROJECT_SOURCE_DIR}/platform/default/src/mbgl/util/compression.cpp

diff --git a/platform/default/src/mbgl/storage/file_source_manager.cpp b/platform/default/src/mbgl/storage/file_source_manager.cpp
@@ -37,12 +37,12 @@ class DefaultFileSourceManagerImpl final : public FileSourceManager {
                                   [](const ResourceOptions& resourceOptions, const ClientOptions& clientOptions) {
                                       return std::make_unique<MBTilesFileSource>(resourceOptions, clientOptions);
                                   });
-
+#ifdef MLN_WITH_PMTILES
         registerFileSourceFactory(FileSourceType::Pmtiles,
                                   [](const ResourceOptions& resourceOptions, const ClientOptions& clientOptions) {
                                       return std::make_unique<PMTilesFileSource>(resourceOptions, clientOptions);
                                   });
-
+#endif
         registerFileSourceFactory(FileSourceType::Network,
                                   [](const ResourceOptions& resourceOptions, const ClientOptions& clientOptions) {
                                       return std::make_unique<OnlineFileSource>(resourceOptions, clientOptions);

diff --git a/platform/default/src/mbgl/storage/main_resource_loader.cpp b/platform/default/src/mbgl/storage/main_resource_loader.cpp
@@ -17,6 +17,7 @@ namespace mbgl {
 
 class MainResourceLoaderThread {
 public:
+#ifdef MLN_WITH_PMTILES
     MainResourceLoaderThread(std::shared_ptr<FileSource> assetFileSource_,
                              std::shared_ptr<FileSource> databaseFileSource_,
                              std::shared_ptr<FileSource> localFileSource_,
@@ -29,6 +30,18 @@ class MainResourceLoaderThread {
           onlineFileSource(std::move(onlineFileSource_)),
           mbtilesFileSource(std::move(mbtilesFileSource_)),
           pmtilesFileSource(std::move(pmtilesFileSource_)) {}
+#else
+    MainResourceLoaderThread(std::shared_ptr<FileSource> assetFileSource_,
+                             std::shared_ptr<FileSource> databaseFileSource_,
+                             std::shared_ptr<FileSource> localFileSource_,
+                             std::shared_ptr<FileSource> onlineFileSource_,
+                             std::shared_ptr<FileSource> mbtilesFileSource_)
+        : assetFileSource(std::move(assetFileSource_)),
+          databaseFileSource(std::move(databaseFileSource_)),
+          localFileSource(std::move(localFileSource_)),
+          onlineFileSource(std::move(onlineFileSource_)),
+          mbtilesFileSource(std::move(mbtilesFileSource_)) {}
+#endif
 
     void request(AsyncRequest* req, const Resource& resource, const ActorRef<FileSourceRequest>& ref) {
         auto callback = [ref](const Response& res) {
@@ -72,9 +85,11 @@ class MainResourceLoaderThread {
         } else if (mbtilesFileSource && mbtilesFileSource->canRequest(resource)) {
             // Local file request
             tasks[req] = mbtilesFileSource->request(resource, callback);
+#ifdef MLN_WITH_PMTILES
         } else if (pmtilesFileSource && pmtilesFileSource->canRequest(resource)) {
             // Local file request
             tasks[req] = pmtilesFileSource->request(resource, callback);
+#endif
         } else if (localFileSource && localFileSource->canRequest(resource)) {
             // Local file request
             tasks[req] = localFileSource->request(resource, callback);
@@ -136,12 +151,15 @@ class MainResourceLoaderThread {
     const std::shared_ptr<FileSource> localFileSource;
     const std::shared_ptr<FileSource> onlineFileSource;
     const std::shared_ptr<FileSource> mbtilesFileSource;
+#ifdef MLN_WITH_PMTILES
     const std::shared_ptr<FileSource> pmtilesFileSource;
+#endif
     std::map<AsyncRequest*, std::unique_ptr<AsyncRequest>> tasks;
 };
 
 class MainResourceLoader::Impl {
 public:
+#ifdef MLN_WITH_PMTILES
     Impl(const ResourceOptions& resourceOptions_,
          const ClientOptions& clientOptions_,
          std::shared_ptr<FileSource> assetFileSource_,
@@ -168,6 +186,31 @@ class MainResourceLoader::Impl {
               pmtilesFileSource)),
           resourceOptions(resourceOptions_.clone()),
           clientOptions(clientOptions_.clone()) {}
+#else
+    Impl(const ResourceOptions& resourceOptions_,
+         const ClientOptions& clientOptions_,
+         std::shared_ptr<FileSource> assetFileSource_,
+         std::shared_ptr<FileSource> databaseFileSource_,
+         std::shared_ptr<FileSource> localFileSource_,
+         std::shared_ptr<FileSource> onlineFileSource_,
+         std::shared_ptr<FileSource> mbtilesFileSource_)
+        : assetFileSource(std::move(assetFileSource_)),
+          databaseFileSource(std::move(databaseFileSource_)),
+          localFileSource(std::move(localFileSource_)),
+          onlineFileSource(std::move(onlineFileSource_)),
+          mbtilesFileSource(std::move(mbtilesFileSource_)),
+          supportsCacheOnlyRequests_(bool(databaseFileSource)),
+          thread(std::make_unique<util::Thread<MainResourceLoaderThread>>(
+              util::makeThreadPrioritySetter(platform::EXPERIMENTAL_THREAD_PRIORITY_WORKER),
+              "ResourceLoaderThread",
+              assetFileSource,
+              databaseFileSource,
+              localFileSource,
+              onlineFileSource,
+              mbtilesFileSource)),
+          resourceOptions(resourceOptions_.clone()),
+          clientOptions(clientOptions_.clone()) {}
+#endif
 
     std::unique_ptr<AsyncRequest> request(const Resource& resource, Callback callback) {
         auto req = std::make_unique<FileSourceRequest>(std::move(callback));
@@ -180,12 +223,20 @@ class MainResourceLoader::Impl {
     }
 
     bool canRequest(const Resource& resource) const {
+#ifdef MLN_WITH_PMTILES
         return (assetFileSource && assetFileSource->canRequest(resource)) ||
                (localFileSource && localFileSource->canRequest(resource)) ||
                (databaseFileSource && databaseFileSource->canRequest(resource)) ||
                (onlineFileSource && onlineFileSource->canRequest(resource)) ||
                (mbtilesFileSource && mbtilesFileSource->canRequest(resource)) ||
                (pmtilesFileSource && pmtilesFileSource->canRequest(resource));
+#else
+        return (assetFileSource && assetFileSource->canRequest(resource)) ||
+               (localFileSource && localFileSource->canRequest(resource)) ||
+               (databaseFileSource && databaseFileSource->canRequest(resource)) ||
+               (onlineFileSource && onlineFileSource->canRequest(resource)) ||
+               (mbtilesFileSource && mbtilesFileSource->canRequest(resource));
+#endif
     }
 
     bool supportsCacheOnlyRequests() const { return supportsCacheOnlyRequests_; }
@@ -202,7 +253,9 @@ class MainResourceLoader::Impl {
         localFileSource->setResourceOptions(options.clone());
         onlineFileSource->setResourceOptions(options.clone());
         mbtilesFileSource->setResourceOptions(options.clone());
+#ifdef MLN_WITH_PMTILES
         pmtilesFileSource->setResourceOptions(options.clone());
+#endif
     }
 
     ResourceOptions getResourceOptions() {
@@ -218,7 +271,9 @@ class MainResourceLoader::Impl {
         localFileSource->setClientOptions(options.clone());
         onlineFileSource->setClientOptions(options.clone());
         mbtilesFileSource->setClientOptions(options.clone());
+#ifdef MLN_WITH_PMTILES
         pmtilesFileSource->setClientOptions(options.clone());
+#endif
     }
 
     ClientOptions getClientOptions() {
@@ -232,7 +287,9 @@ class MainResourceLoader::Impl {
     const std::shared_ptr<FileSource> localFileSource;
     const std::shared_ptr<FileSource> onlineFileSource;
     const std::shared_ptr<FileSource> mbtilesFileSource;
+#ifdef MLN_WITH_PMTILES
     const std::shared_ptr<FileSource> pmtilesFileSource;
+#endif
     const bool supportsCacheOnlyRequests_;
     const std::unique_ptr<util::Thread<MainResourceLoaderThread>> thread;
     mutable std::mutex resourceOptionsMutex;
@@ -241,6 +298,7 @@ class MainResourceLoader::Impl {
     ClientOptions clientOptions;
 };
 
+#ifdef MLN_WITH_PMTILES
 MainResourceLoader::MainResourceLoader(const ResourceOptions& resourceOptions, const ClientOptions& clientOptions)
     : impl(std::make_unique<Impl>(
           resourceOptions.clone(),
@@ -251,6 +309,17 @@ MainResourceLoader::MainResourceLoader(const ResourceOptions& resourceOptions, c
           FileSourceManager::get()->getFileSource(FileSourceType::Network, resourceOptions, clientOptions),
           FileSourceManager::get()->getFileSource(FileSourceType::Mbtiles, resourceOptions, clientOptions),
           FileSourceManager::get()->getFileSource(FileSourceType::Pmtiles, resourceOptions, clientOptions))) {}
+#else
+MainResourceLoader::MainResourceLoader(const ResourceOptions& resourceOptions, const ClientOptions& clientOptions)
+    : impl(std::make_unique<Impl>(
+          resourceOptions.clone(),
+          clientOptions.clone(),
+          FileSourceManager::get()->getFileSource(FileSourceType::Asset, resourceOptions, clientOptions),
+          FileSourceManager::get()->getFileSource(FileSourceType::Database, resourceOptions, clientOptions),
+          FileSourceManager::get()->getFileSource(FileSourceType::FileSystem, resourceOptions, clientOptions),
+          FileSourceManager::get()->getFileSource(FileSourceType::Network, resourceOptions, clientOptions),
+          FileSourceManager::get()->getFileSource(FileSourceType::Mbtiles, resourceOptions, clientOptions))) {}
+#endif
 
 MainResourceLoader::~MainResourceLoader() = default;
 

diff --git a/platform/linux/linux.cmake b/platform/linux/linux.cmake
@@ -50,7 +50,7 @@ target_sources(
         ${PROJECT_SOURCE_DIR}/platform/default/src/mbgl/storage/offline_database.cpp
         ${PROJECT_SOURCE_DIR}/platform/default/src/mbgl/storage/offline_download.cpp
         ${PROJECT_SOURCE_DIR}/platform/default/src/mbgl/storage/online_file_source.cpp
-        ${PROJECT_SOURCE_DIR}/platform/default/src/mbgl/storage/pmtiles_file_source.cpp
+        $<$<BOOL:${MLN_WITH_PMTILES}>:${PROJECT_SOURCE_DIR}/platform/default/src/mbgl/storage/pmtiles_file_source.cpp>
         ${PROJECT_SOURCE_DIR}/platform/default/src/mbgl/storage/sqlite3.cpp
         ${PROJECT_SOURCE_DIR}/platform/default/src/mbgl/text/bidi.cpp
         ${PROJECT_SOURCE_DIR}/platform/default/src/mbgl/text/local_glyph_rasterizer.cpp

diff --git a/platform/macos/macos.cmake b/platform/macos/macos.cmake
@@ -92,7 +92,7 @@ target_sources(
         ${PROJECT_SOURCE_DIR}/platform/default/src/mbgl/storage/offline_database.cpp
         ${PROJECT_SOURCE_DIR}/platform/default/src/mbgl/storage/offline_download.cpp
         ${PROJECT_SOURCE_DIR}/platform/default/src/mbgl/storage/online_file_source.cpp
-        ${PROJECT_SOURCE_DIR}/platform/default/src/mbgl/storage/pmtiles_file_source.cpp
+        $<$<BOOL:${MLN_WITH_PMTILES}>:${PROJECT_SOURCE_DIR}/platform/default/src/mbgl/storage/pmtiles_file_source.cpp>
         ${PROJECT_SOURCE_DIR}/platform/default/src/mbgl/storage/sqlite3.cpp
         ${PROJECT_SOURCE_DIR}/platform/default/src/mbgl/text/bidi.cpp
         ${PROJECT_SOURCE_DIR}/platform/default/src/mbgl/util/compression.cpp

diff --git a/platform/qt/qt.cmake b/platform/qt/qt.cmake
@@ -84,7 +84,7 @@ target_sources(
         ${PROJECT_SOURCE_DIR}/platform/default/src/mbgl/storage/offline_database.cpp
         ${PROJECT_SOURCE_DIR}/platform/default/src/mbgl/storage/offline_download.cpp
         ${PROJECT_SOURCE_DIR}/platform/default/src/mbgl/storage/online_file_source.cpp
-        ${PROJECT_SOURCE_DIR}/platform/default/src/mbgl/storage/pmtiles_file_source.cpp
+        $<$<BOOL:${MLN_WITH_PMTILES}>:${PROJECT_SOURCE_DIR}/platform/default/src/mbgl/storage/pmtiles_file_source.cpp>
         ${PROJECT_SOURCE_DIR}/platform/$<IF:$<BOOL:${MLN_QT_WITH_INTERNAL_SQLITE}>,default/src/mbgl/storage/sqlite3.cpp,qt/src/mbgl/sqlite3.cpp>
         ${PROJECT_SOURCE_DIR}/platform/default/src/mbgl/util/compression.cpp
         ${PROJECT_SOURCE_DIR}/platform/default/src/mbgl/util/filesystem.cpp

diff --git a/platform/windows/windows.cmake b/platform/windows/windows.cmake
@@ -51,7 +51,7 @@ target_sources(
         ${PROJECT_SOURCE_DIR}/platform/default/src/mbgl/storage/offline_database.cpp
         ${PROJECT_SOURCE_DIR}/platform/default/src/mbgl/storage/offline_download.cpp
         ${PROJECT_SOURCE_DIR}/platform/default/src/mbgl/storage/online_file_source.cpp
-        ${PROJECT_SOURCE_DIR}/platform/default/src/mbgl/storage/pmtiles_file_source.cpp
+        $<$<BOOL:${MLN_WITH_PMTILES}>:${PROJECT_SOURCE_DIR}/platform/default/src/mbgl/storage/pmtiles_file_source.cpp>
         ${PROJECT_SOURCE_DIR}/platform/default/src/mbgl/storage/sqlite3.cpp
         ${PROJECT_SOURCE_DIR}/platform/default/src/mbgl/text/bidi.cpp
         ${PROJECT_SOURCE_DIR}/platform/default/src/mbgl/text/local_glyph_rasterizer.cpp