X-Git-Url: http://git.silcnet.org/gitweb/?a=blobdiff_plain;f=lib%2Fsilcutil%2Fsilcutil.h;h=1e2a68eacfcabe8c3b34b38f04b4b0a044a3bdd4;hb=40f8443d8d3a6577336ee66d18e04d9ac4d956bb;hp=d1374d902a5f2b0ee4d400288493d21784bc1dbf;hpb=73340ca4691a23d2649eb2873ba72bbace372480;p=silc.git diff --git a/lib/silcutil/silcutil.h b/lib/silcutil/silcutil.h index d1374d90..1e2a68ea 100644 --- a/lib/silcutil/silcutil.h +++ b/lib/silcutil/silcutil.h @@ -4,7 +4,7 @@ Author: Pekka Riikonen - Copyright (C) 1997 - 2002 Pekka Riikonen + Copyright (C) 1997 - 2005 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 @@ -63,40 +63,61 @@ int silc_check_line(char *buf); * * SYNOPSIS * - * char *silc_get_time(); + * const char *silc_get_time(SilcUInt32 timeval) * * DESCRIPTION * - * Returns current time as string. + * 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. * ***/ -char *silc_get_time(); +const char *silc_get_time(SilcUInt32 timeval); /****f* silcutil/SilcUtilAPI/silc_to_upper * * SYNOPSIS * - * char *silc_to_upper(char *string); + * SilcBool silc_to_upper(const char *string, char *dest, SilcUInt32 dest_size); * * DESCRIPTION * * Converts string to capital characters. * ***/ -char *silc_to_upper(char *string); +SilcBool silc_to_upper(const char *string, char *dest, SilcUInt32 dest_size); + +/****f* silcutil/SilcUtilAPI/silc_to_lower + * + * SYNOPSIS + * + * SilcBool silc_to_lower(const char *string, char *dest, SilcUInt32 dest_size); + * + * DESCRIPTION + * + * Converts string to capital characters. + * + ***/ +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 * @@ -181,6 +202,21 @@ int silc_string_compare(char *string1, char *string2); ***/ SilcUInt32 silc_hash_string(void *key, void *user_context); +/****f* silcutil/SilcUtilAPI/silc_hash_utf8_string + * + * SYNOPSIS + * + * SilcUInt32 silc_hash_utf8_string(void *key, void *user_context); + * + * DESCRIPTION + * + * 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_utf8_string(void *key, void *user_context); + /****f* silcutil/SilcUtilAPI/silc_hash_uint * * SYNOPSIS @@ -220,6 +256,19 @@ SilcUInt32 silc_hash_ptr(void *key, void *user_context); ***/ SilcUInt32 silc_hash_id(void *key, void *user_context); +/****f* silcutil/SilcUtilAPI/silc_hash_client_id_hash + * + * SYNOPSIS + * + * SilcUInt32 silc_hash_client_id_hash(void *key, void *user_context) + * + * DESCRIPTION + * + * Hash Client ID's hash. + * + ***/ +SilcUInt32 silc_hash_client_id_hash(void *key, void *user_context); + /****f* silcutil/SilcUtilAPI/silc_hash_data * * SYNOPSIS @@ -250,7 +299,7 @@ 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 @@ -259,13 +308,14 @@ SilcUInt32 silc_hash_public_key(void *key, void *user_context); * 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 * @@ -274,39 +324,74 @@ bool silc_hash_string_compare(void *key1, void *key2, void *user_context); * 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_id_compare_full + * + * SYNOPSIS + * + * SilcBool silc_hash_id_compare_full(void *key1, void *key2, + * void *user_context) + * + * DESCRIPTION + * + * 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. + * + ***/ +SilcBool silc_hash_id_compare_full(void *key1, void *key2, void *user_context); /****f* silcutil/SilcUtilAPI/silc_hash_client_id_compare * * SYNOPSIS * - * bool silc_hash_client_id_compare(void *key1, void *key2, void *user_context); + * SilcBool silc_hash_client_id_compare(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); +SilcBool 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); + * SilcBool silc_hash_data_compare(void *key1, void *key2, + * void *user_context); * * DESCRIPTION * * Compares binary data. May be used as SilcHashTable comparison function. * ***/ -bool silc_hash_data_compare(void *key1, void *key2, void *user_context); +SilcBool silc_hash_data_compare(void *key1, void *key2, void *user_context); + +/****f* silcutil/SilcUtilAPI/silc_hash_utf8_compare + * + * SYNOPSIS + * + * SilcBool silc_hash_utf8_compare(void *key1, void *key2, + * void *user_context); + * + * DESCRIPTION + * + * Compares UTF-8 strings. Casefolded and NULL terminated strings are + * expected. May be used as SilcHashTable comparison function. + * + ***/ +SilcBool silc_hash_utf8_compare(void *key1, void *key2, void *user_context); /****f* silcutil/SilcUtilAPI/silc_hash_public_key_compare * * SYNOPSIS * - * bool silc_hash_public_key_compare(void *key1, void *key2, void *user_context); + * SilcBool silc_hash_public_key_compare(void *key1, void *key2, + * void *user_context); * * DESCRIPTION * @@ -314,7 +399,8 @@ bool silc_hash_data_compare(void *key1, void *key2, void *user_context); * comparison function. * ***/ -bool silc_hash_public_key_compare(void *key1, void *key2, void *user_context); +SilcBool silc_hash_public_key_compare(void *key1, void *key2, + void *user_context); /****f* silcutil/SilcUtilAPI/silc_client_chmode * @@ -365,7 +451,8 @@ char *silc_client_chumode_char(SilcUInt32 mode); * * 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); @@ -374,7 +461,7 @@ 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 @@ -382,13 +469,13 @@ char *silc_fingerprint(const unsigned char *data, SilcUInt32 data_len); * Return TRUE if the `data' is ASCII string. * ***/ -bool silc_string_is_ascii(const unsigned char *data, SilcUInt32 data_len); +SilcBool 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, + * SilcBool silc_parse_version_string(const char *version, * SilcUInt32 *protocol_version, * char **protocol_version_string, * SilcUInt32 *software_version, @@ -400,7 +487,7 @@ bool silc_string_is_ascii(const unsigned char *data, SilcUInt32 data_len); * Parses SILC protocol style version string. * ***/ -bool silc_parse_version_string(const char *version, +SilcBool silc_parse_version_string(const char *version, SilcUInt32 *protocol_version, char **protocol_version_string, SilcUInt32 *software_version, @@ -424,14 +511,14 @@ SilcUInt32 silc_version_to_num(const char *version); * * 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 */ @@ -443,13 +530,28 @@ char *silc_get_input(const char *prompt, bool echo_off); * * DESCRIPTION * - * Return current time to struct timeval. - * - * This function is system dependant. + * Return current time to struct timeval. This function is system + * dependant. Returns 0 on success and -1 on error. * ***/ int silc_gettimeofday(struct timeval *p); +/****f* silcutil/SilcUtilAPI/silc_compare_timeval + * + * SYNOPSIS + * + * SilcBool silc_compare_timeval(struct timeval *smaller, + * struct timeval *bigger) + * + * DESCRIPTION + * + * Compare two timeval structures and return TRUE if the first + * time value is smaller than the second time value. + * + ***/ +SilcBool silc_compare_timeval(struct timeval *smaller, + struct timeval *bigger); + /****f* silcutil/SilcUtilAPI/silc_string_regexify * * SYNOPSIS @@ -507,7 +609,8 @@ int silc_string_match(const char *string1, const char *string2); * 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. * @@ -522,11 +625,69 @@ char *silc_get_username(); * * 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 + * + * SilcBool 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. + * + ***/ +SilcBool 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 + * + * SYNOPSIS + * + * char *silc_get_command_name(SilcCommand command); + * + * DESCRIPTION + * + * Returns the name corresponding SILC command `command'. + * + ***/ +const char *silc_get_command_name(unsigned char command); + #endif /* !SILCUTIL_H */