pytest.ini: declare minimum version requirement
[metze/wireshark/wip.git] / epan / strutil.h
index dceeabe76b555a8c6b1de4933d26c3b1bffc6917..2046cb0506715f522cd930bd0c113edba0e2bd67 100644 (file)
@@ -1,31 +1,23 @@
 /* strutil.h
  * String utility definitions
  *
- * $Id$
- *
- * Ethereal - Network traffic analyzer
- * By Gerald Combs <gerald@ethereal.com>
+ * 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+ * SPDX-License-Identifier: GPL-2.0-or-later
  */
 
 #ifndef __STRUTIL_H__
 #define __STRUTIL_H__
 
-/* ... thus, config.h needs to be #included */
+#include "ws_symbol_export.h"
+
+#include <epan/wmem/wmem.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif /* __cplusplus */
 
 /** @file
  * String handling and conversion utilities.
@@ -50,41 +42,54 @@ const guchar *find_line_end(const guchar *data, const guchar *dataend,
  * @param next_token Receives the location of the next token
  * @return 0 if there is no next token.
  */
+WS_DLL_PUBLIC
 int        get_token_len(const guchar *linep, const guchar *lineend,
     const guchar **next_token);
 
 /** Given a string, generate a string from it that shows non-printable
  *  characters as C-style escapes, and return a pointer to it.
  *
+ * @param allocator The wmem scope
  * @param line A pointer to the input string
  * @param len The length of the input string
  * @return A pointer to the formatted string
  *
  * @see tvb_format_text()
  */
-gchar*     format_text(const guchar *line, int len);
+WS_DLL_PUBLIC
+gchar*     format_text(wmem_allocator_t* allocator, const guchar *line, size_t len);
 
-/** Turn an array of bytes into a string showing the bytes in hex.
+/**
+ * Given a string, generate a string from it that shows non-printable
+ * characters as C-style escapes except a whitespace character
+ * (space, tab, carriage return, new line, vertical tab, or formfeed)
+ * which will be replaced by a space, and return a pointer to it.
  *
- * @param bd A pointer to the byte array
- * @param bd_len The length of the byte array
+ * @param allocator The wmem scope
+ * @param line A pointer to the input string
+ * @param len The length of the input string
  * @return A pointer to the formatted string
  *
- * @see bytes_to_str_punct()
  */
-gchar*     bytes_to_str(const guint8 *bd, int bd_len);
+WS_DLL_PUBLIC
+gchar*     format_text_wsp(wmem_allocator_t* allocator, const guchar *line, size_t len);
 
-/** Turn an array of bytes into a string showing the bytes in hex,
- *  separated by a punctuation character.
+/**
+ * Given a string, generate a string from it that shows non-printable
+ * characters as the chr parameter passed, except a whitespace character
+ * (space, tab, carriage return, new line, vertical tab, or formfeed)
+ * which will be replaced by a space, and return a pointer to it.
  *
- * @param bd A pointer to the byte array
- * @param bd_len The length of the byte array
- * @param punct The punctuation character
+ * @param allocator The wmem scope
+ * @param string A pointer to the input string
+ * @param len The length of the input string
+ * @param chr The character to use to replace non-printable characters
  * @return A pointer to the formatted string
  *
- * @see bytes_to_str()
  */
-gchar*     bytes_to_str_punct(const guint8 *bd, int bd_len, gchar punct);
+WS_DLL_PUBLIC
+gchar*     format_text_chr(wmem_allocator_t* allocator, const guchar *string, const size_t len, const guchar chr);
+
 
 /** Turn a string of hex digits with optional separators (defined by
  *  is_byte_sep() into a byte array.
@@ -92,22 +97,128 @@ gchar*     bytes_to_str_punct(const guint8 *bd, int bd_len, gchar punct);
  * @param hex_str The string of hex digits.
  * @param bytes The GByteArray that will receive the bytes.  This
  *        must be initialized by the caller.
- * @param force_separators If set to TRUE, separators MUST exist between 
+ * @param force_separators If set to TRUE, separators MUST exist between
  *        bytes.
  * @return True if the string was converted successfully
  */
+WS_DLL_PUBLIC
 gboolean   hex_str_to_bytes(const char *hex_str, GByteArray *bytes,
     gboolean force_separators);
 
+/* Turn a string of hex digits with optional separators (defined by encoding)
+ * into a byte array. Unlike hex_str_to_bytes(), this will read as many hex-char
+ * pairs as possible and not error if it hits a non-hex-char; instead it just ends
+ * there. (i.e., like strtol()/atoi()/etc.) But it must see two hex chars at the
+ * beginning or it will return FALSE.
+ *
+ * @param hex_str The string of hex digits.
+ * @param bytes The GByteArray that will receive the bytes.  This
+ *        must be initialized by the caller.
+ * @param endptr if not NULL, is set to the char after the last hex character consumed.
+ * @param encoding set to one or more bitwise-or'ed ENC_SEP_* (see proto.h)
+ * @param fail_if_partial If set to TRUE, then the conversion fails if the whole
+ *    hex_str is not consumed.
+ * @return FALSE only if no bytes were generated; or if fail_if_partial is TRUE
+ *    and the entire hex_str was not consumed.
+ *
+ * If no ENC_SEP_* is set, then no separators are allowed. If multiple ENC_SEP_* are
+ * bit-or'ed, any of them can be a separator, but once the separator is seen then
+ * only its same type is accepted for the rest of the string. (i.e., it won't convert
+ * a "01:23-4567" even if ENC_SEP_COLON|ENC_SEP_DASH|ENC_SEP_NONE is passed in)
+ *
+ * This is done this way because it's likely a malformed scenario if they're mixed,
+ * and this routine is used by dissectors via tvb_get_string_XXX routines.
+ */
+WS_DLL_PUBLIC
+gboolean hex_str_to_bytes_encoding(const char *hex_str, GByteArray *bytes, const char **endptr,
+                                   const guint encoding, const gboolean fail_if_partial);
+
+/** Turn an RFC 3986 percent-encoded string into a byte array.
+ *
+ * @param uri_str The string of hex digits.
+ * @param bytes The GByteArray that will receive the bytes.  This
+ *        must be initialized by the caller.
+ * @return True if the string was converted successfully
+ * @see format_uri()
+ */
+WS_DLL_PUBLIC
+gboolean   uri_str_to_bytes(const char *uri_str, GByteArray *bytes);
+
+/** Turn a byte array into an RFC 3986 percent-encoded string.
+ *
+ * @param allocator The wmem scope
+ * @param bytes The GByteArray that will receive the bytes.  This
+ *        must be initialized by the caller.
+ * @param reserved_chars Normally the "gen-delims" and "sub-delims"
+ *        from RFC 3986 (":/?#[]@" and "!$&'()*+,;=" respectively)
+ *        plus space (hex value 20) are treated as reserved characters.
+ *        If this variable is non-NULL, its contents will be used
+ *        instead.
+ * @note Any non-printing character determined by isprint(), along
+ *       with the % character itself are always reserved.
+ * @see uri_str_to_bytes(),  format_text(), isprint()
+ */
+WS_DLL_PUBLIC
+gchar* format_uri(wmem_allocator_t* allocator, const GByteArray *bytes, const gchar *reserved_chars);
+
+/** Turn a OID string representation (dot notation) into a byte array.
+ *
+ * @param oid_str The OID string (dot notaion).
+ * @param bytes The GByteArray that will receive the bytes.  This
+ *        must be initialized by the caller.
+ * @param is_absolute True if this is an absolute OID; false for relative OID.
+ * @return True if the string was converted successfully
+ */
+WS_DLL_PUBLIC
+gboolean   rel_oid_str_to_bytes(const char *oid_str, GByteArray *bytes, gboolean is_absolute);
+
+/** Turn a OID string representation (dot notation) into a byte array.
+ *
+ * @param oid_str The OID string (dot notaion).
+ * @param bytes The GByteArray that will receive the bytes.  This
+ *        must be initialized by the caller.
+ * @return True if the string was converted successfully
+ */
+WS_DLL_PUBLIC
+gboolean   oid_str_to_bytes(const char *oid_str, GByteArray *bytes);
+
+/**
+ * Create a copy of a GByteArray
+ *
+ * @param ba The byte array to be copied.
+ * @return If ba exists, a freshly allocated copy.  NULL otherwise.
+ *
+ * @todo - Should this be in strutil.c?
+ */
+WS_DLL_PUBLIC
+GByteArray *byte_array_dup(const GByteArray *ba);
+
+/**
+ * Compare the contents of two GByteArrays
+ *
+ * @param ba1 A byte array
+ * @param ba2 A byte array
+ * @return If both arrays are non-NULL and their lengths are equal and
+ *         their contents are equal, returns TRUE.  Otherwise, returns
+ *         FALSE.
+ *
+ * @todo - Should this be in strutil.c?
+ */
+WS_DLL_PUBLIC
+gboolean byte_array_equal(GByteArray *ba1, GByteArray *ba2);
+
+
 /** Return a XML escaped representation of the unescaped string.
- *  The returned string must be freed when no longer in use. 
+ *  The returned string must be freed when no longer in use.
  *
  * @param unescaped The unescaped string
  * @return An XML-escaped representation of the input string
  */
+WS_DLL_PUBLIC
 gchar*     xml_escape(const gchar *unescaped);
 
-/* Return the first occurrence of needle in haystack.
+/**
+ * Return the first occurrence of needle in haystack.
  * Algorithm copied from GNU's glibc 2.3.2 memcmp()
  *
  * @param haystack The data to search
@@ -118,13 +229,10 @@ gchar*     xml_escape(const gchar *unescaped);
  *         "haystack".  If "needle" isn't found or is NULL, or if
  *         "needle_len" is 0, NULL is returned.
  */
+WS_DLL_PUBLIC
 const guint8 * epan_memmem(const guint8 *haystack, guint haystack_len,
                const guint8 *needle, guint needle_len);
 
-/* Surround a string or a macro, resolved to a string, with double quotes */
-#define _STRINGIFY(a)           # a
-#define STRINGIFY(a)            _STRINGIFY(a)
-
 /** Scan a string to make sure it's valid hex.
  *
  * @param string The string to validate
@@ -132,6 +240,7 @@ const guint8 * epan_memmem(const guint8 *haystack, guint haystack_len,
  * @return A pointer to a buffer containing the converted raw bytes.  This
  *         buffer must be g_free()d by the caller.
  */
+WS_DLL_PUBLIC
 guint8 * convert_string_to_hex(const char *string, size_t *nbytes);
 
 /** Prep a string for case-sensitive vs case-insensitive searching.
@@ -142,18 +251,71 @@ guint8 * convert_string_to_hex(const char *string, size_t *nbytes);
  * an uppercased version if not.  In either case the string must be g_free()d
  * by the caller.
  */
+WS_DLL_PUBLIC
 char * convert_string_case(const char *string, gboolean case_insensitive);
 
-/* g_strlcat() does not exist in gtk 1 */
-#if GTK_MAJOR_VERSION < 2
-#define g_strlcat(dst, src, size)                                      \
-       {                                                               \
-       int strl;                                                       \
-       strl=strlen(dst);                                               \
-       if(strl<size)                                                   \
-               g_snprintf(dst+strl, size-strl, "%s", src);             \
-       dst[size-1]=0;                                                  \
-       }
-#endif
+/** 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 * epan_strcasestr(const char *haystack, const char *needle);
+
+/** Guarantee a non-null string.
+ *
+ * @param string The string to check
+ * @return A pointer 'string' if it's non-null, otherwise "[NULL]".
+ */
+WS_DLL_PUBLIC
+const char * string_or_null(const char *string);
+
+WS_DLL_PUBLIC
+int escape_string_len(const char *string);
+WS_DLL_PUBLIC
+char * escape_string(char *dst, const char *string);
+
+
+WS_DLL_PUBLIC
+void IA5_7BIT_decode(unsigned char * dest, const unsigned char* src, int len);
+
+/** Copy a string, escaping the 'chr' characters in it
+ *
+ * @param str The string to be copied
+ * @param chr The character to be escaped
+ * @return A copy of the string with every original 'chr' being
+ * transformed into double 'chr'.
+ */
+WS_DLL_PUBLIC
+gchar* ws_strdup_escape_char (const gchar *str, const gchar chr);
+
+/** Copy a string, unescaping the 'chr' characters in it
+ *
+ * @param str The string to be copied
+ * @param chr The character to be escaped
+ * @return A copy of the string with every occurrence of double 'chr' in
+ * the original string being copied as a single 'chr'.
+ */
+WS_DLL_PUBLIC
+gchar* ws_strdup_unescape_char (const gchar *str, const gchar chr);
+
+/** Replace values in a string
+ *
+ * @param str String containing 0 or more values to be replaced.
+ * @param old_val Old value.
+ * @param new_val New value. May be NULL, in which case occurences of
+ *                           old_value will be removed.
+ * @return A newly-allocated version of str with replacement values or
+ * NULL on failure.
+ */
+WS_DLL_PUBLIC
+gchar *string_replace(const gchar* str, const gchar *old_val, const gchar *new_val);
+
+#ifdef __cplusplus
+}
+#endif /* __cplusplus */
 
 #endif /* __STRUTIL_H__ */