SILC Runtime Toolkit 1.2 Beta 1
[runtime.git] / lib / silcutil / silcstrutil.h
index 1fdc0fd16b486c89242d7e91c14d8d17324cbb1a..a9f08fe031fb50705eea9218d3e686629eacfba9 100644 (file)
@@ -4,7 +4,7 @@
 
   Author: Pekka Riikonen <priikone@silcnet.org>
 
-  Copyright (C) 2002 - 2007 Pekka Riikonen
+  Copyright (C) 2002 - 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 String Utilities
+/****h* silcutil/String Utilities
  *
  * DESCRIPTION
  *
- * String manipulation utility routines.  These routines provides
- * various helper functions for encoding, decoding and otherwise
- * managing strings.
+ * Various string utility routines.
  *
  ***/
 
 #ifndef SILCSTRUTIL_H
 #define SILCSTRUTIL_H
 
-/****d* silcutil/SilcStrUtilAPI/SilcStringEncoding
+/****d* silcutil/SilcStringEncoding
  *
  * NAME
  *
@@ -67,71 +65,7 @@ typedef enum {
 } SilcStringEncoding;
 /***/
 
-/****f* silcutil/SilcStrUtilAPI/silc_pem_encode
- *
- * SYNOPSIS
- *
- *    char *silc_pem_encode(unsigned char *data, SilcUInt32 len);
- *
- * DESCRIPTION
- *
- *    Encodes data into PEM encoding. Returns NULL terminated PEM encoded
- *    data string. Note: This is originally public domain code and is
- *    still PD.
- *
- ***/
-char *silc_pem_encode(unsigned char *data, SilcUInt32 len);
-
-/****f* silcutil/SilcStrUtilAPI/silc_pem_encode_file
- *
- * SYNOPSIS
- *
- *    char *silc_pem_encode_file(unsigned char *data, SilcUInt32 data_len);
- *
- * DESCRIPTION
- *
- *    Same as silc_pem_encode() but puts newline ('\n') every 72 characters.
- *
- ***/
-char *silc_pem_encode_file(unsigned char *data, SilcUInt32 data_len);
-
-/****f* silcutil/SilcStrUtilAPI/silc_pem_decode
- *
- * SYNOPSIS
- *
- *    unsigned char *silc_pem_decode(unsigned char *pem, SilcUInt32 pem_len,
- *                                   SilcUInt32 *ret_len);
- *
- * DESCRIPTION
- *
- *    Decodes PEM into data. Returns the decoded data. Note: This is
- *    originally public domain code and is still PD.
- *
- ***/
-unsigned char *silc_pem_decode(unsigned char *pem, SilcUInt32 pem_len,
-                              SilcUInt32 *ret_len);
-
-/****f* silcutil/SilcStrStrUtilAPI/silc_snprintf
- *
- * SYNOPSIS
- *
- *    int silc_snprintf(char *str, SilcUInt32 size, const char *format, ...);
- *
- * DESCRIPTION
- *
- *    Produces output string according to the `format'.  The formatting
- *    is equivalent to silc_snprintf(3) and sprintf(3).  Returns the number of
- *    characters output into `str', at most `size' characters including the
- *    trailing '\0' character.  Returns negative value on error.
- *
- ***/
-#ifndef SILC_SNPRINTF
-int silc_snprintf(char *str, SilcUInt32 size, const char *format, ...);
-#else
-#define silc_snprintf snprintf
-#endif /* SILC_SNPRINTF */
-
-/****f* silcutil/SilcStrStrUtilAPI/silc_strncat
+/****f* silcutil/silc_strncat
  *
  * SYNOPSIS
  *
@@ -148,7 +82,7 @@ int silc_snprintf(char *str, SilcUInt32 size, const char *format, ...);
 char *silc_strncat(char *dest, SilcUInt32 dest_size,
                   const char *src, SilcUInt32 src_len);
 
-/****f* silcutil/SilcStrUtilAPI/silc_string_regexify
+/****f* silcutil/silc_string_regexify
  *
  * SYNOPSIS
  *
@@ -160,27 +94,10 @@ char *silc_strncat(char *dest, SilcUInt32 dest_size,
  *    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/SilcStrUtilAPI/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/SilcStrUtilAPI/silc_string_match
+/****f* silcutil/silc_string_match
  *
  * SYNOPSIS
  *
@@ -191,12 +108,10 @@ int silc_string_regex_match(const char *regex, const char *string);
  *    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/SilcStrUtilAPI/silc_string_compare
+/****f* silcutil/silc_string_compare
  *
  * SYNOPSIS
  *
@@ -210,7 +125,7 @@ int silc_string_match(const char *string1, const char *string2);
  ***/
 int silc_string_compare(char *string1, char *string2);
 
-/****f* silcutil/SilcStrUtilAPI/silc_string_split
+/****f* silcutil/silc_string_split
  *
  * SYNOPSIS
  *