qf
/
quakeforge
mirror of https://git.code.sf.net/p/quake/quakeforge
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

dstring.h: 

document the functions (for doxygen)
dstring.c:
	fix a bunch of potential buffer overflows
This commit is contained in:
Bill Currie 2003-09-04 17:17:38 +00:00
parent d186f242b7
commit 9cd2d366ed
2 changed files with 80 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

69
include/QF/dstring.h
View File

@ -38,33 +38,100 @@ typedef struct dstring_s {
// General buffer functions
/** Create a new dstring. size and truesize start at 0 and no string buffer
is allocated.
*/
dstring_t *dstring_new(void);
/** Delete a dstring. Both the string buffer and dstring object are freed.
*/
void dstring_delete (dstring_t *dstr);
/** Resize the string buffer if necessary. The buffer is guaranteed to be
large enough to hold size bytes (rounded up to the next 1kB boundary)
*/
void dstring_adjust (dstring_t *dstr);
/** Copy len bytes from data into the dstring, replacing any existing data.
*/
void dstring_copy (dstring_t *dstr, const char *data, unsigned int len);
/** Append len bytes from data onto the end of the dstring.
*/
void dstring_append (dstring_t *dstr, const char *data, unsigned int len);
/** Insert len bytes from data int the dstring at pos. If pos is past the
end of the dstring, equivalent to dstring_append.
*/
void dstring_insert (dstring_t *dstr, unsigned int pos, const char *data,
unsigned int len);
unsigned int len);
/** Remove len bytes from the dstring starting at pos.
*/
void dstring_snip (dstring_t *dstr, unsigned int pos, unsigned int len);
/** Set the size of the dstring to 0 bytes. Does not free the string buffer
anticipating reuse.
*/
void dstring_clear (dstring_t *dstr);
/** Replace rlen bytes in dstring at pos with len bytes from data. Moves
trailing bytes as needed.
*/
void dstring_replace (dstring_t *dstr, unsigned int pos, unsigned int rlen,
const char *data, unsigned int len);
/** Delete the dstring object retaining the string buffer. The string buffer
will be just big enough to hold the data. Does NOT ensure the string is
null terminated.
*/
char *dstring_freeze (dstring_t *dstr);
// String-specific functions
/** Allocate a new dstring pre-initialized as a null terminated string. size
will be 1 and the first byte 0.
*/
dstring_t *dstring_newstr (void);
/** Copy the null terminated string into the dstring. Replaces any existing
data.
The dstring does not have to be null terminated but will become so.
*/
void dstring_copystr (dstring_t *dstr, const char *str);
/** Copy up to len bytes from the string into the dstring. Replaces any
existing data.
The dstring does not have to be null terminated but will become so.
*/
void dstring_copysubstr (dstring_t *dstr, const char *str, unsigned int len);
/** Append the null terminated string to the end of the dstring.
The dstring does not have to be null terminated but will become so.
However, any embedded nulls will be treated as the end of the dstring.
*/
void dstring_appendstr (dstring_t *dstr, const char *str);
/** Append up to len bytes from the string to the end of the dstring.
The dstring does not have to be null terminated but will become so.
However, any embedded nulls will be treated as the end of the dstring.
*/
void dstring_appendsubstr (dstring_t *dstr, const char *str, unsigned int len);
/** Insert the null terminated string into the dstring at pos. The dstring
is NOT forced to be null terminated.
*/
void dstring_insertstr (dstring_t *dstr, unsigned int pos, const char *str);
/** Insert up to len bytes from the string into the dstring at pos. The
dstring is NOT forced to be null terminated.
*/
void dstring_insertsubstr (dstring_t *dstr, unsigned int pos, const char *str,
unsigned int len);
/** Clear the dstring to be equivalent to "". Does not resize the string buffer
but size is set to 1.
dstr = dstring_new (); dstring_clearstr (dstr); is exactly equivalent to
dstr = dstring_newstr ();
*/
void dstring_clearstr (dstring_t *dstr);
//@{
/** Formatted printing to dstrings. Existing data is replaced by the formatted
string.
*/
int dvsprintf (dstring_t *dstr, const char *fmt, va_list args);
int dsprintf (dstring_t *dstr, const char *fmt, ...) __attribute__((format(printf,2,3)));
//@}
//@{
/** Formatted printing to dstrings. Formatted string is appened to the dstring.
Embedded nulls in the dstring are ignored.
*/
int davsprintf (dstring_t *dstr, const char *fmt, va_list args);
int dasprintf (dstring_t *dstr, const char *fmt, ...) __attribute__((format(printf,2,3)));
//@}
#endif // __dstring_h

12
libs/util/dstring.c
View File

@ -94,6 +94,8 @@ dstring_insert (dstring_t *dstr, unsigned int pos, const char *data,
{
unsigned int oldsize = dstr->size;
if (pos > dstr->size)
pos = dstr->size;
dstr->size += len;
dstring_adjust (dstr);
memmove (dstr->str + pos + len, dstr->str + pos, oldsize - pos);
@ -103,6 +105,12 @@ dstring_insert (dstring_t *dstr, unsigned int pos, const char *data,
void
dstring_snip (dstring_t *dstr, unsigned int pos, unsigned int len)
{
if (pos > dstr->size)
pos = dstr->size;
if (pos + len > dstr->size)
len = dstr->size - pos;
if (!len)
return;
memmove (dstr->str + pos, dstr->str + pos + len, dstr->size - pos - len);
dstr->size -= len;
dstring_adjust (dstr);
@ -120,6 +128,10 @@ dstring_replace (dstring_t *dstr, unsigned int pos, unsigned int rlen,
const char *data, unsigned int len)
{
unsigned int oldsize = dstr->size;
if (pos > dstr->size)
pos = dstr->size;
if (pos + rlen > dstr->size)
rlen = dstr->size - pos;
if (rlen < len) {
dstr->size += len - rlen;
dstring_adjust (dstr);