Adapts last of the core/client classes to coding style. (#700)

Last classes and structures are now adapted to the coding style.
This also changes include headers in public headers to global scope
so that it can support better the pre-installed SDK.

Relates-to: OLPEDGE-567

Signed-off-by: Andrei Popescu <[email protected]>

Author: Andrei Popescu

olp-cpp-sdk-core/include/olp/core/client/OlpClientFactory.h

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2019 HERE Europe B.V.
+ * Copyright (C) 2019-2020 HERE Europe B.V.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -22,24 +22,21 @@
 #include <memory>
 #include <string>
 
-#include "OlpClientSettings.h"
-
 #include <olp/core/CoreApi.h>
 
 namespace olp {
-namespace client {
-class OlpClient;
-}
 
 /**
  * @brief The `client` namespace.
  */
 namespace client {
+class OlpClient;
+struct OlpClientSettings;
+
 /**
  * @brief Creates the `OlpClient` instances that are used for every HTTP
  * request.
  */
-
 class CORE_API OlpClientFactory {
  public:
   /**
@@ -53,5 +50,4 @@ class CORE_API OlpClientFactory {
 };
 
 }  // namespace client
-
 }  // namespace olp

olp-cpp-sdk-core/include/olp/core/client/OlpClientSettings.h

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2019 HERE Europe B.V.
+ * Copyright (C) 2019-2020 HERE Europe B.V.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -27,12 +27,11 @@
 #include <boost/optional.hpp>
 
 #include <olp/core/client/BackdownStrategy.h>
-#include "olp/core/client/CancellationToken.h"
-#include "olp/core/client/HttpResponse.h"
-#include "olp/core/http/Network.h"
+#include <olp/core/client/CancellationToken.h>
+#include <olp/core/client/HttpResponse.h>
+#include <olp/core/http/Network.h>
 
 namespace olp {
-
 namespace cache {
 class KeyValueCache;
 }  // namespace cache
@@ -46,13 +45,13 @@ class Network;
 }  // namespace http
 
 namespace client {
-
 /**
  * @brief The type alias of the asynchronous network callback.
  *
  * Used to receive the `HttpResponse` instance.
  */
 using NetworkAsyncCallback = std::function<void(HttpResponse)>;
+
 /**
  * @brief The type alias of the cancel function.
  *

olp-cpp-sdk-core/include/olp/core/client/TaskContext.h

@@ -102,9 +102,7 @@ class CORE_API TaskContext {
   }
 
  protected:
-  /**
-   * @brief A helper for unordered containers.
-   */
+  /// A helper for unordered containers.
   friend struct TaskContextHash;
 
   TaskContext() = default;
@@ -170,18 +168,11 @@ class CORE_API TaskContext {
   template <typename T>
   class TaskContextImpl : public Impl {
    public:
-    /**
-     * @brief Wraps the `T` typename in the API
-     * response.
-     */
+    /// Wraps the `T` typename in the API response.
     using Response = client::ApiResponse<T, client::ApiError>;
-    /**
-     * @brief The task that produces the `Response` instance.
-     */
+    /// The task that produces the `Response` instance.
     using ExecuteFunc = std::function<Response(client::CancellationContext)>;
-    /**
-     * @brief Consumes the `Response` instance.
-     */
+    /// Consumes the `Response` instance.
     using UserCallback = std::function<void(Response)>;
 
     /**
@@ -199,7 +190,7 @@ class CORE_API TaskContext {
           context_(std::move(context)),
           state_{State::PENDING} {}
 
-    ~TaskContextImpl() {}
+    ~TaskContextImpl() override{};
 
     /**
      * @brief Checks for the cancellation, executes the task, and calls
@@ -247,7 +238,6 @@ class CORE_API TaskContext {
       callback = nullptr;
 
       condition_.Notify();
-
       state_.store(State::COMPLETED);
     }
 
@@ -292,52 +282,30 @@ class CORE_API TaskContext {
      * @brief Indicates the state of the request.
      */
     enum class State {
-      /**
-       * @brief The request waits to be executed.
-       */
+      /// The request waits to be executed.
       PENDING,
-
-      /**
-       * @brief The request is being executed.
-       */
+      /// The request is being executed.
       IN_PROGRESS,
-
-      /**
-       * @brief The request execution finished.
-       */
+      /// The request execution finished.
       COMPLETED
     };
 
-    /**
-     * @brief The mutex lock used to protect from the concurrent read and write
-     * operations.
-     */
+    /// The mutex lock used to protect from the concurrent read and write
+    /// operations.
     std::mutex mutex_;
-    /**
-     * @brief The `ExecuteFunc` instance.
-     */
+    /// The `ExecuteFunc` instance.
     ExecuteFunc execute_func_;
-    /**
-     * @brief The `UserCallback` instance.
-     */
+    /// The `UserCallback` instance.
     UserCallback callback_;
-    /**
-     * @brief The `CancellationContext` instance.
-     */
+    /// The `CancellationContext` instance.
     client::CancellationContext context_;
-    /**
-     * @brief The `Condition` instance.
-     */
+    /// The `Condition` instance.
     client::Condition condition_;
-    /**
-     * @brief The `State` enum of the atomic type.
-     */
+    /// The `State` enum of the atomic type.
     std::atomic<State> state_;
   };
 
-  /**
-   * @brief The `Impl` instance.
-   */
+  /// The `Impl` instance.
   std::shared_ptr<Impl> impl_;
 };
 

olp-cpp-sdk-core/src/client/OlpClientFactory.cpp

@@ -20,15 +20,16 @@
 #include "olp/core/client/OlpClientFactory.h"
 
 #include "olp/core/client/OlpClient.h"
+#include "olp/core/client/OlpClientSettings.h"
 
 namespace olp {
 namespace client {
 
 std::shared_ptr<OlpClient> OlpClientFactory::Create(
     const OlpClientSettings& settings) {
-  auto olpClient = std::make_shared<OlpClient>();
-  olpClient->SetSettings(settings);
-  return olpClient;
+  auto olp_client = std::make_shared<OlpClient>();
+  olp_client->SetSettings(settings);
+  return olp_client;
 }
 
 }  // namespace client

olp-cpp-sdk-core/src/client/OlpClientSettings.cpp

@@ -17,8 +17,10 @@
  * License-Filename: LICENSE
  */
 
-#include <random>
 #include "olp/core/client/OlpClientSettings.h"
+
+#include <random>
+
 #include "olp/core/client/HttpResponse.h"
 #include "olp/core/http/HttpStatusCode.h"
 

olp-cpp-sdk-core/src/client/PendingRequests.cpp

@@ -17,7 +17,8 @@
  * License-Filename: LICENSE
  */
 
-#include <olp/core/client/PendingRequests.h>
+#include "olp/core/client/PendingRequests.h"
+
 #include <olp/core/client/TaskContext.h>
 #include <olp/core/logging/Log.h>
 

olp-cpp-sdk-core/src/client/Tokenizer.h

@@ -66,5 +66,6 @@ struct Tokenizer {
   size_t pos_{0};
   char sep_{'\0'};
 };
+
 }  // namespace client
 }  // namespace olp