From 507f2ee84a04edb8b96cdb15e2a4ab23f450fa2c Mon Sep 17 00:00:00 2001
From: Chris--A <chris@genx.biz>
Date: Thu, 9 Jul 2015 18:32:40 +1000
Subject: Make protected Stream::parseInt/Float overloads public.
 Stream::parseInt & Stream::parseFloat previously had protected overloads
 which allowed skipping a custom character. This commit brings this feature to
 the public interface.
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

To keep the public API simpler, the single paramter overload remains
protected. However its functionality is available in the public
interface using the two parameter overload.
---
 cores/arduino/Stream.h | 27 +++++++++++++++------------
 1 file changed, 15 insertions(+), 12 deletions(-)

(limited to 'cores/arduino/Stream.h')

diff --git a/cores/arduino/Stream.h b/cores/arduino/Stream.h
index 8b34c6a..db71bb6 100644
--- a/cores/arduino/Stream.h
+++ b/cores/arduino/Stream.h
@@ -44,6 +44,8 @@ enum LookaheadMode{
     SKIP_WHITESPACE // Only tabs, spaces, line feeds & carriage returns are skipped.
 };
 
+#define NO_IGNORE_CHAR  '\x01' // a char not found in a valid ASCII numeric field
+
 class Stream : public Print
 {
   protected:
@@ -81,12 +83,15 @@ class Stream : public Print
   bool findUntil(char *target, size_t targetLen, char *terminate, size_t termLen);   // as above but search ends if the terminate string is found
   bool findUntil(uint8_t *target, size_t targetLen, char *terminate, size_t termLen) {return findUntil((char *)target, targetLen, terminate, termLen); }
 
+  long parseInt(LookaheadMode lookahead = SKIP_ALL, char ignore = NO_IGNORE_CHAR);
+  // returns the first valid (long) integer value from the current position.
+  // lookahead determines how parseInt looks ahead in the stream.
+  // See LookaheadMode enumeration at the top of the file.
+  // Lookahead is terminated by the first character that is not a valid part of an integer.
+  // Once parsing commences, 'ignore' will be skipped in the stream.
 
-  long parseInt(LookaheadMode lookahead = 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(LookaheadMode lookahead = SKIP_ALL);               // float version of parseInt
+  float parseFloat(LookaheadMode lookahead = SKIP_ALL, char ignore = NO_IGNORE_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); }
@@ -104,12 +109,10 @@ class Stream : public Print
 
   protected:
   long parseInt(char ignore) { return parseInt(SKIP_ALL, ignore); }
-  long parseInt(LookaheadMode lookahead, char ignore); // as above but the given ignore is ignored
-  // as above but 'ignore' is ignored
-  // this allows format characters (typically commas) in values to be ignored
-  
-  float parseFloat(char ignore) { return parseFloat(SKIP_ALL, ignore); }  
-  float parseFloat(LookaheadMode lookahead, char ignore);  // as above but the given ignore is ignored
+  float parseFloat(char ignore) { return parseFloat(SKIP_ALL, ignore); }
+  // These overload exists for compatibility with any class that has derived
+  // Stream and used parseFloat/Int with a custom ignore character. To keep
+  // the public API simple, these overload remains protected.
 
   struct MultiTarget {
     const char *str;  // string you're searching for
@@ -122,5 +125,5 @@ class Stream : public Print
   int findMulti(struct MultiTarget *targets, int tCount);
 };
 
-
+#undef NO_IGNORE_CHAR
 #endif
-- 
cgit v1.2.3-18-g5258