fluent-0.16.0/.cargo_vcs_info.json0000644000000001120000000000000124060ustar { "git": { "sha1": "b825cc36c9e495e3519b2966bd07caa5b99b831e" } } fluent-0.16.0/Cargo.toml0000644000000024620000000000000104160ustar # 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 believe there's an error in this file please file an # issue against the rust-lang/cargo repository. If you're # editing this file be aware that the upstream Cargo.toml # will likely look very different (and much more reasonable) [package] edition = "2018" name = "fluent" version = "0.16.0" authors = ["Zibi Braniecki ", "Staś Małolepszy "] include = ["src/**/*", "benches/*.rs", "Cargo.toml", "README.md", "LICENSE-APACHE", "LICENSE-MIT"] description = "A localization system designed to unleash the entire expressive power of\nnatural language translations.\n" homepage = "http://www.projectfluent.org" readme = "README.md" keywords = ["localization", "l10n", "i18n", "intl", "internationalization"] categories = ["localization", "internationalization"] license = "Apache-2.0/MIT" repository = "https://github.com/projectfluent/fluent-rs" [dependencies.fluent-bundle] version = "0.15" [dependencies.fluent-pseudo] version = "0.3" optional = true [dependencies.unic-langid] version = "0.9" fluent-0.16.0/Cargo.toml.orig000064400000000000000000000014730000000000000140560ustar 00000000000000[package] name = "fluent" description = """ A localization system designed to unleash the entire expressive power of natural language translations. """ version = "0.16.0" edition = "2018" authors = [ "Zibi Braniecki ", "Staś Małolepszy " ] homepage = "http://www.projectfluent.org" license = "Apache-2.0/MIT" repository = "https://github.com/projectfluent/fluent-rs" readme = "README.md" keywords = ["localization", "l10n", "i18n", "intl", "internationalization"] categories = ["localization", "internationalization"] include = [ "src/**/*", "benches/*.rs", "Cargo.toml", "README.md", "LICENSE-APACHE", "LICENSE-MIT" ] [dependencies] fluent-bundle = { version = "0.15", path = "../fluent-bundle" } unic-langid = "0.9" fluent-pseudo = { version = "0.3", optional = true } fluent-0.16.0/LICENSE-APACHE000064400000000000000000000261110000000000000131070ustar 00000000000000 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 2017 Mozilla 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. fluent-0.16.0/LICENSE-MIT000064400000000000000000000020270000000000000126170ustar 00000000000000Copyright 2017 Mozilla 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. fluent-0.16.0/README.md000064400000000000000000000101120000000000000124340ustar 00000000000000# Fluent `fluent-rs` is a Rust implementation of [Project Fluent][], a localization framework designed to unleash the entire expressive power of natural language translations. [![crates.io](https://meritbadge.herokuapp.com/fluent)](https://crates.io/crates/fluent) [![Build and test](https://github.com/projectfluent/fluent-rs/workflows/Build%20and%20test/badge.svg)](https://github.com/projectfluent/fluent-rs/actions?query=branch%3Amaster+workflow%3A%22Build+and+test%22) [![Coverage Status](https://coveralls.io/repos/github/projectfluent/fluent-rs/badge.svg?branch=master)](https://coveralls.io/github/projectfluent/fluent-rs?branch=master) Project Fluent keeps simple things simple and makes complex things possible. The syntax used for describing translations is easy to read and understand. At the same time it allows, when necessary, to represent complex concepts from natural languages like gender, plurals, conjugations, and others. [Documentation][] [Project Fluent]: http://projectfluent.org [Documentation]: https://docs.rs/fluent/ Usage ----- ```rust use fluent::{FluentBundle, FluentResource}; use unic_langid::langid; fn main() { let ftl_string = "hello-world = Hello, world!".to_owned(); let res = FluentResource::try_new(ftl_string) .expect("Failed to parse an FTL string."); let langid_en = langid!("en-US"); let mut bundle = FluentBundle::new(vec![langid_en]); bundle.add_resource(&res) .expect("Failed to add FTL resources to the bundle."); let msg = bundle.get_message("hello-world") .expect("Message doesn't exist."); let mut errors = vec![]; let pattern = msg.value .expect("Message has no value."); let value = bundle.format_pattern(&pattern, None, &mut errors); assert_eq!(&value, "Hello, world!"); } ``` Status ------ The implementation is in pre-1.0 mode and supports Fluent Syntax 1.0, and Fluent API 0.14.. Consult the [list of milestones][] for more information about release planning and scope. `FluentBundle`, which is the main struct at the moment, is intended to remain a low level API. There is a number of higher level APIs like [fluent-resmgr][] and [fluent-fallback][] intended to wrap around it and provide better ergonomics for bindings and direct usage. Those higher level APIs are not mature yet enough to be included in this package, but will get added once they are. [list of milestones]: https://github.com/projectfluent/fluent-rs/milestones [fluent-resmgr]: https://crates.io/crates/fluent-resmgr [fluent-fallback]: https://crates.io/crates/fluent-fallback Local Development ----------------- cargo build cargo test cargo bench cargo run --example simple-app When submitting a PR please use [`cargo fmt`][] (nightly). [`cargo fmt`]: https://github.com/rust-lang-nursery/rustfmt Learn the FTL syntax -------------------- FTL is a localization file format used for describing translation resources. FTL stands for _Fluent Translation List_. FTL is designed to be simple to read, but at the same time allows to represent complex concepts from natural languages like gender, plurals, conjugations, and others. hello-user = Hello, { $username }! [Read the Fluent Syntax Guide][] in order to learn more about the syntax. If you're a tool author you may be interested in the formal [EBNF grammar][]. [Read the Fluent Syntax Guide]: http://projectfluent.org/fluent/guide/ [EBNF grammar]: https://github.com/projectfluent/fluent/tree/master/spec Get Involved ------------ `fluent-rs` is open-source, licensed under the Apache License, Version 2.0. We encourage everyone to take a look at our code and we'll listen to your feedback. Discuss ------- We'd love to hear your thoughts on Project Fluent! Whether you're a localizer looking for a better way to express yourself in your language, or a developer trying to make your app localizable and multilingual, or a hacker looking for a project to contribute to, please do get in touch on the mailing list and the IRC channel. - Discourse: https://discourse.mozilla.org/c/fluent - IRC channel: [irc://irc.mozilla.org/l20n](irc://irc.mozilla.org/l20n) fluent-0.16.0/src/lib.rs000064400000000000000000000072120000000000000130670ustar 00000000000000//! Fluent is a modern localization system designed to improve how software is translated. //! //! The Rust implementation provides the low level components for syntax operations, like parser //! and AST, and the core localization struct - [`FluentBundle`]. //! //! [`FluentBundle`] is the low level container for storing and formatting localization messages //! in a single locale. //! //! This crate provides also a number of structures needed for a localization API such as [`FluentResource`], //! [`FluentMessage`], [`FluentArgs`], and [`FluentValue`]. //! //! Together, they allow implementations to build higher-level APIs that use [`FluentBundle`] //! and add user friendly helpers, framework bindings, error fallbacking, //! language negotiation between user requested languages and available resources, //! and I/O for loading selected resources. //! //! # Example //! //! ``` //! use fluent::{FluentBundle, FluentValue, FluentResource, FluentArgs}; //! //! // Used to provide a locale for the bundle. //! use unic_langid::LanguageIdentifier; //! //! let ftl_string = String::from(" //! hello-world = Hello, world! //! intro = Welcome, { $name }. //! "); //! let res = FluentResource::try_new(ftl_string) //! .expect("Failed to parse an FTL string."); //! //! let langid_en: LanguageIdentifier = "en-US".parse().expect("Parsing failed"); //! let mut bundle = FluentBundle::new(vec![langid_en]); //! //! bundle //! .add_resource(res) //! .expect("Failed to add FTL resources to the bundle."); //! //! let msg = bundle.get_message("hello-world") //! .expect("Message doesn't exist."); //! let mut errors = vec![]; //! let pattern = msg.value() //! .expect("Message has no value."); //! let value = bundle.format_pattern(&pattern, None, &mut errors); //! //! assert_eq!(&value, "Hello, world!"); //! //! let mut args = FluentArgs::new(); //! args.set("name", FluentValue::from("John")); //! //! let msg = bundle.get_message("intro") //! .expect("Message doesn't exist."); //! let mut errors = vec![]; //! let pattern = msg.value().expect("Message has no value."); //! let value = bundle.format_pattern(&pattern, Some(&args), &mut errors); //! //! // The FSI/PDI isolation marks ensure that the direction of //! // the text from the variable is not affected by the translation. //! assert_eq!(value, "Welcome, \u{2068}John\u{2069}."); //! ``` //! //! # Ergonomics & Higher Level APIs //! //! Reading the example, you may notice how verbose it feels. //! Many core methods are fallible, others accumulate errors, and there //! are intermediate structures used in operations. //! //! This is intentional as it serves as building blocks for variety of different //! scenarios allowing implementations to handle errors, cache and //! optimize results. //! //! At the moment it is expected that users will use //! the `fluent-bundle` crate directly, while the ecosystem //! matures and higher level APIs are being developed. //! //! [`FluentBundle`]: ./struct.FluentBundle.html //! [`FluentResource`]: ./struct.FluentResource.html //! [`FluentMessage`]: ./struct.FluentMessage.html //! [`FluentArgs`]: ./type.FluentArgs.html //! [`FluentValue`]: ./struct.FluentValue.html pub use fluent_bundle::*; /// A helper macro to simplify creation of FluentArgs. /// /// # Example /// /// ``` /// use fluent::fluent_args; /// /// let mut args = fluent_args![ /// "name" => "John", /// "emailCount" => 5 /// ]; /// /// ``` #[macro_export] macro_rules! fluent_args { ( $($key:expr => $value:expr),* ) => { { let mut args: $crate::FluentArgs = $crate::FluentArgs::new(); $( args.set($key, $value); )* args } }; }