Merge pull request #6 from j-ulrich/feature/pr5_toInt

{C++11} Implements toInt() conversion function

Author: j-ulrich

.appveyor.yml

@@ -20,6 +20,9 @@ environment:
           APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2013
           VCVARS_COMMANDLINE: '"C:\Program Files (x86)\Microsoft Visual Studio 12.0\VC\vcvarsall.bat" x86'
 
+cache:
+    - C:\.hunter -> .appveyor.yml, **\CMakeLists.txt, **\*.cmake
+
 before_build:
     - call %VCVARS_COMMANDLINE%
     - set Path=%QT_DIR%\bin;%Path%

CHANGELOG.md

@@ -10,10 +10,19 @@ This changelog follows the [Keep a Changelog](http://keepachangelog.com) format.
 ---
 
 
-## [1.1.1]  - 2018-11-14 ##
+## [1.2.0] - 2019-01-06 ##
+
+### Added ###
+- [#5]{C++11} `toInt()` conversion function.
+
+
+---
+
+
+## [1.1.1] - 2018-11-14 ##
 
 ### Fixed ###
-- Some QNetworkReply::NetworkError codes were not available in Qt before 5.3.
+- {Qt} Some QNetworkReply::NetworkError codes were not available in Qt before 5.3.
 
 
 ---
@@ -26,7 +35,7 @@ Adds missing status codes from the IANA registry.
 
 
 ### Fixed ###
-- Removed redundant "HttpStatus_XXX" documentation comments in C variant.
+- {C} Removed redundant "HttpStatus_XXX" documentation comments.
 
 
 ---
@@ -40,11 +49,12 @@ Initial (actually unversioned) release.
 - Status codes
 - Category/class tests (`isXXX()` functions)
 - Reason phrases
-- `QNetworkReply::NetworkError` mapping
+- {Qt} `QNetworkReply::NetworkError` mapping
 
 
 ---
 
 
+[1.2.0]: https://github.com/j-ulrich/http-status-codes-cpp/releases/tag/1.2.0
 [1.1.1]: https://github.com/j-ulrich/http-status-codes-cpp/releases/tag/1.1.1
 [1.1.0]: https://github.com/j-ulrich/http-status-codes-cpp/releases/tag/1.1.0

HttpStatusCodes_C++.h

@@ -4,7 +4,7 @@
  *
  * https://github.com/j-ulrich/http-status-codes-cpp
  *
- * \version 1.1.1
+ * \version 1.2.0
  * \author Jochen Ulrich <[email protected]>
  * \copyright Licensed under Creative Commons CC0 (http://creativecommons.org/publicdomain/zero/1.0/)
  */

HttpStatusCodes_C++11.h

@@ -4,7 +4,7 @@
  *
  * https://github.com/j-ulrich/http-status-codes-cpp
  *
- * \version 1.1.1
+ * \version 1.2.0
  * \author Jochen Ulrich <[email protected]>
  * \copyright Licensed under Creative Commons CC0 (http://creativecommons.org/publicdomain/zero/1.0/)
  */
@@ -111,6 +111,16 @@ enum class Code
 	NetworkAuthenticationRequired = 511  //!< Indicates that the client needs to authenticate to gain network access.
 };
 
+/*! Converts a Code to its corresponding integer value.
+ * \param code The code to be converted.
+ * \return The numeric value of \p code.
+ * \since 1.2.0
+ */
+inline int toInt(Code code)
+{
+	return static_cast<int>(code);
+}
+
 inline bool isInformational(int code) { return (code >= 100 && code < 200); } //!< \returns \c true if the given \p code is an informational code.
 inline bool isSuccessful(int code)    { return (code >= 200 && code < 300); } //!< \returns \c true if the given \p code is a successful code.
 inline bool isRedirection(int code)   { return (code >= 300 && code < 400); } //!< \returns \c true if the given \p code is a redirectional code.

HttpStatusCodes_C.h

@@ -4,7 +4,7 @@
  *
  * https://github.com/j-ulrich/http-status-codes-cpp
  *
- * \version 1.1.1
+ * \version 1.2.0
  * \author Jochen Ulrich <[email protected]>
  * \copyright Licensed under Creative Commons CC0 (http://creativecommons.org/publicdomain/zero/1.0/)
  */

HttpStatusCodes_Qt.h

@@ -4,7 +4,7 @@
  *
  * https://github.com/j-ulrich/http-status-codes-cpp
  *
- * \version 1.1.1
+ * \version 1.2.0
  * \author Jochen Ulrich <[email protected]>
  * \copyright Licensed under Creative Commons CC0 (http://creativecommons.org/publicdomain/zero/1.0/)
  */

README.md

@@ -20,7 +20,7 @@ Initially, the data was taken from [for-GET/know-your-http-well](https://github.
 >   - [Status Codes Enum](#status-codes-enum)
 >   - [Category/Class Tests](#categoryclass-tests)
 >   - [Reason Phrases](#reason-phrases)
->   - [QNetworkReply::NetworkError Mapping](#qnetworkreplynetworkerror-mapping)
+>   - [Conversion Functions](#conversion-functions)
 > - [License](#license)
 
 
@@ -65,7 +65,7 @@ void printReplyStatus(MyHttpReplyClass reply)
 
 For the complete list of defined enums, see one of the header files.
 
-#### C Variant ####
+##### C Variant #####
 ```c
 enum HttpStatus_Code
 {
@@ -75,7 +75,7 @@ enum HttpStatus_Code
 };
 ```
 
-#### C++11 Variant ####
+##### C++11 Variant #####
 ```c++
 namespace HttpStatus {
 enum class Code
@@ -87,7 +87,7 @@ enum class Code
 }
 ```
 
-#### Other Variants ####
+##### Other Variants #####
 ```c++
 namespace HttpStatus {
 enum Code
@@ -102,7 +102,7 @@ enum Code
 
 ### Category/Class Tests ###
 
-#### C Variant ####
+##### C Variant #####
 ```c
 char HttpStatus_isInformational(int code);
 char HttpStatus_isSuccessful(int code);
@@ -120,7 +120,7 @@ Returns `1` if the given _code_ is either a client error, a server error or any
 Non-standard error codes are status codes with a value of 600 or higher.
 Returns `0` otherwise.
 
-#### Other Variants ####
+##### Other Variants #####
 > **Note:** The C++11 variant also provides overloads for `HttpStatus::Code`. So there is no need to cast.
 
 ```c++
@@ -145,31 +145,36 @@ Returns `false` otherwise.
 
 ### Reason Phrases ###
 
-#### C Variant ####
+##### C Variant #####
 ```c
 const char* HttpStatus_reasonPhrase(int code);
 ```
 Returns the HTTP reason phrase string corresponding to the given _code_.
 
-#### C++/C++11 Variants ####
+##### C++/C++11 Variants #####
 > **Note:** The C++11 variant also provides an overload for `HttpStatus::Code`. So there is no need to cast.
 ```c++
 std::string HttpStatus::reasonPhrase(int code);
 ```
 Returns the HTTP reason phrase string corresponding to the given _code_.
 
-#### Qt Variant ####
+##### Qt Variant #####
 ```c++
 QString HttpStatus::reasonPhrase(int code);
 ```
 Returns the HTTP reason phrase string corresponding to the given _code_.
 
 
-### QNetworkReply::NetworkError Mapping ###
+### Conversion Functions ###
 
-> **Note:** Available only in the Qt variant and if the Qt::Network module is available.
+##### C++11 Variant #####
+```c++
+int HttpStatus::toInt(HttpStatus::Code code);
+```
+Returns the integer value corresponding to a given a _code_.
+This is a convenience function as replacement for a `static_cast<int>()`.
 
-#### Qt Variant ####
+##### Qt Variant #####
 ```c++
 int HttpStatus::networkErrorToStatusCode(QNetworkReply::NetworkError error);
 ```
@@ -180,7 +185,7 @@ Otherwise, `-1` is returned.
 QNetworkReply::NetworkError HttpStatus::statusCodeToNetworkError(int code);
 ```
 Returns the `QNetworkReply::NetworkError` corresponding to the given _code_ if there is one.
-For codes where there is no exact match, the best matchnig "catch all" code (`QNetworkReply::NoError`,
+For codes where there is no exact match, the best matching "catch all" code (`QNetworkReply::NoError`,
 `QNetworkReply::UnknownContentError`, `QNetworkReply::UnknownServerError` or `QNetworkReply::ProtocolFailure`)
 is returned.
 

tests/C++11VariantTest.cpp

@@ -43,5 +43,14 @@ CategoryTesterParams(HttpStatus::Code::HTTPVersionNotSupported,     false,  fals
 ));
 
 
+//####### Conversion Function Test #######
+
+TEST(ConversionFunctionTest, testToInt)
+{
+	ASSERT_EQ(HttpStatus::toInt(HttpStatus::Code::SwitchingProtocols), static_cast<int>(HttpStatus::Code::SwitchingProtocols));
+	ASSERT_EQ(HttpStatus::toInt(HttpStatus::Code::OK),                 static_cast<int>(HttpStatus::Code::OK));
+	ASSERT_EQ(HttpStatus::toInt(HttpStatus::Code::NotExtended),        static_cast<int>(HttpStatus::Code::NotExtended));
+}
+
 
 } // namespace Cpp11VariantTests