Search  

---

C:/temp/src/j2k/Beta/FreeList.h

Go to the documentation of this file.

#ifndef __J2K__FreeList_H__
#define __J2K__FreeList_H__   1

#include <stdio.h>
#include <string.h>
#include <malloc.h>
#include <assert.h>

/* One FreeList link implemented as a single link-list stack */
typedef struct _FreeLink_t
{
  _FreeLink_t* next;  /* Next element pointer */

} FreeLink_t;

/*
   The FreeList itself containing the size to be allocated 
   and safely upgraded if too small
   (e.g. less than 4 bytes on 32-bit machines) 
*/
typedef struct _FreeList_t
{
  FreeLink_t* head;  /* Top of the FreeList stack             */
  size_t size;       /* Size to be allocated on each FreeLink */

} FreeList_t;

/*
   This function must be call in order to create a valid FreeList.

   GOTCHA:
   =======
     1. Don't hard code 4 bytes (32-bit address space), due to 16 and 64 bit machines !
     
     2. Doing a FreeList of char is equivalent to doing a FreeList of int or double !

     3. Notice that this way we save 4 bytes per FreeLink, so basically the FreeList 
        don't cost any space per item except the FreeList container itself 
        which is merely 8 bytes !
*/
FreeList_t* FreeList_create( register size_t sz );

/*
   Allocate the desired amount of memory,
   if no FreeList link available 
*/
void* FreeList_calloc( FreeList_t* this );

/* 
   Falsely delete the dead structure, 
   by stacking it up to the FreeList,
   for future usage.
*/
void FreeList_free( FreeList_t* this, void* dead );

/*
   Really destroy the entire FreeList elements
*/
void FreeList_purge( FreeList_t* this );

/*
   Really destroy the entire FreeList elements
   including the FreeList itself !
*/
void FreeList_delete( FreeList_t* this );


#endif

---