handler.c File Reference

#include "arc/std/handler.h"
#include "arc/std/errno.h"
#include "arc/std/vector.h"
#include <stdlib.h>

Go to the source code of this file.

Data Structures
struct	ARC_Handler

Functions
void	ARC_Handler_Create (ARC_Handler **handler, ARC_Handler_CompareDataFn *compareFn, ARC_Handler_CleanDataFn cleanfn)
	creates ARC_Handler type
void	ARC_Handler_Destroy (ARC_Handler *handler)
	destroyes ARC_Handler type
void	ARC_Handler_Add (ARC_Handler *handler, void *data)
	adds data to handler
void	ARC_Handler_Remove (ARC_Handler *handler, void *data)
	remove from handler
void	ARC_Handler_RemoveIndex (ARC_Handler *handler, uint32_t index)
	remove from handler
void	ARC_Handler_Iterate (ARC_Handler *handler, ARC_Handler_DataFn datafn)
	calls provided function on each element in handler
void	ARC_Handler_Clear (ARC_Handler *handler)
	clears all data from handler and puts it in trash vector
void	ARC_Handler_Clean (ARC_Handler *handler)
	clears trash from handler
uint32_t	ARC_Handler_GetSize (ARC_Handler *handler)
	gets size of vector

Function Documentation

ARC_Handler_Add()

void ARC_Handler_Add	(	ARC_Handler *	handler,
		void *	data )

adds data to handler

Parameters

handler	ARC_Handler to add to
data	data that is being added

Definition at line 31 of file handler.c.

                                                      {
    ARC_Vector_Add(handler->data, data);
}

References ARC_Vector_Add(), and ARC_Handler::data.

ARC_Handler_Clean()

void ARC_Handler_Clean

(

ARC_Handler *

handler

)

clears trash from handler

Note

cleanfn's main purpose is to help manage memory

Parameters

handler

ARC_Handler to remove trash from

Definition at line 63 of file handler.c.

                                            {
    uint32_t i = 0;
    while(ARC_Vector_GetSize(handler->trash)){
        void *data = ARC_Vector_Get(handler->trash, i);
 
        if(handler->cleanfn){
            handler->cleanfn(data);
        }
 
        ARC_Vector_RemoveIndex(handler->trash, i);
    }
}

References ARC_Vector_Get(), ARC_Vector_GetSize(), ARC_Vector_RemoveIndex(), ARC_Handler::cleanfn, and ARC_Handler::trash.

Referenced by ARC_Engine_RunUncapped(), and ARC_Handler_Destroy().

ARC_Handler_Clear()

void ARC_Handler_Clear

(

ARC_Handler *

handler

)

clears all data from handler and puts it in trash vector

Parameters

handler

ARC_Handler to clear data from

Definition at line 56 of file handler.c.

                                            {
    uint32_t zeroIndex = 0;
    while(ARC_Vector_GetSize(handler->data)){
        ARC_Handler_RemoveIndex(handler, zeroIndex);
    }
}

References ARC_Handler_RemoveIndex(), ARC_Vector_GetSize(), and ARC_Handler::data.

Referenced by ARC_Handler_Destroy().

ARC_Handler_Create()

void ARC_Handler_Create	(	ARC_Handler **	handler,
		ARC_Handler_CompareDataFn *	compareFn,
		ARC_Handler_CleanDataFn	cleanFn )

creates ARC_Handler type

Parameters

config	ARC_Handler to initialize
compareFn	function to remove handler data
cleanFn	function to clean data in handler can be null

Definition at line 14 of file handler.c.

                                                                                                                     {
    *handler = (ARC_Handler *) malloc(sizeof(ARC_Handler));
    ARC_Vector_Create(&((*handler)->data), NULL, NULL);
    ARC_Vector_Create(&((*handler)->trash), compareFn, NULL);
    (*handler)->cleanfn = cleanfn;
}

References ARC_Vector_Create().

Referenced by ARC_EngineData_Create().

ARC_Handler_Destroy()

void ARC_Handler_Destroy

(

ARC_Handler *

handler

)

destroyes ARC_Handler type

Parameters

handler

ARC_Handler to destory

Definition at line 21 of file handler.c.

                                              {
    ARC_Handler_Clear(handler);
    ARC_Handler_Clean(handler);
 
    ARC_Vector_Destroy(handler->data);
    ARC_Vector_Destroy(handler->trash);
 
    free(handler);
}

References ARC_Handler_Clean(), ARC_Handler_Clear(), ARC_Vector_Destroy(), ARC_Handler::data, and ARC_Handler::trash.

Referenced by ARC_EngineData_Destroy().

ARC_Handler_GetSize()

uint32_t ARC_Handler_GetSize

(

ARC_Handler *

handler

)

gets size of vector

Parameters

handler

ARC_handler to get size from

Definition at line 76 of file handler.c.

                                                  {
    return ARC_Vector_GetSize(handler->data);
}

References ARC_Vector_GetSize(), and ARC_Handler::data.

ARC_Handler_Iterate()

void ARC_Handler_Iterate	(	ARC_Handler *	handler,
		ARC_Handler_DataFn	datafn )

calls provided function on each element in handler

Parameters

handler	ARC_Handler to iterate through
datafn	function that will be called on each element of data

Definition at line 50 of file handler.c.

                                                                         {
    for(uint32_t i = 0; i < ARC_Vector_GetSize(handler->data); i++){
        datafn(ARC_Vector_Get(handler->data, i));
    }
}

References ARC_Vector_Get(), ARC_Vector_GetSize(), and ARC_Handler::data.

Referenced by ARC_Engine_RunUncapped().

ARC_Handler_Remove()

void ARC_Handler_Remove	(	ARC_Handler *	handler,
		void *	data )

remove from handler

Note

the data that is removed is stored in a trash vector the ARC_Handler_Clean function must be called clean the trash vector the trash vector is to make sure a state is not deleted while being run

Parameters

handler	ARC_Handler to remove from
data	data that is being removed

Definition at line 35 of file handler.c.

                                                         {
    ARC_Vector_Add(handler->trash, data);
    ARC_Vector_Remove(handler->data, data);
}

References ARC_Vector_Add(), ARC_Vector_Remove(), ARC_Handler::data, and ARC_Handler::trash.

ARC_Handler_RemoveIndex()

void ARC_Handler_RemoveIndex	(	ARC_Handler *	handler,
		uint32_t	index )

remove from handler

Note

the data that is removed is stored in a trash vector the ARC_Handler_Clean function must be called clean the trash vector the trash vector is to make sure a state is not deleted while being run

Parameters

handler	ARC_Handler to remove from
index	index of data that is being removed

Definition at line 40 of file handler.c.

                                                                  {
    if(ARC_Vector_GetSize(handler->data) == 0){
        return;
    }
 
    void *data = ARC_Vector_Get(handler->data, index);
    ARC_Vector_Add(handler->trash, data);
    ARC_Vector_RemoveIndex(handler->data, index);
}

References ARC_Vector_Add(), ARC_Vector_Get(), ARC_Vector_GetSize(), ARC_Vector_RemoveIndex(), ARC_Handler::data, and ARC_Handler::trash.

Referenced by ARC_Handler_Clear().