Skip to content

Commit 5163051

Browse files
author
Johnathan Van Why
committed
Vendor the ufmt library, with several files and directories removed.
In a future commit, I will make some changes to integrate `ufmt` into `libtock-rs` a bit better, and document the files I've removed. I'm keeping the changes in a separate commit so it is clear what changes I've made relative to the original version of `ufmt`.
1 parent ae00749 commit 5163051

File tree

24 files changed

+3184
-1
lines changed

24 files changed

+3184
-1
lines changed

‎README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ libtock-rs is licensed under either of
117117

118118
at your option.
119119

120-
Submodules have their own licenses.
120+
Submodules, as well as the code in the `ufmt` directory, have their own licenses.
121121

122122
### Contribution
123123

‎ufmt/Cargo.toml

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
[package]
2+
authors = ["Jorge Aparicio <[email protected]>"]
3+
categories = ["embedded", "no-std"]
4+
description = "A (6-40x) smaller, (2-9x) faster and panic-free alternative to `core::fmt`"
5+
documentation = "https://docs.rs/ufmt"
6+
edition = "2018"
7+
keywords = ["Debug", "Display", "Write", "format"]
8+
license = "MIT OR Apache-2.0"
9+
name = "ufmt"
10+
readme = "README.md"
11+
repository = "https://github.com/japaric/ufmt"
12+
version = "0.1.0"
13+
14+
[dependencies]
15+
proc-macro-hack = "0.5.11"
16+
ufmt-macros = { path = "macros", version = "0.1.0" }
17+
ufmt-write = { path = "write", version = "0.1.0" }
18+
19+
# NOTE do NOT add an `alloc` feature before the alloc crate can be used in
20+
# no-std BINARIES
21+
[features]
22+
# NOTE do NOT turn `std` into a default feature; this is a no-std first crate
23+
std = ["ufmt-write/std"]
24+
25+
[[test]]
26+
name = "vs-std-write"
27+
required-features = ["std"]
28+
29+
[workspace]
30+
members = [
31+
"macros",
32+
"utils",
33+
"write",
34+
]

‎ufmt/LICENSE-APACHE

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎ufmt/LICENSE-MIT

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
Copyright (c) 2019 Jorge Aparicio
2+
3+
Permission is hereby granted, free of charge, to any
4+
person obtaining a copy of this software and associated
5+
documentation files (the "Software"), to deal in the
6+
Software without restriction, including without
7+
limitation the rights to use, copy, modify, merge,
8+
publish, distribute, sublicense, and/or sell copies of
9+
the Software, and to permit persons to whom the Software
10+
is furnished to do so, subject to the following
11+
conditions:
12+
13+
The above copyright notice and this permission notice
14+
shall be included in all copies or substantial portions
15+
of the Software.
16+
17+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
18+
ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
19+
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
20+
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
21+
SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
22+
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
23+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
24+
IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
25+
DEALINGS IN THE SOFTWARE.

‎ufmt/README.md

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
# `μfmt`
2+
3+
> A (6-40x) smaller, (2-9x) faster and panic-free alternative to `core::fmt`
4+
5+
![Call graph of formatting structs](cg.png)
6+
7+
Call graph of a program that formats some structs (generated using
8+
[`cargo-call-stack`]). Source code can be found at the bottom of this file. The
9+
program was compiled with `-C opt-level=z`.
10+
11+
[`cargo-call-stack`]: https://crates.io/crates/cargo-call-stack
12+
13+
## [API docs](https://docs.rs/ufmt)
14+
15+
## Design goals
16+
17+
From highest priority to lowest priority
18+
19+
- Optimized for binary size and speed (rather than for compilation time)
20+
21+
- No dynamic dispatch in generated code
22+
23+
- No panicking branches in generated code, when optimized
24+
25+
- No recursion where possible
26+
27+
## Features
28+
29+
- `Debug` and `Display`-like traits
30+
31+
- `core::write!`-like macro
32+
33+
- A generic `Formatter<'_, impl uWrite>` instead of a single `core::Formatter`;
34+
the `uWrite` trait has an associated error type so each writer can choose its
35+
error type. For example, the implementation for `std::String` uses
36+
`Infallible` as its error type.
37+
38+
- `core::fmt::Formatter::debug_struct`-like API
39+
40+
- `#[derive(uDebug)]`
41+
42+
- Pretty formatting (`{:#?}`) for `uDebug`
43+
44+
# Minimum Supported Rust Version (MSRV)
45+
46+
This crate is guaranteed to compile on stable Rust 1.34 and up. It *might*
47+
compile on older versions but that may change in any new patch release.
48+
49+
## License
50+
51+
All source code (including code snippets) is licensed under either of
52+
53+
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
54+
[https://www.apache.org/licenses/LICENSE-2.0][L1])
55+
56+
- MIT license ([LICENSE-MIT](LICENSE-MIT) or
57+
[https://opensource.org/licenses/MIT][L2])
58+
59+
[L1]: https://www.apache.org/licenses/LICENSE-2.0
60+
[L2]: https://opensource.org/licenses/MIT
61+
62+
at your option.
63+
64+
### Contribution
65+
66+
Unless you explicitly state otherwise, any contribution intentionally submitted
67+
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
68+
licensed as above, without any additional terms or conditions.
69+
70+
## Appendix
71+
72+
### Formatting structs (snippet)
73+
74+
Full source code in [nopanic/examples/struct.rs](nopanic/examples/struct.rs).
75+
76+
``` rust
77+
// ..
78+
79+
#[derive(Clone, Copy, uDebug)]
80+
struct Pair {
81+
x: i32,
82+
y: i32,
83+
}
84+
85+
static X: AtomicI32 = AtomicI32::new(0);
86+
static Y: AtomicI32 = AtomicI32::new(0);
87+
88+
#[exception]
89+
fn PendSV() {
90+
let x = X.load(Ordering::Relaxed);
91+
let y = Y.load(Ordering::Relaxed);
92+
93+
uwrite!(&mut W, "{:?}", Braces {}).unwrap();
94+
uwrite!(&mut W, "{:#?}", Braces {}).unwrap();
95+
96+
uwrite!(&mut W, "{:?}", Parens()).unwrap();
97+
uwrite!(&mut W, "{:#?}", Parens()).unwrap();
98+
99+
uwrite!(&mut W, "{:?}", I32(x)).unwrap();
100+
uwrite!(&mut W, "{:#?}", I32(x)).unwrap();
101+
102+
uwrite!(&mut W, "{:?}", Tuple(x, y)).unwrap();
103+
uwrite!(&mut W, "{:#?}", Tuple(x, y)).unwrap();
104+
105+
let pair = Pair { x, y };
106+
uwrite!(&mut W, "{:?}", pair).unwrap();
107+
uwrite!(&mut W, "{:#?}", pair).unwrap();
108+
109+
let first = pair;
110+
let second = pair;
111+
uwrite!(&mut W, "{:?}", Nested { first, second }).unwrap();
112+
uwrite!(&mut W, "{:#?}", Nested { first, second }).unwrap();
113+
}
114+
115+
// ..
116+
```

0 commit comments

Comments
 (0)