simplegui/HMI/src/HMI_Data.c

/*************************************************************************/
/** Copyright.															**/
/** FileName: HMI_Data.c												**/
/** Author: Polarix														**/
/** Version: 1.0.0.0													**/
/** Description: User operation interface.								**/
/*************************************************************************/
//=======================================================================//
//= Include files.													    =//
//=======================================================================//
#include "HMI_Data.h"
#include "HMI_Demo01_Text.h"
#include "HMI_Demo02_List.h"
#include "HMI_Demo03_Notice1.h"
#include "HMI_Demo03_Notice2.h"
#include "HMI_Demo04_Graph.h"
#include "HMI_Demo05_VariableBox.h"

//=======================================================================//
//= User Macro definition.											    =//
//=======================================================================//
#define		HMI_PRESSED_KEY_MAX								(2)

//=======================================================================//
//= Data type definition.											    =//
//=======================================================================//
typedef struct
{
	uint16_t		Options;
	uint16_t		Keys[HMI_PRESSED_KEY_MAX];
}HMI_USER_KEY_ACTION;

//=======================================================================//
//= Static variable declaration.									    =//
//=======================================================================//
// Record count of screen.
static size_t						uiScreenCount;
// Record the index of the currently active screen.
static size_t						uiCurrentScreenIndex;
// Record the history of the screen follow-up.
static size_t						uiScreenHistory[HMI_GOBACK_HISTORY_SIZE_MAX];
static size_t						uiScreenHistoryCount;

HMI_SCREEN*							pstCurrentScreen = NULL;		// Current screen data pointer.
static HMI_SCREEN*					pstarrScreenDataArray[] = {		// Screen data structure pointer array.
												// Add HMI data here.
												&g_stHMI_DemoText,
												&g_stHMI_DemoList,
												&g_stHMI_DemoRTCNotice,
												&g_stHMI_DemoTextNotice,
												&g_stHMI_DemoGraph,
												&g_stHMI_DemoVariableBox
												};

//=======================================================================//
//= Function implementation.										    =//
//=======================================================================//
/*****************************************************************************/
/** Function Name:	HMI_ActionMap_Initialize								**/
/** Purpose:		Initialize screen follow-up data.						**/
/** Resources:		Screen data array and count variable.					**/
/** Parameters:		None.													**/
/** Return:			None.													**/
/** Notice:			This function must be called in action map initialize	**/
/**					process.												**/
/*****************************************************************************/
void HMI_ScreenData_Initialize(void)
{
	/*----------------------------------*/
	/* Variable Declaration				*/
	/*----------------------------------*/
	size_t				uiScreenIndex;

	/*----------------------------------*/
	/* Initialize						*/
	/*----------------------------------*/
	uiCurrentScreenIndex = 0;
	uiScreenCount = sizeof(pstarrScreenDataArray)/sizeof(HMI_SCREEN*);

	/*----------------------------------*/
	/* Process							*/
	/*----------------------------------*/
	// Initialize each screen.
	for(uiScreenIndex=0; uiScreenIndex<uiScreenCount; uiScreenIndex++)
	{
		if(NULL != pstarrScreenDataArray[uiScreenIndex])
		{
			pstarrScreenDataArray[uiScreenIndex]->ScreenID = uiScreenIndex;
            if(NULL != pstarrScreenDataArray[uiScreenIndex]->Actions->Initialize)
			{
				// Run initialize process if existed.
				pstarrScreenDataArray[uiScreenIndex]->Actions->Initialize();
			}
		}
	}

	uiScreenHistoryCount = 0;
}

/*****************************************************************************/
/** Function Name:	Set current active screen data pointer.					**/
/** Purpose:		Set static screen data pointer to a new data structure.	**/
/** Resources:		Static global screen data pointer.						**/
/** Parameters:																**/
/**	@uiScreenIndex:		Screen data will be set.							**/
/** Return:			None.													**/
/** Notice:			None.													**/
/*****************************************************************************/
void HMI_ScreenData_SetCurrentScreen(uint32_t uiScreenIndex)
{
	uiCurrentScreenIndex = uiScreenIndex;
}

/*****************************************************************************/
/** Function Name:	HMI_ScreenData_GetCurrentScreen.						**/
/** Purpose:		Get current screen data structure pointer which in		**/
/**					active.													**/
/** Resources:		Static global screen data pointer.						**/
/** Parameters:		None.													**/
/** Return:			Current in active screen data structure pointer.		**/
/** Notice:			None.													**/
/*****************************************************************************/
HMI_SCREEN* HMI_ScreenData_GetCurrentScreen(void)
{
	/*----------------------------------*/
	/* Variable Declaration				*/
	/*----------------------------------*/
	HMI_SCREEN*				pstCurrentScreen;

	/*----------------------------------*/
	/* Process							*/
	/*----------------------------------*/
	if(uiCurrentScreenIndex < uiScreenCount)
	{
		pstCurrentScreen = pstarrScreenDataArray[uiCurrentScreenIndex];
	}
	else
	{
		pstCurrentScreen = NULL;
	}

    return pstCurrentScreen;
}

/*****************************************************************************/
/** Function Name:	HMI_ScreenData_GetScreenData.							**/
/** Purpose:		Get current screen data structure pointer by screen ID.	**/
/** Resources:		Static global screen data pointer.						**/
/** Parameters:		None.													**/
/** Return:			Screen data structure pointer.							**/
/** Notice:			None.													**/
/*****************************************************************************/
HMI_SCREEN* HMI_ScreenData_GetScreenData(uint32_t uiScreenID)
{
	/*----------------------------------*/
	/* Variable Declaration				*/
	/*----------------------------------*/
	HMI_SCREEN*				pstCurrentScreen;

	/*----------------------------------*/
	/* Process							*/
	/*----------------------------------*/
	if(uiScreenID < uiScreenCount)
	{
		pstCurrentScreen = pstarrScreenDataArray[uiScreenID];
	}
	else
	{
		pstCurrentScreen = NULL;
	}

    return pstCurrentScreen;
}

/*****************************************************************************/
/** Function Name:	HMI_ScreenData_PushHistory.								**/
/** Purpose:		Add a screen ID to history stack.						**/
/** Resources:		Static history array.									**/
/** Parameters:		None.													**/
/** Return:																	**/
/**	@true:				Add to screen history successful.					**/
/**	@false:				History stack is full, add to history failed.		**/
/** Notice:			None.													**/
/*****************************************************************************/
bool HMI_ScreenData_PushHistory(void)
{
	/*----------------------------------*/
	/* Variable Declaration				*/
	/*----------------------------------*/
	bool			bProcessResult;
	uint32_t		uiScreenIndex;

	/*----------------------------------*/
	/* Process							*/
	/*----------------------------------*/
	if(uiScreenHistoryCount < HMI_GOBACK_HISTORY_SIZE_MAX)
	{
		uiScreenIndex = HMI_ScreenData_GetCurrentScreen()->ScreenID;
		uiScreenHistory[uiScreenHistoryCount] = uiScreenIndex;
		uiScreenHistoryCount++;
		bProcessResult = true;
	}
	else
	{
		bProcessResult = false;
	}

	return bProcessResult;
}

/*****************************************************************************/
/** Function Name:	HMI_ScreenData_PopHistory.								**/
/** Purpose:		Get the top end screen ID form history stack.			**/
/** Resources:		Static history array.									**/
/** Parameters:		None.													**/
/** Return:			The top end screen ID, if the history stack is blank,	**/
/**					The start screen ID will be returned.					**/
/** Notice:			None.													**/
/*****************************************************************************/
uint32_t HMI_ScreenData_PopHistory(void)
{
	/*----------------------------------*/
	/* Variable Declaration				*/
	/*----------------------------------*/
	uint32_t				uiScreenID;

	/*----------------------------------*/
	/* Process							*/
	/*----------------------------------*/
	if(uiScreenHistoryCount > 0)
	{
		uiScreenHistoryCount--;
		uiScreenID = uiScreenHistory[uiScreenHistoryCount];
	}
	else
	{
		uiScreenID = HMI_SCREEN_START;
	}
	return uiScreenID;
}