source: trunk/libtransmission/utils.h @ 10819

Last change on this file since 10819 was 10819, checked in by charles, 12 years ago

(trunk libT) add an accessor for the formatter unit strings

  • Property svn:keywords set to Date Rev Author Id
File size: 18.5 KB
Line 
1/*
2 * This file Copyright (C) 2009-2010 Mnemosyne LLC
3 *
4 * This file is licensed by the GPL version 2.  Works owned by the
5 * Transmission project are granted a special exemption to clause 2(b)
6 * so that the bulk of its code can remain under the MIT license.
7 * This exemption does not extend to derived works not owned by
8 * the Transmission project.
9 *
10 * $Id: utils.h 10819 2010-06-22 13:34:46Z charles $
11 */
12
13#ifndef TR_UTILS_H
14#define TR_UTILS_H 1
15
16#include <inttypes.h>
17#include <stddef.h> /* size_t */
18#include <stdio.h> /* FILE* */
19#include <string.h> /* memcpy()* */
20#include <stdlib.h> /* malloc() */
21#include <time.h> /* time_t */
22
23#ifdef __cplusplus
24extern "C" {
25#endif
26
27/***
28****
29***/
30
31/**
32 * @addtogroup utils Utilities
33 * @{
34 */
35
36#ifndef FALSE
37 #define FALSE 0
38#endif
39
40#ifndef TRUE
41 #define TRUE 1
42#endif
43
44#ifndef UNUSED
45 #ifdef __GNUC__
46  #define UNUSED __attribute__ ( ( unused ) )
47 #else
48  #define UNUSED
49 #endif
50#endif
51
52#ifndef TR_GNUC_PRINTF
53 #ifdef __GNUC__
54  #define TR_GNUC_PRINTF( fmt, args ) __attribute__ ( ( format ( printf, fmt, args ) ) )
55 #else
56  #define TR_GNUC_PRINTF( fmt, args )
57 #endif
58#endif
59
60#ifndef TR_GNUC_NONNULL
61 #ifdef __GNUC__
62  #define TR_GNUC_NONNULL( ... ) __attribute__((nonnull (__VA_ARGS__)))
63 #else
64  #define TR_GNUC_NONNULL( ... )
65 #endif
66#endif
67
68#ifndef TR_GNUC_NULL_TERMINATED
69 #if __GNUC__ > 4 || ( __GNUC__ == 4 && __GNUC_MINOR__ >= 3 )
70  #define TR_GNUC_NULL_TERMINATED __attribute__ ( ( __sentinel__ ) )
71  #define TR_GNUC_HOT __attribute ( ( hot ) )
72 #else
73  #define TR_GNUC_NULL_TERMINATED
74  #define TR_GNUC_HOT
75 #endif
76#endif
77
78#if __GNUC__ > 2 || ( __GNUC__ == 2 && __GNUC_MINOR__ >= 96 )
79 #define TR_GNUC_PURE __attribute__ ( ( __pure__ ) )
80 #define TR_GNUC_MALLOC __attribute__ ( ( __malloc__ ) )
81#else
82 #define TR_GNUC_PURE
83 #define TR_GNUC_MALLOC
84#endif
85
86
87/***
88****
89***/
90
91#if !defined( _ )
92 #if defined( HAVE_LIBINTL_H ) && !defined( SYS_DARWIN )
93  #include <libintl.h>
94  #define _( a ) gettext ( a )
95 #else
96  #define _( a ) ( a )
97 #endif
98#endif
99
100/* #define DISABLE_GETTEXT */
101#ifndef DISABLE_GETTEXT
102 #if defined(WIN32) || defined(TR_EMBEDDED)
103   #define DISABLE_GETTEXT
104 #endif
105#endif
106#ifdef DISABLE_GETTEXT
107 const char * tr_strip_positional_args( const char * fmt );
108 #undef _
109 #define _( a ) tr_strip_positional_args( a )
110#endif
111
112/****
113*****
114****/
115
116void tr_msgInit( void );
117
118#define TR_MAX_MSG_LOG 10000
119
120extern int messageLevel;
121
122static inline tr_bool tr_msgLoggingIsActive( int level )
123{
124    return messageLevel >= level;
125}
126
127void tr_msg( const char * file, int line,
128             int level,
129             const char * torrent,
130             const char * fmt, ... ) TR_GNUC_PRINTF( 5, 6 );
131
132#define tr_nerr( n, ... ) \
133    do { \
134        if( tr_msgLoggingIsActive( TR_MSG_ERR ) ) \
135            tr_msg( __FILE__, __LINE__, TR_MSG_ERR, n, __VA_ARGS__ ); \
136    } while( 0 )
137
138#define tr_ninf( n, ... ) \
139    do { \
140        if( tr_msgLoggingIsActive( TR_MSG_INF) ) \
141            tr_msg( __FILE__, __LINE__, TR_MSG_INF, n, __VA_ARGS__ ); \
142    } while( 0 )
143
144#define tr_ndbg( n, ... ) \
145    do { \
146        if( tr_msgLoggingIsActive( TR_MSG_DBG) ) \
147            tr_msg( __FILE__, __LINE__, TR_MSG_DBG, n, __VA_ARGS__ ); \
148    } while( 0 )
149
150#define tr_torerr( tor, ... ) \
151    do { \
152        if( tr_msgLoggingIsActive( TR_MSG_ERR ) ) \
153            tr_msg( __FILE__, __LINE__, TR_MSG_ERR, tor->info.name, __VA_ARGS__ ); \
154    } while( 0 )
155
156#define tr_torinf( tor, ... ) \
157    do { \
158        if( tr_msgLoggingIsActive( TR_MSG_INF ) ) \
159            tr_msg( __FILE__, __LINE__, TR_MSG_INF, tor->info.name, __VA_ARGS__ ); \
160    } while( 0 )
161
162#define tr_tordbg( tor, ... ) \
163    do { \
164        if( tr_msgLoggingIsActive( TR_MSG_DBG ) ) \
165            tr_msg( __FILE__, __LINE__, TR_MSG_DBG, tor->info.name, __VA_ARGS__ ); \
166    } while( 0 )
167
168#define tr_err( ... ) \
169    do { \
170        if( tr_msgLoggingIsActive( TR_MSG_ERR ) ) \
171            tr_msg( __FILE__, __LINE__, TR_MSG_ERR, NULL, __VA_ARGS__ ); \
172    } while( 0 )
173
174#define tr_inf( ... ) \
175    do { \
176        if( tr_msgLoggingIsActive( TR_MSG_INF ) ) \
177            tr_msg( __FILE__, __LINE__, TR_MSG_INF, NULL, __VA_ARGS__ ); \
178    } while( 0 )
179
180#define tr_dbg( ... ) \
181    do { \
182        if( tr_msgLoggingIsActive( TR_MSG_DBG ) ) \
183            tr_msg( __FILE__, __LINE__, TR_MSG_DBG, NULL, __VA_ARGS__ ); \
184    } while( 0 )
185
186
187
188FILE*          tr_getLog( void );
189
190/** @brief return true if deep logging has been enabled by the user; false otherwise */
191tr_bool tr_deepLoggingIsActive( void );
192
193void           tr_deepLog( const char * file,
194                           int          line,
195                           const char * name,
196                           const char * fmt,
197                           ... ) TR_GNUC_PRINTF( 4, 5 ) TR_GNUC_NONNULL(1,4);
198
199/** @brief set the buffer with the current time formatted for deep logging. */
200char* tr_getLogTimeStr( char * buf, int buflen ) TR_GNUC_NONNULL(1);
201
202
203/**
204 * @brief Rich Salz's classic implementation of shell-style pattern matching for ?, \, [], and * characters.
205 * @return 1 if the pattern matches, 0 if it doesn't, or -1 if an error occured
206 */
207int tr_wildmat( const char * text, const char * pattern ) TR_GNUC_NONNULL(1,2);
208
209/** @brief Portability wrapper for basename() that uses the system implementation if available */
210char* tr_basename( const char * path ) TR_GNUC_MALLOC;
211
212/** @brief Portability wrapper for dirname() that uses the system implementation if available */
213char* tr_dirname( const char * path ) TR_GNUC_MALLOC;
214
215/**
216 * @brief Portability wrapper for mkdir()
217 *
218 * A portability wrapper around mkdir().
219 * On WIN32, the `permissions' argument is unused.
220 *
221 * @return zero on success, or -1 if an error occurred
222 * (in which case errno is set appropriately).
223 */
224int tr_mkdir( const char * path, int permissions ) TR_GNUC_NONNULL(1);
225
226/**
227 * Like mkdir, but makes parent directories as needed.
228 *
229 * @return zero on success, or -1 if an error occurred
230 * (in which case errno is set appropriately).
231 */
232int tr_mkdirp( const char * path, int permissions ) TR_GNUC_NONNULL(1);
233
234
235/**
236 * @brief Loads a file and returns its contents.
237 * On failure, NULL is returned and errno is set.
238 */
239uint8_t* tr_loadFile( const char * filename, size_t * size ) TR_GNUC_MALLOC
240                                                             TR_GNUC_NONNULL(1);
241
242
243/** @brief build a filename from a series of elements using the
244           platform's correct directory separator. */
245char* tr_buildPath( const char * first_element, ... ) TR_GNUC_NULL_TERMINATED
246                                                      TR_GNUC_MALLOC;
247
248struct event;
249
250/**
251 * @brief Convenience wrapper around timer_add() to have a timer wake up in a number of seconds and microseconds
252 * @param timer
253 * @param seconds
254 * @param microseconds
255 */
256void tr_timerAdd( struct event * timer, int seconds, int microseconds ) TR_GNUC_NONNULL(1);
257
258/**
259 * @brief Convenience wrapper around timer_add() to have a timer wake up in a number of milliseconds
260 * @param timer
261 * @param milliseconds
262 */
263void tr_timerAddMsec( struct event * timer, int milliseconds ) TR_GNUC_NONNULL(1);
264
265
266/** @brief return the current date in milliseconds */
267uint64_t tr_date( void );
268
269/** @brief sleep the specified number of milliseconds */
270void tr_wait_msec( uint64_t delay_milliseconds );
271
272/**
273 * @brief make a copy of 'str' whose non-utf8 content has been corrected or stripped
274 * @return a newly-allocated string that must be freed with tr_free()
275 * @param str the string to make a clean copy of
276 * @param len the length of the string to copy.  If -1, the entire string is used.
277 * @param err if an error occurs and err is non-NULL, it's set to TRUE.
278 */
279char* tr_utf8clean( const char * str, int len, tr_bool * err ) TR_GNUC_MALLOC;
280
281
282/***
283****
284***/
285
286/* Sometimes the system defines MAX/MIN, sometimes not.
287   In the latter case, define those here since we will use them */
288#ifndef MAX
289 #define MAX( a, b ) ( ( a ) > ( b ) ? ( a ) : ( b ) )
290#endif
291#ifndef MIN
292 #define MIN( a, b ) ( ( a ) > ( b ) ? ( b ) : ( a ) )
293#endif
294
295/***
296****
297***/
298
299/** @brief Portability wrapper around malloc() in which `0' is a safe argument */
300static inline void* tr_malloc( size_t size )
301{
302    return size ? malloc( size ) : NULL;
303}
304
305/** @brief Portability wrapper around calloc() in which `0' is a safe argument */
306static inline void* tr_malloc0( size_t size )
307{
308    return size ? calloc( 1, size ) : NULL;
309}
310
311/** @brief Portability wrapper around free() in which `NULL' is a safe argument */
312static inline void tr_free( void * p )
313{
314    if( p != NULL )
315        free( p );
316}
317
318/**
319 * @brief make a newly-allocated copy of a chunk of memory
320 * @param src the memory to copy
321 * @param byteCount the number of bytes to copy
322 * @return a newly-allocated copy of `src' that can be freed with tr_free()
323 */
324static inline void* tr_memdup( const void * src, int byteCount )
325{
326    return memcpy( tr_malloc( byteCount ), src, byteCount );
327}
328
329#define tr_new( struct_type, n_structs )           \
330    ( (struct_type *) tr_malloc ( ( (size_t) sizeof ( struct_type ) ) * ( ( size_t) ( n_structs ) ) ) )
331
332#define tr_new0( struct_type, n_structs )          \
333    ( (struct_type *) tr_malloc0 ( ( (size_t) sizeof ( struct_type ) ) * ( ( size_t) ( n_structs ) ) ) )
334
335#define tr_renew( struct_type, mem, n_structs )    \
336    ( (struct_type *) realloc ( ( mem ), ( (size_t) sizeof ( struct_type ) ) * ( ( size_t) ( n_structs ) ) ) )
337
338void* tr_valloc( size_t bufLen );
339
340/**
341 * @brief make a newly-allocated copy of a substring
342 * @param in is a void* so that callers can pass in both signed & unsigned without a cast
343 * @param len length of the substring to copy.  if a length less than zero is passed in, strlen( len ) is used
344 * @return a newly-allocated copy of `in' that can be freed with tr_free()
345 */
346char* tr_strndup( const void * in, int len ) TR_GNUC_MALLOC;
347
348/**
349 * @brief make a newly-allocated copy of a string
350 * @param in is a void* so that callers can pass in both signed & unsigned without a cast
351 * @return a newly-allocated copy of `in' that can be freed with tr_free()
352 */
353static inline char* tr_strdup( const void * in )
354{
355    return tr_strndup( in, in ? strlen( (const char *) in ) : 0 );
356}
357
358/** @brief similar to bsearch() but returns the index of the lower bound */
359int tr_lowerBound( const void * key,
360                   const void * base,
361                   size_t       nmemb,
362                   size_t       size,
363                   int       (* compar)(const void* key, const void* arrayMember),
364                   tr_bool    * exact_match ) TR_GNUC_HOT TR_GNUC_NONNULL(1,5,6);
365
366
367/**
368 * @brief sprintf() a string into a newly-allocated buffer large enough to hold it
369 * @return a newly-allocated string that can be freed with tr_free()
370 */
371char* tr_strdup_printf( const char * fmt, ... ) TR_GNUC_PRINTF( 1, 2 )
372                                                TR_GNUC_MALLOC;
373
374/**
375 * @brief Translate a block of bytes into base64
376 * @return a newly-allocated string that can be freed with tr_free()
377 */
378char* tr_base64_encode( const void * input,
379                        int          inlen,
380                        int        * outlen ) TR_GNUC_MALLOC;
381
382/**
383 * @brief Translate a block of bytes from base64 into raw form
384 * @return a newly-allocated string that can be freed with tr_free()
385 */
386char* tr_base64_decode( const void * input,
387                        int          inlen,
388                        int        * outlen ) TR_GNUC_MALLOC;
389
390/** @brief Portability wrapper for strlcpy() that uses the system implementation if available */
391size_t tr_strlcpy( char * dst, const void * src, size_t siz );
392
393/** @brief Portability wrapper for snprintf() that uses the system implementation if available */
394int tr_snprintf( char * buf, size_t buflen,
395                 const char * fmt, ... ) TR_GNUC_PRINTF( 3, 4 ) TR_GNUC_NONNULL(1,3);
396
397/** @brief Convenience wrapper around strerorr() guaranteed to not return NULL
398    @param errno */
399const char* tr_strerror( int );
400
401/** @brief strips leading and trailing whitspace from a string
402    @return the stripped string */
403char* tr_strstrip( char * str );
404
405/** @brief Returns true if the string ends with the specified case-insensitive suffix */
406tr_bool tr_str_has_suffix( const char *str, const char *suffix );
407
408
409/** @brief Portability wrapper for memmem() that uses the system implementation if available */
410const char* tr_memmem( const char * haystack, size_t haystack_len,
411                       const char * needle, size_t needle_len );
412
413/***
414****
415***/
416
417typedef void ( tr_set_func )( void * element, void * userData );
418
419/**
420 * @brief find the differences and commonalities in two sorted sets
421 * @param a the first set
422 * @param aCount the number of elements in the set 'a'
423 * @param b the second set
424 * @param bCount the number of elements in the set 'b'
425 * @param compare the sorting method for both sets
426 * @param elementSize the sizeof the element in the two sorted sets
427 * @param in_a called for items in set 'a' but not set 'b'
428 * @param in_b called for items in set 'b' but not set 'a'
429 * @param in_both called for items that are in both sets
430 * @param userData user data passed along to in_a, in_b, and in_both
431 */
432void tr_set_compare( const void * a, size_t aCount,
433                     const void * b, size_t bCount,
434                     int compare( const void * a, const void * b ),
435                     size_t elementSize,
436                     tr_set_func in_a_cb,
437                     tr_set_func in_b_cb,
438                     tr_set_func in_both_cb,
439                     void * userData );
440
441void tr_sha1_to_hex( char * out, const uint8_t * sha1 ) TR_GNUC_NONNULL(1,2);
442
443void tr_hex_to_sha1( uint8_t * out, const char * hex ) TR_GNUC_NONNULL(1,2);
444
445/** @brief convenience function to determine if an address is an IP address (IPv4 or IPv6) */
446tr_bool tr_addressIsIP( const char * address );
447
448/** @brief return TRUE if the url is a http or https url that Transmission understands */
449tr_bool tr_urlIsValidTracker( const char * url ) TR_GNUC_NONNULL(1);
450
451/** @brief return TRUE if the url is a [ http, https, ftp, ftps ] url that Transmission understands */
452tr_bool tr_urlIsValid( const char * url ) TR_GNUC_NONNULL(1);
453
454/** @brief parse a URL into its component parts
455    @return zero on success or an error number if an error occurred */
456int  tr_urlParse( const char * url,
457                  int          url_len,
458                  char      ** setme_scheme,
459                  char      ** setme_host,
460                  int        * setme_port,
461                  char      ** setme_path ) TR_GNUC_NONNULL(1);
462
463
464/** @brief return TR_RATIO_NA, TR_RATIO_INF, or a number in [0..1]
465    @return TR_RATIO_NA, TR_RATIO_INF, or a number in [0..1] */
466double tr_getRatio( double numerator, double denominator );
467
468/**
469 * @brief Given a string like "1-4" or "1-4,6,9,14-51", this returns a
470 *        newly-allocated array of all the integers in the set.
471 * @return a newly-allocated array of integers that must be freed with tr_free(),
472 *         or NULL if a fragment of the string can't be parsed.
473 *
474 * For example, "5-8" will return [ 5, 6, 7, 8 ] and setmeCount will be 4.
475 */
476int* tr_parseNumberRange( const char * str,
477                          int str_len,
478                          int * setmeCount ) TR_GNUC_MALLOC TR_GNUC_NONNULL(1);
479
480
481/**
482 * @brief truncate a double value at a given number of decimal places.
483 *
484 * this can be used to prevent a printf() call from rounding up:
485 * call with the decimal_places argument equal to the number of
486 * decimal places in the printf()'s precision:
487 *
488 * - printf("%.2f%%",           99.999    ) ==> "100.00%"
489 *
490 * - printf("%.2f%%", tr_truncd(99.999, 2)) ==>  "99.99%"
491 *             ^                        ^
492 *             |   These should match   |
493 *             +------------------------+
494 */
495double tr_truncd( double x, int decimal_places );
496
497/**
498 * @param buf the buffer to write the string to
499 * @param buflef buf's size
500 * @param ratio the ratio to convert to a string
501 * @param the string represntation of "infinity"
502 */
503char* tr_strratio( char * buf, size_t buflen, double ratio, const char * infinity ) TR_GNUC_NONNULL(1,4);
504
505/** @brief Portability wrapper for localtime_r() that uses the system implementation if available */
506struct tm * tr_localtime_r( const time_t *_clock, struct tm *_result );
507
508
509/**
510 * @brief move a file
511 * @return 0 on success; otherwise, return -1 and set errno
512 */
513int tr_moveFile( const char * oldpath, const char * newpath,
514                 tr_bool * renamed ) TR_GNUC_NONNULL(1,2);
515
516/** @brief convenience function to remove an item from an array */
517static inline void tr_removeElementFromArray( void   * array,
518                                              int      index_to_remove,
519                                              size_t   sizeof_element,
520                                              size_t   nmemb )
521{
522    char * a = (char*) array;
523
524    memmove( a + sizeof_element * index_to_remove,
525             a + sizeof_element * ( index_to_remove  + 1 ),
526             sizeof_element * ( --nmemb - index_to_remove ) );
527}
528
529/***
530****
531***/
532
533/** @brief Private libtransmission variable that's visible only for inlining in tr_time() */
534extern time_t transmission_now;
535
536/**
537 * @brief very inexpensive form of time(NULL)
538 * @return the current epoch time in seconds
539 *
540 * This function returns a second counter that is updated once per second.
541 * If something blocks the libtransmission thread for more than a second,
542 * that counter may be thrown off, so this function is not guaranteed
543 * to always be accurate.  However, it is *much* faster when 100% accuracy
544 * isn't needed
545 */
546static inline time_t tr_time( void ) { return transmission_now; }
547
548/** @brief Private libtransmission function to update tr_time()'s counter */
549static inline void tr_timeUpdate( time_t now ) { transmission_now = now; }
550
551/** @brief Portability wrapper for realpath() that uses the system implementation if available */
552char* tr_realpath( const char *path, char * resolved_path );
553
554/***
555****
556***/
557
558/* example: tr_formatter_size_init( 1024, _("B"), _("KiB"), _("MiB"), _("GiB") ); */
559
560void tr_formatter_size_init( double kilo, const char * b, const char * kb,
561                                          const char * mb, const char * gb );
562
563void tr_formatter_speed_init( double kilo, const char * b, const char * kb,
564                                           const char * mb, const char * gb );
565
566/* format a size into a user-readable string. */
567char* tr_formatter_size( char * buf, uint64_t bytes, size_t buflen );
568
569/* format a speed into a user-readable string. */
570char* tr_formatter_speed( char * buf, uint64_t bytes_per_second, size_t buflen );
571
572enum { TR_FMT_B, TR_FMT_KB, TR_FMT_MB, TR_FMT_GB };
573/* return the human-readable unit initialized by tr_formatter_size_init() */
574const char* tr_formatter_size_units( int size );
575/* return the human-readable unit initialized by tr_formatter_speed_init() */
576const char* tr_formatter_speed_units( int size );
577
578/***
579****
580***/
581
582#ifdef __cplusplus
583}
584#endif
585
586/** @} */
587
588#endif
Note: See TracBrowser for help on using the repository browser.