|
Packit Service |
12e4cd |
.\" WARNING! THIS FILE WAS GENERATED AUTOMATICALLY BY c2man!
|
|
Packit Service |
12e4cd |
.\" DO NOT EDIT! CHANGES MADE TO THIS FILE WILL BE LOST!
|
|
Packit Service |
12e4cd |
.TH "fribidi_shape" 3 "19 February 2018" "c2man fribidi-shape.h" "Programmer's Manual"
|
|
Packit Service |
12e4cd |
.SH "NAME"
|
|
Packit Service |
12e4cd |
fribidi_shape \- do bidi-aware shaping
|
|
Packit Service |
12e4cd |
.SH "SYNOPSIS"
|
|
Packit Service |
12e4cd |
.ft B
|
|
Packit Service |
12e4cd |
#include <fribidi.h>
|
|
Packit Service |
12e4cd |
.sp
|
|
Packit Service |
12e4cd |
extern void fribidi_shape
|
|
Packit Service |
12e4cd |
.br
|
|
Packit Service |
12e4cd |
(
|
|
Packit Service |
12e4cd |
.br
|
|
Packit Service |
12e4cd |
FriBidiFlags flags,
|
|
Packit Service |
12e4cd |
.br
|
|
Packit Service |
12e4cd |
const FriBidiLevel *embedding_levels,
|
|
Packit Service |
12e4cd |
.br
|
|
Packit Service |
12e4cd |
const FriBidiStrIndex len,
|
|
Packit Service |
12e4cd |
.br
|
|
Packit Service |
12e4cd |
FriBidiArabicProp *ar_props,
|
|
Packit Service |
12e4cd |
.br
|
|
Packit Service |
12e4cd |
FriBidiChar *str
|
|
Packit Service |
12e4cd |
.br
|
|
Packit Service |
12e4cd |
);
|
|
Packit Service |
12e4cd |
.ft R
|
|
Packit Service |
12e4cd |
.SH "PARAMETERS"
|
|
Packit Service |
12e4cd |
.TP
|
|
Packit Service |
12e4cd |
.B "FriBidiFlags flags"
|
|
Packit Service |
12e4cd |
Shaping flags.
|
|
Packit Service |
12e4cd |
.TP
|
|
Packit Service |
12e4cd |
.B "const FriBidiLevel *embedding_levels"
|
|
Packit Service |
12e4cd |
Input list of embedding
|
|
Packit Service |
12e4cd |
levels, as returned by
|
|
Packit Service |
12e4cd |
fribidi_get_par_embedding_levels.
|
|
Packit Service |
12e4cd |
.TP
|
|
Packit Service |
12e4cd |
.B "const FriBidiStrIndex len"
|
|
Packit Service |
12e4cd |
Input string length.
|
|
Packit Service |
12e4cd |
.TP
|
|
Packit Service |
12e4cd |
.B "FriBidiArabicProp *ar_props"
|
|
Packit Service |
12e4cd |
Input/output Arabic properties as
|
|
Packit Service |
12e4cd |
computed by fribidi_join_arabic.
|
|
Packit Service |
12e4cd |
.TP
|
|
Packit Service |
12e4cd |
.B "FriBidiChar *str"
|
|
Packit Service |
12e4cd |
String to shape.
|
|
Packit Service |
12e4cd |
.SH "DESCRIPTION"
|
|
Packit Service |
12e4cd |
This function does all shaping work that depends on the resolved embedding
|
|
Packit Service |
12e4cd |
levels of the characters. Currently it does mirroring and Arabic shaping,
|
|
Packit Service |
12e4cd |
but the list may grow in the future. This function is a wrapper around
|
|
Packit Service |
12e4cd |
fribidi_shape_mirroring and fribidi_shape_arabic.
|
|
Packit Service |
12e4cd |
|
|
Packit Service |
12e4cd |
The flags parameter specifies which shapings are applied. The only flags
|
|
Packit Service |
12e4cd |
affecting the functionality of this function are those beginning with
|
|
Packit Service |
12e4cd |
FRIBIDI_FLAG_SHAPE_. Of these, only FRIBIDI_FLAG_SHAPE_MIRRORING is on
|
|
Packit Service |
12e4cd |
in FRIBIDI_FLAGS_DEFAULT. For details of the Arabic-specific flags see
|
|
Packit Service |
12e4cd |
fribidi_shape_arabic. If ar_props is NULL, no Arabic shaping is performed.
|
|
Packit Service |
12e4cd |
|
|
Packit Service |
12e4cd |
Feel free to do your own shaping before or after calling this function,
|
|
Packit Service |
12e4cd |
but you should take care of embedding levels yourself then.
|
|
Packit Service |
12e4cd |
.SH "SEE ALSO"
|
|
Packit Service |
12e4cd |
fribidi_shape_arabic(3),
|
|
Packit Service |
12e4cd |
fribidi_get_par_direction(3),
|
|
Packit Service |
12e4cd |
fribidi_get_par_embedding_levels_ex(3),
|
|
Packit Service |
12e4cd |
fribidi_reorder_line(3),
|
|
Packit Service |
12e4cd |
fribidi_get_bidi_type(3),
|
|
Packit Service |
12e4cd |
fribidi_get_bidi_types(3),
|
|
Packit Service |
12e4cd |
fribidi_get_bidi_type_name(3),
|
|
Packit Service |
12e4cd |
fribidi_debug_status(3),
|
|
Packit Service |
12e4cd |
fribidi_set_debug(3),
|
|
Packit Service |
12e4cd |
fribidi_charset_to_unicode(3),
|
|
Packit Service |
12e4cd |
fribidi_unicode_to_charset(3),
|
|
Packit Service |
12e4cd |
fribidi_parse_charset(3),
|
|
Packit Service |
12e4cd |
fribidi_mirroring_status(3),
|
|
Packit Service |
12e4cd |
fribidi_set_mirroring(3),
|
|
Packit Service |
12e4cd |
fribidi_reorder_nsm_status(3),
|
|
Packit Service |
12e4cd |
fribidi_set_reorder_nsm(3),
|
|
Packit Service |
12e4cd |
fribidi_log2vis_get_embedding_levels(3),
|
|
Packit Service |
12e4cd |
fribidi_get_type(3),
|
|
Packit Service |
12e4cd |
fribidi_get_type_internal(3),
|
|
Packit Service |
12e4cd |
fribidi_remove_bidi_marks(3),
|
|
Packit Service |
12e4cd |
fribidi_log2vis(3),
|
|
Packit Service |
12e4cd |
fribidi_get_par_embedding_levels(3),
|
|
Packit Service |
12e4cd |
fribidi_join_arabic(3),
|
|
Packit Service |
12e4cd |
fribidi_get_joining_type(3),
|
|
Packit Service |
12e4cd |
fribidi_get_joining_types(3),
|
|
Packit Service |
12e4cd |
fribidi_get_joining_type_name(3),
|
|
Packit Service |
12e4cd |
fribidi_get_mirror_char(3),
|
|
Packit Service |
12e4cd |
fribidi_shape_mirroring(3),
|
|
Packit Service |
12e4cd |
fribidi_get_bracket(3),
|
|
Packit Service |
12e4cd |
fribidi_get_bracket_types(3)
|