ICU 63.1 63.1

ubidi.h
Go to the documentation of this file.
1 // © 2016 and later: Unicode, Inc. and others.
2 // License & terms of use: http://www.unicode.org/copyright.html
3 /*
4 ******************************************************************************
5 *
6 * Copyright (C) 1999-2013, International Business Machines
7 * Corporation and others. All Rights Reserved.
8 *
9 ******************************************************************************
10 * file name: ubidi.h
11 * encoding: UTF-8
12 * tab size: 8 (not used)
13 * indentation:4
14 *
15 * created on: 1999jul27
16 * created by: Markus W. Scherer, updated by Matitiahu Allouche
17 */
18
19 #ifndef UBIDI_H
20 #define UBIDI_H
21
22 #include "unicode/utypes.h"
23 #include "unicode/uchar.h"
24 #include "unicode/localpointer.h"
25
289 /*DOCXX_TAG*/
336 typedef uint8_t UBiDiLevel;
337
362 #define UBIDI_DEFAULT_LTR 0xfe
363
389 #define UBIDI_DEFAULT_RTL 0xff
390
398 #define UBIDI_MAX_EXPLICIT_LEVEL 125
399
404 #define UBIDI_LEVEL_OVERRIDE 0x80
405
419 #define UBIDI_MAP_NOWHERE (-1)
420
425 enum UBiDiDirection {
437 UBIDI_LTR,
449 UBIDI_RTL,
456 UBIDI_MIXED,
463 UBIDI_NEUTRAL
464 };
465
467 typedef enum UBiDiDirection UBiDiDirection;
468
479 struct UBiDi;
480
482 typedef struct UBiDi UBiDi;
483
499 U_STABLE UBiDi * U_EXPORT2
500 ubidi_open(void);
501
536 U_STABLE UBiDi * U_EXPORT2
537 ubidi_openSized(int32_t maxLength, int32_t maxRunCount, UErrorCode *pErrorCode);
538
559 U_STABLE void U_EXPORT2
560 ubidi_close(UBiDi *pBiDi);
561
562 #if U_SHOW_CPLUSPLUS_API
563
564 U_NAMESPACE_BEGIN
565
575 U_DEFINE_LOCAL_OPEN_POINTER(LocalUBiDiPointer, UBiDi, ubidi_close);
576
577 U_NAMESPACE_END
578
579 #endif
580
629 U_STABLE void U_EXPORT2
630 ubidi_setInverse(UBiDi *pBiDi, UBool isInverse);
631
648 U_STABLE UBool U_EXPORT2
649 ubidi_isInverse(UBiDi *pBiDi);
650
671 U_STABLE void U_EXPORT2
672 ubidi_orderParagraphsLTR(UBiDi *pBiDi, UBool orderParagraphsLTR);
673
685 U_STABLE UBool U_EXPORT2
686 ubidi_isOrderParagraphsLTR(UBiDi *pBiDi);
687
695 typedef enum UBiDiReorderingMode {
699 UBIDI_REORDER_DEFAULT = 0,
703 UBIDI_REORDER_NUMBERS_SPECIAL,
707 UBIDI_REORDER_GROUP_NUMBERS_WITH_R,
715 UBIDI_REORDER_RUNS_ONLY,
720 UBIDI_REORDER_INVERSE_NUMBERS_AS_L,
724 UBIDI_REORDER_INVERSE_LIKE_DIRECT,
728 UBIDI_REORDER_INVERSE_FOR_NUMBERS_SPECIAL,
729 #ifndef U_HIDE_DEPRECATED_API
730
734 UBIDI_REORDER_COUNT
735 #endif // U_HIDE_DEPRECATED_API
736 } UBiDiReorderingMode;
737
889 U_STABLE void U_EXPORT2
890 ubidi_setReorderingMode(UBiDi *pBiDi, UBiDiReorderingMode reorderingMode);
891
900 U_STABLE UBiDiReorderingMode U_EXPORT2
901 ubidi_getReorderingMode(UBiDi *pBiDi);
902
910 typedef enum UBiDiReorderingOption {
917 UBIDI_OPTION_DEFAULT = 0,
918
963 UBIDI_OPTION_INSERT_MARKS = 1,
964
981 UBIDI_OPTION_REMOVE_CONTROLS = 2,
982
1029 UBIDI_OPTION_STREAMING = 4
1030 } UBiDiReorderingOption;
1031
1045 U_STABLE void U_EXPORT2
1046 ubidi_setReorderingOptions(UBiDi *pBiDi, uint32_t reorderingOptions);
1047
1056 U_STABLE uint32_t U_EXPORT2
1057 ubidi_getReorderingOptions(UBiDi *pBiDi);
1058
1143 U_STABLE void U_EXPORT2
1144 ubidi_setContext(UBiDi *pBiDi,
1145 const UChar *prologue, int32_t proLength,
1146 const UChar *epilogue, int32_t epiLength,
1147 UErrorCode *pErrorCode);
1148
1231 U_STABLE void U_EXPORT2
1232 ubidi_setPara(UBiDi *pBiDi, const UChar *text, int32_t length,
1233 UBiDiLevel paraLevel, UBiDiLevel *embeddingLevels,
1234 UErrorCode *pErrorCode);
1235
1282 U_STABLE void U_EXPORT2
1283 ubidi_setLine(const UBiDi *pParaBiDi,
1284 int32_t start, int32_t limit,
1285 UBiDi *pLineBiDi,
1286 UErrorCode *pErrorCode);
1287
1303 U_STABLE UBiDiDirection U_EXPORT2
1304 ubidi_getDirection(const UBiDi *pBiDi);
1305
1333 U_STABLE UBiDiDirection U_EXPORT2
1334 ubidi_getBaseDirection(const UChar *text, int32_t length );
1335
1347 U_STABLE const UChar * U_EXPORT2
1348 ubidi_getText(const UBiDi *pBiDi);
1349
1358 U_STABLE int32_t U_EXPORT2
1359 ubidi_getLength(const UBiDi *pBiDi);
1360
1376 U_STABLE UBiDiLevel U_EXPORT2
1377 ubidi_getParaLevel(const UBiDi *pBiDi);
1378
1387 U_STABLE int32_t U_EXPORT2
1388 ubidi_countParagraphs(UBiDi *pBiDi);
1389
1424 U_STABLE int32_t U_EXPORT2
1425 ubidi_getParagraph(const UBiDi *pBiDi, int32_t charIndex, int32_t *pParaStart,
1426 int32_t *pParaLimit, UBiDiLevel *pParaLevel,
1427 UErrorCode *pErrorCode);
1428
1456 U_STABLE void U_EXPORT2
1457 ubidi_getParagraphByIndex(const UBiDi *pBiDi, int32_t paraIndex,
1458 int32_t *pParaStart, int32_t *pParaLimit,
1459 UBiDiLevel *pParaLevel, UErrorCode *pErrorCode);
1460
1476 U_STABLE UBiDiLevel U_EXPORT2
1477 ubidi_getLevelAt(const UBiDi *pBiDi, int32_t charIndex);
1478
1497 U_STABLE const UBiDiLevel * U_EXPORT2
1498 ubidi_getLevels(UBiDi *pBiDi, UErrorCode *pErrorCode);
1499
1524 U_STABLE void U_EXPORT2
1525 ubidi_getLogicalRun(const UBiDi *pBiDi, int32_t logicalPosition,
1526 int32_t *pLogicalLimit, UBiDiLevel *pLevel);
1527
1543 U_STABLE int32_t U_EXPORT2
1544 ubidi_countRuns(UBiDi *pBiDi, UErrorCode *pErrorCode);
1545
1602 U_STABLE UBiDiDirection U_EXPORT2
1603 ubidi_getVisualRun(UBiDi *pBiDi, int32_t runIndex,
1604 int32_t *pLogicalStart, int32_t *pLength);
1605
1643 U_STABLE int32_t U_EXPORT2
1644 ubidi_getVisualIndex(UBiDi *pBiDi, int32_t logicalIndex, UErrorCode *pErrorCode);
1645
1678 U_STABLE int32_t U_EXPORT2
1679 ubidi_getLogicalIndex(UBiDi *pBiDi, int32_t visualIndex, UErrorCode *pErrorCode);
1680
1721 U_STABLE void U_EXPORT2
1722 ubidi_getLogicalMap(UBiDi *pBiDi, int32_t *indexMap, UErrorCode *pErrorCode);
1723
1757 U_STABLE void U_EXPORT2
1758 ubidi_getVisualMap(UBiDi *pBiDi, int32_t *indexMap, UErrorCode *pErrorCode);
1759
1780 U_STABLE void U_EXPORT2
1781 ubidi_reorderLogical(const UBiDiLevel *levels, int32_t length, int32_t *indexMap);
1782
1803 U_STABLE void U_EXPORT2
1804 ubidi_reorderVisual(const UBiDiLevel *levels, int32_t length, int32_t *indexMap);
1805
1838 U_STABLE void U_EXPORT2
1839 ubidi_invertMap(const int32_t *srcMap, int32_t *destMap, int32_t length);
1840
1850 #define UBIDI_KEEP_BASE_COMBINING 1
1851
1860 #define UBIDI_DO_MIRRORING 2
1861
1874 #define UBIDI_INSERT_LRM_FOR_NUMERIC 4
1875
1887 #define UBIDI_REMOVE_BIDI_CONTROLS 8
1888
1903 #define UBIDI_OUTPUT_REVERSE 16
1904
1943 U_STABLE int32_t U_EXPORT2
1944 ubidi_getProcessedLength(const UBiDi *pBiDi);
1945
1973 U_STABLE int32_t U_EXPORT2
1974 ubidi_getResultLength(const UBiDi *pBiDi);
1975
1976 U_CDECL_BEGIN
1977
1978 #ifndef U_HIDE_DEPRECATED_API
1979
1988 #define U_BIDI_CLASS_DEFAULT U_CHAR_DIRECTION_COUNT
1989 #endif // U_HIDE_DEPRECATED_API
1990
2011 typedef UCharDirection U_CALLCONV
2012 UBiDiClassCallback(const void *context, UChar32 c);
2013
2014 U_CDECL_END
2015
2031 U_STABLE UCharDirection U_EXPORT2
2032 ubidi_getCustomizedClass(UBiDi *pBiDi, UChar32 c);
2033
2061 U_STABLE void U_EXPORT2
2062 ubidi_setClassCallback(UBiDi *pBiDi, UBiDiClassCallback *newFn,
2063 const void *newContext, UBiDiClassCallback **oldFn,
2064 const void **oldContext, UErrorCode *pErrorCode);
2065
2078 U_STABLE void U_EXPORT2
2079 ubidi_getClassCallback(UBiDi *pBiDi, UBiDiClassCallback **fn, const void **context);
2080
2146 U_STABLE int32_t U_EXPORT2
2147 ubidi_writeReordered(UBiDi *pBiDi,
2148 UChar *dest, int32_t destSize,
2149 uint16_t options,
2150 UErrorCode *pErrorCode);
2151
2198 U_STABLE int32_t U_EXPORT2
2199 ubidi_writeReverse(const UChar *src, int32_t srcLength,
2200 UChar *dest, int32_t destSize,
2201 uint16_t options,
2202 UErrorCode *pErrorCode);
2203
2204 /*#define BIDI_SAMPLE_CODE*/
2207 #endif
UBIDI_REORDER_NUMBERS_SPECIAL
Logical to Visual algorithm which handles numbers in a way which mimics the behavior of Windows XP...
Definition: ubidi.h:703
ubidi_openSized
UBiDi * ubidi_openSized(int32_t maxLength, int32_t maxRunCount, UErrorCode *pErrorCode)
Allocate a UBiDi structure with preallocated memory for internal structures.
UBIDI_REORDER_RUNS_ONLY
Reorder runs only to transform a Logical LTR string to the Logical RTL string with the same display...
Definition: ubidi.h:715
ubidi_getLogicalMap
void ubidi_getLogicalMap(UBiDi *pBiDi, int32_t *indexMap, UErrorCode *pErrorCode)
Get a logical-to-visual index map (array) for the characters in the UBiDi (paragraph or line) object...
ubidi_getClassCallback
void ubidi_getClassCallback(UBiDi *pBiDi, UBiDiClassCallback **fn, const void **context)
Get the current callback function used for Bidi class determination.
ubidi_writeReverse
int32_t ubidi_writeReverse(const UChar *src, int32_t srcLength, UChar *dest, int32_t destSize, uint16_t options, UErrorCode *pErrorCode)
Reverse a Right-To-Left run of Unicode text.
ubidi_setLine
void ubidi_setLine(const UBiDi *pParaBiDi, int32_t start, int32_t limit, UBiDi *pLineBiDi, UErrorCode *pErrorCode)
ubidi_setLine() sets a UBiDi to contain the reordering information, especially the resolved levels...
UBIDI_OPTION_STREAMING
option bit for ubidi_setReorderingOptions: process the output as part of a stream to be continued ...
Definition: ubidi.h:1029
ubidi_getParagraphByIndex
void ubidi_getParagraphByIndex(const UBiDi *pBiDi, int32_t paraIndex, int32_t *pParaStart, int32_t *pParaLimit, UBiDiLevel *pParaLevel, UErrorCode *pErrorCode)
Get a paragraph, given the index of this paragraph.
ubidi_setReorderingOptions
void ubidi_setReorderingOptions(UBiDi *pBiDi, uint32_t reorderingOptions)
Specify which of the reordering options should be applied during Bidi transformations.
ubidi_getLength
int32_t ubidi_getLength(const UBiDi *pBiDi)
Get the length of the text.
ubidi_getLogicalRun
void ubidi_getLogicalRun(const UBiDi *pBiDi, int32_t logicalPosition, int32_t *pLogicalLimit, UBiDiLevel *pLevel)
Get a logical run.
ubidi_getBaseDirection
UBiDiDirection ubidi_getBaseDirection(const UChar *text, int32_t length)
Gets the base direction of the text provided according to the Unicode Bidirectional Algorithm...
ubidi_getLevelAt
UBiDiLevel ubidi_getLevelAt(const UBiDi *pBiDi, int32_t charIndex)
Get the level for one character.
UBIDI_REORDER_COUNT
Number of values for reordering mode.
Definition: ubidi.h:734
UBiDiClassCallback
UCharDirection UBiDiClassCallback(const void *context, UChar32 c)
Callback type declaration for overriding default Bidi class values with custom ones.
Definition: ubidi.h:2012
UBIDI_OPTION_REMOVE_CONTROLS
option bit for ubidi_setReorderingOptions: remove Bidi control characters
Definition: ubidi.h:981
ubidi_getCustomizedClass
UCharDirection ubidi_getCustomizedClass(UBiDi *pBiDi, UChar32 c)
Retrieve the Bidi class for a given code point.
ubidi_isOrderParagraphsLTR
UBool ubidi_isOrderParagraphsLTR(UBiDi *pBiDi)
Is this Bidi object set to allocate level 0 to block separators so that successive paragraphs progres...
UBIDI_REORDER_INVERSE_NUMBERS_AS_L
Visual to Logical algorithm which handles numbers like L (same algorithm as selected by ubidi_setInve...
Definition: ubidi.h:720
UCharDirection
UCharDirection
This specifies the language directional property of a character set.
Definition: uchar.h:921
U_CALLCONV
#define U_CALLCONV
Similar to U_CDECL_BEGIN/U_CDECL_END, this qualifier is necessary in callback function typedefs to ma...
Definition: platform.h:840
ubidi_orderParagraphsLTR
void ubidi_orderParagraphsLTR(UBiDi *pBiDi, UBool orderParagraphsLTR)
Specify whether block separators must be allocated level zero, so that successive paragraphs will pro...
ubidi_setReorderingMode
void ubidi_setReorderingMode(UBiDi *pBiDi, UBiDiReorderingMode reorderingMode)
Modify the operation of the Bidi algorithm such that it implements some variant to the basic Bidi alg...
UBiDiLevel
uint8_t UBiDiLevel
UBiDiLevel is the type of the level values in this Bidi implementation.
Definition: ubidi.h:336
UBIDI_REORDER_INVERSE_FOR_NUMBERS_SPECIAL
Inverse Bidi (Visual to Logical) algorithm for the UBIDI_REORDER_NUMBERS_SPECIAL Bidi algorithm...
Definition: ubidi.h:728
UBIDI_MIXED
Mixed-directional text.
Definition: ubidi.h:456
ubidi_open
UBiDi * ubidi_open(void)
Allocate a UBiDi structure.
ubidi_getProcessedLength
int32_t ubidi_getProcessedLength(const UBiDi *pBiDi)
Get the length of the source text processed by the last call to ubidi_setPara().
UBiDiReorderingOption
UBiDiReorderingOption
UBiDiReorderingOption values indicate which options are specified to affect the Bidi algorithm...
Definition: ubidi.h:910
ubidi_setContext
void ubidi_setContext(UBiDi *pBiDi, const UChar *prologue, int32_t proLength, const UChar *epilogue, int32_t epiLength, UErrorCode *pErrorCode)
Set the context before a call to ubidi_setPara().
UBIDI_OPTION_DEFAULT
option value for ubidi_setReorderingOptions: disable all the options which can be set with this funct...
Definition: ubidi.h:917
ubidi_getParagraph
int32_t ubidi_getParagraph(const UBiDi *pBiDi, int32_t charIndex, int32_t *pParaStart, int32_t *pParaLimit, UBiDiLevel *pParaLevel, UErrorCode *pErrorCode)
Get a paragraph, given a position within the text.
UBiDiDirection
UBiDiDirection
UBiDiDirection values indicate the text direction.
Definition: ubidi.h:425
U_CDECL_BEGIN
#define U_CDECL_BEGIN
This is used to begin a declaration of a library private ICU C API.
Definition: umachine.h:84
ubidi_getVisualMap
void ubidi_getVisualMap(UBiDi *pBiDi, int32_t *indexMap, UErrorCode *pErrorCode)
Get a visual-to-logical index map (array) for the characters in the UBiDi (paragraph or line) object...
ubidi_getDirection
UBiDiDirection ubidi_getDirection(const UBiDi *pBiDi)
Get the directionality of the text.
U_NAMESPACE_BEGIN
#define U_NAMESPACE_BEGIN
This is used to begin a declaration of a public ICU C++ API.
Definition: uversion.h:137
ubidi_getLogicalIndex
int32_t ubidi_getLogicalIndex(UBiDi *pBiDi, int32_t visualIndex, UErrorCode *pErrorCode)
Get the logical text position from a visual position.
U_DEFINE_LOCAL_OPEN_POINTER
#define U_DEFINE_LOCAL_OPEN_POINTER(LocalPointerClassName, Type, closeFunction)
"Smart pointer" definition macro, deletes objects via the closeFunction.
Definition: localpointer.h:487
localpointer.h
C++ API: "Smart pointers" for use with and in ICU4C C++ code.
ubidi_getReorderingMode
UBiDiReorderingMode ubidi_getReorderingMode(UBiDi *pBiDi)
What is the requested reordering mode for a given Bidi object?
ubidi_getResultLength
int32_t ubidi_getResultLength(const UBiDi *pBiDi)
Get the length of the reordered text resulting from the last call to ubidi_setPara().
UBIDI_REORDER_DEFAULT
Regular Logical to Visual Bidi algorithm according to Unicode.
Definition: ubidi.h:699
ubidi_getLevels
const UBiDiLevel * ubidi_getLevels(UBiDi *pBiDi, UErrorCode *pErrorCode)
Get an array of levels for each character.
UChar32
int32_t UChar32
Define UChar32 as a type for single Unicode code points.
Definition: umachine.h:389
ubidi_setClassCallback
void ubidi_setClassCallback(UBiDi *pBiDi, UBiDiClassCallback *newFn, const void *newContext, UBiDiClassCallback **oldFn, const void **oldContext, UErrorCode *pErrorCode)
Set the callback function and callback data used by the UBA implementation for Bidi class determinati...
ubidi_close
void ubidi_close(UBiDi *pBiDi)
ubidi_close() must be called to free the memory associated with a UBiDi object.
ubidi_setInverse
void ubidi_setInverse(UBiDi *pBiDi, UBool isInverse)
Modify the operation of the Bidi algorithm such that it approximates an "inverse Bidi" algorithm...
ubidi_getVisualRun
UBiDiDirection ubidi_getVisualRun(UBiDi *pBiDi, int32_t runIndex, int32_t *pLogicalStart, int32_t *pLength)
Get one run&#39;s logical start, length, and directionality, which can be 0 for LTR or 1 for RTL...
ubidi_getParaLevel
UBiDiLevel ubidi_getParaLevel(const UBiDi *pBiDi)
Get the paragraph level of the text.
UBIDI_OPTION_INSERT_MARKS
option bit for ubidi_setReorderingOptions: insert Bidi marks (LRM or RLM) when needed to ensure corre...
Definition: ubidi.h:963
ubidi_countParagraphs
int32_t ubidi_countParagraphs(UBiDi *pBiDi)
Get the number of paragraphs.
ubidi_isInverse
UBool ubidi_isInverse(UBiDi *pBiDi)
Is this Bidi object set to perform the inverse Bidi algorithm?
uchar.h
C API: Unicode Properties.
ubidi_getText
const UChar * ubidi_getText(const UBiDi *pBiDi)
Get the pointer to the text.
ubidi_reorderLogical
void ubidi_reorderLogical(const UBiDiLevel *levels, int32_t length, int32_t *indexMap)
This is a convenience function that does not use a UBiDi object.
UChar
uint16_t UChar
The base type for UTF-16 code units and pointers.
Definition: umachine.h:342
UBIDI_LTR
Left-to-right text.
Definition: ubidi.h:437
U_CDECL_END
#define U_CDECL_END
This is used to end a declaration of a library private ICU C API.
Definition: umachine.h:85
U_NAMESPACE_END
#define U_NAMESPACE_END
This is used to end a declaration of a public ICU C++ API.
Definition: uversion.h:138
UBIDI_REORDER_INVERSE_LIKE_DIRECT
Visual to Logical algorithm equivalent to the regular Logical to Visual algorithm.
Definition: ubidi.h:724
ubidi_getReorderingOptions
uint32_t ubidi_getReorderingOptions(UBiDi *pBiDi)
What are the reordering options applied to a given Bidi object?
ubidi_countRuns
int32_t ubidi_countRuns(UBiDi *pBiDi, UErrorCode *pErrorCode)
Get the number of runs.
ubidi_getVisualIndex
int32_t ubidi_getVisualIndex(UBiDi *pBiDi, int32_t logicalIndex, UErrorCode *pErrorCode)
Get the visual position from a logical text position.
UBiDi
struct UBiDi UBiDi
Definition: ubidi.h:482
ubidi_writeReordered
int32_t ubidi_writeReordered(UBiDi *pBiDi, UChar *dest, int32_t destSize, uint16_t options, UErrorCode *pErrorCode)
Take a UBiDi object containing the reordering information for a piece of text (one or more paragraphs...
ubidi_setPara
void ubidi_setPara(UBiDi *pBiDi, const UChar *text, int32_t length, UBiDiLevel paraLevel, UBiDiLevel *embeddingLevels, UErrorCode *pErrorCode)
Perform the Unicode Bidi algorithm.
ubidi_reorderVisual
void ubidi_reorderVisual(const UBiDiLevel *levels, int32_t length, int32_t *indexMap)
This is a convenience function that does not use a UBiDi object.
UErrorCode
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers...
Definition: utypes.h:401
UBIDI_REORDER_GROUP_NUMBERS_WITH_R
Logical to Visual algorithm grouping numbers with adjacent R characters (reversible algorithm)...
Definition: ubidi.h:707
LocalUBiDiPointer
"Smart pointer" class, closes a UBiDi via ubidi_close().
UBIDI_NEUTRAL
No strongly directional text.
Definition: ubidi.h:463
ubidi_invertMap
void ubidi_invertMap(const int32_t *srcMap, int32_t *destMap, int32_t length)
Invert an index map.
utypes.h
Basic definitions for ICU, for both C and C++ APIs.
UBiDiReorderingMode
UBiDiReorderingMode
UBiDiReorderingMode values indicate which variant of the Bidi algorithm to use.
Definition: ubidi.h:695
U_STABLE
#define U_STABLE
This is used to declare a function as a stable public ICU C API.
Definition: umachine.h:111
UBool
int8_t UBool
The ICU boolean type.
Definition: umachine.h:225
UBIDI_RTL
Right-to-left text.
Definition: ubidi.h:449