D4D EXTERNAL RESOURCE API Types Specification

Collaboration diagram for D4D EXTERNAL RESOURCE API Types Specification:

Data Structures
struct	D4DFILE_FUNCTIONS_S
	eGUI structure to store API for external files support More...
struct	D4DLOCALE_FUNCTIONS_S
	eGUI structure to store API for external strings (translated) support More...

Macros
#define	D4D_SEEK_SET
	D4D_SEEK_SET eGUI Origin constant for begin of file (1) More...
#define	D4D_SEEK_CUR
	D4D_SEEK_CUR eGUI Origin constant for current position of file (2) More...
#define	D4D_SEEK_END
	D4D_SEEK_END eGUI Origin constant for end of file (3) More...

Typedefs
typedef D4D_FILEPTR(*	D4DFILE_FOPEN )(D4D_CHAR *filename, D4D_CHAR *mode)
	File open eGUI function type. More...
typedef int(*	D4DFILE_FCLOSE )(D4D_FILEPTR p_file)
	File close eGUI function type. More...
typedef int(*	D4DFILE_READ )(D4D_FILEPTR p_file, void *buffer, int size)
	File read eGUI function type. More...
typedef int(*	D4DFILE_WRITE )(D4D_FILEPTR p_file, const void *buffer, int size)
	File write eGUI function type. More...
typedef int(*	D4DFILE_FSEEK )(D4D_FILEPTR p_file, long offset, int origin)
	File seek eGUI function type. More...
typedef long(*	D4DFILE_FTELL )(D4D_FILEPTR p_file)
	File tell eGUI function type. More...
typedef int(*	D4DLOCALE_TRANSLATE_STR )(const D4D_TCHAR *originTxt, D4D_TCHAR *newTxt, int offset, int size)
	String translate function for customizing strings. More...
typedef int(*	D4DLOCALE_GET_TRANSLATE_STR_LEN )(const D4D_TCHAR *originTxt)
	String translate string get lenght function for customized strings. More...
typedef struct D4DFILE_FUNCTIONS_S	D4DFILE_FUNCTIONS
	eGUI structure to store API for external files support More...
typedef struct D4DLOCALE_FUNCTIONS_S	D4DLOCALE_FUNCTIONS
	eGUI structure to store API for external strings (translated) support More...

Detailed Description

This section specifies the exact type for each typedef definition.

---

Data Structure Documentation

struct D4DFILE_FUNCTIONS_S

Collaboration diagram for D4DFILE_FUNCTIONS_S:

Data Fields
D4DFILE_FOPEN	D4DFILE_fopen
	Pointer to File Open Function. More...
D4DFILE_FCLOSE	D4DFILE_fclose
	Pointer to File Close Function. More...
D4DFILE_READ	D4DFILE_read
	Pointer to File Read Function. More...
D4DFILE_WRITE	D4DFILE_write
	Pointer to File Write Function. More...
D4DFILE_FSEEK	D4DFILE_fseek
	Pointer to File Seek Function. More...
D4DFILE_FTELL	D4DFILE_ftell
	Pointer to File Tell Function. More...

Field Documentation

D4DFILE_FCLOSE D4DFILE_fclose

Pointer to File Close Function.

Definition at line 180 of file d4d_extsrc.h.

D4DFILE_FOPEN D4DFILE_fopen

Pointer to File Open Function.

Definition at line 179 of file d4d_extsrc.h.

D4DFILE_FSEEK D4DFILE_fseek

Pointer to File Seek Function.

Definition at line 183 of file d4d_extsrc.h.

D4DFILE_FTELL D4DFILE_ftell

Pointer to File Tell Function.

Definition at line 184 of file d4d_extsrc.h.

D4DFILE_READ D4DFILE_read

Pointer to File Read Function.

Definition at line 181 of file d4d_extsrc.h.

D4DFILE_WRITE D4DFILE_write

Pointer to File Write Function.

Definition at line 182 of file d4d_extsrc.h.

struct D4DLOCALE_FUNCTIONS_S

Collaboration diagram for D4DLOCALE_FUNCTIONS_S:

Data Fields
D4DLOCALE_TRANSLATE_STR	D4DLOCALE_TranslateStr
	Pointer to Translate String Function. More...
D4DLOCALE_GET_TRANSLATE_STR_LEN	D4DLOCALE_GetTranslateStrLength
	Pointer to Get Translate String Length Function. More...

Field Documentation

D4DLOCALE_GET_TRANSLATE_STR_LEN D4DLOCALE_GetTranslateStrLength

Pointer to Get Translate String Length Function.

Definition at line 191 of file d4d_extsrc.h.

D4DLOCALE_TRANSLATE_STR D4DLOCALE_TranslateStr

Pointer to Translate String Function.

Definition at line 190 of file d4d_extsrc.h.

Macro Definition Documentation

#define D4D_SEEK_CUR

D4D_SEEK_CUR eGUI Origin constant for current position of file (2)

Definition at line 141 of file d4d_extsrc.h.

#define D4D_SEEK_END

D4D_SEEK_END eGUI Origin constant for end of file (3)

Definition at line 143 of file d4d_extsrc.h.

#define D4D_SEEK_SET

D4D_SEEK_SET eGUI Origin constant for begin of file (1)

Definition at line 139 of file d4d_extsrc.h.

Typedef Documentation

typedef int(* D4DFILE_FCLOSE)(D4D_FILEPTR p_file)

File close eGUI function type.

Parameters

p_file

- pointer to file structure

Returns

result of operation 0 - OK

Note

The type should reflect standard File Close function type

Definition at line 106 of file d4d_extsrc.h.

typedef D4D_FILEPTR(* D4DFILE_FOPEN)(D4D_CHAR *filename, D4D_CHAR *mode)

File open eGUI function type.

Parameters

filename	- pointer to string with file name
mode	- mode of open file

Returns

pointer to file structure

Note

The type should reflect standard File Open function type

Definition at line 98 of file d4d_extsrc.h.

typedef int(* D4DFILE_FSEEK)(D4D_FILEPTR p_file, long offset, int origin)

File seek eGUI function type.

Parameters

p_file	- pointer to file structure
offset	- new offset from select origin
origin	- origin of offset

Returns

result of operation 0 - OK

Note

The type should reflect standard File Seek function type

Definition at line 136 of file d4d_extsrc.h.

typedef long(* D4DFILE_FTELL)(D4D_FILEPTR p_file)

File tell eGUI function type.

Parameters

p_file

- pointer to file structure

Returns

>0 current position of file, <0 error

Note

The type should reflect standard File Tell function type

Definition at line 151 of file d4d_extsrc.h.

typedef struct D4DFILE_FUNCTIONS_S D4DFILE_FUNCTIONS

eGUI structure to store API for external files support

typedef int(* D4DFILE_READ)(D4D_FILEPTR p_file, void *buffer, int size)

File read eGUI function type.

Parameters

p_file	- pointer to file structure
buffer	- pointer to application buffer
size	- size of data to read

Returns

result of operation >0 read bytes, <0 error

Note

The type should reflect standard File Read function type

Definition at line 116 of file d4d_extsrc.h.

typedef int(* D4DFILE_WRITE)(D4D_FILEPTR p_file, const void *buffer, int size)

File write eGUI function type.

Parameters

p_file	- pointer to file structure
buffer	- pointer to application buffer
size	- size of data to write

Returns

result of operation >0 written bytes, <0 error

Note

The type should reflect standard File Write function type

Definition at line 126 of file d4d_extsrc.h.

typedef struct D4DLOCALE_FUNCTIONS_S D4DLOCALE_FUNCTIONS

eGUI structure to store API for external strings (translated) support

typedef int(* D4DLOCALE_GET_TRANSLATE_STR_LEN)(const D4D_TCHAR *originTxt)

String translate string get lenght function for customized strings.

Parameters

originTxt

- pointer to original string that should be translate to customize one

Returns

length of the translated string

Note

This is way how to print in eGUI any string customized. Is called if the D4D_EXTSRC_TEXT_ENABLE is enabled, and the string first character is D4D_STRINGTABLE_PREFIX and the string doesn't content of string tables. This function should return length of traslated string to eGUI.

Definition at line 174 of file d4d_extsrc.h.

typedef int(* D4DLOCALE_TRANSLATE_STR)(const D4D_TCHAR *originTxt, D4D_TCHAR *newTxt, int offset, int size)

String translate function for customizing strings.

Parameters

originTxt	- pointer to original string that should be translate to customize one
newTxt	- pointer to new string that should be printed
offset	- offset in new string that should be returned in newTxt buffer
size	- size of customized chunk that should be returned in newTxt buffer

Returns

length of printed string to newTxt buffer

Note

This is way how to print in eGUI any string customized. Is called if the D4D_EXTSRC_TEXT_ENABLE is enabled, and the string first character is D4D_STRINGTABLE_PREFIX and the string doesn't content of string tables.

Definition at line 164 of file d4d_extsrc.h.