Author: Pekka Riikonen <priikone@silcnet.org>
- Copyright (C) 1997 - 2002 Pekka Riikonen
+ Copyright (C) 1997 - 2006 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
***/
int silc_check_line(char *buf);
-/****f* silcutil/SilcUtilAPI/silc_get_time
- *
- * SYNOPSIS
- *
- * const char *silc_get_time(SilcUInt32 timeval)
- *
- * DESCRIPTION
- *
- * Returns time as string. If the the `timeval' is non-zero that
- * value is returned as string. If it is zero the current time of the
- * local machine is returned.
- *
- ***/
-const char *silc_get_time(SilcUInt32 timeval);
-
/****f* silcutil/SilcUtilAPI/silc_to_upper
*
* SYNOPSIS
*
- * bool silc_to_upper(const char *string, char *dest, SilcUInt32 dest_size);
+ * SilcBool silc_to_upper(const char *string, char *dest,
+ * SilcUInt32 dest_size);
*
* DESCRIPTION
*
* Converts string to capital characters.
*
***/
-bool silc_to_upper(const char *string, char *dest, SilcUInt32 dest_size);
+SilcBool silc_to_upper(const char *string, char *dest, SilcUInt32 dest_size);
/****f* silcutil/SilcUtilAPI/silc_to_lower
*
* SYNOPSIS
*
- * bool silc_to_lower(const char *string, char *dest, SilcUInt32 dest_size);
+ * SilcBool silc_to_lower(const char *string, char *dest,
+ * SilcUInt32 dest_size);
*
* DESCRIPTION
*
* Converts string to capital characters.
*
***/
-bool silc_to_lower(const char *string, char *dest, SilcUInt32 dest_size);
+SilcBool silc_to_lower(const char *string, char *dest, SilcUInt32 dest_size);
/****f* silcutil/SilcUtilAPI/silc_parse_userfqdn
*
* SYNOPSIS
*
- * bool silc_parse_userfqdn(const char *string, char **left, char **right);
+ * int silc_parse_userfqdn(const char *string,
+ * char *user, SilcUInt32 user_size,
+ * char *fqdn, SilcUInt32 fqdn_size);
*
* DESCRIPTION
*
- * Parse userfqdn string which is in user@fqdn format.
+ * Parse userfqdn string which is in user@fqdn format. Returns 0 on
+ * error, 1 if `user' was filled and 2 if both `user' and `fqdn'
+ * was filled.
*
***/
-bool silc_parse_userfqdn(const char *string, char **left, char **right);
+int silc_parse_userfqdn(const char *string,
+ char *user, SilcUInt32 user_size,
+ char *fqdn, SilcUInt32 fqdn_size);
/****f* silcutil/SilcUtilAPI/silc_parse_command_line
*
***/
char *silc_format(char *fmt, ...);
-/****f* silcutil/SilcUtilAPI/silc_id_render
- *
- * SYNOPSIS
- *
- * char *silc_id_render(void *id, SilcUInt16 type);
- *
- * DESCRIPTION
- *
- * Renders ID to suitable to print for example to log file.
- *
- ***/
-char *silc_id_render(void *id, SilcUInt16 type);
-
-/****f* silcutil/SilcUtilAPI/silc_string_compare
+/****f* silcutil/SilcUtilAPI/silc_hash_string
*
* SYNOPSIS
*
- * int silc_string_compare(char *string1, char *string2);
+ * SilcUInt32 silc_hash_string(void *key, void *user_context);
*
* DESCRIPTION
*
- * Compares two strings. Strings may include wildcards '*' and '?'.
- * Returns TRUE if strings match.
+ * Basic has function to hash strings. May be used with the SilcHashTable.
+ * Note that this lowers the characters of the string (with tolower()) so
+ * this is used usually with nicknames, channel and server names to provide
+ * case insensitive keys.
*
***/
-int silc_string_compare(char *string1, char *string2);
+SilcUInt32 silc_hash_string(void *key, void *user_context);
-/****f* silcutil/SilcUtilAPI/silc_hash_string
+/****f* silcutil/SilcUtilAPI/silc_hash_utf8_string
*
* SYNOPSIS
*
- * SilcUInt32 silc_hash_string(void *key, void *user_context);
+ * SilcUInt32 silc_hash_utf8_string(void *key, void *user_context);
*
* DESCRIPTION
*
- * Basic has function to hash strings. May be used with the SilcHashTable.
- * Note that this lowers the characters of the string (with tolower()) so
- * this is used usually with nicknames, channel and server names to provide
- * case insensitive keys.
+ * Basic has function to hash UTF-8 strings. May be used with the
+ * SilcHashTable. Used with identifier strings. The key is
+ * expected to be casefolded.
*
***/
-SilcUInt32 silc_hash_string(void *key, void *user_context);
+SilcUInt32 silc_hash_utf8_string(void *key, void *user_context);
/****f* silcutil/SilcUtilAPI/silc_hash_uint
*
*
* DESCRIPTION
*
- * Hashed SILC Public key.
+ * Hash public key of any type.
*
***/
SilcUInt32 silc_hash_public_key(void *key, void *user_context);
*
* SYNOPSIS
*
- * bool silc_hash_string_compare(void *key1, void *key2,
+ * SilcBool silc_hash_string_compare(void *key1, void *key2,
* void *user_context);
*
* DESCRIPTION
* function.
*
***/
-bool silc_hash_string_compare(void *key1, void *key2, void *user_context);
+SilcBool silc_hash_string_compare(void *key1, void *key2, void *user_context);
/****f* silcutil/SilcUtilAPI/silc_hash_id_compare
*
* SYNOPSIS
*
- * bool silc_hash_id_compare(void *key1, void *key2, void *user_context);
+ * SilcBool silc_hash_id_compare(void *key1, void *key2,
+ * void *user_context);
*
* DESCRIPTION
*
* part of the Client ID. Other ID's are fully compared.
*
***/
-bool silc_hash_id_compare(void *key1, void *key2, void *user_context);
+SilcBool silc_hash_id_compare(void *key1, void *key2, void *user_context);
-/****f* silcutil/SilcUtilAPI/silc_hash_client_id_compare
+/****f* silcutil/SilcUtilAPI/silc_hash_id_compare_full
*
* SYNOPSIS
*
- * bool silc_hash_client_id_compare(void *key1, void *key2, void *user_context);
+ * SilcBool silc_hash_id_compare_full(void *key1, void *key2,
+ * void *user_context)
*
* DESCRIPTION
*
- * Compare two Client ID's entirely and not just the hash from the ID.
- *
- ***/
-bool silc_hash_client_id_compare(void *key1, void *key2, void *user_context);
-
-/****f* silcutil/SilcUtilAPI/silc_hash_data_compare
- *
- * SYNOPSIS
- *
- * bool silc_hash_data_compare(void *key1, void *key2, void *user_context);
- *
- * DESCRIPTION
- *
- * Compares binary data. May be used as SilcHashTable comparison function.
+ * Compares two ID's. May be used as SilcHashTable comparison function.
+ * To compare full ID's instead of only partial, like the
+ * silc_hash_id_compare does, use this function.
*
***/
-bool silc_hash_data_compare(void *key1, void *key2, void *user_context);
+SilcBool silc_hash_id_compare_full(void *key1, void *key2, void *user_context);
-/****f* silcutil/SilcUtilAPI/silc_hash_public_key_compare
+/****f* silcutil/SilcUtilAPI/silc_hash_client_id_compare
*
* SYNOPSIS
*
- * bool silc_hash_public_key_compare(void *key1, void *key2, void *user_context);
+ * SilcBool silc_hash_client_id_compare(void *key1, void *key2,
+ * void *user_context);
*
* DESCRIPTION
*
- * Compares two SILC Public keys. It may be used as SilcHashTable
- * comparison function.
+ * Compare two Client ID's entirely and not just the hash from the ID.
*
***/
-bool silc_hash_public_key_compare(void *key1, void *key2, void *user_context);
+SilcBool silc_hash_client_id_compare(void *key1, void *key2,
+ void *user_context);
-/****f* silcutil/SilcUtilAPI/silc_client_chmode
+/****f* silcutil/SilcUtilAPI/silc_hash_data_compare
*
* SYNOPSIS
*
- * char *silc_client_chmode(SilcUInt32 mode, const char *cipher,
- * const char *hmac);
+ * SilcBool silc_hash_data_compare(void *key1, void *key2,
+ * void *user_context);
*
* DESCRIPTION
*
- * Parses mode mask and returns the mode as string.
+ * Compares binary data. May be used as SilcHashTable comparison function.
*
***/
-char *silc_client_chmode(SilcUInt32 mode, const char *cipher,
- const char *hmac);
+SilcBool silc_hash_data_compare(void *key1, void *key2, void *user_context);
-/****f* silcutil/SilcUtilAPI/silc_client_chumode
+/****f* silcutil/SilcUtilAPI/silc_hash_utf8_compare
*
* SYNOPSIS
*
- * char *silc_client_chumode(SilcUInt32 mode);
+ * SilcBool silc_hash_utf8_compare(void *key1, void *key2,
+ * void *user_context);
*
* DESCRIPTION
*
- * Parses channel user mode mask and returns te mode as string.
+ * Compares UTF-8 strings. Casefolded and NULL terminated strings are
+ * expected. May be used as SilcHashTable comparison function.
*
***/
-char *silc_client_chumode(SilcUInt32 mode);
+SilcBool silc_hash_utf8_compare(void *key1, void *key2, void *user_context);
-/****f* silcutil/SilcUtilAPI/silc_client_chumode_char
+/****f* silcutil/SilcUtilAPI/silc_hash_public_key_compare
*
* SYNOPSIS
*
- * char *silc_client_chumode_char(SilcUInt32 mode);
+ * SilcBool silc_hash_public_key_compare(void *key1, void *key2,
+ * void *user_context);
*
* DESCRIPTION
*
- * Parses channel user mode and returns it as special mode character.
+ * Compares two SILC Public keys. It may be used as SilcHashTable
+ * comparison function.
*
***/
-char *silc_client_chumode_char(SilcUInt32 mode);
+SilcBool silc_hash_public_key_compare(void *key1, void *key2,
+ void *user_context);
/****f* silcutil/SilcUtilAPI/silc_fingerprint
*
*
* DESCRIPTION
*
- * Creates fingerprint from data, usually used with SHA1 digests.
+ * Return a textual representation of the fingerprint in *data, the
+ * caller must free the returned string.
*
***/
char *silc_fingerprint(const unsigned char *data, SilcUInt32 data_len);
*
* SYNOPSIS
*
- * bool silc_string_is_ascii(const unsigned char *data,
+ * SilcBool silc_string_is_ascii(const unsigned char *data,
* SilcUInt32 data_len);
*
* DESCRIPTION
* Return TRUE if the `data' is ASCII string.
*
***/
-bool silc_string_is_ascii(const unsigned char *data, SilcUInt32 data_len);
-
-/****f* silcutil/SilcUtilAPI/silc_parse_version_string
- *
- * SYNOPSIS
- *
- * bool silc_parse_version_string(const char *version,
- * SilcUInt32 *protocol_version,
- * char **protocol_version_string,
- * SilcUInt32 *software_version,
- * char **software_version_string,
- * char **vendor_version);
- *
- * DESCRIPTION
- *
- * Parses SILC protocol style version string.
- *
- ***/
-bool silc_parse_version_string(const char *version,
- SilcUInt32 *protocol_version,
- char **protocol_version_string,
- SilcUInt32 *software_version,
- char **software_version_string,
- char **vendor_version);
-
-/****f* silcutil/SilcUtilAPI/silc_version_to_num
- *
- * SYNOPSIS
- *
- * SilcUInt32 silc_version_to_num(const char *version);
- *
- * DESCRIPTION
- *
- * Converts version string x.x into number representation.
- *
- ***/
-SilcUInt32 silc_version_to_num(const char *version);
+SilcBool silc_string_is_ascii(const unsigned char *data, SilcUInt32 data_len);
/****f* silcutil/SilcUtilAPI/silc_get_input
*
* SYNOPSIS
*
- * char *silc_get_input(const char *prompt, bool echo_off);
+ * char *silc_get_input(const char *prompt, SilcBool echo_off);
*
* DESCRIPTION
*
* Displays input prompt on command line and takes input data from user.
*
***/
-char *silc_get_input(const char *prompt, bool echo_off);
+char *silc_get_input(const char *prompt, SilcBool echo_off);
/* System dependant prototypes */
-/****f* silcutil/SilcUtilAPI/silc_gettimeofday
- *
- * SYNOPSIS
- *
- * int silc_gettimeofday(struct timeval *p);
- *
- * DESCRIPTION
- *
- * Return current time to struct timeval.
- *
- * This function is system dependant.
- *
- ***/
-int silc_gettimeofday(struct timeval *p);
-
-/****f* silcutil/SilcUtilAPI/silc_string_regexify
- *
- * SYNOPSIS
- *
- * char *silc_string_regexify(const char *string);
- *
- * DESCRIPTION
- *
- * 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.
- *
- ***/
-char *silc_string_regexify(const char *string);
-
-/****f* silcutil/SilcUtilAPI/silc_string_regex_match
- *
- * SYNOPSIS
- *
- * int silc_string_regex_match(const char *regex, const char *string);
- *
- * DESCRIPTION
- *
- * Matches the two strings and returns TRUE if the strings match.
- *
- * This function is system dependant.
- *
- ***/
-int silc_string_regex_match(const char *regex, const char *string);
-
-/****f* silcutil/SilcUtilAPI/silc_string_match
- *
- * SYNOPSIS
- *
- * int silc_string_match(const char *string1, const char *string2);
- *
- * DESCRIPTION
- *
- * Do regex match to the two strings `string1' and `string2'. If the
- * `string2' matches the `string1' this returns TRUE.
- *
- * This function is system dependant.
- *
- ***/
-int silc_string_match(const char *string1, const char *string2);
-
/****f* silcutil/SilcUtilAPI/silc_get_username
*
* SYNOPSIS
* DESCRIPTION
*
* Returns the username of the user. If the global variable LOGNAME
- * does not exists we will get the name from the passwd file.
+ * does not exists we will get the name from the passwd file. The
+ * caller must free the returned name.
*
* This function is system dependant.
*
*
* DESCRIPTION
*
- * Returns the real name of ther user from the passwd file.
+ * Returns the real name of ther user from the passwd file. The
+ * caller must free the returned name.
*
* This function is system dependant.
*
***/
char *silc_get_real_name();
-/****f* silcutil/SilcUtilAPI/silc_get_mode_list
- *
- * SYNOPSIS
- *
- * bool silc_get_mode_list(SilcBuffer mode_list, SilcUInt32 mode_list_count,
- * SilcUInt32 **list);
- *
- * DESCRIPTION
- *
- * Returns modes from list of 32 bit MSB first order values that are
- * encoded one after the other in the `mode_list' into the `list'
- * array. The caller must free the returned list. Return FALSE if
- * there is error parsing the list.
- *
- ***/
-bool silc_get_mode_list(SilcBuffer mode_list, SilcUInt32 mode_list_count,
- SilcUInt32 **list);
-
-/****f* silcutil/SilcUtilAPI/silc_get_status_message
- *
- * SYNOPSIS
- *
- * char *silc_get_status_message(SilcStatus status)
- *
- * DESCRIPTION
- *
- * Returns status message string
- *
- ***/
-const char *silc_get_status_message(unsigned char status);
-
-/****f* silcutil/SilcUtilAPI/silc_get_packet_name
- *
- * SYNOPSIS
- *
- * char *silc_get_packet_name(SilcPacketType type);
- *
- * DESCRIPTION
- *
- * Returns the name corresponding packet type `type'.
- *
- ***/
-const char *silc_get_packet_name(unsigned char type);
-
-/****f* silcutil/SilcUtilAPI/silc_get_command_name
+/****f* silcutil/SilcUtilAPI/silc_va_copy
*
* SYNOPSIS
*
- * char *silc_get_command_name(SilcCommand command);
+ * void silc_va_copy(va_list dest, va_list src);
*
* DESCRIPTION
*
- * Returns the name corresponding SILC command `command'.
+ * Copies variable argument list. This must be called in case the
+ * variable argument list must be evaluated multiple times. For each
+ * evaluation the list must be copied and va_end must be called for
+ * each copied list.
*
***/
-const char *silc_get_command_name(unsigned char command);
+#if defined(HAVE_VA_COPY)
+#define silc_va_copy(dest, src) va_copy(dest, src);
+#elif defined(HAVE___VA_COPY)
+#define silc_va_copy(dest, src) __va_copy(dest, src);
+#elif defined(SILC_VA_COPY_ARRAY)
+#define silc_va_copy(dest, src) memmove(dest, src, sizeof(va_list));
+#else
+#define silc_va_copy(dest, src) dest = src;
+#endif
#endif /* !SILCUTIL_H */