Ensures enum types can hold values up to 1023

j-ulrich · j-ulrich · commit e6df9874efc4 · 2019-02-21T01:04:55.000+01:00
diff --git a/HttpStatusCodes_C++.h b/HttpStatusCodes_C++.h
@@ -107,7 +107,9 @@ enum Code
 	InsufficientStorage           = 507, //!< Means the method could not be performed on the resource because the server is unable to store the representation needed to successfully complete the request.
 	LoopDetected                  = 508, //!< Indicates that the server terminated an operation because it encountered an infinite loop while processing a request with "Depth: infinity". [RFC 5842]
 	NotExtended                   = 510, //!< The policy for accessing the resource has not been met in the request. [RFC 2774]
-	NetworkAuthenticationRequired = 511  //!< Indicates that the client needs to authenticate to gain network access.
+	NetworkAuthenticationRequired = 511, //!< Indicates that the client needs to authenticate to gain network access.
+
+	xxx_max = 1023
 };
 
 inline bool isInformational(int code) { return (code >= 100 && code < 200); } //!< \returns \c true if the given \p code is an informational code.
diff --git a/HttpStatusCodes_C++11.h b/HttpStatusCodes_C++11.h
@@ -108,7 +108,7 @@ enum class Code
 	InsufficientStorage           = 507, //!< Means the method could not be performed on the resource because the server is unable to store the representation needed to successfully complete the request.
 	LoopDetected                  = 508, //!< Indicates that the server terminated an operation because it encountered an infinite loop while processing a request with "Depth: infinity". [RFC 5842]
 	NotExtended                   = 510, //!< The policy for accessing the resource has not been met in the request. [RFC 2774]
-	NetworkAuthenticationRequired = 511  //!< Indicates that the client needs to authenticate to gain network access.
+	NetworkAuthenticationRequired = 511, //!< Indicates that the client needs to authenticate to gain network access.
 };
 
 /*! Converts a Code to its corresponding integer value.
diff --git a/HttpStatusCodes_C.h b/HttpStatusCodes_C.h
@@ -101,7 +101,9 @@ enum HttpStatus_Code
 	HttpStatus_InsufficientStorage           = 507, /*!< Means the method could not be performed on the resource because the server is unable to store the representation needed to successfully complete the request. */
 	HttpStatus_LoopDetected                  = 508, /*!< Indicates that the server terminated an operation because it encountered an infinite loop while processing a request with "Depth: infinity". [RFC 5842] */
 	HttpStatus_NotExtended                   = 510, /*!< The policy for accessing the resource has not been met in the request. [RFC 2774] */
-	HttpStatus_NetworkAuthenticationRequired = 511  /*!< Indicates that the client needs to authenticate to gain network access. */
+	HttpStatus_NetworkAuthenticationRequired = 511, /*!< Indicates that the client needs to authenticate to gain network access. */
+
+	HttpStatus_xxx_max = 1023
 };
 
 static char HttpStatus_isInformational(int code) { return (code >= 100 && code < 200); } /*!< \returns \c true if the given \p code is an informational code. */
diff --git a/HttpStatusCodes_Qt.h b/HttpStatusCodes_Qt.h
@@ -117,7 +117,9 @@ enum Code
 	InsufficientStorage           = 507, //!< Means the method could not be performed on the resource because the server is unable to store the representation needed to successfully complete the request.
 	LoopDetected                  = 508, //!< Indicates that the server terminated an operation because it encountered an infinite loop while processing a request with "Depth: infinity". [RFC 5842]
 	NotExtended                   = 510, //!< The policy for accessing the resource has not been met in the request. [RFC 2774]
-	NetworkAuthenticationRequired = 511  //!< Indicates that the client needs to authenticate to gain network access.
+	NetworkAuthenticationRequired = 511, //!< Indicates that the client needs to authenticate to gain network access.
+
+	xxx_max = 1023
 };
 #if (QT_VERSION >= QT_VERSION_CHECK(5,8,0))
 Q_ENUM_NS(Code)
diff --git a/README.md b/README.md
@@ -27,12 +27,12 @@ Initially, the data was taken from [for-GET/know-your-http-well](https://github.
 
 ## Variants ##
 
-| Variant                          | Scoping                | Status Codes                                                                                   | Reason Phrases |
-|----------------------------------|------------------------|------------------------------------------------------------------------------------------------|----------------|
-| [C](HttpStatusCodes_C.h)         | Prefix `HttpStatus_`   | `enum HttpStatus_Code`                                                                         | `const char*`  |
-| [C++](HttpStatusCodes_C++.h)     | Namespace `HttpStatus` | `enum Code`                                                                                    | `std::string`  |
-| [C++11](HttpStatusCodes_C++11.h) | Namespace `HttpStatus` | `enum class Code`                                                                              | `std::string`  |
-| [Qt](HttpStatusCodes_Qt.h)       | Namespace `HttpStatus` | `enum Code`<br>When using Qt 5.8 or later: registered in meta type system using `Q_ENUM_NS()`  | `QString`      |
+| Variant                          | Name Scoping           | Status Codes Type                                                                              | Reason Phrases Type |
+|----------------------------------|------------------------|------------------------------------------------------------------------------------------------|---------------------|
+| [C](HttpStatusCodes_C.h)         | Prefix `HttpStatus_`   | `enum HttpStatus_Code`                                                                         | `const char*`       |
+| [C++](HttpStatusCodes_C++.h)     | Namespace `HttpStatus` | `enum Code`                                                                                    | `std::string`       |
+| [C++11](HttpStatusCodes_C++11.h) | Namespace `HttpStatus` | `enum class Code`                                                                              | `std::string`       |
+| [Qt](HttpStatusCodes_Qt.h)       | Namespace `HttpStatus` | `enum Code`<br>When using Qt 5.8 or later: registered in meta type system using `Q_ENUM_NS()`  | `QString`           |
 
 
 > Note regarding Qt variant: Oldest tested Qt version was Qt 5.2.0 with MinGW 4.8. However, should be working with any Qt 5.x version.
@@ -65,6 +65,9 @@ void printReplyStatus(MyHttpReplyClass reply)
 
 For the complete list of defined enums, see one of the header files.
 
+> **Note:** The maximum supported value for the enums is `1023`. Trying to convert bigger values to the enum types
+might be undefined behavior.
+
 ##### C Variant #####
 ```c
 enum HttpStatus_Code
