ICU 67.1  67.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 
464 };
465 
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 
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
687 
695 typedef enum UBiDiReorderingMode {
729 #ifndef U_HIDE_DEPRECATED_API
730 
735 #endif // U_HIDE_DEPRECATED_API
737 
889 U_STABLE void U_EXPORT2
890 ubidi_setReorderingMode(UBiDi *pBiDi, UBiDiReorderingMode reorderingMode);
891 
902 
910 typedef enum UBiDiReorderingOption {
918 
964 
982 
1031 
1045 U_STABLE void U_EXPORT2
1046 ubidi_setReorderingOptions(UBiDi *pBiDi, uint32_t reorderingOptions);
1047 
1056 U_STABLE uint32_t U_EXPORT2
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
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 
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 
2015 
2031 U_STABLE UCharDirection U_EXPORT2
2033 
2061 U_STABLE void U_EXPORT2
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
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
Logical to Visual algorithm which handles numbers in a way which mimics the behavior of Windows XP...
Definition: ubidi.h:703
UBiDi * ubidi_openSized(int32_t maxLength, int32_t maxRunCount, UErrorCode *pErrorCode)
Allocate a UBiDi structure with preallocated memory for internal structures.
Reorder runs only to transform a Logical LTR string to the Logical RTL string with the same display...
Definition: ubidi.h:715
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...
void ubidi_getClassCallback(UBiDi *pBiDi, UBiDiClassCallback **fn, const void **context)
Get the current callback function used for Bidi class determination.
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.
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...
option bit for ubidi_setReorderingOptions: process the output as part of a stream to be continued ...
Definition: ubidi.h:1029
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.
void ubidi_setReorderingOptions(UBiDi *pBiDi, uint32_t reorderingOptions)
Specify which of the reordering options should be applied during Bidi transformations.
int32_t ubidi_getLength(const UBiDi *pBiDi)
Get the length of the text.
void ubidi_getLogicalRun(const UBiDi *pBiDi, int32_t logicalPosition, int32_t *pLogicalLimit, UBiDiLevel *pLevel)
Get a logical run.
UBiDiDirection ubidi_getBaseDirection(const UChar *text, int32_t length)
Gets the base direction of the text provided according to the Unicode Bidirectional Algorithm...
UBiDiLevel ubidi_getLevelAt(const UBiDi *pBiDi, int32_t charIndex)
Get the level for one character.
Number of values for reordering mode.
Definition: ubidi.h:734
UCharDirection UBiDiClassCallback(const void *context, UChar32 c)
Callback type declaration for overriding default Bidi class values with custom ones.
Definition: ubidi.h:2012
option bit for ubidi_setReorderingOptions: remove Bidi control characters
Definition: ubidi.h:981
UCharDirection ubidi_getCustomizedClass(UBiDi *pBiDi, UChar32 c)
Retrieve the Bidi class for a given code point.
UBool ubidi_isOrderParagraphsLTR(UBiDi *pBiDi)
Is this Bidi object set to allocate level 0 to block separators so that successive paragraphs progres...
Visual to Logical algorithm which handles numbers like L (same algorithm as selected by ubidi_setInve...
Definition: ubidi.h:720
UCharDirection
This specifies the language directional property of a character set.
Definition: uchar.h:921
#define U_CALLCONV
Similar to U_CDECL_BEGIN/U_CDECL_END, this qualifier is necessary in callback function typedefs to ma...
Definition: platform.h:870
void ubidi_orderParagraphsLTR(UBiDi *pBiDi, UBool orderParagraphsLTR)
Specify whether block separators must be allocated level zero, so that successive paragraphs will pro...
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...
uint8_t UBiDiLevel
UBiDiLevel is the type of the level values in this Bidi implementation.
Definition: ubidi.h:336
Inverse Bidi (Visual to Logical) algorithm for the UBIDI_REORDER_NUMBERS_SPECIAL Bidi algorithm...
Definition: ubidi.h:728
Mixed-directional text.
Definition: ubidi.h:456
UBiDi * ubidi_open(void)
Allocate a UBiDi structure.
int32_t ubidi_getProcessedLength(const UBiDi *pBiDi)
Get the length of the source text processed by the last call to ubidi_setPara().
UBiDiReorderingOption
UBiDiReorderingOption values indicate which options are specified to affect the Bidi algorithm...
Definition: ubidi.h:910
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().
option value for ubidi_setReorderingOptions: disable all the options which can be set with this funct...
Definition: ubidi.h:917
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 values indicate the text direction.
Definition: ubidi.h:425
#define U_CDECL_BEGIN
This is used to begin a declaration of a library private ICU C API.
Definition: umachine.h:84
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...
UBiDiDirection ubidi_getDirection(const UBiDi *pBiDi)
Get the directionality of the text.
int32_t ubidi_getLogicalIndex(UBiDi *pBiDi, int32_t visualIndex, UErrorCode *pErrorCode)
Get the logical text position from a visual position.
#define U_DEFINE_LOCAL_OPEN_POINTER(LocalPointerClassName, Type, closeFunction)
"Smart pointer" definition macro, deletes objects via the closeFunction.
Definition: localpointer.h:550
C++ API: "Smart pointers" for use with and in ICU4C C++ code.
UBiDiReorderingMode ubidi_getReorderingMode(UBiDi *pBiDi)
What is the requested reordering mode for a given Bidi object?
int32_t ubidi_getResultLength(const UBiDi *pBiDi)
Get the length of the reordered text resulting from the last call to ubidi_setPara().
Regular Logical to Visual Bidi algorithm according to Unicode.
Definition: ubidi.h:699
const UBiDiLevel * ubidi_getLevels(UBiDi *pBiDi, UErrorCode *pErrorCode)
Get an array of levels for each character.
int32_t UChar32
Define UChar32 as a type for single Unicode code points.
Definition: umachine.h:425
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...
void ubidi_close(UBiDi *pBiDi)
ubidi_close() must be called to free the memory associated with a UBiDi object.
void ubidi_setInverse(UBiDi *pBiDi, UBool isInverse)
Modify the operation of the Bidi algorithm such that it approximates an "inverse Bidi" algorithm...
UBiDiDirection ubidi_getVisualRun(UBiDi *pBiDi, int32_t runIndex, int32_t *pLogicalStart, int32_t *pLength)
Get one run's logical start, length, and directionality, which can be 0 for LTR or 1 for RTL...
UBiDiLevel ubidi_getParaLevel(const UBiDi *pBiDi)
Get the paragraph level of the text.
option bit for ubidi_setReorderingOptions: insert Bidi marks (LRM or RLM) when needed to ensure corre...
Definition: ubidi.h:963
int32_t ubidi_countParagraphs(UBiDi *pBiDi)
Get the number of paragraphs.
UBool ubidi_isInverse(UBiDi *pBiDi)
Is this Bidi object set to perform the inverse Bidi algorithm?
C API: Unicode Properties.
const UChar * ubidi_getText(const UBiDi *pBiDi)
Get the pointer to the text.
void ubidi_reorderLogical(const UBiDiLevel *levels, int32_t length, int32_t *indexMap)
This is a convenience function that does not use a UBiDi object.
char16_t UChar
The base type for UTF-16 code units and pointers.
Definition: umachine.h:376
Left-to-right text.
Definition: ubidi.h:437
#define U_CDECL_END
This is used to end a declaration of a library private ICU C API.
Definition: umachine.h:85
Visual to Logical algorithm equivalent to the regular Logical to Visual algorithm.
Definition: ubidi.h:724
uint32_t ubidi_getReorderingOptions(UBiDi *pBiDi)
What are the reordering options applied to a given Bidi object?
int32_t ubidi_countRuns(UBiDi *pBiDi, UErrorCode *pErrorCode)
Get the number of runs.
int32_t ubidi_getVisualIndex(UBiDi *pBiDi, int32_t logicalIndex, UErrorCode *pErrorCode)
Get the visual position from a logical text position.
struct UBiDi UBiDi
Definition: ubidi.h:482
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...
void ubidi_setPara(UBiDi *pBiDi, const UChar *text, int32_t length, UBiDiLevel paraLevel, UBiDiLevel *embeddingLevels, UErrorCode *pErrorCode)
Perform the Unicode Bidi algorithm.
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
Standard ICU4C error code type, a substitute for exceptions.
Definition: utypes.h:415
Logical to Visual algorithm grouping numbers with adjacent R characters (reversible algorithm)...
Definition: ubidi.h:707
"Smart pointer" class, closes a UBiDi via ubidi_close().
No strongly directional text.
Definition: ubidi.h:463
void ubidi_invertMap(const int32_t *srcMap, int32_t *destMap, int32_t length)
Invert an index map.
Basic definitions for ICU, for both C and C++ APIs.
UBiDiReorderingMode
UBiDiReorderingMode values indicate which variant of the Bidi algorithm to use.
Definition: ubidi.h:695
#define U_STABLE
This is used to declare a function as a stable public ICU C API.
Definition: umachine.h:111
int8_t UBool
The ICU boolean type.
Definition: umachine.h:261
Right-to-left text.
Definition: ubidi.h:449