Simplify 'cpufreq' plugin using lxpanel_button_new_for_icon().
[lxde/lxpanel.git] / plugins / dclock.c
CommitLineData
239cb032 1/**
8c9c4b55 2 * Copyright (c) 2006-2014 LxDE Developers, see the file AUTHORS for details.
a99ee9e1
JH
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software Foundation,
16 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
17 */
a52c2257 18
8c9c4b55 19#include "plugin.h"
6febec6d 20#include "misc.h"
8c9c4b55
AG
21
22#include <libfm/fm-gtk.h>
23
a52c2257
HJYP
24#include <time.h>
25#include <sys/time.h>
26#include <sys/types.h>
27#include <stdio.h>
28#include <stdlib.h>
29#include <string.h>
e7cb732b 30#include <glib/gi18n.h>
a52c2257 31
a52c2257
HJYP
32#include "dbg.h"
33
a52c2257
HJYP
34#define DEFAULT_TIP_FORMAT "%A %x"
35#define DEFAULT_CLOCK_FORMAT "%R"
36
2918994e 37/* Private context for digital clock plugin. */
a52c2257 38typedef struct {
8c9c4b55 39 GtkWidget * plugin; /* Back pointer to plugin */
a7bd16a4 40 LXPanel * panel;
8c9c4b55 41 config_setting_t *settings;
2918994e 42 GtkWidget * clock_label; /* Label containing clock value */
ec9471fe 43 GtkWidget * clock_icon; /* Icon when icon_only */
2918994e 44 GtkWidget * calendar_window; /* Calendar window, if it is being displayed */
45 char * clock_format; /* Format string for clock value */
46 char * tooltip_format; /* Format string for tooltip value */
47 char * action; /* Command to execute on a click */
48 gboolean bold; /* True if bold font */
ec9471fe 49 gboolean icon_only; /* True if icon only (no clock value) */
907deaab 50 gboolean center_text;
2918994e 51 guint timer; /* Timer for periodic update */
3855f25d
MJ
52 enum {
53 AWAITING_FIRST_CHANGE, /* Experimenting to determine interval, waiting for first change */
54 AWAITING_SECOND_CHANGE, /* Experimenting to determine interval, waiting for second change */
55 ONE_SECOND_INTERVAL, /* Determined that one second interval is necessary */
56 ONE_MINUTE_INTERVAL /* Determined that one minute interval is sufficient */
0bcf9045 57 } expiration_interval;
3855f25d
MJ
58 int experiment_count; /* Count of experiments that have been done to determine interval */
59 char * prev_clock_value; /* Previous value of clock */
60 char * prev_tooltip_value; /* Previous value of tooltip */
2918994e 61} DClockPlugin;
62
2918994e 63static gboolean dclock_update_display(DClockPlugin * dc);
8c9c4b55
AG
64static void dclock_destructor(gpointer user_data);
65static gboolean dclock_apply_configuration(gpointer user_data);
2918994e 66
4ec924bc
MJ
67/* Handler for "map" signal on popup window. */
68static void dclock_popup_map(GtkWidget * widget, DClockPlugin * dc)
69{
8c9c4b55 70 lxpanel_plugin_adjust_popup_position(widget, dc->plugin);
4ec924bc
MJ
71}
72
2918994e 73/* Display a window containing the standard calendar widget. */
4ec924bc 74static GtkWidget * dclock_create_calendar(DClockPlugin * dc)
ba99d2f1 75{
2918994e 76 /* Create a new window. */
77 GtkWidget * win = gtk_window_new(GTK_WINDOW_TOPLEVEL);
7414a73f 78 gtk_window_set_default_size(GTK_WINDOW(win), 180, 180);
ba99d2f1 79 gtk_window_set_decorated(GTK_WINDOW(win), FALSE);
2918994e 80 gtk_window_set_resizable(GTK_WINDOW(win), FALSE);
bb9aef6f 81 gtk_container_set_border_width(GTK_CONTAINER(win), 5);
ba99d2f1
FC
82 gtk_window_set_skip_taskbar_hint(GTK_WINDOW(win), TRUE);
83 gtk_window_set_skip_pager_hint(GTK_WINDOW(win), TRUE);
91f2b215 84 gtk_window_set_type_hint(GTK_WINDOW(win), GDK_WINDOW_TYPE_HINT_UTILITY);
2918994e 85 gtk_window_stick(GTK_WINDOW(win));
86
87 /* Create a vertical box as a child of the window. */
88 GtkWidget * box = gtk_vbox_new(FALSE, 0);
f8465762 89 gtk_container_add(GTK_CONTAINER(win), GTK_WIDGET(box));
ba99d2f1 90
2918994e 91 /* Create a standard calendar widget as a child of the vertical box. */
92 GtkWidget * calendar = gtk_calendar_new();
09fa171b 93 gtk_calendar_set_display_options(
2918994e 94 GTK_CALENDAR(calendar),
95 GTK_CALENDAR_SHOW_WEEK_NUMBERS | GTK_CALENDAR_SHOW_DAY_NAMES | GTK_CALENDAR_SHOW_HEADING);
09fa171b 96 gtk_box_pack_start(GTK_BOX(box), calendar, TRUE, TRUE, 0);
ba99d2f1 97
4ec924bc
MJ
98 /* Connect signals. */
99 g_signal_connect(G_OBJECT(win), "map", G_CALLBACK(dclock_popup_map), dc);
100
2918994e 101 /* Return the widget. */
9dd114c4 102 return win;
ba99d2f1
FC
103}
104
2918994e 105/* Handler for "button-press-event" event from main widget. */
a7bd16a4 106static gboolean dclock_button_press_event(GtkWidget * widget, GdkEventButton * evt, LXPanel * panel)
a52c2257 107{
1639d6b3 108 DClockPlugin * dc = lxpanel_plugin_get_data(widget);
e56f2fdd 109
2918994e 110 /* If an action is set, execute it. */
111 if (dc->action != NULL)
8c9c4b55 112 fm_launch_command_simple(NULL, NULL, 0, dc->action, NULL);
2918994e 113
114 /* If no action is set, toggle the presentation of the calendar. */
115 else
116 {
117 if (dc->calendar_window == NULL)
118 {
4ec924bc 119 dc->calendar_window = dclock_create_calendar(dc);
2918994e 120 gtk_widget_show_all(dc->calendar_window);
121 }
122 else
123 {
124 gtk_widget_destroy(dc->calendar_window);
125 dc->calendar_window = NULL;
ba99d2f1 126 }
0e300420 127 }
2918994e 128 return TRUE;
a52c2257
HJYP
129}
130
3855f25d 131/* Set the timer. */
76a590ef 132static void dclock_timer_set(DClockPlugin * dc, struct timeval *current_time)
3855f25d 133{
3855f25d 134 int milliseconds = 1000;
8575ae11
MJ
135
136 /* Get current time to millisecond resolution. */
76a590ef 137 if (gettimeofday(current_time, NULL) >= 0)
3855f25d
MJ
138 {
139 /* Compute number of milliseconds until next second boundary. */
76a590ef 140 milliseconds = 1000 - (current_time->tv_usec / 1000);
3855f25d
MJ
141
142 /* If the expiration interval is the minute boundary,
143 * add number of milliseconds after that until next minute boundary. */
144 if (dc->expiration_interval == ONE_MINUTE_INTERVAL)
145 {
76a590ef 146 time_t seconds = 60 - (current_time->tv_sec - (current_time->tv_sec / 60) * 60);
3855f25d
MJ
147 milliseconds += seconds * 1000;
148 }
149 }
8575ae11
MJ
150
151 /* Be defensive, and set the timer. */
152 if (milliseconds <= 0)
153 milliseconds = 1000;
3855f25d
MJ
154 dc->timer = g_timeout_add(milliseconds, (GSourceFunc) dclock_update_display, (gpointer) dc);
155}
156
2918994e 157/* Periodic timer callback.
158 * Also used during initialization and configuration change to do a redraw. */
159static gboolean dclock_update_display(DClockPlugin * dc)
a52c2257 160{
2918994e 161 /* Determine the current time. */
76a590ef 162 struct timeval now;
251cfd3e
AG
163 struct tm * current_time;
164
165 if (g_source_is_destroyed(g_main_current_source()))
166 return FALSE;
167
76a590ef
AG
168 dclock_timer_set(dc, &now);
169 current_time = localtime(&now.tv_sec);
2918994e 170
3855f25d
MJ
171 /* Determine the content of the clock label and tooltip. */
172 char clock_value[64];
173 char tooltip_value[64];
c96c6d68
MJ
174 clock_value[0] = '\0';
175 if (dc->clock_format != NULL)
176 strftime(clock_value, sizeof(clock_value), dc->clock_format, current_time);
177 tooltip_value[0] = '\0';
178 if (dc->tooltip_format != NULL)
179 strftime(tooltip_value, sizeof(tooltip_value), dc->tooltip_format, current_time);
2de71c90 180
176fb687 181 /* When we write the clock value, it causes the panel to do a full relayout.
3855f25d
MJ
182 * Since this function may be called too often while the timing experiment is underway,
183 * we take the trouble to check if the string actually changed first. */
ec9471fe 184 if (( ! dc->icon_only)
3855f25d 185 && ((dc->prev_clock_value == NULL) || (strcmp(dc->prev_clock_value, clock_value) != 0)))
176fb687 186 {
5cf3b374 187 /* Convert "\n" escapes in the user's format string to newline characters. */
188 char * newlines_converted = NULL;
3855f25d 189 if (strstr(clock_value, "\\n") != NULL)
5cf3b374 190 {
3855f25d 191 newlines_converted = g_strdup(clock_value); /* Just to get enough space for the converted result */
5cf3b374 192 char * p;
193 char * q;
3855f25d 194 for (p = clock_value, q = newlines_converted; *p != '\0'; p += 1)
5cf3b374 195 {
196 if ((p[0] == '\\') && (p[1] == 'n'))
197 {
198 *q++ = '\n';
199 p += 1;
200 }
201 else
202 *q++ = *p;
203 }
204 *q = '\0';
205 }
206
3855f25d 207 gchar * utf8 = g_locale_to_utf8(((newlines_converted != NULL) ? newlines_converted : clock_value), -1, NULL, NULL, NULL);
2918994e 208 if (utf8 != NULL)
209 {
a7bd16a4 210 lxpanel_draw_label_text(dc->panel, dc->clock_label, utf8, dc->bold, 1, TRUE);
2918994e 211 g_free(utf8);
212 }
5cf3b374 213 g_free(newlines_converted);
176fb687 214 }
a52c2257 215
2918994e 216 /* Determine the content of the tooltip. */
3855f25d 217 gchar * utf8 = g_locale_to_utf8(tooltip_value, -1, NULL, NULL, NULL);
2918994e 218 if (utf8 != NULL)
219 {
8c9c4b55 220 gtk_widget_set_tooltip_text(dc->plugin, utf8);
2918994e 221 g_free(utf8);
a52c2257 222 }
3855f25d
MJ
223
224 /* Conduct an experiment to see how often the value changes.
225 * Use this to decide whether we update the value every second or every minute.
226 * We need to account for the possibility that the experiment is being run when we cross a minute boundary. */
227 if (dc->expiration_interval < ONE_SECOND_INTERVAL)
228 {
229 if (dc->prev_clock_value == NULL)
230 {
231 /* Initiate the experiment. */
232 dc->prev_clock_value = g_strdup(clock_value);
233 dc->prev_tooltip_value = g_strdup(tooltip_value);
234 }
235 else
236 {
8575ae11 237 if (((dc->icon_only) || (strcmp(dc->prev_clock_value, clock_value) == 0))
3855f25d
MJ
238 && (strcmp(dc->prev_tooltip_value, tooltip_value) == 0))
239 {
240 dc->experiment_count += 1;
241 if (dc->experiment_count > 3)
242 {
243 /* No change within 3 seconds. Assume change no more often than once per minute. */
116746cf 244 dc->expiration_interval = ONE_MINUTE_INTERVAL;
3855f25d
MJ
245 g_free(dc->prev_clock_value);
246 g_free(dc->prev_tooltip_value);
247 dc->prev_clock_value = NULL;
248 dc->prev_tooltip_value = NULL;
249 }
250 }
251 else if (dc->expiration_interval == AWAITING_FIRST_CHANGE)
252 {
253 /* We have a change at the beginning of the experiment, but we do not know when the next change might occur.
254 * Continue the experiment for 3 more seconds. */
255 dc->expiration_interval = AWAITING_SECOND_CHANGE;
256 dc->experiment_count = 0;
257 g_free(dc->prev_clock_value);
258 g_free(dc->prev_tooltip_value);
259 dc->prev_clock_value = g_strdup(clock_value);
260 dc->prev_tooltip_value = g_strdup(tooltip_value);
261 }
262 else
263 {
264 /* We have a second change. End the experiment. */
2efc857c 265 dc->expiration_interval = ((dc->experiment_count > 3) ? ONE_MINUTE_INTERVAL : ONE_SECOND_INTERVAL);
3855f25d
MJ
266 g_free(dc->prev_clock_value);
267 g_free(dc->prev_tooltip_value);
268 dc->prev_clock_value = NULL;
269 dc->prev_tooltip_value = NULL;
270 }
271 }
272 }
273
274 /* Reset the timer and return. */
3855f25d 275 return FALSE;
a52c2257
HJYP
276}
277
2918994e 278/* Plugin constructor. */
a7bd16a4 279static GtkWidget *dclock_constructor(LXPanel *panel, config_setting_t *settings)
a52c2257 280{
2918994e 281 /* Allocate and initialize plugin context and set into Plugin private data pointer. */
282 DClockPlugin * dc = g_new0(DClockPlugin, 1);
8c9c4b55
AG
283 GtkWidget * p;
284 const char *str;
285 int tmp_int;
8ccd023a 286
2918994e 287 /* Load parameters from the configuration file. */
8c9c4b55
AG
288 if (config_setting_lookup_string(settings, "ClockFmt", &str))
289 dc->clock_format = g_strdup(str);
290 if (config_setting_lookup_string(settings, "TooltipFmt", &str))
291 dc->tooltip_format = g_strdup(str);
292 if (config_setting_lookup_string(settings, "Action", &str))
293 dc->action = g_strdup(str);
294 if (config_setting_lookup_int(settings, "BoldFont", &tmp_int))
295 dc->bold = tmp_int != 0;
296 if (config_setting_lookup_int(settings, "IconOnly", &tmp_int))
297 dc->icon_only = tmp_int != 0;
298 if (config_setting_lookup_int(settings, "CenterText", &tmp_int))
299 dc->center_text = tmp_int != 0;
300
301 /* Save construction pointers */
302 dc->panel = panel;
303 dc->settings = settings;
9dd114c4 304
2918994e 305 /* Allocate top level widget and set into Plugin widget pointer. */
8c9c4b55
AG
306 dc->plugin = p = gtk_event_box_new();
307 lxpanel_plugin_set_data(p, dc, dclock_destructor);
faa2693d 308
ec9471fe 309 /* Allocate a horizontal box as the child of the top level. */
907deaab 310 GtkWidget * hbox = gtk_hbox_new(TRUE, 0);
8c9c4b55 311 gtk_container_add(GTK_CONTAINER(p), hbox);
ec9471fe 312 gtk_widget_show(hbox);
313
314 /* Create a label and an image as children of the horizontal box.
315 * Only one of these is visible at a time, controlled by user preference. */
2918994e 316 dc->clock_label = gtk_label_new(NULL);
317 gtk_misc_set_alignment(GTK_MISC(dc->clock_label), 0.5, 0.5);
318 gtk_misc_set_padding(GTK_MISC(dc->clock_label), 4, 0);
ec9471fe 319 gtk_container_add(GTK_CONTAINER(hbox), dc->clock_label);
6febec6d 320 dc->clock_icon = lxpanel_image_new_for_icon(panel, "clock", -1, NULL);
ec9471fe 321 gtk_container_add(GTK_CONTAINER(hbox), dc->clock_icon);
239cb032 322
3855f25d
MJ
323 /* Initialize the clock display. */
324 if (dc->clock_format == NULL)
8e26d524 325 dc->clock_format = g_strdup(_(DEFAULT_CLOCK_FORMAT));
3855f25d 326 if (dc->tooltip_format == NULL)
8e26d524 327 dc->tooltip_format = g_strdup(_(DEFAULT_TIP_FORMAT));
2918994e 328 dclock_apply_configuration(p);
4542c20d 329
2918994e 330 /* Show the widget and return. */
8c9c4b55 331 return p;
a52c2257
HJYP
332}
333
2918994e 334/* Plugin destructor. */
8c9c4b55 335static void dclock_destructor(gpointer user_data)
a52c2257 336{
8c9c4b55 337 DClockPlugin * dc = user_data;
15c1aa11 338
2918994e 339 /* Remove the timer. */
340 if (dc->timer != 0)
15c1aa11 341 g_source_remove(dc->timer);
4542c20d 342
2918994e 343 /* Ensure that the calendar is dismissed. */
344 if (dc->calendar_window != NULL)
345 gtk_widget_destroy(dc->calendar_window);
87cbb654 346
2918994e 347 /* Deallocate all memory. */
348 g_free(dc->clock_format);
349 g_free(dc->tooltip_format);
15c1aa11 350 g_free(dc->action);
3855f25d
MJ
351 g_free(dc->prev_clock_value);
352 g_free(dc->prev_tooltip_value);
2918994e 353 g_free(dc);
a52c2257
HJYP
354}
355
2918994e 356/* Callback when the configuration dialog has recorded a configuration change. */
8c9c4b55 357static gboolean dclock_apply_configuration(gpointer user_data)
cfc83537 358{
8c9c4b55
AG
359 GtkWidget * p = user_data;
360 DClockPlugin * dc = lxpanel_plugin_get_data(p);
76a590ef
AG
361 struct timeval now;
362
363 /* stop the updater now */
364 if (dc->timer)
365 g_source_remove(dc->timer);
ec9471fe 366
367 /* Set up the icon or the label as the displayable widget. */
368 if (dc->icon_only)
369 {
ec9471fe 370 gtk_widget_show(dc->clock_icon);
371 gtk_widget_hide(dc->clock_label);
372 }
373 else
374 {
375 gtk_widget_show(dc->clock_label);
376 gtk_widget_hide(dc->clock_icon);
377 }
8c9c4b55 378
907deaab
JL
379 if (dc->center_text)
380 {
8c9c4b55 381 gtk_label_set_justify(GTK_LABEL(dc->clock_label), GTK_JUSTIFY_CENTER);
907deaab
JL
382 }
383 else
384 {
8c9c4b55 385 gtk_label_set_justify(GTK_LABEL(dc->clock_label), GTK_JUSTIFY_LEFT);
907deaab 386 }
ec9471fe 387
3855f25d 388 /* Rerun the experiment to determine update interval and update the display. */
8575ae11
MJ
389 g_free(dc->prev_clock_value);
390 g_free(dc->prev_tooltip_value);
3855f25d
MJ
391 dc->expiration_interval = AWAITING_FIRST_CHANGE;
392 dc->experiment_count = 0;
8575ae11
MJ
393 dc->prev_clock_value = NULL;
394 dc->prev_tooltip_value = NULL;
76a590ef 395 dclock_timer_set(dc, &now);
4ec924bc
MJ
396
397 /* Hide the calendar. */
398 if (dc->calendar_window != NULL)
399 {
400 gtk_widget_destroy(dc->calendar_window);
401 dc->calendar_window = NULL;
402 }
8c9c4b55
AG
403
404 /* Save configuration */
a8d4af54
AG
405 config_group_set_string(dc->settings, "ClockFmt", dc->clock_format);
406 config_group_set_string(dc->settings, "TooltipFmt", dc->tooltip_format);
407 config_group_set_string(dc->settings, "Action", dc->action);
408 config_group_set_int(dc->settings, "BoldFont", dc->bold);
409 config_group_set_int(dc->settings, "IconOnly", dc->icon_only);
410 config_group_set_int(dc->settings, "CenterText", dc->center_text);
8c9c4b55 411 return FALSE;
cfc83537
HJYP
412}
413
2918994e 414/* Callback when the configuration dialog is to be shown. */
752ee4e2 415static GtkWidget *dclock_configure(LXPanel *panel, GtkWidget *p)
8ccd023a 416{
8c9c4b55 417 DClockPlugin * dc = lxpanel_plugin_get_data(p);
131514c9 418 return lxpanel_generic_config_dlg(_("Digital Clock"), panel,
e56f2fdd 419 dclock_apply_configuration, p,
2918994e 420 _("Clock Format"), &dc->clock_format, CONF_TYPE_STR,
421 _("Tooltip Format"), &dc->tooltip_format, CONF_TYPE_STR,
289d2688 422 _("Format codes: man 3 strftime; %n for line break"), NULL, CONF_TYPE_TRIM,
2918994e 423 _("Action when clicked (default: display calendar)"), &dc->action, CONF_TYPE_STR,
424 _("Bold font"), &dc->bold, CONF_TYPE_BOOL,
ec9471fe 425 _("Tooltip only"), &dc->icon_only, CONF_TYPE_BOOL,
907deaab 426 _("Center text"), &dc->center_text, CONF_TYPE_BOOL,
2918994e 427 NULL);
8ccd023a
HJYP
428}
429
2918994e 430/* Callback when panel configuration changes. */
a7bd16a4 431static void dclock_reconfigure(LXPanel *panel, GtkWidget *p)
a97d06a6 432{
2918994e 433 dclock_apply_configuration(p);
a97d06a6
HJYP
434}
435
2918994e 436/* Plugin descriptor. */
8c9c4b55 437LXPanelPluginInit lxpanel_static_plugin_dclock = {
3c3e9c9e 438 .name = N_("Digital Clock"),
3c3e9c9e 439 .description = N_("Display digital clock and tooltip"),
a52c2257 440
8c9c4b55 441 .new_instance = dclock_constructor,
3c3e9c9e 442 .config = dclock_configure,
e56f2fdd
AG
443 .reconfigure = dclock_reconfigure,
444 .button_press_event = dclock_button_press_event
a52c2257 445};