typeids.h File Reference

GATE type ID specifications. More...

#include "gate/gate_core_api.h"
#include "gate/gatetypes.h"

Typedefs
typedef char const *	gate_type_sig_t

Functions
GATE_CORE_API gate_size_t	gate_type_length (gate_type_id_t value_type_id)
	Returns the byte size of a native GATE type.
GATE_CORE_API gate_size_t	gate_type_aligned_length (gate_type_id_t value_type_id)
	Returns the byte size of a native GATE type with default system alignment padding.
GATE_CORE_API gate_result_t	gate_type_init (gate_type_id_t value_type_id, void *ptr_value)
	Initializes a native GATE type with its default value.
GATE_CORE_API gate_result_t	gate_type_copy (gate_type_id_t value_type_id, void *ptr_dst, void const *ptr_src)
	Copies the contents of a native GATE type from a source to a destination value.
GATE_CORE_API gate_result_t	gate_type_release (gate_type_id_t value_type_id, void *ptr_value)
	Releases all resources of a data type.
GATE_CORE_API gate_type_sig_t	gate_type_signature (gate_type_id_t value_type_id)
	Returns a text signature of the given native type-id.
GATE_CORE_API gate_bool_t	gate_type_signature_equals (gate_type_sig_t sig1, gate_type_sig_t sig2)
	Evaluates if two GATE type signatures are equal.

Detailed Description

GATE type ID specifications.

Typedef Documentation

gate_type_sig_t

typedef char const* gate_type_sig_t

native GATE type signature

Function Documentation

gate_type_length()

GATE_CORE_API gate_size_t gate_type_length

(

gate_type_id_t

value_type_id

)

Returns the byte size of a native GATE type.

Parameters

value_type_id

GATE native type-identifier

Returns

length in byte

gate_type_aligned_length()

GATE_CORE_API gate_size_t gate_type_aligned_length

(

gate_type_id_t

value_type_id

)

Returns the byte size of a native GATE type with default system alignment padding.

Parameters

value_type_id

GATE native type-identifier

Returns

aligned length in bytes

gate_type_init()

GATE_CORE_API gate_result_t gate_type_init	(	gate_type_id_t	value_type_id,
		void *	ptr_value )

Initializes a native GATE type with its default value.

Parameters

value_type_id	GATE native type-identifier
ptr_value	pointer to native type

Returns

result code (see GATE_RESULT_*)

gate_type_copy()

GATE_CORE_API gate_result_t gate_type_copy	(	gate_type_id_t	value_type_id,
		void *	ptr_dst,
		void const *	ptr_src )

Copies the contents of a native GATE type from a source to a destination value.

Parameters

value_type_id	GATE native type-identifier
ptr_dst	pointer to destination native type
ptr_src	pointer to source native type

Returns

result code (see GATE_RESULT_*)

gate_type_release()

GATE_CORE_API gate_result_t gate_type_release	(	gate_type_id_t	value_type_id,
		void *	ptr_value )

Releases all resources of a data type.

Parameters

[in]	value_type_id	GATE native type-identifier
[in]	ptr_value	pointer to native type

Returns

result code (see GATE_RESULT_*)

gate_type_signature()

GATE_CORE_API gate_type_sig_t gate_type_signature

(

gate_type_id_t

value_type_id

)

Returns a text signature of the given native type-id.

Parameters

value_type_id

GATE native type-identifier

Returns

static type signature

gate_type_signature_equals()

GATE_CORE_API gate_bool_t gate_type_signature_equals	(	gate_type_sig_t	sig1,
		gate_type_sig_t	sig2 )

Evaluates if two GATE type signatures are equal.

Parameters

[in]	sig1	GATE native type-identifier to be compared
[in]	sig2	other GATE native type-identifier to be compared

Returns

true of both type signatures are equal, otherwise false