From 28f750b06234a4030cd4c2426c2b0458b0605dd9 Mon Sep 17 00:00:00 2001 From: trivernis Date: Sat, 24 Jul 2021 12:12:53 +0200 Subject: [PATCH] Add encode and decode function Signed-off-by: trivernis --- .gitignore | 4 + Cargo.toml | 14 +++ LICENSE | 201 +++++++++++++++++++++++++++++++++++++++++++ README.md | 52 +++++++++++ src/bin/uwudecode.rs | 23 +++++ src/bin/uwuencode.rs | 23 +++++ src/lib.rs | 114 ++++++++++++++++++++++++ 7 files changed, 431 insertions(+) create mode 100644 .gitignore create mode 100644 Cargo.toml create mode 100644 LICENSE create mode 100644 README.md create mode 100644 src/bin/uwudecode.rs create mode 100644 src/bin/uwuencode.rs create mode 100644 src/lib.rs diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..4f6074d --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +/target +Cargo.lock +.idea +test \ No newline at end of file diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..e686cc2 --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,14 @@ +[package] +name = "uwucodec" +version = "0.1.0" +edition = "2018" +license = "Apache-2.0" +authors = ["trivernis "] +description = "Encode your data into uwu and back." +repository = "https://github.com/Trivernis/uwucodec" +readme = "README.md" + +# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html + +[dependencies] +structopt = "0.3.22" \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -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/README.md b/README.md new file mode 100644 index 0000000..6187dd2 --- /dev/null +++ b/README.md @@ -0,0 +1,52 @@ +# UWU-Codec + +I'm sorry. + +## Motivation + +Do you also think hexadecimal byte encoding is boring? Do you want more uwu in your life? +This program solves both of your problems. Bytes are encoded into two words according to +the following mapping: + +| nibble | word | +|--------|------| +| 0000 | uwu +| 0001 | owo +| 0010 | umu +| 0011 | nya +| 0100 | omo +| 0101 | o_o +| 0110 | q_p +| 0111 | u_u +| 1000 | o~o +| 1001 | UwU +| 1010 | OwO +| 1011 | UmU +| 1100 | OmO +| 1101 | O_O +| 1110 | U_U +| 1111 | Nya + + +## Usage + +Use the `uwuencode` and `uwudecode` binaries like this: + +``` +uwuencode path/to/raw/input path/to/encoded/output +uwudecode path/to/encoded/input path/to/raw/output +``` + +You can also use the functions in your project to spice things up: + +```rust +use uwucodec::encode; +fn main() { + let encoded = encode(&"Hello World".as_bytes()); + let decoded = decode(&encoded); +} +``` + +## License + +Apache-2.0 \ No newline at end of file diff --git a/src/bin/uwudecode.rs b/src/bin/uwudecode.rs new file mode 100644 index 0000000..010ab14 --- /dev/null +++ b/src/bin/uwudecode.rs @@ -0,0 +1,23 @@ +use std::fs::{read_to_string, write}; +use std::io; +use std::path::PathBuf; +use structopt::StructOpt; +use uwucodec::decode; + +#[derive(StructOpt, Debug)] +#[structopt()] +struct Opt { + /// The uwuencoded file + #[structopt(parse(from_os_str))] + input: PathBuf, + + /// The file to write the decoded output to + #[structopt(parse(from_os_str))] + output: PathBuf, +} +fn main() -> io::Result<()> { + let opt: Opt = Opt::from_args(); + let encoded_data = read_to_string(opt.input)?; + let data = decode(&encoded_data); + write(opt.output, data) +} diff --git a/src/bin/uwuencode.rs b/src/bin/uwuencode.rs new file mode 100644 index 0000000..5413ea7 --- /dev/null +++ b/src/bin/uwuencode.rs @@ -0,0 +1,23 @@ +use std::fs::{read, write}; +use std::io; +use std::path::PathBuf; +use structopt::StructOpt; +use uwucodec::encode; + +#[derive(StructOpt, Debug)] +#[structopt()] +struct Opt { + /// The input file with the data to encode + #[structopt(parse(from_os_str))] + input: PathBuf, + + /// The file to write the uwuencoded data to + #[structopt(parse(from_os_str))] + output: PathBuf, +} +fn main() -> io::Result<()> { + let opt: Opt = Opt::from_args(); + let data = read(opt.input)?; + let encoded_data = encode(&data); + write(opt.output, encoded_data) +} diff --git a/src/lib.rs b/src/lib.rs new file mode 100644 index 0000000..e3da810 --- /dev/null +++ b/src/lib.rs @@ -0,0 +1,114 @@ +//! This crate provides an encoding from byte to uwu and back. +//! Encode: +//! ``` +//! use uwucodec::encode; +//! +//! fn main() { +//! println!("Hello World in uwu is: {}", encode("Hello World".as_bytes())); +//! } +//! ``` +//! +//! Decode: +//! ``` +//! use uwucodec::decode; +//! fn main() { +//! let text = "omo o~o q_p o_o q_p OmO q_p OmO q_p Nya umu uwu o_o u_u q_p Nya u_u umu q_p OmO q_p omo"; +//! println!("{} is {:?}", text, decode(text)); +//! } +//! ``` + +use std::cell::RefCell; +use std::collections::HashMap; + +static VALUE_MAPPINGS: [&str; 16] = [ + "uwu", "owo", "umu", "nya", "omo", "o_o", "q_p", "u_u", "o~o", "UwU", "OwO", "UmU", "OmO", + "O_O", "U_U", "Nya", +]; +thread_local! { static WORD_MAP: RefCell> = RefCell::new(get_word_map()); } +static SEPARATOR: &str = " "; + +/// Encodes into the best encoding in existence +pub fn encode<'a, I: IntoIterator + 'a>(data: I) -> String { + data.into_iter() + .map(|b| encode_byte(*b)) + .flatten() + .collect::>() + .join(SEPARATOR) +} + +fn encode_byte(byte: u8) -> [&'static str; 2] { + [ + VALUE_MAPPINGS[(byte >> 4) as usize], + VALUE_MAPPINGS[(byte & 15) as usize], + ] +} + +/// Decodes the best encoding in existence back into bytes +pub fn decode>(encoded_data: S) -> Vec { + let mut data = Vec::new(); + let mut words = encoded_data.as_ref().split(SEPARATOR); + loop { + let byte = if let (Some(head), Some(tail)) = (words.next(), words.next()) { + [head, tail] + } else { + break; + }; + data.push(decode_byte(byte)) + } + + data +} + +fn decode_byte(enc_byte: [&str; 2]) -> u8 { + (decode_word(enc_byte[0]) << 4) | decode_word(enc_byte[1]) +} + +fn decode_word(word: &str) -> u8 { + WORD_MAP.with(|m| *m.borrow().get(word).unwrap_or(&0u8)) +} + +fn get_word_map() -> HashMap<&'static str, u8> { + let mut value_map = HashMap::with_capacity(VALUE_MAPPINGS.len()); + for i in 0..VALUE_MAPPINGS.len() { + value_map.insert(VALUE_MAPPINGS[i], i as u8); + } + + value_map +} + +#[cfg(test)] +mod tests { + use crate::{decode, encode}; + + #[test] + fn it_encodes() { + let data = vec![0u8, 16u8, 12u8]; + let encoded = encode(&data); + assert_eq!(encoded, String::from("uwu uwu owo uwu uwu OmO")) + } + + #[test] + fn it_decodes() { + let encoded_data = String::from("uwu uwu owo uwu uwu OmO"); + let decoded = decode(encoded_data); + assert_eq!(decoded, vec![0u8, 16u8, 12u8]) + } + + #[test] + fn it_encodes_100000() { + let data = vec![0u8, 16u8, 12u8]; + for _ in 0..100000 { + let encoded = encode(&data); + assert_eq!(encoded, String::from("uwu uwu owo uwu uwu OmO")) + } + } + + #[test] + fn it_decodes_100000() { + let encoded_data = String::from("uwu uwu owo uwu uwu OmO"); + for _ in 0..100000 { + let decoded = decode(&encoded_data); + assert_eq!(decoded, vec![0u8, 16u8, 12u8]) + } + } +}