/*F(***************************************************************************
 * File name : datamng.hec
 * Project : DOWNLOAD
 * Module : Datamng
 *----------------------------------------------------------------------------*
 *----------------------------------------------------------------------------*
 *                                    DESCRIPTION
 *
 *----------------------------------------------------------------------------*
 *----------------------------------------------------------------------------*
 *                                    EVOLUTION
 *----------------------------------------------------------------------------*
 * Date     | Author    | Arnb   | Description
 *----------------------------------------------------------------------------*
 * 18.10.99 | B.Simon            | Creation
 *----------------------------------------------------------------------------*
 * 03.12.99 | B.Simon            | Update after walkthrough
 *----------------------------------------------------------------------------*
 * 21.12.00 | S.Mevel            | Update for download pack2
 *----------------------------------------------------------------------------*
 * 21.06.01 | A.Gerisse          | Add games Family
 ***************************************************************************)F*/
/* #*/

#ifndef DATAMNG_HEC
#define DATAMNG_HEC

/******************************************************/
/* General definition                                 */
/******************************************************/
#define INPUT
#define OUTPUT
#define INOUT
/******************************************************/
/* General definitions                                */
/******************************************************/
/* return code for the functions (RC) */
typedef enum 
        {
        DMN_RC_NOK = 0,
        DMN_RC_OK,
        DMN_RC_NO_DATA,
        DMN_RC_NO_RESIDENT_DATA,
        DMN_RC_NO_PACKDATA,
        DMN_RC_BAD_COHERENCE,
        DMN_RC_BAD_RESIDENT_DATA_COHERENCE,
        DMN_RC_BAD_PACKDATA_COHERENCE,
        DMN_RC_ENGLISH_NOT_PRESENT,
        DMN_RC_LANGUAGE_NOT_FOUND,
        DMN_RC_NO_FAMILY_TYPE,
        DMN_RC_NO_LOCATION_TYPE,
        DMN_RC_CONVERSION_IMPOSSIBLE,
        DMN_RC_NOT_UCS2_LANGUAGE,
        DMN_RC_FREE_MEMORY_IMPOSSIBLE,
	DMN_RC_BAD_LANGUAGE_CODING,
	DMN_RC_BAD_LANGUAGE_CODING_COHERENCE,
	DMN_RC_DICTIONARY_NOT_FOUND,
	DMN_RC_NO_ICO_ANIM_DWL,
 	DMN_RC_END
        }t_dmn_ReturnCode;


/******************************************************/
/* Data area structure _ DA                           */
/******************************************************/
/* Different families */
typedef enum
        {
        DMN_FAMILY_LANGUAGE = 1,
        DMN_FAMILY_DICTIONARY ,
	DMN_FAMILY_ICO_ANIM,
        DMN_FAMILY_FONT ,
	DMN_FAMILY_GAMES ,
        DMN_FAMILY_END
        }t_dmn_Family;

/* DA_SIGN not coding rules but defined in the ESD download and used by tools */
/*DMN_SIGNATURE */
#define DA_SIGN   	0x3539393A 

/* Define the length of the pack name */
#define DMN_LENGTH_PACK_NAME 12

/******************************************************/
/* dictionnary definitions                            */
/******************************************************/
/* Size of the Plid/Slid name */
/*#define DMN_PLID_NAME_SIZE  4 */ /* Not used ?*/
#define DMN_NAME_SIZE   8


/******************************************************/
/* Conversion definitions                             */
/******************************************************/
/* Different status of the conversion */
#define DMN_CONVERSION_ACHIEVED 0x00
#define DMN_CONVERSION_WITH_APPROXIMATION 0x01
#define DMN_CONVERSION_WITH_LOSS 0x02
#define DMN_NO_CONVERSION_TABLE 0xFF

/* Length of a character (in u8) */
#define DMN_GSM_LENGTH 1
#define DMN_UCS2_LENGTH 2

/* Read Access of the conversion table */
#define DMN_DIRECT_READ_ACCESS 1
#define DMN_UNDIRECT_READ_ACCESS 2

#define DMN_DEFAULT_CHARACTER 0x20 

/* Number of conversion tables */
#define DMN_CONVERSION_TABLE_NUMBER 4

/* Size of the Default Character */
#define DMN_DEFAULT_CHARACTER_SIZE  2

#define DMN_NOT_FOUND 0xFF
#define DMN_FOUND 1
#define DMN_UNDEFINED_TABLE 0xFF


/* Origin of the conversion */
#define DMN_NO_UCS2_HEADER   1
#define DMN_UCS2_HEADER      2


#define DMN_ASCII_IRV_FORMAT 6

/******************************************************/
/* language definitions                               */
/******************************************************/

/* Language coding type (LC) */
typedef enum 
        {
        DMN_LC_GSM = 0,
        DMN_LC_UCS2,
        DMN_LC_END
        }t_dmn_LanguageCoding;

/* Language location type (LL) */
typedef enum 
        {
        DMN_LL_RESIDENT_DATA = 0,
        DMN_LL_PACKDATA,
        DMN_LL_END
        }t_dmn_LanguageLocation;

/* Language location search type (LS) */
typedef enum 
        {
        DMN_LS_NO_DATA = 0,
        DMN_LS_RESIDENT_DATA,
        DMN_LS_PACKDATA,
        DMN_LS_ALL,
        DMN_LS_END
        }t_dmn_LanguageLocationSearch;


/******************************************************/
/* Icones animations definitions                      */
/******************************************************/
/* Define the length of the operator name */
#define DMN_LENGTH_OPERATOR_NAME 12

#endif /* DATAMNG_HEC */