This adds the capability to control the Stream::parseInt/float

Chris--A · Chris--A · commit 46e536402ef1 · 2015-07-10T12:40:09.000+10:00
lookahead. Its default is SKIP_ALL which reflects previous versions.
However SKIP_NONE, and SKIP_WHITESPACE can refine this behaviour.﻿
diff --git a/hardware/arduino/avr/cores/arduino/Stream.cpp b/hardware/arduino/avr/cores/arduino/Stream.cpp
@@ -54,7 +54,7 @@ int Stream::timedPeek()
 
 // returns peek of the next digit in the stream or -1 if timeout
 // discards non-numeric characters
-int Stream::peekNextDigit( bool detectDecimal )
+int Stream::peekNextDigit(StreamParseOpt skipMode, bool detectDecimal)
 {
   int c;
   while (1) {
@@ -65,6 +65,17 @@ int Stream::peekNextDigit( bool detectDecimal )
         c >= '0' && c <= '9' ||
         detectDecimal && c == '.') return c;
 
+    switch( skipMode ){
+        case SKIP_NONE: return -1; // Fail code.
+        case SKIP_WHITESPACE:
+            switch( c ){
+                case ' ':
+                case '\t':
+                case '\r':
+                case '\n': break;
+                default: return -1; // Fail code.
+            }
+    }
     read();  // discard non-numeric
   }
 }
@@ -114,20 +125,20 @@ 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()
+long Stream::parseInt(StreamParseOpt skipMode)
 {
-  return parseInt(NO_SKIP_CHAR); // terminate on first non-digit character (or timeout)
+  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
-long Stream::parseInt(char skipChar)
+long Stream::parseInt(StreamParseOpt skipMode, char skipChar)
 {
   bool isNegative = false;
   long value = 0;
   int c;
 
-  c = peekNextDigit(false);
+  c = peekNextDigit(skipMode, false);
   // ignore non numeric leading characters
   if(c < 0)
     return 0; // zero returned if timeout
@@ -151,21 +162,21 @@ long Stream::parseInt(char skipChar)
 
 
 // as parseInt but returns a floating point value
-float Stream::parseFloat()
+float Stream::parseFloat(StreamParseOpt skipMode)
 {
-  return parseFloat(NO_SKIP_CHAR);
+  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(char skipChar){
+float Stream::parseFloat(StreamParseOpt skipMode, char skipChar){
   bool isNegative = false;
   bool isFraction = false;
   long value = 0;
   char c;
   float fraction = 1.0;
 
-  c = peekNextDigit(true);
+  c = peekNextDigit(skipMode, true);
     // ignore non numeric leading characters
   if(c < 0)
     return 0; // zero returned if timeout
diff --git a/hardware/arduino/avr/cores/arduino/Stream.h b/hardware/arduino/avr/cores/arduino/Stream.h
@@ -35,14 +35,23 @@
 readBytesBetween( pre_string, terminator, buffer, length)
 */
 
+// This enumeration provides the lookahead options for parseInt(), parseFloat()
+// The rules set out here are used until either the first valid character is found
+// or a time out occurs due to lack of input.
+enum StreamParseOpt{
+    SKIP_ALL,       // All invalid characters are ignored.
+    SKIP_NONE,      // Nothing is skipped, and the stream is not touched unless the first waiting character is valid.
+    SKIP_WHITESPACE // Only tabs, spaces, line feeds & carriage returns are skipped.
+};
+
 class Stream : public Print
 {
   protected:
     unsigned long _timeout;      // number of milliseconds to wait for the next char before aborting timed read
     unsigned long _startMillis;  // used for timeout measurement
     int timedRead();    // private method to read stream with timeout
     int timedPeek();    // private method to peek stream with timeout
-    int peekNextDigit( bool detectDecimal ); // returns the next numeric digit in the stream or -1 if timeout
+    int peekNextDigit(StreamParseOpt skipMode, bool detectDecimal); // returns the next numeric digit in the stream or -1 if timeout
 
   public:
     virtual int available() = 0;
@@ -73,11 +82,11 @@ 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(); // returns the first valid (long) integer value from the current position.
+  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.
 
-  float parseFloat();               // float version of parseInt
+  float parseFloat(StreamParseOpt skipMode = SKIP_ALL);               // 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); }
@@ -94,11 +103,11 @@ class Stream : public Print
   String readStringUntil(char terminator);
 
   protected:
-  long parseInt(char skipChar); // as above but the given skipChar is ignored
+  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(char skipChar);  // as above but the given skipChar is 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
diff --git a/hardware/arduino/sam/cores/arduino/Stream.cpp b/hardware/arduino/sam/cores/arduino/Stream.cpp
@@ -54,7 +54,7 @@ int Stream::timedPeek()
 
 // returns peek of the next digit in the stream or -1 if timeout
 // discards non-numeric characters
-int Stream::peekNextDigit( bool detectDecimal )
+int Stream::peekNextDigit(StreamParseOpt skipMode, bool detectDecimal )
 {
   int c;
   while (1) {
@@ -65,6 +65,17 @@ int Stream::peekNextDigit( bool detectDecimal )
         c >= '0' && c <= '9' ||
         detectDecimal && c == '.') return c;
 
+    switch( skipMode ){
+        case SKIP_NONE: return -1; // Fail code.
+        case SKIP_WHITESPACE:
+            switch( c ){
+                case ' ':
+                case '\t':
+                case '\r':
+                case '\n': break;
+                default: return -1; // Fail code.
+            }
+    }
     read();  // discard non-numeric
   }
 }
@@ -114,20 +125,20 @@ 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()
+long Stream::parseInt(StreamParseOpt skipMode)
 {
-  return parseInt(NO_SKIP_CHAR); // terminate on first non-digit character (or timeout)
+  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
-long Stream::parseInt(char skipChar)
+long Stream::parseInt(StreamParseOpt skipMode, char skipChar)
 {
   bool isNegative = false;
   long value = 0;
   int c;
 
-  c = peekNextDigit(false);
+  c = peekNextDigit(skipMode, false);
   // ignore non numeric leading characters
   if(c < 0)
     return 0; // zero returned if timeout
@@ -151,21 +162,21 @@ long Stream::parseInt(char skipChar)
 
 
 // as parseInt but returns a floating point value
-float Stream::parseFloat()
+float Stream::parseFloat(StreamParseOpt skipMode)
 {
-  return parseFloat(NO_SKIP_CHAR);
+  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(char skipChar){
+float Stream::parseFloat(StreamParseOpt skipMode, char skipChar){
   bool isNegative = false;
   bool isFraction = false;
   long value = 0;
   char c;
   float fraction = 1.0;
 
-  c = peekNextDigit(true);
+  c = peekNextDigit(skipMode, true);
     // ignore non numeric leading characters
   if(c < 0)
     return 0; // zero returned if timeout
diff --git a/hardware/arduino/sam/cores/arduino/Stream.h b/hardware/arduino/sam/cores/arduino/Stream.h
@@ -35,14 +35,23 @@
 readBytesBetween( pre_string, terminator, buffer, length)
 */
 
+// This enumeration provides the lookahead options for parseInt(), parseFloat()
+// The rules set out here are used until either the first valid character is found
+// or a time out occurs due to lack of input.
+enum StreamParseOpt{
+    SKIP_ALL,       // All invalid characters are ignored.
+    SKIP_NONE,      // Nothing is skipped, and the stream is not touched unless the first waiting character is valid.
+    SKIP_WHITESPACE // Only tabs, spaces, line feeds & carriage returns are skipped.
+};
+
 class Stream : public Print
 {
   protected:
     unsigned long _timeout;      // number of milliseconds to wait for the next char before aborting timed read
     unsigned long _startMillis;  // used for timeout measurement
     int timedRead();    // private method to read stream with timeout
     int timedPeek();    // private method to peek stream with timeout
-    int peekNextDigit( bool detectDecimal ); // returns the next numeric digit in the stream or -1 if timeout
+    int peekNextDigit(StreamParseOpt skipMode, bool detectDecimal); // returns the next numeric digit in the stream or -1 if timeout
 
   public:
     virtual int available() = 0;
@@ -71,11 +80,11 @@ 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(); // returns the first valid (long) integer value from the current position.
+  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.
 
-  float parseFloat();               // float version of parseInt
+  float parseFloat(StreamParseOpt skipMode = SKIP_ALL);               // 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); }
@@ -92,11 +101,11 @@ class Stream : public Print
   String readStringUntil(char terminator);
 
   protected:
-  long parseInt(char skipChar); // as above but the given skipChar is ignored
+  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(char skipChar);  // as above but the given skipChar is 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
