str_util.h

Go to the documentation of this file.

 
#ifndef __STR_UTIL_H__
#define __STR_UTIL_H__
 
#include <wireshark.h>
#include <wsutil/wmem/wmem.h>
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
WS_DLL_PUBLIC
char *
wmem_strconcat(wmem_allocator_t *allocator, const char *first, ...)
G_GNUC_MALLOC G_GNUC_NULL_TERMINATED;
 
WS_DLL_PUBLIC
char *
wmem_strjoin(wmem_allocator_t *allocator,
             const char *separator, const char *first, ...)
G_GNUC_MALLOC G_GNUC_NULL_TERMINATED;
 
WS_DLL_PUBLIC
char *
wmem_strjoinv(wmem_allocator_t *allocator,
              const char *separator, char **str_array)
G_GNUC_MALLOC;
 
WS_DLL_PUBLIC
char **
wmem_strsplit(wmem_allocator_t *allocator, const char *src,
        const char *delimiter, int max_tokens);
 
WS_DLL_PUBLIC
char*
wmem_ascii_strdown(wmem_allocator_t *allocator, const char *str, ssize_t len);
 
WS_DLL_PUBLIC
char *ascii_strdown_inplace(char *str);
 
WS_DLL_PUBLIC
char *ascii_strup_inplace(char *str);
 
WS_DLL_PUBLIC
bool isprint_string(const char *str);
 
WS_DLL_PUBLIC
bool isprint_utf8_string(const char *str, const unsigned length);
 
WS_DLL_PUBLIC
bool isdigit_string(const unsigned char *str);
 
WS_DLL_PUBLIC
const char *ws_ascii_strcasestr(const char *haystack, const char *needle);
 
WS_DLL_PUBLIC
const uint8_t *ws_memrchr(const void *haystack, int ch, size_t n);
 
WS_DLL_PUBLIC
char *ws_escape_string(wmem_allocator_t *alloc, const char *string, bool add_quotes);
 
WS_DLL_PUBLIC
char *ws_escape_string_len(wmem_allocator_t *alloc, const char *string, ssize_t len, bool add_quotes);
 
/* Replace null bytes with "\0". */
WS_DLL_PUBLIC
char *ws_escape_null(wmem_allocator_t *alloc, const char *string, size_t len, bool add_quotes);
 
/* Escape as in a number of CSV dialects.
 *
 * @param allocator  The wmem scope to use to allocate the returned string
 * @param string  The input string to escape
 * @param add_quotes  Whether to surround the string with quote_char
 * @param quote_char  The quote character, always escaped in some way.
 * @param double_quote  Whether to escape the quote character by doubling it
 * @param escape_whitespace  Whether to escape whitespace with a backslash
 * @return  The escaped string
 *
 * @note If double_quote is false, then quote_or_delim is escaped with a
 * backslash ('\'). The quote character can be '\0', in which case it is
 * ignored. If any character is being escaped with a backslash (i.e.,
 * quote_char is not '\0' and double_quote is false, or escape_whitespace
 * is true), then backslash is also escaped.  If add_quotes is false, then
 * quote_char can either be a quote character (if the string will be quoted
 * later after further manipulation) or the delimiter (to escape it, since
 * the string is not being quoted.).
 */
WS_DLL_PUBLIC
char *ws_escape_csv(wmem_allocator_t *alloc, const char *string, bool add_quotes, char quote_char, bool double_quote, bool escape_whitespace);
 
WS_DLL_PUBLIC
int ws_xton(char ch);
 
typedef enum {
    FORMAT_SIZE_UNIT_NONE,          
    /* XXX - This does not append a trailing space if there is no prefix.
     * That's good if you intend to list the unit somewhere else, e.g. in a
     * legend, header, or other column, but doesn't work well if intending
     * to append your own unit. You can test whether there's a prefix or
     * not with g_ascii_isdigit() (plus special handling for inf and NaN).
     */
    FORMAT_SIZE_UNIT_BYTES,         
    FORMAT_SIZE_UNIT_BITS,          
    FORMAT_SIZE_UNIT_BITS_S,        
    FORMAT_SIZE_UNIT_BYTES_S,       
    FORMAT_SIZE_UNIT_PACKETS,       
    FORMAT_SIZE_UNIT_PACKETS_S,     
    FORMAT_SIZE_UNIT_EVENTS,        
    FORMAT_SIZE_UNIT_EVENTS_S,      
    FORMAT_SIZE_UNIT_FIELDS,        
    /* These next two aren't really for format_size (which takes an int) */
    FORMAT_SIZE_UNIT_SECONDS,       
    FORMAT_SIZE_UNIT_ERLANGS,       
} format_size_units_e;
 
#define FORMAT_SIZE_PREFIX_SI   (1 << 0)    
#define FORMAT_SIZE_PREFIX_IEC  (1 << 1)    
WS_DLL_PUBLIC
char *format_units(wmem_allocator_t *allocator, double size,
                   format_size_units_e unit, uint16_t flags,
                   int precision);
 
WS_DLL_PUBLIC
char *format_size_wmem(wmem_allocator_t *allocator, int64_t size,
                        format_size_units_e unit, uint16_t flags);
 
#define format_size(size, unit, flags) \
    format_size_wmem(NULL, size, unit, flags)
 
WS_DLL_PUBLIC
char printable_char_or_period(char c);
 
WS_DLL_PUBLIC WS_RETNONNULL
const char *ws_strerrorname_r(int errnum, char *buf, size_t buf_size);
 
WS_DLL_PUBLIC
char *ws_strdup_underline(wmem_allocator_t *allocator, long offset, size_t len);
 
WS_DLL_PUBLIC
char *format_text(wmem_allocator_t* allocator, const char *string, size_t len);
 
WS_DLL_PUBLIC
char *format_text_string(wmem_allocator_t* allocator, const char *string);
 
WS_DLL_PUBLIC
char *format_text_wsp(wmem_allocator_t* allocator, const char *line, size_t len);
 
WS_DLL_PUBLIC
char *format_text_chr(wmem_allocator_t *allocator,
                        const char *string, size_t len, char chr);
 
WS_DLL_PUBLIC
char *format_char(wmem_allocator_t *allocator, char c);
 
WS_DLL_PUBLIC
char* ws_utf8_truncate(char *string, size_t len);
 
WS_DLL_PUBLIC
void EBCDIC_to_ASCII(uint8_t *buf, unsigned bytes);
 
WS_DLL_PUBLIC
uint8_t EBCDIC_to_ASCII1(uint8_t c);
 
/* Types of character encodings */
typedef enum {
    HEXDUMP_ENC_ASCII     = 0, /* ASCII */
    HEXDUMP_ENC_EBCDIC    = 1  /* EBCDIC */
} hex_dump_enc;
 
/*
 * Hexdump options for ASCII:
 */
 
#define HEXDUMP_ASCII_MASK            (0x0003U)
#define HEXDUMP_ASCII_OPTION(option)  ((option) & HEXDUMP_ASCII_MASK)
 
#define HEXDUMP_ASCII_INCLUDE         (0x0000U) /* include ASCII section no delimiters (legacy tshark behavior) */
#define HEXDUMP_ASCII_DELIMIT         (0x0001U) /* include ASCII section with delimiters, useful for reliable detection of last hexdata */
#define HEXDUMP_ASCII_EXCLUDE         (0x0002U) /* exclude ASCII section from hexdump reports, if we really don't want or need it */
 
WS_DLL_PUBLIC
bool hex_dump_buffer(bool (*print_line)(void *, const char *), void *fp,
                                    const unsigned char *cp, unsigned length,
                                    hex_dump_enc encoding,
                                    unsigned ascii_option);
 
/* To pass one of two strings, singular or plural */
#define plurality(d,s,p) ((d) == 1 ? (s) : (p))
 
#define true_or_false(val) ((val) ? "TRUE" : "FALSE")
 
#define string_or_null(val) ((val) ? (val) : "[NULL]")
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif /* __STR_UTIL_H__ */