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
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at https://mozilla.org/MPL/2.0/.
use std::{path::PathBuf, str::FromStr};
use clap::{ArgAction, ArgGroup, Parser};
use crate::commands::Command;
#[derive(Parser, Clone, PartialEq, Eq, Debug)]
pub struct App {
#[arg(hide = true, value_parser = clap::builder::PossibleValuesParser::new(["modules"]))]
pub dummy: Option<String>,
#[command(subcommand)]
pub command: Command,
}
impl App {
pub fn sanitized_command(self) -> Command {
let mut command = self.command;
command.sanitize();
command
}
}
pub mod graph {
use super::*;
#[derive(Parser, Clone, PartialEq, Eq, Debug)]
#[group(id = "GraphOptions")]
pub struct Options {
/// Focus the graph on a particular path or use-tree's environment,
/// e.g. "foo:bar::{self, baz, blee::*}".
#[arg(long = "focus-on")]
pub focus_on: Option<String>,
/// The maximum depth of the generated graph
/// relative to the crate's root node, or nodes selected by '--focus-on'.
#[arg(long = "max-depth")]
pub max_depth: Option<usize>,
/// Include types (e.g. structs, unions, enums).
#[arg(long = "types")]
pub types: bool,
/// Exclude types (e.g. structs, unions, enums). [default]
#[arg(long = "no-types", action = ArgAction::SetFalse, overrides_with = "types")]
pub no_types: (),
/// Include traits (e.g. trait, unsafe trait).
#[arg(long = "traits")]
pub traits: bool,
/// Exclude traits (e.g. trait, unsafe trait). [default]
#[arg(long = "no-traits", action = ArgAction::SetFalse, overrides_with = "traits")]
pub no_traits: (),
/// Include functions (e.g. fns, async fns, const fns).
#[arg(long = "fns")]
pub fns: bool,
/// Exclude functions (e.g. fns, async fns, const fns). [default]
#[arg(long = "no-fns", action = ArgAction::SetFalse, overrides_with = "fns")]
pub no_fns: (),
/// Include tests (e.g. `#[test] fn …`).
#[arg(long = "tests")]
pub tests: bool,
/// Exclude tests (e.g. `#[test] fn …`). [default]
#[arg(long = "no-tests", action = ArgAction::SetFalse, overrides_with = "tests")]
pub no_tests: (),
/// Include orphaned modules (i.e. unused files in /src).
#[arg(long = "orphans")]
pub orphans: bool,
/// Exclude orphaned modules (i.e. unused files in /src). [default]
#[arg(long = "no-orphans", action = ArgAction::SetFalse, overrides_with = "orphans")]
pub no_orphans: (),
}
}
pub mod generate {
use super::*;
pub mod graph {
use super::*;
#[derive(Clone, PartialEq, Eq, Debug)]
pub enum LayoutAlgorithm {
None,
Dot,
Neato,
Twopi,
Circo,
Fdp,
Sfdp,
}
impl FromStr for LayoutAlgorithm {
type Err = &'static str;
fn from_str(s: &str) -> Result<Self, Self::Err> {
match s {
"none" => Ok(Self::None),
"dot" => Ok(Self::Dot),
"neato" => Ok(Self::Neato),
"twopi" => Ok(Self::Twopi),
"circo" => Ok(Self::Circo),
"fdp" => Ok(Self::Fdp),
"sfdp" => Ok(Self::Sfdp),
_ => Err("Unrecognized layout"),
}
}
}
impl ToString for LayoutAlgorithm {
fn to_string(&self) -> String {
match self {
Self::None => "none".to_owned(),
Self::Dot => "dot".to_owned(),
Self::Neato => "neato".to_owned(),
Self::Twopi => "twopi".to_owned(),
Self::Circo => "circo".to_owned(),
Self::Fdp => "fdp".to_owned(),
Self::Sfdp => "sfdp".to_owned(),
}
}
}
#[derive(Parser, Clone, PartialEq, Eq, Debug)]
#[group(id = "GenerateGraphOptions")]
pub struct Options {
#[command(flatten)]
pub general: crate::options::general::Options,
#[command(flatten)]
pub project: crate::options::project::Options,
#[command(flatten)]
pub graph: crate::options::graph::Options,
/// Require graph to be acyclic
#[arg(long = "acyclic", action = ArgAction::SetTrue, conflicts_with = "focus_on")]
pub acyclic: bool,
/// The graph layout algorithm to use
/// (e.g. none, dot, neato, twopi, circo, fdp, sfdp).
#[arg(long = "layout", default_value = "neato")]
pub layout: crate::options::generate::graph::LayoutAlgorithm,
// The `modules` and `no_modules` args might look like they have their
// documentation comments and clap-args mixed up, but they have to be
// that way in order to work-around a limitation of clap:
// https://jwodder.github.io/kbits/posts/clap-bool-negate/
// https://github.com/clap-rs/clap/issues/815
/// Exclude modules (e.g. `mod foo`, `mod foo {}`).
#[clap(long = "no-modules", action = ArgAction::SetFalse)]
pub modules: bool,
// The `modules` and `no_modules` args might look like they have their
// documentation comments and clap-args mixed up, but they have to be
// that way in order to work-around a limitation of clap:
// https://jwodder.github.io/kbits/posts/clap-bool-negate/
// https://github.com/clap-rs/clap/issues/815
/// Include modules (e.g. `mod foo`, `mod foo {}`). [default]
#[clap(long = "modules", action = ArgAction::SetTrue, overrides_with = "modules")]
pub no_modules: (),
/// Include used modules and types
#[arg(long = "uses")]
pub uses: bool,
/// Exclude used modules and types [default]
#[arg(long = "no-uses", action = ArgAction::SetFalse, overrides_with = "uses")]
pub no_uses: (),
/// Include used modules and types from extern crates
#[arg(long = "externs")]
pub externs: bool,
/// Exclude used modules and types from extern crates [default]
#[arg(long = "no-externs", action = ArgAction::SetFalse, overrides_with = "externs")]
pub no_externs: (),
}
}
pub mod tree {
use super::*;
#[derive(Parser, Clone, PartialEq, Eq, Debug)]
#[group(id = "GenerateTreeOptions")]
pub struct Options {
#[command(flatten)]
pub general: crate::options::general::Options,
#[command(flatten)]
pub project: crate::options::project::Options,
#[command(flatten)]
pub graph: crate::options::graph::Options,
}
}
}
pub mod project {
use super::*;
#[derive(Parser, Clone, PartialEq, Eq, Debug)]
#[group(id = "ProjectOptions")]
#[command(group = ArgGroup::new("target-group"))]
pub struct Options {
/// Process only this package's library.
#[arg(long = "lib", group = "target-group")]
pub lib: bool,
/// Process only the specified binary.
#[arg(long = "bin", group = "target-group")]
pub bin: Option<String>,
/// Package to process (see `cargo help pkgid`).
#[arg(short = 'p', long = "package")]
pub package: Option<String>,
/// Do not activate the `default` feature.
#[arg(long = "no-default-features")]
pub no_default_features: bool,
/// Activate all available features.
#[arg(long = "all-features")]
pub all_features: bool,
/// List of features to activate.
/// This will be ignored if `--cargo-all-features` is provided.
#[arg(long = "features")]
pub features: Vec<String>,
/// Analyze for target triple.
#[arg(long = "target")]
pub target: Option<String>,
/// Analyze with `#[cfg(test)]` enabled.
#[arg(long = "cfg-test")]
pub cfg_test: bool,
/// Analyze with `#[cfg(test)]` disabled. [default]
#[arg(long = "no-cfg-test", action = ArgAction::SetFalse, overrides_with = "cfg_test")]
pub no_cfg_test: (),
/// Include sysroot crates (`std`, `core` & friends) in analysis.
#[arg(long = "sysroot")]
pub sysroot: bool,
/// Exclude sysroot crates (`std`, `core` & friends) in analysis. [default]
#[arg(long = "no-sysroot", action = ArgAction::SetFalse, overrides_with = "sysroot")]
pub no_sysroot: (),
/// Path to Cargo.toml.
#[arg(long = "manifest-path", default_value = ".")]
pub manifest_path: PathBuf,
}
}
pub mod general {
use super::*;
#[derive(Parser, Clone, PartialEq, Eq, Debug)]
#[group(id = "GeneralOptions")]
pub struct Options {
/// Use verbose output.
#[arg(long = "verbose")]
pub verbose: bool,
}
}