summaryrefslogtreecommitdiff
path: root/legacy/eet/src/lib/Eet.h
blob: a3f5bdbcd94054b32632428359aaaba3f911f6d4 (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
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
#ifndef _EET_H
#define _EET_H

#include <stdlib.h>
#include <stdio.h>
#include <Eina.h>

#ifdef EAPI
# undef EAPI
#endif

#ifdef _WIN32
# ifdef EFL_EET_BUILD
#  ifdef DLL_EXPORT
#   define EAPI __declspec(dllexport)
#  else
#   define EAPI
#  endif /* ! DLL_EXPORT */
# else
#  define EAPI __declspec(dllimport)
# endif /* ! EFL_EET_BUILD */
#else
# ifdef __GNUC__
#  if __GNUC__ >= 4
#   define EAPI __attribute__ ((visibility("default")))
#  else
#   define EAPI
#  endif
# else
#  define EAPI
# endif
#endif /* ! _WIN32 */

#ifdef __cplusplus
extern "C" {
#endif

  /**
   * @file Eet.h
   * @brief The file that provides the eet functions.
   *
   * This header provides the Eet management functions.
   *
   */

  /**
   * @defgroup Eet_Group Top level functions
   * Functions that affect Eet as a whole.
   *
   * @{
   */

  /**
   * @enum _Eet_Error
   * All the error identifiers known by Eet.
   */
   typedef enum _Eet_Error
     {
       EET_ERROR_NONE, /**< No error, it's all fine! */
       EET_ERROR_BAD_OBJECT, /**< Given object or handle is NULL or invalid */
       EET_ERROR_EMPTY, /**< There was nothing to do */
       EET_ERROR_NOT_WRITABLE, /**< Could not write to file or fine is #EET_FILE_MODE_READ */
       EET_ERROR_OUT_OF_MEMORY, /**< Could not allocate memory */
       EET_ERROR_WRITE_ERROR, /**< Failed to write data to destination */
       EET_ERROR_WRITE_ERROR_FILE_TOO_BIG, /**< Failed to write file since it is too big */
       EET_ERROR_WRITE_ERROR_IO_ERROR, /**< Failed to write since generic Input/Output error */
       EET_ERROR_WRITE_ERROR_OUT_OF_SPACE, /**< Failed to write due out of space */
       EET_ERROR_WRITE_ERROR_FILE_CLOSED, /**< Failed to write because file was closed */
       EET_ERROR_MMAP_FAILED, /**< Could not mmap file */
       EET_ERROR_X509_ENCODING_FAILED, /**< Could not encode using X509 */
       EET_ERROR_SIGNATURE_FAILED, /**< Could not validate signature */
       EET_ERROR_INVALID_SIGNATURE, /**< Signature is invalid */
       EET_ERROR_NOT_SIGNED, /**< File or contents are not signed */
       EET_ERROR_NOT_IMPLEMENTED, /**< Function is not implemented */
       EET_ERROR_PRNG_NOT_SEEDED, /**< Could not introduce random seed */
       EET_ERROR_ENCRYPT_FAILED, /**< Could not encrypt contents */
       EET_ERROR_DECRYPT_FAILED /**< Could not decrypt contents */
     } Eet_Error; /**< Eet error identifiers */

  /**
   * @}
   */

   /**
    * Initialize the EET library.
    *
    * @return The new init count.
    *
    * @since 1.0.0
    * @ingroup Eet_Group
    */
   EAPI int eet_init(void);

   /**
    * Shut down the EET library.
    *
    * @return The new init count.
    *
    * @since 1.0.0
    * @ingroup Eet_Group
    */
   EAPI int eet_shutdown(void);

   /**
    * Clear eet cache
    *
    * Eet didn't free items by default. If you are under memory
    * presure, just call this function to recall all memory that are
    * not yet referenced anymore.  The cache take care of modification
    * on disk.
    *
    * @since 1.0.0
    * @ingroup Eet_Group
    */
   EAPI void eet_clearcache(void);


  /**
    * @defgroup Eet_File_Group Eet File Main Functions
    *
    * Functions to create, destroy and do basic manipulation of
    * #Eet_File handles.
    *
    * @{
    */

  /**
   * @enum _Eet_File_Mode
   * Modes that a file can be opened.
   */
   typedef enum _Eet_File_Mode
     {
	EET_FILE_MODE_INVALID = -1,
	EET_FILE_MODE_READ, /**< File is read-only. */
	EET_FILE_MODE_WRITE, /**< File is write-only. */
	EET_FILE_MODE_READ_WRITE /**< File is for both read and write */
     } Eet_File_Mode; /**< Modes that a file can be opened. */

  /**
   * @typedef Eet_File
   * Opaque handle that defines an Eet file (or memory).
   *
   * @see eet_open()
   * @see eet_memopen_read()
   * @see eet_close()
   */
   typedef struct _Eet_File Eet_File;

  /**
   * @typedef Eet_Dictionary
   * Opaque handle that defines a file-backed (mmaped) dictionary of strings.
   */
   typedef struct _Eet_Dictionary Eet_Dictionary;


  /**
   * @}
   */

   /**
    * Open an eet file on disk, and returns a handle to it.
    * @param file The file path to the eet file. eg: @c "/tmp/file.eet".
    * @param mode The mode for opening. Either #EET_FILE_MODE_READ,
    *        #EET_FILE_MODE_WRITE or #EET_FILE_MODE_READ_WRITE.
    * @return An opened eet file handle.
    * @ingroup Eet_File_Group
    *
    * This function will open an exiting eet file for reading, and build
    * the directory table in memory and return a handle to the file, if it
    * exists and can be read, and no memory errors occur on the way, otherwise
    * NULL will be returned.
    *
    * It will also open an eet file for writing. This will, if successful,
    * delete the original file and replace it with a new empty file, till
    * the eet file handle is closed or flushed. If it cannot be opened for
    * writing or a memory error occurs, NULL is returned.
    *
    * You can also open the file for read/write. If you then write a key that
    * does not exist it will be created, if the key exists it will be replaced
    * by the new data.
    *
    * Example:
    * @code
    * #include <Eet.h>
    * #include <stdio.h>
    * #include <string.h>
    *
    * int
    * main(int argc, char **argv)
    * {
    *   Eet_File *ef;
    *   char buf[1024], *ret, **list;
    *   int size, num, i;
    *
    *   eet_init();
    *
    *   strcpy(buf, "Here is a string of data to save!");
    *
    *   ef = eet_open("/tmp/my_file.eet", EET_FILE_MODE_WRITE);
    *   if (!ef) return -1;
    *   if (!eet_write(ef, "/key/to_store/at", buf, 1024, 1))
    *     fprintf(stderr, "Error writing data!\n");
    *   eet_close(ef);
    *
    *   ef = eet_open("/tmp/my_file.eet", EET_FILE_MODE_READ);
    *   if (!ef) return -1;
    *   list = eet_list(ef, "*", &num);
    *   if (list)
    *     {
    *       for (i = 0; i < num; i++)
    *         printf("Key stored: %s\n", list[i]);
    *       free(list);
    *     }
    *   ret = eet_read(ef, "/key/to_store/at", &size);
    *   if (ret)
    *     {
    *       printf("Data read (%i bytes):\n%s\n", size, ret);
    *       free(ret);
    *     }
    *   eet_close(ef);
    *
    *   eet_shutdown();
    *
    *   return 0;
    * }
    * @endcode
    *
    * @since 1.0.0
    */
   EAPI Eet_File *eet_open(const char *file, Eet_File_Mode mode);

   /**
    * Open an eet file directly from a memory location. The data are not copied,
    * so you must keep them around as long as the eet file is open. Their is
    * currently no cache for this kind of Eet_File, so it's reopen every time
    * you do use eet_memopen_read.
    *
    * @since 1.1.0
    * @ingroup Eet_File_Group
    */
   EAPI Eet_File *eet_memopen_read(const void *data, size_t size);

   /**
    * Get the mode an Eet_File was opened with.
    * @param ef A valid eet file handle.
    * @return The mode ef was opened with.
    *
    * @since 1.0.0
    * @ingroup Eet_File_Group
    */
   EAPI Eet_File_Mode eet_mode_get(Eet_File *ef);

   /**
    * Close an eet file handle and flush and writes pending.
    * @param ef A valid eet file handle.
    *
    * This function will flush any pending writes to disk if the eet file
    * was opened for write, and free all data associated with the file handle
    * and file, and close the file.
    *
    * If the eet file handle is not valid nothing will be done.
    *
    * @since 1.0.0
    * @ingroup Eet_File_Group
    */
   EAPI Eet_Error eet_close(Eet_File *ef);

   /**
    * Return a handle to the shared string dictionary of the Eet file
    * @param ef A valid eet file handle.
    * @return A handle to the dictionary of the file
    *
    * This function returns a handle to the dictionary of an Eet file whose
    * handle is @p ef, if a dictionary exists. NULL is returned otherwise or
    * if the file handle is known to be invalid.
    *
    * @see eet_dictionary_string_check() to know if given string came
    *      from the dictionary or it was dynamically allocated using
    *      the #Eet_Data_Descriptor_Class instructrions.
    *
    * @since 1.0.0
    * @ingroup Eet_File_Group
    */
   EAPI Eet_Dictionary *eet_dictionary_get(Eet_File *ef);

   /**
    * Check if a given string comes from a given dictionary
    * @param ed A valid dictionary handle
    * @param string A valid 0 byte terminated C string
    * @return 1 if it is in the dictionary, 0 otherwise
    *
    * This checks the given dictionary to see if the given string is actually
    * inside that dictionary (i.e. comes from it) and returns 1 if it does.
    * If the dictionary handle is invlide, the string is NULL or the string is
    * not in the dictionary, 0 is returned.
    *
    * @since 1.0.0
    * @ingroup Eet_File_Group
    */
   EAPI int eet_dictionary_string_check(Eet_Dictionary *ed, const char *string);

   /**
    * Read a specified entry from an eet file and return data
    * @param ef A valid eet file handle opened for reading.
    * @param name Name of the entry. eg: "/base/file_i_want".
    * @param size_ret Number of bytes read from entry and returned.
    * @return The data stored in that entry in the eet file.
    *
    * This function finds an entry in the eet file that is stored under the
    * name specified, and returns that data, decompressed, if successful.
    * NULL is returned if the lookup fails or if memory errors are
    * encountered. It is the job of the calling program to call free() on
    * the returned data. The number of bytes in the returned data chunk are
    * placed in size_ret.
    *
    * If the eet file handle is not valid NULL is returned and size_ret is
    * filled with 0.
    *
    * @see eet_read_cipher()
    *
    * @since 1.0.0
    * @ingroup Eet_File_Group
    */
   EAPI void *eet_read(Eet_File *ef, const char *name, int *size_ret);

   /**
    * Read a specified entry from an eet file and return data
    * @param ef A valid eet file handle opened for reading.
    * @param name Name of the entry. eg: "/base/file_i_want".
    * @param size_ret Number of bytes read from entry and returned.
    * @return The data stored in that entry in the eet file.
    *
    * This function finds an entry in the eet file that is stored under the
    * name specified, and returns that data if not compressed and successful.
    * NULL is returned if the lookup fails or if memory errors are
    * encountered or if the data is comrpessed. The calling program must never
    * call free() on the returned data. The number of bytes in the returned
    * data chunk are placed in size_ret.
    *
    * If the eet file handle is not valid NULL is returned and size_ret is
    * filled with 0.
    *
    * @since 1.0.0
    * @ingroup Eet_File_Group
    */
   EAPI const void *eet_read_direct(Eet_File *ef, const char *name, int *size_ret);

   /**
    * Write a specified entry to an eet file handle
    * @param ef A valid eet file handle opened for writing.
    * @param name Name of the entry. eg: "/base/file_i_want".
    * @param data Pointer to the data to be stored.
    * @param size Length in bytes in the data to be stored.
    * @param compress Compression flags (1 == compress, 0 = don't compress).
    * @return bytes written on successful write, 0 on failure.
    *
    * This function will write the specified chunk of data to the eet file
    * and return greater than 0 on success. 0 will be returned on failure.
    *
    * The eet file handle must be a valid file handle for an eet file opened
    * for writing. If it is not, 0 will be returned and no action will be
    * performed.
    *
    * Name, and data must not be NULL, and size must be > 0. If these
    * conditions are not met, 0 will be returned.
    *
    * The data will be copied (and optionally compressed) in ram, pending
    * a flush to disk (it will stay in ram till the eet file handle is
    * closed though).
    *
    * @see eet_write_cipher()
    *
    * @since 1.0.0
    * @ingroup Eet_File_Group
    */
   EAPI int eet_write(Eet_File *ef, const char *name, const void *data, int size, int compress);

   /**
    * Delete a specified entry from an Eet file being written or re-written
    * @param ef A valid eet file handle opened for writing.
    * @param name Name of the entry. eg: "/base/file_i_want".
    * @return Success or failure of the delete.
    *
    * This function will delete the specified chunk of data from the eet file
    * and return greater than 0 on success. 0 will be returned on failure.
    *
    * The eet file handle must be a valid file handle for an eet file opened
    * for writing. If it is not, 0 will be returned and no action will be
    * performed.
    *
    * Name, must not be NULL, otherwise 0 will be returned.
    *
    * @since 1.0.0
    * @ingroup Eet_File_Group
    */
   EAPI int eet_delete(Eet_File *ef, const char *name);

   /**
    * List all entries in eet file matching shell glob.
    * @param ef A valid eet file handle.
    * @param glob A shell glob to match against.
    * @param count_ret Number of entries found to match.
    * @return Pointer to an array of strings.
    *
    * This function will list all entries in the eet file matching the
    * supplied shell glob and return an allocated list of their names, if
    * there are any, and if no memory errors occur.
    *
    * The eet file handle must be valid and glob must not be NULL, or NULL
    * will be returned and count_ret will be filled with 0.
    *
    * The calling program must call free() on the array returned, but NOT
    * on the string pointers in the array. They are taken as read-only
    * internals from the eet file handle. They are only valid as long as
    * the file handle is not closed. When it is closed those pointers in the
    * array are now not valid and should not be used.
    *
    * On success the array returned will have a list of string pointers
    * that are the names of the entries that matched, and count_ret will have
    * the number of entries in this array placed in it.
    *
    * Hint: an easy way to list all entries in an eet file is to use a glob
    * value of "*".
    *
    * @since 1.0.0
    * @ingroup Eet_File_Group
    */
   EAPI char **eet_list(Eet_File *ef, const char *glob, int *count_ret);

   /**
    * Return the number of entries in the specified eet file.
    * @param ef A valid eet file handle.
    * @return Number of entries in ef or -1 if the number of entries
    *         cannot be read due to open mode restrictions.
    *
    * @since 1.0.0
    * @ingroup Eet_File_Group
    */
   EAPI int eet_num_entries(Eet_File *ef);

   /**
    * @defgroup Eet_File_Cipher_Group Eet File Ciphered Main Functions
    *
    * Most of the @ref Eet_File_Group have alternative versions that
    * accounts for ciphers to protect their content.
    *
    * @see @ref Eet_Cipher_Group
    *
    * @ingroup Eet_File_Group
    */

   /**
    * Read a specified entry from an eet file and return data using a cipher.
    * @param ef A valid eet file handle opened for reading.
    * @param name Name of the entry. eg: "/base/file_i_want".
    * @param size_ret Number of bytes read from entry and returned.
    * @param cipher_key The key to use as cipher.
    * @return The data stored in that entry in the eet file.
    *
    * This function finds an entry in the eet file that is stored under the
    * name specified, and returns that data, decompressed, if successful.
    * NULL is returned if the lookup fails or if memory errors are
    * encountered. It is the job of the calling program to call free() on
    * the returned data. The number of bytes in the returned data chunk are
    * placed in size_ret.
    *
    * If the eet file handle is not valid NULL is returned and size_ret is
    * filled with 0.
    *
    * @see eet_read()
    *
    * @since 1.0.0
    * @ingroup Eet_File_Cipher_Group
    */
   EAPI void *eet_read_cipher(Eet_File *ef, const char *name, int *size_ret, const char *cipher_key);

   /**
    * Write a specified entry to an eet file handle using a cipher.
    * @param ef A valid eet file handle opened for writing.
    * @param name Name of the entry. eg: "/base/file_i_want".
    * @param data Pointer to the data to be stored.
    * @param size Length in bytes in the data to be stored.
    * @param compress Compression flags (1 == compress, 0 = don't compress).
    * @param cipher_key The key to use as cipher.
    * @return bytes written on successful write, 0 on failure.
    *
    * This function will write the specified chunk of data to the eet file
    * and return greater than 0 on success. 0 will be returned on failure.
    *
    * The eet file handle must be a valid file handle for an eet file opened
    * for writing. If it is not, 0 will be returned and no action will be
    * performed.
    *
    * Name, and data must not be NULL, and size must be > 0. If these
    * conditions are not met, 0 will be returned.
    *
    * The data will be copied (and optionally compressed) in ram, pending
    * a flush to disk (it will stay in ram till the eet file handle is
    * closed though).
    *
    * @see eet_write()
    *
    * @since 1.0.0
    * @ingroup Eet_File_Cipher_Group
    */
   EAPI int eet_write_cipher(Eet_File *ef, const char *name, const void *data, int size, int compress, const char *cipher_key);


   /**
    * @defgroup Eet_File_Image_Group Image Store and Load
    *
    * Eet efficiently stores and loads images, including alpha
    * channels and lossy compressions.
    */

   /**
    * Read just the header data for an image and dont decode the pixels.
    * @param ef A valid eet file handle opened for reading.
    * @param name Name of the entry. eg: "/base/file_i_want".
    * @param w A pointer to the unsigned int to hold the width in pixels.
    * @param h A pointer to the unsigned int to hold the height in pixels.
    * @param alpha A pointer to the int to hold the alpha flag.
    * @param compress A pointer to the int to hold the compression amount.
    * @param quality A pointer to the int to hold the quality amount.
    * @param lossy A pointer to the int to hold the lossiness flag.
    * @return 1 on successfull decode, 0 otherwise
    *
    * This function reads an image from an eet file stored under the named
    * key in the eet file and return a pointer to the decompressed pixel data.
    *
    * The other parameters of the image (width, height etc.) are placed into
    * the values pointed to (they must be supplied). The pixel data is a linear
    * array of pixels starting from the top-left of the image scanning row by
    * row from left to right. Each pile is a 32bit value, with the high byte
    * being the alpha channel, the next being red, then green, and the low byte
    * being blue. The width and height are measured in pixels and will be
    * greater than 0 when returned. The alpha flag is either 0 or 1. 0 denotes
    * that the alpha channel is not used. 1 denotes that it is significant.
    * Compress is filled with the compression value/amount the image was
    * stored with. The quality value is filled with the quality encoding of
    * the image file (0 - 100). The lossy flags is either 0 or 1 as to if
    * the image was encoded lossily or not.
    *
    * On success the function returns 1 indicating the header was read and
    * decoded properly, or 0 on failure.
    *
    * @see eet_data_image_header_read_cipher()
    *
    * @since 1.0.0
    * @ingroup Eet_File_Image_Group
    */
   EAPI int eet_data_image_header_read(Eet_File *ef, const char *name, unsigned int *w, unsigned int *h, int *alpha, int *compress, int *quality, int *lossy);

   /**
    * Read image data from the named key in the eet file.
    * @param ef A valid eet file handle opened for reading.
    * @param name Name of the entry. eg: "/base/file_i_want".
    * @param w A pointer to the unsigned int to hold the width in pixels.
    * @param h A pointer to the unsigned int to hold the height in pixels.
    * @param alpha A pointer to the int to hold the alpha flag.
    * @param compress A pointer to the int to hold the compression amount.
    * @param quality A pointer to the int to hold the quality amount.
    * @param lossy A pointer to the int to hold the lossiness flag.
    * @return The image pixel data decoded
    *
    * This function reads an image from an eet file stored under the named
    * key in the eet file and return a pointer to the decompressed pixel data.
    *
    * The other parameters of the image (width, height etc.) are placed into
    * the values pointed to (they must be supplied). The pixel data is a linear
    * array of pixels starting from the top-left of the image scanning row by
    * row from left to right. Each pile is a 32bit value, with the high byte
    * being the alpha channel, the next being red, then green, and the low byte
    * being blue. The width and height are measured in pixels and will be
    * greater than 0 when returned. The alpha flag is either 0 or 1. 0 denotes
    * that the alpha channel is not used. 1 denotes that it is significant.
    * Compress is filled with the compression value/amount the image was
    * stored with. The quality value is filled with the quality encoding of
    * the image file (0 - 100). The lossy flags is either 0 or 1 as to if
    * the image was encoded lossily or not.
    *
    * On success the function returns a pointer to the image data decoded. The
    * calling application is responsible for calling free() on the image data
    * when it is done with it. On failure NULL is returned and the parameter
    * values may not contain any sensible data.
    *
    * @see eet_data_image_read_cipher()
    *
    * @since 1.0.0
    * @ingroup Eet_File_Image_Group
    */
   EAPI void *eet_data_image_read(Eet_File *ef, const char *name, unsigned int *w, unsigned int *h, int *alpha, int *compress, int *quality, int *lossy);

   /**
    * Read image data from the named key in the eet file.
    * @param ef A valid eet file handle opened for reading.
    * @param name Name of the entry. eg: "/base/file_i_want".
    * @param src_x The starting x coordinate from where to dump the stream.
    * @param src_y The starting y coordinate from where to dump the stream.
    * @param d A pointer to the pixel surface.
    * @param w The expected width in pixels of the pixel surface to decode.
    * @param h The expected height in pixels of the pixel surface to decode.
    * @param row_stride The length of a pixels line in the destination surface.
    * @param alpha A pointer to the int to hold the alpha flag.
    * @param compress A pointer to the int to hold the compression amount.
    * @param quality A pointer to the int to hold the quality amount.
    * @param lossy A pointer to the int to hold the lossiness flag.
    * @return 1 on success, 0 otherwise.
    *
    * This function reads an image from an eet file stored under the named
    * key in the eet file and return a pointer to the decompressed pixel data.
    *
    * The other parameters of the image (width, height etc.) are placed into
    * the values pointed to (they must be supplied). The pixel data is a linear
    * array of pixels starting from the top-left of the image scanning row by
    * row from left to right. Each pile is a 32bit value, with the high byte
    * being the alpha channel, the next being red, then green, and the low byte
    * being blue. The width and height are measured in pixels and will be
    * greater than 0 when returned. The alpha flag is either 0 or 1. 0 denotes
    * that the alpha channel is not used. 1 denotes that it is significant.
    * Compress is filled with the compression value/amount the image was
    * stored with. The quality value is filled with the quality encoding of
    * the image file (0 - 100). The lossy flags is either 0 or 1 as to if
    * the image was encoded lossily or not.
    *
    * On success the function returns 1, and 0 on failure. On failure the
    * parameter values may not contain any sensible data.
    *
    * @see eet_data_image_read_to_surface_cipher()
    *
    * @since 1.0.2
    * @ingroup Eet_File_Image_Group
    */
   EAPI int eet_data_image_read_to_surface(Eet_File *ef, const char *name, unsigned int src_x, unsigned int src_y, unsigned int *d, unsigned int w, unsigned int h, unsigned int row_stride, int *alpha, int *compress, int *quality, int *lossy);

   /**
    * Write image data to the named key in an eet file.
    * @param ef A valid eet file handle opened for writing.
    * @param name Name of the entry. eg: "/base/file_i_want".
    * @param data A pointer to the image pixel data.
    * @param w The width of the image in pixels.
    * @param h The height of the image in pixels.
    * @param alpha The alpha channel flag.
    * @param compress The compression amount.
    * @param quality The quality encoding amount.
    * @param lossy The lossiness flag.
    * @return Success if the data was encoded and written or not.
    *
    * This function takes image pixel data and encodes it in an eet file
    * stored under the supplied name key, and returns how many bytes were
    * actually written to encode the image data.
    *
    * The data expected is the same format as returned by eet_data_image_read.
    * If this is not the case weird things may happen. Width and height must
    * be between 1 and 8000 pixels. The alpha flags can be 0 or 1 (0 meaning
    * the alpha values are not useful and 1 meaning they are). Compress can
    * be from 0 to 9 (0 meaning no compression, 9 meaning full compression).
    * This is only used if the image is not lossily encoded. Quality is used on
    * lossy compression and should be a value from 0 to 100. The lossy flag
    * can be 0 or 1. 0 means encode losslessly and 1 means to encode with
    * image quality loss (but then have a much smaller encoding).
    *
    * On success this function returns the number of bytes that were required
    * to encode the image data, or on failure it returns 0.
    *
    * @see eet_data_image_write_cipher()
    *
    * @since 1.0.0
    * @ingroup Eet_File_Image_Group
    */
   EAPI int eet_data_image_write(Eet_File *ef, const char *name, const void *data, unsigned int w, unsigned int h, int alpha, int compress, int quality, int lossy);

   /**
    * Decode Image data header only to get information.
    * @param data The encoded pixel data.
    * @param size The size, in bytes, of the encoded pixel data.
    * @param w A pointer to the unsigned int to hold the width in pixels.
    * @param h A pointer to the unsigned int to hold the height in pixels.
    * @param alpha A pointer to the int to hold the alpha flag.
    * @param compress A pointer to the int to hold the compression amount.
    * @param quality A pointer to the int to hold the quality amount.
    * @param lossy A pointer to the int to hold the lossiness flag.
    * @return 1 on success, 0 on failure.
    *
    * This function takes encoded pixel data and decodes it into raw RGBA
    * pixels on success.
    *
    * The other parameters of the image (width, height etc.) are placed into
    * the values pointed to (they must be supplied). The pixel data is a linear
    * array of pixels starting from the top-left of the image scanning row by
    * row from left to right. Each pixel is a 32bit value, with the high byte
    * being the alpha channel, the next being red, then green, and the low byte
    * being blue. The width and height are measured in pixels and will be
    * greater than 0 when returned. The alpha flag is either 0 or 1. 0 denotes
    * that the alpha channel is not used. 1 denotes that it is significant.
    * Compress is filled with the compression value/amount the image was
    * stored with. The quality value is filled with the quality encoding of
    * the image file (0 - 100). The lossy flags is either 0 or 1 as to if
    * the image was encoded lossily or not.
    *
    * On success the function returns 1 indicating the header was read and
    * decoded properly, or 0 on failure.
    *
    * @see eet_data_image_header_decode_cipher()
    *
    * @since 1.0.0
    * @ingroup Eet_File_Image_Group
    */
   EAPI int eet_data_image_header_decode(const void *data, int size, unsigned int *w, unsigned int *h, int *alpha, int *compress, int *quality, int *lossy);

   /**
    * Decode Image data into pixel data.
    * @param data The encoded pixel data.
    * @param size The size, in bytes, of the encoded pixel data.
    * @param w A pointer to the unsigned int to hold the width in pixels.
    * @param h A pointer to the unsigned int to hold the height in pixels.
    * @param alpha A pointer to the int to hold the alpha flag.
    * @param compress A pointer to the int to hold the compression amount.
    * @param quality A pointer to the int to hold the quality amount.
    * @param lossy A pointer to the int to hold the lossiness flag.
    * @return The image pixel data decoded
    *
    * This function takes encoded pixel data and decodes it into raw RGBA
    * pixels on success.
    *
    * The other parameters of the image (width, height etc.) are placed into
    * the values pointed to (they must be supplied). The pixel data is a linear
    * array of pixels starting from the top-left of the image scanning row by
    * row from left to right. Each pixel is a 32bit value, with the high byte
    * being the alpha channel, the next being red, then green, and the low byte
    * being blue. The width and height are measured in pixels and will be
    * greater than 0 when returned. The alpha flag is either 0 or 1. 0 denotes
    * that the alpha channel is not used. 1 denotes that it is significant.
    * Compress is filled with the compression value/amount the image was
    * stored with. The quality value is filled with the quality encoding of
    * the image file (0 - 100). The lossy flags is either 0 or 1 as to if
    * the image was encoded lossily or not.
    *
    * On success the function returns a pointer to the image data decoded. The
    * calling application is responsible for calling free() on the image data
    * when it is done with it. On failure NULL is returned and the parameter
    * values may not contain any sensible data.
    *
    * @see eet_data_image_decode_cipher()
    *
    * @since 1.0.0
    * @ingroup Eet_File_Image_Group
    */
   EAPI void *eet_data_image_decode(const void *data, int size, unsigned int *w, unsigned int *h, int *alpha, int *compress, int *quality, int *lossy);

   /**
    * Decode Image data into pixel data.
    * @param data The encoded pixel data.
    * @param size The size, in bytes, of the encoded pixel data.
    * @param src_x The starting x coordinate from where to dump the stream.
    * @param src_y The starting y coordinate from where to dump the stream.
    * @param d A pointer to the pixel surface.
    * @param w The expected width in pixels of the pixel surface to decode.
    * @param h The expected height in pixels of the pixel surface to decode.
    * @param row_stride The length of a pixels line in the destination surface.
    * @param alpha A pointer to the int to hold the alpha flag.
    * @param compress A pointer to the int to hold the compression amount.
    * @param quality A pointer to the int to hold the quality amount.
    * @param lossy A pointer to the int to hold the lossiness flag.
    * @return 1 on success, 0 otherwise.
    *
    * This function takes encoded pixel data and decodes it into raw RGBA
    * pixels on success.
    *
    * The other parameters of the image (alpha, compress etc.) are placed into
    * the values pointed to (they must be supplied). The pixel data is a linear
    * array of pixels starting from the top-left of the image scanning row by
    * row from left to right. Each pixel is a 32bit value, with the high byte
    * being the alpha channel, the next being red, then green, and the low byte
    * being blue. The width and height are measured in pixels and will be
    * greater than 0 when returned. The alpha flag is either 0 or 1. 0 denotes
    * that the alpha channel is not used. 1 denotes that it is significant.
    * Compress is filled with the compression value/amount the image was
    * stored with. The quality value is filled with the quality encoding of
    * the image file (0 - 100). The lossy flags is either 0 or 1 as to if
    * the image was encoded lossily or not.
    *
    * On success the function returns 1, and 0 on failure. On failure the
    * parameter values may not contain any sensible data.
    *
    * @see eet_data_image_decode_to_surface_cipher()
    *
    * @since 1.0.2
    * @ingroup Eet_File_Image_Group
    */
   EAPI int eet_data_image_decode_to_surface(const void *data, int size, unsigned int src_x, unsigned int src_y, unsigned int *d, unsigned int w, unsigned int h, unsigned int row_stride, int *alpha, int *compress, int *quality, int *lossy);

   /**
    * Encode image data for storage or transmission.
    * @param data A pointer to the image pixel data.
    * @param size_ret A pointer to an int to hold the size of the returned data.
    * @param w The width of the image in pixels.
    * @param h The height of the image in pixels.
    * @param alpha The alpha channel flag.
    * @param compress The compression amount.
    * @param quality The quality encoding amount.
    * @param lossy The lossiness flag.
    * @return The encoded image data.
    *
    * This function stakes image pixel data and encodes it with compression and
    * possible loss of quality (as a trade off for size) for storage or
    * transmission to another system.
    *
    * The data expected is the same format as returned by eet_data_image_read.
    * If this is not the case weird things may happen. Width and height must
    * be between 1 and 8000 pixels. The alpha flags can be 0 or 1 (0 meaning
    * the alpha values are not useful and 1 meaning they are). Compress can
    * be from 0 to 9 (0 meaning no compression, 9 meaning full compression).
    * This is only used if the image is not lossily encoded. Quality is used on
    * lossy compression and should be a value from 0 to 100. The lossy flag
    * can be 0 or 1. 0 means encode losslessly and 1 means to encode with
    * image quality loss (but then have a much smaller encoding).
    *
    * On success this function returns a pointer to the encoded data that you
    * can free with free() when no longer needed.
    *
    * @see eet_data_image_encode_cipher()
    *
    * @since 1.0.0
    * @ingroup Eet_File_Image_Group
    */
   EAPI void *eet_data_image_encode(const void *data, int *size_ret, unsigned int w, unsigned int h, int alpha, int compress, int quality, int lossy);

   /**
    * @defgroup Eet_File_Image_Cipher_Group Image Store and Load using a Cipher
    *
    * Most of the @ref Eet_File_Image_Group have alternative versions
    * that accounts for ciphers to protect their content.
    *
    * @see @ref Eet_Cipher_Group
    *
    * @ingroup Eet_File_Image_Group
    */

   /**
    * Read just the header data for an image and dont decode the pixels using a cipher.
    * @param ef A valid eet file handle opened for reading.
    * @param name Name of the entry. eg: "/base/file_i_want".
    * @param cipher_key The key to use as cipher.
    * @param w A pointer to the unsigned int to hold the width in pixels.
    * @param h A pointer to the unsigned int to hold the height in pixels.
    * @param alpha A pointer to the int to hold the alpha flag.
    * @param compress A pointer to the int to hold the compression amount.
    * @param quality A pointer to the int to hold the quality amount.
    * @param lossy A pointer to the int to hold the lossiness flag.
    * @return 1 on successfull decode, 0 otherwise
    *
    * This function reads an image from an eet file stored under the named
    * key in the eet file and return a pointer to the decompressed pixel data.
    *
    * The other parameters of the image (width, height etc.) are placed into
    * the values pointed to (they must be supplied). The pixel data is a linear
    * array of pixels starting from the top-left of the image scanning row by
    * row from left to right. Each pile is a 32bit value, with the high byte
    * being the alpha channel, the next being red, then green, and the low byte
    * being blue. The width and height are measured in pixels and will be
    * greater than 0 when returned. The alpha flag is either 0 or 1. 0 denotes
    * that the alpha channel is not used. 1 denotes that it is significant.
    * Compress is filled with the compression value/amount the image was
    * stored with. The quality value is filled with the quality encoding of
    * the image file (0 - 100). The lossy flags is either 0 or 1 as to if
    * the image was encoded lossily or not.
    *
    * On success the function returns 1 indicating the header was read and
    * decoded properly, or 0 on failure.
    *
    * @see eet_data_image_header_read()
    *
    * @since 1.0.0
    * @ingroup Eet_File_Image_Cipher_Group
    */
   EAPI int eet_data_image_header_read_cipher(Eet_File *ef, const char *name, const char *cipher_key, unsigned int *w, unsigned int *h, int *alpha, int *compress, int *quality, int *lossy);

   /**
    * Read image data from the named key in the eet file using a cipher.
    * @param ef A valid eet file handle opened for reading.
    * @param name Name of the entry. eg: "/base/file_i_want".
    * @param cipher_key The key to use as cipher.
    * @param w A pointer to the unsigned int to hold the width in pixels.
    * @param h A pointer to the unsigned int to hold the height in pixels.
    * @param alpha A pointer to the int to hold the alpha flag.
    * @param compress A pointer to the int to hold the compression amount.
    * @param quality A pointer to the int to hold the quality amount.
    * @param lossy A pointer to the int to hold the lossiness flag.
    * @return The image pixel data decoded
    *
    * This function reads an image from an eet file stored under the named
    * key in the eet file and return a pointer to the decompressed pixel data.
    *
    * The other parameters of the image (width, height etc.) are placed into
    * the values pointed to (they must be supplied). The pixel data is a linear
    * array of pixels starting from the top-left of the image scanning row by
    * row from left to right. Each pile is a 32bit value, with the high byte
    * being the alpha channel, the next being red, then green, and the low byte
    * being blue. The width and height are measured in pixels and will be
    * greater than 0 when returned. The alpha flag is either 0 or 1. 0 denotes
    * that the alpha channel is not used. 1 denotes that it is significant.
    * Compress is filled with the compression value/amount the image was
    * stored with. The quality value is filled with the quality encoding of
    * the image file (0 - 100). The lossy flags is either 0 or 1 as to if
    * the image was encoded lossily or not.
    *
    * On success the function returns a pointer to the image data decoded. The
    * calling application is responsible for calling free() on the image data
    * when it is done with it. On failure NULL is returned and the parameter
    * values may not contain any sensible data.
    *
    * @see eet_data_image_read()
    *
    * @since 1.0.0
    * @ingroup Eet_File_Image_Cipher_Group
    */
   EAPI void *eet_data_image_read_cipher(Eet_File *ef, const char *name, const char *cipher_key, unsigned int *w, unsigned int *h, int *alpha, int *compress, int *quality, int *lossy);

   /**
    * Read image data from the named key in the eet file using a cipher.
    * @param ef A valid eet file handle opened for reading.
    * @param name Name of the entry. eg: "/base/file_i_want".
    * @param cipher_key The key to use as cipher.
    * @param src_x The starting x coordinate from where to dump the stream.
    * @param src_y The starting y coordinate from where to dump the stream.
    * @param d A pointer to the pixel surface.
    * @param w The expected width in pixels of the pixel surface to decode.
    * @param h The expected height in pixels of the pixel surface to decode.
    * @param row_stride The length of a pixels line in the destination surface.
    * @param alpha A pointer to the int to hold the alpha flag.
    * @param compress A pointer to the int to hold the compression amount.
    * @param quality A pointer to the int to hold the quality amount.
    * @param lossy A pointer to the int to hold the lossiness flag.
    * @return 1 on success, 0 otherwise.
    *
    * This function reads an image from an eet file stored under the named
    * key in the eet file and return a pointer to the decompressed pixel data.
    *
    * The other parameters of the image (width, height etc.) are placed into
    * the values pointed to (they must be supplied). The pixel data is a linear
    * array of pixels starting from the top-left of the image scanning row by
    * row from left to right. Each pile is a 32bit value, with the high byte
    * being the alpha channel, the next being red, then green, and the low byte
    * being blue. The width and height are measured in pixels and will be
    * greater than 0 when returned. The alpha flag is either 0 or 1. 0 denotes
    * that the alpha channel is not used. 1 denotes that it is significant.
    * Compress is filled with the compression value/amount the image was
    * stored with. The quality value is filled with the quality encoding of
    * the image file (0 - 100). The lossy flags is either 0 or 1 as to if
    * the image was encoded lossily or not.
    *
    * On success the function returns 1, and 0 on failure. On failure the
    * parameter values may not contain any sensible data.
    *
    * @see eet_data_image_read_to_surface()
    *
    * @since 1.0.2
    * @ingroup Eet_File_Image_Cipher_Group
    */
   EAPI int eet_data_image_read_to_surface_cipher(Eet_File *ef, const char *name, const char *cipher_key, unsigned int src_x, unsigned int src_y, unsigned int *d, unsigned int w, unsigned int h, unsigned int row_stride, int *alpha, int *compress, int *quality, int *lossy);

   /**
    * Write image data to the named key in an eet file using a cipher.
    * @param ef A valid eet file handle opened for writing.
    * @param name Name of the entry. eg: "/base/file_i_want".
    * @param cipher_key The key to use as cipher.
    * @param data A pointer to the image pixel data.
    * @param w The width of the image in pixels.
    * @param h The height of the image in pixels.
    * @param alpha The alpha channel flag.
    * @param compress The compression amount.
    * @param quality The quality encoding amount.
    * @param lossy The lossiness flag.
    * @return Success if the data was encoded and written or not.
    *
    * This function takes image pixel data and encodes it in an eet file
    * stored under the supplied name key, and returns how many bytes were
    * actually written to encode the image data.
    *
    * The data expected is the same format as returned by eet_data_image_read.
    * If this is not the case weird things may happen. Width and height must
    * be between 1 and 8000 pixels. The alpha flags can be 0 or 1 (0 meaning
    * the alpha values are not useful and 1 meaning they are). Compress can
    * be from 0 to 9 (0 meaning no compression, 9 meaning full compression).
    * This is only used if the image is not lossily encoded. Quality is used on
    * lossy compression and should be a value from 0 to 100. The lossy flag
    * can be 0 or 1. 0 means encode losslessly and 1 means to encode with
    * image quality loss (but then have a much smaller encoding).
    *
    * On success this function returns the number of bytes that were required
    * to encode the image data, or on failure it returns 0.
    *
    * @see eet_data_image_write()
    *
    * @since 1.0.0
    * @ingroup Eet_File_Image_Cipher_Group
    */
   EAPI int eet_data_image_write_cipher(Eet_File *ef, const char *name, const char *cipher_key, const void *data, unsigned int w, unsigned int h, int alpha, int compress, int quality, int lossy);


   /**
    * Decode Image data header only to get information using a cipher.
    * @param data The encoded pixel data.
    * @param cipher_key The key to use as cipher.
    * @param size The size, in bytes, of the encoded pixel data.
    * @param w A pointer to the unsigned int to hold the width in pixels.
    * @param h A pointer to the unsigned int to hold the height in pixels.
    * @param alpha A pointer to the int to hold the alpha flag.
    * @param compress A pointer to the int to hold the compression amount.
    * @param quality A pointer to the int to hold the quality amount.
    * @param lossy A pointer to the int to hold the lossiness flag.
    * @return 1 on success, 0 on failure.
    *
    * This function takes encoded pixel data and decodes it into raw RGBA
    * pixels on success.
    *
    * The other parameters of the image (width, height etc.) are placed into
    * the values pointed to (they must be supplied). The pixel data is a linear
    * array of pixels starting from the top-left of the image scanning row by
    * row from left to right. Each pixel is a 32bit value, with the high byte
    * being the alpha channel, the next being red, then green, and the low byte
    * being blue. The width and height are measured in pixels and will be
    * greater than 0 when returned. The alpha flag is either 0 or 1. 0 denotes
    * that the alpha channel is not used. 1 denotes that it is significant.
    * Compress is filled with the compression value/amount the image was
    * stored with. The quality value is filled with the quality encoding of
    * the image file (0 - 100). The lossy flags is either 0 or 1 as to if
    * the image was encoded lossily or not.
    *
    * On success the function returns 1 indicating the header was read and
    * decoded properly, or 0 on failure.
    *
    * @see eet_data_image_header_decode()
    *
    * @since 1.0.0
    * @ingroup Eet_File_Image_Cipher_Group
    */
   EAPI int eet_data_image_header_decode_cipher(const void *data, const char *cipher_key, int size, unsigned int *w, unsigned int *h, int *alpha, int *compress, int *quality, int *lossy);

   /**
    * Decode Image data into pixel data using a cipher.
    * @param data The encoded pixel data.
    * @param cipher_key The key to use as cipher.
    * @param size The size, in bytes, of the encoded pixel data.
    * @param w A pointer to the unsigned int to hold the width in pixels.
    * @param h A pointer to the unsigned int to hold the height in pixels.
    * @param alpha A pointer to the int to hold the alpha flag.
    * @param compress A pointer to the int to hold the compression amount.
    * @param quality A pointer to the int to hold the quality amount.
    * @param lossy A pointer to the int to hold the lossiness flag.
    * @return The image pixel data decoded
    *
    * This function takes encoded pixel data and decodes it into raw RGBA
    * pixels on success.
    *
    * The other parameters of the image (width, height etc.) are placed into
    * the values pointed to (they must be supplied). The pixel data is a linear
    * array of pixels starting from the top-left of the image scanning row by
    * row from left to right. Each pixel is a 32bit value, with the high byte
    * being the alpha channel, the next being red, then green, and the low byte
    * being blue. The width and height are measured in pixels and will be
    * greater than 0 when returned. The alpha flag is either 0 or 1. 0 denotes
    * that the alpha channel is not used. 1 denotes that it is significant.
    * Compress is filled with the compression value/amount the image was
    * stored with. The quality value is filled with the quality encoding of
    * the image file (0 - 100). The lossy flags is either 0 or 1 as to if
    * the image was encoded lossily or not.
    *
    * On success the function returns a pointer to the image data decoded. The
    * calling application is responsible for calling free() on the image data
    * when it is done with it. On failure NULL is returned and the parameter
    * values may not contain any sensible data.
    *
    * @see eet_data_image_decode()
    *
    * @since 1.0.0
    * @ingroup Eet_File_Image_Cipher_Group
    */
   EAPI void *eet_data_image_decode_cipher(const void *data, const char *cipher_key, int size, unsigned int *w, unsigned int *h, int *alpha, int *compress, int *quality, int *lossy);

   /**
    * Decode Image data into pixel data using a cipher.
    * @param data The encoded pixel data.
    * @param cipher_key The key to use as cipher.
    * @param size The size, in bytes, of the encoded pixel data.
    * @param src_x The starting x coordinate from where to dump the stream.
    * @param src_y The starting y coordinate from where to dump the stream.
    * @param d A pointer to the pixel surface.
    * @param w The expected width in pixels of the pixel surface to decode.
    * @param h The expected height in pixels of the pixel surface to decode.
    * @param row_stride The length of a pixels line in the destination surface.
    * @param alpha A pointer to the int to hold the alpha flag.
    * @param compress A pointer to the int to hold the compression amount.
    * @param quality A pointer to the int to hold the quality amount.
    * @param lossy A pointer to the int to hold the lossiness flag.
    * @return 1 on success, 0 otherwise.
    *
    * This function takes encoded pixel data and decodes it into raw RGBA
    * pixels on success.
    *
    * The other parameters of the image (alpha, compress etc.) are placed into
    * the values pointed to (they must be supplied). The pixel data is a linear
    * array of pixels starting from the top-left of the image scanning row by
    * row from left to right. Each pixel is a 32bit value, with the high byte
    * being the alpha channel, the next being red, then green, and the low byte
    * being blue. The width and height are measured in pixels and will be
    * greater than 0 when returned. The alpha flag is either 0 or 1. 0 denotes
    * that the alpha channel is not used. 1 denotes that it is significant.
    * Compress is filled with the compression value/amount the image was
    * stored with. The quality value is filled with the quality encoding of
    * the image file (0 - 100). The lossy flags is either 0 or 1 as to if
    * the image was encoded lossily or not.
    *
    * On success the function returns 1, and 0 on failure. On failure the
    * parameter values may not contain any sensible data.
    *
    * @see eet_data_image_decode_to_surface()
    *
    * @since 1.0.2
    * @ingroup Eet_File_Image_Cipher_Group
    */
   EAPI int eet_data_image_decode_to_surface_cipher(const void *data, const char *cipher_key, int size, unsigned int src_x, unsigned int src_y, unsigned int *d, unsigned int w, unsigned int h, unsigned int row_stride, int *alpha, int *compress, int *quality, int *lossy);

   /**
    * Encode image data for storage or transmission using a cipher.
    * @param data A pointer to the image pixel data.
    * @param cipher_key The key to use as cipher.
    * @param size_ret A pointer to an int to hold the size of the returned data.
    * @param w The width of the image in pixels.
    * @param h The height of the image in pixels.
    * @param alpha The alpha channel flag.
    * @param compress The compression amount.
    * @param quality The quality encoding amount.
    * @param lossy The lossiness flag.
    * @return The encoded image data.
    *
    * This function stakes image pixel data and encodes it with compression and
    * possible loss of quality (as a trade off for size) for storage or
    * transmission to another system.
    *
    * The data expected is the same format as returned by eet_data_image_read.
    * If this is not the case weird things may happen. Width and height must
    * be between 1 and 8000 pixels. The alpha flags can be 0 or 1 (0 meaning
    * the alpha values are not useful and 1 meaning they are). Compress can
    * be from 0 to 9 (0 meaning no compression, 9 meaning full compression).
    * This is only used if the image is not lossily encoded. Quality is used on
    * lossy compression and should be a value from 0 to 100. The lossy flag
    * can be 0 or 1. 0 means encode losslessly and 1 means to encode with
    * image quality loss (but then have a much smaller encoding).
    *
    * On success this function returns a pointer to the encoded data that you
    * can free with free() when no longer needed.
    *
    * @see eet_data_image_encode()
    *
    * @since 1.0.0
    * @ingroup Eet_File_Image_Cipher_Group
    */
   EAPI void *eet_data_image_encode_cipher(const void *data, const char *cipher_key, unsigned int w, unsigned int h, int alpha, int compress, int quality, int lossy, int *size_ret);


   /**
    * @defgroup Eet_Cipher_Group Cipher, Identity and Protection Mechanisms
    *
    * Eet allows one to protect entries of an #Eet_File
    * individually. This may be used to ensure data was not tampered or
    * that third party does not read your data.
    *
    * @see @ref Eet_File_Cipher_Group
    * @see @ref Eet_File_Image_Cipher_Group
    *
    * @{
    */

   /**
    * @typedef Eet_Key
    * Opaque handle that defines an identity (also known as key)
    * in Eet's cipher system.
    */
   typedef struct _Eet_Key Eet_Key;

   /**
    * @}
    */


   /**
    * Callback used to request if needed the password of a private key.
    *
    * @param buffer the buffer where to store the password.
    * @param size the maximum password size (size of buffer, including '@\0').
    * @param rwflag if the buffer is also readable or just writable.
    * @param data currently unused, may contain some context in future.
    * @return 1 on success and password was set to @p buffer, 0 on failure.
    *
    * @since 1.2.0
    * @ingroup Eet_Cipher_Group
    */
   typedef int (*Eet_Key_Password_Callback)(char *buffer, int size, int rwflag, void *data);

   /**
    * Create an Eet_Key needed for signing an eet file.
    *
    * The certificate should provide the public that match the private key.
    * No verification is done to ensure that.
    *
    * @param certificate_file The file where to find the certificate.
    * @param private_key_file The file that contains the private key.
    * @param cb Function to callback if password is required to unlock
    *        private key.
    * @return A key handle to use, or @c NULL on failure.
    *
    * @see eet_identity_close()
    *
    * @since 1.2.0
    * @ingroup Eet_Cipher_Group
    */
   EAPI Eet_Key* eet_identity_open(const char *certificate_file, const char *private_key_file, Eet_Key_Password_Callback cb);

   /**
    * Close and release all ressource used by an Eet_Key.  An
    * reference counter prevent it from being freed until all file
    * using it are also closed.
    *
    * @param key the key handle to close and free resources.
    *
    * @since 1.2.0
    * @ingroup Eet_Cipher_Group
    */
   EAPI void eet_identity_close(Eet_Key *key);

   /**
    * Set a key to sign a file
    *
    * @param ef the file to set the identity.
    * @param key the key handle to set as identity.
    * @return #EET_ERROR_BAD_OBJECT if @p ef is invalid or
    *         #EET_ERROR_NONE on success.
    *
    * @since 1.2.0
    * @ingroup Eet_Cipher_Group
    */
   EAPI Eet_Error eet_identity_set(Eet_File *ef, Eet_Key *key);

   /**
    * Display both private and public key of an Eet_Key.
    *
    * @param key the handle to print.
    * @param out where to print.
    *
    * @since 1.2.0
    * @ingroup Eet_Cipher_Group
    */
   EAPI void eet_identity_print(Eet_Key *key, FILE *out);

   /**
    * Get the x509 der certificate associated with an Eet_File. Will return NULL
    * if the file is not signed.
    *
    * @param ef The file handle to query.
    * @param der_length The length of returned data, may be @c NULL.
    * @return the x509 certificate or @c NULL on error.
    *
    * @since 1.2.0
    * @ingroup Eet_Cipher_Group
    */
   EAPI const void *eet_identity_x509(Eet_File *ef, int *der_length);

   /**
    * Get the raw signature associated with an Eet_File. Will return NULL
    * if the file is not signed.
    *
    * @param ef The file handle to query.
    * @param signature_length The length of returned data, may be @c NULL.
    * @return the raw signature or @c NULL on error.
    *
    * @ingroup Eet_Cipher_Group
    */
   EAPI const void *eet_identity_signature(Eet_File *ef, int *signature_length);

   /**
    * Get the SHA1 associated with a file. Could be the one used to
    * sign the data or if the data where not signed, it will be the
    * SHA1 of the file.
    *
    * @param ef The file handle to query.
    * @param sha1_length The length of returned data, may be @c NULL.
    * @return the associated SHA1 or @c NULL on error.
    *
    * @since 1.2.0
    * @ingroup Eet_Cipher_Group
    */
   EAPI const void *eet_identity_sha1(Eet_File *ef, int *sha1_length);

   /**
    * Display the x509 der certificate to out.
    *
    * @param certificate the x509 certificate to print
    * @param der_length The length the certificate.
    * @param out where to print.
    *
    * @since 1.2.0
    * @ingroup Eet_Cipher_Group
    */
   EAPI void eet_identity_certificate_print(const unsigned char *certificate, int der_length, FILE *out);


   /**
    * @defgroup Eet_Data_Group Eet Data Serialization
    *
    * Convenience functions to serialize and parse complex data
    * structures to binary blobs.
    *
    * While Eet core just handles binary blobs, it is often required
    * to save some structured data of different types, such as
    * strings, integers, lists, hashes and so on.
    *
    * Eet can serialize and then parse data types given some
    * construction instructions. These are defined in two levels:
    *
    * - #Eet_Data_Descriptor_Class to tell generic memory handling,
    *   such as the size of the type, how to allocate memory, strings,
    *   lists, hashes and so on.
    *
    * - #Eet_Data_Descriptor to tell inside such type, the members and
    *   their offsets inside the memory blob, their types and
    *   names. These members can be simple types or other
    *   #Eet_Data_Descriptor, allowing hierarchical types to be
    *   defined.
    *
    * Given that C provides no introspection, this process can be
    * quite cumbersome, so we provide lots of macros and convenience
    * functions to aid creating the types.
    *
    * Example:
    *
    * @code
    * #include <Eet.h>
    * #include <Evas.h>
    *
    * typedef struct _blah2
    * {
    *    char *string;
    * } Blah2;
    *
    * typedef struct _blah3
    * {
    *    char *string;
    * } Blah3;
    *
    * typedef struct _blah
    * {
    *    char character;
    *    short sixteen;
    *    int integer;
    *    long long lots;
    *    float floating;
    *    double floating_lots;
    *    char *string;
    *    Blah2 *blah2;
    *    Eina_List *blah3;
    * } Blah;
    *
    * int
    * main(int argc, char **argv)
    * {
    *    Blah blah;
    *    Blah2 blah2;
    *    Blah3 blah3;
    *    Eet_Data_Descriptor *edd, *edd2, *edd3;
    *    Eet_Data_Descriptor_Class eddc, eddc2, eddc3;
    *    void *data;
    *    int size;
    *    FILE *f;
    *    Blah *blah_in;
    *
    *    eet_init();
    *
    *    EET_EINA_STREAM_DATA_DESCRIPTOR_CLASS_SET(&eddc3, Blah3);
    *    edd3 = eet_data_descriptor_stream_new(&eddc3);
    *    EET_DATA_DESCRIPTOR_ADD_BASIC(edd3, Blah3, "string3", string, EET_T_STRING);
    *
    *    EET_EINA_STREAM_DATA_DESCRIPTOR_CLASS_SET(&eddc2, Blah2);
    *    edd2 = eet_data_descriptor_stream_new(&eddc2);
    *    EET_DATA_DESCRIPTOR_ADD_BASIC(edd2, Blah2, "string2", string, EET_T_STRING);
    *
    *    EET_EINA_STREAM_DATA_DESCRIPTOR_CLASS_SET(&eddc, Blah);
    *    edd = eet_data_descriptor_stream_new(&eddc);
    *    EET_DATA_DESCRIPTOR_ADD_BASIC(edd, Blah, "character", character, EET_T_CHAR);
    *    EET_DATA_DESCRIPTOR_ADD_BASIC(edd, Blah, "sixteen", sixteen, EET_T_SHORT);
    *    EET_DATA_DESCRIPTOR_ADD_BASIC(edd, Blah, "integer", integer, EET_T_INT);
    *    EET_DATA_DESCRIPTOR_ADD_BASIC(edd, Blah, "lots", lots, EET_T_LONG_LONG);
    *    EET_DATA_DESCRIPTOR_ADD_BASIC(edd, Blah, "floating", floating, EET_T_FLOAT);
    *    EET_DATA_DESCRIPTOR_ADD_BASIC(edd, Blah, "floating_lots", floating_lots, EET_T_DOUBLE);
    *    EET_DATA_DESCRIPTOR_ADD_BASIC(edd, Blah, "string", string, EET_T_STRING);
    *    EET_DATA_DESCRIPTOR_ADD_SUB(edd, Blah, "blah2", blah2, edd2);
    *    EET_DATA_DESCRIPTOR_ADD_LIST(edd, Blah, "blah3", blah3, edd3);
    *
    *    blah3.string = "PANTS";
    *
    *    blah2.string = "subtype string here!";
    *
    *    blah.character = '7';
    *    blah.sixteen = 0x7777;
    *    blah.integer = 0xc0def00d;
    *    blah.lots = 0xdeadbeef31337777;
    *    blah.floating = 3.141592654;
    *    blah.floating_lots = 0.777777777777777;
    *    blah.string = "bite me like a turnip";
    *    blah.blah2 = &blah2;
    *    blah.blah3 = eina_list_append(NULL, &blah3);
    *    blah.blah3 = eina_list_append(blah.blah3, &blah3);
    *    blah.blah3 = eina_list_append(blah.blah3, &blah3);
    *    blah.blah3 = eina_list_append(blah.blah3, &blah3);
    *    blah.blah3 = eina_list_append(blah.blah3, &blah3);
    *    blah.blah3 = eina_list_append(blah.blah3, &blah3);
    *    blah.blah3 = eina_list_append(blah.blah3, &blah3);
    *
    *    data = eet_data_descriptor_encode(edd, &blah, &size);
    *    printf("-----DECODING\n");
    *    blah_in = eet_data_descriptor_decode(edd, data, size);
    *
    *    printf("-----DECODED!\n");
    *    printf("%c\n", blah_in->character);
    *    printf("%x\n", (int)blah_in->sixteen);
    *    printf("%x\n", blah_in->integer);
    *    printf("%lx\n", blah_in->lots);
    *    printf("%f\n", (double)blah_in->floating);
    *    printf("%f\n", (double)blah_in->floating_lots);
    *    printf("%s\n", blah_in->string);
    *    printf("%p\n", blah_in->blah2);
    *    printf("  %s\n", blah_in->blah2->string);
    *      {
    *         Eina_List *l;
    *         Blah3 *blah3_in;
    *
    *         EINA_LIST_FOREACH(blah_in->blah3, l, blah3_in)
    *           {
    *              printf("%p\n", blah3_in);
    *              printf("  %s\n", blah3_in->string);
    *           }
    *      }
    *    eet_data_descriptor_free(edd);
    *    eet_data_descriptor_free(edd2);
    *    eet_data_descriptor_free(edd3);
    *
    *    eet_shutdown();
    *
    *   return 0;
    * }
    * @endcode
    *
    * @{
    */
#define EET_T_UNKNOW            0 /**< Unknown data encoding type */
#define EET_T_CHAR              1 /**< Data type: char */
#define EET_T_SHORT             2 /**< Data type: short */
#define EET_T_INT               3 /**< Data type: int */
#define EET_T_LONG_LONG         4 /**< Data type: long long */
#define EET_T_FLOAT             5 /**< Data type: float */
#define EET_T_DOUBLE            6 /**< Data type: double */
#define EET_T_UCHAR             7 /**< Data type: unsigned char */
#define EET_T_USHORT            8 /**< Data type: unsigned short */
#define EET_T_UINT              9 /**< Data type: unsigned int */
#define EET_T_ULONG_LONG        10 /**< Data type: unsigned long long */
#define EET_T_STRING            11 /**< Data type: char * */
#define EET_T_INLINED_STRING    12 /**< Data type: char * (but compressed inside the resulting eet) */
#define EET_T_NULL              13 /**< Data type: (void *) (only use it if you know why) */
#define EET_T_F32P32		14 /**< Data type:  */
#define EET_T_F16P16		15 /**< Data type:  */
#define EET_T_F8P24		16 /**< Data type:  */
#define EET_T_LAST              17 /**< Last data type */

#define EET_G_UNKNOWN    100 /**< Unknown group data encoding type */
#define EET_G_ARRAY      101 /**< Fixed size array group type */
#define EET_G_VAR_ARRAY  102 /**< Variable size array group type */
#define EET_G_LIST       103 /**< Linked list group type */
#define EET_G_HASH       104 /**< Hash table group type */
#define EET_G_LAST       105 /**< Last group type */

#define EET_I_LIMIT      128 /**< Other type exist but are reserved for internal purpose. */

   /**
    * @typedef Eet_Data_Descriptor
    *
    * Opaque handle that have information on a type members.
    *
    * The members are added by means of
    * EET_DATA_DESCRIPTOR_ADD_BASIC(), EET_DATA_DESCRIPTOR_ADD_SUB(),
    * EET_DATA_DESCRIPTOR_ADD_LIST(), EET_DATA_DESCRIPTOR_ADD_HASH()
    * or eet_data_descriptor_element_add().
    *
    * @see eet_data_descriptor_stream_new()
    * @see eet_data_descriptor_file_new()
    * @see eet_data_descriptor_free()
    */
   typedef struct _Eet_Data_Descriptor       Eet_Data_Descriptor;

   /**
    * @def EET_DATA_DESCRIPTOR_CLASS_VERSION
    * The version of #Eet_Data_Descriptor_Class at the time of the
    * distribution of the sources. One should define this to its
    * version member so it is compatible with abi changes, or at least
    * will not crash with them.
    */
#define EET_DATA_DESCRIPTOR_CLASS_VERSION 2

  /**
   * @typedef Eet_Data_Descriptor_Class
   *
   * Instructs Eet about memory management for different needs under
   * serialization and parse process.
   */
   typedef struct _Eet_Data_Descriptor_Class Eet_Data_Descriptor_Class;

   /**
    * @struct _Eet_Data_Descriptor_Class
    *
    * Instructs Eet about memory management for different needs under
    * serialization and parse process.
    *
    * If using Eina data types, it is advised to use the helpers
    * EET_EINA_STREAM_DATA_DESCRIPTOR_CLASS_SET() and
    * EET_EINA_FILE_DATA_DESCRIPTOR_CLASS_SET().
    */
   struct _Eet_Data_Descriptor_Class
     {
	int         version; /**< ABI version as #EET_DATA_DESCRIPTOR_CLASS_VERSION */
	const char *name; /**< Name of data type to be serialized */
	int         size; /**< Size in bytes of data type to be serialized */
	struct {
	   void   *(*mem_alloc) (size_t size); /**< how to allocate memory (usually malloc()) */
	   void    (*mem_free) (void *mem); /**< how to free memory (usually free()) */
           char   *(*str_alloc) (const char *str); /**< how to allocate a string */
	   void    (*str_free) (const char *str); /**< how to free a string */
	   void   *(*list_next) (void *l); /**< how to iterate to the next element of a list. Receives and should return the list node. */
	   void   *(*list_append) (void *l, void *d); /**< how to append data @p d to list which head node is @p l */
	   void   *(*list_data) (void *l); /**< retrieves the data from node @p l */
	   void   *(*list_free) (void *l); /**< free all the nodes from the list which head node is @p l */
	   void    (*hash_foreach) (void *h, int (*func) (void *h, const char *k, void *dt, void *fdt), void *fdt); /**< iterates over all elements in the hash @p h in no specific order */
	   void   *(*hash_add) (void *h, const char *k, void *d); /**< add a new data @p d as key @p k in hash @p h */
	   void    (*hash_free) (void *h); /**< free all entries from the hash @p h */
           char   *(*str_direct_alloc) (const char *str); /**< how to allocate a string directly from file backed/mmaped region pointed by @p str */
           void    (*str_direct_free) (const char *str); /**< how to free a string returned by str_direct_alloc */
	} func;
     };

   /**
    * @}
    */

   /**
    * Create a new empty data structure descriptor.
    * @param name The string name of this data structure (most be a
    *        global constant and never change).
    * @param size The size of the struct (in bytes).
    * @param func_list_next The function to get the next list node.
    * @param func_list_append The function to append a member to a list.
    * @param func_list_data The function to get the data from a list node.
    * @param func_list_free The function to free an entire linked list.
    * @param func_hash_foreach The function to iterate through all
    *        hash table entries.
    * @param func_hash_add The function to add a member to a hash table.
    * @param func_hash_free The function to free an entire hash table.
    * @return A new empty data descriptor.
    *
    * This function creates a new data descriptore and returns a handle to the
    * new data descriptor. On creation it will be empty, containing no contents
    * describing anything other than the shell of the data structure.
    *
    * You add structure members to the data descriptor using the macros
    * EET_DATA_DESCRIPTOR_ADD_BASIC(), EET_DATA_DESCRIPTOR_ADD_SUB() and
    * EET_DATA_DESCRIPTOR_ADD_LIST(), depending on what type of member you are
    * adding to the description.
    *
    * Once you have described all the members of a struct you want loaded, or
    * saved eet can load and save those members for you, encode them into
    * endian-independant serialised data chunks for transmission across a
    * a network or more.
    *
    * The function pointers to the list and hash table functions are only
    * needed if you use those data types, else you can pass NULL instead.
    *
    * @since 1.0.0
    * @ingroup Eet_Data_Group
    *
    * @deprecated use eet_data_descriptor_stream_new() or
    *             eet_data_descriptor_file_new()
    */
   EINA_DEPRECATED EAPI Eet_Data_Descriptor *eet_data_descriptor_new(const char *name, int size, void *(*func_list_next) (void *l), void *(*func_list_append) (void *l, void *d), void *(*func_list_data) (void *l), void *(*func_list_free) (void *l), void  (*func_hash_foreach) (void *h, int (*func) (void *h, const char *k, void *dt, void *fdt), void *fdt), void *(*func_hash_add) (void *h, const char *k, void *d), void  (*func_hash_free) (void *h));
   /*
    * FIXME:
    *
    * moving to this api from the old above. this will break things when the
    * move happens - but be warned
    */
   EINA_DEPRECATED EAPI Eet_Data_Descriptor *eet_data_descriptor2_new(const Eet_Data_Descriptor_Class *eddc);
   EINA_DEPRECATED EAPI Eet_Data_Descriptor *eet_data_descriptor3_new(const Eet_Data_Descriptor_Class *eddc);

   /**
    * This function creates a new data descriptore and returns a handle to the
    * new data descriptor. On creation it will be empty, containing no contents
    * describing anything other than the shell of the data structure.
    * @param eddc The data descriptor to free.
    *
    * You add structure members to the data descriptor using the macros
    * EET_DATA_DESCRIPTOR_ADD_BASIC(), EET_DATA_DESCRIPTOR_ADD_SUB() and
    * EET_DATA_DESCRIPTOR_ADD_LIST(), depending on what type of member you are
    * adding to the description.
    *
    * Once you have described all the members of a struct you want loaded, or
    * saved eet can load and save those members for you, encode them into
    * endian-independant serialised data chunks for transmission across a
    * a network or more.
    *
    * This function specially ignore str_direct_alloc and str_direct_free. It
    * is usefull when the eet_data you are reading don't have a dictionnary
    * like network stream or ipc. It also mean that all string will be allocated
    * and duplicated in memory.
    *
    * @since 1.2.3
    * @ingroup Eet_Data_Group
    */
   EAPI Eet_Data_Descriptor *eet_data_descriptor_stream_new(const Eet_Data_Descriptor_Class *eddc);

   /**
    * This function creates a new data descriptore and returns a handle to the
    * new data descriptor. On creation it will be empty, containing no contents
    * describing anything other than the shell of the data structure.
    * @param eddc The data descriptor to free.
    *
    * You add structure members to the data descriptor using the macros
    * EET_DATA_DESCRIPTOR_ADD_BASIC(), EET_DATA_DESCRIPTOR_ADD_SUB() and
    * EET_DATA_DESCRIPTOR_ADD_LIST(), depending on what type of member you are
    * adding to the description.
    *
    * Once you have described all the members of a struct you want loaded, or
    * saved eet can load and save those members for you, encode them into
    * endian-independant serialised data chunks for transmission across a
    * a network or more.
    *
    * This function use str_direct_alloc and str_direct_free. It is
    * usefull when the eet_data you are reading come from a file and
    * have a dictionnary. This will reduce memory use, improve the
    * possibility for the OS to page this string out. But be carrefull
    * all EET_T_STRING are pointer to a mmapped area and it will point
    * to nowhere if you close the file. So as long as you use this
    * strings, you need to have the Eet_File open.
    *
    * @since 1.2.3
    * @ingroup Eet_Data_Group
    */
   EAPI Eet_Data_Descriptor *eet_data_descriptor_file_new(const Eet_Data_Descriptor_Class *eddc);

   /**
    * This function is an helper that set all the parameter of an
    * Eet_Data_Descriptor_Class correctly when you use Eina data type
    * with a stream.
    * @param eddc The Eet_Data_Descriptor_Class you want to set.
    * @param name The name of the structure described by this class.
    * @param size The size of the structure described by this class.
    * @return EINA_TRUE if the structure was correctly set (The only
    *         reason that could make it fail is if you did give wrong
    *         parameter).
    *
    * @since 1.2.3
    * @ingroup Eet_Data_Group
    */
   EAPI Eina_Bool eet_eina_stream_data_descriptor_class_set(Eet_Data_Descriptor_Class *eddc, const char *name, int size);

   /**
    * This macro is an helper that set all the parameter of an
    * Eet_Data_Descriptor_Class correctly when you use Eina data type
    * with stream.
    * @param Clas The Eet_Data_Descriptor_Class you want to set.
    * @param Type The type of the structure described by this class.
    * @return EINA_TRUE if the structure was correctly set (The only
    *         reason that could make it fail is if you did give wrong
    *         parameter).
    *
    * @since 1.2.3
    * @ingroup Eet_Data_Group
    */
#define EET_EINA_STREAM_DATA_DESCRIPTOR_CLASS_SET(Clas, Type) (eet_eina_stream_data_descriptor_class_set(Clas, #Type , sizeof (Type)))

   /**
    * This function is an helper that set all the parameter of an
    * Eet_Data_Descriptor_Class correctly when you use Eina data type
    * with a file.
    * @param eddc The Eet_Data_Descriptor_Class you want to set.
    * @param name The name of the structure described by this class.
    * @param size The size of the structure described by this class.
    * @return EINA_TRUE if the structure was correctly set (The only
    *         reason that could make it fail is if you did give wrong
    *         parameter).
    *
    * @since 1.2.3
    * @ingroup Eet_Data_Group
    */
   EAPI Eina_Bool eet_eina_file_data_descriptor_class_set(Eet_Data_Descriptor_Class *eddc, const char *name, int size);

   /**
    * This macro is an helper that set all the parameter of an
    * Eet_Data_Descriptor_Class correctly when you use Eina data type
    * with file.
    * @param Clas The Eet_Data_Descriptor_Class you want to set.
    * @param Type The type of the structure described by this class.
    * @return EINA_TRUE if the structure was correctly set (The only
    *         reason that could make it fail is if you did give wrong
    *         parameter).
    *
    * @since 1.2.3
    * @ingroup Eet_Data_Group
    */
#define EET_EINA_FILE_DATA_DESCRIPTOR_CLASS_SET(Clas, Type) (eet_eina_file_data_descriptor_class_set(Clas, #Type , sizeof (Type)))

   /**
    * This function frees a data descriptor when it is not needed anymore.
    * @param edd The data descriptor to free.
    *
    * This function takes a data descriptor handle as a parameter and frees all
    * data allocated for the data descriptor and the handle itself. After this
    * call the descriptor is no longer valid.
    *
    * @since 1.0.0
    * @ingroup Eet_Data_Group
    */
   EAPI void eet_data_descriptor_free(Eet_Data_Descriptor *edd);

   /**
    * This function is an internal used by macros.
    *
    * This function is used by macros EET_DATA_DESCRIPTOR_ADD_BASIC(),
    * EET_DATA_DESCRIPTOR_ADD_SUB() and EET_DATA_DESCRIPTOR_ADD_LIST(). It is
    * complex to use by hand and should be left to be used by the macros, and
    * thus is not documented.
    *
    * @param edd The data descriptor handle to add element (member).
    * @param name The name of element to be serialized.
    * @param type The type of element to be serialized, like
    *        #EET_T_INT. If #EET_T_UNKNOW, then it is considered to be a
    *        group, list or hash.
    * @param group_type If element type is #EET_T_UNKNOW, then the @p
    *        group_type will speficy if it is a list (#EET_G_LIST),
    *        array (#EET_G_ARRAY) and so on. If #EET_G_UNKNOWN, then
    *        the member is a subtype (pointer to another type defined by
    *        another #Eet_Data_Descriptor).
    * @param offset byte offset inside the source memory to be serialized.
    * @param count number of elements (if #EET_G_ARRAY or #EET_G_VAR_ARRAY).
    * @param counter_name variable that defines the name of number of elements.
    * @param subtype If contains a subtype, then its data descriptor.
    *
    * @since 1.0.0
    * @ingroup Eet_Data_Group
    */
   EAPI void eet_data_descriptor_element_add(Eet_Data_Descriptor *edd, const char *name, int type, int group_type, int offset, /* int count_offset,  */int count, const char *counter_name, Eet_Data_Descriptor *subtype);

   /**
    * Read a data structure from an eet file and decodes it.
    * @param ef The eet file handle to read from.
    * @param edd The data descriptor handle to use when decoding.
    * @param name The key the data is stored under in the eet file.
    * @return A pointer to the decoded data structure.
    *
    * This function decodes a data structure stored in an eet file, returning
    * a pointer to it if it decoded successfully, or NULL on failure. This
    * can save a programmer dozens of hours of work in writing configuration
    * file parsing and writing code, as eet does all that work for the program
    * and presents a program-friendly data structure, just as the programmer
    * likes. Eet can handle members being added or deleted from the data in
    * storage and safely zero-fills unfilled members if they were not found
    * in the data. It checks sizes and headers whenever it reads data, allowing
    * the programmer to not worry about corrupt data.
    *
    * Once a data structure has been described by the programmer with the
    * fields they wish to save or load, storing or retrieving a data structure
    * from an eet file, or from a chunk of memory is as simple as a single
    * function call.
    *
    * @see eet_data_read_cipher()
    *
    * @since 1.0.0
    * @ingroup Eet_Data_Group
    */
   EAPI void *eet_data_read(Eet_File *ef, Eet_Data_Descriptor *edd, const char *name);

   /**
    * Write a data structure from memory and store in an eet file.
    * @param ef The eet file handle to write to.
    * @param edd The data descriptor to use when encoding.
    * @param name The key to store the data under in the eet file.
    * @param data A pointer to the data structure to ssave and encode.
    * @param compress Compression flags for storage.
    * @return bytes written on successful write, 0 on failure.
    *
    * This function is the reverse of eet_data_read(), saving a data structure
    * to an eet file.
    *
    * @see eet_data_write_cipher()
    *
    * @since 1.0.0
    * @ingroup Eet_Data_Group
    */
   EAPI int eet_data_write(Eet_File *ef, Eet_Data_Descriptor *edd, const char *name, const void *data, int compress);

   /**
    * Dump an eet encoded data structure into ascii text
    * @param data_in The pointer to the data to decode into a struct.
    * @param size_in The size of the data pointed to in bytes.
    * @param dumpfunc The function to call passed a string when new
    *        data is converted to text
    * @param dumpdata The data to pass to the @p dumpfunc callback.
    * @return 1 on success, 0 on failure
    *
    * This function will take a chunk of data encoded by
    * eet_data_descriptor_encode() and convert it into human readable
    * ascii text.  It does this by calling the @p dumpfunc callback
    * for all new text that is generated. This callback should append
    * to any existing text buffer and will be passed the pointer @p
    * dumpdata as a parameter as well as a string with new text to be
    * appended.
    *
    * Example:
    *
    * @code
    * void output(void *data, const char *string)
    * {
    *   printf("%s", string);
    * }
    *
    * void dump(const char *file)
    * {
    *   FILE *f;
    *   int len;
    *   void *data;
    *
    *   f = fopen(file, "r");
    *   fseek(f, 0, SEEK_END);
    *   len = ftell(f);
    *   rewind(f);
    *   data = malloc(len);
    *   fread(data, len, 1, f);
    *   fclose(f);
    *   eet_data_text_dump(data, len, output, NULL);
    * }
    * @endcode
    *
    * @see eet_data_text_dump_cipher()
    *
    * @since 1.0.0
    * @ingroup Eet_Data_Group
    */
   EAPI int eet_data_text_dump(const void *data_in, int size_in, void (*dumpfunc) (void *data, const char *str), void *dumpdata);

   /**
    * Take an ascii encoding from eet_data_text_dump() and re-encode in binary.
    * @param text The pointer to the string data to parse and encode.
    * @param textlen The size of the string in bytes (not including 0
    *        byte terminator).
    * @param size_ret This gets filled in with the encoded data blob
    *        size in bytes.
    * @return The encoded data on success, NULL on failure.
    *
    * This function will parse the string pointed to by @p text and return
    * an encoded data lump the same way eet_data_descriptor_encode() takes an
    * in-memory data struct and encodes into a binary blob. @p text is a normal
    * C string.
    *
    * @see eet_data_text_undump_cipher()
    *
    * @since 1.0.0
    * @ingroup Eet_Data_Group
    */
   EAPI void *eet_data_text_undump(const char *text, int textlen, int *size_ret);

   /**
    * Dump an eet encoded data structure from an eet file into ascii text
    * @param ef A valid eet file handle.
    * @param name Name of the entry. eg: "/base/file_i_want".
    * @param dumpfunc The function to call passed a string when new
    *        data is converted to text
    * @param dumpdata The data to pass to the @p dumpfunc callback.
    * @return 1 on success, 0 on failure
    *
    * This function will take an open and valid eet file from
    * eet_open() request the data encoded by
    * eet_data_descriptor_encode() corresponding to the key @p name
    * and convert it into human readable ascii text. It does this by
    * calling the @p dumpfunc callback for all new text that is
    * generated. This callback should append to any existing text
    * buffer and will be passed the pointer @p dumpdata as a parameter
    * as well as a string with new text to be appended.
    *
    * @see eet_data_dump_cipher()
    *
    * @since 1.0.0
    * @ingroup Eet_Data_Group
    */
   EAPI int eet_data_dump(Eet_File *ef, const char *name, void (*dumpfunc) (void *data, const char *str), void *dumpdata);

   /**
    * Take an ascii encoding from eet_data_dump() and re-encode in binary.
    * @param ef A valid eet file handle.
    * @param name Name of the entry. eg: "/base/file_i_want".
    * @param text The pointer to the string data to parse and encode.
    * @param textlen The size of the string in bytes (not including 0
    *        byte terminator).
    * @param compress Compression flags (1 == compress, 0 = don't compress).
    * @return 1 on success, 0 on failure
    *
    * This function will parse the string pointed to by @p text,
    * encode it the same way eet_data_descriptor_encode() takes an
    * in-memory data struct and encodes into a binary blob.
    *
    * The data (optionally compressed) will be in ram, pending a flush to
    * disk (it will stay in ram till the eet file handle is closed though).
    *
    * @see eet_data_undump_cipher()
    *
    * @since 1.0.0
    * @ingroup Eet_Data_Group
    */
   EAPI int eet_data_undump(Eet_File *ef, const char *name, const char *text, int textlen, int compress);

   /**
    * Decode a data structure from an arbitary location in memory.
    * @param edd The data  descriptor to use when decoding.
    * @param data_in The pointer to the data to decode into a struct.
    * @param size_in The size of the data pointed to in bytes.
    * @return NULL on failure, or a valid decoded struct pointer on success.
    *
    * This function will decode a data structure that has been encoded using
    * eet_data_descriptor_encode(), and return a data structure with all its
    * elements filled out, if successful, or NULL on failure.
    *
    * The data to be decoded is stored at the memory pointed to by @p data_in,
    * and is described by the descriptor pointed to by @p edd. The data size is
    * passed in as the value to @p size_in, ande must be greater than 0 to
    * succeed.
    *
    * This function is useful for decoding data structures delivered to the
    * application by means other than an eet file, such as an IPC or socket
    * connection, raw files, shared memory etc.
    *
    * Please see eet_data_read() for more information.
    *
    * @see eet_data_descriptor_decode_cipher()
    *
    * @since 1.0.0
    * @ingroup Eet_Data_Group
    */
   EAPI void *eet_data_descriptor_decode(Eet_Data_Descriptor *edd, const void *data_in, int size_in);

   /**
    * Encode a dsata struct to memory and return that encoded data.
    * @param edd The data  descriptor to use when encoding.
    * @param data_in The pointer to the struct to encode into data.
    * @param size_ret pointer to the an int to be filled with the decoded size.
    * @return NULL on failure, or a valid encoded data chunk on success.
    *
    * This function takes a data structutre in memory and encodes it into a
    * serialised chunk of data that can be decoded again by
    * eet_data_descriptor_decode(). This is useful for being able to transmit
    * data structures across sockets, pipes, IPC or shared file mechanisms,
    * without having to worry about memory space, machine type, endianess etc.
    *
    * The parameter @p edd must point to a valid data descriptor, and
    * @p data_in must point to the right data structure to encode. If not, the
    * encoding may fail.
    *
    * On success a non NULL valid pointer is returned and what @p size_ret
    * points to is set to the size of this decoded data, in bytes. When the
    * encoded data is no longer needed, call free() on it. On failure NULL is
    * returned and what @p size_ret points to is set to 0.
    *
    * Please see eet_data_write() for more information.
    *
    * @see eet_data_descriptor_encode_cipher()
    *
    * @since 1.0.0
    * @ingroup Eet_Data_Group
    */
   EAPI void *eet_data_descriptor_encode(Eet_Data_Descriptor *edd, const void *data_in, int *size_ret);

   /**
    * Add a basic data element to a data descriptor.
    * @param edd The data descriptor to add the type to.
    * @param struct_type The type of the struct.
    * @param name The string name to use to encode/decode this member
    *        (must be a constant global and never change).
    * @param member The struct member itself to be encoded.
    * @param type The type of the member to encode.
    *
    * This macro is a convenience macro provided to add a member to
    * the data descriptor @p edd. The type of the structure is
    * provided as the @p struct_type parameter (for example: struct
    * my_struct). The @p name parameter defines a string that will be
    * used to uniquely name that member of the struct (it is suggested
    * to use the struct member itself).  The @p member parameter is
    * the actual struct member itself (for eet_dictionary_string_check
    * example: values), and @p type is the basic data type of the
    * member which must be one of: EET_T_CHAR, EET_T_SHORT, EET_T_INT,
    * EET_T_LONG_LONG, EET_T_FLOAT, EET_T_DOUBLE, EET_T_UCHAR,
    * EET_T_USHORT, EET_T_UINT, EET_T_ULONG_LONG or EET_T_STRING.
    *
    * @since 1.0.0
    * @ingroup Eet_Data_Group
    */
#define EET_DATA_DESCRIPTOR_ADD_BASIC(edd, struct_type, name, member, type) \
     { \
	struct_type ___ett; \
	\
	eet_data_descriptor_element_add(edd, name, type, EET_G_UNKNOWN, \
					(char *)(&(___ett.member)) - (char *)(&(___ett)), \
					0, /* 0,  */NULL, NULL); \
     }

   /**
    * Add a sub-element type to a data descriptor
    * @param edd The data descriptor to add the type to.
    * @param struct_type The type of the struct.
    * @param name The string name to use to encode/decode this member
    *        (must be a constant global and never change).
    * @param member The struct member itself to be encoded.
    * @param subtype The type of sub-type struct to add.
    *
    * This macro lets you easily add a sub-type (a struct that's pointed to
    * by this one). All the parameters are the same as for
    * EET_DATA_DESCRIPTOR_ADD_BASIC(), with the @p subtype being the exception.
    * This must be the data descriptor of the struct that is pointed to by
    * this element.
    *
    * @since 1.0.0
    * @ingroup Eet_Data_Group
    */
#define EET_DATA_DESCRIPTOR_ADD_SUB(edd, struct_type, name, member, subtype) \
     { \
	struct_type ___ett; \
	\
	eet_data_descriptor_element_add(edd, name, EET_T_UNKNOW, EET_G_UNKNOWN, \
					(char *)(&(___ett.member)) - (char *)(&(___ett)), \
					0, /* 0,  */NULL, subtype); \
     }

   /**
    * Add a linked list type to a data descriptor
    * @param edd The data descriptor to add the type to.
    * @param struct_type The type of the struct.
    * @param name The string name to use to encode/decode this member
    *        (must be a constant global and never change).
    * @param member The struct member itself to be encoded.
    * @param subtype The type of linked list member to add.
    *
    * This macro lets you easily add a linked list of other data types. All the
    * parameters are the same as for EET_DATA_DESCRIPTOR_ADD_BASIC(), with the
    * @p subtype being the exception. This must be the data descriptor of the
    * element that is in each member of the linked list to be stored.
    *
    * @since 1.0.0
    * @ingroup Eet_Data_Group
    */
#define EET_DATA_DESCRIPTOR_ADD_LIST(edd, struct_type, name, member, subtype) \
     { \
	struct_type ___ett; \
	\
	eet_data_descriptor_element_add(edd, name, EET_T_UNKNOW, EET_G_LIST, \
					(char *)(&(___ett.member)) - (char *)(&(___ett)), \
					0, /* 0,  */NULL, subtype); \
     }

   /**
    * Add a hash type to a data descriptor
    * @param edd The data descriptor to add the type to.
    * @param struct_type The type of the struct.
    * @param name The string name to use to encode/decode this member
    *        (must be a constant global and never change).
    * @param member The struct member itself to be encoded.
    * @param subtype The type of hash member to add.
    *
    * This macro lets you easily add a hash of other data types. All the
    * parameters are the same as for EET_DATA_DESCRIPTOR_ADD_BASIC(), with the
    * @p subtype being the exception. This must be the data descriptor of the
    * element that is in each member of the hash to be stored.
    *
    * @since 1.0.0
    * @ingroup Eet_Data_Group
    */
#define EET_DATA_DESCRIPTOR_ADD_HASH(edd, struct_type, name, member, subtype) \
     { \
	struct_type ___ett; \
	\
	eet_data_descriptor_element_add(edd, name, EET_T_UNKNOW, EET_G_HASH, \
					(char *)(&(___ett.member)) - (char *)(&(___ett)), \
					0, /* 0,  */NULL, subtype); \
     }

   /**
    * Add a fixed size array type to a data descriptor
    * @param edd The data descriptor to add the type to.
    * @param struct_type The type of the struct.
    * @param name The string name to use to encode/decode this member
    *        (must be a constant global and never change).
    * @param member The struct member itself to be encoded.
    * @param subtype The type of hash member to add.
    *
    * This macro lets you easily add a fixed size array of other data
    * types. All the parameters are the same as for
    * EET_DATA_DESCRIPTOR_ADD_BASIC(), with the @p subtype being the
    * exception. This must be the data descriptor of the element that
    * is in each member of the hash to be stored.
    *
    * @since 1.0.2
    * @ingroup Eet_Data_Group
    */
#define EET_DATA_DESCRIPTOR_ADD_ARRAY(edd, struct_type, name, member, subtype) \
     { \
	struct_type ___ett; \
	\
	eet_data_descriptor_element_add(edd, name, EET_T_UNKNOW, EET_G_ARRAY, \
					(char *)(&(___ett.member)) - (char *)(&(___ett)), \
					/* 0,  */sizeof(___ett.member)/sizeof(___ett.member[0]), NULL, subtype); \
     }

   /**
    * Add a variable size array type to a data descriptor
    * @param edd The data descriptor to add the type to.
    * @param struct_type The type of the struct.
    * @param name The string name to use to encode/decode this member
    *        (must be a constant global and never change).
    * @param member The struct member itself to be encoded.
    * @param subtype The type of hash member to add.
    *
    * This macro lets you easily add a fixed size array of other data
    * types. All the parameters are the same as for
    * EET_DATA_DESCRIPTOR_ADD_BASIC(), with the @p subtype being the
    * exception. This must be the data descriptor of the element that
    * is in each member of the hash to be stored.
    *
    * @since 1.0.2
    * @ingroup Eet_Data_Group
    */
#define EET_DATA_DESCRIPTOR_ADD_VAR_ARRAY(edd, struct_type, name, member, subtype) \
     { \
	struct_type ___ett; \
	\
	eet_data_descriptor_element_add(edd, name, EET_T_UNKNOW, EET_G_VAR_ARRAY, \
					(char *)(&(___ett.member)) - (char *)(&(___ett)), \
					(char *)(&(___ett.member ## _count)) - (char *)(&(___ett)), /* 0,  */NULL, subtype); \
     }

   /**
    * @defgroup Eet_Data_Cipher_Group Eet Data Serialization using A Ciphers
    *
    * Most of the @ref Eet_Data_Group have alternative versions that
    * accounts for ciphers to protect their content.
    *
    * @see @ref Eet_Cipher_Group
    *
    * @ingroup Eet_Data_Group
    */

   /**
    * Read a data structure from an eet file and decodes it using a cipher.
    * @param ef The eet file handle to read from.
    * @param edd The data descriptor handle to use when decoding.
    * @param name The key the data is stored under in the eet file.
    * @param cipher_key The key to use as cipher.
    * @return A pointer to the decoded data structure.
    *
    * This function decodes a data structure stored in an eet file, returning
    * a pointer to it if it decoded successfully, or NULL on failure. This
    * can save a programmer dozens of hours of work in writing configuration
    * file parsing and writing code, as eet does all that work for the program
    * and presents a program-friendly data structure, just as the programmer
    * likes. Eet can handle members being added or deleted from the data in
    * storage and safely zero-fills unfilled members if they were not found
    * in the data. It checks sizes and headers whenever it reads data, allowing
    * the programmer to not worry about corrupt data.
    *
    * Once a data structure has been described by the programmer with the
    * fields they wish to save or load, storing or retrieving a data structure
    * from an eet file, or from a chunk of memory is as simple as a single
    * function call.
    *
    * @see eet_data_read()
    *
    * @since 1.0.0
    * @ingroup Eet_Data_Cipher_Group
    */
   EAPI void *eet_data_read_cipher(Eet_File *ef, Eet_Data_Descriptor *edd, const char *name, const char *cipher_key);

   /**
    * Write a data structure from memory and store in an eet file
    * using a cipher.
    * @param ef The eet file handle to write to.
    * @param edd The data descriptor to use when encoding.
    * @param name The key to store the data under in the eet file.
    * @param cipher_key The key to use as cipher.
    * @param data A pointer to the data structure to ssave and encode.
    * @param compress Compression flags for storage.
    * @return bytes written on successful write, 0 on failure.
    *
    * This function is the reverse of eet_data_read(), saving a data structure
    * to an eet file.
    *
    * @see eet_data_write_cipher()
    *
    * @since 1.0.0
    * @ingroup Eet_Data_Cipher_Group
    */
   EAPI int eet_data_write_cipher(Eet_File *ef, Eet_Data_Descriptor *edd, const char *name, const char *cipher_key, const void *data, int compress);

   /**
    * Dump an eet encoded data structure into ascii text using a cipher.
    * @param data_in The pointer to the data to decode into a struct.
    * @param cipher_key The key to use as cipher.
    * @param size_in The size of the data pointed to in bytes.
    * @param dumpfunc The function to call passed a string when new
    *        data is converted to text
    * @param dumpdata The data to pass to the @p dumpfunc callback.
    * @return 1 on success, 0 on failure
    *
    * This function will take a chunk of data encoded by
    * eet_data_descriptor_encode() and convert it into human readable
    * ascii text.  It does this by calling the @p dumpfunc callback
    * for all new text that is generated. This callback should append
    * to any existing text buffer and will be passed the pointer @p
    * dumpdata as a parameter as well as a string with new text to be
    * appended.
    *
    * Example:
    *
    * @code
    * void output(void *data, const char *string)
    * {
    *   printf("%s", string);
    * }
    *
    * void dump(const char *file)
    * {
    *   FILE *f;
    *   int len;
    *   void *data;
    *
    *   f = fopen(file, "r");
    *   fseek(f, 0, SEEK_END);
    *   len = ftell(f);
    *   rewind(f);
    *   data = malloc(len);
    *   fread(data, len, 1, f);
    *   fclose(f);
    *   eet_data_text_dump_cipher(data, cipher_key, len, output, NULL);
    * }
    * @endcode
    *
    * @see eet_data_text_dump()
    *
    * @since 1.0.0
    * @ingroup Eet_Data_Cipher_Group
    */
   EAPI int eet_data_text_dump_cipher(const void *data_in, const char *cipher_key, int size_in, void (*dumpfunc) (void *data, const char *str), void *dumpdata);

   /**
    * Take an ascii encoding from eet_data_text_dump() and re-encode
    * in binary using a cipher.
    * @param text The pointer to the string data to parse and encode.
    * @param cipher_key The key to use as cipher.
    * @param textlen The size of the string in bytes (not including 0
    *        byte terminator).
    * @param size_ret This gets filled in with the encoded data blob
    *        size in bytes.
    * @return The encoded data on success, NULL on failure.
    *
    * This function will parse the string pointed to by @p text and return
    * an encoded data lump the same way eet_data_descriptor_encode() takes an
    * in-memory data struct and encodes into a binary blob. @p text is a normal
    * C string.
    *
    * @see eet_data_text_undump()
    *
    * @since 1.0.0
    * @ingroup Eet_Data_Cipher_Group
    */
   EAPI void *eet_data_text_undump_cipher(const char *text, const char *cipher_key, int textlen, int *size_ret);

   /**
    * Dump an eet encoded data structure from an eet file into ascii
    * text using a cipher.
    * @param ef A valid eet file handle.
    * @param name Name of the entry. eg: "/base/file_i_want".
    * @param cipher_key The key to use as cipher.
    * @param dumpfunc The function to call passed a string when new
    *        data is converted to text
    * @param dumpdata The data to pass to the @p dumpfunc callback.
    * @return 1 on success, 0 on failure
    *
    * This function will take an open and valid eet file from
    * eet_open() request the data encoded by
    * eet_data_descriptor_encode() corresponding to the key @p name
    * and convert it into human readable ascii text. It does this by
    * calling the @p dumpfunc callback for all new text that is
    * generated. This callback should append to any existing text
    * buffer and will be passed the pointer @p dumpdata as a parameter
    * as well as a string with new text to be appended.
    *
    * @see eet_data_dump()
    *
    * @since 1.0.0
    * @ingroup Eet_Data_Cipher_Group
    */
   EAPI int eet_data_dump_cipher(Eet_File *ef, const char *name, const char *cipher_key, void (*dumpfunc) (void *data, const char *str), void *dumpdata);

   /**
    * Take an ascii encoding from eet_data_dump() and re-encode in
    * binary using a cipher.
    * @param ef A valid eet file handle.
    * @param name Name of the entry. eg: "/base/file_i_want".
    * @param cipher_key The key to use as cipher.
    * @param text The pointer to the string data to parse and encode.
    * @param textlen The size of the string in bytes (not including 0
    *        byte terminator).
    * @param compress Compression flags (1 == compress, 0 = don't compress).
    * @return 1 on success, 0 on failure
    *
    * This function will parse the string pointed to by @p text,
    * encode it the same way eet_data_descriptor_encode() takes an
    * in-memory data struct and encodes into a binary blob.
    *
    * The data (optionally compressed) will be in ram, pending a flush to
    * disk (it will stay in ram till the eet file handle is closed though).
    *
    * @see eet_data_undump()
    *
    * @since 1.0.0
    * @ingroup Eet_Data_Cipher_Group
    */
   EAPI int eet_data_undump_cipher(Eet_File *ef, const char *name, const char *cipher_key, const char *text, int textlen, int compress);

   /**
    * Decode a data structure from an arbitary location in memory
    * using a cipher.
    * @param edd The data  descriptor to use when decoding.
    * @param data_in The pointer to the data to decode into a struct.
    * @param cipher_key The key to use as cipher.
    * @param size_in The size of the data pointed to in bytes.
    * @return NULL on failure, or a valid decoded struct pointer on success.
    *
    * This function will decode a data structure that has been encoded using
    * eet_data_descriptor_encode(), and return a data structure with all its
    * elements filled out, if successful, or NULL on failure.
    *
    * The data to be decoded is stored at the memory pointed to by @p data_in,
    * and is described by the descriptor pointed to by @p edd. The data size is
    * passed in as the value to @p size_in, ande must be greater than 0 to
    * succeed.
    *
    * This function is useful for decoding data structures delivered to the
    * application by means other than an eet file, such as an IPC or socket
    * connection, raw files, shared memory etc.
    *
    * Please see eet_data_read() for more information.
    *
    * @see eet_data_descriptor_decode()
    *
    * @since 1.0.0
    * @ingroup Eet_Data_Cipher_Group
    */
   EAPI void *eet_data_descriptor_decode_cipher(Eet_Data_Descriptor *edd, const void *data_in, const char *cipher_key, int size_in);

   /**
    * Encode a dsata struct to memory and return that encoded data
    * using a cipher.
    * @param edd The data  descriptor to use when encoding.
    * @param data_in The pointer to the struct to encode into data.
    * @param cipher_key The key to use as cipher.
    * @param size_ret pointer to the an int to be filled with the decoded size.
    * @return NULL on failure, or a valid encoded data chunk on success.
    *
    * This function takes a data structutre in memory and encodes it into a
    * serialised chunk of data that can be decoded again by
    * eet_data_descriptor_decode(). This is useful for being able to transmit
    * data structures across sockets, pipes, IPC or shared file mechanisms,
    * without having to worry about memory space, machine type, endianess etc.
    *
    * The parameter @p edd must point to a valid data descriptor, and
    * @p data_in must point to the right data structure to encode. If not, the
    * encoding may fail.
    *
    * On success a non NULL valid pointer is returned and what @p size_ret
    * points to is set to the size of this decoded data, in bytes. When the
    * encoded data is no longer needed, call free() on it. On failure NULL is
    * returned and what @p size_ret points to is set to 0.
    *
    * Please see eet_data_write() for more information.
    *
    * @see eet_data_descriptor_encode()
    *
    * @since 1.0.0
    * @ingroup Eet_Data_Cipher_Group
    */
   EAPI void *eet_data_descriptor_encode_cipher(Eet_Data_Descriptor *edd, const void *data_in, const char *cipher_key, int *size_ret);


  /**
   * @defgroup Eet_Node_Group Low-level Serialization Structures.
   *
   * Functions that create, destroy and manipulate serialization nodes
   * used by @ref Eet_Data_Group.
   *
   * @{
   */

  /**
   * @typedef Eet_Node
   * Opaque handle to manage serialization node.
   */
   typedef struct _Eet_Node                  Eet_Node;

  /**
   * @typedef Eet_Node_Data
   * Contains an union that can fit any kind of node.
   */
   typedef struct _Eet_Node_Data             Eet_Node_Data;

  /**
   * @struct _Eet_Node_Data
   * Contains an union that can fit any kind of node.
   */
   struct _Eet_Node_Data
   {
      union {
	 char c;
	 short s;
	 int i;
	 long long l;
	 float f;
	 double d;
	 unsigned char uc;
	 unsigned short us;
	 unsigned int ui;
	 unsigned long long ul;
	 const char *str;
      } value;
   };

  /**
   * @}
   */

  /**
   * TODO FIX ME
   * @ingroup Eet_Node_Group
   */
   EAPI Eet_Node *eet_node_char_new(const char *name, char c);

  /**
   * TODO FIX ME
   * @ingroup Eet_Node_Group
   */
   EAPI Eet_Node *eet_node_short_new(const char *name, short s);

  /**
   * TODO FIX ME
   * @ingroup Eet_Node_Group
   */
   EAPI Eet_Node *eet_node_int_new(const char *name, int i);

  /**
   * TODO FIX ME
   * @ingroup Eet_Node_Group
   */
   EAPI Eet_Node *eet_node_long_long_new(const char *name, long long l);

  /**
   * TODO FIX ME
   * @ingroup Eet_Node_Group
   */
   EAPI Eet_Node *eet_node_float_new(const char *name, float f);

  /**
   * TODO FIX ME
   * @ingroup Eet_Node_Group
   */
   EAPI Eet_Node *eet_node_double_new(const char *name, double d);

  /**
   * TODO FIX ME
   * @ingroup Eet_Node_Group
   */
   EAPI Eet_Node *eet_node_unsigned_char_new(const char *name, unsigned char uc);

  /**
   * TODO FIX ME
   * @ingroup Eet_Node_Group
   */
   EAPI Eet_Node *eet_node_unsigned_short_new(const char *name, unsigned short us);

  /**
   * TODO FIX ME
   * @ingroup Eet_Node_Group
   */
   EAPI Eet_Node *eet_node_unsigned_int_new(const char *name, unsigned int ui);

  /**
   * TODO FIX ME
   * @ingroup Eet_Node_Group
   */
   EAPI Eet_Node *eet_node_unsigned_long_long_new(const char *name, unsigned long long l);

  /**
   * TODO FIX ME
   * @ingroup Eet_Node_Group
   */
   EAPI Eet_Node *eet_node_string_new(const char *name, const char *str);

  /**
   * TODO FIX ME
   * @ingroup Eet_Node_Group
   */
   EAPI Eet_Node *eet_node_inlined_string_new(const char *name, const char *str);

  /**
   * TODO FIX ME
   * @ingroup Eet_Node_Group
   */
   EAPI Eet_Node *eet_node_null_new(const char *name);

  /**
   * TODO FIX ME
   * @ingroup Eet_Node_Group
   */
   EAPI Eet_Node *eet_node_list_new(const char *name, Eina_List *nodes);

  /**
   * TODO FIX ME
   * @ingroup Eet_Node_Group
   */
   EAPI Eet_Node *eet_node_array_new(const char *name, int count, Eina_List *nodes);

  /**
   * TODO FIX ME
   * @ingroup Eet_Node_Group
   */
   EAPI Eet_Node *eet_node_var_array_new(const char *name, Eina_List *nodes);

  /**
   * TODO FIX ME
   * @ingroup Eet_Node_Group
   */
   EAPI Eet_Node *eet_node_hash_new(const char *name, const char *key, Eet_Node *node);

  /**
   * TODO FIX ME
   * @ingroup Eet_Node_Group
   */
   EAPI Eet_Node *eet_node_struct_new(const char *name, Eina_List *nodes);

  /**
   * TODO FIX ME
   * @ingroup Eet_Node_Group
   */
   EAPI Eet_Node *eet_node_struct_child_new(const char *parent, Eet_Node *child);


  /**
   * TODO FIX ME
   * @ingroup Eet_Node_Group
   */
   EAPI void eet_node_list_append(Eet_Node *parent, const char *name, Eet_Node *child);

  /**
   * TODO FIX ME
   * @ingroup Eet_Node_Group
   */
   EAPI void eet_node_struct_append(Eet_Node *parent, const char *name, Eet_Node *child);

  /**
   * TODO FIX ME
   * @ingroup Eet_Node_Group
   */
   EAPI void eet_node_hash_add(Eet_Node *parent, const char *name, const char *key, Eet_Node *child);


  /**
   * TODO FIX ME
   * @ingroup Eet_Node_Group
   */
   EAPI void eet_node_dump(Eet_Node *n, int dumplevel, void (*dumpfunc) (void *data, const char *str), void *dumpdata);

  /**
   * TODO FIX ME
   * @ingroup Eet_Node_Group
   */
   EAPI void eet_node_del(Eet_Node *n);

  /**
   * TODO FIX ME
   * @ingroup Eet_Node_Group
   */
   EAPI void *eet_data_node_encode_cipher(Eet_Node *node, const char *cipher_key, int *size_ret);

  /**
   * TODO FIX ME
   * @ingroup Eet_Node_Group
   */
   EAPI void *eet_data_node_decode_cipher(const void *data_in, const char *cipher_key, int size_in);

  /**
   * TODO FIX ME
   * @ingroup Eet_Node_Group
   */
   EAPI Eet_Node *eet_data_node_read_cipher(Eet_File *ef, const char *name, const char *cipher_key);

  /**
   * TODO FIX ME
   * @ingroup Eet_Node_Group
   */
   EAPI int eet_data_node_write_cipher(Eet_File *ef, const char *name, const char *cipher_key, Eet_Node *node, int compress);

  /* EXPERIMENTAL: THIS API MAY CHANGE IN THE FUTURE, USE IT ONLY IF YOU KNOW WHAT YOU ARE DOING. */

  /**
   * @typedef Eet_Node_Walk
   * Describes how to walk trees of #Eet_Node.
   */
   typedef struct _Eet_Node_Walk             Eet_Node_Walk;

  /**
   * @struct _Eet_Node_Walk
   * Describes how to walk trees of #Eet_Node.
   */
   struct _Eet_Node_Walk
   {
      void *(*struct_alloc)(const char *type, void *user_data);
      void (*struct_add)(void *parent, const char *name, void *child, void *user_data);
      void *(*array)(Eina_Bool variable, const char *name, int count, void *user_data);
      void (*insert)(void *array, int index, void *child, void *user_data);
      void *(*list)(const char *name, void *user_data);
      void (*append)(void *list, void *child, void *user_data);
      void *(*hash)(void *parent, const char *name, const char *key, void *value, void *user_data);
      void *(*simple)(int type, Eet_Node_Data *data, void *user_data);
   };

   EAPI void *eet_node_walk(void *parent, const char *name, Eet_Node *root, Eet_Node_Walk *cb, void *user_data);

/***************************************************************************/

#ifdef __cplusplus
}
#endif

#endif