Merge branch 'topic/mm-fixes' of git://208.110.73.182/silc into silc.1.1.branch
[silc.git] / lib / silcutil / silcstrutil.h
index 1fdc0fd16b486c89242d7e91c14d8d17324cbb1a..0860bb3a942c2ecc1a4ceb3f3a9abc933f139cd6 100644 (file)
@@ -67,69 +67,50 @@ typedef enum {
 } SilcStringEncoding;
 /***/
 
-/****f* silcutil/SilcStrUtilAPI/silc_pem_encode
+/****f* silcutil/SilcStrUtilAPI/silc_base64_encode
  *
  * SYNOPSIS
  *
- *    char *silc_pem_encode(unsigned char *data, SilcUInt32 len);
+ *    char *silc_base64_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.
+ *    Encodes data into Base 64 (PEM) encoding. Returns NULL terminated
+ *    Base 64 encoded data string.
  *
  ***/
-char *silc_pem_encode(unsigned char *data, SilcUInt32 len);
+char *silc_base64_encode(unsigned char *data, SilcUInt32 len);
 
-/****f* silcutil/SilcStrUtilAPI/silc_pem_encode_file
+/****f* silcutil/SilcStrUtilAPI/silc_base64_encode_file
  *
  * SYNOPSIS
  *
- *    char *silc_pem_encode_file(unsigned char *data, SilcUInt32 data_len);
+ *    char *silc_base64_encode_file(unsigned char *data, SilcUInt32 data_len);
  *
  * DESCRIPTION
  *
- *    Same as silc_pem_encode() but puts newline ('\n') every 72 characters.
+ *    Same as silc_base64_encode() but puts newline ('\n') every 72
+ *    characters.
  *
  ***/
-char *silc_pem_encode_file(unsigned char *data, SilcUInt32 data_len);
+char *silc_base64_encode_file(unsigned char *data, SilcUInt32 data_len);
 
-/****f* silcutil/SilcStrUtilAPI/silc_pem_decode
+/****f* silcutil/SilcStrUtilAPI/silc_base_decode
  *
  * SYNOPSIS
  *
- *    unsigned char *silc_pem_decode(unsigned char *pem, SilcUInt32 pem_len,
- *                                   SilcUInt32 *ret_len);
+ *    unsigned char *silc_base_decode(unsigned char *base64,
+ *                                    SilcUInt32 base64_len,
+ *                                    SilcUInt32 *ret_len);
  *
  * DESCRIPTION
  *
- *    Decodes PEM into data. Returns the decoded data. Note: This is
- *    originally public domain code and is still PD.
+ *    Decodes Base 64 (PEM) into data. Returns the decoded data.
  *
  ***/
-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 */
+unsigned char *silc_base64_decode(unsigned char *base64,
+                                 SilcUInt32 base64_len,
+                                 SilcUInt32 *ret_len);
 
 /****f* silcutil/SilcStrStrUtilAPI/silc_strncat
  *
@@ -160,8 +141,6 @@ 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);
 
@@ -175,8 +154,6 @@ char *silc_string_regexify(const char *string);
  *
  *    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);
 
@@ -191,8 +168,6 @@ 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);