Author: Pekka Riikonen <priikone@silcnet.org>
- Copyright (C) 1997 - 2006 Pekka Riikonen
+ Copyright (C) 1997 - 2008 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
*/
-/****h* silcutil/SILC Utilities
+/****h* silcutil/Misc Utilities
*
* DESCRIPTION
*
#ifndef SILCUTIL_H
#define SILCUTIL_H
-/****f* silcutil/SilcUtilAPI/silc_gets
+/****f* silcutil/silc_gets
*
* SYNOPSIS
*
***/
int silc_gets(char *dest, int destlen, const char *src, int srclen, int begin);
-/****f* silcutil/SilcUtilAPI/silc_check_line
- *
- * SYNOPSIS
- *
- * int silc_check_line(char *buf);
- *
- * DESCRIPTION
- *
- * Checks line for illegal characters. Return -1 when illegal character
- * were found. This is used to check for bad lines when reading data from
- * for example a configuration file.
- *
- ***/
-int silc_check_line(char *buf);
-
-/****f* silcutil/SilcUtilAPI/silc_to_upper
+/****f* silcutil/silc_to_upper
*
* SYNOPSIS
*
***/
SilcBool silc_to_upper(const char *string, char *dest, SilcUInt32 dest_size);
-/****f* silcutil/SilcUtilAPI/silc_to_lower
+/****f* silcutil/silc_to_lower
*
* SYNOPSIS
*
***/
SilcBool silc_to_lower(const char *string, char *dest, SilcUInt32 dest_size);
-/****f* silcutil/SilcUtilAPI/silc_parse_userfqdn
+/****f* silcutil/silc_parse_userfqdn
*
* SYNOPSIS
*
char *user, SilcUInt32 user_size,
char *fqdn, SilcUInt32 fqdn_size);
-/****f* silcutil/SilcUtilAPI/silc_parse_command_line
+/****f* silcutil/silc_parse_command_line
*
* SYNOPSIS
*
SilcUInt32 *parsed_num,
SilcUInt32 max_args);
-/****f* silcutil/SilcUtilAPI/silc_format
+/****f* silcutil/silc_format
*
* SYNOPSIS
*
***/
char *silc_format(char *fmt, ...);
-/****f* silcutil/SilcUtilAPI/silc_hash_string
- *
- * SYNOPSIS
- *
- * SilcUInt32 silc_hash_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.
- *
- ***/
-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
- *
- * SilcUInt32 silc_hash_uint(void *key, void *user_context);
- *
- * DESCRIPTION
- *
- * Basic hash function to hash integers. May be used with the SilcHashTable.
- *
- ***/
-SilcUInt32 silc_hash_uint(void *key, void *user_context);
-
-/****f* silcutil/SilcUtilAPI/silc_hash_ptr
- *
- * SYNOPSIS
- *
- * SilcUInt32 silc_hash_ptr(void *key, void *user_context);
- *
- * DESCRIPTION
- *
- * Basic hash funtion to hash pointers. May be used with the SilcHashTable.
- *
- ***/
-SilcUInt32 silc_hash_ptr(void *key, void *user_context);
-
-/****f* silcutil/SilcUtilAPI/silc_hash_id
- *
- * SYNOPSIS
- *
- * SilcUInt32 silc_hash_id(void *key, void *user_context);
- *
- * DESCRIPTION
- *
- * Hash a ID. The `user_context' is the ID type.
- *
- ***/
-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
- *
- * SilcUInt32 silc_hash_data(void *key, void *user_context);
- *
- * DESCRIPTION
- *
- * Hash binary data. The `user_context' is the data length.
- *
- ***/
-SilcUInt32 silc_hash_data(void *key, void *user_context);
-
-/****f* silcutil/SilcUtilAPI/silc_hash_public_key
- *
- * SYNOPSIS
- *
- * SilcUInt32 silc_hash_public_key(void *key, void *user_context);
- *
- * DESCRIPTION
- *
- * Hash public key of any type.
- *
- ***/
-SilcUInt32 silc_hash_public_key(void *key, void *user_context);
-
-/****f* silcutil/SilcUtilAPI/silc_hash_string_compare
+/****f* silcutil/silc_fingerprint
*
* SYNOPSIS
*
- * SilcBool silc_hash_string_compare(void *key1, void *key2,
- * void *user_context);
+ * char *silc_fingerprint(const unsigned char *data, SilcUInt32 data_len);
*
* DESCRIPTION
*
- * Compares two strings. It may be used as SilcHashTable comparison
- * function.
+ * Return a textual representation of the fingerprint in *data, the
+ * caller must free the returned string. Returns NULL on error. If
+ * the `data_len' is longer than 255 bytes, only the first 255 bytes are
+ * used to create the fingerprint.
*
***/
-SilcBool silc_hash_string_compare(void *key1, void *key2, void *user_context);
+char *silc_fingerprint(const unsigned char *data, SilcUInt32 data_len);
-/****f* silcutil/SilcUtilAPI/silc_hash_id_compare
+/****f* silcutil/silc_string_is_ascii
*
* SYNOPSIS
*
- * SilcBool silc_hash_id_compare(void *key1, void *key2,
- * void *user_context);
+ * SilcBool silc_string_is_ascii(const unsigned char *data,
+ * SilcUInt32 data_len);
*
* DESCRIPTION
*
- * Compares two ID's. May be used as SilcHashTable comparison function.
- * The Client ID's compares only the hash of the Client ID not any other
- * part of the Client ID. Other ID's are fully compared.
+ * Return TRUE if the `data' is ASCII string.
*
***/
-SilcBool silc_hash_id_compare(void *key1, void *key2, void *user_context);
+SilcBool silc_string_is_ascii(const unsigned char *data, SilcUInt32 data_len);
-/****f* silcutil/SilcUtilAPI/silc_hash_id_compare_full
+/****f* silcutil/silc_get_input
*
* SYNOPSIS
*
- * SilcBool silc_hash_id_compare_full(void *key1, void *key2,
- * void *user_context)
+ * char *silc_get_input(const char *prompt, SilcBool echo_off);
*
* 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.
+ * Displays input prompt on command line and takes input data from user.
*
***/
-SilcBool silc_hash_id_compare_full(void *key1, void *key2, void *user_context);
+char *silc_get_input(const char *prompt, SilcBool echo_off);
-/****f* silcutil/SilcUtilAPI/silc_hash_client_id_compare
- *
- * SYNOPSIS
- *
- * 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.
- *
- ***/
-SilcBool silc_hash_client_id_compare(void *key1, void *key2,
- void *user_context);
+/* System dependant prototypes */
-/****f* silcutil/SilcUtilAPI/silc_hash_data_compare
+/****f* silcutil/silc_get_username
*
* SYNOPSIS
*
- * SilcBool silc_hash_data_compare(void *key1, void *key2,
- * void *user_context);
+ * char *silc_get_username();
*
* DESCRIPTION
*
- * Compares binary data. May be used as SilcHashTable comparison function.
- *
- ***/
-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
+ * Returns the username of the user. If the global variable LOGNAME
+ * does not exists we will get the name from the passwd file. The
+ * caller must free the returned name.
*
- * Compares UTF-8 strings. Casefolded and NULL terminated strings are
- * expected. May be used as SilcHashTable comparison function.
+ * This function is system dependant.
*
***/
-SilcBool silc_hash_utf8_compare(void *key1, void *key2, void *user_context);
+char *silc_get_username();
-/****f* silcutil/SilcUtilAPI/silc_hash_public_key_compare
+/****f* silcutil/silc_get_real_name
*
* SYNOPSIS
*
- * SilcBool silc_hash_public_key_compare(void *key1, void *key2,
- * void *user_context);
+ * char *silc_get_real_name();
*
* DESCRIPTION
*
- * Compares two SILC Public keys. It may be used as SilcHashTable
- * comparison function.
- *
- ***/
-SilcBool silc_hash_public_key_compare(void *key1, void *key2,
- void *user_context);
-
-/****f* silcutil/SilcUtilAPI/silc_fingerprint
- *
- * SYNOPSIS
- *
- * char *silc_fingerprint(const unsigned char *data, SilcUInt32 data_len);
- *
- * DESCRIPTION
+ * Returns the real name of ther user from the passwd file. The
+ * caller must free the returned name.
*
- * Return a textual representation of the fingerprint in *data, the
- * caller must free the returned string.
+ * This function is system dependant.
*
***/
-char *silc_fingerprint(const unsigned char *data, SilcUInt32 data_len);
+char *silc_get_real_name();
-/****f* silcutil/SilcUtilAPI/silc_string_is_ascii
+/****f* silcutil/silc_va_copy
*
* SYNOPSIS
*
- * SilcBool silc_string_is_ascii(const unsigned char *data,
- * SilcUInt32 data_len);
+ * void silc_va_copy(va_list dest, va_list src);
*
* DESCRIPTION
*
- * Return TRUE if the `data' is ASCII string.
+ * 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.
*
***/
-SilcBool silc_string_is_ascii(const unsigned char *data, SilcUInt32 data_len);
+#define silc_va_copy(dest, src) __SILC_VA_COPY(dest, src)
-/****f* silcutil/SilcUtilAPI/silc_get_input
+/****f* silcutil/silc_hexdump
*
* SYNOPSIS
*
- * char *silc_get_input(const char *prompt, SilcBool echo_off);
+ * void silc_hexdump(const unsigned char *data, SilcUInt32 data_len,
+ * FILE *output);
*
* DESCRIPTION
*
- * Displays input prompt on command line and takes input data from user.
+ * Dumps the `data' of length of `data_len' bytes as HEX. The `output'
+ * file specifies the destination.
*
***/
-char *silc_get_input(const char *prompt, SilcBool echo_off);
+void silc_hexdump(const unsigned char *data, SilcUInt32 data_len,
+ FILE *output);
-/* System dependant prototypes */
-
-/****f* silcutil/SilcUtilAPI/silc_get_username
+/****f* silcutil/silc_hex2data
*
* SYNOPSIS
*
- * char *silc_get_username();
+ * SilcBool silc_hex2data(const char *hex, unsigned char *data,
+ * SilcUInt32 data_size, SilcUInt32 *ret_data_len);
*
* DESCRIPTION
*
- * Returns the username of the user. If the global variable LOGNAME
- * does not exists we will get the name from the passwd file. The
- * caller must free the returned name.
- *
- * This function is system dependant.
+ * Converts HEX character string to binary data. Each HEX numbers must
+ * have two characters in the `hex' string.
*
***/
-char *silc_get_username();
+SilcBool silc_hex2data(const char *hex, unsigned char *data,
+ SilcUInt32 data_size, SilcUInt32 *ret_data_len);
-/****f* silcutil/SilcUtilAPI/silc_get_real_name
+/****f* silcutil/silc_data2hex
*
* SYNOPSIS
*
- * char *silc_get_real_name();
+ * SilcBool silc_data2hex(const unsigned char *data, SilcUInt32 data_len,
+ * char *hex, SilcUInt32 hex_size);
*
* DESCRIPTION
*
- * Returns the real name of ther user from the passwd file. The
- * caller must free the returned name.
- *
- * This function is system dependant.
+ * Converts binary data to HEX string. This NULL terminates the `hex'
+ * buffer automatically.
*
***/
-char *silc_get_real_name();
+SilcBool silc_data2hex(const unsigned char *data, SilcUInt32 data_len,
+ char *hex, SilcUInt32 hex_size);
-/****f* silcutil/SilcUtilAPI/silc_va_copy
+/****f* silcutil/silc_get_num_cpu
*
* SYNOPSIS
*
- * void silc_va_copy(va_list dest, va_list src);
+ * int silc_get_num_cpu(void);
*
* DESCRIPTION
*
- * 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.
+ * Returns the number of CPU cores in the current machine. Returns 0
+ * if the routine could not determine the number of cores.
*
***/
-void silc_va_copy(va_list dest, va_list src);
+int silc_get_num_cpu(void);
#endif /* !SILCUTIL_H */
projects / runtime.git / blobdiff