Tizen Native API  5.5

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 void *(* Eina_Process_Cb )(const void *container, void *data, void *fdata)
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 function has no effect except the return value and its 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_FALLTHROUGH
 Attribute from gcc to prevent warning and indicate that we expect to actually go to the next switch statement.
#define EINA_PREFETCH(arg)
 Hints that the pointer needs to be pre-fetched into cache.
#define EINA_PREFETCH_WRITE(arg)
 Hints that the pointer needs to be pre-fetched into cache.
#define EINA_PREFETCH_NOCACHE(arg)
 Hints that the pointer needs to be pre-fetched into cache.
#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_PROCESS_CB(Function)   ((Eina_Process_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 EINA_DOUBLE_EQUAL(x, y)   (fabs((x) - (y)) <= (2.2204460492503131e-16) * fabs((x)))

Define Documentation

#define EINA_ARG_NONNULL (   ...)

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

Parameters:
[in]...Ordinals 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_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_DOUBLE_EQUAL (   x,
 
)    (fabs((x) - (y)) <= (2.2204460492503131e-16) * fabs((x)))

Macro to compare 2 double floating point values and deal with precision loss issues.

Since (EFL) :
1.18
#define EINA_EACH_CB (   Function)    ((Eina_Each_Cb)Function)

Macro to cast to Eina_Each.

Attribute from gcc to prevent warning and indicate that we expect to actually go to the next switch statement.

Since (EFL) :
1.20
#define EINA_FORMAT (   fmt)
Parameters:
[in]fmtThe 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:
[in]expThe expression to be used.
#define EINA_PREFETCH (   arg)

Hints that the pointer needs to be pre-fetched into cache.

This hints to the compiler to probably issue a prefetch command for the memory address arg and ensure it goes into all levels of cache. For just writing to an address look at EINA_PREFETCH_WRITE().

Note that the pointer arg does not have to be a valid pointer and will not cause any exceptions (like segfaults) if it is invalid.

Since (EFL) :
1.19
#define EINA_PREFETCH_NOCACHE (   arg)

Hints that the pointer needs to be pre-fetched into cache.

This hints to the compiler to probably issue a prefetch command for the memory address arg and ensure it goes into just the closest(l1) cache. For just writing to an address look at EINA_PREFETCH_WRITE_NOCACHE().

Note that the pointer arg does not have to be a valid pointer and will not cause any exceptions (like segfaults) if it is invalid.

Since (EFL) :
1.19
#define EINA_PREFETCH_WRITE (   arg)

Hints that the pointer needs to be pre-fetched into cache.

This hints to the compiler to probably issue a prefetch command for the memory address arg and ensure it goes into all levels of cache. This specifically indicates that the address is going to be written to as opposed to being read from as with EINA_PREFETCH().

Note that the pointer arg does not have to be a valid pointer and will not cause any exceptions (like segfaults) if it is invalid.

Since (EFL) :
1.19
#define EINA_PRINTF (   fmt,
  arg 
)
Parameters:
[in]fmtThe format to be used.
[in]argThe argument to be used.
#define EINA_PROCESS_CB (   Function)    ((Eina_Process_Cb)Function)

Macro to cast to Eina_Process.

#define EINA_RANDOM_CB (   function)    ((Eina_Random_Cb)function)

Macro to cast to Eina_Random_Cb.

#define EINA_SCANF (   fmt,
  arg 
)
Parameters:
[in]fmtThe format to be used.
[in]argThe 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
#define EINA_TRUE   ((Eina_Bool)1)

boolean value TRUE (numerical value 1)

Examples:
actionslider_example_01.c, bg_example_01.c, bg_example_02.c, bg_example_03.c, box_example_02.c, bubble_example_01.c, button_example_00.c, button_example_01.c, calendar_example_01.c, calendar_example_02.c, calendar_example_03.c, calendar_example_04.c, calendar_example_05.c, calendar_example_06.c, check_example_01.c, clock_example.c, codegen_example.c, colorselector_example_01.c, combobox_example_01.c, conformant_example_01.c, conformant_example_02.c, ctxpopup_example_01.c, datetime_example.c, dayselector_example.c, diskselector_example_01.c, diskselector_example_02.c, 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_fd_handler_gnutls_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, efl_thread_5.c, efl_thread_6.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_iterator_01.c, eina_simple_xml_parser_01.c, eina_tiler_01.c, eina_value_03.c, entry_example.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-text.c, fileselector_button_example.c, fileselector_entry_example.c, fileselector_example.c, flip_example_01.c, flipselector_example.c, frame_example_01.c, general_funcs_example.c, gengrid_example.c, genlist_example_01.c, genlist_example_02.c, genlist_example_03.c, genlist_example_04.c, genlist_example_05.c, glview_example_01.c, hover_example_01.c, hoversel_example_01.c, icon_example_01.c, image_example_01.c, index_example_01.c, index_example_02.c, inwin_example.c, label_example_01.c, layout_example_01.c, layout_example_02.c, layout_example_03.c, list_example_01.c, list_example_02.c, list_example_03.c, map_example_01.c, map_example_02.c, map_example_03.c, mapbuf_example.c, menu_cxx_example_01.cc, menu_example_01.c, naviframe_example.c, notify_example_01.c, panel_example_01.c, panes_example.c, photocam_example_01.c, popup_example_01.c, popup_example_02.c, popup_example_03.c, prefs_data_example.c, prefs_example_01.c, prefs_example_02.c, prefs_example_03.c, progressbar_example.c, radio_example_01.c, scroller_example_01.c, segment_control_example.c, separator_example_01.c, slider_example.c, slideshow_example.c, spinner_example.c, table_example_01.c, table_example_02.c, theme_example_01.c, theme_example_02.c, thumb_example_01.c, toolbar_example_01.c, toolbar_example_02.c, toolbar_example_03.c, track_example_01.c, transit_example_01.c, transit_example_02.c, transit_example_03.c, transit_example_04.c, web_example_02.c, and win_example.c.
#define EINA_UNLIKELY (   exp)    exp
Parameters:
[in]expThe expression to be used.
#define EINA_UNUSED

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

Examples:
actionslider_example_01.c, bg_cxx_example_01.cc, bg_cxx_example_02.cc, bg_example_01.c, bg_example_02.c, bg_example_03.c, box_example_02.c, bubble_example_01.c, button_cxx_example_00.cc, button_cxx_example_01.cc, button_example_00.c, button_example_01.c, calendar_cxx_example_01.cc, calendar_cxx_example_02.cc, calendar_cxx_example_03.cc, calendar_cxx_example_04.cc, calendar_cxx_example_05.cc, calendar_example_01.c, calendar_example_02.c, calendar_example_03.c, calendar_example_04.c, calendar_example_05.c, calendar_example_06.c, check_example_01.c, clock_cxx_example.cc, clock_example.c, codegen_example.c, colorselector_example_01.c, combobox_example_01.c, conformant_example_01.c, conformant_example_02.c, ctxpopup_example_01.c, datetime_example.c, dayselector_example.c, diskselector_example_01.c, diskselector_example_02.c, 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, efl_thread_1.c, efl_thread_2.c, efl_thread_3.c, efl_thread_4.c, efl_thread_5.c, efl_thread_6.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, entry_example.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, evas-text.c, fileselector_button_example.c, fileselector_entry_example.c, fileselector_example.c, flip_example_01.c, flipselector_example.c, frame_example_01.c, general_funcs_example.c, gengrid_example.c, genlist_example_01.c, genlist_example_02.c, genlist_example_03.c, genlist_example_04.c, genlist_example_05.c, glview_example_01.c, hover_example_01.c, hoversel_example_01.c, icon_cxx_example_01.cc, icon_example_01.c, image_example_01.c, index_example_01.c, index_example_02.c, inwin_example.c, label_example_01.c, layout_example_01.c, layout_example_02.c, layout_example_03.c, list_example_01.c, list_example_02.c, list_example_03.c, map_example_01.c, map_example_02.c, map_example_03.c, mapbuf_example.c, menu_cxx_example_01.cc, menu_example_01.c, naviframe_example.c, notify_example_01.c, panel_example_01.c, panes_example.c, photocam_example_01.c, popup_example_01.c, popup_example_02.c, popup_example_03.c, prefs_example_01.c, prefs_example_02.c, prefs_example_03.c, progressbar_example.c, radio_cxx_example_01.cc, radio_example_01.c, scroller_example_01.c, segment_control_example.c, separator_example_01.c, slider_cxx_example.cc, slider_example.c, slideshow_example.c, spinner_cxx_example.cc, spinner_example.c, table_cxx_example_01.cc, table_cxx_example_02.cc, table_example_01.c, table_example_02.c, theme_example_01.c, theme_example_02.c, thumb_example_01.c, toolbar_example_01.c, toolbar_example_02.c, toolbar_example_03.c, track_example_01.c, transit_example_01.c, transit_example_02.c, transit_example_03.c, transit_example_04.c, web_example_02.c, and win_example.c.

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


Typedef Documentation

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.

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.

A callback type used when iterating over a container.

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

Method that processes some data and returns new data. It's meant to be used as a callback to process all nodes inside a container (See eina_iterator_processed_new, for example.)

Parameters:
dataThe data to process.
fdataContext data.
Returns:
The processed data.

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

Since (EFL) :
1.8

Variable Documentation

const unsigned int eina_prime_table[]
Since :
3.0f(2.3.1)