AceRoutine  0.1
A low-memory, fast-switching, cooperative multitasking library using stackless coroutines on Arduino platforms.
StreamReader.h
1 /*
2 MIT License
3 
4 Copyright (c) 2018 Brian T. Park
5 
6 Permission is hereby granted, free of charge, to any person obtaining a copy
7 of this software and associated documentation files (the "Software"), to deal
8 in the Software without restriction, including without limitation the rights
9 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 copies of the Software, and to permit persons to whom the Software is
11 furnished to do so, subject to the following conditions:
12 
13 The above copyright notice and this permission notice shall be included in all
14 copies or substantial portions of the Software.
15 
16 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22 SOFTWARE.
23 */
24 
25 #ifndef ACE_ROUTINE_SERIAL_READER_H
26 #define ACE_ROUTINE_SERIAL_READER_H
27 
28 #include <Arduino.h> // Stream
29 
30 namespace ace_routine {
31 namespace cli {
32 
39 class StreamReader {
40  public:
49  StreamReader(Stream& serial, char* buf, int bufSize):
50  mStream(serial),
51  mBuf(buf),
52  mBufSize(bufSize)
53  {}
54 
60  bool getChar(char* c);
61 
70  bool getWordString(bool* isError, char** word);
71 
80  bool getInteger(bool* isError, int* value);
81 
89  bool getComma(bool* isError);
90 
95  bool skipWhiteSpace();
96 
107  bool getLine(bool* isError, char** line);
108 
109  private:
110  // Disable copy-constructor and assignment operator
111  StreamReader(const StreamReader&) = delete;
112  StreamReader& operator=(const StreamReader&) = delete;
113 
118  void pushback(char c) {
119  mPushback = c;
120  }
121 
127  void resetBuffer() {
128  mBuf[mIndex] = '\0';
129  mIndex = 0;
130  }
131 
133  bool addToBuffer(char c);
134 
135  Stream& mStream;
136  char* const mBuf;
137  int mBufSize;
138  int mIndex = 0;
139  char mPushback = 0;
140 };
141 
142 }
143 }
144 
145 #endif
StreamReader(Stream &serial, char *buf, int bufSize)
Constructor.
Definition: StreamReader.h:49
bool getChar(char *c)
Get a character from serial port.
bool getLine(bool *isError, char **line)
Get a line.
bool getInteger(bool *isError, int *value)
Get an integer.
Reads tokens (lines, words, integers, characters, etc) from the Stream device.
Definition: StreamReader.h:39
bool skipWhiteSpace()
Skip whitespace.
bool getComma(bool *isError)
Parse a comma.
bool getWordString(bool *isError, char **word)
Get a string bounded by whitespace, i.e.