added some more docs

This commit is contained in:
2013-01-07 15:08:22 +00:00
parent 2624acb308
commit f689359e78
5 changed files with 52 additions and 43 deletions

View File

@ -1549,6 +1549,7 @@ PREDEFINED = "QSE_BEGIN_NAMESPACE(x)=namespace x {" \
"QSE_SIZEOF_FLOAT=@QSE_SIZEOF_FLOAT@" \
"QSE_SIZEOF_DOUBLE=@QSE_SIZEOF_DOUBLE@" \
"QSE_SIZEOF_LONG_DOUBLE=@QSE_SIZEOF_LONG_DOUBLE@" \
"QSE_EXPORT=" \
"@CHAR_MODE@"
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then

View File

@ -6,11 +6,12 @@ EXTRA_DIST = \
gendoc.sh \
page/mainpage.md \
page/installation.md \
page/mem.doc \
page/cenc.doc \
page/io.doc \
page/awk.doc \
page/awk-lang.md \
page/sed.doc \
page/mem.doc \
page/cenc.doc \
page/io.doc \
page/awk.doc \
page/awk-embed.md \
page/awk-lang.md \
page/sed.doc \
image/qse-logo.png

28
qse/doc/page/awk-embed.md Normal file
View File

@ -0,0 +1,28 @@
Embedding Guid {#embedding-guide}
================================================================================
Overview
---------
The design of the library is divided into two layers: core and standard.
The core layer is a skeleton implmenetation that requires various callbacks
to be useful. The standard layer provides these callbacks in a general respect.
For example, qse_awk_open() in the core layer requires a set of primitive
functions to be able to create an awk object while qse_awk_openstd() provides
qse_awk_open() with a standard set of primitive functions.
Embedding QSEAWK involves the following steps in the simplest form:
- open a new awk object
- parse in a source script
- open a new runtime context
- execute pattern-action blocks or call a function
- decrement the reference count of the return value
- close the runtime context
- close the awk object
\includelineno awk01.c
You can create multiple runtime contexts over a single awk object. It is useful
if you want to execute the same AWK script over different data streams.

View File

@ -100,7 +100,7 @@ extra information useful for debugging. The default mode is **release**.
debug | enable-debug | BUILD=debug
release | disable-debug | BUILD=release
### Character Type ###
### Character Type ###
You can choose between the wide charcter type and the multi-byte character
type as a basic character type represented in the #qse_char_t type. The default