2012-12-15 00:46:36 +00:00
|
|
|
/* wmem_strbuf.h
|
|
|
|
* Definitions for the Wireshark Memory Manager String Buffer
|
|
|
|
* Copyright 2012, Evan Huus <eapache@gmail.com>
|
|
|
|
*
|
|
|
|
* Wireshark - Network traffic analyzer
|
|
|
|
* By Gerald Combs <gerald@wireshark.org>
|
|
|
|
* Copyright 1998 Gerald Combs
|
|
|
|
*
|
2018-02-08 16:31:35 +00:00
|
|
|
* SPDX-License-Identifier: GPL-2.0-or-later
|
2012-12-15 00:46:36 +00:00
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef __WMEM_STRBUF_H__
|
|
|
|
#define __WMEM_STRBUF_H__
|
|
|
|
|
|
|
|
#include <string.h>
|
|
|
|
#include <glib.h>
|
|
|
|
|
|
|
|
#include "wmem_core.h"
|
|
|
|
|
|
|
|
#ifdef __cplusplus
|
|
|
|
extern "C" {
|
|
|
|
#endif /* __cplusplus */
|
|
|
|
|
2013-05-26 02:40:40 +00:00
|
|
|
/** @addtogroup wmem
|
|
|
|
* @{
|
|
|
|
* @defgroup wmem-strbuf String Buffer
|
|
|
|
*
|
|
|
|
* A string object implementation on top of wmem.
|
|
|
|
*
|
|
|
|
* @{
|
|
|
|
*/
|
|
|
|
|
2012-12-15 00:46:36 +00:00
|
|
|
struct _wmem_strbuf_t;
|
|
|
|
|
|
|
|
typedef struct _wmem_strbuf_t wmem_strbuf_t;
|
|
|
|
|
2013-03-09 20:25:44 +00:00
|
|
|
WS_DLL_PUBLIC
|
2012-12-15 00:46:36 +00:00
|
|
|
wmem_strbuf_t *
|
|
|
|
wmem_strbuf_sized_new(wmem_allocator_t *allocator,
|
2013-04-25 22:54:36 +00:00
|
|
|
gsize alloc_len, gsize max_len)
|
|
|
|
G_GNUC_MALLOC;
|
2012-12-15 00:46:36 +00:00
|
|
|
|
2013-06-19 17:34:24 +00:00
|
|
|
#define wmem_strbuf_new_label(ALLOCATOR) \
|
|
|
|
wmem_strbuf_sized_new((ALLOCATOR), 0, ITEM_LABEL_LENGTH)
|
|
|
|
|
2013-03-09 20:25:44 +00:00
|
|
|
WS_DLL_PUBLIC
|
2012-12-15 00:46:36 +00:00
|
|
|
wmem_strbuf_t *
|
2013-04-25 22:54:36 +00:00
|
|
|
wmem_strbuf_new(wmem_allocator_t *allocator, const gchar *str)
|
|
|
|
G_GNUC_MALLOC;
|
2012-12-15 00:46:36 +00:00
|
|
|
|
2013-03-09 20:25:44 +00:00
|
|
|
WS_DLL_PUBLIC
|
2012-12-15 00:46:36 +00:00
|
|
|
void
|
|
|
|
wmem_strbuf_append(wmem_strbuf_t *strbuf, const gchar *str);
|
|
|
|
|
2020-09-17 19:27:26 +00:00
|
|
|
/* Appends up to append_len bytes (as allowed by strbuf->max_len) from
|
|
|
|
* str. Ensures that strbuf is null terminated afterwards but will copy
|
|
|
|
* embedded nulls. */
|
|
|
|
WS_DLL_PUBLIC
|
|
|
|
void
|
|
|
|
wmem_strbuf_append_len(wmem_strbuf_t *strbuf, const gchar *str, gsize append_len);
|
|
|
|
|
2013-03-09 20:25:44 +00:00
|
|
|
WS_DLL_PUBLIC
|
2012-12-29 20:37:53 +00:00
|
|
|
void
|
2013-04-25 22:54:36 +00:00
|
|
|
wmem_strbuf_append_printf(wmem_strbuf_t *strbuf, const gchar *format, ...)
|
|
|
|
G_GNUC_PRINTF(2, 3);
|
2012-12-29 20:37:53 +00:00
|
|
|
|
2019-10-08 15:35:34 +00:00
|
|
|
WS_DLL_PUBLIC
|
|
|
|
void
|
|
|
|
wmem_strbuf_append_vprintf(wmem_strbuf_t *strbuf, const gchar *fmt, va_list ap);
|
|
|
|
|
2013-04-26 21:30:24 +00:00
|
|
|
WS_DLL_PUBLIC
|
|
|
|
void
|
|
|
|
wmem_strbuf_append_c(wmem_strbuf_t *strbuf, const gchar c);
|
|
|
|
|
|
|
|
WS_DLL_PUBLIC
|
|
|
|
void
|
|
|
|
wmem_strbuf_append_unichar(wmem_strbuf_t *strbuf, const gunichar c);
|
|
|
|
|
2013-04-24 00:11:57 +00:00
|
|
|
WS_DLL_PUBLIC
|
|
|
|
void
|
|
|
|
wmem_strbuf_truncate(wmem_strbuf_t *strbuf, const gsize len);
|
|
|
|
|
2013-03-09 20:25:44 +00:00
|
|
|
WS_DLL_PUBLIC
|
2012-12-19 00:51:48 +00:00
|
|
|
const gchar *
|
|
|
|
wmem_strbuf_get_str(wmem_strbuf_t *strbuf);
|
|
|
|
|
2013-03-09 20:25:44 +00:00
|
|
|
WS_DLL_PUBLIC
|
2012-12-19 00:51:48 +00:00
|
|
|
gsize
|
|
|
|
wmem_strbuf_get_len(wmem_strbuf_t *strbuf);
|
|
|
|
|
2014-03-28 20:28:53 +00:00
|
|
|
/** Truncates the allocated memory down to the minimal amount, frees the header
|
|
|
|
* structure, and returns a non-const pointer to the raw string. The
|
|
|
|
* wmem_strbuf_t structure cannot be used after this is called. Basically a
|
|
|
|
* destructor for when you still need the underlying C-string.
|
|
|
|
*/
|
|
|
|
WS_DLL_PUBLIC
|
|
|
|
char *
|
|
|
|
wmem_strbuf_finalize(wmem_strbuf_t *strbuf);
|
|
|
|
|
2013-05-26 02:40:40 +00:00
|
|
|
/** @}
|
|
|
|
* @} */
|
|
|
|
|
2012-12-15 00:46:36 +00:00
|
|
|
#ifdef __cplusplus
|
|
|
|
}
|
|
|
|
#endif /* __cplusplus */
|
|
|
|
|
|
|
|
#endif /* __WMEM_STRBUF_H__ */
|
|
|
|
|
|
|
|
/*
|
2019-07-26 18:43:17 +00:00
|
|
|
* Editor modelines - https://www.wireshark.org/tools/modelines.html
|
2012-12-15 00:46:36 +00:00
|
|
|
*
|
|
|
|
* Local variables:
|
|
|
|
* c-basic-offset: 4
|
|
|
|
* tab-width: 8
|
|
|
|
* indent-tabs-mode: nil
|
|
|
|
* End:
|
|
|
|
*
|
|
|
|
* vi: set shiftwidth=4 tabstop=8 expandtab:
|
|
|
|
* :indentSize=4:tabSize=8:noTabs=true:
|
|
|
|
*/
|