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
//! This crates provides a procedural macro for parsing command line arguments.
//!
//! It is intended for use in development tools, so it emphasizes fast compile
//! times and convenience at the expense of features.
//!
//! If you need something more fancy, consider using
//! [`clap`](https://docs.rs/clap/2.33.3/clap/) instead.
//!
//! ## Example
//!
//! ```
//! mod flags {
//! use std::path::PathBuf;
//!
//! xflags::xflags! {
//! src "./examples/basic.rs"
//!
//! cmd my-command
//! required path: PathBuf
//! {
//! optional -v, --verbose
//! }
//! }
//!
//! // generated start
//! // The following code is generated by `xflags` macro.
//! // Run `env UPDATE_XFLAGS=1 cargo build` to regenerate.
//! #[derive(Debug)]
//! pub struct MyCommand {
//! pub path: PathBuf,
//!
//! pub verbose: bool,
//! }
//!
//! impl MyCommand {
//! pub const HELP: &'static str = Self::HELP_;
//!
//! pub fn from_env() -> xflags::Result<Self> {
//! Self::from_env_()
//! }
//!
//! pub fn from_vec(args: Vec<std::ffi::OsString>) -> xflags::Result<Self> {
//! Self::from_vec_(args)
//! }
//! }
//! // generated end
//! }
//!
//! fn main() {
//! let flags = flags::MyCommand::from_env();
//! println!("{:#?}", flags);
//! }
//! ```
//!
//! To make the macro less opaque, `xflag` can generate `struct` describing the
//! CLI in-place. To disable this behavior, omit the `src` attribute.
//!
//! xflags correctly handles non-utf8 arguments.
//!
//! ## Syntax Reference
//!
//! The **cmd** keyword introduces a command that accepts positional arguments
//! and switches.
//!
//! ```
//! xflags::xflags! {
//! cmd command-name { }
//! }
//! ```
//!
//! Switches are specified inside the curly braces. Long names (`--switch`) are
//! mandatory, short names (`-s`) are optional. Each switch can be **optional**,
//! **required**, or **repeated**. Dashes are allowed in switch names.
//!
//! ```
//! xflags::xflags! {
//! cmd switches {
//! optional -h, --help
//! repeated --verbose
//! required --pass-me
//! }
//! }
//! ```
//!
//! Switches can also take values. If the value type is `OsString` or `PathBuf`,
//! it is created directly from the underlying argument. Otherwise, `FromStr` is
//! used for parsing
//!
//! ```
//! use std::{path::PathBuf, ffi::OsString};
//!
//! xflags::xflags! {
//! cmd switches-with-values {
//! optional --config path: PathBuf
//! repeated --data val: OsString
//! optional -j, --jobs n: u32
//! }
//! }
//! ```
//!
//! Positional arguments are specified before the opening curly brace:
//!
//! ```
//! use std::{path::PathBuf, ffi::OsString};
//!
//! xflags::xflags! {
//! cmd positional-arguments
//! required program: PathBuf
//! repeated args: OsString
//! { }
//! }
//! ```
//!
//! Nesting **cmd** is allowed:
//!
//! ```ignore
//! xflags::xflags! {
//! src "./examples/subcommands.rs"
//! cmd app {
//! repeated -v, --verbose
//! cmd foo { optional -s, --switch }
//! cmd bar {}
//! }
//! }
//!
//! // generated start
//! // The following code is generated by `xflags` macro.
//! // Run `env UPDATE_XFLAGS=1 cargo build` to regenerate.
//! #[derive(Debug)]
//! pub struct App {
//! pub verbose: u32,
//! pub subcommand: AppCmd,
//! }
//!
//! #[derive(Debug)]
//! pub enum AppCmd {
//! Foo(Foo),
//! Bar(Bar),
//! }
//!
//! #[derive(Debug)]
//! pub struct Foo {
//! pub switch: bool,
//! }
//!
//! #[derive(Debug)]
//! pub struct Bar {
//! }
//!
//! impl App {
//! pub const HELP: &'static str = Self::HELP_;
//!
//! pub fn from_env() -> xflags::Result<Self> {
//! Self::from_env_()
//! }
//!
//! pub fn from_vec(args: Vec<std::ffi::OsString>) -> xflags::Result<Self> {
//! Self::from_vec_(args)
//! }
//! }
//! // generated end
//! ```
//!
//! To make subcommand name optional use the **default** keyword to mark a
//! subcommand to select if no subcommand name is passed. The name of the
//! default subcommand affects only the name of the generated Rust struct, it
//! can't be specified explicitly on the command line.
//!
//! ```
//! xflags::xflags! {
//! cmd app {
//! repeated -v, --verbose
//! default cmd foo { optional -s, --switch }
//! cmd bar {}
//! }
//! }
//! ```
//!
//! Commands, arguments, and switches can documented. Doc comments become a part
//! of generated help:
//!
//! ```
//! mod flags {
//! use std::path::PathBuf;
//!
//! xflags::xflags! {
//! /// Run basic system diagnostics.
//! cmd healthck
//! /// Optional configuration file.
//! optional config: PathBuf
//! {
//! /// Verbosity level, can be repeated multiple times.
//! repeated -v, --verbose
//! /// Print the help message.
//! optional -h, --help
//! }
//! }
//! }
//!
//! fn main() {
//! match flags::Healthck::from_env() {
//! Ok(flags) => {
//! if flags.help {
//! println!("{}", flags::Healthck::HELP);
//! return;
//! }
//! run_checks(flags.config, flags.verbose);
//! }
//! Err(err) => {
//! eprintln!("{}", err);
//! }
//! }
//! }
//!
//! # fn run_checks(_config: Option<std::path::PathBuf>, _verbosity: u32) {}
//! ```
//!
//! The **src** keyword controlls how the code generation works. If it is
//! absent, `xflags` acts as a typical procedure macro, which generates a bunch
//! of structs and impls.
//!
//! If the **src** keyword is present, it should specify the path to the file
//! with `xflags!` invocation. The path should be relative to the directory with
//! Cargo.toml. The macro then will avoid generating the structs. Instead, if
//! the `UPDATE_XFLAGS` environmental variable is set, the macro will write them
//! directly to the specified file.
//!
//! By convention, `xflag!` macro should be invoked from the `flags` submodule.
//! The `flags::` preffix should be used to refer to command names. Additional
//! validation logic can go to the `flags` module:
//!
//! ```
//! mod flags {
//! xflags::xflags! {
//! cmd my-command {
//! repeated -v, --verbose
//! optional -q, --quiet
//! }
//! }
//!
//! impl MyCommand {
//! fn validate(&self) -> xflags::Result<()> {
//! if self.quiet && self.verbose > 0 {
//! return Err(xflags::Error::new(
//! "`-q` and `-v` can't be specified at the same time"
//! ));
//! }
//! Ok(())
//! }
//! }
//! }
//! ```
use std::fmt;
/// Generates a parser for command line arguments from a DSL.
///
/// See the module-level for detailed syntax specification.
pub use xflags_macros::xflags;
pub type Result<T, E = Error> = std::result::Result<T, E>;
/// This type represents an error that can occur during command line argument
/// parsing.
#[derive(Debug)]
pub struct Error {
msg: String,
}
impl fmt::Display for Error {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
fmt::Display::fmt(&self.msg, f)
}
}
impl std::error::Error for Error {}
impl Error {
/// Creates a new `Error` from a given message.
///
/// Use this to report custom validation errors.
pub fn new(message: impl Into<String>) -> Error {
Error { msg: message.into() }
}
}
/// Private impl details for macros.
#[doc(hidden)]
pub mod rt;