16f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/* 26f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org****************************************************************************** 36f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* 46f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* Copyright (C) 1999-2013, International Business Machines 56f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* Corporation and others. All Rights Reserved. 66f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* 76f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org****************************************************************************** 86f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* file name: ubidi.h 96f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* encoding: US-ASCII 106f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* tab size: 8 (not used) 116f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* indentation:4 126f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* 136f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* created on: 1999jul27 146f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* created by: Markus W. Scherer, updated by Matitiahu Allouche 156f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org*/ 166f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 176f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#ifndef UBIDI_H 186f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#define UBIDI_H 196f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 206f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#include "unicode/utypes.h" 216f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#include "unicode/uchar.h" 226f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#include "unicode/localpointer.h" 236f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 246f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 256f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org *\file 266f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * \brief C API: Bidi algorithm 276f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 286f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <h2>Bidi algorithm for ICU</h2> 296f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 306f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * This is an implementation of the Unicode Bidirectional Algorithm. 316f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * The algorithm is defined in the 326f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <a href="http://www.unicode.org/unicode/reports/tr9/">Unicode Standard Annex #9</a>.<p> 336f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 346f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Note: Libraries that perform a bidirectional algorithm and 356f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * reorder strings accordingly are sometimes called "Storage Layout Engines". 366f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * ICU's Bidi and shaping (u_shapeArabic()) APIs can be used at the core of such 376f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * "Storage Layout Engines". 386f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 396f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <h3>General remarks about the API:</h3> 406f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 416f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * In functions with an error code parameter, 426f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * the <code>pErrorCode</code> pointer must be valid 436f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * and the value that it points to must not indicate a failure before 446f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * the function call. Otherwise, the function returns immediately. 456f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * After the function call, the value indicates success or failure.<p> 466f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 476f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * The "limit" of a sequence of characters is the position just after their 486f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * last character, i.e., one more than that position.<p> 496f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 506f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Some of the API functions provide access to "runs". 516f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Such a "run" is defined as a sequence of characters 526f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * that are at the same embedding level 536f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * after performing the Bidi algorithm.<p> 546f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 556f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @author Markus W. Scherer 566f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @version 1.0 576f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 586f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 596f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <h4> Sample code for the ICU Bidi API </h4> 606f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 616f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <h5>Rendering a paragraph with the ICU Bidi API</h5> 626f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 636f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * This is (hypothetical) sample code that illustrates 646f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * how the ICU Bidi API could be used to render a paragraph of text. 656f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Rendering code depends highly on the graphics system, 666f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * therefore this sample code must make a lot of assumptions, 676f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * which may or may not match any existing graphics system's properties. 686f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 696f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <p>The basic assumptions are:</p> 706f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <ul> 716f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <li>Rendering is done from left to right on a horizontal line.</li> 726f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <li>A run of single-style, unidirectional text can be rendered at once.</li> 736f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <li>Such a run of text is passed to the graphics system with 746f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * characters (code units) in logical order.</li> 756f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <li>The line-breaking algorithm is very complicated 766f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * and Locale-dependent - 776f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * and therefore its implementation omitted from this sample code.</li> 786f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * </ul> 796f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 806f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <pre> 816f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * \code 826f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org *#include "unicode/ubidi.h" 836f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 846f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org *typedef enum { 856f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * styleNormal=0, styleSelected=1, 866f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * styleBold=2, styleItalics=4, 876f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * styleSuper=8, styleSub=16 886f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org *} Style; 896f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 906f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org *typedef struct { int32_t limit; Style style; } StyleRun; 916f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 926f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org *int getTextWidth(const UChar *text, int32_t start, int32_t limit, 936f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * const StyleRun *styleRuns, int styleRunCount); 946f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 956f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * // set *pLimit and *pStyleRunLimit for a line 966f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * // from text[start] and from styleRuns[styleRunStart] 976f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * // using ubidi_getLogicalRun(para, ...) 986f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org *void getLineBreak(const UChar *text, int32_t start, int32_t *pLimit, 996f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * UBiDi *para, 1006f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * const StyleRun *styleRuns, int styleRunStart, int *pStyleRunLimit, 1016f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * int *pLineWidth); 1026f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 1036f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * // render runs on a line sequentially, always from left to right 1046f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 1056f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * // prepare rendering a new line 1066f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * void startLine(UBiDiDirection textDirection, int lineWidth); 1076f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 1086f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * // render a run of text and advance to the right by the run width 1096f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * // the text[start..limit-1] is always in logical order 1106f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * void renderRun(const UChar *text, int32_t start, int32_t limit, 1116f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * UBiDiDirection textDirection, Style style); 1126f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 1136f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * // We could compute a cross-product 1146f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * // from the style runs with the directional runs 1156f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * // and then reorder it. 1166f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * // Instead, here we iterate over each run type 1176f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * // and render the intersections - 1186f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * // with shortcuts in simple (and common) cases. 1196f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * // renderParagraph() is the main function. 1206f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 1216f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * // render a directional run with 1226f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * // (possibly) multiple style runs intersecting with it 1236f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * void renderDirectionalRun(const UChar *text, 1246f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * int32_t start, int32_t limit, 1256f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * UBiDiDirection direction, 1266f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * const StyleRun *styleRuns, int styleRunCount) { 1276f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * int i; 1286f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 1296f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * // iterate over style runs 1306f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * if(direction==UBIDI_LTR) { 1316f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * int styleLimit; 1326f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 1336f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * for(i=0; i<styleRunCount; ++i) { 1346f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * styleLimit=styleRun[i].limit; 1356f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * if(start<styleLimit) { 1366f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * if(styleLimit>limit) { styleLimit=limit; } 1376f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * renderRun(text, start, styleLimit, 1386f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * direction, styleRun[i].style); 1396f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * if(styleLimit==limit) { break; } 1406f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * start=styleLimit; 1416f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * } 1426f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * } 1436f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * } else { 1446f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * int styleStart; 1456f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 1466f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * for(i=styleRunCount-1; i>=0; --i) { 1476f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * if(i>0) { 1486f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * styleStart=styleRun[i-1].limit; 1496f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * } else { 1506f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * styleStart=0; 1516f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * } 1526f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * if(limit>=styleStart) { 1536f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * if(styleStart<start) { styleStart=start; } 1546f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * renderRun(text, styleStart, limit, 1556f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * direction, styleRun[i].style); 1566f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * if(styleStart==start) { break; } 1576f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * limit=styleStart; 1586f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * } 1596f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * } 1606f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * } 1616f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * } 1626f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 1636f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * // the line object represents text[start..limit-1] 1646f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * void renderLine(UBiDi *line, const UChar *text, 1656f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * int32_t start, int32_t limit, 1666f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * const StyleRun *styleRuns, int styleRunCount) { 1676f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * UBiDiDirection direction=ubidi_getDirection(line); 1686f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * if(direction!=UBIDI_MIXED) { 1696f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * // unidirectional 1706f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * if(styleRunCount<=1) { 1716f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * renderRun(text, start, limit, direction, styleRuns[0].style); 1726f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * } else { 1736f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * renderDirectionalRun(text, start, limit, 1746f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * direction, styleRuns, styleRunCount); 1756f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * } 1766f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * } else { 1776f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * // mixed-directional 1786f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * int32_t count, i, length; 1796f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * UBiDiLevel level; 1806f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 1816f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * count=ubidi_countRuns(para, pErrorCode); 1826f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * if(U_SUCCESS(*pErrorCode)) { 1836f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * if(styleRunCount<=1) { 1846f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Style style=styleRuns[0].style; 1856f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 1866f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * // iterate over directional runs 1876f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * for(i=0; i<count; ++i) { 1886f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * direction=ubidi_getVisualRun(para, i, &start, &length); 1896f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * renderRun(text, start, start+length, direction, style); 1906f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * } 1916f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * } else { 1926f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * int32_t j; 1936f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 1946f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * // iterate over both directional and style runs 1956f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * for(i=0; i<count; ++i) { 1966f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * direction=ubidi_getVisualRun(line, i, &start, &length); 1976f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * renderDirectionalRun(text, start, start+length, 1986f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * direction, styleRuns, styleRunCount); 1996f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * } 2006f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * } 2016f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * } 2026f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * } 2036f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * } 2046f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 2056f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org *void renderParagraph(const UChar *text, int32_t length, 2066f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * UBiDiDirection textDirection, 2076f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * const StyleRun *styleRuns, int styleRunCount, 2086f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * int lineWidth, 2096f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * UErrorCode *pErrorCode) { 2106f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * UBiDi *para; 2116f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 2126f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * if(pErrorCode==NULL || U_FAILURE(*pErrorCode) || length<=0) { 2136f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * return; 2146f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * } 2156f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 2166f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * para=ubidi_openSized(length, 0, pErrorCode); 2176f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * if(para==NULL) { return; } 2186f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 2196f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * ubidi_setPara(para, text, length, 2206f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * textDirection ? UBIDI_DEFAULT_RTL : UBIDI_DEFAULT_LTR, 2216f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * NULL, pErrorCode); 2226f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * if(U_SUCCESS(*pErrorCode)) { 2236f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * UBiDiLevel paraLevel=1&ubidi_getParaLevel(para); 2246f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * StyleRun styleRun={ length, styleNormal }; 2256f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * int width; 2266f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 2276f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * if(styleRuns==NULL || styleRunCount<=0) { 2286f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * styleRunCount=1; 2296f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * styleRuns=&styleRun; 2306f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * } 2316f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 2326f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * // assume styleRuns[styleRunCount-1].limit>=length 2336f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 2346f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * width=getTextWidth(text, 0, length, styleRuns, styleRunCount); 2356f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * if(width<=lineWidth) { 2366f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * // everything fits onto one line 2376f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 2386f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * // prepare rendering a new line from either left or right 2396f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * startLine(paraLevel, width); 2406f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 2416f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * renderLine(para, text, 0, length, 2426f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * styleRuns, styleRunCount); 2436f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * } else { 2446f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * UBiDi *line; 2456f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 2466f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * // we need to render several lines 2476f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * line=ubidi_openSized(length, 0, pErrorCode); 2486f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * if(line!=NULL) { 2496f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * int32_t start=0, limit; 2506f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * int styleRunStart=0, styleRunLimit; 2516f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 2526f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * for(;;) { 2536f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * limit=length; 2546f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * styleRunLimit=styleRunCount; 2556f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * getLineBreak(text, start, &limit, para, 2566f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * styleRuns, styleRunStart, &styleRunLimit, 2576f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * &width); 2586f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * ubidi_setLine(para, start, limit, line, pErrorCode); 2596f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * if(U_SUCCESS(*pErrorCode)) { 2606f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * // prepare rendering a new line 2616f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * // from either left or right 2626f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * startLine(paraLevel, width); 2636f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 2646f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * renderLine(line, text, start, limit, 2656f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * styleRuns+styleRunStart, 2666f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * styleRunLimit-styleRunStart); 2676f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * } 2686f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * if(limit==length) { break; } 2696f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * start=limit; 2706f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * styleRunStart=styleRunLimit-1; 2716f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * if(start>=styleRuns[styleRunStart].limit) { 2726f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * ++styleRunStart; 2736f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * } 2746f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * } 2756f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 2766f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * ubidi_close(line); 2776f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * } 2786f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * } 2796f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * } 2806f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 2816f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * ubidi_close(para); 2826f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org *} 2836f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org *\endcode 2846f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * </pre> 2856f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 2866f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 2876f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/*DOCXX_TAG*/ 2886f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/*@{*/ 2896f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 2906f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 2916f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * UBiDiLevel is the type of the level values in this 2926f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Bidi implementation. 2936f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * It holds an embedding level and indicates the visual direction 2946f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * by its bit 0 (even/odd value).<p> 2956f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 2966f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * It can also hold non-level values for the 2976f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>paraLevel</code> and <code>embeddingLevels</code> 2986f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * arguments of <code>ubidi_setPara()</code>; there: 2996f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <ul> 3006f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <li>bit 7 of an <code>embeddingLevels[]</code> 3016f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * value indicates whether the using application is 3026f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * specifying the level of a character to <i>override</i> whatever the 3036f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Bidi implementation would resolve it to.</li> 3046f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <li><code>paraLevel</code> can be set to the 3056f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * pseudo-level values <code>UBIDI_DEFAULT_LTR</code> 3066f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * and <code>UBIDI_DEFAULT_RTL</code>.</li> 3076f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * </ul> 3086f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 3096f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_setPara 3106f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 3116f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <p>The related constants are not real, valid level values. 3126f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>UBIDI_DEFAULT_XXX</code> can be used to specify 3136f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * a default for the paragraph level for 3146f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * when the <code>ubidi_setPara()</code> function 3156f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * shall determine it but there is no 3166f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * strongly typed character in the input.<p> 3176f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 3186f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Note that the value for <code>UBIDI_DEFAULT_LTR</code> is even 3196f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * and the one for <code>UBIDI_DEFAULT_RTL</code> is odd, 3206f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * just like with normal LTR and RTL level values - 3216f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * these special values are designed that way. Also, the implementation 3226f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * assumes that UBIDI_MAX_EXPLICIT_LEVEL is odd. 3236f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 3246f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see UBIDI_DEFAULT_LTR 3256f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see UBIDI_DEFAULT_RTL 3266f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see UBIDI_LEVEL_OVERRIDE 3276f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see UBIDI_MAX_EXPLICIT_LEVEL 3286f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 3296f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 3306f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgtypedef uint8_t UBiDiLevel; 3316f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 3326f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** Paragraph level setting.<p> 3336f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 3346f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Constant indicating that the base direction depends on the first strong 3356f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * directional character in the text according to the Unicode Bidirectional 3366f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Algorithm. If no strong directional character is present, 3376f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * then set the paragraph level to 0 (left-to-right).<p> 3386f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 3396f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * If this value is used in conjunction with reordering modes 3406f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>UBIDI_REORDER_INVERSE_LIKE_DIRECT</code> or 3416f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>UBIDI_REORDER_INVERSE_FOR_NUMBERS_SPECIAL</code>, the text to reorder 3426f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * is assumed to be visual LTR, and the text after reordering is required 3436f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * to be the corresponding logical string with appropriate contextual 3446f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * direction. The direction of the result string will be RTL if either 3456f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * the righmost or leftmost strong character of the source text is RTL 3466f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * or Arabic Letter, the direction will be LTR otherwise.<p> 3476f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 3486f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * If reordering option <code>UBIDI_OPTION_INSERT_MARKS</code> is set, an RLM may 3496f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * be added at the beginning of the result string to ensure round trip 3506f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * (that the result string, when reordered back to visual, will produce 3516f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * the original source text). 3526f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see UBIDI_REORDER_INVERSE_LIKE_DIRECT 3536f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see UBIDI_REORDER_INVERSE_FOR_NUMBERS_SPECIAL 3546f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 3556f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 3566f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#define UBIDI_DEFAULT_LTR 0xfe 3576f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 3586f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** Paragraph level setting.<p> 3596f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 3606f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Constant indicating that the base direction depends on the first strong 3616f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * directional character in the text according to the Unicode Bidirectional 3626f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Algorithm. If no strong directional character is present, 3636f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * then set the paragraph level to 1 (right-to-left).<p> 3646f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 3656f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * If this value is used in conjunction with reordering modes 3666f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>UBIDI_REORDER_INVERSE_LIKE_DIRECT</code> or 3676f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>UBIDI_REORDER_INVERSE_FOR_NUMBERS_SPECIAL</code>, the text to reorder 3686f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * is assumed to be visual LTR, and the text after reordering is required 3696f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * to be the corresponding logical string with appropriate contextual 3706f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * direction. The direction of the result string will be RTL if either 3716f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * the righmost or leftmost strong character of the source text is RTL 3726f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * or Arabic Letter, or if the text contains no strong character; 3736f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * the direction will be LTR otherwise.<p> 3746f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 3756f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * If reordering option <code>UBIDI_OPTION_INSERT_MARKS</code> is set, an RLM may 3766f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * be added at the beginning of the result string to ensure round trip 3776f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * (that the result string, when reordered back to visual, will produce 3786f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * the original source text). 3796f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see UBIDI_REORDER_INVERSE_LIKE_DIRECT 3806f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see UBIDI_REORDER_INVERSE_FOR_NUMBERS_SPECIAL 3816f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 3826f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 3836f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#define UBIDI_DEFAULT_RTL 0xff 3846f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 3856f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 3866f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Maximum explicit embedding level. 3876f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * (The maximum resolved level can be up to <code>UBIDI_MAX_EXPLICIT_LEVEL+1</code>). 3886f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 3896f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 3906f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#define UBIDI_MAX_EXPLICIT_LEVEL 125 3916f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 3926f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** Bit flag for level input. 3936f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Overrides directional properties. 3946f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 3956f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 3966f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#define UBIDI_LEVEL_OVERRIDE 0x80 3976f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 3986f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 3996f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Special value which can be returned by the mapping functions when a logical 4006f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * index has no corresponding visual index or vice-versa. This may happen 4016f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * for the logical-to-visual mapping of a Bidi control when option 4026f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>#UBIDI_OPTION_REMOVE_CONTROLS</code> is specified. This can also happen 4036f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * for the visual-to-logical mapping of a Bidi mark (LRM or RLM) inserted 4046f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * by option <code>#UBIDI_OPTION_INSERT_MARKS</code>. 4056f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_getVisualIndex 4066f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_getVisualMap 4076f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_getLogicalIndex 4086f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_getLogicalMap 4096f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 3.6 4106f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 4116f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#define UBIDI_MAP_NOWHERE (-1) 4126f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 4136f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 4146f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>UBiDiDirection</code> values indicate the text direction. 4156f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 4166f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 4176f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgenum UBiDiDirection { 4186f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** Left-to-right text. This is a 0 value. 4196f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <ul> 4206f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <li>As return value for <code>ubidi_getDirection()</code>, it means 4216f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * that the source string contains no right-to-left characters, or 4226f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * that the source string is empty and the paragraph level is even. 4236f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <li> As return value for <code>ubidi_getBaseDirection()</code>, it 4246f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * means that the first strong character of the source string has 4256f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * a left-to-right direction. 4266f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * </ul> 4276f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 4286f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 4296f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UBIDI_LTR, 4306f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** Right-to-left text. This is a 1 value. 4316f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <ul> 4326f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <li>As return value for <code>ubidi_getDirection()</code>, it means 4336f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * that the source string contains no left-to-right characters, or 4346f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * that the source string is empty and the paragraph level is odd. 4356f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <li> As return value for <code>ubidi_getBaseDirection()</code>, it 4366f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * means that the first strong character of the source string has 4376f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * a right-to-left direction. 4386f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * </ul> 4396f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 4406f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 4416f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UBIDI_RTL, 4426f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** Mixed-directional text. 4436f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <p>As return value for <code>ubidi_getDirection()</code>, it means 4446f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * that the source string contains both left-to-right and 4456f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * right-to-left characters. 4466f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 4476f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 4486f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UBIDI_MIXED, 4496f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** No strongly directional text. 4506f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <p>As return value for <code>ubidi_getBaseDirection()</code>, it means 4516f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * that the source string is missing or empty, or contains neither left-to-right 4526f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * nor right-to-left characters. 4536f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 4.6 4546f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 4556f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UBIDI_NEUTRAL 4566f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org}; 4576f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 4586f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** @stable ICU 2.0 */ 4596f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgtypedef enum UBiDiDirection UBiDiDirection; 4606f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 4616f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 4626f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Forward declaration of the <code>UBiDi</code> structure for the declaration of 4636f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * the API functions. Its fields are implementation-specific.<p> 4646f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * This structure holds information about a paragraph (or multiple paragraphs) 4656f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * of text with Bidi-algorithm-related details, or about one line of 4666f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * such a paragraph.<p> 4676f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Reordering can be done on a line, or on one or more paragraphs which are 4686f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * then interpreted each as one single line. 4696f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 4706f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 4716f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgstruct UBiDi; 4726f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 4736f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** @stable ICU 2.0 */ 4746f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgtypedef struct UBiDi UBiDi; 4756f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 4766f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 4776f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Allocate a <code>UBiDi</code> structure. 4786f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Such an object is initially empty. It is assigned 4796f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * the Bidi properties of a piece of text containing one or more paragraphs 4806f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * by <code>ubidi_setPara()</code> 4816f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * or the Bidi properties of a line within a paragraph by 4826f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>ubidi_setLine()</code>.<p> 4836f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * This object can be reused for as long as it is not deallocated 4846f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * by calling <code>ubidi_close()</code>.<p> 4856f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>ubidi_setPara()</code> and <code>ubidi_setLine()</code> will allocate 4866f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * additional memory for internal structures as necessary. 4876f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 4886f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return An empty <code>UBiDi</code> object. 4896f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 4906f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 4916f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgU_STABLE UBiDi * U_EXPORT2 4926f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgubidi_open(void); 4936f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 4946f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 4956f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Allocate a <code>UBiDi</code> structure with preallocated memory 4966f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * for internal structures. 4976f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * This function provides a <code>UBiDi</code> object like <code>ubidi_open()</code> 4986f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * with no arguments, but it also preallocates memory for internal structures 4996f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * according to the sizings supplied by the caller.<p> 5006f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Subsequent functions will not allocate any more memory, and are thus 5016f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * guaranteed not to fail because of lack of memory.<p> 5026f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * The preallocation can be limited to some of the internal memory 5036f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * by setting some values to 0 here. That means that if, e.g., 5046f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>maxRunCount</code> cannot be reasonably predetermined and should not 5056f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * be set to <code>maxLength</code> (the only failproof value) to avoid 5066f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * wasting memory, then <code>maxRunCount</code> could be set to 0 here 5076f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * and the internal structures that are associated with it will be allocated 5086f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * on demand, just like with <code>ubidi_open()</code>. 5096f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 5106f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param maxLength is the maximum text or line length that internal memory 5116f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * will be preallocated for. An attempt to associate this object with a 5126f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * longer text will fail, unless this value is 0, which leaves the allocation 5136f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * up to the implementation. 5146f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 5156f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param maxRunCount is the maximum anticipated number of same-level runs 5166f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * that internal memory will be preallocated for. An attempt to access 5176f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * visual runs on an object that was not preallocated for as many runs 5186f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * as the text was actually resolved to will fail, 5196f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * unless this value is 0, which leaves the allocation up to the implementation.<br><br> 5206f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * The number of runs depends on the actual text and maybe anywhere between 5216f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 1 and <code>maxLength</code>. It is typically small. 5226f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 5236f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pErrorCode must be a valid pointer to an error code value. 5246f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 5256f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return An empty <code>UBiDi</code> object with preallocated memory. 5266f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 5276f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 5286f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgU_STABLE UBiDi * U_EXPORT2 5296f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgubidi_openSized(int32_t maxLength, int32_t maxRunCount, UErrorCode *pErrorCode); 5306f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 5316f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 5326f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>ubidi_close()</code> must be called to free the memory 5336f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * associated with a UBiDi object.<p> 5346f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 5356f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <strong>Important: </strong> 5366f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * A parent <code>UBiDi</code> object must not be destroyed or reused if 5376f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * it still has children. 5386f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * If a <code>UBiDi</code> object has become the <i>child</i> 5396f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * of another one (its <i>parent</i>) by calling 5406f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>ubidi_setLine()</code>, then the child object must 5416f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * be destroyed (closed) or reused (by calling 5426f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>ubidi_setPara()</code> or <code>ubidi_setLine()</code>) 5436f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * before the parent object. 5446f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 5456f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pBiDi is a <code>UBiDi</code> object. 5466f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 5476f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_setPara 5486f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_setLine 5496f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 5506f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 5516f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgU_STABLE void U_EXPORT2 5526f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgubidi_close(UBiDi *pBiDi); 5536f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 5546f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#if U_SHOW_CPLUSPLUS_API 5556f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 5566f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgU_NAMESPACE_BEGIN 5576f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 5586f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 5596f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * \class LocalUBiDiPointer 5606f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * "Smart pointer" class, closes a UBiDi via ubidi_close(). 5616f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * For most methods see the LocalPointerBase base class. 5626f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 5636f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see LocalPointerBase 5646f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see LocalPointer 5656f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 4.4 5666f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 5676f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgU_DEFINE_LOCAL_OPEN_POINTER(LocalUBiDiPointer, UBiDi, ubidi_close); 5686f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 5696f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgU_NAMESPACE_END 5706f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 5716f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#endif 5726f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 5736f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 5746f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Modify the operation of the Bidi algorithm such that it 5756f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * approximates an "inverse Bidi" algorithm. This function 5766f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * must be called before <code>ubidi_setPara()</code>. 5776f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 5786f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <p>The normal operation of the Bidi algorithm as described 5796f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * in the Unicode Technical Report is to take text stored in logical 5806f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * (keyboard, typing) order and to determine the reordering of it for visual 5816f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * rendering. 5826f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Some legacy systems store text in visual order, and for operations 5836f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * with standard, Unicode-based algorithms, the text needs to be transformed 5846f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * to logical order. This is effectively the inverse algorithm of the 5856f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * described Bidi algorithm. Note that there is no standard algorithm for 5866f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * this "inverse Bidi" and that the current implementation provides only an 5876f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * approximation of "inverse Bidi".</p> 5886f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 5896f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <p>With <code>isInverse</code> set to <code>TRUE</code>, 5906f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * this function changes the behavior of some of the subsequent functions 5916f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * in a way that they can be used for the inverse Bidi algorithm. 5926f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Specifically, runs of text with numeric characters will be treated in a 5936f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * special way and may need to be surrounded with LRM characters when they are 5946f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * written in reordered sequence.</p> 5956f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 5966f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <p>Output runs should be retrieved using <code>ubidi_getVisualRun()</code>. 5976f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Since the actual input for "inverse Bidi" is visually ordered text and 5986f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>ubidi_getVisualRun()</code> gets the reordered runs, these are actually 5996f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * the runs of the logically ordered output.</p> 6006f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 6016f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <p>Calling this function with argument <code>isInverse</code> set to 6026f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>TRUE</code> is equivalent to calling 6036f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>ubidi_setReorderingMode</code> with argument 6046f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>reorderingMode</code> 6056f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * set to <code>#UBIDI_REORDER_INVERSE_NUMBERS_AS_L</code>.<br> 6066f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Calling this function with argument <code>isInverse</code> set to 6076f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>FALSE</code> is equivalent to calling 6086f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>ubidi_setReorderingMode</code> with argument 6096f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>reorderingMode</code> 6106f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * set to <code>#UBIDI_REORDER_DEFAULT</code>. 6116f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 6126f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pBiDi is a <code>UBiDi</code> object. 6136f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 6146f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param isInverse specifies "forward" or "inverse" Bidi operation. 6156f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 6166f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_setPara 6176f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_writeReordered 6186f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_setReorderingMode 6196f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 6206f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 6216f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgU_STABLE void U_EXPORT2 6226f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgubidi_setInverse(UBiDi *pBiDi, UBool isInverse); 6236f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 6246f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 6256f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Is this Bidi object set to perform the inverse Bidi algorithm? 6266f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <p>Note: calling this function after setting the reordering mode with 6276f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>ubidi_setReorderingMode</code> will return <code>TRUE</code> if the 6286f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * reordering mode was set to <code>#UBIDI_REORDER_INVERSE_NUMBERS_AS_L</code>, 6296f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>FALSE</code> for all other values.</p> 6306f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 6316f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pBiDi is a <code>UBiDi</code> object. 6326f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return TRUE if the Bidi object is set to perform the inverse Bidi algorithm 6336f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * by handling numbers as L. 6346f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 6356f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_setInverse 6366f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_setReorderingMode 6376f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 6386f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 6396f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 6406f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgU_STABLE UBool U_EXPORT2 6416f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgubidi_isInverse(UBiDi *pBiDi); 6426f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 6436f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 6446f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Specify whether block separators must be allocated level zero, 6456f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * so that successive paragraphs will progress from left to right. 6466f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * This function must be called before <code>ubidi_setPara()</code>. 6476f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Paragraph separators (B) may appear in the text. Setting them to level zero 6486f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * means that all paragraph separators (including one possibly appearing 6496f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * in the last text position) are kept in the reordered text after the text 6506f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * that they follow in the source text. 6516f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * When this feature is not enabled, a paragraph separator at the last 6526f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * position of the text before reordering will go to the first position 6536f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * of the reordered text when the paragraph level is odd. 6546f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 6556f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pBiDi is a <code>UBiDi</code> object. 6566f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 6576f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param orderParagraphsLTR specifies whether paragraph separators (B) must 6586f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * receive level 0, so that successive paragraphs progress from left to right. 6596f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 6606f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_setPara 6616f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 3.4 6626f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 6636f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgU_STABLE void U_EXPORT2 6646f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgubidi_orderParagraphsLTR(UBiDi *pBiDi, UBool orderParagraphsLTR); 6656f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 6666f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 6676f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Is this Bidi object set to allocate level 0 to block separators so that 6686f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * successive paragraphs progress from left to right? 6696f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 6706f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pBiDi is a <code>UBiDi</code> object. 6716f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return TRUE if the Bidi object is set to allocate level 0 to block 6726f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * separators. 6736f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 6746f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_orderParagraphsLTR 6756f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 3.4 6766f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 6776f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgU_STABLE UBool U_EXPORT2 6786f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgubidi_isOrderParagraphsLTR(UBiDi *pBiDi); 6796f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 6806f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 6816f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>UBiDiReorderingMode</code> values indicate which variant of the Bidi 6826f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * algorithm to use. 6836f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 6846f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_setReorderingMode 6856f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 3.6 6866f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 6876f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgtypedef enum UBiDiReorderingMode { 6886f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** Regular Logical to Visual Bidi algorithm according to Unicode. 6896f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * This is a 0 value. 6906f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 3.6 */ 6916f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UBIDI_REORDER_DEFAULT = 0, 6926f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** Logical to Visual algorithm which handles numbers in a way which 6936f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * mimicks the behavior of Windows XP. 6946f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 3.6 */ 6956f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UBIDI_REORDER_NUMBERS_SPECIAL, 6966f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** Logical to Visual algorithm grouping numbers with adjacent R characters 6976f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * (reversible algorithm). 6986f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 3.6 */ 6996f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UBIDI_REORDER_GROUP_NUMBERS_WITH_R, 7006f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** Reorder runs only to transform a Logical LTR string to the Logical RTL 7016f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * string with the same display, or vice-versa.<br> 7026f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * If this mode is set together with option 7036f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>#UBIDI_OPTION_INSERT_MARKS</code>, some Bidi controls in the source 7046f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * text may be removed and other controls may be added to produce the 7056f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * minimum combination which has the required display. 7066f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 3.6 */ 7076f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UBIDI_REORDER_RUNS_ONLY, 7086f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** Visual to Logical algorithm which handles numbers like L 7096f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * (same algorithm as selected by <code>ubidi_setInverse(TRUE)</code>. 7106f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_setInverse 7116f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 3.6 */ 7126f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UBIDI_REORDER_INVERSE_NUMBERS_AS_L, 7136f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** Visual to Logical algorithm equivalent to the regular Logical to Visual 7146f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * algorithm. 7156f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 3.6 */ 7166f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UBIDI_REORDER_INVERSE_LIKE_DIRECT, 7176f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** Inverse Bidi (Visual to Logical) algorithm for the 7186f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>UBIDI_REORDER_NUMBERS_SPECIAL</code> Bidi algorithm. 7196f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 3.6 */ 7206f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UBIDI_REORDER_INVERSE_FOR_NUMBERS_SPECIAL, 7216f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** Number of values for reordering mode. 7226f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 3.6 */ 7236f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UBIDI_REORDER_COUNT 7246f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org} UBiDiReorderingMode; 7256f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 7266f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 7276f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Modify the operation of the Bidi algorithm such that it implements some 7286f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * variant to the basic Bidi algorithm or approximates an "inverse Bidi" 7296f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * algorithm, depending on different values of the "reordering mode". 7306f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * This function must be called before <code>ubidi_setPara()</code>, and stays 7316f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * in effect until called again with a different argument. 7326f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 7336f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <p>The normal operation of the Bidi algorithm as described 7346f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * in the Unicode Standard Annex #9 is to take text stored in logical 7356f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * (keyboard, typing) order and to determine how to reorder it for visual 7366f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * rendering.</p> 7376f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 7386f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <p>With the reordering mode set to a value other than 7396f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>#UBIDI_REORDER_DEFAULT</code>, this function changes the behavior of 7406f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * some of the subsequent functions in a way such that they implement an 7416f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * inverse Bidi algorithm or some other algorithm variants.</p> 7426f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 7436f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <p>Some legacy systems store text in visual order, and for operations 7446f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * with standard, Unicode-based algorithms, the text needs to be transformed 7456f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * into logical order. This is effectively the inverse algorithm of the 7466f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * described Bidi algorithm. Note that there is no standard algorithm for 7476f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * this "inverse Bidi", so a number of variants are implemented here.</p> 7486f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 7496f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <p>In other cases, it may be desirable to emulate some variant of the 7506f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Logical to Visual algorithm (e.g. one used in MS Windows), or perform a 7516f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Logical to Logical transformation.</p> 7526f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 7536f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <ul> 7546f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <li>When the reordering mode is set to <code>#UBIDI_REORDER_DEFAULT</code>, 7556f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * the standard Bidi Logical to Visual algorithm is applied.</li> 7566f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 7576f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <li>When the reordering mode is set to 7586f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>#UBIDI_REORDER_NUMBERS_SPECIAL</code>, 7596f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * the algorithm used to perform Bidi transformations when calling 7606f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>ubidi_setPara</code> should approximate the algorithm used in 7616f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Microsoft Windows XP rather than strictly conform to the Unicode Bidi 7626f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * algorithm. 7636f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <br> 7646f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * The differences between the basic algorithm and the algorithm addressed 7656f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * by this option are as follows: 7666f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <ul> 7676f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <li>Within text at an even embedding level, the sequence "123AB" 7686f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * (where AB represent R or AL letters) is transformed to "123BA" by the 7696f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Unicode algorithm and to "BA123" by the Windows algorithm.</li> 7706f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <li>Arabic-Indic numbers (AN) are handled by the Windows algorithm just 7716f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * like regular numbers (EN).</li> 7726f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * </ul></li> 7736f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 7746f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <li>When the reordering mode is set to 7756f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>#UBIDI_REORDER_GROUP_NUMBERS_WITH_R</code>, 7766f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * numbers located between LTR text and RTL text are associated with the RTL 7776f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * text. For instance, an LTR paragraph with content "abc 123 DEF" (where 7786f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * upper case letters represent RTL characters) will be transformed to 7796f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * "abc FED 123" (and not "abc 123 FED"), "DEF 123 abc" will be transformed 7806f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * to "123 FED abc" and "123 FED abc" will be transformed to "DEF 123 abc". 7816f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * This makes the algorithm reversible and makes it useful when round trip 7826f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * (from visual to logical and back to visual) must be achieved without 7836f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * adding LRM characters. However, this is a variation from the standard 7846f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Unicode Bidi algorithm.<br> 7856f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * The source text should not contain Bidi control characters other than LRM 7866f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * or RLM.</li> 7876f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 7886f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <li>When the reordering mode is set to 7896f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>#UBIDI_REORDER_RUNS_ONLY</code>, 7906f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * a "Logical to Logical" transformation must be performed: 7916f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <ul> 7926f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <li>If the default text level of the source text (argument <code>paraLevel</code> 7936f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * in <code>ubidi_setPara</code>) is even, the source text will be handled as 7946f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * LTR logical text and will be transformed to the RTL logical text which has 7956f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * the same LTR visual display.</li> 7966f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <li>If the default level of the source text is odd, the source text 7976f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * will be handled as RTL logical text and will be transformed to the 7986f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * LTR logical text which has the same LTR visual display.</li> 7996f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * </ul> 8006f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * This mode may be needed when logical text which is basically Arabic or 8016f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Hebrew, with possible included numbers or phrases in English, has to be 8026f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * displayed as if it had an even embedding level (this can happen if the 8036f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * displaying application treats all text as if it was basically LTR). 8046f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <br> 8056f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * This mode may also be needed in the reverse case, when logical text which is 8066f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * basically English, with possible included phrases in Arabic or Hebrew, has to 8076f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * be displayed as if it had an odd embedding level. 8086f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <br> 8096f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Both cases could be handled by adding LRE or RLE at the head of the text, 8106f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * if the display subsystem supports these formatting controls. If it does not, 8116f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * the problem may be handled by transforming the source text in this mode 8126f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * before displaying it, so that it will be displayed properly.<br> 8136f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * The source text should not contain Bidi control characters other than LRM 8146f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * or RLM.</li> 8156f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 8166f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <li>When the reordering mode is set to 8176f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>#UBIDI_REORDER_INVERSE_NUMBERS_AS_L</code>, an "inverse Bidi" algorithm 8186f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * is applied. 8196f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Runs of text with numeric characters will be treated like LTR letters and 8206f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * may need to be surrounded with LRM characters when they are written in 8216f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * reordered sequence (the option <code>#UBIDI_INSERT_LRM_FOR_NUMERIC</code> can 8226f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * be used with function <code>ubidi_writeReordered</code> to this end. This 8236f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * mode is equivalent to calling <code>ubidi_setInverse()</code> with 8246f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * argument <code>isInverse</code> set to <code>TRUE</code>.</li> 8256f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 8266f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <li>When the reordering mode is set to 8276f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>#UBIDI_REORDER_INVERSE_LIKE_DIRECT</code>, the "direct" Logical to Visual 8286f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Bidi algorithm is used as an approximation of an "inverse Bidi" algorithm. 8296f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * This mode is similar to mode <code>#UBIDI_REORDER_INVERSE_NUMBERS_AS_L</code> 8306f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * but is closer to the regular Bidi algorithm. 8316f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <br> 8326f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * For example, an LTR paragraph with the content "FED 123 456 CBA" (where 8336f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * upper case represents RTL characters) will be transformed to 8346f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * "ABC 456 123 DEF", as opposed to "DEF 123 456 ABC" 8356f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * with mode <code>UBIDI_REORDER_INVERSE_NUMBERS_AS_L</code>.<br> 8366f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * When used in conjunction with option 8376f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>#UBIDI_OPTION_INSERT_MARKS</code>, this mode generally 8386f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * adds Bidi marks to the output significantly more sparingly than mode 8396f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>#UBIDI_REORDER_INVERSE_NUMBERS_AS_L</code> with option 8406f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>#UBIDI_INSERT_LRM_FOR_NUMERIC</code> in calls to 8416f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>ubidi_writeReordered</code>.</li> 8426f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 8436f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <li>When the reordering mode is set to 8446f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>#UBIDI_REORDER_INVERSE_FOR_NUMBERS_SPECIAL</code>, the Logical to Visual 8456f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Bidi algorithm used in Windows XP is used as an approximation of an "inverse Bidi" algorithm. 8466f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <br> 8476f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * For example, an LTR paragraph with the content "abc FED123" (where 8486f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * upper case represents RTL characters) will be transformed to "abc 123DEF."</li> 8496f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * </ul> 8506f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 8516f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <p>In all the reordering modes specifying an "inverse Bidi" algorithm 8526f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * (i.e. those with a name starting with <code>UBIDI_REORDER_INVERSE</code>), 8536f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * output runs should be retrieved using 8546f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>ubidi_getVisualRun()</code>, and the output text with 8556f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>ubidi_writeReordered()</code>. The caller should keep in mind that in 8566f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * "inverse Bidi" modes the input is actually visually ordered text and 8576f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * reordered output returned by <code>ubidi_getVisualRun()</code> or 8586f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>ubidi_writeReordered()</code> are actually runs or character string 8596f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * of logically ordered output.<br> 8606f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * For all the "inverse Bidi" modes, the source text should not contain 8616f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Bidi control characters other than LRM or RLM.</p> 8626f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 8636f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <p>Note that option <code>#UBIDI_OUTPUT_REVERSE</code> of 8646f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>ubidi_writeReordered</code> has no useful meaning and should not be 8656f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * used in conjunction with any value of the reordering mode specifying 8666f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * "inverse Bidi" or with value <code>UBIDI_REORDER_RUNS_ONLY</code>. 8676f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 8686f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pBiDi is a <code>UBiDi</code> object. 8696f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param reorderingMode specifies the required variant of the Bidi algorithm. 8706f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 8716f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see UBiDiReorderingMode 8726f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_setInverse 8736f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_setPara 8746f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_writeReordered 8756f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 3.6 8766f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 8776f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgU_STABLE void U_EXPORT2 8786f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgubidi_setReorderingMode(UBiDi *pBiDi, UBiDiReorderingMode reorderingMode); 8796f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 8806f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 8816f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * What is the requested reordering mode for a given Bidi object? 8826f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 8836f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pBiDi is a <code>UBiDi</code> object. 8846f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return the current reordering mode of the Bidi object 8856f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_setReorderingMode 8866f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 3.6 8876f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 8886f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgU_STABLE UBiDiReorderingMode U_EXPORT2 8896f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgubidi_getReorderingMode(UBiDi *pBiDi); 8906f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 8916f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 8926f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>UBiDiReorderingOption</code> values indicate which options are 8936f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * specified to affect the Bidi algorithm. 8946f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 8956f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_setReorderingOptions 8966f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 3.6 8976f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 8986f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgtypedef enum UBiDiReorderingOption { 8996f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 9006f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * option value for <code>ubidi_setReorderingOptions</code>: 9016f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * disable all the options which can be set with this function 9026f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_setReorderingOptions 9036f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 3.6 9046f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 9056f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UBIDI_OPTION_DEFAULT = 0, 9066f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 9076f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 9086f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * option bit for <code>ubidi_setReorderingOptions</code>: 9096f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * insert Bidi marks (LRM or RLM) when needed to ensure correct result of 9106f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * a reordering to a Logical order 9116f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 9126f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <p>This option must be set or reset before calling 9136f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>ubidi_setPara</code>.</p> 9146f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 9156f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <p>This option is significant only with reordering modes which generate 9166f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * a result with Logical order, specifically:</p> 9176f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <ul> 9186f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <li><code>#UBIDI_REORDER_RUNS_ONLY</code></li> 9196f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <li><code>#UBIDI_REORDER_INVERSE_NUMBERS_AS_L</code></li> 9206f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <li><code>#UBIDI_REORDER_INVERSE_LIKE_DIRECT</code></li> 9216f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <li><code>#UBIDI_REORDER_INVERSE_FOR_NUMBERS_SPECIAL</code></li> 9226f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * </ul> 9236f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 9246f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <p>If this option is set in conjunction with reordering mode 9256f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>#UBIDI_REORDER_INVERSE_NUMBERS_AS_L</code> or with calling 9266f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>ubidi_setInverse(TRUE)</code>, it implies 9276f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * option <code>#UBIDI_INSERT_LRM_FOR_NUMERIC</code> 9286f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * in calls to function <code>ubidi_writeReordered()</code>.</p> 9296f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 9306f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <p>For other reordering modes, a minimum number of LRM or RLM characters 9316f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * will be added to the source text after reordering it so as to ensure 9326f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * round trip, i.e. when applying the inverse reordering mode on the 9336f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * resulting logical text with removal of Bidi marks 9346f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * (option <code>#UBIDI_OPTION_REMOVE_CONTROLS</code> set before calling 9356f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>ubidi_setPara()</code> or option <code>#UBIDI_REMOVE_BIDI_CONTROLS</code> 9366f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * in <code>ubidi_writeReordered</code>), the result will be identical to the 9376f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * source text in the first transformation. 9386f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 9396f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <p>This option will be ignored if specified together with option 9406f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>#UBIDI_OPTION_REMOVE_CONTROLS</code>. It inhibits option 9416f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>UBIDI_REMOVE_BIDI_CONTROLS</code> in calls to function 9426f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>ubidi_writeReordered()</code> and it implies option 9436f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>#UBIDI_INSERT_LRM_FOR_NUMERIC</code> in calls to function 9446f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>ubidi_writeReordered()</code> if the reordering mode is 9456f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>#UBIDI_REORDER_INVERSE_NUMBERS_AS_L</code>.</p> 9466f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 9476f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_setReorderingMode 9486f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_setReorderingOptions 9496f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 3.6 9506f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 9516f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UBIDI_OPTION_INSERT_MARKS = 1, 9526f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 9536f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 9546f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * option bit for <code>ubidi_setReorderingOptions</code>: 9556f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * remove Bidi control characters 9566f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 9576f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <p>This option must be set or reset before calling 9586f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>ubidi_setPara</code>.</p> 9596f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 9606f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <p>This option nullifies option <code>#UBIDI_OPTION_INSERT_MARKS</code>. 9616f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * It inhibits option <code>#UBIDI_INSERT_LRM_FOR_NUMERIC</code> in calls 9626f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * to function <code>ubidi_writeReordered()</code> and it implies option 9636f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>#UBIDI_REMOVE_BIDI_CONTROLS</code> in calls to that function.</p> 9646f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 9656f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_setReorderingMode 9666f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_setReorderingOptions 9676f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 3.6 9686f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 9696f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UBIDI_OPTION_REMOVE_CONTROLS = 2, 9706f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 9716f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 9726f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * option bit for <code>ubidi_setReorderingOptions</code>: 9736f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * process the output as part of a stream to be continued 9746f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 9756f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <p>This option must be set or reset before calling 9766f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>ubidi_setPara</code>.</p> 9776f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 9786f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <p>This option specifies that the caller is interested in processing large 9796f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * text object in parts. 9806f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * The results of the successive calls are expected to be concatenated by the 9816f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * caller. Only the call for the last part will have this option bit off.</p> 9826f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 9836f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <p>When this option bit is on, <code>ubidi_setPara()</code> may process 9846f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * less than the full source text in order to truncate the text at a meaningful 9856f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * boundary. The caller should call <code>ubidi_getProcessedLength()</code> 9866f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * immediately after calling <code>ubidi_setPara()</code> in order to 9876f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * determine how much of the source text has been processed. 9886f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Source text beyond that length should be resubmitted in following calls to 9896f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>ubidi_setPara</code>. The processed length may be less than 9906f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * the length of the source text if a character preceding the last character of 9916f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * the source text constitutes a reasonable boundary (like a block separator) 9926f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * for text to be continued.<br> 9936f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * If the last character of the source text constitutes a reasonable 9946f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * boundary, the whole text will be processed at once.<br> 9956f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * If nowhere in the source text there exists 9966f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * such a reasonable boundary, the processed length will be zero.<br> 9976f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * The caller should check for such an occurrence and do one of the following: 9986f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <ul><li>submit a larger amount of text with a better chance to include 9996f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * a reasonable boundary.</li> 10006f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <li>resubmit the same text after turning off option 10016f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>UBIDI_OPTION_STREAMING</code>.</li></ul> 10026f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * In all cases, this option should be turned off before processing the last 10036f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * part of the text.</p> 10046f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 10056f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <p>When the <code>UBIDI_OPTION_STREAMING</code> option is used, 10066f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * it is recommended to call <code>ubidi_orderParagraphsLTR()</code> with 10076f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * argument <code>orderParagraphsLTR</code> set to <code>TRUE</code> before 10086f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * calling <code>ubidi_setPara</code> so that later paragraphs may be 10096f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * concatenated to previous paragraphs on the right.</p> 10106f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 10116f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_setReorderingMode 10126f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_setReorderingOptions 10136f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_getProcessedLength 10146f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_orderParagraphsLTR 10156f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 3.6 10166f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 10176f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UBIDI_OPTION_STREAMING = 4 10186f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org} UBiDiReorderingOption; 10196f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 10206f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 10216f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Specify which of the reordering options 10226f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * should be applied during Bidi transformations. 10236f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 10246f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pBiDi is a <code>UBiDi</code> object. 10256f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param reorderingOptions is a combination of zero or more of the following 10266f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * options: 10276f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>#UBIDI_OPTION_DEFAULT</code>, <code>#UBIDI_OPTION_INSERT_MARKS</code>, 10286f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>#UBIDI_OPTION_REMOVE_CONTROLS</code>, <code>#UBIDI_OPTION_STREAMING</code>. 10296f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 10306f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_getReorderingOptions 10316f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 3.6 10326f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 10336f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgU_STABLE void U_EXPORT2 10346f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgubidi_setReorderingOptions(UBiDi *pBiDi, uint32_t reorderingOptions); 10356f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 10366f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 10376f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * What are the reordering options applied to a given Bidi object? 10386f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 10396f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pBiDi is a <code>UBiDi</code> object. 10406f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return the current reordering options of the Bidi object 10416f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_setReorderingOptions 10426f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 3.6 10436f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 10446f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgU_STABLE uint32_t U_EXPORT2 10456f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgubidi_getReorderingOptions(UBiDi *pBiDi); 10466f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 10476f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 10486f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Set the context before a call to ubidi_setPara().<p> 10496f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 10506f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * ubidi_setPara() computes the left-right directionality for a given piece 10516f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * of text which is supplied as one of its arguments. Sometimes this piece 10526f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * of text (the "main text") should be considered in context, because text 10536f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * appearing before ("prologue") and/or after ("epilogue") the main text 10546f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * may affect the result of this computation.<p> 10556f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 10566f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * This function specifies the prologue and/or the epilogue for the next 10576f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * call to ubidi_setPara(). The characters specified as prologue and 10586f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * epilogue should not be modified by the calling program until the call 10596f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * to ubidi_setPara() has returned. If successive calls to ubidi_setPara() 10606f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * all need specification of a context, ubidi_setContext() must be called 10616f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * before each call to ubidi_setPara(). In other words, a context is not 10626f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * "remembered" after the following successful call to ubidi_setPara().<p> 10636f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 10646f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * If a call to ubidi_setPara() specifies UBIDI_DEFAULT_LTR or 10656f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * UBIDI_DEFAULT_RTL as paraLevel and is preceded by a call to 10666f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * ubidi_setContext() which specifies a prologue, the paragraph level will 10676f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * be computed taking in consideration the text in the prologue.<p> 10686f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 10696f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * When ubidi_setPara() is called without a previous call to 10706f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * ubidi_setContext, the main text is handled as if preceded and followed 10716f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * by strong directional characters at the current paragraph level. 10726f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Calling ubidi_setContext() with specification of a prologue will change 10736f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * this behavior by handling the main text as if preceded by the last 10746f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * strong character appearing in the prologue, if any. 10756f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Calling ubidi_setContext() with specification of an epilogue will change 10766f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * the behavior of ubidi_setPara() by handling the main text as if followed 10776f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * by the first strong character or digit appearing in the epilogue, if any.<p> 10786f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 10796f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Note 1: if <code>ubidi_setContext</code> is called repeatedly without 10806f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * calling <code>ubidi_setPara</code>, the earlier calls have no effect, 10816f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * only the last call will be remembered for the next call to 10826f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>ubidi_setPara</code>.<p> 10836f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 10846f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Note 2: calling <code>ubidi_setContext(pBiDi, NULL, 0, NULL, 0, &errorCode)</code> 10856f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * cancels any previous setting of non-empty prologue or epilogue. 10866f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * The next call to <code>ubidi_setPara()</code> will process no 10876f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * prologue or epilogue.<p> 10886f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 10896f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Note 3: users must be aware that even after setting the context 10906f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * before a call to ubidi_setPara() to perform e.g. a logical to visual 10916f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * transformation, the resulting string may not be identical to what it 10926f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * would have been if all the text, including prologue and epilogue, had 10936f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * been processed together.<br> 10946f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Example (upper case letters represent RTL characters):<br> 10956f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * prologue = "<code>abc DE</code>"<br> 10966f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * epilogue = none<br> 10976f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * main text = "<code>FGH xyz</code>"<br> 10986f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * paraLevel = UBIDI_LTR<br> 10996f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * display without prologue = "<code>HGF xyz</code>" 11006f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * ("HGF" is adjacent to "xyz")<br> 11016f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * display with prologue = "<code>abc HGFED xyz</code>" 11026f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * ("HGF" is not adjacent to "xyz")<br> 11036f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 11046f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pBiDi is a paragraph <code>UBiDi</code> object. 11056f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 11066f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param prologue is a pointer to the text which precedes the text that 11076f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * will be specified in a coming call to ubidi_setPara(). 11086f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * If there is no prologue to consider, then <code>proLength</code> 11096f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * must be zero and this pointer can be NULL. 11106f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 11116f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param proLength is the length of the prologue; if <code>proLength==-1</code> 11126f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * then the prologue must be zero-terminated. 11136f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Otherwise proLength must be >= 0. If <code>proLength==0</code>, it means 11146f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * that there is no prologue to consider. 11156f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 11166f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param epilogue is a pointer to the text which follows the text that 11176f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * will be specified in a coming call to ubidi_setPara(). 11186f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * If there is no epilogue to consider, then <code>epiLength</code> 11196f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * must be zero and this pointer can be NULL. 11206f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 11216f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param epiLength is the length of the epilogue; if <code>epiLength==-1</code> 11226f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * then the epilogue must be zero-terminated. 11236f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Otherwise epiLength must be >= 0. If <code>epiLength==0</code>, it means 11246f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * that there is no epilogue to consider. 11256f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 11266f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pErrorCode must be a valid pointer to an error code value. 11276f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 11286f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_setPara 11296f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 4.8 11306f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 11316f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgU_STABLE void U_EXPORT2 11326f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgubidi_setContext(UBiDi *pBiDi, 11336f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org const UChar *prologue, int32_t proLength, 11346f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org const UChar *epilogue, int32_t epiLength, 11356f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UErrorCode *pErrorCode); 11366f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 11376f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 11386f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Perform the Unicode Bidi algorithm. It is defined in the 11396f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <a href="http://www.unicode.org/unicode/reports/tr9/">Unicode Standard Anned #9</a>, 11406f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * version 13, 11416f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * also described in The Unicode Standard, Version 4.0 .<p> 11426f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 11436f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * This function takes a piece of plain text containing one or more paragraphs, 11446f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * with or without externally specified embedding levels from <i>styled</i> 11456f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * text and computes the left-right-directionality of each character.<p> 11466f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 11476f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * If the entire text is all of the same directionality, then 11486f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * the function may not perform all the steps described by the algorithm, 11496f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * i.e., some levels may not be the same as if all steps were performed. 11506f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * This is not relevant for unidirectional text.<br> 11516f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * For example, in pure LTR text with numbers the numbers would get 11526f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * a resolved level of 2 higher than the surrounding text according to 11536f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * the algorithm. This implementation may set all resolved levels to 11546f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * the same value in such a case.<p> 11556f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 11566f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * The text can be composed of multiple paragraphs. Occurrence of a block 11576f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * separator in the text terminates a paragraph, and whatever comes next starts 11586f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * a new paragraph. The exception to this rule is when a Carriage Return (CR) 11596f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * is followed by a Line Feed (LF). Both CR and LF are block separators, but 11606f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * in that case, the pair of characters is considered as terminating the 11616f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * preceding paragraph, and a new paragraph will be started by a character 11626f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * coming after the LF. 11636f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 11646f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pBiDi A <code>UBiDi</code> object allocated with <code>ubidi_open()</code> 11656f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * which will be set to contain the reordering information, 11666f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * especially the resolved levels for all the characters in <code>text</code>. 11676f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 11686f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param text is a pointer to the text that the Bidi algorithm will be performed on. 11696f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * This pointer is stored in the UBiDi object and can be retrieved 11706f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * with <code>ubidi_getText()</code>.<br> 11716f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <strong>Note:</strong> the text must be (at least) <code>length</code> long. 11726f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 11736f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param length is the length of the text; if <code>length==-1</code> then 11746f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * the text must be zero-terminated. 11756f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 11766f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param paraLevel specifies the default level for the text; 11776f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * it is typically 0 (LTR) or 1 (RTL). 11786f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * If the function shall determine the paragraph level from the text, 11796f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * then <code>paraLevel</code> can be set to 11806f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * either <code>#UBIDI_DEFAULT_LTR</code> 11816f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * or <code>#UBIDI_DEFAULT_RTL</code>; if the text contains multiple 11826f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * paragraphs, the paragraph level shall be determined separately for 11836f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * each paragraph; if a paragraph does not include any strongly typed 11846f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * character, then the desired default is used (0 for LTR or 1 for RTL). 11856f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Any other value between 0 and <code>#UBIDI_MAX_EXPLICIT_LEVEL</code> 11866f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * is also valid, with odd levels indicating RTL. 11876f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 11886f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param embeddingLevels (in) may be used to preset the embedding and override levels, 11896f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * ignoring characters like LRE and PDF in the text. 11906f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * A level overrides the directional property of its corresponding 11916f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * (same index) character if the level has the 11926f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>#UBIDI_LEVEL_OVERRIDE</code> bit set.<br><br> 11936f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Except for that bit, it must be 11946f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>paraLevel<=embeddingLevels[]<=UBIDI_MAX_EXPLICIT_LEVEL</code>, 11956f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * with one exception: a level of zero may be specified for a paragraph 11966f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * separator even if <code>paraLevel>0</code> when multiple paragraphs 11976f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * are submitted in the same call to <code>ubidi_setPara()</code>.<br><br> 11986f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <strong>Caution: </strong>A copy of this pointer, not of the levels, 11996f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * will be stored in the <code>UBiDi</code> object; 12006f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * the <code>embeddingLevels</code> array must not be 12016f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * deallocated before the <code>UBiDi</code> structure is destroyed or reused, 12026f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * and the <code>embeddingLevels</code> 12036f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * should not be modified to avoid unexpected results on subsequent Bidi operations. 12046f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * However, the <code>ubidi_setPara()</code> and 12056f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>ubidi_setLine()</code> functions may modify some or all of the levels.<br><br> 12066f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * After the <code>UBiDi</code> object is reused or destroyed, the caller 12076f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * must take care of the deallocation of the <code>embeddingLevels</code> array.<br><br> 12086f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <strong>Note:</strong> the <code>embeddingLevels</code> array must be 12096f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * at least <code>length</code> long. 12106f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * This pointer can be <code>NULL</code> if this 12116f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * value is not necessary. 12126f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 12136f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pErrorCode must be a valid pointer to an error code value. 12146f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 12156f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 12166f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgU_STABLE void U_EXPORT2 12176f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgubidi_setPara(UBiDi *pBiDi, const UChar *text, int32_t length, 12186f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UBiDiLevel paraLevel, UBiDiLevel *embeddingLevels, 12196f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UErrorCode *pErrorCode); 12206f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 12216f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 12226f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>ubidi_setLine()</code> sets a <code>UBiDi</code> to 12236f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * contain the reordering information, especially the resolved levels, 12246f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * for all the characters in a line of text. This line of text is 12256f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * specified by referring to a <code>UBiDi</code> object representing 12266f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * this information for a piece of text containing one or more paragraphs, 12276f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * and by specifying a range of indexes in this text.<p> 12286f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * In the new line object, the indexes will range from 0 to <code>limit-start-1</code>.<p> 12296f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 12306f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * This is used after calling <code>ubidi_setPara()</code> 12316f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * for a piece of text, and after line-breaking on that text. 12326f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * It is not necessary if each paragraph is treated as a single line.<p> 12336f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 12346f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * After line-breaking, rules (L1) and (L2) for the treatment of 12356f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * trailing WS and for reordering are performed on 12366f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * a <code>UBiDi</code> object that represents a line.<p> 12376f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 12386f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <strong>Important: </strong><code>pLineBiDi</code> shares data with 12396f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>pParaBiDi</code>. 12406f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * You must destroy or reuse <code>pLineBiDi</code> before <code>pParaBiDi</code>. 12416f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * In other words, you must destroy or reuse the <code>UBiDi</code> object for a line 12426f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * before the object for its parent paragraph.<p> 12436f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 12446f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * The text pointer that was stored in <code>pParaBiDi</code> is also copied, 12456f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * and <code>start</code> is added to it so that it points to the beginning of the 12466f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * line for this object. 12476f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 12486f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pParaBiDi is the parent paragraph object. It must have been set 12496f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * by a successful call to ubidi_setPara. 12506f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 12516f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param start is the line's first index into the text. 12526f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 12536f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param limit is just behind the line's last index into the text 12546f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * (its last index +1).<br> 12556f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * It must be <code>0<=start<limit<=</code>containing paragraph limit. 12566f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * If the specified line crosses a paragraph boundary, the function 12576f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * will terminate with error code U_ILLEGAL_ARGUMENT_ERROR. 12586f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 12596f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pLineBiDi is the object that will now represent a line of the text. 12606f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 12616f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pErrorCode must be a valid pointer to an error code value. 12626f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 12636f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_setPara 12646f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_getProcessedLength 12656f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 12666f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 12676f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgU_STABLE void U_EXPORT2 12686f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgubidi_setLine(const UBiDi *pParaBiDi, 12696f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org int32_t start, int32_t limit, 12706f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UBiDi *pLineBiDi, 12716f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UErrorCode *pErrorCode); 12726f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 12736f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 12746f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Get the directionality of the text. 12756f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 12766f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pBiDi is the paragraph or line <code>UBiDi</code> object. 12776f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 12786f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return a value of <code>UBIDI_LTR</code>, <code>UBIDI_RTL</code> 12796f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * or <code>UBIDI_MIXED</code> 12806f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * that indicates if the entire text 12816f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * represented by this object is unidirectional, 12826f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * and which direction, or if it is mixed-directional. 12836f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Note - The value <code>UBIDI_NEUTRAL</code> is never returned from this method. 12846f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 12856f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see UBiDiDirection 12866f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 12876f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 12886f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgU_STABLE UBiDiDirection U_EXPORT2 12896f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgubidi_getDirection(const UBiDi *pBiDi); 12906f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 12916f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 12926f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Gets the base direction of the text provided according 12936f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * to the Unicode Bidirectional Algorithm. The base direction 12946f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * is derived from the first character in the string with bidirectional 12956f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * character type L, R, or AL. If the first such character has type L, 12966f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>UBIDI_LTR</code> is returned. If the first such character has 12976f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * type R or AL, <code>UBIDI_RTL</code> is returned. If the string does 12986f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * not contain any character of these types, then 12996f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>UBIDI_NEUTRAL</code> is returned. 13006f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 13016f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * This is a lightweight function for use when only the base direction 13026f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * is needed and no further bidi processing of the text is needed. 13036f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 13046f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param text is a pointer to the text whose base 13056f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * direction is needed. 13066f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Note: the text must be (at least) @c length long. 13076f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 13086f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param length is the length of the text; 13096f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * if <code>length==-1</code> then the text 13106f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * must be zero-terminated. 13116f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 13126f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return <code>UBIDI_LTR</code>, <code>UBIDI_RTL</code>, 13136f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>UBIDI_NEUTRAL</code> 13146f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 13156f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see UBiDiDirection 13166f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 4.6 13176f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 13186f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgU_STABLE UBiDiDirection U_EXPORT2 13196f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgubidi_getBaseDirection(const UChar *text, int32_t length ); 13206f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 13216f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 13226f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Get the pointer to the text. 13236f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 13246f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pBiDi is the paragraph or line <code>UBiDi</code> object. 13256f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 13266f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return The pointer to the text that the UBiDi object was created for. 13276f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 13286f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_setPara 13296f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_setLine 13306f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 13316f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 13326f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgU_STABLE const UChar * U_EXPORT2 13336f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgubidi_getText(const UBiDi *pBiDi); 13346f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 13356f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 13366f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Get the length of the text. 13376f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 13386f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pBiDi is the paragraph or line <code>UBiDi</code> object. 13396f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 13406f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return The length of the text that the UBiDi object was created for. 13416f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 13426f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 13436f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgU_STABLE int32_t U_EXPORT2 13446f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgubidi_getLength(const UBiDi *pBiDi); 13456f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 13466f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 13476f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Get the paragraph level of the text. 13486f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 13496f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pBiDi is the paragraph or line <code>UBiDi</code> object. 13506f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 13516f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return The paragraph level. If there are multiple paragraphs, their 13526f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * level may vary if the required paraLevel is UBIDI_DEFAULT_LTR or 13536f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * UBIDI_DEFAULT_RTL. In that case, the level of the first paragraph 13546f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * is returned. 13556f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 13566f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see UBiDiLevel 13576f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_getParagraph 13586f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_getParagraphByIndex 13596f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 13606f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 13616f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgU_STABLE UBiDiLevel U_EXPORT2 13626f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgubidi_getParaLevel(const UBiDi *pBiDi); 13636f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 13646f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 13656f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Get the number of paragraphs. 13666f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 13676f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pBiDi is the paragraph or line <code>UBiDi</code> object. 13686f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 13696f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return The number of paragraphs. 13706f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 3.4 13716f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 13726f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgU_STABLE int32_t U_EXPORT2 13736f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgubidi_countParagraphs(UBiDi *pBiDi); 13746f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 13756f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 13766f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Get a paragraph, given a position within the text. 13776f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * This function returns information about a paragraph.<br> 13786f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Note: if the paragraph index is known, it is more efficient to 13796f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * retrieve the paragraph information using ubidi_getParagraphByIndex().<p> 13806f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 13816f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pBiDi is the paragraph or line <code>UBiDi</code> object. 13826f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 13836f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param charIndex is the index of a character within the text, in the 13846f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * range <code>[0..ubidi_getProcessedLength(pBiDi)-1]</code>. 13856f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 13866f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pParaStart will receive the index of the first character of the 13876f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * paragraph in the text. 13886f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * This pointer can be <code>NULL</code> if this 13896f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * value is not necessary. 13906f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 13916f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pParaLimit will receive the limit of the paragraph. 13926f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * The l-value that you point to here may be the 13936f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * same expression (variable) as the one for 13946f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>charIndex</code>. 13956f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * This pointer can be <code>NULL</code> if this 13966f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * value is not necessary. 13976f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 13986f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pParaLevel will receive the level of the paragraph. 13996f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * This pointer can be <code>NULL</code> if this 14006f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * value is not necessary. 14016f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 14026f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pErrorCode must be a valid pointer to an error code value. 14036f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 14046f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return The index of the paragraph containing the specified position. 14056f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 14066f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_getProcessedLength 14076f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 3.4 14086f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 14096f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgU_STABLE int32_t U_EXPORT2 14106f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgubidi_getParagraph(const UBiDi *pBiDi, int32_t charIndex, int32_t *pParaStart, 14116f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org int32_t *pParaLimit, UBiDiLevel *pParaLevel, 14126f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UErrorCode *pErrorCode); 14136f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 14146f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 14156f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Get a paragraph, given the index of this paragraph. 14166f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 14176f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * This function returns information about a paragraph.<p> 14186f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 14196f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pBiDi is the paragraph <code>UBiDi</code> object. 14206f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 14216f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param paraIndex is the number of the paragraph, in the 14226f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * range <code>[0..ubidi_countParagraphs(pBiDi)-1]</code>. 14236f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 14246f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pParaStart will receive the index of the first character of the 14256f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * paragraph in the text. 14266f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * This pointer can be <code>NULL</code> if this 14276f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * value is not necessary. 14286f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 14296f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pParaLimit will receive the limit of the paragraph. 14306f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * This pointer can be <code>NULL</code> if this 14316f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * value is not necessary. 14326f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 14336f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pParaLevel will receive the level of the paragraph. 14346f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * This pointer can be <code>NULL</code> if this 14356f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * value is not necessary. 14366f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 14376f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pErrorCode must be a valid pointer to an error code value. 14386f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 14396f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 3.4 14406f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 14416f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgU_STABLE void U_EXPORT2 14426f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgubidi_getParagraphByIndex(const UBiDi *pBiDi, int32_t paraIndex, 14436f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org int32_t *pParaStart, int32_t *pParaLimit, 14446f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UBiDiLevel *pParaLevel, UErrorCode *pErrorCode); 14456f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 14466f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 14476f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Get the level for one character. 14486f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 14496f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pBiDi is the paragraph or line <code>UBiDi</code> object. 14506f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 14516f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param charIndex the index of a character. It must be in the range 14526f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * [0..ubidi_getProcessedLength(pBiDi)]. 14536f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 14546f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return The level for the character at charIndex (0 if charIndex is not 14556f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * in the valid range). 14566f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 14576f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see UBiDiLevel 14586f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_getProcessedLength 14596f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 14606f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 14616f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgU_STABLE UBiDiLevel U_EXPORT2 14626f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgubidi_getLevelAt(const UBiDi *pBiDi, int32_t charIndex); 14636f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 14646f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 14656f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Get an array of levels for each character.<p> 14666f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 14676f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Note that this function may allocate memory under some 14686f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * circumstances, unlike <code>ubidi_getLevelAt()</code>. 14696f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 14706f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pBiDi is the paragraph or line <code>UBiDi</code> object, whose 14716f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * text length must be strictly positive. 14726f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 14736f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pErrorCode must be a valid pointer to an error code value. 14746f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 14756f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return The levels array for the text, 14766f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * or <code>NULL</code> if an error occurs. 14776f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 14786f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see UBiDiLevel 14796f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_getProcessedLength 14806f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 14816f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 14826f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgU_STABLE const UBiDiLevel * U_EXPORT2 14836f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgubidi_getLevels(UBiDi *pBiDi, UErrorCode *pErrorCode); 14846f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 14856f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 14866f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Get a logical run. 14876f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * This function returns information about a run and is used 14886f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * to retrieve runs in logical order.<p> 14896f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * This is especially useful for line-breaking on a paragraph. 14906f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 14916f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pBiDi is the paragraph or line <code>UBiDi</code> object. 14926f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 14936f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param logicalPosition is a logical position within the source text. 14946f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 14956f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pLogicalLimit will receive the limit of the corresponding run. 14966f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * The l-value that you point to here may be the 14976f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * same expression (variable) as the one for 14986f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>logicalPosition</code>. 14996f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * This pointer can be <code>NULL</code> if this 15006f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * value is not necessary. 15016f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 15026f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pLevel will receive the level of the corresponding run. 15036f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * This pointer can be <code>NULL</code> if this 15046f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * value is not necessary. 15056f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 15066f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_getProcessedLength 15076f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 15086f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 15096f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgU_STABLE void U_EXPORT2 15106f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgubidi_getLogicalRun(const UBiDi *pBiDi, int32_t logicalPosition, 15116f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org int32_t *pLogicalLimit, UBiDiLevel *pLevel); 15126f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 15136f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 15146f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Get the number of runs. 15156f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * This function may invoke the actual reordering on the 15166f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>UBiDi</code> object, after <code>ubidi_setPara()</code> 15176f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * may have resolved only the levels of the text. Therefore, 15186f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>ubidi_countRuns()</code> may have to allocate memory, 15196f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * and may fail doing so. 15206f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 15216f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pBiDi is the paragraph or line <code>UBiDi</code> object. 15226f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 15236f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pErrorCode must be a valid pointer to an error code value. 15246f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 15256f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return The number of runs. 15266f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 15276f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 15286f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgU_STABLE int32_t U_EXPORT2 15296f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgubidi_countRuns(UBiDi *pBiDi, UErrorCode *pErrorCode); 15306f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 15316f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 15326f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Get one run's logical start, length, and directionality, 15336f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * which can be 0 for LTR or 1 for RTL. 15346f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * In an RTL run, the character at the logical start is 15356f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * visually on the right of the displayed run. 15366f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * The length is the number of characters in the run.<p> 15376f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>ubidi_countRuns()</code> should be called 15386f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * before the runs are retrieved. 15396f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 15406f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pBiDi is the paragraph or line <code>UBiDi</code> object. 15416f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 15426f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param runIndex is the number of the run in visual order, in the 15436f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * range <code>[0..ubidi_countRuns(pBiDi)-1]</code>. 15446f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 15456f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pLogicalStart is the first logical character index in the text. 15466f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * The pointer may be <code>NULL</code> if this index is not needed. 15476f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 15486f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pLength is the number of characters (at least one) in the run. 15496f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * The pointer may be <code>NULL</code> if this is not needed. 15506f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 15516f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return the directionality of the run, 15526f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>UBIDI_LTR==0</code> or <code>UBIDI_RTL==1</code>, 15536f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * never <code>UBIDI_MIXED</code>, 15546f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * never <code>UBIDI_NEUTRAL</code>. 15556f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 15566f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_countRuns 15576f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 15586f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Example: 15596f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <pre> 15606f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * \code 15616f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * int32_t i, count=ubidi_countRuns(pBiDi), 15626f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * logicalStart, visualIndex=0, length; 15636f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * for(i=0; i<count; ++i) { 15646f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * if(UBIDI_LTR==ubidi_getVisualRun(pBiDi, i, &logicalStart, &length)) { 15656f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * do { // LTR 15666f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * show_char(text[logicalStart++], visualIndex++); 15676f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * } while(--length>0); 15686f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * } else { 15696f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * logicalStart+=length; // logicalLimit 15706f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * do { // RTL 15716f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * show_char(text[--logicalStart], visualIndex++); 15726f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * } while(--length>0); 15736f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * } 15746f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * } 15756f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org *\endcode 15766f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * </pre> 15776f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 15786f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Note that in right-to-left runs, code like this places 15796f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * second surrogates before first ones (which is generally a bad idea) 15806f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * and combining characters before base characters. 15816f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <p> 15826f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Use of <code>ubidi_writeReordered()</code>, optionally with the 15836f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>#UBIDI_KEEP_BASE_COMBINING</code> option, can be considered in order 15846f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * to avoid these issues. 15856f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 15866f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 15876f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgU_STABLE UBiDiDirection U_EXPORT2 15886f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgubidi_getVisualRun(UBiDi *pBiDi, int32_t runIndex, 15896f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org int32_t *pLogicalStart, int32_t *pLength); 15906f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 15916f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 15926f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Get the visual position from a logical text position. 15936f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * If such a mapping is used many times on the same 15946f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>UBiDi</code> object, then calling 15956f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>ubidi_getLogicalMap()</code> is more efficient.<p> 15966f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 15976f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * The value returned may be <code>#UBIDI_MAP_NOWHERE</code> if there is no 15986f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * visual position because the corresponding text character is a Bidi control 15996f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * removed from output by the option <code>#UBIDI_OPTION_REMOVE_CONTROLS</code>. 16006f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <p> 16016f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * When the visual output is altered by using options of 16026f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>ubidi_writeReordered()</code> such as <code>UBIDI_INSERT_LRM_FOR_NUMERIC</code>, 16036f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>UBIDI_KEEP_BASE_COMBINING</code>, <code>UBIDI_OUTPUT_REVERSE</code>, 16046f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>UBIDI_REMOVE_BIDI_CONTROLS</code>, the visual position returned may not 16056f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * be correct. It is advised to use, when possible, reordering options 16066f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * such as <code>UBIDI_OPTION_INSERT_MARKS</code> and <code>UBIDI_OPTION_REMOVE_CONTROLS</code>. 16076f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <p> 16086f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Note that in right-to-left runs, this mapping places 16096f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * second surrogates before first ones (which is generally a bad idea) 16106f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * and combining characters before base characters. 16116f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Use of <code>ubidi_writeReordered()</code>, optionally with the 16126f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>#UBIDI_KEEP_BASE_COMBINING</code> option can be considered instead 16136f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * of using the mapping, in order to avoid these issues. 16146f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 16156f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pBiDi is the paragraph or line <code>UBiDi</code> object. 16166f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 16176f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param logicalIndex is the index of a character in the text. 16186f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 16196f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pErrorCode must be a valid pointer to an error code value. 16206f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 16216f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return The visual position of this character. 16226f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 16236f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_getLogicalMap 16246f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_getLogicalIndex 16256f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_getProcessedLength 16266f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 16276f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 16286f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgU_STABLE int32_t U_EXPORT2 16296f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgubidi_getVisualIndex(UBiDi *pBiDi, int32_t logicalIndex, UErrorCode *pErrorCode); 16306f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 16316f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 16326f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Get the logical text position from a visual position. 16336f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * If such a mapping is used many times on the same 16346f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>UBiDi</code> object, then calling 16356f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>ubidi_getVisualMap()</code> is more efficient.<p> 16366f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 16376f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * The value returned may be <code>#UBIDI_MAP_NOWHERE</code> if there is no 16386f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * logical position because the corresponding text character is a Bidi mark 16396f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * inserted in the output by option <code>#UBIDI_OPTION_INSERT_MARKS</code>. 16406f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <p> 16416f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * This is the inverse function to <code>ubidi_getVisualIndex()</code>. 16426f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <p> 16436f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * When the visual output is altered by using options of 16446f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>ubidi_writeReordered()</code> such as <code>UBIDI_INSERT_LRM_FOR_NUMERIC</code>, 16456f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>UBIDI_KEEP_BASE_COMBINING</code>, <code>UBIDI_OUTPUT_REVERSE</code>, 16466f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>UBIDI_REMOVE_BIDI_CONTROLS</code>, the logical position returned may not 16476f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * be correct. It is advised to use, when possible, reordering options 16486f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * such as <code>UBIDI_OPTION_INSERT_MARKS</code> and <code>UBIDI_OPTION_REMOVE_CONTROLS</code>. 16496f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 16506f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pBiDi is the paragraph or line <code>UBiDi</code> object. 16516f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 16526f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param visualIndex is the visual position of a character. 16536f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 16546f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pErrorCode must be a valid pointer to an error code value. 16556f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 16566f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return The index of this character in the text. 16576f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 16586f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_getVisualMap 16596f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_getVisualIndex 16606f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_getResultLength 16616f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 16626f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 16636f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgU_STABLE int32_t U_EXPORT2 16646f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgubidi_getLogicalIndex(UBiDi *pBiDi, int32_t visualIndex, UErrorCode *pErrorCode); 16656f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 16666f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 16676f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Get a logical-to-visual index map (array) for the characters in the UBiDi 16686f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * (paragraph or line) object. 16696f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <p> 16706f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Some values in the map may be <code>#UBIDI_MAP_NOWHERE</code> if the 16716f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * corresponding text characters are Bidi controls removed from the visual 16726f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * output by the option <code>#UBIDI_OPTION_REMOVE_CONTROLS</code>. 16736f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <p> 16746f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * When the visual output is altered by using options of 16756f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>ubidi_writeReordered()</code> such as <code>UBIDI_INSERT_LRM_FOR_NUMERIC</code>, 16766f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>UBIDI_KEEP_BASE_COMBINING</code>, <code>UBIDI_OUTPUT_REVERSE</code>, 16776f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>UBIDI_REMOVE_BIDI_CONTROLS</code>, the visual positions returned may not 16786f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * be correct. It is advised to use, when possible, reordering options 16796f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * such as <code>UBIDI_OPTION_INSERT_MARKS</code> and <code>UBIDI_OPTION_REMOVE_CONTROLS</code>. 16806f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <p> 16816f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Note that in right-to-left runs, this mapping places 16826f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * second surrogates before first ones (which is generally a bad idea) 16836f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * and combining characters before base characters. 16846f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Use of <code>ubidi_writeReordered()</code>, optionally with the 16856f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>#UBIDI_KEEP_BASE_COMBINING</code> option can be considered instead 16866f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * of using the mapping, in order to avoid these issues. 16876f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 16886f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pBiDi is the paragraph or line <code>UBiDi</code> object. 16896f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 16906f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param indexMap is a pointer to an array of <code>ubidi_getProcessedLength()</code> 16916f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * indexes which will reflect the reordering of the characters. 16926f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * If option <code>#UBIDI_OPTION_INSERT_MARKS</code> is set, the number 16936f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * of elements allocated in <code>indexMap</code> must be no less than 16946f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>ubidi_getResultLength()</code>. 16956f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * The array does not need to be initialized.<br><br> 16966f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * The index map will result in <code>indexMap[logicalIndex]==visualIndex</code>. 16976f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 16986f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pErrorCode must be a valid pointer to an error code value. 16996f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 17006f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_getVisualMap 17016f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_getVisualIndex 17026f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_getProcessedLength 17036f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_getResultLength 17046f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 17056f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 17066f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgU_STABLE void U_EXPORT2 17076f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgubidi_getLogicalMap(UBiDi *pBiDi, int32_t *indexMap, UErrorCode *pErrorCode); 17086f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 17096f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 17106f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Get a visual-to-logical index map (array) for the characters in the UBiDi 17116f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * (paragraph or line) object. 17126f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <p> 17136f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Some values in the map may be <code>#UBIDI_MAP_NOWHERE</code> if the 17146f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * corresponding text characters are Bidi marks inserted in the visual output 17156f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * by the option <code>#UBIDI_OPTION_INSERT_MARKS</code>. 17166f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <p> 17176f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * When the visual output is altered by using options of 17186f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>ubidi_writeReordered()</code> such as <code>UBIDI_INSERT_LRM_FOR_NUMERIC</code>, 17196f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>UBIDI_KEEP_BASE_COMBINING</code>, <code>UBIDI_OUTPUT_REVERSE</code>, 17206f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>UBIDI_REMOVE_BIDI_CONTROLS</code>, the logical positions returned may not 17216f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * be correct. It is advised to use, when possible, reordering options 17226f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * such as <code>UBIDI_OPTION_INSERT_MARKS</code> and <code>UBIDI_OPTION_REMOVE_CONTROLS</code>. 17236f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 17246f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pBiDi is the paragraph or line <code>UBiDi</code> object. 17256f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 17266f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param indexMap is a pointer to an array of <code>ubidi_getResultLength()</code> 17276f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * indexes which will reflect the reordering of the characters. 17286f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * If option <code>#UBIDI_OPTION_REMOVE_CONTROLS</code> is set, the number 17296f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * of elements allocated in <code>indexMap</code> must be no less than 17306f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>ubidi_getProcessedLength()</code>. 17316f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * The array does not need to be initialized.<br><br> 17326f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * The index map will result in <code>indexMap[visualIndex]==logicalIndex</code>. 17336f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 17346f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pErrorCode must be a valid pointer to an error code value. 17356f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 17366f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_getLogicalMap 17376f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_getLogicalIndex 17386f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_getProcessedLength 17396f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_getResultLength 17406f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 17416f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 17426f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgU_STABLE void U_EXPORT2 17436f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgubidi_getVisualMap(UBiDi *pBiDi, int32_t *indexMap, UErrorCode *pErrorCode); 17446f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 17456f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 17466f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * This is a convenience function that does not use a UBiDi object. 17476f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * It is intended to be used for when an application has determined the levels 17486f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * of objects (character sequences) and just needs to have them reordered (L2). 17496f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * This is equivalent to using <code>ubidi_getLogicalMap()</code> on a 17506f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>UBiDi</code> object. 17516f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 17526f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param levels is an array with <code>length</code> levels that have been determined by 17536f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * the application. 17546f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 17556f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param length is the number of levels in the array, or, semantically, 17566f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * the number of objects to be reordered. 17576f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * It must be <code>length>0</code>. 17586f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 17596f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param indexMap is a pointer to an array of <code>length</code> 17606f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * indexes which will reflect the reordering of the characters. 17616f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * The array does not need to be initialized.<p> 17626f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * The index map will result in <code>indexMap[logicalIndex]==visualIndex</code>. 17636f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 17646f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 17656f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgU_STABLE void U_EXPORT2 17666f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgubidi_reorderLogical(const UBiDiLevel *levels, int32_t length, int32_t *indexMap); 17676f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 17686f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 17696f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * This is a convenience function that does not use a UBiDi object. 17706f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * It is intended to be used for when an application has determined the levels 17716f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * of objects (character sequences) and just needs to have them reordered (L2). 17726f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * This is equivalent to using <code>ubidi_getVisualMap()</code> on a 17736f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>UBiDi</code> object. 17746f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 17756f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param levels is an array with <code>length</code> levels that have been determined by 17766f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * the application. 17776f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 17786f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param length is the number of levels in the array, or, semantically, 17796f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * the number of objects to be reordered. 17806f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * It must be <code>length>0</code>. 17816f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 17826f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param indexMap is a pointer to an array of <code>length</code> 17836f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * indexes which will reflect the reordering of the characters. 17846f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * The array does not need to be initialized.<p> 17856f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * The index map will result in <code>indexMap[visualIndex]==logicalIndex</code>. 17866f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 17876f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 17886f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgU_STABLE void U_EXPORT2 17896f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgubidi_reorderVisual(const UBiDiLevel *levels, int32_t length, int32_t *indexMap); 17906f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 17916f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 17926f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Invert an index map. 17936f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * The index mapping of the first map is inverted and written to 17946f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * the second one. 17956f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 17966f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param srcMap is an array with <code>length</code> elements 17976f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * which defines the original mapping from a source array containing 17986f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>length</code> elements to a destination array. 17996f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Some elements of the source array may have no mapping in the 18006f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * destination array. In that case, their value will be 18016f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * the special value <code>UBIDI_MAP_NOWHERE</code>. 18026f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * All elements must be >=0 or equal to <code>UBIDI_MAP_NOWHERE</code>. 18036f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Some elements may have a value >= <code>length</code>, if the 18046f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * destination array has more elements than the source array. 18056f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * There must be no duplicate indexes (two or more elements with the 18066f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * same value except <code>UBIDI_MAP_NOWHERE</code>). 18076f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 18086f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param destMap is an array with a number of elements equal to 1 + the highest 18096f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * value in <code>srcMap</code>. 18106f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>destMap</code> will be filled with the inverse mapping. 18116f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * If element with index i in <code>srcMap</code> has a value k different 18126f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * from <code>UBIDI_MAP_NOWHERE</code>, this means that element i of 18136f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * the source array maps to element k in the destination array. 18146f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * The inverse map will have value i in its k-th element. 18156f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * For all elements of the destination array which do not map to 18166f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * an element in the source array, the corresponding element in the 18176f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * inverse map will have a value equal to <code>UBIDI_MAP_NOWHERE</code>. 18186f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 18196f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param length is the length of each array. 18206f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see UBIDI_MAP_NOWHERE 18216f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 18226f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 18236f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgU_STABLE void U_EXPORT2 18246f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgubidi_invertMap(const int32_t *srcMap, int32_t *destMap, int32_t length); 18256f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 18266f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** option flags for ubidi_writeReordered() */ 18276f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 18286f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 18296f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * option bit for ubidi_writeReordered(): 18306f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * keep combining characters after their base characters in RTL runs 18316f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 18326f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_writeReordered 18336f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 18346f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 18356f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#define UBIDI_KEEP_BASE_COMBINING 1 18366f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 18376f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 18386f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * option bit for ubidi_writeReordered(): 18396f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * replace characters with the "mirrored" property in RTL runs 18406f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * by their mirror-image mappings 18416f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 18426f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_writeReordered 18436f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 18446f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 18456f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#define UBIDI_DO_MIRRORING 2 18466f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 18476f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 18486f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * option bit for ubidi_writeReordered(): 18496f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * surround the run with LRMs if necessary; 18506f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * this is part of the approximate "inverse Bidi" algorithm 18516f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 18526f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <p>This option does not imply corresponding adjustment of the index 18536f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * mappings.</p> 18546f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 18556f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_setInverse 18566f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_writeReordered 18576f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 18586f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 18596f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#define UBIDI_INSERT_LRM_FOR_NUMERIC 4 18606f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 18616f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 18626f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * option bit for ubidi_writeReordered(): 18636f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * remove Bidi control characters 18646f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * (this does not affect #UBIDI_INSERT_LRM_FOR_NUMERIC) 18656f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 18666f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <p>This option does not imply corresponding adjustment of the index 18676f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * mappings.</p> 18686f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 18696f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_writeReordered 18706f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 18716f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 18726f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#define UBIDI_REMOVE_BIDI_CONTROLS 8 18736f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 18746f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 18756f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * option bit for ubidi_writeReordered(): 18766f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * write the output in reverse order 18776f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 18786f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <p>This has the same effect as calling <code>ubidi_writeReordered()</code> 18796f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * first without this option, and then calling 18806f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>ubidi_writeReverse()</code> without mirroring. 18816f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Doing this in the same step is faster and avoids a temporary buffer. 18826f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * An example for using this option is output to a character terminal that 18836f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * is designed for RTL scripts and stores text in reverse order.</p> 18846f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 18856f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_writeReordered 18866f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 18876f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 18886f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#define UBIDI_OUTPUT_REVERSE 16 18896f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 18906f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 18916f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Get the length of the source text processed by the last call to 18926f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>ubidi_setPara()</code>. This length may be different from the length 18936f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * of the source text if option <code>#UBIDI_OPTION_STREAMING</code> 18946f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * has been set. 18956f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <br> 18966f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Note that whenever the length of the text affects the execution or the 18976f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * result of a function, it is the processed length which must be considered, 18986f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * except for <code>ubidi_setPara</code> (which receives unprocessed source 18996f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * text) and <code>ubidi_getLength</code> (which returns the original length 19006f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * of the source text).<br> 19016f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * In particular, the processed length is the one to consider in the following 19026f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * cases: 19036f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <ul> 19046f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <li>maximum value of the <code>limit</code> argument of 19056f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>ubidi_setLine</code></li> 19066f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <li>maximum value of the <code>charIndex</code> argument of 19076f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>ubidi_getParagraph</code></li> 19086f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <li>maximum value of the <code>charIndex</code> argument of 19096f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>ubidi_getLevelAt</code></li> 19106f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <li>number of elements in the array returned by <code>ubidi_getLevels</code></li> 19116f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <li>maximum value of the <code>logicalStart</code> argument of 19126f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>ubidi_getLogicalRun</code></li> 19136f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <li>maximum value of the <code>logicalIndex</code> argument of 19146f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>ubidi_getVisualIndex</code></li> 19156f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <li>number of elements filled in the <code>*indexMap</code> argument of 19166f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>ubidi_getLogicalMap</code></li> 19176f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <li>length of text processed by <code>ubidi_writeReordered</code></li> 19186f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * </ul> 19196f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 19206f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pBiDi is the paragraph <code>UBiDi</code> object. 19216f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 19226f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return The length of the part of the source text processed by 19236f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * the last call to <code>ubidi_setPara</code>. 19246f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_setPara 19256f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see UBIDI_OPTION_STREAMING 19266f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 3.6 19276f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 19286f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgU_STABLE int32_t U_EXPORT2 19296f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgubidi_getProcessedLength(const UBiDi *pBiDi); 19306f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 19316f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 19326f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Get the length of the reordered text resulting from the last call to 19336f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>ubidi_setPara()</code>. This length may be different from the length 19346f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * of the source text if option <code>#UBIDI_OPTION_INSERT_MARKS</code> 19356f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * or option <code>#UBIDI_OPTION_REMOVE_CONTROLS</code> has been set. 19366f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <br> 19376f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * This resulting length is the one to consider in the following cases: 19386f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <ul> 19396f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <li>maximum value of the <code>visualIndex</code> argument of 19406f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>ubidi_getLogicalIndex</code></li> 19416f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <li>number of elements of the <code>*indexMap</code> argument of 19426f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>ubidi_getVisualMap</code></li> 19436f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * </ul> 19446f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Note that this length stays identical to the source text length if 19456f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Bidi marks are inserted or removed using option bits of 19466f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>ubidi_writeReordered</code>, or if option 19476f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>#UBIDI_REORDER_INVERSE_NUMBERS_AS_L</code> has been set. 19486f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 19496f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pBiDi is the paragraph <code>UBiDi</code> object. 19506f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 19516f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return The length of the reordered text resulting from 19526f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * the last call to <code>ubidi_setPara</code>. 19536f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_setPara 19546f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see UBIDI_OPTION_INSERT_MARKS 19556f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see UBIDI_OPTION_REMOVE_CONTROLS 19566f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 3.6 19576f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 19586f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgU_STABLE int32_t U_EXPORT2 19596f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgubidi_getResultLength(const UBiDi *pBiDi); 19606f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 19616f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgU_CDECL_BEGIN 19626f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 19636f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * value returned by <code>UBiDiClassCallback</code> callbacks when 19646f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * there is no need to override the standard Bidi class for a given code point. 19656f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see UBiDiClassCallback 19666f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 3.6 19676f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 19686f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#define U_BIDI_CLASS_DEFAULT U_CHAR_DIRECTION_COUNT 19696f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 19706f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 19716f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Callback type declaration for overriding default Bidi class values with 19726f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * custom ones. 19736f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <p>Usually, the function pointer will be propagated to a <code>UBiDi</code> 19746f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * object by calling the <code>ubidi_setClassCallback()</code> function; 19756f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * then the callback will be invoked by the UBA implementation any time the 19766f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * class of a character is to be determined.</p> 19776f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 19786f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param context is a pointer to the callback private data. 19796f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 19806f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param c is the code point to get a Bidi class for. 19816f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 19826f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return The directional property / Bidi class for the given code point 19836f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>c</code> if the default class has been overridden, or 19846f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>#U_BIDI_CLASS_DEFAULT</code> if the standard Bidi class value 19856f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * for <code>c</code> is to be used. 19866f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_setClassCallback 19876f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_getClassCallback 19886f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 3.6 19896f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 19906f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgtypedef UCharDirection U_CALLCONV 19916f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgUBiDiClassCallback(const void *context, UChar32 c); 19926f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 19936f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgU_CDECL_END 19946f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 19956f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 19966f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Retrieve the Bidi class for a given code point. 19976f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <p>If a <code>#UBiDiClassCallback</code> callback is defined and returns a 19986f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * value other than <code>#U_BIDI_CLASS_DEFAULT</code>, that value is used; 19996f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * otherwise the default class determination mechanism is invoked.</p> 20006f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 20016f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pBiDi is the paragraph <code>UBiDi</code> object. 20026f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 20036f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param c is the code point whose Bidi class must be retrieved. 20046f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 20056f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return The Bidi class for character <code>c</code> based 20066f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * on the given <code>pBiDi</code> instance. 20076f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see UBiDiClassCallback 20086f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 3.6 20096f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 20106f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgU_STABLE UCharDirection U_EXPORT2 20116f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgubidi_getCustomizedClass(UBiDi *pBiDi, UChar32 c); 20126f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 20136f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 20146f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Set the callback function and callback data used by the UBA 20156f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * implementation for Bidi class determination. 20166f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <p>This may be useful for assigning Bidi classes to PUA characters, or 20176f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * for special application needs. For instance, an application may want to 20186f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * handle all spaces like L or R characters (according to the base direction) 20196f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * when creating the visual ordering of logical lines which are part of a report 20206f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * organized in columns: there should not be interaction between adjacent 20216f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * cells.<p> 20226f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 20236f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pBiDi is the paragraph <code>UBiDi</code> object. 20246f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 20256f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param newFn is the new callback function pointer. 20266f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 20276f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param newContext is the new callback context pointer. This can be NULL. 20286f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 20296f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param oldFn fillin: Returns the old callback function pointer. This can be 20306f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * NULL. 20316f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 20326f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param oldContext fillin: Returns the old callback's context. This can be 20336f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * NULL. 20346f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 20356f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pErrorCode must be a valid pointer to an error code value. 20366f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 20376f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_getClassCallback 20386f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 3.6 20396f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 20406f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgU_STABLE void U_EXPORT2 20416f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgubidi_setClassCallback(UBiDi *pBiDi, UBiDiClassCallback *newFn, 20426f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org const void *newContext, UBiDiClassCallback **oldFn, 20436f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org const void **oldContext, UErrorCode *pErrorCode); 20446f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 20456f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 20466f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Get the current callback function used for Bidi class determination. 20476f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 20486f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pBiDi is the paragraph <code>UBiDi</code> object. 20496f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 20506f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param fn fillin: Returns the callback function pointer. 20516f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 20526f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param context fillin: Returns the callback's private context. 20536f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 20546f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_setClassCallback 20556f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 3.6 20566f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 20576f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgU_STABLE void U_EXPORT2 20586f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgubidi_getClassCallback(UBiDi *pBiDi, UBiDiClassCallback **fn, const void **context); 20596f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 20606f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 20616f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Take a <code>UBiDi</code> object containing the reordering 20626f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * information for a piece of text (one or more paragraphs) set by 20636f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>ubidi_setPara()</code> or for a line of text set by 20646f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>ubidi_setLine()</code> and write a reordered string to the 20656f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * destination buffer. 20666f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 20676f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * This function preserves the integrity of characters with multiple 20686f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * code units and (optionally) combining characters. 20696f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Characters in RTL runs can be replaced by mirror-image characters 20706f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * in the destination buffer. Note that "real" mirroring has 20716f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * to be done in a rendering engine by glyph selection 20726f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * and that for many "mirrored" characters there are no 20736f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Unicode characters as mirror-image equivalents. 20746f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * There are also options to insert or remove Bidi control 20756f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * characters; see the description of the <code>destSize</code> 20766f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * and <code>options</code> parameters and of the option bit flags. 20776f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 20786f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pBiDi A pointer to a <code>UBiDi</code> object that 20796f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * is set by <code>ubidi_setPara()</code> or 20806f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>ubidi_setLine()</code> and contains the reordering 20816f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * information for the text that it was defined for, 20826f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * as well as a pointer to that text.<br><br> 20836f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * The text was aliased (only the pointer was stored 20846f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * without copying the contents) and must not have been modified 20856f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * since the <code>ubidi_setPara()</code> call. 20866f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 20876f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param dest A pointer to where the reordered text is to be copied. 20886f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * The source text and <code>dest[destSize]</code> 20896f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * must not overlap. 20906f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 20916f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param destSize The size of the <code>dest</code> buffer, 20926f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * in number of UChars. 20936f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * If the <code>UBIDI_INSERT_LRM_FOR_NUMERIC</code> 20946f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * option is set, then the destination length could be 20956f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * as large as 20966f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>ubidi_getLength(pBiDi)+2*ubidi_countRuns(pBiDi)</code>. 20976f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * If the <code>UBIDI_REMOVE_BIDI_CONTROLS</code> option 20986f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * is set, then the destination length may be less than 20996f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>ubidi_getLength(pBiDi)</code>. 21006f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * If none of these options is set, then the destination length 21016f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * will be exactly <code>ubidi_getProcessedLength(pBiDi)</code>. 21026f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 21036f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param options A bit set of options for the reordering that control 21046f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * how the reordered text is written. 21056f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * The options include mirroring the characters on a code 21066f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * point basis and inserting LRM characters, which is used 21076f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * especially for transforming visually stored text 21086f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * to logically stored text (although this is still an 21096f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * imperfect implementation of an "inverse Bidi" algorithm 21106f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * because it uses the "forward Bidi" algorithm at its core). 21116f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * The available options are: 21126f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>#UBIDI_DO_MIRRORING</code>, 21136f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>#UBIDI_INSERT_LRM_FOR_NUMERIC</code>, 21146f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>#UBIDI_KEEP_BASE_COMBINING</code>, 21156f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>#UBIDI_OUTPUT_REVERSE</code>, 21166f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>#UBIDI_REMOVE_BIDI_CONTROLS</code> 21176f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 21186f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pErrorCode must be a valid pointer to an error code value. 21196f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 21206f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return The length of the output string. 21216f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 21226f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_getProcessedLength 21236f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 21246f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 21256f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgU_STABLE int32_t U_EXPORT2 21266f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgubidi_writeReordered(UBiDi *pBiDi, 21276f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UChar *dest, int32_t destSize, 21286f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org uint16_t options, 21296f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UErrorCode *pErrorCode); 21306f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 21316f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 21326f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Reverse a Right-To-Left run of Unicode text. 21336f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 21346f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * This function preserves the integrity of characters with multiple 21356f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * code units and (optionally) combining characters. 21366f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Characters can be replaced by mirror-image characters 21376f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * in the destination buffer. Note that "real" mirroring has 21386f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * to be done in a rendering engine by glyph selection 21396f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * and that for many "mirrored" characters there are no 21406f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Unicode characters as mirror-image equivalents. 21416f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * There are also options to insert or remove Bidi control 21426f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * characters. 21436f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 21446f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * This function is the implementation for reversing RTL runs as part 21456f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * of <code>ubidi_writeReordered()</code>. For detailed descriptions 21466f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * of the parameters, see there. 21476f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Since no Bidi controls are inserted here, the output string length 21486f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * will never exceed <code>srcLength</code>. 21496f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 21506f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ubidi_writeReordered 21516f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 21526f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param src A pointer to the RTL run text. 21536f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 21546f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param srcLength The length of the RTL run. 21556f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 21566f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param dest A pointer to where the reordered text is to be copied. 21576f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>src[srcLength]</code> and <code>dest[destSize]</code> 21586f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * must not overlap. 21596f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 21606f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param destSize The size of the <code>dest</code> buffer, 21616f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * in number of UChars. 21626f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * If the <code>UBIDI_REMOVE_BIDI_CONTROLS</code> option 21636f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * is set, then the destination length may be less than 21646f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>srcLength</code>. 21656f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * If this option is not set, then the destination length 21666f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * will be exactly <code>srcLength</code>. 21676f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 21686f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param options A bit set of options for the reordering that control 21696f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * how the reordered text is written. 21706f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * See the <code>options</code> parameter in <code>ubidi_writeReordered()</code>. 21716f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 21726f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param pErrorCode must be a valid pointer to an error code value. 21736f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 21746f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return The length of the output string. 21756f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 21766f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 21776f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgU_STABLE int32_t U_EXPORT2 21786f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgubidi_writeReverse(const UChar *src, int32_t srcLength, 21796f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UChar *dest, int32_t destSize, 21806f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org uint16_t options, 21816f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UErrorCode *pErrorCode); 21826f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 21836f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/*#define BIDI_SAMPLE_CODE*/ 21846f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/*@}*/ 21856f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 21866f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#endif 2187