5 Author: Pekka Riikonen <priikone@silcnet.org>
7 Copyright (C) 1997 - 2007 Pekka Riikonen
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; version 2 of the License.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
20 /****h* silcutil/SILC Utilities
31 /****f* silcutil/SilcUtilAPI/silc_gets
35 * int silc_gets(char *dest, int destlen, const char *src, int srclen,
40 * Gets line from a buffer. Stops reading when a newline or EOF occurs.
41 * This doesn't remove the newline sign from the destination buffer. The
42 * argument begin is returned and should be passed again for the function.
45 int silc_gets(char *dest, int destlen, const char *src, int srclen, int begin);
47 /****f* silcutil/SilcUtilAPI/silc_to_upper
51 * SilcBool silc_to_upper(const char *string, char *dest,
52 * SilcUInt32 dest_size);
56 * Converts string to capital characters.
59 SilcBool silc_to_upper(const char *string, char *dest, SilcUInt32 dest_size);
61 /****f* silcutil/SilcUtilAPI/silc_to_lower
65 * SilcBool silc_to_lower(const char *string, char *dest,
66 * SilcUInt32 dest_size);
70 * Converts string to capital characters.
73 SilcBool silc_to_lower(const char *string, char *dest, SilcUInt32 dest_size);
75 /****f* silcutil/SilcUtilAPI/silc_parse_userfqdn
79 * int silc_parse_userfqdn(const char *string,
80 * char *user, SilcUInt32 user_size,
81 * char *fqdn, SilcUInt32 fqdn_size);
85 * Parse userfqdn string which is in user@fqdn format. Returns 0 on
86 * error, 1 if `user' was filled and 2 if both `user' and `fqdn'
90 int silc_parse_userfqdn(const char *string,
91 char *user, SilcUInt32 user_size,
92 char *fqdn, SilcUInt32 fqdn_size);
94 /****f* silcutil/SilcUtilAPI/silc_parse_command_line
98 * void silc_parse_command_line(unsigned char *buffer,
99 * unsigned char ***parsed,
100 * SilcUInt32 **parsed_lens,
101 * SilcUInt32 **parsed_types,
102 * SilcUInt32 *parsed_num,
103 * SilcUInt32 max_args);
107 * Parses command line. At most `max_args' is taken. Rest of the line
108 * will be allocated as the last argument if there are more than `max_args'
109 * arguments in the line. Note that the command name is counted as one
110 * argument and is saved.
113 void silc_parse_command_line(unsigned char *buffer,
114 unsigned char ***parsed,
115 SilcUInt32 **parsed_lens,
116 SilcUInt32 **parsed_types,
117 SilcUInt32 *parsed_num,
118 SilcUInt32 max_args);
120 /****f* silcutil/SilcUtilAPI/silc_format
124 * char *silc_format(char *fmt, ...);
128 * Formats arguments to a string and returns it after allocating memory
129 * for it. It must be remembered to free it later.
132 char *silc_format(char *fmt, ...);
134 /****f* silcutil/SilcUtilAPI/silc_hash_string
138 * SilcUInt32 silc_hash_string(void *key, void *user_context);
142 * Basic has function to hash strings. May be used with the SilcHashTable.
143 * Note that this lowers the characters of the string (with tolower()) so
144 * this can be used to provide case-insensitive hashing.
147 SilcUInt32 silc_hash_string(void *key, void *user_context);
149 /****f* silcutil/SilcUtilAPI/silc_hash_utf8_string
153 * SilcUInt32 silc_hash_utf8_string(void *key, void *user_context);
157 * Basic has function to hash UTF-8 strings. May be used with the
158 * SilcHashTable. Used with identifier strings. The key is
159 * expected to be casefolded.
162 SilcUInt32 silc_hash_utf8_string(void *key, void *user_context);
164 /****f* silcutil/SilcUtilAPI/silc_hash_uint
168 * SilcUInt32 silc_hash_uint(void *key, void *user_context);
172 * Basic hash function to hash integers. May be used with the SilcHashTable.
175 SilcUInt32 silc_hash_uint(void *key, void *user_context);
177 /****f* silcutil/SilcUtilAPI/silc_hash_ptr
181 * SilcUInt32 silc_hash_ptr(void *key, void *user_context);
185 * Basic hash funtion to hash pointers. May be used with the SilcHashTable.
188 SilcUInt32 silc_hash_ptr(void *key, void *user_context);
190 /****f* silcutil/SilcUtilAPI/silc_hash_id
194 * SilcUInt32 silc_hash_id(void *key, void *user_context);
198 * Hash a ID. The `user_context' is the ID type.
201 SilcUInt32 silc_hash_id(void *key, void *user_context);
203 /****f* silcutil/SilcUtilAPI/silc_hash_client_id_hash
207 * SilcUInt32 silc_hash_client_id_hash(void *key, void *user_context)
211 * Hash Client ID's hash.
214 SilcUInt32 silc_hash_client_id_hash(void *key, void *user_context);
216 /****f* silcutil/SilcUtilAPI/silc_hash_data
220 * SilcUInt32 silc_hash_data(void *key, void *user_context);
224 * Hash binary data. The `user_context' is the data length.
227 SilcUInt32 silc_hash_data(void *key, void *user_context);
229 /****f* silcutil/SilcUtilAPI/silc_hash_string_compare
233 * SilcBool silc_hash_string_compare(void *key1, void *key2,
234 * void *user_context);
238 * Compares two strings. This ignores the case while comparing. It may
239 * be used as SilcHashTable comparison function.
242 SilcBool silc_hash_string_compare(void *key1, void *key2, void *user_context);
244 /****f* silcutil/SilcUtilAPI/silc_hash_id_compare
248 * SilcBool silc_hash_id_compare(void *key1, void *key2,
249 * void *user_context);
253 * Compares two ID's. May be used as SilcHashTable comparison function.
254 * The Client ID's compares only the hash of the Client ID not any other
255 * part of the Client ID. Other ID's are fully compared.
258 SilcBool silc_hash_id_compare(void *key1, void *key2, void *user_context);
260 /****f* silcutil/SilcUtilAPI/silc_hash_id_compare_full
264 * SilcBool silc_hash_id_compare_full(void *key1, void *key2,
265 * void *user_context)
269 * Compares two ID's. May be used as SilcHashTable comparison function.
270 * To compare full ID's instead of only partial, like the
271 * silc_hash_id_compare does, use this function.
274 SilcBool silc_hash_id_compare_full(void *key1, void *key2, void *user_context);
276 /****f* silcutil/SilcUtilAPI/silc_hash_client_id_compare
280 * SilcBool silc_hash_client_id_compare(void *key1, void *key2,
281 * void *user_context);
285 * Compare two Client ID's entirely and not just the hash from the ID.
288 SilcBool silc_hash_client_id_compare(void *key1, void *key2,
291 /****f* silcutil/SilcUtilAPI/silc_hash_data_compare
295 * SilcBool silc_hash_data_compare(void *key1, void *key2,
296 * void *user_context);
300 * Compares binary data. May be used as SilcHashTable comparison function.
303 SilcBool silc_hash_data_compare(void *key1, void *key2, void *user_context);
305 /****f* silcutil/SilcUtilAPI/silc_hash_utf8_compare
309 * SilcBool silc_hash_utf8_compare(void *key1, void *key2,
310 * void *user_context);
314 * Compares UTF-8 strings. Casefolded and NULL terminated strings are
315 * expected. May be used as SilcHashTable comparison function.
318 SilcBool silc_hash_utf8_compare(void *key1, void *key2, void *user_context);
320 /****f* silcutil/SilcUtilAPI/silc_fingerprint
324 * char *silc_fingerprint(const unsigned char *data, SilcUInt32 data_len);
328 * Return a textual representation of the fingerprint in *data, the
329 * caller must free the returned string.
332 char *silc_fingerprint(const unsigned char *data, SilcUInt32 data_len);
334 /****f* silcutil/SilcUtilAPI/silc_string_is_ascii
338 * SilcBool silc_string_is_ascii(const unsigned char *data,
339 * SilcUInt32 data_len);
343 * Return TRUE if the `data' is ASCII string.
346 SilcBool silc_string_is_ascii(const unsigned char *data, SilcUInt32 data_len);
348 /****f* silcutil/SilcUtilAPI/silc_get_input
352 * char *silc_get_input(const char *prompt, SilcBool echo_off);
356 * Displays input prompt on command line and takes input data from user.
359 char *silc_get_input(const char *prompt, SilcBool echo_off);
361 /* System dependant prototypes */
363 /****f* silcutil/SilcUtilAPI/silc_get_username
367 * char *silc_get_username();
371 * Returns the username of the user. If the global variable LOGNAME
372 * does not exists we will get the name from the passwd file. The
373 * caller must free the returned name.
375 * This function is system dependant.
378 char *silc_get_username();
380 /****f* silcutil/SilcUtilAPI/silc_get_real_name
384 * char *silc_get_real_name();
388 * Returns the real name of ther user from the passwd file. The
389 * caller must free the returned name.
391 * This function is system dependant.
394 char *silc_get_real_name();
396 /****f* silcutil/SilcUtilAPI/silc_va_copy
400 * void silc_va_copy(va_list dest, va_list src);
404 * Copies variable argument list. This must be called in case the
405 * variable argument list must be evaluated multiple times. For each
406 * evaluation the list must be copied and va_end must be called for
410 #if defined(HAVE_VA_COPY)
411 #define silc_va_copy(dest, src) va_copy(dest, src);
412 #elif defined(HAVE___VA_COPY)
413 #define silc_va_copy(dest, src) __va_copy(dest, src);
414 #elif defined(SILC_VA_COPY_ARRAY)
415 #define silc_va_copy(dest, src) memmove(dest, src, sizeof(va_list));
417 #define silc_va_copy(dest, src) dest = src;
420 /****f* silcutil/SilcUtilAPI/silc_hexdump
424 * void silc_hexdump(const unsigned char *data, SilcUInt32 data_len,
429 * Dumps the `data' of length of `data_len' bytes as HEX. The `output'
430 * file specifies the destination.
433 void silc_hexdump(const unsigned char *data, SilcUInt32 data_len,
436 /****f* silcutil/SilcUtilAPI/silc_hex2data
440 * SilcBool silc_hex2data(const char *hex, unsigned char *data,
441 * SilcUInt32 data_size, SilcUInt32 *ret_data_len);
445 * Converts HEX character string to binary data. Each HEX numbers must
446 * have two characters in the `hex' string.
449 SilcBool silc_hex2data(const char *hex, unsigned char *data,
450 SilcUInt32 data_size, SilcUInt32 *ret_data_len);
452 /****f* silcutil/SilcUtilAPI/silc_data2hex
456 * SilcBool silc_data2hex(const unsigned char *data, SilcUInt32 data_len,
457 * char *hex, SilcUInt32 hex_size);
461 * Converts binary data to HEX string. This NULL terminates the `hex'
462 * buffer automatically.
465 SilcBool silc_data2hex(const unsigned char *data, SilcUInt32 data_len,
466 char *hex, SilcUInt32 hex_size);
468 #endif /* !SILCUTIL_H */