aboutsummaryrefslogtreecommitdiffstats
path: root/libparc/parc/algol/parc_JSONParser.h
blob: 18ee9d1a9a975f66d132c1e10e23212a403e5ec8 (plain)
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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
/*
 * Copyright (c) 2017 Cisco and/or its affiliates.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License 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 parc_JSONParser.h
 * @brief A JSON parser
 * @ingroup inputoutput
 *
 */
#ifndef PARC_Library_parc_JSONParser_h
#define PARC_Library_parc_JSONParser_h

struct parc_buffer_parser;
typedef struct parc_buffer_parser PARCJSONParser;

#include <parc/algol/parc_Buffer.h>

/**
 * @def parcJSONValue_OptionalAssertValid
 * Optional validation of the given instance.
 *
 * Define `PARCLibrary_DISABLE_VALIDATION` to nullify validation.
 */
#ifdef PARCLibrary_DISABLE_VALIDATION
#  define parcJSONParser_OptionalAssertValid(_instance_)
#else
#  define parcJSONParser_OptionalAssertValid(_instance_) parcJSONParser_AssertValid(_instance_)
#endif


/**
 * Create a new `PARCJSONParser`.
 *
 * @param [in] buffer A pointer to a {@link PARCBuffer} containing the data to parse.
 *
 * @return non-NULL A pointer to a valid `PARCJSONParser`.
 *
 * Example:
 * @code
 * {
 *     PARCBuffer *buffer = parcBuffer_WrapCString(" { \"name\" : 123 }");
 *
 *     PARCJSONParser *parser = parcJSONParser_Create(buffer);
 *
 *     parcJSONParser_Release(&parser);
 *     parcBuffer_Release(&buffer);
 * }
 * @endcode
 */
PARCJSONParser *parcJSONParser_Create(PARCBuffer *buffer);

/**
 * Assert that an instance of `PARCJSONParser` is valid.
 *
 * If the instance is not valid, terminate via {@link trapIllegalValue()}
 *
 * Valid means the internal state of the type is consistent with its required current or future behaviour.
 * This may include the validation of internal instances of types.
 *
 * @param [in] parser A pointer to a `PARCJSONParser` instance.
 */
void parcJSONParser_AssertValid(const PARCJSONParser *parser);

/**
 * Increase the number of references to a `PARCJSONParser`.
 *
 * Note that new `PARCJSONParser` is not created,
 * only that the given `PARCJSONParser` reference count is incremented.
 * Discard the reference by invoking {@link parcJSONParser_Release}.
 *
 * @param parser A pointer to the original instance.
 * @return The value of the input parameter @p parser.
 *
 * Example:
 * @code
 * {
 *     PARCBuffer *buffer = parcBuffer_WrapCString(" { \"name\" : 123 }");
 *
 *     PARCJSONParser *parser = parcJSONParser_Create(buffer);
 *     PARCJSONParser *x2 = parcJSONParser_Acquire(parser);
 *
 *     parcJSONParser_Release(&parser);
 *     parcJSONParser_Release(&x2);
 * }
 * @endcode
 *
 * @see parcJSONParser_Release
 */
PARCJSONParser *parcJSONParser_Acquire(const PARCJSONParser *parser);

/**
 * Release a previously acquired reference to the specified instance,
 * decrementing the reference count for the instance.
 *
 * The pointer to the instance is set to NULL as a side-effect of this function.
 *
 * If the invocation causes the last reference to the instance to be released,
 * the instance is deallocated and the instance's implementation will perform
 * additional cleanup and release other privately held references.
 *
 * The contents of the dealloced memory used for the PARC object are undefined.
 * Do not reference the object after the last release.
 *
 * @param [in,out] parserPtr A pointer to a pointer to the instance of `PARCJSONParser` to release.
 *
 * Example:
 * @code
 * {
 *     PARCBuffer *buffer = parcBuffer_WrapCString(" { \"name\" : 123 }");
 *
 *     PARCJSONParser *parser = parcJSONParser_Create(buffer);
 *
 *     parcJSONParser_Release(&parser);
 * }
 * @endcode
 */
void parcJSONParser_Release(PARCJSONParser **parserPtr);

/**
 * Advance the parser, skipping any ignored characters.
 *
 * Ignored characters are space, tab and new-line.
 *
 * @param [in] parser A pointer to a `PARCJSONParser` instance.
 *
 * Example:
 * @code
 * {
 *     PARCBuffer *buffer = parcBuffer_WrapCString(" { \"name\" : 123 }");
 *
 *     PARCJSONParser *parser = parcJSONParser_Create(buffer);
 *     parcJSONParser_SkipIgnored(parser);
 *
 *     parcJSONParser_Release(&parser);
 * }
 * @endcode
 */
void parcJSONParser_SkipIgnored(PARCJSONParser *parser);

/**
 * Get the next character from the parser.
 *
 * @param [in] parser A pointer to a `PARCJSONParser` instance.
 *
 * @return The next character
 *
 * Example:
 * @code
 * {
 *     PARCBuffer *buffer = parcBuffer_WrapCString(" { \"name\" : 123 }");
 *
 *     PARCJSONParser *parser = parcJSONParser_Create(buffer);
 *     char c = parcJSONParser_NextChar(parser);
 *
 *     parcJSONParser_Release(&parser);
 * }
 * @endcode
 */
char parcJSONParser_NextChar(PARCJSONParser *parser);

/**
 * Get the next character from the parser, returning true or false if successful.
 *
 * @param [in] parser A pointer to a `PARCJSONParser` instance.
 * @param [out] value A pointer to a `char` to contain the value if successful.
 *
 * @return true If successful
 * @return false If unsuccessful
 *
 * Example:
 * @code
 * {
 *     PARCBuffer *buffer = parcBuffer_WrapCString(" { \"name\" : 123 }");
 *
 *     PARCJSONParser *parser = parcJSONParser_Create(buffer);
 *     bool success = parcJSONParser_Next(parser, &c);
 *
 *     parcJSONParser_Release(&parser);
 * }
 * @endcode
 */
bool parcJSONParser_Next(PARCJSONParser *parser, char *value);

/**
 * Get the next character that the parser will process, but do not process it nor advance the parser.
 *
 * @param [in] parser A pointer to a `PARCJSONParser` instance.
 *
 * @return The next character that the parser will process.
 *
 * Example:
 * @code
 * {
 *     PARCBuffer *buffer = parcBuffer_WrapCString(" { \"name\" : 123 }");
 *
 *     PARCJSONParser *parser = parcJSONParser_Create(buffer);
 *     char c = parcJSONParser_PeekNextChar(parser);
 *
 *     parcJSONParser_Release(&parser);
 * }
 * @endcode
 */
char parcJSONParser_PeekNextChar(PARCJSONParser *parser);

/**
 * Advance the position of the parser forward or backward by the given number of bytes.
 *
 * To advance forward, bytes is a positive value.
 * To advance backwards, bytes is a negative value.
 *
 * @param [in] parser A pointer to a valid `PARCJSONParser`.
 * @param [in] bytes The number of bytes to move forward or backward.
 *
 * Example:
 * @code
 * {
 *     PARCBuffer *buffer = parcBuffer_WrapCString("abcdef");
 *
 *     PARCJSONParser *parser = parcJSONParser_Create(buffer);
 *     parcJSONParser_Advance(parser, 2);
 *
 *     parcJSONParser_Release(&parser);
 * }
 * @endcode
 */
void parcJSONParser_Advance(PARCJSONParser *parser, long bytes);

/**
 * Get the number of characters remaining to be parsed.
 *
 * @param [in] parser A pointer to a valid `PARCJSONParser` instance
 *
 * @return The number of characters remaining to be parsed.
 *
 * Example:
 * @code
 * {
 *     PARCBuffer *buffer = parcBuffer_WrapCString("true);
 *
 *     PARCJSONParser *parser = parcJSONParser_Create(buffer);
 *     size_t remaining = parcJSONParser_Remaining(parser);
 *
 *     parcJSONParser_Release(&parser);
 * }
 * @endcode
 */
size_t parcJSONParser_Remaining(const PARCJSONParser *parser);

/**
 * Require the fixed string to appear in the current position of the parser.
 *
 * @param [in] parser A pointer to a `PARCJSONParser` instance.
 * @param [in] string A pointer to a null-terminated C-string that must appear at the current position of the parser.
 *
 * @return true If the string appears.
 * @return false If the string does not appear
 *
 * Example:
 * @code
 * {
 *     PARCBuffer *buffer = parcBuffer_WrapCString("true");
 *
 *     PARCJSONParser *parser = parcJSONParser_Create(buffer);
 *     bool result = parcJSONParser_RequireString(parser, "true");
 *
 *     parcJSONParser_Release(&parser);
 *     parcBuffer_Release(&buffer);
 * }
 * @endcode
 */
bool parcJSONParser_RequireString(PARCJSONParser *parser, const char *string);

/**
 * Parse a JSON string returning a {@link PARCBuffer} containing the parsed string.
 *
 * A JSON string begins and ends with a non-escaped double-quote character.
 *
 * @param [in] parser A pointer to a `PARCJSONParser` instance.
 *
 * @return non-NULL A pointer to a valid `PARCBuffer`.
 * @return NULL An error occurred.
 *
 * Example:
 * @code
 * {
 *     PARCBuffer *buffer = parcBuffer_WrapCString("\"name\" : 123");
 *
 *     PARCJSONParser *parser = parcJSONParser_Create(buffer);
 *     PARCBuffer *theName = parcJSONParser_ParseString(parser);
 *
 *     parcJSONParser_Release(&parser);
 * }
 * @endcode
 */
PARCBuffer *parcJSONParser_ParseString(PARCJSONParser *parser);

#endif