source: branches/1.1x/gtk/torrent-cell-renderer.c @ 5493

Last change on this file since 5493 was 5493, checked in by charles, 14 years ago

(1.1x gtk) backport r5477 and the tr_torrentRates() fix from r5475

  • Property svn:keywords set to Date Rev Author Id
File size: 22.6 KB
Line 
1/*
2 * This file Copyright (C) 2007-2008 Charles Kerr <charles@rebelbase.com>
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: torrent-cell-renderer.c 5493 2008-04-02 23:43:54Z charles $
11 */
12
13#include "assert.h"
14#include <gtk/gtk.h>
15#include <gtk/gtkcellrenderertext.h>
16#include <gtk/gtkcellrendererprogress.h>
17#include <glib/gi18n.h>
18#include <libtransmission/transmission.h>
19#include "hig.h"
20#include "torrent-cell-renderer.h"
21#include "tr-torrent.h"
22#include "util.h"
23
24/* #define TEST_RTL */
25
26enum
27{
28    P_TORRENT = 1,
29    P_BAR_HEIGHT,
30    P_MINIMAL
31};
32
33#define DEFAULT_BAR_HEIGHT 12
34
35/***
36****
37***/
38
39static char*
40getProgressString( const tr_info * info, const tr_stat * torStat )
41{
42    const int isDone = torStat->leftUntilDone == 0;
43    const uint64_t haveTotal = torStat->haveUnchecked + torStat->haveValid;
44    const int isSeed = torStat->haveValid >= info->totalSize;
45    char buf1[32], buf2[32], buf3[32], buf4[32];
46    char * str;
47
48    if( !isDone )
49        str = g_strdup_printf(
50                  /* %1$s is how much we've got,
51                     %2$s is how much we'll have when done,
52                     %3$.2f%% is a percentage of the two */
53                  _("%1$s of %2$s (%3$.2f%%)"),
54                  tr_strlsize( buf1, haveTotal, sizeof(buf1) ),
55                  tr_strlsize( buf2, torStat->desiredSize, sizeof(buf2) ),
56                  torStat->percentDone * 100.0 );
57    else if( !isSeed )
58        str = g_strdup_printf(
59                  /* %1$s is how much we've got,
60                     %2$s is the torrent's total size,
61                     %3$.2f%% is a percentage of the two,
62                     %4$s is how much we've uploaded,
63                     %5$s is our upload-to-download ratio */
64                  _("%1$s of %2$s (%3$.2f%%), uploaded %4$s (Ratio: %5$s)"),
65                  tr_strlsize( buf1, haveTotal, sizeof(buf1) ),
66                  tr_strlsize( buf2, info->totalSize, sizeof(buf2) ),
67                  torStat->percentComplete * 100.0,
68                  tr_strlsize( buf3, torStat->uploadedEver, sizeof(buf3) ),
69                  tr_strlratio( buf4, torStat->ratio, sizeof( buf4 ) ) );
70    else
71        str = g_strdup_printf(
72                  /* %1$s is the torrent's total size,
73                     %2$s is how much we've uploaded,
74                     %3$s is our upload-to-download ratio */
75                  _("%1$s, uploaded %2$s (Ratio: %3$s)"),
76                  tr_strlsize( buf1, info->totalSize, sizeof(buf1) ),
77                  tr_strlsize( buf2, torStat->uploadedEver, sizeof(buf2) ),
78                  tr_strlratio( buf3, torStat->ratio, sizeof( buf3 ) ) );
79
80    /* add time when downloading */
81    if( torStat->status == TR_STATUS_DOWNLOAD )
82    {
83        const int eta = torStat->eta;
84        GString * gstr = g_string_new( str );
85        g_string_append( gstr, " - " );
86        if( eta < 0 )
87            g_string_append( gstr, _( "Stalled" ) );
88        else {
89            char timestr[128];
90            tr_strltime( timestr, eta, sizeof( timestr ) );
91            /* time remaining */
92            g_string_append_printf( gstr, _( "%s remaining" ), timestr );
93        }
94        g_free( str );
95        str = g_string_free( gstr, FALSE );
96    }
97
98    return str;
99}
100
101static char*
102getShortTransferString( const tr_stat * torStat, char * buf, size_t buflen )
103{
104    char downStr[32], upStr[32];
105    const int haveDown = torStat->peersSendingToUs > 0;
106    const int haveUp = torStat->peersGettingFromUs > 0;
107
108    if( haveDown )
109        tr_strlspeed( downStr, torStat->rateDownload, sizeof(downStr) );
110    if( haveUp )
111        tr_strlspeed( upStr, torStat->rateUpload, sizeof(upStr) );
112
113    if( haveDown && haveUp )
114        /* Translators: do not translate the "speed|" disambiguation prefix.
115           %1$s is the download speed
116           %2$s is the upload speed */
117        g_snprintf( buf, buflen, Q_( "speed|Down: %1$s, Up: %2$s"), downStr, upStr );
118    else if( haveDown )
119        /* download speed */
120        g_snprintf( buf, buflen, _( "Down: %s" ), downStr );
121    else if( haveUp )
122        /* upload speed */
123        g_snprintf( buf, buflen, _( "Up: %s" ), upStr );
124    else
125        /* the torrent isn't uploading or downloading */
126        g_strlcpy( buf, _( "Idle" ), buflen );
127
128    return buf;
129}
130
131static char*
132getShortStatusString( const tr_stat * torStat )
133{
134    GString * gstr = g_string_new( NULL );
135
136    switch( torStat->status )
137    {
138        case TR_STATUS_STOPPED:
139            g_string_assign( gstr, _("Paused") );
140            break;
141
142        case TR_STATUS_CHECK_WAIT:
143            g_string_assign( gstr, _( "Waiting to verify local data" ) );
144            break;
145
146        case TR_STATUS_CHECK:
147            g_string_append_printf( gstr, _("Verifying local data (%.1f%% tested)"),
148                                    torStat->recheckProgress * 100.0 );
149            break;
150
151        case TR_STATUS_DOWNLOAD:
152        case TR_STATUS_SEED:
153        case TR_STATUS_DONE: {
154            char buf[128];
155            if( torStat->status != TR_STATUS_DOWNLOAD ) {
156                tr_strlratio( buf, torStat->ratio, sizeof( buf ) );
157                g_string_append_printf( gstr, _("Ratio: %s" ), buf );
158                g_string_append( gstr, ", " );
159            }
160            getShortTransferString( torStat, buf, sizeof( buf ) );
161            g_string_append( gstr, buf );
162            break;
163        }
164
165        default:
166            break;
167    }
168
169    return g_string_free( gstr, FALSE );
170}
171
172static char*
173getStatusString( const tr_stat * torStat )
174{
175    const int isActive = torStat->status != TR_STATUS_STOPPED;
176    const int isChecking = torStat->status == TR_STATUS_CHECK
177                        || torStat->status == TR_STATUS_CHECK_WAIT;
178
179    GString * gstr = g_string_new( NULL );
180
181    if( torStat->error )
182    {
183        g_string_assign( gstr, torStat->errorString );
184    }
185    else switch( torStat->status )
186    {
187        case TR_STATUS_STOPPED:
188        case TR_STATUS_CHECK_WAIT:
189        case TR_STATUS_CHECK: {
190            char * pch = getShortStatusString( torStat );
191            g_string_assign( gstr, pch );
192            g_free( pch );
193            break;
194        }
195
196        case TR_STATUS_DOWNLOAD:
197            g_string_append_printf( gstr,
198                ngettext( "Downloading from %1$'d of %2$'d connected peer",
199                          "Downloading from %1$'d of %2$'d connected peers",
200                          torStat->peersConnected ),
201                torStat->peersSendingToUs,
202                torStat->peersConnected );
203            break;
204
205        case TR_STATUS_DONE:
206        case TR_STATUS_SEED:
207            g_string_append_printf( gstr,
208                ngettext( "Seeding to %1$'d of %2$'d connected peer",
209                          "Seeding to %1$'d of %2$'d connected peers",
210                          torStat->peersConnected ),
211                torStat->peersGettingFromUs,
212                torStat->peersConnected );
213            break;
214    }
215
216    if( isActive && !isChecking )
217    {
218        char buf[256];
219        getShortTransferString( torStat, buf, sizeof(buf) );
220        g_string_append_printf( gstr, " - %s", buf );
221    }
222
223    return g_string_free( gstr, FALSE );
224}
225
226/***
227****
228***/
229
230static GtkCellRendererClass * parent_class = NULL;
231
232struct TorrentCellRendererPrivate
233{
234    tr_torrent * tor;
235    GtkCellRenderer * text_renderer;
236    GtkCellRenderer * text_renderer_err;
237    GtkCellRenderer * progress_renderer;
238    int bar_height;
239    gboolean minimal;
240};
241
242static void
243torrent_cell_renderer_get_size( GtkCellRenderer  * cell,
244                                GtkWidget        * widget,
245                                GdkRectangle     * cell_area,
246                                gint             * x_offset,
247                                gint             * y_offset,
248                                gint             * width,
249                                gint             * height)
250{
251    TorrentCellRenderer * self = TORRENT_CELL_RENDERER( cell );
252
253    if( self && self->priv->tor )
254    {
255        const tr_torrent * tor = self->priv->tor;
256        const tr_info * info = tr_torrentInfo( tor );
257        const char * name = info->name;
258        const tr_stat * torStat = tr_torrentStatCached( (tr_torrent*)tor );
259        char * str;
260        int w=0, h=0;
261        struct TorrentCellRendererPrivate * p = self->priv;
262        GtkCellRenderer * text_renderer = torStat->error != 0
263            ? p->text_renderer_err
264            : p->text_renderer;
265
266        g_object_set( text_renderer, "ellipsize", PANGO_ELLIPSIZE_NONE, NULL );
267
268        /* above the progressbar */
269        if( p->minimal )
270        {
271            int w1, w2, h1, h2;
272            char * shortStatus = getShortStatusString( torStat );
273            g_object_set( text_renderer, "text", name, NULL );
274            gtk_cell_renderer_get_size( text_renderer,
275                                        widget, NULL, NULL, NULL, &w1, &h1 );
276            str = g_markup_printf_escaped( "<small>%s</small>", shortStatus );
277            g_object_set( text_renderer, "markup", str, NULL );
278            gtk_cell_renderer_get_size( text_renderer,
279                                        widget, NULL, NULL, NULL, &w2, &h2 );
280            h += MAX( h1, h2 );
281            w = MAX( w, w1+GUI_PAD_BIG+w2 );
282            g_free( str );
283            g_free( shortStatus );
284        }
285        else
286        {
287            int w1, h1;
288            char * progressString = getProgressString( info, torStat );
289            str = g_markup_printf_escaped( "<b>%s</b>\n<small>%s</small>",
290                                           name, progressString );
291            g_object_set( text_renderer, "markup", str, NULL );
292            gtk_cell_renderer_get_size( text_renderer,
293                                        widget, NULL, NULL, NULL, &w1, &h1 );
294            h += h1;
295            w = MAX( w, w1 );
296            g_free( str );
297            g_free( progressString );
298        }
299
300        /* below the progressbar */
301        if( !p->minimal )
302        {
303            int w1, h1;
304            char * statusString = getStatusString( torStat );
305            str = g_markup_printf_escaped( "<small>%s</small>", statusString );
306            g_object_set( text_renderer, "markup", str, NULL );
307            gtk_cell_renderer_get_size( text_renderer,
308                                        widget, NULL, NULL, NULL, &w1, &h1 );
309            h += h1;
310            w = MAX( w, w1 );
311            g_free( str );
312            g_free( statusString );
313        }
314
315        h += p->bar_height;
316
317        if( cell_area ) {
318            if( x_offset ) *x_offset = 0;
319            if( y_offset ) {
320                *y_offset = 0.5 * (cell_area->height - (h + (2 * cell->ypad)));
321                *y_offset = MAX( *y_offset, 0 );
322            }
323        }
324
325        *width = w + cell->xpad*2;
326        *height = h + cell->ypad*2;
327    }
328}
329
330static void
331torrent_cell_renderer_render( GtkCellRenderer      * cell,
332                              GdkDrawable          * window,
333                              GtkWidget            * widget,
334                              GdkRectangle         * background_area,
335                              GdkRectangle         * cell_area UNUSED,
336                              GdkRectangle         * expose_area UNUSED,
337                              GtkCellRendererState   flags)
338{
339    TorrentCellRenderer * self = TORRENT_CELL_RENDERER( cell );
340
341#ifdef TEST_RTL
342    GtkTextDirection real_dir = gtk_widget_get_direction( widget );
343    gtk_widget_set_direction( widget, GTK_TEXT_DIR_RTL );
344#endif
345
346    if( self && self->priv->tor )
347    {
348        const tr_torrent * tor = self->priv->tor;
349        const tr_info * info = tr_torrentInfo( tor );
350        const char * name = info->name;
351        const tr_stat * torStat = tr_torrentStatCached( (tr_torrent*)tor );
352        GdkRectangle my_bg;
353        GdkRectangle my_cell;
354        GdkRectangle my_expose;
355        int w, h;
356        struct TorrentCellRendererPrivate * p = self->priv;
357        GtkCellRenderer * text_renderer = torStat->error != 0
358            ? p->text_renderer_err
359            : p->text_renderer;
360        const gboolean isActive = torStat->status != TR_STATUS_STOPPED;
361
362        my_bg = *background_area; 
363        my_bg.x += cell->xpad;
364        my_bg.y += cell->ypad;
365        my_bg.width -= cell->xpad*2;
366        my_cell = my_expose = my_bg;
367
368        g_object_set( text_renderer, "sensitive", isActive, NULL );
369        g_object_set( p->progress_renderer, "sensitive", isActive, NULL );
370
371        /* above the progressbar */
372        if( !p->minimal )
373        {
374            char * progressString = getProgressString( info, torStat );
375            char * str = g_markup_printf_escaped( "<b>%s</b>\n<small>%s</small>",
376                                                  name, progressString );
377            g_object_set( text_renderer, "markup", str,
378                                            "ellipsize", PANGO_ELLIPSIZE_NONE,
379                                            NULL );
380            gtk_cell_renderer_get_size( text_renderer,
381                                        widget, NULL, NULL, NULL, &w, &h );
382            my_bg.height     = 
383            my_cell.height   =
384            my_expose.height = h;
385            g_object_set( text_renderer, "ellipsize", PANGO_ELLIPSIZE_END,
386                                            NULL );
387            gtk_cell_renderer_render( text_renderer,
388                                      window, widget,
389                                      &my_bg, &my_cell, &my_expose, flags );
390            my_bg.y += h;
391            my_cell.y += h;
392            my_expose.y += h;
393
394            g_free( str );
395            g_free( progressString );
396        }
397        else
398        {
399            char * statusStr = getShortStatusString( torStat );
400            char * str = g_markup_printf_escaped( "<small>%s</small>", statusStr );
401            int w1, w2, h1, h2, tmp_h;
402            GdkRectangle tmp_bg, tmp_cell, tmp_expose;
403
404            /* get the dimensions for the name */
405            g_object_set( text_renderer, "text", name,
406                                         "ellipsize", PANGO_ELLIPSIZE_NONE,
407                                         NULL );
408            gtk_cell_renderer_get_size( text_renderer,
409                                        widget, NULL, NULL, NULL, &w1, &h1 );
410
411            /* get the dimensions for the short status string */
412            g_object_set( text_renderer, "markup", str,
413                                         "ellipsize", PANGO_ELLIPSIZE_NONE,
414                                         NULL );
415            gtk_cell_renderer_get_size( text_renderer,
416                                        widget, NULL, NULL, NULL, &w2, &h2 );
417
418            tmp_h = MAX( h1, h2 );
419
420            /* short status */
421            tmp_bg.x = my_bg.width - w2;
422            tmp_bg.y = my_bg.y + (h2-h1)/2;
423            tmp_bg.width = w2;
424            tmp_bg.height = tmp_h;
425            tmp_expose = tmp_cell = tmp_bg;
426            g_object_set( text_renderer, "markup", str,
427                                         "ellipsize", PANGO_ELLIPSIZE_END,
428                                         NULL );
429            gtk_cell_renderer_render( text_renderer,
430                                      window, widget,
431                                      &tmp_bg, &tmp_cell, &tmp_expose, flags );
432
433            /* name */
434            tmp_bg.x = my_bg.x;
435            tmp_bg.width = my_bg.width - w2 - GUI_PAD_BIG;
436            tmp_expose = tmp_cell = tmp_bg;
437            g_object_set( text_renderer, "text", name,
438                                         "ellipsize", PANGO_ELLIPSIZE_END,
439                                         NULL );
440            gtk_cell_renderer_render( text_renderer,
441                                      window, widget,
442                                      &tmp_bg, &tmp_cell, &tmp_expose, flags );
443
444            my_bg.y = tmp_bg.y + tmp_bg.height;
445            my_cell.y = tmp_cell.y + tmp_cell.height;
446            my_expose.y += tmp_expose.y + tmp_cell.height;
447
448            g_free( str );
449            g_free( statusStr );
450        }
451
452        /* the progressbar */
453        my_cell.height = p->bar_height;
454        if( 1 )
455        {
456            const double havePercent = ( torStat->haveValid + torStat->haveUnchecked )
457                                                              / (double)info->totalSize;
458            g_object_set( p->progress_renderer, "value", (int)(havePercent*100.0), 
459                                                "text", "",
460                                                NULL );
461            gtk_cell_renderer_render( p->progress_renderer,
462                                      window, widget,
463                                      &my_cell, &my_cell, &my_cell, flags );
464 
465        }
466        my_bg.y     += my_cell.height;
467        my_cell.y   += my_cell.height;
468        my_expose.y += my_cell.height;
469
470        /* below progressbar */
471        if( !p->minimal )
472        {
473            char * statusString = getStatusString( torStat );
474            char * str = g_markup_printf_escaped( "<small>%s</small>",
475                                                  statusString );
476            g_object_set( text_renderer, "markup", str,
477                                         "ellipsize", PANGO_ELLIPSIZE_END,
478                                         NULL );
479            gtk_cell_renderer_get_size( text_renderer,
480                                        widget, NULL, NULL, NULL, &w, &h );
481            my_bg.height      =
482            my_cell.height    =
483            my_expose.height  = h;
484            gtk_cell_renderer_render( text_renderer,
485                                      window, widget,
486                                      &my_bg, &my_cell, &my_expose, flags );
487
488            g_free( str );
489            g_free( statusString );
490        }
491    }
492
493#ifdef TEST_RTL
494    gtk_widget_set_direction( widget, real_dir );
495#endif
496}
497
498static void
499torrent_cell_renderer_set_property( GObject      * object,
500                                    guint          property_id,
501                                    const GValue * v,
502                                    GParamSpec   * pspec)
503{
504    TorrentCellRenderer * self = TORRENT_CELL_RENDERER( object );
505    struct TorrentCellRendererPrivate * p = self->priv;
506
507    switch( property_id )
508    {
509        case P_TORRENT:     p->tor = g_value_get_pointer( v ); break;
510        case P_BAR_HEIGHT:  p->bar_height = g_value_get_int( v ); break;
511        case P_MINIMAL:     p->minimal  = g_value_get_boolean( v ); break;
512        default:
513            G_OBJECT_WARN_INVALID_PROPERTY_ID( object, property_id, pspec );
514            break;
515    }
516}
517
518static void
519torrent_cell_renderer_get_property( GObject      * object,
520                                    guint          property_id,
521                                    GValue       * v,
522                                    GParamSpec   * pspec)
523{
524    const TorrentCellRenderer * self = TORRENT_CELL_RENDERER( object );
525    struct TorrentCellRendererPrivate * p = self->priv;
526
527    switch( property_id )
528    {
529        case P_TORRENT:     g_value_set_pointer( v, p->tor ); break;
530        case P_BAR_HEIGHT:  g_value_set_int( v, p->bar_height ); break;
531        case P_MINIMAL:     g_value_set_boolean( v, p->minimal ); break;
532        default:
533            G_OBJECT_WARN_INVALID_PROPERTY_ID( object, property_id, pspec );
534            break;
535    }
536}
537
538static void
539torrent_cell_renderer_dispose( GObject * o )
540{
541    TorrentCellRenderer * r = TORRENT_CELL_RENDERER( o );
542    GObjectClass * parent;
543
544    if( r && r->priv )
545    {
546        g_object_unref( G_OBJECT( r->priv->text_renderer ) );
547        g_object_unref( G_OBJECT( r->priv->text_renderer_err ) );
548        g_object_unref( G_OBJECT( r->priv->progress_renderer ) );
549        r->priv = NULL;
550    }
551
552    parent = g_type_class_peek( g_type_parent( TORRENT_CELL_RENDERER_TYPE ) );
553    parent->dispose( o );
554}
555
556static void
557torrent_cell_renderer_class_init( TorrentCellRendererClass * klass )
558{
559    GObjectClass * gobject_class = G_OBJECT_CLASS( klass );
560    GtkCellRendererClass * cell_class = GTK_CELL_RENDERER_CLASS( klass );
561
562    g_type_class_add_private( klass,
563                              sizeof(struct TorrentCellRendererPrivate) );
564
565    parent_class = (GtkCellRendererClass*) g_type_class_peek_parent( klass );
566
567    cell_class->render = torrent_cell_renderer_render;
568    cell_class->get_size = torrent_cell_renderer_get_size;
569    gobject_class->set_property = torrent_cell_renderer_set_property;
570    gobject_class->get_property = torrent_cell_renderer_get_property;
571    gobject_class->dispose = torrent_cell_renderer_dispose;
572
573    g_object_class_install_property( gobject_class, P_TORRENT,
574        g_param_spec_pointer( "torrent", NULL, "tr_torrent*",
575                              G_PARAM_READWRITE ) );
576
577    g_object_class_install_property( gobject_class, P_BAR_HEIGHT,
578        g_param_spec_int( "bar-height", NULL, "Bar Height",
579                          1, INT_MAX, DEFAULT_BAR_HEIGHT, G_PARAM_READWRITE ) );
580
581    g_object_class_install_property( gobject_class, P_MINIMAL,
582        g_param_spec_boolean( "minimal", NULL, "Minimal Mode",
583                              FALSE, G_PARAM_READWRITE ) );
584}
585
586static void
587torrent_cell_renderer_init( GTypeInstance * instance, gpointer g_class UNUSED )
588{
589    TorrentCellRenderer * self = TORRENT_CELL_RENDERER( instance );
590    struct TorrentCellRendererPrivate * p;
591   
592    p = self->priv = G_TYPE_INSTANCE_GET_PRIVATE( self,
593                         TORRENT_CELL_RENDERER_TYPE,
594                         struct TorrentCellRendererPrivate );
595
596    p->tor = NULL;
597    p->text_renderer = gtk_cell_renderer_text_new( );
598    p->text_renderer_err = gtk_cell_renderer_text_new(  );
599    p->progress_renderer = gtk_cell_renderer_progress_new(  );
600    g_object_set( p->text_renderer_err, "foreground", "red", NULL );
601    tr_object_ref_sink( p->text_renderer );
602    tr_object_ref_sink( p->text_renderer_err );
603    tr_object_ref_sink( p->progress_renderer );
604
605    p->bar_height = DEFAULT_BAR_HEIGHT;
606}
607
608GType
609torrent_cell_renderer_get_type( void )
610{
611    static GType type = 0;
612
613    if( !type )
614    {
615        static const GTypeInfo info =
616        {
617            sizeof( TorrentCellRendererClass ),
618            NULL, /* base_init */
619            NULL, /* base_finalize */
620            (GClassInitFunc)torrent_cell_renderer_class_init,
621            NULL, /* class_finalize */
622            NULL, /* class_data */
623            sizeof( TorrentCellRenderer ),
624            0, /* n_preallocs */
625            (GInstanceInitFunc)torrent_cell_renderer_init,
626            NULL
627        };
628
629        type = g_type_register_static( GTK_TYPE_CELL_RENDERER,
630                                       "TorrentCellRenderer",
631                                       &info, (GTypeFlags)0 );
632    }
633
634    return type;
635}
636
637GtkCellRenderer *
638torrent_cell_renderer_new( void )
639{
640    return (GtkCellRenderer *) g_object_new( TORRENT_CELL_RENDERER_TYPE, NULL );
641}
Note: See TracBrowser for help on using the repository browser.