7f08eaa71c19d3e1b7b1dcfb6d74c7fdc0521db0
[platform/upstream/fribidi.git] / doc / fribidi_get_bracket.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_get_bracket" 3 "19 February 2018" "c2man fribidi-brackets.h" "Programmer's Manual"
4 .SH "NAME"
5 fribidi_get_bracket \- get bracketed character
6 .SH "SYNOPSIS"
7 .ft B
8 #include <fribidi.h>
9 .sp
10 extern FriBidiBracketType fribidi_get_bracket(FriBidiChar ch);
11 .ft R
12 .SH "PARAMETERS"
13 .TP
14 .B "FriBidiChar ch"
15 Input character.
16 .SH "DESCRIPTION"
17 This function finds the bracketed equivalent of a character as defined in
18 the file BidiBrackets.txt of the Unicode Character Database available at
19 http://www.unicode.org/Public/UNIDATA/BidiBrackets.txt.
20
21 If  the input character is a declared as a brackets character in the
22 Unicode standard and has a bracketed equivalent.  The matching bracketed
23 character is put in the output, otherwise the input character itself is
24 put.
25 .SH "RETURNS"
26 The bracket type of the character. Use the
27 FRIBIDI_IS_BRACKET(FriBidiBracketType) to test if it is a valid
28 property.
29 .SH "SEE ALSO"
30 fribidi_shape_arabic(3),
31 fribidi_get_par_direction(3),
32 fribidi_get_par_embedding_levels_ex(3),
33 fribidi_reorder_line(3),
34 fribidi_get_bidi_type(3),
35 fribidi_get_bidi_types(3),
36 fribidi_get_bidi_type_name(3),
37 fribidi_debug_status(3),
38 fribidi_set_debug(3),
39 fribidi_charset_to_unicode(3),
40 fribidi_unicode_to_charset(3),
41 fribidi_parse_charset(3),
42 fribidi_mirroring_status(3),
43 fribidi_set_mirroring(3),
44 fribidi_reorder_nsm_status(3),
45 fribidi_set_reorder_nsm(3),
46 fribidi_log2vis_get_embedding_levels(3),
47 fribidi_get_type(3),
48 fribidi_get_type_internal(3),
49 fribidi_remove_bidi_marks(3),
50 fribidi_log2vis(3),
51 fribidi_get_par_embedding_levels(3),
52 fribidi_join_arabic(3),
53 fribidi_get_joining_type(3),
54 fribidi_get_joining_types(3),
55 fribidi_get_joining_type_name(3),
56 fribidi_get_mirror_char(3),
57 fribidi_shape_mirroring(3),
58 fribidi_get_bracket_types(3),
59 fribidi_shape(3)