forked from sononum/pbl
-
Notifications
You must be signed in to change notification settings - Fork 12
/
pblStringBuilder.c
437 lines (385 loc) · 11.6 KB
/
pblStringBuilder.c
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
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
/*
pblStringBuilder.c - C implementation of a mutable sequence of characters.
Copyright (C) 2010, 2015 Peter Graf
This file is part of PBL - The Program Base Library.
PBL is free software.
MIT License
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
For more information on the Program Base Library or Peter Graf,
please see: https://www.mission-base.com/.
$Log: pblStringBuilder.c,v $
Revision 1.9 2021/06/23 14:32:49 peter
Switch to MIT license
Revision 1.8 2021/06/12 11:18:27 peter
*/
/*
* Make sure "strings <exe> | grep Id | sort -u" shows the source file versions
*/
char* pblStringBuilder_c_id = "$Id: pblStringBuilder.c,v 1.9 2021/06/23 14:32:49 peter Exp $";
#include <stdio.h>
#include <memory.h>
#include <stdarg.h>
#include <errno.h>
#ifndef __APPLE__
#include <malloc.h>
#endif
#include <stdlib.h>
#include "pbl.h"
/**
* Creates a new string builder.
*
* This function has a time complexity of O(1).
*
* @return PblStringBuilder * retPtr != NULL: A pointer to the new string builder.
* @return PblStringBuilder * retPtr == NULL: An error, see pbl_errno:
*
* <BR>PBL_ERROR_OUT_OF_MEMORY - Out of memory.
*/
PblStringBuilder* pblStringBuilderNew(void)
{
PblStringBuilder* stringBuilder = (PblStringBuilder*)pbl_malloc0("pblStringBuilderNew",
sizeof(PblStringBuilder));
if (!stringBuilder)
{
return NULL;
}
stringBuilder->list = pblListNewArrayList();
if (!stringBuilder->list)
{
PBL_FREE(stringBuilder);
return NULL;
}
return stringBuilder;
}
/**
* Removes all of the elements from the string builder.
*
* This function has a time complexity of O(N),
* with N being the number of elements in the string builder.
*
* @return void
*/
void pblStringBuilderClear( /* */
PblStringBuilder* stringBuilder /** The string builder to clear */
)
{
while (pblListSize(stringBuilder->list) > 0)
{
void* element = pblListRemoveLast(stringBuilder->list);
if (element != NULL && element != (void*)-1)
{
PBL_FREE(element);
}
}
stringBuilder->length = 0;
}
/**
* Frees the string builder's memory from heap.
*
* This function has a time complexity of O(N),
* with N being the number of elements in the string builder.
*
* @return void
*/
void pblStringBuilderFree( /* */
PblStringBuilder* stringBuilder /** The string builder to free */
)
{
pblStringBuilderClear(stringBuilder);
pblListFree(stringBuilder->list);
PBL_FREE(stringBuilder);
}
/**
* Returns the number of elements in the string builder.
*
* This function has a time complexity of O(1).
*
* @return int rc: The number of elements in the string builder.
*/
int pblStringBuilderSize( /* */
PblStringBuilder* stringBuilder /** The string builder to use */
)
{
return pblListSize(stringBuilder->list);
}
/**
* Returns the number of characters in the string builder.
*
* This function has a time complexity of O(1).
*
* @return size_t rc: The number of characters in the string builder.
*/
size_t pblStringBuilderLength( /* */
PblStringBuilder* stringBuilder /** The string builder to use */
)
{
return stringBuilder->length;
}
/**
* Appends a '\0' terminated string to the
* end of the data of the string builder.
*
* This function has a time complexity of O(N),
* with N being the length of the string to append.
*
* @return size_t rc >= 0: The length of the string builder.
* @return size_t rc == -1: An error, see pbl_errno:
*
* <BR>PBL_ERROR_OUT_OF_MEMORY - Out of memory.
*/
size_t pblStringBuilderAppendStr( /* */
PblStringBuilder* stringBuilder, /** The string builder to use */
const char* data /** The data to be added to the string builder */
)
{
size_t length = 0;
char* element = NULL;
if (data)
{
length = strlen(data);
element = (char*)pbl_memdup("pblStringBuilderAppendStr", (void*)data, length + 1);
if (!element)
{
return (size_t)-1;
}
}
if (pblListAdd(stringBuilder->list, element) < 0)
{
PBL_FREE(element);
return (size_t)-1;
}
return stringBuilder->length += length;
}
/**
* Appends at most n bytes of a string to the
* end of the data of the string builder.
*
* This function has a time complexity of O(N),
* with N being the number of characters to append.
*
* @return size_t rc >= 0: The length of the string builder.
* @return size_t rc == -1: An error, see pbl_errno:
*
* <BR>PBL_ERROR_OUT_OF_MEMORY - Out of memory.
*/
size_t pblStringBuilderAppendStrN( /* */
PblStringBuilder* stringBuilder, /** The string builder to use */
size_t n, /** The maximum number of bytes to append */
const char* data /** The data to be added to the string builder */
)
{
size_t length = 0;
char* element = NULL;
if (data && n > 0)
{
element = (char*)pbl_malloc("pblStringBuilderAppendStrN", n + 1);
if (!element)
{
return -1;
}
#ifdef WIN32
strncpy_s(element, n + 1, data, n);
#else
strncpy(element, data, n);
#endif
element[n] = '\0';
length = strlen(element);
}
if (pblListAdd(stringBuilder->list, element) < 0)
{
PBL_FREE(element);
return -1;
}
return stringBuilder->length += length;
}
#define _PBL_BUFFER_ON_STACK_SIZE_MAX 4096
/**
* Appends a variable string defined by the format parameter to the
* end of the data of the string builder.
*
* This function will append at most 4096 bytes of data to the string buffer.
* If you need to append more bytes, use the function pblStringBuilderAppendN.
*
* For the possible values of the format parameter,
* see the documentation of the printf(3) family of functions.
*
* This function has a time complexity of O(N),
* with N being the length of the string being appended.
*
* @return size_t rc >= 0: The length of the string builder.
* @return size_t rc == -1: An error, see pbl_errno:
*
* <BR>PBL_ERROR_OUT_OF_MEMORY - Out of memory.
* <BR>PBL_ERROR_PARAM_FORMAT - The parameter format is not valid.
*/
size_t pblStringBuilderAppend( /* */
PblStringBuilder* stringBuilder, /** The string builder to use */
const char* format, /** The format of the arguments to append */
... /** The variable arguments to append */
)
{
char* tag = "pblStringBuilderAppend";
size_t size = _PBL_BUFFER_ON_STACK_SIZE_MAX;
char buffer[_PBL_BUFFER_ON_STACK_SIZE_MAX];
int rc;
va_list args;
if (!format)
{
return pblStringBuilderAppendStr(stringBuilder, NULL);
}
va_start(args, format);
rc = vsnprintf(buffer, size, format, args);
va_end(args);
if (rc < 0)
{
#ifdef WIN32
_snprintf_s(pbl_errstr, PBL_ERRSTR_LEN, PBL_ERRSTR_LEN,
"%s: vsnprintf of format '%s' failed with errno %d\n", tag, format, errno);
#else
snprintf(pbl_errstr, PBL_ERRSTR_LEN, "%s: vsnprintf of format '%s' failed with errno %d\n", tag, format, errno);
#endif
pbl_errno = PBL_ERROR_PARAM_FORMAT;
return (size_t)-1;
}
return pblStringBuilderAppendStr(stringBuilder, buffer);
}
/**
* Appends at most n bytes of a variable string defined by the format parameter to the
* end of the data of the string builder.
*
* For the possible values of the format parameter,
* see the documentation of the printf(3) family of functions.
*
* This function has a time complexity of O(N),
* with N being the length of the string being appended.
*
* @return size_t rc >= 0: The length of the string builder.
* @return size_t rc == -1: An error, see pbl_errno:
*
* <BR>PBL_ERROR_OUT_OF_MEMORY - Out of memory.
* <BR>PBL_ERROR_PARAM_FORMAT - The parameter format is not valid.
*/
size_t pblStringBuilderAppendN( /* */
PblStringBuilder* stringBuilder, /** The string builder to use */
size_t n, /** The maximum number of bytes to append */
const char* format, /** The format of the arguments to append */
... /** The variable arguments to append */
)
{
char* tag = "pblStringBuilderAppendN";
char* data = NULL;
int rc;
size_t size_t_rc;
va_list args;
if (!format)
{
return pblStringBuilderAppendStr(stringBuilder, NULL);
}
if (n < 1)
{
return pblStringBuilderAppendStr(stringBuilder, "");
}
data = (char*)pbl_malloc(tag, n + 1);
if (!data)
{
return (size_t)-1;
}
va_start(args, format);
rc = vsnprintf(data, n + 1, format, args);
va_end(args);
if (rc < 0)
{
PBL_FREE(data);
#ifdef WIN32
_snprintf_s(pbl_errstr, PBL_ERRSTR_LEN, PBL_ERRSTR_LEN,
"%s: vsnprintf of format '%s' failed with errno %d\n", tag, format, errno);
#else
snprintf(pbl_errstr, PBL_ERRSTR_LEN, "%s: vsnprintf of format '%s' failed with errno %d\n", tag, format, errno);
#endif
pbl_errno = PBL_ERROR_PARAM_FORMAT;
return (size_t)-1;
}
data[n] = '\0';
size_t_rc = pblStringBuilderAppendStr(stringBuilder, data);
PBL_FREE(data);
return size_t_rc;
}
/**
* Converts the string builder's data to a '\0' terminated string.
*
* This function has a time complexity of O(N),
* with N being the length of the data of the string builder.
*
* Note: The memory for the data returned is malloced,
* it is the caller's responsibility to free that memory!
*
* @return char * rc != NULL: The data.
* @return char * rc == NULL: An error, see pbl_errno:
*
* <BR>PBL_ERROR_OUT_OF_MEMORY - Out of memory.
*/
char* pblStringBuilderToString( /* */
PblStringBuilder* stringBuilder /** The string builder to use */
)
{
char* tag = "pblStringBuilderToString";
int hasNext;
char* data = NULL;
char* ptr;
PblIterator iteratorBuffer;
PblIterator* iterator = &iteratorBuffer;
if (stringBuilder->length == 0)
{
return (char*)pbl_strdup(tag, "");
}
data = (char*)pbl_malloc(tag, stringBuilder->length + 1);
if (!data)
{
return (char*)NULL;
}
ptr = data;
if (pblIteratorInit((PblCollection*)stringBuilder->list, iterator) < 0)
{
PBL_FREE(data);
return (char*)NULL;
}
while ((hasNext = pblIteratorHasNext(iterator)) > 0)
{
char* element = (char*)pblIteratorNext(iterator);
if (element == (void*)-1)
{
// Concurrent modification
//
PBL_FREE(data);
return (char*)NULL;
}
if (element)
{
size_t length = strlen(element);
memcpy(ptr, element, length + 1);
ptr += length;
}
}
if (hasNext < 0)
{
// Concurrent modification
//
PBL_FREE(data);
return (char*)NULL;
}
return data;
}