Allow access to full parseInt/Float implementation.

This commit allows users to access the full versions of
parseInt/Float as the previous implementation had some overloads
marked as protected. Ultimately this will allow someone to correctly
parse a formatted string like '-1,234.567' correctly using
parseFloat.

Author: Chris--A

hardware/arduino/avr/cores/arduino/Stream.cpp

@@ -26,7 +26,6 @@
 #include "Stream.h"
 
 #define PARSE_TIMEOUT 1000  // default number of milli-seconds to wait
-#define NO_SKIP_CHAR  1  // a magic char not found in a valid ASCII numeric field
 
 // private method to read stream with timeout
 int Stream::timedRead()
@@ -121,17 +120,11 @@ bool Stream::findUntil(char *target, size_t targetLen, char *terminator, size_t
   }
 }
 
-
 // returns the first valid (long) integer value from the current position.
 // initial characters that are not digits (or the minus sign) are skipped
 // function is terminated by the first character that is not a digit.
-long Stream::parseInt(StreamParseOpt skipMode)
-{
-  return parseInt(skipMode, NO_SKIP_CHAR); // terminate on first non-digit character (or timeout)
-}
-
-// as above but a given skipChar is ignored
-// this allows format characters (typically commas) in values to be ignored
+// If provided, skipChar is ignored. This allows format characters 
+// (typically commas) in values to be ignored.
 long Stream::parseInt(StreamParseOpt skipMode, char skipChar)
 {
   bool isNegative = false;
@@ -160,15 +153,7 @@ long Stream::parseInt(StreamParseOpt skipMode, char skipChar)
   return value;
 }
 
-
 // as parseInt but returns a floating point value
-float Stream::parseFloat(StreamParseOpt skipMode)
-{
-  return parseFloat(skipMode, NO_SKIP_CHAR);
-}
-
-// as above but the given skipChar is ignored
-// this allows format characters (typically commas) in values to be ignored
 float Stream::parseFloat(StreamParseOpt skipMode, char skipChar){
   bool isNegative = false;
   bool isFraction = false;

hardware/arduino/avr/cores/arduino/Stream.h

@@ -41,6 +41,8 @@ enum StreamParseOpt{
     SKIP_WHITESPACE
 };
 
+#define NO_SKIP_CHAR  '\x01' // a magic char not found in a valid ASCII numeric field
+
 class Stream : public Print
 {
   protected:
@@ -79,11 +81,12 @@ class Stream : public Print
   bool findUntil(uint8_t *target, size_t targetLen, char *terminate, size_t termLen) {return findUntil((char *)target, targetLen, terminate, termLen); }
 
 
-  long parseInt(StreamParseOpt skipMode = SKIP_ALL); // returns the first valid (long) integer value from the current position.
-  // initial characters that are not digits (or the minus sign) are skipped
-  // integer is terminated by the first character that is not a digit.
+  long parseInt(StreamParseOpt skipMode = SKIP_ALL, char skipChar = NO_SKIP_CHAR); // returns the first valid (long) integer value from the current position.
+  // skipMode determines how parseInt looks ahead in the stream. 
+  // See StreamParseOpt enumeration at the top of the file.
+  // Lookahead is terminated by the first character that is not a valid part of an integer.
 
-  float parseFloat(StreamParseOpt skipMode = SKIP_ALL);               // float version of parseInt
+  float parseFloat(StreamParseOpt skipMode = SKIP_ALL, char skipChar = NO_SKIP_CHAR); // float version of parseInt
 
   size_t readBytes( char *buffer, size_t length); // read chars from stream into buffer
   size_t readBytes( uint8_t *buffer, size_t length) { return readBytes((char *)buffer, length); }
@@ -100,11 +103,6 @@ class Stream : public Print
   String readStringUntil(char terminator);
 
   protected:
-  long parseInt(StreamParseOpt skipMode, char skipChar); // as above but the given skipChar is ignored
-  // as above but the given skipChar is ignored
-  // this allows format characters (typically commas) in values to be ignored
-
-  float parseFloat(StreamParseOpt skipMode, char skipChar);  // as above but the given skipChar is ignored
 
   struct MultiTarget {
     const char *str;  // string you're searching for
@@ -117,5 +115,5 @@ class Stream : public Print
   int findMulti(struct MultiTarget *targets, int tCount);
 };
 
-
+#undef NO_SKIP_CHAR
 #endif

hardware/arduino/sam/cores/arduino/Stream.cpp

@@ -26,7 +26,6 @@
 #include "Stream.h"
 
 #define PARSE_TIMEOUT 1000  // default number of milli-seconds to wait
-#define NO_SKIP_CHAR  1  // a magic char not found in a valid ASCII numeric field
 
 // private method to read stream with timeout
 int Stream::timedRead()
@@ -121,17 +120,11 @@ bool Stream::findUntil(char *target, size_t targetLen, char *terminator, size_t
   }
 }
 
-
 // returns the first valid (long) integer value from the current position.
 // initial characters that are not digits (or the minus sign) are skipped
 // function is terminated by the first character that is not a digit.
-long Stream::parseInt(StreamParseOpt skipMode)
-{
-  return parseInt(skipMode, NO_SKIP_CHAR); // terminate on first non-digit character (or timeout)
-}
-
-// as above but a given skipChar is ignored
-// this allows format characters (typically commas) in values to be ignored
+// If provided, skipChar is ignored. This allows format characters 
+// (typically commas) in values to be ignored.
 long Stream::parseInt(StreamParseOpt skipMode, char skipChar)
 {
   bool isNegative = false;
@@ -160,15 +153,7 @@ long Stream::parseInt(StreamParseOpt skipMode, char skipChar)
   return value;
 }
 
-
 // as parseInt but returns a floating point value
-float Stream::parseFloat(StreamParseOpt skipMode)
-{
-  return parseFloat(skipMode, NO_SKIP_CHAR);
-}
-
-// as above but the given skipChar is ignored
-// this allows format characters (typically commas) in values to be ignored
 float Stream::parseFloat(StreamParseOpt skipMode, char skipChar){
   bool isNegative = false;
   bool isFraction = false;

hardware/arduino/sam/cores/arduino/Stream.h

@@ -41,6 +41,8 @@ enum StreamParseOpt{
     SKIP_WHITESPACE
 };
 
+#define NO_SKIP_CHAR  '\x01' // a magic char not found in a valid ASCII numeric field
+
 class Stream : public Print
 {
   protected:
@@ -79,11 +81,12 @@ class Stream : public Print
   bool findUntil(uint8_t *target, size_t targetLen, char *terminate, size_t termLen) {return findUntil((char *)target, targetLen, terminate, termLen); }
 
 
-  long parseInt(StreamParseOpt skipMode = SKIP_ALL); // returns the first valid (long) integer value from the current position.
-  // initial characters that are not digits (or the minus sign) are skipped
-  // integer is terminated by the first character that is not a digit.
+  long parseInt(StreamParseOpt skipMode = SKIP_ALL, char skipChar = NO_SKIP_CHAR); // returns the first valid (long) integer value from the current position.
+  // skipMode determines how parseInt looks ahead in the stream. 
+  // See StreamParseOpt enumeration at the top of the file.
+  // Lookahead is terminated by the first character that is not a valid part of an integer.
 
-  float parseFloat(StreamParseOpt skipMode = SKIP_ALL);               // float version of parseInt
+  float parseFloat(StreamParseOpt skipMode = SKIP_ALL, char skipChar = NO_SKIP_CHAR); // float version of parseInt
 
   size_t readBytes( char *buffer, size_t length); // read chars from stream into buffer
   size_t readBytes( uint8_t *buffer, size_t length) { return readBytes((char *)buffer, length); }
@@ -100,11 +103,6 @@ class Stream : public Print
   String readStringUntil(char terminator);
 
   protected:
-  long parseInt(StreamParseOpt skipMode, char skipChar); // as above but the given skipChar is ignored
-  // as above but the given skipChar is ignored
-  // this allows format characters (typically commas) in values to be ignored
-
-  float parseFloat(StreamParseOpt skipMode, char skipChar);  // as above but the given skipChar is ignored
 
   struct MultiTarget {
     const char *str;  // string you're searching for
@@ -117,4 +115,5 @@ class Stream : public Print
   int findMulti(struct MultiTarget *targets, int tCount);
 };
 
+#undef NO_SKIP_CHAR
 #endif