source: branches/1.3x/gtk/torrent-cell-renderer.c @ 6758

Last change on this file since 6758 was 6758, checked in by charles, 13 years ago

(gtk 1.3x) backport #1259 (r6719): "GLib-GObject-WARNING : value "-100" of type gint' is invalid or out of range for property value' of type `gint'"

  • 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 6758 2008-09-16 16:49:10Z 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->sizeWhenDone, 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 == TR_ETA_NOT_AVAIL )
87            g_string_append( gstr, _( "Data not fully available" ) );
88         else if( eta == TR_ETA_UNKNOWN )
89            g_string_append( gstr, _( "Stalled" ) );
90        else {
91            char timestr[128];
92            tr_strltime( timestr, eta, sizeof( timestr ) );
93            /* time remaining */
94            g_string_append_printf( gstr, _( "%s remaining" ), timestr );
95        }
96        g_free( str );
97        str = g_string_free( gstr, FALSE );
98    }
99
100    return str;
101}
102
103static char*
104getShortTransferString( const tr_stat * torStat, char * buf, size_t buflen )
105{
106    char downStr[32], upStr[32];
107    const int haveDown = torStat->peersSendingToUs > 0;
108    const int haveUp = torStat->peersGettingFromUs > 0;
109
110    if( haveDown )
111        tr_strlspeed( downStr, torStat->rateDownload, sizeof(downStr) );
112    if( haveUp )
113        tr_strlspeed( upStr, torStat->rateUpload, sizeof(upStr) );
114
115    if( haveDown && haveUp )
116        /* Translators: do not translate the "speed|" disambiguation prefix.
117           %1$s is the download speed
118           %2$s is the upload speed */
119        g_snprintf( buf, buflen, Q_( "speed|Down: %1$s, Up: %2$s"), downStr, upStr );
120    else if( haveDown )
121        /* download speed */
122        g_snprintf( buf, buflen, _( "Down: %s" ), downStr );
123    else if( haveUp )
124        /* upload speed */
125        g_snprintf( buf, buflen, _( "Up: %s" ), upStr );
126    else
127        /* the torrent isn't uploading or downloading */
128        g_strlcpy( buf, _( "Idle" ), buflen );
129
130    return buf;
131}
132
133static char*
134getShortStatusString( const tr_stat * torStat )
135{
136    GString * gstr = g_string_new( NULL );
137
138    switch( torStat->status )
139    {
140        case TR_STATUS_STOPPED:
141            g_string_assign( gstr, _("Paused") );
142            break;
143
144        case TR_STATUS_CHECK_WAIT:
145            g_string_assign( gstr, _( "Waiting to verify local data" ) );
146            break;
147
148        case TR_STATUS_CHECK:
149            g_string_append_printf( gstr, _("Verifying local data (%.1f%% tested)"),
150                                    torStat->recheckProgress * 100.0 );
151            break;
152
153        case TR_STATUS_DOWNLOAD:
154        case TR_STATUS_SEED: {
155            char buf[128];
156            if( torStat->status != TR_STATUS_DOWNLOAD ) {
157                tr_strlratio( buf, torStat->ratio, sizeof( buf ) );
158                g_string_append_printf( gstr, _("Ratio: %s" ), buf );
159                g_string_append( gstr, ", " );
160            }
161            getShortTransferString( torStat, buf, sizeof( buf ) );
162            g_string_append( gstr, buf );
163            break;
164        }
165
166        default:
167            break;
168    }
169
170    return g_string_free( gstr, FALSE );
171}
172
173static char*
174getStatusString( const tr_stat * torStat )
175{
176    const int isActive = torStat->status != TR_STATUS_STOPPED;
177    const int isChecking = torStat->status == TR_STATUS_CHECK
178                        || torStat->status == TR_STATUS_CHECK_WAIT;
179
180    GString * gstr = g_string_new( NULL );
181
182    if( torStat->error )
183    {
184        g_string_assign( gstr, torStat->errorString );
185    }
186    else switch( torStat->status )
187    {
188        case TR_STATUS_STOPPED:
189        case TR_STATUS_CHECK_WAIT:
190        case TR_STATUS_CHECK: {
191            char * pch = getShortStatusString( torStat );
192            g_string_assign( gstr, pch );
193            g_free( pch );
194            break;
195        }
196
197        case TR_STATUS_DOWNLOAD:
198            g_string_append_printf( gstr,
199                ngettext( "Downloading from %1$'d of %2$'d connected peer",
200                          "Downloading from %1$'d of %2$'d connected peers",
201                          torStat->peersConnected ),
202                torStat->peersSendingToUs + torStat->webseedsSendingToUs,
203                torStat->peersConnected + torStat->webseedsSendingToUs );
204            break;
205
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 percent = MAX( 0.0, torStat->percentDone );
457            g_object_set( p->progress_renderer, "value", (int)(percent*100.0), 
458                                                "text", "",
459                                                NULL );
460            gtk_cell_renderer_render( p->progress_renderer,
461                                      window, widget,
462                                      &my_cell, &my_cell, &my_cell, flags );
463 
464        }
465        my_bg.y     += my_cell.height;
466        my_cell.y   += my_cell.height;
467        my_expose.y += my_cell.height;
468
469        /* below progressbar */
470        if( !p->minimal )
471        {
472            char * statusString = getStatusString( torStat );
473            char * str = g_markup_printf_escaped( "<small>%s</small>",
474                                                  statusString );
475            g_object_set( text_renderer, "markup", str,
476                                         "ellipsize", PANGO_ELLIPSIZE_END,
477                                         NULL );
478            gtk_cell_renderer_get_size( text_renderer,
479                                        widget, NULL, NULL, NULL, &w, &h );
480            my_bg.height      =
481            my_cell.height    =
482            my_expose.height  = h;
483            gtk_cell_renderer_render( text_renderer,
484                                      window, widget,
485                                      &my_bg, &my_cell, &my_expose, flags );
486
487            g_free( str );
488            g_free( statusString );
489        }
490    }
491
492#ifdef TEST_RTL
493    gtk_widget_set_direction( widget, real_dir );
494#endif
495}
496
497static void
498torrent_cell_renderer_set_property( GObject      * object,
499                                    guint          property_id,
500                                    const GValue * v,
501                                    GParamSpec   * pspec)
502{
503    TorrentCellRenderer * self = TORRENT_CELL_RENDERER( object );
504    struct TorrentCellRendererPrivate * p = self->priv;
505
506    switch( property_id )
507    {
508        case P_TORRENT:     p->tor = g_value_get_pointer( v ); break;
509        case P_BAR_HEIGHT:  p->bar_height = g_value_get_int( v ); break;
510        case P_MINIMAL:     p->minimal  = g_value_get_boolean( v ); break;
511        default:
512            G_OBJECT_WARN_INVALID_PROPERTY_ID( object, property_id, pspec );
513            break;
514    }
515}
516
517static void
518torrent_cell_renderer_get_property( GObject      * object,
519                                    guint          property_id,
520                                    GValue       * v,
521                                    GParamSpec   * pspec)
522{
523    const TorrentCellRenderer * self = TORRENT_CELL_RENDERER( object );
524    struct TorrentCellRendererPrivate * p = self->priv;
525
526    switch( property_id )
527    {
528        case P_TORRENT:     g_value_set_pointer( v, p->tor ); break;
529        case P_BAR_HEIGHT:  g_value_set_int( v, p->bar_height ); break;
530        case P_MINIMAL:     g_value_set_boolean( v, p->minimal ); break;
531        default:
532            G_OBJECT_WARN_INVALID_PROPERTY_ID( object, property_id, pspec );
533            break;
534    }
535}
536
537static void
538torrent_cell_renderer_dispose( GObject * o )
539{
540    TorrentCellRenderer * r = TORRENT_CELL_RENDERER( o );
541    GObjectClass * parent;
542
543    if( r && r->priv )
544    {
545        g_object_unref( G_OBJECT( r->priv->text_renderer ) );
546        g_object_unref( G_OBJECT( r->priv->text_renderer_err ) );
547        g_object_unref( G_OBJECT( r->priv->progress_renderer ) );
548        r->priv = NULL;
549    }
550
551    parent = g_type_class_peek( g_type_parent( TORRENT_CELL_RENDERER_TYPE ) );
552    parent->dispose( o );
553}
554
555static void
556torrent_cell_renderer_class_init( TorrentCellRendererClass * klass )
557{
558    GObjectClass * gobject_class = G_OBJECT_CLASS( klass );
559    GtkCellRendererClass * cell_class = GTK_CELL_RENDERER_CLASS( klass );
560
561    g_type_class_add_private( klass,
562                              sizeof(struct TorrentCellRendererPrivate) );
563
564    parent_class = (GtkCellRendererClass*) g_type_class_peek_parent( klass );
565
566    cell_class->render = torrent_cell_renderer_render;
567    cell_class->get_size = torrent_cell_renderer_get_size;
568    gobject_class->set_property = torrent_cell_renderer_set_property;
569    gobject_class->get_property = torrent_cell_renderer_get_property;
570    gobject_class->dispose = torrent_cell_renderer_dispose;
571
572    g_object_class_install_property( gobject_class, P_TORRENT,
573        g_param_spec_pointer( "torrent", NULL, "tr_torrent*",
574                              G_PARAM_READWRITE ) );
575
576    g_object_class_install_property( gobject_class, P_BAR_HEIGHT,
577        g_param_spec_int( "bar-height", NULL, "Bar Height",
578                          1, INT_MAX, DEFAULT_BAR_HEIGHT, G_PARAM_READWRITE ) );
579
580    g_object_class_install_property( gobject_class, P_MINIMAL,
581        g_param_spec_boolean( "minimal", NULL, "Minimal Mode",
582                              FALSE, G_PARAM_READWRITE ) );
583}
584
585static void
586torrent_cell_renderer_init( GTypeInstance * instance, gpointer g_class UNUSED )
587{
588    TorrentCellRenderer * self = TORRENT_CELL_RENDERER( instance );
589    struct TorrentCellRendererPrivate * p;
590   
591    p = self->priv = G_TYPE_INSTANCE_GET_PRIVATE( self,
592                         TORRENT_CELL_RENDERER_TYPE,
593                         struct TorrentCellRendererPrivate );
594
595    p->tor = NULL;
596    p->text_renderer = gtk_cell_renderer_text_new( );
597    p->text_renderer_err = gtk_cell_renderer_text_new(  );
598    p->progress_renderer = gtk_cell_renderer_progress_new(  );
599    g_object_set( p->text_renderer_err, "foreground", "red", NULL );
600    tr_object_ref_sink( p->text_renderer );
601    tr_object_ref_sink( p->text_renderer_err );
602    tr_object_ref_sink( p->progress_renderer );
603
604    p->bar_height = DEFAULT_BAR_HEIGHT;
605}
606
607GType
608torrent_cell_renderer_get_type( void )
609{
610    static GType type = 0;
611
612    if( !type )
613    {
614        static const GTypeInfo info =
615        {
616            sizeof( TorrentCellRendererClass ),
617            NULL, /* base_init */
618            NULL, /* base_finalize */
619            (GClassInitFunc)torrent_cell_renderer_class_init,
620            NULL, /* class_finalize */
621            NULL, /* class_data */
622            sizeof( TorrentCellRenderer ),
623            0, /* n_preallocs */
624            (GInstanceInitFunc)torrent_cell_renderer_init,
625            NULL
626        };
627
628        type = g_type_register_static( GTK_TYPE_CELL_RENDERER,
629                                       "TorrentCellRenderer",
630                                       &info, (GTypeFlags)0 );
631    }
632
633    return type;
634}
635
636GtkCellRenderer *
637torrent_cell_renderer_new( void )
638{
639    return (GtkCellRenderer *) g_object_new( TORRENT_CELL_RENDERER_TYPE, NULL );
640}
Note: See TracBrowser for help on using the repository browser.