82 lines
2.6 KiB
C
82 lines
2.6 KiB
C
/* wsutil/to_str.h
|
|
* Definitions for utilities to convert various other types to strings.
|
|
*
|
|
* Wireshark - Network traffic analyzer
|
|
* By Gerald Combs <gerald@wireshark.org>
|
|
* Copyright 1998 Gerald Combs
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0-or-later
|
|
*/
|
|
|
|
#ifndef __WSUTIL_TO_STR_H__
|
|
#define __WSUTIL_TO_STR_H__
|
|
|
|
#include <glib.h>
|
|
|
|
#include <ws_symbol_export.h>
|
|
#include <wsutil/wmem/wmem.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif /* __cplusplus */
|
|
|
|
/**
|
|
* bytes_to_hexstr()
|
|
*
|
|
* Output hex represetation of guint8 ad array, and return pointer after last character.
|
|
* It always output full representation (padded with 0).
|
|
*
|
|
* String is not NUL terminated by this routine.
|
|
* There needs to be at least len * 2 bytes in the buffer.
|
|
*/
|
|
WS_DLL_PUBLIC char *bytes_to_hexstr(char *out, const guint8 *ad, size_t len);
|
|
|
|
/**
|
|
* bytes_to_hexstr_punct()
|
|
*
|
|
* Output hex represetation of guint8 ad array, and return pointer after last character.
|
|
* Each byte will be separated with punct character (cannot be NUL).
|
|
* It always output full representation (padded with 0).
|
|
*
|
|
* String is not NUL terminated by this routine.
|
|
* There needs to be at least len * 3 - 1 bytes in the buffer.
|
|
*/
|
|
WS_DLL_PUBLIC char *bytes_to_hexstr_punct(char *out, const guint8 *ad, size_t len, char punct);
|
|
|
|
/* Max string length for displaying byte string. */
|
|
#define MAX_BYTE_STR_LEN 72
|
|
|
|
/** Turn an array of bytes into a string showing the bytes in hex,
|
|
* separated by a punctuation character.
|
|
*
|
|
* @param scope memory allocation scheme used
|
|
* @param ad A pointer to the byte array
|
|
* @param len The length of the byte array
|
|
* @param punct The punctuation character
|
|
* @param max Maximum string length, plus ellipsis if present
|
|
* @return A pointer to the formatted string
|
|
*
|
|
* @see bytes_to_str()
|
|
*/
|
|
WS_DLL_PUBLIC gchar *bytes_to_str_punct_max(wmem_allocator_t *scope, const guint8 *ad, size_t len, const char punct, size_t max);
|
|
|
|
#define bytes_to_str_punct(scope, ad, len, punct) bytes_to_str_punct_max(scope, ad, len, punct, MAX_BYTE_STR_LEN)
|
|
|
|
/** Turn an array of bytes into a string showing the bytes in hex.
|
|
*
|
|
* @param scope memory allocation scheme used
|
|
* @param bd A pointer to the byte array
|
|
* @param bd_len The length of the byte array
|
|
* @param max Maximum string length, plus ellipsis if present
|
|
* @return A pointer to the formatted string
|
|
*/
|
|
WS_DLL_PUBLIC char *bytes_to_str_max(wmem_allocator_t *scope, const guint8 *bd, size_t bd_len, size_t max);
|
|
|
|
#define bytes_to_str(scope, bd, len) bytes_to_str_max(scope, bd, len, MAX_BYTE_STR_LEN)
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif /* __cplusplus */
|
|
|
|
#endif /* __TO_STR_H__ */
|