transmission/gtk/util.h

205 lines
5.7 KiB
C
Raw Normal View History

/*
2010-01-04 21:00:47 +00:00
* This file Copyright (C) 2008-2010 Mnemosyne LLC
*
* This file is licensed by the GPL version 2. Works owned by the
* Transmission project are granted a special exemption to clause 2(b)
2009-08-10 20:04:08 +00:00
* so that the bulk of its code can remain under the MIT license.
* This exemption does not extend to derived works not owned by
* the Transmission project.
*
* $Id$
*/
#ifndef GTR_UTIL_H
#define GTR_UTIL_H
2006-07-16 19:39:23 +00:00
#include <sys/types.h>
#include <glib.h>
#include <gtk/gtk.h>
2006-07-16 19:39:23 +00:00
#include <libtransmission/transmission.h>
extern const int mem_K;
extern const char * mem_K_str;
extern const char * mem_M_str;
extern const char * mem_G_str;
extern const char * mem_T_str;
extern const int disk_K;
extern const char * disk_K_str;
extern const char * disk_M_str;
extern const char * disk_G_str;
extern const char * disk_T_str;
extern const int speed_K;
extern const char * speed_K_str;
extern const char * speed_M_str;
extern const char * speed_G_str;
extern const char * speed_T_str;
/* portability wrapper around g_warn_if_fail() for older versions of glib */
#ifdef g_warn_if_fail
#define gtr_warn_if_fail(expr) g_warn_if_fail(expr)
#else
#define gtr_warn_if_fail(expr) do { if G_LIKELY (expr) ; else \
g_log (G_LOG_DOMAIN, G_LOG_LEVEL_WARNING, "%s:%d func(): %s: invariant failed: %s", \
__FILE__, __LINE__, G_STRFUNC, #expr ); } while(0)
#endif
2006-07-16 19:39:23 +00:00
/* macro to shut up "unused parameter" warnings */
2008-05-18 16:44:30 +00:00
#ifndef UNUSED
#define UNUSED G_GNUC_UNUSED
2008-05-18 16:44:30 +00:00
#endif
2006-07-16 19:39:23 +00:00
enum
{
GTR_UNICODE_UP,
GTR_UNICODE_DOWN,
GTR_UNICODE_INF
};
const char * gtr_get_unicode_string( int );
/* return a percent formatted string of either x.xx, xx.x or xxx */
char* tr_strlpercent( char * buf, double x, size_t buflen );
/* return a human-readable string for the size given in bytes. */
char* tr_strlsize( char * buf, guint64 size, size_t buflen );
/* return a human-readable string for the given ratio. */
char* tr_strlratio( char * buf, double ratio, size_t buflen );
/* return a human-readable string for the time given in seconds. */
char* tr_strltime( char * buf, int secs, size_t buflen );
2006-07-16 19:39:23 +00:00
/* similar to asctime, but is utf8-clean */
char* gtr_localtime( time_t time );
int gtr_compare_double( const double a, const double b, int decimal_places );
/***
****
***/
2006-07-16 19:39:23 +00:00
/* http://www.legaltorrents.com/some/announce/url --> legaltorrents.com */
char* gtr_get_host_from_url( const char * url );
gboolean gtr_is_supported_url( const char * str );
gboolean gtr_is_magnet_link( const char * str );
gboolean gtr_is_hex_hashcode( const char * str );
/* create a copy of a GSList of strings, this dups the actual strings too */
GSList * dupstrlist( GSList * list );
/* joins a GSList of strings into one string using an optional separator */
char * joinstrlist( GSList *list, char * sep );
2006-07-16 19:39:23 +00:00
/* free a GSList of strings */
void freestrlist( GSList *list );
2006-07-16 19:39:23 +00:00
/* decodes a string that has been urlencoded */
char * decode_uri( const char * uri );
2006-07-16 19:39:23 +00:00
/***
****
***/
2006-07-16 19:39:23 +00:00
typedef enum
{
GTR_LOCKFILE_SUCCESS = 0,
GTR_LOCKFILE_EOPEN,
GTR_LOCKFILE_ELOCK
}
gtr_lockfile_state_t;
gtr_lockfile_state_t gtr_lockfile( const char * filename );
/***
****
***/
void gtr_open_file( const char * path );
gboolean gtr_dbus_add_torrent( const char * filename );
2008-05-18 16:44:30 +00:00
gboolean gtr_dbus_present_window( void );
char* gtr_get_help_url( void );
2008-05-18 16:44:30 +00:00
/***
****
***/
/* backwards-compatible wrapper around g_mkdir_with_parents() */
int gtr_mkdir_with_parents( const char *name, int mode );
/* backwards-compatible wrapper around gdk_threads_add_timeout_seconds() */
guint gtr_timeout_add_seconds( guint seconds, GSourceFunc func, gpointer data );
/* backwards-compatible wrapper around gdk_threads_add_idle() */
void gtr_idle_add( GSourceFunc func, gpointer data );
/* backwards-compatible wrapper around gtk_orientable_set_orientation() */
void gtr_toolbar_set_orientation( GtkToolbar * tb, GtkOrientation orientation );
/* backwards-compatible wrapper around gtk_widget_set_tooltip_text() */
void gtr_widget_set_tooltip_text( GtkWidget * w, const char * tip );
2009-03-28 16:47:01 +00:00
/* backwards-compatible wrapper around gtk_widget_get_realized() */
gboolean gtr_widget_get_realized( GtkWidget * w );
/* backwards-compatible wrapper around g_object_ref_sink() */
gpointer gtr_object_ref_sink( gpointer object );
/***
****
***/
/* create a button with the specified mnemonic and stock icon */
GtkWidget * gtr_button_new_from_stock( const char * stock,
const char * mnemonic );
2006-07-16 19:39:23 +00:00
/***
****
***/
void gtr_priority_combo_set_value( GtkWidget * w, tr_priority_t );
tr_priority_t gtr_priority_combo_get_value( GtkWidget * w );
GtkWidget * gtr_priority_combo_new( void );
/***
****
***/
void gtr_unrecognized_url_dialog( GtkWidget * parent, const char * url );
void gtr_http_failure_dialog( GtkWidget * parent, const char * url, long response_code );
void addTorrentErrorDialog( GtkWidget * window_or_child,
int err,
const char * filename );
2006-07-16 19:39:23 +00:00
/* pop up the context menu if a user right-clicks.
if the row they right-click on isn't selected, select it. */
gboolean on_tree_view_button_pressed( GtkWidget * view,
GdkEventButton * event,
gpointer unused );
/* if the click didn't specify a row, clear the selection */
gboolean on_tree_view_button_released( GtkWidget * view,
GdkEventButton * event,
gpointer unused );
/* move a file to the trashcan if GIO is available; otherwise, delete it */
int gtr_file_trash_or_remove( const char * filename );
#endif /* GTR_UTIL_H */