oc_errors.c

Go to the documentation of this file.

/*==========================================================================================================================================
//
//     INCLUDES
//
//========================================================================================================================================*/

#include <oc_errors.h>
#include <oc_array.h>
#include <oc_null.h>
#include <stdio.h>
#include <stdint.h>
#include <oc_system_cfg.h>
#include <oc_pixel.h>

/*==========================================================================================================================================
//
//     LOCAL CONSTS
//
//========================================================================================================================================*/


/*==========================================================================================================================================
//
//     LOCAL TYPES
//
//========================================================================================================================================*/

typedef struct
{
    const char *    Function;
    uint32_t        LineNumber;
    const char *    Description;
    oC_ErrorCode_t  ErrorCode;
} SavedError_t;

/*==========================================================================================================================================
//
//     MACROS
//
//========================================================================================================================================*/

#define _ADD_ERROR_TO_STRING_LIST( CODE_NAME , CODE_STR )           CODE_STR ,

/*==========================================================================================================================================
//
//     LOCAL VARIABLES
//
//========================================================================================================================================*/

static const char* oC_ErrorsStrings[] = {
                                                                        "Success" ,
                                                                        oC_ERRORS_LIST(_ADD_ERROR_TO_STRING_LIST)
                                                                        "Unknown error code"
};

static SavedError_t SavedErrors[CFG_UINT8_MAXIMUM_NUMBER_OF_SAVED_ERRORS];
static uint8_t      FreeIndex = 0;
static bool         Locked    = false;

/*==========================================================================================================================================
//
//     LOCAL FUNCTION PROTOTYPES
//
//========================================================================================================================================*/



/*==========================================================================================================================================
//
//     INTERFACE FUNCTIONS
//
//========================================================================================================================================*/

//==========================================================================================================================================
//==========================================================================================================================================
const char * oC_GetErrorString( oC_ErrorCode_t ErrorCode )
{
    const char * string = NULL;
    if ( ErrorCode < oC_ErrorCode_NumberOfErrorsDefinitions )
    {
        string = oC_ErrorsStrings[ErrorCode];
    }
    else
    {
        string = oC_ARRAY_LAST_ELEMENT(oC_ErrorsStrings);
    }
    return string;
}

//==========================================================================================================================================
//==========================================================================================================================================
bool oC_SaveErrorFunction( const char * Description , oC_ErrorCode_t ErrorCode , const char * Function, uint32_t LineNumber )
{
    bool success = false;

    if(Locked == false && FreeIndex < CFG_UINT8_MAXIMUM_NUMBER_OF_SAVED_ERRORS)
    {
        SavedErrors[FreeIndex].Description = Description;
        SavedErrors[FreeIndex].ErrorCode   = ErrorCode;
        SavedErrors[FreeIndex].Function    = Function;
        SavedErrors[FreeIndex].LineNumber  = LineNumber;
        FreeIndex++;

        success = true;
    }

    return success;
}

//==========================================================================================================================================
//==========================================================================================================================================
bool oC_ReadLastError( const char ** outDescription , oC_ErrorCode_t * outErrorCode , const char ** outFunction , uint32_t * outLineNumber )
{
    bool read = false;

    if(FreeIndex > 0)
    {
        FreeIndex--;
        *outDescription = SavedErrors[FreeIndex].Description;
        *outErrorCode   = SavedErrors[FreeIndex].ErrorCode;
        *outFunction    = SavedErrors[FreeIndex].Function;
        *outLineNumber  = SavedErrors[FreeIndex].LineNumber;

        read = true;
    }

    return read;
}

//==========================================================================================================================================
//==========================================================================================================================================
void oC_SetLockSavingErrors( bool Lock )
{
    Locked = Lock;
}

/*==========================================================================================================================================
//
//     LOCAL FUNCTION 
//
//========================================================================================================================================*/