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 (249 lines) | stat: -rw-r--r-- 10,018 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
/*
 * 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: 1 мая 2020 г.
 *
 * 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_CONFIG_SERIALIZER_H_
#define LSP_PLUG_IN_FMT_CONFIG_SERIALIZER_H_

#include <lsp-plug.in/runtime/version.h>
#include <lsp-plug.in/common/types.h>
#include <lsp-plug.in/common/status.h>
#include <lsp-plug.in/runtime/LSPString.h>
#include <lsp-plug.in/io/IOutSequence.h>
#include <lsp-plug.in/io/IOutStream.h>
#include <lsp-plug.in/io/Path.h>
#include <lsp-plug.in/fmt/config/types.h>

namespace lsp
{
    namespace config
    {
        /**
         * Configuration serializer
         */
        class Serializer
        {
            private:
                Serializer & operator = (const Serializer &);

            protected:
                io::IOutSequence       *pOut;
                size_t                  nWFlags;

            protected:
                status_t    write_key(const LSPString *key);

                status_t    write_escaped(const LSPString *key, size_t flags);
                status_t    write_uint(uint64_t v, size_t flags);
                status_t    write_int(int64_t v, size_t flags);
                status_t    write_float(double v, size_t flags);
                status_t    write_bool(bool v, size_t flags);
                status_t    write_string_impl(const LSPString *key, const LSPString *v, size_t flags);

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

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

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

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

                /**
                 * Wrap string with parser
                 * @param str string to wrap
                 * @return status of operation
                 */
                virtual status_t    wrap(LSPString *str);

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

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

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

            public:
                /**
                 * Write comment to the output stream
                 * @param key key
                 * @param v comment
                 * @return status of operation
                 */
                virtual status_t    write_comment(const LSPString *v);

                /**
                 * Write comment to the output stream
                 * @param key key
                 * @param v UTF-8 encoded comment
                 * @return status of operation
                 */
                virtual status_t    write_comment(const char *v);

                /**
                 * Write empty line to the output file
                 * @return status of operation
                 */
                virtual status_t    writeln();

                /**
                 * Write value to the output stream
                 * @param key key
                 * @param v value
                 * @param flags value flags
                 * @return status of operation
                 */
                virtual status_t    write(const LSPString *key, const value_t *v, size_t flags);
                virtual status_t    write(const char *key, const value_t *v, size_t flags);

                /**
                 * Write 32-bit signed integer to the output stream
                 * @param key key
                 * @param v value
                 * @param flags value flags
                 * @return status of operation
                 */
                virtual status_t    write_i32(const LSPString *key, int32_t value, size_t flags);
                virtual status_t    write_i32(const char *key, int32_t value, size_t flags);

                /**
                 * Write 32-bit unsigned integer to the output stream
                 * @param key key
                 * @param v value
                 * @param flags value flags
                 * @return status of operation
                 */
                virtual status_t    write_u32(const LSPString *key, uint32_t value, size_t flags);
                virtual status_t    write_u32(const char *key, uint32_t value, size_t flags);

                /**
                 * Write 32-bit floating-point to the output stream
                 * @param key key
                 * @param v value
                 * @param flags value flags
                 * @return status of operation
                 */
                virtual status_t    write_f32(const LSPString *key, float value, size_t flags);
                virtual status_t    write_f32(const char *key, float value, size_t flags);

                /**
                 * Write 64-bit signed integer to the output stream
                 * @param key key
                 * @param v value
                 * @param flags value flags
                 * @return status of operation
                 */
                virtual status_t    write_i64(const LSPString *key, int64_t value, size_t flags);
                virtual status_t    write_i64(const char *key, int64_t value, size_t flags);

                /**
                 * Write 64-bit unsigned integer to the output stream
                 * @param key key
                 * @param v value
                 * @param flags value flags
                 * @return status of operation
                 */
                virtual status_t    write_u64(const LSPString *key, uint64_t value, size_t flags);
                virtual status_t    write_u64(const char *key, uint64_t value, size_t flags);

                /**
                 * Write 64-bit floating-point to the output stream
                 * @param key key
                 * @param v value
                 * @param flags value flags
                 * @return status of operation
                 */
                virtual status_t    write_f64(const LSPString *key, double value, size_t flags);
                virtual status_t    write_f64(const char *key, double value, size_t flags);

                /**
                 * Write boolean value to the output stream
                 * @param key key
                 * @param v value
                 * @param flags value flags
                 * @return status of operation
                 */
                virtual status_t    write_bool(const LSPString *key, bool value, size_t flags);
                virtual status_t    write_bool(const char *key, bool value, size_t flags);

                /**
                 * Write text string
                 * @param key key
                 * @param v string
                 * @param flags value flags
                 * @return status of operation
                 */
                virtual status_t    write_string(const LSPString *key, const LSPString *v, size_t flags);
                virtual status_t    write_string(const LSPString *key, const char *v, size_t flags);
                virtual status_t    write_string(const char *key, const LSPString *v, size_t flags);
                virtual status_t    write_string(const char *key, const char *v, size_t flags);

                /**
                 * Write blob data
                 * @param key key
                 * @param v blob data
                 * @param flags value flags
                 * @return status of operation
                 */
                virtual status_t    write_blob(const LSPString *key, const blob_t *v, size_t flags);
                virtual status_t    write_blob(const char *key, const blob_t *v, size_t flags);
        };
    
    } /* namespace config */
} /* namespace lsp */

#endif /* LSP_PLUG_IN_FMT_CONFIG_SERIALIZER_H_ */