clap/src/lib.rs

614 lines
23 KiB
Rust
Raw Normal View History

// Copyright ⓒ 2015-2016 Kevin B. Knapp and [`clap-rs` contributors](https://github.com/kbknapp/clap-rs/blob/master/CONTRIBUTORS.md).
// Licensed under the MIT license
// (see LICENSE or <http://opensource.org/licenses/MIT>) All files in the project carrying such
// notice may not be copied, modified, or distributed except according to those terms.
2016-11-21 01:48:49 +00:00
//! `clap` is a simple-to-use, efficient, and full-featured library for parsing command line
//! arguments and subcommands when writing console/terminal applications.
//!
//! ## About
//!
2016-11-21 01:48:49 +00:00
//! `clap` is used to parse *and validate* the string of command line arguments provided by the user
//! at runtime. You provide the list of valid possibilities, and `clap` handles the rest. This means
//! you focus on your *applications* functionality, and less on the parsing and validating of
//! arguments.
//!
2016-11-21 01:48:49 +00:00
//! `clap` also provides the traditional version and help switches (or flags) 'for free' meaning
//! automatically with no configuration. It does this by checking list of valid possibilities you
//! supplied and adding only the ones you haven't already defined. If you are using subcommands,
//! `clap` will also auto-generate a `help` subcommand for you in addition to the traditional flags.
//!
2016-11-21 01:48:49 +00:00
//! Once `clap` parses the user provided string of arguments, it returns the matches along with any
//! applicable values. If the user made an error or typo, `clap` informs them of the mistake and
//! exits gracefully (or returns a `Result` type and allows you to perform any clean up prior to
//! exit). Because of this, you can make reasonable assumptions in your code about the validity of
//! the arguments.
//!
//!
//! ## Quick Example
//!
2016-11-21 01:48:49 +00:00
//! The following examples show a quick example of some of the very basic functionality of `clap`.
//! For more advanced usage, such as requirements, conflicts, groups, multiple values and
//! occurrences see the [documentation](https://docs.rs/clap/), [examples/] directory of
//! this repository or the [video tutorials].
//!
2016-11-21 01:48:49 +00:00
//! **NOTE:** All of these examples are functionally the same, but show different styles in which to
//! use `clap`
//!
2016-11-21 01:48:49 +00:00
//! The first example shows a method that allows more advanced configuration options (not shown in
//! this small example), or even dynamically generating arguments when desired. The downside is it's
//! more verbose.
//!
2016-11-21 02:27:17 +00:00
//! ```no_run
//! // (Full example with detailed comments in examples/01b_quick_example.rs)
//! //
//! // This example demonstrates clap's full 'builder pattern' style of creating arguments which is
//! // more verbose, but allows easier editing, and at times more advanced options, or the possibility
//! // to generate arguments dynamically.
//! extern crate clap;
//! use clap::{Arg, App, };
//!
//! fn main() {
//! let matches = App::new("My Super Program")
//! .version("1.0")
//! .author("Kevin K. <kbknapp@gmail.com>")
//! .about("Does awesome things")
//! .arg(Arg::with_name("config")
//! .short('c')
//! .long("config")
//! .value_name("FILE")
//! .help("Sets a custom config file")
//! .takes_value(true))
//! .arg(Arg::with_name("INPUT")
//! .help("Sets the input file to use")
//! .required(true)
//! .index(1))
//! .arg(Arg::with_name("v")
//! .short('v')
//! .multiple(true)
//! .help("Sets the level of verbosity"))
//! .subcommand(App::new("test")
//! .about("controls testing features")
//! .version("1.3")
//! .author("Someone E. <someone_else@other.com>")
//! .arg(Arg::with_name("debug")
//! .short('d')
//! .help("print debug information verbosely")))
//! .get_matches();
//!
//! // Gets a value for config if supplied by user, or defaults to "default.conf"
//! let config = matches.value_of("config").unwrap_or("default.conf");
//! println!("Value for config: {}", config);
//!
//! // Calling .unwrap() is safe here because "INPUT" is required (if "INPUT" wasn't
//! // required we could have used an 'if let' to conditionally get the value)
//! println!("Using input file: {}", matches.value_of("INPUT").unwrap());
//!
//! // Vary the output based on how many times the user used the "verbose" flag
//! // (i.e. 'myprog -v -v -v' or 'myprog -vvv' vs 'myprog -v'
//! match matches.occurrences_of("v") {
//! 0 => println!("No verbose info"),
//! 1 => println!("Some verbose info"),
//! 2 => println!("Tons of verbose info"),
//! 3 | _ => println!("Don't be crazy"),
//! }
//!
//! // You can handle information about subcommands by requesting their matches by name
//! // (as below), requesting just the name used, or both at the same time
//! if let Some(matches) = matches.subcommand_matches("test") {
//! if matches.is_present("debug") {
//! println!("Printing debug info...");
//! } else {
//! println!("Printing normally...");
//! }
//! }
//!
//! // more program logic goes here...
//! }
//! ```
//!
2016-11-21 01:48:49 +00:00
//! The next example shows a far less verbose method, but sacrifices some of the advanced
//! configuration options (not shown in this small example). This method also takes a *very* minor
//! runtime penalty.
//!
2016-11-21 02:27:17 +00:00
//! ```no_run
//! // (Full example with detailed comments in examples/01a_quick_example.rs)
//! //
//! // This example demonstrates clap's "usage strings" method of creating arguments
//! // which is less verbose
//! extern crate clap;
//! use clap::{Arg, App, };
//!
//! fn main() {
//! let matches = App::new("myapp")
//! .version("1.0")
//! .author("Kevin K. <kbknapp@gmail.com>")
//! .about("Does awesome things")
//! .arg("-c, --config=[FILE] 'Sets a custom config file'")
//! .arg("<INPUT> 'Sets the input file to use'")
//! .arg("-v... 'Sets the level of verbosity'")
//! .subcommand(App::new("test")
//! .about("controls testing features")
//! .version("1.3")
//! .author("Someone E. <someone_else@other.com>")
//! .arg("-d, --debug 'Print debug information'"))
//! .get_matches();
//!
//! // Same as previous example...
//! }
//! ```
//!
2016-11-21 01:48:49 +00:00
//! This third method shows how you can use a YAML file to build your CLI and keep your Rust source
//! tidy or support multiple localized translations by having different YAML files for each
//! localization.
//!
//! First, create the `cli.yml` file to hold your CLI options, but it could be called anything we
//! like:
//!
2015-10-02 00:03:31 +00:00
//! ```yaml
//! name: myapp
2016-11-21 01:48:49 +00:00
//! version: "1.0"
//! author: Kevin K. <kbknapp@gmail.com>
//! about: Does awesome things
//! args:
//! - config:
//! short: c
//! long: config
//! value_name: FILE
//! help: Sets a custom config file
//! takes_value: true
//! - INPUT:
//! help: Sets the input file to use
//! required: true
//! index: 1
//! - verbose:
//! short: v
//! multiple: true
//! help: Sets the level of verbosity
//! subcommands:
//! - test:
//! about: controls testing features
2016-11-21 01:48:49 +00:00
//! version: "1.3"
//! author: Someone E. <someone_else@other.com>
//! args:
//! - debug:
//! short: d
//! help: print debug information
//! ```
//!
2016-11-21 01:48:49 +00:00
//! Since this feature requires additional dependencies that not everyone may want, it is *not*
//! compiled in by default and we need to enable a feature flag in Cargo.toml:
//!
2017-10-25 00:30:11 +00:00
//! Simply change your `clap = "~2.27.0"` to `clap = {version = "~2.27.0", features = ["yaml"]}`.
//!
//! At last we create our `main.rs` file just like we would have with the previous two examples:
//!
2016-11-21 02:27:17 +00:00
//! ```ignore
//! // (Full example with detailed comments in examples/17_yaml.rs)
//! //
//! // This example demonstrates clap's building from YAML style of creating arguments which is far
//! // more clean, but takes a very small performance hit compared to the other two methods.
//! #[macro_use]
//! extern crate clap;
//! use clap::App;
//!
//! fn main() {
//! // The YAML file is found relative to the current file, similar to how modules are found
//! let yaml = load_yaml!("cli.yml");
//! let matches = App::from_yaml(yaml).get_matches();
//!
//! // Same as previous examples...
//! }
//! ```
//!
2016-11-21 01:48:49 +00:00
//! Finally there is a macro version, which is like a hybrid approach offering the speed of the
//! builder pattern (the first example), but without all the verbosity.
//!
2016-11-21 02:27:17 +00:00
//! ```no_run
2016-11-21 01:48:49 +00:00
//! #[macro_use]
//! extern crate clap;
//!
2016-11-21 01:48:49 +00:00
//! fn main() {
//! let matches = clap_app!(myapp =>
//! (version: "1.0")
//! (author: "Kevin K. <kbknapp@gmail.com>")
//! (about: "Does awesome things")
//! (@arg CONFIG: -c --config +takes_value "Sets a custom config file")
//! (@arg INPUT: +required "Sets the input file to use")
//! (@arg debug: -d ... "Sets the level of debugging information")
//! (@subcommand test =>
//! (about: "controls testing features")
//! (version: "1.3")
//! (author: "Someone E. <someone_else@other.com>")
//! (@arg verbose: -v --verbose "Print test information verbosely")
//! )
//! ).get_matches();
//!
2016-11-21 01:48:49 +00:00
//! // Same as before...
//! }
//! ```
//!
2016-11-21 01:48:49 +00:00
//! If you were to compile any of the above programs and run them with the flag `--help` or `-h` (or
//! `help` subcommand, since we defined `test` as a subcommand) the following would be output
//!
2016-11-21 02:27:17 +00:00
//! ```text
//! $ myprog --help
//! My Super Program 1.0
//! Kevin K. <kbknapp@gmail.com>
//! Does awesome things
//!
//! USAGE:
//! MyApp [FLAGS] [OPTIONS] <INPUT> [SUBCOMMAND]
//!
//! FLAGS:
//! -h, --help Prints this message
//! -v Sets the level of verbosity
//! -V, --version Prints version information
//!
//! OPTIONS:
//! -c, --config <FILE> Sets a custom config file
//!
//! ARGS:
//! INPUT The input file to use
//!
//! SUBCOMMANDS:
//! help Prints this message
//! test Controls testing features
//! ```
//!
2016-11-21 01:48:49 +00:00
//! **NOTE:** You could also run `myapp test --help` to see similar output and options for the
//! `test` subcommand.
//!
//! ## Try it!
//!
//! ### Pre-Built Test
//!
//! To try out the pre-built example, use the following steps:
//!
//! * Clone the repository `$ git clone https://github.com/kbknapp/clap-rs && cd clap-rs/tests`
//! * Compile the example `$ cargo build --release`
//! * Run the help info `$ ./target/release/claptests --help`
//! * Play with the arguments!
//!
//! ### BYOB (Build Your Own Binary)
//!
2016-11-21 01:48:49 +00:00
//! To test out `clap`'s default auto-generated help/version follow these steps:
2017-02-20 22:13:06 +00:00
//!
2016-11-21 01:48:49 +00:00
//! * Create a new cargo project `$ cargo new fake --bin && cd fake`
//! * Add `clap` to your `Cargo.toml`
2016-11-21 02:27:17 +00:00
//!
2016-11-21 01:48:49 +00:00
//! ```toml
//! [dependencies]
//! clap = "2"
//! ```
//!
2016-11-21 01:48:49 +00:00
//! * Add the following to your `src/main.rs`
//!
2016-11-21 02:27:17 +00:00
//! ```no_run
//! extern crate clap;
//! use clap::App;
//!
//! fn main() {
//! App::new("fake").version("v1.0-beta").get_matches();
//! }
//! ```
//!
2016-11-21 01:48:49 +00:00
//! * Build your program `$ cargo build --release`
//! * Run with help or version `$ ./target/release/fake --help` or `$ ./target/release/fake
//! --version`
//!
//! ## Usage
//!
2016-11-21 01:48:49 +00:00
//! For full usage, add `clap` as a dependency in your `Cargo.toml` (it is **highly** recommended to
//! use the `~major.minor.patch` style versions in your `Cargo.toml`, for more information see
//! [Compatibility Policy](#compatibility-policy)) to use from crates.io:
//!
//! ```toml
//! [dependencies]
2017-10-25 00:30:11 +00:00
//! clap = "~2.27.0"
//! ```
//!
//! Or get the latest changes from the master branch at github:
//!
2015-10-02 00:03:31 +00:00
//! ```toml
//! [dependencies.clap]
//! git = "https://github.com/kbknapp/clap-rs.git"
//! ```
//!
//! Add `extern crate clap;` to your crate root.
//!
//! Define a list of valid arguments for your program (see the
//! [documentation](https://docs.rs/clap/) or [examples/] directory of this repo)
//!
//! Then run `cargo build` or `cargo update && cargo build` for your project.
//!
//! ### Optional Dependencies / Features
//!
//! #### Features enabled by default
//!
2017-06-08 18:42:10 +00:00
//! * `suggestions`: Turns on the `Did you mean '--myoption'?` feature for when users make typos. (builds dependency `strsim`)
//! * `color`: Turns on colored error messages. This feature only works on non-Windows OSs. (builds dependency `ansi-term` and `atty`)
//! * `wrap_help`: Wraps the help at the actual terminal width when
//! available, instead of 120 chracters. (builds dependency `textwrap`
//! with feature `term_size`)
//!
//! To disable these, add this to your `Cargo.toml`:
//!
2015-10-02 00:03:31 +00:00
//! ```toml
//! [dependencies.clap]
2017-10-25 00:30:11 +00:00
//! version = "~2.27.0"
//! default-features = false
//! ```
//!
//! You can also selectively enable only the features you'd like to include, by adding:
//!
2015-10-02 00:03:31 +00:00
//! ```toml
//! [dependencies.clap]
2017-10-25 00:30:11 +00:00
//! version = "~2.27.0"
//! default-features = false
//!
//! # Cherry-pick the features you'd like to use
//! features = [ "suggestions", "color" ]
//! ```
//!
//! #### Opt-in features
//!
2016-11-21 01:48:49 +00:00
//! * **"yaml"**: Enables building CLIs from YAML documents. (builds dependency `yaml-rust`)
//! * **"unstable"**: Enables unstable `clap` features that may change from release to release
//!
2016-11-21 01:48:49 +00:00
//! ### Dependencies Tree
//!
//! The following graphic depicts `clap`s dependency graph (generated using
2016-11-21 01:48:49 +00:00
//! [cargo-graph](https://github.com/kbknapp/cargo-graph)).
//!
2016-11-21 01:48:49 +00:00
//! * **Dashed** Line: Optional dependency
//! * **Red** Color: **NOT** included by default (must use cargo `features` to enable)
//! * **Blue** Color: Dev dependency, only used while developing.
//!
//! ![clap dependencies](https://raw.githubusercontent.com/kbknapp/clap-rs/master/clap_dep_graph.png)
//!
//! ### More Information
//!
2016-11-21 01:48:49 +00:00
//! You can find complete documentation on the [docs.rs](https://docs.rs/clap/) for this project.
//!
//! You can also find usage examples in the [examples/] directory of this repo.
//!
//! #### Video Tutorials
//!
//! There's also the video tutorial series [Argument Parsing with Rust v2][video tutorials].
//!
2016-11-21 01:48:49 +00:00
//! These videos slowly trickle out as I finish them and currently a work in progress.
//!
2016-11-21 01:48:49 +00:00
//! ## How to Contribute
//!
2016-11-21 01:48:49 +00:00
//! Contributions are always welcome! And there is a multitude of ways in which you can help
//! depending on what you like to do, or are good at. Anything from documentation, code cleanup,
//! issue completion, new features, you name it, even filing issues is contributing and greatly
//! appreciated!
//!
//! Another really great way to help is if you find an interesting, or helpful way in which to use
//! `clap`. You can either add it to the [examples/] directory, or file an issue and tell
2016-11-21 01:48:49 +00:00
//! me. I'm all about giving credit where credit is due :)
//!
//! Please read [CONTRIBUTING.md](https://raw.githubusercontent.com/kbknapp/clap-rs/master/.github/CONTRIBUTING.md) before you start contributing.
//!
//!
2016-11-21 01:48:49 +00:00
//! ### Testing Code
//!
2016-11-21 01:48:49 +00:00
//! To test with all features both enabled and disabled, you can run theese commands:
//!
2016-11-21 02:27:17 +00:00
//! ```text
//! $ cargo test --no-default-features
2016-11-21 01:48:49 +00:00
//! $ cargo test --features "yaml unstable"
//! ```
//!
2016-11-21 01:48:49 +00:00
//! Alternatively, if you have [`just`](https://github.com/casey/just) installed you can run the
2018-03-13 15:18:41 +00:00
//! prebuilt recipies. *Not* using `just` is perfectly fine as well, it simply bundles commands
2016-11-21 01:48:49 +00:00
//! automatically.
//!
2016-11-21 01:48:49 +00:00
//! For example, to test the code, as above simply run:
//!
2016-11-21 02:27:17 +00:00
//! ```text
2016-11-21 01:48:49 +00:00
//! $ just run-tests`
//! ```
//!
2016-11-21 01:48:49 +00:00
//! From here on, I will lis the appropriate `cargo` command as well as the `just` command.
//!
2016-11-21 01:48:49 +00:00
//! Sometimes it's helpful to only run a subset of the tests, which can be done via:
//!
2016-11-21 02:27:17 +00:00
//! ```text
2016-11-21 01:48:49 +00:00
//! $ cargo test --test <test_name>
//!
2016-11-21 01:48:49 +00:00
//! # Or
//!
2016-11-21 01:48:49 +00:00
//! $ just run-test <test_name>
//! ```
//!
2016-11-21 01:48:49 +00:00
//! ### Linting Code
//!
2016-11-21 01:48:49 +00:00
//! During the CI process `clap` runs against many different lints using
//! [`clippy`](https://github.com/Manishearth/rust-clippy). In order to check if these lints pass on
//! your own computer prior to submitting a PR you'll need a nightly compiler.
//!
2016-11-21 01:48:49 +00:00
//! In order to check the code for lints run either:
//!
2016-11-21 02:27:17 +00:00
//! ```text
2016-11-21 01:48:49 +00:00
//! $ rustup override add nightly
//! $ cargo build --features lints
//! $ rustup override remove
//!
2016-11-21 01:48:49 +00:00
//! # Or
//!
2016-11-21 01:48:49 +00:00
//! $ just lint
//! ```
//!
2016-11-21 01:48:49 +00:00
//! ### Debugging Code
//!
2016-11-21 01:48:49 +00:00
//! Another helpful technique is to see the `clap` debug output while developing features. In order
//! to see the debug output while running the full test suite or individual tests, run:
//!
2016-11-21 02:27:17 +00:00
//! ```text
2016-11-21 01:48:49 +00:00
//! $ cargo test --features debug
//!
2016-11-21 01:48:49 +00:00
//! # Or for individual tests
//! $ cargo test --test <test_name> --features debug
//!
2016-11-21 01:48:49 +00:00
//! # The corresponding just command for individual debugging tests is:
//! $ just debug <test_name>
//! ```
//!
2016-11-21 01:48:49 +00:00
//! ### Goals
//!
2016-11-21 01:48:49 +00:00
//! There are a few goals of `clap` that I'd like to maintain throughout contributions. If your
//! proposed changes break, or go against any of these goals we'll discuss the changes further
//! before merging (but will *not* be ignored, all contributes are welcome!). These are by no means
//! hard-and-fast rules, as I'm no expert and break them myself from time to time (even if by
//! mistake or ignorance).
//!
2016-11-21 01:48:49 +00:00
//! * Remain backwards compatible when possible
//! - If backwards compatibility *must* be broken, use deprecation warnings if at all possible before
//! removing legacy code - This does not apply for security concerns
//! * Parse arguments quickly
//! - Parsing of arguments shouldn't slow down usage of the main program - This is also true of
//! generating help and usage information (although *slightly* less stringent, as the program is about
//! to exit)
//! * Try to be cognizant of memory usage
//! - Once parsing is complete, the memory footprint of `clap` should be low since the main program
//! is the star of the show
//! * `panic!` on *developer* error, exit gracefully on *end-user* error
//!
2016-11-21 01:48:49 +00:00
//! ### Compatibility Policy
//!
2017-06-08 18:42:10 +00:00
//! Because `clap` takes `SemVer` and compatibility seriously, this is the official policy regarding
2016-11-21 01:48:49 +00:00
//! breaking changes and previous versions of Rust.
//!
//! `clap` will pin the minimum required version of Rust to the CI builds. Bumping the minimum
//! version of Rust is considered a minor breaking change, meaning *at a minimum* the minor version
//! of `clap` will be bumped.
//!
//! In order to keep from being suprised of breaking changes, it is **highly** recommended to use
//! the `~major.minor.patch` style in your `Cargo.toml`:
//!
//! ```toml
2017-10-25 00:30:11 +00:00
//! [dependencies] clap = "~2.27.0"
//! ```
//!
2016-11-21 01:48:49 +00:00
//! This will cause *only* the patch version to be updated upon a `cargo update` call, and therefore
//! cannot break due to new features, or bumped minimum versions of Rust.
//!
2016-11-21 01:48:49 +00:00
//! #### Minimum Version of Rust
//!
2016-11-21 01:48:49 +00:00
//! `clap` will officially support current stable Rust, minus two releases, but may work with prior
2017-10-25 00:30:11 +00:00
//! releases as well. For example, current stable Rust at the time of this writing is 1.21.0,
//! meaning `clap` is guaranteed to compile with 1.19.0 and beyond. At the 1.22.0 release, `clap`
//! will be guaranteed to compile with 1.20.0 and beyond, etc.
//!
2016-11-21 01:48:49 +00:00
//! Upon bumping the minimum version of Rust (assuming it's within the stable-2 range), it *must* be
//! clearly annotated in the `CHANGELOG.md`
//!
//! ## License
//!
//! `clap` is licensed under the MIT license. Please read the [LICENSE-MIT][license] file in
2016-11-21 01:48:49 +00:00
//! this repository for more information.
//!
//! [examples/]: https://github.com/kbknapp/clap-rs/tree/master/examples
//! [video tutorials]: https://www.youtube.com/playlist?list=PLza5oFLQGTl2Z5T8g1pRkIynR3E0_pc7U
//! [license]: https://raw.githubusercontent.com/kbknapp/clap-rs/master/LICENSE-MIT
2017-11-28 12:30:06 +00:00
#![crate_type = "lib"]
#![doc(html_root_url = "https://docs.rs/clap/3.0.0-beta.1")]
#![deny(
missing_docs,
missing_debug_implementations,
missing_copy_implementations,
trivial_casts,
unused_import_braces,
unused_allocation
)]
// @TODO @v3-beta: remove me!
#![allow(deprecated)]
#![cfg_attr(
not(any(feature = "lints", feature = "nightly")),
forbid(unstable_features)
)]
2017-10-24 03:03:40 +00:00
// Need to disable deny(warnings) while deprecations are active
// #![cfg_attr(feature = "lints", deny(warnings))]
2018-11-14 17:12:34 +00:00
#![cfg_attr(feature = "lints", feature(plugin))]
#![cfg_attr(feature = "lints", plugin(clippy))]
// #![cfg_attr(feature = "lints", allow(cyclomatic_complexity))]
// #![cfg_attr(feature = "lints", allow(doc_markdown))]
// #![cfg_attr(feature = "lints", allow(explicit_iter_loop))]
#[cfg(all(feature = "color", not(target_os = "windows")))]
extern crate ansi_term;
2017-11-28 12:30:06 +00:00
#[cfg(feature = "color")]
extern crate atty;
#[macro_use]
extern crate bitflags;
#[cfg(feature = "derive")]
#[cfg_attr(feature = "derive", allow(unused_imports))]
#[cfg_attr(feature = "derive", macro_use)]
extern crate clap_derive;
2018-06-12 14:22:18 +00:00
extern crate indexmap;
2017-11-28 12:30:06 +00:00
#[cfg(feature = "suggestions")]
extern crate strsim;
#[cfg(feature = "wrap_help")]
extern crate term_size;
feat: use textwrap crate for wrapping help texts The textwrap crate uses a simpler linear-time algorithm for wrapping the text. The current algorithm in wrap_help uses several O(n) calls to String::insert and String::remove, which makes it potentially quadratic in complexity. Comparing the 05_ripgrep benchmark at commits textwrap~2 and textwrap gives this result on my machine: name before ns/iter after ns/iter diff ns/iter diff % build_app_long 22,101 21,099 -1,002 -4.53% build_app_short 22,138 21,205 -933 -4.21% build_help_long 514,265 284,467 -229,798 -44.68% build_help_short 85,720 85,693 -27 -0.03% parse_clean 23,471 22,859 -612 -2.61% parse_complex 29,535 28,919 -616 -2.09% parse_lots 422,815 414,577 -8,238 -1.95% As part of this commit, the wrapping_newline_chars test was updated. The old algorithm had a subtle bug where it would break lines too early. That is, it wrapped the text like ARGS: <mode> x, max, maximum 20 characters, contains symbols. l, long Copy-friendly, 14 characters, contains symbols. m, med, medium Copy-friendly, 8 characters, contains symbols."; when it should really have wrapped it like ARGS: <mode> x, max, maximum 20 characters, contains symbols. l, long Copy-friendly, 14 characters, contains symbols. m, med, medium Copy-friendly, 8 characters, contains symbols."; Notice how the word "14" was incorrectly moved to the next line. There is clearly room for the word on the line with the "l, long" option since there is room for "contains" just above it. I'm not sure why this is, but the algorithm in textwrap handles this case correctly.
2017-01-28 11:42:09 +00:00
extern crate textwrap;
2017-11-28 12:30:06 +00:00
extern crate unicode_width;
#[cfg(feature = "vec_map")]
extern crate vec_map;
#[cfg(feature = "yaml")]
extern crate yaml_rust;
2015-02-28 03:19:48 +00:00
pub use build::{App, AppSettings, Arg, ArgGroup, ArgSettings, Propagation};
pub use output::fmt::Format;
pub use parse::errors::{Error, ErrorKind, Result};
pub use parse::{ArgMatches, OsValues, Values};
#[cfg(feature = "yaml")]
pub use yaml_rust::YamlLoader;
2015-02-25 13:37:25 +00:00
#[cfg(feature = "derive")]
#[cfg_attr(feature = "derive", doc(hidden))]
pub use clap_derive::*;
use std::result::Result as StdResult;
#[macro_use]
mod macros;
2018-07-26 15:15:47 +00:00
mod build;
2018-07-19 12:50:47 +00:00
mod mkeymap;
mod output;
mod parse;
mod util;
2018-11-14 17:12:34 +00:00
const INTERNAL_ERROR_MSG: &str = "Fatal internal error. Please consider filing a bug \
report at https://github.com/kbknapp/clap-rs/issues";
2018-11-14 17:12:34 +00:00
const INVALID_UTF8: &str = "unexpected invalid UTF-8 code point";
/// @TODO @release @docs
pub trait Clap: FromArgMatches + IntoApp + Sized {}
/// @TODO @release @docs
pub trait FromArgMatches: Sized {
/// @TODO @release @docs
fn from_argmatches<'a>(matches: &::parse::ArgMatches<'a>) -> Self;
/// @TODO @release @docs
fn try_from_argmatches<'a>(
matches: &::parse::ArgMatches<'a>,
) -> StdResult<Self, ::parse::errors::Error> {
Ok(<Self as FromArgMatches>::from_argmatches(matches))
}
}
/// @TODO @release @docs
pub trait IntoApp: Sized {
/// @TODO @release @docs
fn into_app<'a, 'b>() -> ::build::App<'a, 'b>;
}
/// @TODO @release @docs
pub trait ArgEnum {}