1 .\" WARNING! THIS FILE WAS GENERATED AUTOMATICALLY BY c2man!
2 .\" DO NOT EDIT! CHANGES MADE TO THIS FILE WILL BE LOST!
3 .TH "fribidi_log2vis" 3 "2 March 2020" "c2man fribidi.h" "Programmer's Manual"
5 fribidi_log2vis \- get visual string
10 extern FriBidiLevel fribidi_log2vis
14 const FriBidiChar *str,
16 const FriBidiStrIndex len,
18 FriBidiParType *pbase_dir,
20 FriBidiChar *visual_str,
22 FriBidiStrIndex *positions_L_to_V,
24 FriBidiStrIndex *positions_V_to_L,
26 FriBidiLevel *embedding_levels
32 .B "const FriBidiChar *str"
35 .B "const FriBidiStrIndex len"
38 .B "FriBidiParType *pbase_dir"
39 Requested and resolved paragraph
42 Possible values for a \fBFriBidiParType\fR are as follows:
46 .nr TL \w'FRIBIDI_PAR_WLTR'u+0.2i
50 Left-To-Right paragraph.
53 Right-To-Left paragraph.
56 DirectiOn-Neutral paragraph.
58 \fBFRIBIDI_PAR_WLTR\fR
59 Weak Left To Right paragraph.
61 \fBFRIBIDI_PAR_WRTL\fR
62 Weak Right To Left paragraph.
66 .B "FriBidiChar *visual_str"
69 .B "FriBidiStrIndex *positions_L_to_V"
70 Output mapping from logical to
71 visual string positions.
73 .B "FriBidiStrIndex *positions_V_to_L"
74 Output mapping from visual string
75 back to the logical string
78 .B "FriBidiLevel *embedding_levels"
79 Output list of embedding levels.
81 This function converts the logical input string to the visual output
82 strings as specified by the Unicode Bidirectional Algorithm. As a side
83 effect it also generates mapping lists between the two strings, and the
84 list of embedding levels as defined by the algorithm.
86 If NULL is passed as any of the the lists, the list is ignored and not
89 Note that this function handles one-line paragraphs. For multi-
90 paragraph texts it is necessary to first split the text into
91 separate paragraphs and then carry over the resolved pbase_dir
92 between the subsequent invocations.
94 Maximum level found plus one, or zero if any error occurred
95 (memory allocation failure most probably).
97 fribidi_shape_arabic(3),
98 fribidi_get_par_direction(3),
99 fribidi_get_par_embedding_levels_ex(3),
100 fribidi_reorder_line(3),
101 fribidi_get_bidi_type(3),
102 fribidi_get_bidi_types(3),
103 fribidi_get_bidi_type_name(3),
104 fribidi_debug_status(3),
105 fribidi_set_debug(3),
106 fribidi_charset_to_unicode(3),
107 fribidi_unicode_to_charset(3),
108 fribidi_parse_charset(3),
109 fribidi_mirroring_status(3),
110 fribidi_set_mirroring(3),
111 fribidi_reorder_nsm_status(3),
112 fribidi_set_reorder_nsm(3),
113 fribidi_log2vis_get_embedding_levels(3),
115 fribidi_get_type_internal(3),
116 fribidi_get_par_embedding_levels(3),
117 fribidi_join_arabic(3),
118 fribidi_get_joining_type(3),
119 fribidi_get_joining_types(3),
120 fribidi_get_joining_type_name(3),
121 fribidi_get_mirror_char(3),
122 fribidi_shape_mirroring(3),
123 fribidi_get_bracket(3),
124 fribidi_get_bracket_types(3),
126 fribidi_remove_bidi_marks(3)