( )⚙ D12001 rust: upgrade to Clap 3

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D12001

rust: upgrade to Clap 3
Needs RevisionPublic

Authored by martinvonz on Jan 14 2022, 5:21 PM.

Details

Reviewers
Alphare
Group Reviewers
hg-reviewers
Summary

Clap 3 was released about a week ago. Let's stay up to date.

Some changes worth mentioning:

  • AppSettings::VersionlessSubcommands is on by default and deleted
  • AllowInvalidUtf8 moved from AppSettings to ArgSettings. I set it only on the global args (-R, --config, --cwd). The other commands don't actually support invalid UTF-8, despite the setting being on at the top level. I'll leave it to someone else to switch to value[s]_of_os() and enable AllowInvalidUtf8 on remaining arguments (where appropriate).
  • Arg::short() now takes a single character (used to take a string). That makes the leading dashes we have on strings passed to Arg::long() stand out (to me at least). I'll leave it to someone else to drop them if they care.

Diff Detail

Repository
rHG Mercurial
Branch
default
Lint
No Linters Available
Unit
No Unit Test Coverage

Event Timeline

martinvonz created this revision.Jan 14 2022, 5:21 PM
Alphare requested changes to this revision.Jan 17 2022, 5:04 AM
Alphare added a subscriber: Alphare.

Unfortunately we can't move forward with clap version 3 since it requires a version of Rust that is too recent for our policy. https://github.com/clap-rs/clap/blob/master/CHANGELOG.md#minimum-required-rust

I was looking into the only change that seems like it might cause an issue (the invalid utf8 stuff), and this patch just wouldn't compile under 1.48.0. We're going to have to wait until Debian Bookworm releases.

This revision now requires changes to proceed.Jan 17 2022, 5:04 AM

Revision Contents
Changeset List

Diff 31657

rust/Cargo.lock

"num-integer", "num-integer",
"num-traits", "num-traits",
"time", "time",
"winapi", "winapi",
] ]
[[package]] [[package]]
name = "clap" name = "clap"
version = "2.33.3" version = "3.0.7"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "37e58ac78573c40708d45522f0d80fa2f01cc4f9b4e2bf749807255454312002" checksum = "12e8611f9ae4e068fa3e56931fded356ff745e70987ff76924a6e0ab1c8ef2e3"
dependencies = [ dependencies = [
"ansi_term",
"atty", "atty",
"bitflags", "bitflags",
"indexmap",
"os_str_bytes",
"strsim", "strsim",
"termcolor",
"textwrap", "textwrap",
"unicode-width",
"vec_map",
] ]
[[package]] [[package]]
name = "const_fn" name = "const_fn"
version = "0.4.4" version = "0.4.4"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "cd51eab21ab4fd6a3bf889e2d0958c0a6e3a61ad04260325e919e652a2a62826" checksum = "cd51eab21ab4fd6a3bf889e2d0958c0a6e3a61ad04260325e919e652a2a62826"
[[package]] [[package]]
name = "glob" name = "glob"
version = "0.3.0" version = "0.3.0"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "9b919933a397b79c37e33b77bb2aa3dc8eb6e165ad809e58ff75bc7db2e34574" checksum = "9b919933a397b79c37e33b77bb2aa3dc8eb6e165ad809e58ff75bc7db2e34574"
[[package]] [[package]]
name = "hashbrown"
version = "0.11.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "ab5ef0d4909ef3724cc8cce6ccc8572c5c817592e9285f5464f8e86f8bd3726e"
[[package]]
name = "hermit-abi" name = "hermit-abi"
version = "0.1.17" version = "0.1.17"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "5aca5565f760fb5b220e499d72710ed156fdb74e631659e99377d9ebfbd13ae8" checksum = "5aca5565f760fb5b220e499d72710ed156fdb74e631659e99377d9ebfbd13ae8"
dependencies = [ dependencies = [
"libc", "libc",
] ]
"rand_core 0.5.1", "rand_core 0.5.1",
"rand_xoshiro", "rand_xoshiro",
"sized-chunks", "sized-chunks",
"typenum", "typenum",
"version_check", "version_check",
] ]
[[package]] [[package]]
name = "indexmap"
version = "1.8.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "282a6247722caba404c065016bbfa522806e51714c34f5dfc3e4a3a46fcb4223"
dependencies = [
"autocfg",
"hashbrown",
]
[[package]]
name = "itertools" name = "itertools"
version = "0.9.0" version = "0.9.0"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "284f18f85651fe11e8a991b2adb42cb078325c996ed026d994719efcfca1d54b" checksum = "284f18f85651fe11e8a991b2adb42cb078325c996ed026d994719efcfca1d54b"
dependencies = [ dependencies = [
"either", "either",
] ]
[[package]] [[package]]
name = "maybe-uninit" name = "maybe-uninit"
version = "2.0.0" version = "2.0.0"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "60302e4db3a61da70c0cb7991976248362f30319e88850c487b9b95bbf059e00" checksum = "60302e4db3a61da70c0cb7991976248362f30319e88850c487b9b95bbf059e00"
[[package]] [[package]]
name = "memchr" name = "memchr"
version = "2.3.4" version = "2.4.1"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "0ee1c47aaa256ecabcaea351eae4a9b01ef39ed810004e298d2511ed284b1525" checksum = "308cc39be01b73d0d18f82a0e7b2a3df85245f84af96fdddc5d202d27e47b86a"
[[package]] [[package]]
name = "memmap2" name = "memmap2"
version = "0.4.0" version = "0.4.0"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "de5d3112c080d58ce560081baeaab7e1e864ca21795ddbf533d5b1842bb1ecf8" checksum = "de5d3112c080d58ce560081baeaab7e1e864ca21795ddbf533d5b1842bb1ecf8"
dependencies = [ dependencies = [
"libc", "libc",
[[package]] [[package]]
name = "opaque-debug" name = "opaque-debug"
version = "0.3.0" version = "0.3.0"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "624a8340c38c1b80fd549087862da4ba43e08858af025b236e509b6649fc13d5" checksum = "624a8340c38c1b80fd549087862da4ba43e08858af025b236e509b6649fc13d5"
[[package]] [[package]]
name = "os_str_bytes"
version = "6.0.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "8e22443d1643a904602595ba1cd8f7d896afe56d26712531c5ff73a15b2fbf64"
dependencies = [
"memchr",
]
[[package]]
name = "output_vt100" name = "output_vt100"
version = "0.1.2" version = "0.1.2"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "53cdc5b785b7a58c5aad8216b3dfa114df64b0b06ae6e1501cef91df2fbdf8f9" checksum = "53cdc5b785b7a58c5aad8216b3dfa114df64b0b06ae6e1501cef91df2fbdf8f9"
dependencies = [ dependencies = [
"winapi", "winapi",
] ]
[[package]] [[package]]
name = "static_assertions" name = "static_assertions"
version = "1.1.0" version = "1.1.0"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "a2eb9349b6444b326872e140eb1cf5e7c522154d69e7a0ffb0fb81c06b37543f" checksum = "a2eb9349b6444b326872e140eb1cf5e7c522154d69e7a0ffb0fb81c06b37543f"
[[package]] [[package]]
name = "strsim" name = "strsim"
version = "0.8.0" version = "0.10.0"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "8ea5119cdb4c55b55d432abb513a0429384878c15dde60cc77b1c99de1a95a6a" checksum = "73473c0e59e6d5812c5dfe2a064a6444949f089e20eec9a2e5506596494e4623"
[[package]] [[package]]
name = "syn" name = "syn"
version = "1.0.54" version = "1.0.54"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "9a2af957a63d6bd42255c359c93d9bfdb97076bd3b820897ce55ffbfbf107f44" checksum = "9a2af957a63d6bd42255c359c93d9bfdb97076bd3b820897ce55ffbfbf107f44"
dependencies = [ dependencies = [
"proc-macro2", "proc-macro2",
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "2dfed899f0eb03f32ee8c6a0aabdb8a7949659e3466561fc0adf54e26d88c5f4" checksum = "2dfed899f0eb03f32ee8c6a0aabdb8a7949659e3466561fc0adf54e26d88c5f4"
dependencies = [ dependencies = [
"winapi-util", "winapi-util",
] ]
[[package]] [[package]]
name = "textwrap" name = "textwrap"
version = "0.11.0" version = "0.14.2"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "d326610f408c7a4eb6f51c37c330e496b08506c9457c9d34287ecc38809fb060" checksum = "0066c8d12af8b5acd21e00547c3797fde4e8677254a7ee429176ccebbe93dd80"
dependencies = [
"unicode-width",
]
[[package]] [[package]]
name = "thread_local" name = "thread_local"
version = "1.0.1" version = "1.0.1"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "d40c6d1b69745a6ec6fb1ca717914848da4b44ae29d9b3080cbee91d72a69b14" checksum = "d40c6d1b69745a6ec6fb1ca717914848da4b44ae29d9b3080cbee91d72a69b14"
dependencies = [ dependencies = [
"lazy_static", "lazy_static",
[[package]] [[package]]
name = "typenum" name = "typenum"
version = "1.12.0" version = "1.12.0"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "373c8a200f9e67a0c95e62a4f52fbf80c23b4381c05a17845531982fa99e6b33" checksum = "373c8a200f9e67a0c95e62a4f52fbf80c23b4381c05a17845531982fa99e6b33"
[[package]] [[package]]
name = "unicode-width"
version = "0.1.8"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "9337591893a19b88d8d87f2cec1e73fad5cdfd10e5a6f349f498ad6ea2ffb1e3"
[[package]]
name = "unicode-xid" name = "unicode-xid"
version = "0.2.1" version = "0.2.1"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "f7fe0bb3479651439c9112f72b6c505038574c9fbb575ed1bf3b797fa39dd564" checksum = "f7fe0bb3479651439c9112f72b6c505038574c9fbb575ed1bf3b797fa39dd564"
[[package]] [[package]]
name = "users" name = "users"
version = "0.11.0" version = "0.11.0"
checksum = "4cb68c231e2575f7503a7c19213875f9d4ec2e84e963a56ce3de4b6bee351ef7" checksum = "4cb68c231e2575f7503a7c19213875f9d4ec2e84e963a56ce3de4b6bee351ef7"
dependencies = [ dependencies = [
"hex", "hex",
"rand 0.7.3", "rand 0.7.3",
"sha-1", "sha-1",
] ]
[[package]] [[package]]
name = "vec_map"
version = "0.8.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "f1bddf1187be692e79c5ffeab891132dfb0f236ed36a43c7ed39f1165ee20191"
[[package]]
name = "version_check" name = "version_check"
version = "0.9.2" version = "0.9.2"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "b5a972e5669d67ba988ce3dc826706fb0a8b01471c088cb0b6110b805cc36aed" checksum = "b5a972e5669d67ba988ce3dc826706fb0a8b01471c088cb0b6110b805cc36aed"
[[package]] [[package]]
name = "wasi" name = "wasi"
version = "0.9.0+wasi-snapshot-preview1" version = "0.9.0+wasi-snapshot-preview1"

rust/hg-core/Cargo.toml

# We don't use the `miniz-oxide` backend to not change rhg benchmarks and until # We don't use the `miniz-oxide` backend to not change rhg benchmarks and until
# we have a clearer view of which backend is the fastest. # we have a clearer view of which backend is the fastest.
[dependencies.flate2] [dependencies.flate2]
version = "1.0.16" version = "1.0.16"
features = ["zlib"] features = ["zlib"]
default-features = false default-features = false
[dev-dependencies] [dev-dependencies]
clap = "*" clap = "3.0.7"
pretty_assertions = "0.6.1" pretty_assertions = "0.6.1"

rust/hg-core/examples/nodemap/main.rs

nodes.last().unwrap(), nodes.last().unwrap(),
last last
); );
} }
fn main() { fn main() {
let matches = App::new("Nodemap pure Rust example") let matches = App::new("Nodemap pure Rust example")
.arg( .arg(
Arg::with_name("REPOSITORY") Arg::new("REPOSITORY")
.help("Path to the repository, always necessary for its index") .help("Path to the repository, always necessary for its index")
.required(true), .required(true),
) )
.arg( .arg(
Arg::with_name("NODEMAP_FILE") Arg::new("NODEMAP_FILE")
.help("Path to the nodemap file, independent of REPOSITORY") .help("Path to the nodemap file, independent of REPOSITORY")
.required(true), .required(true),
) )
.subcommand( .subcommand(
SubCommand::with_name("create") App::new("create")
.about("Create NODEMAP_FILE by scanning repository index"), .about("Create NODEMAP_FILE by scanning repository index"),
) )
.subcommand( .subcommand(
SubCommand::with_name("query") App::new("query")
.about("Query NODEMAP_FILE for PREFIX") .about("Query NODEMAP_FILE for PREFIX")
.arg(Arg::with_name("PREFIX").required(true)), .arg(Arg::new("PREFIX").required(true)),
) )
.subcommand( .subcommand(
SubCommand::with_name("bench") App::new("bench")
.about( .about(
"Perform #QUERIES random successful queries on NODEMAP_FILE") "Perform #QUERIES random successful queries on NODEMAP_FILE")
.arg(Arg::with_name("QUERIES").required(true)), .arg(Arg::new("QUERIES").required(true)),
) )
.get_matches(); .get_matches();
let repo = matches.value_of("REPOSITORY").unwrap(); let repo = matches.value_of("REPOSITORY").unwrap();
let nm_path = matches.value_of("NODEMAP_FILE").unwrap(); let nm_path = matches.value_of("NODEMAP_FILE").unwrap();
let index = mmap_index(&Path::new(repo)); let index = mmap_index(&Path::new(repo));

rust/rhg/Cargo.toml

[package] [package]
name = "rhg" name = "rhg"
version = "0.1.0" version = "0.1.0"
authors = [ authors = [
"Antoine Cezar <antoine.cezar@octobus.net>", "Antoine Cezar <antoine.cezar@octobus.net>",
"Raphaël Gomès <raphael.gomes@octobus.net>", "Raphaël Gomès <raphael.gomes@octobus.net>",
] ]
edition = "2018" edition = "2018"
[dependencies] [dependencies]
hg-core = { path = "../hg-core"} hg-core = { path = "../hg-core"}
chrono = "0.4.19" chrono = "0.4.19"
clap = "2.33.1" clap = "3.0.7"
derive_more = "0.99" derive_more = "0.99"
home = "0.5.3" home = "0.5.3"
lazy_static = "1.4.0" lazy_static = "1.4.0"
log = "0.4.11" log = "0.4.11"
micro-timer = "0.3.1" micro-timer = "0.3.1"
regex = "1.3.9" regex = "1.3.9"
env_logger = "0.7.1" env_logger = "0.7.1"
format-bytes = "0.3.0" format-bytes = "0.3.0"
users = "0.11.0" users = "0.11.0"

rust/rhg/src/commands/cat.rs

use crate::error::CommandError; use crate::error::CommandError;
use clap::Arg; use clap::Arg;
use format_bytes::format_bytes; use format_bytes::format_bytes;
use hg::operations::cat; use hg::operations::cat;
use hg::utils::hg_path::HgPathBuf; use hg::utils::hg_path::HgPathBuf;
use micro_timer::timed; use micro_timer::timed;
use std::convert::TryFrom; use std::convert::TryFrom;
pub const HELP_TEXT: &str = " pub const HELP_TEXT: &str = "
Output the current or given revision of files Output the current or given revision of files
"; ";
pub fn args() -> clap::App<'static, 'static> { pub fn args() -> clap::App<'static> {
clap::SubCommand::with_name("cat") clap::App::new("cat")
.arg( .arg(
Arg::with_name("rev") Arg::new("rev")
.help("search the repository as it is in REV") .help("search the repository as it is in REV")
.short("-r") .short('r')
.long("--rev") .long("--rev")
.value_name("REV") .value_name("REV")
.takes_value(true), .takes_value(true),
) )
.arg( .arg(
clap::Arg::with_name("files") clap::Arg::new("files")
.required(true) .required(true)
.multiple(true) .multiple_occurrences(true)
.empty_values(false) .forbid_empty_values(true)
.value_name("FILE") .value_name("FILE")
.help("Files to output"), .help("Files to output"),
) )
.about(HELP_TEXT) .about(HELP_TEXT)
} }
#[timed] #[timed]
pub fn run(invocation: &crate::CliInvocation) -> Result<(), CommandError> { pub fn run(invocation: &crate::CliInvocation) -> Result<(), CommandError> {

rust/rhg/src/commands/config.rs

use crate::error::CommandError; use crate::error::CommandError;
use clap::Arg; use clap::Arg;
use format_bytes::format_bytes; use format_bytes::format_bytes;
use hg::errors::HgError; use hg::errors::HgError;
use hg::utils::SliceExt; use hg::utils::SliceExt;
pub const HELP_TEXT: &str = " pub const HELP_TEXT: &str = "
With one argument of the form section.name, print just the value of that config item. With one argument of the form section.name, print just the value of that config item.
"; ";
pub fn args() -> clap::App<'static, 'static> { pub fn args() -> clap::App<'static> {
clap::SubCommand::with_name("config") clap::App::new("config")
.arg( .arg(
Arg::with_name("name") Arg::new("name")
.help("the section.name to print") .help("the section.name to print")
.value_name("NAME") .value_name("NAME")
.required(true) .required(true)
.takes_value(true), .takes_value(true),
) )
.about(HELP_TEXT) .about(HELP_TEXT)
} }

rust/rhg/src/commands/debugdata.rs

use crate::error::CommandError; use crate::error::CommandError;
use clap::Arg; use clap::Arg;
use clap::ArgGroup; use clap::ArgGroup;
use hg::operations::{debug_data, DebugDataKind}; use hg::operations::{debug_data, DebugDataKind};
use micro_timer::timed; use micro_timer::timed;
pub const HELP_TEXT: &str = " pub const HELP_TEXT: &str = "
Dump the contents of a data file revision Dump the contents of a data file revision
"; ";
pub fn args() -> clap::App<'static, 'static> { pub fn args() -> clap::App<'static> {
clap::SubCommand::with_name("debugdata") clap::App::new("debugdata")
.arg( .arg(
Arg::with_name("changelog") Arg::new("changelog")
.help("open changelog") .help("open changelog")
.short("-c") .short('c')
.long("--changelog"), .long("--changelog"),
) )
.arg( .arg(
Arg::with_name("manifest") Arg::new("manifest")
.help("open manifest") .help("open manifest")
.short("-m") .short('m')
.long("--manifest"), .long("--manifest"),
) )
.group( .group(
ArgGroup::with_name("") ArgGroup::new("")
.args(&["changelog", "manifest"]) .args(&["changelog", "manifest"])
.required(true), .required(true),
) )
.arg( .arg(
Arg::with_name("rev") Arg::new("rev")
.help("revision") .help("revision")
.required(true) .required(true)
.value_name("REV"), .value_name("REV"),
) )
.about(HELP_TEXT) .about(HELP_TEXT)
} }
#[timed] #[timed]

rust/rhg/src/commands/debugignorerhg.rs

use crate::error::CommandError; use crate::error::CommandError;
use clap::SubCommand;
use hg; use hg;
use hg::matchers::get_ignore_matcher; use hg::matchers::get_ignore_matcher;
use hg::StatusError; use hg::StatusError;
use log::warn; use log::warn;
pub const HELP_TEXT: &str = " pub const HELP_TEXT: &str = "
Show effective hgignore patterns used by rhg. Show effective hgignore patterns used by rhg.
This is a pure Rust version of `hg debugignore`. This is a pure Rust version of `hg debugignore`.
Some options might be missing, check the list below. Some options might be missing, check the list below.
"; ";
pub fn args() -> clap::App<'static, 'static> { pub fn args() -> clap::App<'static> {
SubCommand::with_name("debugignorerhg").about(HELP_TEXT) clap::App::new("debugignorerhg").about(HELP_TEXT)
} }
pub fn run(invocation: &crate::CliInvocation) -> Result<(), CommandError> { pub fn run(invocation: &crate::CliInvocation) -> Result<(), CommandError> {
let repo = invocation.repo?; let repo = invocation.repo?;
let ignore_file = repo.working_directory_vfs().join(".hgignore"); // TODO hardcoded let ignore_file = repo.working_directory_vfs().join(".hgignore"); // TODO hardcoded
let (ignore_matcher, warnings) = get_ignore_matcher( let (ignore_matcher, warnings) = get_ignore_matcher(

rust/rhg/src/commands/debugrequirements.rs

use crate::error::CommandError; use crate::error::CommandError;
pub const HELP_TEXT: &str = " pub const HELP_TEXT: &str = "
Print the current repo requirements. Print the current repo requirements.
"; ";
pub fn args() -> clap::App<'static, 'static> { pub fn args() -> clap::App<'static> {
clap::SubCommand::with_name("debugrequirements").about(HELP_TEXT) clap::App::new("debugrequirements").about(HELP_TEXT)
} }
pub fn run(invocation: &crate::CliInvocation) -> Result<(), CommandError> { pub fn run(invocation: &crate::CliInvocation) -> Result<(), CommandError> {
let repo = invocation.repo?; let repo = invocation.repo?;
let mut output = String::new(); let mut output = String::new();
let mut requirements: Vec<_> = repo.requirements().iter().collect(); let mut requirements: Vec<_> = repo.requirements().iter().collect();
requirements.sort(); requirements.sort();
for req in requirements { for req in requirements {
output.push_str(req); output.push_str(req);
output.push('\n'); output.push('\n');
} }
invocation.ui.write_stdout(output.as_bytes())?; invocation.ui.write_stdout(output.as_bytes())?;
Ok(()) Ok(())
} }

rust/rhg/src/commands/files.rs

use crate::error::CommandError; use crate::error::CommandError;
use crate::ui::Ui; use crate::ui::Ui;
use crate::utils::path_utils::RelativizePaths; use crate::utils::path_utils::RelativizePaths;
use clap::Arg; use clap::Arg;
use hg::errors::HgError; use hg::errors::HgError;
use hg::operations::list_rev_tracked_files; use hg::operations::list_rev_tracked_files;
use hg::operations::Dirstate; use hg::operations::Dirstate;
use hg::repo::Repo; use hg::repo::Repo;
use hg::utils::hg_path::HgPath; use hg::utils::hg_path::HgPath;
pub const HELP_TEXT: &str = " pub const HELP_TEXT: &str = "
List tracked files. List tracked files.
Returns 0 on success. Returns 0 on success.
"; ";
pub fn args() -> clap::App<'static, 'static> { pub fn args() -> clap::App<'static> {
clap::SubCommand::with_name("files") clap::App::new("files")
.arg( .arg(
Arg::with_name("rev") Arg::new("rev")
.help("search the repository as it is in REV") .help("search the repository as it is in REV")
.short("-r") .short('r')
.long("--revision") .long("--revision")
.value_name("REV") .value_name("REV")
.takes_value(true), .takes_value(true),
) )
.about(HELP_TEXT) .about(HELP_TEXT)
} }
pub fn run(invocation: &crate::CliInvocation) -> Result<(), CommandError> { pub fn run(invocation: &crate::CliInvocation) -> Result<(), CommandError> {

rust/rhg/src/commands/root.rs

use crate::error::CommandError; use crate::error::CommandError;
use format_bytes::format_bytes; use format_bytes::format_bytes;
use hg::errors::{IoErrorContext, IoResultExt}; use hg::errors::{IoErrorContext, IoResultExt};
use hg::utils::files::get_bytes_from_path; use hg::utils::files::get_bytes_from_path;
pub const HELP_TEXT: &str = " pub const HELP_TEXT: &str = "
Print the root directory of the current repository. Print the root directory of the current repository.
Returns 0 on success. Returns 0 on success.
"; ";
pub fn args() -> clap::App<'static, 'static> { pub fn args() -> clap::App<'static> {
clap::SubCommand::with_name("root").about(HELP_TEXT) clap::App::new("root").about(HELP_TEXT)
} }
pub fn run(invocation: &crate::CliInvocation) -> Result<(), CommandError> { pub fn run(invocation: &crate::CliInvocation) -> Result<(), CommandError> {
let repo = invocation.repo?; let repo = invocation.repo?;
let working_directory = repo.working_directory_path(); let working_directory = repo.working_directory_path();
let working_directory = std::fs::canonicalize(working_directory) let working_directory = std::fs::canonicalize(working_directory)
.with_context(|| { .with_context(|| {
IoErrorContext::CanonicalizingPath(working_directory.to_owned()) IoErrorContext::CanonicalizingPath(working_directory.to_owned())
})?; })?;
let bytes = get_bytes_from_path(&working_directory); let bytes = get_bytes_from_path(&working_directory);
invocation invocation
.ui .ui
.write_stdout(&format_bytes!(b"{}\n", bytes.as_slice()))?; .write_stdout(&format_bytes!(b"{}\n", bytes.as_slice()))?;
Ok(()) Ok(())
} }

rust/rhg/src/commands/status.rs

// status.rs // status.rs
// //
// Copyright 2020, Georges Racinet <georges.racinets@octobus.net> // Copyright 2020, Georges Racinet <georges.racinets@octobus.net>
// //
// This software may be used and distributed according to the terms of the // This software may be used and distributed according to the terms of the
// GNU General Public License version 2 or any later version. // GNU General Public License version 2 or any later version.
use crate::error::CommandError; use crate::error::CommandError;
use crate::ui::Ui; use crate::ui::Ui;
use crate::utils::path_utils::RelativizePaths; use crate::utils::path_utils::RelativizePaths;
use clap::{Arg, SubCommand}; use clap::Arg;
use format_bytes::format_bytes; use format_bytes::format_bytes;
use hg; use hg;
use hg::config::Config; use hg::config::Config;
use hg::dirstate::has_exec_bit; use hg::dirstate::has_exec_bit;
use hg::dirstate::status::StatusPath; use hg::dirstate::status::StatusPath;
use hg::dirstate::TruncatedTimestamp; use hg::dirstate::TruncatedTimestamp;
use hg::dirstate::RANGE_MASK_31BIT; use hg::dirstate::RANGE_MASK_31BIT;
use hg::errors::{HgError, IoResultExt}; use hg::errors::{HgError, IoResultExt};
pub const HELP_TEXT: &str = " pub const HELP_TEXT: &str = "
Show changed files in the working directory Show changed files in the working directory
This is a pure Rust version of `hg status`. This is a pure Rust version of `hg status`.
Some options might be missing, check the list below. Some options might be missing, check the list below.
"; ";
pub fn args() -> clap::App<'static, 'static> { pub fn args() -> clap::App<'static> {
SubCommand::with_name("status") clap::App::new("status")
.alias("st") .alias("st")
.about(HELP_TEXT) .about(HELP_TEXT)
.arg( .arg(
Arg::with_name("all") Arg::new("all")
.help("show status of all files") .help("show status of all files")
.short("-A") .short('A')
.long("--all"), .long("--all"),
) )
.arg( .arg(
Arg::with_name("modified") Arg::new("modified")
.help("show only modified files") .help("show only modified files")
.short("-m") .short('m')
.long("--modified"), .long("--modified"),
) )
.arg( .arg(
Arg::with_name("added") Arg::new("added")
.help("show only added files") .help("show only added files")
.short("-a") .short('a')
.long("--added"), .long("--added"),
) )
.arg( .arg(
Arg::with_name("removed") Arg::new("removed")
.help("show only removed files") .help("show only removed files")
.short("-r") .short('r')
.long("--removed"), .long("--removed"),
) )
.arg( .arg(
Arg::with_name("clean") Arg::new("clean")
.help("show only clean files") .help("show only clean files")
.short("-c") .short('c')
.long("--clean"), .long("--clean"),
) )
.arg( .arg(
Arg::with_name("deleted") Arg::new("deleted")
.help("show only deleted files") .help("show only deleted files")
.short("-d") .short('d')
.long("--deleted"), .long("--deleted"),
) )
.arg( .arg(
Arg::with_name("unknown") Arg::new("unknown")
.help("show only unknown (not tracked) files") .help("show only unknown (not tracked) files")
.short("-u") .short('u')
.long("--unknown"), .long("--unknown"),
) )
.arg( .arg(
Arg::with_name("ignored") Arg::new("ignored")
.help("show only ignored files") .help("show only ignored files")
.short("-i") .short('i')
.long("--ignored"), .long("--ignored"),
) )
.arg( .arg(
Arg::with_name("copies") Arg::new("copies")
.help("show source of copied files (DEFAULT: ui.statuscopies)") .help("show source of copied files (DEFAULT: ui.statuscopies)")
.short("-C") .short('C')
.long("--copies"), .long("--copies"),
) )
.arg( .arg(
Arg::with_name("no-status") Arg::new("no-status")
.help("hide status prefix") .help("hide status prefix")
.short("-n") .short('n')
.long("--no-status"), .long("--no-status"),
) )
} }
/// Pure data type allowing the caller to specify file states to display /// Pure data type allowing the caller to specify file states to display
#[derive(Copy, Clone, Debug)] #[derive(Copy, Clone, Debug)]
pub struct DisplayStates { pub struct DisplayStates {
pub modified: bool, pub modified: bool,

rust/rhg/src/main.rs

extern crate log; extern crate log;
use crate::error::CommandError; use crate::error::CommandError;
use crate::ui::Ui; use crate::ui::Ui;
use clap::App;
use clap::AppSettings; use clap::AppSettings;
use clap::Arg; use clap::Arg;
use clap::ArgMatches; use clap::ArgMatches;
use clap::{App, ArgSettings};
use format_bytes::{format_bytes, join}; use format_bytes::{format_bytes, join};
use hg::config::{Config, ConfigSource}; use hg::config::{Config, ConfigSource};
use hg::exit_codes; use hg::exit_codes;
use hg::repo::{Repo, RepoError}; use hg::repo::{Repo, RepoError};
use hg::utils::files::{get_bytes_from_os_str, get_path_from_bytes}; use hg::utils::files::{get_bytes_from_os_str, get_path_from_bytes};
use hg::utils::SliceExt; use hg::utils::SliceExt;
use std::collections::HashSet; use std::collections::HashSet;
use std::ffi::OsString; use std::ffi::OsString;
process_start_time: &blackbox::ProcessStartTime, process_start_time: &blackbox::ProcessStartTime,
ui: &ui::Ui, ui: &ui::Ui,
repo: Result<&Repo, &NoRepoInCwdError>, repo: Result<&Repo, &NoRepoInCwdError>,
config: &Config, config: &Config,
) -> Result<(), CommandError> { ) -> Result<(), CommandError> {
check_unsupported(config, repo, ui)?; check_unsupported(config, repo, ui)?;
let app = App::new("rhg") let app = App::new("rhg")
.global_setting(AppSettings::AllowInvalidUtf8) .global_setting(AppSettings::DisableVersionFlag)
.global_setting(AppSettings::DisableVersion)
.setting(AppSettings::SubcommandRequired) .setting(AppSettings::SubcommandRequired)
.setting(AppSettings::VersionlessSubcommands)
.arg( .arg(
Arg::with_name("repository") Arg::new("repository")
.help("repository root directory") .help("repository root directory")
.short("-R") .short('R')
.long("--repository") .long("--repository")
.value_name("REPO") .value_name("REPO")
.takes_value(true) .takes_value(true)
.setting(ArgSettings::AllowInvalidUtf8)
// Both ok: `hg -R ./foo log` or `hg log -R ./foo` // Both ok: `hg -R ./foo log` or `hg log -R ./foo`
.global(true), .global(true),
) )
.arg( .arg(
Arg::with_name("config") Arg::new("config")
.help("set/override config option (use 'section.name=value')") .help("set/override config option (use 'section.name=value')")
.long("--config") .long("--config")
.value_name("CONFIG") .value_name("CONFIG")
.takes_value(true) .takes_value(true)
.setting(ArgSettings::AllowInvalidUtf8)
.global(true) .global(true)
// Ok: `--config section.key1=val --config section.key2=val2` // Ok: `--config section.key1=val --config section.key2=val2`
.multiple(true) .multiple_occurrences(true)
// Not ok: `--config section.key1=val section.key2=val2` // Not ok: `--config section.key1=val section.key2=val2`
.number_of_values(1), .number_of_values(1),
) )
.arg( .arg(
Arg::with_name("cwd") Arg::new("cwd")
.help("change working directory") .help("change working directory")
.long("--cwd") .long("--cwd")
.value_name("DIR") .value_name("DIR")
.takes_value(true) .takes_value(true)
.setting(ArgSettings::AllowInvalidUtf8)
.global(true), .global(true),
) )
.version("0.0.1"); .version("0.0.1");
let app = add_subcommand_args(app); let app = add_subcommand_args(app);
let matches = app.clone().get_matches_safe()?; let matches = app.clone().try_get_matches()?;
let (subcommand_name, subcommand_matches) = matches.subcommand(); let (subcommand_name, subcommand_args) = matches.subcommand().expect("unknown subcommand name from clap despite AppSettings::SubcommandRequired");
// Mercurial allows users to define "defaults" for commands, fallback // Mercurial allows users to define "defaults" for commands, fallback
// if a default is detected for the current command // if a default is detected for the current command
let defaults = config.get_str(b"defaults", subcommand_name.as_bytes()); let defaults = config.get_str(b"defaults", subcommand_name.as_bytes());
if defaults?.is_some() { if defaults?.is_some() {
let msg = "`defaults` config set"; let msg = "`defaults` config set";
return Err(CommandError::unsupported(msg)); return Err(CommandError::unsupported(msg));
} }
for prefix in ["pre", "post", "fail"].iter() { for prefix in ["pre", "post", "fail"].iter() {
// Mercurial allows users to define generic hooks for commands, // Mercurial allows users to define generic hooks for commands,
// fallback if any are detected // fallback if any are detected
let item = format!("{}-{}", prefix, subcommand_name); let item = format!("{}-{}", prefix, subcommand_name);
let hook_for_command = config.get_str(b"hooks", item.as_bytes())?; let hook_for_command = config.get_str(b"hooks", item.as_bytes())?;
if hook_for_command.is_some() { if hook_for_command.is_some() {
let msg = format!("{}-{} hook defined", prefix, subcommand_name); let msg = format!("{}-{} hook defined", prefix, subcommand_name);
return Err(CommandError::unsupported(msg)); return Err(CommandError::unsupported(msg));
} }
} }
let run = subcommand_run_fn(subcommand_name) let run = subcommand_run_fn(subcommand_name)
.expect("unknown subcommand name from clap despite AppSettings::SubcommandRequired"); .expect("unknown subcommand name from clap despite AppSettings::SubcommandRequired");
let subcommand_args = subcommand_matches
.expect("no subcommand arguments from clap despite AppSettings::SubcommandRequired");
let invocation = CliInvocation { let invocation = CliInvocation {
ui, ui,
subcommand_args, subcommand_args,
config, config,
repo, repo,
}; };
macro_rules! subcommands { macro_rules! subcommands {
($( $command: ident )+) => { ($( $command: ident )+) => {
mod commands { mod commands {
$( $(
pub mod $command; pub mod $command;
)+ )+
} }
fn add_subcommand_args<'a, 'b>(app: App<'a, 'b>) -> App<'a, 'b> { fn add_subcommand_args(app: App<'static>) -> App<'static> {
app app
$( $(
.subcommand(commands::$command::args()) .subcommand(commands::$command::args())
)+ )+
} }
pub type RunFn = fn(&CliInvocation) -> Result<(), CommandError>; pub type RunFn = fn(&CliInvocation) -> Result<(), CommandError>;
files files
root root
config config
status status
} }
pub struct CliInvocation<'a> { pub struct CliInvocation<'a> {
ui: &'a Ui, ui: &'a Ui,
subcommand_args: &'a ArgMatches<'a>, subcommand_args: &'a ArgMatches,
config: &'a Config, config: &'a Config,
/// References inside `Result` is a bit peculiar but allow /// References inside `Result` is a bit peculiar but allow
/// `invocation.repo?` to work out with `&CliInvocation` since this /// `invocation.repo?` to work out with `&CliInvocation` since this
/// `Result` type is `Copy`. /// `Result` type is `Copy`.
repo: Result<&'a Repo, &'a NoRepoInCwdError>, repo: Result<&'a Repo, &'a NoRepoInCwdError>,
} }
struct NoRepoInCwdError { struct NoRepoInCwdError {