Include headers explicitly and add constructors to comply C++20 (minio#116)

* Added constructors to become C++20
* fixed: implementation details leak in headers

Author: HJLebbink

.gitattributes

@@ -0,0 +1,5 @@
+# Set the default behavior, in case people don't have core.autocrlf set.
+* text=auto
+
+# Declare files that will always have LF line endings on checkout.
+*.sh test eol=lf

examples/PutObject.cc

@@ -13,7 +13,16 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+#include <fstream>
+#include <iosfwd>
+#include <iostream>
+#include <ostream>
+
+#include "args.h"
 #include "client.h"
+#include "providers.h"
+#include "request.h"
+#include "response.h"
 
 int main() {
   // Create S3 base URL.

examples/PutObjectProgress.cc

@@ -13,7 +13,17 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+#include <fstream>
+#include <iosfwd>
+#include <iostream>
+#include <ostream>
+
+#include "args.h"
 #include "client.h"
+#include "http.h"
+#include "providers.h"
+#include "request.h"
+#include "response.h"
 
 int main() {
   // Create S3 base URL.

include/args.h

@@ -16,10 +16,17 @@
 #ifndef _MINIO_S3_ARGS_H
 #define _MINIO_S3_ARGS_H
 
+#include <functional>
+#include <list>
+#include <map>
+#include <string>
+#include <type_traits>
+
+#include "error.h"
 #include "http.h"
-#include "signer.h"
 #include "sse.h"
 #include "types.h"
+#include "utils.h"
 
 namespace minio {
 namespace s3 {

include/baseclient.h

@@ -16,11 +16,18 @@
 #ifndef _MINIO_S3_BASE_CLIENT_H
 #define _MINIO_S3_BASE_CLIENT_H
 
+#include <map>
+#include <string>
+#include <type_traits>
+
 #include "args.h"
 #include "config.h"
+#include "error.h"
+#include "http.h"
+#include "providers.h"
 #include "request.h"
 #include "response.h"
-#include "select.h"
+#include "utils.h"
 
 namespace minio {
 namespace s3 {

include/client.h

@@ -16,11 +16,13 @@
 #ifndef _MINIO_S3_CLIENT_H
 #define _MINIO_S3_CLIENT_H
 
-#include <fstream>
+#include <list>
+#include <string>
 
 #include "args.h"
 #include "baseclient.h"
-#include "config.h"
+#include "error.h"
+#include "providers.h"
 #include "request.h"
 #include "response.h"
 

include/credentials.h

@@ -16,6 +16,10 @@
 #ifndef _MINIO_CREDS_CREDENTIALS_H
 #define _MINIO_CREDS_CREDENTIALS_H
 
+#include <string>
+#include <type_traits>
+
+#include "error.h"
 #include "utils.h"
 
 namespace minio {
@@ -34,6 +38,30 @@ struct Credentials {
   utils::UtcTime expiration = {};
 
   Credentials() = default;
+  explicit Credentials(error::Error err) : err(std::move(err)) {}
+
+  explicit Credentials(error::Error err, std::string access_key,
+                       std::string secret_key)
+      : err(std::move(err)),
+        access_key(std::move(access_key)),
+        secret_key(std::move(secret_key)) {}
+
+  explicit Credentials(error::Error err, std::string access_key,
+                       std::string secret_key, std::string session_token)
+      : err(std::move(err)),
+        access_key(std::move(access_key)),
+        secret_key(std::move(secret_key)),
+        session_token(std::move(session_token)) {}
+
+  explicit Credentials(error::Error err, std::string access_key,
+                       std::string secret_key, std::string session_token,
+                       utils::UtcTime expiration)
+      : err(std::move(err)),
+        access_key(std::move(access_key)),
+        secret_key(std::move(secret_key)),
+        session_token(std::move(session_token)),
+        expiration(std::move(expiration)) {}
+
   ~Credentials() = default;
 
   bool IsExpired() const { return expired(expiration); }

include/error.h

@@ -18,6 +18,7 @@
 
 #include <ostream>
 #include <string>
+#include <type_traits>
 
 namespace minio {
 namespace error {
@@ -32,9 +33,9 @@ class Error {
   Error(const Error&) = default;
   Error& operator=(const Error&) = default;
 
-  Error(Error&& v) : msg_(std::move(v.msg_)) {}
+  Error(Error&& v) noexcept : msg_(std::move(v.msg_)) {}
 
-  Error& operator=(Error&& v) {
+  Error& operator=(Error&& v) noexcept {
     if (this != &v) {
       msg_ = std::move(v.msg_);
     }

include/http.h

@@ -16,16 +16,15 @@
 #ifndef _MINIO_HTTP_H
 #define _MINIO_HTTP_H
 
-#ifdef _WIN32
-#include <ws2tcpip.h>
-#else
-#include <arpa/inet.h>
-#endif
-
 #include <curlpp/Easy.hpp>
 #include <curlpp/Multi.hpp>
-#include <curlpp/Options.hpp>
+#include <exception>
+#include <functional>
+#include <iostream>
+#include <string>
+#include <type_traits>
 
+#include "error.h"
 #include "utils.h"
 
 namespace minio {
@@ -65,6 +64,13 @@ struct Url {
   std::string query_string;
 
   Url() = default;
+  explicit Url(bool https, std::string host, unsigned int port,
+               std::string path, std::string query_string)
+      : https(https),
+        host(std::move(host)),
+        port(port),
+        path(std::move(path)),
+        query_string(std::move(query_string)) {}
   ~Url() = default;
 
   explicit operator bool() const { return !host.empty(); }
@@ -91,6 +97,16 @@ struct DataFunctionArgs {
   void* userdata = nullptr;
 
   DataFunctionArgs() = default;
+  explicit DataFunctionArgs(curlpp::Easy* handle, Response* response,
+                            void* userdata)
+      : handle(handle), response(response), userdata(userdata) {}
+  explicit DataFunctionArgs(curlpp::Easy* handle, Response* response,
+                            std::string datachunk, void* userdata)
+      : handle(handle),
+        response(response),
+        datachunk(std::move(datachunk)),
+        userdata(userdata) {}
+
   ~DataFunctionArgs() = default;
 };  // struct DataFunctionArgs
 

include/providers.h

@@ -16,11 +16,13 @@
 #ifndef _MINIO_CREDS_PROVIDERS_H
 #define _MINIO_CREDS_PROVIDERS_H
 
-#include <sys/types.h>
-
+#include <functional>
+#include <list>
 #include <string>
+#include <type_traits>
 
 #include "credentials.h"
+#include "error.h"
 #include "http.h"
 
 #define DEFAULT_DURATION_SECONDS (60 * 60 * 24)  // 1 day.
@@ -34,6 +36,8 @@ struct Jwt {
   unsigned int expiry = 0;
 
   Jwt() = default;
+  explicit Jwt(std::string token, unsigned int expiry)
+      : token(std::move(token)), expiry(expiry) {}
   ~Jwt() = default;
 
   explicit operator bool() const { return !token.empty(); }

include/request.h

@@ -16,9 +16,13 @@
 #ifndef _MINIO_REQUEST_H
 #define _MINIO_REQUEST_H
 
-#include "credentials.h"
+#include <regex>
+#include <string>
+
+#include "error.h"
+#include "http.h"
 #include "providers.h"
-#include "signer.h"
+#include "utils.h"
 
 namespace minio {
 namespace s3 {

include/response.h

@@ -16,9 +16,14 @@
 #ifndef _MINIO_S3_RESPONSE_H
 #define _MINIO_S3_RESPONSE_H
 
-#include <pugixml.hpp>
+#include <list>
+#include <map>
+#include <string>
+#include <type_traits>
 
+#include "error.h"
 #include "types.h"
+#include "utils.h"
 
 namespace minio {
 namespace s3 {

include/select.h

@@ -16,8 +16,11 @@
 #ifndef _MINIO_S3_SELECT_H
 #define _MINIO_S3_SELECT_H
 
-#include <pugixml.hpp>
+#include <map>
+#include <string>
+#include <type_traits>
 
+#include "error.h"
 #include "http.h"
 #include "types.h"
 

include/signer.h

@@ -16,9 +16,10 @@
 #ifndef _MINIO_SIGNER_H
 #define _MINIO_SIGNER_H
 
-#include <openssl/hmac.h>
+#include <string>
 
 #include "http.h"
+#include "utils.h"
 
 namespace minio {
 namespace signer {

include/sse.h

@@ -16,6 +16,8 @@
 #ifndef _MINIO_S3_SSE_H
 #define _MINIO_S3_SSE_H
 
+#include <string>
+
 #include "utils.h"
 
 namespace minio {

include/types.h

@@ -16,10 +16,17 @@
 #ifndef _MINIO_S3_TYPES_H
 #define _MINIO_S3_TYPES_H
 
+#include <exception>
+#include <functional>
 #include <iostream>
-#include <nlohmann/json.hpp>
+#include <list>
+#include <map>
+#include <nlohmann/json_fwd.hpp>
 #include <ostream>
+#include <string>
+#include <type_traits>
 
+#include "error.h"
 #include "utils.h"
 
 namespace minio {
@@ -310,6 +317,8 @@ struct Bucket {
   utils::UtcTime creation_date;
 
   Bucket() = default;
+  explicit Bucket(std::string name, utils::UtcTime creation_date)
+      : name(std::move(name)), creation_date(std::move(creation_date)) {}
   ~Bucket() = default;
 };  // struct Bucket
 
@@ -320,6 +329,8 @@ struct Part {
   size_t size = 0;
 
   Part() = default;
+  explicit Part(unsigned int number, std::string etag)
+      : number(number), etag(std::move(etag)) {}
   ~Part() = default;
 };  // struct Part
 

include/utils.h

@@ -20,34 +20,23 @@
 #include <pwd.h>
 #endif
 
-#include <openssl/buffer.h>
-#include <openssl/evp.h>
-#include <sys/types.h>
-#include <zlib.h>
-
-#include <array>
-#include <chrono>
-#include <cmath>
-#include <cstring>
 #include <ctime>
-#include <curlpp/cURLpp.hpp>
-#include <iomanip>
-#include <iostream>
+#include <ios>
 #include <list>
 #include <map>
-#include <ostream>
-#include <regex>
 #include <set>
-#include <sstream>
+#include <streambuf>
+#include <string>
+#include <vector>
 
 #include "error.h"
 
 namespace minio {
 namespace utils {
-inline constexpr unsigned int kMaxMultipartCount = 10000;  // 10000 parts
-inline constexpr unsigned long long kMaxObjectSize = 5497558138880ULL;  // 5TiB
-inline constexpr unsigned long long kMaxPartSize = 5368709120UL;        // 5GiB
-inline constexpr unsigned int kMinPartSize = 5 * 1024 * 1024;           // 5MiB
+inline constexpr unsigned int kMaxMultipartCount = 10000;      // 10000 parts
+inline constexpr uint64_t kMaxObjectSize = 5'497'558'138'880;  // 5TiB
+inline constexpr uint64_t kMaxPartSize = 5'368'709'120;        // 5GiB
+inline constexpr unsigned int kMinPartSize = 5 * 1024 * 1024;  // 5MiB
 
 // GetEnv copies the environment variable name into var
 bool GetEnv(std::string& var, const char* name);
@@ -72,7 +61,7 @@ inline const char* BoolToString(bool b) { return b ? "true" : "false"; }
 // Trim trims leading and trailing character of a string.
 std::string Trim(std::string_view str, char ch = ' ');
 
-// CheckNonemptystring checks whether string is not empty after trimming
+// CheckNonEmptyString checks whether string is not empty after trimming
 // whitespaces.
 bool CheckNonEmptyString(std::string_view str);