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

NAME

6       fribidi_get_par_direction - get base paragraph direction
7

SYNOPSIS

9       #include <fribidi.h>
10
11       extern FriBidiParType fribidi_get_par_direction
12       (
13            const FriBidiCharType *bidi_types,
14            const FriBidiStrIndex len
15       );
16

PARAMETERS

18       const FriBidiCharType *bidi_types
19              Input     list     of     bidi     types    as    returned    by
20              fribidi_get_bidi_types().
21
22              Since there are 23 possible values for a const  FriBidiCharType,
23              they are not all listed here.
24
25       const FriBidiStrIndex len
26              Input string length.
27

DESCRIPTION

29       This  function  finds  the  base  direction  of  a single paragraph, as
30       defined by rule P2 of the Unicode Bidirectional Algorithm available  at
31       http://www.unicode.org/reports/tr9/#P2.
32
33       You  typically  do  not  need  this  function as fribidi_get_par_embed‐
34       ding_levels() knows how to compute base direction itself, but  you  may
35       need  this  to  implement a more sophisticated paragraph direction han‐
36       dling.  Note that you can pass more than a paragraph to  this  function
37       and the direction of the first non-neutral paragraph is returned, which
38       is a very good heuristic to set direction of the neutral paragraphs  at
39       the  beginning  of  text.  For other neutral paragraphs, you better use
40       the direction of the previous paragraph.
41

RETURNS

43       Base pargraph direction.  No weak paragraph direction is returned, only
44       LTR, RTL, or ON.
45
46       Possible values for an extern FriBidiParType are as follows:
47              FRIBIDI_PAR_LTR   Left-To-Right paragraph.
48              FRIBIDI_PAR_RTL   Right-To-Left paragraph.
49              FRIBIDI_PAR_ON    DirectiOn-Neutral paragraph.
50              FRIBIDI_PAR_WLTR  Weak Left To Right paragraph.
51              FRIBIDI_PAR_WRTL  Weak Right To Left paragraph.
52

SEE ALSO

54       fribidi_shape_arabic(3),        fribidi_get_par_embedding_levels_ex(3),
55       fribidi_reorder_line(3),                      fribidi_get_bidi_type(3),
56       fribidi_get_bidi_types(3),               fribidi_get_bidi_type_name(3),
57       fribidi_debug_status(3), fribidi_set_debug(3),  fribidi_charset_to_uni‐
58       code(3),    fribidi_unicode_to_charset(3),    fribidi_parse_charset(3),
59       fribidi_mirroring_status(3),                  fribidi_set_mirroring(3),
60       fribidi_reorder_nsm_status(3),              fribidi_set_reorder_nsm(3),
61       fribidi_log2vis_get_embedding_levels(3),           fribidi_get_type(3),
62       fribidi_get_type_internal(3),             fribidi_remove_bidi_marks(3),
63       fribidi_log2vis(3),                fribidi_get_par_embedding_levels(3),
64       fribidi_join_arabic(3),  fribidi_get_joining_type(3), fribidi_get_join‐
65       ing_types(3),    fribidi_get_joining_type_name(3),     fribidi_get_mir‐
66       ror_char(3),     fribidi_shape_mirroring(3),    fribidi_get_bracket(3),
67       fribidi_get_bracket_types(3), fribidi_shape(3)
68
69
70
71c2man fribidi-bidi.h           19 February 2018   fribidi_get_par_direction(3)
Impressum