Types

Typedefs
typedef unsigned char	Eina_Bool
typedef int(*	Eina_Compare_Cb )(const void *data1, const void *data2)
typedef int(*	Eina_Random_Cb )(const int min, const int max)
typedef Eina_Bool(*	Eina_Each_Cb )(const void *container, void *data, void *fdata)
typedef void(*	Eina_Free_Cb )(void *data)
Defines
#define	EAPI
	Used to export functions(by changing visibility).
#define	EINA_UNUSED
#define	EINA_WARN_UNUSED_RESULT
#define	EINA_ARG_NONNULL(...)
#define	EINA_DEPRECATED
#define	EINA_MALLOC
	EINA_MALLOC is used to tell the compiler that a function may be treated as if any non-NULL pointer it returns cannot alias any other pointer valid when the function returns and that the memory has undefined content.
#define	EINA_PURE
	EINA_PURE is used to tell the compiler this functions has no effects except the return value and their return value depends only on the parameters and/or global variables.
#define	EINA_PRINTF(fmt, arg)
#define	EINA_SCANF(fmt, arg)
#define	EINA_FORMAT(fmt)
#define	EINA_CONST
	Attribute from gcc to prevent the function to read/modify any global memory.
#define	EINA_NOINSTRUMENT
	Attribute from gcc to disable instrumentation for a specific function.
#define	EINA_UNLIKELY(exp)   exp
#define	EINA_LIKELY(exp)   exp
#define	EINA_SENTINEL
	Attribute from gcc to prevent calls without the necessary NULL sentinel in certain variadic functions.
#define	EINA_FALSE   ((Eina_Bool)0)
#define	EINA_TRUE   ((Eina_Bool)1)
#define	EINA_COMPARE_CB(function)   ((Eina_Compare_Cb)function)
#define	EINA_RANDOM_CB(function)   ((Eina_Random_Cb)function)
#define	EINA_EACH_CB(Function)   ((Eina_Each_Cb)Function)
#define	EINA_FREE_CB(Function)   ((Eina_Free_Cb)Function)
#define	EINA_C_ARRAY_LENGTH(arr)   (sizeof(arr) / sizeof((arr)[0]))

---

Define Documentation

#define EINA_ARG_NONNULL

(

...

)

Used to warn when the specified arguments of the function are NULL.

Parameters:

...	Oridnals of the parameters to check for nullity (1..n)

Returns:

Nothing, but Doxygen will complain if it's not documented :-P

#define EINA_C_ARRAY_LENGTH

(

arr

)

(sizeof(arr) / sizeof((arr)[0]))

Macro to return the array length of a standard c array. For example: int foo[] = { 0, 1, 2, 3 }; would return 4 and not 4 * sizeof(int).

Since (EFL) :

1.2.0

Examples:

eina_model_03.c, and eina_value_02.c.

#define EINA_COMPARE_CB

(

function

)

((Eina_Compare_Cb)function)

Macro to cast to Eina_Compare_Cb.

#define EINA_DEPRECATED

Used to warn when the function is considered as deprecated.

#define EINA_EACH_CB

(

Function

)

((Eina_Each_Cb)Function)

Macro to cast to Eina_Each.

#define EINA_FALSE   ((Eina_Bool)0)

boolean value FALSE (numerical value 0)

Examples:

ecore_con_url_headers_example.c, ecore_evas_object_example.c, ecore_evas_window_sizes_example.c, ecore_imf_example.c, ecore_thread_example.c, ecore_time_functions_example.c, edje-box.c, edje-color-class.c, edje-perspective.c, eina_array_02.c, eina_file_01.c, eina_model_03.c, eina_model_04_animal.c, eina_model_04_child.c, eina_model_04_human.c, eina_model_04_parrot.c, eina_simple_xml_parser_01.c, eina_tiler_01.c, eina_value_03.c, evas-events.c, and evas-map-utils.c.

#define EINA_FORMAT

(

fmt

)

Parameters:

fmt	The format to be used.

#define EINA_FREE_CB

(

Function

)

((Eina_Free_Cb)Function)

Macro to cast to Eina_Free_Cb.

#define EINA_LIKELY

(

exp

)

exp

Parameters:

exp	The expression to be used.

#define EINA_PRINTF	(		fmt,
			arg
	)

Parameters:

fmt	The format to be used.
arg	The argument to be used.

#define EINA_RANDOM_CB

(

function

)

((Eina_Random_Cb)function)

Macro to cast to Eina_Random_Cb.

#define EINA_SCANF	(		fmt,
			arg
	)

Parameters:

fmt	The format to be used.
arg	The argument to be used.

#define EINA_SENTINEL

Attribute from gcc to prevent calls without the necessary NULL sentinel in certain variadic functions.

Since (EFL) :

1.7.0

#define EINA_TRUE   ((Eina_Bool)1)

boolean value TRUE (numerical value 1)

Examples:

ecore_con_url_cookies_example.c, ecore_con_url_download_example.c, ecore_con_url_headers_example.c, ecore_evas_buffer_example_02.c, ecore_evas_window_sizes_example.c, ecore_exe_example.c, ecore_imf_example.c, ecore_pipe_gstreamer_example.c, ecore_poller_example.c, ecore_thread_example.c, edje-basic.c, edje-box.c, edje-color-class.c, edje-drag.c, edje-perspective.c, edje-signals-messages.c, edje-table.c, edje-text.c, eina_array_01.c, eina_array_02.c, eina_hash_01.c, eina_hash_02.c, eina_hash_03.c, eina_hash_04.c, eina_hash_05.c, eina_hash_06.c, eina_hash_07.c, eina_hash_08.c, eina_iterator_01.c, eina_model_03.c, eina_model_04_animal.c, eina_model_04_child.c, eina_model_04_human.c, eina_model_04_parrot.c, eina_simple_xml_parser_01.c, eina_tiler_01.c, eina_value_03.c, evas-aspect-hints.c, evas-box.c, evas-events.c, evas-hints.c, evas-images.c, evas-images2.c, evas-map-utils.c, evas-object-manipulation.c, evas-smart-interface.c, evas-smart-object.c, evas-stacking.c, and evas-text.c.

#define EINA_UNLIKELY

(

exp

)

exp

Parameters:

exp	The expression to be used.

#define EINA_UNUSED

Used to warn when an argument of the function is not used.

Examples:

ecore_con_client_simple_example.c, ecore_con_lookup_example.c, ecore_con_server_simple_example.c, ecore_con_url_cookies_example.c, ecore_con_url_download_example.c, ecore_con_url_headers_example.c, ecore_evas_basics_example.c, ecore_evas_buffer_example_02.c, ecore_evas_callbacks.c, ecore_evas_object_example.c, ecore_evas_window_sizes_example.c, ecore_event_example_01.c, ecore_event_example_02.c, ecore_exe_example.c, ecore_exe_example_child.c, ecore_fd_handler_example.c, ecore_idler_example.c, ecore_imf_example.c, ecore_job_example.c, ecore_pipe_gstreamer_example.c, ecore_pipe_simple_example.c, ecore_poller_example.c, ecore_thread_example.c, ecore_time_functions_example.c, ecore_timer_example.c, edje-basic.c, edje-box.c, edje-box2.c, edje-color-class.c, edje-drag.c, edje-perspective.c, edje-signals-messages.c, edje-swallow.c, edje-table.c, edje-text.c, eina_accessor_01.c, eina_array_01.c, eina_array_02.c, eina_file_01.c, eina_hash_01.c, eina_hash_02.c, eina_hash_03.c, eina_hash_04.c, eina_hash_05.c, eina_hash_06.c, eina_hash_07.c, eina_hash_08.c, eina_inarray_01.c, eina_inarray_02.c, eina_inarray_03.c, eina_iterator_01.c, eina_log_03.c, eina_magic_01.c, eina_simple_xml_parser_01.c, eina_str_01.c, eina_strbuf_01.c, eina_stringshare_01.c, eina_tiler_01.c, eina_value_03.c, evas-aspect-hints.c, evas-box.c, evas-events.c, evas-hints.c, evas-images.c, evas-images2.c, evas-map-utils.c, evas-object-manipulation.c, evas-smart-interface.c, evas-smart-object.c, evas-stacking.c, evas-table.c, and evas-text.c.

#define EINA_WARN_UNUSED_RESULT

Used to warn when the returned value of the function is not used.

---

Typedef Documentation

Eina_Bool

Type to mimic a boolean.

Note:

it differs from stdbool.h as this is defined as an unsigned char to make it usable by bitfields (Eina_Bool name:1) and also take as few bytes as possible.

Eina_Compare_Cb

Function used in functions using sorting. It compares data1 and data2. If data1 is 'less' than data2, -1 must be returned, if it is 'greater', 1 must be returned, and if they are equal, 0 must be returned.

Examples:

eina_list_02.c.

Eina_Each_Cb

A callback type used when iterating over a container.

Eina_Free_Cb

A callback type used to free data when iterating over a container.

Eina_Random_Cb

Function used in shuffling functions. An integer between min and max inclusive must be returned.

Since (EFL) :

1.8