Added SILC Server library.

[silc.git] / lib / silcutil / silcutil.h

diff --git a/lib/silcutil/silcutil.h b/lib/silcutil/silcutil.h
index 2d569528d376b6884418e41f42aaf8f9fd56cea0..1e2a68eacfcabe8c3b34b38f04b4b0a044a3bdd4 100644 (file)
--- a/lib/silcutil/silcutil.h
+++ b/lib/silcutil/silcutil.h
@@ -4,7 +4,7 @@
 
   Author: Pekka Riikonen <priikone@silcnet.org>
 
-  Copyright (C) 1997 - 2003 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
@@ -33,7 +33,7 @@
  * SYNOPSIS
  *
  *    int silc_gets(char *dest, int destlen, const char *src, int srclen,
- *                  int *begin);
+ *                  int begin);
  *
  * DESCRIPTION
  *
@@ -42,8 +42,7 @@
  *    argument begin is returned and should be passed again for the function.
  *
  ***/
-int silc_gets(char *dest, int destlen, const char *src, int srclen,
-             int *begin);
+int silc_gets(char *dest, int destlen, const char *src, int srclen, int begin);
 
 /****f* silcutil/SilcUtilAPI/silc_check_line
  *
@@ -79,40 +78,46 @@ const char *silc_get_time(SilcUInt32 timeval);
  *
  * 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
  *
@@ -197,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
@@ -279,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
@@ -288,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
  *
@@ -303,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
  *
@@ -343,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
  *
@@ -404,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
@@ -412,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,
@@ -430,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,
@@ -454,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 */
 
@@ -483,7 +540,7 @@ int silc_gettimeofday(struct timeval *p);
  *
  * SYNOPSIS
  *
- *    bool silc_compare_timeval(struct timeval *smaller,
+ *    SilcBool silc_compare_timeval(struct timeval *smaller,
  *                              struct timeval *bigger)
  *
  * DESCRIPTION
@@ -492,7 +549,7 @@ int silc_gettimeofday(struct timeval *p);
  *    time value is smaller than the second time value.
  *
  ***/
-bool silc_compare_timeval(struct timeval *smaller,
+SilcBool silc_compare_timeval(struct timeval *smaller,
                          struct timeval *bigger);
 
 /****f* silcutil/SilcUtilAPI/silc_string_regexify
@@ -580,7 +637,7 @@ char *silc_get_real_name();
  *
  * SYNOPSIS
  *
- *    bool silc_get_mode_list(SilcBuffer mode_list, SilcUInt32 mode_list_count,
+ *    SilcBool silc_get_mode_list(SilcBuffer mode_list, SilcUInt32 mode_list_count,
  *                            SilcUInt32 **list);
  *
  * DESCRIPTION
@@ -591,7 +648,7 @@ char *silc_get_real_name();
  *    there is error parsing the list.
  *
  ***/
-bool silc_get_mode_list(SilcBuffer mode_list, SilcUInt32 mode_list_count,
+SilcBool silc_get_mode_list(SilcBuffer mode_list, SilcUInt32 mode_list_count,
                        SilcUInt32 **list);
 
 /****f* silcutil/SilcUtilAPI/silc_get_status_message