aboutsummaryrefslogtreecommitdiff
path: root/libdbusmenu-glib/menuitem.c
blob: cfc6bc3f219cb8f408f4c014ef455294f0286b32 (plain)
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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
/*
A library to communicate a menu object set accross DBus and
track updates and maintain consistency.

Copyright 2009 Canonical Ltd.

Authors:
    Ted Gould <ted@canonical.com>

This program is free software: you can redistribute it and/or modify it 
under the terms of either or both of the following licenses:

1) the GNU Lesser General Public License version 3, as published by the 
Free Software Foundation; and/or
2) the GNU Lesser General Public License version 2.1, as published by 
the Free Software Foundation.

This program is distributed in the hope that it will be useful, but 
WITHOUT ANY WARRANTY; without even the implied warranties of 
MERCHANTABILITY, SATISFACTORY QUALITY or FITNESS FOR A PARTICULAR 
PURPOSE.  See the applicable version of the GNU Lesser General Public 
License for more details.

You should have received a copy of both the GNU Lesser General Public 
License version 3 and version 2.1 along with this program.  If not, see 
<http://www.gnu.org/licenses/>
*/

#include <stdlib.h>
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include "menuitem.h"
#include "menuitem-marshal.h"
#include "menuitem-private.h"
#include "defaults.h"

#ifdef MASSIVEDEBUGGING
#define LABEL(x)  dbusmenu_menuitem_property_get(DBUSMENU_MENUITEM(x), DBUSMENU_MENUITEM_PROP_LABEL)
#define ID(x)     dbusmenu_menuitem_get_id(DBUSMENU_MENUITEM(x))
#endif

/* Private */
/**
	DbusmenuMenuitemPrivate:
	@id: The ID of this menu item
	@children: A list of #DbusmenuMenuitem objects that are
	      children to this one.
	@properties: All of the properties on this menu item.
	@root: Whether this node is the root node

	These are the little secrets that we don't want getting
	out of data that we have.  They can still be gotten using
	accessor functions, but are protected appropriately.
*/
struct _DbusmenuMenuitemPrivate
{
	gint id;
	GList * children;
	GHashTable * properties;
	gboolean root;
	gboolean realized;
	DbusmenuDefaults * defaults;
	gboolean exposed;
	DbusmenuMenuitem * parent;
};

/* Signals */
enum {
	PROPERTY_CHANGED,
	ITEM_ACTIVATED,
	CHILD_ADDED,
	CHILD_REMOVED,
	CHILD_MOVED,
	REALIZED,
	SHOW_TO_USER,
	ABOUT_TO_SHOW,
	EVENT,
	LAST_SIGNAL
};

static guint signals[LAST_SIGNAL] = { 0 };

/* Properties */
enum {
	PROP_0,
	PROP_ID,
};

#define PROP_ID_S  "id"

#define DBUSMENU_MENUITEM_GET_PRIVATE(o)  (DBUSMENU_MENUITEM(o)->priv)

/* Prototypes */
static void dbusmenu_menuitem_class_init (DbusmenuMenuitemClass *klass);
static void dbusmenu_menuitem_init       (DbusmenuMenuitem *self);
static void dbusmenu_menuitem_dispose    (GObject *object);
static void dbusmenu_menuitem_finalize   (GObject *object);
static void set_property (GObject * obj, guint id, const GValue * value, GParamSpec * pspec);
static void get_property (GObject * obj, guint id, GValue * value, GParamSpec * pspec);
static void g_value_transform_STRING_BOOLEAN (const GValue * in, GValue * out);
static void g_value_transform_STRING_INT (const GValue * in, GValue * out);
static void handle_event (DbusmenuMenuitem * mi, const gchar * name, GVariant * variant, guint timestamp);
static void send_about_to_show (DbusmenuMenuitem * mi, void (*cb) (DbusmenuMenuitem * mi, gpointer user_data), gpointer cb_data);

/* GObject stuff */
G_DEFINE_TYPE (DbusmenuMenuitem, dbusmenu_menuitem, G_TYPE_OBJECT);

static void
dbusmenu_menuitem_class_init (DbusmenuMenuitemClass *klass)
{
	GObjectClass *object_class = G_OBJECT_CLASS (klass);

	g_type_class_add_private (klass, sizeof (DbusmenuMenuitemPrivate));

	object_class->dispose = dbusmenu_menuitem_dispose;
	object_class->finalize = dbusmenu_menuitem_finalize;
	object_class->set_property = set_property;
	object_class->get_property = get_property;

	klass->handle_event = handle_event;
	klass->send_about_to_show = send_about_to_show;

	/**
		DbusmenuMenuitem::property-changed:
		@arg0: The #DbusmenuMenuitem object.
		@arg1: The name of the property that changed
		@arg2: The new value of the property

		Emitted everytime a property on a menuitem is either
		updated or added.
	*/
	signals[PROPERTY_CHANGED] =   g_signal_new(DBUSMENU_MENUITEM_SIGNAL_PROPERTY_CHANGED,
	                                           G_TYPE_FROM_CLASS(klass),
	                                           G_SIGNAL_RUN_LAST,
	                                           G_STRUCT_OFFSET(DbusmenuMenuitemClass, property_changed),
	                                           NULL, NULL,
	                                           _dbusmenu_menuitem_marshal_VOID__STRING_VARIANT,
	                                           G_TYPE_NONE, 2, G_TYPE_STRING, G_TYPE_VARIANT);
	/**
		DbusmenuMenuitem::item-activated:
		@arg0: The #DbusmenuMenuitem object.
		@arg1: The timestamp of when it was activated

		Emitted on the objects on the server side when
		they are signaled on the client side.
	*/
	signals[ITEM_ACTIVATED] =   g_signal_new(DBUSMENU_MENUITEM_SIGNAL_ITEM_ACTIVATED,
	                                           G_TYPE_FROM_CLASS(klass),
	                                           G_SIGNAL_RUN_LAST,
	                                           G_STRUCT_OFFSET(DbusmenuMenuitemClass, item_activated),
	                                           NULL, NULL,
	                                           _dbusmenu_menuitem_marshal_VOID__UINT,
	                                           G_TYPE_NONE, 1, G_TYPE_UINT, G_TYPE_NONE);
	/**
		DbusmenuMenuitem::child-added:
		@arg0: The #DbusmenuMenuitem which is the parent.
		@arg1: The #DbusmenuMenuitem which is the child.
		@arg2: The position that the child is being added in.

		Signaled when the child menuitem has been added to
		the parent.
	*/
	signals[CHILD_ADDED] =        g_signal_new(DBUSMENU_MENUITEM_SIGNAL_CHILD_ADDED,
	                                           G_TYPE_FROM_CLASS(klass),
	                                           G_SIGNAL_RUN_LAST,
	                                           G_STRUCT_OFFSET(DbusmenuMenuitemClass, child_added),
	                                           NULL, NULL,
	                                           _dbusmenu_menuitem_marshal_VOID__OBJECT_UINT,
	                                           G_TYPE_NONE, 2, G_TYPE_OBJECT, G_TYPE_UINT);
	/**
		DbusmenuMenuitem::child-removed:
		@arg0: The #DbusmenuMenuitem which was the parent.
		@arg1: The #DbusmenuMenuitem which was the child.

		Signaled when the child menuitem has been requested to
		be removed from the parent.  This signal is called when
		it has been removed from the list but not yet had
		#g_object_unref called on it.
	*/
	signals[CHILD_REMOVED] =      g_signal_new(DBUSMENU_MENUITEM_SIGNAL_CHILD_REMOVED,
	                                           G_TYPE_FROM_CLASS(klass),
	                                           G_SIGNAL_RUN_LAST,
	                                           G_STRUCT_OFFSET(DbusmenuMenuitemClass, child_removed),
	                                           NULL, NULL,
	                                           _dbusmenu_menuitem_marshal_VOID__OBJECT,
	                                           G_TYPE_NONE, 1, G_TYPE_OBJECT);
	/**
		DbusmenuMenuitem::child-moved:
		@arg0: The #DbusmenuMenuitem which is the parent.
		@arg1: The #DbusmenuMenuitem which is the child.
		@arg2: The position that the child is being moved to.
		@arg3: The position that the child is was in.

		Signaled when the child menuitem has had it's location
		in the list change.
	*/
	signals[CHILD_MOVED] =        g_signal_new(DBUSMENU_MENUITEM_SIGNAL_CHILD_MOVED,
	                                           G_TYPE_FROM_CLASS(klass),
	                                           G_SIGNAL_RUN_LAST,
	                                           G_STRUCT_OFFSET(DbusmenuMenuitemClass, child_moved),
	                                           NULL, NULL,
	                                           _dbusmenu_menuitem_marshal_VOID__OBJECT_UINT_UINT,
	                                           G_TYPE_NONE, 3, G_TYPE_OBJECT, G_TYPE_UINT, G_TYPE_UINT);
	/**
		DbusmenuMenuitem::realized:
		@arg0: The #DbusmenuMenuitem object.

		Emitted when the initial request for properties
		is complete on the item.  If there is a type
		handler configured for the "type" parameter
		that will be executed before this is signaled.
	*/
	signals[REALIZED] =           g_signal_new(DBUSMENU_MENUITEM_SIGNAL_REALIZED,
	                                           G_TYPE_FROM_CLASS(klass),
	                                           G_SIGNAL_RUN_LAST,
	                                           G_STRUCT_OFFSET(DbusmenuMenuitemClass, realized),
	                                           NULL, NULL,
	                                           _dbusmenu_menuitem_marshal_VOID__VOID,
	                                           G_TYPE_NONE, 0, G_TYPE_NONE);
	/**
		DbusmenuMenuitem::show-to-user:
		@arg0: The #DbusmenuMenuitem which should be shown.
		@arg1: Timestamp the event happened at

		Signaled when the application would like the visualization
		of this menu item shown to the user.  This usually requires
		going over the bus to get it done.
	*/
	signals[SHOW_TO_USER] =      g_signal_new(DBUSMENU_MENUITEM_SIGNAL_SHOW_TO_USER,
	                                           G_TYPE_FROM_CLASS(klass),
	                                           G_SIGNAL_RUN_LAST,
	                                           G_STRUCT_OFFSET(DbusmenuMenuitemClass, show_to_user),
	                                           NULL, NULL,
	                                           g_cclosure_marshal_VOID__UINT,
	                                           G_TYPE_NONE, 1, G_TYPE_UINT, G_TYPE_NONE);

	/**
		DbusmenuMenuitem::about-to-show:
		@arg0: The #DbusmenuMenuitem object.

		Emitted when the submenu for this item
		is about to be shown
	*/
	signals[ABOUT_TO_SHOW] =     g_signal_new(DBUSMENU_MENUITEM_SIGNAL_ABOUT_TO_SHOW,
	                                          G_TYPE_FROM_CLASS(klass),
	                                          G_SIGNAL_RUN_LAST,
	                                          G_STRUCT_OFFSET(DbusmenuMenuitemClass, about_to_show),
	                                          NULL, NULL,
	                                          _dbusmenu_menuitem_marshal_VOID__VOID,
	                                          G_TYPE_BOOLEAN, 0, G_TYPE_NONE);
	/**
		DbusmenuMenuitem::event:
		@arg0: The #DbusmenuMenuitem object.
		@arg1: Name of the event
		@arg2: Information passed along with the event
		@arg3: X11 timestamp of when the event happened

		Emitted when an event is passed through.  The event is signalled
		after handle_event is called.
	*/
	signals[EVENT] =             g_signal_new(DBUSMENU_MENUITEM_SIGNAL_EVENT,
	                                          G_TYPE_FROM_CLASS(klass),
	                                          G_SIGNAL_RUN_LAST | G_SIGNAL_DETAILED,
	                                          G_STRUCT_OFFSET(DbusmenuMenuitemClass, event),
	                                          g_signal_accumulator_true_handled, NULL,
	                                          _dbusmenu_menuitem_marshal_BOOLEAN__STRING_VARIANT_UINT,
	                                          G_TYPE_BOOLEAN, 3, G_TYPE_STRING, G_TYPE_VARIANT, G_TYPE_UINT);

	g_object_class_install_property (object_class, PROP_ID,
	                                 g_param_spec_int(PROP_ID_S, "ID for the menu item",
	                                              "This is a unique indentifier for the menu item.",
												  -1, 30000, -1,
	                                              G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS));

	/* Check transfer functions for GValue */
	if (!g_value_type_transformable(G_TYPE_STRING, G_TYPE_BOOLEAN)) {
		g_value_register_transform_func(G_TYPE_STRING, G_TYPE_BOOLEAN, g_value_transform_STRING_BOOLEAN);
	}
	if (!g_value_type_transformable(G_TYPE_STRING, G_TYPE_INT)) {
		g_value_register_transform_func(G_TYPE_STRING, G_TYPE_INT, g_value_transform_STRING_INT);
	}

	return;
}

/* A little helper function to translate a string into
   a boolean value */
static void
g_value_transform_STRING_BOOLEAN (const GValue * in, GValue * out)
{
	const gchar * string = g_value_get_string(in);
	if (!g_strcmp0(string, "TRUE") || !g_strcmp0(string, "true") || !g_strcmp0(string, "True")) {
		g_value_set_boolean(out, TRUE);
	} else {
		g_value_set_boolean(out, FALSE);
	}
	return;
}

/* A little helper function to translate a string into
   a integer value */
static void
g_value_transform_STRING_INT (const GValue * in, GValue * out)
{
	g_value_set_int(out, atoi(g_value_get_string(in)));
	return;
}

static gint menuitem_next_id = 1;

/* Make the unref function match the prototype need for the
   hashtable destructor */
static void
_g_variant_unref (gpointer data)
{
	g_variant_unref((GVariant *)data);
	return;
}

/* Initialize the values of the in the object, and build the
   properties hash table. */
static void
dbusmenu_menuitem_init (DbusmenuMenuitem *self)
{
	self->priv = G_TYPE_INSTANCE_GET_PRIVATE ((self), DBUSMENU_TYPE_MENUITEM, DbusmenuMenuitemPrivate);

	DbusmenuMenuitemPrivate * priv = DBUSMENU_MENUITEM_GET_PRIVATE(self);

	priv->id = -1; 
	priv->children = NULL;

	priv->properties = g_hash_table_new_full(g_str_hash, g_str_equal, g_free, _g_variant_unref);

	priv->root = FALSE;
	priv->realized = FALSE;

	priv->defaults = dbusmenu_defaults_ref_default();
	priv->exposed = FALSE;
	
	return;
}

static void
dbusmenu_menuitem_dispose (GObject *object)
{
	DbusmenuMenuitemPrivate * priv = DBUSMENU_MENUITEM_GET_PRIVATE(object);

	GList * child = NULL;
	for (child = priv->children; child != NULL; child = g_list_next(child)) {
		g_object_unref(G_OBJECT(child->data));
	}
	g_list_free(priv->children);
	priv->children = NULL;

	if (priv->defaults != NULL) {
		g_object_unref(priv->defaults);
		priv->defaults = NULL;
	}

	if (priv->parent) {
		g_object_remove_weak_pointer(G_OBJECT(priv->parent), (gpointer *)&priv->parent);
		priv->parent = NULL;
	}

	G_OBJECT_CLASS (dbusmenu_menuitem_parent_class)->dispose (object);
	return;
}

static void
dbusmenu_menuitem_finalize (GObject *object)
{
	/* g_debug("Menuitem dying"); */
	DbusmenuMenuitemPrivate * priv = DBUSMENU_MENUITEM_GET_PRIVATE(object);

	if (priv->properties != NULL) {
		g_hash_table_destroy(priv->properties);
		priv->properties = NULL;
	}

	G_OBJECT_CLASS (dbusmenu_menuitem_parent_class)->finalize (object);
	return;
}

static void
set_property (GObject * obj, guint id, const GValue * value, GParamSpec * pspec)
{
	DbusmenuMenuitemPrivate * priv = DBUSMENU_MENUITEM_GET_PRIVATE(obj);

	switch (id) {
	case PROP_ID:
		priv->id = g_value_get_int(value);
		if (priv->id > menuitem_next_id) {
			menuitem_next_id = priv->id + 1;
		}
		break;
	default:
		G_OBJECT_WARN_INVALID_PROPERTY_ID(obj, id, pspec);
		break;
	}

	return;
}

static void
get_property (GObject * obj, guint id, GValue * value, GParamSpec * pspec)
{
	DbusmenuMenuitemPrivate * priv = DBUSMENU_MENUITEM_GET_PRIVATE(obj);

	switch (id) {
	case PROP_ID:
		if (priv->id == -1) {
			priv->id = menuitem_next_id++;
		}
		if (dbusmenu_menuitem_get_root(DBUSMENU_MENUITEM(obj))) {
			g_value_set_int(value, 0);
		} else {
			g_value_set_int(value, priv->id);
		}
		break;
	default:
		G_OBJECT_WARN_INVALID_PROPERTY_ID(obj, id, pspec);
		break;
	}

	return;
}

/* Handles the activate event if it is sent. */
static void
handle_event (DbusmenuMenuitem * mi, const gchar * name, GVariant * value, guint timestamp)
{
	if (g_strcmp0(name, DBUSMENU_MENUITEM_EVENT_ACTIVATED) == 0) {
		g_signal_emit(G_OBJECT(mi), signals[ITEM_ACTIVATED], 0, timestamp, TRUE);
	}

	return;
}

/* Handles our about to show signal on items that submenus
   exist.  This is sending just activate now, but we should
   probably consider a special signal in the future if GTK
   gets more sophisticated about this. */
static void
send_about_to_show (DbusmenuMenuitem * mi, void (*cb) (DbusmenuMenuitem * mi, gpointer user_data), gpointer cb_data)
{
	g_return_if_fail(DBUSMENU_IS_MENUITEM(mi));

	if (dbusmenu_menuitem_get_children(mi) == NULL && g_strcmp0(DBUSMENU_MENUITEM_CHILD_DISPLAY_SUBMENU, dbusmenu_menuitem_property_get(mi, DBUSMENU_MENUITEM_PROP_CHILD_DISPLAY)) != 0) {
		g_warning("About to Show called on an item wihtout submenus.  We're ignoring it.");
	} else {
		gboolean dummy;
		g_signal_emit(G_OBJECT(mi), signals[ABOUT_TO_SHOW], 0, &dummy);
	}

	if (cb != NULL) {
		cb(mi, cb_data);
	}

	return;
}

/* A helper function to get the type of the menuitem, this might
   be a candidate for optimization in the future. */
static const gchar *
menuitem_get_type (const DbusmenuMenuitem * mi)
{
	DbusmenuMenuitemPrivate * priv = DBUSMENU_MENUITEM_GET_PRIVATE(mi);
	GVariant * currentval = (GVariant *)g_hash_table_lookup(priv->properties, DBUSMENU_MENUITEM_PROP_TYPE);
	if (currentval != NULL) {
		return g_variant_get_string(currentval, NULL);
	}
	return NULL;
}

/* Public interface */

/**
 * dbusmenu_menuitem_new:
 * 
 * Create a new #DbusmenuMenuitem with all default values.
 * 
 * Return value: A newly allocated #DbusmenuMenuitem.
 */
DbusmenuMenuitem *
dbusmenu_menuitem_new (void)
{
	return g_object_new(DBUSMENU_TYPE_MENUITEM, NULL);
}

/**
 * dbusmenu_menuitem_new_with_id:
 * @id: ID to use for this menuitem
 * 
 * This creates a blank #DbusmenuMenuitem with a specific ID.
 * 
 * Return value: A newly allocated #DbusmenuMenuitem.
 */
DbusmenuMenuitem *
dbusmenu_menuitem_new_with_id (gint id)
{
	DbusmenuMenuitem * mi = g_object_new(DBUSMENU_TYPE_MENUITEM, PROP_ID_S, id, NULL);
	/* g_debug("New Menuitem id %d goal id %d", dbusmenu_menuitem_get_id(mi), id); */
	return mi;
}

/**
 * dbusmenu_menuitem_get_id:
 * @mi: The #DbusmenuMenuitem to query.
 * 
 * Gets the unique ID for @mi.
 * 
 * Return value: The ID of the @mi.
 */
gint
dbusmenu_menuitem_get_id (DbusmenuMenuitem * mi)
{
	g_return_val_if_fail(DBUSMENU_IS_MENUITEM(mi), -1);

	GValue retval = {0};
	g_value_init(&retval, G_TYPE_INT);
	g_object_get_property(G_OBJECT(mi), PROP_ID_S, &retval);
	gint ret = g_value_get_int(&retval);
	#ifdef MASSIVEDEBUGGING
	g_debug("Getting menuitem ID: %d", ret);
	#endif
	return ret;
}

/**
 * dbusmenu_menuitem_realized:
 * @mi: #DbusmenuMenuitem to check on
 * 
 * This function returns whether the menuitem has been realized or
 * not.  This is significant mostly in client implementations that
 * can use this additional state to see if the second layers of
 * the implementation have been built yet.
 * 
 * Return value: Returns whether or not the menu item has been realized
 * 	yet or not.
 */
gboolean
dbusmenu_menuitem_realized (DbusmenuMenuitem * mi)
{
	g_return_val_if_fail(DBUSMENU_IS_MENUITEM(mi), FALSE);
	DbusmenuMenuitemPrivate * priv = DBUSMENU_MENUITEM_GET_PRIVATE(mi);
	return priv->realized;
}

/**
 * dbusmenu_menuitem_set_realized:
 * @mi: #DbusmenuMenuitem to realize
 * 
 * Sets the internal variable tracking whether it's been realized and
 * signals the DbusmenuMenuitem::realized event.
 */
void
dbusmenu_menuitem_set_realized (DbusmenuMenuitem * mi)
{
	g_return_if_fail(DBUSMENU_IS_MENUITEM(mi));
	DbusmenuMenuitemPrivate * priv = DBUSMENU_MENUITEM_GET_PRIVATE(mi);
	if (priv->realized) {
		g_warning("Realized entry realized again?  ID: %d", dbusmenu_menuitem_get_id(mi));
	}
	priv->realized = TRUE;
	g_signal_emit(G_OBJECT(mi), signals[REALIZED], 0, TRUE);
	return;
}

/**
 * dbusmenu_menuitem_get_children:
 * @mi: The #DbusmenuMenuitem to query.
 * 
 * Returns simply the list of children that this menu item
 * has.  The list is valid until another child related function
 * is called, where it might be changed.
 * 
 * Return value: (transfer none) (element-type Dbusmenu.Menuitem): A #GList of pointers to #DbusmenuMenuitem objects.
 */
GList *
dbusmenu_menuitem_get_children (DbusmenuMenuitem * mi)
{
	g_return_val_if_fail(DBUSMENU_IS_MENUITEM(mi), NULL);

	DbusmenuMenuitemPrivate * priv = DBUSMENU_MENUITEM_GET_PRIVATE(mi);
	return priv->children;
}

/* For all the taken children we need to signal
   that they were removed */
static void
take_children_helper (gpointer data, gpointer user_data)
{
	#ifdef MASSIVEDEBUGGING
	g_debug("Menuitem %d (%s) signalling child removed %d (%s)", ID(user_data), LABEL(user_data), ID(data), LABEL(data));
	#endif
	dbusmenu_menuitem_unparent(DBUSMENU_MENUITEM(data));
	g_signal_emit(G_OBJECT(user_data), signals[CHILD_REMOVED], 0, DBUSMENU_MENUITEM(data), TRUE);
	return;
}

/**
 * dbusmenu_menuitem_take_children:
 * @mi: The #DbusmenMenuitem to take the children from.
 * 
 * While the name sounds devious that's exactly what this function
 * does.  It takes the list of children from the @mi and clears the
 * internal list.  The calling function is now in charge of the ref's
 * on the children it has taken.  A lot of responsibility involved
 * in taking children.
 * 
 * Return value: (transfer full) (element-type Dbusmenu.Menuitem):
 *    A #GList of pointers to #DbusmenuMenuitem objects.
 */
GList *
dbusmenu_menuitem_take_children (DbusmenuMenuitem * mi)
{
	g_return_val_if_fail(DBUSMENU_IS_MENUITEM(mi), NULL);

	DbusmenuMenuitemPrivate * priv = DBUSMENU_MENUITEM_GET_PRIVATE(mi);
	GList * children = priv->children;
	priv->children = NULL;
	g_list_foreach(children, take_children_helper, mi);

	dbusmenu_menuitem_property_remove(mi, DBUSMENU_MENUITEM_PROP_CHILD_DISPLAY);
	
	return children;
}

/**
 * dbusmenu_menuitem_get_position:
 * @mi: The #DbusmenuMenuitem to find the position of
 * @parent: The #DbusmenuMenuitem who's children contain @mi
 * 
 * This function returns the position of the menu item @mi
 * in the children of @parent.  It will return zero if the
 * menu item can't be found.
 * 
 * Return value: The position of @mi in the children of @parent.
 */
guint
dbusmenu_menuitem_get_position (DbusmenuMenuitem * mi, DbusmenuMenuitem * parent)
{
	#ifdef MASSIVEDEBUGGING
	if (!DBUSMENU_IS_MENUITEM(mi))     g_warning("Getting position of %d (%s), it's at: %d (mi fail)", ID(mi), LABEL(mi), 0);
	if (!DBUSMENU_IS_MENUITEM(parent)) g_warning("Getting position of %d (%s), it's at: %d (parent fail)", ID(mi), LABEL(mi), 0);
	#endif

	/* TODO: I'm not too happy returning zeros here.  But that's all I've got */
	g_return_val_if_fail(DBUSMENU_IS_MENUITEM(mi), 0);
	g_return_val_if_fail(DBUSMENU_IS_MENUITEM(parent), 0);

	GList * childs = dbusmenu_menuitem_get_children(parent);
	if (childs == NULL) return 0;
	guint count = 0;
	for ( ; childs != NULL; childs = childs->next, count++) {
		if (childs->data == mi) break;
	}

	if (childs == NULL) return 0;

	#ifdef MASSIVEDEBUGGING
	g_debug("Getting position of %d (%s), it's at: %d", ID(mi), LABEL(mi), count);
	#endif

	return count;
}

/**
 * dbusmenu_menuitem_get_position_realized:
 * @mi: The #DbusmenuMenuitem to find the position of
 * @parent: The #DbusmenuMenuitem who's children contain @mi
 * 
 * This function is very similar to #dbusmenu_menuitem_get_position
 * except that it only counts in the children that have been realized.
 * 
 * Return value: The position of @mi in the realized children of @parent.
 */
guint
dbusmenu_menuitem_get_position_realized (DbusmenuMenuitem * mi, DbusmenuMenuitem * parent)
{
	#ifdef MASSIVEDEBUGGING
	if (!DBUSMENU_IS_MENUITEM(mi))     g_warning("Getting position of %d (%s), it's at: %d (mi fail)", ID(mi), LABEL(mi), 0);
	if (!DBUSMENU_IS_MENUITEM(parent)) g_warning("Getting position of %d (%s), it's at: %d (parent fail)", ID(mi), LABEL(mi), 0);
	#endif

	/* TODO: I'm not too happy returning zeros here.  But that's all I've got */
	g_return_val_if_fail(DBUSMENU_IS_MENUITEM(mi), 0);
	g_return_val_if_fail(DBUSMENU_IS_MENUITEM(parent), 0);

	GList * childs = dbusmenu_menuitem_get_children(parent);
	if (childs == NULL) return 0;
	guint count = 0;
	for ( ; childs != NULL; childs = childs->next, count++) {
		if (!dbusmenu_menuitem_realized(DBUSMENU_MENUITEM(childs->data))) {
			count--;
			continue;
		}
		if (childs->data == mi) {
			break;
		}
	}

	if (childs == NULL) return 0;

	#ifdef MASSIVEDEBUGGING
	g_debug("Getting position of %d (%s), it's at: %d", ID(mi), LABEL(mi), count);
	#endif

	return count;
}

/**
 * dbusmenu_menuitem_child_append:
 * @mi: The #DbusmenuMenuitem which will become a new parent
 * @child: The #DbusmenMenuitem that will be a child
 * 
 * This function adds @child to the list of children on @mi at
 * the end of that list.
 * 
 * Return value: Whether the child has been added successfully.
 */
gboolean
dbusmenu_menuitem_child_append (DbusmenuMenuitem * mi, DbusmenuMenuitem * child)
{
	g_return_val_if_fail(DBUSMENU_IS_MENUITEM(mi), FALSE);
	g_return_val_if_fail(DBUSMENU_IS_MENUITEM(child), FALSE);

	DbusmenuMenuitemPrivate * priv = DBUSMENU_MENUITEM_GET_PRIVATE(mi);
	g_return_val_if_fail(g_list_find(priv->children, child) == NULL, FALSE);

	if (!dbusmenu_menuitem_set_parent(child, mi)) {
		return FALSE;
	}

	if (priv->children == NULL && !dbusmenu_menuitem_property_exist(mi, DBUSMENU_MENUITEM_PROP_CHILD_DISPLAY)) {
		dbusmenu_menuitem_property_set(mi, DBUSMENU_MENUITEM_PROP_CHILD_DISPLAY, DBUSMENU_MENUITEM_CHILD_DISPLAY_SUBMENU);
	}

	priv->children = g_list_append(priv->children, child);
	#ifdef MASSIVEDEBUGGING
	g_debug("Menuitem %d (%s) signalling child added %d (%s) at %d", ID(mi), LABEL(mi), ID(child), LABEL(child), g_list_length(priv->children) - 1);
	#endif
	g_object_ref(G_OBJECT(child));
	g_signal_emit(G_OBJECT(mi), signals[CHILD_ADDED], 0, child, g_list_length(priv->children) - 1, TRUE);
	return TRUE;
}

/**
 * dbusmenu_menuitem_child_prepend:
 * @mi: The #DbusmenuMenuitem which will become a new parent
 * @child: The #DbusmenMenuitem that will be a child
 * 
 * This function adds @child to the list of children on @mi at
 * the beginning of that list.
 * 
 * Return value: Whether the child has been added successfully.
 */
gboolean
dbusmenu_menuitem_child_prepend (DbusmenuMenuitem * mi, DbusmenuMenuitem * child)
{
	g_return_val_if_fail(DBUSMENU_IS_MENUITEM(mi), FALSE);
	g_return_val_if_fail(DBUSMENU_IS_MENUITEM(child), FALSE);

	DbusmenuMenuitemPrivate * priv = DBUSMENU_MENUITEM_GET_PRIVATE(mi);
	g_return_val_if_fail(g_list_find(priv->children, child) == NULL, FALSE);

	if (!dbusmenu_menuitem_set_parent(child, mi)) {
		return FALSE;
	}

	if (priv->children == NULL && !dbusmenu_menuitem_property_exist(mi, DBUSMENU_MENUITEM_PROP_CHILD_DISPLAY)) {
		dbusmenu_menuitem_property_set(mi, DBUSMENU_MENUITEM_PROP_CHILD_DISPLAY, DBUSMENU_MENUITEM_CHILD_DISPLAY_SUBMENU);
	}

	priv->children = g_list_prepend(priv->children, child);
	#ifdef MASSIVEDEBUGGING
	g_debug("Menuitem %d (%s) signalling child added %d (%s) at %d", ID(mi), LABEL(mi), ID(child), LABEL(child), 0);
	#endif
	g_object_ref(G_OBJECT(child));
	g_signal_emit(G_OBJECT(mi), signals[CHILD_ADDED], 0, child, 0, TRUE);
	return TRUE;
}

/**
 * dbusmenu_menuitem_child_delete:
 * @mi: The #DbusmenuMenuitem which has @child as a child
 * @child: The child #DbusmenuMenuitem that you want to no longer
 *     be a child of @mi.
 * 
 * This function removes @child from the children list of @mi.  It does
 * not call #g_object_unref on @child.
 * 
 * Return value: If we were able to delete @child.
 */
gboolean
dbusmenu_menuitem_child_delete (DbusmenuMenuitem * mi, DbusmenuMenuitem * child)
{
	g_return_val_if_fail(DBUSMENU_IS_MENUITEM(mi), FALSE);
	g_return_val_if_fail(DBUSMENU_IS_MENUITEM(child), FALSE);

	if (dbusmenu_menuitem_get_parent(child) != mi) {
		g_warning("Trying to remove a child that doesn't believe we're it's parent.");
		return FALSE;
	}

	DbusmenuMenuitemPrivate * priv = DBUSMENU_MENUITEM_GET_PRIVATE(mi);
	priv->children = g_list_remove(priv->children, child);
	dbusmenu_menuitem_unparent(child);
	#ifdef MASSIVEDEBUGGING
	g_debug("Menuitem %d (%s) signalling child removed %d (%s)", ID(mi), LABEL(mi), ID(child), LABEL(child));
	#endif
	g_signal_emit(G_OBJECT(mi), signals[CHILD_REMOVED], 0, child, TRUE);
	g_object_unref(G_OBJECT(child));

	if (priv->children == NULL) {
		dbusmenu_menuitem_property_remove(mi, DBUSMENU_MENUITEM_PROP_CHILD_DISPLAY);
	}

	return TRUE;
}

/**
 * dbusmenu_menuitem_child_add_position:
 * @mi: The #DbusmenuMenuitem that we're adding the child @child to.
 * @child: The #DbusmenuMenuitem to make a child of @mi.
 * @position: Where in @mi object's list of chidren @child should be placed.
 * 
 * Puts @child in the list of children for @mi at the location
 * specified in @position.  If there is not enough entires available
 * then @child will be placed at the end of the list.
 * 
 * Return value: Whether @child was added successfully.
 */
gboolean
dbusmenu_menuitem_child_add_position (DbusmenuMenuitem * mi, DbusmenuMenuitem * child, guint position)
{
	g_return_val_if_fail(DBUSMENU_IS_MENUITEM(mi), FALSE);
	g_return_val_if_fail(DBUSMENU_IS_MENUITEM(child), FALSE);

	DbusmenuMenuitemPrivate * priv = DBUSMENU_MENUITEM_GET_PRIVATE(mi);
	g_return_val_if_fail(g_list_find(priv->children, child) == NULL, FALSE);

	if (!dbusmenu_menuitem_set_parent(child, mi)) {
		return FALSE;
	}

	if (priv->children == NULL && !dbusmenu_menuitem_property_exist(mi, DBUSMENU_MENUITEM_PROP_CHILD_DISPLAY)) {
		dbusmenu_menuitem_property_set(mi, DBUSMENU_MENUITEM_PROP_CHILD_DISPLAY, DBUSMENU_MENUITEM_CHILD_DISPLAY_SUBMENU);
	}

	priv->children = g_list_insert(priv->children, child, position);
	#ifdef MASSIVEDEBUGGING
	g_debug("Menuitem %d (%s) signalling child added %d (%s) at %d", ID(mi), LABEL(mi), ID(child), LABEL(child), position);
	#endif
	g_object_ref(G_OBJECT(child));
	g_signal_emit(G_OBJECT(mi), signals[CHILD_ADDED], 0, child, position, TRUE);
	return TRUE;
}

/**
 * dbusmenu_menuitem_child_reorder:
 * @mi: The #DbusmenuMenuitem that has children needing realignment
 * @child: The #DbusmenuMenuitem that is a child needing to be moved
 * @position: The position in the list to place it in
 * 
 * This function moves a child on the list of children.  It is
 * for a child that is already in the list, but simply needs a 
 * new location.
 * 
 * Return value: Whether the move was successful.
 */
gboolean
dbusmenu_menuitem_child_reorder(DbusmenuMenuitem * mi, DbusmenuMenuitem * child, guint position)
{
	g_return_val_if_fail(DBUSMENU_IS_MENUITEM(mi), FALSE);
	g_return_val_if_fail(DBUSMENU_IS_MENUITEM(child), FALSE);

	DbusmenuMenuitemPrivate * priv = DBUSMENU_MENUITEM_GET_PRIVATE(mi);
	gint oldpos = g_list_index(priv->children, child);

	if (oldpos == -1) {
		g_warning("Can not reorder child that isn't actually a child.");
		return FALSE;
	}
	if (oldpos == position) {
		return TRUE;
	}

	priv->children = g_list_remove(priv->children, child);
	priv->children = g_list_insert(priv->children, child, position);

	#ifdef MASSIVEDEBUGGING
	g_debug("Menuitem %d (%s) signalling child %d (%s) moved from %d to %d", ID(mi), LABEL(mi), ID(child), LABEL(child), oldpos, position);
	#endif
	g_signal_emit(G_OBJECT(mi), signals[CHILD_MOVED], 0, child, position, oldpos, TRUE);

	return TRUE;
}

/**
 * dbusmenu_menuitem_child_find:
 * @mi: The #DbusmenuMenuitem who's children to look on
 * @id: The ID of the child that we're looking for.
 * 
 * Search the children of @mi to find one with the ID of @id.
 * If it doesn't exist then we return #NULL.
 * 
 * Return value: (transfer none): The menu item with the ID @id or #NULL if it
 *    can't be found.
 */
DbusmenuMenuitem *
dbusmenu_menuitem_child_find (DbusmenuMenuitem * mi, gint id)
{
	g_return_val_if_fail(DBUSMENU_IS_MENUITEM(mi), NULL);

	GList * childs = dbusmenu_menuitem_get_children(mi);
	if (childs == NULL) return NULL;

	for ( ; childs == NULL; childs = g_list_next(childs)) {
		DbusmenuMenuitem * lmi = DBUSMENU_MENUITEM(childs->data);
		if (id == dbusmenu_menuitem_get_id(lmi)) {
			return lmi;
		}
	}

	return NULL;
}

typedef struct {
	DbusmenuMenuitem * mi;
	gint id;
} find_id_t;

/* Basically the heart of the find_id that matches the
   API of GFunc.  Unfortunately, this goes through all the
   children, but it rejects them quickly. */
static void
find_id_helper (gpointer in_mi, gpointer in_find_id)
{
	DbusmenuMenuitem * mi = (DbusmenuMenuitem *)in_mi;
	find_id_t * find_id = (find_id_t *)in_find_id;

	if (find_id->mi != NULL) return;
	if (find_id->id == dbusmenu_menuitem_get_id(mi)) {
		find_id->mi = mi;
		return;
	}

	g_list_foreach(dbusmenu_menuitem_get_children(mi), find_id_helper, in_find_id);
	return;
}

/**
 * dbusmenu_menuitem_find_id:
 * @mi: #DbusmenuMenuitem at the top of the tree to search
 * @id: ID of the #DbusmenuMenuitem to search for
 * 
 * This function searchs the whole tree of children that
 * are attached to @mi.  This could be quite a few nodes, all
 * the way down the tree.  It is a depth first search.
 * 
 * Return value: (transfer none): The #DbusmenuMenuitem with the ID of @id
 * 	or #NULL if there isn't such a menu item in the tree
 * 	represented by @mi.
 */
DbusmenuMenuitem *
dbusmenu_menuitem_find_id (DbusmenuMenuitem * mi, gint id)
{
	g_return_val_if_fail(DBUSMENU_IS_MENUITEM(mi), NULL);
	if (id == 0) {
		if (dbusmenu_menuitem_get_root(mi) == FALSE) {
			g_warning("Getting a menuitem with id zero, but it's not set as root.");
		}
		return mi;
	}
	find_id_t find_id = {mi: NULL, id: id};
	find_id_helper(mi, &find_id);
	return find_id.mi;
}

/**
 * dbusmenu_menuitem_set_parent:
 * @mi: The #DbusmenuMenuitem for which to set the parent
 * @parent: The new parent #DbusmenuMenuitem
 *
 * Sets the parent of @mi to @parent. If @mi already
 * has a parent, then this call will fail. The parent will
 * be set automatically when using the usual methods to add a
 * child menuitem, so this function should not normally be 
 * called directly 
 *
 * Return value: Whether the parent was set successfully
 */
gboolean
dbusmenu_menuitem_set_parent (DbusmenuMenuitem * mi, DbusmenuMenuitem * parent)
{
	g_return_val_if_fail(DBUSMENU_IS_MENUITEM(mi), FALSE);
	g_return_val_if_fail(DBUSMENU_IS_MENUITEM(mi), FALSE);

	DbusmenuMenuitemPrivate * priv = DBUSMENU_MENUITEM_GET_PRIVATE(mi);

	if (priv->parent != NULL) {
		g_warning ("Menu item already has a parent");
		return FALSE;
	}

	priv->parent = parent;
	g_object_add_weak_pointer(G_OBJECT(priv->parent), (gpointer *)&priv->parent);

	return TRUE;
}

/**
 * dbusmenu_menuitem_unparent:
 * @mi: The #DbusmenuMenuitem to unparent
 *
 * Unparents the menu item @mi. If @mi doesn't have a
 * parent, then this call will fail. The menuitem will
 * be unparented automatically when using the usual methods
 * to delete a child menuitem, so this function should not
 * normally be called directly 
 *
 * Return value: Whether the menu item was unparented successfully
 */
gboolean
dbusmenu_menuitem_unparent (DbusmenuMenuitem * mi)
{
	g_return_val_if_fail(DBUSMENU_IS_MENUITEM(mi), FALSE);
	DbusmenuMenuitemPrivate * priv = DBUSMENU_MENUITEM_GET_PRIVATE(mi);

	if (priv->parent == NULL) {
		g_warning("Menu item doesn't have a parent");
		return FALSE;
	}

	g_object_remove_weak_pointer(G_OBJECT(priv->parent), (gpointer *)&priv->parent);
	priv->parent = NULL;

	return TRUE;
}

/**
 * dbusmenu_menuitem_get_parent:
 * @mi: The #DbusmenuMenuitem for which to inspect the parent
 *
 * This function looks up the parent of @mi
 *
 * Return value: (transfer none): The parent of this menu item
 */
DbusmenuMenuitem *
dbusmenu_menuitem_get_parent (DbusmenuMenuitem * mi)
{
	g_return_val_if_fail(DBUSMENU_IS_MENUITEM(mi), NULL);
	DbusmenuMenuitemPrivate * priv = DBUSMENU_MENUITEM_GET_PRIVATE(mi);

	return priv->parent;
}

/**
 * dbusmenu_menuitem_property_set:
 * @mi: The #DbusmenuMenuitem to set the property on.
 * @property: Name of the property to set.
 * @value: The value of the property.
 * 
 * Takes the pair of @property and @value and places them as a
 * property on @mi.  If a property already exists by that name,
 * then the value is set to the new value.  If not, the property
 * is added.  If the value is changed or the property was previously
 * unset then the signal #DbusmenuMenuitem::prop-changed will be
 * emitted by this function.
 * 
 * Return value:  A boolean representing if the property value was set.
 */
gboolean
dbusmenu_menuitem_property_set (DbusmenuMenuitem * mi, const gchar * property, const gchar * value)
{
	GVariant * variant = NULL;
	if (value != NULL) {
		variant = g_variant_new_string(value);
	}
	return dbusmenu_menuitem_property_set_variant(mi, property, variant);
}

/**
 * dbusmenu_menuitem_property_set_bool:
 * @mi: The #DbusmenuMenuitem to set the property on.
 * @property: Name of the property to set.
 * @value: The value of the property.
 * 
 * Takes a boolean @value and sets it on @property as a
 * property on @mi.  If a property already exists by that name,
 * then the value is set to the new value.  If not, the property
 * is added.  If the value is changed or the property was previously
 * unset then the signal #DbusmenuMenuitem::prop-changed will be
 * emitted by this function.
 * 
 * Return value:  A boolean representing if the property value was set.
 */
gboolean
dbusmenu_menuitem_property_set_bool (DbusmenuMenuitem * mi, const gchar * property, const gboolean value)
{
	GVariant * variant = g_variant_new("b", value);
	return dbusmenu_menuitem_property_set_variant(mi, property, variant);
}

/**
 * dbusmenu_menuitem_property_set_int:
 * @mi: The #DbusmenuMenuitem to set the property on.
 * @property: Name of the property to set.
 * @value: The value of the property.
 * 
 * Takes a boolean @value and sets it on @property as a
 * property on @mi.  If a property already exists by that name,
 * then the value is set to the new value.  If not, the property
 * is added.  If the value is changed or the property was previously
 * unset then the signal #DbusmenuMenuitem::prop-changed will be
 * emitted by this function.
 * 
 * Return value:  A boolean representing if the property value was set.
 */
gboolean
dbusmenu_menuitem_property_set_int (DbusmenuMenuitem * mi, const gchar * property, const gint value)
{
	GVariant * variant = g_variant_new("i", value);
	return dbusmenu_menuitem_property_set_variant(mi, property, variant);
}

/**
 * dbusmenu_menuitem_property_set_byte_array:
 * @mi: The #DbusmenuMenuitem to set the property on.
 * @property: Name of the property to set.
 * @value: The byte array.
 * @nelements: The number of elements in the byte array.
 * 
 * Takes a byte array @value and sets it on @property as a
 * property on @mi.  If a property already exists by that name,
 * then the value is set to the new value.  If not, the property
 * is added.  If the value is changed or the property was previously
 * unset then the signal #DbusmenuMenuitem::prop-changed will be
 * emitted by this function.
 * 
 * Return value:  A boolean representing if the property value was set.
 */
gboolean
dbusmenu_menuitem_property_set_byte_array (DbusmenuMenuitem * mi, const gchar * property, const guchar * value, gsize nelements)
{
	GVariant * variant = NULL;
	if (value != NULL) {
		variant = g_variant_new_fixed_array(G_VARIANT_TYPE_BYTE, value, nelements, sizeof(guchar));
	}
	return dbusmenu_menuitem_property_set_variant(mi, property, variant);
}

/**
 * dbusmenu_menuitem_property_set_variant:
 * @mi: The #DbusmenuMenuitem to set the property on.
 * @property: Name of the property to set.
 * @value: The value of the property.
 * 
 * Takes the pair of @property and @value and places them as a
 * property on @mi.  If a property already exists by that name,
 * then the value is set to the new value.  If not, the property
 * is added.  If the value is changed or the property was previously
 * unset then the signal #DbusmenuMenuitem::prop-changed will be
 * emitted by this function.
 * 
 * Return value:  A boolean representing if the property value was set.
 */
gboolean
dbusmenu_menuitem_property_set_variant (DbusmenuMenuitem * mi, const gchar * property, GVariant * value)
{
	g_return_val_if_fail(DBUSMENU_IS_MENUITEM(mi), FALSE);
	g_return_val_if_fail(property != NULL, FALSE);
	g_return_val_if_fail(g_utf8_validate(property, -1, NULL), FALSE);

	DbusmenuMenuitemPrivate * priv = DBUSMENU_MENUITEM_GET_PRIVATE(mi);
	GVariant * default_value = NULL;

	const gchar * type = menuitem_get_type(mi);

	if (value != NULL) {
		/* Check the expected type to see if we want to have a warning */
		GVariantType * default_type = dbusmenu_defaults_default_get_type(priv->defaults, type, property);
		if (default_type != NULL) {
			/* If we have an expected type we should check to see if
			   the value we've been given is of the same type and generate
			   a warning if it isn't */
			if (!g_variant_is_of_type(value, default_type)) {
				g_warning("Setting menuitem property '%s' with value of type '%s' when expecting '%s'", property, g_variant_get_type_string(value), g_variant_type_peek_string(default_type));
			}
		}
	}

	/* Check the defaults database to see if we have a default
	   for this property. */
	default_value = dbusmenu_defaults_default_get(priv->defaults, type, property);
	if (default_value != NULL && value != NULL) {
		/* Now see if we're setting this to the same value as the
		   default.  If we are then we just want to swallow this variant
		   and make the function behave like we're clearing it. */
		if (g_variant_equal(default_value, value)) {
			g_variant_ref_sink(value);
			g_variant_unref(value);
			value = NULL;
		}
	}

	gboolean replaced = FALSE;
	gboolean remove = FALSE;
	gchar * hash_key = NULL;
	GVariant * hash_variant = NULL;
	gboolean inhash = g_hash_table_lookup_extended(priv->properties, property, (gpointer *)&hash_key, (gpointer *)&hash_variant);

	if (inhash && hash_variant == NULL) {
		g_warning("The property '%s' is in the hash with a NULL variant", property);
		inhash = FALSE;
	}

	if (value != NULL) {
		/* NOTE: We're only marking this as replaced if this is true
		   but we're actually replacing it no matter.  This is so that
		   the variant passed in sticks around which the caller may
		   expect.  They shouldn't, but it's low cost to remove bugs. */
		if (!inhash || (hash_variant != NULL && !g_variant_equal(hash_variant, value))) {
			replaced = TRUE;
		}

		gchar * lprop = g_strdup(property);
		g_variant_ref_sink(value);

		/* Really important that this is _insert as that means the value
		   that we just created in the _strdup is free'd and not the one
		   currently in the hashtable.  That could be the same as the one
		   being passed in and then the signal emit would be done with a
		   bad value */
		g_hash_table_insert(priv->properties, lprop, value);
	} else {
		if (inhash) {
		/* So the question you should be asking if you're paying attention
		   is "Why not just do the remove here?"  It's a good question with
		   an interesting answer.  Bascially it's the same reason as above,
		   in a couple cases the passed in properties is the value in the hash
		   table so we can avoid strdup'ing it by removing it (and thus free'ing
		   it) after the signal emition */
			remove = TRUE;
			replaced = TRUE;
			g_hash_table_steal(priv->properties, property);
		}
	}

	/* NOTE: The actual value is invalid at this point
	   becuse it has been unref'd when replaced in the hash
	   table.  But the fact that there was a value is
	   the imporant part. */
	if (replaced) {
		GVariant * signalval = value;

		if (signalval == NULL) {
			/* Might also be NULL, but if it is we're definitely
			   clearing this thing. */
			signalval = default_value;
		}

		g_signal_emit(G_OBJECT(mi), signals[PROPERTY_CHANGED], 0, property, signalval, TRUE);
	}

	if (remove) {
		g_free(hash_key);
		g_variant_unref(hash_variant);
	}

	return TRUE;
}

/**
 * dbusmenu_menuitem_property_get:
 * @mi: The #DbusmenuMenuitem to look for the property on.
 * @property: The property to grab.
 * 
 * Look up a property on @mi and return the value of it if
 * it exits.  #NULL will be returned if the property doesn't
 * exist.
 * 
 * Return value: (transfer none): A string with the value of the property
 * 	that shouldn't be free'd.  Or #NULL if the property
 * 	is not set or is not a string.
 */
const gchar *
dbusmenu_menuitem_property_get (const DbusmenuMenuitem * mi, const gchar * property)
{
	GVariant * variant = dbusmenu_menuitem_property_get_variant(mi, property);
	if (variant == NULL) return NULL;
	if (!g_variant_type_equal(g_variant_get_type(variant), G_VARIANT_TYPE_STRING)) return NULL;
	return g_variant_get_string(variant, NULL);
}

/**
 * dbusmenu_menuitem_property_get_variant:
 * @mi: The #DbusmenuMenuitem to look for the property on.
 * @property: The property to grab.
 * 
 * Look up a property on @mi and return the value of it if
 * it exits.  #NULL will be returned if the property doesn't
 * exist.
 * 
 * Return value: (transfer none): A GVariant for the property.
 */
GVariant *
dbusmenu_menuitem_property_get_variant (const DbusmenuMenuitem * mi, const gchar * property)
{
	g_return_val_if_fail(DBUSMENU_IS_MENUITEM(mi), NULL);
	g_return_val_if_fail(property != NULL, NULL);

	DbusmenuMenuitemPrivate * priv = DBUSMENU_MENUITEM_GET_PRIVATE(mi);

	GVariant * currentval = (GVariant *)g_hash_table_lookup(priv->properties, property);

	if (currentval == NULL) {
		currentval = dbusmenu_defaults_default_get(priv->defaults, menuitem_get_type(mi), property);
	}

	return currentval;
}

/**
 * dbusmenu_menuitem_property_get_bool:
 * @mi: The #DbusmenuMenuitem to look for the property on.
 * @property: The property to grab.
 * 
 * Look up a property on @mi and return the value of it if
 * it exits.  Returns #FALSE if the property doesn't exist.
 * 
 * Return value: The value of the property or #FALSE.
 */
gboolean
dbusmenu_menuitem_property_get_bool (const DbusmenuMenuitem * mi, const gchar * property)
{
	GVariant * variant = dbusmenu_menuitem_property_get_variant(mi, property);
	if (variant == NULL) return FALSE;

	if (g_variant_type_equal(g_variant_get_type(variant), G_VARIANT_TYPE_BOOLEAN)) {
		return g_variant_get_boolean(variant);
	}

	if (g_variant_type_equal(g_variant_get_type(variant), G_VARIANT_TYPE_STRING)) {
		const gchar * string = g_variant_get_string(variant, NULL);

		if (!g_strcmp0(string, "TRUE") || !g_strcmp0(string, "true") || !g_strcmp0(string, "True")) {
			return TRUE;
		} else {
			return FALSE;
		}
	}

	g_warning("Property '%s' has been requested as an boolean but is not one.", property);
	return FALSE;
}

/**
 * dbusmenu_menuitem_property_get_int:
 * @mi: The #DbusmenuMenuitem to look for the property on.
 * @property: The property to grab.
 * 
 * Look up a property on @mi and return the value of it if
 * it exits.  Returns zero if the property doesn't exist.
 * 
 * Return value: The value of the property or zero.
 */
gint
dbusmenu_menuitem_property_get_int (const DbusmenuMenuitem * mi, const gchar * property)
{
	GVariant * variant = dbusmenu_menuitem_property_get_variant(mi, property);
	if (variant == NULL) return 0;

	if (g_variant_type_equal(g_variant_get_type(variant), G_VARIANT_TYPE_INT32)) {
		return g_variant_get_int32(variant);
	}

	if (g_variant_type_equal(g_variant_get_type(variant), G_VARIANT_TYPE_STRING)) {
		const gchar * string = g_variant_get_string(variant, NULL);
		return atoi(string);
	}

	g_warning("Property '%s' has been requested as an int but is not one.", property);
	return 0;
}

/**
 * dbusmenu_menuitem_property_get_byte_array:
 * @mi: The #DbusmenuMenuitem to look for the property on.
 * @property: The property to grab.
 * @nelements: A pointer to the location to store the number of items (out)
 * 
 * Look up a property on @mi and return the value of it if
 * it exits.  #NULL will be returned if the property doesn't
 * exist.
 * 
 * Return value: (array length=nelements)(element-type guint8)(transfer none): A byte array with the
 * 	value of the property that shouldn't be free'd.  Or #NULL if the property
 * 	is not set or is not a byte array.
 */
const guchar *
dbusmenu_menuitem_property_get_byte_array (const DbusmenuMenuitem * mi, const gchar * property, gsize * nelements)
{
	GVariant * variant = dbusmenu_menuitem_property_get_variant(mi, property);
	if (variant == NULL) {
		*nelements = 0;
		return NULL;
	}
	if (!g_variant_type_equal(g_variant_get_type(variant), G_VARIANT_TYPE("ay"))) return NULL;
	return g_variant_get_fixed_array(variant, nelements, sizeof(guchar));
}

/**
 * dbusmenu_menuitem_property_exist:
 * @mi: The #DbusmenuMenuitem to look for the property on.
 * @property: The property to look for.
 * 
 * Checkes to see if a particular property exists on @mi and 
 * returns #TRUE if so.
 * 
 * Return value: A boolean checking to see if the property is available
 */
gboolean
dbusmenu_menuitem_property_exist (const DbusmenuMenuitem * mi, const gchar * property)
{
	g_return_val_if_fail(DBUSMENU_IS_MENUITEM(mi), FALSE);
	g_return_val_if_fail(property != NULL, FALSE);

	DbusmenuMenuitemPrivate * priv = DBUSMENU_MENUITEM_GET_PRIVATE(mi);

	gpointer value = g_hash_table_lookup(priv->properties, property);

	return value != NULL;
}

/**
 * dbusmenu_menuitem_property_remove:
 * @mi: The #DbusmenuMenuitem to remove the property on.
 * @property: The property to look for.
 * 
 * Removes a property from the menuitem.
 */
void
dbusmenu_menuitem_property_remove (DbusmenuMenuitem * mi, const gchar * property)
{
	g_return_if_fail(DBUSMENU_IS_MENUITEM(mi));
	g_return_if_fail(property != NULL);

	dbusmenu_menuitem_property_set_variant(mi, property, NULL);

	return;
}

/**
 * dbusmenu_menuitem_properties_list:
 * @mi: #DbusmenuMenuitem to list the properties on
 * 
 * This functiong gets a list of the names of all the properties
 * that are set on this menu item.  This data on the list is owned
 * by the menuitem but the list is not and should be freed using
 * g_list_free() when the calling function is done with it.
 * 
 * Return value: (transfer container) (element-type utf8): A list of
 * strings or NULL if there are none.
*/
GList *
dbusmenu_menuitem_properties_list (DbusmenuMenuitem * mi)
{
	g_return_val_if_fail(DBUSMENU_IS_MENUITEM(mi), NULL);

	DbusmenuMenuitemPrivate * priv = DBUSMENU_MENUITEM_GET_PRIVATE(mi);
	return g_hash_table_get_keys(priv->properties);
}

/* Copy the keys and make references to the variants that are
   in the new table.  They'll be free'd and unref'd when the
   Hashtable gets destroyed. */
static void
copy_helper (gpointer in_key, gpointer in_value, gpointer in_data)
{
	GHashTable * table = (GHashTable *)in_data;
	gchar * key = (gchar *)in_key;
	GVariant * value = (GVariant *)in_value;
	g_variant_ref_sink(value);
	g_hash_table_insert(table, g_strdup(key), value);
	return;
}

/**
 * dbusmenu_menuitem_properties_copy:
 * @mi: #DbusmenuMenuitem that we're interested in the properties of
 * 
 * This function takes the properties of a #DbusmenuMenuitem
 * and puts them into a #GHashTable that is referenced by the
 * key of a string and has the value of a string.  The hash
 * table may not have any entries if there aren't any or there
 * is an error in processing.  It is the caller's responsibility
 * to destroy the created #GHashTable.
 * 
 * Return value: (transfer full): A brand new #GHashTable that contains all of
 *    theroperties that are on this #DbusmenuMenuitem @mi.
*/
GHashTable *
dbusmenu_menuitem_properties_copy (DbusmenuMenuitem * mi)
{
	GHashTable * ret = g_hash_table_new_full(g_str_hash, g_str_equal, g_free, _g_variant_unref);

	g_return_val_if_fail(DBUSMENU_IS_MENUITEM(mi), ret);

	DbusmenuMenuitemPrivate * priv = DBUSMENU_MENUITEM_GET_PRIVATE(mi);
	g_hash_table_foreach(priv->properties, copy_helper, ret);

	return ret;
}

/* Looks at each value in the hashtable and tries to convert it
   into a variant and add it to our variant builder */
static void
variant_helper (gpointer in_key, gpointer in_value, gpointer user_data)
{
	GVariant * value = g_variant_new_dict_entry(g_variant_new_string((gchar *)in_key),
	                                            g_variant_new_variant((GVariant *)in_value));
	g_variant_builder_add_value((GVariantBuilder *)user_data, value);
	return;
}

/**
 * dbusmenu_menuitem_properties_variant:
 * @mi: #DbusmenuMenuitem to get properties from
 * 
 * Grabs the properties of the menuitem as a GVariant with the
 * type "a{sv}".
 * 
 * Return Value: (transfer full): A GVariant of type "a{sv}" or NULL on error.
 */
GVariant *
dbusmenu_menuitem_properties_variant (DbusmenuMenuitem * mi, const gchar ** properties)
{
	g_return_val_if_fail(DBUSMENU_IS_MENUITEM(mi), NULL);

	DbusmenuMenuitemPrivate * priv = DBUSMENU_MENUITEM_GET_PRIVATE(mi);

	GVariant * final_variant = NULL;

	if ((properties == NULL || properties[0] == NULL) && g_hash_table_size(priv->properties) > 0) {
		GVariantBuilder builder;
		g_variant_builder_init(&builder, G_VARIANT_TYPE_ARRAY);

		g_hash_table_foreach(priv->properties, variant_helper, &builder);

		final_variant = g_variant_builder_end(&builder);
	}

	if (properties != NULL) {
		GVariantBuilder builder;
		gboolean builder_init = FALSE;
		int i = 0; const gchar * prop;

		for (prop = properties[i]; prop != NULL; prop = properties[++i]) {
			GVariant * propvalue = dbusmenu_menuitem_property_get_variant(mi, prop);

			if (propvalue == NULL) {
				continue;
			}

			if (!builder_init) {
				builder_init = TRUE;
				g_variant_builder_init(&builder, G_VARIANT_TYPE_ARRAY);
			}

			GVariant * dict = g_variant_new_dict_entry(g_variant_new_string((gchar *)prop),
			                                           g_variant_new_variant((GVariant *)propvalue));
			g_variant_builder_add_value(&builder, dict);
		}

		if (builder_init) {
			final_variant = g_variant_builder_end(&builder);
		}
	}

	return final_variant;
}

/**
 * dbusmenu_menuitem_set_root:
 * @mi: #DbusmenuMenuitem to set whether it's root
 * @root: Whether @mi is a root node or not
 * 
 * This function sets the internal value of whether this is a
 * root node or not.
 * 
 * Return value: None
 */
void
dbusmenu_menuitem_set_root (DbusmenuMenuitem * mi, gboolean root)
{
	g_return_if_fail(DBUSMENU_IS_MENUITEM(mi));
	DbusmenuMenuitemPrivate * priv = DBUSMENU_MENUITEM_GET_PRIVATE(mi);
	priv->root = root;
	return;
}

/**
 * dbusmenu_menuitem_get_root:
 * @mi: #DbusmenuMenuitem to see whether it's root
 * 
 * This function returns the internal value of whether this is a
 * root node or not.
 * 
 * Return value: #TRUE if this is a root node
 */
gboolean
dbusmenu_menuitem_get_root (DbusmenuMenuitem * mi)
{
	g_return_val_if_fail(DBUSMENU_IS_MENUITEM(mi), FALSE);
	DbusmenuMenuitemPrivate * priv = DBUSMENU_MENUITEM_GET_PRIVATE(mi);
	return priv->root;
}


/**
 * dbusmenu_menuitem_buildvariant:
 * @mi: #DbusmenuMenuitem to represent in a variant
 * @properties: (element-type utf8): A list of string that will be put into
 *      a variant
 * 
 * This function will put at least one entry if this menu item has no children.
 * If it has children it will put two for this entry, one representing the
 * start tag and one that is a closing tag.  It will allow it's
 * children to place their own tags in the array in between those two.
 *
 * Return value: (transfer full): Variant representing @properties
*/
GVariant *
dbusmenu_menuitem_build_variant (DbusmenuMenuitem * mi, const gchar ** properties, gint recurse)
{
	g_return_val_if_fail(DBUSMENU_IS_MENUITEM(mi), NULL);
	DbusmenuMenuitemPrivate * priv = DBUSMENU_MENUITEM_GET_PRIVATE(mi);
	priv->exposed = TRUE;

	gint id = 0;
	if (!dbusmenu_menuitem_get_root(mi)) {
		id = dbusmenu_menuitem_get_id(mi);
	}

	/* This is the tuple that'll build up being a representation of
	   this entry */
	GVariantBuilder tupleb;
	g_variant_builder_init(&tupleb, G_VARIANT_TYPE_TUPLE);

	/* Add our ID */
	g_variant_builder_add_value(&tupleb, g_variant_new_int32(id));

	/* Figure out the properties */
	GVariant * props = dbusmenu_menuitem_properties_variant(mi, properties);
	if (props != NULL) {
		g_variant_builder_add_value(&tupleb, props);
	} else {
		g_variant_builder_add_value(&tupleb, g_variant_parse(G_VARIANT_TYPE("a{sv}"), "[ ]", NULL, NULL, NULL));
	}

	/* Pillage the children */
	GList * children = dbusmenu_menuitem_get_children(mi);
	if (children == NULL || recurse == 0) {
		g_variant_builder_add_value(&tupleb, g_variant_new_array(G_VARIANT_TYPE_VARIANT, NULL, 0));
	} else {
		GVariantBuilder childrenbuilder;
		g_variant_builder_init(&childrenbuilder, G_VARIANT_TYPE_ARRAY);

		for ( ; children != NULL; children = children->next) {
			GVariant * child = dbusmenu_menuitem_build_variant(DBUSMENU_MENUITEM(children->data), properties, recurse - 1);

			g_variant_builder_add_value(&childrenbuilder, g_variant_new_variant(child));
		}

		g_variant_builder_add_value(&tupleb, g_variant_builder_end(&childrenbuilder));
	}

	return g_variant_builder_end(&tupleb);
}

typedef struct {
	void (*func) (DbusmenuMenuitem * mi, gpointer data);
	gpointer data;
} foreach_struct_t;

static void
foreach_helper (gpointer data, gpointer user_data)
{
	dbusmenu_menuitem_foreach(DBUSMENU_MENUITEM(data), ((foreach_struct_t *)user_data)->func, ((foreach_struct_t *)user_data)->data);
	return;
}

/**
 * dbusmenu_menuitem_foreach:
 * @mi: The #DbusmenItem to start from
 * @func: Function to call on every node in the tree
 * @data: (closure): User data to pass to the function
 * 
 * This calls the function @func on this menu item and all
 * of the children of this item.  And their children.  And
 * their children.  And... you get the point.  It will get
 * called on the whole tree.
*/
void
dbusmenu_menuitem_foreach (DbusmenuMenuitem * mi, void (*func) (DbusmenuMenuitem * mi, gpointer data), gpointer data)
{
	g_return_if_fail(DBUSMENU_IS_MENUITEM(mi));
	g_return_if_fail(func != NULL);

	func(mi, data);
	GList * children = dbusmenu_menuitem_get_children(mi);
	foreach_struct_t foreach_data = {func: func, data: data};
	g_list_foreach(children, foreach_helper, &foreach_data);
	return;
}

/**
 * dbusmenu_menuitem_handle_event:
 * @mi: The #DbusmenuMenuitem to send the signal on.
 * @name: The name of the signal
 * @variant: A value that could be set for the event
 * @timestamp: The timestamp of when the event happened
 * 
 * This function is called to create an event.  It is likely
 * to be overrided by subclasses.  The default menu item
 * will respond to the activate signal and do:
 * 
 * Emits the #DbusmenuMenuitem::item-activate signal on this
 * menu item.  Called by server objects when they get the
 * appropriate DBus signals from the client.
 * 
 * If you subclass this function you should really think
 * about calling the parent function unless you have a good
 * reason not to.
*/
void
dbusmenu_menuitem_handle_event (DbusmenuMenuitem * mi, const gchar * name, GVariant * variant, guint timestamp)
{
	g_return_if_fail(DBUSMENU_IS_MENUITEM(mi));
	#ifdef MASSIVEDEBUGGING
	g_debug("Menuitem %d (%s) is getting event '%s'", ID(mi), LABEL(mi), name);
	#endif
	DbusmenuMenuitemClass * class = DBUSMENU_MENUITEM_GET_CLASS(mi);

	gboolean handled = FALSE;
	if (variant == NULL) {
		variant = g_variant_new_int32(0);
	}

	g_variant_ref_sink(variant);

	g_signal_emit(G_OBJECT(mi), signals[EVENT], g_quark_from_string(name), name, variant, timestamp, &handled);

	if (!handled && class->handle_event != NULL) {
		class->handle_event(mi, name, variant, timestamp);
	}

	g_variant_unref(variant);
}

/**
 * dbusmenu_menuitem_send_about_to_show:
 * @mi: The #DbusmenuMenuitem to send the signal on.
 * @cb: Callback to call when the call has returned.
 * @cb_data: (closure): Data to pass to the callback.
 * 
 * This function is used to send the even that the submenu
 * of this item is about to be shown.  Callers to this event
 * should delay showing the menu until their callback is
 * called if possible.
 */
void
dbusmenu_menuitem_send_about_to_show (DbusmenuMenuitem * mi, void (*cb) (DbusmenuMenuitem * mi, gpointer user_data), gpointer cb_data)
{
	g_return_if_fail(DBUSMENU_IS_MENUITEM(mi));
	#ifdef MASSIVEDEBUGGING
	g_debug("Submenu for menuitem %d (%s) is about to be shown", ID(mi), LABEL(mi));
	#endif
	DbusmenuMenuitemClass * class = DBUSMENU_MENUITEM_GET_CLASS(mi);

	if (class != NULL && class->send_about_to_show != NULL) {
		return class->send_about_to_show(mi, cb, cb_data);
	} else if (cb != NULL) {
		cb(mi, cb_data);
	}

	return;
}

/**
 * dbusmenu_menuitem_show_to_user:
 * @mi: #DbusmenuMenuitem to show
 * @timestamp: The time that the user requested it to be shown
 * 
 * Signals that this menu item should be shown to the user.  If this is
 * server side the server will then take it and send it over the
 * bus.
 */
void
dbusmenu_menuitem_show_to_user (DbusmenuMenuitem * mi, guint timestamp)
{
	g_return_if_fail(DBUSMENU_IS_MENUITEM(mi));

	g_signal_emit(G_OBJECT(mi), signals[SHOW_TO_USER], 0, timestamp, TRUE);

	return;
}

/* Checks to see if the value of this property is unique or just the
   default value. */
gboolean
dbusmenu_menuitem_property_is_default (DbusmenuMenuitem * mi, const gchar * property)
{
	g_return_val_if_fail(DBUSMENU_IS_MENUITEM(mi), FALSE);
	DbusmenuMenuitemPrivate * priv = DBUSMENU_MENUITEM_GET_PRIVATE(mi);

	GVariant * currentval = (GVariant *)g_hash_table_lookup(priv->properties, property);
	if (currentval != NULL) {
		/* If we're storing it locally, then it shouldn't be a default */
		return FALSE;
	}

	/* If we haven't stored it locally, then it's the default */
	return TRUE;
}

/* Check to see if this menu item has been sent into the bus yet or
   not.  If no one cares we can give less info */
gboolean
dbusmenu_menuitem_exposed (DbusmenuMenuitem * mi)
{
	g_return_val_if_fail(DBUSMENU_IS_MENUITEM(mi), FALSE);
	DbusmenuMenuitemPrivate * priv = DBUSMENU_MENUITEM_GET_PRIVATE(mi);
	return priv->exposed;
}