From 2f2ddc1f2dbca56c874e8f9c31b5b963202d80e7 Mon Sep 17 00:00:00 2001 From: Eric Haszlakiewicz Date: Thu, 14 Apr 2022 01:12:43 +0000 Subject: Generate docs for the 0.16 release --- doc/html/printbuf_8h.html | 384 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 384 insertions(+) create mode 100644 doc/html/printbuf_8h.html (limited to 'doc/html/printbuf_8h.html') diff --git a/doc/html/printbuf_8h.html b/doc/html/printbuf_8h.html new file mode 100644 index 0000000..1b496f4 --- /dev/null +++ b/doc/html/printbuf_8h.html @@ -0,0 +1,384 @@ + + + + + +json-c: printbuf.h File Reference + + + + + + +
+
+ + + + + + +
+
json-c +  0.16 +
+
+
+ + + + +
+
+
+Data Structures | +Macros | +Typedefs | +Functions
+
+
printbuf.h File Reference
+
+
+ +

Internal string buffer handling. Unless you're writing a json_object_to_json_string_fn implementation for use with json_object_set_serializer() direct use of this is not recommended. +More...

+ + + + +

+Data Structures

struct  printbuf
 
+ + + + + + + + + +

+Macros

#define JSON_EXPORT   extern
 
#define printbuf_memappend_fast(p, bufptr, bufsize)
 
#define printbuf_length(p)   ((p)->bpos)
 
#define printbuf_strappend(pb, str)   printbuf_memappend((pb), _printbuf_check_literal(str), sizeof(str) - 1)
 
+ + + +

+Typedefs

typedef struct printbuf printbuf
 
+ + + + + + + + + + + + + +

+Functions

JSON_EXPORT struct printbuf * printbuf_new (void)
 
JSON_EXPORT int printbuf_memappend (struct printbuf *p, const char *buf, int size)
 
JSON_EXPORT int printbuf_memset (struct printbuf *pb, int offset, int charvalue, int len)
 
JSON_EXPORT int sprintbuf (struct printbuf *p, const char *msg,...)
 
JSON_EXPORT void printbuf_reset (struct printbuf *p)
 
JSON_EXPORT void printbuf_free (struct printbuf *p)
 
+

Detailed Description

+

Internal string buffer handling. Unless you're writing a json_object_to_json_string_fn implementation for use with json_object_set_serializer() direct use of this is not recommended.

+

Macro Definition Documentation

+ +
+
+ + + + +
#define JSON_EXPORT   extern
+
+ +
+
+ +
+
+ + + + + + + + +
#define printbuf_length( p)   ((p)->bpos)
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
#define printbuf_memappend_fast( p,
 bufptr,
 bufsize 
)
+
+Value:
do \
+
{ \
+
if ((p->size - p->bpos) > bufsize) \
+
{ \
+
memcpy(p->buf + p->bpos, (bufptr), bufsize); \
+
p->bpos += bufsize; \
+
p->buf[p->bpos] = '\0'; \
+
} \
+
else \
+
{ \
+
printbuf_memappend(p, (bufptr), bufsize); \
+
} \
+
} while (0)
+
+
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
#define printbuf_strappend( pb,
 str 
)   printbuf_memappend((pb), _printbuf_check_literal(str), sizeof(str) - 1)
+
+

This is an optimization wrapper around printbuf_memappend() that is useful for appending string literals. Since the size of string constants is known at compile time, using this macro can avoid a costly strlen() call. This is especially helpful when a constant string must be appended many times. If you got here because of a compilation error caused by passing something other than a string literal, use printbuf_memappend_fast() in conjunction with strlen().

+

See also: printbuf_memappend_fast() printbuf_memappend() sprintbuf()

+ +
+
+

Typedef Documentation

+ +
+
+ + + + +
typedef struct printbuf printbuf
+
+ +
+
+

Function Documentation

+ +
+
+ + + + + + + + +
JSON_EXPORT void printbuf_free (struct printbuf * p)
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
JSON_EXPORT int printbuf_memappend (struct printbuf * p,
const char * buf,
int size 
)
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
JSON_EXPORT int printbuf_memset (struct printbuf * pb,
int offset,
int charvalue,
int len 
)
+
+

Set len bytes of the buffer to charvalue, starting at offset offset. Similar to calling memset(x, charvalue, len);

+

The memory allocated for the buffer is extended as necessary.

+

If offset is -1, this starts at the end of the current data in the buffer.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
JSON_EXPORT struct printbuf* printbuf_new (void )
+ 		+read
+
+ +
+
+ +
+
+ + + + + + + + +
JSON_EXPORT void printbuf_reset (struct printbuf * p)
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
JSON_EXPORT int sprintbuf (struct printbuf * p,
const char * msg,
 ... 
)
+
+

Formatted print to printbuf.

+

This function is the most expensive of the available functions for appending string data to a printbuf and should be used only where convenience is more important than speed. Avoid using this function in high performance code or tight loops; in these scenarios, consider using snprintf() with a static buffer in conjunction with one of the printbuf_*append() functions.

+

See also: printbuf_memappend_fast() printbuf_memappend() printbuf_strappend()

+ +
+
+
+ +
+Generated on Thu Apr 14 2022 01:11:24 for json-c by   +doxygen + 1.8.2 +
+ + -- cgit v1.2.1