ff9f9fc431
It ends up dragging in libwireshark headers, which programs not linking with libwireshark shouldn't do. In particular, including <epan/address.h> causes some functions that refer to libwireshark functions to be defined if the compiler doesn't handle "static inline" the way GCC does, and you end up requiring libwireshark even though you shouldn't require it. Move plurality() to wsutil/str_util.h, so that non-libwireshark code can get it without include epan/packet.h. Fix includes as necessary. Change-Id: Ie4819719da4c2b349f61445112aa419e99b977d3 Reviewed-on: https://code.wireshark.org/review/11545 Reviewed-by: Guy Harris <guy@alum.mit.edu>
127 lines
4.5 KiB
C
127 lines
4.5 KiB
C
/* str_util.h
|
|
* String utility definitions
|
|
*
|
|
* Wireshark - Network traffic analyzer
|
|
* By Gerald Combs <gerald@wireshark.org>
|
|
* Copyright 1998 Gerald Combs
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
*/
|
|
|
|
#ifndef __STR_UTIL_H__
|
|
#define __STR_UTIL_H__
|
|
|
|
#include <glib.h>
|
|
#include "ws_symbol_export.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif /* __cplusplus */
|
|
|
|
/** 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.
|
|
*
|
|
* @param str The string to be lower-cased.
|
|
* @return ptr to the string
|
|
*/
|
|
WS_DLL_PUBLIC
|
|
gchar *ascii_strdown_inplace(gchar *str);
|
|
|
|
/** 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.
|
|
*
|
|
* @param str The string to be upper-cased.
|
|
* @return ptr to the string
|
|
*/
|
|
WS_DLL_PUBLIC
|
|
gchar *ascii_strup_inplace(gchar *str);
|
|
|
|
/** Check if an entire string consists of printable characters
|
|
*
|
|
* @param string The string to be checked
|
|
* @return TRUE if the entire string is printable, otherwise FALSE
|
|
*/
|
|
WS_DLL_PUBLIC
|
|
gboolean isprint_string(const gchar *string);
|
|
|
|
/** Check if an entire string consists of digits
|
|
*
|
|
* @param string The string to be checked
|
|
* @return TRUE if the entire string is digits, otherwise FALSE
|
|
*/
|
|
WS_DLL_PUBLIC
|
|
gboolean isdigit_string(guchar *string);
|
|
|
|
WS_DLL_PUBLIC
|
|
int ws_xton(char ch);
|
|
|
|
typedef enum {
|
|
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" */
|
|
format_size_prefix_si = 0 << 8, /**< SI (power of 1000) prefixes will be used. */
|
|
format_size_prefix_iec = 1 << 8 /**< IEC (power of 1024) prefixes will be used. */
|
|
/* 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,
|
|
* SI vs IEC, etc). Unit and prefix flags may be ORed together.
|
|
* @return A newly-allocated string representing the value.
|
|
*/
|
|
WS_DLL_PUBLIC
|
|
gchar *format_size(gint64 size, format_size_flags_e flags);
|
|
|
|
WS_DLL_PUBLIC
|
|
gchar printable_char_or_period(gchar c);
|
|
|
|
/* To pass one of two strings, singular or plural */
|
|
#define plurality(d,s,p) ((d) == 1 ? (s) : (p))
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
|
|
/* 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);
|
|
#endif /* __cplusplus */
|
|
|
|
#endif /* __STR_UTIL_H__ */
|