1 .\" WARNING! THIS FILE WAS GENERATED AUTOMATICALLY BY c2man!
2 .\" DO NOT EDIT! CHANGES MADE TO THIS FILE WILL BE LOST!
3 .TH "fribidi_get_par_embedding_levels" 3 "25 August 2012" "GNU FriBidi 0.19.3" "Programmer's Manual"
5 fribidi_get_par_embedding_levels \- get bidi embedding levels of a paragraph
10 FriBidiLevel fribidi_get_par_embedding_levels
14 const FriBidiCharType *bidi_types,
16 const FriBidiStrIndex len,
18 FriBidiParType *pbase_dir,
20 FriBidiLevel *embedding_levels
26 .B "const FriBidiCharType *bidi_types"
27 Input list of bidi types as returned by
28 fribidi_get_bidi_types().
30 Possible values for a \fBconst FriBidiCharType\fR are as follows:
34 .nr TL \w'FRIBIDI_TYPE_LTR'u+0.2i
37 \fBFRIBIDI_TYPE_LTR\fR
40 \fBFRIBIDI_TYPE_RTL\fR
53 European number Separator.
56 European number Terminator.
61 \fBFRIBIDI_TYPE_NSM\fR
79 \fBFRIBIDI_TYPE_LRE\fR
80 Left-to-Right Embedding.
82 \fBFRIBIDI_TYPE_RLE\fR
83 Right-to-Left Embedding.
85 \fBFRIBIDI_TYPE_LRO\fR
86 Left-to-Right Override.
88 \fBFRIBIDI_TYPE_RLO\fR
89 Right-to-Left Override.
91 \fBFRIBIDI_TYPE_PDF\fR
96 .B "const FriBidiStrIndex len"
97 Input string length of the paragraph.
99 .B "FriBidiParType *pbase_dir"
100 Requested and resolved paragraph
103 Possible values for a \fBFriBidiParType\fR are as follows:
107 .nr TL \w'FRIBIDI_PAR_WLTR'u+0.2i
110 \fBFRIBIDI_PAR_LTR\fR
111 Left-To-Right paragraph.
113 \fBFRIBIDI_PAR_RTL\fR
114 Right-To-Left paragraph.
117 DirectiOn-Neutral paragraph.
119 \fBFRIBIDI_PAR_WLTR\fR
120 Weak Left To Right paragraph.
122 \fBFRIBIDI_PAR_WRTL\fR
123 Weak Right To Left paragraph.
127 .B "FriBidiLevel *embedding_levels"
128 Output list of embedding levels.
130 This function finds the bidi embedding levels of a single paragraph,
131 as defined by the Unicode Bidirectional Algorithm available at
132 http://www.unicode.org/reports/tr9/. This function implements rules P2 to
133 I1 inclusive, and parts 1 to 3 of L1, except for rule X9 which is
134 implemented in fribidi_remove_bidi_marks(). Part 4 of L1 is implemented
135 in fribidi_reorder_line().
137 There are a few macros defined in fribidi-bidi-types.h to work with this
140 Maximum level found plus one, or zero if any error occured
141 (memory allocation failure most probably).
143 fribidi_charset_to_unicode(3),
144 fribidi_unicode_to_charset(3),
145 fribidi_parse_charset(3),
146 fribidi_shape_arabic(3),
147 fribidi_get_par_direction(3),
148 fribidi_reorder_line(3),
149 fribidi_get_bidi_type(3),
150 fribidi_get_bidi_types(3),
151 fribidi_get_bidi_type_name(3),
152 fribidi_debug_status(3),
153 fribidi_mirroring_status(3),
154 fribidi_set_mirroring(3),
155 fribidi_reorder_nsm_status(3),
156 fribidi_set_reorder_nsm(3),
157 fribidi_log2vis_get_embedding_levels(3),
159 fribidi_get_type_internal(3),
160 fribidi_remove_bidi_marks(3),
162 fribidi_join_arabic(3),
163 fribidi_get_joining_type(3),
164 fribidi_get_joining_types(3),
165 fribidi_get_joining_type_name(3),
166 fribidi_get_mirror_char(3),
167 fribidi_shape_mirroring(3),