added more documentation

This commit is contained in:
2009-02-02 04:12:49 +00:00
parent 6affaf4d37
commit 0836d3e319
26 changed files with 520 additions and 631 deletions

View File

@ -31,7 +31,7 @@
# include <limits.h>
#endif
QSE_IMPLEMENT_STD_FUNCTIONS (fio)
QSE_IMPLEMENT_COMMON_FUNCTIONS (fio)
static qse_ssize_t fio_input (int cmd, void* arg, void* buf, qse_size_t size);
static qse_ssize_t fio_output (int cmd, void* arg, void* buf, qse_size_t size);

View File

@ -19,6 +19,8 @@
#include <qse/cmn/lda.h>
#include "mem.h"
QSE_IMPLEMENT_COMMON_FUNCTIONS (lda)
#define lda_t qse_lda_t
#define node_t qse_lda_node_t
#define copier_t qse_lda_copier_t
@ -150,21 +152,6 @@ void qse_lda_fini (lda_t* lda)
}
}
void* qse_lda_getxtn (lda_t* lda)
{
return lda + 1;
}
mmgr_t* qse_lda_getmmgr (lda_t* lda)
{
return lda->mmgr;
}
void qse_lda_setmmgr (lda_t* lda, mmgr_t* mmgr)
{
lda->mmgr = mmgr;
}
int qse_lda_getscale (lda_t* lda)
{
return lda->scale;

View File

@ -19,6 +19,8 @@
#include <qse/cmn/map.h>
#include "mem.h"
QSE_IMPLEMENT_COMMON_FUNCTIONS (map)
#define map_t qse_map_t
#define pair_t qse_map_pair_t
#define copier_t qse_map_copier_t
@ -286,21 +288,6 @@ void qse_map_fini (map_t* map)
QSE_MMGR_FREE (map->mmgr, map->bucket);
}
void* qse_map_getxtn (map_t* map)
{
return map + 1;
}
mmgr_t* qse_map_getmmgr (map_t* map)
{
return map->mmgr;
}
void qse_map_setmmgr (map_t* map, mmgr_t* mmgr)
{
map->mmgr = mmgr;
}
int qse_map_getscale (map_t* map, qse_map_id_t id)
{
QSE_ASSERTX (id == QSE_MAP_KEY || id == QSE_MAP_VAL,
@ -424,7 +411,7 @@ pair_t* qse_map_search (map_t* map, const void* kptr, size_t klen)
return QSE_NULL;
}
int qse_map_put (
static int map_put (
map_t* map, void* kptr, size_t klen,
void* vptr, size_t vlen, pair_t** px)
{
@ -487,7 +474,7 @@ pair_t* qse_map_upsert (
int n;
pair_t* px;
n = qse_map_put (map, kptr, klen, vptr, vlen, &px);
n = map_put (map, kptr, klen, vptr, vlen, &px);
if (n < 0) return QSE_NULL;
return px;
}

View File

@ -29,7 +29,7 @@
# include <sys/wait.h>
#endif
QSE_IMPLEMENT_STD_FUNCTIONS (pio)
QSE_IMPLEMENT_COMMON_FUNCTIONS (pio)
static qse_ssize_t pio_input (int cmd, void* arg, void* buf, qse_size_t size);
static qse_ssize_t pio_output (int cmd, void* arg, void* buf, qse_size_t size);
@ -420,6 +420,8 @@ qse_pio_err_t qse_pio_geterrnum (qse_pio_t* pio)
return pio->errnum;
}
/* TODO: qse_pio_geterrmsg (qse_pio_t* pio) */
const qse_char_t* qse_pio_geterrstr (qse_pio_t* pio)
{
static const qse_char_t* __errstr[] =

View File

@ -19,6 +19,8 @@
#include <qse/cmn/sll.h>
#include "mem.h"
QSE_IMPLEMENT_COMMON_FUNCTIONS (sll)
#define sll_t qse_sll_t
#define node_t qse_sll_node_t
#define copier_t qse_sll_copier_t
@ -137,21 +139,6 @@ void qse_sll_fini (sll_t* sll)
qse_sll_clear (sll);
}
void* qse_sll_getxtn (sll_t* sll)
{
return sll + 1;
}
mmgr_t* qse_sll_getmmgr (sll_t* sll)
{
return sll->mmgr;
}
void qse_sll_setmmgr (sll_t* sll, mmgr_t* mmgr)
{
sll->mmgr = mmgr;
}
int qse_sll_getscale (sll_t* sll)
{
return sll->scale;

View File

@ -19,6 +19,8 @@
#include <qse/cmn/str.h>
#include "mem.h"
QSE_IMPLEMENT_COMMON_FUNCTIONS (str)
qse_str_t* qse_str_open (qse_mmgr_t* mmgr, qse_size_t ext, qse_size_t capa)
{
qse_str_t* str;
@ -104,21 +106,6 @@ int qse_str_yield (qse_str_t* str, qse_xstr_t* buf, int new_capa)
return 0;
}
void* qse_str_getxtn (qse_str_t* str)
{
return str + 1;
}
qse_mmgr_t* qse_str_getmmgr (qse_str_t* str)
{
return str->mmgr;
}
void qse_str_setmmgr (qse_str_t* str, qse_mmgr_t* mmgr)
{
str->mmgr = mmgr;
}
qse_str_sizer_t qse_str_getsizer (qse_str_t* str)
{
return str->sizer;

View File

@ -19,7 +19,7 @@
#include <qse/cmn/tio.h>
#include "mem.h"
QSE_IMPLEMENT_STD_FUNCTIONS (tio)
QSE_IMPLEMENT_COMMON_FUNCTIONS (tio)
qse_tio_t* qse_tio_open (qse_mmgr_t* mmgr, qse_size_t ext)
{
@ -90,9 +90,9 @@ qse_tio_err_t qse_tio_geterrnum (qse_tio_t* tio)
return tio->errnum;
}
const qse_char_t* qse_tio_geterrstr (qse_tio_t* tio)
const qse_char_t* qse_tio_geterrmsg (qse_tio_t* tio)
{
static const qse_char_t* __errstr[] =
static const qse_char_t* __errmsg[] =
{
QSE_T("no error"),
QSE_T("out of memory"),
@ -111,9 +111,9 @@ const qse_char_t* qse_tio_geterrstr (qse_tio_t* tio)
QSE_T("unknown error")
};
return __errstr[
(tio->errnum < 0 || tio->errnum >= QSE_COUNTOF(__errstr))?
QSE_COUNTOF(__errstr) - 1: tio->errnum];
return __errmsg[
(tio->errnum < 0 || tio->errnum >= QSE_COUNTOF(__errmsg))?
QSE_COUNTOF(__errmsg) - 1: tio->errnum];
}
int qse_tio_attachin (qse_tio_t* tio, qse_tio_io_t input, void* arg)