glue_ulong.c File Reference

#include "glue_ulong.h"

Functions
U64HL	ULONG_Add (U64HL variable, U64HL value)
	Add a value to a unsigned 64 bit variable. More...
U64HL	ULONG_Add32 (U64HL variable, U32BIT value)
	Add a 32-bit value to a unsigned 64 bit variable. More...
U64HL	ULONG_Sub (U64HL variable, U64HL value)
	Subtract a value from a unsigned 64 bit variable. It is the responsibility of the caller to make sure the value does not overflow. More...
U64HL	ULONG_Sub32 (U64HL variable, U32BIT value)
	Subtract a 32-bit value from a unsigned 64 bit variable. It is the responsibility of the caller to make sure the value does not overflow. More...
U64HL	ULONG_Mul32 (U64HL variable, U32BIT value)
	Multiply a unsigned 64 bit variable by a 32-bit value. More...
U64HL	ULONG_Div32 (U64HL variable, U32BIT value)
	Divide a unsigned 64 bit variable by a 24-bit value. NOTE: This function will produce invalid values if the divisor requires more than 24 bits (larger than 16777215). More...
U64HL	ULONG_ShiftLeft (U64HL variable, U32BIT value)
	Shift bits left on unsigned 64 bit variable by a 32-bit value. More...
U64HL	ULONG_ShiftRight (U64HL variable, U32BIT value)
	Shift bits right on unsigned 64 bit variable by a 32-bit value. More...
U32BIT	ULONG_Mod32 (U64HL variable, U32BIT value)
	Find the remainer after dividing a unsigned 64 bit variable by a 24-bit value. NOTE: This function will produce invalid values if the divisor requires more than 24 bits (larger than 16777215). More...
S32BIT	ULONG_Compare (U64HL first, U64HL second)
	Compare two variables, returning a value that indicates the result of the comparison. More...
S32BIT	ULONG_Compare32 (U64HL variable, U32BIT value)
	Compare a variable with a 32-bit value, returning a value that indicates the result of the comparison. More...
U64HL	ULONG_Atoi (char *str)
	Convert a string to a unsigned 64 bit. Only the numeric part of the string is converted (up to the first non-digit character). The string value should be less than 2**64-1. More...
void	ULONG_Itoa (U64HL variable, char *str)
	Convert a unsigned 64 bit to a string. The string should be able to hold at least 21 characters, as the largest unsigned 64 bit is 18446744073709551615 (2**64-1). More...

Detailed Description

Date

20/12/2012

Author

Adam Sturtridge

Function Documentation

U64HL ULONG_Add	(	U64HL	variable,
		U64HL	value
	)

Add a value to a unsigned 64 bit variable.

Parameters

variable	Unsigned 64 bit
value	Value to add

Returns

resulting value

U64HL ULONG_Add32	(	U64HL	variable,
		U32BIT	value
	)

Add a 32-bit value to a unsigned 64 bit variable.

Parameters

variable	Unsigned 64 bit
value	Value to add (32 bit)

Returns

resulting value

U64HL ULONG_Atoi

(

char *

str

)

Convert a string to a unsigned 64 bit. Only the numeric part of the string is converted (up to the first non-digit character). The string value should be less than 2**64-1.

Convert a string to unsigned 64 bit. Only the numeric part of the string is converted (up to the first non-digit character). The string value should be less than 2**64-1.

Parameters

str	String value

Returns

Unsigned 64 bit

S32BIT ULONG_Compare	(	U64HL	first,
		U64HL	second
	)

Compare two variables, returning a value that indicates the result of the comparison.

Parameters

first	First unsigned 64 bit to compare
second	Second unsigned 64 bit to compare

Returns

0 if the variables are equal, negative if the first variable is smaller than the second variable, and positive if the first variable is larger than the secodd variable

S32BIT ULONG_Compare32	(	U64HL	variable,
		U32BIT	value
	)

Compare a variable with a 32-bit value, returning a value that indicates the result of the comparison.

Parameters

variable	Unsigned 64 bit to compare
value	32-bit value to compare to

Returns

0 if the variables are equal, negative if the first variable is smaller than the second variable, and positive if the first variable is larger than the second variable

U64HL ULONG_Div32	(	U64HL	variable,
		U32BIT	value
	)

Divide a unsigned 64 bit variable by a 24-bit value. NOTE: This function will produce invalid values if the divisor requires more than 24 bits (larger than 16777215).

Parameters

variable	Unsigned 64 bit
value	Value to divide by (24 bit)

Returns

Nothing

void ULONG_Itoa	(	U64HL	variable,
		char *	str
	)

Convert a unsigned 64 bit to a string. The string should be able to hold at least 21 characters, as the largest unsigned 64 bit is 18446744073709551615 (2**64-1).

Convert unsigned 64 bit to a string. The string should be able to hold at least 21 characters, as the largest unsigned 64 bit is 18446744073709551615 (2**64-1).

Parameters

variable	Unsigned 64 bit
str	Buffer for string value (at least 22 bytes)

Returns

Nothing

U32BIT ULONG_Mod32	(	U64HL	variable,
		U32BIT	value
	)

Find the remainer after dividing a unsigned 64 bit variable by a 24-bit value. NOTE: This function will produce invalid values if the divisor requires more than 24 bits (larger than 16777215).

Parameters

variable	Unsigned 64 bit
value	Value to divide by (24 bit)

Returns

The variable modulo the value

U64HL ULONG_Mul32	(	U64HL	variable,
		U32BIT	value
	)

Multiply a unsigned 64 bit variable by a 32-bit value.

Parameters

variable	Unsigned 64 bit
value	Value to multiply by (32 bit)

Returns

Nothing

U64HL ULONG_ShiftLeft	(	U64HL	variable,
		U32BIT	value
	)

Shift bits left on unsigned 64 bit variable by a 32-bit value.

Parameters

variable	Unsigned 64 bit
value	Value to shift by (32 bit)

Returns

Nothing

U64HL ULONG_ShiftRight	(	U64HL	variable,
		U32BIT	value
	)

Shift bits right on unsigned 64 bit variable by a 32-bit value.

Parameters

variable	Unsigned 64 bit
value	Value to shift by (32 bit)

Returns

Nothing

U64HL ULONG_Sub	(	U64HL	variable,
		U64HL	value
	)

Subtract a value from a unsigned 64 bit variable. It is the responsibility of the caller to make sure the value does not overflow.

Parameters

variable	Unsigned 64 bit
value	Value to subtract

Returns

Nothing

U64HL ULONG_Sub32	(	U64HL	variable,
		U32BIT	value
	)

Subtract a 32-bit value from a unsigned 64 bit variable. It is the responsibility of the caller to make sure the value does not overflow.

Parameters

variable	Unsigned 64 bit
value	Value to subtract (32 bit)

Returns

Nothing