Changes in uspace/lib/posix/stdlib/strtold.c [ec18957a:4cf8ca6] in mainline

File:

• uspace/lib/posix/stdlib/strtold.c (modified) (12 diffs)

uspace/lib/posix/stdlib/strtold.c

@@ -30 +30 @@
  * @{
  */
-/** @file
+/** @file Backend for floating point conversions.
  */
 
@@ -55 +55 @@
 #endif
 
-// TODO: clean up, documentation
+// TODO: clean up
 
 // FIXME: ensure it builds and works on all platforms
@@ -116 +116 @@
 };
 
+/**
+ * Decides whether the argument is still in range representable by
+ * long double or not.
+ *
+ * @param num Floating point number to be checked.
+ * @return True if the argument is out of range, false otherwise.
+ */
 static inline bool out_of_range(long double num)
 {
@@ -127 +134 @@
  * @param base Number to be multiplied.
  * @param exponent Base 5 exponent.
- * @return base multiplied by 5**exponent
+ * @return base multiplied by 5**exponent.
  */
 static long double mul_pow5(long double base, int exponent)
@@ -173 +180 @@
  * @param base Number to be multiplied.
  * @param exponent Base 2 exponent.
- * @return base multiplied by 2**exponent
+ * @return base multiplied by 2**exponent.
  */
 static long double mul_pow2(long double base, int exponent)
@@ -212 +219 @@
 }
 
-
+/**
+ * Convert decimal string representation of the floating point number.
+ * Function expects the string pointer to be already pointed at the first
+ * digit (i.e. leading optional sign was already consumed by the caller).
+ * 
+ * @param sptr Pointer to the storage of the string pointer. Upon successful
+ *     conversion, the string pointer is updated to point to the first
+ *     unrecognized character.
+ * @return An approximate representation of the input floating-point number.
+ */
 static long double parse_decimal(const char **sptr)
 {
@@ -315 +331 @@
 }
 
+/**
+ * Derive a hexadecimal digit from its character representation.
+ * 
+ * @param ch Character representation of the hexadecimal digit.
+ * @return Digit value represented by an integer.
+ */
 static inline int hex_value(char ch)
 {
@@ -325 +347 @@
 
 /**
+ * Get the count of leading zero bits up to the maximum of 3 zero bits.
+ *
  * @param val Integer value.
  * @return How many leading zero bits there are. (Maximum is 3)
@@ -339 +363 @@
 }
 
+/**
+ * Convert hexadecimal string representation of the floating point number.
+ * Function expects the string pointer to be already pointed at the first
+ * digit (i.e. leading optional sign and 0x prefix were already consumed
+ * by the caller).
+ *
+ * @param sptr Pointer to the storage of the string pointer. Upon successful
+ *     conversion, the string pointer is updated to point to the first
+ *     unrecognized character.
+ * @return Representation of the input floating-point number.
+ */
 static long double parse_hexadecimal(const char **sptr)
 {
@@ -478 +513 @@
  * @param nptr Input string.
  * @param endptr If non-NULL, *endptr is set to the position of the first
- *    unrecognized character.
+ *     unrecognized character.
  * @return An approximate representation of the input floating-point number.
  */
@@ -512 +547 @@
                 
                 if (endptr != NULL) {
-                        *endptr = (char *) &nptr[i + 3];
-                }
-                errno = ERANGE;
-                return negative ? -0.0l : +0.0l;
+                        *endptr = (char *) nptr;
+                }
+                errno = EINVAL;
+                return 0;
         }
         
@@ -567 +602 @@
 /** @}
  */
-