oc_screen.c

Go to the documentation of this file.

#include <oc_screen.h>
#include <oc_object.h>
#include <oc_string.h>

#define _________________________________________TYPES_SECTION______________________________________________________________________________

//==========================================================================================================================================
//==========================================================================================================================================
struct Screen_t
{
    oC_ObjectControl_t      ObjectControl;          
    oC_Driver_t             Driver;                 
    char                    Name[30];               
    void *                  Config;                 
    void *                  Context;                
    bool                    Configured;             
};

#undef  _________________________________________TYPES_SECTION______________________________________________________________________________

#define _________________________________________VARIABLES_SECTION__________________________________________________________________________

//==========================================================================================================================================
//==========================================================================================================================================
static const oC_Allocator_t Allocator = {
                .Name = "Screen"
};

#undef  _________________________________________VARIABLES_SECTION__________________________________________________________________________


#define _________________________________________INTERFACE_FUNCTIONS_SECTION________________________________________________________________

//==========================================================================================================================================
//==========================================================================================================================================
oC_Screen_t oC_Screen_New( oC_Driver_t Driver , const void * Config , const char * Name )
{
    oC_Screen_t     screen    = NULL;
    oC_ErrorCode_t  errorCode = oC_ErrorCode_ImplementError;

    if(
       ErrorCondition( isaddresscorrect(Driver)                             , oC_ErrorCode_WrongAddress        )
    && ErrorCondition( oC_Driver_GetDriverType(Driver) == GRAPHICS_DRIVER   , oC_ErrorCode_NotGraphicDriver    )
    && ErrorCondition( isaddresscorrect(Driver)                             , oC_ErrorCode_WrongAddress        )
    && ErrorCondition( isaddresscorrect(Name)                               , oC_ErrorCode_WrongAddress        )
        )
    {
        screen = kmalloc(sizeof(struct Screen_t) , &Allocator , AllocationFlags_CanWait1Second | AllocationFlags_ZeroFill);

        if(screen != NULL)
        {
            screen->ObjectControl    = oC_CountObjectControl(screen,oC_ObjectId_Screen);
            screen->Driver           = Driver;
            screen->Config           = kmalloc(Driver->ConfigurationSize,&Allocator, AllocationFlags_CanWait1Second);
            screen->Context          = NULL;
            screen->Configured       = false;

            if(screen->Config != NULL)
            {
                strncpy(screen->Name,Name,sizeof(screen->Name));
                memcpy(screen->Config,Config,Driver->ConfigurationSize);
            }
            else
            {
                oC_SaveIfFalse("Screen::new: cannot release screen memory", kfree(screen,AllocationFlags_CanWait1Second) , oC_ErrorCode_ReleaseError);
                oC_SaveError("Screen::new: cannot allocate memory for config" , oC_ErrorCode_AllocationError);
            }
        }
        else
        {
            oC_SaveError("Screen::new: cannot allocate memory for screen" , oC_ErrorCode_AllocationError);
        }
    }
    else
    {
        oC_SaveError("Screen::new: Cannot create screen - " , errorCode);
    }

    return screen;
}

//==========================================================================================================================================
//==========================================================================================================================================
bool oC_Screen_IsCorrect( oC_Screen_t Screen )
{
    return isram(Screen) && oC_CheckObjectControl(Screen,oC_ObjectId_Screen,Screen->ObjectControl);
}

//==========================================================================================================================================
//==========================================================================================================================================
bool oC_Screen_Delete( oC_Screen_t * Screen )
{
    bool deleted = false;

    if(isaddresscorrect(Screen) && oC_Screen_IsCorrect(*Screen))
    {
        oC_Screen_t localScreen = *Screen;

        if(localScreen->Configured == true)
        {
            oC_SaveIfErrorOccur("Screen::delete: Cannot unconfigure screen - " , oC_Driver_Unconfigure(localScreen->Driver,localScreen->Config,&localScreen->Context));
        }

        deleted = kfree(localScreen->Config,AllocationFlags_CanWait1Second);

        if(!deleted)
        {
            oC_SaveError("Screen::delete: Cannot release config memory - " , oC_ErrorCode_ReleaseError);
        }

        if(kfree(localScreen,AllocationFlags_CanWait1Second))
        {
            deleted = deleted && true;
        }
        else
        {
            oC_SaveError("Screen::delete: Cannot release screen memory - " , oC_ErrorCode_ReleaseError);
        }
    }

    return deleted;
}


//==========================================================================================================================================
//==========================================================================================================================================
bool oC_Screen_IsConfigured( oC_Screen_t Screen )
{
    return oC_Screen_IsCorrect(Screen) && Screen->Configured;
}

//==========================================================================================================================================
//==========================================================================================================================================
oC_ErrorCode_t oC_Screen_Configure( oC_Screen_t Screen )
{
    oC_ErrorCode_t errorCode = oC_ErrorCode_ImplementError;

    if(
        ErrorCondition( oC_Screen_IsCorrect(Screen)  , oC_ErrorCode_ObjectNotCorrect   )
     && ErrorCondition( Screen->Configured == false   , oC_ErrorCode_AlreadyConfigured  )
     && oC_AssignErrorCode(&errorCode , oC_Driver_Configure(Screen->Driver,Screen->Config,&Screen->Context))
        )
    {
        Screen->Configured  = true;
        errorCode           = oC_ErrorCode_None;
    }

    return errorCode;
}

//==========================================================================================================================================
//==========================================================================================================================================
oC_ErrorCode_t oC_Screen_Unconfigure( oC_Screen_t Screen )
{
    oC_ErrorCode_t errorCode = oC_ErrorCode_ImplementError;

    if(
        ErrorCondition( oC_Screen_IsCorrect(Screen)    , oC_ErrorCode_ObjectNotCorrect )
     && ErrorCondition( Screen->Configured == true      , oC_ErrorCode_NotConfiguredYet )
     && oC_AssignErrorCode(&errorCode , oC_Driver_Unconfigure(Screen->Driver,Screen->Config,&Screen->Context))
        )
    {
        Screen->Configured = false;
        errorCode          = oC_ErrorCode_None;
    }

    return errorCode;
}

//==========================================================================================================================================
//==========================================================================================================================================
oC_ErrorCode_t oC_Screen_ReadColorMap( oC_Screen_t Screen , oC_ColorMap_t ** outColorMap )
{
    oC_ErrorCode_t errorCode = oC_ErrorCode_ImplementError;

    if(
        ErrorCondition( oC_Screen_IsCorrect(Screen)     , oC_ErrorCode_ObjectNotCorrect      )
     && ErrorCondition( Screen->Configured == true      , oC_ErrorCode_NotConfiguredYet      )
     && ErrorCondition( isram(outColorMap)              , oC_ErrorCode_OutputAddressNotInRAM )
        )
    {
        errorCode = oC_Driver_ReadColorMap(Screen->Driver,Screen->Context,outColorMap);
    }

    return errorCode;
}

//==========================================================================================================================================
//==========================================================================================================================================
oC_ErrorCode_t oC_Screen_ReadResolution( oC_Screen_t Screen , oC_Pixel_ResolutionUInt_t * outWidth , oC_Pixel_ResolutionUInt_t * outHeight )
{
    oC_ErrorCode_t errorCode = oC_ErrorCode_ImplementError;

    if(
        ErrorCondition( oC_Screen_IsCorrect(Screen)    , oC_ErrorCode_ObjectNotCorrect      )
     && ErrorCondition( Screen->Configured == true      , oC_ErrorCode_NotConfiguredYet      )
     && ErrorCondition( isram(outWidth)                 , oC_ErrorCode_OutputAddressNotInRAM )
     && ErrorCondition( isram(outHeight)                , oC_ErrorCode_OutputAddressNotInRAM )
        )
    {
        errorCode = oC_Driver_ReadResolution(Screen->Driver,Screen->Context,outWidth,outHeight);
    }

    return errorCode;
}

//==========================================================================================================================================
//==========================================================================================================================================
const char * oC_Screen_GetName( oC_Screen_t Screen )
{
    const char * name = "unknown";

    if(oC_Screen_IsCorrect(Screen))
    {
        name = Screen->Name;
    }
    else
    {
        name = "incorrect";
    }

    return name;
}

//==========================================================================================================================================
//==========================================================================================================================================
oC_Driver_t oC_Screen_GetDriver( oC_Screen_t Screen )
{
    oC_Driver_t driver = NULL;

    if(oC_Screen_IsCorrect(Screen))
    {
        driver = Screen->Driver;
    }

    return driver;
}


#undef  _________________________________________INTERFACE_FUNCTIONS_SECTION________________________________________________________________