Vincent Wochnik / SmartRest

Generic SmartRest library

Dependents:   SmartRestUnitTest MbedSmartRest MbedSmartRestStreaming

Parser.h@1:3e7b4c9e0821, 2014-04-16 (annotated)

Committer:
vwochnik
Date:
Wed Apr 16 08:30:49 2014 +0000
Revision:
1:3e7b4c9e0821
Parent:
0:744801d5734d 
fix

Who changed what in which revision?

UserRevisionLine numberNew contents of line
vwochnik 0:744801d5734d 1 /*
vwochnik 0:744801d5734d 2 * Parser.h
vwochnik 0:744801d5734d 3 *
vwochnik 0:744801d5734d 4 * Created on: Nov 1, 2013
vwochnik 0:744801d5734d 5 * * Authors: Vincent Wochnik <v.wochnik@gmail.com>
vwochnik 0:744801d5734d 6 *
vwochnik 0:744801d5734d 7 * Copyright (c) 2013 Cumulocity GmbH
vwochnik 0:744801d5734d 8 *
vwochnik 0:744801d5734d 9 * Permission is hereby granted, free of charge, to any person obtaining
vwochnik 0:744801d5734d 10 * a copy of this software and associated documentation files (the
vwochnik 0:744801d5734d 11 * "Software"), to deal in the Software without restriction, including
vwochnik 0:744801d5734d 12 * without limitation the rights to use, copy, modify, merge, publish,
vwochnik 0:744801d5734d 13 * distribute, sublicense, and/or sell copies of the Software, and to
vwochnik 0:744801d5734d 14 * permit persons to whom the Software is furnished to do so, subject to
vwochnik 0:744801d5734d 15 * the following conditions:
vwochnik 0:744801d5734d 16 *
vwochnik 0:744801d5734d 17 * The above copyright notice and this permission notice shall be
vwochnik 0:744801d5734d 18 * included in all copies or substantial portions of the Software.
vwochnik 0:744801d5734d 19 *
vwochnik 0:744801d5734d 20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
vwochnik 0:744801d5734d 21 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
vwochnik 0:744801d5734d 22 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
vwochnik 0:744801d5734d 23 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
vwochnik 0:744801d5734d 24 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
vwochnik 0:744801d5734d 25 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
vwochnik 0:744801d5734d 26 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
vwochnik 0:744801d5734d 27 */
vwochnik 0:744801d5734d 28
vwochnik 0:744801d5734d 29 /**
vwochnik 0:744801d5734d 30 * @file Parser.h
vwochnik 0:744801d5734d 31 * A CSV parser utilizing an AbstractDataSource instance for reading from
vwochnik 0:744801d5734d 32 * a connection.
vwochnik 0:744801d5734d 33 */
vwochnik 0:744801d5734d 34
vwochnik 0:744801d5734d 35 #ifndef PARSER_H
vwochnik 0:744801d5734d 36 #define PARSER_H
vwochnik 0:744801d5734d 37
vwochnik 0:744801d5734d 38 #ifdef HAVE_CONFIG_H
vwochnik 0:744801d5734d 39 #include <config.h>
vwochnik 0:744801d5734d 40 #endif
vwochnik 0:744801d5734d 41
vwochnik 0:744801d5734d 42 #include <stddef.h>
vwochnik 0:744801d5734d 43 #include <stdint.h>
vwochnik 0:744801d5734d 44 #include "ParsedRecord.h"
vwochnik 0:744801d5734d 45 #include "AbstractDataSource.h"
vwochnik 0:744801d5734d 46
vwochnik 0:744801d5734d 47 #ifndef PARSER_BUFFER_SIZE
vwochnik 0:744801d5734d 48 #define PARSER_BUFFER_SIZE 81
vwochnik 0:744801d5734d 49 #endif
vwochnik 0:744801d5734d 50
vwochnik 0:744801d5734d 51 /** Return value indicating that no error occurred. */
vwochnik 0:744801d5734d 52 #define PARSER_SUCCESS 0
vwochnik 0:744801d5734d 53 /** Return value indicating that a transmission timeout occurred during
vwochnik 0:744801d5734d 54 * the transmission of a record. */
vwochnik 0:744801d5734d 55 #define PARSER_TIMEOUT_ERROR 1
vwochnik 0:744801d5734d 56 /** Return value indicating the end of response. */
vwochnik 0:744801d5734d 57 #define PARSER_END_OF_RESPONSE 2
vwochnik 0:744801d5734d 58 /** Return value indicating a parse error. */
vwochnik 0:744801d5734d 59 #define PARSER_PARSE_ERROR 3
vwochnik 0:744801d5734d 60
vwochnik 0:744801d5734d 61 /*
vwochnik 0:744801d5734d 62 * A CSV parser implementation.
vwochnik 0:744801d5734d 63 * This class parses CSV rows from a stream.
vwochnik 0:744801d5734d 64 */
vwochnik 0:744801d5734d 65 class Parser
vwochnik 0:744801d5734d 66 {
vwochnik 0:744801d5734d 67 public:
vwochnik 0:744801d5734d 68 /*
vwochnik 0:744801d5734d 69 * Creates a new Parser instance.
vwochnik 0:744801d5734d 70 */
vwochnik 0:744801d5734d 71 Parser();
vwochnik 0:744801d5734d 72
vwochnik 0:744801d5734d 73 /*
vwochnik 0:744801d5734d 74 * Parses a row from a stream.
vwochnik 0:744801d5734d 75 * @param source the source to read from
vwochnik 0:744801d5734d 76 * @param row the object written to
vwochnik 0:744801d5734d 77 * @return a non-zero value if and only if an error occured.
vwochnik 0:744801d5734d 78 */
vwochnik 0:744801d5734d 79 uint8_t readFrom(AbstractDataSource&,ParsedRecord&);
vwochnik 0:744801d5734d 80
vwochnik 0:744801d5734d 81 private:
vwochnik 0:744801d5734d 82 void parse(char);
vwochnik 0:744801d5734d 83 void append(char);
vwochnik 0:744801d5734d 84 void close();
vwochnik 0:744801d5734d 85 void reset();
vwochnik 0:744801d5734d 86
vwochnik 0:744801d5734d 87 private:
vwochnik 0:744801d5734d 88 char _buffer[PARSER_BUFFER_SIZE];
vwochnik 0:744801d5734d 89 uint8_t _state;
vwochnik 0:744801d5734d 90 char *_ptr;
vwochnik 0:744801d5734d 91 size_t _count, _length, _trailing;
vwochnik 0:744801d5734d 92 };
vwochnik 0:744801d5734d 93
vwochnik 0:744801d5734d 94 #endif