Codebase list libmawk / upstream/1.0.2 src / libmawk / man / libmawk_run_main.3libmawk
upstream/1.0.2

Tree @upstream/1.0.2 (Download .tar.gz)

libmawk_run_main.3libmawk @upstream/1.0.2raw · history · blame

.\" Copyright 2009 Tibor Palinkas (mawk@inno.bme.hu)
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.\"
.TH LIBMAWK_RUN_MAIN 3libmawk  2009-08-10 "libmawk" "libmawk manual"
.SH NAME
libmawk_run_main \- run main parts of a script
.SH SYNOPSIS
.nf
.B #include <libmawk.h>
.sp
.BI "void libmawk_run_main(mawk_state_t *" m );
.fi
.sp
.SH DESCRIPTION
The
.BR libmawk_run_main ()
attempts to take and parse the next input record and runs all main
parts of the script that matches. If there are multiple full records
in the input buffer, the process repeats until the buffer becomes empty
or contains a partial record. If there is no full record in the buffer,
the call returns with nothing done. The call itself never blocks, but the
script may. The input buffer may be filled using the libmawk_append_input()
call.
.sp
Argument m is a libmawk context previously returned by libmawk_initialize()
or libmawk_initialize_stage3().
.SH "SEE ALSO"
.BR libmawk_initialize_stage (3libmawk),
.BR libmawk_initialize (3libmawk),
.BR libmawk_append_input (3libmawk),