From febbaadc31f89bf5f96be17d26065c4a911e1952 Mon Sep 17 00:00:00 2001 From: hyung-hwan Date: Tue, 30 Sep 2008 04:01:15 +0000 Subject: [PATCH] cleaned up a few type definitions --- ase/include/ase/cmn/map.h | 38 +++++---- ase/include/ase/cmn/sll.h | 9 ++- ase/include/ase/macros.h | 26 ++++++- ase/include/ase/types.h | 158 +++++++++++++++++++++----------------- 4 files changed, 142 insertions(+), 89 deletions(-) diff --git a/ase/include/ase/cmn/map.h b/ase/include/ase/cmn/map.h index dba6b61a..f85331a5 100644 --- a/ase/include/ase/cmn/map.h +++ b/ase/include/ase/cmn/map.h @@ -1,5 +1,5 @@ /* - * $Id: map.h 397 2008-09-29 07:11:08Z baconevi $ + * $Id: map.h 398 2008-09-29 10:01:15Z baconevi $ * * {License} */ @@ -42,19 +42,29 @@ typedef struct ase_map_pair_t ase_map_pair_t; typedef enum ase_map_walk_t ase_map_walk_t; typedef enum ase_map_id_t ase_map_id_t; -/* data copier */ +/****b* ase.cmn.map/ase_map_copier_t + * NAME + * ase_map_copier_t - define a pair contruction callback + * SYNOPSIS + */ typedef void* (*ase_map_copier_t) ( - ase_map_t* map, - void* dptr, - ase_size_t dlen + ase_map_t* map /* a map */, + void* dptr /* the pointer to a key or a value */, + ase_size_t dlen /* the length of a key or a value */ ); +/******/ -/* data freeer */ +/****b* ase.cmn.map/ase_map_freeer_t + * NAME + * ase_map_freeer_t - define a key/value destruction callback + * SYNOPSIS + */ typedef void (*ase_map_freeer_t) ( - ase_map_t* map, - void* dptr, - ase_size_t dlen + ase_map_t* map /* a map */, + void* dptr /* the pointer to a key or a value */, + ase_size_t dlen /* the length of a key or a value */ ); +/******/ /* key hasher */ typedef ase_size_t (*ase_map_hasher_t) ( @@ -78,11 +88,11 @@ typedef ase_size_t (*ase_map_hasher_t) ( * SYNOPSIS */ typedef int (*ase_map_comper_t) ( - ase_map_t* map /* a map */, - const void* kptr1 /* the pointer to a key */, - ase_size_t klen1 /* the length of a key */, - const void* kptr2 /* the pointer to a key */, - ase_size_t klen2 /* the length of a key */ + ase_map_t* map /* a map */, + const void* kptr1 /* the pointer to a key */, + ase_size_t klen1 /* the length of a key */, + const void* kptr2 /* the pointer to a key */, + ase_size_t klen2 /* the length of a key */ ); /******/ diff --git a/ase/include/ase/cmn/sll.h b/ase/include/ase/cmn/sll.h index 06dca613..c2756843 100644 --- a/ase/include/ase/cmn/sll.h +++ b/ase/include/ase/cmn/sll.h @@ -196,11 +196,11 @@ extern "C" { * the pointer to the singly linked list created. * * RETURN - * the pointer to a newly created singly linked list on success. - * ASE_NULL on failure. + * The ase_sll_open() function returns the pointer to a new singly linked + * list on success and ASE_NULL on failure. * * NOTES - * In the debug build, it fails the assertion if ASE_MMGR_SETMMGR() returns + * In the debug build, it fails an assertion if ASE_MMGR_GETMMGR() returns * ASE_NULL when ASE_NULL is passed as the first parameter. In the release * build, it returns ASE_NULL if such a thing happens. * @@ -217,7 +217,8 @@ ase_sll_t* ase_sll_open ( * ase_sll_close - destroy a singly linked list * * DESCRIPTION - * The ase_sll_close() function destroys a singly linked list + * The ase_sll_close() function destroys a singly linked list freeing up + * the memory. * * SYNOPSIS */ diff --git a/ase/include/ase/macros.h b/ase/include/ase/macros.h index 6d1b38d1..8185ed2c 100644 --- a/ase/include/ase/macros.h +++ b/ase/include/ase/macros.h @@ -1,5 +1,5 @@ /* - * $Id: macros.h 381 2008-09-24 11:07:24Z baconevi $ + * $Id: macros.h 398 2008-09-29 10:01:15Z baconevi $ * * {License} */ @@ -16,6 +16,30 @@ #define ASE_NULL ((void*)0) #endif +/****d* ase/ASE_TRUE,ASE_FALSE + * NAME + * ASE_TRUE - represent a boolean true + * ASE_FALSE - represent a boolean false + ****** + */ +#define ASE_TRUE (0 == 0) +#define ASE_FALSE (0 != 0) + + +/****d* ase/ASE_ALIVE,ASE_ZOMBIE,ASE_DEAD + * NAME + * ASE_ALIVE - represent a living state + * ASE_ZOMBIE - represent a zombie state + * ASE_DEAD - represent a dead state + ****** + */ +#define ASE_ALIVE 1 +#define ASE_ZOMBIE 0 +#define ASE_DEAD -1 + + +#defien AES_MCHAR_EOF ((ase_mcint_t)-1) +#defien AES_WCHAR_EOF ((ase_wcint_t)-1) #define ASE_CHAR_EOF ((ase_cint_t)-1) #define ASE_SIZEOF(n) (sizeof(n)) diff --git a/ase/include/ase/types.h b/ase/include/ase/types.h index b0723c01..8b439632 100644 --- a/ase/include/ase/types.h +++ b/ase/include/ase/types.h @@ -1,5 +1,5 @@ /* - * $Id: types.h 389 2008-09-26 08:01:24Z baconevi $ + * $Id: types.h 398 2008-09-29 10:01:15Z baconevi $ * * {License} */ @@ -31,39 +31,32 @@ #error unsupported operating system #endif -/** - * @brief a boolean type - * - * This type defines a boolean type as represented - * by #ASE_TRUE and #ASE_FALSE. +/****t* ase/ase_bool_t + * NAME + * ase_bool_t - define a boolean type + * DESCRIPTION + * The ase_bool_t type defines a boolean type that can represent ASE_TRUE + * and ASE_FALSE. + ****** */ typedef int ase_bool_t; -/** Represents a boolean true value */ -#define ASE_TRUE (0 == 0) -/** Represents a boolean false value */ -#define ASE_FALSE (0 != 0) - -/** - * @brief a tri-state type - * - * This type defines a tri-state type as represented - * by ASE_ALIVE, ASE_ZOMBIE, and ASE_DEAD. +/****t* ase/ase_tri_t + * NAME + * ase_tri_t - define a tri-state type + * DESCRIPTION + * The ase_tri_t type defines a tri-state type that can represent ASE_ALIVE, + * ASE_ZOMBIE, and ASE_DEAD. + ****** */ typedef int ase_tri_t; -#define ASE_ALIVE 1 -#define ASE_ZOMBIE 0 -#define ASE_DEAD -1 -/** - * @typedef ase_int_t - * @brief a signed integer type that can hold a pointer +/****t* ase/ase_int_t,ase_uint_t + * NAME + * ase_int_t - define a signed integer type as large as a pointer type + * ase_uint_t - define an unsigned integer type as large as a pointer type + ****** */ -/** - * @typedef ase_uint_t - * @brief a unsigned integer type that can hold a pointer - */ - #if (defined(hpux) || defined(__hpux) || defined(__hpux__)) && (ASE_SIZEOF_VOID_P == ASE_SIZEOF_LONG) typedef long ase_int_t; typedef unsigned long ase_uint_t; @@ -89,16 +82,12 @@ typedef int ase_tri_t; #error unsupported pointer size #endif - -/** - * @typedef ase_long_t - * @brief the largest signed integer type supported by the system +/****t* ase/ase_long_t,ase_ulong_t + * NAME + * ase_long_t - define the largest signed integer type supported + * ase_ulong_t - define the largest unsigned integer type supported + ****** */ -/** - * @typedef ase_ulong_t - * @brief the largest unsigned integer type supported by the system - */ - #if ASE_SIZEOF_LONG_LONG != 0 typedef long long ase_long_t; typedef unsigned long long ase_ulong_t; @@ -110,13 +99,11 @@ typedef int ase_tri_t; typedef unsigned long ase_ulong_t; #endif -/** - * @typedef ase_int8_t - * @brief an 8-bit signed integer type - */ -/** - * @typedef ase_uint8_t - * @brief an 8-bit unsigned integer type +/****t* ase/ase_int8_t,ase_uint8_t + * NAME + * ase_int8_t - define an 8-bit signed integer type + * ase_uint8_t - define an 8-bit unsigned integer type + ****** */ #if ASE_SIZEOF_CHAR == 1 typedef char ase_int8_t; @@ -126,13 +113,11 @@ typedef int ase_tri_t; typedef unsigned __int8 ase_uint8_t; #endif -/** - * @typedef ase_int16_t - * @brief an 16-bit signed integer type - */ -/** - * @typedef ase_uint16_t - * @brief an 16-bit unsigned integer type +/****t* ase/ase_int16_t,ase_uint16_t + * NAME + * ase_int16_t - define a 16-bit signed integer type + * ase_uint16_t - define a 16-bit unsigned integer type + ****** */ #if ASE_SIZEOF_SHORT == 2 typedef short ase_int16_t; @@ -142,13 +127,11 @@ typedef int ase_tri_t; typedef unsigned __int16 ase_uint16_t; #endif -/** - * @typedef ase_int32_t - * @brief an 32-bit signed integer type - */ -/** - * @typedef ase_uint32_t - * @brief an 32-bit unsigned integer type +/****t* ase/ase_int32_t,ase_uint32_t + * NAME + * ase_int32_t - define a 32-bit signed integer type + * ase_uint32_t - define a 32-bit unsigned integer type + ****** */ #if ASE_SIZEOF_INT == 4 typedef int ase_int32_t; @@ -161,13 +144,11 @@ typedef int ase_tri_t; typedef unsigned __int32 ase_uint32_t; #endif -/** - * @typedef ase_int64_t - * @brief an 64-bit signed integer type - */ -/** - * @typedef ase_uint64_t - * @brief an 64-bit unsigned integer type +/****t* ase/ase_int64_t,ase_uint64_t + * NAME + * ase_int64_t - define a 64-bit signed integer type + * ase_uint64_t - define a 64-bit unsigned integer type + ****** */ #if ASE_SIZEOF_INT == 8 #define ASE_HAVE_INT64_T @@ -213,13 +194,32 @@ typedef int ase_tri_t; typedef unsigned __int128 ase_uint128_t; #endif -/** an 8-bit unsigned integer type */ +/****t* ase/ase_byte_t + * NAME + * ase_word_t - define a byte type + ****** + */ typedef ase_uint8_t ase_byte_t; -/** an unsigned integer type that can hold a pointer value */ + +/****t* ase/ase_size_t + * NAME + * ase_size_t - define an unsigned integer type that can hold a pointer value + ****** + */ typedef ase_uint_t ase_size_t; -/** an signed integer type that can hold a pointer value */ + +/****t* ase/ase_ssize_t + * NAME + * ase_ssize_t - define an signed integer type that can hold a pointer value + ****** + */ typedef ase_int_t ase_ssize_t; -/** an integer type identical to ase_uint_t */ + +/****t* ase/ase_word_t + * NAME + * ase_word_t - define an integer type identical to ase_uint_t + ****** + */ typedef ase_uint_t ase_word_t; /* floating-point number */ @@ -236,10 +236,22 @@ typedef ase_uint_t ase_word_t; typedef double ase_real_t; #endif -/* character types */ +/****t* ase/ase_mchar_t,ase_mcint_t + * NAME + * ase_mchar_t - define a multi-byte character + * ase_mcint_t - define a type that can hold ase_mchar_t and ASE_MCHAR_EOF + ****** + */ typedef char ase_mchar_t; typedef int ase_mcint_t; +/****t* ase/ase_wchar_t,ase_wcint_t + * NAME + * ase_wchar_t - define a wide character + * ase_wcint_t - define a type that can hold ase_wchar_t and ASE_WCHAR_EOF + ****** + */ +typedef char ase_mchar_t; #if defined(__cplusplus) && (!defined(_MSC_VER) || (defined(_MSC_VER)&&defined(_NATIVE_WCHAR_T_DEFINED))) /* C++ */ @@ -289,6 +301,12 @@ typedef int ase_mcint_t; #error unsupported size of wchar_t #endif +/****t* ase/ase_char_t,ase_cint_t + * NAME + * ase_char_t - define a character + * ase_cint_t - define a type that can hold ase_char_t and ASE_CHAR_EOF + ****** + */ #if defined(_WIN32) && (defined(UNICODE)||defined(_UNICODE)) #define ASE_CHAR_IS_WCHAR typedef ase_wchar_t ase_char_t; @@ -334,7 +352,7 @@ typedef ase_cint_t (*ase_toccls_t) (void* data, ase_cint_t c); /****t* ase/ase_xstr_t * NAME - * ase_xstr_t - combile a pointer and length + * ase_xstr_t - combine a pointer and length * * SYNOPSIS */