/
stash.c
1208 lines (1018 loc) · 34.5 KB
/
stash.c
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
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* stash.c - this file is part of Geany, a fast and lightweight IDE
*
* Copyright 2008-2012 Nick Treleaven <nick(dot)treleaven(at)btinternet(dot)com>
* Copyright 2008-2012 Enrico Tröger <enrico(dot)troeger(at)uvena(dot)de>
*
* 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.
*
* 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 Street, Fifth Floor, Boston,
* MA 02110-1301, USA.
*/
/**
* @file stash.h
* Lightweight library for reading/writing @c GKeyFile settings and synchronizing widgets with
* C variables.
*
* Note: Stash should only depend on GLib and GTK, but currently has some minor
* dependencies on Geany's utils.c.
*
* @section Terms
* 'Setting' is used only for data stored on disk or in memory.
* 'Pref' can also include visual widget information.
*
* @section Memory Usage
* Stash will not duplicate strings if they are normally static arrays, such as
* keyfile group names and key names, string default values, widget_id names, property names.
*
* @section String Settings
* String settings and other dynamically allocated settings will be initialized to NULL when
* added to a StashGroup (so they can safely be reassigned later).
*
* @section Widget Support
* Widgets very commonly used in configuration dialogs will be supported with their own function.
* Widgets less commonly used such as @c GtkExpander or widget settings that aren't commonly needed
* to be persistent won't be directly supported, to keep the library lightweight. However, you can
* use stash_group_add_widget_property() to also save these settings for any read/write widget
* property. Macros could be added for common widget properties such as @c GtkExpander:"expanded".
*
* @section settings-example Settings Example
* Here we have some settings for how to make a cup - whether it should be made of china
* and who's going to make it. (Yes, it's a stupid example).
* @include stash-example.c
* @note You might want to handle the warning/error conditions differently from above.
*
* @section prefs-example GUI Prefs Example
* For prefs, it's the same as the above example but you tell Stash to add widget prefs instead of
* just data settings.
*
* This example uses lookup strings for widgets as they are more flexible than widget pointers.
* Code to load and save the settings is omitted - see the first example instead.
*
* Here we show a dialog with a toggle button for whether the cup should have a handle.
* @include stash-gui-example.c
* @note This example should also work for other widget containers besides dialogs, e.g. popup menus.
*/
/* Implementation Note
* We dynamically allocate prefs. It would be more efficient for user code to declare
* a static array of StashPref structs, but we don't do this because:
*
* * It would be more ugly (lots of casts and NULLs).
* * Less type checking.
* * The API & ABI would have to break when adding/changing fields.
*
* Usually the prefs code isn't what user code will spend most of its time doing, so this
* should be efficient enough.
*/
#include "geany.h" /* necessary for utils.h, otherwise use gtk/gtk.h */
#include <stdlib.h> /* only for atoi() */
#include "support.h" /* only for _("text") */
#include "utils.h" /* only for foreach_*, utils_get_setting_*(). Stash should not depend on Geany. */
#include "stash.h"
struct StashPref
{
GType setting_type; /* e.g. G_TYPE_INT */
gpointer setting; /* Address of a variable */
const gchar *key_name;
gpointer default_value; /* Default value, e.g. (gpointer)1 */
GType widget_type; /* e.g. GTK_TYPE_TOGGLE_BUTTON */
StashWidgetID widget_id; /* (GtkWidget*) or (gchar*) */
union
{
struct EnumWidget *radio_buttons;
const gchar *property_name;
} extra; /* extra fields depending on widget_type */
};
typedef struct StashPref StashPref;
struct StashGroup
{
const gchar *name; /* group name to use in the keyfile */
GPtrArray *entries; /* array of (StashPref*) */
gboolean various; /* mark group for display/edit in stash treeview */
gboolean use_defaults; /* use default values if there's no keyfile entry */
};
typedef struct EnumWidget
{
StashWidgetID widget_id;
gint enum_id;
}
EnumWidget;
typedef enum SettingAction
{
SETTING_READ,
SETTING_WRITE
}
SettingAction;
typedef enum PrefAction
{
PREF_DISPLAY,
PREF_UPDATE
}
PrefAction;
static void handle_boolean_setting(StashGroup *group, StashPref *se,
GKeyFile *config, SettingAction action)
{
gboolean *setting = se->setting;
switch (action)
{
case SETTING_READ:
*setting = utils_get_setting_boolean(config, group->name, se->key_name,
GPOINTER_TO_INT(se->default_value));
break;
case SETTING_WRITE:
g_key_file_set_boolean(config, group->name, se->key_name, *setting);
break;
}
}
static void handle_integer_setting(StashGroup *group, StashPref *se,
GKeyFile *config, SettingAction action)
{
gint *setting = se->setting;
switch (action)
{
case SETTING_READ:
*setting = utils_get_setting_integer(config, group->name, se->key_name,
GPOINTER_TO_INT(se->default_value));
break;
case SETTING_WRITE:
g_key_file_set_integer(config, group->name, se->key_name, *setting);
break;
}
}
static void handle_string_setting(StashGroup *group, StashPref *se,
GKeyFile *config, SettingAction action)
{
gchararray *setting = se->setting;
switch (action)
{
case SETTING_READ:
g_free(*setting);
*setting = utils_get_setting_string(config, group->name, se->key_name,
se->default_value);
break;
case SETTING_WRITE:
g_key_file_set_string(config, group->name, se->key_name,
*setting ? *setting : "");
break;
}
}
static void handle_strv_setting(StashGroup *group, StashPref *se,
GKeyFile *config, SettingAction action)
{
gchararray **setting = se->setting;
switch (action)
{
case SETTING_READ:
g_strfreev(*setting);
*setting = g_key_file_get_string_list(config, group->name, se->key_name,
NULL, NULL);
if (*setting == NULL)
*setting = g_strdupv(se->default_value);
break;
case SETTING_WRITE:
{
/* don't try to save a NULL string vector */
const gchar *dummy[] = { "", NULL };
const gchar **strv = *setting ? (const gchar **)*setting : dummy;
g_key_file_set_string_list(config, group->name, se->key_name,
strv, g_strv_length((gchar **)strv));
break;
}
}
}
static void keyfile_action(SettingAction action, StashGroup *group, GKeyFile *keyfile)
{
StashPref *entry;
guint i;
foreach_ptr_array(entry, i, group->entries)
{
/* don't override settings with default values */
if (!group->use_defaults && action == SETTING_READ &&
!g_key_file_has_key(keyfile, group->name, entry->key_name, NULL))
continue;
switch (entry->setting_type)
{
case G_TYPE_BOOLEAN:
handle_boolean_setting(group, entry, keyfile, action); break;
case G_TYPE_INT:
handle_integer_setting(group, entry, keyfile, action); break;
case G_TYPE_STRING:
handle_string_setting(group, entry, keyfile, action); break;
default:
/* Note: G_TYPE_STRV is not a constant, can't use case label */
if (entry->setting_type == G_TYPE_STRV)
handle_strv_setting(group, entry, keyfile, action);
else
g_warning("Unhandled type for %s::%s in %s()!", group->name, entry->key_name,
G_STRFUNC);
}
}
}
/** Reads key values from @a keyfile into the group settings.
* @note You should still call this even if the keyfile couldn't be loaded from disk
* so that all Stash settings are initialized to defaults.
* @param group .
* @param keyfile Usually loaded from a configuration file first. */
void stash_group_load_from_key_file(StashGroup *group, GKeyFile *keyfile)
{
keyfile_action(SETTING_READ, group, keyfile);
}
/** Writes group settings into key values in @a keyfile.
* @a keyfile is usually written to a configuration file afterwards.
* @param group .
* @param keyfile . */
void stash_group_save_to_key_file(StashGroup *group, GKeyFile *keyfile)
{
keyfile_action(SETTING_WRITE, group, keyfile);
}
/** Reads group settings from a configuration file using @c GKeyFile.
* @note Stash settings will be initialized to defaults if the keyfile
* couldn't be loaded from disk.
* @param group .
* @param filename Filename of the file to read, in locale encoding.
* @return @c TRUE if a key file could be loaded.
* @see stash_group_load_from_key_file().
**/
gboolean stash_group_load_from_file(StashGroup *group, const gchar *filename)
{
GKeyFile *keyfile;
gboolean ret;
keyfile = g_key_file_new();
ret = g_key_file_load_from_file(keyfile, filename, 0, NULL);
/* even on failure we load settings to apply defaults */
stash_group_load_from_key_file(group, keyfile);
g_key_file_free(keyfile);
return ret;
}
/** Writes group settings to a configuration file using @c GKeyFile.
*
* @param group .
* @param filename Filename of the file to write, in locale encoding.
* @param flags Keyfile options - @c G_KEY_FILE_NONE is the most efficient.
* @return 0 if the file was successfully written, otherwise the @c errno of the
* failed operation is returned.
* @see stash_group_save_to_key_file().
**/
gint stash_group_save_to_file(StashGroup *group, const gchar *filename,
GKeyFileFlags flags)
{
GKeyFile *keyfile;
gchar *data;
gint ret;
keyfile = g_key_file_new();
/* if we need to keep comments or translations, try to load first */
if (flags)
g_key_file_load_from_file(keyfile, filename, flags, NULL);
stash_group_save_to_key_file(group, keyfile);
data = g_key_file_to_data(keyfile, NULL, NULL);
ret = utils_write_file(filename, data);
g_free(data);
g_key_file_free(keyfile);
return ret;
}
/** Creates a new group.
* @param name Name used for @c GKeyFile group.
* @return Group. */
StashGroup *stash_group_new(const gchar *name)
{
StashGroup *group = g_new0(StashGroup, 1);
group->name = name;
group->entries = g_ptr_array_new();
group->use_defaults = TRUE;
return group;
}
/** Frees the memory allocated for setting values in a group.
* Useful e.g. to avoid freeing strings individually.
* @note This is *not* called by stash_group_free().
* @param group . */
void stash_group_free_settings(StashGroup *group)
{
StashPref *entry;
guint i;
foreach_ptr_array(entry, i, group->entries)
{
if (entry->setting_type == G_TYPE_STRING)
g_free(*(gchararray *) entry->setting);
else if (entry->setting_type == G_TYPE_STRV)
g_strfreev(*(gchararray **) entry->setting);
else
continue;
*(gpointer**) entry->setting = NULL;
}
}
/** Frees a group.
* @param group . */
void stash_group_free(StashGroup *group)
{
StashPref *entry;
guint i;
foreach_ptr_array(entry, i, group->entries)
{
if (entry->widget_type == GTK_TYPE_RADIO_BUTTON)
{
g_free(entry->extra.radio_buttons);
}
g_slice_free(StashPref, entry);
}
g_ptr_array_free(group->entries, TRUE);
g_free(group);
}
/* Used for selecting groups passed to stash_tree_setup().
* @c FALSE by default. */
void stash_group_set_various(StashGroup *group, gboolean various)
{
group->various = various;
}
/* When @c FALSE, Stash doesn't change the setting if there is no keyfile entry, so it
* remains whatever it was initialized/set to by user code.
* @c TRUE by default. */
void stash_group_set_use_defaults(StashGroup *group, gboolean use_defaults)
{
group->use_defaults = use_defaults;
}
static StashPref *
add_pref(StashGroup *group, GType type, gpointer setting,
const gchar *key_name, gpointer default_value)
{
StashPref init = {type, setting, key_name, default_value, G_TYPE_NONE, NULL, {NULL}};
StashPref *entry = g_slice_new(StashPref);
*entry = init;
/* init any pointer settings to NULL so they can be freed later */
if (type == G_TYPE_STRING ||
type == G_TYPE_STRV)
if (group->use_defaults)
*(gpointer**)setting = NULL;
g_ptr_array_add(group->entries, entry);
return entry;
}
/** Adds boolean setting.
* @param group .
* @param setting Address of setting variable.
* @param key_name Name for key in a @c GKeyFile.
* @param default_value Value to use if the key doesn't exist when loading. */
void stash_group_add_boolean(StashGroup *group, gboolean *setting,
const gchar *key_name, gboolean default_value)
{
add_pref(group, G_TYPE_BOOLEAN, setting, key_name, GINT_TO_POINTER(default_value));
}
/** Adds integer setting.
* @param group .
* @param setting Address of setting variable.
* @param key_name Name for key in a @c GKeyFile.
* @param default_value Value to use if the key doesn't exist when loading. */
void stash_group_add_integer(StashGroup *group, gint *setting,
const gchar *key_name, gint default_value)
{
add_pref(group, G_TYPE_INT, setting, key_name, GINT_TO_POINTER(default_value));
}
/** Adds string setting.
* The contents of @a setting will be initialized to @c NULL.
* @param group .
* @param setting Address of setting variable.
* @param key_name Name for key in a @c GKeyFile.
* @param default_value String to copy if the key doesn't exist when loading, or @c NULL. */
void stash_group_add_string(StashGroup *group, gchar **setting,
const gchar *key_name, const gchar *default_value)
{
add_pref(group, G_TYPE_STRING, setting, key_name, (gpointer)default_value);
}
/** Adds string vector setting (array of strings).
* The contents of @a setting will be initialized to @c NULL.
* @param group .
* @param setting Address of setting variable.
* @param key_name Name for key in a @c GKeyFile.
* @param default_value Vector to copy if the key doesn't exist when loading. Usually @c NULL. */
void stash_group_add_string_vector(StashGroup *group, gchar ***setting,
const gchar *key_name, const gchar **default_value)
{
add_pref(group, G_TYPE_STRV, setting, key_name, (gpointer)default_value);
}
/* *** GTK-related functions *** */
static void handle_toggle_button(GtkWidget *widget, gboolean *setting,
PrefAction action)
{
switch (action)
{
case PREF_DISPLAY:
gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(widget), *setting);
break;
case PREF_UPDATE:
*setting = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(widget));
break;
}
}
static void handle_spin_button(GtkWidget *widget, StashPref *entry,
PrefAction action)
{
gint *setting = entry->setting;
g_assert(entry->setting_type == G_TYPE_INT); /* only int spin prefs */
switch (action)
{
case PREF_DISPLAY:
gtk_spin_button_set_value(GTK_SPIN_BUTTON(widget), *setting);
break;
case PREF_UPDATE:
/* if the widget is focussed, the value might not be updated */
gtk_spin_button_update(GTK_SPIN_BUTTON(widget));
*setting = gtk_spin_button_get_value_as_int(GTK_SPIN_BUTTON(widget));
break;
}
}
static void handle_combo_box(GtkWidget *widget, StashPref *entry,
PrefAction action)
{
gint *setting = entry->setting;
switch (action)
{
case PREF_DISPLAY:
gtk_combo_box_set_active(GTK_COMBO_BOX(widget), *setting);
break;
case PREF_UPDATE:
*setting = gtk_combo_box_get_active(GTK_COMBO_BOX(widget));
break;
}
}
static void handle_entry(GtkWidget *widget, StashPref *entry,
PrefAction action)
{
gchararray *setting = entry->setting;
switch (action)
{
case PREF_DISPLAY:
gtk_entry_set_text(GTK_ENTRY(widget), *setting);
break;
case PREF_UPDATE:
g_free(*setting);
*setting = g_strdup(gtk_entry_get_text(GTK_ENTRY(widget)));
break;
}
}
static void handle_combo_box_entry(GtkWidget *widget, StashPref *entry,
PrefAction action)
{
widget = gtk_bin_get_child(GTK_BIN(widget));
handle_entry(widget, entry, action);
}
/* taken from Glade 2.x generated support.c */
static GtkWidget*
lookup_widget(GtkWidget *widget, const gchar *widget_name)
{
GtkWidget *parent, *found_widget;
g_return_val_if_fail(widget != NULL, NULL);
g_return_val_if_fail(widget_name != NULL, NULL);
for (;;)
{
if (GTK_IS_MENU(widget))
parent = gtk_menu_get_attach_widget(GTK_MENU(widget));
else
parent = widget->parent;
if (parent == NULL)
parent = (GtkWidget*) g_object_get_data(G_OBJECT(widget), "GladeParentKey");
if (parent == NULL)
break;
widget = parent;
}
found_widget = (GtkWidget*) g_object_get_data(G_OBJECT(widget), widget_name);
if (G_UNLIKELY(found_widget == NULL))
g_warning("Widget not found: %s", widget_name);
return found_widget;
}
static GtkWidget *
get_widget(GtkWidget *owner, StashWidgetID widget_id)
{
GtkWidget *widget;
if (owner)
widget = lookup_widget(owner, (const gchar *)widget_id);
else
widget = (GtkWidget *)widget_id;
if (!GTK_IS_WIDGET(widget))
{
g_warning("Unknown widget in %s()!", G_STRFUNC);
return NULL;
}
return widget;
}
static void handle_radio_button(GtkWidget *widget, gint enum_id, gboolean *setting,
PrefAction action)
{
switch (action)
{
case PREF_DISPLAY:
if (*setting == enum_id)
gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(widget), TRUE);
break;
case PREF_UPDATE:
if (gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(widget)))
*setting = enum_id;
break;
}
}
static void handle_radio_buttons(GtkWidget *owner, StashPref *entry,
PrefAction action)
{
EnumWidget *field = entry->extra.radio_buttons;
gsize count = 0;
GtkWidget *widget = NULL;
while (1)
{
widget = get_widget(owner, field->widget_id);
if (!widget)
continue;
count++;
handle_radio_button(widget, field->enum_id, entry->setting, action);
field++;
if (!field->widget_id)
break;
}
if (g_slist_length(gtk_radio_button_get_group(GTK_RADIO_BUTTON(widget))) != count)
g_warning("Missing/invalid radio button widget IDs found!");
}
static void handle_widget_property(GtkWidget *widget, StashPref *entry,
PrefAction action)
{
GObject *object = G_OBJECT(widget);
const gchar *name = entry->extra.property_name;
switch (action)
{
case PREF_DISPLAY:
g_object_set(object, name, entry->setting, NULL);
break;
case PREF_UPDATE:
if (entry->setting_type == G_TYPE_STRING)
g_free(entry->setting);
/* TODO: Which other types need freeing here? */
g_object_get(object, name, entry->setting, NULL);
break;
}
}
static void pref_action(PrefAction action, StashGroup *group, GtkWidget *owner)
{
StashPref *entry;
guint i;
foreach_ptr_array(entry, i, group->entries)
{
GtkWidget *widget;
/* ignore settings with no widgets */
if (entry->widget_type == G_TYPE_NONE)
continue;
/* radio buttons have several widgets */
if (entry->widget_type == GTK_TYPE_RADIO_BUTTON)
{
handle_radio_buttons(owner, entry, action);
continue;
}
widget = get_widget(owner, entry->widget_id);
if (!widget)
{
g_warning("Unknown widget for %s::%s in %s()!", group->name, entry->key_name,
G_STRFUNC);
continue;
}
/* note: can't use switch for GTK_TYPE macros */
if (entry->widget_type == GTK_TYPE_TOGGLE_BUTTON)
handle_toggle_button(widget, entry->setting, action);
else if (entry->widget_type == GTK_TYPE_SPIN_BUTTON)
handle_spin_button(widget, entry, action);
else if (entry->widget_type == GTK_TYPE_COMBO_BOX)
handle_combo_box(widget, entry, action);
else if (entry->widget_type == GTK_TYPE_COMBO_BOX_ENTRY)
handle_combo_box_entry(widget, entry, action);
else if (entry->widget_type == GTK_TYPE_ENTRY)
handle_entry(widget, entry, action);
else if (entry->widget_type == G_TYPE_PARAM)
handle_widget_property(widget, entry, action);
else
g_warning("Unhandled type for %s::%s in %s()!", group->name, entry->key_name,
G_STRFUNC);
}
}
/** Applies Stash settings to widgets, usually called before displaying the widgets.
* The @a owner argument depends on which type you use for @ref StashWidgetID.
* @param group .
* @param owner If non-NULL, used to lookup widgets by name, otherwise
* widget pointers are assumed.
* @see stash_group_update(). */
void stash_group_display(StashGroup *group, GtkWidget *owner)
{
pref_action(PREF_DISPLAY, group, owner);
}
/** Applies widget values to Stash settings, usually called after displaying the widgets.
* The @a owner argument depends on which type you use for @ref StashWidgetID.
* @param group .
* @param owner If non-NULL, used to lookup widgets by name, otherwise
* widget pointers are assumed.
* @see stash_group_display(). */
void stash_group_update(StashGroup *group, GtkWidget *owner)
{
pref_action(PREF_UPDATE, group, owner);
}
static StashPref *
add_widget_pref(StashGroup *group, GType setting_type, gpointer setting,
const gchar *key_name, gpointer default_value,
GType widget_type, StashWidgetID widget_id)
{
StashPref *entry =
add_pref(group, setting_type, setting, key_name, default_value);
entry->widget_type = widget_type;
entry->widget_id = widget_id;
return entry;
}
/** Adds a @c GtkToggleButton (or @c GtkCheckButton) widget pref.
* @param group .
* @param setting Address of setting variable.
* @param key_name Name for key in a @c GKeyFile.
* @param default_value Value to use if the key doesn't exist when loading.
* @param widget_id @c GtkWidget pointer or string to lookup widget later.
* @see stash_group_add_radio_buttons(). */
void stash_group_add_toggle_button(StashGroup *group, gboolean *setting,
const gchar *key_name, gboolean default_value, StashWidgetID widget_id)
{
add_widget_pref(group, G_TYPE_BOOLEAN, setting, key_name, GINT_TO_POINTER(default_value),
GTK_TYPE_TOGGLE_BUTTON, widget_id);
}
/** Adds a @c GtkRadioButton widget group pref.
* @param group .
* @param setting Address of setting variable.
* @param key_name Name for key in a @c GKeyFile.
* @param default_value Value to use if the key doesn't exist when loading.
* @param widget_id @c GtkWidget pointer or string to lookup widget later.
* @param enum_id Enum value for @a widget_id.
* @param ... pairs of @a widget_id, @a enum_id.
* Example (using widget lookup strings, but widget pointers can also work):
* @code
* enum {FOO, BAR};
* stash_group_add_radio_buttons(group, &which_one_setting, "which_one", BAR,
* "radio_foo", FOO, "radio_bar", BAR, NULL);
* @endcode */
void stash_group_add_radio_buttons(StashGroup *group, gint *setting,
const gchar *key_name, gint default_value,
StashWidgetID widget_id, gint enum_id, ...)
{
StashPref *entry =
add_widget_pref(group, G_TYPE_INT, setting, key_name, GINT_TO_POINTER(default_value),
GTK_TYPE_RADIO_BUTTON, NULL);
va_list args;
gsize count = 1;
EnumWidget *item, *array;
/* count pairs of args */
va_start(args, enum_id);
while (1)
{
if (!va_arg(args, gpointer))
break;
va_arg(args, gint);
count++;
}
va_end(args);
array = g_new0(EnumWidget, count + 1);
entry->extra.radio_buttons = array;
va_start(args, enum_id);
foreach_c_array(item, array, count)
{
if (item == array)
{
/* first element */
item->widget_id = widget_id;
item->enum_id = enum_id;
}
else
{
item->widget_id = va_arg(args, gpointer);
item->enum_id = va_arg(args, gint);
}
}
va_end(args);
}
/** Adds a @c GtkSpinButton widget pref.
* @param group .
* @param setting Address of setting variable.
* @param key_name Name for key in a @c GKeyFile.
* @param default_value Value to use if the key doesn't exist when loading.
* @param widget_id @c GtkWidget pointer or string to lookup widget later. */
void stash_group_add_spin_button_integer(StashGroup *group, gint *setting,
const gchar *key_name, gint default_value, StashWidgetID widget_id)
{
add_widget_pref(group, G_TYPE_INT, setting, key_name, GINT_TO_POINTER(default_value),
GTK_TYPE_SPIN_BUTTON, widget_id);
}
/** Adds a @c GtkComboBox widget pref.
* @param group .
* @param setting Address of setting variable.
* @param key_name Name for key in a @c GKeyFile.
* @param default_value Value to use if the key doesn't exist when loading.
* @param widget_id @c GtkWidget pointer or string to lookup widget later.
* @see stash_group_add_combo_box_entry(). */
void stash_group_add_combo_box(StashGroup *group, gint *setting,
const gchar *key_name, gint default_value, StashWidgetID widget_id)
{
add_widget_pref(group, G_TYPE_INT, setting, key_name, GINT_TO_POINTER(default_value),
GTK_TYPE_COMBO_BOX, widget_id);
}
/** Adds a @c GtkComboBoxEntry widget pref.
* @param group .
* @param setting Address of setting variable.
* @param key_name Name for key in a @c GKeyFile.
* @param default_value Value to use if the key doesn't exist when loading.
* @param widget_id @c GtkWidget pointer or string to lookup widget later. */
/* We could maybe also have something like stash_group_add_combo_box_entry_with_menu()
* for the history list - or should that be stored as a separate setting? */
void stash_group_add_combo_box_entry(StashGroup *group, gchar **setting,
const gchar *key_name, const gchar *default_value, StashWidgetID widget_id)
{
add_widget_pref(group, G_TYPE_STRING, setting, key_name, (gpointer)default_value,
GTK_TYPE_COMBO_BOX_ENTRY, widget_id);
}
/** Adds a @c GtkEntry widget pref.
* @param group .
* @param setting Address of setting variable.
* @param key_name Name for key in a @c GKeyFile.
* @param default_value Value to use if the key doesn't exist when loading.
* @param widget_id @c GtkWidget pointer or string to lookup widget later. */
void stash_group_add_entry(StashGroup *group, gchar **setting,
const gchar *key_name, const gchar *default_value, StashWidgetID widget_id)
{
add_widget_pref(group, G_TYPE_STRING, setting, key_name, (gpointer)default_value,
GTK_TYPE_ENTRY, widget_id);
}
static GType object_get_property_type(GObject *object, const gchar *property_name)
{
GObjectClass *klass = G_OBJECT_GET_CLASS(object);
GParamSpec *ps;
ps = g_object_class_find_property(klass, property_name);
return ps->value_type;
}
/** Adds a widget's read/write property to the stash group.
* The property will be set when calling
* stash_group_display(), and read when calling stash_group_update().
* @param group .
* @param setting Address of e.g. an integer if using an integer property.
* @param key_name Name for key in a @c GKeyFile.
* @param default_value Value to use if the key doesn't exist when loading.
* Should be cast into a pointer e.g. with @c GINT_TO_POINTER().
* @param widget_id @c GtkWidget pointer or string to lookup widget later.
* @param property_name .
* @param type can be @c 0 if passing a @c GtkWidget as the @a widget_id argument to look it up from the
* @c GObject data.
* @warning Currently only string GValue properties will be freed before setting; patch for
* other types - see @c handle_widget_property(). */
void stash_group_add_widget_property(StashGroup *group, gpointer setting,
const gchar *key_name, gpointer default_value, StashWidgetID widget_id,
const gchar *property_name, GType type)
{
if (!type)
type = object_get_property_type(G_OBJECT(widget_id), property_name);
add_widget_pref(group, type, setting, key_name, default_value,
G_TYPE_PARAM, widget_id)->extra.property_name = property_name;
}
enum
{
STASH_TREE_NAME,
STASH_TREE_VALUE,
STASH_TREE_COUNT
};
struct StashTreeValue
{
const gchar *group_name;
StashPref *pref;
union
{
gchararray tree_string;
gint tree_int;
} data;
};
typedef struct StashTreeValue StashTreeValue;
static void stash_tree_renderer_set_data(GtkCellLayout *cell_layout, GtkCellRenderer *cell,
GtkTreeModel *model, GtkTreeIter *iter, gpointer user_data)
{
GType cell_type = GPOINTER_TO_SIZE(user_data);
StashTreeValue *value;
StashPref *pref;
gboolean matches_type;
gtk_tree_model_get(model, iter, STASH_TREE_VALUE, &value, -1);
pref = value->pref;
matches_type = pref->setting_type == cell_type;
g_object_set(cell, "visible", matches_type, "sensitive", matches_type,
cell_type == G_TYPE_BOOLEAN ? "activatable" : "editable", matches_type, NULL);
if (matches_type)
{
switch (pref->setting_type)
{
case G_TYPE_BOOLEAN:
g_object_set(cell, "active", value->data.tree_int, NULL);
break;
case G_TYPE_INT:
{
gchar *text = g_strdup_printf("%d", value->data.tree_int);
g_object_set(cell, "text", text, NULL);
g_free(text);
break;
}
case G_TYPE_STRING:
g_object_set(cell, "text", value->data.tree_string, NULL);
break;
}
}
}
static void stash_tree_renderer_edited(gchar *path_str, gchar *new_text, GtkTreeModel *model)
{
GtkTreePath *path;
GtkTreeIter iter;
StashTreeValue *value;
StashPref *pref;
path = gtk_tree_path_new_from_string(path_str);
gtk_tree_model_get_iter(model, &iter, path);
gtk_tree_model_get(model, &iter, STASH_TREE_VALUE, &value, -1);
pref = value->pref;
switch (pref->setting_type)
{
case G_TYPE_BOOLEAN:
value->data.tree_int = !value->data.tree_int;
break;
case G_TYPE_INT:
value->data.tree_int = atoi(new_text);
break;
case G_TYPE_STRING:
SETPTR(value->data.tree_string, g_strdup(new_text));
break;
}