1fribidi_log2vis(3)            Programmer's Manual           fribidi_log2vis(3)
2
3
4

NAME

6       fribidi_log2vis - get visual string
7

SYNOPSIS

9       #include <fribidi.h>
10
11       extern FriBidiLevel fribidi_log2vis
12       (
13            const FriBidiChar *str,
14            const FriBidiStrIndex len,
15            FriBidiParType *pbase_dir,
16            FriBidiChar *visual_str,
17            FriBidiStrIndex *positions_L_to_V,
18            FriBidiStrIndex *positions_V_to_L,
19            FriBidiLevel *embedding_levels
20       );
21

PARAMETERS

23       const FriBidiChar *str
24              Input logical string.
25
26       const FriBidiStrIndex len
27              Input string length.
28
29       FriBidiParType *pbase_dir
30              Requested and resolved paragraph base direction.
31
32              Possible values for a FriBidiParType are as follows:
33              FRIBIDI_PAR_LTR   Left-To-Right paragraph.
34              FRIBIDI_PAR_RTL   Right-To-Left paragraph.
35              FRIBIDI_PAR_ON    DirectiOn-Neutral paragraph.
36              FRIBIDI_PAR_WLTR  Weak Left To Right paragraph.
37              FRIBIDI_PAR_WRTL  Weak Right To Left paragraph.
38
39       FriBidiChar *visual_str
40              Output visual string.
41
42       FriBidiStrIndex *positions_L_to_V
43              Output mapping from logical to visual string positions.
44
45       FriBidiStrIndex *positions_V_to_L
46              Output  mapping  from  visual  string back to the logical string
47              positions.
48
49       FriBidiLevel *embedding_levels
50              Output list of embedding levels.
51

DESCRIPTION

53       This function converts the logical input string to  the  visual  output
54       strings as specified by the Unicode Bidirectional Algorithm.  As a side
55       effect it also generates mapping lists between the two strings, and the
56       list of embedding levels as defined by the algorithm.
57
58       If  NULL is passed as any of the the lists, the list is ignored and not
59       filled.
60
61       This function is obsolete because it only handles one-line  paragraphs.
62       Please consider using other functions instead.  Deprecated.
63

RETURNS

65       Maximum  level  found  plus  one, or zero if any error occurred (memory
66       allocation failure most probably).
67

SEE ALSO

69       fribidi_shape_arabic(3),                  fribidi_get_par_direction(3),
70       fribidi_get_par_embedding_levels_ex(3),        fribidi_reorder_line(3),
71       fribidi_get_bidi_type(3),                    fribidi_get_bidi_types(3),
72       fribidi_get_bidi_type_name(3),                 fribidi_debug_status(3),
73       fribidi_set_debug(3),    fribidi_charset_to_unicode(3),    fribidi_uni‐
74       code_to_charset(3),   fribidi_parse_charset(3),  fribidi_mirroring_sta‐
75       tus(3),    fribidi_set_mirroring(3),     fribidi_reorder_nsm_status(3),
76       fribidi_set_reorder_nsm(3),    fribidi_log2vis_get_embedding_levels(3),
77       fribidi_get_type(3),                      fribidi_get_type_internal(3),
78       fribidi_remove_bidi_marks(3),      fribidi_get_par_embedding_levels(3),
79       fribidi_join_arabic(3), fribidi_get_joining_type(3),  fribidi_get_join‐
80       ing_types(3),     fribidi_get_joining_type_name(3),    fribidi_get_mir‐
81       ror_char(3),    fribidi_shape_mirroring(3),     fribidi_get_bracket(3),
82       fribidi_get_bracket_types(3), fribidi_shape(3)
83
84
85
86c2man fribidi-deprecated.h     19 February 2018             fribidi_log2vis(3)
Impressum