amhk / arsc-cli Goto Github PK

Add benchmark tests. To compare performance against aapt2, use a script similar to

#!/bin/bash
set -eu
apk="$1"

hyperfine \
    --prepare 'cargo build --release' \
    --warmup 2 \
    "./target/release/arsc -- ${apk}" \
    "aapt2 dump resources --no-values ${apk}"

Go through and fix some of the many warnings found by clippy when the following settings are applied:

$ git diff
diff --git a/arsc/src/lib.rs b/arsc/src/lib.rs
index d158207845e..0e19de87dcf 100644
--- a/arsc/src/lib.rs
+++ b/arsc/src/lib.rs
@@ -1,3 +1,11 @@
+#![warn(
+    clippy::all,
+    clippy::restriction,
+    clippy::pedantic,
+    clippy::nursery,
+    clippy::cargo,
+    )]
+
 mod chunks;
 mod endianness;
 mod error;

The public method Table::resid_iter returns a ResourceIterator, so make the ResourceIterator public as well.

Currently the arsc crate's unit tests refer to the test-app.apk which resides outside the crate. Make the arsc create self-contained by moving the test data inside it.

Explicitly wrap the u32 resource ID references used for e.g. StringPoolSpan.name.

Increase runtime checks before accessing data in the arsc bytes stream, e.g.

• Verify more invariants for chunks, e.g. the Chunk::as_* methods should check ChunkHeader invariants.
• Annotate each unsafe block with a comment as to why the block can be trusted.

Reduce API complexity by always returning an iterator regardless of the chunk type. Chunks without children (StringPool, Spec, etc) should return an empty iterator.

ValueType::Dimension is currently hard-coded to 0. Implement proper decoding.

Add documentation, especially for the arsc crates public API and the ARSC file format. Add doc tests. Also disable rustdoc for the arsc binary to prevent confusion with the arsc library:

diff --git a/Cargo.toml b/Cargo.toml
index 79b5485eea4..79c1704fde7 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -8,6 +8,7 @@ edition = "2018"
 bench = false
 path = "src/main.rs"
 name = "arsc"
+doc = false
 
 [workspace]
 members = [

• Implement fmt::Display for ResourceConfiguration, e.g. "sv-land"
• Implement fmt::Debug for ResourceConfiguration, e.g. "ResourceConfiguration { }"

ValueType::Fraction is currently hard-coded to 0. Implement proper decoding.

• Add styled strings
• Add more resource types
• Remove pseudo translations

All ValueType::IntColor* values are currently hard-coded to 0. Implement proper decoding.