diff options
author | Jack Lloyd <[email protected]> | 2017-09-30 11:28:02 -0400 |
---|---|---|
committer | Jack Lloyd <[email protected]> | 2017-09-30 11:28:02 -0400 |
commit | f6dc3db8bb7e31569ed1a6042771e3f529aefab8 (patch) | |
tree | 9604495c046e1e52cc1d8e552879f04fe8599631 /src/lib/utils | |
parent | e6dfcaa00d82a2fff5973bd2721dc09562d64199 (diff) |
Use class instead of struct for objects with member functions
Flagged by Sonar and quite reasonable
Diffstat (limited to 'src/lib/utils')
-rw-r--r-- | src/lib/utils/calendar.h | 71 | ||||
-rw-r--r-- | src/lib/utils/exceptn.h | 174 | ||||
-rw-r--r-- | src/lib/utils/http_util/http_util.h | 11 |
3 files changed, 137 insertions, 119 deletions
diff --git a/src/lib/utils/calendar.h b/src/lib/utils/calendar.h index 5cf59eccc..665022599 100644 --- a/src/lib/utils/calendar.h +++ b/src/lib/utils/calendar.h @@ -18,50 +18,51 @@ namespace Botan { /** * Struct representing a particular date and time */ -struct BOTAN_PUBLIC_API(2,0) calendar_point +class BOTAN_PUBLIC_API(2,0) calendar_point { - /** The year */ - uint32_t year; + public: + /** The year */ + uint32_t year; - /** The month, 1 through 12 for Jan to Dec */ - uint32_t month; + /** The month, 1 through 12 for Jan to Dec */ + uint32_t month; - /** The day of the month, 1 through 31 (or 28 or 30 based on month */ - uint32_t day; + /** The day of the month, 1 through 31 (or 28 or 30 based on month */ + uint32_t day; - /** Hour in 24-hour form, 0 to 23 */ - uint32_t hour; + /** Hour in 24-hour form, 0 to 23 */ + uint32_t hour; - /** Minutes in the hour, 0 to 60 */ - uint32_t minutes; + /** Minutes in the hour, 0 to 60 */ + uint32_t minutes; - /** Seconds in the minute, 0 to 60, but might be slightly - larger to deal with leap seconds on some systems - */ - uint32_t seconds; + /** Seconds in the minute, 0 to 60, but might be slightly + larger to deal with leap seconds on some systems + */ + uint32_t seconds; - /** - * Initialize a calendar_point - * @param y the year - * @param mon the month - * @param d the day - * @param h the hour - * @param min the minute - * @param sec the second - */ - calendar_point(uint32_t y, uint32_t mon, uint32_t d, uint32_t h, uint32_t min, uint32_t sec) : - year(y), month(mon), day(d), hour(h), minutes(min), seconds(sec) {} + /** + * Initialize a calendar_point + * @param y the year + * @param mon the month + * @param d the day + * @param h the hour + * @param min the minute + * @param sec the second + */ + calendar_point(uint32_t y, uint32_t mon, uint32_t d, uint32_t h, uint32_t min, uint32_t sec) : + year(y), month(mon), day(d), hour(h), minutes(min), seconds(sec) {} - /** - * Returns an STL timepoint object - */ - std::chrono::system_clock::time_point to_std_timepoint() const; + /** + * Returns an STL timepoint object + */ + std::chrono::system_clock::time_point to_std_timepoint() const; - /** - * Returns a human readable string of the struct's components. - * Formatting might change over time. Currently it is RFC339 'iso-date-time'. - */ - std::string to_string() const; + /** + * Returns a human readable string of the struct's components. + * Formatting might change over time. Currently it is RFC339 'iso-date-time'. + */ + std::string to_string() const; }; /** diff --git a/src/lib/utils/exceptn.h b/src/lib/utils/exceptn.h index 5242e87d9..e5432e43b 100644 --- a/src/lib/utils/exceptn.h +++ b/src/lib/utils/exceptn.h @@ -49,202 +49,218 @@ class BOTAN_PUBLIC_API(2,0) Invalid_Argument : public Exception * An argument that is invalid because it is not supported by Botan. * It might or might not be valid in another context like a standard. */ -struct BOTAN_PUBLIC_API(2,0) Unsupported_Argument final : public Invalid_Argument +class BOTAN_PUBLIC_API(2,0) Unsupported_Argument final : public Invalid_Argument { - explicit Unsupported_Argument(const std::string& msg) : Invalid_Argument(msg) {} + public: + explicit Unsupported_Argument(const std::string& msg) : Invalid_Argument(msg) {} }; /** * Invalid_State Exception */ -struct BOTAN_PUBLIC_API(2,0) Invalid_State : public Exception +class BOTAN_PUBLIC_API(2,0) Invalid_State : public Exception { - explicit Invalid_State(const std::string& err) : - Exception(err) - {} + public: + explicit Invalid_State(const std::string& err) : Exception(err) {} }; /** * Lookup_Error Exception */ -struct BOTAN_PUBLIC_API(2,0) Lookup_Error : public Exception +class BOTAN_PUBLIC_API(2,0) Lookup_Error : public Exception { - explicit Lookup_Error(const std::string& err) : - Exception(err) - {} + public: + explicit Lookup_Error(const std::string& err) : Exception(err) {} - Lookup_Error(const std::string& type, - const std::string& algo, - const std::string& provider) : - Exception("Unavailable " + type + " " + algo + - (provider.empty() ? std::string("") : (" for provider " + provider))) - {} + Lookup_Error(const std::string& type, + const std::string& algo, + const std::string& provider) : + Exception("Unavailable " + type + " " + algo + + (provider.empty() ? std::string("") : (" for provider " + provider))) + {} }; /** * Internal_Error Exception */ -struct BOTAN_PUBLIC_API(2,0) Internal_Error : public Exception +class BOTAN_PUBLIC_API(2,0) Internal_Error : public Exception { - explicit Internal_Error(const std::string& err) : - Exception("Internal error: " + err) - {} + public: + explicit Internal_Error(const std::string& err) : + Exception("Internal error: " + err) + {} }; /** * Invalid_Key_Length Exception */ -struct BOTAN_PUBLIC_API(2,0) Invalid_Key_Length final : public Invalid_Argument +class BOTAN_PUBLIC_API(2,0) Invalid_Key_Length final : public Invalid_Argument { - Invalid_Key_Length(const std::string& name, size_t length) : - Invalid_Argument(name + " cannot accept a key of length " + - std::to_string(length)) - {} + public: + Invalid_Key_Length(const std::string& name, size_t length) : + Invalid_Argument(name + " cannot accept a key of length " + + std::to_string(length)) + {} }; /** * Invalid_IV_Length Exception */ -struct BOTAN_PUBLIC_API(2,0) Invalid_IV_Length final : public Invalid_Argument +class BOTAN_PUBLIC_API(2,0) Invalid_IV_Length final : public Invalid_Argument { - Invalid_IV_Length(const std::string& mode, size_t bad_len) : - Invalid_Argument("IV length " + std::to_string(bad_len) + - " is invalid for " + mode) - {} + public: + Invalid_IV_Length(const std::string& mode, size_t bad_len) : + Invalid_Argument("IV length " + std::to_string(bad_len) + + " is invalid for " + mode) + {} }; /** * PRNG_Unseeded Exception */ -struct BOTAN_PUBLIC_API(2,0) PRNG_Unseeded final : public Invalid_State +class BOTAN_PUBLIC_API(2,0) PRNG_Unseeded final : public Invalid_State { - explicit PRNG_Unseeded(const std::string& algo) : - Invalid_State("PRNG not seeded: " + algo) - {} + public: + explicit PRNG_Unseeded(const std::string& algo) : + Invalid_State("PRNG not seeded: " + algo) + {} }; /** * Policy_Violation Exception */ -struct BOTAN_PUBLIC_API(2,0) Policy_Violation final : public Invalid_State +class BOTAN_PUBLIC_API(2,0) Policy_Violation final : public Invalid_State { - explicit Policy_Violation(const std::string& err) : - Invalid_State("Policy violation: " + err) - {} + public: + explicit Policy_Violation(const std::string& err) : + Invalid_State("Policy violation: " + err) + {} }; /** * Algorithm_Not_Found Exception */ -struct BOTAN_PUBLIC_API(2,0) Algorithm_Not_Found final : public Lookup_Error +class BOTAN_PUBLIC_API(2,0) Algorithm_Not_Found final : public Lookup_Error { - explicit Algorithm_Not_Found(const std::string& name) : - Lookup_Error("Could not find any algorithm named \"" + name + "\"") - {} + public: + explicit Algorithm_Not_Found(const std::string& name) : + Lookup_Error("Could not find any algorithm named \"" + name + "\"") + {} }; /** * No_Provider_Found Exception */ -struct BOTAN_PUBLIC_API(2,0) No_Provider_Found final : public Exception +class BOTAN_PUBLIC_API(2,0) No_Provider_Found final : public Exception { - explicit No_Provider_Found(const std::string& name) : - Exception("Could not find any provider for algorithm named \"" + name + "\"") - {} + public: + explicit No_Provider_Found(const std::string& name) : + Exception("Could not find any provider for algorithm named \"" + name + "\"") + {} }; /** * Provider_Not_Found is thrown when a specific provider was requested * but that provider is not available. */ -struct BOTAN_PUBLIC_API(2,0) Provider_Not_Found final : public Lookup_Error +class BOTAN_PUBLIC_API(2,0) Provider_Not_Found final : public Lookup_Error { - Provider_Not_Found(const std::string& algo, const std::string& provider) : - Lookup_Error("Could not find provider '" + provider + "' for " + algo) {} + public: + Provider_Not_Found(const std::string& algo, const std::string& provider) : + Lookup_Error("Could not find provider '" + provider + "' for " + algo) {} }; /** * Invalid_Algorithm_Name Exception */ -struct BOTAN_PUBLIC_API(2,0) Invalid_Algorithm_Name final : public Invalid_Argument +class BOTAN_PUBLIC_API(2,0) Invalid_Algorithm_Name final : public Invalid_Argument { - explicit Invalid_Algorithm_Name(const std::string& name): - Invalid_Argument("Invalid algorithm name: " + name) - {} + public: + explicit Invalid_Algorithm_Name(const std::string& name): + Invalid_Argument("Invalid algorithm name: " + name) + {} }; /** * Encoding_Error Exception */ -struct BOTAN_PUBLIC_API(2,0) Encoding_Error final : public Invalid_Argument +class BOTAN_PUBLIC_API(2,0) Encoding_Error final : public Invalid_Argument { - explicit Encoding_Error(const std::string& name) : - Invalid_Argument("Encoding error: " + name) {} + public: + explicit Encoding_Error(const std::string& name) : + Invalid_Argument("Encoding error: " + name) {} }; /** * Decoding_Error Exception */ -struct BOTAN_PUBLIC_API(2,0) Decoding_Error : public Invalid_Argument +class BOTAN_PUBLIC_API(2,0) Decoding_Error : public Invalid_Argument { - explicit Decoding_Error(const std::string& name) : - Invalid_Argument("Decoding error: " + name) {} + public: + explicit Decoding_Error(const std::string& name) : + Invalid_Argument("Decoding error: " + name) {} }; /** * Integrity_Failure Exception */ -struct BOTAN_PUBLIC_API(2,0) Integrity_Failure final : public Exception +class BOTAN_PUBLIC_API(2,0) Integrity_Failure final : public Exception { - explicit Integrity_Failure(const std::string& msg) : - Exception("Integrity failure: " + msg) {} + public: + explicit Integrity_Failure(const std::string& msg) : + Exception("Integrity failure: " + msg) {} }; /** * Invalid_OID Exception */ -struct BOTAN_PUBLIC_API(2,0) Invalid_OID final : public Decoding_Error +class BOTAN_PUBLIC_API(2,0) Invalid_OID final : public Decoding_Error { - explicit Invalid_OID(const std::string& oid) : - Decoding_Error("Invalid ASN.1 OID: " + oid) {} + public: + explicit Invalid_OID(const std::string& oid) : + Decoding_Error("Invalid ASN.1 OID: " + oid) {} }; /** * Stream_IO_Error Exception */ -struct BOTAN_PUBLIC_API(2,0) Stream_IO_Error final : public Exception +class BOTAN_PUBLIC_API(2,0) Stream_IO_Error final : public Exception { - explicit Stream_IO_Error(const std::string& err) : - Exception("I/O error: " + err) - {} + public: + explicit Stream_IO_Error(const std::string& err) : + Exception("I/O error: " + err) + {} }; /** * No_Filesystem_Access Exception */ -struct BOTAN_PUBLIC_API(2,0) No_Filesystem_Access final : public Exception +class BOTAN_PUBLIC_API(2,0) No_Filesystem_Access final : public Exception { - No_Filesystem_Access() : Exception("No filesystem access enabled.") {} + public: + No_Filesystem_Access() : Exception("No filesystem access enabled.") {} }; /** * Self Test Failure Exception */ -struct BOTAN_PUBLIC_API(2,0) Self_Test_Failure final : public Internal_Error +class BOTAN_PUBLIC_API(2,0) Self_Test_Failure final : public Internal_Error { - explicit Self_Test_Failure(const std::string& err) : - Internal_Error("Self test failed: " + err) - {} + public: + explicit Self_Test_Failure(const std::string& err) : + Internal_Error("Self test failed: " + err) + {} }; /** * Not Implemented Exception */ -struct BOTAN_PUBLIC_API(2,0) Not_Implemented final : public Exception +class BOTAN_PUBLIC_API(2,0) Not_Implemented final : public Exception { - explicit Not_Implemented(const std::string& err) : - Exception("Not implemented", err) - {} + public: + explicit Not_Implemented(const std::string& err) : + Exception("Not implemented", err) + {} }; } diff --git a/src/lib/utils/http_util/http_util.h b/src/lib/utils/http_util/http_util.h index aa8e1cbc0..528a4fae8 100644 --- a/src/lib/utils/http_util/http_util.h +++ b/src/lib/utils/http_util/http_util.h @@ -19,7 +19,7 @@ namespace Botan { namespace HTTP { -struct Response +class Response { public: Response() : m_status_code(0), m_status_message("Uninitialized") {} @@ -56,11 +56,12 @@ struct Response /** * HTTP_Error Exception */ -struct BOTAN_PUBLIC_API(2,0) HTTP_Error final : public Exception +class BOTAN_PUBLIC_API(2,0) HTTP_Error final : public Exception { - explicit HTTP_Error(const std::string& msg) : - Exception("HTTP error " + msg) - {} + public: + explicit HTTP_Error(const std::string& msg) : + Exception("HTTP error " + msg) + {} }; BOTAN_PUBLIC_API(2,0) std::ostream& operator<<(std::ostream& o, const Response& resp); |