subsurface/membuffer.h
Linus Torvalds 0b8deb2a15 Add C string helper to membuffer interface
I don't know why I didn't do this from the beginning.  We often build up
a membuffer and then want to use it as a C string.  You could do it by
hand by adding the zero byte at the end, but that's just annoying.

Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-03-07 16:36:11 -08:00

65 lines
2.0 KiB
C

#ifndef MEMBUFFER_H
#define MEMBUFFER_H
#ifdef __cplusplus
extern "C" {
#endif
#include <ctype.h>
struct membuffer {
unsigned int len, alloc;
char *buffer;
};
#ifdef __GNUC__
#define __printf(x, y) __attribute__((__format__(__printf__, x, y)))
#else
#define __printf(x, y)
#endif
extern void free_buffer(struct membuffer *);
extern void flush_buffer(struct membuffer *, FILE *);
extern void put_bytes(struct membuffer *, const char *, int);
extern void put_string(struct membuffer *, const char *);
extern void strip_mb(struct membuffer *);
extern const char *mb_cstring(struct membuffer *);
extern __printf(2, 0) void put_vformat(struct membuffer *, const char *, va_list);
extern __printf(2, 3) void put_format(struct membuffer *, const char *fmt, ...);
/* Output one of our "milli" values with type and pre/post data */
extern void put_milli(struct membuffer *, const char *, int, const char *);
/*
* Helper functions for showing particular types. If the type
* is empty, nothing is done, and the function returns false.
* Otherwise, it returns true.
*
* The two "const char *" at the end are pre/post data.
*
* The reason for the pre/post data is so that you can easily
* prepend and append a string without having to test whether the
* type is empty. So
*
* put_temperature(b, temp, "Temp=", " C\n");
*
* writes nothing to the buffer if there is no temperature data,
* but otherwise would a string that looks something like
*
* "Temp=28.1 C\n"
*
* to the memory buffer (typically the post/pre will be some XML
* pattern and unit string or whatever).
*/
extern int put_temperature(struct membuffer *, temperature_t, const char *, const char *);
extern int put_depth(struct membuffer *, depth_t, const char *, const char *);
extern int put_duration(struct membuffer *, duration_t, const char *, const char *);
extern int put_pressure(struct membuffer *, pressure_t, const char *, const char *);
extern int put_salinity(struct membuffer *, int, const char *, const char *);
#ifdef __cplusplus
}
#endif
#endif