Skip to content

Commit 2d74475

Browse files
sffcsffc
authored
Add UnicodeFuncs with safe-to-implement traits (#197)
* Add UnicodeFuncs * Add ability to set parent * Use individual functions with individual bounds * Make the crate no_std and add harfbuzz-sys feature * Fix docs and tests * Post-merge fixes * Make GeneralCategory an enum * Change CombiningClassFunc to return a u8 * Fix docs links * Use `char` instead of `u32` for hb_codepoint_t in traits * Add std feature to harfbuzz * Mark harfbuzz-sys as no_std. * Move to separate crate * Undo sys feature * fix * Add no_std marker for unicode-traits * Update lib.rs * Docs tests * fmt? * Update unicode_funcs_traits.rs * Update lib.rs * Update unicode_funcs.rs
1 parent 278c865 commit 2d74475

File tree

11 files changed

+792
-1
lines changed

11 files changed

+792
-1
lines changed

‎Cargo.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
[workspace]
22
resolver = "2"
3-
members = ["harfbuzz", "harfbuzz-sys"]
3+
members = ["harfbuzz", "harfbuzz-sys", "harfbuzz-traits"]

‎harfbuzz-traits/Cargo.toml‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
[package]
2+
name = "harfbuzz-traits"
3+
version = "0.1.0"
4+
edition = "2021"
5+
6+
authors = ["The Servo Project Developers"]
7+
license = "MIT OR Apache-2.0"
8+
readme = "README.md"
9+
10+
description = "Rust Traits for the HarfBuzz text shaping engine"
11+
repository = "https://github.com/servo/rust-harfbuzz"
12+
documentation = "https://docs.rs/harfbuzz/"
13+
keywords = ["opentype", "font", "text", "layout", "unicode", "shaping"]
14+
categories = ["text-processing"]
15+
16+
[features]

‎harfbuzz-traits/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.

‎harfbuzz-traits/LICENSE-MIT‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
Copyright (c) 2012-2013 Mozilla Foundation
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.

‎harfbuzz-traits/README.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
<div align="center">
2+
3+
# harfbuzz-traits
4+
5+
[![Build Status](https://github.com/servo/rust-harfbuzz/actions/workflows/main.yml/badge.svg)](https://github.com/servo/rust-harfbuzz/actions)
6+
[![Crates.io](https://img.shields.io/crates/v/harfbuzz-traits.svg)](https://crates.io/crates/harfbuzz-traits)
7+
[![Docs](https://docs.rs/harfbuzz-traits/badge.svg)](https://docs.rs/harfbuzz-traits)
8+
9+
</div>
10+
11+
[HarfBuzz](https://harfbuzz.github.io/) is a text shaping engine. It
12+
solves the problem of selecting and positioning glyphs from a font
13+
given a Unicode string.
14+
15+
This crate provides high-level Rust traits that can be implemented without
16+
depending on HarfBuzz itself.
17+
18+
## License
19+
20+
Licensed under either of
21+
22+
- Apache License, Version 2.0
23+
([LICENSE-APACHE](LICENSE-APACHE) or <https://www.apache.org/licenses/LICENSE-2.0>)
24+
- MIT license
25+
([LICENSE-MIT](LICENSE-MIT) or <https://opensource.org/licenses/MIT>)
26+
27+
at your option.
28+
29+
## Contribution
30+
31+
Contributions are welcome by pull request.
32+
33+
Unless you explicitly state otherwise, any contribution intentionally submitted
34+
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
35+
dual licensed as above, without any additional terms or conditions.

‎harfbuzz-traits/src/lib.rs‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
// Copyright 2023 The Servo Project Developers. See the COPYRIGHT
2+
// file at the top-level directory of this distribution.
3+
//
4+
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
5+
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6+
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
7+
// option. This file may not be copied, modified, or distributed
8+
// except according to those terms.
9+
10+
//! # harfbuzz-traits
11+
//!
12+
//! This crate provides traits for the `harfbuzz` crate that can be implememted without
13+
//! depending on [HarfBuzz](https://harfbuzz.github.io/) itself.
14+
15+
#![no_std]
16+
17+
mod unicode_funcs_traits;
18+
19+
pub use unicode_funcs_traits::*;

‎harfbuzz-traits/src/unicode_funcs_traits.rs‎

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
// Copyright 2023 The Servo Project Developers. See the COPYRIGHT
2+
// file at the top-level directory of this distribution.
3+
//
4+
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
5+
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6+
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
7+
// option. This file may not be copied, modified, or distributed
8+
// except according to those terms.
9+
10+
/// A general category value. Equivalent to [`hb_unicode_general_category_t`].
11+
///
12+
/// [`hb_unicode_general_category_t`]: crate::sys::hb_unicode_general_category_t
13+
#[repr(u8)]
14+
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
15+
#[allow(non_camel_case_types)] // the names are defined by Unicode
16+
#[allow(missing_docs)] // the categories are defined by Unicode
17+
pub enum GeneralCategory {
18+
Control = 0,
19+
Format = 1,
20+
Unassigned = 2,
21+
PrivateUse = 3,
22+
Surrogate = 4,
23+
LowercaseLetter = 5,
24+
ModifierLetter = 6,
25+
OtherLetter = 7,
26+
TitlecaseLetter = 8,
27+
UppercaseLetter = 9,
28+
SpacingMark = 10,
29+
EnclosingMark = 11,
30+
NonSpacingMark = 12,
31+
DecimalNumber = 13,
32+
LetterNumber = 14,
33+
OtherNumber = 15,
34+
ConnectPunctuation = 16,
35+
DashPunctuation = 17,
36+
ClosePunctuation = 18,
37+
FinalPunctuation = 19,
38+
InitialPunctuation = 20,
39+
OtherPunctuation = 21,
40+
OpenPunctuation = 22,
41+
CurrencySymbol = 23,
42+
ModifierSymbol = 24,
43+
MathSymbol = 25,
44+
OtherSymbol = 26,
45+
LineSeparator = 27,
46+
ParagraphSeparator = 28,
47+
SpaceSeparator = 29,
48+
}
49+
50+
/// An object to map from code points to general category properties.
51+
pub trait GeneralCategoryFunc {
52+
/// Given a code point, return the general category as a [`GeneralCategory`].
53+
fn general_category(&self, ch: char) -> GeneralCategory;
54+
}
55+
56+
/// An object to map from code points to combining classes.
57+
pub trait CombiningClassFunc {
58+
/// Given a code point, return the combining class as a `u8` corresponding to a
59+
/// [`hb_unicode_combining_class_t`]. Note that the
60+
/// [Unicode stability policy](https://www.unicode.org/policies/stability_policy.html)
61+
/// guarantees that Canonical Combining Class numeric values fit in a `u8`.
62+
///
63+
/// [`hb_unicode_combining_class_t`]: crate::sys::hb_unicode_combining_class_t
64+
fn combining_class(&self, ch: char) -> u8;
65+
}
66+
67+
/// An object to map from code points to mirrored code points.
68+
pub trait MirroringFunc {
69+
/// Given a code point, return the mirrored code point.
70+
fn mirroring(&self, ch: char) -> char;
71+
}
72+
73+
/// An object to map from code points to script names.
74+
pub trait ScriptFunc {
75+
/// Given a code point, return the script as a 4-byte script name.
76+
fn script(&self, ch: char) -> [u8; 4];
77+
}
78+
79+
/// An object to compose two characters.
80+
pub trait ComposeFunc {
81+
/// Given two code points, return the composed code point.
82+
fn compose(&self, a: char, b: char) -> Option<char>;
83+
}
84+
85+
/// An object to decompose a character.
86+
pub trait DecomposeFunc {
87+
/// Given a code point, return the two decomposed code points.
88+
fn decompose(&self, ab: char) -> Option<(char, char)>;
89+
}

0 commit comments

Comments
 (0)