libunibreak 5.0
Macros | Functions
wordbreak.h File Reference

Header file for the word breaking (segmentation) algorithm. More...

#include <stddef.h>
#include "unibreakbase.h"
Include dependency graph for wordbreak.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define WORDBREAK_BREAK   0
 Break is allowed. More...
 
#define WORDBREAK_NOBREAK   1
 No break is allowed. More...
 
#define WORDBREAK_INSIDEACHAR   2
 A UTF-8/16 sequence is unfinished. More...
 

Functions

void init_wordbreak (void)
 Initializes the wordbreak internals. More...
 
void set_wordbreaks_utf8 (const utf8_t *s, size_t len, const char *lang, char *brks)
 Sets the word breaking information for a UTF-8 input string. More...
 
void set_wordbreaks_utf16 (const utf16_t *s, size_t len, const char *lang, char *brks)
 Sets the word breaking information for a UTF-16 input string. More...
 
void set_wordbreaks_utf32 (const utf32_t *s, size_t len, const char *lang, char *brks)
 Sets the word breaking information for a UTF-32 input string. More...
 

Detailed Description

Header file for the word breaking (segmentation) algorithm.

Author
Tom Hacohen

Macro Definition Documentation

◆ WORDBREAK_BREAK

#define WORDBREAK_BREAK   0

Break is allowed.

◆ WORDBREAK_INSIDEACHAR

#define WORDBREAK_INSIDEACHAR   2

A UTF-8/16 sequence is unfinished.

◆ WORDBREAK_NOBREAK

#define WORDBREAK_NOBREAK   1

No break is allowed.

Function Documentation

◆ init_wordbreak()

void init_wordbreak ( void  )

Initializes the wordbreak internals.

It currently does nothing, but it may in the future.

◆ set_wordbreaks_utf16()

void set_wordbreaks_utf16 ( const utf16_t s,
size_t  len,
const char *  lang,
char *  brks 
)

Sets the word breaking information for a UTF-16 input string.

Parameters
[in]sinput UTF-16 string
[in]lenlength of the input
[in]langlanguage of the input (reserved for future use)
[out]brkspointer to the output breaking data, containing WORDBREAK_BREAK, WORDBREAK_NOBREAK, or WORDBREAK_INSIDEACHAR

◆ set_wordbreaks_utf32()

void set_wordbreaks_utf32 ( const utf32_t s,
size_t  len,
const char *  lang,
char *  brks 
)

Sets the word breaking information for a UTF-32 input string.

Parameters
[in]sinput UTF-32 string
[in]lenlength of the input
[in]langlanguage of the input (reserved for future use)
[out]brkspointer to the output breaking data, containing WORDBREAK_BREAK, WORDBREAK_NOBREAK, or WORDBREAK_INSIDEACHAR

◆ set_wordbreaks_utf8()

void set_wordbreaks_utf8 ( const utf8_t s,
size_t  len,
const char *  lang,
char *  brks 
)

Sets the word breaking information for a UTF-8 input string.

Parameters
[in]sinput UTF-8 string
[in]lenlength of the input
[in]langlanguage of the input (reserved for future use)
[out]brkspointer to the output breaking data, containing WORDBREAK_BREAK, WORDBREAK_NOBREAK, or WORDBREAK_INSIDEACHAR