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
|
/* -*- Mode: C -*- */
/* filament.h --- a bit like a string but different =)O|
* Copyright (C) 1998, 1999, 2000, 2002 Gary V. Vaughan
* Originally by Gary V. Vaughan, 1998
* This file is part of Snprintfv
*
* Snprintfv is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License as
* published by the Free Software Foundation; either version 2 of the
* License, or (at your option) any later version.
*
* Snprintfv program 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
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* As a special exception to the GNU General Public License, if you
* distribute this file as part of a program that also links with and
* uses the libopts library from AutoGen, you may include it under
* the same distribution terms used by the libopts library.
*/
/* Code: */
#ifndef FILAMENT_H
#define FILAMENT_H 1
#include <snprintfv/compat.h>
#ifdef __cplusplus
extern "C"
{
#if 0
/* This brace is so that emacs can still indent properly: */ }
#endif
#endif /* __cplusplus */
#define FILAMENT_BUFSIZ (512 - sizeof(char *) - (2 * sizeof(size_t)))
/**
* Filament:
* Opaque data type used to hold 8-bit clean dynamic strings which know
* their own length and resize themselves to avoid buffer overruns.
**/
typedef struct filament Filament;
struct filament
{
char *value; /* pointer to the start of the string */
size_t length; /* length of the string */
size_t size; /* total memory allocated */
char buffer[FILAMENT_BUFSIZ]; /* usually string == &buffer[0] */
};
@protos filament.c
/* Save the overhead of a function call in the great majority of cases. */
#define fil_maybe_extend(fil, len, copy) \
(((len)>=(fil)->size) ? _fil_extend((fil), (len), (copy)) : (void)0)
/**
* filval:
* @fil: The Filament object being queried.
*
* Return value:
* A pointer to the null terminated string held by the Filament
* object is returned. Since the @fil may contain embedded nulls, it
* is not entirely safe to use the strfoo() API to examine the contents
* of the return value.
**/
SNV_INLINE char *
filval (Filament *fil)
{
/* Because we have been careful to ensure there is always at least
one spare byte of allocated memory, it is safe to set it here. */
fil->value[fil->length] = '\0';
return (char *) (fil->value);
}
/**
* fillen:
* @fil: The Filament object being queried.
*
* Return value:
* The length of @fil, including any embedded nulls, but excluding the
* terminating null, is returned.
**/
SNV_INLINE size_t
fillen (Filament *fil)
{
return fil->length;
}
/**
* filelt:
* @fil: The Filament being queried.
* @n: A zero based index into @fil.
*
* This function looks for the @n'th element of @fil.
*
* Return value:
* If @n is an index inside the Filament @fil, then the character stored
* at that index cast to an int is returned, otherwise @n is outside
* this range and -1 is returned.
**/
SNV_INLINE int
filelt (Filament *fil, ssize_t n)
{
if ((n >= 0) && (n < (ssize_t)fil->length))
return (int) fil->value[n];
else
return -1;
}
/**
* filncat:
* @fil: The destination Filament of the concatenation.
* @str: The address of the source bytes for concatenation.
* @n: The number of bytes to be copied from @str.
*
* @n bytes starting with the byte at address @str are destructively
* concatenated to @fil. If necessary, @fil is dynamically reallocated
* to make room for this operation.
*
* Return value:
* A pointer to the (not null terminated) string which is the result
* of this concatenation is returned.
**/
SNV_INLINE char *
filncat (Filament *fil, const char *str, size_t n)
{
fil_maybe_extend (fil, n + fil->length, true);
memcpy (fil->value + fil->length, str, n);
fil->length += n;
return fil->value;
}
/**
* filcat:
* @fil: The destination Filament of the concatenation.
* @str: The address of the source bytes for concatenation.
*
* The bytes starting at address @str upto and including the first null
* byte encountered are destructively concatenated to @fil. If
* necessary @fil is dynamically reallocated to make room for this
* operation.
*
* Return value:
* A pointer to the (not null terminated) string which is the result
* of this concatenation is returned.
**/
SNV_INLINE char *
filcat (Filament *fil, const char *str)
{
size_t length = strlen (str);
return filncat (fil, str, length);
}
/**
* filccat:
* @fil: The destination Filament of the concatenation.
* @c: The character to append to @fil.
*
* @c is destructively concatenated to @fil. If necessary, @fil is
* dynamically reallocated to make room for this operation. When used
* repeatedly this function is less efficient than %filncat,
* since it must check whether to extend the filament before each
* character is appended.
*
* Return value:
* A pointer to the (not null terminated) string which is the result
* of this concatenation is returned.
**/
SNV_INLINE char *
filccat (Filament *fil, int c)
{
fil_maybe_extend (fil, 1 + fil->length, true);
fil->value[fil->length++] = c;
return fil->value;
}
#ifdef __cplusplus
#if 0
/* This brace is so that emacs can still indent properly: */
{
#endif
}
#endif /* __cplusplus */
#endif /* FILAMENT_H */
/* filament.h ends here */
|
