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_check_line
51 * int silc_check_line(char *buf);
55 * Checks line for illegal characters. Return -1 when illegal character
56 * were found. This is used to check for bad lines when reading data from
57 * for example a configuration file.
60 int silc_check_line(char *buf);
62 /****f* silcutil/SilcUtilAPI/silc_to_upper
66 * SilcBool silc_to_upper(const char *string, char *dest,
67 * SilcUInt32 dest_size);
71 * Converts string to capital characters.
74 SilcBool silc_to_upper(const char *string, char *dest, SilcUInt32 dest_size);
76 /****f* silcutil/SilcUtilAPI/silc_to_lower
80 * SilcBool silc_to_lower(const char *string, char *dest,
81 * SilcUInt32 dest_size);
85 * Converts string to capital characters.
88 SilcBool silc_to_lower(const char *string, char *dest, SilcUInt32 dest_size);
90 /****f* silcutil/SilcUtilAPI/silc_parse_userfqdn
94 * int silc_parse_userfqdn(const char *string,
95 * char *user, SilcUInt32 user_size,
96 * char *fqdn, SilcUInt32 fqdn_size);
100 * Parse userfqdn string which is in user@fqdn format. Returns 0 on
101 * error, 1 if `user' was filled and 2 if both `user' and `fqdn'
105 int silc_parse_userfqdn(const char *string,
106 char *user, SilcUInt32 user_size,
107 char *fqdn, SilcUInt32 fqdn_size);
109 /****f* silcutil/SilcUtilAPI/silc_parse_command_line
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);
122 * Parses command line. At most `max_args' is taken. Rest of the line
123 * will be allocated as the last argument if there are more than `max_args'
124 * arguments in the line. Note that the command name is counted as one
125 * argument and is saved.
128 void silc_parse_command_line(unsigned char *buffer,
129 unsigned char ***parsed,
130 SilcUInt32 **parsed_lens,
131 SilcUInt32 **parsed_types,
132 SilcUInt32 *parsed_num,
133 SilcUInt32 max_args);
135 /****f* silcutil/SilcUtilAPI/silc_format
139 * char *silc_format(char *fmt, ...);
143 * Formats arguments to a string and returns it after allocating memory
144 * for it. It must be remembered to free it later.
147 char *silc_format(char *fmt, ...);
149 /****f* silcutil/SilcUtilAPI/silc_hash_string
153 * SilcUInt32 silc_hash_string(void *key, void *user_context);
157 * Basic has function to hash strings. May be used with the SilcHashTable.
158 * Note that this lowers the characters of the string (with tolower()) so
159 * this can be used to provide case-insensitive hashing.
162 SilcUInt32 silc_hash_string(void *key, void *user_context);
164 /****f* silcutil/SilcUtilAPI/silc_hash_utf8_string
168 * SilcUInt32 silc_hash_utf8_string(void *key, void *user_context);
172 * Basic has function to hash UTF-8 strings. May be used with the
173 * SilcHashTable. Used with identifier strings. The key is
174 * expected to be casefolded.
177 SilcUInt32 silc_hash_utf8_string(void *key, void *user_context);
179 /****f* silcutil/SilcUtilAPI/silc_hash_uint
183 * SilcUInt32 silc_hash_uint(void *key, void *user_context);
187 * Basic hash function to hash integers. May be used with the SilcHashTable.
190 SilcUInt32 silc_hash_uint(void *key, void *user_context);
192 /****f* silcutil/SilcUtilAPI/silc_hash_ptr
196 * SilcUInt32 silc_hash_ptr(void *key, void *user_context);
200 * Basic hash funtion to hash pointers. May be used with the SilcHashTable.
203 SilcUInt32 silc_hash_ptr(void *key, void *user_context);
205 /****f* silcutil/SilcUtilAPI/silc_hash_id
209 * SilcUInt32 silc_hash_id(void *key, void *user_context);
213 * Hash a ID. The `user_context' is the ID type.
216 SilcUInt32 silc_hash_id(void *key, void *user_context);
218 /****f* silcutil/SilcUtilAPI/silc_hash_client_id_hash
222 * SilcUInt32 silc_hash_client_id_hash(void *key, void *user_context)
226 * Hash Client ID's hash.
229 SilcUInt32 silc_hash_client_id_hash(void *key, void *user_context);
231 /****f* silcutil/SilcUtilAPI/silc_hash_data
235 * SilcUInt32 silc_hash_data(void *key, void *user_context);
239 * Hash binary data. The `user_context' is the data length.
242 SilcUInt32 silc_hash_data(void *key, void *user_context);
244 /****f* silcutil/SilcUtilAPI/silc_hash_string_compare
248 * SilcBool silc_hash_string_compare(void *key1, void *key2,
249 * void *user_context);
253 * Compares two strings. This ignores the case while comparing. It may
254 * be used as SilcHashTable comparison function.
257 SilcBool silc_hash_string_compare(void *key1, void *key2, void *user_context);
259 /****f* silcutil/SilcUtilAPI/silc_hash_id_compare
263 * SilcBool silc_hash_id_compare(void *key1, void *key2,
264 * void *user_context);
268 * Compares two ID's. May be used as SilcHashTable comparison function.
269 * The Client ID's compares only the hash of the Client ID not any other
270 * part of the Client ID. Other ID's are fully compared.
273 SilcBool silc_hash_id_compare(void *key1, void *key2, void *user_context);
275 /****f* silcutil/SilcUtilAPI/silc_hash_id_compare_full
279 * SilcBool silc_hash_id_compare_full(void *key1, void *key2,
280 * void *user_context)
284 * Compares two ID's. May be used as SilcHashTable comparison function.
285 * To compare full ID's instead of only partial, like the
286 * silc_hash_id_compare does, use this function.
289 SilcBool silc_hash_id_compare_full(void *key1, void *key2, void *user_context);
291 /****f* silcutil/SilcUtilAPI/silc_hash_client_id_compare
295 * SilcBool silc_hash_client_id_compare(void *key1, void *key2,
296 * void *user_context);
300 * Compare two Client ID's entirely and not just the hash from the ID.
303 SilcBool silc_hash_client_id_compare(void *key1, void *key2,
306 /****f* silcutil/SilcUtilAPI/silc_hash_data_compare
310 * SilcBool silc_hash_data_compare(void *key1, void *key2,
311 * void *user_context);
315 * Compares binary data. May be used as SilcHashTable comparison function.
318 SilcBool silc_hash_data_compare(void *key1, void *key2, void *user_context);
320 /****f* silcutil/SilcUtilAPI/silc_hash_utf8_compare
324 * SilcBool silc_hash_utf8_compare(void *key1, void *key2,
325 * void *user_context);
329 * Compares UTF-8 strings. Casefolded and NULL terminated strings are
330 * expected. May be used as SilcHashTable comparison function.
333 SilcBool silc_hash_utf8_compare(void *key1, void *key2, void *user_context);
335 /****f* silcutil/SilcUtilAPI/silc_fingerprint
339 * char *silc_fingerprint(const unsigned char *data, SilcUInt32 data_len);
343 * Return a textual representation of the fingerprint in *data, the
344 * caller must free the returned string.
347 char *silc_fingerprint(const unsigned char *data, SilcUInt32 data_len);
349 /****f* silcutil/SilcUtilAPI/silc_string_is_ascii
353 * SilcBool silc_string_is_ascii(const unsigned char *data,
354 * SilcUInt32 data_len);
358 * Return TRUE if the `data' is ASCII string.
361 SilcBool silc_string_is_ascii(const unsigned char *data, SilcUInt32 data_len);
363 /****f* silcutil/SilcUtilAPI/silc_get_input
367 * char *silc_get_input(const char *prompt, SilcBool echo_off);
371 * Displays input prompt on command line and takes input data from user.
374 char *silc_get_input(const char *prompt, SilcBool echo_off);
376 /* System dependant prototypes */
378 /****f* silcutil/SilcUtilAPI/silc_get_username
382 * char *silc_get_username();
386 * Returns the username of the user. If the global variable LOGNAME
387 * does not exists we will get the name from the passwd file. The
388 * caller must free the returned name.
390 * This function is system dependant.
393 char *silc_get_username();
395 /****f* silcutil/SilcUtilAPI/silc_get_real_name
399 * char *silc_get_real_name();
403 * Returns the real name of ther user from the passwd file. The
404 * caller must free the returned name.
406 * This function is system dependant.
409 char *silc_get_real_name();
411 /****f* silcutil/SilcUtilAPI/silc_va_copy
415 * void silc_va_copy(va_list dest, va_list src);
419 * Copies variable argument list. This must be called in case the
420 * variable argument list must be evaluated multiple times. For each
421 * evaluation the list must be copied and va_end must be called for
425 #if defined(HAVE_VA_COPY)
426 #define silc_va_copy(dest, src) va_copy(dest, src);
427 #elif defined(HAVE___VA_COPY)
428 #define silc_va_copy(dest, src) __va_copy(dest, src);
429 #elif defined(SILC_VA_COPY_ARRAY)
430 #define silc_va_copy(dest, src) memmove(dest, src, sizeof(va_list));
432 #define silc_va_copy(dest, src) dest = src;
435 /****f* silcutil/SilcUtilAPI/silc_hexdump
439 * void silc_hexdump(const unsigned char *data, SilcUInt32 data_len,
444 * Dumps the `data' of length of `data_len' bytes as HEX. The `output'
445 * file specifies the destination.
448 void silc_hexdump(const unsigned char *data, SilcUInt32 data_len,
451 /****f* silcutil/SilcUtilAPI/silc_hex2data
455 * SilcBool silc_hex2data(const char *hex, unsigned char *data,
456 * SilcUInt32 data_size, SilcUInt32 *ret_data_len);
460 * Converts HEX character string to binary data. Each HEX numbers must
461 * have two characters in the `hex' string.
464 SilcBool silc_hex2data(const char *hex, unsigned char *data,
465 SilcUInt32 data_size, SilcUInt32 *ret_data_len);
467 /****f* silcutil/SilcUtilAPI/silc_data2hex
471 * SilcBool silc_data2hex(const unsigned char *data, SilcUInt32 data_len,
472 * char *hex, SilcUInt32 hex_size);
476 * Converts binary data to HEX string. This NULL terminates the `hex'
477 * buffer automatically.
480 SilcBool silc_data2hex(const unsigned char *data, SilcUInt32 data_len,
481 char *hex, SilcUInt32 hex_size);
483 #endif /* !SILCUTIL_H */