Merge branch 'master' of http://olsr.org/git/olsrd
[olsrd.git] / lib / pud / nmealib / include / nmea / parser.h
1 /*
2  * This file is part of nmealib.
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program. If not, see <http://www.gnu.org/licenses/>.
16  */
17
18 #ifndef __NMEA_PARSER_H__
19 #define __NMEA_PARSER_H__
20
21 #include <nmea/info.h>
22 #include <nmea/sentence.h>
23
24 #ifdef  __cplusplus
25 extern "C" {
26 #endif /* __cplusplus */
27
28 /* we need to be able to parse much longer sentences than specified in the (original) specification */
29 #define SENTENCE_SIZE (4096 * 1)
30
31 typedef enum _sentence_parser_state {
32   SKIP_UNTIL_START,
33   READ_SENTENCE,
34   READ_CHECKSUM,
35   READ_EOL
36 } sentence_parser_state;
37
38 /**
39  * NMEA frame parser structure
40  */
41 typedef struct _sentencePARSER {
42     int sentence_checksum;
43     int calculated_checksum;
44
45     char sentence_checksum_chars[2];
46     char sentence_checksum_chars_count;
47
48     char sentence_eol_chars_count;
49
50     bool has_checksum;
51
52     sentence_parser_state state;
53 } sentencePARSER;
54
55 /**
56  * parsed NMEA data and frame parser state
57  */
58 typedef struct _nmeaPARSER {
59     struct {
60         unsigned int length;
61         char buffer[SENTENCE_SIZE];
62     } buffer;
63
64     union {
65         nmeaGPGGA gpgga;
66         nmeaGPGSA gpgsa;
67         nmeaGPGSV gpgsv;
68         nmeaGPRMC gprmc;
69         nmeaGPVTG gpvtg;
70     } sentence;
71
72     sentencePARSER sentence_parser;
73 } nmeaPARSER;
74
75 int nmea_parser_init(nmeaPARSER *parser);
76 int nmea_parse(nmeaPARSER * parser, const char * s, int len, nmeaINFO * info);
77
78 #ifdef  __cplusplus
79 }
80 #endif /* __cplusplus */
81
82 #endif /* __NMEA_PARSER_H__ */