source: trunk/gtk/torrent-cell-renderer.c @ 5313

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

more string work before the freeze. (1) use %'d to get thousands' grouping in end-user strings (2) follow HiG capitalization, quotation guidelines (3) fold a few more strings

  • Property svn:keywords set to Date Rev Author Id
File size: 22.7 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 5313 2008-03-19 20:07:27Z 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    int xpad, ypad;
253    g_object_get( self, "xpad", &xpad, "ypad", &ypad, NULL );
254
255    if( self && self->priv->tor )
256    {
257        const tr_torrent * tor = self->priv->tor;
258        const tr_info * info = tr_torrentInfo( tor );
259        const char * name = info->name;
260        const tr_stat * torStat = tr_torrentStatCached( (tr_torrent*)tor );
261        char * str;
262        int w=0, h=0;
263        struct TorrentCellRendererPrivate * p = self->priv;
264        GtkCellRenderer * text_renderer = torStat->error != 0
265            ? p->text_renderer_err
266            : p->text_renderer;
267
268        g_object_set( text_renderer, "ellipsize", PANGO_ELLIPSIZE_NONE, NULL );
269
270        /* above the progressbar */
271        if( p->minimal )
272        {
273            int w1, w2, h1, h2;
274            char * shortStatus = getShortStatusString( torStat );
275            g_object_set( text_renderer, "text", name, NULL );
276            gtk_cell_renderer_get_size( text_renderer,
277                                        widget, NULL, NULL, NULL, &w1, &h1 );
278            str = g_markup_printf_escaped( "<small>%s</small>", shortStatus );
279            g_object_set( text_renderer, "markup", str, NULL );
280            gtk_cell_renderer_get_size( text_renderer,
281                                        widget, NULL, NULL, NULL, &w2, &h2 );
282            h += MAX( h1, h2 );
283            w = MAX( w, w1+GUI_PAD_BIG+w2 );
284            g_free( str );
285            g_free( shortStatus );
286        }
287        else
288        {
289            int w1, h1;
290            char * progressString = getProgressString( info, torStat );
291            str = g_markup_printf_escaped( "<b>%s</b>\n<small>%s</small>",
292                                           name, progressString );
293            g_object_set( text_renderer, "markup", str, NULL );
294            gtk_cell_renderer_get_size( text_renderer,
295                                        widget, NULL, NULL, NULL, &w1, &h1 );
296            h += h1;
297            w = MAX( w, w1 );
298            g_free( str );
299            g_free( progressString );
300        }
301
302        /* below the progressbar */
303        if( !p->minimal )
304        {
305            int w1, h1;
306            char * statusString = getStatusString( torStat );
307            str = g_markup_printf_escaped( "<small>%s</small>", statusString );
308            g_object_set( text_renderer, "markup", str, NULL );
309            gtk_cell_renderer_get_size( text_renderer,
310                                        widget, NULL, NULL, NULL, &w1, &h1 );
311            h += h1;
312            w = MAX( w, w1 );
313            g_free( str );
314            g_free( statusString );
315        }
316
317        h += p->bar_height;
318
319        if( cell_area ) {
320            if( x_offset ) *x_offset = 0;
321            if( y_offset ) {
322                *y_offset = 0.5 * (cell_area->height - (h + (2 * ypad)));
323                *y_offset = MAX( *y_offset, 0 );
324            }
325        }
326
327        *width = w + xpad*2;
328        *height = h + ypad*2;
329    }
330}
331
332static void
333torrent_cell_renderer_render( GtkCellRenderer      * cell,
334                              GdkDrawable          * window,
335                              GtkWidget            * widget,
336                              GdkRectangle         * background_area,
337                              GdkRectangle         * cell_area UNUSED,
338                              GdkRectangle         * expose_area UNUSED,
339                              GtkCellRendererState   flags)
340{
341    TorrentCellRenderer * self = TORRENT_CELL_RENDERER( cell );
342
343#ifdef TEST_RTL
344    GtkTextDirection real_dir = gtk_widget_get_direction( widget );
345    gtk_widget_set_direction( widget, GTK_TEXT_DIR_RTL );
346#endif
347
348    if( self && self->priv->tor )
349    {
350        const tr_torrent * tor = self->priv->tor;
351        const tr_info * info = tr_torrentInfo( tor );
352        const char * name = info->name;
353        const tr_stat * torStat = tr_torrentStatCached( (tr_torrent*)tor );
354        GdkRectangle my_bg;
355        GdkRectangle my_cell;
356        GdkRectangle my_expose;
357        int xpad, ypad;
358        int w, h;
359        struct TorrentCellRendererPrivate * p = self->priv;
360        GtkCellRenderer * text_renderer = torStat->error != 0
361            ? p->text_renderer_err
362            : p->text_renderer;
363        const gboolean isActive = torStat->status != TR_STATUS_STOPPED;
364
365        g_object_get( self, "xpad", &xpad, "ypad", &ypad, NULL );
366
367        my_bg = *background_area; 
368        my_bg.x += xpad;
369        my_bg.y += ypad;
370        my_bg.width -= xpad*2;
371        my_cell = my_expose = my_bg;
372
373        g_object_set( text_renderer, "sensitive", isActive, NULL );
374        g_object_set( p->progress_renderer, "sensitive", isActive, NULL );
375
376        /* above the progressbar */
377        if( !p->minimal )
378        {
379            char * progressString = getProgressString( info, torStat );
380            char * str = g_markup_printf_escaped( "<b>%s</b>\n<small>%s</small>",
381                                                  name, progressString );
382            g_object_set( text_renderer, "markup", str,
383                                            "ellipsize", PANGO_ELLIPSIZE_NONE,
384                                            NULL );
385            gtk_cell_renderer_get_size( text_renderer,
386                                        widget, NULL, NULL, NULL, &w, &h );
387            my_bg.height     = 
388            my_cell.height   =
389            my_expose.height = h;
390            g_object_set( text_renderer, "ellipsize", PANGO_ELLIPSIZE_END,
391                                            NULL );
392            gtk_cell_renderer_render( text_renderer,
393                                      window, widget,
394                                      &my_bg, &my_cell, &my_expose, flags );
395            my_bg.y += h;
396            my_cell.y += h;
397            my_expose.y += h;
398
399            g_free( str );
400            g_free( progressString );
401        }
402        else
403        {
404            char * statusStr = getShortStatusString( torStat );
405            char * str = g_markup_printf_escaped( "<small>%s</small>", statusStr );
406            int w1, w2, h1, h2, tmp_h;
407            GdkRectangle tmp_bg, tmp_cell, tmp_expose;
408
409            /* get the dimensions for the name */
410            g_object_set( text_renderer, "text", name,
411                                         "ellipsize", PANGO_ELLIPSIZE_NONE,
412                                         NULL );
413            gtk_cell_renderer_get_size( text_renderer,
414                                        widget, NULL, NULL, NULL, &w1, &h1 );
415
416            /* get the dimensions for the short status string */
417            g_object_set( text_renderer, "markup", str,
418                                         "ellipsize", PANGO_ELLIPSIZE_NONE,
419                                         NULL );
420            gtk_cell_renderer_get_size( text_renderer,
421                                        widget, NULL, NULL, NULL, &w2, &h2 );
422
423            tmp_h = MAX( h1, h2 );
424
425            /* short status */
426            tmp_bg.x = my_bg.width - w2;
427            tmp_bg.y = my_bg.y + (h2-h1)/2;
428            tmp_bg.width = w2;
429            tmp_bg.height = tmp_h;
430            tmp_expose = tmp_cell = tmp_bg;
431            g_object_set( text_renderer, "markup", str,
432                                         "ellipsize", PANGO_ELLIPSIZE_END,
433                                         NULL );
434            gtk_cell_renderer_render( text_renderer,
435                                      window, widget,
436                                      &tmp_bg, &tmp_cell, &tmp_expose, flags );
437
438            /* name */
439            tmp_bg.x = my_bg.x;
440            tmp_bg.width = my_bg.width - w2 - GUI_PAD_BIG;
441            tmp_expose = tmp_cell = tmp_bg;
442            g_object_set( text_renderer, "text", name,
443                                         "ellipsize", PANGO_ELLIPSIZE_END,
444                                         NULL );
445            gtk_cell_renderer_render( text_renderer,
446                                      window, widget,
447                                      &tmp_bg, &tmp_cell, &tmp_expose, flags );
448
449            my_bg.y = tmp_bg.y + tmp_bg.height;
450            my_cell.y = tmp_cell.y + tmp_cell.height;
451            my_expose.y += tmp_expose.y + tmp_cell.height;
452
453            g_free( str );
454            g_free( statusStr );
455        }
456
457        /* the progressbar */
458        my_cell.height = p->bar_height;
459        if( 1 )
460        {
461            const double havePercent = ( torStat->haveValid + torStat->haveUnchecked )
462                                                              / (double)info->totalSize;
463            g_object_set( p->progress_renderer, "value", (int)(havePercent*100.0), 
464                                                "text", "",
465                                                NULL );
466            gtk_cell_renderer_render( p->progress_renderer,
467                                      window, widget,
468                                      &my_cell, &my_cell, &my_cell, flags );
469 
470        }
471        my_bg.y     += my_cell.height;
472        my_cell.y   += my_cell.height;
473        my_expose.y += my_cell.height;
474
475        /* below progressbar */
476        if( !p->minimal )
477        {
478            char * statusString = getStatusString( torStat );
479            char * str = g_markup_printf_escaped( "<small>%s</small>",
480                                                  statusString );
481            g_object_set( text_renderer, "markup", str,
482                                         "ellipsize", PANGO_ELLIPSIZE_END,
483                                         NULL );
484            gtk_cell_renderer_get_size( text_renderer,
485                                        widget, NULL, NULL, NULL, &w, &h );
486            my_bg.height      =
487            my_cell.height    =
488            my_expose.height  = h;
489            gtk_cell_renderer_render( text_renderer,
490                                      window, widget,
491                                      &my_bg, &my_cell, &my_expose, flags );
492
493            g_free( str );
494            g_free( statusString );
495        }
496    }
497
498#ifdef TEST_RTL
499    gtk_widget_set_direction( widget, real_dir );
500#endif
501}
502
503static void
504torrent_cell_renderer_set_property( GObject      * object,
505                                    guint          property_id,
506                                    const GValue * v,
507                                    GParamSpec   * pspec)
508{
509    TorrentCellRenderer * self = TORRENT_CELL_RENDERER( object );
510    struct TorrentCellRendererPrivate * p = self->priv;
511
512    switch( property_id )
513    {
514        case P_TORRENT:     p->tor = g_value_get_pointer( v ); break;
515        case P_BAR_HEIGHT:  p->bar_height = g_value_get_int( v ); break;
516        case P_MINIMAL:     p->minimal  = g_value_get_boolean( v ); break;
517        default:
518            G_OBJECT_WARN_INVALID_PROPERTY_ID( object, property_id, pspec );
519            break;
520    }
521}
522
523static void
524torrent_cell_renderer_get_property( GObject      * object,
525                                    guint          property_id,
526                                    GValue       * v,
527                                    GParamSpec   * pspec)
528{
529    const TorrentCellRenderer * self = TORRENT_CELL_RENDERER( object );
530    struct TorrentCellRendererPrivate * p = self->priv;
531
532    switch( property_id )
533    {
534        case P_TORRENT:     g_value_set_pointer( v, p->tor ); break;
535        case P_BAR_HEIGHT:  g_value_set_int( v, p->bar_height ); break;
536        case P_MINIMAL:     g_value_set_boolean( v, p->minimal ); break;
537        default:
538            G_OBJECT_WARN_INVALID_PROPERTY_ID( object, property_id, pspec );
539            break;
540    }
541}
542
543static void
544torrent_cell_renderer_dispose( GObject * o )
545{
546    TorrentCellRenderer * r = TORRENT_CELL_RENDERER( o );
547    GObjectClass * parent;
548
549    if( r && r->priv )
550    {
551        g_object_unref( G_OBJECT( r->priv->text_renderer ) );
552        g_object_unref( G_OBJECT( r->priv->text_renderer_err ) );
553        g_object_unref( G_OBJECT( r->priv->progress_renderer ) );
554        r->priv = NULL;
555    }
556
557    parent = g_type_class_peek( g_type_parent( TORRENT_CELL_RENDERER_TYPE ) );
558    parent->dispose( o );
559}
560
561static void
562torrent_cell_renderer_class_init( TorrentCellRendererClass * klass )
563{
564    GObjectClass * gobject_class = G_OBJECT_CLASS( klass );
565    GtkCellRendererClass * cell_class = GTK_CELL_RENDERER_CLASS( klass );
566
567    g_type_class_add_private( klass,
568                              sizeof(struct TorrentCellRendererPrivate) );
569
570    parent_class = (GtkCellRendererClass*) g_type_class_peek_parent( klass );
571
572    cell_class->render = torrent_cell_renderer_render;
573    cell_class->get_size = torrent_cell_renderer_get_size;
574    gobject_class->set_property = torrent_cell_renderer_set_property;
575    gobject_class->get_property = torrent_cell_renderer_get_property;
576    gobject_class->dispose = torrent_cell_renderer_dispose;
577
578    g_object_class_install_property( gobject_class, P_TORRENT,
579        g_param_spec_pointer( "torrent", NULL, "tr_torrent*",
580                              G_PARAM_READWRITE ) );
581
582    g_object_class_install_property( gobject_class, P_BAR_HEIGHT,
583        g_param_spec_int( "bar-height", NULL, "Bar Height",
584                          1, INT_MAX, DEFAULT_BAR_HEIGHT, G_PARAM_READWRITE ) );
585
586    g_object_class_install_property( gobject_class, P_MINIMAL,
587        g_param_spec_boolean( "minimal", NULL, "Minimal Mode",
588                              FALSE, G_PARAM_READWRITE ) );
589}
590
591static void
592torrent_cell_renderer_init( GTypeInstance * instance, gpointer g_class UNUSED )
593{
594    TorrentCellRenderer * self = TORRENT_CELL_RENDERER( instance );
595    struct TorrentCellRendererPrivate * p;
596   
597    p = self->priv = G_TYPE_INSTANCE_GET_PRIVATE( self,
598                         TORRENT_CELL_RENDERER_TYPE,
599                         struct TorrentCellRendererPrivate );
600
601    p->tor = NULL;
602    p->text_renderer = gtk_cell_renderer_text_new( );
603    p->text_renderer_err = gtk_cell_renderer_text_new(  );
604    p->progress_renderer = gtk_cell_renderer_progress_new(  );
605    g_object_set( p->text_renderer_err, "foreground", "red", NULL );
606    tr_object_ref_sink( p->text_renderer );
607    tr_object_ref_sink( p->text_renderer_err );
608    tr_object_ref_sink( p->progress_renderer );
609
610    p->bar_height = DEFAULT_BAR_HEIGHT;
611}
612
613GType
614torrent_cell_renderer_get_type( void )
615{
616    static GType type = 0;
617
618    if( !type )
619    {
620        static const GTypeInfo info =
621        {
622            sizeof( TorrentCellRendererClass ),
623            NULL, /* base_init */
624            NULL, /* base_finalize */
625            (GClassInitFunc)torrent_cell_renderer_class_init,
626            NULL, /* class_finalize */
627            NULL, /* class_data */
628            sizeof( TorrentCellRenderer ),
629            0, /* n_preallocs */
630            (GInstanceInitFunc)torrent_cell_renderer_init,
631            NULL
632        };
633
634        type = g_type_register_static( GTK_TYPE_CELL_RENDERER,
635                                       "TorrentCellRenderer",
636                                       &info, (GTypeFlags)0 );
637    }
638
639    return type;
640}
641
642GtkCellRenderer *
643torrent_cell_renderer_new( void )
644{
645    return (GtkCellRenderer *) g_object_new( TORRENT_CELL_RENDERER_TYPE, NULL );
646}
Note: See TracBrowser for help on using the repository browser.