swaits/donglora
Archived
1
0 Fork 0
Code Issues Actions Packages Projects Releases Wiki Activity

feat: add display UI with splash screen, dashboard, and RSSI sparkline

Browse Source 
Implement full SSD1306 OLED display support:
- Splash screen on boot (1.5s) with project name, version, board
- Dashboard showing radio state, config, counters, RSSI/SNR
- RSSI history sparkline (64-sample ring buffer, 2px-wide bars)
- DisplayOn/DisplayOff host commands routed via dedicated channel
- Pure render functions against generic DrawTarget (no hardware coupling)
- Display on/off control bypasses radio task entirely

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
swaitsandClaude Opus 4.6 committed 2026-03-29 20:42:54 -06:00
1 parent 7064110293
commit 3102fc747a
17624 files changed
+4564928 -38
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

vendor/proc-macro-crate/.cargo-checksum.json
Vendored
+1
View File
@@ -0,0 +1 @@
{"files":{".cargo_vcs_info.json":"ddba6e7da4b479ec508b0c34b456de2716c9c47273e14f4275f6b12016a662e4",".github/workflows/rust.yml":"160ec009bc8d919336de1d2089d27780bd1aa138aae86ed0ca321fe1eab07a62",".rustfmt.toml":"c37594e3a07641013538d862d8c614db45161ce4a530177c4907057fc7b90992",".travis.yml":"3e9d4f44da994d7b45b2c714791220907b82c58ae2f3feacaab92a600997f29d","Cargo.lock":"6c5406e28ed7eac7d899159bae69175506e26fe1182592f9698ce5324a245d4c","Cargo.toml":"e67f9a551770d5e0eea15db9977f257f390ae893068b1cc6425a0a87ac314bb3","Cargo.toml.orig":"aa382719c0f3c55a4e5067edfc40ec1b4969c6b9ca7abc9ad207f046795435b8","LICENSE-APACHE":"8ada45cd9f843acf64e4722ae262c622a2b3b3007c7310ef36ac1061a30f6adb","LICENSE-MIT":"23f18e03dc49df91622fe2a76176497404e46ced8a715d9d2b67a7446571cca3","README.md":"bf71b469e066c36321488ff63927863e13ed35dd2f433a06db930055d4720b65","clippy.toml":"9ebb997b032fbbb78985e85660df753773c502a13b09a4744e8902fdd9ab2b66","src/lib.rs":"d2ef10bd020f64862ae854efa0ff901760c4f36b9984f58daba072d8bd894153","tests/workspace_deps.rs":"d8722fdbda99135c5291ba197fae72a5697d8a5f29103e6ee61b156e0287bc12"},"package":"e67ba7e9b2b56446f1d419b1d807906278ffa1a658a8a5d8a39dcb1f5a78614f"}
vendor/proc-macro-crate/.cargo_vcs_info.json
Vendored
+6
View File
@@ -0,0 +1,6 @@
{
"git": {
"sha1": "8f3d8b04539f732e09c07907f138a248c8d0eed9"
},
"path_in_vcs": ""
}
vendor/proc-macro-crate/.github/workflows/rust.yml
Vendored
+55
View File
@@ -0,0 +1,55 @@
name: Rust
on:
push:
branches: [ master ]
pull_request:
branches: [ master ]
env:
CARGO_TERM_COLOR: always
jobs:
test:
name: cargo test
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: dtolnay/rust-toolchain@stable
- run: cargo test --all
msrv:
name: "Check MSRV: 1.82.0"
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Install Rust
uses: dtolnay/rust-toolchain@stable
with:
toolchain: 1.82.0 # MSRV
- uses: Swatinem/rust-cache@v2
- name: Default features
run: cargo test --all
rustfmt:
name: rustfmt
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Install Rust
uses: dtolnay/rust-toolchain@nightly
with:
toolchain: nightly
components: rustfmt
- uses: Swatinem/rust-cache@v2
- name: Check formatting
run: cargo fmt --all -- --check
clippy:
name: cargo clippy (forbidden methods)
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: dtolnay/rust-toolchain@stable
# We just use clippy to spot forbidden methods.
# We disable the default lint set which has much questionable output.
- run: cargo clippy --all -- -A clippy::all -D clippy::disallowed_methods
vendor/proc-macro-crate/.rustfmt.toml
Vendored
+23
View File
@@ -0,0 +1,23 @@
# Basic
edition = "2021"
max_width = 100
use_small_heuristics = "Max"
# Imports
imports_granularity = "Crate"
reorder_imports = true
# Consistency
newline_style = "Unix"
# Misc
chain_width = 80
spaces_around_ranges = false
binop_separator = "Back"
reorder_impl_items = false
match_arm_leading_pipes = "Preserve"
match_arm_blocks = false
match_block_trailing_comma = true
trailing_comma = "Vertical"
trailing_semicolon = false
use_field_init_shorthand = true
# Format comments
comment_width = 100
wrap_comments = true
vendor/proc-macro-crate/.travis.yml
Vendored
+8
View File
@@ -0,0 +1,8 @@
language: rust
cache: cargo
rust:
- stable
- beta
- nightly
vendor/proc-macro-crate/Cargo.lock
Generated Vendored
+135
View File
@@ -0,0 +1,135 @@
# This file is automatically @generated by Cargo.
# It is not intended for manual editing.
version = 3
[[package]]
name = "equivalent"
version = "1.0.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "5443807d6dff69373d433ab9ef5378ad8df50ca6298caf15de6e52e24aaf54d5"
[[package]]
name = "hashbrown"
version = "0.16.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "841d1cc9bed7f9236f321df977030373f4a4163ae1a7dbfe1a51a2c1a51d9100"
[[package]]
name = "indexmap"
version = "2.13.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "7714e70437a7dc3ac8eb7e6f8df75fd8eb422675fc7678aff7364301092b1017"
dependencies = [
"equivalent",
"hashbrown",
]
[[package]]
name = "memchr"
version = "2.6.4"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "f665ee40bc4a3c5590afb1e9677db74a508659dfd71e126420da8274909a0167"
[[package]]
name = "proc-macro-crate"
version = "3.5.0"
dependencies = [
"proc-macro2",
"quote",
"syn",
"toml_edit",
]
[[package]]
name = "proc-macro2"
version = "1.0.94"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "a31971752e70b8b2686d7e46ec17fb38dad4051d94024c88df49b667caea9c84"
dependencies = [
"unicode-ident",
]
[[package]]
name = "quote"
version = "1.0.39"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "c1f1914ce909e1658d9907913b4b91947430c7d9be598b15a1912935b8c04801"
dependencies = [
"proc-macro2",
]
[[package]]
name = "serde_core"
version = "1.0.225"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "659356f9a0cb1e529b24c01e43ad2bdf520ec4ceaf83047b83ddcc2251f96383"
dependencies = [
"serde_derive",
]
[[package]]
name = "serde_derive"
version = "1.0.225"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "0ea936adf78b1f766949a4977b91d2f5595825bd6ec079aa9543ad2685fc4516"
dependencies = [
"proc-macro2",
"quote",
"syn",
]
[[package]]
name = "syn"
version = "2.0.99"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "e02e925281e18ffd9d640e234264753c43edc62d64b2d4cf898f1bc5e75f3fc2"
dependencies = [
"proc-macro2",
"quote",
"unicode-ident",
]
[[package]]
name = "toml_datetime"
version = "1.0.0+spec-1.1.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "32c2555c699578a4f59f0cc68e5116c8d7cabbd45e1409b989d4be085b53f13e"
dependencies = [
"serde_core",
]
[[package]]
name = "toml_edit"
version = "0.25.3+spec-1.1.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "a0a07913e63758bc95142d9863a5a45173b71515e68b690cad70cf99c3255ce1"
dependencies = [
"indexmap",
"toml_datetime",
"toml_parser",
"winnow",
]
[[package]]
name = "toml_parser"
version = "1.0.9+spec-1.1.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "702d4415e08923e7e1ef96cd5727c0dfed80b4d2fa25db9647fe5eb6f7c5a4c4"
dependencies = [
"winnow",
]
[[package]]
name = "unicode-ident"
version = "1.0.12"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "3354b9ac3fae1ff6755cb6db53683adb661634f67557942dea4facebec0fee4b"
[[package]]
name = "winnow"
version = "0.7.13"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "21a0236b59786fed61e2a80582dd500fe61f18b5dca67a4a067d0bc9039339cf"
dependencies = [
"memchr",
]
vendor/proc-macro-crate/Cargo.toml
Vendored
+59
View File
@@ -0,0 +1,59 @@
# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO
#
# When uploading crates to the registry Cargo will automatically
# "normalize" Cargo.toml files for maximal compatibility
# with all versions of Cargo and also rewrite `path` dependencies
# to registry (e.g., crates.io) dependencies.
#
# If you are reading this file be aware that the original Cargo.toml
# will likely look very different (and much more reasonable).
# See Cargo.toml.orig for the original contents.
[package]
edition = "2021"
rust-version = "1.82.0"
name = "proc-macro-crate"
version = "3.5.0"
authors = ["Bastian Köcher <git@kchr.de>"]
build = false
autolib = false
autobins = false
autoexamples = false
autotests = false
autobenches = false
description = """
Replacement for crate (macro_rules keyword) in proc-macros
"""
documentation = "https://docs.rs/proc-macro-crate"
readme = "README.md"
keywords = [
"macro-rules",
"crate",
"macro",
"proc-macro",
]
categories = ["development-tools::procedural-macro-helpers"]
license = "MIT OR Apache-2.0"
repository = "https://github.com/bkchr/proc-macro-crate"
[lib]
name = "proc_macro_crate"
path = "src/lib.rs"
[[test]]
name = "workspace_deps"
path = "tests/workspace_deps.rs"
[dependencies.toml_edit]
version = "0.25.0"
features = ["parse"]
default-features = false
[dev-dependencies.proc-macro2]
version = "1.0.94"
[dev-dependencies.quote]
version = "1.0.39"
[dev-dependencies.syn]
version = "2.0.99"
vendor/proc-macro-crate/LICENSE-APACHE
Vendored
+201
View File
@@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
https://www.apache.org/licenses/LICENSE-2.0
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
vendor/proc-macro-crate/LICENSE-MIT
Vendored
+23
View File
@@ -0,0 +1,23 @@
Permission is hereby granted, free of charge, to any
person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the
Software without restriction, including without
limitation the rights to use, copy, modify, merge,
publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software
is furnished to do so, subject to the following
conditions:
The above copyright notice and this permission notice
shall be included in all copies or substantial portions
of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
vendor/proc-macro-crate/README.md
Vendored
+87
View File
@@ -0,0 +1,87 @@
# proc-macro-crate
[![](https://docs.rs/proc-macro-crate/badge.svg)](https://docs.rs/proc-macro-crate/) [![](https://img.shields.io/crates/v/proc-macro-crate.svg)](https://crates.io/crates/proc-macro-crate) [![](https://img.shields.io/crates/d/proc-macro-crate.png)](https://crates.io/crates/proc-macro-crate) [![Build Status](https://travis-ci.org/bkchr/proc-macro-crate.png?branch=master)](https://travis-ci.org/bkchr/proc-macro-crate)
Providing support for `$crate` in procedural macros.
* [Introduction](#introduction)
* [Example](#example)
* [License](#license)
### Introduction
In `macro_rules!` `$crate` is used to get the path of the crate where a macro is declared in. In
procedural macros there is currently no easy way to get this path. A common hack is to import the
desired crate with a know name and use this. However, with rust edition 2018 and dropping
`extern crate` declarations from `lib.rs`, people start to rename crates in `Cargo.toml` directly.
However, this breaks importing the crate, as the proc-macro developer does not know the renamed
name of the crate that should be imported.
This crate provides a way to get the name of a crate, even if it renamed in `Cargo.toml`. For this
purpose a single function `crate_name` is provided. This function needs to be called in the context
of a proc-macro with the name of the desired crate. `CARGO_MANIFEST_DIR` will be used to find the
current active `Cargo.toml` and this `Cargo.toml` is searched for the desired crate.
### Example
```rust
use quote::quote;
use syn::Ident;
use proc_macro2::Span;
use proc_macro_crate::{crate_name, FoundCrate};
fn import_my_crate() {
let found_crate = crate_name("my-crate").expect("my-crate is present in `Cargo.toml`");
match found_crate {
FoundCrate::Itself => quote!( crate::Something ),
FoundCrate::Name(name) => {
let ident = Ident::new(&name, Span::call_site());
quote!( #ident::Something )
}
};
}
```
### Edge cases
There are multiple edge cases when it comes to determining the correct crate. If you for example
import a crate as its own dependency, like this:
```toml
[package]
name = "my_crate"
[dev-dependencies]
my_crate = { version = "0.1", features = [ "test-feature" ] }
```
The crate will return `FoundCrate::Itself` and you will not be able to find the other instance
of your crate in `dev-dependencies`. Other similar cases are when one crate is imported multiple
times:
```toml
[package]
name = "my_crate"
[dependencies]
some-crate = { version = "0.5" }
some-crate-old = { package = "some-crate", version = "0.1" }
```
When searching for `some-crate` in this `Cargo.toml` it will return `FoundCrate::Name("some_old_crate")`,
aka the last definition of the crate in the `Cargo.toml`.
### License
Licensed under either of
* [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0)
* [MIT license](https://opensource.org/licenses/MIT)
at your option.
License: MIT OR Apache-2.0
vendor/proc-macro-crate/clippy.toml
Vendored
+5
View File
@@ -0,0 +1,5 @@
disallowed-methods = [
# Avoid a repeat of https://github.com/bkchr/proc-macro-crate/issues/57
{ path = "toml_edit::Item::as_table", reason = "Use .as_table_like instead!" },
{ path = "toml_edit::Item::is_table", reason = "Use .is_table_like instead!" },
]
vendor/proc-macro-crate/src/lib.rs
Vendored
+577
View File
@@ -0,0 +1,577 @@
/*!
[![](https://docs.rs/proc-macro-crate/badge.svg)](https://docs.rs/proc-macro-crate/) [![](https://img.shields.io/crates/v/proc-macro-crate.svg)](https://crates.io/crates/proc-macro-crate) [![](https://img.shields.io/crates/d/proc-macro-crate.png)](https://crates.io/crates/proc-macro-crate) [![Build Status](https://travis-ci.org/bkchr/proc-macro-crate.png?branch=master)](https://travis-ci.org/bkchr/proc-macro-crate)
Providing support for `$crate` in procedural macros.
* [Introduction](#introduction)
* [Example](#example)
* [License](#license)
## Introduction
In `macro_rules!` `$crate` is used to get the path of the crate where a macro is declared in. In
procedural macros there is currently no easy way to get this path. A common hack is to import the
desired crate with a know name and use this. However, with rust edition 2018 and dropping
`extern crate` declarations from `lib.rs`, people start to rename crates in `Cargo.toml` directly.
However, this breaks importing the crate, as the proc-macro developer does not know the renamed
name of the crate that should be imported.
This crate provides a way to get the name of a crate, even if it renamed in `Cargo.toml`. For this
purpose a single function `crate_name` is provided. This function needs to be called in the context
of a proc-macro with the name of the desired crate. `CARGO_MANIFEST_DIR` will be used to find the
current active `Cargo.toml` and this `Cargo.toml` is searched for the desired crate.
## Example
```
use quote::quote;
use syn::Ident;
use proc_macro2::Span;
use proc_macro_crate::{crate_name, FoundCrate};
fn import_my_crate() {
let found_crate = crate_name("my-crate").expect("my-crate is present in `Cargo.toml`");
match found_crate {
FoundCrate::Itself => quote!( crate::Something ),
FoundCrate::Name(name) => {
let ident = Ident::new(&name, Span::call_site());
quote!( #ident::Something )
}
};
}
# fn main() {}
```
## Edge cases
There are multiple edge cases when it comes to determining the correct crate. If you for example
import a crate as its own dependency, like this:
```toml
[package]
name = "my_crate"
[dev-dependencies]
my_crate = { version = "0.1", features = [ "test-feature" ] }
```
The crate will return `FoundCrate::Itself` and you will not be able to find the other instance
of your crate in `dev-dependencies`. Other similar cases are when one crate is imported multiple
times:
```toml
[package]
name = "my_crate"
[dependencies]
some-crate = { version = "0.5" }
some-crate-old = { package = "some-crate", version = "0.1" }
```
When searching for `some-crate` in this `Cargo.toml` it will return `FoundCrate::Name("some_old_crate")`,
aka the last definition of the crate in the `Cargo.toml`.
## License
Licensed under either of
* [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0)
* [MIT license](https://opensource.org/licenses/MIT)
at your option.
*/
use std::{
collections::btree_map::{self, BTreeMap},
env, fmt, fs, io,
path::{Path, PathBuf},
process::Command,
sync::Mutex,
time::SystemTime,
};
use toml_edit::{DocumentMut, Item, TableLike, TomlError};
/// Error type used by this crate.
pub enum Error {
NotFound(PathBuf),
CargoManifestDirNotSet,
FailedGettingWorkspaceManifestPath,
CouldNotRead { path: PathBuf, source: io::Error },
InvalidToml { source: TomlError },
CrateNotFound { crate_name: String, path: PathBuf },
}
impl std::error::Error for Error {
fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
match self {
Error::CouldNotRead { source, .. } => Some(source),
Error::InvalidToml { source } => Some(source),
_ => None,
}
}
}
impl fmt::Debug for Error {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
fmt::Display::fmt(self, f)
}
}
impl fmt::Display for Error {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
match self {
Error::NotFound(path) =>
write!(f, "Could not find `Cargo.toml` in manifest dir: `{}`.", path.display()),
Error::CargoManifestDirNotSet =>
f.write_str("`CARGO_MANIFEST_DIR` env variable not set."),
Error::CouldNotRead { path, .. } => write!(f, "Could not read `{}`.", path.display()),
Error::InvalidToml { .. } => f.write_str("Invalid toml file."),
Error::CrateNotFound { crate_name, path } => write!(
f,
"Could not find `{}` in `dependencies` or `dev-dependencies` in `{}`!",
crate_name,
path.display(),
),
Error::FailedGettingWorkspaceManifestPath =>
f.write_str("Failed to get the path of the workspace manifest path."),
}
}
}
/// The crate as found by [`crate_name`].
#[derive(Debug, PartialEq, Clone, Eq)]
pub enum FoundCrate {
/// The searched crate is this crate itself.
Itself,
/// The searched crate was found with this name.
Name(String),
}
// In a rustc invocation, there will only ever be one entry in this map, since every crate is
// compiled with its own rustc process. However, the same is not (currently) the case for
// rust-analyzer.
type Cache = BTreeMap<String, CacheEntry>;
struct CacheEntry {
manifest_ts: SystemTime,
workspace_manifest_ts: SystemTime,
workspace_manifest_path: PathBuf,
crate_names: CrateNames,
}
type CrateNames = BTreeMap<String, FoundCrate>;
/// Find the crate name for the given `orig_name` in the current `Cargo.toml`.
///
/// `orig_name` should be the original name of the searched crate.
///
/// The current `Cargo.toml` is determined by taking `CARGO_MANIFEST_DIR/Cargo.toml`.
///
/// # Returns
///
/// - `Ok(FoundCrate::Itself)` the searched crate is the current crate being compiled.
/// - `Ok(FoundCrate::Name(new_name))` the searched crate was found with the given name in the
/// `Cargo.toml`.
/// - `Err` if an error occurred. See [`Error`].
///
/// The returned crate name is sanitized in such a way that it is a valid rust identifier. Thus,
/// it is ready to be used in `extern crate` as identifier.
pub fn crate_name(orig_name: &str) -> Result<FoundCrate, Error> {
let manifest_dir = env::var("CARGO_MANIFEST_DIR").map_err(|_| Error::CargoManifestDirNotSet)?;
let manifest_path = Path::new(&manifest_dir).join("Cargo.toml");
let manifest_ts = cargo_toml_timestamp(&manifest_path)?;
static CACHE: Mutex<Cache> = Mutex::new(BTreeMap::new());
let mut cache = CACHE.lock().unwrap();
let crate_names = match cache.entry(manifest_dir) {
btree_map::Entry::Occupied(entry) => {
let cache_entry = entry.into_mut();
let workspace_manifest_path = cache_entry.workspace_manifest_path.as_path();
let workspace_manifest_ts = cargo_toml_timestamp(&workspace_manifest_path)?;
// Timestamp changed, rebuild this cache entry.
if manifest_ts != cache_entry.manifest_ts ||
workspace_manifest_ts != cache_entry.workspace_manifest_ts
{
*cache_entry = read_cargo_toml(
&manifest_path,
&workspace_manifest_path,
manifest_ts,
workspace_manifest_ts,
)?;
}
&cache_entry.crate_names
},
btree_map::Entry::Vacant(entry) => {
// If `workspace_manifest_path` returns `None`, we are probably in a vendored deps
// folder and cargo complaining that we have some package inside a workspace, that isn't
// part of the workspace. In this case we just use the `manifest_path` as the
// `workspace_manifest_path`.
let workspace_manifest_path =
workspace_manifest_path(&manifest_path)?.unwrap_or_else(|| manifest_path.clone());
let workspace_manifest_ts = cargo_toml_timestamp(&workspace_manifest_path)?;
let cache_entry = entry.insert(read_cargo_toml(
&manifest_path,
&workspace_manifest_path,
manifest_ts,
workspace_manifest_ts,
)?);
&cache_entry.crate_names
},
};
Ok(crate_names
.get(orig_name)
.ok_or_else(|| Error::CrateNotFound {
crate_name: orig_name.to_owned(),
path: manifest_path,
})?
.clone())
}
fn workspace_manifest_path(cargo_toml_manifest: &Path) -> Result<Option<PathBuf>, Error> {
let Ok(cargo) = env::var("CARGO") else {
return Ok(None);
};
let stdout = Command::new(cargo)
.arg("locate-project")
.args(&["--workspace", "--message-format=plain"])
.arg(format!("--manifest-path={}", cargo_toml_manifest.display()))
.output()
.map_err(|_| Error::FailedGettingWorkspaceManifestPath)?
.stdout;
String::from_utf8(stdout)
.map_err(|_| Error::FailedGettingWorkspaceManifestPath)
.map(|s| {
let path = s.trim();
if path.is_empty() {
None
} else {
Some(path.into())
}
})
}
fn cargo_toml_timestamp(manifest_path: &Path) -> Result<SystemTime, Error> {
fs::metadata(manifest_path).and_then(|meta| meta.modified()).map_err(|source| {
if source.kind() == io::ErrorKind::NotFound {
Error::NotFound(manifest_path.to_owned())
} else {
Error::CouldNotRead { path: manifest_path.to_owned(), source }
}
})
}
fn read_cargo_toml(
manifest_path: &Path,
workspace_manifest_path: &Path,
manifest_ts: SystemTime,
workspace_manifest_ts: SystemTime,
) -> Result<CacheEntry, Error> {
let manifest = open_cargo_toml(manifest_path)?;
let workspace_dependencies = if manifest_path != workspace_manifest_path {
let workspace_manifest = open_cargo_toml(workspace_manifest_path)?;
extract_workspace_dependencies(&workspace_manifest)?
} else {
extract_workspace_dependencies(&manifest)?
};
let crate_names = extract_crate_names(&manifest, workspace_dependencies)?;
Ok(CacheEntry {
manifest_ts,
workspace_manifest_ts,
crate_names,
workspace_manifest_path: workspace_manifest_path.to_path_buf(),
})
}
/// Extract all `[workspace.dependencies]`.
///
/// Returns a hash map that maps from dep name to the package name. Dep name
/// and package name can be the same if there doesn't exist any rename.
fn extract_workspace_dependencies(
workspace_toml: &DocumentMut,
) -> Result<BTreeMap<String, String>, Error> {
Ok(workspace_dep_tables(&workspace_toml)
.into_iter()
.map(|t| t.iter())
.flatten()
.map(move |(dep_name, dep_value)| {
let pkg_name = dep_value.get("package").and_then(|i| i.as_str()).unwrap_or(dep_name);
(dep_name.to_owned(), pkg_name.to_owned())
})
.collect())
}
/// Return an iterator over all `[workspace.dependencies]`
fn workspace_dep_tables(cargo_toml: &DocumentMut) -> Option<&dyn TableLike> {
cargo_toml
.get("workspace")
.and_then(|w| w.as_table_like()?.get("dependencies")?.as_table_like())
}
/// Make sure that the given crate name is a valid rust identifier.
fn sanitize_crate_name<S: AsRef<str>>(name: S) -> String {
name.as_ref().replace('-', "_")
}
/// Open the given `Cargo.toml` and parse it into a hashmap.
fn open_cargo_toml(path: &Path) -> Result<DocumentMut, Error> {
let content = fs::read_to_string(path)
.map_err(|e| Error::CouldNotRead { source: e, path: path.into() })?;
content.parse::<DocumentMut>().map_err(|e| Error::InvalidToml { source: e })
}
/// Extract all crate names from the given `Cargo.toml` by checking the `dependencies` and
/// `dev-dependencies`.
fn extract_crate_names(
cargo_toml: &DocumentMut,
workspace_dependencies: BTreeMap<String, String>,
) -> Result<CrateNames, Error> {
let package_name = extract_package_name(cargo_toml);
let root_pkg = package_name.as_ref().map(|name| {
let cr = match env::var_os("CARGO_TARGET_TMPDIR") {
// We're running for a library/binary crate
None => FoundCrate::Itself,
// We're running for an integration test
Some(_) => FoundCrate::Name(sanitize_crate_name(name)),
};
(name.to_string(), cr)
});
let dep_tables = dep_tables(cargo_toml.as_table()).chain(target_dep_tables(cargo_toml));
let dep_pkgs =
dep_tables.map(|t| t.iter()).flatten().filter_map(move |(dep_name, dep_value)| {
let pkg_name = dep_value.get("package").and_then(|i| i.as_str()).unwrap_or(dep_name);
// We already handle this via `root_pkg` above.
if package_name.as_ref().map_or(false, |n| *n == pkg_name) {
return None
}
// Check if this is a workspace dependency.
let workspace =
dep_value.get("workspace").and_then(|w| w.as_bool()).unwrap_or_default();
let pkg_name = workspace
.then(|| workspace_dependencies.get(pkg_name).map(|p| p.as_ref()))
.flatten()
.unwrap_or(pkg_name);
let cr = FoundCrate::Name(sanitize_crate_name(dep_name));
Some((pkg_name.to_owned(), cr))
});
Ok(root_pkg.into_iter().chain(dep_pkgs).collect())
}
fn extract_package_name(cargo_toml: &DocumentMut) -> Option<&str> {
cargo_toml.get("package")?.get("name")?.as_str()
}
fn target_dep_tables(cargo_toml: &DocumentMut) -> impl Iterator<Item = &dyn TableLike> {
cargo_toml
.get("target")
.into_iter()
.filter_map(Item::as_table_like)
.flat_map(|t| {
t.iter()
.map(|(_, value)| value)
.filter_map(Item::as_table_like)
.flat_map(dep_tables)
})
}
fn dep_tables(table: &dyn TableLike) -> impl Iterator<Item = &dyn TableLike> {
table
.get("dependencies")
.into_iter()
.chain(table.get("dev-dependencies"))
.filter_map(Item::as_table_like)
}
#[cfg(test)]
mod tests {
use super::*;
macro_rules! create_test {
(
$name:ident,
$cargo_toml:expr,
$workspace_toml:expr,
$( $result:tt )*
) => {
#[test]
fn $name() {
let cargo_toml = $cargo_toml.parse::<DocumentMut>()
.expect("Parses `Cargo.toml`");
let workspace_cargo_toml = $workspace_toml.parse::<DocumentMut>()
.expect("Parses workspace `Cargo.toml`");
let workspace_deps = extract_workspace_dependencies(&workspace_cargo_toml)
.expect("Extracts workspace dependencies");
match extract_crate_names(&cargo_toml, workspace_deps)
.map(|mut map| map.remove("my_crate"))
{
$( $result )* => (),
o => panic!("Invalid result: {:?}", o),
}
}
};
}
create_test! {
deps_with_crate,
r#"
[dependencies]
my_crate = "0.1"
"#,
"",
Ok(Some(FoundCrate::Name(name))) if name == "my_crate"
}
// forbidding toml_edit::Item::as_table ought to mean this is OK, but let's have a test too
create_test! {
deps_with_crate_inline_table,
r#"
dependencies = { my_crate = "0.1" }
"#,
"",
Ok(Some(FoundCrate::Name(name))) if name == "my_crate"
}
create_test! {
dev_deps_with_crate,
r#"
[dev-dependencies]
my_crate = "0.1"
"#,
"",
Ok(Some(FoundCrate::Name(name))) if name == "my_crate"
}
create_test! {
deps_with_crate_renamed,
r#"
[dependencies]
cool = { package = "my_crate", version = "0.1" }
"#,
"",
Ok(Some(FoundCrate::Name(name))) if name == "cool"
}
create_test! {
deps_with_crate_renamed_second,
r#"
[dependencies.cool]
package = "my_crate"
version = "0.1"
"#,
"",
Ok(Some(FoundCrate::Name(name))) if name == "cool"
}
create_test! {
deps_empty,
r#"
[dependencies]
"#,
"",
Ok(None)
}
create_test! {
crate_not_found,
r#"
[dependencies]
serde = "1.0"
"#,
"",
Ok(None)
}
create_test! {
target_dependency,
r#"
[target.'cfg(target_os="android")'.dependencies]
my_crate = "0.1"
"#,
"",
Ok(Some(FoundCrate::Name(name))) if name == "my_crate"
}
create_test! {
target_dependency2,
r#"
[target.x86_64-pc-windows-gnu.dependencies]
my_crate = "0.1"
"#,
"",
Ok(Some(FoundCrate::Name(name))) if name == "my_crate"
}
create_test! {
own_crate,
r#"
[package]
name = "my_crate"
"#,
"",
Ok(Some(FoundCrate::Itself))
}
create_test! {
own_crate_and_in_deps,
r#"
[package]
name = "my_crate"
[dev-dependencies]
my_crate = "0.1"
"#,
"",
Ok(Some(FoundCrate::Itself))
}
create_test! {
multiple_times,
r#"
[dependencies]
my_crate = { version = "0.5" }
my-crate-old = { package = "my_crate", version = "0.1" }
"#,
"",
Ok(Some(FoundCrate::Name(name))) if name == "my_crate_old"
}
create_test! {
workspace_deps,
r#"
[dependencies]
my_crate_cool = { workspace = true }
"#,
r#"
[workspace.dependencies]
my_crate_cool = { package = "my_crate" }
"#,
Ok(Some(FoundCrate::Name(name))) if name == "my_crate_cool"
}
}
vendor/proc-macro-crate/tests/workspace_deps.rs
Vendored
+17
View File
@@ -0,0 +1,17 @@
use std::{path::PathBuf, process::Command};
#[test]
fn workspace_deps_working() {
let manifest_dir =
PathBuf::from(env!("CARGO_MANIFEST_DIR")).join("tests/workspace_deps/Cargo.toml");
assert!(Command::new("cargo")
.arg("build")
.arg("--all")
.arg(format!("--manifest-path={}", manifest_dir.display()))
.spawn()
.unwrap()
.wait()
.unwrap()
.success());
}