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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144

//! String replacements using regex.
//!
//! # Table of contents
//! * [Description](#description)
//! * [Accent](#accent)
//! * [Tag trait](#tag-trait)
//! * [Implementing Tag trait](#implementing-tag-trait)
//! * [CLI tool](#cli-tool)
//! * [Feature flags](#feature-flags)
//!
//! # Description
//!
//! Provides a way to define a set of rules for replacing text in string. Each rule consists of
//! regex pattern and Tag trait object. The original use case is to simulate
//! mispronounciations in speech accents via text.
//!
//! # Accent
//!
//! [`Accent`] is an array of [`Pass`] named blocks. Each block consists of rules. Regexes inside
//! [`Pass`] are compiled into a single big regex which allows walking haystack only once but
//! sometimes is not enough. For this reason you can define multiple separate ones.
//!
//! This library defines a rule layout that should make it easy to define speech accent. It does
//! the following:
//!
//! * defines `rules` - a list of passes
//! * allows adding or replacing existing rules for higher intensities of accent
//! * executes rules for matching severity group sequentially from top to bottom
//!
//! Intensities is a way to make accent worse. You can override certain rules or replace everything
//! completely.
//!
//! See `examples` folder, specifically `example.ron` for full reference.
//!
//! # Tag trait
//!
//! [`Tag`] is a core of this library. It is an extendable trait. After implementing it you
//! can can parse it along default implementations and other ones.
//!
//! Default replacments from [`tag_impls`] are:
//!
//! * [`Original`] does not replace (leaves original match as is)
//! * [`Delete`] deletes match
//! * [`Literal`] puts given string
//! * [`Any`] selects random inner tag with equal weights
//! * [`Weights`] selects random inner tag based on relative weights
//! * [`Upper`] converts inner result to uppercase
//! * [`Lower`] converts inner result to lowercase
//! * [`Concat`] runs left and right inner tags and adds them together
//!
//! # Implementing Tag trait
//!
//! `StringCase` either uppercases or lowercases match depending of given boolean:
//!
//! ```rust
//! use sayit::{
//!     Accent,
//!     Match,
//!     Tag,
//! };
//!
//! // Deserialize is only required with `deserialize` crate feature
//! #[derive(Clone, Debug, serde::Deserialize)]
//! // transparent allows using `true` directly instead of `(true)`
//! #[serde(transparent)]
//! pub struct StringCase(bool);
//!
//! // `typetag` is only required with `deserialize` crate feature
//! #[typetag::deserialize]
//! impl Tag for StringCase {
//!     fn generate<'a>(&self, m: &Match<'a>) -> std::borrow::Cow<'a, str> {
//!         if self.0 {
//!             m.get_match().to_uppercase()
//!         } else {
//!             m.get_match().to_lowercase()
//!         }.into()
//!     }
//! }
//!
//! // construct accent that will uppercase all instances of "a" and lowercase all "b"
//! let accent = ron::from_str::<Accent>(
//!     r#"
//! (
//!     accent: {
//!         "main": (
//!             rules: {
//!                 "a": {"StringCase": true},
//!                 "b": {"StringCase": false},
//!             }
//!         ),
//!     }
//! )
//! "#,
//! )
//! .expect("accent did not parse");
//!
//! assert_eq!(accent.say_it("abab ABAB Hello", 0), "AbAb AbAb Hello");
//! ```
//!
//! # CLI tool
//!
//! You can run CLI tool by enabling `cli` feature: `cargo run --features=cli -- --help`.  
//! It is useful for debugging and can run any of the example accents.
//!
//! `echo hello | cargo run --features=cli -- -a examples/clown.ron` will honk at you.
//!
//! # Feature flags
//!
//! Name | Description | Default?
//! ---|---|---
//! `deserialize` | enables deserialization for [`Tag`] trait | yes
//! `cli` | required to run CLI tool | no
//!
//! [`Tag`]: crate::Tag
//! [`Pass`]: crate::pass::Pass
//! [`Match`]: crate::Match
//! [`Intensity`]: crate::intensity::Intensity
//! [`Original`]: crate::tag_impls::Original
//! [`Delete`]: crate::tag_impls::Delete
//! [`Literal`]: crate::tag_impls::Literal
//! [`Any`]: crate::tag_impls::Any
//! [`Weights`]: crate::tag_impls::Weights
//! [`Upper`]: crate::tag_impls::Upper
//! [`Lower`]: crate::tag_impls::Lower
//! [`Concat`]: crate::tag_impls::Concat

pub mod accent;
pub mod intensity;
pub mod r#match;
pub mod pass;
pub mod tag;
pub mod tag_impls;

#[doc(hidden)] // pub for bench
pub mod utils;

#[cfg(feature = "deserialize")]
mod deserialize;

pub use accent::Accent;
pub use intensity::Intensity;
pub use pass::Pass;
pub use r#match::Match;
pub use tag::Tag;