doc/fribidi_shape.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" 3 "20 July 2018" "c2man fribidi-shape.h" "Programmer's Manual"
   4 .SH "NAME"
   5 fribidi_shape \- do bidi-aware shaping
   6 .SH "SYNOPSIS"
   7 .ft B
   8 #include <fribidi.h>
   9 .sp
  10 extern void fribidi_shape
  11 .br
  12 (
  13 .br
  14         FriBidiFlags flags,
  15 .br
  16         const FriBidiLevel *embedding_levels,
  17 .br
  18         const FriBidiStrIndex len,
  19 .br
  20         FriBidiArabicProp *ar_props,
  21 .br
  22         FriBidiChar *str
  23 .br
  24 );
  25 .ft R
  26 .SH "PARAMETERS"
  27 .TP
  28 .B "FriBidiFlags flags"
  29 Shaping flags.
  30 .TP
  31 .B "const FriBidiLevel *embedding_levels"
  32 Input list of embedding
  33 levels, as returned by
  34 fribidi_get_par_embedding_levels.
  35 .TP
  36 .B "const FriBidiStrIndex len"
  37 Input string length.
  38 .TP
  39 .B "FriBidiArabicProp *ar_props"
  40 Input/output Arabic properties as
  41 computed by fribidi_join_arabic.
  42 .TP
  43 .B "FriBidiChar *str"
  44 String to shape.
  45 .SH "DESCRIPTION"
  46 This function does all shaping work that depends on the resolved embedding
  47 levels of the characters.  Currently it does mirroring and Arabic shaping,
  48 but the list may grow in the future.  This function is a wrapper around
  49 fribidi_shape_mirroring and fribidi_shape_arabic.
  50
  51 The flags parameter specifies which shapings are applied.  The only flags
  52 affecting the functionality of this function are those beginning with
  53 FRIBIDI_FLAG_SHAPE_.  Of these, only FRIBIDI_FLAG_SHAPE_MIRRORING is on
  54 in FRIBIDI_FLAGS_DEFAULT.  For details of the Arabic-specific flags see
  55 fribidi_shape_arabic.  If ar_props is NULL, no Arabic shaping is performed.
  56
  57 Feel free to do your own shaping before or after calling this function,
  58 but you should take care of embedding levels yourself then.
  59 .SH "SEE ALSO"
  60 fribidi_shape_arabic(3),
  61 fribidi_get_par_direction(3),
  62 fribidi_get_par_embedding_levels_ex(3),
  63 fribidi_reorder_line(3),
  64 fribidi_get_bidi_type(3),
  65 fribidi_get_bidi_types(3),
  66 fribidi_get_bidi_type_name(3),
  67 fribidi_debug_status(3),
  68 fribidi_set_debug(3),
  69 fribidi_charset_to_unicode(3),
  70 fribidi_unicode_to_charset(3),
  71 fribidi_parse_charset(3),
  72 fribidi_mirroring_status(3),
  73 fribidi_set_mirroring(3),
  74 fribidi_reorder_nsm_status(3),
  75 fribidi_set_reorder_nsm(3),
  76 fribidi_log2vis_get_embedding_levels(3),
  77 fribidi_get_type(3),
  78 fribidi_get_type_internal(3),
  79 fribidi_get_par_embedding_levels(3),
  80 fribidi_join_arabic(3),
  81 fribidi_get_joining_type(3),
  82 fribidi_get_joining_types(3),
  83 fribidi_get_joining_type_name(3),
  84 fribidi_get_mirror_char(3),
  85 fribidi_shape_mirroring(3),
  86 fribidi_get_bracket(3),
  87 fribidi_get_bracket_types(3),
  88 fribidi_remove_bidi_marks(3),
  89 fribidi_log2vis(3)