Imported Upstream version 0.19.7
[platform/upstream/fribidi.git] / doc / fribidi_shape_mirroring.3
1 .\" WARNING! THIS FILE WAS GENERATED AUTOMATICALLY BY c2man!
2 .\" DO NOT EDIT! CHANGES MADE TO THIS FILE WILL BE LOST!
3 .TH "fribidi_shape_mirroring" 3 "6 December 2012" "GNU FriBidi 0.19.7" "Programmer's Manual"
4 .SH "NAME"
5 fribidi_shape_mirroring \- do mirroring shaping
6 .SH "SYNOPSIS"
7 .ft B
8 #include <fribidi.h>
9 .sp
10 void fribidi_shape_mirroring
11 .br
12 (
13 .br
14         const FriBidiLevel *embedding_levels,
15 .br
16         const FriBidiStrIndex len,
17 .br
18         FriBidiChar *str
19 .br
20 );
21 .ft R
22 .SH "PARAMETERS"
23 .TP
24 .B "const FriBidiLevel *embedding_levels"
25 Input list of embedding
26 levels, as returned by
27 fribidi_get_par_embedding_levels.
28 .TP
29 .B "const FriBidiStrIndex len"
30 Input string length.
31 .TP
32 .B "FriBidiChar *str"
33 String to shape.
34 .SH "DESCRIPTION"
35 This functions replaces mirroring characters on right-to-left embeddings in
36 string with their mirrored equivalent as returned by
37 fribidi_get_mirror_char().
38
39 This function implements rule L4 of the Unicode Bidirectional Algorithm
40 available at http://www.unicode.org/reports/tr9/#L4.
41 .SH "SEE ALSO"
42 fribidi_charset_to_unicode(3),
43 fribidi_unicode_to_charset(3),
44 fribidi_parse_charset(3),
45 fribidi_shape_arabic(3),
46 fribidi_get_par_direction(3),
47 fribidi_get_par_embedding_levels(3),
48 fribidi_reorder_line(3),
49 fribidi_get_bidi_type(3),
50 fribidi_get_bidi_types(3),
51 fribidi_get_bidi_type_name(3),
52 fribidi_debug_status(3),
53 fribidi_mirroring_status(3),
54 fribidi_set_mirroring(3),
55 fribidi_reorder_nsm_status(3),
56 fribidi_set_reorder_nsm(3),
57 fribidi_log2vis_get_embedding_levels(3),
58 fribidi_get_type(3),
59 fribidi_get_type_internal(3),
60 fribidi_remove_bidi_marks(3),
61 fribidi_log2vis(3),
62 fribidi_join_arabic(3),
63 fribidi_get_joining_type(3),
64 fribidi_get_joining_types(3),
65 fribidi_get_joining_type_name(3),
66 fribidi_get_mirror_char(3),
67 fribidi_shape(3)