liblouis: lou_hyphenate

1 
1 6.9 lou_hyphenate
1 =================
1 
1      int lou_hyphenate (
1          const char *tableList,
1          const widechar *inbuf,
1          int inlen,
1          char *hyphens,
1          int mode);
1 
1    This function looks at the characters in 'inbuf' and if it finds a
1 sequence of letters attempts to hyphenate it as a word.  Note that
1 lou_hyphenate operates on single words only, and spaces or punctuation
1 marks between letters are not allowed.  Leading and trailing punctuation
1 marks are ignored.  The table named by the 'tableList' parameter must
1 contain a hyphenation table.  If it does not, the function does nothing.
1 'inlen' is the length of the character string in 'inbuf'.  'hyphens' is
1 an array of characters and must be of size 'inlen' + 1 (to account for
1 the NULL terminator).  If hyphenation is successful it will have a 1 at
1 the beginning of each syllable and a 0 elsewhere.  If the 'mode'
1 parameter is 0 'inbuf' is assumed to contain untranslated characters.
1 Any nonzero value means that 'inbuf' contains a translation.  In this
1 case, it is back-translated, hyphenation is performed, and it is
1 re-translated so that the hyphens can be placed correctly.  The
1 'lou_translate' and 'lou_backTranslate' functions are used in this
1 process.  'lou_hyphenate' returns 1 if hyphenation was successful and 0
1 otherwise.  In the latter case, the contents of the 'hyphens' parameter
1 are undefined.  This function was provided for use in liblouisutdml.
1