Separate lib/bin, update README.md, release v1.0.0

2024-03-13 17:32:23 -06:00 · 2024-03-13 17:32:23 -06:00 · 852fb537c4
parent f31edda06e
commit 852fb537c4
10 changed files with 190 additions and 103 deletions
--- a/.github/workflows/build.yaml
+++ b/.github/workflows/build.yaml
@ -14,7 +14,7 @@ jobs:
      RUSTFLAGS: -D warnings
    steps:
      - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
      - name: Setup Rust toolchain
        uses: dtolnay/rust-toolchain@stable
        with:
@ -35,7 +35,7 @@ jobs:
    # Prevent new advisories from failing CI
    continue-on-error: ${{ matrix.checks == 'advisories' }}
    steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
      - uses: EmbarkStudios/cargo-deny-action@v1
        with:
          command: check ${{ matrix.checks }}
@ -49,7 +49,7 @@ jobs:
    runs-on: ${{ matrix.platform }}
    steps:
      - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
      - name: Setup Rust toolchain
        uses: dtolnay/rust-toolchain@stable
      - name: Cargo test
@ -87,7 +87,7 @@ jobs:
    runs-on: ${{ matrix.platform }}
    steps:
      - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
      - name: Install dependencies
        if: matrix.packages != ''
        run: sudo apt-get -y install ${{ matrix.packages }}
@ -98,7 +98,7 @@ jobs:
      - name: Cargo build
        run: cargo build --release --all-features --target ${{ matrix.target }} --bin ${{ env.CARGO_BIN_NAME }}
      - name: Upload artifacts
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
        with:
          name: ${{ matrix.name }}
          path: |
@ -115,7 +115,7 @@ jobs:
    needs: [ build ]
    steps:
      - name: Download artifacts
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
        with:
          path: artifacts
      - name: Rename artifacts
@ -127,6 +127,6 @@ jobs:
          done
          ls -R ../out
      - name: Release
-        uses: softprops/action-gh-release@v1
+        uses: softprops/action-gh-release@v2
        with:
          files: out/*
--- a/.gitignore
+++ b/.gitignore
@ -1,3 +1,3 @@
-/target
+target/
 Cargo.lock
 .idea
--- a/Cargo.toml
+++ b/Cargo.toml
@ -1,16 +1,3 @@
-[package]
-name = "cwdemangle"
-version = "0.2.0"
-edition = "2018"
-authors = ["Luke Street <luke@street.dev>"]
-license = "MIT OR Apache-2.0"
-repository = "https://github.com/encounter/cwdemangle"
-readme = "README.md"
-description = """
-CodeWarrior C++ symbol demangler
-"""
-categories = ["command-line-utilities"]
-rust-version = "1.58"
-
-[dependencies]
-argh = "0.1.8"
+[workspace]
+members = ["lib", "bin"]
+resolver = "2"
--- a/README.md
+++ b/README.md
@ -10,24 +10,37 @@

 A CodeWarrior C++ symbol demangler.

-### Usage
+## Usage

-CLI:
+### CLI
+
+Static binaries available from [releases](https://github.com/encounter/cwdemangle/releases) or install via `cargo install cwdemangle-bin`.

 ```shell
 cwdemangle 'BuildLight__9CGuiLightCFv'
 ```

-Library:
+Pass `--help` to see available options.
+
+### Library
+
+- No dependencies
+- `#![no_std]` compatible (requires `alloc`)
+
+Cargo.toml:
+
+```toml
+[dependencies]
+cwdemangle = "0.2"
+```
+
+Usage:

 ```rust
 use cwdemangle::{demangle, DemangleOptions};

-if let Some(result) = demangle("BuildLight__9CGuiLightCFv", &DemangleOptions::default()) {
-    println!("{}", result);
-} else {
-    eprintln!("Couldn't demangle symbol (not a C++ symbol?)");
-}
+let result = demangle("BuildLight__9CGuiLightCFv", &DemangleOptions::default());
+assert_eq!(result, Some("CGuiLight::BuildLight() const".to_string()));
 ```

 ### License
--- a/bin/Cargo.toml
+++ b/bin/Cargo.toml
@ -0,0 +1,19 @@
+[package]
+name = "cwdemangle-bin"
+version = "1.0.0"
+edition = "2021"
+authors = ["Luke Street <luke@street.dev>"]
+license = "MIT OR Apache-2.0"
+repository = "https://github.com/encounter/cwdemangle"
+readme = "../README.md"
+description = "CodeWarrior C++ symbol demangler (binary)"
+categories = ["command-line-utilities"]
+rust-version = "1.58"
+
+[[bin]]
+name = "cwdemangle"
+path = "src/main.rs"
+
+[dependencies]
+argh = "0.1.12"
+cwdemangle = { path = "../lib" }
--- a/bin/src/argh_cargo.rs
+++ b/bin/src/argh_cargo.rs
--- a/bin/src/main.rs
+++ b/bin/src/main.rs
--- a/deny.toml
+++ b/deny.toml
@ -9,6 +9,11 @@
 # The values provided in this template are the default values that will be used
 # when any section or field is not specified in your own configuration

+# Root options
+
+# The graph table configures how the dependency graph is constructed and thus
+# which crates the checks are performed against
+[graph]
 # If 1 or more target triples (and optionally, target_features) are specified,
 # only the specified targets will be checked when running `cargo deny check`.
 # This means, if a particular package is only ever used as a target specific
@ -20,53 +25,67 @@
 targets = [
    # The triple can be any string, but only the target triples built in to
    # rustc (as of 1.40) can be checked against actual config expressions
-    #{ triple = "x86_64-unknown-linux-musl" },
+    #"x86_64-unknown-linux-musl",
    # You can also specify which target_features you promise are enabled for a
    # particular target. target_features are currently not validated against
    # the actual valid features supported by the target architecture.
    #{ triple = "wasm32-unknown-unknown", features = ["atomics"] },
 ]
+# When creating the dependency graph used as the source of truth when checks are
+# executed, this field can be used to prune crates from the graph, removing them
+# from the view of cargo-deny. This is an extremely heavy hammer, as if a crate
+# is pruned from the graph, all of its dependencies will also be pruned unless
+# they are connected to another crate in the graph that hasn't been pruned,
+# so it should be used with care. The identifiers are [Package ID Specifications]
+# (https://doc.rust-lang.org/cargo/reference/pkgid-spec.html)
+#exclude = []
+# If true, metadata will be collected with `--all-features`. Note that this can't
+# be toggled off if true, if you want to conditionally enable `--all-features` it
+# is recommended to pass `--all-features` on the cmd line instead
+all-features = false
+# If true, metadata will be collected with `--no-default-features`. The same
+# caveat with `all-features` applies
+no-default-features = false
+# If set, these feature will be enabled when collecting metadata. If `--features`
+# is specified on the cmd line they will take precedence over this option.
+#features = []
+
+# The output table provides options for how/if diagnostics are outputted
+[output]
+# When outputting inclusion graphs in diagnostics that include features, this
+# option can be used to specify the depth at which feature edges will be added.
+# This option is included since the graphs can be quite large and the addition
+# of features from the crate(s) to all of the graph roots can be far too verbose.
+# This option can be overridden via `--feature-depth` on the cmd line
+feature-depth = 1

 # This section is considered when running `cargo deny check advisories`
 # More documentation for the advisories section can be found here:
 # https://embarkstudios.github.io/cargo-deny/checks/advisories/cfg.html
 [advisories]
-# The path where the advisory database is cloned/fetched into
-db-path = "~/.cargo/advisory-db"
+# The path where the advisory databases are cloned/fetched into
+#db-path = "$CARGO_HOME/advisory-dbs"
 # The url(s) of the advisory databases to use
-db-urls = ["https://github.com/rustsec/advisory-db"]
-# The lint level for security vulnerabilities
-vulnerability = "deny"
-# The lint level for unmaintained crates
-unmaintained = "warn"
-# The lint level for crates that have been yanked from their source registry
-yanked = "warn"
-# The lint level for crates with security notices. Note that as of
-# 2019-12-17 there are no security notice advisories in
-# https://github.com/rustsec/advisory-db
-notice = "warn"
+#db-urls = ["https://github.com/rustsec/advisory-db"]
 # A list of advisory IDs to ignore. Note that ignored advisories will still
 # output a note when they are encountered.
 ignore = [
    #"RUSTSEC-0000-0000",
+    #{ id = "RUSTSEC-0000-0000", reason = "you can specify a reason the advisory is ignored" },
+    #"a-crate-that-is-yanked@0.1.1", # you can also ignore yanked crate versions if you wish
+    #{ crate = "a-crate-that-is-yanked@0.1.1", reason = "you can specify why you are ignoring the yanked crate" },
 ]
-# Threshold for security vulnerabilities, any vulnerability with a CVSS score
-# lower than the range specified will be ignored. Note that ignored advisories
-# will still output a note when they are encountered.
-# * None - CVSS Score 0.0
-# * Low - CVSS Score 0.1 - 3.9
-# * Medium - CVSS Score 4.0 - 6.9
-# * High - CVSS Score 7.0 - 8.9
-# * Critical - CVSS Score 9.0 - 10.0
-#severity-threshold =
+# If this is true, then cargo deny will use the git executable to fetch advisory database.
+# If this is false, then it uses a built-in git library.
+# Setting this to true can be helpful if you have special authentication requirements that cargo-deny does not support.
+# See Git Authentication for more information about setting up git authentication.
+#git-fetch-with-cli = true

 # This section is considered when running `cargo deny check licenses`
 # More documentation for the licenses section can be found here:
 # https://embarkstudios.github.io/cargo-deny/checks/licenses/cfg.html
 [licenses]
-# The lint level for crates which do not have a detectable license
-unlicensed = "deny"
-# List of explictly allowed licenses
+# List of explicitly allowed licenses
 # See https://spdx.org/licenses/ for list of possible licenses
 # [possible values: any SPDX 3.11 short identifier (+ optional exception)].
 allow = [
@ -75,26 +94,6 @@ allow = [
    "BSD-3-Clause",
    "Unicode-DFS-2016",
 ]
-# List of explictly disallowed licenses
-# See https://spdx.org/licenses/ for list of possible licenses
-# [possible values: any SPDX 3.11 short identifier (+ optional exception)].
-deny = [
-    #"Nokia",
-]
-# Lint level for licenses considered copyleft
-copyleft = "warn"
-# Blanket approval or denial for OSI-approved or FSF Free/Libre licenses
-# * both - The license will be approved if it is both OSI-approved *AND* FSF
-# * either - The license will be approved if it is either OSI-approved *OR* FSF
-# * osi-only - The license will be approved if is OSI-approved *AND NOT* FSF
-# * fsf-only - The license will be approved if is FSF *AND NOT* OSI-approved
-# * neither - This predicate is ignored and the default lint level is used
-allow-osi-fsf-free = "neither"
-# Lint level used when no other predicates are matched
-# 1. License isn't in the allow or deny lists
-# 2. License isn't copyleft
-# 3. License isn't OSI/FSF, or allow-osi-fsf-free = "neither"
-default = "deny"
 # The confidence threshold for detecting a license from license text.
 # The higher the value, the more closely the license text must be to the
 # canonical license text of a valid SPDX license file.
@ -105,32 +104,32 @@ confidence-threshold = 0.8
 exceptions = [
    # Each entry is the crate and version constraint, and its specific allow
    # list
-    #{ allow = ["Zlib"], name = "adler32", version = "*" },
+    #{ allow = ["Zlib"], crate = "adler32" },
 ]

 # Some crates don't have (easily) machine readable licensing information,
 # adding a clarification entry for it allows you to manually specify the
 # licensing information
-[[licenses.clarify]]
-# The name of the crate the clarification applies to
-name = "encoding_rs"
-# The optional version constraint for the crate
-#version = "*"
+#[[licenses.clarify]]
+# The package spec the clarification applies to
+#crate = "ring"
 # The SPDX expression for the license requirements of the crate
-expression = "(Apache-2.0 OR MIT) AND BSD-3-Clause"
+#expression = "MIT AND ISC AND OpenSSL"
 # One or more files in the crate's source used as the "source of truth" for
 # the license expression. If the contents match, the clarification will be used
 # when running the license check, otherwise the clarification will be ignored
 # and the crate will be checked normally, which may produce warnings or errors
 # depending on the rest of your configuration
-license-files = [
-    # Each entry is a crate relative path, and the (opaque) hash of its contents
-    { path = "COPYRIGHT", hash = 0x39f8ad31 }
-]
+#license-files = [
+# Each entry is a crate relative path, and the (opaque) hash of its contents
+#{ path = "LICENSE", hash = 0xbd0eed23 }
+#]

 [licenses.private]
 # If true, ignores workspace crates that aren't published, or are only
-# published to private registries
+# published to private registries.
+# To see how to mark a crate as unpublished (to the official registry),
+# visit https://doc.rust-lang.org/cargo/reference/manifest.html#the-publish-field.
 ignore = false
 # One or more private registries that you might publish crates to, if a crate
 # is only published to private registries, and ignore is true, the crate will
@ -153,30 +152,63 @@ wildcards = "allow"
 # * simplest-path - The path to the version with the fewest edges is highlighted
 # * all - Both lowest-version and simplest-path are used
 highlight = "all"
+# The default lint level for `default` features for crates that are members of
+# the workspace that is being checked. This can be overridden by allowing/denying
+# `default` on a crate-by-crate basis if desired.
+workspace-default-features = "allow"
+# The default lint level for `default` features for external crates that are not
+# members of the workspace. This can be overridden by allowing/denying `default`
+# on a crate-by-crate basis if desired.
+external-default-features = "allow"
 # List of crates that are allowed. Use with care!
 allow = [
-    #{ name = "ansi_term", version = "=0.11.0" },
+    #"ansi_term@0.11.0",
+    #{ crate = "ansi_term@0.11.0", reason = "you can specify a reason it is allowed" },
 ]
 # List of crates to deny
 deny = [
-    # Each entry the name of a crate and a version range. If version is
-    # not specified, all versions will be matched.
-    #{ name = "ansi_term", version = "=0.11.0" },
-    #
+    #"ansi_term@0.11.0",
+    #{ crate = "ansi_term@0.11.0", reason = "you can specify a reason it is banned" },
    # Wrapper crates can optionally be specified to allow the crate when it
    # is a direct dependency of the otherwise banned crate
-    #{ name = "ansi_term", version = "=0.11.0", wrappers = [] },
+    #{ crate = "ansi_term@0.11.0", wrappers = ["this-crate-directly-depends-on-ansi_term"] },
 ]
+
+# List of features to allow/deny
+# Each entry the name of a crate and a version range. If version is
+# not specified, all versions will be matched.
+#[[bans.features]]
+#crate = "reqwest"
+# Features to not allow
+#deny = ["json"]
+# Features to allow
+#allow = [
+#    "rustls",
+#    "__rustls",
+#    "__tls",
+#    "hyper-rustls",
+#    "rustls",
+#    "rustls-pemfile",
+#    "rustls-tls-webpki-roots",
+#    "tokio-rustls",
+#    "webpki-roots",
+#]
+# If true, the allowed features must exactly match the enabled feature set. If
+# this is set there is no point setting `deny`
+#exact = true
+
 # Certain crates/versions that will be skipped when doing duplicate detection.
 skip = [
-    #{ name = "ansi_term", version = "=0.11.0" },
+    #"ansi_term@0.11.0",
+    #{ crate = "ansi_term@0.11.0", reason = "you can specify a reason why it can't be updated/removed" },
 ]
 # Similarly to `skip` allows you to skip certain crates during duplicate
 # detection. Unlike skip, it also includes the entire tree of transitive
 # dependencies starting at the specified crate, up to a certain depth, which is
-# by default infinite
+# by default infinite.
 skip-tree = [
-    #{ name = "ansi_term", version = "=0.11.0", depth = 20 },
+    #"ansi_term@0.11.0", # will be skipped along with _all_ of its direct and transitive dependencies
+    #{ crate = "ansi_term@0.11.0", depth = 20 },
 ]

 # This section is considered when running `cargo deny check sources`.
@ -197,8 +229,8 @@ allow-git = []

 [sources.allow-org]
 # 1 or more github.com organizations to allow git sources for
-#github = [""]
+github = []
 # 1 or more gitlab.com organizations to allow git sources for
-#gitlab = [""]
+gitlab = []
 # 1 or more bitbucket.org organizations to allow git sources for
-#bitbucket = [""]
+bitbucket = []
--- a/lib/Cargo.toml
+++ b/lib/Cargo.toml
@ -0,0 +1,14 @@
+[package]
+name = "cwdemangle"
+version = "1.0.0"
+edition = "2021"
+authors = ["Luke Street <luke@street.dev>"]
+license = "MIT OR Apache-2.0"
+repository = "https://github.com/encounter/cwdemangle"
+readme = "../README.md"
+description = "CodeWarrior C++ symbol demangler"
+categories = ["parser-implementations", "no-std"]
+rust-version = "1.58"
+
+[dependencies]
+# Intentionally left blank.
--- a/lib/src/lib.rs
+++ b/lib/src/lib.rs
@ -1,9 +1,28 @@
-use std::str::FromStr;
+//! A CodeWarrior C++ symbol demangler.
+//! 
+//! # Usage
+//! ```
+//! use cwdemangle::{demangle, DemangleOptions};
+//!
+//! let result = demangle("BuildLight__9CGuiLightCFv", &DemangleOptions::default());
+//! assert_eq!(result, Some("CGuiLight::BuildLight() const".to_string()));
+//! ```
+#![no_std]

+extern crate alloc;
+
+use alloc::{
+    format,
+    str::FromStr,
+    string::{String, ToString},
+};
+
+/// Options for [demangle].
 pub struct DemangleOptions {
    /// Replace `(void)` function parameters with `()`
    pub omit_empty_parameters: bool,
    /// Enable Metrowerks extension types (`__int128`, `__vec2x32float__`, etc.)
+    ///
    /// Disabled by default since they conflict with template argument literals
    /// and can't always be demangled correctly.
    pub mw_extensions: bool,
@ -326,6 +345,9 @@ fn demangle_special_function(
    ))
 }

+/// Demangle a symbol name.
+///
+/// Returns `None` if the input is not a valid mangled name.
 pub fn demangle(mut str: &str, options: &DemangleOptions) -> Option<String> {
    if !str.is_ascii() {
        return None;