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
|
// This file is part of Hexchat Plugin API Bindings for Rust
// Copyright (C) 2022 Soni L.
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.
/// Stripping mode for [`PluginHandle::strip`](crate::PluginHandle::strip).
#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, Default)]
pub struct Strip {
// 4
hidden: bool,
// 2
formatting: bool,
// 1
colors: bool,
}
impl Strip {
/// Creates a new `Strip` that, by default, strips no attributes.
///
/// # Examples
///
/// ```no_run
/// use hexchat_unsafe_plugin::{PluginHandle, Strip};
///
/// fn strip_nothing(s: &str, ph: &PluginHandle<'_>) -> String {
/// ph.strip(s, Strip::new())
/// }
/// ```
#[inline]
pub const fn new() -> Strip {
Strip {
hidden: false,
formatting: false,
colors: false,
}
}
/// Sets whether to remove mIRC color attributes.
///
/// # Examples
///
/// ```no_run
/// use hexchat_unsafe_plugin::{PluginHandle, Strip};
///
/// fn strip_colors(s: &str, ph: &PluginHandle<'_>) -> String {
/// ph.strip(s, Strip::new().colors(true))
/// }
/// ```
#[inline]
pub const fn colors(mut self, strip: bool) -> Self {
self.colors = strip;
self
}
/// Sets whether to remove formatting attributes.
///
/// # Examples
///
/// ```no_run
/// use hexchat_unsafe_plugin::{PluginHandle, Strip};
///
/// fn strip_formatting(s: &str, ph: &PluginHandle<'_>) -> String {
/// ph.strip(s, Strip::new().formatting(true))
/// }
/// ```
#[inline]
pub const fn formatting(mut self, strip: bool) -> Self {
self.formatting = strip;
self
}
/// Sets whether to remove internal "hidden text" formatting attributes.
///
/// This is split from [`Self::formatting`] because these attributes are
/// only processed when writing directly to a buffer - they're for
/// internal/plugin use. This tends to be useful when processing user or
/// remote input and writing it directly to a buffer.
///
/// # Examples
///
/// ```no_run
/// use hexchat_unsafe_plugin::{PluginHandle, Strip};
///
/// fn strip_hidden(s: &str, ph: &PluginHandle<'_>) -> String {
/// ph.strip(s, Strip::new().hidden(true))
/// }
/// ```
#[inline]
pub const fn hidden(mut self, strip: bool) -> Self {
self.hidden = strip;
self
}
/// Creates a new `Strip` that strips all strippable attributes.
///
/// # Examples
///
/// ```no_run
/// use hexchat_unsafe_plugin::{PluginHandle, Strip};
///
/// fn strip_all(s: &str, ph: &PluginHandle<'_>) -> String {
/// ph.strip(s, Strip::all())
/// }
/// ```
#[inline]
pub const fn all() -> Strip {
Strip {
hidden: true,
formatting: true,
colors: true,
}
}
/// Builds the flags for FFI.
pub(crate) fn flags(self) -> ::libc::c_int {
let mut value = 0;
if self.hidden {
value |= 4;
}
if self.formatting {
value |= 2;
}
if self.colors {
value |= 1;
}
value
}
}
|
