Macros | Typedefs | Variables
Types

Macros

#define EAPI
 Used to export functions (by changing visibility).
 
#define EAPI_WEAK
 
#define EWAPI   EAPI EAPI_WEAK
 
#define EXPORTAPI
 
#define __WORDSIZE   64
 
#define EINA_UNUSED
 Used to warn when an argument of the function is not used.
 
#define EINA_WARN_UNUSED_RESULT
 Used to warn when the returned value of the function is not used.
 
#define EINA_ARG_NONNULL(...)
 Used to warn when the specified arguments of the function are NULL. More...
 
#define EINA_DEPRECATED
 Used to warn when the function is considered as 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. More...
 
#define EINA_FALLTHROUGH
 Attribute from gcc to prevent warning and indicate that we expect to actually go to the next switch statement. More...
 
#define EINA_PREFETCH(arg)
 Hints that the pointer needs to be pre-fetched into cache. More...
 
#define EINA_PREFETCH_WRITE(arg)
 Hints that the pointer needs to be pre-fetched into cache. More...
 
#define EINA_PREFETCH_NOCACHE(arg)
 Hints that the pointer needs to be pre-fetched into cache. More...
 
#define EINA_PREFETCH_NOCACHE_WRITE(arg)
 
#define EINA_FALSE   ((Eina_Bool)0)
 boolean value FALSE (numerical value 0)
 
#define EINA_TRUE   ((Eina_Bool)1)
 boolean value TRUE (numerical value 1)
 
#define EINA_COMPARE_CB(function)   ((Eina_Compare_Cb)function)
 Macro to cast to Eina_Compare_Cb.
 
#define EINA_RANDOM_CB(function)   ((Eina_Random_Cb)function)
 Macro to cast to Eina_Random_Cb.
 
#define EINA_EACH_CB(Function)   ((Eina_Each_Cb)Function)
 Macro to cast to Eina_Each.
 
#define EINA_FREE_CB(Function)   ((Eina_Free_Cb)Function)
 Macro to cast to Eina_Free_Cb.
 
#define EINA_C_ARRAY_LENGTH(arr)   (sizeof(arr) / sizeof((arr)[0]))
 Macro to return the array length of a standard c array. More...
 
#define EINA_DOUBLE_EQUAL(x, y)   (fabs((x) - (y)) <= (2.2204460492503131e-16) * fabs((x)))
 Macro to compare 2 double floating point values and deal with precision loss issues. More...
 

Typedefs

typedef unsigned char Eina_Bool
 Type to mimic a boolean. More...
 
typedef int(* Eina_Compare_Cb) (const void *data1, const void *data2)
 Function used in functions using sorting. More...
 
typedef int(* Eina_Random_Cb) (const int min, const int max)
 Function used in shuffling functions. More...
 
typedef Eina_Bool(* Eina_Each_Cb) (const void *container, void *data, void *fdata)
 A callback type used when iterating over a container.
 
typedef void(* Eina_Free_Cb) (void *data)
 A callback type used to free data when iterating over a container.
 

Variables

const unsigned int eina_prime_table []
 

Detailed Description

Macro Definition Documentation

◆ EINA_ARG_NONNULL

#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

◆ EINA_PRINTF

#define EINA_PRINTF (   fmt,
  arg 
)
Parameters
[in]fmtThe format to be used.
[in]argThe argument to be used.

◆ EINA_SCANF

#define EINA_SCANF (   fmt,
  arg 
)
Parameters
[in]fmtThe format to be used.
[in]argThe argument to be used.

◆ EINA_FORMAT

#define EINA_FORMAT (   fmt)
Parameters
[in]fmtThe format to be used.

◆ EINA_UNLIKELY

#define EINA_UNLIKELY (   exp)    exp

◆ EINA_LIKELY

#define EINA_LIKELY (   exp)    exp

◆ EINA_SENTINEL

#define EINA_SENTINEL

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

Since
1.7

◆ EINA_FALLTHROUGH

#define EINA_FALLTHROUGH

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

Since
1.20

Referenced by edje_edit_part_source_set(), and eet_node_del().

◆ EINA_PREFETCH

#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
1.19

◆ EINA_PREFETCH_WRITE

#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
1.19

◆ EINA_PREFETCH_NOCACHE

#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
1.19

◆ EINA_C_ARRAY_LENGTH

#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
1.2.0
Examples:
complex-types-server.c, eina_value_02.c, and ephysics_logo.c.

◆ EINA_DOUBLE_EQUAL

#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
1.18

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

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_Random_Cb

Eina_Random_Cb

Function used in shuffling functions.

An integer between min and max inclusive must be returned.

Since
1.8