mbed.org implementation of the abstract SmartREST library for the Cumulocity Platform SmartREST protocol.

Dependents:   MbedSmartRestMain MbedSmartRestMain

Committer:
Cumulocity
Date:
Sat Nov 15 12:21:41 2014 +0100
Revision:
13:aba98ad2ac1b
Parent:
11:e1bee9a77652
Updated from revision 0b898f0efc6d

Who changed what in which revision?

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