5 Author: Pekka Riikonen <priikone@silcnet.org>
7 Copyright (C) 1997 - 2005 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_get_time
66 * const char *silc_get_time(SilcUInt32 timeval)
70 * Returns time as string. If the the `timeval' is non-zero that
71 * value is returned as string. If it is zero the current time of the
72 * local machine is returned.
75 const char *silc_get_time(SilcUInt32 timeval);
77 /****f* silcutil/SilcUtilAPI/silc_to_upper
81 * bool silc_to_upper(const char *string, char *dest, SilcUInt32 dest_size);
85 * Converts string to capital characters.
88 bool silc_to_upper(const char *string, char *dest, SilcUInt32 dest_size);
90 /****f* silcutil/SilcUtilAPI/silc_to_lower
94 * bool silc_to_lower(const char *string, char *dest, SilcUInt32 dest_size);
98 * Converts string to capital characters.
101 bool silc_to_lower(const char *string, char *dest, SilcUInt32 dest_size);
103 /****f* silcutil/SilcUtilAPI/silc_parse_userfqdn
107 * bool silc_parse_userfqdn(const char *string, char **left, char **right);
111 * Parse userfqdn string which is in user@fqdn format.
114 bool silc_parse_userfqdn(const char *string, char **left, char **right);
116 /****f* silcutil/SilcUtilAPI/silc_parse_command_line
120 * void silc_parse_command_line(unsigned char *buffer,
121 * unsigned char ***parsed,
122 * SilcUInt32 **parsed_lens,
123 * SilcUInt32 **parsed_types,
124 * SilcUInt32 *parsed_num,
125 * SilcUInt32 max_args);
129 * Parses command line. At most `max_args' is taken. Rest of the line
130 * will be allocated as the last argument if there are more than `max_args'
131 * arguments in the line. Note that the command name is counted as one
132 * argument and is saved.
135 void silc_parse_command_line(unsigned char *buffer,
136 unsigned char ***parsed,
137 SilcUInt32 **parsed_lens,
138 SilcUInt32 **parsed_types,
139 SilcUInt32 *parsed_num,
140 SilcUInt32 max_args);
142 /****f* silcutil/SilcUtilAPI/silc_format
146 * char *silc_format(char *fmt, ...);
150 * Formats arguments to a string and returns it after allocating memory
151 * for it. It must be remembered to free it later.
154 char *silc_format(char *fmt, ...);
156 /****f* silcutil/SilcUtilAPI/silc_id_render
160 * char *silc_id_render(void *id, SilcUInt16 type);
164 * Renders ID to suitable to print for example to log file.
167 char *silc_id_render(void *id, SilcUInt16 type);
169 /****f* silcutil/SilcUtilAPI/silc_string_compare
173 * int silc_string_compare(char *string1, char *string2);
177 * Compares two strings. Strings may include wildcards '*' and '?'.
178 * Returns TRUE if strings match.
181 int silc_string_compare(char *string1, char *string2);
183 /****f* silcutil/SilcUtilAPI/silc_hash_string
187 * SilcUInt32 silc_hash_string(void *key, void *user_context);
191 * Basic has function to hash strings. May be used with the SilcHashTable.
192 * Note that this lowers the characters of the string (with tolower()) so
193 * this is used usually with nicknames, channel and server names to provide
194 * case insensitive keys.
197 SilcUInt32 silc_hash_string(void *key, void *user_context);
199 /****f* silcutil/SilcUtilAPI/silc_hash_utf8_string
203 * SilcUInt32 silc_hash_utf8_string(void *key, void *user_context);
207 * Basic has function to hash UTF-8 strings. May be used with the
208 * SilcHashTable. Used with identifier strings. The key is
209 * expected to be casefolded.
212 SilcUInt32 silc_hash_utf8_string(void *key, void *user_context);
214 /****f* silcutil/SilcUtilAPI/silc_hash_uint
218 * SilcUInt32 silc_hash_uint(void *key, void *user_context);
222 * Basic hash function to hash integers. May be used with the SilcHashTable.
225 SilcUInt32 silc_hash_uint(void *key, void *user_context);
227 /****f* silcutil/SilcUtilAPI/silc_hash_ptr
231 * SilcUInt32 silc_hash_ptr(void *key, void *user_context);
235 * Basic hash funtion to hash pointers. May be used with the SilcHashTable.
238 SilcUInt32 silc_hash_ptr(void *key, void *user_context);
240 /****f* silcutil/SilcUtilAPI/silc_hash_id
244 * SilcUInt32 silc_hash_id(void *key, void *user_context);
248 * Hash a ID. The `user_context' is the ID type.
251 SilcUInt32 silc_hash_id(void *key, void *user_context);
253 /****f* silcutil/SilcUtilAPI/silc_hash_client_id_hash
257 * SilcUInt32 silc_hash_client_id_hash(void *key, void *user_context)
261 * Hash Client ID's hash.
264 SilcUInt32 silc_hash_client_id_hash(void *key, void *user_context);
266 /****f* silcutil/SilcUtilAPI/silc_hash_data
270 * SilcUInt32 silc_hash_data(void *key, void *user_context);
274 * Hash binary data. The `user_context' is the data length.
277 SilcUInt32 silc_hash_data(void *key, void *user_context);
279 /****f* silcutil/SilcUtilAPI/silc_hash_public_key
283 * SilcUInt32 silc_hash_public_key(void *key, void *user_context);
287 * Hashed SILC Public key.
290 SilcUInt32 silc_hash_public_key(void *key, void *user_context);
292 /****f* silcutil/SilcUtilAPI/silc_hash_string_compare
296 * bool silc_hash_string_compare(void *key1, void *key2,
297 * void *user_context);
301 * Compares two strings. It may be used as SilcHashTable comparison
305 bool silc_hash_string_compare(void *key1, void *key2, void *user_context);
307 /****f* silcutil/SilcUtilAPI/silc_hash_id_compare
311 * bool silc_hash_id_compare(void *key1, void *key2, void *user_context);
315 * Compares two ID's. May be used as SilcHashTable comparison function.
316 * The Client ID's compares only the hash of the Client ID not any other
317 * part of the Client ID. Other ID's are fully compared.
320 bool silc_hash_id_compare(void *key1, void *key2, void *user_context);
322 /****f* silcutil/SilcUtilAPI/silc_hash_client_id_compare
326 * bool silc_hash_client_id_compare(void *key1, void *key2, void *user_context);
330 * Compare two Client ID's entirely and not just the hash from the ID.
333 bool silc_hash_client_id_compare(void *key1, void *key2, void *user_context);
335 /****f* silcutil/SilcUtilAPI/silc_hash_data_compare
339 * bool silc_hash_data_compare(void *key1, void *key2, void *user_context);
343 * Compares binary data. May be used as SilcHashTable comparison function.
346 bool silc_hash_data_compare(void *key1, void *key2, void *user_context);
348 /****f* silcutil/SilcUtilAPI/silc_hash_utf8_compare
352 * bool silc_hash_utf8_compare(void *key1, void *key2, void *user_context);
356 * Compares UTF-8 strings. Casefolded and NULL terminated strings are
357 * expected. May be used as SilcHashTable comparison function.
360 bool silc_hash_utf8_compare(void *key1, void *key2, void *user_context);
362 /****f* silcutil/SilcUtilAPI/silc_hash_public_key_compare
366 * bool silc_hash_public_key_compare(void *key1, void *key2,
367 * void *user_context);
371 * Compares two SILC Public keys. It may be used as SilcHashTable
372 * comparison function.
375 bool silc_hash_public_key_compare(void *key1, void *key2, void *user_context);
377 /****f* silcutil/SilcUtilAPI/silc_client_chmode
381 * char *silc_client_chmode(SilcUInt32 mode, const char *cipher,
386 * Parses mode mask and returns the mode as string.
389 char *silc_client_chmode(SilcUInt32 mode, const char *cipher,
392 /****f* silcutil/SilcUtilAPI/silc_client_chumode
396 * char *silc_client_chumode(SilcUInt32 mode);
400 * Parses channel user mode mask and returns te mode as string.
403 char *silc_client_chumode(SilcUInt32 mode);
405 /****f* silcutil/SilcUtilAPI/silc_client_chumode_char
409 * char *silc_client_chumode_char(SilcUInt32 mode);
413 * Parses channel user mode and returns it as special mode character.
416 char *silc_client_chumode_char(SilcUInt32 mode);
418 /****f* silcutil/SilcUtilAPI/silc_fingerprint
422 * char *silc_fingerprint(const unsigned char *data, SilcUInt32 data_len);
426 * Return a textual representation of the fingerprint in *data, the
427 * caller must free the returned string.
430 char *silc_fingerprint(const unsigned char *data, SilcUInt32 data_len);
432 /****f* silcutil/SilcUtilAPI/silc_string_is_ascii
436 * bool silc_string_is_ascii(const unsigned char *data,
437 * SilcUInt32 data_len);
441 * Return TRUE if the `data' is ASCII string.
444 bool silc_string_is_ascii(const unsigned char *data, SilcUInt32 data_len);
446 /****f* silcutil/SilcUtilAPI/silc_parse_version_string
450 * bool silc_parse_version_string(const char *version,
451 * SilcUInt32 *protocol_version,
452 * char **protocol_version_string,
453 * SilcUInt32 *software_version,
454 * char **software_version_string,
455 * char **vendor_version);
459 * Parses SILC protocol style version string.
462 bool silc_parse_version_string(const char *version,
463 SilcUInt32 *protocol_version,
464 char **protocol_version_string,
465 SilcUInt32 *software_version,
466 char **software_version_string,
467 char **vendor_version);
469 /****f* silcutil/SilcUtilAPI/silc_version_to_num
473 * SilcUInt32 silc_version_to_num(const char *version);
477 * Converts version string x.x into number representation.
480 SilcUInt32 silc_version_to_num(const char *version);
482 /****f* silcutil/SilcUtilAPI/silc_get_input
486 * char *silc_get_input(const char *prompt, bool echo_off);
490 * Displays input prompt on command line and takes input data from user.
493 char *silc_get_input(const char *prompt, bool echo_off);
495 /* System dependant prototypes */
497 /****f* silcutil/SilcUtilAPI/silc_gettimeofday
501 * int silc_gettimeofday(struct timeval *p);
505 * Return current time to struct timeval. This function is system
506 * dependant. Returns 0 on success and -1 on error.
509 int silc_gettimeofday(struct timeval *p);
511 /****f* silcutil/SilcUtilAPI/silc_compare_timeval
515 * bool silc_compare_timeval(struct timeval *smaller,
516 * struct timeval *bigger)
520 * Compare two timeval structures and return TRUE if the first
521 * time value is smaller than the second time value.
524 bool silc_compare_timeval(struct timeval *smaller,
525 struct timeval *bigger);
527 /****f* silcutil/SilcUtilAPI/silc_string_regexify
531 * char *silc_string_regexify(const char *string);
535 * Inspects the `string' for wildcards and returns regex string that can
536 * be used by the GNU regex library. A comma (`,') in the `string' means
537 * that the string is list.
539 * This function is system dependant.
542 char *silc_string_regexify(const char *string);
544 /****f* silcutil/SilcUtilAPI/silc_string_regex_match
548 * int silc_string_regex_match(const char *regex, const char *string);
552 * Matches the two strings and returns TRUE if the strings match.
554 * This function is system dependant.
557 int silc_string_regex_match(const char *regex, const char *string);
559 /****f* silcutil/SilcUtilAPI/silc_string_match
563 * int silc_string_match(const char *string1, const char *string2);
567 * Do regex match to the two strings `string1' and `string2'. If the
568 * `string2' matches the `string1' this returns TRUE.
570 * This function is system dependant.
573 int silc_string_match(const char *string1, const char *string2);
575 /****f* silcutil/SilcUtilAPI/silc_get_username
579 * char *silc_get_username();
583 * Returns the username of the user. If the global variable LOGNAME
584 * does not exists we will get the name from the passwd file. The
585 * caller must free the returned name.
587 * This function is system dependant.
590 char *silc_get_username();
592 /****f* silcutil/SilcUtilAPI/silc_get_real_name
596 * char *silc_get_real_name();
600 * Returns the real name of ther user from the passwd file. The
601 * caller must free the returned name.
603 * This function is system dependant.
606 char *silc_get_real_name();
608 /****f* silcutil/SilcUtilAPI/silc_get_mode_list
612 * bool silc_get_mode_list(SilcBuffer mode_list, SilcUInt32 mode_list_count,
613 * SilcUInt32 **list);
617 * Returns modes from list of 32 bit MSB first order values that are
618 * encoded one after the other in the `mode_list' into the `list'
619 * array. The caller must free the returned list. Return FALSE if
620 * there is error parsing the list.
623 bool silc_get_mode_list(SilcBuffer mode_list, SilcUInt32 mode_list_count,
626 /****f* silcutil/SilcUtilAPI/silc_get_status_message
630 * char *silc_get_status_message(SilcStatus status)
634 * Returns status message string
637 const char *silc_get_status_message(unsigned char status);
639 /****f* silcutil/SilcUtilAPI/silc_get_packet_name
643 * char *silc_get_packet_name(SilcPacketType type);
647 * Returns the name corresponding packet type `type'.
650 const char *silc_get_packet_name(unsigned char type);
652 /****f* silcutil/SilcUtilAPI/silc_get_command_name
656 * char *silc_get_command_name(SilcCommand command);
660 * Returns the name corresponding SILC command `command'.
663 const char *silc_get_command_name(unsigned char command);
665 #endif /* !SILCUTIL_H */