Endian specific read/write interfaces

The endian specific read/write functions read and write data of the specified endianness, dynamically translating to the host machine endianness. More...

Macros
#define	ArchSwapLE16(X)   (X)
#define	ArchSwapLE32(X)   (X)
#define	ArchSwapLE64(X)   (X)
#define	ArchSwapBE16(X)   ArchSwap16(X)
#define	ArchSwapBE32(X)   ArchSwap32(X)
#define	ArchSwapBE64(X)   ArchSwap64(X)

Functions
Uint16	MGUI_ReadLE16 (MG_RWops *src)
	Reads a 16-bit little endian integer from a MG_RWops object. More...
Uint16	MGUI_ReadBE16 (MG_RWops *src)
	Reads a 16-bit big endian integer from a MG_RWops object. More...
Uint32	MGUI_ReadLE32 (MG_RWops *src)
	Reads a 32-bit little endian integer from a MG_RWops object. More...
Uint32	MGUI_ReadBE32 (MG_RWops *src)
	Reads a 32-bit big endian integer from a MG_RWops object. More...
Uint64	MGUI_ReadLE64 (MG_RWops *src)
	Reads a 64-bit little endian integer from a MG_RWops object. More...
Uint64	MGUI_ReadBE64 (MG_RWops *src)
	Reads a 64-bit big endian integer from a MG_RWops object. More...
int	MGUI_WriteLE16 (MG_RWops *dst, Uint16 value)
	Writes an 16-bit integer of native format to a MG_RWops object in littlen endianness. More...
int	MGUI_WriteBE16 (MG_RWops *dst, Uint16 value)
	Writes an 16-bit integer of native format to a MG_RWops object in big endianness. More...
int	MGUI_WriteLE32 (MG_RWops *dst, Uint32 value)
	Writes an 32-bit integer of native format to a MG_RWops object in littlen endianness. More...
int	MGUI_WriteBE32 (MG_RWops *dst, Uint32 value)
	Writes an 32-bit integer of native format to a MG_RWops object in big endianness. More...
int	MGUI_WriteLE64 (MG_RWops *dst, Uint64 value)
	Writes an 64-bit integer of native format to a MG_RWops object in littlen endianness. More...
int	MGUI_WriteBE64 (MG_RWops *dst, Uint64 value)
	Writes an 64-bit integer of native format to a MG_RWops object in big endianness. More...
Uint16	MGUI_ReadLE16FP (FILE *src)
	Reads a 16-bit little endian integer from a stdio FILE object. More...
Uint32	MGUI_ReadLE32FP (FILE *src)
	Reads a 32-bit little endian integer from a stdio FILE object. More...
int	MGUI_WriteLE16FP (FILE *dst, Uint16 value)
	Writes an 16-bit integer of native format to a stdio FILE object in littlen endianness. More...
int	MGUI_WriteLE32FP (FILE *dst, Uint32 value)
	Writes an 32-bit integer of native format to a stdio FILE object in littlen endianness. More...

Detailed Description

The endian specific read/write functions read and write data of the specified endianness, dynamically translating to the host machine endianness.

e.g.: If you want to read a 16 bit value on big-endian machine from an opened file containing little endian values, you would use:

value = MGUI_ReadLE16(rp);

See also

General read/write operations

Example:

    int fd, len_header;
 
...
 
    if (read (fd, &len_header, sizeof (int)) == -1)
        goto error;
#if MGUI_BYTEORDER == MGUI_BIG_ENDIAN
    /* If the native system is big endian, calling ArchSwap32 to
     * swap the bytes.
     */
    len_header = ArchSwap32 (len_header);
#endif
 
...

Macro Definition Documentation

ArchSwapBE16

#define ArchSwapBE16

(

X

)

ArchSwap16(X)

Swaps a 16-bit big endian integer to the native endianness.

Definition at line 467 of file endianrw.h.

ArchSwapBE32

#define ArchSwapBE32

(

X

)

ArchSwap32(X)

Swaps a 32-bit big endian integer to the native endianness.

Definition at line 469 of file endianrw.h.

ArchSwapBE64

#define ArchSwapBE64

(

X

)

ArchSwap64(X)

Swaps a 64-bit big endian integer to the native endianness.

Definition at line 471 of file endianrw.h.

ArchSwapLE16

#define ArchSwapLE16

(

X

)

(X)

Swaps a 16-bit little endian integer to the native endianness.

Definition at line 461 of file endianrw.h.

ArchSwapLE32

#define ArchSwapLE32

(

X

)

(X)

Swaps a 32-bit little endian integer to the native endianness.

Definition at line 463 of file endianrw.h.

ArchSwapLE64

#define ArchSwapLE64

(

X

)

(X)

Swaps a 64-bit little endian integer to the native endianness.

Definition at line 465 of file endianrw.h.

Function Documentation

MGUI_ReadBE16()

Uint16 MGUI_ReadBE16

(

MG_RWops *

src

)

Reads a 16-bit big endian integer from a MG_RWops object.

This function reads a 16-bit big endian integer from the data source pointed to by src, and return it in native format.

Parameters

src	The pointer to the MG_RWops object.

Returns

The integer in native endianness.

See also

MGUI_WriteBE16

MGUI_ReadBE32()

Uint32 MGUI_ReadBE32

(

MG_RWops *

src

)

Reads a 32-bit big endian integer from a MG_RWops object.

This function reads a 32-bit big endian integer from the data source pointed to by src, and return it in native format.

Parameters

src	The pointer to the MG_RWops object.

Returns

The integer in native endianness.

See also

MGUI_WriteBE32

MGUI_ReadBE64()

Uint64 MGUI_ReadBE64

(

MG_RWops *

src

)

Reads a 64-bit big endian integer from a MG_RWops object.

This function reads a 64-bit big endian integer from the data source pointed to by src, and return it in native format.

Parameters

src	The pointer to the MG_RWops object.

Returns

The integer in native endianness.

See also

MGUI_WriteBE64

MGUI_ReadLE16()

Uint16 MGUI_ReadLE16

(

MG_RWops *

src

)

Reads a 16-bit little endian integer from a MG_RWops object.

This function reads a 16-bit little endian integer from the data source pointed to by src, and return it in native format.

Parameters

src	The pointer to the MG_RWops object.

Returns

The integer in native endianness.

See also

MGUI_WriteLE16

MGUI_ReadLE16FP()

Uint16 MGUI_ReadLE16FP

(

FILE *

src

)

Reads a 16-bit little endian integer from a stdio FILE object.

This function reads a 16-bit little endian integer from the stdio FILE object pointed to by src, and return it in native format.

Parameters

src	The pointer to the stdio FILE object.

Returns

The integer in native endianness.

See also

MGUI_WriteLE16FP, MGUI_ReadLE16

MGUI_ReadLE32()

Uint32 MGUI_ReadLE32

(

MG_RWops *

src

)

Reads a 32-bit little endian integer from a MG_RWops object.

This function reads a 32-bit little endian integer from the data source pointed to by src, and return it in native format.

Parameters

src	The pointer to the MG_RWops object.

Returns

The integer in native endianness.

See also

MGUI_WriteLE32

MGUI_ReadLE32FP()

Uint32 MGUI_ReadLE32FP

(

FILE *

src

)

Reads a 32-bit little endian integer from a stdio FILE object.

This function reads a 32-bit little endian integer from the stdio FILE object pointed to by src, and return it in native format.

Parameters

src	The pointer to the stdio FILE object.

Returns

The integer in native endianness.

See also

MGUI_WriteLE32FP, MGUI_ReadLE32

MGUI_ReadLE64()

Uint64 MGUI_ReadLE64

(

MG_RWops *

src

)

Reads a 64-bit little endian integer from a MG_RWops object.

This function reads a 64-bit little endian integer from the data source pointed to by src, and return it in native format.

Parameters

src	The pointer to the MG_RWops object.

Returns

The integer in native endianness.

See also

MGUI_WriteLE64

MGUI_WriteBE16()

int MGUI_WriteBE16	(	MG_RWops *	src,
		Uint16	value
	)

Writes an 16-bit integer of native format to a MG_RWops object in big endianness.

This function writes a 16-bit integer of native format to the data source pointed to by src in big endiannes.

Parameters

src	The pointer to the MG_RWops object.
value	The 16-bit integer in native endianness.

Returns

Returns 1 on success, else indicates an error.

See also

MGUI_ReadLE16

MGUI_WriteBE32()

int MGUI_WriteBE32	(	MG_RWops *	src,
		Uint32	value
	)

Writes an 32-bit integer of native format to a MG_RWops object in big endianness.

This function writes a 32-bit integer of native format to the data source pointed to by src in big endiannes.

Parameters

src	The pointer to the MG_RWops object.
value	The 32-bit integer in native endianness.

Returns

Returns 1 on success, else indicates an error.

See also

MGUI_ReadLE32

MGUI_WriteBE64()

int MGUI_WriteBE64	(	MG_RWops *	src,
		Uint64	value
	)

Writes an 64-bit integer of native format to a MG_RWops object in big endianness.

This function writes a 64-bit integer of native format to the data source pointed to by src in big endiannes.

Parameters

src	The pointer to the MG_RWops object.
value	The 64-bit integer in native endianness.

Returns

Returns 1 on success, else indicates an error.

See also

MGUI_ReadLE64

MGUI_WriteLE16()

int MGUI_WriteLE16	(	MG_RWops *	src,
		Uint16	value
	)

Writes an 16-bit integer of native format to a MG_RWops object in littlen endianness.

This function writes a 16-bit integer of native format to the data source pointed to by src in littlen endiannes.

Parameters

src	The pointer to the MG_RWops object.
value	The 16-bit integer in native endianness.

Returns

Returns 1 on success, else indicates an error.

See also

MGUI_ReadLE16

MGUI_WriteLE16FP()

int MGUI_WriteLE16FP	(	FILE *	dst,
		Uint16	value
	)

Writes an 16-bit integer of native format to a stdio FILE object in littlen endianness.

This function writes a 16-bit integer of native format to the stdio FILE object pointed to by src in littlen endiannes.

Parameters

dst	The pointer to the MG_RWops object.
value	The 16-bit integer in native endianness.

Returns

Returns 1 on success, else indicates an error.

See also

MGUI_ReadLE16FP, MGUI_WriteLE16

MGUI_WriteLE32()

int MGUI_WriteLE32	(	MG_RWops *	src,
		Uint32	value
	)

Writes an 32-bit integer of native format to a MG_RWops object in littlen endianness.

This function writes a 32-bit integer of native format to the data source pointed to by src in littlen endiannes.

Parameters

src	The pointer to the MG_RWops object.
value	The 32-bit integer in native endianness.

Returns

Returns 1 on success, else indicates an error.

See also

MGUI_ReadLE32

MGUI_WriteLE32FP()

int MGUI_WriteLE32FP	(	FILE *	dst,
		Uint32	value
	)

Writes an 32-bit integer of native format to a stdio FILE object in littlen endianness.

This function writes a 32-bit integer of native format to the stdio FILE object pointed to by src in littlen endiannes.

Parameters

dst	The pointer to the MG_RWops object.
value	The 32-bit integer in native endianness.

Returns

Returns 1 on success, else indicates an error.

See also

MGUI_ReadLE32FP, MGUI_WriteLE32

MGUI_WriteLE64()

int MGUI_WriteLE64	(	MG_RWops *	src,
		Uint64	value
	)

Writes an 64-bit integer of native format to a MG_RWops object in littlen endianness.

This function writes a 64-bit integer of native format to the data source pointed to by src in littlen endiannes.

Parameters

src	The pointer to the MG_RWops object.
value	The 64-bit integer in native endianness.

Returns

Returns 1 on success, else indicates an error.

See also

MGUI_ReadLE64