spark_wiring_stream.h

Go to the documentation of this file.

#ifndef __SPARK_WIRING_STREAM_H
#define __SPARK_WIRING_STREAM_H

#include "spark_wiring_string.h"
#include "spark_wiring_print.h"
#include "system_tick_hal.h"

// compatability macros for testing
/*
#define   getInt()            parseInt()
#define   getInt(skipChar)    parseInt(skipchar)
#define   getFloat()          parseFloat()
#define   getFloat(skipChar)  parseFloat(skipChar)
#define   getString( pre_string, post_string, buffer, length)
readBytesBetween( pre_string, terminator, buffer, length)
*/

class Stream : public Print
{
  protected:
#ifndef DOXYGEN_DO_NOT_DOCUMENT
    system_tick_t _timeout;      // number of milliseconds to wait for the next char before aborting timed read
    system_tick_t _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(); // returns the next numeric digit in the stream or -1 if timeout
#endif

  public:
    virtual int available() = 0;

    virtual int read() = 0;

    virtual int peek() = 0;

    virtual void flush() = 0;

#ifndef DOXYGEN_DO_NOT_DOCUMENT
    Stream() {_timeout=1000;}
#endif

// parsing methods

  void setTimeout(system_tick_t timeout);  // sets maximum milliseconds to wait for stream data, default is 1 second

  bool find(char *target);

  bool find(char *target, size_t length);
  bool findUntil(char *target, char *terminator);

  bool findUntil(char *target, size_t targetLen, char *terminate, size_t termLen);   // as above but search ends if the terminate string is found


  long parseInt();


  float parseFloat();

  size_t readBytes( char *buffer, size_t length);

  size_t readBytesUntil( char terminator, char *buffer, size_t length);

  // Arduino String functions to be added here

  String readString();

  String readStringUntil(char terminator);

  protected:
#ifndef DOXYGEN_DO_NOT_DOCUMENT
  long parseInt(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
#endif
};

#endif