2021-11-26 03:31:05 +00:00
|
|
|
/** @file
|
2008-09-03 19:14:52 +00:00
|
|
|
* String utility definitions
|
|
|
|
*
|
|
|
|
* Wireshark - Network traffic analyzer
|
|
|
|
* By Gerald Combs <gerald@wireshark.org>
|
|
|
|
* Copyright 1998 Gerald Combs
|
|
|
|
*
|
2018-02-07 11:26:45 +00:00
|
|
|
* SPDX-License-Identifier: GPL-2.0-or-later
|
2008-09-03 19:14:52 +00:00
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef __STR_UTIL_H__
|
|
|
|
#define __STR_UTIL_H__
|
|
|
|
|
2021-10-16 09:33:34 +00:00
|
|
|
#include <wireshark.h>
|
2021-07-10 15:12:03 +00:00
|
|
|
#include <wsutil/wmem/wmem.h>
|
|
|
|
|
2012-10-18 21:14:43 +00:00
|
|
|
#ifdef __cplusplus
|
|
|
|
extern "C" {
|
|
|
|
#endif /* __cplusplus */
|
|
|
|
|
2008-09-03 19:14:52 +00:00
|
|
|
/** Convert all upper-case ASCII letters to their ASCII lower-case
|
|
|
|
* equivalents, in place, with a simple non-locale-dependent
|
|
|
|
* ASCII mapping (A-Z -> a-z).
|
|
|
|
* All other characters are left unchanged, as the mapping to
|
|
|
|
* lower case may be locale-dependent.
|
|
|
|
*
|
|
|
|
* The string is assumed to be in a character encoding, such as
|
|
|
|
* an ISO 8859 or other EUC encoding, or UTF-8, in which all
|
|
|
|
* bytes in the range 0x00 through 0x7F are ASCII characters and
|
|
|
|
* non-ASCII characters are constructed from one or more bytes in
|
|
|
|
* the range 0x80 through 0xFF.
|
2012-10-10 19:17:31 +00:00
|
|
|
*
|
2008-09-03 19:14:52 +00:00
|
|
|
* @param str The string to be lower-cased.
|
2009-01-17 17:30:23 +00:00
|
|
|
* @return ptr to the string
|
2008-09-03 19:14:52 +00:00
|
|
|
*/
|
2013-02-28 14:09:46 +00:00
|
|
|
WS_DLL_PUBLIC
|
2009-01-17 17:30:23 +00:00
|
|
|
gchar *ascii_strdown_inplace(gchar *str);
|
2008-09-03 19:14:52 +00:00
|
|
|
|
|
|
|
/** Convert all lower-case ASCII letters to their ASCII upper-case
|
|
|
|
* equivalents, in place, with a simple non-locale-dependent
|
|
|
|
* ASCII mapping (a-z -> A-Z).
|
|
|
|
* All other characters are left unchanged, as the mapping to
|
|
|
|
* lower case may be locale-dependent.
|
|
|
|
*
|
|
|
|
* The string is assumed to be in a character encoding, such as
|
|
|
|
* an ISO 8859 or other EUC encoding, or UTF-8, in which all
|
|
|
|
* bytes in the range 0x00 through 0x7F are ASCII characters and
|
|
|
|
* non-ASCII characters are constructed from one or more bytes in
|
|
|
|
* the range 0x80 through 0xFF.
|
2012-10-10 19:17:31 +00:00
|
|
|
*
|
2008-09-03 19:14:52 +00:00
|
|
|
* @param str The string to be upper-cased.
|
2009-01-17 17:30:23 +00:00
|
|
|
* @return ptr to the string
|
2008-09-03 19:14:52 +00:00
|
|
|
*/
|
2013-02-28 14:09:46 +00:00
|
|
|
WS_DLL_PUBLIC
|
2009-01-17 17:30:23 +00:00
|
|
|
gchar *ascii_strup_inplace(gchar *str);
|
2008-09-03 19:14:52 +00:00
|
|
|
|
2012-02-17 17:22:12 +00:00
|
|
|
/** Check if an entire string consists of printable characters
|
2012-10-10 19:17:31 +00:00
|
|
|
*
|
2019-01-06 19:49:32 +00:00
|
|
|
* @param str The string to be checked
|
2013-08-10 21:27:42 +00:00
|
|
|
* @return TRUE if the entire string is printable, otherwise FALSE
|
2012-02-17 17:22:12 +00:00
|
|
|
*/
|
2013-02-28 14:09:46 +00:00
|
|
|
WS_DLL_PUBLIC
|
2019-01-04 13:12:04 +00:00
|
|
|
gboolean isprint_string(const gchar *str);
|
2012-02-17 17:22:12 +00:00
|
|
|
|
2018-04-27 13:29:32 +00:00
|
|
|
/** Check if an entire UTF-8 string consists of printable characters
|
|
|
|
*
|
2019-01-06 19:49:32 +00:00
|
|
|
* @param str The string to be checked
|
2018-04-27 13:29:32 +00:00
|
|
|
* @param length The number of bytes to validate
|
|
|
|
* @return TRUE if the entire string is printable, otherwise FALSE
|
|
|
|
*/
|
|
|
|
WS_DLL_PUBLIC
|
2019-01-04 13:12:04 +00:00
|
|
|
gboolean isprint_utf8_string(const gchar *str, guint length);
|
2018-04-27 13:29:32 +00:00
|
|
|
|
2012-02-17 17:22:12 +00:00
|
|
|
/** Check if an entire string consists of digits
|
2012-10-10 19:17:31 +00:00
|
|
|
*
|
2019-01-06 19:49:32 +00:00
|
|
|
* @param str The string to be checked
|
2013-08-10 21:27:42 +00:00
|
|
|
* @return TRUE if the entire string is digits, otherwise FALSE
|
2012-02-17 17:22:12 +00:00
|
|
|
*/
|
2013-02-28 14:09:46 +00:00
|
|
|
WS_DLL_PUBLIC
|
2019-01-04 13:12:04 +00:00
|
|
|
gboolean isdigit_string(const guchar *str);
|
2012-02-17 17:22:12 +00:00
|
|
|
|
2021-11-27 17:57:46 +00:00
|
|
|
/**
|
|
|
|
* Return the first occurrence of needle in haystack.
|
|
|
|
*
|
|
|
|
* @param haystack The data to search
|
|
|
|
* @param haystack_len The length of the search data
|
|
|
|
* @param needle The string to look for
|
|
|
|
* @param needle_len The length of the search string
|
|
|
|
* @return A pointer to the first occurrence of "needle" in
|
|
|
|
* "haystack". If "needle" isn't found or is NULL, or if
|
|
|
|
* "needle_len" is 0, NULL is returned.
|
|
|
|
*/
|
|
|
|
WS_DLL_PUBLIC
|
|
|
|
const guint8 *ws_memmem(const void *haystack, size_t haystack_len,
|
|
|
|
const void *needle, size_t needle_len);
|
|
|
|
|
|
|
|
/** Finds the first occurrence of string 'needle' in string 'haystack'.
|
|
|
|
* The matching is done in a case insensitive manner.
|
|
|
|
*
|
|
|
|
* @param haystack The string possibly containing the substring
|
|
|
|
* @param needle The substring to be searched
|
|
|
|
* @return A pointer into 'haystack' where 'needle' is first found.
|
|
|
|
* Otherwise it returns NULL.
|
|
|
|
*/
|
|
|
|
WS_DLL_PUBLIC
|
|
|
|
const char *ws_strcasestr(const char *haystack, const char *needle);
|
|
|
|
|
2021-11-29 13:52:09 +00:00
|
|
|
WS_DLL_PUBLIC
|
2021-11-29 13:37:57 +00:00
|
|
|
char *ws_escape_string(wmem_allocator_t *alloc, const char *string, bool add_quotes);
|
2021-11-29 13:52:09 +00:00
|
|
|
|
2014-01-08 00:28:13 +00:00
|
|
|
WS_DLL_PUBLIC
|
|
|
|
int ws_xton(char ch);
|
|
|
|
|
2012-10-10 19:17:31 +00:00
|
|
|
typedef enum {
|
2014-08-24 08:56:36 +00:00
|
|
|
format_size_unit_none = 0, /**< No unit will be appended. You must supply your own. */
|
|
|
|
format_size_unit_bytes = 1, /**< "bytes" for un-prefixed sizes, "B" otherwise. */
|
|
|
|
format_size_unit_bits = 2, /**< "bits" for un-prefixed sizes, "b" otherwise. */
|
|
|
|
format_size_unit_bits_s = 3, /**< "bits/s" for un-prefixed sizes, "bps" otherwise. */
|
|
|
|
format_size_unit_bytes_s = 4, /**< "bytes/s" for un-prefixed sizes, "Bps" otherwise. */
|
|
|
|
format_size_unit_packets = 5, /**< "packets" */
|
|
|
|
format_size_unit_packets_s = 6, /**< "packets/s" */
|
2012-10-18 17:29:37 +00:00
|
|
|
format_size_prefix_si = 0 << 8, /**< SI (power of 1000) prefixes will be used. */
|
2021-07-11 00:01:14 +00:00
|
|
|
format_size_prefix_iec = 1 << 8 /**< IEC (power of 1024) prefixes will be used. */
|
2012-10-10 19:17:31 +00:00
|
|
|
/* XXX format_size_prefix_default_for_this_particular_os ? */
|
|
|
|
} format_size_flags_e;
|
|
|
|
|
|
|
|
/** Given a size, return its value in a human-readable format
|
|
|
|
*
|
|
|
|
* Prefixes up to "T/Ti" (tera, tebi) are currently supported.
|
|
|
|
*
|
|
|
|
* @param size The size value
|
|
|
|
* @param flags Flags to control the output (unit of measurement,
|
2021-07-11 00:01:14 +00:00
|
|
|
* SI vs IEC, etc). Unit and prefix flags may be ORed together.
|
2012-10-10 19:17:31 +00:00
|
|
|
* @return A newly-allocated string representing the value.
|
|
|
|
*/
|
2013-02-28 14:09:46 +00:00
|
|
|
WS_DLL_PUBLIC
|
2021-07-10 15:12:03 +00:00
|
|
|
gchar *format_size_wmem(wmem_allocator_t *allocator, gint64 size, format_size_flags_e flags);
|
|
|
|
|
|
|
|
#define format_size(size, flags) format_size_wmem(NULL, size, flags)
|
2012-10-10 19:17:31 +00:00
|
|
|
|
2014-09-04 01:57:02 +00:00
|
|
|
WS_DLL_PUBLIC
|
|
|
|
gchar printable_char_or_period(gchar c);
|
2012-10-18 21:14:43 +00:00
|
|
|
|
2015-11-04 08:45:54 +00:00
|
|
|
/* To pass one of two strings, singular or plural */
|
|
|
|
#define plurality(d,s,p) ((d) == 1 ? (s) : (p))
|
|
|
|
|
2021-09-26 15:28:39 +00:00
|
|
|
#define true_or_false(val) ((val) ? "TRUE" : "FALSE")
|
|
|
|
|
2021-11-29 18:00:18 +00:00
|
|
|
#define string_or_null(val) ((val) ? (val) : "[NULL]")
|
|
|
|
|
2012-10-18 21:14:43 +00:00
|
|
|
#ifdef __cplusplus
|
|
|
|
}
|
2013-10-12 03:00:04 +00:00
|
|
|
|
|
|
|
/* Should we just have separate unit and prefix enums instead? */
|
|
|
|
extern format_size_flags_e operator|(format_size_flags_e lhs, format_size_flags_e rhs);
|
2012-10-18 21:14:43 +00:00
|
|
|
#endif /* __cplusplus */
|
|
|
|
|
2008-09-03 19:14:52 +00:00
|
|
|
#endif /* __STR_UTIL_H__ */
|