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

documented the source code a little bit

Browse Source
This commit is contained in:
hyung-hwan
2009-02-17 21:27:03 +00:00
parent fed0a952ab
commit 80dfcd497c
8 changed files with 83 additions and 57 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -24,7 +24,7 @@
#include <qse/cmn/map.h>
#include <qse/cmn/str.h>
/****o* AWK/AWK Interpreter
/****o* AWK/Interpreter
* DESCRIPTION
* The library includes an AWK interpreter that can be embedded into other
* applications or can run stand-alone.
@ -1074,7 +1074,7 @@ qse_char_t* qse_awk_strdup (
qse_char_t* qse_awk_strxdup (
qse_awk_t* awk,
const qse_char_t* str,
qse_size_t len
qse_size_t len
);
/******/
@ -1134,12 +1134,13 @@ void qse_awk_rtx_close (
* RETURN
* The qse_awk_rtx_loop() function returns 0 on success and -1 on failure.
* EXAMPLE
* rtx = qse_awk_rtx_open (awk, rio, rcb, QSE_NULL, QSE_NULL);
* if (rtx != QSE_NULL)
* {
* qse_awk_rtx_loop (rtx);
* qse_awk_rtx_close (rtx);
* }
* The example shows typical usage of the function.
* rtx = qse_awk_rtx_open (awk, rio, rcb, QSE_NULL, QSE_NULL);
* if (rtx != QSE_NULL)
* {
* qse_awk_rtx_loop (rtx);
* qse_awk_rtx_close (rtx);
* }
* SYNOPSIS
*/
int qse_awk_rtx_loop (
@ -1158,13 +1159,14 @@ int qse_awk_rtx_loop (
* RETURN
* The qse_awk_rtx_call() function returns 0 on success and -1 on failure.
* EXAMPLE
* rtx = qse_awk_rtx_open (awk, rio, rcb, QSE_NULL, QSE_NULL);
* if (rtx != QSE_NULL)
* {
* qse_awk_rtx_call (rtx, QSE_T("init"), QSE_NULL, 0);
* qse_awk_rtx_call (rtx, QSE_T("fini"), QSE_NULL, 0);
* qse_awk_rtx_close (rtx);
* }
* The example shows typical usage of the function.
* rtx = qse_awk_rtx_open (awk, rio, rcb, QSE_NULL, QSE_NULL);
* if (rtx != QSE_NULL)
* {
* qse_awk_rtx_call (rtx, QSE_T("init"), QSE_NULL, 0);
* qse_awk_rtx_call (rtx, QSE_T("fini"), QSE_NULL, 0);
* qse_awk_rtx_close (rtx);
* }
* SYNOPSIS
*/
int qse_awk_rtx_call (
@ -1308,7 +1310,7 @@ void qse_awk_rtx_setretval (
*/
int qse_awk_rtx_setfilename (
qse_awk_rtx_t* rtx,
const qse_char_t* name,
const qse_char_t* str,
qse_size_t len
);
/******/
@ -1320,7 +1322,7 @@ int qse_awk_rtx_setfilename (
*/
int qse_awk_rtx_setofilename (
qse_awk_rtx_t* rtx,
const qse_char_t* name,
const qse_char_t* str,
qse_size_t len
);
/******/
@ -1525,17 +1527,16 @@ qse_char_t* qse_awk_rtx_valtostr (
* RETURN
* The qse_awk_rtx_valtonum() function returns -1 on error, 0 if the converted
* number is a long number and 1 if it is a real number.
* EXAMPLES
* The following example show how to convert a value to a number and
* determine if it is an integer or a floating-point number.
* qse_long_t l;
* qse_real_t r;
* int n;
*
* n = qse_awk_rtx_valtonum (v, &l, &r);
* if (n == -1) error ();
* else if (n == 0) do_long (l);
* else if (n == 1) do_real (r);
* EXAMPLE
* The example show how to convert a value to a number and determine
* if it is an integer or a floating-point number.
* qse_long_t l;
* qse_real_t r;
* int n;
* n = qse_awk_rtx_valtonum (v, &l, &r);
* if (n == -1) error ();
* else if (n == 0) print_long (l);
* else if (n == 1) print_real (r);
* SYNOPSIS
*/
int qse_awk_rtx_valtonum (

40
qse/include/qse/types.h
View File

@ -77,8 +77,8 @@ typedef enum qse_tri_t qse_tri_t;
/****t* Base/qse_int_t,Base/qse_uint_t
* NAME
* qse_int_t - define a signed integer type as large as a pointer type
* qse_uint_t - define an unsigned integer type as large as a pointer type
* * qse_int_t - define a signed integer type as large as a pointer type
* * qse_uint_t - define an unsigned integer type as large as a pointer type
******
*/
#if (defined(hpux) || defined(__hpux) || defined(__hpux__)) && \
@ -109,8 +109,8 @@ typedef enum qse_tri_t qse_tri_t;
/****t* Base/qse_long_t,Base/qse_ulong_t
* NAME
* qse_long_t - define the largest signed integer type supported
* qse_ulong_t - define the largest unsigned integer type supported
* * qse_long_t - define the largest signed integer type supported
* * qse_ulong_t - define the largest unsigned integer type supported
******
*/
#if QSE_SIZEOF_LONG_LONG > 0
@ -126,8 +126,8 @@ typedef enum qse_tri_t qse_tri_t;
/****t* Base/qse_int8_t,Base/qse_uint8_t
* NAME
* qse_int8_t - define an 8-bit signed integer type
* qse_uint8_t - define an 8-bit unsigned integer type
* * qse_int8_t - define an 8-bit signed integer type
* * qse_uint8_t - define an 8-bit unsigned integer type
******
*/
#if QSE_SIZEOF_CHAR == 1
@ -140,8 +140,8 @@ typedef enum qse_tri_t qse_tri_t;
/****t* Base/qse_int16_t,Base/qse_uint16_t
* NAME
* qse_int16_t - define a 16-bit signed integer type
* qse_uint16_t - define a 16-bit unsigned integer type
* * qse_int16_t - define a 16-bit signed integer type
* * qse_uint16_t - define a 16-bit unsigned integer type
******
*/
#if QSE_SIZEOF_SHORT == 2
@ -154,8 +154,8 @@ typedef enum qse_tri_t qse_tri_t;
/****t* Base/qse_int32_t,Base/qse_uint32_t
* NAME
* qse_int32_t - define a 32-bit signed integer type
* qse_uint32_t - define a 32-bit unsigned integer type
* * qse_int32_t - define a 32-bit signed integer type
* * qse_uint32_t - define a 32-bit unsigned integer type
******
*/
#if QSE_SIZEOF_INT == 4
@ -171,8 +171,8 @@ typedef enum qse_tri_t qse_tri_t;
/****t* Base/qse_int64_t,Base/qse_uint64_t
* NAME
* qse_int64_t - define a 64-bit signed integer type
* qse_uint64_t - define a 64-bit unsigned integer type
* * qse_int64_t - define a 64-bit signed integer type
* * qse_uint64_t - define a 64-bit unsigned integer type
******
*/
#if QSE_SIZEOF_INT == 8
@ -267,8 +267,8 @@ typedef qse_uint_t qse_word_t;
/****t* Base/qse_mchar_t,Base/qse_mcint_t
* NAME
* qse_mchar_t - define a multi-byte character
* qse_mcint_t - define a type that can hold qse_mchar_t and QSE_MCHAR_EOF
* * qse_mchar_t - define a multi-byte character
* * qse_mcint_t - define a type that can hold qse_mchar_t and QSE_MCHAR_EOF
******
*/
typedef char qse_mchar_t;
@ -276,8 +276,8 @@ typedef int qse_mcint_t;
/****t* Base/qse_wchar_t,Base/qse_wcint_t
* NAME
* qse_wchar_t - define a wide character
* qse_wcint_t - define a type that can hold qse_wchar_t and QSE_WCHAR_EOF
* * qse_wchar_t - define a wide character
* * qse_wcint_t - define a type that can hold qse_wchar_t and QSE_WCHAR_EOF
******
*/
#if defined(__cplusplus) && \
@ -335,8 +335,8 @@ typedef int qse_mcint_t;
/****t* Base/qse_char_t,Base/qse_cint_t
* NAME
* qse_char_t - define a character
* qse_cint_t - define a type that can hold qse_char_t and QSE_CHAR_EOF
* * qse_char_t - define a character
* * qse_cint_t - define a type that can hold qse_char_t and QSE_CHAR_EOF
******
*/
#if defined(_WIN32) && (defined(UNICODE)||defined(_UNICODE))
@ -378,6 +378,8 @@ typedef struct qse_ccls_t qse_ccls_t;
/****t* Base/qse_xstr_t
* NAME
* qse_xstr_t - combine a pointer and length
* SEE ALSO
* qse_cstr_t
* SYNOPSIS
*/
struct qse_xstr_t
@ -390,6 +392,8 @@ struct qse_xstr_t
/****t* Base/qse_cstr_t
* NAME
* qse_cstr_t - combine a constant pointer and length
* SEE ALSO
* qse_xstr_t
* SYNOPSIS
*/
struct qse_cstr_t