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

revised docs

Browse Source
This commit is contained in:
hyung-hwan
2013-01-12 16:46:12 +00:00
parent 4581bf1e4e
commit ef6d295cac
49 changed files with 849 additions and 312 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
qse/include/Makefile.in
View File

@ -187,6 +187,8 @@ QSE_SIZEOF_INT = @QSE_SIZEOF_INT@
QSE_SIZEOF_LONG = @QSE_SIZEOF_LONG@
QSE_SIZEOF_LONG_DOUBLE = @QSE_SIZEOF_LONG_DOUBLE@
QSE_SIZEOF_LONG_LONG = @QSE_SIZEOF_LONG_LONG@
QSE_SIZEOF_OFF64_T = @QSE_SIZEOF_OFF64_T@
QSE_SIZEOF_OFF_T = @QSE_SIZEOF_OFF_T@
QSE_SIZEOF_SHORT = @QSE_SIZEOF_SHORT@
QSE_SIZEOF_VOID_P = @QSE_SIZEOF_VOID_P@
QSE_SIZEOF_WCHAR_T = @QSE_SIZEOF_WCHAR_T@

2
qse/include/qse/Makefile.in
View File

@ -222,6 +222,8 @@ QSE_SIZEOF_INT = @QSE_SIZEOF_INT@
QSE_SIZEOF_LONG = @QSE_SIZEOF_LONG@
QSE_SIZEOF_LONG_DOUBLE = @QSE_SIZEOF_LONG_DOUBLE@
QSE_SIZEOF_LONG_LONG = @QSE_SIZEOF_LONG_LONG@
QSE_SIZEOF_OFF64_T = @QSE_SIZEOF_OFF64_T@
QSE_SIZEOF_OFF_T = @QSE_SIZEOF_OFF_T@
QSE_SIZEOF_SHORT = @QSE_SIZEOF_SHORT@
QSE_SIZEOF_VOID_P = @QSE_SIZEOF_VOID_P@
QSE_SIZEOF_WCHAR_T = @QSE_SIZEOF_WCHAR_T@

2
qse/include/qse/awk/Makefile.in
View File

@ -182,6 +182,8 @@ QSE_SIZEOF_INT = @QSE_SIZEOF_INT@
QSE_SIZEOF_LONG = @QSE_SIZEOF_LONG@
QSE_SIZEOF_LONG_DOUBLE = @QSE_SIZEOF_LONG_DOUBLE@
QSE_SIZEOF_LONG_LONG = @QSE_SIZEOF_LONG_LONG@
QSE_SIZEOF_OFF64_T = @QSE_SIZEOF_OFF64_T@
QSE_SIZEOF_OFF_T = @QSE_SIZEOF_OFF_T@
QSE_SIZEOF_SHORT = @QSE_SIZEOF_SHORT@
QSE_SIZEOF_VOID_P = @QSE_SIZEOF_VOID_P@
QSE_SIZEOF_WCHAR_T = @QSE_SIZEOF_WCHAR_T@

11
qse/include/qse/awk/awk.h
View File

@ -1440,10 +1440,18 @@ QSE_EXPORT int qse_awk_close (
qse_awk_t* awk /**< awk */
);
/**
* The qse_awk_getmmgr() function gets the memory manager used in
* qse_awk_open().
*/
QSE_EXPORT qse_mmgr_t* qse_awk_getmmgr (
qse_awk_t* awk
);
/**
* The qse_awk_getxtn() function gets the poniter to the beginning
* of the extension area created with qse_awk_open ().
*/
QSE_EXPORT void* qse_awk_getxtn (
qse_awk_t* awk
);
@ -2101,7 +2109,8 @@ QSE_EXPORT qse_mmgr_t* qse_awk_rtx_getmmgr (
);
/**
* The qse_awk_rtx_getxtn() function gets the pointer to the extension block.
* The qse_awk_rtx_getxtn() function gets the pointer to the extension area
* created with qse_awk_rtx_open().
*/
QSE_EXPORT void* qse_awk_rtx_getxtn (
qse_awk_rtx_t* rtx /**< runtime context */

22
qse/include/qse/awk/std.h
View File

@ -35,15 +35,14 @@
*/
/**
* The qse_awk_parsestd_type_t type defines the types of source I/O.
* The qse_awk_parsestd_type_t type defines standard source I/O types.
*/
enum qse_awk_parsestd_type_t
{
QSE_AWK_PARSESTD_NULL = 0, /**< pseudo-value to indicate no script */
QSE_AWK_PARSESTD_FILE = 1, /**< script file */
QSE_AWK_PARSESTD_FILE = 1, /**< file */
QSE_AWK_PARSESTD_STR = 2 /**< length-bounded string */
};
typedef enum qse_awk_parsestd_type_t qse_awk_parsestd_type_t;
/**
@ -59,6 +58,10 @@ struct qse_awk_parsestd_t
{
/** file path to open. #QSE_NULL or '-' for stdin/stdout. */
const qse_char_t* path;
/** a stream created with the file path is set with this
* cmgr if it is not #QSE_NULL. */
qse_cmgr_t* cmgr;
} file;
/**
@ -73,10 +76,6 @@ struct qse_awk_parsestd_t
*/
qse_xstr_t str;
} u;
/* the streams created with the file path is set with this
* cmgr if it is not #QSE_NULL. */
qse_cmgr_t* cmgr;
};
typedef struct qse_awk_parsestd_t qse_awk_parsestd_t;
@ -106,9 +105,9 @@ QSE_EXPORT qse_awk_t* qse_awk_openstdwithmmgr (
);
/**
* The qse_awk_getxtnstd() gets the pointer to extension space.
* Note that you must not call qse_awk_getxtn() for an awk object
* created with qse_awk_openstd() and qse_awk_openstdwithmmgr().
* The qse_awk_getxtnstd() gets the pointer to extension area created with
* qse_awk_openstd() or qse_awk_openstdwithmmgr(). You must not call
* qse_awk_getxtn() for sunch an object.
*/
QSE_EXPORT void* qse_awk_getxtnstd (
qse_awk_t* awk
@ -158,7 +157,8 @@ QSE_EXPORT qse_awk_rtx_t* qse_awk_rtx_openstd (
);
/**
* The qse_awk_rtx_getxtnstd() function gets the pointer to extension space.
* The qse_awk_rtx_getxtnstd() function gets the pointer to extension area
* created with qse_awk_rtx_openstd().
*/
QSE_EXPORT void* qse_awk_rtx_getxtnstd (
qse_awk_rtx_t* rtx

2
qse/include/qse/cmn/Makefile.in
View File

@ -187,6 +187,8 @@ QSE_SIZEOF_INT = @QSE_SIZEOF_INT@
QSE_SIZEOF_LONG = @QSE_SIZEOF_LONG@
QSE_SIZEOF_LONG_DOUBLE = @QSE_SIZEOF_LONG_DOUBLE@
QSE_SIZEOF_LONG_LONG = @QSE_SIZEOF_LONG_LONG@
QSE_SIZEOF_OFF64_T = @QSE_SIZEOF_OFF64_T@
QSE_SIZEOF_OFF_T = @QSE_SIZEOF_OFF_T@
QSE_SIZEOF_SHORT = @QSE_SIZEOF_SHORT@
QSE_SIZEOF_VOID_P = @QSE_SIZEOF_VOID_P@
QSE_SIZEOF_WCHAR_T = @QSE_SIZEOF_WCHAR_T@

4
qse/include/qse/config.h.in
View File

@ -622,10 +622,10 @@
your system. */
#undef PTHREAD_CREATE_JOINABLE
/* char is mchar */
/* The default character type is the multi-byte character type */
#undef QSE_CHAR_IS_MCHAR
/* char is wchar */
/* The default character type is the wide character type */
#undef QSE_CHAR_IS_WCHAR
/* use the bundled unicode routines */

2
qse/include/qse/net/Makefile.in
View File

@ -180,6 +180,8 @@ QSE_SIZEOF_INT = @QSE_SIZEOF_INT@
QSE_SIZEOF_LONG = @QSE_SIZEOF_LONG@
QSE_SIZEOF_LONG_DOUBLE = @QSE_SIZEOF_LONG_DOUBLE@
QSE_SIZEOF_LONG_LONG = @QSE_SIZEOF_LONG_LONG@
QSE_SIZEOF_OFF64_T = @QSE_SIZEOF_OFF64_T@
QSE_SIZEOF_OFF_T = @QSE_SIZEOF_OFF_T@
QSE_SIZEOF_SHORT = @QSE_SIZEOF_SHORT@
QSE_SIZEOF_VOID_P = @QSE_SIZEOF_VOID_P@
QSE_SIZEOF_WCHAR_T = @QSE_SIZEOF_WCHAR_T@

2
qse/include/qse/sed/Makefile.in
View File

@ -182,6 +182,8 @@ QSE_SIZEOF_INT = @QSE_SIZEOF_INT@
QSE_SIZEOF_LONG = @QSE_SIZEOF_LONG@
QSE_SIZEOF_LONG_DOUBLE = @QSE_SIZEOF_LONG_DOUBLE@
QSE_SIZEOF_LONG_LONG = @QSE_SIZEOF_LONG_LONG@
QSE_SIZEOF_OFF64_T = @QSE_SIZEOF_OFF64_T@
QSE_SIZEOF_OFF_T = @QSE_SIZEOF_OFF_T@
QSE_SIZEOF_SHORT = @QSE_SIZEOF_SHORT@
QSE_SIZEOF_VOID_P = @QSE_SIZEOF_VOID_P@
QSE_SIZEOF_WCHAR_T = @QSE_SIZEOF_WCHAR_T@

42
qse/include/qse/sed/std.h
View File

@ -37,40 +37,46 @@
*/
/**
* The qse_sed_iostd_t type defines standard I/O resources.
* The qse_sed_iostd_type_t type defines types of standard
* I/O resources.
*/
typedef struct qse_sed_iostd_t qse_sed_iostd_t;
enum qse_sed_iostd_type_t
{
QSE_SED_IOSTD_NULL, /**< null resource type */
QSE_SED_IOSTD_FILE, /**< file */
QSE_SED_IOSTD_STR, /**< string */
QSE_SED_IOSTD_SIO /**< sio */
};
typedef enum qse_sed_iostd_type_t qse_sed_iostd_type_t;
/**
* The qse_sed_iostd_t type defines a standard I/O resource.
*/
struct qse_sed_iostd_t
{
enum
{
QSE_SED_IOSTD_NULL, /** invalid resource */
QSE_SED_IOSTD_FILE,
QSE_SED_IOSTD_STR,
QSE_SED_IOSTD_SIO
} type;
qse_sed_iostd_type_t type; /**< resource type */
union
{
struct
{
const qse_char_t* path;
qse_cmgr_t* cmgr;
} file;
const qse_char_t* path; /**< file path */
qse_cmgr_t* cmgr; /**< cmgr for the file */
} file;
qse_xstr_t str;
qse_sio_t* sio;
} u;
} u; /**< union containing data for each type */
};
typedef struct qse_sed_iostd_t qse_sed_iostd_t;
#ifdef __cplusplus
extern "C" {
#endif
/**
* The qse_sed_openstd() function creates a stream editor with the default
* memory manager and initializes it. Use qse_getxtnstd(), not qse_getxtn()
* to get the pointer to the extension area.
* memory manager and initializes it. Use qse_sed_getxtnstd() to get the
* pointer to the extension area. Do not use qse_sed_getxtn() for this.
* @return pointer to a stream editor on success, #QSE_NULL on failure.
*/
QSE_EXPORT qse_sed_t* qse_sed_openstd (
@ -80,8 +86,8 @@ QSE_EXPORT qse_sed_t* qse_sed_openstd (
/**
* The qse_sed_openstdwithmmgr() function creates a stream editor with a
* user-defined memory manager. It is equivalent to qse_sed_openstd(),
* except that you can specify your own memory manager.Use qse_getxtnstd(),
* not qse_getxtn() to get the pointer to the extension area.
* except that you can specify your own memory manager.Use qse_sed_getxtnstd(),
* not qse_sed_getxtn() to get the pointer to the extension area.
* @return pointer to a stream editor on success, #QSE_NULL on failure.
*/
QSE_EXPORT qse_sed_t* qse_sed_openstdwithmmgr (