Push Mode

Macros
#define	lparseCreatePush(sb, pline, ...)   _lparseCreatePush(sb, pline, opt_flags(__VA_ARGS__))

Typedefs
typedef bool(*	lparseLineCB) (stvlist *cvars, strref line)

Detailed Description

Push-mode line parsing where a callback is invoked for each line automatically.

Macro Definition Documentation

lparseCreatePush

#define lparseCreatePush	(		sb,
			pline,
			...
	)		_lparseCreatePush(sb, pline, opt_flags(__VA_ARGS__))

LineParser *lparseCreatePush(StreamBuffer *sb, closure pline, [flags])

Creates a line parser that is called as data arrives.

The parser registers as the stream buffer's consumer, so the producer drives: the closure runs for each line as soon as enough data is there. A last line with no EOL is delivered when the producer calls sbufClose().

Takes ownership of the closure whether or not the parser is created. It is destroyed along with the parser.

Parameters

sb	The stream buffer
pline	Closure created with closureCreateAs(lparseLineCB, ...)
...	(flags) Configuration flags from LINEPARSER_FLAGS_ENUM

Returns

New line parser, or NULL if a consumer is already attached to the stream buffer

Example:

bool handleLine(stvlist *cvars, strref line) {
    int *count = stvlAtPtr(cvars, 0);
    (*count)++;
    printf("Line %d: %s\n", *count, strC(line));
    return true;  // continue processing
}
 
int lineCount = 0;
StreamBuffer *sb = sbufCreate(4096);
LineParser *lp   = lparseCreatePush(sb,
    closureCreateAs(lparseLineCB, handleLine, stvar(ptr, &lineCount)), LPARSE_LF);
sbufFileIn(sb, file, true);   // triggers callbacks automatically
sbufClose(sb);
lparseDestroy(&lp);

Definition at line 210 of file lineparse.h.

Typedef Documentation

lparseLineCB

typedef bool(* lparseLineCB) (stvlist *cvars, strref line)

Line callback, for a parser created with lparseCreatePush()

Create it with closureCreateAs(lparseLineCB, func, ...). Runs for each line found in the stream buffer. The line is only valid during the call; copy it to keep it.

Parameters

cvars	Captured variables of the closure
line	The parsed line (valid only during the call)

Returns

true to continue parsing, false to stop

Definition at line 171 of file lineparse.h.