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
|
/*
* Copyright (C) 2022 Linux Studio Plugins Project <https://lsp-plug.in/>
* (C) 2022 Vladimir Sadovnikov <sadko4u@gmail.com>
*
* This file is part of lsp-runtime-lib
* Created on: 24 окт. 2022 г.
*
* 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_LSPC_UTIL_CONFIG_H_
#define LSP_PLUG_IN_FMT_LSPC_UTIL_CONFIG_H_
#include <lsp-plug.in/runtime/version.h>
#include <lsp-plug.in/common/status.h>
#include <lsp-plug.in/fmt/lspc/File.h>
#include <lsp-plug.in/mm/types.h>
#include <lsp-plug.in/io/IInStream.h>
#include <lsp-plug.in/io/Path.h>
#include <lsp-plug.in/runtime/LSPString.h>
namespace lsp
{
namespace lspc
{
/**
* Write configuration entry to the LSPC file
* @param chunk_id pointer to store allocated chunk identifier, can be NULL
* @param file the LSPC file to write the chunk
* @param path the location of configuration file to write
* @param buf_size size of buffer for I/O operations
* @return status of operation
*/
LSP_RUNTIME_LIB_PUBLIC
status_t write_config(chunk_id_t *chunk_id, File *file, const char *path, size_t buf_size = 0x1000);
LSP_RUNTIME_LIB_PUBLIC
status_t write_config(chunk_id_t *chunk_id, File *file, const io::Path *path, size_t buf_size = 0x1000);
LSP_RUNTIME_LIB_PUBLIC
status_t write_config(chunk_id_t *chunk_id, File *file, const LSPString *path, size_t buf_size = 0x1000);
/**
* Write the contents of the passed stream to the LSPC file as a configuration chunk
* @param chunk_id pointer to store allocated chunk identifier, can be NULL
* @param file the LSPC file to write the chunk
* @param is input stream that provides data to write
* @param buf_size size of buffer for I/O operations
* @return status of operation
*/
LSP_RUNTIME_LIB_PUBLIC
status_t write_config(chunk_id_t *chunk_id, File *file, io::IInStream *is, size_t buf_size = 0x1000);
/**
* Create configuration entry in the LSPC file and return chunk writer that will allow to write to the entry
* @param chunk_id pointer to store allocated chunk identifier, can be NULL
* @param file the LSPC file to write the chunk
* @param writer pointer to store the created chunk writer that should be deleted after use
* @return status of operation
*/
LSP_RUNTIME_LIB_PUBLIC
status_t write_config(chunk_id_t *chunk_id, File *file, lspc::ChunkWriter **writer);
/**
* Create configuration entry in the LSPC file and return chunk writer that will allow to write to the entry
* @param chunk_id pointer to store allocated chunk identifier, can be NULL
* @param file the LSPC file to write the chunk
* @param os pointer to store the created output stream that should be deleted after use
* @param buf_size size of buffer for I/O operations
* @return status of operation
*/
LSP_RUNTIME_LIB_PUBLIC
status_t write_config(chunk_id_t *chunk_id, File *file, io::IOutStream **os);
/**
* Write configuration entry data to the LSPC file
* @param chunk_id pointer to store allocated chunk identifier, can be NULL
* @param file the LSPC file to write the chunk
* @param data the text configuration data to write to the file
* @param buf_size size of buffer for I/O operations
* @return status of operation
*/
LSP_RUNTIME_LIB_PUBLIC
status_t write_config_data(chunk_id_t *chunk_id, File *file, const char *data, size_t buf_size = 0x1000);
LSP_RUNTIME_LIB_PUBLIC
status_t write_config_data(chunk_id_t *chunk_id, File *file, const LSPString *data, size_t buf_size = 0x1000);
/**
* Write configuration entry data to the LSPC file
* @param chunk_id pointer to store allocated chunk identifier, can be NULL
* @param file the LSPC file to write the chunk
* @param data the binary data to write to the file
* @param bytes the size of data in bytes
* @param buf_size size of buffer for I/O operations
* @return status of operation
*/
LSP_RUNTIME_LIB_PUBLIC
status_t write_config_data(chunk_id_t *chunk_id, File *file, const void *data, size_t bytes, size_t buf_size = 0x1000);
/**
* Read configuration chunk to the file
* @param chunk_id chunk identifier
* @param file the LSPC file to read the chunk
* @param path target file name
* @param buf_size size of buffer for I/O operations
* @return status of operation
*/
LSP_RUNTIME_LIB_PUBLIC
status_t read_config(chunk_id_t chunk_id, File *file, const char *path, size_t buf_size = 0x1000);
LSP_RUNTIME_LIB_PUBLIC
status_t read_config(chunk_id_t chunk_id, File *file, const io::Path *path, size_t buf_size = 0x1000);
LSP_RUNTIME_LIB_PUBLIC
status_t read_config(chunk_id_t chunk_id, File *file, const LSPString *path, size_t buf_size = 0x1000);
/**
* Read configuration chunk to the output stream
* @param chunk_id chunk identifier
* @param file the LSPC file to read the chunk
* @param os target output stream to read data
* @param buf_size size of buffer for I/O operations
* @return status of operation
*/
LSP_RUNTIME_LIB_PUBLIC
status_t read_config(chunk_id_t chunk_id, File *file, io::IOutStream *os, size_t buf_size = 0x1000);
/**
* Read configuration chunk and return pointer to the input stream
* @param chunk_id chunk identifier
* @param file the LSPC file to read the chunk
* @param is pointer to store the resulting stream, should be deleted after use
* @return status of operation
*/
LSP_RUNTIME_LIB_PUBLIC
status_t read_config(chunk_id_t chunk_id, File *file, io::IInStream **is);
/**
* Read configuration chunk into the memory and return pointer to the allocated string
* @param chunk_id chunk identifier
* @param file the LSPC file to read the chunk
* @param data pointer to store the resulting string, should be free()'d by the caller after use
* @param buf_size size of buffer for I/O operations
* @return status of operation
*/
LSP_RUNTIME_LIB_PUBLIC
status_t read_config_data(chunk_id_t chunk_id, File *file, char **data, size_t buf_size = 0x1000);
/**
* Read configuration chunk into the string
* @param chunk_id chunk identifier
* @param file the LSPC file to read the chunk
* @param data string to store the result
* @param buf_size size of buffer for I/O operations
* @return status of operation
*/
LSP_RUNTIME_LIB_PUBLIC
status_t read_config_data(chunk_id_t chunk_id, File *file, LSPString *data, size_t buf_size = 0x1000);
/**
* Read configuration chunk into the memory and return it's size
* @param chunk_id chunk identifier
* @param file the LSPC file to read the chunk
* @param data pointer to store the address of the buffer, should be free()'d by the caller after use
* @param size pointer to return the size of read data
* @param buf_size size of buffer for I/O operations
* @return status of operation
*/
LSP_RUNTIME_LIB_PUBLIC
status_t read_config_data(chunk_id_t chunk_id, File *file, void **data, size_t *size, size_t buf_size = 0x1000);
} /* namespace lspc */
} /* namespace lsp */
#endif /* LSP_PLUG_IN_FMT_LSPC_UTIL_CONFIG_H_ */
|
