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

updated doc a bit

Browse Source
This commit is contained in:
hyung-hwan 2012-08-12 06:37:23 +00:00
parent b795f0d53e
commit 1ade6b6ad7
1 changed files with 19 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
qse/doc/page/awk.doc
View File

@ -18,9 +18,9 @@
@section awk_intro INTRODUCTION @section awk_intro INTRODUCTION
QSEAWK is an embeddable AWK interpreter and is a part of the @ref qse_intro QSEAWK is an AWK interpreter and is a part of the @ref qse_intro "QSE" library.
"QSE" library. Its design focuses on building a flexible and robust embedding Its design focuses on building a flexible and robust embedding API with minimal
API with minimal platform dependency. An embedding application is capable of platform dependency. An embedding application is capable of:
- adding new global variables and functions. - adding new global variables and functions.
- getting and set the value of a global variable. - getting and set the value of a global variable.
- calling a function with or without parameters and getting its return value. - calling a function with or without parameters and getting its return value.
@ -30,7 +30,21 @@ API with minimal platform dependency. An embedding application is capable of
- changing language features by setting options. - changing language features by setting options.
- and more - and more
Embedding an interpreter typically involves the following steps. The library implements AWK in multiple levels:
- base interpreter
- standard interpreter
- parallel interpreter
The base interpreter provides most core language features while minimizing
platform dependence. When working with the base interpreter, you're required
to write primtive operation handlers like I/O and pass them in to make it
useful. The standard interpreter is usable immediately since it implements
all the primitive operations required by the base interpreter and adds
standard AWK functions. The parallel interpreter enables parallel processing
by adding various MPI variables and functions to the standard interpreter.
Embedding a standard interpreter typically involves the following steps.
- open a new interpreter - open a new interpreter
- parse in a source script - parse in a source script
@ -135,7 +149,7 @@ int main (int argc, char* argv[])
This library also provides a stand-alone AWK interpreter that you can use This library also provides a stand-alone AWK interpreter that you can use
in a console environment. The source code is located under the in a console environment. The source code is located under the
<project-root>/cmd/awk subdirectory. <project-root>/cmd/awk subdirectory. See the usage below.
@code @code
$ qseawk $ qseawk