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

updated documentation

Browse Source
This commit is contained in:
hyung-hwan
2013-01-09 08:03:21 +00:00
parent 19b4e697af
commit 6e94d324ef
20 changed files with 1143 additions and 1317 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
qse/include/qse/awk/Awk.hpp
View File

@ -29,7 +29,6 @@
/// @file
/// AWK Interpreter
///
/////////////////////////////////
QSE_BEGIN_NAMESPACE(QSE)

27
qse/include/qse/awk/StdAwk.hpp
View File

@ -27,33 +27,6 @@
/// @file
/// Standard AWK Interpreter
///
/// @example awk05.cpp
/// This program demonstrates how to use QSE::StdAwk::loop().
///
/// @example awk06.cpp
/// This program demonstrates how to use QSE::StdAwk::call().
///
/// @example awk07.cpp
/// This program demonstrates how to handle an indexed value.
///
/// @example awk08.cpp
/// This program shows how to add intrinsic functions.
///
/// @example awk12.cpp
/// This program shows how to override console methods to use
/// string buffers for console input and output.
///
/// @example awk13.cpp
/// This program shows how to use resetRunContext(). It is similar
/// to awk12.cpp in principle.
///
/// @example awk14.cpp
/// This program shows how to define a console handler to use
/// string buffers for console input and output. It is identical
/// to awk13.cpp except that it relies an external console handler
/// rather than overriding console methods.
///
/////////////////////////////////
QSE_BEGIN_NAMESPACE(QSE)

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

File diff suppressed because it is too large Load Diff

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

@ -24,7 +24,7 @@
#include <qse/awk/awk.h>
#include <qse/cmn/sio.h>
/** @file
/** \file
* This file defines functions and data types that help you create
* an awk interpreter with less effort. It is designed to be as close
* to conventional awk implementations as possible.
@ -34,16 +34,6 @@
* normal file name.
*/
/**
* @example awk09.c
* This programs shows how to specify multiple console output files.
*
* @example awk11.c
* This programs shows how to extend an I/O handler implemented by
* qse_awk_rtx_openstd().
*
*/
/**
* The qse_awk_parsestd_type_t type defines the types of source I/O.
*/
@ -128,7 +118,7 @@ QSE_EXPORT void* qse_awk_getxtnstd (
* The qse_awk_parsestd() functions parses source script.
* The code below shows how to parse a literal string 'BEGIN { print 10; }'
* and deparses it out to a buffer 'buf'.
* @code
* \code
* int n;
* qse_awk_parsestd_t in[2];
* qse_awk_parsestd_t out;
@ -144,7 +134,7 @@ QSE_EXPORT void* qse_awk_getxtnstd (
* qse_printf (QSE_T("%s\n"), out.u.str.ptr);
* QSE_MMGR_FREE (out.u.str.ptr);
* }
* @endcode
* \endcode
*/
QSE_EXPORT int qse_awk_parsestd (
qse_awk_t* awk,
@ -154,9 +144,9 @@ QSE_EXPORT int qse_awk_parsestd (
/**
* The qse_awk_rtx_openstd() function creates a standard runtime context.
* The caller should keep the contents of @a icf and @a ocf valid throughout
* the lifetime of the runtime context created. The @a cmgr is set to the
* streams created with @a icf and @a ocf if it is not #QSE_NULL.
* The caller should keep the contents of \a icf and \a ocf valid throughout
* the lifetime of the runtime context created. The \a cmgr is set to the
* streams created with \a icf and \a ocf if it is not #QSE_NULL.
*/
QSE_EXPORT qse_awk_rtx_t* qse_awk_rtx_openstd (
qse_awk_t* awk,
@ -178,7 +168,7 @@ QSE_EXPORT void* qse_awk_rtx_getxtnstd (
/**
* The qse_awk_rtx_getcmgrstd() function gets the current character
* manager associated with a particular I/O target indicated by the name
* @a ioname if #QSE_CHAR_IS_WCHAR is defined. It always returns #QSE_NULL
* \a ioname if #QSE_CHAR_IS_WCHAR is defined. It always returns #QSE_NULL
* if #QSE_CHAR_IS_MCHAR is defined.
*/
QSE_EXPORT qse_cmgr_t* qse_awk_rtx_getcmgrstd (