Tizen Native API
Typedefs | Defines
Types
Core

This provides fundamental types and macros, etc.

Typedefs

typedef unsigned char Eina_Bool
 The boolean type to mimic a boolean.
typedef int(* Eina_Compare_Cb )(const void *data1, const void *data2)
 The integer type used in functions that use 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.
typedef Eina_Bool(* Eina_Each_Cb )(const void *container, void *data, void *fdata)
 The boolean type used when iterating over a container.
typedef void(* Eina_Free_Cb )(void *data)
 The boolean type used to free data when iterating over a container.

Defines

#define EAPI
 Definition used to export functions(by changing visibility).
#define EINA_WARN_UNUSED_RESULT
 Definition used to warn when the returned value of the function is not used.
#define EINA_ARG_NONNULL(...)
 Definition used to warn when the specified arguments of the function are NULL.
#define EINA_DEPRECATED
 Definition used to warn when the function is considered as deprecated.
#define EINA_MALLOC
 Definition 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
 Definition used to tell the compiler that this function has no effect except that the return value depends only on the parameters and/or global variables.
#define EINA_PRINTF(fmt, arg)
 Write formatted string to the standard output.
#define EINA_SCANF(fmt, arg)
 Read formatted string from stdin.
#define EINA_FORMAT(fmt)
 Assign printf-like or scanf-like characteristics.
#define EINA_CONST
 Definition of the attribute from gcc to prevent the function to read/modify any global memory.
#define EINA_NOINSTRUMENT
 Definition of the attribute from gcc to disable instrumentation for a specific function.
#define EINA_UNLIKELY(exp)   exp
 Give branch prediction information.
#define EINA_LIKELY(exp)   exp
 Give branch prediction information.
#define EINA_SENTINEL
 Definition of the attribute from gcc to prevent calls without the necessary NULL sentinel in certain variadic functions.
#define EINA_FALSE   ((Eina_Bool)0)
 Definition of the boolean value FALSE (numerical value 0).
#define EINA_TRUE   ((Eina_Bool)1)
 Definition of the boolean value TRUE (numerical value 1).
#define EINA_COMPARE_CB(function)   ((Eina_Compare_Cb)function)
 Definition of the macro to cast to Eina_Compare_Cb.
#define EINA_EACH_CB(Function)   ((Eina_Each_Cb)Function)
 Definition of the macro to cast to Eina_Each.
#define EINA_FREE_CB(Function)   ((Eina_Free_Cb)Function)
 Definition of the macro to cast to Eina_Free_Cb.
#define EINA_C_ARRAY_LENGTH(arr)   (sizeof(arr) / sizeof((arr)[0]))
 Definition of the macro to return the array length of a standard C array.

Define Documentation

#define EINA_C_ARRAY_LENGTH (   arr)    (sizeof(arr) / sizeof((arr)[0]))

Definition of the 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
Since :
2.3.1
#define EINA_COMPARE_CB (   function)    ((Eina_Compare_Cb)function)

Definition of the macro to cast to Eina_Compare_Cb.

Since :
2.3.1
#define EINA_EACH_CB (   Function)    ((Eina_Each_Cb)Function)

Definition of the macro to cast to Eina_Each.

Since :
2.3.1
#define EINA_FALSE   ((Eina_Bool)0)

Definition of the boolean value FALSE (numerical value 0).

Since :
2.3.1
#define EINA_FORMAT (   fmt)

Assign printf-like or scanf-like characteristics.

Parameters:
fmtThe format to be used
#define EINA_FREE_CB (   Function)    ((Eina_Free_Cb)Function)

Definition of the macro to cast to Eina_Free_Cb.

Since :
2.3.1
#define EINA_LIKELY (   exp)    exp

Give branch prediction information.

Parameters:
expThe expression to be used
#define EINA_PRINTF (   fmt,
  arg 
)

Write formatted string to the standard output.

Parameters:
fmtThe format to be used
argThe argument to be used
#define EINA_SCANF (   fmt,
  arg 
)

Read formatted string from stdin.

Parameters:
fmtThe format to be used
argThe argument to be used
#define EINA_SENTINEL

Definition of the 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)

Definition of the boolean value TRUE (numerical value 1).

Since :
2.3.1
#define EINA_UNLIKELY (   exp)    exp

Give branch prediction information.

Parameters:
expThe expression to be used

Typedef Documentation

Eina_Bool

The boolean type to mimic a boolean.

Since :
2.3.1
Remarks:
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

The integer type used in functions that use 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.

Since :
2.3.1
Eina_Each_Cb

The boolean type used when iterating over a container.

Since :
2.3.1
Eina_Free_Cb

The boolean type used to free data when iterating over a container.

Since :
2.3.1