simple_cbor_stream_parse/scsp.h at master · vi/simple_cbor_stream_parse · GitHub

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
// A simple low-level streamed callback-based CBOR push parser in C.

// Implemented by Vitaly "_Vi" Shukela in 2017; License = MIT or Apache 2.0

#ifndef _SCSP_H
#define _SCSP_H

#include <stdint.h>
#include <stddef.h>


#ifdef SCSP_DEBUG_STDERR
    #define SCSP_DEBUG(x...) fprintf(stderr, x)
    #include <stdio.h>
#endif

#ifndef SCSP_INT
#define SCSP_INT int64_t
#endif


#ifndef SCSP_USERDATA
#define SCSP_USERDATA void*
#endif

#ifndef SCSP_MAXDEPTH
#define SCSP_MAXDEPTH 16
#endif

#ifndef SCSP_DEBUG
#define SCSP_DEBUG(x...)
#endif

#ifndef SCSP_EXPORT
#define SCSP_EXPORT
#endif

#ifndef SCSP_ENABLE_32BIT
#define SCSP_ENABLE_32BIT 1
#endif

#ifndef SCSP_ENABLE_64BIT
#define SCSP_ENABLE_64BIT 1
#endif

#ifndef SCSP_ENABLE_FLOAT
#define SCSP_ENABLE_FLOAT 1
#endif

#ifndef SCSP_ENABLE_HELPERS
#define SCSP_ENABLE_HELPERS 1
#endif


struct scsp_stack_entry {
    char type;
    SCSP_INT remaining;
};

struct scsp_state {
    SCSP_INT cur_depth;
    struct scsp_stack_entry stack[SCSP_MAXDEPTH];
};

struct scsp_callbacks {
    SCSP_INT (*integer) (SCSP_USERDATA userdata, SCSP_INT value);

    SCSP_INT (*bytestring_opened)(SCSP_USERDATA userdata, SCSP_INT size_or_minus_one);
    SCSP_INT (*bytestring_chunk) (SCSP_USERDATA userdata, const uint8_t* buf, size_t len);
    SCSP_INT (*bytestring_closed) (SCSP_USERDATA userdata);

    SCSP_INT (*string_opened) (SCSP_USERDATA userdata, SCSP_INT size_or_minus_one);
    SCSP_INT (*string_chunk) (SCSP_USERDATA userdata, const uint8_t* buf, size_t len);
    SCSP_INT (*string_closed) (SCSP_USERDATA userdata);

    SCSP_INT (*array_opened) (SCSP_USERDATA userdata, SCSP_INT size_or_minus_one);
    SCSP_INT (*array_item)   (SCSP_USERDATA userdata);
    SCSP_INT (*array_closed) (SCSP_USERDATA userdata);

    SCSP_INT (*map_opened) (SCSP_USERDATA userdata, SCSP_INT size_or_minus_one);
    SCSP_INT (*map_key) (SCSP_USERDATA userdata);
    SCSP_INT (*map_value) (SCSP_USERDATA userdata);
    SCSP_INT (*map_closed) (SCSP_USERDATA userdata);

    // 'T' - true, 'F' - false, 'N' - null, 'U' - undefined
    SCSP_INT (*simple) (SCSP_USERDATA userdata, char value);
    SCSP_INT (*simple_other) (SCSP_USERDATA userdata, SCSP_INT value);
    SCSP_INT (*tag) (SCSP_USERDATA userdata, SCSP_INT value);
#if SCSP_ENABLE_FLOAT
    SCSP_INT (*noninteger) (SCSP_USERDATA userdata, double value);
#endif
};

/* Syncronously read from a FD to end, with buffering, and call callbacks along the way
 * Returns number of trailing unpased bytes; or -1 on error.
 */
SCSP_INT SCSP_EXPORT scsp_parse_from_fd(
            int fd,
            struct scsp_callbacks* callbacks,
            SCSP_USERDATA userdata);

/* Returns number of trailing unpased bytes; or -1 on error. */
SCSP_INT SCSP_EXPORT scsp_parse_from_memory(
            const void *buffer,
            size_t count,
            struct scsp_callbacks* callbacks,
            SCSP_USERDATA userdata);

/*
 * Low-level parse function. Call in in a loop.
 *
 * Returns number of processed bytes, which is likely less than suppied.
 * Returns 0 if there is too little data to be parsed. Expects buffering to be done by caller.
 * Returns -1 on error, including on error returned from callbacks.
 * Does not set errno.
 *
 * Memset scsp_state to 0 before first use or to reset the parser
 */
SCSP_INT SCSP_EXPORT scsp_parse_lowlevel(
            struct scsp_state* state,
            struct scsp_callbacks* callbacks,
            SCSP_USERDATA userdata,
            const void* buf,
            size_t count);

#endif // _SCSP_H