doc/fribidi_shape_arabic.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_arabic" 3 "20 July 2018" "c2man fribidi-arabic.h" "Programmer's Manual"
   4 .SH "NAME"
   5 fribidi_shape_arabic \- do Arabic shaping
   6 .SH "SYNOPSIS"
   7 .ft B
   8 #include <fribidi.h>
   9 .sp
  10 extern void fribidi_shape_arabic
  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 Not Documented.
  33 .TP
  34 .B "const FriBidiStrIndex len"
  35 Input string length.
  36 .TP
  37 .B "FriBidiArabicProp *ar_props"
  38 Input/output Arabic properties as
  39 computed by fribidi_join_arabic.
  40 .TP
  41 .B "FriBidiChar *str"
  42 String to shape.
  43 .SH "DESCRIPTION"
  44 The actual shaping that is done depends on the flags set.  Only flags
  45 starting with FRIBIDI_FLAG_SHAPE_ARAB_ affect this function.
  46 Currently these are:
  47
  48 .br
  49 * FRIBIDI_FLAG_SHAPE_MIRRORING: Do mirroring.
  50 .br
  51 * FRIBIDI_FLAG_SHAPE_ARAB_PRES: Shape Arabic characters to their
  52 presentation form glyphs.
  53 .br
  54 * FRIBIDI_FLAG_SHAPE_ARAB_LIGA: Form mandatory Arabic ligatures.
  55 .br
  56 * FRIBIDI_FLAG_SHAPE_ARAB_CONSOLE: Perform additional Arabic shaping
  57 suitable for text rendered on
  58 grid terminals with no mark
  59 rendering capabilities.
  60
  61 Of the above, FRIBIDI_FLAG_SHAPE_ARAB_CONSOLE is only used in special
  62 cases, but the rest are recommended in any environment that doesn't have
  63 other means for doing Arabic shaping.  The set of extra flags that enable
  64 this level of Arabic support has a shortcut named FRIBIDI_FLAGS_ARABIC.
  65 .SH "SEE ALSO"
  66 fribidi_get_par_direction(3),
  67 fribidi_get_par_embedding_levels_ex(3),
  68 fribidi_reorder_line(3),
  69 fribidi_get_bidi_type(3),
  70 fribidi_get_bidi_types(3),
  71 fribidi_get_bidi_type_name(3),
  72 fribidi_debug_status(3),
  73 fribidi_set_debug(3),
  74 fribidi_charset_to_unicode(3),
  75 fribidi_unicode_to_charset(3),
  76 fribidi_parse_charset(3),
  77 fribidi_mirroring_status(3),
  78 fribidi_set_mirroring(3),
  79 fribidi_reorder_nsm_status(3),
  80 fribidi_set_reorder_nsm(3),
  81 fribidi_log2vis_get_embedding_levels(3),
  82 fribidi_get_type(3),
  83 fribidi_get_type_internal(3),
  84 fribidi_get_par_embedding_levels(3),
  85 fribidi_join_arabic(3),
  86 fribidi_get_joining_type(3),
  87 fribidi_get_joining_types(3),
  88 fribidi_get_joining_type_name(3),
  89 fribidi_get_mirror_char(3),
  90 fribidi_shape_mirroring(3),
  91 fribidi_get_bracket(3),
  92 fribidi_get_bracket_types(3),
  93 fribidi_shape(3),
  94 fribidi_remove_bidi_marks(3)