File: fribidi_remove_bidi_marks.3

package info (click to toggle)
fribidi 1.0.5-3.1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster, sid
  • size: 19,752 kB
  • sloc: ansic: 8,701; sh: 4,573; makefile: 350; python: 27
file content (96 lines) | stat: -rw-r--r-- 2,909 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
.\" WARNING! THIS FILE WAS GENERATED AUTOMATICALLY BY c2man!
.\" DO NOT EDIT! CHANGES MADE TO THIS FILE WILL BE LOST!
.TH "fribidi_remove_bidi_marks" 3 "19 February 2018" "c2man fribidi-deprecated.h" "Programmer's Manual"
.SH "NAME"
fribidi_remove_bidi_marks \- remove bidi marks out of an string
.SH "SYNOPSIS"
.ft B
#include <fribidi.h>
.sp
extern FriBidiStrIndex fribidi_remove_bidi_marks
.br
(
.br
	FriBidiChar *str,
.br
	const FriBidiStrIndex len,
.br
	FriBidiStrIndex *positions_to_this,
.br
	FriBidiStrIndex *position_from_this_list,
.br
	FriBidiLevel *embedding_levels
.br
);
.ft R
.SH "PARAMETERS"
.TP
.B "FriBidiChar *str"
Input string to clean.
.TP
.B "const FriBidiStrIndex len"
Input string length.
.TP
.B "FriBidiStrIndex *positions_to_this"
List mapping positions to the
order used in str.
.TP
.B "FriBidiStrIndex *position_from_this_list"
List mapping positions from the
order used in str.
.TP
.B "FriBidiLevel *embedding_levels"
List of embedding levels.
.SH "DESCRIPTION"
This function removes the bidi and boundary-neutral marks out of an string
and the accompanying lists.  It implements rule X9 of the Unicode
Bidirectional Algorithm available at
http://www.unicode.org/reports/tr9/#X9, with the exception that it removes
U+200E LEFT-TO-RIGHT MARK and U+200F RIGHT-TO-LEFT MARK too.

If any of the input lists are NULL, the list is skipped.  If str is the
visual string, then positions_to_this is  positions_L_to_V and
position_from_this_list is positions_V_to_L;  if str is the logical
string, the other way. Moreover, the position maps should be filled with
valid entries.

A position map pointing to a removed character is filled with \(hy1. By the
way, you should not use embedding_levels if str is visual string.

For best results this function should be run on a whole paragraph, not
lines; but feel free to do otherwise if you know what you are doing.
Deprecated.  Use fribidi_remove_special_chars instead.
.SH "RETURNS"
New length of the string, or \(hy1 if an error occurred (memory
allocation failure most probably).
.SH "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_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_log2vis(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)