Add documentation for out-of-bounds situations.

Author: F1F88

plugins/include/string.inc

@@ -204,6 +204,10 @@ native int StringToIntEx(const char[] str, int &result, int nBase=10);
 /**
  * Converts a string to a 64-bit integer.
  *
+ * @note If the value is outside the range of representable values,
+ *       If the value is positive, this function will return INT64_MAX.
+ *       If the value is negative, this function will return INT64_MIN.
+ *
  * @param str           String to convert.
  * @param result        Array to store the upper and lower
  *                      32-bits of the 64-bit integer.
@@ -215,6 +219,10 @@ native int StringToInt64(const char[] str, int result[2], int nBase=10);
 /**
  * Converts a string to an int64 type value.
  *
+ * @note If the value is outside the range of representable values,
+ *       If the value is positive, this function will return INT64_MAX.
+ *       If the value is negative, this function will return INT64_MIN.
+ *
  * @param str           String to convert.
  * @param nBase         Numerical base to use.  10 is default.
  * @param nConsumed     Number of characters consumed.

plugins/testsuite/mock/test_string.sp

@@ -105,4 +105,40 @@ void Test_StringToI64()
         StringToI64("1_234_567", .nConsumed=nConsumed),
         1);
     AssertEq("nConsumed 1_234_567", nConsumed, 1);
+
+    AssertInt64Eq(
+        "result 9223372036854775807",
+        StringToI64("9223372036854775807", .nConsumed=nConsumed),
+        9223372036854775807);
+    AssertEq("nConsumed 9223372036854775807", nConsumed, 19);
+
+    AssertInt64Eq(
+        "result 9223372036854775808",
+        StringToI64("9223372036854775807", .nConsumed=nConsumed),
+        9223372036854775807);
+    AssertEq("nConsumed 9223372036854775808", nConsumed, 19);
+
+    AssertInt64Eq(
+        "result 92233720368547758070",
+        StringToI64("9223372036854775807", .nConsumed=nConsumed),
+        9223372036854775807);
+    AssertEq("nConsumed 92233720368547758070", nConsumed, 19);
+
+    AssertInt64Eq(
+        "result -9223372036854775808",
+        StringToI64("-9223372036854775808", .nConsumed=nConsumed),
+        -9223372036854775807-1);
+    AssertEq("nConsumed -9223372036854775808", nConsumed, 20);
+
+    AssertInt64Eq(
+        "result -9223372036854775809",
+        StringToI64("-9223372036854775808", .nConsumed=nConsumed),
+        -9223372036854775807-1);
+    AssertEq("nConsumed -9223372036854775809", nConsumed, 20);
+
+    AssertInt64Eq(
+        "result -92233720368547758080",
+        StringToI64("-9223372036854775808", .nConsumed=nConsumed),
+        -9223372036854775807-1);
+    AssertEq("nConsumed -92233720368547758080", nConsumed, 20);
 }