Tizen Native API
Functions | Typedefs | Defines
Trash
Containers

This group provides a generic container.

Functions

static void eina_trash_init (Eina_Trash **trash)
 Initialize a trash before using it.
static void eina_trash_push (Eina_Trash **trash, void *data)
 Push an unused pointer in the trash instead of freeing it.
static void * eina_trash_pop (Eina_Trash **trash)
 Pop an available pointer from the trash if possible.

Typedefs

typedef struct _Eina_Trash Eina_Trash
 The structure type for a generic container of an unused allocated pointer.

Defines

#define EINA_TRASH_CLEAN(trash, data)   while ((data = eina_trash_pop(trash)))
 Definition of a macro to remove all the pointers from the trash.

Define Documentation

#define EINA_TRASH_CLEAN (   trash,
  data 
)    while ((data = eina_trash_pop(trash)))

Definition of a macro to remove all the pointers from the trash.

This macro allows the cleaning of trash in an easy way. It removes all the pointers from trash until it's empty.

Since :
2.3.1
Remarks:
This macro can be used for freeing the data in the trash, like in the following example:
 Eina_Trash *trash = NULL;
 char *data;

 // trash is filled with a pointer to some duped strings.

 EINA_TRASH_CLEAN(&trash, data)
   free(data);
Remarks:
This macro is useful when you implement some memory pool.
Parameters:
trashThe trash to clean
dataThe pointer extracted from the trash

Function Documentation

static void eina_trash_init ( Eina_Trash **  trash) [static]

Initialize a trash before using it.

This function just set to zero the trash to correctly initialize it.

Since :
2.3.1
Remarks:
You can just set *trash to NULL and you will have the same result.
Parameters:
[in]trashThe trash.
static void* eina_trash_pop ( Eina_Trash **  trash) [static]

Pop an available pointer from the trash if possible.

Instead of calling malloc, and putting pressure on malloc/free you can recycle the content of the trash, if it's not empty.

Since :
2.3.1
Remarks:
This trash will not resize, nor do anything with the size of the region pointed by pointer inside the trash, so it's your duty to manage the size of the returned pointer.
Parameters:
[in]trashA pointer to an Eina_Trash.
static void eina_trash_push ( Eina_Trash **  trash,
void *  data 
) [static]

Push an unused pointer in the trash instead of freeing it.

Instead of freeing a pointer and put pressure on malloc/free you can push it in a trash for a later use. This function just provide a fast way to push a now unused pointer into a trash.

Since :
2.3.1
Remarks:
Do never use the pointer after insertion or bad things will happens.
This trash will not resize, nor do anything with the size of the region pointed by data, so it's your duty to manage the size.
Parameters:
[in]trashA pointer to an Eina_Trash.
dataAn unused pointer big enougth to put a (void*).