break

Perform line breaking algorithm. More...

Data Structures
struct	unistr_t
struct	gcstring_t
Functions
gcstring_t **	linebreak_break_partial (linebreak_t *lbobj, unistr_t *input)
gcstring_t **	linebreak_break_fast (linebreak_t *lbobj, unistr_t *input)
gcstring_t **	linebreak_break (linebreak_t *lbobj, unistr_t *input)

---

Detailed Description

Perform line breaking algorithm.

---

Function Documentation

gcstring_t** linebreak_break	(	linebreak_t *	lbobj,
		unistr_t *	input
	)

Perform line breaking algorithm on complete input.

This function will consume constant size of heap.

Parameters:

[in]	lbobj	linebreak object.
[in]	input	Unicode string.

Returns:

array of broken grapheme cluster strings terminated by NULL. If internal error occurred, lbobj->errnum is set then NULL is returned.

gcstring_t** linebreak_break_fast	(	linebreak_t *	lbobj,
		unistr_t *	input
	)

Perform line breaking algorithm on complete input.

This function will consume heap size proportional to input size. linebreak_break() is highly recommended.

Parameters:

[in]	lbobj	linebreak object.
[in]	input	Unicode string.

Returns:

array of broken grapheme cluster strings terminated by NULL. If internal error occurred, lbobj->errnum is set then NULL is returned.

gcstring_t ** linebreak_break_partial	(	linebreak_t *	lbobj,
		unistr_t *	input
	)

Perform line breaking algorithm with incremental inputs.

Parameters:

[in]	lbobj	linebreak object.
[in]	input	Unicode string; give NULL to specify end of input.

Returns:

array of (partial) broken grapheme cluster strings terminated by NULL. If internal error occurred, lbobj->errnum is set then NULL is returned.