From 49e055af9c3057df73eb367935bf75f70f2ff115 Mon Sep 17 00:00:00 2001 From: Bruce Mitchener Date: Thu, 23 May 2024 21:06:51 +0700 Subject: [PATCH] Migrate to multi-crate layout. (#59) This moves all `parley` items into a subdirectory next to `fontique`. --- Cargo.toml | 34 +--- examples/tiny_skia_render/Cargo.toml | 2 +- parley/Cargo.toml | 26 +++ parley/LICENSE-APACHE | 201 ++++++++++++++++++++++ parley/LICENSE-MIT | 25 +++ parley/README.md | 55 ++++++ {src => parley/src}/bidi.rs | 0 {src => parley/src}/context.rs | 0 {src => parley/src}/font.rs | 0 {src => parley/src}/layout/cluster.rs | 0 {src => parley/src}/layout/cursor.rs | 0 {src => parley/src}/layout/data.rs | 0 {src => parley/src}/layout/line/greedy.rs | 0 {src => parley/src}/layout/line/mod.rs | 0 {src => parley/src}/layout/mod.rs | 0 {src => parley/src}/layout/run.rs | 0 {src => parley/src}/lib.rs | 0 {src => parley/src}/resolve/mod.rs | 0 {src => parley/src}/resolve/range.rs | 0 {src => parley/src}/resolve/tree.rs | 0 {src => parley/src}/shape.rs | 0 {src => parley/src}/style/brush.rs | 0 {src => parley/src}/style/font.rs | 0 {src => parley/src}/style/mod.rs | 0 {src => parley/src}/swash_convert.rs | 0 {src => parley/src}/util.rs | 0 26 files changed, 312 insertions(+), 31 deletions(-) create mode 100644 parley/Cargo.toml create mode 100644 parley/LICENSE-APACHE create mode 100644 parley/LICENSE-MIT create mode 100644 parley/README.md rename {src => parley/src}/bidi.rs (100%) rename {src => parley/src}/context.rs (100%) rename {src => parley/src}/font.rs (100%) rename {src => parley/src}/layout/cluster.rs (100%) rename {src => parley/src}/layout/cursor.rs (100%) rename {src => parley/src}/layout/data.rs (100%) rename {src => parley/src}/layout/line/greedy.rs (100%) rename {src => parley/src}/layout/line/mod.rs (100%) rename {src => parley/src}/layout/mod.rs (100%) rename {src => parley/src}/layout/run.rs (100%) rename {src => parley/src}/lib.rs (100%) rename {src => parley/src}/resolve/mod.rs (100%) rename {src => parley/src}/resolve/range.rs (100%) rename {src => parley/src}/resolve/tree.rs (100%) rename {src => parley/src}/shape.rs (100%) rename {src => parley/src}/style/brush.rs (100%) rename {src => parley/src}/style/font.rs (100%) rename {src => parley/src}/style/mod.rs (100%) rename {src => parley/src}/swash_convert.rs (100%) rename {src => parley/src}/util.rs (100%) diff --git a/Cargo.toml b/Cargo.toml index d89483c6..229a4c3e 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,8 +1,9 @@ [workspace] resolver = "2" members = [ - "fontique", - "examples/tiny_skia_render", + "fontique", + "parley", + "examples/tiny_skia_render" ] [workspace.package] @@ -12,41 +13,14 @@ rust-version = "1.70" license = "Apache-2.0 OR MIT" repository = "https://github.com/linebender/parley" -[package] -name = "parley" -version = "0.1.0" -description = "Parley provides an API for implementing rich text layout." -keywords = ["text", "layout"] -categories = ["gui", "graphics"] -edition.workspace = true -rust-version.workspace = true -license.workspace = true -repository.workspace = true -exclude = ["/.github/", "/doc/", ".gitignore"] - [workspace.lints] clippy.doc_markdown = "warn" clippy.semicolon_if_nothing_returned = "warn" clippy.trivially_copy_pass_by_ref = "warn" rust.unused_qualifications = "warn" -[lints] -workspace = true - -[features] -default = ["system"] -std = ["fontique/std", "skrifa/std", "peniko/std"] -libm = ["fontique/libm", "skrifa/libm", "peniko/libm"] -# Enables support for system font backends -system = ["std", "fontique/system"] - -[dependencies] -swash = "0.1.15" -skrifa = { workspace = true } -peniko = { workspace = true } -fontique = { workspace = true } - [workspace.dependencies] fontique = { version = "0.1.0", default-features = false, path = "fontique" } +parley = { version = "0.1.0", default-features = false, path = "parley" } skrifa = { version = "0.19.1", default-features = false } peniko = { version = "0.1.0", default-features = false } diff --git a/examples/tiny_skia_render/Cargo.toml b/examples/tiny_skia_render/Cargo.toml index d538fbc8..8e209b00 100644 --- a/examples/tiny_skia_render/Cargo.toml +++ b/examples/tiny_skia_render/Cargo.toml @@ -8,7 +8,7 @@ repository.workspace = true publish = false [dependencies] -parley = { path = "../.." } +parley = { workspace = true, default-features = true } skrifa = { workspace = true } peniko = { workspace = true } tiny-skia = "0.11" diff --git a/parley/Cargo.toml b/parley/Cargo.toml new file mode 100644 index 00000000..397ae4bc --- /dev/null +++ b/parley/Cargo.toml @@ -0,0 +1,26 @@ +[package] +name = "parley" +version = "0.1.0" +description = "Parley provides an API for implementing rich text layout." +keywords = ["text", "layout"] +categories = ["gui", "graphics"] +edition.workspace = true +rust-version.workspace = true +license.workspace = true +repository.workspace = true + +[lints] +workspace = true + +[features] +default = ["system"] +std = ["fontique/std", "skrifa/std", "peniko/std"] +libm = ["fontique/libm", "skrifa/libm", "peniko/libm"] +# Enables support for system font backends +system = ["std", "fontique/system"] + +[dependencies] +swash = "0.1.15" +skrifa = { workspace = true } +peniko = { workspace = true } +fontique = { workspace = true } diff --git a/parley/LICENSE-APACHE b/parley/LICENSE-APACHE new file mode 100644 index 00000000..16fe87b0 --- /dev/null +++ b/parley/LICENSE-APACHE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + +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 + + http://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. diff --git a/parley/LICENSE-MIT b/parley/LICENSE-MIT new file mode 100644 index 00000000..657288a5 --- /dev/null +++ b/parley/LICENSE-MIT @@ -0,0 +1,25 @@ +Copyright 2020 the Parley Authors + +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. diff --git a/parley/README.md b/parley/README.md new file mode 100644 index 00000000..ada06af0 --- /dev/null +++ b/parley/README.md @@ -0,0 +1,55 @@ +
+ +# Parley + +**Rich text layout** + +[![Latest published parley version.](https://img.shields.io/crates/v/parley.svg)](https://crates.io/crates/parley) +[![Documentation build status.](https://img.shields.io/docsrs/parley.svg)](https://docs.rs/parley) +[![Dependency staleness status.](https://deps.rs/crate/parley/latest/status.svg)](https://deps.rs/crate/parley) +[![Linebender Zulip chat.](https://img.shields.io/badge/Linebender-%23text-blue?logo=Zulip)](https://xi.zulipchat.com/#narrow/stream/205635-text) +[![Apache 2.0 or MIT license.](https://img.shields.io/badge/license-Apache--2.0_OR_MIT-blue.svg)](#license) + +
+ +Parley provides an API for implementing rich text layout. +It is backed by [Swash](https://github.com/dfrg/swash). + +## Minimum supported Rust Version (MSRV) + +This version of Parley has been verified to compile with **Rust 1.70** and later. + +Future versions of Parley might increase the Rust version requirement. +It will not be treated as a breaking change and as such can even happen with small patch releases. + +
+Click here if compiling fails. + +As time has passed, some of Parley's dependencies could have released versions with a higher Rust requirement. +If you encounter a compilation issue due to a dependency and don't want to upgrade your Rust toolchain, then you could downgrade the dependency. + +```sh +# Use the problematic dependency's name and version +cargo update -p package_name --precise 0.1.1 +``` +
+ +## Community + +Discussion of Parley development happens in the [Linebender Zulip](https://xi.zulipchat.com/), specifically the [#text stream](https://xi.zulipchat.com/#narrow/stream/205635-text). +All public content can be read without logging in. + +Contributions are welcome by pull request. The [Rust code of conduct] applies. + +Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache 2.0 license, shall be licensed as noted in the [License](#license) section, without any additional terms or conditions. + +## License + +Licensed under either of + +- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or ) +- MIT license ([LICENSE-MIT](LICENSE-MIT) or ) + +at your option. + +[Rust code of conduct]: https://www.rust-lang.org/policies/code-of-conduct diff --git a/src/bidi.rs b/parley/src/bidi.rs similarity index 100% rename from src/bidi.rs rename to parley/src/bidi.rs diff --git a/src/context.rs b/parley/src/context.rs similarity index 100% rename from src/context.rs rename to parley/src/context.rs diff --git a/src/font.rs b/parley/src/font.rs similarity index 100% rename from src/font.rs rename to parley/src/font.rs diff --git a/src/layout/cluster.rs b/parley/src/layout/cluster.rs similarity index 100% rename from src/layout/cluster.rs rename to parley/src/layout/cluster.rs diff --git a/src/layout/cursor.rs b/parley/src/layout/cursor.rs similarity index 100% rename from src/layout/cursor.rs rename to parley/src/layout/cursor.rs diff --git a/src/layout/data.rs b/parley/src/layout/data.rs similarity index 100% rename from src/layout/data.rs rename to parley/src/layout/data.rs diff --git a/src/layout/line/greedy.rs b/parley/src/layout/line/greedy.rs similarity index 100% rename from src/layout/line/greedy.rs rename to parley/src/layout/line/greedy.rs diff --git a/src/layout/line/mod.rs b/parley/src/layout/line/mod.rs similarity index 100% rename from src/layout/line/mod.rs rename to parley/src/layout/line/mod.rs diff --git a/src/layout/mod.rs b/parley/src/layout/mod.rs similarity index 100% rename from src/layout/mod.rs rename to parley/src/layout/mod.rs diff --git a/src/layout/run.rs b/parley/src/layout/run.rs similarity index 100% rename from src/layout/run.rs rename to parley/src/layout/run.rs diff --git a/src/lib.rs b/parley/src/lib.rs similarity index 100% rename from src/lib.rs rename to parley/src/lib.rs diff --git a/src/resolve/mod.rs b/parley/src/resolve/mod.rs similarity index 100% rename from src/resolve/mod.rs rename to parley/src/resolve/mod.rs diff --git a/src/resolve/range.rs b/parley/src/resolve/range.rs similarity index 100% rename from src/resolve/range.rs rename to parley/src/resolve/range.rs diff --git a/src/resolve/tree.rs b/parley/src/resolve/tree.rs similarity index 100% rename from src/resolve/tree.rs rename to parley/src/resolve/tree.rs diff --git a/src/shape.rs b/parley/src/shape.rs similarity index 100% rename from src/shape.rs rename to parley/src/shape.rs diff --git a/src/style/brush.rs b/parley/src/style/brush.rs similarity index 100% rename from src/style/brush.rs rename to parley/src/style/brush.rs diff --git a/src/style/font.rs b/parley/src/style/font.rs similarity index 100% rename from src/style/font.rs rename to parley/src/style/font.rs diff --git a/src/style/mod.rs b/parley/src/style/mod.rs similarity index 100% rename from src/style/mod.rs rename to parley/src/style/mod.rs diff --git a/src/swash_convert.rs b/parley/src/swash_convert.rs similarity index 100% rename from src/swash_convert.rs rename to parley/src/swash_convert.rs diff --git a/src/util.rs b/parley/src/util.rs similarity index 100% rename from src/util.rs rename to parley/src/util.rs