Added autodetecting to appropriate use of silc_va_copy.
[runtime.git] / lib / silcutil / silcutil.h
index 4524a80b0c6642237c0599e10c8fedc17ffb7603..0b8a4250e77824333c7fba575461cc07e42a6dc5 100644 (file)
@@ -4,7 +4,7 @@
 
   Author: Pekka Riikonen <priikone@silcnet.org>
 
-  Copyright (C) 1997 - 2007 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
@@ -17,7 +17,7 @@
 
 */
 
-/****h* silcutil/SILC Utilities
+/****h* silcutil/Misc Utilities
  *
  * DESCRIPTION
  *
@@ -28,7 +28,7 @@
 #ifndef SILCUTIL_H
 #define SILCUTIL_H
 
-/****f* silcutil/SilcUtilAPI/silc_gets
+/****f* silcutil/silc_gets
  *
  * SYNOPSIS
  *
@@ -44,7 +44,7 @@
  ***/
 int silc_gets(char *dest, int destlen, const char *src, int srclen, int begin);
 
-/****f* silcutil/SilcUtilAPI/silc_to_upper
+/****f* silcutil/silc_to_upper
  *
  * SYNOPSIS
  *
@@ -58,7 +58,7 @@ int silc_gets(char *dest, int destlen, const char *src, int srclen, int begin);
  ***/
 SilcBool silc_to_upper(const char *string, char *dest, SilcUInt32 dest_size);
 
-/****f* silcutil/SilcUtilAPI/silc_to_lower
+/****f* silcutil/silc_to_lower
  *
  * SYNOPSIS
  *
@@ -72,7 +72,7 @@ SilcBool silc_to_upper(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
+/****f* silcutil/silc_parse_userfqdn
  *
  * SYNOPSIS
  *
@@ -91,7 +91,7 @@ int silc_parse_userfqdn(const char *string,
                        char *user, SilcUInt32 user_size,
                        char *fqdn, SilcUInt32 fqdn_size);
 
-/****f* silcutil/SilcUtilAPI/silc_parse_command_line
+/****f* silcutil/silc_parse_command_line
  *
  * SYNOPSIS
  *
@@ -117,7 +117,7 @@ void silc_parse_command_line(unsigned char *buffer,
                             SilcUInt32 *parsed_num,
                             SilcUInt32 max_args);
 
-/****f* silcutil/SilcUtilAPI/silc_format
+/****f* silcutil/silc_format
  *
  * SYNOPSIS
  *
@@ -131,80 +131,7 @@ void silc_parse_command_line(unsigned char *buffer,
  ***/
 char *silc_format(char *fmt, ...);
 
-/****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_id_compare
- *
- * SYNOPSIS
- *
- *    SilcBool silc_hash_id_compare(void *key1, void *key2,
- *                                  void *user_context);
- *
- * 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.
- *
- ***/
-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
- *
- *    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);
-
-/****f* silcutil/SilcUtilAPI/silc_fingerprint
+/****f* silcutil/silc_fingerprint
  *
  * SYNOPSIS
  *
@@ -220,7 +147,7 @@ SilcBool silc_hash_client_id_compare(void *key1, void *key2,
  ***/
 char *silc_fingerprint(const unsigned char *data, SilcUInt32 data_len);
 
-/****f* silcutil/SilcUtilAPI/silc_string_is_ascii
+/****f* silcutil/silc_string_is_ascii
  *
  * SYNOPSIS
  *
@@ -234,7 +161,7 @@ char *silc_fingerprint(const unsigned char *data, SilcUInt32 data_len);
  ***/
 SilcBool silc_string_is_ascii(const unsigned char *data, SilcUInt32 data_len);
 
-/****f* silcutil/SilcUtilAPI/silc_get_input
+/****f* silcutil/silc_get_input
  *
  * SYNOPSIS
  *
@@ -249,7 +176,7 @@ char *silc_get_input(const char *prompt, SilcBool echo_off);
 
 /* System dependant prototypes */
 
-/****f* silcutil/SilcUtilAPI/silc_get_username
+/****f* silcutil/silc_get_username
  *
  * SYNOPSIS
  *
@@ -266,7 +193,7 @@ char *silc_get_input(const char *prompt, SilcBool echo_off);
  ***/
 char *silc_get_username();
 
-/****f* silcutil/SilcUtilAPI/silc_get_real_name
+/****f* silcutil/silc_get_real_name
  *
  * SYNOPSIS
  *
@@ -282,7 +209,7 @@ char *silc_get_username();
  ***/
 char *silc_get_real_name();
 
-/****f* silcutil/SilcUtilAPI/silc_va_copy
+/****f* silcutil/silc_va_copy
  *
  * SYNOPSIS
  *
@@ -296,17 +223,9 @@ char *silc_get_real_name();
  *    each copied list.
  *
  ***/
-#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
+#define silc_va_copy(dest, src) __SILC_VA_COPY(dest, src)
 
-/****f* silcutil/SilcUtilAPI/silc_hexdump
+/****f* silcutil/silc_hexdump
  *
  * SYNOPSIS
  *
@@ -322,7 +241,7 @@ char *silc_get_real_name();
 void silc_hexdump(const unsigned char *data, SilcUInt32 data_len,
                  FILE *output);
 
-/****f* silcutil/SilcUtilAPI/silc_hex2data
+/****f* silcutil/silc_hex2data
  *
  * SYNOPSIS
  *
@@ -338,7 +257,7 @@ void silc_hexdump(const unsigned char *data, SilcUInt32 data_len,
 SilcBool silc_hex2data(const char *hex, unsigned char *data,
                       SilcUInt32 data_size, SilcUInt32 *ret_data_len);
 
-/****f* silcutil/SilcUtilAPI/silc_data2hex
+/****f* silcutil/silc_data2hex
  *
  * SYNOPSIS
  *
@@ -354,4 +273,18 @@ SilcBool silc_hex2data(const char *hex, unsigned char *data,
 SilcBool silc_data2hex(const unsigned char *data, SilcUInt32 data_len,
                       char *hex, SilcUInt32 hex_size);
 
+/****f* silcutil/silc_get_num_cpu
+ *
+ * SYNOPSIS
+ *
+ *    int silc_get_num_cpu(void);
+ *
+ * DESCRIPTION
+ *
+ *    Returns the number of CPU cores in the current machine.  Returns 0
+ *    if the routine could not determine the number of cores.
+ *
+ ***/
+int silc_get_num_cpu(void);
+
 #endif /* !SILCUTIL_H */