Main Page | Modules | File List | Globals

GDSL types


Typedefs

typedef void * gdsl_element_t
 GDSL element type.

typedef gdsl_element_t(* gdsl_alloc_func_t )(void *USER_DATA)
 GDSL Alloc element function type.

typedef void(* gdsl_free_func_t )(gdsl_element_t E)
 GDSL Free element function type.

typedef gdsl_element_t(* gdsl_copy_func_t )(const gdsl_element_t E)
 GDSL Copy element function type.

typedef int(* gdsl_map_func_t )(const gdsl_element_t E, void *USER_DATA)
 GDSL Map element function type.

typedef int(* gdsl_compare_func_t )(const gdsl_element_t E, void *VALUE)
 GDSL Comparison element function type.

typedef void(* gdsl_write_func_t )(const gdsl_element_t E, FILE *OUTPUT_FILE, void *USER_DATA)
 GDSL Write element function type.

typedef unsigned long int ulong

Enumerations

enum  gdsl_constant_t {
  GDSL_ERR_MEM_ALLOC = -1, GDSL_MAP_STOP = 0, GDSL_MAP_CONT = 1, GDSL_INSERTED,
  GDSL_FOUND
}
 GDSL Constants. More...

enum  bool { FALSE = 0, TRUE = 1 }


Typedef Documentation

typedef gdsl_element_t(* gdsl_alloc_func_t)(void* USER_DATA )
 

GDSL Alloc element function type.

This function type is for allocating a new gdsl_element_t variable. The USER_DATA argument should be used to fill-in the new element.

Parameters:
USER_DATA user data used to create the new element
Returns:
the newly allocated element in case of success.

NULL in case of failure.

See also:
gdsl_free_func_t

Definition at line 86 of file gdsl_types.h.

typedef int(* gdsl_compare_func_t)(const gdsl_element_t E, void* VALUE )
 

GDSL Comparison element function type.

This function type is used to compare a gdsl_element_t variable with a user value. The E argument is always the one in the GDSL data structure, VALUE is always the one the user wants to compare E with.

Parameters:
E The gdsl_element_t variable contained into the data structure to compare from
VALUE The user data to compare E with
Returns:
< 0 if E is assumed to be less than VALUE.

0 if E is assumed to be equal to VALUE.

> 0 if E is assumed to be greather than VALUE.

Definition at line 153 of file gdsl_types.h.

typedef gdsl_element_t(* gdsl_copy_func_t)(const gdsl_element_t E )
 

GDSL Copy element function type.

This function type is for copying gdsl_element_t variables.

Parameters:
E The gdsl_element_t variable to copy
Returns:
the copied element in case of success.

NULL in case of failure.

Definition at line 117 of file gdsl_types.h.

typedef void* gdsl_element_t
 

GDSL element type.

All GDSL internal data structures contains a field of this type. This field is for GDSL users to store their data into GDSL data structures.

Definition at line 72 of file gdsl_types.h.

typedef void(* gdsl_free_func_t)(gdsl_element_t E )
 

GDSL Free element function type.

This function type is for freeing a gdsl_element_t variable. The element must have been previously allocated by a function of gdsl_alloc_func_t type. A free function according to gdsl_free_func_t must free the ressources allocated by the corresponding call to the function of type gdsl_alloc_func_t. The GDSL functions doesn't check if E != NULL before calling this function.

Parameters:
E The element to deallocate
See also:
gdsl_alloc_func_t

Definition at line 104 of file gdsl_types.h.

typedef int(* gdsl_map_func_t)(const gdsl_element_t E, void* USER_DATA )
 

GDSL Map element function type.

This function type is for mapping a gdsl_element_t variable from a GDSL data structure. The optional USER_DATA could be used to do special thing if needed.

Parameters:
E The actually mapped gdsl_element_t variable
USER_DATA User's datas
Returns:
GDSL_MAP_STOP if the parsing must be stopped.

GDSL_MAP_CONT if the parsing must continue.

Definition at line 133 of file gdsl_types.h.

typedef void(* gdsl_write_func_t)(const gdsl_element_t E, FILE* OUTPUT_FILE, void* USER_DATA )
 

GDSL Write element function type.

This function type is for writing a gdsl_element_t E to OUTPUT_FILE. Additional USER_DATA could be passed to it.

Parameters:
E The gdsl_element_t variable to write
OUTPUT_FILE The FILE where to write E
USER_DATA User's datas

Definition at line 168 of file gdsl_types.h.

typedef unsigned long int ulong
 

Definition at line 187 of file gdsl_types.h.


Enumeration Type Documentation

enum bool
 

GDSL boolean type. Defines _NO_LIBGDSL_TYPES_ at compilation time if you don't want them.

Enumeration values:
FALSE  FALSE boolean value
TRUE  TRUE boolean value

Definition at line 210 of file gdsl_types.h.

enum gdsl_constant_t
 

GDSL Constants.

Enumeration values:
GDSL_ERR_MEM_ALLOC  Memory allocation error
GDSL_MAP_STOP  For stopping a parsing function
GDSL_MAP_CONT  For continuing a parsing function
GDSL_INSERTED  To indicate an inserted value
GDSL_FOUND  To indicate a founded value

Definition at line 47 of file gdsl_types.h.


Generated on Fri Oct 1 18:54:53 2004 for GDSL by doxygen 1.3.5