Use std::optional if available. (#1628)

asopov-here · web-flow · commit ba2156c796b8 · 2025-08-11T10:00:10.000+02:00
Currently, SDK requires C++11 minimum.
So, boost::optional type is used for optional values.
For C++17 and above more convenient is to use std::optional instead.
The task NLAM-23 is about making this type configurable.
This commit is a renaming of the initially proposed "optional.hpp"
into optional.h to avoid clang-format header sorting issue.

Relates-To: NLAM-23

Signed-off-by: sopov &lt;ext-alexander.sopov@here.com&gt;
diff --git a/olp-cpp-sdk-authentication/include/olp/authentication/AuthenticationClient.h b/olp-cpp-sdk-authentication/include/olp/authentication/AuthenticationClient.h
@@ -36,7 +36,7 @@
 #include <olp/authentication/Types.h>
 #include <olp/core/client/ApiResponse.h>
 #include <olp/core/client/CancellationToken.h>
-#include <olp/core/porting/optional.hpp>
+#include <olp/core/porting/optional.h>
 
 /**
  * @brief Rules all the other namespaces.
diff --git a/olp-cpp-sdk-authentication/include/olp/authentication/AuthenticationCredentials.h b/olp-cpp-sdk-authentication/include/olp/authentication/AuthenticationCredentials.h
@@ -21,7 +21,7 @@
 
 #include <string>
 
-#include <olp/core/porting/optional.hpp>
+#include <olp/core/porting/optional.h>
 #include "AuthenticationApi.h"
 
 namespace olp {
diff --git a/olp-cpp-sdk-authentication/include/olp/authentication/AuthenticationSettings.h b/olp-cpp-sdk-authentication/include/olp/authentication/AuthenticationSettings.h
@@ -25,7 +25,7 @@
 #include <olp/authentication/AuthenticationApi.h>
 #include <olp/core/client/RetrySettings.h>
 #include <olp/core/http/NetworkProxySettings.h>
-#include <olp/core/porting/optional.hpp>
+#include <olp/core/porting/optional.h>
 
 namespace olp {
 namespace http {
diff --git a/olp-cpp-sdk-authentication/include/olp/authentication/AuthorizeRequest.h b/olp-cpp-sdk-authentication/include/olp/authentication/AuthorizeRequest.h
@@ -23,7 +23,7 @@
 #include <vector>
 
 #include <olp/authentication/AuthenticationApi.h>
-#include <olp/core/porting/optional.hpp>
+#include <olp/core/porting/optional.h>
 
 namespace olp {
 namespace authentication {
diff --git a/olp-cpp-sdk-authentication/include/olp/authentication/Settings.h b/olp-cpp-sdk-authentication/include/olp/authentication/Settings.h
@@ -24,8 +24,7 @@
 
 #include <olp/core/client/RetrySettings.h>
 #include <olp/core/http/NetworkProxySettings.h>
-#include <olp/core/porting/optional.hpp>
-
+#include <olp/core/porting/optional.h>
 #include "AuthenticationApi.h"
 #include "AuthenticationCredentials.h"
 
diff --git a/olp-cpp-sdk-authentication/include/olp/authentication/TokenResult.h b/olp-cpp-sdk-authentication/include/olp/authentication/TokenResult.h
@@ -23,7 +23,7 @@
 #include <ctime>
 #include <string>
 
-#include <olp/core/porting/optional.hpp>
+#include <olp/core/porting/optional.h>
 #include "AuthenticationApi.h"
 #include "ErrorResponse.h"
 
diff --git a/olp-cpp-sdk-authentication/src/TokenEndpointImpl.h b/olp-cpp-sdk-authentication/src/TokenEndpointImpl.h
@@ -29,7 +29,7 @@
 #include <olp/authentication/Types.h>
 #include <olp/core/client/CancellationContext.h>
 #include <olp/core/client/OlpClient.h>
-#include <olp/core/porting/optional.hpp>
+#include <olp/core/porting/optional.h>
 #include "TokenRequest.h"
 
 namespace olp {
diff --git a/olp-cpp-sdk-core/CMakeLists.txt b/olp-cpp-sdk-core/CMakeLists.txt
@@ -131,7 +131,7 @@ set(OLP_SDK_PORTING_HEADERS
     ./include/olp/core/porting/deprecated.h
     ./include/olp/core/porting/export.h
     ./include/olp/core/porting/make_unique.h
-    ./include/olp/core/porting/optional.hpp
+    ./include/olp/core/porting/optional.h
     ./include/olp/core/porting/platform.h
     ./include/olp/core/porting/shared_mutex.h
     ./include/olp/core/porting/try_emplace.h
diff --git a/olp-cpp-sdk-core/include/olp/core/cache/CacheSettings.h b/olp-cpp-sdk-core/include/olp/core/cache/CacheSettings.h
@@ -24,7 +24,7 @@
 
 #include <olp/core/Config.h>
 #include <olp/core/CoreApi.h>
-#include <olp/core/porting/optional.hpp>
+#include <olp/core/porting/optional.h>
 
 namespace olp {
 namespace cache {
diff --git a/olp-cpp-sdk-core/include/olp/core/cache/KeyGenerator.h b/olp-cpp-sdk-core/include/olp/core/cache/KeyGenerator.h
@@ -23,7 +23,7 @@
 
 #include <olp/core/CoreApi.h>
 #include <olp/core/geo/tiling/TileKey.h>
-#include <olp/core/porting/optional.hpp>
+#include <olp/core/porting/optional.h>
 
 namespace olp {
 namespace cache {
@@ -76,7 +76,8 @@ class CORE_API KeyGenerator {
    */
   static std::string CreatePartitionKey(
       const std::string& hrn, const std::string& layer_id,
-      const std::string& partition_id, const porting::optional<int64_t>& version);
+      const std::string& partition_id,
+      const porting::optional<int64_t>& version);
 
   /**
    * @brief Generates cache key for storing list of partitions.
@@ -113,11 +114,10 @@ class CORE_API KeyGenerator {
    *
    * @return A key used to store the quadtree in cache.
    */
-  static std::string CreateQuadTreeKey(const std::string& hrn,
-                                       const std::string& layer_id,
-                                       olp::geo::TileKey root,
-                                       const porting::optional<int64_t>& version,
-                                       int32_t depth);
+  static std::string CreateQuadTreeKey(
+      const std::string& hrn, const std::string& layer_id,
+      olp::geo::TileKey root, const porting::optional<int64_t>& version,
+      int32_t depth);
 
   /**
    * @brief Generates cache key for data handle entities.
diff --git a/olp-cpp-sdk-core/include/olp/core/client/OlpClientSettings.h b/olp-cpp-sdk-core/include/olp/core/client/OlpClientSettings.h
@@ -31,7 +31,7 @@
 #include <olp/core/client/OauthToken.h>
 #include <olp/core/client/RetrySettings.h>
 #include <olp/core/http/Network.h>
-#include <olp/core/porting/optional.hpp>
+#include <olp/core/porting/optional.h>
 
 namespace olp {
 namespace cache {
diff --git a/olp-cpp-sdk-core/include/olp/core/generated/parser/ParserWrapper.h b/olp-cpp-sdk-core/include/olp/core/generated/parser/ParserWrapper.h
@@ -24,7 +24,7 @@
 #include <string>
 #include <vector>
 
-#include <olp/core/porting/optional.hpp>
+#include <olp/core/porting/optional.h>
 #include <rapidjson/rapidjson.h>
 
 namespace olp {
diff --git a/olp-cpp-sdk-core/include/olp/core/generated/serializer/SerializerWrapper.h b/olp-cpp-sdk-core/include/olp/core/generated/serializer/SerializerWrapper.h
@@ -22,10 +22,10 @@
 #include <map>
 #include <memory>
 #include <string>
-#include <vector>
 #include <utility>
+#include <vector>
 
-#include <olp/core/porting/optional.hpp>
+#include <olp/core/porting/optional.h>
 #include <rapidjson/document.h>
 
 namespace olp {
diff --git a/olp-cpp-sdk-core/include/olp/core/geo/tiling/PathTiling.h b/olp-cpp-sdk-core/include/olp/core/geo/tiling/PathTiling.h
@@ -26,7 +26,7 @@
 #include <olp/core/geo/coordinates/GeoCoordinates.h>
 #include <olp/core/geo/tiling/TileKey.h>
 #include <olp/core/geo/tiling/TileKeyUtils.h>
-#include <olp/core/porting/optional.hpp>
+#include <olp/core/porting/optional.h>
 
 namespace olp {
 namespace geo {
diff --git a/olp-cpp-sdk-core/include/olp/core/geo/tiling/TileKey.h b/olp-cpp-sdk-core/include/olp/core/geo/tiling/TileKey.h
@@ -24,7 +24,7 @@
 #include <string>
 
 #include <olp/core/CoreApi.h>
-#include <olp/core/porting/optional.hpp>
+#include <olp/core/porting/optional.h>
 
 namespace olp {
 namespace geo {
@@ -46,12 +46,13 @@ namespace geo {
  * To create a tile key, use `FromRowColumnLevel()`.
  *
  * For vertical navigation within the tree, use the following functions:
- * `Parent()`, `ChangedLevelBy()`, and `ChangedLevelTo()`. To navigate within a level, use
- * the `HasNextRow()`, `NextRow()`, `HasNextColumn()`, and `NextColumn()` functions.
- * To get the number of available rows and columns on the tile level, use `RowCount()` and
- * `ColumnCount()`.
+ * `Parent()`, `ChangedLevelBy()`, and `ChangedLevelTo()`. To navigate within a
+ * level, use the `HasNextRow()`, `NextRow()`, `HasNextColumn()`, and
+ * `NextColumn()` functions. To get the number of available rows and columns on
+ * the tile level, use `RowCount()` and `ColumnCount()`.
  *
- * You can also create tile keys from and converted them into various alternative formats:
+ * You can also create tile keys from and converted them into various
+ * alternative formats:
  *
  *  - `ToQuadKey()` / `FromQuadKey()` – 4-based string representation.
  *
@@ -121,7 +122,8 @@ class CORE_API TileKey {
   }
 
   /**
-   * @brief Creates a quad string from a tile key to later use it in REST API calls.
+   * @brief Creates a quad string from a tile key to later use it in REST API
+   * calls.
    *
    * If the tile is the root tile, the quadkey is '-'.
    * Otherwise, the string is a number to the base of 4 without the leading
@@ -142,11 +144,13 @@ class CORE_API TileKey {
   static TileKey FromQuadKey(const std::string& quad_key);
 
   /**
-   * @brief Creates a HERE tile code string from a tile key to later use it in REST API calls.
+   * @brief Creates a HERE tile code string from a tile key to later use it in
+   * REST API calls.
    *
    * The string is a quadkey Morton code.
    *
-   * To convert the HERE tile code string back into the tile key, use `FromHereTile()`.
+   * To convert the HERE tile code string back into the tile key, use
+   * `FromHereTile()`.
    */
   std::string ToHereTile() const;
 
@@ -160,7 +164,8 @@ class CORE_API TileKey {
   /**
    * @brief Creates a 64-bit Morton code from a tile key.
    *
-   * To convert the 64-bit Morton code back into the tile key, use `FromQuadKey64()`.
+   * To convert the 64-bit Morton code back into the tile key, use
+   * `FromQuadKey64()`.
    */
   std::uint64_t ToQuadKey64() const;
 
@@ -174,7 +179,8 @@ class CORE_API TileKey {
   /**
    * @brief Creates a tile key.
    *
-   * @param row The requested row. Must be less than 2 to the power of the level.
+   * @param row The requested row. Must be less than 2 to the power of the
+   * level.
    * @param column The requested column. Must be less than 2 to the power of
    * the level.
    * @param level The requested level.
diff --git a/olp-cpp-sdk-core/include/olp/core/http/NetworkResponse.h b/olp-cpp-sdk-core/include/olp/core/http/NetworkResponse.h
@@ -26,7 +26,7 @@
 
 #include <olp/core/CoreApi.h>
 #include <olp/core/http/NetworkTypes.h>
-#include <olp/core/porting/optional.hpp>
+#include <olp/core/porting/optional.h>
 
 namespace olp {
 namespace http {
diff --git a/olp-cpp-sdk-core/include/olp/core/logging/FilterGroup.h b/olp-cpp-sdk-core/include/olp/core/logging/FilterGroup.h
@@ -26,7 +26,7 @@
 
 #include <olp/core/CoreApi.h>
 #include <olp/core/logging/Level.h>
-#include <olp/core/porting/optional.hpp>
+#include <olp/core/porting/optional.h>
 
 namespace olp {
 namespace logging {
@@ -54,7 +54,8 @@ class CORE_API FilterGroup {
   /**
    * @brief Gets the default log level.
    *
-   * @return The default log level or `olp::porting::none` if the level is not set.
+   * @return The default log level or `olp::porting::none` if the level is not
+   * set.
    */
   inline porting::optional<Level> getLevel() const;
 
@@ -78,7 +79,8 @@ class CORE_API FilterGroup {
    *
    * @param tag The tag for which to get the log level.
    *
-   * @return The log level for the tag, or `olp::porting::none` if the level is not set.
+   * @return The log level for the tag, or `olp::porting::none` if the level is
+   * not set.
    */
   inline porting::optional<Level> getLevel(const std::string& tag) const;
 
@@ -184,7 +186,8 @@ inline FilterGroup& FilterGroup::clearLevel() {
 inline porting::optional<Level> FilterGroup::getLevel(
     const std::string& tag) const {
   auto foundIter = m_tagLevels.find(tag);
-  if (foundIter == m_tagLevels.end()) return porting::none;
+  if (foundIter == m_tagLevels.end())
+    return porting::none;
   return foundIter->second;
 }
 
diff --git a/olp-cpp-sdk-core/include/olp/core/logging/Log.h b/olp-cpp-sdk-core/include/olp/core/logging/Log.h
@@ -28,7 +28,7 @@
 #include <olp/core/logging/Level.h>
 
 #include <olp/core/CoreApi.h>
-#include <olp/core/porting/optional.hpp>
+#include <olp/core/porting/optional.h>
 #include <olp/core/utils/WarningWorkarounds.h>
 
 /**
diff --git a/olp-cpp-sdk-core/include/olp/core/porting/optional.h b/olp-cpp-sdk-core/include/olp/core/porting/optional.h
diff --git a/olp-cpp-sdk-core/include/olp/core/utils/Url.h b/olp-cpp-sdk-core/include/olp/core/utils/Url.h
@@ -25,7 +25,7 @@
 #include <vector>
 
 #include <olp/core/CoreApi.h>
-#include <olp/core/porting/optional.hpp>
+#include <olp/core/porting/optional.h>
 
 namespace olp {
 namespace utils {
@@ -81,7 +81,8 @@ class CORE_API Url {
    * @return An optional pair representing host part and the rest of URL.
    * Returns olp::porting::none when url cannot be split.
    */
-  static porting::optional<HostAndRest> ParseHostAndRest(const std::string& url);
+  static porting::optional<HostAndRest> ParseHostAndRest(
+      const std::string& url);
 };
 
 }  // namespace utils
diff --git a/olp-cpp-sdk-core/src/client/api/PlatformApi.h b/olp-cpp-sdk-core/src/client/api/PlatformApi.h
@@ -25,7 +25,7 @@
 #include <olp/core/client/ApiError.h>
 #include <olp/core/client/ApiResponse.h>
 #include <olp/core/client/model/Api.h>
-#include <olp/core/porting/optional.hpp>
+#include <olp/core/porting/optional.h>
 
 namespace olp {
 namespace client {
diff --git a/olp-cpp-sdk-core/src/client/api/ResourcesApi.h b/olp-cpp-sdk-core/src/client/api/ResourcesApi.h
@@ -25,7 +25,7 @@
 #include <olp/core/client/ApiError.h>
 #include <olp/core/client/ApiResponse.h>
 #include <olp/core/client/model/Api.h>
-#include <olp/core/porting/optional.hpp>
+#include <olp/core/porting/optional.h>
 
 namespace olp {
 namespace client {
diff --git a/olp-cpp-sdk-core/src/client/repository/ApiCacheRepository.h b/olp-cpp-sdk-core/src/client/repository/ApiCacheRepository.h
@@ -24,7 +24,7 @@
 #include <string>
 
 #include <olp/core/client/HRN.h>
-#include <olp/core/porting/optional.hpp>
+#include <olp/core/porting/optional.h>
 
 namespace olp {
 namespace cache {
@@ -44,7 +44,7 @@ class ApiCacheRepository final {
            const std::string& url, porting::optional<time_t> expiry);
 
   porting::optional<std::string> Get(const std::string& service,
-                                   const std::string& version);
+                                     const std::string& version);
 
  private:
   std::string hrn_;
diff --git a/olp-cpp-sdk-core/src/http/curl/NetworkCurl.h b/olp-cpp-sdk-core/src/http/curl/NetworkCurl.h
@@ -31,7 +31,7 @@
 #include <thread>
 #include <vector>
 
-#include <olp/core/porting/optional.hpp>
+#include <olp/core/porting/optional.h>
 
 #if defined(OLP_SDK_ENABLE_ANDROID_CURL) && !defined(ANDROID_HOST)
 #include <openssl/ossl_typ.h>
diff --git a/olp-cpp-sdk-dataservice-write/include/olp/dataservice/write/generated/model/Index.h b/olp-cpp-sdk-dataservice-write/include/olp/dataservice/write/generated/model/Index.h
@@ -24,8 +24,7 @@
 #include <string>
 #include <utility>
 
-#include <olp/core/porting/optional.hpp>
-
+#include <olp/core/porting/optional.h>
 #include <olp/dataservice/write/DataServiceWriteApi.h>
 
 namespace olp {
diff --git a/olp-cpp-sdk-dataservice-write/include/olp/dataservice/write/generated/model/Publication.h b/olp-cpp-sdk-dataservice-write/include/olp/dataservice/write/generated/model/Publication.h
@@ -22,8 +22,7 @@
 #include <string>
 #include <vector>
 
-#include <olp/core/porting/optional.hpp>
-
+#include <olp/core/porting/optional.h>
 #include <olp/dataservice/write/DataServiceWriteApi.h>
 #include <olp/dataservice/write/generated/model/Details.h>
 #include <olp/dataservice/write/generated/model/VersionDependency.h>
diff --git a/olp-cpp-sdk-dataservice-write/include/olp/dataservice/write/model/PublishDataRequest.h b/olp-cpp-sdk-dataservice-write/include/olp/dataservice/write/model/PublishDataRequest.h
@@ -24,8 +24,7 @@
 #include <utility>
 #include <vector>
 
-#include <olp/core/porting/optional.hpp>
-
+#include <olp/core/porting/optional.h>
 #include <olp/dataservice/write/DataServiceWriteApi.h>
 
 namespace olp {
diff --git a/olp-cpp-sdk-dataservice-write/include/olp/dataservice/write/model/PublishIndexRequest.h b/olp-cpp-sdk-dataservice-write/include/olp/dataservice/write/model/PublishIndexRequest.h
@@ -24,8 +24,7 @@
 #include <utility>
 #include <vector>
 
-#include <olp/core/porting/optional.hpp>
-
+#include <olp/core/porting/optional.h>
 #include <olp/dataservice/write/DataServiceWriteApi.h>
 #include <olp/dataservice/write/generated/model/Index.h>
 
diff --git a/olp-cpp-sdk-dataservice-write/include/olp/dataservice/write/model/PublishPartitionDataRequest.h b/olp-cpp-sdk-dataservice-write/include/olp/dataservice/write/model/PublishPartitionDataRequest.h
diff --git a/olp-cpp-sdk-dataservice-write/include/olp/dataservice/write/model/PublishSdiiRequest.h b/olp-cpp-sdk-dataservice-write/include/olp/dataservice/write/model/PublishSdiiRequest.h
diff --git a/olp-cpp-sdk-dataservice-write/include/olp/dataservice/write/model/StartBatchRequest.h b/olp-cpp-sdk-dataservice-write/include/olp/dataservice/write/model/StartBatchRequest.h
diff --git a/olp-cpp-sdk-dataservice-write/include/olp/dataservice/write/model/UpdateIndexRequest.h b/olp-cpp-sdk-dataservice-write/include/olp/dataservice/write/model/UpdateIndexRequest.h
diff --git a/olp-cpp-sdk-dataservice-write/src/StreamLayerClientImpl.h b/olp-cpp-sdk-dataservice-write/src/StreamLayerClientImpl.h
diff --git a/olp-cpp-sdk-dataservice-write/src/generated/ConfigApi.h b/olp-cpp-sdk-dataservice-write/src/generated/ConfigApi.h
diff --git a/olp-cpp-sdk-dataservice-write/src/generated/IngestApi.h b/olp-cpp-sdk-dataservice-write/src/generated/IngestApi.h
diff --git a/olp-cpp-sdk-dataservice-write/src/generated/MetadataApi.h b/olp-cpp-sdk-dataservice-write/src/generated/MetadataApi.h
diff --git a/olp-cpp-sdk-dataservice-write/src/generated/QueryApi.h b/olp-cpp-sdk-dataservice-write/src/generated/QueryApi.h
diff --git a/olp-cpp-sdk-dataservice-write/src/generated/model/Partitions.h b/olp-cpp-sdk-dataservice-write/src/generated/model/Partitions.h
diff --git a/olp-cpp-sdk-dataservice-write/src/generated/model/PublishPartition.h b/olp-cpp-sdk-dataservice-write/src/generated/model/PublishPartition.h
diff --git a/olp-cpp-sdk-dataservice-write/src/generated/model/PublishPartitions.h b/olp-cpp-sdk-dataservice-write/src/generated/model/PublishPartitions.h
