SafeStringReader.h

Go to the documentation of this file.

#ifndef SAFE_STRING_READER_H
#define SAFE_STRING_READER_H
/*
  SafeStringReader.h  a tokenizing Stream reader
  by Matthew Ford
  (c)2020 Forward Computing and Control Pty. Ltd.
  This code is not warranted to be fit for any purpose. You may only use it at your own risk.
  This code may be freely used for both private and commercial use.
  Provide this copyright is maintained.
**/
#ifdef __cplusplus
#include <Arduino.h>
#include "SafeString.h"
// SafeString.h includes defines for Stream
 
// handle namespace arduino
#include "SafeStringNameSpaceStart.h"
 
#define createSafeStringReader(name, size, ...) \
  char name ## _INPUT_BUFFER[(size)+2]; \
  char name ## _TOKEN_BUFFER[(size)+2]; \
  SafeString name ## _SF_INPUT((size)+2,  name ## _INPUT_BUFFER, "", #name "_InputBuffer"); \
  SafeStringReader name(name ## _SF_INPUT, (size)+2, name ## _TOKEN_BUFFER, #name, __VA_ARGS__ );
 
 
// size + 1 for delimiter, + 1 for '\0'  actually token only ever size+1 for '\0' as delimiter not returned
// size is the maximum size of the token to be read ignoring the delimiter
 
class SafeStringReader : public SafeString {
  public:
      // here buffSize is max size of the token + 1 for delimiter + 1 for terminating '\0;
    explicit SafeStringReader(SafeString& _sfInput, size_t bufSize, char *tokenBuf, const char* _name, const char* delimiters, bool skipToDelimiterFlag = false, uint8_t echoInput = false, unsigned long timeout_ms = 0 );
    explicit SafeStringReader(SafeString& _sfInput, size_t bufSize, char *tokenBuf, const char* _name, const char delimiter, bool skipToDelimiterFlag = false, uint8_t echoInput = false, unsigned long timeout_ms = 0 );
 
    void connect(Stream& stream); // clears getReadCount() as well
 
    void setTimeout(unsigned long ms);
 
 
    bool read();
 
    int getDelimiter();
 
    void echoOn();
    void echoOff();
 
    void flushInput();
 
    void returnEmptyTokens(bool flag = true);
 
    bool end();
 
    size_t getReadCount();
 
    void skipToDelimiter();
    bool isSkippingToDelimiter();
 
    bool longTokenDiscarded();
 
    /* Assignment operators **********************************
      Set the SafeString to a char version of the assigned value.
      For = (const char *) the contents are copied to the SafeString buffer
      if the value is null or invalid,
      or too large to be fit in the string's internal buffer
      the string will be left empty
    */
    SafeStringReader & operator = (char c);
    SafeStringReader & operator = (unsigned char c);
    SafeStringReader & operator = (int num);
    SafeStringReader & operator = (unsigned int num);
    SafeStringReader & operator = (long num);
    SafeStringReader & operator = (unsigned long num);
    SafeStringReader & operator = (float num);
    SafeStringReader & operator = (double num);
    SafeStringReader & operator = (SafeString &rhs);
    SafeStringReader & operator = (const char *cstr);
    SafeStringReader & operator = (const __FlashStringHelper *str); // handle F(" .. ") values
 
    const char* debugInputBuffer(bool verbose = true);
    const char* debugInputBuffer(const char* title, bool verbose = true);
    const char* debugInputBuffer(const __FlashStringHelper *title, bool verbose = true);
    const char* debugInputBuffer(SafeString &stitle, bool verbose = true);
 
  private:
    SafeStringReader(const SafeStringReader& other);
    void init(SafeString& _sfInput, const char* delimiters, bool skipToDelimiterFlag, uint8_t echoInput, unsigned long timeout_ms);
    //  void bufferInput(); // get more input
    SafeString* sfInputPtr;
    const char* delimiters;
    bool skipToDelimiterFlag;
    bool echoInput;
    bool emptyTokensReturned; // default false
    bool flagFlushInput; // true if flushing
    bool longTokenDiscardedFlag; // true if the last read() detected and discarded an over-long token
    unsigned long timeout_ms;
    bool haveToken; // true if have token but read() not called yet
    Stream *streamPtr;
    size_t charCounter; // counts bytes read, useful for http streams
    char internalCharDelimiter[2]; // used if char delimiter passed
};
 
#include "SafeStringNameSpaceEnd.h"
 
#endif  // __cplusplus
#endif // SAFE_STRING_READER_H