source: arduino-1-6-7/trunk/fuentes/arduino-ide-amd64/hardware/arduino/avr/cores/arduino/Stream.h @ 4837

Last change on this file since 4837 was 4837, checked in by daduve, 3 years ago

Adding new version

File size: 6.0 KB
Line 
1/*
2  Stream.h - base class for character-based streams.
3  Copyright (c) 2010 David A. Mellis.  All right reserved.
4
5  This library is free software; you can redistribute it and/or
6  modify it under the terms of the GNU Lesser General Public
7  License as published by the Free Software Foundation; either
8  version 2.1 of the License, or (at your option) any later version.
9
10  This library is distributed in the hope that it will be useful,
11  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  Lesser General Public License for more details.
14
15  You should have received a copy of the GNU Lesser General Public
16  License along with this library; if not, write to the Free Software
17  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
18
19  parsing functions based on TextFinder library by Michael Margolis
20*/
21
22#ifndef Stream_h
23#define Stream_h
24
25#include <inttypes.h>
26#include "Print.h"
27
28// compatability macros for testing
29/*
30#define   getInt()            parseInt()
31#define   getInt(ignore)    parseInt(ignore)
32#define   getFloat()          parseFloat()
33#define   getFloat(ignore)  parseFloat(ignore)
34#define   getString( pre_string, post_string, buffer, length)
35readBytesBetween( pre_string, terminator, buffer, length)
36*/
37
38// This enumeration provides the lookahead options for parseInt(), parseFloat()
39// The rules set out here are used until either the first valid character is found
40// or a time out occurs due to lack of input.
41enum LookaheadMode{
42    SKIP_ALL,       // All invalid characters are ignored.
43    SKIP_NONE,      // Nothing is skipped, and the stream is not touched unless the first waiting character is valid.
44    SKIP_WHITESPACE // Only tabs, spaces, line feeds & carriage returns are skipped.
45};
46
47#define NO_IGNORE_CHAR  '\x01' // a char not found in a valid ASCII numeric field
48
49class Stream : public Print
50{
51  protected:
52    unsigned long _timeout;      // number of milliseconds to wait for the next char before aborting timed read
53    unsigned long _startMillis;  // used for timeout measurement
54    int timedRead();    // private method to read stream with timeout
55    int timedPeek();    // private method to peek stream with timeout
56    int peekNextDigit(LookaheadMode lookahead, bool detectDecimal); // returns the next numeric digit in the stream or -1 if timeout
57
58  public:
59    virtual int available() = 0;
60    virtual int read() = 0;
61    virtual int peek() = 0;
62    virtual void flush() = 0;
63
64    Stream() {_timeout=1000;}
65
66// parsing methods
67
68  void setTimeout(unsigned long timeout);  // sets maximum milliseconds to wait for stream data, default is 1 second
69  unsigned long getTimeout(void) { return _timeout; }
70 
71  bool find(char *target);   // reads data from the stream until the target string is found
72  bool find(uint8_t *target) { return find ((char *)target); }
73  // returns true if target string is found, false if timed out (see setTimeout)
74
75  bool find(char *target, size_t length);   // reads data from the stream until the target string of given length is found
76  bool find(uint8_t *target, size_t length) { return find ((char *)target, length); }
77  // returns true if target string is found, false if timed out
78
79  bool find(char target) { return find (&target, 1); }
80
81  bool findUntil(char *target, char *terminator);   // as find but search ends if the terminator string is found
82  bool findUntil(uint8_t *target, char *terminator) { return findUntil((char *)target, terminator); }
83
84  bool findUntil(char *target, size_t targetLen, char *terminate, size_t termLen);   // as above but search ends if the terminate string is found
85  bool findUntil(uint8_t *target, size_t targetLen, char *terminate, size_t termLen) {return findUntil((char *)target, targetLen, terminate, termLen); }
86
87  long parseInt(LookaheadMode lookahead = SKIP_ALL, char ignore = NO_IGNORE_CHAR);
88  // returns the first valid (long) integer value from the current position.
89  // lookahead determines how parseInt looks ahead in the stream.
90  // See LookaheadMode enumeration at the top of the file.
91  // Lookahead is terminated by the first character that is not a valid part of an integer.
92  // Once parsing commences, 'ignore' will be skipped in the stream.
93
94  float parseFloat(LookaheadMode lookahead = SKIP_ALL, char ignore = NO_IGNORE_CHAR);
95  // float version of parseInt
96
97  size_t readBytes( char *buffer, size_t length); // read chars from stream into buffer
98  size_t readBytes( uint8_t *buffer, size_t length) { return readBytes((char *)buffer, length); }
99  // terminates if length characters have been read or timeout (see setTimeout)
100  // returns the number of characters placed in the buffer (0 means no valid data found)
101
102  size_t readBytesUntil( char terminator, char *buffer, size_t length); // as readBytes with terminator character
103  size_t readBytesUntil( char terminator, uint8_t *buffer, size_t length) { return readBytesUntil(terminator, (char *)buffer, length); }
104  // terminates if length characters have been read, timeout, or if the terminator character  detected
105  // returns the number of characters placed in the buffer (0 means no valid data found)
106
107  // Arduino String functions to be added here
108  String readString();
109  String readStringUntil(char terminator);
110
111  protected:
112  long parseInt(char ignore) { return parseInt(SKIP_ALL, ignore); }
113  float parseFloat(char ignore) { return parseFloat(SKIP_ALL, ignore); }
114  // These overload exists for compatibility with any class that has derived
115  // Stream and used parseFloat/Int with a custom ignore character. To keep
116  // the public API simple, these overload remains protected.
117
118  struct MultiTarget {
119    const char *str;  // string you're searching for
120    size_t len;       // length of string you're searching for
121    size_t index;     // index used by the search routine.
122  };
123
124  // This allows you to search for an arbitrary number of strings.
125  // Returns index of the target that is found first or -1 if timeout occurs.
126  int findMulti(struct MultiTarget *targets, int tCount);
127};
128
129#undef NO_IGNORE_CHAR
130#endif
Note: See TracBrowser for help on using the repository browser.