summaryrefslogtreecommitdiff
path: root/src/lib/eet
diff options
context:
space:
mode:
authorMyoungwoon Roy, Kim <myoungwoon.kim@samsung.com>2017-02-16 10:16:49 -0800
committerCedric BAIL <cedric@osg.samsung.com>2017-02-16 10:16:52 -0800
commit7760613107f164f14e706deb96c0ae9ac6614417 (patch)
tree1709c85f7aae2a84ad3ff4933776b210af1b0ab6 /src/lib/eet
parentcbe7859d1c79fbb991186605b5ea2defdfe9ef52 (diff)
doxygen: fix typos and some wrong expressions in Edje and Eet API reference documentation.
Summary: I had fixed some typos and some wrong expressions, such as capital letters, singular, and orders of groups in Edje and Eet API reference doxygen. Test Plan: Doxygen Revision Reviewers: stefan, cedric, raster, Jaehyun_Cho, jpeg Subscribers: conr2d Differential Revision: https://phab.enlightenment.org/D4666 Signed-off-by: Cedric BAIL <cedric@osg.samsung.com>
Diffstat (limited to 'src/lib/eet')
-rw-r--r--src/lib/eet/Eet.h743
1 files changed, 372 insertions, 371 deletions
diff --git a/src/lib/eet/Eet.h b/src/lib/eet/Eet.h
index f2ef50c42a..688e82906b 100644
--- a/src/lib/eet/Eet.h
+++ b/src/lib/eet/Eet.h
@@ -1,7 +1,7 @@
1/** 1/**
2 @brief Eet Data Handling Library Public API Calls 2 @brief Eet Data Handling Library Public API Calls.
3 3
4 These routines are used for Eet Library interaction 4 These routines are used for Eet Library interaction.
5 5
6 @page eet_main Eet 6 @page eet_main Eet
7 7
@@ -140,12 +140,12 @@ extern "C" {
140 140
141/** 141/**
142 * @def EET_VERSION_MAJOR 142 * @def EET_VERSION_MAJOR
143 * The major number of eet version 143 * The major number of eet version.
144 */ 144 */
145#define EET_VERSION_MAJOR EFL_VERSION_MAJOR 145#define EET_VERSION_MAJOR EFL_VERSION_MAJOR
146/** 146/**
147 * @def EET_VERSION_MINOR 147 * @def EET_VERSION_MINOR
148 * The minor number of eet version 148 * The minor number of eet version.
149 */ 149 */
150#define EET_VERSION_MINOR EFL_VERSION_MINOR 150#define EET_VERSION_MINOR EFL_VERSION_MINOR
151/** 151/**
@@ -255,23 +255,24 @@ typedef enum _Eet_Compression
255 */ 255 */
256 256
257/** 257/**
258 * Initialize the EET library. 258 * @ingroup Eet_Group
259 * @brief Initializes the EET library.
259 * 260 *
260 * The first time this function is called, it will perform all the internal 261 * The first time this function is called, it will perform all the internal
261 * initialization required for the library to function properly and increment 262 * initialization required for the library to function properly and increment
262 * the initialization counter. Any subsequent call only increment this counter 263 * the initialization counter. Any subsequent call only increment this counter
263 * and return its new value, so it's safe to call this function more than once. 264 * and return its new value, so it's safe to call this function more than once.
264 * 265 *
265 * @return The new init count. Will be 0 if initialization failed. 266 * @return The new init count. Will be @c 0 if initialization failed.
266 * 267 *
267 * @since 1.0.0 268 * @since 1.0.0
268 * @ingroup Eet_Group
269 */ 269 */
270EAPI int 270EAPI int
271eet_init(void); 271eet_init(void);
272 272
273/** 273/**
274 * Shut down the EET library. 274 * @ingroup Eet_Group
275 * @brief Shuts down the EET library.
275 * 276 *
276 * If eet_init() was called more than once for the running application, 277 * If eet_init() was called more than once for the running application,
277 * eet_shutdown() will decrement the initialization counter and return its 278 * eet_shutdown() will decrement the initialization counter and return its
@@ -281,13 +282,13 @@ eet_init(void);
281 * @return The new init count. 282 * @return The new init count.
282 * 283 *
283 * @since 1.0.0 284 * @since 1.0.0
284 * @ingroup Eet_Group
285 */ 285 */
286EAPI int 286EAPI int
287eet_shutdown(void); 287eet_shutdown(void);
288 288
289/** 289/**
290 * Clear eet cache 290 * @ingroup Eet_Group
291 * @Clears eet cache.
291 * 292 *
292 * For a faster access to previously accessed data, Eet keeps an internal 293 * For a faster access to previously accessed data, Eet keeps an internal
293 * cache of files. These files will be freed automatically only when 294 * cache of files. These files will be freed automatically only when
@@ -300,7 +301,6 @@ eet_shutdown(void);
300 * will be written down to disk before flushing them from memory. 301 * will be written down to disk before flushing them from memory.
301 * 302 *
302 * @since 1.0.0 303 * @since 1.0.0
303 * @ingroup Eet_Group
304 */ 304 */
305EAPI void 305EAPI void
306eet_clearcache(void); 306eet_clearcache(void);
@@ -312,7 +312,7 @@ eet_clearcache(void);
312 * Functions to create, destroy and do basic manipulation of 312 * Functions to create, destroy and do basic manipulation of
313 * #Eet_File handles. 313 * #Eet_File handles.
314 * 314 *
315 * This sections explains how to use the most basic Eet functions, which 315 * This section explains how to use the most basic Eet functions, which
316 * are used to work with eet files, read data from them, store it back in or 316 * are used to work with eet files, read data from them, store it back in or
317 * take a look at what entries it contains, without making use of the 317 * take a look at what entries it contains, without making use of the
318 * serialization capabilities explained in @ref Eet_Data_Group. 318 * serialization capabilities explained in @ref Eet_Data_Group.
@@ -549,12 +549,12 @@ struct _Eet_Entry
549 */ 549 */
550 550
551/** 551/**
552 * Open an eet file on disk, and returns a handle to it. 552 * @ingroup Eet_File_Group
553 * @brief Opens an eet file on disk, and returns a handle to it.
553 * @param file The file path to the eet file. eg: @c "/tmp/file.eet". 554 * @param file The file path to the eet file. eg: @c "/tmp/file.eet".
554 * @param mode The mode for opening. Either #EET_FILE_MODE_READ, 555 * @param mode The mode for opening. Either #EET_FILE_MODE_READ,
555 * #EET_FILE_MODE_WRITE or #EET_FILE_MODE_READ_WRITE. 556 * #EET_FILE_MODE_WRITE or #EET_FILE_MODE_READ_WRITE.
556 * @return An opened eet file handle. 557 * @return An opened eet file handle.
557 * @ingroup Eet_File_Group
558 * 558 *
559 * This function will open an exiting eet file for reading, and build 559 * This function will open an exiting eet file for reading, and build
560 * the directory table in memory and return a handle to the file, if it 560 * the directory table in memory and return a handle to the file, if it
@@ -592,10 +592,10 @@ eet_open(const char *file,
592 Eet_File_Mode mode); 592 Eet_File_Mode mode);
593 593
594/** 594/**
595 * Open an eet file on disk from an Eina_File handle, and returns a handle to it. 595 * @ingroup Eet_File_Group
596 * @brief Opens an eet file on disk from an Eina_File handle, and returns a handle to it.
596 * @param file The Eina_File handle to map to an eet file. 597 * @param file The Eina_File handle to map to an eet file.
597 * @return An opened eet file handle. 598 * @return An opened eet file handle.
598 * @ingroup Eet_File_Group
599 * 599 *
600 * This function will open an exiting eet file for reading, and build 600 * This function will open an exiting eet file for reading, and build
601 * the directory table in memory and return a handle to the file, if it 601 * the directory table in memory and return a handle to the file, if it
@@ -617,7 +617,8 @@ EAPI Eet_File *
617eet_mmap(const Eina_File *file); 617eet_mmap(const Eina_File *file);
618 618
619/** 619/**
620 * Open an eet file directly from a memory location. The data is not copied, 620 * @ingroup Eet_File_Group
621 * Opens an eet file directly from a memory location. The data is not copied,
621 * so you must keep it around as long as the eet file is open. There is 622 * so you must keep it around as long as the eet file is open. There is
622 * currently no cache for this kind of Eet_File, so it's reopened every time 623 * currently no cache for this kind of Eet_File, so it's reopened every time
623 * you use eet_memopen_read. 624 * you use eet_memopen_read.
@@ -628,25 +629,25 @@ eet_mmap(const Eina_File *file);
628 * Files opened this way will always be in read-only mode. 629 * Files opened this way will always be in read-only mode.
629 * 630 *
630 * @since 1.1.0 631 * @since 1.1.0
631 * @ingroup Eet_File_Group
632 */ 632 */
633EAPI Eet_File * 633EAPI Eet_File *
634eet_memopen_read(const void *data, 634eet_memopen_read(const void *data,
635 size_t size); 635 size_t size);
636 636
637/** 637/**
638 * Get the mode an Eet_File was opened with. 638 * @ingroup Eet_File_Group
639 * @brief Gets the mode an Eet_File was opened with.
639 * @param ef A valid eet file handle. 640 * @param ef A valid eet file handle.
640 * @return The mode ef was opened with. 641 * @return The mode ef was opened with.
641 * 642 *
642 * @since 1.0.0 643 * @since 1.0.0
643 * @ingroup Eet_File_Group
644 */ 644 */
645EAPI Eet_File_Mode 645EAPI Eet_File_Mode
646eet_mode_get(Eet_File *ef); 646eet_mode_get(Eet_File *ef);
647 647
648/** 648/**
649 * Close an eet file handle and flush pending writes. 649 * @ingroup Eet_File_Group
650 * @brief Closes an eet file handle and flush pending writes.
650 * @param ef A valid eet file handle. 651 * @param ef A valid eet file handle.
651 * @return An eet error identifier. 652 * @return An eet error identifier.
652 * 653 *
@@ -659,7 +660,6 @@ eet_mode_get(Eet_File *ef);
659 * If the eet file handle is not valid nothing will be done. 660 * If the eet file handle is not valid nothing will be done.
660 * 661 *
661 * @since 1.0.0 662 * @since 1.0.0
662 * @ingroup Eet_File_Group
663 * 663 *
664 * @see eet_clearcache() 664 * @see eet_clearcache()
665 */ 665 */
@@ -667,7 +667,8 @@ EAPI Eet_Error
667eet_close(Eet_File *ef); 667eet_close(Eet_File *ef);
668 668
669/** 669/**
670 * Sync content of an eet file handle, flushing pending writes. 670 * @ingroup Eet_File_Group
671 * @brief Syncs content of an eet file handle, flushing pending writes.
671 * @param ef A valid eet file handle. 672 * @param ef A valid eet file handle.
672 * @return An eet error identifier. 673 * @return An eet error identifier.
673 * 674 *
@@ -677,13 +678,13 @@ eet_close(Eet_File *ef);
677 * If the eet file handle is not valid nothing will be done. 678 * If the eet file handle is not valid nothing will be done.
678 * 679 *
679 * @since 1.2.4 680 * @since 1.2.4
680 * @ingroup Eet_File_Group
681 */ 681 */
682EAPI Eet_Error 682EAPI Eet_Error
683eet_sync(Eet_File *ef); 683eet_sync(Eet_File *ef);
684 684
685/** 685/**
686 * Return a handle to the shared string dictionary of the Eet file 686 * @ingroup Eet_File_Group
687 * @brief Returns a handle to the shared string dictionary of the Eet file
687 * @param ef A valid eet file handle. 688 * @param ef A valid eet file handle.
688 * @return A handle to the dictionary of the file 689 * @return A handle to the dictionary of the file
689 * 690 *
@@ -696,42 +697,42 @@ eet_sync(Eet_File *ef);
696 * the #Eet_Data_Descriptor_Class instructions. 697 * the #Eet_Data_Descriptor_Class instructions.
697 * 698 *
698 * @since 1.0.0 699 * @since 1.0.0
699 * @ingroup Eet_File_Group
700 */ 700 */
701EAPI Eet_Dictionary * 701EAPI Eet_Dictionary *
702eet_dictionary_get(Eet_File *ef); 702eet_dictionary_get(Eet_File *ef);
703 703
704/** 704/**
705 * Check if a given string comes from a given dictionary 705 * @ingroup Eet_File_Group
706 * @brief Checks if a given string comes from a given dictionary
706 * @param ed A valid dictionary handle 707 * @param ed A valid dictionary handle
707 * @param string A valid 0 byte terminated C string 708 * @param string A valid 0 byte terminated C string
708 * @return 1 if it is in the dictionary, 0 otherwise 709 * @return @c 1 if it is in the dictionary, @c 0 otherwise
709 * 710 *
710 * This checks the given dictionary to see if the given string is actually 711 * This checks the given dictionary to see if the given string is actually
711 * inside that dictionary (i.e. comes from it) and returns 1 if it does. 712 * inside that dictionary (i.e. comes from it) and returns @c 1 if it does.
712 * If the dictionary handle is invalid, the string is NULL or the string is 713 * If the dictionary handle is invalid, the string is NULL or the string is
713 * not in the dictionary, 0 is returned. 714 * not in the dictionary, @c 0 is returned.
714 * 715 *
715 * @since 1.0.0 716 * @since 1.0.0
716 * @ingroup Eet_File_Group
717 */ 717 */
718EAPI int 718EAPI int
719eet_dictionary_string_check(Eet_Dictionary *ed, 719eet_dictionary_string_check(Eet_Dictionary *ed,
720 const char *string); 720 const char *string);
721 721
722/** 722/**
723 * Return the number of strings inside a dictionary 723 * @ingroup Eet_File_Group
724 * @brief Returns the number of strings inside a dictionary.
724 * @param ed A valid dictionary handle 725 * @param ed A valid dictionary handle
725 * @return the number of strings inside a dictionary 726 * @return the number of strings inside a dictionary
726 * 727 *
727 * @since 1.6.0 728 * @since 1.6.0
728 * @ingroup Eet_File_Group
729 */ 729 */
730EAPI int 730EAPI int
731eet_dictionary_count(const Eet_Dictionary *ed); 731eet_dictionary_count(const Eet_Dictionary *ed);
732 732
733/** 733/**
734 * Read a specified entry from an eet file and return data 734 * @ingroup Eet_File_Group
735 * @brief Reads a specified entry from an eet file and return data.
735 * @param ef A valid eet file handle opened for reading. 736 * @param ef A valid eet file handle opened for reading.
736 * @param name Name of the entry. eg: "/base/file_i_want". 737 * @param name Name of the entry. eg: "/base/file_i_want".
737 * @param size_ret Number of bytes read from entry and returned. 738 * @param size_ret Number of bytes read from entry and returned.
@@ -745,12 +746,11 @@ eet_dictionary_count(const Eet_Dictionary *ed);
745 * placed in size_ret. 746 * placed in size_ret.
746 * 747 *
747 * If the eet file handle is not valid NULL is returned and size_ret is 748 * If the eet file handle is not valid NULL is returned and size_ret is
748 * filled with 0. 749 * filled with @c 0.
749 * 750 *
750 * @see eet_read_cipher() 751 * @see eet_read_cipher()
751 * 752 *
752 * @since 1.0.0 753 * @since 1.0.0
753 * @ingroup Eet_File_Group
754 */ 754 */
755EAPI void * 755EAPI void *
756eet_read(Eet_File *ef, 756eet_read(Eet_File *ef,
@@ -758,7 +758,8 @@ eet_read(Eet_File *ef,
758 int *size_ret); 758 int *size_ret);
759 759
760/** 760/**
761 * Read a specified entry from an eet file and return data 761 * @ingroup Eet_File_Group
762 * @brief Reads a specified entry from an eet file and return data.
762 * @param ef A valid eet file handle opened for reading. 763 * @param ef A valid eet file handle opened for reading.
763 * @param name Name of the entry. eg: "/base/file_i_want". 764 * @param name Name of the entry. eg: "/base/file_i_want".
764 * @param size_ret Number of bytes read from entry and returned. 765 * @param size_ret Number of bytes read from entry and returned.
@@ -772,10 +773,9 @@ eet_read(Eet_File *ef,
772 * data chunk are placed in size_ret. 773 * data chunk are placed in size_ret.
773 * 774 *
774 * If the eet file handle is not valid NULL is returned and size_ret is 775 * If the eet file handle is not valid NULL is returned and size_ret is
775 * filled with 0. 776 * filled with @c 0.
776 * 777 *
777 * @since 1.0.0 778 * @since 1.0.0
778 * @ingroup Eet_File_Group
779 */ 779 */
780EAPI const void * 780EAPI const void *
781eet_read_direct(Eet_File *ef, 781eet_read_direct(Eet_File *ef,
@@ -783,7 +783,8 @@ eet_read_direct(Eet_File *ef,
783 int *size_ret); 783 int *size_ret);
784 784
785/** 785/**
786 * Write a specified entry to an eet file handle 786 * @ingroup Eet_File_Group
787 * @brief Write a specified entry to an eet file handle.
787 * @param ef A valid eet file handle opened for writing. 788 * @param ef A valid eet file handle opened for writing.
788 * @param name Name of the entry. eg: "/base/file_i_want". 789 * @param name Name of the entry. eg: "/base/file_i_want".
789 * @param data Pointer to the data to be stored. 790 * @param data Pointer to the data to be stored.
@@ -808,7 +809,6 @@ eet_read_direct(Eet_File *ef,
808 * @see eet_write_cipher() 809 * @see eet_write_cipher()
809 * 810 *
810 * @since 1.0.0 811 * @since 1.0.0
811 * @ingroup Eet_File_Group
812 */ 812 */
813EAPI int 813EAPI int
814eet_write(Eet_File *ef, 814eet_write(Eet_File *ef,
@@ -818,7 +818,8 @@ eet_write(Eet_File *ef,
818 int compress); 818 int compress);
819 819
820/** 820/**
821 * Delete a specified entry from an Eet file being written or re-written 821 * @ingroup Eet_File_Group
822 * @brief Deletes a specified entry from an Eet file being written or re-written.
822 * @param ef A valid eet file handle opened for writing. 823 * @param ef A valid eet file handle opened for writing.
823 * @param name Name of the entry. eg: "/base/file_i_want". 824 * @param name Name of the entry. eg: "/base/file_i_want".
824 * @return Success or failure of the delete. 825 * @return Success or failure of the delete.
@@ -833,14 +834,14 @@ eet_write(Eet_File *ef,
833 * Name, must not be NULL, otherwise 0 will be returned. 834 * Name, must not be NULL, otherwise 0 will be returned.
834 * 835 *
835 * @since 1.0.0 836 * @since 1.0.0
836 * @ingroup Eet_File_Group
837 */ 837 */
838EAPI int 838EAPI int
839eet_delete(Eet_File *ef, 839eet_delete(Eet_File *ef,
840 const char *name); 840 const char *name);
841 841
842/** 842/**
843 * Alias a specific section to another one. Destination may exist or not, 843 * @ingroup Eet_File_Group
844 * @brief Alias a specific section to another one. Destination may exist or not,
844 * no checks are done. 845 * no checks are done.
845 * @param ef A valid eet file handle opened for writing. 846 * @param ef A valid eet file handle opened for writing.
846 * @param name Name of the new entry. eg: "/base/file_i_want". 847 * @param name Name of the new entry. eg: "/base/file_i_want".
@@ -852,7 +853,6 @@ eet_delete(Eet_File *ef,
852 * The equivalent of this would be calling 'ln -s destination name' 853 * The equivalent of this would be calling 'ln -s destination name'
853 * 854 *
854 * @since 1.3.3 855 * @since 1.3.3
855 * @ingroup Eet_File_Group
856 */ 856 */
857EAPI Eina_Bool 857EAPI Eina_Bool
858eet_alias(Eet_File *ef, 858eet_alias(Eet_File *ef,
@@ -861,20 +861,21 @@ eet_alias(Eet_File *ef,
861 int compress); 861 int compress);
862 862
863/** 863/**
864 * Retrieve the filename of an Eet_File 864 * @ingroup Eet_File_Group
865 * @brief Retrieves the filename of an Eet_File.
865 * @param ef A valid eet file handle opened for writing. 866 * @param ef A valid eet file handle opened for writing.
866 * @return The stringshared file string opened with eet_open(), or NULL on error 867 * @return The stringshared file string opened with eet_open(), or NULL on error
867 * 868 *
868 * @note This function will return NULL for files opened with eet_memopen_read() 869 * @note This function will return NULL for files opened with eet_memopen_read()
869 * 870 *
870 * @since 1.6 871 * @since 1.6
871 * @ingroup Eet_File_Group
872 */ 872 */
873EAPI const char * 873EAPI const char *
874eet_file_get(Eet_File *ef); 874eet_file_get(Eet_File *ef);
875 875
876/** 876/**
877 * Retrieve the destination name of an alias 877 * @ingroup Eet_File_Group
878 * @brief Retrieves the destination name of an alias.
878 * @param ef A valid eet file handle opened for writing 879 * @param ef A valid eet file handle opened for writing
879 * @param name Name of the entry. eg: "/base/file_i_want" 880 * @param name Name of the entry. eg: "/base/file_i_want"
880 * @return Destination of the alias. eg: "/base/the_real_stuff_i_want", NULL on failure 881 * @return Destination of the alias. eg: "/base/the_real_stuff_i_want", NULL on failure
@@ -882,14 +883,14 @@ eet_file_get(Eet_File *ef);
882 * Name must not be NULL, otherwise NULL will be returned. 883 * Name must not be NULL, otherwise NULL will be returned.
883 * 884 *
884 * @since 1.5 885 * @since 1.5
885 * @ingroup Eet_File_Group
886 */ 886 */
887EAPI const char * 887EAPI const char *
888eet_alias_get(Eet_File *ef, 888eet_alias_get(Eet_File *ef,
889 const char *name); 889 const char *name);
890 890
891/** 891/**
892 * List all entries in eet file matching shell glob. 892 * @ingroup Eet_File_Group
893 * @brief Lists all entries in eet file matching shell glob.
893 * @param ef A valid eet file handle. 894 * @param ef A valid eet file handle.
894 * @param glob A shell glob to match against. 895 * @param glob A shell glob to match against.
895 * @param count_ret Number of entries found to match. 896 * @param count_ret Number of entries found to match.
@@ -900,7 +901,7 @@ eet_alias_get(Eet_File *ef,
900 * there are any, and if no memory errors occur. 901 * there are any, and if no memory errors occur.
901 * 902 *
902 * The eet file handle must be valid and glob must not be NULL, or NULL 903 * The eet file handle must be valid and glob must not be NULL, or NULL
903 * will be returned and count_ret will be filled with 0. 904 * will be returned and count_ret will be filled with @c 0.
904 * 905 *
905 * The calling program must call free() on the array returned, but NOT 906 * The calling program must call free() on the array returned, but NOT
906 * on the string pointers in the array. They are taken as read-only 907 * on the string pointers in the array. They are taken as read-only
@@ -908,7 +909,7 @@ eet_alias_get(Eet_File *ef,
908 * the file handle is not closed. When it is closed those pointers in the 909 * the file handle is not closed. When it is closed those pointers in the
909 * array are now not valid and should not be used. 910 * array are now not valid and should not be used.
910 * 911 *
911 * On success the array returned will have a list of string pointers 912 * On success, the array returned will have a list of string pointers
912 * that are the names of the entries that matched, and count_ret will have 913 * that are the names of the entries that matched, and count_ret will have
913 * the number of entries in this array placed in it. 914 * the number of entries in this array placed in it.
914 * 915 *
@@ -916,7 +917,6 @@ eet_alias_get(Eet_File *ef,
916 * value of "*". 917 * value of "*".
917 * 918 *
918 * @since 1.0.0 919 * @since 1.0.0
919 * @ingroup Eet_File_Group
920 */ 920 */
921EAPI char ** 921EAPI char **
922eet_list(Eet_File *ef, 922eet_list(Eet_File *ef,
@@ -924,41 +924,42 @@ eet_list(Eet_File *ef,
924 int *count_ret); 924 int *count_ret);
925 925
926/** 926/**
927 * Return an iterator that will describe each entry of an Eet_File. 927 * @ingroup Eet_File_Group
928 * @brief Returns an iterator that will describe each entry of an Eet_File.
928 * @param ef A valid eet file handle. 929 * @param ef A valid eet file handle.
929 * @return An interator of Eet_Entry. 930 * @return An interator of Eet_Entry.
930 * 931 *
931 * @since 1.8.0 932 * @since 1.8.0
932 * @ingroup Eet_File_Group
933 */ 933 */
934 934
935EAPI Eina_Iterator *eet_list_entries(Eet_File *ef); 935EAPI Eina_Iterator *eet_list_entries(Eet_File *ef);
936 936
937/** 937/**
938 * Return the number of entries in the specified eet file. 938 * @ingroup Eet_File_Group
939 * @brief Returns the number of entries in the specified eet file.
939 * @param ef A valid eet file handle. 940 * @param ef A valid eet file handle.
940 * @return Number of entries in ef or -1 if the number of entries 941 * @return Number of entries in ef or @c -1 if the number of entries
941 * cannot be read due to open mode restrictions. 942 * cannot be read due to open mode restrictions.
942 * 943 *
943 * @since 1.0.0 944 * @since 1.0.0
944 * @ingroup Eet_File_Group
945 */ 945 */
946EAPI int 946EAPI int
947eet_num_entries(Eet_File *ef); 947eet_num_entries(Eet_File *ef);
948 948
949/** 949/**
950 * @defgroup Eet_File_Cipher_Group Eet File Ciphered Main Functions 950 * @defgroup Eet_File_Cipher_Group Eet File Ciphered Main Functions
951 * @ingroup Eet_File_Group
951 * 952 *
952 * Most of the @ref Eet_File_Group have alternative versions that 953 * Most of the @ref Eet_File_Group have alternative versions that
953 * accounts for ciphers to protect their content. 954 * accounts for ciphers to protect their content.
954 * 955 *
955 * @see @ref Eet_Cipher_Group 956 * @see @ref Eet_Cipher_Group
956 * 957 *
957 * @ingroup Eet_File_Group
958 */ 958 */
959 959
960/** 960/**
961 * Read a specified entry from an eet file and return data using a cipher. 961 * @ingroup Eet_File_Cipher_Group
962 * @brif Reads a specified entry from an eet file and return data using a cipher.
962 * @param ef A valid eet file handle opened for reading. 963 * @param ef A valid eet file handle opened for reading.
963 * @param name Name of the entry. eg: "/base/file_i_want". 964 * @param name Name of the entry. eg: "/base/file_i_want".
964 * @param size_ret Number of bytes read from entry and returned. 965 * @param size_ret Number of bytes read from entry and returned.
@@ -973,12 +974,11 @@ eet_num_entries(Eet_File *ef);
973 * placed in size_ret. 974 * placed in size_ret.
974 * 975 *
975 * If the eet file handle is not valid NULL is returned and size_ret is 976 * If the eet file handle is not valid NULL is returned and size_ret is
976 * filled with 0. 977 * filled with @c 0.
977 * 978 *
978 * @see eet_read() 979 * @see eet_read()
979 * 980 *
980 * @since 1.0.0 981 * @since 1.0.0
981 * @ingroup Eet_File_Cipher_Group
982 */ 982 */
983EAPI void * 983EAPI void *
984eet_read_cipher(Eet_File *ef, 984eet_read_cipher(Eet_File *ef,
@@ -987,20 +987,21 @@ eet_read_cipher(Eet_File *ef,
987 const char *cipher_key); 987 const char *cipher_key);
988 988
989/** 989/**
990 * Write a specified entry to an eet file handle using a cipher. 990 * @ingroup Eet_File_Cipher_Group
991 * @brief Writes a specified entry to an eet file handle using a cipher.
991 * @param ef A valid eet file handle opened for writing. 992 * @param ef A valid eet file handle opened for writing.
992 * @param name Name of the entry. eg: "/base/file_i_want". 993 * @param name Name of the entry. eg: "/base/file_i_want".
993 * @param data Pointer to the data to be stored. 994 * @param data Pointer to the data to be stored.
994 * @param size Length in bytes in the data to be stored. 995 * @param size Length in bytes in the data to be stored.
995 * @param compress Compression flags (1 == compress, 0 = don't compress). 996 * @param compress Compression flags (1 == compress, 0 = don't compress).
996 * @param cipher_key The key to use as cipher. 997 * @param cipher_key The key to use as cipher.
997 * @return bytes written on successful write, 0 on failure. 998 * @return Bytes written on successful write, @c 0 on failure.
998 * 999 *
999 * This function will write the specified chunk of data to the eet file 1000 * This function will write the specified chunk of data to the eet file
1000 * and return greater than 0 on success. 0 will be returned on failure. 1001 * and return greater than @c 0 on success. 0 will be returned on failure.
1001 * 1002 *
1002 * The eet file handle must be a valid file handle for an eet file opened 1003 * The eet file handle must be a valid file handle for an eet file opened
1003 * for writing. If it is not, 0 will be returned and no action will be 1004 * for writing. If it is not, @c 0 will be returned and no action will be
1004 * performed. 1005 * performed.
1005 * 1006 *
1006 * Name, and data must not be NULL, and size must be > 0. If these 1007 * Name, and data must not be NULL, and size must be > 0. If these
@@ -1013,7 +1014,6 @@ eet_read_cipher(Eet_File *ef,
1013 * @see eet_write() 1014 * @see eet_write()
1014 * 1015 *
1015 * @since 1.0.0 1016 * @since 1.0.0
1016 * @ingroup Eet_File_Cipher_Group
1017 */ 1017 */
1018EAPI int 1018EAPI int
1019eet_write_cipher(Eet_File *ef, 1019eet_write_cipher(Eet_File *ef,
@@ -1049,7 +1049,8 @@ eet_write_cipher(Eet_File *ef,
1049 */ 1049 */
1050 1050
1051/** 1051/**
1052 * Read just the header data for an image and dont decode the pixels. 1052 * @ingroup Eet_File_Image_Group
1053 * @brief Reads just the header data for an image and dont decode the pixels.
1053 * @param ef A valid eet file handle opened for reading. 1054 * @param ef A valid eet file handle opened for reading.
1054 * @param name Name of the entry. eg: "/base/file_i_want". 1055 * @param name Name of the entry. eg: "/base/file_i_want".
1055 * @param w A pointer to the unsigned int to hold the width in pixels. 1056 * @param w A pointer to the unsigned int to hold the width in pixels.
@@ -1058,7 +1059,7 @@ eet_write_cipher(Eet_File *ef,
1058 * @param compress A pointer to the int to hold the compression amount. 1059 * @param compress A pointer to the int to hold the compression amount.
1059 * @param quality A pointer to the int to hold the quality amount. 1060 * @param quality A pointer to the int to hold the quality amount.
1060 * @param lossy A pointer to the int to hold the lossiness flag. 1061 * @param lossy A pointer to the int to hold the lossiness flag.
1061 * @return 1 on successful decode, 0 otherwise 1062 * @return @c 1 on successful decode, @c 0 otherwise
1062 * 1063 *
1063 * Reads and decodes the image header data stored under the given key and 1064 * Reads and decodes the image header data stored under the given key and
1064 * Eet file. 1065 * Eet file.
@@ -1077,7 +1078,6 @@ eet_write_cipher(Eet_File *ef,
1077 * @see eet_data_image_header_read_cipher() 1078 * @see eet_data_image_header_read_cipher()
1078 * 1079 *
1079 * @since 1.0.0 1080 * @since 1.0.0
1080 * @ingroup Eet_File_Image_Group
1081 */ 1081 */
1082EAPI int 1082EAPI int
1083eet_data_image_header_read(Eet_File *ef, 1083eet_data_image_header_read(Eet_File *ef,
@@ -1090,7 +1090,8 @@ eet_data_image_header_read(Eet_File *ef,
1090 Eet_Image_Encoding *lossy); 1090 Eet_Image_Encoding *lossy);
1091 1091
1092/** 1092/**
1093 * Read image data from the named key in the eet file. 1093 * @ingroup Eet_File_Image_Group
1094 * @brief Reads image data from the named key in the eet file.
1094 * @param ef A valid eet file handle opened for reading. 1095 * @param ef A valid eet file handle opened for reading.
1095 * @param name Name of the entry. eg: "/base/file_i_want". 1096 * @param name Name of the entry. eg: "/base/file_i_want".
1096 * @param w A pointer to the unsigned int to hold the width in pixels. 1097 * @param w A pointer to the unsigned int to hold the width in pixels.
@@ -1122,7 +1123,6 @@ eet_data_image_header_read(Eet_File *ef,
1122 * @see eet_data_image_read_to_surface() 1123 * @see eet_data_image_read_to_surface()
1123 * 1124 *
1124 * @since 1.0.0 1125 * @since 1.0.0
1125 * @ingroup Eet_File_Image_Group
1126 */ 1126 */
1127EAPI void * 1127EAPI void *
1128eet_data_image_read(Eet_File *ef, 1128eet_data_image_read(Eet_File *ef,
@@ -1135,7 +1135,8 @@ eet_data_image_read(Eet_File *ef,
1135 Eet_Image_Encoding *lossy); 1135 Eet_Image_Encoding *lossy);
1136 1136
1137/** 1137/**
1138 * Read image data from the named key in the eet file and store it in the given buffer. 1138 * @ingroup Eet_File_Image_Group
1139 * @brief Reads image data from the named key in the eet file and store it in the given buffer.
1139 * @param ef A valid eet file handle opened for reading. 1140 * @param ef A valid eet file handle opened for reading.
1140 * @param name Name of the entry. eg: "/base/file_i_want". 1141 * @param name Name of the entry. eg: "/base/file_i_want".
1141 * @param src_x The starting x coordinate from where to dump the stream. 1142 * @param src_x The starting x coordinate from where to dump the stream.
@@ -1148,7 +1149,7 @@ eet_data_image_read(Eet_File *ef,
1148 * @param compress A pointer to the int to hold the compression amount. 1149 * @param compress A pointer to the int to hold the compression amount.
1149 * @param quality A pointer to the int to hold the quality amount. 1150 * @param quality A pointer to the int to hold the quality amount.
1150 * @param lossy A pointer to the int to hold the lossiness flag. 1151 * @param lossy A pointer to the int to hold the lossiness flag.
1151 * @return 1 on success, 0 otherwise. 1152 * @return @c 1 on success, @c 0 otherwise.
1152 * 1153 *
1153 * Reads and decodes the image stored in the given Eet file, placing the 1154 * Reads and decodes the image stored in the given Eet file, placing the
1154 * resulting pixel data in the buffer pointed by the user. 1155 * resulting pixel data in the buffer pointed by the user.
@@ -1180,7 +1181,6 @@ eet_data_image_read(Eet_File *ef,
1180 * @see eet_data_image_decode_to_cspace_surface_cipher() 1181 * @see eet_data_image_decode_to_cspace_surface_cipher()
1181 * 1182 *
1182 * @since 1.0.2 1183 * @since 1.0.2
1183 * @ingroup Eet_File_Image_Group
1184 */ 1184 */
1185EAPI int 1185EAPI int
1186eet_data_image_read_to_surface(Eet_File *ef, 1186eet_data_image_read_to_surface(Eet_File *ef,
@@ -1197,7 +1197,8 @@ eet_data_image_read_to_surface(Eet_File *ef,
1197 Eet_Image_Encoding *lossy); 1197 Eet_Image_Encoding *lossy);
1198 1198
1199/** 1199/**
1200 * Write image data to the named key in an eet file. 1200 * @ingroup Eet_File_Image_Group
1201 * @brief Writes image data to the named key in an eet file.
1201 * @param ef A valid eet file handle opened for writing. 1202 * @param ef A valid eet file handle opened for writing.
1202 * @param name Name of the entry. eg: "/base/file_i_want". 1203 * @param name Name of the entry. eg: "/base/file_i_want".
1203 * @param data A pointer to the image pixel data. 1204 * @param data A pointer to the image pixel data.
@@ -1231,7 +1232,6 @@ eet_data_image_read_to_surface(Eet_File *ef,
1231 * @see eet_data_image_write_cipher() 1232 * @see eet_data_image_write_cipher()
1232 * 1233 *
1233 * @since 1.0.0 1234 * @since 1.0.0
1234 * @ingroup Eet_File_Image_Group
1235 */ 1235 */
1236EAPI int 1236EAPI int
1237eet_data_image_write(Eet_File *ef, 1237eet_data_image_write(Eet_File *ef,
@@ -1245,7 +1245,8 @@ eet_data_image_write(Eet_File *ef,
1245 Eet_Image_Encoding lossy); 1245 Eet_Image_Encoding lossy);
1246 1246
1247/** 1247/**
1248 * Decode Image data header only to get information. 1248 * @ingroup Eet_File_Image_Group
1249 * @brief Decodes Image data header only to get information.
1249 * @param data The encoded pixel data. 1250 * @param data The encoded pixel data.
1250 * @param size The size, in bytes, of the encoded pixel data. 1251 * @param size The size, in bytes, of the encoded pixel data.
1251 * @param w A pointer to the unsigned int to hold the width in pixels. 1252 * @param w A pointer to the unsigned int to hold the width in pixels.
@@ -1254,20 +1255,19 @@ eet_data_image_write(Eet_File *ef,
1254 * @param compress A pointer to the int to hold the compression amount. 1255 * @param compress A pointer to the int to hold the compression amount.
1255 * @param quality A pointer to the int to hold the quality amount. 1256 * @param quality A pointer to the int to hold the quality amount.
1256 * @param lossy A pointer to the int to hold the lossiness flag. 1257 * @param lossy A pointer to the int to hold the lossiness flag.
1257 * @return 1 on success, 0 on failure. 1258 * @return @c 1 on success, @c 0 on failure.
1258 * 1259 *
1259 * This function works exactly like eet_data_image_header_read(), but instead 1260 * This function works exactly like eet_data_image_header_read(), but instead
1260 * of reading from an Eet file, it takes the buffer of size @p size pointed 1261 * of reading from an Eet file, it takes the buffer of size @p size pointed
1261 * by @p data, which must be a valid Eet encoded image. 1262 * by @p data, which must be a valid Eet encoded image.
1262 * 1263 *
1263 * On success the function returns 1 indicating the header was read and 1264 * On success the function returns @c 1 indicating the header was read and
1264 * decoded properly, or 0 on failure. 1265 * decoded properly, or @c 0 on failure.
1265 * 1266 *
1266 * @see eet_data_image_header_read() 1267 * @see eet_data_image_header_read()
1267 * @see eet_data_image_header_decode_cipher() 1268 * @see eet_data_image_header_decode_cipher()
1268 * 1269 *
1269 * @since 1.0.0 1270 * @since 1.0.0
1270 * @ingroup Eet_File_Image_Group
1271 */ 1271 */
1272EAPI int 1272EAPI int
1273eet_data_image_header_decode(const void *data, 1273eet_data_image_header_decode(const void *data,
@@ -1280,7 +1280,8 @@ eet_data_image_header_decode(const void *data,
1280 Eet_Image_Encoding *lossy); 1280 Eet_Image_Encoding *lossy);
1281 1281
1282/** 1282/**
1283 * Decode Image data into pixel data. 1283 * @ingroup Eet_File_Image_Group
1284 * @brief Decodes Image data into pixel data.
1284 * @param data The encoded pixel data. 1285 * @param data The encoded pixel data.
1285 * @param size The size, in bytes, of the encoded pixel data. 1286 * @param size The size, in bytes, of the encoded pixel data.
1286 * @param w A pointer to the unsigned int to hold the width in pixels. 1287 * @param w A pointer to the unsigned int to hold the width in pixels.
@@ -1307,7 +1308,6 @@ eet_data_image_header_decode(const void *data,
1307 * @see eet_data_image_decode_cipher() 1308 * @see eet_data_image_decode_cipher()
1308 * 1309 *
1309 * @since 1.0.0 1310 * @since 1.0.0
1310 * @ingroup Eet_File_Image_Group
1311 */ 1311 */
1312EAPI void * 1312EAPI void *
1313eet_data_image_decode(const void *data, 1313eet_data_image_decode(const void *data,
@@ -1320,7 +1320,8 @@ eet_data_image_decode(const void *data,
1320 Eet_Image_Encoding *lossy); 1320 Eet_Image_Encoding *lossy);
1321 1321
1322/** 1322/**
1323 * Decode Image data into pixel data and stores in the given buffer. 1323 * @ingroup Eet_File_Image_Group
1324 * @brief Decodes Image data into pixel data and stores in the given buffer.
1324 * @param data The encoded pixel data. 1325 * @param data The encoded pixel data.
1325 * @param size The size, in bytes, of the encoded pixel data. 1326 * @param size The size, in bytes, of the encoded pixel data.
1326 * @param src_x The starting x coordinate from where to dump the stream. 1327 * @param src_x The starting x coordinate from where to dump the stream.
@@ -1333,7 +1334,7 @@ eet_data_image_decode(const void *data,
1333 * @param compress A pointer to the int to hold the compression amount. 1334 * @param compress A pointer to the int to hold the compression amount.
1334 * @param quality A pointer to the int to hold the quality amount. 1335 * @param quality A pointer to the int to hold the quality amount.
1335 * @param lossy A pointer to the int to hold the lossiness flag. 1336 * @param lossy A pointer to the int to hold the lossiness flag.
1336 * @return 1 on success, 0 otherwise. 1337 * @return @c 1 on success, @c 0 otherwise.
1337 * 1338 *
1338 * Like eet_data_image_read_to_surface(), but reading the given @p data buffer 1339 * Like eet_data_image_read_to_surface(), but reading the given @p data buffer
1339 * instead of a file. 1340 * instead of a file.
@@ -1345,7 +1346,6 @@ eet_data_image_decode(const void *data,
1345 * @see eet_data_image_decode_to_surface_cipher() 1346 * @see eet_data_image_decode_to_surface_cipher()
1346 * 1347 *
1347 * @since 1.0.2 1348 * @since 1.0.2
1348 * @ingroup Eet_File_Image_Group
1349 */ 1349 */
1350EAPI int 1350EAPI int
1351eet_data_image_decode_to_surface(const void *data, 1351eet_data_image_decode_to_surface(const void *data,
@@ -1362,7 +1362,8 @@ eet_data_image_decode_to_surface(const void *data,
1362 Eet_Image_Encoding *lossy); 1362 Eet_Image_Encoding *lossy);
1363 1363
1364/** 1364/**
1365 * Encode image data for storage or transmission. 1365 * @ingroup Eet_File_Image_Group
1366 * @brief Encodes image data for storage or transmission.
1366 * @param data A pointer to the image pixel data. 1367 * @param data A pointer to the image pixel data.
1367 * @param size_ret A pointer to an int to hold the size of the returned data. 1368 * @param size_ret A pointer to an int to hold the size of the returned data.
1368 * @param w The width of the image in pixels. 1369 * @param w The width of the image in pixels.
@@ -1389,7 +1390,6 @@ eet_data_image_decode_to_surface(const void *data,
1389 * @see eet_data_image_encode_cipher() 1390 * @see eet_data_image_encode_cipher()
1390 * 1391 *
1391 * @since 1.0.0 1392 * @since 1.0.0
1392 * @ingroup Eet_File_Image_Group
1393 */ 1393 */
1394EAPI void * 1394EAPI void *
1395eet_data_image_encode(const void *data, 1395eet_data_image_encode(const void *data,
@@ -1403,17 +1403,18 @@ eet_data_image_encode(const void *data,
1403 1403
1404/** 1404/**
1405 * @defgroup Eet_File_Image_Cipher_Group Image Store and Load using a Cipher 1405 * @defgroup Eet_File_Image_Cipher_Group Image Store and Load using a Cipher
1406 * @ingroup Eet_File_Image_Group
1406 * 1407 *
1407 * Most of the @ref Eet_File_Image_Group have alternative versions 1408 * Most of the @ref Eet_File_Image_Group have alternative versions
1408 * that accounts for ciphers to protect their content. 1409 * that accounts for ciphers to protect their content.
1409 * 1410 *
1410 * @see @ref Eet_Cipher_Group 1411 * @see @ref Eet_Cipher_Group
1411 * 1412 *
1412 * @ingroup Eet_File_Image_Group
1413 */ 1413 */
1414 1414
1415/** 1415/**
1416 * Read just the header data for an image and dont decode the pixels using a cipher. 1416 * @ingroup Eet_File_Image_Cipher_Group
1417 * @brief Reads just the header data for an image and dont decode the pixels using a cipher.
1417 * @param ef A valid eet file handle opened for reading. 1418 * @param ef A valid eet file handle opened for reading.
1418 * @param name Name of the entry. eg: "/base/file_i_want". 1419 * @param name Name of the entry. eg: "/base/file_i_want".
1419 * @param cipher_key The key to use as cipher. 1420 * @param cipher_key The key to use as cipher.
@@ -1423,7 +1424,7 @@ eet_data_image_encode(const void *data,
1423 * @param compress A pointer to the int to hold the compression amount. 1424 * @param compress A pointer to the int to hold the compression amount.
1424 * @param quality A pointer to the int to hold the quality amount. 1425 * @param quality A pointer to the int to hold the quality amount.
1425 * @param lossy A pointer to the int to hold the lossiness flag. 1426 * @param lossy A pointer to the int to hold the lossiness flag.
1426 * @return 1 on successful decode, 0 otherwise 1427 * @return @c 1 on successful decode, @c 0 otherwise
1427 * 1428 *
1428 * This function reads an image from an eet file stored under the named 1429 * This function reads an image from an eet file stored under the named
1429 * key in the eet file and return a pointer to the decompressed pixel data. 1430 * key in the eet file and return a pointer to the decompressed pixel data.
@@ -1441,13 +1442,12 @@ eet_data_image_encode(const void *data,
1441 * the image file (0 - 100). The lossy flags is either 0 or 1 as to if 1442 * the image file (0 - 100). The lossy flags is either 0 or 1 as to if
1442 * the image was encoded lossily or not. 1443 * the image was encoded lossily or not.
1443 * 1444 *
1444 * On success the function returns 1 indicating the header was read and 1445 * On success the function returns @c 1 indicating the header was read and
1445 * decoded properly, or 0 on failure. 1446 * decoded properly, or @c 0 on failure.
1446 * 1447 *
1447 * @see eet_data_image_header_read() 1448 * @see eet_data_image_header_read()
1448 * 1449 *
1449 * @since 1.0.0 1450 * @since 1.0.0
1450 * @ingroup Eet_File_Image_Cipher_Group
1451 */ 1451 */
1452EAPI int 1452EAPI int
1453eet_data_image_header_read_cipher(Eet_File *ef, 1453eet_data_image_header_read_cipher(Eet_File *ef,
@@ -1461,7 +1461,8 @@ eet_data_image_header_read_cipher(Eet_File *ef,
1461 Eet_Image_Encoding *lossy); 1461 Eet_Image_Encoding *lossy);
1462 1462
1463/** 1463/**
1464 * Get the colorspace Eet can decode into of a given eet image ressource 1464 * @ingroup Eet_File_Image_Group
1465 * @brief Gets the colorspace Eet can decode into of a given eet image ressource.
1465 * 1466 *
1466 * @param ef A valid eet file handle opened for reading. 1467 * @param ef A valid eet file handle opened for reading.
1467 * @param name Name of the entry. eg: "/base/file_i_want". 1468 * @param name Name of the entry. eg: "/base/file_i_want".
@@ -1470,7 +1471,6 @@ eet_data_image_header_read_cipher(Eet_File *ef,
1470 * @return 1 on successful get, 0 otherwise. 1471 * @return 1 on successful get, 0 otherwise.
1471 * 1472 *
1472 * @since 1.10.0 1473 * @since 1.10.0
1473 * @ingroup Eet_File_Image_Group
1474 */ 1474 */
1475EAPI int 1475EAPI int
1476eet_data_image_colorspace_get(Eet_File *ef, 1476eet_data_image_colorspace_get(Eet_File *ef,
@@ -1479,7 +1479,8 @@ eet_data_image_colorspace_get(Eet_File *ef,
1479 const Eet_Colorspace **cspaces); 1479 const Eet_Colorspace **cspaces);
1480 1480
1481/** 1481/**
1482 * Read image data from the named key in the eet file using a cipher. 1482 * @ingroup Eet_File_Image_Cipher_Group
1483 * @brief Reads image data from the named key in the eet file using a cipher.
1483 * @param ef A valid eet file handle opened for reading. 1484 * @param ef A valid eet file handle opened for reading.
1484 * @param name Name of the entry. eg: "/base/file_i_want". 1485 * @param name Name of the entry. eg: "/base/file_i_want".
1485 * @param cipher_key The key to use as cipher. 1486 * @param cipher_key The key to use as cipher.
@@ -1515,7 +1516,6 @@ eet_data_image_colorspace_get(Eet_File *ef,
1515 * @see eet_data_image_read() 1516 * @see eet_data_image_read()
1516 * 1517 *
1517 * @since 1.0.0 1518 * @since 1.0.0
1518 * @ingroup Eet_File_Image_Cipher_Group
1519 */ 1519 */
1520EAPI void * 1520EAPI void *
1521eet_data_image_read_cipher(Eet_File *ef, 1521eet_data_image_read_cipher(Eet_File *ef,
@@ -1529,7 +1529,8 @@ eet_data_image_read_cipher(Eet_File *ef,
1529 Eet_Image_Encoding *lossy); 1529 Eet_Image_Encoding *lossy);
1530 1530
1531/** 1531/**
1532 * Read image data from the named key in the eet file using a cipher. 1532 * @ingroup Eet_File_Image_Cipher_Group
1533 * @brief Reads image data from the named key in the eet file using a cipher.
1533 * @param ef A valid eet file handle opened for reading. 1534 * @param ef A valid eet file handle opened for reading.
1534 * @param name Name of the entry. eg: "/base/file_i_want". 1535 * @param name Name of the entry. eg: "/base/file_i_want".
1535 * @param cipher_key The key to use as cipher. 1536 * @param cipher_key The key to use as cipher.
@@ -1543,7 +1544,7 @@ eet_data_image_read_cipher(Eet_File *ef,
1543 * @param compress A pointer to the int to hold the compression amount. 1544 * @param compress A pointer to the int to hold the compression amount.
1544 * @param quality A pointer to the int to hold the quality amount. 1545 * @param quality A pointer to the int to hold the quality amount.
1545 * @param lossy A pointer to the int to hold the lossiness flag. 1546 * @param lossy A pointer to the int to hold the lossiness flag.
1546 * @return 1 on success, 0 otherwise. 1547 * @return @c 1 on success, @c 0 otherwise.
1547 * 1548 *
1548 * This function reads an image from an eet file stored under the named 1549 * This function reads an image from an eet file stored under the named
1549 * key in the eet file and store the decompressed pixel data in the provided 1550 * key in the eet file and store the decompressed pixel data in the provided
@@ -1569,7 +1570,6 @@ eet_data_image_read_cipher(Eet_File *ef,
1569 * @see eet_data_image_decode_to_cspace_surface_cipher() 1570 * @see eet_data_image_decode_to_cspace_surface_cipher()
1570 * 1571 *
1571 * @since 1.0.2 1572 * @since 1.0.2
1572 * @ingroup Eet_File_Image_Cipher_Group
1573 */ 1573 */
1574EAPI int 1574EAPI int
1575eet_data_image_read_to_surface_cipher(Eet_File *ef, 1575eet_data_image_read_to_surface_cipher(Eet_File *ef,
@@ -1588,7 +1588,8 @@ eet_data_image_read_to_surface_cipher(Eet_File *ef,
1588 1588
1589 1589
1590/** 1590/**
1591 * Read image data from the named key in the eet file using a cipher. 1591 * @ingroup Eet_File_Image_Cipher_Group
1592 * @brief Reads image data from the named key in the eet file using a cipher.
1592 * @param ef A valid eet file handle opened for reading. 1593 * @param ef A valid eet file handle opened for reading.
1593 * @param name Name of the entry. eg: "/base/file_i_want". 1594 * @param name Name of the entry. eg: "/base/file_i_want".
1594 * @param cipher_key The key to use as cipher. 1595 * @param cipher_key The key to use as cipher.
@@ -1603,7 +1604,7 @@ eet_data_image_read_to_surface_cipher(Eet_File *ef,
1603 * @param comp A pointer to the int to hold the compression amount. 1604 * @param comp A pointer to the int to hold the compression amount.
1604 * @param quality A pointer to the int to hold the quality amount. 1605 * @param quality A pointer to the int to hold the quality amount.
1605 * @param lossy A pointer to the int to hold the lossiness flag. 1606 * @param lossy A pointer to the int to hold the lossiness flag.
1606 * @return 1 on success, 0 otherwise. 1607 * @return @c 1 on success, @c 0 otherwise.
1607 * 1608 *
1608 * This function reads an image from an eet file stored under the named 1609 * This function reads an image from an eet file stored under the named
1609 * key in the eet file and store the decompressed pixel data in the provided 1610 * key in the eet file and store the decompressed pixel data in the provided
@@ -1630,7 +1631,6 @@ eet_data_image_read_to_surface_cipher(Eet_File *ef,
1630 * @see eet_data_image_read_to_surface_cipher() 1631 * @see eet_data_image_read_to_surface_cipher()
1631 * 1632 *
1632 * @since 1.10.0 1633 * @since 1.10.0
1633 * @ingroup Eet_File_Image_Cipher_Group
1634 */ 1634 */
1635EAPI int 1635EAPI int
1636eet_data_image_read_to_cspace_surface_cipher(Eet_File *ef, 1636eet_data_image_read_to_cspace_surface_cipher(Eet_File *ef,
@@ -1650,7 +1650,8 @@ eet_data_image_read_to_cspace_surface_cipher(Eet_File *ef,
1650 1650
1651 1651
1652/** 1652/**
1653 * Read image data from the named key in the eet file using a cipher. 1653 * @ingroup Eet_File_Image_Cipher_Group
1654 * @brief Reads image data from the named key in the eet file using a cipher.
1654 * @param ef A valid eet file handle opened for reading. 1655 * @param ef A valid eet file handle opened for reading.
1655 * @param name Name of the entry. eg: "/base/file_i_want". 1656 * @param name Name of the entry. eg: "/base/file_i_want".
1656 * @param cipher_key The key to use as cipher. 1657 * @param cipher_key The key to use as cipher.
@@ -1665,7 +1666,7 @@ eet_data_image_read_to_cspace_surface_cipher(Eet_File *ef,
1665 * @param comp A pointer to the int to hold the compression amount. 1666 * @param comp A pointer to the int to hold the compression amount.
1666 * @param quality A pointer to the int to hold the quality amount. 1667 * @param quality A pointer to the int to hold the quality amount.
1667 * @param lossy A pointer to the int to hold the lossiness flag. 1668 * @param lossy A pointer to the int to hold the lossiness flag.
1668 * @return 1 on success, 0 otherwise. 1669 * @return @c 1 on success, @c 0 otherwise.
1669 * 1670 *
1670 * This function reads an image from an eet file stored under the named 1671 * This function reads an image from an eet file stored under the named
1671 * key in the eet file and store the decompressed pixels in the specified 1672 * key in the eet file and store the decompressed pixels in the specified
@@ -1691,7 +1692,6 @@ eet_data_image_read_to_cspace_surface_cipher(Eet_File *ef,
1691 * @see eet_data_image_read_to_surface_cipher() 1692 * @see eet_data_image_read_to_surface_cipher()
1692 * 1693 *
1693 * @since 1.10.0 1694 * @since 1.10.0
1694 * @ingroup Eet_File_Image_Cipher_Group
1695 */ 1695 */
1696 1696
1697EAPI int 1697EAPI int
@@ -1711,7 +1711,8 @@ eet_data_image_decode_to_cspace_surface_cipher(const void *data,
1711 Eet_Image_Encoding *lossy); 1711 Eet_Image_Encoding *lossy);
1712 1712
1713/** 1713/**
1714 * Write image data to the named key in an eet file using a cipher. 1714 * @ingroup Eet_File_Image_Cipher_Group
1715 * @brief Writes image data to the named key in an eet file using a cipher.
1715 * @param ef A valid eet file handle opened for writing. 1716 * @param ef A valid eet file handle opened for writing.
1716 * @param name Name of the entry. eg: "/base/file_i_want". 1717 * @param name Name of the entry. eg: "/base/file_i_want".
1717 * @param cipher_key The key to use as cipher. 1718 * @param cipher_key The key to use as cipher.
@@ -1744,7 +1745,6 @@ eet_data_image_decode_to_cspace_surface_cipher(const void *data,
1744 * @see eet_data_image_write() 1745 * @see eet_data_image_write()
1745 * 1746 *
1746 * @since 1.0.0 1747 * @since 1.0.0
1747 * @ingroup Eet_File_Image_Cipher_Group
1748 */ 1748 */
1749EAPI int 1749EAPI int
1750eet_data_image_write_cipher(Eet_File *ef, 1750eet_data_image_write_cipher(Eet_File *ef,
@@ -1759,7 +1759,8 @@ eet_data_image_write_cipher(Eet_File *ef,
1759 Eet_Image_Encoding lossy); 1759 Eet_Image_Encoding lossy);
1760 1760
1761/** 1761/**
1762 * Decode Image data header only to get information using a cipher. 1762 * @ingroup Eet_File_Image_Cipher_Group
1763 * @brief Decodes Image data header only to get information using a cipher.
1763 * @param data The encoded pixel data. 1764 * @param data The encoded pixel data.
1764 * @param cipher_key The key to use as cipher. 1765 * @param cipher_key The key to use as cipher.
1765 * @param size The size, in bytes, of the encoded pixel data. 1766 * @param size The size, in bytes, of the encoded pixel data.
@@ -1769,7 +1770,7 @@ eet_data_image_write_cipher(Eet_File *ef,
1769 * @param compress A pointer to the int to hold the compression amount. 1770 * @param compress A pointer to the int to hold the compression amount.
1770 * @param quality A pointer to the int to hold the quality amount. 1771 * @param quality A pointer to the int to hold the quality amount.
1771 * @param lossy A pointer to the int to hold the lossiness flag. 1772 * @param lossy A pointer to the int to hold the lossiness flag.
1772 * @return 1 on success, 0 on failure. 1773 * @return @c 1 on success, @c 0 on failure.
1773 * 1774 *
1774 * This function takes encoded pixel data and decodes it into raw RGBA 1775 * This function takes encoded pixel data and decodes it into raw RGBA
1775 * pixels on success. 1776 * pixels on success.
@@ -1793,7 +1794,6 @@ eet_data_image_write_cipher(Eet_File *ef,
1793 * @see eet_data_image_header_decode() 1794 * @see eet_data_image_header_decode()
1794 * 1795 *
1795 * @since 1.0.0 1796 * @since 1.0.0
1796 * @ingroup Eet_File_Image_Cipher_Group
1797 */ 1797 */
1798EAPI int 1798EAPI int
1799eet_data_image_header_decode_cipher(const void *data, 1799eet_data_image_header_decode_cipher(const void *data,
@@ -1807,7 +1807,8 @@ eet_data_image_header_decode_cipher(const void *data,
1807 Eet_Image_Encoding *lossy); 1807 Eet_Image_Encoding *lossy);
1808 1808
1809/** 1809/**
1810 * Decode Image data into pixel data using a cipher. 1810 * @ingroup Eet_File_Image_Cipher_Group
1811 * @brief Decodes Image data into pixel data using a cipher.
1811 * @param data The encoded pixel data. 1812 * @param data The encoded pixel data.
1812 * @param cipher_key The key to use as cipher. 1813 * @param cipher_key The key to use as cipher.
1813 * @param size The size, in bytes, of the encoded pixel data. 1814 * @param size The size, in bytes, of the encoded pixel data.
@@ -1843,7 +1844,6 @@ eet_data_image_header_decode_cipher(const void *data,
1843 * @see eet_data_image_decode() 1844 * @see eet_data_image_decode()
1844 * 1845 *
1845 * @since 1.0.0 1846 * @since 1.0.0
1846 * @ingroup Eet_File_Image_Cipher_Group
1847 */ 1847 */
1848EAPI void * 1848EAPI void *
1849eet_data_image_decode_cipher(const void *data, 1849eet_data_image_decode_cipher(const void *data,
@@ -1857,7 +1857,8 @@ eet_data_image_decode_cipher(const void *data,
1857 Eet_Image_Encoding *lossy); 1857 Eet_Image_Encoding *lossy);
1858 1858
1859/** 1859/**
1860 * Decode Image data into pixel data using a cipher. 1860 * @ingroup Eet_File_Image_Cipher_Group
1861 * @brief Decodes Image data into pixel data using a cipher.
1861 * @param data The encoded pixel data. 1862 * @param data The encoded pixel data.
1862 * @param cipher_key The key to use as cipher. 1863 * @param cipher_key The key to use as cipher.
1863 * @param size The size, in bytes, of the encoded pixel data. 1864 * @param size The size, in bytes, of the encoded pixel data.
@@ -1871,7 +1872,7 @@ eet_data_image_decode_cipher(const void *data,
1871 * @param compress A pointer to the int to hold the compression amount. 1872 * @param compress A pointer to the int to hold the compression amount.
1872 * @param quality A pointer to the int to hold the quality amount. 1873 * @param quality A pointer to the int to hold the quality amount.
1873 * @param lossy A pointer to the int to hold the lossiness flag. 1874 * @param lossy A pointer to the int to hold the lossiness flag.
1874 * @return 1 on success, 0 otherwise. 1875 * @return @c 1 on success, @c 0 otherwise.
1875 * 1876 *
1876 * This function takes encoded pixel data and decodes it into raw RGBA 1877 * This function takes encoded pixel data and decodes it into raw RGBA
1877 * pixels on success. 1878 * pixels on success.
@@ -1895,7 +1896,6 @@ eet_data_image_decode_cipher(const void *data,
1895 * @see eet_data_image_decode_to_surface() 1896 * @see eet_data_image_decode_to_surface()
1896 * 1897 *
1897 * @since 1.0.2 1898 * @since 1.0.2
1898 * @ingroup Eet_File_Image_Cipher_Group
1899 */ 1899 */
1900EAPI int 1900EAPI int
1901eet_data_image_decode_to_surface_cipher(const void *data, 1901eet_data_image_decode_to_surface_cipher(const void *data,
@@ -1913,7 +1913,8 @@ eet_data_image_decode_to_surface_cipher(const void *data,
1913 Eet_Image_Encoding *lossy); 1913 Eet_Image_Encoding *lossy);
1914 1914
1915/** 1915/**
1916 * Encode image data for storage or transmission using a cipher. 1916 * @ingroup Eet_File_Image_Cipher_Group
1917 * @brief Encodes image data for storage or transmission using a cipher.
1917 * @param data A pointer to the image pixel data. 1918 * @param data A pointer to the image pixel data.
1918 * @param cipher_key The key to use as cipher. 1919 * @param cipher_key The key to use as cipher.
1919 * @param size_ret A pointer to an int to hold the size of the returned data. 1920 * @param size_ret A pointer to an int to hold the size of the returned data.
@@ -1945,7 +1946,6 @@ eet_data_image_decode_to_surface_cipher(const void *data,
1945 * @see eet_data_image_encode() 1946 * @see eet_data_image_encode()
1946 * 1947 *
1947 * @since 1.0.0 1948 * @since 1.0.0
1948 * @ingroup Eet_File_Image_Cipher_Group
1949 */ 1949 */
1950EAPI void * 1950EAPI void *
1951eet_data_image_encode_cipher(const void *data, 1951eet_data_image_encode_cipher(const void *data,
@@ -1984,21 +1984,22 @@ typedef struct _Eet_Key Eet_Key;
1984 */ 1984 */
1985 1985
1986/** 1986/**
1987 * Callback used to request if needed the password of a private key. 1987 * @ingroup Eet_Cipher_Group
1988 * @brief Callback used to request if needed the password of a private key.
1988 * 1989 *
1989 * @param buffer the buffer where to store the password. 1990 * @param buffer the buffer where to store the password.
1990 * @param size the maximum password size (size of buffer, including '@\0'). 1991 * @param size the maximum password size (size of buffer, including '@\0').
1991 * @param rwflag if the buffer is also readable or just writable. 1992 * @param rwflag if the buffer is also readable or just writable.
1992 * @param data currently unused, may contain some context in future. 1993 * @param data currently unused, may contain some context in future.
1993 * @return 1 on success and password was set to @p buffer, 0 on failure. 1994 * @return @c 1 on success and password was set to @p buffer, @c 0 on failure.
1994 * 1995 *
1995 * @since 1.2.0 1996 * @since 1.2.0
1996 * @ingroup Eet_Cipher_Group
1997 */ 1997 */
1998typedef int (*Eet_Key_Password_Callback)(char *buffer, int size, int rwflag, void *data); 1998typedef int (*Eet_Key_Password_Callback)(char *buffer, int size, int rwflag, void *data);
1999 1999
2000/** 2000/**
2001 * Create an Eet_Key needed for signing an eet file. 2001 * @ingroup Eet_Cipher_Group
2002 * @brief Creates an Eet_Key needed for signing an eet file.
2002 * 2003 *
2003 * The certificate should provide the public that match the private key. 2004 * The certificate should provide the public that match the private key.
2004 * No verification is done to ensure that. 2005 * No verification is done to ensure that.
@@ -2013,7 +2014,6 @@ typedef int (*Eet_Key_Password_Callback)(char *buffer, int size, int rwflag, voi
2013 * 2014 *
2014 * @warning You need to compile signature support in EET. 2015 * @warning You need to compile signature support in EET.
2015 * @since 1.2.0 2016 * @since 1.2.0
2016 * @ingroup Eet_Cipher_Group
2017 */ 2017 */
2018EAPI Eet_Key * 2018EAPI Eet_Key *
2019eet_identity_open(const char *certificate_file, 2019eet_identity_open(const char *certificate_file,
@@ -2021,20 +2021,21 @@ eet_identity_open(const char *certificate_file,
2021 Eet_Key_Password_Callback cb); 2021 Eet_Key_Password_Callback cb);
2022 2022
2023/** 2023/**
2024 * Close and release all resource used by an Eet_Key. An 2024 * @ingroup Eet_Cipher_Group
2025 * reference counter prevent it from being freed until all file 2025 * @brief Close and release all resource used by an Eet_Key.
2026 * A reference counter prevent it from being freed until all file
2026 * using it are also closed. 2027 * using it are also closed.
2027 * 2028 *
2028 * @param key the key handle to close and free resources. 2029 * @param key the key handle to close and free resources.
2029 * 2030 *
2030 * @since 1.2.0 2031 * @since 1.2.0
2031 * @ingroup Eet_Cipher_Group
2032 */ 2032 */
2033EAPI void 2033EAPI void
2034eet_identity_close(Eet_Key *key); 2034eet_identity_close(Eet_Key *key);
2035 2035
2036/** 2036/**
2037 * Set a key to sign a file 2037 * @ingroup Eet_Cipher_Group
2038 * @breif Sets a key to sign a file.
2038 * 2039 *
2039 * @param ef the file to set the identity. 2040 * @param ef the file to set the identity.
2040 * @param key the key handle to set as identity. 2041 * @param key the key handle to set as identity.
@@ -2042,32 +2043,32 @@ eet_identity_close(Eet_Key *key);
2042 * #EET_ERROR_NONE on success. 2043 * #EET_ERROR_NONE on success.
2043 * 2044 *
2044 * @since 1.2.0 2045 * @since 1.2.0
2045 * @ingroup Eet_Cipher_Group
2046 */ 2046 */
2047EAPI Eet_Error 2047EAPI Eet_Error
2048eet_identity_set(Eet_File *ef, 2048eet_identity_set(Eet_File *ef,
2049 Eet_Key *key); 2049 Eet_Key *key);
2050 2050
2051/** 2051/**
2052 * Display both private and public key of an Eet_Key. 2052 * @ingroup Eet_Cipher_Group
2053 * @brief Displays both private and public key of an Eet_Key.
2053 * 2054 *
2054 * @param key the handle to print. 2055 * @param key the handle to print.
2055 * @param out where to print. 2056 * @param out where to print.
2056 * 2057 *
2057 * @warning You need to compile signature support in EET. 2058 * @warning You need to compile signature support in EET.
2058 * @since 1.2.0 2059 * @since 1.2.0
2059 * @ingroup Eet_Cipher_Group
2060 */ 2060 */
2061EAPI void 2061EAPI void
2062eet_identity_print(Eet_Key *key, 2062eet_identity_print(Eet_Key *key,
2063 FILE *out); 2063 FILE *out);
2064 2064
2065/** 2065/**
2066 * Compare the identify certificate of an eet file against a stored one 2066 * @ingroup Eet_Cipher_Group
2067 * @brief Compares the identify certificate of an eet file against a stored one
2067 * 2068 *
2068 * @param ef The file handle to check the identify of 2069 * @param ef The file handle to check the identify of
2069 * @param certificate_file The path to the certificate file 2070 * @param certificate_file The path to the certificate file
2070 * @return EINA_TRUE if the certificates match, otherwise EINA_FALSE; 2071 * @return @c EINA_TRUE if the certificates match, otherwise @c EINA_FALSE
2071 * 2072 *
2072 * The @p ef file handle mus be valid, and a signed file, otherwise 2073 * The @p ef file handle mus be valid, and a signed file, otherwise
2073 * checking will fail. The path to the certificate file must be a valid 2074 * checking will fail. The path to the certificate file must be a valid
@@ -2079,14 +2080,14 @@ eet_identity_print(Eet_Key *key,
2079 * security. This is just a convenience test function. 2080 * security. This is just a convenience test function.
2080 * @warning You need to compile signature support in EET. 2081 * @warning You need to compile signature support in EET.
2081 * @since 1.13 2082 * @since 1.13
2082 * @ingroup Eet_Cipher_Group
2083 */ 2083 */
2084EAPI Eina_Bool 2084EAPI Eina_Bool
2085eet_identity_verify(Eet_File *ef, 2085eet_identity_verify(Eet_File *ef,
2086 const char *certificate_file); 2086 const char *certificate_file);
2087 2087
2088/** 2088/**
2089 * Get the x509 der certificate associated with an Eet_File. Will return NULL 2089 * @ingroup Eet_Cipher_Group
2090 * @brief Gets the x509 der certificate associated with an Eet_File. Will return NULL
2090 * if the file is not signed. 2091 * if the file is not signed.
2091 * 2092 *
2092 * @param ef The file handle to query. 2093 * @param ef The file handle to query.
@@ -2094,28 +2095,28 @@ eet_identity_verify(Eet_File *ef,
2094 * @return the x509 certificate or @c NULL on error. 2095 * @return the x509 certificate or @c NULL on error.
2095 * 2096 *
2096 * @since 1.2.0 2097 * @since 1.2.0
2097 * @ingroup Eet_Cipher_Group
2098 */ 2098 */
2099EAPI const void * 2099EAPI const void *
2100eet_identity_x509(Eet_File *ef, 2100eet_identity_x509(Eet_File *ef,
2101 int *der_length); 2101 int *der_length);
2102 2102
2103/** 2103/**
2104 * Get the raw signature associated with an Eet_File. Will return NULL 2104 * @ingroup Eet_Cipher_Group
2105 * @brief Gets the raw signature associated with an Eet_File. Will return NULL
2105 * if the file is not signed. 2106 * if the file is not signed.
2106 * 2107 *
2107 * @param ef The file handle to query. 2108 * @param ef The file handle to query.
2108 * @param signature_length The length of returned data, may be @c NULL. 2109 * @param signature_length The length of returned data, may be @c NULL.
2109 * @return the raw signature or @c NULL on error. 2110 * @return The raw signature or @c NULL on error.
2110 * 2111 *
2111 * @ingroup Eet_Cipher_Group
2112 */ 2112 */
2113EAPI const void * 2113EAPI const void *
2114eet_identity_signature(Eet_File *ef, 2114eet_identity_signature(Eet_File *ef,
2115 int *signature_length); 2115 int *signature_length);
2116 2116
2117/** 2117/**
2118 * Get the SHA1 associated with a file. Could be the one used to 2118 * @ingroup Eet_Cipher_Group
2119 * @brief Gets the SHA1 associated with a file. Could be the one used to
2119 * sign the data or if the data where not signed, it will be the 2120 * sign the data or if the data where not signed, it will be the
2120 * SHA1 of the file. 2121 * SHA1 of the file.
2121 * 2122 *
@@ -2124,14 +2125,14 @@ eet_identity_signature(Eet_File *ef,
2124 * @return the associated SHA1 or @c NULL on error. 2125 * @return the associated SHA1 or @c NULL on error.
2125 * 2126 *
2126 * @since 1.2.0 2127 * @since 1.2.0
2127 * @ingroup Eet_Cipher_Group
2128 */ 2128 */
2129EAPI const void * 2129EAPI const void *
2130eet_identity_sha1(Eet_File *ef, 2130eet_identity_sha1(Eet_File *ef,
2131 int *sha1_length); 2131 int *sha1_length);
2132 2132
2133/** 2133/**
2134 * Display the x509 der certificate to out. 2134 * @ingroup Eet_Cipher_Group
2135 * @brief Displays the x509 der certificate to out.
2135 * 2136 *
2136 * @param certificate the x509 certificate to print 2137 * @param certificate the x509 certificate to print
2137 * @param der_length The length the certificate. 2138 * @param der_length The length the certificate.
@@ -2139,7 +2140,6 @@ eet_identity_sha1(Eet_File *ef,
2139 * 2140 *
2140 * @warning You need to compile signature support in EET. 2141 * @warning You need to compile signature support in EET.
2141 * @since 1.2.0 2142 * @since 1.2.0
2142 * @ingroup Eet_Cipher_Group
2143 */ 2143 */
2144EAPI void 2144EAPI void
2145eet_identity_certificate_print(const unsigned char *certificate, 2145eet_identity_certificate_print(const unsigned char *certificate,
@@ -2642,19 +2642,19 @@ typedef struct _Eet_Data_Descriptor_Class Eet_Data_Descriptor_Class;
2642 * @typedef (*Eet_Descriptor_Hash_Foreach_Callback_Callback) 2642 * @typedef (*Eet_Descriptor_Hash_Foreach_Callback_Callback)
2643 * 2643 *
2644 * Callback prototype for Eet_Descriptor_Hash_Foreach_Callback 2644 * Callback prototype for Eet_Descriptor_Hash_Foreach_Callback
2645 * @param h the hash 2645 * @param h The hash
2646 * @param k the key 2646 * @param k The key
2647 * @param dt the data 2647 * @param dt The data
2648 * @param fdt the data passed to the callback 2648 * @param fdt The data passed to the callback
2649 * @return an integer 2649 * @return An integer
2650 */ 2650 */
2651typedef int (*Eet_Descriptor_Hash_Foreach_Callback_Callback)(void *h, const char *k, void *dt, void *fdt); 2651typedef int (*Eet_Descriptor_Hash_Foreach_Callback_Callback)(void *h, const char *k, void *dt, void *fdt);
2652 2652
2653/** 2653/**
2654 * @typedef (*Eet_Descriptor_Mem_Alloc_Callback) 2654 * @typedef (*Eet_Descriptor_Mem_Alloc_Callback)
2655 * 2655 *
2656 * Callback prototype for Eet_Descriptor_Mem_Alloc 2656 * Callback prototype for Eet_Descriptor_Mem_Alloc.
2657 * @param size is the size of memory to alloc on call of the callback 2657 * @param size Is the size of memory to alloc on call of the callback
2658 */ 2658 */
2659typedef void * (*Eet_Descriptor_Mem_Alloc_Callback)(size_t size); 2659typedef void * (*Eet_Descriptor_Mem_Alloc_Callback)(size_t size);
2660 2660
@@ -2662,7 +2662,7 @@ typedef void * (*Eet_Descriptor_Mem_Alloc_Callback)(siz
2662 * @typedef (*Eet_Descriptor_Mem_Free_Callback) 2662 * @typedef (*Eet_Descriptor_Mem_Free_Callback)
2663 * 2663 *
2664 * Callback prototype for Eet_Descriptor_Mem_Alloc 2664 * Callback prototype for Eet_Descriptor_Mem_Alloc
2665 * @param mem must be a pointer to free on call of the callback 2665 * @param mem Must be a pointer to free on call of the callback
2666 */ 2666 */
2667typedef void (*Eet_Descriptor_Mem_Free_Callback)(void *mem); 2667typedef void (*Eet_Descriptor_Mem_Free_Callback)(void *mem);
2668 2668
@@ -2670,8 +2670,8 @@ typedef void (*Eet_Descriptor_Mem_Free_Callback)(void
2670 * @typedef (*Eet_Descriptor_Str_Alloc_Callback) 2670 * @typedef (*Eet_Descriptor_Str_Alloc_Callback)
2671 * 2671 *
2672 * Callback prototype for Eet_Descriptor_Str_Alloc 2672 * Callback prototype for Eet_Descriptor_Str_Alloc
2673 * @param str must be the string to alloc 2673 * @param str Must be the string to alloc
2674 * @return have must be an allocated char * for the given string 2674 * @return have Must be an allocated char * for the given string
2675 */ 2675 */
2676typedef char * (*Eet_Descriptor_Str_Alloc_Callback)(const char *str); 2676typedef char * (*Eet_Descriptor_Str_Alloc_Callback)(const char *str);
2677 2677
@@ -2679,7 +2679,7 @@ typedef char * (*Eet_Descriptor_Str_Alloc_Callback)(con
2679 * @typedef (*Eet_Descriptor_Str_Free_Callback) 2679 * @typedef (*Eet_Descriptor_Str_Free_Callback)
2680 * 2680 *
2681 * Callback prototype for Eet_Descriptor_Str_Free 2681 * Callback prototype for Eet_Descriptor_Str_Free
2682 * @param str must be an allocated string to free 2682 * @param str Must be an allocated string to free
2683 */ 2683 */
2684typedef void (*Eet_Descriptor_Str_Free_Callback)(const char *str); 2684typedef void (*Eet_Descriptor_Str_Free_Callback)(const char *str);
2685 2685
@@ -2687,8 +2687,8 @@ typedef void (*Eet_Descriptor_Str_Free_Callback)(cons
2687 * @typedef (*Eet_Descriptor_List_Next_Callback) 2687 * @typedef (*Eet_Descriptor_List_Next_Callback)
2688 * 2688 *
2689 * Callback prototype for Eet_Descriptor_List_Next 2689 * Callback prototype for Eet_Descriptor_List_Next
2690 * @param l must be a pointer to the list 2690 * @param l Must be a pointer to the list
2691 * @return must be a pointer to the list 2691 * @return Must be a pointer to the list
2692 */ 2692 */
2693typedef void * (*Eet_Descriptor_List_Next_Callback)(void *l); 2693typedef void * (*Eet_Descriptor_List_Next_Callback)(void *l);
2694 2694
@@ -2696,9 +2696,9 @@ typedef void * (*Eet_Descriptor_List_Next_Callback)(voi
2696 * @typedef (*Eet_Descriptor_List_Append_Callback) 2696 * @typedef (*Eet_Descriptor_List_Append_Callback)
2697 * 2697 *
2698 * Callback prototype for Eet_Descriptor_List_Append 2698 * Callback prototype for Eet_Descriptor_List_Append
2699 * @param l must be a pointer to the list 2699 * @param l Must be a pointer to the list
2700 * @param d the data to append to the list 2700 * @param d The data to append to the list
2701 * @return must be a pointer to the list 2701 * @return Must be a pointer to the list
2702 */ 2702 */
2703typedef void * (*Eet_Descriptor_List_Append_Callback)(void *l, void *d); 2703typedef void * (*Eet_Descriptor_List_Append_Callback)(void *l, void *d);
2704 2704
@@ -2707,8 +2707,8 @@ typedef void * (*Eet_Descriptor_List_Append_Callback)(v
2707 * @typedef (*Eet_Descriptor_List_Data_Callback) 2707 * @typedef (*Eet_Descriptor_List_Data_Callback)
2708 * 2708 *
2709 * Callback prototype for Eet_Descriptor_List_Data 2709 * Callback prototype for Eet_Descriptor_List_Data
2710 * @param l must be a pointer to the list 2710 * @param l Must be a pointer to the list
2711 * @return must be a pointer to the list 2711 * @return Must be a pointer to the list
2712 */ 2712 */
2713typedef void * (*Eet_Descriptor_List_Data_Callback)(void *l); 2713typedef void * (*Eet_Descriptor_List_Data_Callback)(void *l);
2714 2714
@@ -2716,7 +2716,7 @@ typedef void * (*Eet_Descriptor_List_Data_Callback)(voi
2716 * @typedef (*Eet_Descriptor_List_Free_Callback) 2716 * @typedef (*Eet_Descriptor_List_Free_Callback)
2717 * 2717 *
2718 * Callback prototype for Eet_Descriptor_List_Free 2718 * Callback prototype for Eet_Descriptor_List_Free
2719 * @param l must be a pointer to the list to free 2719 * @param l Must be a pointer to the list to free
2720 */ 2720 */
2721typedef void * (*Eet_Descriptor_List_Free_Callback)(void *l); 2721typedef void * (*Eet_Descriptor_List_Free_Callback)(void *l);
2722 2722
@@ -2724,9 +2724,9 @@ typedef void * (*Eet_Descriptor_List_Free_Callback)(voi
2724 * @typedef (*Eet_Descriptor_Hash_Foreach_Callback) 2724 * @typedef (*Eet_Descriptor_Hash_Foreach_Callback)
2725 * 2725 *
2726 * Callback for Eet_Descriptor_Hash_Foreach 2726 * Callback for Eet_Descriptor_Hash_Foreach
2727 * @param h the hash 2727 * @param h The hash
2728 * @param func the function callback to call on each iteration 2728 * @param func The function callback to call on each iteration
2729 * @param fdt the data to pass to the callbac setted in param func 2729 * @param fdt The data to pass to the callbac setted in param func
2730 */ 2730 */
2731typedef void (*Eet_Descriptor_Hash_Foreach_Callback)(void *h, Eet_Descriptor_Hash_Foreach_Callback_Callback func, void *fdt); 2731typedef void (*Eet_Descriptor_Hash_Foreach_Callback)(void *h, Eet_Descriptor_Hash_Foreach_Callback_Callback func, void *fdt);
2732 2732
@@ -2734,9 +2734,9 @@ typedef void (*Eet_Descriptor_Hash_Foreach_Callback)(
2734 * @typedef (*Eet_Descriptor_Hash_Add_Callback) 2734 * @typedef (*Eet_Descriptor_Hash_Add_Callback)
2735 * 2735 *
2736 * Callback prototype for Eet_Descriptor_Hash_Add 2736 * Callback prototype for Eet_Descriptor_Hash_Add
2737 * @param h the hash 2737 * @param h The hash
2738 * @param k the key 2738 * @param k The key
2739 * @param d the data to associate with the 'k' key 2739 * @param d The data to associate with the 'k' key
2740 */ 2740 */
2741typedef void * (*Eet_Descriptor_Hash_Add_Callback)(void *h, const char *k, void *d); 2741typedef void * (*Eet_Descriptor_Hash_Add_Callback)(void *h, const char *k, void *d);
2742 2742
@@ -2744,7 +2744,7 @@ typedef void * (*Eet_Descriptor_Hash_Add_Callback)(void
2744 * @typedef (*Eet_Descriptor_Hash_Free_Callback) 2744 * @typedef (*Eet_Descriptor_Hash_Free_Callback)
2745 * 2745 *
2746 * Callback prototype for Eet_Descriptor_Hash_Free 2746 * Callback prototype for Eet_Descriptor_Hash_Free
2747 * @param h the hash to free 2747 * @param h The hash to free
2748 */ 2748 */
2749typedef void (*Eet_Descriptor_Hash_Free_Callback)(void *h); 2749typedef void (*Eet_Descriptor_Hash_Free_Callback)(void *h);
2750 2750
@@ -2752,8 +2752,8 @@ typedef void (*Eet_Descriptor_Hash_Free_Callback)(voi
2752 * @typedef (*Eet_Descriptor_Str_Alloc_Callback) 2752 * @typedef (*Eet_Descriptor_Str_Alloc_Callback)
2753 * 2753 *
2754 * Callback prototype for Eet_Descriptor_Str_Alloc 2754 * Callback prototype for Eet_Descriptor_Str_Alloc
2755 * @param str the string to allocate 2755 * @param str The string to allocate
2756 * @return an allocated pointer to the string 2756 * @return An allocated pointer to the string
2757 */ 2757 */
2758typedef char * (*Eet_Descriptor_Str_Direct_Alloc_Callback)(const char *str); 2758typedef char * (*Eet_Descriptor_Str_Direct_Alloc_Callback)(const char *str);
2759 2759
@@ -2761,7 +2761,7 @@ typedef char * (*Eet_Descriptor_Str_Direct_Alloc_Callba
2761 * @typedef (*Eet_Descriptor_Str_Free_Callback) 2761 * @typedef (*Eet_Descriptor_Str_Free_Callback)
2762 * 2762 *
2763 * Callback prototype for Eet_Descriptor_Str_Free 2763 * Callback prototype for Eet_Descriptor_Str_Free
2764 * @param str the string to free 2764 * @param str The string to free
2765 */ 2765 */
2766typedef void (*Eet_Descriptor_Str_Direct_Free_Callback)(const char *str); 2766typedef void (*Eet_Descriptor_Str_Direct_Free_Callback)(const char *str);
2767 2767
@@ -2770,7 +2770,7 @@ typedef void (*Eet_Descriptor_Str_Direct_Free_Callbac
2770 * @typedef (*Eet_Descriptor_Type_Get_Callback) 2770 * @typedef (*Eet_Descriptor_Type_Get_Callback)
2771 * 2771 *
2772 * Callback prototype for Eet_Descriptor_Type_Get 2772 * Callback prototype for Eet_Descriptor_Type_Get
2773 * @param data data to pass to the callback 2773 * @param data Data to pass to the callback
2774 * @param unknow Eina_Bool __FIXME__ 2774 * @param unknow Eina_Bool __FIXME__
2775 */ 2775 */
2776typedef const char * (*Eet_Descriptor_Type_Get_Callback)(const void *data, Eina_Bool *unknow); 2776typedef const char * (*Eet_Descriptor_Type_Get_Callback)(const void *data, Eina_Bool *unknow);
@@ -2779,8 +2779,8 @@ typedef const char * (*Eet_Descriptor_Type_Get_Callback)(cons
2779 * @typedef (*Eet_Descriptor_Type_Set_Callback) 2779 * @typedef (*Eet_Descriptor_Type_Set_Callback)
2780 * 2780 *
2781 * Callback prototype for Eet_Descriptor_Type_Set 2781 * Callback prototype for Eet_Descriptor_Type_Set
2782 * @param type the type to set 2782 * @param type The type to set
2783 * @param data to pass to the callback 2783 * @param data To pass to the callback
2784 * @param unknow Eina_Bool __FIXME__ 2784 * @param unknow Eina_Bool __FIXME__
2785 */ 2785 */
2786typedef Eina_Bool (*Eet_Descriptor_Type_Set_Callback)(const char *type, void *data, Eina_Bool unknow); 2786typedef Eina_Bool (*Eet_Descriptor_Type_Set_Callback)(const char *type, void *data, Eina_Bool unknow);
@@ -2847,7 +2847,11 @@ struct _Eet_Data_Descriptor_Class
2847 */ 2847 */
2848 2848
2849/** 2849/**
2850 * Create a new empty data structure descriptor. 2850 *
2851 * @ingroup Eet_Data_Group
2852 * @deprecated use eet_data_descriptor_stream_new() or
2853 * eet_data_descriptor_file_new()
2854 * @brief Creates a new empty data structure descriptor.
2851 * @param name The string name of this data structure (most be a 2855 * @param name The string name of this data structure (most be a
2852 * global constant and never change). 2856 * global constant and never change).
2853 * @param size The size of the struct (in bytes). 2857 * @param size The size of the struct (in bytes).
@@ -2879,10 +2883,7 @@ struct _Eet_Data_Descriptor_Class
2879 * needed if you use those data types, else you can pass NULL instead. 2883 * needed if you use those data types, else you can pass NULL instead.
2880 * 2884 *
2881 * @since 1.0.0 2885 * @since 1.0.0
2882 * @ingroup Eet_Data_Group
2883 * 2886 *
2884 * @deprecated use eet_data_descriptor_stream_new() or
2885 * eet_data_descriptor_file_new()
2886 */ 2887 */
2887EINA_DEPRECATED EAPI Eet_Data_Descriptor * 2888EINA_DEPRECATED EAPI Eet_Data_Descriptor *
2888eet_data_descriptor_new(const char *name, 2889eet_data_descriptor_new(const char *name,
@@ -2906,6 +2907,7 @@ EINA_DEPRECATED EAPI Eet_Data_Descriptor *
2906 eet_data_descriptor3_new(const Eet_Data_Descriptor_Class *eddc); 2907 eet_data_descriptor3_new(const Eet_Data_Descriptor_Class *eddc);
2907 2908
2908/** 2909/**
2910 * @ingroup Eet_Data_Group
2909 * This function creates a new data descriptor and returns a handle to the 2911 * This function creates a new data descriptor and returns a handle to the
2910 * new data descriptor. On creation it will be empty, containing no contents 2912 * new data descriptor. On creation it will be empty, containing no contents
2911 * describing anything other than the shell of the data structure. 2913 * describing anything other than the shell of the data structure.
@@ -2928,12 +2930,12 @@ EINA_DEPRECATED EAPI Eet_Data_Descriptor *
2928 * and duplicated in memory. 2930 * and duplicated in memory.
2929 * 2931 *
2930 * @since 1.2.3 2932 * @since 1.2.3
2931 * @ingroup Eet_Data_Group
2932 */ 2933 */
2933EAPI Eet_Data_Descriptor * 2934EAPI Eet_Data_Descriptor *
2934eet_data_descriptor_stream_new(const Eet_Data_Descriptor_Class *eddc); 2935eet_data_descriptor_stream_new(const Eet_Data_Descriptor_Class *eddc);
2935 2936
2936/** 2937/**
2938 * @ingroup Eet_Data_Group
2937 * This function creates a new data descriptor and returns a handle to the 2939 * This function creates a new data descriptor and returns a handle to the
2938 * new data descriptor. On creation it will be empty, containing no contents 2940 * new data descriptor. On creation it will be empty, containing no contents
2939 * describing anything other than the shell of the data structure. 2941 * describing anything other than the shell of the data structure.
@@ -2978,12 +2980,12 @@ eet_data_descriptor_stream_new(const Eet_Data_Descriptor_Class *eddc);
2978 * @endcode 2980 * @endcode
2979 * 2981 *
2980 * @since 1.2.3 2982 * @since 1.2.3
2981 * @ingroup Eet_Data_Group
2982 */ 2983 */
2983EAPI Eet_Data_Descriptor * 2984EAPI Eet_Data_Descriptor *
2984eet_data_descriptor_file_new(const Eet_Data_Descriptor_Class *eddc); 2985eet_data_descriptor_file_new(const Eet_Data_Descriptor_Class *eddc);
2985 2986
2986/** 2987/**
2988 * @ingroup Eet_Data_Group
2987 * This function is an helper that set all the parameters of an 2989 * This function is an helper that set all the parameters of an
2988 * Eet_Data_Descriptor_Class correctly when you use Eina data type 2990 * Eet_Data_Descriptor_Class correctly when you use Eina data type
2989 * with a stream. 2991 * with a stream.
@@ -2991,7 +2993,7 @@ eet_data_descriptor_file_new(const Eet_Data_Descriptor_Class *eddc);
2991 * @param eddc_size The size of the Eet_Data_Descriptor_Class at the compilation time. 2993 * @param eddc_size The size of the Eet_Data_Descriptor_Class at the compilation time.
2992 * @param name The name of the structure described by this class. 2994 * @param name The name of the structure described by this class.
2993 * @param size The size of the structure described by this class. 2995 * @param size The size of the structure described by this class.
2994 * @return EINA_TRUE if the structure was correctly set (The only 2996 * @return @c EINA_TRUE if the structure was correctly set (The only
2995 * reason that could make it fail is if you did give wrong 2997 * reason that could make it fail is if you did give wrong
2996 * parameter). 2998 * parameter).
2997 * 2999 *
@@ -2999,7 +3001,6 @@ eet_data_descriptor_file_new(const Eet_Data_Descriptor_Class *eddc);
2999 * the EET_EINA_STREAM_DATA_DESCRIPTOR_CLASS_SET macro is recommended. 3001 * the EET_EINA_STREAM_DATA_DESCRIPTOR_CLASS_SET macro is recommended.
3000 * 3002 *
3001 * @since 1.2.3 3003 * @since 1.2.3
3002 * @ingroup Eet_Data_Group
3003 */ 3004 */
3004EAPI Eina_Bool 3005EAPI Eina_Bool
3005eet_eina_stream_data_descriptor_class_set(Eet_Data_Descriptor_Class *eddc, 3006eet_eina_stream_data_descriptor_class_set(Eet_Data_Descriptor_Class *eddc,
@@ -3008,6 +3009,7 @@ eet_eina_stream_data_descriptor_class_set(Eet_Data_Descriptor_Class *eddc,
3008 int size); 3009 int size);
3009 3010
3010/** 3011/**
3012 * @ingroup Eet_Data_Group
3011 * This macro is an helper that set all the parameter of an 3013 * This macro is an helper that set all the parameter of an
3012 * Eet_Data_Descriptor_Class correctly when you use Eina data type 3014 * Eet_Data_Descriptor_Class correctly when you use Eina data type
3013 * with stream. 3015 * with stream.
@@ -3019,12 +3021,12 @@ eet_eina_stream_data_descriptor_class_set(Eet_Data_Descriptor_Class *eddc,
3019 * 3021 *
3020 * @see eet_data_descriptor_stream_new 3022 * @see eet_data_descriptor_stream_new
3021 * @since 1.2.3 3023 * @since 1.2.3
3022 * @ingroup Eet_Data_Group
3023 */ 3024 */
3024#define EET_EINA_STREAM_DATA_DESCRIPTOR_CLASS_SET(clas, type) \ 3025#define EET_EINA_STREAM_DATA_DESCRIPTOR_CLASS_SET(clas, type) \
3025 (eet_eina_stream_data_descriptor_class_set(clas, sizeof (*(clas)), # type, sizeof(type))) 3026 (eet_eina_stream_data_descriptor_class_set(clas, sizeof (*(clas)), # type, sizeof(type)))
3026 3027
3027/** 3028/**
3029 * @ingroup Eet_Data_Group
3028 * This function is an helper that set all the parameter of an 3030 * This function is an helper that set all the parameter of an
3029 * Eet_Data_Descriptor_Class correctly when you use Eina data type 3031 * Eet_Data_Descriptor_Class correctly when you use Eina data type
3030 * with a file. 3032 * with a file.
@@ -3032,7 +3034,7 @@ eet_eina_stream_data_descriptor_class_set(Eet_Data_Descriptor_Class *eddc,
3032 * @param eddc_size The size of the Eet_Data_Descriptor_Class at the compilation time. 3034 * @param eddc_size The size of the Eet_Data_Descriptor_Class at the compilation time.
3033 * @param name The name of the structure described by this class. 3035 * @param name The name of the structure described by this class.
3034 * @param size The size of the structure described by this class. 3036 * @param size The size of the structure described by this class.
3035 * @return EINA_TRUE if the structure was correctly set (The only 3037 * @return @c EINA_TRUE if the structure was correctly set (The only
3036 * reason that could make it fail is if you did give wrong 3038 * reason that could make it fail is if you did give wrong
3037 * parameter). 3039 * parameter).
3038 * 3040 *
@@ -3040,7 +3042,6 @@ eet_eina_stream_data_descriptor_class_set(Eet_Data_Descriptor_Class *eddc,
3040 * the EET_EINA_FILE_DATA_DESCRIPTOR_CLASS_SET macro is recommended. 3042 * the EET_EINA_FILE_DATA_DESCRIPTOR_CLASS_SET macro is recommended.
3041 * 3043 *
3042 * @since 1.2.3 3044 * @since 1.2.3
3043 * @ingroup Eet_Data_Group
3044 */ 3045 */
3045EAPI Eina_Bool 3046EAPI Eina_Bool
3046eet_eina_file_data_descriptor_class_set(Eet_Data_Descriptor_Class *eddc, 3047eet_eina_file_data_descriptor_class_set(Eet_Data_Descriptor_Class *eddc,
@@ -3049,24 +3050,25 @@ eet_eina_file_data_descriptor_class_set(Eet_Data_Descriptor_Class *eddc,
3049 int size); 3050 int size);
3050 3051
3051/** 3052/**
3053 * @ingroup Eet_Data_Group
3052 * This macro is an helper that set all the parameter of an 3054 * This macro is an helper that set all the parameter of an
3053 * Eet_Data_Descriptor_Class correctly when you use Eina data type 3055 * Eet_Data_Descriptor_Class correctly when you use Eina data type
3054 * with file. 3056 * with file.
3055 * @param clas The Eet_Data_Descriptor_Class you want to set. 3057 * @param clas The Eet_Data_Descriptor_Class you want to set.
3056 * @param type The type of the structure described by this class. 3058 * @param type The type of the structure described by this class.
3057 * @return EINA_TRUE if the structure was correctly set (The only 3059 * @return @c EINA_TRUE if the structure was correctly set (The only
3058 * reason that could make it fail is if you did give wrong 3060 * reason that could make it fail is if you did give wrong
3059 * parameter). 3061 * parameter).
3060 * 3062 *
3061 * @see eet_data_descriptor_file_new 3063 * @see eet_data_descriptor_file_new
3062 * @since 1.2.3 3064 * @since 1.2.3
3063 * @ingroup Eet_Data_Group
3064 */ 3065 */
3065#define EET_EINA_FILE_DATA_DESCRIPTOR_CLASS_SET(clas, type) \ 3066#define EET_EINA_FILE_DATA_DESCRIPTOR_CLASS_SET(clas, type) \
3066 (eet_eina_file_data_descriptor_class_set(clas, sizeof (*(clas)), # type, sizeof(type))) 3067 (eet_eina_file_data_descriptor_class_set(clas, sizeof (*(clas)), # type, sizeof(type)))
3067 3068
3068/** 3069/**
3069 * This function frees a data descriptor when it is not needed anymore. 3070 * @ingroup Eet_Data_Group
3071 * @brief This function frees a data descriptor when it is not needed anymore.
3070 * @param edd The data descriptor to free. 3072 * @param edd The data descriptor to free.
3071 * 3073 *
3072 * This function takes a data descriptor handle as a parameter and frees all 3074 * This function takes a data descriptor handle as a parameter and frees all
@@ -3074,21 +3076,21 @@ eet_eina_file_data_descriptor_class_set(Eet_Data_Descriptor_Class *eddc,
3074 * call the descriptor is no longer valid. 3076 * call the descriptor is no longer valid.
3075 * 3077 *
3076 * @since 1.0.0 3078 * @since 1.0.0
3077 * @ingroup Eet_Data_Group
3078 */ 3079 */
3079EAPI void 3080EAPI void
3080eet_data_descriptor_free(Eet_Data_Descriptor *edd); 3081eet_data_descriptor_free(Eet_Data_Descriptor *edd);
3081 3082
3082/** 3083/**
3083 * This function returns the name of a data descriptor. 3084 * @ingroup Eet_Data_Group
3085 * @brief This function returns the name of a data descriptor.
3084 * 3086 *
3085 * @since 1.8.0 3087 * @since 1.8.0
3086 * @ingroup Eet_Data_Group
3087 */ 3088 */
3088EAPI const char *eet_data_descriptor_name_get(const Eet_Data_Descriptor *edd); 3089EAPI const char *eet_data_descriptor_name_get(const Eet_Data_Descriptor *edd);
3089 3090
3090/** 3091/**
3091 * This function is an internal used by macros. 3092 * @ingroup Eet_Data_Group
3093 * @brief This function is an internal used by macros.
3092 * 3094 *
3093 * This function is used by macros EET_DATA_DESCRIPTOR_ADD_BASIC(), 3095 * This function is used by macros EET_DATA_DESCRIPTOR_ADD_BASIC(),
3094 * EET_DATA_DESCRIPTOR_ADD_SUB() and EET_DATA_DESCRIPTOR_ADD_LIST(). It is 3096 * EET_DATA_DESCRIPTOR_ADD_SUB() and EET_DATA_DESCRIPTOR_ADD_LIST(). It is
@@ -3111,7 +3113,6 @@ EAPI const char *eet_data_descriptor_name_get(const Eet_Data_Descriptor *edd);
3111 * @param subtype If contains a subtype, then its data descriptor. 3113 * @param subtype If contains a subtype, then its data descriptor.
3112 * 3114 *
3113 * @since 1.0.0 3115 * @since 1.0.0
3114 * @ingroup Eet_Data_Group
3115 */ 3116 */
3116EAPI void 3117EAPI void
3117eet_data_descriptor_element_add(Eet_Data_Descriptor *edd, 3118eet_data_descriptor_element_add(Eet_Data_Descriptor *edd,
@@ -3125,7 +3126,8 @@ eet_data_descriptor_element_add(Eet_Data_Descriptor *edd,
3125 Eet_Data_Descriptor *subtype); 3126 Eet_Data_Descriptor *subtype);
3126 3127
3127/** 3128/**
3128 * Read a data structure from an eet file and decodes it. 3129 * @ingroup Eet_Data_Group
3130 * @brief Reads a data structure from an eet file and decodes it.
3129 * @param ef The eet file handle to read from. 3131 * @param ef The eet file handle to read from.
3130 * @param edd The data descriptor handle to use when decoding. 3132 * @param edd The data descriptor handle to use when decoding.
3131 * @param name The key the data is stored under in the eet file. 3133 * @param name The key the data is stored under in the eet file.
@@ -3149,7 +3151,6 @@ eet_data_descriptor_element_add(Eet_Data_Descriptor *edd,
3149 * @see eet_data_read_cipher() 3151 * @see eet_data_read_cipher()
3150 * 3152 *
3151 * @since 1.0.0 3153 * @since 1.0.0
3152 * @ingroup Eet_Data_Group
3153 */ 3154 */
3154EAPI void * 3155EAPI void *
3155eet_data_read(Eet_File *ef, 3156eet_data_read(Eet_File *ef,
@@ -3157,13 +3158,14 @@ eet_data_read(Eet_File *ef,
3157 const char *name); 3158 const char *name);
3158 3159
3159/** 3160/**
3160 * Write a data structure from memory and store in an eet file. 3161 * @ingroup Eet_Data_Group
3162 * @brief Writes a data structure from memory and store in an eet file.
3161 * @param ef The eet file handle to write to. 3163 * @param ef The eet file handle to write to.
3162 * @param edd The data descriptor to use when encoding. 3164 * @param edd The data descriptor to use when encoding.
3163 * @param name The key to store the data under in the eet file. 3165 * @param name The key to store the data under in the eet file.
3164 * @param data A pointer to the data structure to save and encode. 3166 * @param data A pointer to the data structure to save and encode.
3165 * @param compress Compression flags for storage. 3167 * @param compress Compression flags for storage.
3166 * @return bytes written on successful write, 0 on failure. 3168 * @return bytes Written on successful write, @c 0 on failure.
3167 * 3169 *
3168 * This function is the reverse of eet_data_read(), saving a data structure 3170 * This function is the reverse of eet_data_read(), saving a data structure
3169 * to an eet file. The file must have been opening in write mode and the data 3171 * to an eet file. The file must have been opening in write mode and the data
@@ -3173,7 +3175,6 @@ eet_data_read(Eet_File *ef,
3173 * @see eet_data_write_cipher() 3175 * @see eet_data_write_cipher()
3174 * 3176 *
3175 * @since 1.0.0 3177 * @since 1.0.0
3176 * @ingroup Eet_Data_Group
3177 */ 3178 */
3178EAPI int 3179EAPI int
3179eet_data_write(Eet_File *ef, 3180eet_data_write(Eet_File *ef,
@@ -3187,20 +3188,21 @@ eet_data_write(Eet_File *ef,
3187 * 3188 *
3188 * Callback protoype for Eet_Dump 3189 * Callback protoype for Eet_Dump
3189 * 3190 *
3190 * @param data to passe to the callback 3191 * @param data To passe to the callback
3191 * @param str the string to dump 3192 * @param str The string to dump
3192 * 3193 *
3193 */ 3194 */
3194typedef void (*Eet_Dump_Callback)(void *data, const char *str); 3195typedef void (*Eet_Dump_Callback)(void *data, const char *str);
3195 3196
3196/** 3197/**
3197 * Dump an eet encoded data structure into ascii text 3198 * @ingroup Eet_Data_Group
3199 * @brief Dumps an eet encoded data structure into ascii text
3198 * @param data_in The pointer to the data to decode into a struct. 3200 * @param data_in The pointer to the data to decode into a struct.
3199 * @param size_in The size of the data pointed to in bytes. 3201 * @param size_in The size of the data pointed to in bytes.
3200 * @param dumpfunc The function to call passed a string when new 3202 * @param dumpfunc The function to call passed a string when new
3201 * data is converted to text 3203 * data is converted to text
3202 * @param dumpdata The data to pass to the @p dumpfunc callback. 3204 * @param dumpdata The data to pass to the @p dumpfunc callback.
3203 * @return 1 on success, 0 on failure 3205 * @return @c 1 on success, @c 0 on failure
3204 * 3206 *
3205 * This function will take a chunk of data encoded by 3207 * This function will take a chunk of data encoded by
3206 * eet_data_descriptor_encode() and convert it into human readable 3208 * eet_data_descriptor_encode() and convert it into human readable
@@ -3238,7 +3240,6 @@ typedef void (*Eet_Dump_Callback)(void *data, const char *str);
3238 * @see eet_data_text_dump_cipher() 3240 * @see eet_data_text_dump_cipher()
3239 * 3241 *
3240 * @since 1.0.0 3242 * @since 1.0.0
3241 * @ingroup Eet_Data_Group
3242 */ 3243 */
3243EAPI int 3244EAPI int
3244eet_data_text_dump(const void *data_in, 3245eet_data_text_dump(const void *data_in,
@@ -3247,7 +3248,8 @@ eet_data_text_dump(const void *data_in,
3247 void *dumpdata) EINA_ARG_NONNULL(3); 3248 void *dumpdata) EINA_ARG_NONNULL(3);
3248 3249
3249/** 3250/**
3250 * Take an ascii encoding from eet_data_text_dump() and re-encode in binary. 3251 * @ingroup Eet_Data_Group
3252 * @brief Takes an ascii encoding from eet_data_text_dump() and re-encode in binary.
3251 * @param text The pointer to the string data to parse and encode. 3253 * @param text The pointer to the string data to parse and encode.
3252 * @param textlen The size of the string in bytes (not including 0 3254 * @param textlen The size of the string in bytes (not including 0
3253 * byte terminator). 3255 * byte terminator).
@@ -3263,7 +3265,6 @@ eet_data_text_dump(const void *data_in,
3263 * @see eet_data_text_undump_cipher() 3265 * @see eet_data_text_undump_cipher()
3264 * 3266 *
3265 * @since 1.0.0 3267 * @since 1.0.0
3266 * @ingroup Eet_Data_Group
3267 */ 3268 */
3268EAPI void * 3269EAPI void *
3269eet_data_text_undump(const char *text, 3270eet_data_text_undump(const char *text,
@@ -3271,13 +3272,14 @@ eet_data_text_undump(const char *text,
3271 int *size_ret) EINA_ARG_NONNULL(3); 3272 int *size_ret) EINA_ARG_NONNULL(3);
3272 3273
3273/** 3274/**
3274 * Dump an eet encoded data structure from an eet file into ascii text 3275 * @ingroup Eet_Data_Group
3276 * @brief Dumps an eet encoded data structure from an eet file into ascii text.
3275 * @param ef A valid eet file handle. 3277 * @param ef A valid eet file handle.
3276 * @param name Name of the entry. eg: "/base/file_i_want". 3278 * @param name Name of the entry. eg: "/base/file_i_want".
3277 * @param dumpfunc The function to call passed a string when new 3279 * @param dumpfunc The function to call passed a string when new
3278 * data is converted to text 3280 * data is converted to text
3279 * @param dumpdata The data to pass to the @p dumpfunc callback. 3281 * @param dumpdata The data to pass to the @p dumpfunc callback.
3280 * @return 1 on success, 0 on failure 3282 * @return @c 1 on success, @c 0 on failure
3281 * 3283 *
3282 * This function will take an open and valid eet file from 3284 * This function will take an open and valid eet file from
3283 * eet_open() request the data encoded by 3285 * eet_open() request the data encoded by
@@ -3291,7 +3293,6 @@ eet_data_text_undump(const char *text,
3291 * @see eet_data_dump_cipher() 3293 * @see eet_data_dump_cipher()
3292 * 3294 *
3293 * @since 1.0.0 3295 * @since 1.0.0
3294 * @ingroup Eet_Data_Group
3295 */ 3296 */
3296EAPI int 3297EAPI int
3297eet_data_dump(Eet_File *ef, 3298eet_data_dump(Eet_File *ef,
@@ -3300,14 +3301,15 @@ eet_data_dump(Eet_File *ef,
3300 void *dumpdata) EINA_ARG_NONNULL(3); 3301 void *dumpdata) EINA_ARG_NONNULL(3);
3301 3302
3302/** 3303/**
3303 * Take an ascii encoding from eet_data_dump() and re-encode in binary. 3304 * @ingroup Eet_Data_Group
3305 * @brief Takes an ascii encoding from eet_data_dump() and re-encode in binary.
3304 * @param ef A valid eet file handle. 3306 * @param ef A valid eet file handle.
3305 * @param name Name of the entry. eg: "/base/file_i_want". 3307 * @param name Name of the entry. eg: "/base/file_i_want".
3306 * @param text The pointer to the string data to parse and encode. 3308 * @param text The pointer to the string data to parse and encode.
3307 * @param textlen The size of the string in bytes (not including 0 3309 * @param textlen The size of the string in bytes (not including 0
3308 * byte terminator). 3310 * byte terminator).
3309 * @param compress Compression flags (1 == compress, 0 = don't compress). 3311 * @param compress Compression flags (1 == compress, 0 = don't compress).
3310 * @return 1 on success, 0 on failure 3312 * @return @c 1 on success, @c 0 on failure
3311 * 3313 *
3312 * This function will parse the string pointed to by @p text, 3314 * This function will parse the string pointed to by @p text,
3313 * encode it the same way eet_data_descriptor_encode() takes an 3315 * encode it the same way eet_data_descriptor_encode() takes an
@@ -3319,7 +3321,6 @@ eet_data_dump(Eet_File *ef,
3319 * @see eet_data_undump_cipher() 3321 * @see eet_data_undump_cipher()
3320 * 3322 *
3321 * @since 1.0.0 3323 * @since 1.0.0
3322 * @ingroup Eet_Data_Group
3323 */ 3324 */
3324EAPI int 3325EAPI int
3325eet_data_undump(Eet_File *ef, 3326eet_data_undump(Eet_File *ef,
@@ -3329,8 +3330,9 @@ eet_data_undump(Eet_File *ef,
3329 int compress); 3330 int compress);
3330 3331
3331/** 3332/**
3332 * Decode a data structure from an arbitrary location in memory. 3333 * @ingroup Eet_Data_Group
3333 * @param edd The data descriptor to use when decoding. 3334 * @brief Decodes a data structure from an arbitrary location in memory.
3335 * @param edd The data descriptor to use when decoding.
3334 * @param data_in The pointer to the data to decode into a struct. 3336 * @param data_in The pointer to the data to decode into a struct.
3335 * @param size_in The size of the data pointed to in bytes. 3337 * @param size_in The size of the data pointed to in bytes.
3336 * @return NULL on failure, or a valid decoded struct pointer on success. 3338 * @return NULL on failure, or a valid decoded struct pointer on success.
@@ -3353,7 +3355,6 @@ eet_data_undump(Eet_File *ef,
3353 * @see eet_data_descriptor_decode_cipher() 3355 * @see eet_data_descriptor_decode_cipher()
3354 * 3356 *
3355 * @since 1.0.0 3357 * @since 1.0.0
3356 * @ingroup Eet_Data_Group
3357 */ 3358 */
3358EAPI void * 3359EAPI void *
3359eet_data_descriptor_decode(Eet_Data_Descriptor *edd, 3360eet_data_descriptor_decode(Eet_Data_Descriptor *edd,
@@ -3361,8 +3362,9 @@ eet_data_descriptor_decode(Eet_Data_Descriptor *edd,
3361 int size_in); 3362 int size_in);
3362 3363
3363/** 3364/**
3364 * Encode a dsata struct to memory and return that encoded data. 3365 * @ingroup Eet_Data_Group
3365 * @param edd The data descriptor to use when encoding. 3366 * @brief Encodes a dsata struct to memory and return that encoded data.
3367 * @param edd The data descriptor to use when encoding.
3366 * @param data_in The pointer to the struct to encode into data. 3368 * @param data_in The pointer to the struct to encode into data.
3367 * @param size_ret pointer to the an int to be filled with the decoded size. 3369 * @param size_ret pointer to the an int to be filled with the decoded size.
3368 * @return NULL on failure, or a valid encoded data chunk on success. 3370 * @return NULL on failure, or a valid encoded data chunk on success.
@@ -3387,7 +3389,6 @@ eet_data_descriptor_decode(Eet_Data_Descriptor *edd,
3387 * @see eet_data_descriptor_encode_cipher() 3389 * @see eet_data_descriptor_encode_cipher()
3388 * 3390 *
3389 * @since 1.0.0 3391 * @since 1.0.0
3390 * @ingroup Eet_Data_Group
3391 */ 3392 */
3392EAPI void * 3393EAPI void *
3393eet_data_descriptor_encode(Eet_Data_Descriptor *edd, 3394eet_data_descriptor_encode(Eet_Data_Descriptor *edd,
@@ -3395,7 +3396,8 @@ eet_data_descriptor_encode(Eet_Data_Descriptor *edd,
3395 int *size_ret); 3396 int *size_ret);
3396 3397
3397/** 3398/**
3398 * Add a basic data element to a data descriptor. 3399 * @ingroup Eet_Data_Group
3400 * @brief Adds a basic data element to a data descriptor.
3399 * @param edd The data descriptor to add the type to. 3401 * @param edd The data descriptor to add the type to.
3400 * @param struct_type The type of the struct. 3402 * @param struct_type The type of the struct.
3401 * @param name The string name to use to encode/decode this member 3403 * @param name The string name to use to encode/decode this member
@@ -3415,7 +3417,6 @@ eet_data_descriptor_encode(Eet_Data_Descriptor *edd,
3415 * EET_T_USHORT, EET_T_UINT, EET_T_ULONG_LONG or EET_T_STRING. 3417 * EET_T_USHORT, EET_T_UINT, EET_T_ULONG_LONG or EET_T_STRING.
3416 * 3418 *
3417 * @since 1.0.0 3419 * @since 1.0.0
3418 * @ingroup Eet_Data_Group
3419 */ 3420 */
3420#define EET_DATA_DESCRIPTOR_ADD_BASIC(edd, struct_type, name, member, type) \ 3421#define EET_DATA_DESCRIPTOR_ADD_BASIC(edd, struct_type, name, member, type) \
3421 do { \ 3422 do { \
@@ -3427,7 +3428,8 @@ eet_data_descriptor_encode(Eet_Data_Descriptor *edd,
3427 } while(0) 3428 } while(0)
3428 3429
3429/** 3430/**
3430 * Add a sub-element type to a data descriptor 3431 * @ingroup Eet_Data_Group
3432 * @brief Adds a sub-element type to a data descriptor.
3431 * @param edd The data descriptor to add the type to. 3433 * @param edd The data descriptor to add the type to.
3432 * @param struct_type The type of the struct. 3434 * @param struct_type The type of the struct.
3433 * @param name The string name to use to encode/decode this member 3435 * @param name The string name to use to encode/decode this member
@@ -3442,7 +3444,6 @@ eet_data_descriptor_encode(Eet_Data_Descriptor *edd,
3442 * this element. 3444 * this element.
3443 * 3445 *
3444 * @since 1.0.0 3446 * @since 1.0.0
3445 * @ingroup Eet_Data_Group
3446 */ 3447 */
3447#define EET_DATA_DESCRIPTOR_ADD_SUB(edd, struct_type, name, member, subtype) \ 3448#define EET_DATA_DESCRIPTOR_ADD_SUB(edd, struct_type, name, member, subtype) \
3448 do { \ 3449 do { \
@@ -3454,7 +3455,8 @@ eet_data_descriptor_encode(Eet_Data_Descriptor *edd,
3454 } while (0) 3455 } while (0)
3455 3456
3456/** 3457/**
3457 * Add a nested sub-element type to a data descriptor 3458 * @ingroup Eet_Data_Group
3459 * @brief Adds a nested sub-element type to a data descriptor.
3458 * @param edd The data descriptor to add the type to. 3460 * @param edd The data descriptor to add the type to.
3459 * @param struct_type The type of the struct. 3461 * @param struct_type The type of the struct.
3460 * @param name The string name to use to encode/decode this member 3462 * @param name The string name to use to encode/decode this member
@@ -3468,7 +3470,6 @@ eet_data_descriptor_encode(Eet_Data_Descriptor *edd,
3468 * All the parameters are the same as for EET_DATA_DESCRIPTOR_ADD_SUB(). 3470 * All the parameters are the same as for EET_DATA_DESCRIPTOR_ADD_SUB().
3469 * 3471 *
3470 * @since 1.8.0 3472 * @since 1.8.0
3471 * @ingroup Eet_Data_Group
3472 */ 3473 */
3473#define EET_DATA_DESCRIPTOR_ADD_SUB_NESTED(edd, struct_type, name, member, subtype) \ 3474#define EET_DATA_DESCRIPTOR_ADD_SUB_NESTED(edd, struct_type, name, member, subtype) \
3474 do { \ 3475 do { \
@@ -3480,7 +3481,8 @@ eet_data_descriptor_encode(Eet_Data_Descriptor *edd,
3480 } while (0) 3481 } while (0)
3481 3482
3482/** 3483/**
3483 * Add a linked list type to a data descriptor 3484 * @ingroup Eet_Data_Group
3485 * @brief Adds a linked list type to a data descriptor.
3484 * @param edd The data descriptor to add the type to. 3486 * @param edd The data descriptor to add the type to.
3485 * @param struct_type The type of the struct. 3487 * @param struct_type The type of the struct.
3486 * @param name The string name to use to encode/decode this member 3488 * @param name The string name to use to encode/decode this member
@@ -3494,7 +3496,6 @@ eet_data_descriptor_encode(Eet_Data_Descriptor *edd,
3494 * element that is in each member of the linked list to be stored. 3496 * element that is in each member of the linked list to be stored.
3495 * 3497 *
3496 * @since 1.0.0 3498 * @since 1.0.0
3497 * @ingroup Eet_Data_Group
3498 */ 3499 */
3499#define EET_DATA_DESCRIPTOR_ADD_LIST(edd, struct_type, name, member, subtype) \ 3500#define EET_DATA_DESCRIPTOR_ADD_LIST(edd, struct_type, name, member, subtype) \
3500 do { \ 3501 do { \
@@ -3506,7 +3507,8 @@ eet_data_descriptor_encode(Eet_Data_Descriptor *edd,
3506 } while (0) 3507 } while (0)
3507 3508
3508/** 3509/**
3509 * Add a linked list of string to a data descriptor 3510 * @ingroup Eet_Data_Group
3511 * @brief Adds a linked list of string to a data descriptor.
3510 * @param edd The data descriptor to add the type to. 3512 * @param edd The data descriptor to add the type to.
3511 * @param struct_type The type of the struct. 3513 * @param struct_type The type of the struct.
3512 * @param name The string name to use to encode/decode this member 3514 * @param name The string name to use to encode/decode this member
@@ -3517,7 +3519,6 @@ eet_data_descriptor_encode(Eet_Data_Descriptor *edd,
3517 * parameters are the same as for EET_DATA_DESCRIPTOR_ADD_BASIC(). 3519 * parameters are the same as for EET_DATA_DESCRIPTOR_ADD_BASIC().
3518 * 3520 *
3519 * @since 1.5.0 3521 * @since 1.5.0
3520 * @ingroup Eet_Data_Group
3521 */ 3522 */
3522#define EET_DATA_DESCRIPTOR_ADD_LIST_STRING(edd, struct_type, name, member) \ 3523#define EET_DATA_DESCRIPTOR_ADD_LIST_STRING(edd, struct_type, name, member) \
3523 do { \ 3524 do { \
@@ -3529,7 +3530,8 @@ eet_data_descriptor_encode(Eet_Data_Descriptor *edd,
3529 } while (0) 3530 } while (0)
3530 3531
3531/** 3532/**
3532 * Add a hash type to a data descriptor 3533 * @ingroup Eet_Data_Group
3534 * @brief Adds a hash type to a data descriptor.
3533 * @param edd The data descriptor to add the type to. 3535 * @param edd The data descriptor to add the type to.
3534 * @param struct_type The type of the struct. 3536 * @param struct_type The type of the struct.
3535 * @param name The string name to use to encode/decode this member 3537 * @param name The string name to use to encode/decode this member
@@ -3544,7 +3546,6 @@ eet_data_descriptor_encode(Eet_Data_Descriptor *edd,
3544 * The hash keys must be strings. 3546 * The hash keys must be strings.
3545 * 3547 *
3546 * @since 1.0.0 3548 * @since 1.0.0
3547 * @ingroup Eet_Data_Group
3548 */ 3549 */
3549#define EET_DATA_DESCRIPTOR_ADD_HASH(edd, struct_type, name, member, subtype) \ 3550#define EET_DATA_DESCRIPTOR_ADD_HASH(edd, struct_type, name, member, subtype) \
3550 do { \ 3551 do { \
@@ -3556,7 +3557,8 @@ eet_data_descriptor_encode(Eet_Data_Descriptor *edd,
3556 } while (0) 3557 } while (0)
3557 3558
3558/** 3559/**
3559 * Add a hash of string to a data descriptor 3560 * @ingroup Eet_Data_Group
3561 * @brief Adds a hash of string to a data descriptor.
3560 * @param edd The data descriptor to add the type to. 3562 * @param edd The data descriptor to add the type to.
3561 * @param struct_type The type of the struct. 3563 * @param struct_type The type of the struct.
3562 * @param name The string name to use to encode/decode this member 3564 * @param name The string name to use to encode/decode this member
@@ -3567,7 +3569,6 @@ eet_data_descriptor_encode(Eet_Data_Descriptor *edd,
3567 * parameters are the same as for EET_DATA_DESCRIPTOR_ADD_HASH(). 3569 * parameters are the same as for EET_DATA_DESCRIPTOR_ADD_HASH().
3568 * 3570 *
3569 * @since 1.3.4 3571 * @since 1.3.4
3570 * @ingroup Eet_Data_Group
3571 */ 3572 */
3572#define EET_DATA_DESCRIPTOR_ADD_HASH_STRING(edd, struct_type, name, member) \ 3573#define EET_DATA_DESCRIPTOR_ADD_HASH_STRING(edd, struct_type, name, member) \
3573 do { \ 3574 do { \
@@ -3579,7 +3580,8 @@ eet_data_descriptor_encode(Eet_Data_Descriptor *edd,
3579 } while (0) 3580 } while (0)
3580 3581
3581/** 3582/**
3582 * Add a hash of generic value storage to a data descriptor 3583 * @ingroup Eet_Data_Group
3584 * @brief Adds a hash of generic value storage to a data descriptor.
3583 * @param edd The data descriptor to add the type to. 3585 * @param edd The data descriptor to add the type to.
3584 * @param struct_type The type of the struct. 3586 * @param struct_type The type of the struct.
3585 * @param name The string name to use to encode/decode this member 3587 * @param name The string name to use to encode/decode this member
@@ -3590,7 +3592,6 @@ eet_data_descriptor_encode(Eet_Data_Descriptor *edd,
3590 * parameters are the same as for EET_DATA_DESCRIPTOR_ADD_HASH(). 3592 * parameters are the same as for EET_DATA_DESCRIPTOR_ADD_HASH().
3591 * 3593 *
3592 * @since 1.18 3594 * @since 1.18
3593 * @ingroup Eet_Data_Group
3594 */ 3595 */
3595#define EET_DATA_DESCRIPTOR_ADD_HASH_VALUE(edd, struct_type, name, member) \ 3596#define EET_DATA_DESCRIPTOR_ADD_HASH_VALUE(edd, struct_type, name, member) \
3596 do { \ 3597 do { \
@@ -3602,7 +3603,8 @@ eet_data_descriptor_encode(Eet_Data_Descriptor *edd,
3602 } while (0) 3603 } while (0)
3603 3604
3604/** 3605/**
3605 * Add an array of basic data elements to a data descriptor. 3606 * @ingroup Eet_Data_Group
3607 * @brief Adds an array of basic data elements to a data descriptor.
3606 * @param edd The data descriptor to add the type to. 3608 * @param edd The data descriptor to add the type to.
3607 * @param struct_type The type of the struct. 3609 * @param struct_type The type of the struct.
3608 * @param name The string name to use to encode/decode this member 3610 * @param name The string name to use to encode/decode this member
@@ -3617,7 +3619,6 @@ eet_data_descriptor_encode(Eet_Data_Descriptor *edd,
3617 * struct containing it. 3619 * struct containing it.
3618 * 3620 *
3619 * @since 1.5.0 3621 * @since 1.5.0
3620 * @ingroup Eet_Data_Group
3621 */ 3622 */
3622#define EET_DATA_DESCRIPTOR_ADD_BASIC_ARRAY(edd, struct_type, name, member, type) \ 3623#define EET_DATA_DESCRIPTOR_ADD_BASIC_ARRAY(edd, struct_type, name, member, type) \
3623 do { \ 3624 do { \
@@ -3631,7 +3632,8 @@ eet_data_descriptor_encode(Eet_Data_Descriptor *edd,
3631 } while(0) 3632 } while(0)
3632 3633
3633/** 3634/**
3634 * Add a variable array of basic data elements to a data descriptor. 3635 * @ingroup Eet_Data_Group
3636 * @brief Adds a variable array of basic data elements to a data descriptor.
3635 * @param edd The data descriptor to add the type to. 3637 * @param edd The data descriptor to add the type to.
3636 * @param struct_type The type of the struct. 3638 * @param struct_type The type of the struct.
3637 * @param name The string name to use to encode/decode this member 3639 * @param name The string name to use to encode/decode this member
@@ -3648,7 +3650,6 @@ eet_data_descriptor_encode(Eet_Data_Descriptor *edd,
3648 * is in. 3650 * is in.
3649 * 3651 *
3650 * @since 1.6.0 3652 * @since 1.6.0
3651 * @ingroup Eet_Data_Group
3652 */ 3653 */
3653#define EET_DATA_DESCRIPTOR_ADD_BASIC_VAR_ARRAY(edd, struct_type, name, member, type) \ 3654#define EET_DATA_DESCRIPTOR_ADD_BASIC_VAR_ARRAY(edd, struct_type, name, member, type) \
3654 do { \ 3655 do { \
@@ -3663,7 +3664,8 @@ eet_data_descriptor_encode(Eet_Data_Descriptor *edd,
3663 } while(0) 3664 } while(0)
3664 3665
3665/** 3666/**
3666 * Add a fixed size array type to a data descriptor 3667 * @ingroup Eet_Data_Group
3668 * @brief Adds a fixed size array type to a data descriptor.
3667 * @param edd The data descriptor to add the type to. 3669 * @param edd The data descriptor to add the type to.
3668 * @param struct_type The type of the struct. 3670 * @param struct_type The type of the struct.
3669 * @param name The string name to use to encode/decode this member 3671 * @param name The string name to use to encode/decode this member
@@ -3680,7 +3682,6 @@ eet_data_descriptor_encode(Eet_Data_Descriptor *edd,
3680 * struct containing it. 3682 * struct containing it.
3681 * 3683 *
3682 * @since 1.0.2 3684 * @since 1.0.2
3683 * @ingroup Eet_Data_Group
3684 */ 3685 */
3685#define EET_DATA_DESCRIPTOR_ADD_ARRAY(edd, struct_type, name, member, subtype) \ 3686#define EET_DATA_DESCRIPTOR_ADD_ARRAY(edd, struct_type, name, member, subtype) \
3686 do { \ 3687 do { \
@@ -3693,7 +3694,8 @@ eet_data_descriptor_encode(Eet_Data_Descriptor *edd,
3693 } while (0) 3694 } while (0)
3694 3695
3695/** 3696/**
3696 * Add a variable size array type to a data descriptor 3697 * @ingroup Eet_Data_Group
3698 * @brief Adds a variable size array type to a data descriptor.
3697 * @param edd The data descriptor to add the type to. 3699 * @param edd The data descriptor to add the type to.
3698 * @param struct_type The type of the struct. 3700 * @param struct_type The type of the struct.
3699 * @param name The string name to use to encode/decode this member 3701 * @param name The string name to use to encode/decode this member
@@ -3712,7 +3714,6 @@ eet_data_descriptor_encode(Eet_Data_Descriptor *edd,
3712 * is in. 3714 * is in.
3713 * 3715 *
3714 * @since 1.0.2 3716 * @since 1.0.2
3715 * @ingroup Eet_Data_Group
3716 */ 3717 */
3717#define EET_DATA_DESCRIPTOR_ADD_VAR_ARRAY(edd, struct_type, name, member, subtype) \ 3718#define EET_DATA_DESCRIPTOR_ADD_VAR_ARRAY(edd, struct_type, name, member, subtype) \
3718 do { \ 3719 do { \
@@ -3730,7 +3731,8 @@ eet_data_descriptor_encode(Eet_Data_Descriptor *edd,
3730 } while (0) 3731 } while (0)
3731 3732
3732/** 3733/**
3733 * Add a variable size array type to a data descriptor 3734 * @ingroup Eet_Data_Group
3735 * @brief Adds a variable size array type to a data descriptor.
3734 * @param edd The data descriptor to add the type to. 3736 * @param edd The data descriptor to add the type to.
3735 * @param struct_type The type of the struct. 3737 * @param struct_type The type of the struct.
3736 * @param name The string name to use to encode/decode this member 3738 * @param name The string name to use to encode/decode this member
@@ -3741,7 +3743,6 @@ eet_data_descriptor_encode(Eet_Data_Descriptor *edd,
3741 * the parameters are the same as for EET_DATA_DESCRIPTOR_ADD_BASIC(). 3743 * the parameters are the same as for EET_DATA_DESCRIPTOR_ADD_BASIC().
3742 * 3744 *
3743 * @since 1.4.0 3745 * @since 1.4.0
3744 * @ingroup Eet_Data_Group
3745 */ 3746 */
3746#define EET_DATA_DESCRIPTOR_ADD_VAR_ARRAY_STRING(edd, struct_type, name, member) \ 3747#define EET_DATA_DESCRIPTOR_ADD_VAR_ARRAY_STRING(edd, struct_type, name, member) \
3747 do { \ 3748 do { \
@@ -3759,7 +3760,8 @@ eet_data_descriptor_encode(Eet_Data_Descriptor *edd,
3759 } while (0) 3760 } while (0)
3760 3761
3761/** 3762/**
3762 * Add an union type to a data descriptor 3763 * @ingroup Eet_Data_Group
3764 * @brief Adds an union type to a data descriptor.
3763 * @param edd The data descriptor to add the type to. 3765 * @param edd The data descriptor to add the type to.
3764 * @param struct_type The type of the struct. 3766 * @param struct_type The type of the struct.
3765 * @param name The string name to use to encode/decode this member 3767 * @param name The string name to use to encode/decode this member
@@ -3774,7 +3776,6 @@ eet_data_descriptor_encode(Eet_Data_Descriptor *edd,
3774 * callback of unified_type should be defined. 3776 * callback of unified_type should be defined.
3775 * 3777 *
3776 * @since 1.2.4 3778 * @since 1.2.4
3777 * @ingroup Eet_Data_Group
3778 * @see Eet_Data_Descriptor_Class 3779 * @see Eet_Data_Descriptor_Class
3779 */ 3780 */
3780#define EET_DATA_DESCRIPTOR_ADD_UNION(edd, struct_type, name, member, type_member, unified_type) \ 3781#define EET_DATA_DESCRIPTOR_ADD_UNION(edd, struct_type, name, member, type_member, unified_type) \
@@ -3789,7 +3790,8 @@ eet_data_descriptor_encode(Eet_Data_Descriptor *edd,
3789 } while (0) 3790 } while (0)
3790 3791
3791/** 3792/**
3792 * Add a automatically selectable type to a data descriptor 3793 * @ingroup Eet_Data_Group
3794 * @brief Adds a automatically selectable type to a data descriptor.
3793 * @param edd The data descriptor to add the type to. 3795 * @param edd The data descriptor to add the type to.
3794 * @param struct_type The type of the struct. 3796 * @param struct_type The type of the struct.
3795 * @param name The string name to use to encode/decode this member 3797 * @param name The string name to use to encode/decode this member
@@ -3806,7 +3808,6 @@ eet_data_descriptor_encode(Eet_Data_Descriptor *edd,
3806 * given previously and telling it by setting unknow to EINA_TRUE. 3808 * given previously and telling it by setting unknow to EINA_TRUE.
3807 * 3809 *
3808 * @since 1.2.4 3810 * @since 1.2.4
3809 * @ingroup Eet_Data_Group
3810 * @see Eet_Data_Descriptor_Class 3811 * @see Eet_Data_Descriptor_Class
3811 */ 3812 */
3812#define EET_DATA_DESCRIPTOR_ADD_VARIANT(edd, struct_type, name, member, type_member, unified_type) \ 3813#define EET_DATA_DESCRIPTOR_ADD_VARIANT(edd, struct_type, name, member, type_member, unified_type) \
@@ -3821,13 +3822,13 @@ eet_data_descriptor_encode(Eet_Data_Descriptor *edd,
3821 } while (0) 3822 } while (0)
3822 3823
3823/** 3824/**
3824 * Add a mapping to a data descriptor that will be used by union, variant or inherited type 3825 * @ingroup Eet_Data_Group
3826 * @brief Adds a mapping to a data descriptor that will be used by union, variant or inherited type.
3825 * @param unified_type The data descriptor to add the mapping to. 3827 * @param unified_type The data descriptor to add the mapping to.
3826 * @param name The string name to get/set type. 3828 * @param name The string name to get/set type.
3827 * @param subtype The matching data descriptor. 3829 * @param subtype The matching data descriptor.
3828 * 3830 *
3829 * @since 1.2.4 3831 * @since 1.2.4
3830 * @ingroup Eet_Data_Group
3831 * @see Eet_Data_Descriptor_Class 3832 * @see Eet_Data_Descriptor_Class
3832 */ 3833 */
3833#define EET_DATA_DESCRIPTOR_ADD_MAPPING(unified_type, name, subtype) \ 3834#define EET_DATA_DESCRIPTOR_ADD_MAPPING(unified_type, name, subtype) \
@@ -3841,13 +3842,13 @@ eet_data_descriptor_encode(Eet_Data_Descriptor *edd,
3841 subtype) 3842 subtype)
3842 3843
3843/** 3844/**
3844 * Add a mapping of a basic type to a data descriptor that will be used by a union type. 3845 * @ingroup Eet_Data_Group
3846 * @brief Adds a mapping of a basic type to a data descriptor that will be used by a union type.
3845 * @param unified_type The data descriptor to add the mapping to. 3847 * @param unified_type The data descriptor to add the mapping to.
3846 * @param name The string name to get/set type. 3848 * @param name The string name to get/set type.
3847 * @param basic_type The matching basic type. 3849 * @param basic_type The matching basic type.
3848 * 3850 *
3849 * @since 1.8 3851 * @since 1.8
3850 * @ingroup Eet_Data_Group
3851 * @see Eet_Data_Descriptor_Class 3852 * @see Eet_Data_Descriptor_Class
3852 */ 3853 */
3853#define EET_DATA_DESCRIPTOR_ADD_MAPPING_BASIC(unified_type, name, basic_type) \ 3854#define EET_DATA_DESCRIPTOR_ADD_MAPPING_BASIC(unified_type, name, basic_type) \
@@ -3861,17 +3862,18 @@ eet_data_descriptor_encode(Eet_Data_Descriptor *edd,
3861 NULL) 3862 NULL)
3862/** 3863/**
3863 * @defgroup Eet_Data_Cipher_Group Eet Data Serialization using A Ciphers 3864 * @defgroup Eet_Data_Cipher_Group Eet Data Serialization using A Ciphers
3865 * @ingroup Eet_Data_Group
3864 * 3866 *
3865 * Most of the @ref Eet_Data_Group have alternative versions that 3867 * Most of the @ref Eet_Data_Group have alternative versions that
3866 * accounts for ciphers to protect their content. 3868 * accounts for ciphers to protect their content.
3867 * 3869 *
3868 * @see @ref Eet_Cipher_Group 3870 * @see @ref Eet_Cipher_Group
3869 * 3871 *
3870 * @ingroup Eet_Data_Group
3871 */ 3872 */
3872 3873
3873/** 3874/**
3874 * Read a data structure from an eet file and decodes it using a cipher. 3875 * @ingroup Eet_Data_Cipher_Group
3876 * @brief Reads a data structure from an eet file and decodes it using a cipher.
3875 * @param ef The eet file handle to read from. 3877 * @param ef The eet file handle to read from.
3876 * @param edd The data descriptor handle to use when decoding. 3878 * @param edd The data descriptor handle to use when decoding.
3877 * @param name The key the data is stored under in the eet file. 3879 * @param name The key the data is stored under in the eet file.
@@ -3896,7 +3898,6 @@ eet_data_descriptor_encode(Eet_Data_Descriptor *edd,
3896 * @see eet_data_read() 3898 * @see eet_data_read()
3897 * 3899 *
3898 * @since 1.0.0 3900 * @since 1.0.0
3899 * @ingroup Eet_Data_Cipher_Group
3900 */ 3901 */
3901EAPI void * 3902EAPI void *
3902eet_data_read_cipher(Eet_File *ef, 3903eet_data_read_cipher(Eet_File *ef,
@@ -3905,14 +3906,15 @@ eet_data_read_cipher(Eet_File *ef,
3905 const char *cipher_key); 3906 const char *cipher_key);
3906 3907
3907/** 3908/**
3908 * Read a data structure from an eet file and decodes it into a buffer using a cipher, 3909 * @ingroup Eet_Data_Cipher_Group
3910 * @brief Reads a data structure from an eet file and decodes it into a buffer using a cipher.
3909 * @param ef The eet file handle to read from. 3911 * @param ef The eet file handle to read from.
3910 * @param edd The data descriptor handle to use when decoding. 3912 * @param edd The data descriptor handle to use when decoding.
3911 * @param name The key the data is stored under in the eet file. 3913 * @param name The key the data is stored under in the eet file.
3912 * @param cipher_key The key to use as cipher. 3914 * @param cipher_key The key to use as cipher.
3913 * @param buffer Buffer. 3915 * @param buffer Buffer.
3914 * @param buffer_size The buffer size. 3916 * @param buffer_size The buffer size.
3915 * @return A pointer to buffer if successful and NULL on error. 3917 * @return A pointer to buffer if successful, and NULL on error.
3916 * 3918 *
3917 * This function decodes a data structure stored in an eet file, returning 3919 * This function decodes a data structure stored in an eet file, returning
3918 * a pointer to it if it decoded successfully, or NULL on failure. This 3920 * a pointer to it if it decoded successfully, or NULL on failure. This
@@ -3932,7 +3934,6 @@ eet_data_read_cipher(Eet_File *ef,
3932 * @see eet_data_read_cipher() 3934 * @see eet_data_read_cipher()
3933 * 3935 *
3934 * @since 1.10.0 3936 * @since 1.10.0
3935 * @ingroup Eet_Data_Cipher_Group
3936 */ 3937 */
3937EAPI void * 3938EAPI void *
3938eet_data_read_cipher_buffer(Eet_File *ef, 3939eet_data_read_cipher_buffer(Eet_File *ef,
@@ -3943,7 +3944,8 @@ eet_data_read_cipher_buffer(Eet_File *ef,
3943 int buffer_size); 3944 int buffer_size);
3944 3945
3945/** 3946/**
3946 * Read a data structure from an eet extended attribute and decodes it using a cipher. 3947 * @ingroup Eet_Data_Cipher_Group
3948 * @brief Reads a data structure from an eet extended attribute and decodes it using a cipher.
3947 * @param filename The file to extract the extended attribute from. 3949 * @param filename The file to extract the extended attribute from.
3948 * @param attribute The attribute to get the data from. 3950 * @param attribute The attribute to get the data from.
3949 * @param edd The data descriptor handle to use when decoding. 3951 * @param edd The data descriptor handle to use when decoding.
@@ -3963,7 +3965,6 @@ eet_data_read_cipher_buffer(Eet_File *ef,
3963 * is as simple as a single function call. 3965 * is as simple as a single function call.
3964 * 3966 *
3965 * @since 1.5.0 3967 * @since 1.5.0
3966 * @ingroup Eet_Data_Cipher_Group
3967 */ 3968 */
3968EAPI void * 3969EAPI void *
3969eet_data_xattr_cipher_get(const char *filename, 3970eet_data_xattr_cipher_get(const char *filename,
@@ -3972,7 +3973,8 @@ eet_data_xattr_cipher_get(const char *filename,
3972 const char *cipher_key); 3973 const char *cipher_key);
3973 3974
3974/** 3975/**
3975 * Write a data structure from memory and store in an eet file 3976 * @ingroup Eet_Data_Cipher_Group
3977 * @brief Writes a data structure from memory and store in an eet file
3976 * using a cipher. 3978 * using a cipher.
3977 * @param ef The eet file handle to write to. 3979 * @param ef The eet file handle to write to.
3978 * @param edd The data descriptor to use when encoding. 3980 * @param edd The data descriptor to use when encoding.
@@ -3986,7 +3988,6 @@ eet_data_xattr_cipher_get(const char *filename,
3986 * to an eet file. 3988 * to an eet file.
3987 * 3989 *
3988 * @since 1.0.0 3990 * @since 1.0.0
3989 * @ingroup Eet_Data_Cipher_Group
3990 */ 3991 */
3991EAPI int 3992EAPI int
3992eet_data_write_cipher(Eet_File *ef, 3993eet_data_write_cipher(Eet_File *ef,
@@ -3997,7 +3998,8 @@ eet_data_write_cipher(Eet_File *ef,
3997 int compress); 3998 int compress);
3998 3999
3999/** 4000/**
4000 * Write a data structure from memory and store in an eet extended attribute 4001 * @ingroup Eet_Data_Cipher_Group
4002 * @brief Writes a data structure from memory and store in an eet extended attribute
4001 * using a cipher. 4003 * using a cipher.
4002 * @param filename The file to write the extended attribute to. 4004 * @param filename The file to write the extended attribute to.
4003 * @param attribute The attribute to store the data to. 4005 * @param attribute The attribute to store the data to.
@@ -4011,7 +4013,6 @@ eet_data_write_cipher(Eet_File *ef,
4011 * to an eet extended attribute. 4013 * to an eet extended attribute.
4012 * 4014 *
4013 * @since 1.5.0 4015 * @since 1.5.0
4014 * @ingroup Eet_Data_Cipher_Group
4015 */ 4016 */
4016EAPI Eina_Bool 4017EAPI Eina_Bool
4017eet_data_xattr_cipher_set(const char *filename, 4018eet_data_xattr_cipher_set(const char *filename,
@@ -4022,14 +4023,15 @@ eet_data_xattr_cipher_set(const char *filename,
4022 Eina_Xattr_Flags flags); 4023 Eina_Xattr_Flags flags);
4023 4024
4024/** 4025/**
4025 * Dump an eet encoded data structure into ascii text using a cipher. 4026 * @ingroup Eet_Data_Cipher_Group
4027 * @brief Dumps an eet encoded data structure into ascii text using a cipher.
4026 * @param data_in The pointer to the data to decode into a struct. 4028 * @param data_in The pointer to the data to decode into a struct.
4027 * @param cipher_key The key to use as cipher. 4029 * @param cipher_key The key to use as cipher.
4028 * @param size_in The size of the data pointed to in bytes. 4030 * @param size_in The size of the data pointed to in bytes.
4029 * @param dumpfunc The function to call passed a string when new 4031 * @param dumpfunc The function to call passed a string when new
4030 * data is converted to text 4032 * data is converted to text
4031 * @param dumpdata The data to pass to the @p dumpfunc callback. 4033 * @param dumpdata The data to pass to the @p dumpfunc callback.
4032 * @return 1 on success, 0 on failure 4034 * @return @c 1 on success, @c 0 on failure
4033 * 4035 *
4034 * This function will take a chunk of data encoded by 4036 * This function will take a chunk of data encoded by
4035 * eet_data_descriptor_encode() and convert it into human readable 4037 * eet_data_descriptor_encode() and convert it into human readable
@@ -4067,7 +4069,6 @@ eet_data_xattr_cipher_set(const char *filename,
4067 * @see eet_data_text_dump() 4069 * @see eet_data_text_dump()
4068 * 4070 *
4069 * @since 1.0.0 4071 * @since 1.0.0
4070 * @ingroup Eet_Data_Cipher_Group
4071 */ 4072 */
4072EAPI int 4073EAPI int
4073eet_data_text_dump_cipher(const void *data_in, 4074eet_data_text_dump_cipher(const void *data_in,
@@ -4077,7 +4078,8 @@ eet_data_text_dump_cipher(const void *data_in,
4077 void *dumpdata) EINA_ARG_NONNULL(4); 4078 void *dumpdata) EINA_ARG_NONNULL(4);
4078 4079
4079/** 4080/**
4080 * Take an ascii encoding from eet_data_text_dump() and re-encode 4081 * @ingroup Eet_Data_Cipher_Group
4082 * @brief Takes an ascii encoding from eet_data_text_dump() and re-encode
4081 * in binary using a cipher. 4083 * in binary using a cipher.
4082 * @param text The pointer to the string data to parse and encode. 4084 * @param text The pointer to the string data to parse and encode.
4083 * @param cipher_key The key to use as cipher. 4085 * @param cipher_key The key to use as cipher.
@@ -4095,7 +4097,6 @@ eet_data_text_dump_cipher(const void *data_in,
4095 * @see eet_data_text_undump() 4097 * @see eet_data_text_undump()
4096 * 4098 *
4097 * @since 1.0.0 4099 * @since 1.0.0
4098 * @ingroup Eet_Data_Cipher_Group
4099 */ 4100 */
4100EAPI void * 4101EAPI void *
4101eet_data_text_undump_cipher(const char *text, 4102eet_data_text_undump_cipher(const char *text,
@@ -4104,7 +4105,8 @@ eet_data_text_undump_cipher(const char *text,
4104 int *size_ret) EINA_ARG_NONNULL(4); 4105 int *size_ret) EINA_ARG_NONNULL(4);
4105 4106
4106/** 4107/**
4107 * Dump an eet encoded data structure from an eet file into ascii 4108 * @ingroup Eet_Data_Cipher_Group
4109 * @brief Dumps an eet encoded data structure from an eet file into ascii
4108 * text using a cipher. 4110 * text using a cipher.
4109 * @param ef A valid eet file handle. 4111 * @param ef A valid eet file handle.
4110 * @param name Name of the entry. eg: "/base/file_i_want". 4112 * @param name Name of the entry. eg: "/base/file_i_want".
@@ -4112,7 +4114,7 @@ eet_data_text_undump_cipher(const char *text,
4112 * @param dumpfunc The function to call passed a string when new 4114 * @param dumpfunc The function to call passed a string when new
4113 * data is converted to text 4115 * data is converted to text
4114 * @param dumpdata The data to pass to the @p dumpfunc callback. 4116 * @param dumpdata The data to pass to the @p dumpfunc callback.
4115 * @return 1 on success, 0 on failure 4117 * @return @c 1 on success, @c 0 on failure
4116 * 4118 *
4117 * This function will take an open and valid eet file from 4119 * This function will take an open and valid eet file from
4118 * eet_open() request the data encoded by 4120 * eet_open() request the data encoded by
@@ -4126,7 +4128,6 @@ eet_data_text_undump_cipher(const char *text,
4126 * @see eet_data_dump() 4128 * @see eet_data_dump()
4127 * 4129 *
4128 * @since 1.0.0 4130 * @since 1.0.0
4129 * @ingroup Eet_Data_Cipher_Group
4130 */ 4131 */
4131EAPI int 4132EAPI int
4132eet_data_dump_cipher(Eet_File *ef, 4133eet_data_dump_cipher(Eet_File *ef,
@@ -4136,7 +4137,8 @@ eet_data_dump_cipher(Eet_File *ef,
4136 void *dumpdata) EINA_ARG_NONNULL(4); 4137 void *dumpdata) EINA_ARG_NONNULL(4);
4137 4138
4138/** 4139/**
4139 * Take an ascii encoding from eet_data_dump() and re-encode in 4140 * @ingroup Eet_Data_Cipher_Group
4141 * @brief Takes an ascii encoding from eet_data_dump() and re-encode in
4140 * binary using a cipher. 4142 * binary using a cipher.
4141 * @param ef A valid eet file handle. 4143 * @param ef A valid eet file handle.
4142 * @param name Name of the entry. eg: "/base/file_i_want". 4144 * @param name Name of the entry. eg: "/base/file_i_want".
@@ -4145,7 +4147,7 @@ eet_data_dump_cipher(Eet_File *ef,
4145 * @param textlen The size of the string in bytes (not including 0 4147 * @param textlen The size of the string in bytes (not including 0
4146 * byte terminator). 4148 * byte terminator).
4147 * @param compress Compression flags (1 == compress, 0 = don't compress). 4149 * @param compress Compression flags (1 == compress, 0 = don't compress).
4148 * @return 1 on success, 0 on failure 4150 * @return @c 1 on success, @c 0 on failure
4149 * 4151 *
4150 * This function will parse the string pointed to by @p text, 4152 * This function will parse the string pointed to by @p text,
4151 * encode it the same way eet_data_descriptor_encode() takes an 4153 * encode it the same way eet_data_descriptor_encode() takes an
@@ -4157,7 +4159,6 @@ eet_data_dump_cipher(Eet_File *ef,
4157 * @see eet_data_undump() 4159 * @see eet_data_undump()
4158 * 4160 *
4159 * @since 1.0.0 4161 * @since 1.0.0
4160 * @ingroup Eet_Data_Cipher_Group
4161 */ 4162 */
4162EAPI int 4163EAPI int
4163eet_data_undump_cipher(Eet_File *ef, 4164eet_data_undump_cipher(Eet_File *ef,
@@ -4168,7 +4169,8 @@ eet_data_undump_cipher(Eet_File *ef,
4168 int compress); 4169 int compress);
4169 4170
4170/** 4171/**
4171 * Decode a data structure from an arbitrary location in memory 4172 * @ingroup Eet_Data_Cipher_Group
4173 * @brief Decodes a data structure from an arbitrary location in memory
4172 * using a cipher. 4174 * using a cipher.
4173 * @param edd The data descriptor to use when decoding. 4175 * @param edd The data descriptor to use when decoding.
4174 * @param data_in The pointer to the data to decode into a struct. 4176 * @param data_in The pointer to the data to decode into a struct.
@@ -4194,7 +4196,6 @@ eet_data_undump_cipher(Eet_File *ef,
4194 * @see eet_data_descriptor_decode() 4196 * @see eet_data_descriptor_decode()
4195 * 4197 *
4196 * @since 1.0.0 4198 * @since 1.0.0
4197 * @ingroup Eet_Data_Cipher_Group
4198 */ 4199 */
4199EAPI void * 4200EAPI void *
4200eet_data_descriptor_decode_cipher(Eet_Data_Descriptor *edd, 4201eet_data_descriptor_decode_cipher(Eet_Data_Descriptor *edd,
@@ -4203,9 +4204,10 @@ eet_data_descriptor_decode_cipher(Eet_Data_Descriptor *edd,
4203 int size_in); 4204 int size_in);
4204 4205
4205/** 4206/**
4206 * Encode a data struct to memory and return that encoded data 4207 * @ingroup Eet_Data_Cipher_Group
4208 * @brief Encodes a data struct to memory and return that encoded data
4207 * using a cipher. 4209 * using a cipher.
4208 * @param edd The data descriptor to use when encoding. 4210 * @param edd The data descriptor to use when encoding.
4209 * @param data_in The pointer to the struct to encode into data. 4211 * @param data_in The pointer to the struct to encode into data.
4210 * @param cipher_key The key to use as cipher. 4212 * @param cipher_key The key to use as cipher.
4211 * @param size_ret pointer to the an int to be filled with the decoded size. 4213 * @param size_ret pointer to the an int to be filled with the decoded size.
@@ -4231,7 +4233,6 @@ eet_data_descriptor_decode_cipher(Eet_Data_Descriptor *edd,
4231 * @see eet_data_descriptor_encode() 4233 * @see eet_data_descriptor_encode()
4232 * 4234 *
4233 * @since 1.0.0 4235 * @since 1.0.0
4234 * @ingroup Eet_Data_Cipher_Group
4235 */ 4236 */
4236EAPI void * 4237EAPI void *
4237eet_data_descriptor_encode_cipher(Eet_Data_Descriptor *edd, 4238eet_data_descriptor_encode_cipher(Eet_Data_Descriptor *edd,
@@ -4287,164 +4288,164 @@ struct _Eet_Node_Data
4287 */ 4288 */
4288 4289
4289/** 4290/**
4290 * Create a new character node. 4291 * @ingroup Eet_Node_Group
4292 * @brief Creates a new character node.
4291 * @param name Name of the node. 4293 * @param name Name of the node.
4292 * @param c Character value. 4294 * @param c Character value.
4293 * @return A new character node. 4295 * @return A new character node.
4294 * @ingroup Eet_Node_Group
4295 */ 4296 */
4296EAPI Eet_Node * 4297EAPI Eet_Node *
4297eet_node_char_new(const char *name, 4298eet_node_char_new(const char *name,
4298 char c); 4299 char c);
4299 4300
4300/** 4301/**
4301 * Create a new short node. 4302 * @ingroup Eet_Node_Group
4303 * @brief Creates a new short node.
4302 * @param name Name of the node. 4304 * @param name Name of the node.
4303 * @param s short value. 4305 * @param s Short value.
4304 * @return A new short node. 4306 * @return A new short node.
4305 * @ingroup Eet_Node_Group
4306 */ 4307 */
4307EAPI Eet_Node * 4308EAPI Eet_Node *
4308eet_node_short_new(const char *name, 4309eet_node_short_new(const char *name,
4309 short s); 4310 short s);
4310 4311
4311/** 4312/**
4312 * Create a new integer node. 4313 * @ingroup Eet_Node_Group
4314 * @brief Creates a new integer node.
4313 * @param name Name of the node. 4315 * @param name Name of the node.
4314 * @param i integer value. 4316 * @param i Integer value.
4315 * @return A new integer node. 4317 * @return A new integer node.
4316 * @ingroup Eet_Node_Group
4317 */ 4318 */
4318EAPI Eet_Node * 4319EAPI Eet_Node *
4319eet_node_int_new(const char *name, 4320eet_node_int_new(const char *name,
4320 int i); 4321 int i);
4321 4322
4322/** 4323/**
4323 * Create a new long long integer node. 4324 * @ingroup Eet_Node_Group
4325 * @brief Creates a new long long integer node.
4324 * @param name Name of the node. 4326 * @param name Name of the node.
4325 * @param l long long integer value. 4327 * @param l Long long integer value.
4326 * @return A new long long integer node. 4328 * @return A new long long integer node.
4327 * @ingroup Eet_Node_Group
4328 */ 4329 */
4329EAPI Eet_Node * 4330EAPI Eet_Node *
4330eet_node_long_long_new(const char *name, 4331eet_node_long_long_new(const char *name,
4331 long long l); 4332 long long l);
4332 4333
4333/** 4334/**
4334 * Create a new float node. 4335 * @ingroup Eet_Node_Group
4336 * @brief Creates a new float node.
4335 * @param name Name of the node. 4337 * @param name Name of the node.
4336 * @param f float value. 4338 * @param f Float value.
4337 * @return A new float node. 4339 * @return A new float node.
4338 * @ingroup Eet_Node_Group
4339 */ 4340 */
4340EAPI Eet_Node * 4341EAPI Eet_Node *
4341eet_node_float_new(const char *name, 4342eet_node_float_new(const char *name,
4342 float f); 4343 float f);
4343 4344
4344/** 4345/**
4345 * Create a new double node. 4346 * @ingroup Eet_Node_Group
4347 * @brief Creates a new double node.
4346 * @param name Name of the node. 4348 * @param name Name of the node.
4347 * @param d double value. 4349 * @param d Double value.
4348 * @return A new double node. 4350 * @return A new double node.
4349 * @ingroup Eet_Node_Group
4350 */ 4351 */
4351EAPI Eet_Node * 4352EAPI Eet_Node *
4352eet_node_double_new(const char *name, 4353eet_node_double_new(const char *name,
4353 double d); 4354 double d);
4354 4355
4355/** 4356/**
4356 * Create a new unsigned character node. 4357 * @ingroup Eet_Node_Group
4358 * @brief Creates a new unsigned character node.
4357 * @param name Name of the node. 4359 * @param name Name of the node.
4358 * @param uc unsigned char value. 4360 * @param uc Unsigned char value.
4359 * @return A new unsigned char node. 4361 * @return A new unsigned char node.
4360 * @ingroup Eet_Node_Group
4361 */ 4362 */
4362EAPI Eet_Node * 4363EAPI Eet_Node *
4363eet_node_unsigned_char_new(const char *name, 4364eet_node_unsigned_char_new(const char *name,
4364 unsigned char uc); 4365 unsigned char uc);
4365 4366
4366/** 4367/**
4367 * Create a new unsigned short node. 4368 * @ingroup Eet_Node_Group
4369 * @brief Creates a new unsigned short node.
4368 * @param name Name of the node. 4370 * @param name Name of the node.
4369 * @param us unsigned short value. 4371 * @param us Unsigned short value.
4370 * @return A new unsigned short node. 4372 * @return A new unsigned short node.
4371 * @ingroup Eet_Node_Group
4372 */ 4373 */
4373EAPI Eet_Node * 4374EAPI Eet_Node *
4374eet_node_unsigned_short_new(const char *name, 4375eet_node_unsigned_short_new(const char *name,
4375 unsigned short us); 4376 unsigned short us);
4376 4377
4377/** 4378/**
4378 * Create a new unsigned integer node. 4379 * @ingroup Eet_Node_Group
4380 * @brief Creates a new unsigned integer node.
4379 * @param name Name of the node. 4381 * @param name Name of the node.
4380 * @param ui unsigned integer value. 4382 * @param ui Unsigned integer value.
4381 * @return A new unsigned integer node. 4383 * @return A new unsigned integer node.
4382 * @ingroup Eet_Node_Group
4383 */ 4384 */
4384EAPI Eet_Node * 4385EAPI Eet_Node *
4385eet_node_unsigned_int_new(const char *name, 4386eet_node_unsigned_int_new(const char *name,
4386 unsigned int ui); 4387 unsigned int ui);
4387 4388
4388/** 4389/**
4389 * Create a new unsigned long long integer node. 4390 * @ingroup Eet_Node_Group
4391 * @brief Creates a new unsigned long long integer node.
4390 * @param name Name of the node. 4392 * @param name Name of the node.
4391 * @param l unsigned long long integer value. 4393 * @param l Unsigned long long integer value.
4392 * @return A new unsigned long long integer node. 4394 * @return A new unsigned long long integer node.
4393 * @ingroup Eet_Node_Group
4394 */ 4395 */
4395EAPI Eet_Node * 4396EAPI Eet_Node *
4396eet_node_unsigned_long_long_new(const char *name, 4397eet_node_unsigned_long_long_new(const char *name,
4397 unsigned long long l); 4398 unsigned long long l);
4398 4399
4399/** 4400/**
4400 * Create a new string node. 4401 * @ingroup Eet_Node_Group
4402 * @brief Creates a new string node.
4401 * @param name Name of the node. 4403 * @param name Name of the node.
4402 * @param str string value. 4404 * @param str String value.
4403 * @return A new string node. 4405 * @return A new string node.
4404 * @ingroup Eet_Node_Group
4405 */ 4406 */
4406EAPI Eet_Node * 4407EAPI Eet_Node *
4407eet_node_string_new(const char *name, 4408eet_node_string_new(const char *name,
4408 const char *str); 4409 const char *str);
4409 4410
4410/** 4411/**
4411 * Create a new inlined string node. 4412 * @ingroup Eet_Node_Group
4413 * @brief Creates a new inlined string node.
4412 * @param name Name of the node. 4414 * @param name Name of the node.
4413 * @param str string value. 4415 * @param str String value.
4414 * @return A new inlined string node. 4416 * @return A new inlined string node.
4415 * @ingroup Eet_Node_Group
4416 */ 4417 */
4417EAPI Eet_Node * 4418EAPI Eet_Node *
4418eet_node_inlined_string_new(const char *name, 4419eet_node_inlined_string_new(const char *name,
4419 const char *str); 4420 const char *str);
4420 4421
4421/** 4422/**
4422 * Create a new empty node. 4423 * @ingroup Eet_Node_Group
4424 * @brief Creates a new empty node.
4423 * @param name Name of the node. 4425 * @param name Name of the node.
4424 * @return A new empty node. 4426 * @return A new empty node.
4425 * @ingroup Eet_Node_Group
4426 */ 4427 */
4427EAPI Eet_Node * 4428EAPI Eet_Node *
4428eet_node_null_new(const char *name); 4429eet_node_null_new(const char *name);
4429 4430
4430/** 4431/**
4431 * Create a new list node. 4432 * @ingroup Eet_Node_Group
4433 * @brief Creates a new list node.
4432 * @param name Name of the node. 4434 * @param name Name of the node.
4433 * @param nodes list of nodes. 4435 * @param nodes List of nodes.
4434 * @return A new list node. 4436 * @return A new list node.
4435 * @ingroup Eet_Node_Group
4436 */ 4437 */
4437EAPI Eet_Node * 4438EAPI Eet_Node *
4438eet_node_list_new(const char *name, 4439eet_node_list_new(const char *name,
4439 Eina_List *nodes); 4440 Eina_List *nodes);
4440 4441
4441/** 4442/**
4442 * Create a new array node. 4443 * @ingroup Eet_Node_Group
4444 * @brief Creates a new array node.
4443 * @param name Name of the node. 4445 * @param name Name of the node.
4444 * @param count number of nodes 4446 * @param count Number of nodes
4445 * @param nodes list of nodes. 4447 * @param nodes List of nodes.
4446 * @return A new array node. 4448 * @return A new array node.
4447 * @ingroup Eet_Node_Group
4448 */ 4449 */
4449EAPI Eet_Node * 4450EAPI Eet_Node *
4450eet_node_array_new(const char *name, 4451eet_node_array_new(const char *name,
@@ -4452,11 +4453,11 @@ eet_node_array_new(const char *name,
4452 Eina_List *nodes); 4453 Eina_List *nodes);
4453 4454
4454/** 4455/**
4455 * Create a new variable array node. 4456 * @ingroup Eet_Node_Group
4457 * @brief Creates a new variable array node.
4456 * @param name Name of the node. 4458 * @param name Name of the node.
4457 * @param nodes list of nodes. 4459 * @param nodes List of nodes.
4458 * @return A new variable array node. 4460 * @return A new variable array node.
4459 * @ingroup Eet_Node_Group
4460 */ 4461 */
4461EAPI Eet_Node * 4462EAPI Eet_Node *
4462eet_node_var_array_new(const char *name, 4463eet_node_var_array_new(const char *name,
@@ -4467,11 +4468,11 @@ eet_node_var_array_new(const char *name,
4467 * @ingroup Eet_Node_Group 4468 * @ingroup Eet_Node_Group
4468 */ 4469 */
4469/** 4470/**
4470 * Create a new short node. 4471 * @ingroup Eet_Node_Group
4472 * @brief Creates a new short node.
4471 * @param name Name of the node. 4473 * @param name Name of the node.
4472 * @param s short value. 4474 * @param s Short value.
4473 * @return A new short node. 4475 * @return A new short node.
4474 * @ingroup Eet_Node_Group
4475 */ 4476 */
4476EAPI Eet_Node * 4477EAPI Eet_Node *
4477eet_node_hash_new(const char *name, 4478eet_node_hash_new(const char *name,
@@ -4479,11 +4480,11 @@ eet_node_hash_new(const char *name,
4479 Eet_Node *node); 4480 Eet_Node *node);
4480 4481
4481/** 4482/**
4482 * Create a new struct node. 4483 * @ingroup Eet_Node_Group
4484 * @brief Creates a new struct node.
4483 * @param name Name of the node. 4485 * @param name Name of the node.
4484 * @param nodes list of nodes. 4486 * @param nodes List of nodes.
4485 * @return A new struct node. 4487 * @return A new struct node.
4486 * @ingroup Eet_Node_Group
4487 */ 4488 */
4488EAPI Eet_Node * 4489EAPI Eet_Node *
4489eet_node_struct_new(const char *name, 4490eet_node_struct_new(const char *name,
@@ -4494,18 +4495,18 @@ eet_node_struct_new(const char *name,
4494 * @ingroup Eet_Node_Group 4495 * @ingroup Eet_Node_Group
4495 */ 4496 */
4496/** 4497/**
4497 * Create a new short node. 4498 * @ingroup Eet_Node_Group
4499 * @brief Creates a new short node.
4498 * @param name Name of the node. 4500 * @param name Name of the node.
4499 * @param s short value. 4501 * @param s Short value.
4500 * @return A new short node. 4502 * @return A new short node.
4501 * @ingroup Eet_Node_Group
4502 */ 4503 */
4503EAPI Eet_Node * 4504EAPI Eet_Node *
4504eet_node_struct_child_new(const char *parent, 4505eet_node_struct_child_new(const char *parent,
4505 Eet_Node *child); 4506 Eet_Node *child);
4506 4507
4507/** 4508/**
4508 * @brief Get a node's child nodes 4509 * @brief Gets a node's child nodes.
4509 * @param node The node 4510 * @param node The node
4510 * @return The first child node which contains a pointer to the 4511 * @return The first child node which contains a pointer to the
4511 * next child node and the parent. 4512 * next child node and the parent.
@@ -4515,7 +4516,7 @@ EAPI Eet_Node *
4515eet_node_children_get(Eet_Node *node); 4516eet_node_children_get(Eet_Node *node);
4516 4517
4517/** 4518/**
4518 * @brief Get the next node in a list of nodes 4519 * @brief Gets the next node in a list of nodes.
4519 * @param node The node 4520 * @param node The node
4520 * @return A node which contains a pointer to the 4521 * @return A node which contains a pointer to the
4521 * next child node and the parent. 4522 * next child node and the parent.
@@ -4525,7 +4526,7 @@ EAPI Eet_Node *
4525eet_node_next_get(Eet_Node *node); 4526eet_node_next_get(Eet_Node *node);
4526 4527
4527/** 4528/**
4528 * @brief Get the parent node of a node 4529 * @brief Gets the parent node of a node.
4529 * @param node The node 4530 * @param node The node
4530 * @return The parent node of @p node 4531 * @return The parent node of @p node
4531 * @since 1.5 4532 * @since 1.5
@@ -4534,8 +4535,8 @@ EAPI Eet_Node *
4534eet_node_parent_get(Eet_Node *node); 4535eet_node_parent_get(Eet_Node *node);
4535 4536
4536/** 4537/**
4537 * @brief Append a "list" node TODO FIX ME
4538 * @ingroup Eet_Node_Group 4538 * @ingroup Eet_Node_Group
4539 * @brief Appends a "list" node TODO FIX ME.
4539 */ 4540 */
4540EAPI void 4541EAPI void
4541eet_node_list_append(Eet_Node *parent, 4542eet_node_list_append(Eet_Node *parent,
@@ -4572,7 +4573,7 @@ eet_node_dump(Eet_Node *n,
4572 void *dumpdata); 4573 void *dumpdata);
4573 4574
4574/** 4575/**
4575 * @brief Return the type of a node 4576 * @brief Returns the type of a node.
4576 * @param node The node 4577 * @param node The node
4577 * @return The node's type (EET_T_$TYPE) 4578 * @return The node's type (EET_T_$TYPE)
4578 * @since 1.5 4579 * @since 1.5
@@ -4581,7 +4582,7 @@ EAPI int
4581eet_node_type_get(Eet_Node *node); 4582eet_node_type_get(Eet_Node *node);
4582 4583
4583/** 4584/**
4584 * @brief Return the node's data 4585 * @brief Returns the node's data.
4585 * @param node The node 4586 * @param node The node
4586 * @return The data contained in the node 4587 * @return The data contained in the node
4587 * @since 1.5 4588 * @since 1.5
@@ -4647,7 +4648,7 @@ typedef struct _Eet_Node_Walk Eet_Node_Walk;
4647 * 4648 *
4648 * Callback prototype for Eet_Node_Walk_Struct_Alloc 4649 * Callback prototype for Eet_Node_Walk_Struct_Alloc
4649 * @param type The allocation type 4650 * @param type The allocation type
4650 * @param user_data the data passed by the user to the callback 4651 * @param user_data The data passed by the user to the callback
4651 */ 4652 */
4652typedef void * (*Eet_Node_Walk_Struct_Alloc_Callback)(const char *type, void *user_data); 4653typedef void * (*Eet_Node_Walk_Struct_Alloc_Callback)(const char *type, void *user_data);
4653 4654
@@ -4656,9 +4657,9 @@ typedef void * (*Eet_Node_Walk_Struct_Alloc_Callback)(const char *t
4656 * 4657 *
4657 * Callback prototype for Eet_Node_Walk_Struct_Add 4658 * Callback prototype for Eet_Node_Walk_Struct_Add
4658 * @param parent The parent node 4659 * @param parent The parent node
4659 * @param name the name for the new node 4660 * @param name The name for the new node
4660 * @param child the child node 4661 * @param child The child node
4661 * @param user_data the data passed by the user to the callback 4662 * @param user_data The data passed by the user to the callback
4662 */ 4663 */
4663typedef void (*Eet_Node_Walk_Struct_Add_Callback)(void *parent, const char *name, void *child, void *user_data); 4664typedef void (*Eet_Node_Walk_Struct_Add_Callback)(void *parent, const char *name, void *child, void *user_data);
4664 4665
@@ -4666,10 +4667,10 @@ typedef void (*Eet_Node_Walk_Struct_Add_Callback)(void *parent, c
4666 * @typedef (*Eet_Node_Walk_Array_Callback) 4667 * @typedef (*Eet_Node_Walk_Array_Callback)
4667 * 4668 *
4668 * Callback prototype for Eet_Node_Walk_Array 4669 * Callback prototype for Eet_Node_Walk_Array
4669 * @param variable EINA_TRUE or EINA_FALSE 4670 * @param variable @c EINA_TRUE or @c EINA_FALSE
4670 * @param name a name 4671 * @param name A name
4671 * @param count a counter 4672 * @param count A counter
4672 * @param user_data the data passed by the user to the callback 4673 * @param user_data The data passed by the user to the callback
4673 */ 4674 */
4674typedef void * (*Eet_Node_Walk_Array_Callback)(Eina_Bool variable, const char *name, int count, void *user_data); 4675typedef void * (*Eet_Node_Walk_Array_Callback)(Eina_Bool variable, const char *name, int count, void *user_data);
4675 4676
@@ -4713,40 +4714,40 @@ eet_node_walk(void *parent,
4713 */ 4714 */
4714 4715
4715/** 4716/**
4717 * @ingroup Eet_Connection_Group
4716 * @typedef Eet_Connection 4718 * @typedef Eet_Connection
4717 * Opaque handle to track paquet for a specific connection. 4719 * Opaque handle to track paquet for a specific connection.
4718 * 4720 *
4719 * @ingroup Eet_Connection_Group
4720 */ 4721 */
4721typedef struct _Eet_Connection Eet_Connection; 4722typedef struct _Eet_Connection Eet_Connection;
4722 4723
4723/** 4724/**
4725 * @ingroup Eet_Connection_Group
4724 * @typedef Eet_Read_Cb 4726 * @typedef Eet_Read_Cb
4725 * Called back when an @ref Eet_Data_Group has been received completely and could be used. 4727 * Called back when an @ref Eet_Data_Group has been received completely and could be used.
4726 * 4728 *
4727 * @ingroup Eet_Connection_Group
4728 */ 4729 */
4729typedef Eina_Bool Eet_Read_Cb (const void *eet_data, size_t size, void *user_data); 4730typedef Eina_Bool Eet_Read_Cb (const void *eet_data, size_t size, void *user_data);
4730 4731
4731/** 4732/**
4733 * @ingroup Eet_Connection_Group
4732 * @typedef Eet_Write_Cb 4734 * @typedef Eet_Write_Cb
4733 * Called back when a packet containing @ref Eet_Data_Group data is ready to be send. 4735 * Called back when a packet containing @ref Eet_Data_Group data is ready to be send.
4734 * 4736 *
4735 * @ingroup Eet_Connection_Group
4736 */ 4737 */
4737typedef Eina_Bool Eet_Write_Cb (const void *data, size_t size, void *user_data); 4738typedef Eina_Bool Eet_Write_Cb (const void *data, size_t size, void *user_data);
4738 4739
4739/** 4740/**
4740 * Instanciate a new connection to track. 4741 * @ingroup Eet_Connection_Group
4742 * @brief Instanciates a new connection to track.
4741 * @param eet_read_cb Function to call when one Eet_Data packet has been fully assemble. 4743 * @param eet_read_cb Function to call when one Eet_Data packet has been fully assemble.
4742 * @param eet_write_cb Function to call when one Eet_Data packet is ready to be send over the wire. 4744 * @param eet_write_cb Function to call when one Eet_Data packet is ready to be send over the wire.
4743 * @param user_data Pointer provided to both functions to be used as a context handler. 4745 * @param user_data Pointer provided to both functions to be used as a context handler.
4744 * @return NULL on failure, or a valid Eet_Connection handler. 4746 * @return @c NULL on failure, or a valid Eet_Connection handler.
4745 * 4747 *
4746 * For every connection to track you will need a separate Eet_Connection provider. 4748 * For every connection to track you will need a separate Eet_Connection provider.
4747 * 4749 *
4748 * @since 1.2.4 4750 * @since 1.2.4
4749 * @ingroup Eet_Connection_Group
4750 */ 4751 */
4751EAPI Eet_Connection * 4752EAPI Eet_Connection *
4752eet_connection_new(Eet_Read_Cb *eet_read_cb, 4753eet_connection_new(Eet_Read_Cb *eet_read_cb,
@@ -4754,18 +4755,18 @@ eet_connection_new(Eet_Read_Cb *eet_read_cb,
4754 const void *user_data); 4755 const void *user_data);
4755 4756
4756/** 4757/**
4757 * Process a raw packet received over the link 4758 * @ingroup Eet_Connection_Group
4759 * @brief Processes a raw packet received over the link.
4758 * @param conn Connection handler to track. 4760 * @param conn Connection handler to track.
4759 * @param data Raw data packet. 4761 * @param data Raw data packet.
4760 * @param size The size of that packet. 4762 * @param size The size of that packet.
4761 * @return 0 on complete success, any other value indicate where in the stream it got wrong (It could be before that packet). 4763 * @return @c 0 on complete success, any other value indicate where in the stream it got wrong (It could be before that packet).
4762 * 4764 *
4763 * Every time you receive a packet related to your connection, you should pass 4765 * Every time you receive a packet related to your connection, you should pass
4764 * it to that function so that it could process and assemble packet has you 4766 * it to that function so that it could process and assemble packet has you
4765 * receive it. It will automatically call Eet_Read_Cb when one is fully received. 4767 * receive it. It will automatically call Eet_Read_Cb when one is fully received.
4766 * 4768 *
4767 * @since 1.2.4 4769 * @since 1.2.4
4768 * @ingroup Eet_Connection_Group
4769 */ 4770 */
4770EAPI int 4771EAPI int
4771eet_connection_received(Eet_Connection *conn, 4772eet_connection_received(Eet_Connection *conn,
@@ -4773,26 +4774,27 @@ eet_connection_received(Eet_Connection *conn,
4773 size_t size); 4774 size_t size);
4774 4775
4775/** 4776/**
4776 * Tell if the Eet_Connection as received some partial data. 4777 * @ingroup Eet_Connection_Group
4778 * @brief Tells if the Eet_Connection as received some partial data.
4777 * @param conn Connection handler to request. 4779 * @param conn Connection handler to request.
4778 * @return EINA_TRUE if there is some data pending inside, EINA_FALSE otherwise. 4780 * @return @c EINA_TRUE if there is some data pending inside, @c EINA_FALSE otherwise.
4779 * 4781 *
4780 * Eet_Connection buffer data until the received data can be unserialized correctly. This 4782 * Eet_Connection buffer data until the received data can be unserialized correctly. This
4781 * function let you know if there is some data inside that buffer waiting for more data to 4783 * function let you know if there is some data inside that buffer waiting for more data to
4782 * be received before being processed. 4784 * be received before being processed.
4783 * 4785 *
4784 * @since 1.7 4786 * @since 1.7
4785 * @ingroup Eet_Connection_Group
4786 */ 4787 */
4787EAPI Eina_Bool eet_connection_empty(Eet_Connection *conn); 4788EAPI Eina_Bool eet_connection_empty(Eet_Connection *conn);
4788 4789
4789/** 4790/**
4790 * Convert a complex structure and prepare it to be send. 4791 * @ingroup Eet_Connection_Group
4792 * @brief Converts a complex structure and prepare it to be send.
4791 * @param conn Connection handler to track. 4793 * @param conn Connection handler to track.
4792 * @param edd The data descriptor to use when encoding. 4794 * @param edd The data descriptor to use when encoding.
4793 * @param data_in The pointer to the struct to encode into data. 4795 * @param data_in The pointer to the struct to encode into data.
4794 * @param cipher_key The key to use as cipher. 4796 * @param cipher_key The key to use as cipher.
4795 * @return EINA_TRUE if the data where correctly send, EINA_FALSE if they don't. 4797 * @return @c EINA_TRUE if the data where correctly send, @c EINA_FALSE if they don't.
4796 * 4798 *
4797 * This function serialize data_in with edd, assemble the packet and call 4799 * This function serialize data_in with edd, assemble the packet and call
4798 * Eet_Write_Cb when ready. The data passed Eet_Write_Cb are temporary allocated 4800 * Eet_Write_Cb when ready. The data passed Eet_Write_Cb are temporary allocated
@@ -4801,7 +4803,6 @@ EAPI Eina_Bool eet_connection_empty(Eet_Connection *conn);
4801 * @see eet_data_descriptor_encode_cipher 4803 * @see eet_data_descriptor_encode_cipher
4802 * 4804 *
4803 * @since 1.2.4 4805 * @since 1.2.4
4804 * @ingroup Eet_Connection_Group
4805 */ 4806 */
4806EAPI Eina_Bool 4807EAPI Eina_Bool
4807eet_connection_send(Eet_Connection *conn, 4808eet_connection_send(Eet_Connection *conn,
@@ -4810,11 +4811,12 @@ eet_connection_send(Eet_Connection *conn,
4810 const char *cipher_key); 4811 const char *cipher_key);
4811 4812
4812/** 4813/**
4813 * Convert a Eet_Node tree and prepare it to be send. 4814 * @ingroup Eet_Connection_Group
4815 * @brief Converts a Eet_Node tree and prepare it to be send.
4814 * @param conn Connection handler to track. 4816 * @param conn Connection handler to track.
4815 * @param node The data tree to use when encoding. 4817 * @param node The data tree to use when encoding.
4816 * @param cipher_key The key to use as cipher. 4818 * @param cipher_key The key to use as cipher.
4817 * @return EINA_TRUE if the data where correctly send, EINA_FALSE if they don't. 4819 * @return @c EINA_TRUE if the data where correctly send, @c EINA_FALSE if they don't.
4818 * 4820 *
4819 * This function serialize node, assemble the packet and call 4821 * This function serialize node, assemble the packet and call
4820 * Eet_Write_Cb when ready. The data passed Eet_Write_Cb are temporary allocated 4822 * Eet_Write_Cb when ready. The data passed Eet_Write_Cb are temporary allocated
@@ -4823,7 +4825,6 @@ eet_connection_send(Eet_Connection *conn,
4823 * @see eet_data_node_encode_cipher 4825 * @see eet_data_node_encode_cipher
4824 * 4826 *
4825 * @since 1.2.4 4827 * @since 1.2.4
4826 * @ingroup Eet_Connection_Group
4827 */ 4828 */
4828EAPI Eina_Bool 4829EAPI Eina_Bool
4829eet_connection_node_send(Eet_Connection *conn, 4830eet_connection_node_send(Eet_Connection *conn,
@@ -4831,13 +4832,13 @@ eet_connection_node_send(Eet_Connection *conn,
4831 const char *cipher_key); 4832 const char *cipher_key);
4832 4833
4833/** 4834/**
4834 * Close a connection and lost its track. 4835 * @ingroup Eet_Connection_Group
4836 * @brief Closes a connection and lost its track.
4835 * @param conn Connection handler to close. 4837 * @param conn Connection handler to close.
4836 * @param on_going Signal if a partial packet wasn't completed. 4838 * @param on_going Signal if a partial packet wasn't completed.
4837 * @return the user_data passed to both callback. 4839 * @return the user_data passed to both callback.
4838 * 4840 *
4839 * @since 1.2.4 4841 * @since 1.2.4
4840 * @ingroup Eet_Connection_Group
4841 */ 4842 */
4842EAPI void * 4843EAPI void *
4843eet_connection_close(Eet_Connection *conn, 4844eet_connection_close(Eet_Connection *conn,