forked from aws/aws-iot-device-sdk-embedded-C
-
Notifications
You must be signed in to change notification settings - Fork 0
/
aws_iot_json_utils.h
212 lines (193 loc) · 6.52 KB
/
aws_iot_json_utils.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
/*
* Copyright 2010-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
/**
* @file aws_json_utils.h
* @brief Utilities for manipulating JSON
*
* json_utils provides JSON parsing utilities for use with the IoT SDK.
* Underlying JSON parsing relies on the Jasmine JSON parser.
*
*/
#ifndef AWS_IOT_SDK_SRC_JSON_UTILS_H_
#define AWS_IOT_SDK_SRC_JSON_UTILS_H_
#ifdef __cplusplus
extern "C" {
#endif
#include <stdbool.h>
#include <stdint.h>
#include "aws_iot_error.h"
#include "jsmn.h"
// utility functions
/**
* @brief JSON Equality Check
*
* Given a token pointing to a particular JSON node and an
* input string, check to see if the key is equal to the string.
*
* @param json json string
* @param tok json token - pointer to key to test for equality
* @param s input string for key to test equality
*
* @return 0 if equal, 1 otherwise
*/
int8_t jsoneq(const char *json, jsmntok_t *tok, const char *s);
/**
* @brief Parse a signed 32-bit integer value from a JSON node.
*
* Given a JSON node parse the integer value from the value.
*
* @param jsonString json string
* @param tok json token - pointer to JSON node
* @param i address of int32_t to be updated
*
* @return SUCCESS - success
* @return JSON_PARSE_ERROR - error parsing value
*/
IoT_Error_t parseInteger32Value(int32_t *i, const char *jsonString, jsmntok_t *token);
/**
* @brief Parse a signed 16-bit integer value from a JSON node.
*
* Given a JSON node parse the integer value from the value.
*
* @param jsonString json string
* @param tok json token - pointer to JSON node
* @param i address of int16_t to be updated
*
* @return SUCCESS - success
* @return JSON_PARSE_ERROR - error parsing value
*/
IoT_Error_t parseInteger16Value(int16_t *i, const char *jsonString, jsmntok_t *token);
/**
* @brief Parse a signed 8-bit integer value from a JSON node.
*
* Given a JSON node parse the integer value from the value.
*
* @param jsonString json string
* @param tok json token - pointer to JSON node
* @param i address of int8_t to be updated
*
* @return SUCCESS - success
* @return JSON_PARSE_ERROR - error parsing value
*/
IoT_Error_t parseInteger8Value(int8_t *i, const char *jsonString, jsmntok_t *token);
/**
* @brief Parse an unsigned 32-bit integer value from a JSON node.
*
* Given a JSON node parse the integer value from the value.
*
* @param jsonString json string
* @param tok json token - pointer to JSON node
* @param i address of uint32_t to be updated
*
* @return SUCCESS - success
* @return JSON_PARSE_ERROR - error parsing value
*/
IoT_Error_t parseUnsignedInteger32Value(uint32_t *i, const char *jsonString, jsmntok_t *token);
/**
* @brief Parse an unsigned 16-bit integer value from a JSON node.
*
* Given a JSON node parse the integer value from the value.
*
* @param jsonString json string
* @param tok json token - pointer to JSON node
* @param i address of uint16_t to be updated
*
* @return SUCCESS - success
* @return JSON_PARSE_ERROR - error parsing value
*/
IoT_Error_t parseUnsignedInteger16Value(uint16_t *i, const char *jsonString, jsmntok_t *token);
/**
* @brief Parse an unsigned 8-bit integer value from a JSON node.
*
* Given a JSON node parse the integer value from the value.
*
* @param jsonString json string
* @param tok json token - pointer to JSON node
* @param i address of uint8_t to be updated
*
* @return SUCCESS - success
* @return JSON_PARSE_ERROR - error parsing value
*/
IoT_Error_t parseUnsignedInteger8Value(uint8_t *i, const char *jsonString, jsmntok_t *token);
/**
* @brief Parse a float value from a JSON node.
*
* Given a JSON node parse the float value from the value.
*
* @param jsonString json string
* @param tok json token - pointer to JSON node
* @param f address of float to be updated
*
* @return SUCCESS - success
* @return JSON_PARSE_ERROR - error parsing value
*/
IoT_Error_t parseFloatValue(float *f, const char *jsonString, jsmntok_t *token);
/**
* @brief Parse a double value from a JSON node.
*
* Given a JSON node parse the double value from the value.
*
* @param jsonString json string
* @param tok json token - pointer to JSON node
* @param d address of double to be updated
*
* @return SUCCESS - success
* @return JSON_PARSE_ERROR - error parsing value
*/
IoT_Error_t parseDoubleValue(double *d, const char *jsonString, jsmntok_t *token);
/**
* @brief Parse a boolean value from a JSON node.
*
* Given a JSON node parse the boolean value from the value.
*
* @param jsonString json string
* @param tok json token - pointer to JSON node
* @param b address of boolean to be updated
*
* @return SUCCESS - success
* @return JSON_PARSE_ERROR - error parsing value
*/
IoT_Error_t parseBooleanValue(bool *b, const char *jsonString, jsmntok_t *token);
/**
* @brief Parse a string value from a JSON node.
*
* Given a JSON node parse the string value from the value.
*
* @param buf address of string to be updated
* @param bufLen length of buf in bytes
* @param jsonString json string
* @param token json token - pointer to JSON node
*
* @return SUCCESS - success
* @return JSON_PARSE_ERROR - error parsing value
*/
IoT_Error_t parseStringValue(char *buf, size_t bufLen, const char *jsonString, jsmntok_t *token);
/**
* @brief Find the JSON node associated with the given key in the given object.
*
* Given a JSON node parse the string value from the value.
*
* @param key json key
* @param token json token - pointer to JSON node
* @param jsonString json string
*
* @return pointer to found property value
* @return NULL - not found
*/
jsmntok_t *findToken(const char *key, const char *jsonString, jsmntok_t *token);
#ifdef __cplusplus
}
#endif
#endif /* AWS_IOT_SDK_SRC_JSON_UTILS_H_ */