ubjsc  0.6
Enterprise-grade C library for manipulating UBJSON
ubjs_parser.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016 Tomasz Sieprawski
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a copy
5  * of this software and associated documentation files (the "Software"), to deal
6  * in the Software without restriction, including without limitation the rights
7  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8  * copies of the Software, and to permit persons to whom the Software is
9  * furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included in all
12  * copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20  * SOFTWARE.
21  **/
31 #ifndef HAVE_UBJS_PARSER
32 #define HAVE_UBJS_PARSER
33 
34 #ifdef __cplusplus
35 extern "C"
36 {
37 #endif
38 
39 #include "ubjs_common.h"
40 #include "ubjs_library.h"
41 #include "ubjs_primitives.h"
42 
44 struct ubjs_parser;
45 
47 struct ubjs_parser_builder;
48 
50 struct ubjs_parser_error;
51 
53 typedef struct ubjs_parser ubjs_parser;
54 
57 
60 
68 typedef void (*ubjs_parser_parsed_f)(void *userdata, ubjs_prmtv *primitive);
76 typedef void (*ubjs_parser_debug_f)(void *userdata, unsigned int len, char *message);
85 typedef void (*ubjs_parser_error_f)(void *userdata, ubjs_parser_error *error);
92 typedef void (*ubjs_parser_free_f)(void *userdata);
93 
101  unsigned int *plength);
102 
113 
121  ubjs_parser_builder **pbuilder);
122 
129 
137  void *userdata);
138 
146  ubjs_parser_parsed_f parsed_f);
147 
158  ubjs_parser_debug_f debug_f);
159 
167  ubjs_parser_error_f error_f);
168 
176  ubjs_parser_free_f free_f);
177 
189  ubjs_parser_builder *builder, unsigned int value);
190 
205  unsigned int value);
206 
218  unsigned int value);
219 
231  unsigned int value);
232 
248  ubjs_parser_builder *builder, ubjs_bool value);
249 
258  ubjs_parser **pthis);
259 
268 UBJS_EXPORT ubjs_result ubjs_parser_free(ubjs_parser **pthis);
269 
277 UBJS_EXPORT ubjs_result ubjs_parser_get_userdata(ubjs_parser *this, void **puserdata);
278 
296 UBJS_EXPORT ubjs_result ubjs_parser_parse(ubjs_parser *this, uint8_t *data, unsigned int len);
297 
298 #ifdef __cplusplus
299 }
300 #endif
301 
302 #endif
Library handle, allocation callbacks, glues.
Definitions of common types, ubjson markers and some utilities.
struct ubjs_prmtv ubjs_prmtv
Definition: ubjs_primitives.h:166
UBJS_EXPORT ubjs_result ubjs_parser_builder_set_debug_f(ubjs_parser_builder *builder, ubjs_parser_debug_f debug_f)
Sets debug callback for parser's userdata. If this is set, parser will callback with lots of internal...
Definition: ubjs_parser.c:107
struct ubjs_parser_error ubjs_parser_error
Holder for parser errors.
Definition: ubjs_parser.h:59
UBJS_EXPORT ubjs_result ubjs_parser_builder_set_limit_string_length(ubjs_parser_builder *builder, unsigned int value)
Max number of characters in string or HPN. If this is 0, limit is effectively off. Else parser errors when expected length exceeds the limit.
Definition: ubjs_parser.c:155
UBJS_EXPORT ubjs_result ubjs_parser_builder_set_error_f(ubjs_parser_builder *builder, ubjs_parser_error_f error_f)
Sets error callback for parser's userdata.
Definition: ubjs_parser.c:95
UBJS_EXPORT ubjs_result ubjs_parser_get_userdata(ubjs_parser *this, void **puserdata)
Gets userdata from the parser.
Definition: ubjs_parser.c:565
UBJS_EXPORT ubjs_result ubjs_parser_builder_build(ubjs_parser_builder *builder, ubjs_parser **pthis)
Creates new parser.
Definition: ubjs_parser.c:465
UBJS_EXPORT ubjs_result ubjs_parser_builder_set_silently_ignore_toplevel_noops(ubjs_parser_builder *builder, ubjs_bool value)
Whether to silently ignore no-op primitives. If this is UTRUE:
Definition: ubjs_parser.c:179
struct ubjs_parser_builder ubjs_parser_builder
Parser builder.
Definition: ubjs_parser.h:56
ubjs_bool
Wrapper around regular C-like booleans.
Definition: ubjs_common.h:59
Wrappers over ubjson primitive types.
UBJS_EXPORT ubjs_result ubjs_parser_free(ubjs_parser **pthis)
Frees the parser.
Definition: ubjs_parser.c:513
UBJS_EXPORT ubjs_result ubjs_parser_parse(ubjs_parser *this, uint8_t *data, unsigned int len)
Parses the incoming data.
Definition: ubjs_parser.c:576
struct ubjs_parser ubjs_parser
Parser itself.
Definition: ubjs_parser.h:53
UBJS_EXPORT ubjs_result ubjs_parser_builder_set_limit_container_length(ubjs_parser_builder *builder, unsigned int value)
Max number of items in container. This applies to arrays and objects. If this is 0, limit is effectively off. Else parser errors when:
Definition: ubjs_parser.c:143
UBJS_EXPORT ubjs_result ubjs_parser_builder_set_userdata(ubjs_parser_builder *builder, void *userdata)
Sets parser's userdata.
Definition: ubjs_parser.c:72
ubjs_result
Enum that defines the result of a method.
Definition: ubjs_common.h:73
UBJS_EXPORT ubjs_result ubjs_parser_builder_set_limit_bytes_since_last_callback(ubjs_parser_builder *builder, unsigned int value)
Sets max number of bytes to process since last callback. If this is 0, limit is effectively off...
Definition: ubjs_parser.c:131
void(* ubjs_parser_free_f)(void *userdata)
Callback when parser is about to be free-d.
Definition: ubjs_parser.h:92
UBJS_EXPORT ubjs_result ubjs_parser_builder_free(ubjs_parser_builder **pbuilder)
Frees the builder.
Definition: ubjs_parser.c:57
UBJS_EXPORT ubjs_result ubjs_parser_builder_new(ubjs_library *lib, ubjs_parser_builder **pbuilder)
Creates new builder.
Definition: ubjs_parser.c:32
void(* ubjs_parser_parsed_f)(void *userdata, ubjs_prmtv *primitive)
Callback to be executed just when parser parsed a first-citizen primitive.
Definition: ubjs_parser.h:68
UBJS_EXPORT ubjs_result ubjs_parser_builder_set_limit_recursion_level(ubjs_parser_builder *builder, unsigned int value)
Max recursion level for containers. If this is 0, limit is effectively off. Else parser errors when r...
Definition: ubjs_parser.c:167
UBJS_EXPORT ubjs_result ubjs_parser_builder_set_free_f(ubjs_parser_builder *builder, ubjs_parser_free_f free_f)
Sets free callback for parser's userdata.
Definition: ubjs_parser.c:119
UBJS_EXPORT ubjs_result ubjs_parser_error_get_message_text(ubjs_parser_error *this, char *text)
Copies the error message's content to provided array.
Definition: ubjs_parser.c:230
void(* ubjs_parser_error_f)(void *userdata, ubjs_parser_error *error)
Callback when encountered a parsing error.
Definition: ubjs_parser.h:85
UBJS_EXPORT ubjs_result ubjs_parser_error_get_message_length(ubjs_parser_error *this, unsigned int *plength)
Gets the error message's length.
Definition: ubjs_parser.c:219
UBJS_EXPORT ubjs_result ubjs_parser_builder_set_parsed_f(ubjs_parser_builder *builder, ubjs_parser_parsed_f parsed_f)
Sets parsed callback for parser's userdata.
Definition: ubjs_parser.c:83
struct ubjs_library ubjs_library
Library handle.
Definition: ubjs_library.h:67
void(* ubjs_parser_debug_f)(void *userdata, unsigned int len, char *message)
Callback to be executed just when parser issued a debug message.
Definition: ubjs_parser.h:76