cargo-equip

競技プログラミング用にRustコードを一つの.rsファイルにバンドルするCargoサブコマンドです。

例

```toml [package] name = "lib" version = "0.0.0" edition = "2018"

[package.metadata.cargo-equip.module-dependencies] "crate::input" = [] "crate::output" = [] "crate::tonellishanks" = ["crate::xorshift", "::_atcoder::modint"] "crate::xorshift" = []

..

"::atcoder::convolution" = ["::atcoder::internalbit", "::atcoder::modint"] "::atcoder::internalbit" = [] "::atcoder::internalmath" = [] "::atcoder::internalqueue" = [] "::atcoder::internalscc" = [] "::atcoder::internaltypetraits" = [] "::atcoder::lazysegtree" = ["::atcoder::internalbit", "::atcoder::segtree"] "::atcoder::math" = ["::atcoder::internalmath"] "::atcoder::maxflow" = ["::atcoder::internaltypetraits", "::atcoder::internalqueue"] "::atcoder::mincostflow" = ["::atcoder::internaltypetraits"] "::atcoder::modint" = ["::atcoder::internalmath"] "::atcoder::scc" = ["::atcoder::internalscc"] "::atcoder::segtree" = ["::atcoder::internalbit", "::atcoder::internaltypetraits"] "::atcoder::twosat" = ["::atcoder::internalscc"]

[dependencies] __atcoder = { package = "ac-library-rs", git = "https://github.com/rust-lang-ja/ac-library-rs", branch = "replace-absolute-paths" } ```

```toml [package] name = "bin" version = "0.0.0" edition = "2018"

[dependencies] _atcoder = { package = "ac-library-rs", git = "https://github.com/rust-lang-ja/ac-library-rs", branch = "replace-absolute-paths" } _lib = { package = "lib", path = "/path/to/lib" } ```

```rust

[cfgattr(cargoequip, cargo_equip::equip)]

use ::{ _atcoder::modint::ModInt, _lib::{input, output, tonelli_shanks::ModIntBaseExt as _}, };

use std::io::Write as _;

fn main() { input! { yps: [(u32, u32)], }

output::buf_print(|out| {
    macro_rules! println(($($tt:tt)*) => (writeln!(out, $($tt)*).unwrap()));
    for (y, p) in yps {
        ModInt::set_modulus(p);
        if let Some(sqrt) = ModInt::new(y).sqrt() {
            println!("{}", sqrt);
        } else {
            println!("-1");
        }
    }
});

} ```

↓

console $ cargo equip --remove docs test-items --minify libs --rustfmt --check -o bundled.rs Bundling the code warning: could not minify the code. inserting spaces: `crate::__atcoder` Checking cargo-equip-check-output-d2y79wjwradhzmc5 v0.1.0 (/tmp/cargo-equip-check-output-d2y79wjwradhzmc5) Finished dev [unoptimized + debuginfo] target(s) in 0.36s

Submit Info #25574 - Library-Checker

インストール

Crates.io

console $ cargo install cargo-equip

`master`

console $ cargo install --git https://github.com/qryxip/cargo-equip

GitHub Releases

バイナリでの提供もしています。

使い方

cargo-equipで展開できるライブラリには以下の制約があります。

絶対パスを使わない。クレート内のアイテムはすべて相対パスで書く。

Rustのパス解決をシミュレートするのは非常に困難であるため、cargo-equipは基本的にパスの置き換えを行いません。 crate::はself::とsuper::で書き直してください。

diff -use crate::foo::Foo; +use super::foo::Foo;
共に展開する予定のクレートを使う場合、各モジュールに#[cfg_attr(cargo_equip, cargo_equip::use_another_lib)]を付けたextern crateを宣言してマウントし、そこを相対パスで参照する。

cargo-equipはこのアトリビュートの付いたextern crateをuse crate::extern_crate_name_in_main_crate;に置き換えます。

誤って直接使わないように対象の名前はリネームしておくことを強く推奨します。

```rust

[cfgattr(cargoequip, cargoequip::useanother_lib)]

extern crate _anotherlib as another_lib; ```

注意点として、バンドル後のコードが2015 editionで実行される場合(yukicoder, Library-Checker)、相対パスで参照するときはself::を付けてください。

rust use self::another_lib::foo::Foo;
#[macro_export] macro_rules! name { .. }はmod nameの中に置かれている

cargo-equipはmain source file内でどのマクロが使われているのかを調べません。この制約を守れば#[macro_export]したマクロは展開前も展開後も自然に動作します。

```rust

[cfgattr(cargoequip, cargo_equip::equip)]

use ::_mylib::input;

fn main() { input! { a: u32, b: u32, s: String, }
```
todo!();
```
} ```
マクロにおいて$crate::でアイテムのパスを指定している場合、#[cfg_attr(cargo_equip, cargo_equip::translate_dollar_crates)]を付ける

cargo-equipはこのアトリビュートが付いたmacro_rules!内にあるすべての$crateを、::identifier!と続く場合のみを除いて$crate::extern_crate_name_in_the_main_crateと置き換えます。アトリビュートが無い場合、またはアトリビュートをtypoしている場合は一切操作しません。

ただ3.の制約を守っていて、関連するアイテムがすべて同じモジュールにあるなら無くても動く場合があります。

```diff #[cfgattr(cargoequip, cargoequip::translatedollarcrates)] #[macroexport] macro_rules! input { ($($tt:tt)*) => {
- let __scanner = $crate::input::Scanner::new();
- let scanner = $crate::externcratenameinthemaincrate::input::Scanner::new(); $crate::input_inner!($($tt)*); // as is }; } ```
可能な限りinline module (mod $name;)は深さ1まで

後述するpackage.metadataでのモジュール依存関係の記述は今のところトップモジュール単位です。
crate root直下にはmod以外のpubなアイテムが置かれていない

置いてもいいですが使わないでください。現在cargo-equipはlib.rs直下のmod以外のアイテムを、読みますがすべて消し飛ばします。

5.と6.はそのうち対応しようと思います。

このように薄く広く作ってください。

src ├── a.rs ├── b.rs ├── c.rs └── lib.rs

rust // src/lib.rs pub mod a; pub mod b; pub mod c;

この制限に合うようなライブラリを書いたら、そのCargo.tomlのpackage.metadataにモジュールの依存関係を手で書いてください。直接useしたモジュールと、その連結成分だけを展開します。書いていない場合や欠けている場合はwarningと共にすべてのモジュールを展開します。

toml [package.metadata.cargo-equip.module-dependencies] "crate::a" = [] "crate::b" = ["crate::b"] "crate::c" = ["::__another_lib::d"] "::__another_lib::d" = ["::__another_lib::e"]

最後にマージされるのでどのモジュールの依存関係を、bin側を含めてどのパッケージに記述してもよいです。 ac-library-rsを使う場合、毎回使用するパッケージに以下のものを加えてください。

```toml

"extern crate name"が`__atcoder`の場合

[package.metadata.cargo-equip.module-dependencies] "::atcoder::convolution" = ["::atcoder::internalbit", "::atcoder::modint"] "::atcoder::internalbit" = [] "::atcoder::internalmath" = [] "::atcoder::internalqueue" = [] "::atcoder::internalscc" = [] "::atcoder::internaltypetraits" = [] "::atcoder::lazysegtree" = ["::atcoder::internalbit", "::atcoder::segtree"] "::atcoder::math" = ["::atcoder::internalmath"] "::atcoder::maxflow" = ["::atcoder::internaltypetraits", "::atcoder::internalqueue"] "::atcoder::mincostflow" = ["::atcoder::internaltypetraits"] "::atcoder::modint" = ["::atcoder::internalmath"] "::atcoder::scc" = ["::atcoder::internalscc"] "::atcoder::segtree" = ["::atcoder::internalbit", "::atcoder::internaltypetraits"] "::atcoder::twosat" = ["::atcoder::internalscc"] ```

そしてbin側の準備として、バンドルしたいライブラリをCargo.tomlのdependenciesに加えてください。

ただしこの際、ライブラリは誤って直接使わないようにリネームしておくことを強く推奨します。直接使った場合cargo-equipはそれについて何も操作しません。

コンテスト毎にツールでパッケージを自動生成しているならそれのテンプレートに加えてください。

toml [dependencies] __atcoder = { package = "ac-library-rs", git = "https://github.com/rust-lang-ja/ac-library-rs", branch = "replace-absolute-paths" } __my_lib1 = { package = "my_lib1", path = "/path/to/my_lib1" } __my_lib2 = { package = "my_lib2", path = "/path/to/my_lib2" }

準備ができたらこのようにattribute付きでライブラリをuseします。

```rust

![cfgattr(cargoequip, cargo_equip::equip)]

use ::mylib1::{a::A, b::B}; use ::mylib1::{c::C, d::D}; ```

leading colon (::)が付いたuseだけ展開されます。

use ::__my_lib1::{a::A, b::B}; ^^

パスの1つ目のsegmentから展開するべきライブラリを決定します。 leading colonを必須としているのはこのためです。

use ::__my_lib1::{a::A, b::B}; ^^^^^^^^

先述したライブラリの制約より、パスの第二セグメントはモジュールとみなします。これらのモジュールと、先程書いたmodule-dependenciesで繋がっているモジュールが展開されます。

use ::__my_lib1::{a::A, b::B}; ^ ^

第三セグメント以降はuse self::$extern_crate_name::$module_name::{..}と展開されます。

use ::__my_lib1::{a::A, b::B}; ^ ^

コードが書けたらcargo equipで展開します。 --bin {binの名前}か--src {binのファイルパス}でbinを指定してください。パッケージ内のbinが一つの場合は省略できます。ただしdefault-runには未対応です。

console $ cargo equip --bin "$name"

コードはこのように展開されます。

``rust //! # Bundled libraries //! //! ## [mylib1]({ a link to Crates.io or the repository }) //! //! ### Modules //! //! -::mylib1::a//! -::mylib1::b//! //! ## [mylib2]({ a link to Crates.io or the repository }) //! //! ### Modules //! //! -::mylib2::c//! -::mylib2::d`

/#![cfg_attr(cargo_equip, cargo_equip::equip)]/

/use ::my_lib1::{a::A, b::B};/ /use ::my_lib2::{c::C, d::D};/

fn main() { todo!(); }

// The following code was expanded by cargo-equip.

use self::mylib1::{a::A, b::B}; use self::mylib2::{c::C, d::D};

[allow(dead_code)]

pub mod _mylib { mod a { // .. }

mod b {
    // ..
}

// `module-dependencies`で連結されているモジュールも共に展開される
mod b_dep {
    // ..
}

}

[allow(dead_code)]

pub mod _mylib { mod c { // .. }

mod d {
    // ..
}

} ```

cargo-equipがやる操作は以下の通りです。これ以外は何も行いません。

bin側
- #![cfg_attr(cargo_equip, cargo_equip::equip)]を検知し、コメントアウト
- ::で始まるuseを検知し、コメントアウト
- doc commentを上部に追加
- 展開したlibを下部に追加
lib側
- lib.rs内のmodをすべて再帰的に展開する。このとき各モジュールをインデントする。ただし複数行にまたがるリテラルが無い場合はインデントしない
- modを展開後、modとextern crate以外のすべてのトップレベルのアイテムを消去する
- #[cfg_attr(cargo_equip, cargo_equip::use_another_lib)]が付いたextern crateを操作
- #[cfg_attr(cargo_equip, cargo_equip::translate_dollar_crates)]が付いたmacro_rules!を操作
- --remove <REMOVE>...オプションを付けた場合対象を操作
両方
- --minify allオプションを付けた場合コード全体を最小化する
- --rustfmtオプションを付けた場合Rustfmtでフォーマットする

オプション

`--remove <REMOVE>...`

--remove test-itemsで#[cfg(test)]が付いたアイテムを
--remove docsでDoc comment (//! .., /// .., /** .. */, #[doc = ".."])を
--remove commentsでコメント (// .., /* .. */)を

除去することができます。

```rust

[allow(dead_code)]

pub mod a { //! A.

/// A.
pub struct A; // aaaaa

#[cfg(test)]
mod tests {
    #[test]
    fn it_works() {
        assert_eq!(2 + 2, 4);
    }
}

} ```

↓

```rust

[allow(dead_code)]

pub mod a { pub struct A; } ```

`--minify <MINIFY>`

--minify libで展開後のライブラリをそれぞれ一行に折り畳みます。 --minify allでコード全体を最小化します。

ただ現段階では実装が適当なのでいくつか余計なスペースが挟まる場合があります。

`--rustfmt`

出力をRustfmtでフォーマットします。

`--check`

バンドルしたコードを出力する前にtarget directoryを共有した一時パッケージを作り、それの上でcargo checkします。

console $ cargo equip --check -o /dev/null Bundling code Checking cargo-equip-check-output-r3cw9cy0swqb5yac v0.1.0 (/tmp/cargo-equip-check-output-r3cw9cy0swqb5yac) Finished dev [unoptimized + debuginfo] target(s) in 0.18s

ライセンス

MIT or Apache-2.0のデュアルライセンスです。

cargo-equip

例

..

[cfgattr(cargoequip, cargo_equip::equip)]

インストール

Crates.io

master

GitHub Releases

使い方

[cfgattr(cargoequip, cargoequip::useanother_lib)]

[cfgattr(cargoequip, cargo_equip::equip)]

"extern crate name"が__atcoderの場合

![cfgattr(cargoequip, cargo_equip::equip)]

[allow(dead_code)]

[allow(dead_code)]

オプション

--remove <REMOVE>...

[allow(dead_code)]

[allow(dead_code)]

--minify <MINIFY>

--rustfmt

--check

ライセンス

`master`

"extern crate name"が`__atcoder`の場合

`--remove <REMOVE>...`

`--minify <MINIFY>`

`--rustfmt`

`--check`