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
|
/** @file stringbuffer.h
*
* Implements a general string buffer: it builds a string by concatenating. It
* allocates enough memory to hold the whole string; there is no upper limit
* for the total string length.
*
* Usage is:
* <code>
* StringBuffer *sb = stringbuffer_new();
* stringbuffer_append_string(sb, "abc");
* stringbuffer_append_string(sb, "def");
* ... more calls to stringbuffer_append_xxx()
* char *str = stringbuffer_finish(sb)
* ... use str
* free(str);
* </code>
*
* No function ever fails. In case not enough memory is availabl, {@link
* fatal()} is called.
*/
#ifndef STRING_BUFFER_H
#define STRING_BUFFER_H
#include <ctype.h>
#include "global.h"
/**
* The string buffer state.
*/
typedef struct StringBuffer StringBuffer;
/**
* Create a new string buffer.
*
* @return The newly allocated string buffer.
*/
StringBuffer *stringbuffer_new(void);
/**
* Totally delete a string buffer.
* @param sb String to delete, pointer becomes invalid after the call.
*/
void stringbuffer_delete(StringBuffer *sb);
/**
* Deallocate the string buffer instance and return the string.
*
* The passed string buffer must not be accessed afterwards.
*
* @param sb The string buffer to deallocate.
*
* @return The result string; to free it, call <code>free()</code> on it.
*/
char *stringbuffer_finish(StringBuffer *sb);
/**
* Deallocate the string buffer instance and return the string as a shared
* string.
*
* The passed string buffer must not be accessed afterwards.
*
* @param sb The string buffer to deallocate.
*
* @return The result shared string; to free it, call
* <code>free_string()</code> on it.
*/
sstring stringbuffer_finish_shared(StringBuffer *sb);
/**
* Append a string to a string buffer instance.
*
* @param sb The string buffer to modify.
*
* @param str The string to append.
*/
void stringbuffer_append_string(StringBuffer *sb, const char *str);
/**
* Append a formatted string to a string buffer instance.
*
* @param sb The string buffer to modify.
*
* @param format The format string to append.
*/
void stringbuffer_append_printf(StringBuffer *sb, const char *format, ...);
/**
* Append the contents of a string buffer instance to another string buffer
* instance.
*
* @param sb The string buffer to modify.
*
* @param sb2 The string buffer to append; it must be different from sb.
*/
void stringbuffer_append_stringbuffer(StringBuffer *sb, const StringBuffer *sb2);
/**
* Return the current length of the buffer.
* @param sb The string buffer to check.
*
* @return current length of sb.
*/
size_t stringbuffer_length(StringBuffer *sb);
/**
* Trim trailing whitespace from a stringbuffer.
*
* @param sb
* The stringbuffer.
*/
void stringbuffer_trim_whitespace(StringBuffer *sb);
#endif
|
