/*
- silcstrutil.h
+ silcstrutil.h
Author: Pekka Riikonen <priikone@silcnet.org>
- Copyright (C) 2002 Pekka Riikonen
+ Copyright (C) 2002 - 2007 Pekka Riikonen
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
*
* DESCRIPTION
*
- * String manipulation utility routines. These routines provides
- * various helper functions for encoding, decoding and otherwise
- * managing strings.
+ * String manipulation utility routines. These routines provides
+ * various helper functions for encoding, decoding and otherwise
+ * managing strings.
*
***/
#ifndef SILCSTRUTIL_H
#define SILCSTRUTIL_H
+/****d* silcutil/SilcStrUtilAPI/SilcStringEncoding
+ *
+ * NAME
+ *
+ * typedef enum { ... } SilcStringEncoding;
+ *
+ * DESCRIPTION
+ *
+ * String encoding definitions used with various string manipulation
+ * routines. By default, applications are suggested to use
+ * SILC_STRING_LOCALE since it encodes and decodes correctly according
+ * to local system language and character set (locale).
+ *
+ * SOURCE
+ */
+typedef enum {
+ SILC_STRING_ASCII = 0, /* Any 8 bit ASCII encoding (default) */
+ SILC_STRING_ASCII_ESC = 1, /* 7 bit ASCII (>0x7f escaped) */
+ SILC_STRING_BMP = 2, /* 16 bit, UCS-2, BMP, ISO/IEC 10646 */
+ SILC_STRING_BMP_LSB = 3, /* BMP, least significant byte first */
+ SILC_STRING_UNIVERSAL = 4, /* 32 bit, UCS-4, Universal, ISO/IEC 10646 */
+ SILC_STRING_UNIVERSAL_LSB = 5, /* Universal, least significant byte first */
+ SILC_STRING_LOCALE = 6, /* A locale specific conversion on
+ those platforms that support iconv().
+ Fallback is SILC_STRING_ASCII. */
+ SILC_STRING_UTF8 = 7, /* UTF-8 encoding */
+ SILC_STRING_PRINTABLE = 8, /* Printable ASCII (no escaping) */
+ SILC_STRING_VISIBLE = 9, /* Visible ASCII string */
+ SILC_STRING_TELETEX = 10, /* Teletex ASCII string */
+ SILC_STRING_NUMERICAL = 11, /* Numerical ASCII string (digits) */
+ SILC_STRING_LDAP_DN = 12, /* Strings for LDAP DNs, RFC 2253 */
+ SILC_STRING_UTF8_ESCAPE = 12, /* Escaped UTF-8 as defined in RFC 2253 */
+
+ SILC_STRING_LANGUAGE = 6, /* _Deprecated_, use SILC_STRING_LOCALE. */
+} SilcStringEncoding;
+/***/
+
/****f* silcutil/SilcStrUtilAPI/silc_pem_encode
*
* SYNOPSIS
unsigned char *silc_pem_decode(unsigned char *pem, SilcUInt32 pem_len,
SilcUInt32 *ret_len);
-/****d* silcutil/SilcStrUtilAPI/SilcStringEncoding
+/****f* silcutil/SilcStrStrUtilAPI/silc_snprintf
*
- * NAME
- *
- * typedef enum { ... } SilcStringEncoding;
+ * SYNOPSIS
+ *
+ * int silc_snprintf(char *str, SilcUInt32 size, const char *format, ...);
*
* DESCRIPTION
*
- * String encoding definitions used with the UTF-8 encoding and the
- * decoding functions.
+ * Produces output string according to the `format'. The formatting
+ * is equivalent to silc_snprintf(3) and sprintf(3). Returns the number of
+ * characters output into `str', at most `size' characters including the
+ * trailing '\0' character. Returns negative value on error.
*
- * SOURCE
- */
-typedef enum {
- SILC_STRING_ASCII = 0, /* Any 8 bit ASCII encoding (default) */
+ ***/
+#ifndef SILC_SNPRINTF
+int silc_snprintf(char *str, SilcUInt32 size, const char *format, ...);
+#else
+#define silc_snprintf snprintf
+#endif /* SILC_SNPRINTF */
- /* Rest are not implemented yet */
- SILC_STRING_ASCII_ESC = 1, /* 7 bit ASCII (>0x7f escaped) */
- SILC_STRING_BMP = 2, /* 16 bit, UCS-2, BMP, ISO/IEC 10646 */
- SILC_STRING_UNIVERSAL = 3, /* 32 bit, UCS-4, Universal, ISO/IEC 10646 */
-} SilcStringEncoding;
-/***/
+/****f* silcutil/SilcStrStrUtilAPI/silc_strncat
+ *
+ * SYNOPSIS
+ *
+ * char *silc_strncat(char *dest, SilcUInt32 dest_size,
+ * const char *src, SilcUInt32 src_len);
+ *
+ * DESCRIPTION
+ *
+ * Concatenates the `src' into `dest'. If `src_len' is more than the
+ * size of the `dest' (minus NULL at the end) the `src' will be
+ * truncated to fit.
+ *
+ ***/
+char *silc_strncat(char *dest, SilcUInt32 dest_size,
+ const char *src, SilcUInt32 src_len);
-/****f* silcutil/SilcStrUtilAPI/silc_utf8_encode
+/****f* silcutil/SilcStrUtilAPI/silc_string_regexify
*
* SYNOPSIS
*
- * SilcUInt32 silc_utf8_encode(const unsigned char *bin, SilcUInt32 bin_len,
- * SilcStringEncoding bin_encoding,
- * unsigned char *utf8, SilcUInt32 utf8_size);
+ * char *silc_string_regexify(const char *string);
*
* DESCRIPTION
*
- * Encodes the string `bin' of which encoding is `bin_encoding' to the
- * UTF-8 encoding into the buffer `utf8' which is of size of `utf8_size'.
- * Returns the length of the UTF-8 encoded string, or zero (0) on error.
- * By default `bin_encoding' is ASCII, and the caller needs to know the
- * encoding of the input string if it is anything else.
+ * Inspects the `string' for wildcards and returns regex string that can
+ * be used by the GNU regex library. A comma (`,') in the `string' means
+ * that the string is list.
+ *
+ * This function is system dependant.
*
***/
-SilcUInt32 silc_utf8_encode(const unsigned char *bin, SilcUInt32 bin_len,
- SilcStringEncoding bin_encoding,
- unsigned char *utf8, SilcUInt32 utf8_size);
+char *silc_string_regexify(const char *string);
-/****f* silcutil/SilcStrUtilAPI/silc_utf8_decode
+/****f* silcutil/SilcStrUtilAPI/silc_string_regex_match
*
* SYNOPSIS
*
- * SilcUInt32 silc_utf8_decode(const unsigned char *utf8,
- * SilcUInt32 utf8_len,
- * SilcStringEncoding bin_encoding,
- * unsigned char *bin, SilcUInt32 bin_size);
+ * int silc_string_regex_match(const char *regex, const char *string);
*
* DESCRIPTION
*
- * Decodes UTF-8 encoded string `utf8' to string of which encoding is
- * to be `bin_encoding', into the `bin' buffer of size of `bin_size'.
- * Returns the length of the decoded buffer, or zero (0) on error.
- * By default `bin_encoding' is ASCII, and the caller needs to know to
- * which encoding the output string is to be encoded if ASCII is not
- * desired.
+ * Matches the two strings and returns TRUE if the strings match.
+ *
+ * This function is system dependant.
*
***/
-SilcUInt32 silc_utf8_decode(const unsigned char *utf8, SilcUInt32 utf8_len,
- SilcStringEncoding bin_encoding,
- unsigned char *bin, SilcUInt32 bin_size);
+int silc_string_regex_match(const char *regex, const char *string);
-/****f* silcutil/SilcStrUtilAPI/silc_utf8_encoded_len
+/****f* silcutil/SilcStrUtilAPI/silc_string_match
*
* SYNOPSIS
*
- * SilcUInt32 silc_utf8_encoded_len(const unsigned char *bin,
- * SilcUInt32 bin_len,
- * SilcStringEncoding bin_encoding);
+ * int silc_string_match(const char *string1, const char *string2);
*
* DESCRIPTION
*
- * Returns the length of UTF-8 encoded string if the `bin' of
- * encoding of `bin_encoding' is encoded with silc_utf8_encode.
+ * Do regex match to the two strings `string1' and `string2'. If the
+ * `string2' matches the `string1' this returns TRUE.
+ *
+ * This function is system dependant.
*
***/
-SilcUInt32 silc_utf8_encoded_len(const unsigned char *bin, SilcUInt32 bin_len,
- SilcStringEncoding bin_encoding);
+int silc_string_match(const char *string1, const char *string2);
-/****f* silcutil/SilcStrUtilAPI/silc_utf8_valid
+/****f* silcutil/SilcStrUtilAPI/silc_string_compare
*
* SYNOPSIS
*
- * bool silc_utf8_valid(const unsigned char *utf8, SilcUInt32 utf8_len);
+ * int silc_string_compare(char *string1, char *string2);
*
* DESCRIPTION
*
- * Returns TRUE if the `utf8' string of length of `utf8_len' is valid
- * UTF-8 encoded string, FALSE if it is not UTF-8 encoded string.
+ * Compares two strings. Strings may include wildcards '*' and '?'.
+ * Returns TRUE if strings match.
*
***/
-bool silc_utf8_valid(const unsigned char *utf8, SilcUInt32 utf8_len);
+int silc_string_compare(char *string1, char *string2);
+/****f* silcutil/SilcStrUtilAPI/silc_string_split
+ *
+ * SYNOPSIS
+ *
+ * char **silc_string_split(const char *string, char ch, int *ret_count);
+ *
+ * DESCRIPTION
+ *
+ * Splits a `string' that has a separator `ch' into an array of strings
+ * and returns the array. The `ret_count' will contain the number of
+ * strings in the array. Caller must free the strings and the array.
+ * Returns NULL on error. If the string does not have `ch' separator
+ * this returns the `string' in the array.
+ *
+ ***/
+char **silc_string_split(const char *string, char ch, int *ret_count);
#endif /* SILCSTRUTIL_H */
projects / silc.git / blobdiff