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

//! # ArabicReshaper
//!
//! Reconstruct Arabic sentences to be used in applications that don't support Arabic script.
//!
//! ## Usage:
//! reshape a single string
//! ```rust
//! use ar_reshaper::{ArabicReshaper, reshape_line};
//!
//! let reshaper = ArabicReshaper::default();
//!
//! // You can reshape just a single string using
//! println!("{}", reshaper.reshape("سلام دنیا"));
//! // or `reshape_line` method if you dont want to construct the [ArabicReshaper]
//! // and you just want to reshape a line with default settings
//! println!("{}", reshape_line("سلام دنیا"));
//! // Both will reconstruct the string and print `ﺳﻼﻡ ﺩﻧﯿﺎ`
//! ```
//!
//! reshape a slice of strings
//! ```rust
//! use ar_reshaper::ArabicReshaper;
//!
//! let reshaper = ArabicReshaper::default();
//!
//! println!("{:#?}", reshaper.reshape_lines(["سلام خوبی؟", "عالیم ممنون"]));
//! // this will reconstruct the string and print  ["ﺳﻼﻡ ﺧﻮﺑﯽ؟", "ﻋﺎﻟﯿﻢ ﻣﻤﻨﻮﻥ"]
//! ```
//!
//! You can also reshape strings on a iterator
//! ```rust
//! use ar_reshaper::prelude::*;
//!
//! for line in ["یک", "دو"].iter().reshape_default() {
//!     println!("{line}");
//! }
//! ```
//!
//! A rusty rewrite of [python-arabic-reshaper](https://github.com/mpcabd/python-arabic-reshaper)
//! You can check the original repository for more information.
#![forbid(unsafe_code)]

pub use config::{Language, ReshaperConfig};
pub use reshaper::ArabicReshaper;

pub mod config;
pub mod iterator;
pub mod letters;
mod ligatures;
mod reshaper;
#[cfg(test)]
mod tests;

pub mod prelude {
    pub use crate::config::*;
    pub use crate::iterator::*;
    pub use crate::ligatures::LigatureNames;
    pub use crate::reshaper::ArabicReshaper;
}

/// Reshape the given text with the default [ArabicReshaper] configuration.\
/// Keep in mind that if you want to reshape a large amount of lines its better
/// to first create a [ArabicReshaper] and then use the `reshape` or `reshape_lines`
/// methods of it instead.
pub fn reshape_line<S>(text: S) -> String
where
    S: AsRef<str>,
{
    let reshaper = ArabicReshaper::default();

    reshaper.reshape(text)
}