File: Serializer.h

package info (click to toggle)
lsp-plugins 1.2.5-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 91,856 kB
  • sloc: cpp: 427,831; xml: 57,779; makefile: 9,961; php: 1,005; sh: 18
file content (325 lines) | stat: -rw-r--r-- 11,472 bytes parent folder | download
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
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
/*
 * Copyright (C) 2020 Linux Studio Plugins Project <https://lsp-plug.in/>
 *           (C) 2020 Vladimir Sadovnikov <sadko4u@gmail.com>
 *
 * This file is part of lsp-runtime-lib
 * Created on: 17 окт. 2019 г.
 *
 * lsp-runtime-lib is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * any later version.
 *
 * lsp-runtime-lib is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with lsp-runtime-lib. If not, see <https://www.gnu.org/licenses/>.
 */

#ifndef LSP_PLUG_IN_FMT_JSON_SERIALIZER_H_
#define LSP_PLUG_IN_FMT_JSON_SERIALIZER_H_

#include <lsp-plug.in/runtime/version.h>
#include <lsp-plug.in/common/types.h>
#include <lsp-plug.in/io/IOutStream.h>
#include <lsp-plug.in/io/IOutSequence.h>
#include <lsp-plug.in/io/Path.h>
#include <lsp-plug.in/fmt/json/token.h>
#include <lsp-plug.in/lltl/darray.h>

namespace lsp
{
    namespace json
    {
        
        class Serializer
        {
            private:
                Serializer & operator = (const Serializer &);

            protected:
                enum pmode_t
                {
                    WRITE_ROOT,
                    WRITE_ARRAY,
                    WRITE_OBJECT
                };

                enum serialize_flags_t
                {
                    SF_PROPERTY     = 1 << 0,
                    SF_VALUE        = 1 << 1,
                    SF_COMMA        = 1 << 2,
                    SF_CONTENT      = 1 << 3
                };

                typedef struct state_t
                {
                    pmode_t                     mode;
                    size_t                      flags;
                    size_t                      ident;
                } state_t;

            protected:
                io::IOutSequence           *pOut;
                size_t                      nWFlags;
                state_t                     sState;
                lltl::darray<state_t>       sStack;
                serial_flags_t              sSettings;

            protected:
                inline status_t     push_state(pmode_t state);
                status_t            pop_state();
                inline void         copy_settings(const serial_flags_t *flags);

                inline char         hex(int x);
                status_t            write_raw(const char *buf, int len);
                status_t            write_literal(const LSPString *value);
                inline status_t     emit_comma();
                inline status_t     emit_separator();

            public:
                explicit Serializer();
                virtual ~Serializer();

            public:
                /**
                 * Open serializer
                 * @param path UTF-8 path to the file
                 * @param settings serialization flags
                 * @param charset character set
                 * @return status of operation
                 */
                status_t    open(const char *path, const serial_flags_t *settings, const char *charset = NULL);

                /**
                 * Open serializer
                 * @param path string representation of path to the file
                 * @param settings serialization flags
                 * @param charset character set
                 * @return status of operation
                 */
                status_t    open(const LSPString *path, const serial_flags_t *settings, const char *charset = NULL);

                /**
                 * Open serializer
                 * @param path path to the file
                 * @param settings serialization flags
                 * @param charset character set
                 * @return status of operation
                 */
                status_t    open(const io::Path *path, const serial_flags_t *settings, const char *charset = NULL);

                /**
                 * Wrap string with serializer
                 * @param str string to wrap
                 * @param settings serialization flags
                 * @return status of operation
                 */
                status_t    wrap(LSPString *str, const serial_flags_t *settings);

                /**
                 * Wrap input sequence with serializer
                 * @param seq sequence to use for reads
                 * @param settings serialization flags
                 * @param flags wrapping flags
                 * @return status of operation
                 */
                status_t    wrap(io::IOutSequence *seq, const serial_flags_t *settings, size_t flags = WRAP_NONE);

                /**
                 * Wrap input stream with serializer
                 * @param os output stream
                 * @param version JSON version
                 * @param settings serialization flags
                 * @param flags wrapping flags
                 * @param charset character set
                 * @return status of operation
                 */
                status_t    wrap(io::IOutStream *os, const serial_flags_t *settings, size_t flags = WRAP_NONE, const char *charset = NULL);

                /**
                 * Close serializer
                 * @return status of operation
                 */
                status_t    close();

            public:

                /**
                 * Write JSON event to output
                 * @param event event to write
                 * @return status of operation
                 */
                status_t    write(const event_t *event);

                /**
                 * Write comma
                 * @return status of operation
                 */
                status_t    write_comma();

                /**
                 * Write new line
                 * @return status of operation
                 */
                status_t    writeln();

                /**
                 * Write integer value
                 * @param value value to write
                 * @return status of operation
                 */
                status_t    write_int(ssize_t value);

                /**
                 * Write hexadecimal value
                 * @param value value to write
                 * @return status of operation
                 */
                status_t    write_hex(ssize_t value);

                /**
                 * Write double
                 * @param value double value
                 * @return status of operation
                 */
                status_t    write_double(double value);

                /**
                 * Write double
                 * @param value double value
                 * @param fmt format specifier (same as for sprintf)
                 * @return status of operation
                 */
                status_t    write_double(double value, const char *fmt);

                /**
                 * Write boolean value
                 * @param value value to write
                 * @return status of operation
                 */
                status_t    write_bool(bool value);

                /**
                 * Write string value
                 * @param value value to write, NULL will be interpreted as NULL value
                 * @param charset character set
                 * @return status of operation
                 */
                status_t    write_string(const char *value, const char *charset);

                /**
                 * Write string in UTF-8
                 * @param value value to write, NULL will be interpreted as NULL value
                 * @return status of operation
                 */
                status_t    write_string(const char *value);

                /**
                 * Write string value
                 * @param value value to write, NULL will be interpreted as NULL value
                 * @return status of operation
                 */
                status_t    write_string(const LSPString *value);

                /**
                 * Write null value
                 * @return status of operation
                 */
                status_t    write_null();

                /**
                 * Write comment
                 * @param value comment to write
                 * @return status of operation
                 */
                status_t    write_comment(const char *value, const char *charset);

                /**
                 * Write comment in UTF-8 encoding
                 * @param value comment to write
                 * @return status of operation
                 */
                status_t    write_comment(const char *value);

                /**
                 * Write comment
                 * @param value comment to write
                 * @return status of operation
                 */
                status_t    write_comment(const LSPString *value);

                /**
                 * Write property
                 * @param name property name
                 * @param charset character set
                 * @return status of operation
                 */
                status_t    write_property(const char *name, const char *charset);

                /**
                 * Write property in UTF-8 encoding
                 * @param name property name
                 * @param charset character set
                 * @return status of operation
                 */
                status_t    write_property(const char *name);

                /**
                 * Write property
                 * @param name property name
                 * @return status of operation
                 */
                status_t    write_property(const LSPString *name);

                /**
                 * Write beginning of the object
                 * @return status of operation
                 */
                status_t    start_object();

                /**
                 * Write the end of the object
                 * @return status of operation
                 */
                status_t    end_object();

                /**
                 * Write beginning of the array
                 * @return status of operation
                 */
                status_t    start_array();

                /**
                 * Write the end of the array
                 * @return status of operation
                 */
                status_t    end_array();

            public:
                /**
                 * Get multiline flag
                 * @return multiline flag
                 */
                inline bool get_multiline() const { return sSettings.multiline; }

                /**
                 * Get multiline flag
                 * @return multiline flag
                 */
                inline bool set_multiline(bool multiline)
                {
                    bool prev = sSettings.multiline;
                    sSettings.multiline = multiline;
                    return prev;
                }
        };
    
    } /* namespace json */
} /* namespace lsp */

#endif /* LSP_PLUG_IN_FMT_JSON_SERIALIZER_H_ */