Section 3: library functions
NAME fribidi_set_mirroring – set mirroring on or off SYNOPSIS #include <fribidi.h> extern fribidi_boolean fribidi_set_mirroring(fribidi_boolean state); PARAMETERS fribidi_boolean state New state to set. DESCRIPTION This function is used to turn character mirroring on or off. Character mirroring is the act of replacing a mirrorable glyph (character), eg. Left parenthesis, with the matching glyph, eg. Right parenthesis,…
NAME fribidi_set_debug – set debug state SYNOPSIS #include <fribidi.h> extern int fribidi_set_debug(int state); PARAMETERS int state New state to set. DESCRIPTION Set debug state. SEE ALSO fribidi_shape_arabic(3), fribidi_get_par_direction(3), fribidi_get_par_embedding_levels_ex(3), fribidi_reorder_line(3), fribidi_get_bidi_type(3), fribidi_get_bidi_types(3), fribidi_get_bidi_type_name(3), fribidi_debug_status(3), fribidi_charset_to_unicode(3), fribidi_unicode_to_charset(3), fribidi_parse_charset(3), fribidi_mirroring_status(3), fribidi_set_mirroring(3), fribidi_reorder_nsm_status(3), fribidi_set_reorder_nsm(3), fribidi_log2vis_get_embedding_levels(3), fribidi_get_type(3), fribidi_get_type_internal(3), fribidi_get_par_embedding_levels(3), fribidi_join_arabic(3), fribidi_get_joining_type(3), fribidi_get_joining_types(3), fribidi_get_joining_type_name(3), fribidi_get_mirror_char(3), fribidi_shape_mirroring(3), fribidi_get_bracket(3), fribidi_get_bracket_types(3), fribidi_shape(3), fribidi_remove_bidi_marks(3)…
NAME fribidi_reorder_nsm_status – get current marks reordering status SYNOPSIS #include <fribidi.h> extern fribidi_boolean fribidi_reorder_nsm_status(void); DESCRIPTION This function is deprecated and only used with other deprecated functions. SEE ALSO fribidi_shape_arabic(3), fribidi_get_par_direction(3), fribidi_get_par_embedding_levels_ex(3), fribidi_reorder_line(3), fribidi_get_bidi_type(3), fribidi_get_bidi_types(3), fribidi_get_bidi_type_name(3), fribidi_debug_status(3), fribidi_set_debug(3), fribidi_charset_to_unicode(3), fribidi_unicode_to_charset(3), fribidi_parse_charset(3), fribidi_mirroring_status(3), fribidi_set_mirroring(3), fribidi_set_reorder_nsm(3), fribidi_log2vis_get_embedding_levels(3), fribidi_get_type(3), fribidi_get_type_internal(3), fribidi_get_par_embedding_levels(3), fribidi_join_arabic(3), fribidi_get_joining_type(3), fribidi_get_joining_types(3), fribidi_get_joining_type_name(3), fribidi_get_mirror_char(3), fribidi_shape_mirroring(3), fribidi_get_bracket(3), fribidi_get_bracket_types(3),…
NAME fribidi_reorder_line – reorder a line of logical string to visual SYNOPSIS #include <fribidi.h> extern FriBidiLevel fribidi_reorder_line ( FriBidiFlags flags, const FriBidiCharType *bidi_types, const FriBidiStrIndex len, const FriBidiStrIndex off, const FriBidiParType base_dir, FriBidiLevel *embedding_levels, FriBidiChar *visual_str, FriBidiStrIndex *map ); PARAMETERS FriBidiFlags flags Reorder flags. const FriBidiCharType *bidi_types Input list of bidi types as returned by…
NAME fribidi_remove_bidi_marks – remove bidi marks out of an string SYNOPSIS #include <fribidi.h> extern FriBidiStrIndex fribidi_remove_bidi_marks ( FriBidiChar *str, const FriBidiStrIndex len, FriBidiStrIndex *positions_to_this, FriBidiStrIndex *position_from_this_list, FriBidiLevel *embedding_levels ); PARAMETERS FriBidiChar *str Input string to clean. const FriBidiStrIndex len Input string length. FriBidiStrIndex *positions_to_this List mapping positions to the order used in str. FriBidiStrIndex *position_from_this_list…
NAME fribidi_parse_charset – parse character set name SYNOPSIS #include <fribidi.h> extern FriBidiCharSet fribidi_parse_charset(const char *s); PARAMETERS const char *s Input name of the character set. DESCRIPTION Parse character set name. RETURNS The character set named s, or FRIBIDI_CHAR_SET_NOT_FOUND if the character set is not available. Possible values for an extern FriBidiCharSet are as follows: FRIBIDI_CHAR_SET_UTF8…
NAME fribidi_mirroring_status – get current mirroring status SYNOPSIS #include <fribidi.h> extern fribidi_boolean fribidi_mirroring_status(void); DESCRIPTION This function is deprecated and only used with other deprecated functions. SEE ALSO fribidi_shape_arabic(3), fribidi_get_par_direction(3), fribidi_get_par_embedding_levels_ex(3), fribidi_reorder_line(3), fribidi_get_bidi_type(3), fribidi_get_bidi_types(3), fribidi_get_bidi_type_name(3), fribidi_debug_status(3), fribidi_set_debug(3), fribidi_charset_to_unicode(3), fribidi_unicode_to_charset(3), fribidi_parse_charset(3), fribidi_set_mirroring(3), fribidi_reorder_nsm_status(3), fribidi_set_reorder_nsm(3), fribidi_log2vis_get_embedding_levels(3), fribidi_get_type(3), fribidi_get_type_internal(3), fribidi_get_par_embedding_levels(3), fribidi_join_arabic(3), fribidi_get_joining_type(3), fribidi_get_joining_types(3), fribidi_get_joining_type_name(3), fribidi_get_mirror_char(3), fribidi_shape_mirroring(3), fribidi_get_bracket(3), fribidi_get_bracket_types(3), fribidi_shape(3),…
NAME fribidi_log2vis_get_embedding_levels – get embedding levels SYNOPSIS #include <fribidi.h> extern FriBidiLevel fribidi_log2vis_get_embedding_levels ( const FriBidiCharType *bidi_types, const FriBidiStrIndex len, FriBidiParType *pbase_dir, FriBidiLevel *embedding_levels ); PARAMETERS const FriBidiCharType *bidi_types Input list of bidi types as returned by fribidi_get_bidi_types(). Since there are 23 possible values for a const FriBidiCharType, they are not all listed here. const FriBidiStrIndex…
NAME fribidi_log2vis – get visual string SYNOPSIS #include <fribidi.h> extern FriBidiLevel fribidi_log2vis ( const FriBidiChar *str, const FriBidiStrIndex len, FriBidiParType *pbase_dir, FriBidiChar *visual_str, FriBidiStrIndex *positions_L_to_V, FriBidiStrIndex *positions_V_to_L, FriBidiLevel *embedding_levels ); PARAMETERS const FriBidiChar *str Input logical string. const FriBidiStrIndex len Input string length. FriBidiParType *pbase_dir Requested and resolved paragraph base direction. Possible values for a…
NAME fribidi_join_arabic – do Arabic joining SYNOPSIS #include <fribidi.h> extern void fribidi_join_arabic ( const FriBidiCharType *bidi_types, const FriBidiStrIndex len, const FriBidiLevel *embedding_levels, FriBidiArabicProp *ar_props ); PARAMETERS const FriBidiCharType *bidi_types Input list of bidi types as returned by fribidi_get_bidi_types(). Since there are 23 possible values for a const FriBidiCharType, they are not all listed here. const…
NAME fribidi_get_type_internal – get character bidi type SYNOPSIS #include <fribidi.h> extern FriBidiCharType fribidi_get_type_internal(FriBidiChar ch); PARAMETERS FriBidiChar ch Input character. DESCRIPTION Deprecated. Replaced by fribidi_get_bidi_type. RETURNS Since there are 23 possible values for an extern FriBidiCharType, they are not all listed here. SEE ALSO fribidi_shape_arabic(3), fribidi_get_par_direction(3), fribidi_get_par_embedding_levels_ex(3), fribidi_reorder_line(3), fribidi_get_bidi_type(3), fribidi_get_bidi_types(3), fribidi_get_bidi_type_name(3), fribidi_debug_status(3), fribidi_set_debug(3), fribidi_charset_to_unicode(3), fribidi_unicode_to_charset(3), fribidi_parse_charset(3),…
NAME fribidi_get_type – get character bidi type SYNOPSIS #include <fribidi.h> extern FriBidiCharType fribidi_get_type(FriBidiChar ch); PARAMETERS FriBidiChar ch Input character. DESCRIPTION Deprecated. Replaced by fribidi_get_bidi_type. RETURNS Since there are 23 possible values for an extern FriBidiCharType, they are not all listed here. SEE ALSO fribidi_shape_arabic(3), fribidi_get_par_direction(3), fribidi_get_par_embedding_levels_ex(3), fribidi_reorder_line(3), fribidi_get_bidi_type(3), fribidi_get_bidi_types(3), fribidi_get_bidi_type_name(3), fribidi_debug_status(3), fribidi_set_debug(3), fribidi_charset_to_unicode(3), fribidi_unicode_to_charset(3), fribidi_parse_charset(3),…
NAME fribidi_get_par_embedding_levels_ex – get bidi embedding levels of a paragraph SYNOPSIS #include <fribidi.h> extern FriBidiLevel fribidi_get_par_embedding_levels_ex ( const FriBidiCharType *bidi_types, const FriBidiBracketType *bracket_types, const FriBidiStrIndex len, FriBidiParType *pbase_dir, FriBidiLevel *embedding_levels ); PARAMETERS const FriBidiCharType *bidi_types Input list of bidi types as returned by fribidi_get_bidi_types(). Since there are 23 possible values for a const FriBidiCharType, they…
NAME fribidi_get_par_embedding_levels – get bidi embedding levels of a paragraph SYNOPSIS #include <fribidi.h> extern FriBidiLevel fribidi_get_par_embedding_levels ( const FriBidiCharType *bidi_types, const FriBidiStrIndex len, FriBidiParType *pbase_dir, FriBidiLevel *embedding_levels ); PARAMETERS const FriBidiCharType *bidi_types Input list of bidi types as returned by fribidi_get_bidi_types(). Since there are 23 possible values for a const FriBidiCharType, they are not all…
NAME fribidi_get_par_direction – get base paragraph direction SYNOPSIS #include <fribidi.h> extern FriBidiParType fribidi_get_par_direction ( const FriBidiCharType *bidi_types, const FriBidiStrIndex len ); PARAMETERS const FriBidiCharType *bidi_types Input list of bidi types as returned by fribidi_get_bidi_types(). Since there are 23 possible values for a const FriBidiCharType, they are not all listed here. const FriBidiStrIndex len Input string…
NAME fribidi_get_mirror_char – get mirrored character SYNOPSIS #include <fribidi.h> extern fribidi_boolean fribidi_get_mirror_char ( FriBidiChar ch, FriBidiChar *mirrored_ch ); PARAMETERS FriBidiChar ch Input character. FriBidiChar *mirrored_ch Output mirrored character. DESCRIPTION This function finds the mirrored equivalent of a character as defined in the file BidiMirroring.txt of the Unicode Character Database available at http://www.unicode.org/Public/UNIDATA/BidiMirroring.txt. If the input…
NAME fribidi_get_joining_types – get joining types for an string of characters SYNOPSIS #include <fribidi.h> extern void fribidi_get_joining_types ( const FriBidiChar *str, const FriBidiStrIndex len, FriBidiJoiningType *jtypes ); PARAMETERS const FriBidiChar *str Input string. const FriBidiStrIndex len Input string length. FriBidiJoiningType *jtypes Output joining types. Possible values for a FriBidiJoiningType are as follows: FRIBIDI_JOINING_TYPE_U NUn-joining, e.g….
NAME fribidi_get_joining_type_name – get joining type name SYNOPSIS #include <fribidi.h> extern const char *fribidi_get_joining_type_name(FriBidiJoiningType j); PARAMETERS FriBidiJoiningType j Input joining type. Possible values for a FriBidiJoiningType are as follows: FRIBIDI_JOINING_TYPE_U NUn-joining, e.g. Full Stop. FRIBIDI_JOINING_TYPE_R Right-joining, e.g. Arabic Letter Dal. FRIBIDI_JOINING_TYPE_D Dual-joining, e.g. Arabic Letter Ain. FRIBIDI_JOINING_TYPE_C Join-Causing, e.g. Tatweel, ZWJ. FRIBIDI_JOINING_TYPE_T Transparent, e.g. Arabic…
NAME fribidi_get_joining_type – get character joining type SYNOPSIS #include <fribidi.h> extern FriBidiJoiningType fribidi_get_joining_type(FriBidiChar ch); PARAMETERS FriBidiChar ch Input character. DESCRIPTION This function returns the joining type of a character as defined in Table 8-2 Primary Arabic Joining Classes of the Unicode standard available at http://www.unicode.org/versions/Unicode4.0.0/ch08.pdf#G7462, using data provided in file ArabicShaping.txt and UnicodeData.txt of the…
NAME fribidi_get_bracket_types – get bracketed characters SYNOPSIS #include <fribidi.h> extern void fribidi_get_bracket_types ( const FriBidiChar *str, const FriBidiStrIndex len, const FriBidiCharType *types, FriBidiBracketType *btypes ); PARAMETERS const FriBidiChar *str Input string. const FriBidiStrIndex len Input string length. const FriBidiCharType *types Input bidi types. Since there are 23 possible values for a const FriBidiCharType, they are…