summary refs log blame commit diff stats
path: root/src/Makefile.am
blob: 7885669233054fac31726c9a4be99882d81dfaa3 (plain) (tree) 
4a6ceffb ^














1
2
3
4
5
6
7
8
9
10
11
12
13
14














                                                         
## Process this file with automake to produce Makefile.in

EXTRA_DIST = fe-text/fe-text.c \
	fe-text/README fe-text/fe-text.h version-script

if DO_TEXT
text_fe = fe-text
endif

if DO_GTK
gtk_fe = fe-gtk
endif

SUBDIRS = pixmaps common $(gtk_fe) $(text_fe)
generated by cgit-pink 1.4.1 (git 2.36.1) at 2024-10-31 07:18:31 +0000
4 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 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 
// 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::fmt::Display;
use ::std::fmt::Formatter;
use ::std::future::Future;
use ::std::hash::Hash;
use ::std::io::Cursor;
use ::std::marker::PhantomData;
use ::std::num::ParseFloatError;
use ::std::num::ParseIntError;
use ::std::ops::Bound;
use ::std::ops::RangeBounds;
use ::std::pin::Pin;
use ::std::str::FromStr;

use anycast::Anycast;
//use ::ordered_float::OrderedFloat;

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>(PhantomData<(&'i str, S, E)>);

/// An argument parser/validator.
///
/// Note: Iosonism requires argument types to be `Send + Sync`, but for ease
/// when implementing generic argument types, those bounds are not reflected in
/// this trait. Nevertheless, Iosonism doesn't itself use threads, so a
/// [workaround] can be used if one needs non-`Send + Sync` argument types.
///
/// Additionally, argument types must be `Display`, `Eq` and `Hash`. This *is*
/// reflected in this trait.
///
/// [workaround]: https://users.rust-lang.org/t/how-to-check-send-at-runtime-similar-to-how-refcell-checks-borrowing-at-runtime/68269
///
/// # 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::fmt::Display;
/// 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()
///     }
/// }
///
/// impl Display for BoolArgumentType {
///     fn fmt(&self, f: &mut ::std::fmt::Formatter) -> ::std::fmt::Result {
///         write!(f, "bool()")
///     }
/// }
/// ```
pub trait ArgumentType<S, E>: Display + Eq + ::std::hash::Hash {
    /// 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(&[])
    }
}

/// Internal wrapper around `ArgumentType`, but with more `Any`.
pub(crate) trait ArgumentTypeAny<S, E>: Send + Sync + Display + Anycast {
    /// 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]>;

    /// Compares this `ArgumentType` with another.
    fn dyn_eq(&self, other: &dyn ArgumentTypeAny<S, E>) -> bool;

    /// Hashes this `ArgumentType`.
    fn dyn_hash(&self, hasher: &mut dyn ::std::hash::Hasher);
}

/// Any `ArgumentType` that is also `Send`, `Sync`, `Eq` and `Hash` is an
/// `ArgumentTypeAny`.
impl<T, S, E> ArgumentTypeAny<S, E> for T
where T: ArgumentType<S, E> + Send + Sync + Eq + ::std::hash::Hash + Any {
    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()
    }

    fn dyn_eq(&self, other: &dyn ArgumentTypeAny<S, E>) -> bool {
        match other.any_ref().downcast_ref() {
            Some(other) => self == other,
            None => false,
        }
    }

    fn dyn_hash(&self, mut hasher: &mut dyn ::std::hash::Hasher) {
        // rust-lang/rust#44015
        self.hash(&mut hasher)
    }
}

/// Any `dyn ArgumentTypeAny` (note the `dyn`!) is an `ArgumentType`.
impl<S, E> ArgumentType<S, E> for dyn ArgumentTypeAny<S, E> {
    type Result = Box<dyn Any>;

    fn parse<'i>(
        &self,
        reader: &mut Cursor<&'i str>,
    ) -> Result<Box<dyn Any>, E> where E: 'i {
        self.parse(reader)
    }

    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()
    }
}

impl<S, E> PartialEq for dyn ArgumentTypeAny<S, E> {
    fn eq(&self, other: &Self) -> bool {
        self.dyn_eq(other)
    }
}

impl<S, E> Eq for dyn ArgumentTypeAny<S, E> {
}

impl<S, E> ::std::hash::Hash for dyn ArgumentTypeAny<S, E> {
    fn hash<H: ::std::hash::Hasher>(&self, hasher: &mut H) {
        self.dyn_hash(hasher as &mut dyn ::std::hash::Hasher)
    }
}

/// A boolean argument.
// FIXME add examples/expand docs
#[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"])
    }
}

/// Formats this `BoolArgumentType`.
///
/// Always `"bool()"`.
impl Display for BoolArgumentType {
    fn fmt(&self, f: &mut Formatter) -> ::std::fmt::Result {
        write!(f, "bool()")
    }
}

/// 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> + Eq + Hash,
    T: PartialOrd<T> + FromStr<Err=ParseIntError> + Any + Display + Eq + Hash,
{
    /// 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"])
    }
}

/// Formats this `IntegerArgumentType`.
///
/// The resulting string follows the syntax `"integer(start,end)"`, with
/// `start` and `end` being one of the below:
///
/// - `value` if the bound is inclusive.
/// - `value*` if the bound is exclusive.
/// - `-` if it's unbounded.
///
/// For example, `integer(0*,-)` is an unbounded positive integer, and
/// `integer(1,10)` is an integer between 1 and 10 inclusive.
impl<T: Display, R: RangeBounds<T>> Display for IntegerArgumentType<T, R> {
    fn fmt(&self, f: &mut Formatter) -> ::std::fmt::Result {
        let start_bound = self.range.start_bound();
        let end_bound = self.range.end_bound();
        write!(f, "integer(")?;
        match start_bound {
            Bound::Included(t) => write!(f, "{}", t)?,
            Bound::Excluded(t) => write!(f, "{}*", t)?,
            Bound::Unbounded => write!(f, "-")?,
        }
        write!(f, ",")?;
        match end_bound {
            Bound::Included(t) => write!(f, "{}", t)?,
            Bound::Excluded(t) => write!(f, "{}*", t)?,
            Bound::Unbounded => write!(f, "-")?,
        }
        write!(f,")")
    }
}

// FIXME implement Eq and Hash properly
/// A float argument.
#[derive(Copy, Clone, PartialEq, Eq, Debug, PartialOrd, Ord, Hash, 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> + Eq + Hash,
    T: PartialOrd<T> + FromStr<Err=ParseFloatError> + Any + Display + Eq + Hash,
{
    /// 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"])
    }
}

/// Formats this `FloatArgumentType`.
///
/// The resulting string follows the syntax `"float(start,end)"`, with `start`
/// and `end` being one of the below:
///
/// - `value` if the bound is inclusive.
/// - `value*` if the bound is exclusive.
/// - `-` if it's unbounded.
///
/// For example, `float(0*,-)` is an unbounded positive float, and
/// `float(1,10)` is a float between 1.0 and 10.0 inclusive.
impl<T: Display, R: RangeBounds<T>> Display for FloatArgumentType<T, R> {
    fn fmt(&self, f: &mut Formatter) -> ::std::fmt::Result {
        let start_bound = self.range.start_bound();
        let end_bound = self.range.end_bound();
        write!(f, "float(")?;
        match start_bound {
            Bound::Included(t) => write!(f, "{}", t)?,
            Bound::Excluded(t) => write!(f, "{}*", t)?,
            Bound::Unbounded => write!(f, "-")?,
        }
        write!(f, ",")?;
        match end_bound {
            Bound::Included(t) => write!(f, "{}", t)?,
            Bound::Excluded(t) => write!(f, "{}*", t)?,
            Bound::Unbounded => write!(f, "-")?,
        }
        write!(f,")")
    }
}

/// A string argument.
#[derive(Copy, Clone, PartialEq, Eq, Debug, PartialOrd, Ord, Hash)]
pub struct StringArgumentType(StringMode);

/// Creates a string argument that accepts simple words.
///
/// # Examples
///
/// ```rust
/// use ::iosonism::args::word;
///
/// let argtype = word();
/// ```
pub fn word() -> StringArgumentType {
    StringArgumentType(StringMode::SingleWord)
}

/// Creates a string argument that accepts simple words and quoted strings.
///
/// # Examples
///
/// ```rust
/// use ::iosonism::args::string;
///
/// let argtype = string();
/// ```
pub fn string() -> StringArgumentType {
    StringArgumentType(StringMode::QuotablePhrase)
}

/// Creates a string argument that accepts simple text until the end of the
/// input.
///
/// # Examples
///
/// ```rust
/// use ::iosonism::args::greedy_string;
///
/// let argtype = greedy_string();
/// ```
pub fn greedy_string() -> StringArgumentType {
    StringArgumentType(StringMode::GreedyPhrase)
}

/// The "mode" of parsing a string.
#[derive(Copy, Clone, PartialEq, Eq, Debug, PartialOrd, Ord, Hash)]
enum StringMode {
    SingleWord,
    QuotablePhrase,
    GreedyPhrase,
}

/// An `ArgumentType` for strings.
impl<S, E> ArgumentType<S, E> for StringArgumentType
where for<'i> E: ReadError<'i, Cursor<&'i str>> {
    /// A `StringArgumentType` parses a string.
    type Result = String;

    /// Attempts to parse a string from the `reader`.
    fn parse<'i>(
        &self,
        reader: &mut Cursor<&'i str>,
    ) -> Result<String, E> where E: 'i {
        match self {
            Self(StringMode::SingleWord) => {
                Ok(reader.read_unquoted_str().into())
            },
            Self(StringMode::QuotablePhrase) => reader.read_string(),
            Self(StringMode::GreedyPhrase) => {
                let text = reader.get_remaining().into();
                reader.set_position(reader.total_len() as u64);
                Ok(text)
            },
        }
    }

    /// Returns examples
    fn get_examples(&self) -> Cow<'static, [&str]> {
        match self {
            Self(StringMode::SingleWord) => {
                Cow::Borrowed(&["word", "words_With_underscores"])
            },
            Self(StringMode::QuotablePhrase) => {
                Cow::Borrowed(&["\"quoted phrase\"", "word", "\"\""])
            },
            Self(StringMode::GreedyPhrase) => {
                Cow::Borrowed(&["word", "with spaces", "text \"and symbols\""])
            },
        }
    }
}

/// Formats this `StringArgumentType`.
///
/// The resulting string follows the syntax `"string(type)"`, with `type` being
/// one of the below:
///
/// - `word` if this argument matches a single word.
/// - `"phrase"` if this argument matches a single word or a quoted phrase.
/// - `text ...` if this argument matches any text up to the end of the input.
impl Display for StringArgumentType {
    fn fmt(&self, f: &mut Formatter) -> ::std::fmt::Result {
        match self {
            Self(StringMode::SingleWord) => {
                write!(f, "string(word)")
            },
            Self(StringMode::QuotablePhrase) => {
                write!(f, "string(\"phrase\")")
            },
            Self(StringMode::GreedyPhrase) => {
                write!(f, "string(text ...)")
            },
        }
    }
}
generated by cgit-pink 1.4.1 (git 2.36.1) at 2024-10-31 07:18:31 +0000