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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
|
// Copyright (c) 2021 Soni L.
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT license.
// Documentation and comments licensed under CC BY-SA 4.0.
//! Argument processing.
use ::std::any::Any;
use ::std::borrow::Cow;
use ::std::future::Future;
use ::std::io::Cursor;
use ::std::marker::PhantomData;
use ::std::num::ParseFloatError;
use ::std::num::ParseIntError;
use ::std::ops::RangeBounds;
use ::std::pin::Pin;
use ::std::str::FromStr;
use crate::error::RangeError;
use crate::error::ReadError;
use crate::strcursor::StringReader;
use crate::suggestion::Suggestions;
use crate::suggestion::SuggestionsBuilder;
// FIXME delete when implemented
/// The parsing context of a command.
pub struct CommandContext<'i, S, E>(::std::marker::PhantomData<(&'i str, S, E)>);
/// An argument parser.
///
/// # Type params
///
/// - `S`: The source type accepted by this argument type.
/// - `E`: The error type accepted by this argument type.
///
/// # Examples
///
/// A very basic `bool` argument type:
///
/// ```
/// use ::std::io::Cursor;
///
/// use ::iosonism::args::ArgumentType;
/// use ::iosonism::error::ReadError;
/// use ::iosonism::strcursor::StringReader;
///
/// struct BoolArgumentType;
///
/// impl<S, E> ArgumentType<S, E> for BoolArgumentType
/// where for<'i> E: ReadError<'i, Cursor<&'i str>>
/// {
/// type Result = bool;
/// fn parse<'i>(
/// &self,
/// reader: &mut Cursor<&'i str>,
/// ) -> Result<bool, E> where E: 'i {
/// reader.read_bool()
/// }
/// }
/// ```
pub trait ArgumentType<S, E> {
/// The parsed type of the argument.
type Result: Sized + 'static + Any;
/// Parses an argument of this type, returning the parsed argument.
fn parse<'i>(
&self,
reader: &mut Cursor<&'i str>,
) -> Result<Self::Result, E> where E: 'i;
/// Creates suggestions for this argument.
fn list_suggestions<'i>(
&self,
context: &CommandContext<'i, S, E>,
builder: SuggestionsBuilder<'i>,
) -> Pin<Box<dyn Future<Output=Suggestions> + Send + 'i>> {
let _ = context;
let _ = builder;
Suggestions::empty()
}
/// Returns examples for this argument.
fn get_examples(&self) -> Cow<'static, [&str]> {
Cow::Borrowed(&[])
}
}
/// Wrapper around `ArgumentType`, but with `Any`.
pub(crate) trait ArgumentTypeAny<S, E> {
/// Parses an argument of this type, returning the parsed argument.
fn parse<'i>(
&self,
reader: &mut Cursor<&'i str>,
) -> Result<Box<dyn Any>, E> where E: 'i;
/// Creates suggestions for this argument.
fn list_suggestions<'i>(
&self,
context: &CommandContext<'i, S, E>,
builder: SuggestionsBuilder<'i>,
) -> Pin<Box<dyn Future<Output=Suggestions> + Send + 'i>>;
/// Returns examples for this argument.
fn get_examples(&self) -> Cow<'static, [&str]>;
}
impl<T: ArgumentType<S, E>, S, E> ArgumentTypeAny<S, E> for T {
fn parse<'i>(
&self,
reader: &mut Cursor<&'i str>,
) -> Result<Box<dyn Any>, E> where E: 'i {
self.parse(reader).map(|x| Box::new(x) as _)
}
fn list_suggestions<'i>(
&self,
context: &CommandContext<'i, S, E>,
builder: SuggestionsBuilder<'i>,
) -> Pin<Box<dyn Future<Output=Suggestions> + Send + 'i>> {
self.list_suggestions(context, builder)
}
fn get_examples(&self) -> Cow<'static, [&str]> {
self.get_examples()
}
}
/// A boolean argument.
// FIXME add examples/expand docs
// FIXME add tests
#[derive(Copy, Clone, PartialEq, Eq, Debug, PartialOrd, Ord, Hash, Default)]
pub struct BoolArgumentType;
/// An `ArgumentType` for `bool`.
impl<S, E> ArgumentType<S, E> for BoolArgumentType
where for<'i> E: ReadError<'i, Cursor<&'i str>>
{
/// A `BoolArgumentType` parses a `bool`.
type Result = bool;
/// Attempts to parse a `bool` from the `reader`.
fn parse<'i>(
&self,
reader: &mut Cursor<&'i str>,
) -> Result<bool, E> where E: 'i {
reader.read_bool()
}
/// Suggests completions for inputting a boolean argument.
fn list_suggestions<'i>(
&self,
context: &CommandContext<'i, S, E>,
mut builder: SuggestionsBuilder<'i>,
) -> Pin<Box<dyn Future<Output=Suggestions> + Send + 'i>> {
let _ = context;
if "true".starts_with(builder.get_remaining()) {
builder.suggest("true".into());
}
if "false".starts_with(builder.get_remaining()) {
builder.suggest("false".into());
}
builder.drain_build_future()
}
/// Returns examples
fn get_examples(&self) -> Cow<'static, [&str]> {
Cow::Borrowed(&["true", "false"])
}
}
/// An integer argument.
#[derive(Copy, Clone, PartialEq, Eq, Debug, PartialOrd, Ord, Hash, Default)]
pub struct IntegerArgumentType<T, R: RangeBounds<T>> {
/// The valid range for this argument.
pub range: R,
/// PhantomData for the type.
pub _ty: PhantomData<T>,
}
/// Helper to create an integer argument with values not bounded by a range.
///
/// # Examples
///
/// ```rust
/// use ::iosonism::args::integer;
///
/// let argtype = integer::<i32>();
/// ```
pub fn integer<T>() -> IntegerArgumentType<T, ::std::ops::RangeFull> {
IntegerArgumentType {
range: ..,
_ty: PhantomData,
}
}
/// Helper to create an integer argument with values bounded by a range.
///
/// # Examples
///
/// ```rust
/// use ::iosonism::args::bounded_integer;
///
/// let argtype = bounded_integer(0..100i32);
/// ```
pub fn bounded_integer<T, R: RangeBounds<T>>(
range: R,
) -> IntegerArgumentType<T, R> {
IntegerArgumentType {
range: range,
_ty: PhantomData,
}
}
/// An `ArgumentType` for integer types.
impl<S, E, T, R> ArgumentType<S, E> for IntegerArgumentType<T, R>
where
for<'i> E: ReadError<'i, Cursor<&'i str>>,
for<'i> E: RangeError<'i, Cursor<&'i str>, T, R>,
R: RangeBounds<T>,
T: PartialOrd<T> + FromStr<Err=ParseIntError> + Any,
{
/// An `IntegerArgumentType` parses an integer type.
type Result = T;
/// Attempts to parse an integer from the `reader`.
fn parse<'i>(
&self,
reader: &mut Cursor<&'i str>,
) -> Result<T, E> where E: 'i {
let start = reader.position();
let value = reader.read_integer()?;
if self.range.contains(&value) {
Ok(value)
} else {
reader.set_position(start);
Err(E::value_not_in_range(reader, &value, &self.range))
}
}
/// Returns examples
fn get_examples(&self) -> Cow<'static, [&str]> {
Cow::Borrowed(&["0", "123", "-123"])
}
}
/// A float argument.
#[derive(Copy, Clone, PartialEq, Debug, PartialOrd, Default)]
pub struct FloatArgumentType<T, R: RangeBounds<T>> {
/// The valid range for this argument.
pub range: R,
/// PhantomData for the type.
pub _ty: PhantomData<T>,
}
/// Helper to create a float argument with values not bounded by a range.
///
/// # Examples
///
/// ```rust
/// use ::iosonism::args::float;
///
/// let argtype = float::<f32>();
/// ```
pub fn float<T>() -> FloatArgumentType<T, ::std::ops::RangeFull> {
FloatArgumentType {
range: ..,
_ty: PhantomData,
}
}
/// Helper to create a float argument with values bounded by a range.
///
/// # Examples
///
/// ```rust
/// use ::iosonism::args::bounded_float;
///
/// let argtype = bounded_float(0.0..100f32);
/// ```
pub fn bounded_float<T, R: RangeBounds<T>>(
range: R,
) -> FloatArgumentType<T, R> {
FloatArgumentType {
range: range,
_ty: PhantomData,
}
}
/// An `ArgumentType` for float types.
impl<S, E, T, R> ArgumentType<S, E> for FloatArgumentType<T, R>
where
for<'i> E: ReadError<'i, Cursor<&'i str>>,
for<'i> E: RangeError<'i, Cursor<&'i str>, T, R>,
R: RangeBounds<T>,
T: PartialOrd<T> + FromStr<Err=ParseFloatError> + Any,
{
/// A `FloatArgumentType` parses a float type.
type Result = T;
/// Attempts to parse a float from the `reader`.
fn parse<'i>(
&self,
reader: &mut Cursor<&'i str>,
) -> Result<T, E> where E: 'i {
let start = reader.position();
let value = reader.read_float()?;
if self.range.contains(&value) {
Ok(value)
} else {
reader.set_position(start);
Err(E::value_not_in_range(reader, &value, &self.range))
}
}
/// Returns examples
fn get_examples(&self) -> Cow<'static, [&str]> {
Cow::Borrowed(&["0", "1.2", ".5", "-1", "-.5", "-1234.56"])
}
}
|