Adapt core/utils classes to coding style. (#813)

All core/utils classes are now adapted to our coding style, except
some Windows specific code from Dir.cpp.

Relates-To: OLPEDGE-1854

Signed-off-by: Andrei Popescu <andrei.popescu@here.com>

Author: Andrei Popescu

olp-cpp-sdk-core/include/olp/core/utils/Base64.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.
@@ -28,37 +28,46 @@
 
 namespace olp {
 namespace utils {
+
 /**
- * @brief base64Encode encodes binary stream into base64 text
- * @param bytes data to be encoded
- * @return base64 encoded string
+ * @brief Encodes binary stream into base64 text.
+ *
+ * @param bytes Data to be encoded.
+ *
+ * @return Base64 encoded string.
  */
 CORE_API std::string Base64Encode(const std::vector<std::uint8_t>& bytes);
 
 /**
- * @brief base64Encode encodes binary stream into base64 text
- * @param bytes data to be encoded
- * @return base64 encoded string
+ * @brief Encodes binary stream into base64 text.
+ *
+ * @param bytes Data to be encoded.
+ *
+ * @return Base64 encoded string.
  */
 CORE_API std::string Base64Encode(const std::string& bytes);
 
 /**
- * @brief base64Encode encodes binary stream into base64 text
- * @param bytes data to be encoded
- * @param size The length of the bytes array
- * @return base64 encoded string
+ * @brief Encodes binary stream into base64 text.
+ *
+ * @param bytes Data to be encoded.
+ * @param size The length of the bytes array.
+ *
+ * @return Base64 encoded string.
  */
 CORE_API std::string Base64Encode(const void* bytes, size_t size);
 
 /**
- * @brief base64Decode decodes base64 into binary stream
- * @param[in] s base64 string to be decoded
- * @param[out] bytes vector containing decoded bytes
- * @param[in] write_null_bytes true if decoded null bytes should be written to
+ * @brief Decodes base64 into a binary stream.
+ *
+ * @param[in] string Base64 string to be decoded.
+ * @param[out] bytes Vector containing decoded bytes.
+ * @param[in] write_null_bytes True if decoded null bytes should be written to
  * the output, false otherwise. Default is true.
- * @return \c true if decoding was successful, false otherwise
+ *
+ * @return \c true if decoding was successful, \c false otherwise.
  */
-CORE_API bool Base64Decode(const std::string& s,
+CORE_API bool Base64Decode(const std::string& string,
                            std::vector<std::uint8_t>& bytes,
                            bool write_null_bytes = true);
 

olp-cpp-sdk-core/include/olp/core/utils/Dir.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.
@@ -29,36 +29,79 @@ namespace utils {
 class CORE_API Dir {
  public:
   /**
-   * @brief exists checks if directory exists
-   * @param path path of the directory
-   * @return true if directory exists, false otherwise.
+   * @brief Checks if directory exists.
+   *
+   * @param path Path of the directory.
+   *
+   * @return \c true if directory exists, \c false otherwise.
+   *
+   * @deprecated Will be removed by 10.2020. Please use Exists() instead.
    */
   static bool exists(const std::string& path);
 
   /**
-   * @brief remove removes the directory, deleting all subfolders and files.
-   * @param path path of the directory
+   * @brief Checks if directory exists.
+   *
+   * @param path Path of the directory.
+   *
+   * @return true if directory exists, false otherwise.
+   */
+  static bool Exists(const std::string& path);
+
+  /**
+   * @brief Removes the directory, deleting all subfolders and files.
+   *
+   * @param path Path of the directory.
+   *
    * @return true if operation is successfull, false otherwise.
+   *
+   *  @deprecated Will be removed by 10.2020. Please use Remove() instead.
    */
   static bool remove(const std::string& path);
 
   /**
-   * @brief create creates the directory including all required directories on
+   * @brief Removes the directory, deleting all subfolders and files.
+   *
+   * @param path Path of the directory.
+   *
+   * @return \c true if operation is successfull, \c false otherwise.
+   */
+  static bool Remove(const std::string& path);
+
+  /**
+   * @brief Creates the directory including all required directories on
    * the path.
-   * @param path path of the directory
-   * @return true if operation is successfull, false otherwise.
+   *
+   * @param path Path of the directory.
+   *
+   * @return \c true if operation is successfull, \c false otherwise.
+   *
+   * @deprecated Will be removed by 10.2020. Please use Create() instead.
    */
   static bool create(const std::string& path);
 
   /**
-   * @brief TempDirectory returns the platform-specific temporary path.
-   * @return temporary directory path
+   * @brief Creates the directory including all required directories on
+   * the path.
+   *
+   * @param path Path of the directory.
+   *
+   * @return \c true if operation is successfull, \c false otherwise.
+   */
+  static bool Create(const std::string& path);
+
+  /**
+   * @brief Returns the platform-specific temporary path.
+   *
+   * @return The platform specific temporary directory path.
    */
   static std::string TempDirectory();
 
   /**
-   * @brief Check whether file exists.
-   * @param[in] file_path Path to the file.
+   * @brief Check whether the provided file exists.
+   *
+   * @param file_path Path to the file.
+   *
    * @return \c true if any file with the given path exists, \c false otherwise.
    */
   static bool FileExists(const std::string& file_path);

olp-cpp-sdk-core/include/olp/core/utils/Url.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.
@@ -28,62 +28,43 @@
 
 namespace olp {
 namespace utils {
+
 /**
  * Class used for building and parsing Urls.
  */
 class CORE_API Url {
  public:
   /**
-   * Performs URL decoding on a given input string by replacing
+   * @brief Performs URL decoding on a given input string by replacing
    * percent-encoded characters with the actual ones.
    *
-   * @param in URL encoded string
-   * @return URL decoded result string
+   * @param in URL encoded string.
+   *
+   * @return URL decoded result string.
    */
   static std::string Decode(const std::string& in);
 
   /**
-   * Encodes a given input string by escaping non-ASCII characters.
+   * @brief Encodes a given input string by escaping non-ASCII characters.
+   *
+   * @param in URL string to be encoded.
    *
-   * @param in URL string to be encoded
-   * @return URL encoded result string
+   * @return URL encoded result string.
    */
   static std::string Encode(const std::string& in);
 
   /**
    * @brief Produces full URL from url base, path and query parameters.
+   *
    * @param base Base of the URL.
    * @param path Path part of the URL.
    * @param query_params Multipam of query parameters.
+   *
    * @return URL encoded result string.
    */
   static std::string Construct(
       const std::string& base, const std::string& path,
       const std::multimap<std::string, std::string>& query_params);
-
-  /** Parses input string and fills appropriate parts of url. Output strings are
-   * decoded */
-  static bool Parse(std::string url, std::string& scheme, std::string& userinfo,
-                    std::string& host, std::string& port, std::string& path,
-                    std::string& query, std::string& fragment);
-
- private:
-  /** Updates internal url as string from different parts, like scheme, host,
-   * port, etc. */
-  void UpdateUrl();
-
-  template <class TQueryItemsContainer>
-  void SetQueryItemsImpl(const TQueryItemsContainer& items);
-
-  std::string url_;
-
-  std::string scheme_;
-  std::string userinfo_;
-  std::string host_;
-  std::string port_;
-  std::string path_;
-  std::string query_;
-  std::string fragment_;
 };
 
 }  // namespace utils