1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
|
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 8 -*-
*
* Copyright (C) 2003 Jorn Baayen <jorn@nl.linux.org>
* Copyright (C) 2003,2004 Colin Walters <walters@redhat.com>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* The Rhythmbox authors hereby grant permission for non-GPL compatible
* GStreamer plugins to be used and distributed together with GStreamer
* and Rhythmbox. This permission is above and beyond the permissions granted
* by the GPL license by which Rhythmbox is covered. If you modify this code
* you may extend this exception to your version of the code, but you are not
* obligated to do so. If you do not wish to do so, delete this exception
* statement from your version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
*/
#include "config.h"
#include <unistd.h>
#include <stdlib.h>
#include <string.h>
#include <glib/gi18n.h>
#include <gtk/gtk.h>
#include "rb-statusbar.h"
#include "rb-debug.h"
/**
* SECTION:rb-statusbar
* @short_description: status bar widget
*
* The status bar is displayed at the bottom of the main window. It consists of some
* status text and a progress bar.
*
* The status text usually comes from the selected source, and typically shows the number
* of songs, the total duration and the total file size. When a menu is open, however,
* the status text shows the description of the currently selected menu item.
*
* The progress bar shows progress information from a variety of sources. The source that
* is currently selected in the source list can provide progress information, such as buffering
* feedback, track transfer status, or progress for updating a song catalog. If the source
* does not provide status information and the database is busy (loading the database from disk,
* processing a query, etc.) the progress bar will be pulsed periodically.
*/
#define EPSILON (0.00001)
static void rb_statusbar_class_init (RBStatusbarClass *klass);
static void rb_statusbar_init (RBStatusbar *statusbar);
static void rb_statusbar_dispose (GObject *object);
static void rb_statusbar_finalize (GObject *object);
static void rb_statusbar_set_property (GObject *object,
guint prop_id,
const GValue *value,
GParamSpec *pspec);
static void rb_statusbar_get_property (GObject *object,
guint prop_id,
GValue *value,
GParamSpec *pspec);
static gboolean poll_status (RBStatusbar *status);
static void rb_statusbar_sync_status (RBStatusbar *status);
static void rb_statusbar_source_status_changed_cb (RBSource *source,
RBStatusbar *statusbar);
struct RBStatusbarPrivate
{
RBSource *selected_source;
RhythmDB *db;
GtkUIManager *ui_manager;
GtkWidget *progress;
double progress_fraction;
gboolean progress_changed;
gchar *progress_text;
gchar *loading_text;
guint status_poll_id;
};
enum
{
PROP_0,
PROP_DB,
PROP_UI_MANAGER,
PROP_SOURCE
};
G_DEFINE_TYPE (RBStatusbar, rb_statusbar, GTK_TYPE_STATUSBAR)
static void
rb_statusbar_class_init (RBStatusbarClass *klass)
{
GObjectClass *object_class = G_OBJECT_CLASS (klass);
object_class->dispose = rb_statusbar_dispose;
object_class->finalize = rb_statusbar_finalize;
object_class->set_property = rb_statusbar_set_property;
object_class->get_property = rb_statusbar_get_property;
/**
* RBStatusbar:db:
*
* The #RhythmDB instance
*/
g_object_class_install_property (object_class,
PROP_DB,
g_param_spec_object ("db",
"RhythmDB",
"RhythmDB object",
RHYTHMDB_TYPE,
G_PARAM_READWRITE));
/**
* RBStatusbar:source:
*
* The currently selected #RBSource
*/
g_object_class_install_property (object_class,
PROP_SOURCE,
g_param_spec_object ("source",
"RBSource",
"RBSource object",
RB_TYPE_SOURCE,
G_PARAM_READWRITE));
/**
* RBStatusbar:ui-manager:
*
* The #GtkUIManager instance
*/
g_object_class_install_property (object_class,
PROP_UI_MANAGER,
g_param_spec_object ("ui-manager",
"GtkUIManager",
"GtkUIManager object",
GTK_TYPE_UI_MANAGER,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
g_type_class_add_private (klass, sizeof (RBStatusbarPrivate));
}
static void
rb_statusbar_init (RBStatusbar *statusbar)
{
statusbar->priv = G_TYPE_INSTANCE_GET_PRIVATE (statusbar,
RB_TYPE_STATUSBAR,
RBStatusbarPrivate);
gtk_statusbar_set_has_resize_grip (GTK_STATUSBAR (statusbar), TRUE);
statusbar->priv->progress = gtk_progress_bar_new ();
gtk_widget_set_size_request (statusbar->priv->progress, -1, 10);
statusbar->priv->progress_fraction = 1.0;
statusbar->priv->loading_text = g_strdup (_("Loading..."));
gtk_progress_bar_set_fraction (GTK_PROGRESS_BAR (statusbar->priv->progress), 1.0);
gtk_widget_hide (statusbar->priv->progress);
gtk_box_pack_start (GTK_BOX (statusbar),
GTK_WIDGET (statusbar->priv->progress), FALSE, TRUE, 0);
}
static void
rb_statusbar_dispose (GObject *object)
{
RBStatusbar *statusbar;
g_return_if_fail (object != NULL);
g_return_if_fail (RB_IS_STATUSBAR (object));
statusbar = RB_STATUSBAR (object);
g_return_if_fail (statusbar->priv != NULL);
if (statusbar->priv->status_poll_id) {
g_source_remove (statusbar->priv->status_poll_id);
statusbar->priv->status_poll_id = 0;
}
if (statusbar->priv->db != NULL) {
g_object_unref (statusbar->priv->db);
statusbar->priv->db = NULL;
}
if (statusbar->priv->ui_manager != NULL) {
g_object_unref (statusbar->priv->ui_manager);
statusbar->priv->ui_manager = NULL;
}
if (statusbar->priv->selected_source != NULL) {
g_object_unref (statusbar->priv->selected_source);
statusbar->priv->selected_source = NULL;
}
G_OBJECT_CLASS (rb_statusbar_parent_class)->dispose (object);
}
static void
rb_statusbar_finalize (GObject *object)
{
RBStatusbar *statusbar;
g_return_if_fail (object != NULL);
g_return_if_fail (RB_IS_STATUSBAR (object));
statusbar = RB_STATUSBAR (object);
g_return_if_fail (statusbar->priv != NULL);
g_free (statusbar->priv->loading_text);
g_free (statusbar->priv->progress_text);
G_OBJECT_CLASS (rb_statusbar_parent_class)->finalize (object);
}
typedef struct {
GtkWidget *statusbar;
char *tooltip;
} StatusTip;
static void
statustip_free (StatusTip *tip)
{
g_object_unref (tip->statusbar);
g_free (tip->tooltip);
g_free (tip);
}
static void
set_statusbar_tooltip (GtkWidget *widget,
StatusTip *data)
{
guint context_id;
context_id = gtk_statusbar_get_context_id (GTK_STATUSBAR (data->statusbar),
"rb_statusbar_tooltip");
gtk_statusbar_push (GTK_STATUSBAR (data->statusbar),
context_id,
data->tooltip ? data->tooltip: "");
}
static void
unset_statusbar_tooltip (GtkWidget *widget,
GtkWidget *statusbar)
{
guint context_id;
context_id = gtk_statusbar_get_context_id (GTK_STATUSBAR (statusbar),
"rb_statusbar_tooltip");
gtk_statusbar_pop (GTK_STATUSBAR (statusbar), context_id);
}
static void
rb_statusbar_connect_ui_manager (RBStatusbar *statusbar,
GtkAction *action,
GtkWidget *proxy,
GtkUIManager *ui_manager)
{
char *tooltip;
if (! GTK_IS_MENU_ITEM (proxy))
return;
g_object_get (action, "tooltip", &tooltip, NULL);
if (tooltip) {
StatusTip *statustip;
statustip = g_new (StatusTip, 1);
statustip->statusbar = g_object_ref (statusbar);
statustip->tooltip = tooltip;
g_signal_connect_data (proxy, "select",
G_CALLBACK (set_statusbar_tooltip),
statustip, (GClosureNotify)statustip_free, 0);
g_signal_connect (proxy, "deselect",
G_CALLBACK (unset_statusbar_tooltip),
statusbar);
}
}
static void
rb_statusbar_set_property (GObject *object,
guint prop_id,
const GValue *value,
GParamSpec *pspec)
{
RBStatusbar *statusbar = RB_STATUSBAR (object);
switch (prop_id)
{
case PROP_DB:
statusbar->priv->db = g_value_get_object (value);
g_object_ref (statusbar->priv->db);
statusbar->priv->status_poll_id
= g_idle_add ((GSourceFunc) poll_status, statusbar);
break;
case PROP_SOURCE:
if (statusbar->priv->selected_source != NULL) {
g_signal_handlers_disconnect_by_func (G_OBJECT (statusbar->priv->selected_source),
G_CALLBACK (rb_statusbar_source_status_changed_cb),
statusbar);
g_object_unref (statusbar->priv->selected_source);
}
statusbar->priv->selected_source = g_value_get_object (value);
rb_debug ("selected source %p", statusbar->priv->selected_source);
g_object_ref (statusbar->priv->selected_source);
if (statusbar->priv->selected_source != NULL) {
g_signal_connect_object (G_OBJECT (statusbar->priv->selected_source),
"status-changed",
G_CALLBACK (rb_statusbar_source_status_changed_cb),
statusbar, 0);
}
rb_statusbar_sync_status (statusbar);
break;
case PROP_UI_MANAGER:
if (statusbar->priv->ui_manager) {
g_signal_handlers_disconnect_by_func (G_OBJECT (statusbar->priv->ui_manager),
G_CALLBACK (rb_statusbar_connect_ui_manager),
statusbar);
g_object_unref (statusbar->priv->ui_manager);
}
statusbar->priv->ui_manager = g_value_get_object (value);
g_object_ref (statusbar->priv->ui_manager);
g_signal_connect_object (statusbar->priv->ui_manager,
"connect-proxy",
G_CALLBACK (rb_statusbar_connect_ui_manager),
statusbar,
G_CONNECT_SWAPPED);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
static void
rb_statusbar_get_property (GObject *object,
guint prop_id,
GValue *value,
GParamSpec *pspec)
{
RBStatusbar *statusbar = RB_STATUSBAR (object);
switch (prop_id)
{
case PROP_DB:
g_value_set_object (value, statusbar->priv->db);
break;
case PROP_SOURCE:
g_value_set_object (value, statusbar->priv->selected_source);
break;
case PROP_UI_MANAGER:
g_value_set_object (value, statusbar->priv->ui_manager);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
/**
* rb_statusbar_set_source:
* @statusbar: the #RBStatusbar
* @source: the new selected #RBSource
*
* Updates the status bar for a newly selected source.
*/
void
rb_statusbar_set_source (RBStatusbar *statusbar, RBSource *source)
{
g_return_if_fail (RB_IS_STATUSBAR (statusbar));
g_return_if_fail (RB_IS_SOURCE (source));
g_object_set (G_OBJECT (statusbar),
"source", source,
NULL);
}
static gboolean
poll_status (RBStatusbar *status)
{
GDK_THREADS_ENTER ();
status->priv->status_poll_id = 0;
rb_statusbar_sync_status (status);
GDK_THREADS_LEAVE ();
return FALSE;
}
static void
rb_statusbar_sync_status (RBStatusbar *status)
{
gboolean changed = FALSE;
gboolean show_progress = TRUE;
char *status_text = NULL;
char *progress_text = NULL;
float progress = 999;
/*
* Behaviour of status bar:
* - use source's status text
* - use source's progress value and text, unless internal progress value is set,
* - if no source progress value or internal progress value and library is busy,
* pulse the progress bar
*/
/* library busy? */
if (rhythmdb_is_busy (status->priv->db)) {
/*g_free (status_text);
status_text = g_strdup (status->priv->loading_text); */
progress = -1.0f;
changed = TRUE;
}
/* get source details */
if (status->priv->selected_source) {
rb_source_get_status (status->priv->selected_source, &status_text, &progress_text, &progress);
rb_debug ("updating status with: '%s', '%s', %f",
status_text ? status_text : "", progress_text ? progress_text : "", progress);
}
/* internal progress bar moving? */
if (status->priv->progress_fraction < (1.0 - EPSILON) || status->priv->progress_changed) {
g_free (progress_text);
progress_text = g_strdup (status->priv->progress_text);
progress = status->priv->progress_fraction;
status->priv->progress_changed = FALSE;
show_progress = TRUE;
changed = TRUE;
}
/* set up the status text */
if (status_text) {
gtk_statusbar_pop (GTK_STATUSBAR (status), 0);
gtk_statusbar_push (GTK_STATUSBAR (status), 0, status_text);
g_free (status_text);
}
/* set up the progress bar */
if (progress > (1.0f - EPSILON) || !show_progress) {
gtk_widget_hide (status->priv->progress);
} else {
gtk_widget_show (status->priv->progress);
if (progress < (0.0f - EPSILON)) {
gtk_progress_bar_pulse (GTK_PROGRESS_BAR (status->priv->progress));
changed = TRUE;
} else {
gtk_progress_bar_set_fraction (GTK_PROGRESS_BAR (status->priv->progress),
progress);
}
gtk_progress_bar_set_text (GTK_PROGRESS_BAR (status->priv->progress),
progress_text);
}
g_free (progress_text);
if (status->priv->status_poll_id == 0 && changed)
status->priv->status_poll_id = g_timeout_add (250, (GSourceFunc) poll_status, status);
}
/**
* rb_statusbar_new:
* @db: the #RhythmDB instance
* @ui_manager: the #GtkUIManager
*
* Creates the status bar widget.
*
* Return value: the status bar widget
*/
RBStatusbar *
rb_statusbar_new (RhythmDB *db,
GtkUIManager *ui_manager)
{
RBStatusbar *statusbar = g_object_new (RB_TYPE_STATUSBAR,
"db", db,
"ui-manager", ui_manager,
NULL);
g_return_val_if_fail (statusbar->priv != NULL, NULL);
return statusbar;
}
/**
* rb_statusbar_set_progress:
* @statusbar: the #RBStatusbar
* @progress: progress fraction
* @text: text to display on the progress bar
*
* Updates the progress bar widget. If the progress fraction is less than zero,
* the progress bar is hidden.
*/
void
rb_statusbar_set_progress (RBStatusbar *statusbar, double progress, const char *text)
{
if (statusbar->priv->progress_text) {
g_free (statusbar->priv->progress_text);
statusbar->priv->progress_text = NULL;
}
if (progress > (0.0 - EPSILON)) {
statusbar->priv->progress_fraction = progress;
statusbar->priv->progress_changed = TRUE;
if (text)
statusbar->priv->progress_text = g_strdup (text);
} else {
/* trick sync_status into hiding it */
statusbar->priv->progress_fraction = 1.0;
statusbar->priv->progress_changed = FALSE;
}
rb_statusbar_sync_status (statusbar);
}
static void
rb_statusbar_source_status_changed_cb (RBSource *source, RBStatusbar *statusbar)
{
rb_debug ("source status changed");
if (statusbar->priv->status_poll_id == 0)
statusbar->priv->status_poll_id =
g_idle_add ((GSourceFunc) poll_status, statusbar);
}
|