hyung-hwan/qse
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

updated header files for documentation

Browse Source
This commit is contained in:
hyung-hwan 2010-07-14 07:29:02 +00:00
parent f05306ba29
commit 0406471ef0
4 changed files with 75 additions and 58 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
qse/doc/doxygen.css
View File

@ -3,6 +3,7 @@
body, table, div, p, dl { body, table, div, p, dl {
/* font-family: Lucida Grande, Verdana, Geneva, Arial, sans-serif; /* font-family: Lucida Grande, Verdana, Geneva, Arial, sans-serif;
font-size: 90%; */ font-size: 90%; */
font-family: sans-serif;
} }
/* @group Heading Levels */ /* @group Heading Levels */

38
qse/include/qse/cmn/htb.h
View File

@ -1,5 +1,5 @@
/* /*
* $Id: htb.h 331 2010-07-13 11:18:30Z hyunghwan.chung $ * $Id: htb.h 333 2010-07-13 13:29:02Z hyunghwan.chung $
* *
Copyright 2006-2009 Chung, Hyung-Hwan. Copyright 2006-2009 Chung, Hyung-Hwan.
This file is part of QSE. This file is part of QSE.
@ -29,26 +29,33 @@
* chained under the same bucket. * chained under the same bucket.
*/ */
/* values that can be returned by qse_htb_walker_t */ typedef struct qse_htb_t qse_htb_t;
typedef struct qse_htb_pair_t qse_htb_pair_t;
/**
* The qse_htb_walk_t type defines values that the callback function can
* return to control qse_htb_walk().
*/
enum qse_htb_walk_t enum qse_htb_walk_t
{ {
QSE_HTB_WALK_STOP = 0, QSE_HTB_WALK_STOP = 0,
QSE_HTB_WALK_FORWARD = 1 QSE_HTB_WALK_FORWARD = 1
}; };
typedef enum qse_htb_walk_t qse_htb_walk_t;
/**
* The qse_htb_id_t type defines IDs to indicate a key or a value in various
* functions.
*/
enum qse_htb_id_t enum qse_htb_id_t
{ {
QSE_HTB_KEY = 0, QSE_HTB_KEY = 0,
QSE_HTB_VAL = 1 QSE_HTB_VAL = 1
}; };
typedef struct qse_htb_t qse_htb_t;
typedef struct qse_htb_pair_t qse_htb_pair_t;
typedef enum qse_htb_walk_t qse_htb_walk_t;
typedef enum qse_htb_id_t qse_htb_id_t; typedef enum qse_htb_id_t qse_htb_id_t;
/** /**
* The qse_htb_copier_t type defines a pair contruction callback * The qse_htb_copier_t type defines a pair contruction callback.
*/ */
typedef void* (*qse_htb_copier_t) ( typedef void* (*qse_htb_copier_t) (
qse_htb_t* htb /* hash table */, qse_htb_t* htb /* hash table */,
@ -68,15 +75,14 @@ typedef void (*qse_htb_freeer_t) (
/* key hasher */ /* key hasher */
typedef qse_size_t (*qse_htb_hasher_t) ( typedef qse_size_t (*qse_htb_hasher_t) (
qse_htb_t* htb, /**< hash table */ qse_htb_t* htb, /**< hash table */
const void* kptr, /**< pointer to a key */ const void* kptr, /**< key pointer */
qse_size_t klen /**< length of a key in bytes */ qse_size_t klen /**< key length in bytes */
); );
/** /**
* The qse_htb_comper_t type defines a key comparator that is called when * The qse_htb_comper_t type defines a key comparator that is called when
* the htb needs to compare keys. A htb is created with a default comparator * the htb needs to compare keys. A hash table is created with a default
* which performs bitwise comparison between two keys. * comparator which performs bitwise comparison of two keys.
*
* The comparator should return 0 if the keys are the same and a non-zero * The comparator should return 0 if the keys are the same and a non-zero
* integer otherwise. * integer otherwise.
*/ */
@ -91,8 +97,8 @@ typedef int (*qse_htb_comper_t) (
/** /**
* The qse_htb_keeper_t type defines a value keeper that is called when * The qse_htb_keeper_t type defines a value keeper that is called when
* a value is retained in the context that it should be destroyed because * a value is retained in the context that it should be destroyed because
* it is identical to a new value. Two values are identical if their beginning * it is identical to a new value. Two values are identical if their
* pointers and their lengths are equal. * pointers and lengths are equal.
*/ */
typedef void (*qse_htb_keeper_t) ( typedef void (*qse_htb_keeper_t) (
qse_htb_t* htb, /**< hash table */ qse_htb_t* htb, /**< hash table */
@ -434,7 +440,7 @@ int qse_htb_delete (
qse_size_t klen /**< the size of the key */ qse_size_t klen /**< the size of the key */
); );
/* /**
* The qse_htb_clear() function empties a hash table * The qse_htb_clear() function empties a hash table
*/ */
void qse_htb_clear ( void qse_htb_clear (
@ -446,7 +452,7 @@ void qse_htb_clear (
*/ */
void qse_htb_walk ( void qse_htb_walk (
qse_htb_t* htb, /**< hash table */ qse_htb_t* htb, /**< hash table */
qse_htb_walker_t walker, /**< pointer to the function for each pair */ qse_htb_walker_t walker, /**< callback function for each pair */
void* ctx /**< pointer to user-specific data */ void* ctx /**< pointer to user-specific data */
); );

76
qse/include/qse/cmn/rbt.h
View File

@ -28,22 +28,29 @@
* A red-black tree is a self-balancing binary search tree. * A red-black tree is a self-balancing binary search tree.
*/ */
/* values that can be returned by qse_rbt_walker_t */ typedef struct qse_rbt_t qse_rbt_t;
typedef struct qse_rbt_pair_t qse_rbt_pair_t;
/**
* The qse_rbt_walk_t type defines values that the callback function can
* return to control qse_rbt_walk() and qse_rbt_rwalk().
*/
enum qse_rbt_walk_t enum qse_rbt_walk_t
{ {
QSE_RBT_WALK_STOP = 0, QSE_RBT_WALK_STOP = 0,
QSE_RBT_WALK_FORWARD = 1 QSE_RBT_WALK_FORWARD = 1
}; };
typedef enum qse_rbt_walk_t qse_rbt_walk_t;
/**
* The qse_rbt_id_t type defines IDs to indicate a key or a value in various
* functions
*/
enum qse_rbt_id_t enum qse_rbt_id_t
{ {
QSE_RBT_KEY = 0, QSE_RBT_KEY = 0, /**< indicate a key */
QSE_RBT_VAL = 1 QSE_RBT_VAL = 1 /**< indicate a value */
}; };
typedef struct qse_rbt_t qse_rbt_t;
typedef struct qse_rbt_pair_t qse_rbt_pair_t;
typedef enum qse_rbt_walk_t qse_rbt_walk_t;
typedef enum qse_rbt_id_t qse_rbt_id_t; typedef enum qse_rbt_id_t qse_rbt_id_t;
/** /**
@ -66,11 +73,10 @@ typedef void (*qse_rbt_freeer_t) (
/** /**
* The qse_rbt_comper_t type defines a key comparator that is called when * The qse_rbt_comper_t type defines a key comparator that is called when
* the rbt needs to compare keys. A rbt is created with a default comparator * the rbt needs to compare keys. A red-black tree is created with a default
* which performs bitwise comparison between two keys. * comparator which performs bitwise comparison of two keys.
* * The comparator should return 0 if the keys are the same, 1 if the first
* The comparator should return 0 if the keys are the same and a non-zero * key is greater than the second key, -1 otherwise.
* integer otherwise.
*/ */
typedef int (*qse_rbt_comper_t) ( typedef int (*qse_rbt_comper_t) (
qse_rbt_t* rbt, /**< red-black tree */ qse_rbt_t* rbt, /**< red-black tree */
@ -83,8 +89,8 @@ typedef int (*qse_rbt_comper_t) (
/** /**
* The qse_rbt_keeper_t type defines a value keeper that is called when * The qse_rbt_keeper_t type defines a value keeper that is called when
* a value is retained in the context that it should be destroyed because * a value is retained in the context that it should be destroyed because
* it is identical to a new value. Two values are identical if their beginning * it is identical to a new value. Two values are identical if their
* pointers and their lengths are equal. * pointers and lengths are equal.
*/ */
typedef void (*qse_rbt_keeper_t) ( typedef void (*qse_rbt_keeper_t) (
qse_rbt_t* rbt, /**< red-black tree */ qse_rbt_t* rbt, /**< red-black tree */
@ -131,8 +137,8 @@ struct qse_rbt_t
{ {
QSE_DEFINE_COMMON_FIELDS (rbt) QSE_DEFINE_COMMON_FIELDS (rbt)
qse_rbt_copier_t copier[2]; qse_rbt_copier_t copier[2]; /**< key and value copier */
qse_rbt_freeer_t freeer[2]; qse_rbt_freeer_t freeer[2]; /**< key and value freeer */
qse_rbt_comper_t comper; /**< key comparator */ qse_rbt_comper_t comper; /**< key comparator */
qse_rbt_keeper_t keeper; /**< value keeper */ qse_rbt_keeper_t keeper; /**< value keeper */
@ -142,11 +148,20 @@ struct qse_rbt_t
qse_rbt_pair_t nil; /**< internal nil node */ qse_rbt_pair_t nil; /**< internal nil node */
qse_size_t size; qse_size_t size; /**< number of pairs */
qse_rbt_pair_t* root; qse_rbt_pair_t* root; /**< root pair */
}; };
/**
* The QSE_RBT_COPIER_SIMPLE macros defines a copier that remembers the
* pointer and length of data in a pair.
*/
#define QSE_RBT_COPIER_SIMPLE ((qse_rbt_copier_t)1) #define QSE_RBT_COPIER_SIMPLE ((qse_rbt_copier_t)1)
/**
* The QSE_RBT_COPIER_INLINE macros defines a copier that copies data into
* a pair.
*/
#define QSE_RBT_COPIER_INLINE ((qse_rbt_copier_t)2) #define QSE_RBT_COPIER_INLINE ((qse_rbt_copier_t)2)
/** /**
@ -220,7 +235,7 @@ qse_size_t qse_rbt_getsize (
*/ */
int qse_rbt_getscale ( int qse_rbt_getscale (
qse_rbt_t* rbt, /**< red-black tree */ qse_rbt_t* rbt, /**< red-black tree */
qse_rbt_id_t id /**< QSE_RBT_KEY or QSE_RBT_VAL */ qse_rbt_id_t id /**< #QSE_RBT_KEY or #QSE_RBT_VAL */
); );
/** /**
@ -233,7 +248,7 @@ int qse_rbt_getscale (
*/ */
void qse_rbt_setscale ( void qse_rbt_setscale (
qse_rbt_t* rbt, /**< red-black tree */ qse_rbt_t* rbt, /**< red-black tree */
qse_rbt_id_t id, /**< QSE_RBT_KEY or QSE_RBT_VAL */ qse_rbt_id_t id, /**< #QSE_RBT_KEY or #QSE_RBT_VAL */
int scale /**< scale factor in bytes */ int scale /**< scale factor in bytes */
); );
@ -242,7 +257,7 @@ void qse_rbt_setscale (
*/ */
qse_rbt_copier_t qse_rbt_getcopier ( qse_rbt_copier_t qse_rbt_getcopier (
qse_rbt_t* rbt, /**< red-black tree */ qse_rbt_t* rbt, /**< red-black tree */
qse_rbt_id_t id /**< QSE_RBT_KEY or QSE_RBT_VAL */ qse_rbt_id_t id /**< #QSE_RBT_KEY or #QSE_RBT_VAL */
); );
/** /**
@ -256,13 +271,13 @@ qse_rbt_copier_t qse_rbt_getcopier (
*/ */
void qse_rbt_setcopier ( void qse_rbt_setcopier (
qse_rbt_t* rbt, /**< red-black tree */ qse_rbt_t* rbt, /**< red-black tree */
qse_rbt_id_t id, /**< QSE_RBT_KEY or QSE_RBT_VAL */ qse_rbt_id_t id, /**< #QSE_RBT_KEY or #QSE_RBT_VAL */
qse_rbt_copier_t copier /**< element copier */ qse_rbt_copier_t copier /**< callback for copying a key or a value */
); );
qse_rbt_freeer_t qse_rbt_getfreeer ( qse_rbt_freeer_t qse_rbt_getfreeer (
qse_rbt_t* rbt, /**< red-black tree */ qse_rbt_t* rbt, /**< red-black tree */
qse_rbt_id_t id /**< QSE_RBT_KEY or QSE_RBT_VAL */ qse_rbt_id_t id /**< #QSE_RBT_KEY or #QSE_RBT_VAL */
); );
/** /**
@ -271,11 +286,10 @@ qse_rbt_freeer_t qse_rbt_getfreeer (
*/ */
void qse_rbt_setfreeer ( void qse_rbt_setfreeer (
qse_rbt_t* rbt, /**< red-black tree */ qse_rbt_t* rbt, /**< red-black tree */
qse_rbt_id_t id, /**< QSE_RBT_KEY or QSE_RBT_VAL */ qse_rbt_id_t id, /**< #QSE_RBT_KEY or #QSE_RBT_VAL */
qse_rbt_freeer_t freeer /**< an element freeer */ qse_rbt_freeer_t freeer /**< callback for destroying a key or a value */
); );
/** /**
* The qse_rbt_getcomper() function returns the key comparator. * The qse_rbt_getcomper() function returns the key comparator.
*/ */
@ -324,7 +338,7 @@ qse_rbt_pair_t* qse_rbt_search (
/** /**
* The qse_rbt_upsert() function searches red-black tree for the pair with a * The qse_rbt_upsert() function searches red-black tree for the pair with a
* matching key. If one is found, it updates the pair. Otherwise, it inserts * matching key. If one is found, it updates the pair. Otherwise, it inserts
* a new pair with the key and value given. It returns the pointer to the * a new pair with the key and the value given. It returns the pointer to the
* pair updated or inserted. * pair updated or inserted.
* @return a pointer to the updated or inserted pair on success, * @return a pointer to the updated or inserted pair on success,
* QSE_NULL on failure. * QSE_NULL on failure.
@ -388,7 +402,7 @@ int qse_rbt_delete (
qse_size_t klen /**< key size */ qse_size_t klen /**< key size */
); );
/* /**
* The qse_rbt_clear() function empties a red-black tree. * The qse_rbt_clear() function empties a red-black tree.
*/ */
void qse_rbt_clear ( void qse_rbt_clear (
@ -401,7 +415,7 @@ void qse_rbt_clear (
*/ */
void qse_rbt_walk ( void qse_rbt_walk (
qse_rbt_t* rbt, /**< red-black tree */ qse_rbt_t* rbt, /**< red-black tree */
qse_rbt_walker_t walker, /**< pointer to the function for each pair */ qse_rbt_walker_t walker, /**< callback function for each pair */
void* ctx /**< pointer to user-specific data */ void* ctx /**< pointer to user-specific data */
); );
@ -411,7 +425,7 @@ void qse_rbt_walk (
*/ */
void qse_rbt_rwalk ( void qse_rbt_rwalk (
qse_rbt_t* rbt, /**< red-black tree */ qse_rbt_t* rbt, /**< red-black tree */
qse_rbt_walker_t walker, /**< pointer to the function for each pair */ qse_rbt_walker_t walker, /**< callback function for each pair */
void* ctx /**< pointer to user-specific data */ void* ctx /**< pointer to user-specific data */
); );

6
qse/lib/cmn/rbt.c
View File

@ -503,7 +503,7 @@ static pair_t* change_pair_val (
} }
else else
{ {
QSE_ASSERT (parent->parent->right == pair); QSE_ASSERT (pair->parent->right == pair);
pair->parent->right = p; pair->parent->right = p;
} }
} }
@ -535,8 +535,6 @@ static pair_t* change_pair_val (
static pair_t* insert ( static pair_t* insert (
rbt_t* rbt, void* kptr, size_t klen, void* vptr, size_t vlen, int opt) rbt_t* rbt, void* kptr, size_t klen, void* vptr, size_t vlen, int opt)
{ {
/* TODO: enhance this. ues comper... etc */
pair_t* xcur = rbt->root; pair_t* xcur = rbt->root;
pair_t* xpar = QSE_NULL; pair_t* xpar = QSE_NULL;
pair_t* xnew; pair_t* xnew;
@ -546,8 +544,6 @@ static pair_t* insert (
int n = rbt->comper (rbt, kptr, klen, xcur->kptr, xcur->klen); int n = rbt->comper (rbt, kptr, klen, xcur->kptr, xcur->klen);
if (n == 0) if (n == 0)
{ {
/* TODO: handle various cases depending on insert types.
* return error. update value. */
switch (opt) switch (opt)
{ {
case UPSERT: case UPSERT: