/** Unregisters a callback function from a clock
* @param[in] _pstClock Concerned clock
* @param[in] _fnCallback Callback to remove
* @return orxSTATUS_SUCCESS / orxSTATUS_FAILURE
*/
orxSTATUS orxFASTCALL orxClock_Unregister(orxCLOCK *_pstClock, const orxCLOCK_FUNCTION _pfnCallback)
{
orxCLOCK_FUNCTION_STORAGE *pstFunctionStorage;
orxSTATUS eResult = orxSTATUS_SUCCESS;
/* Checks */
orxASSERT(sstClock.u32Flags & orxCLOCK_KU32_STATIC_FLAG_READY);
orxSTRUCTURE_ASSERT(_pstClock);
orxASSERT(_pfnCallback != orxNULL);
/* Finds clock function storage */
pstFunctionStorage = orxClock_FindFunctionStorage(_pstClock, _pfnCallback);
/* Found? */
if(pstFunctionStorage != orxNULL)
{
/* Removes it from list */
orxLinkList_Remove(&(pstFunctionStorage->stNode));
/* Removes it from bank */
orxBank_Free(_pstClock->pstFunctionBank, pstFunctionStorage);
}
else
{
/* Logs message */
orxDEBUG_PRINT(orxDEBUG_LEVEL_CLOCK, "Couldn't find clock function storage.");
/* Not found */
eResult = orxSTATUS_FAILURE;
}
/* Done! */
return eResult;
}
/** Removes an event handler which matches given context
* @param[in] _eEventType Concerned type of event
* @param[in] _pfnEventHandler Event handler to remove
* @param[in] _pContext Context of the handler to remove, orxNULL for removing all occurrences regardless of their context
* return orxSTATUS_SUCCESS / orxSTATUS_FAILURE
*/
orxSTATUS orxFASTCALL orxEvent_RemoveHandlerWithContext(orxEVENT_TYPE _eEventType, orxEVENT_HANDLER _pfnEventHandler, void *_pContext)
{
orxEVENT_HANDLER_STORAGE *pstStorage;
orxSTATUS eResult = orxSTATUS_FAILURE;
/* Checks */
orxASSERT(orxFLAG_TEST(sstEvent.u32Flags, orxEVENT_KU32_STATIC_FLAG_READY));
orxASSERT(_pfnEventHandler != orxNULL);
/* Gets corresponding storage */
pstStorage = (_eEventType < orxEVENT_TYPE_CORE_NUMBER) ? sstEvent.astCoreHandlerStorageList[_eEventType] : (orxEVENT_HANDLER_STORAGE *)orxHashTable_Get(sstEvent.pstHandlerStorageTable, _eEventType);
/* Valid? */
if(pstStorage != orxNULL)
{
orxEVENT_HANDLER_INFO *pstInfo;
/* For all handlers */
for(pstInfo = (orxEVENT_HANDLER_INFO *)orxLinkList_GetFirst(&(pstStorage->stList));
pstInfo != orxNULL;
pstInfo = (orxEVENT_HANDLER_INFO *)orxLinkList_GetNext(&(pstInfo->stNode)))
{
/* Found? */
if((pstInfo->pfnHandler == _pfnEventHandler)
&& ((_pContext == orxNULL)
|| (_pContext == _pfnEventHandler)
|| (_pContext == pstInfo->pContext)))
{
/* Removes it from list */
orxLinkList_Remove(&(pstInfo->stNode));
/* Frees it */
orxBank_Free(pstStorage->pstBank, pstInfo);
/* Updates result */
eResult = orxSTATUS_SUCCESS;
/* Should only remove one? */
if(_pContext == _pfnEventHandler)
{
/* Stops */
break;
}
}
}
}
else
{
/* Defaults to success */
eResult = orxSTATUS_SUCCESS;
}
/* Done! */
return eResult;
}
/** Deletes a clock
* @param[in] _pstClock Concerned clock
* @return orxSTATUS_SUCCESS / orxSTATUS_FAILURE
*/
orxSTATUS orxFASTCALL orxClock_Delete(orxCLOCK *_pstClock)
{
orxSTATUS eResult = orxSTATUS_SUCCESS;
/* Checks */
orxASSERT(sstClock.u32Flags & orxCLOCK_KU32_STATIC_FLAG_READY);
orxSTRUCTURE_ASSERT(_pstClock);
/* Decreases counter */
orxStructure_DecreaseCounter(_pstClock);
/* Not referenced? */
if(orxStructure_GetRefCounter(_pstClock) == 0)
{
/* Not locked? */
if(!orxStructure_TestFlags(_pstClock, orxCLOCK_KU32_FLAG_UPDATE_LOCK))
{
orxCLOCK_TIMER_STORAGE *pstTimerStorage;
/* For all stored timers */
for(pstTimerStorage = (orxCLOCK_TIMER_STORAGE *)orxLinkList_GetFirst(&(_pstClock->stTimerList));
pstTimerStorage != orxNULL;
pstTimerStorage = (orxCLOCK_TIMER_STORAGE *)orxLinkList_GetFirst(&(_pstClock->stTimerList)))
{
/* Removes it */
orxLinkList_Remove(&(pstTimerStorage->stNode));
/* Deletes it */
orxBank_Free(sstClock.pstTimerBank, pstTimerStorage);
}
/* Deletes function bank */
orxBank_Delete(_pstClock->pstFunctionBank);
/* Is referenced? */
if(orxStructure_TestFlags(_pstClock, orxCLOCK_KU32_FLAG_REFERENCED))
{
/* Removes it from reference table */
orxHashTable_Remove(sstClock.pstReferenceTable, orxString_ToCRC(_pstClock->zReference));
}
/* Has reference? */
if(_pstClock->zReference != orxNULL)
{
/* Unprotects it */
orxConfig_ProtectSection(_pstClock->zReference, orxFALSE);
}
/* Deletes clock */
orxStructure_Delete(_pstClock);
}
else
{
/* Increases counter */
orxStructure_IncreaseCounter(_pstClock);
/* Logs message */
orxDEBUG_PRINT(orxDEBUG_LEVEL_CLOCK, "Can't delete clock <%s> as it's currently locked for processing!", orxStructure_TestFlags(_pstClock, orxCLOCK_KU32_FLAG_REFERENCED) ? _pstClock->zReference : orxSTRING_EMPTY);
/* Updates result */
eResult = orxSTATUS_FAILURE;
}
}
else
{
/* Referenced by others */
eResult = orxSTATUS_FAILURE;
}
/* Done! */
return eResult;
}
/** Updates the clock system
* @return orxSTATUS_SUCCESS / orxSTATUS_FAILURE
*/
orxSTATUS orxFASTCALL orxClock_Update()
{
orxDOUBLE dNewTime;
orxFLOAT fDT, fDelay;
orxCLOCK *pstClock;
orxSTATUS eResult = orxSTATUS_SUCCESS;
/* Checks */
orxASSERT(sstClock.u32Flags & orxCLOCK_KU32_STATIC_FLAG_READY);
/* Not already locked? */
if(!(sstClock.u32Flags & orxCLOCK_KU32_STATIC_FLAG_UPDATE_LOCK))
{
/* Lock clocks */
sstClock.u32Flags |= orxCLOCK_KU32_STATIC_FLAG_UPDATE_LOCK;
/* Gets new time */
dNewTime = orxSystem_GetTime();
/* Computes natural DT */
fDT = (orxFLOAT)(dNewTime - sstClock.dTime);
/* Gets modified DT */
fDT = orxClock_ComputeDT(fDT, orxNULL);
/* Updates time */
sstClock.dTime = dNewTime;
/* Inits delay */
fDelay = sstClock.fMainClockTickSize;
/* For all clocks */
for(pstClock = orxCLOCK(orxStructure_GetFirst(orxSTRUCTURE_ID_CLOCK));
pstClock != orxNULL;
pstClock = orxCLOCK(orxStructure_GetNext(pstClock)))
{
/* Locks it */
orxStructure_SetFlags(pstClock, orxCLOCK_KU32_FLAG_UPDATE_LOCK, orxCLOCK_KU32_FLAG_NONE);
/* Is clock not paused? */
if(orxClock_IsPaused(pstClock) == orxFALSE)
{
orxFLOAT fClockDelay;
/* Updates clock real time & partial DT */
pstClock->fPartialDT += fDT;
/* New tick happens? */
if(pstClock->fPartialDT >= pstClock->stClockInfo.fTickSize)
{
orxFLOAT fClockDT;
orxCLOCK_TIMER_STORAGE *pstTimerStorage;
orxCLOCK_FUNCTION_STORAGE *pstFunctionStorage;
/* Gets clock modified DT */
fClockDT = orxClock_ComputeDT(pstClock->fPartialDT, &(pstClock->stClockInfo));
/* Updates clock DT */
pstClock->stClockInfo.fDT = fClockDT;
/* Updates clock time */
pstClock->stClockInfo.fTime += fClockDT;
/* For all timers */
for(pstTimerStorage = (orxCLOCK_TIMER_STORAGE *)orxLinkList_GetFirst(&(pstClock->stTimerList)); pstTimerStorage != orxNULL;)
{
/* Should call it? */
if((pstTimerStorage->fTimeStamp <= pstClock->stClockInfo.fTime) && (pstTimerStorage->s32Repetition != 0))
{
/* Calls it */
pstTimerStorage->pfnCallback(&(pstClock->stClockInfo), pstTimerStorage->pContext);
/* Updates its time stamp */
pstTimerStorage->fTimeStamp = pstClock->stClockInfo.fTime + pstTimerStorage->fDelay;
/* Should update counter */
if(pstTimerStorage->s32Repetition > 0)
{
/* Updates it */
pstTimerStorage->s32Repetition--;
}
}
/* Should delete it */
if(pstTimerStorage->s32Repetition == 0)
{
orxCLOCK_TIMER_STORAGE *pstDelete;
/* Gets timer to delete */
pstDelete = pstTimerStorage;
/* Gets the next timer */
pstTimerStorage = (orxCLOCK_TIMER_STORAGE *)orxLinkList_GetNext(&(pstTimerStorage->stNode));
/* Removes current timer */
orxLinkList_Remove(&(pstDelete->stNode));
/* Deletes it */
orxBank_Free(sstClock.pstTimerBank, pstDelete);
}
else
{
/* Gets the next timer */
pstTimerStorage = (orxCLOCK_TIMER_STORAGE *)orxLinkList_GetNext(&(pstTimerStorage->stNode));
}
}
/* For all registered callbacks */
for(pstFunctionStorage = (orxCLOCK_FUNCTION_STORAGE *)orxLinkList_GetFirst(&(pstClock->stFunctionList));
pstFunctionStorage != orxNULL;
pstFunctionStorage = (orxCLOCK_FUNCTION_STORAGE *)orxLinkList_GetNext(&(pstFunctionStorage->stNode)))
{
/* Calls it */
pstFunctionStorage->pfnCallback(&(pstClock->stClockInfo), pstFunctionStorage->pContext);
}
/* Updates partial DT */
pstClock->fPartialDT = orxFLOAT_0;
}
/* Gets clock's delay */
fClockDelay = pstClock->stClockInfo.fTickSize - pstClock->fPartialDT;
/* Smaller than previous clocks' delay? */
if(fClockDelay < fDelay)
{
/* Stores it */
fDelay = fClockDelay;
}
}
/* Unlocks it */
orxStructure_SetFlags(pstClock, orxCLOCK_KU32_FLAG_NONE, orxCLOCK_KU32_FLAG_UPDATE_LOCK);
}
/* Unlocks clocks */
sstClock.u32Flags &= ~orxCLOCK_KU32_STATIC_FLAG_UPDATE_LOCK;
/* Gets real remaining delay */
fDelay = fDelay + orxCLOCK_KF_DELAY_ADJUSTMENT - orx2F(orxSystem_GetTime() - sstClock.dTime);
/* Should delay? */
if(fDelay > orxFLOAT_0)
{
/* Waits for next time slice */
orxSystem_Delay(fDelay);
}
}
/* Done! */
return eResult;
}
