liblouis: lou_translate

1 
1 6.6 lou_translate
1 =================
1 
1      int lou_translate (
1          const char * tableList,
1          const widechar * const inbuf,
1          int *inlen,
1          widechar * outbuf,
1          int *outlen,
1          char *typeform,
1          char *spacing,
1          int *outputPos,
1          int *inputPos,
1          int *cursorPos,
1          int mode);
1 
1    This function adds the parameters 'outputPos', 'inputPos' and
1 'cursorPos', to facilitate use in screen reader programs.  The
1 'outputPos' parameter must point to an array of integers with at least
1 'inlen' elements.  On return, this array will contain the position in
1 'outbuf' corresponding to each input position.  Similarly, 'inputPos'
1 must point to an array of integers of at least 'outlen' elements.  On
1 return, this array will contain the position in 'inbuf' corresponding to
1 each position in 'outbuf'.  'cursorPos' must point to an integer
1 containing the position of the cursor in the input.  On return, it will
1 contain the cursor position in the output.  Any parameter after 'outlen'
1 may be 'NULL'.  In this case, the actions corresponding to it will not
1 be carried out.  The 'mode' parameter, however, must be present and must
1 be an integer, not a pointer to an integer.  If the 'compbrlAtCursor'
1 bit is set in the 'mode' parameter the space-bounded characters
1 containing the cursor will be translated in computer braille.  If the
1 'compbrlLeftCursor' bit is set only the characters to the left of the
1 cursor will be in computer braille.  This bit overrides
1 'compbrlAtCursor'.  When the 'dotsIO' bit is set, during translation,
1 produce output as dot patterns.  During back-translation accept input as
1 dot patterns.  Note that the produced dot patterns are affected if you
1 have any 'display' opcode (⇒display display opcode.) defined in
1 any of your tables.  The 'ucBrl' (Unicode Braille) bit is used by
1 'lou_charToDots' and 'lou_translate'.  It causes the dot patterns to be
1 Unicode Braille rather than the liblouis representation.  Note that you
1 will not notice any change when setting 'ucBrl' unless 'dotsIO' is also
1 set.  'lou_dotsToChar' and 'lou_backTranslate' recognize Unicode braille
1 automatically.
1 
1    The 'otherTrans' mode needs special description.  If it is set
1 liblouis will attempt to call a wrapper for another translator.  These
1 other translators are usually for Asian languages.  The calling sequence
1 is the same as for liblouis itself except that the 'trantab' parameter
1 gives the name of the other translator, possibly abbreviated, followed
1 by a colon, followed by whatever other information the other translator
1 needs.  This is specific for each translator.  If no such information is
1 needed the colon should be omitted.  The result of calling either the
1 translate or back-translate functions with this mode bit set will be the
1 same as calling without it set.  That is, the wrapper for the other
1 translator simulates a call to liblouis.  Note that the wrappers are not
1 implemented at this time.  Setting this mode bit will result in failure
1 (return value of 0).
1